From 81dc6f0bf07f880e68091674cd4fa6bcfa58884c Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 14:27:13 +0200 Subject: [PATCH 001/387] Init Riverpod 3 --- packages/flutter_riverpod/pubspec.yaml | 2 +- packages/hooks_riverpod/pubspec.yaml | 2 +- packages/riverpod/CHANGELOG.md | 4 ++++ packages/riverpod/pubspec.yaml | 2 +- 4 files changed, 7 insertions(+), 3 deletions(-) diff --git a/packages/flutter_riverpod/pubspec.yaml b/packages/flutter_riverpod/pubspec.yaml index 08482d75e..307600566 100644 --- a/packages/flutter_riverpod/pubspec.yaml +++ b/packages/flutter_riverpod/pubspec.yaml @@ -10,7 +10,7 @@ funding: - https://github.com/sponsors/rrousselGit/ environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0+0.0-dev <4.0.0" flutter: ">=3.0.0" dependencies: diff --git a/packages/hooks_riverpod/pubspec.yaml b/packages/hooks_riverpod/pubspec.yaml index d8d5e1373..f629c539b 100644 --- a/packages/hooks_riverpod/pubspec.yaml +++ b/packages/hooks_riverpod/pubspec.yaml @@ -10,7 +10,7 @@ funding: - https://github.com/sponsors/rrousselGit/ environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0+0.0-dev <4.0.0" flutter: ">=3.0.0" dependencies: diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index de2465420..6e71762c9 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -1,3 +1,7 @@ +## Unreleased major + +- Bumped minimum Dart SDK to >= 3.0.0-dev + ## 2.3.6 - 2023-04-24 - Improved error message for missing `dependencies` (thanks to @ValentinVignal) diff --git a/packages/riverpod/pubspec.yaml b/packages/riverpod/pubspec.yaml index 8a311f395..e95384217 100644 --- a/packages/riverpod/pubspec.yaml +++ b/packages/riverpod/pubspec.yaml @@ -10,7 +10,7 @@ funding: - https://github.com/sponsors/rrousselGit/ environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0+0.0-dev <4.0.0" dependencies: meta: ^1.4.0 From 4630ed7b691ed405dc7e842b11547c0a9a3dd826 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 14:34:24 +0200 Subject: [PATCH 002/387] Make AsyncValue sealed --- packages/riverpod/CHANGELOG.md | 1 + packages/riverpod/lib/src/common.dart | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 6e71762c9..612d26b00 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -1,5 +1,6 @@ ## Unreleased major +- **Breaking**: `AsyncValue` is now "sealed" (cannot be extended/implemented) - Bumped minimum Dart SDK to >= 3.0.0-dev ## 2.3.6 - 2023-04-24 diff --git a/packages/riverpod/lib/src/common.dart b/packages/riverpod/lib/src/common.dart index b792469b7..de22cecbe 100644 --- a/packages/riverpod/lib/src/common.dart +++ b/packages/riverpod/lib/src/common.dart @@ -87,7 +87,7 @@ extension AsyncTransition on ProviderElementBase> { /// - [AsyncValue.guard], to simplify transforming a [Future] into an [AsyncValue]. @sealed @immutable -abstract class AsyncValue { +sealed class AsyncValue { const AsyncValue._(); /// {@template asyncvalue.data} From 8892629f9783fdf524613638e4eff94bc829b374 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 14:34:32 +0200 Subject: [PATCH 003/387] Fix runtimeType lint --- packages/riverpod/lib/src/common.dart | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/packages/riverpod/lib/src/common.dart b/packages/riverpod/lib/src/common.dart index de22cecbe..ba9964de3 100644 --- a/packages/riverpod/lib/src/common.dart +++ b/packages/riverpod/lib/src/common.dart @@ -205,6 +205,8 @@ sealed class AsyncValue { /// The stacktrace of [error]. StackTrace? get stackTrace; + String get _displayString; + /// Perform some action based on the current state of the [AsyncValue]. /// /// This allows reading the content of an [AsyncValue] in a type-safe way, @@ -259,7 +261,7 @@ sealed class AsyncValue { ] ].join(', '); - return '$runtimeType($content)'; + return '$_displayString<$T>($content)'; } @override @@ -303,11 +305,15 @@ class AsyncData extends AsyncValue { }) : super._(); @override - final T value; + String get _displayString => 'AsyncData'; @override bool get hasValue => true; + @override + final T value; + + @override @override final bool isLoading; @@ -355,6 +361,9 @@ class AsyncLoading extends AsyncValue { @override bool get isLoading => true; + @override + String get _displayString => 'AsyncLoading'; + @override final bool hasValue; @@ -439,6 +448,9 @@ class AsyncError extends AsyncValue { }) : _value = value, super._(); + @override + String get _displayString => 'AsyncError'; + @override final bool isLoading; From 15f88647e1f451b13dc876438adee0cffaa9cd80 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 14:39:13 +0200 Subject: [PATCH 004/387] Test exhaustive AsyncValue match --- .../riverpod/test/framework/async_value_test.dart | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/packages/riverpod/test/framework/async_value_test.dart b/packages/riverpod/test/framework/async_value_test.dart index 371377775..f10b5a2df 100644 --- a/packages/riverpod/test/framework/async_value_test.dart +++ b/packages/riverpod/test/framework/async_value_test.dart @@ -7,6 +7,17 @@ import 'package:riverpod/src/internals.dart'; import 'package:test/test.dart'; void main() { + test('Can do exhaustive pattern matching', () { + expect( + switch (const AsyncValue.loading()) { + AsyncData() => 'data', + AsyncError() => 'error', + AsyncLoading() => 'loading', + }, + 'loading', + ); + }); + group('custom AsyncValue', () { test('supports when', () { expect( From b40f0c32b91d3066d548c0da02e51dd59a887668 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 14:53:47 +0200 Subject: [PATCH 005/387] Mark other AsyncValue classes as final --- .../flutter_riverpod/example/pubspec.yaml | 2 +- packages/hooks_riverpod/example/pubspec.yaml | 2 +- packages/riverpod/CHANGELOG.md | 4 ++- packages/riverpod/example/pubspec.yaml | 2 +- packages/riverpod/lib/src/common.dart | 6 ++-- .../test/framework/async_value_test.dart | 36 ------------------- 6 files changed, 9 insertions(+), 43 deletions(-) diff --git a/packages/flutter_riverpod/example/pubspec.yaml b/packages/flutter_riverpod/example/pubspec.yaml index 5dc9c5207..4785b0a0a 100644 --- a/packages/flutter_riverpod/example/pubspec.yaml +++ b/packages/flutter_riverpod/example/pubspec.yaml @@ -4,7 +4,7 @@ description: A new Flutter project. publish_to: "none" environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: flutter: diff --git a/packages/hooks_riverpod/example/pubspec.yaml b/packages/hooks_riverpod/example/pubspec.yaml index 8fcf462c8..a2dff9a3a 100644 --- a/packages/hooks_riverpod/example/pubspec.yaml +++ b/packages/hooks_riverpod/example/pubspec.yaml @@ -4,7 +4,7 @@ description: A new Flutter project. publish_to: "none" environment: - sdk: ">=2.12.0-0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" flutter: ">=1.17.0" dependencies: diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 612d26b00..414f24bed 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -1,6 +1,8 @@ ## Unreleased major -- **Breaking**: `AsyncValue` is now "sealed" (cannot be extended/implemented) +- **Breaking**: `AsyncValue` is now "sealed" and `AsyncData/AsyncLoading/AsyncError` + are "final". This means that it is no-longer possible to subclass + `AsyncValue` or the associated classes. - Bumped minimum Dart SDK to >= 3.0.0-dev ## 2.3.6 - 2023-04-24 diff --git a/packages/riverpod/example/pubspec.yaml b/packages/riverpod/example/pubspec.yaml index 6fcdd0c5e..76252355f 100644 --- a/packages/riverpod/example/pubspec.yaml +++ b/packages/riverpod/example/pubspec.yaml @@ -2,7 +2,7 @@ name: riverpod_example publish_to: "none" environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: crypto: ^3.0.0 diff --git a/packages/riverpod/lib/src/common.dart b/packages/riverpod/lib/src/common.dart index ba9964de3..1cfcaa605 100644 --- a/packages/riverpod/lib/src/common.dart +++ b/packages/riverpod/lib/src/common.dart @@ -287,7 +287,7 @@ sealed class AsyncValue { } /// {@macro asyncvalue.data} -class AsyncData extends AsyncValue { +final class AsyncData extends AsyncValue { /// {@macro asyncvalue.data} const AsyncData(T value) : this._( @@ -342,7 +342,7 @@ class AsyncData extends AsyncValue { } /// {@macro asyncvalue.loading} -class AsyncLoading extends AsyncValue { +final class AsyncLoading extends AsyncValue { /// {@macro asyncvalue.loading} const AsyncLoading() : hasValue = false, @@ -428,7 +428,7 @@ class AsyncLoading extends AsyncValue { } /// {@macro asyncvalue.error_ctor} -class AsyncError extends AsyncValue { +final class AsyncError extends AsyncValue { /// {@macro asyncvalue.error_ctor} const AsyncError(Object error, StackTrace stackTrace) : this._( diff --git a/packages/riverpod/test/framework/async_value_test.dart b/packages/riverpod/test/framework/async_value_test.dart index f10b5a2df..4710bfb9a 100644 --- a/packages/riverpod/test/framework/async_value_test.dart +++ b/packages/riverpod/test/framework/async_value_test.dart @@ -18,26 +18,6 @@ void main() { ); }); - group('custom AsyncValue', () { - test('supports when', () { - expect( - const CustomData(42).whenOrNull(data: (v) => v * 2), - 84, - ); - - expect( - const CustomError(42, stackTrace: StackTrace.empty) - .whenOrNull(data: (v) => v * 2), - null, - ); - - expect( - const CustomLoading().whenOrNull(data: (v) => v * 2), - null, - ); - }); - }); - test('unwrapPrevious', () { expect( const AsyncLoading() @@ -1580,19 +1560,3 @@ void main() { ); }); } - -class CustomLoading extends AsyncLoading { - const CustomLoading(); -} - -class CustomData extends AsyncData { - const CustomData(super.value); -} - -class CustomError extends AsyncError { - const CustomError(Object error, {required StackTrace stackTrace}) - : super( - error, - stackTrace, - ); -} From 2c23093472314f943abe0b82301dadc55da653e8 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 15:01:40 +0200 Subject: [PATCH 006/387] Removed the deprecated from/argument/debugGetCreateSourceHash of providers --- .../lib/src/change_notifier_provider/auto_dispose.dart | 6 +++--- .../lib/src/change_notifier_provider/base.dart | 6 +++--- packages/riverpod/CHANGELOG.md | 1 + packages/riverpod/lib/src/async_notifier/auto_dispose.dart | 6 +++--- .../lib/src/async_notifier/auto_dispose_family.dart | 6 +++--- packages/riverpod/lib/src/async_notifier/base.dart | 6 +++--- packages/riverpod/lib/src/async_notifier/family.dart | 6 +++--- packages/riverpod/lib/src/future_provider/auto_dispose.dart | 6 +++--- packages/riverpod/lib/src/future_provider/base.dart | 6 +++--- packages/riverpod/lib/src/notifier/auto_dispose.dart | 6 +++--- packages/riverpod/lib/src/notifier/auto_dispose_family.dart | 6 +++--- packages/riverpod/lib/src/notifier/base.dart | 6 +++--- packages/riverpod/lib/src/notifier/family.dart | 6 +++--- packages/riverpod/lib/src/provider/auto_dispose.dart | 6 +++--- packages/riverpod/lib/src/provider/base.dart | 6 +++--- .../lib/src/state_notifier_provider/auto_dispose.dart | 6 +++--- packages/riverpod/lib/src/state_notifier_provider/base.dart | 6 +++--- packages/riverpod/lib/src/state_provider/auto_dispose.dart | 6 +++--- packages/riverpod/lib/src/state_provider/base.dart | 6 +++--- packages/riverpod/lib/src/stream_provider/auto_dispose.dart | 6 +++--- packages/riverpod/lib/src/stream_provider/base.dart | 6 +++--- .../riverpod/test/providers/async_notifier/factory.dart | 2 -- packages/riverpod/test/providers/notifier/factory.dart | 2 -- 23 files changed, 61 insertions(+), 64 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/change_notifier_provider/auto_dispose.dart b/packages/flutter_riverpod/lib/src/change_notifier_provider/auto_dispose.dart index 4987332fb..998bec31a 100644 --- a/packages/flutter_riverpod/lib/src/change_notifier_provider/auto_dispose.dart +++ b/packages/flutter_riverpod/lib/src/change_notifier_provider/auto_dispose.dart @@ -17,12 +17,12 @@ class AutoDisposeChangeNotifierProvider this._createFn, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart b/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart index c65c10ff9..a27c01233 100644 --- a/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart +++ b/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart @@ -80,12 +80,12 @@ class ChangeNotifierProvider this._createFn, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 414f24bed..083318011 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -3,6 +3,7 @@ - **Breaking**: `AsyncValue` is now "sealed" and `AsyncData/AsyncLoading/AsyncError` are "final". This means that it is no-longer possible to subclass `AsyncValue` or the associated classes. +- **Breaking**: Removed the deprecated from/argument/debugGetCreateSourceHash of providers - Bumped minimum Dart SDK to >= 3.0.0-dev ## 2.3.6 - 2023-04-24 diff --git a/packages/riverpod/lib/src/async_notifier/auto_dispose.dart b/packages/riverpod/lib/src/async_notifier/auto_dispose.dart index 053f663d2..3cdf5c7d6 100644 --- a/packages/riverpod/lib/src/async_notifier/auto_dispose.dart +++ b/packages/riverpod/lib/src/async_notifier/auto_dispose.dart @@ -55,12 +55,12 @@ class AutoDisposeAsyncNotifierProviderImpl< super._createNotifier, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/async_notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/async_notifier/auto_dispose_family.dart index 9d4255476..524aacdfb 100644 --- a/packages/riverpod/lib/src/async_notifier/auto_dispose_family.dart +++ b/packages/riverpod/lib/src/async_notifier/auto_dispose_family.dart @@ -41,12 +41,12 @@ class AutoDisposeFamilyAsyncNotifierProviderImpl< super._createNotifier, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/async_notifier/base.dart b/packages/riverpod/lib/src/async_notifier/base.dart index 1109143b4..6f0a27f7f 100644 --- a/packages/riverpod/lib/src/async_notifier/base.dart +++ b/packages/riverpod/lib/src/async_notifier/base.dart @@ -96,12 +96,12 @@ class AsyncNotifierProviderImpl, T> super._createNotifier, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/async_notifier/family.dart b/packages/riverpod/lib/src/async_notifier/family.dart index 75442455e..07dee9ad6 100644 --- a/packages/riverpod/lib/src/async_notifier/family.dart +++ b/packages/riverpod/lib/src/async_notifier/family.dart @@ -49,12 +49,12 @@ class FamilyAsyncNotifierProviderImpl, T, super._createNotifier, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/future_provider/auto_dispose.dart b/packages/riverpod/lib/src/future_provider/auto_dispose.dart index 87030f6d0..5e8bd1294 100644 --- a/packages/riverpod/lib/src/future_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/future_provider/auto_dispose.dart @@ -14,12 +14,12 @@ class AutoDisposeFutureProvider extends _FutureProviderBase this._createFn, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/future_provider/base.dart b/packages/riverpod/lib/src/future_provider/base.dart index fa4f714d8..e98f75aa6 100644 --- a/packages/riverpod/lib/src/future_provider/base.dart +++ b/packages/riverpod/lib/src/future_provider/base.dart @@ -30,12 +30,12 @@ class FutureProvider extends _FutureProviderBase this._createFn, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/notifier/auto_dispose.dart b/packages/riverpod/lib/src/notifier/auto_dispose.dart index 1da3093b0..4e12d371c 100644 --- a/packages/riverpod/lib/src/notifier/auto_dispose.dart +++ b/packages/riverpod/lib/src/notifier/auto_dispose.dart @@ -54,12 +54,12 @@ class AutoDisposeNotifierProviderImpl, T> super._createNotifier, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/notifier/auto_dispose_family.dart index 9ff2976a7..8582ad30f 100644 --- a/packages/riverpod/lib/src/notifier/auto_dispose_family.dart +++ b/packages/riverpod/lib/src/notifier/auto_dispose_family.dart @@ -41,12 +41,12 @@ class AutoDisposeFamilyNotifierProviderImpl, super._createNotifier, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/notifier/base.dart b/packages/riverpod/lib/src/notifier/base.dart index 30bbd183c..bb52edb59 100644 --- a/packages/riverpod/lib/src/notifier/base.dart +++ b/packages/riverpod/lib/src/notifier/base.dart @@ -119,12 +119,12 @@ class NotifierProviderImpl, T> super._createNotifier, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/notifier/family.dart b/packages/riverpod/lib/src/notifier/family.dart index 9ae4ac516..9257d1adc 100644 --- a/packages/riverpod/lib/src/notifier/family.dart +++ b/packages/riverpod/lib/src/notifier/family.dart @@ -36,12 +36,12 @@ class FamilyNotifierProviderImpl, T, Arg> super._createNotifier, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/provider/auto_dispose.dart b/packages/riverpod/lib/src/provider/auto_dispose.dart index 941c29786..2b60d9203 100644 --- a/packages/riverpod/lib/src/provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/provider/auto_dispose.dart @@ -11,12 +11,12 @@ class AutoDisposeProvider extends InternalProvider { this._createFn, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/provider/base.dart b/packages/riverpod/lib/src/provider/base.dart index da365d369..ac4e5d7e5 100644 --- a/packages/riverpod/lib/src/provider/base.dart +++ b/packages/riverpod/lib/src/provider/base.dart @@ -23,12 +23,12 @@ class Provider extends InternalProvider this._createFn, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/state_notifier_provider/auto_dispose.dart b/packages/riverpod/lib/src/state_notifier_provider/auto_dispose.dart index 6a08081f0..09dc5654e 100644 --- a/packages/riverpod/lib/src/state_notifier_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/state_notifier_provider/auto_dispose.dart @@ -14,12 +14,12 @@ class AutoDisposeStateNotifierProvider, T> this._createFn, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/state_notifier_provider/base.dart b/packages/riverpod/lib/src/state_notifier_provider/base.dart index c42819cfd..5e4783512 100644 --- a/packages/riverpod/lib/src/state_notifier_provider/base.dart +++ b/packages/riverpod/lib/src/state_notifier_provider/base.dart @@ -81,12 +81,12 @@ class StateNotifierProvider, T> this._createFn, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/state_provider/auto_dispose.dart b/packages/riverpod/lib/src/state_provider/auto_dispose.dart index 96503a560..eea9e8190 100644 --- a/packages/riverpod/lib/src/state_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/state_provider/auto_dispose.dart @@ -12,12 +12,12 @@ class AutoDisposeStateProvider extends _StateProviderBase { this._createFn, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/state_provider/base.dart b/packages/riverpod/lib/src/state_provider/base.dart index 68d491424..02b29edb2 100644 --- a/packages/riverpod/lib/src/state_provider/base.dart +++ b/packages/riverpod/lib/src/state_provider/base.dart @@ -49,12 +49,12 @@ class StateProvider extends _StateProviderBase this._createFn, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/stream_provider/auto_dispose.dart b/packages/riverpod/lib/src/stream_provider/auto_dispose.dart index 278e32532..f847f4dc4 100644 --- a/packages/riverpod/lib/src/stream_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/stream_provider/auto_dispose.dart @@ -13,12 +13,12 @@ class AutoDisposeStreamProvider extends _StreamProviderBase this._createFn, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/lib/src/stream_provider/base.dart b/packages/riverpod/lib/src/stream_provider/base.dart index 6a4d69a31..630d5df58 100644 --- a/packages/riverpod/lib/src/stream_provider/base.dart +++ b/packages/riverpod/lib/src/stream_provider/base.dart @@ -77,12 +77,12 @@ class StreamProvider extends _StreamProviderBase this._createFn, { super.name, super.dependencies, - @Deprecated('Will be removed in 3.0.0') super.from, - @Deprecated('Will be removed in 3.0.0') super.argument, - @Deprecated('Will be removed in 3.0.0') super.debugGetCreateSourceHash, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod diff --git a/packages/riverpod/test/providers/async_notifier/factory.dart b/packages/riverpod/test/providers/async_notifier/factory.dart index b169bef56..b1096c7c3 100644 --- a/packages/riverpod/test/providers/async_notifier/factory.dart +++ b/packages/riverpod/test/providers/async_notifier/factory.dart @@ -6,9 +6,7 @@ typedef AsyncNotifierProviderFactoryType = AsyncNotifierProviderBase Function, T>( NotifierT Function() create, { - Object? argument, Iterable? dependencies, - Family? from, String? name, }); diff --git a/packages/riverpod/test/providers/notifier/factory.dart b/packages/riverpod/test/providers/notifier/factory.dart index 79c721d9d..6600b5d78 100644 --- a/packages/riverpod/test/providers/notifier/factory.dart +++ b/packages/riverpod/test/providers/notifier/factory.dart @@ -3,9 +3,7 @@ import 'package:riverpod/src/internals.dart'; typedef NotifierProviderFactoryType = NotifierProviderBase Function, T>( NotifierT Function() create, { - Object? argument, Iterable? dependencies, - Family? from, String? name, }); From 7d2be0953f7889a34f6532008dc4167ca66fdaaf Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 15:07:39 +0200 Subject: [PATCH 007/387] Remove .stream --- packages/riverpod/CHANGELOG.md | 2 +- .../riverpod/lib/src/stream_provider.dart | 17 - .../lib/src/stream_provider/auto_dispose.dart | 7 - .../lib/src/stream_provider/base.dart | 7 - ...o_dispose_family_stream_provider_test.dart | 4 - .../auto_dispose_stream_provider_test.dart | 42 +- .../stream_provider_family_test.dart | 6 - .../stream_provider/stream_provider_test.dart | 382 +----------------- 8 files changed, 10 insertions(+), 457 deletions(-) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 083318011..a4698ec66 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -3,7 +3,7 @@ - **Breaking**: `AsyncValue` is now "sealed" and `AsyncData/AsyncLoading/AsyncError` are "final". This means that it is no-longer possible to subclass `AsyncValue` or the associated classes. -- **Breaking**: Removed the deprecated from/argument/debugGetCreateSourceHash of providers +- **Breaking**: Removed everything marked as "deprecated" - Bumped minimum Dart SDK to >= 3.0.0-dev ## 2.3.6 - 2023-04-24 diff --git a/packages/riverpod/lib/src/stream_provider.dart b/packages/riverpod/lib/src/stream_provider.dart index 6eadcab2d..42a19b7aa 100644 --- a/packages/riverpod/lib/src/stream_provider.dart +++ b/packages/riverpod/lib/src/stream_provider.dart @@ -25,17 +25,6 @@ ProviderElementProxy, Future> _future( ); } -ProviderElementProxy, Stream> _stream( - _StreamProviderBase that, -) { - return ProviderElementProxy, Stream>( - that, - (element) { - return (element as StreamProviderElement)._streamNotifier; - }, - ); -} - abstract class _StreamProviderBase extends ProviderBase> { const _StreamProviderBase({ required super.allTransitiveDependencies, @@ -48,11 +37,5 @@ abstract class _StreamProviderBase extends ProviderBase> { ProviderListenable> get future; - @Deprecated( - '.stream will be removed in 3.0.0. As a replacement, either listen to the ' - 'provider itself (AsyncValue) or .future.', - ) - ProviderListenable> get stream; - Stream _create(covariant StreamProviderElement ref); } diff --git a/packages/riverpod/lib/src/stream_provider/auto_dispose.dart b/packages/riverpod/lib/src/stream_provider/auto_dispose.dart index f847f4dc4..f2cc548d9 100644 --- a/packages/riverpod/lib/src/stream_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/stream_provider/auto_dispose.dart @@ -49,13 +49,6 @@ class AutoDisposeStreamProvider extends _StreamProviderBase @override late final Refreshable> future = _future(this); - @Deprecated( - '.stream will be removed in 3.0.0. As a replacement, either listen to the ' - 'provider itself (AsyncValue) or .future.', - ) - @override - late final Refreshable> stream = _stream(this); - /// {@macro riverpod.overridewith} Override overrideWith( Create, AutoDisposeStreamProviderRef> create, diff --git a/packages/riverpod/lib/src/stream_provider/base.dart b/packages/riverpod/lib/src/stream_provider/base.dart index 630d5df58..ec2521901 100644 --- a/packages/riverpod/lib/src/stream_provider/base.dart +++ b/packages/riverpod/lib/src/stream_provider/base.dart @@ -108,13 +108,6 @@ class StreamProvider extends _StreamProviderBase @override late final AlwaysAliveRefreshable> future = _future(this); - @Deprecated( - '.stream will be removed in 3.0.0. As a replacement, either listen to the ' - 'provider itself (AsyncValue) or .future.', - ) - @override - late final AlwaysAliveRefreshable> stream = _stream(this); - @override Stream _create(StreamProviderElement ref) => _createFn(ref); diff --git a/packages/riverpod/test/providers/stream_provider/auto_dispose_family_stream_provider_test.dart b/packages/riverpod/test/providers/stream_provider/auto_dispose_family_stream_provider_test.dart index dae234a94..e0b124920 100644 --- a/packages/riverpod/test/providers/stream_provider/auto_dispose_family_stream_provider_test.dart +++ b/packages/riverpod/test/providers/stream_provider/auto_dispose_family_stream_provider_test.dart @@ -21,8 +21,6 @@ void main() { final root = createContainer(); final container = createContainer(parent: root, overrides: [provider]); - // ignore: deprecated_member_use_from_same_package - expect(await container.read(provider(0).stream).first, 0); expect(await container.read(provider(0).future), 0); expect(container.read(provider(0)), const AsyncData(0)); expect(root.getAllProviderElements(), isEmpty); @@ -95,8 +93,6 @@ void main() { overrides: [dep.overrideWithValue(42)], ); - // ignore: deprecated_member_use_from_same_package - await expectLater(container.read(provider(10).stream), emits(52)); await expectLater(container.read(provider(10).future), completion(52)); expect(container.read(provider(10)), const AsyncData(52)); diff --git a/packages/riverpod/test/providers/stream_provider/auto_dispose_stream_provider_test.dart b/packages/riverpod/test/providers/stream_provider/auto_dispose_stream_provider_test.dart index f8b365c07..6a9b27a19 100644 --- a/packages/riverpod/test/providers/stream_provider/auto_dispose_stream_provider_test.dart +++ b/packages/riverpod/test/providers/stream_provider/auto_dispose_stream_provider_test.dart @@ -59,8 +59,6 @@ void main() { overrides: [dep.overrideWithValue(42)], ); - // ignore: deprecated_member_use_from_same_package - await expectLater(container.read(provider.stream), emits(42)); await expectLater(container.read(provider.future), completion(42)); expect(container.read(provider), const AsyncData(42)); @@ -80,9 +78,8 @@ void main() { container.listen(provider, (prev, value) {}); await expectLater( - // ignore: deprecated_member_use_from_same_package - container.read(provider.stream), - emits(42), + container.read(provider.future), + completion(42), ); expect( container.read(provider), @@ -106,9 +103,8 @@ void main() { verifyNoMoreInteractions(listener); await expectLater( - // ignore: deprecated_member_use_from_same_package - container.read(provider.stream), - emits(21), + container.read(provider.future), + completion(21), ); expect( container.read(provider), @@ -124,8 +120,6 @@ void main() { container.listen(provider, (_, __) {}); - // ignore: deprecated_member_use_from_same_package - expect(container.read(provider.stream), emits(0)); expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); @@ -136,8 +130,6 @@ void main() { .copyWithPrevious(const AsyncValue.data(0)), ); - // ignore: deprecated_member_use_from_same_package - expect(container.read(provider.stream), emits(1)); expect(await container.read(provider.future), 1); expect(container.read(provider), const AsyncValue.data(1)); }); @@ -162,28 +154,6 @@ void main() { verifyNoMoreInteractions(listener); }); - test( - '.stream does not update dependents if the created stream did not change', - () async { - final container = createContainer(); - final dep = StateProvider((ref) => 0); - final provider = StreamProvider.autoDispose((ref) { - ref.watch(dep); - return const Stream.empty(); - }); - final listener = Listener>(); - - // ignore: deprecated_member_use_from_same_package - container.listen(provider.stream, listener, fireImmediately: true); - - verifyOnly(listener, listener(any, any)); - - container.read(dep.notifier).state++; - await container.pump(); - - verifyNoMoreInteractions(listener); - }); - test( '.future does not update dependents if the created future did not change', () async { @@ -216,8 +186,6 @@ void main() { final root = createContainer(); final container = createContainer(parent: root, overrides: [provider]); - // ignore: deprecated_member_use_from_same_package - expect(await container.read(provider.stream).first, 0); expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); expect(root.getAllProviderElements(), isEmpty); @@ -267,8 +235,6 @@ void main() { ], ); - // ignore: deprecated_member_use_from_same_package - expect(await container.read(provider.stream).first, 42); expect(await container.read(provider.future), 42); expect(container.read(provider), const AsyncValue.data(42)); expect(root.getAllProviderElements(), isEmpty); diff --git a/packages/riverpod/test/providers/stream_provider/stream_provider_family_test.dart b/packages/riverpod/test/providers/stream_provider/stream_provider_family_test.dart index 6f48ec3e6..5d2fe72d7 100644 --- a/packages/riverpod/test/providers/stream_provider/stream_provider_family_test.dart +++ b/packages/riverpod/test/providers/stream_provider/stream_provider_family_test.dart @@ -20,8 +20,6 @@ void main() { final root = createContainer(); final container = createContainer(parent: root, overrides: [provider]); - // ignore: deprecated_member_use_from_same_package - expect(await container.read(provider(0).stream).first, 0); expect(await container.read(provider(0).future), 0); expect(container.read(provider(0)), const AsyncData(0)); expect(root.getAllProviderElements(), isEmpty); @@ -47,8 +45,6 @@ void main() { ], ); - // ignore: deprecated_member_use_from_same_package - expect(await container.read(provider(0).stream).first, 42); expect(await container.read(provider(0).future), 42); expect(container.read(provider(0)), const AsyncData(42)); expect(root.getAllProviderElements(), isEmpty); @@ -74,8 +70,6 @@ void main() { overrides: [dep.overrideWithValue(42)], ); - // ignore: deprecated_member_use_from_same_package - await expectLater(container.read(provider(10).stream), emits(52)); await expectLater(container.read(provider(10).future), completion(52)); expect(container.read(provider(10)), const AsyncData(52)); diff --git a/packages/riverpod/test/providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/providers/stream_provider/stream_provider_test.dart index 77352ba55..e396d5f6e 100644 --- a/packages/riverpod/test/providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/providers/stream_provider/stream_provider_test.dart @@ -228,8 +228,6 @@ void main() { overrides: [dep.overrideWithValue(42)], ); - // ignore: deprecated_member_use_from_same_package - await expectLater(container.read(provider.stream), emits(42)); await expectLater(container.read(provider.future), completion(42)); expect(container.read(provider), const AsyncData(42)); @@ -247,9 +245,8 @@ void main() { addTearDown(controller.close); await expectLater( - // ignore: deprecated_member_use_from_same_package - container.read(provider.stream), - emits(42), + container.read(provider.future), + completion(42), ); expect( container.read(provider), @@ -273,9 +270,8 @@ void main() { verifyNoMoreInteractions(listener); await expectLater( - // ignore: deprecated_member_use_from_same_package - container.read(provider.stream), - emits(21), + container.read(provider.future), + completion(21), ); expect( container.read(provider), @@ -288,8 +284,6 @@ void main() { final container = createContainer(); final provider = StreamProvider((ref) => Stream.value(result)); - // ignore: deprecated_member_use_from_same_package - expect(container.read(provider.stream), emits(0)); expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); @@ -299,8 +293,6 @@ void main() { const AsyncLoading().copyWithPrevious(const AsyncValue.data(0)), ); - // ignore: deprecated_member_use_from_same_package - expect(container.read(provider.stream), emits(1)); expect(await container.read(provider.future), 1); expect(container.read(provider), const AsyncValue.data(1)); }); @@ -311,8 +303,6 @@ void main() { final root = createContainer(); final container = createContainer(parent: root, overrides: [provider]); - // ignore: deprecated_member_use_from_same_package - expect(await container.read(provider.stream).first, 0); expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); expect(root.getAllProviderElements(), isEmpty); @@ -355,14 +345,10 @@ void main() { final container = createContainer( parent: root, overrides: [ - provider - // ignore: deprecated_member_use_from_same_package - .overrideWithProvider(StreamProvider((ref) => Stream.value(42))), + provider.overrideWith((ref) => Stream.value(42)), ], ); - // ignore: deprecated_member_use_from_same_package - expect(await container.read(provider.stream).first, 42); expect(await container.read(provider.future), 42); expect(container.read(provider), const AsyncValue.data(42)); expect(root.getAllProviderElements(), isEmpty); @@ -612,17 +598,6 @@ void main() { expect(sub.read(), const AsyncValue.data(42)); }); - test('provider.stream is a broadcast stream', () async { - controller = StreamController(); - - // ignore: deprecated_member_use_from_same_package - final sub = container.listen(provider.stream, (_, __) {}); - - controller.add(42); - - await expectLater(sub.read(), emits(42)); - }); - test('throwing inside "create" result in an AsyncValue.error', () { // ignore: only_throw_errors final provider = StreamProvider((ref) => throw 42); @@ -652,27 +627,6 @@ void main() { verifyNoMoreInteractions(listener); }); - test( - '.stream does not update dependents if the created stream did not change', - () async { - final dep = StateProvider((ref) => 0); - final provider = StreamProvider((ref) { - ref.watch(dep); - return const Stream.empty(); - }); - final listener = Listener>(); - - // ignore: deprecated_member_use_from_same_package - container.listen(provider.stream, listener, fireImmediately: true); - - verifyOnly(listener, listener(any, any)); - - container.read(dep.notifier).state++; - await container.pump(); - - verifyNoMoreInteractions(listener); - }); - test( '.future does not update dependents if the created future did not change', () async { @@ -912,110 +866,6 @@ void main() { await controller.close(); }); - group('StreamProvider().future', () { - test('does not update dependents when the future completes', () async { - final controller = StreamController(sync: true); - addTearDown(controller.close); - final provider = StreamProvider((_) => controller.stream); - final container = createContainer(); - var callCount = 0; - final dependent = Provider((ref) { - callCount++; - // ignore: deprecated_member_use_from_same_package - return ref.watch(provider.stream); - }); - - container.listen(dependent, (_, __) {}); - - expect(callCount, 1); - - controller.add(42); - // just making sure the dependent isn't updated asynchronously - await container.pump(); - - expect(callCount, 1); - }); - - test('.stream creates the stream once and it contains all events', - () async { - final currentStream = StateProvider((ref) => Stream.value(42)); - // a StreamProvider that can rebuild with a new future - final streamProvider = StreamProvider((ref) => ref.watch(currentStream)); - final container = createContainer(); - final listener = Listener>(); - - final sub = container.listen( - // ignore: deprecated_member_use_from_same_package - streamProvider.stream, - listener, - fireImmediately: true, - ); - - final stream = sub.read(); - - verifyOnly(listener, listener(null, sub.read())); - await expectLater(stream, emits(42)); - - container.read(currentStream.notifier).state = Stream.value(21); - await expectLater(stream, emits(21)); - - // Making sure providers are disposed, sending done events to ".stream". - container.dispose(); - - await expectLater(stream, emitsDone); - verifyNoMoreInteractions(listener); - }); - }); - - group('StreamProvider.autoDispose().stream', () { - test('does not update dependents when the future completes', () async { - final controller = StreamController(sync: true); - addTearDown(controller.close); - final provider = StreamProvider.autoDispose((_) => controller.stream); - final container = createContainer(); - var callCount = 0; - final dependent = Provider.autoDispose((ref) { - callCount++; - // ignore: deprecated_member_use_from_same_package - return ref.watch(provider.stream); - }); - - container.listen(dependent, (_, __) {}); - - expect(callCount, 1); - - controller.add(42); - - // just making sure the dependent isn't updated asynchronously - await container.pump(); - - expect(callCount, 1); - }); - - test('disposes the main provider when no longer used', () async { - final controller = StreamController(sync: true); - addTearDown(controller.close); - var didDispose = false; - final provider = StreamProvider.autoDispose((ref) { - ref.onDispose(() => didDispose = true); - return controller.stream; - }); - final container = createContainer(); - // ignore: deprecated_member_use_from_same_package - final sub = container.listen(provider.stream, (_, __) {}); - - expect(didDispose, false); - - await container.pump(); - expect(didDispose, false); - - sub.close(); - - await container.pump(); - expect(didDispose, true); - }); - }); - group('StreamProvider.future', () { group('from StreamProvider', () { test('read currentValue before first value', () async { @@ -1149,228 +999,6 @@ void main() { }); }); - group('StreamProvider.stream', () { - group('from StreamProvider', () { - test('read currentValue before first value', () async { - final container = createContainer(); - final controller = StreamController(); - final provider = StreamProvider((_) => controller.stream); - - // ignore: deprecated_member_use_from_same_package - final stream = container.read(provider.stream); - - controller.add(42); - - await expectLater(stream, emits(42)); - - await controller.close(); - }); - - test('read currentValue before after value', () async { - final container = createContainer(); - final controller = StreamController(); - final provider = StreamProvider((_) => controller.stream); - - controller.add(42); - - // ignore: deprecated_member_use_from_same_package - final stream = container.read(provider.stream); - - await expectLater(stream, emits(42)); - - await controller.close(); - }); - - test('read currentValue before first error', () async { - final container = createContainer(); - final controller = StreamController(); - final provider = StreamProvider((_) => controller.stream); - - // ignore: deprecated_member_use_from_same_package - final stream = container.read(provider.stream); - - controller.addError(42); - - await expectLater(stream, emitsError(42)); - - await controller.close(); - }); - - test('read currentValue before after error', () async { - final container = createContainer(); - final controller = StreamController(); - final provider = StreamProvider((_) => controller.stream); - - controller.addError(42); - - // ignore: deprecated_member_use_from_same_package - final stream = container.read(provider.stream); - - await expectLater(stream, emitsError(42)); - - await controller.close(); - }); - }); - - group('from StreamProvider.overrideWithValue', () { - // test('loading to data to loading creates a new stream too', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - - // final stream0 = container.read(provider.stream); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // final stream1 = container.read(provider.stream); - - // expect(stream0, stream1); - // await expectLater(stream1, emits(42)); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - - // final stream2 = container.read(provider.stream); - - // expect(stream2, isNot(stream1)); - // await expectLater(stream1, emitsDone); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(21)), - // ]); - - // await expectLater(stream2, emits(21)); - // }); - - // test('data to loading creates a new stream', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // final stream1 = container.read(provider.stream); - - // await expectLater(stream1, emits(42)); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - - // final stream2 = container.read(provider.stream); - - // expect(stream2, isNot(stream1)); - // await expectLater(stream1, emitsDone); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(21)), - // ]); - - // await expectLater(stream2, emits(21)); - // }); - - // test('error to loading creates a new stream', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.error(42)), - // ]); - - // final stream1 = container.read(provider.stream); - - // await expectLater(stream1, emitsError(42)); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - - // final stream2 = container.read(provider.stream); - - // expect(stream2, isNot(stream1)); - // await expectLater(stream1, emitsDone); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(21)), - // ]); - - // await expectLater(stream2, emits(21)); - // }); - - // test('read currentValue before first value', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - - // final stream = container.read(provider.stream); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // await expectLater(stream, emits(42)); - // }); - - // test('read currentValue before after value', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // final stream = container.read(provider.stream); - - // await expectLater(stream, emits(42)); - // }); - - // test('read currentValue before first error', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - - // final stream = container.read(provider.stream); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.error(42)), - // ]); - - // await expectLater(stream, emitsError(42)); - // }); - - // test('read currentValue before after error', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.error(42)), - // ]); - - // final stream = container.read(provider.stream); - - // await expectLater(stream, emitsError(42)); - // }); - - // test('synchronous first event', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // final stream = container.read(provider.stream); - - // await expectLater(stream, emits(42)); - // }); - }); - }); - group('mock as value', () { // test('value immediately then other value', () async { // final provider = StreamProvider((_) async* {}); From 7c1c5e9128dd169c12418b8f8df9d09fe275c216 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 15:10:26 +0200 Subject: [PATCH 008/387] Remove maintainState --- .../lib/src/framework/auto_dispose.dart | 12 +- packages/riverpod/lib/src/framework/ref.dart | 12 -- .../riverpod/lib/src/framework/scheduler.dart | 3 +- .../test/framework/auto_dispose_test.dart | 103 ------------------ 4 files changed, 2 insertions(+), 128 deletions(-) diff --git a/packages/riverpod/lib/src/framework/auto_dispose.dart b/packages/riverpod/lib/src/framework/auto_dispose.dart index b9d56d79a..bb9fe4a6e 100644 --- a/packages/riverpod/lib/src/framework/auto_dispose.dart +++ b/packages/riverpod/lib/src/framework/auto_dispose.dart @@ -6,16 +6,6 @@ mixin AutoDisposeProviderElementMixin on ProviderElementBase implements AutoDisposeRef { List? _keepAliveLinks; - bool _maintainState = false; - @Deprecated('Use `keepAlive()` instead') - @override - bool get maintainState => _maintainState; - @override - set maintainState(bool value) { - _maintainState = value; - if (!value) mayNeedDispose(); - } - @override KeepAliveLink keepAlive() { final links = _keepAliveLinks ??= []; @@ -36,7 +26,7 @@ mixin AutoDisposeProviderElementMixin on ProviderElementBase final links = _keepAliveLinks; // ignore: deprecated_member_use_from_same_package - if (!maintainState && !hasListeners && (links == null || links.isEmpty)) { + if (!hasListeners && (links == null || links.isEmpty)) { _container._scheduler.scheduleProviderDispose(this); } } diff --git a/packages/riverpod/lib/src/framework/ref.dart b/packages/riverpod/lib/src/framework/ref.dart index ff33398f7..f79dd0f72 100644 --- a/packages/riverpod/lib/src/framework/ref.dart +++ b/packages/riverpod/lib/src/framework/ref.dart @@ -314,18 +314,6 @@ abstract class Ref { /// [keepAlive] function to help determine if the state can be destroyed /// or not. abstract class AutoDisposeRef extends Ref { - /// Whether to destroy the state of the provider when all listeners are removed or not. - /// - /// Can be changed at any time, in which case when setting it to `false`, - /// may destroy the provider state if it currently has no listeners. - /// - /// Defaults to `false`. - @Deprecated('use keepAlive() instead') - bool get maintainState; - - @Deprecated('use keepAlive() instead') - set maintainState(bool value); - /// Requests for the state of a provider to not be disposed when all the /// listeners of the provider are removed. /// diff --git a/packages/riverpod/lib/src/framework/scheduler.dart b/packages/riverpod/lib/src/framework/scheduler.dart index 365dc04ed..765d33e07 100644 --- a/packages/riverpod/lib/src/framework/scheduler.dart +++ b/packages/riverpod/lib/src/framework/scheduler.dart @@ -87,8 +87,7 @@ class _ProviderScheduler { final links = element._keepAliveLinks; // ignore: deprecated_member_use_from_same_package - if (element.maintainState || - (links != null && links.isNotEmpty) || + if ((links != null && links.isNotEmpty) || element.hasListeners || element._container._disposed) { continue; diff --git a/packages/riverpod/test/framework/auto_dispose_test.dart b/packages/riverpod/test/framework/auto_dispose_test.dart index 7de599a3d..3a1f5a89f 100644 --- a/packages/riverpod/test/framework/auto_dispose_test.dart +++ b/packages/riverpod/test/framework/auto_dispose_test.dart @@ -149,38 +149,6 @@ Future main() async { ); }); - test( - 'when closing KeepAliveLink, does not dispose the provider maintainState=true', - () async { - final container = createContainer(); - late KeepAliveLink a; - late AutoDisposeRef ref; - - final provider = Provider.autoDispose((r) { - ref = r; - r.maintainState = true; - a = ref.keepAlive(); - }); - - container.read(provider); - - a.close(); - await container.pump(); - - expect( - container.getAllProviderElements().map((e) => e.provider), - [provider], - ); - - ref.maintainState = false; - await container.pump(); - - expect( - container.getAllProviderElements().map((e) => e.provider), - isEmpty, - ); - }); - test( 'when closing the last KeepAliveLink, then immediately adding a new link, ' 'the provider will not be disposed.', () async { @@ -361,7 +329,6 @@ final alwaysAlive = Provider((ref) { final provider = Provider.autoDispose( name: 'provider', (ref) { - ref.maintainState = true; if (ref.watch(isDependendingOnDependency)) { ref.watch(dependency); } @@ -561,76 +528,6 @@ final alwaysAlive = Provider((ref) { expect(container.read(isEven), true); }); - test('setting maintainState to false destroys the state when not listened to', - () async { - final onDispose = OnDisposeMock(); - late AutoDisposeRef ref; - final provider = Provider.autoDispose((r) { - ref = r; - ref.onDispose(onDispose); - ref.maintainState = true; - }); - final container = createContainer(); - - final sub = container.listen(provider, (prev, value) {}); - sub.close(); - - await container.pump(); - - verifyZeroInteractions(onDispose); - - ref.maintainState = false; - - verifyZeroInteractions(onDispose); - - await container.pump(); - - verify(onDispose()).called(1); - verifyNoMoreInteractions(onDispose); - }); - - test( - "maintainState to true don't dispose the state when no longer listened to", - () async { - var value = 42; - final onDispose = OnDisposeMock(); - final provider = Provider.autoDispose((ref) { - ref.onDispose(onDispose); - ref.maintainState = true; - return value; - }); - final container = createContainer(); - final listener = Listener(); - - final sub = container.listen(provider, listener, fireImmediately: true); - verify(listener(null, 42)).called(1); - verifyNoMoreInteractions(listener); - sub.close(); - - await container.pump(); - - verifyZeroInteractions(onDispose); - - value = 21; - container.listen(provider, listener, fireImmediately: true); - - verify(listener(null, 42)).called(1); - verifyNoMoreInteractions(listener); - }); - - test('maintainState defaults to false', () { - late bool maintainState; - final provider = Provider.autoDispose((ref) { - maintainState = ref.maintainState; - return 42; - }); - final container = createContainer(); - - container.listen(provider, (prev, value) {}); - - expect(maintainState, false); - }); - test('unsub to A then make B sub to A then unsub to B disposes B before A', () async { final container = createContainer(); From a39b2c5fb401ccb87959687d90c2cbfdec68e1d9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 15:15:16 +0200 Subject: [PATCH 009/387] Remove deprecated container properties --- .../riverpod/lib/src/framework/container.dart | 23 ------------------- 1 file changed, 23 deletions(-) diff --git a/packages/riverpod/lib/src/framework/container.dart b/packages/riverpod/lib/src/framework/container.dart index 5e674d72d..5f2035ece 100644 --- a/packages/riverpod/lib/src/framework/container.dart +++ b/packages/riverpod/lib/src/framework/container.dart @@ -141,21 +141,6 @@ class ProviderContainer implements Node { final int _debugOverridesLength; - /// A function that controls the refresh rate of providers. - /// - /// Defaults to refreshing providers at the end of the next event-loop. - @Deprecated('Will be removed in 3.0.0') - @internal - void Function(void Function() task) get vsync { - return vsyncOverride ?? _defaultVsync; - } - - /// A way to override [vsync], used by Flutter to synchronize a container - /// with the widget tree. - @Deprecated('Will be removed in 3.0.0') - @internal - void Function(void Function() task)? vsyncOverride; - /// The object that handles when providers are refreshed and disposed. late final _ProviderScheduler _scheduler = _parent?._scheduler ?? _ProviderScheduler(); @@ -181,14 +166,6 @@ class ProviderContainer implements Node { final List _observers; - /// A debug utility used by `flutter_riverpod`/`hooks_riverpod` to check - /// if it is safe to modify a provider. - /// - /// This corresponds to all the widgets that a [Provider] is associated with. - @Deprecated('Will be removed in 3.0.0') - @internal - void Function()? debugCanModifyProviders; - /// Whether [dispose] was called or not. /// /// This disables the different methods of [ProviderContainer], resulting in From 6c29267d19312f39107efc962ee9f6e1006e9896 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 15:30:23 +0200 Subject: [PATCH 010/387] Remove overrideWithProvider --- .../src/change_notifier_provider/base.dart | 2 +- ...dispose_change_notifier_provider_test.dart | 7 +-- .../change_notifier_provider_test.dart | 15 ++---- ...dispose_change_notifier_provider_test.dart | 8 +-- .../family_change_notifier_provider_test.dart | 11 ++-- .../riverpod/lib/src/framework/family.dart | 9 ---- .../lib/src/framework/provider_base.dart | 50 ------------------- packages/riverpod/lib/src/provider/base.dart | 2 +- .../riverpod/test/framework/family_test.dart | 19 ------- .../framework/provider_container_test.dart | 25 +--------- .../riverpod/test/framework/scope_test.dart | 38 ++++---------- ...o_dispose_family_future_provider_test.dart | 6 +-- .../auto_dispose_future_provider_test.dart | 8 +-- .../family_future_provider_test.dart | 6 +-- .../future_provider/future_provider_test.dart | 5 +- .../auto_dispose_provider_family_test.dart | 8 ++- .../provider/auto_dispose_provider_test.dart | 20 +------- .../provider/provider_family_test.dart | 6 +-- .../providers/provider/provider_test.dart | 5 +- .../auto_dispose_family_test.dart | 8 +-- ..._dispose_state_notifier_provider_test.dart | 16 ++---- .../state_notifier_provider/family_test.dart | 12 ++--- .../state_notifier_provider_test.dart | 25 ++-------- .../state_provider_auto_dispose_test.dart | 11 ++-- ...ate_provider_family_auto_dispose_test.dart | 6 +-- .../state_provider_family_test.dart | 10 ++-- .../state_provider/state_provider_test.dart | 13 ++--- ...o_dispose_family_stream_provider_test.dart | 6 +-- .../auto_dispose_stream_provider_test.dart | 7 +-- .../stream_provider_family_test.dart | 10 ++-- .../stream_provider/stream_provider_test.dart | 2 +- 31 files changed, 78 insertions(+), 298 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart b/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart index a27c01233..fbafcdc16 100644 --- a/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart +++ b/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart @@ -146,7 +146,7 @@ class ChangeNotifierProvider /// ProviderScope( /// overrides: [ /// // Replace the implementation of the provider with a different one - /// myService.overrideWithProvider((ref) { + /// myService.overrideWith((ref) { /// ref.watch('other'); /// return MyFakeService(), /// })), diff --git a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart index ec16402a9..397cc079a 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart @@ -111,17 +111,14 @@ void main() { // expect(root.getAllProviderElements(), isEmpty); // }); - test('when using provider.overrideWithProvider', () { + test('when using provider.overrideWith', () { final provider = ChangeNotifierProvider.autoDispose((ref) => ValueNotifier(0)); final root = createContainer(); final container = createContainer( parent: root, overrides: [ - // ignore: deprecated_member_use - provider.overrideWithProvider( - ChangeNotifierProvider.autoDispose((ref) => ValueNotifier(42)), - ), + provider.overrideWith((ref) => ValueNotifier(42)), ], ); diff --git a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart index 60fe8bcc4..8f0e98cfa 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart @@ -187,16 +187,13 @@ void main() { // expect(root.getAllProviderElements(), isEmpty); // }); - test('when using provider.overrideWithProvider', () { + test('when using provider.overrideWith', () { final provider = ChangeNotifierProvider((ref) => ValueNotifier(0)); final root = createContainer(); final container = createContainer( parent: root, overrides: [ - // ignore: deprecated_member_use - provider.overrideWithProvider( - ChangeNotifierProvider((ref) => ValueNotifier(42)), - ), + provider.overrideWith((ref) => ValueNotifier(42)), ], ); @@ -408,7 +405,7 @@ void main() { expect(root.getAllProviderElements(), isEmpty); }); - test('overrideWithProvider preserves the state across update', () async { + test('overrideWith preserves the state across update', () async { final provider = ChangeNotifierProvider((_) { return TestNotifier(); }); @@ -416,8 +413,7 @@ void main() { final notifier2 = TestNotifier(); final container = createContainer( overrides: [ - // ignore: deprecated_member_use - provider.overrideWithProvider(ChangeNotifierProvider((_) => notifier)), + provider.overrideWith((_) => notifier), ], ); addTearDown(container.dispose); @@ -436,8 +432,7 @@ void main() { expect(callCount, 1); container.updateOverrides([ - // ignore: deprecated_member_use - provider.overrideWithProvider(ChangeNotifierProvider((_) => notifier2)), + provider.overrideWith((_) => notifier2), ]); await container.pump(); diff --git a/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart index 9d495c413..e265e67f7 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart @@ -69,18 +69,14 @@ void main() { expect(root.getAllProviderElements(), isEmpty); }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final provider = ChangeNotifierProvider.autoDispose .family, int>((ref, _) => ValueNotifier(0)); final root = createContainer(); final container = createContainer( parent: root, overrides: [ - provider.overrideWithProvider( - (value) => ChangeNotifierProvider.autoDispose( - (ref) => ValueNotifier(42), - ), - ), + provider.overrideWith((ref, value) => ValueNotifier(42)), ], ); diff --git a/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart index 8a028db84..be9ecb317 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart @@ -68,7 +68,7 @@ void main() { expect(root.getAllProviderElements(), isEmpty); }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final provider = ChangeNotifierProvider.family, int>( (ref, _) => ValueNotifier(0), ); @@ -76,9 +76,7 @@ void main() { final container = createContainer( parent: root, overrides: [ - provider.overrideWithProvider( - (value) => ChangeNotifierProvider((ref) => ValueNotifier(42)), - ), + provider.overrideWith((ref, value) => ValueNotifier(42)), ], ); @@ -101,10 +99,7 @@ void main() { }); final container = createContainer( overrides: [ - provider.overrideWithProvider( - (value) => - ChangeNotifierProvider((ref) => ValueNotifier(value * 2)), - ), + provider.overrideWith((ref, value) => ValueNotifier(value * 2)), ], ); diff --git a/packages/riverpod/lib/src/framework/family.dart b/packages/riverpod/lib/src/framework/family.dart index bf348427f..bfd019983 100644 --- a/packages/riverpod/lib/src/framework/family.dart +++ b/packages/riverpod/lib/src/framework/family.dart @@ -57,15 +57,6 @@ mixin _FamilyMixin> /// See the documentation of [Provider.family] for more information. FamilyProvider call(Arg argument); - /// Overrides the behavior of a family for a part of the application. - /// - /// {@macro riverpod.overrideWith} - Override overrideWithProvider( - FamilyProvider Function(Arg argument) override, - ) { - return FamilyOverrideImpl(this, override); - } - @visibleForOverriding @override ProviderBase getProviderOverride(ProviderBase provider) { diff --git a/packages/riverpod/lib/src/framework/provider_base.dart b/packages/riverpod/lib/src/framework/provider_base.dart index d41657a69..d4cb03fab 100644 --- a/packages/riverpod/lib/src/framework/provider_base.dart +++ b/packages/riverpod/lib/src/framework/provider_base.dart @@ -246,53 +246,3 @@ mixin OverrideWithValueMixin on ProviderBase { ); } } - -/// A mixin to add `overrideWithProvider` capability to providers. -extension OverrideWithProviderExtension> on ProviderType { - /// {@template riverpod.overridewithprovider} - /// Overrides a provider with a value, ejecting the default behaviour. - /// - /// This will also disable the auto-scoping mechanism, meaning that if the - /// overridden provider specified `dependencies`, it will have no effect. - /// - /// The override must not specify a `dependencies`. - /// - /// Some common use-cases are: - /// - testing, by replacing a service with a fake implementation, or to reach - /// a very specific state easily. - /// - multiple environments, by changing the implementation of a class - /// based on the platform or other parameters. - /// - /// This function should be used in combination with `ProviderScope.overrides` - /// or `ProviderContainer.overrides`: - /// - /// ```dart - /// final myService = Provider((ref) => MyService()); - /// - /// runApp( - /// ProviderScope( - /// overrides: [ - /// myService.overrideWithProvider( - /// // Replace the implementation of the provider with a different one - /// Provider((ref) { - /// ref.watch('other'); - /// return MyFakeService(), - /// }), - /// ), - /// ], - /// child: MyApp(), - /// ), - /// ); - /// ``` - /// {@endtemplate} - @Deprecated('Will be removed in 3.0.0. Use overrideWith instead.') - Override overrideWithProvider(ProviderType override) { - assert( - override.dependencies == null, - 'When using overrideWithProvider, the override cannot specify `dependencies`.', - ); - - return ProviderOverride(origin: this, override: override); - } -} diff --git a/packages/riverpod/lib/src/provider/base.dart b/packages/riverpod/lib/src/provider/base.dart index ac4e5d7e5..8c42934d8 100644 --- a/packages/riverpod/lib/src/provider/base.dart +++ b/packages/riverpod/lib/src/provider/base.dart @@ -81,7 +81,7 @@ class Provider extends InternalProvider /// ProviderScope( /// overrides: [ /// // Replace the implementation of the provider with a different one - /// myService.overrideWithProvider((ref) { + /// myService.overrideWith((ref) { /// ref.watch('other'); /// return MyFakeService(), /// })), diff --git a/packages/riverpod/test/framework/family_test.dart b/packages/riverpod/test/framework/family_test.dart index 436904dfd..7624616ba 100644 --- a/packages/riverpod/test/framework/family_test.dart +++ b/packages/riverpod/test/framework/family_test.dart @@ -7,25 +7,6 @@ import 'package:test/test.dart'; import '../utils.dart'; void main() { - test('throw if overrideWithProvider returns a provider with dependencies', - () { - final family = Provider.family((ref, _) => 0); - final a = Provider((ref) => 0); - - final container = createContainer( - overrides: [ - family.overrideWithProvider( - (argument) => Provider((ref) => 0, dependencies: [a]), - ), - ], - ); - - expect( - () => container.read(family(42)), - throwsA(isA()), - ); - }); - test( 'does not re-initialize a family if read by a child container after the provider was initialized', () { diff --git a/packages/riverpod/test/framework/provider_container_test.dart b/packages/riverpod/test/framework/provider_container_test.dart index 0c89eedb1..de9719774 100644 --- a/packages/riverpod/test/framework/provider_container_test.dart +++ b/packages/riverpod/test/framework/provider_container_test.dart @@ -233,23 +233,6 @@ void main() { verifyOnly(listener, listener(0, 1)); }); - test( - 'when using overrideWithProvider, handles overriding with a more specific provider type', - () { - final fooProvider = Provider((ref) => Foo()); - - final container = createContainer( - overrides: [ - // ignore: deprecated_member_use_from_same_package - fooProvider.overrideWithProvider( - Provider((ref) => Bar()), - ), - ], - ); - - expect(container.read(fooProvider), isA()); - }); - test( 'when the same provider is overridden multiple times at once, uses the latest override', () { @@ -274,8 +257,8 @@ void main() { final provider = Provider.family((ref, value) => 0); final container = createContainer( overrides: [ - provider.overrideWithProvider((value) => Provider((ref) => 21)), - provider.overrideWithProvider((value) => Provider((ref) => 42)), + provider.overrideWith((ref, value) => 21), + provider.overrideWith((ref, value) => 42), ], ); @@ -726,7 +709,3 @@ void main() { ); }); } - -class Foo {} - -class Bar extends Foo {} diff --git a/packages/riverpod/test/framework/scope_test.dart b/packages/riverpod/test/framework/scope_test.dart index 366fd2ceb..13519df58 100644 --- a/packages/riverpod/test/framework/scope_test.dart +++ b/packages/riverpod/test/framework/scope_test.dart @@ -74,7 +74,7 @@ Future main() async { final mid = createContainer( parent: root, overrides: [ - a.overrideWithProvider((argument) => Provider((ref) => argument + 10)), + a.overrideWith((ref, argument) => argument + 10), ], ); @@ -83,7 +83,7 @@ Future main() async { final child = createContainer( parent: mid, overrides: [ - a.overrideWithProvider((argument) => Provider((ref) => argument + 20)), + a.overrideWith((ref, argument) => argument + 20), ], ); @@ -100,14 +100,14 @@ Future main() async { final mid = createContainer( parent: root, overrides: [ - a.overrideWithProvider((argument) => Provider((ref) => argument + 10)), + a.overrideWith((ref, argument) => argument + 10), ], ); final child = createContainer( parent: mid, overrides: [ - a.overrideWithProvider((argument) => Provider((ref) => argument + 20)), + a.overrideWith((ref, argument) => argument + 20), ], ); @@ -125,11 +125,9 @@ Future main() async { final mid = createContainer( parent: root, overrides: [ - a.overrideWithProvider((argument) { - return Provider((ref) { - overrideBuildCount++; - return argument + 10; - }); + a.overrideWith((ref, argument) { + overrideBuildCount++; + return argument + 10; }), ], ); @@ -774,21 +772,6 @@ final b = Provider( }); }); - test( - 'throw if non-family overrideWithProvider returns a provider with dependencies', - () { - final provider = Provider((ref) => 0); - final a = Provider((ref) => 0); - - expect( - // ignore: deprecated_member_use_from_same_package - () => provider.overrideWithProvider( - Provider((ref) => 0, dependencies: [a]), - ), - throwsA(isA()), - ); - }); - test('does not auto-scope provider overrides', () { final a = Provider((ref) => 0); final another = Provider((ref) => 42); @@ -798,8 +781,7 @@ final b = Provider( final root = createContainer( overrides: [ b.overrideWithValue(21), - // ignore: deprecated_member_use_from_same_package - c.overrideWithProvider(Provider((ref) => ref.watch(another) + 10)), + c.overrideWith((ref) => ref.watch(another) + 10), ], ); final container = createContainer( @@ -825,8 +807,8 @@ final b = Provider( final root = createContainer( overrides: [ - b.overrideWithProvider( - (value) => Provider((ref) => ref.watch(another) + value), + b.overrideWith( + (ref, value) => ref.watch(another) + value, ), ], ); diff --git a/packages/riverpod/test/providers/future_provider/auto_dispose_family_future_provider_test.dart b/packages/riverpod/test/providers/future_provider/auto_dispose_family_future_provider_test.dart index 793309d15..89f86635b 100644 --- a/packages/riverpod/test/providers/future_provider/auto_dispose_family_future_provider_test.dart +++ b/packages/riverpod/test/providers/future_provider/auto_dispose_family_future_provider_test.dart @@ -45,7 +45,7 @@ void main() { expect(root.getAllProviderElements(), isEmpty); }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final provider = FutureProvider.autoDispose.family((ref, _) { return 0; }); @@ -53,9 +53,7 @@ void main() { final container = createContainer( parent: root, overrides: [ - provider.overrideWithProvider( - (value) => FutureProvider.autoDispose((ref) => 42), - ), + provider.overrideWith((ref, value) => 42), ], ); diff --git a/packages/riverpod/test/providers/future_provider/auto_dispose_future_provider_test.dart b/packages/riverpod/test/providers/future_provider/auto_dispose_future_provider_test.dart index 22c812fcb..bac824592 100644 --- a/packages/riverpod/test/providers/future_provider/auto_dispose_future_provider_test.dart +++ b/packages/riverpod/test/providers/future_provider/auto_dispose_future_provider_test.dart @@ -244,16 +244,12 @@ void main() { // ]); // }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final provider = FutureProvider.autoDispose((ref) async => 0); final root = createContainer(); final container = createContainer( parent: root, - overrides: [ - provider - // ignore: deprecated_member_use_from_same_package - .overrideWithProvider(FutureProvider.autoDispose((ref) => 42)), - ], + overrides: [provider.overrideWith((ref) => 42)], ); expect(await container.read(provider.future), 42); diff --git a/packages/riverpod/test/providers/future_provider/family_future_provider_test.dart b/packages/riverpod/test/providers/future_provider/family_future_provider_test.dart index 370ffe53a..6f82a80f8 100644 --- a/packages/riverpod/test/providers/future_provider/family_future_provider_test.dart +++ b/packages/riverpod/test/providers/future_provider/family_future_provider_test.dart @@ -44,15 +44,13 @@ void main() { expect(root.getAllProviderElements(), isEmpty); }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final provider = FutureProvider.family((ref, _) async => 0); final root = createContainer(); final container = createContainer( parent: root, overrides: [ - provider.overrideWithProvider( - (value) => FutureProvider((ref) async => 42), - ), + provider.overrideWith((ref, value) async => 42), ], ); diff --git a/packages/riverpod/test/providers/future_provider/future_provider_test.dart b/packages/riverpod/test/providers/future_provider/future_provider_test.dart index cda0ead76..11b20cca0 100644 --- a/packages/riverpod/test/providers/future_provider/future_provider_test.dart +++ b/packages/riverpod/test/providers/future_provider/future_provider_test.dart @@ -464,14 +464,13 @@ void main() { // ]); // }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final provider = FutureProvider((ref) async => 0); final root = createContainer(); final container = createContainer( parent: root, overrides: [ - // ignore: deprecated_member_use_from_same_package - provider.overrideWithProvider(FutureProvider((ref) async => 42)), + provider.overrideWith((ref) async => 42), ], ); diff --git a/packages/riverpod/test/providers/provider/auto_dispose_provider_family_test.dart b/packages/riverpod/test/providers/provider/auto_dispose_provider_family_test.dart index cb853d4e0..d13c4165a 100644 --- a/packages/riverpod/test/providers/provider/auto_dispose_provider_family_test.dart +++ b/packages/riverpod/test/providers/provider/auto_dispose_provider_family_test.dart @@ -76,11 +76,9 @@ void main() { final listener = Listener(); final container = ProviderContainer( overrides: [ - provider.overrideWithProvider((value) { - return Provider.autoDispose((ref) { - ref.onDispose(onDispose); - return '$value override'; - }); + provider.overrideWith((ref, value) { + ref.onDispose(onDispose); + return '$value override'; }) ], ); diff --git a/packages/riverpod/test/providers/provider/auto_dispose_provider_test.dart b/packages/riverpod/test/providers/provider/auto_dispose_provider_test.dart index 71c16ca51..c112fd2fb 100644 --- a/packages/riverpod/test/providers/provider/auto_dispose_provider_test.dart +++ b/packages/riverpod/test/providers/provider/auto_dispose_provider_test.dart @@ -147,14 +147,13 @@ void main() { expect(root.getAllProviderElements(), isEmpty); }); - test('when using provider.overrideWithProvider', () { + test('when using provider.overrideWith', () { final provider = Provider.autoDispose((ref) => 0); final root = createContainer(); final container = createContainer( parent: root, overrides: [ - // ignore: deprecated_member_use_from_same_package - provider.overrideWithProvider(Provider.autoDispose((ref) => 42)), + provider.overrideWith((ref) => 42), ], ); @@ -167,21 +166,6 @@ void main() { }); }); - test('can be overridden by anything', () { - final provider = Provider.autoDispose((_) => 42); - final override = Provider.autoDispose((_) { - return 21; - }); - final container = createContainer( - overrides: [ - // ignore: deprecated_member_use_from_same_package - provider.overrideWithProvider(override), - ], - ); - - expect(container.read(provider), 21); - }); - test('can be auto-scoped', () async { final dep = Provider((ref) => 0); final provider = Provider.autoDispose( diff --git a/packages/riverpod/test/providers/provider/provider_family_test.dart b/packages/riverpod/test/providers/provider/provider_family_test.dart index 69c9aa0e4..d1468bfa0 100644 --- a/packages/riverpod/test/providers/provider/provider_family_test.dart +++ b/packages/riverpod/test/providers/provider/provider_family_test.dart @@ -26,14 +26,12 @@ void main() { expect(root.getAllProviderElements(), isEmpty); }); - test('when using provider.overrideWithProvider', () { + test('when using provider.overrideWith', () { final provider = Provider.family((ref, _) => 0); final root = createContainer(); final container = createContainer( parent: root, - overrides: [ - provider.overrideWithProvider((value) => Provider((ref) => 42)), - ], + overrides: [provider.overrideWith((ref, value) => 42)], ); expect(root.getAllProviderElements(), isEmpty); diff --git a/packages/riverpod/test/providers/provider/provider_test.dart b/packages/riverpod/test/providers/provider/provider_test.dart index be1cfd400..0a4bd0421 100644 --- a/packages/riverpod/test/providers/provider/provider_test.dart +++ b/packages/riverpod/test/providers/provider/provider_test.dart @@ -199,14 +199,13 @@ void main() { expect(root.getAllProviderElements(), isEmpty); }); - test('when using provider.overrideWithProvider', () { + test('when using provider.overrideWith', () { final provider = Provider((ref) => 0); final root = createContainer(); final container = createContainer( parent: root, overrides: [ - // ignore: deprecated_member_use_from_same_package - provider.overrideWithProvider(Provider((ref) => 42)), + provider.overrideWith((ref) => 42), ], ); diff --git a/packages/riverpod/test/providers/state_notifier_provider/auto_dispose_family_test.dart b/packages/riverpod/test/providers/state_notifier_provider/auto_dispose_family_test.dart index 149cf3598..009261ac7 100644 --- a/packages/riverpod/test/providers/state_notifier_provider/auto_dispose_family_test.dart +++ b/packages/riverpod/test/providers/state_notifier_provider/auto_dispose_family_test.dart @@ -56,7 +56,7 @@ void main() { expect(root.getAllProviderElementsInOrder(), isEmpty); }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final controller = StateController(0); final provider = StateNotifierProvider.autoDispose .family, int, int>((ref, _) => controller); @@ -65,11 +65,7 @@ void main() { final container = createContainer( parent: root, overrides: [ - provider.overrideWithProvider( - (value) => StateNotifierProvider.autoDispose( - (ref) => controllerOverride, - ), - ), + provider.overrideWith((ref, value) => controllerOverride), ], ); diff --git a/packages/riverpod/test/providers/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart b/packages/riverpod/test/providers/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart index 54dc4787a..f3b1f2b88 100644 --- a/packages/riverpod/test/providers/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart +++ b/packages/riverpod/test/providers/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart @@ -268,7 +268,7 @@ void main() { expect(callCount, 1); }); - test('overrideWithProvider preserves the state across update', () async { + test('overrideWith preserves the state across update', () async { final provider = StateNotifierProvider.autoDispose((_) { return TestNotifier(); }); @@ -276,12 +276,7 @@ void main() { final notifier2 = TestNotifier(21); final container = createContainer( overrides: [ - // ignore: deprecated_member_use_from_same_package - provider.overrideWithProvider( - StateNotifierProvider.autoDispose((_) { - return notifier; - }), - ), + provider.overrideWith((_) => notifier), ], ); addTearDown(container.dispose); @@ -298,12 +293,7 @@ void main() { verifyOnly(listener, listener(42, 43)); container.updateOverrides([ - // ignore: deprecated_member_use_from_same_package - provider.overrideWithProvider( - StateNotifierProvider.autoDispose((_) { - return notifier2; - }), - ), + provider.overrideWith((_) => notifier2), ]); await container.pump(); diff --git a/packages/riverpod/test/providers/state_notifier_provider/family_test.dart b/packages/riverpod/test/providers/state_notifier_provider/family_test.dart index 66756a6f0..033bdc295 100644 --- a/packages/riverpod/test/providers/state_notifier_provider/family_test.dart +++ b/packages/riverpod/test/providers/state_notifier_provider/family_test.dart @@ -57,7 +57,7 @@ void main() { expect(root.getAllProviderElementsInOrder(), isEmpty); }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final controller = StateController(0); final provider = StateNotifierProvider.family, int, int>( @@ -68,9 +68,7 @@ void main() { final container = createContainer( parent: root, overrides: [ - provider.overrideWithProvider( - (value) => StateNotifierProvider((ref) => controllerOverride), - ), + provider.overrideWith((ref, value) => controllerOverride), ], ); @@ -142,11 +140,7 @@ void main() { .family((ref, a) => TestNotifier()); final container = createContainer( overrides: [ - provider.overrideWithProvider((a) { - return StateNotifierProvider.autoDispose( - (ref) => notifier2, - ); - }), + provider.overrideWith((ref, a) => notifier2), ], ); addTearDown(container.dispose); diff --git a/packages/riverpod/test/providers/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/providers/state_notifier_provider/state_notifier_provider_test.dart index 13804c302..274a6d2f8 100644 --- a/packages/riverpod/test/providers/state_notifier_provider/state_notifier_provider_test.dart +++ b/packages/riverpod/test/providers/state_notifier_provider/state_notifier_provider_test.dart @@ -204,7 +204,7 @@ void main() { // ); // }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final controller = StateController(0); final provider = StateNotifierProvider.autoDispose, int>( @@ -215,12 +215,7 @@ void main() { final container = createContainer( parent: root, overrides: [ - // ignore: deprecated_member_use_from_same_package - provider.overrideWithProvider( - StateNotifierProvider.autoDispose, int>( - (ref) => controllerOverride, - ), - ), + provider.overrideWith((ref) => controllerOverride), ], ); @@ -420,7 +415,7 @@ void main() { // verifyOnly(listener, listener(21, 22)); // }); - test('overrideWithProvider preserves the state across update', () async { + test('overrideWith preserves the state across update', () async { final provider = StateNotifierProvider((_) { return TestNotifier(); }); @@ -428,12 +423,7 @@ void main() { final notifier2 = TestNotifier(21); final container = createContainer( overrides: [ - // ignore: deprecated_member_use_from_same_package - provider.overrideWithProvider( - StateNotifierProvider((_) { - return notifier; - }), - ), + provider.overrideWith((_) => notifier), ], ); addTearDown(container.dispose); @@ -451,12 +441,7 @@ void main() { verifyOnly(listener, listener(42, 43)); container.updateOverrides([ - // ignore: deprecated_member_use_from_same_package - provider.overrideWithProvider( - StateNotifierProvider((_) { - return notifier2; - }), - ), + provider.overrideWith((_) => notifier2), ]); await container.pump(); diff --git a/packages/riverpod/test/providers/state_provider/state_provider_auto_dispose_test.dart b/packages/riverpod/test/providers/state_provider/state_provider_auto_dispose_test.dart index f2271483a..b5dab56f8 100644 --- a/packages/riverpod/test/providers/state_provider/state_provider_auto_dispose_test.dart +++ b/packages/riverpod/test/providers/state_provider/state_provider_auto_dispose_test.dart @@ -172,16 +172,13 @@ void main() { // ); // }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final provider = StateProvider.autoDispose((ref) => 0, name: 'true'); final root = createContainer(); final container = createContainer( parent: root, overrides: [ - // ignore: deprecated_member_use_from_same_package - provider.overrideWithProvider( - StateProvider.autoDispose((ref) => 42, name: 'meh'), - ), + provider.overrideWith((ref) => 42), ], ); @@ -198,7 +195,7 @@ void main() { }); }); - group('overrideWithProvider', () { + group('overrideWith', () { // test('listens to state changes', () { // final override = StateController(42); // final provider = StateProvider.autoDispose((ref) => 0); @@ -207,7 +204,7 @@ void main() { // ]); // addTearDown(container.dispose); // final container2 = ProviderContainer(overrides: [ - // provider.overrideWithProvider( + // provider.overrideWith( // StateProvider.autoDispose((ref) => 42), // ), // ]); diff --git a/packages/riverpod/test/providers/state_provider/state_provider_family_auto_dispose_test.dart b/packages/riverpod/test/providers/state_provider/state_provider_family_auto_dispose_test.dart index c525d24c5..dc9a53d54 100644 --- a/packages/riverpod/test/providers/state_provider/state_provider_family_auto_dispose_test.dart +++ b/packages/riverpod/test/providers/state_provider/state_provider_family_auto_dispose_test.dart @@ -46,16 +46,14 @@ void main() { expect(root.getAllProviderElementsInOrder(), isEmpty); }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final provider = StateProvider.autoDispose.family((ref, _) => 0); final root = createContainer(); final container = createContainer( parent: root, overrides: [ - provider.overrideWithProvider( - (value) => StateProvider.autoDispose((ref) => 42), - ), + provider.overrideWith((ref, value) => 42), ], ); diff --git a/packages/riverpod/test/providers/state_provider/state_provider_family_test.dart b/packages/riverpod/test/providers/state_provider/state_provider_family_test.dart index 65698ac4e..66d28a515 100644 --- a/packages/riverpod/test/providers/state_provider/state_provider_family_test.dart +++ b/packages/riverpod/test/providers/state_provider/state_provider_family_test.dart @@ -43,15 +43,13 @@ void main() { expect(root.getAllProviderElementsInOrder(), isEmpty); }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final provider = StateProvider.family((ref, _) => 0); final root = createContainer(); final container = createContainer( parent: root, overrides: [ - provider.overrideWithProvider( - (value) => StateProvider((ref) => 42), - ), + provider.overrideWith((ref, value) => 42), ], ); @@ -102,9 +100,7 @@ void main() { }); final container = createContainer( overrides: [ - provider.overrideWithProvider((a) { - return StateProvider((ref) => 'override $a'); - }), + provider.overrideWith((ref, a) => 'override $a'), ], ); diff --git a/packages/riverpod/test/providers/state_provider/state_provider_test.dart b/packages/riverpod/test/providers/state_provider/state_provider_test.dart index 88b9d9962..09b4813dc 100644 --- a/packages/riverpod/test/providers/state_provider/state_provider_test.dart +++ b/packages/riverpod/test/providers/state_provider/state_provider_test.dart @@ -284,16 +284,13 @@ void main() { // ); // }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final provider = StateProvider((ref) => 0); final root = createContainer(); final container = createContainer( parent: root, overrides: [ - // ignore: deprecated_member_use_from_same_package - provider.overrideWithProvider( - StateProvider((ref) => 42), - ), + provider.overrideWith((ref) => 42), ], ); @@ -333,7 +330,7 @@ void main() { // }, // ); - group('overrideWithProvider', () { + group('overrideWith', () { // test('listens to state changes', () { // final override = StateController(21); // final provider = StateProvider((ref) => 0); @@ -342,8 +339,8 @@ void main() { // ]); // addTearDown(container.dispose); // final container2 = ProviderContainer(overrides: [ - // provider.overrideWithProvider( - // StateProvider((ref) => 42), + // provider.overrideWith( + // ((ref) => 42), // ), // ]); // addTearDown(container.dispose); diff --git a/packages/riverpod/test/providers/stream_provider/auto_dispose_family_stream_provider_test.dart b/packages/riverpod/test/providers/stream_provider/auto_dispose_family_stream_provider_test.dart index e0b124920..5435429db 100644 --- a/packages/riverpod/test/providers/stream_provider/auto_dispose_family_stream_provider_test.dart +++ b/packages/riverpod/test/providers/stream_provider/auto_dispose_family_stream_provider_test.dart @@ -53,15 +53,13 @@ void main() { ); }); - test('overrideWithProvider', () async { + test('overrideWith', () async { final provider = StreamProvider.autoDispose.family((ref, a) { return Stream.value(a * 2); }); final container = ProviderContainer( overrides: [ - provider.overrideWithProvider((a) { - return StreamProvider.autoDispose((ref) => Stream.value(a * 4)); - }), + provider.overrideWith((ref, a) => Stream.value(a * 4)), ], ); final listener = Listener>(); diff --git a/packages/riverpod/test/providers/stream_provider/auto_dispose_stream_provider_test.dart b/packages/riverpod/test/providers/stream_provider/auto_dispose_stream_provider_test.dart index 6a9b27a19..aba9117a8 100644 --- a/packages/riverpod/test/providers/stream_provider/auto_dispose_stream_provider_test.dart +++ b/packages/riverpod/test/providers/stream_provider/auto_dispose_stream_provider_test.dart @@ -222,16 +222,13 @@ void main() { // ); // }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final provider = StreamProvider.autoDispose((ref) => Stream.value(0)); final root = createContainer(); final container = createContainer( parent: root, overrides: [ - // ignore: deprecated_member_use_from_same_package - provider.overrideWithProvider( - StreamProvider.autoDispose((ref) => Stream.value(42)), - ), + provider.overrideWith((ref) => Stream.value(42)), ], ); diff --git a/packages/riverpod/test/providers/stream_provider/stream_provider_family_test.dart b/packages/riverpod/test/providers/stream_provider/stream_provider_family_test.dart index 5d2fe72d7..18542148e 100644 --- a/packages/riverpod/test/providers/stream_provider/stream_provider_family_test.dart +++ b/packages/riverpod/test/providers/stream_provider/stream_provider_family_test.dart @@ -32,16 +32,14 @@ void main() { ); }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final provider = StreamProvider.family((ref, _) => Stream.value(0)); final root = createContainer(); final container = createContainer( parent: root, overrides: [ - provider.overrideWithProvider( - (value) => StreamProvider((ref) => Stream.value(42)), - ), + provider.overrideWith((ref, value) => Stream.value(42)), ], ); @@ -82,9 +80,7 @@ void main() { }); final container = ProviderContainer( overrides: [ - provider.overrideWithProvider( - (a) => StreamProvider((ref) => Stream.value('override $a')), - ), + provider.overrideWith((ref, a) => Stream.value('override $a')), ], ); diff --git a/packages/riverpod/test/providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/providers/stream_provider/stream_provider_test.dart index e396d5f6e..68f30bddd 100644 --- a/packages/riverpod/test/providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/providers/stream_provider/stream_provider_test.dart @@ -339,7 +339,7 @@ void main() { // ); // }); - test('when using provider.overrideWithProvider', () async { + test('when using provider.overrideWith', () async { final provider = StreamProvider((ref) => Stream.value(0)); final root = createContainer(); final container = createContainer( From 82caac2cf870ae9a4ef48aa8b25794660d1ec08e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 15:31:30 +0200 Subject: [PATCH 011/387] Remove some deprecated_member_use_from_same_package ignores --- packages/riverpod/lib/src/framework/auto_dispose.dart | 1 - packages/riverpod/lib/src/framework/scheduler.dart | 1 - packages/riverpod/test/framework/auto_dispose_test.dart | 2 -- 3 files changed, 4 deletions(-) diff --git a/packages/riverpod/lib/src/framework/auto_dispose.dart b/packages/riverpod/lib/src/framework/auto_dispose.dart index bb9fe4a6e..4d97c4415 100644 --- a/packages/riverpod/lib/src/framework/auto_dispose.dart +++ b/packages/riverpod/lib/src/framework/auto_dispose.dart @@ -25,7 +25,6 @@ mixin AutoDisposeProviderElementMixin on ProviderElementBase void mayNeedDispose() { final links = _keepAliveLinks; - // ignore: deprecated_member_use_from_same_package if (!hasListeners && (links == null || links.isEmpty)) { _container._scheduler.scheduleProviderDispose(this); } diff --git a/packages/riverpod/lib/src/framework/scheduler.dart b/packages/riverpod/lib/src/framework/scheduler.dart index 765d33e07..e4ce4dc36 100644 --- a/packages/riverpod/lib/src/framework/scheduler.dart +++ b/packages/riverpod/lib/src/framework/scheduler.dart @@ -86,7 +86,6 @@ class _ProviderScheduler { final links = element._keepAliveLinks; - // ignore: deprecated_member_use_from_same_package if ((links != null && links.isNotEmpty) || element.hasListeners || element._container._disposed) { diff --git a/packages/riverpod/test/framework/auto_dispose_test.dart b/packages/riverpod/test/framework/auto_dispose_test.dart index 3a1f5a89f..2af10da5c 100644 --- a/packages/riverpod/test/framework/auto_dispose_test.dart +++ b/packages/riverpod/test/framework/auto_dispose_test.dart @@ -1,5 +1,3 @@ -// ignore_for_file: deprecated_member_use_from_same_package - import 'package:expect_error/expect_error.dart'; import 'package:mockito/mockito.dart'; import 'package:riverpod/src/internals.dart'; From f170b82218eb3d2a173bc061185b32bdbadb4579 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 15:32:11 +0200 Subject: [PATCH 012/387] Remove StateProvider.state --- packages/riverpod/lib/src/state_provider.dart | 12 ---------- .../lib/src/state_provider/auto_dispose.dart | 7 ------ .../riverpod/lib/src/state_provider/base.dart | 7 ------ .../state_provider/state_provider_test.dart | 23 ------------------- 4 files changed, 49 deletions(-) diff --git a/packages/riverpod/lib/src/state_provider.dart b/packages/riverpod/lib/src/state_provider.dart index bac6be04f..67be8f21c 100644 --- a/packages/riverpod/lib/src/state_provider.dart +++ b/packages/riverpod/lib/src/state_provider.dart @@ -17,17 +17,6 @@ ProviderElementProxy> _notifier( ); } -ProviderElementProxy> _state( - _StateProviderBase that, -) { - return ProviderElementProxy>( - that, - (element) { - return (element as StateProviderElement)._stateNotifier; - }, - ); -} - abstract class _StateProviderBase extends ProviderBase { const _StateProviderBase({ required super.name, @@ -39,7 +28,6 @@ abstract class _StateProviderBase extends ProviderBase { }); ProviderListenable> get notifier; - ProviderListenable> get state; T _create(covariant StateProviderElement ref); } diff --git a/packages/riverpod/lib/src/state_provider/auto_dispose.dart b/packages/riverpod/lib/src/state_provider/auto_dispose.dart index eea9e8190..f179324a5 100644 --- a/packages/riverpod/lib/src/state_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/state_provider/auto_dispose.dart @@ -48,13 +48,6 @@ class AutoDisposeStateProvider extends _StateProviderBase { @override late final Refreshable> notifier = _notifier(this); - @Deprecated( - 'Will be removed in 3.0.0. ' - 'Use either `ref.watch(provider)` or `ref.read(provider.notifier)` instead', - ) - @override - late final Refreshable> state = _state(this); - /// {@macro riverpod.overridewith} Override overrideWith( Create> create, diff --git a/packages/riverpod/lib/src/state_provider/base.dart b/packages/riverpod/lib/src/state_provider/base.dart index 02b29edb2..873662931 100644 --- a/packages/riverpod/lib/src/state_provider/base.dart +++ b/packages/riverpod/lib/src/state_provider/base.dart @@ -87,13 +87,6 @@ class StateProvider extends _StateProviderBase late final AlwaysAliveRefreshable> notifier = _notifier(this); - @Deprecated( - 'Will be removed in 3.0.0. ' - 'Use either `ref.watch(provider)` or `ref.read(provider.notifier)` instead', - ) - @override - late final AlwaysAliveRefreshable> state = _state(this); - /// {@macro riverpod.overridewith} Override overrideWith( Create> create, diff --git a/packages/riverpod/test/providers/state_provider/state_provider_test.dart b/packages/riverpod/test/providers/state_provider/state_provider_test.dart index 09b4813dc..e001cf700 100644 --- a/packages/riverpod/test/providers/state_provider/state_provider_test.dart +++ b/packages/riverpod/test/providers/state_provider/state_provider_test.dart @@ -90,29 +90,6 @@ void main() { ); }); - test('.state clears listener when autoDisposed', () async { - final observer = ObserverMock(); - final container = createContainer(observers: [observer]); - final provider = StateProvider.autoDispose((ref) => 0); - final listener = Listener>(); - - container.listen(provider.notifier, (previous, next) {}); - - // ignore: deprecated_member_use_from_same_package - container.read(provider.state); - await container.pump(); - - verifyZeroInteractions(listener); - - // ignore: deprecated_member_use_from_same_package - container.listen(provider.state, listener); - - container.read(provider.notifier).state++; - - verify(listener(any, any)).called(1); - verify(observer.didUpdateProvider(any, any, any, container)).called(1); - }); - test('can be auto-scoped', () async { final dep = Provider((ref) => 0); final provider = StateProvider( From ac308583555c511a0781b9b0ca606f9538123e0f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 15:40:29 +0200 Subject: [PATCH 013/387] Update workspace --- melos.yaml | 36 +----------------------------------- 1 file changed, 1 insertion(+), 35 deletions(-) diff --git a/melos.yaml b/melos.yaml index bc575300f..60507fd39 100644 --- a/melos.yaml +++ b/melos.yaml @@ -21,40 +21,6 @@ scripts: cd MELOS_ROOT_PATH/packages/riverpod_cli/fixtures/unified_syntax/golden && flutter pub get - analyze: - run: | - melos exec -c 1 -- \ - flutter analyze . - description: | - Run `dart analyze` in all packages. - - Note: you can also rely on your IDEs Dart Analysis / Issues window. - generate: - run: melos run generate:dart && melos run generate:flutter + run: melos exec --depends-on=build_runner -- dart pub run build_runner build -d description: Build all generated files for Dart & Flutter packages in this project. - - generate:dart: - run: melos exec -c 1 --depends-on="build_runner" --no-flutter --ignore="riverpod_lint_flutter_test" -- "dart run build_runner build --delete-conflicting-outputs" - description: Build all generated files for Dart packages in this project. - - generate:flutter: - run: melos exec -c 1 --depends-on="build_runner" --flutter -- "flutter pub run build_runner build --delete-conflicting-outputs" - description: Build all generated files for Flutter packages in this project. - - test: - run: melos run test:dart --no-select && melos run test:flutter --no-select - description: Run all Dart & Flutter tests in this project. - - test:dart: - run: melos exec -c 1 --fail-fast -- "\$MELOS_ROOT_PATH/scripts/coverage.sh" - description: Run Dart tests for a specific package in this project. - select-package: - flutter: false - dir-exists: test - - test:flutter: - run: melos exec --dir-exists="test" -c 1 --fail-fast -- "flutter test --coverage" - description: Run Flutter tests for a specific package in this project. - select-package: - flutter: true - dir-exists: test \ No newline at end of file From d0e0ad6674abbd5ef41a2856bc721fe96039cae9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 15:41:56 +0200 Subject: [PATCH 014/387] riverpod_generator no-longer specifies Family generic arg --- examples/pub/lib/detail.g.dart | 4 +- examples/pub/lib/search.g.dart | 2 +- .../riverpod/lib/src/framework/container.dart | 4 +- .../riverpod/lib/src/framework/family.dart | 39 ++++++++----------- .../lib/src/framework/foundation.dart | 2 +- .../lib/src/framework/provider_base.dart | 2 +- packages/riverpod_generator/CHANGELOG.md | 4 ++ .../integration/build_yaml/lib/main.g.dart | 12 +++--- .../lib/src/templates/family.dart | 2 +- .../test/integration/async.g.dart | 4 +- .../test/integration/dependencies.g.dart | 6 +-- .../test/integration/stream.g.dart | 4 +- .../test/integration/sync.g.dart | 12 +++--- .../generated/golden/lib/sync.g.dart | 4 +- ...vert_stateful_provider_to_stateless.g.dart | 2 +- ...vert_stateless_provider_to_stateful.g.dart | 2 +- .../goldens/lints/provider_parameters.g.dart | 2 +- 17 files changed, 52 insertions(+), 55 deletions(-) diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 818e0303d..506af6484 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -39,7 +39,7 @@ typedef FetchPackageDetailsRef = AutoDisposeFutureProviderRef; const fetchPackageDetailsProvider = FetchPackageDetailsFamily(); /// See also [fetchPackageDetails]. -class FetchPackageDetailsFamily extends Family> { +class FetchPackageDetailsFamily extends Family { /// See also [fetchPackageDetails]. const FetchPackageDetailsFamily(); @@ -172,7 +172,7 @@ const packageMetricsProvider = PackageMetricsFamily(); /// is logged-in. /// /// Copied from [PackageMetrics]. -class PackageMetricsFamily extends Family> { +class PackageMetricsFamily extends Family { /// A provider that fetches the likes count, popularity score and pub points /// for a given package. /// diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 36e09a241..657552f83 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -38,7 +38,7 @@ typedef FetchPackagesRef = AutoDisposeFutureProviderRef>; const fetchPackagesProvider = FetchPackagesFamily(); /// See also [fetchPackages]. -class FetchPackagesFamily extends Family>> { +class FetchPackagesFamily extends Family { /// See also [fetchPackages]. const FetchPackagesFamily(); diff --git a/packages/riverpod/lib/src/framework/container.dart b/packages/riverpod/lib/src/framework/container.dart index 5f2035ece..497846b13 100644 --- a/packages/riverpod/lib/src/framework/container.dart +++ b/packages/riverpod/lib/src/framework/container.dart @@ -5,7 +5,7 @@ ProviderBase? _circularDependencyLock; class _FamilyOverrideRef { _FamilyOverrideRef(this.override, this.container); - FamilyOverride override; + FamilyOverride override; final ProviderContainer container; } @@ -161,7 +161,7 @@ class ProviderContainer implements Node { final _overrideForProvider = HashMap, ProviderBase>(); - final _overrideForFamily = HashMap, _FamilyOverrideRef>(); + final _overrideForFamily = HashMap(); final Map, _StateReader> _stateReaders; final List _observers; diff --git a/packages/riverpod/lib/src/framework/family.dart b/packages/riverpod/lib/src/framework/family.dart index bfd019983..b8e60bcd6 100644 --- a/packages/riverpod/lib/src/framework/family.dart +++ b/packages/riverpod/lib/src/framework/family.dart @@ -9,7 +9,7 @@ typedef ProviderCreate = ProviderT required Iterable? dependencies, required Set? allTransitiveDependencies, required DebugGetCreateSourceHash? debugGetCreateSourceHash, - Family from, + Family from, Object? argument, }); @@ -22,7 +22,7 @@ typedef ProviderNotifierCreate = ProviderT required Iterable? dependencies, required Set? allTransitiveDependencies, required DebugGetCreateSourceHash? debugGetCreateSourceHash, - Family from, + Family from, Object? argument, }); @@ -31,26 +31,19 @@ typedef ProviderNotifierCreate = ProviderT typedef FamilyCreate = T Function(R ref, Arg arg); /// A base class for all families -abstract class Family< - @Deprecated( - 'The generic parameter will be removed in version 3.0.0. ' - 'This is to enable riverpod_generator to implement families with generic parameters', - ) - // ignore: deprecated_member_use_from_same_package - State> implements FamilyOverride, ProviderOrFamily { +abstract class Family implements FamilyOverride, ProviderOrFamily { /// A base class for all families const Family(); @override - Family? get from => null; + Family? get from => null; @override - // ignore: deprecated_member_use_from_same_package - Family get overriddenFamily => this; + Family get overriddenFamily => this; } mixin _FamilyMixin> - on Family { + on Family { /// Create a provider from an external value. /// /// That external value should be immutable and preferably override `==`/`hashCode`. @@ -59,7 +52,7 @@ mixin _FamilyMixin> @visibleForOverriding @override - ProviderBase getProviderOverride(ProviderBase provider) { + ProviderBase getProviderOverride(ProviderBase provider) { return call(provider.argument as Arg); } } @@ -77,19 +70,19 @@ typedef SetupFamilyOverride = void Function( /// Do not use: Internal object to used by [ProviderContainer]/`ProviderScope` /// to override the behavior of a "family" for part of the application. @internal -abstract class FamilyOverride implements Override { +abstract class FamilyOverride implements Override { /// The family that was overridden. - Family get overriddenFamily; + Family get overriddenFamily; /// Obtains the new behavior for a provider associated to the overridden family. @visibleForOverriding - ProviderBase getProviderOverride(ProviderBase provider); + ProviderBase getProviderOverride(ProviderBase provider); } /// An [Override] for families @internal class FamilyOverrideImpl> - implements FamilyOverride { + implements FamilyOverride { /// An [Override] for families // ignore: library_private_types_in_public_api FamilyOverrideImpl(this.overriddenFamily, this._newCreate); @@ -102,7 +95,7 @@ class FamilyOverrideImpl> @visibleForOverriding @override - ProviderBase getProviderOverride(ProviderBase provider) { + ProviderBase getProviderOverride(ProviderBase provider) { final arg = provider.argument as Arg; return _newCreate(arg); } @@ -114,7 +107,7 @@ class FamilyOverrideImpl> /// This API is not meant for public consumption. @internal class FamilyBase, R, Arg, Created, - ProviderT extends ProviderBase> extends Family + ProviderT extends ProviderBase> extends Family with _FamilyMixin { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. @@ -163,7 +156,7 @@ class FamilyBase, R, Arg, Created, @internal class AutoDisposeFamilyBase, R, Arg, Created, - ProviderT extends ProviderBase> extends Family + ProviderT extends ProviderBase> extends Family with _FamilyMixin { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. @@ -212,7 +205,7 @@ class AutoDisposeFamilyBase, R, Arg, Created, /// This API is not meant for public consumption. @internal class AutoDisposeNotifierFamilyBase, R, Arg, NotifierT, - ProviderT extends ProviderBase> extends Family + ProviderT extends ProviderBase> extends Family with _FamilyMixin { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. @@ -261,7 +254,7 @@ class AutoDisposeNotifierFamilyBase, R, Arg, NotifierT, /// This API is not meant for public consumption. @internal class NotifierFamilyBase, R, Arg, NotifierT, - ProviderT extends ProviderBase> extends Family + ProviderT extends ProviderBase> extends Family with _FamilyMixin { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. diff --git a/packages/riverpod/lib/src/framework/foundation.dart b/packages/riverpod/lib/src/framework/foundation.dart index fd1cb7030..c24fd4d93 100644 --- a/packages/riverpod/lib/src/framework/foundation.dart +++ b/packages/riverpod/lib/src/framework/foundation.dart @@ -11,7 +11,7 @@ abstract class ProviderOrFamily { }); /// The family that this provider/family depends on. - Family? get from; + Family? get from; /// {@template riverpod.name} /// A custom label for providers. diff --git a/packages/riverpod/lib/src/framework/provider_base.dart b/packages/riverpod/lib/src/framework/provider_base.dart index d4cb03fab..518736305 100644 --- a/packages/riverpod/lib/src/framework/provider_base.dart +++ b/packages/riverpod/lib/src/framework/provider_base.dart @@ -58,7 +58,7 @@ abstract class ProviderBase extends ProviderOrFamily /// If this provider was created with the `.family` modifier, [from] is the `.family` instance. @override - final Family? from; + final Family? from; /// If this provider was created with the `.family` modifier, [argument] is /// the variable that was used. diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index e25125dfa..170554484 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -1,3 +1,7 @@ +## Unreleased major + +- Upgraded to use Riverpod 3.0 + ## 2.2.1 - 2023-04-24 - `riverpod_annotation` upgraded to `2.1.1` diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index e98aeb734..cc88e398f 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -78,7 +78,7 @@ typedef Count2Ref = AutoDisposeProviderRef; const count2ProviderFamily = Count2Family(); /// See also [count2]. -class Count2Family extends Family { +class Count2Family extends Family { /// See also [count2]. const Count2Family(); @@ -159,7 +159,7 @@ typedef CountFuture2Ref = AutoDisposeFutureProviderRef; const countFuture2ProviderFamily = CountFuture2Family(); /// See also [countFuture2]. -class CountFuture2Family extends Family> { +class CountFuture2Family extends Family { /// See also [countFuture2]. const CountFuture2Family(); @@ -241,7 +241,7 @@ typedef CountStream2Ref = AutoDisposeStreamProviderRef; const countStream2ProviderFamily = CountStream2Family(); /// See also [countStream2]. -class CountStream2Family extends Family> { +class CountStream2Family extends Family { /// See also [countStream2]. const CountStream2Family(); @@ -380,7 +380,7 @@ abstract class _$CountNotifier2 extends BuildlessAutoDisposeNotifier { const countNotifier2ProviderFamily = CountNotifier2Family(); /// See also [CountNotifier2]. -class CountNotifier2Family extends Family { +class CountNotifier2Family extends Family { /// See also [CountNotifier2]. const CountNotifier2Family(); @@ -478,7 +478,7 @@ abstract class _$CountAsyncNotifier2 const countAsyncNotifier2ProviderFamily = CountAsyncNotifier2Family(); /// See also [CountAsyncNotifier2]. -class CountAsyncNotifier2Family extends Family> { +class CountAsyncNotifier2Family extends Family { /// See also [CountAsyncNotifier2]. const CountAsyncNotifier2Family(); @@ -576,7 +576,7 @@ abstract class _$CountStreamNotifier2 const countStreamNotifier2ProviderFamily = CountStreamNotifier2Family(); /// See also [CountStreamNotifier2]. -class CountStreamNotifier2Family extends Family> { +class CountStreamNotifier2Family extends Family { /// See also [CountStreamNotifier2]. const CountStreamNotifier2Family(); diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 19241398c..df4234395 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -191,7 +191,7 @@ $docs const $providerName = $familyName(); $docs -class $familyName extends Family<${provider.exposedType}> { +class $familyName extends Family { $docs const $familyName(); diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index fafc627e3..807925b5f 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -64,7 +64,7 @@ typedef FamilyRef = AutoDisposeFutureProviderRef; const familyProvider = FamilyFamily(); /// See also [family]. -class FamilyFamily extends Family> { +class FamilyFamily extends Family { /// See also [family]. const FamilyFamily(); @@ -223,7 +223,7 @@ abstract class _$FamilyClass extends BuildlessAutoDisposeAsyncNotifier { const familyClassProvider = FamilyClassFamily(); /// See also [FamilyClass]. -class FamilyClassFamily extends Family> { +class FamilyClassFamily extends Family { /// See also [FamilyClass]. const FamilyClassFamily(); diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 80032655d..38cbed6e4 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -50,7 +50,7 @@ typedef FamilyRef = AutoDisposeProviderRef; const familyProvider = FamilyFamily(); /// See also [family]. -class FamilyFamily extends Family { +class FamilyFamily extends Family { /// See also [family]. const FamilyFamily(); @@ -259,7 +259,7 @@ abstract class _$Family2 extends BuildlessAutoDisposeNotifier { const family2Provider = Family2Family(); /// See also [Family2]. -class Family2Family extends Family { +class Family2Family extends Family { /// See also [Family2]. const Family2Family(); @@ -377,7 +377,7 @@ abstract class _$Provider4 extends BuildlessAutoDisposeNotifier { const provider4Provider = Provider4Family(); /// See also [Provider4]. -class Provider4Family extends Family { +class Provider4Family extends Family { /// See also [Provider4]. const Provider4Family(); diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 69949f5d1..823dbe0dd 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -64,7 +64,7 @@ typedef FamilyRef = AutoDisposeStreamProviderRef; const familyProvider = FamilyFamily(); /// See also [family]. -class FamilyFamily extends Family> { +class FamilyFamily extends Family { /// See also [family]. const FamilyFamily(); @@ -224,7 +224,7 @@ abstract class _$FamilyClass const familyClassProvider = FamilyClassFamily(); /// See also [FamilyClass]. -class FamilyClassFamily extends Family> { +class FamilyClassFamily extends Family { /// See also [FamilyClass]. const FamilyClassFamily(); diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index d572aa021..27fa6b1e5 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -64,7 +64,7 @@ typedef RawFamilyFutureRef = AutoDisposeProviderRef>; const rawFamilyFutureProvider = RawFamilyFutureFamily(); /// See also [rawFamilyFuture]. -class RawFamilyFutureFamily extends Family> { +class RawFamilyFutureFamily extends Family { /// See also [rawFamilyFuture]. const RawFamilyFutureFamily(); @@ -146,7 +146,7 @@ typedef RawFamilyStreamRef = AutoDisposeProviderRef>; const rawFamilyStreamProvider = RawFamilyStreamFamily(); /// See also [rawFamilyStream]. -class RawFamilyStreamFamily extends Family> { +class RawFamilyStreamFamily extends Family { /// See also [rawFamilyStream]. const RawFamilyStreamFamily(); @@ -263,7 +263,7 @@ const familyProvider = FamilyFamily(); /// This is some documentation /// /// Copied from [family]. -class FamilyFamily extends Family { +class FamilyFamily extends Family { /// This is some documentation /// /// Copied from [family]. @@ -454,7 +454,7 @@ abstract class _$RawFamilyFutureClass const rawFamilyFutureClassProvider = RawFamilyFutureClassFamily(); /// See also [RawFamilyFutureClass]. -class RawFamilyFutureClassFamily extends Family> { +class RawFamilyFutureClassFamily extends Family { /// See also [RawFamilyFutureClass]. const RawFamilyFutureClassFamily(); @@ -552,7 +552,7 @@ abstract class _$RawFamilyStreamClass const rawFamilyStreamClassProvider = RawFamilyStreamClassFamily(); /// See also [RawFamilyStreamClass]. -class RawFamilyStreamClassFamily extends Family> { +class RawFamilyStreamClassFamily extends Family { /// See also [RawFamilyStreamClass]. const RawFamilyStreamClassFamily(); @@ -692,7 +692,7 @@ const familyClassProvider = FamilyClassFamily(); /// This is some documentation /// /// Copied from [FamilyClass]. -class FamilyClassFamily extends Family { +class FamilyClassFamily extends Family { /// This is some documentation /// /// Copied from [FamilyClass]. diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 8a1dc9712..253bc14ec 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -73,7 +73,7 @@ const familyProvider = FamilyFamily(); /// A generated family provider. /// /// Copied from [family]. -class FamilyFamily extends Family { +class FamilyFamily extends Family { /// A generated family provider. /// /// Copied from [family]. @@ -260,7 +260,7 @@ const familyClassProvider = FamilyClassFamily(); /// A generated family provider from a class. /// /// Copied from [FamilyClass]. -class FamilyClassFamily extends Family { +class FamilyClassFamily extends Family { /// A generated family provider from a class. /// /// Copied from [FamilyClass]. diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.g.dart index 3f81bd986..c5c945bdb 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.g.dart @@ -64,7 +64,7 @@ const statefulFamilyProvider = StatefulFamilyFamily(); /// Some comment /// /// Copied from [StatefulFamily]. -class StatefulFamilyFamily extends Family { +class StatefulFamilyFamily extends Family { /// Some comment /// /// Copied from [StatefulFamily]. diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.g.dart index ad7797637..168a9f1b9 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.g.dart @@ -56,7 +56,7 @@ const statelessFamilyProvider = StatelessFamilyFamily(); /// Some comment /// /// Copied from [statelessFamily]. -class StatelessFamilyFamily extends Family { +class StatelessFamilyFamily extends Family { /// Some comment /// /// Copied from [statelessFamily]. diff --git a/packages/riverpod_lint_flutter_test/test/goldens/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/goldens/lints/provider_parameters.g.dart index 84866797c..16a68dda1 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/goldens/lints/provider_parameters.g.dart @@ -36,7 +36,7 @@ typedef GeneratorRef = ProviderRef; const generatorProvider = GeneratorFamily(); /// See also [generator]. -class GeneratorFamily extends Family { +class GeneratorFamily extends Family { /// See also [generator]. const GeneratorFamily(); From 97abba1925587485dc6fb6e4e3dd855a2c44435b Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 16:45:06 +0200 Subject: [PATCH 015/387] Added `GeneratorProviderDeclarationElement.isFamily` --- packages/riverpod_analyzer_utils/CHANGELOG.md | 4 ++ .../lib/src/riverpod_element.dart | 21 +++++- .../generator_provider_declaration_test.dart | 69 +++++++++++++++++-- 3 files changed, 85 insertions(+), 9 deletions(-) diff --git a/packages/riverpod_analyzer_utils/CHANGELOG.md b/packages/riverpod_analyzer_utils/CHANGELOG.md index cd1013b85..970706259 100644 --- a/packages/riverpod_analyzer_utils/CHANGELOG.md +++ b/packages/riverpod_analyzer_utils/CHANGELOG.md @@ -1,3 +1,7 @@ +## Unreleased minor + +- Added `GeneratorProviderDeclarationElement.isFamily` + ## 0.3.0 - 2023-04-18 - Added `DartType.isRaw` extension property for checking if a type is from a `Raw` typedef. diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart index fcaddbb8f..9bd0c130b 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart @@ -265,6 +265,10 @@ abstract class GeneratorProviderDeclarationElement implements ProviderDeclarationElement { RiverpodAnnotationElement get annotation; + /// Whether a provider has any form of parameter, be it function parameters + /// or type parameters. + bool get isFamily; + bool get isScoped => annotation.dependencies != null; @override @@ -316,6 +320,12 @@ class StatefulProviderDeclarationElement static final _cache = Expando<_Box>(); + @override + bool get isFamily { + return buildMethod.parameters.isNotEmpty || + element.typeParameters.isNotEmpty; + } + @override final ClassElement element; @@ -355,6 +365,14 @@ class StatelessProviderDeclarationElement static final _cache = Expando<_Box>(); + @override + bool get isScoped => super.isScoped || element.isExternal; + + @override + bool get isFamily { + return element.parameters.length > 1 || element.typeParameters.isNotEmpty; + } + @override final ExecutableElement element; @@ -363,9 +381,6 @@ class StatelessProviderDeclarationElement @override final RiverpodAnnotationElement annotation; - - @override - bool get isScoped => super.isScoped || element.isExternal; } /// An object for differentiating "no cache" from "cache but value is null". diff --git a/packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart b/packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart index d94c43226..e7e09d878 100644 --- a/packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart @@ -4,6 +4,67 @@ import 'package:test/test.dart'; import 'analyser_test_utils.dart'; void main() { + testSource('Parses element.isFamily', source: r''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@riverpod +T generic(GenericRef ref) => throw UnimplementedError(); + +@riverpod +class GenericClass extends _$GenericClass { + @override + T build() => throw UnimplementedError(); +} + +@riverpod +int value(ValueRef ref) => throw UnimplementedError(); + +@riverpod +class ValueClass extends _$ValueClass { + @override + int build() => throw UnimplementedError(); +} + +@riverpod +int parametrized(ParametrizedRef ref, int id) => throw UnimplementedError(); + +@riverpod +class ParametrizedClass extends _$ParametrizedClass { + @override + int build(int id) => throw UnimplementedError(); +} +''', (resolver) async { + final result = await resolver.resolveRiverpodAnalyssiResult(); + + final generic = result.generatorProviderDeclarations.singleWhere( + (e) => e.name.toString() == 'generic', + ); + final genericClass = result.generatorProviderDeclarations.singleWhere( + (e) => e.name.toString() == 'GenericClass', + ); + final value = result.generatorProviderDeclarations.singleWhere( + (e) => e.name.toString() == 'value', + ); + final valueClass = result.generatorProviderDeclarations.singleWhere( + (e) => e.name.toString() == 'ValueClass', + ); + final parametrized = result.generatorProviderDeclarations.singleWhere( + (e) => e.name.toString() == 'parametrized', + ); + final parametrizedClass = result.generatorProviderDeclarations.singleWhere( + (e) => e.name.toString() == 'ParametrizedClass', + ); + + expect(generic.providerElement.isFamily, true); + expect(genericClass.providerElement.isFamily, true); + + expect(value.providerElement.isFamily, false); + expect(valueClass.providerElement.isFamily, false); + + expect(parametrized.providerElement.isFamily, true); + expect(parametrizedClass.providerElement.isFamily, true); + }); + testSource('Parses Raw types', source: ''' import 'package:riverpod_annotation/riverpod_annotation.dart'; @@ -16,9 +77,7 @@ Future value2(Value2Ref ref) async => 0; @riverpod Future> value3(Value3Ref ref) async => 0; ''', (resolver) async { - final result = await resolver.resolveRiverpodAnalyssiResult( - ignoreErrors: true, - ); + final result = await resolver.resolveRiverpodAnalyssiResult(); final value = result.statelessProviderDeclarations.singleWhere( (e) => e.name.toString() == 'value', @@ -60,9 +119,7 @@ int scoped() => 0; @riverpod int plain(PlainRef ref) => 0; ''', (resolver) async { - final result = await resolver.resolveRiverpodAnalyssiResult( - ignoreErrors: true, - ); + final result = await resolver.resolveRiverpodAnalyssiResult(); final needsOverride = result.statelessProviderDeclarations.singleWhere( (e) => e.name.toString() == 'needsOverride', From daa6d0eeb7979843796c3110f5e4b453ad478e18 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 16:53:16 +0200 Subject: [PATCH 016/387] Update codegen to use .isFamily --- .../lib/src/riverpod_generator.dart | 10 +- .../lib/src/templates/family.dart | 8 +- .../lib/src/templates/stateful_provider.dart | 8 +- .../lib/src/templates/stateless_provider.dart | 8 +- .../test/integration/async.dart | 13 ++ .../test/integration/async.g.dart | 195 ++++++++++++++++-- .../test/integration/stream.dart | 13 ++ .../test/integration/stream.g.dart | 195 ++++++++++++++++-- .../test/integration/sync.dart | 13 ++ .../test/integration/sync.g.dart | 194 +++++++++++++++-- 10 files changed, 571 insertions(+), 86 deletions(-) diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index 9f549ef55..537856133 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -131,14 +131,11 @@ class _SystemHash { ) { super.visitStatefulProviderDeclaration(provider); - final parameters = provider.buildMethod.parameters?.parameters; - if (parameters == null) return; - final hashFunctionName = _hashFnName(provider); final hashFn = _hashFnIdentifier(hashFunctionName); buffer.write(_hashFn(provider, hashFunctionName)); - if (parameters.isEmpty) { + if (!provider.providerElement.isFamily) { final providerName = '${provider.providerElement.name.lowerFirst}$suffix'; final notifierTypedefName = providerName.startsWith('_') ? '_\$${provider.providerElement.name.substring(1)}' @@ -173,9 +170,6 @@ class _SystemHash { ) { super.visitStatelessProviderDeclaration(provider); - final parameters = provider.node.functionExpression.parameters?.parameters; - if (parameters == null) return; - final hashFunctionName = _hashFnName(provider); final hashFn = _hashFnIdentifier(hashFunctionName); buffer.write(_hashFn(provider, hashFunctionName)); @@ -184,7 +178,7 @@ class _SystemHash { // Using >1 as functional providers always have at least one parameter: ref // So a provider is a "family" only if it has parameters besides the ref. - if (parameters.length > 1) { + if (provider.providerElement.isFamily) { maybeEmitHashUtils(); FamilyTemplate.stateless( provider, diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index df4234395..97b98c36a 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -28,11 +28,11 @@ class FamilyTemplate extends Template { this.other = '', this.providerOther = '', }) { - if (parameters.isEmpty) { + if (!provider.providerElement.isFamily) { throw ArgumentError.value( - parameters, - 'provider', - 'Expected a provider with parameters', + provider.providerElement.isFamily, + 'provider.providerElement.isFamily', + 'Expected a family provider', ); } } diff --git a/packages/riverpod_generator/lib/src/templates/stateful_provider.dart b/packages/riverpod_generator/lib/src/templates/stateful_provider.dart index 079cd21ab..f8dbb45bf 100644 --- a/packages/riverpod_generator/lib/src/templates/stateful_provider.dart +++ b/packages/riverpod_generator/lib/src/templates/stateful_provider.dart @@ -46,11 +46,11 @@ class StatefulProviderTemplate extends Template { required this.hashFn, required this.options, }) { - if (provider.buildMethod.parameters!.parameters.isNotEmpty) { + if (provider.providerElement.isFamily) { throw ArgumentError.value( - provider.buildMethod.parameters?.toSource(), - 'provider', - 'Expected a stateful provider with no parameter', + provider.providerElement.isFamily, + 'provider.providerElement.isFamily', + 'Expected a non-family provider', ); } } diff --git a/packages/riverpod_generator/lib/src/templates/stateless_provider.dart b/packages/riverpod_generator/lib/src/templates/stateless_provider.dart index 02009ab5c..efc0ee589 100644 --- a/packages/riverpod_generator/lib/src/templates/stateless_provider.dart +++ b/packages/riverpod_generator/lib/src/templates/stateless_provider.dart @@ -11,11 +11,11 @@ class StatelessProviderTemplate extends Template { required this.hashFn, required this.options, }) { - if (provider.node.functionExpression.parameters!.parameters.length > 1) { + if (provider.providerElement.isFamily) { throw ArgumentError.value( - provider.node.functionExpression.parameters?.toSource(), - 'provider', - 'Expected a stateless provider with no parameter', + provider.providerElement.isFamily, + 'provider.providerElement.isFamily', + 'Expected a non-family provider', ); } } diff --git a/packages/riverpod_generator/test/integration/async.dart b/packages/riverpod_generator/test/integration/async.dart index 4ee104e96..7206ee4a5 100644 --- a/packages/riverpod_generator/test/integration/async.dart +++ b/packages/riverpod_generator/test/integration/async.dart @@ -2,6 +2,19 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'async.g.dart'; +@riverpod +Future> generic(GenericRef ref) async { + return []; +} + +@riverpod +class GenericClass extends _$GenericClass { + @override + Future> build() async { + return []; + } +} + @riverpod FutureOr public(PublicRef ref) { return 'Hello world'; diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 807925b5f..1ba5a2d9c 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -6,6 +6,98 @@ part of 'async.dart'; // RiverpodGenerator // ************************************************************************** +String _$genericHash() => r'6ee5473ece745b00328c1e048f6967c160343620'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +typedef GenericRef = AutoDisposeFutureProviderRef>; + +/// See also [generic]. +@ProviderFor(generic) +const genericProvider = GenericFamily(); + +/// See also [generic]. +class GenericFamily extends Family { + /// See also [generic]. + const GenericFamily(); + + /// See also [generic]. + GenericProvider call() { + return GenericProvider(); + } + + @override + GenericProvider getProviderOverride( + covariant GenericProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericProvider'; +} + +/// See also [generic]. +class GenericProvider extends AutoDisposeFutureProvider> { + /// See also [generic]. + GenericProvider() + : super.internal( + (ref) => generic( + ref, + ), + from: genericProvider, + name: r'genericProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericHash, + dependencies: GenericFamily._dependencies, + allTransitiveDependencies: GenericFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is GenericProvider; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + + return _SystemHash.finish(hash); + } +} + String _$publicHash() => r'9d99b79c013da13926d4ad89c72ebca4fc1cc257'; /// See also [public]. @@ -35,28 +127,6 @@ final _privateProvider = AutoDisposeFutureProvider.internal( typedef _PrivateRef = AutoDisposeFutureProviderRef; String _$familyHash() => r'f46defb7b007c76254058e9e8bc868260bcfe0f1'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - typedef FamilyRef = AutoDisposeFutureProviderRef; /// See also [family]. @@ -170,6 +240,87 @@ class FamilyProvider extends AutoDisposeFutureProvider { } } +String _$genericClassHash() => r'0c53e36d8c4776a3835fb87502355340a8dd2cc6'; + +abstract class _$GenericClass + extends BuildlessAutoDisposeAsyncNotifier> { + Future> build(); +} + +/// See also [GenericClass]. +@ProviderFor(GenericClass) +const genericClassProvider = GenericClassFamily(); + +/// See also [GenericClass]. +class GenericClassFamily extends Family { + /// See also [GenericClass]. + const GenericClassFamily(); + + /// See also [GenericClass]. + GenericClassProvider call() { + return GenericClassProvider(); + } + + @override + GenericClassProvider getProviderOverride( + covariant GenericClassProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericClassProvider'; +} + +/// See also [GenericClass]. +class GenericClassProvider + extends AutoDisposeAsyncNotifierProviderImpl> { + /// See also [GenericClass]. + GenericClassProvider() + : super.internal( + () => GenericClass(), + from: genericClassProvider, + name: r'genericClassProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericClassHash, + dependencies: GenericClassFamily._dependencies, + allTransitiveDependencies: + GenericClassFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is GenericClassProvider; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + + return _SystemHash.finish(hash); + } + + @override + Future> runNotifierBuild( + covariant GenericClass notifier, + ) { + return notifier.build(); + } +} + String _$publicClassHash() => r'98f7b5a2478814264c0a70d066ecabfddc58c577'; /// See also [PublicClass]. diff --git a/packages/riverpod_generator/test/integration/stream.dart b/packages/riverpod_generator/test/integration/stream.dart index 99071d3bf..cf90f00bd 100644 --- a/packages/riverpod_generator/test/integration/stream.dart +++ b/packages/riverpod_generator/test/integration/stream.dart @@ -2,6 +2,19 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'stream.g.dart'; +@riverpod +Stream> generic(GenericRef ref) async* { + yield []; +} + +@riverpod +class GenericClass extends _$GenericClass { + @override + Stream> build() async* { + yield []; + } +} + @riverpod Stream public(PublicRef ref) { return Stream.value('Hello world'); diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 823dbe0dd..26f905230 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -6,6 +6,98 @@ part of 'stream.dart'; // RiverpodGenerator // ************************************************************************** +String _$genericHash() => r'c1122edf55163d47de8d871ed5d15e0a7edddc05'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +typedef GenericRef = AutoDisposeStreamProviderRef>; + +/// See also [generic]. +@ProviderFor(generic) +const genericProvider = GenericFamily(); + +/// See also [generic]. +class GenericFamily extends Family { + /// See also [generic]. + const GenericFamily(); + + /// See also [generic]. + GenericProvider call() { + return GenericProvider(); + } + + @override + GenericProvider getProviderOverride( + covariant GenericProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericProvider'; +} + +/// See also [generic]. +class GenericProvider extends AutoDisposeStreamProvider> { + /// See also [generic]. + GenericProvider() + : super.internal( + (ref) => generic( + ref, + ), + from: genericProvider, + name: r'genericProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericHash, + dependencies: GenericFamily._dependencies, + allTransitiveDependencies: GenericFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is GenericProvider; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + + return _SystemHash.finish(hash); + } +} + String _$publicHash() => r'c5cc0eac434371901cf6ab159a81bba49c58da12'; /// See also [public]. @@ -35,28 +127,6 @@ final _privateProvider = AutoDisposeStreamProvider.internal( typedef _PrivateRef = AutoDisposeStreamProviderRef; String _$familyHash() => r'6896fac2f6e3ccd7c38ecaa0d538cbd3577936b2'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - typedef FamilyRef = AutoDisposeStreamProviderRef; /// See also [family]. @@ -170,6 +240,87 @@ class FamilyProvider extends AutoDisposeStreamProvider { } } +String _$genericClassHash() => r'3769bc659154cb464c07beb57d6f8409c849fb97'; + +abstract class _$GenericClass + extends BuildlessAutoDisposeStreamNotifier> { + Stream> build(); +} + +/// See also [GenericClass]. +@ProviderFor(GenericClass) +const genericClassProvider = GenericClassFamily(); + +/// See also [GenericClass]. +class GenericClassFamily extends Family { + /// See also [GenericClass]. + const GenericClassFamily(); + + /// See also [GenericClass]. + GenericClassProvider call() { + return GenericClassProvider(); + } + + @override + GenericClassProvider getProviderOverride( + covariant GenericClassProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericClassProvider'; +} + +/// See also [GenericClass]. +class GenericClassProvider + extends AutoDisposeStreamNotifierProviderImpl> { + /// See also [GenericClass]. + GenericClassProvider() + : super.internal( + () => GenericClass(), + from: genericClassProvider, + name: r'genericClassProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericClassHash, + dependencies: GenericClassFamily._dependencies, + allTransitiveDependencies: + GenericClassFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is GenericClassProvider; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + + return _SystemHash.finish(hash); + } + + @override + Stream> runNotifierBuild( + covariant GenericClass notifier, + ) { + return notifier.build(); + } +} + String _$publicClassHash() => r'a0b49ed7018eb64309ef147c2d058a45d6092b01'; /// See also [PublicClass]. diff --git a/packages/riverpod_generator/test/integration/sync.dart b/packages/riverpod_generator/test/integration/sync.dart index 2cf69b39e..b2f6a3b9d 100644 --- a/packages/riverpod_generator/test/integration/sync.dart +++ b/packages/riverpod_generator/test/integration/sync.dart @@ -2,6 +2,19 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'sync.g.dart'; +@riverpod +List generic(GenericRef ref) { + return []; +} + +@riverpod +class GenericClass extends _$GenericClass { + @override + List build() { + return []; + } +} + @riverpod Raw> rawFuture(RawFutureRef ref) async { return 'Hello world'; diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 27fa6b1e5..6229bee44 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -6,6 +6,98 @@ part of 'sync.dart'; // RiverpodGenerator // ************************************************************************** +String _$genericHash() => r'2fab4b31aac394b86ac5403fdd99329184d8c5b8'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +typedef GenericRef = AutoDisposeProviderRef>; + +/// See also [generic]. +@ProviderFor(generic) +const genericProvider = GenericFamily(); + +/// See also [generic]. +class GenericFamily extends Family { + /// See also [generic]. + const GenericFamily(); + + /// See also [generic]. + GenericProvider call() { + return GenericProvider(); + } + + @override + GenericProvider getProviderOverride( + covariant GenericProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericProvider'; +} + +/// See also [generic]. +class GenericProvider extends AutoDisposeProvider> { + /// See also [generic]. + GenericProvider() + : super.internal( + (ref) => generic( + ref, + ), + from: genericProvider, + name: r'genericProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericHash, + dependencies: GenericFamily._dependencies, + allTransitiveDependencies: GenericFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is GenericProvider; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + + return _SystemHash.finish(hash); + } +} + String _$rawFutureHash() => r'5203a56065b768023770326281618e3229ccb530'; /// See also [rawFuture]. @@ -35,28 +127,6 @@ final rawStreamProvider = AutoDisposeProvider>.internal( typedef RawStreamRef = AutoDisposeProviderRef>; String _$rawFamilyFutureHash() => r'485f59512081852e51279658facc015309743864'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - typedef RawFamilyFutureRef = AutoDisposeProviderRef>; /// See also [rawFamilyFuture]. @@ -405,6 +475,86 @@ final generatedProvider = AutoDisposeProvider.internal( ); typedef GeneratedRef = AutoDisposeProviderRef; +String _$genericClassHash() => r'5a3dcf57f724f9c16ef52b4d86d767ac65175cf7'; + +abstract class _$GenericClass extends BuildlessAutoDisposeNotifier> { + List build(); +} + +/// See also [GenericClass]. +@ProviderFor(GenericClass) +const genericClassProvider = GenericClassFamily(); + +/// See also [GenericClass]. +class GenericClassFamily extends Family { + /// See also [GenericClass]. + const GenericClassFamily(); + + /// See also [GenericClass]. + GenericClassProvider call() { + return GenericClassProvider(); + } + + @override + GenericClassProvider getProviderOverride( + covariant GenericClassProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericClassProvider'; +} + +/// See also [GenericClass]. +class GenericClassProvider + extends AutoDisposeNotifierProviderImpl> { + /// See also [GenericClass]. + GenericClassProvider() + : super.internal( + () => GenericClass(), + from: genericClassProvider, + name: r'genericClassProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericClassHash, + dependencies: GenericClassFamily._dependencies, + allTransitiveDependencies: + GenericClassFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is GenericClassProvider; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + + return _SystemHash.finish(hash); + } + + @override + List runNotifierBuild( + covariant GenericClass notifier, + ) { + return notifier.build(); + } +} + String _$rawFutureClassHash() => r'bf66f1cdbd99118b8845d206e6a2611b3101f45c'; /// See also [RawFutureClass]. From 7d127a5053f724adf8c93307df773862fb311d3e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 17:57:10 +0200 Subject: [PATCH 017/387] Update all constraints to >=3.0.0 --- benchmarks/pubspec.yaml | 2 +- examples/counter/pubspec.yaml | 2 +- examples/marvel/pubspec.yaml | 2 +- examples/pub/pubspec.yaml | 2 +- examples/random_number/pubspec.yaml | 2 +- examples/stackoverflow/pubspec.yaml | 2 +- examples/todos/pubspec.yaml | 2 +- packages/riverpod_analyzer_utils/pubspec.yaml | 2 +- packages/riverpod_analyzer_utils_tests/pubspec.yaml | 2 +- packages/riverpod_annotation/pubspec.yaml | 2 +- packages/riverpod_cli/fixtures/notifiers/golden/pubspec.yaml | 2 +- .../riverpod_cli/fixtures/unified_syntax/golden/pubspec.yaml | 2 +- packages/riverpod_cli/pubspec.yaml | 2 +- .../riverpod_generator/integration/build_yaml/pubspec.yaml | 2 +- packages/riverpod_generator/pubspec.yaml | 2 +- packages/riverpod_graph/pubspec.yaml | 2 +- .../test/integration/addition/golden/pubspec.yaml | 2 +- .../test/integration/consumer_widget/golden/pubspec.yaml | 2 +- .../test/integration/generated/golden/pubspec.yaml | 2 +- packages/riverpod_lint/pubspec.yaml | 2 +- packages/riverpod_lint_flutter_test/pubspec.yaml | 2 +- pubspec.yaml | 3 ++- tools/generate_providers/pubspec.yaml | 2 +- website/pubspec.yaml | 2 +- 24 files changed, 25 insertions(+), 24 deletions(-) diff --git a/benchmarks/pubspec.yaml b/benchmarks/pubspec.yaml index a2cd6e07d..99dfed423 100644 --- a/benchmarks/pubspec.yaml +++ b/benchmarks/pubspec.yaml @@ -4,7 +4,7 @@ publish_to: 'none' # Remove this line if you wish to publish to pub.dev version: 1.0.0+1 environment: - sdk: ">=2.12.0-0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: flutter: diff --git a/examples/counter/pubspec.yaml b/examples/counter/pubspec.yaml index 5dad486ed..d32cd2f45 100644 --- a/examples/counter/pubspec.yaml +++ b/examples/counter/pubspec.yaml @@ -4,7 +4,7 @@ description: A new Flutter project. publish_to: "none" environment: - sdk: ">=2.18.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" flutter: ">=1.17.0" dependencies: diff --git a/examples/marvel/pubspec.yaml b/examples/marvel/pubspec.yaml index 103c7c65f..cff618a4c 100644 --- a/examples/marvel/pubspec.yaml +++ b/examples/marvel/pubspec.yaml @@ -3,7 +3,7 @@ description: A new Flutter project. publish_to: "none" environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" flutter: ">=1.17.0" dependencies: diff --git a/examples/pub/pubspec.yaml b/examples/pub/pubspec.yaml index 292f1f192..35f970ffd 100644 --- a/examples/pub/pubspec.yaml +++ b/examples/pub/pubspec.yaml @@ -3,7 +3,7 @@ description: A new Flutter project. publish_to: "none" environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" flutter: ">=1.17.0" dependencies: diff --git a/examples/random_number/pubspec.yaml b/examples/random_number/pubspec.yaml index c221d87ac..854448e6f 100644 --- a/examples/random_number/pubspec.yaml +++ b/examples/random_number/pubspec.yaml @@ -3,7 +3,7 @@ description: A new Flutter project. publish_to: 'none' environment: - sdk: ">=2.14.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: flutter: diff --git a/examples/stackoverflow/pubspec.yaml b/examples/stackoverflow/pubspec.yaml index 1b02c8874..66ef48a1b 100644 --- a/examples/stackoverflow/pubspec.yaml +++ b/examples/stackoverflow/pubspec.yaml @@ -3,7 +3,7 @@ description: A new Flutter project. publish_to: "none" environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" flutter: ">=1.17.0" dependencies: diff --git a/examples/todos/pubspec.yaml b/examples/todos/pubspec.yaml index ac9cf2339..b6406d089 100644 --- a/examples/todos/pubspec.yaml +++ b/examples/todos/pubspec.yaml @@ -3,7 +3,7 @@ description: A new Flutter project. publish_to: "none" environment: - sdk: ">=2.14.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" flutter: ">=1.17.0" dependencies: diff --git a/packages/riverpod_analyzer_utils/pubspec.yaml b/packages/riverpod_analyzer_utils/pubspec.yaml index 7c3f16cf9..d7a00b041 100644 --- a/packages/riverpod_analyzer_utils/pubspec.yaml +++ b/packages/riverpod_analyzer_utils/pubspec.yaml @@ -7,7 +7,7 @@ funding: version: 0.3.0 environment: - sdk: ">=2.18.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: analyzer: ^5.0.0 diff --git a/packages/riverpod_analyzer_utils_tests/pubspec.yaml b/packages/riverpod_analyzer_utils_tests/pubspec.yaml index c868df066..a7190ca11 100644 --- a/packages/riverpod_analyzer_utils_tests/pubspec.yaml +++ b/packages/riverpod_analyzer_utils_tests/pubspec.yaml @@ -4,7 +4,7 @@ publish_to: none version: 0.0.1 environment: - sdk: ">=2.18.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: analyzer: ^5.0.0 diff --git a/packages/riverpod_annotation/pubspec.yaml b/packages/riverpod_annotation/pubspec.yaml index d4b82e56e..68a36945e 100644 --- a/packages/riverpod_annotation/pubspec.yaml +++ b/packages/riverpod_annotation/pubspec.yaml @@ -7,7 +7,7 @@ funding: - https://github.com/sponsors/rrousselGit/ environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: meta: ^1.7.0 diff --git a/packages/riverpod_cli/fixtures/notifiers/golden/pubspec.yaml b/packages/riverpod_cli/fixtures/notifiers/golden/pubspec.yaml index 08438d8d4..7630a7d35 100644 --- a/packages/riverpod_cli/fixtures/notifiers/golden/pubspec.yaml +++ b/packages/riverpod_cli/fixtures/notifiers/golden/pubspec.yaml @@ -3,7 +3,7 @@ description: Test riverpod codemods publish_to: none environment: - sdk: ">=2.12.0-0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: flutter: diff --git a/packages/riverpod_cli/fixtures/unified_syntax/golden/pubspec.yaml b/packages/riverpod_cli/fixtures/unified_syntax/golden/pubspec.yaml index 42be2293a..9afb076d5 100644 --- a/packages/riverpod_cli/fixtures/unified_syntax/golden/pubspec.yaml +++ b/packages/riverpod_cli/fixtures/unified_syntax/golden/pubspec.yaml @@ -3,7 +3,7 @@ description: Test riverpod codemods publish_to: none environment: - sdk: ">=2.12.0-0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: flutter: diff --git a/packages/riverpod_cli/pubspec.yaml b/packages/riverpod_cli/pubspec.yaml index eecbaebc7..4430ad38b 100644 --- a/packages/riverpod_cli/pubspec.yaml +++ b/packages/riverpod_cli/pubspec.yaml @@ -8,7 +8,7 @@ funding: - https://github.com/sponsors/rrousselGit/ environment: - sdk: '>=2.12.0 <3.0.0' + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: analyzer: "^1.5.0" diff --git a/packages/riverpod_generator/integration/build_yaml/pubspec.yaml b/packages/riverpod_generator/integration/build_yaml/pubspec.yaml index 519d94960..dfc88949f 100644 --- a/packages/riverpod_generator/integration/build_yaml/pubspec.yaml +++ b/packages/riverpod_generator/integration/build_yaml/pubspec.yaml @@ -3,7 +3,7 @@ description: A sample command-line application. publish_to: none environment: - sdk: ">=2.18.4 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: riverpod: diff --git a/packages/riverpod_generator/pubspec.yaml b/packages/riverpod_generator/pubspec.yaml index a0e5959be..3a8700361 100644 --- a/packages/riverpod_generator/pubspec.yaml +++ b/packages/riverpod_generator/pubspec.yaml @@ -7,7 +7,7 @@ funding: - https://github.com/sponsors/rrousselGit/ environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: analyzer: ">4.2.0 <6.0.0" diff --git a/packages/riverpod_graph/pubspec.yaml b/packages/riverpod_graph/pubspec.yaml index bea5adeb6..208d665c3 100644 --- a/packages/riverpod_graph/pubspec.yaml +++ b/packages/riverpod_graph/pubspec.yaml @@ -8,7 +8,7 @@ funding: - https://github.com/sponsors/rrousselGit/ environment: - sdk: ">=2.15.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: analyzer: ">=4.0.0 <4.1.0" diff --git a/packages/riverpod_graph/test/integration/addition/golden/pubspec.yaml b/packages/riverpod_graph/test/integration/addition/golden/pubspec.yaml index b677ec598..c218db294 100644 --- a/packages/riverpod_graph/test/integration/addition/golden/pubspec.yaml +++ b/packages/riverpod_graph/test/integration/addition/golden/pubspec.yaml @@ -2,7 +2,7 @@ name: riverpod_graph_golden_addition publish_to: none environment: - sdk: ">=2.14.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: riverpod: diff --git a/packages/riverpod_graph/test/integration/consumer_widget/golden/pubspec.yaml b/packages/riverpod_graph/test/integration/consumer_widget/golden/pubspec.yaml index 3376bf28c..0b6fd2f88 100644 --- a/packages/riverpod_graph/test/integration/consumer_widget/golden/pubspec.yaml +++ b/packages/riverpod_graph/test/integration/consumer_widget/golden/pubspec.yaml @@ -4,7 +4,7 @@ description: A new Flutter project. publish_to: "none" environment: - sdk: ">=2.14.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" flutter: ">=1.17.0" dependencies: diff --git a/packages/riverpod_graph/test/integration/generated/golden/pubspec.yaml b/packages/riverpod_graph/test/integration/generated/golden/pubspec.yaml index 5f80267d0..564d3277b 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/pubspec.yaml +++ b/packages/riverpod_graph/test/integration/generated/golden/pubspec.yaml @@ -4,7 +4,7 @@ description: A new Flutter project. publish_to: "none" environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" flutter: ">=1.17.0" dependencies: diff --git a/packages/riverpod_lint/pubspec.yaml b/packages/riverpod_lint/pubspec.yaml index 4c8f4f2c3..8c5c0166d 100644 --- a/packages/riverpod_lint/pubspec.yaml +++ b/packages/riverpod_lint/pubspec.yaml @@ -9,7 +9,7 @@ funding: environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: analyzer: ^5.2.0 diff --git a/packages/riverpod_lint_flutter_test/pubspec.yaml b/packages/riverpod_lint_flutter_test/pubspec.yaml index aa3d8b1c2..95c312f3f 100644 --- a/packages/riverpod_lint_flutter_test/pubspec.yaml +++ b/packages/riverpod_lint_flutter_test/pubspec.yaml @@ -2,7 +2,7 @@ name: riverpod_lint_flutter_test publish_to: none environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" flutter: ">=3.0.0" dependencies: diff --git a/pubspec.yaml b/pubspec.yaml index 671355da8..48beff9f7 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -2,6 +2,7 @@ name: melos_root publish_to: none environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" + dev_dependencies: melos: ^3.0.0 diff --git a/tools/generate_providers/pubspec.yaml b/tools/generate_providers/pubspec.yaml index ab6a1bc59..836aafcda 100644 --- a/tools/generate_providers/pubspec.yaml +++ b/tools/generate_providers/pubspec.yaml @@ -2,7 +2,7 @@ name: generate_providers publish_to: "none" environment: - sdk: ">=2.19.0 <4.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: dart_style: ^2.0.0 diff --git a/website/pubspec.yaml b/website/pubspec.yaml index a9485e943..3dec99ae4 100644 --- a/website/pubspec.yaml +++ b/website/pubspec.yaml @@ -2,7 +2,7 @@ name: website_snippets publish_to: "none" environment: - sdk: ">=2.12.0-0 <3.0.0" + sdk: ">=3.0.0-0.0-dev <4.0.0" dependencies: collection: ^1.15.0 From 1b77a6c2697eb5bfcb14fbd3337719da80bcc399 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Apr 2023 20:54:32 +0200 Subject: [PATCH 018/387] Allows providers to have generic parameters in riverpod_generator (#2489) --- .github/workflows/build.yml | 1 - .github/workflows/riverpod_lint.yml | 4 +- examples/todos/lib/main.dart | 12 +- packages/hooks_riverpod/example/lib/main.dart | 4 +- .../golden/change_notifier_provider.dart | 4 +- .../golden/state_notifier_provider.dart | 6 +- .../notifiers/golden/state_provider.dart | 4 +- .../unified_syntax/golden/widgets.dart | 32 +- packages/riverpod_generator/CHANGELOG.md | 22 ++ .../lib/src/templates/family.dart | 78 +++- .../test/integration/async.dart | 2 +- .../test/integration/async.g.dart | 41 +- .../test/integration/stream.dart | 2 +- .../test/integration/stream.g.dart | 41 +- .../test/integration/sync.dart | 15 +- .../test/integration/sync.g.dart | 137 ++++++- .../riverpod_generator/test/sync_test.dart | 65 ++++ .../consumer_widget/golden/lib/main.dart | 2 +- packages/riverpod_lint/CHANGELOG.md | 5 + .../stateful_to_stateless_provider.dart | 18 +- .../stateless_to_stateful_provider.dart | 15 +- .../src/lints/generator_class_extends.dart | 64 +++- .../lib/src/lints/stateless_ref.dart | 27 +- ...onvert_stateful_provider_to_stateless.dart | 6 + ...vert_stateful_provider_to_stateless.g.dart | 81 ++++ ...onvert_stateful_provider_to_stateless.json | 2 +- ...t_stateful_provider_to_stateless_test.dart | 1 + ...onvert_stateless_provider_to_stateful.dart | 3 + ...vert_stateless_provider_to_stateful.g.dart | 72 ++++ ...onvert_stateless_provider_to_stateful.json | 2 +- ...t_stateless_provider_to_stateful_test.dart | 1 + .../test/goldens/generator_class_extends.dart | 25 ++ .../goldens/generator_class_extends.g.dart | 350 ++++++++++++++++++ .../test/goldens/generator_class_extends.json | 2 +- .../goldens/generator_class_extends_test.dart | 25 +- .../test/goldens/stateless_ref.dart | 15 + .../test/goldens/stateless_ref.g.dart | 312 ++++++++++++++++ .../test/goldens/stateless_ref.json | 1 + .../concepts/provider_observer_logger.dart | 2 +- .../docs/concepts/reading_consumer_hook.dart | 2 +- .../reading_consumer_hook_widget.dart | 2 +- .../reading_consumer_stateful_widget.dart | 2 +- .../concepts/reading_consumer_widget.dart | 2 +- website/docs/concepts/reading_listen.dart | 2 +- .../docs/concepts/reading_listen_build.dart | 4 +- website/docs/concepts/reading_read.dart | 4 +- ...reading_stateful_hook_consumer_widget.dart | 2 +- .../docs/concepts/reading_watch_build.dart | 2 +- website/docs/cookbooks/testing_flutter.dart | 2 +- website/docs/cookbooks/testing_full.dart | 2 +- .../docs/cookbooks/testing_override_info.dart | 2 +- .../todos_consumer.dart | 2 +- .../provider/optimized_previous_button.dart | 2 +- .../provider/unoptimized_previous_button.dart | 2 +- .../todos_consumer.dart | 2 +- .../docs/providers/state_provider/full.dart | 4 +- .../state_provider/update_read_once.dart | 2 +- .../state_provider/update_read_twice.dart | 2 +- .../concepts/provider_observer_logger.dart | 2 +- .../concepts/reading_consumer_hook.dart | 2 +- .../reading_consumer_hook_widget.dart | 2 +- .../reading_consumer_stateful_widget.dart | 2 +- .../concepts/reading_consumer_widget.dart | 2 +- .../current/concepts/reading_listen.dart | 2 +- .../concepts/reading_listen_build.dart | 4 +- .../current/concepts/reading_read.dart | 4 +- .../current/concepts/reading_watch_build.dart | 2 +- .../current/cookbooks/testing_flutter.dart | 2 +- .../current/cookbooks/testing_full.dart | 2 +- .../cookbooks/testing_override_info.dart | 2 +- .../provider/optimized_previous_button.dart | 2 +- .../provider/unoptimized_previous_button.dart | 2 +- .../todos_consumer.dart | 2 +- .../providers/state_provider/full.dart | 4 +- .../state_provider/update_read_once.dart | 2 +- .../state_provider/update_read_twice.dart | 2 +- .../concepts/provider_observer_logger.dart | 2 +- .../concepts/reading_consumer_hook.dart | 2 +- .../reading_consumer_hook_widget.dart | 2 +- .../reading_consumer_stateful_widget.dart | 2 +- .../concepts/reading_consumer_widget.dart | 2 +- .../current/concepts/reading_listen.dart | 2 +- .../concepts/reading_listen_build.dart | 4 +- .../current/concepts/reading_read.dart | 4 +- .../current/concepts/reading_watch_build.dart | 2 +- .../current/cookbooks/testing_flutter.dart | 2 +- .../current/cookbooks/testing_full.dart | 2 +- .../cookbooks/testing_override_info.dart | 2 +- .../provider/optimized_previous_button.dart | 2 +- .../provider/unoptimized_previous_button.dart | 2 +- .../todos_consumer.dart | 2 +- .../providers/state_provider/full.dart | 4 +- .../state_provider/update_read_once.dart | 2 +- .../state_provider/update_read_twice.dart | 2 +- .../provider/optimized_previous_button.dart | 2 +- .../provider/unoptimized_previous_button.dart | 2 +- .../todos_consumer.dart | 2 +- .../providers/state_provider/full.dart | 4 +- .../state_provider/update_read_once.dart | 2 +- .../state_provider/update_read_twice.dart | 2 +- .../concepts/provider_observer_logger.dart | 2 +- .../concepts/reading_consumer_hook.dart | 2 +- .../reading_consumer_hook_widget.dart | 2 +- .../reading_consumer_stateful_widget.dart | 2 +- .../concepts/reading_consumer_widget.dart | 2 +- .../current/concepts/reading_listen.dart | 2 +- .../concepts/reading_listen_build.dart | 4 +- .../current/concepts/reading_read.dart | 4 +- .../current/concepts/reading_watch_build.dart | 2 +- .../todos_consumer.dart | 2 +- .../provider/optimized_previous_button.dart | 2 +- .../provider/unoptimized_previous_button.dart | 2 +- .../todos_consumer.dart | 2 +- .../providers/state_provider/full.dart | 4 +- .../state_provider/update_read_once.dart | 2 +- .../state_provider/update_read_twice.dart | 2 +- .../concepts/provider_observer_logger.dart | 2 +- .../concepts/reading_consumer_hook.dart | 2 +- .../reading_consumer_hook_widget.dart | 2 +- .../reading_consumer_stateful_widget.dart | 2 +- .../concepts/reading_consumer_widget.dart | 2 +- .../current/concepts/reading_read.dart | 4 +- ...reading_stateful_hook_consumer_widget.dart | 2 +- .../current/concepts/reading_watch_build.dart | 2 +- .../current/cookbooks/testing_flutter.dart | 2 +- .../current/cookbooks/testing_full.dart | 2 +- .../cookbooks/testing_override_info.dart | 2 +- .../provider/optimized_previous_button.dart | 2 +- .../provider/unoptimized_previous_button.dart | 2 +- .../todos_consumer.dart | 2 +- .../providers/state_provider/full.dart | 4 +- .../state_provider/update_read_twice.dart | 2 +- .../concepts/provider_observer_logger.dart | 2 +- .../concepts/reading_consumer_hook.dart | 2 +- .../reading_consumer_hook_widget.dart | 2 +- .../reading_consumer_stateful_widget.dart | 2 +- .../concepts/reading_consumer_widget.dart | 2 +- .../current/concepts/reading_listen.dart | 2 +- .../concepts/reading_listen_build.dart | 4 +- .../current/concepts/reading_read.dart | 4 +- ...reading_stateful_hook_consumer_widget.dart | 2 +- .../current/concepts/reading_watch_build.dart | 2 +- .../current/cookbooks/testing_flutter.dart | 2 +- .../current/cookbooks/testing_full.dart | 2 +- .../cookbooks/testing_override_info.dart | 2 +- .../todos_consumer.dart | 2 +- .../provider/optimized_previous_button.dart | 2 +- .../provider/unoptimized_previous_button.dart | 2 +- .../todos_consumer.dart | 2 +- .../providers/state_provider/full.dart | 4 +- .../state_provider/update_read_once.dart | 2 +- .../state_provider/update_read_twice.dart | 2 +- .../concepts/provider_observer_logger.dart | 2 +- .../concepts/reading_consumer_hook.dart | 2 +- .../reading_consumer_hook_widget.dart | 2 +- .../reading_consumer_stateful_widget.dart | 2 +- .../concepts/reading_consumer_widget.dart | 2 +- .../current/concepts/reading_listen.dart | 2 +- .../concepts/reading_listen_build.dart | 4 +- .../current/concepts/reading_read.dart | 4 +- .../current/concepts/reading_watch_build.dart | 2 +- .../current/cookbooks/testing_flutter.dart | 2 +- .../current/cookbooks/testing_full.dart | 2 +- .../cookbooks/testing_override_info.dart | 2 +- .../provider/optimized_previous_button.dart | 2 +- .../provider/unoptimized_previous_button.dart | 2 +- .../todos_consumer.dart | 2 +- .../providers/state_provider/full.dart | 4 +- .../state_provider/update_read_once.dart | 2 +- .../state_provider/update_read_twice.dart | 2 +- .../concepts/provider_observer_logger.dart | 2 +- .../concepts/reading_consumer_hook.dart | 2 +- .../reading_consumer_hook_widget.dart | 2 +- .../reading_consumer_stateful_widget.dart | 2 +- .../concepts/reading_consumer_widget.dart | 2 +- .../current/concepts/reading_listen.dart | 2 +- .../concepts/reading_listen_build.dart | 4 +- .../current/concepts/reading_read.dart | 4 +- ...reading_stateful_hook_consumer_widget.dart | 2 +- .../current/concepts/reading_watch_build.dart | 2 +- .../current/cookbooks/testing_flutter.dart | 2 +- .../current/cookbooks/testing_full.dart | 2 +- .../cookbooks/testing_override_info.dart | 2 +- .../todos_consumer.dart | 2 +- .../provider/optimized_previous_button.dart | 2 +- .../provider/unoptimized_previous_button.dart | 2 +- .../todos_consumer.dart | 2 +- .../providers/state_provider/full.dart | 4 +- .../state_provider/update_read_once.dart | 2 +- .../state_provider/update_read_twice.dart | 2 +- 190 files changed, 1557 insertions(+), 294 deletions(-) create mode 100644 packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.json diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index a1d9f4b05..9d311c230 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -24,7 +24,6 @@ jobs: strategy: matrix: channel: - - stable - master package_path: - examples/counter diff --git a/.github/workflows/riverpod_lint.yml b/.github/workflows/riverpod_lint.yml index 64ee2ea90..3747dcec7 100644 --- a/.github/workflows/riverpod_lint.yml +++ b/.github/workflows/riverpod_lint.yml @@ -24,7 +24,7 @@ jobs: strategy: matrix: channel: - - stable + - master package_path: - packages/riverpod_analyzer_utils - packages/riverpod_analyzer_utils_tests @@ -46,7 +46,7 @@ jobs: run: flutter pub get - run: dart pub global activate custom_lint - name: Check format - run: flutter format --set-exit-if-changed . + run: dart format --set-exit-if-changed . - name: Analyze run: flutter analyze diff --git a/examples/todos/lib/main.dart b/examples/todos/lib/main.dart index 7b3e251d4..857da0a6f 100644 --- a/examples/todos/lib/main.dart +++ b/examples/todos/lib/main.dart @@ -70,7 +70,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { @@ -81,7 +81,7 @@ class MyApp extends StatelessWidget { } class Home extends HookConsumerWidget { - const Home({Key? key}) : super(key: key); + const Home({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { @@ -133,8 +133,8 @@ class Home extends HookConsumerWidget { class Toolbar extends HookConsumerWidget { const Toolbar({ - Key? key, - }) : super(key: key); + super.key, + }); @override Widget build(BuildContext context, WidgetRef ref) { @@ -205,7 +205,7 @@ class Toolbar extends HookConsumerWidget { } class Title extends StatelessWidget { - const Title({Key? key}) : super(key: key); + const Title({super.key}); @override Widget build(BuildContext context) { @@ -232,7 +232,7 @@ class Title extends StatelessWidget { final _currentTodo = Provider((ref) => throw UnimplementedError()); class TodoItem extends HookConsumerWidget { - const TodoItem({Key? key}) : super(key: key); + const TodoItem({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/packages/hooks_riverpod/example/lib/main.dart b/packages/hooks_riverpod/example/lib/main.dart index 4302d4e6b..50f365e7e 100644 --- a/packages/hooks_riverpod/example/lib/main.dart +++ b/packages/hooks_riverpod/example/lib/main.dart @@ -32,7 +32,7 @@ class Counter extends StateNotifier { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { @@ -43,7 +43,7 @@ class MyApp extends StatelessWidget { } class MyHomePage extends HookConsumerWidget { - const MyHomePage({Key? key}) : super(key: key); + const MyHomePage({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/packages/riverpod_cli/fixtures/notifiers/golden/change_notifier_provider.dart b/packages/riverpod_cli/fixtures/notifiers/golden/change_notifier_provider.dart index 12b7ae153..72eff1f67 100644 --- a/packages/riverpod_cli/fixtures/notifiers/golden/change_notifier_provider.dart +++ b/packages/riverpod_cli/fixtures/notifiers/golden/change_notifier_provider.dart @@ -30,7 +30,7 @@ final otherProvider = Provider((ref) { }); class ConsumerWatch extends ConsumerWidget { - const ConsumerWatch({Key? key}) : super(key: key); + const ConsumerWatch({super.key}); @override Widget build(BuildContext context, ScopedReader watch) { @@ -42,7 +42,7 @@ class ConsumerWatch extends ConsumerWidget { } class HooksWatch extends HookWidget { - const HooksWatch({Key? key}) : super(key: key); + const HooksWatch({super.key}); @override Widget build(BuildContext context) { diff --git a/packages/riverpod_cli/fixtures/notifiers/golden/state_notifier_provider.dart b/packages/riverpod_cli/fixtures/notifiers/golden/state_notifier_provider.dart index 0b005a83e..b94f04412 100644 --- a/packages/riverpod_cli/fixtures/notifiers/golden/state_notifier_provider.dart +++ b/packages/riverpod_cli/fixtures/notifiers/golden/state_notifier_provider.dart @@ -20,7 +20,7 @@ class Counter extends StateNotifier { } class CounterNullable extends StateNotifier { - CounterNullable(int? init) : super(init); + CounterNullable(super.init); void increment() => state = state! + 1; void decrement() => state = state! - 1; @@ -53,7 +53,7 @@ final otherProvider = Provider((ref) { }); class ConsumerWatch extends ConsumerWidget { - const ConsumerWatch({Key? key}) : super(key: key); + const ConsumerWatch({super.key}); @override Widget build(BuildContext context, ScopedReader watch) { @@ -67,7 +67,7 @@ class ConsumerWatch extends ConsumerWidget { } class HooksWatch extends HookWidget { - const HooksWatch({Key? key}) : super(key: key); + const HooksWatch({super.key}); @override Widget build(BuildContext context) { diff --git a/packages/riverpod_cli/fixtures/notifiers/golden/state_provider.dart b/packages/riverpod_cli/fixtures/notifiers/golden/state_provider.dart index 43ae572c6..82a97ec96 100644 --- a/packages/riverpod_cli/fixtures/notifiers/golden/state_provider.dart +++ b/packages/riverpod_cli/fixtures/notifiers/golden/state_provider.dart @@ -20,7 +20,7 @@ final otherProvider = Provider((ref) { }); class ConsumerWatch extends ConsumerWidget { - const ConsumerWatch({Key? key}) : super(key: key); + const ConsumerWatch({super.key}); @override Widget build(BuildContext context, ScopedReader watch) { @@ -34,7 +34,7 @@ class ConsumerWatch extends ConsumerWidget { } class HooksWatch extends HookWidget { - const HooksWatch({Key? key}) : super(key: key); + const HooksWatch({super.key}); @override Widget build(BuildContext context) { diff --git a/packages/riverpod_cli/fixtures/unified_syntax/golden/widgets.dart b/packages/riverpod_cli/fixtures/unified_syntax/golden/widgets.dart index 3f8db4311..c08bb6305 100644 --- a/packages/riverpod_cli/fixtures/unified_syntax/golden/widgets.dart +++ b/packages/riverpod_cli/fixtures/unified_syntax/golden/widgets.dart @@ -81,7 +81,7 @@ class Logger extends ProviderObserver { } class ImageProvider extends StatelessWidget { - const ImageProvider({Key? key}) : super(key: key); + const ImageProvider({super.key}); @override Widget build(BuildContext context) { @@ -90,7 +90,7 @@ class ImageProvider extends StatelessWidget { } class ConsumerWatch extends ConsumerWidget { - const ConsumerWatch({Key? key}) : super(key: key); + const ConsumerWatch({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { @@ -108,7 +108,7 @@ class ConsumerWatch extends ConsumerWidget { } class StatelessRead extends ConsumerWidget { - const StatelessRead({Key? key}) : super(key: key); + const StatelessRead({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { @@ -125,7 +125,7 @@ class StatelessRead extends ConsumerWidget { } class StatelessConsumerRead extends ConsumerWidget { - const StatelessConsumerRead({Key? key}) : super(key: key); + const StatelessConsumerRead({super.key}); void onPressed(WidgetRef ref, BuildContext context) { ref.read(counterProvider); @@ -156,7 +156,7 @@ class StatelessConsumerRead extends ConsumerWidget { } class StatelessListen extends ConsumerWidget { - const StatelessListen({Key? key}) : super(key: key); + const StatelessListen({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { @@ -168,7 +168,7 @@ class StatelessListen extends ConsumerWidget { } class StatelessListen2 extends ConsumerWidget { - const StatelessListen2({Key? key}) : super(key: key); + const StatelessListen2({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { @@ -178,7 +178,7 @@ class StatelessListen2 extends ConsumerWidget { } class StatelessListen3 extends ConsumerWidget { - const StatelessListen3({Key? key}) : super(key: key); + const StatelessListen3({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { @@ -194,7 +194,7 @@ void _onChange(int? previous, int i) { } class StatelessExpressionListen extends ConsumerWidget { - const StatelessExpressionListen({Key? key}) : super(key: key); + const StatelessExpressionListen({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { @@ -208,7 +208,7 @@ class StatelessExpressionListen extends ConsumerWidget { } class StatefulConsumerBasic extends ConsumerStatefulWidget { - const StatefulConsumerBasic({Key? key}) : super(key: key); + const StatefulConsumerBasic({super.key}); @override ConsumerState createState() => @@ -229,7 +229,7 @@ class _StatefulConsumerBasicState extends ConsumerState { } class StatefulConsumer extends ConsumerStatefulWidget { - const StatefulConsumer({Key? key}) : super(key: key); + const StatefulConsumer({super.key}); @override // ignore: library_private_types_in_public_api @@ -271,7 +271,7 @@ class _StatefulConsumerState2 extends ConsumerState { } class StatefulConsumer2 extends ConsumerStatefulWidget { - const StatefulConsumer2({Key? key}) : super(key: key); + const StatefulConsumer2({super.key}); @override // ignore: library_private_types_in_public_api @@ -279,7 +279,7 @@ class StatefulConsumer2 extends ConsumerStatefulWidget { } class HooksWatch extends HookConsumerWidget { - const HooksWatch({Key? key}) : super(key: key); + const HooksWatch({super.key}); void empty() {} void error(Object err, StackTrace? st) {} @@ -316,7 +316,7 @@ class HooksWatch extends HookConsumerWidget { } class HooksConsumerWatch extends StatelessWidget { - const HooksConsumerWatch({Key? key}) : super(key: key); + const HooksConsumerWatch({super.key}); @override Widget build(BuildContext context) { @@ -338,7 +338,7 @@ class HooksConsumerWatch extends StatelessWidget { } class HooksConsumerSimple extends ConsumerWidget { - const HooksConsumerSimple({Key? key}) : super(key: key); + const HooksConsumerSimple({super.key}); @override Widget build(BuildContext context, WidgetRef ref) => _build(ref); @@ -352,7 +352,7 @@ class HooksConsumerSimple extends ConsumerWidget { } class BasicUseOfCustomHook extends HookConsumerWidget { - const BasicUseOfCustomHook({Key? key}) : super(key: key); + const BasicUseOfCustomHook({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { useAnotherHook(ref); @@ -373,7 +373,7 @@ void useAnotherHook(WidgetRef ref) { } class NoMigrateHook extends HookWidget { - const NoMigrateHook({Key? key}) : super(key: key); + const NoMigrateHook({super.key}); @override Widget build(BuildContext context) { final state = useState(''); diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 170554484..0c08ebc86 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -1,5 +1,27 @@ ## Unreleased major +- Providers can now be generic: + + ```dart + @riverpod + List example(ExampleRef ref) { + return []; + } + + @riverpod + class ClassExample extends _$ClassExample { + @override + List build() => []; + } + ``` + + Specifying type parameters works the same as specifying arguments, and + make the generated provider a "function": + + ```dart + ref.watch(example()); + ``` + - Upgraded to use Riverpod 3.0 ## 2.2.1 - 2023-04-24 diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 97b98c36a..dad6c154a 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -1,3 +1,4 @@ +import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/dart/element/element.dart'; import 'package:collection/collection.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; @@ -15,11 +16,32 @@ String providerFamilyNameFor( return '${provider.name.lowerFirst}${options.providerFamilyNameSuffix ?? options.providerNameSuffix ?? 'Provider'}'; } +String genericDefinitionDisplayString(TypeParameterList? typeParameters) { + return typeParameters?.toSource() ?? ''; +} + +String genericUsageDisplayString(TypeParameterList? typeParameterList) { + if (typeParameterList == null) { + return ''; + } + + return '<${typeParameterList.typeParameters.map((e) => e.name.lexeme).join(', ')}>'; +} + +String anyGenericUsageDisplayString(TypeParameterList? typeParameterList) { + if (typeParameterList == null) { + return ''; + } + + return '<${typeParameterList.typeParameters.map((e) => e.declaredElement?.bound?.toString() ?? 'Object?').join(', ')}>'; +} + class FamilyTemplate extends Template { FamilyTemplate._( this.provider, { required this.options, required this.parameters, + required this.typeParameters, required this.providerType, required this.providerGenerics, required this.providerCreate, @@ -69,17 +91,24 @@ class FamilyTemplate extends Template { for (final parameter in parameters) parameter: parameter.name, }); + final typeParameters = provider.node.functionExpression.typeParameters; + final typeParametersDefinition = + genericDefinitionDisplayString(typeParameters); + final typeParametersUsage = genericUsageDisplayString(typeParameters); + return FamilyTemplate._( provider, options: options, parameters: parameters, + typeParameters: typeParameters, hashFn: hashFn, providerGenerics: '<${provider.valueType}>', - providerCreate: '(ref) => ${provider.name}(ref, $parametersPassThrough)', + providerCreate: + '(ref) => ${provider.name}$typeParametersUsage(ref, $parametersPassThrough)', providerType: providerType, parametersPassThrough: parametersPassThrough, other: ''' -typedef $refName = ${providerType}Ref<${provider.valueType}>; +typedef $refName$typeParametersDefinition = ${providerType}Ref<${provider.valueType}>; ''', ); } @@ -120,17 +149,28 @@ typedef $refName = ${providerType}Ref<${provider.valueType}>; for (final parameter in parameters) parameter: parameter.name, }); + final typeParameters = provider.node.typeParameters; + final typeParametersUsage = genericUsageDisplayString(typeParameters); + final typeParametersDefinition = + genericDefinitionDisplayString(typeParameters); + return FamilyTemplate._( provider, options: options, parameters: parameters, + typeParameters: typeParameters, hashFn: hashFn, - providerGenerics: '<${provider.name}, ${provider.valueType}>', + providerGenerics: + '<${provider.name}$typeParametersUsage, ${provider.valueType}>', providerType: providerType, - providerCreate: '() => ${provider.name}()$cascadePropertyInit', + providerCreate: parameters.isEmpty + // If the provider has no arguments (and therefore only generics), + // use tear-off constructor + ? '${provider.name.lexeme}$typeParametersUsage.new' + : '() => ${provider.name}$typeParametersUsage()$cascadePropertyInit', parametersPassThrough: parametersPassThrough, other: ''' -abstract class $notifierTypedefName extends $notifierBaseType<${provider.valueType}> { +abstract class $notifierTypedefName$typeParametersDefinition extends $notifierBaseType<${provider.valueType}> { ${parameters.map((e) => 'late final ${e.type} ${e.name};').join('\n')} ${provider.createdType} build($parameterDefinition); @@ -139,7 +179,7 @@ abstract class $notifierTypedefName extends $notifierBaseType<${provider.valueTy providerOther: ''' @override ${provider.createdType} runNotifierBuild( - covariant ${provider.name} notifier, + covariant ${provider.name}$typeParametersUsage notifier, ) { return notifier.build($parametersPassThrough); } @@ -149,6 +189,7 @@ abstract class $notifierTypedefName extends $notifierBaseType<${provider.valueTy final GeneratorProviderDeclaration provider; final List parameters; + final TypeParameterList? typeParameters; final BuildYamlOptions options; final String providerType; final String providerGenerics; @@ -183,6 +224,11 @@ abstract class $notifierTypedefName extends $notifierBaseType<${provider.valueTy ? 'const Iterable?' : 'final Iterable'; + final typeParametersDefinition = + genericDefinitionDisplayString(typeParameters); + final typeParametersUsage = genericUsageDisplayString(typeParameters); + final anyTypeParametersUsage = anyGenericUsageDisplayString(typeParameters); + buffer.write(''' $other @@ -196,13 +242,13 @@ class $familyName extends Family { const $familyName(); $docs - $providerTypeNameImpl call($parameterDefinition) { - return $providerTypeNameImpl($parametersPassThrough); + $providerTypeNameImpl$typeParametersUsage call$typeParametersDefinition($parameterDefinition) { + return $providerTypeNameImpl$typeParametersUsage($parametersPassThrough); } @override - $providerTypeNameImpl getProviderOverride( - covariant $providerTypeNameImpl provider, + $providerTypeNameImpl$anyTypeParametersUsage getProviderOverride( + covariant $providerTypeNameImpl$anyTypeParametersUsage provider, ) { return call($parameterProviderPassThrough); } @@ -222,7 +268,7 @@ class $familyName extends Family { } $docs -class $providerTypeNameImpl extends $providerType$providerGenerics { +class $providerTypeNameImpl$typeParametersDefinition extends $providerType$providerGenerics { $docs $providerTypeNameImpl($thisParameterDefinition) : super.internal( $providerCreate, @@ -239,14 +285,20 @@ ${parameters.map((e) => 'final ${e.type.getDisplayString(withNullability: true)} bool operator ==(Object other) { return ${[ 'other is $providerTypeNameImpl', - ...parameters.map((e) => 'other.${e.name} == ${e.name}') + // If there are type parameters, check the runtimeType to check them too. + if (typeParameters?.typeParameters.isNotEmpty ?? false) + 'other.runtimeType == runtimeType', + ...parameters.map((e) => 'other.${e.name} == ${e.name}'), ].join(' && ')}; } @override int get hashCode { var hash = _SystemHash.combine(0, runtimeType.hashCode); -${parameters.map((e) => 'hash = _SystemHash.combine(hash, ${e.name}.hashCode);').join()} +${[ + ...parameters.map((e) => e.name), + ...?typeParameters?.typeParameters.map((e) => e.name) + ].map((e) => 'hash = _SystemHash.combine(hash, $e.hashCode);').join()} return _SystemHash.finish(hash); } diff --git a/packages/riverpod_generator/test/integration/async.dart b/packages/riverpod_generator/test/integration/async.dart index 7206ee4a5..93dc20d8a 100644 --- a/packages/riverpod_generator/test/integration/async.dart +++ b/packages/riverpod_generator/test/integration/async.dart @@ -8,7 +8,7 @@ Future> generic(GenericRef ref) async { } @riverpod -class GenericClass extends _$GenericClass { +class GenericClass extends _$GenericClass { @override Future> build() async { return []; diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 1ba5a2d9c..a1c9882db 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -29,7 +29,7 @@ class _SystemHash { } } -typedef GenericRef = AutoDisposeFutureProviderRef>; +typedef GenericRef = AutoDisposeFutureProviderRef>; /// See also [generic]. @ProviderFor(generic) @@ -41,13 +41,13 @@ class GenericFamily extends Family { const GenericFamily(); /// See also [generic]. - GenericProvider call() { - return GenericProvider(); + GenericProvider call() { + return GenericProvider(); } @override - GenericProvider getProviderOverride( - covariant GenericProvider provider, + GenericProvider getProviderOverride( + covariant GenericProvider provider, ) { return call(); } @@ -68,11 +68,12 @@ class GenericFamily extends Family { } /// See also [generic]. -class GenericProvider extends AutoDisposeFutureProvider> { +class GenericProvider + extends AutoDisposeFutureProvider> { /// See also [generic]. GenericProvider() : super.internal( - (ref) => generic( + (ref) => generic( ref, ), from: genericProvider, @@ -87,12 +88,13 @@ class GenericProvider extends AutoDisposeFutureProvider> { @override bool operator ==(Object other) { - return other is GenericProvider; + return other is GenericProvider && other.runtimeType == runtimeType; } @override int get hashCode { var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, T.hashCode); return _SystemHash.finish(hash); } @@ -240,9 +242,9 @@ class FamilyProvider extends AutoDisposeFutureProvider { } } -String _$genericClassHash() => r'0c53e36d8c4776a3835fb87502355340a8dd2cc6'; +String _$genericClassHash() => r'd3c4acc9cdae12f6c666fbf1f89aee212bb086db'; -abstract class _$GenericClass +abstract class _$GenericClass extends BuildlessAutoDisposeAsyncNotifier> { Future> build(); } @@ -257,13 +259,13 @@ class GenericClassFamily extends Family { const GenericClassFamily(); /// See also [GenericClass]. - GenericClassProvider call() { - return GenericClassProvider(); + GenericClassProvider call() { + return GenericClassProvider(); } @override - GenericClassProvider getProviderOverride( - covariant GenericClassProvider provider, + GenericClassProvider getProviderOverride( + covariant GenericClassProvider provider, ) { return call(); } @@ -284,12 +286,12 @@ class GenericClassFamily extends Family { } /// See also [GenericClass]. -class GenericClassProvider - extends AutoDisposeAsyncNotifierProviderImpl> { +class GenericClassProvider + extends AutoDisposeAsyncNotifierProviderImpl, List> { /// See also [GenericClass]. GenericClassProvider() : super.internal( - () => GenericClass(), + GenericClass.new, from: genericClassProvider, name: r'genericClassProvider', debugGetCreateSourceHash: @@ -303,19 +305,20 @@ class GenericClassProvider @override bool operator ==(Object other) { - return other is GenericClassProvider; + return other is GenericClassProvider && other.runtimeType == runtimeType; } @override int get hashCode { var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, T.hashCode); return _SystemHash.finish(hash); } @override Future> runNotifierBuild( - covariant GenericClass notifier, + covariant GenericClass notifier, ) { return notifier.build(); } diff --git a/packages/riverpod_generator/test/integration/stream.dart b/packages/riverpod_generator/test/integration/stream.dart index cf90f00bd..b7b5a6608 100644 --- a/packages/riverpod_generator/test/integration/stream.dart +++ b/packages/riverpod_generator/test/integration/stream.dart @@ -8,7 +8,7 @@ Stream> generic(GenericRef ref) async* { } @riverpod -class GenericClass extends _$GenericClass { +class GenericClass extends _$GenericClass { @override Stream> build() async* { yield []; diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 26f905230..592be32e5 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -29,7 +29,7 @@ class _SystemHash { } } -typedef GenericRef = AutoDisposeStreamProviderRef>; +typedef GenericRef = AutoDisposeStreamProviderRef>; /// See also [generic]. @ProviderFor(generic) @@ -41,13 +41,13 @@ class GenericFamily extends Family { const GenericFamily(); /// See also [generic]. - GenericProvider call() { - return GenericProvider(); + GenericProvider call() { + return GenericProvider(); } @override - GenericProvider getProviderOverride( - covariant GenericProvider provider, + GenericProvider getProviderOverride( + covariant GenericProvider provider, ) { return call(); } @@ -68,11 +68,12 @@ class GenericFamily extends Family { } /// See also [generic]. -class GenericProvider extends AutoDisposeStreamProvider> { +class GenericProvider + extends AutoDisposeStreamProvider> { /// See also [generic]. GenericProvider() : super.internal( - (ref) => generic( + (ref) => generic( ref, ), from: genericProvider, @@ -87,12 +88,13 @@ class GenericProvider extends AutoDisposeStreamProvider> { @override bool operator ==(Object other) { - return other is GenericProvider; + return other is GenericProvider && other.runtimeType == runtimeType; } @override int get hashCode { var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, T.hashCode); return _SystemHash.finish(hash); } @@ -240,9 +242,9 @@ class FamilyProvider extends AutoDisposeStreamProvider { } } -String _$genericClassHash() => r'3769bc659154cb464c07beb57d6f8409c849fb97'; +String _$genericClassHash() => r'401ae1cfd97a4291dfd135a69ff8e1c436866e5a'; -abstract class _$GenericClass +abstract class _$GenericClass extends BuildlessAutoDisposeStreamNotifier> { Stream> build(); } @@ -257,13 +259,13 @@ class GenericClassFamily extends Family { const GenericClassFamily(); /// See also [GenericClass]. - GenericClassProvider call() { - return GenericClassProvider(); + GenericClassProvider call() { + return GenericClassProvider(); } @override - GenericClassProvider getProviderOverride( - covariant GenericClassProvider provider, + GenericClassProvider getProviderOverride( + covariant GenericClassProvider provider, ) { return call(); } @@ -284,12 +286,12 @@ class GenericClassFamily extends Family { } /// See also [GenericClass]. -class GenericClassProvider - extends AutoDisposeStreamNotifierProviderImpl> { +class GenericClassProvider + extends AutoDisposeStreamNotifierProviderImpl, List> { /// See also [GenericClass]. GenericClassProvider() : super.internal( - () => GenericClass(), + GenericClass.new, from: genericClassProvider, name: r'genericClassProvider', debugGetCreateSourceHash: @@ -303,19 +305,20 @@ class GenericClassProvider @override bool operator ==(Object other) { - return other is GenericClassProvider; + return other is GenericClassProvider && other.runtimeType == runtimeType; } @override int get hashCode { var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, T.hashCode); return _SystemHash.finish(hash); } @override Stream> runNotifierBuild( - covariant GenericClass notifier, + covariant GenericClass notifier, ) { return notifier.build(); } diff --git a/packages/riverpod_generator/test/integration/sync.dart b/packages/riverpod_generator/test/integration/sync.dart index b2f6a3b9d..a5ed1929f 100644 --- a/packages/riverpod_generator/test/integration/sync.dart +++ b/packages/riverpod_generator/test/integration/sync.dart @@ -4,11 +4,24 @@ part 'sync.g.dart'; @riverpod List generic(GenericRef ref) { + return [ + 'Hello world', + 42, + 3.14, + ].whereType().toList(); +} + +@riverpod +List complexGeneric( + ComplexGenericRef ref, { + required T param, + Foo? otherParam, +}) { return []; } @riverpod -class GenericClass extends _$GenericClass { +class GenericClass extends _$GenericClass { @override List build() { return []; diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 6229bee44..85f123e1a 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -29,7 +29,7 @@ class _SystemHash { } } -typedef GenericRef = AutoDisposeProviderRef>; +typedef GenericRef = AutoDisposeProviderRef>; /// See also [generic]. @ProviderFor(generic) @@ -41,13 +41,13 @@ class GenericFamily extends Family { const GenericFamily(); /// See also [generic]. - GenericProvider call() { - return GenericProvider(); + GenericProvider call() { + return GenericProvider(); } @override - GenericProvider getProviderOverride( - covariant GenericProvider provider, + GenericProvider getProviderOverride( + covariant GenericProvider provider, ) { return call(); } @@ -68,11 +68,11 @@ class GenericFamily extends Family { } /// See also [generic]. -class GenericProvider extends AutoDisposeProvider> { +class GenericProvider extends AutoDisposeProvider> { /// See also [generic]. GenericProvider() : super.internal( - (ref) => generic( + (ref) => generic( ref, ), from: genericProvider, @@ -87,12 +87,109 @@ class GenericProvider extends AutoDisposeProvider> { @override bool operator ==(Object other) { - return other is GenericProvider; + return other is GenericProvider && other.runtimeType == runtimeType; } @override int get hashCode { var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, T.hashCode); + + return _SystemHash.finish(hash); + } +} + +String _$complexGenericHash() => r'a5254e5552cd61bb8d65c018539ff2d8edfd5822'; +typedef ComplexGenericRef + = AutoDisposeProviderRef>; + +/// See also [complexGeneric]. +@ProviderFor(complexGeneric) +const complexGenericProvider = ComplexGenericFamily(); + +/// See also [complexGeneric]. +class ComplexGenericFamily extends Family { + /// See also [complexGeneric]. + const ComplexGenericFamily(); + + /// See also [complexGeneric]. + ComplexGenericProvider call({ + required T param, + Foo? otherParam, + }) { + return ComplexGenericProvider( + param: param, + otherParam: otherParam, + ); + } + + @override + ComplexGenericProvider getProviderOverride( + covariant ComplexGenericProvider provider, + ) { + return call( + param: provider.param, + otherParam: provider.otherParam, + ); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'complexGenericProvider'; +} + +/// See also [complexGeneric]. +class ComplexGenericProvider + extends AutoDisposeProvider> { + /// See also [complexGeneric]. + ComplexGenericProvider({ + required this.param, + this.otherParam, + }) : super.internal( + (ref) => complexGeneric( + ref, + param: param, + otherParam: otherParam, + ), + from: complexGenericProvider, + name: r'complexGenericProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$complexGenericHash, + dependencies: ComplexGenericFamily._dependencies, + allTransitiveDependencies: + ComplexGenericFamily._allTransitiveDependencies, + ); + + final T param; + final Foo? otherParam; + + @override + bool operator ==(Object other) { + return other is ComplexGenericProvider && + other.runtimeType == runtimeType && + other.param == param && + other.otherParam == otherParam; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, param.hashCode); + hash = _SystemHash.combine(hash, otherParam.hashCode); + hash = _SystemHash.combine(hash, T.hashCode); + hash = _SystemHash.combine(hash, Foo.hashCode); return _SystemHash.finish(hash); } @@ -475,9 +572,10 @@ final generatedProvider = AutoDisposeProvider.internal( ); typedef GeneratedRef = AutoDisposeProviderRef; -String _$genericClassHash() => r'5a3dcf57f724f9c16ef52b4d86d767ac65175cf7'; +String _$genericClassHash() => r'671e348a5abf8e00ab06c5f247defbca8af9677b'; -abstract class _$GenericClass extends BuildlessAutoDisposeNotifier> { +abstract class _$GenericClass + extends BuildlessAutoDisposeNotifier> { List build(); } @@ -491,13 +589,13 @@ class GenericClassFamily extends Family { const GenericClassFamily(); /// See also [GenericClass]. - GenericClassProvider call() { - return GenericClassProvider(); + GenericClassProvider call() { + return GenericClassProvider(); } @override - GenericClassProvider getProviderOverride( - covariant GenericClassProvider provider, + GenericClassProvider getProviderOverride( + covariant GenericClassProvider provider, ) { return call(); } @@ -518,12 +616,12 @@ class GenericClassFamily extends Family { } /// See also [GenericClass]. -class GenericClassProvider - extends AutoDisposeNotifierProviderImpl> { +class GenericClassProvider + extends AutoDisposeNotifierProviderImpl, List> { /// See also [GenericClass]. GenericClassProvider() : super.internal( - () => GenericClass(), + GenericClass.new, from: genericClassProvider, name: r'genericClassProvider', debugGetCreateSourceHash: @@ -537,19 +635,20 @@ class GenericClassProvider @override bool operator ==(Object other) { - return other is GenericClassProvider; + return other is GenericClassProvider && other.runtimeType == runtimeType; } @override int get hashCode { var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, T.hashCode); return _SystemHash.finish(hash); } @override List runNotifierBuild( - covariant GenericClass notifier, + covariant GenericClass notifier, ) { return notifier.build(); } diff --git a/packages/riverpod_generator/test/sync_test.dart b/packages/riverpod_generator/test/sync_test.dart index 2e1f5399e..04dfaa688 100644 --- a/packages/riverpod_generator/test/sync_test.dart +++ b/packages/riverpod_generator/test/sync_test.dart @@ -9,6 +9,71 @@ import 'utils.dart'; void main() { // TODO test that the generated providers contain the docs from the annotated element + group('Supports generics', () { + test('checks generics in hashCode', () { + expect( + genericProvider().hashCode, + genericProvider().hashCode, + ); + expect( + genericProvider().hashCode, + isNot(genericProvider().hashCode), + ); + expect( + genericProvider().hashCode, + isNot(genericProvider().hashCode), + ); + expect( + genericProvider().hashCode, + isNot(genericProvider().hashCode), + ); + expect( + genericProvider().hashCode, + genericProvider().hashCode, + ); + }); + + test('checks generics in ==', () { + expect( + genericProvider(), + genericProvider(), + ); + expect( + genericProvider(), + isNot(genericProvider()), + ); + expect( + genericProvider(), + isNot(genericProvider()), + ); + expect( + genericProvider(), + isNot(genericProvider()), + ); + expect( + genericProvider(), + genericProvider(), + ); + }); + + test('in simple scenarios', () { + final container = createContainer(); + + expect( + container.listen(genericProvider(), (p, n) {}).read(), + [42], + ); + expect( + container.listen(genericProvider(), (p, n) {}).read(), + [3.14], + ); + expect( + container.listen(genericProvider(), (p, n) {}).read(), + [42, 3.14], + ); + }); + }); + test('Supports Raw', () async { final container = createContainer(); diff --git a/packages/riverpod_graph/test/integration/consumer_widget/golden/lib/main.dart b/packages/riverpod_graph/test/integration/consumer_widget/golden/lib/main.dart index ebacab1e0..5f86352e3 100644 --- a/packages/riverpod_graph/test/integration/consumer_widget/golden/lib/main.dart +++ b/packages/riverpod_graph/test/integration/consumer_widget/golden/lib/main.dart @@ -7,7 +7,7 @@ final counterProvider = StateProvider((ref) => 0); /// Counter widget. class CounterWidget extends ConsumerWidget { /// Counter widget. - const CounterWidget({Key? key}) : super(key: key); + const CounterWidget({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index da79abf9a..3f6a0f67d 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -1,3 +1,8 @@ +## Unreleased minor + +- Updated `stateless_ref` and `generator_class_extends` to support providers + with generic parameters. + ## 1.3.1 - 2023-04-24 - `riverpod` upgraded to `2.3.6` diff --git a/packages/riverpod_lint/lib/src/assists/stateful_to_stateless_provider.dart b/packages/riverpod_lint/lib/src/assists/stateful_to_stateless_provider.dart index 4edace94e..efbbc29af 100644 --- a/packages/riverpod_lint/lib/src/assists/stateful_to_stateless_provider.dart +++ b/packages/riverpod_lint/lib/src/assists/stateful_to_stateless_provider.dart @@ -50,12 +50,28 @@ class StatefulToStatelessProvider extends RiverpodAssist { declaration.node.name.lexeme.lowerFirst, ); + var typeParametersSource = ''; + final typeParameters = declaration.node.typeParameters; + if (typeParameters != null) { + // Obtain the source of type parameters + typeParametersSource = resolver.source.contents.data.substring( + typeParameters.offset, + typeParameters.end, + ); + + // Make the function generic if the class was generic + builder.addSimpleInsertion( + declaration.buildMethod.name.end, + typeParametersSource, + ); + } + final parameters = declaration.buildMethod.parameters!; final trailingRefParameter = parameters.parameters.isEmpty ? '' : ', '; // Add ref parameter to the build method builder.addSimpleInsertion( parameters.leftParenthesis.end, - '${refNameFor(declaration)} ref$trailingRefParameter', + '${refNameFor(declaration)}$typeParametersSource ref$trailingRefParameter', ); // Remove anything after the build method diff --git a/packages/riverpod_lint/lib/src/assists/stateless_to_stateful_provider.dart b/packages/riverpod_lint/lib/src/assists/stateless_to_stateful_provider.dart index e6b168ba2..22bb43109 100644 --- a/packages/riverpod_lint/lib/src/assists/stateless_to_stateful_provider.dart +++ b/packages/riverpod_lint/lib/src/assists/stateless_to_stateful_provider.dart @@ -33,11 +33,24 @@ class StatelessToStatefulProvider extends RiverpodAssist { ); changeBuilder.addDartFileEdit((builder) { + var typeParametersSource = ''; + final typeParameters = + declaration.node.functionExpression.typeParameters; + if (typeParameters != null) { + // Remove type arguments, if any + builder.addDeletion(typeParameters.sourceRange); + + typeParametersSource = resolver.source.contents.data.substring( + typeParameters.offset, + typeParameters.end, + ); + } + // Add the class name builder.addSimpleInsertion( functionStartOffset, ''' -class ${classNameFor(declaration)} extends ${generatedClassNameFor(declaration)} { +class ${classNameFor(declaration)}$typeParametersSource extends ${generatedClassNameFor(declaration)}$typeParametersSource { @override ''', ); diff --git a/packages/riverpod_lint/lib/src/lints/generator_class_extends.dart b/packages/riverpod_lint/lib/src/lints/generator_class_extends.dart index 6d6e9a83e..a5f8d0509 100644 --- a/packages/riverpod_lint/lib/src/lints/generator_class_extends.dart +++ b/packages/riverpod_lint/lib/src/lints/generator_class_extends.dart @@ -1,3 +1,4 @@ +import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/error/error.dart'; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; @@ -9,6 +10,43 @@ String _generatedClassName(ProviderDeclaration declaration) { return '_\$${declaration.name.lexeme.public}'; } +/// Check that a generic type definition matches with a generic type usage. +/// +/// This is a strict check based on names, such that `` will +/// match with `` but not `` or `` or cases with extra/fewer +/// type arguments. +bool areGenericTypeArgumentsMatching( + List expectedTypeArguments, + List actualTypeArguments, +) { + // Are type arguments specified in the correct order? + var i = 0; + for (; + i < expectedTypeArguments.length && i < actualTypeArguments.length; + i++) { + final expectedType = expectedTypeArguments[i].name.lexeme; + final actualType = actualTypeArguments[i].toSource(); + + if (expectedType != actualType) { + return false; + } + } + + // Is a type argument missing? + if (i != expectedTypeArguments.length || i != actualTypeArguments.length) { + return false; + } + + return true; +} + +/// Convert a [TypeParameterList] to a string. +String genericsDisplayStringFor(TypeParameterList? typeParameters) { + if (typeParameters == null) return ''; + + return '<${typeParameters.typeParameters.map((e) => e.name).join(', ')}>'; +} + class GeneratorClassExtends extends RiverpodLintRule { const GeneratorClassExtends() : super(code: _code); @@ -38,6 +76,21 @@ class GeneratorClassExtends extends RiverpodLintRule { reporter.reportErrorForNode(_code, extendsClause.superclass); return; } + + final expectedTypeArguments = + declaration.node.typeParameters?.typeParameters ?? + const []; + final actualTypeArguments = + extendsClause.superclass.typeArguments?.arguments ?? + const []; + if (!areGenericTypeArgumentsMatching( + expectedTypeArguments, + actualTypeArguments, + )) { + // No type specified. Underlining the ref name + reporter.reportErrorForNode(_code, extendsClause.superclass); + return; + } }); } @@ -60,10 +113,15 @@ class GeneratorClassExtendsFix extends RiverpodFix { return; } + final expectedGenerics = genericsDisplayStringFor( + declaration.node.typeParameters, + ); final expectedClassName = _generatedClassName(declaration); + final expectedExtends = '$expectedClassName$expectedGenerics'; + final extendsClause = declaration.node.extendsClause; final changeBuilder = reporter.createChangeBuilder( - message: 'Extend $expectedClassName', + message: 'Extend $expectedExtends', priority: 90, ); @@ -72,7 +130,7 @@ class GeneratorClassExtendsFix extends RiverpodFix { // No "extends" clause builder.addSimpleInsertion( declaration.name.end, - ' extends $expectedClassName', + ' extends $expectedExtends', ); return; } @@ -80,7 +138,7 @@ class GeneratorClassExtendsFix extends RiverpodFix { // There is an "extends" clause but the extended type is wrong builder.addSimpleReplacement( extendsClause.superclass.sourceRange, - expectedClassName, + expectedExtends, ); }); }); diff --git a/packages/riverpod_lint/lib/src/lints/stateless_ref.dart b/packages/riverpod_lint/lib/src/lints/stateless_ref.dart index cc4d4f9a6..32dc05a0f 100644 --- a/packages/riverpod_lint/lib/src/lints/stateless_ref.dart +++ b/packages/riverpod_lint/lib/src/lints/stateless_ref.dart @@ -5,6 +5,7 @@ import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import '../riverpod_custom_lint.dart'; +import 'generator_class_extends.dart'; class StatelessRef extends RiverpodLintRule { const StatelessRef() : super(code: _code); @@ -48,6 +49,26 @@ class StatelessRef extends RiverpodLintRule { if (refNodeType.beginToken.lexeme != expectedRefName) { reporter.reportErrorForNode(_code, refNodeType); } + + final expectedTypeArguments = + declaration.node.functionExpression.typeParameters?.typeParameters ?? + const []; + + final currentRefType = refNode.type; + if (currentRefType is! NamedType) { + reporter.reportErrorForNode(_code, refNodeType); + return; + } + final actualTypeArguments = + currentRefType.typeArguments?.arguments ?? const []; + + if (!areGenericTypeArgumentsMatching( + expectedTypeArguments, + actualTypeArguments, + )) { + reporter.reportErrorForNode(_code, refNodeType); + return; + } }); } @@ -70,7 +91,11 @@ class StatelessRefFix extends RiverpodFix { return; } - final expectedRefType = refNameFor(declaration); + final expectedGenerics = genericsDisplayStringFor( + declaration.node.functionExpression.typeParameters, + ); + final expectedRefType = '${refNameFor(declaration)}$expectedGenerics'; + final refNode = declaration .node.functionExpression.parameters!.parameters.firstOrNull; if (refNode == null) { diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.dart index a2004fa10..2d0ea9566 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.dart @@ -18,3 +18,9 @@ class StatefulFamily extends _$StatefulFamily { return 0; } } + +@riverpod +class Generic extends _$Generic { + @override + int build() => 0; +} diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.g.dart index c5c945bdb..0954dd796 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.g.dart @@ -161,4 +161,85 @@ class StatefulFamilyProvider ); } } + +String _$genericHash() => r'0a3792d7b59723aebd92715eef2c74d2f267cbd2'; + +abstract class _$Generic extends BuildlessAutoDisposeNotifier { + int build(); +} + +/// See also [Generic]. +@ProviderFor(Generic) +const genericProvider = GenericFamily(); + +/// See also [Generic]. +class GenericFamily extends Family { + /// See also [Generic]. + const GenericFamily(); + + /// See also [Generic]. + GenericProvider call() { + return GenericProvider(); + } + + @override + GenericProvider getProviderOverride( + covariant GenericProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericProvider'; +} + +/// See also [Generic]. +class GenericProvider + extends AutoDisposeNotifierProviderImpl, int> { + /// See also [Generic]. + GenericProvider() + : super.internal( + Generic.new, + from: genericProvider, + name: r'genericProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericHash, + dependencies: GenericFamily._dependencies, + allTransitiveDependencies: GenericFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is GenericProvider && other.runtimeType == runtimeType; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, A.hashCode); + hash = _SystemHash.combine(hash, B.hashCode); + + return _SystemHash.finish(hash); + } + + @override + int runNotifierBuild( + covariant Generic notifier, + ) { + return notifier.build(); + } +} // ignore_for_file: unnecessary_raw_strings, subtype_of_sealed_class, invalid_use_of_internal_member, do_not_use_environment, prefer_const_constructors, public_member_api_docs, avoid_private_typedef_functions diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.json b/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.json index 2ec6083fd..7c50eb64c 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.json +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless.json @@ -1 +1 @@ -[{"priority":100,"change":{"message":"Convert to stateless provider","edits":[{"fileStamp":0,"edits":[{"offset":213,"length":2,"replacement":""},{"offset":206,"length":0,"replacement":"StatefulRef ref"},{"offset":200,"length":5,"replacement":"stateful"},{"offset":146,"length":50,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to stateless provider","edits":[{"fileStamp":0,"edits":[{"offset":213,"length":2,"replacement":""},{"offset":206,"length":0,"replacement":"StatefulRef ref"},{"offset":200,"length":5,"replacement":"stateful"},{"offset":146,"length":50,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to stateless provider","edits":[{"fileStamp":0,"edits":[{"offset":213,"length":2,"replacement":""},{"offset":206,"length":0,"replacement":"StatefulRef ref"},{"offset":200,"length":5,"replacement":"stateful"},{"offset":146,"length":50,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to stateless provider","edits":[{"fileStamp":0,"edits":[{"offset":213,"length":2,"replacement":""},{"offset":206,"length":0,"replacement":"StatefulRef ref"},{"offset":200,"length":5,"replacement":"stateful"},{"offset":146,"length":50,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to stateless provider","edits":[{"fileStamp":0,"edits":[{"offset":389,"length":2,"replacement":""},{"offset":316,"length":0,"replacement":"StatefulFamilyRef ref, "},{"offset":310,"length":5,"replacement":"statefulFamily"},{"offset":244,"length":62,"replacement":""}]}],"linkedEditGroups":[]}}] \ No newline at end of file +[{"priority":100,"change":{"message":"Convert to stateless provider","edits":[{"fileStamp":0,"edits":[{"offset":213,"length":2,"replacement":""},{"offset":206,"length":0,"replacement":"StatefulRef ref"},{"offset":200,"length":5,"replacement":"stateful"},{"offset":146,"length":50,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to stateless provider","edits":[{"fileStamp":0,"edits":[{"offset":213,"length":2,"replacement":""},{"offset":206,"length":0,"replacement":"StatefulRef ref"},{"offset":200,"length":5,"replacement":"stateful"},{"offset":146,"length":50,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to stateless provider","edits":[{"fileStamp":0,"edits":[{"offset":213,"length":2,"replacement":""},{"offset":206,"length":0,"replacement":"StatefulRef ref"},{"offset":200,"length":5,"replacement":"stateful"},{"offset":146,"length":50,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to stateless provider","edits":[{"fileStamp":0,"edits":[{"offset":213,"length":2,"replacement":""},{"offset":206,"length":0,"replacement":"StatefulRef ref"},{"offset":200,"length":5,"replacement":"stateful"},{"offset":146,"length":50,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to stateless provider","edits":[{"fileStamp":0,"edits":[{"offset":389,"length":2,"replacement":""},{"offset":316,"length":0,"replacement":"StatefulFamilyRef ref, "},{"offset":310,"length":5,"replacement":"statefulFamily"},{"offset":244,"length":62,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to stateless provider","edits":[{"fileStamp":0,"edits":[{"offset":494,"length":2,"replacement":""},{"offset":487,"length":0,"replacement":"GenericRef ref"},{"offset":486,"length":0,"replacement":""},{"offset":481,"length":5,"replacement":"generic"},{"offset":403,"length":74,"replacement":""}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless_test.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless_test.dart index d588976da..e3466a148 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_stateful_provider_to_stateless_test.dart @@ -28,6 +28,7 @@ void main() { ...await assist.testRun(result, const SourceRange(174, 0)), ...await assist.testRun(result, const SourceRange(190, 0)), ...await assist.testRun(result, const SourceRange(258, 0)), + ...await assist.testRun(result, const SourceRange(412, 0)), ]; }, ); diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.dart index d40864631..ce798a0f2 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.dart @@ -12,3 +12,6 @@ int statelessFamily(StatelessFamilyRef ref, {required int a, String b = '42'}) { // Hello world return 0; } + +@riverpod +int generic(GenericRef ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.g.dart index 168a9f1b9..90c504c25 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.g.dart @@ -144,4 +144,76 @@ class StatelessFamilyProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } } + +String _$genericHash() => r'd31aaf9c8c291a44a486f914abfe94c420d48502'; +typedef GenericRef = AutoDisposeProviderRef; + +/// See also [generic]. +@ProviderFor(generic) +const genericProvider = GenericFamily(); + +/// See also [generic]. +class GenericFamily extends Family { + /// See also [generic]. + const GenericFamily(); + + /// See also [generic]. + GenericProvider call() { + return GenericProvider(); + } + + @override + GenericProvider getProviderOverride( + covariant GenericProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericProvider'; +} + +/// See also [generic]. +class GenericProvider extends AutoDisposeProvider { + /// See also [generic]. + GenericProvider() + : super.internal( + (ref) => generic( + ref, + ), + from: genericProvider, + name: r'genericProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericHash, + dependencies: GenericFamily._dependencies, + allTransitiveDependencies: GenericFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is GenericProvider && other.runtimeType == runtimeType; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, A.hashCode); + hash = _SystemHash.combine(hash, B.hashCode); + + return _SystemHash.finish(hash); + } +} // ignore_for_file: unnecessary_raw_strings, subtype_of_sealed_class, invalid_use_of_internal_member, do_not_use_environment, prefer_const_constructors, public_member_api_docs, avoid_private_typedef_functions diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.json b/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.json index 36bfc061d..c11f417d0 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.json +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful.json @@ -1 +1 @@ -[{"priority":100,"change":{"message":"Convert to stateful provider","edits":[{"fileStamp":0,"edits":[{"offset":183,"length":0,"replacement":"\n}"},{"offset":160,"length":16,"replacement":""},{"offset":150,"length":9,"replacement":"build"},{"offset":146,"length":0,"replacement":"class Stateless extends _$Stateless {\n @override\n "}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to stateful provider","edits":[{"fileStamp":0,"edits":[{"offset":183,"length":0,"replacement":"\n}"},{"offset":160,"length":16,"replacement":""},{"offset":150,"length":9,"replacement":"build"},{"offset":146,"length":0,"replacement":"class Stateless extends _$Stateless {\n @override\n "}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to stateful provider","edits":[{"fileStamp":0,"edits":[{"offset":323,"length":0,"replacement":"\n}"},{"offset":232,"length":24,"replacement":""},{"offset":216,"length":15,"replacement":"build"},{"offset":212,"length":0,"replacement":"class StatelessFamily extends _$StatelessFamily {\n @override\n "}]}],"linkedEditGroups":[]}}] \ No newline at end of file +[{"priority":100,"change":{"message":"Convert to stateful provider","edits":[{"fileStamp":0,"edits":[{"offset":183,"length":0,"replacement":"\n}"},{"offset":160,"length":16,"replacement":""},{"offset":150,"length":9,"replacement":"build"},{"offset":146,"length":0,"replacement":"class Stateless extends _$Stateless {\n @override\n "}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to stateful provider","edits":[{"fileStamp":0,"edits":[{"offset":183,"length":0,"replacement":"\n}"},{"offset":160,"length":16,"replacement":""},{"offset":150,"length":9,"replacement":"build"},{"offset":146,"length":0,"replacement":"class Stateless extends _$Stateless {\n @override\n "}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to stateful provider","edits":[{"fileStamp":0,"edits":[{"offset":323,"length":0,"replacement":"\n}"},{"offset":232,"length":24,"replacement":""},{"offset":216,"length":15,"replacement":"build"},{"offset":212,"length":0,"replacement":"class StatelessFamily extends _$StatelessFamily {\n @override\n "}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to stateful provider","edits":[{"fileStamp":0,"edits":[{"offset":394,"length":0,"replacement":"\n}"},{"offset":367,"length":20,"replacement":""},{"offset":346,"length":20,"replacement":""},{"offset":339,"length":7,"replacement":"build"},{"offset":335,"length":0,"replacement":"class Generic extends _$Generic {\n @override\n "}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful_test.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful_test.dart index fd517d9aa..ba5f203a4 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_stateless_provider_to_stateful_test.dart @@ -27,6 +27,7 @@ void main() { ...await assist.testRun(result, const SourceRange(167, 0)), ...await assist.testRun(result, const SourceRange(180, 0)), ...await assist.testRun(result, const SourceRange(224, 0)), + ...await assist.testRun(result, const SourceRange(342, 0)), ]; }, ); diff --git a/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends.dart b/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends.dart index 6fac9cef6..592933ad2 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends.dart +++ b/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends.dart @@ -2,6 +2,8 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'generator_class_extends.g.dart'; +// ignore_for_file: wrong_number_of_type_arguments + @riverpod class MyNotifier extends _$MyNotifier { int build() => 0; @@ -25,3 +27,26 @@ class _PrivateClass extends _$PrivateClass { @override String build() => 'Hello World!'; } + +@riverpod +class Generics extends _$Generics { + int build() => 0; +} + +@riverpod +// expect_lint: generator_class_extends +class NoGenerics extends _$NoGenerics { + int build() => 0; +} + +@riverpod +// expect_lint: generator_class_extends +class MissingGenerics extends _$MissingGenerics { + int build() => 0; +} + +@riverpod +// expect_lint: generator_class_extends +class WrongOrder extends _$WrongOrder { + int build() => 0; +} diff --git a/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends.g.dart b/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends.g.dart index c44f3a8c7..fef4f34ac 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends.g.dart @@ -65,4 +65,354 @@ final _privateClassProvider = ); typedef _$PrivateClass = AutoDisposeNotifier; +String _$genericsHash() => r'0a1bf00e0610ccb1fb5615460e1bc4afb2555f69'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +abstract class _$Generics + extends BuildlessAutoDisposeNotifier { + int build(); +} + +/// See also [Generics]. +@ProviderFor(Generics) +const genericsProvider = GenericsFamily(); + +/// See also [Generics]. +class GenericsFamily extends Family { + /// See also [Generics]. + const GenericsFamily(); + + /// See also [Generics]. + GenericsProvider call() { + return GenericsProvider(); + } + + @override + GenericsProvider getProviderOverride( + covariant GenericsProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericsProvider'; +} + +/// See also [Generics]. +class GenericsProvider + extends AutoDisposeNotifierProviderImpl, int> { + /// See also [Generics]. + GenericsProvider() + : super.internal( + Generics.new, + from: genericsProvider, + name: r'genericsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericsHash, + dependencies: GenericsFamily._dependencies, + allTransitiveDependencies: GenericsFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is GenericsProvider && other.runtimeType == runtimeType; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, A.hashCode); + hash = _SystemHash.combine(hash, B.hashCode); + + return _SystemHash.finish(hash); + } + + @override + int runNotifierBuild( + covariant Generics notifier, + ) { + return notifier.build(); + } +} + +String _$noGenericsHash() => r'30d5d20092f43cb17ede1f619773757df7cecb30'; + +abstract class _$NoGenerics + extends BuildlessAutoDisposeNotifier { + int build(); +} + +/// See also [NoGenerics]. +@ProviderFor(NoGenerics) +const noGenericsProvider = NoGenericsFamily(); + +/// See also [NoGenerics]. +class NoGenericsFamily extends Family { + /// See also [NoGenerics]. + const NoGenericsFamily(); + + /// See also [NoGenerics]. + NoGenericsProvider call() { + return NoGenericsProvider(); + } + + @override + NoGenericsProvider getProviderOverride( + covariant NoGenericsProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'noGenericsProvider'; +} + +/// See also [NoGenerics]. +class NoGenericsProvider + extends AutoDisposeNotifierProviderImpl, int> { + /// See also [NoGenerics]. + NoGenericsProvider() + : super.internal( + NoGenerics.new, + from: noGenericsProvider, + name: r'noGenericsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$noGenericsHash, + dependencies: NoGenericsFamily._dependencies, + allTransitiveDependencies: + NoGenericsFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is NoGenericsProvider && other.runtimeType == runtimeType; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, A.hashCode); + hash = _SystemHash.combine(hash, B.hashCode); + + return _SystemHash.finish(hash); + } + + @override + int runNotifierBuild( + covariant NoGenerics notifier, + ) { + return notifier.build(); + } +} + +String _$missingGenericsHash() => r'b611c76d5fb87fdde78b5fc017912e0569762c23'; + +abstract class _$MissingGenerics + extends BuildlessAutoDisposeNotifier { + int build(); +} + +/// See also [MissingGenerics]. +@ProviderFor(MissingGenerics) +const missingGenericsProvider = MissingGenericsFamily(); + +/// See also [MissingGenerics]. +class MissingGenericsFamily extends Family { + /// See also [MissingGenerics]. + const MissingGenericsFamily(); + + /// See also [MissingGenerics]. + MissingGenericsProvider call() { + return MissingGenericsProvider(); + } + + @override + MissingGenericsProvider getProviderOverride( + covariant MissingGenericsProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'missingGenericsProvider'; +} + +/// See also [MissingGenerics]. +class MissingGenericsProvider + extends AutoDisposeNotifierProviderImpl, int> { + /// See also [MissingGenerics]. + MissingGenericsProvider() + : super.internal( + MissingGenerics.new, + from: missingGenericsProvider, + name: r'missingGenericsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$missingGenericsHash, + dependencies: MissingGenericsFamily._dependencies, + allTransitiveDependencies: + MissingGenericsFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is MissingGenericsProvider && other.runtimeType == runtimeType; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, A.hashCode); + hash = _SystemHash.combine(hash, B.hashCode); + + return _SystemHash.finish(hash); + } + + @override + int runNotifierBuild( + covariant MissingGenerics notifier, + ) { + return notifier.build(); + } +} + +String _$wrongOrderHash() => r'7757670a2f67406ebc96c87edf088deb9cb248a1'; + +abstract class _$WrongOrder extends BuildlessAutoDisposeNotifier { + int build(); +} + +/// See also [WrongOrder]. +@ProviderFor(WrongOrder) +const wrongOrderProvider = WrongOrderFamily(); + +/// See also [WrongOrder]. +class WrongOrderFamily extends Family { + /// See also [WrongOrder]. + const WrongOrderFamily(); + + /// See also [WrongOrder]. + WrongOrderProvider call() { + return WrongOrderProvider(); + } + + @override + WrongOrderProvider getProviderOverride( + covariant WrongOrderProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'wrongOrderProvider'; +} + +/// See also [WrongOrder]. +class WrongOrderProvider + extends AutoDisposeNotifierProviderImpl, int> { + /// See also [WrongOrder]. + WrongOrderProvider() + : super.internal( + WrongOrder.new, + from: wrongOrderProvider, + name: r'wrongOrderProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$wrongOrderHash, + dependencies: WrongOrderFamily._dependencies, + allTransitiveDependencies: + WrongOrderFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is WrongOrderProvider && other.runtimeType == runtimeType; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, A.hashCode); + hash = _SystemHash.combine(hash, B.hashCode); + + return _SystemHash.finish(hash); + } + + @override + int runNotifierBuild( + covariant WrongOrder notifier, + ) { + return notifier.build(); + } +} // ignore_for_file: unnecessary_raw_strings, subtype_of_sealed_class, invalid_use_of_internal_member, do_not_use_environment, prefer_const_constructors, public_member_api_docs, avoid_private_typedef_functions diff --git a/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends.json b/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends.json index 2808c5608..1d6da27a3 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends.json +++ b/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends.json @@ -1 +1 @@ -[{"priority":90,"change":{"message":"Extend _$NoExtends","edits":[{"fileStamp":0,"edits":[{"offset":242,"length":0,"replacement":" extends _$NoExtends"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$WrongExtends","edits":[{"fileStamp":0,"edits":[{"offset":345,"length":18,"replacement":"_$WrongExtends"}]}],"linkedEditGroups":[]}}] \ No newline at end of file +[{"priority":90,"change":{"message":"Extend _$NoExtends","edits":[{"fileStamp":0,"edits":[{"offset":294,"length":0,"replacement":" extends _$NoExtends"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$WrongExtends","edits":[{"fileStamp":0,"edits":[{"offset":397,"length":18,"replacement":"_$WrongExtends"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$NoGenerics","edits":[{"fileStamp":0,"edits":[{"offset":808,"length":12,"replacement":"_$NoGenerics"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$MissingGenerics","edits":[{"fileStamp":0,"edits":[{"offset":932,"length":20,"replacement":"_$MissingGenerics"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$WrongOrder","edits":[{"fileStamp":0,"edits":[{"offset":1059,"length":18,"replacement":"_$WrongOrder"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends_test.dart b/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends_test.dart index 344e7fcab..d2b565cfd 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends_test.dart +++ b/packages/riverpod_lint_flutter_test/test/goldens/generator_class_extends_test.dart @@ -3,6 +3,7 @@ import 'dart:io'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:collection/collection.dart'; import 'package:riverpod_lint/src/lints/generator_class_extends.dart'; +import 'package:riverpod_lint/src/lints/stateless_ref.dart'; import 'package:analyzer/dart/analysis/results.dart'; import 'package:analyzer/dart/analysis/utilities.dart'; import 'package:test/test.dart'; @@ -24,7 +25,29 @@ void main() { result as ResolvedUnitResult; final errors = await lint.testRun(result); - expect(errors, hasLength(2)); + expect(errors, hasLength(5)); + + final changes = await Future.wait([ + for (final error in errors) fix.testRun(result, error, errors), + ]); + + return changes.flattened; + }, + ); + + testGolden( + 'Verify that @riverpod classes extend the generated typedef', + 'goldens/stateless_ref.json', + () async { + final lint = StatelessRef(); + final fix = lint.getFixes().single as DartFix; + final file = File('test/goldens/stateless_ref.dart').absolute; + + final result = await resolveFile2(path: file.path); + result as ResolvedUnitResult; + + final errors = await lint.testRun(result); + expect(errors, hasLength(6)); final changes = await Future.wait([ for (final error in errors) fix.testRun(result, error, errors), diff --git a/packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.dart b/packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.dart index ef4dabdfc..9cda713c5 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.dart +++ b/packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.dart @@ -26,3 +26,18 @@ int incorrectlyTyped( @riverpod external int scoped(); + +@riverpod +int generics(GenericsRef ref) => 0; + +@riverpod +// expect_lint: stateless_ref +int noGenerics(NoGenericsRef ref) => 0; + +@riverpod +// expect_lint: stateless_ref +int missingGenerics(MissingGenericsRef ref) => 0; + +@riverpod +// expect_lint: stateless_ref +int wrongOrder(WrongOrderRef ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.g.dart b/packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.g.dart index 39387d0a5..ca890be94 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.g.dart @@ -66,4 +66,316 @@ final scopedProvider = AutoDisposeProvider.internal( ); typedef ScopedRef = AutoDisposeProviderRef; +String _$genericsHash() => r'b5813cf6a00581bafea48d8ab66f7d5468fff0e4'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +typedef GenericsRef = AutoDisposeProviderRef; + +/// See also [generics]. +@ProviderFor(generics) +const genericsProvider = GenericsFamily(); + +/// See also [generics]. +class GenericsFamily extends Family { + /// See also [generics]. + const GenericsFamily(); + + /// See also [generics]. + GenericsProvider call() { + return GenericsProvider(); + } + + @override + GenericsProvider getProviderOverride( + covariant GenericsProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericsProvider'; +} + +/// See also [generics]. +class GenericsProvider extends AutoDisposeProvider { + /// See also [generics]. + GenericsProvider() + : super.internal( + (ref) => generics( + ref, + ), + from: genericsProvider, + name: r'genericsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericsHash, + dependencies: GenericsFamily._dependencies, + allTransitiveDependencies: GenericsFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is GenericsProvider && other.runtimeType == runtimeType; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, A.hashCode); + hash = _SystemHash.combine(hash, B.hashCode); + + return _SystemHash.finish(hash); + } +} + +String _$noGenericsHash() => r'449264e25990bc14ad811c0940117c8cde4d730a'; +typedef NoGenericsRef = AutoDisposeProviderRef; + +/// See also [noGenerics]. +@ProviderFor(noGenerics) +const noGenericsProvider = NoGenericsFamily(); + +/// See also [noGenerics]. +class NoGenericsFamily extends Family { + /// See also [noGenerics]. + const NoGenericsFamily(); + + /// See also [noGenerics]. + NoGenericsProvider call() { + return NoGenericsProvider(); + } + + @override + NoGenericsProvider getProviderOverride( + covariant NoGenericsProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'noGenericsProvider'; +} + +/// See also [noGenerics]. +class NoGenericsProvider extends AutoDisposeProvider { + /// See also [noGenerics]. + NoGenericsProvider() + : super.internal( + (ref) => noGenerics( + ref, + ), + from: noGenericsProvider, + name: r'noGenericsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$noGenericsHash, + dependencies: NoGenericsFamily._dependencies, + allTransitiveDependencies: + NoGenericsFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is NoGenericsProvider && other.runtimeType == runtimeType; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, A.hashCode); + hash = _SystemHash.combine(hash, B.hashCode); + + return _SystemHash.finish(hash); + } +} + +String _$missingGenericsHash() => r'7d8bc49e4f1e466260fbf6a61a3f9e62b4aef28f'; +typedef MissingGenericsRef = AutoDisposeProviderRef; + +/// See also [missingGenerics]. +@ProviderFor(missingGenerics) +const missingGenericsProvider = MissingGenericsFamily(); + +/// See also [missingGenerics]. +class MissingGenericsFamily extends Family { + /// See also [missingGenerics]. + const MissingGenericsFamily(); + + /// See also [missingGenerics]. + MissingGenericsProvider call() { + return MissingGenericsProvider(); + } + + @override + MissingGenericsProvider getProviderOverride( + covariant MissingGenericsProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'missingGenericsProvider'; +} + +/// See also [missingGenerics]. +class MissingGenericsProvider extends AutoDisposeProvider { + /// See also [missingGenerics]. + MissingGenericsProvider() + : super.internal( + (ref) => missingGenerics( + ref, + ), + from: missingGenericsProvider, + name: r'missingGenericsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$missingGenericsHash, + dependencies: MissingGenericsFamily._dependencies, + allTransitiveDependencies: + MissingGenericsFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is MissingGenericsProvider && other.runtimeType == runtimeType; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, A.hashCode); + hash = _SystemHash.combine(hash, B.hashCode); + + return _SystemHash.finish(hash); + } +} + +String _$wrongOrderHash() => r'6732863e85b220c07f82c2d13be15c1e6f08192d'; +typedef WrongOrderRef = AutoDisposeProviderRef; + +/// See also [wrongOrder]. +@ProviderFor(wrongOrder) +const wrongOrderProvider = WrongOrderFamily(); + +/// See also [wrongOrder]. +class WrongOrderFamily extends Family { + /// See also [wrongOrder]. + const WrongOrderFamily(); + + /// See also [wrongOrder]. + WrongOrderProvider call() { + return WrongOrderProvider(); + } + + @override + WrongOrderProvider getProviderOverride( + covariant WrongOrderProvider provider, + ) { + return call(); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'wrongOrderProvider'; +} + +/// See also [wrongOrder]. +class WrongOrderProvider extends AutoDisposeProvider { + /// See also [wrongOrder]. + WrongOrderProvider() + : super.internal( + (ref) => wrongOrder( + ref, + ), + from: wrongOrderProvider, + name: r'wrongOrderProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$wrongOrderHash, + dependencies: WrongOrderFamily._dependencies, + allTransitiveDependencies: + WrongOrderFamily._allTransitiveDependencies, + ); + + @override + bool operator ==(Object other) { + return other is WrongOrderProvider && other.runtimeType == runtimeType; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, B.hashCode); + hash = _SystemHash.combine(hash, A.hashCode); + + return _SystemHash.finish(hash); + } +} // ignore_for_file: unnecessary_raw_strings, subtype_of_sealed_class, invalid_use_of_internal_member, do_not_use_environment, prefer_const_constructors, public_member_api_docs, avoid_private_typedef_functions diff --git a/packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.json b/packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.json new file mode 100644 index 000000000..2c621377b --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.json @@ -0,0 +1 @@ +[{"priority":90,"change":{"message":"Add ref parameter","edits":[{"fileStamp":0,"edits":[{"offset":146,"length":0,"replacement":"ReflessRef ref"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as NamelessRef","edits":[{"fileStamp":0,"edits":[{"offset":223,"length":0,"replacement":"NamelessRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as IncorrectlyTypedRef","edits":[{"fileStamp":0,"edits":[{"offset":313,"length":4,"replacement":"IncorrectlyTypedRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as NoGenericsRef","edits":[{"fileStamp":0,"edits":[{"offset":519,"length":14,"replacement":"NoGenericsRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as MissingGenericsRef","edits":[{"fileStamp":0,"edits":[{"offset":611,"length":19,"replacement":"MissingGenericsRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as WrongOrderRef","edits":[{"fileStamp":0,"edits":[{"offset":703,"length":14,"replacement":"WrongOrderRef "}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/website/docs/concepts/provider_observer_logger.dart b/website/docs/concepts/provider_observer_logger.dart index d7903659e..40f8120e6 100644 --- a/website/docs/concepts/provider_observer_logger.dart +++ b/website/docs/concepts/provider_observer_logger.dart @@ -32,7 +32,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/docs/concepts/reading_consumer_hook.dart b/website/docs/concepts/reading_consumer_hook.dart index f7f36b8be..6dfd4b024 100644 --- a/website/docs/concepts/reading_consumer_hook.dart +++ b/website/docs/concepts/reading_consumer_hook.dart @@ -7,7 +7,7 @@ import 'reading_counter.dart'; class HomeView extends HookConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/docs/concepts/reading_consumer_hook_widget.dart b/website/docs/concepts/reading_consumer_hook_widget.dart index f0f7aaa30..eb3716806 100644 --- a/website/docs/concepts/reading_consumer_hook_widget.dart +++ b/website/docs/concepts/reading_consumer_hook_widget.dart @@ -8,7 +8,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends HookConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/docs/concepts/reading_consumer_stateful_widget.dart b/website/docs/concepts/reading_consumer_stateful_widget.dart index 0773296a3..5fef555b9 100644 --- a/website/docs/concepts/reading_consumer_stateful_widget.dart +++ b/website/docs/concepts/reading_consumer_stateful_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerStatefulWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override HomeViewState createState() => HomeViewState(); diff --git a/website/docs/concepts/reading_consumer_widget.dart b/website/docs/concepts/reading_consumer_widget.dart index 568e004f4..18b851e55 100644 --- a/website/docs/concepts/reading_consumer_widget.dart +++ b/website/docs/concepts/reading_consumer_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/docs/concepts/reading_listen.dart b/website/docs/concepts/reading_listen.dart index 37121f87c..4ed90e7af 100644 --- a/website/docs/concepts/reading_listen.dart +++ b/website/docs/concepts/reading_listen.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); final anotherProvider = Provider((ref) { ref.listen(counterProvider, (int? previousCount, int newCount) { diff --git a/website/docs/concepts/reading_listen_build.dart b/website/docs/concepts/reading_listen_build.dart index 2449c763e..066565b67 100644 --- a/website/docs/concepts/reading_listen_build.dart +++ b/website/docs/concepts/reading_listen_build.dart @@ -6,10 +6,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/docs/concepts/reading_read.dart b/website/docs/concepts/reading_read.dart index 553c137f3..daf2e5f0f 100644 --- a/website/docs/concepts/reading_read.dart +++ b/website/docs/concepts/reading_read.dart @@ -7,10 +7,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/docs/concepts/reading_stateful_hook_consumer_widget.dart b/website/docs/concepts/reading_stateful_hook_consumer_widget.dart index d1a79e64e..d47189e61 100644 --- a/website/docs/concepts/reading_stateful_hook_consumer_widget.dart +++ b/website/docs/concepts/reading_stateful_hook_consumer_widget.dart @@ -8,7 +8,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends StatefulHookConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override HomeViewState createState() => HomeViewState(); diff --git a/website/docs/concepts/reading_watch_build.dart b/website/docs/concepts/reading_watch_build.dart index af23d3d5d..acade55d7 100644 --- a/website/docs/concepts/reading_watch_build.dart +++ b/website/docs/concepts/reading_watch_build.dart @@ -21,7 +21,7 @@ class TodoList extends StateNotifier> { final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/docs/cookbooks/testing_flutter.dart b/website/docs/cookbooks/testing_flutter.dart index 0fc7580d3..6685a1bdb 100644 --- a/website/docs/cookbooks/testing_flutter.dart +++ b/website/docs/cookbooks/testing_flutter.dart @@ -4,7 +4,7 @@ import 'package:flutter_test/flutter_test.dart'; class MyApp extends StatelessWidget { // ignore: prefer_const_constructors_in_immutables - MyApp({Key? key}) : super(key: key); + MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/docs/cookbooks/testing_full.dart b/website/docs/cookbooks/testing_full.dart index 3f91c575b..0f79b4ee8 100644 --- a/website/docs/cookbooks/testing_full.dart +++ b/website/docs/cookbooks/testing_full.dart @@ -43,7 +43,7 @@ class FakeRepository implements Repository { } class TodoItem extends StatelessWidget { - const TodoItem({Key? key, required this.todo}) : super(key: key); + const TodoItem({super.key, required this.todo}); final Todo todo; @override Widget build(BuildContext context) { diff --git a/website/docs/cookbooks/testing_override_info.dart b/website/docs/cookbooks/testing_override_info.dart index 0a396c8ef..d71ae3c69 100644 --- a/website/docs/cookbooks/testing_override_info.dart +++ b/website/docs/cookbooks/testing_override_info.dart @@ -17,7 +17,7 @@ class Todo { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/docs/providers/change_notifier_provider/todos_consumer.dart b/website/docs/providers/change_notifier_provider/todos_consumer.dart index da889e521..beac13f4e 100644 --- a/website/docs/providers/change_notifier_provider/todos_consumer.dart +++ b/website/docs/providers/change_notifier_provider/todos_consumer.dart @@ -8,7 +8,7 @@ import 'todos.dart'; /* SNIPPET START */ class TodoListView extends ConsumerWidget { - const TodoListView({Key? key}) : super(key: key); + const TodoListView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/docs/providers/provider/optimized_previous_button.dart b/website/docs/providers/provider/optimized_previous_button.dart index 3ec7de654..83223168f 100644 --- a/website/docs/providers/provider/optimized_previous_button.dart +++ b/website/docs/providers/provider/optimized_previous_button.dart @@ -14,7 +14,7 @@ final canGoToPreviousPageProvider = Provider((ref) { }); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}): super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/docs/providers/provider/unoptimized_previous_button.dart b/website/docs/providers/provider/unoptimized_previous_button.dart index c28df14e3..a04b9d65c 100644 --- a/website/docs/providers/provider/unoptimized_previous_button.dart +++ b/website/docs/providers/provider/unoptimized_previous_button.dart @@ -7,7 +7,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final pageIndexProvider = StateProvider((ref) => 0); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}): super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/docs/providers/state_notifier_provider/todos_consumer.dart b/website/docs/providers/state_notifier_provider/todos_consumer.dart index 1b98eb780..8722a542f 100644 --- a/website/docs/providers/state_notifier_provider/todos_consumer.dart +++ b/website/docs/providers/state_notifier_provider/todos_consumer.dart @@ -8,7 +8,7 @@ import 'todos.dart'; /* SNIPPET START */ class TodoListView extends ConsumerWidget { - const TodoListView({Key? key}): super(key: key); + const TodoListView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/docs/providers/state_provider/full.dart b/website/docs/providers/state_provider/full.dart index 74a0c7c72..4c598055f 100644 --- a/website/docs/providers/state_provider/full.dart +++ b/website/docs/providers/state_provider/full.dart @@ -11,7 +11,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { @@ -56,7 +56,7 @@ final productsProvider = Provider>((ref) { }); class MyHomePage extends ConsumerWidget { - const MyHomePage({Key? key}) : super(key: key); + const MyHomePage({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/docs/providers/state_provider/update_read_once.dart b/website/docs/providers/state_provider/update_read_once.dart index 1c99c21ee..825df6d0f 100644 --- a/website/docs/providers/state_provider/update_read_once.dart +++ b/website/docs/providers/state_provider/update_read_once.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/docs/providers/state_provider/update_read_twice.dart b/website/docs/providers/state_provider/update_read_twice.dart index af6d060a8..c029e0730 100644 --- a/website/docs/providers/state_provider/update_read_twice.dart +++ b/website/docs/providers/state_provider/update_read_twice.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index dc80cc762..0d801dbce 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -32,7 +32,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart index c4b2efcc4..8d0ecbafd 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart @@ -6,7 +6,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'reading_counter.dart'; class HomeView extends HookConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart index aded824b7..a7dcff48f 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart @@ -8,7 +8,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends HookConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart index b85c0504f..254e86a9d 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerStatefulWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override HomeViewState createState() => HomeViewState(); diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart index 568e004f4..18b851e55 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index 37121f87c..4ed90e7af 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); final anotherProvider = Provider((ref) { ref.listen(counterProvider, (int? previousCount, int newCount) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 2449c763e..066565b67 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -6,10 +6,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index 6de10d964..91be089df 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -8,10 +8,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ final counterProvider = - StateNotifierProvider((ref) => Counter(ref)); + StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index ac58d040e..bc0c7bdf4 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -21,7 +21,7 @@ class TodoList extends StateNotifier> { final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart index a43c7ce42..36ff78123 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -4,7 +4,7 @@ import 'package:flutter_test/flutter_test.dart'; class MyApp extends StatelessWidget { // ignore: prefer_const_constructors_in_immutables - MyApp({Key? key}) : super(key: key); + MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index dbdcfdbd3..128e211f7 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -42,7 +42,7 @@ class FakeRepository implements Repository { } class TodoItem extends StatelessWidget { - const TodoItem({Key? key, required this.todo}) : super(key: key); + const TodoItem({super.key, required this.todo}); final Todo todo; @override Widget build(BuildContext context) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart index 3ea55f0a6..38a80e15b 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart @@ -17,7 +17,7 @@ class Todo { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index 99616a42d..2848a2a91 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -14,7 +14,7 @@ final canGoToPreviousPageProvider = Provider((ref) { }); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}) : super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index 638b0b438..9ae43a3eb 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -7,7 +7,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final pageIndexProvider = StateProvider((ref) => 0); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}) : super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index 8233438b1..e319dfbed 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -8,7 +8,7 @@ import 'todos.dart'; /* SNIPPET START */ class TodoListView extends ConsumerWidget { - const TodoListView({Key? key}) : super(key: key); + const TodoListView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index d2ea00677..3c59ff2da 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -11,7 +11,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { @@ -56,7 +56,7 @@ final productsProvider = Provider>((ref) { }); class MyHomePage extends ConsumerWidget { - const MyHomePage({Key? key}) : super(key: key); + const MyHomePage({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 1c99c21ee..825df6d0f 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index f7b715b7f..59590fa5b 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index 918a3f54c..238d1eaf8 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -32,7 +32,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart index 54d11e333..6312de226 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart @@ -6,7 +6,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'reading_counter.dart'; class HomeView extends HookConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart index c8ffcf8c7..4480fe7fa 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart @@ -8,7 +8,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends HookConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart index 640971b27..879e2661b 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerStatefulWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override HomeViewState createState() => HomeViewState(); diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart index 70a7d548b..86604fc7b 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index 37121f87c..4ed90e7af 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); final anotherProvider = Provider((ref) { ref.listen(counterProvider, (int? previousCount, int newCount) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 2449c763e..066565b67 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -6,10 +6,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index cb30574b7..1c42dd23f 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -8,10 +8,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ final counterProvider = - StateNotifierProvider((ref) => Counter(ref)); + StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index eb0aaebf0..d7fc059f6 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -21,7 +21,7 @@ class TodoList extends StateNotifier> { final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart index 88fdbefcc..58b425278 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -4,7 +4,7 @@ import 'package:flutter_test/flutter_test.dart'; class MyApp extends StatelessWidget { // ignore: prefer_const_constructors_in_immutables - MyApp({Key? key}) : super(key: key); + MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index 3e9f51e7f..4bfe5b24a 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -43,7 +43,7 @@ class FakeRepository implements Repository { } class TodoItem extends StatelessWidget { - const TodoItem({Key? key, required this.todo}) : super(key: key); + const TodoItem({super.key, required this.todo}); final Todo todo; @override Widget build(BuildContext context) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart index c0541c9b3..19f2e726f 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart @@ -17,7 +17,7 @@ class Todo { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index dbab5f7a2..4e04ebdb7 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -14,7 +14,7 @@ final canGoToPreviousPageProvider = Provider((ref) { }); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}) : super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index d80ddd6f3..99efdd26b 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -7,7 +7,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final pageIndexProvider = StateProvider((ref) => 0); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}) : super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index 2cfabd954..035772e30 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -8,7 +8,7 @@ import 'todos.dart'; /* SNIPPET START */ class TodoListView extends ConsumerWidget { - const TodoListView({Key? key}) : super(key: key); + const TodoListView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 84ed40342..d47fb2427 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -11,7 +11,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { @@ -56,7 +56,7 @@ final productsProvider = Provider>((ref) { }); class MyHomePage extends ConsumerWidget { - const MyHomePage({Key? key}) : super(key: key); + const MyHomePage({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 1c99c21ee..825df6d0f 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index 11ec10463..91b877290 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index 5e7925fd5..1ea8c37e9 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -14,7 +14,7 @@ final canGoToPreviousPageProvider = Provider((ref) { }); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}) : super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index 66726eba1..28a8b3abd 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -7,7 +7,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final pageIndexProvider = StateProvider((ref) => 0); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}) : super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index 97a3acef9..09c82341b 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -8,7 +8,7 @@ import 'todos.dart'; /* SNIPPET START */ class TodoListView extends ConsumerWidget { - const TodoListView({Key? key}): super(key: key); + const TodoListView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 358bc0d07..283d4c4bd 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -11,7 +11,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { @@ -56,7 +56,7 @@ final productsProvider = Provider>((ref) { }); class MyHomePage extends ConsumerWidget { - const MyHomePage({Key? key}) : super(key: key); + const MyHomePage({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 1c99c21ee..825df6d0f 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index 038c8be76..b60695d94 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index 974a0264c..71ccc1557 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -32,7 +32,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart index 38d581c67..10031d23d 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart @@ -6,7 +6,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'reading_counter.dart'; class HomeView extends HookConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart index 1a57537ea..194bec8dc 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart @@ -8,7 +8,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends HookConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart index 1671265f4..a685b7bac 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerStatefulWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override HomeViewState createState() => HomeViewState(); diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart index a5f2d55f4..0970aede5 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index 37121f87c..4ed90e7af 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); final anotherProvider = Provider((ref) { ref.listen(counterProvider, (int? previousCount, int newCount) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 2449c763e..066565b67 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -6,10 +6,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index 45eeb7db0..23a1a9a97 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -7,10 +7,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index dcf2febec..e87b2436b 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -21,7 +21,7 @@ class TodoList extends StateNotifier> { final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart index 6b85441de..600101582 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart @@ -8,7 +8,7 @@ import 'todos.dart'; /* SNIPPET START */ class TodoListView extends ConsumerWidget { - const TodoListView({Key? key}) : super(key: key); + const TodoListView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index 98f248da8..0ca446615 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -15,7 +15,7 @@ final canGoToPreviousPageProvider = Provider((ref) { }); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}): super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index ec01269c4..9a60b44fc 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -7,7 +7,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final pageIndexProvider = StateProvider((ref) => 0); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}): super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index 609279285..016ba782b 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -8,7 +8,7 @@ import 'todos.dart'; /* SNIPPET START */ class TodoListView extends ConsumerWidget { - const TodoListView({Key? key}): super(key: key); + const TodoListView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 64d83e706..bb48b1107 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -11,7 +11,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { @@ -56,7 +56,7 @@ final productsProvider = Provider>((ref) { }); class MyHomePage extends ConsumerWidget { - const MyHomePage({Key? key}) : super(key: key); + const MyHomePage({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 1c99c21ee..825df6d0f 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index 961a891e6..37d6d4a19 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index 769d9025e..fbca504d5 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -33,7 +33,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart index 59a7af0ec..3a99d644d 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart @@ -6,7 +6,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'reading_counter.dart'; class HomeView extends HookConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart index f9866ec6c..2199b694f 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart @@ -8,7 +8,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends HookConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart index 4bbb6c991..bf6aac600 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerStatefulWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override HomeViewState createState() => HomeViewState(); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart index cb3d8de3c..85d64730d 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index 33cb5f845..f6e0d4112 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -8,10 +8,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ final counterProvider = - StateNotifierProvider((ref) => Counter(ref)); + StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart index 4f0c7a165..ad4ef3fdf 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart @@ -8,7 +8,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends StatefulHookConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override HomeViewState createState() => HomeViewState(); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index 4d941edd3..9976365c8 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -21,7 +21,7 @@ class TodoList extends StateNotifier> { final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart index 5d96a2ace..0b50be457 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -4,7 +4,7 @@ import 'package:flutter_test/flutter_test.dart'; class MyApp extends StatelessWidget { // ignore: prefer_const_constructors_in_immutables - MyApp({Key? key}) : super(key: key); + MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index 9c615f171..ec47bdfed 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -43,7 +43,7 @@ class FakeRepository implements Repository { } class TodoItem extends StatelessWidget { - const TodoItem({Key? key, required this.todo}) : super(key: key); + const TodoItem({super.key, required this.todo}); final Todo todo; @override Widget build(BuildContext context) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart index c998894ce..302f85601 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart @@ -17,7 +17,7 @@ class Todo { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index 5c4623d07..a9a7d2469 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -15,7 +15,7 @@ final canGoToPreviousPageProvider = Provider((ref) { }); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}) : super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index 15453e5cc..f8a4596df 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -7,7 +7,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final pageIndexProvider = StateProvider((ref) => 0); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}) : super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index 4e0febf0b..10628cc8b 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -8,7 +8,7 @@ import 'todos.dart'; /* SNIPPET START */ class TodoListView extends ConsumerWidget { - const TodoListView({Key? key}) : super(key: key); + const TodoListView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 9be456f53..966f4dec3 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -11,7 +11,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { @@ -56,7 +56,7 @@ final productsProvider = Provider>((ref) { }); class MyHomePage extends ConsumerWidget { - const MyHomePage({Key? key}) : super(key: key); + const MyHomePage({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index f8b51a482..e3896c225 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index 0109bc44f..d6e0a046d 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -32,7 +32,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart index 4eaa6d0d6..fe3d6ac4f 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart @@ -7,7 +7,7 @@ import 'reading_counter.dart'; class HomeView extends HookConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart index 3ede1219f..0668b2510 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart @@ -8,7 +8,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends HookConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart index 33b7693df..8fd00f4d8 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerStatefulWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override HomeViewState createState() => HomeViewState(); diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart index e9f83a366..3a5cb346e 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index 37121f87c..4ed90e7af 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); final anotherProvider = Provider((ref) { ref.listen(counterProvider, (int? previousCount, int newCount) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 2449c763e..066565b67 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -6,10 +6,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index d47644e84..e9afa56c4 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -7,10 +7,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart index a4371343f..0e9db5bae 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart @@ -8,7 +8,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends StatefulHookConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override HomeViewState createState() => HomeViewState(); diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index 73551cc2c..fc1744463 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -21,7 +21,7 @@ class TodoList extends StateNotifier> { final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart index 4f48da6c1..823aa3d30 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -4,7 +4,7 @@ import 'package:flutter_test/flutter_test.dart'; class MyApp extends StatelessWidget { // ignore: prefer_const_constructors_in_immutables - MyApp({Key? key}) : super(key: key); + MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index a7172bcab..ba5140848 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -43,7 +43,7 @@ class FakeRepository implements Repository { } class TodoItem extends StatelessWidget { - const TodoItem({Key? key, required this.todo}) : super(key: key); + const TodoItem({super.key, required this.todo}); final Todo todo; @override Widget build(BuildContext context) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart index 0785daa06..b25deff3a 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart @@ -17,7 +17,7 @@ class Todo { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart index 9ac192a8a..abb3f67dd 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart @@ -8,7 +8,7 @@ import 'todos.dart'; /* SNIPPET START */ class TodoListView extends ConsumerWidget { - const TodoListView({Key? key}) : super(key: key); + const TodoListView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index 7ee48eada..58ed9ed3e 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -14,7 +14,7 @@ final canGoToPreviousPageProvider = Provider((ref) { }); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}) : super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index 874338d50..0f1f4a503 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -7,7 +7,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final pageIndexProvider = StateProvider((ref) => 0); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}) : super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index 2200ea96a..f1e5a74a0 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -8,7 +8,7 @@ import 'todos.dart'; /* SNIPPET START */ class TodoListView extends ConsumerWidget { - const TodoListView({Key? key}): super(key: key); + const TodoListView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 358bc0d07..283d4c4bd 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -11,7 +11,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { @@ -56,7 +56,7 @@ final productsProvider = Provider>((ref) { }); class MyHomePage extends ConsumerWidget { - const MyHomePage({Key? key}) : super(key: key); + const MyHomePage({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 1c99c21ee..825df6d0f 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index 27fc70d5d..645be50ee 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index be4e325e5..1574317f9 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -32,7 +32,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart index 2f998d0fd..2d38c4cfc 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart @@ -6,7 +6,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'reading_counter.dart'; class HomeView extends HookConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart index 2e44af84c..27db84a16 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart @@ -8,7 +8,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends HookConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart index 680a93b72..c545e9b17 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerStatefulWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override HomeViewState createState() => HomeViewState(); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart index 7fcca6f14..ffa37a065 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index 37121f87c..4ed90e7af 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); final anotherProvider = Provider((ref) { ref.listen(counterProvider, (int? previousCount, int newCount) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 2449c763e..066565b67 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -6,10 +6,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index bfdcce443..b3573a256 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -8,10 +8,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ final counterProvider = - StateNotifierProvider((ref) => Counter(ref)); + StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index 73f86e6e4..6ace027ca 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -21,7 +21,7 @@ class TodoList extends StateNotifier> { final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart index fdc3a12df..eb475ff23 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -4,7 +4,7 @@ import 'package:flutter_test/flutter_test.dart'; class MyApp extends StatelessWidget { // ignore: prefer_const_constructors_in_immutables - MyApp({Key? key}) : super(key: key); + MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index fd6ea0fbf..8b290d56d 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -42,7 +42,7 @@ class FakeRepository implements Repository { } class TodoItem extends StatelessWidget { - const TodoItem({Key? key, required this.todo}) : super(key: key); + const TodoItem({super.key, required this.todo}); final Todo todo; @override Widget build(BuildContext context) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart index bb80b87c4..8ad1eca93 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart @@ -17,7 +17,7 @@ class Todo { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index b4093708b..b7c497a43 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -14,7 +14,7 @@ final canGoToPreviousPageProvider = Provider((ref) { }); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}) : super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index a415f6b6c..e5f56b568 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -7,7 +7,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final pageIndexProvider = StateProvider((ref) => 0); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}) : super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index 1b98eb780..8722a542f 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -8,7 +8,7 @@ import 'todos.dart'; /* SNIPPET START */ class TodoListView extends ConsumerWidget { - const TodoListView({Key? key}): super(key: key); + const TodoListView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 74a0c7c72..4c598055f 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -11,7 +11,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { @@ -56,7 +56,7 @@ final productsProvider = Provider>((ref) { }); class MyHomePage extends ConsumerWidget { - const MyHomePage({Key? key}) : super(key: key); + const MyHomePage({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 1c99c21ee..825df6d0f 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index af6d060a8..c029e0730 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index c058b2482..da15a3a50 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -32,7 +32,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart index 4ae8388a0..ac6d3ef63 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart @@ -7,7 +7,7 @@ import 'reading_counter.dart'; class HomeView extends HookConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart index 9df46339c..69b5c71ce 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart @@ -8,7 +8,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends HookConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart index c05217472..d176a287a 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerStatefulWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override HomeViewState createState() => HomeViewState(); diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart index 845f0c56a..234a266ba 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index 37121f87c..4ed90e7af 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -5,7 +5,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); final anotherProvider = Provider((ref) { ref.listen(counterProvider, (int? previousCount, int newCount) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 2449c763e..066565b67 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -6,10 +6,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index e9b04fee1..957ccc2cc 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -7,10 +7,10 @@ import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider((ref) => Counter(ref)); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart index da8854428..fa21a6f45 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart @@ -8,7 +8,7 @@ import 'reading_counter.dart'; /* SNIPPET START */ class HomeView extends StatefulHookConsumerWidget { - const HomeView({Key? key}) : super(key: key); + const HomeView({super.key}); @override HomeViewState createState() => HomeViewState(); diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index 41b861272..779ffb0a1 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -21,7 +21,7 @@ class TodoList extends StateNotifier> { final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart index cc799ea51..35b35a589 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -4,7 +4,7 @@ import 'package:flutter_test/flutter_test.dart'; class MyApp extends StatelessWidget { // ignore: prefer_const_constructors_in_immutables - MyApp({Key? key}) : super(key: key); + MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index d80d48758..fdd7f1e04 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -43,7 +43,7 @@ class FakeRepository implements Repository { } class TodoItem extends StatelessWidget { - const TodoItem({Key? key, required this.todo}) : super(key: key); + const TodoItem({super.key, required this.todo}); final Todo todo; @override Widget build(BuildContext context) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart index bde97547a..dbdc85b26 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart @@ -17,7 +17,7 @@ class Todo { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart index b65b34143..e04cbd9e2 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart @@ -8,7 +8,7 @@ import 'todos.dart'; /* SNIPPET START */ class TodoListView extends ConsumerWidget { - const TodoListView({Key? key}) : super(key: key); + const TodoListView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index 10ccd75d1..f1a86304d 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -15,7 +15,7 @@ final canGoToPreviousPageProvider = Provider((ref) { }); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}): super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index 3218e222f..106bdd5af 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -7,7 +7,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final pageIndexProvider = StateProvider((ref) => 0); class PreviousButton extends ConsumerWidget { - const PreviousButton({Key? key}): super(key: key); + const PreviousButton({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index a7c5078ae..bc1163af4 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -8,7 +8,7 @@ import 'todos.dart'; /* SNIPPET START */ class TodoListView extends ConsumerWidget { - const TodoListView({Key? key}): super(key: key); + const TodoListView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 659a93c7f..f96b8f7d3 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -11,7 +11,7 @@ void main() { } class MyApp extends StatelessWidget { - const MyApp({Key? key}) : super(key: key); + const MyApp({super.key}); @override Widget build(BuildContext context) { @@ -56,7 +56,7 @@ final productsProvider = Provider>((ref) { }); class MyHomePage extends ConsumerWidget { - const MyHomePage({Key? key}) : super(key: key); + const MyHomePage({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 1c99c21ee..825df6d0f 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index bc802acf4..80c4b2505 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); class HomeView extends ConsumerWidget { - const HomeView({Key? key}): super(key: key); + const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { From 5e944a966344fbfd1718b4502f723f3ce696922b Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Tue, 29 Aug 2023 22:04:36 +0200 Subject: [PATCH 019/387] Patch lints --- melos.yaml | 2 +- packages/riverpod_lint/lib/src/lints/functional_ref.dart | 2 +- .../test/goldens/functional_ref.dart | 6 +++--- .../test/goldens/notifier_extends.dart | 6 +++--- .../test/goldens/notifier_extends_test.dart | 1 + 5 files changed, 9 insertions(+), 8 deletions(-) diff --git a/melos.yaml b/melos.yaml index 92f760bcc..230aabcaa 100644 --- a/melos.yaml +++ b/melos.yaml @@ -3,7 +3,7 @@ name: my_project packages: - - website/** + - website - packages/** - examples/** diff --git a/packages/riverpod_lint/lib/src/lints/functional_ref.dart b/packages/riverpod_lint/lib/src/lints/functional_ref.dart index 0934ef07a..fd3dab5e7 100644 --- a/packages/riverpod_lint/lib/src/lints/functional_ref.dart +++ b/packages/riverpod_lint/lib/src/lints/functional_ref.dart @@ -5,7 +5,7 @@ import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import '../riverpod_custom_lint.dart'; -import 'generator_class_extends.dart'; +import 'notifier_extends.dart'; class FunctionalRef extends RiverpodLintRule { const FunctionalRef() : super(code: _code); diff --git a/packages/riverpod_lint_flutter_test/test/goldens/functional_ref.dart b/packages/riverpod_lint_flutter_test/test/goldens/functional_ref.dart index 99606eb2e..5c0a072f6 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/functional_ref.dart +++ b/packages/riverpod_lint_flutter_test/test/goldens/functional_ref.dart @@ -31,13 +31,13 @@ external int scoped(); int generics(GenericsRef ref) => 0; @riverpod -// expect_lint: stateless_ref +// expect_lint: functional_ref int noGenerics(NoGenericsRef ref) => 0; @riverpod -// expect_lint: stateless_ref +// expect_lint: functional_ref int missingGenerics(MissingGenericsRef ref) => 0; @riverpod -// expect_lint: stateless_ref +// expect_lint: functional_ref int wrongOrder(WrongOrderRef ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends.dart b/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends.dart index 778316271..f80904594 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends.dart +++ b/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends.dart @@ -34,19 +34,19 @@ class Generics extends _$Generics { } @riverpod -// expect_lint: generator_class_extends +// expect_lint: notifier_extends class NoGenerics extends _$NoGenerics { int build() => 0; } @riverpod -// expect_lint: generator_class_extends +// expect_lint: notifier_extends class MissingGenerics extends _$MissingGenerics { int build() => 0; } @riverpod -// expect_lint: generator_class_extends +// expect_lint: notifier_extends class WrongOrder extends _$WrongOrder { int build() => 0; } diff --git a/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends_test.dart b/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends_test.dart index 7da80e8ef..e152304cb 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends_test.dart +++ b/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends_test.dart @@ -2,6 +2,7 @@ import 'dart:io'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:collection/collection.dart'; +import 'package:riverpod_lint/src/lints/functional_ref.dart'; import 'package:riverpod_lint/src/lints/notifier_extends.dart'; import 'package:analyzer/dart/analysis/results.dart'; import 'package:analyzer/dart/analysis/utilities.dart'; From 39864b9b6c2fff5f7e1dac5c2c2448316e9459b5 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Tue, 29 Aug 2023 22:18:45 +0200 Subject: [PATCH 020/387] Fixup generics/lints --- .../auto_dispose_provider_family_test.dart | 2 +- .../legacy_provider_declaration.dart | 2 - .../src/riverpod_ast/riverpod_annotation.dart | 2 - .../lib/src/migrate/unified_syntax.dart | 7 --- .../lib/src/templates/family.dart | 20 ++++---- .../test/integration/async.g.dart | 23 ++++----- .../test/integration/stream.g.dart | 23 ++++----- .../test/integration/sync.g.dart | 40 ++++++++-------- .../convert_to_stateful_base_widget.dart | 4 -- .../convert_to_stateless_base_widget.dart | 4 -- ..._class_based_provider_to_functional.g.dart | 10 ++-- .../test/goldens/functional_ref.g.dart | 48 +++++++++---------- ...stateless_ref.json => functional_ref.json} | 2 +- .../test/goldens/notifier_extends.g.dart | 40 ++++++++-------- .../test/goldens/notifier_extends.json | 2 +- .../test/goldens/notifier_extends_test.dart | 4 +- .../bin/generate_providers.dart | 2 - 17 files changed, 108 insertions(+), 127 deletions(-) rename packages/riverpod_lint_flutter_test/test/goldens/{stateless_ref.json => functional_ref.json} (65%) diff --git a/packages/riverpod/test/providers/provider/auto_dispose_provider_family_test.dart b/packages/riverpod/test/providers/provider/auto_dispose_provider_family_test.dart index 28cbbcac4..1700e27e3 100644 --- a/packages/riverpod/test/providers/provider/auto_dispose_provider_family_test.dart +++ b/packages/riverpod/test/providers/provider/auto_dispose_provider_family_test.dart @@ -79,7 +79,7 @@ void main() { provider.overrideWith((ref, value) { ref.onDispose(onDispose.call); return '$value override'; - }) + }), ], ); addTearDown(container.dispose); diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/legacy_provider_declaration.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/legacy_provider_declaration.dart index f7e5d98af..65b71b06a 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/legacy_provider_declaration.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/legacy_provider_declaration.dart @@ -124,10 +124,8 @@ class LegacyProviderDeclaration extends RiverpodAst switch (identifier.name) { case 'autoDispose': autoDisposeModifier = identifier; - break; case 'family': familyModifier = identifier; - break; default: provider = identifier; } diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart index e7f22bf79..7a00e22a8 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart @@ -79,10 +79,8 @@ class RiverpodAnnotation extends RiverpodAst { switch (argument.name.label.name) { case 'keepAlive': keepAliveNode = argument; - break; case 'dependencies': dependenciesNode = argument; - break; } } } diff --git a/packages/riverpod_cli/lib/src/migrate/unified_syntax.dart b/packages/riverpod_cli/lib/src/migrate/unified_syntax.dart index 6a56c06b4..e66e4fee1 100644 --- a/packages/riverpod_cli/lib/src/migrate/unified_syntax.dart +++ b/packages/riverpod_cli/lib/src/migrate/unified_syntax.dart @@ -509,45 +509,38 @@ class RiverpodUnifiedSyntaxChangesMigrationSuggestor node.name2.offset, node.name2.end, ); - break; case ProviderType.future: yieldPatch( '${autoDisposePrefix}FutureProviderRef<$providerTypeArgs>', node.name2.offset, node.name2.end, ); - break; case ProviderType.plain: yieldPatch( '${autoDisposePrefix}ProviderRef<$providerTypeArgs>', node.name2.offset, node.name2.end, ); - break; case ProviderType.state: yieldPatch( '${autoDisposePrefix}StateProviderRef<$providerTypeArgs>', node.name2.offset, node.name2.end, ); - break; case ProviderType.statenotifier: yieldPatch( '${autoDisposePrefix}StateNotifierProviderRef<$providerTypeArgs>', node.name2.offset, node.name2.end, ); - break; case ProviderType.changenotifier: yieldPatch( '${autoDisposePrefix}ChangeNotifierProviderRef<$providerTypeArgs>', node.name2.offset, node.name2.end, ); - break; case ProviderType.none: yieldPatch('Ref', node.name2.offset, node.name2.end); - break; } } } catch (e, st) { diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index d6ec55231..ced1cb7af 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -103,8 +103,6 @@ class FamilyTemplate extends Template { }); final typeParameters = provider.node.functionExpression.typeParameters; - final typeParametersDefinition = - genericDefinitionDisplayString(typeParameters); final typeParametersUsage = genericUsageDisplayString(typeParameters); return FamilyTemplate._( @@ -124,12 +122,12 @@ class FamilyTemplate extends Template { @override Override overrideWith( - $createdType Function(${provider._refImplName} provider) create, + $createdType Function(${provider._refImplName}$typeParametersUsage provider) create, ) { return ProviderOverride( origin: this, - override: ${provider._providerImplName}._internal( - (ref) => create(ref as ${provider._refImplName}), + override: ${provider._providerImplName}$typeParametersUsage._internal( + (ref) => create(ref as ${provider._refImplName}$typeParametersUsage), from: from, name: null, dependencies: null, @@ -223,10 +221,10 @@ abstract class $notifierTypedefName$typeParametersDefinition extends $notifierBa } @override - Override overrideWith(${provider.name} Function() create) { + Override overrideWith(${provider.name}$typeParametersUsage Function() create) { return ProviderOverride( origin: this, - override: ${provider._providerImplName}._internal( + override: ${provider._providerImplName}$typeParametersUsage._internal( () => create()$cascadePropertyInit, from: from, name: null, @@ -373,14 +371,14 @@ $providerOther var hash = _SystemHash.combine(0, runtimeType.hashCode); ${[ ...parameters.map((e) => e.name), - ...?typeParameters?.typeParameters.map((e) => e.name) + ...?typeParameters?.typeParameters.map((e) => e.name), ].map((e) => 'hash = _SystemHash.combine(hash, $e.hashCode);').join()} return _SystemHash.finish(hash); } } -mixin $refNameImpl on $refType<${provider.valueType}> { +mixin $refNameImpl$typeParametersDefinition on $refType<${provider.valueType}> { ${parameters.map((e) { return ''' /// The parameter `${e.name}` of this provider. @@ -388,10 +386,10 @@ ${e.type} get ${e.name};'''; }).join()} } -class $elementNameImpl extends $elementType$providerGenerics with $refNameImpl { +class $elementNameImpl$typeParametersDefinition extends $elementType$providerGenerics with $refNameImpl$typeParametersUsage { $elementNameImpl(super.provider); -${parameters.map((e) => '@override ${e.type} get ${e.name} => (origin as $providerTypeNameImpl).${e.name};').join()} +${parameters.map((e) => '@override ${e.type} get ${e.name} => (origin as $providerTypeNameImpl$typeParametersUsage).${e.name};').join()} } '''); } diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index e295fb68d..3618a2759 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -95,12 +95,12 @@ class GenericProvider @override Override overrideWith( - FutureOr> Function(GenericRef provider) create, + FutureOr> Function(GenericRef provider) create, ) { return ProviderOverride( origin: this, - override: GenericProvider._internal( - (ref) => create(ref as GenericRef), + override: GenericProvider._internal( + (ref) => create(ref as GenericRef), from: from, name: null, dependencies: null, @@ -129,10 +129,10 @@ class GenericProvider } } -mixin GenericRef on AutoDisposeFutureProviderRef> {} +mixin GenericRef on AutoDisposeFutureProviderRef> {} -class _GenericProviderElement extends AutoDisposeFutureProviderElement> - with GenericRef { +class _GenericProviderElement + extends AutoDisposeFutureProviderElement> with GenericRef { _GenericProviderElement(super.provider); } @@ -561,10 +561,10 @@ class GenericClassProvider } @override - Override overrideWith(GenericClass Function() create) { + Override overrideWith(GenericClass Function() create) { return ProviderOverride( origin: this, - override: GenericClassProvider._internal( + override: GenericClassProvider._internal( () => create(), from: from, name: null, @@ -595,11 +595,12 @@ class GenericClassProvider } } -mixin GenericClassRef on AutoDisposeAsyncNotifierProviderRef> {} +mixin GenericClassRef + on AutoDisposeAsyncNotifierProviderRef> {} -class _GenericClassProviderElement +class _GenericClassProviderElement extends AutoDisposeAsyncNotifierProviderElement, List> - with GenericClassRef { + with GenericClassRef { _GenericClassProviderElement(super.provider); } diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 2578ab444..7ddd5ba4d 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -95,12 +95,12 @@ class GenericProvider @override Override overrideWith( - Stream> Function(GenericRef provider) create, + Stream> Function(GenericRef provider) create, ) { return ProviderOverride( origin: this, - override: GenericProvider._internal( - (ref) => create(ref as GenericRef), + override: GenericProvider._internal( + (ref) => create(ref as GenericRef), from: from, name: null, dependencies: null, @@ -129,10 +129,10 @@ class GenericProvider } } -mixin GenericRef on AutoDisposeStreamProviderRef> {} +mixin GenericRef on AutoDisposeStreamProviderRef> {} -class _GenericProviderElement extends AutoDisposeStreamProviderElement> - with GenericRef { +class _GenericProviderElement + extends AutoDisposeStreamProviderElement> with GenericRef { _GenericProviderElement(super.provider); } @@ -434,10 +434,10 @@ class GenericClassProvider } @override - Override overrideWith(GenericClass Function() create) { + Override overrideWith(GenericClass Function() create) { return ProviderOverride( origin: this, - override: GenericClassProvider._internal( + override: GenericClassProvider._internal( () => create(), from: from, name: null, @@ -468,11 +468,12 @@ class GenericClassProvider } } -mixin GenericClassRef on AutoDisposeStreamNotifierProviderRef> {} +mixin GenericClassRef + on AutoDisposeStreamNotifierProviderRef> {} -class _GenericClassProviderElement +class _GenericClassProviderElement extends AutoDisposeStreamNotifierProviderElement, List> - with GenericClassRef { + with GenericClassRef { _GenericClassProviderElement(super.provider); } diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 1ac245eb6..0c5f8b669 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -94,12 +94,12 @@ class GenericProvider extends AutoDisposeProvider> { @override Override overrideWith( - List Function(GenericRef provider) create, + List Function(GenericRef provider) create, ) { return ProviderOverride( origin: this, - override: GenericProvider._internal( - (ref) => create(ref as GenericRef), + override: GenericProvider._internal( + (ref) => create(ref as GenericRef), from: from, name: null, dependencies: null, @@ -128,10 +128,10 @@ class GenericProvider extends AutoDisposeProvider> { } } -mixin GenericRef on AutoDisposeProviderRef> {} +mixin GenericRef on AutoDisposeProviderRef> {} -class _GenericProviderElement extends AutoDisposeProviderElement> - with GenericRef { +class _GenericProviderElement + extends AutoDisposeProviderElement> with GenericRef { _GenericProviderElement(super.provider); } @@ -224,12 +224,12 @@ class ComplexGenericProvider @override Override overrideWith( - List Function(ComplexGenericRef provider) create, + List Function(ComplexGenericRef provider) create, ) { return ProviderOverride( origin: this, - override: ComplexGenericProvider._internal( - (ref) => create(ref as ComplexGenericRef), + override: ComplexGenericProvider._internal( + (ref) => create(ref as ComplexGenericRef), from: from, name: null, dependencies: null, @@ -266,7 +266,8 @@ class ComplexGenericProvider } } -mixin ComplexGenericRef on AutoDisposeProviderRef> { +mixin ComplexGenericRef + on AutoDisposeProviderRef> { /// The parameter `param` of this provider. T get param; @@ -274,14 +275,14 @@ mixin ComplexGenericRef on AutoDisposeProviderRef> { Foo? get otherParam; } -class _ComplexGenericProviderElement extends AutoDisposeProviderElement> - with ComplexGenericRef { +class _ComplexGenericProviderElement + extends AutoDisposeProviderElement> with ComplexGenericRef { _ComplexGenericProviderElement(super.provider); @override - T get param => (origin as ComplexGenericProvider).param; + T get param => (origin as ComplexGenericProvider).param; @override - Foo? get otherParam => (origin as ComplexGenericProvider).otherParam; + Foo? get otherParam => (origin as ComplexGenericProvider).otherParam; } String _$rawFutureHash() => r'5203a56065b768023770326281618e3229ccb530'; @@ -909,10 +910,10 @@ class GenericClassProvider } @override - Override overrideWith(GenericClass Function() create) { + Override overrideWith(GenericClass Function() create) { return ProviderOverride( origin: this, - override: GenericClassProvider._internal( + override: GenericClassProvider._internal( () => create(), from: from, name: null, @@ -942,11 +943,12 @@ class GenericClassProvider } } -mixin GenericClassRef on AutoDisposeNotifierProviderRef> {} +mixin GenericClassRef + on AutoDisposeNotifierProviderRef> {} -class _GenericClassProviderElement +class _GenericClassProviderElement extends AutoDisposeNotifierProviderElement, List> - with GenericClassRef { + with GenericClassRef { _GenericClassProviderElement(super.provider); } diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart index e4f60c98c..784349bbd 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart @@ -96,11 +96,9 @@ class ConvertToStatefulBaseWidget extends RiverpodAssist { case StatefulBaseWidgetType.consumerStatefulWidget: case StatefulBaseWidgetType.statefulHookConsumerWidget: baseStateName = 'ConsumerState'; - break; case StatefulBaseWidgetType.statefulHookWidget: case StatefulBaseWidgetType.statefulWidget: baseStateName = 'State'; - break; } // Split the class into two classes right before the build method @@ -154,11 +152,9 @@ class $createdStateClassName extends $baseStateName<${widgetClass.name}> { case StatefulBaseWidgetType.consumerStatefulWidget: case StatefulBaseWidgetType.statefulHookConsumerWidget: baseStateName = 'ConsumerState'; - break; case StatefulBaseWidgetType.statefulHookWidget: case StatefulBaseWidgetType.statefulWidget: baseStateName = 'State'; - break; } final createStateMethod = widgetClass.members diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart index fc2c30174..24555fa7f 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart @@ -104,7 +104,6 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist { ', WidgetRef ref', ); } - break; case StatelessBaseWidgetType.hookWidget: case StatelessBaseWidgetType.statelessWidget: // If the build method has a ref, remove it @@ -116,7 +115,6 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist { ), ); } - break; } }); } @@ -165,11 +163,9 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist { case StatelessBaseWidgetType.consumerWidget: case StatelessBaseWidgetType.hookConsumerWidget: newBuildMethod = _buildMethodWithRef(buildMethod, source); - break; case StatelessBaseWidgetType.hookWidget: case StatelessBaseWidgetType.statelessWidget: newBuildMethod = _buildMethodWithoutRef(buildMethod, source); - break; } if (newBuildMethod == null) return; diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional.g.dart index be09cbfd1..c1dcc7e16 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional.g.dart @@ -294,10 +294,10 @@ class GenericProvider } @override - Override overrideWith(Generic Function() create) { + Override overrideWith(Generic Function() create) { return ProviderOverride( origin: this, - override: GenericProvider._internal( + override: GenericProvider._internal( () => create(), from: from, name: null, @@ -328,11 +328,11 @@ class GenericProvider } } -mixin GenericRef on AutoDisposeNotifierProviderRef {} +mixin GenericRef on AutoDisposeNotifierProviderRef {} -class _GenericProviderElement +class _GenericProviderElement extends AutoDisposeNotifierProviderElement, int> - with GenericRef { + with GenericRef { _GenericProviderElement(super.provider); } // ignore_for_file: type=lint diff --git a/packages/riverpod_lint_flutter_test/test/goldens/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/goldens/functional_ref.g.dart index 1ff205738..96f1cf86b 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/goldens/functional_ref.g.dart @@ -154,12 +154,12 @@ class GenericsProvider extends AutoDisposeProvider { @override Override overrideWith( - int Function(GenericsRef provider) create, + int Function(GenericsRef provider) create, ) { return ProviderOverride( origin: this, - override: GenericsProvider._internal( - (ref) => create(ref as GenericsRef), + override: GenericsProvider._internal( + (ref) => create(ref as GenericsRef), from: from, name: null, dependencies: null, @@ -189,10 +189,10 @@ class GenericsProvider extends AutoDisposeProvider { } } -mixin GenericsRef on AutoDisposeProviderRef {} +mixin GenericsRef on AutoDisposeProviderRef {} -class _GenericsProviderElement extends AutoDisposeProviderElement - with GenericsRef { +class _GenericsProviderElement + extends AutoDisposeProviderElement with GenericsRef { _GenericsProviderElement(super.provider); } @@ -264,12 +264,12 @@ class NoGenericsProvider extends AutoDisposeProvider { @override Override overrideWith( - int Function(NoGenericsRef provider) create, + int Function(NoGenericsRef provider) create, ) { return ProviderOverride( origin: this, - override: NoGenericsProvider._internal( - (ref) => create(ref as NoGenericsRef), + override: NoGenericsProvider._internal( + (ref) => create(ref as NoGenericsRef), from: from, name: null, dependencies: null, @@ -299,10 +299,10 @@ class NoGenericsProvider extends AutoDisposeProvider { } } -mixin NoGenericsRef on AutoDisposeProviderRef {} +mixin NoGenericsRef on AutoDisposeProviderRef {} -class _NoGenericsProviderElement extends AutoDisposeProviderElement - with NoGenericsRef { +class _NoGenericsProviderElement + extends AutoDisposeProviderElement with NoGenericsRef { _NoGenericsProviderElement(super.provider); } @@ -374,12 +374,12 @@ class MissingGenericsProvider extends AutoDisposeProvider { @override Override overrideWith( - int Function(MissingGenericsRef provider) create, + int Function(MissingGenericsRef provider) create, ) { return ProviderOverride( origin: this, - override: MissingGenericsProvider._internal( - (ref) => create(ref as MissingGenericsRef), + override: MissingGenericsProvider._internal( + (ref) => create(ref as MissingGenericsRef), from: from, name: null, dependencies: null, @@ -409,10 +409,10 @@ class MissingGenericsProvider extends AutoDisposeProvider { } } -mixin MissingGenericsRef on AutoDisposeProviderRef {} +mixin MissingGenericsRef on AutoDisposeProviderRef {} -class _MissingGenericsProviderElement extends AutoDisposeProviderElement - with MissingGenericsRef { +class _MissingGenericsProviderElement + extends AutoDisposeProviderElement with MissingGenericsRef { _MissingGenericsProviderElement(super.provider); } @@ -484,12 +484,12 @@ class WrongOrderProvider extends AutoDisposeProvider { @override Override overrideWith( - int Function(WrongOrderRef provider) create, + int Function(WrongOrderRef provider) create, ) { return ProviderOverride( origin: this, - override: WrongOrderProvider._internal( - (ref) => create(ref as WrongOrderRef), + override: WrongOrderProvider._internal( + (ref) => create(ref as WrongOrderRef), from: from, name: null, dependencies: null, @@ -519,10 +519,10 @@ class WrongOrderProvider extends AutoDisposeProvider { } } -mixin WrongOrderRef on AutoDisposeProviderRef {} +mixin WrongOrderRef on AutoDisposeProviderRef {} -class _WrongOrderProviderElement extends AutoDisposeProviderElement - with WrongOrderRef { +class _WrongOrderProviderElement extends AutoDisposeProviderElement + with WrongOrderRef { _WrongOrderProviderElement(super.provider); } // ignore_for_file: type=lint diff --git a/packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.json b/packages/riverpod_lint_flutter_test/test/goldens/functional_ref.json similarity index 65% rename from packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.json rename to packages/riverpod_lint_flutter_test/test/goldens/functional_ref.json index 2c621377b..f8ef383c2 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/stateless_ref.json +++ b/packages/riverpod_lint_flutter_test/test/goldens/functional_ref.json @@ -1 +1 @@ -[{"priority":90,"change":{"message":"Add ref parameter","edits":[{"fileStamp":0,"edits":[{"offset":146,"length":0,"replacement":"ReflessRef ref"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as NamelessRef","edits":[{"fileStamp":0,"edits":[{"offset":223,"length":0,"replacement":"NamelessRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as IncorrectlyTypedRef","edits":[{"fileStamp":0,"edits":[{"offset":313,"length":4,"replacement":"IncorrectlyTypedRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as NoGenericsRef","edits":[{"fileStamp":0,"edits":[{"offset":519,"length":14,"replacement":"NoGenericsRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as MissingGenericsRef","edits":[{"fileStamp":0,"edits":[{"offset":611,"length":19,"replacement":"MissingGenericsRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as WrongOrderRef","edits":[{"fileStamp":0,"edits":[{"offset":703,"length":14,"replacement":"WrongOrderRef "}]}],"linkedEditGroups":[]}}] \ No newline at end of file +[{"priority":90,"change":{"message":"Add ref parameter","edits":[{"fileStamp":0,"edits":[{"offset":148,"length":0,"replacement":"ReflessRef ref"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as NamelessRef","edits":[{"fileStamp":0,"edits":[{"offset":226,"length":0,"replacement":"NamelessRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as IncorrectlyTypedRef","edits":[{"fileStamp":0,"edits":[{"offset":317,"length":4,"replacement":"IncorrectlyTypedRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as NoGenericsRef","edits":[{"fileStamp":0,"edits":[{"offset":524,"length":14,"replacement":"NoGenericsRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as MissingGenericsRef","edits":[{"fileStamp":0,"edits":[{"offset":617,"length":19,"replacement":"MissingGenericsRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as WrongOrderRef","edits":[{"fileStamp":0,"edits":[{"offset":710,"length":14,"replacement":"WrongOrderRef "}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends.g.dart index 37850ed16..78fa8d03e 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends.g.dart @@ -163,10 +163,10 @@ class GenericsProvider } @override - Override overrideWith(Generics Function() create) { + Override overrideWith(Generics Function() create) { return ProviderOverride( origin: this, - override: GenericsProvider._internal( + override: GenericsProvider._internal( () => create(), from: from, name: null, @@ -197,11 +197,11 @@ class GenericsProvider } } -mixin GenericsRef on AutoDisposeNotifierProviderRef {} +mixin GenericsRef on AutoDisposeNotifierProviderRef {} -class _GenericsProviderElement +class _GenericsProviderElement extends AutoDisposeNotifierProviderElement, int> - with GenericsRef { + with GenericsRef { _GenericsProviderElement(super.provider); } @@ -283,10 +283,10 @@ class NoGenericsProvider } @override - Override overrideWith(NoGenerics Function() create) { + Override overrideWith(NoGenerics Function() create) { return ProviderOverride( origin: this, - override: NoGenericsProvider._internal( + override: NoGenericsProvider._internal( () => create(), from: from, name: null, @@ -317,11 +317,11 @@ class NoGenericsProvider } } -mixin NoGenericsRef on AutoDisposeNotifierProviderRef {} +mixin NoGenericsRef on AutoDisposeNotifierProviderRef {} -class _NoGenericsProviderElement +class _NoGenericsProviderElement extends AutoDisposeNotifierProviderElement, int> - with NoGenericsRef { + with NoGenericsRef { _NoGenericsProviderElement(super.provider); } @@ -403,10 +403,10 @@ class MissingGenericsProvider } @override - Override overrideWith(MissingGenerics Function() create) { + Override overrideWith(MissingGenerics Function() create) { return ProviderOverride( origin: this, - override: MissingGenericsProvider._internal( + override: MissingGenericsProvider._internal( () => create(), from: from, name: null, @@ -438,11 +438,11 @@ class MissingGenericsProvider } } -mixin MissingGenericsRef on AutoDisposeNotifierProviderRef {} +mixin MissingGenericsRef on AutoDisposeNotifierProviderRef {} -class _MissingGenericsProviderElement +class _MissingGenericsProviderElement extends AutoDisposeNotifierProviderElement, int> - with MissingGenericsRef { + with MissingGenericsRef { _MissingGenericsProviderElement(super.provider); } @@ -523,10 +523,10 @@ class WrongOrderProvider } @override - Override overrideWith(WrongOrder Function() create) { + Override overrideWith(WrongOrder Function() create) { return ProviderOverride( origin: this, - override: WrongOrderProvider._internal( + override: WrongOrderProvider._internal( () => create(), from: from, name: null, @@ -557,11 +557,11 @@ class WrongOrderProvider } } -mixin WrongOrderRef on AutoDisposeNotifierProviderRef {} +mixin WrongOrderRef on AutoDisposeNotifierProviderRef {} -class _WrongOrderProviderElement +class _WrongOrderProviderElement extends AutoDisposeNotifierProviderElement, int> - with WrongOrderRef { + with WrongOrderRef { _WrongOrderProviderElement(super.provider); } // ignore_for_file: type=lint diff --git a/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends.json b/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends.json index e3efc82cf..e76303fd3 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends.json +++ b/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends.json @@ -1 +1 @@ -[{"priority":90,"change":{"message":"Extend _$NoExtends","edits":[{"fileStamp":0,"edits":[{"offset":294,"length":0,"replacement":" extends _$NoExtends"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$WrongExtends","edits":[{"fileStamp":0,"edits":[{"offset":397,"length":18,"replacement":"_$WrongExtends"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$NoGenerics","edits":[{"fileStamp":0,"edits":[{"offset":808,"length":12,"replacement":"_$NoGenerics"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$MissingGenerics","edits":[{"fileStamp":0,"edits":[{"offset":932,"length":20,"replacement":"_$MissingGenerics"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$WrongOrder","edits":[{"fileStamp":0,"edits":[{"offset":1059,"length":18,"replacement":"_$WrongOrder"}]}],"linkedEditGroups":[]}}] +[{"priority":90,"change":{"message":"Extend _$NoExtends","edits":[{"fileStamp":0,"edits":[{"offset":280,"length":0,"replacement":" extends _$NoExtends"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$WrongExtends","edits":[{"fileStamp":0,"edits":[{"offset":376,"length":18,"replacement":"_$WrongExtends"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$NoGenerics","edits":[{"fileStamp":0,"edits":[{"offset":780,"length":12,"replacement":"_$NoGenerics"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$MissingGenerics","edits":[{"fileStamp":0,"edits":[{"offset":897,"length":20,"replacement":"_$MissingGenerics"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$WrongOrder","edits":[{"fileStamp":0,"edits":[{"offset":1017,"length":18,"replacement":"_$WrongOrder"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends_test.dart b/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends_test.dart index e152304cb..41dad58d3 100644 --- a/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends_test.dart +++ b/packages/riverpod_lint_flutter_test/test/goldens/notifier_extends_test.dart @@ -37,11 +37,11 @@ void main() { testGolden( 'Verify that @riverpod classes extend the generated typedef', - 'goldens/stateless_ref.json', + 'goldens/functional_ref.json', () async { final lint = FunctionalRef(); final fix = lint.getFixes().single as DartFix; - final file = File('test/goldens/stateless_ref.dart').absolute; + final file = File('test/goldens/functional_ref.dart').absolute; final result = await resolveFile2(path: file.path); result as ResolvedUnitResult; diff --git a/tools/generate_providers/bin/generate_providers.dart b/tools/generate_providers/bin/generate_providers.dart index 11d0fa8c4..fe9321f33 100644 --- a/tools/generate_providers/bin/generate_providers.dart +++ b/tools/generate_providers/bin/generate_providers.dart @@ -707,7 +707,6 @@ class AutoDisposeStreamNotifierProviderFamilyBuilder { } """, ); - break; case 'flutter_riverpod': matrix = Tuple3( DisposeType.values, @@ -728,7 +727,6 @@ import 'package:flutter/foundation.dart'; import 'internals.dart'; """, ); - break; default: throw UnsupportedError('Unknown package ${args.first}'); } From c0a0ecbd3dc41d9f4bb1debad5ced646fdc71db9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Tue, 29 Aug 2023 22:23:09 +0200 Subject: [PATCH 021/387] Last lint fixup --- .../assists/convert_class_based_provider_to_functional.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional.json b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional.json index ac601b46f..437d0dda2 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional.json +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional.json @@ -1 +1 @@ -[{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":215,"length":2,"replacement":""},{"offset":208,"length":0,"replacement":"ExampleRef ref"},{"offset":202,"length":5,"replacement":"example"},{"offset":150,"length":48,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":215,"length":2,"replacement":""},{"offset":208,"length":0,"replacement":"ExampleRef ref"},{"offset":202,"length":5,"replacement":"example"},{"offset":150,"length":48,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":215,"length":2,"replacement":""},{"offset":208,"length":0,"replacement":"ExampleRef ref"},{"offset":202,"length":5,"replacement":"example"},{"offset":150,"length":48,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":389,"length":2,"replacement":""},{"offset":316,"length":0,"replacement":"ExampleFamilyRef ref, "},{"offset":310,"length":5,"replacement":"exampleFamily"},{"offset":246,"length":60,"replacement":""}]}],"linkedEditGroups":[]}}] \ No newline at end of file +[{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":215,"length":2,"replacement":""},{"offset":208,"length":0,"replacement":"ExampleRef ref"},{"offset":202,"length":5,"replacement":"example"},{"offset":150,"length":48,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":215,"length":2,"replacement":""},{"offset":208,"length":0,"replacement":"ExampleRef ref"},{"offset":202,"length":5,"replacement":"example"},{"offset":150,"length":48,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":215,"length":2,"replacement":""},{"offset":208,"length":0,"replacement":"ExampleRef ref"},{"offset":202,"length":5,"replacement":"example"},{"offset":150,"length":48,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":389,"length":2,"replacement":""},{"offset":316,"length":0,"replacement":"ExampleFamilyRef ref, "},{"offset":310,"length":5,"replacement":"exampleFamily"},{"offset":246,"length":60,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":494,"length":2,"replacement":""},{"offset":487,"length":0,"replacement":"GenericRef ref"},{"offset":486,"length":0,"replacement":""},{"offset":481,"length":5,"replacement":"generic"},{"offset":403,"length":74,"replacement":""}]}],"linkedEditGroups":[]}}] \ No newline at end of file From 2278661a45d29682fdfb02813c2cc6e37c52147a Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 2 Oct 2023 15:26:52 +0200 Subject: [PATCH 022/387] Generated files updates --- .../test/integration/generated.g.dart | 14 +++++++------- .../lints/avoid_build_context_in_providers.g.dart | 4 ++-- .../test/lints/dependencies.g.dart | 4 ++-- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 0eb0350dc..eed623ca2 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -48,7 +48,7 @@ class _SystemHash { const generatedFamilyProvider = GeneratedFamilyFamily(); /// See also [generatedFamily]. -class GeneratedFamilyFamily extends Family<_Test> { +class GeneratedFamilyFamily extends Family { /// See also [generatedFamily]. const GeneratedFamilyFamily(); @@ -190,7 +190,7 @@ String _$$dynamicFamilyHash() => r'b764133af8837b8321b08814892f198d4bc1aa18'; const $dynamicFamilyProvider = $DynamicFamilyFamily(); /// See also [$dynamicFamily]. -class $DynamicFamilyFamily extends Family { +class $DynamicFamilyFamily extends Family { /// See also [$dynamicFamily]. const $DynamicFamilyFamily(); @@ -318,7 +318,7 @@ String _$dynamicHash() => r'da9dc07960139fff2cf5fe584dca5c524e4f2308'; const _dynamicProvider = _DynamicFamily(); /// See also [_dynamic]. -class _DynamicFamily extends Family { +class _DynamicFamily extends Family { /// See also [_dynamic]. const _DynamicFamily(); @@ -459,7 +459,7 @@ String _$aliasFamilyHash() => r'f345937d5750132f629aef41646b119a301f750b'; const aliasFamilyProvider = AliasFamilyFamily(); /// See also [aliasFamily]. -class AliasFamilyFamily extends Family> { +class AliasFamilyFamily extends Family { /// See also [aliasFamily]. const AliasFamilyFamily(); @@ -613,7 +613,7 @@ abstract class _$GeneratedClassFamily const generatedClassFamilyProvider = GeneratedClassFamilyFamily(); /// See also [GeneratedClassFamily]. -class GeneratedClassFamilyFamily extends Family<_Test> { +class GeneratedClassFamilyFamily extends Family { /// See also [GeneratedClassFamily]. const GeneratedClassFamilyFamily(); @@ -774,7 +774,7 @@ abstract class _$$DynamicClassFamily const $dynamicClassFamilyProvider = $DynamicClassFamilyFamily(); /// See also [$DynamicClassFamily]. -class $DynamicClassFamilyFamily extends Family { +class $DynamicClassFamilyFamily extends Family { /// See also [$DynamicClassFamily]. const $DynamicClassFamilyFamily(); @@ -933,7 +933,7 @@ abstract class _$AliasClassFamily const aliasClassFamilyProvider = AliasClassFamilyFamily(); /// See also [AliasClassFamily]. -class AliasClassFamilyFamily extends Family> { +class AliasClassFamilyFamily extends Family { /// See also [AliasClassFamily]. const AliasClassFamilyFamily(); diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 405da9b98..55e494497 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -34,7 +34,7 @@ class _SystemHash { const fnProvider = FnFamily(); /// See also [fn]. -class FnFamily extends Family { +class FnFamily extends Family { /// See also [fn]. const FnFamily(); @@ -185,7 +185,7 @@ abstract class _$MyNotifier extends BuildlessAutoDisposeNotifier { const myNotifierProvider = MyNotifierFamily(); /// See also [MyNotifier]. -class MyNotifierFamily extends Family { +class MyNotifierFamily extends Family { /// See also [MyNotifier]. const MyNotifierFamily(); diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index 119d53d6d..6c2827ffa 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -412,7 +412,7 @@ class _SystemHash { const familyDepProvider = FamilyDepFamily(); /// See also [familyDep]. -class FamilyDepFamily extends Family { +class FamilyDepFamily extends Family { /// See also [familyDep]. const FamilyDepFamily(); @@ -545,7 +545,7 @@ String _$familyDep2Hash() => r'd81e2e56d75dd08a695b834853a3a6cea99ea305'; const familyDep2Provider = FamilyDep2Family(); /// See also [familyDep2]. -class FamilyDep2Family extends Family { +class FamilyDep2Family extends Family { /// See also [familyDep2]. const FamilyDep2Family(); From 2d2db9bd3ae5e3b46195e19be9dbbc8a906ef2b0 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 2 Oct 2023 15:42:41 +0200 Subject: [PATCH 023/387] Fix test --- .../test/golden.dart | 2 ++ .../{ => functional_ref}/functional_ref.dart | 0 .../functional_ref.g.dart | 0 .../functional_ref}/functional_ref.json | 0 .../functional_ref/functional_ref_test.dart | 35 +++++++++++++++++++ .../notifier_extends_test.dart | 23 ------------ 6 files changed, 37 insertions(+), 23 deletions(-) rename packages/riverpod_lint_flutter_test/test/lints/{ => functional_ref}/functional_ref.dart (100%) rename packages/riverpod_lint_flutter_test/test/lints/{ => functional_ref}/functional_ref.g.dart (100%) rename packages/riverpod_lint_flutter_test/test/{goldens => lints/functional_ref}/functional_ref.json (100%) create mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart diff --git a/packages/riverpod_lint_flutter_test/test/golden.dart b/packages/riverpod_lint_flutter_test/test/golden.dart index d67555a9e..646a103f8 100644 --- a/packages/riverpod_lint_flutter_test/test/golden.dart +++ b/packages/riverpod_lint_flutter_test/test/golden.dart @@ -1,6 +1,7 @@ import 'dart:convert'; import 'dart:io'; +import 'package:freezed_annotation/freezed_annotation.dart'; import 'package:test/test.dart'; import 'package:path/path.dart'; import 'package:custom_lint_core/custom_lint_core.dart'; @@ -20,6 +21,7 @@ File writeToTemporaryFile(String content) { return file; } +@isTest void testGolden( String description, String fileName, diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.dart similarity index 100% rename from packages/riverpod_lint_flutter_test/test/lints/functional_ref.dart rename to packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.dart diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart similarity index 100% rename from packages/riverpod_lint_flutter_test/test/lints/functional_ref.g.dart rename to packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart diff --git a/packages/riverpod_lint_flutter_test/test/goldens/functional_ref.json b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.json similarity index 100% rename from packages/riverpod_lint_flutter_test/test/goldens/functional_ref.json rename to packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.json diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart new file mode 100644 index 000000000..6625754c9 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart @@ -0,0 +1,35 @@ +import 'dart:io'; + +import 'package:custom_lint_builder/custom_lint_builder.dart'; +import 'package:collection/collection.dart'; +import 'package:riverpod_lint/src/lints/functional_ref.dart'; +import 'package:analyzer/dart/analysis/results.dart'; +import 'package:analyzer/dart/analysis/utilities.dart'; +import 'package:test/test.dart'; + +import '../../golden.dart'; + +void main() { + testGolden( + 'Verify that @riverpod classes extend the generated typedef', + 'lints/functional_ref/functional_ref.json', + () async { + final lint = FunctionalRef(); + final fix = lint.getFixes().single as DartFix; + final file = + File('test/lints/functional_ref/functional_ref.dart').absolute; + + final result = await resolveFile2(path: file.path); + result as ResolvedUnitResult; + + final errors = await lint.testRun(result); + expect(errors, hasLength(6)); + + final changes = await Future.wait([ + for (final error in errors) fix.testRun(result, error, errors), + ]); + + return changes.flattened; + }, + ); +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart index 4e2243d4c..41e55a5ce 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart @@ -2,7 +2,6 @@ import 'dart:io'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:collection/collection.dart'; -import 'package:riverpod_lint/src/lints/functional_ref.dart'; import 'package:riverpod_lint/src/lints/notifier_extends.dart'; import 'package:analyzer/dart/analysis/results.dart'; import 'package:analyzer/dart/analysis/utilities.dart'; @@ -34,26 +33,4 @@ void main() { return changes.flattened; }, ); - - testGolden( - 'Verify that @riverpod classes extend the generated typedef', - 'goldens/functional_ref.json', - () async { - final lint = FunctionalRef(); - final fix = lint.getFixes().single as DartFix; - final file = File('test/goldens/functional_ref.dart').absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; - - final errors = await lint.testRun(result); - expect(errors, hasLength(6)); - - final changes = await Future.wait([ - for (final error in errors) fix.testRun(result, error, errors), - ]); - - return changes.flattened; - }, - ); } From d8850a2b5730c41d83359c43b2e22fde581c35cf Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 15 Oct 2023 22:21:21 +0200 Subject: [PATCH 024/387] Fix lint tests --- .../riverpod_lint_flutter_test/build.yaml | 1 + .../failing_functional_ref.dart | 22 ++++++++++ .../lints/functional_ref/functional_ref.dart | 21 --------- .../functional_ref/functional_ref.g.dart | 44 ------------------- 4 files changed, 23 insertions(+), 65 deletions(-) create mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/failing_functional_ref.dart diff --git a/packages/riverpod_lint_flutter_test/build.yaml b/packages/riverpod_lint_flutter_test/build.yaml index 354797122..7e00739e5 100644 --- a/packages/riverpod_lint_flutter_test/build.yaml +++ b/packages/riverpod_lint_flutter_test/build.yaml @@ -7,3 +7,4 @@ targets: # Those files voluntarily have the generation fail - test/lints/notifier_build/notifier_build.dart - test/lints/notifier_build/fix/notifier_build.dart + - test/lints/functional_ref/failing_functional_ref.dart diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/failing_functional_ref.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/failing_functional_ref.dart new file mode 100644 index 000000000..984c3acf7 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/failing_functional_ref.dart @@ -0,0 +1,22 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@riverpod +// expect_lint: functional_ref +int refless() { + return 0; +} + +@riverpod +int incorrectlyTyped( + // expect_lint: functional_ref + int ref, +) { + return 0; +} + +// Regression test for https://github.com/rrousselGit/riverpod/issues/2689 +@riverpod +// expect_lint: functional_ref +int noRefButArgs({int a = 42}) { + return 0; +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.dart index b043b607e..8a3268ae3 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.dart @@ -2,12 +2,6 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'functional_ref.g.dart'; -@riverpod -// expect_lint: functional_ref -int refless() { - return 0; -} - @riverpod int nameless( // expect_lint: functional_ref @@ -16,14 +10,6 @@ int nameless( return 0; } -@riverpod -int incorrectlyTyped( - // expect_lint: functional_ref - int ref, -) { - return 0; -} - @riverpod external int scoped(); @@ -41,10 +27,3 @@ int missingGenerics(MissingGenericsRef ref) => 0; @riverpod // expect_lint: functional_ref int wrongOrder(WrongOrderRef ref) => 0; - -// Regression test for https://github.com/rrousselGit/riverpod/issues/2689 -@riverpod -// expect_lint: functional_ref -int noRefButArgs({int a = 42}) { - return 0; -} diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 9e769f10e..57b6200ab 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -6,20 +6,6 @@ part of 'functional_ref.dart'; // RiverpodGenerator // ************************************************************************** -String _$reflessHash() => r'45894f451ae8fab59805fce9bd8292f2b5db1618'; - -/// See also [refless]. -@ProviderFor(refless) -final reflessProvider = AutoDisposeProvider.internal( - refless, - name: r'reflessProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$reflessHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ReflessRef = AutoDisposeProviderRef; String _$namelessHash() => r'1a2aa61445a64c65301051820b159c5998195606'; /// See also [nameless]. @@ -34,21 +20,6 @@ final namelessProvider = AutoDisposeProvider.internal( ); typedef NamelessRef = AutoDisposeProviderRef; -String _$incorrectlyTypedHash() => r'36b38a6d23ff56629e8d18e1764a957495953ac0'; - -/// See also [incorrectlyTyped]. -@ProviderFor(incorrectlyTyped) -final incorrectlyTypedProvider = AutoDisposeProvider.internal( - incorrectlyTyped, - name: r'incorrectlyTypedProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$incorrectlyTypedHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef IncorrectlyTypedRef = AutoDisposeProviderRef; String _$scopedHash() => r'590f1a203323105e732397a2616fbd7dac65f0cc'; /// See also [scoped]. @@ -549,20 +520,5 @@ class _WrongOrderProviderElement extends AutoDisposeProviderElement with WrongOrderRef { _WrongOrderProviderElement(super.provider); } - -String _$noRefButArgsHash() => r'462ab15f4053f3e9592557cc8a698fbb2352bd40'; - -/// See also [noRefButArgs]. -@ProviderFor(noRefButArgs) -final noRefButArgsProvider = AutoDisposeProvider.internal( - noRefButArgs, - name: r'noRefButArgsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$noRefButArgsHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef NoRefButArgsRef = AutoDisposeProviderRef; // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package From f794275aae93fd09ffb8b5b7d92c32c1bf29711f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 15 Oct 2023 22:26:25 +0200 Subject: [PATCH 025/387] Update changelogs --- packages/riverpod/CHANGELOG.md | 2 +- packages/riverpod_generator/CHANGELOG.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 4bc04b855..1b53e060c 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased major +## Unreleased 3.0.0-dev.0 - **Breaking**: `AsyncValue` is now "sealed" and `AsyncData/AsyncLoading/AsyncError` are "final". This means that it is no-longer possible to subclass diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index d73ebdacb..106619b8f 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased increment +## Unreleased 3.0.0-dev.5 - Providers can now be generic: From 6f898c0c83cb1d1df111ae22e89eb19bea3f3384 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 28 Oct 2023 17:45:43 +0200 Subject: [PATCH 026/387] Sync dev with master (#3050) --- .github/workflows/build.yml | 1 + .github/workflows/changelog.yml | 32 +++++++++++++++++++ .github/workflows/check_generation.yml | 1 + .github/workflows/riverpod_lint.yml | 1 + .../build_yaml/test/build_yaml_test.dart | 28 ++++++++++++++++ 5 files changed, 63 insertions(+) create mode 100644 .github/workflows/changelog.yml create mode 100644 packages/riverpod_generator/integration/build_yaml/test/build_yaml_test.dart diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 0a817f2ab..ab80d18f1 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -8,6 +8,7 @@ on: push: branches: - master + - dev paths-ignore: - "**.md" - "**.mdx" diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml new file mode 100644 index 000000000..86765bcbe --- /dev/null +++ b/.github/workflows/changelog.yml @@ -0,0 +1,32 @@ +name: Check CHANGELOG.md + +on: + push: + branches: + - master + - dev + pull_request: + + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3.1.0 + with: + fetch-depth: 2 + - uses: subosito/flutter-action@v2.7.1 + with: + channel: master + + - name: Add pub cache bin to PATH + run: echo "$HOME/.pub-cache/bin" >> $GITHUB_PATH + - name: Add pub cache to PATH + run: echo "PUB_CACHE="$HOME/.pub-cache"" >> $GITHUB_ENV + + - name: Install "semantic_changelog" + run: dart pub global activate -s git https://github.com/rrousselGit/semantic_changelog + + - run: git fetch origin master:refs/remotes/origin/master + - run: semantic_changelog check origin/master \ No newline at end of file diff --git a/.github/workflows/check_generation.yml b/.github/workflows/check_generation.yml index 2c6679327..629ab50cd 100644 --- a/.github/workflows/check_generation.yml +++ b/.github/workflows/check_generation.yml @@ -7,6 +7,7 @@ on: push: branches: - master + - dev paths-ignore: - "**.md" diff --git a/.github/workflows/riverpod_lint.yml b/.github/workflows/riverpod_lint.yml index 3747dcec7..ae92a03b8 100644 --- a/.github/workflows/riverpod_lint.yml +++ b/.github/workflows/riverpod_lint.yml @@ -7,6 +7,7 @@ on: push: branches: - master + - dev paths-ignore: - "**.md" schedule: diff --git a/packages/riverpod_generator/integration/build_yaml/test/build_yaml_test.dart b/packages/riverpod_generator/integration/build_yaml/test/build_yaml_test.dart new file mode 100644 index 000000000..f03578c84 --- /dev/null +++ b/packages/riverpod_generator/integration/build_yaml/test/build_yaml_test.dart @@ -0,0 +1,28 @@ +import 'package:build_yaml/main.dart'; +import 'package:test/test.dart'; + +void main() { + test('provider names', () { + expect(countPod.name, 'countPod'); + expect(countFuturePod.name, 'countFuturePod'); + expect(countStreamPod.name, 'countStreamPod'); + expect(countNotifierPod.name, 'countNotifierPod'); + expect(countAsyncNotifierPod.name, 'countAsyncNotifierPod'); + expect(countStreamNotifierPod.name, 'countStreamNotifierPod'); + }); + + test('provider family names', () { + expect(count2ProviderFamily.name, 'count2ProviderFamily'); + expect(countFuture2ProviderFamily.name, 'countFuture2ProviderFamily'); + expect(countStream2ProviderFamily.name, 'countStream2ProviderFamily'); + expect(countNotifier2ProviderFamily.name, 'countNotifier2ProviderFamily'); + expect( + countAsyncNotifier2ProviderFamily.name, + 'countAsyncNotifier2ProviderFamily', + ); + expect( + countStreamNotifier2ProviderFamily.name, + 'countStreamNotifier2ProviderFamily', + ); + }); +} From a3cbacd5ad37f199504bb0cffbd1f9f42d728273 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 29 Oct 2023 02:39:32 +0100 Subject: [PATCH 027/387] Revert "Revert "Revert e0360815e8b28b2e2e9cd9e18fa4f291493acef9 (#3052)"" This reverts commit e81f93c34a833711c34de8e67f5469b55b23741e. --- examples/counter/lib/main.g.dart | 2 +- examples/pub/lib/detail.g.dart | 125 +- examples/pub/lib/search.g.dart | 70 +- packages/riverpod_generator/CHANGELOG.md | 39 + packages/riverpod_generator/README.md | 5 +- .../integration/build_yaml/README.md | 2 +- .../integration/build_yaml/lib/main.g.dart | 352 ++++- .../integration/build_yaml/pubspec.yaml | 3 +- .../lib/src/parse_generator.dart | 5 +- .../lib/src/riverpod_generator.dart | 23 +- .../src/templates/class_based_provider.dart | 1 + .../lib/src/templates/family.dart | 87 +- .../src/templates/functional_provider.dart | 1 + .../lib/src/templates/parameters.dart | 57 +- packages/riverpod_generator/pubspec.yaml | 8 +- .../test/annotated_test.dart | 89 ++ .../riverpod_generator/test/async_test.dart | 33 + .../test/integration/annotated.dart | 40 + .../test/integration/annotated.g.dart | 439 ++++++ .../test/integration/async.g.dart | 273 +++- .../test/integration/auto_dispose.g.dart | 2 +- .../test/integration/dependencies.g.dart | 203 ++- .../test/integration/dependencies2.g.dart | 172 ++- .../test/integration/generated.dart | 83 + .../test/integration/generated.freezed.dart | 74 + .../test/integration/generated.g.dart | 1352 +++++++++++++++++ .../test/integration/hash/hash1.g.dart | 2 +- .../test/integration/scopes.g.dart | 2 +- .../test/integration/split.dart | 2 +- .../test/integration/split.g.dart | 2 +- .../test/integration/stream.g.dart | 156 +- .../test/integration/sync.g.dart | 393 ++++- .../riverpod_generator/test/stream_test.dart | 34 + .../riverpod_generator/test/sync_test.dart | 66 +- .../generated/golden/lib/sync.g.dart | 155 +- ..._class_based_provider_to_functional.g.dart | 68 +- ..._functional_provider_to_class_based.g.dart | 68 +- .../test/lints/another.g.dart | 2 +- .../avoid_build_context_in_providers.g.dart | 134 +- .../avoid_public_notifier_properties.g.dart | 59 +- .../test/lints/dependencies.g.dart | 144 +- .../notifier_extends/notifier_extends.g.dart | 2 +- .../protected_notifier_properties.g.dart | 344 ++++- .../provider_dependencies.g.dart | 2 +- .../test/lints/provider_parameters.g.dart | 63 +- ...oviders_should_specify_dependencies.g.dart | 2 +- .../lints/unsupported_provider_value.g.dart | 2 +- .../advanced/select/select/codegen.g.dart | 2 +- .../select/select_async/codegen.g.dart | 2 +- .../fetch_activity/codegen.g.dart | 2 +- .../pull_to_refresh/full_app/codegen.g.dart | 2 +- .../docs/concepts/about_codegen/main.g.dart | 63 +- .../provider_type/async_class_future.g.dart | 2 +- .../provider_type/async_class_stream.g.dart | 2 +- .../provider_type/async_fn_future.g.dart | 2 +- .../provider_type/async_fn_stream.g.dart | 2 +- .../provider_type/auto_dispose.g.dart | 2 +- .../about_codegen/provider_type/family.g.dart | 61 +- .../provider_type/family_class.g.dart | 68 +- .../provider_type/family_fn.g.dart | 68 +- .../provider_type/sync_class.g.dart | 2 +- .../provider_type/sync_fn.g.dart | 2 +- .../characters_provider/codegen.g.dart | 2 +- .../city_provider/codegen.g.dart | 2 +- .../codegen.g.dart | 2 +- .../read_in_provider/codegen.g.dart | 2 +- .../select_async_provider/codegen.g.dart | 2 +- .../todo_list_provider/codegen.g.dart | 2 +- .../weather_provider/codegen.g.dart | 2 +- .../whole_object_provider/codegen.g.dart | 2 +- .../lifecycle_on_dispose/codegen.g.dart | 2 +- .../creating_a_provider/codegen.g.dart | 2 +- .../declaring_many_providers/codegen.g.dart | 2 +- .../concepts/reading/counter/codegen.g.dart | 2 +- .../concepts/reading/listen/codegen.g.dart | 2 +- .../reading/listen_build/codegen.g.dart | 2 +- .../reading/listen_build/codegen_hooks.g.dart | 2 +- .../concepts/reading/provider/codegen.g.dart | 2 +- .../docs/concepts/reading/read/codegen.g.dart | 2 +- .../reading/read/codegen_hooks.g.dart | 2 +- .../reading/read_build/codegen.g.dart | 2 +- .../read_notifier_build/codegen.g.dart | 2 +- .../concepts/reading/watch/codegen.g.dart | 2 +- .../reading/watch_build/codegen.g.dart | 2 +- .../reading/watch_build/codegen_hooks.g.dart | 2 +- .../watch_notifier_build/codegen.g.dart | 2 +- .../concepts/why_immutability/codegen.g.dart | 2 +- .../cache_for_usage/codegen.g.dart | 2 +- .../auto_dispose/codegen_keep_alive.g.dart | 2 +- .../invalidate_family_example/codegen.g.dart | 61 +- .../auto_dispose/keep_alive/codegen.g.dart | 2 +- .../on_dispose_example/codegen.g.dart | 2 +- .../functional_ref/codegen.g.dart | 2 +- .../listen_example/codegen.g.dart | 2 +- .../notifier_ref/codegen.g.dart | 2 +- .../read_example/codegen.g.dart | 2 +- .../watch_example/codegen.g.dart | 2 +- .../watch_placement/codegen.g.dart | 2 +- .../require_value/codegen.g.dart | 2 +- .../first_request/codegen/provider.g.dart | 2 +- .../passing_args/codegen/family.g.dart | 61 +- .../passing_args/codegen/provider.g.dart | 2 +- .../codegen/todo_list_notifier.g.dart | 2 +- .../todo_list_notifier_add_todo.g.dart | 2 +- .../codegen/todo_list_provider.g.dart | 2 +- .../testing/notifier_mock/codegen.g.dart | 2 +- .../testing/provider_to_mock/codegen.g.dart | 2 +- .../pipe_change_notifier.g.dart | 2 +- .../websockets_sync/raw_usage.g.dart | 2 +- .../shared_pipe_change_notifier.g.dart | 2 +- .../stream_provider/codegen.g.dart | 2 +- .../sync_definition/codegen.g.dart | 2 +- .../docs/from_provider/family/family.g.dart | 68 +- .../async_values/async_values.g.dart | 2 +- .../auto_dispose/auto_dispose.g.dart | 2 +- .../motivation/combine/combine.g.dart | 2 +- .../motivation/same_type/same_type.g.dart | 2 +- .../dart_hello_world/main.g.dart | 2 +- .../hello_world/hooks_codegen/main.g.dart | 2 +- .../getting_started/hello_world/main.g.dart | 2 +- .../introduction/why_riverpod/codegen.g.dart | 70 +- .../declaration/declaration.g.dart | 2 +- .../initialization/initialization.g.dart | 2 +- .../migrated/migrated.g.dart | 2 +- .../add_listener/add_listener.g.dart | 2 +- .../async_notifier/async_notifier.g.dart | 2 +- .../build_init/build_init.g.dart | 2 +- .../family_and_dispose.g.dart | 60 +- .../from_state_provider.g.dart | 2 +- .../old_lifecycles/old_lifecycles.g.dart | 2 +- .../old_lifecycles_final.g.dart | 2 +- .../config_provider/codegen.g.dart | 2 +- .../remote_todos/codegen.g.dart | 2 +- .../notifier_provider/todos/codegen.g.dart | 2 +- .../completed_todos/completed_todos.g.dart | 2 +- .../optimized_previous_button.g.dart | 2 +- .../docs/providers/provider/todo/todo.g.dart | 2 +- .../unoptimized_previous_button.g.dart | 2 +- .../live_stream_chat_provider/codegen.g.dart | 2 +- .../current/about_codegen/main.g.dart | 63 +- .../dart_hello_world/main.g.dart | 2 +- .../getting_started/hello_world/main.g.dart | 2 +- .../remote_todos/codegen.g.dart | 2 +- .../notifier_provider/todos/codegen.g.dart | 2 +- .../current/about_codegen/main.g.dart | 63 +- .../dart_hello_world/main.g.dart | 2 +- .../getting_started/hello_world/main.g.dart | 2 +- .../current/about_codegen/main.g.dart | 63 +- .../dart_hello_world/main.g.dart | 2 +- .../getting_started/hello_world/main.g.dart | 2 +- .../config_provider/codegen.g.dart | 2 +- .../current/about_codegen/main.g.dart | 63 +- .../lifecycle_on_dispose/codegen.g.dart | 2 +- .../concepts/reading/counter/codegen.g.dart | 2 +- .../concepts/reading/listen/codegen.g.dart | 2 +- .../reading/listen_build/codegen.g.dart | 2 +- .../concepts/reading/provider/codegen.g.dart | 2 +- .../concepts/reading/read/codegen.g.dart | 2 +- .../reading/read_build/codegen.g.dart | 2 +- .../read_notifier_build/codegen.g.dart | 2 +- .../concepts/reading/watch/codegen.g.dart | 2 +- .../reading/watch_build/codegen.g.dart | 2 +- .../watch_notifier_build/codegen.g.dart | 2 +- .../dart_hello_world/main.g.dart | 2 +- .../getting_started/hello_world/main.g.dart | 2 +- .../hello_world/main_hooks.g.dart | 2 +- .../config_provider/codegen.g.dart | 2 +- .../remote_todos/codegen.g.dart | 2 +- .../notifier_provider/todos/codegen.g.dart | 2 +- .../completed_todos/completed_todos.g.dart | 2 +- .../optimized_previous_button.g.dart | 2 +- .../providers/provider/todo/todo.g.dart | 2 +- .../unoptimized_previous_button.g.dart | 2 +- website/static/snippets/async.g.dart | 2 +- website/static/snippets/combine.g.dart | 2 +- website/static/snippets/create.g.dart | 2 +- website/static/snippets/declare.g.dart | 2 +- 177 files changed, 5589 insertions(+), 719 deletions(-) create mode 100644 packages/riverpod_generator/test/annotated_test.dart create mode 100644 packages/riverpod_generator/test/integration/annotated.dart create mode 100644 packages/riverpod_generator/test/integration/annotated.g.dart create mode 100644 packages/riverpod_generator/test/integration/generated.dart create mode 100644 packages/riverpod_generator/test/integration/generated.freezed.dart create mode 100644 packages/riverpod_generator/test/integration/generated.g.dart diff --git a/examples/counter/lib/main.g.dart b/examples/counter/lib/main.g.dart index 9450b6ad2..deb83f61c 100644 --- a/examples/counter/lib/main.g.dart +++ b/examples/counter/lib/main.g.dart @@ -26,4 +26,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 8a246b6d4..748b6e3fa 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -41,6 +41,20 @@ class FetchPackageDetailsFamily extends Family { /// See also [fetchPackageDetails]. const FetchPackageDetailsFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'fetchPackageDetailsProvider'; + /// See also [fetchPackageDetails]. FetchPackageDetailsProvider call({ required String packageName, @@ -50,6 +64,7 @@ class FetchPackageDetailsFamily extends Family { ); } + @visibleForOverriding @override FetchPackageDetailsProvider getProviderOverride( covariant FetchPackageDetailsProvider provider, @@ -59,19 +74,28 @@ class FetchPackageDetailsFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith( + FutureOr Function(FetchPackageDetailsRef ref) create) { + return _$FetchPackageDetailsFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FetchPackageDetailsFamilyOverride + implements FamilyOverride> { + _$FetchPackageDetailsFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FutureOr Function(FetchPackageDetailsRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FetchPackageDetailsFamily overriddenFamily; @override - String? get name => r'fetchPackageDetailsProvider'; + FetchPackageDetailsProvider getProviderOverride( + covariant FetchPackageDetailsProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [fetchPackageDetails]. @@ -97,7 +121,7 @@ class FetchPackageDetailsProvider extends AutoDisposeFutureProvider { ); FetchPackageDetailsProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -110,7 +134,7 @@ class FetchPackageDetailsProvider extends AutoDisposeFutureProvider { @override Override overrideWith( - FutureOr Function(FetchPackageDetailsRef provider) create, + FutureOr Function(FetchPackageDetailsRef ref) create, ) { return ProviderOverride( origin: this, @@ -126,11 +150,32 @@ class FetchPackageDetailsProvider extends AutoDisposeFutureProvider { ); } + @override + ({ + String packageName, + }) get argument { + return (packageName: packageName,); + } + @override AutoDisposeFutureProviderElement createElement() { return _FetchPackageDetailsProviderElement(this); } + FetchPackageDetailsProvider _copyWith( + FutureOr Function(FetchPackageDetailsRef ref) create, + ) { + return FetchPackageDetailsProvider._internal( + (ref) => create(ref as FetchPackageDetailsRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + packageName: packageName, + ); + } + @override bool operator ==(Object other) { return other is FetchPackageDetailsProvider && @@ -228,6 +273,20 @@ class PackageMetricsFamily extends Family { /// Copied from [PackageMetrics]. const PackageMetricsFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'packageMetricsProvider'; + /// A provider that fetches the likes count, popularity score and pub points /// for a given package. /// @@ -243,6 +302,7 @@ class PackageMetricsFamily extends Family { ); } + @visibleForOverriding @override PackageMetricsProvider getProviderOverride( covariant PackageMetricsProvider provider, @@ -252,19 +312,27 @@ class PackageMetricsFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(PackageMetrics Function() create) { + return _$PackageMetricsFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$PackageMetricsFamilyOverride + implements FamilyOverride> { + _$PackageMetricsFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final PackageMetrics Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final PackageMetricsFamily overriddenFamily; @override - String? get name => r'packageMetricsProvider'; + PackageMetricsProvider getProviderOverride( + covariant PackageMetricsProvider provider, + ) { + return provider._copyWith(create); + } } /// A provider that fetches the likes count, popularity score and pub points @@ -300,7 +368,7 @@ class PackageMetricsProvider extends AutoDisposeAsyncNotifierProviderImpl< ); PackageMetricsProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -336,12 +404,33 @@ class PackageMetricsProvider extends AutoDisposeAsyncNotifierProviderImpl< ); } + @override + ({ + String packageName, + }) get argument { + return (packageName: packageName,); + } + @override AutoDisposeAsyncNotifierProviderElement createElement() { return _PackageMetricsProviderElement(this); } + PackageMetricsProvider _copyWith( + PackageMetrics Function() create, + ) { + return PackageMetricsProvider._internal( + () => create()..packageName = packageName, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + packageName: packageName, + ); + } + @override bool operator ==(Object other) { return other is PackageMetricsProvider && other.packageName == packageName; @@ -371,4 +460,4 @@ class _PackageMetricsProviderElement String get packageName => (origin as PackageMetricsProvider).packageName; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 14b93d5bd..c9161f8a6 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -40,6 +40,20 @@ class FetchPackagesFamily extends Family { /// See also [fetchPackages]. const FetchPackagesFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'fetchPackagesProvider'; + /// See also [fetchPackages]. FetchPackagesProvider call({ required int page, @@ -51,6 +65,7 @@ class FetchPackagesFamily extends Family { ); } + @visibleForOverriding @override FetchPackagesProvider getProviderOverride( covariant FetchPackagesProvider provider, @@ -61,19 +76,28 @@ class FetchPackagesFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith( + FutureOr> Function(FetchPackagesRef ref) create) { + return _$FetchPackagesFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FetchPackagesFamilyOverride + implements FamilyOverride>> { + _$FetchPackagesFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FutureOr> Function(FetchPackagesRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FetchPackagesFamily overriddenFamily; @override - String? get name => r'fetchPackagesProvider'; + FetchPackagesProvider getProviderOverride( + covariant FetchPackagesProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [fetchPackages]. @@ -102,7 +126,7 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { ); FetchPackagesProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -117,7 +141,7 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { @override Override overrideWith( - FutureOr> Function(FetchPackagesRef provider) create, + FutureOr> Function(FetchPackagesRef ref) create, ) { return ProviderOverride( origin: this, @@ -134,11 +158,37 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { ); } + @override + ({ + int page, + String search, + }) get argument { + return ( + page: page, + search: search, + ); + } + @override AutoDisposeFutureProviderElement> createElement() { return _FetchPackagesProviderElement(this); } + FetchPackagesProvider _copyWith( + FutureOr> Function(FetchPackagesRef ref) create, + ) { + return FetchPackagesProvider._internal( + (ref) => create(ref as FetchPackagesRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + page: page, + search: search, + ); + } + @override bool operator ==(Object other) { return other is FetchPackagesProvider && @@ -175,4 +225,4 @@ class _FetchPackagesProviderElement String get search => (origin as FetchPackagesProvider).search; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 7d84a1b23..8e70702a1 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -23,6 +23,45 @@ ``` - Upgraded to use Riverpod 3.0 +- Fixed `family.overrideWith` missing + +## 3.0.0-dev.5 - 2023-10-21 + +- `riverpod_analyzer_utils` upgraded to `0.4.2` + +## 3.0.0-dev.4 - 2023-10-15 + +- Annotating a provider with `@deprecated` and a few other annotations + also annotate the generated code accordingly (thanks to @SunlightBro) +- `provider.argument` is now a record of all arguments in a provider. + +## 3.0.0-dev.3 - 2023-10-06 + +- `riverpod_analyzer_utils` upgraded to `0.4.1` +- `riverpod_annotation` upgraded to `2.2.0` + +## 3.0.0-dev.2 - 2023-10-02 + +- `riverpod_analyzer_utils` upgraded to `0.4.0` + +## 3.0.0-dev.1 - 2023-10-02 + +The code generator now supports import aliases, generated types and typedefs +as input of providers!. + +This comes with a few minor restrictions: + +- **Breaking**: Returning a Typedef or type Future/FutureOr/Stream is no-longer supported: + + ```dart + typedef Example = Future; + + @riverpod + Example foo(FooRef ref) async => 0; + ``` + +- **Breaking**: Arguments of the form `fn(void myParameter())` + are no-longer supported. Instead use `fn(void Function() myParameter)`. ## 2.3.5 - 2023-10-21 diff --git a/packages/riverpod_generator/README.md b/packages/riverpod_generator/README.md index 448dc72b7..e370df6bd 100644 --- a/packages/riverpod_generator/README.md +++ b/packages/riverpod_generator/README.md @@ -86,9 +86,10 @@ over the default Riverpod syntax. - [Riverpod generator](#riverpod-generator) - [Getting started](#getting-started) - - [Installing riverpod_generator](#installing-riverpod_generator) + - [Installing riverpod\_generator](#installing-riverpod_generator) - [Starting the code generator](#starting-the-code-generator) - [Defining our first "provider"](#defining-our-first-provider) + - [Global configuration](#global-configuration) # Getting started @@ -98,7 +99,7 @@ To install riverpod_generator, edit your `pubspec.yaml` and add the following: ```yaml dependencies: - # or flutter_riverpod/hooks_riverpod as per https://riverpod.dev/docs/getting_started + # or flutter_riverpod/hooks_riverpod as per https://riverpod.dev/docs/introduction/getting_started riverpod: # the annotation package containing @riverpod riverpod_annotation: diff --git a/packages/riverpod_generator/integration/build_yaml/README.md b/packages/riverpod_generator/integration/build_yaml/README.md index ad4d3b1bd..50f850fb4 100644 --- a/packages/riverpod_generator/integration/build_yaml/README.md +++ b/packages/riverpod_generator/integration/build_yaml/README.md @@ -10,7 +10,7 @@ dart pub global activate melos Build the riverpod packages ```bash -fluttter pub get +flutter pub get ``` ## Start the tests diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 6d8370c4f..45ddb938a 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -80,6 +80,20 @@ class Count2Family extends Family { /// See also [count2]. const Count2Family(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'count2ProviderFamily'; + /// See also [count2]. Count2Provider call( int a, @@ -89,6 +103,7 @@ class Count2Family extends Family { ); } + @visibleForOverriding @override Count2Provider getProviderOverride( covariant Count2Provider provider, @@ -98,19 +113,26 @@ class Count2Family extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(int Function(Count2Ref ref) create) { + return _$Count2FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$Count2FamilyOverride implements FamilyOverride { + _$Count2FamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final int Function(Count2Ref ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final Count2Family overriddenFamily; @override - String? get name => r'count2ProviderFamily'; + Count2Provider getProviderOverride( + covariant Count2Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [count2]. @@ -135,7 +157,7 @@ class Count2Provider extends AutoDisposeProvider { ); Count2Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -148,7 +170,7 @@ class Count2Provider extends AutoDisposeProvider { @override Override overrideWith( - int Function(Count2Ref provider) create, + int Function(Count2Ref ref) create, ) { return ProviderOverride( origin: this, @@ -164,11 +186,30 @@ class Count2Provider extends AutoDisposeProvider { ); } + @override + (int,) get argument { + return (a,); + } + @override AutoDisposeProviderElement createElement() { return _Count2ProviderElement(this); } + Count2Provider _copyWith( + int Function(Count2Ref ref) create, + ) { + return Count2Provider._internal( + (ref) => create(ref as Count2Ref), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + a: a, + ); + } + @override bool operator ==(Object other) { return other is Count2Provider && other.a == a; @@ -207,6 +248,20 @@ class CountFuture2Family extends Family { /// See also [countFuture2]. const CountFuture2Family(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'countFuture2ProviderFamily'; + /// See also [countFuture2]. CountFuture2Provider call( int a, @@ -216,6 +271,7 @@ class CountFuture2Family extends Family { ); } + @visibleForOverriding @override CountFuture2Provider getProviderOverride( covariant CountFuture2Provider provider, @@ -225,19 +281,26 @@ class CountFuture2Family extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FutureOr Function(CountFuture2Ref ref) create) { + return _$CountFuture2FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$CountFuture2FamilyOverride implements FamilyOverride> { + _$CountFuture2FamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FutureOr Function(CountFuture2Ref ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final CountFuture2Family overriddenFamily; @override - String? get name => r'countFuture2ProviderFamily'; + CountFuture2Provider getProviderOverride( + covariant CountFuture2Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [countFuture2]. @@ -263,7 +326,7 @@ class CountFuture2Provider extends AutoDisposeFutureProvider { ); CountFuture2Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -276,7 +339,7 @@ class CountFuture2Provider extends AutoDisposeFutureProvider { @override Override overrideWith( - FutureOr Function(CountFuture2Ref provider) create, + FutureOr Function(CountFuture2Ref ref) create, ) { return ProviderOverride( origin: this, @@ -292,11 +355,30 @@ class CountFuture2Provider extends AutoDisposeFutureProvider { ); } + @override + (int,) get argument { + return (a,); + } + @override AutoDisposeFutureProviderElement createElement() { return _CountFuture2ProviderElement(this); } + CountFuture2Provider _copyWith( + FutureOr Function(CountFuture2Ref ref) create, + ) { + return CountFuture2Provider._internal( + (ref) => create(ref as CountFuture2Ref), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + a: a, + ); + } + @override bool operator ==(Object other) { return other is CountFuture2Provider && other.a == a; @@ -335,6 +417,20 @@ class CountStream2Family extends Family { /// See also [countStream2]. const CountStream2Family(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'countStream2ProviderFamily'; + /// See also [countStream2]. CountStream2Provider call( int a, @@ -344,6 +440,7 @@ class CountStream2Family extends Family { ); } + @visibleForOverriding @override CountStream2Provider getProviderOverride( covariant CountStream2Provider provider, @@ -353,19 +450,26 @@ class CountStream2Family extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(Stream Function(CountStream2Ref ref) create) { + return _$CountStream2FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$CountStream2FamilyOverride implements FamilyOverride> { + _$CountStream2FamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final Stream Function(CountStream2Ref ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final CountStream2Family overriddenFamily; @override - String? get name => r'countStream2ProviderFamily'; + CountStream2Provider getProviderOverride( + covariant CountStream2Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [countStream2]. @@ -391,7 +495,7 @@ class CountStream2Provider extends AutoDisposeStreamProvider { ); CountStream2Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -404,7 +508,7 @@ class CountStream2Provider extends AutoDisposeStreamProvider { @override Override overrideWith( - Stream Function(CountStream2Ref provider) create, + Stream Function(CountStream2Ref ref) create, ) { return ProviderOverride( origin: this, @@ -420,11 +524,30 @@ class CountStream2Provider extends AutoDisposeStreamProvider { ); } + @override + (int,) get argument { + return (a,); + } + @override AutoDisposeStreamProviderElement createElement() { return _CountStream2ProviderElement(this); } + CountStream2Provider _copyWith( + Stream Function(CountStream2Ref ref) create, + ) { + return CountStream2Provider._internal( + (ref) => create(ref as CountStream2Ref), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + a: a, + ); + } + @override bool operator ==(Object other) { return other is CountStream2Provider && other.a == a; @@ -521,6 +644,20 @@ class CountNotifier2Family extends Family { /// See also [CountNotifier2]. const CountNotifier2Family(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'countNotifier2ProviderFamily'; + /// See also [CountNotifier2]. CountNotifier2Provider call( int a, @@ -530,6 +667,7 @@ class CountNotifier2Family extends Family { ); } + @visibleForOverriding @override CountNotifier2Provider getProviderOverride( covariant CountNotifier2Provider provider, @@ -539,19 +677,26 @@ class CountNotifier2Family extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(CountNotifier2 Function() create) { + return _$CountNotifier2FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$CountNotifier2FamilyOverride implements FamilyOverride { + _$CountNotifier2FamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final CountNotifier2 Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final CountNotifier2Family overriddenFamily; @override - String? get name => r'countNotifier2ProviderFamily'; + CountNotifier2Provider getProviderOverride( + covariant CountNotifier2Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [CountNotifier2]. @@ -575,7 +720,7 @@ class CountNotifier2Provider ); CountNotifier2Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -611,11 +756,30 @@ class CountNotifier2Provider ); } + @override + (int,) get argument { + return (a,); + } + @override AutoDisposeNotifierProviderElement createElement() { return _CountNotifier2ProviderElement(this); } + CountNotifier2Provider _copyWith( + CountNotifier2 Function() create, + ) { + return CountNotifier2Provider._internal( + () => create()..a = a, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + a: a, + ); + } + @override bool operator ==(Object other) { return other is CountNotifier2Provider && other.a == a; @@ -665,6 +829,20 @@ class CountAsyncNotifier2Family extends Family { /// See also [CountAsyncNotifier2]. const CountAsyncNotifier2Family(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'countAsyncNotifier2ProviderFamily'; + /// See also [CountAsyncNotifier2]. CountAsyncNotifier2Provider call( int a, @@ -674,6 +852,7 @@ class CountAsyncNotifier2Family extends Family { ); } + @visibleForOverriding @override CountAsyncNotifier2Provider getProviderOverride( covariant CountAsyncNotifier2Provider provider, @@ -683,19 +862,27 @@ class CountAsyncNotifier2Family extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(CountAsyncNotifier2 Function() create) { + return _$CountAsyncNotifier2FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$CountAsyncNotifier2FamilyOverride + implements FamilyOverride> { + _$CountAsyncNotifier2FamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final CountAsyncNotifier2 Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final CountAsyncNotifier2Family overriddenFamily; @override - String? get name => r'countAsyncNotifier2ProviderFamily'; + CountAsyncNotifier2Provider getProviderOverride( + covariant CountAsyncNotifier2Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [CountAsyncNotifier2]. @@ -719,7 +906,7 @@ class CountAsyncNotifier2Provider ); CountAsyncNotifier2Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -755,12 +942,31 @@ class CountAsyncNotifier2Provider ); } + @override + (int,) get argument { + return (a,); + } + @override AutoDisposeAsyncNotifierProviderElement createElement() { return _CountAsyncNotifier2ProviderElement(this); } + CountAsyncNotifier2Provider _copyWith( + CountAsyncNotifier2 Function() create, + ) { + return CountAsyncNotifier2Provider._internal( + () => create()..a = a, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + a: a, + ); + } + @override bool operator ==(Object other) { return other is CountAsyncNotifier2Provider && other.a == a; @@ -810,6 +1016,20 @@ class CountStreamNotifier2Family extends Family { /// See also [CountStreamNotifier2]. const CountStreamNotifier2Family(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'countStreamNotifier2ProviderFamily'; + /// See also [CountStreamNotifier2]. CountStreamNotifier2Provider call( int a, @@ -819,6 +1039,7 @@ class CountStreamNotifier2Family extends Family { ); } + @visibleForOverriding @override CountStreamNotifier2Provider getProviderOverride( covariant CountStreamNotifier2Provider provider, @@ -828,19 +1049,27 @@ class CountStreamNotifier2Family extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(CountStreamNotifier2 Function() create) { + return _$CountStreamNotifier2FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$CountStreamNotifier2FamilyOverride + implements FamilyOverride> { + _$CountStreamNotifier2FamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final CountStreamNotifier2 Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final CountStreamNotifier2Family overriddenFamily; @override - String? get name => r'countStreamNotifier2ProviderFamily'; + CountStreamNotifier2Provider getProviderOverride( + covariant CountStreamNotifier2Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [CountStreamNotifier2]. @@ -864,7 +1093,7 @@ class CountStreamNotifier2Provider ); CountStreamNotifier2Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -900,12 +1129,31 @@ class CountStreamNotifier2Provider ); } + @override + (int,) get argument { + return (a,); + } + @override AutoDisposeStreamNotifierProviderElement createElement() { return _CountStreamNotifier2ProviderElement(this); } + CountStreamNotifier2Provider _copyWith( + CountStreamNotifier2 Function() create, + ) { + return CountStreamNotifier2Provider._internal( + () => create()..a = a, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + a: a, + ); + } + @override bool operator ==(Object other) { return other is CountStreamNotifier2Provider && other.a == a; @@ -934,4 +1182,4 @@ class _CountStreamNotifier2ProviderElement int get a => (origin as CountStreamNotifier2Provider).a; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/integration/build_yaml/pubspec.yaml b/packages/riverpod_generator/integration/build_yaml/pubspec.yaml index 519d94960..c63b70ab6 100644 --- a/packages/riverpod_generator/integration/build_yaml/pubspec.yaml +++ b/packages/riverpod_generator/integration/build_yaml/pubspec.yaml @@ -3,7 +3,7 @@ description: A sample command-line application. publish_to: none environment: - sdk: ">=2.18.4 <3.0.0" + sdk: ">=3.0.0 <4.0.0" dependencies: riverpod: @@ -11,6 +11,5 @@ dependencies: dev_dependencies: build_runner: ^2.3.2 - build_verify: ^3.0.0 riverpod_generator: test: ^1.16.0 diff --git a/packages/riverpod_generator/lib/src/parse_generator.dart b/packages/riverpod_generator/lib/src/parse_generator.dart index 3c52f8359..3e7e477ed 100644 --- a/packages/riverpod_generator/lib/src/parse_generator.dart +++ b/packages/riverpod_generator/lib/src/parse_generator.dart @@ -20,7 +20,10 @@ abstract class ParserGenerator ) async { final firstAnnotatedElementFromUniqueSource = {}; - for (final annotated in library.annotatedWithExact(typeChecker)) { + for (final annotated in library.annotatedWithExact( + typeChecker, + throwOnUnresolved: false, + )) { firstAnnotatedElementFromUniqueSource.putIfAbsent( annotated.element.source!.uri, () => annotated.element, diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index 437e837b6..f7fd3434f 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -2,6 +2,7 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/dart/element/element.dart'; import 'package:meta/meta.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; + // ignore: implementation_imports, safe as we are the one controlling this file import 'package:riverpod_annotation/src/riverpod_annotation.dart'; import 'package:source_gen/source_gen.dart'; @@ -20,6 +21,22 @@ String providerDocFor(Element element) { : '${element.documentationComment}\n///\n/// Copied from [${element.name}].'; } +String metaAnnotations(NodeList metadata) { + final buffer = StringBuffer(); + for (final annotation in metadata) { + final element = annotation.elementAnnotation; + if (element == null) continue; + if (element.isDeprecated || + element.isVisibleForTesting || + element.isProtected) { + buffer.writeln('$annotation'); + continue; + } + } + + return buffer.toString(); +} + String _hashFn(GeneratorProviderDeclaration provider, String hashName) { return "String $hashName() => r'${provider.computeProviderHash()}';"; } @@ -47,7 +64,7 @@ class RiverpodInvalidGenerationSourceError final AstNode? astNode; - // TODO overrride toString to render AST nodes. +// TODO override toString to render AST nodes. } @immutable @@ -80,7 +97,7 @@ class RiverpodGenerator extends ParserGenerator { if (buffer.isNotEmpty) { buffer.write(''' // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package '''); } @@ -95,9 +112,11 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { final BuildYamlOptions options; String get suffix => options.providerNameSuffix ?? _defaultProviderNameSuffix; + String get familySuffix => options.providerFamilyNameSuffix ?? suffix; var _didEmitHashUtils = false; + void maybeEmitHashUtils() { if (_didEmitHashUtils) return; diff --git a/packages/riverpod_generator/lib/src/templates/class_based_provider.dart b/packages/riverpod_generator/lib/src/templates/class_based_provider.dart index a40dc0064..1dda0cf4d 100644 --- a/packages/riverpod_generator/lib/src/templates/class_based_provider.dart +++ b/packages/riverpod_generator/lib/src/templates/class_based_provider.dart @@ -112,6 +112,7 @@ class ClassBasedProviderTemplate extends Template { buffer.write(''' ${providerDocFor(provider.providerElement.element)} @ProviderFor(${provider.name}) +${metaAnnotations(provider.node.metadata)} final $providerName = $providerType<${provider.name}, ${provider.valueTypeDisplayString}>.internal( ${provider.providerElement.name}.new, name: r'$providerName', diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index c421ebd9a..f96890a3c 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -1,3 +1,4 @@ +import 'package:analyzer/dart/ast/ast.dart'; import 'package:collection/collection.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; @@ -47,6 +48,8 @@ class FamilyTemplate extends Template { required this.providerCreate, required this.parametersPassThrough, required this.hashFn, + required this.createType, + required this.overrideCreate, this.other = '', this.providerOther = '', }) { @@ -90,14 +93,12 @@ class FamilyTemplate extends Template { } } - final parameters = provider - .node.functionExpression.parameters!.parameterElements - .whereNotNull() + final parameters = provider.node.functionExpression.parameters!.parameters .skip(1) .toList(); final parametersPassThrough = buildParamInvocationQuery({ - for (final parameter in parameters) parameter: parameter.name, + for (final parameter in parameters) parameter: parameter.name!.lexeme, }); final typeParameters = provider.node.functionExpression.typeParameters; @@ -116,6 +117,9 @@ class FamilyTemplate extends Template { '(ref) => ${provider.name}$typeParametersUsage(ref as ${provider._refImplName}$typeParametersUsage, $parametersPassThrough)', providerType: providerType, parametersPassThrough: parametersPassThrough, + createType: + '${provider.createdTypeDisplayString} Function(${provider._refImplName} ref)', + overrideCreate: '(ref) => create(ref as ${provider._refImplName})', providerOther: ''' @override @@ -170,15 +174,14 @@ ${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} } } - final parameters = provider.buildMethod.parameters!.parameterElements - .whereNotNull() - .toList(); + final parameters = + provider.buildMethod.parameters!.parameters.whereNotNull().toList(); final parameterDefinition = buildParamDefinitionQuery(parameters); final cascadePropertyInit = parameters.map((e) => '..${e.name} = ${e.name}').join('\n'); final parametersPassThrough = buildParamInvocationQuery({ - for (final parameter in parameters) parameter: parameter.name, + for (final parameter in parameters) parameter: parameter.name!.lexeme, }); final typeParameters = provider.node.typeParameters; @@ -203,6 +206,8 @@ ${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} ? '${provider.name.lexeme}$typeParametersUsage.new' : '() => ${provider.name}$typeParametersUsage()$cascadePropertyInit', parametersPassThrough: parametersPassThrough, + createType: '${provider.name} Function()', + overrideCreate: '() => create()$cascadePropertyInit', other: ''' abstract class $notifierTypedefName$typeParametersDefinition extends $notifierBaseType<${provider.valueTypeDisplayString}> { ${parameters.map((e) => 'late final ${e.typeDisplayString} ${e.name};').join('\n')} @@ -250,6 +255,8 @@ ${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} final String providerOther; final String parametersPassThrough; final String hashFn; + final String createType; + final String overrideCreate; @override void run(StringBuffer buffer) { @@ -263,8 +270,12 @@ ${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} for (final parameter in parameters) parameter: 'provider.${parameter.name}', }); + final parameterThisNamedPassThrough = parameters + .map((parameter) => '${parameter.name}: ${parameter.name},') + .join(); final docs = providerDocFor(provider.providerElement.element); + final meta = metaAnnotations(provider.node.metadata); final providerName = providerFamilyNameFor(provider.providerElement, options); @@ -293,6 +304,7 @@ $other $docs @ProviderFor(${provider.name}) +$meta const $providerName = $familyName(); $docs @@ -300,11 +312,25 @@ class $familyName extends Family { $docs const $familyName(); + static $dependenciesKeyword _dependencies = ${serializeDependencies(provider.providerElement.annotation, options)}; + + static $dependenciesKeyword _allTransitiveDependencies = ${serializeAllTransitiveDependencies(provider.providerElement.annotation, options)}; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => _allTransitiveDependencies; + + @override + String? get name => r'$providerName'; + $docs $providerTypeNameImpl$typeParametersUsage call$typeParametersDefinition($parameterDefinition) { return $providerTypeNameImpl$typeParametersUsage($parametersPassThrough); } + @visibleForOverriding @override $providerTypeNameImpl$anyTypeParametersUsage getProviderOverride( covariant $providerTypeNameImpl$anyTypeParametersUsage provider, @@ -312,18 +338,26 @@ class $familyName extends Family { return call($parameterProviderPassThrough); } - static $dependenciesKeyword _dependencies = ${serializeDependencies(provider.providerElement.annotation, options)}; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith($createType create) { + return $familyOverrideClassName(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class $familyOverrideClassName implements FamilyOverride<${provider.exposedTypeDisplayString}> { + $familyOverrideClassName(this.overriddenFamily, this.create); - static $dependenciesKeyword _allTransitiveDependencies = ${serializeAllTransitiveDependencies(provider.providerElement.annotation, options)}; + final $createType create; @override - Iterable? get allTransitiveDependencies => _allTransitiveDependencies; + final $familyName overriddenFamily; @override - String? get name => r'$providerName'; + $providerTypeNameImpl getProviderOverride( + covariant $providerTypeNameImpl provider, + ) { + return provider._copyWith(create); + } } $docs @@ -340,7 +374,7 @@ class $providerTypeNameImpl$typeParametersDefinition extends $providerType$provi ); $providerTypeNameImpl._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -354,15 +388,34 @@ class $providerTypeNameImpl$typeParametersDefinition extends $providerType$provi )} }) : super.internal(); -${parameters.map((e) => 'final ${e.type.getDisplayString(withNullability: true)} ${e.name};').join()} +${parameters.map((e) => 'final ${e.typeDisplayString} ${e.name};').join()} $providerOther + @override + ($argumentRecordType) get argument { + return ($argumentsToRecord); + } + @override $elementType$providerGenerics createElement() { return $elementNameImpl(this); } + $providerTypeNameImpl _copyWith( + $createType create, + ) { + return $providerTypeNameImpl._internal( + $overrideCreate, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + $parameterThisNamedPassThrough + ); + } + @override bool operator ==(Object other) { return ${[ @@ -390,7 +443,7 @@ mixin $refNameImpl$typeParametersDefinition on $refType<${provider.valueTypeDisp ${parameters.map((e) { return ''' /// The parameter `${e.name}` of this provider. -${e.type} get ${e.name};'''; +${e.typeDisplayString} get ${e.name};'''; }).join()} } diff --git a/packages/riverpod_generator/lib/src/templates/functional_provider.dart b/packages/riverpod_generator/lib/src/templates/functional_provider.dart index 22ce94287..66760f86e 100644 --- a/packages/riverpod_generator/lib/src/templates/functional_provider.dart +++ b/packages/riverpod_generator/lib/src/templates/functional_provider.dart @@ -58,6 +58,7 @@ class FunctionalProviderTemplate extends Template { buffer.write(''' ${providerDocFor(provider.providerElement.element)} @ProviderFor(${provider.name}) +${metaAnnotations(provider.node.metadata)} final $providerName = $providerType<${provider.valueTypeDisplayString}>.internal( $createFn, name: r'$providerName', diff --git a/packages/riverpod_generator/lib/src/templates/parameters.dart b/packages/riverpod_generator/lib/src/templates/parameters.dart index 55a302b8a..eac55717e 100644 --- a/packages/riverpod_generator/lib/src/templates/parameters.dart +++ b/packages/riverpod_generator/lib/src/templates/parameters.dart @@ -1,11 +1,12 @@ -import 'package:analyzer/dart/element/element.dart'; +import 'package:analyzer/dart/ast/ast.dart'; String buildParamDefinitionQuery( - List parameters, { + List parameters, { bool asThisParameter = false, bool asSuperParameter = false, bool writeBrackets = true, bool asRequiredNamed = false, + bool asRecord = false, }) { assert( !asThisParameter || !asSuperParameter, @@ -23,25 +24,38 @@ String buildParamDefinitionQuery( .toList(); final buffer = StringBuffer(); - String encodeParameter(ParameterElement e) { - final leading = e.isRequiredNamed || asRequiredNamed ? 'required ' : ''; - final trailing = e.defaultValueCode != null && !asRequiredNamed - ? '= ${e.defaultValueCode}' + String encodeParameter(FormalParameter parameter) { + if (asRecord) { + final type = parameter.typeDisplayString.isEmpty + ? 'dynamic' + : parameter.typeDisplayString; + if (parameter.isNamed) { + return '$type ${parameter.name}'; + } + return type; + } + + late final element = parameter.declaredElement!; + late final leading = + parameter.isRequiredNamed || asRequiredNamed ? 'required ' : ''; + late final trailing = element.defaultValueCode != null && !asRequiredNamed + ? '= ${element.defaultValueCode}' : ''; - if (asThisParameter) return '${leading}this.${e.name}$trailing'; - if (asSuperParameter) return '${leading}super.${e.name}$trailing'; - return '$leading${e.type} ${e.name}$trailing'; + if (asThisParameter) return '${leading}this.${parameter.name}$trailing'; + if (asSuperParameter) return '${leading}super.${parameter.name}$trailing'; + + return '$leading${parameter.typeDisplayString} ${parameter.name}$trailing'; } buffer.writeAll( requiredPositionals.map(encodeParameter).expand((e) => [e, ',']), ); if (optionalPositionals.isNotEmpty) { - if (writeBrackets) buffer.write('['); + if (writeBrackets && !asRecord) buffer.write('['); buffer.writeAll( optionalPositionals.map(encodeParameter).expand((e) => [e, ',']), ); - if (writeBrackets) buffer.write(']'); + if (writeBrackets && !asRecord) buffer.write(']'); } if (named.isNotEmpty) { if (writeBrackets) buffer.write('{'); @@ -53,7 +67,7 @@ String buildParamDefinitionQuery( } String buildParamInvocationQuery( - Map parameters, { + Map parameters, { bool asThisParameter = false, }) { final buffer = StringBuffer(); @@ -67,3 +81,22 @@ String buildParamInvocationQuery( return buffer.toString(); } + +extension ParamterType on FormalParameter { + String get typeDisplayString { + final that = this; + switch (that) { + case DefaultFormalParameter(): + return that.parameter.typeDisplayString; + case SimpleFormalParameter(): + // No type, so let's just return '' + return that.type?.toSource() ?? ''; + case FieldFormalParameter(): + case FunctionTypedFormalParameter(): + case SuperFormalParameter(): + throw UnsupportedError( + 'Only parameters of the form "Type name" are supported', + ); + } + } +} diff --git a/packages/riverpod_generator/pubspec.yaml b/packages/riverpod_generator/pubspec.yaml index 374ef6e23..18e04fe95 100644 --- a/packages/riverpod_generator/pubspec.yaml +++ b/packages/riverpod_generator/pubspec.yaml @@ -1,16 +1,16 @@ name: riverpod_generator description: A code generator for Riverpod. This both simplifies the syntax empowers it, such as allowing stateful hot-reload. -version: 2.3.5 +version: 3.0.0-dev.6 repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues funding: - https://github.com/sponsors/rrousselGit/ environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0 <4.0.0" dependencies: - analyzer: ">=5.12.0 <7.0.0" + analyzer: ">=6.0.0 <7.0.0" build: ^2.0.0 build_config: ^1.0.0 collection: ^1.15.0 @@ -24,5 +24,7 @@ dependencies: dev_dependencies: build_runner: ^2.1.7 build_verify: ^3.0.0 + freezed: ^2.4.3 + freezed_annotation: ^2.4.1 riverpod: ^2.4.4 test: ^1.21.0 diff --git a/packages/riverpod_generator/test/annotated_test.dart b/packages/riverpod_generator/test/annotated_test.dart new file mode 100644 index 000000000..01ffe8571 --- /dev/null +++ b/packages/riverpod_generator/test/annotated_test.dart @@ -0,0 +1,89 @@ +import 'dart:io'; + +import 'package:analyzer/dart/analysis/results.dart'; +import 'package:analyzer/dart/analysis/utilities.dart'; +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:test/test.dart'; + +void main() async { + final file = File('test/integration/annotated.g.dart').absolute; + final result = await resolveFile2(path: file.path) as ResolvedUnitResult; + final topLevelDeclarations = result.unit.declarations + .whereType() + .toList(); + + test('Annotations on generated functionalProvider', () async { + final annotations = topLevelDeclarations + .findNamed('functionalProvider') + .metadata + .toString(); + + expect( + annotations, + "[@ProviderFor(functional), @Deprecated('Deprecation message'), @visibleForTesting, @protected]", + ); + }); + + test('Annotations on generated classBasedProvider', () async { + final annotations = topLevelDeclarations + .findNamed('classBasedProvider') + .metadata + .toString(); + + expect( + annotations, + "[@ProviderFor(ClassBased), @Deprecated('Deprecation message'), @visibleForTesting, @protected]", + ); + }); + + test('Annotations on generated familyProvider', () async { + final annotations = + topLevelDeclarations.findNamed('familyProvider').metadata.toString(); + expect( + annotations, + "[@ProviderFor(family), @Deprecated('Deprecation message'), @visibleForTesting, @protected]", + ); + }); + + test('Annotations on generated notCopiedFunctionalProvider', () async { + final annotations = topLevelDeclarations + .findNamed('notCopiedFunctionalProvider') + .metadata + .toString(); + expect( + annotations, + '[@ProviderFor(notCopiedFunctional)]', + ); + }); + + test('Annotations on generated notCopiedClassBasedProvider', () async { + final annotations = topLevelDeclarations + .findNamed('notCopiedClassBasedProvider') + .metadata + .toString(); + expect( + annotations, + '[@ProviderFor(NotCopiedClassBased)]', + ); + }); + + test('Annotations on generated notCopiedFamilyProvider', () async { + final annotations = topLevelDeclarations + .findNamed('notCopiedFamilyProvider') + .metadata + .toString(); + expect( + annotations, + '[@ProviderFor(notCopiedFamily)]', + ); + }); +} + +extension TopLevelVariableDeclarationFindNamedX + on List { + TopLevelVariableDeclaration findNamed(String name) { + return singleWhere((element) { + return element.variables.variables.first.name.lexeme == name; + }); + } +} diff --git a/packages/riverpod_generator/test/async_test.dart b/packages/riverpod_generator/test/async_test.dart index cfb2bf807..ed18a8e3f 100644 --- a/packages/riverpod_generator/test/async_test.dart +++ b/packages/riverpod_generator/test/async_test.dart @@ -139,4 +139,37 @@ void main() { ), ); }); + + test('can override providers', () { + final container = createContainer( + overrides: [ + publicProvider.overrideWith((ref) { + const FutureOr result = 'test'; + return result; + }), + publicClassProvider.overrideWith(() => PublicClass(42)), + familyProvider.overrideWith( + (ref) { + final FutureOr result = + 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})'; + return result; + }, + ), + familyClassProvider.overrideWith(() => FamilyClass(42)), + ], + ); + + expect(container.read(publicProvider).requireValue, 'test'); + expect(container.read(publicClassProvider.notifier).param, 42); + expect( + container.read(familyProvider(42, second: '42', third: .42)).requireValue, + 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', + ); + expect( + container + .read(familyClassProvider(42, second: '42', third: .42).notifier) + .param, + 42, + ); + }); } diff --git a/packages/riverpod_generator/test/integration/annotated.dart b/packages/riverpod_generator/test/integration/annotated.dart new file mode 100644 index 000000000..a60a58a4d --- /dev/null +++ b/packages/riverpod_generator/test/integration/annotated.dart @@ -0,0 +1,40 @@ +import 'package:meta/meta.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'annotated.g.dart'; + +@riverpod +@Deprecated('Deprecation message') +@visibleForTesting +@protected +String functional(FunctionalRef ref) => 'functional'; + +@riverpod +@Deprecated('Deprecation message') +@visibleForTesting +@protected +class ClassBased extends _$ClassBased { + @override + String build() => 'ClassBased'; +} + +@riverpod +@Deprecated('Deprecation message') +@visibleForTesting +@protected +String family(FamilyRef ref, int id) => 'family $id'; + +@riverpod +@doNotStore +String notCopiedFunctional(NotCopiedFunctionalRef ref) => 'notCopiedFunctional'; + +@riverpod +@doNotStore +class NotCopiedClassBased extends _$NotCopiedClassBased { + @override + String build() => 'NotCopiedClassBased'; +} + +@riverpod +@doNotStore +String notCopiedFamily(NotCopiedFamilyRef ref, int id) => 'notCopiedFamily $id'; diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart new file mode 100644 index 000000000..3b5aa9b38 --- /dev/null +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -0,0 +1,439 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'annotated.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$functionalHash() => r'69e260b1de8ba28cbeb8e24d628933366cde6b8b'; + +/// See also [functional]. +@ProviderFor(functional) +@Deprecated('Deprecation message') +@visibleForTesting +@protected +final functionalProvider = AutoDisposeProvider.internal( + functional, + name: r'functionalProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$functionalHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef FunctionalRef = AutoDisposeProviderRef; +String _$familyHash() => r'd70685b83be840bfd9e79c11fb84c905d19d6e10'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [family]. +@ProviderFor(family) +@Deprecated('Deprecation message') +@visibleForTesting +@protected +const familyProvider = FamilyFamily(); + +/// See also [family]. +class FamilyFamily extends Family { + /// See also [family]. + const FamilyFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyProvider'; + + /// See also [family]. + FamilyProvider call( + int id, + ) { + return FamilyProvider( + id, + ); + } + + @visibleForOverriding + @override + FamilyProvider getProviderOverride( + covariant FamilyProvider provider, + ) { + return call( + provider.id, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(String Function(FamilyRef ref) create) { + return _$FamilyFamilyOverride(this, create); + } +} + +class _$FamilyFamilyOverride implements FamilyOverride { + _$FamilyFamilyOverride(this.overriddenFamily, this.create); + + final String Function(FamilyRef ref) create; + + @override + final FamilyFamily overriddenFamily; + + @override + FamilyProvider getProviderOverride( + covariant FamilyProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [family]. +class FamilyProvider extends AutoDisposeProvider { + /// See also [family]. + FamilyProvider( + int id, + ) : this._internal( + (ref) => family( + ref as FamilyRef, + id, + ), + from: familyProvider, + name: r'familyProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$familyHash, + dependencies: FamilyFamily._dependencies, + allTransitiveDependencies: FamilyFamily._allTransitiveDependencies, + id: id, + ); + + FamilyProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.id, + }) : super.internal(); + + final int id; + + @override + Override overrideWith( + String Function(FamilyRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: FamilyProvider._internal( + (ref) => create(ref as FamilyRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + id: id, + ), + ); + } + + @override + (int,) get argument { + return (id,); + } + + @override + AutoDisposeProviderElement createElement() { + return _FamilyProviderElement(this); + } + + FamilyProvider _copyWith( + String Function(FamilyRef ref) create, + ) { + return FamilyProvider._internal( + (ref) => create(ref as FamilyRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + id: id, + ); + } + + @override + bool operator ==(Object other) { + return other is FamilyProvider && other.id == id; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, id.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin FamilyRef on AutoDisposeProviderRef { + /// The parameter `id` of this provider. + int get id; +} + +class _FamilyProviderElement extends AutoDisposeProviderElement + with FamilyRef { + _FamilyProviderElement(super.provider); + + @override + int get id => (origin as FamilyProvider).id; +} + +String _$notCopiedFunctionalHash() => + r'30587ee9ceb75d5c8562015ad4a67ec0b107c1f6'; + +/// See also [notCopiedFunctional]. +@ProviderFor(notCopiedFunctional) +final notCopiedFunctionalProvider = AutoDisposeProvider.internal( + notCopiedFunctional, + name: r'notCopiedFunctionalProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$notCopiedFunctionalHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef NotCopiedFunctionalRef = AutoDisposeProviderRef; +String _$notCopiedFamilyHash() => r'6ef06ce6ebd73b476870bbe1af41c4f3fbe8ddb1'; + +/// See also [notCopiedFamily]. +@ProviderFor(notCopiedFamily) +const notCopiedFamilyProvider = NotCopiedFamilyFamily(); + +/// See also [notCopiedFamily]. +class NotCopiedFamilyFamily extends Family { + /// See also [notCopiedFamily]. + const NotCopiedFamilyFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'notCopiedFamilyProvider'; + + /// See also [notCopiedFamily]. + NotCopiedFamilyProvider call( + int id, + ) { + return NotCopiedFamilyProvider( + id, + ); + } + + @visibleForOverriding + @override + NotCopiedFamilyProvider getProviderOverride( + covariant NotCopiedFamilyProvider provider, + ) { + return call( + provider.id, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(String Function(NotCopiedFamilyRef ref) create) { + return _$NotCopiedFamilyFamilyOverride(this, create); + } +} + +class _$NotCopiedFamilyFamilyOverride implements FamilyOverride { + _$NotCopiedFamilyFamilyOverride(this.overriddenFamily, this.create); + + final String Function(NotCopiedFamilyRef ref) create; + + @override + final NotCopiedFamilyFamily overriddenFamily; + + @override + NotCopiedFamilyProvider getProviderOverride( + covariant NotCopiedFamilyProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [notCopiedFamily]. +class NotCopiedFamilyProvider extends AutoDisposeProvider { + /// See also [notCopiedFamily]. + NotCopiedFamilyProvider( + int id, + ) : this._internal( + (ref) => notCopiedFamily( + ref as NotCopiedFamilyRef, + id, + ), + from: notCopiedFamilyProvider, + name: r'notCopiedFamilyProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$notCopiedFamilyHash, + dependencies: NotCopiedFamilyFamily._dependencies, + allTransitiveDependencies: + NotCopiedFamilyFamily._allTransitiveDependencies, + id: id, + ); + + NotCopiedFamilyProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.id, + }) : super.internal(); + + final int id; + + @override + Override overrideWith( + String Function(NotCopiedFamilyRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: NotCopiedFamilyProvider._internal( + (ref) => create(ref as NotCopiedFamilyRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + id: id, + ), + ); + } + + @override + (int,) get argument { + return (id,); + } + + @override + AutoDisposeProviderElement createElement() { + return _NotCopiedFamilyProviderElement(this); + } + + NotCopiedFamilyProvider _copyWith( + String Function(NotCopiedFamilyRef ref) create, + ) { + return NotCopiedFamilyProvider._internal( + (ref) => create(ref as NotCopiedFamilyRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + id: id, + ); + } + + @override + bool operator ==(Object other) { + return other is NotCopiedFamilyProvider && other.id == id; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, id.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin NotCopiedFamilyRef on AutoDisposeProviderRef { + /// The parameter `id` of this provider. + int get id; +} + +class _NotCopiedFamilyProviderElement extends AutoDisposeProviderElement + with NotCopiedFamilyRef { + _NotCopiedFamilyProviderElement(super.provider); + + @override + int get id => (origin as NotCopiedFamilyProvider).id; +} + +String _$classBasedHash() => r'f40d1a032ee264aafd7686a985cdf1937f2dc108'; + +/// See also [ClassBased]. +@ProviderFor(ClassBased) +@Deprecated('Deprecation message') +@visibleForTesting +@protected +final classBasedProvider = + AutoDisposeNotifierProvider.internal( + ClassBased.new, + name: r'classBasedProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$classBasedHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$ClassBased = AutoDisposeNotifier; +String _$notCopiedClassBasedHash() => + r'd2aefd08a78e3bb4c02000d4931a3bf15c01b495'; + +/// See also [NotCopiedClassBased]. +@ProviderFor(NotCopiedClassBased) +final notCopiedClassBasedProvider = + AutoDisposeNotifierProvider.internal( + NotCopiedClassBased.new, + name: r'notCopiedClassBasedProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$notCopiedClassBasedHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$NotCopiedClassBased = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index e56d26b78..9e050498b 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -181,6 +181,20 @@ class FamilyOrFamily extends Family { /// See also [familyOr]. const FamilyOrFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyOrProvider'; + /// See also [familyOr]. FamilyOrProvider call( int first, @@ -190,6 +204,7 @@ class FamilyOrFamily extends Family { ); } + @visibleForOverriding @override FamilyOrProvider getProviderOverride( covariant FamilyOrProvider provider, @@ -199,19 +214,26 @@ class FamilyOrFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FutureOr Function(FamilyOrRef ref) create) { + return _$FamilyOrFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FamilyOrFamilyOverride implements FamilyOverride> { + _$FamilyOrFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FutureOr Function(FamilyOrRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FamilyOrFamily overriddenFamily; @override - String? get name => r'familyOrProvider'; + FamilyOrProvider getProviderOverride( + covariant FamilyOrProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [familyOr]. @@ -236,7 +258,7 @@ class FamilyOrProvider extends AutoDisposeFutureProvider { ); FamilyOrProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -249,7 +271,7 @@ class FamilyOrProvider extends AutoDisposeFutureProvider { @override Override overrideWith( - FutureOr Function(FamilyOrRef provider) create, + FutureOr Function(FamilyOrRef ref) create, ) { return ProviderOverride( origin: this, @@ -265,11 +287,30 @@ class FamilyOrProvider extends AutoDisposeFutureProvider { ); } + @override + (int,) get argument { + return (first,); + } + @override AutoDisposeFutureProviderElement createElement() { return _FamilyOrProviderElement(this); } + FamilyOrProvider _copyWith( + FutureOr Function(FamilyOrRef ref) create, + ) { + return FamilyOrProvider._internal( + (ref) => create(ref as FamilyOrRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + first: first, + ); + } + @override bool operator ==(Object other) { return other is FamilyOrProvider && other.first == first; @@ -308,6 +349,20 @@ class FamilyFamily extends Family { /// See also [family]. const FamilyFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyProvider'; + /// See also [family]. FamilyProvider call( int first, { @@ -325,6 +380,7 @@ class FamilyFamily extends Family { ); } + @visibleForOverriding @override FamilyProvider getProviderOverride( covariant FamilyProvider provider, @@ -338,19 +394,26 @@ class FamilyFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FutureOr Function(FamilyRef ref) create) { + return _$FamilyFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FamilyFamilyOverride implements FamilyOverride> { + _$FamilyFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FutureOr Function(FamilyRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FamilyFamily overriddenFamily; @override - String? get name => r'familyProvider'; + FamilyProvider getProviderOverride( + covariant FamilyProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [family]. @@ -387,7 +450,7 @@ class FamilyProvider extends AutoDisposeFutureProvider { ); FamilyProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -408,7 +471,7 @@ class FamilyProvider extends AutoDisposeFutureProvider { @override Override overrideWith( - FutureOr Function(FamilyRef provider) create, + FutureOr Function(FamilyRef ref) create, ) { return ProviderOverride( origin: this, @@ -428,11 +491,46 @@ class FamilyProvider extends AutoDisposeFutureProvider { ); } + @override + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) get argument { + return ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ); + } + @override AutoDisposeFutureProviderElement createElement() { return _FamilyProviderElement(this); } + FamilyProvider _copyWith( + FutureOr Function(FamilyRef ref) create, + ) { + return FamilyProvider._internal( + (ref) => create(ref as FamilyRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + first: first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ); + } + @override bool operator ==(Object other) { return other is FamilyProvider && @@ -666,6 +764,20 @@ class FamilyOrClassFamily extends Family { /// See also [FamilyOrClass]. const FamilyOrClassFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyOrClassProvider'; + /// See also [FamilyOrClass]. FamilyOrClassProvider call( int first, @@ -675,6 +787,7 @@ class FamilyOrClassFamily extends Family { ); } + @visibleForOverriding @override FamilyOrClassProvider getProviderOverride( covariant FamilyOrClassProvider provider, @@ -684,19 +797,27 @@ class FamilyOrClassFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FamilyOrClass Function() create) { + return _$FamilyOrClassFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FamilyOrClassFamilyOverride + implements FamilyOverride> { + _$FamilyOrClassFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FamilyOrClass Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FamilyOrClassFamily overriddenFamily; @override - String? get name => r'familyOrClassProvider'; + FamilyOrClassProvider getProviderOverride( + covariant FamilyOrClassProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [FamilyOrClass]. @@ -720,7 +841,7 @@ class FamilyOrClassProvider ); FamilyOrClassProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -756,12 +877,31 @@ class FamilyOrClassProvider ); } + @override + (int,) get argument { + return (first,); + } + @override AutoDisposeAsyncNotifierProviderElement createElement() { return _FamilyOrClassProviderElement(this); } + FamilyOrClassProvider _copyWith( + FamilyOrClass Function() create, + ) { + return FamilyOrClassProvider._internal( + () => create()..first = first, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + first: first, + ); + } + @override bool operator ==(Object other) { return other is FamilyOrClassProvider && other.first == first; @@ -817,6 +957,20 @@ class FamilyClassFamily extends Family { /// See also [FamilyClass]. const FamilyClassFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyClassProvider'; + /// See also [FamilyClass]. FamilyClassProvider call( int first, { @@ -834,6 +988,7 @@ class FamilyClassFamily extends Family { ); } + @visibleForOverriding @override FamilyClassProvider getProviderOverride( covariant FamilyClassProvider provider, @@ -847,19 +1002,27 @@ class FamilyClassFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FamilyClass Function() create) { + return _$FamilyClassFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FamilyClassFamilyOverride + implements FamilyOverride> { + _$FamilyClassFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FamilyClass Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FamilyClassFamily overriddenFamily; @override - String? get name => r'familyClassProvider'; + FamilyClassProvider getProviderOverride( + covariant FamilyClassProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [FamilyClass]. @@ -896,7 +1059,7 @@ class FamilyClassProvider ); FamilyClassProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -953,11 +1116,51 @@ class FamilyClassProvider ); } + @override + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) get argument { + return ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ); + } + @override AutoDisposeAsyncNotifierProviderElement createElement() { return _FamilyClassProviderElement(this); } + FamilyClassProvider _copyWith( + FamilyClass Function() create, + ) { + return FamilyClassProvider._internal( + () => create() + ..first = first + ..second = second + ..third = third + ..fourth = fourth + ..fifth = fifth, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + first: first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ); + } + @override bool operator ==(Object other) { return other is FamilyClassProvider && @@ -1015,4 +1218,4 @@ class _FamilyClassProviderElement List? get fifth => (origin as FamilyClassProvider).fifth; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 4bd8667b9..3d6ee6934 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -35,4 +35,4 @@ final notKeepAliveProvider = AutoDisposeProvider.internal( typedef NotKeepAliveRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 8ade59cfc..b499e8112 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -52,6 +52,20 @@ class FamilyFamily extends Family { /// See also [family]. const FamilyFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyProvider'; + /// See also [family]. FamilyProvider call( int id, @@ -61,6 +75,7 @@ class FamilyFamily extends Family { ); } + @visibleForOverriding @override FamilyProvider getProviderOverride( covariant FamilyProvider provider, @@ -70,19 +85,26 @@ class FamilyFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(int Function(FamilyRef ref) create) { + return _$FamilyFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FamilyFamilyOverride implements FamilyOverride { + _$FamilyFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final int Function(FamilyRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FamilyFamily overriddenFamily; @override - String? get name => r'familyProvider'; + FamilyProvider getProviderOverride( + covariant FamilyProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [family]. @@ -107,7 +129,7 @@ class FamilyProvider extends AutoDisposeProvider { ); FamilyProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -120,7 +142,7 @@ class FamilyProvider extends AutoDisposeProvider { @override Override overrideWith( - int Function(FamilyRef provider) create, + int Function(FamilyRef ref) create, ) { return ProviderOverride( origin: this, @@ -136,11 +158,30 @@ class FamilyProvider extends AutoDisposeProvider { ); } + @override + (int,) get argument { + return (id,); + } + @override AutoDisposeProviderElement createElement() { return _FamilyProviderElement(this); } + FamilyProvider _copyWith( + int Function(FamilyRef ref) create, + ) { + return FamilyProvider._internal( + (ref) => create(ref as FamilyRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + id: id, + ); + } + @override bool operator ==(Object other) { return other is FamilyProvider && other.id == id; @@ -365,6 +406,20 @@ class Family2Family extends Family { /// See also [Family2]. const Family2Family(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'family2Provider'; + /// See also [Family2]. Family2Provider call( int id, @@ -374,6 +429,7 @@ class Family2Family extends Family { ); } + @visibleForOverriding @override Family2Provider getProviderOverride( covariant Family2Provider provider, @@ -383,19 +439,26 @@ class Family2Family extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(Family2 Function() create) { + return _$Family2FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$Family2FamilyOverride implements FamilyOverride { + _$Family2FamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final Family2 Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final Family2Family overriddenFamily; @override - String? get name => r'family2Provider'; + Family2Provider getProviderOverride( + covariant Family2Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [Family2]. @@ -417,7 +480,7 @@ class Family2Provider extends AutoDisposeNotifierProviderImpl { ); Family2Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -453,11 +516,30 @@ class Family2Provider extends AutoDisposeNotifierProviderImpl { ); } + @override + (int,) get argument { + return (id,); + } + @override AutoDisposeNotifierProviderElement createElement() { return _Family2ProviderElement(this); } + Family2Provider _copyWith( + Family2 Function() create, + ) { + return Family2Provider._internal( + () => create()..id = id, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + id: id, + ); + } + @override bool operator ==(Object other) { return other is Family2Provider && other.id == id; @@ -532,24 +614,6 @@ class Provider4Family extends Family { /// See also [Provider4]. const Provider4Family(); - /// See also [Provider4]. - Provider4Provider call( - int id, - ) { - return Provider4Provider( - id, - ); - } - - @override - Provider4Provider getProviderOverride( - covariant Provider4Provider provider, - ) { - return call( - provider.id, - ); - } - static final Iterable _dependencies = { depProvider, familyProvider, @@ -557,9 +621,6 @@ class Provider4Family extends Family { family2Provider }; - @override - Iterable? get dependencies => _dependencies; - static final Iterable _allTransitiveDependencies = { depProvider, @@ -572,12 +633,55 @@ class Provider4Family extends Family { ...?family2Provider.allTransitiveDependencies }; + @override + Iterable? get dependencies => _dependencies; + @override Iterable? get allTransitiveDependencies => _allTransitiveDependencies; @override String? get name => r'provider4Provider'; + + /// See also [Provider4]. + Provider4Provider call( + int id, + ) { + return Provider4Provider( + id, + ); + } + + @visibleForOverriding + @override + Provider4Provider getProviderOverride( + covariant Provider4Provider provider, + ) { + return call( + provider.id, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(Provider4 Function() create) { + return _$Provider4FamilyOverride(this, create); + } +} + +class _$Provider4FamilyOverride implements FamilyOverride { + _$Provider4FamilyOverride(this.overriddenFamily, this.create); + + final Provider4 Function() create; + + @override + final Provider4Family overriddenFamily; + + @override + Provider4Provider getProviderOverride( + covariant Provider4Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [Provider4]. @@ -600,7 +704,7 @@ class Provider4Provider ); Provider4Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -636,11 +740,30 @@ class Provider4Provider ); } + @override + (int,) get argument { + return (id,); + } + @override AutoDisposeNotifierProviderElement createElement() { return _Provider4ProviderElement(this); } + Provider4Provider _copyWith( + Provider4 Function() create, + ) { + return Provider4Provider._internal( + () => create()..id = id, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + id: id, + ); + } + @override bool operator ==(Object other) { return other is Provider4Provider && other.id == id; @@ -687,4 +810,4 @@ final emptyDependenciesClassBasedProvider = typedef _$EmptyDependenciesClassBased = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 5984dad5a..509fb1ace 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -66,6 +66,32 @@ class FamilyWithDependencies2Family extends Family { /// See also [familyWithDependencies2]. const FamilyWithDependencies2Family(); + static final Iterable _dependencies = [ + providerWithDependenciesProvider, + _private2Provider, + public2Provider + ]; + + static final Iterable _allTransitiveDependencies = + { + providerWithDependenciesProvider, + ...?providerWithDependenciesProvider.allTransitiveDependencies, + _private2Provider, + ...?_private2Provider.allTransitiveDependencies, + public2Provider, + ...?public2Provider.allTransitiveDependencies + }; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyWithDependencies2Provider'; + /// See also [familyWithDependencies2]. FamilyWithDependencies2Provider call({ int? id, @@ -75,6 +101,7 @@ class FamilyWithDependencies2Family extends Family { ); } + @visibleForOverriding @override FamilyWithDependencies2Provider getProviderOverride( covariant FamilyWithDependencies2Provider provider, @@ -84,31 +111,26 @@ class FamilyWithDependencies2Family extends Family { ); } - static final Iterable _dependencies = [ - providerWithDependenciesProvider, - _private2Provider, - public2Provider - ]; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(int Function(FamilyWithDependencies2Ref ref) create) { + return _$FamilyWithDependencies2FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FamilyWithDependencies2FamilyOverride implements FamilyOverride { + _$FamilyWithDependencies2FamilyOverride(this.overriddenFamily, this.create); - static final Iterable _allTransitiveDependencies = - { - providerWithDependenciesProvider, - ...?providerWithDependenciesProvider.allTransitiveDependencies, - _private2Provider, - ...?_private2Provider.allTransitiveDependencies, - public2Provider, - ...?public2Provider.allTransitiveDependencies - }; + final int Function(FamilyWithDependencies2Ref ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FamilyWithDependencies2Family overriddenFamily; @override - String? get name => r'familyWithDependencies2Provider'; + FamilyWithDependencies2Provider getProviderOverride( + covariant FamilyWithDependencies2Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [familyWithDependencies2]. @@ -134,7 +156,7 @@ class FamilyWithDependencies2Provider extends AutoDisposeProvider { ); FamilyWithDependencies2Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -147,7 +169,7 @@ class FamilyWithDependencies2Provider extends AutoDisposeProvider { @override Override overrideWith( - int Function(FamilyWithDependencies2Ref provider) create, + int Function(FamilyWithDependencies2Ref ref) create, ) { return ProviderOverride( origin: this, @@ -163,11 +185,32 @@ class FamilyWithDependencies2Provider extends AutoDisposeProvider { ); } + @override + ({ + int? id, + }) get argument { + return (id: id,); + } + @override AutoDisposeProviderElement createElement() { return _FamilyWithDependencies2ProviderElement(this); } + FamilyWithDependencies2Provider _copyWith( + int Function(FamilyWithDependencies2Ref ref) create, + ) { + return FamilyWithDependencies2Provider._internal( + (ref) => create(ref as FamilyWithDependencies2Ref), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + id: id, + ); + } + @override bool operator ==(Object other) { return other is FamilyWithDependencies2Provider && other.id == id; @@ -273,6 +316,32 @@ class NotifierFamilyWithDependenciesFamily extends Family { /// See also [NotifierFamilyWithDependencies]. const NotifierFamilyWithDependenciesFamily(); + static final Iterable _dependencies = [ + providerWithDependenciesProvider, + _private2Provider, + public2Provider + ]; + + static final Iterable _allTransitiveDependencies = + { + providerWithDependenciesProvider, + ...?providerWithDependenciesProvider.allTransitiveDependencies, + _private2Provider, + ...?_private2Provider.allTransitiveDependencies, + public2Provider, + ...?public2Provider.allTransitiveDependencies + }; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'notifierFamilyWithDependenciesProvider'; + /// See also [NotifierFamilyWithDependencies]. NotifierFamilyWithDependenciesProvider call({ int? id, @@ -282,6 +351,7 @@ class NotifierFamilyWithDependenciesFamily extends Family { ); } + @visibleForOverriding @override NotifierFamilyWithDependenciesProvider getProviderOverride( covariant NotifierFamilyWithDependenciesProvider provider, @@ -291,31 +361,28 @@ class NotifierFamilyWithDependenciesFamily extends Family { ); } - static final Iterable _dependencies = [ - providerWithDependenciesProvider, - _private2Provider, - public2Provider - ]; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(NotifierFamilyWithDependencies Function() create) { + return _$NotifierFamilyWithDependenciesFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$NotifierFamilyWithDependenciesFamilyOverride + implements FamilyOverride { + _$NotifierFamilyWithDependenciesFamilyOverride( + this.overriddenFamily, this.create); - static final Iterable _allTransitiveDependencies = - { - providerWithDependenciesProvider, - ...?providerWithDependenciesProvider.allTransitiveDependencies, - _private2Provider, - ...?_private2Provider.allTransitiveDependencies, - public2Provider, - ...?public2Provider.allTransitiveDependencies - }; + final NotifierFamilyWithDependencies Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final NotifierFamilyWithDependenciesFamily overriddenFamily; @override - String? get name => r'notifierFamilyWithDependenciesProvider'; + NotifierFamilyWithDependenciesProvider getProviderOverride( + covariant NotifierFamilyWithDependenciesProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [NotifierFamilyWithDependencies]. @@ -340,7 +407,7 @@ class NotifierFamilyWithDependenciesProvider ); NotifierFamilyWithDependenciesProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -376,12 +443,33 @@ class NotifierFamilyWithDependenciesProvider ); } + @override + ({ + int? id, + }) get argument { + return (id: id,); + } + @override AutoDisposeNotifierProviderElement createElement() { return _NotifierFamilyWithDependenciesProviderElement(this); } + NotifierFamilyWithDependenciesProvider _copyWith( + NotifierFamilyWithDependencies Function() create, + ) { + return NotifierFamilyWithDependenciesProvider._internal( + () => create()..id = id, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + id: id, + ); + } + @override bool operator ==(Object other) { return other is NotifierFamilyWithDependenciesProvider && other.id == id; @@ -410,4 +498,4 @@ class _NotifierFamilyWithDependenciesProviderElement int? get id => (origin as NotifierFamilyWithDependenciesProvider).id; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/generated.dart b/packages/riverpod_generator/test/integration/generated.dart new file mode 100644 index 000000000..2a117a8e6 --- /dev/null +++ b/packages/riverpod_generator/test/integration/generated.dart @@ -0,0 +1,83 @@ +// ignore_for_file: library_private_types_in_public_api, inference_failure_on_function_return_type, always_declare_return_types, type_annotate_public_apis + +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod/riverpod.dart' as r; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'generated.freezed.dart'; +part 'generated.g.dart'; + +@freezed +class Test with _$Test { + factory Test() = _Test; +} + +@riverpod +_Test generated(GeneratedRef ref) => _Test(); + +@riverpod +_Test generatedFamily(GeneratedFamilyRef ref, _Test test) => _Test(); + +@riverpod +class GeneratedClass extends _$GeneratedClass { + @override + _Test build() => _Test(); +} + +@riverpod +class GeneratedClassFamily extends _$GeneratedClassFamily { + @override + _Test build(_Test test) => _Test(); +} + +@riverpod +$dynamic($DynamicRef ref) => _Test(); + +@riverpod +$dynamicFamily($DynamicFamilyRef ref, test) => _Test(); + +@riverpod +class $DynamicClass extends _$$DynamicClass { + @override + build() => _Test(); +} + +@riverpod +class $DynamicClassFamily extends _$$DynamicClassFamily { + @override + build(test) => _Test(); +} + +@riverpod +_dynamic(_DynamicRef ref, test) => 0; + +@riverpod +r.AsyncValue alias(AliasRef ref) { + return const r.AsyncData(42); +} + +@riverpod +r.AsyncValue aliasFamily( + AliasFamilyRef ref, + r.AsyncValue test, +) { + return const r.AsyncData(42); +} + +@riverpod +class AliasClass extends _$AliasClass { + @override + r.AsyncValue build() { + return const r.AsyncData(42); + } +} + +@riverpod +class AliasClassFamily extends _$AliasClassFamily { + @override + r.AsyncValue build( + r.AsyncValue test, + ) { + return const r.AsyncData(42); + } +} diff --git a/packages/riverpod_generator/test/integration/generated.freezed.dart b/packages/riverpod_generator/test/integration/generated.freezed.dart new file mode 100644 index 000000000..b7df1ae69 --- /dev/null +++ b/packages/riverpod_generator/test/integration/generated.freezed.dart @@ -0,0 +1,74 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'generated.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + +/// @nodoc +mixin _$Test {} + +/// @nodoc +abstract class $TestCopyWith<$Res> { + factory $TestCopyWith(Test value, $Res Function(Test) then) = + _$TestCopyWithImpl<$Res, Test>; +} + +/// @nodoc +class _$TestCopyWithImpl<$Res, $Val extends Test> + implements $TestCopyWith<$Res> { + _$TestCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; +} + +/// @nodoc +abstract class _$$TestImplCopyWith<$Res> { + factory _$$TestImplCopyWith( + _$TestImpl value, $Res Function(_$TestImpl) then) = + __$$TestImplCopyWithImpl<$Res>; +} + +/// @nodoc +class __$$TestImplCopyWithImpl<$Res> + extends _$TestCopyWithImpl<$Res, _$TestImpl> + implements _$$TestImplCopyWith<$Res> { + __$$TestImplCopyWithImpl(_$TestImpl _value, $Res Function(_$TestImpl) _then) + : super(_value, _then); +} + +/// @nodoc + +class _$TestImpl implements _Test { + _$TestImpl(); + + @override + String toString() { + return 'Test()'; + } + + @override + bool operator ==(dynamic other) { + return identical(this, other) || + (other.runtimeType == runtimeType && other is _$TestImpl); + } + + @override + int get hashCode => runtimeType.hashCode; +} + +abstract class _Test implements Test { + factory _Test() = _$TestImpl; +} diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart new file mode 100644 index 000000000..6f18708d3 --- /dev/null +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -0,0 +1,1352 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'generated.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$generatedHash() => r'e49f3520d06ed50d34a44de613fdcd20b19f48d4'; + +/// See also [generated]. +@ProviderFor(generated) +final generatedProvider = AutoDisposeProvider<_Test>.internal( + generated, + name: r'generatedProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$generatedHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef GeneratedRef = AutoDisposeProviderRef<_Test>; +String _$generatedFamilyHash() => r'ed284f58926c87acc81dab9168882d5d1c2cddf8'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [generatedFamily]. +@ProviderFor(generatedFamily) +const generatedFamilyProvider = GeneratedFamilyFamily(); + +/// See also [generatedFamily]. +class GeneratedFamilyFamily extends Family<_Test> { + /// See also [generatedFamily]. + const GeneratedFamilyFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'generatedFamilyProvider'; + + /// See also [generatedFamily]. + GeneratedFamilyProvider call( + _Test test, + ) { + return GeneratedFamilyProvider( + test, + ); + } + + @visibleForOverriding + @override + GeneratedFamilyProvider getProviderOverride( + covariant GeneratedFamilyProvider provider, + ) { + return call( + provider.test, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(_Test Function(GeneratedFamilyRef ref) create) { + return _$GeneratedFamilyFamilyOverride(this, create); + } +} + +class _$GeneratedFamilyFamilyOverride implements FamilyOverride<_Test> { + _$GeneratedFamilyFamilyOverride(this.overriddenFamily, this.create); + + final _Test Function(GeneratedFamilyRef ref) create; + + @override + final GeneratedFamilyFamily overriddenFamily; + + @override + GeneratedFamilyProvider getProviderOverride( + covariant GeneratedFamilyProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [generatedFamily]. +class GeneratedFamilyProvider extends AutoDisposeProvider<_Test> { + /// See also [generatedFamily]. + GeneratedFamilyProvider( + _Test test, + ) : this._internal( + (ref) => generatedFamily( + ref as GeneratedFamilyRef, + test, + ), + from: generatedFamilyProvider, + name: r'generatedFamilyProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$generatedFamilyHash, + dependencies: GeneratedFamilyFamily._dependencies, + allTransitiveDependencies: + GeneratedFamilyFamily._allTransitiveDependencies, + test: test, + ); + + GeneratedFamilyProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.test, + }) : super.internal(); + + final _Test test; + + @override + Override overrideWith( + _Test Function(GeneratedFamilyRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: GeneratedFamilyProvider._internal( + (ref) => create(ref as GeneratedFamilyRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + test: test, + ), + ); + } + + @override + (_Test,) get argument { + return (test,); + } + + @override + AutoDisposeProviderElement<_Test> createElement() { + return _GeneratedFamilyProviderElement(this); + } + + GeneratedFamilyProvider _copyWith( + _Test Function(GeneratedFamilyRef ref) create, + ) { + return GeneratedFamilyProvider._internal( + (ref) => create(ref as GeneratedFamilyRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + test: test, + ); + } + + @override + bool operator ==(Object other) { + return other is GeneratedFamilyProvider && other.test == test; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, test.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin GeneratedFamilyRef on AutoDisposeProviderRef<_Test> { + /// The parameter `test` of this provider. + _Test get test; +} + +class _GeneratedFamilyProviderElement extends AutoDisposeProviderElement<_Test> + with GeneratedFamilyRef { + _GeneratedFamilyProviderElement(super.provider); + + @override + _Test get test => (origin as GeneratedFamilyProvider).test; +} + +String _$$dynamicHash() => r'f62d63d9340f30b253e687f76deacd8205fed0e7'; + +/// See also [$dynamic]. +@ProviderFor($dynamic) +final $dynamicProvider = AutoDisposeProvider.internal( + $dynamic, + name: r'$dynamicProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$$dynamicHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef $DynamicRef = AutoDisposeProviderRef; +String _$$dynamicFamilyHash() => r'b764133af8837b8321b08814892f198d4bc1aa18'; + +/// See also [$dynamicFamily]. +@ProviderFor($dynamicFamily) +const $dynamicFamilyProvider = $DynamicFamilyFamily(); + +/// See also [$dynamicFamily]. +class $DynamicFamilyFamily extends Family { + /// See also [$dynamicFamily]. + const $DynamicFamilyFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'$dynamicFamilyProvider'; + + /// See also [$dynamicFamily]. + $DynamicFamilyProvider call( + test, + ) { + return $DynamicFamilyProvider( + test, + ); + } + + @visibleForOverriding + @override + $DynamicFamilyProvider getProviderOverride( + covariant $DynamicFamilyProvider provider, + ) { + return call( + provider.test, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(Object? Function($DynamicFamilyRef ref) create) { + return _$$DynamicFamilyFamilyOverride(this, create); + } +} + +class _$$DynamicFamilyFamilyOverride implements FamilyOverride { + _$$DynamicFamilyFamilyOverride(this.overriddenFamily, this.create); + + final Object? Function($DynamicFamilyRef ref) create; + + @override + final $DynamicFamilyFamily overriddenFamily; + + @override + $DynamicFamilyProvider getProviderOverride( + covariant $DynamicFamilyProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [$dynamicFamily]. +class $DynamicFamilyProvider extends AutoDisposeProvider { + /// See also [$dynamicFamily]. + $DynamicFamilyProvider( + test, + ) : this._internal( + (ref) => $dynamicFamily( + ref as $DynamicFamilyRef, + test, + ), + from: $dynamicFamilyProvider, + name: r'$dynamicFamilyProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$$dynamicFamilyHash, + dependencies: $DynamicFamilyFamily._dependencies, + allTransitiveDependencies: + $DynamicFamilyFamily._allTransitiveDependencies, + test: test, + ); + + $DynamicFamilyProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.test, + }) : super.internal(); + + final test; + + @override + Override overrideWith( + Object? Function($DynamicFamilyRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: $DynamicFamilyProvider._internal( + (ref) => create(ref as $DynamicFamilyRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + test: test, + ), + ); + } + + @override + (dynamic,) get argument { + return (test,); + } + + @override + AutoDisposeProviderElement createElement() { + return _$DynamicFamilyProviderElement(this); + } + + $DynamicFamilyProvider _copyWith( + Object? Function($DynamicFamilyRef ref) create, + ) { + return $DynamicFamilyProvider._internal( + (ref) => create(ref as $DynamicFamilyRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + test: test, + ); + } + + @override + bool operator ==(Object other) { + return other is $DynamicFamilyProvider && other.test == test; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, test.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin $DynamicFamilyRef on AutoDisposeProviderRef { + /// The parameter `test` of this provider. + get test; +} + +class _$DynamicFamilyProviderElement extends AutoDisposeProviderElement + with $DynamicFamilyRef { + _$DynamicFamilyProviderElement(super.provider); + + @override + get test => (origin as $DynamicFamilyProvider).test; +} + +String _$dynamicHash() => r'da9dc07960139fff2cf5fe584dca5c524e4f2308'; + +/// See also [_dynamic]. +@ProviderFor(_dynamic) +const _dynamicProvider = _DynamicFamily(); + +/// See also [_dynamic]. +class _DynamicFamily extends Family { + /// See also [_dynamic]. + const _DynamicFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'_dynamicProvider'; + + /// See also [_dynamic]. + _DynamicProvider call( + test, + ) { + return _DynamicProvider( + test, + ); + } + + @visibleForOverriding + @override + _DynamicProvider getProviderOverride( + covariant _DynamicProvider provider, + ) { + return call( + provider.test, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(Object? Function(_DynamicRef ref) create) { + return _$DynamicFamilyOverride(this, create); + } +} + +class _$DynamicFamilyOverride implements FamilyOverride { + _$DynamicFamilyOverride(this.overriddenFamily, this.create); + + final Object? Function(_DynamicRef ref) create; + + @override + final _DynamicFamily overriddenFamily; + + @override + _DynamicProvider getProviderOverride( + covariant _DynamicProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [_dynamic]. +class _DynamicProvider extends AutoDisposeProvider { + /// See also [_dynamic]. + _DynamicProvider( + test, + ) : this._internal( + (ref) => _dynamic( + ref as _DynamicRef, + test, + ), + from: _dynamicProvider, + name: r'_dynamicProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$dynamicHash, + dependencies: _DynamicFamily._dependencies, + allTransitiveDependencies: _DynamicFamily._allTransitiveDependencies, + test: test, + ); + + _DynamicProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.test, + }) : super.internal(); + + final test; + + @override + Override overrideWith( + Object? Function(_DynamicRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: _DynamicProvider._internal( + (ref) => create(ref as _DynamicRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + test: test, + ), + ); + } + + @override + (dynamic,) get argument { + return (test,); + } + + @override + AutoDisposeProviderElement createElement() { + return _DynamicProviderElement(this); + } + + _DynamicProvider _copyWith( + Object? Function(_DynamicRef ref) create, + ) { + return _DynamicProvider._internal( + (ref) => create(ref as _DynamicRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + test: test, + ); + } + + @override + bool operator ==(Object other) { + return other is _DynamicProvider && other.test == test; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, test.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin _DynamicRef on AutoDisposeProviderRef { + /// The parameter `test` of this provider. + get test; +} + +class _DynamicProviderElement extends AutoDisposeProviderElement + with _DynamicRef { + _DynamicProviderElement(super.provider); + + @override + get test => (origin as _DynamicProvider).test; +} + +String _$aliasHash() => r'cc08ec4cc5ec0dc98bdb7f4dcbc035021b09bcf3'; + +/// See also [alias]. +@ProviderFor(alias) +final aliasProvider = AutoDisposeProvider>.internal( + alias, + name: r'aliasProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$aliasHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef AliasRef = AutoDisposeProviderRef>; +String _$aliasFamilyHash() => r'f345937d5750132f629aef41646b119a301f750b'; + +/// See also [aliasFamily]. +@ProviderFor(aliasFamily) +const aliasFamilyProvider = AliasFamilyFamily(); + +/// See also [aliasFamily]. +class AliasFamilyFamily extends Family> { + /// See also [aliasFamily]. + const AliasFamilyFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'aliasFamilyProvider'; + + /// See also [aliasFamily]. + AliasFamilyProvider call( + r.AsyncValue test, + ) { + return AliasFamilyProvider( + test, + ); + } + + @visibleForOverriding + @override + AliasFamilyProvider getProviderOverride( + covariant AliasFamilyProvider provider, + ) { + return call( + provider.test, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(r.AsyncValue Function(AliasFamilyRef ref) create) { + return _$AliasFamilyFamilyOverride(this, create); + } +} + +class _$AliasFamilyFamilyOverride implements FamilyOverride> { + _$AliasFamilyFamilyOverride(this.overriddenFamily, this.create); + + final r.AsyncValue Function(AliasFamilyRef ref) create; + + @override + final AliasFamilyFamily overriddenFamily; + + @override + AliasFamilyProvider getProviderOverride( + covariant AliasFamilyProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [aliasFamily]. +class AliasFamilyProvider extends AutoDisposeProvider> { + /// See also [aliasFamily]. + AliasFamilyProvider( + r.AsyncValue test, + ) : this._internal( + (ref) => aliasFamily( + ref as AliasFamilyRef, + test, + ), + from: aliasFamilyProvider, + name: r'aliasFamilyProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$aliasFamilyHash, + dependencies: AliasFamilyFamily._dependencies, + allTransitiveDependencies: + AliasFamilyFamily._allTransitiveDependencies, + test: test, + ); + + AliasFamilyProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.test, + }) : super.internal(); + + final r.AsyncValue test; + + @override + Override overrideWith( + r.AsyncValue Function(AliasFamilyRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: AliasFamilyProvider._internal( + (ref) => create(ref as AliasFamilyRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + test: test, + ), + ); + } + + @override + (r.AsyncValue,) get argument { + return (test,); + } + + @override + AutoDisposeProviderElement> createElement() { + return _AliasFamilyProviderElement(this); + } + + AliasFamilyProvider _copyWith( + r.AsyncValue Function(AliasFamilyRef ref) create, + ) { + return AliasFamilyProvider._internal( + (ref) => create(ref as AliasFamilyRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + test: test, + ); + } + + @override + bool operator ==(Object other) { + return other is AliasFamilyProvider && other.test == test; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, test.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin AliasFamilyRef on AutoDisposeProviderRef> { + /// The parameter `test` of this provider. + r.AsyncValue get test; +} + +class _AliasFamilyProviderElement + extends AutoDisposeProviderElement> with AliasFamilyRef { + _AliasFamilyProviderElement(super.provider); + + @override + r.AsyncValue get test => (origin as AliasFamilyProvider).test; +} + +String _$generatedClassHash() => r'984153f97e25de687d2f19756b277aabd56f6e72'; + +/// See also [GeneratedClass]. +@ProviderFor(GeneratedClass) +final generatedClassProvider = + AutoDisposeNotifierProvider.internal( + GeneratedClass.new, + name: r'generatedClassProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$generatedClassHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$GeneratedClass = AutoDisposeNotifier<_Test>; +String _$generatedClassFamilyHash() => + r'28d0a5a82af5b254f6ef07b492916e2feb7e6e63'; + +abstract class _$GeneratedClassFamily + extends BuildlessAutoDisposeNotifier<_Test> { + late final _Test test; + + _Test build( + _Test test, + ); +} + +/// See also [GeneratedClassFamily]. +@ProviderFor(GeneratedClassFamily) +const generatedClassFamilyProvider = GeneratedClassFamilyFamily(); + +/// See also [GeneratedClassFamily]. +class GeneratedClassFamilyFamily extends Family<_Test> { + /// See also [GeneratedClassFamily]. + const GeneratedClassFamilyFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'generatedClassFamilyProvider'; + + /// See also [GeneratedClassFamily]. + GeneratedClassFamilyProvider call( + _Test test, + ) { + return GeneratedClassFamilyProvider( + test, + ); + } + + @visibleForOverriding + @override + GeneratedClassFamilyProvider getProviderOverride( + covariant GeneratedClassFamilyProvider provider, + ) { + return call( + provider.test, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(GeneratedClassFamily Function() create) { + return _$GeneratedClassFamilyFamilyOverride(this, create); + } +} + +class _$GeneratedClassFamilyFamilyOverride implements FamilyOverride<_Test> { + _$GeneratedClassFamilyFamilyOverride(this.overriddenFamily, this.create); + + final GeneratedClassFamily Function() create; + + @override + final GeneratedClassFamilyFamily overriddenFamily; + + @override + GeneratedClassFamilyProvider getProviderOverride( + covariant GeneratedClassFamilyProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [GeneratedClassFamily]. +class GeneratedClassFamilyProvider + extends AutoDisposeNotifierProviderImpl { + /// See also [GeneratedClassFamily]. + GeneratedClassFamilyProvider( + _Test test, + ) : this._internal( + () => GeneratedClassFamily()..test = test, + from: generatedClassFamilyProvider, + name: r'generatedClassFamilyProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$generatedClassFamilyHash, + dependencies: GeneratedClassFamilyFamily._dependencies, + allTransitiveDependencies: + GeneratedClassFamilyFamily._allTransitiveDependencies, + test: test, + ); + + GeneratedClassFamilyProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.test, + }) : super.internal(); + + final _Test test; + + @override + _Test runNotifierBuild( + covariant GeneratedClassFamily notifier, + ) { + return notifier.build( + test, + ); + } + + @override + Override overrideWith(GeneratedClassFamily Function() create) { + return ProviderOverride( + origin: this, + override: GeneratedClassFamilyProvider._internal( + () => create()..test = test, + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + test: test, + ), + ); + } + + @override + (_Test,) get argument { + return (test,); + } + + @override + AutoDisposeNotifierProviderElement + createElement() { + return _GeneratedClassFamilyProviderElement(this); + } + + GeneratedClassFamilyProvider _copyWith( + GeneratedClassFamily Function() create, + ) { + return GeneratedClassFamilyProvider._internal( + () => create()..test = test, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + test: test, + ); + } + + @override + bool operator ==(Object other) { + return other is GeneratedClassFamilyProvider && other.test == test; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, test.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin GeneratedClassFamilyRef on AutoDisposeNotifierProviderRef<_Test> { + /// The parameter `test` of this provider. + _Test get test; +} + +class _GeneratedClassFamilyProviderElement + extends AutoDisposeNotifierProviderElement + with GeneratedClassFamilyRef { + _GeneratedClassFamilyProviderElement(super.provider); + + @override + _Test get test => (origin as GeneratedClassFamilyProvider).test; +} + +String _$$dynamicClassHash() => r'c6d8e5191c3f060df3ce3eee66107433fd4c3292'; + +/// See also [$DynamicClass]. +@ProviderFor($DynamicClass) +final $dynamicClassProvider = + AutoDisposeNotifierProvider<$DynamicClass, Object?>.internal( + $DynamicClass.new, + name: r'$dynamicClassProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$$dynamicClassHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$$DynamicClass = AutoDisposeNotifier; +String _$$dynamicClassFamilyHash() => + r'bdda961386f3b647c071d79293a8da441580c470'; + +abstract class _$$DynamicClassFamily + extends BuildlessAutoDisposeNotifier { + late final test; + + Object? build( + test, + ); +} + +/// See also [$DynamicClassFamily]. +@ProviderFor($DynamicClassFamily) +const $dynamicClassFamilyProvider = $DynamicClassFamilyFamily(); + +/// See also [$DynamicClassFamily]. +class $DynamicClassFamilyFamily extends Family { + /// See also [$DynamicClassFamily]. + const $DynamicClassFamilyFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'$dynamicClassFamilyProvider'; + + /// See also [$DynamicClassFamily]. + $DynamicClassFamilyProvider call( + test, + ) { + return $DynamicClassFamilyProvider( + test, + ); + } + + @visibleForOverriding + @override + $DynamicClassFamilyProvider getProviderOverride( + covariant $DynamicClassFamilyProvider provider, + ) { + return call( + provider.test, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith($DynamicClassFamily Function() create) { + return _$$DynamicClassFamilyFamilyOverride(this, create); + } +} + +class _$$DynamicClassFamilyFamilyOverride implements FamilyOverride { + _$$DynamicClassFamilyFamilyOverride(this.overriddenFamily, this.create); + + final $DynamicClassFamily Function() create; + + @override + final $DynamicClassFamilyFamily overriddenFamily; + + @override + $DynamicClassFamilyProvider getProviderOverride( + covariant $DynamicClassFamilyProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [$DynamicClassFamily]. +class $DynamicClassFamilyProvider + extends AutoDisposeNotifierProviderImpl<$DynamicClassFamily, Object?> { + /// See also [$DynamicClassFamily]. + $DynamicClassFamilyProvider( + test, + ) : this._internal( + () => $DynamicClassFamily()..test = test, + from: $dynamicClassFamilyProvider, + name: r'$dynamicClassFamilyProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$$dynamicClassFamilyHash, + dependencies: $DynamicClassFamilyFamily._dependencies, + allTransitiveDependencies: + $DynamicClassFamilyFamily._allTransitiveDependencies, + test: test, + ); + + $DynamicClassFamilyProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.test, + }) : super.internal(); + + final test; + + @override + Object? runNotifierBuild( + covariant $DynamicClassFamily notifier, + ) { + return notifier.build( + test, + ); + } + + @override + Override overrideWith($DynamicClassFamily Function() create) { + return ProviderOverride( + origin: this, + override: $DynamicClassFamilyProvider._internal( + () => create()..test = test, + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + test: test, + ), + ); + } + + @override + (dynamic,) get argument { + return (test,); + } + + @override + AutoDisposeNotifierProviderElement<$DynamicClassFamily, Object?> + createElement() { + return _$DynamicClassFamilyProviderElement(this); + } + + $DynamicClassFamilyProvider _copyWith( + $DynamicClassFamily Function() create, + ) { + return $DynamicClassFamilyProvider._internal( + () => create()..test = test, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + test: test, + ); + } + + @override + bool operator ==(Object other) { + return other is $DynamicClassFamilyProvider && other.test == test; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, test.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin $DynamicClassFamilyRef on AutoDisposeNotifierProviderRef { + /// The parameter `test` of this provider. + get test; +} + +class _$DynamicClassFamilyProviderElement + extends AutoDisposeNotifierProviderElement<$DynamicClassFamily, Object?> + with $DynamicClassFamilyRef { + _$DynamicClassFamilyProviderElement(super.provider); + + @override + get test => (origin as $DynamicClassFamilyProvider).test; +} + +String _$aliasClassHash() => r'a6c6d7594ebd09ba728e42d79b12af560d09c379'; + +/// See also [AliasClass]. +@ProviderFor(AliasClass) +final aliasClassProvider = + AutoDisposeNotifierProvider>.internal( + AliasClass.new, + name: r'aliasClassProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$aliasClassHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$AliasClass = AutoDisposeNotifier>; +String _$aliasClassFamilyHash() => r'3f348beb95dae3a9890b4a4d0ce01481316fc66d'; + +abstract class _$AliasClassFamily + extends BuildlessAutoDisposeNotifier> { + late final r.AsyncValue test; + + r.AsyncValue build( + r.AsyncValue test, + ); +} + +/// See also [AliasClassFamily]. +@ProviderFor(AliasClassFamily) +const aliasClassFamilyProvider = AliasClassFamilyFamily(); + +/// See also [AliasClassFamily]. +class AliasClassFamilyFamily extends Family> { + /// See also [AliasClassFamily]. + const AliasClassFamilyFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'aliasClassFamilyProvider'; + + /// See also [AliasClassFamily]. + AliasClassFamilyProvider call( + r.AsyncValue test, + ) { + return AliasClassFamilyProvider( + test, + ); + } + + @visibleForOverriding + @override + AliasClassFamilyProvider getProviderOverride( + covariant AliasClassFamilyProvider provider, + ) { + return call( + provider.test, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(AliasClassFamily Function() create) { + return _$AliasClassFamilyFamilyOverride(this, create); + } +} + +class _$AliasClassFamilyFamilyOverride + implements FamilyOverride> { + _$AliasClassFamilyFamilyOverride(this.overriddenFamily, this.create); + + final AliasClassFamily Function() create; + + @override + final AliasClassFamilyFamily overriddenFamily; + + @override + AliasClassFamilyProvider getProviderOverride( + covariant AliasClassFamilyProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [AliasClassFamily]. +class AliasClassFamilyProvider extends AutoDisposeNotifierProviderImpl< + AliasClassFamily, r.AsyncValue> { + /// See also [AliasClassFamily]. + AliasClassFamilyProvider( + r.AsyncValue test, + ) : this._internal( + () => AliasClassFamily()..test = test, + from: aliasClassFamilyProvider, + name: r'aliasClassFamilyProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$aliasClassFamilyHash, + dependencies: AliasClassFamilyFamily._dependencies, + allTransitiveDependencies: + AliasClassFamilyFamily._allTransitiveDependencies, + test: test, + ); + + AliasClassFamilyProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.test, + }) : super.internal(); + + final r.AsyncValue test; + + @override + r.AsyncValue runNotifierBuild( + covariant AliasClassFamily notifier, + ) { + return notifier.build( + test, + ); + } + + @override + Override overrideWith(AliasClassFamily Function() create) { + return ProviderOverride( + origin: this, + override: AliasClassFamilyProvider._internal( + () => create()..test = test, + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + test: test, + ), + ); + } + + @override + (r.AsyncValue,) get argument { + return (test,); + } + + @override + AutoDisposeNotifierProviderElement> + createElement() { + return _AliasClassFamilyProviderElement(this); + } + + AliasClassFamilyProvider _copyWith( + AliasClassFamily Function() create, + ) { + return AliasClassFamilyProvider._internal( + () => create()..test = test, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + test: test, + ); + } + + @override + bool operator ==(Object other) { + return other is AliasClassFamilyProvider && other.test == test; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, test.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin AliasClassFamilyRef on AutoDisposeNotifierProviderRef> { + /// The parameter `test` of this provider. + r.AsyncValue get test; +} + +class _AliasClassFamilyProviderElement + extends AutoDisposeNotifierProviderElement> with AliasClassFamilyRef { + _AliasClassFamilyProviderElement(super.provider); + + @override + r.AsyncValue get test => (origin as AliasClassFamilyProvider).test; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index 8fd887b16..687aed714 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -50,4 +50,4 @@ final simpleClassProvider = typedef _$SimpleClass = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index eb436b0d5..5417662f4 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -24,4 +24,4 @@ final scopedProvider = AutoDisposeProvider.internal( typedef ScopedRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/split.dart b/packages/riverpod_generator/test/integration/split.dart index cceca20c9..543f7e6fc 100644 --- a/packages/riverpod_generator/test/integration/split.dart +++ b/packages/riverpod_generator/test/integration/split.dart @@ -1,4 +1,4 @@ -// Regresion test for https://github.com/rrousselGit/riverpod/issues/2175 +// Regression test for https://github.com/rrousselGit/riverpod/issues/2175 import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'split2.dart'; diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index 40f69d5b7..3d46657c5 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -35,4 +35,4 @@ final counterProvider = AutoDisposeProvider.internal( typedef CounterRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 578941b4e..712b69cf2 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -181,6 +181,20 @@ class FamilyFamily extends Family { /// See also [family]. const FamilyFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyProvider'; + /// See also [family]. FamilyProvider call( int first, { @@ -198,6 +212,7 @@ class FamilyFamily extends Family { ); } + @visibleForOverriding @override FamilyProvider getProviderOverride( covariant FamilyProvider provider, @@ -211,19 +226,26 @@ class FamilyFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(Stream Function(FamilyRef ref) create) { + return _$FamilyFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FamilyFamilyOverride implements FamilyOverride> { + _$FamilyFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final Stream Function(FamilyRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FamilyFamily overriddenFamily; @override - String? get name => r'familyProvider'; + FamilyProvider getProviderOverride( + covariant FamilyProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [family]. @@ -260,7 +282,7 @@ class FamilyProvider extends AutoDisposeStreamProvider { ); FamilyProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -281,7 +303,7 @@ class FamilyProvider extends AutoDisposeStreamProvider { @override Override overrideWith( - Stream Function(FamilyRef provider) create, + Stream Function(FamilyRef ref) create, ) { return ProviderOverride( origin: this, @@ -301,11 +323,46 @@ class FamilyProvider extends AutoDisposeStreamProvider { ); } + @override + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) get argument { + return ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ); + } + @override AutoDisposeStreamProviderElement createElement() { return _FamilyProviderElement(this); } + FamilyProvider _copyWith( + Stream Function(FamilyRef ref) create, + ) { + return FamilyProvider._internal( + (ref) => create(ref as FamilyRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + first: first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ); + } + @override bool operator ==(Object other) { return other is FamilyProvider && @@ -547,6 +604,20 @@ class FamilyClassFamily extends Family { /// See also [FamilyClass]. const FamilyClassFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyClassProvider'; + /// See also [FamilyClass]. FamilyClassProvider call( int first, { @@ -564,6 +635,7 @@ class FamilyClassFamily extends Family { ); } + @visibleForOverriding @override FamilyClassProvider getProviderOverride( covariant FamilyClassProvider provider, @@ -577,19 +649,27 @@ class FamilyClassFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FamilyClass Function() create) { + return _$FamilyClassFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FamilyClassFamilyOverride + implements FamilyOverride> { + _$FamilyClassFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FamilyClass Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FamilyClassFamily overriddenFamily; @override - String? get name => r'familyClassProvider'; + FamilyClassProvider getProviderOverride( + covariant FamilyClassProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [FamilyClass]. @@ -626,7 +706,7 @@ class FamilyClassProvider ); FamilyClassProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -683,12 +763,52 @@ class FamilyClassProvider ); } + @override + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) get argument { + return ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ); + } + @override AutoDisposeStreamNotifierProviderElement createElement() { return _FamilyClassProviderElement(this); } + FamilyClassProvider _copyWith( + FamilyClass Function() create, + ) { + return FamilyClassProvider._internal( + () => create() + ..first = first + ..second = second + ..third = third + ..fourth = fourth + ..fifth = fifth, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + first: first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ); + } + @override bool operator ==(Object other) { return other is FamilyClassProvider && @@ -746,4 +866,4 @@ class _FamilyClassProviderElement List? get fifth => (origin as FamilyClassProvider).fifth; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 34d63448d..ac74a9b1f 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -342,6 +342,20 @@ class RawFamilyFutureFamily extends Family { /// See also [rawFamilyFuture]. const RawFamilyFutureFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'rawFamilyFutureProvider'; + /// See also [rawFamilyFuture]. RawFamilyFutureProvider call( int id, @@ -351,6 +365,7 @@ class RawFamilyFutureFamily extends Family { ); } + @visibleForOverriding @override RawFamilyFutureProvider getProviderOverride( covariant RawFamilyFutureProvider provider, @@ -360,19 +375,28 @@ class RawFamilyFutureFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith( + Raw> Function(RawFamilyFutureRef ref) create) { + return _$RawFamilyFutureFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$RawFamilyFutureFamilyOverride + implements FamilyOverride>> { + _$RawFamilyFutureFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final Raw> Function(RawFamilyFutureRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final RawFamilyFutureFamily overriddenFamily; @override - String? get name => r'rawFamilyFutureProvider'; + RawFamilyFutureProvider getProviderOverride( + covariant RawFamilyFutureProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [rawFamilyFuture]. @@ -398,7 +422,7 @@ class RawFamilyFutureProvider extends AutoDisposeProvider>> { ); RawFamilyFutureProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -411,7 +435,7 @@ class RawFamilyFutureProvider extends AutoDisposeProvider>> { @override Override overrideWith( - Raw> Function(RawFamilyFutureRef provider) create, + Raw> Function(RawFamilyFutureRef ref) create, ) { return ProviderOverride( origin: this, @@ -427,11 +451,30 @@ class RawFamilyFutureProvider extends AutoDisposeProvider>> { ); } + @override + (int,) get argument { + return (id,); + } + @override AutoDisposeProviderElement>> createElement() { return _RawFamilyFutureProviderElement(this); } + RawFamilyFutureProvider _copyWith( + Raw> Function(RawFamilyFutureRef ref) create, + ) { + return RawFamilyFutureProvider._internal( + (ref) => create(ref as RawFamilyFutureRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + id: id, + ); + } + @override bool operator ==(Object other) { return other is RawFamilyFutureProvider && other.id == id; @@ -471,6 +514,20 @@ class RawFamilyStreamFamily extends Family { /// See also [rawFamilyStream]. const RawFamilyStreamFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'rawFamilyStreamProvider'; + /// See also [rawFamilyStream]. RawFamilyStreamProvider call( int id, @@ -480,6 +537,7 @@ class RawFamilyStreamFamily extends Family { ); } + @visibleForOverriding @override RawFamilyStreamProvider getProviderOverride( covariant RawFamilyStreamProvider provider, @@ -489,19 +547,28 @@ class RawFamilyStreamFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith( + Raw> Function(RawFamilyStreamRef ref) create) { + return _$RawFamilyStreamFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$RawFamilyStreamFamilyOverride + implements FamilyOverride>> { + _$RawFamilyStreamFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final Raw> Function(RawFamilyStreamRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final RawFamilyStreamFamily overriddenFamily; @override - String? get name => r'rawFamilyStreamProvider'; + RawFamilyStreamProvider getProviderOverride( + covariant RawFamilyStreamProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [rawFamilyStream]. @@ -527,7 +594,7 @@ class RawFamilyStreamProvider extends AutoDisposeProvider>> { ); RawFamilyStreamProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -540,7 +607,7 @@ class RawFamilyStreamProvider extends AutoDisposeProvider>> { @override Override overrideWith( - Raw> Function(RawFamilyStreamRef provider) create, + Raw> Function(RawFamilyStreamRef ref) create, ) { return ProviderOverride( origin: this, @@ -556,11 +623,30 @@ class RawFamilyStreamProvider extends AutoDisposeProvider>> { ); } + @override + (int,) get argument { + return (id,); + } + @override AutoDisposeProviderElement>> createElement() { return _RawFamilyStreamProviderElement(this); } + RawFamilyStreamProvider _copyWith( + Raw> Function(RawFamilyStreamRef ref) create, + ) { + return RawFamilyStreamProvider._internal( + (ref) => create(ref as RawFamilyStreamRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + id: id, + ); + } + @override bool operator ==(Object other) { return other is RawFamilyStreamProvider && other.id == id; @@ -637,6 +723,20 @@ class FamilyFamily extends Family { /// Copied from [family]. const FamilyFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyProvider'; + /// This is some documentation /// /// Copied from [family]. @@ -656,6 +756,7 @@ class FamilyFamily extends Family { ); } + @visibleForOverriding @override FamilyProvider getProviderOverride( covariant FamilyProvider provider, @@ -669,19 +770,26 @@ class FamilyFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(String Function(FamilyRef ref) create) { + return _$FamilyFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FamilyFamilyOverride implements FamilyOverride { + _$FamilyFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final String Function(FamilyRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FamilyFamily overriddenFamily; @override - String? get name => r'familyProvider'; + FamilyProvider getProviderOverride( + covariant FamilyProvider provider, + ) { + return provider._copyWith(create); + } } /// This is some documentation @@ -722,7 +830,7 @@ class FamilyProvider extends AutoDisposeProvider { ); FamilyProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -743,7 +851,7 @@ class FamilyProvider extends AutoDisposeProvider { @override Override overrideWith( - String Function(FamilyRef provider) create, + String Function(FamilyRef ref) create, ) { return ProviderOverride( origin: this, @@ -763,11 +871,46 @@ class FamilyProvider extends AutoDisposeProvider { ); } + @override + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) get argument { + return ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ); + } + @override AutoDisposeProviderElement createElement() { return _FamilyProviderElement(this); } + FamilyProvider _copyWith( + String Function(FamilyRef ref) create, + ) { + return FamilyProvider._internal( + (ref) => create(ref as FamilyRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + first: first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ); + } + @override bool operator ==(Object other) { return other is FamilyProvider && @@ -1031,6 +1174,20 @@ class RawFamilyFutureClassFamily extends Family { /// See also [RawFamilyFutureClass]. const RawFamilyFutureClassFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'rawFamilyFutureClassProvider'; + /// See also [RawFamilyFutureClass]. RawFamilyFutureClassProvider call( int id, @@ -1040,6 +1197,7 @@ class RawFamilyFutureClassFamily extends Family { ); } + @visibleForOverriding @override RawFamilyFutureClassProvider getProviderOverride( covariant RawFamilyFutureClassProvider provider, @@ -1049,19 +1207,27 @@ class RawFamilyFutureClassFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(RawFamilyFutureClass Function() create) { + return _$RawFamilyFutureClassFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$RawFamilyFutureClassFamilyOverride + implements FamilyOverride>> { + _$RawFamilyFutureClassFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final RawFamilyFutureClass Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final RawFamilyFutureClassFamily overriddenFamily; @override - String? get name => r'rawFamilyFutureClassProvider'; + RawFamilyFutureClassProvider getProviderOverride( + covariant RawFamilyFutureClassProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [RawFamilyFutureClass]. @@ -1085,7 +1251,7 @@ class RawFamilyFutureClassProvider extends AutoDisposeNotifierProviderImpl< ); RawFamilyFutureClassProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -1121,12 +1287,31 @@ class RawFamilyFutureClassProvider extends AutoDisposeNotifierProviderImpl< ); } + @override + (int,) get argument { + return (id,); + } + @override AutoDisposeNotifierProviderElement>> createElement() { return _RawFamilyFutureClassProviderElement(this); } + RawFamilyFutureClassProvider _copyWith( + RawFamilyFutureClass Function() create, + ) { + return RawFamilyFutureClassProvider._internal( + () => create()..id = id, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + id: id, + ); + } + @override bool operator ==(Object other) { return other is RawFamilyFutureClassProvider && other.id == id; @@ -1177,6 +1362,20 @@ class RawFamilyStreamClassFamily extends Family { /// See also [RawFamilyStreamClass]. const RawFamilyStreamClassFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'rawFamilyStreamClassProvider'; + /// See also [RawFamilyStreamClass]. RawFamilyStreamClassProvider call( int id, @@ -1186,6 +1385,7 @@ class RawFamilyStreamClassFamily extends Family { ); } + @visibleForOverriding @override RawFamilyStreamClassProvider getProviderOverride( covariant RawFamilyStreamClassProvider provider, @@ -1195,19 +1395,27 @@ class RawFamilyStreamClassFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(RawFamilyStreamClass Function() create) { + return _$RawFamilyStreamClassFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$RawFamilyStreamClassFamilyOverride + implements FamilyOverride>> { + _$RawFamilyStreamClassFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final RawFamilyStreamClass Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final RawFamilyStreamClassFamily overriddenFamily; @override - String? get name => r'rawFamilyStreamClassProvider'; + RawFamilyStreamClassProvider getProviderOverride( + covariant RawFamilyStreamClassProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [RawFamilyStreamClass]. @@ -1231,7 +1439,7 @@ class RawFamilyStreamClassProvider extends AutoDisposeNotifierProviderImpl< ); RawFamilyStreamClassProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -1267,12 +1475,31 @@ class RawFamilyStreamClassProvider extends AutoDisposeNotifierProviderImpl< ); } + @override + (int,) get argument { + return (id,); + } + @override AutoDisposeNotifierProviderElement>> createElement() { return _RawFamilyStreamClassProviderElement(this); } + RawFamilyStreamClassProvider _copyWith( + RawFamilyStreamClass Function() create, + ) { + return RawFamilyStreamClassProvider._internal( + () => create()..id = id, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + id: id, + ); + } + @override bool operator ==(Object other) { return other is RawFamilyStreamClassProvider && other.id == id; @@ -1367,6 +1594,20 @@ class FamilyClassFamily extends Family { /// Copied from [FamilyClass]. const FamilyClassFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyClassProvider'; + /// This is some documentation /// /// Copied from [FamilyClass]. @@ -1386,6 +1627,7 @@ class FamilyClassFamily extends Family { ); } + @visibleForOverriding @override FamilyClassProvider getProviderOverride( covariant FamilyClassProvider provider, @@ -1399,19 +1641,26 @@ class FamilyClassFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FamilyClass Function() create) { + return _$FamilyClassFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FamilyClassFamilyOverride implements FamilyOverride { + _$FamilyClassFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FamilyClass Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FamilyClassFamily overriddenFamily; @override - String? get name => r'familyClassProvider'; + FamilyClassProvider getProviderOverride( + covariant FamilyClassProvider provider, + ) { + return provider._copyWith(create); + } } /// This is some documentation @@ -1452,7 +1701,7 @@ class FamilyClassProvider ); FamilyClassProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -1509,11 +1758,51 @@ class FamilyClassProvider ); } + @override + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) get argument { + return ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ); + } + @override AutoDisposeNotifierProviderElement createElement() { return _FamilyClassProviderElement(this); } + FamilyClassProvider _copyWith( + FamilyClass Function() create, + ) { + return FamilyClassProvider._internal( + () => create() + ..first = first + ..second = second + ..third = third + ..fourth = fourth + ..fifth = fifth, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + first: first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ); + } + @override bool operator ==(Object other) { return other is FamilyClassProvider && @@ -1589,4 +1878,4 @@ final supports$InClassNameProvider = typedef _$Supports$InClassName = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/stream_test.dart b/packages/riverpod_generator/test/stream_test.dart index fa6d54ee2..256715423 100644 --- a/packages/riverpod_generator/test/stream_test.dart +++ b/packages/riverpod_generator/test/stream_test.dart @@ -127,4 +127,38 @@ void main() { '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', ); }); + + test('can override providers', () { + final container = createContainer( + overrides: [ + publicProvider.overrideWith((ref) { + ref.state = const AsyncData('test'); + return const Stream.empty(); + }), + publicClassProvider.overrideWith(() => PublicClass(42)), + familyProvider.overrideWith( + (ref) { + ref.state = AsyncData( + 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})', + ); + return const Stream.empty(); + }, + ), + familyClassProvider.overrideWith(() => FamilyClass(42)), + ], + ); + + expect(container.read(publicProvider).requireValue, 'test'); + expect(container.read(publicClassProvider.notifier).param, 42); + expect( + container.read(familyProvider(42, second: '42', third: .42)).requireValue, + 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', + ); + expect( + container + .read(familyClassProvider(42, second: '42', third: .42).notifier) + .param, + 42, + ); + }); } diff --git a/packages/riverpod_generator/test/sync_test.dart b/packages/riverpod_generator/test/sync_test.dart index 3da99a585..49cd17c33 100644 --- a/packages/riverpod_generator/test/sync_test.dart +++ b/packages/riverpod_generator/test/sync_test.dart @@ -1,5 +1,10 @@ -// ignore_for_file: omit_local_variable_types, unused_local_variable +// ignore_for_file: omit_local_variable_types, unused_local_variable, require_trailing_commas +import 'dart:io'; + +import 'package:analyzer/dart/analysis/results.dart'; +import 'package:analyzer/dart/analysis/utilities.dart'; +import 'package:path/path.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:test/test.dart'; @@ -184,6 +189,19 @@ void main() { expect(familyProvider(42, third: .42).name, 'familyProvider'); }); + test('Marks getProviderOverride as @visibleForOverriding', () async { + final file = File('test/integration/sync.dart'); + final path = normalize(file.absolute.path); + + final library = await resolveFile2(path: path); + library as ResolvedUnitResult; + + final clazz = library.libraryElement.getClass('FamilyClassFamily')!; + final method = clazz.getMethod('getProviderOverride')!; + + expect(method.hasVisibleForOverriding, isTrue); + }); + test( 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', () { @@ -231,7 +249,7 @@ void main() { second: 'x42', third: .42, fourth: false, - fifth: ['x42'], + fifth: const ['x42'], ); final AutoDisposeProvider futureProvider = provider; @@ -241,6 +259,25 @@ void main() { expect(provider.fourth, false); expect(provider.fifth, ['x42']); + final ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) argument = provider.argument; + + expect( + argument, + ( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: const ['x42'], + ), + ); + final String result = container.read( familyProvider( 42, @@ -256,4 +293,29 @@ void main() { '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', ); }); + + test('can override providers', () { + final container = createContainer(overrides: [ + publicProvider.overrideWith((ref) => 'test'), + publicClassProvider.overrideWith(() => PublicClass(42)), + familyProvider.overrideWith( + (ref) => + 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})', + ), + familyClassProvider.overrideWith(() => FamilyClass(42)), + ]); + + expect(container.read(publicProvider), 'test'); + expect(container.read(publicClassProvider.notifier).param, 42); + expect( + container.read(familyProvider(42, second: '42', third: .42)), + 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', + ); + expect( + container + .read(familyClassProvider(42, second: '42', third: .42).notifier) + .param, + 42, + ); + }); } diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 94249390e..1235ead9a 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -77,6 +77,20 @@ class FamilyFamily extends Family { /// Copied from [family]. const FamilyFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyProvider'; + /// A generated family provider. /// /// Copied from [family]. @@ -96,6 +110,7 @@ class FamilyFamily extends Family { ); } + @visibleForOverriding @override FamilyProvider getProviderOverride( covariant FamilyProvider provider, @@ -109,19 +124,26 @@ class FamilyFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(String Function(FamilyRef ref) create) { + return _$FamilyFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FamilyFamilyOverride implements FamilyOverride { + _$FamilyFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final String Function(FamilyRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FamilyFamily overriddenFamily; @override - String? get name => r'familyProvider'; + FamilyProvider getProviderOverride( + covariant FamilyProvider provider, + ) { + return provider._copyWith(create); + } } /// A generated family provider. @@ -162,7 +184,7 @@ class FamilyProvider extends AutoDisposeProvider { ); FamilyProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -183,7 +205,7 @@ class FamilyProvider extends AutoDisposeProvider { @override Override overrideWith( - String Function(FamilyRef provider) create, + String Function(FamilyRef ref) create, ) { return ProviderOverride( origin: this, @@ -203,11 +225,46 @@ class FamilyProvider extends AutoDisposeProvider { ); } + @override + ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }) get argument { + return ( + first, + second: second, + third: third, + forth: forth, + fifth: fifth, + ); + } + @override AutoDisposeProviderElement createElement() { return _FamilyProviderElement(this); } + FamilyProvider _copyWith( + String Function(FamilyRef ref) create, + ) { + return FamilyProvider._internal( + (ref) => create(ref as FamilyRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + first: first, + second: second, + third: third, + forth: forth, + fifth: fifth, + ); + } + @override bool operator ==(Object other) { return other is FamilyProvider && @@ -343,6 +400,20 @@ class FamilyClassFamily extends Family { /// Copied from [FamilyClass]. const FamilyClassFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyClassProvider'; + /// A generated family provider from a class. /// /// Copied from [FamilyClass]. @@ -362,6 +433,7 @@ class FamilyClassFamily extends Family { ); } + @visibleForOverriding @override FamilyClassProvider getProviderOverride( covariant FamilyClassProvider provider, @@ -375,19 +447,26 @@ class FamilyClassFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FamilyClass Function() create) { + return _$FamilyClassFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FamilyClassFamilyOverride implements FamilyOverride { + _$FamilyClassFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FamilyClass Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FamilyClassFamily overriddenFamily; @override - String? get name => r'familyClassProvider'; + FamilyClassProvider getProviderOverride( + covariant FamilyClassProvider provider, + ) { + return provider._copyWith(create); + } } /// A generated family provider from a class. @@ -428,7 +507,7 @@ class FamilyClassProvider ); FamilyClassProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -485,11 +564,51 @@ class FamilyClassProvider ); } + @override + ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }) get argument { + return ( + first, + second: second, + third: third, + forth: forth, + fifth: fifth, + ); + } + @override AutoDisposeNotifierProviderElement createElement() { return _FamilyClassProviderElement(this); } + FamilyClassProvider _copyWith( + FamilyClass Function() create, + ) { + return FamilyClassProvider._internal( + () => create() + ..first = first + ..second = second + ..third = third + ..forth = forth + ..fifth = fifth, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + first: first, + second: second, + third: third, + forth: forth, + fifth: fifth, + ); + } + @override bool operator ==(Object other) { return other is FamilyClassProvider && @@ -567,4 +686,4 @@ final supports$InClassNameProvider = typedef _$Supports$InClassName = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index 8eba38393..18cd9af98 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -70,6 +70,20 @@ class ExampleFamilyFamily extends Family { /// Copied from [ExampleFamily]. const ExampleFamilyFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'exampleFamilyProvider'; + /// Some comment /// /// Copied from [ExampleFamily]. @@ -83,6 +97,7 @@ class ExampleFamilyFamily extends Family { ); } + @visibleForOverriding @override ExampleFamilyProvider getProviderOverride( covariant ExampleFamilyProvider provider, @@ -93,19 +108,26 @@ class ExampleFamilyFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(ExampleFamily Function() create) { + return _$ExampleFamilyFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$ExampleFamilyFamilyOverride implements FamilyOverride { + _$ExampleFamilyFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final ExampleFamily Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final ExampleFamilyFamily overriddenFamily; @override - String? get name => r'exampleFamilyProvider'; + ExampleFamilyProvider getProviderOverride( + covariant ExampleFamilyProvider provider, + ) { + return provider._copyWith(create); + } } /// Some comment @@ -137,7 +159,7 @@ class ExampleFamilyProvider ); ExampleFamilyProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -179,11 +201,39 @@ class ExampleFamilyProvider ); } + @override + ({ + int a, + String b, + }) get argument { + return ( + a: a, + b: b, + ); + } + @override AutoDisposeNotifierProviderElement createElement() { return _ExampleFamilyProviderElement(this); } + ExampleFamilyProvider _copyWith( + ExampleFamily Function() create, + ) { + return ExampleFamilyProvider._internal( + () => create() + ..a = a + ..b = b, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + a: a, + b: b, + ); + } + @override bool operator ==(Object other) { return other is ExampleFamilyProvider && other.a == a && other.b == b; @@ -342,4 +392,4 @@ class _GenericProviderElement _GenericProviderElement(super.provider); } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index 1588f718e..f626e08bf 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -60,6 +60,20 @@ class ExampleFamilyFamily extends Family { /// Copied from [exampleFamily]. const ExampleFamilyFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'exampleFamilyProvider'; + /// Some comment /// /// Copied from [exampleFamily]. @@ -73,6 +87,7 @@ class ExampleFamilyFamily extends Family { ); } + @visibleForOverriding @override ExampleFamilyProvider getProviderOverride( covariant ExampleFamilyProvider provider, @@ -83,19 +98,26 @@ class ExampleFamilyFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(int Function(ExampleFamilyRef ref) create) { + return _$ExampleFamilyFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$ExampleFamilyFamilyOverride implements FamilyOverride { + _$ExampleFamilyFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final int Function(ExampleFamilyRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final ExampleFamilyFamily overriddenFamily; @override - String? get name => r'exampleFamilyProvider'; + ExampleFamilyProvider getProviderOverride( + covariant ExampleFamilyProvider provider, + ) { + return provider._copyWith(create); + } } /// Some comment @@ -128,7 +150,7 @@ class ExampleFamilyProvider extends AutoDisposeProvider { ); ExampleFamilyProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -143,7 +165,7 @@ class ExampleFamilyProvider extends AutoDisposeProvider { @override Override overrideWith( - int Function(ExampleFamilyRef provider) create, + int Function(ExampleFamilyRef ref) create, ) { return ProviderOverride( origin: this, @@ -160,11 +182,37 @@ class ExampleFamilyProvider extends AutoDisposeProvider { ); } + @override + ({ + int a, + String b, + }) get argument { + return ( + a: a, + b: b, + ); + } + @override AutoDisposeProviderElement createElement() { return _ExampleFamilyProviderElement(this); } + ExampleFamilyProvider _copyWith( + int Function(ExampleFamilyRef ref) create, + ) { + return ExampleFamilyProvider._internal( + (ref) => create(ref as ExampleFamilyRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + a: a, + b: b, + ); + } + @override bool operator ==(Object other) { return other is ExampleFamilyProvider && other.a == a && other.b == b; @@ -198,4 +246,4 @@ class _ExampleFamilyProviderElement extends AutoDisposeProviderElement String get b => (origin as ExampleFamilyProvider).b; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/another.g.dart b/packages/riverpod_lint_flutter_test/test/lints/another.g.dart index 2f515779b..a294d3fd5 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/another.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/another.g.dart @@ -21,4 +21,4 @@ final bProvider = AutoDisposeProvider.internal( typedef BRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 84b45e0c1..586f558da 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -38,6 +38,20 @@ class FnFamily extends Family { /// See also [fn]. const FnFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'fnProvider'; + /// See also [fn]. FnProvider call( BuildContext context1, { @@ -49,6 +63,7 @@ class FnFamily extends Family { ); } + @visibleForOverriding @override FnProvider getProviderOverride( covariant FnProvider provider, @@ -59,19 +74,26 @@ class FnFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(int Function(FnRef ref) create) { + return _$FnFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FnFamilyOverride implements FamilyOverride { + _$FnFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final int Function(FnRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FnFamily overriddenFamily; @override - String? get name => r'fnProvider'; + FnProvider getProviderOverride( + covariant FnProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [fn]. @@ -97,7 +119,7 @@ class FnProvider extends AutoDisposeProvider { ); FnProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -112,7 +134,7 @@ class FnProvider extends AutoDisposeProvider { @override Override overrideWith( - int Function(FnRef provider) create, + int Function(FnRef ref) create, ) { return ProviderOverride( origin: this, @@ -129,11 +151,37 @@ class FnProvider extends AutoDisposeProvider { ); } + @override + ( + BuildContext, { + BuildContext context2, + }) get argument { + return ( + context1, + context2: context2, + ); + } + @override AutoDisposeProviderElement createElement() { return _FnProviderElement(this); } + FnProvider _copyWith( + int Function(FnRef ref) create, + ) { + return FnProvider._internal( + (ref) => create(ref as FnRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + context1: context1, + context2: context2, + ); + } + @override bool operator ==(Object other) { return other is FnProvider && @@ -189,6 +237,20 @@ class MyNotifierFamily extends Family { /// See also [MyNotifier]. const MyNotifierFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'myNotifierProvider'; + /// See also [MyNotifier]. MyNotifierProvider call( BuildContext context1, { @@ -200,6 +262,7 @@ class MyNotifierFamily extends Family { ); } + @visibleForOverriding @override MyNotifierProvider getProviderOverride( covariant MyNotifierProvider provider, @@ -210,19 +273,26 @@ class MyNotifierFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(MyNotifier Function() create) { + return _$MyNotifierFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$MyNotifierFamilyOverride implements FamilyOverride { + _$MyNotifierFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final MyNotifier Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final MyNotifierFamily overriddenFamily; @override - String? get name => r'myNotifierProvider'; + MyNotifierProvider getProviderOverride( + covariant MyNotifierProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [MyNotifier]. @@ -250,7 +320,7 @@ class MyNotifierProvider ); MyNotifierProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -292,11 +362,39 @@ class MyNotifierProvider ); } + @override + ( + BuildContext, { + BuildContext context2, + }) get argument { + return ( + context1, + context2: context2, + ); + } + @override AutoDisposeNotifierProviderElement createElement() { return _MyNotifierProviderElement(this); } + MyNotifierProvider _copyWith( + MyNotifier Function() create, + ) { + return MyNotifierProvider._internal( + () => create() + ..context1 = context1 + ..context2 = context2, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + context1: context1, + context2: context2, + ); + } + @override bool operator ==(Object other) { return other is MyNotifierProvider && @@ -350,4 +448,4 @@ final regresion2959Provider = typedef _$Regresion2959 = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index aaa67b36c..ec169870d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -46,6 +46,20 @@ class GeneratedNotifierFamily extends Family { /// See also [GeneratedNotifier]. const GeneratedNotifierFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'generatedNotifierProvider'; + /// See also [GeneratedNotifier]. GeneratedNotifierProvider call( int param, @@ -55,6 +69,7 @@ class GeneratedNotifierFamily extends Family { ); } + @visibleForOverriding @override GeneratedNotifierProvider getProviderOverride( covariant GeneratedNotifierProvider provider, @@ -64,19 +79,26 @@ class GeneratedNotifierFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(GeneratedNotifier Function() create) { + return _$GeneratedNotifierFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$GeneratedNotifierFamilyOverride implements FamilyOverride { + _$GeneratedNotifierFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final GeneratedNotifier Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final GeneratedNotifierFamily overriddenFamily; @override - String? get name => r'generatedNotifierProvider'; + GeneratedNotifierProvider getProviderOverride( + covariant GeneratedNotifierProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [GeneratedNotifier]. @@ -100,7 +122,7 @@ class GeneratedNotifierProvider ); GeneratedNotifierProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -136,11 +158,30 @@ class GeneratedNotifierProvider ); } + @override + (int,) get argument { + return (param,); + } + @override AutoDisposeNotifierProviderElement createElement() { return _GeneratedNotifierProviderElement(this); } + GeneratedNotifierProvider _copyWith( + GeneratedNotifier Function() create, + ) { + return GeneratedNotifierProvider._internal( + () => create()..param = param, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param: param, + ); + } + @override bool operator ==(Object other) { return other is GeneratedNotifierProvider && other.param == param; @@ -169,4 +210,4 @@ class _GeneratedNotifierProviderElement int get param => (origin as GeneratedNotifierProvider).param; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index a13bfbbaa..2f4e1167b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -416,6 +416,26 @@ class FamilyDepFamily extends Family { /// See also [familyDep]. const FamilyDepFamily(); + static final Iterable _dependencies = [ + depProvider + ]; + + static final Iterable _allTransitiveDependencies = + { + depProvider, + ...?depProvider.allTransitiveDependencies + }; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyDepProvider'; + /// See also [familyDep]. FamilyDepProvider call( int p, @@ -425,6 +445,7 @@ class FamilyDepFamily extends Family { ); } + @visibleForOverriding @override FamilyDepProvider getProviderOverride( covariant FamilyDepProvider provider, @@ -434,25 +455,26 @@ class FamilyDepFamily extends Family { ); } - static final Iterable _dependencies = [ - depProvider - ]; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(int Function(FamilyDepRef ref) create) { + return _$FamilyDepFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FamilyDepFamilyOverride implements FamilyOverride { + _$FamilyDepFamilyOverride(this.overriddenFamily, this.create); - static final Iterable _allTransitiveDependencies = - { - depProvider, - ...?depProvider.allTransitiveDependencies - }; + final int Function(FamilyDepRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FamilyDepFamily overriddenFamily; @override - String? get name => r'familyDepProvider'; + FamilyDepProvider getProviderOverride( + covariant FamilyDepProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [familyDep]. @@ -477,7 +499,7 @@ class FamilyDepProvider extends AutoDisposeProvider { ); FamilyDepProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -490,7 +512,7 @@ class FamilyDepProvider extends AutoDisposeProvider { @override Override overrideWith( - int Function(FamilyDepRef provider) create, + int Function(FamilyDepRef ref) create, ) { return ProviderOverride( origin: this, @@ -506,11 +528,30 @@ class FamilyDepProvider extends AutoDisposeProvider { ); } + @override + (int,) get argument { + return (p,); + } + @override AutoDisposeProviderElement createElement() { return _FamilyDepProviderElement(this); } + FamilyDepProvider _copyWith( + int Function(FamilyDepRef ref) create, + ) { + return FamilyDepProvider._internal( + (ref) => create(ref as FamilyDepRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + p: p, + ); + } + @override bool operator ==(Object other) { return other is FamilyDepProvider && other.p == p; @@ -549,6 +590,26 @@ class FamilyDep2Family extends Family { /// See also [familyDep2]. const FamilyDep2Family(); + static final Iterable _dependencies = [ + familyDepProvider + ]; + + static final Iterable _allTransitiveDependencies = + { + familyDepProvider, + ...?familyDepProvider.allTransitiveDependencies + }; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'familyDep2Provider'; + /// See also [familyDep2]. FamilyDep2Provider call( int p, @@ -558,6 +619,7 @@ class FamilyDep2Family extends Family { ); } + @visibleForOverriding @override FamilyDep2Provider getProviderOverride( covariant FamilyDep2Provider provider, @@ -567,25 +629,26 @@ class FamilyDep2Family extends Family { ); } - static final Iterable _dependencies = [ - familyDepProvider - ]; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(int Function(FamilyDep2Ref ref) create) { + return _$FamilyDep2FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FamilyDep2FamilyOverride implements FamilyOverride { + _$FamilyDep2FamilyOverride(this.overriddenFamily, this.create); - static final Iterable _allTransitiveDependencies = - { - familyDepProvider, - ...?familyDepProvider.allTransitiveDependencies - }; + final int Function(FamilyDep2Ref ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FamilyDep2Family overriddenFamily; @override - String? get name => r'familyDep2Provider'; + FamilyDep2Provider getProviderOverride( + covariant FamilyDep2Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [familyDep2]. @@ -611,7 +674,7 @@ class FamilyDep2Provider extends AutoDisposeProvider { ); FamilyDep2Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -624,7 +687,7 @@ class FamilyDep2Provider extends AutoDisposeProvider { @override Override overrideWith( - int Function(FamilyDep2Ref provider) create, + int Function(FamilyDep2Ref ref) create, ) { return ProviderOverride( origin: this, @@ -640,11 +703,30 @@ class FamilyDep2Provider extends AutoDisposeProvider { ); } + @override + (int,) get argument { + return (p,); + } + @override AutoDisposeProviderElement createElement() { return _FamilyDep2ProviderElement(this); } + FamilyDep2Provider _copyWith( + int Function(FamilyDep2Ref ref) create, + ) { + return FamilyDep2Provider._internal( + (ref) => create(ref as FamilyDep2Ref), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + p: p, + ); + } + @override bool operator ==(Object other) { return other is FamilyDep2Provider && other.p == p; @@ -759,4 +841,4 @@ final aliasClassProvider = typedef _$AliasClass = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart index f6d5b5773..151d26616 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart @@ -589,4 +589,4 @@ class _WrongOrderProviderElement _WrongOrderProviderElement(super.provider); } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index f94a628af..0615d6811 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -74,6 +74,20 @@ class A3Family extends Family { /// See also [A3]. const A3Family(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'a3Provider'; + /// See also [A3]. A3Provider call( int param, @@ -83,6 +97,7 @@ class A3Family extends Family { ); } + @visibleForOverriding @override A3Provider getProviderOverride( covariant A3Provider provider, @@ -92,19 +107,26 @@ class A3Family extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(A3 Function() create) { + return _$A3FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$A3FamilyOverride implements FamilyOverride { + _$A3FamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final A3 Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final A3Family overriddenFamily; @override - String? get name => r'a3Provider'; + A3Provider getProviderOverride( + covariant A3Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [A3]. @@ -124,7 +146,7 @@ class A3Provider extends AutoDisposeNotifierProviderImpl { ); A3Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -160,11 +182,30 @@ class A3Provider extends AutoDisposeNotifierProviderImpl { ); } + @override + (int,) get argument { + return (param,); + } + @override AutoDisposeNotifierProviderElement createElement() { return _A3ProviderElement(this); } + A3Provider _copyWith( + A3 Function() create, + ) { + return A3Provider._internal( + () => create()..param = param, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param: param, + ); + } + @override bool operator ==(Object other) { return other is A3Provider && other.param == param; @@ -211,6 +252,20 @@ class A4Family extends Family { /// See also [A4]. const A4Family(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'a4Provider'; + /// See also [A4]. A4Provider call( int param, @@ -220,6 +275,7 @@ class A4Family extends Family { ); } + @visibleForOverriding @override A4Provider getProviderOverride( covariant A4Provider provider, @@ -229,19 +285,26 @@ class A4Family extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(A4 Function() create) { + return _$A4FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$A4FamilyOverride implements FamilyOverride { + _$A4FamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final A4 Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final A4Family overriddenFamily; @override - String? get name => r'a4Provider'; + A4Provider getProviderOverride( + covariant A4Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [A4]. @@ -261,7 +324,7 @@ class A4Provider extends NotifierProviderImpl { ); A4Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -297,11 +360,30 @@ class A4Provider extends NotifierProviderImpl { ); } + @override + (int,) get argument { + return (param,); + } + @override NotifierProviderElement createElement() { return _A4ProviderElement(this); } + A4Provider _copyWith( + A4 Function() create, + ) { + return A4Provider._internal( + () => create()..param = param, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param: param, + ); + } + @override bool operator ==(Object other) { return other is A4Provider && other.param == param; @@ -347,6 +429,20 @@ class A5Family extends Family { /// See also [A5]. const A5Family(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'a5Provider'; + /// See also [A5]. A5Provider call( int param, @@ -356,6 +452,7 @@ class A5Family extends Family { ); } + @visibleForOverriding @override A5Provider getProviderOverride( covariant A5Provider provider, @@ -365,19 +462,26 @@ class A5Family extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(A5 Function() create) { + return _$A5FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$A5FamilyOverride implements FamilyOverride> { + _$A5FamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final A5 Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final A5Family overriddenFamily; @override - String? get name => r'a5Provider'; + A5Provider getProviderOverride( + covariant A5Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [A5]. @@ -397,7 +501,7 @@ class A5Provider extends AutoDisposeAsyncNotifierProviderImpl { ); A5Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -433,11 +537,30 @@ class A5Provider extends AutoDisposeAsyncNotifierProviderImpl { ); } + @override + (int,) get argument { + return (param,); + } + @override AutoDisposeAsyncNotifierProviderElement createElement() { return _A5ProviderElement(this); } + A5Provider _copyWith( + A5 Function() create, + ) { + return A5Provider._internal( + () => create()..param = param, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param: param, + ); + } + @override bool operator ==(Object other) { return other is A5Provider && other.param == param; @@ -484,6 +607,20 @@ class A6Family extends Family { /// See also [A6]. const A6Family(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'a6Provider'; + /// See also [A6]. A6Provider call( int param, @@ -493,6 +630,7 @@ class A6Family extends Family { ); } + @visibleForOverriding @override A6Provider getProviderOverride( covariant A6Provider provider, @@ -502,19 +640,26 @@ class A6Family extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(A6 Function() create) { + return _$A6FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$A6FamilyOverride implements FamilyOverride> { + _$A6FamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final A6 Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final A6Family overriddenFamily; @override - String? get name => r'a6Provider'; + A6Provider getProviderOverride( + covariant A6Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [A6]. @@ -534,7 +679,7 @@ class A6Provider extends AsyncNotifierProviderImpl { ); A6Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -570,11 +715,30 @@ class A6Provider extends AsyncNotifierProviderImpl { ); } + @override + (int,) get argument { + return (param,); + } + @override AsyncNotifierProviderElement createElement() { return _A6ProviderElement(this); } + A6Provider _copyWith( + A6 Function() create, + ) { + return A6Provider._internal( + () => create()..param = param, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param: param, + ); + } + @override bool operator ==(Object other) { return other is A6Provider && other.param == param; @@ -621,6 +785,20 @@ class A7Family extends Family { /// See also [A7]. const A7Family(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'a7Provider'; + /// See also [A7]. A7Provider call( int param, @@ -630,6 +808,7 @@ class A7Family extends Family { ); } + @visibleForOverriding @override A7Provider getProviderOverride( covariant A7Provider provider, @@ -639,19 +818,26 @@ class A7Family extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(A7 Function() create) { + return _$A7FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$A7FamilyOverride implements FamilyOverride> { + _$A7FamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final A7 Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final A7Family overriddenFamily; @override - String? get name => r'a7Provider'; + A7Provider getProviderOverride( + covariant A7Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [A7]. @@ -671,7 +857,7 @@ class A7Provider extends AutoDisposeStreamNotifierProviderImpl { ); A7Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -707,11 +893,30 @@ class A7Provider extends AutoDisposeStreamNotifierProviderImpl { ); } + @override + (int,) get argument { + return (param,); + } + @override AutoDisposeStreamNotifierProviderElement createElement() { return _A7ProviderElement(this); } + A7Provider _copyWith( + A7 Function() create, + ) { + return A7Provider._internal( + () => create()..param = param, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param: param, + ); + } + @override bool operator ==(Object other) { return other is A7Provider && other.param == param; @@ -758,6 +963,20 @@ class A8Family extends Family { /// See also [A8]. const A8Family(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'a8Provider'; + /// See also [A8]. A8Provider call( int param, @@ -767,6 +986,7 @@ class A8Family extends Family { ); } + @visibleForOverriding @override A8Provider getProviderOverride( covariant A8Provider provider, @@ -776,19 +996,26 @@ class A8Family extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(A8 Function() create) { + return _$A8FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$A8FamilyOverride implements FamilyOverride> { + _$A8FamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final A8 Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final A8Family overriddenFamily; @override - String? get name => r'a8Provider'; + A8Provider getProviderOverride( + covariant A8Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [A8]. @@ -808,7 +1035,7 @@ class A8Provider extends StreamNotifierProviderImpl { ); A8Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -844,11 +1071,30 @@ class A8Provider extends StreamNotifierProviderImpl { ); } + @override + (int,) get argument { + return (param,); + } + @override StreamNotifierProviderElement createElement() { return _A8ProviderElement(this); } + A8Provider _copyWith( + A8 Function() create, + ) { + return A8Provider._internal( + () => create()..param = param, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param: param, + ); + } + @override bool operator ==(Object other) { return other is A8Provider && other.param == param; @@ -905,4 +1151,4 @@ final b2Provider = AutoDisposeNotifierProvider.internal( typedef _$B2 = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart index ec5ac67d9..c2d7a638d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart @@ -202,4 +202,4 @@ final noDepWithoutCommaProvider = AutoDisposeProvider.internal( typedef NoDepWithoutCommaRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 56fbdc08e..9b960dd49 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -38,6 +38,20 @@ class GeneratorFamily extends Family { /// See also [generator]. const GeneratorFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'generatorProvider'; + /// See also [generator]. GeneratorProvider call({ Object? value, @@ -47,6 +61,7 @@ class GeneratorFamily extends Family { ); } + @visibleForOverriding @override GeneratorProvider getProviderOverride( covariant GeneratorProvider provider, @@ -56,19 +71,26 @@ class GeneratorFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(int Function(GeneratorRef ref) create) { + return _$GeneratorFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$GeneratorFamilyOverride implements FamilyOverride { + _$GeneratorFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final int Function(GeneratorRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final GeneratorFamily overriddenFamily; @override - String? get name => r'generatorProvider'; + GeneratorProvider getProviderOverride( + covariant GeneratorProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [generator]. @@ -93,7 +115,7 @@ class GeneratorProvider extends Provider { ); GeneratorProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -106,7 +128,7 @@ class GeneratorProvider extends Provider { @override Override overrideWith( - int Function(GeneratorRef provider) create, + int Function(GeneratorRef ref) create, ) { return ProviderOverride( origin: this, @@ -122,11 +144,32 @@ class GeneratorProvider extends Provider { ); } + @override + ({ + Object? value, + }) get argument { + return (value: value,); + } + @override ProviderElement createElement() { return _GeneratorProviderElement(this); } + GeneratorProvider _copyWith( + int Function(GeneratorRef ref) create, + ) { + return GeneratorProvider._internal( + (ref) => create(ref as GeneratorRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + value: value, + ); + } + @override bool operator ==(Object other) { return other is GeneratorProvider && other.value == value; @@ -153,4 +196,4 @@ class _GeneratorProviderElement extends ProviderElement with GeneratorRef { Object? get value => (origin as GeneratorProvider).value; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart index cd6fd4b52..baf6beb59 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart @@ -54,4 +54,4 @@ final rootProvider = AutoDisposeProvider.internal( typedef RootRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart index 0b3f126db..daa5c7372 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart @@ -345,4 +345,4 @@ final asyncNotifierClassProvider = typedef _$AsyncNotifierClass = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/advanced/select/select/codegen.g.dart b/website/docs/advanced/select/select/codegen.g.dart index 018542dba..9e44ffe6d 100644 --- a/website/docs/advanced/select/select/codegen.g.dart +++ b/website/docs/advanced/select/select/codegen.g.dart @@ -23,4 +23,4 @@ final exampleProvider = AutoDisposeProvider.internal( typedef ExampleRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/advanced/select/select_async/codegen.g.dart b/website/docs/advanced/select/select_async/codegen.g.dart index ab6da16f7..1f422ec8a 100644 --- a/website/docs/advanced/select/select_async/codegen.g.dart +++ b/website/docs/advanced/select/select_async/codegen.g.dart @@ -23,4 +23,4 @@ final exampleProvider = AutoDisposeProvider.internal( typedef ExampleRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart index 16aa62d6b..fa23157e9 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -23,4 +23,4 @@ final activityProvider = AutoDisposeFutureProvider.internal( typedef ActivityRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart index 69ee1d982..4d688e552 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -43,4 +43,4 @@ final activityProvider = AutoDisposeFutureProvider.internal( typedef ActivityRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 55eea2d14..0a2446f97 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -40,6 +40,20 @@ class FetchUserFamily extends Family { /// See also [fetchUser]. const FetchUserFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'fetchUserProvider'; + /// See also [fetchUser]. FetchUserProvider call({ required int userId, @@ -49,6 +63,7 @@ class FetchUserFamily extends Family { ); } + @visibleForOverriding @override FetchUserProvider getProviderOverride( covariant FetchUserProvider provider, @@ -58,19 +73,26 @@ class FetchUserFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FutureOr Function(FetchUserRef ref) create) { + return _$FetchUserFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FetchUserFamilyOverride implements FamilyOverride> { + _$FetchUserFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FutureOr Function(FetchUserRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FetchUserFamily overriddenFamily; @override - String? get name => r'fetchUserProvider'; + FetchUserProvider getProviderOverride( + covariant FetchUserProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [fetchUser]. @@ -95,7 +117,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ); FetchUserProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -108,7 +130,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { @override Override overrideWith( - FutureOr Function(FetchUserRef provider) create, + FutureOr Function(FetchUserRef ref) create, ) { return ProviderOverride( origin: this, @@ -124,11 +146,32 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ); } + @override + ({ + int userId, + }) get argument { + return (userId: userId,); + } + @override AutoDisposeFutureProviderElement createElement() { return _FetchUserProviderElement(this); } + FetchUserProvider _copyWith( + FutureOr Function(FetchUserRef ref) create, + ) { + return FetchUserProvider._internal( + (ref) => create(ref as FetchUserRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + userId: userId, + ); + } + @override bool operator ==(Object other) { return other is FetchUserProvider && other.userId == userId; @@ -156,4 +199,4 @@ class _FetchUserProviderElement extends AutoDisposeFutureProviderElement int get userId => (origin as FetchUserProvider).userId; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart index 749d6e6dc..0fe4488e1 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart @@ -24,4 +24,4 @@ final exampleProvider = typedef _$Example = AutoDisposeAsyncNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart index 77984b80a..e44bf1860 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart @@ -24,4 +24,4 @@ final exampleProvider = typedef _$Example = AutoDisposeStreamNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart index 3274e8a9b..f22d58704 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -23,4 +23,4 @@ final exampleProvider = AutoDisposeFutureProvider.internal( typedef ExampleRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart index 42904d939..56ff2877e 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -23,4 +23,4 @@ final exampleProvider = AutoDisposeStreamProvider.internal( typedef ExampleRef = AutoDisposeStreamProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart index e6e00432c..98e4139ea 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -37,4 +37,4 @@ final example2Provider = Provider.internal( typedef Example2Ref = ProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index b6a91de7d..b73608c0b 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -40,6 +40,20 @@ class ExampleFamily extends Family { /// See also [example]. const ExampleFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'exampleProvider'; + /// See also [example]. ExampleProvider call( int param, @@ -49,6 +63,7 @@ class ExampleFamily extends Family { ); } + @visibleForOverriding @override ExampleProvider getProviderOverride( covariant ExampleProvider provider, @@ -58,19 +73,26 @@ class ExampleFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(String Function(ExampleRef ref) create) { + return _$ExampleFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$ExampleFamilyOverride implements FamilyOverride { + _$ExampleFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final String Function(ExampleRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final ExampleFamily overriddenFamily; @override - String? get name => r'exampleProvider'; + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [example]. @@ -95,7 +117,7 @@ class ExampleProvider extends AutoDisposeProvider { ); ExampleProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -108,7 +130,7 @@ class ExampleProvider extends AutoDisposeProvider { @override Override overrideWith( - String Function(ExampleRef provider) create, + String Function(ExampleRef ref) create, ) { return ProviderOverride( origin: this, @@ -124,11 +146,30 @@ class ExampleProvider extends AutoDisposeProvider { ); } + @override + (int,) get argument { + return (param,); + } + @override AutoDisposeProviderElement createElement() { return _ExampleProviderElement(this); } + ExampleProvider _copyWith( + String Function(ExampleRef ref) create, + ) { + return ExampleProvider._internal( + (ref) => create(ref as ExampleRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param: param, + ); + } + @override bool operator ==(Object other) { return other is ExampleProvider && other.param == param; @@ -156,4 +197,4 @@ class _ExampleProviderElement extends AutoDisposeProviderElement int get param => (origin as ExampleProvider).param; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index 6435784e5..ebabfd15f 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -50,6 +50,20 @@ class ExampleFamily extends Family { /// See also [Example]. const ExampleFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'exampleProvider'; + /// See also [Example]. ExampleProvider call( int param1, { @@ -61,6 +75,7 @@ class ExampleFamily extends Family { ); } + @visibleForOverriding @override ExampleProvider getProviderOverride( covariant ExampleProvider provider, @@ -71,19 +86,26 @@ class ExampleFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(Example Function() create) { + return _$ExampleFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$ExampleFamilyOverride implements FamilyOverride { + _$ExampleFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final Example Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final ExampleFamily overriddenFamily; @override - String? get name => r'exampleProvider'; + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [Example]. @@ -109,7 +131,7 @@ class ExampleProvider extends AutoDisposeNotifierProviderImpl { ); ExampleProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -151,11 +173,39 @@ class ExampleProvider extends AutoDisposeNotifierProviderImpl { ); } + @override + ( + int, { + String param2, + }) get argument { + return ( + param1, + param2: param2, + ); + } + @override AutoDisposeNotifierProviderElement createElement() { return _ExampleProviderElement(this); } + ExampleProvider _copyWith( + Example Function() create, + ) { + return ExampleProvider._internal( + () => create() + ..param1 = param1 + ..param2 = param2, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param1: param1, + param2: param2, + ); + } + @override bool operator ==(Object other) { return other is ExampleProvider && @@ -192,4 +242,4 @@ class _ExampleProviderElement String get param2 => (origin as ExampleProvider).param2; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index 8b25e0af9..7fc2c43d1 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -40,6 +40,20 @@ class ExampleFamily extends Family { /// See also [example]. const ExampleFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'exampleProvider'; + /// See also [example]. ExampleProvider call( int param1, { @@ -51,6 +65,7 @@ class ExampleFamily extends Family { ); } + @visibleForOverriding @override ExampleProvider getProviderOverride( covariant ExampleProvider provider, @@ -61,19 +76,26 @@ class ExampleFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(String Function(ExampleRef ref) create) { + return _$ExampleFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$ExampleFamilyOverride implements FamilyOverride { + _$ExampleFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final String Function(ExampleRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final ExampleFamily overriddenFamily; @override - String? get name => r'exampleProvider'; + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [example]. @@ -101,7 +123,7 @@ class ExampleProvider extends AutoDisposeProvider { ); ExampleProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -116,7 +138,7 @@ class ExampleProvider extends AutoDisposeProvider { @override Override overrideWith( - String Function(ExampleRef provider) create, + String Function(ExampleRef ref) create, ) { return ProviderOverride( origin: this, @@ -133,11 +155,37 @@ class ExampleProvider extends AutoDisposeProvider { ); } + @override + ( + int, { + String param2, + }) get argument { + return ( + param1, + param2: param2, + ); + } + @override AutoDisposeProviderElement createElement() { return _ExampleProviderElement(this); } + ExampleProvider _copyWith( + String Function(ExampleRef ref) create, + ) { + return ExampleProvider._internal( + (ref) => create(ref as ExampleRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param1: param1, + param2: param2, + ); + } + @override bool operator ==(Object other) { return other is ExampleProvider && @@ -173,4 +221,4 @@ class _ExampleProviderElement extends AutoDisposeProviderElement String get param2 => (origin as ExampleProvider).param2; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart index e03372d41..d4c658779 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart @@ -23,4 +23,4 @@ final exampleProvider = AutoDisposeNotifierProvider.internal( typedef _$Example = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart index dbc326dcd..daabcdd71 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -23,4 +23,4 @@ final exampleProvider = AutoDisposeProvider.internal( typedef ExampleRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart index acc45c280..710947519 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -37,4 +37,4 @@ final charactersProvider = AutoDisposeFutureProvider>.internal( typedef CharactersRef = AutoDisposeFutureProviderRef>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart index 674b539be..ac0b5a099 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -23,4 +23,4 @@ final cityProvider = AutoDisposeProvider.internal( typedef CityRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart index f8563b534..c26fbd6ba 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -24,4 +24,4 @@ final filteredTodoListProvider = AutoDisposeProvider>.internal( typedef FilteredTodoListRef = AutoDisposeProviderRef>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart index acabbbbfe..50ab2adaf 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -37,4 +37,4 @@ final myProvider = AutoDisposeProvider.internal( typedef MyRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart index ba5c2aec1..cc039edb4 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -37,4 +37,4 @@ final productsProvider = AutoDisposeFutureProvider>.internal( typedef ProductsRef = AutoDisposeFutureProviderRef>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart index 5cb2dae07..f7076044d 100644 --- a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart @@ -24,4 +24,4 @@ final todoListProvider = typedef _$TodoList = AutoDisposeNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart index 5398e9c62..a259eb12b 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -37,4 +37,4 @@ final weatherProvider = AutoDisposeFutureProvider.internal( typedef WeatherRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart index 895d80ff7..25c5a7ded 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -37,4 +37,4 @@ final productsProvider = AutoDisposeFutureProvider>.internal( typedef ProductsRef = AutoDisposeFutureProviderRef>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart index 24f936699..29ee85fa1 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart @@ -23,4 +23,4 @@ final exampleProvider = AutoDisposeStreamProvider.internal( typedef ExampleRef = AutoDisposeStreamProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart index 601ed73b6..71bf0484e 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart @@ -23,4 +23,4 @@ final myProvider = AutoDisposeProvider.internal( typedef MyRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart index b3a642c74..84913df77 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart @@ -37,4 +37,4 @@ final countryProvider = AutoDisposeProvider.internal( typedef CountryRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/counter/codegen.g.dart b/website/docs/concepts/reading/counter/codegen.g.dart index addf9363a..d892e8ba8 100644 --- a/website/docs/concepts/reading/counter/codegen.g.dart +++ b/website/docs/concepts/reading/counter/codegen.g.dart @@ -23,4 +23,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/listen/codegen.g.dart b/website/docs/concepts/reading/listen/codegen.g.dart index 072dce6c2..60b68adf7 100644 --- a/website/docs/concepts/reading/listen/codegen.g.dart +++ b/website/docs/concepts/reading/listen/codegen.g.dart @@ -23,4 +23,4 @@ final anotherProvider = AutoDisposeProvider.internal( typedef AnotherRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/listen_build/codegen.g.dart b/website/docs/concepts/reading/listen_build/codegen.g.dart index 395a07f40..1e834cdbe 100644 --- a/website/docs/concepts/reading/listen_build/codegen.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen.g.dart @@ -23,4 +23,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart index 6f4db9464..9affdaea0 100644 --- a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart @@ -23,4 +23,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/provider/codegen.g.dart b/website/docs/concepts/reading/provider/codegen.g.dart index 31073640e..0e7d74954 100644 --- a/website/docs/concepts/reading/provider/codegen.g.dart +++ b/website/docs/concepts/reading/provider/codegen.g.dart @@ -37,4 +37,4 @@ final valueProvider = AutoDisposeProvider.internal( typedef ValueRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/read/codegen.g.dart b/website/docs/concepts/reading/read/codegen.g.dart index c3cfff0b6..041865b99 100644 --- a/website/docs/concepts/reading/read/codegen.g.dart +++ b/website/docs/concepts/reading/read/codegen.g.dart @@ -23,4 +23,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/read/codegen_hooks.g.dart b/website/docs/concepts/reading/read/codegen_hooks.g.dart index f5cbe5535..5fd373b49 100644 --- a/website/docs/concepts/reading/read/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/read/codegen_hooks.g.dart @@ -23,4 +23,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/read_build/codegen.g.dart b/website/docs/concepts/reading/read_build/codegen.g.dart index c3cfff0b6..041865b99 100644 --- a/website/docs/concepts/reading/read_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_build/codegen.g.dart @@ -23,4 +23,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart index c3cfff0b6..041865b99 100644 --- a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart @@ -23,4 +23,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/watch/codegen.g.dart b/website/docs/concepts/reading/watch/codegen.g.dart index 971b32d3a..8221391a4 100644 --- a/website/docs/concepts/reading/watch/codegen.g.dart +++ b/website/docs/concepts/reading/watch/codegen.g.dart @@ -52,4 +52,4 @@ final todosProvider = AutoDisposeNotifierProvider>.internal( typedef _$Todos = AutoDisposeNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/watch_build/codegen.g.dart b/website/docs/concepts/reading/watch_build/codegen.g.dart index f8e5f6463..347684842 100644 --- a/website/docs/concepts/reading/watch_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen.g.dart @@ -38,4 +38,4 @@ final todoListProvider = typedef _$TodoList = AutoDisposeNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart index 8a2f64454..f5b4cfea1 100644 --- a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart @@ -38,4 +38,4 @@ final todoListProvider = typedef _$TodoList = AutoDisposeNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart index c3cfff0b6..041865b99 100644 --- a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart @@ -23,4 +23,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/why_immutability/codegen.g.dart b/website/docs/concepts/why_immutability/codegen.g.dart index e423516f0..44ea6ef85 100644 --- a/website/docs/concepts/why_immutability/codegen.g.dart +++ b/website/docs/concepts/why_immutability/codegen.g.dart @@ -25,4 +25,4 @@ final themeNotifierProvider = typedef _$ThemeNotifier = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart index eb2dcfb0d..98fd6ea63 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -23,4 +23,4 @@ final exampleProvider = AutoDisposeFutureProvider.internal( typedef ExampleRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart index 9f567e514..854d2df27 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -23,4 +23,4 @@ final exampleProvider = Provider.internal( typedef ExampleRef = ProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index ffe8961bd..04810e0e7 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -40,6 +40,20 @@ class LabelFamily extends Family { /// See also [label]. const LabelFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'labelProvider'; + /// See also [label]. LabelProvider call( String userName, @@ -49,6 +63,7 @@ class LabelFamily extends Family { ); } + @visibleForOverriding @override LabelProvider getProviderOverride( covariant LabelProvider provider, @@ -58,19 +73,26 @@ class LabelFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(String Function(LabelRef ref) create) { + return _$LabelFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$LabelFamilyOverride implements FamilyOverride { + _$LabelFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final String Function(LabelRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final LabelFamily overriddenFamily; @override - String? get name => r'labelProvider'; + LabelProvider getProviderOverride( + covariant LabelProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [label]. @@ -95,7 +117,7 @@ class LabelProvider extends AutoDisposeProvider { ); LabelProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -108,7 +130,7 @@ class LabelProvider extends AutoDisposeProvider { @override Override overrideWith( - String Function(LabelRef provider) create, + String Function(LabelRef ref) create, ) { return ProviderOverride( origin: this, @@ -124,11 +146,30 @@ class LabelProvider extends AutoDisposeProvider { ); } + @override + (String,) get argument { + return (userName,); + } + @override AutoDisposeProviderElement createElement() { return _LabelProviderElement(this); } + LabelProvider _copyWith( + String Function(LabelRef ref) create, + ) { + return LabelProvider._internal( + (ref) => create(ref as LabelRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + userName: userName, + ); + } + @override bool operator ==(Object other) { return other is LabelProvider && other.userName == userName; @@ -156,4 +197,4 @@ class _LabelProviderElement extends AutoDisposeProviderElement String get userName => (origin as LabelProvider).userName; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart index dfe5d12cc..bf38010f2 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -23,4 +23,4 @@ final exampleProvider = AutoDisposeFutureProvider.internal( typedef ExampleRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart index 5ae67d1d2..448c6784e 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -37,4 +37,4 @@ final exampleProvider = AutoDisposeStreamProvider.internal( typedef ExampleRef = AutoDisposeStreamProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart index d7bab87bb..8df442e58 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart @@ -37,4 +37,4 @@ final exampleProvider = AutoDisposeProvider.internal( typedef ExampleRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart index 0e0b3489f..eb3006429 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart @@ -23,4 +23,4 @@ final exampleProvider = AutoDisposeProvider.internal( typedef ExampleRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart index ca4e51873..8109b649d 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -37,4 +37,4 @@ final exampleProvider = AutoDisposeNotifierProvider.internal( typedef _$Example = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/read_example/codegen.g.dart b/website/docs/essentials/combining_requests/read_example/codegen.g.dart index 9c655cd8a..4bac3c78b 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.g.dart @@ -24,4 +24,4 @@ final myNotifierProvider = typedef _$MyNotifier = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart index 910b079a1..2bf4a34f4 100644 --- a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart @@ -41,4 +41,4 @@ final restaurantsNearMeProvider = typedef RestaurantsNearMeRef = AutoDisposeFutureProviderRef>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart index b1dcd7086..c845e281b 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart @@ -38,4 +38,4 @@ final myNotifierProvider = typedef _$MyNotifier = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart index 739f3ea63..dd85f62f9 100644 --- a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart +++ b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart @@ -23,4 +23,4 @@ final exampleProvider = AutoDisposeFutureProvider.internal( typedef ExampleRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/first_request/codegen/provider.g.dart b/website/docs/essentials/first_request/codegen/provider.g.dart index 79f97a0c4..f410c01d1 100644 --- a/website/docs/essentials/first_request/codegen/provider.g.dart +++ b/website/docs/essentials/first_request/codegen/provider.g.dart @@ -26,4 +26,4 @@ final activityProvider = AutoDisposeFutureProvider.internal( typedef ActivityRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/passing_args/codegen/family.g.dart b/website/docs/essentials/passing_args/codegen/family.g.dart index 06750fac2..46a74719b 100644 --- a/website/docs/essentials/passing_args/codegen/family.g.dart +++ b/website/docs/essentials/passing_args/codegen/family.g.dart @@ -40,6 +40,20 @@ class ActivityFamily extends Family { /// See also [activity]. const ActivityFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'activityProvider'; + /// See also [activity]. ActivityProvider call( String activityType, @@ -49,6 +63,7 @@ class ActivityFamily extends Family { ); } + @visibleForOverriding @override ActivityProvider getProviderOverride( covariant ActivityProvider provider, @@ -58,19 +73,26 @@ class ActivityFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FutureOr Function(ActivityRef ref) create) { + return _$ActivityFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$ActivityFamilyOverride implements FamilyOverride> { + _$ActivityFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FutureOr Function(ActivityRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final ActivityFamily overriddenFamily; @override - String? get name => r'activityProvider'; + ActivityProvider getProviderOverride( + covariant ActivityProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [activity]. @@ -95,7 +117,7 @@ class ActivityProvider extends AutoDisposeFutureProvider { ); ActivityProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -108,7 +130,7 @@ class ActivityProvider extends AutoDisposeFutureProvider { @override Override overrideWith( - FutureOr Function(ActivityRef provider) create, + FutureOr Function(ActivityRef ref) create, ) { return ProviderOverride( origin: this, @@ -124,11 +146,30 @@ class ActivityProvider extends AutoDisposeFutureProvider { ); } + @override + (String,) get argument { + return (activityType,); + } + @override AutoDisposeFutureProviderElement createElement() { return _ActivityProviderElement(this); } + ActivityProvider _copyWith( + FutureOr Function(ActivityRef ref) create, + ) { + return ActivityProvider._internal( + (ref) => create(ref as ActivityRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + activityType: activityType, + ); + } + @override bool operator ==(Object other) { return other is ActivityProvider && other.activityType == activityType; @@ -156,4 +197,4 @@ class _ActivityProviderElement String get activityType => (origin as ActivityProvider).activityType; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/passing_args/codegen/provider.g.dart b/website/docs/essentials/passing_args/codegen/provider.g.dart index 7d8e0b166..9a1b2c4b6 100644 --- a/website/docs/essentials/passing_args/codegen/provider.g.dart +++ b/website/docs/essentials/passing_args/codegen/provider.g.dart @@ -23,4 +23,4 @@ final activityProvider = AutoDisposeFutureProvider.internal( typedef ActivityRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart index 9d12d50c6..4e6801ff7 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -39,4 +39,4 @@ final todoListProvider = typedef _$TodoList = AutoDisposeAsyncNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart index a6c2ce847..8d2e07c04 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -24,4 +24,4 @@ final todoListProvider = typedef _$TodoList = AutoDisposeAsyncNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart index 455d9a64b..caa526bca 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -23,4 +23,4 @@ final todoListProvider = AutoDisposeFutureProvider>.internal( typedef TodoListRef = AutoDisposeFutureProviderRef>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/testing/notifier_mock/codegen.g.dart b/website/docs/essentials/testing/notifier_mock/codegen.g.dart index 7efc9fc64..b2d7b9dac 100644 --- a/website/docs/essentials/testing/notifier_mock/codegen.g.dart +++ b/website/docs/essentials/testing/notifier_mock/codegen.g.dart @@ -24,4 +24,4 @@ final myNotifierProvider = typedef _$MyNotifier = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart index 739f3ea63..dd85f62f9 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart @@ -23,4 +23,4 @@ final exampleProvider = AutoDisposeFutureProvider.internal( typedef ExampleRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart index fb78ce8fc..f64dd3222 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -26,4 +26,4 @@ final myListenableProvider = AutoDisposeProvider>.internal( typedef MyListenableRef = AutoDisposeProviderRef>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/raw_usage.g.dart b/website/docs/essentials/websockets_sync/raw_usage.g.dart index 5b898587c..bd06ba4bc 100644 --- a/website/docs/essentials/websockets_sync/raw_usage.g.dart +++ b/website/docs/essentials/websockets_sync/raw_usage.g.dart @@ -23,4 +23,4 @@ final rawStreamProvider = AutoDisposeProvider>>.internal( typedef RawStreamRef = AutoDisposeProviderRef>>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart index 66cb3d39c..fbc40c61b 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -39,4 +39,4 @@ final anotherListenableProvider = typedef AnotherListenableRef = AutoDisposeProviderRef>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart index fec43b43a..b8ef976c4 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -24,4 +24,4 @@ final streamExampleProvider = AutoDisposeStreamProvider.internal( typedef StreamExampleRef = AutoDisposeStreamProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart index 9d331d63e..ef1015d6e 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -25,4 +25,4 @@ final synchronousExampleProvider = AutoDisposeProvider.internal( typedef SynchronousExampleRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index 7aa166878..e7793230e 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -40,6 +40,20 @@ class RandomFamily extends Family { /// See also [random]. const RandomFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'randomProvider'; + /// See also [random]. RandomProvider call({ required int seed, @@ -51,6 +65,7 @@ class RandomFamily extends Family { ); } + @visibleForOverriding @override RandomProvider getProviderOverride( covariant RandomProvider provider, @@ -61,19 +76,26 @@ class RandomFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(int Function(RandomRef ref) create) { + return _$RandomFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$RandomFamilyOverride implements FamilyOverride { + _$RandomFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final int Function(RandomRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final RandomFamily overriddenFamily; @override - String? get name => r'randomProvider'; + RandomProvider getProviderOverride( + covariant RandomProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [random]. @@ -101,7 +123,7 @@ class RandomProvider extends AutoDisposeProvider { ); RandomProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -116,7 +138,7 @@ class RandomProvider extends AutoDisposeProvider { @override Override overrideWith( - int Function(RandomRef provider) create, + int Function(RandomRef ref) create, ) { return ProviderOverride( origin: this, @@ -133,11 +155,37 @@ class RandomProvider extends AutoDisposeProvider { ); } + @override + ({ + int seed, + int max, + }) get argument { + return ( + seed: seed, + max: max, + ); + } + @override AutoDisposeProviderElement createElement() { return _RandomProviderElement(this); } + RandomProvider _copyWith( + int Function(RandomRef ref) create, + ) { + return RandomProvider._internal( + (ref) => create(ref as RandomRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + seed: seed, + max: max, + ); + } + @override bool operator ==(Object other) { return other is RandomProvider && other.seed == seed && other.max == max; @@ -171,4 +219,4 @@ class _RandomProviderElement extends AutoDisposeProviderElement int get max => (origin as RandomProvider).max; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/motivation/async_values/async_values.g.dart b/website/docs/from_provider/motivation/async_values/async_values.g.dart index 09f07382c..0765d3a65 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.g.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.g.dart @@ -37,4 +37,4 @@ final evenItemsProvider = AutoDisposeProvider>.internal( typedef EvenItemsRef = AutoDisposeProviderRef>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart index 376279010..9397a920f 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -38,4 +38,4 @@ final cachedDiceRollProvider = AutoDisposeProvider.internal( typedef CachedDiceRollRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/motivation/combine/combine.g.dart b/website/docs/from_provider/motivation/combine/combine.g.dart index 7df3df2f7..501f580ef 100644 --- a/website/docs/from_provider/motivation/combine/combine.g.dart +++ b/website/docs/from_provider/motivation/combine/combine.g.dart @@ -37,4 +37,4 @@ final doubledProvider = AutoDisposeProvider.internal( typedef DoubledRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/motivation/same_type/same_type.g.dart b/website/docs/from_provider/motivation/same_type/same_type.g.dart index db84c17ad..e421d5b6d 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.g.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.g.dart @@ -37,4 +37,4 @@ final evenItemsProvider = AutoDisposeProvider>.internal( typedef EvenItemsRef = AutoDisposeProviderRef>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart index 180bedb23..a7cc420dc 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart @@ -23,4 +23,4 @@ final helloWorldProvider = AutoDisposeProvider.internal( typedef HelloWorldRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart index 180bedb23..a7cc420dc 100644 --- a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -23,4 +23,4 @@ final helloWorldProvider = AutoDisposeProvider.internal( typedef HelloWorldRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/introduction/getting_started/hello_world/main.g.dart b/website/docs/introduction/getting_started/hello_world/main.g.dart index 180bedb23..a7cc420dc 100644 --- a/website/docs/introduction/getting_started/hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/main.g.dart @@ -23,4 +23,4 @@ final helloWorldProvider = AutoDisposeProvider.internal( typedef HelloWorldRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index cef67671e..c2c6ead3c 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -40,6 +40,20 @@ class FetchPackagesFamily extends Family { /// See also [fetchPackages]. const FetchPackagesFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'fetchPackagesProvider'; + /// See also [fetchPackages]. FetchPackagesProvider call({ required int page, @@ -51,6 +65,7 @@ class FetchPackagesFamily extends Family { ); } + @visibleForOverriding @override FetchPackagesProvider getProviderOverride( covariant FetchPackagesProvider provider, @@ -61,19 +76,28 @@ class FetchPackagesFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith( + FutureOr> Function(FetchPackagesRef ref) create) { + return _$FetchPackagesFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FetchPackagesFamilyOverride + implements FamilyOverride>> { + _$FetchPackagesFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FutureOr> Function(FetchPackagesRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FetchPackagesFamily overriddenFamily; @override - String? get name => r'fetchPackagesProvider'; + FetchPackagesProvider getProviderOverride( + covariant FetchPackagesProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [fetchPackages]. @@ -102,7 +126,7 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { ); FetchPackagesProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -117,7 +141,7 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { @override Override overrideWith( - FutureOr> Function(FetchPackagesRef provider) create, + FutureOr> Function(FetchPackagesRef ref) create, ) { return ProviderOverride( origin: this, @@ -134,11 +158,37 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { ); } + @override + ({ + int page, + String search, + }) get argument { + return ( + page: page, + search: search, + ); + } + @override AutoDisposeFutureProviderElement> createElement() { return _FetchPackagesProviderElement(this); } + FetchPackagesProvider _copyWith( + FutureOr> Function(FetchPackagesRef ref) create, + ) { + return FetchPackagesProvider._internal( + (ref) => create(ref as FetchPackagesRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + page: page, + search: search, + ); + } + @override bool operator ==(Object other) { return other is FetchPackagesProvider && @@ -175,4 +225,4 @@ class _FetchPackagesProviderElement String get search => (origin as FetchPackagesProvider).search; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart index 6a0307fb2..317354e31 100644 --- a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart +++ b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart @@ -24,4 +24,4 @@ final myNotifierProvider = typedef _$MyNotifier = AutoDisposeAsyncNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart index 8fd8b75ce..376ce998f 100644 --- a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart +++ b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart @@ -24,4 +24,4 @@ final myNotifierProvider = typedef _$MyNotifier = AutoDisposeAsyncNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart index 737a9ce7f..8eaddcfd9 100644 --- a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart +++ b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart @@ -24,4 +24,4 @@ final myNotifierProvider = typedef _$MyNotifier = AutoDisposeAsyncNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart index 3d55dd0bb..161b3bba0 100644 --- a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart +++ b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -24,4 +24,4 @@ final myNotifierProvider = typedef _$MyNotifier = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart index 5f72d5d1c..25bcda60d 100644 --- a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart +++ b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -26,4 +26,4 @@ final asyncTodosNotifierProvider = typedef _$AsyncTodosNotifier = AutoDisposeAsyncNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart index 9b4dc05a7..6b4621ecb 100644 --- a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart +++ b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart @@ -25,4 +25,4 @@ final counterNotifierProvider = typedef _$CounterNotifier = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index 1fe9cd320..1ae77f4ae 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -50,6 +50,20 @@ class BugsEncounteredNotifierFamily extends Family { /// See also [BugsEncounteredNotifier]. const BugsEncounteredNotifierFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'bugsEncounteredNotifierProvider'; + /// See also [BugsEncounteredNotifier]. BugsEncounteredNotifierProvider call( String featureId, @@ -59,6 +73,7 @@ class BugsEncounteredNotifierFamily extends Family { ); } + @visibleForOverriding @override BugsEncounteredNotifierProvider getProviderOverride( covariant BugsEncounteredNotifierProvider provider, @@ -68,19 +83,27 @@ class BugsEncounteredNotifierFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(BugsEncounteredNotifier Function() create) { + return _$BugsEncounteredNotifierFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$BugsEncounteredNotifierFamilyOverride + implements FamilyOverride> { + _$BugsEncounteredNotifierFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final BugsEncounteredNotifier Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final BugsEncounteredNotifierFamily overriddenFamily; @override - String? get name => r'bugsEncounteredNotifierProvider'; + BugsEncounteredNotifierProvider getProviderOverride( + covariant BugsEncounteredNotifierProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [BugsEncounteredNotifier]. @@ -104,7 +127,7 @@ class BugsEncounteredNotifierProvider ); BugsEncounteredNotifierProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -140,12 +163,31 @@ class BugsEncounteredNotifierProvider ); } + @override + (String,) get argument { + return (featureId,); + } + @override AutoDisposeAsyncNotifierProviderElement createElement() { return _BugsEncounteredNotifierProviderElement(this); } + BugsEncounteredNotifierProvider _copyWith( + BugsEncounteredNotifier Function() create, + ) { + return BugsEncounteredNotifierProvider._internal( + () => create()..featureId = featureId, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + featureId: featureId, + ); + } + @override bool operator ==(Object other) { return other is BugsEncounteredNotifierProvider && @@ -175,4 +217,4 @@ class _BugsEncounteredNotifierProviderElement String get featureId => (origin as BugsEncounteredNotifierProvider).featureId; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart index e9bbec271..9a3edeebc 100644 --- a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart +++ b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -25,4 +25,4 @@ final counterNotifierProvider = typedef _$CounterNotifier = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart index 9d1158e62..d28e242a3 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -24,4 +24,4 @@ final myNotifierProvider = typedef _$MyNotifier = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart index 3600948dc..7c55609e1 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -24,4 +24,4 @@ final myNotifierProvider = typedef _$MyNotifier = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/providers/future_provider/config_provider/codegen.g.dart b/website/docs/providers/future_provider/config_provider/codegen.g.dart index 08b9d838b..ce4740543 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.g.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.g.dart @@ -26,4 +26,4 @@ final fetchConfigurationProvider = typedef FetchConfigurationRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart index fb8e168d2..8783f8ed4 100644 --- a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart @@ -41,4 +41,4 @@ final asyncTodosProvider = typedef _$AsyncTodos = AutoDisposeAsyncNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/providers/notifier_provider/todos/codegen.g.dart b/website/docs/providers/notifier_provider/todos/codegen.g.dart index d2f26ef1b..0abb46e3f 100644 --- a/website/docs/providers/notifier_provider/todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/todos/codegen.g.dart @@ -23,4 +23,4 @@ final todosProvider = AutoDisposeNotifierProvider>.internal( typedef _$Todos = AutoDisposeNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/providers/provider/completed_todos/completed_todos.g.dart b/website/docs/providers/provider/completed_todos/completed_todos.g.dart index f7db84ee2..be2ec7731 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.g.dart @@ -24,4 +24,4 @@ final completedTodosProvider = AutoDisposeProvider>.internal( typedef CompletedTodosRef = AutoDisposeProviderRef>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index d71214f1d..096a056f2 100644 --- a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -39,4 +39,4 @@ final pageIndexProvider = AutoDisposeNotifierProvider.internal( typedef _$PageIndex = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/providers/provider/todo/todo.g.dart b/website/docs/providers/provider/todo/todo.g.dart index a21239ae8..0b4a0a56d 100644 --- a/website/docs/providers/provider/todo/todo.g.dart +++ b/website/docs/providers/provider/todo/todo.g.dart @@ -23,4 +23,4 @@ final todosProvider = AutoDisposeNotifierProvider>.internal( typedef _$Todos = AutoDisposeNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart index 2656fac9b..e02ece976 100644 --- a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart +++ b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -23,4 +23,4 @@ final pageIndexProvider = AutoDisposeNotifierProvider.internal( typedef _$PageIndex = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart index 213c08a68..ed660f3fa 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -23,4 +23,4 @@ final chatProvider = AutoDisposeStreamProvider>.internal( typedef ChatRef = AutoDisposeStreamProviderRef>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 55eea2d14..0a2446f97 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -40,6 +40,20 @@ class FetchUserFamily extends Family { /// See also [fetchUser]. const FetchUserFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'fetchUserProvider'; + /// See also [fetchUser]. FetchUserProvider call({ required int userId, @@ -49,6 +63,7 @@ class FetchUserFamily extends Family { ); } + @visibleForOverriding @override FetchUserProvider getProviderOverride( covariant FetchUserProvider provider, @@ -58,19 +73,26 @@ class FetchUserFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FutureOr Function(FetchUserRef ref) create) { + return _$FetchUserFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FetchUserFamilyOverride implements FamilyOverride> { + _$FetchUserFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FutureOr Function(FetchUserRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FetchUserFamily overriddenFamily; @override - String? get name => r'fetchUserProvider'; + FetchUserProvider getProviderOverride( + covariant FetchUserProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [fetchUser]. @@ -95,7 +117,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ); FetchUserProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -108,7 +130,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { @override Override overrideWith( - FutureOr Function(FetchUserRef provider) create, + FutureOr Function(FetchUserRef ref) create, ) { return ProviderOverride( origin: this, @@ -124,11 +146,32 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ); } + @override + ({ + int userId, + }) get argument { + return (userId: userId,); + } + @override AutoDisposeFutureProviderElement createElement() { return _FetchUserProviderElement(this); } + FetchUserProvider _copyWith( + FutureOr Function(FetchUserRef ref) create, + ) { + return FetchUserProvider._internal( + (ref) => create(ref as FetchUserRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + userId: userId, + ); + } + @override bool operator ==(Object other) { return other is FetchUserProvider && other.userId == userId; @@ -156,4 +199,4 @@ class _FetchUserProviderElement extends AutoDisposeFutureProviderElement int get userId => (origin as FetchUserProvider).userId; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index 180bedb23..a7cc420dc 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -23,4 +23,4 @@ final helloWorldProvider = AutoDisposeProvider.internal( typedef HelloWorldRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index 180bedb23..a7cc420dc 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -23,4 +23,4 @@ final helloWorldProvider = AutoDisposeProvider.internal( typedef HelloWorldRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart index fb8e168d2..8783f8ed4 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart @@ -41,4 +41,4 @@ final asyncTodosProvider = typedef _$AsyncTodos = AutoDisposeAsyncNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart index d2f26ef1b..0abb46e3f 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart @@ -23,4 +23,4 @@ final todosProvider = AutoDisposeNotifierProvider>.internal( typedef _$Todos = AutoDisposeNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 55eea2d14..0a2446f97 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -40,6 +40,20 @@ class FetchUserFamily extends Family { /// See also [fetchUser]. const FetchUserFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'fetchUserProvider'; + /// See also [fetchUser]. FetchUserProvider call({ required int userId, @@ -49,6 +63,7 @@ class FetchUserFamily extends Family { ); } + @visibleForOverriding @override FetchUserProvider getProviderOverride( covariant FetchUserProvider provider, @@ -58,19 +73,26 @@ class FetchUserFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FutureOr Function(FetchUserRef ref) create) { + return _$FetchUserFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FetchUserFamilyOverride implements FamilyOverride> { + _$FetchUserFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FutureOr Function(FetchUserRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FetchUserFamily overriddenFamily; @override - String? get name => r'fetchUserProvider'; + FetchUserProvider getProviderOverride( + covariant FetchUserProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [fetchUser]. @@ -95,7 +117,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ); FetchUserProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -108,7 +130,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { @override Override overrideWith( - FutureOr Function(FetchUserRef provider) create, + FutureOr Function(FetchUserRef ref) create, ) { return ProviderOverride( origin: this, @@ -124,11 +146,32 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ); } + @override + ({ + int userId, + }) get argument { + return (userId: userId,); + } + @override AutoDisposeFutureProviderElement createElement() { return _FetchUserProviderElement(this); } + FetchUserProvider _copyWith( + FutureOr Function(FetchUserRef ref) create, + ) { + return FetchUserProvider._internal( + (ref) => create(ref as FetchUserRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + userId: userId, + ); + } + @override bool operator ==(Object other) { return other is FetchUserProvider && other.userId == userId; @@ -156,4 +199,4 @@ class _FetchUserProviderElement extends AutoDisposeFutureProviderElement int get userId => (origin as FetchUserProvider).userId; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index 180bedb23..a7cc420dc 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -23,4 +23,4 @@ final helloWorldProvider = AutoDisposeProvider.internal( typedef HelloWorldRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index 180bedb23..a7cc420dc 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -23,4 +23,4 @@ final helloWorldProvider = AutoDisposeProvider.internal( typedef HelloWorldRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 55eea2d14..0a2446f97 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -40,6 +40,20 @@ class FetchUserFamily extends Family { /// See also [fetchUser]. const FetchUserFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'fetchUserProvider'; + /// See also [fetchUser]. FetchUserProvider call({ required int userId, @@ -49,6 +63,7 @@ class FetchUserFamily extends Family { ); } + @visibleForOverriding @override FetchUserProvider getProviderOverride( covariant FetchUserProvider provider, @@ -58,19 +73,26 @@ class FetchUserFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FutureOr Function(FetchUserRef ref) create) { + return _$FetchUserFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FetchUserFamilyOverride implements FamilyOverride> { + _$FetchUserFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FutureOr Function(FetchUserRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FetchUserFamily overriddenFamily; @override - String? get name => r'fetchUserProvider'; + FetchUserProvider getProviderOverride( + covariant FetchUserProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [fetchUser]. @@ -95,7 +117,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ); FetchUserProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -108,7 +130,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { @override Override overrideWith( - FutureOr Function(FetchUserRef provider) create, + FutureOr Function(FetchUserRef ref) create, ) { return ProviderOverride( origin: this, @@ -124,11 +146,32 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ); } + @override + ({ + int userId, + }) get argument { + return (userId: userId,); + } + @override AutoDisposeFutureProviderElement createElement() { return _FetchUserProviderElement(this); } + FetchUserProvider _copyWith( + FutureOr Function(FetchUserRef ref) create, + ) { + return FetchUserProvider._internal( + (ref) => create(ref as FetchUserRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + userId: userId, + ); + } + @override bool operator ==(Object other) { return other is FetchUserProvider && other.userId == userId; @@ -156,4 +199,4 @@ class _FetchUserProviderElement extends AutoDisposeFutureProviderElement int get userId => (origin as FetchUserProvider).userId; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index 180bedb23..a7cc420dc 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -23,4 +23,4 @@ final helloWorldProvider = AutoDisposeProvider.internal( typedef HelloWorldRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index 180bedb23..a7cc420dc 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -23,4 +23,4 @@ final helloWorldProvider = AutoDisposeProvider.internal( typedef HelloWorldRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart index 08b9d838b..ce4740543 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart @@ -26,4 +26,4 @@ final fetchConfigurationProvider = typedef FetchConfigurationRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 55eea2d14..0a2446f97 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -40,6 +40,20 @@ class FetchUserFamily extends Family { /// See also [fetchUser]. const FetchUserFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'fetchUserProvider'; + /// See also [fetchUser]. FetchUserProvider call({ required int userId, @@ -49,6 +63,7 @@ class FetchUserFamily extends Family { ); } + @visibleForOverriding @override FetchUserProvider getProviderOverride( covariant FetchUserProvider provider, @@ -58,19 +73,26 @@ class FetchUserFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FutureOr Function(FetchUserRef ref) create) { + return _$FetchUserFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$FetchUserFamilyOverride implements FamilyOverride> { + _$FetchUserFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FutureOr Function(FetchUserRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final FetchUserFamily overriddenFamily; @override - String? get name => r'fetchUserProvider'; + FetchUserProvider getProviderOverride( + covariant FetchUserProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [fetchUser]. @@ -95,7 +117,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ); FetchUserProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -108,7 +130,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { @override Override overrideWith( - FutureOr Function(FetchUserRef provider) create, + FutureOr Function(FetchUserRef ref) create, ) { return ProviderOverride( origin: this, @@ -124,11 +146,32 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ); } + @override + ({ + int userId, + }) get argument { + return (userId: userId,); + } + @override AutoDisposeFutureProviderElement createElement() { return _FetchUserProviderElement(this); } + FetchUserProvider _copyWith( + FutureOr Function(FetchUserRef ref) create, + ) { + return FetchUserProvider._internal( + (ref) => create(ref as FetchUserRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + userId: userId, + ); + } + @override bool operator ==(Object other) { return other is FetchUserProvider && other.userId == userId; @@ -156,4 +199,4 @@ class _FetchUserProviderElement extends AutoDisposeFutureProviderElement int get userId => (origin as FetchUserProvider).userId; } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart index 24f936699..29ee85fa1 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart @@ -23,4 +23,4 @@ final exampleProvider = AutoDisposeStreamProvider.internal( typedef ExampleRef = AutoDisposeStreamProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart index addf9363a..d892e8ba8 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart @@ -23,4 +23,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart index 072dce6c2..60b68adf7 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart @@ -23,4 +23,4 @@ final anotherProvider = AutoDisposeProvider.internal( typedef AnotherRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart index 395a07f40..1e834cdbe 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart @@ -23,4 +23,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart index 31073640e..0e7d74954 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart @@ -37,4 +37,4 @@ final valueProvider = AutoDisposeProvider.internal( typedef ValueRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart index c3cfff0b6..041865b99 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart @@ -23,4 +23,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart index c3cfff0b6..041865b99 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart @@ -23,4 +23,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart index c3cfff0b6..041865b99 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart @@ -23,4 +23,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart index 971b32d3a..8221391a4 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart @@ -52,4 +52,4 @@ final todosProvider = AutoDisposeNotifierProvider>.internal( typedef _$Todos = AutoDisposeNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart index f8e5f6463..347684842 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart @@ -38,4 +38,4 @@ final todoListProvider = typedef _$TodoList = AutoDisposeNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart index c3cfff0b6..041865b99 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart @@ -23,4 +23,4 @@ final counterProvider = AutoDisposeNotifierProvider.internal( typedef _$Counter = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index 180bedb23..a7cc420dc 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -23,4 +23,4 @@ final helloWorldProvider = AutoDisposeProvider.internal( typedef HelloWorldRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index 180bedb23..a7cc420dc 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -23,4 +23,4 @@ final helloWorldProvider = AutoDisposeProvider.internal( typedef HelloWorldRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart index 5bd2dd2b0..e44b1758b 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart @@ -23,4 +23,4 @@ final helloWorldProvider = AutoDisposeProvider.internal( typedef HelloWorldRef = AutoDisposeProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart index 08b9d838b..ce4740543 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart @@ -26,4 +26,4 @@ final fetchConfigurationProvider = typedef FetchConfigurationRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart index fb8e168d2..8783f8ed4 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart @@ -41,4 +41,4 @@ final asyncTodosProvider = typedef _$AsyncTodos = AutoDisposeAsyncNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart index d2f26ef1b..0abb46e3f 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart @@ -23,4 +23,4 @@ final todosProvider = AutoDisposeNotifierProvider>.internal( typedef _$Todos = AutoDisposeNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart index f7db84ee2..be2ec7731 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart @@ -24,4 +24,4 @@ final completedTodosProvider = AutoDisposeProvider>.internal( typedef CompletedTodosRef = AutoDisposeProviderRef>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index d71214f1d..096a056f2 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -39,4 +39,4 @@ final pageIndexProvider = AutoDisposeNotifierProvider.internal( typedef _$PageIndex = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart index a21239ae8..0b4a0a56d 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart @@ -23,4 +23,4 @@ final todosProvider = AutoDisposeNotifierProvider>.internal( typedef _$Todos = AutoDisposeNotifier>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart index 2656fac9b..e02ece976 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -23,4 +23,4 @@ final pageIndexProvider = AutoDisposeNotifierProvider.internal( typedef _$PageIndex = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/static/snippets/async.g.dart b/website/static/snippets/async.g.dart index 8d2b55181..a5b75d791 100644 --- a/website/static/snippets/async.g.dart +++ b/website/static/snippets/async.g.dart @@ -25,4 +25,4 @@ final configurationsProvider = typedef ConfigurationsRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/static/snippets/combine.g.dart b/website/static/snippets/combine.g.dart index ef1b14963..6e60eb019 100644 --- a/website/static/snippets/combine.g.dart +++ b/website/static/snippets/combine.g.dart @@ -24,4 +24,4 @@ final filteredTodosProvider = AutoDisposeProvider>.internal( typedef FilteredTodosRef = AutoDisposeProviderRef>; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/static/snippets/create.g.dart b/website/static/snippets/create.g.dart index e1d7cfc22..ad4d118fe 100644 --- a/website/static/snippets/create.g.dart +++ b/website/static/snippets/create.g.dart @@ -24,4 +24,4 @@ final boredSuggestionProvider = AutoDisposeFutureProvider.internal( typedef BoredSuggestionRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/static/snippets/declare.g.dart b/website/static/snippets/declare.g.dart index 14ecc77f2..d6543db42 100644 --- a/website/static/snippets/declare.g.dart +++ b/website/static/snippets/declare.g.dart @@ -23,4 +23,4 @@ final countProvider = AutoDisposeNotifierProvider.internal( typedef _$Count = AutoDisposeNotifier; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package From 8733b96020ef4291b314b9df254ac2da12235dc0 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 29 Oct 2023 02:47:00 +0100 Subject: [PATCH 028/387] Fix generics --- packages/riverpod_generator/lib/src/templates/family.dart | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index f96890a3c..34f97ddae 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -103,6 +103,8 @@ class FamilyTemplate extends Template { final typeParameters = provider.node.functionExpression.typeParameters; final typeParametersUsage = genericUsageDisplayString(typeParameters); + final typeParametersDefinition = + genericDefinitionDisplayString(typeParameters); return FamilyTemplate._( provider, @@ -118,7 +120,7 @@ class FamilyTemplate extends Template { providerType: providerType, parametersPassThrough: parametersPassThrough, createType: - '${provider.createdTypeDisplayString} Function(${provider._refImplName} ref)', + '${provider.createdTypeDisplayString} Function$typeParametersDefinition(${provider._refImplName} ref)', overrideCreate: '(ref) => create(ref as ${provider._refImplName})', providerOther: ''' @@ -344,7 +346,7 @@ class $familyName extends Family { } } -class $familyOverrideClassName implements FamilyOverride<${provider.exposedTypeDisplayString}> { +class $familyOverrideClassName implements FamilyOverride { $familyOverrideClassName(this.overriddenFamily, this.create); final $createType create; From a94dd330a5ec04cb869f07f59df4aab858aa22a9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 29 Oct 2023 02:47:06 +0100 Subject: [PATCH 029/387] Update generated files --- examples/pub/lib/detail.g.dart | 6 +- examples/pub/lib/search.g.dart | 3 +- .../integration/build_yaml/lib/main.g.dart | 14 +- .../test/integration/annotated.g.dart | 8 +- .../test/integration/async.g.dart | 117 +++++++--- .../test/integration/dependencies.g.dart | 6 +- .../test/integration/dependencies2.g.dart | 5 +- .../test/integration/generated.g.dart | 29 ++- .../test/integration/stream.g.dart | 108 +++++++-- .../test/integration/sync.g.dart | 178 ++++++++++++--- .../generated/golden/lib/sync.g.dart | 4 +- ..._class_based_provider_to_functional.g.dart | 52 ++++- ..._functional_provider_to_class_based.g.dart | 2 +- .../avoid_build_context_in_providers.g.dart | 4 +- .../avoid_public_notifier_properties.g.dart | 2 +- .../test/lints/dependencies.g.dart | 4 +- .../functional_ref/functional_ref.g.dart | 210 +++++++++++++++--- .../notifier_extends/notifier_extends.g.dart | 200 ++++++++++++++--- .../protected_notifier_properties.g.dart | 12 +- .../test/lints/provider_parameters.g.dart | 2 +- .../docs/concepts/about_codegen/main.g.dart | 2 +- .../about_codegen/provider_type/family.g.dart | 2 +- .../provider_type/family_class.g.dart | 2 +- .../provider_type/family_fn.g.dart | 2 +- .../invalidate_family_example/codegen.g.dart | 4 +- .../passing_args/codegen/family.g.dart | 2 +- .../docs/from_provider/family/family.g.dart | 2 +- .../introduction/why_riverpod/codegen.g.dart | 3 +- .../family_and_dispose.g.dart | 3 +- .../current/about_codegen/main.g.dart | 2 +- .../current/about_codegen/main.g.dart | 2 +- .../current/about_codegen/main.g.dart | 2 +- .../current/about_codegen/main.g.dart | 2 +- 33 files changed, 768 insertions(+), 228 deletions(-) diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 748b6e3fa..7397fc2ea 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -81,8 +81,7 @@ class FetchPackageDetailsFamily extends Family { } } -class _$FetchPackageDetailsFamilyOverride - implements FamilyOverride> { +class _$FetchPackageDetailsFamilyOverride implements FamilyOverride { _$FetchPackageDetailsFamilyOverride(this.overriddenFamily, this.create); final FutureOr Function(FetchPackageDetailsRef ref) create; @@ -318,8 +317,7 @@ class PackageMetricsFamily extends Family { } } -class _$PackageMetricsFamilyOverride - implements FamilyOverride> { +class _$PackageMetricsFamilyOverride implements FamilyOverride { _$PackageMetricsFamilyOverride(this.overriddenFamily, this.create); final PackageMetrics Function() create; diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index c9161f8a6..d43cf5161 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -83,8 +83,7 @@ class FetchPackagesFamily extends Family { } } -class _$FetchPackagesFamilyOverride - implements FamilyOverride>> { +class _$FetchPackagesFamilyOverride implements FamilyOverride { _$FetchPackagesFamilyOverride(this.overriddenFamily, this.create); final FutureOr> Function(FetchPackagesRef ref) create; diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 45ddb938a..4448b8c92 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -119,7 +119,7 @@ class Count2Family extends Family { } } -class _$Count2FamilyOverride implements FamilyOverride { +class _$Count2FamilyOverride implements FamilyOverride { _$Count2FamilyOverride(this.overriddenFamily, this.create); final int Function(Count2Ref ref) create; @@ -287,7 +287,7 @@ class CountFuture2Family extends Family { } } -class _$CountFuture2FamilyOverride implements FamilyOverride> { +class _$CountFuture2FamilyOverride implements FamilyOverride { _$CountFuture2FamilyOverride(this.overriddenFamily, this.create); final FutureOr Function(CountFuture2Ref ref) create; @@ -456,7 +456,7 @@ class CountStream2Family extends Family { } } -class _$CountStream2FamilyOverride implements FamilyOverride> { +class _$CountStream2FamilyOverride implements FamilyOverride { _$CountStream2FamilyOverride(this.overriddenFamily, this.create); final Stream Function(CountStream2Ref ref) create; @@ -683,7 +683,7 @@ class CountNotifier2Family extends Family { } } -class _$CountNotifier2FamilyOverride implements FamilyOverride { +class _$CountNotifier2FamilyOverride implements FamilyOverride { _$CountNotifier2FamilyOverride(this.overriddenFamily, this.create); final CountNotifier2 Function() create; @@ -868,8 +868,7 @@ class CountAsyncNotifier2Family extends Family { } } -class _$CountAsyncNotifier2FamilyOverride - implements FamilyOverride> { +class _$CountAsyncNotifier2FamilyOverride implements FamilyOverride { _$CountAsyncNotifier2FamilyOverride(this.overriddenFamily, this.create); final CountAsyncNotifier2 Function() create; @@ -1055,8 +1054,7 @@ class CountStreamNotifier2Family extends Family { } } -class _$CountStreamNotifier2FamilyOverride - implements FamilyOverride> { +class _$CountStreamNotifier2FamilyOverride implements FamilyOverride { _$CountStreamNotifier2FamilyOverride(this.overriddenFamily, this.create); final CountStreamNotifier2 Function() create; diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 3b5aa9b38..99bfe831a 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -54,7 +54,7 @@ class _SystemHash { const familyProvider = FamilyFamily(); /// See also [family]. -class FamilyFamily extends Family { +class FamilyFamily extends Family { /// See also [family]. const FamilyFamily(); @@ -97,7 +97,7 @@ class FamilyFamily extends Family { } } -class _$FamilyFamilyOverride implements FamilyOverride { +class _$FamilyFamilyOverride implements FamilyOverride { _$FamilyFamilyOverride(this.overriddenFamily, this.create); final String Function(FamilyRef ref) create; @@ -238,7 +238,7 @@ String _$notCopiedFamilyHash() => r'6ef06ce6ebd73b476870bbe1af41c4f3fbe8ddb1'; const notCopiedFamilyProvider = NotCopiedFamilyFamily(); /// See also [notCopiedFamily]. -class NotCopiedFamilyFamily extends Family { +class NotCopiedFamilyFamily extends Family { /// See also [notCopiedFamily]. const NotCopiedFamilyFamily(); @@ -281,7 +281,7 @@ class NotCopiedFamilyFamily extends Family { } } -class _$NotCopiedFamilyFamilyOverride implements FamilyOverride { +class _$NotCopiedFamilyFamilyOverride implements FamilyOverride { _$NotCopiedFamilyFamilyOverride(this.overriddenFamily, this.create); final String Function(NotCopiedFamilyRef ref) create; diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 9e050498b..19008ae42 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -38,6 +38,20 @@ class GenericFamily extends Family { /// See also [generic]. const GenericFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericProvider'; + /// See also [generic]. GenericProvider call() { return GenericProvider(); @@ -51,19 +65,27 @@ class GenericFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith( + FutureOr> Function(GenericRef ref) create) { + return _$GenericFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$GenericFamilyOverride implements FamilyOverride { + _$GenericFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final FutureOr> Function(GenericRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final GenericFamily overriddenFamily; @override - String? get name => r'genericProvider'; + GenericProvider getProviderOverride( + covariant GenericProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [generic]. @@ -86,7 +108,7 @@ class GenericProvider ); GenericProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -96,7 +118,7 @@ class GenericProvider @override Override overrideWith( - FutureOr> Function(GenericRef provider) create, + FutureOr> Function(GenericRef ref) create, ) { return ProviderOverride( origin: this, @@ -121,6 +143,19 @@ class GenericProvider return _GenericProviderElement(this); } + GenericProvider _copyWith( + FutureOr> Function(GenericRef ref) create, + ) { + return GenericProvider._internal( + (ref) => create(ref as GenericRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is GenericProvider && other.runtimeType == runtimeType; @@ -220,7 +255,7 @@ class FamilyOrFamily extends Family { } } -class _$FamilyOrFamilyOverride implements FamilyOverride> { +class _$FamilyOrFamilyOverride implements FamilyOverride { _$FamilyOrFamilyOverride(this.overriddenFamily, this.create); final FutureOr Function(FamilyOrRef ref) create; @@ -400,7 +435,7 @@ class FamilyFamily extends Family { } } -class _$FamilyFamilyOverride implements FamilyOverride> { +class _$FamilyFamilyOverride implements FamilyOverride { _$FamilyFamilyOverride(this.overriddenFamily, this.create); final FutureOr Function(FamilyRef ref) create; @@ -591,7 +626,7 @@ String _$genericClassHash() => r'd3c4acc9cdae12f6c666fbf1f89aee212bb086db'; abstract class _$GenericClass extends BuildlessAutoDisposeAsyncNotifier> { - Future> build(); + FutureOr> build(); } /// See also [GenericClass]. @@ -603,6 +638,20 @@ class GenericClassFamily extends Family { /// See also [GenericClass]. const GenericClassFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericClassProvider'; + /// See also [GenericClass]. GenericClassProvider call() { return GenericClassProvider(); @@ -616,19 +665,26 @@ class GenericClassFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(GenericClass Function() create) { + return _$GenericClassFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$GenericClassFamilyOverride implements FamilyOverride { + _$GenericClassFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final GenericClass Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final GenericClassFamily overriddenFamily; @override - String? get name => r'genericClassProvider'; + GenericClassProvider getProviderOverride( + covariant GenericClassProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [GenericClass]. @@ -650,7 +706,7 @@ class GenericClassProvider ); GenericClassProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -659,7 +715,7 @@ class GenericClassProvider }) : super.internal(); @override - Future> runNotifierBuild( + FutureOr> runNotifierBuild( covariant GenericClass notifier, ) { return notifier.build(); @@ -691,6 +747,19 @@ class GenericClassProvider return _GenericClassProviderElement(this); } + GenericClassProvider _copyWith( + GenericClass Function() create, + ) { + return GenericClassProvider._internal( + () => create(), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is GenericClassProvider && other.runtimeType == runtimeType; @@ -803,8 +872,7 @@ class FamilyOrClassFamily extends Family { } } -class _$FamilyOrClassFamilyOverride - implements FamilyOverride> { +class _$FamilyOrClassFamilyOverride implements FamilyOverride { _$FamilyOrClassFamilyOverride(this.overriddenFamily, this.create); final FamilyOrClass Function() create; @@ -1008,8 +1076,7 @@ class FamilyClassFamily extends Family { } } -class _$FamilyClassFamilyOverride - implements FamilyOverride> { +class _$FamilyClassFamilyOverride implements FamilyOverride { _$FamilyClassFamilyOverride(this.overriddenFamily, this.create); final FamilyClass Function() create; diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index b499e8112..0126eab5a 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -91,7 +91,7 @@ class FamilyFamily extends Family { } } -class _$FamilyFamilyOverride implements FamilyOverride { +class _$FamilyFamilyOverride implements FamilyOverride { _$FamilyFamilyOverride(this.overriddenFamily, this.create); final int Function(FamilyRef ref) create; @@ -445,7 +445,7 @@ class Family2Family extends Family { } } -class _$Family2FamilyOverride implements FamilyOverride { +class _$Family2FamilyOverride implements FamilyOverride { _$Family2FamilyOverride(this.overriddenFamily, this.create); final Family2 Function() create; @@ -668,7 +668,7 @@ class Provider4Family extends Family { } } -class _$Provider4FamilyOverride implements FamilyOverride { +class _$Provider4FamilyOverride implements FamilyOverride { _$Provider4FamilyOverride(this.overriddenFamily, this.create); final Provider4 Function() create; diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 509fb1ace..68f5c4873 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -117,7 +117,7 @@ class FamilyWithDependencies2Family extends Family { } } -class _$FamilyWithDependencies2FamilyOverride implements FamilyOverride { +class _$FamilyWithDependencies2FamilyOverride implements FamilyOverride { _$FamilyWithDependencies2FamilyOverride(this.overriddenFamily, this.create); final int Function(FamilyWithDependencies2Ref ref) create; @@ -367,8 +367,7 @@ class NotifierFamilyWithDependenciesFamily extends Family { } } -class _$NotifierFamilyWithDependenciesFamilyOverride - implements FamilyOverride { +class _$NotifierFamilyWithDependenciesFamilyOverride implements FamilyOverride { _$NotifierFamilyWithDependenciesFamilyOverride( this.overriddenFamily, this.create); diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 6f18708d3..3a6bd55cb 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -48,7 +48,7 @@ class _SystemHash { const generatedFamilyProvider = GeneratedFamilyFamily(); /// See also [generatedFamily]. -class GeneratedFamilyFamily extends Family<_Test> { +class GeneratedFamilyFamily extends Family { /// See also [generatedFamily]. const GeneratedFamilyFamily(); @@ -91,7 +91,7 @@ class GeneratedFamilyFamily extends Family<_Test> { } } -class _$GeneratedFamilyFamilyOverride implements FamilyOverride<_Test> { +class _$GeneratedFamilyFamilyOverride implements FamilyOverride { _$GeneratedFamilyFamilyOverride(this.overriddenFamily, this.create); final _Test Function(GeneratedFamilyRef ref) create; @@ -231,7 +231,7 @@ String _$$dynamicFamilyHash() => r'b764133af8837b8321b08814892f198d4bc1aa18'; const $dynamicFamilyProvider = $DynamicFamilyFamily(); /// See also [$dynamicFamily]. -class $DynamicFamilyFamily extends Family { +class $DynamicFamilyFamily extends Family { /// See also [$dynamicFamily]. const $DynamicFamilyFamily(); @@ -274,7 +274,7 @@ class $DynamicFamilyFamily extends Family { } } -class _$$DynamicFamilyFamilyOverride implements FamilyOverride { +class _$$DynamicFamilyFamilyOverride implements FamilyOverride { _$$DynamicFamilyFamilyOverride(this.overriddenFamily, this.create); final Object? Function($DynamicFamilyRef ref) create; @@ -400,7 +400,7 @@ String _$dynamicHash() => r'da9dc07960139fff2cf5fe584dca5c524e4f2308'; const _dynamicProvider = _DynamicFamily(); /// See also [_dynamic]. -class _DynamicFamily extends Family { +class _DynamicFamily extends Family { /// See also [_dynamic]. const _DynamicFamily(); @@ -443,7 +443,7 @@ class _DynamicFamily extends Family { } } -class _$DynamicFamilyOverride implements FamilyOverride { +class _$DynamicFamilyOverride implements FamilyOverride { _$DynamicFamilyOverride(this.overriddenFamily, this.create); final Object? Function(_DynamicRef ref) create; @@ -582,7 +582,7 @@ String _$aliasFamilyHash() => r'f345937d5750132f629aef41646b119a301f750b'; const aliasFamilyProvider = AliasFamilyFamily(); /// See also [aliasFamily]. -class AliasFamilyFamily extends Family> { +class AliasFamilyFamily extends Family { /// See also [aliasFamily]. const AliasFamilyFamily(); @@ -625,7 +625,7 @@ class AliasFamilyFamily extends Family> { } } -class _$AliasFamilyFamilyOverride implements FamilyOverride> { +class _$AliasFamilyFamilyOverride implements FamilyOverride { _$AliasFamilyFamilyOverride(this.overriddenFamily, this.create); final r.AsyncValue Function(AliasFamilyRef ref) create; @@ -777,7 +777,7 @@ abstract class _$GeneratedClassFamily const generatedClassFamilyProvider = GeneratedClassFamilyFamily(); /// See also [GeneratedClassFamily]. -class GeneratedClassFamilyFamily extends Family<_Test> { +class GeneratedClassFamilyFamily extends Family { /// See also [GeneratedClassFamily]. const GeneratedClassFamilyFamily(); @@ -820,7 +820,7 @@ class GeneratedClassFamilyFamily extends Family<_Test> { } } -class _$GeneratedClassFamilyFamilyOverride implements FamilyOverride<_Test> { +class _$GeneratedClassFamilyFamilyOverride implements FamilyOverride { _$GeneratedClassFamilyFamilyOverride(this.overriddenFamily, this.create); final GeneratedClassFamily Function() create; @@ -979,7 +979,7 @@ abstract class _$$DynamicClassFamily const $dynamicClassFamilyProvider = $DynamicClassFamilyFamily(); /// See also [$DynamicClassFamily]. -class $DynamicClassFamilyFamily extends Family { +class $DynamicClassFamilyFamily extends Family { /// See also [$DynamicClassFamily]. const $DynamicClassFamilyFamily(); @@ -1022,7 +1022,7 @@ class $DynamicClassFamilyFamily extends Family { } } -class _$$DynamicClassFamilyFamilyOverride implements FamilyOverride { +class _$$DynamicClassFamilyFamilyOverride implements FamilyOverride { _$$DynamicClassFamilyFamilyOverride(this.overriddenFamily, this.create); final $DynamicClassFamily Function() create; @@ -1179,7 +1179,7 @@ abstract class _$AliasClassFamily const aliasClassFamilyProvider = AliasClassFamilyFamily(); /// See also [AliasClassFamily]. -class AliasClassFamilyFamily extends Family> { +class AliasClassFamilyFamily extends Family { /// See also [AliasClassFamily]. const AliasClassFamilyFamily(); @@ -1222,8 +1222,7 @@ class AliasClassFamilyFamily extends Family> { } } -class _$AliasClassFamilyFamilyOverride - implements FamilyOverride> { +class _$AliasClassFamilyFamilyOverride implements FamilyOverride { _$AliasClassFamilyFamilyOverride(this.overriddenFamily, this.create); final AliasClassFamily Function() create; diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 712b69cf2..e5e916a48 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -38,6 +38,20 @@ class GenericFamily extends Family { /// See also [generic]. const GenericFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericProvider'; + /// See also [generic]. GenericProvider call() { return GenericProvider(); @@ -51,19 +65,27 @@ class GenericFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith( + Stream> Function(GenericRef ref) create) { + return _$GenericFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$GenericFamilyOverride implements FamilyOverride { + _$GenericFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final Stream> Function(GenericRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final GenericFamily overriddenFamily; @override - String? get name => r'genericProvider'; + GenericProvider getProviderOverride( + covariant GenericProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [generic]. @@ -86,7 +108,7 @@ class GenericProvider ); GenericProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -96,7 +118,7 @@ class GenericProvider @override Override overrideWith( - Stream> Function(GenericRef provider) create, + Stream> Function(GenericRef ref) create, ) { return ProviderOverride( origin: this, @@ -121,6 +143,19 @@ class GenericProvider return _GenericProviderElement(this); } + GenericProvider _copyWith( + Stream> Function(GenericRef ref) create, + ) { + return GenericProvider._internal( + (ref) => create(ref as GenericRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is GenericProvider && other.runtimeType == runtimeType; @@ -232,7 +267,7 @@ class FamilyFamily extends Family { } } -class _$FamilyFamilyOverride implements FamilyOverride> { +class _$FamilyFamilyOverride implements FamilyOverride { _$FamilyFamilyOverride(this.overriddenFamily, this.create); final Stream Function(FamilyRef ref) create; @@ -435,6 +470,20 @@ class GenericClassFamily extends Family { /// See also [GenericClass]. const GenericClassFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericClassProvider'; + /// See also [GenericClass]. GenericClassProvider call() { return GenericClassProvider(); @@ -448,19 +497,26 @@ class GenericClassFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(GenericClass Function() create) { + return _$GenericClassFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$GenericClassFamilyOverride implements FamilyOverride { + _$GenericClassFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final GenericClass Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final GenericClassFamily overriddenFamily; @override - String? get name => r'genericClassProvider'; + GenericClassProvider getProviderOverride( + covariant GenericClassProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [GenericClass]. @@ -482,7 +538,7 @@ class GenericClassProvider ); GenericClassProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -523,6 +579,19 @@ class GenericClassProvider return _GenericClassProviderElement(this); } + GenericClassProvider _copyWith( + GenericClass Function() create, + ) { + return GenericClassProvider._internal( + () => create(), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is GenericClassProvider && other.runtimeType == runtimeType; @@ -655,8 +724,7 @@ class FamilyClassFamily extends Family { } } -class _$FamilyClassFamilyOverride - implements FamilyOverride> { +class _$FamilyClassFamilyOverride implements FamilyOverride { _$FamilyClassFamilyOverride(this.overriddenFamily, this.create); final FamilyClass Function() create; diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index ac74a9b1f..d7f9395e7 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -38,6 +38,20 @@ class GenericFamily extends Family { /// See also [generic]. const GenericFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericProvider'; + /// See also [generic]. GenericProvider call() { return GenericProvider(); @@ -51,19 +65,27 @@ class GenericFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith( + List Function(GenericRef ref) create) { + return _$GenericFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$GenericFamilyOverride implements FamilyOverride { + _$GenericFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final List Function(GenericRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final GenericFamily overriddenFamily; @override - String? get name => r'genericProvider'; + GenericProvider getProviderOverride( + covariant GenericProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [generic]. @@ -85,7 +107,7 @@ class GenericProvider extends AutoDisposeProvider> { ); GenericProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -95,7 +117,7 @@ class GenericProvider extends AutoDisposeProvider> { @override Override overrideWith( - List Function(GenericRef provider) create, + List Function(GenericRef ref) create, ) { return ProviderOverride( origin: this, @@ -120,6 +142,19 @@ class GenericProvider extends AutoDisposeProvider> { return _GenericProviderElement(this); } + GenericProvider _copyWith( + List Function(GenericRef ref) create, + ) { + return GenericProvider._internal( + (ref) => create(ref as GenericRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is GenericProvider && other.runtimeType == runtimeType; @@ -152,6 +187,20 @@ class ComplexGenericFamily extends Family { /// See also [complexGeneric]. const ComplexGenericFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'complexGenericProvider'; + /// See also [complexGeneric]. ComplexGenericProvider call({ required T param, @@ -174,19 +223,30 @@ class ComplexGenericFamily extends Family { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith( + List Function( + ComplexGenericRef ref) + create) { + return _$ComplexGenericFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$ComplexGenericFamilyOverride implements FamilyOverride { + _$ComplexGenericFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final List Function( + ComplexGenericRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final ComplexGenericFamily overriddenFamily; @override - String? get name => r'complexGenericProvider'; + ComplexGenericProvider getProviderOverride( + covariant ComplexGenericProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [complexGeneric]. @@ -216,7 +276,7 @@ class ComplexGenericProvider ); ComplexGenericProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -231,7 +291,7 @@ class ComplexGenericProvider @override Override overrideWith( - List Function(ComplexGenericRef provider) create, + List Function(ComplexGenericRef ref) create, ) { return ProviderOverride( origin: this, @@ -264,6 +324,22 @@ class ComplexGenericProvider return _ComplexGenericProviderElement(this); } + ComplexGenericProvider _copyWith( + List Function(ComplexGenericRef ref) + create, + ) { + return ComplexGenericProvider._internal( + (ref) => create(ref as ComplexGenericRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param: param, + otherParam: otherParam, + ); + } + @override bool operator ==(Object other) { return other is ComplexGenericProvider && @@ -382,8 +458,7 @@ class RawFamilyFutureFamily extends Family { } } -class _$RawFamilyFutureFamilyOverride - implements FamilyOverride>> { +class _$RawFamilyFutureFamilyOverride implements FamilyOverride { _$RawFamilyFutureFamilyOverride(this.overriddenFamily, this.create); final Raw> Function(RawFamilyFutureRef ref) create; @@ -554,8 +629,7 @@ class RawFamilyStreamFamily extends Family { } } -class _$RawFamilyStreamFamilyOverride - implements FamilyOverride>> { +class _$RawFamilyStreamFamilyOverride implements FamilyOverride { _$RawFamilyStreamFamilyOverride(this.overriddenFamily, this.create); final Raw> Function(RawFamilyStreamRef ref) create; @@ -776,7 +850,7 @@ class FamilyFamily extends Family { } } -class _$FamilyFamilyOverride implements FamilyOverride { +class _$FamilyFamilyOverride implements FamilyOverride { _$FamilyFamilyOverride(this.overriddenFamily, this.create); final String Function(FamilyRef ref) create; @@ -1011,6 +1085,20 @@ class GenericClassFamily extends Family { /// See also [GenericClass]. const GenericClassFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericClassProvider'; + /// See also [GenericClass]. GenericClassProvider call() { return GenericClassProvider(); @@ -1024,19 +1112,26 @@ class GenericClassFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(GenericClass Function() create) { + return _$GenericClassFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$GenericClassFamilyOverride implements FamilyOverride { + _$GenericClassFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final GenericClass Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final GenericClassFamily overriddenFamily; @override - String? get name => r'genericClassProvider'; + GenericClassProvider getProviderOverride( + covariant GenericClassProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [GenericClass]. @@ -1058,7 +1153,7 @@ class GenericClassProvider ); GenericClassProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -1098,6 +1193,19 @@ class GenericClassProvider return _GenericClassProviderElement(this); } + GenericClassProvider _copyWith( + GenericClass Function() create, + ) { + return GenericClassProvider._internal( + () => create(), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is GenericClassProvider && other.runtimeType == runtimeType; @@ -1213,8 +1321,7 @@ class RawFamilyFutureClassFamily extends Family { } } -class _$RawFamilyFutureClassFamilyOverride - implements FamilyOverride>> { +class _$RawFamilyFutureClassFamilyOverride implements FamilyOverride { _$RawFamilyFutureClassFamilyOverride(this.overriddenFamily, this.create); final RawFamilyFutureClass Function() create; @@ -1401,8 +1508,7 @@ class RawFamilyStreamClassFamily extends Family { } } -class _$RawFamilyStreamClassFamilyOverride - implements FamilyOverride>> { +class _$RawFamilyStreamClassFamilyOverride implements FamilyOverride { _$RawFamilyStreamClassFamilyOverride(this.overriddenFamily, this.create); final RawFamilyStreamClass Function() create; @@ -1647,7 +1753,7 @@ class FamilyClassFamily extends Family { } } -class _$FamilyClassFamilyOverride implements FamilyOverride { +class _$FamilyClassFamilyOverride implements FamilyOverride { _$FamilyClassFamilyOverride(this.overriddenFamily, this.create); final FamilyClass Function() create; diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 1235ead9a..7a09ecae2 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -130,7 +130,7 @@ class FamilyFamily extends Family { } } -class _$FamilyFamilyOverride implements FamilyOverride { +class _$FamilyFamilyOverride implements FamilyOverride { _$FamilyFamilyOverride(this.overriddenFamily, this.create); final String Function(FamilyRef ref) create; @@ -453,7 +453,7 @@ class FamilyClassFamily extends Family { } } -class _$FamilyClassFamilyOverride implements FamilyOverride { +class _$FamilyClassFamilyOverride implements FamilyOverride { _$FamilyClassFamilyOverride(this.overriddenFamily, this.create); final FamilyClass Function() create; diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index 18cd9af98..8e2a8b82e 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -114,7 +114,7 @@ class ExampleFamilyFamily extends Family { } } -class _$ExampleFamilyFamilyOverride implements FamilyOverride { +class _$ExampleFamilyFamilyOverride implements FamilyOverride { _$ExampleFamilyFamilyOverride(this.overriddenFamily, this.create); final ExampleFamily Function() create; @@ -283,6 +283,20 @@ class GenericFamily extends Family { /// See also [Generic]. const GenericFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericProvider'; + /// See also [Generic]. GenericProvider call() { return GenericProvider(); @@ -296,19 +310,26 @@ class GenericFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(Generic Function() create) { + return _$GenericFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$GenericFamilyOverride implements FamilyOverride { + _$GenericFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final Generic Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final GenericFamily overriddenFamily; @override - String? get name => r'genericProvider'; + GenericProvider getProviderOverride( + covariant GenericProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [Generic]. @@ -329,7 +350,7 @@ class GenericProvider ); GenericProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -369,6 +390,19 @@ class GenericProvider return _GenericProviderElement(this); } + GenericProvider _copyWith( + Generic Function() create, + ) { + return GenericProvider._internal( + () => create(), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is GenericProvider && other.runtimeType == runtimeType; diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index f626e08bf..fce831170 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -104,7 +104,7 @@ class ExampleFamilyFamily extends Family { } } -class _$ExampleFamilyFamilyOverride implements FamilyOverride { +class _$ExampleFamilyFamilyOverride implements FamilyOverride { _$ExampleFamilyFamilyOverride(this.overriddenFamily, this.create); final int Function(ExampleFamilyRef ref) create; diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 586f558da..57ff93806 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -80,7 +80,7 @@ class FnFamily extends Family { } } -class _$FnFamilyOverride implements FamilyOverride { +class _$FnFamilyOverride implements FamilyOverride { _$FnFamilyOverride(this.overriddenFamily, this.create); final int Function(FnRef ref) create; @@ -279,7 +279,7 @@ class MyNotifierFamily extends Family { } } -class _$MyNotifierFamilyOverride implements FamilyOverride { +class _$MyNotifierFamilyOverride implements FamilyOverride { _$MyNotifierFamilyOverride(this.overriddenFamily, this.create); final MyNotifier Function() create; diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index ec169870d..c940d274a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -85,7 +85,7 @@ class GeneratedNotifierFamily extends Family { } } -class _$GeneratedNotifierFamilyOverride implements FamilyOverride { +class _$GeneratedNotifierFamilyOverride implements FamilyOverride { _$GeneratedNotifierFamilyOverride(this.overriddenFamily, this.create); final GeneratedNotifier Function() create; diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index 2f4e1167b..0c6d35d4d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -461,7 +461,7 @@ class FamilyDepFamily extends Family { } } -class _$FamilyDepFamilyOverride implements FamilyOverride { +class _$FamilyDepFamilyOverride implements FamilyOverride { _$FamilyDepFamilyOverride(this.overriddenFamily, this.create); final int Function(FamilyDepRef ref) create; @@ -635,7 +635,7 @@ class FamilyDep2Family extends Family { } } -class _$FamilyDep2FamilyOverride implements FamilyOverride { +class _$FamilyDep2FamilyOverride implements FamilyOverride { _$FamilyDep2FamilyOverride(this.overriddenFamily, this.create); final int Function(FamilyDep2Ref ref) create; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 57b6200ab..d224137fc 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -69,6 +69,20 @@ class GenericsFamily extends Family { /// See also [generics]. const GenericsFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericsProvider'; + /// See also [generics]. GenericsProvider call() { return GenericsProvider(); @@ -82,19 +96,27 @@ class GenericsFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith( + int Function(GenericsRef ref) create) { + return _$GenericsFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$GenericsFamilyOverride implements FamilyOverride { + _$GenericsFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final int Function(GenericsRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final GenericsFamily overriddenFamily; @override - String? get name => r'genericsProvider'; + GenericsProvider getProviderOverride( + covariant GenericsProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [generics]. @@ -116,7 +138,7 @@ class GenericsProvider extends AutoDisposeProvider { ); GenericsProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -126,7 +148,7 @@ class GenericsProvider extends AutoDisposeProvider { @override Override overrideWith( - int Function(GenericsRef provider) create, + int Function(GenericsRef ref) create, ) { return ProviderOverride( origin: this, @@ -151,6 +173,19 @@ class GenericsProvider extends AutoDisposeProvider { return _GenericsProviderElement(this); } + GenericsProvider _copyWith( + int Function(GenericsRef ref) create, + ) { + return GenericsProvider._internal( + (ref) => create(ref as GenericsRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is GenericsProvider && other.runtimeType == runtimeType; @@ -184,6 +219,20 @@ class NoGenericsFamily extends Family { /// See also [noGenerics]. const NoGenericsFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'noGenericsProvider'; + /// See also [noGenerics]. NoGenericsProvider call() { return NoGenericsProvider(); @@ -197,19 +246,27 @@ class NoGenericsFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith( + int Function(NoGenericsRef ref) create) { + return _$NoGenericsFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$NoGenericsFamilyOverride implements FamilyOverride { + _$NoGenericsFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final int Function(NoGenericsRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final NoGenericsFamily overriddenFamily; @override - String? get name => r'noGenericsProvider'; + NoGenericsProvider getProviderOverride( + covariant NoGenericsProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [noGenerics]. @@ -232,7 +289,7 @@ class NoGenericsProvider extends AutoDisposeProvider { ); NoGenericsProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -242,7 +299,7 @@ class NoGenericsProvider extends AutoDisposeProvider { @override Override overrideWith( - int Function(NoGenericsRef provider) create, + int Function(NoGenericsRef ref) create, ) { return ProviderOverride( origin: this, @@ -267,6 +324,19 @@ class NoGenericsProvider extends AutoDisposeProvider { return _NoGenericsProviderElement(this); } + NoGenericsProvider _copyWith( + int Function(NoGenericsRef ref) create, + ) { + return NoGenericsProvider._internal( + (ref) => create(ref as NoGenericsRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is NoGenericsProvider && other.runtimeType == runtimeType; @@ -300,6 +370,20 @@ class MissingGenericsFamily extends Family { /// See also [missingGenerics]. const MissingGenericsFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'missingGenericsProvider'; + /// See also [missingGenerics]. MissingGenericsProvider call() { return MissingGenericsProvider(); @@ -313,19 +397,26 @@ class MissingGenericsFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(int Function(MissingGenericsRef ref) create) { + return _$MissingGenericsFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$MissingGenericsFamilyOverride implements FamilyOverride { + _$MissingGenericsFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final int Function(MissingGenericsRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final MissingGenericsFamily overriddenFamily; @override - String? get name => r'missingGenericsProvider'; + MissingGenericsProvider getProviderOverride( + covariant MissingGenericsProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [missingGenerics]. @@ -348,7 +439,7 @@ class MissingGenericsProvider extends AutoDisposeProvider { ); MissingGenericsProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -358,7 +449,7 @@ class MissingGenericsProvider extends AutoDisposeProvider { @override Override overrideWith( - int Function(MissingGenericsRef provider) create, + int Function(MissingGenericsRef ref) create, ) { return ProviderOverride( origin: this, @@ -383,6 +474,19 @@ class MissingGenericsProvider extends AutoDisposeProvider { return _MissingGenericsProviderElement(this); } + MissingGenericsProvider _copyWith( + int Function(MissingGenericsRef ref) create, + ) { + return MissingGenericsProvider._internal( + (ref) => create(ref as MissingGenericsRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is MissingGenericsProvider && other.runtimeType == runtimeType; @@ -416,6 +520,20 @@ class WrongOrderFamily extends Family { /// See also [wrongOrder]. const WrongOrderFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'wrongOrderProvider'; + /// See also [wrongOrder]. WrongOrderProvider call() { return WrongOrderProvider(); @@ -429,19 +547,26 @@ class WrongOrderFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(int Function(WrongOrderRef ref) create) { + return _$WrongOrderFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$WrongOrderFamilyOverride implements FamilyOverride { + _$WrongOrderFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final int Function(WrongOrderRef ref) create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final WrongOrderFamily overriddenFamily; @override - String? get name => r'wrongOrderProvider'; + WrongOrderProvider getProviderOverride( + covariant WrongOrderProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [wrongOrder]. @@ -464,7 +589,7 @@ class WrongOrderProvider extends AutoDisposeProvider { ); WrongOrderProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -474,7 +599,7 @@ class WrongOrderProvider extends AutoDisposeProvider { @override Override overrideWith( - int Function(WrongOrderRef provider) create, + int Function(WrongOrderRef ref) create, ) { return ProviderOverride( origin: this, @@ -499,6 +624,19 @@ class WrongOrderProvider extends AutoDisposeProvider { return _WrongOrderProviderElement(this); } + WrongOrderProvider _copyWith( + int Function(WrongOrderRef ref) create, + ) { + return WrongOrderProvider._internal( + (ref) => create(ref as WrongOrderRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is WrongOrderProvider && other.runtimeType == runtimeType; diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart index 151d26616..8bfc3a4aa 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart @@ -102,6 +102,20 @@ class GenericsFamily extends Family { /// See also [Generics]. const GenericsFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'genericsProvider'; + /// See also [Generics]. GenericsProvider call() { return GenericsProvider(); @@ -115,19 +129,26 @@ class GenericsFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(Generics Function() create) { + return _$GenericsFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$GenericsFamilyOverride implements FamilyOverride { + _$GenericsFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final Generics Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final GenericsFamily overriddenFamily; @override - String? get name => r'genericsProvider'; + GenericsProvider getProviderOverride( + covariant GenericsProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [Generics]. @@ -148,7 +169,7 @@ class GenericsProvider ); GenericsProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -188,6 +209,19 @@ class GenericsProvider return _GenericsProviderElement(this); } + GenericsProvider _copyWith( + Generics Function() create, + ) { + return GenericsProvider._internal( + () => create(), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is GenericsProvider && other.runtimeType == runtimeType; @@ -227,6 +261,20 @@ class NoGenericsFamily extends Family { /// See also [NoGenerics]. const NoGenericsFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'noGenericsProvider'; + /// See also [NoGenerics]. NoGenericsProvider call() { return NoGenericsProvider(); @@ -240,19 +288,26 @@ class NoGenericsFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(NoGenerics Function() create) { + return _$NoGenericsFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$NoGenericsFamilyOverride implements FamilyOverride { + _$NoGenericsFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final NoGenerics Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final NoGenericsFamily overriddenFamily; @override - String? get name => r'noGenericsProvider'; + NoGenericsProvider getProviderOverride( + covariant NoGenericsProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [NoGenerics]. @@ -274,7 +329,7 @@ class NoGenericsProvider ); NoGenericsProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -314,6 +369,19 @@ class NoGenericsProvider return _NoGenericsProviderElement(this); } + NoGenericsProvider _copyWith( + NoGenerics Function() create, + ) { + return NoGenericsProvider._internal( + () => create(), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is NoGenericsProvider && other.runtimeType == runtimeType; @@ -353,6 +421,20 @@ class MissingGenericsFamily extends Family { /// See also [MissingGenerics]. const MissingGenericsFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'missingGenericsProvider'; + /// See also [MissingGenerics]. MissingGenericsProvider call() { return MissingGenericsProvider(); @@ -366,19 +448,26 @@ class MissingGenericsFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(MissingGenerics Function() create) { + return _$MissingGenericsFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$MissingGenericsFamilyOverride implements FamilyOverride { + _$MissingGenericsFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final MissingGenerics Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final MissingGenericsFamily overriddenFamily; @override - String? get name => r'missingGenericsProvider'; + MissingGenericsProvider getProviderOverride( + covariant MissingGenericsProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [MissingGenerics]. @@ -400,7 +489,7 @@ class MissingGenericsProvider ); MissingGenericsProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -441,6 +530,19 @@ class MissingGenericsProvider return _MissingGenericsProviderElement(this); } + MissingGenericsProvider _copyWith( + MissingGenerics Function() create, + ) { + return MissingGenericsProvider._internal( + () => create(), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is MissingGenericsProvider && other.runtimeType == runtimeType; @@ -479,6 +581,20 @@ class WrongOrderFamily extends Family { /// See also [WrongOrder]. const WrongOrderFamily(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'wrongOrderProvider'; + /// See also [WrongOrder]. WrongOrderProvider call() { return WrongOrderProvider(); @@ -492,19 +608,26 @@ class WrongOrderFamily extends Family { return call(); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(WrongOrder Function() create) { + return _$WrongOrderFamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$WrongOrderFamilyOverride implements FamilyOverride { + _$WrongOrderFamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final WrongOrder Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final WrongOrderFamily overriddenFamily; @override - String? get name => r'wrongOrderProvider'; + WrongOrderProvider getProviderOverride( + covariant WrongOrderProvider provider, + ) { + return provider._copyWith(create); + } } /// See also [WrongOrder]. @@ -526,7 +649,7 @@ class WrongOrderProvider ); WrongOrderProvider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -566,6 +689,19 @@ class WrongOrderProvider return _WrongOrderProviderElement(this); } + WrongOrderProvider _copyWith( + WrongOrder Function() create, + ) { + return WrongOrderProvider._internal( + () => create(), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + ); + } + @override bool operator ==(Object other) { return other is WrongOrderProvider && other.runtimeType == runtimeType; diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index 0615d6811..7c9fb644a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -113,7 +113,7 @@ class A3Family extends Family { } } -class _$A3FamilyOverride implements FamilyOverride { +class _$A3FamilyOverride implements FamilyOverride { _$A3FamilyOverride(this.overriddenFamily, this.create); final A3 Function() create; @@ -291,7 +291,7 @@ class A4Family extends Family { } } -class _$A4FamilyOverride implements FamilyOverride { +class _$A4FamilyOverride implements FamilyOverride { _$A4FamilyOverride(this.overriddenFamily, this.create); final A4 Function() create; @@ -468,7 +468,7 @@ class A5Family extends Family { } } -class _$A5FamilyOverride implements FamilyOverride> { +class _$A5FamilyOverride implements FamilyOverride { _$A5FamilyOverride(this.overriddenFamily, this.create); final A5 Function() create; @@ -646,7 +646,7 @@ class A6Family extends Family { } } -class _$A6FamilyOverride implements FamilyOverride> { +class _$A6FamilyOverride implements FamilyOverride { _$A6FamilyOverride(this.overriddenFamily, this.create); final A6 Function() create; @@ -824,7 +824,7 @@ class A7Family extends Family { } } -class _$A7FamilyOverride implements FamilyOverride> { +class _$A7FamilyOverride implements FamilyOverride { _$A7FamilyOverride(this.overriddenFamily, this.create); final A7 Function() create; @@ -1002,7 +1002,7 @@ class A8Family extends Family { } } -class _$A8FamilyOverride implements FamilyOverride> { +class _$A8FamilyOverride implements FamilyOverride { _$A8FamilyOverride(this.overriddenFamily, this.create); final A8 Function() create; diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 9b960dd49..e47e0ce94 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -77,7 +77,7 @@ class GeneratorFamily extends Family { } } -class _$GeneratorFamilyOverride implements FamilyOverride { +class _$GeneratorFamilyOverride implements FamilyOverride { _$GeneratorFamilyOverride(this.overriddenFamily, this.create); final int Function(GeneratorRef ref) create; diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 0a2446f97..370c04d0a 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -79,7 +79,7 @@ class FetchUserFamily extends Family { } } -class _$FetchUserFamilyOverride implements FamilyOverride> { +class _$FetchUserFamilyOverride implements FamilyOverride { _$FetchUserFamilyOverride(this.overriddenFamily, this.create); final FutureOr Function(FetchUserRef ref) create; diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index b73608c0b..fe7456f0d 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -79,7 +79,7 @@ class ExampleFamily extends Family { } } -class _$ExampleFamilyOverride implements FamilyOverride { +class _$ExampleFamilyOverride implements FamilyOverride { _$ExampleFamilyOverride(this.overriddenFamily, this.create); final String Function(ExampleRef ref) create; diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index ebabfd15f..1108d93c1 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -92,7 +92,7 @@ class ExampleFamily extends Family { } } -class _$ExampleFamilyOverride implements FamilyOverride { +class _$ExampleFamilyOverride implements FamilyOverride { _$ExampleFamilyOverride(this.overriddenFamily, this.create); final Example Function() create; diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index 7fc2c43d1..a72fa27de 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -82,7 +82,7 @@ class ExampleFamily extends Family { } } -class _$ExampleFamilyOverride implements FamilyOverride { +class _$ExampleFamilyOverride implements FamilyOverride { _$ExampleFamilyOverride(this.overriddenFamily, this.create); final String Function(ExampleRef ref) create; diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index 04810e0e7..410c48677 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -36,7 +36,7 @@ class _SystemHash { const labelProvider = LabelFamily(); /// See also [label]. -class LabelFamily extends Family { +class LabelFamily extends Family { /// See also [label]. const LabelFamily(); @@ -79,7 +79,7 @@ class LabelFamily extends Family { } } -class _$LabelFamilyOverride implements FamilyOverride { +class _$LabelFamilyOverride implements FamilyOverride { _$LabelFamilyOverride(this.overriddenFamily, this.create); final String Function(LabelRef ref) create; diff --git a/website/docs/essentials/passing_args/codegen/family.g.dart b/website/docs/essentials/passing_args/codegen/family.g.dart index 46a74719b..c88a2122c 100644 --- a/website/docs/essentials/passing_args/codegen/family.g.dart +++ b/website/docs/essentials/passing_args/codegen/family.g.dart @@ -79,7 +79,7 @@ class ActivityFamily extends Family { } } -class _$ActivityFamilyOverride implements FamilyOverride> { +class _$ActivityFamilyOverride implements FamilyOverride { _$ActivityFamilyOverride(this.overriddenFamily, this.create); final FutureOr Function(ActivityRef ref) create; diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index e7793230e..3e39394a5 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -82,7 +82,7 @@ class RandomFamily extends Family { } } -class _$RandomFamilyOverride implements FamilyOverride { +class _$RandomFamilyOverride implements FamilyOverride { _$RandomFamilyOverride(this.overriddenFamily, this.create); final int Function(RandomRef ref) create; diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index c2c6ead3c..8f63ec36f 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -83,8 +83,7 @@ class FetchPackagesFamily extends Family { } } -class _$FetchPackagesFamilyOverride - implements FamilyOverride>> { +class _$FetchPackagesFamilyOverride implements FamilyOverride { _$FetchPackagesFamilyOverride(this.overriddenFamily, this.create); final FutureOr> Function(FetchPackagesRef ref) create; diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index 1ae77f4ae..cbcfb779b 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -89,8 +89,7 @@ class BugsEncounteredNotifierFamily extends Family { } } -class _$BugsEncounteredNotifierFamilyOverride - implements FamilyOverride> { +class _$BugsEncounteredNotifierFamilyOverride implements FamilyOverride { _$BugsEncounteredNotifierFamilyOverride(this.overriddenFamily, this.create); final BugsEncounteredNotifier Function() create; diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 0a2446f97..370c04d0a 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -79,7 +79,7 @@ class FetchUserFamily extends Family { } } -class _$FetchUserFamilyOverride implements FamilyOverride> { +class _$FetchUserFamilyOverride implements FamilyOverride { _$FetchUserFamilyOverride(this.overriddenFamily, this.create); final FutureOr Function(FetchUserRef ref) create; diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 0a2446f97..370c04d0a 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -79,7 +79,7 @@ class FetchUserFamily extends Family { } } -class _$FetchUserFamilyOverride implements FamilyOverride> { +class _$FetchUserFamilyOverride implements FamilyOverride { _$FetchUserFamilyOverride(this.overriddenFamily, this.create); final FutureOr Function(FetchUserRef ref) create; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 0a2446f97..370c04d0a 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -79,7 +79,7 @@ class FetchUserFamily extends Family { } } -class _$FetchUserFamilyOverride implements FamilyOverride> { +class _$FetchUserFamilyOverride implements FamilyOverride { _$FetchUserFamilyOverride(this.overriddenFamily, this.create); final FutureOr Function(FetchUserRef ref) create; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 0a2446f97..370c04d0a 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -79,7 +79,7 @@ class FetchUserFamily extends Family { } } -class _$FetchUserFamilyOverride implements FamilyOverride> { +class _$FetchUserFamilyOverride implements FamilyOverride { _$FetchUserFamilyOverride(this.overriddenFamily, this.create); final FutureOr Function(FetchUserRef ref) create; From cb0b1779c6ce5c361eeb365859e617defd643e24 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 29 Oct 2023 13:37:55 +0100 Subject: [PATCH 030/387] 3.0.0 dev release --- packages/flutter_riverpod/CHANGELOG.md | 8 ++++++++ packages/flutter_riverpod/pubspec.yaml | 4 ++-- packages/hooks_riverpod/CHANGELOG.md | 8 ++++++++ packages/hooks_riverpod/pubspec.yaml | 6 +++--- packages/riverpod/CHANGELOG.md | 2 +- packages/riverpod/pubspec.yaml | 2 +- packages/riverpod_annotation/CHANGELOG.md | 4 ++++ packages/riverpod_annotation/pubspec.yaml | 4 ++-- packages/riverpod_generator/CHANGELOG.md | 2 +- packages/riverpod_generator/pubspec.yaml | 4 ++-- packages/riverpod_lint/CHANGELOG.md | 4 ++++ packages/riverpod_lint/pubspec.yaml | 4 ++-- 12 files changed, 38 insertions(+), 14 deletions(-) diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md index 6df27f12b..6e352ecc5 100644 --- a/packages/flutter_riverpod/CHANGELOG.md +++ b/packages/flutter_riverpod/CHANGELOG.md @@ -1,3 +1,11 @@ +## 3.0.0-dev.0 - 2023-10-29 + +- **Breaking**: `AsyncValue` is now "sealed" and `AsyncData/AsyncLoading/AsyncError` + are "final". This means that it is no-longer possible to subclass + `AsyncValue` or the associated classes. +- **Breaking**: Removed everything marked as "deprecated" +- Bumped minimum Dart SDK to >= 3.0.0-dev + ## 2.4.5 - 2023-10-28 - Support assigning `AsyncValue` to `AsyncNotifier.state` diff --git a/packages/flutter_riverpod/pubspec.yaml b/packages/flutter_riverpod/pubspec.yaml index 0aa533690..1a0e958d9 100644 --- a/packages/flutter_riverpod/pubspec.yaml +++ b/packages/flutter_riverpod/pubspec.yaml @@ -2,7 +2,7 @@ name: flutter_riverpod description: > A simple way to access state from anywhere in your application while robust and testable. -version: 2.4.5 +version: 3.0.0-dev.0 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues @@ -18,7 +18,7 @@ dependencies: flutter: sdk: flutter meta: ^1.4.0 - riverpod: 2.4.5 + riverpod: 3.0.0-dev.0 state_notifier: ">=0.7.2 <2.0.0" dev_dependencies: diff --git a/packages/hooks_riverpod/CHANGELOG.md b/packages/hooks_riverpod/CHANGELOG.md index d854fa9cd..1ae6559c3 100644 --- a/packages/hooks_riverpod/CHANGELOG.md +++ b/packages/hooks_riverpod/CHANGELOG.md @@ -1,3 +1,11 @@ +## 3.0.0-dev.0 - 2023-10-29 + +- **Breaking**: `AsyncValue` is now "sealed" and `AsyncData/AsyncLoading/AsyncError` + are "final". This means that it is no-longer possible to subclass + `AsyncValue` or the associated classes. +- **Breaking**: Removed everything marked as "deprecated" +- Bumped minimum Dart SDK to >= 3.0.0-dev + ## 2.4.5 - 2023-10-28 - Support assigning `AsyncValue` to `AsyncNotifier.state` diff --git a/packages/hooks_riverpod/pubspec.yaml b/packages/hooks_riverpod/pubspec.yaml index f7bf57f29..a16da991a 100644 --- a/packages/hooks_riverpod/pubspec.yaml +++ b/packages/hooks_riverpod/pubspec.yaml @@ -2,7 +2,7 @@ name: hooks_riverpod description: > A simple way to access state from anywhere in your application while robust and testable. -version: 2.4.5 +version: 3.0.0-dev.0 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues @@ -18,8 +18,8 @@ dependencies: flutter: sdk: flutter flutter_hooks: '>=0.18.0 <0.21.0' - flutter_riverpod: 2.4.5 - riverpod: 2.4.5 + flutter_riverpod: 3.0.0-dev.0 + riverpod: 3.0.0-dev.0 state_notifier: ">=0.7.2 <2.0.0" dev_dependencies: diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 5590dc95e..313b88b13 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased 3.0.0-dev.6 +## 3.0.0-dev.0 - 2023-10-29 - **Breaking**: `AsyncValue` is now "sealed" and `AsyncData/AsyncLoading/AsyncError` are "final". This means that it is no-longer possible to subclass diff --git a/packages/riverpod/pubspec.yaml b/packages/riverpod/pubspec.yaml index a41813c75..40a28e1e8 100644 --- a/packages/riverpod/pubspec.yaml +++ b/packages/riverpod/pubspec.yaml @@ -2,7 +2,7 @@ name: riverpod description: > A simple way to access state from anywhere in your application while robust and testable. -version: 2.4.5 +version: 3.0.0-dev.0 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues diff --git a/packages/riverpod_annotation/CHANGELOG.md b/packages/riverpod_annotation/CHANGELOG.md index f2ed8a3db..baa8eb286 100644 --- a/packages/riverpod_annotation/CHANGELOG.md +++ b/packages/riverpod_annotation/CHANGELOG.md @@ -1,3 +1,7 @@ +## 3.0.0-dev.0 - 2023-10-29 + +- `riverpod` upgraded to `3.0.0-dev.0` + ## 2.3.0 - 2023-10-28 - Exported internal `FamilyOverride` API, for use in generated code. diff --git a/packages/riverpod_annotation/pubspec.yaml b/packages/riverpod_annotation/pubspec.yaml index 330f88dbd..702731331 100644 --- a/packages/riverpod_annotation/pubspec.yaml +++ b/packages/riverpod_annotation/pubspec.yaml @@ -1,6 +1,6 @@ name: riverpod_annotation description: A package exposing annotations for riverpod_generator -version: 2.3.0 +version: 3.0.0-dev.0 repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues funding: @@ -11,7 +11,7 @@ environment: dependencies: meta: ^1.7.0 - riverpod: ^2.4.5 + riverpod: ^3.0.0-dev.0 dev_dependencies: test: ^1.21.0 diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 8e70702a1..a25341843 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased 3.0.0-dev.5 +## 3.0.0-dev.7 - 2023-10-29 - Providers can now be generic: diff --git a/packages/riverpod_generator/pubspec.yaml b/packages/riverpod_generator/pubspec.yaml index e8014d479..dc1b756ac 100644 --- a/packages/riverpod_generator/pubspec.yaml +++ b/packages/riverpod_generator/pubspec.yaml @@ -1,6 +1,6 @@ name: riverpod_generator description: A code generator for Riverpod. This both simplifies the syntax empowers it, such as allowing stateful hot-reload. -version: 3.0.0-dev.6 +version: 3.0.0-dev.7 repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues funding: @@ -18,7 +18,7 @@ dependencies: meta: ^1.7.0 path: ^1.8.0 riverpod_analyzer_utils: ^0.4.3 - riverpod_annotation: ^2.3.0 + riverpod_annotation: ^3.0.0-dev.0 source_gen: ^1.2.0 dev_dependencies: diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index 509af434f..7892cd6c3 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -1,3 +1,7 @@ +## 3.0.0-dev.0 - 2023-10-29 + +- `riverpod` upgraded to `3.0.0-dev.0` + ## 2.3.3 - 2023-10-28 - `riverpod` upgraded to `2.4.5` diff --git a/packages/riverpod_lint/pubspec.yaml b/packages/riverpod_lint/pubspec.yaml index 83507cc8c..f13eee9ae 100644 --- a/packages/riverpod_lint/pubspec.yaml +++ b/packages/riverpod_lint/pubspec.yaml @@ -1,6 +1,6 @@ name: riverpod_lint description: Riverpod_lint is a developer tool for users of Riverpod, designed to help stop common issues and simplify repetitive tasks. -version: 2.3.3 +version: 3.0.0-dev.0 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/river_pod issue_tracker: https://github.com/rrousselGit/riverpod/issues @@ -17,7 +17,7 @@ dependencies: custom_lint_builder: ^0.5.2 meta: ^1.7.0 path: ^1.8.1 - riverpod: ^2.4.5 + riverpod: ^3.0.0-dev.0 riverpod_analyzer_utils: ^0.4.3 source_span: ^1.8.0 yaml: ^3.1.1 From 7278d5458af9a3dbcdff0e1ff0e81bd3a46ddfba Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 29 Oct 2023 13:40:40 +0100 Subject: [PATCH 031/387] Check dev PRs against dev --- .github/workflows/changelog.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml index 86765bcbe..1e3acc6d2 100644 --- a/.github/workflows/changelog.yml +++ b/.github/workflows/changelog.yml @@ -28,5 +28,5 @@ jobs: - name: Install "semantic_changelog" run: dart pub global activate -s git https://github.com/rrousselGit/semantic_changelog - - run: git fetch origin master:refs/remotes/origin/master - - run: semantic_changelog check origin/master \ No newline at end of file + - run: git fetch origin dev:refs/remotes/origin/dev + - run: semantic_changelog check origin/dev \ No newline at end of file From 105b3384908c49bfc3a68369f3899c6b4e28fd7f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 29 Oct 2023 13:41:39 +0100 Subject: [PATCH 032/387] Remove duplicate CI work --- .github/workflows/changelog.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml index 1e3acc6d2..23fa6544e 100644 --- a/.github/workflows/changelog.yml +++ b/.github/workflows/changelog.yml @@ -4,7 +4,6 @@ on: push: branches: - master - - dev pull_request: From 26661fde05829a422ca1a0da26e2a0f27b359678 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 29 Oct 2023 13:42:26 +0100 Subject: [PATCH 033/387] Fix CI --- .github/workflows/changelog.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml index 23fa6544e..75d2323d8 100644 --- a/.github/workflows/changelog.yml +++ b/.github/workflows/changelog.yml @@ -1,11 +1,7 @@ name: Check CHANGELOG.md on: - push: - branches: - - master pull_request: - jobs: build: From c081a1671df7e44431ca4fd3d517a49ae5b3fa94 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 29 Oct 2023 13:43:59 +0100 Subject: [PATCH 034/387] Remove more dups --- .github/workflows/build.yml | 7 ------- .github/workflows/check_generation.yml | 6 ------ .github/workflows/riverpod_lint.yml | 6 ------ 3 files changed, 19 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index f0af561b8..6a9e10071 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -5,13 +5,6 @@ on: paths-ignore: - "**.md" - "**.mdx" - push: - branches: - - master - - dev - paths-ignore: - - "**.md" - - "**.mdx" schedule: # runs the CI everyday at 10AM diff --git a/.github/workflows/check_generation.yml b/.github/workflows/check_generation.yml index 629ab50cd..5cb2259ed 100644 --- a/.github/workflows/check_generation.yml +++ b/.github/workflows/check_generation.yml @@ -4,12 +4,6 @@ on: pull_request: paths-ignore: - "**.md" - push: - branches: - - master - - dev - paths-ignore: - - "**.md" jobs: build: diff --git a/.github/workflows/riverpod_lint.yml b/.github/workflows/riverpod_lint.yml index ae92a03b8..0752ab895 100644 --- a/.github/workflows/riverpod_lint.yml +++ b/.github/workflows/riverpod_lint.yml @@ -4,12 +4,6 @@ on: pull_request: paths-ignore: - "**.md" - push: - branches: - - master - - dev - paths-ignore: - - "**.md" schedule: # runs the CI everyday at 10AM - cron: "0 10 * * *" From d5d4c7458413ba44dd24db09e6f777f774519c20 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 29 Oct 2023 14:11:54 +0100 Subject: [PATCH 035/387] Fix test --- .../test/lints/functional_ref/functional_ref.json | 2 +- .../test/lints/functional_ref/functional_ref_test.dart | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.json b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.json index f8ef383c2..4def516b2 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.json +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.json @@ -1 +1 @@ -[{"priority":90,"change":{"message":"Add ref parameter","edits":[{"fileStamp":0,"edits":[{"offset":148,"length":0,"replacement":"ReflessRef ref"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as NamelessRef","edits":[{"fileStamp":0,"edits":[{"offset":226,"length":0,"replacement":"NamelessRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as IncorrectlyTypedRef","edits":[{"fileStamp":0,"edits":[{"offset":317,"length":4,"replacement":"IncorrectlyTypedRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as NoGenericsRef","edits":[{"fileStamp":0,"edits":[{"offset":524,"length":14,"replacement":"NoGenericsRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as MissingGenericsRef","edits":[{"fileStamp":0,"edits":[{"offset":617,"length":19,"replacement":"MissingGenericsRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as WrongOrderRef","edits":[{"fileStamp":0,"edits":[{"offset":710,"length":14,"replacement":"WrongOrderRef "}]}],"linkedEditGroups":[]}}] \ No newline at end of file +[{"priority":90,"change":{"message":"Type as NamelessRef","edits":[{"fileStamp":0,"edits":[{"offset":154,"length":0,"replacement":"NamelessRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as NoGenericsRef","edits":[{"fileStamp":0,"edits":[{"offset":357,"length":14,"replacement":"NoGenericsRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as MissingGenericsRef","edits":[{"fileStamp":0,"edits":[{"offset":450,"length":19,"replacement":"MissingGenericsRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as WrongOrderRef","edits":[{"fileStamp":0,"edits":[{"offset":543,"length":14,"replacement":"WrongOrderRef "}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart index 6625754c9..ecfaac102 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart @@ -23,7 +23,7 @@ void main() { result as ResolvedUnitResult; final errors = await lint.testRun(result); - expect(errors, hasLength(6)); + expect(errors, hasLength(4)); final changes = await Future.wait([ for (final error in errors) fix.testRun(result, error, errors), From e8017f8e8045194bc07d5885af5f3fd3cc4e005e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 30 Oct 2023 12:08:24 +0100 Subject: [PATCH 036/387] Format --- packages/riverpod/lib/src/common.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/riverpod/lib/src/common.dart b/packages/riverpod/lib/src/common.dart index 2dd671d49..1138940ae 100644 --- a/packages/riverpod/lib/src/common.dart +++ b/packages/riverpod/lib/src/common.dart @@ -201,7 +201,7 @@ sealed class AsyncValue { StackTrace? get stackTrace; String get _displayString; - + /// Casts the [AsyncValue] to a different type. AsyncValue _cast(); From 7dfbab1fa5e3143020f1248170461b233fdfa935 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 30 Oct 2023 12:21:24 +0100 Subject: [PATCH 037/387] Re-release `isFamily` getter --- packages/riverpod_analyzer_utils/CHANGELOG.md | 4 ++++ packages/riverpod_analyzer_utils/pubspec.yaml | 2 +- packages/riverpod_generator/CHANGELOG.md | 4 ++++ packages/riverpod_generator/pubspec.yaml | 4 ++-- packages/riverpod_lint/CHANGELOG.md | 4 ++++ packages/riverpod_lint/pubspec.yaml | 4 ++-- 6 files changed, 17 insertions(+), 5 deletions(-) diff --git a/packages/riverpod_analyzer_utils/CHANGELOG.md b/packages/riverpod_analyzer_utils/CHANGELOG.md index cc4acd4e5..92da5c291 100644 --- a/packages/riverpod_analyzer_utils/CHANGELOG.md +++ b/packages/riverpod_analyzer_utils/CHANGELOG.md @@ -1,3 +1,7 @@ +## 1.0.0-dev.0 - 2023-10-30 + +- Added `GeneratorProviderDeclarationElement.isFamily` + ## 0.4.3 - 2023-10-28 - Added `GeneratorProviderDeclarationElement.isFamily` diff --git a/packages/riverpod_analyzer_utils/pubspec.yaml b/packages/riverpod_analyzer_utils/pubspec.yaml index 309a80ff1..4be4969ff 100644 --- a/packages/riverpod_analyzer_utils/pubspec.yaml +++ b/packages/riverpod_analyzer_utils/pubspec.yaml @@ -4,7 +4,7 @@ repository: https://github.com/rrousselGit/river_pod issue_tracker: https://github.com/rrousselGit/riverpod/issues funding: - https://github.com/sponsors/rrousselGit/ -version: 0.4.3 +version: 1.0.0-dev.0 environment: sdk: ">=3.0.0-0.0-dev <4.0.0" diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index a25341843..0291c1b0d 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -1,3 +1,7 @@ +## 3.0.0-dev.8 - 2023-10-30 + +- `riverpod_analyzer_utils` upgraded to `1.0.0-dev.0` + ## 3.0.0-dev.7 - 2023-10-29 - Providers can now be generic: diff --git a/packages/riverpod_generator/pubspec.yaml b/packages/riverpod_generator/pubspec.yaml index dc1b756ac..de43f1da4 100644 --- a/packages/riverpod_generator/pubspec.yaml +++ b/packages/riverpod_generator/pubspec.yaml @@ -1,6 +1,6 @@ name: riverpod_generator description: A code generator for Riverpod. This both simplifies the syntax empowers it, such as allowing stateful hot-reload. -version: 3.0.0-dev.7 +version: 3.0.0-dev.8 repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues funding: @@ -17,7 +17,7 @@ dependencies: crypto: ^3.0.2 meta: ^1.7.0 path: ^1.8.0 - riverpod_analyzer_utils: ^0.4.3 + riverpod_analyzer_utils: ^1.0.0-dev.0 riverpod_annotation: ^3.0.0-dev.0 source_gen: ^1.2.0 diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index 7892cd6c3..ec572aa75 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -1,3 +1,7 @@ +## 3.0.0-dev.1 - 2023-10-30 + +- `riverpod_analyzer_utils` upgraded to `1.0.0-dev.0` + ## 3.0.0-dev.0 - 2023-10-29 - `riverpod` upgraded to `3.0.0-dev.0` diff --git a/packages/riverpod_lint/pubspec.yaml b/packages/riverpod_lint/pubspec.yaml index f13eee9ae..62b9da0c1 100644 --- a/packages/riverpod_lint/pubspec.yaml +++ b/packages/riverpod_lint/pubspec.yaml @@ -1,6 +1,6 @@ name: riverpod_lint description: Riverpod_lint is a developer tool for users of Riverpod, designed to help stop common issues and simplify repetitive tasks. -version: 3.0.0-dev.0 +version: 3.0.0-dev.1 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/river_pod issue_tracker: https://github.com/rrousselGit/riverpod/issues @@ -18,7 +18,7 @@ dependencies: meta: ^1.7.0 path: ^1.8.1 riverpod: ^3.0.0-dev.0 - riverpod_analyzer_utils: ^0.4.3 + riverpod_analyzer_utils: ^1.0.0-dev.0 source_span: ^1.8.0 yaml: ^3.1.1 From e46522fc6b740a2738fd907145f90fb5e8291c3e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 30 Oct 2023 12:23:35 +0100 Subject: [PATCH 038/387] Test --- packages/riverpod_generator/pubspec.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/riverpod_generator/pubspec.yaml b/packages/riverpod_generator/pubspec.yaml index de43f1da4..baaa61a26 100644 --- a/packages/riverpod_generator/pubspec.yaml +++ b/packages/riverpod_generator/pubspec.yaml @@ -26,5 +26,5 @@ dev_dependencies: build_verify: ^3.0.0 freezed: ^2.4.3 freezed_annotation: ^2.4.1 - riverpod: ^2.4.5 + riverpod: ^3.0.0-dev.0 test: ^1.21.0 From 65b60ddbe7c450f7cfdeb8744a2525c63da56c12 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 30 Oct 2023 15:09:37 +0100 Subject: [PATCH 039/387] Remove version --- packages/riverpod_analyzer_utils_tests/pubspec.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/riverpod_analyzer_utils_tests/pubspec.yaml b/packages/riverpod_analyzer_utils_tests/pubspec.yaml index 95fda4dff..4b2cc60e2 100644 --- a/packages/riverpod_analyzer_utils_tests/pubspec.yaml +++ b/packages/riverpod_analyzer_utils_tests/pubspec.yaml @@ -1,7 +1,6 @@ name: riverpod_analyzer_utils_tests description: A sample command-line application. publish_to: none -version: 0.0.1 environment: sdk: ">=3.0.0-0.0-dev <4.0.0" From adc4d70da4e9d59c13b59327303d2837d73cf557 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 13 Nov 2023 14:06:06 +0100 Subject: [PATCH 040/387] Update generated files --- .../cancel/detail_screen/codegen.g.dart | 2 +- .../detail_screen_cancel/codegen.g.dart | 2 +- .../detail_screen_debounce/codegen.g.dart | 2 +- .../provider_with_extension/codegen.g.dart | 2 +- .../passing_args/codegen/provider.g.dart | 59 ++++++++++++++++--- 5 files changed, 54 insertions(+), 13 deletions(-) diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart index 69ee1d982..4d688e552 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart @@ -43,4 +43,4 @@ final activityProvider = AutoDisposeFutureProvider.internal( typedef ActivityRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart index d8ec45ada..67a5099bf 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -23,4 +23,4 @@ final activityProvider = AutoDisposeFutureProvider.internal( typedef ActivityRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart index 6d0d3104b..2f62270bc 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -23,4 +23,4 @@ final activityProvider = AutoDisposeFutureProvider.internal( typedef ActivityRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart index b3407fc98..7c8195c7b 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -23,4 +23,4 @@ final activityProvider = AutoDisposeFutureProvider.internal( typedef ActivityRef = AutoDisposeFutureProviderRef; // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/passing_args/codegen/provider.g.dart b/website/docs/essentials/passing_args/codegen/provider.g.dart index 3225b55ea..7b8a4fd90 100644 --- a/website/docs/essentials/passing_args/codegen/provider.g.dart +++ b/website/docs/essentials/passing_args/codegen/provider.g.dart @@ -59,10 +59,24 @@ abstract class _$ActivityNotifier2 const activityNotifier2Provider = ActivityNotifier2Family(); /// See also [ActivityNotifier2]. -class ActivityNotifier2Family extends Family> { +class ActivityNotifier2Family extends Family { /// See also [ActivityNotifier2]. const ActivityNotifier2Family(); + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'activityNotifier2Provider'; + /// See also [ActivityNotifier2]. ActivityNotifier2Provider call( String activityType, @@ -72,6 +86,7 @@ class ActivityNotifier2Family extends Family> { ); } + @visibleForOverriding @override ActivityNotifier2Provider getProviderOverride( covariant ActivityNotifier2Provider provider, @@ -81,19 +96,26 @@ class ActivityNotifier2Family extends Family> { ); } - static const Iterable? _dependencies = null; + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(ActivityNotifier2 Function() create) { + return _$ActivityNotifier2FamilyOverride(this, create); + } +} - @override - Iterable? get dependencies => _dependencies; +class _$ActivityNotifier2FamilyOverride implements FamilyOverride { + _$ActivityNotifier2FamilyOverride(this.overriddenFamily, this.create); - static const Iterable? _allTransitiveDependencies = null; + final ActivityNotifier2 Function() create; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final ActivityNotifier2Family overriddenFamily; @override - String? get name => r'activityNotifier2Provider'; + ActivityNotifier2Provider getProviderOverride( + covariant ActivityNotifier2Provider provider, + ) { + return provider._copyWith(create); + } } /// See also [ActivityNotifier2]. @@ -117,7 +139,7 @@ class ActivityNotifier2Provider ); ActivityNotifier2Provider._internal( - super._createNotifier, { + super.create, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -153,12 +175,31 @@ class ActivityNotifier2Provider ); } + @override + (String,) get argument { + return (activityType,); + } + @override AutoDisposeAsyncNotifierProviderElement createElement() { return _ActivityNotifier2ProviderElement(this); } + ActivityNotifier2Provider _copyWith( + ActivityNotifier2 Function() create, + ) { + return ActivityNotifier2Provider._internal( + () => create()..activityType = activityType, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + activityType: activityType, + ); + } + @override bool operator ==(Object other) { return other is ActivityNotifier2Provider && From 7d5e52a1ba5fc97f17152dea3defd80848398ff1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 13 Nov 2023 14:18:02 +0100 Subject: [PATCH 041/387] Typos --- packages/flutter_riverpod/CHANGELOG.md | 8 +++++--- packages/hooks_riverpod/CHANGELOG.md | 4 +++- packages/riverpod/CHANGELOG.md | 8 +++++--- packages/riverpod_generator/CHANGELOG.md | 4 +++- packages/riverpod_lint/CHANGELOG.md | 6 ++++-- 5 files changed, 20 insertions(+), 10 deletions(-) diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md index f60cf7551..13461aeaa 100644 --- a/packages/flutter_riverpod/CHANGELOG.md +++ b/packages/flutter_riverpod/CHANGELOG.md @@ -307,7 +307,7 @@ Riverpod is now stable! - **Breaking** The return value when reading a `StateProvider` changed. Before, doing `ref.read(someStateProvider)` would return the `StateController` instance. Now, this will only return the state of the `StateController`. - This new behaviour matches `StateNotifierProvider`. + This new behavior matches `StateNotifierProvider`. For a simple migration, the old behavior is available by writing `ref.read(someStateProvider.state)`. @@ -635,7 +635,7 @@ Fix an issue where `*Provider.autoDispose` were not able to specify the ### Bug-fixes - fixed a bug where providers were rebuilding even when not listened to -- fixed `ref.listen` now working when downcasting the value of a provider. +- fixed `ref.listen` now working when downcasing the value of a provider. - fixed a bug where disposing a scoped `ProviderContainer` could cause other `ProviderContainer`s to stop working. - fixed an issue where conditionally depending on an "autoDispose" provider @@ -821,7 +821,7 @@ Removed an assert that could cause issues when an application is partially migra ## 0.14.0+1 -- Re-added `StateProvider.overrideWithValue`/`StateProvider.overrideWithProvider` that were unvoluntarily removed. +- Re-added `StateProvider.overrideWithValue`/`StateProvider.overrideWithProvider` that were involuntarily removed. ## 0.14.0 @@ -1240,3 +1240,5 @@ The behavior is the same. Only the syntax changed. ## 0.1.0 Initial release + + diff --git a/packages/hooks_riverpod/CHANGELOG.md b/packages/hooks_riverpod/CHANGELOG.md index 12e2dc218..56452cb67 100644 --- a/packages/hooks_riverpod/CHANGELOG.md +++ b/packages/hooks_riverpod/CHANGELOG.md @@ -786,7 +786,7 @@ Fix an issue where `*Provider.autoDispose` were not able to specify the ### Bug-fixes - fixed a bug where providers were rebuilding even when not listened to -- fixed `ref.listen` now working when downcasting the value of a provider. +- fixed `ref.listen` now working when downcasing the value of a provider. - fixed a bug where disposing a scoped `ProviderContainer` could cause other `ProviderContainer`s to stop working. - fixed an issue where conditionally depending on an "autoDispose" provider @@ -1435,3 +1435,5 @@ The behavior is the same. Only the syntax changed. ## 0.1.0 Initial release + + diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 830f2cce2..a6e71f525 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -399,7 +399,7 @@ Riverpod is now stable! - **Breaking** The return value when reading a `StateProvider` changed. Before, doing `ref.read(someStateProvider)` would return the `StateController` instance. Now, this will only return the state of the `StateController`. - This new behaviour matches `StateNotifierProvider`. + This new behavior matches `StateNotifierProvider`. For a simple migration, the old behavior is available by writing `ref.read(someStateProvider.state)`. @@ -677,7 +677,7 @@ Fix an issue where `*Provider.autoDispose` were not able to specify the ### Bug-fixes - fixed a bug where providers were rebuilding even when not being listened to -- fixed `ref.listen` now working when downcasting the value of a provider. +- fixed `ref.listen` now working when downcasing the value of a provider. - fixed a bug where disposing a scoped `ProviderContainer` could cause other `ProviderContainer`s to stop working. - fixed an issue where conditionally depending on an "autoDispose" provider @@ -816,7 +816,7 @@ Removed an assert that could cause issues when an application is partially migra ## 0.14.0+1 -- Re-added `StateProvider.overrideWithValue`/`StateProvider.overrideWithProvider` that were unvoluntarily removed. +- Re-added `StateProvider.overrideWithValue`/`StateProvider.overrideWithProvider` that were involuntarily removed. ## 0.14.0 @@ -1153,3 +1153,5 @@ The behavior is the same. Only the syntax changed. ## 0.1.0 Initial release + + diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 0291c1b0d..80743c3a7 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -194,7 +194,7 @@ Upgrade Riverpod to latest ## 1.1.0 -- The generated hash function of providers is now correctluy private (thanks to @westito) +- The generated hash function of providers is now correctly private (thanks to @westito) - Allow customizing the name of the generated providers (thanks to @trejdych) - Update dependencies. @@ -225,3 +225,5 @@ Fix version conflict with Riverpod ## 1.0.0 Initial release + + diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index 9a6d39709..686aad4e6 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -9,7 +9,7 @@ ## 2.3.4 - 2023-11-13 -- Updated `scoped_providers_should_specify_dependencies` to ignore instances of using pumpWidget in tests (thanks to [lockieRichter](https://github.com/lockieRichter)) +- Updated `scoped_providers_should_specify_dependencies` to ignore instances of using pumpWidget in tests (thanks to @lockieRichter) ## 2.3.3 - 2023-10-28 @@ -26,7 +26,7 @@ ## 2.3.0 - 2023-10-06 -- Added `async_value_nullable_patttern` lint, to warn against using `AsyncValue(:final value?)` in pattern match when `value` is possibly nullable. +- Added `async_value_nullable_pattern` lint, to warn against using `AsyncValue(:final value?)` in pattern match when `value` is possibly nullable. - Added `protected_notifier_state` lint, which warns against using the `Notifier.state` property of a notifier different than the current one. Aka a Notifier "A" should not directly access the `state` if a Notifier "B". @@ -185,3 +185,5 @@ Fix quick-fix for provider_dependencies ## 1.0.0 Initial release + + From a581082904b11f5773d97977e81f524f77836d4b Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 13 Nov 2023 15:47:43 +0100 Subject: [PATCH 042/387] Have notifier properties throw if used after dispose (#3113) fixes #2420 --- packages/riverpod/CHANGELOG.md | 7 +- packages/riverpod/lib/src/async_notifier.dart | 25 ++-- .../lib/src/async_notifier/auto_dispose.dart | 19 ++- .../async_notifier/auto_dispose_family.dart | 6 +- .../riverpod/lib/src/async_notifier/base.dart | 51 ++++--- .../lib/src/async_notifier/family.dart | 6 +- packages/riverpod/lib/src/notifier.dart | 45 ++++++- .../lib/src/notifier/auto_dispose.dart | 17 ++- .../lib/src/notifier/auto_dispose_family.dart | 6 +- packages/riverpod/lib/src/notifier/base.dart | 22 +++- .../riverpod/lib/src/notifier/family.dart | 6 +- .../lib/src/stream_notifier/auto_dispose.dart | 18 ++- .../stream_notifier/auto_dispose_family.dart | 6 +- .../lib/src/stream_notifier/base.dart | 17 ++- .../lib/src/stream_notifier/family.dart | 6 +- .../async_notifier/async_notifier_test.dart | 124 ++++++++++++++++-- .../providers/notifier/notifier_test.dart | 109 ++++++++++++++- .../stream_notifier/async_notifier_test.dart | 124 ++++++++++++++++-- 18 files changed, 522 insertions(+), 92 deletions(-) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index a6e71f525..6ead85749 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -1,4 +1,9 @@ -## WIP +## Unreleased build + +- All notifier properties now throw an error if used after the notifier + has been disposed. +- The error thrown when a notifier property is used inside the constructor + of a notifier has been improved. ## 3.0.0-dev.0 - 2023-10-29 diff --git a/packages/riverpod/lib/src/async_notifier.dart b/packages/riverpod/lib/src/async_notifier.dart index 7de3d033d..6a4e62e45 100644 --- a/packages/riverpod/lib/src/async_notifier.dart +++ b/packages/riverpod/lib/src/async_notifier.dart @@ -28,10 +28,10 @@ part 'stream_notifier/family.dart'; /// Not meant for public consumption. @internal abstract class AsyncNotifierBase { - AsyncNotifierProviderElementBase, State> + AsyncNotifierProviderElementBase, State>? get _element; - void _setElement(ProviderElementBase> element); + void _setElement(ProviderElementBase>? element); /// The value currently exposed by this [AsyncNotifier]. /// @@ -46,15 +46,21 @@ abstract class AsyncNotifierBase { @visibleForTesting @protected AsyncValue get state { - _element.flush(); + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + element.flush(); // ignore: invalid_use_of_protected_member - return _element.requireState; + return element.requireState; } @visibleForTesting @protected set state(AsyncValue newState) { - _element.state = newState; + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + element.state = newState; } /// The [Ref] from the provider associated with this [AsyncNotifier]. @@ -75,8 +81,11 @@ abstract class AsyncNotifierBase { @visibleForTesting @protected Future get future { - _element.flush(); - return _element.futureNotifier.value; + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + element.flush(); + return element.futureNotifier.value; } /// A function to update [state] from its previous value, while @@ -96,7 +105,7 @@ abstract class AsyncNotifierBase { @visibleForTesting @protected Future update( - FutureOr Function(State) cb, { + FutureOr Function(State previousState) cb, { FutureOr Function(Object err, StackTrace stackTrace)? onError, }) async { // TODO cancel on rebuild? diff --git a/packages/riverpod/lib/src/async_notifier/auto_dispose.dart b/packages/riverpod/lib/src/async_notifier/auto_dispose.dart index 6c9d6eb8d..b916a3c99 100644 --- a/packages/riverpod/lib/src/async_notifier/auto_dispose.dart +++ b/packages/riverpod/lib/src/async_notifier/auto_dispose.dart @@ -7,17 +7,26 @@ part of '../async_notifier.dart'; abstract class BuildlessAutoDisposeAsyncNotifier extends AsyncNotifierBase { @override - late final AutoDisposeAsyncNotifierProviderElement, - State> _element; + AutoDisposeAsyncNotifierProviderElement, State>? + _element; @override - void _setElement(ProviderElementBase> element) { + void _setElement(ProviderElementBase>? element) { + if (_element != null && element != null) { + throw StateError(alreadyInitializedError); + } + _element = element as AutoDisposeAsyncNotifierProviderElement< - AsyncNotifierBase, State>; + AsyncNotifierBase, State>?; } @override - AutoDisposeAsyncNotifierProviderRef get ref => _element; + AutoDisposeAsyncNotifierProviderRef get ref { + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + return element; + } } /// {@macro riverpod.async_notifier_provider} diff --git a/packages/riverpod/lib/src/async_notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/async_notifier/auto_dispose_family.dart index fc234abfa..f71db5519 100644 --- a/packages/riverpod/lib/src/async_notifier/auto_dispose_family.dart +++ b/packages/riverpod/lib/src/async_notifier/auto_dispose_family.dart @@ -9,9 +9,11 @@ abstract class AutoDisposeFamilyAsyncNotifier late final Arg arg; @override - void _setElement(ProviderElementBase> element) { + void _setElement(ProviderElementBase>? element) { super._setElement(element); - arg = element.origin.argument as Arg; + if (element != null) { + arg = element.origin.argument as Arg; + } } /// {@macro riverpod.async_notifier.build} diff --git a/packages/riverpod/lib/src/async_notifier/base.dart b/packages/riverpod/lib/src/async_notifier/base.dart index d9f8db5f4..7003bd0f2 100644 --- a/packages/riverpod/lib/src/async_notifier/base.dart +++ b/packages/riverpod/lib/src/async_notifier/base.dart @@ -6,17 +6,24 @@ part of '../async_notifier.dart'; @internal abstract class BuildlessAsyncNotifier extends AsyncNotifierBase { @override - late final AsyncNotifierProviderElement, State> - _element; + AsyncNotifierProviderElement, State>? _element; @override - void _setElement(ProviderElementBase> element) { + void _setElement(ProviderElementBase>? element) { + if (_element != null && element != null) { + throw StateError(alreadyInitializedError); + } _element = element - as AsyncNotifierProviderElement, State>; + as AsyncNotifierProviderElement, State>?; } @override - AsyncNotifierProviderRef get ref => _element; + AsyncNotifierProviderRef get ref { + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + return element; + } } /// {@template riverpod.async_notifier} @@ -231,18 +238,16 @@ mixin FutureHandlerProviderElementMixin /// has yet to complete. @internal void onError(AsyncError value, {bool seamless = false}) { - if (mounted) { - asyncTransition(value, seamless: seamless); + asyncTransition(value, seamless: seamless); - for (final observer in container.observers) { - runQuaternaryGuarded( - observer.providerDidFail, - provider, - value.error, - value.stackTrace, - container, - ); - } + for (final observer in container.observers) { + runQuaternaryGuarded( + observer.providerDidFail, + provider, + value.error, + value.stackTrace, + container, + ); } final completer = _futureCompleter; @@ -256,7 +261,7 @@ mixin FutureHandlerProviderElementMixin ); _futureCompleter = null; // TODO SynchronousFuture.error - } else if (mounted) { + } else { futureNotifier.result = Result.data( // TODO test ignore Future.error( @@ -273,15 +278,13 @@ mixin FutureHandlerProviderElementMixin /// has yet to complete. @internal void onData(AsyncData value, {bool seamless = false}) { - if (mounted) { - asyncTransition(value, seamless: seamless); - } + asyncTransition(value, seamless: seamless); final completer = _futureCompleter; if (completer != null) { completer.complete(value.value); _futureCompleter = null; - } else if (mounted) { + } else { futureNotifier.result = Result.data(Future.value(value.value)); } } @@ -508,6 +511,12 @@ abstract class AsyncNotifierProviderElementBase< ?.updateShouldNotify(previous, next) ?? true; } + + @override + void dispose() { + super.dispose(); + _notifierNotifier.result?.stateOrNull?._setElement(null); + } } /// The element of [AsyncNotifierProvider]. diff --git a/packages/riverpod/lib/src/async_notifier/family.dart b/packages/riverpod/lib/src/async_notifier/family.dart index 52e31e92d..2d34b121e 100644 --- a/packages/riverpod/lib/src/async_notifier/family.dart +++ b/packages/riverpod/lib/src/async_notifier/family.dart @@ -19,9 +19,11 @@ abstract class FamilyAsyncNotifier late final Arg arg; @override - void _setElement(ProviderElementBase> element) { + void _setElement(ProviderElementBase>? element) { super._setElement(element); - arg = element.origin.argument as Arg; + if (element != null) { + arg = element.origin.argument as Arg; + } } /// {@macro riverpod.async_notifier.build} diff --git a/packages/riverpod/lib/src/notifier.dart b/packages/riverpod/lib/src/notifier.dart index 470ad0414..b7a8480dd 100644 --- a/packages/riverpod/lib/src/notifier.dart +++ b/packages/riverpod/lib/src/notifier.dart @@ -12,14 +12,36 @@ part 'notifier/auto_dispose_family.dart'; part 'notifier/base.dart'; part 'notifier/family.dart'; +/// An error thrown if a Notifier is associated multiple times with a provider. +@internal +const alreadyInitializedError = ''' +A NotifierProvider returned a Notifier instance that is already associated +with another provider. + +To fix, do not reuse the same Notifier instance multiple times. +NotifierProviders are expected to always create a new Notifier instance. +'''; + +/// The error message for when a notifier is used when uninitialized. +@internal +const uninitializedElementError = ''' +Tried to use a notifier in an uninitialized state. +This means that you tried to either: +- Use ref/state inside the constructor of a notifier. + In this case you should move your logic inside the "build" method instead. +- Use ref/state after the notifier was disposed. + In this case, consider using `ref.onDispose` earlier in your notifier's lifecycle + to abort any pending logic that could try to use `ref/state`. +'''; + /// A base class for [NotifierBase]. /// /// Not meant for public consumption. @internal abstract class NotifierBase { - NotifierProviderElement, State> get _element; + NotifierProviderElement, State>? get _element; - void _setElement(ProviderElementBase element); + void _setElement(ProviderElementBase? element); /// The value currently exposed by this [Notifier]. /// @@ -35,8 +57,11 @@ abstract class NotifierBase { @protected @visibleForTesting State get state { - _element.flush(); - return _element.requireState; + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + element.flush(); + return element.requireState; } /// The value currently exposed by this [Notifier]. @@ -52,15 +77,21 @@ abstract class NotifierBase { @protected @visibleForTesting State? get stateOrNull { - _element.flush(); - return _element.getState()?.stateOrNull; + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + element.flush(); + return element.getState()?.stateOrNull; } @protected @visibleForTesting set state(State value) { + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + // ignore: invalid_use_of_protected_member - _element.setState(value); + element.setState(value); } /// The [Ref] from the provider associated with this [Notifier]. diff --git a/packages/riverpod/lib/src/notifier/auto_dispose.dart b/packages/riverpod/lib/src/notifier/auto_dispose.dart index 874d44641..8cd60d53c 100644 --- a/packages/riverpod/lib/src/notifier/auto_dispose.dart +++ b/packages/riverpod/lib/src/notifier/auto_dispose.dart @@ -6,17 +6,24 @@ part of '../notifier.dart'; @internal abstract class BuildlessAutoDisposeNotifier extends NotifierBase { @override - late final AutoDisposeNotifierProviderElement, State> - _element; + AutoDisposeNotifierProviderElement, State>? _element; @override - void _setElement(ProviderElementBase element) { + void _setElement(ProviderElementBase? element) { + if (_element != null && element != null) { + throw StateError(alreadyInitializedError); + } _element = element - as AutoDisposeNotifierProviderElement, State>; + as AutoDisposeNotifierProviderElement, State>?; } @override - AutoDisposeNotifierProviderRef get ref => _element; + AutoDisposeNotifierProviderRef get ref { + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + return element; + } } /// {@macro riverpod.notifier} diff --git a/packages/riverpod/lib/src/notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/notifier/auto_dispose_family.dart index 52d01bfed..dd87d379f 100644 --- a/packages/riverpod/lib/src/notifier/auto_dispose_family.dart +++ b/packages/riverpod/lib/src/notifier/auto_dispose_family.dart @@ -9,9 +9,11 @@ abstract class AutoDisposeFamilyNotifier late final Arg arg; @override - void _setElement(ProviderElementBase element) { + void _setElement(ProviderElementBase? element) { super._setElement(element); - arg = element.origin.argument as Arg; + if (element != null) { + arg = element.origin.argument as Arg; + } } /// {@macro riverpod.async_notifier.build} diff --git a/packages/riverpod/lib/src/notifier/base.dart b/packages/riverpod/lib/src/notifier/base.dart index 3ab1fc3b0..733d95bf8 100644 --- a/packages/riverpod/lib/src/notifier/base.dart +++ b/packages/riverpod/lib/src/notifier/base.dart @@ -6,15 +6,23 @@ part of '../notifier.dart'; @internal abstract class BuildlessNotifier extends NotifierBase { @override - late final NotifierProviderElement, State> _element; + NotifierProviderElement, State>? _element; @override - void _setElement(ProviderElementBase element) { - _element = element as NotifierProviderElement, State>; + void _setElement(ProviderElementBase? element) { + if (_element != null && element != null) { + throw StateError(alreadyInitializedError); + } + _element = element as NotifierProviderElement, State>?; } @override - NotifierProviderRef get ref => _element; + NotifierProviderRef get ref { + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + return element; + } } /// {@template riverpod.notifier} @@ -222,4 +230,10 @@ class NotifierProviderElement, T> ?.updateShouldNotify(previous, next) ?? true; } + + @override + void dispose() { + super.dispose(); + _notifierNotifier.result?.stateOrNull?._setElement(null); + } } diff --git a/packages/riverpod/lib/src/notifier/family.dart b/packages/riverpod/lib/src/notifier/family.dart index d76b80b20..7e508f603 100644 --- a/packages/riverpod/lib/src/notifier/family.dart +++ b/packages/riverpod/lib/src/notifier/family.dart @@ -8,9 +8,11 @@ abstract class FamilyNotifier extends BuildlessNotifier { late final Arg arg; @override - void _setElement(ProviderElementBase element) { + void _setElement(ProviderElementBase? element) { super._setElement(element); - arg = element.origin.argument as Arg; + if (element != null) { + arg = element.origin.argument as Arg; + } } /// {@macro riverpod.async_notifier.build} diff --git a/packages/riverpod/lib/src/stream_notifier/auto_dispose.dart b/packages/riverpod/lib/src/stream_notifier/auto_dispose.dart index 2559b7edf..f5989a835 100644 --- a/packages/riverpod/lib/src/stream_notifier/auto_dispose.dart +++ b/packages/riverpod/lib/src/stream_notifier/auto_dispose.dart @@ -7,17 +7,25 @@ part of '../async_notifier.dart'; abstract class BuildlessAutoDisposeStreamNotifier extends AsyncNotifierBase { @override - late final AutoDisposeStreamNotifierProviderElement, - State> _element; + AutoDisposeStreamNotifierProviderElement, State>? + _element; @override - void _setElement(ProviderElementBase> element) { + void _setElement(ProviderElementBase>? element) { + if (_element != null && element != null) { + throw StateError(alreadyInitializedError); + } _element = element as AutoDisposeStreamNotifierProviderElement< - AsyncNotifierBase, State>; + AsyncNotifierBase, State>?; } @override - AutoDisposeStreamNotifierProviderRef get ref => _element; + AutoDisposeStreamNotifierProviderRef get ref { + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + return element; + } } /// {@macro riverpod.streamNotifier} diff --git a/packages/riverpod/lib/src/stream_notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/stream_notifier/auto_dispose_family.dart index c4ee6de64..55ca950d4 100644 --- a/packages/riverpod/lib/src/stream_notifier/auto_dispose_family.dart +++ b/packages/riverpod/lib/src/stream_notifier/auto_dispose_family.dart @@ -7,9 +7,11 @@ abstract class AutoDisposeFamilyStreamNotifier late final Arg arg; @override - void _setElement(ProviderElementBase> element) { + void _setElement(ProviderElementBase>? element) { super._setElement(element); - arg = element.origin.argument as Arg; + if (element != null) { + arg = element.origin.argument as Arg; + } } /// {@macro riverpod.StreamNotifier.build} diff --git a/packages/riverpod/lib/src/stream_notifier/base.dart b/packages/riverpod/lib/src/stream_notifier/base.dart index 1b6e77f87..3f2c7a188 100644 --- a/packages/riverpod/lib/src/stream_notifier/base.dart +++ b/packages/riverpod/lib/src/stream_notifier/base.dart @@ -6,17 +6,24 @@ part of '../async_notifier.dart'; @internal abstract class BuildlessStreamNotifier extends AsyncNotifierBase { @override - late final StreamNotifierProviderElement, State> - _element; + StreamNotifierProviderElement, State>? _element; @override - void _setElement(ProviderElementBase> element) { + void _setElement(ProviderElementBase>? element) { + if (_element != null && element != null) { + throw StateError(alreadyInitializedError); + } _element = element - as StreamNotifierProviderElement, State>; + as StreamNotifierProviderElement, State>?; } @override - StreamNotifierProviderRef get ref => _element; + StreamNotifierProviderRef get ref { + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + return element; + } } /// {@template riverpod.streamNotifier} diff --git a/packages/riverpod/lib/src/stream_notifier/family.dart b/packages/riverpod/lib/src/stream_notifier/family.dart index 979d4bce4..5846f579c 100644 --- a/packages/riverpod/lib/src/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/stream_notifier/family.dart @@ -17,9 +17,11 @@ abstract class FamilyStreamNotifier late final Arg arg; @override - void _setElement(ProviderElementBase> element) { + void _setElement(ProviderElementBase>? element) { super._setElement(element); - arg = element.origin.argument as Arg; + if (element != null) { + arg = element.origin.argument as Arg; + } } /// {@macro riverpod.StreamNotifier.build} diff --git a/packages/riverpod/test/providers/async_notifier/async_notifier_test.dart b/packages/riverpod/test/providers/async_notifier/async_notifier_test.dart index c32b7b3ab..c1689759b 100644 --- a/packages/riverpod/test/providers/async_notifier/async_notifier_test.dart +++ b/packages/riverpod/test/providers/async_notifier/async_notifier_test.dart @@ -11,8 +11,79 @@ import '../../utils.dart'; import 'factory.dart'; void main() { + test('Throws if using notifier properties in its constructor', () { + expect( + CtorNotifier.new, + throwsA(isA()), + ); + expect( + AutoDisposeCtorNotifier.new, + throwsA(isA()), + ); + expect( + AutoDisposeFamilyCtorNotifier.new, + throwsA(isA()), + ); + expect( + FamilyCtorNotifier.new, + throwsA(isA()), + ); + }); + for (final factory in matrix()) { group(factory.label, () { + test('Cannot share a Notifier instance between providers ', () { + final container = createContainer(); + final notifier = factory.notifier((ref) => 0); + + final provider = factory.provider, int>( + () => notifier, + ); + final provider2 = factory.provider, int>( + () => notifier, + ); + + container.read(provider); + + expect( + container.read(provider2), + isA>(), + ); + }); + + test('Can read state inside onDispose', () { + final container = createContainer(); + late AsyncTestNotifierBase notifier; + final provider = factory.simpleTestProvider((ref) { + ref.onDispose(() { + notifier.state; + }); + return 0; + }); + + container.listen(provider.notifier, (prev, next) {}); + notifier = container.read(provider.notifier); + + container.dispose(); + }); + + test('Using the notifier after dispose throws', () { + final container = createContainer(); + final provider = factory.simpleTestProvider((ref) => 0); + + container.listen(provider.notifier, (prev, next) {}); + final notifier = container.read(provider.notifier); + + container.dispose(); + + expect(() => notifier.state, throwsStateError); + expect(() => notifier.future, throwsStateError); + expect(() => notifier.state = const AsyncData(42), throwsStateError); + // ignore: invalid_use_of_protected_member + expect(() => notifier.ref, throwsStateError); + expect(() => notifier.update((p1) => 42), throwsStateError); + }); + test('Can assign `AsyncLoading` to `AsyncValue`', () { // Regression test for https://github.com/rrousselGit/riverpod/issues/2120 final provider = factory.simpleTestProvider((ref) => 42); @@ -457,11 +528,11 @@ void main() { final sub = container.listen(provider.notifier, (previous, next) {}); - // ignore: prefer_const_constructors, not using `const` as we voluntarility break identity to test `identical` + // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` final newState = AsyncData(84); - // ignore: prefer_const_constructors, not using `const` as we voluntarility break identity to test `identical` + // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` final newLoading = AsyncLoading(); - // ignore: prefer_const_constructors, not using `const` as we voluntarility break identity to test `identical` + // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` final newError = AsyncError(84, StackTrace.empty); sub.read().state = newState; @@ -703,7 +774,7 @@ void main() { await expectLater(sub.read().future, completion(1)); }); - test('retuns a Future identical to that of .future', () { + test('returns a Future identical to that of .future', () { final listener = OnBuildMock(); final dep = StateProvider((ref) => 0); final provider = factory.simpleTestProvider( @@ -805,7 +876,7 @@ void main() { ); }); - group('AsyncNotifer.update', () { + group('AsyncNotifier.update', () { test('passes in the latest state', () async { final container = createContainer(); final provider = factory.simpleTestProvider( @@ -869,8 +940,7 @@ void main() { expect(container.read(provider), const AsyncData(21)); }); - test( - 'executes immediately with current state if a state is avalailable', + test('executes immediately with current state if a state is available', () async { final container = createContainer(); final provider = factory.simpleTestProvider((ref) => 1); @@ -886,8 +956,7 @@ void main() { expect(container.read(provider), const AsyncData(2)); }); - test( - 'executes immediately with current state if an error is avalailable', + test('executes immediately with current state if an error is available', () async { final container = createContainer(); final provider = factory.simpleTestProvider( @@ -1182,3 +1251,40 @@ class Equal { @override int get hashCode => Object.hash(runtimeType, value); } + +class CtorNotifier extends AsyncNotifier { + CtorNotifier() { + state; + } + + @override + FutureOr build() => 0; +} + +class AutoDisposeCtorNotifier extends AutoDisposeAsyncNotifier { + AutoDisposeCtorNotifier() { + state; + } + + @override + FutureOr build() => 0; +} + +class AutoDisposeFamilyCtorNotifier + extends AutoDisposeFamilyAsyncNotifier { + AutoDisposeFamilyCtorNotifier() { + state; + } + + @override + FutureOr build(int arg) => 0; +} + +class FamilyCtorNotifier extends FamilyAsyncNotifier { + FamilyCtorNotifier() { + state; + } + + @override + FutureOr build(int arg) => 0; +} diff --git a/packages/riverpod/test/providers/notifier/notifier_test.dart b/packages/riverpod/test/providers/notifier/notifier_test.dart index 8512c63ed..20f35c6ac 100644 --- a/packages/riverpod/test/providers/notifier/notifier_test.dart +++ b/packages/riverpod/test/providers/notifier/notifier_test.dart @@ -9,8 +9,78 @@ import '../../utils.dart'; import 'factory.dart'; void main() { + test('Throws if using notifier properties in its constructor', () { + expect( + CtorNotifier.new, + throwsA(isA()), + ); + expect( + AutoDisposeCtorNotifier.new, + throwsA(isA()), + ); + expect( + AutoDisposeFamilyCtorNotifier.new, + throwsA(isA()), + ); + expect( + FamilyCtorNotifier.new, + throwsA(isA()), + ); + }); + for (final factory in matrix()) { group(factory.label, () { + test('Cannot share a Notifier instance between providers ', () { + final container = createContainer(); + final notifier = factory.notifier((ref) => 0); + + final provider = factory.provider, int>( + () => notifier, + ); + final provider2 = factory.provider, int>( + () => notifier, + ); + + container.read(provider); + + expect( + () => container.read(provider2), + throwsA(isA()), + ); + }); + + test('Can read state inside onDispose', () { + final container = createContainer(); + late TestNotifierBase notifier; + final provider = factory.simpleTestProvider((ref) { + ref.onDispose(() { + notifier.state; + }); + return 0; + }); + + container.listen(provider.notifier, (prev, next) {}); + notifier = container.read(provider.notifier); + + container.dispose(); + }); + + test('Using the notifier after dispose throws', () { + final container = createContainer(); + final provider = factory.simpleTestProvider((ref) => 0); + + container.listen(provider.notifier, (prev, next) {}); + final notifier = container.read(provider.notifier); + + container.dispose(); + + expect(() => notifier.state, throwsStateError); + expect(() => notifier.stateOrNull, throwsStateError); + expect(() => notifier.state = 42, throwsStateError); + // ignore: invalid_use_of_protected_member + expect(() => notifier.ref, throwsStateError); + }); + test( 'throws if the same Notifier instance is reused in different providers', () { @@ -294,7 +364,7 @@ void main() { }); test( - 'Reading the state inside the notifier rethrows initilization error, if any', + 'Reading the state inside the notifier rethrows initialization error, if any', () { final provider = factory .simpleTestProvider((ref) => throw UnimplementedError()); @@ -687,3 +757,40 @@ class Equal { @override int get hashCode => Object.hash(runtimeType, value); } + +class CtorNotifier extends Notifier { + CtorNotifier() { + state; + } + + @override + int build() => 0; +} + +class AutoDisposeCtorNotifier extends AutoDisposeNotifier { + AutoDisposeCtorNotifier() { + state; + } + + @override + int build() => 0; +} + +class AutoDisposeFamilyCtorNotifier + extends AutoDisposeFamilyNotifier { + AutoDisposeFamilyCtorNotifier() { + state; + } + + @override + int build(int arg) => 0; +} + +class FamilyCtorNotifier extends FamilyNotifier { + FamilyCtorNotifier() { + state; + } + + @override + int build(int arg) => 0; +} diff --git a/packages/riverpod/test/providers/stream_notifier/async_notifier_test.dart b/packages/riverpod/test/providers/stream_notifier/async_notifier_test.dart index 8e8660ef3..d72fa124a 100644 --- a/packages/riverpod/test/providers/stream_notifier/async_notifier_test.dart +++ b/packages/riverpod/test/providers/stream_notifier/async_notifier_test.dart @@ -11,8 +11,79 @@ import '../../utils.dart'; import 'factory.dart'; void main() { + test('Throws if using notifier properties in its constructor', () { + expect( + CtorNotifier.new, + throwsA(isA()), + ); + expect( + AutoDisposeCtorNotifier.new, + throwsA(isA()), + ); + expect( + AutoDisposeFamilyCtorNotifier.new, + throwsA(isA()), + ); + expect( + FamilyCtorNotifier.new, + throwsA(isA()), + ); + }); + for (final factory in matrix()) { group(factory.label, () { + test('Cannot share a Notifier instance between providers ', () { + final container = createContainer(); + final notifier = factory.notifier((ref) => Stream.value(0)); + + final provider = factory.provider, int>( + () => notifier, + ); + final provider2 = factory.provider, int>( + () => notifier, + ); + + container.read(provider); + + expect( + container.read(provider2), + isA>(), + ); + }); + + test('Can read state inside onDispose', () { + final container = createContainer(); + late StreamTestNotifierBase notifier; + final provider = factory.simpleTestProvider((ref) { + ref.onDispose(() { + notifier.state; + }); + return Stream.value(0); + }); + + container.listen(provider.notifier, (prev, next) {}); + notifier = container.read(provider.notifier); + + container.dispose(); + }); + + test('Using the notifier after dispose throws', () { + final container = createContainer(); + final provider = factory.simpleTestProvider((ref) => Stream.value(0)); + + container.listen(provider.notifier, (prev, next) {}); + final notifier = container.read(provider.notifier); + + container.dispose(); + + expect(() => notifier.state, throwsStateError); + expect(() => notifier.future, throwsStateError); + expect(() => notifier.state = const AsyncData(42), throwsStateError); + // ignore: invalid_use_of_protected_member + expect(() => notifier.ref, throwsStateError); + expect(() => notifier.update((p1) => 42), throwsStateError); + }); + group('supports AsyncValue transition', () { test( 'performs seamless copyWithPrevious if triggered by ref.invalidate/ref.refresh', @@ -358,11 +429,11 @@ void main() { final sub = container.listen(provider.notifier, (previous, next) {}); await container.read(provider.future); - // ignore: prefer_const_constructors, not using `const` as we voluntarility break identity to test `identical` + // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` final newState = AsyncData(84); - // ignore: prefer_const_constructors, not using `const` as we voluntarility break identity to test `identical` + // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` final newLoading = AsyncLoading(); - // ignore: prefer_const_constructors, not using `const` as we voluntarility break identity to test `identical` + // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` final newError = AsyncError(84, StackTrace.empty); sub.read().state = newState; @@ -609,7 +680,7 @@ void main() { await expectLater(sub.read().future, completion(1)); }); - test('retuns a Future identical to that of .future', () { + test('returns a Future identical to that of .future', () { final listener = OnBuildMock(); final dep = StateProvider((ref) => 0); final provider = factory.simpleTestProvider( @@ -720,7 +791,7 @@ void main() { ); }); - group('AsyncNotifer.update', () { + group('AsyncNotifier.update', () { test('passes in the latest state', () async { final container = createContainer(); final provider = factory.simpleTestProvider( @@ -787,8 +858,7 @@ void main() { expect(container.read(provider), const AsyncData(21)); }); - test( - 'executes immediately with current state if a state is avalailable', + test('executes immediately with current state if a state is available', () async { final container = createContainer(); final provider = factory.simpleTestProvider( @@ -809,8 +879,7 @@ void main() { expect(container.read(provider), const AsyncData(2)); }); - test( - 'executes immediately with current state if an error is avalailable', + test('executes immediately with current state if an error is available', () async { final container = createContainer(); final provider = factory.simpleTestProvider( @@ -1122,3 +1191,40 @@ class Equal { @override int get hashCode => Object.hash(runtimeType, value); } + +class CtorNotifier extends StreamNotifier { + CtorNotifier() { + state; + } + + @override + Stream build() => Stream.value(0); +} + +class AutoDisposeCtorNotifier extends AutoDisposeStreamNotifier { + AutoDisposeCtorNotifier() { + state; + } + + @override + Stream build() => Stream.value(0); +} + +class AutoDisposeFamilyCtorNotifier + extends AutoDisposeFamilyStreamNotifier { + AutoDisposeFamilyCtorNotifier() { + state; + } + + @override + Stream build(int arg) => Stream.value(0); +} + +class FamilyCtorNotifier extends FamilyStreamNotifier { + FamilyCtorNotifier() { + state; + } + + @override + Stream build(int arg) => Stream.value(0); +} From 9c06ec0d36ebb632456cc21aa5397c950c299bdd Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 20 Nov 2023 15:02:43 +0100 Subject: [PATCH 043/387] Sync dev with master (#3138) --- .github/workflows/changelog.yml | 2 +- .github/workflows/check_generation.yml | 2 +- .github/workflows/riverpod_lint.yml | 2 +- packages/flutter_riverpod/CHANGELOG.md | 14 + packages/hooks_riverpod/CHANGELOG.md | 14 + packages/riverpod/CHANGELOG.md | 7 + .../riverpod/lib/src/framework/element.dart | 6 +- .../framework/provider_observer_test.dart | 296 +++++++++++------- packages/riverpod/test/utils.dart | 9 + packages/riverpod_analyzer_utils/CHANGELOG.md | 10 + .../lib/src/riverpod_element.dart | 8 +- .../test/consumer_test.dart | 51 ++- packages/riverpod_annotation/CHANGELOG.md | 4 + packages/riverpod_generator/CHANGELOG.md | 8 + packages/riverpod_lint/CHANGELOG.md | 7 + website/meta_generator.js | 18 +- website/src/components/Link/index.tsx | 6 +- 17 files changed, 322 insertions(+), 142 deletions(-) diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml index 75d2323d8..41213eaeb 100644 --- a/.github/workflows/changelog.yml +++ b/.github/workflows/changelog.yml @@ -4,7 +4,7 @@ on: pull_request: jobs: - build: + changelog: runs-on: ubuntu-latest steps: diff --git a/.github/workflows/check_generation.yml b/.github/workflows/check_generation.yml index 5cb2259ed..24fb2909a 100644 --- a/.github/workflows/check_generation.yml +++ b/.github/workflows/check_generation.yml @@ -6,7 +6,7 @@ on: - "**.md" jobs: - build: + check_generation: runs-on: ubuntu-latest steps: diff --git a/.github/workflows/riverpod_lint.yml b/.github/workflows/riverpod_lint.yml index 0752ab895..eb30d0bca 100644 --- a/.github/workflows/riverpod_lint.yml +++ b/.github/workflows/riverpod_lint.yml @@ -9,7 +9,7 @@ on: - cron: "0 10 * * *" jobs: - build: + riverpod_lint: runs-on: ubuntu-latest defaults: diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md index 13461aeaa..adb9d4c14 100644 --- a/packages/flutter_riverpod/CHANGELOG.md +++ b/packages/flutter_riverpod/CHANGELOG.md @@ -1,3 +1,12 @@ +## Unreleased build + +- All notifier properties now throw an error if used after the notifier + has been disposed. +- The error thrown when a notifier property is used inside the constructor + of a notifier has been improved. +- Fix `ProviderObserver.didUpdateProvider` being called with an incorrect + "provider" parameter when the provider is overridden. + ## 3.0.0-dev.0 - 2023-10-29 - **Breaking**: `AsyncValue` is now "sealed" and `AsyncData/AsyncLoading/AsyncError` @@ -6,6 +15,11 @@ - **Breaking**: Removed everything marked as "deprecated" - Bumped minimum Dart SDK to >= 3.0.0-dev +## 2.4.7 - 2023-11-20 + +- Fix `ProviderObserver.didUpdateProvider` being called with an incorrect + "provider" parameter when the provider is overridden. + ## 2.4.6 - 2023-11-13 - Exceptions in asynchronous providers are now correctly received diff --git a/packages/hooks_riverpod/CHANGELOG.md b/packages/hooks_riverpod/CHANGELOG.md index 56452cb67..92fd770d2 100644 --- a/packages/hooks_riverpod/CHANGELOG.md +++ b/packages/hooks_riverpod/CHANGELOG.md @@ -1,3 +1,12 @@ +## Unreleased build + +- All notifier properties now throw an error if used after the notifier + has been disposed. +- The error thrown when a notifier property is used inside the constructor + of a notifier has been improved. +- Fix `ProviderObserver.didUpdateProvider` being called with an incorrect + "provider" parameter when the provider is overridden. + ## 3.0.0-dev.0 - 2023-10-29 - **Breaking**: `AsyncValue` is now "sealed" and `AsyncData/AsyncLoading/AsyncError` @@ -6,6 +15,11 @@ - **Breaking**: Removed everything marked as "deprecated" - Bumped minimum Dart SDK to >= 3.0.0-dev +## 2.4.7 - 2023-11-20 + +- Fix `ProviderObserver.didUpdateProvider` being called with an incorrect + "provider" parameter when the provider is overridden. + ## 2.4.6 - 2023-11-13 - Exceptions in asynchronous providers are now correctly received diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 6ead85749..b6438bb82 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -4,6 +4,8 @@ has been disposed. - The error thrown when a notifier property is used inside the constructor of a notifier has been improved. +- Fix `ProviderObserver.didUpdateProvider` being called with an incorrect + "provider" parameter when the provider is overridden. ## 3.0.0-dev.0 - 2023-10-29 @@ -13,6 +15,11 @@ - **Breaking**: Removed everything marked as "deprecated" - Bumped minimum Dart SDK to >= 3.0.0-dev +## 2.4.7 - 2023-11-20 + +- Fix `ProviderObserver.didUpdateProvider` being called with an incorrect + "provider" parameter when the provider is overridden. + ## 2.4.6 - 2023-11-13 - Exceptions in asynchronous providers are now correctly received diff --git a/packages/riverpod/lib/src/framework/element.dart b/packages/riverpod/lib/src/framework/element.dart index 6ce2650a5..11ad92401 100644 --- a/packages/riverpod/lib/src/framework/element.dart +++ b/packages/riverpod/lib/src/framework/element.dart @@ -67,7 +67,7 @@ abstract class ProviderElementBase implements Ref, Node { /// The [ProviderContainer] that owns this [ProviderElementBase]. @override ProviderContainer get container => _container; - late ProviderContainer _container; + late final ProviderContainer _container; /// Whether this [ProviderElementBase] is currently listened to or not. /// @@ -573,7 +573,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu for (final observer in _container.observers) { runQuaternaryGuarded( observer.didUpdateProvider, - provider, + origin, previousState, newState.stateOrNull, _container, @@ -586,7 +586,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu error: (newState) { runQuaternaryGuarded( observer.providerDidFail, - provider, + origin, newState.error, newState.stackTrace, _container, diff --git a/packages/riverpod/test/framework/provider_observer_test.dart b/packages/riverpod/test/framework/provider_observer_test.dart index 173685380..8eae31284 100644 --- a/packages/riverpod/test/framework/provider_observer_test.dart +++ b/packages/riverpod/test/framework/provider_observer_test.dart @@ -69,49 +69,48 @@ void main() { verifyNever(observer.providerDidFail(any, any, any, any)); }); - // test( - // 'on scoped ProviderContainer, applies both child and ancestors observers', - // () { - // final provider = StateNotifierProvider, int>( - // (ref) => StateController(0), - // ); - // final observer = ObserverMock(); - // final observer2 = ObserverMock(); - // final observer3 = ObserverMock(); - // final root = createContainer(observers: [observer]); - // final mid = createContainer( - // parent: root, - // observers: [observer2], - // ); - // final child = createContainer( - // parent: mid, - // overrides: [provider.overrideWithValue(StateController(42))], - // observers: [observer3], - // ); - - // expect(child.read(provider), 42); - // expect(mid.read(provider), 0); - - // clearInteractions(observer3); - // clearInteractions(observer2); - // clearInteractions(observer); - - // child.read(provider.notifier).state++; - - // verifyInOrder([ - // observer3.didUpdateProvider(provider, 42, 43, child), - // observer2.didUpdateProvider(provider, 42, 43, child), - // observer.didUpdateProvider(provider, 42, 43, child), - // ]); - - // mid.read(provider.notifier).state++; - - // verify(observer.didUpdateProvider(provider, 0, 1, root)).called(1); - - // verifyNoMoreInteractions(observer3); - // verifyNoMoreInteractions(observer2); - // verifyNoMoreInteractions(observer); - // }); + test( + 'on scoped ProviderContainer, applies both child and ancestors observers', + () { + final provider = StateNotifierProvider, int>( + (ref) => StateController(0), + ); + final observer = ObserverMock('a'); + final observer2 = ObserverMock('b'); + final observer3 = ObserverMock('c'); + + final root = createContainer(observers: [observer]); + final mid = createContainer( + parent: root, + observers: [observer2], + ); + final child = createContainer( + parent: mid, + overrides: [provider.overrideWith((ref) => StateController(42))], + observers: [observer3], + ); + + expect(child.read(provider), 42); + expect(mid.read(provider), 0); + + clearInteractions(observer3); + clearInteractions(observer2); + clearInteractions(observer); + + expect(child.read(provider.notifier).state++, 42); + + verify(observer.didUpdateProvider(provider, 42, 43, child)).called(1); + verify(observer2.didUpdateProvider(provider, 42, 43, child)).called(1); + verify(observer3.didUpdateProvider(provider, 42, 43, child)).called(1); + + mid.read(provider.notifier).state++; + + verify(observer.didUpdateProvider(provider, 0, 1, root)).called(1); + + verifyNoMoreInteractions(observer3); + verifyNoMoreInteractions(observer2); + verifyNoMoreInteractions(observer); + }); test('handles computed provider update', () async { final observer = ObserverMock(); @@ -150,84 +149,76 @@ void main() { ).called(1); }); - // test('didUpdateProviders', () { - // final observer = ObserverMock(); - // final observer2 = ObserverMock(); - // final provider = StateNotifierProvider((_) => Counter()); - // final counter = Counter(); - // final container = createContainer( - // overrides: [ - // provider.overrideWithValue(counter), - // ], - // observers: [observer, observer2], - // ); - // final listener = Listener(); - - // container.listen(provider, listener, fireImmediately: true); - - // verify(listener(null, 0)).called(1); - // verifyNoMoreInteractions(listener); - // verifyInOrder([ - // observer.didAddProvider( - // provider.notifier, - // counter, - // container, - // ), - // observer2.didAddProvider(provider.notifier, counter, container), - // observer.didAddProvider(provider, 0, container), - // observer2.didAddProvider(provider, 0, container), - // ]); - // verifyNoMoreInteractions(observer); - // verifyNoMoreInteractions(observer2); - - // counter.increment(); - - // verifyInOrder([ - // listener(0, 1), - // observer.didUpdateProvider(provider, 0, 1, container), - // observer2.didUpdateProvider(provider, 0, 1, container), - // ]); - // verifyNoMoreInteractions(listener); - // verifyNoMoreInteractions(observer); - // verifyNoMoreInteractions(observer2); - // }); - - // test('guards didUpdateProviders', () { - // final observer = ObserverMock(); - // when(observer.didUpdateProvider(any, any, any, any)) - // .thenThrow('error1'); - // final observer2 = ObserverMock(); - // when(observer2.didUpdateProvider(any, any, any, any)) - // .thenThrow('error2'); - // final observer3 = ObserverMock(); - // final provider = StateNotifierProvider((_) => Counter()); - // final counter = Counter(); - // final container = createContainer( - // overrides: [ - // provider.overrideWithValue(counter), - // ], - // observers: [observer, observer2, observer3], - // ); - - // container.read(provider); - - // clearInteractions(observer); - // clearInteractions(observer2); - // clearInteractions(observer3); - - // final errors = []; - // runZonedGuarded(counter.increment, (err, stack) => errors.add(err)); - - // expect(errors, ['error1', 'error2']); - // verifyInOrder([ - // observer.didUpdateProvider(provider, 0, 1, container), - // observer2.didUpdateProvider(provider, 0, 1, container), - // observer3.didUpdateProvider(provider, 0, 1, container), - // ]); - // verifyNoMoreInteractions(observer); - // verifyNoMoreInteractions(observer2); - // verifyNoMoreInteractions(observer3); - // }); + test('didUpdateProviders', () { + final observer = ObserverMock('a'); + final observer2 = ObserverMock('b'); + final provider = StateNotifierProvider((_) => Counter()); + final counter = Counter(); + final container = createContainer( + overrides: [ + provider.overrideWith((ref) => counter), + ], + observers: [observer, observer2], + ); + final listener = Listener(); + + container.listen(provider, listener.call, fireImmediately: true); + + verify(listener(null, 0)).called(1); + verifyNoMoreInteractions(listener); + verifyInOrder([ + observer.didAddProvider(provider, 0, container), + observer2.didAddProvider(provider, 0, container), + ]); + verifyNoMoreInteractions(observer); + verifyNoMoreInteractions(observer2); + + counter.increment(); + + verifyInOrder([ + listener(0, 1), + observer.didUpdateProvider(provider, 0, 1, container), + observer2.didUpdateProvider(provider, 0, 1, container), + ]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(observer); + verifyNoMoreInteractions(observer2); + }); + + test('guards didUpdateProviders', () { + final observer = ObserverMock(); + when(observer.didUpdateProvider(any, any, any, any)) + .thenThrow('error1'); + final observer2 = ObserverMock(); + when(observer2.didUpdateProvider(any, any, any, any)) + .thenThrow('error2'); + final observer3 = ObserverMock(); + final provider = StateNotifierProvider((_) => Counter()); + final counter = Counter(); + final container = createContainer( + overrides: [provider.overrideWith((ref) => counter)], + observers: [observer, observer2, observer3], + ); + + container.read(provider); + + clearInteractions(observer); + clearInteractions(observer2); + clearInteractions(observer3); + + final errors = []; + runZonedGuarded(counter.increment, (err, stack) => errors.add(err)); + + expect(errors, ['error1', 'error2']); + verifyInOrder([ + observer.didUpdateProvider(provider, 0, 1, container), + observer2.didUpdateProvider(provider, 0, 1, container), + observer3.didUpdateProvider(provider, 0, 1, container), + ]); + verifyNoMoreInteractions(observer); + verifyNoMoreInteractions(observer2); + verifyNoMoreInteractions(observer3); + }); test("Computed don't call didUpdateProviders when value doesn't change", () async { @@ -288,6 +279,69 @@ void main() { }); group('providerDidFail', () { + test( + 'on scoped ProviderContainer, applies both child and ancestors observers', + () async { + final dep = StateProvider((ref) => 0); + final provider = StateNotifierProvider, int>( + (ref) => StateController(0), + ); + final observer = ObserverMock('a'); + final observer2 = ObserverMock('b'); + final observer3 = ObserverMock('c'); + + final root = createContainer(observers: [observer]); + final mid = createContainer( + parent: root, + observers: [observer2], + ); + final child = createContainer( + parent: mid, + overrides: [ + provider.overrideWith((ref) { + if (ref.watch(dep) != 0) { + Error.throwWithStackTrace('error', StackTrace.empty); + } + return StateController(42); + }), + ], + observers: [observer3], + ); + + child.listen(provider, (_, __) {}, onError: (_, __) {}); + + expect(child.read(provider), 42); + expect(mid.read(provider), 0); + + clearInteractions(observer3); + clearInteractions(observer2); + clearInteractions(observer); + + child.read(dep.notifier).state++; + await child.pump(); + + verifyInOrder([ + observer.didDisposeProvider(provider, child), + observer.didUpdateProvider(dep, 0, 1, root), + observer.didUpdateProvider(provider, 42, null, child), + observer.providerDidFail(provider, 'error', StackTrace.empty, child), + ]); + verifyInOrder([ + observer2.didDisposeProvider(provider, child), + observer2.didUpdateProvider(provider, 42, null, child), + observer2.providerDidFail(provider, 'error', StackTrace.empty, child), + ]); + verifyInOrder([ + observer3.didDisposeProvider(provider, child), + observer3.didUpdateProvider(provider, 42, null, child), + observer3.providerDidFail(provider, 'error', StackTrace.empty, child), + ]); + + verifyNoMoreInteractions(observer3); + verifyNoMoreInteractions(observer2); + verifyNoMoreInteractions(observer); + }); + test('is called when FutureProvider emits an error', () async { final observer = ObserverMock(); final container = createContainer(observers: [observer]); diff --git a/packages/riverpod/test/utils.dart b/packages/riverpod/test/utils.dart index 33b4bbe23..745864173 100644 --- a/packages/riverpod/test/utils.dart +++ b/packages/riverpod/test/utils.dart @@ -176,6 +176,15 @@ class _EqualsIgnoringHashCodes extends Matcher { } class ObserverMock extends Mock implements ProviderObserver { + ObserverMock([this.label]); + + final String? label; + + @override + String toString() { + return label ?? super.toString(); + } + @override void didDisposeProvider( ProviderBase? provider, diff --git a/packages/riverpod_analyzer_utils/CHANGELOG.md b/packages/riverpod_analyzer_utils/CHANGELOG.md index 92da5c291..8ae8aba6c 100644 --- a/packages/riverpod_analyzer_utils/CHANGELOG.md +++ b/packages/riverpod_analyzer_utils/CHANGELOG.md @@ -1,7 +1,17 @@ +## Unreleased build + +- **Breaking** `LegacyProviderDeclarationElement.providerType` is now nullable. +- Fix crash when parsing classes with a `ProviderBase` field. + ## 1.0.0-dev.0 - 2023-10-30 - Added `GeneratorProviderDeclarationElement.isFamily` +## 0.5.0 - 2023-11-20 + +- **Breaking** `LegacyProviderDeclarationElement.providerType` is now nullable. +- Fix crash when parsing classes with a `ProviderBase` field. + ## 0.4.3 - 2023-10-28 - Added `GeneratorProviderDeclarationElement.isFamily` diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart index 439e01204..7d3ff264e 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart @@ -149,7 +149,7 @@ enum LegacyProviderType { /// Type for `Provider` provider; - static LegacyProviderType _parse(DartType providerType) { + static LegacyProviderType? _parse(DartType providerType) { if (anyFutureProviderType.isAssignableFromType(providerType)) { return LegacyProviderType.futureProvider; } @@ -175,7 +175,7 @@ enum LegacyProviderType { return LegacyProviderType.changeNotifierProvider; } - throw StateError('Unknown provider type $providerType'); + return null; } } @@ -203,7 +203,7 @@ class LegacyProviderDeclarationElement implements ProviderDeclarationElement { bool isAutoDispose; LegacyFamilyInvocationElement? familyElement; - LegacyProviderType providerType; + LegacyProviderType? providerType; if (providerBaseType.isAssignableFromType(element.type)) { isAutoDispose = !alwaysAliveProviderListenableType .isAssignableFromType(element.type); @@ -248,7 +248,7 @@ class LegacyProviderDeclarationElement implements ProviderDeclarationElement { final LegacyFamilyInvocationElement? familyElement; - final LegacyProviderType providerType; + final LegacyProviderType? providerType; } class LegacyFamilyInvocationElement { diff --git a/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart b/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart index f3a025a6b..b23769ef2 100644 --- a/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart @@ -1,9 +1,58 @@ -import 'package:riverpod_analyzer_utils/src/riverpod_ast.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import 'package:test/test.dart'; import 'analyzer_test_utils.dart'; void main() { + testSource('Handles consumers with a ProviderBase inside', source: ''' +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter/material.dart'; + +class ProviderWidget extends ConsumerWidget { + const ProviderWidget({super.key, required this.provider}); + + final ProviderBase> provider; + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.watch(provider); + return Container(); + } +} +''', (resolver) async { + final result = await resolver.resolveRiverpodAnalysisResult(); + + final consumerWidget = result.consumerWidgetDeclarations.single; + expect(consumerWidget, isA()); + expect(consumerWidget.node.name.toString(), 'ProviderWidget'); + expect( + consumerWidget.buildMethod!.toSource(), + '@override Widget build(BuildContext context, WidgetRef ref) {ref.watch(provider); return Container();}', + ); + + expect(consumerWidget.widgetRefInvocations, [ + isA() + .having((e) => e.node.toSource(), 'node', 'ref.watch(provider)') + .having( + (e) => e.provider, + 'provider', + isA() + .having((e) => e.node.toSource(), 'node', 'provider') + .having( + (e) => e.providerElement, + 'providerElement', + isA() + .having((e) => e.providerType, 'providerType', null), + ), + ), + ]); + + expect( + result.resolvedRiverpodLibraryResults.single.unknownWidgetRefInvocations, + isEmpty, + ); + }); + testSource('Decode ConsumerWidget declarations', source: ''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/packages/riverpod_annotation/CHANGELOG.md b/packages/riverpod_annotation/CHANGELOG.md index 23dc6e2ec..dc12f3e04 100644 --- a/packages/riverpod_annotation/CHANGELOG.md +++ b/packages/riverpod_annotation/CHANGELOG.md @@ -2,6 +2,10 @@ - `riverpod` upgraded to `3.0.0-dev.0` +## 2.3.1 - 2023-11-20 + +- `riverpod` upgraded to `2.4.7` + ## 2.3.1 - 2023-11-13 - `riverpod` upgraded to `2.4.6` diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 80743c3a7..fbaf4d0e3 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -1,3 +1,7 @@ +## Unreleased build + +- Fix crash when encountering classes with a `ProviderBase` field. + ## 3.0.0-dev.8 - 2023-10-30 - `riverpod_analyzer_utils` upgraded to `1.0.0-dev.0` @@ -67,6 +71,10 @@ This comes with a few minor restrictions: - **Breaking**: Arguments of the form `fn(void myParameter())` are no-longer supported. Instead use `fn(void Function() myParameter)`. +## 2.3.7 - 2023-11-20 + +- Fix crash when encountering classes with a `ProviderBase` field. + ## 2.3.5 - 2023-10-21 - `riverpod_analyzer_utils` upgraded to `0.4.1` diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index 686aad4e6..62058a670 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -1,3 +1,7 @@ +## Unreleased build + +- Fix crash when encountering classes with a `ProviderBase` field. + ## 3.0.0-dev.1 - 2023-10-30 - `riverpod_analyzer_utils` upgraded to `1.0.0-dev.0` @@ -6,6 +10,9 @@ - `riverpod` upgraded to `3.0.0-dev.0` +## 2.3.5 - 2023-11-20 + +- Fix crash when encountering classes with a `ProviderBase` field. ## 2.3.4 - 2023-11-13 diff --git a/website/meta_generator.js b/website/meta_generator.js index fd690a85a..0ac937585 100644 --- a/website/meta_generator.js +++ b/website/meta_generator.js @@ -99,10 +99,10 @@ function decodeDocuments(documents) { let id = parsedDoc.data.id; if (!id) { let pathSplit; - if (docFile.startsWith("docs/")) { - pathSplit = docFile.split("/").slice(1); - } else if (docFile.startsWith("i18n/")) { - pathSplit = docFile.split("/").slice(4); + if (docFile.startsWith(`docs${path.sep}`)) { + pathSplit = docFile.split(path.sep).slice(1); + } else if (docFile.startsWith(`i18n${path.sep}`)) { + pathSplit = docFile.split(path.sep).slice(4); } else { throw new Error(`Unknown document type ${docFile}`); } @@ -130,14 +130,14 @@ function decodeDocuments(documents) { return result; } -function getCountryCodeForPath(path) { - if (path.startsWith("docs/")) return "en"; +function getCountryCodeForPath(docFile) { + if (docFile.startsWith(`docs${path.sep}`)) return "en"; - if (!path.startsWith("i18n/")) { - throw new Error(`Unknown path ${path}`); + if (!docFile.startsWith(`i18n${path.sep}`)) { + throw new Error(`Unknown docFile ${docFile}`); } - return path.split("/")[1]; + return docFile.split(path.sep)[1]; } class OutdatedTranslation { diff --git a/website/src/components/Link/index.tsx b/website/src/components/Link/index.tsx index da80a37bf..35b8f4326 100644 --- a/website/src/components/Link/index.tsx +++ b/website/src/components/Link/index.tsx @@ -14,6 +14,10 @@ export function Link(props: LinkProps) { ? doc.metadata.source.split("/")[2] : "en"; + const prefix = countryCode === "en" + ? "" + : `/${countryCode}`; + const docTitle = documentTitles[countryCode][props.documentID]; if (!docTitle) { @@ -24,5 +28,5 @@ export function Link(props: LinkProps) { const trailing = props.hash ? `#${props.hash}` : ""; - return {docTitle}; + return {docTitle}; } From b0c713db4f2395f07df1e9b21410b8c75b6b1a50 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 20 Nov 2023 15:04:58 +0100 Subject: [PATCH 044/387] riverpod : 3.0.0-dev.0 -> 3.0.0-dev.1 riverpod_analyzer_utils : 1.0.0-dev.0 -> 1.0.0-dev.1 riverpod_annotation : 3.0.0-dev.0 -> 3.0.0-dev.1 riverpod_generator : 3.0.0-dev.8 -> 3.0.0-dev.9 riverpod_lint : 3.0.0-dev.1 -> 3.0.0-dev.2 flutter_riverpod : 3.0.0-dev.0 -> 3.0.0-dev.1 hooks_riverpod : 3.0.0-dev.0 -> 3.0.0-dev.1 --- packages/flutter_riverpod/CHANGELOG.md | 2 +- packages/flutter_riverpod/pubspec.yaml | 4 ++-- packages/hooks_riverpod/CHANGELOG.md | 2 +- packages/hooks_riverpod/pubspec.yaml | 6 +++--- packages/riverpod/CHANGELOG.md | 2 +- packages/riverpod/pubspec.yaml | 2 +- packages/riverpod_analyzer_utils/CHANGELOG.md | 2 +- packages/riverpod_analyzer_utils/pubspec.yaml | 2 +- packages/riverpod_annotation/CHANGELOG.md | 4 ++++ packages/riverpod_annotation/pubspec.yaml | 4 ++-- packages/riverpod_generator/CHANGELOG.md | 2 +- packages/riverpod_generator/pubspec.yaml | 8 ++++---- packages/riverpod_lint/CHANGELOG.md | 2 +- packages/riverpod_lint/pubspec.yaml | 6 +++--- 14 files changed, 26 insertions(+), 22 deletions(-) diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md index adb9d4c14..3169cb8e2 100644 --- a/packages/flutter_riverpod/CHANGELOG.md +++ b/packages/flutter_riverpod/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased build +## 3.0.0-dev.1 - 2023-11-20 - All notifier properties now throw an error if used after the notifier has been disposed. diff --git a/packages/flutter_riverpod/pubspec.yaml b/packages/flutter_riverpod/pubspec.yaml index 1a0e958d9..8fb050cc6 100644 --- a/packages/flutter_riverpod/pubspec.yaml +++ b/packages/flutter_riverpod/pubspec.yaml @@ -2,7 +2,7 @@ name: flutter_riverpod description: > A simple way to access state from anywhere in your application while robust and testable. -version: 3.0.0-dev.0 +version: 3.0.0-dev.1 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues @@ -18,7 +18,7 @@ dependencies: flutter: sdk: flutter meta: ^1.4.0 - riverpod: 3.0.0-dev.0 + riverpod: 3.0.0-dev.1 state_notifier: ">=0.7.2 <2.0.0" dev_dependencies: diff --git a/packages/hooks_riverpod/CHANGELOG.md b/packages/hooks_riverpod/CHANGELOG.md index 92fd770d2..4af0b72de 100644 --- a/packages/hooks_riverpod/CHANGELOG.md +++ b/packages/hooks_riverpod/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased build +## 3.0.0-dev.1 - 2023-11-20 - All notifier properties now throw an error if used after the notifier has been disposed. diff --git a/packages/hooks_riverpod/pubspec.yaml b/packages/hooks_riverpod/pubspec.yaml index a16da991a..914bdb6a9 100644 --- a/packages/hooks_riverpod/pubspec.yaml +++ b/packages/hooks_riverpod/pubspec.yaml @@ -2,7 +2,7 @@ name: hooks_riverpod description: > A simple way to access state from anywhere in your application while robust and testable. -version: 3.0.0-dev.0 +version: 3.0.0-dev.1 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues @@ -18,8 +18,8 @@ dependencies: flutter: sdk: flutter flutter_hooks: '>=0.18.0 <0.21.0' - flutter_riverpod: 3.0.0-dev.0 - riverpod: 3.0.0-dev.0 + flutter_riverpod: 3.0.0-dev.1 + riverpod: 3.0.0-dev.1 state_notifier: ">=0.7.2 <2.0.0" dev_dependencies: diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index b6438bb82..b3617b47a 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased build +## 3.0.0-dev.1 - 2023-11-20 - All notifier properties now throw an error if used after the notifier has been disposed. diff --git a/packages/riverpod/pubspec.yaml b/packages/riverpod/pubspec.yaml index 40a28e1e8..1486feea0 100644 --- a/packages/riverpod/pubspec.yaml +++ b/packages/riverpod/pubspec.yaml @@ -2,7 +2,7 @@ name: riverpod description: > A simple way to access state from anywhere in your application while robust and testable. -version: 3.0.0-dev.0 +version: 3.0.0-dev.1 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues diff --git a/packages/riverpod_analyzer_utils/CHANGELOG.md b/packages/riverpod_analyzer_utils/CHANGELOG.md index 8ae8aba6c..e1f565942 100644 --- a/packages/riverpod_analyzer_utils/CHANGELOG.md +++ b/packages/riverpod_analyzer_utils/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased build +## 1.0.0-dev.1 - 2023-11-20 - **Breaking** `LegacyProviderDeclarationElement.providerType` is now nullable. - Fix crash when parsing classes with a `ProviderBase` field. diff --git a/packages/riverpod_analyzer_utils/pubspec.yaml b/packages/riverpod_analyzer_utils/pubspec.yaml index 4be4969ff..254146a86 100644 --- a/packages/riverpod_analyzer_utils/pubspec.yaml +++ b/packages/riverpod_analyzer_utils/pubspec.yaml @@ -4,7 +4,7 @@ repository: https://github.com/rrousselGit/river_pod issue_tracker: https://github.com/rrousselGit/riverpod/issues funding: - https://github.com/sponsors/rrousselGit/ -version: 1.0.0-dev.0 +version: 1.0.0-dev.1 environment: sdk: ">=3.0.0-0.0-dev <4.0.0" diff --git a/packages/riverpod_annotation/CHANGELOG.md b/packages/riverpod_annotation/CHANGELOG.md index dc12f3e04..eb8a19e02 100644 --- a/packages/riverpod_annotation/CHANGELOG.md +++ b/packages/riverpod_annotation/CHANGELOG.md @@ -1,3 +1,7 @@ +## 3.0.0-dev.1 - 2023-11-20 + +- `riverpod` upgraded to `3.0.0-dev.1` + ## 3.0.0-dev.0 - 2023-10-29 - `riverpod` upgraded to `3.0.0-dev.0` diff --git a/packages/riverpod_annotation/pubspec.yaml b/packages/riverpod_annotation/pubspec.yaml index 702731331..dce72eb6a 100644 --- a/packages/riverpod_annotation/pubspec.yaml +++ b/packages/riverpod_annotation/pubspec.yaml @@ -1,6 +1,6 @@ name: riverpod_annotation description: A package exposing annotations for riverpod_generator -version: 3.0.0-dev.0 +version: 3.0.0-dev.1 repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues funding: @@ -11,7 +11,7 @@ environment: dependencies: meta: ^1.7.0 - riverpod: ^3.0.0-dev.0 + riverpod: ^3.0.0-dev.1 dev_dependencies: test: ^1.21.0 diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index fbaf4d0e3..f3331dc10 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased build +## 3.0.0-dev.9 - 2023-11-20 - Fix crash when encountering classes with a `ProviderBase` field. diff --git a/packages/riverpod_generator/pubspec.yaml b/packages/riverpod_generator/pubspec.yaml index baaa61a26..c60a7d229 100644 --- a/packages/riverpod_generator/pubspec.yaml +++ b/packages/riverpod_generator/pubspec.yaml @@ -1,6 +1,6 @@ name: riverpod_generator description: A code generator for Riverpod. This both simplifies the syntax empowers it, such as allowing stateful hot-reload. -version: 3.0.0-dev.8 +version: 3.0.0-dev.9 repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues funding: @@ -17,8 +17,8 @@ dependencies: crypto: ^3.0.2 meta: ^1.7.0 path: ^1.8.0 - riverpod_analyzer_utils: ^1.0.0-dev.0 - riverpod_annotation: ^3.0.0-dev.0 + riverpod_analyzer_utils: ^1.0.0-dev.1 + riverpod_annotation: ^3.0.0-dev.1 source_gen: ^1.2.0 dev_dependencies: @@ -26,5 +26,5 @@ dev_dependencies: build_verify: ^3.0.0 freezed: ^2.4.3 freezed_annotation: ^2.4.1 - riverpod: ^3.0.0-dev.0 + riverpod: ^3.0.0-dev.1 test: ^1.21.0 diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index 62058a670..3d02266f1 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased build +## 3.0.0-dev.2 - 2023-11-20 - Fix crash when encountering classes with a `ProviderBase` field. diff --git a/packages/riverpod_lint/pubspec.yaml b/packages/riverpod_lint/pubspec.yaml index 62b9da0c1..2b8060b75 100644 --- a/packages/riverpod_lint/pubspec.yaml +++ b/packages/riverpod_lint/pubspec.yaml @@ -1,6 +1,6 @@ name: riverpod_lint description: Riverpod_lint is a developer tool for users of Riverpod, designed to help stop common issues and simplify repetitive tasks. -version: 3.0.0-dev.1 +version: 3.0.0-dev.2 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/river_pod issue_tracker: https://github.com/rrousselGit/riverpod/issues @@ -17,8 +17,8 @@ dependencies: custom_lint_builder: ^0.5.2 meta: ^1.7.0 path: ^1.8.1 - riverpod: ^3.0.0-dev.0 - riverpod_analyzer_utils: ^1.0.0-dev.0 + riverpod: ^3.0.0-dev.1 + riverpod_analyzer_utils: ^1.0.0-dev.1 source_span: ^1.8.0 yaml: ^3.1.1 From 13b8d0b93601fb988d7da67cbd1925e4a7ace426 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 20 Nov 2023 23:57:25 +0100 Subject: [PATCH 045/387] riverpod : 3.0.0-dev.1 -> 3.0.0-dev.2 riverpod_annotation : 3.0.0-dev.1 -> 3.0.0-dev.2 riverpod_generator : 3.0.0-dev.9 -> 3.0.0-dev.10 riverpod_lint : 3.0.0-dev.2 -> 3.0.0-dev.3 flutter_riverpod : 3.0.0-dev.1 -> 3.0.0-dev.2 hooks_riverpod : 3.0.0-dev.1 -> 3.0.0-dev.2 --- packages/flutter_riverpod/CHANGELOG.md | 2 +- packages/flutter_riverpod/pubspec.yaml | 4 ++-- packages/hooks_riverpod/CHANGELOG.md | 2 +- packages/hooks_riverpod/pubspec.yaml | 6 +++--- packages/riverpod/CHANGELOG.md | 2 +- packages/riverpod/pubspec.yaml | 2 +- packages/riverpod_annotation/CHANGELOG.md | 4 ++++ packages/riverpod_annotation/pubspec.yaml | 4 ++-- packages/riverpod_generator/CHANGELOG.md | 5 +++++ packages/riverpod_generator/pubspec.yaml | 6 +++--- packages/riverpod_lint/CHANGELOG.md | 4 ++++ packages/riverpod_lint/pubspec.yaml | 4 ++-- 12 files changed, 29 insertions(+), 16 deletions(-) diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md index b8f9167c4..21ab23c99 100644 --- a/packages/flutter_riverpod/CHANGELOG.md +++ b/packages/flutter_riverpod/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased build +## 3.0.0-dev.2 - 2023-11-20 Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. diff --git a/packages/flutter_riverpod/pubspec.yaml b/packages/flutter_riverpod/pubspec.yaml index 8fb050cc6..846fb1e4d 100644 --- a/packages/flutter_riverpod/pubspec.yaml +++ b/packages/flutter_riverpod/pubspec.yaml @@ -2,7 +2,7 @@ name: flutter_riverpod description: > A simple way to access state from anywhere in your application while robust and testable. -version: 3.0.0-dev.1 +version: 3.0.0-dev.2 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues @@ -18,7 +18,7 @@ dependencies: flutter: sdk: flutter meta: ^1.4.0 - riverpod: 3.0.0-dev.1 + riverpod: 3.0.0-dev.2 state_notifier: ">=0.7.2 <2.0.0" dev_dependencies: diff --git a/packages/hooks_riverpod/CHANGELOG.md b/packages/hooks_riverpod/CHANGELOG.md index 50ed39749..00d4a64c1 100644 --- a/packages/hooks_riverpod/CHANGELOG.md +++ b/packages/hooks_riverpod/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased build +## 3.0.0-dev.2 - 2023-11-20 Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. diff --git a/packages/hooks_riverpod/pubspec.yaml b/packages/hooks_riverpod/pubspec.yaml index 914bdb6a9..6ac7023fa 100644 --- a/packages/hooks_riverpod/pubspec.yaml +++ b/packages/hooks_riverpod/pubspec.yaml @@ -2,7 +2,7 @@ name: hooks_riverpod description: > A simple way to access state from anywhere in your application while robust and testable. -version: 3.0.0-dev.1 +version: 3.0.0-dev.2 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues @@ -18,8 +18,8 @@ dependencies: flutter: sdk: flutter flutter_hooks: '>=0.18.0 <0.21.0' - flutter_riverpod: 3.0.0-dev.1 - riverpod: 3.0.0-dev.1 + flutter_riverpod: 3.0.0-dev.2 + riverpod: 3.0.0-dev.2 state_notifier: ">=0.7.2 <2.0.0" dev_dependencies: diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index e8ce1bb1b..219051a6f 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased build +## 3.0.0-dev.2 - 2023-11-20 Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. diff --git a/packages/riverpod/pubspec.yaml b/packages/riverpod/pubspec.yaml index 1486feea0..e9984ba10 100644 --- a/packages/riverpod/pubspec.yaml +++ b/packages/riverpod/pubspec.yaml @@ -2,7 +2,7 @@ name: riverpod description: > A simple way to access state from anywhere in your application while robust and testable. -version: 3.0.0-dev.1 +version: 3.0.0-dev.2 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues diff --git a/packages/riverpod_annotation/CHANGELOG.md b/packages/riverpod_annotation/CHANGELOG.md index cff847815..0f06a638e 100644 --- a/packages/riverpod_annotation/CHANGELOG.md +++ b/packages/riverpod_annotation/CHANGELOG.md @@ -1,3 +1,7 @@ +## 3.0.0-dev.2 - 2023-11-20 + +- `riverpod` upgraded to `3.0.0-dev.2` + ## 3.0.0-dev.1 - 2023-11-20 - `riverpod` upgraded to `3.0.0-dev.1` diff --git a/packages/riverpod_annotation/pubspec.yaml b/packages/riverpod_annotation/pubspec.yaml index dce72eb6a..539f8725a 100644 --- a/packages/riverpod_annotation/pubspec.yaml +++ b/packages/riverpod_annotation/pubspec.yaml @@ -1,6 +1,6 @@ name: riverpod_annotation description: A package exposing annotations for riverpod_generator -version: 3.0.0-dev.1 +version: 3.0.0-dev.2 repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues funding: @@ -11,7 +11,7 @@ environment: dependencies: meta: ^1.7.0 - riverpod: ^3.0.0-dev.1 + riverpod: ^3.0.0-dev.2 dev_dependencies: test: ^1.21.0 diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 0be068f3f..e39a32790 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -1,3 +1,8 @@ +## 3.0.0-dev.10 - 2023-11-20 + +- `riverpod_annotation` upgraded to `3.0.0-dev.2` +- `riverpod` upgraded to `3.0.0-dev.2` + ## 3.0.0-dev.9 - 2023-11-20 - Fix crash when encountering classes with a `ProviderBase` field. diff --git a/packages/riverpod_generator/pubspec.yaml b/packages/riverpod_generator/pubspec.yaml index c60a7d229..9cfd76b7b 100644 --- a/packages/riverpod_generator/pubspec.yaml +++ b/packages/riverpod_generator/pubspec.yaml @@ -1,6 +1,6 @@ name: riverpod_generator description: A code generator for Riverpod. This both simplifies the syntax empowers it, such as allowing stateful hot-reload. -version: 3.0.0-dev.9 +version: 3.0.0-dev.10 repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues funding: @@ -18,7 +18,7 @@ dependencies: meta: ^1.7.0 path: ^1.8.0 riverpod_analyzer_utils: ^1.0.0-dev.1 - riverpod_annotation: ^3.0.0-dev.1 + riverpod_annotation: ^3.0.0-dev.2 source_gen: ^1.2.0 dev_dependencies: @@ -26,5 +26,5 @@ dev_dependencies: build_verify: ^3.0.0 freezed: ^2.4.3 freezed_annotation: ^2.4.1 - riverpod: ^3.0.0-dev.1 + riverpod: ^3.0.0-dev.2 test: ^1.21.0 diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index 03483a7f6..5e50b5ff0 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -1,3 +1,7 @@ +## 3.0.0-dev.3 - 2023-11-20 + +- `riverpod` upgraded to `3.0.0-dev.2` + ## 3.0.0-dev.2 - 2023-11-20 - Fix crash when encountering classes with a `ProviderBase` field. diff --git a/packages/riverpod_lint/pubspec.yaml b/packages/riverpod_lint/pubspec.yaml index 2b8060b75..e9e8b0b4e 100644 --- a/packages/riverpod_lint/pubspec.yaml +++ b/packages/riverpod_lint/pubspec.yaml @@ -1,6 +1,6 @@ name: riverpod_lint description: Riverpod_lint is a developer tool for users of Riverpod, designed to help stop common issues and simplify repetitive tasks. -version: 3.0.0-dev.2 +version: 3.0.0-dev.3 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/river_pod issue_tracker: https://github.com/rrousselGit/riverpod/issues @@ -17,7 +17,7 @@ dependencies: custom_lint_builder: ^0.5.2 meta: ^1.7.0 path: ^1.8.1 - riverpod: ^3.0.0-dev.1 + riverpod: ^3.0.0-dev.2 riverpod_analyzer_utils: ^1.0.0-dev.1 source_span: ^1.8.0 yaml: ^3.1.1 From 9a54da8cb0da68378b4b168ba012c425efdac61c Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 27 Nov 2023 01:23:48 +0100 Subject: [PATCH 046/387] The following packages have been updated: riverpod : 3.0.0-dev.2 -> 3.0.0-dev.3 riverpod_annotation : 3.0.0-dev.2 -> 3.0.0-dev.3 riverpod_generator : 3.0.0-dev.10 -> 3.0.0-dev.11 riverpod_lint : 3.0.0-dev.3 -> 3.0.0-dev.4 flutter_riverpod : 3.0.0-dev.2 -> 3.0.0-dev.3 hooks_riverpod : 3.0.0-dev.2 -> 3.0.0-dev.3 --- packages/flutter_riverpod/CHANGELOG.md | 2 +- packages/flutter_riverpod/pubspec.yaml | 4 ++-- packages/hooks_riverpod/CHANGELOG.md | 2 +- packages/hooks_riverpod/pubspec.yaml | 6 +++--- packages/riverpod/CHANGELOG.md | 2 +- packages/riverpod/pubspec.yaml | 2 +- packages/riverpod_annotation/CHANGELOG.md | 4 ++++ packages/riverpod_annotation/pubspec.yaml | 4 ++-- packages/riverpod_generator/CHANGELOG.md | 5 +++++ packages/riverpod_generator/pubspec.yaml | 6 +++--- packages/riverpod_lint/CHANGELOG.md | 4 ++++ packages/riverpod_lint/pubspec.yaml | 4 ++-- 12 files changed, 29 insertions(+), 16 deletions(-) diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md index 4a2757eb6..bcfc27ae2 100644 --- a/packages/flutter_riverpod/CHANGELOG.md +++ b/packages/flutter_riverpod/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased build +## 3.0.0-dev.3 - 2023-11-27 - Fix "pending timer" issue inside tests when using `ref.keepAlive()`. - Fix `Ref.invalidate`/`Ref.refresh` not throwing on circular dependency. diff --git a/packages/flutter_riverpod/pubspec.yaml b/packages/flutter_riverpod/pubspec.yaml index 846fb1e4d..c84922abe 100644 --- a/packages/flutter_riverpod/pubspec.yaml +++ b/packages/flutter_riverpod/pubspec.yaml @@ -2,7 +2,7 @@ name: flutter_riverpod description: > A simple way to access state from anywhere in your application while robust and testable. -version: 3.0.0-dev.2 +version: 3.0.0-dev.3 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues @@ -18,7 +18,7 @@ dependencies: flutter: sdk: flutter meta: ^1.4.0 - riverpod: 3.0.0-dev.2 + riverpod: 3.0.0-dev.3 state_notifier: ">=0.7.2 <2.0.0" dev_dependencies: diff --git a/packages/hooks_riverpod/CHANGELOG.md b/packages/hooks_riverpod/CHANGELOG.md index 9e0537f77..83ded1fb5 100644 --- a/packages/hooks_riverpod/CHANGELOG.md +++ b/packages/hooks_riverpod/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased build +## 3.0.0-dev.3 - 2023-11-27 - Fix "pending timer" issue inside tests when using `ref.keepAlive()`. - Fix `Ref.invalidate`/`Ref.refresh` not throwing on circular dependency. diff --git a/packages/hooks_riverpod/pubspec.yaml b/packages/hooks_riverpod/pubspec.yaml index 6ac7023fa..b1d897f5d 100644 --- a/packages/hooks_riverpod/pubspec.yaml +++ b/packages/hooks_riverpod/pubspec.yaml @@ -2,7 +2,7 @@ name: hooks_riverpod description: > A simple way to access state from anywhere in your application while robust and testable. -version: 3.0.0-dev.2 +version: 3.0.0-dev.3 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues @@ -18,8 +18,8 @@ dependencies: flutter: sdk: flutter flutter_hooks: '>=0.18.0 <0.21.0' - flutter_riverpod: 3.0.0-dev.2 - riverpod: 3.0.0-dev.2 + flutter_riverpod: 3.0.0-dev.3 + riverpod: 3.0.0-dev.3 state_notifier: ">=0.7.2 <2.0.0" dev_dependencies: diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 584ba9d58..6361af5a8 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -1,4 +1,4 @@ -## Unreleased build +## 3.0.0-dev.3 - 2023-11-27 - Fix "pending timer" issue inside tests when using `ref.keepAlive()`. - Fix `Ref.invalidate`/`Ref.refresh` not throwing on circular dependency. diff --git a/packages/riverpod/pubspec.yaml b/packages/riverpod/pubspec.yaml index e9984ba10..e8cad4e8e 100644 --- a/packages/riverpod/pubspec.yaml +++ b/packages/riverpod/pubspec.yaml @@ -2,7 +2,7 @@ name: riverpod description: > A simple way to access state from anywhere in your application while robust and testable. -version: 3.0.0-dev.2 +version: 3.0.0-dev.3 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues diff --git a/packages/riverpod_annotation/CHANGELOG.md b/packages/riverpod_annotation/CHANGELOG.md index 85a10dd17..e6c7f2efb 100644 --- a/packages/riverpod_annotation/CHANGELOG.md +++ b/packages/riverpod_annotation/CHANGELOG.md @@ -1,3 +1,7 @@ +## 3.0.0-dev.3 - 2023-11-27 + +- `riverpod` upgraded to `3.0.0-dev.3` + ## 3.0.0-dev.2 - 2023-11-20 - `riverpod` upgraded to `3.0.0-dev.2` diff --git a/packages/riverpod_annotation/pubspec.yaml b/packages/riverpod_annotation/pubspec.yaml index 539f8725a..b5c0c3658 100644 --- a/packages/riverpod_annotation/pubspec.yaml +++ b/packages/riverpod_annotation/pubspec.yaml @@ -1,6 +1,6 @@ name: riverpod_annotation description: A package exposing annotations for riverpod_generator -version: 3.0.0-dev.2 +version: 3.0.0-dev.3 repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues funding: @@ -11,7 +11,7 @@ environment: dependencies: meta: ^1.7.0 - riverpod: ^3.0.0-dev.2 + riverpod: ^3.0.0-dev.3 dev_dependencies: test: ^1.21.0 diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 4af128c97..19db2a2da 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -1,3 +1,8 @@ +## 3.0.0-dev.11 - 2023-11-27 + +- `riverpod_annotation` upgraded to `3.0.0-dev.3` +- `riverpod` upgraded to `3.0.0-dev.3` + ## 3.0.0-dev.10 - 2023-11-20 - `riverpod_annotation` upgraded to `3.0.0-dev.2` diff --git a/packages/riverpod_generator/pubspec.yaml b/packages/riverpod_generator/pubspec.yaml index 9cfd76b7b..133750c63 100644 --- a/packages/riverpod_generator/pubspec.yaml +++ b/packages/riverpod_generator/pubspec.yaml @@ -1,6 +1,6 @@ name: riverpod_generator description: A code generator for Riverpod. This both simplifies the syntax empowers it, such as allowing stateful hot-reload. -version: 3.0.0-dev.10 +version: 3.0.0-dev.11 repository: https://github.com/rrousselGit/riverpod issue_tracker: https://github.com/rrousselGit/riverpod/issues funding: @@ -18,7 +18,7 @@ dependencies: meta: ^1.7.0 path: ^1.8.0 riverpod_analyzer_utils: ^1.0.0-dev.1 - riverpod_annotation: ^3.0.0-dev.2 + riverpod_annotation: ^3.0.0-dev.3 source_gen: ^1.2.0 dev_dependencies: @@ -26,5 +26,5 @@ dev_dependencies: build_verify: ^3.0.0 freezed: ^2.4.3 freezed_annotation: ^2.4.1 - riverpod: ^3.0.0-dev.2 + riverpod: ^3.0.0-dev.3 test: ^1.21.0 diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index 2e5e7cec9..30a352a82 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -1,3 +1,7 @@ +## 3.0.0-dev.4 - 2023-11-27 + +- `riverpod` upgraded to `3.0.0-dev.3` + ## 3.0.0-dev.3 - 2023-11-20 - `riverpod` upgraded to `3.0.0-dev.2` diff --git a/packages/riverpod_lint/pubspec.yaml b/packages/riverpod_lint/pubspec.yaml index e9e8b0b4e..97d81cdfd 100644 --- a/packages/riverpod_lint/pubspec.yaml +++ b/packages/riverpod_lint/pubspec.yaml @@ -1,6 +1,6 @@ name: riverpod_lint description: Riverpod_lint is a developer tool for users of Riverpod, designed to help stop common issues and simplify repetitive tasks. -version: 3.0.0-dev.3 +version: 3.0.0-dev.4 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/river_pod issue_tracker: https://github.com/rrousselGit/riverpod/issues @@ -17,7 +17,7 @@ dependencies: custom_lint_builder: ^0.5.2 meta: ^1.7.0 path: ^1.8.1 - riverpod: ^3.0.0-dev.2 + riverpod: ^3.0.0-dev.3 riverpod_analyzer_utils: ^1.0.0-dev.1 source_span: ^1.8.0 yaml: ^3.1.1 From 98c4475c213319d6ab861e43417c09468cc6881e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 29 Nov 2023 10:27:36 +0100 Subject: [PATCH 047/387] Wip --- .../lib/src/framework2/framework.dart | 32 +++++++++ .../generated_providers/examples.dart | 24 +++++++ .../generated_providers/examples.g.dart | 18 +++++ .../generated_providers/future_notifier.dart | 0 .../generated_providers/future_provider.dart | 0 .../generated_providers/stream_notifier.dart | 0 .../generated_providers/stream_provider.dart | 0 .../generated_providers/sync_notifier.dart | 0 .../generated_providers/sync_provider.dart | 35 ++++++++++ .../riverpod/lib/src/framework2/node.dart | 67 ++++++++++++++++++ .../riverpod/lib/src/framework2/override.dart | 25 +++++++ .../riverpod/lib/src/framework2/provider.dart | 30 ++++++++ .../src/framework2/provider_container.dart | 68 +++++++++++++++++++ .../lib/src/framework2/provider_element.dart | 17 +++++ .../src/framework2/provider_listenable.dart | 26 +++++++ .../lib/src/framework2/provider_observer.dart | 30 ++++++++ packages/riverpod/lib/src/framework2/ref.dart | 42 ++++++++++++ 17 files changed, 414 insertions(+) create mode 100644 packages/riverpod/lib/src/framework2/framework.dart create mode 100644 packages/riverpod/lib/src/framework2/generated_providers/examples.dart create mode 100644 packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart create mode 100644 packages/riverpod/lib/src/framework2/generated_providers/future_notifier.dart create mode 100644 packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart create mode 100644 packages/riverpod/lib/src/framework2/generated_providers/stream_notifier.dart create mode 100644 packages/riverpod/lib/src/framework2/generated_providers/stream_provider.dart create mode 100644 packages/riverpod/lib/src/framework2/generated_providers/sync_notifier.dart create mode 100644 packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart create mode 100644 packages/riverpod/lib/src/framework2/node.dart create mode 100644 packages/riverpod/lib/src/framework2/override.dart create mode 100644 packages/riverpod/lib/src/framework2/provider.dart create mode 100644 packages/riverpod/lib/src/framework2/provider_container.dart create mode 100644 packages/riverpod/lib/src/framework2/provider_element.dart create mode 100644 packages/riverpod/lib/src/framework2/provider_listenable.dart create mode 100644 packages/riverpod/lib/src/framework2/provider_observer.dart create mode 100644 packages/riverpod/lib/src/framework2/ref.dart diff --git a/packages/riverpod/lib/src/framework2/framework.dart b/packages/riverpod/lib/src/framework2/framework.dart new file mode 100644 index 000000000..4d0924fcb --- /dev/null +++ b/packages/riverpod/lib/src/framework2/framework.dart @@ -0,0 +1,32 @@ +import 'dart:async'; + +import 'package:meta/meta.dart'; + +import '../result.dart'; + +part 'provider_container.dart'; +part 'provider_observer.dart'; +part 'provider_listenable.dart'; +part 'provider_element.dart'; +part 'provider.dart'; +part 'ref.dart'; +part 'override.dart'; +part 'node.dart'; + +@internal +typedef OnError = void Function(Object error, StackTrace stackTrace); + +@internal +typedef ProviderListener = void Function( + StateT? previous, + StateT next, +); + +@internal +typedef VoidCallback = void Function(); + +@internal +typedef Build> = T Function(RefT ref); + +@internal +const kDebugMode = bool.fromEnvironment('dart.vm.product'); diff --git a/packages/riverpod/lib/src/framework2/generated_providers/examples.dart b/packages/riverpod/lib/src/framework2/generated_providers/examples.dart new file mode 100644 index 000000000..8928b5e30 --- /dev/null +++ b/packages/riverpod/lib/src/framework2/generated_providers/examples.dart @@ -0,0 +1,24 @@ +import '../framework.dart'; +import 'sync_provider.dart'; + +part 'examples.g.dart'; + +const riverpod = Object(); + +@riverpod +int syncExample(Ref ref) => 42; + +@riverpod +int syncExample2(Ref ref, {int? arg = 42}) => 42; + +@riverpod +class SyncExampleNotifier extends _$SyncExampleNotifier { + @override + int build(Ref ref) => syncExample(ref); +} + +@riverpod +class ScopedSyncExampleNotifier extends _$ScopedSyncExampleNotifier { + @override + int build(Ref ref); +} diff --git a/packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart b/packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart new file mode 100644 index 000000000..25688e66d --- /dev/null +++ b/packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart @@ -0,0 +1,18 @@ +part of 'examples.dart'; + +const syncExampleProvider = SyncExampleProvider._(); + +final class SyncExampleProvider extends SyncProvider { + const SyncExampleProvider._() + : super( + name: 'syncExample', + from: null, + arguments: null, + debugSource: kDebugMode + ? 'package:riverpod/src/framework2/generated_providers/examples.dart:syncExample' + : null, + ); + + @override + int build(Ref ref) => syncExample(ref); +} diff --git a/packages/riverpod/lib/src/framework2/generated_providers/future_notifier.dart b/packages/riverpod/lib/src/framework2/generated_providers/future_notifier.dart new file mode 100644 index 000000000..e69de29bb diff --git a/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart b/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart new file mode 100644 index 000000000..e69de29bb diff --git a/packages/riverpod/lib/src/framework2/generated_providers/stream_notifier.dart b/packages/riverpod/lib/src/framework2/generated_providers/stream_notifier.dart new file mode 100644 index 000000000..e69de29bb diff --git a/packages/riverpod/lib/src/framework2/generated_providers/stream_provider.dart b/packages/riverpod/lib/src/framework2/generated_providers/stream_provider.dart new file mode 100644 index 000000000..e69de29bb diff --git a/packages/riverpod/lib/src/framework2/generated_providers/sync_notifier.dart b/packages/riverpod/lib/src/framework2/generated_providers/sync_notifier.dart new file mode 100644 index 000000000..e69de29bb diff --git a/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart b/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart new file mode 100644 index 000000000..1320161f7 --- /dev/null +++ b/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart @@ -0,0 +1,35 @@ +import '../../result.dart'; +import '../framework.dart'; + +abstract base class SyncProvider extends Provider { + const SyncProvider({ + required super.name, + required super.from, + required super.arguments, + required super.debugSource, + }); + + StateT build(Ref ref); + + Override overrideWith(Build> create); + + Override overrideWithValue(StateT value); + + @override + SyncProviderElement createElement() => SyncProviderElement(this); +} + +class SyncProviderElement extends ProviderElement { + SyncProviderElement(this.provider); + + final SyncProvider provider; + + @override + void build(Ref ref) { + try { + result = Result.data(provider.build(ref)); + } catch (err, stack) { + result = Result.error(err, stack); + } + } +} diff --git a/packages/riverpod/lib/src/framework2/node.dart b/packages/riverpod/lib/src/framework2/node.dart new file mode 100644 index 000000000..7c577fd26 --- /dev/null +++ b/packages/riverpod/lib/src/framework2/node.dart @@ -0,0 +1,67 @@ +part of 'framework.dart'; + +@internal +class DebugDependentSource {} + +@internal +sealed class DebugConsumerDependentSource extends DebugDependentSource { + DebugConsumerDependentSource({required this.consumer}); + + final Consumer consumer; +} + +@internal +sealed class DebugProviderDependentSource extends DebugDependentSource { + DebugProviderDependentSource({required this.provider}); + + final Provider provider; +} + +@internal +sealed class DebugRefWatchDependentSource extends DebugProviderDependentSource { + DebugRefWatchDependentSource({required super.provider}) : super(); +} + +@internal +sealed class DebugRefListenDependentSource + extends DebugProviderDependentSource { + DebugRefListenDependentSource({required super.provider}) : super(); +} + +@internal +sealed class DebugRefReadDependentSource extends DebugProviderDependentSource { + DebugRefReadDependentSource({required super.provider}) : super(); +} + +@internal +sealed class DebugRefInvalidateDependentSource + extends DebugProviderDependentSource { + DebugRefInvalidateDependentSource({required super.provider}) : super(); +} + +@internal +sealed class DebugRefRefreshDependentSource + extends DebugProviderDependentSource { + DebugRefRefreshDependentSource({required super.provider}) : super(); +} + +@internal +class Node { + Node({ + required this.owner, + required this.element, + }); + + final ProviderContainer owner; + final ProviderElement element; + + final _debugDependentSources = []; + final _listeners = >[]; + + ProviderSubscription addListener( + ProviderListener listener, { + required DebugDependentSource? debugDependents, + required OnError? onError, + required bool fireImmediately, + }) {} +} diff --git a/packages/riverpod/lib/src/framework2/override.dart b/packages/riverpod/lib/src/framework2/override.dart new file mode 100644 index 000000000..d43331ba5 --- /dev/null +++ b/packages/riverpod/lib/src/framework2/override.dart @@ -0,0 +1,25 @@ +part of 'framework.dart'; + +@immutable +sealed class Override { + const Override({required this.origin}); + + @internal + final Provider origin; +} + +@internal +final class OverrideWithValue extends Override { + const OverrideWithValue(this.value, {required super.origin}); + + @internal + final StateT value; +} + +@internal +abstract class OverrideWithCreate extends Override { + const OverrideWithCreate({required super.origin}); + + @internal + StateT create(ProviderElement ref); +} diff --git a/packages/riverpod/lib/src/framework2/provider.dart b/packages/riverpod/lib/src/framework2/provider.dart new file mode 100644 index 000000000..7645842ae --- /dev/null +++ b/packages/riverpod/lib/src/framework2/provider.dart @@ -0,0 +1,30 @@ +part of 'framework.dart'; + +abstract class ProviderListenableOrFamily {} + +abstract class ProviderOrFamily {} + +abstract base class Family implements ProviderOrFamily { + const Family(); +} + +@immutable +@renameProviderBaseToPRovider() +abstract base class Provider + with ProviderListenable + implements ProviderOrFamily { + const Provider({ + required this.name, + required this.from, + required this.arguments, + required this.debugSource, + }); + + final String name; + final Family? from; + final String? debugSource; + + @Deprecated('Use arguments') + Object? get argument => arguments; + final Object? arguments; +} diff --git a/packages/riverpod/lib/src/framework2/provider_container.dart b/packages/riverpod/lib/src/framework2/provider_container.dart new file mode 100644 index 000000000..982204b22 --- /dev/null +++ b/packages/riverpod/lib/src/framework2/provider_container.dart @@ -0,0 +1,68 @@ +part of 'framework.dart'; + +class _Pointer { + _Pointer({required this.isFromOverride}); + + final bool isFromOverride; + ProviderElement? element; +} + +class ProviderContainer { + ProviderContainer({ + this.parent, + List overrides = const [], + List? observers, + }) : root = parent?.root ?? parent; + + @visibleForTesting + factory ProviderContainer.test({ + ProviderContainer? parent, + List overrides = const [], + List? observers, + }) { + final container = ProviderContainer( + parent: parent, + overrides: overrides, + observers: observers, + ); + addTearDown(container.dispose); + + return container; + } + + final ProviderContainer? root; + final ProviderContainer? parent; + final _children = []; + final Map, ProviderElement> _providerPointers; + + void updateOverrides(List overrides); + + void debugReassemble(); + + void invalidate(ProviderOrFamily provider); + StateT refresh(Refreshable provider); + + StateT read(ProviderListenable provider) { + final subscription = listen(provider, (_, value) {}); + try { + return subscription.read(); + } finally { + subscription.close(); + } + } + + ProviderSubscription listen( + ProviderListenable provider, + void Function(StateT? previous, StateT next) listener, { + bool fireImmediately = false, + void Function(Object error, StackTrace stackTrace)? onError, + }); + + bool exists(Provider provider); + + Future pump(); + + void dispose() { + parent?._children.remove(this); + } +} diff --git a/packages/riverpod/lib/src/framework2/provider_element.dart b/packages/riverpod/lib/src/framework2/provider_element.dart new file mode 100644 index 000000000..8cdfda144 --- /dev/null +++ b/packages/riverpod/lib/src/framework2/provider_element.dart @@ -0,0 +1,17 @@ +part of 'framework.dart'; + +abstract class ProviderElement { + Result? _result; + Result? get result => _result; + set result(Result? value) => _result = value; + + FutureOr build(Ref ref); + + void markNeedsReload() { + throw UnimplementedError(); + } + + void markNeedsRefresh() { + throw UnimplementedError(); + } +} diff --git a/packages/riverpod/lib/src/framework2/provider_listenable.dart b/packages/riverpod/lib/src/framework2/provider_listenable.dart new file mode 100644 index 000000000..99b9e113b --- /dev/null +++ b/packages/riverpod/lib/src/framework2/provider_listenable.dart @@ -0,0 +1,26 @@ +part of 'framework.dart'; + +@immutable +mixin ProviderListenable implements ProviderListenableOrFamily { + ProviderSubscription addListener( + ProviderContainer container, + void Function(StateT? previous, StateT next) listener, { + bool fireImmediately = false, + void Function(Object error, StackTrace stackTrace)? onError, + }); + + ProviderListenable select(T Function(StateT value) selector) {} +} + +abstract class ProviderSubscription { + const ProviderSubscription(); + + StateT read(); + + void pause(); + void resume(); + + void close(); +} + +mixin Refreshable on ProviderListenable {} diff --git a/packages/riverpod/lib/src/framework2/provider_observer.dart b/packages/riverpod/lib/src/framework2/provider_observer.dart new file mode 100644 index 000000000..0b7e88760 --- /dev/null +++ b/packages/riverpod/lib/src/framework2/provider_observer.dart @@ -0,0 +1,30 @@ +part of 'framework.dart'; + +abstract class ProviderObserver { + const ProviderObserver(); + + void didAddProvider( + Provider provider, + Object? value, + ProviderContainer container, + ) {} + + void providerDidFail( + Provider provider, + Object error, + StackTrace stackTrace, + ProviderContainer container, + ) {} + + void didUpdateProvider( + Provider provider, + Object? previousValue, + Object? newValue, + ProviderContainer container, + ) {} + + void didDisposeProvider( + Provider provider, + ProviderContainer container, + ) {} +} diff --git a/packages/riverpod/lib/src/framework2/ref.dart b/packages/riverpod/lib/src/framework2/ref.dart new file mode 100644 index 000000000..099fc9d8e --- /dev/null +++ b/packages/riverpod/lib/src/framework2/ref.dart @@ -0,0 +1,42 @@ +part of 'framework.dart'; + +class Ref { + Ref._(this._element); + + final ProviderElement _element; + + ProviderContainer get container => _element.container; + + abstract StateT state; + + FutureOr get future; + + @useResult + T refresh(Refreshable provider); + void invalidate(ProviderOrFamily provider); + void invalidateSelf({bool isReload = false}); + + void notifyListeners(); + + void onAddListener(VoidCallback cb); + void onRemoveListener(VoidCallback cb); + void onResume(VoidCallback cb); + void onCancel(VoidCallback cb); + void onDispose(VoidCallback cb); + + bool exists(Provider provider); + + T read(ProviderListenable provider); + T watch(ProviderListenable provider); + + ProviderSubscription listen( + ProviderListenable provider, + ProviderListener listener, { + OnError? onError, + bool fireImmediately = false, + }); + void listenSelf( + ProviderListener listener, { + OnError? onError, + }); +} From 4670b17466cd974a0e586d21b6368dc64e25f844 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 2 Dec 2023 11:07:13 +0100 Subject: [PATCH 048/387] w --- .../dependency_sources/consumer.dart | 9 + .../dependency_sources/container.dart | 29 +++ .../dependency_sources/provider.dart | 35 ++++ .../lib/src/framework2/framework.dart | 5 + .../generated_providers/examples.dart | 2 + .../generated_providers/examples.g.dart | 26 ++- .../riverpod/lib/src/framework2/node.dart | 56 +----- .../riverpod/lib/src/framework2/provider.dart | 118 ++++++++++- .../src/framework2/provider_container.dart | 183 ++++++++++++++++-- .../lib/src/framework2/provider_element.dart | 27 +++ .../src/framework2/provider_listenable.dart | 6 +- packages/riverpod/lib/src/framework2/ref.dart | 22 ++- packages/riverpod/pubspec.yaml | 2 +- 13 files changed, 452 insertions(+), 68 deletions(-) create mode 100644 packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart create mode 100644 packages/riverpod/lib/src/framework2/dependency_sources/container.dart create mode 100644 packages/riverpod/lib/src/framework2/dependency_sources/provider.dart diff --git a/packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart b/packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart new file mode 100644 index 000000000..e37ec08ff --- /dev/null +++ b/packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart @@ -0,0 +1,9 @@ +part of '../framework.dart'; + +@internal +sealed class DebugConsumerDependentSource extends DebugDependentSource { + DebugConsumerDependentSource({required this.consumer, required this.element}); + + final Consumer consumer; + final Element element; +} diff --git a/packages/riverpod/lib/src/framework2/dependency_sources/container.dart b/packages/riverpod/lib/src/framework2/dependency_sources/container.dart new file mode 100644 index 000000000..c252838d4 --- /dev/null +++ b/packages/riverpod/lib/src/framework2/dependency_sources/container.dart @@ -0,0 +1,29 @@ +part of '../framework.dart'; + +@internal +sealed class DebugProviderContainerDependentSource + extends DebugDependentSource { + DebugProviderContainerDependentSource._({required this.container}); + + final ProviderContainer container; +} + +@internal +final class DebugProviderContainerListenDependentSource + extends DebugDependentSource { + DebugProviderContainerListenDependentSource({ + required this.container, + }); + + final ProviderContainer container; +} + +@internal +final class DebugProviderContainerReadDependentSource + extends DebugDependentSource { + DebugProviderContainerReadDependentSource({ + required this.container, + }); + + final ProviderContainer container; +} diff --git a/packages/riverpod/lib/src/framework2/dependency_sources/provider.dart b/packages/riverpod/lib/src/framework2/dependency_sources/provider.dart new file mode 100644 index 000000000..99d4bc059 --- /dev/null +++ b/packages/riverpod/lib/src/framework2/dependency_sources/provider.dart @@ -0,0 +1,35 @@ +part of '../framework.dart'; + +@internal +sealed class DebugProviderDependentSource extends DebugDependentSource { + DebugProviderDependentSource._({required this.provider}); + + final Provider provider; +} + +@internal +final class DebugRefWatchDependentSource extends DebugProviderDependentSource { + DebugRefWatchDependentSource({required super.provider}) : super._(); +} + +@internal +final class DebugRefListenDependentSource extends DebugProviderDependentSource { + DebugRefListenDependentSource({required super.provider}) : super._(); +} + +@internal +final class DebugRefReadDependentSource extends DebugProviderDependentSource { + DebugRefReadDependentSource({required super.provider}) : super._(); +} + +@internal +final class DebugRefInvalidateDependentSource + extends DebugProviderDependentSource { + DebugRefInvalidateDependentSource({required super.provider}) : super._(); +} + +@internal +final class DebugRefRefreshDependentSource + extends DebugProviderDependentSource { + DebugRefRefreshDependentSource({required super.provider}) : super._(); +} diff --git a/packages/riverpod/lib/src/framework2/framework.dart b/packages/riverpod/lib/src/framework2/framework.dart index 4d0924fcb..00d301aa0 100644 --- a/packages/riverpod/lib/src/framework2/framework.dart +++ b/packages/riverpod/lib/src/framework2/framework.dart @@ -1,6 +1,8 @@ import 'dart:async'; +import 'dart:collection'; import 'package:meta/meta.dart'; +import 'package:test/test.dart' as test; import '../result.dart'; @@ -12,6 +14,9 @@ part 'provider.dart'; part 'ref.dart'; part 'override.dart'; part 'node.dart'; +part 'dependency_sources/consumer.dart'; +part 'dependency_sources/container.dart'; +part 'dependency_sources/provider.dart'; @internal typedef OnError = void Function(Object error, StackTrace stackTrace); diff --git a/packages/riverpod/lib/src/framework2/generated_providers/examples.dart b/packages/riverpod/lib/src/framework2/generated_providers/examples.dart index 8928b5e30..8538ca2fb 100644 --- a/packages/riverpod/lib/src/framework2/generated_providers/examples.dart +++ b/packages/riverpod/lib/src/framework2/generated_providers/examples.dart @@ -1,3 +1,5 @@ +import 'package:meta/meta.dart'; + import '../framework.dart'; import 'sync_provider.dart'; diff --git a/packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart b/packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart index 25688e66d..9c9e6b36b 100644 --- a/packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart +++ b/packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart @@ -9,10 +9,34 @@ final class SyncExampleProvider extends SyncProvider { from: null, arguments: null, debugSource: kDebugMode - ? 'package:riverpod/src/framework2/generated_providers/examples.dart:syncExample' + ? const DebugProviderSource( + name: 'syncExample', + file: + 'package:riverpod/src/framework2/generated_providers/examples.dart:syncExample', + line: 42, + column: 42, + hash: '123', + ) : null, ); @override int build(Ref ref) => syncExample(ref); + + static ProviderContainer? _$root; + + /// For unscoped providers, we can circumvent the override and map lookup + /// by statically caching the element. + /// This is only a performance optimization and should not be relied upon. + static ProviderElement? _$element; + + @override + ProviderElement getElement(ProviderContainer container) { + final target = container.root ?? container; + + final element = _$element; + if (element != null && _$root == target) return element; + + return _$element = super.getElement(_$root = target); + } } diff --git a/packages/riverpod/lib/src/framework2/node.dart b/packages/riverpod/lib/src/framework2/node.dart index 7c577fd26..cfe762dd6 100644 --- a/packages/riverpod/lib/src/framework2/node.dart +++ b/packages/riverpod/lib/src/framework2/node.dart @@ -1,48 +1,15 @@ part of 'framework.dart'; @internal -class DebugDependentSource {} +@immutable +abstract class DebugDependentSource { + @mustBeOverridden + @override + bool operator ==(Object other); -@internal -sealed class DebugConsumerDependentSource extends DebugDependentSource { - DebugConsumerDependentSource({required this.consumer}); - - final Consumer consumer; -} - -@internal -sealed class DebugProviderDependentSource extends DebugDependentSource { - DebugProviderDependentSource({required this.provider}); - - final Provider provider; -} - -@internal -sealed class DebugRefWatchDependentSource extends DebugProviderDependentSource { - DebugRefWatchDependentSource({required super.provider}) : super(); -} - -@internal -sealed class DebugRefListenDependentSource - extends DebugProviderDependentSource { - DebugRefListenDependentSource({required super.provider}) : super(); -} - -@internal -sealed class DebugRefReadDependentSource extends DebugProviderDependentSource { - DebugRefReadDependentSource({required super.provider}) : super(); -} - -@internal -sealed class DebugRefInvalidateDependentSource - extends DebugProviderDependentSource { - DebugRefInvalidateDependentSource({required super.provider}) : super(); -} - -@internal -sealed class DebugRefRefreshDependentSource - extends DebugProviderDependentSource { - DebugRefRefreshDependentSource({required super.provider}) : super(); + @mustBeOverridden + @override + int get hashCode; } @internal @@ -57,11 +24,4 @@ class Node { final _debugDependentSources = []; final _listeners = >[]; - - ProviderSubscription addListener( - ProviderListener listener, { - required DebugDependentSource? debugDependents, - required OnError? onError, - required bool fireImmediately, - }) {} } diff --git a/packages/riverpod/lib/src/framework2/provider.dart b/packages/riverpod/lib/src/framework2/provider.dart index 7645842ae..71d4e6710 100644 --- a/packages/riverpod/lib/src/framework2/provider.dart +++ b/packages/riverpod/lib/src/framework2/provider.dart @@ -8,8 +8,50 @@ abstract base class Family implements ProviderOrFamily { const Family(); } +/// {@template debug_provider_source} +/// Debug information about where a provider was defined. +/// +/// This can enable better error messages and better debugging experience. +/// For instance, it enables the devtool to open the IDE at the location +/// where the provider was defined. +/// {@endtemplate} +@internal +class DebugProviderSource { + const DebugProviderSource({ + required this.name, + required this.file, + required this.line, + required this.column, + required this.hash, + }); + + /// The name of the provider, as in the code. + final String name; + + /// The absolute path to the file where this provider was defined. + final String file; + + /// The line where this provider was defined. + final int line; + + /// The column where this provider was defined. + final int column; + + /// A hash of the source of this provider. + /// + /// This is used to determine if a provider was changed by a hot-reload. + final String hash; +} + +@deprecated +const renameProviderBaseToPRovider = Object(); + +abstract class NotifierProvider { + Refreshable get notifier; +} + @immutable -@renameProviderBaseToPRovider() +@renameProviderBaseToPRovider abstract base class Provider with ProviderListenable implements ProviderOrFamily { @@ -18,13 +60,85 @@ abstract base class Provider required this.from, required this.arguments, required this.debugSource, + required this.dependencies, + required this.allTransitiveDependencies, + required this.isAlwaysAlive, }); + /// Whether the provider isn't automatically disposed when all its listeners + /// are removed. + /// + /// This is used for linting purposes. + final bool isAlwaysAlive; + + /// A debug name for this provider. + /// + /// This changes error messages, [toString] and other debug messages. final String name; + + /// The "family" that owns this provider. + /// + /// A provider is part of a family if it has parameters. + /// In which case, the parameters used can be retrieved with [arguments]. final Family? from; - final String? debugSource; + /// Debug information about where this provider was defined. + /// + /// This is prefilled by the code-generator. + final DebugProviderSource? debugSource; + + /// {@macro provider_arguments} @Deprecated('Use arguments') Object? get argument => arguments; + + /// {@template provider_arguments} + /// The arguments used to create this provider. + /// + /// If created using the code-generator, this will be a [Record] of all + /// the parameters used to create this provider. + /// {@endtemplate} final Object? arguments; + + final List? dependencies; + final List? allTransitiveDependencies; + + /// A method that always create a new [ProviderElement]. + @visibleForOverriding + ProviderElement createElement(ProviderContainer container); + + /// A method for fast lookup of the [ProviderElement] associated to this provider. + /// + /// Providers that cannot be "scoped" may obtain their [ProviderElement] from + /// the "root" [ProviderContainer]. + /// + /// Providers may override this for even faster lookup, such as by caching + /// the [ProviderElement] in a static field. + @visibleForOverriding + ProviderElement getElement(ProviderContainer container) { + if (dependencies == null) { + container.root._readProviderElement(this); + } + return container._readProviderElement(this); + } + + @override + ProviderSubscription addListener( + ProviderContainer container, + void Function(StateT? previous, StateT next) listener, { + required bool fireImmediately, + required void Function(Object error, StackTrace stackTrace)? onError, + required DebugDependentSource? debugDependentSource, + }) { + final element = getElement(container); + + final subscription = element.addListener( + container, + listener, + fireImmediately: fireImmediately, + onError: onError, + debugDependentSource: debugDependentSource, + ); + + return ProviderSubscription._(subscription, element); + } } diff --git a/packages/riverpod/lib/src/framework2/provider_container.dart b/packages/riverpod/lib/src/framework2/provider_container.dart index 982204b22..d429e162a 100644 --- a/packages/riverpod/lib/src/framework2/provider_container.dart +++ b/packages/riverpod/lib/src/framework2/provider_container.dart @@ -1,18 +1,133 @@ part of 'framework.dart'; -class _Pointer { - _Pointer({required this.isFromOverride}); +class _ProviderPointer { + _ProviderPointer({required this.isFromOverride}); + /// Whether this pointer was created from an override. + /// + /// If so, this pointer should **never** be removed. final bool isFromOverride; ProviderElement? element; } +/// An object responsible for storing the a O(1) access to providers, +/// while also enabling the "scoping" of providers and ensuring all [ProviderContainer]s +/// are in sync. +/// +/// Instead of storing a [Map]. +/// +/// Then, when overriding a provider, it is guaranteed that the [ProviderContainer] +/// and all of its children have the same [_ProviderPointer] for a overridden provider. +/// +/// This way, we can read an overridden provider from any of the [ProviderContainer]s. +/// And no-matter where the first read is made, all [ProviderContainer]s will +/// share the same state. +class _ProviderPointers { + _ProviderPointers() + : orphanPointers = HashMap(), + familyPointers = HashMap(); + + _ProviderPointers.from(ProviderContainer parent) + : orphanPointers = HashMap.from(parent._providerPointers.orphanPointers), + familyPointers = HashMap.from(parent._providerPointers.familyPointers); + + late final ProviderContainer container; + final HashMap, _ProviderPointer> orphanPointers; + final HashMap, _ProviderPointer>> + familyPointers; + + /// Obtain and possibly mount the [ProviderElement] for a provider. + ProviderElement add( + Provider provider, { + required bool isFromOverride, + required DebugDependentSource? debugDependentSource, + }) { + final from = provider.from; + + _ProviderPointer mount() { + final pointer = _ProviderPointer(isFromOverride: isFromOverride); + final element = provider.createElement(container); + pointer.element = element; + return pointer; + } + + if (from == null) { + final pointer = orphanPointers.putIfAbsent(provider, mount); + + return pointer.element!; + } else { + final familyPointers = this.familyPointers.putIfAbsent(from, HashMap.new); + final pointer = familyPointers.putIfAbsent(provider, mount); + + return pointer.element!; + } + } + + /// Obtain the pointer for a provider. Noop if it doesn't exist. + _ProviderPointer? _readPointer(Provider provider) { + final from = provider.from; + + if (from == null) { + return orphanPointers[provider]; + } else { + return familyPointers[from]?[provider]; + } + } + + /// Read the [ProviderElement] for a provider, without creating it if it doesn't exist. + ProviderElement? read( + Provider provider, { + required DebugDependentSource? debugDependentSource, + }) { + return _readPointer(provider)?.element; + } + + /// Remove a provider from this container. + /// + /// Noop if the provider is from an override or doesn't exist. + void remove(Provider provider) { + final pointer = _readPointer(provider); + // If null, nothing to remove. If from an override, must not be removed. + if (pointer == null || pointer.isFromOverride) { + return; + } + + final from = provider.from; + + if (from == null) { + orphanPointers.remove(provider); + } else { + final familyPointer = familyPointers[from]; + + // Nothing to remove + if (familyPointer == null) return; + familyPointer.remove(provider); + + // Cleanup family if empty + + // The family isn't empty, nothing to do + if (familyPointer.isNotEmpty) return; + // The family is empty, remove it. + // It should be guaranteed that there this won't remove scoped provider pointers + // as there's a "isFromOverride" check at the beginning of this method. + familyPointers.remove(from); + } + } +} + class ProviderContainer { ProviderContainer({ this.parent, List overrides = const [], List? observers, - }) : root = parent?.root ?? parent; + }) : root = parent?.root ?? parent, + _providerPointers = parent != null + ? _ProviderPointers.from(parent) + : _ProviderPointers() { + _providerPointers.container = this; + _initializeOverrides(overrides); + } @visibleForTesting factory ProviderContainer.test({ @@ -25,7 +140,7 @@ class ProviderContainer { overrides: overrides, observers: observers, ); - addTearDown(container.dispose); + test.addTearDown(container.dispose); return container; } @@ -33,17 +148,46 @@ class ProviderContainer { final ProviderContainer? root; final ProviderContainer? parent; final _children = []; - final Map, ProviderElement> _providerPointers; + final _ProviderPointers _providerPointers; void updateOverrides(List overrides); void debugReassemble(); - void invalidate(ProviderOrFamily provider); - StateT refresh(Refreshable provider); + void invalidate( + ProviderOrFamily provider, { + @internal DebugDependentSource? debugDependentSource, + }) { + _providerPointers.read(provider)?.markNeedsRefresh(); + _addDependency(provider, StackTrace.current); + } + + StateT refresh( + Refreshable provider, { + @internal DebugDependentSource? debugDependentSource, + }) { + invalidate(provider, debugDependentSource: debugDependentSource); + _addDependency(provider, StackTrace.current); + } + + ProviderElement _insertProvider(Provider provider) { + return _providerPointers.add( + provider, + // If the provider points to an override, a pointer should already be set. + // So always using `false` isn't an issue. + isFromOverride: false, + ) as ProviderElement; + } - StateT read(ProviderListenable provider) { - final subscription = listen(provider, (_, value) {}); + StateT read( + ProviderListenable provider, { + @internal DebugDependentSource? debugDependentSource, + }) { + final subscription = listen( + provider, + (_, value) {}, + debugDependentSource: debugDependentSource ?? DebugRead, + ); try { return subscription.read(); } finally { @@ -56,9 +200,26 @@ class ProviderContainer { void Function(StateT? previous, StateT next) listener, { bool fireImmediately = false, void Function(Object error, StackTrace stackTrace)? onError, - }); + @internal DebugDependentSource? debugDependentSource, + }) { + provider.addListener( + this, + listener, + fireImmediately: fireImmediately, + onError: onError, + debugDependentSource: kDebugMode + ? debugDependentSource ?? + DebugProviderContainerListenDependentSource(container: this) + : null, + ); + } - bool exists(Provider provider); + bool exists( + Provider provider, { + @internal DebugDependentSource? debugDependentSource, + }) { + return _providerPointers.read(provider) != null; + } Future pump(); diff --git a/packages/riverpod/lib/src/framework2/provider_element.dart b/packages/riverpod/lib/src/framework2/provider_element.dart index 8cdfda144..099bd1ad9 100644 --- a/packages/riverpod/lib/src/framework2/provider_element.dart +++ b/packages/riverpod/lib/src/framework2/provider_element.dart @@ -1,10 +1,37 @@ part of 'framework.dart'; +/// The element of a provider is a class responsible for managing the state +/// of a provider. +/// +/// It is responsible for: +/// - Initializing the provider +/// - Recomputing the provider when requested (such as with [Ref.watch] or [Ref.invalidate]) +/// - Disposing the state abstract class ProviderElement { + ProviderElement(this.container); + + /// The provider associated with this [ProviderElement]. + Provider get provider; + + /// The container where this [ProviderElement] is attached to. + final ProviderContainer container; + Result? _result; + + /// The current state of this provider. + /// + /// This is `null` until the provider has been initialized. + /// The state may be in error state, which can be checked using [Result]. Result? get result => _result; + + /// Set the current state of this provider. + /// + /// This will notify listeners if: + /// - invoked after the provider has finished initializing + /// - and if the new state is different from the previous one set result(Result? value) => _result = value; + @visibleForOverriding FutureOr build(Ref ref); void markNeedsReload() { diff --git a/packages/riverpod/lib/src/framework2/provider_listenable.dart b/packages/riverpod/lib/src/framework2/provider_listenable.dart index 99b9e113b..c4ee85956 100644 --- a/packages/riverpod/lib/src/framework2/provider_listenable.dart +++ b/packages/riverpod/lib/src/framework2/provider_listenable.dart @@ -2,11 +2,13 @@ part of 'framework.dart'; @immutable mixin ProviderListenable implements ProviderListenableOrFamily { + @visibleForOverriding ProviderSubscription addListener( ProviderContainer container, void Function(StateT? previous, StateT next) listener, { - bool fireImmediately = false, - void Function(Object error, StackTrace stackTrace)? onError, + required bool fireImmediately, + required void Function(Object error, StackTrace stackTrace)? onError, + required DebugDependentSource? debugDependentSource, }); ProviderListenable select(T Function(StateT value) selector) {} diff --git a/packages/riverpod/lib/src/framework2/ref.dart b/packages/riverpod/lib/src/framework2/ref.dart index 099fc9d8e..c62531ffd 100644 --- a/packages/riverpod/lib/src/framework2/ref.dart +++ b/packages/riverpod/lib/src/framework2/ref.dart @@ -7,6 +7,8 @@ class Ref { ProviderContainer get container => _element.container; + // Explain that calling `state=` while the provider is synchronously building will not notify listeners + // And that if no state= is called, then after the synchronous execution has completed, the current state will be emitted abstract StateT state; FutureOr get future; @@ -14,7 +16,8 @@ class Ref { @useResult T refresh(Refreshable provider); void invalidate(ProviderOrFamily provider); - void invalidateSelf({bool isReload = false}); + void invalidateSelf() => _element.markNeedsRefresh(); + void reloadSelf() => _element.markNeedsReload(); void notifyListeners(); @@ -26,8 +29,21 @@ class Ref { bool exists(Provider provider); - T read(ProviderListenable provider); - T watch(ProviderListenable provider); + T read(ProviderListenable provider) { + final subscription = listen(provider, (_, value) {}); + try { + return subscription.read(); + } finally { + subscription.close(); + } + } + + T watch(ProviderListenable provider) { + final subscription = listen(provider, (_, value) => reloadSelf()); + onDispose(subscription.close); + + return subscription.read(); + } ProviderSubscription listen( ProviderListenable provider, diff --git a/packages/riverpod/pubspec.yaml b/packages/riverpod/pubspec.yaml index e8cad4e8e..e807c9a6f 100644 --- a/packages/riverpod/pubspec.yaml +++ b/packages/riverpod/pubspec.yaml @@ -16,10 +16,10 @@ dependencies: meta: ^1.9.0 stack_trace: ^1.10.0 state_notifier: ">=0.7.2 <2.0.0" + test: ^1.0.0 dev_dependencies: analyzer: ">=5.12.0 <7.0.0" expect_error: ^1.0.0 mockito: ^5.0.0 - test: ^1.16.0 trotter: ^2.0.0-dev.1 From 7ccf425bc9d76ae914ac243d2aeccb7c916c7923 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 4 Dec 2023 11:36:24 +0100 Subject: [PATCH 049/387] w --- .../lib/src/framework2/framework.dart | 15 +- .../riverpod/lib/src/framework2/provider.dart | 5 +- .../src/framework2/provider_container.dart | 7 +- .../lib/src/framework2/provider_element.dart | 266 ++++++++++++++++-- .../src/framework2/provider_listenable.dart | 27 +- packages/riverpod/lib/src/framework2/ref.dart | 26 +- packages/riverpod/lib/src/tenable.dart | 104 +++++++ packages/riverpod/pubspec.yaml | 2 +- 8 files changed, 421 insertions(+), 31 deletions(-) create mode 100644 packages/riverpod/lib/src/tenable.dart diff --git a/packages/riverpod/lib/src/framework2/framework.dart b/packages/riverpod/lib/src/framework2/framework.dart index 00d301aa0..c964b0ab8 100644 --- a/packages/riverpod/lib/src/framework2/framework.dart +++ b/packages/riverpod/lib/src/framework2/framework.dart @@ -1,10 +1,12 @@ import 'dart:async'; import 'dart:collection'; +import 'dart:math' as math; import 'package:meta/meta.dart'; import 'package:test/test.dart' as test; -import '../result.dart'; +import '../common.dart'; +import '../tenable.dart'; part 'provider_container.dart'; part 'provider_observer.dart'; @@ -27,6 +29,17 @@ typedef ProviderListener = void Function( StateT next, ); +@internal +typedef OnAddListener = VoidCallback; +@internal +typedef OnRemoveListener = VoidCallback; +@internal +typedef OnResume = VoidCallback; +@internal +typedef OnCancel = VoidCallback; +@internal +typedef OnDispose = VoidCallback; + @internal typedef VoidCallback = void Function(); diff --git a/packages/riverpod/lib/src/framework2/provider.dart b/packages/riverpod/lib/src/framework2/provider.dart index 71d4e6710..21b50c7f4 100644 --- a/packages/riverpod/lib/src/framework2/provider.dart +++ b/packages/riverpod/lib/src/framework2/provider.dart @@ -128,15 +128,18 @@ abstract base class Provider required bool fireImmediately, required void Function(Object error, StackTrace stackTrace)? onError, required DebugDependentSource? debugDependentSource, + required ProviderElement? dependent, + required void Function()? onCancel, }) { final element = getElement(container); final subscription = element.addListener( - container, listener, fireImmediately: fireImmediately, onError: onError, debugDependentSource: debugDependentSource, + dependent: dependent, + onCancel: onCancel, ); return ProviderSubscription._(subscription, element); diff --git a/packages/riverpod/lib/src/framework2/provider_container.dart b/packages/riverpod/lib/src/framework2/provider_container.dart index d429e162a..9925a23c5 100644 --- a/packages/riverpod/lib/src/framework2/provider_container.dart +++ b/packages/riverpod/lib/src/framework2/provider_container.dart @@ -197,10 +197,11 @@ class ProviderContainer { ProviderSubscription listen( ProviderListenable provider, - void Function(StateT? previous, StateT next) listener, { + ProviderListener listener, { bool fireImmediately = false, - void Function(Object error, StackTrace stackTrace)? onError, - @internal DebugDependentSource? debugDependentSource, + OnError? onError, + DebugDependentSource? debugDependentSource, + OnCancel? onCancel, }) { provider.addListener( this, diff --git a/packages/riverpod/lib/src/framework2/provider_element.dart b/packages/riverpod/lib/src/framework2/provider_element.dart index 099bd1ad9..6107acdc9 100644 --- a/packages/riverpod/lib/src/framework2/provider_element.dart +++ b/packages/riverpod/lib/src/framework2/provider_element.dart @@ -1,5 +1,10 @@ part of 'framework.dart'; +enum _DirtyType { + reload, + refresh, +} + /// The element of a provider is a class responsible for managing the state /// of a provider. /// @@ -16,29 +21,258 @@ abstract class ProviderElement { /// The container where this [ProviderElement] is attached to. final ProviderContainer container; - Result? _result; + _DirtyType? _dirty; - /// The current state of this provider. - /// - /// This is `null` until the provider has been initialized. - /// The state may be in error state, which can be checked using [Result]. - Result? get result => _result; + /// What this provider is currently listening to. + List> _subscriptions = []; - /// Set the current state of this provider. - /// - /// This will notify listeners if: - /// - invoked after the provider has finished initializing - /// - and if the new state is different from the previous one - set result(Result? value) => _result = value; + /// The listeners listening to this provider. + List> _listeners = []; + + // The various life-cycles listeners of a provider. + // We store them in the element instead of Ref for performance reasons. + // This avoids having to create a new list for each Ref and is less DC intensive. + final _onDispose = VoidNotifier(); + final _onAddListener = VoidNotifier(); + final _onRemoveListener = VoidNotifier(); + final _onResume = VoidNotifier(); + final _onPause = VoidNotifier(); + + Ref? _ref; + AsyncValue? _result; + + AsyncValue requestState() { + container.scheduler.performRebuilds(); + + final result = _result; + if (result != null) return result; + } + + void _runProviderBuild() { + assert(_dirty != null); + + _dirty = null; + + setLoading(); + final ref = _ref = Ref._(this); + + List>? previousSubscriptions = _subscriptions; + _subscriptions = []; + + void closePreviousSubscriptions() { + for (final subscription in previousSubscriptions!) { + subscription.close(); + } + previousSubscriptions = null; + } + + // Prevent listeners from being notified while we are building. + assert(_lockNotifyListeners()); + + final tenable = Tenable.fromFutureOr(() => build(ref)); + // Once "build" has completed, we fully close previous subscriptions. + tenable.whenComplete(closePreviousSubscriptions); + + // If "build" completed synchronously, subscriptions should already be closed. + // No need to pause them. + // We pause subscriptions _after_ starting build, for the sake of efficiency. + // This avoids both pausing and closing subscriptions in a quick succession. + if (previousSubscriptions != null) { + // Pause previous subscriptions to disable them while "build" is running. + // This avoids unnecessary work in providers that may not be used anymore. + for (final subscription in previousSubscriptions!) { + subscription.pause(); + } + } + + assert(_unlockNotifyListeners()); + assert(_result != null); + // We notify listeners after "build" has completed. + // This avoids notifying listeners multiple times if multiple state change + // operations are performed at once. + _notifyListeners(); + } + + void setLoading(); + void setError(Object error, StackTrace stackTrace); + void setDats(StateT value); + + ProviderSubscription addListener( + ProviderListener listener, { + required bool fireImmediately, + required OnError? onError, + required DebugDependentSource? debugDependentSource, + required ProviderElement? dependent, + required OnCancel? onCancel, + }) { + final subscription = _ProviderSubscription( + this, + listener, + fireImmediately: fireImmediately, + onError: onError, + debugDependentSource: debugDependentSource, + dependent: dependent, + originalDependentSubscriptions: _subscriptions, + onCancel: onCancel, + ); + + _listeners.add(subscription); + + if (dependent != null) { + dependent._subscriptions.add(subscription); + } + + return subscription; + } + + /// Invoke the "create" method of a provider. + /// + /// Should not notify listeners during the synchronous execution of the build + /// method. @visibleForOverriding FutureOr build(Ref ref); - void markNeedsReload() { - throw UnimplementedError(); + void markNeedsRebuild({bool isReload = false}) { + if (_dirty != null) { + // If at least one rebuild request asks for a "reload", then we reload. + // Otherwise we "refresh". + if (isReload) _dirty = _DirtyType.reload; + + return; + } + + _dirty = isReload ? _DirtyType.reload : _DirtyType.refresh; + + container.scheduler.scheduleBuildFor(this); } - void markNeedsRefresh() { - throw UnimplementedError(); + void _runDispose() { + // By disposing the "ref" before invoking "onDispose", + // then we ensure that "onDispose" cannot call "ref.state=" & co. + _ref?._dispose(); + _ref = null; + + _onDispose + ..notifyListeners() + ..clear(); + } + + @mustCallSuper + void unmount() { + _runDispose(); + + // Clearing the subscriptions before closing them, for efficiency. + // This avoids having to remove the subscriptions from the list. + // Cf _ProviderSubscription._originalDependentSubscriptions. + final subscriptions = _subscriptions; + final listeners = _listeners; + _listeners = []; + _subscriptions = []; + + for (final subscription in subscriptions) { + subscription.close(); + } + for (final listener in listeners) { + listener.close(); + } + + _ref = null; + _result = null; + } +} + +class _ProviderSubscription implements ProviderSubscription { + _ProviderSubscription( + this._element, + this._listener, { + required bool fireImmediately, + required void Function(Object error, StackTrace stackTrace)? onError, + required DebugDependentSource? debugDependentSource, + required ProviderElement? dependent, + required List> originalDependentSubscriptions, + required void Function()? onCancel, + }) : _fireImmediately = fireImmediately, + _onError = onError, + _debugDependentSource = debugDependentSource, + _dependent = dependent, + _originalDependentSubscriptions = originalDependentSubscriptions, + _onCancel = onCancel; + + final ProviderElement _element; + final void Function(StateT? previous, StateT next) _listener; + final bool _fireImmediately; + final void Function(Object error, StackTrace stackTrace)? _onError; + final DebugDependentSource? _debugDependentSource; + final ProviderElement? _dependent; + final void Function()? _onCancel; + + /// [ProvidElement._subscriptions] at the time this subscription was created. + /// + /// Used to optimize the removal of this subscription from the list when the + /// provider's state was refreshed. + final List> _originalDependentSubscriptions; + + bool _closed = false; + int _pauseCount = 0; + + @override + StateT read() { + if (_closed) { + throw StateError('Cannot read from a closed subscription'); + } + if (_pauseCount > 0) { + throw StateError('Cannot read from a paused subscription'); + } + + return _element.requestState().data!.value; + } + + @override + void pause() { + if (_closed) { + throw StateError('Cannot pause a closed subscription'); + } + + // If this is the first pause, pause the provider too. + if (_pauseCount == 0) _element.pause(); + + _pauseCount++; + } + + @override + void resume() { + if (_closed) { + throw StateError('Cannot resume a closed subscription'); + } + + // Noop if not paused. + if (_pauseCount == 0) return; + + // If this is the last resume, unpause the provider too. + if (_pauseCount == 1) _element.resume(); + + _pauseCount--; + } + + @override + void close() { + if (_closed) { + throw StateError('Cannot close a closed subscription'); + } + + _closed = true; + + // If closing a paused subscription, unpause the provider too. + if (_pauseCount > 0) _element.resume(); + + _onCancel?.call(); + + _element._listeners.remove(this); + + if (_dependent != null && + _dependent._subscriptions == _originalDependentSubscriptions) { + _dependent._subscriptions.remove(this); + } } } diff --git a/packages/riverpod/lib/src/framework2/provider_listenable.dart b/packages/riverpod/lib/src/framework2/provider_listenable.dart index c4ee85956..a16e49104 100644 --- a/packages/riverpod/lib/src/framework2/provider_listenable.dart +++ b/packages/riverpod/lib/src/framework2/provider_listenable.dart @@ -9,17 +9,40 @@ mixin ProviderListenable implements ProviderListenableOrFamily { required bool fireImmediately, required void Function(Object error, StackTrace stackTrace)? onError, required DebugDependentSource? debugDependentSource, + required ProviderElement? dependent, + required void Function()? onCancel, }); ProviderListenable select(T Function(StateT value) selector) {} } abstract class ProviderSubscription { - const ProviderSubscription(); - StateT read(); + /// Pause the subscription. + /// + /// While paused, the subscription will not notify listeners. + /// If all subscriptions of a provider are paused, the provider itself + /// will be paused (invoking [Ref.onCancel]). From there on, the provider + /// will not rebuild unless read even if a dependency changes. + /// + /// If the subscription is already paused, calling [pause] again will have no effect. + /// + /// Calling [resume] will resume the subscription. + /// The [resume] method will have to be called as many times as [pause] was called. void pause(); + + /// Resume the subscription. + /// + /// If the subscription is not paused, calling [resume] will have no effect. + /// + /// If the subscription was paused multiple times, it is necessary to call + /// [resume] as many times as [pause] was called to resume the subscription. + /// If resuming a subscription on a provider that is paused, the provider + /// will be resumed as well (invoking [Ref.onResume]). + /// + /// See also: + /// - [pause], which pauses the subscription. void resume(); void close(); diff --git a/packages/riverpod/lib/src/framework2/ref.dart b/packages/riverpod/lib/src/framework2/ref.dart index c62531ffd..60c7b3831 100644 --- a/packages/riverpod/lib/src/framework2/ref.dart +++ b/packages/riverpod/lib/src/framework2/ref.dart @@ -21,11 +21,11 @@ class Ref { void notifyListeners(); - void onAddListener(VoidCallback cb); - void onRemoveListener(VoidCallback cb); - void onResume(VoidCallback cb); - void onCancel(VoidCallback cb); - void onDispose(VoidCallback cb); + void onAddListener(OnAddListener cb); + void onRemoveListener(OnRemoveListener cb); + void onResume(OnResume cb); + void onCancel(OnCancel cb); + void onDispose(OnDispose cb); bool exists(Provider provider); @@ -40,7 +40,6 @@ class Ref { T watch(ProviderListenable provider) { final subscription = listen(provider, (_, value) => reloadSelf()); - onDispose(subscription.close); return subscription.read(); } @@ -49,8 +48,21 @@ class Ref { ProviderListenable provider, ProviderListener listener, { OnError? onError, + VoidCallback? onCancel, bool fireImmediately = false, - }); + }) { + final subscription = provider.addListener( + container, + listener, + fireImmediately: fireImmediately, + onError: onError, + onCancel: onCancel, + dependent: _element, + ); + + return subscription; + } + void listenSelf( ProviderListener listener, { OnError? onError, diff --git a/packages/riverpod/lib/src/tenable.dart b/packages/riverpod/lib/src/tenable.dart new file mode 100644 index 000000000..890887d07 --- /dev/null +++ b/packages/riverpod/lib/src/tenable.dart @@ -0,0 +1,104 @@ +import 'dart:async'; + +import 'package:meta/meta.dart'; + +/// A Future-like class that can emit synchronously. +/// +/// This is similar to [FutureOr], but can hold errors. +@internal +abstract class Tenable { + const Tenable._(); + + const factory Tenable.value(T value) = _TenableValue; + const factory Tenable.error(Object error, StackTrace stacktrace) = + _TenableError; + factory Tenable.fromFuture(Future future) = _TenableFromFuture; + factory Tenable.guardSync(T Function() cb) { + try { + return Tenable.value(cb()); + } catch (err, stackTrace) { + return Tenable.error(err, stackTrace); + } + } + factory Tenable.guardTenable(Tenable Function() cb) { + try { + return cb(); + } catch (err, stackTrace) { + return Tenable.error(err, stackTrace); + } + } + factory Tenable.fromFutureOr(FutureOr Function() cb) { + try { + final futureOr = cb(); + if (futureOr is Future) { + return Tenable.fromFuture(futureOr); + } else { + return Tenable.value(futureOr); + } + } catch (err, stackTrace) { + return Tenable.error(err, stackTrace); + } + } + + Tenable then( + FutureOr Function(T value) cb, { + FutureOr Function(Object error, StackTrace stack)? onError, + }); + + Tenable whenComplete(FutureOr Function() cb) { + return then( + (value) => Tenable.fromFutureOr(cb), + onError: (err, stackTrace) => Tenable.fromFutureOr(cb), + ); + } +} + +class _TenableValue extends Tenable { + const _TenableValue(this.value) : super._(); + + final T value; + + @override + Tenable then( + FutureOr Function(T value) cb, { + FutureOr Function(Object error, StackTrace stack)? onError, + }) { + return Tenable.fromFutureOr(() => cb(value)); + } +} + +class _TenableError extends Tenable { + const _TenableError(this.error, this.stackTrace) : super._(); + + final Object error; + final StackTrace stackTrace; + + @override + Tenable then( + FutureOr Function(T value) cb, { + FutureOr Function(Object error, StackTrace stack)? onError, + }) { + if (onError == null) return Tenable.error(error, stackTrace); + + return Tenable.fromFutureOr(() => onError(error, stackTrace)); + } +} + +class _TenableFromFuture extends Tenable { + const _TenableFromFuture(this.future) : super._(); + + final Future future; + + @override + Tenable then( + FutureOr Function(T value) cb, { + FutureOr Function(Object error, StackTrace stack)? onError, + }) { + return Tenable.fromFuture( + future.then( + cb, + onError: onError, + ), + ); + } +} diff --git a/packages/riverpod/pubspec.yaml b/packages/riverpod/pubspec.yaml index e807c9a6f..477890a22 100644 --- a/packages/riverpod/pubspec.yaml +++ b/packages/riverpod/pubspec.yaml @@ -10,7 +10,7 @@ funding: - https://github.com/sponsors/rrousselGit/ environment: - sdk: ">=3.0.0+0.0-dev <4.0.0" + sdk: ">=3.2.0 <4.0.0" dependencies: meta: ^1.9.0 From 386818acf74f98574a49ce7c34ce8b228ff56d67 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 6 Dec 2023 09:28:29 +0100 Subject: [PATCH 050/387] W --- .../flutter_riverpod/lib/src/consumer.dart | 2 + .../lib/src/framework2/framework.dart | 2 - .../generated_providers/examples.dart | 20 +++---- .../riverpod/lib/src/framework2/node.dart | 27 --------- .../riverpod/lib/src/framework2/provider.dart | 12 ++-- .../src/framework2/provider_container.dart | 20 +++++-- .../lib/src/framework2/provider_element.dart | 44 ++++++++++++-- .../src/framework2/provider_listenable.dart | 2 +- packages/riverpod/lib/src/framework2/ref.dart | 59 +++++++++++++++---- 9 files changed, 120 insertions(+), 68 deletions(-) delete mode 100644 packages/riverpod/lib/src/framework2/node.dart diff --git a/packages/flutter_riverpod/lib/src/consumer.dart b/packages/flutter_riverpod/lib/src/consumer.dart index 665a6e596..9b2a9075a 100644 --- a/packages/flutter_riverpod/lib/src/consumer.dart +++ b/packages/flutter_riverpod/lib/src/consumer.dart @@ -236,6 +236,8 @@ abstract class WidgetRef { /// /// If used on a provider which is not initialized, this method will have no effect. void invalidate(ProviderOrFamily provider); + + void reload(ProviderOrFamily provider); } /// A function that can also listen to providers diff --git a/packages/riverpod/lib/src/framework2/framework.dart b/packages/riverpod/lib/src/framework2/framework.dart index c964b0ab8..6239bd660 100644 --- a/packages/riverpod/lib/src/framework2/framework.dart +++ b/packages/riverpod/lib/src/framework2/framework.dart @@ -1,6 +1,5 @@ import 'dart:async'; import 'dart:collection'; -import 'dart:math' as math; import 'package:meta/meta.dart'; import 'package:test/test.dart' as test; @@ -15,7 +14,6 @@ part 'provider_element.dart'; part 'provider.dart'; part 'ref.dart'; part 'override.dart'; -part 'node.dart'; part 'dependency_sources/consumer.dart'; part 'dependency_sources/container.dart'; part 'dependency_sources/provider.dart'; diff --git a/packages/riverpod/lib/src/framework2/generated_providers/examples.dart b/packages/riverpod/lib/src/framework2/generated_providers/examples.dart index 8538ca2fb..8bdec6515 100644 --- a/packages/riverpod/lib/src/framework2/generated_providers/examples.dart +++ b/packages/riverpod/lib/src/framework2/generated_providers/examples.dart @@ -13,14 +13,14 @@ int syncExample(Ref ref) => 42; @riverpod int syncExample2(Ref ref, {int? arg = 42}) => 42; -@riverpod -class SyncExampleNotifier extends _$SyncExampleNotifier { - @override - int build(Ref ref) => syncExample(ref); -} +// @riverpod +// class SyncExampleNotifier extends _$SyncExampleNotifier { +// @override +// int build(Ref ref) => syncExample(ref); +// } -@riverpod -class ScopedSyncExampleNotifier extends _$ScopedSyncExampleNotifier { - @override - int build(Ref ref); -} +// @riverpod +// class ScopedSyncExampleNotifier extends _$ScopedSyncExampleNotifier { +// @override +// int build(Ref ref); +// } diff --git a/packages/riverpod/lib/src/framework2/node.dart b/packages/riverpod/lib/src/framework2/node.dart deleted file mode 100644 index cfe762dd6..000000000 --- a/packages/riverpod/lib/src/framework2/node.dart +++ /dev/null @@ -1,27 +0,0 @@ -part of 'framework.dart'; - -@internal -@immutable -abstract class DebugDependentSource { - @mustBeOverridden - @override - bool operator ==(Object other); - - @mustBeOverridden - @override - int get hashCode; -} - -@internal -class Node { - Node({ - required this.owner, - required this.element, - }); - - final ProviderContainer owner; - final ProviderElement element; - - final _debugDependentSources = []; - final _listeners = >[]; -} diff --git a/packages/riverpod/lib/src/framework2/provider.dart b/packages/riverpod/lib/src/framework2/provider.dart index 21b50c7f4..be6de43e0 100644 --- a/packages/riverpod/lib/src/framework2/provider.dart +++ b/packages/riverpod/lib/src/framework2/provider.dart @@ -115,25 +115,23 @@ abstract base class Provider /// the [ProviderElement] in a static field. @visibleForOverriding ProviderElement getElement(ProviderContainer container) { - if (dependencies == null) { - container.root._readProviderElement(this); - } - return container._readProviderElement(this); + return container._insertProvider(this); } + @visibleForOverriding @override ProviderSubscription addListener( ProviderContainer container, void Function(StateT? previous, StateT next) listener, { required bool fireImmediately, required void Function(Object error, StackTrace stackTrace)? onError, - required DebugDependentSource? debugDependentSource, + required DebugProviderSource? debugDependentSource, required ProviderElement? dependent, required void Function()? onCancel, }) { final element = getElement(container); - final subscription = element.addListener( + return element.addListener( listener, fireImmediately: fireImmediately, onError: onError, @@ -141,7 +139,5 @@ abstract base class Provider dependent: dependent, onCancel: onCancel, ); - - return ProviderSubscription._(subscription, element); } } diff --git a/packages/riverpod/lib/src/framework2/provider_container.dart b/packages/riverpod/lib/src/framework2/provider_container.dart index 9925a23c5..bde3aa2a9 100644 --- a/packages/riverpod/lib/src/framework2/provider_container.dart +++ b/packages/riverpod/lib/src/framework2/provider_container.dart @@ -154,6 +154,11 @@ class ProviderContainer { void debugReassemble(); + void reload( + ProviderOrFamily provider, { + @internal DebugDependentSource? debugDependentSource, + }); + void invalidate( ProviderOrFamily provider, { @internal DebugDependentSource? debugDependentSource, @@ -186,7 +191,10 @@ class ProviderContainer { final subscription = listen( provider, (_, value) {}, - debugDependentSource: debugDependentSource ?? DebugRead, + debugDependentSource: kDebugMode + ? (debugDependentSource ?? + DebugProviderContainerReadDependentSource(container: this)) + : null, ); try { return subscription.read(); @@ -200,17 +208,19 @@ class ProviderContainer { ProviderListener listener, { bool fireImmediately = false, OnError? onError, - DebugDependentSource? debugDependentSource, + @internal DebugDependentSource? debugDependentSource, OnCancel? onCancel, }) { - provider.addListener( + return provider.addListener( this, listener, fireImmediately: fireImmediately, onError: onError, + onCancel: onCancel, + dependent: null, debugDependentSource: kDebugMode - ? debugDependentSource ?? - DebugProviderContainerListenDependentSource(container: this) + ? (debugDependentSource ?? + DebugProviderContainerListenDependentSource(container: this)) : null, ); } diff --git a/packages/riverpod/lib/src/framework2/provider_element.dart b/packages/riverpod/lib/src/framework2/provider_element.dart index 6107acdc9..b043c0791 100644 --- a/packages/riverpod/lib/src/framework2/provider_element.dart +++ b/packages/riverpod/lib/src/framework2/provider_element.dart @@ -21,6 +21,16 @@ abstract class ProviderElement { /// The container where this [ProviderElement] is attached to. final ProviderContainer container; + /// Whether this provider is currently paused. + /// + /// A provider is paused when if: + /// - It has no listeners + /// - All of its listeners are paused + /// - The provider was manually using [pause]. + bool get paused => + _subscriptions.isEmpty || _pauseCount > 0 || _pausedListenerCount > 0; + + bool _disposed = false; _DirtyType? _dirty; /// What this provider is currently listening to. @@ -29,6 +39,9 @@ abstract class ProviderElement { /// The listeners listening to this provider. List> _listeners = []; + var _pauseCount = 0; + var _pausedListenerCount = 0; + // The various life-cycles listeners of a provider. // We store them in the element instead of Ref for performance reasons. // This avoids having to create a new list for each Ref and is less DC intensive. @@ -133,7 +146,28 @@ abstract class ProviderElement { @visibleForOverriding FutureOr build(Ref ref); - void markNeedsRebuild({bool isReload = false}) { + @override + void pause() { + if (_disposed) throw StateError('Cannot pause a disposed ProviderElement'); + + _pauseCount++; + } + + @override + void resume() { + if (_disposed) throw StateError('Cannot resume a disposed ProviderElement'); + + // Noop if not paused. + if (_pauseCount == 0) return; + + _pauseCount--; + } + + void markNeedsReload() => _markNeedsRebuild(isReload: true); + + void markNeedsRefresh() => _markNeedsRebuild(); + + void _markNeedsRebuild({bool isReload = false}) { if (_dirty != null) { // If at least one rebuild request asks for a "reload", then we reload. // Otherwise we "refresh". @@ -162,6 +196,8 @@ abstract class ProviderElement { void unmount() { _runDispose(); + _disposed = true; + // Clearing the subscriptions before closing them, for efficiency. // This avoids having to remove the subscriptions from the list. // Cf _ProviderSubscription._originalDependentSubscriptions. @@ -235,7 +271,7 @@ class _ProviderSubscription implements ProviderSubscription { } // If this is the first pause, pause the provider too. - if (_pauseCount == 0) _element.pause(); + if (_pauseCount == 0) _element._pausedListenerCount++; _pauseCount++; } @@ -250,7 +286,7 @@ class _ProviderSubscription implements ProviderSubscription { if (_pauseCount == 0) return; // If this is the last resume, unpause the provider too. - if (_pauseCount == 1) _element.resume(); + if (_pauseCount == 1) _element._pausedListenerCount--; _pauseCount--; } @@ -264,7 +300,7 @@ class _ProviderSubscription implements ProviderSubscription { _closed = true; // If closing a paused subscription, unpause the provider too. - if (_pauseCount > 0) _element.resume(); + if (_pauseCount > 0) _element._pausedListenerCount--; _onCancel?.call(); diff --git a/packages/riverpod/lib/src/framework2/provider_listenable.dart b/packages/riverpod/lib/src/framework2/provider_listenable.dart index a16e49104..13d530f7c 100644 --- a/packages/riverpod/lib/src/framework2/provider_listenable.dart +++ b/packages/riverpod/lib/src/framework2/provider_listenable.dart @@ -8,7 +8,7 @@ mixin ProviderListenable implements ProviderListenableOrFamily { void Function(StateT? previous, StateT next) listener, { required bool fireImmediately, required void Function(Object error, StackTrace stackTrace)? onError, - required DebugDependentSource? debugDependentSource, + required DebugProviderSource? debugDependentSource, required ProviderElement? dependent, required void Function()? onCancel, }); diff --git a/packages/riverpod/lib/src/framework2/ref.dart b/packages/riverpod/lib/src/framework2/ref.dart index 60c7b3831..010d0ffa9 100644 --- a/packages/riverpod/lib/src/framework2/ref.dart +++ b/packages/riverpod/lib/src/framework2/ref.dart @@ -7,15 +7,15 @@ class Ref { ProviderContainer get container => _element.container; - // Explain that calling `state=` while the provider is synchronously building will not notify listeners - // And that if no state= is called, then after the synchronous execution has completed, the current state will be emitted - abstract StateT state; + // TODO deprecate state= + StateT get state; FutureOr get future; @useResult T refresh(Refreshable provider); void invalidate(ProviderOrFamily provider); + void reload(ProviderOrFamily provider); void invalidateSelf() => _element.markNeedsRefresh(); void reloadSelf() => _element.markNeedsReload(); @@ -30,7 +30,16 @@ class Ref { bool exists(Provider provider); T read(ProviderListenable provider) { - final subscription = listen(provider, (_, value) {}); + final subscription = _listen( + provider, + (_, value) {}, + onError: null, + onCancel: null, + fireImmediately: false, + debugDependentSource: kDebugMode + ? DebugRefReadDependentSource(provider: _element.provider) + : null, + ); try { return subscription.read(); } finally { @@ -39,28 +48,56 @@ class Ref { } T watch(ProviderListenable provider) { - final subscription = listen(provider, (_, value) => reloadSelf()); + final subscription = _listen( + provider, + (_, value) => reloadSelf(), + onError: null, + onCancel: null, + fireImmediately: false, + debugDependentSource: kDebugMode + ? DebugRefWatchDependentSource(provider: _element.provider) + : null, + ); return subscription.read(); } - ProviderSubscription listen( + ProviderSubscription _listen( ProviderListenable provider, ProviderListener listener, { - OnError? onError, - VoidCallback? onCancel, - bool fireImmediately = false, + required OnError? onError, + required VoidCallback? onCancel, + required bool fireImmediately, + required DebugDependentSource? debugDependentSource, }) { - final subscription = provider.addListener( + return provider.addListener( container, listener, fireImmediately: fireImmediately, onError: onError, onCancel: onCancel, dependent: _element, + debugDependentSource: debugDependentSource, ); + } - return subscription; + ProviderSubscription listen( + ProviderListenable provider, + ProviderListener listener, { + OnError? onError, + VoidCallback? onCancel, + bool fireImmediately = false, + }) { + return _listen( + provider, + listener, + onError: onError, + onCancel: onCancel, + fireImmediately: fireImmediately, + debugDependentSource: kDebugMode + ? DebugRefListenDependentSource(provider: _element.provider) + : null, + ); } void listenSelf( From 29a0d68081a55686609407e2f8dddfbc543a65df Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 9 Dec 2023 01:35:48 +0100 Subject: [PATCH 051/387] W --- .../dependency_sources/consumer.dart | 3 +- .../dependency_sources/container.dart | 40 +++++ .../dependency_sources/provider.dart | 13 ++ .../lib/src/framework2/framework.dart | 3 + .../generated_providers/examples.dart | 69 +++++++- .../generated_providers/examples.g.dart | 77 ++++++++- .../generated_providers/future_provider.dart | 84 ++++++++++ .../generated_providers/sync_provider.dart | 45 ++++- .../riverpod/lib/src/framework2/provider.dart | 37 ++--- .../src/framework2/provider_container.dart | 134 +++++++++++---- .../lib/src/framework2/provider_element.dart | 96 ++++++----- .../src/framework2/provider_listenable.dart | 8 +- packages/riverpod/lib/src/framework2/ref.dart | 156 ++++++++++++------ .../lib/src/framework2/scheduler.dart | 66 ++++++++ packages/riverpod/pubspec.yaml | 1 + 15 files changed, 679 insertions(+), 153 deletions(-) create mode 100644 packages/riverpod/lib/src/framework2/scheduler.dart diff --git a/packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart b/packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart index e37ec08ff..6e271bfe0 100644 --- a/packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart +++ b/packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart @@ -4,6 +4,7 @@ part of '../framework.dart'; sealed class DebugConsumerDependentSource extends DebugDependentSource { DebugConsumerDependentSource({required this.consumer, required this.element}); - final Consumer consumer; + // TODO + final Object consumer; final Element element; } diff --git a/packages/riverpod/lib/src/framework2/dependency_sources/container.dart b/packages/riverpod/lib/src/framework2/dependency_sources/container.dart index c252838d4..91c85593c 100644 --- a/packages/riverpod/lib/src/framework2/dependency_sources/container.dart +++ b/packages/riverpod/lib/src/framework2/dependency_sources/container.dart @@ -27,3 +27,43 @@ final class DebugProviderContainerReadDependentSource final ProviderContainer container; } + +@internal +final class DebugProviderContainerExistsDependentSource + extends DebugDependentSource { + DebugProviderContainerExistsDependentSource({ + required this.container, + }); + + final ProviderContainer container; +} + +@internal +final class DebugProviderContainerInvalidateDependentSource + extends DebugDependentSource { + DebugProviderContainerInvalidateDependentSource({ + required this.container, + }); + + final ProviderContainer container; +} + +@internal +final class DebugProviderContainerRefreshDependentSource + extends DebugDependentSource { + DebugProviderContainerRefreshDependentSource({ + required this.container, + }); + + final ProviderContainer container; +} + +@internal +final class DebugProviderContainerReloadDependentSource + extends DebugDependentSource { + DebugProviderContainerReloadDependentSource({ + required this.container, + }); + + final ProviderContainer container; +} diff --git a/packages/riverpod/lib/src/framework2/dependency_sources/provider.dart b/packages/riverpod/lib/src/framework2/dependency_sources/provider.dart index 99d4bc059..e8bb0d4c4 100644 --- a/packages/riverpod/lib/src/framework2/dependency_sources/provider.dart +++ b/packages/riverpod/lib/src/framework2/dependency_sources/provider.dart @@ -1,5 +1,8 @@ part of '../framework.dart'; +@internal +abstract class DebugDependentSource {} + @internal sealed class DebugProviderDependentSource extends DebugDependentSource { DebugProviderDependentSource._({required this.provider}); @@ -33,3 +36,13 @@ final class DebugRefRefreshDependentSource extends DebugProviderDependentSource { DebugRefRefreshDependentSource({required super.provider}) : super._(); } + +@internal +final class DebugRefReloadDependentSource extends DebugProviderDependentSource { + DebugRefReloadDependentSource({required super.provider}) : super._(); +} + +@internal +final class DebugRefExistsDependentSource extends DebugProviderDependentSource { + DebugRefExistsDependentSource({required super.provider}) : super._(); +} diff --git a/packages/riverpod/lib/src/framework2/framework.dart b/packages/riverpod/lib/src/framework2/framework.dart index 6239bd660..2ed1e541f 100644 --- a/packages/riverpod/lib/src/framework2/framework.dart +++ b/packages/riverpod/lib/src/framework2/framework.dart @@ -1,6 +1,8 @@ import 'dart:async'; import 'dart:collection'; +import 'dart:html'; +import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; import 'package:test/test.dart' as test; @@ -17,6 +19,7 @@ part 'override.dart'; part 'dependency_sources/consumer.dart'; part 'dependency_sources/container.dart'; part 'dependency_sources/provider.dart'; +part 'scheduler.dart'; @internal typedef OnError = void Function(Object error, StackTrace stackTrace); diff --git a/packages/riverpod/lib/src/framework2/generated_providers/examples.dart b/packages/riverpod/lib/src/framework2/generated_providers/examples.dart index 8bdec6515..d10976398 100644 --- a/packages/riverpod/lib/src/framework2/generated_providers/examples.dart +++ b/packages/riverpod/lib/src/framework2/generated_providers/examples.dart @@ -1,4 +1,7 @@ +import 'dart:async'; + import 'package:meta/meta.dart'; +import 'package:riverpod/src/framework2/generated_providers/future_provider.dart'; import '../framework.dart'; import 'sync_provider.dart'; @@ -11,7 +14,71 @@ const riverpod = Object(); int syncExample(Ref ref) => 42; @riverpod -int syncExample2(Ref ref, {int? arg = 42}) => 42; +int syncExample2(Ref ref, {int? arg = 42}) { + return 42; +} + +// TODO +// extension on FutureOr { +// Future get sync { +// final that = this; +// if (that is Future) { +// return that; +// } else { +// return SynchronousFuture(that); +// } +// } +// } +// extension on Future { +// @Deprecated( +// 'Do not use "sync" on a Future. Either use a "FutureOr", or remove the "sync".', +// ) +// Never get sync => throw UnsupportedError( +// 'Do not use "sync" on a Future. Either use a "FutureOr", or remove the "sync".', +// ); +// } + +// TODO +// extension on Ref { +// /// A custom "return" keyword that enables synchronous value emit. +// /// +// /// Works by throwing an exception, which is caught and silenced by Riverpod. +// Never returnData(T value); + +// /// A custom "yield" keyword that enables synchronous value emit. +// /// +// /// The returned future typically completes immediately. +// /// But on paused providers, it will complete when the provider is resumed. +// /// +// /// This enables pausing asynchronous work. +// FutureOr emitData(T value) => state = value; +// } + +@riverpod +FutureOr asyncExample(Ref ref) async { + // "syncFuture" returns a SynchronousFuture from Flutter. + // This enables "await" to be synchronous. + // It unfortunately cannot be the default, due to SynchronousFuture not working + // with certain APIs (such as Future.wait) + // Riverpod_lint could have a warning to suggest using ".syncFuture" instead of ".future" + // when using "await". + final value = await ref.watch(asyncExampleProvider.syncFuture); + + return value; + + // final stream = Stream.periodic(const Duration(seconds: 1), (i) => i); + // // An example of iterating over a stream that supports pausing. + // // If the widget listening to this stream stops being visible, this loop would pause. + // // This would work thanks to "emitData" awaiting for the provider to be resumed. + // await for (final value in stream) { + // print('value: $value'); + // await ref.emitData(value); + // } + + // // Instead of "return 42", we use a custom "returnData" method. + // // This achieves the same result, but bypasses Future's asynchronous nature. + // ref.returnData(42); +} // @riverpod // class SyncExampleNotifier extends _$SyncExampleNotifier { diff --git a/packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart b/packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart index 9c9e6b36b..d3b17808c 100644 --- a/packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart +++ b/packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart @@ -20,6 +20,12 @@ final class SyncExampleProvider extends SyncProvider { : null, ); + @override + Refreshable get notifier; + + @override + Refreshable get future; + @override int build(Ref ref) => syncExample(ref); @@ -28,15 +34,80 @@ final class SyncExampleProvider extends SyncProvider { /// For unscoped providers, we can circumvent the override and map lookup /// by statically caching the element. /// This is only a performance optimization and should not be relied upon. - static ProviderElement? _$element; + static ProviderElement? _$element; + + @override + ProviderElement getElement( + ProviderContainer container, { + required DebugDependentSource? debugDependentSource, + }) { + final target = container.root ?? container; + + final element = _$element; + if (element != null && _$root == target) return element; + + return _$element = super.getElement( + _$root = target, + debugDependentSource: debugDependentSource, + ); + } +} + +const asyncExampleProvider = AsyncExampleProvider._(); + +final class AsyncExampleProvider extends AsyncProvider { + const AsyncExampleProvider._() + : super( + name: 'asyncExample', + from: null, + arguments: null, + dependencies: null, + allTransitiveDependencies: null, + isAlwaysAlive: false, + debugSource: kDebugMode + ? const DebugProviderSource( + name: 'asyncExample', + file: + 'package:riverpod/src/framework2/generated_providers/examples.dart:asyncExample', + line: 42, + column: 42, + hash: '123', + ) + : null, + ); + + @override + Refreshable get notifier; + + @override + Refreshable> get future; + + @override + Refreshable> get syncFuture; + + @override + FutureOr build(Ref ref) => asyncExample(ref); + + static ProviderContainer? _$root; + + /// For unscoped providers, we can circumvent the override and map lookup + /// by statically caching the element. + /// This is only a performance optimization and should not be relied upon. + static ProviderElement? _$element; @override - ProviderElement getElement(ProviderContainer container) { + ProviderElement getElement( + ProviderContainer container, { + required DebugDependentSource? debugDependentSource, + }) { final target = container.root ?? container; final element = _$element; if (element != null && _$root == target) return element; - return _$element = super.getElement(_$root = target); + return _$element = super.getElement( + _$root = target, + debugDependentSource: debugDependentSource, + ); } } diff --git a/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart b/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart index e69de29bb..cca27ffeb 100644 --- a/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart +++ b/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart @@ -0,0 +1,84 @@ +import 'dart:async'; + +import 'package:meta/meta.dart'; + +import '../../common.dart'; +import '../framework.dart'; + +abstract base class AsyncProvider extends Provider> { + const AsyncProvider({ + required super.name, + required super.from, + required super.arguments, + required super.debugSource, + required super.dependencies, + required super.allTransitiveDependencies, + required super.isAlwaysAlive, + }); + + FutureOr build(Ref ref); + + Override overrideWith(Build, Ref> create); + + Override overrideWithValue(AsyncValue value); + + @override + ProviderElement createElement( + ProviderContainer container, + ) { + return AsyncProviderElement(this, container); + } + + @visibleForOverriding + @override + ProviderSubscription> addListener( + ProviderContainer container, + void Function(AsyncValue? previous, AsyncValue next) + listener, { + required bool fireImmediately, + required void Function(Object error, StackTrace stackTrace)? onError, + required DebugDependentSource? debugDependentSource, + required ProviderElement? dependent, + required void Function()? onCancel, + }) { + final element = getElement( + container, + debugDependentSource: debugDependentSource, + ) as AsyncProviderElement; + + return element.addListener( + listener, + convert: (value) => value, + fireImmediately: fireImmediately, + onError: onError, + debugDependentSource: debugDependentSource, + dependent: dependent, + onCancel: onCancel, + ); + } +} + +class AsyncProviderElement extends ProviderElement { + AsyncProviderElement(this.provider, super.container); + + final AsyncProvider provider; + + @override + FutureOr build(Ref ref) { + try { + final futureOr = provider.build(ref); + + if (futureOr is Future) { + // TODO handle cancellation + return futureOr.then( + setData, + onError: setError, + ); + } else { + setData(futureOr); + } + } catch (err, stack) { + setError(err, stack); + } + } +} diff --git a/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart b/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart index 1320161f7..049208d18 100644 --- a/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart +++ b/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart @@ -1,4 +1,6 @@ -import '../../result.dart'; +import 'package:meta/meta.dart'; + +import '../../common.dart'; import '../framework.dart'; abstract base class SyncProvider extends Provider { @@ -7,8 +9,12 @@ abstract base class SyncProvider extends Provider { required super.from, required super.arguments, required super.debugSource, + required super.dependencies, + required super.allTransitiveDependencies, + required super.isAlwaysAlive, }); + @internal StateT build(Ref ref); Override overrideWith(Build> create); @@ -16,20 +22,49 @@ abstract base class SyncProvider extends Provider { Override overrideWithValue(StateT value); @override - SyncProviderElement createElement() => SyncProviderElement(this); + ProviderElement createElement(ProviderContainer container) { + return SyncProviderElement(this, container); + } + + @visibleForOverriding + @override + ProviderSubscription addListener( + ProviderContainer container, + void Function(StateT? previous, StateT next) listener, { + required bool fireImmediately, + required void Function(Object error, StackTrace stackTrace)? onError, + required DebugDependentSource? debugDependentSource, + required ProviderElement? dependent, + required void Function()? onCancel, + }) { + final element = getElement( + container, + debugDependentSource: debugDependentSource, + ) as SyncProviderElement; + + return element.addListener( + listener, + convert: (value) => value.requireValue, + fireImmediately: fireImmediately, + onError: onError, + debugDependentSource: debugDependentSource, + dependent: dependent, + onCancel: onCancel, + ); + } } class SyncProviderElement extends ProviderElement { - SyncProviderElement(this.provider); + SyncProviderElement(this.provider, super.container); final SyncProvider provider; @override void build(Ref ref) { try { - result = Result.data(provider.build(ref)); + setData(provider.build(ref)); } catch (err, stack) { - result = Result.error(err, stack); + setError(err, stack); } } } diff --git a/packages/riverpod/lib/src/framework2/provider.dart b/packages/riverpod/lib/src/framework2/provider.dart index be6de43e0..4c30528ef 100644 --- a/packages/riverpod/lib/src/framework2/provider.dart +++ b/packages/riverpod/lib/src/framework2/provider.dart @@ -46,10 +46,6 @@ class DebugProviderSource { @deprecated const renameProviderBaseToPRovider = Object(); -abstract class NotifierProvider { - Refreshable get notifier; -} - @immutable @renameProviderBaseToPRovider abstract base class Provider @@ -102,9 +98,13 @@ abstract base class Provider final List? dependencies; final List? allTransitiveDependencies; + Refreshable> get future; + Refreshable> get syncFuture; + Refreshable get notifier; + /// A method that always create a new [ProviderElement]. @visibleForOverriding - ProviderElement createElement(ProviderContainer container); + ProviderElement createElement(ProviderContainer container); /// A method for fast lookup of the [ProviderElement] associated to this provider. /// @@ -113,9 +113,15 @@ abstract base class Provider /// /// Providers may override this for even faster lookup, such as by caching /// the [ProviderElement] in a static field. - @visibleForOverriding - ProviderElement getElement(ProviderContainer container) { - return container._insertProvider(this); + @protected + ProviderElement getElement( + ProviderContainer container, { + required DebugDependentSource? debugDependentSource, + }) { + return container._insertProvider( + this, + debugDependentSource: debugDependentSource, + ); } @visibleForOverriding @@ -125,19 +131,8 @@ abstract base class Provider void Function(StateT? previous, StateT next) listener, { required bool fireImmediately, required void Function(Object error, StackTrace stackTrace)? onError, - required DebugProviderSource? debugDependentSource, + required DebugDependentSource? debugDependentSource, required ProviderElement? dependent, required void Function()? onCancel, - }) { - final element = getElement(container); - - return element.addListener( - listener, - fireImmediately: fireImmediately, - onError: onError, - debugDependentSource: debugDependentSource, - dependent: dependent, - onCancel: onCancel, - ); - } + }); } diff --git a/packages/riverpod/lib/src/framework2/provider_container.dart b/packages/riverpod/lib/src/framework2/provider_container.dart index bde3aa2a9..c46574532 100644 --- a/packages/riverpod/lib/src/framework2/provider_container.dart +++ b/packages/riverpod/lib/src/framework2/provider_container.dart @@ -25,17 +25,19 @@ class _ProviderPointer { /// share the same state. class _ProviderPointers { _ProviderPointers() - : orphanPointers = HashMap(), - familyPointers = HashMap(); + : _orphanPointers = HashMap(), + _familyPointers = HashMap(); _ProviderPointers.from(ProviderContainer parent) - : orphanPointers = HashMap.from(parent._providerPointers.orphanPointers), - familyPointers = HashMap.from(parent._providerPointers.familyPointers); + : _orphanPointers = + HashMap.from(parent._providerPointers._orphanPointers), + _familyPointers = + HashMap.from(parent._providerPointers._familyPointers); late final ProviderContainer container; - final HashMap, _ProviderPointer> orphanPointers; + final HashMap, _ProviderPointer> _orphanPointers; final HashMap, _ProviderPointer>> - familyPointers; + _familyPointers; /// Obtain and possibly mount the [ProviderElement] for a provider. ProviderElement add( @@ -49,18 +51,24 @@ class _ProviderPointers { final pointer = _ProviderPointer(isFromOverride: isFromOverride); final element = provider.createElement(container); pointer.element = element; + return pointer; } if (from == null) { - final pointer = orphanPointers.putIfAbsent(provider, mount); + final pointer = _orphanPointers.putIfAbsent(provider, mount); + final element = pointer.element!; + // TODO debugAddDependency(element, debugDependentSource: debugDependentSource); - return pointer.element!; + return element; } else { - final familyPointers = this.familyPointers.putIfAbsent(from, HashMap.new); - final pointer = familyPointers.putIfAbsent(provider, mount); + final _familyPointers = + this._familyPointers.putIfAbsent(from, HashMap.new); + final pointer = _familyPointers.putIfAbsent(provider, mount); + final element = pointer.element!; + // TODO debugAddDependency(element, debugDependentSource: debugDependentSource); - return pointer.element!; + return element; } } @@ -69,9 +77,9 @@ class _ProviderPointers { final from = provider.from; if (from == null) { - return orphanPointers[provider]; + return _orphanPointers[provider]; } else { - return familyPointers[from]?[provider]; + return _familyPointers[from]?[provider]; } } @@ -80,7 +88,26 @@ class _ProviderPointers { Provider provider, { required DebugDependentSource? debugDependentSource, }) { - return _readPointer(provider)?.element; + final element = _readPointer(provider)?.element; +// TODO debugAddDependency(element, debugDependentSource: debugDependentSource); + + return element; + } + + /// Read the [ProviderElement] for a provider, without creating it if it doesn't exist. + Iterable> readFamily( + Family family, { + required DebugDependentSource? debugDependentSource, + }) { + final _familyPointers = this._familyPointers[family]; + if (_familyPointers == null) return const []; + + return _familyPointers.values.map((e) { + final element = e.element; + // TODO debugAddDependency(element, debugDependentSource: debugDependentSource); + + return element; + }).whereNotNull(); } /// Remove a provider from this container. @@ -96,9 +123,9 @@ class _ProviderPointers { final from = provider.from; if (from == null) { - orphanPointers.remove(provider); + _orphanPointers.remove(provider); } else { - final familyPointer = familyPointers[from]; + final familyPointer = _familyPointers[from]; // Nothing to remove if (familyPointer == null) return; @@ -111,12 +138,12 @@ class _ProviderPointers { // The family is empty, remove it. // It should be guaranteed that there this won't remove scoped provider pointers // as there's a "isFromOverride" check at the beginning of this method. - familyPointers.remove(from); + _familyPointers.remove(from); } } } -class ProviderContainer { +final class ProviderContainer { ProviderContainer({ this.parent, List overrides = const [], @@ -126,7 +153,6 @@ class ProviderContainer { ? _ProviderPointers.from(parent) : _ProviderPointers() { _providerPointers.container = this; - _initializeOverrides(overrides); } @visibleForTesting @@ -150,38 +176,73 @@ class ProviderContainer { final _children = []; final _ProviderPointers _providerPointers; - void updateOverrides(List overrides); + final _scheduler = SchedulerBinding(); - void debugReassemble(); + // TODO void updateOverrides(List overrides); - void reload( - ProviderOrFamily provider, { - @internal DebugDependentSource? debugDependentSource, - }); + // TODO void debugReassemble(); void invalidate( ProviderOrFamily provider, { + bool asReload = false, @internal DebugDependentSource? debugDependentSource, }) { - _providerPointers.read(provider)?.markNeedsRefresh(); - _addDependency(provider, StackTrace.current); + switch (provider) { + case Provider(): + _providerPointers + .read( + provider, + debugDependentSource: kDebugMode + ? (debugDependentSource ?? + DebugProviderContainerInvalidateDependentSource( + container: this, + )) + : null, + ) + ?.markNeedsRebuild(asReload: asReload); + case Family(): + final elements = _providerPointers.readFamily( + provider, + debugDependentSource: debugDependentSource, + ); + for (final element in elements) { + element.markNeedsRebuild(asReload: asReload); + } + } } StateT refresh( Refreshable provider, { @internal DebugDependentSource? debugDependentSource, }) { - invalidate(provider, debugDependentSource: debugDependentSource); - _addDependency(provider, StackTrace.current); + invalidate( + provider._refreshed, + debugDependentSource: kDebugMode + ? (debugDependentSource ?? + DebugProviderContainerRefreshDependentSource(container: this)) + : null, + ); + + return read( + provider, + debugDependentSource: kDebugMode + ? (debugDependentSource ?? + DebugProviderContainerRefreshDependentSource(container: this)) + : null, + ); } - ProviderElement _insertProvider(Provider provider) { + ProviderElement _insertProvider( + Provider provider, { + required DebugDependentSource? debugDependentSource, + }) { return _providerPointers.add( provider, // If the provider points to an override, a pointer should already be set. // So always using `false` isn't an issue. isFromOverride: false, - ) as ProviderElement; + debugDependentSource: debugDependentSource, + ); } StateT read( @@ -229,10 +290,17 @@ class ProviderContainer { Provider provider, { @internal DebugDependentSource? debugDependentSource, }) { - return _providerPointers.read(provider) != null; + return _providerPointers.read( + provider, + debugDependentSource: kDebugMode + ? (debugDependentSource ?? + DebugProviderContainerExistsDependentSource(container: this)) + : null, + ) != + null; } - Future pump(); + // TODO Future pump(); void dispose() { parent?._children.remove(this); diff --git a/packages/riverpod/lib/src/framework2/provider_element.dart b/packages/riverpod/lib/src/framework2/provider_element.dart index b043c0791..eb8b52d89 100644 --- a/packages/riverpod/lib/src/framework2/provider_element.dart +++ b/packages/riverpod/lib/src/framework2/provider_element.dart @@ -16,7 +16,7 @@ abstract class ProviderElement { ProviderElement(this.container); /// The provider associated with this [ProviderElement]. - Provider get provider; + Provider get provider; /// The container where this [ProviderElement] is attached to. final ProviderContainer container; @@ -30,7 +30,9 @@ abstract class ProviderElement { bool get paused => _subscriptions.isEmpty || _pauseCount > 0 || _pausedListenerCount > 0; + bool get disposed => _disposed; bool _disposed = false; + _DirtyType? _dirty; /// What this provider is currently listening to. @@ -42,23 +44,33 @@ abstract class ProviderElement { var _pauseCount = 0; var _pausedListenerCount = 0; - // The various life-cycles listeners of a provider. - // We store them in the element instead of Ref for performance reasons. - // This avoids having to create a new list for each Ref and is less DC intensive. - final _onDispose = VoidNotifier(); - final _onAddListener = VoidNotifier(); - final _onRemoveListener = VoidNotifier(); - final _onResume = VoidNotifier(); - final _onPause = VoidNotifier(); + // // The various life-cycles listeners of a provider. + // // We store them in the element instead of Ref for performance reasons. + // // This avoids having to create a new list for each Ref and is less DC intensive. + // TODO + // final _onDispose = VoidNotifier(); + // final _onAddListener = VoidNotifier(); + // final _onRemoveListener = VoidNotifier(); + // final _onResume = VoidNotifier(); + // final _onPause = VoidNotifier(); Ref? _ref; + + AsyncValue? get result => _result; AsyncValue? _result; + int get depthApproximation => _depthApproximation; + int _depthApproximation = 0; + AsyncValue requestState() { - container.scheduler.performRebuilds(); + container._scheduler.scheduleBuildFor(this); - final result = _result; + final result = this.result; if (result != null) return result; + + throw StateError( + 'Cannot request state while the provider is not built', + ); } void _runProviderBuild() { @@ -80,7 +92,7 @@ abstract class ProviderElement { } // Prevent listeners from being notified while we are building. - assert(_lockNotifyListeners()); + // TODO assert(_lockNotifyListeners()); final tenable = Tenable.fromFutureOr(() => build(ref)); @@ -99,29 +111,39 @@ abstract class ProviderElement { } } - assert(_unlockNotifyListeners()); - assert(_result != null); + // TODO assert(_unlockNotifyListeners()); + assert(result != null); // We notify listeners after "build" has completed. // This avoids notifying listeners multiple times if multiple state change // operations are performed at once. - _notifyListeners(); + // TODO _notifyListeners(); + } + + void setLoading() { + // TODO } - void setLoading(); - void setError(Object error, StackTrace stackTrace); - void setDats(StateT value); + void setError(Object error, StackTrace stackTrace) { + // TODO + } + + void setData(StateT value) { + // TODO + } - ProviderSubscription addListener( - ProviderListener listener, { + ProviderSubscription addListener( + ProviderListener listener, { required bool fireImmediately, required OnError? onError, + required ResultT Function(AsyncValue value) convert, required DebugDependentSource? debugDependentSource, required ProviderElement? dependent, required OnCancel? onCancel, }) { - final subscription = _ProviderSubscription( + final subscription = _ProviderSubscription( this, listener, + convert: convert, fireImmediately: fireImmediately, onError: onError, debugDependentSource: debugDependentSource, @@ -146,14 +168,12 @@ abstract class ProviderElement { @visibleForOverriding FutureOr build(Ref ref); - @override void pause() { if (_disposed) throw StateError('Cannot pause a disposed ProviderElement'); _pauseCount++; } - @override void resume() { if (_disposed) throw StateError('Cannot resume a disposed ProviderElement'); @@ -163,22 +183,18 @@ abstract class ProviderElement { _pauseCount--; } - void markNeedsReload() => _markNeedsRebuild(isReload: true); - - void markNeedsRefresh() => _markNeedsRebuild(); - - void _markNeedsRebuild({bool isReload = false}) { + void markNeedsRebuild({bool asReload = false}) { if (_dirty != null) { // If at least one rebuild request asks for a "reload", then we reload. // Otherwise we "refresh". - if (isReload) _dirty = _DirtyType.reload; + if (asReload) _dirty = _DirtyType.reload; return; } - _dirty = isReload ? _DirtyType.reload : _DirtyType.refresh; + _dirty = asReload ? _DirtyType.reload : _DirtyType.refresh; - container.scheduler.scheduleBuildFor(this); + container._scheduler.scheduleBuildFor(this); } void _runDispose() { @@ -187,9 +203,9 @@ abstract class ProviderElement { _ref?._dispose(); _ref = null; - _onDispose - ..notifyListeners() - ..clear(); + // TODO _onDispose + // ..notifyListeners() + // ..clear(); } @mustCallSuper @@ -218,10 +234,12 @@ abstract class ProviderElement { } } -class _ProviderSubscription implements ProviderSubscription { +class _ProviderSubscription + implements ProviderSubscription { _ProviderSubscription( this._element, this._listener, { + required ResultT Function(AsyncValue value) convert, required bool fireImmediately, required void Function(Object error, StackTrace stackTrace)? onError, required DebugDependentSource? debugDependentSource, @@ -230,13 +248,15 @@ class _ProviderSubscription implements ProviderSubscription { required void Function()? onCancel, }) : _fireImmediately = fireImmediately, _onError = onError, + _convert = convert, _debugDependentSource = debugDependentSource, _dependent = dependent, _originalDependentSubscriptions = originalDependentSubscriptions, _onCancel = onCancel; final ProviderElement _element; - final void Function(StateT? previous, StateT next) _listener; + final ResultT Function(AsyncValue) _convert; + final void Function(ResultT? previous, ResultT next) _listener; final bool _fireImmediately; final void Function(Object error, StackTrace stackTrace)? _onError; final DebugDependentSource? _debugDependentSource; @@ -253,7 +273,7 @@ class _ProviderSubscription implements ProviderSubscription { int _pauseCount = 0; @override - StateT read() { + ResultT read() { if (_closed) { throw StateError('Cannot read from a closed subscription'); } @@ -261,7 +281,7 @@ class _ProviderSubscription implements ProviderSubscription { throw StateError('Cannot read from a paused subscription'); } - return _element.requestState().data!.value; + return _convert(_element.requestState()); } @override diff --git a/packages/riverpod/lib/src/framework2/provider_listenable.dart b/packages/riverpod/lib/src/framework2/provider_listenable.dart index 13d530f7c..f835da3c5 100644 --- a/packages/riverpod/lib/src/framework2/provider_listenable.dart +++ b/packages/riverpod/lib/src/framework2/provider_listenable.dart @@ -8,12 +8,12 @@ mixin ProviderListenable implements ProviderListenableOrFamily { void Function(StateT? previous, StateT next) listener, { required bool fireImmediately, required void Function(Object error, StackTrace stackTrace)? onError, - required DebugProviderSource? debugDependentSource, + required DebugDependentSource? debugDependentSource, required ProviderElement? dependent, required void Function()? onCancel, }); - ProviderListenable select(T Function(StateT value) selector) {} + // TODO select } abstract class ProviderSubscription { @@ -48,4 +48,6 @@ abstract class ProviderSubscription { void close(); } -mixin Refreshable on ProviderListenable {} +mixin Refreshable on ProviderListenable { + Provider get _refreshed; +} diff --git a/packages/riverpod/lib/src/framework2/ref.dart b/packages/riverpod/lib/src/framework2/ref.dart index 010d0ffa9..0dd9640ec 100644 --- a/packages/riverpod/lib/src/framework2/ref.dart +++ b/packages/riverpod/lib/src/framework2/ref.dart @@ -3,39 +3,114 @@ part of 'framework.dart'; class Ref { Ref._(this._element); - final ProviderElement _element; + bool get mounted => !_element.disposed; + var _mounted = false; - ProviderContainer get container => _element.container; + ProviderContainer get container { + _assertNotDisposed(); + return _element.container; + } // TODO deprecate state= - StateT get state; + // StateT get state { + // _assertNotDisposed(); + // } + + // TODO + // FutureOr get future { + // _assertNotDisposed(); + // } - FutureOr get future; + final ProviderElement _element; + + void _assertNotDisposed() { + assert( + !_mounted, + ''' +Cannot use a disposed "ref". This may happen is: +- You are using a "ref" on a provider that was disposed (such as because it was no-longer listened). +- Your provider rebuilt, and therefore a more up-to-date "ref" is available. +''', + ); + } @useResult - T refresh(Refreshable provider); - void invalidate(ProviderOrFamily provider); - void reload(ProviderOrFamily provider); - void invalidateSelf() => _element.markNeedsRefresh(); - void reloadSelf() => _element.markNeedsReload(); + T refresh(Refreshable provider) { + _assertNotDisposed(); + return container.refresh( + provider, + debugDependentSource: kDebugMode + ? DebugRefRefreshDependentSource(provider: _element.provider) + : null, + ); + } + + void invalidate(ProviderOrFamily provider, {bool asReload = false}) { + _assertNotDisposed(); + container.invalidate( + provider, + asReload: asReload, + debugDependentSource: kDebugMode + ? DebugRefInvalidateDependentSource(provider: _element.provider) + : null, + ); + } + + // TODO remove Reload dependent source + + bool exists(Provider provider) { + _assertNotDisposed(); + return container.exists( + provider, + debugDependentSource: kDebugMode + ? DebugRefExistsDependentSource(provider: _element.provider) + : null, + ); + } - void notifyListeners(); + void invalidateSelf() { + _assertNotDisposed(); + _element.markNeedsRebuild(); + } + + void reloadSelf() { + _assertNotDisposed(); + _element.markNeedsRebuild(asReload: true); + } - void onAddListener(OnAddListener cb); - void onRemoveListener(OnRemoveListener cb); - void onResume(OnResume cb); - void onCancel(OnCancel cb); - void onDispose(OnDispose cb); + // TODO + // void notifyListeners() => _element.notifyListeners(); - bool exists(Provider provider); + // void onAddListener(OnAddListener cb) { + // _assertNotDisposed(); + // _element.onAddListener(cb); + // } + + // void onRemoveListener(OnRemoveListener cb) { + // _assertNotDisposed(); + // _element.onRemoveListener(cb); + // } + + // void onResume(OnResume cb) { + // _assertNotDisposed(); + // _element.onResume(cb); + // } + + // void onCancel(OnCancel cb) { + // _assertNotDisposed(); + // _element.onCancel(cb); + // } + + // void onDispose(OnDispose cb) { + // _assertNotDisposed(); + // _element.onDispose(cb); + // } T read(ProviderListenable provider) { - final subscription = _listen( + _assertNotDisposed(); + final subscription = container.listen( provider, (_, value) {}, - onError: null, - onCancel: null, - fireImmediately: false, debugDependentSource: kDebugMode ? DebugRefReadDependentSource(provider: _element.provider) : null, @@ -48,12 +123,9 @@ class Ref { } T watch(ProviderListenable provider) { - final subscription = _listen( + final subscription = container.listen( provider, (_, value) => reloadSelf(), - onError: null, - onCancel: null, - fireImmediately: false, debugDependentSource: kDebugMode ? DebugRefWatchDependentSource(provider: _element.provider) : null, @@ -62,25 +134,6 @@ class Ref { return subscription.read(); } - ProviderSubscription _listen( - ProviderListenable provider, - ProviderListener listener, { - required OnError? onError, - required VoidCallback? onCancel, - required bool fireImmediately, - required DebugDependentSource? debugDependentSource, - }) { - return provider.addListener( - container, - listener, - fireImmediately: fireImmediately, - onError: onError, - onCancel: onCancel, - dependent: _element, - debugDependentSource: debugDependentSource, - ); - } - ProviderSubscription listen( ProviderListenable provider, ProviderListener listener, { @@ -88,7 +141,8 @@ class Ref { VoidCallback? onCancel, bool fireImmediately = false, }) { - return _listen( + _assertNotDisposed(); + return container.listen( provider, listener, onError: onError, @@ -100,8 +154,14 @@ class Ref { ); } - void listenSelf( - ProviderListener listener, { - OnError? onError, - }); + // Mention bout listening to self does not cause a provider to be "unpaused". + // TODO void listenSelf( + // ProviderListener listener, { + // OnError? onError, + // }) { + // _assertNotDisposed(); + // _element._listenSelf(listener, onError); + // } + + void _dispose() => _mounted = true; } diff --git a/packages/riverpod/lib/src/framework2/scheduler.dart b/packages/riverpod/lib/src/framework2/scheduler.dart new file mode 100644 index 000000000..90d6fdf0c --- /dev/null +++ b/packages/riverpod/lib/src/framework2/scheduler.dart @@ -0,0 +1,66 @@ +part of 'framework.dart'; + +@internal +class SchedulerBinding { + final _toBuild = >[]; + + bool _closed = false; + + int scheduleBuildFor(ProviderElement element) => + _depthBasedInsert(element); + + int _depthBasedInsert(ProviderElement element, [int start = 0]) { + final depth = element.depthApproximation; + final index = _toBuild.indexWhere( + (e) => e.depthApproximation > depth, + start, + ); + + if (index == -1) { + _toBuild.add(element); + return _toBuild.length - 1; + } else { + _toBuild.insert(index, element); + return index; + } + } + + int rescheduleBuildFor(ProviderElement element, int previousIndex) { + final index = _toBuild.indexOf(element, previousIndex); + assert(index >= 0, 'The element was not found in the list of providers'); + + _toBuild.removeAt(index); + + return _depthBasedInsert(element, index + 1); + } + + void _task() { + if (_closed) return; + + flushBuild(); + } + + void flushBuild() { + var debugDepth = 0; + + for (var x = 0; x < _toBuild.length; x++) { + // Assert that the elements are sorted by their depth + if (kDebugMode) { + assert( + debugDepth <= _toBuild[x].depthApproximation, + 'Bad state, the internal list of providers is incorrectly sorted', + ); + debugDepth = _toBuild[x].depthApproximation; + } + + final element = _toBuild[x]; + + if (!element.paused && !element.disposed) element._runProviderBuild(); + } + _toBuild.clear(); + } + + void close() { + _closed = true; + } +} diff --git a/packages/riverpod/pubspec.yaml b/packages/riverpod/pubspec.yaml index 477890a22..d8408f66e 100644 --- a/packages/riverpod/pubspec.yaml +++ b/packages/riverpod/pubspec.yaml @@ -13,6 +13,7 @@ environment: sdk: ">=3.2.0 <4.0.0" dependencies: + collection: ^1.18.0 meta: ^1.9.0 stack_trace: ^1.10.0 state_notifier: ">=0.7.2 <2.0.0" From 9d5f1e4de324d9b32e3caf47251d4be3017b1937 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 9 Dec 2023 10:58:46 +0100 Subject: [PATCH 052/387] mv --- packages/riverpod/test/{ => old}/framework/async_value_test.dart | 0 packages/riverpod/test/{ => old}/framework/auto_dispose_test.dart | 0 packages/riverpod/test/{ => old}/framework/family_test.dart | 0 packages/riverpod/test/{ => old}/framework/listen_test.dart | 0 packages/riverpod/test/{ => old}/framework/modifiers_test.dart | 0 .../test/{ => old}/framework/provider_container_test.dart | 0 .../riverpod/test/{ => old}/framework/provider_element_test.dart | 0 .../riverpod/test/{ => old}/framework/provider_observer_test.dart | 0 .../test/{ => old}/framework/proxy_provider_listenable_test.dart | 0 packages/riverpod/test/{ => old}/framework/ref_test.dart | 0 packages/riverpod/test/{ => old}/framework/ref_watch_test.dart | 0 packages/riverpod/test/{ => old}/framework/result_test.dart | 0 packages/riverpod/test/{ => old}/framework/scope_test.dart | 0 packages/riverpod/test/{ => old}/framework/select_async_test.dart | 0 .../riverpod/test/{ => old}/framework/uni_directional_test.dart | 0 packages/riverpod/test/{ => old}/framework/visit_states_test.dart | 0 packages/riverpod/test/{ => old}/legacy/devtool_test.dart | 0 .../riverpod/test/{ => old}/legacy/framework2/framework_test.dart | 0 packages/riverpod/test/{ => old}/legacy/framework_test.dart | 0 .../{ => old}/providers/async_notifier/async_notifier_test.dart | 0 .../riverpod/test/{ => old}/providers/async_notifier/factory.dart | 0 .../future_provider/auto_dispose_family_future_provider_test.dart | 0 .../future_provider/auto_dispose_future_provider_test.dart | 0 .../providers/future_provider/family_future_provider_test.dart | 0 .../{ => old}/providers/future_provider/future_provider_test.dart | 0 packages/riverpod/test/{ => old}/providers/notifier/factory.dart | 0 .../riverpod/test/{ => old}/providers/notifier/notifier_test.dart | 0 .../providers/provider/auto_dispose_provider_family_test.dart | 0 .../{ => old}/providers/provider/auto_dispose_provider_test.dart | 0 .../test/{ => old}/providers/provider/provider_family_test.dart | 0 .../riverpod/test/{ => old}/providers/provider/provider_test.dart | 0 .../{ => old}/providers/scoped_provider/scoped_provider_test.dart | 0 .../state_notifier_provider/auto_dispose_family_test.dart | 0 .../auto_dispose_state_notifier_provider_test.dart | 0 .../{ => old}/providers/state_notifier_provider/family_test.dart | 0 .../state_notifier_provider/state_notifier_provider_test.dart | 0 .../{ => old}/providers/state_provider/state_controller_test.dart | 0 .../state_provider/state_provider_auto_dispose_test.dart | 0 .../state_provider/state_provider_family_auto_dispose_test.dart | 0 .../providers/state_provider/state_provider_family_test.dart | 0 .../{ => old}/providers/state_provider/state_provider_test.dart | 0 .../{ => old}/providers/stream_notifier/async_notifier_test.dart | 0 .../test/{ => old}/providers/stream_notifier/factory.dart | 0 .../stream_provider/auto_dispose_family_stream_provider_test.dart | 0 .../stream_provider/auto_dispose_stream_provider_test.dart | 0 .../providers/stream_provider/stream_provider_family_test.dart | 0 .../{ => old}/providers/stream_provider/stream_provider_test.dart | 0 packages/riverpod/test/{ => old}/third_party/fake_async.dart | 0 packages/riverpod/test/{ => old}/utils.dart | 0 49 files changed, 0 insertions(+), 0 deletions(-) rename packages/riverpod/test/{ => old}/framework/async_value_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/auto_dispose_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/family_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/listen_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/modifiers_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/provider_container_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/provider_element_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/provider_observer_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/proxy_provider_listenable_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/ref_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/ref_watch_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/result_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/scope_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/select_async_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/uni_directional_test.dart (100%) rename packages/riverpod/test/{ => old}/framework/visit_states_test.dart (100%) rename packages/riverpod/test/{ => old}/legacy/devtool_test.dart (100%) rename packages/riverpod/test/{ => old}/legacy/framework2/framework_test.dart (100%) rename packages/riverpod/test/{ => old}/legacy/framework_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/async_notifier/async_notifier_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/async_notifier/factory.dart (100%) rename packages/riverpod/test/{ => old}/providers/future_provider/auto_dispose_family_future_provider_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/future_provider/auto_dispose_future_provider_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/future_provider/family_future_provider_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/future_provider/future_provider_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/notifier/factory.dart (100%) rename packages/riverpod/test/{ => old}/providers/notifier/notifier_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/provider/auto_dispose_provider_family_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/provider/auto_dispose_provider_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/provider/provider_family_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/provider/provider_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/scoped_provider/scoped_provider_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/state_notifier_provider/auto_dispose_family_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/state_notifier_provider/family_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/state_notifier_provider/state_notifier_provider_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/state_provider/state_controller_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/state_provider/state_provider_auto_dispose_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/state_provider/state_provider_family_auto_dispose_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/state_provider/state_provider_family_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/state_provider/state_provider_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/stream_notifier/async_notifier_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/stream_notifier/factory.dart (100%) rename packages/riverpod/test/{ => old}/providers/stream_provider/auto_dispose_family_stream_provider_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/stream_provider/auto_dispose_stream_provider_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/stream_provider/stream_provider_family_test.dart (100%) rename packages/riverpod/test/{ => old}/providers/stream_provider/stream_provider_test.dart (100%) rename packages/riverpod/test/{ => old}/third_party/fake_async.dart (100%) rename packages/riverpod/test/{ => old}/utils.dart (100%) diff --git a/packages/riverpod/test/framework/async_value_test.dart b/packages/riverpod/test/old/framework/async_value_test.dart similarity index 100% rename from packages/riverpod/test/framework/async_value_test.dart rename to packages/riverpod/test/old/framework/async_value_test.dart diff --git a/packages/riverpod/test/framework/auto_dispose_test.dart b/packages/riverpod/test/old/framework/auto_dispose_test.dart similarity index 100% rename from packages/riverpod/test/framework/auto_dispose_test.dart rename to packages/riverpod/test/old/framework/auto_dispose_test.dart diff --git a/packages/riverpod/test/framework/family_test.dart b/packages/riverpod/test/old/framework/family_test.dart similarity index 100% rename from packages/riverpod/test/framework/family_test.dart rename to packages/riverpod/test/old/framework/family_test.dart diff --git a/packages/riverpod/test/framework/listen_test.dart b/packages/riverpod/test/old/framework/listen_test.dart similarity index 100% rename from packages/riverpod/test/framework/listen_test.dart rename to packages/riverpod/test/old/framework/listen_test.dart diff --git a/packages/riverpod/test/framework/modifiers_test.dart b/packages/riverpod/test/old/framework/modifiers_test.dart similarity index 100% rename from packages/riverpod/test/framework/modifiers_test.dart rename to packages/riverpod/test/old/framework/modifiers_test.dart diff --git a/packages/riverpod/test/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart similarity index 100% rename from packages/riverpod/test/framework/provider_container_test.dart rename to packages/riverpod/test/old/framework/provider_container_test.dart diff --git a/packages/riverpod/test/framework/provider_element_test.dart b/packages/riverpod/test/old/framework/provider_element_test.dart similarity index 100% rename from packages/riverpod/test/framework/provider_element_test.dart rename to packages/riverpod/test/old/framework/provider_element_test.dart diff --git a/packages/riverpod/test/framework/provider_observer_test.dart b/packages/riverpod/test/old/framework/provider_observer_test.dart similarity index 100% rename from packages/riverpod/test/framework/provider_observer_test.dart rename to packages/riverpod/test/old/framework/provider_observer_test.dart diff --git a/packages/riverpod/test/framework/proxy_provider_listenable_test.dart b/packages/riverpod/test/old/framework/proxy_provider_listenable_test.dart similarity index 100% rename from packages/riverpod/test/framework/proxy_provider_listenable_test.dart rename to packages/riverpod/test/old/framework/proxy_provider_listenable_test.dart diff --git a/packages/riverpod/test/framework/ref_test.dart b/packages/riverpod/test/old/framework/ref_test.dart similarity index 100% rename from packages/riverpod/test/framework/ref_test.dart rename to packages/riverpod/test/old/framework/ref_test.dart diff --git a/packages/riverpod/test/framework/ref_watch_test.dart b/packages/riverpod/test/old/framework/ref_watch_test.dart similarity index 100% rename from packages/riverpod/test/framework/ref_watch_test.dart rename to packages/riverpod/test/old/framework/ref_watch_test.dart diff --git a/packages/riverpod/test/framework/result_test.dart b/packages/riverpod/test/old/framework/result_test.dart similarity index 100% rename from packages/riverpod/test/framework/result_test.dart rename to packages/riverpod/test/old/framework/result_test.dart diff --git a/packages/riverpod/test/framework/scope_test.dart b/packages/riverpod/test/old/framework/scope_test.dart similarity index 100% rename from packages/riverpod/test/framework/scope_test.dart rename to packages/riverpod/test/old/framework/scope_test.dart diff --git a/packages/riverpod/test/framework/select_async_test.dart b/packages/riverpod/test/old/framework/select_async_test.dart similarity index 100% rename from packages/riverpod/test/framework/select_async_test.dart rename to packages/riverpod/test/old/framework/select_async_test.dart diff --git a/packages/riverpod/test/framework/uni_directional_test.dart b/packages/riverpod/test/old/framework/uni_directional_test.dart similarity index 100% rename from packages/riverpod/test/framework/uni_directional_test.dart rename to packages/riverpod/test/old/framework/uni_directional_test.dart diff --git a/packages/riverpod/test/framework/visit_states_test.dart b/packages/riverpod/test/old/framework/visit_states_test.dart similarity index 100% rename from packages/riverpod/test/framework/visit_states_test.dart rename to packages/riverpod/test/old/framework/visit_states_test.dart diff --git a/packages/riverpod/test/legacy/devtool_test.dart b/packages/riverpod/test/old/legacy/devtool_test.dart similarity index 100% rename from packages/riverpod/test/legacy/devtool_test.dart rename to packages/riverpod/test/old/legacy/devtool_test.dart diff --git a/packages/riverpod/test/legacy/framework2/framework_test.dart b/packages/riverpod/test/old/legacy/framework2/framework_test.dart similarity index 100% rename from packages/riverpod/test/legacy/framework2/framework_test.dart rename to packages/riverpod/test/old/legacy/framework2/framework_test.dart diff --git a/packages/riverpod/test/legacy/framework_test.dart b/packages/riverpod/test/old/legacy/framework_test.dart similarity index 100% rename from packages/riverpod/test/legacy/framework_test.dart rename to packages/riverpod/test/old/legacy/framework_test.dart diff --git a/packages/riverpod/test/providers/async_notifier/async_notifier_test.dart b/packages/riverpod/test/old/providers/async_notifier/async_notifier_test.dart similarity index 100% rename from packages/riverpod/test/providers/async_notifier/async_notifier_test.dart rename to packages/riverpod/test/old/providers/async_notifier/async_notifier_test.dart diff --git a/packages/riverpod/test/providers/async_notifier/factory.dart b/packages/riverpod/test/old/providers/async_notifier/factory.dart similarity index 100% rename from packages/riverpod/test/providers/async_notifier/factory.dart rename to packages/riverpod/test/old/providers/async_notifier/factory.dart diff --git a/packages/riverpod/test/providers/future_provider/auto_dispose_family_future_provider_test.dart b/packages/riverpod/test/old/providers/future_provider/auto_dispose_family_future_provider_test.dart similarity index 100% rename from packages/riverpod/test/providers/future_provider/auto_dispose_family_future_provider_test.dart rename to packages/riverpod/test/old/providers/future_provider/auto_dispose_family_future_provider_test.dart diff --git a/packages/riverpod/test/providers/future_provider/auto_dispose_future_provider_test.dart b/packages/riverpod/test/old/providers/future_provider/auto_dispose_future_provider_test.dart similarity index 100% rename from packages/riverpod/test/providers/future_provider/auto_dispose_future_provider_test.dart rename to packages/riverpod/test/old/providers/future_provider/auto_dispose_future_provider_test.dart diff --git a/packages/riverpod/test/providers/future_provider/family_future_provider_test.dart b/packages/riverpod/test/old/providers/future_provider/family_future_provider_test.dart similarity index 100% rename from packages/riverpod/test/providers/future_provider/family_future_provider_test.dart rename to packages/riverpod/test/old/providers/future_provider/family_future_provider_test.dart diff --git a/packages/riverpod/test/providers/future_provider/future_provider_test.dart b/packages/riverpod/test/old/providers/future_provider/future_provider_test.dart similarity index 100% rename from packages/riverpod/test/providers/future_provider/future_provider_test.dart rename to packages/riverpod/test/old/providers/future_provider/future_provider_test.dart diff --git a/packages/riverpod/test/providers/notifier/factory.dart b/packages/riverpod/test/old/providers/notifier/factory.dart similarity index 100% rename from packages/riverpod/test/providers/notifier/factory.dart rename to packages/riverpod/test/old/providers/notifier/factory.dart diff --git a/packages/riverpod/test/providers/notifier/notifier_test.dart b/packages/riverpod/test/old/providers/notifier/notifier_test.dart similarity index 100% rename from packages/riverpod/test/providers/notifier/notifier_test.dart rename to packages/riverpod/test/old/providers/notifier/notifier_test.dart diff --git a/packages/riverpod/test/providers/provider/auto_dispose_provider_family_test.dart b/packages/riverpod/test/old/providers/provider/auto_dispose_provider_family_test.dart similarity index 100% rename from packages/riverpod/test/providers/provider/auto_dispose_provider_family_test.dart rename to packages/riverpod/test/old/providers/provider/auto_dispose_provider_family_test.dart diff --git a/packages/riverpod/test/providers/provider/auto_dispose_provider_test.dart b/packages/riverpod/test/old/providers/provider/auto_dispose_provider_test.dart similarity index 100% rename from packages/riverpod/test/providers/provider/auto_dispose_provider_test.dart rename to packages/riverpod/test/old/providers/provider/auto_dispose_provider_test.dart diff --git a/packages/riverpod/test/providers/provider/provider_family_test.dart b/packages/riverpod/test/old/providers/provider/provider_family_test.dart similarity index 100% rename from packages/riverpod/test/providers/provider/provider_family_test.dart rename to packages/riverpod/test/old/providers/provider/provider_family_test.dart diff --git a/packages/riverpod/test/providers/provider/provider_test.dart b/packages/riverpod/test/old/providers/provider/provider_test.dart similarity index 100% rename from packages/riverpod/test/providers/provider/provider_test.dart rename to packages/riverpod/test/old/providers/provider/provider_test.dart diff --git a/packages/riverpod/test/providers/scoped_provider/scoped_provider_test.dart b/packages/riverpod/test/old/providers/scoped_provider/scoped_provider_test.dart similarity index 100% rename from packages/riverpod/test/providers/scoped_provider/scoped_provider_test.dart rename to packages/riverpod/test/old/providers/scoped_provider/scoped_provider_test.dart diff --git a/packages/riverpod/test/providers/state_notifier_provider/auto_dispose_family_test.dart b/packages/riverpod/test/old/providers/state_notifier_provider/auto_dispose_family_test.dart similarity index 100% rename from packages/riverpod/test/providers/state_notifier_provider/auto_dispose_family_test.dart rename to packages/riverpod/test/old/providers/state_notifier_provider/auto_dispose_family_test.dart diff --git a/packages/riverpod/test/providers/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart b/packages/riverpod/test/old/providers/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart similarity index 100% rename from packages/riverpod/test/providers/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart rename to packages/riverpod/test/old/providers/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart diff --git a/packages/riverpod/test/providers/state_notifier_provider/family_test.dart b/packages/riverpod/test/old/providers/state_notifier_provider/family_test.dart similarity index 100% rename from packages/riverpod/test/providers/state_notifier_provider/family_test.dart rename to packages/riverpod/test/old/providers/state_notifier_provider/family_test.dart diff --git a/packages/riverpod/test/providers/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/old/providers/state_notifier_provider/state_notifier_provider_test.dart similarity index 100% rename from packages/riverpod/test/providers/state_notifier_provider/state_notifier_provider_test.dart rename to packages/riverpod/test/old/providers/state_notifier_provider/state_notifier_provider_test.dart diff --git a/packages/riverpod/test/providers/state_provider/state_controller_test.dart b/packages/riverpod/test/old/providers/state_provider/state_controller_test.dart similarity index 100% rename from packages/riverpod/test/providers/state_provider/state_controller_test.dart rename to packages/riverpod/test/old/providers/state_provider/state_controller_test.dart diff --git a/packages/riverpod/test/providers/state_provider/state_provider_auto_dispose_test.dart b/packages/riverpod/test/old/providers/state_provider/state_provider_auto_dispose_test.dart similarity index 100% rename from packages/riverpod/test/providers/state_provider/state_provider_auto_dispose_test.dart rename to packages/riverpod/test/old/providers/state_provider/state_provider_auto_dispose_test.dart diff --git a/packages/riverpod/test/providers/state_provider/state_provider_family_auto_dispose_test.dart b/packages/riverpod/test/old/providers/state_provider/state_provider_family_auto_dispose_test.dart similarity index 100% rename from packages/riverpod/test/providers/state_provider/state_provider_family_auto_dispose_test.dart rename to packages/riverpod/test/old/providers/state_provider/state_provider_family_auto_dispose_test.dart diff --git a/packages/riverpod/test/providers/state_provider/state_provider_family_test.dart b/packages/riverpod/test/old/providers/state_provider/state_provider_family_test.dart similarity index 100% rename from packages/riverpod/test/providers/state_provider/state_provider_family_test.dart rename to packages/riverpod/test/old/providers/state_provider/state_provider_family_test.dart diff --git a/packages/riverpod/test/providers/state_provider/state_provider_test.dart b/packages/riverpod/test/old/providers/state_provider/state_provider_test.dart similarity index 100% rename from packages/riverpod/test/providers/state_provider/state_provider_test.dart rename to packages/riverpod/test/old/providers/state_provider/state_provider_test.dart diff --git a/packages/riverpod/test/providers/stream_notifier/async_notifier_test.dart b/packages/riverpod/test/old/providers/stream_notifier/async_notifier_test.dart similarity index 100% rename from packages/riverpod/test/providers/stream_notifier/async_notifier_test.dart rename to packages/riverpod/test/old/providers/stream_notifier/async_notifier_test.dart diff --git a/packages/riverpod/test/providers/stream_notifier/factory.dart b/packages/riverpod/test/old/providers/stream_notifier/factory.dart similarity index 100% rename from packages/riverpod/test/providers/stream_notifier/factory.dart rename to packages/riverpod/test/old/providers/stream_notifier/factory.dart diff --git a/packages/riverpod/test/providers/stream_provider/auto_dispose_family_stream_provider_test.dart b/packages/riverpod/test/old/providers/stream_provider/auto_dispose_family_stream_provider_test.dart similarity index 100% rename from packages/riverpod/test/providers/stream_provider/auto_dispose_family_stream_provider_test.dart rename to packages/riverpod/test/old/providers/stream_provider/auto_dispose_family_stream_provider_test.dart diff --git a/packages/riverpod/test/providers/stream_provider/auto_dispose_stream_provider_test.dart b/packages/riverpod/test/old/providers/stream_provider/auto_dispose_stream_provider_test.dart similarity index 100% rename from packages/riverpod/test/providers/stream_provider/auto_dispose_stream_provider_test.dart rename to packages/riverpod/test/old/providers/stream_provider/auto_dispose_stream_provider_test.dart diff --git a/packages/riverpod/test/providers/stream_provider/stream_provider_family_test.dart b/packages/riverpod/test/old/providers/stream_provider/stream_provider_family_test.dart similarity index 100% rename from packages/riverpod/test/providers/stream_provider/stream_provider_family_test.dart rename to packages/riverpod/test/old/providers/stream_provider/stream_provider_family_test.dart diff --git a/packages/riverpod/test/providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/providers/stream_provider/stream_provider_test.dart similarity index 100% rename from packages/riverpod/test/providers/stream_provider/stream_provider_test.dart rename to packages/riverpod/test/old/providers/stream_provider/stream_provider_test.dart diff --git a/packages/riverpod/test/third_party/fake_async.dart b/packages/riverpod/test/old/third_party/fake_async.dart similarity index 100% rename from packages/riverpod/test/third_party/fake_async.dart rename to packages/riverpod/test/old/third_party/fake_async.dart diff --git a/packages/riverpod/test/utils.dart b/packages/riverpod/test/old/utils.dart similarity index 100% rename from packages/riverpod/test/utils.dart rename to packages/riverpod/test/old/utils.dart From a273c5af86c4edf5e1a8a632140df1842f8301f3 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 14:11:53 +0100 Subject: [PATCH 053/387] W --- .../dependency_sources/consumer.dart | 3 +- .../lib/src/framework2/framework.dart | 1 - .../framework2/legacy_providers/compat.dart | 6 ++ .../framework2/legacy_providers/provider.dart | 4 + .../src/framework2/provider_container.dart | 10 +- .../riverpod/test/new/container_test.dart | 101 ++++++++++++++++++ .../framework/provider_container_test.dart | 80 -------------- 7 files changed, 122 insertions(+), 83 deletions(-) create mode 100644 packages/riverpod/lib/src/framework2/legacy_providers/compat.dart create mode 100644 packages/riverpod/lib/src/framework2/legacy_providers/provider.dart create mode 100644 packages/riverpod/test/new/container_test.dart diff --git a/packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart b/packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart index 6e271bfe0..4377a13d6 100644 --- a/packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart +++ b/packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart @@ -6,5 +6,6 @@ sealed class DebugConsumerDependentSource extends DebugDependentSource { // TODO final Object consumer; - final Element element; + // TODO + final Object? element; } diff --git a/packages/riverpod/lib/src/framework2/framework.dart b/packages/riverpod/lib/src/framework2/framework.dart index 2ed1e541f..3dd66e52e 100644 --- a/packages/riverpod/lib/src/framework2/framework.dart +++ b/packages/riverpod/lib/src/framework2/framework.dart @@ -1,6 +1,5 @@ import 'dart:async'; import 'dart:collection'; -import 'dart:html'; import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; diff --git a/packages/riverpod/lib/src/framework2/legacy_providers/compat.dart b/packages/riverpod/lib/src/framework2/legacy_providers/compat.dart new file mode 100644 index 000000000..a8f93c90f --- /dev/null +++ b/packages/riverpod/lib/src/framework2/legacy_providers/compat.dart @@ -0,0 +1,6 @@ +import '../framework.dart' as framework; + +export 'provider.dart' show Provider, ProviderRef; + +typedef ProviderElementBase = framework.ProviderElement; +typedef ProviderBase = framework.Provider; diff --git a/packages/riverpod/lib/src/framework2/legacy_providers/provider.dart b/packages/riverpod/lib/src/framework2/legacy_providers/provider.dart new file mode 100644 index 000000000..05f957979 --- /dev/null +++ b/packages/riverpod/lib/src/framework2/legacy_providers/provider.dart @@ -0,0 +1,4 @@ +@riverpod +T provider(ProviderRef ref, T Function(ProviderRef ref) create) { + return create(ref); +} diff --git a/packages/riverpod/lib/src/framework2/provider_container.dart b/packages/riverpod/lib/src/framework2/provider_container.dart index c46574532..da02bb0d9 100644 --- a/packages/riverpod/lib/src/framework2/provider_container.dart +++ b/packages/riverpod/lib/src/framework2/provider_container.dart @@ -175,7 +175,7 @@ final class ProviderContainer { final ProviderContainer? parent; final _children = []; final _ProviderPointers _providerPointers; - + var _disposed = false; final _scheduler = SchedulerBinding(); // TODO void updateOverrides(List overrides); @@ -303,6 +303,14 @@ final class ProviderContainer { // TODO Future pump(); void dispose() { + if (_disposed) return; + + _disposed = true; parent?._children.remove(this); } } + +@internal +extension ProviderContainerTest on ProviderContainer { + bool get disposed => _disposed; +} diff --git a/packages/riverpod/test/new/container_test.dart b/packages/riverpod/test/new/container_test.dart new file mode 100644 index 000000000..4f09cdda1 --- /dev/null +++ b/packages/riverpod/test/new/container_test.dart @@ -0,0 +1,101 @@ +import 'package:riverpod/src/framework2/framework.dart'; +import 'package:test/test.dart'; + +void main() { + group('ProviderContainer', () { + group('.test', () { + test('Auto-disposes the provider when the test ends', () { + late ProviderContainer container; + + addTearDown(() => expect(container.disposed, true)); + + container = ProviderContainer.test(); + + addTearDown(() => expect(container.disposed, false)); + }); + + group('exists', () { + test('simple use-case', () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => 0); + + expect(container.exists(provider), false); + expect(container.getAllProviderElements(), isEmpty); + + container.read(provider); + + expect(container.exists(provider), true); + }); + + test('handles autoDispose', () async { + final provider = Provider.autoDispose((ref) => 0); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWith((ref) => 42), + ], + ); + + expect(container.exists(provider), false); + expect(container.getAllProviderElements(), isEmpty); + + container.read(provider); + + expect(container.exists(provider), true); + + await container.pump(); + + expect(container.getAllProviderElements(), isEmpty); + expect(container.exists(provider), false); + expect(container.getAllProviderElements(), isEmpty); + }); + + test('Handles uninitialized overrideWith', () { + final provider = Provider((ref) => 0); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWith((ref) => 42), + ], + ); + + expect(container.exists(provider), false); + expect(container.getAllProviderElements(), isEmpty); + + container.read(provider); + + expect(container.exists(provider), true); + }); + + test('handles nested providers', () { + final provider = Provider((ref) => 0); + final provider2 = Provider((ref) => 0); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider2]); + + expect(container.exists(provider), false); + expect(container.exists(provider2), false); + expect(container.getAllProviderElements(), isEmpty); + expect(root.getAllProviderElements(), isEmpty); + + container.read(provider); + + expect(container.exists(provider), true); + expect(container.exists(provider2), false); + expect(container.getAllProviderElements(), isEmpty); + expect( + root.getAllProviderElements().map((e) => e.origin), [provider]); + + container.read(provider2); + + expect(container.exists(provider2), true); + expect( + container.getAllProviderElements().map((e) => e.origin), + [provider2], + ); + expect( + root.getAllProviderElements().map((e) => e.origin), [provider]); + }); + }); + }); + }); +} diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index c416e39dd..6367e47cd 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -70,86 +70,6 @@ void main() { }); }); - group('exists', () { - test('simple use-case', () { - final container = createContainer(); - final provider = Provider((ref) => 0); - - expect(container.exists(provider), false); - expect(container.getAllProviderElements(), isEmpty); - - container.read(provider); - - expect(container.exists(provider), true); - }); - - test('handles autoDispose', () async { - final provider = Provider.autoDispose((ref) => 0); - final container = createContainer( - overrides: [ - provider.overrideWith((ref) => 42), - ], - ); - - expect(container.exists(provider), false); - expect(container.getAllProviderElements(), isEmpty); - - container.read(provider); - - expect(container.exists(provider), true); - - await container.pump(); - - expect(container.getAllProviderElements(), isEmpty); - expect(container.exists(provider), false); - expect(container.getAllProviderElements(), isEmpty); - }); - - test('Handles uninitialized overrideWith', () { - final provider = Provider((ref) => 0); - final container = createContainer( - overrides: [ - provider.overrideWith((ref) => 42), - ], - ); - - expect(container.exists(provider), false); - expect(container.getAllProviderElements(), isEmpty); - - container.read(provider); - - expect(container.exists(provider), true); - }); - - test('handles nested providers', () { - final provider = Provider((ref) => 0); - final provider2 = Provider((ref) => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider2]); - - expect(container.exists(provider), false); - expect(container.exists(provider2), false); - expect(container.getAllProviderElements(), isEmpty); - expect(root.getAllProviderElements(), isEmpty); - - container.read(provider); - - expect(container.exists(provider), true); - expect(container.exists(provider2), false); - expect(container.getAllProviderElements(), isEmpty); - expect(root.getAllProviderElements().map((e) => e.origin), [provider]); - - container.read(provider2); - - expect(container.exists(provider2), true); - expect( - container.getAllProviderElements().map((e) => e.origin), - [provider2], - ); - expect(root.getAllProviderElements().map((e) => e.origin), [provider]); - }); - }); - group('debugReassemble', () { test( 'reload providers if the debugGetCreateSourceHash of a provider returns a different value', From 6093bd6e66035248fd669e1eb04180dacc13f223 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 14:13:23 +0100 Subject: [PATCH 054/387] rename --- packages/riverpod/lib/src/framework.dart | 2 +- .../src/framework/{container.dart => provider_container.dart} | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename packages/riverpod/lib/src/framework/{container.dart => provider_container.dart} (99%) diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index acad37540..4a6f1cb76 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -12,7 +12,7 @@ part 'framework/auto_dispose.dart'; part 'framework/async_selector.dart'; part 'framework/provider_base.dart'; part 'framework/element.dart'; -part 'framework/container.dart'; +part 'framework/provider_container.dart'; part 'framework/family.dart'; part 'framework/listen.dart'; part 'framework/foundation.dart'; diff --git a/packages/riverpod/lib/src/framework/container.dart b/packages/riverpod/lib/src/framework/provider_container.dart similarity index 99% rename from packages/riverpod/lib/src/framework/container.dart rename to packages/riverpod/lib/src/framework/provider_container.dart index f805ba4fa..d90e4f8fa 100644 --- a/packages/riverpod/lib/src/framework/container.dart +++ b/packages/riverpod/lib/src/framework/provider_container.dart @@ -603,7 +603,7 @@ final b = Provider((ref) => ref.watch(a), dependencies: [a]); ); if (_root != null) { - _root!._stateReaders[provider] = reader; + _root._stateReaders[provider] = reader; } return reader; From 89baf213355be4ad12719da168f1f2b21e418e98 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 15:23:06 +0100 Subject: [PATCH 055/387] Add tests --- packages/riverpod/lib/riverpod.dart | 3 +- packages/riverpod/lib/src/env.dart | 68 ++++++ packages/riverpod/lib/src/framework.dart | 1 + .../lib/src/framework/provider_container.dart | 46 ++++ .../lib/src/framework2/framework.dart | 3 - .../riverpod/test/new/container_test.dart | 228 +++++++++++++----- 6 files changed, 282 insertions(+), 67 deletions(-) create mode 100644 packages/riverpod/lib/src/env.dart diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 6f848c3b7..a6e5756f1 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -50,7 +50,8 @@ export 'src/framework.dart' Create, Node, ProviderElementProxy, - OnError; + OnError, + ProviderContainerTest; export 'src/future_provider.dart'; diff --git a/packages/riverpod/lib/src/env.dart b/packages/riverpod/lib/src/env.dart new file mode 100644 index 000000000..6a012603a --- /dev/null +++ b/packages/riverpod/lib/src/env.dart @@ -0,0 +1,68 @@ +// Copyright 2014 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +// ignore_for_file: do_not_use_environment + +import 'package:meta/meta.dart'; + +/// A constant that is true if the application was compiled in release mode. +/// +/// More specifically, this is a constant that is true if the application was +/// compiled in Dart with the '-Ddart.vm.product=true' flag. +/// +/// Since this is a const value, it can be used to indicate to the compiler that +/// a particular block of code will not be executed in release mode, and hence +/// can be removed. +/// +/// Generally it is better to use [kDebugMode] or `assert` to gate code, since +/// using [kReleaseMode] will introduce differences between release and profile +/// builds, which makes performance testing less representative. +/// +/// See also: +/// +/// * [kDebugMode], which is true in debug builds. +/// * [kProfileMode], which is true in profile builds. +@internal +const bool kReleaseMode = bool.fromEnvironment('dart.vm.product'); + +/// A constant that is true if the application was compiled in profile mode. +/// +/// More specifically, this is a constant that is true if the application was +/// compiled in Dart with the '-Ddart.vm.profile=true' flag. +/// +/// Since this is a const value, it can be used to indicate to the compiler that +/// a particular block of code will not be executed in profile mode, an hence +/// can be removed. +/// +/// See also: +/// +/// * [kDebugMode], which is true in debug builds. +/// * [kReleaseMode], which is true in release builds. +@internal +const bool kProfileMode = bool.fromEnvironment('dart.vm.profile'); + +/// A constant that is true if the application was compiled in debug mode. +/// +/// More specifically, this is a constant that is true if the application was +/// not compiled with '-Ddart.vm.product=true' and '-Ddart.vm.profile=true'. +/// +/// Since this is a const value, it can be used to indicate to the compiler that +/// a particular block of code will not be executed in debug mode, and hence +/// can be removed. +/// +/// An alternative strategy is to use asserts, as in: +/// +/// ```dart +/// assert(() { +/// // ...debug-only code here... +/// return true; +/// }()); +/// ``` +/// +/// See also: +/// +/// * [kReleaseMode], which is true in release builds. +/// * [kProfileMode], which is true in profile builds. +@internal +const bool kDebugMode = !kReleaseMode && !kProfileMode; diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index 4a6f1cb76..8f05760b8 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -5,6 +5,7 @@ import 'dart:collection'; import 'package:meta/meta.dart'; import 'package:state_notifier/state_notifier.dart'; +import 'package:test/test.dart' as test; import 'internals.dart'; part 'framework/always_alive.dart'; diff --git a/packages/riverpod/lib/src/framework/provider_container.dart b/packages/riverpod/lib/src/framework/provider_container.dart index d90e4f8fa..629cf7790 100644 --- a/packages/riverpod/lib/src/framework/provider_container.dart +++ b/packages/riverpod/lib/src/framework/provider_container.dart @@ -95,6 +95,9 @@ var _debugVerifyDependenciesAreRespectedEnabled = true; /// /// If you are using Flutter, you do not need to care about this object /// (outside of testing), as it is implicitly created for you by `ProviderScope`. +/// +/// Inside tests, consider using [ProviderContainer.test]. +/// This will automatically dispose the container at the end of the test. /// {@endtemplate} @sealed class ProviderContainer implements Node { @@ -117,6 +120,12 @@ class ProviderContainer implements Node { }, _root = parent?._root ?? parent { if (parent != null) { + if (parent.disposed) { + throw StateError( + 'Cannot create a ProviderContainer that has a disposed parent', + ); + } + parent._children.add(this); _overrideForFamily.addAll(parent._overrideForFamily); } @@ -139,6 +148,27 @@ class ProviderContainer implements Node { } } + /// An automatically disposed [ProviderContainer]. + /// + /// This constructor works only inside tests, by relying on `package:test`'s + /// `addTearDown`. + @visibleForTesting + factory ProviderContainer.test({ + ProviderContainer? parent, + List overrides = const [], + List? observers, + }) { + // TODO changelog + final container = ProviderContainer( + parent: parent, + overrides: overrides, + observers: observers, + ); + test.addTearDown(container.dispose); + + return container; + } + final int _debugOverridesLength; /// The object that handles when providers are refreshed and disposed. @@ -619,6 +649,12 @@ final b = Provider((ref) => ref.watch(a), dependencies: [a]); void dispose() { if (_disposed) return; + if (children.any((child) => !child._disposed)) { + throw StateError( + 'Cannot dispose a ProviderContainer that still has children', + ); + } + _disposed = true; _parent?._children.remove(this); @@ -702,6 +738,16 @@ final b = Provider((ref) => ref.watch(a), dependencies: [a]); } } +@internal +extension ProviderContainerTest on ProviderContainer { + bool get disposed => _disposed; + + ProviderContainer? get root => _root; + ProviderContainer? get parent => _parent; + + List get children => _children; +} + /// An object that listens to the changes of a [ProviderContainer]. /// /// This can be used for logging or making devtools. diff --git a/packages/riverpod/lib/src/framework2/framework.dart b/packages/riverpod/lib/src/framework2/framework.dart index 3dd66e52e..77ab0bd95 100644 --- a/packages/riverpod/lib/src/framework2/framework.dart +++ b/packages/riverpod/lib/src/framework2/framework.dart @@ -45,6 +45,3 @@ typedef VoidCallback = void Function(); @internal typedef Build> = T Function(RefT ref); - -@internal -const kDebugMode = bool.fromEnvironment('dart.vm.product'); diff --git a/packages/riverpod/test/new/container_test.dart b/packages/riverpod/test/new/container_test.dart index 4f09cdda1..b65465055 100644 --- a/packages/riverpod/test/new/container_test.dart +++ b/packages/riverpod/test/new/container_test.dart @@ -1,8 +1,57 @@ -import 'package:riverpod/src/framework2/framework.dart'; +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; void main() { group('ProviderContainer', () { + group('constructor', () { + test('throws if "parent" is disposed', () { + // TODO changelog + + final root = ProviderContainer(); + root.dispose(); + + expect( + () => ProviderContainer(parent: root), + throwsStateError, + ); + }); + + test('if parent is null, assign "root" to "null"', () { + final container = ProviderContainer(); + addTearDown(container.dispose); + + expect(container.root, null); + }); + + test('if parent is not null, assign "root" to "parent.root"', () { + final root = ProviderContainer(); + addTearDown(root.dispose); + final container = ProviderContainer(parent: root); + addTearDown(container.dispose); + + expect(container.root, root); + }); + + test('assign "parent" to "this.parent"', () { + final root = ProviderContainer(); + addTearDown(root.dispose); + final container = ProviderContainer(parent: root); + addTearDown(container.dispose); + + expect(container.parent, root); + }); + + test('Adds "this" to "root.children"', () { + final root = ProviderContainer(); + addTearDown(root.dispose); + final container = ProviderContainer(parent: root); + addTearDown(container.dispose); + + expect(root.children, [container]); + }); + }); + group('.test', () { test('Auto-disposes the provider when the test ends', () { late ProviderContainer container; @@ -14,88 +63,141 @@ void main() { addTearDown(() => expect(container.disposed, false)); }); - group('exists', () { - test('simple use-case', () { - final container = ProviderContainer.test(); - final provider = Provider((ref) => 0); + test('Passes parameters', () { + final provider = Provider((ref) => 0); + final observer = _EmptyObserver(); + + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + observers: [observer], + overrides: [ + provider.overrideWithValue(1), + ], + ); + + expect(container.root, root); + expect(container.observers, [observer]); + expect(container.read(provider), 1); + }); + }); + + group('dispose', () { + test('throws if a child is not disposed', () { + final root = ProviderContainer.test(); + ProviderContainer.test(parent: root); + + expect(root.dispose, throwsStateError); + }); + + test('removes "this" from "root.children"', () { + final root = ProviderContainer.test(); + final container = ProviderContainer.test(parent: root); + final leaf = ProviderContainer.test(parent: container); + final leaf2 = ProviderContainer.test(parent: container); + + expect(root.children, [container]); + expect(container.children, [leaf, leaf2]); + expect(leaf.children, isEmpty); + expect(leaf2.children, isEmpty); - expect(container.exists(provider), false); - expect(container.getAllProviderElements(), isEmpty); + leaf.dispose(); - container.read(provider); + expect(root.children, [container]); + expect(container.children, [leaf2]); - expect(container.exists(provider), true); - }); + leaf2.dispose(); - test('handles autoDispose', () async { - final provider = Provider.autoDispose((ref) => 0); - final container = ProviderContainer.test( - overrides: [ - provider.overrideWith((ref) => 42), - ], - ); + expect(root.children, [container]); + expect(container.children, isEmpty); - expect(container.exists(provider), false); - expect(container.getAllProviderElements(), isEmpty); + container.dispose(); - container.read(provider); + expect(root.children, isEmpty); + }); + }); + + group('exists', () { + test('simple use-case', () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => 0); + + expect(container.exists(provider), false); + expect(container.getAllProviderElements(), isEmpty); - expect(container.exists(provider), true); + container.read(provider); - await container.pump(); + expect(container.exists(provider), true); + }); - expect(container.getAllProviderElements(), isEmpty); - expect(container.exists(provider), false); - expect(container.getAllProviderElements(), isEmpty); - }); + test('handles autoDispose', () async { + final provider = Provider.autoDispose((ref) => 0); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWith((ref) => 42), + ], + ); - test('Handles uninitialized overrideWith', () { - final provider = Provider((ref) => 0); - final container = ProviderContainer.test( - overrides: [ - provider.overrideWith((ref) => 42), - ], - ); + expect(container.exists(provider), false); + expect(container.getAllProviderElements(), isEmpty); - expect(container.exists(provider), false); - expect(container.getAllProviderElements(), isEmpty); + container.read(provider); - container.read(provider); + expect(container.exists(provider), true); - expect(container.exists(provider), true); - }); + await container.pump(); - test('handles nested providers', () { - final provider = Provider((ref) => 0); - final provider2 = Provider((ref) => 0); - final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider2]); + expect(container.getAllProviderElements(), isEmpty); + expect(container.exists(provider), false); + expect(container.getAllProviderElements(), isEmpty); + }); - expect(container.exists(provider), false); - expect(container.exists(provider2), false); - expect(container.getAllProviderElements(), isEmpty); - expect(root.getAllProviderElements(), isEmpty); + test('Handles uninitialized overrideWith', () { + final provider = Provider((ref) => 0); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWith((ref) => 42), + ], + ); - container.read(provider); + expect(container.exists(provider), false); + expect(container.getAllProviderElements(), isEmpty); - expect(container.exists(provider), true); - expect(container.exists(provider2), false); - expect(container.getAllProviderElements(), isEmpty); - expect( - root.getAllProviderElements().map((e) => e.origin), [provider]); + container.read(provider); - container.read(provider2); + expect(container.exists(provider), true); + }); - expect(container.exists(provider2), true); - expect( - container.getAllProviderElements().map((e) => e.origin), - [provider2], - ); - expect( - root.getAllProviderElements().map((e) => e.origin), [provider]); - }); + test('handles nested providers', () { + final provider = Provider((ref) => 0); + final provider2 = Provider((ref) => 0); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider2]); + + expect(container.exists(provider), false); + expect(container.exists(provider2), false); + expect(container.getAllProviderElements(), isEmpty); + expect(root.getAllProviderElements(), isEmpty); + + container.read(provider); + + expect(container.exists(provider), true); + expect(container.exists(provider2), false); + expect(container.getAllProviderElements(), isEmpty); + expect(root.getAllProviderElements().map((e) => e.origin), [provider]); + + container.read(provider2); + + expect(container.exists(provider2), true); + expect( + container.getAllProviderElements().map((e) => e.origin), + [provider2], + ); + expect(root.getAllProviderElements().map((e) => e.origin), [provider]); }); }); }); } + +class _EmptyObserver extends ProviderObserver {} From 333d878d5e52baa467842e3cc9a17e2f050ffeb3 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 15:43:06 +0100 Subject: [PATCH 056/387] Make ProviderContainer.dispose recursive --- .../lib/src/framework/provider_container.dart | 36 +++++++++---- .../riverpod/test/new/container_test.dart | 54 +++++++++++++++++-- packages/riverpod/test/new/utils.dart | 27 ++++++++++ 3 files changed, 104 insertions(+), 13 deletions(-) create mode 100644 packages/riverpod/test/new/utils.dart diff --git a/packages/riverpod/lib/src/framework/provider_container.dart b/packages/riverpod/lib/src/framework/provider_container.dart index 629cf7790..e5f2d3d41 100644 --- a/packages/riverpod/lib/src/framework/provider_container.dart +++ b/packages/riverpod/lib/src/framework/provider_container.dart @@ -642,21 +642,24 @@ final b = Provider((ref) => ref.watch(a), dependencies: [a]); return _stateReaders[provider] = getReader(); } - /// Release all the resources associated with this [ProviderContainer]. - /// - /// This will destroy the state of all providers associated with this - /// [ProviderContainer] and call [Ref.onDispose] listeners. - void dispose() { + void _dispose({ + // A flag to optimize recursive dispose calls. + // When disposing a graph of containers, there is no need to call `children.remove` + // individually, as all children will be disposed at once. + required bool updateChildren, + }) { if (_disposed) return; - if (children.any((child) => !child._disposed)) { - throw StateError( - 'Cannot dispose a ProviderContainer that still has children', - ); + // We dispose children before disposing "this" + // This is important to dispose providers from leaves to roots. + // We can safely iterate over "children" without using "toList" thanks to + // the "updateChildren" flag. + for (final child in _children) { + child._dispose(updateChildren: false); } _disposed = true; - _parent?._children.remove(this); + if (updateChildren) _parent?._children.remove(this); if (_root == null) scheduler.dispose(); @@ -665,6 +668,19 @@ final b = Provider((ref) => ref.watch(a), dependencies: [a]); } } + /// Release all the resources associated with this [ProviderContainer]. + /// + /// This will destroy the state of all providers associated with this + /// [ProviderContainer] and call [Ref.onDispose] listeners. + /// + /// It is safe to call this method multiple times. Subsequent calls will be no-op. + /// + /// TODO changelog + /// If this container has non-disposed child [ProviderContainer]s (cf `parent`), + /// then this method will dispose those children first. + /// Therefore, disposing the root [ProviderContainer] the entire graph. + void dispose() => _dispose(updateChildren: true); + /// Traverse the [ProviderElementBase]s associated with this [ProviderContainer]. Iterable> getAllProviderElements() sync* { for (final reader in _stateReaders.values) { diff --git a/packages/riverpod/test/new/container_test.dart b/packages/riverpod/test/new/container_test.dart index b65465055..00be8e345 100644 --- a/packages/riverpod/test/new/container_test.dart +++ b/packages/riverpod/test/new/container_test.dart @@ -1,7 +1,10 @@ +import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; +import 'utils.dart'; + void main() { group('ProviderContainer', () { group('constructor', () { @@ -83,11 +86,56 @@ void main() { }); group('dispose', () { - test('throws if a child is not disposed', () { + test('Disposes its children first', () { + final rootOnDispose = OnDisposeMock(); + final childOnDispose = OnDisposeMock(); + final child2OnDispose = OnDisposeMock(); + final provider = Provider((ref) { + ref.onDispose(rootOnDispose.call); + return 0; + }); + final root = ProviderContainer.test(); - ProviderContainer.test(parent: root); + final container = ProviderContainer.test( + parent: root, + overrides: [ + provider.overrideWith((ref) { + ref.onDispose(childOnDispose.call); + return 0; + }), + ], + ); + final container2 = ProviderContainer.test( + parent: root, + overrides: [ + provider.overrideWith((ref) { + ref.onDispose(child2OnDispose.call); + return 0; + }), + ], + ); + + root.listen(provider, (previous, next) {}); + container.listen(provider, (previous, next) {}); + container2.listen(provider, (previous, next) {}); + + container2.dispose(); + + verifyOnly(child2OnDispose, child2OnDispose.call()); + verifyZeroInteractions(childOnDispose); + verifyZeroInteractions(rootOnDispose); + expect(container.disposed, false); + expect(root.disposed, false); + + root.dispose(); + + verifyInOrder([ + childOnDispose.call(), + rootOnDispose.call(), + ]); - expect(root.dispose, throwsStateError); + expect(container.disposed, true); + expect(root.disposed, true); }); test('removes "this" from "root.children"', () { diff --git a/packages/riverpod/test/new/utils.dart b/packages/riverpod/test/new/utils.dart new file mode 100644 index 000000000..0b4594c5b --- /dev/null +++ b/packages/riverpod/test/new/utils.dart @@ -0,0 +1,27 @@ +import 'package:mockito/mockito.dart'; + +class OnDisposeMock extends Mock { + void call(); +} + +/// Syntax sugar for: +/// +/// ```dart +/// verify(mock()).called(1); +/// verifyNoMoreInteractions(mock); +/// ``` +VerifyOnly get verifyOnly { + final verification = verify; + + return (mock, invocation) { + final result = verification(invocation); + result.called(1); + verifyNoMoreInteractions(mock); + return result; + }; +} + +typedef VerifyOnly = VerificationResult Function( + Mock mock, + T matchingInvocations, +); From cad32e767eb91705fa2ca5117f2ab63679f90dcc Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 16:00:10 +0100 Subject: [PATCH 057/387] Remove migrated test --- .../test/old/framework/provider_container_test.dart | 9 --------- 1 file changed, 9 deletions(-) diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 6367e47cd..5028bfabc 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -7,15 +7,6 @@ import '../utils.dart'; void main() { group('ProviderContainer', () { - test('Supports unmounting containers in reverse order', () { - final container = createContainer(); - - final child = createContainer(parent: container); - - container.dispose(); - child.dispose(); - }); - group('when unmounting providers', () { test( 'cleans up all the StateReaders of a provider in the entire ProviderContainer tree', From 356a5cdf072ba7302947a4e4241ab3a95a213267 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 16:39:42 +0100 Subject: [PATCH 058/387] Throw if the same provider/family is overridden twice And register containers in a global devtool binding --- packages/riverpod/lib/riverpod.dart | 3 +- packages/riverpod/lib/src/framework.dart | 2 + .../riverpod/lib/src/framework/devtool.dart | 17 ++++ .../lib/src/framework/provider_container.dart | 26 +++++- .../riverpod/test/new/container_test.dart | 93 +++++++++++++++++++ 5 files changed, 139 insertions(+), 2 deletions(-) create mode 100644 packages/riverpod/lib/src/framework/devtool.dart diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index a6e5756f1..ed1d33c94 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -51,7 +51,8 @@ export 'src/framework.dart' Node, ProviderElementProxy, OnError, - ProviderContainerTest; + ProviderContainerTest, + DebugRiverpodDevtoolBiding; export 'src/future_provider.dart'; diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index 8f05760b8..653ef5dc1 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -6,6 +6,7 @@ import 'dart:collection'; import 'package:meta/meta.dart'; import 'package:state_notifier/state_notifier.dart'; import 'package:test/test.dart' as test; +import 'env.dart'; import 'internals.dart'; part 'framework/always_alive.dart'; @@ -22,3 +23,4 @@ part 'framework/ref.dart'; part 'framework/selector.dart'; part 'framework/scheduler.dart'; part 'framework/value_provider.dart'; +part 'framework/devtool.dart'; diff --git a/packages/riverpod/lib/src/framework/devtool.dart b/packages/riverpod/lib/src/framework/devtool.dart new file mode 100644 index 000000000..6e483608d --- /dev/null +++ b/packages/riverpod/lib/src/framework/devtool.dart @@ -0,0 +1,17 @@ +part of '../framework.dart'; + +@internal +abstract class DebugRiverpodDevtoolBiding { + static final _containers = []; + + static List get containers => + UnmodifiableListView(_containers); + + static void addContainer(ProviderContainer container) { + _containers.add(container); + } + + static void removeContainer(ProviderContainer container) { + _containers.remove(container); + } +} diff --git a/packages/riverpod/lib/src/framework/provider_container.dart b/packages/riverpod/lib/src/framework/provider_container.dart index e5f2d3d41..66fc37b38 100644 --- a/packages/riverpod/lib/src/framework/provider_container.dart +++ b/packages/riverpod/lib/src/framework/provider_container.dart @@ -126,12 +126,19 @@ class ProviderContainer implements Node { ); } - parent._children.add(this); _overrideForFamily.addAll(parent._overrideForFamily); } for (final override in overrides) { if (override is ProviderOverride) { + final previousReader = _stateReaders[override._origin]; + if (previousReader != null && previousReader.container == this) { + // The provider was already overridden in this container. + throw StateError( + 'Cannot override a provider twice within the same container: ${override._origin}', + ); + } + _overrideForProvider[override._origin] = override._override; _stateReaders[override._origin] = _StateReader( origin: override._origin, @@ -140,12 +147,25 @@ class ProviderContainer implements Node { isDynamicallyCreated: false, ); } else if (override is FamilyOverride) { + final previousOverride = _overrideForFamily[override.overriddenFamily]; + if (previousOverride != null && previousOverride.container == this) { + throw StateError( + 'Cannot override a family twice within the same container: ${override.overriddenFamily}', + ); + } + _overrideForFamily[override.overriddenFamily] = _FamilyOverrideRef( override, this, ); } } + + // Mutate the parent & global state only at the very end. + // This ensures that if an error is thrown, the parent & global state + // are not affected. + parent?._children.add(this); + if (kDebugMode) DebugRiverpodDevtoolBiding.addContainer(this); } /// An automatically disposed [ProviderContainer]. @@ -666,6 +686,10 @@ final b = Provider((ref) => ref.watch(a), dependencies: [a]); for (final element in getAllProviderElementsInOrder().toList().reversed) { element.dispose(); } + + if (kDebugMode) { + DebugRiverpodDevtoolBiding.removeContainer(this); + } } /// Release all the resources associated with this [ProviderContainer]. diff --git a/packages/riverpod/test/new/container_test.dart b/packages/riverpod/test/new/container_test.dart index 00be8e345..4d9f6e891 100644 --- a/packages/riverpod/test/new/container_test.dart +++ b/packages/riverpod/test/new/container_test.dart @@ -6,8 +6,20 @@ import 'package:test/test.dart'; import 'utils.dart'; void main() { + tearDown(() { + // Verifies that there is no container leak. + expect(DebugRiverpodDevtoolBiding.containers, isEmpty); + }); + group('ProviderContainer', () { group('constructor', () { + test('registers itself in the container list', () { + final container = ProviderContainer(); + addTearDown(container.dispose); + + expect(DebugRiverpodDevtoolBiding.containers, [container]); + }); + test('throws if "parent" is disposed', () { // TODO changelog @@ -18,6 +30,17 @@ void main() { () => ProviderContainer(parent: root), throwsStateError, ); + + expect( + root.children, + isEmpty, + reason: 'Invalid containers should not be added as children', + ); + expect( + DebugRiverpodDevtoolBiding.containers, + isEmpty, + reason: 'Invalid containers should not be added to the global list', + ); }); test('if parent is null, assign "root" to "null"', () { @@ -53,6 +76,65 @@ void main() { expect(root.children, [container]); }); + + group('overrides', () { + test( + 'throws if the same provider is overridden twice in the same container', + () { + // TODO changelog + final provider = Provider((ref) => 0); + + expect( + () => ProviderContainer( + overrides: [ + provider.overrideWithValue(42), + provider.overrideWithValue(21), + ], + ), + throwsStateError, + ); + }); + + test( + 'throws if the same family is overridden twice in the same container', + () { + // TODO changelog + final provider = Provider.family((ref, id) => 0); + + expect( + () => ProviderContainer( + overrides: [ + provider.overrideWith((ref, arg) => arg), + provider.overrideWith((ref, arg) => arg), + ], + ), + throwsStateError, + ); + }); + + test( + 'supports overriding an already overridden provider/family in a different container', + () { + final provider = Provider((ref) => 0); + final family = Provider.family((ref, id) => 0); + final root = ProviderContainer( + overrides: [ + provider.overrideWithValue(42), + family.overrideWith((ref, arg) => arg), + ], + ); + addTearDown(root.dispose); + + final container = ProviderContainer( + parent: root, + overrides: [ + provider.overrideWithValue(21), + family.overrideWith((ref, arg) => arg * 2), + ], + ); + addTearDown(container.dispose); + }); + }); }); group('.test', () { @@ -86,6 +168,17 @@ void main() { }); group('dispose', () { + test('unregisters itself from the container list', () { + final container = ProviderContainer(); + addTearDown(container.dispose); + + expect(DebugRiverpodDevtoolBiding.containers, [container]); + + container.dispose(); + + expect(DebugRiverpodDevtoolBiding.containers, isEmpty); + }); + test('Disposes its children first', () { final rootOnDispose = OnDisposeMock(); final childOnDispose = OnDisposeMock(); From 5ebccbf6121aab37a9fa64e7c4fd148254c3aa12 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 16:45:41 +0100 Subject: [PATCH 059/387] Remove out of date test --- .../framework/provider_container_test.dart | 36 ------------------- 1 file changed, 36 deletions(-) diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 5028bfabc..d10c79b9f 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -144,42 +144,6 @@ void main() { verifyOnly(listener, listener(0, 1)); }); - test( - 'when the same provider is overridden multiple times at once, uses the latest override', - () { - final provider = Provider((ref) => 0); - final container = createContainer( - overrides: [ - provider.overrideWithValue(21), - provider.overrideWithValue(42), - ], - ); - - expect(container.read(provider), 42); - expect(container.getAllProviderElements(), [ - isA>() - .having((e) => e.origin, 'origin', provider), - ]); - }); - - test( - 'when the same family is overridden multiple times at once, uses the latest override', - () { - final provider = Provider.family((ref, value) => 0); - final container = createContainer( - overrides: [ - provider.overrideWith((ref, value) => 21), - provider.overrideWith((ref, value) => 42), - ], - ); - - expect(container.read(provider(0)), 42); - expect(container.getAllProviderElements(), [ - isA>() - .having((e) => e.origin, 'origin', provider(0)), - ]); - }); - group('validate that properties respect `dependencies`', () { test('on reading an element, asserts that dependencies are respected', () { From a56d67e005b8ea605a3598a7e3c9942be33c4b83 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 16:48:11 +0100 Subject: [PATCH 060/387] Promote test --- .../riverpod/test/new/container_test.dart | 24 ++++++++++++++++++- packages/riverpod/test/new/utils.dart | 4 ++++ .../framework/provider_container_test.dart | 21 ---------------- 3 files changed, 27 insertions(+), 22 deletions(-) diff --git a/packages/riverpod/test/new/container_test.dart b/packages/riverpod/test/new/container_test.dart index 4d9f6e891..575f75ec1 100644 --- a/packages/riverpod/test/new/container_test.dart +++ b/packages/riverpod/test/new/container_test.dart @@ -168,7 +168,29 @@ void main() { }); group('dispose', () { - test('unregisters itself from the container list', () { + test( + 'after a child container is disposed, ' + 'ref.watch keeps working on providers associated with the ancestor container', + () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final provider = Provider((ref) => ref.watch(dep)); + final listener = Listener(); + final child = ProviderContainer.test(parent: container); + + container.listen(provider, listener.call, fireImmediately: true); + + verifyOnly(listener, listener(null, 0)); + + child.dispose(); + + container.read(dep.notifier).state++; + await container.pump(); + + verifyOnly(listener, listener(0, 1)); + }); + + test('unregister itself from the container list', () { final container = ProviderContainer(); addTearDown(container.dispose); diff --git a/packages/riverpod/test/new/utils.dart b/packages/riverpod/test/new/utils.dart index 0b4594c5b..21ff388af 100644 --- a/packages/riverpod/test/new/utils.dart +++ b/packages/riverpod/test/new/utils.dart @@ -25,3 +25,7 @@ typedef VerifyOnly = VerificationResult Function( Mock mock, T matchingInvocations, ); + +class Listener extends Mock { + void call(T? previous, T? next); +} diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index d10c79b9f..6b779299d 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -198,27 +198,6 @@ void main() { }); }); - test( - 'after a child container is disposed, ref.watch keeps working on providers associated with the ancestor container', - () async { - final container = createContainer(); - final dep = StateProvider((ref) => 0); - final provider = Provider((ref) => ref.watch(dep)); - final listener = Listener(); - final child = createContainer(parent: container); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(listener, listener(null, 0)); - - child.dispose(); - - container.read(dep.notifier).state++; - await container.pump(); - - verifyOnly(listener, listener(0, 1)); - }); - test( 'flushes listened-to providers even if they have no external listeners', () async { From 5d0853c4ac4d3b340db74298665bed5205fbabfd Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 16:48:19 +0100 Subject: [PATCH 061/387] Rename --- .../new/{container_test.dart => provider_container_test.dart} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename packages/riverpod/test/new/{container_test.dart => provider_container_test.dart} (100%) diff --git a/packages/riverpod/test/new/container_test.dart b/packages/riverpod/test/new/provider_container_test.dart similarity index 100% rename from packages/riverpod/test/new/container_test.dart rename to packages/riverpod/test/new/provider_container_test.dart From 49a6cb136975813ad0531ec058134c1be132e657 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 16:49:41 +0100 Subject: [PATCH 062/387] Promote test --- .../test/new/provider_container_test.dart | 33 +++++++++++++++++++ .../framework/provider_container_test.dart | 33 ------------------- 2 files changed, 33 insertions(+), 33 deletions(-) diff --git a/packages/riverpod/test/new/provider_container_test.dart b/packages/riverpod/test/new/provider_container_test.dart index 575f75ec1..66c649ddf 100644 --- a/packages/riverpod/test/new/provider_container_test.dart +++ b/packages/riverpod/test/new/provider_container_test.dart @@ -360,6 +360,39 @@ void main() { expect(root.getAllProviderElements().map((e) => e.origin), [provider]); }); }); + + group('.pump', () { + test( + 'Waits for providers associated with this container and its parents to rebuild', + () async { + final dep = StateProvider((ref) => 0); + final a = Provider((ref) => ref.watch(dep)); + final b = Provider((ref) => ref.watch(dep)); + final aListener = Listener(); + final bListener = Listener(); + + final root = ProviderContainer.test(); + final scoped = ProviderContainer.test(parent: root, overrides: [b]); + + scoped.listen(a, aListener.call, fireImmediately: true); + scoped.listen(b, bListener.call, fireImmediately: true); + + verifyOnly(aListener, aListener(null, 0)); + verifyOnly(bListener, bListener(null, 0)); + + root.read(dep.notifier).state++; + await scoped.pump(); + + verifyOnly(aListener, aListener(0, 1)); + verifyOnly(bListener, bListener(0, 1)); + + scoped.read(dep.notifier).state++; + await scoped.pump(); + + verifyOnly(aListener, aListener(1, 2)); + verifyOnly(bListener, bListener(1, 2)); + }); + }); }); } diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 6b779299d..70f9aa5be 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -234,39 +234,6 @@ void main() { expect(container.read(another), 1); }); - group('.pump', () { - test( - 'Waits for providers associated with this container and its parents to rebuild', - () async { - final dep = StateProvider((ref) => 0); - final a = Provider((ref) => ref.watch(dep)); - final b = Provider((ref) => ref.watch(dep)); - final aListener = Listener(); - final bListener = Listener(); - - final root = createContainer(); - final scoped = createContainer(parent: root, overrides: [b]); - - scoped.listen(a, aListener.call, fireImmediately: true); - scoped.listen(b, bListener.call, fireImmediately: true); - - verifyOnly(aListener, aListener(null, 0)); - verifyOnly(bListener, bListener(null, 0)); - - root.read(dep.notifier).state++; - await scoped.pump(); - - verifyOnly(aListener, aListener(0, 1)); - verifyOnly(bListener, bListener(0, 1)); - - scoped.read(dep.notifier).state++; - await scoped.pump(); - - verifyOnly(aListener, aListener(1, 2)); - verifyOnly(bListener, bListener(1, 2)); - }); - }); - test('depth', () { final root = createContainer(); final a = createContainer(parent: root); From 15f7bb4107ba4a7d0ded898c1dd99a09c181d77d Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 16:51:57 +0100 Subject: [PATCH 063/387] depth --- .../lib/src/framework/provider_container.dart | 1 + .../test/new/provider_container_test.dart | 15 +++++++++++++++ .../old/framework/provider_container_test.dart | 15 --------------- 3 files changed, 16 insertions(+), 15 deletions(-) diff --git a/packages/riverpod/lib/src/framework/provider_container.dart b/packages/riverpod/lib/src/framework/provider_container.dart index 66fc37b38..1b944bafc 100644 --- a/packages/riverpod/lib/src/framework/provider_container.dart +++ b/packages/riverpod/lib/src/framework/provider_container.dart @@ -198,6 +198,7 @@ class ProviderContainer implements Node { /// How deep this [ProviderContainer] is in the graph of containers. /// /// Starts at 0. + /// TODO check this is still used after refactoring final int depth; final ProviderContainer? _root; final ProviderContainer? _parent; diff --git a/packages/riverpod/test/new/provider_container_test.dart b/packages/riverpod/test/new/provider_container_test.dart index 66c649ddf..3fe9ad70e 100644 --- a/packages/riverpod/test/new/provider_container_test.dart +++ b/packages/riverpod/test/new/provider_container_test.dart @@ -393,6 +393,21 @@ void main() { verifyOnly(bListener, bListener(1, 2)); }); }); + + test('depth', () { + final root = ProviderContainer.test(); + final a = ProviderContainer.test(parent: root); + final b = ProviderContainer.test(parent: a); + final c = ProviderContainer.test(parent: a); + + final root2 = ProviderContainer.test(); + + expect(root.depth, 0); + expect(root2.depth, 0); + expect(a.depth, 1); + expect(b.depth, 2); + expect(c.depth, 2); + }); }); } diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 70f9aa5be..81e4e3687 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -234,21 +234,6 @@ void main() { expect(container.read(another), 1); }); - test('depth', () { - final root = createContainer(); - final a = createContainer(parent: root); - final b = createContainer(parent: a); - final c = createContainer(parent: a); - - final root2 = createContainer(); - - expect(root.depth, 0); - expect(root2.depth, 0); - expect(a.depth, 1); - expect(b.depth, 2); - expect(c.depth, 2); - }); - group('getAllProviderElements', () { test('list scoped providers that depends on nothing', () { final scopedProvider = Provider((ref) => 0); From c1f35e87cd175677e924ece5d39776d55d6ea3a4 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 16:56:10 +0100 Subject: [PATCH 064/387] Promote more tests --- .../test/new/provider_container_test.dart | 68 +++++++++++++++++++ .../framework/provider_container_test.dart | 66 ------------------ 2 files changed, 68 insertions(+), 66 deletions(-) diff --git a/packages/riverpod/test/new/provider_container_test.dart b/packages/riverpod/test/new/provider_container_test.dart index 3fe9ad70e..9c1aaf1e4 100644 --- a/packages/riverpod/test/new/provider_container_test.dart +++ b/packages/riverpod/test/new/provider_container_test.dart @@ -408,6 +408,74 @@ void main() { expect(b.depth, 2); expect(c.depth, 2); }); + + group('listen', () { + test('can downcast the listener value', () { + final container = ProviderContainer.test(); + final provider = StateProvider((ref) => 0); + final listener = Listener(); + + container.listen(provider, listener.call); + + verifyZeroInteractions(listener); + + container.read(provider.notifier).state++; + + verifyOnly(listener, listener(any, any)); + }); + + test( + 'can close a ProviderSubscription multiple times with no effect', + () { + final container = ProviderContainer.test(); + final provider = + StateNotifierProvider, int>((ref) { + return StateController(0); + }); + final listener = Listener(); + + final controller = container.read(provider.notifier); + + final sub = container.listen(provider, listener.call); + + sub.close(); + sub.close(); + + controller.state++; + + verifyZeroInteractions(listener); + }, + ); + + test( + 'closing an already closed ProviderSubscription does not remove subscriptions with the same listener', + () { + final container = ProviderContainer.test(); + final provider = + StateNotifierProvider, int>((ref) { + return StateController(0); + }); + final listener = Listener(); + + final controller = container.read(provider.notifier); + + final sub = container.listen(provider, listener.call); + container.listen(provider, listener.call); + + controller.state++; + + verify(listener(0, 1)).called(2); + verifyNoMoreInteractions(listener); + + sub.close(); + sub.close(); + + controller.state++; + + verifyOnly(listener, listener(1, 2)); + }, + ); + }); }); } diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 81e4e3687..5270bd9bd 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -400,72 +400,6 @@ void main() { expect(buildCount, 1); }); - test('can downcast the listener value', () { - final container = createContainer(); - final provider = StateProvider((ref) => 0); - final listener = Listener(); - - container.listen(provider, listener.call); - - verifyZeroInteractions(listener); - - container.read(provider.notifier).state++; - - verifyOnly(listener, listener(any, any)); - }); - - test( - 'can close a ProviderSubscription multiple times with no effect', - () { - final container = createContainer(); - final provider = - StateNotifierProvider, int>((ref) { - return StateController(0); - }); - final listener = Listener(); - - final controller = container.read(provider.notifier); - - final sub = container.listen(provider, listener.call); - - sub.close(); - sub.close(); - - controller.state++; - - verifyZeroInteractions(listener); - }, - ); - - test( - 'closing an already closed ProviderSubscription does not remove subscriptions with the same listener', - () { - final container = createContainer(); - final provider = - StateNotifierProvider, int>((ref) { - return StateController(0); - }); - final listener = Listener(); - - final controller = container.read(provider.notifier); - - final sub = container.listen(provider, listener.call); - container.listen(provider, listener.call); - - controller.state++; - - verify(listener(0, 1)).called(2); - verifyNoMoreInteractions(listener); - - sub.close(); - sub.close(); - - controller.state++; - - verifyOnly(listener, listener(1, 2)); - }, - ); - test('builds providers at most once per container', () { var result = 42; final container = createContainer(); From 351f6632869c49a18b28fe976570bb16dc156277 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 16:59:46 +0100 Subject: [PATCH 065/387] More --- .../test/new/provider_container_test.dart | 17 +++++++++++++++++ packages/riverpod/test/new/utils.dart | 3 +++ .../old/framework/provider_container_test.dart | 16 ---------------- 3 files changed, 20 insertions(+), 16 deletions(-) diff --git a/packages/riverpod/test/new/provider_container_test.dart b/packages/riverpod/test/new/provider_container_test.dart index 9c1aaf1e4..2ab23b393 100644 --- a/packages/riverpod/test/new/provider_container_test.dart +++ b/packages/riverpod/test/new/provider_container_test.dart @@ -409,6 +409,23 @@ void main() { expect(c.depth, 2); }); + group('updateOverrides', () { + test('is not allowed to remove overrides ', () { + final provider = Provider((_) => 0); + + final container = ProviderContainer.test( + overrides: [provider.overrideWithValue(42)], + ); + + expect(container.read(provider), 42); + + expect( + () => container.updateOverrides([]), + throwsA(isAssertionError), + ); + }); + }); + group('listen', () { test('can downcast the listener value', () { final container = ProviderContainer.test(); diff --git a/packages/riverpod/test/new/utils.dart b/packages/riverpod/test/new/utils.dart index 21ff388af..caa067cd3 100644 --- a/packages/riverpod/test/new/utils.dart +++ b/packages/riverpod/test/new/utils.dart @@ -1,4 +1,5 @@ import 'package:mockito/mockito.dart'; +import 'package:test/test.dart'; class OnDisposeMock extends Mock { void call(); @@ -29,3 +30,5 @@ typedef VerifyOnly = VerificationResult Function( class Listener extends Mock { void call(T? previous, T? next); } + +final isAssertionError = isA(); diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 5270bd9bd..27fff2f52 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -182,22 +182,6 @@ void main() { }); }); - group('updateOverrides', () { - test('is not allowed to remove overrides ', () { - final provider = Provider((_) => 0); - - final container = - createContainer(overrides: [provider.overrideWithValue(42)]); - - expect(container.read(provider), 42); - - expect( - () => container.updateOverrides([]), - throwsA(isAssertionError), - ); - }); - }); - test( 'flushes listened-to providers even if they have no external listeners', () async { From 607eb72c7de576dcced13c2d484bfe0b423352b9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 17:10:10 +0100 Subject: [PATCH 066/387] Promote more tests --- .../test/new/provider_container_test.dart | 167 ++++++++++++++++++ .../test/old/legacy/framework_test.dart | 32 ---- .../old/providers/provider/provider_test.dart | 43 ----- .../scoped_provider/scoped_provider_test.dart | 84 --------- 4 files changed, 167 insertions(+), 159 deletions(-) diff --git a/packages/riverpod/test/new/provider_container_test.dart b/packages/riverpod/test/new/provider_container_test.dart index 2ab23b393..cb51234a1 100644 --- a/packages/riverpod/test/new/provider_container_test.dart +++ b/packages/riverpod/test/new/provider_container_test.dart @@ -190,6 +190,19 @@ void main() { verifyOnly(listener, listener(0, 1)); }); + test('does not compute provider states if not loaded yet', () { + var callCount = 0; + final provider = Provider((_) => callCount++); + + final container = ProviderContainer.test( + overrides: [provider], + ); + + container.dispose(); + + expect(callCount, 0); + }); + test('unregister itself from the container list', () { final container = ProviderContainer(); addTearDown(container.dispose); @@ -424,6 +437,160 @@ void main() { throwsA(isAssertionError), ); }); + + test('changing the override type at a given index throws', () { + final provider = Provider((ref) => 0); + final family = Provider.family((ref, value) => 0); + final container = ProviderContainer.test(overrides: [family]); + + expect( + () => container.updateOverrides([provider]), + throwsA(isA()), + ); + }); + + test('does not compute provider states if not loaded yet', () { + var callCount = 0; + final provider = Provider((_) => callCount++); + + final container = ProviderContainer.test( + overrides: [provider], + ); + + container.updateOverrides([provider]); + + expect(callCount, 0); + + container.dispose(); + + expect(callCount, 0); + }); + + test('does not notify listeners if updated with the same value', () { + final provider = Provider((ref) => 0); + final container = ProviderContainer.test( + overrides: [provider.overrideWithValue(42)], + ); + final listener = Listener(); + + addTearDown(container.dispose); + + container.listen(provider, listener.call, fireImmediately: true); + + verifyOnly(listener, listener(null, 42)); + + container.updateOverrides([ + provider.overrideWithValue(42), + ]); + + expect(container.read(provider), 42); + verifyNoMoreInteractions(listener); + }); + + test('notify listeners when value changes', () { + final provider = Provider((ref) => 0); + final container = ProviderContainer.test( + overrides: [provider.overrideWithValue(42)], + ); + final listener = Listener(); + + addTearDown(container.dispose); + + container.listen(provider, listener.call, fireImmediately: true); + + verifyOnly(listener, listener(null, 42)); + + container.updateOverrides([ + provider.overrideWithValue(21), + ]); + + verifyOnly(listener, listener(42, 21)); + }); + + test('updating parent override when there is a child override is no-op', + () async { + final provider = Provider((ref) => 0); + final root = ProviderContainer.test( + overrides: [provider.overrideWithValue(21)], + ); + final container = ProviderContainer.test( + parent: root, + overrides: [provider.overrideWithValue(42)], + ); + final listener = Listener(); + + container.listen(provider, listener.call, fireImmediately: true); + + verifyOnly(listener, listener(null, 42)); + + root.updateOverrides([ + provider.overrideWithValue(22), + ]); + + await container.pump(); + + verifyNoMoreInteractions(listener); + }); + + test('can update multiple ScopeProviders at once', () { + final provider = Provider((ref) => -1); + final provider2 = Provider((ref) => -1); + + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(21), + provider2.overrideWithValue(42), + ], + ); + + final listener = Listener(); + final listener2 = Listener(); + + container.listen(provider, listener.call, fireImmediately: true); + container.listen(provider2, listener2.call, fireImmediately: true); + + verifyOnly(listener, listener(null, 21)); + verifyOnly(listener2, listener2(null, 42)); + + container.updateOverrides([ + provider.overrideWithValue(22), + provider2.overrideWithValue(43), + ]); + + verifyInOrder([ + listener(21, 22), + listener2(42, 43), + ]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test( + 'if listened from a child container, ' + 'updating the parent override correctly notifies listeners', () { + final provider = Provider((ref) => 0); + final root = ProviderContainer.test( + overrides: [provider.overrideWithValue(1)], + ); + final mid = ProviderContainer.test( + parent: root, + overrides: [ + provider.overrideWithValue(42), + ], + ); + final container = ProviderContainer.test(parent: mid); + final listener = Listener(); + + container.listen(provider, listener.call, fireImmediately: true); + + verifyOnly(listener, listener(null, 42)); + + mid.updateOverrides([ + provider.overrideWithValue(21), + ]); + + verifyOnly(listener, listener(42, 21)); + }); }); group('listen', () { diff --git a/packages/riverpod/test/old/legacy/framework_test.dart b/packages/riverpod/test/old/legacy/framework_test.dart index 46680abb8..2c1a62e21 100644 --- a/packages/riverpod/test/old/legacy/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework_test.dart @@ -50,17 +50,6 @@ void main() { ]); }); - test('changing the override type at a given index throws', () { - final provider = Provider((ref) => 0); - final family = Provider.family((ref, value) => 0); - final container = createContainer(overrides: [family]); - - expect( - () => container.updateOverrides([provider]), - throwsA(isA()), - ); - }); - test("can't call onDispose inside onDispose", () { final provider = Provider((ref) { ref.onDispose(() { @@ -138,27 +127,6 @@ void main() { expect(value21, 1); }); - test( - "updating overrides / dispose don't compute provider states if not loaded yet", - () { - var callCount = 0; - final provider = Provider((_) => callCount++); - - final container = createContainer( - overrides: [provider], - ); - - expect(callCount, 0); - - container.updateOverrides([provider]); - - expect(callCount, 0); - - container.dispose(); - - expect(callCount, 0); - }); - test('circular dependencies (sync)', () { late Provider provider; diff --git a/packages/riverpod/test/old/providers/provider/provider_test.dart b/packages/riverpod/test/old/providers/provider/provider_test.dart index 737d0f487..be4be6707 100644 --- a/packages/riverpod/test/old/providers/provider/provider_test.dart +++ b/packages/riverpod/test/old/providers/provider/provider_test.dart @@ -218,49 +218,6 @@ void main() { }); }); - group('override', () { - test('does not notify listeners if updated with the same value', () { - final provider = Provider((ref) => 0); - final container = createContainer( - overrides: [provider.overrideWithValue(42)], - ); - final listener = Listener(); - - addTearDown(container.dispose); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(listener, listener(null, 42)); - - container.updateOverrides([ - provider.overrideWithValue(42), - ]); - - expect(container.read(provider), 42); - verifyNoMoreInteractions(listener); - }); - - test('notify listeners when value changes', () { - final provider = Provider((ref) => 0); - final container = createContainer( - overrides: [provider.overrideWithValue(42)], - ); - final listener = Listener(); - - addTearDown(container.dispose); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(listener, listener(null, 42)); - - container.updateOverrides([ - provider.overrideWithValue(21), - ]); - - verifyOnly(listener, listener(42, 21)); - }); - }); - test('can specify name', () { final provider = Provider( (_) => 0, diff --git a/packages/riverpod/test/old/providers/scoped_provider/scoped_provider_test.dart b/packages/riverpod/test/old/providers/scoped_provider/scoped_provider_test.dart index 4307aad04..530e5cd48 100644 --- a/packages/riverpod/test/old/providers/scoped_provider/scoped_provider_test.dart +++ b/packages/riverpod/test/old/providers/scoped_provider/scoped_provider_test.dart @@ -1,4 +1,3 @@ -import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; @@ -59,31 +58,6 @@ void main() { expect(root.read(provider), 21); }); - test('updating parent override when there is a child override is no-op', - () async { - final provider = Provider((ref) => 0); - final root = createContainer( - overrides: [provider.overrideWithValue(21)], - ); - final container = createContainer( - parent: root, - overrides: [provider.overrideWithValue(42)], - ); - final listener = Listener(); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(listener, listener(null, 42)); - - root.updateOverrides([ - provider.overrideWithValue(22), - ]); - - await container.pump(); - - verifyNoMoreInteractions(listener); - }); - test('supports auto-dispose', () async { final provider = Provider.autoDispose((ref) => 0); final container = createContainer(); @@ -125,64 +99,6 @@ void main() { expect(element.mounted, false); }); - test('can update multiple ScopeProviders at once', () { - final provider = Provider((ref) => -1); - final provider2 = Provider((ref) => -1); - - final container = createContainer( - overrides: [ - provider.overrideWithValue(21), - provider2.overrideWithValue(42), - ], - ); - - final listener = Listener(); - final listener2 = Listener(); - - container.listen(provider, listener.call, fireImmediately: true); - container.listen(provider2, listener2.call, fireImmediately: true); - - verifyOnly(listener, listener(null, 21)); - verifyOnly(listener2, listener2(null, 42)); - - container.updateOverrides([ - provider.overrideWithValue(22), - provider2.overrideWithValue(43), - ]); - - verifyInOrder([ - listener(21, 22), - listener2(42, 43), - ]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('handles parent override update', () { - final provider = Provider((ref) => 0); - final root = createContainer( - overrides: [provider.overrideWithValue(1)], - ); - final mid = createContainer( - parent: root, - overrides: [ - provider.overrideWithValue(42), - ], - ); - final container = createContainer(parent: mid); - final listener = Listener(); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(listener, listener(null, 42)); - - mid.updateOverrides([ - provider.overrideWithValue(21), - ]); - - verifyOnly(listener, listener(42, 21)); - }); - test('can be overridden on non-root container', () { final provider = Provider((ref) => 0); final root = createContainer(); From 77abf06fe24e9f873ff4cdd7266b49e1f49a6bee Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 17:22:30 +0100 Subject: [PATCH 067/387] Move --- .../riverpod/test/{old/framework => new}/async_value_test.dart | 0 .../test/new/{ => framework}/provider_container_test.dart | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename packages/riverpod/test/{old/framework => new}/async_value_test.dart (100%) rename packages/riverpod/test/new/{ => framework}/provider_container_test.dart (99%) diff --git a/packages/riverpod/test/old/framework/async_value_test.dart b/packages/riverpod/test/new/async_value_test.dart similarity index 100% rename from packages/riverpod/test/old/framework/async_value_test.dart rename to packages/riverpod/test/new/async_value_test.dart diff --git a/packages/riverpod/test/new/provider_container_test.dart b/packages/riverpod/test/new/framework/provider_container_test.dart similarity index 99% rename from packages/riverpod/test/new/provider_container_test.dart rename to packages/riverpod/test/new/framework/provider_container_test.dart index cb51234a1..48379da36 100644 --- a/packages/riverpod/test/new/provider_container_test.dart +++ b/packages/riverpod/test/new/framework/provider_container_test.dart @@ -3,7 +3,7 @@ import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; -import 'utils.dart'; +import '../utils.dart'; void main() { tearDown(() { From ee602bc4380f26253ce9f587e240306041d7bf67 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Dec 2023 18:03:27 +0100 Subject: [PATCH 068/387] Have createElement receive the container, And have ProviderElement's constructor receive it --- examples/pub/lib/detail.g.dart | 16 +++-- examples/pub/lib/search.g.dart | 8 ++- .../auto_dispose.dart | 10 ++- .../src/change_notifier_provider/base.dart | 7 +- .../flutter_riverpod/lib/src/consumer.dart | 4 +- .../lib/src/async_notifier/auto_dispose.dart | 8 ++- .../async_notifier/auto_dispose_family.dart | 6 +- .../riverpod/lib/src/async_notifier/base.dart | 9 ++- .../lib/src/async_notifier/family.dart | 6 +- .../lib/src/framework/auto_dispose.dart | 2 +- .../riverpod/lib/src/framework/element.dart | 36 +++++----- .../lib/src/framework/provider_base.dart | 2 +- .../lib/src/framework/provider_container.dart | 7 +- .../riverpod/lib/src/framework/scheduler.dart | 4 +- .../lib/src/framework/value_provider.dart | 6 +- .../lib/src/future_provider/auto_dispose.dart | 7 +- .../lib/src/future_provider/base.dart | 11 ++- .../lib/src/notifier/auto_dispose.dart | 8 ++- .../lib/src/notifier/auto_dispose_family.dart | 6 +- packages/riverpod/lib/src/notifier/base.dart | 11 ++- .../riverpod/lib/src/notifier/family.dart | 6 +- .../lib/src/provider/auto_dispose.dart | 11 ++- packages/riverpod/lib/src/provider/base.dart | 8 ++- .../state_notifier_provider/auto_dispose.dart | 7 +- .../lib/src/state_notifier_provider/base.dart | 7 +- .../lib/src/state_provider/auto_dispose.dart | 12 ++-- .../riverpod/lib/src/state_provider/base.dart | 11 ++- .../lib/src/stream_notifier/auto_dispose.dart | 8 ++- .../stream_notifier/auto_dispose_family.dart | 6 +- .../lib/src/stream_notifier/base.dart | 7 +- .../lib/src/stream_notifier/family.dart | 6 +- .../lib/src/stream_provider/auto_dispose.dart | 7 +- .../lib/src/stream_provider/base.dart | 13 +++- .../framework/provider_container_test.dart | 10 +++ .../lib/riverpod_annotation.dart | 2 + .../integration/build_yaml/lib/main.g.dart | 48 ++++++++----- .../lib/src/templates/family.dart | 8 ++- .../test/integration/annotated.g.dart | 16 +++-- .../test/integration/async.g.dart | 49 ++++++++----- .../test/integration/dependencies.g.dart | 24 ++++--- .../test/integration/dependencies2.g.dart | 17 +++-- .../test/integration/generated.g.dart | 57 +++++++++------ .../test/integration/stream.g.dart | 33 +++++---- .../test/integration/sync.g.dart | 72 ++++++++++++------- .../generated/golden/lib/sync.g.dart | 16 +++-- ..._class_based_provider_to_functional.g.dart | 16 +++-- ..._functional_provider_to_class_based.g.dart | 8 ++- .../avoid_build_context_in_providers.g.dart | 16 +++-- .../avoid_public_notifier_properties.g.dart | 8 ++- .../test/lints/dependencies.g.dart | 16 +++-- .../functional_ref/functional_ref.g.dart | 32 +++++---- .../notifier_extends/notifier_extends.g.dart | 33 +++++---- .../protected_notifier_properties.g.dart | 48 ++++++++----- .../test/lints/provider_parameters.g.dart | 8 ++- .../docs/concepts/about_codegen/main.g.dart | 8 ++- .../about_codegen/provider_type/family.g.dart | 8 ++- .../provider_type/family_class.g.dart | 8 ++- .../provider_type/family_fn.g.dart | 8 ++- .../invalidate_family_example/codegen.g.dart | 8 ++- .../passing_args/codegen/family.g.dart | 8 ++- .../passing_args/codegen/provider.g.dart | 8 ++- .../docs/from_provider/family/family.g.dart | 8 ++- .../introduction/why_riverpod/codegen.g.dart | 8 ++- .../family_and_dispose.g.dart | 8 ++- .../current/about_codegen/main.g.dart | 8 ++- .../current/about_codegen/main.g.dart | 8 ++- .../current/about_codegen/main.g.dart | 8 ++- .../current/about_codegen/main.g.dart | 8 ++- 68 files changed, 594 insertions(+), 338 deletions(-) diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 7397fc2ea..f64de6736 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -157,8 +157,10 @@ class FetchPackageDetailsProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement() { - return _FetchPackageDetailsProviderElement(this); + AutoDisposeFutureProviderElement createElement( + ProviderContainer container, + ) { + return _FetchPackageDetailsProviderElement(this, container); } FetchPackageDetailsProvider _copyWith( @@ -198,7 +200,7 @@ mixin FetchPackageDetailsRef on AutoDisposeFutureProviderRef { class _FetchPackageDetailsProviderElement extends AutoDisposeFutureProviderElement with FetchPackageDetailsRef { - _FetchPackageDetailsProviderElement(super.provider); + _FetchPackageDetailsProviderElement(super.provider, super.container); @override String get packageName => (origin as FetchPackageDetailsProvider).packageName; @@ -411,8 +413,10 @@ class PackageMetricsProvider extends AutoDisposeAsyncNotifierProviderImpl< @override AutoDisposeAsyncNotifierProviderElement - createElement() { - return _PackageMetricsProviderElement(this); + createElement( + ProviderContainer container, + ) { + return _PackageMetricsProviderElement(this, container); } PackageMetricsProvider _copyWith( @@ -452,7 +456,7 @@ mixin PackageMetricsRef class _PackageMetricsProviderElement extends AutoDisposeAsyncNotifierProviderElement with PackageMetricsRef { - _PackageMetricsProviderElement(super.provider); + _PackageMetricsProviderElement(super.provider, super.container); @override String get packageName => (origin as PackageMetricsProvider).packageName; diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index d43cf5161..8a5637280 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -169,8 +169,10 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { } @override - AutoDisposeFutureProviderElement> createElement() { - return _FetchPackagesProviderElement(this); + AutoDisposeFutureProviderElement> createElement( + ProviderContainer container, + ) { + return _FetchPackagesProviderElement(this, container); } FetchPackagesProvider _copyWith( @@ -216,7 +218,7 @@ mixin FetchPackagesRef on AutoDisposeFutureProviderRef> { class _FetchPackagesProviderElement extends AutoDisposeFutureProviderElement> with FetchPackagesRef { - _FetchPackagesProviderElement(super.provider); + _FetchPackagesProviderElement(super.provider, super.container); @override int get page => (origin as FetchPackagesProvider).page; diff --git a/packages/flutter_riverpod/lib/src/change_notifier_provider/auto_dispose.dart b/packages/flutter_riverpod/lib/src/change_notifier_provider/auto_dispose.dart index b56824284..3fdb3640f 100644 --- a/packages/flutter_riverpod/lib/src/change_notifier_provider/auto_dispose.dart +++ b/packages/flutter_riverpod/lib/src/change_notifier_provider/auto_dispose.dart @@ -49,8 +49,13 @@ class AutoDisposeChangeNotifierProvider } @override - AutoDisposeChangeNotifierProviderElement createElement() { - return AutoDisposeChangeNotifierProviderElement._(this); + AutoDisposeChangeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return AutoDisposeChangeNotifierProviderElement._( + this, + container, + ); } @override @@ -84,6 +89,7 @@ class AutoDisposeChangeNotifierProviderElement< /// The [ProviderElementBase] for [ChangeNotifier] AutoDisposeChangeNotifierProviderElement._( AutoDisposeChangeNotifierProvider super._provider, + super.container, ) : super._(); } diff --git a/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart b/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart index 9d36e2fab..617b69cea 100644 --- a/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart +++ b/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart @@ -114,8 +114,10 @@ class ChangeNotifierProvider } @override - ChangeNotifierProviderElement createElement() { - return ChangeNotifierProviderElement._(this); + ChangeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return ChangeNotifierProviderElement._(this, container); } @override @@ -180,6 +182,7 @@ class ChangeNotifierProviderElement implements ChangeNotifierProviderRef { ChangeNotifierProviderElement._( _ChangeNotifierProviderBase super._provider, + super.container, ); @override diff --git a/packages/flutter_riverpod/lib/src/consumer.dart b/packages/flutter_riverpod/lib/src/consumer.dart index 9b2a9075a..776e22eaa 100644 --- a/packages/flutter_riverpod/lib/src/consumer.dart +++ b/packages/flutter_riverpod/lib/src/consumer.dart @@ -86,7 +86,7 @@ abstract class WidgetRef { /// As opposed to [listen], [listenManual] is not safe to use within the `build` /// method of a widget. /// Instead, [listenManual] is designed to be used inside [State.initState] or - /// other [State] lifecycles. + /// other [State] lifecycle. /// /// [listenManual] returns a [ProviderSubscription] which can be used to stop /// listening to the provider, or to read the current value exposed by @@ -237,7 +237,7 @@ abstract class WidgetRef { /// If used on a provider which is not initialized, this method will have no effect. void invalidate(ProviderOrFamily provider); - void reload(ProviderOrFamily provider); + // TODO reload } /// A function that can also listen to providers diff --git a/packages/riverpod/lib/src/async_notifier/auto_dispose.dart b/packages/riverpod/lib/src/async_notifier/auto_dispose.dart index b916a3c99..9e9b249c9 100644 --- a/packages/riverpod/lib/src/async_notifier/auto_dispose.dart +++ b/packages/riverpod/lib/src/async_notifier/auto_dispose.dart @@ -95,8 +95,10 @@ class AutoDisposeAsyncNotifierProviderImpl< late final Refreshable> future = _asyncFuture(this); @override - AutoDisposeAsyncNotifierProviderElement createElement() { - return AutoDisposeAsyncNotifierProviderElement(this); + AutoDisposeAsyncNotifierProviderElement createElement( + ProviderContainer container, + ) { + return AutoDisposeAsyncNotifierProviderElement(this, container); } @override @@ -131,5 +133,5 @@ class AutoDisposeAsyncNotifierProviderElement< implements AutoDisposeAsyncNotifierProviderRef { /// The [ProviderElementBase] for [AsyncNotifierProvider] @internal - AutoDisposeAsyncNotifierProviderElement(super._provider) : super(); + AutoDisposeAsyncNotifierProviderElement(super._provider, super.container); } diff --git a/packages/riverpod/lib/src/async_notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/async_notifier/auto_dispose_family.dart index f71db5519..1386fff06 100644 --- a/packages/riverpod/lib/src/async_notifier/auto_dispose_family.dart +++ b/packages/riverpod/lib/src/async_notifier/auto_dispose_family.dart @@ -71,8 +71,10 @@ class AutoDisposeFamilyAsyncNotifierProviderImpl< late final Refreshable> future = _asyncFuture(this); @override - AutoDisposeAsyncNotifierProviderElement createElement() { - return AutoDisposeAsyncNotifierProviderElement(this); + AutoDisposeAsyncNotifierProviderElement createElement( + ProviderContainer container, + ) { + return AutoDisposeAsyncNotifierProviderElement(this, container); } @override diff --git a/packages/riverpod/lib/src/async_notifier/base.dart b/packages/riverpod/lib/src/async_notifier/base.dart index 7003bd0f2..fa8274c00 100644 --- a/packages/riverpod/lib/src/async_notifier/base.dart +++ b/packages/riverpod/lib/src/async_notifier/base.dart @@ -136,8 +136,10 @@ class AsyncNotifierProviderImpl, T> late final AlwaysAliveRefreshable> future = _asyncFuture(this); @override - AsyncNotifierProviderElement createElement() { - return AsyncNotifierProviderElement(this); + AsyncNotifierProviderElement createElement( + ProviderContainer container, + ) { + return AsyncNotifierProviderElement(this, container); } @override @@ -488,7 +490,7 @@ abstract class AsyncNotifierProviderElementBase< with FutureHandlerProviderElementMixin { /// The element of [AsyncNotifierProvider]. @internal - AsyncNotifierProviderElementBase(super._provider); + AsyncNotifierProviderElementBase(super._provider, super.container); final _notifierNotifier = ProxyElementValueNotifier(); @@ -527,6 +529,7 @@ class AsyncNotifierProviderElement, T> @internal AsyncNotifierProviderElement( AsyncNotifierProviderBase super._provider, + super.container, ); @override diff --git a/packages/riverpod/lib/src/async_notifier/family.dart b/packages/riverpod/lib/src/async_notifier/family.dart index 2d34b121e..3593db233 100644 --- a/packages/riverpod/lib/src/async_notifier/family.dart +++ b/packages/riverpod/lib/src/async_notifier/family.dart @@ -82,8 +82,10 @@ class FamilyAsyncNotifierProviderImpl, T, late final AlwaysAliveRefreshable> future = _asyncFuture(this); @override - AsyncNotifierProviderElement createElement() { - return AsyncNotifierProviderElement(this); + AsyncNotifierProviderElement createElement( + ProviderContainer container, + ) { + return AsyncNotifierProviderElement(this, container); } @override diff --git a/packages/riverpod/lib/src/framework/auto_dispose.dart b/packages/riverpod/lib/src/framework/auto_dispose.dart index 8175b172c..33bf85a5b 100644 --- a/packages/riverpod/lib/src/framework/auto_dispose.dart +++ b/packages/riverpod/lib/src/framework/auto_dispose.dart @@ -26,7 +26,7 @@ mixin AutoDisposeProviderElementMixin on ProviderElementBase final links = _keepAliveLinks; if (!hasListeners && (links == null || links.isEmpty)) { - _container.scheduler.scheduleProviderDispose(this); + container.scheduler.scheduleProviderDispose(this); } } diff --git a/packages/riverpod/lib/src/framework/element.dart b/packages/riverpod/lib/src/framework/element.dart index 2d64128fb..c172e6c2e 100644 --- a/packages/riverpod/lib/src/framework/element.dart +++ b/packages/riverpod/lib/src/framework/element.dart @@ -43,9 +43,11 @@ void Function()? debugCanModifyProviders; /// of providers. /// Do not use. /// {@endtemplate} +// TODO rename to ProviderElement abstract class ProviderElementBase implements Ref, Node { /// {@macro riverpod.provider_element_base} - ProviderElementBase(this._provider); + // TODO changelog: ProviderElement no-longer takes a provider as parameter but takes a ProviderContainer + ProviderElementBase(this._provider, this.container); static ProviderElementBase? _debugCurrentlyBuildingElement; @@ -60,14 +62,14 @@ abstract class ProviderElementBase implements Ref, Node { ProviderBase get origin => _origin; late ProviderBase _origin; + // TODO changelog ProviderElement.provider is now abstract /// The provider associated with this [ProviderElementBase], after applying overrides. ProviderBase get provider => _provider; ProviderBase _provider; /// The [ProviderContainer] that owns this [ProviderElementBase]. @override - ProviderContainer get container => _container; - late final ProviderContainer _container; + final ProviderContainer container; /// Whether this [ProviderElementBase] is currently listened to or not. /// @@ -288,7 +290,7 @@ abstract class ProviderElementBase implements Ref, Node { @override void invalidate(ProviderOrFamily provider) { assert(_debugAssertCanDependOn(provider), ''); - _container.invalidate(provider); + container.invalidate(provider); } @override @@ -297,7 +299,7 @@ abstract class ProviderElementBase implements Ref, Node { _mustRecomputeState = true; runOnDispose(); - _container.scheduler.scheduleProviderRefresh(this); + container.scheduler.scheduleProviderRefresh(this); // We don't call this._markDependencyMayHaveChanged here because we voluntarily // do not want to set the _dependencyMayHaveChanged flag to true. @@ -571,17 +573,17 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu _providerDependents[i]._markDependencyChanged(); } - for (final observer in _container.observers) { + for (final observer in container.observers) { runQuaternaryGuarded( observer.didUpdateProvider, origin, previousState, newState.stateOrNull, - _container, + container, ); } - for (final observer in _container.observers) { + for (final observer in container.observers) { newState.map( data: (_) {}, error: (newState) { @@ -590,7 +592,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu origin, newState.error, newState.stackTrace, - _container, + container, ); }, ); @@ -623,7 +625,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu try { // Initializing the provider, to make sure its dependencies are setup. - _container.readProviderElement(listenable); + container.readProviderElement(listenable); } catch (err) { // We don't care whether the provider is in error or not. We're just // checking whether we're not in a circular dependency. @@ -680,7 +682,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu T refresh(Refreshable provider) { _assertNotOutdated(); assert(_debugAssertCanDependOn(provider), ''); - return _container.refresh(provider); + return container.refresh(provider); } @override @@ -688,11 +690,11 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu _assertNotOutdated(); assert(!_debugIsRunningSelector, 'Cannot call ref.read inside a selector'); assert(_debugAssertCanDependOn(provider), ''); - return _container.read(provider); + return container.read(provider); } @override - bool exists(ProviderBase provider) => _container.exists(provider); + bool exists(ProviderBase provider) => container.exists(provider); @override T watch(ProviderListenable listenable) { @@ -712,7 +714,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu assert(_debugAssertCanDependOn(listenable), ''); - final element = _container.readProviderElement(listenable); + final element = container.readProviderElement(listenable); _dependencies.putIfAbsent(element, () { final previousSub = _previousDependencies?.remove(element); if (previousSub != null) { @@ -743,7 +745,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu @override ProviderElementBase readProviderElement(ProviderBase provider) { - return _container.readProviderElement(provider); + return container.readProviderElement(provider); } @override @@ -933,11 +935,11 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu _onDisposeListeners?.forEach(runGuarded); - for (final observer in _container.observers) { + for (final observer in container.observers) { runBinaryGuarded( observer.didDisposeProvider, _origin, - _container, + container, ); } diff --git a/packages/riverpod/lib/src/framework/provider_base.dart b/packages/riverpod/lib/src/framework/provider_base.dart index 507dcd9a1..49b692055 100644 --- a/packages/riverpod/lib/src/framework/provider_base.dart +++ b/packages/riverpod/lib/src/framework/provider_base.dart @@ -110,7 +110,7 @@ abstract class ProviderBase extends ProviderOrFamily /// An internal method that defines how a provider behaves. @visibleForOverriding - ProviderElementBase createElement(); + ProviderElementBase createElement(ProviderContainer container); @override // ignore: avoid_equals_and_hash_code_on_mutable_classes diff --git a/packages/riverpod/lib/src/framework/provider_container.dart b/packages/riverpod/lib/src/framework/provider_container.dart index 1b944bafc..ed4da75a5 100644 --- a/packages/riverpod/lib/src/framework/provider_container.dart +++ b/packages/riverpod/lib/src/framework/provider_container.dart @@ -40,10 +40,9 @@ class _StateReader { } _circularDependencyLock ??= origin; try { - final element = override.createElement() + final element = override.createElement(container) .._provider = override .._origin = origin - .._container = container ..mount(); element.getState()!.map( @@ -734,7 +733,7 @@ final b = Provider((ref) => ref.watch(a), dependencies: [a]); element.visitAncestors((element) { // We ignore dependencies that are defined in another container, as // they are in a separate graph - if (element._container == this) { + if (element.container == this) { hasAncestorsInContainer = true; } }); @@ -764,7 +763,7 @@ final b = Provider((ref) => ref.watch(a), dependencies: [a]); // All the parents of a node must have been visited before a node is visited var areAllAncestorsAlreadyVisited = true; dependent.visitAncestors((e) { - if (e._container == this && !visitedNodes.contains(e)) { + if (e.container == this && !visitedNodes.contains(e)) { areAllAncestorsAlreadyVisited = false; } }); diff --git a/packages/riverpod/lib/src/framework/scheduler.dart b/packages/riverpod/lib/src/framework/scheduler.dart index 88976ffaf..c788706e5 100644 --- a/packages/riverpod/lib/src/framework/scheduler.dart +++ b/packages/riverpod/lib/src/framework/scheduler.dart @@ -120,10 +120,10 @@ class ProviderScheduler { if ((links != null && links.isNotEmpty) || element.hasListeners || - element._container._disposed) { + element.container._disposed) { continue; } - element._container._disposeProvider(element._origin); + element.container._disposeProvider(element._origin); } } diff --git a/packages/riverpod/lib/src/framework/value_provider.dart b/packages/riverpod/lib/src/framework/value_provider.dart index de21f5a7f..048f56019 100644 --- a/packages/riverpod/lib/src/framework/value_provider.dart +++ b/packages/riverpod/lib/src/framework/value_provider.dart @@ -27,8 +27,8 @@ class ValueProvider extends ProviderBase Set? get allTransitiveDependencies => null; @override - ValueProviderElement createElement() { - return ValueProviderElement(this); + ValueProviderElement createElement(ProviderContainer container) { + return ValueProviderElement(this, container); } } @@ -37,7 +37,7 @@ class ValueProvider extends ProviderBase @internal class ValueProviderElement extends ProviderElementBase { /// The [ProviderElementBase] of a [ValueProvider] - ValueProviderElement(ValueProvider super._provider); + ValueProviderElement(ValueProvider super._provider, super.container); /// A custom listener called when `overrideWithValue` changes /// with a different value. diff --git a/packages/riverpod/lib/src/future_provider/auto_dispose.dart b/packages/riverpod/lib/src/future_provider/auto_dispose.dart index 1f7faedab..104b09cdd 100644 --- a/packages/riverpod/lib/src/future_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/future_provider/auto_dispose.dart @@ -44,8 +44,10 @@ class AutoDisposeFutureProvider extends _FutureProviderBase _createFn(ref); @override - AutoDisposeFutureProviderElement createElement() { - return AutoDisposeFutureProviderElement(this); + AutoDisposeFutureProviderElement createElement( + ProviderContainer container, + ) { + return AutoDisposeFutureProviderElement(this, container); } @override @@ -78,6 +80,7 @@ class AutoDisposeFutureProviderElement extends FutureProviderElement @internal AutoDisposeFutureProviderElement( AutoDisposeFutureProvider super._provider, + super.container, ) : super(); } diff --git a/packages/riverpod/lib/src/future_provider/base.dart b/packages/riverpod/lib/src/future_provider/base.dart index 19e929f0a..8b941a6aa 100644 --- a/packages/riverpod/lib/src/future_provider/base.dart +++ b/packages/riverpod/lib/src/future_provider/base.dart @@ -65,7 +65,9 @@ class FutureProvider extends _FutureProviderBase FutureOr _create(FutureProviderElement ref) => _createFn(ref); @override - FutureProviderElement createElement() => FutureProviderElement(this); + FutureProviderElement createElement(ProviderContainer container) { + return FutureProviderElement(this, container); + } /// {@macro riverpod.override_with} Override overrideWith(Create, FutureProviderRef> create) { @@ -90,8 +92,11 @@ class FutureProviderElement extends ProviderElementBase> implements FutureProviderRef { /// The element of a [FutureProvider] @internal - // ignore: library_private_types_in_public_api - FutureProviderElement(_FutureProviderBase super._provider); + FutureProviderElement( + // ignore: library_private_types_in_public_api + _FutureProviderBase super._provider, + super.container, + ); @override Future get future { diff --git a/packages/riverpod/lib/src/notifier/auto_dispose.dart b/packages/riverpod/lib/src/notifier/auto_dispose.dart index 8cd60d53c..16e912308 100644 --- a/packages/riverpod/lib/src/notifier/auto_dispose.dart +++ b/packages/riverpod/lib/src/notifier/auto_dispose.dart @@ -88,8 +88,10 @@ class AutoDisposeNotifierProviderImpl, T> late final Refreshable notifier = _notifier(this); @override - AutoDisposeNotifierProviderElement createElement() { - return AutoDisposeNotifierProviderElement(this); + AutoDisposeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return AutoDisposeNotifierProviderElement(this, container); } @override @@ -123,5 +125,5 @@ class AutoDisposeNotifierProviderElement, T> implements AutoDisposeNotifierProviderRef { /// The [ProviderElementBase] for [NotifierProvider] @internal - AutoDisposeNotifierProviderElement(super._provider); + AutoDisposeNotifierProviderElement(super._provider, super.container); } diff --git a/packages/riverpod/lib/src/notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/notifier/auto_dispose_family.dart index dd87d379f..28c1bed16 100644 --- a/packages/riverpod/lib/src/notifier/auto_dispose_family.dart +++ b/packages/riverpod/lib/src/notifier/auto_dispose_family.dart @@ -67,8 +67,10 @@ class AutoDisposeFamilyNotifierProviderImpl, late final Refreshable notifier = _notifier(this); @override - AutoDisposeNotifierProviderElement createElement() { - return AutoDisposeNotifierProviderElement(this); + AutoDisposeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return AutoDisposeNotifierProviderElement(this, container); } @override diff --git a/packages/riverpod/lib/src/notifier/base.dart b/packages/riverpod/lib/src/notifier/base.dart index 733d95bf8..9ef3fee1a 100644 --- a/packages/riverpod/lib/src/notifier/base.dart +++ b/packages/riverpod/lib/src/notifier/base.dart @@ -154,8 +154,10 @@ class NotifierProviderImpl, T> static const family = NotifierProviderFamilyBuilder(); @override - NotifierProviderElement createElement() { - return NotifierProviderElement(this); + NotifierProviderElement createElement( + ProviderContainer container, + ) { + return NotifierProviderElement(this, container); } @override @@ -191,7 +193,10 @@ class NotifierProviderElement, T> extends ProviderElementBase implements NotifierProviderRef { /// The element of [NotifierProvider]. @internal - NotifierProviderElement(NotifierProviderBase super._provider); + NotifierProviderElement( + NotifierProviderBase super._provider, + super.container, + ); final _notifierNotifier = ProxyElementValueNotifier(); diff --git a/packages/riverpod/lib/src/notifier/family.dart b/packages/riverpod/lib/src/notifier/family.dart index 7e508f603..71c497fb2 100644 --- a/packages/riverpod/lib/src/notifier/family.dart +++ b/packages/riverpod/lib/src/notifier/family.dart @@ -70,8 +70,10 @@ class FamilyNotifierProviderImpl, T, Arg> _notifier(this); @override - NotifierProviderElement createElement() { - return NotifierProviderElement(this); + NotifierProviderElement createElement( + ProviderContainer container, + ) { + return NotifierProviderElement(this, container); } @override diff --git a/packages/riverpod/lib/src/provider/auto_dispose.dart b/packages/riverpod/lib/src/provider/auto_dispose.dart index 819c5b2cd..90af8fd18 100644 --- a/packages/riverpod/lib/src/provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/provider/auto_dispose.dart @@ -40,8 +40,10 @@ class AutoDisposeProvider extends InternalProvider { T _create(AutoDisposeProviderElement ref) => _createFn(ref); @override - AutoDisposeProviderElement createElement() { - return AutoDisposeProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return AutoDisposeProviderElement(this, container); } /// {@macro riverpod.override_with} @@ -69,7 +71,10 @@ class AutoDisposeProviderElement extends ProviderElement implements AutoDisposeProviderRef { /// The [ProviderElementBase] for [Provider] @internal - AutoDisposeProviderElement(AutoDisposeProvider super._provider); + AutoDisposeProviderElement( + AutoDisposeProvider super._provider, + super.container, + ); } /// The [Family] of [AutoDisposeProvider] diff --git a/packages/riverpod/lib/src/provider/base.dart b/packages/riverpod/lib/src/provider/base.dart index 8c91b7a8a..8b00ee20d 100644 --- a/packages/riverpod/lib/src/provider/base.dart +++ b/packages/riverpod/lib/src/provider/base.dart @@ -55,7 +55,11 @@ class Provider extends InternalProvider State _create(ProviderElement ref) => _createFn(ref); @override - ProviderElement createElement() => ProviderElement(this); + ProviderElement createElement( + ProviderContainer container, + ) { + return ProviderElement(this, container); + } /// {@template riverpod.override_with} /// Override the provider with a new initialization function. @@ -323,7 +327,7 @@ class ProviderElement extends ProviderElementBase implements ProviderRef { /// A [ProviderElementBase] for [Provider] @internal - ProviderElement(super._provider); + ProviderElement(super._provider, super.container); @override State get state => requireState; diff --git a/packages/riverpod/lib/src/state_notifier_provider/auto_dispose.dart b/packages/riverpod/lib/src/state_notifier_provider/auto_dispose.dart index 0d08dd0c8..f78471069 100644 --- a/packages/riverpod/lib/src/state_notifier_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/state_notifier_provider/auto_dispose.dart @@ -47,8 +47,10 @@ class AutoDisposeStateNotifierProvider, T> } @override - AutoDisposeStateNotifierProviderElement createElement() { - return AutoDisposeStateNotifierProviderElement._(this); + AutoDisposeStateNotifierProviderElement createElement( + ProviderContainer container, + ) { + return AutoDisposeStateNotifierProviderElement._(this, container); } @override @@ -82,6 +84,7 @@ class AutoDisposeStateNotifierProviderElement< /// The [ProviderElementBase] for [StateNotifierProvider] AutoDisposeStateNotifierProviderElement._( AutoDisposeStateNotifierProvider super._provider, + super.container, ) : super._(); } diff --git a/packages/riverpod/lib/src/state_notifier_provider/base.dart b/packages/riverpod/lib/src/state_notifier_provider/base.dart index b642c48f6..89ad19614 100644 --- a/packages/riverpod/lib/src/state_notifier_provider/base.dart +++ b/packages/riverpod/lib/src/state_notifier_provider/base.dart @@ -116,8 +116,10 @@ class StateNotifierProvider, T> } @override - StateNotifierProviderElement createElement() { - return StateNotifierProviderElement._(this); + StateNotifierProviderElement createElement( + ProviderContainer container, + ) { + return StateNotifierProviderElement._(this, container); } @override @@ -148,6 +150,7 @@ class StateNotifierProviderElement, T> implements StateNotifierProviderRef { StateNotifierProviderElement._( _StateNotifierProviderBase super._provider, + super.container, ); @override diff --git a/packages/riverpod/lib/src/state_provider/auto_dispose.dart b/packages/riverpod/lib/src/state_provider/auto_dispose.dart index 6f2b38db9..75173b354 100644 --- a/packages/riverpod/lib/src/state_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/state_provider/auto_dispose.dart @@ -41,8 +41,10 @@ class AutoDisposeStateProvider extends _StateProviderBase { T _create(AutoDisposeStateProviderElement ref) => _createFn(ref); @override - AutoDisposeStateProviderElement createElement() { - return AutoDisposeStateProviderElement._(this); + AutoDisposeStateProviderElement createElement( + ProviderContainer container, + ) { + return AutoDisposeStateProviderElement._(this, container); } @override @@ -72,8 +74,10 @@ class AutoDisposeStateProviderElement extends StateProviderElement with AutoDisposeProviderElementMixin implements AutoDisposeStateProviderRef { /// The [ProviderElementBase] for [StateProvider] - AutoDisposeStateProviderElement._(AutoDisposeStateProvider super._provider) - : super._(); + AutoDisposeStateProviderElement._( + AutoDisposeStateProvider super._provider, + super.container, + ) : super._(); } /// The [Family] of [StateProvider]. diff --git a/packages/riverpod/lib/src/state_provider/base.dart b/packages/riverpod/lib/src/state_provider/base.dart index 9ede763ca..4056c11c8 100644 --- a/packages/riverpod/lib/src/state_provider/base.dart +++ b/packages/riverpod/lib/src/state_provider/base.dart @@ -81,7 +81,11 @@ class StateProvider extends _StateProviderBase T _create(StateProviderElement ref) => _createFn(ref); @override - StateProviderElement createElement() => StateProviderElement._(this); + StateProviderElement createElement( + ProviderContainer container, + ) { + return StateProviderElement._(this, container); + } @override late final AlwaysAliveRefreshable> notifier = @@ -109,7 +113,10 @@ class StateProvider extends _StateProviderBase /// The element of [StateProvider]. class StateProviderElement extends ProviderElementBase implements StateProviderRef { - StateProviderElement._(_StateProviderBase super._provider); + StateProviderElement._( + _StateProviderBase super._provider, + super.container, + ); @override StateController get controller => _controllerNotifier.value; diff --git a/packages/riverpod/lib/src/stream_notifier/auto_dispose.dart b/packages/riverpod/lib/src/stream_notifier/auto_dispose.dart index f5989a835..aec078969 100644 --- a/packages/riverpod/lib/src/stream_notifier/auto_dispose.dart +++ b/packages/riverpod/lib/src/stream_notifier/auto_dispose.dart @@ -90,8 +90,10 @@ class AutoDisposeStreamNotifierProviderImpl< late final Refreshable> future = _streamFuture(this); @override - AutoDisposeStreamNotifierProviderElement createElement() { - return AutoDisposeStreamNotifierProviderElement(this); + AutoDisposeStreamNotifierProviderElement createElement( + ProviderContainer container, + ) { + return AutoDisposeStreamNotifierProviderElement(this, container); } @override @@ -127,5 +129,5 @@ class AutoDisposeStreamNotifierProviderElement< implements AutoDisposeStreamNotifierProviderRef { /// The [ProviderElementBase] for [StreamNotifierProvider] @internal - AutoDisposeStreamNotifierProviderElement(super._provider); + AutoDisposeStreamNotifierProviderElement(super._provider, super.container); } diff --git a/packages/riverpod/lib/src/stream_notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/stream_notifier/auto_dispose_family.dart index 55ca950d4..60c1bb2bf 100644 --- a/packages/riverpod/lib/src/stream_notifier/auto_dispose_family.dart +++ b/packages/riverpod/lib/src/stream_notifier/auto_dispose_family.dart @@ -66,8 +66,10 @@ class AutoDisposeFamilyStreamNotifierProviderImpl< late final Refreshable> future = _streamFuture(this); @override - AutoDisposeStreamNotifierProviderElement createElement() { - return AutoDisposeStreamNotifierProviderElement(this); + AutoDisposeStreamNotifierProviderElement createElement( + ProviderContainer container, + ) { + return AutoDisposeStreamNotifierProviderElement(this, container); } @override diff --git a/packages/riverpod/lib/src/stream_notifier/base.dart b/packages/riverpod/lib/src/stream_notifier/base.dart index 3f2c7a188..e122b0799 100644 --- a/packages/riverpod/lib/src/stream_notifier/base.dart +++ b/packages/riverpod/lib/src/stream_notifier/base.dart @@ -107,8 +107,10 @@ class StreamNotifierProviderImpl, T> late final AlwaysAliveRefreshable> future = _streamFuture(this); @override - StreamNotifierProviderElement createElement() { - return StreamNotifierProviderElement(this); + StreamNotifierProviderElement createElement( + ProviderContainer container, + ) { + return StreamNotifierProviderElement(this, container); } @override @@ -144,6 +146,7 @@ class StreamNotifierProviderElement, T> @internal StreamNotifierProviderElement( StreamNotifierProviderBase super._provider, + super.container, ); @override diff --git a/packages/riverpod/lib/src/stream_notifier/family.dart b/packages/riverpod/lib/src/stream_notifier/family.dart index 5846f579c..a09201380 100644 --- a/packages/riverpod/lib/src/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/stream_notifier/family.dart @@ -78,8 +78,10 @@ class FamilyStreamNotifierProviderImpl, late final AlwaysAliveRefreshable> future = _streamFuture(this); @override - StreamNotifierProviderElement createElement() { - return StreamNotifierProviderElement(this); + StreamNotifierProviderElement createElement( + ProviderContainer container, + ) { + return StreamNotifierProviderElement(this, container); } @override diff --git a/packages/riverpod/lib/src/stream_provider/auto_dispose.dart b/packages/riverpod/lib/src/stream_provider/auto_dispose.dart index 3e0236de1..30471d404 100644 --- a/packages/riverpod/lib/src/stream_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/stream_provider/auto_dispose.dart @@ -42,8 +42,10 @@ class AutoDisposeStreamProvider extends _StreamProviderBase Stream _create(AutoDisposeStreamProviderElement ref) => _createFn(ref); @override - AutoDisposeStreamProviderElement createElement() { - return AutoDisposeStreamProviderElement(this); + AutoDisposeStreamProviderElement createElement( + ProviderContainer container, + ) { + return AutoDisposeStreamProviderElement(this, container); } @override @@ -75,6 +77,7 @@ class AutoDisposeStreamProviderElement extends StreamProviderElement /// The [ProviderElementBase] for [StreamProvider] AutoDisposeStreamProviderElement( AutoDisposeStreamProvider super._provider, + super.container, ); } diff --git a/packages/riverpod/lib/src/stream_provider/base.dart b/packages/riverpod/lib/src/stream_provider/base.dart index 76ff28cca..0f5cf05f6 100644 --- a/packages/riverpod/lib/src/stream_provider/base.dart +++ b/packages/riverpod/lib/src/stream_provider/base.dart @@ -112,7 +112,11 @@ class StreamProvider extends _StreamProviderBase Stream _create(StreamProviderElement ref) => _createFn(ref); @override - StreamProviderElement createElement() => StreamProviderElement(this); + StreamProviderElement createElement( + ProviderContainer container, + ) { + return StreamProviderElement(this, container); + } /// {@macro riverpod.override_with} @mustBeOverridden @@ -138,8 +142,11 @@ class StreamProviderElement extends ProviderElementBase> implements StreamProviderRef { /// The element of [StreamProvider]. @internal - // ignore: library_private_types_in_public_api - StreamProviderElement(_StreamProviderBase super._provider); + StreamProviderElement( + // ignore: library_private_types_in_public_api + _StreamProviderBase super._provider, + super.container, + ); final _streamNotifier = ProxyElementValueNotifier>(); final StreamController _streamController = StreamController.broadcast(); diff --git a/packages/riverpod/test/new/framework/provider_container_test.dart b/packages/riverpod/test/new/framework/provider_container_test.dart index 48379da36..98f9322bc 100644 --- a/packages/riverpod/test/new/framework/provider_container_test.dart +++ b/packages/riverpod/test/new/framework/provider_container_test.dart @@ -591,6 +591,16 @@ void main() { verifyOnly(listener, listener(42, 21)); }); + + test('throws if used on a disposed container', () { + final container = ProviderContainer.test(); + container.dispose(); + + expect( + () => container.updateOverrides([]), + throwsStateError, + ); + }); }); group('listen', () { diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index 01b72b8d0..009c06387 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -7,6 +7,8 @@ export 'package:meta/meta.dart' show visibleForOverriding; export 'package:riverpod/src/internals.dart' show // General stuff + // TODO changelog exported ProviderContainer, + ProviderContainer, Family, ProviderOrFamily, Override, diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 4448b8c92..4cf2b4bab 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -192,8 +192,10 @@ class Count2Provider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _Count2ProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _Count2ProviderElement(this, container); } Count2Provider _copyWith( @@ -231,7 +233,7 @@ mixin Count2Ref on AutoDisposeProviderRef { class _Count2ProviderElement extends AutoDisposeProviderElement with Count2Ref { - _Count2ProviderElement(super.provider); + _Count2ProviderElement(super.provider, super.container); @override int get a => (origin as Count2Provider).a; @@ -361,8 +363,10 @@ class CountFuture2Provider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement() { - return _CountFuture2ProviderElement(this); + AutoDisposeFutureProviderElement createElement( + ProviderContainer container, + ) { + return _CountFuture2ProviderElement(this, container); } CountFuture2Provider _copyWith( @@ -400,7 +404,7 @@ mixin CountFuture2Ref on AutoDisposeFutureProviderRef { class _CountFuture2ProviderElement extends AutoDisposeFutureProviderElement with CountFuture2Ref { - _CountFuture2ProviderElement(super.provider); + _CountFuture2ProviderElement(super.provider, super.container); @override int get a => (origin as CountFuture2Provider).a; @@ -530,8 +534,10 @@ class CountStream2Provider extends AutoDisposeStreamProvider { } @override - AutoDisposeStreamProviderElement createElement() { - return _CountStream2ProviderElement(this); + AutoDisposeStreamProviderElement createElement( + ProviderContainer container, + ) { + return _CountStream2ProviderElement(this, container); } CountStream2Provider _copyWith( @@ -569,7 +575,7 @@ mixin CountStream2Ref on AutoDisposeStreamProviderRef { class _CountStream2ProviderElement extends AutoDisposeStreamProviderElement with CountStream2Ref { - _CountStream2ProviderElement(super.provider); + _CountStream2ProviderElement(super.provider, super.container); @override int get a => (origin as CountStream2Provider).a; @@ -762,8 +768,10 @@ class CountNotifier2Provider } @override - AutoDisposeNotifierProviderElement createElement() { - return _CountNotifier2ProviderElement(this); + AutoDisposeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _CountNotifier2ProviderElement(this, container); } CountNotifier2Provider _copyWith( @@ -802,7 +810,7 @@ mixin CountNotifier2Ref on AutoDisposeNotifierProviderRef { class _CountNotifier2ProviderElement extends AutoDisposeNotifierProviderElement with CountNotifier2Ref { - _CountNotifier2ProviderElement(super.provider); + _CountNotifier2ProviderElement(super.provider, super.container); @override int get a => (origin as CountNotifier2Provider).a; @@ -948,8 +956,10 @@ class CountAsyncNotifier2Provider @override AutoDisposeAsyncNotifierProviderElement - createElement() { - return _CountAsyncNotifier2ProviderElement(this); + createElement( + ProviderContainer container, + ) { + return _CountAsyncNotifier2ProviderElement(this, container); } CountAsyncNotifier2Provider _copyWith( @@ -988,7 +998,7 @@ mixin CountAsyncNotifier2Ref on AutoDisposeAsyncNotifierProviderRef { class _CountAsyncNotifier2ProviderElement extends AutoDisposeAsyncNotifierProviderElement with CountAsyncNotifier2Ref { - _CountAsyncNotifier2ProviderElement(super.provider); + _CountAsyncNotifier2ProviderElement(super.provider, super.container); @override int get a => (origin as CountAsyncNotifier2Provider).a; @@ -1134,8 +1144,10 @@ class CountStreamNotifier2Provider @override AutoDisposeStreamNotifierProviderElement - createElement() { - return _CountStreamNotifier2ProviderElement(this); + createElement( + ProviderContainer container, + ) { + return _CountStreamNotifier2ProviderElement(this, container); } CountStreamNotifier2Provider _copyWith( @@ -1174,7 +1186,7 @@ mixin CountStreamNotifier2Ref on AutoDisposeStreamNotifierProviderRef { class _CountStreamNotifier2ProviderElement extends AutoDisposeStreamNotifierProviderElement with CountStreamNotifier2Ref { - _CountStreamNotifier2ProviderElement(super.provider); + _CountStreamNotifier2ProviderElement(super.provider, super.container); @override int get a => (origin as CountStreamNotifier2Provider).a; diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 34f97ddae..a2cb42331 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -301,6 +301,8 @@ ${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} final familyOverrideClassName = '_\$${provider.name.lexeme.titled.public}FamilyOverride'; + // TODO changelog updated to support createElement prototype change + buffer.write(''' $other @@ -400,8 +402,8 @@ $providerOther } @override - $elementType$providerGenerics createElement() { - return $elementNameImpl(this); + $elementType$providerGenerics createElement(ProviderContainer container,) { + return $elementNameImpl(this, container); } $providerTypeNameImpl _copyWith( @@ -450,7 +452,7 @@ ${e.typeDisplayString} get ${e.name};'''; } class $elementNameImpl$typeParametersDefinition extends $elementType$providerGenerics with $refNameImpl$typeParametersUsage { - $elementNameImpl(super.provider); + $elementNameImpl(super.provider, super.container); ${parameters.map((e) => '@override ${e.typeDisplayString} get ${e.name} => (origin as $providerTypeNameImpl$typeParametersUsage).${e.name};').join()} } diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 99bfe831a..8610bf759 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -170,8 +170,10 @@ class FamilyProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _FamilyProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyProviderElement(this, container); } FamilyProvider _copyWith( @@ -209,7 +211,7 @@ mixin FamilyRef on AutoDisposeProviderRef { class _FamilyProviderElement extends AutoDisposeProviderElement with FamilyRef { - _FamilyProviderElement(super.provider); + _FamilyProviderElement(super.provider, super.container); @override int get id => (origin as FamilyProvider).id; @@ -355,8 +357,10 @@ class NotCopiedFamilyProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _NotCopiedFamilyProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _NotCopiedFamilyProviderElement(this, container); } NotCopiedFamilyProvider _copyWith( @@ -394,7 +398,7 @@ mixin NotCopiedFamilyRef on AutoDisposeProviderRef { class _NotCopiedFamilyProviderElement extends AutoDisposeProviderElement with NotCopiedFamilyRef { - _NotCopiedFamilyProviderElement(super.provider); + _NotCopiedFamilyProviderElement(super.provider, super.container); @override int get id => (origin as NotCopiedFamilyProvider).id; diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 19008ae42..0f177781a 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -139,8 +139,10 @@ class GenericProvider } @override - AutoDisposeFutureProviderElement> createElement() { - return _GenericProviderElement(this); + AutoDisposeFutureProviderElement> createElement( + ProviderContainer container, + ) { + return _GenericProviderElement(this, container); } GenericProvider _copyWith( @@ -174,7 +176,7 @@ mixin GenericRef on AutoDisposeFutureProviderRef> {} class _GenericProviderElement extends AutoDisposeFutureProviderElement> with GenericRef { - _GenericProviderElement(super.provider); + _GenericProviderElement(super.provider, super.container); } String _$publicHash() => r'9d99b79c013da13926d4ad89c72ebca4fc1cc257'; @@ -328,8 +330,10 @@ class FamilyOrProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement() { - return _FamilyOrProviderElement(this); + AutoDisposeFutureProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyOrProviderElement(this, container); } FamilyOrProvider _copyWith( @@ -367,7 +371,7 @@ mixin FamilyOrRef on AutoDisposeFutureProviderRef { class _FamilyOrProviderElement extends AutoDisposeFutureProviderElement with FamilyOrRef { - _FamilyOrProviderElement(super.provider); + _FamilyOrProviderElement(super.provider, super.container); @override int get first => (origin as FamilyOrProvider).first; @@ -544,8 +548,10 @@ class FamilyProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement() { - return _FamilyProviderElement(this); + AutoDisposeFutureProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyProviderElement(this, container); } FamilyProvider _copyWith( @@ -608,7 +614,7 @@ mixin FamilyRef on AutoDisposeFutureProviderRef { class _FamilyProviderElement extends AutoDisposeFutureProviderElement with FamilyRef { - _FamilyProviderElement(super.provider); + _FamilyProviderElement(super.provider, super.container); @override int get first => (origin as FamilyProvider).first; @@ -743,8 +749,10 @@ class GenericClassProvider @override AutoDisposeAsyncNotifierProviderElement, List> - createElement() { - return _GenericClassProviderElement(this); + createElement( + ProviderContainer container, + ) { + return _GenericClassProviderElement(this, container); } GenericClassProvider _copyWith( @@ -780,7 +788,7 @@ mixin GenericClassRef class _GenericClassProviderElement extends AutoDisposeAsyncNotifierProviderElement, List> with GenericClassRef { - _GenericClassProviderElement(super.provider); + _GenericClassProviderElement(super.provider, super.container); } String _$publicClassHash() => r'e9bc69e44b72e8ed77d423524c0d74ad460d629d'; @@ -951,9 +959,10 @@ class FamilyOrClassProvider } @override - AutoDisposeAsyncNotifierProviderElement - createElement() { - return _FamilyOrClassProviderElement(this); + AutoDisposeAsyncNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyOrClassProviderElement(this, container); } FamilyOrClassProvider _copyWith( @@ -992,7 +1001,7 @@ mixin FamilyOrClassRef on AutoDisposeAsyncNotifierProviderRef { class _FamilyOrClassProviderElement extends AutoDisposeAsyncNotifierProviderElement with FamilyOrClassRef { - _FamilyOrClassProviderElement(super.provider); + _FamilyOrClassProviderElement(super.provider, super.container); @override int get first => (origin as FamilyOrClassProvider).first; @@ -1201,8 +1210,10 @@ class FamilyClassProvider } @override - AutoDisposeAsyncNotifierProviderElement createElement() { - return _FamilyClassProviderElement(this); + AutoDisposeAsyncNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyClassProviderElement(this, container); } FamilyClassProvider _copyWith( @@ -1271,7 +1282,7 @@ mixin FamilyClassRef on AutoDisposeAsyncNotifierProviderRef { class _FamilyClassProviderElement extends AutoDisposeAsyncNotifierProviderElement with FamilyClassRef { - _FamilyClassProviderElement(super.provider); + _FamilyClassProviderElement(super.provider, super.container); @override int get first => (origin as FamilyClassProvider).first; diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 0126eab5a..3a935f5c7 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -164,8 +164,10 @@ class FamilyProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _FamilyProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyProviderElement(this, container); } FamilyProvider _copyWith( @@ -203,7 +205,7 @@ mixin FamilyRef on AutoDisposeProviderRef { class _FamilyProviderElement extends AutoDisposeProviderElement with FamilyRef { - _FamilyProviderElement(super.provider); + _FamilyProviderElement(super.provider, super.container); @override int get id => (origin as FamilyProvider).id; @@ -522,8 +524,10 @@ class Family2Provider extends AutoDisposeNotifierProviderImpl { } @override - AutoDisposeNotifierProviderElement createElement() { - return _Family2ProviderElement(this); + AutoDisposeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _Family2ProviderElement(this, container); } Family2Provider _copyWith( @@ -561,7 +565,7 @@ mixin Family2Ref on AutoDisposeNotifierProviderRef { class _Family2ProviderElement extends AutoDisposeNotifierProviderElement with Family2Ref { - _Family2ProviderElement(super.provider); + _Family2ProviderElement(super.provider, super.container); @override int get id => (origin as Family2Provider).id; @@ -746,8 +750,10 @@ class Provider4Provider } @override - AutoDisposeNotifierProviderElement createElement() { - return _Provider4ProviderElement(this); + AutoDisposeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _Provider4ProviderElement(this, container); } Provider4Provider _copyWith( @@ -786,7 +792,7 @@ mixin Provider4Ref on AutoDisposeNotifierProviderRef { class _Provider4ProviderElement extends AutoDisposeNotifierProviderElement with Provider4Ref { - _Provider4ProviderElement(super.provider); + _Provider4ProviderElement(super.provider, super.container); @override int get id => (origin as Provider4Provider).id; diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 68f5c4873..f14d0622f 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -193,8 +193,10 @@ class FamilyWithDependencies2Provider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _FamilyWithDependencies2ProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyWithDependencies2ProviderElement(this, container); } FamilyWithDependencies2Provider _copyWith( @@ -232,7 +234,7 @@ mixin FamilyWithDependencies2Ref on AutoDisposeProviderRef { class _FamilyWithDependencies2ProviderElement extends AutoDisposeProviderElement with FamilyWithDependencies2Ref { - _FamilyWithDependencies2ProviderElement(super.provider); + _FamilyWithDependencies2ProviderElement(super.provider, super.container); @override int? get id => (origin as FamilyWithDependencies2Provider).id; @@ -451,8 +453,10 @@ class NotifierFamilyWithDependenciesProvider @override AutoDisposeNotifierProviderElement - createElement() { - return _NotifierFamilyWithDependenciesProviderElement(this); + createElement( + ProviderContainer container, + ) { + return _NotifierFamilyWithDependenciesProviderElement(this, container); } NotifierFamilyWithDependenciesProvider _copyWith( @@ -491,7 +495,8 @@ mixin NotifierFamilyWithDependenciesRef on AutoDisposeNotifierProviderRef { class _NotifierFamilyWithDependenciesProviderElement extends AutoDisposeNotifierProviderElement with NotifierFamilyWithDependenciesRef { - _NotifierFamilyWithDependenciesProviderElement(super.provider); + _NotifierFamilyWithDependenciesProviderElement( + super.provider, super.container); @override int? get id => (origin as NotifierFamilyWithDependenciesProvider).id; diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 3a6bd55cb..9d1984f29 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -165,8 +165,10 @@ class GeneratedFamilyProvider extends AutoDisposeProvider<_Test> { } @override - AutoDisposeProviderElement<_Test> createElement() { - return _GeneratedFamilyProviderElement(this); + AutoDisposeProviderElement<_Test> createElement( + ProviderContainer container, + ) { + return _GeneratedFamilyProviderElement(this, container); } GeneratedFamilyProvider _copyWith( @@ -204,7 +206,7 @@ mixin GeneratedFamilyRef on AutoDisposeProviderRef<_Test> { class _GeneratedFamilyProviderElement extends AutoDisposeProviderElement<_Test> with GeneratedFamilyRef { - _GeneratedFamilyProviderElement(super.provider); + _GeneratedFamilyProviderElement(super.provider, super.container); @override _Test get test => (origin as GeneratedFamilyProvider).test; @@ -348,8 +350,10 @@ class $DynamicFamilyProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _$DynamicFamilyProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _$DynamicFamilyProviderElement(this, container); } $DynamicFamilyProvider _copyWith( @@ -387,7 +391,7 @@ mixin $DynamicFamilyRef on AutoDisposeProviderRef { class _$DynamicFamilyProviderElement extends AutoDisposeProviderElement with $DynamicFamilyRef { - _$DynamicFamilyProviderElement(super.provider); + _$DynamicFamilyProviderElement(super.provider, super.container); @override get test => (origin as $DynamicFamilyProvider).test; @@ -516,8 +520,10 @@ class _DynamicProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _DynamicProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _DynamicProviderElement(this, container); } _DynamicProvider _copyWith( @@ -555,7 +561,7 @@ mixin _DynamicRef on AutoDisposeProviderRef { class _DynamicProviderElement extends AutoDisposeProviderElement with _DynamicRef { - _DynamicProviderElement(super.provider); + _DynamicProviderElement(super.provider, super.container); @override get test => (origin as _DynamicProvider).test; @@ -699,8 +705,10 @@ class AliasFamilyProvider extends AutoDisposeProvider> { } @override - AutoDisposeProviderElement> createElement() { - return _AliasFamilyProviderElement(this); + AutoDisposeProviderElement> createElement( + ProviderContainer container, + ) { + return _AliasFamilyProviderElement(this, container); } AliasFamilyProvider _copyWith( @@ -738,7 +746,7 @@ mixin AliasFamilyRef on AutoDisposeProviderRef> { class _AliasFamilyProviderElement extends AutoDisposeProviderElement> with AliasFamilyRef { - _AliasFamilyProviderElement(super.provider); + _AliasFamilyProviderElement(super.provider, super.container); @override r.AsyncValue get test => (origin as AliasFamilyProvider).test; @@ -899,9 +907,10 @@ class GeneratedClassFamilyProvider } @override - AutoDisposeNotifierProviderElement - createElement() { - return _GeneratedClassFamilyProviderElement(this); + AutoDisposeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _GeneratedClassFamilyProviderElement(this, container); } GeneratedClassFamilyProvider _copyWith( @@ -940,7 +949,7 @@ mixin GeneratedClassFamilyRef on AutoDisposeNotifierProviderRef<_Test> { class _GeneratedClassFamilyProviderElement extends AutoDisposeNotifierProviderElement with GeneratedClassFamilyRef { - _GeneratedClassFamilyProviderElement(super.provider); + _GeneratedClassFamilyProviderElement(super.provider, super.container); @override _Test get test => (origin as GeneratedClassFamilyProvider).test; @@ -1102,8 +1111,10 @@ class $DynamicClassFamilyProvider @override AutoDisposeNotifierProviderElement<$DynamicClassFamily, Object?> - createElement() { - return _$DynamicClassFamilyProviderElement(this); + createElement( + ProviderContainer container, + ) { + return _$DynamicClassFamilyProviderElement(this, container); } $DynamicClassFamilyProvider _copyWith( @@ -1142,7 +1153,7 @@ mixin $DynamicClassFamilyRef on AutoDisposeNotifierProviderRef { class _$DynamicClassFamilyProviderElement extends AutoDisposeNotifierProviderElement<$DynamicClassFamily, Object?> with $DynamicClassFamilyRef { - _$DynamicClassFamilyProviderElement(super.provider); + _$DynamicClassFamilyProviderElement(super.provider, super.container); @override get test => (origin as $DynamicClassFamilyProvider).test; @@ -1302,8 +1313,10 @@ class AliasClassFamilyProvider extends AutoDisposeNotifierProviderImpl< @override AutoDisposeNotifierProviderElement> - createElement() { - return _AliasClassFamilyProviderElement(this); + createElement( + ProviderContainer container, + ) { + return _AliasClassFamilyProviderElement(this, container); } AliasClassFamilyProvider _copyWith( @@ -1342,7 +1355,7 @@ mixin AliasClassFamilyRef on AutoDisposeNotifierProviderRef> { class _AliasClassFamilyProviderElement extends AutoDisposeNotifierProviderElement> with AliasClassFamilyRef { - _AliasClassFamilyProviderElement(super.provider); + _AliasClassFamilyProviderElement(super.provider, super.container); @override r.AsyncValue get test => (origin as AliasClassFamilyProvider).test; diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index e5e916a48..9ee8bf2c6 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -139,8 +139,10 @@ class GenericProvider } @override - AutoDisposeStreamProviderElement> createElement() { - return _GenericProviderElement(this); + AutoDisposeStreamProviderElement> createElement( + ProviderContainer container, + ) { + return _GenericProviderElement(this, container); } GenericProvider _copyWith( @@ -174,7 +176,7 @@ mixin GenericRef on AutoDisposeStreamProviderRef> {} class _GenericProviderElement extends AutoDisposeStreamProviderElement> with GenericRef { - _GenericProviderElement(super.provider); + _GenericProviderElement(super.provider, super.container); } String _$publicHash() => r'c5cc0eac434371901cf6ab159a81bba49c58da12'; @@ -376,8 +378,10 @@ class FamilyProvider extends AutoDisposeStreamProvider { } @override - AutoDisposeStreamProviderElement createElement() { - return _FamilyProviderElement(this); + AutoDisposeStreamProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyProviderElement(this, container); } FamilyProvider _copyWith( @@ -440,7 +444,7 @@ mixin FamilyRef on AutoDisposeStreamProviderRef { class _FamilyProviderElement extends AutoDisposeStreamProviderElement with FamilyRef { - _FamilyProviderElement(super.provider); + _FamilyProviderElement(super.provider, super.container); @override int get first => (origin as FamilyProvider).first; @@ -575,8 +579,10 @@ class GenericClassProvider @override AutoDisposeStreamNotifierProviderElement, List> - createElement() { - return _GenericClassProviderElement(this); + createElement( + ProviderContainer container, + ) { + return _GenericClassProviderElement(this, container); } GenericClassProvider _copyWith( @@ -612,7 +618,7 @@ mixin GenericClassRef class _GenericClassProviderElement extends AutoDisposeStreamNotifierProviderElement, List> with GenericClassRef { - _GenericClassProviderElement(super.provider); + _GenericClassProviderElement(super.provider, super.container); } String _$publicClassHash() => r'b1526943c8ff0aaa20642bf78e744e5833cf9d02'; @@ -849,9 +855,10 @@ class FamilyClassProvider } @override - AutoDisposeStreamNotifierProviderElement - createElement() { - return _FamilyClassProviderElement(this); + AutoDisposeStreamNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyClassProviderElement(this, container); } FamilyClassProvider _copyWith( @@ -920,7 +927,7 @@ mixin FamilyClassRef on AutoDisposeStreamNotifierProviderRef { class _FamilyClassProviderElement extends AutoDisposeStreamNotifierProviderElement with FamilyClassRef { - _FamilyClassProviderElement(super.provider); + _FamilyClassProviderElement(super.provider, super.container); @override int get first => (origin as FamilyClassProvider).first; diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index d7f9395e7..42d607a87 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -138,8 +138,10 @@ class GenericProvider extends AutoDisposeProvider> { } @override - AutoDisposeProviderElement> createElement() { - return _GenericProviderElement(this); + AutoDisposeProviderElement> createElement( + ProviderContainer container, + ) { + return _GenericProviderElement(this, container); } GenericProvider _copyWith( @@ -173,7 +175,7 @@ mixin GenericRef on AutoDisposeProviderRef> {} class _GenericProviderElement extends AutoDisposeProviderElement> with GenericRef { - _GenericProviderElement(super.provider); + _GenericProviderElement(super.provider, super.container); } String _$complexGenericHash() => r'a5254e5552cd61bb8d65c018539ff2d8edfd5822'; @@ -320,8 +322,10 @@ class ComplexGenericProvider } @override - AutoDisposeProviderElement> createElement() { - return _ComplexGenericProviderElement(this); + AutoDisposeProviderElement> createElement( + ProviderContainer container, + ) { + return _ComplexGenericProviderElement(this, container); } ComplexGenericProvider _copyWith( @@ -371,7 +375,7 @@ mixin ComplexGenericRef class _ComplexGenericProviderElement extends AutoDisposeProviderElement> with ComplexGenericRef { - _ComplexGenericProviderElement(super.provider); + _ComplexGenericProviderElement(super.provider, super.container); @override T get param => (origin as ComplexGenericProvider).param; @@ -532,8 +536,10 @@ class RawFamilyFutureProvider extends AutoDisposeProvider>> { } @override - AutoDisposeProviderElement>> createElement() { - return _RawFamilyFutureProviderElement(this); + AutoDisposeProviderElement>> createElement( + ProviderContainer container, + ) { + return _RawFamilyFutureProviderElement(this, container); } RawFamilyFutureProvider _copyWith( @@ -572,7 +578,7 @@ mixin RawFamilyFutureRef on AutoDisposeProviderRef>> { class _RawFamilyFutureProviderElement extends AutoDisposeProviderElement>> with RawFamilyFutureRef { - _RawFamilyFutureProviderElement(super.provider); + _RawFamilyFutureProviderElement(super.provider, super.container); @override int get id => (origin as RawFamilyFutureProvider).id; @@ -703,8 +709,10 @@ class RawFamilyStreamProvider extends AutoDisposeProvider>> { } @override - AutoDisposeProviderElement>> createElement() { - return _RawFamilyStreamProviderElement(this); + AutoDisposeProviderElement>> createElement( + ProviderContainer container, + ) { + return _RawFamilyStreamProviderElement(this, container); } RawFamilyStreamProvider _copyWith( @@ -743,7 +751,7 @@ mixin RawFamilyStreamRef on AutoDisposeProviderRef>> { class _RawFamilyStreamProviderElement extends AutoDisposeProviderElement>> with RawFamilyStreamRef { - _RawFamilyStreamProviderElement(super.provider); + _RawFamilyStreamProviderElement(super.provider, super.container); @override int get id => (origin as RawFamilyStreamProvider).id; @@ -963,8 +971,10 @@ class FamilyProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _FamilyProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyProviderElement(this, container); } FamilyProvider _copyWith( @@ -1027,7 +1037,7 @@ mixin FamilyRef on AutoDisposeProviderRef { class _FamilyProviderElement extends AutoDisposeProviderElement with FamilyRef { - _FamilyProviderElement(super.provider); + _FamilyProviderElement(super.provider, super.container); @override int get first => (origin as FamilyProvider).first; @@ -1189,8 +1199,10 @@ class GenericClassProvider } @override - AutoDisposeNotifierProviderElement, List> createElement() { - return _GenericClassProviderElement(this); + AutoDisposeNotifierProviderElement, List> createElement( + ProviderContainer container, + ) { + return _GenericClassProviderElement(this, container); } GenericClassProvider _copyWith( @@ -1226,7 +1238,7 @@ mixin GenericClassRef class _GenericClassProviderElement extends AutoDisposeNotifierProviderElement, List> with GenericClassRef { - _GenericClassProviderElement(super.provider); + _GenericClassProviderElement(super.provider, super.container); } String _$rawFutureClassHash() => r'bf66f1cdbd99118b8845d206e6a2611b3101f45c'; @@ -1401,8 +1413,10 @@ class RawFamilyFutureClassProvider extends AutoDisposeNotifierProviderImpl< @override AutoDisposeNotifierProviderElement>> - createElement() { - return _RawFamilyFutureClassProviderElement(this); + createElement( + ProviderContainer container, + ) { + return _RawFamilyFutureClassProviderElement(this, container); } RawFamilyFutureClassProvider _copyWith( @@ -1442,7 +1456,7 @@ mixin RawFamilyFutureClassRef class _RawFamilyFutureClassProviderElement extends AutoDisposeNotifierProviderElement>> with RawFamilyFutureClassRef { - _RawFamilyFutureClassProviderElement(super.provider); + _RawFamilyFutureClassProviderElement(super.provider, super.container); @override int get id => (origin as RawFamilyFutureClassProvider).id; @@ -1588,8 +1602,10 @@ class RawFamilyStreamClassProvider extends AutoDisposeNotifierProviderImpl< @override AutoDisposeNotifierProviderElement>> - createElement() { - return _RawFamilyStreamClassProviderElement(this); + createElement( + ProviderContainer container, + ) { + return _RawFamilyStreamClassProviderElement(this, container); } RawFamilyStreamClassProvider _copyWith( @@ -1629,7 +1645,7 @@ mixin RawFamilyStreamClassRef class _RawFamilyStreamClassProviderElement extends AutoDisposeNotifierProviderElement>> with RawFamilyStreamClassRef { - _RawFamilyStreamClassProviderElement(super.provider); + _RawFamilyStreamClassProviderElement(super.provider, super.container); @override int get id => (origin as RawFamilyStreamClassProvider).id; @@ -1882,8 +1898,10 @@ class FamilyClassProvider } @override - AutoDisposeNotifierProviderElement createElement() { - return _FamilyClassProviderElement(this); + AutoDisposeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyClassProviderElement(this, container); } FamilyClassProvider _copyWith( @@ -1952,7 +1970,7 @@ mixin FamilyClassRef on AutoDisposeNotifierProviderRef { class _FamilyClassProviderElement extends AutoDisposeNotifierProviderElement with FamilyClassRef { - _FamilyClassProviderElement(super.provider); + _FamilyClassProviderElement(super.provider, super.container); @override int get first => (origin as FamilyClassProvider).first; diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 7a09ecae2..2280a7a99 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -243,8 +243,10 @@ class FamilyProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _FamilyProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyProviderElement(this, container); } FamilyProvider _copyWith( @@ -307,7 +309,7 @@ mixin FamilyRef on AutoDisposeProviderRef { class _FamilyProviderElement extends AutoDisposeProviderElement with FamilyRef { - _FamilyProviderElement(super.provider); + _FamilyProviderElement(super.provider, super.container); @override int get first => (origin as FamilyProvider).first; @@ -582,8 +584,10 @@ class FamilyClassProvider } @override - AutoDisposeNotifierProviderElement createElement() { - return _FamilyClassProviderElement(this); + AutoDisposeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyClassProviderElement(this, container); } FamilyClassProvider _copyWith( @@ -652,7 +656,7 @@ mixin FamilyClassRef on AutoDisposeNotifierProviderRef { class _FamilyClassProviderElement extends AutoDisposeNotifierProviderElement with FamilyClassRef { - _FamilyClassProviderElement(super.provider); + _FamilyClassProviderElement(super.provider, super.container); @override int get first => (origin as FamilyClassProvider).first; diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index 8e2a8b82e..b65566a6b 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -213,8 +213,10 @@ class ExampleFamilyProvider } @override - AutoDisposeNotifierProviderElement createElement() { - return _ExampleFamilyProviderElement(this); + AutoDisposeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _ExampleFamilyProviderElement(this, container); } ExampleFamilyProvider _copyWith( @@ -260,7 +262,7 @@ mixin ExampleFamilyRef on AutoDisposeNotifierProviderRef { class _ExampleFamilyProviderElement extends AutoDisposeNotifierProviderElement with ExampleFamilyRef { - _ExampleFamilyProviderElement(super.provider); + _ExampleFamilyProviderElement(super.provider, super.container); @override int get a => (origin as ExampleFamilyProvider).a; @@ -386,8 +388,10 @@ class GenericProvider } @override - AutoDisposeNotifierProviderElement, int> createElement() { - return _GenericProviderElement(this); + AutoDisposeNotifierProviderElement, int> createElement( + ProviderContainer container, + ) { + return _GenericProviderElement(this, container); } GenericProvider _copyWith( @@ -423,7 +427,7 @@ mixin GenericRef on AutoDisposeNotifierProviderRef {} class _GenericProviderElement extends AutoDisposeNotifierProviderElement, int> with GenericRef { - _GenericProviderElement(super.provider); + _GenericProviderElement(super.provider, super.container); } // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index fce831170..6cfee54cc 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -194,8 +194,10 @@ class ExampleFamilyProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _ExampleFamilyProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _ExampleFamilyProviderElement(this, container); } ExampleFamilyProvider _copyWith( @@ -238,7 +240,7 @@ mixin ExampleFamilyRef on AutoDisposeProviderRef { class _ExampleFamilyProviderElement extends AutoDisposeProviderElement with ExampleFamilyRef { - _ExampleFamilyProviderElement(super.provider); + _ExampleFamilyProviderElement(super.provider, super.container); @override int get a => (origin as ExampleFamilyProvider).a; diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 57ff93806..f946722de 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -163,8 +163,10 @@ class FnProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _FnProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _FnProviderElement(this, container); } FnProvider _copyWith( @@ -208,7 +210,7 @@ mixin FnRef on AutoDisposeProviderRef { } class _FnProviderElement extends AutoDisposeProviderElement with FnRef { - _FnProviderElement(super.provider); + _FnProviderElement(super.provider, super.container); @override BuildContext get context1 => (origin as FnProvider).context1; @@ -374,8 +376,10 @@ class MyNotifierProvider } @override - AutoDisposeNotifierProviderElement createElement() { - return _MyNotifierProviderElement(this); + AutoDisposeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _MyNotifierProviderElement(this, container); } MyNotifierProvider _copyWith( @@ -423,7 +427,7 @@ mixin MyNotifierRef on AutoDisposeNotifierProviderRef { class _MyNotifierProviderElement extends AutoDisposeNotifierProviderElement with MyNotifierRef { - _MyNotifierProviderElement(super.provider); + _MyNotifierProviderElement(super.provider, super.container); @override BuildContext get context1 => (origin as MyNotifierProvider).context1; diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index c940d274a..e369cc34c 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -164,8 +164,10 @@ class GeneratedNotifierProvider } @override - AutoDisposeNotifierProviderElement createElement() { - return _GeneratedNotifierProviderElement(this); + AutoDisposeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _GeneratedNotifierProviderElement(this, container); } GeneratedNotifierProvider _copyWith( @@ -204,7 +206,7 @@ mixin GeneratedNotifierRef on AutoDisposeNotifierProviderRef { class _GeneratedNotifierProviderElement extends AutoDisposeNotifierProviderElement with GeneratedNotifierRef { - _GeneratedNotifierProviderElement(super.provider); + _GeneratedNotifierProviderElement(super.provider, super.container); @override int get param => (origin as GeneratedNotifierProvider).param; diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index 0c6d35d4d..e66659eaf 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -534,8 +534,10 @@ class FamilyDepProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _FamilyDepProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyDepProviderElement(this, container); } FamilyDepProvider _copyWith( @@ -573,7 +575,7 @@ mixin FamilyDepRef on AutoDisposeProviderRef { class _FamilyDepProviderElement extends AutoDisposeProviderElement with FamilyDepRef { - _FamilyDepProviderElement(super.provider); + _FamilyDepProviderElement(super.provider, super.container); @override int get p => (origin as FamilyDepProvider).p; @@ -709,8 +711,10 @@ class FamilyDep2Provider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _FamilyDep2ProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _FamilyDep2ProviderElement(this, container); } FamilyDep2Provider _copyWith( @@ -748,7 +752,7 @@ mixin FamilyDep2Ref on AutoDisposeProviderRef { class _FamilyDep2ProviderElement extends AutoDisposeProviderElement with FamilyDep2Ref { - _FamilyDep2ProviderElement(super.provider); + _FamilyDep2ProviderElement(super.provider, super.container); @override int get p => (origin as FamilyDep2Provider).p; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index d224137fc..01bb30cae 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -169,8 +169,10 @@ class GenericsProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _GenericsProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _GenericsProviderElement(this, container); } GenericsProvider _copyWith( @@ -205,7 +207,7 @@ mixin GenericsRef on AutoDisposeProviderRef {} class _GenericsProviderElement extends AutoDisposeProviderElement with GenericsRef { - _GenericsProviderElement(super.provider); + _GenericsProviderElement(super.provider, super.container); } String _$noGenericsHash() => r'449264e25990bc14ad811c0940117c8cde4d730a'; @@ -320,8 +322,10 @@ class NoGenericsProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _NoGenericsProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _NoGenericsProviderElement(this, container); } NoGenericsProvider _copyWith( @@ -356,7 +360,7 @@ mixin NoGenericsRef on AutoDisposeProviderRef {} class _NoGenericsProviderElement extends AutoDisposeProviderElement with NoGenericsRef { - _NoGenericsProviderElement(super.provider); + _NoGenericsProviderElement(super.provider, super.container); } String _$missingGenericsHash() => r'7d8bc49e4f1e466260fbf6a61a3f9e62b4aef28f'; @@ -470,8 +474,10 @@ class MissingGenericsProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _MissingGenericsProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _MissingGenericsProviderElement(this, container); } MissingGenericsProvider _copyWith( @@ -506,7 +512,7 @@ mixin MissingGenericsRef on AutoDisposeProviderRef {} class _MissingGenericsProviderElement extends AutoDisposeProviderElement with MissingGenericsRef { - _MissingGenericsProviderElement(super.provider); + _MissingGenericsProviderElement(super.provider, super.container); } String _$wrongOrderHash() => r'6732863e85b220c07f82c2d13be15c1e6f08192d'; @@ -620,8 +626,10 @@ class WrongOrderProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _WrongOrderProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _WrongOrderProviderElement(this, container); } WrongOrderProvider _copyWith( @@ -656,7 +664,7 @@ mixin WrongOrderRef on AutoDisposeProviderRef {} class _WrongOrderProviderElement extends AutoDisposeProviderElement with WrongOrderRef { - _WrongOrderProviderElement(super.provider); + _WrongOrderProviderElement(super.provider, super.container); } // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart index 8bfc3a4aa..848434c3d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart @@ -205,8 +205,10 @@ class GenericsProvider } @override - AutoDisposeNotifierProviderElement, int> createElement() { - return _GenericsProviderElement(this); + AutoDisposeNotifierProviderElement, int> createElement( + ProviderContainer container, + ) { + return _GenericsProviderElement(this, container); } GenericsProvider _copyWith( @@ -242,7 +244,7 @@ mixin GenericsRef on AutoDisposeNotifierProviderRef {} class _GenericsProviderElement extends AutoDisposeNotifierProviderElement, int> with GenericsRef { - _GenericsProviderElement(super.provider); + _GenericsProviderElement(super.provider, super.container); } String _$noGenericsHash() => r'30d5d20092f43cb17ede1f619773757df7cecb30'; @@ -365,8 +367,10 @@ class NoGenericsProvider } @override - AutoDisposeNotifierProviderElement, int> createElement() { - return _NoGenericsProviderElement(this); + AutoDisposeNotifierProviderElement, int> createElement( + ProviderContainer container, + ) { + return _NoGenericsProviderElement(this, container); } NoGenericsProvider _copyWith( @@ -402,7 +406,7 @@ mixin NoGenericsRef on AutoDisposeNotifierProviderRef {} class _NoGenericsProviderElement extends AutoDisposeNotifierProviderElement, int> with NoGenericsRef { - _NoGenericsProviderElement(super.provider); + _NoGenericsProviderElement(super.provider, super.container); } String _$missingGenericsHash() => r'b611c76d5fb87fdde78b5fc017912e0569762c23'; @@ -525,9 +529,10 @@ class MissingGenericsProvider } @override - AutoDisposeNotifierProviderElement, int> - createElement() { - return _MissingGenericsProviderElement(this); + AutoDisposeNotifierProviderElement, int> createElement( + ProviderContainer container, + ) { + return _MissingGenericsProviderElement(this, container); } MissingGenericsProvider _copyWith( @@ -563,7 +568,7 @@ mixin MissingGenericsRef on AutoDisposeNotifierProviderRef {} class _MissingGenericsProviderElement extends AutoDisposeNotifierProviderElement, int> with MissingGenericsRef { - _MissingGenericsProviderElement(super.provider); + _MissingGenericsProviderElement(super.provider, super.container); } String _$wrongOrderHash() => r'7757670a2f67406ebc96c87edf088deb9cb248a1'; @@ -685,8 +690,10 @@ class WrongOrderProvider } @override - AutoDisposeNotifierProviderElement, int> createElement() { - return _WrongOrderProviderElement(this); + AutoDisposeNotifierProviderElement, int> createElement( + ProviderContainer container, + ) { + return _WrongOrderProviderElement(this, container); } WrongOrderProvider _copyWith( @@ -722,7 +729,7 @@ mixin WrongOrderRef on AutoDisposeNotifierProviderRef {} class _WrongOrderProviderElement extends AutoDisposeNotifierProviderElement, int> with WrongOrderRef { - _WrongOrderProviderElement(super.provider); + _WrongOrderProviderElement(super.provider, super.container); } // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index 7c9fb644a..2dfc05797 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -188,8 +188,10 @@ class A3Provider extends AutoDisposeNotifierProviderImpl { } @override - AutoDisposeNotifierProviderElement createElement() { - return _A3ProviderElement(this); + AutoDisposeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _A3ProviderElement(this, container); } A3Provider _copyWith( @@ -227,7 +229,7 @@ mixin A3Ref on AutoDisposeNotifierProviderRef { class _A3ProviderElement extends AutoDisposeNotifierProviderElement with A3Ref { - _A3ProviderElement(super.provider); + _A3ProviderElement(super.provider, super.container); @override int get param => (origin as A3Provider).param; @@ -366,8 +368,10 @@ class A4Provider extends NotifierProviderImpl { } @override - NotifierProviderElement createElement() { - return _A4ProviderElement(this); + NotifierProviderElement createElement( + ProviderContainer container, + ) { + return _A4ProviderElement(this, container); } A4Provider _copyWith( @@ -404,7 +408,7 @@ mixin A4Ref on NotifierProviderRef { } class _A4ProviderElement extends NotifierProviderElement with A4Ref { - _A4ProviderElement(super.provider); + _A4ProviderElement(super.provider, super.container); @override int get param => (origin as A4Provider).param; @@ -543,8 +547,10 @@ class A5Provider extends AutoDisposeAsyncNotifierProviderImpl { } @override - AutoDisposeAsyncNotifierProviderElement createElement() { - return _A5ProviderElement(this); + AutoDisposeAsyncNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _A5ProviderElement(this, container); } A5Provider _copyWith( @@ -582,7 +588,7 @@ mixin A5Ref on AutoDisposeAsyncNotifierProviderRef { class _A5ProviderElement extends AutoDisposeAsyncNotifierProviderElement with A5Ref { - _A5ProviderElement(super.provider); + _A5ProviderElement(super.provider, super.container); @override int get param => (origin as A5Provider).param; @@ -721,8 +727,10 @@ class A6Provider extends AsyncNotifierProviderImpl { } @override - AsyncNotifierProviderElement createElement() { - return _A6ProviderElement(this); + AsyncNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _A6ProviderElement(this, container); } A6Provider _copyWith( @@ -760,7 +768,7 @@ mixin A6Ref on AsyncNotifierProviderRef { class _A6ProviderElement extends AsyncNotifierProviderElement with A6Ref { - _A6ProviderElement(super.provider); + _A6ProviderElement(super.provider, super.container); @override int get param => (origin as A6Provider).param; @@ -899,8 +907,10 @@ class A7Provider extends AutoDisposeStreamNotifierProviderImpl { } @override - AutoDisposeStreamNotifierProviderElement createElement() { - return _A7ProviderElement(this); + AutoDisposeStreamNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _A7ProviderElement(this, container); } A7Provider _copyWith( @@ -938,7 +948,7 @@ mixin A7Ref on AutoDisposeStreamNotifierProviderRef { class _A7ProviderElement extends AutoDisposeStreamNotifierProviderElement with A7Ref { - _A7ProviderElement(super.provider); + _A7ProviderElement(super.provider, super.container); @override int get param => (origin as A7Provider).param; @@ -1077,8 +1087,10 @@ class A8Provider extends StreamNotifierProviderImpl { } @override - StreamNotifierProviderElement createElement() { - return _A8ProviderElement(this); + StreamNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _A8ProviderElement(this, container); } A8Provider _copyWith( @@ -1116,7 +1128,7 @@ mixin A8Ref on StreamNotifierProviderRef { class _A8ProviderElement extends StreamNotifierProviderElement with A8Ref { - _A8ProviderElement(super.provider); + _A8ProviderElement(super.provider, super.container); @override int get param => (origin as A8Provider).param; diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index e47e0ce94..3f8156b4b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -152,8 +152,10 @@ class GeneratorProvider extends Provider { } @override - ProviderElement createElement() { - return _GeneratorProviderElement(this); + ProviderElement createElement( + ProviderContainer container, + ) { + return _GeneratorProviderElement(this, container); } GeneratorProvider _copyWith( @@ -190,7 +192,7 @@ mixin GeneratorRef on ProviderRef { } class _GeneratorProviderElement extends ProviderElement with GeneratorRef { - _GeneratorProviderElement(super.provider); + _GeneratorProviderElement(super.provider, super.container); @override Object? get value => (origin as GeneratorProvider).value; diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 370c04d0a..46308bff6 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -154,8 +154,10 @@ class FetchUserProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement() { - return _FetchUserProviderElement(this); + AutoDisposeFutureProviderElement createElement( + ProviderContainer container, + ) { + return _FetchUserProviderElement(this, container); } FetchUserProvider _copyWith( @@ -193,7 +195,7 @@ mixin FetchUserRef on AutoDisposeFutureProviderRef { class _FetchUserProviderElement extends AutoDisposeFutureProviderElement with FetchUserRef { - _FetchUserProviderElement(super.provider); + _FetchUserProviderElement(super.provider, super.container); @override int get userId => (origin as FetchUserProvider).userId; diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index fe7456f0d..c08d209d1 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -152,8 +152,10 @@ class ExampleProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _ExampleProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _ExampleProviderElement(this, container); } ExampleProvider _copyWith( @@ -191,7 +193,7 @@ mixin ExampleRef on AutoDisposeProviderRef { class _ExampleProviderElement extends AutoDisposeProviderElement with ExampleRef { - _ExampleProviderElement(super.provider); + _ExampleProviderElement(super.provider, super.container); @override int get param => (origin as ExampleProvider).param; diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index 1108d93c1..f787a49c2 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -185,8 +185,10 @@ class ExampleProvider extends AutoDisposeNotifierProviderImpl { } @override - AutoDisposeNotifierProviderElement createElement() { - return _ExampleProviderElement(this); + AutoDisposeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _ExampleProviderElement(this, container); } ExampleProvider _copyWith( @@ -234,7 +236,7 @@ mixin ExampleRef on AutoDisposeNotifierProviderRef { class _ExampleProviderElement extends AutoDisposeNotifierProviderElement with ExampleRef { - _ExampleProviderElement(super.provider); + _ExampleProviderElement(super.provider, super.container); @override int get param1 => (origin as ExampleProvider).param1; diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index a72fa27de..dec24ae10 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -167,8 +167,10 @@ class ExampleProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _ExampleProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _ExampleProviderElement(this, container); } ExampleProvider _copyWith( @@ -213,7 +215,7 @@ mixin ExampleRef on AutoDisposeProviderRef { class _ExampleProviderElement extends AutoDisposeProviderElement with ExampleRef { - _ExampleProviderElement(super.provider); + _ExampleProviderElement(super.provider, super.container); @override int get param1 => (origin as ExampleProvider).param1; diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index 410c48677..8a6339941 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -152,8 +152,10 @@ class LabelProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _LabelProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _LabelProviderElement(this, container); } LabelProvider _copyWith( @@ -191,7 +193,7 @@ mixin LabelRef on AutoDisposeProviderRef { class _LabelProviderElement extends AutoDisposeProviderElement with LabelRef { - _LabelProviderElement(super.provider); + _LabelProviderElement(super.provider, super.container); @override String get userName => (origin as LabelProvider).userName; diff --git a/website/docs/essentials/passing_args/codegen/family.g.dart b/website/docs/essentials/passing_args/codegen/family.g.dart index c88a2122c..c11d603c0 100644 --- a/website/docs/essentials/passing_args/codegen/family.g.dart +++ b/website/docs/essentials/passing_args/codegen/family.g.dart @@ -152,8 +152,10 @@ class ActivityProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement() { - return _ActivityProviderElement(this); + AutoDisposeFutureProviderElement createElement( + ProviderContainer container, + ) { + return _ActivityProviderElement(this, container); } ActivityProvider _copyWith( @@ -191,7 +193,7 @@ mixin ActivityRef on AutoDisposeFutureProviderRef { class _ActivityProviderElement extends AutoDisposeFutureProviderElement with ActivityRef { - _ActivityProviderElement(super.provider); + _ActivityProviderElement(super.provider, super.container); @override String get activityType => (origin as ActivityProvider).activityType; diff --git a/website/docs/essentials/passing_args/codegen/provider.g.dart b/website/docs/essentials/passing_args/codegen/provider.g.dart index 7b8a4fd90..70093f52d 100644 --- a/website/docs/essentials/passing_args/codegen/provider.g.dart +++ b/website/docs/essentials/passing_args/codegen/provider.g.dart @@ -182,8 +182,10 @@ class ActivityNotifier2Provider @override AutoDisposeAsyncNotifierProviderElement - createElement() { - return _ActivityNotifier2ProviderElement(this); + createElement( + ProviderContainer container, + ) { + return _ActivityNotifier2ProviderElement(this, container); } ActivityNotifier2Provider _copyWith( @@ -223,7 +225,7 @@ mixin ActivityNotifier2Ref on AutoDisposeAsyncNotifierProviderRef { class _ActivityNotifier2ProviderElement extends AutoDisposeAsyncNotifierProviderElement with ActivityNotifier2Ref { - _ActivityNotifier2ProviderElement(super.provider); + _ActivityNotifier2ProviderElement(super.provider, super.container); @override String get activityType => (origin as ActivityNotifier2Provider).activityType; diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index 3e39394a5..d171c13e2 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -167,8 +167,10 @@ class RandomProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement() { - return _RandomProviderElement(this); + AutoDisposeProviderElement createElement( + ProviderContainer container, + ) { + return _RandomProviderElement(this, container); } RandomProvider _copyWith( @@ -211,7 +213,7 @@ mixin RandomRef on AutoDisposeProviderRef { class _RandomProviderElement extends AutoDisposeProviderElement with RandomRef { - _RandomProviderElement(super.provider); + _RandomProviderElement(super.provider, super.container); @override int get seed => (origin as RandomProvider).seed; diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index 8f63ec36f..cd7cd9edf 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -169,8 +169,10 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { } @override - AutoDisposeFutureProviderElement> createElement() { - return _FetchPackagesProviderElement(this); + AutoDisposeFutureProviderElement> createElement( + ProviderContainer container, + ) { + return _FetchPackagesProviderElement(this, container); } FetchPackagesProvider _copyWith( @@ -216,7 +218,7 @@ mixin FetchPackagesRef on AutoDisposeFutureProviderRef> { class _FetchPackagesProviderElement extends AutoDisposeFutureProviderElement> with FetchPackagesRef { - _FetchPackagesProviderElement(super.provider); + _FetchPackagesProviderElement(super.provider, super.container); @override int get page => (origin as FetchPackagesProvider).page; diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index cbcfb779b..f348b4ea8 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -169,8 +169,10 @@ class BugsEncounteredNotifierProvider @override AutoDisposeAsyncNotifierProviderElement - createElement() { - return _BugsEncounteredNotifierProviderElement(this); + createElement( + ProviderContainer container, + ) { + return _BugsEncounteredNotifierProviderElement(this, container); } BugsEncounteredNotifierProvider _copyWith( @@ -210,7 +212,7 @@ mixin BugsEncounteredNotifierRef on AutoDisposeAsyncNotifierProviderRef { class _BugsEncounteredNotifierProviderElement extends AutoDisposeAsyncNotifierProviderElement with BugsEncounteredNotifierRef { - _BugsEncounteredNotifierProviderElement(super.provider); + _BugsEncounteredNotifierProviderElement(super.provider, super.container); @override String get featureId => (origin as BugsEncounteredNotifierProvider).featureId; diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 370c04d0a..46308bff6 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -154,8 +154,10 @@ class FetchUserProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement() { - return _FetchUserProviderElement(this); + AutoDisposeFutureProviderElement createElement( + ProviderContainer container, + ) { + return _FetchUserProviderElement(this, container); } FetchUserProvider _copyWith( @@ -193,7 +195,7 @@ mixin FetchUserRef on AutoDisposeFutureProviderRef { class _FetchUserProviderElement extends AutoDisposeFutureProviderElement with FetchUserRef { - _FetchUserProviderElement(super.provider); + _FetchUserProviderElement(super.provider, super.container); @override int get userId => (origin as FetchUserProvider).userId; diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 370c04d0a..46308bff6 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -154,8 +154,10 @@ class FetchUserProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement() { - return _FetchUserProviderElement(this); + AutoDisposeFutureProviderElement createElement( + ProviderContainer container, + ) { + return _FetchUserProviderElement(this, container); } FetchUserProvider _copyWith( @@ -193,7 +195,7 @@ mixin FetchUserRef on AutoDisposeFutureProviderRef { class _FetchUserProviderElement extends AutoDisposeFutureProviderElement with FetchUserRef { - _FetchUserProviderElement(super.provider); + _FetchUserProviderElement(super.provider, super.container); @override int get userId => (origin as FetchUserProvider).userId; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 370c04d0a..46308bff6 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -154,8 +154,10 @@ class FetchUserProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement() { - return _FetchUserProviderElement(this); + AutoDisposeFutureProviderElement createElement( + ProviderContainer container, + ) { + return _FetchUserProviderElement(this, container); } FetchUserProvider _copyWith( @@ -193,7 +195,7 @@ mixin FetchUserRef on AutoDisposeFutureProviderRef { class _FetchUserProviderElement extends AutoDisposeFutureProviderElement with FetchUserRef { - _FetchUserProviderElement(super.provider); + _FetchUserProviderElement(super.provider, super.container); @override int get userId => (origin as FetchUserProvider).userId; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 370c04d0a..46308bff6 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -154,8 +154,10 @@ class FetchUserProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement() { - return _FetchUserProviderElement(this); + AutoDisposeFutureProviderElement createElement( + ProviderContainer container, + ) { + return _FetchUserProviderElement(this, container); } FetchUserProvider _copyWith( @@ -193,7 +195,7 @@ mixin FetchUserRef on AutoDisposeFutureProviderRef { class _FetchUserProviderElement extends AutoDisposeFutureProviderElement with FetchUserRef { - _FetchUserProviderElement(super.provider); + _FetchUserProviderElement(super.provider, super.container); @override int get userId => (origin as FetchUserProvider).userId; From fb3f2f0495ac6639bc6ce71a43419312b950465a Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 15 Dec 2023 12:24:43 +0100 Subject: [PATCH 069/387] w --- packages/riverpod/lib/src/framework.dart | 2 + .../riverpod/lib/src/framework/family.dart | 1 + .../lib/src/framework/foundation.dart | 2 +- .../lib/src/framework/provider_container.dart | 1002 ++++++++++------- packages/riverpod/pubspec.yaml | 2 +- .../framework/provider_container_test.dart | 708 ++++++++++++ 6 files changed, 1337 insertions(+), 380 deletions(-) diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index 653ef5dc1..5b55f28aa 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -3,7 +3,9 @@ library framework; import 'dart:async'; import 'dart:collection'; +import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; +import 'package:meta/meta.dart' as meta; import 'package:state_notifier/state_notifier.dart'; import 'package:test/test.dart' as test; import 'env.dart'; diff --git a/packages/riverpod/lib/src/framework/family.dart b/packages/riverpod/lib/src/framework/family.dart index 89c450899..7a7872703 100644 --- a/packages/riverpod/lib/src/framework/family.dart +++ b/packages/riverpod/lib/src/framework/family.dart @@ -72,6 +72,7 @@ typedef SetupFamilyOverride = void Function( @internal abstract class FamilyOverride implements Override { /// The family that was overridden. + // TODO make all fields private Family get overriddenFamily; /// Obtains the new behavior for a provider associated to the overridden family. diff --git a/packages/riverpod/lib/src/framework/foundation.dart b/packages/riverpod/lib/src/framework/foundation.dart index cf6190e68..4335a1918 100644 --- a/packages/riverpod/lib/src/framework/foundation.dart +++ b/packages/riverpod/lib/src/framework/foundation.dart @@ -2,7 +2,7 @@ part of '../framework.dart'; /// A common interface shared by [ProviderBase] and [Family] @sealed -abstract class ProviderOrFamily implements ProviderListenableOrFamily { +sealed class ProviderOrFamily implements ProviderListenableOrFamily { /// A common interface shared by [ProviderBase] and [Family] const ProviderOrFamily({ required this.name, diff --git a/packages/riverpod/lib/src/framework/provider_container.dart b/packages/riverpod/lib/src/framework/provider_container.dart index ed4da75a5..98f71071d 100644 --- a/packages/riverpod/lib/src/framework/provider_container.dart +++ b/packages/riverpod/lib/src/framework/provider_container.dart @@ -1,88 +1,538 @@ part of '../framework.dart'; +extension on String { + String indentAfterFirstLine(int level) { + final indent = ' ' * level; + return split('\n').join('\n$indent'); + } +} + ProviderBase? _circularDependencyLock; -class _FamilyOverrideRef { - _FamilyOverrideRef(this.override, this.container); +abstract class _PointerBase { + ProviderContainer get container; +} + +@internal +class ProviderPointer implements _PointerBase { + ProviderPointer(this.container, {required this.providerOverride}); + + /// The override associated with this provider, if any. + /// + /// If non-null, this pointer should **never** be removed. + /// + /// This override may be implicitly created by [ProviderOrFamily.allTransitiveDependencies]. + ProviderOverride? providerOverride; + ProviderElementBase? element; + @override + final ProviderContainer container; + + @override + String toString() { + final buffer = StringBuffer(); + buffer.writeln('ProviderPointer$hashCode('); + + buffer.writeln(' container: $container'); + buffer.writeln(' override: $providerOverride'); + buffer.writeln(' element: $element'); + + buffer.write(')'); + + return buffer.toString(); + } +} + +PointerT _upsert( + ProviderContainer container, + Map pointers, + ProviderOrFamily provider, { + required PointerT Function() useRoot, + required PointerT Function(OverrideT) create, +}) { + // We are not at the root and the provider can't be scoped. + // Let's just return the root's pointer. + if (provider.allTransitiveDependencies == null && container._parent != null) { + // If the provider can't be scoped, we mount it in the root container directly. + return useRoot(); + } + + final pointer = pointers[provider]; + if (pointer != null) { + // We are at the root and the pointer is already here. Nothing to do. + if (container._parent == null) return pointer; + + // The provider is already mounted in this container and can't be further down. + // We can just return it. + if (pointer.container == container) return pointer; - FamilyOverride override; + if (!container._pointerManager.hasLocallyOverriddenDependency(provider)) { + // The provider is not overridden, so we can just return the pointer. + return pointer; + } + } + + return create(); +} + +@internal +class ProviderDirectory implements _PointerBase { + ProviderDirectory( + this.container, { + required this.familyOverride, + HashMap, ProviderPointer>? pointers, + }) : pointers = pointers ?? HashMap(); + + ProviderDirectory.from( + ProviderDirectory pointer, + ) : familyOverride = pointer.familyOverride, + container = pointer.container, + pointers = HashMap.fromEntries( + pointer.pointers.entries.where((e) { + if (e.key.allTransitiveDependencies == null) return true; + if (e.value.providerOverride != null) return true; + + return false; + }), + ); + + /// The override associated with this provider, if any. + /// + /// If non-null, this pointer should **never** be removed. + /// + /// This override may be implicitly created by [ProviderOrFamily.allTransitiveDependencies]. + FamilyOverride? familyOverride; + final HashMap, ProviderPointer> pointers; + @override final ProviderContainer container; + + void addProviderOverride( + ProviderOverride override, + ProviderContainer target, + ) { + final origin = override._origin; + final previousPointer = pointers[origin]; + + // The provider wasn't overridden yet, so we can just add it + if (previousPointer == null || previousPointer.container != target) { + pointers[origin] = ProviderPointer( + target, + providerOverride: override, + ); + return; + } + + throw StateError( + 'Cannot override a provider twice within the same container: $origin', + ); + } + + ProviderPointer upsertPointer(ProviderBase provider) { + // TODO changelog that provider which don't specify depencies can't be scoped + // TODO throw if a provider is overridden but does not specify dependencies + + return _upsert( + container, + pointers, + provider, + useRoot: () => container._root!._pointerManager.upsertPointer(provider), + create: () => ProviderPointer(container), + ); + + // // We are not at the root and the provider can't be scoped. + // // Let's just return the root's pointer. + // if (provider.allTransitiveDependencies == null && + // container.parent != null) { + // // If the provider can't be scoped, we mount it in the root container directly. + // return container._root!._pointerManager.upsertPointer(provider); + // } + + // final pointer = pointers[provider]; + // if (pointer != null) { + // // We are at the root and the pointer is already here. Nothing to do. + // if (container._parent == null) return pointer; + + // // The provider is already mounted in this container and can't be further down. + // // We can just return it. + // if (pointer.container == container) return pointer; + // } + + // return pointers.putIfAbsent(provider, () { + // if (container._pointerManager.hasLocallyOverriddenDependency(provider)) { + // // If the provider is overridden, we mount it in this container. + // } else if (container._root case final root?) { + // // If the provider is not overridden, we mount it in the root container. + // // This way, all containers will share the same state. + // return root._pointerManager.upsertPointer(provider); + // } + + // return ProviderPointer(container); + // }); + } + + /// Initializes a provider and returns its pointer. + /// + /// Overridden providers, be it directly or transitively, + /// are mounted in the current container. + /// + /// Non-overridden providers are mounted in the root container. + ProviderPointer mount(ProviderBase provider) { + final pointer = upsertPointer(provider); + + if (pointer.element == null) { + final element = provider.createElement(container) + // TODO remove + .._provider = pointer.providerOverride?._override ?? provider + // TODO remove + .._origin = provider + // TODO make this optional + ..mount(); + pointer.element = element; + } + + return pointer; + } + + @override + // ignore: annotate_overrides, https://github.com/dart-lang/linter/issues/4819 + String toString() { + final buffer = StringBuffer(); + buffer.writeln('ProviderDirectory$hashCode('); + + buffer.writeln(' container: $container'); + buffer.writeln(' override: $familyOverride'); + + buffer.write(' pointers: {'); + for (final entry in pointers.entries) { + buffer.write( + '\n ${entry.key}: ${entry.value.toString().indentAfterFirstLine(2)},', + ); + } + if (pointers.isNotEmpty) { + buffer.writeln('\n }'); + } else { + buffer.writeln('}'); + } + + buffer.write(')'); + + return buffer.toString(); + } } -/// An object that contains a [ProviderElementBase]. +/// An object responsible for storing the a O(1) access to providers, +/// while also enabling the "scoping" of providers and ensuring all [ProviderContainer]s +/// are in sync. +/// +/// Instead of storing a [Map], we voluntarily +/// introduce a level of indirection by storing a [Map]. /// -/// This object is used to implement the scoping mechanism of providers, -/// by allowing a [ProviderContainer] to "inherit" the [_StateReader]s from -/// its ancestor, while preserving the "mount providers on demand" logic. -class _StateReader { - _StateReader({ - required this.origin, - required this.override, +/// Then, when overriding a provider, it is guaranteed that the [ProviderContainer] +/// and all of its children have the same [ProviderPointer] for a overridden provider. +/// +/// This way, we can read an overridden provider from any of the [ProviderContainer]s. +/// And no-matter where the first read is made, all [ProviderContainer]s will +/// share the same state. +@internal +class ProviderPointerManager { + ProviderPointerManager( + List overrides, { required this.container, - required this.isDynamicallyCreated, - }); + required this.orphanPointers, + HashMap? familyPointers, + }) : familyPointers = familyPointers ?? HashMap() { + _initializeOverrides(overrides); + } + + factory ProviderPointerManager.from( + ProviderContainer parent, + List overrides, { + required ProviderContainer container, + }) { + return ProviderPointerManager( + overrides, + container: container, + // Cloning the parent's pointers, so that we can add new pointers without + // affecting the parent. + // We do so only if an override is present, for performance's sake. + // We have to always clone both types if any override is present because + // of the possibility of providers being overridden transitively. + orphanPointers: overrides.isNotEmpty + ? ProviderDirectory.from(parent._pointerManager.orphanPointers) + : parent._pointerManager.orphanPointers, + + familyPointers: overrides.isNotEmpty + ? HashMap.fromEntries( + parent._pointerManager.familyPointers.entries.map( + (e) { + if (e.key.allTransitiveDependencies == null) return e; + + if (e.value.familyOverride != null) return e; + + return MapEntry(e.key, ProviderDirectory.from(e.value)); + }, + ), + ) + : parent._pointerManager.familyPointers, + ); + } - final ProviderBase origin; - ProviderBase override; final ProviderContainer container; + ProviderDirectory orphanPointers; + final HashMap familyPointers; - /// Whether the [_StateReader] was created on first provider read instead of - /// at the creation of the [ProviderContainer] - final bool isDynamicallyCreated; + /// Creates a local pointer for a [Family], while preserving parent state. + ProviderDirectory _scopeProviderDirectory( + Family? family, { + FamilyOverride? override, + }) { + final pointer = family == null ? orphanPointers : familyPointers[family]; - ProviderElementBase? _element; + ProviderDirectory? newDirectory; + if (pointer != null) { + // The family is already overridden in this container. No need to fork. + // This is purely an optimization. + if (pointer.container == container) return pointer; - ProviderElementBase getElement() => _element ??= _create(); + if (override == null) { + // Fork a parent pointer, to keep its state but allow local modifications. + newDirectory = ProviderDirectory.from(pointer); + } + } - ProviderElementBase _create() { - if (origin == _circularDependencyLock) { - throw CircularDependencyError._(); + // No parent pointer, so we can just create a new one. + newDirectory ??= ProviderDirectory( + container, + familyOverride: override, + ); + + if (family == null) { + orphanPointers = newDirectory; + } else { + familyPointers[family] = newDirectory; } - _circularDependencyLock ??= origin; - try { - final element = override.createElement(container) - .._provider = override - .._origin = origin - ..mount(); - element.getState()!.map( - // ignore: avoid_types_on_closure_parameters - data: (ResultData data) { - for (final observer in container.observers) { - runTernaryGuarded( - observer.didAddProvider, - origin, - data.state, - container, - ); - } - }, - error: (error) { - for (final observer in container.observers) { - runTernaryGuarded( - observer.didAddProvider, - origin, - null, - container, - ); - } - for (final observer in container.observers) { - runQuaternaryGuarded( - observer.providerDidFail, - origin, - error.error, - error.stackTrace, - container, + return newDirectory; + } + + void _initializeOverrides(List overrides) { + for (final override in overrides) { + switch (override) { + case ProviderOverride(): + // Overriding a provider from a family, but not the whole family. + // We don't want to modify the parent's family pointers, + // therefore we need to fork the inherited family pointers. + _scopeProviderDirectory( + override._origin.from, + ).addProviderOverride(override, container); + // TODO: test that scoping a family provider does not impact the parent + // TODO test that scoping a family provider does not impact other non-overridden providers from that family + + case FamilyOverride(): + final overriddenFamily = override.overriddenFamily; + + final previousPointer = familyPointers[overriddenFamily]; + if (previousPointer != null && + previousPointer.container == container && + previousPointer.familyOverride != null) { + throw StateError( + 'Cannot override a family twice within the same container: $overriddenFamily', ); } - }, - ); + + final pointer = _scopeProviderDirectory( + overriddenFamily, + override: override, + ); + + pointer.familyOverride = override; + } + } + } + + /// Whether a provider was inserted at [container] instead of an ancestor. + bool isLocallyMounted(ProviderOrFamily provider) { + // If we are at the root, then providers are always mounted locally. + if (this.container.parent == null) return true; + + ProviderContainer? container; + + switch (provider) { + case ProviderBase(): + container = readPointer(provider)?.container ?? + readDirectory(provider)?.container; + case Family(): + container = familyPointers[provider]?.container; + } + + return container == this.container; + } + + /// Whether a provider has a transitive dependency that is overridden in this container. + bool hasLocallyOverriddenDependency(ProviderOrFamily provider) { + if (container._parent == null) return false; + + final transitiveDependencies = provider.allTransitiveDependencies; + + /// If the provider has no dependencies, it cannot be locally overridden. + if (transitiveDependencies == null) return false; + + for (final dependency in transitiveDependencies) { + if (isLocallyMounted(dependency)) return true; + } + + return false; + } + + /// Initializes a family and returns its pointer. + /// + /// Overridden families, be it directly or transitively, + /// are mounted in the current container. + /// + /// Non-overridden families are mounted in the root container. + ProviderDirectory _mountFamily(Family family) { + final pointer = familyPointers[family]; + + if (pointer != null) { + // We are at the root and the pointer is already here. Nothing to do. + if (container._parent == null) return pointer; + + // The family is already mounted in this container and can't be further down. + // We can just return it. + if (pointer.container == container) return pointer; + } + + return familyPointers.putIfAbsent(family, () { + if (hasLocallyOverriddenDependency(family)) { + // If the provider is overridden, we mount it in this container. + } else if (container._root case final root?) { + // If the provider is not overridden, we mount it in the root container. + // This way, all containers will share the same state. + return root._pointerManager._mountFamily(family); + } + + return ProviderDirectory(container); + }); + } + + ProviderDirectory? readDirectory(ProviderBase provider) { + final from = provider.from; + + if (from == null) { + return orphanPointers; + } else { + return familyPointers[from]; + } + } + + ProviderPointer? readPointer(ProviderBase provider) { + return readDirectory(provider)?.pointers[provider]; + } + + ProviderElementBase? readElement(ProviderBase provider) { + return readPointer(provider)?.element; + } + + ProviderDirectory upsertDirectory(ProviderBase provider) { + final from = provider.from; + + if (from == null) { + return orphanPointers; + } else { + // // TODO debugAddDependency(element, debugDependentSource: debugDependentSource); + return _mountFamily(from); + } + } + + ProviderPointer upsertPointer(ProviderBase provider) { + return upsertDirectory(provider).mount(provider); + } + + ProviderElementBase upsertElement(ProviderBase provider) { + return upsertPointer(provider).element!; + } + + /// Traverse the [ProviderElementBase]s associated with this [ProviderContainer]. + Iterable listProviderPointers() { + return orphanPointers.pointers.values + .where((pointer) => pointer.container == container) + .followedBy( + familyPointers.values + .where((pointer) => pointer.container == container) + .expand((e) => e.pointers.values), + ); + } + + /// Read the [ProviderElement] for a provider, without creating it if it doesn't exist. + Iterable> listFamily(Family family) { + final _familyPointers = familyPointers[family]; + if (_familyPointers == null) return const []; + + return _familyPointers.pointers.values.map((e) { + final element = e.element; + // TODO debugAddDependency(element, debugDependentSource: debugDependentSource); + return element; - } finally { - if (_circularDependencyLock == origin) { - _circularDependencyLock = null; + }).whereNotNull(); + } + + /// Remove a provider from this container. + /// + /// Noop if the provider is from an override or doesn't exist. + /// + /// Returns the associated pointer, even if it was not removed. + ProviderPointer? remove(ProviderBase provider) { + // TODO remove in all containers + + final directory = readDirectory(provider); + if (directory == null) return null; + + final pointer = directory.pointers[provider]; + // If null, nothing to remove. If from an override, must not be removed. + if (pointer == null || pointer.providerOverride != null) { + return pointer; + } + + directory.pointers.remove(provider); + + final from = provider.from; + if (from != null) { + // Cleanup family if empty. + // We do so only if it isn't from an override, as overrides are + // must never be removed. + if (directory.pointers.isEmpty && directory.familyOverride == null) { + familyPointers.remove(from); } } + + return pointer; + } + + @override + String toString() { + final buffer = StringBuffer(); + buffer.writeln('ProviderPointerManager#${shortHash(this)}('); + + buffer.writeln(' container: $container'); + buffer.writeln( + ' orphanPointers: ${orphanPointers.toString().indentAfterFirstLine(2)}', + ); + + buffer.write(' familyPointers: {'); + + for (final entry in familyPointers.entries) { + buffer.write( + '\n ${entry.key}: ${entry.value.toString().indentAfterFirstLine(2)},', + ); + } + if (familyPointers.isNotEmpty) { + buffer.writeln('\n }'); + } else { + buffer.writeln('}'); + } + + buffer.write(')'); + + return buffer.toString(); } } @@ -112,11 +562,6 @@ class ProviderContainer implements Node { ...?observers, if (parent != null) ...parent.observers, ], - _stateReaders = { - if (parent != null) - for (final entry in parent._stateReaders.entries) - if (!entry.value.isDynamicallyCreated) entry.key: entry.value, - }, _root = parent?._root ?? parent { if (parent != null) { if (parent.disposed) { @@ -124,41 +569,15 @@ class ProviderContainer implements Node { 'Cannot create a ProviderContainer that has a disposed parent', ); } - - _overrideForFamily.addAll(parent._overrideForFamily); } - for (final override in overrides) { - if (override is ProviderOverride) { - final previousReader = _stateReaders[override._origin]; - if (previousReader != null && previousReader.container == this) { - // The provider was already overridden in this container. - throw StateError( - 'Cannot override a provider twice within the same container: ${override._origin}', + _pointerManager = parent != null + ? ProviderPointerManager.from(parent, overrides, container: this) + : ProviderPointerManager( + overrides, + container: this, + orphanPointers: ProviderDirectory(this), ); - } - - _overrideForProvider[override._origin] = override._override; - _stateReaders[override._origin] = _StateReader( - origin: override._origin, - override: override._override, - container: this, - isDynamicallyCreated: false, - ); - } else if (override is FamilyOverride) { - final previousOverride = _overrideForFamily[override.overriddenFamily]; - if (previousOverride != null && previousOverride.container == this) { - throw StateError( - 'Cannot override a family twice within the same container: ${override.overriddenFamily}', - ); - } - - _overrideForFamily[override.overriddenFamily] = _FamilyOverrideRef( - override, - this, - ); - } - } // Mutate the parent & global state only at the very end. // This ensures that if an error is thrown, the parent & global state @@ -209,10 +628,12 @@ class ProviderContainer implements Node { /// Do not use in production List get debugChildren => UnmodifiableListView(_children); - final _overrideForProvider = - HashMap, ProviderBase>(); - final _overrideForFamily = HashMap(); - final Map, _StateReader> _stateReaders; + late final ProviderPointerManager _pointerManager; + + // final _overrideForProvider = + // HashMap, ProviderBase>(); + // final _overrideForFamily = HashMap(); + // final Map, _StateReader> _stateReaders; /// The list of observers attached to this container. /// @@ -228,17 +649,6 @@ class ProviderContainer implements Node { /// a [StateError] when attempting to use them. bool _disposed = false; - /// An internal utility for checking if a [ProviderContainer] has a fast - /// path for reading a provider. - /// - /// This should not be used and is an implementation detail of [ProviderContainer]. - /// It could be removed at any time without a major version bump. - @internal - @visibleForTesting - bool hasStateReaderFor(ProviderListenable provider) { - return _stateReaders.containsKey(provider); - } - /// Awaits for providers to rebuild/be disposed and for listeners to be notified. Future pump() async { final a = scheduler.pendingFuture; @@ -270,9 +680,7 @@ class ProviderContainer implements Node { /// {@macro riverpod.exists} bool exists(ProviderBase provider) { - final element = _getOrNull(provider)?._element; - - return element != null; + return _pointerManager.readDirectory(provider)?.pointers[provider] != null; } /// Executes [ProviderElementBase.debugReassemble] on all the providers. @@ -332,20 +740,13 @@ class ProviderContainer implements Node { /// {@macro riverpod.invalidate} void invalidate(ProviderOrFamily provider) { - if (provider is ProviderBase) { - final reader = _getOrNull(provider); - - reader?._element?.invalidateSelf(); - } else { - provider as Family; - - final familyContainer = - _overrideForFamily[provider]?.container ?? _root ?? this; - - for (final stateReader in familyContainer._stateReaders.values) { - if (stateReader.origin.from != provider) continue; - stateReader._element?.invalidateSelf(); - } + switch (provider) { + case ProviderBase(): + _pointerManager.readElement(provider)?.invalidateSelf(); + case Family(): + for (final element in _pointerManager.listFamily(provider)) { + element.invalidateSelf(); + } } } @@ -356,29 +757,13 @@ class ProviderContainer implements Node { } void _disposeProvider(ProviderBase provider) { - final reader = _getOrNull(provider); - // The provider is already disposed, so we don't need to do anything - if (reader == null) return; - - reader._element?.dispose(); + final pointer = _pointerManager.remove(provider); - if (reader.isDynamicallyCreated) { - // Since the StateReader is implicitly created, we don't keep it - // on provider dispose, to avoid memory leak - - void removeStateReaderFrom(ProviderContainer container) { - /// Checking if the reader is the same instance is important, - /// as it is possible that the provider was overridden. - if (container._stateReaders[provider] == reader) { - container._stateReaders.remove(provider); - } - container._children.forEach(removeStateReaderFrom); - } + // The provider is already disposed, so we don't need to do anything + if (pointer == null) return; - removeStateReaderFrom(this); - } else { - reader._element = null; - } + pointer.element?.dispose(); + pointer.element = null; } /// Updates the list of provider overrides. @@ -402,63 +787,61 @@ class ProviderContainer implements Node { 'overrides cannot be removed/added, they can only be updated.', ); - List? unusedOverrides; - assert( - () { - unusedOverrides = [...overrides]; - return true; - }(), - '', - ); - for (final override in overrides) { - if (override is ProviderOverride) { - assert( - () { - unusedOverrides!.remove(override); - return true; - }(), - '', - ); + void debugValidateOverride( + Override? previousOverride, + Type newOverrideType, + ) { + if (previousOverride == null) { + throw AssertionError( + 'Tried to update the override of a provider that was not overridden before', + ); + } assert( - _overrideForProvider[override._origin].runtimeType == - override._override.runtimeType, - 'Replaced the override of type ${_overrideForProvider[override._origin].runtimeType} ' - 'with an override of type ${override._override.runtimeType}, which is different.\n' + previousOverride.runtimeType == newOverrideType, + 'Replaced the override of type ${previousOverride.runtimeType} ' + 'with an override of type $newOverrideType, which is different.\n' 'Changing the kind of override or reordering overrides is not supported.', ); + } - // _stateReaders[origin] cannot be null for overridden providers. - final reader = _stateReaders[override._origin]!; + switch (override) { + case ProviderOverride(): + final pointer = _pointerManager.readPointer(override._origin); - reader.override = - _overrideForProvider[override._origin] = override._override; + if (kDebugMode) { + debugValidateOverride( + pointer?.providerOverride, + override._override.runtimeType, + ); + } - final element = reader._element; - if (element == null) continue; + pointer!.providerOverride = override; - runUnaryGuarded(element.update, override._override); - } else if (override is FamilyOverride) { - assert( - () { - unusedOverrides!.remove(override); - return true; - }(), - '', - ); - // TODO assert family override did not change + final element = pointer.element; + if (element == null) continue; + + runUnaryGuarded(element.update, override._override); + + case FamilyOverride(): + // TODO assert family override did not change + + final pointer = + _pointerManager.familyPointers[override.overriddenFamily]; + + if (kDebugMode) { + debugValidateOverride( + pointer?.familyOverride, override.runtimeType); + } - _overrideForFamily[override.overriddenFamily]!.override = override; + pointer!.familyOverride = override; } } - - assert( - unusedOverrides!.isEmpty, - 'Updated the list of overrides with providers that were not overridden before', - ); } + /// TODO make private + /// TODO remove generic @override ProviderElementBase readProviderElement( ProviderBase provider, @@ -469,35 +852,36 @@ class ProviderContainer implements Node { ); } - final reader = _putIfAbsent(provider); + final element = _pointerManager.upsertElement(provider); - assert( - () { + // Assert that the the provider wouldn't have a more up-to-date value + // if it was locally overridden. + if (kDebugMode && + !_pointerManager.isLocallyMounted(provider) && // Avoid having the assert trigger itself exponentially - if (!_debugVerifyDependenciesAreRespectedEnabled) return true; - - try { - _debugVerifyDependenciesAreRespectedEnabled = false; - - // Check that this containers doesn't have access to an overridden - // dependency of the targeted provider - final targetElement = reader.getElement(); - final visitedDependencies = >{}; - final queue = Queue>(); - targetElement.visitAncestors((e) => queue.add(e.origin)); - - while (queue.isNotEmpty) { - final dependency = queue.removeFirst(); - if (visitedDependencies.add(dependency)) { - final dependencyElement = - readProviderElement(dependency); - - assert( - targetElement.provider != targetElement.origin || - dependencyElement == - targetElement.container - .readProviderElement(dependency), - ''' + !_debugVerifyDependenciesAreRespectedEnabled) { + try { + _debugVerifyDependenciesAreRespectedEnabled = false; + + // Check that this containers doesn't have access to an overridden + // dependency of the targeted provider + final visitedDependencies = >{}; + final queue = Queue>(); + element.visitAncestors((e) => queue.add(e.origin)); + + while (queue.isNotEmpty) { + final dependency = queue.removeFirst(); + if (visitedDependencies.add(dependency)) { + final dependencyElement = readProviderElement( + dependency, + ); + + assert( + element.provider != element.origin || + dependencyElement == + element.container + .readProviderElement(dependency), + ''' Tried to read $provider from a place where one of its dependencies were overridden but the provider is not. To fix this error, you can add $dependency (a) to the "dependencies" of $provider (b) such that we have: @@ -507,159 +891,17 @@ final a = Provider(...); final b = Provider((ref) => ref.watch(a), dependencies: [a]); ``` ''', - ); - - dependencyElement.visitAncestors((e) => queue.add(e.origin)); - } - } - } finally { - _debugVerifyDependenciesAreRespectedEnabled = true; - } - return true; - }(), - '', - ); - - return reader.getElement() as ProviderElementBase; - } - - /// Obtains a [_StateReader] for a provider, but do not create it if it does - /// not exist. - _StateReader? _getOrNull(ProviderBase provider) { - return _stateReaders[provider] ?? - - /// No need to check "parent". We can directly check "root", because - /// if the provider is not in the root, it must have been overridden. - /// In which case, it is guaranteed to be in the current container already. - _root?._getOrNull(provider); - } - - /// Create a [_StateReader] for a provider if it does not exist. - /// If one already exists, returns it. - _StateReader _putIfAbsent(ProviderBase provider) { - final currentReader = _stateReaders[provider]; - if (currentReader != null) return currentReader; - - _StateReader getReader() { - if (provider.from != null) { - // reading a family - - final familyOverrideRef = _overrideForFamily[provider.from]; - if (familyOverrideRef != null) { - // A family was overridden, so we implicitly mount the readers - - if (familyOverrideRef.container._stateReaders.containsKey(provider)) { - return familyOverrideRef.container._stateReaders[provider]!; - } - - void setupOverride({ - required ProviderBase origin, - required ProviderBase override, - }) { - assert( - origin == override || override.dependencies == null, - 'A provider override cannot specify `dependencies`', ); - // setupOverride may be called multiple times on different providers - // of the same family (provider vs provider.modifier), so we use ??= - // to initialize the providers only once - familyOverrideRef.container._stateReaders[origin] ??= _StateReader( - origin: origin, - override: override, - container: familyOverrideRef.container, - isDynamicallyCreated: true, - ); + dependencyElement.visitAncestors((e) => queue.add(e.origin)); } - - final providerOverride = - familyOverrideRef.override.getProviderOverride(provider); - - setupOverride(origin: provider, override: providerOverride); - - // if setupOverride overrode the provider, it was already initialized - // in the code above. Otherwise we initialize it as if it was not overridden - return familyOverrideRef.container._stateReaders[provider] ?? - _StateReader( - origin: provider, - override: provider, - container: familyOverrideRef.container, - isDynamicallyCreated: true, - ); } + } finally { + _debugVerifyDependenciesAreRespectedEnabled = true; } - - final root = _root; - if (root != null) { - // On scoped containers, check for implicit override. - - final dependencies = provider.from?.allTransitiveDependencies ?? - provider.allTransitiveDependencies; - - final containerForDependencyOverride = dependencies - ?.map((dep) { - final reader = _stateReaders[dep]; - if (reader != null) { - return reader.container; - } - final familyOverride = _overrideForFamily[dep]; - return familyOverride?.container; - }) - .where((container) => container != null) - .toList(); - - if (containerForDependencyOverride != null && - containerForDependencyOverride.isNotEmpty) { - // a dependency of the provider was overridden, so the provider is overridden too - - final deepestOverrideContainer = containerForDependencyOverride - .fold(root, (previous, container) { - if (container!.depth > previous.depth) { - return container; - } - return previous; - }); - - /// Insert the StateReader in the container that it belongs to, - /// and import it locally - return deepestOverrideContainer._stateReaders.putIfAbsent(provider, - () { - return _StateReader( - origin: provider, - override: provider, - container: deepestOverrideContainer, - isDynamicallyCreated: true, - ); - }); - } - } - - if (_root?._stateReaders.containsKey(provider) ?? false) { - // For un-overridden providers, it is possible that the provider was - // read in the root ProviderContainer before this container. In which case - // we reuse the existing state instead of creating a new one. - return _root!._stateReaders[provider]!; - } - - // The provider had no existing state and no override, so we're - // mounting it on the root container. - final reader = _StateReader( - origin: provider, - // If a provider did not have an associated StateReader then it is - // guaranteed to not be overridden - override: provider, - container: _root ?? this, - isDynamicallyCreated: true, - ); - - if (_root != null) { - _root._stateReaders[provider] = reader; - } - - return reader; } - return _stateReaders[provider] = getReader(); + return element as ProviderElementBase; } void _dispose({ @@ -706,12 +948,11 @@ final b = Provider((ref) => ref.watch(a), dependencies: [a]); void dispose() => _dispose(updateChildren: true); /// Traverse the [ProviderElementBase]s associated with this [ProviderContainer]. - Iterable> getAllProviderElements() sync* { - for (final reader in _stateReaders.values) { - if (reader._element != null && reader.container == this) { - yield reader._element!; - } - } + Iterable> getAllProviderElements() { + return _pointerManager + .listProviderPointers() + .map((e) => e.element) + .whereNotNull(); } /// Visit all nodes of the graph at most once, from roots to leaves. @@ -724,9 +965,9 @@ final b = Provider((ref) => ref.watch(a), dependencies: [a]); final queue = DoubleLinkedQueue>(); // get providers that don't depend on other providers from this container - for (final reader in _stateReaders.values) { - if (reader.container != this) continue; - final element = reader._element; + for (final pointer in _pointerManager.listProviderPointers()) { + if (pointer.container != this) continue; + final element = pointer.element; if (element == null) continue; var hasAncestorsInContainer = false; @@ -776,6 +1017,9 @@ final b = Provider((ref) => ref.watch(a), dependencies: [a]); ); } } + + @override + String toString() => 'ProviderContainer#${shortHash(this)}()'; } @internal @@ -786,6 +1030,8 @@ extension ProviderContainerTest on ProviderContainer { ProviderContainer? get parent => _parent; List get children => _children; + + ProviderPointerManager get pointerManager => _pointerManager; } /// An object that listens to the changes of a [ProviderContainer]. @@ -869,7 +1115,7 @@ class ProviderOverride implements Override { /// of a provider/family for part of the application. /// /// Do not extend or implement. -abstract class Override {} +sealed class Override {} /// An error thrown when a call to [Ref.read]/[Ref.watch] /// leads to a provider depending on itself. diff --git a/packages/riverpod/pubspec.yaml b/packages/riverpod/pubspec.yaml index d8408f66e..62892dcfc 100644 --- a/packages/riverpod/pubspec.yaml +++ b/packages/riverpod/pubspec.yaml @@ -10,7 +10,7 @@ funding: - https://github.com/sponsors/rrousselGit/ environment: - sdk: ">=3.2.0 <4.0.0" + sdk: ">=3.3.0-0.0.dev <4.0.0" dependencies: collection: ^1.18.0 diff --git a/packages/riverpod/test/new/framework/provider_container_test.dart b/packages/riverpod/test/new/framework/provider_container_test.dart index 98f9322bc..ce77918e2 100644 --- a/packages/riverpod/test/new/framework/provider_container_test.dart +++ b/packages/riverpod/test/new/framework/provider_container_test.dart @@ -5,12 +5,355 @@ import 'package:test/test.dart'; import '../utils.dart'; +const _sentinel = Object(); + +TypeMatcher isPointer({ + Object? override = _sentinel, + Object? element = _sentinel, + Object? container = _sentinel, +}) { + var matcher = isA(); + + if (override != _sentinel) { + matcher = matcher.having((p) => p.providerOverride, 'override', override); + } + + if (element != _sentinel) { + matcher = matcher.having((p) => p.element, 'element', element); + } + + if (container != _sentinel) { + matcher = matcher.having((p) => p.container, 'container', container); + } + + return matcher; +} + +TypeMatcher isProviderDirectory({ + Object? override = _sentinel, + Object? pointers = _sentinel, + Object? container = _sentinel, +}) { + var matcher = isA(); + + if (override != _sentinel) { + matcher = matcher.having((p) => p.familyOverride, 'override', override); + } + + if (pointers != _sentinel) { + matcher = matcher.having((p) => p.pointers, 'pointers', pointers); + } + + if (container != _sentinel) { + matcher = matcher.having((p) => p.container, 'container', container); + } + + return matcher; +} + void main() { tearDown(() { // Verifies that there is no container leak. expect(DebugRiverpodDevtoolBiding.containers, isEmpty); }); + group('ProviderPointerManager', () { + group('hasLocallyOverriddenDependency', () { + final a = Provider((_) => 0); + final b = Provider.family((_, __) => 0); + final c = Provider.family((_, __) => 0)(42); + + test('returns true if in the root container', () { + final container = ProviderContainer.test(); + + expect(container.pointerManager.isLocallyMounted(a), true); + expect(container.pointerManager.isLocallyMounted(b), true); + expect(container.pointerManager.isLocallyMounted(c), true); + }); + + test('returns false if the provider is not mounted', () { + final root = ProviderContainer.test(); + final container = ProviderContainer.test(parent: root); + + expect(container.pointerManager.isLocallyMounted(a), false); + expect(container.pointerManager.isLocallyMounted(b), false); + expect(container.pointerManager.isLocallyMounted(c), false); + }); + + test('returns false if mounted but in a different container', () { + final root = ProviderContainer.test(); + + root.read(a); + root.read(b(21)); + root.read(c); + + // Creating after reads, to inherit elements from root + final container = ProviderContainer.test(parent: root); + + expect(container.pointerManager.isLocallyMounted(a), false); + expect(container.pointerManager.isLocallyMounted(b), false); + expect(container.pointerManager.isLocallyMounted(c), false); + }); + + test('returns true if mounted in the same container', () { + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [ + a.overrideWithValue(42), + b.overrideWith((ref, args) => 0), + c.overrideWithValue(42), + ], + ); + + expect(container.pointerManager.isLocallyMounted(a), true); + expect(container.pointerManager.isLocallyMounted(b), true); + expect(container.pointerManager.isLocallyMounted(b(21)), true); + expect(container.pointerManager.isLocallyMounted(c), true); + }); + }); + + group('hasLocallyOverriddenDependency', () { + final dependency = Provider((_) => 0); + final transitiveDependency = Provider((_) => 0); + + final a = Provider( + (_) => 0, + dependencies: [dependency, transitiveDependency], + ); + + test('always returns false if has no dependency', () { + final provider = Provider((_) => 0); + final root = ProviderContainer.test(); + final container = ProviderContainer.test(parent: root); + + expect( + container.pointerManager.hasLocallyOverriddenDependency(provider), + false, + ); + }); + + test('returns false if the root container', () { + final root = ProviderContainer.test( + overrides: [ + dependency.overrideWithValue(42), + ], + ); + + expect( + root.pointerManager.hasLocallyOverriddenDependency(a), + false, + ); + }); + + test( + 'returns true in a scoped container with overridden direct dependency', + () { + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [ + dependency.overrideWithValue(42), + ], + ); + + expect( + container.pointerManager.hasLocallyOverriddenDependency(a), + true, + ); + }); + + test( + 'returns true in a scoped container with overridden transitive dependency', + () { + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [ + transitiveDependency.overrideWithValue(42), + ], + ); + + expect( + container.pointerManager.hasLocallyOverriddenDependency(a), + true, + ); + }); + }); + + group('upsertDirectory', () { + test('on orphan with a family dependency, forks the directory', () { + final dependency = Provider.family((ref, id) => 0); + final provider = Provider((ref) => 0, dependencies: [dependency]); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [ + dependency.overrideWith((ref, arg) => 0), + ], + ); + + expect( + container.pointerManager.orphanPointers, + same(root.pointerManager.orphanPointers), + ); + + final directory = container.pointerManager.upsertDirectory(provider); + + expect( + container.pointerManager.orphanPointers, + isNot(root.pointerManager.orphanPointers), + ); + expect(container.pointerManager.orphanPointers, directory); + + expect( + directory, + isProviderDirectory( + container: root, + override: null, + pointers: { + dependency(42): isPointer( + container: container, + override: null, + element: null, + ), + }, + ), + ); + }); + + test( + 'on family with orphan dependency, forks the directory', + () {}, + skip: 'TODO', + ); + + test('on orphans, return orphanPointers', () { + final provider = Provider((_) => 0); + final container = ProviderContainer.test(); + + final directory = container.pointerManager.upsertDirectory(provider); + + expect(container.pointerManager.orphanPointers, directory); + + expect( + directory, + isProviderDirectory( + container: container, + override: null, + pointers: isEmpty, + ), + ); + }); + + test('on families, adds a new directory if not already present', () { + final provider = Provider.family((ref, _) => 0); + final container = ProviderContainer.test(); + + final directory = container.pointerManager.upsertDirectory( + provider(42), + ); + + expect( + container.pointerManager.familyPointers, + {provider: directory}, + ); + + expect( + directory, + isProviderDirectory( + container: container, + override: null, + pointers: isEmpty, + ), + ); + }); + + test('returns existing directory if called twice', () { + final provider = Provider.family((ref, _) => 0); + final container = ProviderContainer.test(); + + final directory = + container.pointerManager.upsertDirectory(provider(42)); + final directory2 = + container.pointerManager.upsertDirectory(provider(42)); + + expect(directory2, same(directory)); + }); + + test('returns override directory if present', () { + final provider = Provider.family((ref, _) => 0); + + final container = ProviderContainer.test( + overrides: [provider.overrideWith((ref, arg) => 0)], + ); + + final overrideDir = container.pointerManager.familyPointers[provider]!; + + final directory = container.pointerManager.upsertDirectory( + provider(42), + ); + + expect(directory, same(overrideDir)); + + expect( + directory, + isProviderDirectory( + container: container, + override: isNotNull, + pointers: isEmpty, + ), + ); + }); + }); + + group('upsertPointer', () { + test('on orphans, insert in orphanPointers', () { + final provider = Provider((_) => 0); + final container = ProviderContainer.test(); + + final pointer = container.pointerManager.upsertPointer(provider); + + expect( + container.pointerManager.orphanPointers.pointers, + {provider: pointer}, + ); + + expect( + pointer, + isPointer( + container: container, + override: null, + element: isNotNull, + ), + ); + }); + + test('on families, adds a new pointer if not already present', () { + final provider = Provider.family((ref, _) => 0); + final container = ProviderContainer.test(); + + final pointer = container.pointerManager.upsertPointer( + provider(42), + ); + + expect( + container.pointerManager.familyPointers[provider]!.pointers, + {provider(42): pointer}, + ); + + expect( + pointer, + isPointer( + container: container, + override: null, + element: isNotNull, + ), + ); + }); + }); + }); + group('ProviderContainer', () { group('constructor', () { test('registers itself in the container list', () { @@ -134,6 +477,371 @@ void main() { ); addTearDown(container.dispose); }); + + test( + 'supports overriding a provider from a family, and then the family', + () { + final family = Provider.family((ref, id) => 0); + final root = ProviderContainer( + overrides: [ + family(42).overrideWithValue(42), + family.overrideWith((ref, arg) => arg), + ], + ); + addTearDown(root.dispose); + }); + }); + }); + + group('pointers', () { + test('has "container" pointing to "this"', () { + final root = ProviderContainer.test(); + final container = ProviderContainer.test(parent: root); + + expect(root.pointerManager.container, root); + expect(container.pointerManager.container, container); + }); + + group('at the root, ', () { + test('orphansPointers.container points to the root', () { + final root = ProviderContainer.test(); + + expect(root.pointerManager.orphanPointers.container, root); + }); + }); + + group('on scoped containers', () { + test('reuses orphanPointers instance if there are no orphan overrides', + () { + final family = Provider.family((ref, id) => 0); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [ + family.overrideWith((ref, arg) => arg), + family(42).overrideWith((ref) => 42), + ], + ); + + expect( + container.pointerManager.orphanPointers, + same(root.pointerManager.orphanPointers), + ); + + expect( + container.pointerManager.familyPointers, + isNot(root.pointerManager.familyPointers), + ); + }); + + test('reuses familyPointers instance if there are no family overrides', + () { + final provider = Provider((_) => 0); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [provider.overrideWith((ref) => 0)], + ); + + expect( + container.pointerManager.familyPointers, + same(root.pointerManager.familyPointers), + ); + + expect( + container.pointerManager.orphanPointers, + isNot(root.pointerManager.orphanPointers), + ); + }); + + test('inherits overrides from its parents', () { + final a = Provider((_) => 0); + final aOverride = a.overrideWithValue(1); + final b = Provider((_) => 0); + final bOverride = b.overrideWithValue(2); + final c = Provider((_) => 0); + final cOverride = c.overrideWithValue(3); + final aFamily = Provider.family((_, __) => 0); + final aFamilyOverride = aFamily.overrideWith((_, __) => 1); + final aValueOverride = aFamily(42).overrideWith((_) => 2); + final bFamily = Provider.family((_, __) => 0); + final bFamilyOverride = bFamily.overrideWith((_, __) => 2); + final bValueOverride = bFamily(42).overrideWith((_) => 3); + final cFamily = Provider.family((_, __) => 0); + final cFamilyOverride = cFamily.overrideWith((_, __) => 3); + final cValueOverride = cFamily(42).overrideWith((_) => 4); + + final root = ProviderContainer.test( + overrides: [aOverride, aFamilyOverride, aValueOverride], + ); + final mid = ProviderContainer.test( + parent: root, + overrides: [bOverride, bFamilyOverride, bValueOverride], + ); + final container = ProviderContainer.test( + parent: mid, + overrides: [cOverride, cFamilyOverride, cValueOverride], + ); + + expect( + container.pointerManager.familyPointers, + { + aFamily: isProviderDirectory( + override: aFamilyOverride, + container: root, + pointers: { + aFamily(42): isPointer( + override: aValueOverride, + container: root, + element: null, + ), + }, + ), + bFamily: isProviderDirectory( + override: bFamilyOverride, + container: mid, + pointers: { + bFamily(42): isPointer( + override: bValueOverride, + container: mid, + element: null, + ), + }, + ), + cFamily: isProviderDirectory( + override: cFamilyOverride, + container: container, + pointers: { + cFamily(42): isPointer( + override: cValueOverride, + container: container, + element: null, + ), + }, + ), + }, + ); + + expect( + container.pointerManager.orphanPointers, + isProviderDirectory( + container: root, + override: null, + pointers: { + a: isPointer( + override: aOverride, + container: root, + element: null, + ), + b: isPointer( + override: bOverride, + container: mid, + element: null, + ), + c: isPointer( + override: cOverride, + container: container, + element: null, + ), + }, + ), + ); + }); + + test('with no overrides, uses an identical content as its parent', () { + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( + parent: root, + overrides: [Provider((_) => 0)], + ); + final container = ProviderContainer.test(parent: mid); + final container2 = ProviderContainer.test(parent: mid, overrides: []); + + expect( + container.pointerManager.orphanPointers, + same(mid.pointerManager.orphanPointers), + ); + expect( + container.pointerManager.familyPointers, + same(mid.pointerManager.familyPointers), + ); + + expect( + container2.pointerManager.familyPointers, + same(mid.pointerManager.familyPointers), + ); + expect( + container2.pointerManager.orphanPointers, + same(mid.pointerManager.orphanPointers), + ); + }); + + test('orphanPointers.container is always equal to root', () { + final root = ProviderContainer.test(); + final provider = Provider((_) => 0); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); + + expect(root.pointerManager.orphanPointers.container, root); + expect(container.pointerManager.orphanPointers.container, root); + + expect( + container.pointerManager.orphanPointers.pointers, + { + provider: isPointer( + container: container, + override: provider, + element: null, + ), + }, + ); + }); + }); + + test('adds non-family provider overrides to orphanPointers', () { + final provider = Provider((_) => 0); + final override = provider.overrideWithValue(42); + final root = ProviderContainer.test( + overrides: [override], + ); + final root2 = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root2, + overrides: [override], + ); + + expect( + root.pointerManager.orphanPointers, + isProviderDirectory( + container: root, + override: null, + pointers: { + provider: isPointer( + container: root, + override: override, + element: null, + ), + }, + ), + ); + + expect( + root2.pointerManager.orphanPointers.pointers, + isEmpty, + ); + expect( + container.pointerManager.orphanPointers, + isProviderDirectory( + container: root2, + override: null, + pointers: { + provider: isPointer( + container: container, + override: override, + element: null, + ), + }, + ), + ); + }); + + test('adds family overrides to familyPointers', () { + final provider = Provider.family((ref, _) => 0); + final override = provider.overrideWith((ref, arg) => 0); + final root = ProviderContainer.test( + overrides: [override], + ); + final root2 = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root2, + overrides: [override], + ); + + expect( + root.pointerManager.familyPointers, + { + provider: isProviderDirectory( + override: override, + container: root, + pointers: isEmpty, + ), + }, + ); + + expect( + root2.pointerManager.familyPointers, + isEmpty, + ); + expect( + container.pointerManager.familyPointers, + { + provider: isProviderDirectory( + override: override, + container: container, + pointers: isEmpty, + ), + }, + ); + }); + + test('adds family provider overrides to familyPointers.pointers', () { + final provider = Provider.family((ref, _) => 0); + final override = provider(42).overrideWith((ref) => 0); + final root = ProviderContainer.test( + overrides: [override], + ); + final root2 = ProviderContainer.test(); + + final container = ProviderContainer.test( + parent: root2, + overrides: [override], + ); + + expect( + root.pointerManager.familyPointers, + { + provider: isProviderDirectory( + override: null, + container: root, + pointers: { + provider(42): isPointer( + container: root, + override: override, + element: null, + ), + }, + ), + }, + ); + + expect( + container.pointerManager.familyPointers, + isNot(root2.pointerManager.familyPointers), + ); + + expect( + root2.pointerManager.familyPointers, + isEmpty, + ); + + expect( + container.pointerManager.familyPointers, + { + provider: isProviderDirectory( + override: null, + container: container, + pointers: { + provider(42): isPointer( + container: container, + override: override, + element: null, + ), + }, + ), + }, + ); }); }); From b451b050ed89c7d3014c8dfa05b6be8a3a959ea9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 17 Dec 2023 12:35:29 +0100 Subject: [PATCH 070/387] W --- examples/pub/lib/detail.g.dart | 12 +- examples/pub/lib/search.g.dart | 6 +- .../auto_dispose.dart | 2 +- .../src/change_notifier_provider/base.dart | 8 +- packages/riverpod/lib/src/async_notifier.dart | 2 +- .../lib/src/async_notifier/auto_dispose.dart | 3 +- .../riverpod/lib/src/async_notifier/base.dart | 9 +- .../lib/src/async_notifier/family.dart | 7 +- packages/riverpod/lib/src/framework.dart | 3 +- .../lib/src/framework/always_alive.dart | 38 -- .../lib/src/framework/async_selector.dart | 51 ++- .../riverpod/lib/src/framework/element.dart | 13 +- .../riverpod/lib/src/framework/family.dart | 40 +-- .../riverpod/lib/src/framework/override.dart | 127 +++++++ .../lib/src/framework/provider_base.dart | 12 +- .../lib/src/framework/provider_container.dart | 327 +++++++++--------- .../framework/proxy_provider_listenable.dart | 19 +- packages/riverpod/lib/src/framework/ref.dart | 4 +- .../riverpod/lib/src/framework/selector.dart | 10 - .../lib/src/framework/value_provider.dart | 5 +- .../riverpod/lib/src/future_provider.dart | 24 +- .../lib/src/future_provider/auto_dispose.dart | 2 +- .../lib/src/future_provider/base.dart | 7 +- .../lib/src/notifier/auto_dispose.dart | 2 +- packages/riverpod/lib/src/notifier/base.dart | 7 +- .../riverpod/lib/src/notifier/family.dart | 5 +- .../lib/src/provider/auto_dispose.dart | 2 +- packages/riverpod/lib/src/provider/base.dart | 5 +- .../state_notifier_provider/auto_dispose.dart | 2 +- .../lib/src/state_notifier_provider/base.dart | 7 +- .../lib/src/state_provider/auto_dispose.dart | 2 +- .../riverpod/lib/src/state_provider/base.dart | 8 +- .../riverpod/lib/src/stream_notifier.dart | 2 +- .../lib/src/stream_notifier/auto_dispose.dart | 3 +- .../lib/src/stream_notifier/base.dart | 9 +- .../lib/src/stream_notifier/family.dart | 7 +- .../riverpod/lib/src/stream_provider.dart | 5 +- .../lib/src/stream_provider/auto_dispose.dart | 2 +- .../lib/src/stream_provider/base.dart | 7 +- .../framework/provider_container_test.dart | 11 +- .../integration/build_yaml/lib/main.g.dart | 36 +- .../test/integration/annotated.g.dart | 12 +- .../test/integration/async.g.dart | 36 +- .../test/integration/dependencies.g.dart | 18 +- .../test/integration/dependencies2.g.dart | 13 +- .../test/integration/generated.g.dart | 42 +-- .../test/integration/stream.g.dart | 24 +- .../test/integration/sync.g.dart | 54 +-- .../generated/golden/lib/sync.g.dart | 12 +- ..._class_based_provider_to_functional.g.dart | 12 +- ..._functional_provider_to_class_based.g.dart | 6 +- .../avoid_build_context_in_providers.g.dart | 12 +- .../avoid_public_notifier_properties.g.dart | 6 +- .../test/lints/dependencies.g.dart | 12 +- .../functional_ref/functional_ref.g.dart | 24 +- .../protected_notifier_properties.g.dart | 36 +- .../test/lints/provider_parameters.g.dart | 6 +- .../docs/concepts/about_codegen/main.g.dart | 6 +- .../about_codegen/provider_type/family.g.dart | 6 +- .../provider_type/family_class.g.dart | 6 +- .../provider_type/family_fn.g.dart | 6 +- .../invalidate_family_example/codegen.g.dart | 6 +- .../passing_args/codegen/family.g.dart | 6 +- .../passing_args/codegen/provider.g.dart | 6 +- .../docs/from_provider/family/family.g.dart | 6 +- .../introduction/why_riverpod/codegen.g.dart | 6 +- .../family_and_dispose.g.dart | 6 +- .../current/about_codegen/main.g.dart | 6 +- .../current/about_codegen/main.g.dart | 6 +- .../current/about_codegen/main.g.dart | 6 +- .../current/about_codegen/main.g.dart | 6 +- 71 files changed, 617 insertions(+), 645 deletions(-) delete mode 100644 packages/riverpod/lib/src/framework/always_alive.dart create mode 100644 packages/riverpod/lib/src/framework/override.dart diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index f64de6736..b6193e30b 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -82,12 +82,12 @@ class FetchPackageDetailsFamily extends Family { } class _$FetchPackageDetailsFamilyOverride implements FamilyOverride { - _$FetchPackageDetailsFamilyOverride(this.overriddenFamily, this.create); + _$FetchPackageDetailsFamilyOverride(this.from, this.create); final FutureOr Function(FetchPackageDetailsRef ref) create; @override - final FetchPackageDetailsFamily overriddenFamily; + final FetchPackageDetailsFamily from; @override FetchPackageDetailsProvider getProviderOverride( @@ -137,7 +137,7 @@ class FetchPackageDetailsProvider extends AutoDisposeFutureProvider { ) { return ProviderOverride( origin: this, - override: FetchPackageDetailsProvider._internal( + providerOverride: FetchPackageDetailsProvider._internal( (ref) => create(ref as FetchPackageDetailsRef), from: from, name: null, @@ -320,12 +320,12 @@ class PackageMetricsFamily extends Family { } class _$PackageMetricsFamilyOverride implements FamilyOverride { - _$PackageMetricsFamilyOverride(this.overriddenFamily, this.create); + _$PackageMetricsFamilyOverride(this.from, this.create); final PackageMetrics Function() create; @override - final PackageMetricsFamily overriddenFamily; + final PackageMetricsFamily from; @override PackageMetricsProvider getProviderOverride( @@ -392,7 +392,7 @@ class PackageMetricsProvider extends AutoDisposeAsyncNotifierProviderImpl< Override overrideWith(PackageMetrics Function() create) { return ProviderOverride( origin: this, - override: PackageMetricsProvider._internal( + providerOverride: PackageMetricsProvider._internal( () => create()..packageName = packageName, from: from, name: null, diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 8a5637280..4822a451d 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -84,12 +84,12 @@ class FetchPackagesFamily extends Family { } class _$FetchPackagesFamilyOverride implements FamilyOverride { - _$FetchPackagesFamilyOverride(this.overriddenFamily, this.create); + _$FetchPackagesFamilyOverride(this.from, this.create); final FutureOr> Function(FetchPackagesRef ref) create; @override - final FetchPackagesFamily overriddenFamily; + final FetchPackagesFamily from; @override FetchPackagesProvider getProviderOverride( @@ -144,7 +144,7 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { ) { return ProviderOverride( origin: this, - override: FetchPackagesProvider._internal( + providerOverride: FetchPackagesProvider._internal( (ref) => create(ref as FetchPackagesRef), from: from, name: null, diff --git a/packages/flutter_riverpod/lib/src/change_notifier_provider/auto_dispose.dart b/packages/flutter_riverpod/lib/src/change_notifier_provider/auto_dispose.dart index 3fdb3640f..233133783 100644 --- a/packages/flutter_riverpod/lib/src/change_notifier_provider/auto_dispose.dart +++ b/packages/flutter_riverpod/lib/src/change_notifier_provider/auto_dispose.dart @@ -67,7 +67,7 @@ class AutoDisposeChangeNotifierProvider ) { return ProviderOverride( origin: this, - override: AutoDisposeChangeNotifierProvider.internal( + providerOverride: AutoDisposeChangeNotifierProvider.internal( create, from: from, argument: argument, diff --git a/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart b/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart index 617b69cea..39bc9af29 100644 --- a/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart +++ b/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart @@ -73,8 +73,7 @@ abstract class ChangeNotifierProviderRef /// ``` /// {@endtemplate} class ChangeNotifierProvider - extends _ChangeNotifierProviderBase - with AlwaysAliveProviderBase { + extends _ChangeNotifierProviderBase { /// {@macro riverpod.change_notifier_provider} ChangeNotifierProvider( this._createFn, { @@ -121,8 +120,7 @@ class ChangeNotifierProvider } @override - late final AlwaysAliveRefreshable notifier = - _notifier(this); + late final Refreshable notifier = _notifier(this); /// {@template riverpod.override_with} /// Override the provider with a new initialization function. @@ -163,7 +161,7 @@ class ChangeNotifierProvider ) { return ProviderOverride( origin: this, - override: ChangeNotifierProvider.internal( + providerOverride: ChangeNotifierProvider.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/async_notifier.dart b/packages/riverpod/lib/src/async_notifier.dart index 6a4e62e45..06118c071 100644 --- a/packages/riverpod/lib/src/async_notifier.dart +++ b/packages/riverpod/lib/src/async_notifier.dart @@ -172,7 +172,7 @@ ProviderElementProxy, Future> _asyncFuture( @visibleForTesting @internal abstract class AsyncNotifierProviderBase, - T> extends ProviderBase> { + T> extends ProviderBase> with AsyncSelector { /// A base class for [AsyncNotifierProvider] /// /// Not meant for public consumption diff --git a/packages/riverpod/lib/src/async_notifier/auto_dispose.dart b/packages/riverpod/lib/src/async_notifier/auto_dispose.dart index 9e9b249c9..7aecaeaf8 100644 --- a/packages/riverpod/lib/src/async_notifier/auto_dispose.dart +++ b/packages/riverpod/lib/src/async_notifier/auto_dispose.dart @@ -112,7 +112,8 @@ class AutoDisposeAsyncNotifierProviderImpl< Override overrideWith(NotifierT Function() create) { return ProviderOverride( origin: this, - override: AutoDisposeAsyncNotifierProviderImpl.internal( + providerOverride: + AutoDisposeAsyncNotifierProviderImpl.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/async_notifier/base.dart b/packages/riverpod/lib/src/async_notifier/base.dart index fa8274c00..9c2677693 100644 --- a/packages/riverpod/lib/src/async_notifier/base.dart +++ b/packages/riverpod/lib/src/async_notifier/base.dart @@ -93,8 +93,7 @@ typedef AsyncNotifierProvider, T> @visibleForTesting @internal class AsyncNotifierProviderImpl, T> - extends AsyncNotifierProviderBase - with AlwaysAliveProviderBase>, AlwaysAliveAsyncSelector { + extends AsyncNotifierProviderBase { /// {@macro riverpod.async_notifier_provider} /// /// {@macro riverpod.async_notifier_provider_modifier} @@ -129,11 +128,11 @@ class AsyncNotifierProviderImpl, T> static const family = AsyncNotifierProviderFamilyBuilder(); @override - late final AlwaysAliveRefreshable notifier = + late final Refreshable notifier = _asyncNotifier(this); @override - late final AlwaysAliveRefreshable> future = _asyncFuture(this); + late final Refreshable> future = _asyncFuture(this); @override AsyncNotifierProviderElement createElement( @@ -153,7 +152,7 @@ class AsyncNotifierProviderImpl, T> Override overrideWith(NotifierT Function() create) { return ProviderOverride( origin: this, - override: AsyncNotifierProviderImpl.internal( + providerOverride: AsyncNotifierProviderImpl.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/async_notifier/family.dart b/packages/riverpod/lib/src/async_notifier/family.dart index 3593db233..6e6404565 100644 --- a/packages/riverpod/lib/src/async_notifier/family.dart +++ b/packages/riverpod/lib/src/async_notifier/family.dart @@ -44,8 +44,7 @@ typedef AsyncNotifierFamilyProvider< @visibleForTesting @internal class FamilyAsyncNotifierProviderImpl, T, - Arg> extends AsyncNotifierProviderBase - with AlwaysAliveProviderBase>, AlwaysAliveAsyncSelector { + Arg> extends AsyncNotifierProviderBase { /// {@macro riverpod.async_notifier_family_provider} FamilyAsyncNotifierProviderImpl( super._createNotifier, { @@ -75,11 +74,11 @@ class FamilyAsyncNotifierProviderImpl, T, static const autoDispose = AutoDisposeAsyncNotifierProviderFamily.new; @override - late final AlwaysAliveRefreshable notifier = + late final Refreshable notifier = _asyncNotifier(this); @override - late final AlwaysAliveRefreshable> future = _asyncFuture(this); + late final Refreshable> future = _asyncFuture(this); @override AsyncNotifierProviderElement createElement( diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index 5b55f28aa..a2a5a69aa 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -5,13 +5,11 @@ import 'dart:collection'; import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; -import 'package:meta/meta.dart' as meta; import 'package:state_notifier/state_notifier.dart'; import 'package:test/test.dart' as test; import 'env.dart'; import 'internals.dart'; -part 'framework/always_alive.dart'; part 'framework/auto_dispose.dart'; part 'framework/async_selector.dart'; part 'framework/provider_base.dart'; @@ -25,4 +23,5 @@ part 'framework/ref.dart'; part 'framework/selector.dart'; part 'framework/scheduler.dart'; part 'framework/value_provider.dart'; +part 'framework/override.dart'; part 'framework/devtool.dart'; diff --git a/packages/riverpod/lib/src/framework/always_alive.dart b/packages/riverpod/lib/src/framework/always_alive.dart deleted file mode 100644 index 26b3e200c..000000000 --- a/packages/riverpod/lib/src/framework/always_alive.dart +++ /dev/null @@ -1,38 +0,0 @@ -part of '../framework.dart'; - -/// A base class for all providers, used to consume a provider. -/// -/// It is used by [ProviderContainer.listen] and [Ref.watch] to listen to -/// both a provider and `provider.select`. -/// -/// Do not implement or extend. -mixin AlwaysAliveProviderListenable on ProviderListenable { - @override - AlwaysAliveProviderListenable select( - Selected Function(State value) selector, - ) { - return _AlwaysAliveProviderSelector( - provider: this, - selector: selector, - ); - } -} - -/// A base class for providers that never dispose themselves. -/// -/// This is the default base class for providers, unless a provider was marked -/// with the `.autoDispose` modifier, like: `Provider.autoDispose(...)` -mixin AlwaysAliveProviderBase on ProviderBase - implements - AlwaysAliveProviderListenable, - AlwaysAliveRefreshable { - @override - AlwaysAliveProviderListenable select( - Selected Function(State value) selector, - ) { - return _AlwaysAliveProviderSelector( - provider: this, - selector: selector, - ); - } -} diff --git a/packages/riverpod/lib/src/framework/async_selector.dart b/packages/riverpod/lib/src/framework/async_selector.dart index 57406e482..8b8bf7346 100644 --- a/packages/riverpod/lib/src/framework/async_selector.dart +++ b/packages/riverpod/lib/src/framework/async_selector.dart @@ -3,7 +3,25 @@ part of '../framework.dart'; /// Adds [selectAsync] to [ProviderListenable] @internal mixin AsyncSelector on ProviderListenable> { - /// The future that [selectAsync] will query + /// Obtains the [Future] associated with a [FutureProvider]. + /// + /// The instance of [Future] obtained may change over time, if the provider + /// was recreated (such as when using [Ref.watch]). + /// + /// This provider allows using `async`/`await` to easily combine + /// [FutureProvider] together: + /// + /// ```dart + /// final configsProvider = FutureProvider((ref) async => Configs()); + /// + /// final productsProvider = FutureProvider((ref) async { + /// // Wait for the configurations to resolve + /// final configs = await ref.watch(configsProvider.future); + /// + /// // Do something with the result + /// return await http.get('${configs.host}/products'); + /// }); + /// ``` Refreshable> get future; /// {@template riverpod.async_select} @@ -38,26 +56,7 @@ mixin AsyncSelector on ProviderListenable> { ProviderListenable> selectAsync( Output Function(Input data) selector, ) { - return _AlwaysAliveAsyncSelector( - selector: selector, - provider: this, - future: future, - ); - } -} - -/// Adds [selectAsync] to [AlwaysAliveProviderListenable] -@internal -mixin AlwaysAliveAsyncSelector - on AlwaysAliveProviderListenable> { - /// The future that [selectAsync] will query - AlwaysAliveRefreshable> get future; - - /// {@macro riverpod.async_select} - AlwaysAliveProviderListenable> selectAsync( - Output Function(Input data) selector, - ) { - return _AlwaysAliveAsyncSelector( + return _AsyncSelector( selector: selector, provider: this, future: future, @@ -65,16 +64,6 @@ mixin AlwaysAliveAsyncSelector } } -class _AlwaysAliveAsyncSelector - extends _AsyncSelector - with AlwaysAliveProviderListenable> { - _AlwaysAliveAsyncSelector({ - required super.provider, - required super.future, - required super.selector, - }); -} - /// An internal class for `ProviderBase.selectAsync`. @sealed class _AsyncSelector with ProviderListenable> { diff --git a/packages/riverpod/lib/src/framework/element.dart b/packages/riverpod/lib/src/framework/element.dart index c172e6c2e..b7a1588a4 100644 --- a/packages/riverpod/lib/src/framework/element.dart +++ b/packages/riverpod/lib/src/framework/element.dart @@ -16,14 +16,11 @@ part of '../framework.dart'; /// ref.watch(provider.select((value) => value)); /// ``` /// {@endtemplate} -abstract class Refreshable implements ProviderListenable { - /// The provider that is being refreshed. - ProviderBase get _origin; -} +sealed class Refreshable implements ProviderListenable {} -/// {@macro riverpod.refreshable} -abstract class AlwaysAliveRefreshable - implements Refreshable, AlwaysAliveProviderListenable {} +mixin _ProviderRefreshable implements Refreshable { + ProviderBase get provider; +} /// A debug utility used by `flutter_riverpod`/`hooks_riverpod` to check /// if it is safe to modify a provider. @@ -632,7 +629,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } assert( - listenable._origin != origin, + listenable != origin, 'A provider cannot depend on itself', ); diff --git a/packages/riverpod/lib/src/framework/family.dart b/packages/riverpod/lib/src/framework/family.dart index 7a7872703..c32f5993a 100644 --- a/packages/riverpod/lib/src/framework/family.dart +++ b/packages/riverpod/lib/src/framework/family.dart @@ -36,10 +36,7 @@ abstract class Family implements FamilyOverride, ProviderOrFamily { const Family(); @override - Family? get from => null; - - @override - Family get overriddenFamily => this; + Family get from => this; } mixin _FamilyMixin> @@ -67,41 +64,6 @@ typedef SetupFamilyOverride = void Function( }), ); -/// Do not use: Internal object to used by [ProviderContainer]/`ProviderScope` -/// to override the behavior of a "family" for part of the application. -@internal -abstract class FamilyOverride implements Override { - /// The family that was overridden. - // TODO make all fields private - Family get overriddenFamily; - - /// Obtains the new behavior for a provider associated to the overridden family. - @visibleForOverriding - ProviderBase getProviderOverride(ProviderBase provider); -} - -/// An [Override] for families -@internal -class FamilyOverrideImpl> - implements FamilyOverride { - /// An [Override] for families - // ignore: library_private_types_in_public_api - FamilyOverrideImpl(this.overriddenFamily, this._newCreate); - - final FamilyProvider Function(Arg arg) _newCreate; - - @override - // ignore: library_private_types_in_public_api - final _FamilyMixin overriddenFamily; - - @visibleForOverriding - @override - ProviderBase getProviderOverride(ProviderBase provider) { - final arg = provider.argument as Arg; - return _newCreate(arg); - } -} - /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. /// diff --git a/packages/riverpod/lib/src/framework/override.dart b/packages/riverpod/lib/src/framework/override.dart new file mode 100644 index 000000000..80c22c36f --- /dev/null +++ b/packages/riverpod/lib/src/framework/override.dart @@ -0,0 +1,127 @@ +part of '../framework.dart'; + +/// An object used by [ProviderContainer]/`ProviderScope` to override the behavior +/// of a provider/family for part of the application. +/// +/// Do not extend or implement. +sealed class Override {} + +/// An object used by [ProviderContainer] to override the behavior of a provider +/// for a part of the application. +/// +/// Do not implement/extend this class. +/// +/// See also: +/// +/// - [ProviderContainer], which uses this object. +/// - `overrideWithValue`, which creates a [ProviderOverride]. +@internal +sealed class ProviderOverride implements Override { + factory ProviderOverride({ + required ProviderBase origin, + required ProviderBase providerOverride, + }) = _ProviderOverrideBase; +} + +class _ProviderOverrideBase implements ProviderOverride { + /// Override a provider + _ProviderOverrideBase({ + required this.origin, + required this.providerOverride, + }); + + /// The provider that is overridden. + final ProviderBase origin; + + /// The new provider behavior. + final ProviderBase providerOverride; +} + +/// When users pass `overrides: [provider]` to a container. +class _ManualScopeProviderOverride implements _ProviderOverrideBase { + _ManualScopeProviderOverride(this.origin); + + @override + final ProviderBase origin; + + @override + ProviderBase get providerOverride => origin; +} + +/// When a provider is automatically scoped due to specifying `dependencies`. +class _TransitiveProviderOverride implements _ProviderOverrideBase { + _TransitiveProviderOverride(this.origin); + + @override + final ProviderBase origin; + + @override + ProviderBase get providerOverride => origin; +} + +extension on ProviderOverride { + /// The provider that is overridden. + ProviderBase get origin { + final that = this; + return switch (that) { + ProviderBase() => that, + _ProviderOverrideBase() => that.origin, + }; + } + + /// The new provider behavior. + ProviderBase get providerOverride { + final that = this; + return switch (that) { + ProviderBase() => that, + _ProviderOverrideBase() => that.providerOverride, + }; + } +} + +/// Do not use: Internal object to used by [ProviderContainer]/`ProviderScope` +/// to override the behavior of a "family" for part of the application. +@internal +abstract class FamilyOverride implements Override { + /// The family that was overridden. + // TODO make all fields private + Family get from; + + /// Obtains the new behavior for a provider associated to the overridden family. + @visibleForOverriding + ProviderBase getProviderOverride(ProviderBase provider); +} + +class _TransitiveFamilyOverride implements FamilyOverride { + _TransitiveFamilyOverride(this.from); + + @override + final Family from; + + @override + ProviderBase getProviderOverride(ProviderBase provider) { + return provider; + } +} + +/// An [Override] for families +@internal +class FamilyOverrideImpl> + implements FamilyOverride { + /// An [Override] for families + // ignore: library_private_types_in_public_api + FamilyOverrideImpl(this.from, this._newCreate); + + final FamilyProvider Function(Arg arg) _newCreate; + + @override + // ignore: library_private_types_in_public_api + final _FamilyMixin from; + + @visibleForOverriding + @override + ProviderBase getProviderOverride(ProviderBase provider) { + final arg = provider.argument as Arg; + return _newCreate(arg); + } +} diff --git a/packages/riverpod/lib/src/framework/provider_base.dart b/packages/riverpod/lib/src/framework/provider_base.dart index 49b692055..bb70dcc93 100644 --- a/packages/riverpod/lib/src/framework/provider_base.dart +++ b/packages/riverpod/lib/src/framework/provider_base.dart @@ -27,7 +27,7 @@ typedef DebugGetCreateSourceHash = String Function(); @immutable abstract class ProviderBase extends ProviderOrFamily with ProviderListenable - implements ProviderOverride, Refreshable { + implements Refreshable, ProviderOverride { /// A base class for _all_ providers. const ProviderBase({ required super.name, @@ -38,14 +38,8 @@ abstract class ProviderBase extends ProviderOrFamily required super.allTransitiveDependencies, }); - @override - ProviderBase get _origin => this; - - @override - ProviderBase get _override => this; - /// {@template riverpod.create_source_hash} - /// A debug-only fucntion for obtaining a hash of the source code of the + /// A debug-only function for obtaining a hash of the source code of the /// initialization function. /// /// If after a hot-reload this function returns a different result, the @@ -244,7 +238,7 @@ mixin OverrideWithValueMixin on ProviderBase { Override overrideWithValue(State value) { return ProviderOverride( origin: this, - override: ValueProvider(value), + providerOverride: ValueProvider(value), ); } } diff --git a/packages/riverpod/lib/src/framework/provider_container.dart b/packages/riverpod/lib/src/framework/provider_container.dart index 98f71071d..9fea2321d 100644 --- a/packages/riverpod/lib/src/framework/provider_container.dart +++ b/packages/riverpod/lib/src/framework/provider_container.dart @@ -10,12 +10,21 @@ extension on String { ProviderBase? _circularDependencyLock; abstract class _PointerBase { - ProviderContainer get container; + /// The container in which the element of this provider will be mounted. + ProviderContainer get mountedContainer; + + /// The container that owns this pointer. + /// May be equal to [mountedContainer] or one of its children. + ProviderContainer get ownerContainer; } @internal class ProviderPointer implements _PointerBase { - ProviderPointer(this.container, {required this.providerOverride}); + ProviderPointer({ + required this.providerOverride, + required this.mountedContainer, + required this.ownerContainer, + }); /// The override associated with this provider, if any. /// @@ -25,14 +34,16 @@ class ProviderPointer implements _PointerBase { ProviderOverride? providerOverride; ProviderElementBase? element; @override - final ProviderContainer container; + final ProviderContainer mountedContainer; + @override + final ProviderContainer ownerContainer; @override String toString() { final buffer = StringBuffer(); buffer.writeln('ProviderPointer$hashCode('); - buffer.writeln(' container: $container'); + buffer.writeln(' container: $mountedContainer'); buffer.writeln(' override: $providerOverride'); buffer.writeln(' element: $element'); @@ -42,50 +53,59 @@ class ProviderPointer implements _PointerBase { } } -PointerT _upsert( - ProviderContainer container, - Map pointers, - ProviderOrFamily provider, { - required PointerT Function() useRoot, - required PointerT Function(OverrideT) create, -}) { - // We are not at the root and the provider can't be scoped. - // Let's just return the root's pointer. - if (provider.allTransitiveDependencies == null && container._parent != null) { - // If the provider can't be scoped, we mount it in the root container directly. - return useRoot(); - } - - final pointer = pointers[provider]; - if (pointer != null) { - // We are at the root and the pointer is already here. Nothing to do. - if (container._parent == null) return pointer; +extension + on Map { + /// - [currentContainer]: The container trying to read this pointer. + PointerT _upsert( + ProviderT provider, { + required ProviderContainer currentContainer, + required PointerT Function(ProviderContainer) inherit, + required PointerT Function({ProviderT? override}) scope, + }) { + final pointer = this[provider]; - // The provider is already mounted in this container and can't be further down. - // We can just return it. - if (pointer.container == container) return pointer; + if (pointer != null) { + if (provider.allTransitiveDependencies == null) { + // The provider is not scoped, so can never be transitively overridden + return pointer; + } + if (pointer.mountedContainer == currentContainer) { + // The pointer isn't inherited but rather local to the current container, + // so no need to check for transitive overrides. + return pointer; + } + } - if (!container._pointerManager.hasLocallyOverriddenDependency(provider)) { - // The provider is not overridden, so we can just return the pointer. - return pointer; + if (currentContainer._pointerManager + .hasLocallyOverriddenDependency(provider)) { + return scope(override: provider); } - } - return create(); + return inherit( + /// If scoped, mount in the scope. + pointer?.mountedContainer ?? + // If not scoped and in a child container, mount in the root + currentContainer._root ?? + // We are in the root, mount here directly + currentContainer, + ); + } } @internal class ProviderDirectory implements _PointerBase { - ProviderDirectory( - this.container, { + ProviderDirectory.empty( + ProviderContainer container, { required this.familyOverride, - HashMap, ProviderPointer>? pointers, - }) : pointers = pointers ?? HashMap(); + }) : pointers = HashMap(), + mountedContainer = container, + ownerContainer = container; ProviderDirectory.from( - ProviderDirectory pointer, - ) : familyOverride = pointer.familyOverride, - container = pointer.container, + ProviderDirectory pointer, { + required this.ownerContainer, + }) : familyOverride = pointer.familyOverride, + mountedContainer = pointer.mountedContainer, pointers = HashMap.fromEntries( pointer.pointers.entries.where((e) { if (e.key.allTransitiveDependencies == null) return true; @@ -103,26 +123,27 @@ class ProviderDirectory implements _PointerBase { FamilyOverride? familyOverride; final HashMap, ProviderPointer> pointers; @override - final ProviderContainer container; + final ProviderContainer mountedContainer; + @override + final ProviderContainer ownerContainer; void addProviderOverride( ProviderOverride override, - ProviderContainer target, ) { - final origin = override._origin; + final origin = override.origin; final previousPointer = pointers[origin]; - // The provider wasn't overridden yet, so we can just add it - if (previousPointer == null || previousPointer.container != target) { - pointers[origin] = ProviderPointer( - target, - providerOverride: override, + if (previousPointer != null && + previousPointer.ownerContainer == ownerContainer) { + throw StateError( + 'Cannot override a provider twice within the same container: $origin', ); - return; } - throw StateError( - 'Cannot override a provider twice within the same container: $origin', + pointers[origin] = ProviderPointer( + mountedContainer: ownerContainer, + ownerContainer: ownerContainer, + providerOverride: override, ); } @@ -130,43 +151,18 @@ class ProviderDirectory implements _PointerBase { // TODO changelog that provider which don't specify depencies can't be scoped // TODO throw if a provider is overridden but does not specify dependencies - return _upsert( - container, - pointers, + return pointers._upsert( provider, - useRoot: () => container._root!._pointerManager.upsertPointer(provider), - create: () => ProviderPointer(container), + currentContainer: ownerContainer, + inherit: (target) => target._pointerManager.upsertPointer(provider), + scope: ({override}) => ProviderPointer( + mountedContainer: ownerContainer, + ownerContainer: ownerContainer, + providerOverride: override == null // + ? null + : _TransitiveProviderOverride(override), + ), ); - - // // We are not at the root and the provider can't be scoped. - // // Let's just return the root's pointer. - // if (provider.allTransitiveDependencies == null && - // container.parent != null) { - // // If the provider can't be scoped, we mount it in the root container directly. - // return container._root!._pointerManager.upsertPointer(provider); - // } - - // final pointer = pointers[provider]; - // if (pointer != null) { - // // We are at the root and the pointer is already here. Nothing to do. - // if (container._parent == null) return pointer; - - // // The provider is already mounted in this container and can't be further down. - // // We can just return it. - // if (pointer.container == container) return pointer; - // } - - // return pointers.putIfAbsent(provider, () { - // if (container._pointerManager.hasLocallyOverriddenDependency(provider)) { - // // If the provider is overridden, we mount it in this container. - // } else if (container._root case final root?) { - // // If the provider is not overridden, we mount it in the root container. - // // This way, all containers will share the same state. - // return root._pointerManager.upsertPointer(provider); - // } - - // return ProviderPointer(container); - // }); } /// Initializes a provider and returns its pointer. @@ -179,9 +175,9 @@ class ProviderDirectory implements _PointerBase { final pointer = upsertPointer(provider); if (pointer.element == null) { - final element = provider.createElement(container) + final element = provider.createElement(mountedContainer) // TODO remove - .._provider = pointer.providerOverride?._override ?? provider + .._provider = pointer.providerOverride?.providerOverride ?? provider // TODO remove .._origin = provider // TODO make this optional @@ -198,7 +194,7 @@ class ProviderDirectory implements _PointerBase { final buffer = StringBuffer(); buffer.writeln('ProviderDirectory$hashCode('); - buffer.writeln(' container: $container'); + buffer.writeln(' container: $mountedContainer'); buffer.writeln(' override: $familyOverride'); buffer.write(' pointers: {'); @@ -257,7 +253,10 @@ class ProviderPointerManager { // We have to always clone both types if any override is present because // of the possibility of providers being overridden transitively. orphanPointers: overrides.isNotEmpty - ? ProviderDirectory.from(parent._pointerManager.orphanPointers) + ? ProviderDirectory.from( + parent._pointerManager.orphanPointers, + ownerContainer: container, + ) : parent._pointerManager.orphanPointers, familyPointers: overrides.isNotEmpty @@ -268,7 +267,10 @@ class ProviderPointerManager { if (e.value.familyOverride != null) return e; - return MapEntry(e.key, ProviderDirectory.from(e.value)); + return MapEntry( + e.key, + ProviderDirectory.from(e.value, ownerContainer: container), + ); }, ), ) @@ -291,16 +293,18 @@ class ProviderPointerManager { if (pointer != null) { // The family is already overridden in this container. No need to fork. // This is purely an optimization. - if (pointer.container == container) return pointer; + if (pointer.mountedContainer == container) return pointer; if (override == null) { // Fork a parent pointer, to keep its state but allow local modifications. - newDirectory = ProviderDirectory.from(pointer); + newDirectory = ProviderDirectory.from( + pointer, + ownerContainer: container, + ); } } - // No parent pointer, so we can just create a new one. - newDirectory ??= ProviderDirectory( + newDirectory ??= ProviderDirectory.empty( container, familyOverride: override, ); @@ -314,25 +318,32 @@ class ProviderPointerManager { return newDirectory; } + void _initializeProviderOverride( + ProviderOverride override, + ) { + // Overriding a provider from a family, but not the whole family. + // We don't want to modify the parent's family pointers, + // therefore we need to fork the inherited family pointers. + _scopeProviderDirectory(override.origin.from).addProviderOverride(override); + // TODO: test that scoping a family provider does not impact the parent + // TODO test that scoping a family provider does not impact other non-overridden providers from that family + } + void _initializeOverrides(List overrides) { for (final override in overrides) { switch (override) { + case ProviderBase(): + _initializeProviderOverride( + _ManualScopeProviderOverride(override), + ); case ProviderOverride(): - // Overriding a provider from a family, but not the whole family. - // We don't want to modify the parent's family pointers, - // therefore we need to fork the inherited family pointers. - _scopeProviderDirectory( - override._origin.from, - ).addProviderOverride(override, container); - // TODO: test that scoping a family provider does not impact the parent - // TODO test that scoping a family provider does not impact other non-overridden providers from that family - + _initializeProviderOverride(override); case FamilyOverride(): - final overriddenFamily = override.overriddenFamily; + final overriddenFamily = override.from; final previousPointer = familyPointers[overriddenFamily]; if (previousPointer != null && - previousPointer.container == container && + previousPointer.mountedContainer == container && previousPointer.familyOverride != null) { throw StateError( 'Cannot override a family twice within the same container: $overriddenFamily', @@ -358,10 +369,10 @@ class ProviderPointerManager { switch (provider) { case ProviderBase(): - container = readPointer(provider)?.container ?? - readDirectory(provider)?.container; + container = readPointer(provider)?.mountedContainer ?? + readDirectory(provider)?.mountedContainer; case Family(): - container = familyPointers[provider]?.container; + container = familyPointers[provider]?.mountedContainer; } return container == this.container; @@ -390,28 +401,20 @@ class ProviderPointerManager { /// /// Non-overridden families are mounted in the root container. ProviderDirectory _mountFamily(Family family) { - final pointer = familyPointers[family]; - - if (pointer != null) { - // We are at the root and the pointer is already here. Nothing to do. - if (container._parent == null) return pointer; - - // The family is already mounted in this container and can't be further down. - // We can just return it. - if (pointer.container == container) return pointer; - } - - return familyPointers.putIfAbsent(family, () { - if (hasLocallyOverriddenDependency(family)) { - // If the provider is overridden, we mount it in this container. - } else if (container._root case final root?) { - // If the provider is not overridden, we mount it in the root container. - // This way, all containers will share the same state. - return root._pointerManager._mountFamily(family); - } - - return ProviderDirectory(container); - }); + return familyPointers._upsert( + family, + currentContainer: container, + inherit: (target) => ProviderDirectory.from( + target._pointerManager._mountFamily(family), + ownerContainer: target, + ), + scope: ({override}) => ProviderDirectory.empty( + container, + familyOverride: override == null // + ? null + : _TransitiveFamilyOverride(override), + ), + ); } ProviderDirectory? readDirectory(ProviderBase provider) { @@ -454,10 +457,10 @@ class ProviderPointerManager { /// Traverse the [ProviderElementBase]s associated with this [ProviderContainer]. Iterable listProviderPointers() { return orphanPointers.pointers.values - .where((pointer) => pointer.container == container) + .where((pointer) => pointer.mountedContainer == container) .followedBy( familyPointers.values - .where((pointer) => pointer.container == container) + .where((pointer) => pointer.mountedContainer == container) .expand((e) => e.pointers.values), ); } @@ -576,7 +579,7 @@ class ProviderContainer implements Node { : ProviderPointerManager( overrides, container: this, - orphanPointers: ProviderDirectory(this), + orphanPointers: ProviderDirectory.empty(this, familyOverride: null), ); // Mutate the parent & global state only at the very end. @@ -751,9 +754,19 @@ class ProviderContainer implements Node { } /// {@macro riverpod.refresh} - State refresh(Refreshable provider) { - invalidate(provider._origin); - return read(provider); + StateT refresh(Refreshable refreshable) { + ProviderBase providerToRefresh; + + switch (refreshable) { + case ProviderBase(): + providerToRefresh = refreshable; + case _ProviderRefreshable(:final provider): + providerToRefresh = provider; + // TODO: Handle this case. + } + + invalidate(providerToRefresh); + return read(refreshable); } void _disposeProvider(ProviderBase provider) { @@ -808,12 +821,12 @@ class ProviderContainer implements Node { switch (override) { case ProviderOverride(): - final pointer = _pointerManager.readPointer(override._origin); + final pointer = _pointerManager.readPointer(override.origin); if (kDebugMode) { debugValidateOverride( pointer?.providerOverride, - override._override.runtimeType, + override.providerOverride.runtimeType, ); } @@ -822,17 +835,18 @@ class ProviderContainer implements Node { final element = pointer.element; if (element == null) continue; - runUnaryGuarded(element.update, override._override); + runUnaryGuarded(element.update, override.providerOverride); case FamilyOverride(): // TODO assert family override did not change - final pointer = - _pointerManager.familyPointers[override.overriddenFamily]; + final pointer = _pointerManager.familyPointers[override.from]; if (kDebugMode) { debugValidateOverride( - pointer?.familyOverride, override.runtimeType); + pointer?.familyOverride, + override.runtimeType, + ); } pointer!.familyOverride = override; @@ -966,7 +980,7 @@ final b = Provider((ref) => ref.watch(a), dependencies: [a]); // get providers that don't depend on other providers from this container for (final pointer in _pointerManager.listProviderPointers()) { - if (pointer.container != this) continue; + if (pointer.mountedContainer != this) continue; final element = pointer.element; if (element == null) continue; @@ -1086,37 +1100,6 @@ typedef SetupOverride = void Function({ required ProviderBase override, }); -/// An object used by [ProviderContainer] to override the behavior of a provider -/// for a part of the application. -/// -/// Do not implement/extend this class. -/// -/// See also: -/// -/// - [ProviderContainer], which uses this object. -/// - `overrideWithValue`, which creates a [ProviderOverride]. -@internal -class ProviderOverride implements Override { - /// Override a provider - ProviderOverride({ - required ProviderBase origin, - required ProviderBase override, - }) : _origin = origin, - _override = override; - - /// The provider that is overridden. - final ProviderBase _origin; - - /// The new provider behavior. - final ProviderBase _override; -} - -/// An object used by [ProviderContainer]/`ProviderScope` to override the behavior -/// of a provider/family for part of the application. -/// -/// Do not extend or implement. -sealed class Override {} - /// An error thrown when a call to [Ref.read]/[Ref.watch] /// leads to a provider depending on itself. /// diff --git a/packages/riverpod/lib/src/framework/proxy_provider_listenable.dart b/packages/riverpod/lib/src/framework/proxy_provider_listenable.dart index 14cb2400e..0d3906f54 100644 --- a/packages/riverpod/lib/src/framework/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/framework/proxy_provider_listenable.dart @@ -38,8 +38,10 @@ class _ProxySubscription extends ProviderSubscription { /// This API is not meant for public consumption. @internal class ProviderElementProxy - with ProviderListenable, AlwaysAliveProviderListenable - implements AlwaysAliveRefreshable { + with + ProviderListenable, + ProviderListenable, + _ProviderRefreshable { /// An internal utility for reading alternate values of a provider. /// /// For example, this is used by [FutureProvider] to differentiate: @@ -55,10 +57,10 @@ class ProviderElementProxy /// ``` /// /// This API is not meant for public consumption. - const ProviderElementProxy(this._origin, this._lense); + const ProviderElementProxy(this.provider, this._lense); @override - final ProviderBase _origin; + final ProviderBase provider; final ProxyElementValueNotifier Function( ProviderElementBase element, ) _lense; @@ -71,7 +73,7 @@ class ProviderElementProxy required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, }) { - final element = node.readProviderElement(_origin); + final element = node.readProviderElement(provider); // TODO does this need a "flush"? // element.flush(); @@ -111,7 +113,7 @@ class ProviderElementProxy @override Output read(Node node) { - final element = node.readProviderElement(_origin); + final element = node.readProviderElement(provider); element.flush(); element.mayNeedDispose(); return _lense(element).value; @@ -119,8 +121,9 @@ class ProviderElementProxy @override bool operator ==(Object other) => - other is ProviderElementProxy && other._origin == _origin; + other is ProviderElementProxy && + other.provider == provider; @override - int get hashCode => _origin.hashCode; + int get hashCode => provider.hashCode; } diff --git a/packages/riverpod/lib/src/framework/ref.dart b/packages/riverpod/lib/src/framework/ref.dart index 2a7790b97..bf169ed20 100644 --- a/packages/riverpod/lib/src/framework/ref.dart +++ b/packages/riverpod/lib/src/framework/ref.dart @@ -278,7 +278,7 @@ abstract class Ref { /// - if multiple widgets depends on `sortedTodosProvider` the list will be /// sorted only once. /// - if nothing is listening to `sortedTodosProvider`, then no sort is performed. - T watch(AlwaysAliveProviderListenable provider); + T watch(ProviderListenable provider); /// {@template riverpod.listen} /// Listen to a provider and call [listener] whenever its value changes. @@ -300,7 +300,7 @@ abstract class Ref { /// Instead the listener will receive an [AsyncError]. /// {@endtemplate} ProviderSubscription listen( - AlwaysAliveProviderListenable provider, + ProviderListenable provider, void Function(T? previous, T next) listener, { void Function(Object error, StackTrace stackTrace)? onError, bool fireImmediately, diff --git a/packages/riverpod/lib/src/framework/selector.dart b/packages/riverpod/lib/src/framework/selector.dart index 1aead0b6b..7b4c57cbb 100644 --- a/packages/riverpod/lib/src/framework/selector.dart +++ b/packages/riverpod/lib/src/framework/selector.dart @@ -186,13 +186,3 @@ class _SelectorSubscription return _read(); } } - -class _AlwaysAliveProviderSelector - extends _ProviderSelector - with AlwaysAliveProviderListenable { - /// An internal class for `ProviderBase.select`. - _AlwaysAliveProviderSelector({ - required super.provider, - required super.selector, - }); -} diff --git a/packages/riverpod/lib/src/framework/value_provider.dart b/packages/riverpod/lib/src/framework/value_provider.dart index 048f56019..7e4cee68d 100644 --- a/packages/riverpod/lib/src/framework/value_provider.dart +++ b/packages/riverpod/lib/src/framework/value_provider.dart @@ -5,10 +5,9 @@ part of '../framework.dart'; /// This is an implementation detail of `overrideWithValue`. @sealed @internal -class ValueProvider extends ProviderBase - with AlwaysAliveProviderBase { +class ValueProvider extends ProviderBase { /// Creates a [ValueProvider]. - ValueProvider(this._value) + const ValueProvider(this._value) : super( name: null, from: null, diff --git a/packages/riverpod/lib/src/future_provider.dart b/packages/riverpod/lib/src/future_provider.dart index a1f7cf86c..b9419269c 100644 --- a/packages/riverpod/lib/src/future_provider.dart +++ b/packages/riverpod/lib/src/future_provider.dart @@ -93,7 +93,8 @@ ProviderElementProxy, Future> _future( /// - [FutureProvider.family], to create a [FutureProvider] from external parameters /// - [FutureProvider.autoDispose], to destroy the state of a [FutureProvider] when no longer needed. /// {@endtemplate} -abstract class _FutureProviderBase extends ProviderBase> { +abstract class _FutureProviderBase extends ProviderBase> + with AsyncSelector { const _FutureProviderBase({ required super.dependencies, required super.allTransitiveDependencies, @@ -103,26 +104,5 @@ abstract class _FutureProviderBase extends ProviderBase> { required super.debugGetCreateSourceHash, }); - /// Obtains the [Future] associated with a [FutureProvider]. - /// - /// The instance of [Future] obtained may change over time, if the provider - /// was recreated (such as when using [Ref.watch]). - /// - /// This provider allows using `async`/`await` to easily combine - /// [FutureProvider] together: - /// - /// ```dart - /// final configsProvider = FutureProvider((ref) async => Configs()); - /// - /// final productsProvider = FutureProvider((ref) async { - /// // Wait for the configurations to resolve - /// final configs = await ref.watch(configsProvider.future); - /// - /// // Do something with the result - /// return await http.get('${configs.host}/products'); - /// }); - /// ``` - Refreshable> get future; - FutureOr _create(covariant FutureProviderElement ref); } diff --git a/packages/riverpod/lib/src/future_provider/auto_dispose.dart b/packages/riverpod/lib/src/future_provider/auto_dispose.dart index 104b09cdd..f67c8df2c 100644 --- a/packages/riverpod/lib/src/future_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/future_provider/auto_dispose.dart @@ -59,7 +59,7 @@ class AutoDisposeFutureProvider extends _FutureProviderBase ) { return ProviderOverride( origin: this, - override: AutoDisposeFutureProvider.internal( + providerOverride: AutoDisposeFutureProvider.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/future_provider/base.dart b/packages/riverpod/lib/src/future_provider/base.dart index 8b941a6aa..7f6954f12 100644 --- a/packages/riverpod/lib/src/future_provider/base.dart +++ b/packages/riverpod/lib/src/future_provider/base.dart @@ -23,8 +23,7 @@ abstract class FutureProviderRef implements Ref> { } /// {@macro riverpod.future_provider} -class FutureProvider extends _FutureProviderBase - with AlwaysAliveProviderBase>, AlwaysAliveAsyncSelector { +class FutureProvider extends _FutureProviderBase { /// {@macro riverpod.future_provider} FutureProvider( this._createFn, { @@ -59,7 +58,7 @@ class FutureProvider extends _FutureProviderBase final Create, FutureProviderRef> _createFn; @override - late final AlwaysAliveRefreshable> future = _future(this); + late final Refreshable> future = _future(this); @override FutureOr _create(FutureProviderElement ref) => _createFn(ref); @@ -73,7 +72,7 @@ class FutureProvider extends _FutureProviderBase Override overrideWith(Create, FutureProviderRef> create) { return ProviderOverride( origin: this, - override: FutureProvider.internal( + providerOverride: FutureProvider.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/notifier/auto_dispose.dart b/packages/riverpod/lib/src/notifier/auto_dispose.dart index 16e912308..f2ea52f50 100644 --- a/packages/riverpod/lib/src/notifier/auto_dispose.dart +++ b/packages/riverpod/lib/src/notifier/auto_dispose.dart @@ -105,7 +105,7 @@ class AutoDisposeNotifierProviderImpl, T> Override overrideWith(NotifierT Function() create) { return ProviderOverride( origin: this, - override: AutoDisposeNotifierProviderImpl.internal( + providerOverride: AutoDisposeNotifierProviderImpl.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/notifier/base.dart b/packages/riverpod/lib/src/notifier/base.dart index 9ef3fee1a..a0134ff3b 100644 --- a/packages/riverpod/lib/src/notifier/base.dart +++ b/packages/riverpod/lib/src/notifier/base.dart @@ -119,7 +119,7 @@ typedef NotifierProvider, T> /// [AutoDisposeNotifierProvider] at the same time. @internal class NotifierProviderImpl, T> - extends NotifierProviderBase with AlwaysAliveProviderBase { + extends NotifierProviderBase { /// {@macro riverpod.notifier_provider} /// /// {@macro riverpod.notifier_provider_modifier} @@ -161,8 +161,7 @@ class NotifierProviderImpl, T> } @override - late final AlwaysAliveRefreshable notifier = - _notifier(this); + late final Refreshable notifier = _notifier(this); @override @mustBeOverridden @@ -175,7 +174,7 @@ class NotifierProviderImpl, T> Override overrideWith(NotifierT Function() create) { return ProviderOverride( origin: this, - override: NotifierProviderImpl.internal( + providerOverride: NotifierProviderImpl.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/notifier/family.dart b/packages/riverpod/lib/src/notifier/family.dart index 71c497fb2..7e2815406 100644 --- a/packages/riverpod/lib/src/notifier/family.dart +++ b/packages/riverpod/lib/src/notifier/family.dart @@ -32,7 +32,7 @@ typedef NotifierFamilyProvider, T, Arg> @visibleForTesting @internal class FamilyNotifierProviderImpl, T, Arg> - extends NotifierProviderBase with AlwaysAliveProviderBase { + extends NotifierProviderBase { /// {@macro riverpod.notifier} FamilyNotifierProviderImpl( super._createNotifier, { @@ -66,8 +66,7 @@ class FamilyNotifierProviderImpl, T, Arg> // static const family = NotifierProviderFamilyBuilder(); @override - late final AlwaysAliveRefreshable notifier = - _notifier(this); + late final Refreshable notifier = _notifier(this); @override NotifierProviderElement createElement( diff --git a/packages/riverpod/lib/src/provider/auto_dispose.dart b/packages/riverpod/lib/src/provider/auto_dispose.dart index 90af8fd18..7a45b2bce 100644 --- a/packages/riverpod/lib/src/provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/provider/auto_dispose.dart @@ -52,7 +52,7 @@ class AutoDisposeProvider extends InternalProvider { ) { return ProviderOverride( origin: this, - override: AutoDisposeProvider.internal( + providerOverride: AutoDisposeProvider.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/provider/base.dart b/packages/riverpod/lib/src/provider/base.dart index 8b00ee20d..f9ae3c9dd 100644 --- a/packages/riverpod/lib/src/provider/base.dart +++ b/packages/riverpod/lib/src/provider/base.dart @@ -16,8 +16,7 @@ abstract class ProviderRef implements Ref { /// {@macro riverpod.provider} @sealed -class Provider extends InternalProvider - with AlwaysAliveProviderBase { +class Provider extends InternalProvider { /// {@macro riverpod.provider} Provider( this._createFn, { @@ -100,7 +99,7 @@ class Provider extends InternalProvider ) { return ProviderOverride( origin: this, - override: Provider.internal( + providerOverride: Provider.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/state_notifier_provider/auto_dispose.dart b/packages/riverpod/lib/src/state_notifier_provider/auto_dispose.dart index f78471069..f629fe6c0 100644 --- a/packages/riverpod/lib/src/state_notifier_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/state_notifier_provider/auto_dispose.dart @@ -62,7 +62,7 @@ class AutoDisposeStateNotifierProvider, T> ) { return ProviderOverride( origin: this, - override: AutoDisposeStateNotifierProvider.internal( + providerOverride: AutoDisposeStateNotifierProvider.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/state_notifier_provider/base.dart b/packages/riverpod/lib/src/state_notifier_provider/base.dart index 89ad19614..834a23297 100644 --- a/packages/riverpod/lib/src/state_notifier_provider/base.dart +++ b/packages/riverpod/lib/src/state_notifier_provider/base.dart @@ -74,8 +74,7 @@ abstract class StateNotifierProviderRef, T> /// ``` /// {@endtemplate} class StateNotifierProvider, T> - extends _StateNotifierProviderBase - with AlwaysAliveProviderBase { + extends _StateNotifierProviderBase { /// {@macro riverpod.statenotifierprovider} StateNotifierProvider( this._createFn, { @@ -123,7 +122,7 @@ class StateNotifierProvider, T> } @override - late final AlwaysAliveRefreshable notifier = _notifier(this); + late final Refreshable notifier = _notifier(this); /// {@macro riverpod.override_with} Override overrideWith( @@ -131,7 +130,7 @@ class StateNotifierProvider, T> ) { return ProviderOverride( origin: this, - override: StateNotifierProvider.internal( + providerOverride: StateNotifierProvider.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/state_provider/auto_dispose.dart b/packages/riverpod/lib/src/state_provider/auto_dispose.dart index 75173b354..a06caa7b6 100644 --- a/packages/riverpod/lib/src/state_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/state_provider/auto_dispose.dart @@ -56,7 +56,7 @@ class AutoDisposeStateProvider extends _StateProviderBase { ) { return ProviderOverride( origin: this, - override: AutoDisposeStateProvider.internal( + providerOverride: AutoDisposeStateProvider.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/state_provider/base.dart b/packages/riverpod/lib/src/state_provider/base.dart index 4056c11c8..abeb963f8 100644 --- a/packages/riverpod/lib/src/state_provider/base.dart +++ b/packages/riverpod/lib/src/state_provider/base.dart @@ -42,8 +42,7 @@ abstract class StateProviderRef implements Ref { /// } /// ``` /// {@endtemplate} -class StateProvider extends _StateProviderBase - with AlwaysAliveProviderBase { +class StateProvider extends _StateProviderBase { /// {@macro riverpod.stateprovider} StateProvider( this._createFn, { @@ -88,8 +87,7 @@ class StateProvider extends _StateProviderBase } @override - late final AlwaysAliveRefreshable> notifier = - _notifier(this); + late final Refreshable> notifier = _notifier(this); /// {@macro riverpod.override_with} Override overrideWith( @@ -97,7 +95,7 @@ class StateProvider extends _StateProviderBase ) { return ProviderOverride( origin: this, - override: StateProvider.internal( + providerOverride: StateProvider.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/stream_notifier.dart b/packages/riverpod/lib/src/stream_notifier.dart index 874aac4eb..91d44a586 100644 --- a/packages/riverpod/lib/src/stream_notifier.dart +++ b/packages/riverpod/lib/src/stream_notifier.dart @@ -32,7 +32,7 @@ ProviderElementProxy, Future> _streamFuture( @internal abstract class StreamNotifierProviderBase< NotifierT extends AsyncNotifierBase, - T> extends ProviderBase> { + T> extends ProviderBase> with AsyncSelector { /// A base class for [StreamNotifierProvider] /// /// Not meant for public consumption diff --git a/packages/riverpod/lib/src/stream_notifier/auto_dispose.dart b/packages/riverpod/lib/src/stream_notifier/auto_dispose.dart index aec078969..b8b370772 100644 --- a/packages/riverpod/lib/src/stream_notifier/auto_dispose.dart +++ b/packages/riverpod/lib/src/stream_notifier/auto_dispose.dart @@ -108,7 +108,8 @@ class AutoDisposeStreamNotifierProviderImpl< Override overrideWith(NotifierT Function() create) { return ProviderOverride( origin: this, - override: AutoDisposeStreamNotifierProviderImpl.internal( + providerOverride: + AutoDisposeStreamNotifierProviderImpl.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/stream_notifier/base.dart b/packages/riverpod/lib/src/stream_notifier/base.dart index e122b0799..ca075e1ec 100644 --- a/packages/riverpod/lib/src/stream_notifier/base.dart +++ b/packages/riverpod/lib/src/stream_notifier/base.dart @@ -66,8 +66,7 @@ typedef StreamNotifierProvider, T> @visibleForTesting @internal class StreamNotifierProviderImpl, T> - extends StreamNotifierProviderBase - with AlwaysAliveProviderBase>, AlwaysAliveAsyncSelector { + extends StreamNotifierProviderBase { /// {@macro riverpod.streamNotifier} StreamNotifierProviderImpl( super._createNotifier, { @@ -100,11 +99,11 @@ class StreamNotifierProviderImpl, T> static const family = StreamNotifierProviderFamilyBuilder(); @override - late final AlwaysAliveRefreshable notifier = + late final Refreshable notifier = _streamNotifier(this); @override - late final AlwaysAliveRefreshable> future = _streamFuture(this); + late final Refreshable> future = _streamFuture(this); @override StreamNotifierProviderElement createElement( @@ -125,7 +124,7 @@ class StreamNotifierProviderImpl, T> Override overrideWith(NotifierT Function() create) { return ProviderOverride( origin: this, - override: StreamNotifierProviderImpl.internal( + providerOverride: StreamNotifierProviderImpl.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/stream_notifier/family.dart b/packages/riverpod/lib/src/stream_notifier/family.dart index a09201380..c26df5328 100644 --- a/packages/riverpod/lib/src/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/stream_notifier/family.dart @@ -40,8 +40,7 @@ typedef StreamNotifierFamilyProvider< @visibleForTesting @internal class FamilyStreamNotifierProviderImpl, - T, Arg> extends StreamNotifierProviderBase - with AlwaysAliveProviderBase>, AlwaysAliveAsyncSelector { + T, Arg> extends StreamNotifierProviderBase { /// {@macro riverpod.streamNotifier} FamilyStreamNotifierProviderImpl( super._createNotifier, { @@ -71,11 +70,11 @@ class FamilyStreamNotifierProviderImpl, static const autoDispose = AutoDisposeStreamNotifierProviderFamily.new; @override - late final AlwaysAliveRefreshable notifier = + late final Refreshable notifier = _streamNotifier(this); @override - late final AlwaysAliveRefreshable> future = _streamFuture(this); + late final Refreshable> future = _streamFuture(this); @override StreamNotifierProviderElement createElement( diff --git a/packages/riverpod/lib/src/stream_provider.dart b/packages/riverpod/lib/src/stream_provider.dart index 42a19b7aa..3457327f5 100644 --- a/packages/riverpod/lib/src/stream_provider.dart +++ b/packages/riverpod/lib/src/stream_provider.dart @@ -25,7 +25,8 @@ ProviderElementProxy, Future> _future( ); } -abstract class _StreamProviderBase extends ProviderBase> { +abstract class _StreamProviderBase extends ProviderBase> + with AsyncSelector { const _StreamProviderBase({ required super.allTransitiveDependencies, required super.dependencies, @@ -35,7 +36,5 @@ abstract class _StreamProviderBase extends ProviderBase> { required super.debugGetCreateSourceHash, }); - ProviderListenable> get future; - Stream _create(covariant StreamProviderElement ref); } diff --git a/packages/riverpod/lib/src/stream_provider/auto_dispose.dart b/packages/riverpod/lib/src/stream_provider/auto_dispose.dart index 30471d404..c6348f770 100644 --- a/packages/riverpod/lib/src/stream_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/stream_provider/auto_dispose.dart @@ -57,7 +57,7 @@ class AutoDisposeStreamProvider extends _StreamProviderBase ) { return ProviderOverride( origin: this, - override: AutoDisposeStreamProvider.internal( + providerOverride: AutoDisposeStreamProvider.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/lib/src/stream_provider/base.dart b/packages/riverpod/lib/src/stream_provider/base.dart index 0f5cf05f6..3ac295ed8 100644 --- a/packages/riverpod/lib/src/stream_provider/base.dart +++ b/packages/riverpod/lib/src/stream_provider/base.dart @@ -70,8 +70,7 @@ abstract class StreamProviderRef implements Ref> { /// - [StreamProvider.family], to create a [StreamProvider] from external parameters /// - [StreamProvider.autoDispose], to destroy the state of a [StreamProvider] when no longer needed. /// {@endtemplate} -class StreamProvider extends _StreamProviderBase - with AlwaysAliveProviderBase>, AlwaysAliveAsyncSelector { +class StreamProvider extends _StreamProviderBase { /// {@macro riverpod.stream_provider} StreamProvider( this._createFn, { @@ -106,7 +105,7 @@ class StreamProvider extends _StreamProviderBase final Stream Function(StreamProviderRef ref) _createFn; @override - late final AlwaysAliveRefreshable> future = _future(this); + late final Refreshable> future = _future(this); @override Stream _create(StreamProviderElement ref) => _createFn(ref); @@ -123,7 +122,7 @@ class StreamProvider extends _StreamProviderBase Override overrideWith(Create, StreamProviderRef> create) { return ProviderOverride( origin: this, - override: StreamProvider.internal( + providerOverride: StreamProvider.internal( create, from: from, argument: argument, diff --git a/packages/riverpod/test/new/framework/provider_container_test.dart b/packages/riverpod/test/new/framework/provider_container_test.dart index ce77918e2..97501c1ea 100644 --- a/packages/riverpod/test/new/framework/provider_container_test.dart +++ b/packages/riverpod/test/new/framework/provider_container_test.dart @@ -23,7 +23,7 @@ TypeMatcher isPointer({ } if (container != _sentinel) { - matcher = matcher.having((p) => p.container, 'container', container); + matcher = matcher.having((p) => p.mountedContainer, 'container', container); } return matcher; @@ -45,7 +45,7 @@ TypeMatcher isProviderDirectory({ } if (container != _sentinel) { - matcher = matcher.having((p) => p.container, 'container', container); + matcher = matcher.having((p) => p.mountedContainer, 'container', container); } return matcher; @@ -506,7 +506,7 @@ void main() { test('orphansPointers.container points to the root', () { final root = ProviderContainer.test(); - expect(root.pointerManager.orphanPointers.container, root); + expect(root.pointerManager.orphanPointers.mountedContainer, root); }); }); @@ -684,8 +684,9 @@ void main() { overrides: [provider], ); - expect(root.pointerManager.orphanPointers.container, root); - expect(container.pointerManager.orphanPointers.container, root); + expect(root.pointerManager.orphanPointers.mountedContainer, root); + expect( + container.pointerManager.orphanPointers.mountedContainer, root); expect( container.pointerManager.orphanPointers.pointers, diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 4cf2b4bab..3455e1037 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -120,12 +120,12 @@ class Count2Family extends Family { } class _$Count2FamilyOverride implements FamilyOverride { - _$Count2FamilyOverride(this.overriddenFamily, this.create); + _$Count2FamilyOverride(this.from, this.create); final int Function(Count2Ref ref) create; @override - final Count2Family overriddenFamily; + final Count2Family from; @override Count2Provider getProviderOverride( @@ -174,7 +174,7 @@ class Count2Provider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: Count2Provider._internal( + providerOverride: Count2Provider._internal( (ref) => create(ref as Count2Ref), from: from, name: null, @@ -290,12 +290,12 @@ class CountFuture2Family extends Family { } class _$CountFuture2FamilyOverride implements FamilyOverride { - _$CountFuture2FamilyOverride(this.overriddenFamily, this.create); + _$CountFuture2FamilyOverride(this.from, this.create); final FutureOr Function(CountFuture2Ref ref) create; @override - final CountFuture2Family overriddenFamily; + final CountFuture2Family from; @override CountFuture2Provider getProviderOverride( @@ -345,7 +345,7 @@ class CountFuture2Provider extends AutoDisposeFutureProvider { ) { return ProviderOverride( origin: this, - override: CountFuture2Provider._internal( + providerOverride: CountFuture2Provider._internal( (ref) => create(ref as CountFuture2Ref), from: from, name: null, @@ -461,12 +461,12 @@ class CountStream2Family extends Family { } class _$CountStream2FamilyOverride implements FamilyOverride { - _$CountStream2FamilyOverride(this.overriddenFamily, this.create); + _$CountStream2FamilyOverride(this.from, this.create); final Stream Function(CountStream2Ref ref) create; @override - final CountStream2Family overriddenFamily; + final CountStream2Family from; @override CountStream2Provider getProviderOverride( @@ -516,7 +516,7 @@ class CountStream2Provider extends AutoDisposeStreamProvider { ) { return ProviderOverride( origin: this, - override: CountStream2Provider._internal( + providerOverride: CountStream2Provider._internal( (ref) => create(ref as CountStream2Ref), from: from, name: null, @@ -690,12 +690,12 @@ class CountNotifier2Family extends Family { } class _$CountNotifier2FamilyOverride implements FamilyOverride { - _$CountNotifier2FamilyOverride(this.overriddenFamily, this.create); + _$CountNotifier2FamilyOverride(this.from, this.create); final CountNotifier2 Function() create; @override - final CountNotifier2Family overriddenFamily; + final CountNotifier2Family from; @override CountNotifier2Provider getProviderOverride( @@ -750,7 +750,7 @@ class CountNotifier2Provider Override overrideWith(CountNotifier2 Function() create) { return ProviderOverride( origin: this, - override: CountNotifier2Provider._internal( + providerOverride: CountNotifier2Provider._internal( () => create()..a = a, from: from, name: null, @@ -877,12 +877,12 @@ class CountAsyncNotifier2Family extends Family { } class _$CountAsyncNotifier2FamilyOverride implements FamilyOverride { - _$CountAsyncNotifier2FamilyOverride(this.overriddenFamily, this.create); + _$CountAsyncNotifier2FamilyOverride(this.from, this.create); final CountAsyncNotifier2 Function() create; @override - final CountAsyncNotifier2Family overriddenFamily; + final CountAsyncNotifier2Family from; @override CountAsyncNotifier2Provider getProviderOverride( @@ -937,7 +937,7 @@ class CountAsyncNotifier2Provider Override overrideWith(CountAsyncNotifier2 Function() create) { return ProviderOverride( origin: this, - override: CountAsyncNotifier2Provider._internal( + providerOverride: CountAsyncNotifier2Provider._internal( () => create()..a = a, from: from, name: null, @@ -1065,12 +1065,12 @@ class CountStreamNotifier2Family extends Family { } class _$CountStreamNotifier2FamilyOverride implements FamilyOverride { - _$CountStreamNotifier2FamilyOverride(this.overriddenFamily, this.create); + _$CountStreamNotifier2FamilyOverride(this.from, this.create); final CountStreamNotifier2 Function() create; @override - final CountStreamNotifier2Family overriddenFamily; + final CountStreamNotifier2Family from; @override CountStreamNotifier2Provider getProviderOverride( @@ -1125,7 +1125,7 @@ class CountStreamNotifier2Provider Override overrideWith(CountStreamNotifier2 Function() create) { return ProviderOverride( origin: this, - override: CountStreamNotifier2Provider._internal( + providerOverride: CountStreamNotifier2Provider._internal( () => create()..a = a, from: from, name: null, diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 8610bf759..b6efa80b7 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -98,12 +98,12 @@ class FamilyFamily extends Family { } class _$FamilyFamilyOverride implements FamilyOverride { - _$FamilyFamilyOverride(this.overriddenFamily, this.create); + _$FamilyFamilyOverride(this.from, this.create); final String Function(FamilyRef ref) create; @override - final FamilyFamily overriddenFamily; + final FamilyFamily from; @override FamilyProvider getProviderOverride( @@ -152,7 +152,7 @@ class FamilyProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: FamilyProvider._internal( + providerOverride: FamilyProvider._internal( (ref) => create(ref as FamilyRef), from: from, name: null, @@ -284,12 +284,12 @@ class NotCopiedFamilyFamily extends Family { } class _$NotCopiedFamilyFamilyOverride implements FamilyOverride { - _$NotCopiedFamilyFamilyOverride(this.overriddenFamily, this.create); + _$NotCopiedFamilyFamilyOverride(this.from, this.create); final String Function(NotCopiedFamilyRef ref) create; @override - final NotCopiedFamilyFamily overriddenFamily; + final NotCopiedFamilyFamily from; @override NotCopiedFamilyProvider getProviderOverride( @@ -339,7 +339,7 @@ class NotCopiedFamilyProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: NotCopiedFamilyProvider._internal( + providerOverride: NotCopiedFamilyProvider._internal( (ref) => create(ref as NotCopiedFamilyRef), from: from, name: null, diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 0f177781a..60e39f416 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -73,12 +73,12 @@ class GenericFamily extends Family { } class _$GenericFamilyOverride implements FamilyOverride { - _$GenericFamilyOverride(this.overriddenFamily, this.create); + _$GenericFamilyOverride(this.from, this.create); final FutureOr> Function(GenericRef ref) create; @override - final GenericFamily overriddenFamily; + final GenericFamily from; @override GenericProvider getProviderOverride( @@ -122,7 +122,7 @@ class GenericProvider ) { return ProviderOverride( origin: this, - override: GenericProvider._internal( + providerOverride: GenericProvider._internal( (ref) => create(ref as GenericRef), from: from, name: null, @@ -258,12 +258,12 @@ class FamilyOrFamily extends Family { } class _$FamilyOrFamilyOverride implements FamilyOverride { - _$FamilyOrFamilyOverride(this.overriddenFamily, this.create); + _$FamilyOrFamilyOverride(this.from, this.create); final FutureOr Function(FamilyOrRef ref) create; @override - final FamilyOrFamily overriddenFamily; + final FamilyOrFamily from; @override FamilyOrProvider getProviderOverride( @@ -312,7 +312,7 @@ class FamilyOrProvider extends AutoDisposeFutureProvider { ) { return ProviderOverride( origin: this, - override: FamilyOrProvider._internal( + providerOverride: FamilyOrProvider._internal( (ref) => create(ref as FamilyOrRef), from: from, name: null, @@ -440,12 +440,12 @@ class FamilyFamily extends Family { } class _$FamilyFamilyOverride implements FamilyOverride { - _$FamilyFamilyOverride(this.overriddenFamily, this.create); + _$FamilyFamilyOverride(this.from, this.create); final FutureOr Function(FamilyRef ref) create; @override - final FamilyFamily overriddenFamily; + final FamilyFamily from; @override FamilyProvider getProviderOverride( @@ -514,7 +514,7 @@ class FamilyProvider extends AutoDisposeFutureProvider { ) { return ProviderOverride( origin: this, - override: FamilyProvider._internal( + providerOverride: FamilyProvider._internal( (ref) => create(ref as FamilyRef), from: from, name: null, @@ -678,12 +678,12 @@ class GenericClassFamily extends Family { } class _$GenericClassFamilyOverride implements FamilyOverride { - _$GenericClassFamilyOverride(this.overriddenFamily, this.create); + _$GenericClassFamilyOverride(this.from, this.create); final GenericClass Function() create; @override - final GenericClassFamily overriddenFamily; + final GenericClassFamily from; @override GenericClassProvider getProviderOverride( @@ -731,7 +731,7 @@ class GenericClassProvider Override overrideWith(GenericClass Function() create) { return ProviderOverride( origin: this, - override: GenericClassProvider._internal( + providerOverride: GenericClassProvider._internal( () => create(), from: from, name: null, @@ -881,12 +881,12 @@ class FamilyOrClassFamily extends Family { } class _$FamilyOrClassFamilyOverride implements FamilyOverride { - _$FamilyOrClassFamilyOverride(this.overriddenFamily, this.create); + _$FamilyOrClassFamilyOverride(this.from, this.create); final FamilyOrClass Function() create; @override - final FamilyOrClassFamily overriddenFamily; + final FamilyOrClassFamily from; @override FamilyOrClassProvider getProviderOverride( @@ -941,7 +941,7 @@ class FamilyOrClassProvider Override overrideWith(FamilyOrClass Function() create) { return ProviderOverride( origin: this, - override: FamilyOrClassProvider._internal( + providerOverride: FamilyOrClassProvider._internal( () => create()..first = first, from: from, name: null, @@ -1086,12 +1086,12 @@ class FamilyClassFamily extends Family { } class _$FamilyClassFamilyOverride implements FamilyOverride { - _$FamilyClassFamilyOverride(this.overriddenFamily, this.create); + _$FamilyClassFamilyOverride(this.from, this.create); final FamilyClass Function() create; @override - final FamilyClassFamily overriddenFamily; + final FamilyClassFamily from; @override FamilyClassProvider getProviderOverride( @@ -1171,7 +1171,7 @@ class FamilyClassProvider Override overrideWith(FamilyClass Function() create) { return ProviderOverride( origin: this, - override: FamilyClassProvider._internal( + providerOverride: FamilyClassProvider._internal( () => create() ..first = first ..second = second diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 3a935f5c7..0ddd854d8 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -92,12 +92,12 @@ class FamilyFamily extends Family { } class _$FamilyFamilyOverride implements FamilyOverride { - _$FamilyFamilyOverride(this.overriddenFamily, this.create); + _$FamilyFamilyOverride(this.from, this.create); final int Function(FamilyRef ref) create; @override - final FamilyFamily overriddenFamily; + final FamilyFamily from; @override FamilyProvider getProviderOverride( @@ -146,7 +146,7 @@ class FamilyProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: FamilyProvider._internal( + providerOverride: FamilyProvider._internal( (ref) => create(ref as FamilyRef), from: from, name: null, @@ -448,12 +448,12 @@ class Family2Family extends Family { } class _$Family2FamilyOverride implements FamilyOverride { - _$Family2FamilyOverride(this.overriddenFamily, this.create); + _$Family2FamilyOverride(this.from, this.create); final Family2 Function() create; @override - final Family2Family overriddenFamily; + final Family2Family from; @override Family2Provider getProviderOverride( @@ -506,7 +506,7 @@ class Family2Provider extends AutoDisposeNotifierProviderImpl { Override overrideWith(Family2 Function() create) { return ProviderOverride( origin: this, - override: Family2Provider._internal( + providerOverride: Family2Provider._internal( () => create()..id = id, from: from, name: null, @@ -673,12 +673,12 @@ class Provider4Family extends Family { } class _$Provider4FamilyOverride implements FamilyOverride { - _$Provider4FamilyOverride(this.overriddenFamily, this.create); + _$Provider4FamilyOverride(this.from, this.create); final Provider4 Function() create; @override - final Provider4Family overriddenFamily; + final Provider4Family from; @override Provider4Provider getProviderOverride( @@ -732,7 +732,7 @@ class Provider4Provider Override overrideWith(Provider4 Function() create) { return ProviderOverride( origin: this, - override: Provider4Provider._internal( + providerOverride: Provider4Provider._internal( () => create()..id = id, from: from, name: null, diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index f14d0622f..77cb54681 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -118,12 +118,12 @@ class FamilyWithDependencies2Family extends Family { } class _$FamilyWithDependencies2FamilyOverride implements FamilyOverride { - _$FamilyWithDependencies2FamilyOverride(this.overriddenFamily, this.create); + _$FamilyWithDependencies2FamilyOverride(this.from, this.create); final int Function(FamilyWithDependencies2Ref ref) create; @override - final FamilyWithDependencies2Family overriddenFamily; + final FamilyWithDependencies2Family from; @override FamilyWithDependencies2Provider getProviderOverride( @@ -173,7 +173,7 @@ class FamilyWithDependencies2Provider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: FamilyWithDependencies2Provider._internal( + providerOverride: FamilyWithDependencies2Provider._internal( (ref) => create(ref as FamilyWithDependencies2Ref), from: from, name: null, @@ -370,13 +370,12 @@ class NotifierFamilyWithDependenciesFamily extends Family { } class _$NotifierFamilyWithDependenciesFamilyOverride implements FamilyOverride { - _$NotifierFamilyWithDependenciesFamilyOverride( - this.overriddenFamily, this.create); + _$NotifierFamilyWithDependenciesFamilyOverride(this.from, this.create); final NotifierFamilyWithDependencies Function() create; @override - final NotifierFamilyWithDependenciesFamily overriddenFamily; + final NotifierFamilyWithDependenciesFamily from; @override NotifierFamilyWithDependenciesProvider getProviderOverride( @@ -432,7 +431,7 @@ class NotifierFamilyWithDependenciesProvider Override overrideWith(NotifierFamilyWithDependencies Function() create) { return ProviderOverride( origin: this, - override: NotifierFamilyWithDependenciesProvider._internal( + providerOverride: NotifierFamilyWithDependenciesProvider._internal( () => create()..id = id, from: from, name: null, diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 9d1984f29..51e29a39e 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -92,12 +92,12 @@ class GeneratedFamilyFamily extends Family { } class _$GeneratedFamilyFamilyOverride implements FamilyOverride { - _$GeneratedFamilyFamilyOverride(this.overriddenFamily, this.create); + _$GeneratedFamilyFamilyOverride(this.from, this.create); final _Test Function(GeneratedFamilyRef ref) create; @override - final GeneratedFamilyFamily overriddenFamily; + final GeneratedFamilyFamily from; @override GeneratedFamilyProvider getProviderOverride( @@ -147,7 +147,7 @@ class GeneratedFamilyProvider extends AutoDisposeProvider<_Test> { ) { return ProviderOverride( origin: this, - override: GeneratedFamilyProvider._internal( + providerOverride: GeneratedFamilyProvider._internal( (ref) => create(ref as GeneratedFamilyRef), from: from, name: null, @@ -277,12 +277,12 @@ class $DynamicFamilyFamily extends Family { } class _$$DynamicFamilyFamilyOverride implements FamilyOverride { - _$$DynamicFamilyFamilyOverride(this.overriddenFamily, this.create); + _$$DynamicFamilyFamilyOverride(this.from, this.create); final Object? Function($DynamicFamilyRef ref) create; @override - final $DynamicFamilyFamily overriddenFamily; + final $DynamicFamilyFamily from; @override $DynamicFamilyProvider getProviderOverride( @@ -332,7 +332,7 @@ class $DynamicFamilyProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: $DynamicFamilyProvider._internal( + providerOverride: $DynamicFamilyProvider._internal( (ref) => create(ref as $DynamicFamilyRef), from: from, name: null, @@ -448,12 +448,12 @@ class _DynamicFamily extends Family { } class _$DynamicFamilyOverride implements FamilyOverride { - _$DynamicFamilyOverride(this.overriddenFamily, this.create); + _$DynamicFamilyOverride(this.from, this.create); final Object? Function(_DynamicRef ref) create; @override - final _DynamicFamily overriddenFamily; + final _DynamicFamily from; @override _DynamicProvider getProviderOverride( @@ -502,7 +502,7 @@ class _DynamicProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: _DynamicProvider._internal( + providerOverride: _DynamicProvider._internal( (ref) => create(ref as _DynamicRef), from: from, name: null, @@ -632,12 +632,12 @@ class AliasFamilyFamily extends Family { } class _$AliasFamilyFamilyOverride implements FamilyOverride { - _$AliasFamilyFamilyOverride(this.overriddenFamily, this.create); + _$AliasFamilyFamilyOverride(this.from, this.create); final r.AsyncValue Function(AliasFamilyRef ref) create; @override - final AliasFamilyFamily overriddenFamily; + final AliasFamilyFamily from; @override AliasFamilyProvider getProviderOverride( @@ -687,7 +687,7 @@ class AliasFamilyProvider extends AutoDisposeProvider> { ) { return ProviderOverride( origin: this, - override: AliasFamilyProvider._internal( + providerOverride: AliasFamilyProvider._internal( (ref) => create(ref as AliasFamilyRef), from: from, name: null, @@ -829,12 +829,12 @@ class GeneratedClassFamilyFamily extends Family { } class _$GeneratedClassFamilyFamilyOverride implements FamilyOverride { - _$GeneratedClassFamilyFamilyOverride(this.overriddenFamily, this.create); + _$GeneratedClassFamilyFamilyOverride(this.from, this.create); final GeneratedClassFamily Function() create; @override - final GeneratedClassFamilyFamily overriddenFamily; + final GeneratedClassFamilyFamily from; @override GeneratedClassFamilyProvider getProviderOverride( @@ -889,7 +889,7 @@ class GeneratedClassFamilyProvider Override overrideWith(GeneratedClassFamily Function() create) { return ProviderOverride( origin: this, - override: GeneratedClassFamilyProvider._internal( + providerOverride: GeneratedClassFamilyProvider._internal( () => create()..test = test, from: from, name: null, @@ -1032,12 +1032,12 @@ class $DynamicClassFamilyFamily extends Family { } class _$$DynamicClassFamilyFamilyOverride implements FamilyOverride { - _$$DynamicClassFamilyFamilyOverride(this.overriddenFamily, this.create); + _$$DynamicClassFamilyFamilyOverride(this.from, this.create); final $DynamicClassFamily Function() create; @override - final $DynamicClassFamilyFamily overriddenFamily; + final $DynamicClassFamilyFamily from; @override $DynamicClassFamilyProvider getProviderOverride( @@ -1092,7 +1092,7 @@ class $DynamicClassFamilyProvider Override overrideWith($DynamicClassFamily Function() create) { return ProviderOverride( origin: this, - override: $DynamicClassFamilyProvider._internal( + providerOverride: $DynamicClassFamilyProvider._internal( () => create()..test = test, from: from, name: null, @@ -1234,12 +1234,12 @@ class AliasClassFamilyFamily extends Family { } class _$AliasClassFamilyFamilyOverride implements FamilyOverride { - _$AliasClassFamilyFamilyOverride(this.overriddenFamily, this.create); + _$AliasClassFamilyFamilyOverride(this.from, this.create); final AliasClassFamily Function() create; @override - final AliasClassFamilyFamily overriddenFamily; + final AliasClassFamilyFamily from; @override AliasClassFamilyProvider getProviderOverride( @@ -1294,7 +1294,7 @@ class AliasClassFamilyProvider extends AutoDisposeNotifierProviderImpl< Override overrideWith(AliasClassFamily Function() create) { return ProviderOverride( origin: this, - override: AliasClassFamilyProvider._internal( + providerOverride: AliasClassFamilyProvider._internal( () => create()..test = test, from: from, name: null, diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 9ee8bf2c6..173eb32cf 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -73,12 +73,12 @@ class GenericFamily extends Family { } class _$GenericFamilyOverride implements FamilyOverride { - _$GenericFamilyOverride(this.overriddenFamily, this.create); + _$GenericFamilyOverride(this.from, this.create); final Stream> Function(GenericRef ref) create; @override - final GenericFamily overriddenFamily; + final GenericFamily from; @override GenericProvider getProviderOverride( @@ -122,7 +122,7 @@ class GenericProvider ) { return ProviderOverride( origin: this, - override: GenericProvider._internal( + providerOverride: GenericProvider._internal( (ref) => create(ref as GenericRef), from: from, name: null, @@ -270,12 +270,12 @@ class FamilyFamily extends Family { } class _$FamilyFamilyOverride implements FamilyOverride { - _$FamilyFamilyOverride(this.overriddenFamily, this.create); + _$FamilyFamilyOverride(this.from, this.create); final Stream Function(FamilyRef ref) create; @override - final FamilyFamily overriddenFamily; + final FamilyFamily from; @override FamilyProvider getProviderOverride( @@ -344,7 +344,7 @@ class FamilyProvider extends AutoDisposeStreamProvider { ) { return ProviderOverride( origin: this, - override: FamilyProvider._internal( + providerOverride: FamilyProvider._internal( (ref) => create(ref as FamilyRef), from: from, name: null, @@ -508,12 +508,12 @@ class GenericClassFamily extends Family { } class _$GenericClassFamilyOverride implements FamilyOverride { - _$GenericClassFamilyOverride(this.overriddenFamily, this.create); + _$GenericClassFamilyOverride(this.from, this.create); final GenericClass Function() create; @override - final GenericClassFamily overriddenFamily; + final GenericClassFamily from; @override GenericClassProvider getProviderOverride( @@ -561,7 +561,7 @@ class GenericClassProvider Override overrideWith(GenericClass Function() create) { return ProviderOverride( origin: this, - override: GenericClassProvider._internal( + providerOverride: GenericClassProvider._internal( () => create(), from: from, name: null, @@ -731,12 +731,12 @@ class FamilyClassFamily extends Family { } class _$FamilyClassFamilyOverride implements FamilyOverride { - _$FamilyClassFamilyOverride(this.overriddenFamily, this.create); + _$FamilyClassFamilyOverride(this.from, this.create); final FamilyClass Function() create; @override - final FamilyClassFamily overriddenFamily; + final FamilyClassFamily from; @override FamilyClassProvider getProviderOverride( @@ -816,7 +816,7 @@ class FamilyClassProvider Override overrideWith(FamilyClass Function() create) { return ProviderOverride( origin: this, - override: FamilyClassProvider._internal( + providerOverride: FamilyClassProvider._internal( () => create() ..first = first ..second = second diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 42d607a87..792401efe 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -73,12 +73,12 @@ class GenericFamily extends Family { } class _$GenericFamilyOverride implements FamilyOverride { - _$GenericFamilyOverride(this.overriddenFamily, this.create); + _$GenericFamilyOverride(this.from, this.create); final List Function(GenericRef ref) create; @override - final GenericFamily overriddenFamily; + final GenericFamily from; @override GenericProvider getProviderOverride( @@ -121,7 +121,7 @@ class GenericProvider extends AutoDisposeProvider> { ) { return ProviderOverride( origin: this, - override: GenericProvider._internal( + providerOverride: GenericProvider._internal( (ref) => create(ref as GenericRef), from: from, name: null, @@ -235,13 +235,13 @@ class ComplexGenericFamily extends Family { } class _$ComplexGenericFamilyOverride implements FamilyOverride { - _$ComplexGenericFamilyOverride(this.overriddenFamily, this.create); + _$ComplexGenericFamilyOverride(this.from, this.create); final List Function( ComplexGenericRef ref) create; @override - final ComplexGenericFamily overriddenFamily; + final ComplexGenericFamily from; @override ComplexGenericProvider getProviderOverride( @@ -297,7 +297,7 @@ class ComplexGenericProvider ) { return ProviderOverride( origin: this, - override: ComplexGenericProvider._internal( + providerOverride: ComplexGenericProvider._internal( (ref) => create(ref as ComplexGenericRef), from: from, name: null, @@ -463,12 +463,12 @@ class RawFamilyFutureFamily extends Family { } class _$RawFamilyFutureFamilyOverride implements FamilyOverride { - _$RawFamilyFutureFamilyOverride(this.overriddenFamily, this.create); + _$RawFamilyFutureFamilyOverride(this.from, this.create); final Raw> Function(RawFamilyFutureRef ref) create; @override - final RawFamilyFutureFamily overriddenFamily; + final RawFamilyFutureFamily from; @override RawFamilyFutureProvider getProviderOverride( @@ -518,7 +518,7 @@ class RawFamilyFutureProvider extends AutoDisposeProvider>> { ) { return ProviderOverride( origin: this, - override: RawFamilyFutureProvider._internal( + providerOverride: RawFamilyFutureProvider._internal( (ref) => create(ref as RawFamilyFutureRef), from: from, name: null, @@ -636,12 +636,12 @@ class RawFamilyStreamFamily extends Family { } class _$RawFamilyStreamFamilyOverride implements FamilyOverride { - _$RawFamilyStreamFamilyOverride(this.overriddenFamily, this.create); + _$RawFamilyStreamFamilyOverride(this.from, this.create); final Raw> Function(RawFamilyStreamRef ref) create; @override - final RawFamilyStreamFamily overriddenFamily; + final RawFamilyStreamFamily from; @override RawFamilyStreamProvider getProviderOverride( @@ -691,7 +691,7 @@ class RawFamilyStreamProvider extends AutoDisposeProvider>> { ) { return ProviderOverride( origin: this, - override: RawFamilyStreamProvider._internal( + providerOverride: RawFamilyStreamProvider._internal( (ref) => create(ref as RawFamilyStreamRef), from: from, name: null, @@ -859,12 +859,12 @@ class FamilyFamily extends Family { } class _$FamilyFamilyOverride implements FamilyOverride { - _$FamilyFamilyOverride(this.overriddenFamily, this.create); + _$FamilyFamilyOverride(this.from, this.create); final String Function(FamilyRef ref) create; @override - final FamilyFamily overriddenFamily; + final FamilyFamily from; @override FamilyProvider getProviderOverride( @@ -937,7 +937,7 @@ class FamilyProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: FamilyProvider._internal( + providerOverride: FamilyProvider._internal( (ref) => create(ref as FamilyRef), from: from, name: null, @@ -1129,12 +1129,12 @@ class GenericClassFamily extends Family { } class _$GenericClassFamilyOverride implements FamilyOverride { - _$GenericClassFamilyOverride(this.overriddenFamily, this.create); + _$GenericClassFamilyOverride(this.from, this.create); final GenericClass Function() create; @override - final GenericClassFamily overriddenFamily; + final GenericClassFamily from; @override GenericClassProvider getProviderOverride( @@ -1182,7 +1182,7 @@ class GenericClassProvider Override overrideWith(GenericClass Function() create) { return ProviderOverride( origin: this, - override: GenericClassProvider._internal( + providerOverride: GenericClassProvider._internal( () => create(), from: from, name: null, @@ -1334,12 +1334,12 @@ class RawFamilyFutureClassFamily extends Family { } class _$RawFamilyFutureClassFamilyOverride implements FamilyOverride { - _$RawFamilyFutureClassFamilyOverride(this.overriddenFamily, this.create); + _$RawFamilyFutureClassFamilyOverride(this.from, this.create); final RawFamilyFutureClass Function() create; @override - final RawFamilyFutureClassFamily overriddenFamily; + final RawFamilyFutureClassFamily from; @override RawFamilyFutureClassProvider getProviderOverride( @@ -1394,7 +1394,7 @@ class RawFamilyFutureClassProvider extends AutoDisposeNotifierProviderImpl< Override overrideWith(RawFamilyFutureClass Function() create) { return ProviderOverride( origin: this, - override: RawFamilyFutureClassProvider._internal( + providerOverride: RawFamilyFutureClassProvider._internal( () => create()..id = id, from: from, name: null, @@ -1523,12 +1523,12 @@ class RawFamilyStreamClassFamily extends Family { } class _$RawFamilyStreamClassFamilyOverride implements FamilyOverride { - _$RawFamilyStreamClassFamilyOverride(this.overriddenFamily, this.create); + _$RawFamilyStreamClassFamilyOverride(this.from, this.create); final RawFamilyStreamClass Function() create; @override - final RawFamilyStreamClassFamily overriddenFamily; + final RawFamilyStreamClassFamily from; @override RawFamilyStreamClassProvider getProviderOverride( @@ -1583,7 +1583,7 @@ class RawFamilyStreamClassProvider extends AutoDisposeNotifierProviderImpl< Override overrideWith(RawFamilyStreamClass Function() create) { return ProviderOverride( origin: this, - override: RawFamilyStreamClassProvider._internal( + providerOverride: RawFamilyStreamClassProvider._internal( () => create()..id = id, from: from, name: null, @@ -1770,12 +1770,12 @@ class FamilyClassFamily extends Family { } class _$FamilyClassFamilyOverride implements FamilyOverride { - _$FamilyClassFamilyOverride(this.overriddenFamily, this.create); + _$FamilyClassFamilyOverride(this.from, this.create); final FamilyClass Function() create; @override - final FamilyClassFamily overriddenFamily; + final FamilyClassFamily from; @override FamilyClassProvider getProviderOverride( @@ -1859,7 +1859,7 @@ class FamilyClassProvider Override overrideWith(FamilyClass Function() create) { return ProviderOverride( origin: this, - override: FamilyClassProvider._internal( + providerOverride: FamilyClassProvider._internal( () => create() ..first = first ..second = second diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 2280a7a99..64efc283f 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -131,12 +131,12 @@ class FamilyFamily extends Family { } class _$FamilyFamilyOverride implements FamilyOverride { - _$FamilyFamilyOverride(this.overriddenFamily, this.create); + _$FamilyFamilyOverride(this.from, this.create); final String Function(FamilyRef ref) create; @override - final FamilyFamily overriddenFamily; + final FamilyFamily from; @override FamilyProvider getProviderOverride( @@ -209,7 +209,7 @@ class FamilyProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: FamilyProvider._internal( + providerOverride: FamilyProvider._internal( (ref) => create(ref as FamilyRef), from: from, name: null, @@ -456,12 +456,12 @@ class FamilyClassFamily extends Family { } class _$FamilyClassFamilyOverride implements FamilyOverride { - _$FamilyClassFamilyOverride(this.overriddenFamily, this.create); + _$FamilyClassFamilyOverride(this.from, this.create); final FamilyClass Function() create; @override - final FamilyClassFamily overriddenFamily; + final FamilyClassFamily from; @override FamilyClassProvider getProviderOverride( @@ -545,7 +545,7 @@ class FamilyClassProvider Override overrideWith(FamilyClass Function() create) { return ProviderOverride( origin: this, - override: FamilyClassProvider._internal( + providerOverride: FamilyClassProvider._internal( () => create() ..first = first ..second = second diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index b65566a6b..a7356dd9e 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -115,12 +115,12 @@ class ExampleFamilyFamily extends Family { } class _$ExampleFamilyFamilyOverride implements FamilyOverride { - _$ExampleFamilyFamilyOverride(this.overriddenFamily, this.create); + _$ExampleFamilyFamilyOverride(this.from, this.create); final ExampleFamily Function() create; @override - final ExampleFamilyFamily overriddenFamily; + final ExampleFamilyFamily from; @override ExampleFamilyProvider getProviderOverride( @@ -186,7 +186,7 @@ class ExampleFamilyProvider Override overrideWith(ExampleFamily Function() create) { return ProviderOverride( origin: this, - override: ExampleFamilyProvider._internal( + providerOverride: ExampleFamilyProvider._internal( () => create() ..a = a ..b = b, @@ -319,12 +319,12 @@ class GenericFamily extends Family { } class _$GenericFamilyOverride implements FamilyOverride { - _$GenericFamilyOverride(this.overriddenFamily, this.create); + _$GenericFamilyOverride(this.from, this.create); final Generic Function() create; @override - final GenericFamily overriddenFamily; + final GenericFamily from; @override GenericProvider getProviderOverride( @@ -371,7 +371,7 @@ class GenericProvider Override overrideWith(Generic Function() create) { return ProviderOverride( origin: this, - override: GenericProvider._internal( + providerOverride: GenericProvider._internal( () => create(), from: from, name: null, diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index 6cfee54cc..2e694b5e8 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -105,12 +105,12 @@ class ExampleFamilyFamily extends Family { } class _$ExampleFamilyFamilyOverride implements FamilyOverride { - _$ExampleFamilyFamilyOverride(this.overriddenFamily, this.create); + _$ExampleFamilyFamilyOverride(this.from, this.create); final int Function(ExampleFamilyRef ref) create; @override - final ExampleFamilyFamily overriddenFamily; + final ExampleFamilyFamily from; @override ExampleFamilyProvider getProviderOverride( @@ -169,7 +169,7 @@ class ExampleFamilyProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: ExampleFamilyProvider._internal( + providerOverride: ExampleFamilyProvider._internal( (ref) => create(ref as ExampleFamilyRef), from: from, name: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index f946722de..fd79f0ae3 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -81,12 +81,12 @@ class FnFamily extends Family { } class _$FnFamilyOverride implements FamilyOverride { - _$FnFamilyOverride(this.overriddenFamily, this.create); + _$FnFamilyOverride(this.from, this.create); final int Function(FnRef ref) create; @override - final FnFamily overriddenFamily; + final FnFamily from; @override FnProvider getProviderOverride( @@ -138,7 +138,7 @@ class FnProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: FnProvider._internal( + providerOverride: FnProvider._internal( (ref) => create(ref as FnRef), from: from, name: null, @@ -282,12 +282,12 @@ class MyNotifierFamily extends Family { } class _$MyNotifierFamilyOverride implements FamilyOverride { - _$MyNotifierFamilyOverride(this.overriddenFamily, this.create); + _$MyNotifierFamilyOverride(this.from, this.create); final MyNotifier Function() create; @override - final MyNotifierFamily overriddenFamily; + final MyNotifierFamily from; @override MyNotifierProvider getProviderOverride( @@ -349,7 +349,7 @@ class MyNotifierProvider Override overrideWith(MyNotifier Function() create) { return ProviderOverride( origin: this, - override: MyNotifierProvider._internal( + providerOverride: MyNotifierProvider._internal( () => create() ..context1 = context1 ..context2 = context2, diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index e369cc34c..0815462e8 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -86,12 +86,12 @@ class GeneratedNotifierFamily extends Family { } class _$GeneratedNotifierFamilyOverride implements FamilyOverride { - _$GeneratedNotifierFamilyOverride(this.overriddenFamily, this.create); + _$GeneratedNotifierFamilyOverride(this.from, this.create); final GeneratedNotifier Function() create; @override - final GeneratedNotifierFamily overriddenFamily; + final GeneratedNotifierFamily from; @override GeneratedNotifierProvider getProviderOverride( @@ -146,7 +146,7 @@ class GeneratedNotifierProvider Override overrideWith(GeneratedNotifier Function() create) { return ProviderOverride( origin: this, - override: GeneratedNotifierProvider._internal( + providerOverride: GeneratedNotifierProvider._internal( () => create()..param = param, from: from, name: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index e66659eaf..2231cf398 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -462,12 +462,12 @@ class FamilyDepFamily extends Family { } class _$FamilyDepFamilyOverride implements FamilyOverride { - _$FamilyDepFamilyOverride(this.overriddenFamily, this.create); + _$FamilyDepFamilyOverride(this.from, this.create); final int Function(FamilyDepRef ref) create; @override - final FamilyDepFamily overriddenFamily; + final FamilyDepFamily from; @override FamilyDepProvider getProviderOverride( @@ -516,7 +516,7 @@ class FamilyDepProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: FamilyDepProvider._internal( + providerOverride: FamilyDepProvider._internal( (ref) => create(ref as FamilyDepRef), from: from, name: null, @@ -638,12 +638,12 @@ class FamilyDep2Family extends Family { } class _$FamilyDep2FamilyOverride implements FamilyOverride { - _$FamilyDep2FamilyOverride(this.overriddenFamily, this.create); + _$FamilyDep2FamilyOverride(this.from, this.create); final int Function(FamilyDep2Ref ref) create; @override - final FamilyDep2Family overriddenFamily; + final FamilyDep2Family from; @override FamilyDep2Provider getProviderOverride( @@ -693,7 +693,7 @@ class FamilyDep2Provider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: FamilyDep2Provider._internal( + providerOverride: FamilyDep2Provider._internal( (ref) => create(ref as FamilyDep2Ref), from: from, name: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 01bb30cae..cbd588bc1 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -104,12 +104,12 @@ class GenericsFamily extends Family { } class _$GenericsFamilyOverride implements FamilyOverride { - _$GenericsFamilyOverride(this.overriddenFamily, this.create); + _$GenericsFamilyOverride(this.from, this.create); final int Function(GenericsRef ref) create; @override - final GenericsFamily overriddenFamily; + final GenericsFamily from; @override GenericsProvider getProviderOverride( @@ -152,7 +152,7 @@ class GenericsProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: GenericsProvider._internal( + providerOverride: GenericsProvider._internal( (ref) => create(ref as GenericsRef), from: from, name: null, @@ -256,12 +256,12 @@ class NoGenericsFamily extends Family { } class _$NoGenericsFamilyOverride implements FamilyOverride { - _$NoGenericsFamilyOverride(this.overriddenFamily, this.create); + _$NoGenericsFamilyOverride(this.from, this.create); final int Function(NoGenericsRef ref) create; @override - final NoGenericsFamily overriddenFamily; + final NoGenericsFamily from; @override NoGenericsProvider getProviderOverride( @@ -305,7 +305,7 @@ class NoGenericsProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: NoGenericsProvider._internal( + providerOverride: NoGenericsProvider._internal( (ref) => create(ref as NoGenericsRef), from: from, name: null, @@ -408,12 +408,12 @@ class MissingGenericsFamily extends Family { } class _$MissingGenericsFamilyOverride implements FamilyOverride { - _$MissingGenericsFamilyOverride(this.overriddenFamily, this.create); + _$MissingGenericsFamilyOverride(this.from, this.create); final int Function(MissingGenericsRef ref) create; @override - final MissingGenericsFamily overriddenFamily; + final MissingGenericsFamily from; @override MissingGenericsProvider getProviderOverride( @@ -457,7 +457,7 @@ class MissingGenericsProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: MissingGenericsProvider._internal( + providerOverride: MissingGenericsProvider._internal( (ref) => create(ref as MissingGenericsRef), from: from, name: null, @@ -560,12 +560,12 @@ class WrongOrderFamily extends Family { } class _$WrongOrderFamilyOverride implements FamilyOverride { - _$WrongOrderFamilyOverride(this.overriddenFamily, this.create); + _$WrongOrderFamilyOverride(this.from, this.create); final int Function(WrongOrderRef ref) create; @override - final WrongOrderFamily overriddenFamily; + final WrongOrderFamily from; @override WrongOrderProvider getProviderOverride( @@ -609,7 +609,7 @@ class WrongOrderProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: WrongOrderProvider._internal( + providerOverride: WrongOrderProvider._internal( (ref) => create(ref as WrongOrderRef), from: from, name: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index 2dfc05797..6a59eb9f4 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -114,12 +114,12 @@ class A3Family extends Family { } class _$A3FamilyOverride implements FamilyOverride { - _$A3FamilyOverride(this.overriddenFamily, this.create); + _$A3FamilyOverride(this.from, this.create); final A3 Function() create; @override - final A3Family overriddenFamily; + final A3Family from; @override A3Provider getProviderOverride( @@ -170,7 +170,7 @@ class A3Provider extends AutoDisposeNotifierProviderImpl { Override overrideWith(A3 Function() create) { return ProviderOverride( origin: this, - override: A3Provider._internal( + providerOverride: A3Provider._internal( () => create()..param = param, from: from, name: null, @@ -294,12 +294,12 @@ class A4Family extends Family { } class _$A4FamilyOverride implements FamilyOverride { - _$A4FamilyOverride(this.overriddenFamily, this.create); + _$A4FamilyOverride(this.from, this.create); final A4 Function() create; @override - final A4Family overriddenFamily; + final A4Family from; @override A4Provider getProviderOverride( @@ -350,7 +350,7 @@ class A4Provider extends NotifierProviderImpl { Override overrideWith(A4 Function() create) { return ProviderOverride( origin: this, - override: A4Provider._internal( + providerOverride: A4Provider._internal( () => create()..param = param, from: from, name: null, @@ -473,12 +473,12 @@ class A5Family extends Family { } class _$A5FamilyOverride implements FamilyOverride { - _$A5FamilyOverride(this.overriddenFamily, this.create); + _$A5FamilyOverride(this.from, this.create); final A5 Function() create; @override - final A5Family overriddenFamily; + final A5Family from; @override A5Provider getProviderOverride( @@ -529,7 +529,7 @@ class A5Provider extends AutoDisposeAsyncNotifierProviderImpl { Override overrideWith(A5 Function() create) { return ProviderOverride( origin: this, - override: A5Provider._internal( + providerOverride: A5Provider._internal( () => create()..param = param, from: from, name: null, @@ -653,12 +653,12 @@ class A6Family extends Family { } class _$A6FamilyOverride implements FamilyOverride { - _$A6FamilyOverride(this.overriddenFamily, this.create); + _$A6FamilyOverride(this.from, this.create); final A6 Function() create; @override - final A6Family overriddenFamily; + final A6Family from; @override A6Provider getProviderOverride( @@ -709,7 +709,7 @@ class A6Provider extends AsyncNotifierProviderImpl { Override overrideWith(A6 Function() create) { return ProviderOverride( origin: this, - override: A6Provider._internal( + providerOverride: A6Provider._internal( () => create()..param = param, from: from, name: null, @@ -833,12 +833,12 @@ class A7Family extends Family { } class _$A7FamilyOverride implements FamilyOverride { - _$A7FamilyOverride(this.overriddenFamily, this.create); + _$A7FamilyOverride(this.from, this.create); final A7 Function() create; @override - final A7Family overriddenFamily; + final A7Family from; @override A7Provider getProviderOverride( @@ -889,7 +889,7 @@ class A7Provider extends AutoDisposeStreamNotifierProviderImpl { Override overrideWith(A7 Function() create) { return ProviderOverride( origin: this, - override: A7Provider._internal( + providerOverride: A7Provider._internal( () => create()..param = param, from: from, name: null, @@ -1013,12 +1013,12 @@ class A8Family extends Family { } class _$A8FamilyOverride implements FamilyOverride { - _$A8FamilyOverride(this.overriddenFamily, this.create); + _$A8FamilyOverride(this.from, this.create); final A8 Function() create; @override - final A8Family overriddenFamily; + final A8Family from; @override A8Provider getProviderOverride( @@ -1069,7 +1069,7 @@ class A8Provider extends StreamNotifierProviderImpl { Override overrideWith(A8 Function() create) { return ProviderOverride( origin: this, - override: A8Provider._internal( + providerOverride: A8Provider._internal( () => create()..param = param, from: from, name: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 3f8156b4b..08a945f6c 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -78,12 +78,12 @@ class GeneratorFamily extends Family { } class _$GeneratorFamilyOverride implements FamilyOverride { - _$GeneratorFamilyOverride(this.overriddenFamily, this.create); + _$GeneratorFamilyOverride(this.from, this.create); final int Function(GeneratorRef ref) create; @override - final GeneratorFamily overriddenFamily; + final GeneratorFamily from; @override GeneratorProvider getProviderOverride( @@ -132,7 +132,7 @@ class GeneratorProvider extends Provider { ) { return ProviderOverride( origin: this, - override: GeneratorProvider._internal( + providerOverride: GeneratorProvider._internal( (ref) => create(ref as GeneratorRef), from: from, name: null, diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 46308bff6..0b9b8e941 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -80,12 +80,12 @@ class FetchUserFamily extends Family { } class _$FetchUserFamilyOverride implements FamilyOverride { - _$FetchUserFamilyOverride(this.overriddenFamily, this.create); + _$FetchUserFamilyOverride(this.from, this.create); final FutureOr Function(FetchUserRef ref) create; @override - final FetchUserFamily overriddenFamily; + final FetchUserFamily from; @override FetchUserProvider getProviderOverride( @@ -134,7 +134,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ) { return ProviderOverride( origin: this, - override: FetchUserProvider._internal( + providerOverride: FetchUserProvider._internal( (ref) => create(ref as FetchUserRef), from: from, name: null, diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index c08d209d1..660418639 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -80,12 +80,12 @@ class ExampleFamily extends Family { } class _$ExampleFamilyOverride implements FamilyOverride { - _$ExampleFamilyOverride(this.overriddenFamily, this.create); + _$ExampleFamilyOverride(this.from, this.create); final String Function(ExampleRef ref) create; @override - final ExampleFamily overriddenFamily; + final ExampleFamily from; @override ExampleProvider getProviderOverride( @@ -134,7 +134,7 @@ class ExampleProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: ExampleProvider._internal( + providerOverride: ExampleProvider._internal( (ref) => create(ref as ExampleRef), from: from, name: null, diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index f787a49c2..e9ec23808 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -93,12 +93,12 @@ class ExampleFamily extends Family { } class _$ExampleFamilyOverride implements FamilyOverride { - _$ExampleFamilyOverride(this.overriddenFamily, this.create); + _$ExampleFamilyOverride(this.from, this.create); final Example Function() create; @override - final ExampleFamily overriddenFamily; + final ExampleFamily from; @override ExampleProvider getProviderOverride( @@ -158,7 +158,7 @@ class ExampleProvider extends AutoDisposeNotifierProviderImpl { Override overrideWith(Example Function() create) { return ProviderOverride( origin: this, - override: ExampleProvider._internal( + providerOverride: ExampleProvider._internal( () => create() ..param1 = param1 ..param2 = param2, diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index dec24ae10..e258c03e4 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -83,12 +83,12 @@ class ExampleFamily extends Family { } class _$ExampleFamilyOverride implements FamilyOverride { - _$ExampleFamilyOverride(this.overriddenFamily, this.create); + _$ExampleFamilyOverride(this.from, this.create); final String Function(ExampleRef ref) create; @override - final ExampleFamily overriddenFamily; + final ExampleFamily from; @override ExampleProvider getProviderOverride( @@ -142,7 +142,7 @@ class ExampleProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: ExampleProvider._internal( + providerOverride: ExampleProvider._internal( (ref) => create(ref as ExampleRef), from: from, name: null, diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index 8a6339941..5773207f2 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -80,12 +80,12 @@ class LabelFamily extends Family { } class _$LabelFamilyOverride implements FamilyOverride { - _$LabelFamilyOverride(this.overriddenFamily, this.create); + _$LabelFamilyOverride(this.from, this.create); final String Function(LabelRef ref) create; @override - final LabelFamily overriddenFamily; + final LabelFamily from; @override LabelProvider getProviderOverride( @@ -134,7 +134,7 @@ class LabelProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: LabelProvider._internal( + providerOverride: LabelProvider._internal( (ref) => create(ref as LabelRef), from: from, name: null, diff --git a/website/docs/essentials/passing_args/codegen/family.g.dart b/website/docs/essentials/passing_args/codegen/family.g.dart index c11d603c0..9daa74dde 100644 --- a/website/docs/essentials/passing_args/codegen/family.g.dart +++ b/website/docs/essentials/passing_args/codegen/family.g.dart @@ -80,12 +80,12 @@ class ActivityFamily extends Family { } class _$ActivityFamilyOverride implements FamilyOverride { - _$ActivityFamilyOverride(this.overriddenFamily, this.create); + _$ActivityFamilyOverride(this.from, this.create); final FutureOr Function(ActivityRef ref) create; @override - final ActivityFamily overriddenFamily; + final ActivityFamily from; @override ActivityProvider getProviderOverride( @@ -134,7 +134,7 @@ class ActivityProvider extends AutoDisposeFutureProvider { ) { return ProviderOverride( origin: this, - override: ActivityProvider._internal( + providerOverride: ActivityProvider._internal( (ref) => create(ref as ActivityRef), from: from, name: null, diff --git a/website/docs/essentials/passing_args/codegen/provider.g.dart b/website/docs/essentials/passing_args/codegen/provider.g.dart index 70093f52d..54c2f5141 100644 --- a/website/docs/essentials/passing_args/codegen/provider.g.dart +++ b/website/docs/essentials/passing_args/codegen/provider.g.dart @@ -103,12 +103,12 @@ class ActivityNotifier2Family extends Family { } class _$ActivityNotifier2FamilyOverride implements FamilyOverride { - _$ActivityNotifier2FamilyOverride(this.overriddenFamily, this.create); + _$ActivityNotifier2FamilyOverride(this.from, this.create); final ActivityNotifier2 Function() create; @override - final ActivityNotifier2Family overriddenFamily; + final ActivityNotifier2Family from; @override ActivityNotifier2Provider getProviderOverride( @@ -163,7 +163,7 @@ class ActivityNotifier2Provider Override overrideWith(ActivityNotifier2 Function() create) { return ProviderOverride( origin: this, - override: ActivityNotifier2Provider._internal( + providerOverride: ActivityNotifier2Provider._internal( () => create()..activityType = activityType, from: from, name: null, diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index d171c13e2..9f8886727 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -83,12 +83,12 @@ class RandomFamily extends Family { } class _$RandomFamilyOverride implements FamilyOverride { - _$RandomFamilyOverride(this.overriddenFamily, this.create); + _$RandomFamilyOverride(this.from, this.create); final int Function(RandomRef ref) create; @override - final RandomFamily overriddenFamily; + final RandomFamily from; @override RandomProvider getProviderOverride( @@ -142,7 +142,7 @@ class RandomProvider extends AutoDisposeProvider { ) { return ProviderOverride( origin: this, - override: RandomProvider._internal( + providerOverride: RandomProvider._internal( (ref) => create(ref as RandomRef), from: from, name: null, diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index cd7cd9edf..342aab3b7 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -84,12 +84,12 @@ class FetchPackagesFamily extends Family { } class _$FetchPackagesFamilyOverride implements FamilyOverride { - _$FetchPackagesFamilyOverride(this.overriddenFamily, this.create); + _$FetchPackagesFamilyOverride(this.from, this.create); final FutureOr> Function(FetchPackagesRef ref) create; @override - final FetchPackagesFamily overriddenFamily; + final FetchPackagesFamily from; @override FetchPackagesProvider getProviderOverride( @@ -144,7 +144,7 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { ) { return ProviderOverride( origin: this, - override: FetchPackagesProvider._internal( + providerOverride: FetchPackagesProvider._internal( (ref) => create(ref as FetchPackagesRef), from: from, name: null, diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index f348b4ea8..cb1ae6e03 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -90,12 +90,12 @@ class BugsEncounteredNotifierFamily extends Family { } class _$BugsEncounteredNotifierFamilyOverride implements FamilyOverride { - _$BugsEncounteredNotifierFamilyOverride(this.overriddenFamily, this.create); + _$BugsEncounteredNotifierFamilyOverride(this.from, this.create); final BugsEncounteredNotifier Function() create; @override - final BugsEncounteredNotifierFamily overriddenFamily; + final BugsEncounteredNotifierFamily from; @override BugsEncounteredNotifierProvider getProviderOverride( @@ -150,7 +150,7 @@ class BugsEncounteredNotifierProvider Override overrideWith(BugsEncounteredNotifier Function() create) { return ProviderOverride( origin: this, - override: BugsEncounteredNotifierProvider._internal( + providerOverride: BugsEncounteredNotifierProvider._internal( () => create()..featureId = featureId, from: from, name: null, diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 46308bff6..0b9b8e941 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -80,12 +80,12 @@ class FetchUserFamily extends Family { } class _$FetchUserFamilyOverride implements FamilyOverride { - _$FetchUserFamilyOverride(this.overriddenFamily, this.create); + _$FetchUserFamilyOverride(this.from, this.create); final FutureOr Function(FetchUserRef ref) create; @override - final FetchUserFamily overriddenFamily; + final FetchUserFamily from; @override FetchUserProvider getProviderOverride( @@ -134,7 +134,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ) { return ProviderOverride( origin: this, - override: FetchUserProvider._internal( + providerOverride: FetchUserProvider._internal( (ref) => create(ref as FetchUserRef), from: from, name: null, diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 46308bff6..0b9b8e941 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -80,12 +80,12 @@ class FetchUserFamily extends Family { } class _$FetchUserFamilyOverride implements FamilyOverride { - _$FetchUserFamilyOverride(this.overriddenFamily, this.create); + _$FetchUserFamilyOverride(this.from, this.create); final FutureOr Function(FetchUserRef ref) create; @override - final FetchUserFamily overriddenFamily; + final FetchUserFamily from; @override FetchUserProvider getProviderOverride( @@ -134,7 +134,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ) { return ProviderOverride( origin: this, - override: FetchUserProvider._internal( + providerOverride: FetchUserProvider._internal( (ref) => create(ref as FetchUserRef), from: from, name: null, diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 46308bff6..0b9b8e941 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -80,12 +80,12 @@ class FetchUserFamily extends Family { } class _$FetchUserFamilyOverride implements FamilyOverride { - _$FetchUserFamilyOverride(this.overriddenFamily, this.create); + _$FetchUserFamilyOverride(this.from, this.create); final FutureOr Function(FetchUserRef ref) create; @override - final FetchUserFamily overriddenFamily; + final FetchUserFamily from; @override FetchUserProvider getProviderOverride( @@ -134,7 +134,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ) { return ProviderOverride( origin: this, - override: FetchUserProvider._internal( + providerOverride: FetchUserProvider._internal( (ref) => create(ref as FetchUserRef), from: from, name: null, diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 46308bff6..0b9b8e941 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -80,12 +80,12 @@ class FetchUserFamily extends Family { } class _$FetchUserFamilyOverride implements FamilyOverride { - _$FetchUserFamilyOverride(this.overriddenFamily, this.create); + _$FetchUserFamilyOverride(this.from, this.create); final FutureOr Function(FetchUserRef ref) create; @override - final FetchUserFamily overriddenFamily; + final FetchUserFamily from; @override FetchUserProvider getProviderOverride( @@ -134,7 +134,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { ) { return ProviderOverride( origin: this, - override: FetchUserProvider._internal( + providerOverride: FetchUserProvider._internal( (ref) => create(ref as FetchUserRef), from: from, name: null, From a23cecb092bcc59cdfebc003da2b4d3f175f83f0 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 17 Dec 2023 13:15:26 +0100 Subject: [PATCH 071/387] ProviderContainer.test throws if there are remaining undisposed containers --- .../lib/src/framework/provider_container.dart | 95 ++++++++++++------- .../framework/provider_container_test.dart | 41 +++++++- 2 files changed, 100 insertions(+), 36 deletions(-) diff --git a/packages/riverpod/lib/src/framework/provider_container.dart b/packages/riverpod/lib/src/framework/provider_container.dart index 9fea2321d..81794902f 100644 --- a/packages/riverpod/lib/src/framework/provider_container.dart +++ b/packages/riverpod/lib/src/framework/provider_container.dart @@ -81,14 +81,21 @@ extension return scope(override: provider); } - return inherit( - /// If scoped, mount in the scope. - pointer?.mountedContainer ?? - // If not scoped and in a child container, mount in the root - currentContainer._root ?? - // We are in the root, mount here directly - currentContainer, - ); + // Where the provider should be mounted + final target = + + /// If scoped, mount in the scope. + pointer?.mountedContainer ?? + // If not scoped and in a child container, mount in the root + currentContainer._root ?? + // We are in the root, mount here directly + currentContainer; + + if (target == currentContainer) { + return scope(); + } + + return inherit(target); } } @@ -244,6 +251,8 @@ class ProviderPointerManager { List overrides, { required ProviderContainer container, }) { + if (overrides.isEmpty) return parent._pointerManager; + return ProviderPointerManager( overrides, container: container, @@ -252,29 +261,25 @@ class ProviderPointerManager { // We do so only if an override is present, for performance's sake. // We have to always clone both types if any override is present because // of the possibility of providers being overridden transitively. - orphanPointers: overrides.isNotEmpty - ? ProviderDirectory.from( - parent._pointerManager.orphanPointers, - ownerContainer: container, - ) - : parent._pointerManager.orphanPointers, - - familyPointers: overrides.isNotEmpty - ? HashMap.fromEntries( - parent._pointerManager.familyPointers.entries.map( - (e) { - if (e.key.allTransitiveDependencies == null) return e; - - if (e.value.familyOverride != null) return e; - - return MapEntry( - e.key, - ProviderDirectory.from(e.value, ownerContainer: container), - ); - }, - ), - ) - : parent._pointerManager.familyPointers, + orphanPointers: ProviderDirectory.from( + parent._pointerManager.orphanPointers, + ownerContainer: container, + ), + + familyPointers: HashMap.fromEntries( + parent._pointerManager.familyPointers.entries.map( + (e) { + if (e.key.allTransitiveDependencies == null) return e; + + if (e.value.familyOverride != null) return e; + + return MapEntry( + e.key, + ProviderDirectory.from(e.value, ownerContainer: container), + ); + }, + ), + ), ); } @@ -465,7 +470,7 @@ class ProviderPointerManager { ); } - /// Read the [ProviderElement] for a provider, without creating it if it doesn't exist. + /// Read the [ProviderElementBase] for a provider, without creating it if it doesn't exist. Iterable> listFamily(Family family) { final _familyPointers = familyPointers[family]; if (_familyPointers == null) return const []; @@ -541,6 +546,27 @@ class ProviderPointerManager { var _debugVerifyDependenciesAreRespectedEnabled = true; +int _tearDownCount = 0; + +/// A callback that disposes a [ProviderContainer] inside tests +@internal +void Function() providerContainerTestTeardown(ProviderContainer container) { + _tearDownCount++; + + return () { + container.dispose(); + + if (kDebugMode && _tearDownCount == 1) { + test.expect( + DebugRiverpodDevtoolBiding.containers, + test.isEmpty, + ); + } + + _tearDownCount--; + }; +} + /// {@template riverpod.provider_container} /// An object that stores the state of the providers and allows overriding the /// behavior of a specific provider. @@ -591,6 +617,9 @@ class ProviderContainer implements Node { /// An automatically disposed [ProviderContainer]. /// + /// This also adds an internal check at the end of tests that verifies + /// that all containers were disposed. + /// /// This constructor works only inside tests, by relying on `package:test`'s /// `addTearDown`. @visibleForTesting @@ -605,7 +634,7 @@ class ProviderContainer implements Node { overrides: overrides, observers: observers, ); - test.addTearDown(container.dispose); + test.addTearDown(providerContainerTestTeardown(container)); return container; } diff --git a/packages/riverpod/test/new/framework/provider_container_test.dart b/packages/riverpod/test/new/framework/provider_container_test.dart index 97501c1ea..b5b770556 100644 --- a/packages/riverpod/test/new/framework/provider_container_test.dart +++ b/packages/riverpod/test/new/framework/provider_container_test.dart @@ -73,7 +73,14 @@ void main() { test('returns false if the provider is not mounted', () { final root = ProviderContainer.test(); - final container = ProviderContainer.test(parent: root); + final container = ProviderContainer.test( + parent: root, + overrides: [ + // An unrelated override, added to avoid the container optimizing + // pointers away. + Provider((ref) => null), + ], + ); expect(container.pointerManager.isLocallyMounted(a), false); expect(container.pointerManager.isLocallyMounted(b), false); @@ -88,7 +95,14 @@ void main() { root.read(c); // Creating after reads, to inherit elements from root - final container = ProviderContainer.test(parent: root); + final container = ProviderContainer.test( + parent: root, + overrides: [ + // An unrelated override, added to avoid the container optimizing + // pointers away. + Provider((ref) => null), + ], + ); expect(container.pointerManager.isLocallyMounted(a), false); expect(container.pointerManager.isLocallyMounted(b), false); @@ -195,7 +209,7 @@ void main() { expect( container.pointerManager.orphanPointers, - same(root.pointerManager.orphanPointers), + isNot(root.pointerManager.orphanPointers), ); final directory = container.pointerManager.upsertDirectory(provider); @@ -857,6 +871,27 @@ void main() { addTearDown(() => expect(container.disposed, false)); }); + test( + 'last addTearDown throws if there are some remaining undisposed containers', + () async { + final container = ProviderContainer(); + addTearDown(container.dispose); + final container2 = ProviderContainer(); + addTearDown(container.dispose); + + var cb = providerContainerTestTeardown(container); + + expect( + cb, + throwsA(isA()), + reason: 'container2 is not disposed', + ); + + cb = providerContainerTestTeardown(container2); + + expect(cb, returnsNormally); + }); + test('Passes parameters', () { final provider = Provider((ref) => 0); final observer = _EmptyObserver(); From d49680a9e58aa9bcf472c4404e4dc16e04106627 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 17 Dec 2023 13:16:43 +0100 Subject: [PATCH 072/387] Msg --- packages/riverpod/lib/src/framework/provider_container.dart | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/riverpod/lib/src/framework/provider_container.dart b/packages/riverpod/lib/src/framework/provider_container.dart index 81794902f..69ed19e16 100644 --- a/packages/riverpod/lib/src/framework/provider_container.dart +++ b/packages/riverpod/lib/src/framework/provider_container.dart @@ -560,6 +560,7 @@ void Function() providerContainerTestTeardown(ProviderContainer container) { test.expect( DebugRiverpodDevtoolBiding.containers, test.isEmpty, + reason: 'All ProviderContainers must be disposed at the end of tests.', ); } From 3141ae6b197e30d3bcd2568bf209f7af8392810f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 17 Dec 2023 22:14:42 +0100 Subject: [PATCH 073/387] W --- .../riverpod/lib/src/framework/override.dart | 27 +- .../lib/src/framework/provider_container.dart | 285 ++++++++------- .../framework/provider_container_test.dart | 345 +++++++++++------- 3 files changed, 379 insertions(+), 278 deletions(-) diff --git a/packages/riverpod/lib/src/framework/override.dart b/packages/riverpod/lib/src/framework/override.dart index 80c22c36f..5622800c1 100644 --- a/packages/riverpod/lib/src/framework/override.dart +++ b/packages/riverpod/lib/src/framework/override.dart @@ -4,7 +4,11 @@ part of '../framework.dart'; /// of a provider/family for part of the application. /// /// Do not extend or implement. -sealed class Override {} +sealed class Override { + @mustBeOverridden + @override + String toString(); +} /// An object used by [ProviderContainer] to override the behavior of a provider /// for a part of the application. @@ -37,20 +41,10 @@ class _ProviderOverrideBase implements ProviderOverride { final ProviderBase providerOverride; } -/// When users pass `overrides: [provider]` to a container. -class _ManualScopeProviderOverride implements _ProviderOverrideBase { - _ManualScopeProviderOverride(this.origin); - - @override - final ProviderBase origin; - - @override - ProviderBase get providerOverride => origin; -} - /// When a provider is automatically scoped due to specifying `dependencies`. -class _TransitiveProviderOverride implements _ProviderOverrideBase { - _TransitiveProviderOverride(this.origin); +@internal +class TransitiveProviderOverride implements _ProviderOverrideBase { + TransitiveProviderOverride(this.origin); @override final ProviderBase origin; @@ -92,8 +86,9 @@ abstract class FamilyOverride implements Override { ProviderBase getProviderOverride(ProviderBase provider); } -class _TransitiveFamilyOverride implements FamilyOverride { - _TransitiveFamilyOverride(this.from); +@internal +class TransitiveFamilyOverride implements FamilyOverride { + TransitiveFamilyOverride(this.from); @override final Family from; diff --git a/packages/riverpod/lib/src/framework/provider_container.dart b/packages/riverpod/lib/src/framework/provider_container.dart index 69ed19e16..20fe1a1e2 100644 --- a/packages/riverpod/lib/src/framework/provider_container.dart +++ b/packages/riverpod/lib/src/framework/provider_container.dart @@ -11,19 +11,19 @@ ProviderBase? _circularDependencyLock; abstract class _PointerBase { /// The container in which the element of this provider will be mounted. - ProviderContainer get mountedContainer; + ProviderContainer get targetContainer; - /// The container that owns this pointer. - /// May be equal to [mountedContainer] or one of its children. - ProviderContainer get ownerContainer; + // /// The container that owns this pointer. + // /// May be equal to [targetContainer] or one of its children. + // ProviderContainer get ownerContainer; } @internal class ProviderPointer implements _PointerBase { ProviderPointer({ required this.providerOverride, - required this.mountedContainer, - required this.ownerContainer, + required this.targetContainer, + // required this.ownerContainer, }); /// The override associated with this provider, if any. @@ -34,16 +34,17 @@ class ProviderPointer implements _PointerBase { ProviderOverride? providerOverride; ProviderElementBase? element; @override - final ProviderContainer mountedContainer; - @override - final ProviderContainer ownerContainer; + final ProviderContainer targetContainer; + // @override + // final ProviderContainer ownerContainer; @override String toString() { final buffer = StringBuffer(); buffer.writeln('ProviderPointer$hashCode('); - buffer.writeln(' container: $mountedContainer'); + buffer.writeln(' targetContainer: $targetContainer'); + // buffer.writeln(' ownerContainer: $ownerContainer'); buffer.writeln(' override: $providerOverride'); buffer.writeln(' element: $element'); @@ -69,7 +70,7 @@ extension // The provider is not scoped, so can never be transitively overridden return pointer; } - if (pointer.mountedContainer == currentContainer) { + if (pointer.targetContainer == currentContainer) { // The pointer isn't inherited but rather local to the current container, // so no need to check for transitive overrides. return pointer; @@ -78,24 +79,24 @@ extension if (currentContainer._pointerManager .hasLocallyOverriddenDependency(provider)) { - return scope(override: provider); + return this[provider] = scope(override: provider); } // Where the provider should be mounted final target = /// If scoped, mount in the scope. - pointer?.mountedContainer ?? + pointer?.targetContainer ?? // If not scoped and in a child container, mount in the root currentContainer._root ?? // We are in the root, mount here directly currentContainer; if (target == currentContainer) { - return scope(); + return this[provider] = scope(); } - return inherit(target); + return this[provider] = inherit(target); } } @@ -105,22 +106,13 @@ class ProviderDirectory implements _PointerBase { ProviderContainer container, { required this.familyOverride, }) : pointers = HashMap(), - mountedContainer = container, - ownerContainer = container; + targetContainer = container; ProviderDirectory.from( - ProviderDirectory pointer, { - required this.ownerContainer, - }) : familyOverride = pointer.familyOverride, - mountedContainer = pointer.mountedContainer, - pointers = HashMap.fromEntries( - pointer.pointers.entries.where((e) { - if (e.key.allTransitiveDependencies == null) return true; - if (e.value.providerOverride != null) return true; - - return false; - }), - ); + ProviderDirectory pointer, + ) : familyOverride = pointer.familyOverride, + targetContainer = pointer.targetContainer, + pointers = HashMap.of(pointer.pointers); /// The override associated with this provider, if any. /// @@ -130,44 +122,36 @@ class ProviderDirectory implements _PointerBase { FamilyOverride? familyOverride; final HashMap, ProviderPointer> pointers; @override - final ProviderContainer mountedContainer; - @override - final ProviderContainer ownerContainer; + final ProviderContainer targetContainer; void addProviderOverride( - ProviderOverride override, - ) { + ProviderOverride override, { + required ProviderContainer targetContainer, + }) { final origin = override.origin; - final previousPointer = pointers[origin]; - - if (previousPointer != null && - previousPointer.ownerContainer == ownerContainer) { - throw StateError( - 'Cannot override a provider twice within the same container: $origin', - ); - } pointers[origin] = ProviderPointer( - mountedContainer: ownerContainer, - ownerContainer: ownerContainer, + targetContainer: targetContainer, providerOverride: override, ); } - ProviderPointer upsertPointer(ProviderBase provider) { + ProviderPointer upsertPointer( + ProviderBase provider, { + required ProviderContainer currentContainer, + }) { // TODO changelog that provider which don't specify depencies can't be scoped // TODO throw if a provider is overridden but does not specify dependencies return pointers._upsert( provider, - currentContainer: ownerContainer, + currentContainer: currentContainer, inherit: (target) => target._pointerManager.upsertPointer(provider), scope: ({override}) => ProviderPointer( - mountedContainer: ownerContainer, - ownerContainer: ownerContainer, + targetContainer: currentContainer, providerOverride: override == null // ? null - : _TransitiveProviderOverride(override), + : TransitiveProviderOverride(override), ), ); } @@ -178,11 +162,18 @@ class ProviderDirectory implements _PointerBase { /// are mounted in the current container. /// /// Non-overridden providers are mounted in the root container. - ProviderPointer mount(ProviderBase provider) { - final pointer = upsertPointer(provider); + ProviderPointer mount( + ProviderBase provider, { + required ProviderContainer currentContainer, + }) { + final pointer = upsertPointer( + provider, + currentContainer: currentContainer, + ); if (pointer.element == null) { - final element = provider.createElement(mountedContainer) + // TODO test family(42) overrides on nested containers receive the correct container + final element = provider.createElement(pointer.targetContainer) // TODO remove .._provider = pointer.providerOverride?.providerOverride ?? provider // TODO remove @@ -201,7 +192,7 @@ class ProviderDirectory implements _PointerBase { final buffer = StringBuffer(); buffer.writeln('ProviderDirectory$hashCode('); - buffer.writeln(' container: $mountedContainer'); + buffer.writeln(' targetContainer: $targetContainer'); buffer.writeln(' override: $familyOverride'); buffer.write(' pointers: {'); @@ -256,14 +247,9 @@ class ProviderPointerManager { return ProviderPointerManager( overrides, container: container, - // Cloning the parent's pointers, so that we can add new pointers without - // affecting the parent. - // We do so only if an override is present, for performance's sake. - // We have to always clone both types if any override is present because - // of the possibility of providers being overridden transitively. + // Always folks orphan pointers, because of possible transitive overrides. orphanPointers: ProviderDirectory.from( parent._pointerManager.orphanPointers, - ownerContainer: container, ), familyPointers: HashMap.fromEntries( @@ -271,12 +257,9 @@ class ProviderPointerManager { (e) { if (e.key.allTransitiveDependencies == null) return e; - if (e.value.familyOverride != null) return e; + // TODO don't fork a family if no family(42) is overridden - return MapEntry( - e.key, - ProviderDirectory.from(e.value, ownerContainer: container), - ); + return MapEntry(e.key, ProviderDirectory.from(e.value)); }, ), ), @@ -284,83 +267,95 @@ class ProviderPointerManager { } final ProviderContainer container; - ProviderDirectory orphanPointers; + final ProviderDirectory orphanPointers; final HashMap familyPointers; - /// Creates a local pointer for a [Family], while preserving parent state. - ProviderDirectory _scopeProviderDirectory( - Family? family, { - FamilyOverride? override, - }) { - final pointer = family == null ? orphanPointers : familyPointers[family]; - - ProviderDirectory? newDirectory; - if (pointer != null) { - // The family is already overridden in this container. No need to fork. - // This is purely an optimization. - if (pointer.mountedContainer == container) return pointer; - - if (override == null) { - // Fork a parent pointer, to keep its state but allow local modifications. - newDirectory = ProviderDirectory.from( - pointer, - ownerContainer: container, - ); - } - } + // /// Creates a local pointer for a [Family], while preserving parent state. + // ProviderDirectory _scopeProviderDirectory( + // Family? family, { + // FamilyOverride? override, + // }) { + // final pointer = family == null ? orphanPointers : familyPointers[family]; + + // ProviderDirectory? newDirectory; + // if (pointer != null) { + // // The family is already overridden in this container. No need to fork. + // // This is purely an optimization. + // if (pointer.targetContainer == container) return pointer; + + // if (override == null) { + // // Fork a parent pointer, to keep its state but allow local modifications. + // newDirectory = ProviderDirectory.from( + // pointer, + // ownerContainer: container, + // ); + // } + // } + + // newDirectory ??= ProviderDirectory.empty( + // container, + // familyOverride: override, + // ); + + // if (family == null) { + // orphanPointers = newDirectory; + // } else { + // familyPointers[family] = newDirectory; + // } + + // return newDirectory; + // } - newDirectory ??= ProviderDirectory.empty( - container, - familyOverride: override, - ); + void _initializeProviderOverride( + ProviderOverride override, + ) { + final from = override.origin.from; - if (family == null) { - orphanPointers = newDirectory; - } else { - familyPointers[family] = newDirectory; + if (from == null) { + orphanPointers.addProviderOverride( + override, + targetContainer: container, + ); + return; } - return newDirectory; - } + final familyPointer = familyPointers[from] ??= ProviderDirectory.empty( + // TODO use rootOrSelf + container._root ?? container, + familyOverride: null, + ); - void _initializeProviderOverride( - ProviderOverride override, - ) { - // Overriding a provider from a family, but not the whole family. - // We don't want to modify the parent's family pointers, - // therefore we need to fork the inherited family pointers. - _scopeProviderDirectory(override.origin.from).addProviderOverride(override); - // TODO: test that scoping a family provider does not impact the parent - // TODO test that scoping a family provider does not impact other non-overridden providers from that family + familyPointer.addProviderOverride( + override, + targetContainer: container, + ); } void _initializeOverrides(List overrides) { for (final override in overrides) { switch (override) { - case ProviderBase(): - _initializeProviderOverride( - _ManualScopeProviderOverride(override), - ); case ProviderOverride(): _initializeProviderOverride(override); case FamilyOverride(): final overriddenFamily = override.from; final previousPointer = familyPointers[overriddenFamily]; - if (previousPointer != null && - previousPointer.mountedContainer == container && - previousPointer.familyOverride != null) { - throw StateError( - 'Cannot override a family twice within the same container: $overriddenFamily', + if (previousPointer != null) { + /// A provider from that family was overridden first. + /// We override the family but preserve the provider override too. + + previousPointer.familyOverride = override; + // Remove inherited family values and keep only local ones + previousPointer.pointers.removeWhere( + (key, value) => value.targetContainer != container, ); + return; } - final pointer = _scopeProviderDirectory( - overriddenFamily, - override: override, + familyPointers[overriddenFamily] = ProviderDirectory.empty( + container, + familyOverride: override, ); - - pointer.familyOverride = override; } } } @@ -374,10 +369,10 @@ class ProviderPointerManager { switch (provider) { case ProviderBase(): - container = readPointer(provider)?.mountedContainer ?? - readDirectory(provider)?.mountedContainer; + container = readPointer(provider)?.targetContainer ?? + readDirectory(provider)?.targetContainer; case Family(): - container = familyPointers[provider]?.mountedContainer; + container = familyPointers[provider]?.targetContainer; } return container == this.container; @@ -409,15 +404,12 @@ class ProviderPointerManager { return familyPointers._upsert( family, currentContainer: container, - inherit: (target) => ProviderDirectory.from( - target._pointerManager._mountFamily(family), - ownerContainer: target, - ), + inherit: (target) => target._pointerManager._mountFamily(family), scope: ({override}) => ProviderDirectory.empty( container, familyOverride: override == null // ? null - : _TransitiveFamilyOverride(override), + : TransitiveFamilyOverride(override), ), ); } @@ -452,7 +444,10 @@ class ProviderPointerManager { } ProviderPointer upsertPointer(ProviderBase provider) { - return upsertDirectory(provider).mount(provider); + return upsertDirectory(provider).mount( + provider, + currentContainer: container, + ); } ProviderElementBase upsertElement(ProviderBase provider) { @@ -462,10 +457,10 @@ class ProviderPointerManager { /// Traverse the [ProviderElementBase]s associated with this [ProviderContainer]. Iterable listProviderPointers() { return orphanPointers.pointers.values - .where((pointer) => pointer.mountedContainer == container) + .where((pointer) => pointer.targetContainer == container) .followedBy( familyPointers.values - .where((pointer) => pointer.mountedContainer == container) + .where((pointer) => pointer.targetContainer == container) .expand((e) => e.pointers.values), ); } @@ -601,6 +596,26 @@ class ProviderContainer implements Node { } } + if (kDebugMode) { + final overrideOrigins = {}; + for (final override in overrides) { + switch (override) { + case ProviderOverride(): + if (!overrideOrigins.add(override.origin)) { + throw AssertionError( + 'Tried to override a provider twice within the same container: ${override.origin}', + ); + } + case FamilyOverride(): + if (!overrideOrigins.add(override.from)) { + throw AssertionError( + 'Tried to override a family twice within the same container: ${override.from}', + ); + } + } + } + } + _pointerManager = parent != null ? ProviderPointerManager.from(parent, overrides, container: this) : ProviderPointerManager( @@ -713,7 +728,11 @@ class ProviderContainer implements Node { /// {@macro riverpod.exists} bool exists(ProviderBase provider) { - return _pointerManager.readDirectory(provider)?.pointers[provider] != null; + return _pointerManager + .readDirectory(provider) + ?.pointers[provider] + ?.element != + null; } /// Executes [ProviderElementBase.debugReassemble] on all the providers. @@ -856,7 +875,7 @@ class ProviderContainer implements Node { if (kDebugMode) { debugValidateOverride( pointer?.providerOverride, - override.providerOverride.runtimeType, + override.runtimeType, ); } @@ -1010,7 +1029,7 @@ final b = Provider((ref) => ref.watch(a), dependencies: [a]); // get providers that don't depend on other providers from this container for (final pointer in _pointerManager.listProviderPointers()) { - if (pointer.mountedContainer != this) continue; + if (pointer.targetContainer != this) continue; final element = pointer.element; if (element == null) continue; diff --git a/packages/riverpod/test/new/framework/provider_container_test.dart b/packages/riverpod/test/new/framework/provider_container_test.dart index b5b770556..bce3b2590 100644 --- a/packages/riverpod/test/new/framework/provider_container_test.dart +++ b/packages/riverpod/test/new/framework/provider_container_test.dart @@ -10,7 +10,7 @@ const _sentinel = Object(); TypeMatcher isPointer({ Object? override = _sentinel, Object? element = _sentinel, - Object? container = _sentinel, + Object? targetContainer = _sentinel, }) { var matcher = isA(); @@ -22,17 +22,34 @@ TypeMatcher isPointer({ matcher = matcher.having((p) => p.element, 'element', element); } - if (container != _sentinel) { - matcher = matcher.having((p) => p.mountedContainer, 'container', container); + if (targetContainer != _sentinel) { + matcher = matcher.having( + (p) => p.targetContainer, + 'targetContainer', + targetContainer, + ); } return matcher; } +TypeMatcher isTransitiveFamilyOverride( + Object? family, +) { + return isA().having((f) => f.from, 'from', family); +} + +TypeMatcher isTransitiveProviderOverride( + Object? provider, +) { + return isA() + .having((f) => f.origin, 'origin', provider); +} + TypeMatcher isProviderDirectory({ Object? override = _sentinel, Object? pointers = _sentinel, - Object? container = _sentinel, + Object? targetContainer = _sentinel, }) { var matcher = isA(); @@ -44,8 +61,12 @@ TypeMatcher isProviderDirectory({ matcher = matcher.having((p) => p.pointers, 'pointers', pointers); } - if (container != _sentinel) { - matcher = matcher.having((p) => p.mountedContainer, 'container', container); + if (targetContainer != _sentinel) { + matcher = matcher.having( + (p) => p.targetContainer, + 'targetContainer', + targetContainer, + ); } return matcher; @@ -58,7 +79,7 @@ void main() { }); group('ProviderPointerManager', () { - group('hasLocallyOverriddenDependency', () { + group('isLocallyMounted', () { final a = Provider((_) => 0); final b = Provider.family((_, __) => 0); final c = Provider.family((_, __) => 0)(42); @@ -139,7 +160,13 @@ void main() { test('always returns false if has no dependency', () { final provider = Provider((_) => 0); final root = ProviderContainer.test(); - final container = ProviderContainer.test(parent: root); + final container = ProviderContainer.test( + parent: root, + overrides: [ + // Unrelated override, to avoid the container optimizing the pointer away + Provider((ref) => null), + ], + ); expect( container.pointerManager.hasLocallyOverriddenDependency(provider), @@ -196,52 +223,45 @@ void main() { }); group('upsertDirectory', () { - test('on orphan with a family dependency, forks the directory', () { - final dependency = Provider.family((ref, id) => 0); - final provider = Provider((ref) => 0, dependencies: [dependency]); + test('handles auto-scoping', () { + final dep = Provider((_) => 0); + final family = Provider.family( + (ref, id) => 0, + dependencies: [dep], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, - overrides: [ - dependency.overrideWith((ref, arg) => 0), - ], + overrides: [dep.overrideWithValue(42)], ); + final directory = container.pointerManager.upsertDirectory(family(42)); + expect( - container.pointerManager.orphanPointers, - isNot(root.pointerManager.orphanPointers), + directory, + isProviderDirectory( + targetContainer: container, + override: isTransitiveFamilyOverride(family), + pointers: isEmpty, + ), ); - final directory = container.pointerManager.upsertDirectory(provider); - expect( - container.pointerManager.orphanPointers, - isNot(root.pointerManager.orphanPointers), + container.pointerManager.familyPointers, + {family: directory}, ); - expect(container.pointerManager.orphanPointers, directory); + // Check that the root was unaffected expect( - directory, - isProviderDirectory( - container: root, - override: null, - pointers: { - dependency(42): isPointer( - container: container, - override: null, - element: null, - ), - }, - ), + root.pointerManager.familyPointers, + isEmpty, + ); + expect( + root.pointerManager.orphanPointers.pointers, + isEmpty, ); }); - test( - 'on family with orphan dependency, forks the directory', - () {}, - skip: 'TODO', - ); - test('on orphans, return orphanPointers', () { final provider = Provider((_) => 0); final container = ProviderContainer.test(); @@ -253,7 +273,7 @@ void main() { expect( directory, isProviderDirectory( - container: container, + targetContainer: container, override: null, pointers: isEmpty, ), @@ -276,7 +296,7 @@ void main() { expect( directory, isProviderDirectory( - container: container, + targetContainer: container, override: null, pointers: isEmpty, ), @@ -313,7 +333,7 @@ void main() { expect( directory, isProviderDirectory( - container: container, + targetContainer: container, override: isNotNull, pointers: isEmpty, ), @@ -322,6 +342,106 @@ void main() { }); group('upsertPointer', () { + test('handles auto-scoping', () { + final dep = Provider((_) => 0); + final family = Provider.family( + (ref, id) => 0, + dependencies: [dep], + ); + final provider = Provider((_) => 0, dependencies: [dep]); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [dep.overrideWithValue(42)], + ); + + final pointer = container.pointerManager.upsertPointer(family(42)); + final pointer2 = container.pointerManager.upsertPointer(provider); + + expect( + pointer, + isPointer( + targetContainer: container, + override: isTransitiveProviderOverride(family(42)), + ), + ); + expect( + pointer2, + isPointer( + targetContainer: container, + override: isTransitiveProviderOverride(provider), + ), + ); + + expect( + container.pointerManager.familyPointers, + { + family: isProviderDirectory( + targetContainer: container, + override: isTransitiveFamilyOverride(family), + pointers: { + family(42): pointer, + }, + ), + }, + ); + expect( + container.pointerManager.orphanPointers, + isProviderDirectory( + targetContainer: root, + override: null, + pointers: { + provider: pointer2, + dep: isNotNull, + }, + ), + ); + + // Check that the root was unaffected + expect( + root.pointerManager.familyPointers, + isEmpty, + ); + expect( + root.pointerManager.orphanPointers.pointers, + isEmpty, + ); + }); + + test( + 'have ancestors and children share their pointers when not overridden', + () { + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [ + // An unrelated override, added to avoid the container optimizing + Provider((_) => 0), + ], + ); + final provider = Provider((ref) => 0); + final family = Provider.family((ref, id) => 0); + + root.read(provider); + root.read(family(42)); + container.read(provider); + container.read(family(42)); + + expect( + container.pointerManager.orphanPointers.pointers[provider], + same(root.pointerManager.orphanPointers.pointers[provider]), + ); + + expect( + container.pointerManager.familyPointers[family]!.pointers, + { + family(42): same( + root.pointerManager.familyPointers[family]!.pointers[family(42)], + ), + }, + ); + }); + test('on orphans, insert in orphanPointers', () { final provider = Provider((_) => 0); final container = ProviderContainer.test(); @@ -336,7 +456,7 @@ void main() { expect( pointer, isPointer( - container: container, + targetContainer: container, override: null, element: isNotNull, ), @@ -359,7 +479,7 @@ void main() { expect( pointer, isPointer( - container: container, + targetContainer: container, override: null, element: isNotNull, ), @@ -442,13 +562,13 @@ void main() { final provider = Provider((ref) => 0); expect( - () => ProviderContainer( + () => ProviderContainer.test( overrides: [ provider.overrideWithValue(42), provider.overrideWithValue(21), ], ), - throwsStateError, + throwsA(isA()), ); }); @@ -459,13 +579,13 @@ void main() { final provider = Provider.family((ref, id) => 0); expect( - () => ProviderContainer( + () => ProviderContainer.test( overrides: [ provider.overrideWith((ref, arg) => arg), provider.overrideWith((ref, arg) => arg), ], ), - throwsStateError, + throwsA(isA()), ); }); @@ -510,7 +630,10 @@ void main() { group('pointers', () { test('has "container" pointing to "this"', () { final root = ProviderContainer.test(); - final container = ProviderContainer.test(parent: root); + final container = ProviderContainer.test(parent: root, overrides: [ + // An unrelated override, added to avoid the container optimizing + Provider((_) => 0), + ]); expect(root.pointerManager.container, root); expect(container.pointerManager.container, container); @@ -520,70 +643,30 @@ void main() { test('orphansPointers.container points to the root', () { final root = ProviderContainer.test(); - expect(root.pointerManager.orphanPointers.mountedContainer, root); + expect(root.pointerManager.orphanPointers.targetContainer, root); }); }); group('on scoped containers', () { - test('reuses orphanPointers instance if there are no orphan overrides', - () { - final family = Provider.family((ref, id) => 0); - final root = ProviderContainer.test(); - final container = ProviderContainer.test( - parent: root, - overrides: [ - family.overrideWith((ref, arg) => arg), - family(42).overrideWith((ref) => 42), - ], - ); - - expect( - container.pointerManager.orphanPointers, - same(root.pointerManager.orphanPointers), - ); - - expect( - container.pointerManager.familyPointers, - isNot(root.pointerManager.familyPointers), - ); - }); - - test('reuses familyPointers instance if there are no family overrides', - () { - final provider = Provider((_) => 0); - final root = ProviderContainer.test(); - final container = ProviderContainer.test( - parent: root, - overrides: [provider.overrideWith((ref) => 0)], - ); - - expect( - container.pointerManager.familyPointers, - same(root.pointerManager.familyPointers), - ); - - expect( - container.pointerManager.orphanPointers, - isNot(root.pointerManager.orphanPointers), - ); - }); - test('inherits overrides from its parents', () { - final a = Provider((_) => 0); + final a = Provider((_) => 0, name: 'a'); final aOverride = a.overrideWithValue(1); - final b = Provider((_) => 0); + final b = Provider((_) => 0, name: 'b'); final bOverride = b.overrideWithValue(2); - final c = Provider((_) => 0); + final c = Provider((_) => 0, name: 'c'); final cOverride = c.overrideWithValue(3); - final aFamily = Provider.family((_, __) => 0); + final aFamily = + Provider.family((_, __) => 0, name: 'aFamily'); final aFamilyOverride = aFamily.overrideWith((_, __) => 1); - final aValueOverride = aFamily(42).overrideWith((_) => 2); - final bFamily = Provider.family((_, __) => 0); + final aValueOverride = aFamily(1).overrideWith((_) => 2); + final bFamily = + Provider.family((_, __) => 0, name: 'bFamily'); final bFamilyOverride = bFamily.overrideWith((_, __) => 2); - final bValueOverride = bFamily(42).overrideWith((_) => 3); - final cFamily = Provider.family((_, __) => 0); + final bValueOverride = bFamily(2).overrideWith((_) => 3); + final cFamily = + Provider.family((_, __) => 0, name: 'cFamily'); final cFamilyOverride = cFamily.overrideWith((_, __) => 3); - final cValueOverride = cFamily(42).overrideWith((_) => 4); + final cValueOverride = cFamily(3).overrideWith((_) => 4); final root = ProviderContainer.test( overrides: [aOverride, aFamilyOverride, aValueOverride], @@ -602,33 +685,33 @@ void main() { { aFamily: isProviderDirectory( override: aFamilyOverride, - container: root, + targetContainer: root, pointers: { - aFamily(42): isPointer( + aFamily(1): isPointer( override: aValueOverride, - container: root, + targetContainer: root, element: null, ), }, ), bFamily: isProviderDirectory( override: bFamilyOverride, - container: mid, + targetContainer: mid, pointers: { - bFamily(42): isPointer( + bFamily(2): isPointer( override: bValueOverride, - container: mid, + targetContainer: mid, element: null, ), }, ), cFamily: isProviderDirectory( override: cFamilyOverride, - container: container, + targetContainer: container, pointers: { - cFamily(42): isPointer( + cFamily(3): isPointer( override: cValueOverride, - container: container, + targetContainer: container, element: null, ), }, @@ -639,22 +722,22 @@ void main() { expect( container.pointerManager.orphanPointers, isProviderDirectory( - container: root, + targetContainer: root, override: null, pointers: { a: isPointer( override: aOverride, - container: root, + targetContainer: root, element: null, ), b: isPointer( override: bOverride, - container: mid, + targetContainer: mid, element: null, ), c: isPointer( override: cOverride, - container: container, + targetContainer: container, element: null, ), }, @@ -690,7 +773,9 @@ void main() { ); }); - test('orphanPointers.container is always equal to root', () { + // TODO throw if trying to scope a provider/family with no dependencies + + test('orphanPointers.containers are always equal to root', () { final root = ProviderContainer.test(); final provider = Provider((_) => 0); final container = ProviderContainer.test( @@ -698,15 +783,17 @@ void main() { overrides: [provider], ); - expect(root.pointerManager.orphanPointers.mountedContainer, root); + expect(root.pointerManager.orphanPointers.targetContainer, root); expect( - container.pointerManager.orphanPointers.mountedContainer, root); + container.pointerManager.orphanPointers.targetContainer, + root, + ); expect( container.pointerManager.orphanPointers.pointers, { provider: isPointer( - container: container, + targetContainer: container, override: provider, element: null, ), @@ -730,11 +817,11 @@ void main() { expect( root.pointerManager.orphanPointers, isProviderDirectory( - container: root, + targetContainer: root, override: null, pointers: { provider: isPointer( - container: root, + targetContainer: root, override: override, element: null, ), @@ -749,11 +836,11 @@ void main() { expect( container.pointerManager.orphanPointers, isProviderDirectory( - container: root2, + targetContainer: root2, override: null, pointers: { provider: isPointer( - container: container, + targetContainer: container, override: override, element: null, ), @@ -779,7 +866,7 @@ void main() { { provider: isProviderDirectory( override: override, - container: root, + targetContainer: root, pointers: isEmpty, ), }, @@ -794,7 +881,7 @@ void main() { { provider: isProviderDirectory( override: override, - container: container, + targetContainer: container, pointers: isEmpty, ), }, @@ -819,10 +906,10 @@ void main() { { provider: isProviderDirectory( override: null, - container: root, + targetContainer: root, pointers: { provider(42): isPointer( - container: root, + targetContainer: root, override: override, element: null, ), @@ -846,10 +933,10 @@ void main() { { provider: isProviderDirectory( override: null, - container: container, + targetContainer: root2, pointers: { provider(42): isPointer( - container: container, + targetContainer: container, override: override, element: null, ), From d9103b761ac6df04ba9f5bfade4490828c42db66 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 17 Dec 2023 22:31:13 +0100 Subject: [PATCH 074/387] Fix all new --- .../lib/src/framework/provider_container.dart | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/packages/riverpod/lib/src/framework/provider_container.dart b/packages/riverpod/lib/src/framework/provider_container.dart index 20fe1a1e2..3e6735a9b 100644 --- a/packages/riverpod/lib/src/framework/provider_container.dart +++ b/packages/riverpod/lib/src/framework/provider_container.dart @@ -163,21 +163,24 @@ class ProviderDirectory implements _PointerBase { /// /// Non-overridden providers are mounted in the root container. ProviderPointer mount( - ProviderBase provider, { + ProviderBase origin, { required ProviderContainer currentContainer, }) { final pointer = upsertPointer( - provider, + origin, currentContainer: currentContainer, ); if (pointer.element == null) { + final overrideProvider = + pointer.providerOverride?.providerOverride ?? origin; + // TODO test family(42) overrides on nested containers receive the correct container - final element = provider.createElement(pointer.targetContainer) + final element = overrideProvider.createElement(pointer.targetContainer) // TODO remove - .._provider = pointer.providerOverride?.providerOverride ?? provider + .._provider = overrideProvider // TODO remove - .._origin = provider + .._origin = origin // TODO make this optional ..mount(); pointer.element = element; From d3863079ad29ed7fe0703a889a7e2b0cef7fded4 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 22 Dec 2023 15:43:20 +0100 Subject: [PATCH 075/387] Fix errs --- .../{old/framework => new}/result_test.dart | 0 .../framework/provider_container_test.dart | 32 +++++----- .../test/old/framework/ref_watch_test.dart | 2 +- .../async_notifier/async_notifier_test.dart | 58 ------------------- .../future_provider/future_provider_test.dart | 6 -- .../old/providers/notifier/notifier_test.dart | 46 --------------- .../old/providers/provider/provider_test.dart | 5 -- .../stream_notifier/async_notifier_test.dart | 28 --------- .../stream_provider/stream_provider_test.dart | 6 -- 9 files changed, 17 insertions(+), 166 deletions(-) rename packages/riverpod/test/{old/framework => new}/result_test.dart (100%) diff --git a/packages/riverpod/test/old/framework/result_test.dart b/packages/riverpod/test/new/result_test.dart similarity index 100% rename from packages/riverpod/test/old/framework/result_test.dart rename to packages/riverpod/test/new/result_test.dart diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 27fff2f52..23ee58d69 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -29,24 +29,24 @@ void main() { fireImmediately: true, ); - expect(a.hasStateReaderFor(provider), true); - expect(b.hasStateReaderFor(provider), false); - expect(c.hasStateReaderFor(provider), false); - expect(d.hasStateReaderFor(provider), true); + expect(a.pointerManager.isLocallyMounted(provider), true); + expect(b.pointerManager.isLocallyMounted(provider), false); + expect(c.pointerManager.isLocallyMounted(provider), false); + expect(d.pointerManager.isLocallyMounted(provider), true); subscription.close(); - expect(a.hasStateReaderFor(provider), true); - expect(b.hasStateReaderFor(provider), false); - expect(c.hasStateReaderFor(provider), false); - expect(d.hasStateReaderFor(provider), true); + expect(a.pointerManager.isLocallyMounted(provider), true); + expect(b.pointerManager.isLocallyMounted(provider), false); + expect(c.pointerManager.isLocallyMounted(provider), false); + expect(d.pointerManager.isLocallyMounted(provider), true); await a.pump(); - expect(a.hasStateReaderFor(provider), false); - expect(b.hasStateReaderFor(provider), false); - expect(c.hasStateReaderFor(provider), false); - expect(d.hasStateReaderFor(provider), false); + expect(a.pointerManager.isLocallyMounted(provider), false); + expect(b.pointerManager.isLocallyMounted(provider), false); + expect(c.pointerManager.isLocallyMounted(provider), false); + expect(d.pointerManager.isLocallyMounted(provider), false); d.listen( provider, @@ -54,10 +54,10 @@ void main() { fireImmediately: true, ); - expect(a.hasStateReaderFor(provider), true); - expect(b.hasStateReaderFor(provider), false); - expect(c.hasStateReaderFor(provider), false); - expect(d.hasStateReaderFor(provider), true); + expect(a.pointerManager.isLocallyMounted(provider), true); + expect(b.pointerManager.isLocallyMounted(provider), false); + expect(c.pointerManager.isLocallyMounted(provider), false); + expect(d.pointerManager.isLocallyMounted(provider), true); }); }); diff --git a/packages/riverpod/test/old/framework/ref_watch_test.dart b/packages/riverpod/test/old/framework/ref_watch_test.dart index e9e00ed92..d60d78873 100644 --- a/packages/riverpod/test/old/framework/ref_watch_test.dart +++ b/packages/riverpod/test/old/framework/ref_watch_test.dart @@ -452,7 +452,7 @@ void main() { test('Provider.family', () async { final computed = - Provider.family>((ref, provider) { + Provider.family>((ref, provider) { return ref.watch(provider).toString(); }); final notifier = Counter(); diff --git a/packages/riverpod/test/old/providers/async_notifier/async_notifier_test.dart b/packages/riverpod/test/old/providers/async_notifier/async_notifier_test.dart index c1689759b..9f29665f7 100644 --- a/packages/riverpod/test/old/providers/async_notifier/async_notifier_test.dart +++ b/packages/riverpod/test/old/providers/async_notifier/async_notifier_test.dart @@ -1067,18 +1067,10 @@ void main() { }); group('modifiers', () { - void canBeAssignedToAlwaysAliveRefreshable( - AlwaysAliveRefreshable provider, - ) {} - void canBeAssignedToRefreshable( Refreshable provider, ) {} - void canBeAssignedToAlwaysAliveListenable( - AlwaysAliveProviderListenable provider, - ) {} - void canBeAssignedToProviderListenable( ProviderListenable provider, ) {} @@ -1094,23 +1086,13 @@ void main() { provider.selectAsync((int value) => 0); canBeAssignedToProviderListenable>(provider); - canBeAssignedToAlwaysAliveListenable>(provider); canBeAssignedToRefreshable>(provider); - canBeAssignedToAlwaysAliveRefreshable>(provider); canBeAssignedToProviderListenable>(provider.future); - canBeAssignedToAlwaysAliveListenable>(provider.future); canBeAssignedToRefreshable>(provider.future); - canBeAssignedToAlwaysAliveRefreshable>(provider.future); canBeAssignedToProviderListenable>(provider.notifier); - canBeAssignedToAlwaysAliveListenable>( - provider.notifier, - ); canBeAssignedToRefreshable>(provider.notifier); - canBeAssignedToAlwaysAliveRefreshable>( - provider.notifier, - ); }); test('autoDispose', () { @@ -1123,27 +1105,17 @@ void main() { autoDispose.selectAsync((int value) => 0); canBeAssignedToProviderListenable>(autoDispose); - // canBeAssignedToAlwaysAliveListenable>(autoDispose); canBeAssignedToRefreshable>(autoDispose); - // canBeAssignedToAlwaysAliveRefreshable>(autoDispose); canBeAssignedToProviderListenable>(autoDispose.future); - // canBeAssignedToAlwaysAliveListenable>(autoDispose.future); canBeAssignedToRefreshable>(autoDispose.future); - // canBeAssignedToAlwaysAliveRefreshable>(autoDispose.future); canBeAssignedToProviderListenable>( autoDispose.notifier, ); - // canBeAssignedToAlwaysAliveListenable>( - // autoDispose.notifier, - // ); canBeAssignedToRefreshable>( autoDispose.notifier, ); - // canBeAssignedToAlwaysAliveRefreshable>( - // autoDispose.notifier, - // ); }); test('family', () { @@ -1156,27 +1128,17 @@ void main() { family(0).selectAsync((String value) => 0); canBeAssignedToProviderListenable>(family(0)); - canBeAssignedToAlwaysAliveListenable>(family(0)); canBeAssignedToRefreshable>(family(0)); - canBeAssignedToAlwaysAliveRefreshable>(family(0)); canBeAssignedToProviderListenable>(family(0).future); - canBeAssignedToAlwaysAliveListenable>(family(0).future); canBeAssignedToRefreshable>(family(0).future); - canBeAssignedToAlwaysAliveRefreshable>(family(0).future); canBeAssignedToProviderListenable>( family(0).notifier, ); - canBeAssignedToAlwaysAliveListenable>( - family(0).notifier, - ); canBeAssignedToRefreshable>( family(0).notifier, ); - canBeAssignedToAlwaysAliveRefreshable>( - family(0).notifier, - ); }); test('autoDisposeFamily', () { @@ -1196,44 +1158,24 @@ void main() { canBeAssignedToProviderListenable>( autoDisposeFamily(0), ); - // canBeAssignedToAlwaysAliveListenable>( - // autoDisposeFamily(0), - // ); canBeAssignedToRefreshable>( autoDisposeFamily(0), ); - // canBeAssignedToAlwaysAliveRefreshable>( - // autoDisposeFamily(0), - // ); canBeAssignedToProviderListenable>( autoDisposeFamily(0).future, ); - // canBeAssignedToAlwaysAliveListenable>( - // autoDisposeFamily(0).future, - // ); canBeAssignedToRefreshable>( autoDisposeFamily(0).future, ); - // canBeAssignedToAlwaysAliveRefreshable>( - // autoDisposeFamily(0).future, - // ); canBeAssignedToProviderListenable< AutoDisposeFamilyAsyncNotifier>( autoDisposeFamily(0).notifier, ); - // canBeAssignedToAlwaysAliveListenable< - // AutoDisposeFamilyAsyncNotifier>( - // autoDisposeFamily(0).notifier, - // ); canBeAssignedToRefreshable>( autoDisposeFamily(0).notifier, ); - // canBeAssignedToAlwaysAliveRefreshable< - // AutoDisposeFamilyAsyncNotifier>( - // autoDisposeFamily(0).notifier, - // ); }); }); } diff --git a/packages/riverpod/test/old/providers/future_provider/future_provider_test.dart b/packages/riverpod/test/old/providers/future_provider/future_provider_test.dart index 2dab1e3cf..01f6c88d5 100644 --- a/packages/riverpod/test/old/providers/future_provider/future_provider_test.dart +++ b/packages/riverpod/test/old/providers/future_provider/future_provider_test.dart @@ -562,12 +562,6 @@ void main() { // No errors are reported to the zone }); - test('is AlwaysAliveProviderBase', () { - final provider = FutureProvider((_) async => 42); - - expect(provider, isA>>()); - }); - group('FutureProvider().future', () { test('does not update dependents when the future completes', () async { final completer = Completer.sync(); diff --git a/packages/riverpod/test/old/providers/notifier/notifier_test.dart b/packages/riverpod/test/old/providers/notifier/notifier_test.dart index 20f35c6ac..3beaf3898 100644 --- a/packages/riverpod/test/old/providers/notifier/notifier_test.dart +++ b/packages/riverpod/test/old/providers/notifier/notifier_test.dart @@ -606,18 +606,10 @@ void main() { }); group('modifiers', () { - void canBeAssignedToAlwaysAliveRefreshable( - AlwaysAliveRefreshable provider, - ) {} - void canBeAssignedToRefreshable( Refreshable provider, ) {} - void canBeAssignedToAlwaysAliveListenable( - AlwaysAliveProviderListenable provider, - ) {} - void canBeAssignedToProviderListenable( ProviderListenable provider, ) {} @@ -632,18 +624,10 @@ void main() { provider.select((int value) => 0); canBeAssignedToProviderListenable(provider); - canBeAssignedToAlwaysAliveListenable(provider); canBeAssignedToRefreshable(provider); - canBeAssignedToAlwaysAliveRefreshable(provider); canBeAssignedToProviderListenable>(provider.notifier); - canBeAssignedToAlwaysAliveListenable>( - provider.notifier, - ); canBeAssignedToRefreshable>(provider.notifier); - canBeAssignedToAlwaysAliveRefreshable>( - provider.notifier, - ); }); test('autoDispose', () { @@ -655,22 +639,14 @@ void main() { autoDispose.select((int value) => 0); canBeAssignedToProviderListenable(autoDispose); - // canBeAssignedToAlwaysAliveListenable(autoDispose); canBeAssignedToRefreshable(autoDispose); - // canBeAssignedToAlwaysAliveRefreshable(autoDispose); canBeAssignedToProviderListenable>( autoDispose.notifier, ); - // canBeAssignedToAlwaysAliveListenable>( - // autoDispose.notifier, - // ); canBeAssignedToRefreshable>( autoDispose.notifier, ); - // canBeAssignedToAlwaysAliveRefreshable>( - // autoDispose.notifier, - // ); }); test('family', () { @@ -682,22 +658,14 @@ void main() { family(0).select((String value) => 0); canBeAssignedToProviderListenable(family(0)); - canBeAssignedToAlwaysAliveListenable(family(0)); canBeAssignedToRefreshable(family(0)); - canBeAssignedToAlwaysAliveRefreshable(family(0)); canBeAssignedToProviderListenable>( family(0).notifier, ); - canBeAssignedToAlwaysAliveListenable>( - family(0).notifier, - ); canBeAssignedToRefreshable>( family(0).notifier, ); - canBeAssignedToAlwaysAliveRefreshable>( - family(0).notifier, - ); }); test('autoDisposeFamily', () { @@ -716,30 +684,16 @@ void main() { canBeAssignedToProviderListenable( autoDisposeFamily(0), ); - // canBeAssignedToAlwaysAliveListenable( - // autoDisposeFamily(0), - // ); canBeAssignedToRefreshable( autoDisposeFamily(0), ); - // canBeAssignedToAlwaysAliveRefreshable( - // autoDisposeFamily(0), - // ); canBeAssignedToProviderListenable>( autoDisposeFamily(0).notifier, ); - // canBeAssignedToAlwaysAliveListenable< - // AutoDisposeFamilyNotifier>( - // autoDisposeFamily(0).notifier, - // ); canBeAssignedToRefreshable>( autoDisposeFamily(0).notifier, ); - // canBeAssignedToAlwaysAliveRefreshable< - // AutoDisposeFamilyNotifier>( - // autoDisposeFamily(0).notifier, - // ); }); }); } diff --git a/packages/riverpod/test/old/providers/provider/provider_test.dart b/packages/riverpod/test/old/providers/provider/provider_test.dart index be4be6707..74b825f7e 100644 --- a/packages/riverpod/test/old/providers/provider/provider_test.dart +++ b/packages/riverpod/test/old/providers/provider/provider_test.dart @@ -230,11 +230,6 @@ void main() { expect(provider2.name, isNull); }); - - test('is AlwaysAliveProviderBase', () { - // ignore: unused_local_variable, testing that Provider can be assigned to AlwaysAliveProviderBase - final AlwaysAliveProviderBase provider = Provider((_) => 42); - }); }); test('dispose', () { diff --git a/packages/riverpod/test/old/providers/stream_notifier/async_notifier_test.dart b/packages/riverpod/test/old/providers/stream_notifier/async_notifier_test.dart index d72fa124a..5ec7b7215 100644 --- a/packages/riverpod/test/old/providers/stream_notifier/async_notifier_test.dart +++ b/packages/riverpod/test/old/providers/stream_notifier/async_notifier_test.dart @@ -1007,18 +1007,10 @@ void main() { }); group('modifiers', () { - void canBeAssignedToAlwaysAliveRefreshable( - AlwaysAliveRefreshable provider, - ) {} - void canBeAssignedToRefreshable( Refreshable provider, ) {} - void canBeAssignedToAlwaysAliveListenable( - AlwaysAliveProviderListenable provider, - ) {} - void canBeAssignedToProviderListenable( ProviderListenable provider, ) {} @@ -1034,23 +1026,13 @@ void main() { provider.selectAsync((int value) => 0); canBeAssignedToProviderListenable>(provider); - canBeAssignedToAlwaysAliveListenable>(provider); canBeAssignedToRefreshable>(provider); - canBeAssignedToAlwaysAliveRefreshable>(provider); canBeAssignedToProviderListenable>(provider.future); - canBeAssignedToAlwaysAliveListenable>(provider.future); canBeAssignedToRefreshable>(provider.future); - canBeAssignedToAlwaysAliveRefreshable>(provider.future); canBeAssignedToProviderListenable>(provider.notifier); - canBeAssignedToAlwaysAliveListenable>( - provider.notifier, - ); canBeAssignedToRefreshable>(provider.notifier); - canBeAssignedToAlwaysAliveRefreshable>( - provider.notifier, - ); }); test('autoDispose', () { @@ -1096,27 +1078,17 @@ void main() { family(0).selectAsync((String value) => 0); canBeAssignedToProviderListenable>(family(0)); - canBeAssignedToAlwaysAliveListenable>(family(0)); canBeAssignedToRefreshable>(family(0)); - canBeAssignedToAlwaysAliveRefreshable>(family(0)); canBeAssignedToProviderListenable>(family(0).future); - canBeAssignedToAlwaysAliveListenable>(family(0).future); canBeAssignedToRefreshable>(family(0).future); - canBeAssignedToAlwaysAliveRefreshable>(family(0).future); canBeAssignedToProviderListenable>( family(0).notifier, ); - canBeAssignedToAlwaysAliveListenable>( - family(0).notifier, - ); canBeAssignedToRefreshable>( family(0).notifier, ); - canBeAssignedToAlwaysAliveRefreshable>( - family(0).notifier, - ); }); test('autoDisposeFamily', () { diff --git a/packages/riverpod/test/old/providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/providers/stream_provider/stream_provider_test.dart index 1ff2e69d4..e1e4df33f 100644 --- a/packages/riverpod/test/old/providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/providers/stream_provider/stream_provider_test.dart @@ -761,12 +761,6 @@ void main() { expect(provider2.name, isNull); }); - test('is AlwaysAliveProviderBase', () { - final provider = StreamProvider((_) async* {}); - - expect(provider, isA>>()); - }); - test('subscribe exposes loading synchronously then value on change', () async { final container = createContainer(); From 81bd548d6fb3c0239e151972ac8fd5f31d58fb14 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 22 Dec 2023 15:53:22 +0100 Subject: [PATCH 076/387] Move things around --- .../lib/flutter_riverpod.dart | 2 +- .../flutter_riverpod/lib/src/internals.dart | 3 +- .../src/{ => legacy/deprecated}/builders.dart | 2 +- .../deprecated}/change_notifier_provider.dart | 0 .../auto_dispose.dart | 0 .../change_notifier_provider/base.dart | 0 packages/riverpod/lib/riverpod.dart | 18 +++++------ .../riverpod/lib/src/{ => common}/env.dart | 0 .../lib/src/{ => common}/listenable.dart | 4 +-- .../riverpod/lib/src/{ => common}/pragma.dart | 0 .../riverpod/lib/src/{ => common}/result.dart | 0 .../lib/src/{ => common}/run_guarded.dart | 0 .../lib/src/{ => common}/stack_trace.dart | 0 .../lib/src/{ => common}/tenable.dart | 0 .../{framework => core}/async_selector.dart | 0 .../{common.dart => core/async_value.dart} | 8 ++--- .../src/{framework => core}/auto_dispose.dart | 0 .../lib/src/{framework => core}/devtool.dart | 0 .../lib/src/{framework => core}/element.dart | 0 .../lib/src/{framework => core}/family.dart | 0 .../src/{framework => core}/foundation.dart | 0 .../lib/src/{framework => core}/listen.dart | 0 .../lib/src/{framework => core}/override.dart | 0 .../{framework => core}/provider_base.dart | 0 .../provider_container.dart | 0 .../proxy_provider_listenable.dart | 0 .../lib/src/{framework => core}/ref.dart | 0 .../src/{framework => core}/scheduler.dart | 0 .../lib/src/{framework => core}/selector.dart | 0 .../{framework => core}/value_provider.dart | 0 packages/riverpod/lib/src/framework.dart | 32 +++++++++---------- .../lib/src/framework2/framework.dart | 2 +- .../generated_providers/future_provider.dart | 2 +- .../generated_providers/sync_provider.dart | 2 +- packages/riverpod/lib/src/internals.dart | 26 +++++++-------- .../async_notifier.dart | 12 +++---- .../async_notifier/auto_dispose.dart | 0 .../async_notifier/auto_dispose_family.dart | 0 .../async_notifier/base.dart | 0 .../async_notifier/family.dart | 0 .../src/{ => legacy_providers}/builders.dart | 2 +- .../deprecated}/state_controller.dart | 0 .../deprecated}/state_notifier_provider.dart | 2 +- .../state_notifier_provider/auto_dispose.dart | 0 .../state_notifier_provider/base.dart | 0 .../deprecated}/state_provider.dart | 2 +- .../state_provider/auto_dispose.dart | 0 .../deprecated}/state_provider/base.dart | 0 .../future_provider.dart | 4 +-- .../future_provider/auto_dispose.dart | 0 .../future_provider/base.dart | 0 .../src/{ => legacy_providers}/notifier.dart | 6 ++-- .../notifier/auto_dispose.dart | 0 .../notifier/auto_dispose_family.dart | 0 .../{ => legacy_providers}/notifier/base.dart | 0 .../notifier/family.dart | 0 .../src/{ => legacy_providers}/provider.dart | 4 +-- .../provider/auto_dispose.dart | 0 .../{ => legacy_providers}/provider/base.dart | 0 .../stream_notifier.dart | 0 .../stream_notifier/auto_dispose.dart | 0 .../stream_notifier/auto_dispose_family.dart | 0 .../stream_notifier/base.dart | 0 .../stream_notifier/family.dart | 0 .../stream_provider.dart | 8 ++--- .../stream_provider/auto_dispose.dart | 0 .../stream_provider/base.dart | 0 packages/riverpod/test/new/result_test.dart | 2 +- .../test/old/framework/modifiers_test.dart | 2 +- 69 files changed, 73 insertions(+), 72 deletions(-) rename packages/flutter_riverpod/lib/src/{ => legacy/deprecated}/builders.dart (99%) rename packages/flutter_riverpod/lib/src/{ => legacy/deprecated}/change_notifier_provider.dart (100%) rename packages/flutter_riverpod/lib/src/{ => legacy/deprecated}/change_notifier_provider/auto_dispose.dart (100%) rename packages/flutter_riverpod/lib/src/{ => legacy/deprecated}/change_notifier_provider/base.dart (100%) rename packages/riverpod/lib/src/{ => common}/env.dart (100%) rename packages/riverpod/lib/src/{ => common}/listenable.dart (99%) rename packages/riverpod/lib/src/{ => common}/pragma.dart (100%) rename packages/riverpod/lib/src/{ => common}/result.dart (100%) rename packages/riverpod/lib/src/{ => common}/run_guarded.dart (100%) rename packages/riverpod/lib/src/{ => common}/stack_trace.dart (100%) rename packages/riverpod/lib/src/{ => common}/tenable.dart (100%) rename packages/riverpod/lib/src/{framework => core}/async_selector.dart (100%) rename packages/riverpod/lib/src/{common.dart => core/async_value.dart} (99%) rename packages/riverpod/lib/src/{framework => core}/auto_dispose.dart (100%) rename packages/riverpod/lib/src/{framework => core}/devtool.dart (100%) rename packages/riverpod/lib/src/{framework => core}/element.dart (100%) rename packages/riverpod/lib/src/{framework => core}/family.dart (100%) rename packages/riverpod/lib/src/{framework => core}/foundation.dart (100%) rename packages/riverpod/lib/src/{framework => core}/listen.dart (100%) rename packages/riverpod/lib/src/{framework => core}/override.dart (100%) rename packages/riverpod/lib/src/{framework => core}/provider_base.dart (100%) rename packages/riverpod/lib/src/{framework => core}/provider_container.dart (100%) rename packages/riverpod/lib/src/{framework => core}/proxy_provider_listenable.dart (100%) rename packages/riverpod/lib/src/{framework => core}/ref.dart (100%) rename packages/riverpod/lib/src/{framework => core}/scheduler.dart (100%) rename packages/riverpod/lib/src/{framework => core}/selector.dart (100%) rename packages/riverpod/lib/src/{framework => core}/value_provider.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/async_notifier.dart (97%) rename packages/riverpod/lib/src/{ => legacy_providers}/async_notifier/auto_dispose.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/async_notifier/auto_dispose_family.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/async_notifier/base.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/async_notifier/family.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/builders.dart (99%) rename packages/riverpod/lib/src/{ => legacy_providers/deprecated}/state_controller.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers/deprecated}/state_notifier_provider.dart (97%) rename packages/riverpod/lib/src/{ => legacy_providers/deprecated}/state_notifier_provider/auto_dispose.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers/deprecated}/state_notifier_provider/base.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers/deprecated}/state_provider.dart (96%) rename packages/riverpod/lib/src/{ => legacy_providers/deprecated}/state_provider/auto_dispose.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers/deprecated}/state_provider/base.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/future_provider.dart (98%) rename packages/riverpod/lib/src/{ => legacy_providers}/future_provider/auto_dispose.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/future_provider/base.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/notifier.dart (98%) rename packages/riverpod/lib/src/{ => legacy_providers}/notifier/auto_dispose.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/notifier/auto_dispose_family.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/notifier/base.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/notifier/family.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/provider.dart (87%) rename packages/riverpod/lib/src/{ => legacy_providers}/provider/auto_dispose.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/provider/base.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/stream_notifier.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/stream_notifier/auto_dispose.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/stream_notifier/auto_dispose_family.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/stream_notifier/base.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/stream_notifier/family.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/stream_provider.dart (88%) rename packages/riverpod/lib/src/{ => legacy_providers}/stream_provider/auto_dispose.dart (100%) rename packages/riverpod/lib/src/{ => legacy_providers}/stream_provider/base.dart (100%) diff --git a/packages/flutter_riverpod/lib/flutter_riverpod.dart b/packages/flutter_riverpod/lib/flutter_riverpod.dart index 1dc14b407..b794bb112 100644 --- a/packages/flutter_riverpod/lib/flutter_riverpod.dart +++ b/packages/flutter_riverpod/lib/flutter_riverpod.dart @@ -1,6 +1,6 @@ // ignore: invalid_export_of_internal_element export 'package:riverpod/riverpod.dart'; -export 'src/change_notifier_provider.dart'; +export 'src/legacy/deprecated/change_notifier_provider.dart'; export 'src/consumer.dart'; export 'src/framework.dart' hide ProviderScopeState; diff --git a/packages/flutter_riverpod/lib/src/internals.dart b/packages/flutter_riverpod/lib/src/internals.dart index 8609c050b..6395cb62b 100644 --- a/packages/flutter_riverpod/lib/src/internals.dart +++ b/packages/flutter_riverpod/lib/src/internals.dart @@ -1,4 +1,5 @@ export 'package:riverpod/src/internals.dart'; -export 'change_notifier_provider.dart'; + export 'consumer.dart'; export 'framework.dart'; +export 'legacy/deprecated/change_notifier_provider.dart'; diff --git a/packages/flutter_riverpod/lib/src/builders.dart b/packages/flutter_riverpod/lib/src/legacy/deprecated/builders.dart similarity index 99% rename from packages/flutter_riverpod/lib/src/builders.dart rename to packages/flutter_riverpod/lib/src/legacy/deprecated/builders.dart index 65ac6e094..e0b5ef94b 100644 --- a/packages/flutter_riverpod/lib/src/builders.dart +++ b/packages/flutter_riverpod/lib/src/legacy/deprecated/builders.dart @@ -11,7 +11,7 @@ // ignore_for_file: invalid_use_of_internal_member import 'package:flutter/foundation.dart'; -import 'internals.dart'; +import '../../internals.dart'; /// Builds a [ChangeNotifierProvider]. class ChangeNotifierProviderBuilder { diff --git a/packages/flutter_riverpod/lib/src/change_notifier_provider.dart b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider.dart similarity index 100% rename from packages/flutter_riverpod/lib/src/change_notifier_provider.dart rename to packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider.dart diff --git a/packages/flutter_riverpod/lib/src/change_notifier_provider/auto_dispose.dart b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart similarity index 100% rename from packages/flutter_riverpod/lib/src/change_notifier_provider/auto_dispose.dart rename to packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart diff --git a/packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart similarity index 100% rename from packages/flutter_riverpod/lib/src/change_notifier_provider/base.dart rename to packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index ed1d33c94..1cb8110c6 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -1,6 +1,6 @@ export 'package:state_notifier/state_notifier.dart' hide Listener, LocatorMixin; -export 'src/async_notifier.dart' +export 'src/legacy_providers/async_notifier.dart' hide AsyncNotifierProviderImpl, AutoDisposeAsyncNotifierProviderImpl, @@ -20,7 +20,7 @@ export 'src/async_notifier.dart' BuildlessAutoDisposeStreamNotifier, BuildlessStreamNotifier; -export 'src/common.dart' hide AsyncTransition; +export 'src/core/async_value.dart' hide AsyncTransition; export 'src/framework.dart' hide @@ -54,9 +54,9 @@ export 'src/framework.dart' ProviderContainerTest, DebugRiverpodDevtoolBiding; -export 'src/future_provider.dart'; +export 'src/legacy_providers/future_provider.dart'; -export 'src/notifier.dart' +export 'src/legacy_providers/notifier.dart' hide NotifierBase, NotifierProviderBase, @@ -67,8 +67,8 @@ export 'src/notifier.dart' BuildlessAutoDisposeNotifier, BuildlessNotifier; -export 'src/provider.dart' hide InternalProvider; -export 'src/state_controller.dart'; -export 'src/state_notifier_provider.dart'; -export 'src/state_provider.dart'; -export 'src/stream_provider.dart'; +export 'src/legacy_providers/provider.dart' hide InternalProvider; +export 'src/legacy_providers/deprecated/state_controller.dart'; +export 'src/legacy_providers/deprecated/state_notifier_provider.dart'; +export 'src/legacy_providers/deprecated/state_provider.dart'; +export 'src/legacy_providers/stream_provider.dart'; diff --git a/packages/riverpod/lib/src/env.dart b/packages/riverpod/lib/src/common/env.dart similarity index 100% rename from packages/riverpod/lib/src/env.dart rename to packages/riverpod/lib/src/common/env.dart diff --git a/packages/riverpod/lib/src/listenable.dart b/packages/riverpod/lib/src/common/listenable.dart similarity index 99% rename from packages/riverpod/lib/src/listenable.dart rename to packages/riverpod/lib/src/common/listenable.dart index 06de51841..0e9ff1820 100644 --- a/packages/riverpod/lib/src/listenable.dart +++ b/packages/riverpod/lib/src/common/listenable.dart @@ -1,7 +1,7 @@ import 'package:meta/meta.dart'; -import 'framework.dart' show ProviderElementBase; -import 'internals.dart' show OnError; +import '../framework.dart' show ProviderElementBase; +import '../internals.dart' show OnError; import 'pragma.dart'; import 'result.dart'; diff --git a/packages/riverpod/lib/src/pragma.dart b/packages/riverpod/lib/src/common/pragma.dart similarity index 100% rename from packages/riverpod/lib/src/pragma.dart rename to packages/riverpod/lib/src/common/pragma.dart diff --git a/packages/riverpod/lib/src/result.dart b/packages/riverpod/lib/src/common/result.dart similarity index 100% rename from packages/riverpod/lib/src/result.dart rename to packages/riverpod/lib/src/common/result.dart diff --git a/packages/riverpod/lib/src/run_guarded.dart b/packages/riverpod/lib/src/common/run_guarded.dart similarity index 100% rename from packages/riverpod/lib/src/run_guarded.dart rename to packages/riverpod/lib/src/common/run_guarded.dart diff --git a/packages/riverpod/lib/src/stack_trace.dart b/packages/riverpod/lib/src/common/stack_trace.dart similarity index 100% rename from packages/riverpod/lib/src/stack_trace.dart rename to packages/riverpod/lib/src/common/stack_trace.dart diff --git a/packages/riverpod/lib/src/tenable.dart b/packages/riverpod/lib/src/common/tenable.dart similarity index 100% rename from packages/riverpod/lib/src/tenable.dart rename to packages/riverpod/lib/src/common/tenable.dart diff --git a/packages/riverpod/lib/src/framework/async_selector.dart b/packages/riverpod/lib/src/core/async_selector.dart similarity index 100% rename from packages/riverpod/lib/src/framework/async_selector.dart rename to packages/riverpod/lib/src/core/async_selector.dart diff --git a/packages/riverpod/lib/src/common.dart b/packages/riverpod/lib/src/core/async_value.dart similarity index 99% rename from packages/riverpod/lib/src/common.dart rename to packages/riverpod/lib/src/core/async_value.dart index 1138940ae..dfe8e4097 100644 --- a/packages/riverpod/lib/src/common.dart +++ b/packages/riverpod/lib/src/core/async_value.dart @@ -1,9 +1,9 @@ import 'package:meta/meta.dart'; -import 'framework.dart'; -import 'future_provider.dart' show FutureProvider; -import 'stack_trace.dart'; -import 'stream_provider.dart' show StreamProvider; +import '../framework.dart'; +import '../legacy_providers/future_provider.dart' show FutureProvider; +import '../common/stack_trace.dart'; +import '../legacy_providers/stream_provider.dart' show StreamProvider; /// An extension for [asyncTransition]. @internal diff --git a/packages/riverpod/lib/src/framework/auto_dispose.dart b/packages/riverpod/lib/src/core/auto_dispose.dart similarity index 100% rename from packages/riverpod/lib/src/framework/auto_dispose.dart rename to packages/riverpod/lib/src/core/auto_dispose.dart diff --git a/packages/riverpod/lib/src/framework/devtool.dart b/packages/riverpod/lib/src/core/devtool.dart similarity index 100% rename from packages/riverpod/lib/src/framework/devtool.dart rename to packages/riverpod/lib/src/core/devtool.dart diff --git a/packages/riverpod/lib/src/framework/element.dart b/packages/riverpod/lib/src/core/element.dart similarity index 100% rename from packages/riverpod/lib/src/framework/element.dart rename to packages/riverpod/lib/src/core/element.dart diff --git a/packages/riverpod/lib/src/framework/family.dart b/packages/riverpod/lib/src/core/family.dart similarity index 100% rename from packages/riverpod/lib/src/framework/family.dart rename to packages/riverpod/lib/src/core/family.dart diff --git a/packages/riverpod/lib/src/framework/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart similarity index 100% rename from packages/riverpod/lib/src/framework/foundation.dart rename to packages/riverpod/lib/src/core/foundation.dart diff --git a/packages/riverpod/lib/src/framework/listen.dart b/packages/riverpod/lib/src/core/listen.dart similarity index 100% rename from packages/riverpod/lib/src/framework/listen.dart rename to packages/riverpod/lib/src/core/listen.dart diff --git a/packages/riverpod/lib/src/framework/override.dart b/packages/riverpod/lib/src/core/override.dart similarity index 100% rename from packages/riverpod/lib/src/framework/override.dart rename to packages/riverpod/lib/src/core/override.dart diff --git a/packages/riverpod/lib/src/framework/provider_base.dart b/packages/riverpod/lib/src/core/provider_base.dart similarity index 100% rename from packages/riverpod/lib/src/framework/provider_base.dart rename to packages/riverpod/lib/src/core/provider_base.dart diff --git a/packages/riverpod/lib/src/framework/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart similarity index 100% rename from packages/riverpod/lib/src/framework/provider_container.dart rename to packages/riverpod/lib/src/core/provider_container.dart diff --git a/packages/riverpod/lib/src/framework/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart similarity index 100% rename from packages/riverpod/lib/src/framework/proxy_provider_listenable.dart rename to packages/riverpod/lib/src/core/proxy_provider_listenable.dart diff --git a/packages/riverpod/lib/src/framework/ref.dart b/packages/riverpod/lib/src/core/ref.dart similarity index 100% rename from packages/riverpod/lib/src/framework/ref.dart rename to packages/riverpod/lib/src/core/ref.dart diff --git a/packages/riverpod/lib/src/framework/scheduler.dart b/packages/riverpod/lib/src/core/scheduler.dart similarity index 100% rename from packages/riverpod/lib/src/framework/scheduler.dart rename to packages/riverpod/lib/src/core/scheduler.dart diff --git a/packages/riverpod/lib/src/framework/selector.dart b/packages/riverpod/lib/src/core/selector.dart similarity index 100% rename from packages/riverpod/lib/src/framework/selector.dart rename to packages/riverpod/lib/src/core/selector.dart diff --git a/packages/riverpod/lib/src/framework/value_provider.dart b/packages/riverpod/lib/src/core/value_provider.dart similarity index 100% rename from packages/riverpod/lib/src/framework/value_provider.dart rename to packages/riverpod/lib/src/core/value_provider.dart diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index a2a5a69aa..e5ad17d48 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -7,21 +7,21 @@ import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; import 'package:state_notifier/state_notifier.dart'; import 'package:test/test.dart' as test; -import 'env.dart'; +import 'common/env.dart'; import 'internals.dart'; -part 'framework/auto_dispose.dart'; -part 'framework/async_selector.dart'; -part 'framework/provider_base.dart'; -part 'framework/element.dart'; -part 'framework/provider_container.dart'; -part 'framework/family.dart'; -part 'framework/listen.dart'; -part 'framework/foundation.dart'; -part 'framework/proxy_provider_listenable.dart'; -part 'framework/ref.dart'; -part 'framework/selector.dart'; -part 'framework/scheduler.dart'; -part 'framework/value_provider.dart'; -part 'framework/override.dart'; -part 'framework/devtool.dart'; +part 'core/auto_dispose.dart'; +part 'core/async_selector.dart'; +part 'core/provider_base.dart'; +part 'core/element.dart'; +part 'core/provider_container.dart'; +part 'core/family.dart'; +part 'core/listen.dart'; +part 'core/foundation.dart'; +part 'core/proxy_provider_listenable.dart'; +part 'core/ref.dart'; +part 'core/selector.dart'; +part 'core/scheduler.dart'; +part 'core/value_provider.dart'; +part 'core/override.dart'; +part 'core/devtool.dart'; diff --git a/packages/riverpod/lib/src/framework2/framework.dart b/packages/riverpod/lib/src/framework2/framework.dart index 77ab0bd95..6fd1d6e0d 100644 --- a/packages/riverpod/lib/src/framework2/framework.dart +++ b/packages/riverpod/lib/src/framework2/framework.dart @@ -5,7 +5,7 @@ import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; import 'package:test/test.dart' as test; -import '../common.dart'; +import '../core/async_value.dart'; import '../tenable.dart'; part 'provider_container.dart'; diff --git a/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart b/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart index cca27ffeb..67ec63454 100644 --- a/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart +++ b/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart @@ -2,7 +2,7 @@ import 'dart:async'; import 'package:meta/meta.dart'; -import '../../common.dart'; +import '../../core/async_value.dart'; import '../framework.dart'; abstract base class AsyncProvider extends Provider> { diff --git a/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart b/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart index 049208d18..522d74ced 100644 --- a/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart +++ b/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart @@ -1,6 +1,6 @@ import 'package:meta/meta.dart'; -import '../../common.dart'; +import '../../core/async_value.dart'; import '../framework.dart'; abstract base class SyncProvider extends Provider { diff --git a/packages/riverpod/lib/src/internals.dart b/packages/riverpod/lib/src/internals.dart index 425a30feb..65b8c9e3a 100644 --- a/packages/riverpod/lib/src/internals.dart +++ b/packages/riverpod/lib/src/internals.dart @@ -5,17 +5,17 @@ /// It is used by the flutter and hooks implementation, but is not stable. library internals; -export 'async_notifier.dart'; -export 'builders.dart'; -export 'common.dart'; +export 'legacy_providers/builders.dart'; +export 'common/listenable.dart'; +export 'common/result.dart'; +export 'common/run_guarded.dart'; +export 'common/stack_trace.dart'; +export 'core/async_value.dart'; export 'framework.dart'; -export 'future_provider.dart'; -export 'listenable.dart'; -export 'notifier.dart'; -export 'provider.dart'; -export 'result.dart'; -export 'run_guarded.dart'; -export 'stack_trace.dart'; -export 'state_notifier_provider.dart'; -export 'state_provider.dart'; -export 'stream_provider.dart'; +export 'legacy_providers/async_notifier.dart'; +export 'legacy_providers/deprecated/state_notifier_provider.dart'; +export 'legacy_providers/deprecated/state_provider.dart'; +export 'legacy_providers/future_provider.dart'; +export 'legacy_providers/notifier.dart'; +export 'legacy_providers/provider.dart'; +export 'legacy_providers/stream_provider.dart'; diff --git a/packages/riverpod/lib/src/async_notifier.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier.dart similarity index 97% rename from packages/riverpod/lib/src/async_notifier.dart rename to packages/riverpod/lib/src/legacy_providers/async_notifier.dart index 06118c071..61d5396e6 100644 --- a/packages/riverpod/lib/src/async_notifier.dart +++ b/packages/riverpod/lib/src/legacy_providers/async_notifier.dart @@ -3,14 +3,14 @@ import 'dart:async'; import 'package:meta/meta.dart'; import 'builders.dart'; -import 'common.dart'; -import 'framework.dart'; +import '../common/run_guarded.dart'; +import '../core/async_value.dart'; +import '../framework.dart'; import 'future_provider.dart' show FutureProvider; -import 'listenable.dart'; +import '../common/listenable.dart'; import 'notifier.dart'; -import 'pragma.dart'; -import 'result.dart'; -import 'run_guarded.dart'; +import '../common/pragma.dart'; +import '../common/result.dart'; import 'stream_provider.dart'; part 'async_notifier/auto_dispose.dart'; diff --git a/packages/riverpod/lib/src/async_notifier/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose.dart similarity index 100% rename from packages/riverpod/lib/src/async_notifier/auto_dispose.dart rename to packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose.dart diff --git a/packages/riverpod/lib/src/async_notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose_family.dart similarity index 100% rename from packages/riverpod/lib/src/async_notifier/auto_dispose_family.dart rename to packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose_family.dart diff --git a/packages/riverpod/lib/src/async_notifier/base.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/base.dart similarity index 100% rename from packages/riverpod/lib/src/async_notifier/base.dart rename to packages/riverpod/lib/src/legacy_providers/async_notifier/base.dart diff --git a/packages/riverpod/lib/src/async_notifier/family.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart similarity index 100% rename from packages/riverpod/lib/src/async_notifier/family.dart rename to packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart diff --git a/packages/riverpod/lib/src/builders.dart b/packages/riverpod/lib/src/legacy_providers/builders.dart similarity index 99% rename from packages/riverpod/lib/src/builders.dart rename to packages/riverpod/lib/src/legacy_providers/builders.dart index ea966b9f5..2e069c501 100644 --- a/packages/riverpod/lib/src/builders.dart +++ b/packages/riverpod/lib/src/legacy_providers/builders.dart @@ -11,7 +11,7 @@ import 'dart:async'; import 'package:state_notifier/state_notifier.dart'; -import 'internals.dart'; +import '../internals.dart'; /// Builds a [AsyncNotifierProvider]. class AsyncNotifierProviderBuilder { diff --git a/packages/riverpod/lib/src/state_controller.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_controller.dart similarity index 100% rename from packages/riverpod/lib/src/state_controller.dart rename to packages/riverpod/lib/src/legacy_providers/deprecated/state_controller.dart diff --git a/packages/riverpod/lib/src/state_notifier_provider.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider.dart similarity index 97% rename from packages/riverpod/lib/src/state_notifier_provider.dart rename to packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider.dart index 79784d3df..ef4853d46 100644 --- a/packages/riverpod/lib/src/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider.dart @@ -1,7 +1,7 @@ import 'package:meta/meta.dart'; import 'package:state_notifier/state_notifier.dart'; -import 'internals.dart'; +import '../../internals.dart'; part 'state_notifier_provider/auto_dispose.dart'; part 'state_notifier_provider/base.dart'; diff --git a/packages/riverpod/lib/src/state_notifier_provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/auto_dispose.dart similarity index 100% rename from packages/riverpod/lib/src/state_notifier_provider/auto_dispose.dart rename to packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/auto_dispose.dart diff --git a/packages/riverpod/lib/src/state_notifier_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart similarity index 100% rename from packages/riverpod/lib/src/state_notifier_provider/base.dart rename to packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart diff --git a/packages/riverpod/lib/src/state_provider.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider.dart similarity index 96% rename from packages/riverpod/lib/src/state_provider.dart rename to packages/riverpod/lib/src/legacy_providers/deprecated/state_provider.dart index 67be8f21c..653f4e0dc 100644 --- a/packages/riverpod/lib/src/state_provider.dart +++ b/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider.dart @@ -1,6 +1,6 @@ import 'package:meta/meta.dart'; -import 'internals.dart'; +import '../../internals.dart'; import 'state_controller.dart'; part 'state_provider/auto_dispose.dart'; diff --git a/packages/riverpod/lib/src/state_provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/auto_dispose.dart similarity index 100% rename from packages/riverpod/lib/src/state_provider/auto_dispose.dart rename to packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/auto_dispose.dart diff --git a/packages/riverpod/lib/src/state_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart similarity index 100% rename from packages/riverpod/lib/src/state_provider/base.dart rename to packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart diff --git a/packages/riverpod/lib/src/future_provider.dart b/packages/riverpod/lib/src/legacy_providers/future_provider.dart similarity index 98% rename from packages/riverpod/lib/src/future_provider.dart rename to packages/riverpod/lib/src/legacy_providers/future_provider.dart index b9419269c..c5326b678 100644 --- a/packages/riverpod/lib/src/future_provider.dart +++ b/packages/riverpod/lib/src/legacy_providers/future_provider.dart @@ -4,8 +4,8 @@ import 'package:meta/meta.dart'; import 'async_notifier.dart'; import 'builders.dart'; -import 'common.dart'; -import 'framework.dart'; +import '../core/async_value.dart'; +import '../framework.dart'; import 'provider.dart' show Provider; import 'stream_provider.dart' show StreamProvider; diff --git a/packages/riverpod/lib/src/future_provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/future_provider/auto_dispose.dart similarity index 100% rename from packages/riverpod/lib/src/future_provider/auto_dispose.dart rename to packages/riverpod/lib/src/legacy_providers/future_provider/auto_dispose.dart diff --git a/packages/riverpod/lib/src/future_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/future_provider/base.dart similarity index 100% rename from packages/riverpod/lib/src/future_provider/base.dart rename to packages/riverpod/lib/src/legacy_providers/future_provider/base.dart diff --git a/packages/riverpod/lib/src/notifier.dart b/packages/riverpod/lib/src/legacy_providers/notifier.dart similarity index 98% rename from packages/riverpod/lib/src/notifier.dart rename to packages/riverpod/lib/src/legacy_providers/notifier.dart index b7a8480dd..6b87f1356 100644 --- a/packages/riverpod/lib/src/notifier.dart +++ b/packages/riverpod/lib/src/legacy_providers/notifier.dart @@ -2,10 +2,10 @@ import 'package:meta/meta.dart'; import 'async_notifier.dart'; import 'builders.dart'; -import 'framework.dart'; -import 'listenable.dart'; +import '../framework.dart'; +import '../common/listenable.dart'; import 'provider.dart'; -import 'result.dart'; +import '../common/result.dart'; part 'notifier/auto_dispose.dart'; part 'notifier/auto_dispose_family.dart'; diff --git a/packages/riverpod/lib/src/notifier/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose.dart similarity index 100% rename from packages/riverpod/lib/src/notifier/auto_dispose.dart rename to packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose.dart diff --git a/packages/riverpod/lib/src/notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose_family.dart similarity index 100% rename from packages/riverpod/lib/src/notifier/auto_dispose_family.dart rename to packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose_family.dart diff --git a/packages/riverpod/lib/src/notifier/base.dart b/packages/riverpod/lib/src/legacy_providers/notifier/base.dart similarity index 100% rename from packages/riverpod/lib/src/notifier/base.dart rename to packages/riverpod/lib/src/legacy_providers/notifier/base.dart diff --git a/packages/riverpod/lib/src/notifier/family.dart b/packages/riverpod/lib/src/legacy_providers/notifier/family.dart similarity index 100% rename from packages/riverpod/lib/src/notifier/family.dart rename to packages/riverpod/lib/src/legacy_providers/notifier/family.dart diff --git a/packages/riverpod/lib/src/provider.dart b/packages/riverpod/lib/src/legacy_providers/provider.dart similarity index 87% rename from packages/riverpod/lib/src/provider.dart rename to packages/riverpod/lib/src/legacy_providers/provider.dart index 587bb40bd..50b55a432 100644 --- a/packages/riverpod/lib/src/provider.dart +++ b/packages/riverpod/lib/src/legacy_providers/provider.dart @@ -1,8 +1,8 @@ import 'package:meta/meta.dart'; import 'builders.dart'; -import 'framework.dart'; -import 'state_notifier_provider.dart' show StateNotifierProvider; +import '../framework.dart'; +import 'deprecated/state_notifier_provider.dart' show StateNotifierProvider; import 'stream_provider.dart' show StreamProvider; part 'provider/auto_dispose.dart'; diff --git a/packages/riverpod/lib/src/provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/provider/auto_dispose.dart similarity index 100% rename from packages/riverpod/lib/src/provider/auto_dispose.dart rename to packages/riverpod/lib/src/legacy_providers/provider/auto_dispose.dart diff --git a/packages/riverpod/lib/src/provider/base.dart b/packages/riverpod/lib/src/legacy_providers/provider/base.dart similarity index 100% rename from packages/riverpod/lib/src/provider/base.dart rename to packages/riverpod/lib/src/legacy_providers/provider/base.dart diff --git a/packages/riverpod/lib/src/stream_notifier.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier.dart similarity index 100% rename from packages/riverpod/lib/src/stream_notifier.dart rename to packages/riverpod/lib/src/legacy_providers/stream_notifier.dart diff --git a/packages/riverpod/lib/src/stream_notifier/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose.dart similarity index 100% rename from packages/riverpod/lib/src/stream_notifier/auto_dispose.dart rename to packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose.dart diff --git a/packages/riverpod/lib/src/stream_notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose_family.dart similarity index 100% rename from packages/riverpod/lib/src/stream_notifier/auto_dispose_family.dart rename to packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose_family.dart diff --git a/packages/riverpod/lib/src/stream_notifier/base.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/base.dart similarity index 100% rename from packages/riverpod/lib/src/stream_notifier/base.dart rename to packages/riverpod/lib/src/legacy_providers/stream_notifier/base.dart diff --git a/packages/riverpod/lib/src/stream_notifier/family.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/family.dart similarity index 100% rename from packages/riverpod/lib/src/stream_notifier/family.dart rename to packages/riverpod/lib/src/legacy_providers/stream_notifier/family.dart diff --git a/packages/riverpod/lib/src/stream_provider.dart b/packages/riverpod/lib/src/legacy_providers/stream_provider.dart similarity index 88% rename from packages/riverpod/lib/src/stream_provider.dart rename to packages/riverpod/lib/src/legacy_providers/stream_provider.dart index 3457327f5..7b73c039f 100644 --- a/packages/riverpod/lib/src/stream_provider.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_provider.dart @@ -4,12 +4,12 @@ import 'package:meta/meta.dart'; import 'async_notifier.dart'; import 'builders.dart'; -import 'common.dart'; -import 'framework.dart'; +import '../core/async_value.dart'; +import '../framework.dart'; import 'future_provider.dart' show FutureProvider; -import 'listenable.dart'; +import '../common/listenable.dart'; import 'provider.dart' show Provider; -import 'result.dart'; +import '../common/result.dart'; part 'stream_provider/auto_dispose.dart'; part 'stream_provider/base.dart'; diff --git a/packages/riverpod/lib/src/stream_provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/stream_provider/auto_dispose.dart similarity index 100% rename from packages/riverpod/lib/src/stream_provider/auto_dispose.dart rename to packages/riverpod/lib/src/legacy_providers/stream_provider/auto_dispose.dart diff --git a/packages/riverpod/lib/src/stream_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart similarity index 100% rename from packages/riverpod/lib/src/stream_provider/base.dart rename to packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart diff --git a/packages/riverpod/test/new/result_test.dart b/packages/riverpod/test/new/result_test.dart index a3b9d357f..902634c8c 100644 --- a/packages/riverpod/test/new/result_test.dart +++ b/packages/riverpod/test/new/result_test.dart @@ -1,4 +1,4 @@ -import 'package:riverpod/src/result.dart'; +import 'package:riverpod/src/common/result.dart'; import 'package:test/test.dart'; void main() { diff --git a/packages/riverpod/test/old/framework/modifiers_test.dart b/packages/riverpod/test/old/framework/modifiers_test.dart index 44dddfb92..2350804bf 100644 --- a/packages/riverpod/test/old/framework/modifiers_test.dart +++ b/packages/riverpod/test/old/framework/modifiers_test.dart @@ -1,6 +1,6 @@ // ignore_for_file: prefer_const_constructors import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/builders.dart'; +import 'package:riverpod/src/legacy_providers/builders.dart'; import 'package:test/test.dart'; void main() { From 867b14af364c946df94879e79d1243ca067005ec Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 22 Dec 2023 16:02:54 +0100 Subject: [PATCH 077/387] More shuffling --- packages/riverpod/test/new/{ => common}/result_test.dart | 0 packages/riverpod/test/new/{ => core}/async_value_test.dart | 0 .../test/new/{framework => core}/provider_container_test.dart | 0 .../async_notifier/async_notifier_test.dart | 0 .../{providers => legacy_providers}/async_notifier/factory.dart | 0 .../state_notifier_provider/auto_dispose_family_test.dart | 2 +- .../auto_dispose_state_notifier_provider_test.dart | 2 +- .../deprecated}/state_notifier_provider/family_test.dart | 2 +- .../state_notifier_provider/state_notifier_provider_test.dart | 2 +- .../deprecated}/state_provider/state_controller_test.dart | 0 .../state_provider/state_provider_auto_dispose_test.dart | 2 +- .../state_provider/state_provider_family_auto_dispose_test.dart | 2 +- .../deprecated}/state_provider/state_provider_family_test.dart | 2 +- .../deprecated}/state_provider/state_provider_test.dart | 2 +- .../auto_dispose_family_future_provider_test.dart | 0 .../future_provider/auto_dispose_future_provider_test.dart | 0 .../future_provider/family_future_provider_test.dart | 0 .../future_provider/future_provider_test.dart | 0 .../old/{providers => legacy_providers}/notifier/factory.dart | 0 .../{providers => legacy_providers}/notifier/notifier_test.dart | 0 .../provider/auto_dispose_provider_family_test.dart | 0 .../provider/auto_dispose_provider_test.dart | 0 .../provider/provider_family_test.dart | 0 .../{providers => legacy_providers}/provider/provider_test.dart | 0 .../scoped_provider/scoped_provider_test.dart | 0 .../stream_notifier/async_notifier_test.dart | 0 .../stream_notifier/factory.dart | 0 .../auto_dispose_family_stream_provider_test.dart | 0 .../stream_provider/auto_dispose_stream_provider_test.dart | 0 .../stream_provider/stream_provider_family_test.dart | 0 .../stream_provider/stream_provider_test.dart | 0 31 files changed, 8 insertions(+), 8 deletions(-) rename packages/riverpod/test/new/{ => common}/result_test.dart (100%) rename packages/riverpod/test/new/{ => core}/async_value_test.dart (100%) rename packages/riverpod/test/new/{framework => core}/provider_container_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/async_notifier/async_notifier_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/async_notifier/factory.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers/deprecated}/state_notifier_provider/auto_dispose_family_test.dart (99%) rename packages/riverpod/test/old/{providers => legacy_providers/deprecated}/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart (99%) rename packages/riverpod/test/old/{providers => legacy_providers/deprecated}/state_notifier_provider/family_test.dart (99%) rename packages/riverpod/test/old/{providers => legacy_providers/deprecated}/state_notifier_provider/state_notifier_provider_test.dart (99%) rename packages/riverpod/test/old/{providers => legacy_providers/deprecated}/state_provider/state_controller_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers/deprecated}/state_provider/state_provider_auto_dispose_test.dart (99%) rename packages/riverpod/test/old/{providers => legacy_providers/deprecated}/state_provider/state_provider_family_auto_dispose_test.dart (98%) rename packages/riverpod/test/old/{providers => legacy_providers/deprecated}/state_provider/state_provider_family_test.dart (99%) rename packages/riverpod/test/old/{providers => legacy_providers/deprecated}/state_provider/state_provider_test.dart (99%) rename packages/riverpod/test/old/{providers => legacy_providers}/future_provider/auto_dispose_family_future_provider_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/future_provider/auto_dispose_future_provider_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/future_provider/family_future_provider_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/future_provider/future_provider_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/notifier/factory.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/notifier/notifier_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/provider/auto_dispose_provider_family_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/provider/auto_dispose_provider_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/provider/provider_family_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/provider/provider_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/scoped_provider/scoped_provider_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/stream_notifier/async_notifier_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/stream_notifier/factory.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/stream_provider/auto_dispose_family_stream_provider_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/stream_provider/auto_dispose_stream_provider_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/stream_provider/stream_provider_family_test.dart (100%) rename packages/riverpod/test/old/{providers => legacy_providers}/stream_provider/stream_provider_test.dart (100%) diff --git a/packages/riverpod/test/new/result_test.dart b/packages/riverpod/test/new/common/result_test.dart similarity index 100% rename from packages/riverpod/test/new/result_test.dart rename to packages/riverpod/test/new/common/result_test.dart diff --git a/packages/riverpod/test/new/async_value_test.dart b/packages/riverpod/test/new/core/async_value_test.dart similarity index 100% rename from packages/riverpod/test/new/async_value_test.dart rename to packages/riverpod/test/new/core/async_value_test.dart diff --git a/packages/riverpod/test/new/framework/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart similarity index 100% rename from packages/riverpod/test/new/framework/provider_container_test.dart rename to packages/riverpod/test/new/core/provider_container_test.dart diff --git a/packages/riverpod/test/old/providers/async_notifier/async_notifier_test.dart b/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/async_notifier/async_notifier_test.dart rename to packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart diff --git a/packages/riverpod/test/old/providers/async_notifier/factory.dart b/packages/riverpod/test/old/legacy_providers/async_notifier/factory.dart similarity index 100% rename from packages/riverpod/test/old/providers/async_notifier/factory.dart rename to packages/riverpod/test/old/legacy_providers/async_notifier/factory.dart diff --git a/packages/riverpod/test/old/providers/state_notifier_provider/auto_dispose_family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart similarity index 99% rename from packages/riverpod/test/old/providers/state_notifier_provider/auto_dispose_family_test.dart rename to packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart index b88cd768e..6ac0d6883 100644 --- a/packages/riverpod/test/old/providers/state_notifier_provider/auto_dispose_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart @@ -1,7 +1,7 @@ import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../../utils.dart'; +import '../../../utils.dart'; void main() { group('StateNotifier.family', () { diff --git a/packages/riverpod/test/old/providers/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart similarity index 99% rename from packages/riverpod/test/old/providers/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart rename to packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart index 9c148e8da..b7c3fc15a 100644 --- a/packages/riverpod/test/old/providers/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart @@ -2,7 +2,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../../utils.dart'; +import '../../../utils.dart'; void main() { test('can read and set current StateNotifier', () async { diff --git a/packages/riverpod/test/old/providers/state_notifier_provider/family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart similarity index 99% rename from packages/riverpod/test/old/providers/state_notifier_provider/family_test.dart rename to packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart index 62374903e..56b65681c 100644 --- a/packages/riverpod/test/old/providers/state_notifier_provider/family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart @@ -2,7 +2,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../../utils.dart'; +import '../../../utils.dart'; import 'state_notifier_provider_test.dart'; void main() { diff --git a/packages/riverpod/test/old/providers/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart similarity index 99% rename from packages/riverpod/test/old/providers/state_notifier_provider/state_notifier_provider_test.dart rename to packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart index d9499eee0..cd40f6b0a 100644 --- a/packages/riverpod/test/old/providers/state_notifier_provider/state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart @@ -4,7 +4,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../../utils.dart'; +import '../../../utils.dart'; void main() { test('supports overrideWith', () { diff --git a/packages/riverpod/test/old/providers/state_provider/state_controller_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_controller_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/state_provider/state_controller_test.dart rename to packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_controller_test.dart diff --git a/packages/riverpod/test/old/providers/state_provider/state_provider_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart similarity index 99% rename from packages/riverpod/test/old/providers/state_provider/state_provider_auto_dispose_test.dart rename to packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart index d107a863b..0e9dc546c 100644 --- a/packages/riverpod/test/old/providers/state_provider/state_provider_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart @@ -2,7 +2,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../../utils.dart'; +import '../../../utils.dart'; void main() { test('supports .name', () { diff --git a/packages/riverpod/test/old/providers/state_provider/state_provider_family_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart similarity index 98% rename from packages/riverpod/test/old/providers/state_provider/state_provider_family_auto_dispose_test.dart rename to packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart index dc9a53d54..dc4ea503f 100644 --- a/packages/riverpod/test/old/providers/state_provider/state_provider_family_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart @@ -1,7 +1,7 @@ import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../../utils.dart'; +import '../../../utils.dart'; void main() { test('supports .name', () { diff --git a/packages/riverpod/test/old/providers/state_provider/state_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart similarity index 99% rename from packages/riverpod/test/old/providers/state_provider/state_provider_family_test.dart rename to packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart index 66d28a515..1081c1f46 100644 --- a/packages/riverpod/test/old/providers/state_provider/state_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart @@ -1,7 +1,7 @@ import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../../utils.dart'; +import '../../../utils.dart'; void main() { test('supports .name', () { diff --git a/packages/riverpod/test/old/providers/state_provider/state_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart similarity index 99% rename from packages/riverpod/test/old/providers/state_provider/state_provider_test.dart rename to packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart index f9f31a7df..a48f0abdc 100644 --- a/packages/riverpod/test/old/providers/state_provider/state_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart @@ -4,7 +4,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../../utils.dart'; +import '../../../utils.dart'; void main() { test('supports overrideWith', () { diff --git a/packages/riverpod/test/old/providers/future_provider/auto_dispose_family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/future_provider/auto_dispose_family_future_provider_test.dart rename to packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart diff --git a/packages/riverpod/test/old/providers/future_provider/auto_dispose_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/future_provider/auto_dispose_future_provider_test.dart rename to packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart diff --git a/packages/riverpod/test/old/providers/future_provider/family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/future_provider/family_future_provider_test.dart rename to packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart diff --git a/packages/riverpod/test/old/providers/future_provider/future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/future_provider/future_provider_test.dart rename to packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart diff --git a/packages/riverpod/test/old/providers/notifier/factory.dart b/packages/riverpod/test/old/legacy_providers/notifier/factory.dart similarity index 100% rename from packages/riverpod/test/old/providers/notifier/factory.dart rename to packages/riverpod/test/old/legacy_providers/notifier/factory.dart diff --git a/packages/riverpod/test/old/providers/notifier/notifier_test.dart b/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/notifier/notifier_test.dart rename to packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart diff --git a/packages/riverpod/test/old/providers/provider/auto_dispose_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/provider/auto_dispose_provider_family_test.dart rename to packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart diff --git a/packages/riverpod/test/old/providers/provider/auto_dispose_provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/provider/auto_dispose_provider_test.dart rename to packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart diff --git a/packages/riverpod/test/old/providers/provider/provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/provider/provider_family_test.dart rename to packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart diff --git a/packages/riverpod/test/old/providers/provider/provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/provider/provider_test.dart rename to packages/riverpod/test/old/legacy_providers/provider/provider_test.dart diff --git a/packages/riverpod/test/old/providers/scoped_provider/scoped_provider_test.dart b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/scoped_provider/scoped_provider_test.dart rename to packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart diff --git a/packages/riverpod/test/old/providers/stream_notifier/async_notifier_test.dart b/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/stream_notifier/async_notifier_test.dart rename to packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart diff --git a/packages/riverpod/test/old/providers/stream_notifier/factory.dart b/packages/riverpod/test/old/legacy_providers/stream_notifier/factory.dart similarity index 100% rename from packages/riverpod/test/old/providers/stream_notifier/factory.dart rename to packages/riverpod/test/old/legacy_providers/stream_notifier/factory.dart diff --git a/packages/riverpod/test/old/providers/stream_provider/auto_dispose_family_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/stream_provider/auto_dispose_family_stream_provider_test.dart rename to packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart diff --git a/packages/riverpod/test/old/providers/stream_provider/auto_dispose_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/stream_provider/auto_dispose_stream_provider_test.dart rename to packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart diff --git a/packages/riverpod/test/old/providers/stream_provider/stream_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/stream_provider/stream_provider_family_test.dart rename to packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart diff --git a/packages/riverpod/test/old/providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart similarity index 100% rename from packages/riverpod/test/old/providers/stream_provider/stream_provider_test.dart rename to packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart From 29939f4edc45cdb50b7c8b77088d973fb04a5cee Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 22 Dec 2023 16:03:17 +0100 Subject: [PATCH 078/387] More --- packages/riverpod/test/{old => }/third_party/fake_async.dart | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename packages/riverpod/test/{old => }/third_party/fake_async.dart (100%) diff --git a/packages/riverpod/test/old/third_party/fake_async.dart b/packages/riverpod/test/third_party/fake_async.dart similarity index 100% rename from packages/riverpod/test/old/third_party/fake_async.dart rename to packages/riverpod/test/third_party/fake_async.dart From 942b93ba631cbc6f7704a18af08cd310fa52c6f3 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 22 Dec 2023 16:13:09 +0100 Subject: [PATCH 079/387] Fix imports --- .../lib/flutter_riverpod.dart | 2 +- packages/riverpod/lib/riverpod.dart | 49 +++++++++---------- .../riverpod/lib/src/core/async_value.dart | 2 +- .../generated_providers/examples.dart | 4 +- .../generated_providers/future_provider.dart | 1 + .../generated_providers/sync_provider.dart | 1 + packages/riverpod/lib/src/internals.dart | 2 +- .../src/legacy_providers/async_notifier.dart | 9 ++-- .../src/legacy_providers/future_provider.dart | 4 +- .../lib/src/legacy_providers/notifier.dart | 6 +-- .../lib/src/legacy_providers/provider.dart | 2 +- .../src/legacy_providers/provider/base.dart | 2 +- .../src/legacy_providers/stream_notifier.dart | 1 + .../src/legacy_providers/stream_provider.dart | 8 +-- .../new/core/provider_container_test.dart | 2 +- .../framework/provider_container_test.dart | 1 - 16 files changed, 46 insertions(+), 50 deletions(-) diff --git a/packages/flutter_riverpod/lib/flutter_riverpod.dart b/packages/flutter_riverpod/lib/flutter_riverpod.dart index b794bb112..5adedb89d 100644 --- a/packages/flutter_riverpod/lib/flutter_riverpod.dart +++ b/packages/flutter_riverpod/lib/flutter_riverpod.dart @@ -1,6 +1,6 @@ // ignore: invalid_export_of_internal_element export 'package:riverpod/riverpod.dart'; -export 'src/legacy/deprecated/change_notifier_provider.dart'; export 'src/consumer.dart'; export 'src/framework.dart' hide ProviderScopeState; +export 'src/legacy/deprecated/change_notifier_provider.dart'; diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 1cb8110c6..0f302ba6f 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -1,27 +1,6 @@ export 'package:state_notifier/state_notifier.dart' hide Listener, LocatorMixin; -export 'src/legacy_providers/async_notifier.dart' - hide - AsyncNotifierProviderImpl, - AutoDisposeAsyncNotifierProviderImpl, - AutoDisposeFamilyAsyncNotifierProviderImpl, - FamilyAsyncNotifierProviderImpl, - AsyncNotifierBase, - AsyncNotifierProviderBase, - CancelAsyncSubscription, - BuildlessAsyncNotifier, - BuildlessAutoDisposeAsyncNotifier, - FutureHandlerProviderElementMixin, - FamilyStreamNotifierProviderImpl, - StreamNotifierProviderImpl, - AutoDisposeStreamNotifierProviderImpl, - AutoDisposeFamilyStreamNotifierProviderImpl, - StreamNotifierProviderBase, - BuildlessAutoDisposeStreamNotifier, - BuildlessStreamNotifier; - export 'src/core/async_value.dart' hide AsyncTransition; - export 'src/framework.dart' hide ProviderScheduler, @@ -53,9 +32,29 @@ export 'src/framework.dart' OnError, ProviderContainerTest, DebugRiverpodDevtoolBiding; - +export 'src/legacy_providers/async_notifier.dart' + hide + AsyncNotifierProviderImpl, + AutoDisposeAsyncNotifierProviderImpl, + AutoDisposeFamilyAsyncNotifierProviderImpl, + FamilyAsyncNotifierProviderImpl, + AsyncNotifierBase, + AsyncNotifierProviderBase, + CancelAsyncSubscription, + BuildlessAsyncNotifier, + BuildlessAutoDisposeAsyncNotifier, + FutureHandlerProviderElementMixin, + FamilyStreamNotifierProviderImpl, + StreamNotifierProviderImpl, + AutoDisposeStreamNotifierProviderImpl, + AutoDisposeFamilyStreamNotifierProviderImpl, + StreamNotifierProviderBase, + BuildlessAutoDisposeStreamNotifier, + BuildlessStreamNotifier; +export 'src/legacy_providers/deprecated/state_controller.dart'; +export 'src/legacy_providers/deprecated/state_notifier_provider.dart'; +export 'src/legacy_providers/deprecated/state_provider.dart'; export 'src/legacy_providers/future_provider.dart'; - export 'src/legacy_providers/notifier.dart' hide NotifierBase, @@ -66,9 +65,5 @@ export 'src/legacy_providers/notifier.dart' NotifierProviderImpl, BuildlessAutoDisposeNotifier, BuildlessNotifier; - export 'src/legacy_providers/provider.dart' hide InternalProvider; -export 'src/legacy_providers/deprecated/state_controller.dart'; -export 'src/legacy_providers/deprecated/state_notifier_provider.dart'; -export 'src/legacy_providers/deprecated/state_provider.dart'; export 'src/legacy_providers/stream_provider.dart'; diff --git a/packages/riverpod/lib/src/core/async_value.dart b/packages/riverpod/lib/src/core/async_value.dart index dfe8e4097..3eff83824 100644 --- a/packages/riverpod/lib/src/core/async_value.dart +++ b/packages/riverpod/lib/src/core/async_value.dart @@ -1,8 +1,8 @@ import 'package:meta/meta.dart'; +import '../common/stack_trace.dart'; import '../framework.dart'; import '../legacy_providers/future_provider.dart' show FutureProvider; -import '../common/stack_trace.dart'; import '../legacy_providers/stream_provider.dart' show StreamProvider; /// An extension for [asyncTransition]. diff --git a/packages/riverpod/lib/src/framework2/generated_providers/examples.dart b/packages/riverpod/lib/src/framework2/generated_providers/examples.dart index d10976398..c81e3d5dc 100644 --- a/packages/riverpod/lib/src/framework2/generated_providers/examples.dart +++ b/packages/riverpod/lib/src/framework2/generated_providers/examples.dart @@ -1,9 +1,7 @@ import 'dart:async'; -import 'package:meta/meta.dart'; -import 'package:riverpod/src/framework2/generated_providers/future_provider.dart'; - import '../framework.dart'; +import 'future_provider.dart'; import 'sync_provider.dart'; part 'examples.g.dart'; diff --git a/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart b/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart index 67ec63454..cc4fae706 100644 --- a/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart +++ b/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart @@ -61,6 +61,7 @@ abstract base class AsyncProvider extends Provider> { class AsyncProviderElement extends ProviderElement { AsyncProviderElement(this.provider, super.container); + @override final AsyncProvider provider; @override diff --git a/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart b/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart index 522d74ced..3a7d0bc52 100644 --- a/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart +++ b/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart @@ -57,6 +57,7 @@ abstract base class SyncProvider extends Provider { class SyncProviderElement extends ProviderElement { SyncProviderElement(this.provider, super.container); + @override final SyncProvider provider; @override diff --git a/packages/riverpod/lib/src/internals.dart b/packages/riverpod/lib/src/internals.dart index 65b8c9e3a..554d9b564 100644 --- a/packages/riverpod/lib/src/internals.dart +++ b/packages/riverpod/lib/src/internals.dart @@ -5,7 +5,6 @@ /// It is used by the flutter and hooks implementation, but is not stable. library internals; -export 'legacy_providers/builders.dart'; export 'common/listenable.dart'; export 'common/result.dart'; export 'common/run_guarded.dart'; @@ -13,6 +12,7 @@ export 'common/stack_trace.dart'; export 'core/async_value.dart'; export 'framework.dart'; export 'legacy_providers/async_notifier.dart'; +export 'legacy_providers/builders.dart'; export 'legacy_providers/deprecated/state_notifier_provider.dart'; export 'legacy_providers/deprecated/state_provider.dart'; export 'legacy_providers/future_provider.dart'; diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier.dart index 61d5396e6..103ce77f3 100644 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier.dart +++ b/packages/riverpod/lib/src/legacy_providers/async_notifier.dart @@ -2,15 +2,15 @@ import 'dart:async'; import 'package:meta/meta.dart'; -import 'builders.dart'; +import '../common/listenable.dart'; +import '../common/pragma.dart'; +import '../common/result.dart'; import '../common/run_guarded.dart'; import '../core/async_value.dart'; import '../framework.dart'; +import 'builders.dart'; import 'future_provider.dart' show FutureProvider; -import '../common/listenable.dart'; import 'notifier.dart'; -import '../common/pragma.dart'; -import '../common/result.dart'; import 'stream_provider.dart'; part 'async_notifier/auto_dispose.dart'; @@ -208,6 +208,7 @@ abstract class AsyncNotifierProviderBase, /// Listening to this using [Ref.watch] will rebuild the widget/provider /// when the [AsyncNotifier] emits a new value. /// This will then return a new [Future] that resoles with the latest "state". + @override Refreshable> get future; final NotifierT Function() _createNotifier; diff --git a/packages/riverpod/lib/src/legacy_providers/future_provider.dart b/packages/riverpod/lib/src/legacy_providers/future_provider.dart index c5326b678..0270408e9 100644 --- a/packages/riverpod/lib/src/legacy_providers/future_provider.dart +++ b/packages/riverpod/lib/src/legacy_providers/future_provider.dart @@ -2,10 +2,10 @@ import 'dart:async'; import 'package:meta/meta.dart'; -import 'async_notifier.dart'; -import 'builders.dart'; import '../core/async_value.dart'; import '../framework.dart'; +import 'async_notifier.dart'; +import 'builders.dart'; import 'provider.dart' show Provider; import 'stream_provider.dart' show StreamProvider; diff --git a/packages/riverpod/lib/src/legacy_providers/notifier.dart b/packages/riverpod/lib/src/legacy_providers/notifier.dart index 6b87f1356..a78d482c6 100644 --- a/packages/riverpod/lib/src/legacy_providers/notifier.dart +++ b/packages/riverpod/lib/src/legacy_providers/notifier.dart @@ -1,11 +1,11 @@ import 'package:meta/meta.dart'; +import '../common/listenable.dart'; +import '../common/result.dart'; +import '../framework.dart'; import 'async_notifier.dart'; import 'builders.dart'; -import '../framework.dart'; -import '../common/listenable.dart'; import 'provider.dart'; -import '../common/result.dart'; part 'notifier/auto_dispose.dart'; part 'notifier/auto_dispose_family.dart'; diff --git a/packages/riverpod/lib/src/legacy_providers/provider.dart b/packages/riverpod/lib/src/legacy_providers/provider.dart index 50b55a432..93017df25 100644 --- a/packages/riverpod/lib/src/legacy_providers/provider.dart +++ b/packages/riverpod/lib/src/legacy_providers/provider.dart @@ -1,7 +1,7 @@ import 'package:meta/meta.dart'; -import 'builders.dart'; import '../framework.dart'; +import 'builders.dart'; import 'deprecated/state_notifier_provider.dart' show StateNotifierProvider; import 'stream_provider.dart' show StreamProvider; diff --git a/packages/riverpod/lib/src/legacy_providers/provider/base.dart b/packages/riverpod/lib/src/legacy_providers/provider/base.dart index f9ae3c9dd..08818bbdd 100644 --- a/packages/riverpod/lib/src/legacy_providers/provider/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/provider/base.dart @@ -32,7 +32,7 @@ class Provider extends InternalProvider { /// An implementation detail of Riverpod @internal - Provider.internal( + const Provider.internal( this._createFn, { required super.name, required super.dependencies, diff --git a/packages/riverpod/lib/src/legacy_providers/stream_notifier.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier.dart index 91d44a586..870fb1bec 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_notifier.dart @@ -68,6 +68,7 @@ abstract class StreamNotifierProviderBase< /// Listening to this using [Ref.watch] will rebuild the widget/provider /// when the [StreamNotifier] emits a new value. /// This will then return a new [Future] that resoles with the latest "state". + @override Refreshable> get future; final NotifierT Function() _createNotifier; diff --git a/packages/riverpod/lib/src/legacy_providers/stream_provider.dart b/packages/riverpod/lib/src/legacy_providers/stream_provider.dart index 7b73c039f..62f16ded4 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_provider.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_provider.dart @@ -2,14 +2,14 @@ import 'dart:async'; import 'package:meta/meta.dart'; -import 'async_notifier.dart'; -import 'builders.dart'; +import '../common/listenable.dart'; +import '../common/result.dart'; import '../core/async_value.dart'; import '../framework.dart'; +import 'async_notifier.dart'; +import 'builders.dart'; import 'future_provider.dart' show FutureProvider; -import '../common/listenable.dart'; import 'provider.dart' show Provider; -import '../common/result.dart'; part 'stream_provider/auto_dispose.dart'; part 'stream_provider/base.dart'; diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index bce3b2590..a981c93ae 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -633,7 +633,7 @@ void main() { final container = ProviderContainer.test(parent: root, overrides: [ // An unrelated override, added to avoid the container optimizing Provider((_) => 0), - ]); + ],); expect(root.pointerManager.container, root); expect(container.pointerManager.container, container); diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 23ee58d69..273034d9a 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -1,5 +1,4 @@ import 'package:mockito/mockito.dart'; -import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/internals.dart'; import 'package:test/test.dart'; From 98b5b4effd1752da955547691793fff77774ebc0 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 22 Dec 2023 16:24:29 +0100 Subject: [PATCH 080/387] More --- packages/riverpod/lib/riverpod.dart | 1 - .../riverpod/lib/src/core/foundation.dart | 10 --- packages/riverpod/lib/src/core/listen.dart | 15 ---- ...provider.dart => override_with_value.dart} | 42 ++++++++++ .../{provider_base.dart => provider.dart} | 80 +++---------------- .../lib/src/core/provider_subscription.dart | 38 +++++++++ .../src/core/{selector.dart => select.dart} | 2 +- ...{async_selector.dart => select_async.dart} | 0 packages/riverpod/lib/src/framework.dart | 10 +-- 9 files changed, 98 insertions(+), 100 deletions(-) delete mode 100644 packages/riverpod/lib/src/core/listen.dart rename packages/riverpod/lib/src/core/{value_provider.dart => override_with_value.dart} (62%) rename packages/riverpod/lib/src/core/{provider_base.dart => provider.dart} (68%) create mode 100644 packages/riverpod/lib/src/core/provider_subscription.dart rename packages/riverpod/lib/src/core/{selector.dart => select.dart} (99%) rename packages/riverpod/lib/src/core/{async_selector.dart => select_async.dart} (100%) diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 0f302ba6f..d26f50389 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -21,7 +21,6 @@ export 'src/framework.dart' ProviderOverride, AutoDisposeFamilyBase, AlwaysAliveAsyncSelector, - handleFireImmediately, DebugGetCreateSourceHash, ProviderNotifierCreate, ProviderCreate, diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index 4335a1918..094ce4d47 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -222,13 +222,3 @@ mixin ProviderListenable implements ProviderListenableOrFamily { ); } } - -/// Represents the subscription to a [ProviderListenable] -abstract class ProviderSubscription { - /// Stops listening to the provider - @mustCallSuper - void close(); - - /// Obtain the latest value emitted by the provider - State read(); -} diff --git a/packages/riverpod/lib/src/core/listen.dart b/packages/riverpod/lib/src/core/listen.dart deleted file mode 100644 index 43b7b53d5..000000000 --- a/packages/riverpod/lib/src/core/listen.dart +++ /dev/null @@ -1,15 +0,0 @@ -part of '../framework.dart'; - -/// Deals with the internals of synchronously calling the listeners -/// when using `fireImmediately: true` -@internal -void handleFireImmediately( - Result currentState, { - required void Function(State? previous, State current) listener, - required void Function(Object error, StackTrace stackTrace) onError, -}) { - currentState.map( - data: (data) => runBinaryGuarded(listener, null, data.state), - error: (error) => runBinaryGuarded(onError, error.error, error.stackTrace), - ); -} diff --git a/packages/riverpod/lib/src/core/value_provider.dart b/packages/riverpod/lib/src/core/override_with_value.dart similarity index 62% rename from packages/riverpod/lib/src/core/value_provider.dart rename to packages/riverpod/lib/src/core/override_with_value.dart index 7e4cee68d..5a5c1150b 100644 --- a/packages/riverpod/lib/src/core/value_provider.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -1,5 +1,47 @@ part of '../framework.dart'; +/// A mixin to add [overrideWithValue] capability to a provider. +// TODO merge with Provider directy +mixin OverrideWithValueMixin on ProviderBase { + /// {@template riverpod.overrridewithvalue} + /// Overrides a provider with a value, ejecting the default behaviour. + /// + /// This will also disable the auto-scoping mechanism, meaning that if the + /// overridden provider specified [dependencies], it will have no effect. + /// + /// Some common use-cases are: + /// - testing, by replacing a service with a fake implementation, or to reach + /// a very specific state easily. + /// - multiple environments, by changing the implementation of a class + /// based on the platform or other parameters. + /// + /// This function should be used in combination with `ProviderScope.overrides` + /// or `ProviderContainer.overrides`: + /// + /// ```dart + /// final myService = Provider((ref) => MyService()); + /// + /// runApp( + /// ProviderScope( + /// overrides: [ + /// myService.overrideWithValue( + /// // Replace the implementation of MyService with a fake implementation + /// MyFakeService(), + /// ), + /// ], + /// child: MyApp(), + /// ), + /// ); + /// ``` + /// {@endtemplate} + Override overrideWithValue(State value) { + return ProviderOverride( + origin: this, + providerOverride: ValueProvider(value), + ); + } +} + /// A provider that is driven by a value instead of a function. /// /// This is an implementation detail of `overrideWithValue`. diff --git a/packages/riverpod/lib/src/core/provider_base.dart b/packages/riverpod/lib/src/core/provider.dart similarity index 68% rename from packages/riverpod/lib/src/core/provider_base.dart rename to packages/riverpod/lib/src/core/provider.dart index bb70dcc93..e822c29aa 100644 --- a/packages/riverpod/lib/src/core/provider_base.dart +++ b/packages/riverpod/lib/src/core/provider.dart @@ -74,7 +74,7 @@ abstract class ProviderBase extends ProviderOrFamily element.flush(); if (fireImmediately) { - handleFireImmediately( + _handleFireImmediately( element.getState()!, listener: listener, onError: onError, @@ -174,71 +174,15 @@ class _ExternalProviderSubscription } } -/// When a provider listens to another provider using `listen` -class _ProviderListener implements ProviderSubscription { - _ProviderListener._({ - required this.listenedElement, - required this.dependentElement, - required this.listener, - required this.onError, - }); - -// TODO can't we type it properly? - final void Function(Object? prev, Object? state) listener; - final ProviderElementBase dependentElement; - final ProviderElementBase listenedElement; - final OnError onError; - - @override - void close() { - dependentElement._listenedProviderSubscriptions.remove(this); - listenedElement - .._subscribers.remove(this) - .._onRemoveListener(); - } - - @override - State read() => listenedElement.readSelf(); -} - -/// A mixin to add [overrideWithValue] capability to a provider. -// TODO merge with Provider directy -mixin OverrideWithValueMixin on ProviderBase { - /// {@template riverpod.overrridewithvalue} - /// Overrides a provider with a value, ejecting the default behaviour. - /// - /// This will also disable the auto-scoping mechanism, meaning that if the - /// overridden provider specified [dependencies], it will have no effect. - /// - /// Some common use-cases are: - /// - testing, by replacing a service with a fake implementation, or to reach - /// a very specific state easily. - /// - multiple environments, by changing the implementation of a class - /// based on the platform or other parameters. - /// - /// This function should be used in combination with `ProviderScope.overrides` - /// or `ProviderContainer.overrides`: - /// - /// ```dart - /// final myService = Provider((ref) => MyService()); - /// - /// runApp( - /// ProviderScope( - /// overrides: [ - /// myService.overrideWithValue( - /// // Replace the implementation of MyService with a fake implementation - /// MyFakeService(), - /// ), - /// ], - /// child: MyApp(), - /// ), - /// ); - /// ``` - /// {@endtemplate} - Override overrideWithValue(State value) { - return ProviderOverride( - origin: this, - providerOverride: ValueProvider(value), - ); - } +/// Deals with the internals of synchronously calling the listeners +/// when using `fireImmediately: true` +void _handleFireImmediately( + Result currentState, { + required void Function(State? previous, State current) listener, + required void Function(Object error, StackTrace stackTrace) onError, +}) { + currentState.map( + data: (data) => runBinaryGuarded(listener, null, data.state), + error: (error) => runBinaryGuarded(onError, error.error, error.stackTrace), + ); } diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart new file mode 100644 index 000000000..214e9e82d --- /dev/null +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -0,0 +1,38 @@ +part of '../framework.dart'; + +/// Represents the subscription to a [ProviderListenable] +abstract class ProviderSubscription { + /// Stops listening to the provider + @mustCallSuper + void close(); + + /// Obtain the latest value emitted by the provider + State read(); +} + +/// When a provider listens to another provider using `listen` +class _ProviderListener implements ProviderSubscription { + _ProviderListener._({ + required this.listenedElement, + required this.dependentElement, + required this.listener, + required this.onError, + }); + +// TODO can't we type it properly? + final void Function(Object? prev, Object? state) listener; + final ProviderElementBase dependentElement; + final ProviderElementBase listenedElement; + final OnError onError; + + @override + void close() { + dependentElement._listenedProviderSubscriptions.remove(this); + listenedElement + .._subscribers.remove(this) + .._onRemoveListener(); + } + + @override + State read() => listenedElement.readSelf(); +} diff --git a/packages/riverpod/lib/src/core/selector.dart b/packages/riverpod/lib/src/core/select.dart similarity index 99% rename from packages/riverpod/lib/src/core/selector.dart rename to packages/riverpod/lib/src/core/select.dart index 7b4c57cbb..b017d0627 100644 --- a/packages/riverpod/lib/src/core/selector.dart +++ b/packages/riverpod/lib/src/core/select.dart @@ -131,7 +131,7 @@ class _ProviderSelector with ProviderListenable { lastSelectedValue = _select(Result.guard(sub.read)); if (fireImmediately) { - handleFireImmediately( + _handleFireImmediately( lastSelectedValue, listener: listener, onError: onError, diff --git a/packages/riverpod/lib/src/core/async_selector.dart b/packages/riverpod/lib/src/core/select_async.dart similarity index 100% rename from packages/riverpod/lib/src/core/async_selector.dart rename to packages/riverpod/lib/src/core/select_async.dart diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index e5ad17d48..a4f4ff5c2 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -11,17 +11,17 @@ import 'common/env.dart'; import 'internals.dart'; part 'core/auto_dispose.dart'; -part 'core/async_selector.dart'; -part 'core/provider_base.dart'; +part 'core/select_async.dart'; +part 'core/provider.dart'; part 'core/element.dart'; part 'core/provider_container.dart'; part 'core/family.dart'; -part 'core/listen.dart'; +part 'core/provider_subscription.dart'; part 'core/foundation.dart'; part 'core/proxy_provider_listenable.dart'; part 'core/ref.dart'; -part 'core/selector.dart'; +part 'core/select.dart'; part 'core/scheduler.dart'; -part 'core/value_provider.dart'; +part 'core/override_with_value.dart'; part 'core/override.dart'; part 'core/devtool.dart'; From 7cf5cb291ee22dab0c3f0f76d1208f94f956ece9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 22 Dec 2023 16:53:25 +0100 Subject: [PATCH 081/387] Fix override --- packages/riverpod/lib/src/core/override.dart | 5 ++ .../lib/src/core/override_with_value.dart | 3 ++ .../lib/src/core/provider_container.dart | 2 +- .../new/core/provider_container_test.dart | 47 +++++++++++++++++-- 4 files changed, 52 insertions(+), 5 deletions(-) diff --git a/packages/riverpod/lib/src/core/override.dart b/packages/riverpod/lib/src/core/override.dart index 5622800c1..03d29248e 100644 --- a/packages/riverpod/lib/src/core/override.dart +++ b/packages/riverpod/lib/src/core/override.dart @@ -39,6 +39,11 @@ class _ProviderOverrideBase implements ProviderOverride { /// The new provider behavior. final ProviderBase providerOverride; + + @override + String toString() { + return 'ProviderOverride($origin, $providerOverride)'; + } } /// When a provider is automatically scoped due to specifying `dependencies`. diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index 5a5c1150b..0a605fdda 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -71,6 +71,9 @@ class ValueProvider extends ProviderBase { ValueProviderElement createElement(ProviderContainer container) { return ValueProviderElement(this, container); } + + @override + String toString() => 'ValueProvider<$State>($_value)'; } /// The [ProviderElementBase] of a [ValueProvider] diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 3e6735a9b..b4533ce96 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -352,7 +352,7 @@ class ProviderPointerManager { previousPointer.pointers.removeWhere( (key, value) => value.targetContainer != container, ); - return; + continue; } familyPointers[overriddenFamily] = ProviderDirectory.empty( diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index a981c93ae..b48d71855 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -630,10 +630,13 @@ void main() { group('pointers', () { test('has "container" pointing to "this"', () { final root = ProviderContainer.test(); - final container = ProviderContainer.test(parent: root, overrides: [ - // An unrelated override, added to avoid the container optimizing - Provider((_) => 0), - ],); + final container = ProviderContainer.test( + parent: root, + overrides: [ + // An unrelated override, added to avoid the container optimizing + Provider((_) => 0), + ], + ); expect(root.pointerManager.container, root); expect(container.pointerManager.container, container); @@ -945,6 +948,42 @@ void main() { }, ); }); + + test( + 'can override a family and a provider from that family in the same container', + () { + final family = Provider.family((ref, a) => 'Hello $a'); + final familyOverride = family.overrideWith((ref, a) => 'Hi $a'); + final beforeOverride = family(42).overrideWithValue('Bonjour 42'); + final afterOverride = family(21).overrideWithValue('Ola 42'); + + final container = ProviderContainer.test( + overrides: [ + beforeOverride, + familyOverride, + afterOverride, + ], + ); + + expect(container.pointerManager.familyPointers, { + family: isProviderDirectory( + override: familyOverride, + targetContainer: container, + pointers: { + family(42): isPointer( + override: beforeOverride, + targetContainer: container, + element: null, + ), + family(21): isPointer( + override: afterOverride, + targetContainer: container, + element: null, + ), + }, + ), + }); + }); }); group('.test', () { From adf3a27be9795c1e843cd29b03eb12342d2aeeb9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 22 Dec 2023 18:36:22 +0100 Subject: [PATCH 082/387] Throw if scoping a non-scoped provider --- .../lib/src/core/provider_container.dart | 41 +- .../test/new/core/auto_dispose_test.dart | 35 ++ .../new/core/provider_container_test.dart | 437 ++++++++++++++++-- .../test/old/framework/auto_dispose_test.dart | 20 - 4 files changed, 469 insertions(+), 64 deletions(-) create mode 100644 packages/riverpod/test/new/core/auto_dispose_test.dart diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index b4533ce96..f55b5c5f2 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -493,19 +493,23 @@ class ProviderPointerManager { if (directory == null) return null; final pointer = directory.pointers[provider]; - // If null, nothing to remove. If from an override, must not be removed. - if (pointer == null || pointer.providerOverride != null) { + // If null, nothing to remove. + if (pointer == null) return null; + // If from an override, must not be removed unless it is a transitive override + if (pointer.providerOverride != null && + pointer.providerOverride is! TransitiveProviderOverride) { return pointer; } directory.pointers.remove(provider); final from = provider.from; - if (from != null) { - // Cleanup family if empty. - // We do so only if it isn't from an override, as overrides are - // must never be removed. - if (directory.pointers.isEmpty && directory.familyOverride == null) { + // Cleanup family if empty. + // We do so only if it isn't from an override, as overrides are + // must never be removed. + if (from != null && directory.pointers.isEmpty) { + if (directory.familyOverride == null || + directory.familyOverride is TransitiveFamilyOverride) { familyPointers.remove(from); } } @@ -604,12 +608,27 @@ class ProviderContainer implements Node { for (final override in overrides) { switch (override) { case ProviderOverride(): + if (parent != null && + override.origin.allTransitiveDependencies == null && + override.origin.from?.allTransitiveDependencies == null) { + throw AssertionError( + 'Tried to scope a provider that did not specify "dependencies": ${override.origin}', + ); + } + if (!overrideOrigins.add(override.origin)) { throw AssertionError( 'Tried to override a provider twice within the same container: ${override.origin}', ); } case FamilyOverride(): + if (parent != null && + override.from.allTransitiveDependencies == null) { + throw AssertionError( + 'Tried to scope a family that did not specify "dependencies": ${override.from}', + ); + } + if (!overrideOrigins.add(override.from)) { throw AssertionError( 'Tried to override a family twice within the same container: ${override.from}', @@ -822,6 +841,14 @@ class ProviderContainer implements Node { } void _disposeProvider(ProviderBase provider) { + if (provider.allTransitiveDependencies != null) { + /// Recursively removes the pointer in all containers if the provider + /// can be scoped. + for (final child in _children) { + child._disposeProvider(provider); + } + } + final pointer = _pointerManager.remove(provider); // The provider is already disposed, so we don't need to do anything diff --git a/packages/riverpod/test/new/core/auto_dispose_test.dart b/packages/riverpod/test/new/core/auto_dispose_test.dart new file mode 100644 index 000000000..aa4fa88c7 --- /dev/null +++ b/packages/riverpod/test/new/core/auto_dispose_test.dart @@ -0,0 +1,35 @@ +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/framework.dart'; +import 'package:test/test.dart'; + +void main() { + group('AutoDispose', () { + test('supports disposing of overridden families', () async { + // Regression test for https://github.com/rrousselGit/riverpod/issues/2480 + final provider = Provider.autoDispose.family( + (ref, _) => -1, + dependencies: const [], + ); + + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [provider.overrideWith((ref, arg) => 0)], + ); + + container.read(provider(0)); + + expect(container.pointerManager.readPointer(provider(0)), isNotNull); + expect(container.pointerManager.familyPointers[provider], isNotNull); + + await container.pump(); + + // The family pointer should still be there, as it comes from an override + expect(container.pointerManager.familyPointers[provider], isNotNull); + // The provider should've been disposed. + expect(container.pointerManager.readPointer(provider(0)), isNull); + }); + + // TODO test recursive dispose does not remove pointers in unrelated containers + }); +} diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index b48d71855..6978f93aa 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -80,9 +80,18 @@ void main() { group('ProviderPointerManager', () { group('isLocallyMounted', () { - final a = Provider((_) => 0); - final b = Provider.family((_, __) => 0); - final c = Provider.family((_, __) => 0)(42); + final a = Provider( + (_) => 0, + dependencies: const [], + ); + final b = Provider.family( + (_, __) => 0, + dependencies: const [], + ); + final c = Provider.family( + (_, __) => 0, + dependencies: const [], + )(42); test('returns true if in the root container', () { final container = ProviderContainer.test(); @@ -99,7 +108,7 @@ void main() { overrides: [ // An unrelated override, added to avoid the container optimizing // pointers away. - Provider((ref) => null), + Provider((ref) => null, dependencies: const []), ], ); @@ -121,7 +130,7 @@ void main() { overrides: [ // An unrelated override, added to avoid the container optimizing // pointers away. - Provider((ref) => null), + Provider((ref) => null, dependencies: const []), ], ); @@ -149,8 +158,14 @@ void main() { }); group('hasLocallyOverriddenDependency', () { - final dependency = Provider((_) => 0); - final transitiveDependency = Provider((_) => 0); + final dependency = Provider( + (_) => 0, + dependencies: const [], + ); + final transitiveDependency = Provider( + (_) => 0, + dependencies: const [], + ); final a = Provider( (_) => 0, @@ -164,7 +179,7 @@ void main() { parent: root, overrides: [ // Unrelated override, to avoid the container optimizing the pointer away - Provider((ref) => null), + Provider((ref) => null, dependencies: const []), ], ); @@ -224,7 +239,10 @@ void main() { group('upsertDirectory', () { test('handles auto-scoping', () { - final dep = Provider((_) => 0); + final dep = Provider( + (_) => 0, + dependencies: const [], + ); final family = Provider.family( (ref, id) => 0, dependencies: [dep], @@ -343,7 +361,10 @@ void main() { group('upsertPointer', () { test('handles auto-scoping', () { - final dep = Provider((_) => 0); + final dep = Provider( + (_) => 0, + dependencies: const [], + ); final family = Provider.family( (ref, id) => 0, dependencies: [dep], @@ -416,7 +437,7 @@ void main() { parent: root, overrides: [ // An unrelated override, added to avoid the container optimizing - Provider((_) => 0), + Provider((_) => 0, dependencies: const []), ], ); final provider = Provider((ref) => 0); @@ -486,10 +507,300 @@ void main() { ); }); }); + + group('remove', () { + test('if called on a provider that is not mounted, is no-op', () {}); + + test('removes non-family providers from orphan list', () { + final provider = Provider((_) => 0); + final container = ProviderContainer.test(); + + final pointer = container.pointerManager.upsertPointer(provider); + + expect( + container.pointerManager.orphanPointers.pointers, + {provider: isPointer()}, + ); + + final removed = container.pointerManager.remove(provider); + + expect(removed, pointer); + expect( + container.pointerManager.orphanPointers.pointers, + isEmpty, + ); + }); + + test('removes family providers from family list', () { + final family = Provider.family((ref, _) => 0); + final container = ProviderContainer.test(); + + final pointer = container.pointerManager.upsertPointer(family(42)); + // Mounting two values to avoid testing for empty families + container.pointerManager.upsertPointer(family(21)); + + expect( + container.pointerManager.familyPointers[family]!.pointers, + {family(42): isPointer(), family(21): isPointer()}, + ); + + final removed = container.pointerManager.remove(family(42)); + + expect(removed, pointer); + expect( + container.pointerManager.familyPointers[family]!.pointers, + {family(21): isPointer()}, + ); + }); + + test('if a family becomes empty after a remove, remove the directory', + () { + final family = Provider.family((ref, _) => 0); + final container = ProviderContainer.test(); + + final pointer = container.pointerManager.upsertPointer(family(42)); + + expect( + container.pointerManager.familyPointers, + {family: isProviderDirectory()}, + ); + + final removed = container.pointerManager.remove(family(42)); + + expect(removed, pointer); + expect( + container.pointerManager.familyPointers, + isEmpty, + ); + }); + + test('if a family is not empty after a remove, keep the directory', () { + final family = Provider.family((ref, _) => 0); + final container = ProviderContainer.test(); + + final pointer = container.pointerManager.upsertPointer(family(42)); + container.pointerManager.upsertPointer(family(21)); + + expect( + container.pointerManager.familyPointers, + { + family: isProviderDirectory( + pointers: { + family(42): isPointer(), + family(21): isPointer(), + }, + ), + }, + ); + + final removed = container.pointerManager.remove(family(42)); + + expect(removed, pointer); + expect( + container.pointerManager.familyPointers, + { + family: isProviderDirectory(pointers: {family(21): isPointer()}), + }, + ); + }); + + test('if an orphan provider is from an override, keep the pointer', () { + final provider = Provider((_) => 0); + final override = provider.overrideWithValue(42); + final container = ProviderContainer.test( + overrides: [override], + ); + + final pointer = container.pointerManager.upsertPointer(provider); + + expect( + container.pointerManager.orphanPointers.pointers, + {provider: isPointer(override: override)}, + ); + + final removed = container.pointerManager.remove(provider); + + expect(removed, pointer); + expect( + container.pointerManager.orphanPointers.pointers, + {provider: isPointer(override: override)}, + ); + }); + + test('if a family provider is from a manual override, keep the pointer', + () { + final family = Provider.family((ref, _) => 0); + final override = family(21).overrideWith((ref) => 42); + final container = ProviderContainer.test( + overrides: [override], + ); + + final pointer = container.pointerManager.upsertPointer(family(21)); + + expect( + container.pointerManager.familyPointers[family]!.pointers, + {family(21): isPointer(override: override)}, + ); + + final removed = container.pointerManager.remove(family(21)); + + expect(removed, pointer); + expect( + container.pointerManager.familyPointers, + { + family: isProviderDirectory( + pointers: {family(21): isPointer(override: override)}, + ), + }, + ); + }); + + test( + 'if a family becomes empty after a remove but is from a manual override, ' + 'keep the directory', () { + final family = Provider.family((ref, _) => 0); + final override = family.overrideWith((ref, _) => 42); + final container = ProviderContainer.test( + overrides: [override], + ); + + final pointer = container.pointerManager.upsertPointer(family(21)); + + expect( + container.pointerManager.familyPointers, + { + family: isProviderDirectory( + override: override, + pointers: {family(21): isPointer()}, + ), + }, + ); + + final removed = container.pointerManager.remove(family(21)); + + expect(removed, pointer); + expect( + container.pointerManager.familyPointers, + { + family: isProviderDirectory( + override: override, + pointers: isEmpty, + ), + }, + ); + }); + + test( + 'if an orphan is from a transitive override, ' + 'removes the pointer', () { + final dep = Provider( + (_) => 0, + dependencies: const [], + ); + final provider = Provider((ref) => 0, dependencies: [dep]); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [dep], + ); + + final pointer = container.pointerManager.upsertPointer(provider); + + expect( + container.pointerManager.orphanPointers.pointers, + { + dep: isPointer(override: dep), + provider: isPointer( + override: isTransitiveProviderOverride(provider), + ) + }, + ); + + final removed = container.pointerManager.remove(provider); + + expect(removed, pointer); + expect( + container.pointerManager.orphanPointers.pointers, + {dep: isPointer(override: dep)}, + ); + }); + + test( + 'if a family is from a transitive override and becomes empty, ' + 'remove the directory', () { + final dep = Provider( + (_) => 0, + dependencies: const [], + ); + final family = Provider.family( + (ref, _) => 0, + dependencies: [dep], + ); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [dep], + ); + + final pointer = container.pointerManager.upsertPointer(family(42)); + + expect( + container.pointerManager.familyPointers, + { + family: isProviderDirectory( + override: isTransitiveFamilyOverride(family), + pointers: {family(42): isPointer()}, + ), + }, + ); + + final removed = container.pointerManager.remove(family(42)); + + expect(removed, pointer); + expect( + container.pointerManager.familyPointers, + isEmpty, + ); + }); + }); }); group('ProviderContainer', () { group('constructor', () { + test('throws if trying to scope a provider/family with no dependencies', + () { + // TODO changelog + + final provider = Provider((_) => 0); + final family = Provider.family((ref, _) => 0); + + final root = ProviderContainer.test(); + + expect( + () => ProviderContainer.test( + parent: root, + overrides: [provider], + ), + throwsA(isA()), + ); + + expect( + () => ProviderContainer.test( + parent: root, + overrides: [family], + ), + throwsA(isA()), + ); + + expect( + () => ProviderContainer.test( + parent: root, + overrides: [family(21)], + ), + throwsA(isA()), + ); + }); + test('registers itself in the container list', () { final container = ProviderContainer(); addTearDown(container.dispose); @@ -592,8 +903,14 @@ void main() { test( 'supports overriding an already overridden provider/family in a different container', () { - final provider = Provider((ref) => 0); - final family = Provider.family((ref, id) => 0); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); + final family = Provider.family( + (ref, id) => 0, + dependencies: const [], + ); final root = ProviderContainer( overrides: [ provider.overrideWithValue(42), @@ -634,7 +951,7 @@ void main() { parent: root, overrides: [ // An unrelated override, added to avoid the container optimizing - Provider((_) => 0), + Provider((_) => 0, dependencies: const []), ], ); @@ -654,20 +971,34 @@ void main() { test('inherits overrides from its parents', () { final a = Provider((_) => 0, name: 'a'); final aOverride = a.overrideWithValue(1); - final b = Provider((_) => 0, name: 'b'); + final b = Provider( + (_) => 0, + name: 'b', + dependencies: const [], + ); final bOverride = b.overrideWithValue(2); - final c = Provider((_) => 0, name: 'c'); + final c = Provider( + (_) => 0, + name: 'c', + dependencies: const [], + ); final cOverride = c.overrideWithValue(3); final aFamily = Provider.family((_, __) => 0, name: 'aFamily'); final aFamilyOverride = aFamily.overrideWith((_, __) => 1); final aValueOverride = aFamily(1).overrideWith((_) => 2); - final bFamily = - Provider.family((_, __) => 0, name: 'bFamily'); + final bFamily = Provider.family( + (_, __) => 0, + name: 'bFamily', + dependencies: const [], + ); final bFamilyOverride = bFamily.overrideWith((_, __) => 2); final bValueOverride = bFamily(2).overrideWith((_) => 3); - final cFamily = - Provider.family((_, __) => 0, name: 'cFamily'); + final cFamily = Provider.family( + (_, __) => 0, + name: 'cFamily', + dependencies: const [], + ); final cFamilyOverride = cFamily.overrideWith((_, __) => 3); final cValueOverride = cFamily(3).overrideWith((_) => 4); @@ -752,7 +1083,7 @@ void main() { final root = ProviderContainer.test(); final mid = ProviderContainer.test( parent: root, - overrides: [Provider((_) => 0)], + overrides: [Provider((_) => 0, dependencies: const [])], ); final container = ProviderContainer.test(parent: mid); final container2 = ProviderContainer.test(parent: mid, overrides: []); @@ -776,11 +1107,14 @@ void main() { ); }); - // TODO throw if trying to scope a provider/family with no dependencies + // TODO throw if trying to cope a provider/family with no dependencies test('orphanPointers.containers are always equal to root', () { final root = ProviderContainer.test(); - final provider = Provider((_) => 0); + final provider = Provider( + (_) => 0, + dependencies: const [], + ); final container = ProviderContainer.test( parent: root, overrides: [provider], @@ -806,7 +1140,10 @@ void main() { }); test('adds non-family provider overrides to orphanPointers', () { - final provider = Provider((_) => 0); + final provider = Provider( + (_) => 0, + dependencies: const [], + ); final override = provider.overrideWithValue(42); final root = ProviderContainer.test( overrides: [override], @@ -853,7 +1190,10 @@ void main() { }); test('adds family overrides to familyPointers', () { - final provider = Provider.family((ref, _) => 0); + final provider = Provider.family( + (ref, _) => 0, + dependencies: const [], + ); final override = provider.overrideWith((ref, arg) => 0); final root = ProviderContainer.test( overrides: [override], @@ -892,7 +1232,10 @@ void main() { }); test('adds family provider overrides to familyPointers.pointers', () { - final provider = Provider.family((ref, _) => 0); + final provider = Provider.family( + (ref, _) => 0, + dependencies: const [], + ); final override = provider(42).overrideWith((ref) => 0); final root = ProviderContainer.test( overrides: [override], @@ -1019,7 +1362,10 @@ void main() { }); test('Passes parameters', () { - final provider = Provider((ref) => 0); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); final observer = _EmptyObserver(); final root = ProviderContainer.test(); @@ -1088,10 +1434,13 @@ void main() { final rootOnDispose = OnDisposeMock(); final childOnDispose = OnDisposeMock(); final child2OnDispose = OnDisposeMock(); - final provider = Provider((ref) { - ref.onDispose(rootOnDispose.call); - return 0; - }); + final provider = Provider( + (ref) { + ref.onDispose(rootOnDispose.call); + return 0; + }, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( @@ -1216,10 +1565,15 @@ void main() { test('handles nested providers', () { final provider = Provider((ref) => 0); - final provider2 = Provider((ref) => 0); + final provider2 = Provider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider2]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider2], + ); expect(container.exists(provider), false); expect(container.exists(provider2), false); @@ -1250,7 +1604,10 @@ void main() { () async { final dep = StateProvider((ref) => 0); final a = Provider((ref) => ref.watch(dep)); - final b = Provider((ref) => ref.watch(dep)); + final b = Provider( + (ref) => ref.watch(dep), + dependencies: const [], + ); final aListener = Listener(); final bListener = Listener(); @@ -1379,7 +1736,10 @@ void main() { test('updating parent override when there is a child override is no-op', () async { - final provider = Provider((ref) => 0); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test( overrides: [provider.overrideWithValue(21)], ); @@ -1438,7 +1798,10 @@ void main() { test( 'if listened from a child container, ' 'updating the parent override correctly notifies listeners', () { - final provider = Provider((ref) => 0); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test( overrides: [provider.overrideWithValue(1)], ); diff --git a/packages/riverpod/test/old/framework/auto_dispose_test.dart b/packages/riverpod/test/old/framework/auto_dispose_test.dart index fec0780be..9b051b171 100644 --- a/packages/riverpod/test/old/framework/auto_dispose_test.dart +++ b/packages/riverpod/test/old/framework/auto_dispose_test.dart @@ -527,26 +527,6 @@ final alwaysAlive = Provider((ref) { expect(container.getAllProviderElements(), isEmpty); }); - test('supports disposing of overridden families', () async { - // Regression test for https://github.com/rrousselGit/riverpod/issues/2480 - final provider = Provider.autoDispose.family((ref, _) => -1); - - var constructionCount = 0; - final root = createContainer(); - final container = createContainer( - parent: root, - overrides: [provider.overrideWith((ref, arg) => ++constructionCount)], - ); - - var count = container.read(provider(0)); - expect(count, 1); - - await container.pump(); - - count = container.read(provider(0)); - expect(count, 2); - }); - test( 'can select auto-dispose providers if the selecting provider is auto-dispose too', () { From e640d73653674851cd898ea878bec26e20e911f4 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 22 Dec 2023 18:39:06 +0100 Subject: [PATCH 083/387] Use ProviderContainer.test everywhere createContainer was used --- .../test/old/framework/auto_dispose_test.dart | 67 ++++---- .../test/old/framework/family_test.dart | 16 +- .../test/old/framework/listen_test.dart | 114 ++++++------- .../framework/provider_container_test.dart | 56 +++---- .../old/framework/provider_element_test.dart | 108 ++++++------- .../old/framework/provider_observer_test.dart | 60 +++---- .../riverpod/test/old/framework/ref_test.dart | 18 +-- .../test/old/framework/ref_watch_test.dart | 38 ++--- .../test/old/framework/scope_test.dart | 150 +++++++++--------- .../test/old/framework/select_async_test.dart | 28 ++-- .../old/framework/uni_directional_test.dart | 4 +- .../test/old/framework/visit_states_test.dart | 20 +-- .../old/legacy/framework2/framework_test.dart | 36 ++--- .../test/old/legacy/framework_test.dart | 29 ++-- .../async_notifier/async_notifier_test.dart | 84 +++++----- .../auto_dispose_family_test.dart | 13 +- ..._dispose_state_notifier_provider_test.dart | 31 ++-- .../state_notifier_provider/family_test.dart | 20 +-- .../state_notifier_provider_test.dart | 45 +++--- .../state_provider_auto_dispose_test.dart | 31 ++-- ...ate_provider_family_auto_dispose_test.dart | 13 +- .../state_provider_family_test.dart | 17 +- .../state_provider/state_provider_test.dart | 57 +++---- ...o_dispose_family_future_provider_test.dart | 15 +- .../auto_dispose_future_provider_test.dart | 35 ++-- .../family_future_provider_test.dart | 15 +- .../future_provider/future_provider_test.dart | 97 +++++------ .../notifier/notifier_test.dart | 50 +++--- .../auto_dispose_provider_family_test.dart | 11 +- .../provider/auto_dispose_provider_test.dart | 29 ++-- .../provider/provider_family_test.dart | 13 +- .../provider/provider_test.dart | 43 ++--- .../scoped_provider/scoped_provider_test.dart | 31 ++-- .../stream_notifier/async_notifier_test.dart | 74 ++++----- ...o_dispose_family_stream_provider_test.dart | 11 +- .../auto_dispose_stream_provider_test.dart | 29 ++-- .../stream_provider_family_test.dart | 13 +- .../stream_provider/stream_provider_test.dart | 73 ++++----- packages/riverpod/test/old/utils.dart | 14 -- 39 files changed, 813 insertions(+), 795 deletions(-) diff --git a/packages/riverpod/test/old/framework/auto_dispose_test.dart b/packages/riverpod/test/old/framework/auto_dispose_test.dart index 9b051b171..9ed96a29e 100644 --- a/packages/riverpod/test/old/framework/auto_dispose_test.dart +++ b/packages/riverpod/test/old/framework/auto_dispose_test.dart @@ -14,9 +14,9 @@ Future main() async { 'the child container keeps its override', () async { // Regression test for https://github.com/rrousselGit/riverpod/issues/1519 - final root = createContainer(); + final root = ProviderContainer.test(); final provider = Provider.autoDispose((ref) => 0); - final child = createContainer( + final child = ProviderContainer.test( parent: root, overrides: [provider.overrideWithValue(42)], ); @@ -37,8 +37,9 @@ Future main() async { () async { // regression test for https://github.com/rrousselGit/riverpod/issues/1400 final provider = Provider.autoDispose((ref) => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); container.read(provider); container.dispose(); @@ -49,7 +50,7 @@ Future main() async { group('ref.keepAlive', () { test('Does not cause an infinite loop if aborted directly in the callback', () async { - final container = createContainer(); + final container = ProviderContainer.test(); var buildCount = 0; var disposeCount = 0; final provider = Provider.autoDispose((ref) { @@ -80,7 +81,7 @@ Future main() async { }); test('when the provider rebuilds, links are cleared', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); KeepAliveLink? a; @@ -110,7 +111,7 @@ Future main() async { test('maintains the state of the provider until all links are closed', () async { - final container = createContainer(); + final container = ProviderContainer.test(); late KeepAliveLink a; late KeepAliveLink b; @@ -153,7 +154,7 @@ Future main() async { test( 'when closing KeepAliveLink, does not dispose the provider if it is still being listened to', () async { - final container = createContainer(); + final container = ProviderContainer.test(); late KeepAliveLink a; final provider = Provider.autoDispose((ref) { @@ -182,7 +183,7 @@ Future main() async { test( 'when closing the last KeepAliveLink, then immediately adding a new link, ' 'the provider will not be disposed.', () async { - final container = createContainer(); + final container = ProviderContainer.test(); late KeepAliveLink a; late AutoDisposeRef ref; @@ -312,7 +313,7 @@ final alwaysAlive = Provider((ref) { test( 'if a dependency changed, the element is still disposed, ' 'but without calling ref.onDispose again', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final onDispose = OnDisposeMock(); final dep = StateProvider((ref) => 0); final provider = Provider.autoDispose((ref) { @@ -343,7 +344,7 @@ final alwaysAlive = Provider((ref) { test( 'when a provider conditionally depends on another provider, rebuilding without the dependency can dispose the dependency', () async { - final container = createContainer(); + final container = ProviderContainer.test(); var dependencyDisposeCount = 0; final dependency = Provider.autoDispose( name: 'dependency', @@ -401,8 +402,8 @@ final alwaysAlive = Provider((ref) { return value; }); - final root = createContainer(); - final container = createContainer(parent: root); + final root = ProviderContainer.test(); + final container = ProviderContainer.test(parent: root); final sub = container.listen(provider, listener.call, fireImmediately: true); @@ -432,8 +433,9 @@ final alwaysAlive = Provider((ref) { () async { final provider = Provider.autoDispose((ref) => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); container.read(provider); expect(root.getAllProviderElements(), isEmpty); @@ -455,9 +457,9 @@ final alwaysAlive = Provider((ref) { () async { final provider = Provider.autoDispose((ref) => 0); - final root = createContainer(); - final mid = createContainer(parent: root, overrides: [provider]); - final container = createContainer(parent: mid); + final root = ProviderContainer.test(); + final mid = ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test(parent: mid); container.read(provider); expect(root.getAllProviderElements(), isEmpty); @@ -482,8 +484,9 @@ final alwaysAlive = Provider((ref) { () async { final provider = Provider.autoDispose.family((ref, _) => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); container.read(provider(0)); expect(root.getAllProviderElements(), isEmpty); @@ -505,9 +508,9 @@ final alwaysAlive = Provider((ref) { () async { final provider = Provider.autoDispose.family((ref, _) => 0); - final root = createContainer(); - final mid = createContainer(parent: root, overrides: [provider]); - final container = createContainer(parent: mid); + final root = ProviderContainer.test(); + final mid = ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test(parent: mid); container.read(provider(0)); expect(root.getAllProviderElements(), isEmpty); @@ -530,7 +533,7 @@ final alwaysAlive = Provider((ref) { test( 'can select auto-dispose providers if the selecting provider is auto-dispose too', () { - final container = createContainer(); + final container = ProviderContainer.test(); final selected = Provider.autoDispose((ref) => 0); final isEven = Provider.autoDispose((ref) { return ref.watch(selected.select((c) => c.isEven)); @@ -541,7 +544,7 @@ final alwaysAlive = Provider((ref) { test('unsub to A then make B sub to A then unsub to B disposes B before A', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final aDispose = OnDisposeMock(); final a = Provider.autoDispose((ref) { ref.onDispose(aDispose.call); @@ -574,7 +577,7 @@ final alwaysAlive = Provider((ref) { }); test('chain', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final onDispose = OnDisposeMock(); var value = 42; final provider = Provider.autoDispose((ref) { @@ -621,7 +624,7 @@ final alwaysAlive = Provider((ref) { }); test("auto dispose A then auto dispose B doesn't dispose A again", () async { - final container = createContainer(); + final container = ProviderContainer.test(); final aDispose = OnDisposeMock(); final a = Provider.autoDispose((ref) { ref.onDispose(aDispose.call); @@ -658,7 +661,7 @@ final alwaysAlive = Provider((ref) { test('ProviderContainer was disposed before AutoDisposer handled the dispose', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final onDispose = OnDisposeMock(); final provider = Provider.autoDispose((ref) { ref.onDispose(onDispose.call); @@ -683,7 +686,7 @@ final alwaysAlive = Provider((ref) { }); test('unsub no-op if another sub is added before event-loop', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final onDispose = OnDisposeMock(); final provider = Provider.autoDispose((ref) { ref.onDispose(onDispose.call); @@ -712,7 +715,7 @@ final alwaysAlive = Provider((ref) { test('no-op if when removing listener if there is still a listener', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final onDispose = OnDisposeMock(); final provider = Provider.autoDispose((ref) { ref.onDispose(onDispose.call); @@ -743,7 +746,7 @@ final alwaysAlive = Provider((ref) { ref.onDispose(onDispose.call); return 42; }); - final container = createContainer(); + final container = ProviderContainer.test(); final sub = container.listen(provider, (_, __) {}); sub.close(); @@ -760,7 +763,7 @@ final alwaysAlive = Provider((ref) { test('providers with only a "listen" as subscribers are kept alive', () async { - final container = createContainer(); + final container = ProviderContainer.test(); var mounted = true; final listened = Provider.autoDispose((ref) { ref.onDispose(() => mounted = false); diff --git a/packages/riverpod/test/old/framework/family_test.dart b/packages/riverpod/test/old/framework/family_test.dart index 06dd9325b..d0b6b8cd8 100644 --- a/packages/riverpod/test/old/framework/family_test.dart +++ b/packages/riverpod/test/old/framework/family_test.dart @@ -10,9 +10,9 @@ void main() { test( 'does not re-initialize a family if read by a child container after the provider was initialized', () { - final root = createContainer(); + final root = ProviderContainer.test(); // the child must be created before the provider is initialized - final child = createContainer(parent: root); + final child = ProviderContainer.test(parent: root); var buildCount = 0; final provider = Provider.family((ref, param) { @@ -38,10 +38,10 @@ void main() { return 42; }); - final root = createContainer(); - final scope = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final scope = ProviderContainer.test(parent: root, overrides: [provider]); // the child must be created before the provider is initialized - final child = createContainer(parent: scope); + final child = ProviderContainer.test(parent: scope); expect(scope.read(provider(0)), 42); @@ -56,7 +56,7 @@ void main() { test('caches the provider per value', () { final family = Provider.family((ref, a) => '$a'); - final container = createContainer(); + final container = ProviderContainer.test(); expect(family(42), family(42)); expect(container.read(family(42)), '42'); @@ -73,7 +73,7 @@ void main() { final family = StreamProvider.family((ref, a) { return controllers[a]!.stream; }); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); final listener2 = Listener>(); @@ -130,7 +130,7 @@ void main() { test('family override', () { final family = Provider.family((ref, a) => 'Hello $a'); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ // Provider overrides always takes over family overrides family(84).overrideWithValue('Bonjour 84'), diff --git a/packages/riverpod/test/old/framework/listen_test.dart b/packages/riverpod/test/old/framework/listen_test.dart index 326827b4f..b188626a7 100644 --- a/packages/riverpod/test/old/framework/listen_test.dart +++ b/packages/riverpod/test/old/framework/listen_test.dart @@ -10,7 +10,7 @@ import '../utils.dart'; void main() { group('Ref.listenSelf', () { test('does not break autoDispose', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider.autoDispose((ref) { ref.listenSelf((previous, next) {}); }); @@ -24,7 +24,7 @@ void main() { }); test('listens to mutations post build', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final listener2 = Listener(); @@ -57,7 +57,7 @@ void main() { }); test('listens to rebuild', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final listener2 = Listener(); var result = 0; @@ -89,7 +89,7 @@ void main() { }); test('notify listeners independently from updateShouldNotify', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final listener2 = Listener(); final provider = Provider((ref) { @@ -119,7 +119,7 @@ void main() { }); test('clears state listeners on rebuild', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final listener2 = Listener(); var result = 0; @@ -148,7 +148,7 @@ void main() { }); test('listens to errors', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final errorListener = ErrorListener(); final errorListener2 = ErrorListener(); @@ -184,7 +184,7 @@ void main() { }); test('executes error listener before other listeners', () { - final container = createContainer(); + final container = ProviderContainer.test(); final errorListener = ErrorListener(); final errorListener2 = ErrorListener(); Exception? error; @@ -213,7 +213,7 @@ void main() { }); test('executes state listener before other listeners', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final listener2 = Listener(); var result = 0; @@ -249,7 +249,7 @@ void main() { test( 'when rebuild throws identical error/stack, listeners are still notified', () { - final container = createContainer(); + final container = ProviderContainer.test(); const stack = StackTrace.empty; final listener = Listener(); final errorListener = ErrorListener(); @@ -274,7 +274,7 @@ void main() { }); test('cannot listen itself', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); late ProviderRef ref; late Provider provider; @@ -292,7 +292,7 @@ void main() { }); test('expose previous and new value on change', () { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateNotifierProvider, int>( (ref) => StateController(0), ); @@ -313,7 +313,7 @@ void main() { test( 'calling ref.listen on a provider with an outdated dependency flushes it, then add the listener', () { - final container = createContainer(); + final container = ProviderContainer.test(); var buildCount = 0; final dep2 = StateNotifierProvider, int>( (ref) => StateController(0), @@ -342,7 +342,7 @@ void main() { test( 'when using selectors, `previous` is the latest notification instead of latest event', () { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateNotifierProvider, int>( (ref) => StateController(0), ); @@ -369,7 +369,7 @@ void main() { test('when no onError is specified, fallbacks to handleUncaughtError', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final isErrored = StateProvider((ref) => false); final dep = Provider((ref) { if (ref.watch(isErrored)) throw UnimplementedError(); @@ -400,7 +400,7 @@ void main() { test( 'when no onError is specified, selectors fallbacks to handleUncaughtError', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final isErrored = StateProvider((ref) => false); final dep = Provider((ref) { if (ref.watch(isErrored)) throw UnimplementedError(); @@ -429,7 +429,7 @@ void main() { }); test('when rebuild throws, calls onError', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = Provider((ref) { if (ref.watch(dep) != 0) { @@ -460,7 +460,7 @@ void main() { }); test('when rebuild throws on selector, calls onError', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = Provider((ref) { if (ref.watch(dep) != 0) { @@ -497,7 +497,7 @@ void main() { group('fireImmediately', () { test('when no onError is specified, fallbacks to handleUncaughtError', () { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = Provider((ref) => throw UnimplementedError()); final listener = Listener(); final errors = []; @@ -525,7 +525,7 @@ void main() { test( 'when no onError is specified on selectors, fallbacks to handleUncaughtError', () { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = Provider((ref) => throw UnimplementedError()); final listener = Listener(); final errors = []; @@ -551,7 +551,7 @@ void main() { }); test('on provider that threw, fireImmediately calls onError', () { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = Provider((ref) => throw UnimplementedError()); final listener = Listener(); final errorListener = ErrorListener(); @@ -575,7 +575,7 @@ void main() { test('when selecting provider that threw, fireImmediately calls onError', () { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = Provider((ref) => throw UnimplementedError()); final listener = Listener(); final errorListener = ErrorListener(); @@ -602,7 +602,7 @@ void main() { final listener = Listener(); var isFirstCall = true; - final container = createContainer(); + final container = ProviderContainer.test(); final errors = []; ProviderSubscription? sub; @@ -639,7 +639,7 @@ void main() { final listener = Listener(); var isFirstCall = true; - final container = createContainer(); + final container = ProviderContainer.test(); final errors = []; ProviderSubscription? sub; @@ -685,7 +685,7 @@ void main() { final errorListener = ErrorListener(); var isFirstCall = true; - final container = createContainer(); + final container = ProviderContainer.test(); final errors = []; ProviderSubscription? sub; @@ -739,7 +739,7 @@ void main() { final errorListener = ErrorListener(); var isFirstCall = true; - final container = createContainer(); + final container = ProviderContainer.test(); final errors = []; ProviderSubscription? sub; @@ -784,7 +784,7 @@ void main() { group('ProviderContainer.listen', () { test('when no onError is specified, fallbacks to handleUncaughtError', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final isErrored = StateProvider((ref) => false); final dep = Provider((ref) { if (ref.watch(isErrored)) throw UnimplementedError(); @@ -812,7 +812,7 @@ void main() { test( 'when no onError is specified, selectors fallbacks to handleUncaughtError', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final isErrored = StateProvider((ref) => false); final dep = Provider((ref) { if (ref.watch(isErrored)) throw UnimplementedError(); @@ -838,7 +838,7 @@ void main() { }); test('when rebuild throws, calls onError', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = Provider((ref) { if (ref.watch(dep) != 0) { @@ -865,7 +865,7 @@ void main() { }); test('when rebuild throws on selector, calls onError', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = Provider((ref) { if (ref.watch(dep) != 0) { @@ -898,7 +898,7 @@ void main() { test( 'when using selectors, `previous` is the latest notification instead of latest event', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateNotifierProvider, int>( (ref) => StateController(0), ); @@ -922,7 +922,7 @@ void main() { }); test('expose previous and new value on change', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateNotifierProvider, int>( (ref) => StateController(0), ); @@ -941,7 +941,7 @@ void main() { final listener = Listener(); final dep = StateProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(dep, listener.call); @@ -957,7 +957,7 @@ void main() { 'if a listener adds a container.listen, the new listener is not called immediately', () { final provider = StateProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); @@ -981,7 +981,7 @@ void main() { 'if a listener removes another provider.listen, the removed listener is still called', () { final provider = StateProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final listener2 = Listener(); @@ -1019,7 +1019,7 @@ void main() { skip: true, () { final provider = StateProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final listener2 = Listener(); @@ -1063,7 +1063,7 @@ void main() { 'if a listener adds a provider.listen, the new listener is not called immediately', () { final provider = StateProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); @@ -1091,7 +1091,7 @@ void main() { skip: true, () { final provider = StateProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final listener2 = Listener(); @@ -1132,7 +1132,7 @@ void main() { 'if a listener removes another container.listen, the removed listener is still called', () { final provider = StateProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final listener2 = Listener(); @@ -1165,7 +1165,7 @@ void main() { group('fireImmediately', () { test('when no onError is specified, fallbacks to handleUncaughtError', () { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = Provider((ref) => throw UnimplementedError()); final listener = Listener(); final errors = []; @@ -1190,7 +1190,7 @@ void main() { test( 'when no onError is specified on selectors, fallbacks to handleUncaughtError', () { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = Provider((ref) => throw UnimplementedError()); final listener = Listener(); final errors = []; @@ -1213,7 +1213,7 @@ void main() { }); test('on provider that threw, fireImmediately calls onError', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider((ref) => throw UnimplementedError()); final listener = Listener(); final errorListener = ErrorListener(); @@ -1233,7 +1233,7 @@ void main() { }); test('supports selectors', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateNotifierProvider((ref) => Counter()); final listener = Listener(); @@ -1259,7 +1259,7 @@ void main() { final provider = StateProvider((ref) => 0); final listener = Listener(); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider, listener.call); @@ -1280,7 +1280,7 @@ void main() { final errorListener = ErrorListener(); var isFirstCall = true; - final container = createContainer(); + final container = ProviderContainer.test(); final errors = []; final sub = runZonedGuarded( @@ -1330,7 +1330,7 @@ void main() { final errorListener = ErrorListener(); var isFirstCall = true; - final container = createContainer(); + final container = ProviderContainer.test(); final errors = []; final sub = runZonedGuarded( @@ -1371,7 +1371,7 @@ void main() { final listener = Listener(); var isFirstCall = true; - final container = createContainer(); + final container = ProviderContainer.test(); final errors = []; final sub = runZonedGuarded( @@ -1403,7 +1403,7 @@ void main() { final listener = Listener(); var isFirstCall = true; - final container = createContainer(); + final container = ProviderContainer.test(); final errors = []; final sub = runZonedGuarded( @@ -1435,7 +1435,7 @@ void main() { final listener = Listener(); var isFirstCall = true; - final container = createContainer(); + final container = ProviderContainer.test(); final errors = []; final sub = runZonedGuarded( @@ -1466,7 +1466,7 @@ void main() { test('.read on closed subscription throws', () { final notifier = Counter(); final provider = StateNotifierProvider((_) => notifier); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final sub = @@ -1486,7 +1486,7 @@ void main() { test('.read on closed selector subscription throws', () { final notifier = Counter(); final provider = StateNotifierProvider((_) => notifier); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final sub = container.listen( @@ -1506,7 +1506,7 @@ void main() { }); test("doesn't trow when creating a provider that failed", () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider((ref) { throw Error(); }); @@ -1517,7 +1517,7 @@ void main() { }); test('selectors can close listeners', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateNotifierProvider((ref) => Counter()); expect(container.readProviderElement(provider).hasListeners, false); @@ -1535,7 +1535,7 @@ void main() { }); test('can watch selectors', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateNotifierProvider((ref) => Counter()); final isAdultSelector = Selector(false, (c) => c >= 18); final isAdultListener = Listener(); @@ -1570,7 +1570,7 @@ void main() { final provider = Provider((ref) => 0); final listener = Listener(); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider, listener.call, fireImmediately: true); @@ -1580,7 +1580,7 @@ void main() { test('call listener when provider rebuilds', () async { final controller = StreamController(); addTearDown(controller.close); - final container = createContainer(); + final container = ProviderContainer.test(); final count = StateProvider((ref) => 0); final provider = Provider((ref) => ref.watch(count)); @@ -1600,7 +1600,7 @@ void main() { }); test('call listener when provider emits an update', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final count = StateProvider((ref) => 0); final listener = Listener(); @@ -1617,7 +1617,7 @@ void main() { }); test('supports selectors', () { - final container = createContainer(); + final container = ProviderContainer.test(); final count = StateProvider((ref) => 0); final listener = Listener(); diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 273034d9a..31f32d899 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -11,14 +11,14 @@ void main() { 'cleans up all the StateReaders of a provider in the entire ProviderContainer tree', () async { // Regression test for https://github.com/rrousselGit/riverpod/issues/1943 - final a = createContainer(); + final a = ProviderContainer.test(); // b/c voluntarily do not use the Provider, but a/d do. This is to test // that the disposal logic correctly cleans up the StateReaders // in all ProviderContainers associated with the provider, even if // some links between two ProviderContainers are not using the provider. - final b = createContainer(parent: a); - final c = createContainer(parent: b); - final d = createContainer(parent: c); + final b = ProviderContainer.test(parent: a); + final c = ProviderContainer.test(parent: b); + final d = ProviderContainer.test(parent: c); final provider = Provider.autoDispose((ref) => 3); @@ -124,7 +124,7 @@ void main() { }); test('invalidate triggers a rebuild on next frame', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); var result = 0; final provider = Provider((r) => result); @@ -149,8 +149,8 @@ void main() { final dep = Provider((ref) => 0); final provider = Provider((ref) => ref.watch(dep)); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -168,8 +168,8 @@ void main() { final dep = Provider((ref) => ref.watch(transitiveDep)); final provider = Provider((ref) => ref.watch(dep)); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [transitiveDep.overrideWithValue(42)], ); @@ -190,7 +190,7 @@ void main() { ref.listen(provider, (prev, value) => ref.controller.state++); return 0; }); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(another), 0); @@ -208,7 +208,7 @@ void main() { ref.listen(provider, (prev, value) => ref.controller.state++); return 0; }); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(another), 0); @@ -220,8 +220,8 @@ void main() { group('getAllProviderElements', () { test('list scoped providers that depends on nothing', () { final scopedProvider = Provider((ref) => 0); - final parent = createContainer(); - final child = createContainer( + final parent = ProviderContainer.test(); + final child = ProviderContainer.test( parent: parent, overrides: [scopedProvider], ); @@ -240,8 +240,8 @@ void main() { () { final dependency = Provider((ref) => 0); final scopedProvider = Provider((ref) => ref.watch(dependency)); - final parent = createContainer(); - final child = createContainer( + final parent = ProviderContainer.test(); + final child = ProviderContainer.test( parent: parent, overrides: [scopedProvider], ); @@ -261,9 +261,11 @@ void main() { final provider = Provider((ref) => 0); final provider2 = Provider((ref) => 0); final provider3 = Provider((ref) => 0); - final root = createContainer(); - final mid = createContainer(parent: root, overrides: [provider2]); - final leaf = createContainer(parent: mid, overrides: [provider3]); + final root = ProviderContainer.test(); + final mid = + ProviderContainer.test(parent: root, overrides: [provider2]); + final leaf = + ProviderContainer.test(parent: mid, overrides: [provider3]); leaf.read(provider); leaf.read(provider2); @@ -325,8 +327,8 @@ void main() { group('getAllProviderElementsInOrder', () { test('list scoped providers that depends on nothing', () { final scopedProvider = Provider((ref) => 0); - final parent = createContainer(); - final child = createContainer( + final parent = ProviderContainer.test(); + final child = ProviderContainer.test( parent: parent, overrides: [scopedProvider], ); @@ -345,8 +347,8 @@ void main() { () { final dependency = Provider((ref) => 0); final scopedProvider = Provider((ref) => ref.watch(dependency)); - final parent = createContainer(); - final child = createContainer( + final parent = ProviderContainer.test(); + final child = ProviderContainer.test( parent: parent, overrides: [scopedProvider], ); @@ -364,9 +366,9 @@ void main() { test( 'does not re-initialize a provider if read by a child container after the provider was initialized', () { - final root = createContainer(); + final root = ProviderContainer.test(); // the child must be created before the provider is initialized - final child = createContainer(parent: root); + final child = ProviderContainer.test(parent: root); var buildCount = 0; final provider = Provider((ref) { @@ -385,7 +387,7 @@ void main() { test('builds providers at most once per container', () { var result = 42; - final container = createContainer(); + final container = ProviderContainer.test(); var callCount = 0; final provider = Provider((_) { callCount++; @@ -398,7 +400,7 @@ void main() { expect(container.read(provider), 42); expect(callCount, 1); - final container2 = createContainer(); + final container2 = ProviderContainer.test(); result = 21; expect(container2.read(provider), 21); @@ -411,7 +413,7 @@ void main() { test( 'does not refresh providers if their dependencies changes but they have no active listeners', () async { - final container = createContainer(); + final container = ProviderContainer.test(); var buildCount = 0; final dep = StateProvider((ref) => 0); diff --git a/packages/riverpod/test/old/framework/provider_element_test.dart b/packages/riverpod/test/old/framework/provider_element_test.dart index 2ef4471e5..c361f102c 100644 --- a/packages/riverpod/test/old/framework/provider_element_test.dart +++ b/packages/riverpod/test/old/framework/provider_element_test.dart @@ -9,8 +9,8 @@ import '../utils.dart'; void main() { group('Ref.exists', () { test('Returns true if available on ancestor container', () { - final root = createContainer(); - final container = createContainer(parent: root); + final root = ProviderContainer.test(); + final container = ProviderContainer.test(parent: root); final provider = Provider((ref) => 0); root.read(provider); @@ -20,7 +20,7 @@ void main() { }); test('simple use-case', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider((ref) => 0); final refProvider = Provider((ref) => ref); @@ -45,7 +45,7 @@ void main() { final observer = ProviderObserverMock(); final listener = Listener(); final selfListener = Listener(); - final container = createContainer(observers: [observer]); + final container = ProviderContainer.test(observers: [observer]); late Ref ref; final provider = Provider((r) { ref = r; @@ -75,7 +75,7 @@ void main() { final observer = ProviderObserverMock(); final selfListener = Listener(); final listener = Listener(); - final container = createContainer(observers: [observer]); + final container = ProviderContainer.test(observers: [observer]); final provider = Provider((ref) { ref.listenSelf(selfListener.call); ref.notifyListeners(); @@ -95,7 +95,7 @@ void main() { final observer = ProviderObserverMock(); final listener = Listener(); final selfListener = Listener(); - final container = createContainer(observers: [observer]); + final container = ProviderContainer.test(observers: [observer]); var callNotifyListeners = false; const firstValue = 'first'; const secondValue = 'second'; @@ -145,7 +145,7 @@ void main() { return 0; }); final b = Provider((r) => r.watch(a)); - final container = createContainer(); + final container = ProviderContainer.test(); container.read(b); @@ -165,7 +165,7 @@ void main() { return 0; }); final b = Provider((r) => r.watch(a)); - final container = createContainer(); + final container = ProviderContainer.test(); container.read(b); @@ -182,7 +182,7 @@ void main() { return 0; }); final b = Provider.family((r, id) => r.watch(a)); - final container = createContainer(); + final container = ProviderContainer.test(); container.read(b(0)); @@ -193,7 +193,7 @@ void main() { }); test('triggers a rebuild on next frame', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); var result = 0; final provider = Provider((r) => result); @@ -219,7 +219,7 @@ void main() { group('on families', () { test('recomputes providers associated with the family', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final listener2 = Listener(); final listener3 = Listener(); @@ -265,8 +265,8 @@ void main() { final provider = Provider.family((r, i) => result); final listener = Listener(); final listener2 = Listener(); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [provider, another], ); @@ -294,7 +294,7 @@ void main() { group('ref.invalidateSelf', () { test('calls dispose immediately', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnDisposeMock(); late Ref ref; final provider = Provider((r) { @@ -315,7 +315,7 @@ void main() { }); test('triggers a rebuild on next frame', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); var result = 0; late Ref ref; @@ -339,7 +339,7 @@ void main() { }); test('merges the rebuild with dependency change rebuild', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final dep = StateProvider((ref) => 0); late Ref ref; @@ -364,7 +364,7 @@ void main() { group('ref.onRemoveListener', () { test('is not called on read', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnRemoveListener(); final provider = Provider((ref) { ref.onRemoveListener(listener.call); @@ -376,7 +376,7 @@ void main() { }); test('calls listeners when container.listen subscriptions are closed', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnRemoveListener(); final listener2 = OnRemoveListener(); final provider = Provider((ref) { @@ -407,7 +407,7 @@ void main() { }); test('calls listeners when ref.listen subscriptions are closed', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnRemoveListener(); final listener2 = OnRemoveListener(); final dep = Provider( @@ -452,7 +452,7 @@ void main() { }); test('calls listeners when ref.watch subscriptions are removed', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnRemoveListener(); final listener2 = OnRemoveListener(); final dep = Provider( @@ -484,7 +484,7 @@ void main() { }); test('listeners are cleared on rebuild', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnRemoveListener(); final listener2 = OnRemoveListener(); var isSecondBuild = false; @@ -510,7 +510,7 @@ void main() { test('if a listener throws, still calls all listeners', () { final errors = []; - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnRemoveListener(); final listener2 = OnRemoveListener(); when(listener()).thenThrow(42); @@ -535,7 +535,7 @@ void main() { group('ref.onAddListener', () { test('is not called on read', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnAddListener(); final provider = Provider((ref) { ref.onAddListener(listener.call); @@ -547,7 +547,7 @@ void main() { }); test('calls listeners when container.listen is invoked', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnAddListener(); final listener2 = OnAddListener(); final provider = Provider((ref) { @@ -569,7 +569,7 @@ void main() { }); test('calls listeners when new ref.listen is invoked', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnAddListener(); final listener2 = OnAddListener(); final dep = Provider( @@ -602,7 +602,7 @@ void main() { }); test('calls listeners when new ref.watch is invoked', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnAddListener(); final listener2 = OnAddListener(); final dep = Provider( @@ -646,7 +646,7 @@ void main() { }); test('listeners are cleared on rebuild', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnAddListener(); final listener2 = OnAddListener(); var isSecondBuild = false; @@ -671,7 +671,7 @@ void main() { test('if a listener throws, still calls all listeners', () { final errors = []; - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnAddListener(); final listener2 = OnAddListener(); when(listener()).thenThrow(42); @@ -694,7 +694,7 @@ void main() { group('ref.onResume', () { test('is not called on initial subscription', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnResume(); final provider = Provider((ref) { ref.onResume(listener.call); @@ -708,7 +708,7 @@ void main() { test('calls listeners on the first new container.listen after a cancel', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnResume(); final listener2 = OnResume(); final provider = Provider((ref) { @@ -735,7 +735,7 @@ void main() { }); test('calls listeners on the first new ref.listen after a cancel', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnResume(); final listener2 = OnResume(); final dep = Provider( @@ -772,7 +772,7 @@ void main() { }); test('does not call listeners on read after a cancel', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnResume(); final provider = Provider((ref) { ref.onResume(listener.call); @@ -789,7 +789,7 @@ void main() { }); test('calls listeners when ref.watch is invoked after a cancel', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnResume(); final listener2 = OnResume(); final dep = Provider( @@ -821,7 +821,7 @@ void main() { }); test('listeners are cleared on rebuild', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnResume(); final listener2 = OnResume(); var isSecondBuild = false; @@ -851,7 +851,7 @@ void main() { }); test('internal resume status is cleared on rebuild', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnResume(); final provider = Provider((ref) { ref.onResume(listener.call); @@ -874,7 +874,7 @@ void main() { test('if a listener throws, still calls all listeners', () { final errors = []; - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnResume(); final listener2 = OnResume(); when(listener()).thenThrow(42); @@ -907,7 +907,7 @@ void main() { skip: 'Waiting for "clear dependencies after futureprovider rebuilds"', () async { // - final container = createContainer(); + final container = ProviderContainer.test(); final onCancel = OnCancelMock(); final dep = StateProvider((ref) { ref.onCancel(onCancel.call); @@ -930,7 +930,7 @@ void main() { ); test('is called when all container listeners are removed', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnCancelMock(); final listener2 = OnCancelMock(); final provider = Provider((ref) { @@ -956,7 +956,7 @@ void main() { }); test('is called when all provider listeners are removed', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnCancelMock(); final listener2 = OnCancelMock(); final dep = Provider((ref) { @@ -987,7 +987,7 @@ void main() { }); test('is called when all provider dependencies are removed', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnCancelMock(); final listener2 = OnCancelMock(); final dep = Provider((ref) { @@ -1023,7 +1023,7 @@ void main() { }); test('is not called when using container.read', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnCancelMock(); final provider = Provider((ref) { ref.onCancel(listener.call); @@ -1039,7 +1039,7 @@ void main() { 'is not called when using container.read (autoDispose)', skip: true, () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnCancelMock(); final dispose = OnDisposeMock(); final provider = StateProvider.autoDispose((ref) { @@ -1057,7 +1057,7 @@ void main() { ); test('listeners are cleared on rebuild', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnCancelMock(); final listener2 = OnCancelMock(); var isSecondBuild = false; @@ -1090,7 +1090,7 @@ void main() { test('if a listener throws, still calls all listeners', () { final errors = []; - final container = createContainer(); + final container = ProviderContainer.test(); final listener = OnCancelMock(); final listener2 = OnCancelMock(); when(listener()).thenThrow(42); @@ -1120,7 +1120,7 @@ void main() { 'onDispose is triggered only once if within autoDispose unmount, a dependency changed', () async { // regression test for https://github.com/rrousselGit/riverpod/issues/1064 - final container = createContainer(); + final container = ProviderContainer.test(); final onDispose = OnDisposeMock(); final dep = StateProvider((ref) => 0); final provider = Provider.autoDispose((ref) { @@ -1145,7 +1145,7 @@ void main() { test( 'does not throw outdated error when a dependency is flushed while the dependent is building', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final a = StateProvider((ref) => 0); final dep = Provider((ref) { @@ -1182,7 +1182,7 @@ void main() { group('getState', () { test('throws on providers that threw', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider((ref) => throw UnimplementedError()); final element = container.readProviderElement(provider); @@ -1197,7 +1197,7 @@ void main() { group('readSelf', () { test('throws on providers that threw', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider((ref) => throw UnimplementedError()); final element = container.readProviderElement(provider); @@ -1211,7 +1211,7 @@ void main() { group('visitChildren', () { test('includes ref.watch dependents', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider((ref) => 0); final dependent = Provider((ref) { ref.watch(provider); @@ -1240,7 +1240,7 @@ void main() { }); test('includes ref.listen dependents', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider((ref) => 0); final dependent = Provider((ref) { ref.listen(provider, (_, __) {}); @@ -1277,7 +1277,7 @@ void main() { final dep = Provider((ref) { ref.listen(provider, (prev, value) {}); }); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.readProviderElement(provider).hasListeners, false); @@ -1291,7 +1291,7 @@ void main() { final dep = Provider((ref) { ref.watch(provider); }); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.readProviderElement(provider).hasListeners, false); @@ -1302,7 +1302,7 @@ void main() { test('includes container listeners', () async { final provider = Provider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.readProviderElement(provider).hasListeners, false); @@ -1313,7 +1313,7 @@ void main() { }); test('does not notify listeners when rebuilding the state', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final dep = StateProvider((ref) => 0); diff --git a/packages/riverpod/test/old/framework/provider_observer_test.dart b/packages/riverpod/test/old/framework/provider_observer_test.dart index 8eae31284..b0da872e6 100644 --- a/packages/riverpod/test/old/framework/provider_observer_test.dart +++ b/packages/riverpod/test/old/framework/provider_observer_test.dart @@ -12,7 +12,7 @@ void main() { const observer = ConstObserver(); final provider = Provider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); observer.didAddProvider(provider, 0, container); observer.didDisposeProvider(provider, container); @@ -21,7 +21,7 @@ void main() { }); test('ProviderObservers can have const constructors', () { - final root = createContainer( + final root = ProviderContainer.test( observers: [ const ConstObserver(), ], @@ -35,7 +35,8 @@ void main() { () async { final observer = ObserverMock(); final observer2 = ObserverMock(); - final container = createContainer(observers: [observer, observer2]); + final container = + ProviderContainer.test(observers: [observer, observer2]); final dep = StateProvider((ref) => 0); final provider = Provider((ref) { if (ref.watch(dep) == 0) { @@ -79,12 +80,12 @@ void main() { final observer2 = ObserverMock('b'); final observer3 = ObserverMock('c'); - final root = createContainer(observers: [observer]); - final mid = createContainer( + final root = ProviderContainer.test(observers: [observer]); + final mid = ProviderContainer.test( parent: root, observers: [observer2], ); - final child = createContainer( + final child = ProviderContainer.test( parent: mid, overrides: [provider.overrideWith((ref) => StateController(42))], observers: [observer3], @@ -114,7 +115,7 @@ void main() { test('handles computed provider update', () async { final observer = ObserverMock(); - final container = createContainer(observers: [observer]); + final container = ProviderContainer.test(observers: [observer]); final notifier = Counter(); final provider = StateNotifierProvider((_) => notifier); final computed = Provider((ref) => ref.watch(provider)); @@ -134,7 +135,7 @@ void main() { test('handles direct provider update', () { final observer = ObserverMock(); - final container = createContainer(observers: [observer]); + final container = ProviderContainer.test(observers: [observer]); final notifier = Counter(); final provider = StateNotifierProvider((_) => notifier); @@ -154,7 +155,7 @@ void main() { final observer2 = ObserverMock('b'); final provider = StateNotifierProvider((_) => Counter()); final counter = Counter(); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith((ref) => counter), ], @@ -195,7 +196,7 @@ void main() { final observer3 = ObserverMock(); final provider = StateNotifierProvider((_) => Counter()); final counter = Counter(); - final container = createContainer( + final container = ProviderContainer.test( overrides: [provider.overrideWith((ref) => counter)], observers: [observer, observer2, observer3], ); @@ -228,7 +229,7 @@ void main() { final isNegative = Provider((ref) { return ref.watch(provider).isNegative; }); - final container = createContainer(observers: [observer]); + final container = ProviderContainer.test(observers: [observer]); final isNegativeListener = Listener(); container.listen( @@ -290,12 +291,12 @@ void main() { final observer2 = ObserverMock('b'); final observer3 = ObserverMock('c'); - final root = createContainer(observers: [observer]); - final mid = createContainer( + final root = ProviderContainer.test(observers: [observer]); + final mid = ProviderContainer.test( parent: root, observers: [observer2], ); - final child = createContainer( + final child = ProviderContainer.test( parent: mid, overrides: [ provider.overrideWith((ref) { @@ -344,7 +345,7 @@ void main() { test('is called when FutureProvider emits an error', () async { final observer = ObserverMock(); - final container = createContainer(observers: [observer]); + final container = ProviderContainer.test(observers: [observer]); final provider = FutureProvider( (ref) => Future.error('error', StackTrace.empty), ); @@ -375,7 +376,7 @@ void main() { test('is called when StreamProvider emits an error', () async { final observer = ObserverMock(); - final container = createContainer(observers: [observer]); + final container = ProviderContainer.test(observers: [observer]); final provider = StreamProvider( (ref) => Stream.error('error', StackTrace.empty), ); @@ -407,7 +408,8 @@ void main() { test('is called on uncaught error during first initialization', () { final observer = ObserverMock(); final observer2 = ObserverMock(); - final container = createContainer(observers: [observer, observer2]); + final container = + ProviderContainer.test(observers: [observer, observer2]); final provider = Provider((ref) => throw UnimplementedError()); expect( @@ -437,7 +439,8 @@ void main() { test('is called on uncaught error after update ', () async { final observer = ObserverMock(); final observer2 = ObserverMock(); - final container = createContainer(observers: [observer, observer2]); + final container = + ProviderContainer.test(observers: [observer, observer2]); final dep = StateProvider((ref) => 0); final provider = Provider((ref) { if (ref.watch(dep) != 0) { @@ -486,7 +489,7 @@ void main() { group('didAddProvider', () { test('when throwing during creation, receives `null` as value', () { final observer = ObserverMock(); - final container = createContainer(observers: [observer]); + final container = ProviderContainer.test(observers: [observer]); final provider = Provider((ref) => throw UnimplementedError()); expect( @@ -504,12 +507,12 @@ void main() { final observer = ObserverMock(); final observer2 = ObserverMock(); final observer3 = ObserverMock(); - final root = createContainer(observers: [observer]); - final mid = createContainer( + final root = ProviderContainer.test(observers: [observer]); + final mid = ProviderContainer.test( parent: root, observers: [observer2], ); - final child = createContainer( + final child = ProviderContainer.test( parent: mid, overrides: [provider.overrideWithValue(42)], observers: [observer3], @@ -536,7 +539,8 @@ void main() { final observer = ObserverMock(); final observer2 = ObserverMock(); final provider = Provider((_) => 42); - final container = createContainer(observers: [observer, observer2]); + final container = + ProviderContainer.test(observers: [observer, observer2]); expect(container.read(provider), 42); verifyInOrder([ @@ -562,7 +566,7 @@ void main() { when(observer2.didAddProvider(any, any, any)).thenThrow('error2'); final observer3 = ObserverMock(); final provider = Provider((_) => 42); - final container = createContainer( + final container = ProviderContainer.test( observers: [observer, observer2, observer3], ); @@ -589,7 +593,7 @@ void main() { group('didDisposeProvider', () { test('supports invalidate', () { final observer = ObserverMock(); - final container = createContainer(observers: [observer]); + final container = ProviderContainer.test(observers: [observer]); final provider = Provider((ref) => 0); container.read(provider); @@ -604,7 +608,7 @@ void main() { test('supports container dispose', () { final observer = ObserverMock(); - final container = createContainer(observers: [observer]); + final container = ProviderContainer.test(observers: [observer]); final provider = StateNotifierProvider((ref) => Counter()); container.read(provider); @@ -621,7 +625,7 @@ void main() { test('supports auto-dispose', () async { final observer = ObserverMock(); - final container = createContainer(observers: [observer]); + final container = ProviderContainer.test(observers: [observer]); final provider = StateNotifierProvider.autoDispose((ref) { return Counter(); }); @@ -651,7 +655,7 @@ void main() { return 0; }); final provider2 = Provider((ref) => ref.watch(provider)); - final container = createContainer( + final container = ProviderContainer.test( observers: [observer, observer2, observer3], ); diff --git a/packages/riverpod/test/old/framework/ref_test.dart b/packages/riverpod/test/old/framework/ref_test.dart index 793defd4a..2fe507cc2 100644 --- a/packages/riverpod/test/old/framework/ref_test.dart +++ b/packages/riverpod/test/old/framework/ref_test.dart @@ -10,7 +10,7 @@ void main() { 'cannot call ref.watch/ref.read/ref.listen/ref.onDispose after a dependency changed', () { late Ref ref; - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = Provider((r) { r.watch(dep); @@ -54,7 +54,7 @@ void main() { final provider = Provider((r) { ref = r; }); - final container = createContainer(); + final container = ProviderContainer.test(); container.read(provider); @@ -78,7 +78,7 @@ void main() { final another = Provider((ref) { ref.listen(provider, listener.call, fireImmediately: true); }); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(provider), 0); expect(buildCount, 1); @@ -100,7 +100,7 @@ void main() { ref.listen(dep, listener.call); }); - final container = createContainer(); + final container = ProviderContainer.test(); container.read(provider); verifyZeroInteractions(listener); @@ -112,7 +112,7 @@ void main() { }); test('can listen selectors', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateNotifierProvider, int>((ref) { return StateController(0); @@ -157,7 +157,7 @@ void main() { }); test('listen on selectors supports fireImmediately', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateNotifierProvider, int>((ref) { return StateController(0); @@ -325,7 +325,7 @@ void main() { group('mounted', () { test('is false during onDispose caused by ref.watch', () { - final container = createContainer(); + final container = ProviderContainer.test(); bool? mounted; late ProviderElementBase element; final dep = StateProvider((ref) => 0); @@ -344,7 +344,7 @@ void main() { }); test('is false during onDispose caused by container dispose', () { - final container = createContainer(); + final container = ProviderContainer.test(); bool? mounted; late ProviderElementBase element; final dep = StateProvider((ref) => 0); @@ -363,7 +363,7 @@ void main() { }); test('is false in between rebuilds', () { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); late ProviderElementBase element; final provider = Provider((ref) { diff --git a/packages/riverpod/test/old/framework/ref_watch_test.dart b/packages/riverpod/test/old/framework/ref_watch_test.dart index d60d78873..ef9213566 100644 --- a/packages/riverpod/test/old/framework/ref_watch_test.dart +++ b/packages/riverpod/test/old/framework/ref_watch_test.dart @@ -17,7 +17,7 @@ class Counter extends StateNotifier { void main() { test('can chain select', () { - final container = createContainer(); + final container = ProviderContainer.test(); var buildCount = 0; final dep = StateProvider((ref) => 0); @@ -54,7 +54,7 @@ void main() { }); test('can listen multiple providers at once', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final count = StateProvider((ref) => 0); final count2 = StateProvider((ref) => 0); @@ -108,7 +108,7 @@ void main() { test('when selector throws, rebuild providers', () {}, skip: true); test('on provider that threw, exceptions bypass the selector', () { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = Provider((ref) { throw UnimplementedError(); }); @@ -125,7 +125,7 @@ void main() { test( 'when rebuilding a provider after an uncaught exception, correctly updates dependents', () { - final container = createContainer(); + final container = ProviderContainer.test(); final throws = StateProvider((ref) => true); final provider = Provider((ref) { if (ref.watch(throws)) { @@ -151,7 +151,7 @@ void main() { test( 'when rebuilding a provider after an uncaught selected exception, correctly updates dependents', () { - final container = createContainer(); + final container = ProviderContainer.test(); final throws = StateProvider((ref) => true); final provider = Provider((ref) { if (ref.watch(throws)) { @@ -179,7 +179,7 @@ void main() { final onDispose = OnDisposeMock(); final dep = StateProvider((ref) => 0); final dep2 = StateProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider((ref) { ref.onDispose(onDispose.call); ref.watch(dep); @@ -207,7 +207,7 @@ void main() { ref.watch(dep.select((value) => ref.read(dep))); }, ); - final container = createContainer(); + final container = ProviderContainer.test(); expect( () => container.read(provider), @@ -222,7 +222,7 @@ void main() { final provider = Provider((ref) { ref.watch(dep.select((value) => ref.watch(dep))); }); - final container = createContainer(); + final container = ProviderContainer.test(); expect( () => container.read(provider), @@ -242,7 +242,7 @@ void main() { }), ); }); - final container = createContainer(); + final container = ProviderContainer.test(); expect( () => container.read(provider), @@ -253,7 +253,7 @@ void main() { test( 'when selecting a provider, element.visitChildren visits the selected provider', () { - final container = createContainer(); + final container = ProviderContainer.test(); final selected = StateNotifierProvider, int>((ref) { return StateController(0); }); @@ -271,7 +271,7 @@ void main() { }); test('can watch selectors', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateNotifierProvider, int>( name: 'provider', (ref) => StateController(0), @@ -334,7 +334,7 @@ void main() { }); final computedListener = Listener(); - final container = createContainer(); + final container = ProviderContainer.test(); container.read(provider0); container.read(provider1); @@ -404,7 +404,7 @@ void main() { }); final computedListener = Listener(); - final container = createContainer(); + final container = ProviderContainer.test(); final provider0Element = container.readProviderElement(provider0); final provider1Element = container.readProviderElement(provider1); @@ -459,7 +459,7 @@ void main() { final provider = StateNotifierProvider((_) { return notifier; }); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); container.listen(computed(provider), listener.call, fireImmediately: true); @@ -475,7 +475,7 @@ void main() { test( 'multiple ref.watch, when one of them forces re-evaluate, all dependencies are still flushed', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final notifier = Notifier(0); final provider = StateNotifierProvider, int>((_) { return notifier; @@ -520,7 +520,7 @@ void main() { secondCallCount++; return ref.watch(first).toString(); }); - final container = createContainer(); + final container = ProviderContainer.test(); final controller = container.read(state.notifier); @@ -537,7 +537,7 @@ void main() { }); test('can call ref.watch asynchronously', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final notifier = Notifier(0); final provider = StateNotifierProvider, int>( name: 'provider', @@ -579,7 +579,7 @@ void main() { }); test('the value is cached between multiple listeners', () { - final container = createContainer(); + final container = ProviderContainer.test(); final notifier = Notifier(0); final provider = StateNotifierProvider, int>((_) { return notifier; @@ -624,7 +624,7 @@ void main() { }); test('Simple Provider flow', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final notifier = Notifier(0); final provider = StateNotifierProvider, int>((_) { return notifier; diff --git a/packages/riverpod/test/old/framework/scope_test.dart b/packages/riverpod/test/old/framework/scope_test.dart index 15964bb63..7d51b73a3 100644 --- a/packages/riverpod/test/old/framework/scope_test.dart +++ b/packages/riverpod/test/old/framework/scope_test.dart @@ -26,15 +26,15 @@ Future main() async { final a = Provider((ref) => 0); final b = Provider((ref) => ref.watch(a) + 10, dependencies: [a]); - final root = createContainer(); - final mid = createContainer( + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( parent: root, overrides: [a.overrideWithValue(42)], ); expect(mid.read(b), 52); - final child = createContainer( + final child = ProviderContainer.test( parent: mid, overrides: [a.overrideWithValue(84)], ); @@ -49,12 +49,12 @@ Future main() async { final a = Provider((ref) => 0); final b = Provider((ref) => ref.watch(a) + 10, dependencies: [a]); - final root = createContainer(); - final mid = createContainer( + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( parent: root, overrides: [a.overrideWithValue(42)], ); - final child = createContainer( + final child = ProviderContainer.test( parent: mid, overrides: [a.overrideWithValue(84)], ); @@ -70,8 +70,8 @@ Future main() async { () { final a = Provider.family((ref, id) => id); - final root = createContainer(); - final mid = createContainer( + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( parent: root, overrides: [ a.overrideWith((ref, argument) => argument + 10), @@ -80,7 +80,7 @@ Future main() async { expect(mid.read(a(10)), 20); - final child = createContainer( + final child = ProviderContainer.test( parent: mid, overrides: [ a.overrideWith((ref, argument) => argument + 20), @@ -96,15 +96,15 @@ Future main() async { () { final a = Provider.family((ref, id) => id); - final root = createContainer(); - final mid = createContainer( + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( parent: root, overrides: [ a.overrideWith((ref, argument) => argument + 10), ], ); - final child = createContainer( + final child = ProviderContainer.test( parent: mid, overrides: [ a.overrideWith((ref, argument) => argument + 20), @@ -121,8 +121,8 @@ Future main() async { () { final a = Provider.family((ref, id) => id); var overrideBuildCount = 0; - final root = createContainer(); - final mid = createContainer( + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( parent: root, overrides: [ a.overrideWith((ref, argument) { @@ -136,7 +136,7 @@ Future main() async { expect(mid.read(a(10)), 20); expect(overrideBuildCount, 1); - final child = createContainer(parent: mid); + final child = ProviderContainer.test(parent: mid); expect(child.read(a(10)), 20); expect(overrideBuildCount, 1); @@ -146,8 +146,8 @@ Future main() async { test('can override a provider with a reference to the provider directly', () { final provider = Provider((ref) => 0); - final container = createContainer(); - final child = createContainer(overrides: [provider]); + final container = ProviderContainer.test(); + final child = ProviderContainer.test(overrides: [provider]); expect(child.read(provider), 0); @@ -160,8 +160,8 @@ Future main() async { test('use latest override on mount', () { final provider = Provider((ref) => 0); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [provider.overrideWithValue(42)], ); @@ -175,8 +175,8 @@ Future main() async { test('updating scoped override does not mount the provider', () { final provider = Provider((ref) => 0); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [provider.overrideWithValue(42)], ); @@ -197,9 +197,9 @@ Future main() async { callCount++; return 42; }); - final root = createContainer(); - final mid = createContainer(parent: root, overrides: [provider]); - final container = createContainer(parent: mid); + final root = ProviderContainer.test(); + final mid = ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test(parent: mid); expect(mid.read(provider), 42); expect(callCount, 1); @@ -217,8 +217,8 @@ Future main() async { final provider = Provider.family( (ref, value) => '$value ${ref.watch(dep)}', ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ dep.overrideWithValue(1), @@ -239,8 +239,8 @@ Future main() async { final provider = Provider.family( (ref, value) => '$value ${ref.watch(dep)}', ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ dep.overrideWithValue(1), @@ -259,8 +259,8 @@ Future main() async { test('can override a family with a reference to the provider directly', () { final provider = Provider.family((ref, param) => 0); - final container = createContainer(); - final child = createContainer(overrides: [provider]); + final container = ProviderContainer.test(); + final child = ProviderContainer.test(overrides: [provider]); expect(child.read(provider(0)), 0); @@ -280,15 +280,15 @@ Future main() async { callCount++; return '$value ${ref.watch(dep)}'; }); - final root = createContainer(); - final mid = createContainer( + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( parent: root, overrides: [ dep.overrideWithValue(1), provider, ], ); - final container = createContainer(parent: mid); + final container = ProviderContainer.test(parent: mid); expect(mid.read(provider(0)), '0 1'); expect(callCount, 1); @@ -311,7 +311,7 @@ Future main() async { }, dependencies: [dep], ); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(provider(42)), 'foo'); }); @@ -327,13 +327,13 @@ Future main() async { return ref.watch(dep); }, ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); - final child = createContainer(parent: container); - final subChild = createContainer(parent: child); + final child = ProviderContainer.test(parent: container); + final subChild = ProviderContainer.test(parent: child); expect(buildCount, 0); expect(container.read(provider), 42); @@ -345,7 +345,7 @@ Future main() async { expect(subChild.read(provider), 42); expect(buildCount, 2); - final lateChild = createContainer(parent: container); + final lateChild = ProviderContainer.test(parent: container); expect(lateChild.read(provider), 42); expect(buildCount, 2); @@ -364,13 +364,13 @@ Future main() async { return ref.watch(dep); }, ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); - final child = createContainer(parent: container); - final subChild = createContainer(parent: child); + final child = ProviderContainer.test(parent: container); + final subChild = ProviderContainer.test(parent: child); expect(subChild.read(provider), 42); expect(buildCount, 1); @@ -419,13 +419,13 @@ Future main() async { }, ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); - final child = createContainer(parent: container); - final subChild = createContainer(parent: child); + final child = ProviderContainer.test(parent: container); + final subChild = ProviderContainer.test(parent: child); expect(buildCount, 0); @@ -465,7 +465,7 @@ Future main() async { expect(dep2BuildCount, 2); expect(depBuildCount, 1); - final lateChild = createContainer(parent: container); + final lateChild = ProviderContainer.test(parent: container); expect(lateChild.read(provider), '84'); expect(container.read(dep3), 84); @@ -491,16 +491,16 @@ Future main() async { ], // checking that the 'dependencies' order doesn't matter name: 'b', ); - final root = createContainer(); - final mid = createContainer( + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); - final mid2 = createContainer( + final mid2 = ProviderContainer.test( parent: mid, overrides: [dep2.overrideWithValue(21)], ); - final container = createContainer(parent: mid2); + final container = ProviderContainer.test(parent: mid2); expect(container.read(a), 63); expect(container.read(b), 21); @@ -533,16 +533,16 @@ Future main() async { dependencies: [dep], name: 'a', ); - final root = createContainer(); - final mid = createContainer( + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); - final mid2 = createContainer( + final mid2 = ProviderContainer.test( parent: mid, overrides: [dep2.overrideWithValue(21)], ); - final container = createContainer(parent: mid2); + final container = ProviderContainer.test(parent: mid2); expect(container.read(a), 42); @@ -566,12 +566,12 @@ Future main() async { () { final dep = Provider((ref) => 0); final provider = Provider((ref) => ref.watch(dep), dependencies: [dep]); - final root = createContainer(); - final mid = createContainer( + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( parent: root, overrides: [provider.overrideWithValue(42)], ); - final container = createContainer( + final container = ProviderContainer.test( parent: mid, overrides: [dep.overrideWithValue(84)], ); @@ -595,12 +595,12 @@ Future main() async { (ref) => ref.watch(family(21)), dependencies: [family], ); - final root = createContainer(); - final mid = createContainer( + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( parent: root, overrides: [family], ); - final container = createContainer(parent: mid); + final container = ProviderContainer.test(parent: mid); expect(container.read(provider), 42); expect(mid.read(provider), 42); @@ -624,12 +624,12 @@ Future main() async { dependencies: [family], ); final provider = Provider((ref) => ref.watch(dep), dependencies: [dep]); - final root = createContainer(); - final mid = createContainer( + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( parent: root, overrides: [family], ); - final container = createContainer(parent: mid); + final container = ProviderContainer.test(parent: mid); expect(container.read(provider), 42); expect(mid.read(provider), 42); @@ -654,8 +654,8 @@ Future main() async { (ref) => ref.watch(dep), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -710,7 +710,7 @@ final b = Provider( test( 'does not throw if trying to watch a non-scoped provider that is not in the dependencies list', () { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = Provider((ref) => 0); final provider = Provider( (ref) => ref.watch(dep), @@ -723,7 +723,7 @@ final b = Provider( test( 'Throw if trying to watch a scoped provider that is not in the dependencies list', () { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = Provider((ref) => 0, dependencies: const []); final dep2 = Provider((ref) => 0, dependencies: [dep]); final provider = Provider( @@ -740,7 +740,7 @@ final b = Provider( test( 'Throw if trying to listen a scoped provider that is not in the dependencies list', () { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = Provider((ref) => 0, dependencies: const []); final dep2 = Provider((ref) => 0, dependencies: [dep]); final provider = Provider( @@ -757,7 +757,7 @@ final b = Provider( test( 'Throw if trying to read a scoped provider that is not in the dependencies list', () { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = Provider((ref) => 0, dependencies: const []); final dep2 = Provider((ref) => 0, dependencies: [dep]); final provider = Provider( @@ -778,13 +778,13 @@ final b = Provider( final b = Provider((ref) => ref.watch(a), dependencies: [a]); final c = Provider((ref) => ref.watch(a), dependencies: [a]); - final root = createContainer( + final root = ProviderContainer.test( overrides: [ b.overrideWithValue(21), c.overrideWith((ref) => ref.watch(another) + 10), ], ); - final container = createContainer( + final container = ProviderContainer.test( parent: root, overrides: [ a.overrideWithValue(42), @@ -805,14 +805,14 @@ final b = Provider( dependencies: [a], ); - final root = createContainer( + final root = ProviderContainer.test( overrides: [ b.overrideWith( (ref, value) => ref.watch(another) + value, ), ], ); - final container = createContainer( + final container = ProviderContainer.test( parent: root, overrides: [ a.overrideWithValue(42), diff --git a/packages/riverpod/test/old/framework/select_async_test.dart b/packages/riverpod/test/old/framework/select_async_test.dart index b51b78b8e..0d885080f 100644 --- a/packages/riverpod/test/old/framework/select_async_test.dart +++ b/packages/riverpod/test/old/framework/select_async_test.dart @@ -8,7 +8,7 @@ import '../utils.dart'; void main() { test('implements ProviderSubscription.read on AsyncData', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = FutureProvider((ref) async => ref.watch(dep)); @@ -31,7 +31,7 @@ void main() { }); test('implements ProviderSubscription.read on AsyncError', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = FutureProvider( (ref) => Future.error(ref.watch(dep)), @@ -57,7 +57,7 @@ void main() { }); test('when selector throws, returns a failing future', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = FutureProvider((ref) async => ref.watch(dep)); @@ -80,7 +80,7 @@ void main() { }); test('handles fireImmediately: true on AsyncLoading', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = FutureProvider((ref) async => 0); final listener = Listener>(); @@ -97,7 +97,7 @@ void main() { }); test('handles fireImmediately: true on AsyncData', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = FutureProvider((ref) => 0); final listener = Listener>(); @@ -114,7 +114,7 @@ void main() { }); test('handles fireImmediately: true on AsyncError', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = FutureProvider((ref) => throw StateError('0')); final listener = Listener>(); @@ -131,7 +131,7 @@ void main() { }); test('handles fireImmediately: false', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = FutureProvider((ref) async => 0); final listener = Listener>(); @@ -147,7 +147,7 @@ void main() { test( 'catching errors in the future is not necessary if the error is coming from AsyncError', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = FutureProvider((ref) => throw StateError('err')); container.listen( @@ -161,7 +161,7 @@ void main() { }); test('handles multiple AsyncLoading at once then data', () async { - final container = createContainer(); + final container = ProviderContainer.test(); late FutureProviderRef ref; final provider = FutureProvider((r) { ref = r; @@ -190,7 +190,7 @@ void main() { }); test('can watch async selectors', () async { - final container = createContainer(); + final container = ProviderContainer.test(); var buildCount = 0; final dep = StateProvider((ref) => 0); final a = FutureProvider((ref) async => ref.watch(dep)); @@ -246,7 +246,7 @@ void main() { }); test('can watch async selectors (autoDispose)', () async { - final container = createContainer(); + final container = ProviderContainer.test(); var buildCount = 0; final dep = StateProvider((ref) => 0); final a = FutureProvider.autoDispose((ref) async => ref.watch(dep)); @@ -303,7 +303,7 @@ void main() { group('Supports ProviderContainer.read', () { test('and resolves with data', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = FutureProvider((ref) async => 0); expect( @@ -313,7 +313,7 @@ void main() { }); test('resolves with error', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = FutureProvider((ref) async => throw StateError('err')); @@ -324,7 +324,7 @@ void main() { }); test('emits exceptions inside selectors as Future.error', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = FutureProvider((ref) async => 42); expect( diff --git a/packages/riverpod/test/old/framework/uni_directional_test.dart b/packages/riverpod/test/old/framework/uni_directional_test.dart index 7bd6e4abf..cc39ec9d4 100644 --- a/packages/riverpod/test/old/framework/uni_directional_test.dart +++ b/packages/riverpod/test/old/framework/uni_directional_test.dart @@ -17,7 +17,7 @@ void main() { 'Catches circular dependency when dependencies are setup during provider initialization', () { // regression for #1766 - final container = createContainer(); + final container = ProviderContainer.test(); final authInterceptorProvider = Provider((ref) => ref); @@ -100,7 +100,7 @@ void main() { ref.listen(provider, (prev, value) => ref.controller.state++); return 0; }); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(another), 0); diff --git a/packages/riverpod/test/old/framework/visit_states_test.dart b/packages/riverpod/test/old/framework/visit_states_test.dart index 9ba94c783..909742a08 100644 --- a/packages/riverpod/test/old/framework/visit_states_test.dart +++ b/packages/riverpod/test/old/framework/visit_states_test.dart @@ -28,7 +28,7 @@ void main() { final perm = Permutations(3, [a, b, c]); for (final permutation in perm()) { - final container = createContainer(); + final container = ProviderContainer.test(); permutation.forEach(container.read); expect(compute(container), [a, b, c]); } @@ -58,7 +58,7 @@ void main() { final perm = Permutations(4, [a, b, c, d]); for (final permutation in perm()) { - final container = createContainer(); + final container = ProviderContainer.test(); permutation.forEach(container.read); expect( compute(container), @@ -81,8 +81,8 @@ void main() { return B(); }); - final parent = createContainer(); - final container = createContainer(parent: parent, overrides: [b]); + final parent = ProviderContainer.test(); + final container = ProviderContainer.test(parent: parent, overrides: [b]); container.read(b); expect(compute(container), [b]); @@ -105,11 +105,11 @@ void main() { return C(); }); - final parent = createContainer(); + final parent = ProviderContainer.test(); final perm = Permutations(2, [b, c]); for (final permutation in perm()) { - final container = createContainer( + final container = ProviderContainer.test( parent: parent, overrides: permutation, ); @@ -171,7 +171,7 @@ void main() { final perm = Permutations(7, [a, b, c, d, e, f, g]); for (final permutation in perm()) { - final container = createContainer(); + final container = ProviderContainer.test(); permutation.forEach(container.read); expect( compute(container), @@ -215,7 +215,7 @@ void main() { final perm = Permutations(4, [a, b, c, d]); for (final permutation in perm()) { - final container = createContainer(); + final container = ProviderContainer.test(); permutation.forEach(container.read); expect( compute(container), @@ -250,7 +250,7 @@ void main() { final perm = Permutations(4, [a, b, c, d]); for (final permutation in perm()) { - final container = createContainer(); + final container = ProviderContainer.test(); permutation.forEach(container.read); expect( compute(container), @@ -290,7 +290,7 @@ void main() { final perm = Permutations(5, [a, b, c, d, e]); for (final permutation in perm()) { - final container = createContainer(); + final container = ProviderContainer.test(); permutation.forEach(container.read); expect( compute(container), diff --git a/packages/riverpod/test/old/legacy/framework2/framework_test.dart b/packages/riverpod/test/old/legacy/framework2/framework_test.dart index 268376a5a..db7a2f97c 100644 --- a/packages/riverpod/test/old/legacy/framework2/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework2/framework_test.dart @@ -11,7 +11,7 @@ void main() { final didChange = Listener(); setUp(() { - container = createContainer(); + container = ProviderContainer.test(); }); tearDown(() { @@ -20,22 +20,22 @@ void main() { }); test('ProviderContainer.children', () { - final root = createContainer(); + final root = ProviderContainer.test(); expect(root.debugChildren, isEmpty); - final mid = createContainer(parent: root); + final mid = ProviderContainer.test(parent: root); expect(root.debugChildren, containsAll([mid])); expect(mid.debugChildren, isEmpty); - final mid2 = createContainer(parent: root); + final mid2 = ProviderContainer.test(parent: root); expect(root.debugChildren, containsAll([mid, mid2])); expect(mid.debugChildren, isEmpty); expect(mid2.debugChildren, isEmpty); - final leaf = createContainer(parent: mid); + final leaf = ProviderContainer.test(parent: mid); expect(root.debugChildren, containsAll([mid, mid2])); expect(mid.debugChildren, containsAll([leaf])); @@ -61,8 +61,8 @@ void main() { }); test('Ref.container exposes the root container', () { - final root = createContainer(); - final container = createContainer(parent: root); + final root = ProviderContainer.test(); + final container = ProviderContainer.test(parent: root); final provider = Provider((ref) => ref); expect(container.read(provider).container, root); @@ -168,7 +168,7 @@ void main() { buildCount++; ref.onDispose(onDispose.call); }); - final container = createContainer(); + final container = ProviderContainer.test(); container.read(provider); @@ -188,8 +188,8 @@ void main() { }); test('disposing child container does not dispose the providers', () { - final container = createContainer(); - final child = createContainer(parent: container); + final container = ProviderContainer.test(); + final child = ProviderContainer.test(parent: container); var disposed = false; final provider = Provider((ref) { ref.onDispose(() => disposed = true); @@ -209,10 +209,10 @@ void main() { test('child container uses root overrides', () { final provider = Provider((ref) => 0); - final container = createContainer( + final container = ProviderContainer.test( overrides: [provider.overrideWithValue(42)], ); - final child = createContainer(parent: container); + final child = ProviderContainer.test(parent: container); expect(child.read(provider), 42); }); @@ -296,7 +296,7 @@ void main() { // callCount++; // return 0; // }); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncValue.data(42)), // ]); @@ -497,8 +497,8 @@ void main() { group('container.refresh', () { test('still refresh providers on non-root containers', () { - final root = createContainer(); - final container = createContainer(parent: root); + final root = ProviderContainer.test(); + final container = ProviderContainer.test(parent: root); var callCount = 0; late Ref providerReference; var result = 0; @@ -528,7 +528,7 @@ void main() { callCount++; return future; }); - final container = createContainer(); + final container = ProviderContainer.test(); await expectLater(container.read(provider.future), completion(42)); @@ -562,7 +562,7 @@ void main() { callCount++; return Future.value(42); }); - final container = createContainer(); + final container = ProviderContainer.test(); expect(callCount, 0); expect( @@ -589,7 +589,7 @@ void main() { ref.watch(dep); return future; }); - final container = createContainer(); + final container = ProviderContainer.test(); container.refresh(provider); diff --git a/packages/riverpod/test/old/legacy/framework_test.dart b/packages/riverpod/test/old/legacy/framework_test.dart index 2c1a62e21..ba5281df3 100644 --- a/packages/riverpod/test/old/legacy/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework_test.dart @@ -9,7 +9,7 @@ import '../utils.dart'; void main() { test('hasListeners', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider((_) => 42); expect(container.read(provider), 42); @@ -34,8 +34,9 @@ void main() { final family2 = Provider.family((ref, value) { return '$value 2'; }); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [family2]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [family2]); expect(container.read(family(0)), '0'); expect(container.read(family2(0)), '0 2'); @@ -57,7 +58,7 @@ void main() { }); return ref; }); - final container = createContainer(); + final container = ProviderContainer.test(); container.read(provider); @@ -75,7 +76,7 @@ void main() { }); return ref; }); - final container = createContainer(); + final container = ProviderContainer.test(); container.read(provider); @@ -93,7 +94,7 @@ void main() { }); return ref; }); - final container = createContainer(); + final container = ProviderContainer.test(); container.read(provider); @@ -104,7 +105,7 @@ void main() { }); test('disposing an already disposed container is no-op', () { - final container = createContainer(); + final container = ProviderContainer.test(); container.dispose(); container.dispose(); @@ -113,7 +114,7 @@ void main() { test('Owner.read', () { final provider = Provider((ref) => 0); final provider2 = Provider((ref) => 1); - final container = createContainer(); + final container = ProviderContainer.test(); final value1 = container.read(provider); final value2 = container.read(provider); @@ -140,7 +141,7 @@ void main() { return ref.watch(provider2) + 1; }); - final container = createContainer(); + final container = ProviderContainer.test(); expect( () => container.read(provider), throwsA(isA()), @@ -160,7 +161,7 @@ void main() { return () => ref.watch(provider2) + 1; }); - final container = createContainer(); + final container = ProviderContainer.test(); expect( () => container.read(provider)(), throwsA(isA()), @@ -168,7 +169,7 @@ void main() { }); test('circular dependencies #2', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider((ref) => ref); final provider1 = Provider((ref) => ref); @@ -185,7 +186,7 @@ void main() { }); test('dispose providers in dependency order (simple)', () { - final container = createContainer(); + final container = ProviderContainer.test(); final onDispose1 = OnDisposeMock(); final onDispose2 = OnDisposeMock(); final onDispose3 = OnDisposeMock(); @@ -222,7 +223,7 @@ void main() { }); test('Ref is unusable after dispose (read/onDispose)', () { - final container = createContainer(); + final container = ProviderContainer.test(); late ProviderElement ref; final provider = Provider((s) { ref = s as ProviderElement; @@ -249,7 +250,7 @@ void main() { ref.onDispose(onDispose.call); throw error; }); - final container = createContainer(); + final container = ProviderContainer.test(); expect(() => container.read(provider), throwsA(error)); expect(callCount, 1); diff --git a/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart b/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart index 9f29665f7..41eed0c04 100644 --- a/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart +++ b/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart @@ -33,7 +33,7 @@ void main() { for (final factory in matrix()) { group(factory.label, () { test('Cannot share a Notifier instance between providers ', () { - final container = createContainer(); + final container = ProviderContainer.test(); final notifier = factory.notifier((ref) => 0); final provider = factory.provider, int>( @@ -52,7 +52,7 @@ void main() { }); test('Can read state inside onDispose', () { - final container = createContainer(); + final container = ProviderContainer.test(); late AsyncTestNotifierBase notifier; final provider = factory.simpleTestProvider((ref) { ref.onDispose(() { @@ -68,7 +68,7 @@ void main() { }); test('Using the notifier after dispose throws', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider((ref) => 0); container.listen(provider.notifier, (prev, next) {}); @@ -87,7 +87,7 @@ void main() { test('Can assign `AsyncLoading` to `AsyncValue`', () { // Regression test for https://github.com/rrousselGit/riverpod/issues/2120 final provider = factory.simpleTestProvider((ref) => 42); - final container = createContainer(); + final container = ProviderContainer.test(); final sub = container.listen(provider.notifier, (prev, next) {}); @@ -107,7 +107,7 @@ void main() { test('Can assign `AsyncData` to `AsyncValue`', () { // Regression test for https://github.com/rrousselGit/riverpod/issues/2120 final provider = factory.simpleTestProvider((ref) => 42); - final container = createContainer(); + final container = ProviderContainer.test(); final sub = container.listen(provider.notifier, (prev, next) {}); @@ -127,7 +127,7 @@ void main() { test('Can assign `AsyncError` to `AsyncValue`', () { // Regression test for https://github.com/rrousselGit/riverpod/issues/2120 final provider = factory.simpleTestProvider((ref) => 42); - final container = createContainer(); + final container = ProviderContainer.test(); final sub = container.listen(provider.notifier, (prev, next) {}); @@ -150,7 +150,7 @@ void main() { test( 'performs seamless copyWithPrevious if triggered by ref.invalidate/ref.refresh', () async { - final container = createContainer(); + final container = ProviderContainer.test(); var count = 0; final provider = factory.simpleTestProvider( (ref) => Future.value(count++), @@ -182,7 +182,7 @@ void main() { test( 'performs seamless:false copyWithPrevious on `state = AsyncLoading()`', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider((ref) => Future.value(0)); final sub = container.listen(provider.notifier, (previous, next) {}); @@ -202,7 +202,7 @@ void main() { test( 'performs seamless:false copyWithPrevious if triggered by a dependency change', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = factory.simpleTestProvider( (ref) => Future.value(ref.watch(dep)), @@ -225,7 +225,7 @@ void main() { }); test('performs seamless data > loading > error transition', () async { - final container = createContainer(); + final container = ProviderContainer.test(); var result = Future.value(42); final provider = FutureProvider((ref) => result); @@ -253,7 +253,7 @@ void main() { test( 'performs seamless:false copyWithPrevious if both triggered by a dependency change and ref.refresh', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = factory.simpleTestProvider( (ref) => Future.value(ref.watch(dep)), @@ -278,7 +278,7 @@ void main() { test('does not notify listeners when refreshed during loading', () async { final provider = factory.simpleTestProvider((ref) => Future.value(0)); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, listener.call, fireImmediately: true); @@ -302,7 +302,7 @@ void main() { ref.listenSelf(listener.call, onError: onError.call); Error.throwWithStackTrace(42, StackTrace.empty); }); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider, (previous, next) {}); @@ -328,7 +328,7 @@ void main() { 'converts AsyncNotifier.build into an AsyncData if the future completes', () async { final provider = factory.simpleTestProvider((ref) => Future.value(0)); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, listener.call, fireImmediately: true); @@ -357,7 +357,7 @@ void main() { final provider = factory.simpleTestProvider( (ref) => Future.error(0, StackTrace.empty), ); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, listener.call, fireImmediately: true); @@ -385,7 +385,7 @@ void main() { final provider = factory.testProvider( () => Error.throwWithStackTrace(0, StackTrace.empty), ); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, listener.call, fireImmediately: true); @@ -406,7 +406,7 @@ void main() { 'synchronously emits AsyncData if AsyncNotifier.build emits synchronously', () async { final provider = factory.simpleTestProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, listener.call, fireImmediately: true); @@ -422,7 +422,7 @@ void main() { final provider = factory.simpleTestProvider( (ref) => Error.throwWithStackTrace(42, StackTrace.empty), ); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, listener.call, fireImmediately: true); @@ -441,7 +441,7 @@ void main() { test( 'stops listening to the previous future data when the provider rebuilds', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final completers = { 0: Completer.sync(), @@ -480,7 +480,7 @@ void main() { test( 'stops listening to the previous future error when the provider rebuilds', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final completers = { 0: Completer.sync(), @@ -524,7 +524,7 @@ void main() { 'when manually modifying the state, the new exposed value contains the previous state when possible', () async { final provider = factory.simpleTestProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final sub = container.listen(provider.notifier, (previous, next) {}); @@ -569,7 +569,7 @@ void main() { return Future.value(ref.watch(dep)); }, ); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider, (previous, next) {}); final notifier = container.read(provider.notifier); @@ -605,7 +605,7 @@ void main() { ); }, ); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider, (previous, next) {}); @@ -622,7 +622,7 @@ void main() { test('notifies listeners when the setter is called', () { final provider = factory.simpleTestProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, listener.call); @@ -642,7 +642,7 @@ void main() { test( 'when disposed during loading, resolves with the content of AsyncNotifier.build', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( (ref) => completer.future, @@ -659,7 +659,7 @@ void main() { test( 'when disposed during loading, resolves with the error of AsyncNotifier.build', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( (ref) => completer.future, @@ -678,7 +678,7 @@ void main() { 'going data > loading while the future is still pending. ' 'Resolves with last future result', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( (ref) => completer.future, @@ -701,7 +701,7 @@ void main() { test( 'if going back to loading after future resolved, throws StateError', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( (ref) => completer.future, @@ -725,7 +725,7 @@ void main() { test( 'resolves with the new state if AsyncNotifier.state is modified during loading', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( (ref) => completer.future, @@ -752,7 +752,7 @@ void main() { test('resolves with the new state when notifier.state is changed', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider((ref) => 0); final listener = Listener>(); @@ -783,7 +783,7 @@ void main() { return Future.value(ref.watch(dep)); }, ); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider.notifier, (previous, next) {}); final notifier = container.read(provider.notifier); @@ -802,7 +802,7 @@ void main() { return Future.value(ref.watch(dep)); }, ); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider, (previous, next) {}); final notifier = container.read(provider.notifier); @@ -829,7 +829,7 @@ void main() { listener(); return factory.notifier((ref) => ref.watch(dep)); }); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider, (previous, next) {}); final notifier = container.read(provider.notifier); @@ -852,7 +852,7 @@ void main() { (ref) => Equal(42), updateShouldNotify: (a, b) => a != b, ); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>>(); container.listen(provider, listener.call); @@ -878,7 +878,7 @@ void main() { group('AsyncNotifier.update', () { test('passes in the latest state', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( (ref) => 0, ); @@ -905,7 +905,7 @@ void main() { }); test('can specify onError to handle error scenario', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( (ref) => Error.throwWithStackTrace(42, StackTrace.empty), ); @@ -942,7 +942,7 @@ void main() { test('executes immediately with current state if a state is available', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider((ref) => 1); final sub = container.listen(provider.notifier, (prev, next) {}); @@ -958,7 +958,7 @@ void main() { test('executes immediately with current state if an error is available', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( (ref) => Error.throwWithStackTrace(42, StackTrace.empty), ); @@ -987,7 +987,7 @@ void main() { }); test('awaits the future resolution if in loading state', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( (ref) => Future.value(42), ); @@ -1014,7 +1014,7 @@ void main() { AutoDisposeAsyncTestNotifier, int>( () => AutoDisposeAsyncTestNotifier((ref) => 0), ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith(() => AsyncTestNotifier((ref) => 42)), autoDispose.overrideWith( @@ -1036,7 +1036,7 @@ void main() { .family, int, int>( () => AutoDisposeAsyncTestNotifierFamily((ref) => 0), ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ family.overrideWith( () => AsyncTestNotifierFamily((ref) => 42), @@ -1060,7 +1060,7 @@ void main() { return ref.watch(dep); }), ); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(provider), const AsyncData(0)); }); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart index 6ac0d6883..b685e8ac7 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart @@ -22,8 +22,8 @@ void main() { (ref, i) => StateController(ref.watch(dep) + i), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -41,8 +41,9 @@ void main() { .family, int, int>( (ref, _) => controller, ); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider(0).notifier), controller); expect(container.read(provider(0)), 0); @@ -60,9 +61,9 @@ void main() { final controller = StateController(0); final provider = StateNotifierProvider.autoDispose .family, int, int>((ref, _) => controller); - final root = createContainer(); + final root = ProviderContainer.test(); final controllerOverride = StateController(42); - final container = createContainer( + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref, value) => controllerOverride), diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart index b7c3fc15a..9b62043d1 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart @@ -6,7 +6,7 @@ import '../../../utils.dart'; void main() { test('can read and set current StateNotifier', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); late AutoDisposeStateNotifierProviderRef ref; final provider = StateNotifierProvider.autoDispose((r) { @@ -27,8 +27,8 @@ void main() { (ref) => StateController(ref.watch(dep)), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -44,7 +44,7 @@ void main() { final provider = StateNotifierProvider.autoDispose( (ref) => Counter(initialValue), ); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider, (prev, value) {}); @@ -59,7 +59,7 @@ void main() { test('can be refreshed', () async { var result = StateController(0); - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateNotifierProvider.autoDispose, int>( (ref) => result, @@ -82,8 +82,9 @@ void main() { StateNotifierProvider.autoDispose, int>( (ref) => controller, ); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider.notifier), controller); expect(container.read(provider), 0); @@ -102,9 +103,9 @@ void main() { // final provider = // StateNotifierProvider.autoDispose, int>( // (ref) => controller); - // final root = createContainer(); + // final root = ProviderContainer.test(); // final controllerOverride = StateController(42); - // final container = createContainer(parent: root, overrides: [ + // final container = ProviderContainer.test(parent: root, overrides: [ // provider.overrideWithValue(controllerOverride), // ]); @@ -128,7 +129,7 @@ void main() { // return TestNotifier(); // }); // final notifier = TestNotifier(42); - // final container = createContainer( + // final container = ProviderContainer.test( // overrides: [ // provider.overrideWithValue(TestNotifier(10)), // ], @@ -177,7 +178,7 @@ void main() { final provider = StateNotifierProvider.autoDispose((_) { return notifier; }); - final container = createContainer(); + final container = ProviderContainer.test(); addTearDown(container.dispose); container.listen(provider, (prev, value) {}); @@ -194,7 +195,7 @@ void main() { return notifier; }); final listener = Listener(); - final container = createContainer(); + final container = ProviderContainer.test(); addTearDown(container.dispose); container.listen(provider.notifier, listener.call, fireImmediately: true); @@ -221,7 +222,7 @@ void main() { return notifier; }); final listener = Listener(); - final container = createContainer(); + final container = ProviderContainer.test(); addTearDown(container.dispose); container.listen(provider, listener.call, fireImmediately: true); @@ -245,7 +246,7 @@ void main() { StateNotifierProvider.autoDispose((ref) { return ref.watch(dep) == 0 ? notifier : notifier2; }); - final container = createContainer(); + final container = ProviderContainer.test(); addTearDown(container.dispose); var callCount = 0; @@ -274,7 +275,7 @@ void main() { }); final notifier = TestNotifier(42); final notifier2 = TestNotifier(21); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith((_) => notifier), ], diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart index 56b65681c..306ee6bd1 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart @@ -23,8 +23,8 @@ void main() { (ref, i) => StateController(ref.watch(dep) + i), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -42,8 +42,9 @@ void main() { StateNotifierProvider.family, int, int>( (ref, _) => controller, ); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider(0).notifier), controller); expect(container.read(provider(0)), 0); @@ -63,9 +64,9 @@ void main() { StateNotifierProvider.family, int, int>( (ref, _) => controller, ); - final root = createContainer(); + final root = ProviderContainer.test(); final controllerOverride = StateController(42); - final container = createContainer( + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref, value) => controllerOverride), @@ -118,8 +119,9 @@ void main() { final family = StateNotifierProvider.family( (ref, id) => Counter(), ); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [family]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [family]); expect(container.read(family('0')), 0); expect(container.read(family('0').notifier), isA()); @@ -138,7 +140,7 @@ void main() { final notifier2 = TestNotifier(42); final provider = StateNotifierProvider.autoDispose .family((ref, a) => TestNotifier()); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith((ref, a) => notifier2), ], diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart index cd40f6b0a..f390e196f 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart @@ -14,7 +14,7 @@ void main() { final autoDispose = StateNotifierProvider.autoDispose( (ref) => TestNotifier(), ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith( (StateNotifierProviderRef ref) => TestNotifier(42), @@ -38,7 +38,7 @@ void main() { StateNotifierProvider.autoDispose.family( (ref, arg) => TestNotifier(0 + arg), ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ family.overrideWith( (StateNotifierProviderRef ref, int arg) => @@ -62,7 +62,7 @@ void main() { 'on refresh, does not notify listeners if the new value is identical to the previous one', () { // regression test for https://github.com/rrousselGit/riverpod/issues/1560 - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateNotifierProvider, int>( (ref) => StateController(0), ); @@ -79,7 +79,7 @@ void main() { test('ref.listenSelf listens to state changes', () { final listener = Listener(); - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateNotifierProvider, int>((ref) { ref.listenSelf(listener.call); return StateController(0); @@ -95,7 +95,7 @@ void main() { }); test('can read and set current StateNotifier', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); late StateNotifierProviderRef ref; final provider = StateNotifierProvider((r) { @@ -115,8 +115,8 @@ void main() { (ref) => StateController(ref.watch(dep)), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -131,7 +131,7 @@ void main() { var initialValue = 1; final provider = StateNotifierProvider((ref) => Counter(initialValue)); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(provider), 1); expect(container.read(provider.notifier).state, 1); @@ -144,7 +144,7 @@ void main() { test('can be refreshed', () async { var result = StateController(0); - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateNotifierProvider, int>((ref) => result); @@ -165,8 +165,9 @@ void main() { final provider = StateNotifierProvider, int>( (ref) => controller, ); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider.notifier), controller); expect(container.read(provider), 0); @@ -184,9 +185,9 @@ void main() { // final controller = StateController(0); // final provider = StateNotifierProvider, int>( // (ref) => controller); - // final root = createContainer(); + // final root = ProviderContainer.test(); // final controllerOverride = StateController(42); - // final container = createContainer(parent: root, overrides: [ + // final container = ProviderContainer.test(parent: root, overrides: [ // provider.overrideWithValue(controllerOverride), // ]); @@ -210,9 +211,9 @@ void main() { StateNotifierProvider.autoDispose, int>( (ref) => controller, ); - final root = createContainer(); + final root = ProviderContainer.test(); final controllerOverride = StateController(42); - final container = createContainer( + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref) => controllerOverride), @@ -237,7 +238,7 @@ void main() { // final notifier = TestNotifier(42); // final provider = // StateNotifierProvider((_) => TestNotifier()); - // final container = createContainer( + // final container = ProviderContainer.test( // overrides: [ // provider.overrideWithValue(TestNotifier(10)), // ], @@ -276,7 +277,7 @@ void main() { final provider = StateNotifierProvider((_) { return notifier; }); - final container = createContainer(); + final container = ProviderContainer.test(); addTearDown(container.dispose); expect(container.read(provider.notifier), notifier); @@ -293,7 +294,7 @@ void main() { return notifier; }); final listener = Listener(); - final container = createContainer(); + final container = ProviderContainer.test(); addTearDown(container.dispose); container.listen(provider.notifier, listener.call, fireImmediately: true); @@ -319,7 +320,7 @@ void main() { return TestNotifier(); }); final listener = Listener(); - final container = createContainer(); + final container = ProviderContainer.test(); addTearDown(container.dispose); container.listen(provider, listener.call, fireImmediately: true); @@ -342,7 +343,7 @@ void main() { final provider = StateNotifierProvider((ref) { return ref.watch(dep) == 0 ? notifier : notifier2; }); - final container = createContainer(); + final container = ProviderContainer.test(); addTearDown(container.dispose); var callCount = 0; @@ -378,7 +379,7 @@ void main() { // }); // final notifier = TestNotifier(42); // final notifier2 = TestNotifier(21); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(notifier), // ]); // addTearDown(container.dispose); @@ -421,7 +422,7 @@ void main() { }); final notifier = TestNotifier(42); final notifier2 = TestNotifier(21); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith((_) => notifier), ], diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart index 0e9dc546c..e42a85397 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart @@ -22,8 +22,8 @@ void main() { (ref) => ref.watch(dep), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -36,7 +36,7 @@ void main() { group('ref.state', () { test('can read and change current value', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); late StateProviderRef ref; final provider = StateProvider.autoDispose((r) { @@ -57,7 +57,7 @@ void main() { }); test('fails if trying to read the state before it was set', () { - final container = createContainer(); + final container = ProviderContainer.test(); Object? err; final provider = StateProvider.autoDispose((ref) { try { @@ -75,7 +75,7 @@ void main() { test('on rebuild, still fails if trying to read the state before was built', () { final dep = StateProvider((ref) => false); - final container = createContainer(); + final container = ProviderContainer.test(); Object? err; final provider = StateProvider.autoDispose((ref) { if (ref.watch(dep)) { @@ -101,7 +101,7 @@ void main() { test('can refresh .notifier', () async { var initialValue = 1; final provider = StateProvider.autoDispose((ref) => initialValue); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider.notifier, (prev, value) {}); @@ -116,7 +116,7 @@ void main() { test('can be refreshed', () async { var result = 0; - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateProvider.autoDispose((ref) => result); final notifier = container.read(provider.notifier); @@ -134,8 +134,9 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { final provider = StateProvider.autoDispose((ref) => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider.notifier).state, 0); expect(container.read(provider), 0); @@ -151,8 +152,8 @@ void main() { // test('when using provider.overrideWithValue', () async { // final provider = StateProvider.autoDispose((ref) => 0); - // final root = createContainer(); - // final container = createContainer(parent: root, overrides: [ + // final root = ProviderContainer.test(); + // final container = ProviderContainer.test(parent: root, overrides: [ // provider.overrideWithValue(StateController(42)), // ]); @@ -174,8 +175,8 @@ void main() { test('when using provider.overrideWith', () async { final provider = StateProvider.autoDispose((ref) => 0, name: 'true'); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref) => 42), @@ -199,7 +200,7 @@ void main() { // test('listens to state changes', () { // final override = StateController(42); // final provider = StateProvider.autoDispose((ref) => 0); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(override), // ]); // addTearDown(container.dispose); @@ -217,7 +218,7 @@ void main() { test( 'properly disposes of the StateController when the provider is disposed', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateProvider.autoDispose((ref) => 0); final notifier = container.read(provider.notifier); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart index dc4ea503f..11d3dccaf 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart @@ -31,8 +31,9 @@ void main() { test('when passing the provider itself', () async { final provider = StateProvider.autoDispose.family((ref, _) => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider(0).notifier).state, 0); expect(container.read(provider(0)), 0); @@ -49,8 +50,8 @@ void main() { test('when using provider.overrideWith', () async { final provider = StateProvider.autoDispose.family((ref, _) => 0); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref, value) => 42), @@ -76,8 +77,8 @@ void main() { (ref, i) => ref.watch(dep) + i, dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart index 1081c1f46..d54886102 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart @@ -28,8 +28,9 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { final provider = StateProvider.family((ref, _) => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider(0).notifier).state, 0); expect(container.read(provider(0)), 0); @@ -45,8 +46,8 @@ void main() { test('when using provider.overrideWith', () async { final provider = StateProvider.family((ref, _) => 0); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref, value) => 42), @@ -72,8 +73,8 @@ void main() { (ref, i) => ref.watch(dep) + i, dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -88,7 +89,7 @@ void main() { final provider = StateProvider.family((ref, a) { return '$a'; }); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(provider(0)), '0'); expect(container.read(provider(1)), '1'); @@ -98,7 +99,7 @@ void main() { final provider = StateProvider.family((ref, a) { return '$a'; }); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith((ref, a) => 'override $a'), ], diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart index a48f0abdc..1c475e398 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart @@ -14,7 +14,7 @@ void main() { final autoDispose = StateProvider.autoDispose( (ref) => 0, ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith((StateProviderRef ref) => 42), autoDispose.overrideWith((AutoDisposeStateProviderRef ref) => 84), @@ -30,7 +30,7 @@ void main() { final autoDisposeFamily = StateProvider.autoDispose.family( (ref, arg) => '0 $arg', ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ family.overrideWith( (StateProviderRef ref, int arg) => '42 $arg', @@ -49,7 +49,7 @@ void main() { 'on refresh, does not notify listeners if the new value is identical to the previous one', () { // regression test for https://github.com/rrousselGit/riverpod/issues/1560 - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateProvider((ref) => 0); final listener = Listener(); @@ -64,7 +64,7 @@ void main() { test('ref.listenSelf listens to state changes', () { final listener = Listener(); - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateProvider((ref) { ref.listenSelf(listener.call); return 0; @@ -96,8 +96,8 @@ void main() { (ref) => ref.watch(dep), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -110,7 +110,7 @@ void main() { group('ref.controller', () { test('can read and change current value', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); late StateProviderRef ref; final provider = StateProvider((r) { @@ -131,7 +131,7 @@ void main() { }); test('fails if trying to read the state before it was set', () { - final container = createContainer(); + final container = ProviderContainer.test(); Object? err; final provider = StateProvider((ref) { try { @@ -149,7 +149,7 @@ void main() { test('on rebuild, still fails if trying to read the state before was built', () { final dep = StateProvider((ref) => false); - final container = createContainer(); + final container = ProviderContainer.test(); Object? err; final provider = StateProvider((ref) { if (ref.watch(dep)) { @@ -175,7 +175,7 @@ void main() { test('can refresh .notifier', () async { var initialValue = 1; final provider = StateProvider((ref) => initialValue); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(provider), 1); expect(container.read(provider.notifier).state, 1); @@ -193,7 +193,7 @@ void main() { // TODO fix this test var initialValue = 1; final provider = StateProvider((ref) => initialValue); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(provider), 1); expect(container.read(provider.notifier).state, 1); @@ -207,7 +207,7 @@ void main() { test('can be refreshed', () async { var result = 0; - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateProvider((ref) => result); final notifier = container.read(provider.notifier); @@ -225,8 +225,9 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { final provider = StateProvider((ref) => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider.notifier).state, 0); expect(container.read(provider), 0); @@ -242,8 +243,8 @@ void main() { // test('when using provider.overrideWithValue', () async { // final provider = StateProvider((ref) => 0); - // final root = createContainer(); - // final container = createContainer(parent: root, overrides: [ + // final root = ProviderContainer.test(); + // final container = ProviderContainer.test(parent: root, overrides: [ // provider.overrideWithValue(StateController(42)), // ]); @@ -263,8 +264,8 @@ void main() { test('when using provider.overrideWith', () async { final provider = StateProvider((ref) => 0); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref) => 42), @@ -288,7 +289,7 @@ void main() { // 'overrideWithValue listens to the new StateController and support controller changes', // () { // final provider = StateProvider((ref) => 0); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(StateController(42)), // ]); // final listener = Listener(); @@ -311,7 +312,7 @@ void main() { // test('listens to state changes', () { // final override = StateController(21); // final provider = StateProvider((ref) => 0); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(override), // ]); // addTearDown(container.dispose); @@ -330,7 +331,7 @@ void main() { test( 'properly disposes of the StateController when the provider is disposed', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateProvider.autoDispose((ref) => 0); final notifier = container.read(provider.notifier); @@ -347,7 +348,7 @@ void main() { }); test('Expose a state and allows modifying it', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateProvider((ref) => 0); final listener = Listener(); @@ -363,7 +364,7 @@ void main() { }); test('disposes the controller when the container is disposed', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateProvider((ref) => 0); final controller = container.read(provider.notifier); @@ -376,7 +377,7 @@ void main() { }); test('disposes the controller when the provider is re-evaluated', () { - final container = createContainer(); + final container = ProviderContainer.test(); final other = StateProvider((ref) => 0); final provider = StateProvider((ref) => ref.watch(other) * 2); @@ -399,7 +400,7 @@ void main() { group('StateProvider', () { test('.notifier obtains the controller without listening to it', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = StateProvider((ref) { ref.watch(dep); @@ -435,7 +436,7 @@ void main() { group('StateProvider.autoDispose', () { test('.notifier obtains the controller without listening to it', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = StateProvider.autoDispose((ref) { ref.watch(dep); @@ -469,7 +470,7 @@ void main() { }); test('creates a new controller when no longer listened to', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateProvider.autoDispose((ref) => 0); final sub = container.listen(provider.notifier, (_, __) {}); @@ -493,7 +494,7 @@ void main() { group('StateProvider.family.autoDispose', () { test('creates a new controller when no longer listened to', () async { - final container = createContainer(); + final container = ProviderContainer.test(); StateProvider.family.autoDispose((ref, id) { return 42; diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart index ceb300388..e84f1841a 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart @@ -15,8 +15,9 @@ void main() { test('when passing the provider itself', () async { final provider = FutureProvider.autoDispose.family((ref, _) async => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(await container.read(provider(0).future), 0); expect(container.read(provider(0)), const AsyncData(0)); @@ -33,8 +34,8 @@ void main() { (ref, i) => ref.watch(dep) + i, dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -49,8 +50,8 @@ void main() { final provider = FutureProvider.autoDispose.family((ref, _) { return 0; }); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref, value) => 42), @@ -71,7 +72,7 @@ void main() { final provider = FutureProvider.autoDispose.family((ref, a) { return Future.value(a * 2); }); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider(21), listener.call, fireImmediately: true); diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart index 67935ce64..a0e606d74 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart @@ -8,7 +8,7 @@ import '../../utils.dart'; void main() { test('can read and set current AsyncValue', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); late AutoDisposeFutureProviderRef ref; final provider = FutureProvider.autoDispose((r) { @@ -44,8 +44,8 @@ void main() { (ref) => ref.watch(dep), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -58,7 +58,7 @@ void main() { test('can return a value synchronously, bypassing AsyncLoading', () async { final provider = FutureProvider.autoDispose((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider, (_, __) {}); @@ -69,7 +69,7 @@ void main() { test('can return an error synchronously, bypassing AsyncLoading', () async { final provider = FutureProvider.autoDispose((ref) => throw UnimplementedError()); - final container = createContainer(); + final container = ProviderContainer.test(); expect( container.read(provider), @@ -87,7 +87,7 @@ void main() { () async { final dep = StateProvider((ref) => Future.value(42)); final provider = FutureProvider.autoDispose((ref) => ref.watch(dep)); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, (prev, value) {}); @@ -132,7 +132,7 @@ void main() { test('can refresh .future', () async { var future = Future.value(1); final provider = FutureProvider.autoDispose((ref) => future); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider.future, (prev, value) {}); @@ -146,7 +146,7 @@ void main() { test('can be refreshed', () async { var result = 0; - final container = createContainer(); + final container = ProviderContainer.test(); final provider = FutureProvider.autoDispose((ref) => Future.value(result)); container.listen(provider, (prev, value) {}); @@ -166,7 +166,7 @@ void main() { test('does not update dependents if the created stream did not change', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final completer = Completer(); final provider = FutureProvider.autoDispose((ref) { @@ -188,7 +188,7 @@ void main() { test( '.stream does not update dependents if the created stream did not change', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final completer = Completer(); final provider = FutureProvider.autoDispose((ref) { @@ -215,8 +215,9 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { final provider = FutureProvider.autoDispose((ref) async => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); @@ -229,8 +230,8 @@ void main() { // test('when using provider.overrideWithValue', () async { // final provider = FutureProvider.autoDispose((ref) async => 0); - // final root = createContainer(); - // final container = createContainer(parent: root, overrides: [ + // final root = ProviderContainer.test(); + // final container = ProviderContainer.test(parent: root, overrides: [ // provider.overrideWithValue(const AsyncValue.data(42)), // ]); @@ -246,8 +247,8 @@ void main() { test('when using provider.overrideWith', () async { final provider = FutureProvider.autoDispose((ref) async => 0); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [provider.overrideWith((ref) => 42)], ); @@ -269,7 +270,7 @@ void main() { ref.onDispose(onDispose.call); return future; }); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); final sub = diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart index 6f82a80f8..30db56933 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart @@ -14,8 +14,9 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { final provider = FutureProvider.family((ref, _) async => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(await container.read(provider(0).future), 0); expect(container.read(provider(0)), const AsyncData(0)); @@ -32,8 +33,8 @@ void main() { (ref, i) => ref.watch(dep) + i, dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -46,8 +47,8 @@ void main() { test('when using provider.overrideWith', () async { final provider = FutureProvider.family((ref, _) async => 0); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref, value) async => 42), @@ -68,7 +69,7 @@ void main() { final provider = FutureProvider.family((ref, a) { return Future.value('$a'); }); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(provider(0)), const AsyncValue.loading()); diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart index 01f6c88d5..d4321dda3 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart @@ -11,7 +11,7 @@ import '../../utils.dart'; void main() { group('FutureProviderRef.future', () { test('returns the pending future', () async { - final container = createContainer(); + final container = ProviderContainer.test(); Future? future; int? value; final provider = FutureProvider((ref) { @@ -39,7 +39,7 @@ void main() { }); test('flushes the provider when reading ref.future', () async { - final container = createContainer(); + final container = ProviderContainer.test(); var result = Future.value(42); late FutureProviderRef ref; final provider = FutureProvider((r) { @@ -64,7 +64,7 @@ void main() { return Future.value(); }); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(testProvider), const AsyncLoading()); await container.read(testProvider.future); @@ -75,7 +75,7 @@ void main() { test('supports overrideWith', () { final provider = FutureProvider((ref) => 0); final autoDispose = FutureProvider.autoDispose((ref) => 0); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith((FutureProviderRef ref) => 42), autoDispose.overrideWith( @@ -97,7 +97,7 @@ void main() { await Future.value(); return 3; }); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); // Completer used for the sole purpose of being able to await `provider.future` // Since `provider` emits `AsyncData` before the future completes, then @@ -131,7 +131,7 @@ void main() { final autoDisposeFamily = FutureProvider.autoDispose.family( (ref, arg) => '0 $arg', ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ family.overrideWith( (FutureProviderRef ref, int arg) => '42 $arg', @@ -147,7 +147,7 @@ void main() { }); test('Emits AsyncLoading before the create function is executed', () async { - final container = createContainer(); + final container = ProviderContainer.test(); late AsyncValue state; final provider = FutureProvider((ref) { state = ref.state; @@ -169,7 +169,7 @@ void main() { test('On dispose, .future resolves with the future returned itself', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final completer1 = Completer.sync(); final completer2 = Completer.sync(); var result = completer1.future; @@ -192,7 +192,7 @@ void main() { test( 'provider.future resolves with the new data instead of the old future result', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final completer1 = Completer.sync(); final completer2 = Completer.sync(); var result = completer1.future; @@ -218,7 +218,7 @@ void main() { test( 'sets isRefreshing to true if triggered by a ref.invalidate/ref.refresh', () async { - final container = createContainer(); + final container = ProviderContainer.test(); var count = 0; final provider = FutureProvider((ref) => Future.value(count++)); @@ -245,7 +245,7 @@ void main() { test('does not set isRefreshing if triggered by a dependency change', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = FutureProvider((ref) => Future.value(ref.watch(dep))); @@ -266,7 +266,7 @@ void main() { test( 'does not set isRefreshing if both triggered by a dependency change and ref.refresh', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = FutureProvider((ref) => Future.value(ref.watch(dep))); @@ -286,7 +286,7 @@ void main() { }); test('can read and set current AsyncValue', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); late FutureProviderRef ref; final provider = FutureProvider((r) { @@ -323,8 +323,8 @@ void main() { (ref) => ref.watch(dep), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -337,7 +337,7 @@ void main() { test('can return a value synchronously, bypassing AsyncLoading', () async { final provider = FutureProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(provider), const AsyncData(0)); await expectLater(container.read(provider.future), completion(0)); @@ -345,7 +345,7 @@ void main() { test('can return an error synchronously, bypassing AsyncLoading', () async { final provider = FutureProvider((ref) => throw UnimplementedError()); - final container = createContainer(); + final container = ProviderContainer.test(); expect( container.read(provider), @@ -361,7 +361,7 @@ void main() { test('can refresh .future', () async { var future = Future.value(1); final provider = FutureProvider((ref) => future); - final container = createContainer(); + final container = ProviderContainer.test(); expect(await container.read(provider.future), 1); @@ -373,7 +373,7 @@ void main() { test('can be refreshed', () async { var result = 0; - final container = createContainer(); + final container = ProviderContainer.test(); final provider = FutureProvider((ref) => Future.value(result)); expect(await container.read(provider.future), 0); @@ -391,7 +391,7 @@ void main() { test('does not update dependents if the created stream did not change', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final completer = Completer(); final provider = FutureProvider((ref) { @@ -413,7 +413,7 @@ void main() { test( '.future does not update dependents if the created future did not change', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final completer = Completer(); final provider = FutureProvider((ref) { @@ -435,8 +435,9 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { final provider = FutureProvider((ref) async => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); @@ -449,8 +450,8 @@ void main() { // test('when using provider.overrideWithValue', () async { // final provider = FutureProvider((ref) async => 0); - // final root = createContainer(); - // final container = createContainer(parent: root, overrides: [ + // final root = ProviderContainer.test(); + // final container = ProviderContainer.test(parent: root, overrides: [ // provider.overrideWithValue(const AsyncValue.data(42)), // ]); @@ -466,8 +467,8 @@ void main() { test('when using provider.overrideWith', () async { final provider = FutureProvider((ref) async => 0); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref) async => 42), @@ -490,7 +491,7 @@ void main() { // final error = Error(); // final future = FutureProvider((ref) async => 0); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // future.overrideWithValue(AsyncValue.error(error)), // ]); // addTearDown(container.dispose); @@ -506,7 +507,7 @@ void main() { test('throwing inside "create" result in an AsyncValue.error', () { // ignore: only_throw_errors final provider = FutureProvider((ref) => throw 42); - final container = createContainer(); + final container = ProviderContainer.test(); expect( container.read(provider), @@ -530,7 +531,7 @@ void main() { test('handle errors', () async { // ignore: only_throw_errors final provider = FutureProvider((_) async => throw 42); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(provider), const AsyncValue.loading()); @@ -552,7 +553,7 @@ void main() { test('noop if fails after provider dispose', () async { // ignore: only_throw_errors final provider = FutureProvider((_) async => throw 42); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(provider), const AsyncValue.loading()); @@ -566,7 +567,7 @@ void main() { test('does not update dependents when the future completes', () async { final completer = Completer.sync(); final provider = FutureProvider((_) => completer.future); - final container = createContainer(); + final container = ProviderContainer.test(); var callCount = 0; final dependent = Provider>((ref) { callCount++; @@ -597,7 +598,7 @@ void main() { callCount++; return ref.watch(provider.future); }); - final container = createContainer(); + final container = ProviderContainer.test(); final futureController = container.read(futureProvider.notifier); await expectLater(container.read(dependent), completion(42)); @@ -626,7 +627,7 @@ void main() { callCount++; return ref.watch(provider.future); }); - final container = createContainer(); + final container = ProviderContainer.test(); final futureController = container.read(futureProvider.notifier); @@ -644,7 +645,7 @@ void main() { test('does not update dependents when the future completes', () async { final completer = Completer.sync(); final provider = FutureProvider.autoDispose((_) => completer.future); - final container = createContainer(); + final container = ProviderContainer.test(); var callCount = 0; final dependent = Provider.autoDispose((ref) { callCount++; @@ -672,7 +673,7 @@ void main() { ref.onDispose(() => didDispose = true); return Future.value(42); }); - final container = createContainer(); + final container = ProviderContainer.test(); final sub = container.listen(provider.future, (_, __) {}); expect(didDispose, false); @@ -688,7 +689,7 @@ void main() { }); test('read', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final completer = Completer.sync(); final other = FutureProvider((_) => completer.future); final simple = Provider((_) => 21); @@ -715,7 +716,7 @@ void main() { }); test('exposes data', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); final completer = Completer.sync(); final provider = FutureProvider((_) => completer.future); @@ -739,7 +740,7 @@ void main() { // group('mock as value', () { // test('value immediately then other value', () async { // final provider = FutureProvider((_) async => 0); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncValue.data(42)), // ]); @@ -765,7 +766,7 @@ void main() { // test('value immediately then error', () async { // final provider = FutureProvider((_) async => 0); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncValue.data(42)), // ]); @@ -794,7 +795,7 @@ void main() { // test('value immediately then loading', () async { // final provider = FutureProvider((_) async => 0); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncValue.data(42)), // ]); @@ -823,7 +824,7 @@ void main() { // test('loading immediately then value', () async { // final provider = FutureProvider((_) async => 0); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncValue.loading()), // ]); @@ -844,7 +845,7 @@ void main() { // test('loading immediately then error', () async { // final provider = FutureProvider((_) async => 0); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncValue.loading()), // ]); @@ -868,7 +869,7 @@ void main() { // test('loading immediately then loading', () async { // final provider = FutureProvider((_) async => 0); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncValue.loading()), // ]); // final listener = Listener>(); @@ -899,7 +900,7 @@ void main() { // test('error immediately then different error', () async { // final stackTrace = StackTrace.current; // final provider = FutureProvider((_) async => 0); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider // .overrideWithValue(AsyncValue.error(42, stackTrace: stackTrace)), // ]); @@ -928,7 +929,7 @@ void main() { // test('error immediately then different stacktrace', () async { // final stackTrace = StackTrace.current; // final provider = FutureProvider((_) async => 0); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider // .overrideWithValue(AsyncValue.error(42, stackTrace: stackTrace)), // ]); @@ -961,7 +962,7 @@ void main() { // test('error immediately then data', () async { // final stackTrace = StackTrace.current; // final provider = FutureProvider((_) async => 0); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider // .overrideWithValue(AsyncValue.error(42, stackTrace: stackTrace)), // ]); @@ -993,7 +994,7 @@ void main() { // test('error immediately then loading', () async { // final stackTrace = StackTrace.current; // final provider = FutureProvider((_) async => 0); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider // .overrideWithValue(AsyncValue.error(42, stackTrace: stackTrace)), // ]); diff --git a/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart b/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart index 3beaf3898..8251aae9c 100644 --- a/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart +++ b/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart @@ -31,7 +31,7 @@ void main() { for (final factory in matrix()) { group(factory.label, () { test('Cannot share a Notifier instance between providers ', () { - final container = createContainer(); + final container = ProviderContainer.test(); final notifier = factory.notifier((ref) => 0); final provider = factory.provider, int>( @@ -50,7 +50,7 @@ void main() { }); test('Can read state inside onDispose', () { - final container = createContainer(); + final container = ProviderContainer.test(); late TestNotifierBase notifier; final provider = factory.simpleTestProvider((ref) { ref.onDispose(() { @@ -66,7 +66,7 @@ void main() { }); test('Using the notifier after dispose throws', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider((ref) => 0); container.listen(provider.notifier, (prev, next) {}); @@ -85,7 +85,7 @@ void main() { 'throws if the same Notifier instance is reused in different providers', () { // Regression test for https://github.com/rrousselGit/riverpod/issues/2617 - final container = createContainer(); + final container = ProviderContainer.test(); final notifier = factory.notifier((ref) => 0); @@ -115,7 +115,7 @@ void main() { return 0; }); }); - final container = createContainer(); + final container = ProviderContainer.test(); final sub = container.listen( provider.notifier, @@ -131,7 +131,7 @@ void main() { final provider = factory.simpleTestProvider( (ref) => throw Exception('42'), ); - final container = createContainer(); + final container = ProviderContainer.test(); final sub = container.listen( provider.notifier, @@ -153,7 +153,7 @@ void main() { return 0; }); }); - final container = createContainer(); + final container = ProviderContainer.test(); final sub = container.listen( provider.notifier, @@ -170,7 +170,7 @@ void main() { final provider = factory.simpleTestProvider( (ref) => 0, ); - final container = createContainer(); + final container = ProviderContainer.test(); final sub = container.listen( provider.notifier, @@ -190,7 +190,7 @@ void main() { final provider = factory.simpleTestProvider( (ref) => 0, ); - final container = createContainer(); + final container = ProviderContainer.test(); final sub = container.listen( provider.notifier, @@ -211,7 +211,7 @@ void main() { 'uses notifier.build as initial state and update listeners when state changes', () { final provider = factory.simpleTestProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); container.listen(provider, listener.call, fireImmediately: true); @@ -228,7 +228,7 @@ void main() { final provider = factory.simpleTestProvider((ref) { return ref.watch(dep); }); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen( @@ -253,7 +253,7 @@ void main() { final provider = factory.simpleTestProvider((ref) { return ref.watch(dep); }); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); container.listen(provider, listener.call, fireImmediately: true); @@ -275,7 +275,7 @@ void main() { final provider = factory.simpleTestProvider((ref) { throw StateError('Hey'); }); - final container = createContainer(); + final container = ProviderContainer.test(); expect( () => container.read(provider), @@ -291,7 +291,7 @@ void main() { final provider = factory.provider, int>( () => Error.throwWithStackTrace(err, stack), ); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = ErrorListener(); expect( @@ -343,7 +343,7 @@ void main() { test('can read/set the current state within the notifier', () { final provider = factory.simpleTestProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); container.listen(provider, listener.call, fireImmediately: true); @@ -368,7 +368,7 @@ void main() { () { final provider = factory .simpleTestProvider((ref) => throw UnimplementedError()); - final container = createContainer(); + final container = ProviderContainer.test(); final notifier = container.read(provider.notifier); @@ -383,7 +383,7 @@ void main() { final provider = factory.simpleTestProvider( (ref) => Error.throwWithStackTrace(err, stack), ); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); final onError = ErrorListener(); @@ -424,7 +424,7 @@ void main() { final dep = StateProvider((ref) => 0); final provider = factory.simpleTestProvider((ref) => ref.watch(dep)); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); container.listen(provider, listener.call); @@ -444,7 +444,7 @@ void main() { test('supports ref.refresh(provider)', () { final provider = factory.simpleTestProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final notifier = container.read(provider.notifier); @@ -467,7 +467,7 @@ void main() { ref.listenSelf(listener.call, onError: onError.call); Error.throwWithStackTrace(42, StackTrace.empty); }); - final container = createContainer(); + final container = ProviderContainer.test(); expect(() => container.read(provider), throwsA(42)); @@ -477,7 +477,7 @@ void main() { test('filters state update by identical by default', () { final provider = factory.simpleTestProvider>((ref) => Equal(42)); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, listener.call); @@ -502,7 +502,7 @@ void main() { (ref) => Equal(42), updateShouldNotify: (a, b) => a != b, ); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, listener.call); @@ -535,7 +535,7 @@ void main() { if (factory.isAutoDispose) { group('autoDispose', () { test('keeps state alive if notifier is listened', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final onDispose = OnDisposeMock(); final provider = factory.simpleTestProvider((ref) { ref.onDispose(onDispose.call); @@ -569,7 +569,7 @@ void main() { NotifierProvider.autoDispose, int>( () => AutoDisposeTestNotifier((ref) => 0), ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith(() => TestNotifier((ref) => 42)), autoDispose.overrideWith( @@ -590,7 +590,7 @@ void main() { .family, int, int>( () => AutoDisposeTestNotifierFamily((ref) => 0), ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ family.overrideWith( () => TestNotifierFamily((ref) => 42), diff --git a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart index 1700e27e3..749929b78 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart @@ -16,8 +16,9 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () { final provider = Provider.autoDispose.family((ref, _) => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider(0)), 0); expect(container.getAllProviderElements(), [ @@ -34,8 +35,8 @@ void main() { (ref, i) => ref.watch(dep) + i, dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -52,7 +53,7 @@ void main() { return '$value'; }); final listener = Listener(); - final container = createContainer(); + final container = ProviderContainer.test(); final sub = container.listen(provider(0), listener.call, fireImmediately: true); diff --git a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart index 45dbef581..6d5a877b6 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart @@ -8,7 +8,7 @@ void main() { group('Provider.autoDispose', () { group('ref.state', () { test('can read and change current value', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); late ProviderRef ref; final provider = Provider.autoDispose((r) { @@ -28,7 +28,7 @@ void main() { }); test('fails if trying to read the state before it was set', () { - final container = createContainer(); + final container = ProviderContainer.test(); Object? err; final provider = Provider.autoDispose((ref) { try { @@ -47,7 +47,7 @@ void main() { 'on rebuild, still fails if trying to read the state before was built', () { final dep = StateProvider((ref) => false); - final container = createContainer(); + final container = ProviderContainer.test(); Object? err; final provider = Provider.autoDispose((ref) { if (ref.watch(dep)) { @@ -70,7 +70,7 @@ void main() { }); test('can read the state if the setter was called before', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider.autoDispose((ref) { // ignore: join_return_with_assignment ref.state = 42; @@ -84,7 +84,7 @@ void main() { test('can be refreshed', () async { var result = 0; - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider.autoDispose((ref) => result); expect(container.read(provider), 0); @@ -97,7 +97,7 @@ void main() { test('does not notify listeners when called ref.state= with == new value', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); late AutoDisposeProviderRef ref; final provider = AutoDisposeProvider((r) { @@ -118,8 +118,9 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () { final provider = Provider.autoDispose((ref) => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider), 0); expect(container.getAllProviderElements(), [ @@ -131,8 +132,8 @@ void main() { test('when using provider.overrideWithValue', () { final provider = Provider.autoDispose((ref) => 0); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWithValue(42), @@ -149,8 +150,8 @@ void main() { test('when using provider.overrideWith', () { final provider = Provider.autoDispose((ref) => 0); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref) => 42), @@ -172,8 +173,8 @@ void main() { (ref) => ref.watch(dep), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart index 5e74876f2..f5d42137b 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart @@ -15,8 +15,9 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () { final provider = Provider.family((ref, _) => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider(0)), 0); expect(container.getAllProviderElements(), [ @@ -28,8 +29,8 @@ void main() { test('when using provider.overrideWith', () { final provider = Provider.family((ref, _) => 0); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [provider.overrideWith((ref, value) => 42)], ); @@ -49,8 +50,8 @@ void main() { (ref, i) => ref.watch(dep) + i, dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart index 74b825f7e..72a6f98ba 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart @@ -11,7 +11,7 @@ void main() { test('supports overrideWith', () { final provider = Provider((ref) => 0); final autoDispose = Provider.autoDispose((ref) => 0); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith((ProviderRef ref) => 42), autoDispose.overrideWith( @@ -29,7 +29,7 @@ void main() { final autoDisposeFamily = Provider.autoDispose.family( (ref, arg) => '0 $arg', ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ family.overrideWith((ProviderRef ref, int arg) => '42 $arg'), autoDisposeFamily.overrideWith( @@ -44,7 +44,7 @@ void main() { test('can be refreshed', () async { var result = 0; - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider((ref) => result); expect(container.read(provider), 0); @@ -57,7 +57,7 @@ void main() { group('ref.state', () { test('throws on providers that threw', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider((ref) => throw UnimplementedError()); expect( @@ -75,7 +75,7 @@ void main() { }); test('can read and change current value', () { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); late ProviderRef ref; final provider = Provider((r) { @@ -95,7 +95,7 @@ void main() { }); test('fails if trying to read the state before it was set', () { - final container = createContainer(); + final container = ProviderContainer.test(); Object? err; final provider = Provider((ref) { try { @@ -114,7 +114,7 @@ void main() { 'on rebuild, still fails if trying to read the state before was built', () { final dep = StateProvider((ref) => false); - final container = createContainer(); + final container = ProviderContainer.test(); Object? err; final provider = Provider((ref) { if (ref.watch(dep)) { @@ -137,7 +137,7 @@ void main() { }); test('can read the state if the setter was called before', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = Provider((ref) { // ignore: join_return_with_assignment ref.state = 42; @@ -151,7 +151,7 @@ void main() { test('does not notify listeners when called ref.state= with == new value', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); late ProviderRef ref; final provider = Provider((r) { @@ -172,8 +172,9 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () { final provider = Provider((ref) => 0); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider), 0); expect(container.getAllProviderElements(), [ @@ -185,8 +186,8 @@ void main() { test('when using provider.overrideWithValue', () { final provider = Provider((ref) => 0); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [provider.overrideWithValue(42)], ); @@ -201,8 +202,8 @@ void main() { test('when using provider.overrideWith', () { final provider = Provider((ref) => 0); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref) => 42), @@ -233,7 +234,7 @@ void main() { }); test('dispose', () { - final container = createContainer(); + final container = ProviderContainer.test(); final onDispose = OnDisposeMock(); final provider = Provider((ref) { ref.onDispose(onDispose.call); @@ -250,7 +251,7 @@ void main() { }); test('Read creates the value only once', () { - final container = createContainer(); + final container = ProviderContainer.test(); var callCount = 0; final provider = Provider((ref) { callCount++; @@ -266,7 +267,7 @@ void main() { }); test("rebuild don't notify clients if == doesn't change", () { - final container = createContainer(); + final container = ProviderContainer.test(); final counter = Counter(); final other = StateNotifierProvider((ref) => counter); var buildCount = 0; @@ -292,7 +293,7 @@ void main() { }); test('rebuild notify clients if == did change', () { - final container = createContainer(); + final container = ProviderContainer.test(); final counter = Counter(); final other = StateNotifierProvider((ref) => counter); final provider = Provider((ref) { @@ -318,8 +319,8 @@ void main() { (ref) => ref.watch(dep), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); diff --git a/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart index 530e5cd48..687ad623b 100644 --- a/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart @@ -12,7 +12,7 @@ void main() { (ref) => ref.watch(dep.notifier), dependencies: [dep], ); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(provider).state, 0); }); @@ -20,16 +20,16 @@ void main() { group('scoping mechanism', () { test('use the deepest override', () { final provider = Provider((ref) => 0); - final root = createContainer( + final root = ProviderContainer.test( overrides: [provider.overrideWithValue(1)], ); - final mid = createContainer( + final mid = ProviderContainer.test( parent: root, overrides: [ provider.overrideWithValue(42), ], ); - final container = createContainer(parent: mid); + final container = ProviderContainer.test(parent: mid); expect(container.read(provider), 42); @@ -44,10 +44,10 @@ void main() { test('can read both parent and child simultaneously', () async { final provider = Provider((ref) => 0); - final root = createContainer( + final root = ProviderContainer.test( overrides: [provider.overrideWithValue(21)], ); - final container = createContainer( + final container = ProviderContainer.test( parent: root, overrides: [provider.overrideWithValue(42)], ); @@ -60,7 +60,7 @@ void main() { test('supports auto-dispose', () async { final provider = Provider.autoDispose((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final sub = container.listen(provider, (_, __) {}); final element = container.readProviderElement(provider); @@ -80,10 +80,10 @@ void main() { test('are disposed on nested containers', () { final provider = Provider((ref) => 0); - final root = createContainer( + final root = ProviderContainer.test( overrides: [provider.overrideWithValue(1)], ); - final container = createContainer( + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWithValue(42), @@ -101,8 +101,8 @@ void main() { test('can be overridden on non-root container', () { final provider = Provider((ref) => 0); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [provider.overrideWithValue(42)], ); @@ -116,8 +116,8 @@ void main() { final provider2 = Provider((ref) { return ref.watch(provider) * 2; }); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWithValue(1), @@ -145,8 +145,9 @@ void main() { final provider2 = Provider((ref) { return ref.watch(provider) * 2; }); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider2]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider2]); container.listen(provider2, listener.call, fireImmediately: true); diff --git a/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart b/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart index 5ec7b7215..a13c7fade 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart @@ -33,7 +33,7 @@ void main() { for (final factory in matrix()) { group(factory.label, () { test('Cannot share a Notifier instance between providers ', () { - final container = createContainer(); + final container = ProviderContainer.test(); final notifier = factory.notifier((ref) => Stream.value(0)); final provider = factory.provider, int>( @@ -52,7 +52,7 @@ void main() { }); test('Can read state inside onDispose', () { - final container = createContainer(); + final container = ProviderContainer.test(); late StreamTestNotifierBase notifier; final provider = factory.simpleTestProvider((ref) { ref.onDispose(() { @@ -68,7 +68,7 @@ void main() { }); test('Using the notifier after dispose throws', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider((ref) => Stream.value(0)); container.listen(provider.notifier, (prev, next) {}); @@ -88,7 +88,7 @@ void main() { test( 'performs seamless copyWithPrevious if triggered by ref.invalidate/ref.refresh', () async { - final container = createContainer(); + final container = ProviderContainer.test(); var count = 0; final provider = factory.simpleTestProvider( (ref) => Stream.value(count++), @@ -120,7 +120,7 @@ void main() { test( 'performs seamless:false copyWithPrevious on `state = AsyncLoading()`', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider((ref) => Stream.value(0)); final sub = container.listen(provider.notifier, (previous, next) {}); @@ -140,7 +140,7 @@ void main() { test( 'performs seamless:false copyWithPrevious if triggered by a dependency change', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = factory.simpleTestProvider( (ref) => Stream.value(ref.watch(dep)), @@ -165,7 +165,7 @@ void main() { test( 'performs seamless:false copyWithPrevious if both triggered by a dependency change and ref.refresh', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = factory.simpleTestProvider( (ref) => Stream.value(ref.watch(dep)), @@ -190,7 +190,7 @@ void main() { test('does not notify listeners when refreshed during loading', () async { final provider = factory.simpleTestProvider((ref) => Stream.value(0)); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, listener.call, fireImmediately: true); @@ -214,7 +214,7 @@ void main() { ref.listenSelf(listener.call, onError: onError.call); Error.throwWithStackTrace(42, StackTrace.empty); }); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider, (previous, next) {}); @@ -240,7 +240,7 @@ void main() { 'converts StreamNotifier.build into an AsyncData if the future completes', () async { final provider = factory.simpleTestProvider((ref) => Stream.value(0)); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, listener.call, fireImmediately: true); @@ -269,7 +269,7 @@ void main() { final provider = factory.simpleTestProvider( (ref) => Stream.error(0, StackTrace.empty), ); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, listener.call, fireImmediately: true); @@ -297,7 +297,7 @@ void main() { final provider = factory.testProvider( () => Error.throwWithStackTrace(0, StackTrace.empty), ); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, listener.call, fireImmediately: true); @@ -320,7 +320,7 @@ void main() { final provider = factory.simpleTestProvider( (ref) => Error.throwWithStackTrace(42, StackTrace.empty), ); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider, listener.call, fireImmediately: true); @@ -339,7 +339,7 @@ void main() { test( 'stops listening to the previous future data when the provider rebuilds', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final completers = { 0: Completer.sync(), @@ -378,7 +378,7 @@ void main() { test( 'stops listening to the previous future error when the provider rebuilds', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final completers = { 0: Completer.sync(), @@ -424,7 +424,7 @@ void main() { final provider = factory.simpleTestProvider( (ref) => Stream.value(0), ); - final container = createContainer(); + final container = ProviderContainer.test(); final sub = container.listen(provider.notifier, (previous, next) {}); await container.read(provider.future); @@ -470,7 +470,7 @@ void main() { return Stream.value(ref.watch(dep)); }, ); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider, (previous, next) {}); final notifier = container.read(provider.notifier); @@ -506,7 +506,7 @@ void main() { ); }, ); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider, (previous, next) {}); @@ -523,7 +523,7 @@ void main() { test('notifies listeners when the setter is called', () async { final provider = factory.simpleTestProvider((ref) => Stream.value(0)); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); // Skip the loading @@ -546,7 +546,7 @@ void main() { test( 'when disposed during loading, resolves with the content of StreamNotifier.build', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( (ref) => Stream.fromFuture(completer.future), @@ -563,7 +563,7 @@ void main() { test( 'when disposed during loading, resolves with the error of StreamNotifier.build', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( (ref) => Stream.fromFuture(completer.future), @@ -582,7 +582,7 @@ void main() { 'going data > loading while the future is still pending. ' 'Resolves with last future result', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( (ref) => Stream.fromFuture(completer.future), @@ -605,7 +605,7 @@ void main() { test( 'if going back to loading after future resolved, throws StateError', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( (ref) => Stream.fromFuture(completer.future), @@ -629,7 +629,7 @@ void main() { test( 'resolves with the new state if StreamNotifier.state is modified during loading', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( (ref) => Stream.fromFuture(completer.future), @@ -656,7 +656,7 @@ void main() { test('resolves with the new state when notifier.state is changed', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( (ref) => Stream.value(0), ); @@ -689,7 +689,7 @@ void main() { return Stream.value(ref.watch(dep)); }, ); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider.notifier, (previous, next) {}); final notifier = container.read(provider.notifier); @@ -708,7 +708,7 @@ void main() { return Stream.value(ref.watch(dep)); }, ); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider, (previous, next) {}); final notifier = container.read(provider.notifier); @@ -737,7 +737,7 @@ void main() { (ref) => Stream.value(ref.watch(dep)), ); }); - final container = createContainer(); + final container = ProviderContainer.test(); // Skip the loading await container.listen(provider.future, (previous, next) {}).read(); @@ -764,7 +764,7 @@ void main() { (ref) => Stream.value(Equal(42)), updateShouldNotify: (a, b) => a != b, ); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>>(); // Skip the loading @@ -793,7 +793,7 @@ void main() { group('AsyncNotifier.update', () { test('passes in the latest state', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( (ref) => Stream.value(0), ); @@ -823,7 +823,7 @@ void main() { }); test('can specify onError to handle error scenario', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( (ref) => Error.throwWithStackTrace(42, StackTrace.empty), ); @@ -860,7 +860,7 @@ void main() { test('executes immediately with current state if a state is available', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( (ref) => Stream.value(1), ); @@ -881,7 +881,7 @@ void main() { test('executes immediately with current state if an error is available', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( (ref) => Error.throwWithStackTrace(42, StackTrace.empty), ); @@ -910,7 +910,7 @@ void main() { }); test('awaits the future resolution if in loading state', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( (ref) => Stream.value(42), ); @@ -937,7 +937,7 @@ void main() { AutoDisposeStreamTestNotifier, int>( () => AutoDisposeStreamTestNotifier((ref) => Stream.value(0)), ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith( () => StreamTestNotifier((ref) => Stream.value(42)), @@ -965,7 +965,7 @@ void main() { .family, int, int>( () => AutoDisposeStreamTestNotifierFamily((ref) => Stream.value(0)), ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ family.overrideWith( () => StreamTestNotifierFamily((ref) => Stream.value(42)), @@ -997,7 +997,7 @@ void main() { return Stream.value(ref.watch(dep)); }), ); - final container = createContainer(); + final container = ProviderContainer.test(); // Skip the loading await container.listen(provider.future, (previous, next) {}).read(); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart index 4026ea471..756b74bea 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart @@ -18,8 +18,9 @@ void main() { test('when passing the provider itself', () async { final provider = StreamProvider.autoDispose .family((ref, _) => Stream.value(0)); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(await container.read(provider(0).future), 0); expect(container.read(provider(0)), const AsyncData(0)); @@ -38,7 +39,7 @@ void main() { final provider = StreamProvider.autoDispose.family((ref, a) { return Stream.value(a * 2); }); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); container.listen(provider(21), listener.call, fireImmediately: true); @@ -85,8 +86,8 @@ void main() { (ref, i) => Stream.value(ref.watch(dep) + i), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart index 9a6efbc4c..184455a75 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart @@ -9,7 +9,7 @@ import '../../utils.dart'; void main() { group('StreamProvider.autoDispose', () { test('can read and set current AsyncValue', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); late AutoDisposeStreamProviderRef ref; final provider = StreamProvider.autoDispose((r) { @@ -53,8 +53,8 @@ void main() { (ref) => Stream.value(ref.watch(dep)), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -70,7 +70,7 @@ void main() { () async { final dep = StateProvider((ref) => Stream.value(42)); final provider = StreamProvider.autoDispose((ref) => ref.watch(dep)); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); final controller = StreamController(); addTearDown(controller.close); @@ -114,7 +114,7 @@ void main() { test('can be refreshed', () async { var result = 0; - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StreamProvider.autoDispose((ref) => Stream.value(result)); @@ -136,7 +136,7 @@ void main() { test('does not update dependents if the created stream did not change', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = StreamProvider.autoDispose((ref) { ref.watch(dep); @@ -157,7 +157,7 @@ void main() { test( '.future does not update dependents if the created future did not change', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = StreamProvider.autoDispose((ref) { ref.watch(dep); @@ -183,8 +183,9 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { final provider = StreamProvider.autoDispose((ref) => Stream.value(0)); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); @@ -200,8 +201,8 @@ void main() { // test('when using provider.overrideWithValue', () async { // final provider = StreamProvider.autoDispose((ref) => Stream.value(0)); - // final root = createContainer(); - // final container = createContainer(parent: root, overrides: [ + // final root = ProviderContainer.test(); + // final container = ProviderContainer.test(parent: root, overrides: [ // provider.overrideWithValue(const AsyncValue.data(42)), // ]); @@ -224,8 +225,8 @@ void main() { test('when using provider.overrideWith', () async { final provider = StreamProvider.autoDispose((ref) => Stream.value(0)); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref) => Stream.value(42)), @@ -252,7 +253,7 @@ void main() { ref.onDispose(onDispose.call); return stream; }); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); final sub = diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart index 18542148e..9800c739c 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart @@ -17,8 +17,9 @@ void main() { test('when passing the provider itself', () async { final provider = StreamProvider.family((ref, _) => Stream.value(0)); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(await container.read(provider(0).future), 0); expect(container.read(provider(0)), const AsyncData(0)); @@ -35,8 +36,8 @@ void main() { test('when using provider.overrideWith', () async { final provider = StreamProvider.family((ref, _) => Stream.value(0)); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref, value) => Stream.value(42)), @@ -62,8 +63,8 @@ void main() { (ref, i) => Stream.value(ref.watch(dep) + i), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart index e1e4df33f..9042f7670 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart @@ -15,7 +15,7 @@ void main() { // TODO remove this setup/teardown setUp(() { - container = createContainer(); + container = ProviderContainer.test(); controller = StreamController(sync: true); }); tearDown(() { @@ -36,7 +36,7 @@ void main() { return Stream.value(1); }, ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith((StreamProviderRef ref) { ref.state = const AsyncData(42); @@ -64,7 +64,7 @@ void main() { return Stream.value('1 $arg'); }, ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ family.overrideWith( (StreamProviderRef ref, int arg) { @@ -86,7 +86,7 @@ void main() { }); test('Emits AsyncLoading before the create function is executed', () async { - final container = createContainer(); + final container = ProviderContainer.test(); late AsyncValue state; final provider = StreamProvider((ref) { state = ref.state; @@ -110,7 +110,7 @@ void main() { test( 'sets isRefreshing to true if triggered by a ref.invalidate/ref.refresh', () async { - final container = createContainer(); + final container = ProviderContainer.test(); var count = 0; final provider = StreamProvider((ref) => Stream.value(count++)); @@ -137,7 +137,7 @@ void main() { test('does not set isRefreshing if triggered by a dependency change', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = StreamProvider((ref) => Stream.value(ref.watch(dep))); @@ -158,7 +158,7 @@ void main() { test( 'does not set isRefreshing if both triggered by a dependency change and ref.refresh', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = StreamProvider((ref) => Stream.value(ref.watch(dep))); @@ -178,7 +178,7 @@ void main() { }); test('can read and set current AsyncValue', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); late StreamProviderRef ref; final provider = StreamProvider((r) { @@ -222,8 +222,8 @@ void main() { (ref) => Stream.value(ref.watch(dep)), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -239,7 +239,7 @@ void main() { () async { final dep = StateProvider((ref) => Stream.value(42)); final provider = StreamProvider((ref) => ref.watch(dep)); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); final controller = StreamController(); addTearDown(controller.close); @@ -281,7 +281,7 @@ void main() { test('can be refreshed', () async { var result = 0; - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StreamProvider((ref) => Stream.value(result)); expect(await container.read(provider.future), 0); @@ -300,8 +300,9 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { final provider = StreamProvider((ref) => Stream.value(0)); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); @@ -317,8 +318,8 @@ void main() { // test('when using provider.overrideWithValue', () async { // final provider = StreamProvider((ref) => Stream.value(0)); - // final root = createContainer(); - // final container = createContainer(parent: root, overrides: [ + // final root = ProviderContainer.test(); + // final container = ProviderContainer.test(parent: root, overrides: [ // provider.overrideWithValue(const AsyncValue.data(42)), // ]); @@ -341,8 +342,8 @@ void main() { test('when using provider.overrideWith', () async { final provider = StreamProvider((ref) => Stream.value(0)); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref) => Stream.value(42)), @@ -386,7 +387,7 @@ void main() { // test( // 'throws StateError if the provider is disposed before a value was emitted', // () async { - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncLoading()), // ]); @@ -409,7 +410,7 @@ void main() { // }); // test('supports loading then error then loading', () async { - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncLoading()), // ]); @@ -445,7 +446,7 @@ void main() { // }); // test('supports loading then error then another error', () async { - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncLoading()), // ]); @@ -476,7 +477,7 @@ void main() { // }); // test('supports loading then data then loading', () async { - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncLoading()), // ]); @@ -504,7 +505,7 @@ void main() { // }); // test('supports loading then data then another data', () async { - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncLoading()), // ]); @@ -538,7 +539,7 @@ void main() { // test('myProvider.stream re-create a new stream when re-entering loading', // () async { - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncValue.data(42)), // ]); @@ -567,7 +568,7 @@ void main() { // }); // test('myProvider.stream works across provider rebuild', () async { - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncValue.data(42)), // ]); @@ -656,7 +657,7 @@ void main() { group('overrideWithValue(T)', () { // test('.stream is a broadcast stream', () async { // final provider = StreamProvider((ref) => controller.stream); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncValue.data(42)), // ]); @@ -673,7 +674,7 @@ void main() { // test('.stream queues events when there are no listeners', () async { // final provider = StreamProvider((ref) => controller.stream); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncValue.data(42)), // ]); @@ -700,7 +701,7 @@ void main() { // test('.stream emits done when the container is disposed', () async { // final provider = StreamProvider.autoDispose((ref) => controller.stream); - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncValue.data(42)), // ]); @@ -736,7 +737,7 @@ void main() { final provider = StreamProvider.family((ref, a) { return Stream.value('$a'); }); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(provider(0)), const AsyncValue.loading()); @@ -763,7 +764,7 @@ void main() { test('subscribe exposes loading synchronously then value on change', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final controller = StreamController(sync: true); final provider = StreamProvider((_) => controller.stream); final listener = Listener>(); @@ -790,7 +791,7 @@ void main() { }); test('errors', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final controller = StreamController(sync: true); final provider = StreamProvider((_) => controller.stream); final listener = Listener>(); @@ -827,7 +828,7 @@ void main() { }); test('stops subscription', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final controller = StreamController(sync: true); final dispose = OnDisposeMock(); final provider = StreamProvider((ref) { @@ -863,7 +864,7 @@ void main() { group('StreamProvider.future', () { group('from StreamProvider', () { test('read currentValue before first value', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final controller = StreamController(); final provider = StreamProvider((_) => controller.stream); @@ -877,7 +878,7 @@ void main() { }); test('read currentValue before after value', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final controller = StreamController(); final provider = StreamProvider((_) => controller.stream); @@ -891,7 +892,7 @@ void main() { }); test('read currentValue before first error', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final controller = StreamController(); final provider = StreamProvider((_) => controller.stream); @@ -905,7 +906,7 @@ void main() { }); test('read currentValue before after error', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final controller = StreamController(); final provider = StreamProvider((_) => controller.stream); diff --git a/packages/riverpod/test/old/utils.dart b/packages/riverpod/test/old/utils.dart index 745864173..64a148cee 100644 --- a/packages/riverpod/test/old/utils.dart +++ b/packages/riverpod/test/old/utils.dart @@ -22,20 +22,6 @@ class Counter extends StateNotifier { set state(int value) => super.state = value; } -ProviderContainer createContainer({ - ProviderContainer? parent, - List overrides = const [], - List? observers, -}) { - final container = ProviderContainer( - parent: parent, - overrides: overrides, - observers: observers, - ); - addTearDown(container.dispose); - return container; -} - List errorsOf(void Function() cb) { final errors = []; runZonedGuarded(cb, (err, _) => errors.add(err)); From da94a8207e7c941efd117fe13fdc45115e93225e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 22 Dec 2023 19:02:45 +0100 Subject: [PATCH 084/387] Handle recursive dispose --- .../lib/src/core/provider_container.dart | 10 ++++- .../test/new/core/auto_dispose_test.dart | 39 +++++++++++++++++++ .../test/old/framework/auto_dispose_test.dart | 24 ------------ 3 files changed, 47 insertions(+), 26 deletions(-) diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index f55b5c5f2..c95966b82 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -841,16 +841,22 @@ class ProviderContainer implements Node { } void _disposeProvider(ProviderBase provider) { + final pointer = _pointerManager.remove(provider); + if (provider.allTransitiveDependencies != null) { /// Recursively removes the pointer in all containers if the provider /// can be scoped. for (final child in _children) { + final childPointer = child._pointerManager.readPointer(provider); + + // The child container uses a different instance for this provider. + // We don't need to dispose it. + if (childPointer != null && childPointer != pointer) continue; + child._disposeProvider(provider); } } - final pointer = _pointerManager.remove(provider); - // The provider is already disposed, so we don't need to do anything if (pointer == null) return; diff --git a/packages/riverpod/test/new/core/auto_dispose_test.dart b/packages/riverpod/test/new/core/auto_dispose_test.dart index aa4fa88c7..62c1194e3 100644 --- a/packages/riverpod/test/new/core/auto_dispose_test.dart +++ b/packages/riverpod/test/new/core/auto_dispose_test.dart @@ -2,6 +2,8 @@ import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; +import 'provider_container_test.dart'; + void main() { group('AutoDispose', () { test('supports disposing of overridden families', () async { @@ -31,5 +33,42 @@ void main() { }); // TODO test recursive dispose does not remove pointers in unrelated containers + + test( + 'When a non-overridden autoDispose provider is disposed ' + 'and the associated ProviderContainer has a child ProviderContainer which overrides said provider, ' + 'the child container keeps its override', () async { +// Regression test for https://github.com/rrousselGit/riverpod/issues/1519 + + final provider = Provider.autoDispose( + (ref) => 0, + dependencies: const [], + ); + final root = ProviderContainer.test(); + final child = ProviderContainer.test( + parent: root, + overrides: [ + provider.overrideWith((ref) { + ref.keepAlive(); + return 42; + }) + ], + ); + + root.read(provider); + child.read(provider); + + await root.pump(); + + expect( + root.pointerManager.readPointer(provider), + isNull, + ); + + expect( + child.pointerManager.readPointer(provider), + isPointer(override: isNotNull, element: isNotNull), + ); + }); }); } diff --git a/packages/riverpod/test/old/framework/auto_dispose_test.dart b/packages/riverpod/test/old/framework/auto_dispose_test.dart index 9ed96a29e..a60c5e839 100644 --- a/packages/riverpod/test/old/framework/auto_dispose_test.dart +++ b/packages/riverpod/test/old/framework/auto_dispose_test.dart @@ -8,30 +8,6 @@ import '../utils.dart'; Future main() async { final library = await Library.parseFromStacktrace(); - test( - 'When a non-overridden autoDispose provider is disposed ' - 'and the associated ProviderContainer has a child ProviderContainer which overrides said provider, ' - 'the child container keeps its override', () async { -// Regression test for https://github.com/rrousselGit/riverpod/issues/1519 - - final root = ProviderContainer.test(); - final provider = Provider.autoDispose((ref) => 0); - final child = ProviderContainer.test( - parent: root, - overrides: [provider.overrideWithValue(42)], - ); - - root.read(provider); - - await root.pump(); - - child.updateOverrides([ - provider.overrideWithValue(21), - ]); - - expect(child.read(provider), 21); - }); - test( 'Handles cases where the ProviderContainer is disposed yet Scheduler.performDispose is invoked anyway', () async { From c9be83e3d2d5af74a105172e7482255c530c86ec Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 22 Dec 2023 20:16:55 +0100 Subject: [PATCH 085/387] Move one test --- .../test/new/core/auto_dispose_test.dart | 31 +++++++++++++++++++ .../test/old/framework/auto_dispose_test.dart | 31 ------------------- 2 files changed, 31 insertions(+), 31 deletions(-) diff --git a/packages/riverpod/test/new/core/auto_dispose_test.dart b/packages/riverpod/test/new/core/auto_dispose_test.dart index 62c1194e3..43a8b4661 100644 --- a/packages/riverpod/test/new/core/auto_dispose_test.dart +++ b/packages/riverpod/test/new/core/auto_dispose_test.dart @@ -1,7 +1,9 @@ +import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; +import '../utils.dart'; import 'provider_container_test.dart'; void main() { @@ -70,5 +72,34 @@ void main() { isPointer(override: isNotNull, element: isNotNull), ); }); + + group('on unused providers', () { + test( + 'if a dependency changed, the element is still disposed, ' + 'but without calling ref.onDispose again', () async { + final container = ProviderContainer.test(); + final onDispose = OnDisposeMock(); + final dep = StateProvider((ref) => 0); + final provider = Provider.autoDispose((ref) { + ref.onDispose(onDispose.call); + return ref.watch(dep); + }); + + container.read(provider); + verifyZeroInteractions(onDispose); + container.read(dep.notifier).state++; + + expect( + container.pointerManager.readPointer(provider), + isNotNull, + ); + + await container.pump(); + + verify(onDispose()).called(1); + + expect(container.pointerManager.readPointer(provider), isNull); + }); + }); }); } diff --git a/packages/riverpod/test/old/framework/auto_dispose_test.dart b/packages/riverpod/test/old/framework/auto_dispose_test.dart index a60c5e839..0e450deb3 100644 --- a/packages/riverpod/test/old/framework/auto_dispose_test.dart +++ b/packages/riverpod/test/old/framework/auto_dispose_test.dart @@ -286,37 +286,6 @@ final alwaysAlive = Provider((ref) { }); }); - test( - 'if a dependency changed, the element is still disposed, ' - 'but without calling ref.onDispose again', () async { - final container = ProviderContainer.test(); - final onDispose = OnDisposeMock(); - final dep = StateProvider((ref) => 0); - final provider = Provider.autoDispose((ref) { - ref.onDispose(onDispose.call); - return ref.watch(dep); - }); - - container.read(provider); - - verifyZeroInteractions(onDispose); - expect( - container.getAllProviderElements().map((e) => e.origin), - contains(provider), - ); - - container.read(dep.notifier).state++; - - await container.pump(); - - verify(onDispose()).called(1); - - expect( - container.getAllProviderElements().map((e) => e.origin), - isNot(contains(provider)), - ); - }); - test( 'when a provider conditionally depends on another provider, rebuilding without the dependency can dispose the dependency', () async { From 56783748d7c4ac76ac42391fe8830ae11401eff1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 22 Dec 2023 23:25:25 +0100 Subject: [PATCH 086/387] Add a bunch of dependencies --- .../auto_dispose_family_test.dart | 17 +++++-- ..._dispose_state_notifier_provider_test.dart | 12 +++-- .../state_notifier_provider/family_test.dart | 20 ++++++--- .../state_notifier_provider_test.dart | 13 ++++-- .../state_provider_auto_dispose_test.dart | 22 ++++++--- ...ate_provider_family_auto_dispose_test.dart | 23 +++++++--- .../state_provider_family_test.dart | 21 ++++++--- .../state_provider/state_provider_test.dart | 21 ++++++--- ...o_dispose_family_future_provider_test.dart | 24 ++++++---- .../auto_dispose_future_provider_test.dart | 21 ++++++--- .../family_future_provider_test.dart | 21 ++++++--- .../future_provider/future_provider_test.dart | 21 ++++++--- .../auto_dispose_provider_family_test.dart | 16 +++++-- .../provider/auto_dispose_provider_test.dart | 26 ++++++++--- .../provider/provider_family_test.dart | 21 ++++++--- .../provider/provider_test.dart | 26 ++++++++--- .../scoped_provider/scoped_provider_test.dart | 45 +++++++++++++------ ...o_dispose_family_stream_provider_test.dart | 17 ++++--- .../auto_dispose_stream_provider_test.dart | 21 ++++++--- .../stream_provider_family_test.dart | 23 +++++++--- .../stream_provider/stream_provider_test.dart | 21 ++++++--- 21 files changed, 336 insertions(+), 116 deletions(-) diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart index b685e8ac7..f5a3ab47b 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart @@ -16,7 +16,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = StateNotifierProvider.autoDispose .family, int, int>( (ref, i) => StateController(ref.watch(dep) + i), @@ -40,10 +43,13 @@ void main() { final provider = StateNotifierProvider.autoDispose .family, int, int>( (ref, _) => controller, + dependencies: const [], ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(container.read(provider(0).notifier), controller); expect(container.read(provider(0)), 0); @@ -60,7 +66,10 @@ void main() { test('when using provider.overrideWith', () async { final controller = StateController(0); final provider = StateNotifierProvider.autoDispose - .family, int, int>((ref, _) => controller); + .family, int, int>( + (ref, _) => controller, + dependencies: const [], + ); final root = ProviderContainer.test(); final controllerOverride = StateController(42); final container = ProviderContainer.test( diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart index 9b62043d1..d1193a5d7 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart @@ -21,7 +21,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = StateNotifierProvider.autoDispose, int>( (ref) => StateController(ref.watch(dep)), @@ -81,10 +84,13 @@ void main() { final provider = StateNotifierProvider.autoDispose, int>( (ref) => controller, + dependencies: const [], ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(container.read(provider.notifier), controller); expect(container.read(provider), 0); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart index 306ee6bd1..4fe7d9680 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart @@ -17,7 +17,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = StateNotifierProvider.family, int, int>( (ref, i) => StateController(ref.watch(dep) + i), @@ -41,10 +44,13 @@ void main() { final provider = StateNotifierProvider.family, int, int>( (ref, _) => controller, + dependencies: const [], ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(container.read(provider(0).notifier), controller); expect(container.read(provider(0)), 0); @@ -63,6 +69,7 @@ void main() { final provider = StateNotifierProvider.family, int, int>( (ref, _) => controller, + dependencies: const [], ); final root = ProviderContainer.test(); final controllerOverride = StateController(42); @@ -118,10 +125,13 @@ void main() { () { final family = StateNotifierProvider.family( (ref, id) => Counter(), + dependencies: const [], ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [family]); + final container = ProviderContainer.test( + parent: root, + overrides: [family], + ); expect(container.read(family('0')), 0); expect(container.read(family('0').notifier), isA()); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart index f390e196f..c079350fa 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart @@ -110,7 +110,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = StateNotifierProvider, int>( (ref) => StateController(ref.watch(dep)), dependencies: [dep], @@ -164,10 +167,13 @@ void main() { final controller = StateController(0); final provider = StateNotifierProvider, int>( (ref) => controller, + dependencies: const [], ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(container.read(provider.notifier), controller); expect(container.read(provider), 0); @@ -210,6 +216,7 @@ void main() { final provider = StateNotifierProvider.autoDispose, int>( (ref) => controller, + dependencies: const [], ); final root = ProviderContainer.test(); final controllerOverride = StateController(42); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart index e42a85397..fdc1b0746 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart @@ -17,7 +17,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = StateProvider.autoDispose( (ref) => ref.watch(dep), dependencies: [dep], @@ -133,10 +136,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { - final provider = StateProvider.autoDispose((ref) => 0); + final provider = StateProvider.autoDispose( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(container.read(provider.notifier).state, 0); expect(container.read(provider), 0); @@ -174,7 +182,11 @@ void main() { // }); test('when using provider.overrideWith', () async { - final provider = StateProvider.autoDispose((ref) => 0, name: 'true'); + final provider = StateProvider.autoDispose( + (ref) => 0, + name: 'true', + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart index 11d3dccaf..9f0fbc2a4 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart @@ -29,11 +29,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { - final provider = - StateProvider.autoDispose.family((ref, _) => 0); + final provider = StateProvider.autoDispose.family( + (ref, _) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(container.read(provider(0).notifier).state, 0); expect(container.read(provider(0)), 0); @@ -48,8 +52,10 @@ void main() { }); test('when using provider.overrideWith', () async { - final provider = - StateProvider.autoDispose.family((ref, _) => 0); + final provider = StateProvider.autoDispose.family( + (ref, _) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, @@ -72,7 +78,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = StateProvider.autoDispose.family( (ref, i) => ref.watch(dep) + i, dependencies: [dep], diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart index d54886102..b70fc574c 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart @@ -27,10 +27,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { - final provider = StateProvider.family((ref, _) => 0); + final provider = StateProvider.family( + (ref, _) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(container.read(provider(0).notifier).state, 0); expect(container.read(provider(0)), 0); @@ -45,7 +50,10 @@ void main() { }); test('when using provider.overrideWith', () async { - final provider = StateProvider.family((ref, _) => 0); + final provider = StateProvider.family( + (ref, _) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, @@ -68,7 +76,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = StateProvider.family( (ref, i) => ref.watch(dep) + i, dependencies: [dep], diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart index 1c475e398..04ac24eab 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart @@ -91,7 +91,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = StateProvider( (ref) => ref.watch(dep), dependencies: [dep], @@ -224,10 +227,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { - final provider = StateProvider((ref) => 0); + final provider = StateProvider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(container.read(provider.notifier).state, 0); expect(container.read(provider), 0); @@ -263,7 +271,10 @@ void main() { // }); test('when using provider.overrideWith', () async { - final provider = StateProvider((ref) => 0); + final provider = StateProvider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart index e84f1841a..ced002fbc 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart @@ -13,11 +13,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { - final provider = - FutureProvider.autoDispose.family((ref, _) async => 0); + final provider = FutureProvider.autoDispose.family( + (ref, _) async => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(await container.read(provider(0).future), 0); expect(container.read(provider(0)), const AsyncData(0)); @@ -29,7 +33,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = FutureProvider.family.autoDispose( (ref, i) => ref.watch(dep) + i, dependencies: [dep], @@ -47,9 +54,10 @@ void main() { }); test('when using provider.overrideWith', () async { - final provider = FutureProvider.autoDispose.family((ref, _) { - return 0; - }); + final provider = FutureProvider.autoDispose.family( + (ref, _) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart index a0e606d74..9f3fd2f57 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart @@ -39,7 +39,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = FutureProvider.autoDispose( (ref) => ref.watch(dep), dependencies: [dep], @@ -214,10 +217,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { - final provider = FutureProvider.autoDispose((ref) async => 0); + final provider = FutureProvider.autoDispose( + (ref) async => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); @@ -246,7 +254,10 @@ void main() { // }); test('when using provider.overrideWith', () async { - final provider = FutureProvider.autoDispose((ref) async => 0); + final provider = FutureProvider.autoDispose( + (ref) async => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart index 30db56933..2c9087281 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart @@ -13,10 +13,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { - final provider = FutureProvider.family((ref, _) async => 0); + final provider = FutureProvider.family( + (ref, _) async => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(await container.read(provider(0).future), 0); expect(container.read(provider(0)), const AsyncData(0)); @@ -28,7 +33,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = FutureProvider.family( (ref, i) => ref.watch(dep) + i, dependencies: [dep], @@ -46,7 +54,10 @@ void main() { }); test('when using provider.overrideWith', () async { - final provider = FutureProvider.family((ref, _) async => 0); + final provider = FutureProvider.family( + (ref, _) async => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart index d4321dda3..543d2465a 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart @@ -318,7 +318,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = FutureProvider( (ref) => ref.watch(dep), dependencies: [dep], @@ -434,10 +437,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { - final provider = FutureProvider((ref) async => 0); + final provider = FutureProvider( + (ref) async => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); @@ -466,7 +474,10 @@ void main() { // }); test('when using provider.overrideWith', () async { - final provider = FutureProvider((ref) async => 0); + final provider = FutureProvider( + (ref) async => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, diff --git a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart index 749929b78..dfb118eed 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart @@ -15,10 +15,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () { - final provider = Provider.autoDispose.family((ref, _) => 0); + final provider = Provider.autoDispose.family( + (ref, _) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(container.read(provider(0)), 0); expect(container.getAllProviderElements(), [ @@ -30,7 +35,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = Provider.family.autoDispose( (ref, i) => ref.watch(dep) + i, dependencies: [dep], diff --git a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart index 6d5a877b6..66c37306f 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart @@ -117,10 +117,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () { - final provider = Provider.autoDispose((ref) => 0); + final provider = Provider.autoDispose( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(container.read(provider), 0); expect(container.getAllProviderElements(), [ @@ -131,7 +136,10 @@ void main() { }); test('when using provider.overrideWithValue', () { - final provider = Provider.autoDispose((ref) => 0); + final provider = Provider.autoDispose( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, @@ -149,7 +157,10 @@ void main() { }); test('when using provider.overrideWith', () { - final provider = Provider.autoDispose((ref) => 0); + final provider = Provider.autoDispose( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, @@ -168,7 +179,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = Provider.autoDispose( (ref) => ref.watch(dep), dependencies: [dep], diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart index f5d42137b..b7e5d3b6f 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart @@ -14,10 +14,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () { - final provider = Provider.family((ref, _) => 0); + final provider = Provider.family( + (ref, _) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(container.read(provider(0)), 0); expect(container.getAllProviderElements(), [ @@ -28,7 +33,10 @@ void main() { }); test('when using provider.overrideWith', () { - final provider = Provider.family((ref, _) => 0); + final provider = Provider.family( + (ref, _) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, @@ -45,7 +53,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = Provider.family( (ref, i) => ref.watch(dep) + i, dependencies: [dep], diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart index 72a6f98ba..2979acdc8 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart @@ -171,10 +171,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () { - final provider = Provider((ref) => 0); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(container.read(provider), 0); expect(container.getAllProviderElements(), [ @@ -185,7 +190,10 @@ void main() { }); test('when using provider.overrideWithValue', () { - final provider = Provider((ref) => 0); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, @@ -201,7 +209,10 @@ void main() { }); test('when using provider.overrideWith', () { - final provider = Provider((ref) => 0); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, @@ -314,7 +325,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = Provider( (ref) => ref.watch(dep), dependencies: [dep], diff --git a/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart index 687ad623b..d8f44fac8 100644 --- a/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart @@ -19,7 +19,10 @@ void main() { group('scoping mechanism', () { test('use the deepest override', () { - final provider = Provider((ref) => 0); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test( overrides: [provider.overrideWithValue(1)], ); @@ -43,7 +46,10 @@ void main() { }); test('can read both parent and child simultaneously', () async { - final provider = Provider((ref) => 0); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test( overrides: [provider.overrideWithValue(21)], ); @@ -79,7 +85,10 @@ void main() { }); test('are disposed on nested containers', () { - final provider = Provider((ref) => 0); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test( overrides: [provider.overrideWithValue(1)], ); @@ -100,7 +109,10 @@ void main() { }); test('can be overridden on non-root container', () { - final provider = Provider((ref) => 0); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, @@ -112,10 +124,14 @@ void main() { test('can listen to other scoped providers', () async { final listener = Listener(); - final provider = Provider((ref) => 0); - final provider2 = Provider((ref) { - return ref.watch(provider) * 2; - }); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); + final provider2 = Provider( + (ref) => ref.watch(provider) * 2, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, @@ -142,12 +158,15 @@ void main() { test('can listen to other normal providers', () async { final listener = Listener(); final provider = StateProvider((ref) => 1); - final provider2 = Provider((ref) { - return ref.watch(provider) * 2; - }); + final provider2 = Provider( + (ref) => ref.watch(provider) * 2, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider2]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider2], + ); container.listen(provider2, listener.call, fireImmediately: true); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart index 756b74bea..a9aba632b 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart @@ -16,11 +16,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { - final provider = StreamProvider.autoDispose - .family((ref, _) => Stream.value(0)); + final provider = StreamProvider.autoDispose.family( + (ref, _) => Stream.value(0), + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(await container.read(provider(0).future), 0); expect(container.read(provider(0)), const AsyncData(0)); @@ -81,7 +85,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = StreamProvider.autoDispose.family( (ref, i) => Stream.value(ref.watch(dep) + i), dependencies: [dep], diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart index 184455a75..fc6bb3e59 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart @@ -48,7 +48,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = StreamProvider.autoDispose( (ref) => Stream.value(ref.watch(dep)), dependencies: [dep], @@ -182,10 +185,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { - final provider = StreamProvider.autoDispose((ref) => Stream.value(0)); + final provider = StreamProvider.autoDispose( + (ref) => Stream.value(0), + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); @@ -224,7 +232,10 @@ void main() { // }); test('when using provider.overrideWith', () async { - final provider = StreamProvider.autoDispose((ref) => Stream.value(0)); + final provider = StreamProvider.autoDispose( + (ref) => Stream.value(0), + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart index 9800c739c..b3e41a02e 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart @@ -15,11 +15,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { - final provider = - StreamProvider.family((ref, _) => Stream.value(0)); + final provider = StreamProvider.family( + (ref, _) => Stream.value(0), + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(await container.read(provider(0).future), 0); expect(container.read(provider(0)), const AsyncData(0)); @@ -34,8 +38,10 @@ void main() { }); test('when using provider.overrideWith', () async { - final provider = - StreamProvider.family((ref, _) => Stream.value(0)); + final provider = StreamProvider.family( + (ref, _) => Stream.value(0), + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, @@ -58,7 +64,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = StreamProvider.family( (ref, i) => Stream.value(ref.watch(dep) + i), dependencies: [dep], diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart index 9042f7670..2894fbb80 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart @@ -217,7 +217,10 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = StreamProvider( (ref) => Stream.value(ref.watch(dep)), dependencies: [dep], @@ -299,10 +302,15 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { - final provider = StreamProvider((ref) => Stream.value(0)); + final provider = StreamProvider( + (ref) => Stream.value(0), + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); @@ -341,7 +349,10 @@ void main() { // }); test('when using provider.overrideWith', () async { - final provider = StreamProvider((ref) => Stream.value(0)); + final provider = StreamProvider( + (ref) => Stream.value(0), + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, From 3ec48acd52aa6437cd1b30546ac6ae19b964ca5e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 25 Dec 2023 02:38:56 +0100 Subject: [PATCH 087/387] More --- .../lib/src/core/provider_container.dart | 52 +++---------------- .../new/core/provider_container_test.dart | 41 +++++++++++++++ ...o_dispose_family_future_provider_test.dart | 29 ++++++++--- 3 files changed, 71 insertions(+), 51 deletions(-) diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index c95966b82..fa0873d36 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -60,12 +60,14 @@ extension PointerT _upsert( ProviderT provider, { required ProviderContainer currentContainer, + required ProviderContainer? targetContainer, required PointerT Function(ProviderContainer) inherit, required PointerT Function({ProviderT? override}) scope, }) { final pointer = this[provider]; if (pointer != null) { + // TODO what about family(42) overrides on nested containers? if (provider.allTransitiveDependencies == null) { // The provider is not scoped, so can never be transitively overridden return pointer; @@ -83,14 +85,10 @@ extension } // Where the provider should be mounted - final target = - - /// If scoped, mount in the scope. - pointer?.targetContainer ?? - // If not scoped and in a child container, mount in the root - currentContainer._root ?? - // We are in the root, mount here directly - currentContainer; + final target = pointer?.targetContainer ?? + targetContainer ?? + currentContainer._root ?? + currentContainer; if (target == currentContainer) { return this[provider] = scope(); @@ -146,6 +144,7 @@ class ProviderDirectory implements _PointerBase { return pointers._upsert( provider, currentContainer: currentContainer, + targetContainer: targetContainer, inherit: (target) => target._pointerManager.upsertPointer(provider), scope: ({override}) => ProviderPointer( targetContainer: currentContainer, @@ -273,42 +272,6 @@ class ProviderPointerManager { final ProviderDirectory orphanPointers; final HashMap familyPointers; - // /// Creates a local pointer for a [Family], while preserving parent state. - // ProviderDirectory _scopeProviderDirectory( - // Family? family, { - // FamilyOverride? override, - // }) { - // final pointer = family == null ? orphanPointers : familyPointers[family]; - - // ProviderDirectory? newDirectory; - // if (pointer != null) { - // // The family is already overridden in this container. No need to fork. - // // This is purely an optimization. - // if (pointer.targetContainer == container) return pointer; - - // if (override == null) { - // // Fork a parent pointer, to keep its state but allow local modifications. - // newDirectory = ProviderDirectory.from( - // pointer, - // ownerContainer: container, - // ); - // } - // } - - // newDirectory ??= ProviderDirectory.empty( - // container, - // familyOverride: override, - // ); - - // if (family == null) { - // orphanPointers = newDirectory; - // } else { - // familyPointers[family] = newDirectory; - // } - - // return newDirectory; - // } - void _initializeProviderOverride( ProviderOverride override, ) { @@ -407,6 +370,7 @@ class ProviderPointerManager { return familyPointers._upsert( family, currentContainer: container, + targetContainer: null, inherit: (target) => target._pointerManager._mountFamily(family), scope: ({override}) => ProviderDirectory.empty( container, diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index 6978f93aa..20300e26e 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -360,6 +360,45 @@ void main() { }); group('upsertPointer', () { + test('on scoped providers, has no impact on the ancestor container', () { + final provider = Provider((_) => 0, dependencies: const []); + final family = Provider.family( + (ref, id) => 0, + dependencies: const [], + ); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [provider, family], + ); + + container.pointerManager.upsertPointer(provider); + container.pointerManager.upsertPointer(family(42)); + + expect(root.pointerManager.familyPointers, isEmpty); + expect(root.pointerManager.orphanPointers.pointers, isEmpty); + + expect( + container.pointerManager.orphanPointers.pointers, + { + provider: isPointer( + targetContainer: container, + override: provider, + ), + }, + ); + expect( + container.pointerManager.familyPointers, + { + family: isProviderDirectory( + targetContainer: container, + override: family, + pointers: {family(42): isPointer(targetContainer: container)}, + ), + }, + ); + }); + test('handles auto-scoping', () { final dep = Provider( (_) => 0, @@ -944,6 +983,8 @@ void main() { }); }); + // TODO test that reading a provider with deps does not mount those deps if unused by the provider + group('pointers', () { test('has "container" pointing to "this"', () { final root = ProviderContainer.test(); diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart index ced002fbc..2c8fcdda4 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart @@ -1,6 +1,8 @@ import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; +import '../../../new/core/provider_container_test.dart'; import '../../utils.dart'; void main() { @@ -23,13 +25,26 @@ void main() { overrides: [provider], ); - expect(await container.read(provider(0).future), 0); - expect(container.read(provider(0)), const AsyncData(0)); - expect(container.getAllProviderElementsInOrder(), [ - isA>() - .having((e) => e.origin, 'origin', provider(0)), - ]); - expect(root.getAllProviderElementsInOrder(), isEmpty); + container.listen(provider(0), (_, __) {}); + + // expect(await container.read(provider(0).future), 0); + // expect(container.read(provider(0)), const AsyncData(0)); + + expect( + container.pointerManager.familyPointers[provider], + isProviderDirectory( + pointers: {provider(0): isPointer(element: isNotNull)}, + ), + ); + + expect( + root.pointerManager.orphanPointers.pointers, + isEmpty, + ); + expect( + root.pointerManager.familyPointers, + isEmpty, + ); }); test('can be auto-scoped', () async { From 0b37d68bd2f60de04c3fe2cb72c434fdde4e8a4d Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 25 Dec 2023 03:00:32 +0100 Subject: [PATCH 088/387] Everybody gets a dependency! --- .../test/old/framework/auto_dispose_test.dart | 43 ++++-- .../test/old/framework/family_test.dart | 11 +- .../framework/provider_container_test.dart | 52 +++++-- .../old/framework/provider_element_test.dart | 12 +- .../old/framework/provider_observer_test.dart | 7 +- .../test/old/framework/scope_test.dart | 146 ++++++++++++++---- .../test/old/framework/visit_states_test.dart | 33 ++-- .../test/old/legacy/framework_test.dart | 15 +- 8 files changed, 238 insertions(+), 81 deletions(-) diff --git a/packages/riverpod/test/old/framework/auto_dispose_test.dart b/packages/riverpod/test/old/framework/auto_dispose_test.dart index 0e450deb3..be99a9bda 100644 --- a/packages/riverpod/test/old/framework/auto_dispose_test.dart +++ b/packages/riverpod/test/old/framework/auto_dispose_test.dart @@ -12,10 +12,15 @@ Future main() async { 'Handles cases where the ProviderContainer is disposed yet Scheduler.performDispose is invoked anyway', () async { // regression test for https://github.com/rrousselGit/riverpod/issues/1400 - final provider = Provider.autoDispose((ref) => 0); + final provider = Provider.autoDispose( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); container.read(provider); container.dispose(); @@ -376,11 +381,16 @@ final alwaysAlive = Provider((ref) { test('scoped autoDispose override preserve the override after one disposal', () async { - final provider = Provider.autoDispose((ref) => 0); + final provider = Provider.autoDispose( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); container.read(provider); expect(root.getAllProviderElements(), isEmpty); @@ -400,7 +410,10 @@ final alwaysAlive = Provider((ref) { test( 'scoped autoDispose override through intermediary unused container preserve the override after one disposal', () async { - final provider = Provider.autoDispose((ref) => 0); + final provider = Provider.autoDispose( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final mid = ProviderContainer.test(parent: root, overrides: [provider]); @@ -427,11 +440,16 @@ final alwaysAlive = Provider((ref) { test( 'scoped autoDispose override preserve family override after one disposal', () async { - final provider = Provider.autoDispose.family((ref, _) => 0); + final provider = Provider.autoDispose.family( + (ref, _) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); container.read(provider(0)); expect(root.getAllProviderElements(), isEmpty); @@ -451,7 +469,10 @@ final alwaysAlive = Provider((ref) { test( 'scoped autoDispose override through intermediary unused container preserve family override after one disposal', () async { - final provider = Provider.autoDispose.family((ref, _) => 0); + final provider = Provider.autoDispose.family( + (ref, _) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final mid = ProviderContainer.test(parent: root, overrides: [provider]); diff --git a/packages/riverpod/test/old/framework/family_test.dart b/packages/riverpod/test/old/framework/family_test.dart index d0b6b8cd8..8d5a76f29 100644 --- a/packages/riverpod/test/old/framework/family_test.dart +++ b/packages/riverpod/test/old/framework/family_test.dart @@ -33,10 +33,13 @@ void main() { 'does not re-initialize a scoped family if read by a child container after the provider was initialized', () { var buildCount = 0; - final provider = Provider.family((ref, param) { - buildCount++; - return 42; - }); + final provider = Provider.family( + (ref, param) { + buildCount++; + return 42; + }, + dependencies: const [], + ); final root = ProviderContainer.test(); final scope = ProviderContainer.test(parent: root, overrides: [provider]); diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 31f32d899..ee3bc5e4d 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -146,7 +146,10 @@ void main() { group('validate that properties respect `dependencies`', () { test('on reading an element, asserts that dependencies are respected', () { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = Provider((ref) => ref.watch(dep)); final root = ProviderContainer.test(); @@ -164,7 +167,10 @@ void main() { test( 'on reading an element, asserts that transitive dependencies are also respected', () { - final transitiveDep = Provider((ref) => 0); + final transitiveDep = Provider( + (ref) => 0, + dependencies: const [], + ); final dep = Provider((ref) => ref.watch(transitiveDep)); final provider = Provider((ref) => ref.watch(dep)); @@ -219,7 +225,10 @@ void main() { group('getAllProviderElements', () { test('list scoped providers that depends on nothing', () { - final scopedProvider = Provider((ref) => 0); + final scopedProvider = Provider( + (ref) => 0, + dependencies: const [], + ); final parent = ProviderContainer.test(); final child = ProviderContainer.test( parent: parent, @@ -239,7 +248,10 @@ void main() { 'list scoped providers that depends on providers from another container', () { final dependency = Provider((ref) => 0); - final scopedProvider = Provider((ref) => ref.watch(dependency)); + final scopedProvider = Provider( + (ref) => ref.watch(dependency), + dependencies: const [], + ); final parent = ProviderContainer.test(); final child = ProviderContainer.test( parent: parent, @@ -259,13 +271,23 @@ void main() { 'list only elements associated with the container (ignoring inherited and descendent elements)', () { final provider = Provider((ref) => 0); - final provider2 = Provider((ref) => 0); - final provider3 = Provider((ref) => 0); + final provider2 = Provider( + (ref) => 0, + dependencies: const [], + ); + final provider3 = Provider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); - final mid = - ProviderContainer.test(parent: root, overrides: [provider2]); - final leaf = - ProviderContainer.test(parent: mid, overrides: [provider3]); + final mid = ProviderContainer.test( + parent: root, + overrides: [provider2], + ); + final leaf = ProviderContainer.test( + parent: mid, + overrides: [provider3], + ); leaf.read(provider); leaf.read(provider2); @@ -326,7 +348,10 @@ void main() { group('getAllProviderElementsInOrder', () { test('list scoped providers that depends on nothing', () { - final scopedProvider = Provider((ref) => 0); + final scopedProvider = Provider( + (ref) => 0, + dependencies: const [], + ); final parent = ProviderContainer.test(); final child = ProviderContainer.test( parent: parent, @@ -346,7 +371,10 @@ void main() { 'list scoped providers that depends on providers from another container', () { final dependency = Provider((ref) => 0); - final scopedProvider = Provider((ref) => ref.watch(dependency)); + final scopedProvider = Provider( + (ref) => ref.watch(dependency), + dependencies: const [], + ); final parent = ProviderContainer.test(); final child = ProviderContainer.test( parent: parent, diff --git a/packages/riverpod/test/old/framework/provider_element_test.dart b/packages/riverpod/test/old/framework/provider_element_test.dart index c361f102c..33fc71945 100644 --- a/packages/riverpod/test/old/framework/provider_element_test.dart +++ b/packages/riverpod/test/old/framework/provider_element_test.dart @@ -258,11 +258,15 @@ void main() { test('clears only on the closest family override', () async { late Ref ref; - final another = Provider((r) { - ref = r; - }); + final another = Provider( + (r) => ref = r, + dependencies: const [], + ); var result = 0; - final provider = Provider.family((r, i) => result); + final provider = Provider.family( + (r, i) => result, + dependencies: const [], + ); final listener = Listener(); final listener2 = Listener(); final root = ProviderContainer.test(); diff --git a/packages/riverpod/test/old/framework/provider_observer_test.dart b/packages/riverpod/test/old/framework/provider_observer_test.dart index b0da872e6..0d2d87b6a 100644 --- a/packages/riverpod/test/old/framework/provider_observer_test.dart +++ b/packages/riverpod/test/old/framework/provider_observer_test.dart @@ -75,6 +75,7 @@ void main() { () { final provider = StateNotifierProvider, int>( (ref) => StateController(0), + dependencies: const [], ); final observer = ObserverMock('a'); final observer2 = ObserverMock('b'); @@ -286,6 +287,7 @@ void main() { final dep = StateProvider((ref) => 0); final provider = StateNotifierProvider, int>( (ref) => StateController(0), + dependencies: const [], ); final observer = ObserverMock('a'); final observer2 = ObserverMock('b'); @@ -503,7 +505,10 @@ void main() { test( 'on scoped ProviderContainer, applies both child and ancestors observers', () { - final provider = Provider((ref) => 0); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); final observer = ObserverMock(); final observer2 = ObserverMock(); final observer3 = ObserverMock(); diff --git a/packages/riverpod/test/old/framework/scope_test.dart b/packages/riverpod/test/old/framework/scope_test.dart index 7d51b73a3..c5e6ab0f5 100644 --- a/packages/riverpod/test/old/framework/scope_test.dart +++ b/packages/riverpod/test/old/framework/scope_test.dart @@ -23,7 +23,10 @@ Future main() async { 'reading a provider from a scoped container, ' 'then adding a new container with an override, ' 'then reading from the new container correctly auto-scope again', () { - final a = Provider((ref) => 0); + final a = Provider( + (ref) => 0, + dependencies: const [], + ); final b = Provider((ref) => ref.watch(a) + 10, dependencies: [a]); final root = ProviderContainer.test(); @@ -46,7 +49,10 @@ Future main() async { 'reading a provider from a scoped container, ' 'then reading from container further down the tree correctly auto-scope again', () { - final a = Provider((ref) => 0); + final a = Provider( + (ref) => 0, + dependencies: const [], + ); final b = Provider((ref) => ref.watch(a) + 10, dependencies: [a]); final root = ProviderContainer.test(); @@ -68,7 +74,10 @@ Future main() async { 'then adding a new container with the same family overridden again, ' 'then reading from the new container correctly obtains the new override', () { - final a = Provider.family((ref, id) => id); + final a = Provider.family( + (ref, id) => id, + dependencies: const [], + ); final root = ProviderContainer.test(); final mid = ProviderContainer.test( @@ -94,7 +103,10 @@ Future main() async { 'reading a family override from a scoped container, ' 'then reading from container further down the tree correctly uses the deepest override', () { - final a = Provider.family((ref, id) => id); + final a = Provider.family( + (ref, id) => id, + dependencies: const [], + ); final root = ProviderContainer.test(); final mid = ProviderContainer.test( @@ -119,7 +131,10 @@ Future main() async { 'reading a family override from a scoped container, ' 'then reading from container further down the tree reuse the provider state when possible', () { - final a = Provider.family((ref, id) => id); + final a = Provider.family( + (ref, id) => id, + dependencies: const [], + ); var overrideBuildCount = 0; final root = ProviderContainer.test(); final mid = ProviderContainer.test( @@ -159,7 +174,10 @@ Future main() async { }); test('use latest override on mount', () { - final provider = Provider((ref) => 0); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, @@ -174,7 +192,10 @@ Future main() async { }); test('updating scoped override does not mount the provider', () { - final provider = Provider((ref) => 0); + final provider = Provider( + (ref) => 0, + dependencies: const [], + ); final root = ProviderContainer.test(); final container = ProviderContainer.test( parent: root, @@ -193,10 +214,13 @@ Future main() async { 'does not re-initialize a provider if read by an intermediary container', () { var callCount = 0; - final provider = Provider((ref) { - callCount++; - return 42; - }); + final provider = Provider( + (ref) { + callCount++; + return 42; + }, + dependencies: const [], + ); final root = ProviderContainer.test(); final mid = ProviderContainer.test(parent: root, overrides: [provider]); final container = ProviderContainer.test(parent: mid); @@ -213,9 +237,13 @@ Future main() async { group('Scoping family', () { test('use latest override on mount', () { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = Provider.family( (ref, value) => '$value ${ref.watch(dep)}', + dependencies: const [], ); final root = ProviderContainer.test(); final container = ProviderContainer.test( @@ -235,9 +263,13 @@ Future main() async { }); test('updating scoped override does not mount the provider', () { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = Provider.family( (ref, value) => '$value ${ref.watch(dep)}', + dependencies: const [], ); final root = ProviderContainer.test(); final container = ProviderContainer.test( @@ -274,12 +306,18 @@ Future main() async { test( 'does not re-initialize a provider if read by an intermediary container', () { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); var callCount = 0; - final provider = Provider.family((ref, value) { - callCount++; - return '$value ${ref.watch(dep)}'; - }); + final provider = Provider.family( + (ref, value) { + callCount++; + return '$value ${ref.watch(dep)}'; + }, + dependencies: const [], + ); final root = ProviderContainer.test(); final mid = ProviderContainer.test( parent: root, @@ -317,7 +355,11 @@ Future main() async { }); test('auto scope direct provider dependencies', () { - final dep = Provider((ref) => 0, name: 'dep'); + final dep = Provider( + (ref) => 0, + name: 'dep', + dependencies: const [], + ); var buildCount = 0; final provider = Provider( name: 'provider', @@ -354,7 +396,11 @@ Future main() async { test( 'auto scope still works if the first read of the auto-override is through a child container', () { - final dep = Provider((ref) => 0, name: 'dep'); + final dep = Provider( + (ref) => 0, + name: 'dep', + dependencies: const [], + ); var buildCount = 0; final provider = Provider( dependencies: [dep], @@ -390,6 +436,7 @@ Future main() async { depBuildCount++; return 0; }, + dependencies: const [], ); var dep2BuildCount = 0; final dep2 = Provider.family( @@ -476,8 +523,16 @@ Future main() async { test( 'when provider depends on multiple overrides, is placed on the deepest container', () { - final dep = Provider((ref) => 0, name: 'dep'); - final dep2 = Provider((ref) => 0, name: 'dep2'); + final dep = Provider( + (ref) => 0, + name: 'dep', + dependencies: const [], + ); + final dep2 = Provider( + (ref) => 0, + name: 'dep2', + dependencies: const [], + ); final a = Provider( (ref) => ref.watch(dep) + ref.watch(dep2), dependencies: [dep, dep2], @@ -526,8 +581,16 @@ Future main() async { test('skips containers with overrides that do not match the "dependencies"', () { - final dep = Provider((ref) => 0, name: 'dep'); - final dep2 = Provider((ref) => 0, name: 'dep2'); + final dep = Provider( + (ref) => 0, + name: 'dep', + dependencies: const [], + ); + final dep2 = Provider( + (ref) => 0, + name: 'dep2', + dependencies: const [], + ); final a = Provider( (ref) => ref.watch(dep), dependencies: [dep], @@ -564,7 +627,10 @@ Future main() async { 'when a provider with dependencies is overridden with a value, ' 'it is no longer automatically overridden if a lower container overrides a dependency', () { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = Provider((ref) => ref.watch(dep), dependencies: [dep]); final root = ProviderContainer.test(); final mid = ProviderContainer.test( @@ -590,7 +656,10 @@ Future main() async { }); test('auto scope direct family dependencies', () { - final family = Provider.family((ref, id) => id * 2); + final family = Provider.family( + (ref, id) => id * 2, + dependencies: const [], + ); final provider = Provider( (ref) => ref.watch(family(21)), dependencies: [family], @@ -649,7 +718,10 @@ Future main() async { }); test('can auto-scope autoDispose providers', () async { - final dep = Provider((ref) => 0); + final dep = Provider( + (ref) => 0, + dependencies: const [], + ); final provider = Provider.autoDispose( (ref) => ref.watch(dep), dependencies: [dep], @@ -773,8 +845,14 @@ final b = Provider( }); test('does not auto-scope provider overrides', () { - final a = Provider((ref) => 0); - final another = Provider((ref) => 42); + final a = Provider( + (ref) => 0, + dependencies: const [], + ); + final another = Provider( + (ref) => 42, + dependencies: const [], + ); final b = Provider((ref) => ref.watch(a), dependencies: [a]); final c = Provider((ref) => ref.watch(a), dependencies: [a]); @@ -798,8 +876,14 @@ final b = Provider( }); test('does not auto-scope family overrides', () { - final a = Provider((ref) => 0); - final another = Provider((ref) => 42); + final a = Provider( + (ref) => 0, + dependencies: const [], + ); + final another = Provider( + (ref) => 42, + dependencies: const [], + ); final b = Provider.family( (ref, _) => ref.watch(a), dependencies: [a], diff --git a/packages/riverpod/test/old/framework/visit_states_test.dart b/packages/riverpod/test/old/framework/visit_states_test.dart index 909742a08..1fd8f8c99 100644 --- a/packages/riverpod/test/old/framework/visit_states_test.dart +++ b/packages/riverpod/test/old/framework/visit_states_test.dart @@ -76,10 +76,13 @@ void main() { test('linear across two containers', () { final a = Provider((ref) => A()); - final b = Provider((ref) { - ref.watch(a); - return B(); - }); + final b = Provider( + (ref) { + ref.watch(a); + return B(); + }, + dependencies: const [], + ); final parent = ProviderContainer.test(); final container = ProviderContainer.test(parent: parent, overrides: [b]); @@ -95,15 +98,19 @@ void main() { test('branching across two containers', () { final a = Provider((ref) => A()); - final b = Provider((ref) { - return B(); - }); - - final c = Provider((ref) { - ref.watch(a); - ref.watch(b); - return C(); - }); + final b = Provider( + (ref) => B(), + dependencies: const [], + ); + + final c = Provider( + (ref) { + ref.watch(a); + ref.watch(b); + return C(); + }, + dependencies: [b], + ); final parent = ProviderContainer.test(); diff --git a/packages/riverpod/test/old/legacy/framework_test.dart b/packages/riverpod/test/old/legacy/framework_test.dart index ba5281df3..22a457429 100644 --- a/packages/riverpod/test/old/legacy/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework_test.dart @@ -31,12 +31,17 @@ void main() { final family = Provider.family((ref, value) { return '$value'; }); - final family2 = Provider.family((ref, value) { - return '$value 2'; - }); + final family2 = Provider.family( + (ref, value) { + return '$value 2'; + }, + dependencies: const [], + ); final root = ProviderContainer.test(); - final container = - ProviderContainer.test(parent: root, overrides: [family2]); + final container = ProviderContainer.test( + parent: root, + overrides: [family2], + ); expect(container.read(family(0)), '0'); expect(container.read(family2(0)), '0 2'); From 8c86c0ecde1a495be6f45cdc78299c07dc4e5330 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 25 Dec 2023 03:03:47 +0100 Subject: [PATCH 089/387] Apply fix --- packages/riverpod/test/new/core/auto_dispose_test.dart | 2 +- packages/riverpod/test/new/core/provider_container_test.dart | 2 +- packages/riverpod/test/old/framework/scope_test.dart | 1 - packages/riverpod/test/old/framework/visit_states_test.dart | 1 - .../state_provider/state_provider_family_auto_dispose_test.dart | 1 - .../deprecated/state_provider/state_provider_family_test.dart | 1 - .../future_provider/family_future_provider_test.dart | 1 - .../old/legacy_providers/provider/provider_family_test.dart | 1 - .../stream_provider/stream_provider_family_test.dart | 1 - 9 files changed, 2 insertions(+), 9 deletions(-) diff --git a/packages/riverpod/test/new/core/auto_dispose_test.dart b/packages/riverpod/test/new/core/auto_dispose_test.dart index 43a8b4661..5e1d973b6 100644 --- a/packages/riverpod/test/new/core/auto_dispose_test.dart +++ b/packages/riverpod/test/new/core/auto_dispose_test.dart @@ -53,7 +53,7 @@ void main() { provider.overrideWith((ref) { ref.keepAlive(); return 42; - }) + }), ], ); diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index 20300e26e..30fded4a5 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -751,7 +751,7 @@ void main() { dep: isPointer(override: dep), provider: isPointer( override: isTransitiveProviderOverride(provider), - ) + ), }, ); diff --git a/packages/riverpod/test/old/framework/scope_test.dart b/packages/riverpod/test/old/framework/scope_test.dart index c5e6ab0f5..017c57cb7 100644 --- a/packages/riverpod/test/old/framework/scope_test.dart +++ b/packages/riverpod/test/old/framework/scope_test.dart @@ -4,7 +4,6 @@ import 'package:expect_error/expect_error.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../utils.dart'; Future main() async { final library = await Library.parseFromStacktrace(); diff --git a/packages/riverpod/test/old/framework/visit_states_test.dart b/packages/riverpod/test/old/framework/visit_states_test.dart index 1fd8f8c99..e541418ae 100644 --- a/packages/riverpod/test/old/framework/visit_states_test.dart +++ b/packages/riverpod/test/old/framework/visit_states_test.dart @@ -6,7 +6,6 @@ import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; import 'package:trotter/trotter.dart'; -import '../utils.dart'; void main() { // A diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart index 9f0fbc2a4..2620e7195 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart @@ -1,7 +1,6 @@ import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../../../utils.dart'; void main() { test('supports .name', () { diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart index b70fc574c..ba417e83b 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart @@ -1,7 +1,6 @@ import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../../../utils.dart'; void main() { test('supports .name', () { diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart index 2c9087281..9400b76af 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart @@ -1,7 +1,6 @@ import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../../utils.dart'; void main() { test('specifies `from` & `argument` for related providers', () { diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart index b7e5d3b6f..a7dda4431 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart @@ -1,7 +1,6 @@ import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../../utils.dart'; void main() { group('Provider.family', () { diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart index b3e41a02e..5e3431553 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart @@ -1,7 +1,6 @@ import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../../utils.dart'; void main() { group('StreamProvider.family', () { From ade40f520ba4cefc060f481629fdcb301c4fa433 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 25 Dec 2023 03:09:25 +0100 Subject: [PATCH 090/387] Remove "all contains are disposed" check --- .../lib/src/core/provider_container.dart | 24 +------------------ .../new/core/provider_container_test.dart | 21 ---------------- 2 files changed, 1 insertion(+), 44 deletions(-) diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index fa0873d36..02112750b 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -512,28 +512,6 @@ class ProviderPointerManager { var _debugVerifyDependenciesAreRespectedEnabled = true; -int _tearDownCount = 0; - -/// A callback that disposes a [ProviderContainer] inside tests -@internal -void Function() providerContainerTestTeardown(ProviderContainer container) { - _tearDownCount++; - - return () { - container.dispose(); - - if (kDebugMode && _tearDownCount == 1) { - test.expect( - DebugRiverpodDevtoolBiding.containers, - test.isEmpty, - reason: 'All ProviderContainers must be disposed at the end of tests.', - ); - } - - _tearDownCount--; - }; -} - /// {@template riverpod.provider_container} /// An object that stores the state of the providers and allows overriding the /// behavior of a specific provider. @@ -636,7 +614,7 @@ class ProviderContainer implements Node { overrides: overrides, observers: observers, ); - test.addTearDown(providerContainerTestTeardown(container)); + test.addTearDown(container.dispose); return container; } diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index 30fded4a5..fd55f05ef 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -1381,27 +1381,6 @@ void main() { addTearDown(() => expect(container.disposed, false)); }); - test( - 'last addTearDown throws if there are some remaining undisposed containers', - () async { - final container = ProviderContainer(); - addTearDown(container.dispose); - final container2 = ProviderContainer(); - addTearDown(container.dispose); - - var cb = providerContainerTestTeardown(container); - - expect( - cb, - throwsA(isA()), - reason: 'container2 is not disposed', - ); - - cb = providerContainerTestTeardown(container2); - - expect(cb, returnsNormally); - }); - test('Passes parameters', () { final provider = Provider( (ref) => 0, From 79ce753789bd8366fc2dff8cc17b007e26554b54 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 25 Dec 2023 03:19:10 +0100 Subject: [PATCH 091/387] Handle didAddProvider --- packages/riverpod/lib/src/core/element.dart | 27 +++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index b7a1588a4..fa9ad35ba 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -256,6 +256,15 @@ abstract class ProviderElementBase implements Ref, Node { ); } } + + for (final observer in container.observers) { + runTernaryGuarded( + observer.didAddProvider, + origin, + newState.state, + container, + ); + } }, error: (newState) { final onErrorSelfListeners = _onErrorSelfListeners; @@ -268,6 +277,24 @@ abstract class ProviderElementBase implements Ref, Node { ); } } + + for (final observer in container.observers) { + runTernaryGuarded( + observer.didAddProvider, + origin, + null, + container, + ); + } + for (final observer in container.observers) { + runQuaternaryGuarded( + observer.providerDidFail, + origin, + newState.error, + newState.stackTrace, + container, + ); + } }, ); } From d9bb1104e72dc9888658b5c4202655c2b957069d Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 25 Dec 2023 03:42:39 +0100 Subject: [PATCH 092/387] Fix pointer leak --- .../lib/src/core/provider_container.dart | 31 ++++++----- .../test/new/core/auto_dispose_test.dart | 55 +++++++++++++++++++ .../framework/provider_container_test.dart | 54 ------------------ 3 files changed, 73 insertions(+), 67 deletions(-) diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 02112750b..a4ab979a5 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -664,6 +664,7 @@ class ProviderContainer implements Node { /// Awaits for providers to rebuild/be disposed and for listeners to be notified. Future pump() async { final a = scheduler.pendingFuture; + // TODO should be recursive final b = _parent?.scheduler.pendingFuture; await Future.wait([ @@ -782,26 +783,30 @@ class ProviderContainer implements Node { return read(refreshable); } - void _disposeProvider(ProviderBase provider) { - final pointer = _pointerManager.remove(provider); - - if (provider.allTransitiveDependencies != null) { - /// Recursively removes the pointer in all containers if the provider - /// can be scoped. - for (final child in _children) { - final childPointer = child._pointerManager.readPointer(provider); - - // The child container uses a different instance for this provider. - // We don't need to dispose it. - if (childPointer != null && childPointer != pointer) continue; + void _recursivePointerRemoval( + ProviderBase provider, + ProviderPointer pointer, + ) { + for (final child in _children) { + final childPointer = child._pointerManager.readPointer(provider); - child._disposeProvider(provider); + if (childPointer != null && childPointer != pointer) { + continue; } + + child._recursivePointerRemoval(provider, pointer); } + _pointerManager.remove(provider); + } + + void _disposeProvider(ProviderBase provider) { + final pointer = _pointerManager.remove(provider); // The provider is already disposed, so we don't need to do anything if (pointer == null) return; + _recursivePointerRemoval(provider, pointer); + pointer.element?.dispose(); pointer.element = null; } diff --git a/packages/riverpod/test/new/core/auto_dispose_test.dart b/packages/riverpod/test/new/core/auto_dispose_test.dart index 5e1d973b6..c45f956b7 100644 --- a/packages/riverpod/test/new/core/auto_dispose_test.dart +++ b/packages/riverpod/test/new/core/auto_dispose_test.dart @@ -74,6 +74,61 @@ void main() { }); group('on unused providers', () { + // TODO test calls dispose only once + + test( + 'cleans up the pointers of a provider in the entire ProviderContainer tree', + () async { + final unrelated = Provider((_) => 42, dependencies: const []); + // Regression test for https://github.com/rrousselGit/riverpod/issues/1943 + final a = ProviderContainer.test(); + // b/c voluntarily do not use the Provider, but a/d do. This is to test + // that the disposal logic correctly cleans up the StateReaders + // in all ProviderContainers associated with the provider, even if + // some links between two ProviderContainers are not using the provider. + final b = ProviderContainer.test(parent: a, overrides: [unrelated]); + final c = ProviderContainer.test(parent: b, overrides: [unrelated]); + final d = ProviderContainer.test(parent: c, overrides: [unrelated]); + + final provider = Provider.autoDispose((ref) => 3); + + final subscription = d.listen( + provider, + (previous, next) {}, + fireImmediately: true, + ); + + expect(a.pointerManager.readPointer(provider), isNotNull); + expect(b.pointerManager.readPointer(provider), isNull); + expect(c.pointerManager.readPointer(provider), isNull); + expect(d.pointerManager.readPointer(provider), isNotNull); + + subscription.close(); + + expect(a.pointerManager.readPointer(provider), isNotNull); + expect(b.pointerManager.readPointer(provider), isNull); + expect(c.pointerManager.readPointer(provider), isNull); + expect(d.pointerManager.readPointer(provider), isNotNull); + + await a.pump(); + + expect(a.pointerManager.readPointer(provider), isNull); + expect(b.pointerManager.readPointer(provider), isNull); + expect(c.pointerManager.readPointer(provider), isNull); + expect(d.pointerManager.readPointer(provider), isNull); + + d.listen( + provider, + (previous, next) {}, + fireImmediately: true, + ); + + expect(a.pointerManager.readPointer(provider), isNotNull); + expect(b.pointerManager.readPointer(provider), isNull); + expect(c.pointerManager.readPointer(provider), isNull); + expect(d.pointerManager.readPointer(provider), isNotNull); + }); + test( 'if a dependency changed, the element is still disposed, ' 'but without calling ref.onDispose again', () async { diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index ee3bc5e4d..f926bd99e 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -6,60 +6,6 @@ import '../utils.dart'; void main() { group('ProviderContainer', () { - group('when unmounting providers', () { - test( - 'cleans up all the StateReaders of a provider in the entire ProviderContainer tree', - () async { - // Regression test for https://github.com/rrousselGit/riverpod/issues/1943 - final a = ProviderContainer.test(); - // b/c voluntarily do not use the Provider, but a/d do. This is to test - // that the disposal logic correctly cleans up the StateReaders - // in all ProviderContainers associated with the provider, even if - // some links between two ProviderContainers are not using the provider. - final b = ProviderContainer.test(parent: a); - final c = ProviderContainer.test(parent: b); - final d = ProviderContainer.test(parent: c); - - final provider = Provider.autoDispose((ref) => 3); - - final subscription = d.listen( - provider, - (previous, next) {}, - fireImmediately: true, - ); - - expect(a.pointerManager.isLocallyMounted(provider), true); - expect(b.pointerManager.isLocallyMounted(provider), false); - expect(c.pointerManager.isLocallyMounted(provider), false); - expect(d.pointerManager.isLocallyMounted(provider), true); - - subscription.close(); - - expect(a.pointerManager.isLocallyMounted(provider), true); - expect(b.pointerManager.isLocallyMounted(provider), false); - expect(c.pointerManager.isLocallyMounted(provider), false); - expect(d.pointerManager.isLocallyMounted(provider), true); - - await a.pump(); - - expect(a.pointerManager.isLocallyMounted(provider), false); - expect(b.pointerManager.isLocallyMounted(provider), false); - expect(c.pointerManager.isLocallyMounted(provider), false); - expect(d.pointerManager.isLocallyMounted(provider), false); - - d.listen( - provider, - (previous, next) {}, - fireImmediately: true, - ); - - expect(a.pointerManager.isLocallyMounted(provider), true); - expect(b.pointerManager.isLocallyMounted(provider), false); - expect(c.pointerManager.isLocallyMounted(provider), false); - expect(d.pointerManager.isLocallyMounted(provider), true); - }); - }); - group('debugReassemble', () { test( 'reload providers if the debugGetCreateSourceHash of a provider returns a different value', From efa900b42432997dbb095a0c305c0ffff4d302cf Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 27 Dec 2023 17:21:25 +0100 Subject: [PATCH 093/387] Fix --- .../docs/introduction/getting_started/dart_hello_world/main.dart | 1 - .../current/getting_started/dart_hello_world/main.dart | 1 - .../current/getting_started/dart_hello_world/main.dart | 1 - .../current/getting_started/dart_hello_world/main.dart | 1 - .../current/getting_started/dart_hello_world/main.dart | 1 - 5 files changed, 5 deletions(-) diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.dart b/website/docs/introduction/getting_started/dart_hello_world/main.dart index cb53853fb..ae7a30285 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.dart @@ -2,7 +2,6 @@ /* SNIPPET START */ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart index cb53853fb..ae7a30285 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart @@ -2,7 +2,6 @@ /* SNIPPET START */ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart index cb53853fb..ae7a30285 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart @@ -2,7 +2,6 @@ /* SNIPPET START */ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart index cb53853fb..ae7a30285 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart @@ -2,7 +2,6 @@ /* SNIPPET START */ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart index 2b5fc5131..34bb333db 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart @@ -2,7 +2,6 @@ /* SNIPPET START */ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; From 88d18c543fd67078d7c0f413a2271e01bb4e3bf3 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 27 Dec 2023 17:21:32 +0100 Subject: [PATCH 094/387] Remove expect_error --- packages/riverpod/pubspec.yaml | 1 - .../test/old/framework/auto_dispose_test.dart | 89 ------------------- .../test/old/framework/scope_test.dart | 27 ------ 3 files changed, 117 deletions(-) diff --git a/packages/riverpod/pubspec.yaml b/packages/riverpod/pubspec.yaml index 62892dcfc..634960889 100644 --- a/packages/riverpod/pubspec.yaml +++ b/packages/riverpod/pubspec.yaml @@ -21,6 +21,5 @@ dependencies: dev_dependencies: analyzer: ">=5.12.0 <7.0.0" - expect_error: ^1.0.0 mockito: ^5.0.0 trotter: ^2.0.0-dev.1 diff --git a/packages/riverpod/test/old/framework/auto_dispose_test.dart b/packages/riverpod/test/old/framework/auto_dispose_test.dart index be99a9bda..067f49d4a 100644 --- a/packages/riverpod/test/old/framework/auto_dispose_test.dart +++ b/packages/riverpod/test/old/framework/auto_dispose_test.dart @@ -1,4 +1,3 @@ -import 'package:expect_error/expect_error.dart'; import 'package:mockito/mockito.dart'; import 'package:riverpod/src/internals.dart'; import 'package:test/test.dart'; @@ -6,8 +5,6 @@ import 'package:test/test.dart'; import '../utils.dart'; Future main() async { - final library = await Library.parseFromStacktrace(); - test( 'Handles cases where the ProviderContainer is disposed yet Scheduler.performDispose is invoked anyway', () async { @@ -205,92 +202,6 @@ Future main() async { }); }); - group( - 'emits compilation error when passing an autoDispose provider to a non-autoDispose provider', - () { - test('to ref.watch', () { - expect( - library.withCode( - ''' -import 'package:riverpod/riverpod.dart'; - -final autoDispose = Provider.autoDispose((ref) => 0); - -final alwaysAlive = Provider((ref) { - // expect-error: ARGUMENT_TYPE_NOT_ASSIGNABLE - ref.watch(autoDispose); -}); -''', - ), - compiles, - ); - }); - - test('to ref.watch when using selectors', () { - expect( - library.withCode( - ''' -import 'package:riverpod/riverpod.dart'; - -final autoDispose = Provider.autoDispose((ref) => 0); - -final alwaysAlive = Provider((ref) { - ref.watch( - // expect-error: ARGUMENT_TYPE_NOT_ASSIGNABLE - autoDispose - .select((value) => value), - ); -}); -''', - ), - compiles, - ); - }); - - test('to ref.listen', () { - expect( - library.withCode( - ''' -import 'package:riverpod/riverpod.dart'; - -final autoDispose = Provider.autoDispose((ref) => 0); - -final alwaysAlive = Provider((ref) { - ref.listen( - // expect-error: ARGUMENT_TYPE_NOT_ASSIGNABLE - autoDispose, - (prev, value) {}, - ); -}); -''', - ), - compiles, - ); - }); - - test('to ref.listen when using selectors', () { - expect( - library.withCode( - ''' -import 'package:riverpod/riverpod.dart'; - -final autoDispose = Provider.autoDispose((ref) => 0); - -final alwaysAlive = Provider((ref) { - ref.listen( - // expect-error: ARGUMENT_TYPE_NOT_ASSIGNABLE - autoDispose - .select((value) => value), - (prev, value) {}, - ); -}); -''', - ), - compiles, - ); - }); - }); - test( 'when a provider conditionally depends on another provider, rebuilding without the dependency can dispose the dependency', () async { diff --git a/packages/riverpod/test/old/framework/scope_test.dart b/packages/riverpod/test/old/framework/scope_test.dart index 017c57cb7..7bc004974 100644 --- a/packages/riverpod/test/old/framework/scope_test.dart +++ b/packages/riverpod/test/old/framework/scope_test.dart @@ -1,13 +1,9 @@ // Tests related to scoping providers -import 'package:expect_error/expect_error.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; - Future main() async { - final library = await Library.parseFromStacktrace(); - test( 'transitive dependencies includes the transitive dependencies of families', () { @@ -755,29 +751,6 @@ Future main() async { expect(root.getAllProviderElements(), isEmpty); }); - test('accepts only providers or families', () async { - expect( - library.withCode( - ''' -import 'package:riverpod/riverpod.dart'; - -final a = Provider((ref) => 0); - -final b = Provider( - (ref) => 0, - dependencies: [ - // expect-error: LIST_ELEMENT_TYPE_NOT_ASSIGNABLE - 42, - // expect-error: LIST_ELEMENT_TYPE_NOT_ASSIGNABLE - a.select((value) => 42), - ], -); -''', - ), - compiles, - ); - }); - test( 'does not throw if trying to watch a non-scoped provider that is not in the dependencies list', () { From e2819705d42f127b6667e49e7d18995ebc7f544f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 27 Dec 2023 17:25:50 +0100 Subject: [PATCH 095/387] Update freezed code --- .../marvel/lib/src/configuration.freezed.dart | 2 +- examples/marvel/lib/src/marvel.freezed.dart | 10 ++++---- examples/marvel/lib/src/result.freezed.dart | 4 ++-- .../marvel/lib/src/screens/home.freezed.dart | 4 ++-- examples/pub/lib/pub_repository.freezed.dart | 18 +++++++------- .../stackoverflow/lib/question.freezed.dart | 6 ++--- examples/stackoverflow/lib/tag.freezed.dart | 2 +- examples/stackoverflow/lib/user.freezed.dart | 4 ++-- .../riverpod/example/lib/models.freezed.dart | 8 +++---- .../lib/src/templates/family.dart | 8 +++---- .../test/integration/generated.freezed.dart | 2 +- .../notifier_extends/notifier_extends.g.dart | 24 +++++++++---------- .../lints/provider_parameters.freezed.dart | 2 +- .../cancel/detail_screen/codegen.freezed.dart | 2 +- .../activity/codegen.freezed.dart | 2 +- .../full_app/codegen.freezed.dart | 2 +- .../todo_list_provider/codegen.freezed.dart | 2 +- .../why_immutability/codegen.freezed.dart | 2 +- .../codegen/activity.freezed.dart | 2 +- .../codegen/todo_list_notifier.freezed.dart | 2 +- .../codegen/todo_list_provider.freezed.dart | 2 +- .../from_provider/helpers/item.freezed.dart | 2 +- .../remote_todos/codegen.freezed.dart | 2 +- .../todos/codegen.freezed.dart | 2 +- .../remote_todos/codegen.freezed.dart | 2 +- .../todos/codegen.freezed.dart | 2 +- .../remote_todos/codegen.freezed.dart | 2 +- .../todos/codegen.freezed.dart | 2 +- 28 files changed, 62 insertions(+), 62 deletions(-) diff --git a/examples/marvel/lib/src/configuration.freezed.dart b/examples/marvel/lib/src/configuration.freezed.dart index ea54df0fb..6ae5361b4 100644 --- a/examples/marvel/lib/src/configuration.freezed.dart +++ b/examples/marvel/lib/src/configuration.freezed.dart @@ -125,7 +125,7 @@ class _$ConfigurationImpl implements _Configuration { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ConfigurationImpl && diff --git a/examples/marvel/lib/src/marvel.freezed.dart b/examples/marvel/lib/src/marvel.freezed.dart index 698d3ff9e..236aca293 100644 --- a/examples/marvel/lib/src/marvel.freezed.dart +++ b/examples/marvel/lib/src/marvel.freezed.dart @@ -130,7 +130,7 @@ class _$MarvelListCharactersResponseImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$MarvelListCharactersResponseImpl && @@ -307,7 +307,7 @@ class _$CharacterImpl implements _Character { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$CharacterImpl && @@ -465,7 +465,7 @@ class _$ThumbnailImpl extends _Thumbnail { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ThumbnailImpl && @@ -621,7 +621,7 @@ class _$MarvelResponseImpl implements _MarvelResponse { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$MarvelResponseImpl && @@ -778,7 +778,7 @@ class _$MarvelDataImpl implements _MarvelData { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$MarvelDataImpl && diff --git a/examples/marvel/lib/src/result.freezed.dart b/examples/marvel/lib/src/result.freezed.dart index 1b853ca34..daaf92469 100644 --- a/examples/marvel/lib/src/result.freezed.dart +++ b/examples/marvel/lib/src/result.freezed.dart @@ -118,7 +118,7 @@ class _$ResultDataImpl extends _ResultData { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ResultDataImpl && @@ -257,7 +257,7 @@ class _$ResultErrorImpl extends _ResultError { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ResultErrorImpl && diff --git a/examples/marvel/lib/src/screens/home.freezed.dart b/examples/marvel/lib/src/screens/home.freezed.dart index b59d28598..a0f9e8ea9 100644 --- a/examples/marvel/lib/src/screens/home.freezed.dart +++ b/examples/marvel/lib/src/screens/home.freezed.dart @@ -116,7 +116,7 @@ class _$CharacterPaginationImpl implements _CharacterPagination { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$CharacterPaginationImpl && @@ -252,7 +252,7 @@ class _$CharacterOffsetImpl implements _CharacterOffset { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$CharacterOffsetImpl && diff --git a/examples/pub/lib/pub_repository.freezed.dart b/examples/pub/lib/pub_repository.freezed.dart index 526229bc9..c4cda8db7 100644 --- a/examples/pub/lib/pub_repository.freezed.dart +++ b/examples/pub/lib/pub_repository.freezed.dart @@ -198,7 +198,7 @@ class _$PackageMetricsScoreImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$PackageMetricsScoreImpl && @@ -385,7 +385,7 @@ class _$PackageMetricsResponseImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$PackageMetricsResponseImpl && @@ -547,7 +547,7 @@ class _$PackageDetailsImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$PackageDetailsImpl && @@ -721,7 +721,7 @@ class _$PackageImpl with DiagnosticableTreeMixin implements _Package { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$PackageImpl && @@ -883,7 +883,7 @@ class _$LikedPackageImpl with DiagnosticableTreeMixin implements _LikedPackage { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$LikedPackageImpl && @@ -1044,7 +1044,7 @@ class _$LikesPackagesResponseImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$LikesPackagesResponseImpl && @@ -1201,7 +1201,7 @@ class _$PubPackagesResponseImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$PubPackagesResponseImpl && @@ -1350,7 +1350,7 @@ class _$SearchPackageImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$SearchPackageImpl && @@ -1502,7 +1502,7 @@ class _$PubSearchResponseImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$PubSearchResponseImpl && diff --git a/examples/stackoverflow/lib/question.freezed.dart b/examples/stackoverflow/lib/question.freezed.dart index 16fca8a77..a9cdf80e0 100644 --- a/examples/stackoverflow/lib/question.freezed.dart +++ b/examples/stackoverflow/lib/question.freezed.dart @@ -132,7 +132,7 @@ class _$QuestionsResponseImpl implements _QuestionsResponse { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$QuestionsResponseImpl && @@ -476,7 +476,7 @@ class _$QuestionImpl implements _Question { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$QuestionImpl && @@ -683,7 +683,7 @@ class _$QuestionThemeImpl implements _QuestionTheme { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$QuestionThemeImpl && diff --git a/examples/stackoverflow/lib/tag.freezed.dart b/examples/stackoverflow/lib/tag.freezed.dart index 77c51997b..50ec013ca 100644 --- a/examples/stackoverflow/lib/tag.freezed.dart +++ b/examples/stackoverflow/lib/tag.freezed.dart @@ -153,7 +153,7 @@ class _$TagThemeImpl implements _TagTheme { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TagThemeImpl && diff --git a/examples/stackoverflow/lib/user.freezed.dart b/examples/stackoverflow/lib/user.freezed.dart index efc55d2ad..ea66623e1 100644 --- a/examples/stackoverflow/lib/user.freezed.dart +++ b/examples/stackoverflow/lib/user.freezed.dart @@ -208,7 +208,7 @@ class _$UserImpl implements _User { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$UserImpl && @@ -396,7 +396,7 @@ class _$BadgeCountImpl implements _BadgeCount { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$BadgeCountImpl && diff --git a/packages/riverpod/example/lib/models.freezed.dart b/packages/riverpod/example/lib/models.freezed.dart index dcea04b78..b0e3ebd83 100644 --- a/packages/riverpod/example/lib/models.freezed.dart +++ b/packages/riverpod/example/lib/models.freezed.dart @@ -125,7 +125,7 @@ class _$ConfigurationImpl implements _Configuration { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ConfigurationImpl && @@ -281,7 +281,7 @@ class _$MarvelResponseImpl implements _MarvelResponse { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$MarvelResponseImpl && @@ -424,7 +424,7 @@ class _$MarvelDataImpl implements _MarvelData { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$MarvelDataImpl && @@ -572,7 +572,7 @@ class _$ComicImpl implements _Comic { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ComicImpl && diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index a2cb42331..fbaea8231 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -130,7 +130,7 @@ class FamilyTemplate extends Template { ) { return ProviderOverride( origin: this, - override: ${provider._providerImplName}$typeParametersUsage._internal( + providerOverride: ${provider._providerImplName}$typeParametersUsage._internal( (ref) => create(ref as ${provider._refImplName}$typeParametersUsage), from: from, name: null, @@ -229,7 +229,7 @@ abstract class $notifierTypedefName$typeParametersDefinition extends $notifierBa Override overrideWith(${provider.name}$typeParametersUsage Function() create) { return ProviderOverride( origin: this, - override: ${provider._providerImplName}$typeParametersUsage._internal( + providerOverride: ${provider._providerImplName}$typeParametersUsage._internal( () => create()$cascadePropertyInit, from: from, name: null, @@ -349,12 +349,12 @@ class $familyName extends Family { } class $familyOverrideClassName implements FamilyOverride { - $familyOverrideClassName(this.overriddenFamily, this.create); + $familyOverrideClassName(this.from, this.create); final $createType create; @override - final $familyName overriddenFamily; + final $familyName from; @override $providerTypeNameImpl getProviderOverride( diff --git a/packages/riverpod_generator/test/integration/generated.freezed.dart b/packages/riverpod_generator/test/integration/generated.freezed.dart index b7df1ae69..28fc84cf6 100644 --- a/packages/riverpod_generator/test/integration/generated.freezed.dart +++ b/packages/riverpod_generator/test/integration/generated.freezed.dart @@ -60,7 +60,7 @@ class _$TestImpl implements _Test { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TestImpl); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart index 848434c3d..5ffc2d810 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart @@ -136,12 +136,12 @@ class GenericsFamily extends Family { } class _$GenericsFamilyOverride implements FamilyOverride { - _$GenericsFamilyOverride(this.overriddenFamily, this.create); + _$GenericsFamilyOverride(this.from, this.create); final Generics Function() create; @override - final GenericsFamily overriddenFamily; + final GenericsFamily from; @override GenericsProvider getProviderOverride( @@ -188,7 +188,7 @@ class GenericsProvider Override overrideWith(Generics Function() create) { return ProviderOverride( origin: this, - override: GenericsProvider._internal( + providerOverride: GenericsProvider._internal( () => create(), from: from, name: null, @@ -297,12 +297,12 @@ class NoGenericsFamily extends Family { } class _$NoGenericsFamilyOverride implements FamilyOverride { - _$NoGenericsFamilyOverride(this.overriddenFamily, this.create); + _$NoGenericsFamilyOverride(this.from, this.create); final NoGenerics Function() create; @override - final NoGenericsFamily overriddenFamily; + final NoGenericsFamily from; @override NoGenericsProvider getProviderOverride( @@ -350,7 +350,7 @@ class NoGenericsProvider Override overrideWith(NoGenerics Function() create) { return ProviderOverride( origin: this, - override: NoGenericsProvider._internal( + providerOverride: NoGenericsProvider._internal( () => create(), from: from, name: null, @@ -459,12 +459,12 @@ class MissingGenericsFamily extends Family { } class _$MissingGenericsFamilyOverride implements FamilyOverride { - _$MissingGenericsFamilyOverride(this.overriddenFamily, this.create); + _$MissingGenericsFamilyOverride(this.from, this.create); final MissingGenerics Function() create; @override - final MissingGenericsFamily overriddenFamily; + final MissingGenericsFamily from; @override MissingGenericsProvider getProviderOverride( @@ -512,7 +512,7 @@ class MissingGenericsProvider Override overrideWith(MissingGenerics Function() create) { return ProviderOverride( origin: this, - override: MissingGenericsProvider._internal( + providerOverride: MissingGenericsProvider._internal( () => create(), from: from, name: null, @@ -620,12 +620,12 @@ class WrongOrderFamily extends Family { } class _$WrongOrderFamilyOverride implements FamilyOverride { - _$WrongOrderFamilyOverride(this.overriddenFamily, this.create); + _$WrongOrderFamilyOverride(this.from, this.create); final WrongOrder Function() create; @override - final WrongOrderFamily overriddenFamily; + final WrongOrderFamily from; @override WrongOrderProvider getProviderOverride( @@ -673,7 +673,7 @@ class WrongOrderProvider Override overrideWith(WrongOrder Function() create) { return ProviderOverride( origin: this, - override: WrongOrderProvider._internal( + providerOverride: WrongOrderProvider._internal( () => create(), from: from, name: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.freezed.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.freezed.dart index 803df2d6d..1b1c8d964 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.freezed.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.freezed.dart @@ -62,7 +62,7 @@ class _$FreezedExampleImpl implements _FreezedExample { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$FreezedExampleImpl); } diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.freezed.dart b/website/docs/case_studies/cancel/detail_screen/codegen.freezed.dart index f4f9398ea..96f1b9a0b 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.freezed.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.freezed.dart @@ -153,7 +153,7 @@ class _$ActivityImpl implements _Activity { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ActivityImpl && diff --git a/website/docs/case_studies/pull_to_refresh/activity/codegen.freezed.dart b/website/docs/case_studies/pull_to_refresh/activity/codegen.freezed.dart index f4f9398ea..96f1b9a0b 100644 --- a/website/docs/case_studies/pull_to_refresh/activity/codegen.freezed.dart +++ b/website/docs/case_studies/pull_to_refresh/activity/codegen.freezed.dart @@ -153,7 +153,7 @@ class _$ActivityImpl implements _Activity { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ActivityImpl && diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.freezed.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.freezed.dart index f4f9398ea..96f1b9a0b 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.freezed.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.freezed.dart @@ -153,7 +153,7 @@ class _$ActivityImpl implements _Activity { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ActivityImpl && diff --git a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart index a04416833..a2fc72563 100644 --- a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart +++ b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart @@ -126,7 +126,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/docs/concepts/why_immutability/codegen.freezed.dart b/website/docs/concepts/why_immutability/codegen.freezed.dart index acb6d0e7f..78422f4d9 100644 --- a/website/docs/concepts/why_immutability/codegen.freezed.dart +++ b/website/docs/concepts/why_immutability/codegen.freezed.dart @@ -116,7 +116,7 @@ class _$ThemeSettingsImpl implements _ThemeSettings { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ThemeSettingsImpl && diff --git a/website/docs/essentials/first_request/codegen/activity.freezed.dart b/website/docs/essentials/first_request/codegen/activity.freezed.dart index c10bc4253..3f862d5e5 100644 --- a/website/docs/essentials/first_request/codegen/activity.freezed.dart +++ b/website/docs/essentials/first_request/codegen/activity.freezed.dart @@ -177,7 +177,7 @@ class _$ActivityImpl implements _Activity { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ActivityImpl && diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier.freezed.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier.freezed.dart index 319351f78..6fb514afd 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier.freezed.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier.freezed.dart @@ -121,7 +121,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.freezed.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.freezed.dart index 95e5e1d15..67a84d8b7 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.freezed.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.freezed.dart @@ -113,7 +113,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/docs/from_provider/helpers/item.freezed.dart b/website/docs/from_provider/helpers/item.freezed.dart index 959fe13d2..2ad228f69 100644 --- a/website/docs/from_provider/helpers/item.freezed.dart +++ b/website/docs/from_provider/helpers/item.freezed.dart @@ -107,7 +107,7 @@ class _$ItemImpl implements _Item { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ItemImpl && diff --git a/website/docs/providers/notifier_provider/remote_todos/codegen.freezed.dart b/website/docs/providers/notifier_provider/remote_todos/codegen.freezed.dart index 315bc924e..3fbfdcf6c 100644 --- a/website/docs/providers/notifier_provider/remote_todos/codegen.freezed.dart +++ b/website/docs/providers/notifier_provider/remote_todos/codegen.freezed.dart @@ -134,7 +134,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/docs/providers/notifier_provider/todos/codegen.freezed.dart b/website/docs/providers/notifier_provider/todos/codegen.freezed.dart index a04416833..a2fc72563 100644 --- a/website/docs/providers/notifier_provider/todos/codegen.freezed.dart +++ b/website/docs/providers/notifier_provider/todos/codegen.freezed.dart @@ -126,7 +126,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart index 315bc924e..3fbfdcf6c 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart @@ -134,7 +134,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart index a04416833..a2fc72563 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart @@ -126,7 +126,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart index 315bc924e..3fbfdcf6c 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart @@ -134,7 +134,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart index a04416833..a2fc72563 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart @@ -126,7 +126,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && From 6ba00b83b2b7fac05266407a4999afc62eb2b588 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 28 Dec 2023 10:34:30 +0100 Subject: [PATCH 096/387] toString upate --- examples/pub/lib/detail.g.dart | 18 +++++ examples/pub/lib/search.g.dart | 9 +++ .../deprecated/change_notifier_provider.dart | 4 + packages/riverpod/lib/riverpod.dart | 9 ++- packages/riverpod/lib/src/common/result.dart | 4 +- packages/riverpod/lib/src/core/override.dart | 13 +-- .../lib/src/core/override_with_value.dart | 6 +- packages/riverpod/lib/src/core/provider.dart | 10 ++- .../integration/build_yaml/lib/main.g.dart | 56 +++++++++++++ .../riverpod_generator/lib/src/models.dart | 2 + .../lib/src/templates/family.dart | 16 ++++ .../test/integration/annotated.g.dart | 18 +++++ .../test/integration/async.g.dart | 54 +++++++++++++ .../test/integration/dependencies.g.dart | 27 +++++++ .../test/integration/dependencies2.g.dart | 19 +++++ .../test/integration/generated.g.dart | 63 +++++++++++++++ .../test/integration/stream.g.dart | 36 +++++++++ .../test/integration/sync.g.dart | 81 +++++++++++++++++++ .../generated/golden/lib/sync.g.dart | 18 +++++ ..._class_based_provider_to_functional.g.dart | 18 +++++ ..._functional_provider_to_class_based.g.dart | 9 +++ .../avoid_build_context_in_providers.g.dart | 18 +++++ .../avoid_public_notifier_properties.g.dart | 9 +++ .../test/lints/dependencies.g.dart | 18 +++++ .../functional_ref/functional_ref.g.dart | 36 +++++++++ .../notifier_extends/notifier_extends.g.dart | 36 +++++++++ .../protected_notifier_properties.g.dart | 54 +++++++++++++ .../test/lints/provider_parameters.g.dart | 9 +++ .../docs/concepts/about_codegen/main.g.dart | 9 +++ .../about_codegen/provider_type/family.g.dart | 9 +++ .../provider_type/family_class.g.dart | 9 +++ .../provider_type/family_fn.g.dart | 9 +++ .../invalidate_family_example/codegen.g.dart | 9 +++ .../passing_args/codegen/family.g.dart | 9 +++ .../passing_args/codegen/provider.g.dart | 9 +++ .../docs/from_provider/family/family.g.dart | 9 +++ .../introduction/why_riverpod/codegen.g.dart | 9 +++ .../family_and_dispose.g.dart | 9 +++ .../current/about_codegen/main.g.dart | 9 +++ .../current/about_codegen/main.g.dart | 9 +++ .../current/about_codegen/main.g.dart | 9 +++ .../current/about_codegen/main.g.dart | 9 +++ 42 files changed, 781 insertions(+), 15 deletions(-) diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index b6193e30b..6c4feef84 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -79,6 +79,9 @@ class FetchPackageDetailsFamily extends Family { FutureOr Function(FetchPackageDetailsRef ref) create) { return _$FetchPackageDetailsFamilyOverride(this, create); } + + @override + String toString() => 'fetchPackageDetailsProvider'; } class _$FetchPackageDetailsFamilyOverride implements FamilyOverride { @@ -95,6 +98,9 @@ class _$FetchPackageDetailsFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'fetchPackageDetailsProvider.overrideWith($create)'; } /// See also [fetchPackageDetails]. @@ -190,6 +196,9 @@ class FetchPackageDetailsProvider extends AutoDisposeFutureProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'fetchPackageDetailsProvider$argument'; } mixin FetchPackageDetailsRef on AutoDisposeFutureProviderRef { @@ -317,6 +326,9 @@ class PackageMetricsFamily extends Family { Override overrideWith(PackageMetrics Function() create) { return _$PackageMetricsFamilyOverride(this, create); } + + @override + String toString() => 'packageMetricsProvider'; } class _$PackageMetricsFamilyOverride implements FamilyOverride { @@ -333,6 +345,9 @@ class _$PackageMetricsFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'packageMetricsProvider.overrideWith($create)'; } /// A provider that fetches the likes count, popularity score and pub points @@ -445,6 +460,9 @@ class PackageMetricsProvider extends AutoDisposeAsyncNotifierProviderImpl< return _SystemHash.finish(hash); } + + @override + String toString() => 'packageMetricsProvider$argument'; } mixin PackageMetricsRef diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 4822a451d..8fcf3e883 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -81,6 +81,9 @@ class FetchPackagesFamily extends Family { FutureOr> Function(FetchPackagesRef ref) create) { return _$FetchPackagesFamilyOverride(this, create); } + + @override + String toString() => 'fetchPackagesProvider'; } class _$FetchPackagesFamilyOverride implements FamilyOverride { @@ -97,6 +100,9 @@ class _$FetchPackagesFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'fetchPackagesProvider.overrideWith($create)'; } /// See also [fetchPackages]. @@ -205,6 +211,9 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { return _SystemHash.finish(hash); } + + @override + String toString() => 'fetchPackagesProvider$argument'; } mixin FetchPackagesRef on AutoDisposeFutureProviderRef> { diff --git a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider.dart b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider.dart index b14ad8bce..9398cdf0b 100644 --- a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider.dart @@ -60,4 +60,8 @@ abstract class _ChangeNotifierProviderBase ProviderListenable get notifier; NotifierT _create(covariant ChangeNotifierProviderElement ref); + + // Specified by ProviderBase + @override + String toString(); } diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index d26f50389..9ae867f10 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -20,7 +20,6 @@ export 'src/framework.dart' AutoDisposeNotifierFamilyBase, ProviderOverride, AutoDisposeFamilyBase, - AlwaysAliveAsyncSelector, DebugGetCreateSourceHash, ProviderNotifierCreate, ProviderCreate, @@ -30,7 +29,13 @@ export 'src/framework.dart' ProviderElementProxy, OnError, ProviderContainerTest, - DebugRiverpodDevtoolBiding; + DebugRiverpodDevtoolBiding, + TransitiveFamilyOverride, + TransitiveProviderOverride, + ProviderPointer, + ProviderPointerManager, + ProviderDirectory; + export 'src/legacy_providers/async_notifier.dart' hide AsyncNotifierProviderImpl, diff --git a/packages/riverpod/lib/src/common/result.dart b/packages/riverpod/lib/src/common/result.dart index 807117ac1..fba7523f4 100644 --- a/packages/riverpod/lib/src/common/result.dart +++ b/packages/riverpod/lib/src/common/result.dart @@ -83,7 +83,7 @@ class ResultData implements Result { } @override - bool operator ==(Object? other) => + bool operator ==(Object other) => other is ResultData && other.runtimeType == runtimeType && other.state == state; @@ -130,7 +130,7 @@ class ResultError implements Result { } @override - bool operator ==(Object? other) => + bool operator ==(Object other) => other is ResultError && other.runtimeType == runtimeType && other.stackTrace == stackTrace && diff --git a/packages/riverpod/lib/src/core/override.dart b/packages/riverpod/lib/src/core/override.dart index 03d29248e..195544d32 100644 --- a/packages/riverpod/lib/src/core/override.dart +++ b/packages/riverpod/lib/src/core/override.dart @@ -4,11 +4,7 @@ part of '../framework.dart'; /// of a provider/family for part of the application. /// /// Do not extend or implement. -sealed class Override { - @mustBeOverridden - @override - String toString(); -} +sealed class Override {} /// An object used by [ProviderContainer] to override the behavior of a provider /// for a part of the application. @@ -40,9 +36,10 @@ class _ProviderOverrideBase implements ProviderOverride { /// The new provider behavior. final ProviderBase providerOverride; + @mustBeOverridden @override String toString() { - return 'ProviderOverride($origin, $providerOverride)'; + return '$origin.overrideWith($providerOverride)'; } } @@ -89,6 +86,10 @@ abstract class FamilyOverride implements Override { /// Obtains the new behavior for a provider associated to the overridden family. @visibleForOverriding ProviderBase getProviderOverride(ProviderBase provider); + + @mustBeOverridden + @override + String toString(); } @internal diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index 0a605fdda..5136b4656 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -4,7 +4,7 @@ part of '../framework.dart'; // TODO merge with Provider directy mixin OverrideWithValueMixin on ProviderBase { /// {@template riverpod.overrridewithvalue} - /// Overrides a provider with a value, ejecting the default behaviour. + /// Overrides a provider with a value, ejecting the default behavior. /// /// This will also disable the auto-scoping mechanism, meaning that if the /// overridden provider specified [dependencies], it will have no effect. @@ -40,6 +40,10 @@ mixin OverrideWithValueMixin on ProviderBase { providerOverride: ValueProvider(value), ); } + + @mustBeOverridden + @override + String toString(); } /// A provider that is driven by a value instead of a function. diff --git a/packages/riverpod/lib/src/core/provider.dart b/packages/riverpod/lib/src/core/provider.dart index e822c29aa..bb6338b7c 100644 --- a/packages/riverpod/lib/src/core/provider.dart +++ b/packages/riverpod/lib/src/core/provider.dart @@ -132,12 +132,14 @@ abstract class ProviderBase extends ProviderOrFamily leading = '($argument)'; } - var trailing = ''; - if (name != null) { - trailing = '$name:'; + String label; + if (name case final name?) { + label = name; + } else { + label = describeIdentity(this); } - return '$trailing${describeIdentity(this)}$leading'; + return '$label$leading'; } } diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 3455e1037..a90a68ee1 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -117,6 +117,9 @@ class Count2Family extends Family { Override overrideWith(int Function(Count2Ref ref) create) { return _$Count2FamilyOverride(this, create); } + + @override + String toString() => 'count2ProviderFamily'; } class _$Count2FamilyOverride implements FamilyOverride { @@ -133,6 +136,9 @@ class _$Count2FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'count2ProviderFamily.overrideWith($create)'; } /// See also [count2]. @@ -224,6 +230,9 @@ class Count2Provider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'count2ProviderFamily$argument'; } mixin Count2Ref on AutoDisposeProviderRef { @@ -287,6 +296,9 @@ class CountFuture2Family extends Family { Override overrideWith(FutureOr Function(CountFuture2Ref ref) create) { return _$CountFuture2FamilyOverride(this, create); } + + @override + String toString() => 'countFuture2ProviderFamily'; } class _$CountFuture2FamilyOverride implements FamilyOverride { @@ -303,6 +315,9 @@ class _$CountFuture2FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'countFuture2ProviderFamily.overrideWith($create)'; } /// See also [countFuture2]. @@ -395,6 +410,9 @@ class CountFuture2Provider extends AutoDisposeFutureProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'countFuture2ProviderFamily$argument'; } mixin CountFuture2Ref on AutoDisposeFutureProviderRef { @@ -458,6 +476,9 @@ class CountStream2Family extends Family { Override overrideWith(Stream Function(CountStream2Ref ref) create) { return _$CountStream2FamilyOverride(this, create); } + + @override + String toString() => 'countStream2ProviderFamily'; } class _$CountStream2FamilyOverride implements FamilyOverride { @@ -474,6 +495,9 @@ class _$CountStream2FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'countStream2ProviderFamily.overrideWith($create)'; } /// See also [countStream2]. @@ -566,6 +590,9 @@ class CountStream2Provider extends AutoDisposeStreamProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'countStream2ProviderFamily$argument'; } mixin CountStream2Ref on AutoDisposeStreamProviderRef { @@ -687,6 +714,9 @@ class CountNotifier2Family extends Family { Override overrideWith(CountNotifier2 Function() create) { return _$CountNotifier2FamilyOverride(this, create); } + + @override + String toString() => 'countNotifier2ProviderFamily'; } class _$CountNotifier2FamilyOverride implements FamilyOverride { @@ -703,6 +733,9 @@ class _$CountNotifier2FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'countNotifier2ProviderFamily.overrideWith($create)'; } /// See also [CountNotifier2]. @@ -800,6 +833,9 @@ class CountNotifier2Provider return _SystemHash.finish(hash); } + + @override + String toString() => 'countNotifier2ProviderFamily$argument'; } mixin CountNotifier2Ref on AutoDisposeNotifierProviderRef { @@ -874,6 +910,9 @@ class CountAsyncNotifier2Family extends Family { Override overrideWith(CountAsyncNotifier2 Function() create) { return _$CountAsyncNotifier2FamilyOverride(this, create); } + + @override + String toString() => 'countAsyncNotifier2ProviderFamily'; } class _$CountAsyncNotifier2FamilyOverride implements FamilyOverride { @@ -890,6 +929,10 @@ class _$CountAsyncNotifier2FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => + 'countAsyncNotifier2ProviderFamily.overrideWith($create)'; } /// See also [CountAsyncNotifier2]. @@ -988,6 +1031,9 @@ class CountAsyncNotifier2Provider return _SystemHash.finish(hash); } + + @override + String toString() => 'countAsyncNotifier2ProviderFamily$argument'; } mixin CountAsyncNotifier2Ref on AutoDisposeAsyncNotifierProviderRef { @@ -1062,6 +1108,9 @@ class CountStreamNotifier2Family extends Family { Override overrideWith(CountStreamNotifier2 Function() create) { return _$CountStreamNotifier2FamilyOverride(this, create); } + + @override + String toString() => 'countStreamNotifier2ProviderFamily'; } class _$CountStreamNotifier2FamilyOverride implements FamilyOverride { @@ -1078,6 +1127,10 @@ class _$CountStreamNotifier2FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => + 'countStreamNotifier2ProviderFamily.overrideWith($create)'; } /// See also [CountStreamNotifier2]. @@ -1176,6 +1229,9 @@ class CountStreamNotifier2Provider return _SystemHash.finish(hash); } + + @override + String toString() => 'countStreamNotifier2ProviderFamily$argument'; } mixin CountStreamNotifier2Ref on AutoDisposeStreamNotifierProviderRef { diff --git a/packages/riverpod_generator/lib/src/models.dart b/packages/riverpod_generator/lib/src/models.dart index 1feb16801..a8d7e9d02 100644 --- a/packages/riverpod_generator/lib/src/models.dart +++ b/packages/riverpod_generator/lib/src/models.dart @@ -16,6 +16,8 @@ class BuildYamlOptions { } extension CaseChangeExtension on String { + String get encoded => replaceAll(r'$', r'\$'); + String get titled { return replaceFirstMapped( RegExp('[a-zA-Z]'), diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index fbaea8231..606ef7359 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -302,6 +302,13 @@ ${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} '_\$${provider.name.lexeme.titled.public}FamilyOverride'; // TODO changelog updated to support createElement prototype change + // TODO changelog toString() + // TODO handle generics with $ in their name + + final encodedProviderName = providerName.encoded; + final encodedGenerics = typeParameters == null + ? '' + : '<${typeParameters!.typeParameters.map((e) => '\$${e.name.lexeme.encoded}').join(',')}>'; buffer.write(''' $other @@ -346,6 +353,9 @@ class $familyName extends Family { Override overrideWith($createType create) { return $familyOverrideClassName(this, create); } + + @override + String toString() => '$encodedProviderName'; } class $familyOverrideClassName implements FamilyOverride { @@ -362,6 +372,9 @@ class $familyOverrideClassName implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => '$encodedProviderName.overrideWith(\$create)'; } $docs @@ -441,6 +454,9 @@ ${[ return _SystemHash.finish(hash); } + + @override + String toString() => '$encodedProviderName$encodedGenerics\$argument'; } mixin $refNameImpl$typeParametersDefinition on $refType<${provider.valueTypeDisplayString}> { diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index b6efa80b7..9f6613681 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -95,6 +95,9 @@ class FamilyFamily extends Family { Override overrideWith(String Function(FamilyRef ref) create) { return _$FamilyFamilyOverride(this, create); } + + @override + String toString() => 'familyProvider'; } class _$FamilyFamilyOverride implements FamilyOverride { @@ -111,6 +114,9 @@ class _$FamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyProvider.overrideWith($create)'; } /// See also [family]. @@ -202,6 +208,9 @@ class FamilyProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'familyProvider$argument'; } mixin FamilyRef on AutoDisposeProviderRef { @@ -281,6 +290,9 @@ class NotCopiedFamilyFamily extends Family { Override overrideWith(String Function(NotCopiedFamilyRef ref) create) { return _$NotCopiedFamilyFamilyOverride(this, create); } + + @override + String toString() => 'notCopiedFamilyProvider'; } class _$NotCopiedFamilyFamilyOverride implements FamilyOverride { @@ -297,6 +309,9 @@ class _$NotCopiedFamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'notCopiedFamilyProvider.overrideWith($create)'; } /// See also [notCopiedFamily]. @@ -389,6 +404,9 @@ class NotCopiedFamilyProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'notCopiedFamilyProvider$argument'; } mixin NotCopiedFamilyRef on AutoDisposeProviderRef { diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 60e39f416..c64518cdd 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -70,6 +70,9 @@ class GenericFamily extends Family { FutureOr> Function(GenericRef ref) create) { return _$GenericFamilyOverride(this, create); } + + @override + String toString() => 'genericProvider'; } class _$GenericFamilyOverride implements FamilyOverride { @@ -86,6 +89,9 @@ class _$GenericFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'genericProvider.overrideWith($create)'; } /// See also [generic]. @@ -170,6 +176,9 @@ class GenericProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'genericProvider<$T>$argument'; } mixin GenericRef on AutoDisposeFutureProviderRef> {} @@ -255,6 +264,9 @@ class FamilyOrFamily extends Family { Override overrideWith(FutureOr Function(FamilyOrRef ref) create) { return _$FamilyOrFamilyOverride(this, create); } + + @override + String toString() => 'familyOrProvider'; } class _$FamilyOrFamilyOverride implements FamilyOverride { @@ -271,6 +283,9 @@ class _$FamilyOrFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyOrProvider.overrideWith($create)'; } /// See also [familyOr]. @@ -362,6 +377,9 @@ class FamilyOrProvider extends AutoDisposeFutureProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'familyOrProvider$argument'; } mixin FamilyOrRef on AutoDisposeFutureProviderRef { @@ -437,6 +455,9 @@ class FamilyFamily extends Family { Override overrideWith(FutureOr Function(FamilyRef ref) create) { return _$FamilyFamilyOverride(this, create); } + + @override + String toString() => 'familyProvider'; } class _$FamilyFamilyOverride implements FamilyOverride { @@ -453,6 +474,9 @@ class _$FamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyProvider.overrideWith($create)'; } /// See also [family]. @@ -593,6 +617,9 @@ class FamilyProvider extends AutoDisposeFutureProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'familyProvider$argument'; } mixin FamilyRef on AutoDisposeFutureProviderRef { @@ -675,6 +702,9 @@ class GenericClassFamily extends Family { Override overrideWith(GenericClass Function() create) { return _$GenericClassFamilyOverride(this, create); } + + @override + String toString() => 'genericClassProvider'; } class _$GenericClassFamilyOverride implements FamilyOverride { @@ -691,6 +721,9 @@ class _$GenericClassFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'genericClassProvider.overrideWith($create)'; } /// See also [GenericClass]. @@ -780,6 +813,9 @@ class GenericClassProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'genericClassProvider<$T>$argument'; } mixin GenericClassRef @@ -878,6 +914,9 @@ class FamilyOrClassFamily extends Family { Override overrideWith(FamilyOrClass Function() create) { return _$FamilyOrClassFamilyOverride(this, create); } + + @override + String toString() => 'familyOrClassProvider'; } class _$FamilyOrClassFamilyOverride implements FamilyOverride { @@ -894,6 +933,9 @@ class _$FamilyOrClassFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyOrClassProvider.overrideWith($create)'; } /// See also [FamilyOrClass]. @@ -991,6 +1033,9 @@ class FamilyOrClassProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'familyOrClassProvider$argument'; } mixin FamilyOrClassRef on AutoDisposeAsyncNotifierProviderRef { @@ -1083,6 +1128,9 @@ class FamilyClassFamily extends Family { Override overrideWith(FamilyClass Function() create) { return _$FamilyClassFamilyOverride(this, create); } + + @override + String toString() => 'familyClassProvider'; } class _$FamilyClassFamilyOverride implements FamilyOverride { @@ -1099,6 +1147,9 @@ class _$FamilyClassFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyClassProvider.overrideWith($create)'; } /// See also [FamilyClass]. @@ -1260,6 +1311,9 @@ class FamilyClassProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'familyClassProvider$argument'; } mixin FamilyClassRef on AutoDisposeAsyncNotifierProviderRef { diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 0ddd854d8..a0797a580 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -89,6 +89,9 @@ class FamilyFamily extends Family { Override overrideWith(int Function(FamilyRef ref) create) { return _$FamilyFamilyOverride(this, create); } + + @override + String toString() => 'familyProvider'; } class _$FamilyFamilyOverride implements FamilyOverride { @@ -105,6 +108,9 @@ class _$FamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyProvider.overrideWith($create)'; } /// See also [family]. @@ -196,6 +202,9 @@ class FamilyProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'familyProvider$argument'; } mixin FamilyRef on AutoDisposeProviderRef { @@ -445,6 +454,9 @@ class Family2Family extends Family { Override overrideWith(Family2 Function() create) { return _$Family2FamilyOverride(this, create); } + + @override + String toString() => 'family2Provider'; } class _$Family2FamilyOverride implements FamilyOverride { @@ -461,6 +473,9 @@ class _$Family2FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'family2Provider.overrideWith($create)'; } /// See also [Family2]. @@ -556,6 +571,9 @@ class Family2Provider extends AutoDisposeNotifierProviderImpl { return _SystemHash.finish(hash); } + + @override + String toString() => 'family2Provider$argument'; } mixin Family2Ref on AutoDisposeNotifierProviderRef { @@ -670,6 +688,9 @@ class Provider4Family extends Family { Override overrideWith(Provider4 Function() create) { return _$Provider4FamilyOverride(this, create); } + + @override + String toString() => 'provider4Provider'; } class _$Provider4FamilyOverride implements FamilyOverride { @@ -686,6 +707,9 @@ class _$Provider4FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'provider4Provider.overrideWith($create)'; } /// See also [Provider4]. @@ -782,6 +806,9 @@ class Provider4Provider return _SystemHash.finish(hash); } + + @override + String toString() => 'provider4Provider$argument'; } mixin Provider4Ref on AutoDisposeNotifierProviderRef { diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 77cb54681..83e0c8cd4 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -115,6 +115,9 @@ class FamilyWithDependencies2Family extends Family { Override overrideWith(int Function(FamilyWithDependencies2Ref ref) create) { return _$FamilyWithDependencies2FamilyOverride(this, create); } + + @override + String toString() => 'familyWithDependencies2Provider'; } class _$FamilyWithDependencies2FamilyOverride implements FamilyOverride { @@ -131,6 +134,9 @@ class _$FamilyWithDependencies2FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyWithDependencies2Provider.overrideWith($create)'; } /// See also [familyWithDependencies2]. @@ -225,6 +231,9 @@ class FamilyWithDependencies2Provider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'familyWithDependencies2Provider$argument'; } mixin FamilyWithDependencies2Ref on AutoDisposeProviderRef { @@ -367,6 +376,9 @@ class NotifierFamilyWithDependenciesFamily extends Family { Override overrideWith(NotifierFamilyWithDependencies Function() create) { return _$NotifierFamilyWithDependenciesFamilyOverride(this, create); } + + @override + String toString() => 'notifierFamilyWithDependenciesProvider'; } class _$NotifierFamilyWithDependenciesFamilyOverride implements FamilyOverride { @@ -383,6 +395,10 @@ class _$NotifierFamilyWithDependenciesFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => + 'notifierFamilyWithDependenciesProvider.overrideWith($create)'; } /// See also [NotifierFamilyWithDependencies]. @@ -484,6 +500,9 @@ class NotifierFamilyWithDependenciesProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'notifierFamilyWithDependenciesProvider$argument'; } mixin NotifierFamilyWithDependenciesRef on AutoDisposeNotifierProviderRef { diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 51e29a39e..fa753f3ad 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -89,6 +89,9 @@ class GeneratedFamilyFamily extends Family { Override overrideWith(_Test Function(GeneratedFamilyRef ref) create) { return _$GeneratedFamilyFamilyOverride(this, create); } + + @override + String toString() => 'generatedFamilyProvider'; } class _$GeneratedFamilyFamilyOverride implements FamilyOverride { @@ -105,6 +108,9 @@ class _$GeneratedFamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'generatedFamilyProvider.overrideWith($create)'; } /// See also [generatedFamily]. @@ -197,6 +203,9 @@ class GeneratedFamilyProvider extends AutoDisposeProvider<_Test> { return _SystemHash.finish(hash); } + + @override + String toString() => 'generatedFamilyProvider$argument'; } mixin GeneratedFamilyRef on AutoDisposeProviderRef<_Test> { @@ -274,6 +283,9 @@ class $DynamicFamilyFamily extends Family { Override overrideWith(Object? Function($DynamicFamilyRef ref) create) { return _$$DynamicFamilyFamilyOverride(this, create); } + + @override + String toString() => '\$dynamicFamilyProvider'; } class _$$DynamicFamilyFamilyOverride implements FamilyOverride { @@ -290,6 +302,9 @@ class _$$DynamicFamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => '\$dynamicFamilyProvider.overrideWith($create)'; } /// See also [$dynamicFamily]. @@ -382,6 +397,9 @@ class $DynamicFamilyProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => '\$dynamicFamilyProvider$argument'; } mixin $DynamicFamilyRef on AutoDisposeProviderRef { @@ -445,6 +463,9 @@ class _DynamicFamily extends Family { Override overrideWith(Object? Function(_DynamicRef ref) create) { return _$DynamicFamilyOverride(this, create); } + + @override + String toString() => '_dynamicProvider'; } class _$DynamicFamilyOverride implements FamilyOverride { @@ -461,6 +482,9 @@ class _$DynamicFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => '_dynamicProvider.overrideWith($create)'; } /// See also [_dynamic]. @@ -552,6 +576,9 @@ class _DynamicProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => '_dynamicProvider$argument'; } mixin _DynamicRef on AutoDisposeProviderRef { @@ -629,6 +656,9 @@ class AliasFamilyFamily extends Family { Override overrideWith(r.AsyncValue Function(AliasFamilyRef ref) create) { return _$AliasFamilyFamilyOverride(this, create); } + + @override + String toString() => 'aliasFamilyProvider'; } class _$AliasFamilyFamilyOverride implements FamilyOverride { @@ -645,6 +675,9 @@ class _$AliasFamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'aliasFamilyProvider.overrideWith($create)'; } /// See also [aliasFamily]. @@ -737,6 +770,9 @@ class AliasFamilyProvider extends AutoDisposeProvider> { return _SystemHash.finish(hash); } + + @override + String toString() => 'aliasFamilyProvider$argument'; } mixin AliasFamilyRef on AutoDisposeProviderRef> { @@ -826,6 +862,9 @@ class GeneratedClassFamilyFamily extends Family { Override overrideWith(GeneratedClassFamily Function() create) { return _$GeneratedClassFamilyFamilyOverride(this, create); } + + @override + String toString() => 'generatedClassFamilyProvider'; } class _$GeneratedClassFamilyFamilyOverride implements FamilyOverride { @@ -842,6 +881,9 @@ class _$GeneratedClassFamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'generatedClassFamilyProvider.overrideWith($create)'; } /// See also [GeneratedClassFamily]. @@ -939,6 +981,9 @@ class GeneratedClassFamilyProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'generatedClassFamilyProvider$argument'; } mixin GeneratedClassFamilyRef on AutoDisposeNotifierProviderRef<_Test> { @@ -1029,6 +1074,9 @@ class $DynamicClassFamilyFamily extends Family { Override overrideWith($DynamicClassFamily Function() create) { return _$$DynamicClassFamilyFamilyOverride(this, create); } + + @override + String toString() => '\$dynamicClassFamilyProvider'; } class _$$DynamicClassFamilyFamilyOverride implements FamilyOverride { @@ -1045,6 +1093,9 @@ class _$$DynamicClassFamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => '\$dynamicClassFamilyProvider.overrideWith($create)'; } /// See also [$DynamicClassFamily]. @@ -1143,6 +1194,9 @@ class $DynamicClassFamilyProvider return _SystemHash.finish(hash); } + + @override + String toString() => '\$dynamicClassFamilyProvider$argument'; } mixin $DynamicClassFamilyRef on AutoDisposeNotifierProviderRef { @@ -1231,6 +1285,9 @@ class AliasClassFamilyFamily extends Family { Override overrideWith(AliasClassFamily Function() create) { return _$AliasClassFamilyFamilyOverride(this, create); } + + @override + String toString() => 'aliasClassFamilyProvider'; } class _$AliasClassFamilyFamilyOverride implements FamilyOverride { @@ -1247,6 +1304,9 @@ class _$AliasClassFamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'aliasClassFamilyProvider.overrideWith($create)'; } /// See also [AliasClassFamily]. @@ -1345,6 +1405,9 @@ class AliasClassFamilyProvider extends AutoDisposeNotifierProviderImpl< return _SystemHash.finish(hash); } + + @override + String toString() => 'aliasClassFamilyProvider$argument'; } mixin AliasClassFamilyRef on AutoDisposeNotifierProviderRef> { diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 173eb32cf..6d9c3d25f 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -70,6 +70,9 @@ class GenericFamily extends Family { Stream> Function(GenericRef ref) create) { return _$GenericFamilyOverride(this, create); } + + @override + String toString() => 'genericProvider'; } class _$GenericFamilyOverride implements FamilyOverride { @@ -86,6 +89,9 @@ class _$GenericFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'genericProvider.overrideWith($create)'; } /// See also [generic]. @@ -170,6 +176,9 @@ class GenericProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'genericProvider<$T>$argument'; } mixin GenericRef on AutoDisposeStreamProviderRef> {} @@ -267,6 +276,9 @@ class FamilyFamily extends Family { Override overrideWith(Stream Function(FamilyRef ref) create) { return _$FamilyFamilyOverride(this, create); } + + @override + String toString() => 'familyProvider'; } class _$FamilyFamilyOverride implements FamilyOverride { @@ -283,6 +295,9 @@ class _$FamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyProvider.overrideWith($create)'; } /// See also [family]. @@ -423,6 +438,9 @@ class FamilyProvider extends AutoDisposeStreamProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'familyProvider$argument'; } mixin FamilyRef on AutoDisposeStreamProviderRef { @@ -505,6 +523,9 @@ class GenericClassFamily extends Family { Override overrideWith(GenericClass Function() create) { return _$GenericClassFamilyOverride(this, create); } + + @override + String toString() => 'genericClassProvider'; } class _$GenericClassFamilyOverride implements FamilyOverride { @@ -521,6 +542,9 @@ class _$GenericClassFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'genericClassProvider.overrideWith($create)'; } /// See also [GenericClass]. @@ -610,6 +634,9 @@ class GenericClassProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'genericClassProvider<$T>$argument'; } mixin GenericClassRef @@ -728,6 +755,9 @@ class FamilyClassFamily extends Family { Override overrideWith(FamilyClass Function() create) { return _$FamilyClassFamilyOverride(this, create); } + + @override + String toString() => 'familyClassProvider'; } class _$FamilyClassFamilyOverride implements FamilyOverride { @@ -744,6 +774,9 @@ class _$FamilyClassFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyClassProvider.overrideWith($create)'; } /// See also [FamilyClass]. @@ -905,6 +938,9 @@ class FamilyClassProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'familyClassProvider$argument'; } mixin FamilyClassRef on AutoDisposeStreamNotifierProviderRef { diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 792401efe..63568b48e 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -70,6 +70,9 @@ class GenericFamily extends Family { List Function(GenericRef ref) create) { return _$GenericFamilyOverride(this, create); } + + @override + String toString() => 'genericProvider'; } class _$GenericFamilyOverride implements FamilyOverride { @@ -86,6 +89,9 @@ class _$GenericFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'genericProvider.overrideWith($create)'; } /// See also [generic]. @@ -169,6 +175,9 @@ class GenericProvider extends AutoDisposeProvider> { return _SystemHash.finish(hash); } + + @override + String toString() => 'genericProvider<$T>$argument'; } mixin GenericRef on AutoDisposeProviderRef> {} @@ -232,6 +241,9 @@ class ComplexGenericFamily extends Family { create) { return _$ComplexGenericFamilyOverride(this, create); } + + @override + String toString() => 'complexGenericProvider'; } class _$ComplexGenericFamilyOverride implements FamilyOverride { @@ -249,6 +261,9 @@ class _$ComplexGenericFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'complexGenericProvider.overrideWith($create)'; } /// See also [complexGeneric]. @@ -362,6 +377,9 @@ class ComplexGenericProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'complexGenericProvider<$T,$Foo>$argument'; } mixin ComplexGenericRef @@ -460,6 +478,9 @@ class RawFamilyFutureFamily extends Family { Raw> Function(RawFamilyFutureRef ref) create) { return _$RawFamilyFutureFamilyOverride(this, create); } + + @override + String toString() => 'rawFamilyFutureProvider'; } class _$RawFamilyFutureFamilyOverride implements FamilyOverride { @@ -476,6 +497,9 @@ class _$RawFamilyFutureFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'rawFamilyFutureProvider.overrideWith($create)'; } /// See also [rawFamilyFuture]. @@ -568,6 +592,9 @@ class RawFamilyFutureProvider extends AutoDisposeProvider>> { return _SystemHash.finish(hash); } + + @override + String toString() => 'rawFamilyFutureProvider$argument'; } mixin RawFamilyFutureRef on AutoDisposeProviderRef>> { @@ -633,6 +660,9 @@ class RawFamilyStreamFamily extends Family { Raw> Function(RawFamilyStreamRef ref) create) { return _$RawFamilyStreamFamilyOverride(this, create); } + + @override + String toString() => 'rawFamilyStreamProvider'; } class _$RawFamilyStreamFamilyOverride implements FamilyOverride { @@ -649,6 +679,9 @@ class _$RawFamilyStreamFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'rawFamilyStreamProvider.overrideWith($create)'; } /// See also [rawFamilyStream]. @@ -741,6 +774,9 @@ class RawFamilyStreamProvider extends AutoDisposeProvider>> { return _SystemHash.finish(hash); } + + @override + String toString() => 'rawFamilyStreamProvider$argument'; } mixin RawFamilyStreamRef on AutoDisposeProviderRef>> { @@ -856,6 +892,9 @@ class FamilyFamily extends Family { Override overrideWith(String Function(FamilyRef ref) create) { return _$FamilyFamilyOverride(this, create); } + + @override + String toString() => 'familyProvider'; } class _$FamilyFamilyOverride implements FamilyOverride { @@ -872,6 +911,9 @@ class _$FamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyProvider.overrideWith($create)'; } /// This is some documentation @@ -1016,6 +1058,9 @@ class FamilyProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'familyProvider$argument'; } mixin FamilyRef on AutoDisposeProviderRef { @@ -1126,6 +1171,9 @@ class GenericClassFamily extends Family { Override overrideWith(GenericClass Function() create) { return _$GenericClassFamilyOverride(this, create); } + + @override + String toString() => 'genericClassProvider'; } class _$GenericClassFamilyOverride implements FamilyOverride { @@ -1142,6 +1190,9 @@ class _$GenericClassFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'genericClassProvider.overrideWith($create)'; } /// See also [GenericClass]. @@ -1230,6 +1281,9 @@ class GenericClassProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'genericClassProvider<$T>$argument'; } mixin GenericClassRef @@ -1331,6 +1385,9 @@ class RawFamilyFutureClassFamily extends Family { Override overrideWith(RawFamilyFutureClass Function() create) { return _$RawFamilyFutureClassFamilyOverride(this, create); } + + @override + String toString() => 'rawFamilyFutureClassProvider'; } class _$RawFamilyFutureClassFamilyOverride implements FamilyOverride { @@ -1347,6 +1404,9 @@ class _$RawFamilyFutureClassFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'rawFamilyFutureClassProvider.overrideWith($create)'; } /// See also [RawFamilyFutureClass]. @@ -1445,6 +1505,9 @@ class RawFamilyFutureClassProvider extends AutoDisposeNotifierProviderImpl< return _SystemHash.finish(hash); } + + @override + String toString() => 'rawFamilyFutureClassProvider$argument'; } mixin RawFamilyFutureClassRef @@ -1520,6 +1583,9 @@ class RawFamilyStreamClassFamily extends Family { Override overrideWith(RawFamilyStreamClass Function() create) { return _$RawFamilyStreamClassFamilyOverride(this, create); } + + @override + String toString() => 'rawFamilyStreamClassProvider'; } class _$RawFamilyStreamClassFamilyOverride implements FamilyOverride { @@ -1536,6 +1602,9 @@ class _$RawFamilyStreamClassFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'rawFamilyStreamClassProvider.overrideWith($create)'; } /// See also [RawFamilyStreamClass]. @@ -1634,6 +1703,9 @@ class RawFamilyStreamClassProvider extends AutoDisposeNotifierProviderImpl< return _SystemHash.finish(hash); } + + @override + String toString() => 'rawFamilyStreamClassProvider$argument'; } mixin RawFamilyStreamClassRef @@ -1767,6 +1839,9 @@ class FamilyClassFamily extends Family { Override overrideWith(FamilyClass Function() create) { return _$FamilyClassFamilyOverride(this, create); } + + @override + String toString() => 'familyClassProvider'; } class _$FamilyClassFamilyOverride implements FamilyOverride { @@ -1783,6 +1858,9 @@ class _$FamilyClassFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyClassProvider.overrideWith($create)'; } /// This is some documentation @@ -1948,6 +2026,9 @@ class FamilyClassProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'familyClassProvider$argument'; } mixin FamilyClassRef on AutoDisposeNotifierProviderRef { diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 64efc283f..6b54664fc 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -128,6 +128,9 @@ class FamilyFamily extends Family { Override overrideWith(String Function(FamilyRef ref) create) { return _$FamilyFamilyOverride(this, create); } + + @override + String toString() => 'familyProvider'; } class _$FamilyFamilyOverride implements FamilyOverride { @@ -144,6 +147,9 @@ class _$FamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyProvider.overrideWith($create)'; } /// A generated family provider. @@ -288,6 +294,9 @@ class FamilyProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'familyProvider$argument'; } mixin FamilyRef on AutoDisposeProviderRef { @@ -453,6 +462,9 @@ class FamilyClassFamily extends Family { Override overrideWith(FamilyClass Function() create) { return _$FamilyClassFamilyOverride(this, create); } + + @override + String toString() => 'familyClassProvider'; } class _$FamilyClassFamilyOverride implements FamilyOverride { @@ -469,6 +481,9 @@ class _$FamilyClassFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyClassProvider.overrideWith($create)'; } /// A generated family provider from a class. @@ -634,6 +649,9 @@ class FamilyClassProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'familyClassProvider$argument'; } mixin FamilyClassRef on AutoDisposeNotifierProviderRef { diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index a7356dd9e..a5b69a397 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -112,6 +112,9 @@ class ExampleFamilyFamily extends Family { Override overrideWith(ExampleFamily Function() create) { return _$ExampleFamilyFamilyOverride(this, create); } + + @override + String toString() => 'exampleFamilyProvider'; } class _$ExampleFamilyFamilyOverride implements FamilyOverride { @@ -128,6 +131,9 @@ class _$ExampleFamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'exampleFamilyProvider.overrideWith($create)'; } /// Some comment @@ -249,6 +255,9 @@ class ExampleFamilyProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'exampleFamilyProvider$argument'; } mixin ExampleFamilyRef on AutoDisposeNotifierProviderRef { @@ -316,6 +325,9 @@ class GenericFamily extends Family { Override overrideWith(Generic Function() create) { return _$GenericFamilyOverride(this, create); } + + @override + String toString() => 'genericProvider'; } class _$GenericFamilyOverride implements FamilyOverride { @@ -332,6 +344,9 @@ class _$GenericFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'genericProvider.overrideWith($create)'; } /// See also [Generic]. @@ -420,6 +435,9 @@ class GenericProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'genericProvider<$A,$B>$argument'; } mixin GenericRef on AutoDisposeNotifierProviderRef {} diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index 2e694b5e8..b44574a1d 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -102,6 +102,9 @@ class ExampleFamilyFamily extends Family { Override overrideWith(int Function(ExampleFamilyRef ref) create) { return _$ExampleFamilyFamilyOverride(this, create); } + + @override + String toString() => 'exampleFamilyProvider'; } class _$ExampleFamilyFamilyOverride implements FamilyOverride { @@ -118,6 +121,9 @@ class _$ExampleFamilyFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'exampleFamilyProvider.overrideWith($create)'; } /// Some comment @@ -228,6 +234,9 @@ class ExampleFamilyProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'exampleFamilyProvider$argument'; } mixin ExampleFamilyRef on AutoDisposeProviderRef { diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index fd79f0ae3..e886bd3da 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -78,6 +78,9 @@ class FnFamily extends Family { Override overrideWith(int Function(FnRef ref) create) { return _$FnFamilyOverride(this, create); } + + @override + String toString() => 'fnProvider'; } class _$FnFamilyOverride implements FamilyOverride { @@ -94,6 +97,9 @@ class _$FnFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'fnProvider.overrideWith($create)'; } /// See also [fn]. @@ -199,6 +205,9 @@ class FnProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'fnProvider$argument'; } mixin FnRef on AutoDisposeProviderRef { @@ -279,6 +288,9 @@ class MyNotifierFamily extends Family { Override overrideWith(MyNotifier Function() create) { return _$MyNotifierFamilyOverride(this, create); } + + @override + String toString() => 'myNotifierProvider'; } class _$MyNotifierFamilyOverride implements FamilyOverride { @@ -295,6 +307,9 @@ class _$MyNotifierFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'myNotifierProvider.overrideWith($create)'; } /// See also [MyNotifier]. @@ -414,6 +429,9 @@ class MyNotifierProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'myNotifierProvider$argument'; } mixin MyNotifierRef on AutoDisposeNotifierProviderRef { diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index 0815462e8..03531574e 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -83,6 +83,9 @@ class GeneratedNotifierFamily extends Family { Override overrideWith(GeneratedNotifier Function() create) { return _$GeneratedNotifierFamilyOverride(this, create); } + + @override + String toString() => 'generatedNotifierProvider'; } class _$GeneratedNotifierFamilyOverride implements FamilyOverride { @@ -99,6 +102,9 @@ class _$GeneratedNotifierFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'generatedNotifierProvider.overrideWith($create)'; } /// See also [GeneratedNotifier]. @@ -196,6 +202,9 @@ class GeneratedNotifierProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'generatedNotifierProvider$argument'; } mixin GeneratedNotifierRef on AutoDisposeNotifierProviderRef { diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index 2231cf398..57687e220 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -459,6 +459,9 @@ class FamilyDepFamily extends Family { Override overrideWith(int Function(FamilyDepRef ref) create) { return _$FamilyDepFamilyOverride(this, create); } + + @override + String toString() => 'familyDepProvider'; } class _$FamilyDepFamilyOverride implements FamilyOverride { @@ -475,6 +478,9 @@ class _$FamilyDepFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyDepProvider.overrideWith($create)'; } /// See also [familyDep]. @@ -566,6 +572,9 @@ class FamilyDepProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'familyDepProvider$argument'; } mixin FamilyDepRef on AutoDisposeProviderRef { @@ -635,6 +644,9 @@ class FamilyDep2Family extends Family { Override overrideWith(int Function(FamilyDep2Ref ref) create) { return _$FamilyDep2FamilyOverride(this, create); } + + @override + String toString() => 'familyDep2Provider'; } class _$FamilyDep2FamilyOverride implements FamilyOverride { @@ -651,6 +663,9 @@ class _$FamilyDep2FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'familyDep2Provider.overrideWith($create)'; } /// See also [familyDep2]. @@ -743,6 +758,9 @@ class FamilyDep2Provider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'familyDep2Provider$argument'; } mixin FamilyDep2Ref on AutoDisposeProviderRef { diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index cbd588bc1..367ca1641 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -101,6 +101,9 @@ class GenericsFamily extends Family { int Function(GenericsRef ref) create) { return _$GenericsFamilyOverride(this, create); } + + @override + String toString() => 'genericsProvider'; } class _$GenericsFamilyOverride implements FamilyOverride { @@ -117,6 +120,9 @@ class _$GenericsFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'genericsProvider.overrideWith($create)'; } /// See also [generics]. @@ -201,6 +207,9 @@ class GenericsProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'genericsProvider<$A,$B>$argument'; } mixin GenericsRef on AutoDisposeProviderRef {} @@ -253,6 +262,9 @@ class NoGenericsFamily extends Family { int Function(NoGenericsRef ref) create) { return _$NoGenericsFamilyOverride(this, create); } + + @override + String toString() => 'noGenericsProvider'; } class _$NoGenericsFamilyOverride implements FamilyOverride { @@ -269,6 +281,9 @@ class _$NoGenericsFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'noGenericsProvider.overrideWith($create)'; } /// See also [noGenerics]. @@ -354,6 +369,9 @@ class NoGenericsProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'noGenericsProvider<$A,$B>$argument'; } mixin NoGenericsRef on AutoDisposeProviderRef {} @@ -405,6 +423,9 @@ class MissingGenericsFamily extends Family { Override overrideWith(int Function(MissingGenericsRef ref) create) { return _$MissingGenericsFamilyOverride(this, create); } + + @override + String toString() => 'missingGenericsProvider'; } class _$MissingGenericsFamilyOverride implements FamilyOverride { @@ -421,6 +442,9 @@ class _$MissingGenericsFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'missingGenericsProvider.overrideWith($create)'; } /// See also [missingGenerics]. @@ -506,6 +530,9 @@ class MissingGenericsProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'missingGenericsProvider<$A,$B>$argument'; } mixin MissingGenericsRef on AutoDisposeProviderRef {} @@ -557,6 +584,9 @@ class WrongOrderFamily extends Family { Override overrideWith(int Function(WrongOrderRef ref) create) { return _$WrongOrderFamilyOverride(this, create); } + + @override + String toString() => 'wrongOrderProvider'; } class _$WrongOrderFamilyOverride implements FamilyOverride { @@ -573,6 +603,9 @@ class _$WrongOrderFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'wrongOrderProvider.overrideWith($create)'; } /// See also [wrongOrder]. @@ -658,6 +691,9 @@ class WrongOrderProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'wrongOrderProvider<$B,$A>$argument'; } mixin WrongOrderRef on AutoDisposeProviderRef {} diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart index 5ffc2d810..02e36d5e7 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart @@ -133,6 +133,9 @@ class GenericsFamily extends Family { Override overrideWith(Generics Function() create) { return _$GenericsFamilyOverride(this, create); } + + @override + String toString() => 'genericsProvider'; } class _$GenericsFamilyOverride implements FamilyOverride { @@ -149,6 +152,9 @@ class _$GenericsFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'genericsProvider.overrideWith($create)'; } /// See also [Generics]. @@ -237,6 +243,9 @@ class GenericsProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'genericsProvider<$A,$B>$argument'; } mixin GenericsRef on AutoDisposeNotifierProviderRef {} @@ -294,6 +303,9 @@ class NoGenericsFamily extends Family { Override overrideWith(NoGenerics Function() create) { return _$NoGenericsFamilyOverride(this, create); } + + @override + String toString() => 'noGenericsProvider'; } class _$NoGenericsFamilyOverride implements FamilyOverride { @@ -310,6 +322,9 @@ class _$NoGenericsFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'noGenericsProvider.overrideWith($create)'; } /// See also [NoGenerics]. @@ -399,6 +414,9 @@ class NoGenericsProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'noGenericsProvider<$A,$B>$argument'; } mixin NoGenericsRef on AutoDisposeNotifierProviderRef {} @@ -456,6 +474,9 @@ class MissingGenericsFamily extends Family { Override overrideWith(MissingGenerics Function() create) { return _$MissingGenericsFamilyOverride(this, create); } + + @override + String toString() => 'missingGenericsProvider'; } class _$MissingGenericsFamilyOverride implements FamilyOverride { @@ -472,6 +493,9 @@ class _$MissingGenericsFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'missingGenericsProvider.overrideWith($create)'; } /// See also [MissingGenerics]. @@ -561,6 +585,9 @@ class MissingGenericsProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'missingGenericsProvider<$A,$B>$argument'; } mixin MissingGenericsRef on AutoDisposeNotifierProviderRef {} @@ -617,6 +644,9 @@ class WrongOrderFamily extends Family { Override overrideWith(WrongOrder Function() create) { return _$WrongOrderFamilyOverride(this, create); } + + @override + String toString() => 'wrongOrderProvider'; } class _$WrongOrderFamilyOverride implements FamilyOverride { @@ -633,6 +663,9 @@ class _$WrongOrderFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'wrongOrderProvider.overrideWith($create)'; } /// See also [WrongOrder]. @@ -722,6 +755,9 @@ class WrongOrderProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'wrongOrderProvider<$A,$B>$argument'; } mixin WrongOrderRef on AutoDisposeNotifierProviderRef {} diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index 6a59eb9f4..c796ba9ca 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -111,6 +111,9 @@ class A3Family extends Family { Override overrideWith(A3 Function() create) { return _$A3FamilyOverride(this, create); } + + @override + String toString() => 'a3Provider'; } class _$A3FamilyOverride implements FamilyOverride { @@ -127,6 +130,9 @@ class _$A3FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'a3Provider.overrideWith($create)'; } /// See also [A3]. @@ -220,6 +226,9 @@ class A3Provider extends AutoDisposeNotifierProviderImpl { return _SystemHash.finish(hash); } + + @override + String toString() => 'a3Provider$argument'; } mixin A3Ref on AutoDisposeNotifierProviderRef { @@ -291,6 +300,9 @@ class A4Family extends Family { Override overrideWith(A4 Function() create) { return _$A4FamilyOverride(this, create); } + + @override + String toString() => 'a4Provider'; } class _$A4FamilyOverride implements FamilyOverride { @@ -307,6 +319,9 @@ class _$A4FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'a4Provider.overrideWith($create)'; } /// See also [A4]. @@ -400,6 +415,9 @@ class A4Provider extends NotifierProviderImpl { return _SystemHash.finish(hash); } + + @override + String toString() => 'a4Provider$argument'; } mixin A4Ref on NotifierProviderRef { @@ -470,6 +488,9 @@ class A5Family extends Family { Override overrideWith(A5 Function() create) { return _$A5FamilyOverride(this, create); } + + @override + String toString() => 'a5Provider'; } class _$A5FamilyOverride implements FamilyOverride { @@ -486,6 +507,9 @@ class _$A5FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'a5Provider.overrideWith($create)'; } /// See also [A5]. @@ -579,6 +603,9 @@ class A5Provider extends AutoDisposeAsyncNotifierProviderImpl { return _SystemHash.finish(hash); } + + @override + String toString() => 'a5Provider$argument'; } mixin A5Ref on AutoDisposeAsyncNotifierProviderRef { @@ -650,6 +677,9 @@ class A6Family extends Family { Override overrideWith(A6 Function() create) { return _$A6FamilyOverride(this, create); } + + @override + String toString() => 'a6Provider'; } class _$A6FamilyOverride implements FamilyOverride { @@ -666,6 +696,9 @@ class _$A6FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'a6Provider.overrideWith($create)'; } /// See also [A6]. @@ -759,6 +792,9 @@ class A6Provider extends AsyncNotifierProviderImpl { return _SystemHash.finish(hash); } + + @override + String toString() => 'a6Provider$argument'; } mixin A6Ref on AsyncNotifierProviderRef { @@ -830,6 +866,9 @@ class A7Family extends Family { Override overrideWith(A7 Function() create) { return _$A7FamilyOverride(this, create); } + + @override + String toString() => 'a7Provider'; } class _$A7FamilyOverride implements FamilyOverride { @@ -846,6 +885,9 @@ class _$A7FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'a7Provider.overrideWith($create)'; } /// See also [A7]. @@ -939,6 +981,9 @@ class A7Provider extends AutoDisposeStreamNotifierProviderImpl { return _SystemHash.finish(hash); } + + @override + String toString() => 'a7Provider$argument'; } mixin A7Ref on AutoDisposeStreamNotifierProviderRef { @@ -1010,6 +1055,9 @@ class A8Family extends Family { Override overrideWith(A8 Function() create) { return _$A8FamilyOverride(this, create); } + + @override + String toString() => 'a8Provider'; } class _$A8FamilyOverride implements FamilyOverride { @@ -1026,6 +1074,9 @@ class _$A8FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'a8Provider.overrideWith($create)'; } /// See also [A8]. @@ -1119,6 +1170,9 @@ class A8Provider extends StreamNotifierProviderImpl { return _SystemHash.finish(hash); } + + @override + String toString() => 'a8Provider$argument'; } mixin A8Ref on StreamNotifierProviderRef { diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 08a945f6c..cc4ae1727 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -75,6 +75,9 @@ class GeneratorFamily extends Family { Override overrideWith(int Function(GeneratorRef ref) create) { return _$GeneratorFamilyOverride(this, create); } + + @override + String toString() => 'generatorProvider'; } class _$GeneratorFamilyOverride implements FamilyOverride { @@ -91,6 +94,9 @@ class _$GeneratorFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'generatorProvider.overrideWith($create)'; } /// See also [generator]. @@ -184,6 +190,9 @@ class GeneratorProvider extends Provider { return _SystemHash.finish(hash); } + + @override + String toString() => 'generatorProvider$argument'; } mixin GeneratorRef on ProviderRef { diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 0b9b8e941..faa289a58 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -77,6 +77,9 @@ class FetchUserFamily extends Family { Override overrideWith(FutureOr Function(FetchUserRef ref) create) { return _$FetchUserFamilyOverride(this, create); } + + @override + String toString() => 'fetchUserProvider'; } class _$FetchUserFamilyOverride implements FamilyOverride { @@ -93,6 +96,9 @@ class _$FetchUserFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'fetchUserProvider.overrideWith($create)'; } /// See also [fetchUser]. @@ -186,6 +192,9 @@ class FetchUserProvider extends AutoDisposeFutureProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'fetchUserProvider$argument'; } mixin FetchUserRef on AutoDisposeFutureProviderRef { diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 660418639..728bdca7c 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -77,6 +77,9 @@ class ExampleFamily extends Family { Override overrideWith(String Function(ExampleRef ref) create) { return _$ExampleFamilyOverride(this, create); } + + @override + String toString() => 'exampleProvider'; } class _$ExampleFamilyOverride implements FamilyOverride { @@ -93,6 +96,9 @@ class _$ExampleFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'exampleProvider.overrideWith($create)'; } /// See also [example]. @@ -184,6 +190,9 @@ class ExampleProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'exampleProvider$argument'; } mixin ExampleRef on AutoDisposeProviderRef { diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index e9ec23808..fb018792b 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -90,6 +90,9 @@ class ExampleFamily extends Family { Override overrideWith(Example Function() create) { return _$ExampleFamilyOverride(this, create); } + + @override + String toString() => 'exampleProvider'; } class _$ExampleFamilyOverride implements FamilyOverride { @@ -106,6 +109,9 @@ class _$ExampleFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'exampleProvider.overrideWith($create)'; } /// See also [Example]. @@ -223,6 +229,9 @@ class ExampleProvider extends AutoDisposeNotifierProviderImpl { return _SystemHash.finish(hash); } + + @override + String toString() => 'exampleProvider$argument'; } mixin ExampleRef on AutoDisposeNotifierProviderRef { diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index e258c03e4..b82556129 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -80,6 +80,9 @@ class ExampleFamily extends Family { Override overrideWith(String Function(ExampleRef ref) create) { return _$ExampleFamilyOverride(this, create); } + + @override + String toString() => 'exampleProvider'; } class _$ExampleFamilyOverride implements FamilyOverride { @@ -96,6 +99,9 @@ class _$ExampleFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'exampleProvider.overrideWith($create)'; } /// See also [example]. @@ -203,6 +209,9 @@ class ExampleProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'exampleProvider$argument'; } mixin ExampleRef on AutoDisposeProviderRef { diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index 5773207f2..d2ba91ec8 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -77,6 +77,9 @@ class LabelFamily extends Family { Override overrideWith(String Function(LabelRef ref) create) { return _$LabelFamilyOverride(this, create); } + + @override + String toString() => 'labelProvider'; } class _$LabelFamilyOverride implements FamilyOverride { @@ -93,6 +96,9 @@ class _$LabelFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'labelProvider.overrideWith($create)'; } /// See also [label]. @@ -184,6 +190,9 @@ class LabelProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'labelProvider$argument'; } mixin LabelRef on AutoDisposeProviderRef { diff --git a/website/docs/essentials/passing_args/codegen/family.g.dart b/website/docs/essentials/passing_args/codegen/family.g.dart index 9daa74dde..8ad73822f 100644 --- a/website/docs/essentials/passing_args/codegen/family.g.dart +++ b/website/docs/essentials/passing_args/codegen/family.g.dart @@ -77,6 +77,9 @@ class ActivityFamily extends Family { Override overrideWith(FutureOr Function(ActivityRef ref) create) { return _$ActivityFamilyOverride(this, create); } + + @override + String toString() => 'activityProvider'; } class _$ActivityFamilyOverride implements FamilyOverride { @@ -93,6 +96,9 @@ class _$ActivityFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'activityProvider.overrideWith($create)'; } /// See also [activity]. @@ -184,6 +190,9 @@ class ActivityProvider extends AutoDisposeFutureProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'activityProvider$argument'; } mixin ActivityRef on AutoDisposeFutureProviderRef { diff --git a/website/docs/essentials/passing_args/codegen/provider.g.dart b/website/docs/essentials/passing_args/codegen/provider.g.dart index 54c2f5141..a0bb83691 100644 --- a/website/docs/essentials/passing_args/codegen/provider.g.dart +++ b/website/docs/essentials/passing_args/codegen/provider.g.dart @@ -100,6 +100,9 @@ class ActivityNotifier2Family extends Family { Override overrideWith(ActivityNotifier2 Function() create) { return _$ActivityNotifier2FamilyOverride(this, create); } + + @override + String toString() => 'activityNotifier2Provider'; } class _$ActivityNotifier2FamilyOverride implements FamilyOverride { @@ -116,6 +119,9 @@ class _$ActivityNotifier2FamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'activityNotifier2Provider.overrideWith($create)'; } /// See also [ActivityNotifier2]. @@ -215,6 +221,9 @@ class ActivityNotifier2Provider return _SystemHash.finish(hash); } + + @override + String toString() => 'activityNotifier2Provider$argument'; } mixin ActivityNotifier2Ref on AutoDisposeAsyncNotifierProviderRef { diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index 9f8886727..6d0ac7450 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -80,6 +80,9 @@ class RandomFamily extends Family { Override overrideWith(int Function(RandomRef ref) create) { return _$RandomFamilyOverride(this, create); } + + @override + String toString() => 'randomProvider'; } class _$RandomFamilyOverride implements FamilyOverride { @@ -96,6 +99,9 @@ class _$RandomFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'randomProvider.overrideWith($create)'; } /// See also [random]. @@ -201,6 +207,9 @@ class RandomProvider extends AutoDisposeProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'randomProvider$argument'; } mixin RandomRef on AutoDisposeProviderRef { diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index 342aab3b7..dbf930ffd 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -81,6 +81,9 @@ class FetchPackagesFamily extends Family { FutureOr> Function(FetchPackagesRef ref) create) { return _$FetchPackagesFamilyOverride(this, create); } + + @override + String toString() => 'fetchPackagesProvider'; } class _$FetchPackagesFamilyOverride implements FamilyOverride { @@ -97,6 +100,9 @@ class _$FetchPackagesFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'fetchPackagesProvider.overrideWith($create)'; } /// See also [fetchPackages]. @@ -205,6 +211,9 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { return _SystemHash.finish(hash); } + + @override + String toString() => 'fetchPackagesProvider$argument'; } mixin FetchPackagesRef on AutoDisposeFutureProviderRef> { diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index cb1ae6e03..cf552683e 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -87,6 +87,9 @@ class BugsEncounteredNotifierFamily extends Family { Override overrideWith(BugsEncounteredNotifier Function() create) { return _$BugsEncounteredNotifierFamilyOverride(this, create); } + + @override + String toString() => 'bugsEncounteredNotifierProvider'; } class _$BugsEncounteredNotifierFamilyOverride implements FamilyOverride { @@ -103,6 +106,9 @@ class _$BugsEncounteredNotifierFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'bugsEncounteredNotifierProvider.overrideWith($create)'; } /// See also [BugsEncounteredNotifier]. @@ -202,6 +208,9 @@ class BugsEncounteredNotifierProvider return _SystemHash.finish(hash); } + + @override + String toString() => 'bugsEncounteredNotifierProvider$argument'; } mixin BugsEncounteredNotifierRef on AutoDisposeAsyncNotifierProviderRef { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 0b9b8e941..faa289a58 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -77,6 +77,9 @@ class FetchUserFamily extends Family { Override overrideWith(FutureOr Function(FetchUserRef ref) create) { return _$FetchUserFamilyOverride(this, create); } + + @override + String toString() => 'fetchUserProvider'; } class _$FetchUserFamilyOverride implements FamilyOverride { @@ -93,6 +96,9 @@ class _$FetchUserFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'fetchUserProvider.overrideWith($create)'; } /// See also [fetchUser]. @@ -186,6 +192,9 @@ class FetchUserProvider extends AutoDisposeFutureProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'fetchUserProvider$argument'; } mixin FetchUserRef on AutoDisposeFutureProviderRef { diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 0b9b8e941..faa289a58 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -77,6 +77,9 @@ class FetchUserFamily extends Family { Override overrideWith(FutureOr Function(FetchUserRef ref) create) { return _$FetchUserFamilyOverride(this, create); } + + @override + String toString() => 'fetchUserProvider'; } class _$FetchUserFamilyOverride implements FamilyOverride { @@ -93,6 +96,9 @@ class _$FetchUserFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'fetchUserProvider.overrideWith($create)'; } /// See also [fetchUser]. @@ -186,6 +192,9 @@ class FetchUserProvider extends AutoDisposeFutureProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'fetchUserProvider$argument'; } mixin FetchUserRef on AutoDisposeFutureProviderRef { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 0b9b8e941..faa289a58 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -77,6 +77,9 @@ class FetchUserFamily extends Family { Override overrideWith(FutureOr Function(FetchUserRef ref) create) { return _$FetchUserFamilyOverride(this, create); } + + @override + String toString() => 'fetchUserProvider'; } class _$FetchUserFamilyOverride implements FamilyOverride { @@ -93,6 +96,9 @@ class _$FetchUserFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'fetchUserProvider.overrideWith($create)'; } /// See also [fetchUser]. @@ -186,6 +192,9 @@ class FetchUserProvider extends AutoDisposeFutureProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'fetchUserProvider$argument'; } mixin FetchUserRef on AutoDisposeFutureProviderRef { diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 0b9b8e941..faa289a58 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -77,6 +77,9 @@ class FetchUserFamily extends Family { Override overrideWith(FutureOr Function(FetchUserRef ref) create) { return _$FetchUserFamilyOverride(this, create); } + + @override + String toString() => 'fetchUserProvider'; } class _$FetchUserFamilyOverride implements FamilyOverride { @@ -93,6 +96,9 @@ class _$FetchUserFamilyOverride implements FamilyOverride { ) { return provider._copyWith(create); } + + @override + String toString() => 'fetchUserProvider.overrideWith($create)'; } /// See also [fetchUser]. @@ -186,6 +192,9 @@ class FetchUserProvider extends AutoDisposeFutureProvider { return _SystemHash.finish(hash); } + + @override + String toString() => 'fetchUserProvider$argument'; } mixin FetchUserRef on AutoDisposeFutureProviderRef { From 783f1f0e26e2a9359edb27c669ab5af3ffe55e38 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 28 Dec 2023 13:22:44 +0100 Subject: [PATCH 097/387] Override update --- examples/pub/lib/detail.g.dart | 35 +--- examples/pub/lib/search.g.dart | 18 +- .../auto_dispose.dart | 27 +-- .../change_notifier_provider/base.dart | 27 +-- packages/riverpod/lib/src/core/family.dart | 122 +++++++------ packages/riverpod/lib/src/core/override.dart | 125 ++++++++------ .../lib/src/core/override_with_value.dart | 1 - packages/riverpod/lib/src/core/provider.dart | 2 +- .../lib/src/core/provider_container.dart | 44 ++--- .../async_notifier/auto_dispose_family.dart | 29 ++-- .../async_notifier/family.dart | 27 +-- .../state_notifier_provider/auto_dispose.dart | 27 +-- .../state_notifier_provider/base.dart | 26 +-- .../state_provider/auto_dispose.dart | 26 +-- .../deprecated/state_provider/base.dart | 26 +-- .../future_provider/auto_dispose.dart | 26 +-- .../future_provider/base.dart | 26 +-- .../notifier/auto_dispose_family.dart | 27 +-- .../src/legacy_providers/notifier/family.dart | 28 +-- .../provider/auto_dispose.dart | 26 +-- .../src/legacy_providers/provider/base.dart | 26 +-- .../stream_notifier/auto_dispose_family.dart | 29 ++-- .../stream_notifier/family.dart | 27 +-- .../stream_provider/auto_dispose.dart | 26 +-- .../stream_provider/base.dart | 26 +-- .../integration/build_yaml/lib/main.g.dart | 104 +++--------- .../lib/src/templates/family.dart | 28 +-- .../test/integration/annotated.g.dart | 34 +--- .../test/integration/async.g.dart | 107 +++--------- .../test/integration/dependencies.g.dart | 51 ++---- .../test/integration/dependencies2.g.dart | 35 +--- .../test/integration/generated.g.dart | 121 +++---------- .../test/integration/stream.g.dart | 73 ++------ .../test/integration/sync.g.dart | 160 ++++-------------- .../generated/golden/lib/sync.g.dart | 42 +---- ..._class_based_provider_to_functional.g.dart | 33 +--- ..._functional_provider_to_class_based.g.dart | 18 +- .../avoid_build_context_in_providers.g.dart | 36 +--- .../avoid_public_notifier_properties.g.dart | 17 +- .../test/lints/dependencies.g.dart | 34 +--- .../functional_ref/functional_ref.g.dart | 60 ++----- .../notifier_extends/notifier_extends.g.dart | 60 ++----- .../protected_notifier_properties.g.dart | 102 +++-------- .../test/lints/provider_parameters.g.dart | 17 +- .../docs/concepts/about_codegen/main.g.dart | 17 +- .../about_codegen/provider_type/family.g.dart | 17 +- .../provider_type/family_class.g.dart | 18 +- .../provider_type/family_fn.g.dart | 18 +- .../invalidate_family_example/codegen.g.dart | 17 +- .../passing_args/codegen/family.g.dart | 17 +- .../passing_args/codegen/provider.g.dart | 18 +- .../docs/from_provider/family/family.g.dart | 18 +- .../introduction/why_riverpod/codegen.g.dart | 18 +- .../family_and_dispose.g.dart | 18 +- .../current/about_codegen/main.g.dart | 17 +- .../current/about_codegen/main.g.dart | 17 +- .../current/about_codegen/main.g.dart | 17 +- .../current/about_codegen/main.g.dart | 17 +- 58 files changed, 761 insertions(+), 1444 deletions(-) diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 6c4feef84..0bac74e70 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -64,16 +64,6 @@ class FetchPackageDetailsFamily extends Family { ); } - @visibleForOverriding - @override - FetchPackageDetailsProvider getProviderOverride( - covariant FetchPackageDetailsProvider provider, - ) { - return call( - packageName: provider.packageName, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith( FutureOr Function(FetchPackageDetailsRef ref) create) { @@ -93,10 +83,11 @@ class _$FetchPackageDetailsFamilyOverride implements FamilyOverride { final FetchPackageDetailsFamily from; @override - FetchPackageDetailsProvider getProviderOverride( + _FetchPackageDetailsProviderElement createElement( + ProviderContainer container, covariant FetchPackageDetailsProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -163,7 +154,7 @@ class FetchPackageDetailsProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement( + _FetchPackageDetailsProviderElement createElement( ProviderContainer container, ) { return _FetchPackageDetailsProviderElement(this, container); @@ -312,16 +303,6 @@ class PackageMetricsFamily extends Family { ); } - @visibleForOverriding - @override - PackageMetricsProvider getProviderOverride( - covariant PackageMetricsProvider provider, - ) { - return call( - packageName: provider.packageName, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(PackageMetrics Function() create) { return _$PackageMetricsFamilyOverride(this, create); @@ -340,10 +321,11 @@ class _$PackageMetricsFamilyOverride implements FamilyOverride { final PackageMetricsFamily from; @override - PackageMetricsProvider getProviderOverride( + _PackageMetricsProviderElement createElement( + ProviderContainer container, covariant PackageMetricsProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -427,8 +409,7 @@ class PackageMetricsProvider extends AutoDisposeAsyncNotifierProviderImpl< } @override - AutoDisposeAsyncNotifierProviderElement - createElement( + _PackageMetricsProviderElement createElement( ProviderContainer container, ) { return _PackageMetricsProviderElement(this, container); diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 8fcf3e883..98dbd30e3 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -65,17 +65,6 @@ class FetchPackagesFamily extends Family { ); } - @visibleForOverriding - @override - FetchPackagesProvider getProviderOverride( - covariant FetchPackagesProvider provider, - ) { - return call( - page: provider.page, - search: provider.search, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith( FutureOr> Function(FetchPackagesRef ref) create) { @@ -95,10 +84,11 @@ class _$FetchPackagesFamilyOverride implements FamilyOverride { final FetchPackagesFamily from; @override - FetchPackagesProvider getProviderOverride( + _FetchPackagesProviderElement createElement( + ProviderContainer container, covariant FetchPackagesProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -175,7 +165,7 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { } @override - AutoDisposeFutureProviderElement> createElement( + _FetchPackagesProviderElement createElement( ProviderContainer container, ) { return _FetchPackagesProviderElement(this, container); diff --git a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart index 233133783..e0505782a 100644 --- a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart +++ b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart @@ -122,18 +122,21 @@ class AutoDisposeChangeNotifierProviderFamily>( - this, - (arg) => AutoDisposeChangeNotifierProvider.internal( - (ref) => create(ref, arg), - from: from, - argument: arg, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as AutoDisposeChangeNotifierProvider; + + return AutoDisposeChangeNotifierProvider.internal( + (ref) => create(ref, provider.argument as Arg), + from: provider.from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart index 39bc9af29..acb5253f9 100644 --- a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart +++ b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart @@ -262,18 +262,21 @@ class ChangeNotifierProviderFamily NotifierT Function(ChangeNotifierProviderRef ref, Arg arg) create, ) { - return FamilyOverrideImpl>( - this, - (arg) => ChangeNotifierProvider.internal( - (ref) => create(ref, arg), - from: from, - argument: arg, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ChangeNotifierProvider; + + return ChangeNotifierProvider.internal( + (ref) => create(ref, provider.argument as Arg), + from: provider.from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index c32f5993a..f0c27ee7d 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -31,7 +31,7 @@ typedef ProviderNotifierCreate = ProviderT typedef FamilyCreate = T Function(R ref, Arg arg); /// A base class for all families -abstract class Family implements FamilyOverride, ProviderOrFamily { +abstract class Family implements _FamilyOverride, ProviderOrFamily { /// A base class for all families const Family(); @@ -39,21 +39,6 @@ abstract class Family implements FamilyOverride, ProviderOrFamily { Family get from => this; } -mixin _FamilyMixin> - on Family { - /// Create a provider from an external value. - /// - /// That external value should be immutable and preferably override `==`/`hashCode`. - /// See the documentation of [Provider.family] for more information. - FamilyProvider call(Arg argument); - - @visibleForOverriding - @override - ProviderBase getProviderOverride(ProviderBase provider) { - return call(provider.argument as Arg); - } -} - /// Setup how a family is overridden @internal typedef SetupFamilyOverride = void Function( @@ -70,8 +55,7 @@ typedef SetupFamilyOverride = void Function( /// This API is not meant for public consumption. @internal class FamilyBase, R, Arg, Created, - ProviderT extends ProviderBase> extends Family - with _FamilyMixin { + ProviderT extends ProviderBase> extends Family { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. /// @@ -89,16 +73,23 @@ class FamilyBase, R, Arg, Created, final Created Function(RefT ref, Arg arg) _createFn; - @override - ProviderT call(Arg argument) => _providerFactory( - (ref) => _createFn(ref, argument), - name: name, - from: this, - argument: argument, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - ); + /// {@template family.call} + /// Create a provider from an external value. + /// + /// That external value should be immutable and preferably override `==`/`hashCode`. + /// See the documentation of [Provider.family] for more information. + /// {@endtemplate} + ProviderT call(Arg argument) { + return _providerFactory( + (ref) => _createFn(ref, argument), + name: name, + from: this, + argument: argument, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + ); + } @override final String? name; @@ -119,8 +110,7 @@ class FamilyBase, R, Arg, Created, @internal class AutoDisposeFamilyBase, R, Arg, Created, - ProviderT extends ProviderBase> extends Family - with _FamilyMixin { + ProviderT extends ProviderBase> extends Family { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. /// @@ -138,16 +128,18 @@ class AutoDisposeFamilyBase, R, Arg, Created, final Created Function(RefT ref, Arg arg) _createFn; - @override - ProviderT call(Arg argument) => _providerFactory( - (ref) => _createFn(ref, argument), - name: name, - from: this, - argument: argument, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - ); + /// {@macro family.call} + ProviderT call(Arg argument) { + return _providerFactory( + (ref) => _createFn(ref, argument), + name: name, + from: this, + argument: argument, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + ); + } @override final String? name; @@ -168,8 +160,7 @@ class AutoDisposeFamilyBase, R, Arg, Created, /// This API is not meant for public consumption. @internal class AutoDisposeNotifierFamilyBase, R, Arg, NotifierT, - ProviderT extends ProviderBase> extends Family - with _FamilyMixin { + ProviderT extends ProviderBase> extends Family { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. /// @@ -187,16 +178,18 @@ class AutoDisposeNotifierFamilyBase, R, Arg, NotifierT, final NotifierT Function() _createFn; - @override - ProviderT call(Arg argument) => _providerFactory( - _createFn, - name: name, - from: this, - argument: argument, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - ); + /// {@macro family.call} + ProviderT call(Arg argument) { + return _providerFactory( + _createFn, + name: name, + from: this, + argument: argument, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + ); + } @override final String? name; @@ -217,8 +210,7 @@ class AutoDisposeNotifierFamilyBase, R, Arg, NotifierT, /// This API is not meant for public consumption. @internal class NotifierFamilyBase, R, Arg, NotifierT, - ProviderT extends ProviderBase> extends Family - with _FamilyMixin { + ProviderT extends ProviderBase> extends Family { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. /// @@ -236,16 +228,18 @@ class NotifierFamilyBase, R, Arg, NotifierT, final NotifierT Function() _createFn; - @override - ProviderT call(Arg argument) => _providerFactory( - _createFn, - name: name, - from: this, - argument: argument, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - ); + /// {@macro family.call} + ProviderT call(Arg argument) { + return _providerFactory( + _createFn, + name: name, + from: this, + argument: argument, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + ); + } @override final String? name; diff --git a/packages/riverpod/lib/src/core/override.dart b/packages/riverpod/lib/src/core/override.dart index 195544d32..5d701dcdc 100644 --- a/packages/riverpod/lib/src/core/override.dart +++ b/packages/riverpod/lib/src/core/override.dart @@ -6,6 +6,41 @@ part of '../framework.dart'; /// Do not extend or implement. sealed class Override {} +sealed class _ProviderOverride implements Override {} + +extension on _ProviderOverride { + /// The provider that is overridden. + ProviderBase get origin { + final that = this; + return switch (that) { + ProviderBase() => that, + ProviderOverride() => that.origin, + }; + } + + /// The new provider behavior. + ProviderBase get providerOverride { + final that = this; + return switch (that) { + ProviderBase() => that, + ProviderOverride() => that.providerOverride, + }; + } +} + +sealed class _FamilyOverride implements Override {} + +extension on _FamilyOverride { + /// The provider that is overridden. + Family get from { + final that = this; + return switch (that) { + Family() => that, + FamilyOverride() => that.from, + }; + } +} + /// An object used by [ProviderContainer] to override the behavior of a provider /// for a part of the application. /// @@ -15,17 +50,9 @@ sealed class Override {} /// /// - [ProviderContainer], which uses this object. /// - `overrideWithValue`, which creates a [ProviderOverride]. -@internal -sealed class ProviderOverride implements Override { - factory ProviderOverride({ - required ProviderBase origin, - required ProviderBase providerOverride, - }) = _ProviderOverrideBase; -} - -class _ProviderOverrideBase implements ProviderOverride { +class ProviderOverride implements _ProviderOverride { /// Override a provider - _ProviderOverrideBase({ + ProviderOverride({ required this.origin, required this.providerOverride, }); @@ -45,7 +72,7 @@ class _ProviderOverrideBase implements ProviderOverride { /// When a provider is automatically scoped due to specifying `dependencies`. @internal -class TransitiveProviderOverride implements _ProviderOverrideBase { +class TransitiveProviderOverride implements ProviderOverride { TransitiveProviderOverride(this.origin); @override @@ -55,37 +82,27 @@ class TransitiveProviderOverride implements _ProviderOverrideBase { ProviderBase get providerOverride => origin; } -extension on ProviderOverride { - /// The provider that is overridden. - ProviderBase get origin { - final that = this; - return switch (that) { - ProviderBase() => that, - _ProviderOverrideBase() => that.origin, - }; - } - - /// The new provider behavior. - ProviderBase get providerOverride { - final that = this; - return switch (that) { - ProviderBase() => that, - _ProviderOverrideBase() => that.providerOverride, - }; - } -} - /// Do not use: Internal object to used by [ProviderContainer]/`ProviderScope` /// to override the behavior of a "family" for part of the application. @internal -abstract class FamilyOverride implements Override { +abstract class FamilyOverride implements _FamilyOverride { + factory FamilyOverride({ + required ProviderElementBase Function( + ProviderContainer container, + ProviderBase provider, + ) createElement, + required Family from, + }) = _FamilyOverrideImpl; + /// The family that was overridden. // TODO make all fields private Family get from; - /// Obtains the new behavior for a provider associated to the overridden family. - @visibleForOverriding - ProviderBase getProviderOverride(ProviderBase provider); + /// The overridden [ProviderBase.createElement]. + ProviderElementBase createElement( + ProviderContainer container, + ProviderBase provider, + ); @mustBeOverridden @override @@ -100,29 +117,39 @@ class TransitiveFamilyOverride implements FamilyOverride { final Family from; @override - ProviderBase getProviderOverride(ProviderBase provider) { - return provider; + ProviderElementBase createElement( + ProviderContainer container, + ProviderBase provider, + ) { + return provider.createElement(container); } } /// An [Override] for families -@internal -class FamilyOverrideImpl> - implements FamilyOverride { +class _FamilyOverrideImpl implements FamilyOverride { /// An [Override] for families // ignore: library_private_types_in_public_api - FamilyOverrideImpl(this.from, this._newCreate); - - final FamilyProvider Function(Arg arg) _newCreate; + _FamilyOverrideImpl({ + required ProviderElementBase Function( + ProviderContainer container, + ProviderBase provider, + ) createElement, + required this.from, + }) : _createElement = createElement; @override - // ignore: library_private_types_in_public_api - final _FamilyMixin from; + final Family from; + + final ProviderElementBase Function( + ProviderContainer container, + ProviderBase provider, + ) _createElement; - @visibleForOverriding @override - ProviderBase getProviderOverride(ProviderBase provider) { - final arg = provider.argument as Arg; - return _newCreate(arg); + ProviderElementBase createElement( + ProviderContainer container, + ProviderBase provider, + ) { + return _createElement(container, provider); } } diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index 5136b4656..b94f09ece 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -41,7 +41,6 @@ mixin OverrideWithValueMixin on ProviderBase { ); } - @mustBeOverridden @override String toString(); } diff --git a/packages/riverpod/lib/src/core/provider.dart b/packages/riverpod/lib/src/core/provider.dart index bb6338b7c..2a6611b25 100644 --- a/packages/riverpod/lib/src/core/provider.dart +++ b/packages/riverpod/lib/src/core/provider.dart @@ -27,7 +27,7 @@ typedef DebugGetCreateSourceHash = String Function(); @immutable abstract class ProviderBase extends ProviderOrFamily with ProviderListenable - implements Refreshable, ProviderOverride { + implements Refreshable, _ProviderOverride { /// A base class for _all_ providers. const ProviderBase({ required super.name, diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index a4ab979a5..eb00b7374 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -12,10 +12,6 @@ ProviderBase? _circularDependencyLock; abstract class _PointerBase { /// The container in which the element of this provider will be mounted. ProviderContainer get targetContainer; - - // /// The container that owns this pointer. - // /// May be equal to [targetContainer] or one of its children. - // ProviderContainer get ownerContainer; } @internal @@ -23,7 +19,6 @@ class ProviderPointer implements _PointerBase { ProviderPointer({ required this.providerOverride, required this.targetContainer, - // required this.ownerContainer, }); /// The override associated with this provider, if any. @@ -31,12 +26,10 @@ class ProviderPointer implements _PointerBase { /// If non-null, this pointer should **never** be removed. /// /// This override may be implicitly created by [ProviderOrFamily.allTransitiveDependencies]. - ProviderOverride? providerOverride; + _ProviderOverride? providerOverride; ProviderElementBase? element; @override final ProviderContainer targetContainer; - // @override - // final ProviderContainer ownerContainer; @override String toString() { @@ -44,7 +37,6 @@ class ProviderPointer implements _PointerBase { buffer.writeln('ProviderPointer$hashCode('); buffer.writeln(' targetContainer: $targetContainer'); - // buffer.writeln(' ownerContainer: $ownerContainer'); buffer.writeln(' override: $providerOverride'); buffer.writeln(' element: $element'); @@ -117,13 +109,13 @@ class ProviderDirectory implements _PointerBase { /// If non-null, this pointer should **never** be removed. /// /// This override may be implicitly created by [ProviderOrFamily.allTransitiveDependencies]. - FamilyOverride? familyOverride; + _FamilyOverride? familyOverride; final HashMap, ProviderPointer> pointers; @override final ProviderContainer targetContainer; void addProviderOverride( - ProviderOverride override, { + _ProviderOverride override, { required ProviderContainer targetContainer, }) { final origin = override.origin; @@ -171,11 +163,25 @@ class ProviderDirectory implements _PointerBase { ); if (pointer.element == null) { + ProviderElementBase? element; + + switch ((pointer.providerOverride, familyOverride)) { + case (final override?, _): + element = + override.providerOverride.createElement(pointer.targetContainer); + + case (null, final FamilyOverride override): + element = override.createElement(pointer.targetContainer, origin); + + case (null, _FamilyOverride() || null): + element = origin.createElement(pointer.targetContainer); + } + final overrideProvider = pointer.providerOverride?.providerOverride ?? origin; // TODO test family(42) overrides on nested containers receive the correct container - final element = overrideProvider.createElement(pointer.targetContainer) + element // TODO remove .._provider = overrideProvider // TODO remove @@ -273,7 +279,7 @@ class ProviderPointerManager { final HashMap familyPointers; void _initializeProviderOverride( - ProviderOverride override, + _ProviderOverride override, ) { final from = override.origin.from; @@ -300,9 +306,9 @@ class ProviderPointerManager { void _initializeOverrides(List overrides) { for (final override in overrides) { switch (override) { - case ProviderOverride(): + case _ProviderOverride(): _initializeProviderOverride(override); - case FamilyOverride(): + case _FamilyOverride(): final overriddenFamily = override.from; final previousPointer = familyPointers[overriddenFamily]; @@ -549,7 +555,7 @@ class ProviderContainer implements Node { final overrideOrigins = {}; for (final override in overrides) { switch (override) { - case ProviderOverride(): + case _ProviderOverride(): if (parent != null && override.origin.allTransitiveDependencies == null && override.origin.from?.allTransitiveDependencies == null) { @@ -563,7 +569,7 @@ class ProviderContainer implements Node { 'Tried to override a provider twice within the same container: ${override.origin}', ); } - case FamilyOverride(): + case _FamilyOverride(): if (parent != null && override.from.allTransitiveDependencies == null) { throw AssertionError( @@ -852,7 +858,7 @@ class ProviderContainer implements Node { } switch (override) { - case ProviderOverride(): + case _ProviderOverride(): final pointer = _pointerManager.readPointer(override.origin); if (kDebugMode) { @@ -869,7 +875,7 @@ class ProviderContainer implements Node { runUnaryGuarded(element.update, override.providerOverride); - case FamilyOverride(): + case _FamilyOverride(): // TODO assert family override did not change final pointer = _pointerManager.familyPointers[override.from]; diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose_family.dart index 1386fff06..5ef690d46 100644 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose_family.dart +++ b/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose_family.dart @@ -108,19 +108,22 @@ class AutoDisposeAsyncNotifierProviderFamily< /// {@macro riverpod.override_with} Override overrideWith(NotifierT Function() create) { - return FamilyOverrideImpl, Arg, - AutoDisposeFamilyAsyncNotifierProvider>( - this, - (arg) => - AutoDisposeFamilyAsyncNotifierProvider.internal( - create, - from: from, - argument: arg, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as AutoDisposeFamilyAsyncNotifierProvider; + + return AutoDisposeFamilyAsyncNotifierProvider.internal( + create, + from: provider.from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart index 6e6404565..fb3e93524 100644 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart @@ -114,18 +114,21 @@ class AsyncNotifierProviderFamily, /// {@macro riverpod.override_with} Override overrideWith(NotifierT Function() create) { - return FamilyOverrideImpl, Arg, - AsyncNotifierFamilyProvider>( - this, - (arg) => AsyncNotifierFamilyProvider.internal( - create, - from: from, - argument: arg, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as AsyncNotifierFamilyProvider; + + return AsyncNotifierFamilyProvider.internal( + create, + from: from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/auto_dispose.dart index f629fe6c0..88da7802f 100644 --- a/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/auto_dispose.dart @@ -116,18 +116,21 @@ class AutoDisposeStateNotifierProviderFamily, Arg arg, ) create, ) { - return FamilyOverrideImpl>( - this, - (arg) => AutoDisposeStateNotifierProvider.internal( - (ref) => create(ref, arg), - from: from, - argument: arg, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as AutoDisposeStateNotifierProvider; + + return AutoDisposeStateNotifierProvider.internal( + (ref) => create(ref, provider.argument as Arg), + from: provider.from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart index 834a23297..5f0f0220c 100644 --- a/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart @@ -229,17 +229,21 @@ class StateNotifierProviderFamily, T, Arg> NotifierT Function(StateNotifierProviderRef ref, Arg arg) create, ) { - return FamilyOverrideImpl>( - this, - (arg) => StateNotifierProvider.internal( - (ref) => create(ref, arg), - from: from, - argument: arg, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as StateNotifierProvider; + + return StateNotifierProvider.internal( + (ref) => create(ref, provider.argument as Arg), + from: provider.from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/auto_dispose.dart index a06caa7b6..3649e75eb 100644 --- a/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/auto_dispose.dart @@ -99,17 +99,21 @@ class AutoDisposeStateProviderFamily extends AutoDisposeFamilyBase< Override overrideWith( R Function(AutoDisposeStateProviderRef ref, Arg arg) create, ) { - return FamilyOverrideImpl>( - this, - (arg) => AutoDisposeStateProvider.internal( - (ref) => create(ref, arg), - from: from, - argument: arg, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as AutoDisposeStateProvider; + + return AutoDisposeStateProvider.internal( + (ref) => create(ref, provider.argument as Arg), + from: provider.from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart index abeb963f8..1475ac3d3 100644 --- a/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart @@ -191,17 +191,21 @@ class StateProviderFamily Override overrideWith( R Function(StateProviderRef ref, Arg arg) create, ) { - return FamilyOverrideImpl>( - this, - (arg) => StateProvider.internal( - (ref) => create(ref, arg), - from: from, - argument: arg, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as StateProvider; + + return StateProvider.internal( + (ref) => create(ref, provider.argument as Arg), + from: provider.from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/future_provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/future_provider/auto_dispose.dart index f67c8df2c..c880f0e60 100644 --- a/packages/riverpod/lib/src/legacy_providers/future_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/legacy_providers/future_provider/auto_dispose.dart @@ -117,17 +117,21 @@ class AutoDisposeFutureProviderFamily extends AutoDisposeFamilyBase< Override overrideWith( FutureOr Function(AutoDisposeFutureProviderRef ref, Arg arg) create, ) { - return FamilyOverrideImpl, Arg, AutoDisposeFutureProvider>( - this, - (arg) => AutoDisposeFutureProvider.internal( - (ref) => create(ref, arg), - from: from, - argument: arg, - debugGetCreateSourceHash: null, - dependencies: null, - allTransitiveDependencies: null, - name: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as AutoDisposeFutureProvider; + + return AutoDisposeFutureProvider.internal( + (ref) => create(ref, provider.argument as Arg), + from: provider.from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/future_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/future_provider/base.dart index 7f6954f12..9211fac34 100644 --- a/packages/riverpod/lib/src/legacy_providers/future_provider/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/future_provider/base.dart @@ -143,17 +143,21 @@ class FutureProviderFamily extends FamilyBase, Override overrideWith( FutureOr Function(FutureProviderRef ref, Arg arg) create, ) { - return FamilyOverrideImpl, Arg, FutureProvider>( - this, - (arg) => FutureProvider.internal( - (ref) => create(ref, arg), - from: from, - argument: arg, - debugGetCreateSourceHash: null, - dependencies: null, - allTransitiveDependencies: null, - name: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FutureProvider; + + return FutureProvider.internal( + (ref) => create(ref, provider.argument as Arg), + from: provider.from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose_family.dart index 28c1bed16..7215d63cf 100644 --- a/packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose_family.dart +++ b/packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose_family.dart @@ -110,18 +110,21 @@ class AutoDisposeNotifierProviderFamily< /// {@macro riverpod.override_with} Override overrideWith(NotifierT Function() create) { - return FamilyOverrideImpl>( - this, - (arg) => AutoDisposeFamilyNotifierProvider.internal( - create, - from: from, - argument: arg, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as AutoDisposeFamilyNotifierProvider; + + return AutoDisposeFamilyNotifierProvider.internal( + create, + from: from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/notifier/family.dart b/packages/riverpod/lib/src/legacy_providers/notifier/family.dart index 7e2815406..66d036677 100644 --- a/packages/riverpod/lib/src/legacy_providers/notifier/family.dart +++ b/packages/riverpod/lib/src/legacy_providers/notifier/family.dart @@ -111,18 +111,22 @@ class NotifierProviderFamily, T, Arg> /// {@macro riverpod.override_with} Override overrideWith(NotifierT Function() create) { - return FamilyOverrideImpl>( - this, - (arg) => NotifierFamilyProvider.internal( - create, - from: from, - argument: arg, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), + // TODO fix up nootifier names + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as NotifierProviderFamily; + + return NotifierFamilyProvider.internal( + create, + from: from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/provider/auto_dispose.dart index 7a45b2bce..6ec2418c6 100644 --- a/packages/riverpod/lib/src/legacy_providers/provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/legacy_providers/provider/auto_dispose.dart @@ -96,17 +96,21 @@ class AutoDisposeProviderFamily extends AutoDisposeFamilyBase< Override overrideWith( R Function(AutoDisposeProviderRef ref, Arg arg) create, ) { - return FamilyOverrideImpl>( - this, - (arg) => AutoDisposeProvider.internal( - (ref) => create(ref, arg), - from: from, - argument: arg, - name: null, - debugGetCreateSourceHash: null, - dependencies: null, - allTransitiveDependencies: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as AutoDisposeProvider; + + return AutoDisposeProvider.internal( + (ref) => create(ref, provider.argument as Arg), + from: provider.from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/provider/base.dart b/packages/riverpod/lib/src/legacy_providers/provider/base.dart index 08818bbdd..6a623c431 100644 --- a/packages/riverpod/lib/src/legacy_providers/provider/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/provider/base.dart @@ -376,17 +376,21 @@ class ProviderFamily Override overrideWith( R Function(ProviderRef ref, Arg arg) create, ) { - return FamilyOverrideImpl>( - this, - (arg) => Provider.internal( - (ref) => create(ref, arg), - from: from, - argument: arg, - name: name, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Provider; + + return Provider.internal( + (ref) => create(ref, provider.argument as Arg), + from: provider.from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose_family.dart index 60c1bb2bf..3703a8f98 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose_family.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose_family.dart @@ -103,19 +103,22 @@ class AutoDisposeStreamNotifierProviderFamily< /// {@macro riverpod.override_with} Override overrideWith(NotifierT Function() create) { - return FamilyOverrideImpl, Arg, - AutoDisposeFamilyStreamNotifierProvider>( - this, - (arg) => - AutoDisposeFamilyStreamNotifierProvider.internal( - create, - from: from, - argument: arg, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as AutoDisposeFamilyStreamNotifierProvider; + + return AutoDisposeFamilyStreamNotifierProvider.internal( + create, + from: provider.from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/stream_notifier/family.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/family.dart index c26df5328..6477a805d 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_notifier/family.dart @@ -110,18 +110,21 @@ class StreamNotifierProviderFamily< /// {@macro riverpod.override_with} Override overrideWith(NotifierT Function() create) { - return FamilyOverrideImpl, Arg, - StreamNotifierFamilyProvider>( - this, - (arg) => StreamNotifierFamilyProvider.internal( - create, - from: from, - argument: arg, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as StreamNotifierFamilyProvider; + + return StreamNotifierFamilyProvider.internal( + create, + from: from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/stream_provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/stream_provider/auto_dispose.dart index c6348f770..4f157efa7 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_provider/auto_dispose.dart @@ -104,17 +104,21 @@ class AutoDisposeStreamProviderFamily extends AutoDisposeFamilyBase< Override overrideWith( Stream Function(AutoDisposeStreamProviderRef ref, Arg arg) create, ) { - return FamilyOverrideImpl, Arg, AutoDisposeStreamProvider>( - this, - (arg) => AutoDisposeStreamProvider.internal( - (ref) => create(ref, arg), - from: from, - argument: arg, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as AutoDisposeStreamProvider; + + return AutoDisposeStreamProvider.internal( + (ref) => create(ref, provider.argument as Arg), + from: provider.from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart index 3ac295ed8..a5bc6c30b 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart @@ -224,17 +224,21 @@ class StreamProviderFamily extends FamilyBase, Override overrideWith( Stream Function(StreamProviderRef ref, Arg arg) create, ) { - return FamilyOverrideImpl, Arg, StreamProvider>( - this, - (arg) => StreamProvider.internal( - (ref) => create(ref, arg), - from: from, - argument: arg, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as StreamProvider; + + return StreamProvider.internal( + (ref) => create(ref, provider.argument as Arg), + from: provider.from, + argument: provider.argument, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, ); } } diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index a90a68ee1..d4165f1e7 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -103,16 +103,6 @@ class Count2Family extends Family { ); } - @visibleForOverriding - @override - Count2Provider getProviderOverride( - covariant Count2Provider provider, - ) { - return call( - provider.a, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(int Function(Count2Ref ref) create) { return _$Count2FamilyOverride(this, create); @@ -131,10 +121,11 @@ class _$Count2FamilyOverride implements FamilyOverride { final Count2Family from; @override - Count2Provider getProviderOverride( + _Count2ProviderElement createElement( + ProviderContainer container, covariant Count2Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -198,7 +189,7 @@ class Count2Provider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _Count2ProviderElement createElement( ProviderContainer container, ) { return _Count2ProviderElement(this, container); @@ -282,16 +273,6 @@ class CountFuture2Family extends Family { ); } - @visibleForOverriding - @override - CountFuture2Provider getProviderOverride( - covariant CountFuture2Provider provider, - ) { - return call( - provider.a, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(FutureOr Function(CountFuture2Ref ref) create) { return _$CountFuture2FamilyOverride(this, create); @@ -310,10 +291,11 @@ class _$CountFuture2FamilyOverride implements FamilyOverride { final CountFuture2Family from; @override - CountFuture2Provider getProviderOverride( + _CountFuture2ProviderElement createElement( + ProviderContainer container, covariant CountFuture2Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -378,7 +360,7 @@ class CountFuture2Provider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement( + _CountFuture2ProviderElement createElement( ProviderContainer container, ) { return _CountFuture2ProviderElement(this, container); @@ -462,16 +444,6 @@ class CountStream2Family extends Family { ); } - @visibleForOverriding - @override - CountStream2Provider getProviderOverride( - covariant CountStream2Provider provider, - ) { - return call( - provider.a, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(Stream Function(CountStream2Ref ref) create) { return _$CountStream2FamilyOverride(this, create); @@ -490,10 +462,11 @@ class _$CountStream2FamilyOverride implements FamilyOverride { final CountStream2Family from; @override - CountStream2Provider getProviderOverride( + _CountStream2ProviderElement createElement( + ProviderContainer container, covariant CountStream2Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -558,7 +531,7 @@ class CountStream2Provider extends AutoDisposeStreamProvider { } @override - AutoDisposeStreamProviderElement createElement( + _CountStream2ProviderElement createElement( ProviderContainer container, ) { return _CountStream2ProviderElement(this, container); @@ -700,16 +673,6 @@ class CountNotifier2Family extends Family { ); } - @visibleForOverriding - @override - CountNotifier2Provider getProviderOverride( - covariant CountNotifier2Provider provider, - ) { - return call( - provider.a, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(CountNotifier2 Function() create) { return _$CountNotifier2FamilyOverride(this, create); @@ -728,10 +691,11 @@ class _$CountNotifier2FamilyOverride implements FamilyOverride { final CountNotifier2Family from; @override - CountNotifier2Provider getProviderOverride( + _CountNotifier2ProviderElement createElement( + ProviderContainer container, covariant CountNotifier2Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -801,7 +765,7 @@ class CountNotifier2Provider } @override - AutoDisposeNotifierProviderElement createElement( + _CountNotifier2ProviderElement createElement( ProviderContainer container, ) { return _CountNotifier2ProviderElement(this, container); @@ -896,16 +860,6 @@ class CountAsyncNotifier2Family extends Family { ); } - @visibleForOverriding - @override - CountAsyncNotifier2Provider getProviderOverride( - covariant CountAsyncNotifier2Provider provider, - ) { - return call( - provider.a, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(CountAsyncNotifier2 Function() create) { return _$CountAsyncNotifier2FamilyOverride(this, create); @@ -924,10 +878,11 @@ class _$CountAsyncNotifier2FamilyOverride implements FamilyOverride { final CountAsyncNotifier2Family from; @override - CountAsyncNotifier2Provider getProviderOverride( + _CountAsyncNotifier2ProviderElement createElement( + ProviderContainer container, covariant CountAsyncNotifier2Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -998,8 +953,7 @@ class CountAsyncNotifier2Provider } @override - AutoDisposeAsyncNotifierProviderElement - createElement( + _CountAsyncNotifier2ProviderElement createElement( ProviderContainer container, ) { return _CountAsyncNotifier2ProviderElement(this, container); @@ -1094,16 +1048,6 @@ class CountStreamNotifier2Family extends Family { ); } - @visibleForOverriding - @override - CountStreamNotifier2Provider getProviderOverride( - covariant CountStreamNotifier2Provider provider, - ) { - return call( - provider.a, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(CountStreamNotifier2 Function() create) { return _$CountStreamNotifier2FamilyOverride(this, create); @@ -1122,10 +1066,11 @@ class _$CountStreamNotifier2FamilyOverride implements FamilyOverride { final CountStreamNotifier2Family from; @override - CountStreamNotifier2Provider getProviderOverride( + _CountStreamNotifier2ProviderElement createElement( + ProviderContainer container, covariant CountStreamNotifier2Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -1196,8 +1141,7 @@ class CountStreamNotifier2Provider } @override - AutoDisposeStreamNotifierProviderElement - createElement( + _CountStreamNotifier2ProviderElement createElement( ProviderContainer container, ) { return _CountStreamNotifier2ProviderElement(this, container); diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 606ef7359..0b6992246 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -27,14 +27,6 @@ String genericUsageDisplayString(TypeParameterList? typeParameterList) { return '<${typeParameterList.typeParameters.map((e) => e.name.lexeme).join(', ')}>'; } -String anyGenericUsageDisplayString(TypeParameterList? typeParameterList) { - if (typeParameterList == null) { - return ''; - } - - return '<${typeParameterList.typeParameters.map((e) => e.declaredElement?.bound?.toString() ?? 'Object?').join(', ')}>'; -} - class FamilyTemplate extends Template { FamilyTemplate._( this.provider, { @@ -268,10 +260,6 @@ ${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} final familyName = '${provider.providerElement.name.titled}Family'; final parameterDefinition = buildParamDefinitionQuery(parameters); - final parameterProviderPassThrough = buildParamInvocationQuery({ - for (final parameter in parameters) - parameter: 'provider.${parameter.name}', - }); final parameterThisNamedPassThrough = parameters .map((parameter) => '${parameter.name}: ${parameter.name},') .join(); @@ -289,7 +277,6 @@ ${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} final typeParametersDefinition = genericDefinitionDisplayString(typeParameters); final typeParametersUsage = genericUsageDisplayString(typeParameters); - final anyTypeParametersUsage = anyGenericUsageDisplayString(typeParameters); final argumentRecordType = buildParamDefinitionQuery( parameters, asRecord: true, @@ -341,14 +328,6 @@ class $familyName extends Family { return $providerTypeNameImpl$typeParametersUsage($parametersPassThrough); } - @visibleForOverriding - @override - $providerTypeNameImpl$anyTypeParametersUsage getProviderOverride( - covariant $providerTypeNameImpl$anyTypeParametersUsage provider, - ) { - return call($parameterProviderPassThrough); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith($createType create) { return $familyOverrideClassName(this, create); @@ -367,10 +346,11 @@ class $familyOverrideClassName implements FamilyOverride { final $familyName from; @override - $providerTypeNameImpl getProviderOverride( + $elementNameImpl createElement( + ProviderContainer container, covariant $providerTypeNameImpl provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -415,7 +395,7 @@ $providerOther } @override - $elementType$providerGenerics createElement(ProviderContainer container,) { + $elementNameImpl$typeParametersUsage createElement(ProviderContainer container,) { return $elementNameImpl(this, container); } diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 9f6613681..c0029b491 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -81,16 +81,6 @@ class FamilyFamily extends Family { ); } - @visibleForOverriding - @override - FamilyProvider getProviderOverride( - covariant FamilyProvider provider, - ) { - return call( - provider.id, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(String Function(FamilyRef ref) create) { return _$FamilyFamilyOverride(this, create); @@ -109,10 +99,11 @@ class _$FamilyFamilyOverride implements FamilyOverride { final FamilyFamily from; @override - FamilyProvider getProviderOverride( + _FamilyProviderElement createElement( + ProviderContainer container, covariant FamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -176,7 +167,7 @@ class FamilyProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _FamilyProviderElement createElement( ProviderContainer container, ) { return _FamilyProviderElement(this, container); @@ -276,16 +267,6 @@ class NotCopiedFamilyFamily extends Family { ); } - @visibleForOverriding - @override - NotCopiedFamilyProvider getProviderOverride( - covariant NotCopiedFamilyProvider provider, - ) { - return call( - provider.id, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(String Function(NotCopiedFamilyRef ref) create) { return _$NotCopiedFamilyFamilyOverride(this, create); @@ -304,10 +285,11 @@ class _$NotCopiedFamilyFamilyOverride implements FamilyOverride { final NotCopiedFamilyFamily from; @override - NotCopiedFamilyProvider getProviderOverride( + _NotCopiedFamilyProviderElement createElement( + ProviderContainer container, covariant NotCopiedFamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -372,7 +354,7 @@ class NotCopiedFamilyProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _NotCopiedFamilyProviderElement createElement( ProviderContainer container, ) { return _NotCopiedFamilyProviderElement(this, container); diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index c64518cdd..6105c17e1 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -57,14 +57,6 @@ class GenericFamily extends Family { return GenericProvider(); } - @visibleForOverriding - @override - GenericProvider getProviderOverride( - covariant GenericProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith( FutureOr> Function(GenericRef ref) create) { @@ -84,10 +76,11 @@ class _$GenericFamilyOverride implements FamilyOverride { final GenericFamily from; @override - GenericProvider getProviderOverride( + _GenericProviderElement createElement( + ProviderContainer container, covariant GenericProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -145,7 +138,7 @@ class GenericProvider } @override - AutoDisposeFutureProviderElement> createElement( + _GenericProviderElement createElement( ProviderContainer container, ) { return _GenericProviderElement(this, container); @@ -250,16 +243,6 @@ class FamilyOrFamily extends Family { ); } - @visibleForOverriding - @override - FamilyOrProvider getProviderOverride( - covariant FamilyOrProvider provider, - ) { - return call( - provider.first, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(FutureOr Function(FamilyOrRef ref) create) { return _$FamilyOrFamilyOverride(this, create); @@ -278,10 +261,11 @@ class _$FamilyOrFamilyOverride implements FamilyOverride { final FamilyOrFamily from; @override - FamilyOrProvider getProviderOverride( + _FamilyOrProviderElement createElement( + ProviderContainer container, covariant FamilyOrProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -345,7 +329,7 @@ class FamilyOrProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement( + _FamilyOrProviderElement createElement( ProviderContainer container, ) { return _FamilyOrProviderElement(this, container); @@ -437,20 +421,6 @@ class FamilyFamily extends Family { ); } - @visibleForOverriding - @override - FamilyProvider getProviderOverride( - covariant FamilyProvider provider, - ) { - return call( - provider.first, - second: provider.second, - third: provider.third, - fourth: provider.fourth, - fifth: provider.fifth, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(FutureOr Function(FamilyRef ref) create) { return _$FamilyFamilyOverride(this, create); @@ -469,10 +439,11 @@ class _$FamilyFamilyOverride implements FamilyOverride { final FamilyFamily from; @override - FamilyProvider getProviderOverride( + _FamilyProviderElement createElement( + ProviderContainer container, covariant FamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -572,7 +543,7 @@ class FamilyProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement( + _FamilyProviderElement createElement( ProviderContainer container, ) { return _FamilyProviderElement(this, container); @@ -690,14 +661,6 @@ class GenericClassFamily extends Family { return GenericClassProvider(); } - @visibleForOverriding - @override - GenericClassProvider getProviderOverride( - covariant GenericClassProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(GenericClass Function() create) { return _$GenericClassFamilyOverride(this, create); @@ -716,10 +679,11 @@ class _$GenericClassFamilyOverride implements FamilyOverride { final GenericClassFamily from; @override - GenericClassProvider getProviderOverride( + _GenericClassProviderElement createElement( + ProviderContainer container, covariant GenericClassProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -781,8 +745,7 @@ class GenericClassProvider } @override - AutoDisposeAsyncNotifierProviderElement, List> - createElement( + _GenericClassProviderElement createElement( ProviderContainer container, ) { return _GenericClassProviderElement(this, container); @@ -900,16 +863,6 @@ class FamilyOrClassFamily extends Family { ); } - @visibleForOverriding - @override - FamilyOrClassProvider getProviderOverride( - covariant FamilyOrClassProvider provider, - ) { - return call( - provider.first, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(FamilyOrClass Function() create) { return _$FamilyOrClassFamilyOverride(this, create); @@ -928,10 +881,11 @@ class _$FamilyOrClassFamilyOverride implements FamilyOverride { final FamilyOrClassFamily from; @override - FamilyOrClassProvider getProviderOverride( + _FamilyOrClassProviderElement createElement( + ProviderContainer container, covariant FamilyOrClassProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -1001,7 +955,7 @@ class FamilyOrClassProvider } @override - AutoDisposeAsyncNotifierProviderElement createElement( + _FamilyOrClassProviderElement createElement( ProviderContainer container, ) { return _FamilyOrClassProviderElement(this, container); @@ -1110,20 +1064,6 @@ class FamilyClassFamily extends Family { ); } - @visibleForOverriding - @override - FamilyClassProvider getProviderOverride( - covariant FamilyClassProvider provider, - ) { - return call( - provider.first, - second: provider.second, - third: provider.third, - fourth: provider.fourth, - fifth: provider.fifth, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(FamilyClass Function() create) { return _$FamilyClassFamilyOverride(this, create); @@ -1142,10 +1082,11 @@ class _$FamilyClassFamilyOverride implements FamilyOverride { final FamilyClassFamily from; @override - FamilyClassProvider getProviderOverride( + _FamilyClassProviderElement createElement( + ProviderContainer container, covariant FamilyClassProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -1261,7 +1202,7 @@ class FamilyClassProvider } @override - AutoDisposeAsyncNotifierProviderElement createElement( + _FamilyClassProviderElement createElement( ProviderContainer container, ) { return _FamilyClassProviderElement(this, container); diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index a0797a580..e02881444 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -75,16 +75,6 @@ class FamilyFamily extends Family { ); } - @visibleForOverriding - @override - FamilyProvider getProviderOverride( - covariant FamilyProvider provider, - ) { - return call( - provider.id, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(int Function(FamilyRef ref) create) { return _$FamilyFamilyOverride(this, create); @@ -103,10 +93,11 @@ class _$FamilyFamilyOverride implements FamilyOverride { final FamilyFamily from; @override - FamilyProvider getProviderOverride( + _FamilyProviderElement createElement( + ProviderContainer container, covariant FamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -170,7 +161,7 @@ class FamilyProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _FamilyProviderElement createElement( ProviderContainer container, ) { return _FamilyProviderElement(this, container); @@ -440,16 +431,6 @@ class Family2Family extends Family { ); } - @visibleForOverriding - @override - Family2Provider getProviderOverride( - covariant Family2Provider provider, - ) { - return call( - provider.id, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(Family2 Function() create) { return _$Family2FamilyOverride(this, create); @@ -468,10 +449,11 @@ class _$Family2FamilyOverride implements FamilyOverride { final Family2Family from; @override - Family2Provider getProviderOverride( + _Family2ProviderElement createElement( + ProviderContainer container, covariant Family2Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -539,7 +521,7 @@ class Family2Provider extends AutoDisposeNotifierProviderImpl { } @override - AutoDisposeNotifierProviderElement createElement( + _Family2ProviderElement createElement( ProviderContainer container, ) { return _Family2ProviderElement(this, container); @@ -674,16 +656,6 @@ class Provider4Family extends Family { ); } - @visibleForOverriding - @override - Provider4Provider getProviderOverride( - covariant Provider4Provider provider, - ) { - return call( - provider.id, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(Provider4 Function() create) { return _$Provider4FamilyOverride(this, create); @@ -702,10 +674,11 @@ class _$Provider4FamilyOverride implements FamilyOverride { final Provider4Family from; @override - Provider4Provider getProviderOverride( + _Provider4ProviderElement createElement( + ProviderContainer container, covariant Provider4Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -774,7 +747,7 @@ class Provider4Provider } @override - AutoDisposeNotifierProviderElement createElement( + _Provider4ProviderElement createElement( ProviderContainer container, ) { return _Provider4ProviderElement(this, container); diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 83e0c8cd4..14bd3c252 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -101,16 +101,6 @@ class FamilyWithDependencies2Family extends Family { ); } - @visibleForOverriding - @override - FamilyWithDependencies2Provider getProviderOverride( - covariant FamilyWithDependencies2Provider provider, - ) { - return call( - id: provider.id, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(int Function(FamilyWithDependencies2Ref ref) create) { return _$FamilyWithDependencies2FamilyOverride(this, create); @@ -129,10 +119,11 @@ class _$FamilyWithDependencies2FamilyOverride implements FamilyOverride { final FamilyWithDependencies2Family from; @override - FamilyWithDependencies2Provider getProviderOverride( + _FamilyWithDependencies2ProviderElement createElement( + ProviderContainer container, covariant FamilyWithDependencies2Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -199,7 +190,7 @@ class FamilyWithDependencies2Provider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _FamilyWithDependencies2ProviderElement createElement( ProviderContainer container, ) { return _FamilyWithDependencies2ProviderElement(this, container); @@ -362,16 +353,6 @@ class NotifierFamilyWithDependenciesFamily extends Family { ); } - @visibleForOverriding - @override - NotifierFamilyWithDependenciesProvider getProviderOverride( - covariant NotifierFamilyWithDependenciesProvider provider, - ) { - return call( - id: provider.id, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(NotifierFamilyWithDependencies Function() create) { return _$NotifierFamilyWithDependenciesFamilyOverride(this, create); @@ -390,10 +371,11 @@ class _$NotifierFamilyWithDependenciesFamilyOverride implements FamilyOverride { final NotifierFamilyWithDependenciesFamily from; @override - NotifierFamilyWithDependenciesProvider getProviderOverride( + _NotifierFamilyWithDependenciesProviderElement createElement( + ProviderContainer container, covariant NotifierFamilyWithDependenciesProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -467,8 +449,7 @@ class NotifierFamilyWithDependenciesProvider } @override - AutoDisposeNotifierProviderElement - createElement( + _NotifierFamilyWithDependenciesProviderElement createElement( ProviderContainer container, ) { return _NotifierFamilyWithDependenciesProviderElement(this, container); diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index fa753f3ad..4ae31bb78 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -75,16 +75,6 @@ class GeneratedFamilyFamily extends Family { ); } - @visibleForOverriding - @override - GeneratedFamilyProvider getProviderOverride( - covariant GeneratedFamilyProvider provider, - ) { - return call( - provider.test, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(_Test Function(GeneratedFamilyRef ref) create) { return _$GeneratedFamilyFamilyOverride(this, create); @@ -103,10 +93,11 @@ class _$GeneratedFamilyFamilyOverride implements FamilyOverride { final GeneratedFamilyFamily from; @override - GeneratedFamilyProvider getProviderOverride( + _GeneratedFamilyProviderElement createElement( + ProviderContainer container, covariant GeneratedFamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -171,7 +162,7 @@ class GeneratedFamilyProvider extends AutoDisposeProvider<_Test> { } @override - AutoDisposeProviderElement<_Test> createElement( + _GeneratedFamilyProviderElement createElement( ProviderContainer container, ) { return _GeneratedFamilyProviderElement(this, container); @@ -269,16 +260,6 @@ class $DynamicFamilyFamily extends Family { ); } - @visibleForOverriding - @override - $DynamicFamilyProvider getProviderOverride( - covariant $DynamicFamilyProvider provider, - ) { - return call( - provider.test, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(Object? Function($DynamicFamilyRef ref) create) { return _$$DynamicFamilyFamilyOverride(this, create); @@ -297,10 +278,11 @@ class _$$DynamicFamilyFamilyOverride implements FamilyOverride { final $DynamicFamilyFamily from; @override - $DynamicFamilyProvider getProviderOverride( + _$DynamicFamilyProviderElement createElement( + ProviderContainer container, covariant $DynamicFamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -365,7 +347,7 @@ class $DynamicFamilyProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _$DynamicFamilyProviderElement createElement( ProviderContainer container, ) { return _$DynamicFamilyProviderElement(this, container); @@ -449,16 +431,6 @@ class _DynamicFamily extends Family { ); } - @visibleForOverriding - @override - _DynamicProvider getProviderOverride( - covariant _DynamicProvider provider, - ) { - return call( - provider.test, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(Object? Function(_DynamicRef ref) create) { return _$DynamicFamilyOverride(this, create); @@ -477,10 +449,11 @@ class _$DynamicFamilyOverride implements FamilyOverride { final _DynamicFamily from; @override - _DynamicProvider getProviderOverride( + _DynamicProviderElement createElement( + ProviderContainer container, covariant _DynamicProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -544,7 +517,7 @@ class _DynamicProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _DynamicProviderElement createElement( ProviderContainer container, ) { return _DynamicProviderElement(this, container); @@ -642,16 +615,6 @@ class AliasFamilyFamily extends Family { ); } - @visibleForOverriding - @override - AliasFamilyProvider getProviderOverride( - covariant AliasFamilyProvider provider, - ) { - return call( - provider.test, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(r.AsyncValue Function(AliasFamilyRef ref) create) { return _$AliasFamilyFamilyOverride(this, create); @@ -670,10 +633,11 @@ class _$AliasFamilyFamilyOverride implements FamilyOverride { final AliasFamilyFamily from; @override - AliasFamilyProvider getProviderOverride( + _AliasFamilyProviderElement createElement( + ProviderContainer container, covariant AliasFamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -738,7 +702,7 @@ class AliasFamilyProvider extends AutoDisposeProvider> { } @override - AutoDisposeProviderElement> createElement( + _AliasFamilyProviderElement createElement( ProviderContainer container, ) { return _AliasFamilyProviderElement(this, container); @@ -848,16 +812,6 @@ class GeneratedClassFamilyFamily extends Family { ); } - @visibleForOverriding - @override - GeneratedClassFamilyProvider getProviderOverride( - covariant GeneratedClassFamilyProvider provider, - ) { - return call( - provider.test, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(GeneratedClassFamily Function() create) { return _$GeneratedClassFamilyFamilyOverride(this, create); @@ -876,10 +830,11 @@ class _$GeneratedClassFamilyFamilyOverride implements FamilyOverride { final GeneratedClassFamilyFamily from; @override - GeneratedClassFamilyProvider getProviderOverride( + _GeneratedClassFamilyProviderElement createElement( + ProviderContainer container, covariant GeneratedClassFamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -949,7 +904,7 @@ class GeneratedClassFamilyProvider } @override - AutoDisposeNotifierProviderElement createElement( + _GeneratedClassFamilyProviderElement createElement( ProviderContainer container, ) { return _GeneratedClassFamilyProviderElement(this, container); @@ -1060,16 +1015,6 @@ class $DynamicClassFamilyFamily extends Family { ); } - @visibleForOverriding - @override - $DynamicClassFamilyProvider getProviderOverride( - covariant $DynamicClassFamilyProvider provider, - ) { - return call( - provider.test, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith($DynamicClassFamily Function() create) { return _$$DynamicClassFamilyFamilyOverride(this, create); @@ -1088,10 +1033,11 @@ class _$$DynamicClassFamilyFamilyOverride implements FamilyOverride { final $DynamicClassFamilyFamily from; @override - $DynamicClassFamilyProvider getProviderOverride( + _$DynamicClassFamilyProviderElement createElement( + ProviderContainer container, covariant $DynamicClassFamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -1161,8 +1107,7 @@ class $DynamicClassFamilyProvider } @override - AutoDisposeNotifierProviderElement<$DynamicClassFamily, Object?> - createElement( + _$DynamicClassFamilyProviderElement createElement( ProviderContainer container, ) { return _$DynamicClassFamilyProviderElement(this, container); @@ -1271,16 +1216,6 @@ class AliasClassFamilyFamily extends Family { ); } - @visibleForOverriding - @override - AliasClassFamilyProvider getProviderOverride( - covariant AliasClassFamilyProvider provider, - ) { - return call( - provider.test, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(AliasClassFamily Function() create) { return _$AliasClassFamilyFamilyOverride(this, create); @@ -1299,10 +1234,11 @@ class _$AliasClassFamilyFamilyOverride implements FamilyOverride { final AliasClassFamilyFamily from; @override - AliasClassFamilyProvider getProviderOverride( + _AliasClassFamilyProviderElement createElement( + ProviderContainer container, covariant AliasClassFamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -1372,8 +1308,7 @@ class AliasClassFamilyProvider extends AutoDisposeNotifierProviderImpl< } @override - AutoDisposeNotifierProviderElement> - createElement( + _AliasClassFamilyProviderElement createElement( ProviderContainer container, ) { return _AliasClassFamilyProviderElement(this, container); diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 6d9c3d25f..7b1891902 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -57,14 +57,6 @@ class GenericFamily extends Family { return GenericProvider(); } - @visibleForOverriding - @override - GenericProvider getProviderOverride( - covariant GenericProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith( Stream> Function(GenericRef ref) create) { @@ -84,10 +76,11 @@ class _$GenericFamilyOverride implements FamilyOverride { final GenericFamily from; @override - GenericProvider getProviderOverride( + _GenericProviderElement createElement( + ProviderContainer container, covariant GenericProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -145,7 +138,7 @@ class GenericProvider } @override - AutoDisposeStreamProviderElement> createElement( + _GenericProviderElement createElement( ProviderContainer container, ) { return _GenericProviderElement(this, container); @@ -258,20 +251,6 @@ class FamilyFamily extends Family { ); } - @visibleForOverriding - @override - FamilyProvider getProviderOverride( - covariant FamilyProvider provider, - ) { - return call( - provider.first, - second: provider.second, - third: provider.third, - fourth: provider.fourth, - fifth: provider.fifth, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(Stream Function(FamilyRef ref) create) { return _$FamilyFamilyOverride(this, create); @@ -290,10 +269,11 @@ class _$FamilyFamilyOverride implements FamilyOverride { final FamilyFamily from; @override - FamilyProvider getProviderOverride( + _FamilyProviderElement createElement( + ProviderContainer container, covariant FamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -393,7 +373,7 @@ class FamilyProvider extends AutoDisposeStreamProvider { } @override - AutoDisposeStreamProviderElement createElement( + _FamilyProviderElement createElement( ProviderContainer container, ) { return _FamilyProviderElement(this, container); @@ -511,14 +491,6 @@ class GenericClassFamily extends Family { return GenericClassProvider(); } - @visibleForOverriding - @override - GenericClassProvider getProviderOverride( - covariant GenericClassProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(GenericClass Function() create) { return _$GenericClassFamilyOverride(this, create); @@ -537,10 +509,11 @@ class _$GenericClassFamilyOverride implements FamilyOverride { final GenericClassFamily from; @override - GenericClassProvider getProviderOverride( + _GenericClassProviderElement createElement( + ProviderContainer container, covariant GenericClassProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -602,8 +575,7 @@ class GenericClassProvider } @override - AutoDisposeStreamNotifierProviderElement, List> - createElement( + _GenericClassProviderElement createElement( ProviderContainer container, ) { return _GenericClassProviderElement(this, container); @@ -737,20 +709,6 @@ class FamilyClassFamily extends Family { ); } - @visibleForOverriding - @override - FamilyClassProvider getProviderOverride( - covariant FamilyClassProvider provider, - ) { - return call( - provider.first, - second: provider.second, - third: provider.third, - fourth: provider.fourth, - fifth: provider.fifth, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(FamilyClass Function() create) { return _$FamilyClassFamilyOverride(this, create); @@ -769,10 +727,11 @@ class _$FamilyClassFamilyOverride implements FamilyOverride { final FamilyClassFamily from; @override - FamilyClassProvider getProviderOverride( + _FamilyClassProviderElement createElement( + ProviderContainer container, covariant FamilyClassProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -888,7 +847,7 @@ class FamilyClassProvider } @override - AutoDisposeStreamNotifierProviderElement createElement( + _FamilyClassProviderElement createElement( ProviderContainer container, ) { return _FamilyClassProviderElement(this, container); diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 63568b48e..26362482a 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -57,14 +57,6 @@ class GenericFamily extends Family { return GenericProvider(); } - @visibleForOverriding - @override - GenericProvider getProviderOverride( - covariant GenericProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith( List Function(GenericRef ref) create) { @@ -84,10 +76,11 @@ class _$GenericFamilyOverride implements FamilyOverride { final GenericFamily from; @override - GenericProvider getProviderOverride( + _GenericProviderElement createElement( + ProviderContainer container, covariant GenericProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -144,7 +137,7 @@ class GenericProvider extends AutoDisposeProvider> { } @override - AutoDisposeProviderElement> createElement( + _GenericProviderElement createElement( ProviderContainer container, ) { return _GenericProviderElement(this, container); @@ -223,17 +216,6 @@ class ComplexGenericFamily extends Family { ); } - @visibleForOverriding - @override - ComplexGenericProvider getProviderOverride( - covariant ComplexGenericProvider provider, - ) { - return call( - param: provider.param, - otherParam: provider.otherParam, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith( List Function( @@ -256,10 +238,11 @@ class _$ComplexGenericFamilyOverride implements FamilyOverride { final ComplexGenericFamily from; @override - ComplexGenericProvider getProviderOverride( + _ComplexGenericProviderElement createElement( + ProviderContainer container, covariant ComplexGenericProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -337,7 +320,7 @@ class ComplexGenericProvider } @override - AutoDisposeProviderElement> createElement( + _ComplexGenericProviderElement createElement( ProviderContainer container, ) { return _ComplexGenericProviderElement(this, container); @@ -463,16 +446,6 @@ class RawFamilyFutureFamily extends Family { ); } - @visibleForOverriding - @override - RawFamilyFutureProvider getProviderOverride( - covariant RawFamilyFutureProvider provider, - ) { - return call( - provider.id, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith( Raw> Function(RawFamilyFutureRef ref) create) { @@ -492,10 +465,11 @@ class _$RawFamilyFutureFamilyOverride implements FamilyOverride { final RawFamilyFutureFamily from; @override - RawFamilyFutureProvider getProviderOverride( + _RawFamilyFutureProviderElement createElement( + ProviderContainer container, covariant RawFamilyFutureProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -560,7 +534,7 @@ class RawFamilyFutureProvider extends AutoDisposeProvider>> { } @override - AutoDisposeProviderElement>> createElement( + _RawFamilyFutureProviderElement createElement( ProviderContainer container, ) { return _RawFamilyFutureProviderElement(this, container); @@ -645,16 +619,6 @@ class RawFamilyStreamFamily extends Family { ); } - @visibleForOverriding - @override - RawFamilyStreamProvider getProviderOverride( - covariant RawFamilyStreamProvider provider, - ) { - return call( - provider.id, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith( Raw> Function(RawFamilyStreamRef ref) create) { @@ -674,10 +638,11 @@ class _$RawFamilyStreamFamilyOverride implements FamilyOverride { final RawFamilyStreamFamily from; @override - RawFamilyStreamProvider getProviderOverride( + _RawFamilyStreamProviderElement createElement( + ProviderContainer container, covariant RawFamilyStreamProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -742,7 +707,7 @@ class RawFamilyStreamProvider extends AutoDisposeProvider>> { } @override - AutoDisposeProviderElement>> createElement( + _RawFamilyStreamProviderElement createElement( ProviderContainer container, ) { return _RawFamilyStreamProviderElement(this, container); @@ -874,20 +839,6 @@ class FamilyFamily extends Family { ); } - @visibleForOverriding - @override - FamilyProvider getProviderOverride( - covariant FamilyProvider provider, - ) { - return call( - provider.first, - second: provider.second, - third: provider.third, - fourth: provider.fourth, - fifth: provider.fifth, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(String Function(FamilyRef ref) create) { return _$FamilyFamilyOverride(this, create); @@ -906,10 +857,11 @@ class _$FamilyFamilyOverride implements FamilyOverride { final FamilyFamily from; @override - FamilyProvider getProviderOverride( + _FamilyProviderElement createElement( + ProviderContainer container, covariant FamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -1013,7 +965,7 @@ class FamilyProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _FamilyProviderElement createElement( ProviderContainer container, ) { return _FamilyProviderElement(this, container); @@ -1159,14 +1111,6 @@ class GenericClassFamily extends Family { return GenericClassProvider(); } - @visibleForOverriding - @override - GenericClassProvider getProviderOverride( - covariant GenericClassProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(GenericClass Function() create) { return _$GenericClassFamilyOverride(this, create); @@ -1185,10 +1129,11 @@ class _$GenericClassFamilyOverride implements FamilyOverride { final GenericClassFamily from; @override - GenericClassProvider getProviderOverride( + _GenericClassProviderElement createElement( + ProviderContainer container, covariant GenericClassProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -1250,7 +1195,7 @@ class GenericClassProvider } @override - AutoDisposeNotifierProviderElement, List> createElement( + _GenericClassProviderElement createElement( ProviderContainer container, ) { return _GenericClassProviderElement(this, container); @@ -1371,16 +1316,6 @@ class RawFamilyFutureClassFamily extends Family { ); } - @visibleForOverriding - @override - RawFamilyFutureClassProvider getProviderOverride( - covariant RawFamilyFutureClassProvider provider, - ) { - return call( - provider.id, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(RawFamilyFutureClass Function() create) { return _$RawFamilyFutureClassFamilyOverride(this, create); @@ -1399,10 +1334,11 @@ class _$RawFamilyFutureClassFamilyOverride implements FamilyOverride { final RawFamilyFutureClassFamily from; @override - RawFamilyFutureClassProvider getProviderOverride( + _RawFamilyFutureClassProviderElement createElement( + ProviderContainer container, covariant RawFamilyFutureClassProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -1472,8 +1408,7 @@ class RawFamilyFutureClassProvider extends AutoDisposeNotifierProviderImpl< } @override - AutoDisposeNotifierProviderElement>> - createElement( + _RawFamilyFutureClassProviderElement createElement( ProviderContainer container, ) { return _RawFamilyFutureClassProviderElement(this, container); @@ -1569,16 +1504,6 @@ class RawFamilyStreamClassFamily extends Family { ); } - @visibleForOverriding - @override - RawFamilyStreamClassProvider getProviderOverride( - covariant RawFamilyStreamClassProvider provider, - ) { - return call( - provider.id, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(RawFamilyStreamClass Function() create) { return _$RawFamilyStreamClassFamilyOverride(this, create); @@ -1597,10 +1522,11 @@ class _$RawFamilyStreamClassFamilyOverride implements FamilyOverride { final RawFamilyStreamClassFamily from; @override - RawFamilyStreamClassProvider getProviderOverride( + _RawFamilyStreamClassProviderElement createElement( + ProviderContainer container, covariant RawFamilyStreamClassProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -1670,8 +1596,7 @@ class RawFamilyStreamClassProvider extends AutoDisposeNotifierProviderImpl< } @override - AutoDisposeNotifierProviderElement>> - createElement( + _RawFamilyStreamClassProviderElement createElement( ProviderContainer container, ) { return _RawFamilyStreamClassProviderElement(this, container); @@ -1821,20 +1746,6 @@ class FamilyClassFamily extends Family { ); } - @visibleForOverriding - @override - FamilyClassProvider getProviderOverride( - covariant FamilyClassProvider provider, - ) { - return call( - provider.first, - second: provider.second, - third: provider.third, - fourth: provider.fourth, - fifth: provider.fifth, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(FamilyClass Function() create) { return _$FamilyClassFamilyOverride(this, create); @@ -1853,10 +1764,11 @@ class _$FamilyClassFamilyOverride implements FamilyOverride { final FamilyClassFamily from; @override - FamilyClassProvider getProviderOverride( + _FamilyClassProviderElement createElement( + ProviderContainer container, covariant FamilyClassProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -1976,7 +1888,7 @@ class FamilyClassProvider } @override - AutoDisposeNotifierProviderElement createElement( + _FamilyClassProviderElement createElement( ProviderContainer container, ) { return _FamilyClassProviderElement(this, container); diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 6b54664fc..4a82b3968 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -110,20 +110,6 @@ class FamilyFamily extends Family { ); } - @visibleForOverriding - @override - FamilyProvider getProviderOverride( - covariant FamilyProvider provider, - ) { - return call( - provider.first, - second: provider.second, - third: provider.third, - forth: provider.forth, - fifth: provider.fifth, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(String Function(FamilyRef ref) create) { return _$FamilyFamilyOverride(this, create); @@ -142,10 +128,11 @@ class _$FamilyFamilyOverride implements FamilyOverride { final FamilyFamily from; @override - FamilyProvider getProviderOverride( + _FamilyProviderElement createElement( + ProviderContainer container, covariant FamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -249,7 +236,7 @@ class FamilyProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _FamilyProviderElement createElement( ProviderContainer container, ) { return _FamilyProviderElement(this, container); @@ -444,20 +431,6 @@ class FamilyClassFamily extends Family { ); } - @visibleForOverriding - @override - FamilyClassProvider getProviderOverride( - covariant FamilyClassProvider provider, - ) { - return call( - provider.first, - second: provider.second, - third: provider.third, - forth: provider.forth, - fifth: provider.fifth, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(FamilyClass Function() create) { return _$FamilyClassFamilyOverride(this, create); @@ -476,10 +449,11 @@ class _$FamilyClassFamilyOverride implements FamilyOverride { final FamilyClassFamily from; @override - FamilyClassProvider getProviderOverride( + _FamilyClassProviderElement createElement( + ProviderContainer container, covariant FamilyClassProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -599,7 +573,7 @@ class FamilyClassProvider } @override - AutoDisposeNotifierProviderElement createElement( + _FamilyClassProviderElement createElement( ProviderContainer container, ) { return _FamilyClassProviderElement(this, container); diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index a5b69a397..91fc4b883 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -97,17 +97,6 @@ class ExampleFamilyFamily extends Family { ); } - @visibleForOverriding - @override - ExampleFamilyProvider getProviderOverride( - covariant ExampleFamilyProvider provider, - ) { - return call( - a: provider.a, - b: provider.b, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(ExampleFamily Function() create) { return _$ExampleFamilyFamilyOverride(this, create); @@ -126,10 +115,11 @@ class _$ExampleFamilyFamilyOverride implements FamilyOverride { final ExampleFamilyFamily from; @override - ExampleFamilyProvider getProviderOverride( + _ExampleFamilyProviderElement createElement( + ProviderContainer container, covariant ExampleFamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -219,7 +209,7 @@ class ExampleFamilyProvider } @override - AutoDisposeNotifierProviderElement createElement( + _ExampleFamilyProviderElement createElement( ProviderContainer container, ) { return _ExampleFamilyProviderElement(this, container); @@ -313,14 +303,6 @@ class GenericFamily extends Family { return GenericProvider(); } - @visibleForOverriding - @override - GenericProvider getProviderOverride( - covariant GenericProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(Generic Function() create) { return _$GenericFamilyOverride(this, create); @@ -339,10 +321,11 @@ class _$GenericFamilyOverride implements FamilyOverride { final GenericFamily from; @override - GenericProvider getProviderOverride( + _GenericProviderElement createElement( + ProviderContainer container, covariant GenericProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -403,7 +386,7 @@ class GenericProvider } @override - AutoDisposeNotifierProviderElement, int> createElement( + _GenericProviderElement createElement( ProviderContainer container, ) { return _GenericProviderElement(this, container); diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index b44574a1d..fd59e0c50 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -87,17 +87,6 @@ class ExampleFamilyFamily extends Family { ); } - @visibleForOverriding - @override - ExampleFamilyProvider getProviderOverride( - covariant ExampleFamilyProvider provider, - ) { - return call( - a: provider.a, - b: provider.b, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(int Function(ExampleFamilyRef ref) create) { return _$ExampleFamilyFamilyOverride(this, create); @@ -116,10 +105,11 @@ class _$ExampleFamilyFamilyOverride implements FamilyOverride { final ExampleFamilyFamily from; @override - ExampleFamilyProvider getProviderOverride( + _ExampleFamilyProviderElement createElement( + ProviderContainer container, covariant ExampleFamilyProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -200,7 +190,7 @@ class ExampleFamilyProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _ExampleFamilyProviderElement createElement( ProviderContainer container, ) { return _ExampleFamilyProviderElement(this, container); diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index e886bd3da..4642c78f8 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -63,17 +63,6 @@ class FnFamily extends Family { ); } - @visibleForOverriding - @override - FnProvider getProviderOverride( - covariant FnProvider provider, - ) { - return call( - provider.context1, - context2: provider.context2, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(int Function(FnRef ref) create) { return _$FnFamilyOverride(this, create); @@ -92,10 +81,11 @@ class _$FnFamilyOverride implements FamilyOverride { final FnFamily from; @override - FnProvider getProviderOverride( + _FnProviderElement createElement( + ProviderContainer container, covariant FnProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -169,7 +159,7 @@ class FnProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _FnProviderElement createElement( ProviderContainer container, ) { return _FnProviderElement(this, container); @@ -273,17 +263,6 @@ class MyNotifierFamily extends Family { ); } - @visibleForOverriding - @override - MyNotifierProvider getProviderOverride( - covariant MyNotifierProvider provider, - ) { - return call( - provider.context1, - context2: provider.context2, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(MyNotifier Function() create) { return _$MyNotifierFamilyOverride(this, create); @@ -302,10 +281,11 @@ class _$MyNotifierFamilyOverride implements FamilyOverride { final MyNotifierFamily from; @override - MyNotifierProvider getProviderOverride( + _MyNotifierProviderElement createElement( + ProviderContainer container, covariant MyNotifierProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -391,7 +371,7 @@ class MyNotifierProvider } @override - AutoDisposeNotifierProviderElement createElement( + _MyNotifierProviderElement createElement( ProviderContainer container, ) { return _MyNotifierProviderElement(this, container); diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index 03531574e..113e55cdd 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -69,16 +69,6 @@ class GeneratedNotifierFamily extends Family { ); } - @visibleForOverriding - @override - GeneratedNotifierProvider getProviderOverride( - covariant GeneratedNotifierProvider provider, - ) { - return call( - provider.param, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(GeneratedNotifier Function() create) { return _$GeneratedNotifierFamilyOverride(this, create); @@ -97,10 +87,11 @@ class _$GeneratedNotifierFamilyOverride implements FamilyOverride { final GeneratedNotifierFamily from; @override - GeneratedNotifierProvider getProviderOverride( + _GeneratedNotifierProviderElement createElement( + ProviderContainer container, covariant GeneratedNotifierProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -170,7 +161,7 @@ class GeneratedNotifierProvider } @override - AutoDisposeNotifierProviderElement createElement( + _GeneratedNotifierProviderElement createElement( ProviderContainer container, ) { return _GeneratedNotifierProviderElement(this, container); diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index 57687e220..df03cdf2e 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -445,16 +445,6 @@ class FamilyDepFamily extends Family { ); } - @visibleForOverriding - @override - FamilyDepProvider getProviderOverride( - covariant FamilyDepProvider provider, - ) { - return call( - provider.p, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(int Function(FamilyDepRef ref) create) { return _$FamilyDepFamilyOverride(this, create); @@ -473,10 +463,11 @@ class _$FamilyDepFamilyOverride implements FamilyOverride { final FamilyDepFamily from; @override - FamilyDepProvider getProviderOverride( + _FamilyDepProviderElement createElement( + ProviderContainer container, covariant FamilyDepProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -540,7 +531,7 @@ class FamilyDepProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _FamilyDepProviderElement createElement( ProviderContainer container, ) { return _FamilyDepProviderElement(this, container); @@ -630,16 +621,6 @@ class FamilyDep2Family extends Family { ); } - @visibleForOverriding - @override - FamilyDep2Provider getProviderOverride( - covariant FamilyDep2Provider provider, - ) { - return call( - provider.p, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(int Function(FamilyDep2Ref ref) create) { return _$FamilyDep2FamilyOverride(this, create); @@ -658,10 +639,11 @@ class _$FamilyDep2FamilyOverride implements FamilyOverride { final FamilyDep2Family from; @override - FamilyDep2Provider getProviderOverride( + _FamilyDep2ProviderElement createElement( + ProviderContainer container, covariant FamilyDep2Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -726,7 +708,7 @@ class FamilyDep2Provider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _FamilyDep2ProviderElement createElement( ProviderContainer container, ) { return _FamilyDep2ProviderElement(this, container); diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 367ca1641..2aef68e7c 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -88,14 +88,6 @@ class GenericsFamily extends Family { return GenericsProvider(); } - @visibleForOverriding - @override - GenericsProvider getProviderOverride( - covariant GenericsProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith( int Function(GenericsRef ref) create) { @@ -115,10 +107,11 @@ class _$GenericsFamilyOverride implements FamilyOverride { final GenericsFamily from; @override - GenericsProvider getProviderOverride( + _GenericsProviderElement createElement( + ProviderContainer container, covariant GenericsProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -175,7 +168,7 @@ class GenericsProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _GenericsProviderElement createElement( ProviderContainer container, ) { return _GenericsProviderElement(this, container); @@ -249,14 +242,6 @@ class NoGenericsFamily extends Family { return NoGenericsProvider(); } - @visibleForOverriding - @override - NoGenericsProvider getProviderOverride( - covariant NoGenericsProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith( int Function(NoGenericsRef ref) create) { @@ -276,10 +261,11 @@ class _$NoGenericsFamilyOverride implements FamilyOverride { final NoGenericsFamily from; @override - NoGenericsProvider getProviderOverride( + _NoGenericsProviderElement createElement( + ProviderContainer container, covariant NoGenericsProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -337,7 +323,7 @@ class NoGenericsProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _NoGenericsProviderElement createElement( ProviderContainer container, ) { return _NoGenericsProviderElement(this, container); @@ -411,14 +397,6 @@ class MissingGenericsFamily extends Family { return MissingGenericsProvider(); } - @visibleForOverriding - @override - MissingGenericsProvider getProviderOverride( - covariant MissingGenericsProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(int Function(MissingGenericsRef ref) create) { return _$MissingGenericsFamilyOverride(this, create); @@ -437,10 +415,11 @@ class _$MissingGenericsFamilyOverride implements FamilyOverride { final MissingGenericsFamily from; @override - MissingGenericsProvider getProviderOverride( + _MissingGenericsProviderElement createElement( + ProviderContainer container, covariant MissingGenericsProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -498,7 +477,7 @@ class MissingGenericsProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _MissingGenericsProviderElement createElement( ProviderContainer container, ) { return _MissingGenericsProviderElement(this, container); @@ -572,14 +551,6 @@ class WrongOrderFamily extends Family { return WrongOrderProvider(); } - @visibleForOverriding - @override - WrongOrderProvider getProviderOverride( - covariant WrongOrderProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(int Function(WrongOrderRef ref) create) { return _$WrongOrderFamilyOverride(this, create); @@ -598,10 +569,11 @@ class _$WrongOrderFamilyOverride implements FamilyOverride { final WrongOrderFamily from; @override - WrongOrderProvider getProviderOverride( + _WrongOrderProviderElement createElement( + ProviderContainer container, covariant WrongOrderProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -659,7 +631,7 @@ class WrongOrderProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _WrongOrderProviderElement createElement( ProviderContainer container, ) { return _WrongOrderProviderElement(this, container); diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart index 02e36d5e7..3f1cda270 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart @@ -121,14 +121,6 @@ class GenericsFamily extends Family { return GenericsProvider(); } - @visibleForOverriding - @override - GenericsProvider getProviderOverride( - covariant GenericsProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(Generics Function() create) { return _$GenericsFamilyOverride(this, create); @@ -147,10 +139,11 @@ class _$GenericsFamilyOverride implements FamilyOverride { final GenericsFamily from; @override - GenericsProvider getProviderOverride( + _GenericsProviderElement createElement( + ProviderContainer container, covariant GenericsProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -211,7 +204,7 @@ class GenericsProvider } @override - AutoDisposeNotifierProviderElement, int> createElement( + _GenericsProviderElement createElement( ProviderContainer container, ) { return _GenericsProviderElement(this, container); @@ -291,14 +284,6 @@ class NoGenericsFamily extends Family { return NoGenericsProvider(); } - @visibleForOverriding - @override - NoGenericsProvider getProviderOverride( - covariant NoGenericsProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(NoGenerics Function() create) { return _$NoGenericsFamilyOverride(this, create); @@ -317,10 +302,11 @@ class _$NoGenericsFamilyOverride implements FamilyOverride { final NoGenericsFamily from; @override - NoGenericsProvider getProviderOverride( + _NoGenericsProviderElement createElement( + ProviderContainer container, covariant NoGenericsProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -382,7 +368,7 @@ class NoGenericsProvider } @override - AutoDisposeNotifierProviderElement, int> createElement( + _NoGenericsProviderElement createElement( ProviderContainer container, ) { return _NoGenericsProviderElement(this, container); @@ -462,14 +448,6 @@ class MissingGenericsFamily extends Family { return MissingGenericsProvider(); } - @visibleForOverriding - @override - MissingGenericsProvider getProviderOverride( - covariant MissingGenericsProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(MissingGenerics Function() create) { return _$MissingGenericsFamilyOverride(this, create); @@ -488,10 +466,11 @@ class _$MissingGenericsFamilyOverride implements FamilyOverride { final MissingGenericsFamily from; @override - MissingGenericsProvider getProviderOverride( + _MissingGenericsProviderElement createElement( + ProviderContainer container, covariant MissingGenericsProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -553,7 +532,7 @@ class MissingGenericsProvider } @override - AutoDisposeNotifierProviderElement, int> createElement( + _MissingGenericsProviderElement createElement( ProviderContainer container, ) { return _MissingGenericsProviderElement(this, container); @@ -632,14 +611,6 @@ class WrongOrderFamily extends Family { return WrongOrderProvider(); } - @visibleForOverriding - @override - WrongOrderProvider getProviderOverride( - covariant WrongOrderProvider provider, - ) { - return call(); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(WrongOrder Function() create) { return _$WrongOrderFamilyOverride(this, create); @@ -658,10 +629,11 @@ class _$WrongOrderFamilyOverride implements FamilyOverride { final WrongOrderFamily from; @override - WrongOrderProvider getProviderOverride( + _WrongOrderProviderElement createElement( + ProviderContainer container, covariant WrongOrderProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -723,7 +695,7 @@ class WrongOrderProvider } @override - AutoDisposeNotifierProviderElement, int> createElement( + _WrongOrderProviderElement createElement( ProviderContainer container, ) { return _WrongOrderProviderElement(this, container); diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index c796ba9ca..c6c749ced 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -97,16 +97,6 @@ class A3Family extends Family { ); } - @visibleForOverriding - @override - A3Provider getProviderOverride( - covariant A3Provider provider, - ) { - return call( - provider.param, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(A3 Function() create) { return _$A3FamilyOverride(this, create); @@ -125,10 +115,11 @@ class _$A3FamilyOverride implements FamilyOverride { final A3Family from; @override - A3Provider getProviderOverride( + _A3ProviderElement createElement( + ProviderContainer container, covariant A3Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -194,7 +185,7 @@ class A3Provider extends AutoDisposeNotifierProviderImpl { } @override - AutoDisposeNotifierProviderElement createElement( + _A3ProviderElement createElement( ProviderContainer container, ) { return _A3ProviderElement(this, container); @@ -286,16 +277,6 @@ class A4Family extends Family { ); } - @visibleForOverriding - @override - A4Provider getProviderOverride( - covariant A4Provider provider, - ) { - return call( - provider.param, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(A4 Function() create) { return _$A4FamilyOverride(this, create); @@ -314,10 +295,11 @@ class _$A4FamilyOverride implements FamilyOverride { final A4Family from; @override - A4Provider getProviderOverride( + _A4ProviderElement createElement( + ProviderContainer container, covariant A4Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -383,7 +365,7 @@ class A4Provider extends NotifierProviderImpl { } @override - NotifierProviderElement createElement( + _A4ProviderElement createElement( ProviderContainer container, ) { return _A4ProviderElement(this, container); @@ -474,16 +456,6 @@ class A5Family extends Family { ); } - @visibleForOverriding - @override - A5Provider getProviderOverride( - covariant A5Provider provider, - ) { - return call( - provider.param, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(A5 Function() create) { return _$A5FamilyOverride(this, create); @@ -502,10 +474,11 @@ class _$A5FamilyOverride implements FamilyOverride { final A5Family from; @override - A5Provider getProviderOverride( + _A5ProviderElement createElement( + ProviderContainer container, covariant A5Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -571,7 +544,7 @@ class A5Provider extends AutoDisposeAsyncNotifierProviderImpl { } @override - AutoDisposeAsyncNotifierProviderElement createElement( + _A5ProviderElement createElement( ProviderContainer container, ) { return _A5ProviderElement(this, container); @@ -663,16 +636,6 @@ class A6Family extends Family { ); } - @visibleForOverriding - @override - A6Provider getProviderOverride( - covariant A6Provider provider, - ) { - return call( - provider.param, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(A6 Function() create) { return _$A6FamilyOverride(this, create); @@ -691,10 +654,11 @@ class _$A6FamilyOverride implements FamilyOverride { final A6Family from; @override - A6Provider getProviderOverride( + _A6ProviderElement createElement( + ProviderContainer container, covariant A6Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -760,7 +724,7 @@ class A6Provider extends AsyncNotifierProviderImpl { } @override - AsyncNotifierProviderElement createElement( + _A6ProviderElement createElement( ProviderContainer container, ) { return _A6ProviderElement(this, container); @@ -852,16 +816,6 @@ class A7Family extends Family { ); } - @visibleForOverriding - @override - A7Provider getProviderOverride( - covariant A7Provider provider, - ) { - return call( - provider.param, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(A7 Function() create) { return _$A7FamilyOverride(this, create); @@ -880,10 +834,11 @@ class _$A7FamilyOverride implements FamilyOverride { final A7Family from; @override - A7Provider getProviderOverride( + _A7ProviderElement createElement( + ProviderContainer container, covariant A7Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -949,7 +904,7 @@ class A7Provider extends AutoDisposeStreamNotifierProviderImpl { } @override - AutoDisposeStreamNotifierProviderElement createElement( + _A7ProviderElement createElement( ProviderContainer container, ) { return _A7ProviderElement(this, container); @@ -1041,16 +996,6 @@ class A8Family extends Family { ); } - @visibleForOverriding - @override - A8Provider getProviderOverride( - covariant A8Provider provider, - ) { - return call( - provider.param, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(A8 Function() create) { return _$A8FamilyOverride(this, create); @@ -1069,10 +1014,11 @@ class _$A8FamilyOverride implements FamilyOverride { final A8Family from; @override - A8Provider getProviderOverride( + _A8ProviderElement createElement( + ProviderContainer container, covariant A8Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -1138,7 +1084,7 @@ class A8Provider extends StreamNotifierProviderImpl { } @override - StreamNotifierProviderElement createElement( + _A8ProviderElement createElement( ProviderContainer container, ) { return _A8ProviderElement(this, container); diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index cc4ae1727..fe3a1984d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -61,16 +61,6 @@ class GeneratorFamily extends Family { ); } - @visibleForOverriding - @override - GeneratorProvider getProviderOverride( - covariant GeneratorProvider provider, - ) { - return call( - value: provider.value, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(int Function(GeneratorRef ref) create) { return _$GeneratorFamilyOverride(this, create); @@ -89,10 +79,11 @@ class _$GeneratorFamilyOverride implements FamilyOverride { final GeneratorFamily from; @override - GeneratorProvider getProviderOverride( + _GeneratorProviderElement createElement( + ProviderContainer container, covariant GeneratorProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -158,7 +149,7 @@ class GeneratorProvider extends Provider { } @override - ProviderElement createElement( + _GeneratorProviderElement createElement( ProviderContainer container, ) { return _GeneratorProviderElement(this, container); diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index faa289a58..818bba960 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -63,16 +63,6 @@ class FetchUserFamily extends Family { ); } - @visibleForOverriding - @override - FetchUserProvider getProviderOverride( - covariant FetchUserProvider provider, - ) { - return call( - userId: provider.userId, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(FutureOr Function(FetchUserRef ref) create) { return _$FetchUserFamilyOverride(this, create); @@ -91,10 +81,11 @@ class _$FetchUserFamilyOverride implements FamilyOverride { final FetchUserFamily from; @override - FetchUserProvider getProviderOverride( + _FetchUserProviderElement createElement( + ProviderContainer container, covariant FetchUserProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -160,7 +151,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement( + _FetchUserProviderElement createElement( ProviderContainer container, ) { return _FetchUserProviderElement(this, container); diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 728bdca7c..9cbebfeae 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -63,16 +63,6 @@ class ExampleFamily extends Family { ); } - @visibleForOverriding - @override - ExampleProvider getProviderOverride( - covariant ExampleProvider provider, - ) { - return call( - provider.param, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(String Function(ExampleRef ref) create) { return _$ExampleFamilyOverride(this, create); @@ -91,10 +81,11 @@ class _$ExampleFamilyOverride implements FamilyOverride { final ExampleFamily from; @override - ExampleProvider getProviderOverride( + _ExampleProviderElement createElement( + ProviderContainer container, covariant ExampleProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -158,7 +149,7 @@ class ExampleProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _ExampleProviderElement createElement( ProviderContainer container, ) { return _ExampleProviderElement(this, container); diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index fb018792b..c581bc045 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -75,17 +75,6 @@ class ExampleFamily extends Family { ); } - @visibleForOverriding - @override - ExampleProvider getProviderOverride( - covariant ExampleProvider provider, - ) { - return call( - provider.param1, - param2: provider.param2, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(Example Function() create) { return _$ExampleFamilyOverride(this, create); @@ -104,10 +93,11 @@ class _$ExampleFamilyOverride implements FamilyOverride { final ExampleFamily from; @override - ExampleProvider getProviderOverride( + _ExampleProviderElement createElement( + ProviderContainer container, covariant ExampleProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -191,7 +181,7 @@ class ExampleProvider extends AutoDisposeNotifierProviderImpl { } @override - AutoDisposeNotifierProviderElement createElement( + _ExampleProviderElement createElement( ProviderContainer container, ) { return _ExampleProviderElement(this, container); diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index b82556129..fca2832c0 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -65,17 +65,6 @@ class ExampleFamily extends Family { ); } - @visibleForOverriding - @override - ExampleProvider getProviderOverride( - covariant ExampleProvider provider, - ) { - return call( - provider.param1, - param2: provider.param2, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(String Function(ExampleRef ref) create) { return _$ExampleFamilyOverride(this, create); @@ -94,10 +83,11 @@ class _$ExampleFamilyOverride implements FamilyOverride { final ExampleFamily from; @override - ExampleProvider getProviderOverride( + _ExampleProviderElement createElement( + ProviderContainer container, covariant ExampleProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -173,7 +163,7 @@ class ExampleProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _ExampleProviderElement createElement( ProviderContainer container, ) { return _ExampleProviderElement(this, container); diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index d2ba91ec8..c6837d4b7 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -63,16 +63,6 @@ class LabelFamily extends Family { ); } - @visibleForOverriding - @override - LabelProvider getProviderOverride( - covariant LabelProvider provider, - ) { - return call( - provider.userName, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(String Function(LabelRef ref) create) { return _$LabelFamilyOverride(this, create); @@ -91,10 +81,11 @@ class _$LabelFamilyOverride implements FamilyOverride { final LabelFamily from; @override - LabelProvider getProviderOverride( + _LabelProviderElement createElement( + ProviderContainer container, covariant LabelProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -158,7 +149,7 @@ class LabelProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _LabelProviderElement createElement( ProviderContainer container, ) { return _LabelProviderElement(this, container); diff --git a/website/docs/essentials/passing_args/codegen/family.g.dart b/website/docs/essentials/passing_args/codegen/family.g.dart index 8ad73822f..ba220d2b1 100644 --- a/website/docs/essentials/passing_args/codegen/family.g.dart +++ b/website/docs/essentials/passing_args/codegen/family.g.dart @@ -63,16 +63,6 @@ class ActivityFamily extends Family { ); } - @visibleForOverriding - @override - ActivityProvider getProviderOverride( - covariant ActivityProvider provider, - ) { - return call( - provider.activityType, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(FutureOr Function(ActivityRef ref) create) { return _$ActivityFamilyOverride(this, create); @@ -91,10 +81,11 @@ class _$ActivityFamilyOverride implements FamilyOverride { final ActivityFamily from; @override - ActivityProvider getProviderOverride( + _ActivityProviderElement createElement( + ProviderContainer container, covariant ActivityProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -158,7 +149,7 @@ class ActivityProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement( + _ActivityProviderElement createElement( ProviderContainer container, ) { return _ActivityProviderElement(this, container); diff --git a/website/docs/essentials/passing_args/codegen/provider.g.dart b/website/docs/essentials/passing_args/codegen/provider.g.dart index a0bb83691..129338d03 100644 --- a/website/docs/essentials/passing_args/codegen/provider.g.dart +++ b/website/docs/essentials/passing_args/codegen/provider.g.dart @@ -86,16 +86,6 @@ class ActivityNotifier2Family extends Family { ); } - @visibleForOverriding - @override - ActivityNotifier2Provider getProviderOverride( - covariant ActivityNotifier2Provider provider, - ) { - return call( - provider.activityType, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(ActivityNotifier2 Function() create) { return _$ActivityNotifier2FamilyOverride(this, create); @@ -114,10 +104,11 @@ class _$ActivityNotifier2FamilyOverride implements FamilyOverride { final ActivityNotifier2Family from; @override - ActivityNotifier2Provider getProviderOverride( + _ActivityNotifier2ProviderElement createElement( + ProviderContainer container, covariant ActivityNotifier2Provider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -187,8 +178,7 @@ class ActivityNotifier2Provider } @override - AutoDisposeAsyncNotifierProviderElement - createElement( + _ActivityNotifier2ProviderElement createElement( ProviderContainer container, ) { return _ActivityNotifier2ProviderElement(this, container); diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index 6d0ac7450..413ad69d4 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -65,17 +65,6 @@ class RandomFamily extends Family { ); } - @visibleForOverriding - @override - RandomProvider getProviderOverride( - covariant RandomProvider provider, - ) { - return call( - seed: provider.seed, - max: provider.max, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(int Function(RandomRef ref) create) { return _$RandomFamilyOverride(this, create); @@ -94,10 +83,11 @@ class _$RandomFamilyOverride implements FamilyOverride { final RandomFamily from; @override - RandomProvider getProviderOverride( + _RandomProviderElement createElement( + ProviderContainer container, covariant RandomProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -173,7 +163,7 @@ class RandomProvider extends AutoDisposeProvider { } @override - AutoDisposeProviderElement createElement( + _RandomProviderElement createElement( ProviderContainer container, ) { return _RandomProviderElement(this, container); diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index dbf930ffd..2d695760d 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -65,17 +65,6 @@ class FetchPackagesFamily extends Family { ); } - @visibleForOverriding - @override - FetchPackagesProvider getProviderOverride( - covariant FetchPackagesProvider provider, - ) { - return call( - page: provider.page, - search: provider.search, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith( FutureOr> Function(FetchPackagesRef ref) create) { @@ -95,10 +84,11 @@ class _$FetchPackagesFamilyOverride implements FamilyOverride { final FetchPackagesFamily from; @override - FetchPackagesProvider getProviderOverride( + _FetchPackagesProviderElement createElement( + ProviderContainer container, covariant FetchPackagesProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -175,7 +165,7 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { } @override - AutoDisposeFutureProviderElement> createElement( + _FetchPackagesProviderElement createElement( ProviderContainer container, ) { return _FetchPackagesProviderElement(this, container); diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index cf552683e..ca8bc7da7 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -73,16 +73,6 @@ class BugsEncounteredNotifierFamily extends Family { ); } - @visibleForOverriding - @override - BugsEncounteredNotifierProvider getProviderOverride( - covariant BugsEncounteredNotifierProvider provider, - ) { - return call( - provider.featureId, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(BugsEncounteredNotifier Function() create) { return _$BugsEncounteredNotifierFamilyOverride(this, create); @@ -101,10 +91,11 @@ class _$BugsEncounteredNotifierFamilyOverride implements FamilyOverride { final BugsEncounteredNotifierFamily from; @override - BugsEncounteredNotifierProvider getProviderOverride( + _BugsEncounteredNotifierProviderElement createElement( + ProviderContainer container, covariant BugsEncounteredNotifierProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -174,8 +165,7 @@ class BugsEncounteredNotifierProvider } @override - AutoDisposeAsyncNotifierProviderElement - createElement( + _BugsEncounteredNotifierProviderElement createElement( ProviderContainer container, ) { return _BugsEncounteredNotifierProviderElement(this, container); diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index faa289a58..818bba960 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -63,16 +63,6 @@ class FetchUserFamily extends Family { ); } - @visibleForOverriding - @override - FetchUserProvider getProviderOverride( - covariant FetchUserProvider provider, - ) { - return call( - userId: provider.userId, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(FutureOr Function(FetchUserRef ref) create) { return _$FetchUserFamilyOverride(this, create); @@ -91,10 +81,11 @@ class _$FetchUserFamilyOverride implements FamilyOverride { final FetchUserFamily from; @override - FetchUserProvider getProviderOverride( + _FetchUserProviderElement createElement( + ProviderContainer container, covariant FetchUserProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -160,7 +151,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement( + _FetchUserProviderElement createElement( ProviderContainer container, ) { return _FetchUserProviderElement(this, container); diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index faa289a58..818bba960 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -63,16 +63,6 @@ class FetchUserFamily extends Family { ); } - @visibleForOverriding - @override - FetchUserProvider getProviderOverride( - covariant FetchUserProvider provider, - ) { - return call( - userId: provider.userId, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(FutureOr Function(FetchUserRef ref) create) { return _$FetchUserFamilyOverride(this, create); @@ -91,10 +81,11 @@ class _$FetchUserFamilyOverride implements FamilyOverride { final FetchUserFamily from; @override - FetchUserProvider getProviderOverride( + _FetchUserProviderElement createElement( + ProviderContainer container, covariant FetchUserProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -160,7 +151,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement( + _FetchUserProviderElement createElement( ProviderContainer container, ) { return _FetchUserProviderElement(this, container); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index faa289a58..818bba960 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -63,16 +63,6 @@ class FetchUserFamily extends Family { ); } - @visibleForOverriding - @override - FetchUserProvider getProviderOverride( - covariant FetchUserProvider provider, - ) { - return call( - userId: provider.userId, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(FutureOr Function(FetchUserRef ref) create) { return _$FetchUserFamilyOverride(this, create); @@ -91,10 +81,11 @@ class _$FetchUserFamilyOverride implements FamilyOverride { final FetchUserFamily from; @override - FetchUserProvider getProviderOverride( + _FetchUserProviderElement createElement( + ProviderContainer container, covariant FetchUserProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -160,7 +151,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement( + _FetchUserProviderElement createElement( ProviderContainer container, ) { return _FetchUserProviderElement(this, container); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index faa289a58..818bba960 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -63,16 +63,6 @@ class FetchUserFamily extends Family { ); } - @visibleForOverriding - @override - FetchUserProvider getProviderOverride( - covariant FetchUserProvider provider, - ) { - return call( - userId: provider.userId, - ); - } - /// Enables overriding the behavior of this provider, no matter the parameters. Override overrideWith(FutureOr Function(FetchUserRef ref) create) { return _$FetchUserFamilyOverride(this, create); @@ -91,10 +81,11 @@ class _$FetchUserFamilyOverride implements FamilyOverride { final FetchUserFamily from; @override - FetchUserProvider getProviderOverride( + _FetchUserProviderElement createElement( + ProviderContainer container, covariant FetchUserProvider provider, ) { - return provider._copyWith(create); + return provider._copyWith(create).createElement(container); } @override @@ -160,7 +151,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { } @override - AutoDisposeFutureProviderElement createElement( + _FetchUserProviderElement createElement( ProviderContainer container, ) { return _FetchUserProviderElement(this, container); From 95ab9abd19d60452cbed132144887a7fcbd7c3f1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 28 Dec 2023 14:40:14 +0100 Subject: [PATCH 098/387] Test override toString --- packages/riverpod/lib/src/core/family.dart | 3 + packages/riverpod/lib/src/core/override.dart | 11 ++- .../lib/src/core/override_with_value.dart | 3 - .../test/new/core/overrides_test.dart | 85 +++++++++++++++++++ .../riverpod_generator/test/sync_test.dart | 24 ++++++ 5 files changed, 122 insertions(+), 4 deletions(-) create mode 100644 packages/riverpod/test/new/core/overrides_test.dart diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index f0c27ee7d..52feefd42 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -101,6 +101,9 @@ class FamilyBase, R, Arg, Created, /// {@macro riverpod.create_source_hash} @internal final DebugGetCreateSourceHash? debugGetCreateSourceHash; + + @override + String toString() => name ?? describeIdentity(this); } /// A base implementation for [Family], used by the various providers to diff --git a/packages/riverpod/lib/src/core/override.dart b/packages/riverpod/lib/src/core/override.dart index 5d701dcdc..368d9390e 100644 --- a/packages/riverpod/lib/src/core/override.dart +++ b/packages/riverpod/lib/src/core/override.dart @@ -66,7 +66,12 @@ class ProviderOverride implements _ProviderOverride { @mustBeOverridden @override String toString() { - return '$origin.overrideWith($providerOverride)'; + switch (providerOverride) { + case ValueProvider(:final _value): + return '$origin.overrideWithValue($_value)'; + default: + return '$origin.overrideWith(...)'; + } } } @@ -152,4 +157,8 @@ class _FamilyOverrideImpl implements FamilyOverride { ) { return _createElement(container, provider); } + + @mustBeOverridden + @override + String toString() => '$from.overrideWith(...)'; } diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index b94f09ece..9e73a0658 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -74,9 +74,6 @@ class ValueProvider extends ProviderBase { ValueProviderElement createElement(ProviderContainer container) { return ValueProviderElement(this, container); } - - @override - String toString() => 'ValueProvider<$State>($_value)'; } /// The [ProviderElementBase] of a [ValueProvider] diff --git a/packages/riverpod/test/new/core/overrides_test.dart b/packages/riverpod/test/new/core/overrides_test.dart new file mode 100644 index 000000000..40db7c8ee --- /dev/null +++ b/packages/riverpod/test/new/core/overrides_test.dart @@ -0,0 +1,85 @@ +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +import '../../old/utils.dart'; + +void main() { + group('ProviderOverride', () { + group('overrideWith', () { + test('toString', () { + final namelessProvider = Provider((_) => 42); + final namelessFamily = Provider.family((_, __) => 42); + final provider = Provider((_) => 42, name: 'myName'); + final family = Provider.family((_, __) => 42, name: 'myName'); + + expect( + namelessProvider.overrideWith((ref) => 42).toString(), + equalsIgnoringHashCodes('Provider#00000.overrideWith(...)'), + ); + expect( + namelessFamily(42).overrideWith((ref) => 42).toString(), + equalsIgnoringHashCodes('Provider#00000(42).overrideWith(...)'), + ); + + expect( + provider.overrideWith((ref) => 42).toString(), + 'myName.overrideWith(...)', + ); + expect( + family(42).overrideWith((ref) => 42).toString(), + 'myName(42).overrideWith(...)', + ); + }); + }); + + group('overrideWithValue', () { + test('toString', () { + final namelessProvider = Provider((_) => 42); + final namelessFamily = Provider.family((_, __) => 42); + final provider = Provider((_) => 42, name: 'myName'); + final family = Provider.family((_, __) => 42, name: 'myName'); + + expect( + namelessProvider.overrideWithValue(21).toString(), + equalsIgnoringHashCodes('Provider#00000.overrideWithValue(21)'), + ); + expect( + namelessFamily(42).overrideWithValue(21).toString(), + equalsIgnoringHashCodes( + 'Provider#00000(42).overrideWithValue(21)', + ), + ); + + expect( + provider.overrideWithValue(21).toString(), + 'myName.overrideWithValue(21)', + ); + expect( + family(42).overrideWithValue(21).toString(), + 'myName(42).overrideWithValue(21)', + ); + }); + }); + }); + + group('FamilyOverride', () { + group('overrideWith', () { + test('toString', () { + final namelessFamily = Provider.family((_, __) => 42); + final family = Provider.family((_, __) => 42, name: 'myName'); + + expect( + namelessFamily.overrideWith((ref, arg) => 42).toString(), + equalsIgnoringHashCodes( + 'ProviderFamily#00000.overrideWith(...)', + ), + ); + + expect( + family.overrideWith((ref, _) => 42).toString(), + 'myName.overrideWith(...)', + ); + }); + }); + }); +} diff --git a/packages/riverpod_generator/test/sync_test.dart b/packages/riverpod_generator/test/sync_test.dart index 49cd17c33..d8ed248c6 100644 --- a/packages/riverpod_generator/test/sync_test.dart +++ b/packages/riverpod_generator/test/sync_test.dart @@ -135,6 +135,30 @@ void main() { ); }); + test('overrides toString', () { + expect(publicProvider.toString(), 'publicProvider'); + expect(familyProvider.toString(), 'familyProvider'); + expect( + familyProvider.call(42, second: 'foo', third: .3).toString(), + 'familyProvider(42, fifth: null, fourth: true, second: foo, third: 0.3)', + ); + + expect( + publicProvider.overrideWithValue('foo').toString(), + 'publicProvider.overrideWithValue(foo)', + ); + expect( + familyProvider.overrideWith((ref) => 'foo').toString(), + 'familyProvider.overrideWith(...)', + ); + expect( + familyProvider(42, second: 'foo', third: .3) + .overrideWith((ref) => '') + .toString(), + 'familyProvider(42, fifth: null, fourth: true, second: foo, third: 0.3).overrideWith(...)', + ); + }); + test('Supports overriding non-family providers', () { final container = createContainer( overrides: [ From 138c5b99d4a34530bf7bc945f44719cf59cbf5b9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 28 Dec 2023 14:46:56 +0100 Subject: [PATCH 099/387] More override toString test --- examples/pub/lib/detail.g.dart | 4 ++-- examples/pub/lib/search.g.dart | 2 +- packages/riverpod/lib/src/core/override.dart | 6 ++++++ .../riverpod/test/new/core/overrides_test.dart | 18 ++++++++++++++++++ .../integration/build_yaml/lib/main.g.dart | 14 ++++++-------- .../lib/src/templates/family.dart | 2 +- .../test/integration/annotated.g.dart | 4 ++-- .../test/integration/async.g.dart | 12 ++++++------ .../test/integration/dependencies.g.dart | 6 +++--- .../test/integration/dependencies2.g.dart | 4 ++-- .../test/integration/generated.g.dart | 14 +++++++------- .../test/integration/stream.g.dart | 8 ++++---- .../test/integration/sync.g.dart | 18 +++++++++--------- .../generated/golden/lib/sync.g.dart | 4 ++-- ...t_class_based_provider_to_functional.g.dart | 4 ++-- ...t_functional_provider_to_class_based.g.dart | 2 +- .../avoid_build_context_in_providers.g.dart | 4 ++-- .../avoid_public_notifier_properties.g.dart | 2 +- .../test/lints/dependencies.g.dart | 4 ++-- .../lints/functional_ref/functional_ref.g.dart | 8 ++++---- .../notifier_extends/notifier_extends.g.dart | 8 ++++---- .../lints/protected_notifier_properties.g.dart | 12 ++++++------ .../test/lints/provider_parameters.g.dart | 2 +- .../docs/concepts/about_codegen/main.g.dart | 2 +- .../about_codegen/provider_type/family.g.dart | 2 +- .../provider_type/family_class.g.dart | 2 +- .../provider_type/family_fn.g.dart | 2 +- .../invalidate_family_example/codegen.g.dart | 2 +- .../passing_args/codegen/family.g.dart | 2 +- .../passing_args/codegen/provider.g.dart | 2 +- .../docs/from_provider/family/family.g.dart | 2 +- .../introduction/why_riverpod/codegen.g.dart | 2 +- .../family_and_dispose.g.dart | 2 +- .../current/about_codegen/main.g.dart | 2 +- .../current/about_codegen/main.g.dart | 2 +- .../current/about_codegen/main.g.dart | 2 +- .../current/about_codegen/main.g.dart | 2 +- 37 files changed, 106 insertions(+), 84 deletions(-) diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 0bac74e70..03a855261 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -91,7 +91,7 @@ class _$FetchPackageDetailsFamilyOverride implements FamilyOverride { } @override - String toString() => 'fetchPackageDetailsProvider.overrideWith($create)'; + String toString() => 'fetchPackageDetailsProvider.overrideWith(...)'; } /// See also [fetchPackageDetails]. @@ -329,7 +329,7 @@ class _$PackageMetricsFamilyOverride implements FamilyOverride { } @override - String toString() => 'packageMetricsProvider.overrideWith($create)'; + String toString() => 'packageMetricsProvider.overrideWith(...)'; } /// A provider that fetches the likes count, popularity score and pub points diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 98dbd30e3..5f41d38a3 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -92,7 +92,7 @@ class _$FetchPackagesFamilyOverride implements FamilyOverride { } @override - String toString() => 'fetchPackagesProvider.overrideWith($create)'; + String toString() => 'fetchPackagesProvider.overrideWith(...)'; } /// See also [fetchPackages]. diff --git a/packages/riverpod/lib/src/core/override.dart b/packages/riverpod/lib/src/core/override.dart index 368d9390e..399964870 100644 --- a/packages/riverpod/lib/src/core/override.dart +++ b/packages/riverpod/lib/src/core/override.dart @@ -85,6 +85,9 @@ class TransitiveProviderOverride implements ProviderOverride { @override ProviderBase get providerOverride => origin; + + @override + String toString() => '$origin'; } /// Do not use: Internal object to used by [ProviderContainer]/`ProviderScope` @@ -128,6 +131,9 @@ class TransitiveFamilyOverride implements FamilyOverride { ) { return provider.createElement(container); } + + @override + String toString() => '$from'; } /// An [Override] for families diff --git a/packages/riverpod/test/new/core/overrides_test.dart b/packages/riverpod/test/new/core/overrides_test.dart index 40db7c8ee..0d99acd00 100644 --- a/packages/riverpod/test/new/core/overrides_test.dart +++ b/packages/riverpod/test/new/core/overrides_test.dart @@ -1,10 +1,19 @@ import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; import '../../old/utils.dart'; void main() { group('ProviderOverride', () { + test('TransitiveOverride.toString', () { + final provider = Provider((_) => 42); + expect( + TransitiveProviderOverride(provider), + equalsIgnoringHashCodes('Provider#00000'), + ); + }); + group('overrideWith', () { test('toString', () { final namelessProvider = Provider((_) => 42); @@ -63,6 +72,15 @@ void main() { }); group('FamilyOverride', () { + test('TransitiveOverride.toString', () { + final provider = Provider.family((_, b) => 42); + + expect( + TransitiveFamilyOverride(provider), + equalsIgnoringHashCodes('Provider#00000'), + ); + }); + group('overrideWith', () { test('toString', () { final namelessFamily = Provider.family((_, __) => 42); diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index d4165f1e7..d06c7a914 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -129,7 +129,7 @@ class _$Count2FamilyOverride implements FamilyOverride { } @override - String toString() => 'count2ProviderFamily.overrideWith($create)'; + String toString() => 'count2ProviderFamily.overrideWith(...)'; } /// See also [count2]. @@ -299,7 +299,7 @@ class _$CountFuture2FamilyOverride implements FamilyOverride { } @override - String toString() => 'countFuture2ProviderFamily.overrideWith($create)'; + String toString() => 'countFuture2ProviderFamily.overrideWith(...)'; } /// See also [countFuture2]. @@ -470,7 +470,7 @@ class _$CountStream2FamilyOverride implements FamilyOverride { } @override - String toString() => 'countStream2ProviderFamily.overrideWith($create)'; + String toString() => 'countStream2ProviderFamily.overrideWith(...)'; } /// See also [countStream2]. @@ -699,7 +699,7 @@ class _$CountNotifier2FamilyOverride implements FamilyOverride { } @override - String toString() => 'countNotifier2ProviderFamily.overrideWith($create)'; + String toString() => 'countNotifier2ProviderFamily.overrideWith(...)'; } /// See also [CountNotifier2]. @@ -886,8 +886,7 @@ class _$CountAsyncNotifier2FamilyOverride implements FamilyOverride { } @override - String toString() => - 'countAsyncNotifier2ProviderFamily.overrideWith($create)'; + String toString() => 'countAsyncNotifier2ProviderFamily.overrideWith(...)'; } /// See also [CountAsyncNotifier2]. @@ -1074,8 +1073,7 @@ class _$CountStreamNotifier2FamilyOverride implements FamilyOverride { } @override - String toString() => - 'countStreamNotifier2ProviderFamily.overrideWith($create)'; + String toString() => 'countStreamNotifier2ProviderFamily.overrideWith(...)'; } /// See also [CountStreamNotifier2]. diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 0b6992246..5d3aa3664 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -354,7 +354,7 @@ class $familyOverrideClassName implements FamilyOverride { } @override - String toString() => '$encodedProviderName.overrideWith(\$create)'; + String toString() => '$encodedProviderName.overrideWith(...)'; } $docs diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index c0029b491..afe2b63e0 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -107,7 +107,7 @@ class _$FamilyFamilyOverride implements FamilyOverride { } @override - String toString() => 'familyProvider.overrideWith($create)'; + String toString() => 'familyProvider.overrideWith(...)'; } /// See also [family]. @@ -293,7 +293,7 @@ class _$NotCopiedFamilyFamilyOverride implements FamilyOverride { } @override - String toString() => 'notCopiedFamilyProvider.overrideWith($create)'; + String toString() => 'notCopiedFamilyProvider.overrideWith(...)'; } /// See also [notCopiedFamily]. diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 6105c17e1..07c12dd01 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -84,7 +84,7 @@ class _$GenericFamilyOverride implements FamilyOverride { } @override - String toString() => 'genericProvider.overrideWith($create)'; + String toString() => 'genericProvider.overrideWith(...)'; } /// See also [generic]. @@ -269,7 +269,7 @@ class _$FamilyOrFamilyOverride implements FamilyOverride { } @override - String toString() => 'familyOrProvider.overrideWith($create)'; + String toString() => 'familyOrProvider.overrideWith(...)'; } /// See also [familyOr]. @@ -447,7 +447,7 @@ class _$FamilyFamilyOverride implements FamilyOverride { } @override - String toString() => 'familyProvider.overrideWith($create)'; + String toString() => 'familyProvider.overrideWith(...)'; } /// See also [family]. @@ -687,7 +687,7 @@ class _$GenericClassFamilyOverride implements FamilyOverride { } @override - String toString() => 'genericClassProvider.overrideWith($create)'; + String toString() => 'genericClassProvider.overrideWith(...)'; } /// See also [GenericClass]. @@ -889,7 +889,7 @@ class _$FamilyOrClassFamilyOverride implements FamilyOverride { } @override - String toString() => 'familyOrClassProvider.overrideWith($create)'; + String toString() => 'familyOrClassProvider.overrideWith(...)'; } /// See also [FamilyOrClass]. @@ -1090,7 +1090,7 @@ class _$FamilyClassFamilyOverride implements FamilyOverride { } @override - String toString() => 'familyClassProvider.overrideWith($create)'; + String toString() => 'familyClassProvider.overrideWith(...)'; } /// See also [FamilyClass]. diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index e02881444..56437f927 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -101,7 +101,7 @@ class _$FamilyFamilyOverride implements FamilyOverride { } @override - String toString() => 'familyProvider.overrideWith($create)'; + String toString() => 'familyProvider.overrideWith(...)'; } /// See also [family]. @@ -457,7 +457,7 @@ class _$Family2FamilyOverride implements FamilyOverride { } @override - String toString() => 'family2Provider.overrideWith($create)'; + String toString() => 'family2Provider.overrideWith(...)'; } /// See also [Family2]. @@ -682,7 +682,7 @@ class _$Provider4FamilyOverride implements FamilyOverride { } @override - String toString() => 'provider4Provider.overrideWith($create)'; + String toString() => 'provider4Provider.overrideWith(...)'; } /// See also [Provider4]. diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 14bd3c252..1525244dd 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -127,7 +127,7 @@ class _$FamilyWithDependencies2FamilyOverride implements FamilyOverride { } @override - String toString() => 'familyWithDependencies2Provider.overrideWith($create)'; + String toString() => 'familyWithDependencies2Provider.overrideWith(...)'; } /// See also [familyWithDependencies2]. @@ -380,7 +380,7 @@ class _$NotifierFamilyWithDependenciesFamilyOverride implements FamilyOverride { @override String toString() => - 'notifierFamilyWithDependenciesProvider.overrideWith($create)'; + 'notifierFamilyWithDependenciesProvider.overrideWith(...)'; } /// See also [NotifierFamilyWithDependencies]. diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 4ae31bb78..ea029776d 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -101,7 +101,7 @@ class _$GeneratedFamilyFamilyOverride implements FamilyOverride { } @override - String toString() => 'generatedFamilyProvider.overrideWith($create)'; + String toString() => 'generatedFamilyProvider.overrideWith(...)'; } /// See also [generatedFamily]. @@ -286,7 +286,7 @@ class _$$DynamicFamilyFamilyOverride implements FamilyOverride { } @override - String toString() => '\$dynamicFamilyProvider.overrideWith($create)'; + String toString() => '\$dynamicFamilyProvider.overrideWith(...)'; } /// See also [$dynamicFamily]. @@ -457,7 +457,7 @@ class _$DynamicFamilyOverride implements FamilyOverride { } @override - String toString() => '_dynamicProvider.overrideWith($create)'; + String toString() => '_dynamicProvider.overrideWith(...)'; } /// See also [_dynamic]. @@ -641,7 +641,7 @@ class _$AliasFamilyFamilyOverride implements FamilyOverride { } @override - String toString() => 'aliasFamilyProvider.overrideWith($create)'; + String toString() => 'aliasFamilyProvider.overrideWith(...)'; } /// See also [aliasFamily]. @@ -838,7 +838,7 @@ class _$GeneratedClassFamilyFamilyOverride implements FamilyOverride { } @override - String toString() => 'generatedClassFamilyProvider.overrideWith($create)'; + String toString() => 'generatedClassFamilyProvider.overrideWith(...)'; } /// See also [GeneratedClassFamily]. @@ -1041,7 +1041,7 @@ class _$$DynamicClassFamilyFamilyOverride implements FamilyOverride { } @override - String toString() => '\$dynamicClassFamilyProvider.overrideWith($create)'; + String toString() => '\$dynamicClassFamilyProvider.overrideWith(...)'; } /// See also [$DynamicClassFamily]. @@ -1242,7 +1242,7 @@ class _$AliasClassFamilyFamilyOverride implements FamilyOverride { } @override - String toString() => 'aliasClassFamilyProvider.overrideWith($create)'; + String toString() => 'aliasClassFamilyProvider.overrideWith(...)'; } /// See also [AliasClassFamily]. diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 7b1891902..f7d7b541f 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -84,7 +84,7 @@ class _$GenericFamilyOverride implements FamilyOverride { } @override - String toString() => 'genericProvider.overrideWith($create)'; + String toString() => 'genericProvider.overrideWith(...)'; } /// See also [generic]. @@ -277,7 +277,7 @@ class _$FamilyFamilyOverride implements FamilyOverride { } @override - String toString() => 'familyProvider.overrideWith($create)'; + String toString() => 'familyProvider.overrideWith(...)'; } /// See also [family]. @@ -517,7 +517,7 @@ class _$GenericClassFamilyOverride implements FamilyOverride { } @override - String toString() => 'genericClassProvider.overrideWith($create)'; + String toString() => 'genericClassProvider.overrideWith(...)'; } /// See also [GenericClass]. @@ -735,7 +735,7 @@ class _$FamilyClassFamilyOverride implements FamilyOverride { } @override - String toString() => 'familyClassProvider.overrideWith($create)'; + String toString() => 'familyClassProvider.overrideWith(...)'; } /// See also [FamilyClass]. diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 26362482a..23ae67c3e 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -84,7 +84,7 @@ class _$GenericFamilyOverride implements FamilyOverride { } @override - String toString() => 'genericProvider.overrideWith($create)'; + String toString() => 'genericProvider.overrideWith(...)'; } /// See also [generic]. @@ -246,7 +246,7 @@ class _$ComplexGenericFamilyOverride implements FamilyOverride { } @override - String toString() => 'complexGenericProvider.overrideWith($create)'; + String toString() => 'complexGenericProvider.overrideWith(...)'; } /// See also [complexGeneric]. @@ -473,7 +473,7 @@ class _$RawFamilyFutureFamilyOverride implements FamilyOverride { } @override - String toString() => 'rawFamilyFutureProvider.overrideWith($create)'; + String toString() => 'rawFamilyFutureProvider.overrideWith(...)'; } /// See also [rawFamilyFuture]. @@ -646,7 +646,7 @@ class _$RawFamilyStreamFamilyOverride implements FamilyOverride { } @override - String toString() => 'rawFamilyStreamProvider.overrideWith($create)'; + String toString() => 'rawFamilyStreamProvider.overrideWith(...)'; } /// See also [rawFamilyStream]. @@ -865,7 +865,7 @@ class _$FamilyFamilyOverride implements FamilyOverride { } @override - String toString() => 'familyProvider.overrideWith($create)'; + String toString() => 'familyProvider.overrideWith(...)'; } /// This is some documentation @@ -1137,7 +1137,7 @@ class _$GenericClassFamilyOverride implements FamilyOverride { } @override - String toString() => 'genericClassProvider.overrideWith($create)'; + String toString() => 'genericClassProvider.overrideWith(...)'; } /// See also [GenericClass]. @@ -1342,7 +1342,7 @@ class _$RawFamilyFutureClassFamilyOverride implements FamilyOverride { } @override - String toString() => 'rawFamilyFutureClassProvider.overrideWith($create)'; + String toString() => 'rawFamilyFutureClassProvider.overrideWith(...)'; } /// See also [RawFamilyFutureClass]. @@ -1530,7 +1530,7 @@ class _$RawFamilyStreamClassFamilyOverride implements FamilyOverride { } @override - String toString() => 'rawFamilyStreamClassProvider.overrideWith($create)'; + String toString() => 'rawFamilyStreamClassProvider.overrideWith(...)'; } /// See also [RawFamilyStreamClass]. @@ -1772,7 +1772,7 @@ class _$FamilyClassFamilyOverride implements FamilyOverride { } @override - String toString() => 'familyClassProvider.overrideWith($create)'; + String toString() => 'familyClassProvider.overrideWith(...)'; } /// This is some documentation diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 4a82b3968..5145a6f4c 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -136,7 +136,7 @@ class _$FamilyFamilyOverride implements FamilyOverride { } @override - String toString() => 'familyProvider.overrideWith($create)'; + String toString() => 'familyProvider.overrideWith(...)'; } /// A generated family provider. @@ -457,7 +457,7 @@ class _$FamilyClassFamilyOverride implements FamilyOverride { } @override - String toString() => 'familyClassProvider.overrideWith($create)'; + String toString() => 'familyClassProvider.overrideWith(...)'; } /// A generated family provider from a class. diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index 91fc4b883..aeef05840 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -123,7 +123,7 @@ class _$ExampleFamilyFamilyOverride implements FamilyOverride { } @override - String toString() => 'exampleFamilyProvider.overrideWith($create)'; + String toString() => 'exampleFamilyProvider.overrideWith(...)'; } /// Some comment @@ -329,7 +329,7 @@ class _$GenericFamilyOverride implements FamilyOverride { } @override - String toString() => 'genericProvider.overrideWith($create)'; + String toString() => 'genericProvider.overrideWith(...)'; } /// See also [Generic]. diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index fd59e0c50..b7a4e1e5c 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -113,7 +113,7 @@ class _$ExampleFamilyFamilyOverride implements FamilyOverride { } @override - String toString() => 'exampleFamilyProvider.overrideWith($create)'; + String toString() => 'exampleFamilyProvider.overrideWith(...)'; } /// Some comment diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 4642c78f8..c6579fbb0 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -89,7 +89,7 @@ class _$FnFamilyOverride implements FamilyOverride { } @override - String toString() => 'fnProvider.overrideWith($create)'; + String toString() => 'fnProvider.overrideWith(...)'; } /// See also [fn]. @@ -289,7 +289,7 @@ class _$MyNotifierFamilyOverride implements FamilyOverride { } @override - String toString() => 'myNotifierProvider.overrideWith($create)'; + String toString() => 'myNotifierProvider.overrideWith(...)'; } /// See also [MyNotifier]. diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index 113e55cdd..00191f3bb 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -95,7 +95,7 @@ class _$GeneratedNotifierFamilyOverride implements FamilyOverride { } @override - String toString() => 'generatedNotifierProvider.overrideWith($create)'; + String toString() => 'generatedNotifierProvider.overrideWith(...)'; } /// See also [GeneratedNotifier]. diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index df03cdf2e..26984624e 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -471,7 +471,7 @@ class _$FamilyDepFamilyOverride implements FamilyOverride { } @override - String toString() => 'familyDepProvider.overrideWith($create)'; + String toString() => 'familyDepProvider.overrideWith(...)'; } /// See also [familyDep]. @@ -647,7 +647,7 @@ class _$FamilyDep2FamilyOverride implements FamilyOverride { } @override - String toString() => 'familyDep2Provider.overrideWith($create)'; + String toString() => 'familyDep2Provider.overrideWith(...)'; } /// See also [familyDep2]. diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 2aef68e7c..4fde64745 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -115,7 +115,7 @@ class _$GenericsFamilyOverride implements FamilyOverride { } @override - String toString() => 'genericsProvider.overrideWith($create)'; + String toString() => 'genericsProvider.overrideWith(...)'; } /// See also [generics]. @@ -269,7 +269,7 @@ class _$NoGenericsFamilyOverride implements FamilyOverride { } @override - String toString() => 'noGenericsProvider.overrideWith($create)'; + String toString() => 'noGenericsProvider.overrideWith(...)'; } /// See also [noGenerics]. @@ -423,7 +423,7 @@ class _$MissingGenericsFamilyOverride implements FamilyOverride { } @override - String toString() => 'missingGenericsProvider.overrideWith($create)'; + String toString() => 'missingGenericsProvider.overrideWith(...)'; } /// See also [missingGenerics]. @@ -577,7 +577,7 @@ class _$WrongOrderFamilyOverride implements FamilyOverride { } @override - String toString() => 'wrongOrderProvider.overrideWith($create)'; + String toString() => 'wrongOrderProvider.overrideWith(...)'; } /// See also [wrongOrder]. diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart index 3f1cda270..9e8eb184b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart @@ -147,7 +147,7 @@ class _$GenericsFamilyOverride implements FamilyOverride { } @override - String toString() => 'genericsProvider.overrideWith($create)'; + String toString() => 'genericsProvider.overrideWith(...)'; } /// See also [Generics]. @@ -310,7 +310,7 @@ class _$NoGenericsFamilyOverride implements FamilyOverride { } @override - String toString() => 'noGenericsProvider.overrideWith($create)'; + String toString() => 'noGenericsProvider.overrideWith(...)'; } /// See also [NoGenerics]. @@ -474,7 +474,7 @@ class _$MissingGenericsFamilyOverride implements FamilyOverride { } @override - String toString() => 'missingGenericsProvider.overrideWith($create)'; + String toString() => 'missingGenericsProvider.overrideWith(...)'; } /// See also [MissingGenerics]. @@ -637,7 +637,7 @@ class _$WrongOrderFamilyOverride implements FamilyOverride { } @override - String toString() => 'wrongOrderProvider.overrideWith($create)'; + String toString() => 'wrongOrderProvider.overrideWith(...)'; } /// See also [WrongOrder]. diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index c6c749ced..79725bcd5 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -123,7 +123,7 @@ class _$A3FamilyOverride implements FamilyOverride { } @override - String toString() => 'a3Provider.overrideWith($create)'; + String toString() => 'a3Provider.overrideWith(...)'; } /// See also [A3]. @@ -303,7 +303,7 @@ class _$A4FamilyOverride implements FamilyOverride { } @override - String toString() => 'a4Provider.overrideWith($create)'; + String toString() => 'a4Provider.overrideWith(...)'; } /// See also [A4]. @@ -482,7 +482,7 @@ class _$A5FamilyOverride implements FamilyOverride { } @override - String toString() => 'a5Provider.overrideWith($create)'; + String toString() => 'a5Provider.overrideWith(...)'; } /// See also [A5]. @@ -662,7 +662,7 @@ class _$A6FamilyOverride implements FamilyOverride { } @override - String toString() => 'a6Provider.overrideWith($create)'; + String toString() => 'a6Provider.overrideWith(...)'; } /// See also [A6]. @@ -842,7 +842,7 @@ class _$A7FamilyOverride implements FamilyOverride { } @override - String toString() => 'a7Provider.overrideWith($create)'; + String toString() => 'a7Provider.overrideWith(...)'; } /// See also [A7]. @@ -1022,7 +1022,7 @@ class _$A8FamilyOverride implements FamilyOverride { } @override - String toString() => 'a8Provider.overrideWith($create)'; + String toString() => 'a8Provider.overrideWith(...)'; } /// See also [A8]. diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index fe3a1984d..25f926e94 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -87,7 +87,7 @@ class _$GeneratorFamilyOverride implements FamilyOverride { } @override - String toString() => 'generatorProvider.overrideWith($create)'; + String toString() => 'generatorProvider.overrideWith(...)'; } /// See also [generator]. diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 818bba960..cc46b26a1 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -89,7 +89,7 @@ class _$FetchUserFamilyOverride implements FamilyOverride { } @override - String toString() => 'fetchUserProvider.overrideWith($create)'; + String toString() => 'fetchUserProvider.overrideWith(...)'; } /// See also [fetchUser]. diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 9cbebfeae..8b69fbd36 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -89,7 +89,7 @@ class _$ExampleFamilyOverride implements FamilyOverride { } @override - String toString() => 'exampleProvider.overrideWith($create)'; + String toString() => 'exampleProvider.overrideWith(...)'; } /// See also [example]. diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index c581bc045..cb2ebbfa0 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -101,7 +101,7 @@ class _$ExampleFamilyOverride implements FamilyOverride { } @override - String toString() => 'exampleProvider.overrideWith($create)'; + String toString() => 'exampleProvider.overrideWith(...)'; } /// See also [Example]. diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index fca2832c0..d0777ec8e 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -91,7 +91,7 @@ class _$ExampleFamilyOverride implements FamilyOverride { } @override - String toString() => 'exampleProvider.overrideWith($create)'; + String toString() => 'exampleProvider.overrideWith(...)'; } /// See also [example]. diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index c6837d4b7..b6a9745f5 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -89,7 +89,7 @@ class _$LabelFamilyOverride implements FamilyOverride { } @override - String toString() => 'labelProvider.overrideWith($create)'; + String toString() => 'labelProvider.overrideWith(...)'; } /// See also [label]. diff --git a/website/docs/essentials/passing_args/codegen/family.g.dart b/website/docs/essentials/passing_args/codegen/family.g.dart index ba220d2b1..892084197 100644 --- a/website/docs/essentials/passing_args/codegen/family.g.dart +++ b/website/docs/essentials/passing_args/codegen/family.g.dart @@ -89,7 +89,7 @@ class _$ActivityFamilyOverride implements FamilyOverride { } @override - String toString() => 'activityProvider.overrideWith($create)'; + String toString() => 'activityProvider.overrideWith(...)'; } /// See also [activity]. diff --git a/website/docs/essentials/passing_args/codegen/provider.g.dart b/website/docs/essentials/passing_args/codegen/provider.g.dart index 129338d03..1823fec59 100644 --- a/website/docs/essentials/passing_args/codegen/provider.g.dart +++ b/website/docs/essentials/passing_args/codegen/provider.g.dart @@ -112,7 +112,7 @@ class _$ActivityNotifier2FamilyOverride implements FamilyOverride { } @override - String toString() => 'activityNotifier2Provider.overrideWith($create)'; + String toString() => 'activityNotifier2Provider.overrideWith(...)'; } /// See also [ActivityNotifier2]. diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index 413ad69d4..ecdaa4ce6 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -91,7 +91,7 @@ class _$RandomFamilyOverride implements FamilyOverride { } @override - String toString() => 'randomProvider.overrideWith($create)'; + String toString() => 'randomProvider.overrideWith(...)'; } /// See also [random]. diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index 2d695760d..8bb8a5c3a 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -92,7 +92,7 @@ class _$FetchPackagesFamilyOverride implements FamilyOverride { } @override - String toString() => 'fetchPackagesProvider.overrideWith($create)'; + String toString() => 'fetchPackagesProvider.overrideWith(...)'; } /// See also [fetchPackages]. diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index ca8bc7da7..310967406 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -99,7 +99,7 @@ class _$BugsEncounteredNotifierFamilyOverride implements FamilyOverride { } @override - String toString() => 'bugsEncounteredNotifierProvider.overrideWith($create)'; + String toString() => 'bugsEncounteredNotifierProvider.overrideWith(...)'; } /// See also [BugsEncounteredNotifier]. diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 818bba960..cc46b26a1 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -89,7 +89,7 @@ class _$FetchUserFamilyOverride implements FamilyOverride { } @override - String toString() => 'fetchUserProvider.overrideWith($create)'; + String toString() => 'fetchUserProvider.overrideWith(...)'; } /// See also [fetchUser]. diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 818bba960..cc46b26a1 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -89,7 +89,7 @@ class _$FetchUserFamilyOverride implements FamilyOverride { } @override - String toString() => 'fetchUserProvider.overrideWith($create)'; + String toString() => 'fetchUserProvider.overrideWith(...)'; } /// See also [fetchUser]. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 818bba960..cc46b26a1 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -89,7 +89,7 @@ class _$FetchUserFamilyOverride implements FamilyOverride { } @override - String toString() => 'fetchUserProvider.overrideWith($create)'; + String toString() => 'fetchUserProvider.overrideWith(...)'; } /// See also [fetchUser]. diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 818bba960..cc46b26a1 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -89,7 +89,7 @@ class _$FetchUserFamilyOverride implements FamilyOverride { } @override - String toString() => 'fetchUserProvider.overrideWith($create)'; + String toString() => 'fetchUserProvider.overrideWith(...)'; } /// See also [fetchUser]. From 188cef65eca4634067643736c73f0dc816d287a1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 28 Dec 2023 16:10:00 +0100 Subject: [PATCH 100/387] Fix test --- packages/riverpod/test/new/core/overrides_test.dart | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/packages/riverpod/test/new/core/overrides_test.dart b/packages/riverpod/test/new/core/overrides_test.dart index 0d99acd00..f985e34a0 100644 --- a/packages/riverpod/test/new/core/overrides_test.dart +++ b/packages/riverpod/test/new/core/overrides_test.dart @@ -8,8 +8,9 @@ void main() { group('ProviderOverride', () { test('TransitiveOverride.toString', () { final provider = Provider((_) => 42); + expect( - TransitiveProviderOverride(provider), + TransitiveProviderOverride(provider).toString(), equalsIgnoringHashCodes('Provider#00000'), ); }); @@ -76,8 +77,8 @@ void main() { final provider = Provider.family((_, b) => 42); expect( - TransitiveFamilyOverride(provider), - equalsIgnoringHashCodes('Provider#00000'), + TransitiveFamilyOverride(provider).toString(), + equalsIgnoringHashCodes('ProviderFamily#00000'), ); }); From 3e9d429facab1234760d6bdf54cab3b57d0ff6be Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 28 Dec 2023 17:45:39 +0100 Subject: [PATCH 101/387] Fix more tests --- packages/riverpod/lib/riverpod.dart | 1 - packages/riverpod/lib/src/core/element.dart | 16 ++--- .../lib/src/core/override_with_value.dart | 10 ++- .../lib/src/core/provider_container.dart | 61 +++++++++-------- packages/riverpod/lib/src/core/scheduler.dart | 2 +- .../async_notifier/auto_dispose.dart | 2 +- .../legacy_providers/async_notifier/base.dart | 12 ++-- .../state_notifier_provider/base.dart | 10 ++- .../deprecated/state_provider/base.dart | 9 ++- .../future_provider/base.dart | 11 ++- .../src/legacy_providers/notifier/base.dart | 10 ++- .../provider/auto_dispose.dart | 2 +- .../src/legacy_providers/provider/base.dart | 7 +- .../stream_notifier/base.dart | 10 ++- .../stream_provider/base.dart | 16 ++--- .../new/core/provider_container_test.dart | 67 ++++++++++++++++++- .../test/old/framework/scope_test.dart | 17 ++++- 17 files changed, 165 insertions(+), 98 deletions(-) diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 9ae867f10..51e670572 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -11,7 +11,6 @@ export 'src/framework.dart' FamilyCreate, AsyncSelector, FamilyBase, - FamilyOverrideImpl, AutoDisposeProviderElementMixin, FamilyOverride, NotifierFamilyBase, diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index fa9ad35ba..d7187839c 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -44,7 +44,7 @@ void Function()? debugCanModifyProviders; abstract class ProviderElementBase implements Ref, Node { /// {@macro riverpod.provider_element_base} // TODO changelog: ProviderElement no-longer takes a provider as parameter but takes a ProviderContainer - ProviderElementBase(this._provider, this.container); + ProviderElementBase(this.container); static ProviderElementBase? _debugCurrentlyBuildingElement; @@ -59,10 +59,9 @@ abstract class ProviderElementBase implements Ref, Node { ProviderBase get origin => _origin; late ProviderBase _origin; - // TODO changelog ProviderElement.provider is now abstract /// The provider associated with this [ProviderElementBase], after applying overrides. - ProviderBase get provider => _provider; - ProviderBase _provider; + // TODO changelog ProviderElement.provider is now abstract + ProviderBase get provider; /// The [ProviderContainer] that owns this [ProviderElementBase]. @override @@ -77,12 +76,12 @@ abstract class ProviderElementBase implements Ref, Node { _subscribers.isNotEmpty || _providerDependents.isNotEmpty; - // TODO(rrousselGit) refactor to match ChangeNotifier /// The list of [ProviderSubscription]s that are linked with this element, /// which aren't coming from another provider. /// /// This is typically Flutter widgets or manual calls to [ProviderContainer.listen] /// with this provider as target. + // TODO(rrousselGit) refactor to match ChangeNotifier final _externalDependents = <_ExternalProviderSubscription>[]; /// The [ProviderSubscription]s associated to the providers that this @@ -305,11 +304,8 @@ abstract class ProviderElementBase implements Ref, Node { /// See also: /// - `overrideWithValue`, which relies on [update] to handle /// the scenario where the value changed. - @internal - // ignore: use_setters_to_change_properties - void update(ProviderBase newProvider) { - _provider = newProvider; - } + @visibleForOverriding + void update(ProviderBase newProvider) {} @override void invalidate(ProviderOrFamily provider) { diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index 9e73a0658..3be045bff 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -81,16 +81,20 @@ class ValueProvider extends ProviderBase { @internal class ValueProviderElement extends ProviderElementBase { /// The [ProviderElementBase] of a [ValueProvider] - ValueProviderElement(ValueProvider super._provider, super.container); + ValueProviderElement(this.provider, super.container); /// A custom listener called when `overrideWithValue` changes /// with a different value. void Function(State value)? onChange; @override - void update(ProviderBase newProvider) { + ValueProvider provider; + + @override + void update(covariant ValueProvider newProvider) { super.update(newProvider); - final newValue = (provider as ValueProvider)._value; + provider = newProvider; + final newValue = provider._value; // `getState` will never be in error/loading state since there is no "create" final previousState = getState()! as ResultData; diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index eb00b7374..7042ad000 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -57,19 +57,20 @@ extension required PointerT Function({ProviderT? override}) scope, }) { final pointer = this[provider]; - - if (pointer != null) { - // TODO what about family(42) overrides on nested containers? - if (provider.allTransitiveDependencies == null) { - // The provider is not scoped, so can never be transitively overridden - return pointer; - } - if (pointer.targetContainer == currentContainer) { - // The pointer isn't inherited but rather local to the current container, - // so no need to check for transitive overrides. - return pointer; - } - } + if (pointer != null) return pointer; + + // if (pointer != null) { + // // TODO what about family(42) overrides on nested containers? + // if (provider.allTransitiveDependencies == null) { + // // The provider is not scoped, so can never be transitively overridden + // return pointer; + // } + // if (pointer.targetContainer == currentContainer) { + // // The pointer isn't inherited but rather local to the current container, + // // so no need to check for transitive overrides. + // return pointer; + // } + // } if (currentContainer._pointerManager .hasLocallyOverriddenDependency(provider)) { @@ -102,7 +103,7 @@ class ProviderDirectory implements _PointerBase { ProviderDirectory pointer, ) : familyOverride = pointer.familyOverride, targetContainer = pointer.targetContainer, - pointers = HashMap.of(pointer.pointers); + pointers = HashMap.from(pointer.pointers); /// The override associated with this provider, if any. /// @@ -112,7 +113,7 @@ class ProviderDirectory implements _PointerBase { _FamilyOverride? familyOverride; final HashMap, ProviderPointer> pointers; @override - final ProviderContainer targetContainer; + ProviderContainer targetContainer; void addProviderOverride( _ProviderOverride override, { @@ -166,29 +167,33 @@ class ProviderDirectory implements _PointerBase { ProviderElementBase? element; switch ((pointer.providerOverride, familyOverride)) { + // The provider is overridden. This takes over any family override case (final override?, _): element = override.providerOverride.createElement(pointer.targetContainer); + // The family was overridden using overrideWith & co. case (null, final FamilyOverride override): element = override.createElement(pointer.targetContainer, origin); + // Either the provider wasn't overridden or it was scoped. case (null, _FamilyOverride() || null): element = origin.createElement(pointer.targetContainer); } - final overrideProvider = - pointer.providerOverride?.providerOverride ?? origin; + /// Assigning the element before calling "mount" to guarantee + /// that even if something goes very wrong, such as a recursive + /// initialization or "mount" throwing, next read will not try to + /// initialize the provider again. + /// This has otherwise no impact unless there is a bug. + pointer.element = element; // TODO test family(42) overrides on nested containers receive the correct container element - // TODO remove - .._provider = overrideProvider // TODO remove .._origin = origin // TODO make this optional ..mount(); - pointer.element = element; } return pointer; @@ -314,13 +319,15 @@ class ProviderPointerManager { final previousPointer = familyPointers[overriddenFamily]; if (previousPointer != null) { /// A provider from that family was overridden first. - /// We override the family but preserve the provider override too. - - previousPointer.familyOverride = override; - // Remove inherited family values and keep only local ones - previousPointer.pointers.removeWhere( - (key, value) => value.targetContainer != container, - ); + /// We override the family but preserve the provider overrides too. + + previousPointer + ..familyOverride = override + ..targetContainer = container + // Remove inherited family values and keep only local ones + ..pointers.removeWhere( + (key, value) => value.targetContainer != container, + ); continue; } diff --git a/packages/riverpod/lib/src/core/scheduler.dart b/packages/riverpod/lib/src/core/scheduler.dart index c788706e5..683249186 100644 --- a/packages/riverpod/lib/src/core/scheduler.dart +++ b/packages/riverpod/lib/src/core/scheduler.dart @@ -100,7 +100,7 @@ class ProviderScheduler { ) { assert( !element.hasListeners, - 'Tried to dispose ${element._provider} , but still has listeners', + 'Tried to dispose ${element.origin} , but still has listeners', ); _stateToDispose.add(element); diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose.dart index 7aecaeaf8..08bb25bbb 100644 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose.dart +++ b/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose.dart @@ -134,5 +134,5 @@ class AutoDisposeAsyncNotifierProviderElement< implements AutoDisposeAsyncNotifierProviderRef { /// The [ProviderElementBase] for [AsyncNotifierProvider] @internal - AutoDisposeAsyncNotifierProviderElement(super._provider, super.container); + AutoDisposeAsyncNotifierProviderElement(super.provider, super.container); } diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier/base.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/base.dart index 9c2677693..919992a33 100644 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/async_notifier/base.dart @@ -489,7 +489,7 @@ abstract class AsyncNotifierProviderElementBase< with FutureHandlerProviderElementMixin { /// The element of [AsyncNotifierProvider]. @internal - AsyncNotifierProviderElementBase(super._provider, super.container); + AsyncNotifierProviderElementBase(super.container); final _notifierNotifier = ProxyElementValueNotifier(); @@ -526,15 +526,13 @@ class AsyncNotifierProviderElement, T> implements AsyncNotifierProviderRef { /// The element of [AsyncNotifierProvider]. @internal - AsyncNotifierProviderElement( - AsyncNotifierProviderBase super._provider, - super.container, - ); + AsyncNotifierProviderElement(this.provider, super.container); @override - void create({required bool didChangeDependency}) { - final provider = this.provider as AsyncNotifierProviderBase; + final AsyncNotifierProviderBase provider; + @override + void create({required bool didChangeDependency}) { final notifierResult = _notifierNotifier.result ??= Result.guard(() { return provider._createNotifier().._setElement(this); }); diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart index 5f0f0220c..9601dcc7d 100644 --- a/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart @@ -147,10 +147,10 @@ class StateNotifierProvider, T> class StateNotifierProviderElement, T> extends ProviderElementBase implements StateNotifierProviderRef { - StateNotifierProviderElement._( - _StateNotifierProviderBase super._provider, - super.container, - ); + StateNotifierProviderElement._(this.provider, super.container); + + @override + final _StateNotifierProviderBase provider; @override NotifierT get notifier => _notifierNotifier.value; @@ -160,8 +160,6 @@ class StateNotifierProviderElement, T> @override void create({required bool didChangeDependency}) { - final provider = this.provider as _StateNotifierProviderBase; - final notifier = _notifierNotifier.result = Result.guard(() => provider._create(this)); diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart index 1475ac3d3..4f933acff 100644 --- a/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart @@ -111,10 +111,10 @@ class StateProvider extends _StateProviderBase { /// The element of [StateProvider]. class StateProviderElement extends ProviderElementBase implements StateProviderRef { - StateProviderElement._( - _StateProviderBase super._provider, - super.container, - ); + StateProviderElement._(this.provider, super.container); + + @override + final _StateProviderBase provider; @override StateController get controller => _controllerNotifier.value; @@ -126,7 +126,6 @@ class StateProviderElement extends ProviderElementBase @override void create({required bool didChangeDependency}) { - final provider = this.provider as _StateProviderBase; final initialState = provider._create(this); final controller = StateController(initialState); diff --git a/packages/riverpod/lib/src/legacy_providers/future_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/future_provider/base.dart index 9211fac34..b89ed5193 100644 --- a/packages/riverpod/lib/src/legacy_providers/future_provider/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/future_provider/base.dart @@ -91,11 +91,10 @@ class FutureProviderElement extends ProviderElementBase> implements FutureProviderRef { /// The element of a [FutureProvider] @internal - FutureProviderElement( - // ignore: library_private_types_in_public_api - _FutureProviderBase super._provider, - super.container, - ); + FutureProviderElement(this.provider, super.container); + + @override + final _FutureProviderBase provider; @override Future get future { @@ -105,8 +104,6 @@ class FutureProviderElement extends ProviderElementBase> @override void create({required bool didChangeDependency}) { - final provider = this.provider as _FutureProviderBase; - handleFuture( () => provider._create(this), didChangeDependency: didChangeDependency, diff --git a/packages/riverpod/lib/src/legacy_providers/notifier/base.dart b/packages/riverpod/lib/src/legacy_providers/notifier/base.dart index a0134ff3b..f5e79f39f 100644 --- a/packages/riverpod/lib/src/legacy_providers/notifier/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/notifier/base.dart @@ -192,17 +192,15 @@ class NotifierProviderElement, T> extends ProviderElementBase implements NotifierProviderRef { /// The element of [NotifierProvider]. @internal - NotifierProviderElement( - NotifierProviderBase super._provider, - super.container, - ); + NotifierProviderElement(this.provider, super.container); + + @override + final NotifierProviderBase provider; final _notifierNotifier = ProxyElementValueNotifier(); @override void create({required bool didChangeDependency}) { - final provider = this.provider as NotifierProviderBase; - final notifierResult = _notifierNotifier.result ??= Result.guard(() { return provider._createNotifier().._setElement(this); }); diff --git a/packages/riverpod/lib/src/legacy_providers/provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/provider/auto_dispose.dart index 6ec2418c6..87610cac0 100644 --- a/packages/riverpod/lib/src/legacy_providers/provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/legacy_providers/provider/auto_dispose.dart @@ -72,7 +72,7 @@ class AutoDisposeProviderElement extends ProviderElement /// The [ProviderElementBase] for [Provider] @internal AutoDisposeProviderElement( - AutoDisposeProvider super._provider, + AutoDisposeProvider super.provider, super.container, ); } diff --git a/packages/riverpod/lib/src/legacy_providers/provider/base.dart b/packages/riverpod/lib/src/legacy_providers/provider/base.dart index 6a623c431..1b49dbd06 100644 --- a/packages/riverpod/lib/src/legacy_providers/provider/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/provider/base.dart @@ -326,7 +326,10 @@ class ProviderElement extends ProviderElementBase implements ProviderRef { /// A [ProviderElementBase] for [Provider] @internal - ProviderElement(super._provider, super.container); + ProviderElement(this.provider, super.container); + + @override + final InternalProvider provider; @override State get state => requireState; @@ -336,8 +339,6 @@ class ProviderElement extends ProviderElementBase @override void create({required bool didChangeDependency}) { - final provider = this.provider as InternalProvider; - setState(provider._create(this)); } diff --git a/packages/riverpod/lib/src/legacy_providers/stream_notifier/base.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/base.dart index ca075e1ec..46fe7633e 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_notifier/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_notifier/base.dart @@ -143,15 +143,13 @@ class StreamNotifierProviderElement, T> implements StreamNotifierProviderRef { /// The element of [StreamNotifierProvider]. @internal - StreamNotifierProviderElement( - StreamNotifierProviderBase super._provider, - super.container, - ); + StreamNotifierProviderElement(this.provider, super.container); @override - void create({required bool didChangeDependency}) { - final provider = this.provider as StreamNotifierProviderBase; + final StreamNotifierProviderBase provider; + @override + void create({required bool didChangeDependency}) { final notifierResult = _notifierNotifier.result ??= Result.guard(() { return provider._createNotifier().._setElement(this); }); diff --git a/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart index a5bc6c30b..34b01ffa9 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart @@ -141,11 +141,12 @@ class StreamProviderElement extends ProviderElementBase> implements StreamProviderRef { /// The element of [StreamProvider]. @internal - StreamProviderElement( - // ignore: library_private_types_in_public_api - _StreamProviderBase super._provider, - super.container, - ); + StreamProviderElement(this.provider, super.container); + + // TODO remove all ignores + + @override + final _StreamProviderBase provider; final _streamNotifier = ProxyElementValueNotifier>(); final StreamController _streamController = StreamController.broadcast(); @@ -156,10 +157,7 @@ class StreamProviderElement extends ProviderElementBase> _streamNotifier.result ??= Result.data(_streamController.stream); handleStream( - () { - final provider = this.provider as _StreamProviderBase; - return provider._create(this); - }, + () => provider._create(this), didChangeDependency: didChangeDependency, ); } diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index fd55f05ef..5c5c92d1c 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -1148,8 +1148,6 @@ void main() { ); }); - // TODO throw if trying to cope a provider/family with no dependencies - test('orphanPointers.containers are always equal to root', () { final root = ProviderContainer.test(); final provider = Provider( @@ -1178,6 +1176,71 @@ void main() { }, ); }); + + test('can scope a provider that is already scoped', () { + final provider = Provider((_) => 0, dependencies: const []); + final family = Provider.family( + (_, b) => 0, + dependencies: const [], + ); + final root = ProviderContainer.test(); + + final providerOverride1 = provider.overrideWithValue(1); + final familyOverride1 = family.overrideWith((ref, arg) => 1); + final mid = ProviderContainer.test( + parent: root, + overrides: [providerOverride1, familyOverride1], + ); + + final providerOverride2 = provider.overrideWithValue(1); + final familyOverride2 = family.overrideWith((ref, arg) => 1); + final leaf = ProviderContainer.test( + parent: mid, + overrides: [providerOverride2, familyOverride2], + ); + + expect( + leaf.pointerManager.orphanPointers.pointers, + { + provider: isPointer( + targetContainer: leaf, + override: providerOverride2, + element: null, + ), + }, + ); + expect( + leaf.pointerManager.familyPointers, + { + family: isProviderDirectory( + override: familyOverride2, + targetContainer: leaf, + pointers: isEmpty, + ), + }, + ); + + expect( + mid.pointerManager.orphanPointers.pointers, + { + provider: isPointer( + targetContainer: mid, + override: providerOverride1, + element: null, + ), + }, + ); + expect( + mid.pointerManager.familyPointers, + { + family: isProviderDirectory( + override: familyOverride1, + targetContainer: mid, + pointers: isEmpty, + ), + }, + ); + }); }); test('adds non-family provider overrides to orphanPointers', () { diff --git a/packages/riverpod/test/old/framework/scope_test.dart b/packages/riverpod/test/old/framework/scope_test.dart index 7bc004974..abac40872 100644 --- a/packages/riverpod/test/old/framework/scope_test.dart +++ b/packages/riverpod/test/old/framework/scope_test.dart @@ -1,8 +1,11 @@ // Tests related to scoping providers import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; +import '../../new/core/provider_container_test.dart'; + Future main() async { test( 'transitive dependencies includes the transitive dependencies of families', @@ -84,11 +87,19 @@ Future main() async { expect(mid.read(a(10)), 20); + final override2 = a.overrideWith((ref, argument) => argument + 20); final child = ProviderContainer.test( parent: mid, - overrides: [ - a.overrideWith((ref, argument) => argument + 20), - ], + overrides: [override2], + ); + + expect( + child.pointerManager.familyPointers[a], + isProviderDirectory( + override: override2, + targetContainer: child, + pointers: {}, + ), ); expect(child.read(a(10)), 30); From e34d4ca495a7f557668cd63b6ddbb7221f047eb5 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 28 Dec 2023 19:00:56 +0100 Subject: [PATCH 102/387] Better handle auto-scoping --- .../lib/src/core/provider_container.dart | 55 +++--- .../new/core/provider_container_test.dart | 177 ++++++++++++++++-- 2 files changed, 187 insertions(+), 45 deletions(-) diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 7042ad000..ed1548348 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -59,32 +59,21 @@ extension final pointer = this[provider]; if (pointer != null) return pointer; - // if (pointer != null) { - // // TODO what about family(42) overrides on nested containers? - // if (provider.allTransitiveDependencies == null) { - // // The provider is not scoped, so can never be transitively overridden - // return pointer; - // } - // if (pointer.targetContainer == currentContainer) { - // // The pointer isn't inherited but rather local to the current container, - // // so no need to check for transitive overrides. - // return pointer; - // } - // } - - if (currentContainer._pointerManager - .hasLocallyOverriddenDependency(provider)) { - return this[provider] = scope(override: provider); - } + final deepestTransitiveDependencyContainer = currentContainer + ._pointerManager + .findDeepestTransitiveDependencyProviderContainer(provider); - // Where the provider should be mounted - final target = pointer?.targetContainer ?? + final target = deepestTransitiveDependencyContainer ?? + pointer?.targetContainer ?? targetContainer ?? currentContainer._root ?? currentContainer; if (target == currentContainer) { - return this[provider] = scope(); + return this[provider] = scope( + override: + deepestTransitiveDependencyContainer == null ? null : provider, + ); } return this[provider] = inherit(target); @@ -141,7 +130,7 @@ class ProviderDirectory implements _PointerBase { inherit: (target) => target._pointerManager.upsertPointer(provider), scope: ({override}) => ProviderPointer( targetContainer: currentContainer, - providerOverride: override == null // + providerOverride: override == null || provider.from != null // ? null : TransitiveProviderOverride(override), ), @@ -357,20 +346,32 @@ class ProviderPointerManager { return container == this.container; } - /// Whether a provider has a transitive dependency that is overridden in this container. - bool hasLocallyOverriddenDependency(ProviderOrFamily provider) { - if (container._parent == null) return false; + /// Obtains the [ProviderContainer] in which provider/family should be mounted, + /// if the provider is locally scoped. + /// + /// Returns `null` if it should be mounted at the root. + ProviderContainer? findDeepestTransitiveDependencyProviderContainer( + ProviderOrFamily provider) { + if (container._parent == null) return null; final transitiveDependencies = provider.allTransitiveDependencies; /// If the provider has no dependencies, it cannot be locally overridden. - if (transitiveDependencies == null) return false; + if (transitiveDependencies == null) return null; + ProviderContainer? deepestContainer; for (final dependency in transitiveDependencies) { - if (isLocallyMounted(dependency)) return true; + final target = switch (dependency) { + Family() => familyPointers[dependency]?.targetContainer, + ProviderBase() => readPointer(dependency)?.targetContainer, + }; + if (target == null || target.depth == 0) continue; + if (deepestContainer == null || deepestContainer.depth < target.depth) { + deepestContainer = target; + } } - return false; + return deepestContainer; } /// Initializes a family and returns its pointer. diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index 5c5c92d1c..45df2731c 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -157,22 +157,22 @@ void main() { }); }); - group('hasLocallyOverriddenDependency', () { - final dependency = Provider( + group('findDeepestTransitiveDependencyProviderContainer', () { + final transitiveDependency = Provider( (_) => 0, dependencies: const [], ); - final transitiveDependency = Provider( + final dependency = Provider( (_) => 0, - dependencies: const [], + dependencies: [transitiveDependency], ); final a = Provider( (_) => 0, - dependencies: [dependency, transitiveDependency], + dependencies: [dependency], ); - test('always returns false if has no dependency', () { + test('always returns null if has no dependency', () { final provider = Provider((_) => 0); final root = ProviderContainer.test(); final container = ProviderContainer.test( @@ -184,12 +184,14 @@ void main() { ); expect( - container.pointerManager.hasLocallyOverriddenDependency(provider), - false, + container.pointerManager + .findDeepestTransitiveDependencyProviderContainer(provider), + null, ); }); - test('returns false if the root container', () { + test('returns null if the dependency is overridden in the root container', + () { final root = ProviderContainer.test( overrides: [ dependency.overrideWithValue(42), @@ -197,13 +199,14 @@ void main() { ); expect( - root.pointerManager.hasLocallyOverriddenDependency(a), - false, + root.pointerManager + .findDeepestTransitiveDependencyProviderContainer(a), + null, ); }); test( - 'returns true in a scoped container with overridden direct dependency', + "for direct dependencies, returns the dependency's container if overridden", () { final root = ProviderContainer.test(); final container = ProviderContainer.test( @@ -212,15 +215,23 @@ void main() { dependency.overrideWithValue(42), ], ); + final leaf = ProviderContainer.test( + parent: container, + overrides: [ + // Unrelated override, to avoid the container optimizing the pointer away + Provider((ref) => null, dependencies: const []), + ], + ); expect( - container.pointerManager.hasLocallyOverriddenDependency(a), - true, + leaf.pointerManager + .findDeepestTransitiveDependencyProviderContainer(a), + container, ); }); test( - 'returns true in a scoped container with overridden transitive dependency', + "for transitive dependencies, returns the dependency's container if overridden", () { final root = ProviderContainer.test(); final container = ProviderContainer.test( @@ -229,10 +240,65 @@ void main() { transitiveDependency.overrideWithValue(42), ], ); + final leaf = ProviderContainer.test( + parent: container, + overrides: [ + // Unrelated override, to avoid the container optimizing the pointer away + Provider((ref) => null, dependencies: const []), + ], + ); + + expect( + leaf.pointerManager + .findDeepestTransitiveDependencyProviderContainer(a), + container, + ); + }); + + test( + 'if multiple dependencies are overridden, returns the deepest container', + () { + final dep2 = Provider( + (_) => 0, + dependencies: const [], + ); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [ + dependency.overrideWithValue(42), + ], + ); + final container2 = ProviderContainer.test( + parent: container, + overrides: [ + dep2.overrideWithValue(42), + ], + ); + final leaf = ProviderContainer.test( + parent: container2, + overrides: [ + // Unrelated override, to avoid the container optimizing the pointer away + Provider((ref) => null, dependencies: const []), + ], + ); + + final b = Provider( + (_) => 0, + dependencies: [dep2], + ); + + expect( + leaf.pointerManager + .findDeepestTransitiveDependencyProviderContainer(a), + // Does not care about dep2, so points to 'container' + container, + ); expect( - container.pointerManager.hasLocallyOverriddenDependency(a), - true, + leaf.pointerManager + .findDeepestTransitiveDependencyProviderContainer(b), + container2, ); }); }); @@ -422,7 +488,7 @@ void main() { pointer, isPointer( targetContainer: container, - override: isTransitiveProviderOverride(family(42)), + override: null, ), ); expect( @@ -468,6 +534,81 @@ void main() { ); }); + test('auto-scoping inserts at the correct container', () { + final dep = Provider((_) => 0, dependencies: const [], name: 'dep'); + final dep2 = Provider((_) => 0, dependencies: const [], name: 'dep2'); + + final a = Provider((ref) => 0, dependencies: [dep], name: 'a'); + final b = Provider((ref) => 0, dependencies: [dep2], name: 'b'); + final c = Provider.family( + (ref, id) => 0, + dependencies: [dep], + name: 'c', + ); + final d = Provider.family( + (ref, id) => 0, + dependencies: [dep2], + name: 'd', + ); + + final root = ProviderContainer.test(); + final mid = ProviderContainer.test(parent: root, overrides: [dep]); + final mid2 = ProviderContainer.test(parent: mid, overrides: [dep2]); + final leaf = ProviderContainer.test(parent: mid2, overrides: [ + // Disable scoping optimization + Provider((ref) => null, dependencies: const []), + ]); + + leaf.pointerManager.upsertPointer(a); + leaf.pointerManager.upsertPointer(b); + leaf.pointerManager.upsertPointer(c(0)); + leaf.pointerManager.upsertPointer(d(0)); + + expect( + leaf.pointerManager.orphanPointers, + isProviderDirectory( + targetContainer: root, + override: null, + pointers: allOf( + containsPair( + a, + isPointer( + targetContainer: mid, + override: isTransitiveProviderOverride(a), + ), + ), + containsPair( + b, + isPointer( + targetContainer: mid2, + override: isTransitiveProviderOverride(b), + ), + ), + ), + ), + ); + + expect( + leaf.pointerManager.familyPointers, + { + c: isProviderDirectory( + targetContainer: mid, + override: isTransitiveFamilyOverride(c), + pointers: { + c(0): isPointer(targetContainer: mid, override: null), + }, + ), + d: isProviderDirectory( + targetContainer: mid2, + override: isTransitiveFamilyOverride(d), + pointers: { + d(0): isPointer(targetContainer: mid2, override: null), + }, + ), + }, + ); + }); + test( 'have ancestors and children share their pointers when not overridden', () { From 4dd919ef68a7daf5b3ebe66d12eeb13af752e8d7 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 28 Dec 2023 19:03:59 +0100 Subject: [PATCH 103/387] Fix more --- packages/riverpod/lib/src/core/provider_container.dart | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index ed1548348..5f0657401 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -1012,7 +1012,8 @@ final b = Provider((ref) => ref.watch(a), dependencies: [a]); return _pointerManager .listProviderPointers() .map((e) => e.element) - .whereNotNull(); + .whereNotNull() + .where((e) => e.container == this); } /// Visit all nodes of the graph at most once, from roots to leaves. From ce567e9672238bc279a9c9cdb5c5c3ddfe847a26 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 28 Dec 2023 19:06:59 +0100 Subject: [PATCH 104/387] Almost there --- packages/riverpod/test/old/framework/scope_test.dart | 5 ++++- .../riverpod/test/old/legacy/framework2/framework_test.dart | 4 ++-- .../deprecated/state_notifier_provider/family_test.dart | 4 +--- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/packages/riverpod/test/old/framework/scope_test.dart b/packages/riverpod/test/old/framework/scope_test.dart index abac40872..c4d95ec3b 100644 --- a/packages/riverpod/test/old/framework/scope_test.dart +++ b/packages/riverpod/test/old/framework/scope_test.dart @@ -693,7 +693,10 @@ Future main() async { }); test('auto scope transitive family dependencies', () { - final family = Provider.family((ref, id) => id * 2); + final family = Provider.family( + (ref, id) => id * 2, + dependencies: [], + ); final dep = Provider( (ref) => ref.watch(family(21)), dependencies: [family], diff --git a/packages/riverpod/test/old/legacy/framework2/framework_test.dart b/packages/riverpod/test/old/legacy/framework2/framework_test.dart index db7a2f97c..8a1007e2f 100644 --- a/packages/riverpod/test/old/legacy/framework2/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework2/framework_test.dart @@ -79,13 +79,13 @@ void main() { expect(family2(0).name, 'name'); expect( family2(0).toString(), - equalsIgnoringHashCodes('name:Provider#00000(0)'), + equalsIgnoringHashCodes('name(0)'), ); expect(family2(1).name, 'name'); expect( family2(1).toString(), - equalsIgnoringHashCodes('name:Provider#00000(1)'), + equalsIgnoringHashCodes('name(1)'), ); }); }); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart index 4fe7d9680..4e725767d 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart @@ -103,9 +103,7 @@ void main() { expect( family('foo').toString(), - equalsIgnoringHashCodes( - 'Example:StateNotifierProvider#05480(foo)', - ), + equalsIgnoringHashCodes('Example(foo)'), ); }, ); From 30348731615980b95ef118e921b8b69ddc9ab9ee Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 28 Dec 2023 21:46:03 +0100 Subject: [PATCH 105/387] 3 remaining! --- examples/pub/lib/detail.g.dart | 10 +- examples/pub/lib/search.g.dart | 5 +- packages/riverpod/lib/src/core/family.dart | 14 ++- packages/riverpod/lib/src/core/provider.dart | 5 +- .../lib/src/core/provider_container.dart | 17 ++- .../new/core/provider_container_test.dart | 117 +++++++++++++++++- .../test/old/framework/scope_test.dart | 6 +- .../scoped_provider/scoped_provider_test.dart | 2 +- .../integration/build_yaml/lib/main.g.dart | 29 ++--- .../lib/src/templates/family.dart | 4 +- .../test/dependencies_test.dart | 7 ++ .../test/integration/annotated.g.dart | 9 +- .../test/integration/async.g.dart | 27 ++-- .../test/integration/dependencies.g.dart | 12 +- .../test/integration/dependencies2.g.dart | 10 +- .../test/integration/generated.g.dart | 34 +++-- .../test/integration/stream.g.dart | 18 ++- .../test/integration/sync.g.dart | 43 +++---- .../riverpod_generator/test/sync_test.dart | 18 --- .../generated/golden/lib/sync.g.dart | 9 +- ..._class_based_provider_to_functional.g.dart | 9 +- ..._functional_provider_to_class_based.g.dart | 5 +- .../avoid_build_context_in_providers.g.dart | 9 +- .../avoid_public_notifier_properties.g.dart | 5 +- .../test/lints/dependencies.g.dart | 9 +- .../functional_ref/functional_ref.g.dart | 19 ++- .../notifier_extends/notifier_extends.g.dart | 19 ++- .../protected_notifier_properties.g.dart | 24 ++-- .../test/lints/provider_parameters.g.dart | 4 +- .../docs/concepts/about_codegen/main.g.dart | 4 +- .../about_codegen/provider_type/family.g.dart | 4 +- .../provider_type/family_class.g.dart | 4 +- .../provider_type/family_fn.g.dart | 4 +- .../invalidate_family_example/codegen.g.dart | 4 +- .../passing_args/codegen/family.g.dart | 4 +- .../passing_args/codegen/provider.g.dart | 5 +- .../docs/from_provider/family/family.g.dart | 4 +- .../introduction/why_riverpod/codegen.g.dart | 5 +- .../family_and_dispose.g.dart | 5 +- .../current/about_codegen/main.g.dart | 4 +- .../current/about_codegen/main.g.dart | 4 +- .../current/about_codegen/main.g.dart | 4 +- .../current/about_codegen/main.g.dart | 4 +- 43 files changed, 314 insertions(+), 244 deletions(-) diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 03a855261..33cf0e3a2 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -110,9 +110,8 @@ class FetchPackageDetailsProvider extends AutoDisposeFutureProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$fetchPackageDetailsHash, - dependencies: FetchPackageDetailsFamily._dependencies, - allTransitiveDependencies: - FetchPackageDetailsFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, packageName: packageName, ); @@ -358,9 +357,8 @@ class PackageMetricsProvider extends AutoDisposeAsyncNotifierProviderImpl< const bool.fromEnvironment('dart.vm.product') ? null : _$packageMetricsHash, - dependencies: PackageMetricsFamily._dependencies, - allTransitiveDependencies: - PackageMetricsFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, packageName: packageName, ); diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 5f41d38a3..c93d95448 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -113,9 +113,8 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { const bool.fromEnvironment('dart.vm.product') ? null : _$fetchPackagesHash, - dependencies: FetchPackagesFamily._dependencies, - allTransitiveDependencies: - FetchPackagesFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, page: page, search: search, ); diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index 52feefd42..2248d79d6 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -6,8 +6,10 @@ typedef ProviderCreate = ProviderT Function( Create create, { required String? name, - required Iterable? dependencies, - required Set? allTransitiveDependencies, + // ignore: prefer_void_to_null, explicitly using Null to cause a compilation error if non-null value is assigned + required Null dependencies, + // ignore: prefer_void_to_null, explicitly using Null to cause a compilation error if non-null value is assigned + required Null allTransitiveDependencies, required DebugGetCreateSourceHash? debugGetCreateSourceHash, Family from, Object? argument, @@ -85,8 +87,8 @@ class FamilyBase, R, Arg, Created, name: name, from: this, argument: argument, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, debugGetCreateSourceHash: debugGetCreateSourceHash, ); } @@ -138,8 +140,8 @@ class AutoDisposeFamilyBase, R, Arg, Created, name: name, from: this, argument: argument, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, debugGetCreateSourceHash: debugGetCreateSourceHash, ); } diff --git a/packages/riverpod/lib/src/core/provider.dart b/packages/riverpod/lib/src/core/provider.dart index 2a6611b25..f5a005df4 100644 --- a/packages/riverpod/lib/src/core/provider.dart +++ b/packages/riverpod/lib/src/core/provider.dart @@ -36,7 +36,10 @@ abstract class ProviderBase extends ProviderOrFamily required this.debugGetCreateSourceHash, required super.dependencies, required super.allTransitiveDependencies, - }); + }) : assert( + from == null || allTransitiveDependencies == null, + 'When from a family, providers cannot specify dependencies.', + ); /// {@template riverpod.create_source_hash} /// A debug-only function for obtaining a hash of the source code of the diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 5f0657401..63f73fa41 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -10,6 +10,8 @@ extension on String { ProviderBase? _circularDependencyLock; abstract class _PointerBase { + bool get isTransitiveOverride; + /// The container in which the element of this provider will be mounted. ProviderContainer get targetContainer; } @@ -21,6 +23,10 @@ class ProviderPointer implements _PointerBase { required this.targetContainer, }); + @override + bool get isTransitiveOverride => + providerOverride is TransitiveProviderOverride; + /// The override associated with this provider, if any. /// /// If non-null, this pointer should **never** be removed. @@ -92,7 +98,12 @@ class ProviderDirectory implements _PointerBase { ProviderDirectory pointer, ) : familyOverride = pointer.familyOverride, targetContainer = pointer.targetContainer, - pointers = HashMap.from(pointer.pointers); + pointers = HashMap.fromEntries( + pointer.pointers.entries.where((e) => !e.value.isTransitiveOverride), + ); + + @override + bool get isTransitiveOverride => familyOverride is TransitiveFamilyOverride; /// The override associated with this provider, if any. /// @@ -255,7 +266,9 @@ class ProviderPointerManager { ), familyPointers: HashMap.fromEntries( - parent._pointerManager.familyPointers.entries.map( + parent._pointerManager.familyPointers.entries + .where((e) => !e.value.isTransitiveOverride) + .map( (e) { if (e.key.allTransitiveDependencies == null) return e; diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index 45df2731c..7e97259e1 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -39,11 +39,16 @@ TypeMatcher isTransitiveFamilyOverride( return isA().having((f) => f.from, 'from', family); } -TypeMatcher isTransitiveProviderOverride( - Object? provider, -) { - return isA() - .having((f) => f.origin, 'origin', provider); +TypeMatcher isTransitiveProviderOverride([ + Object? provider = _sentinel, +]) { + var matcher = isA(); + + if (provider != _sentinel) { + matcher = matcher.having((f) => f.origin, 'origin', provider); + } + + return matcher; } TypeMatcher isProviderDirectory({ @@ -534,6 +539,63 @@ void main() { ); }); + test('skips auto-scoping if the provider is manually overridden', () { + final dep = Provider( + (_) => 0, + dependencies: const [], + ); + final family = Provider.family( + (ref, id) => 0, + dependencies: [dep], + ); + final familyOverride = family.overrideWith((ref, arg) => 0); + final provider = Provider((_) => 0, dependencies: [dep]); + final providerOverride = provider.overrideWithValue(42); + + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( + parent: root, + overrides: [familyOverride, providerOverride], + ); + final container = ProviderContainer.test( + parent: mid, + overrides: [dep.overrideWithValue(42)], + ); + + container.pointerManager.upsertPointer(family(42)); + container.pointerManager.upsertPointer(provider); + + expect( + container.pointerManager.familyPointers, + { + family: isProviderDirectory( + targetContainer: mid, + override: familyOverride, + pointers: { + family(42): isPointer( + targetContainer: mid, + override: null, + ), + }, + ), + }, + ); + expect( + container.pointerManager.orphanPointers, + isProviderDirectory( + targetContainer: root, + override: null, + pointers: { + provider: isPointer( + targetContainer: mid, + override: providerOverride, + ), + dep: isNotNull, + }, + ), + ); + }); + test('auto-scoping inserts at the correct container', () { final dep = Provider((_) => 0, dependencies: const [], name: 'dep'); final dep2 = Provider((_) => 0, dependencies: const [], name: 'dep2'); @@ -1150,7 +1212,52 @@ void main() { }); group('on scoped containers', () { + test('does not inherit transitive overrides', () { + final unrelated = Provider((_) => 0, dependencies: const []); + final dep = Provider( + (_) => 0, + dependencies: const [], + name: 'dep', + ); + final provider = Provider((_) => 0, dependencies: [dep], name: 'a'); + final family = Provider.family( + (_, d) => 0, + dependencies: [dep], + name: 'b', + ); + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( + parent: root, + overrides: [dep], + ); + + mid.pointerManager.upsertPointer(provider); + mid.pointerManager.upsertPointer(family(42)); + + final container = ProviderContainer.test( + parent: mid, + overrides: [ + // An unrelated override, added to avoid the container optimizing + unrelated, + ], + ); + + expect( + container.pointerManager.orphanPointers.pointers, + { + dep: isPointer(targetContainer: mid, override: dep), + unrelated: isPointer(), + }, + ); + expect( + container.pointerManager.familyPointers, + isEmpty, + ); + }); + test('inherits overrides from its parents', () { + // TODO test that inheriting a transitively overridden family which contains family(arg) overrides preserves the family(arg) overrides + final a = Provider((_) => 0, name: 'a'); final aOverride = a.overrideWithValue(1); final b = Provider( diff --git a/packages/riverpod/test/old/framework/scope_test.dart b/packages/riverpod/test/old/framework/scope_test.dart index c4d95ec3b..9c98fcc3d 100644 --- a/packages/riverpod/test/old/framework/scope_test.dart +++ b/packages/riverpod/test/old/framework/scope_test.dart @@ -249,7 +249,7 @@ Future main() async { ); final provider = Provider.family( (ref, value) => '$value ${ref.watch(dep)}', - dependencies: const [], + dependencies: [dep], ); final root = ProviderContainer.test(); final container = ProviderContainer.test( @@ -322,7 +322,7 @@ Future main() async { callCount++; return '$value ${ref.watch(dep)}'; }, - dependencies: const [], + dependencies: [dep], ); final root = ProviderContainer.test(); final mid = ProviderContainer.test( @@ -872,7 +872,7 @@ Future main() async { ); final b = Provider.family( (ref, _) => ref.watch(a), - dependencies: [a], + dependencies: [a, another], ); final root = ProviderContainer.test( diff --git a/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart index d8f44fac8..752db9721 100644 --- a/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart @@ -130,7 +130,7 @@ void main() { ); final provider2 = Provider( (ref) => ref.watch(provider) * 2, - dependencies: const [], + dependencies: [provider], ); final root = ProviderContainer.test(); final container = ProviderContainer.test( diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index d06c7a914..acb061de0 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -148,8 +148,8 @@ class Count2Provider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$count2Hash, - dependencies: Count2Family._dependencies, - allTransitiveDependencies: Count2Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, a: a, ); @@ -318,9 +318,8 @@ class CountFuture2Provider extends AutoDisposeFutureProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$countFuture2Hash, - dependencies: CountFuture2Family._dependencies, - allTransitiveDependencies: - CountFuture2Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, a: a, ); @@ -489,9 +488,8 @@ class CountStream2Provider extends AutoDisposeStreamProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$countStream2Hash, - dependencies: CountStream2Family._dependencies, - allTransitiveDependencies: - CountStream2Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, a: a, ); @@ -716,9 +714,8 @@ class CountNotifier2Provider const bool.fromEnvironment('dart.vm.product') ? null : _$countNotifier2Hash, - dependencies: CountNotifier2Family._dependencies, - allTransitiveDependencies: - CountNotifier2Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, a: a, ); @@ -903,9 +900,8 @@ class CountAsyncNotifier2Provider const bool.fromEnvironment('dart.vm.product') ? null : _$countAsyncNotifier2Hash, - dependencies: CountAsyncNotifier2Family._dependencies, - allTransitiveDependencies: - CountAsyncNotifier2Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, a: a, ); @@ -1090,9 +1086,8 @@ class CountStreamNotifier2Provider const bool.fromEnvironment('dart.vm.product') ? null : _$countStreamNotifier2Hash, - dependencies: CountStreamNotifier2Family._dependencies, - allTransitiveDependencies: - CountStreamNotifier2Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, a: a, ); diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 5d3aa3664..2fb076c6a 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -365,8 +365,8 @@ class $providerTypeNameImpl$typeParametersDefinition extends $providerType$provi from: $providerName, name: r'$providerName', debugGetCreateSourceHash: $hashFn, - dependencies: $familyName._dependencies, - allTransitiveDependencies: $familyName._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ${parameters.map((e) => '${e.name}: ${e.name},\n').join()} ); diff --git a/packages/riverpod_generator/test/dependencies_test.dart b/packages/riverpod_generator/test/dependencies_test.dart index 1553811a9..86f489f5e 100644 --- a/packages/riverpod_generator/test/dependencies_test.dart +++ b/packages/riverpod_generator/test/dependencies_test.dart @@ -85,6 +85,13 @@ void main() { ); }); + test( + 'On families, passes `null` as dependencies/allTransitiveDependencies to the providers', + () { + expect(provider4Provider(42).dependencies, null); + expect(provider4Provider(42).allTransitiveDependencies, null); + }); + test('Caches dependencies', () { expect( providerProvider.dependencies, diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index afe2b63e0..9d7ff448f 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -126,8 +126,8 @@ class FamilyProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$familyHash, - dependencies: FamilyFamily._dependencies, - allTransitiveDependencies: FamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, id: id, ); @@ -312,9 +312,8 @@ class NotCopiedFamilyProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$notCopiedFamilyHash, - dependencies: NotCopiedFamilyFamily._dependencies, - allTransitiveDependencies: - NotCopiedFamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, id: id, ); diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 07c12dd01..cc8449f43 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -102,8 +102,8 @@ class GenericProvider const bool.fromEnvironment('dart.vm.product') ? null : _$genericHash, - dependencies: GenericFamily._dependencies, - allTransitiveDependencies: GenericFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); GenericProvider._internal( @@ -288,8 +288,8 @@ class FamilyOrProvider extends AutoDisposeFutureProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$familyOrHash, - dependencies: FamilyOrFamily._dependencies, - allTransitiveDependencies: FamilyOrFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, first: first, ); @@ -474,8 +474,8 @@ class FamilyProvider extends AutoDisposeFutureProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$familyHash, - dependencies: FamilyFamily._dependencies, - allTransitiveDependencies: FamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, first: first, second: second, third: third, @@ -703,9 +703,8 @@ class GenericClassProvider const bool.fromEnvironment('dart.vm.product') ? null : _$genericClassHash, - dependencies: GenericClassFamily._dependencies, - allTransitiveDependencies: - GenericClassFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); GenericClassProvider._internal( @@ -906,9 +905,8 @@ class FamilyOrClassProvider const bool.fromEnvironment('dart.vm.product') ? null : _$familyOrClassHash, - dependencies: FamilyOrClassFamily._dependencies, - allTransitiveDependencies: - FamilyOrClassFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, first: first, ); @@ -1116,9 +1114,8 @@ class FamilyClassProvider const bool.fromEnvironment('dart.vm.product') ? null : _$familyClassHash, - dependencies: FamilyClassFamily._dependencies, - allTransitiveDependencies: - FamilyClassFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, first: first, second: second, third: third, diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 56437f927..b6775918a 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -120,8 +120,8 @@ class FamilyProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$familyHash, - dependencies: FamilyFamily._dependencies, - allTransitiveDependencies: FamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, id: id, ); @@ -473,8 +473,8 @@ class Family2Provider extends AutoDisposeNotifierProviderImpl { const bool.fromEnvironment('dart.vm.product') ? null : _$family2Hash, - dependencies: Family2Family._dependencies, - allTransitiveDependencies: Family2Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, id: id, ); @@ -699,8 +699,8 @@ class Provider4Provider const bool.fromEnvironment('dart.vm.product') ? null : _$provider4Hash, - dependencies: Provider4Family._dependencies, - allTransitiveDependencies: Provider4Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, id: id, ); diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 1525244dd..acb75115c 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -146,9 +146,8 @@ class FamilyWithDependencies2Provider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$familyWithDependencies2Hash, - dependencies: FamilyWithDependencies2Family._dependencies, - allTransitiveDependencies: - FamilyWithDependencies2Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, id: id, ); @@ -398,9 +397,8 @@ class NotifierFamilyWithDependenciesProvider const bool.fromEnvironment('dart.vm.product') ? null : _$notifierFamilyWithDependenciesHash, - dependencies: NotifierFamilyWithDependenciesFamily._dependencies, - allTransitiveDependencies: - NotifierFamilyWithDependenciesFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, id: id, ); diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index ea029776d..32382bf36 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -120,9 +120,8 @@ class GeneratedFamilyProvider extends AutoDisposeProvider<_Test> { const bool.fromEnvironment('dart.vm.product') ? null : _$generatedFamilyHash, - dependencies: GeneratedFamilyFamily._dependencies, - allTransitiveDependencies: - GeneratedFamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, test: test, ); @@ -305,9 +304,8 @@ class $DynamicFamilyProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$$dynamicFamilyHash, - dependencies: $DynamicFamilyFamily._dependencies, - allTransitiveDependencies: - $DynamicFamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, test: test, ); @@ -476,8 +474,8 @@ class _DynamicProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$dynamicHash, - dependencies: _DynamicFamily._dependencies, - allTransitiveDependencies: _DynamicFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, test: test, ); @@ -660,9 +658,8 @@ class AliasFamilyProvider extends AutoDisposeProvider> { const bool.fromEnvironment('dart.vm.product') ? null : _$aliasFamilyHash, - dependencies: AliasFamilyFamily._dependencies, - allTransitiveDependencies: - AliasFamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, test: test, ); @@ -855,9 +852,8 @@ class GeneratedClassFamilyProvider const bool.fromEnvironment('dart.vm.product') ? null : _$generatedClassFamilyHash, - dependencies: GeneratedClassFamilyFamily._dependencies, - allTransitiveDependencies: - GeneratedClassFamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, test: test, ); @@ -1058,9 +1054,8 @@ class $DynamicClassFamilyProvider const bool.fromEnvironment('dart.vm.product') ? null : _$$dynamicClassFamilyHash, - dependencies: $DynamicClassFamilyFamily._dependencies, - allTransitiveDependencies: - $DynamicClassFamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, test: test, ); @@ -1259,9 +1254,8 @@ class AliasClassFamilyProvider extends AutoDisposeNotifierProviderImpl< const bool.fromEnvironment('dart.vm.product') ? null : _$aliasClassFamilyHash, - dependencies: AliasClassFamilyFamily._dependencies, - allTransitiveDependencies: - AliasClassFamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, test: test, ); diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index f7d7b541f..2ff6bddca 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -102,8 +102,8 @@ class GenericProvider const bool.fromEnvironment('dart.vm.product') ? null : _$genericHash, - dependencies: GenericFamily._dependencies, - allTransitiveDependencies: GenericFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); GenericProvider._internal( @@ -304,8 +304,8 @@ class FamilyProvider extends AutoDisposeStreamProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$familyHash, - dependencies: FamilyFamily._dependencies, - allTransitiveDependencies: FamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, first: first, second: second, third: third, @@ -533,9 +533,8 @@ class GenericClassProvider const bool.fromEnvironment('dart.vm.product') ? null : _$genericClassHash, - dependencies: GenericClassFamily._dependencies, - allTransitiveDependencies: - GenericClassFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); GenericClassProvider._internal( @@ -761,9 +760,8 @@ class FamilyClassProvider const bool.fromEnvironment('dart.vm.product') ? null : _$familyClassHash, - dependencies: FamilyClassFamily._dependencies, - allTransitiveDependencies: - FamilyClassFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, first: first, second: second, third: third, diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 23ae67c3e..c45764d2c 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -101,8 +101,8 @@ class GenericProvider extends AutoDisposeProvider> { const bool.fromEnvironment('dart.vm.product') ? null : _$genericHash, - dependencies: GenericFamily._dependencies, - allTransitiveDependencies: GenericFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); GenericProvider._internal( @@ -268,9 +268,8 @@ class ComplexGenericProvider const bool.fromEnvironment('dart.vm.product') ? null : _$complexGenericHash, - dependencies: ComplexGenericFamily._dependencies, - allTransitiveDependencies: - ComplexGenericFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, param: param, otherParam: otherParam, ); @@ -492,9 +491,8 @@ class RawFamilyFutureProvider extends AutoDisposeProvider>> { const bool.fromEnvironment('dart.vm.product') ? null : _$rawFamilyFutureHash, - dependencies: RawFamilyFutureFamily._dependencies, - allTransitiveDependencies: - RawFamilyFutureFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, id: id, ); @@ -665,9 +663,8 @@ class RawFamilyStreamProvider extends AutoDisposeProvider>> { const bool.fromEnvironment('dart.vm.product') ? null : _$rawFamilyStreamHash, - dependencies: RawFamilyStreamFamily._dependencies, - allTransitiveDependencies: - RawFamilyStreamFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, id: id, ); @@ -896,8 +893,8 @@ class FamilyProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$familyHash, - dependencies: FamilyFamily._dependencies, - allTransitiveDependencies: FamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, first: first, second: second, third: third, @@ -1153,9 +1150,8 @@ class GenericClassProvider const bool.fromEnvironment('dart.vm.product') ? null : _$genericClassHash, - dependencies: GenericClassFamily._dependencies, - allTransitiveDependencies: - GenericClassFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); GenericClassProvider._internal( @@ -1359,9 +1355,8 @@ class RawFamilyFutureClassProvider extends AutoDisposeNotifierProviderImpl< const bool.fromEnvironment('dart.vm.product') ? null : _$rawFamilyFutureClassHash, - dependencies: RawFamilyFutureClassFamily._dependencies, - allTransitiveDependencies: - RawFamilyFutureClassFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, id: id, ); @@ -1547,9 +1542,8 @@ class RawFamilyStreamClassProvider extends AutoDisposeNotifierProviderImpl< const bool.fromEnvironment('dart.vm.product') ? null : _$rawFamilyStreamClassHash, - dependencies: RawFamilyStreamClassFamily._dependencies, - allTransitiveDependencies: - RawFamilyStreamClassFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, id: id, ); @@ -1802,9 +1796,8 @@ class FamilyClassProvider const bool.fromEnvironment('dart.vm.product') ? null : _$familyClassHash, - dependencies: FamilyClassFamily._dependencies, - allTransitiveDependencies: - FamilyClassFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, first: first, second: second, third: third, diff --git a/packages/riverpod_generator/test/sync_test.dart b/packages/riverpod_generator/test/sync_test.dart index d8ed248c6..c678e548e 100644 --- a/packages/riverpod_generator/test/sync_test.dart +++ b/packages/riverpod_generator/test/sync_test.dart @@ -1,10 +1,5 @@ // ignore_for_file: omit_local_variable_types, unused_local_variable, require_trailing_commas -import 'dart:io'; - -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; -import 'package:path/path.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:test/test.dart'; @@ -213,19 +208,6 @@ void main() { expect(familyProvider(42, third: .42).name, 'familyProvider'); }); - test('Marks getProviderOverride as @visibleForOverriding', () async { - final file = File('test/integration/sync.dart'); - final path = normalize(file.absolute.path); - - final library = await resolveFile2(path: path); - library as ResolvedUnitResult; - - final clazz = library.libraryElement.getClass('FamilyClassFamily')!; - final method = clazz.getMethod('getProviderOverride')!; - - expect(method.hasVisibleForOverriding, isTrue); - }); - test( 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', () { diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 5145a6f4c..681ca5de5 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -167,8 +167,8 @@ class FamilyProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$familyHash, - dependencies: FamilyFamily._dependencies, - allTransitiveDependencies: FamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, first: first, second: second, third: third, @@ -487,9 +487,8 @@ class FamilyClassProvider const bool.fromEnvironment('dart.vm.product') ? null : _$familyClassHash, - dependencies: FamilyClassFamily._dependencies, - allTransitiveDependencies: - FamilyClassFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, first: first, second: second, third: third, diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index aeef05840..99093ca9a 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -147,9 +147,8 @@ class ExampleFamilyProvider const bool.fromEnvironment('dart.vm.product') ? null : _$exampleFamilyHash, - dependencies: ExampleFamilyFamily._dependencies, - allTransitiveDependencies: - ExampleFamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, a: a, b: b, ); @@ -345,8 +344,8 @@ class GenericProvider const bool.fromEnvironment('dart.vm.product') ? null : _$genericHash, - dependencies: GenericFamily._dependencies, - allTransitiveDependencies: GenericFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); GenericProvider._internal( diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index b7a4e1e5c..a640116fa 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -138,9 +138,8 @@ class ExampleFamilyProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$exampleFamilyHash, - dependencies: ExampleFamilyFamily._dependencies, - allTransitiveDependencies: - ExampleFamilyFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, a: a, b: b, ); diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index c6579fbb0..8a16d4e0a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -108,8 +108,8 @@ class FnProvider extends AutoDisposeProvider { name: r'fnProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$fnHash, - dependencies: FnFamily._dependencies, - allTransitiveDependencies: FnFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, context1: context1, context2: context2, ); @@ -309,9 +309,8 @@ class MyNotifierProvider const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, - dependencies: MyNotifierFamily._dependencies, - allTransitiveDependencies: - MyNotifierFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, context1: context1, context2: context2, ); diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index 00191f3bb..db079bcf6 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -112,9 +112,8 @@ class GeneratedNotifierProvider const bool.fromEnvironment('dart.vm.product') ? null : _$generatedNotifierHash, - dependencies: GeneratedNotifierFamily._dependencies, - allTransitiveDependencies: - GeneratedNotifierFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, param: param, ); diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index 26984624e..7629f7c06 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -490,8 +490,8 @@ class FamilyDepProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$familyDepHash, - dependencies: FamilyDepFamily._dependencies, - allTransitiveDependencies: FamilyDepFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, p: p, ); @@ -666,9 +666,8 @@ class FamilyDep2Provider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$familyDep2Hash, - dependencies: FamilyDep2Family._dependencies, - allTransitiveDependencies: - FamilyDep2Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, p: p, ); diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 4fde64745..7f326b2c2 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -132,8 +132,8 @@ class GenericsProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$genericsHash, - dependencies: GenericsFamily._dependencies, - allTransitiveDependencies: GenericsFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); GenericsProvider._internal( @@ -286,9 +286,8 @@ class NoGenericsProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$noGenericsHash, - dependencies: NoGenericsFamily._dependencies, - allTransitiveDependencies: - NoGenericsFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); NoGenericsProvider._internal( @@ -440,9 +439,8 @@ class MissingGenericsProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$missingGenericsHash, - dependencies: MissingGenericsFamily._dependencies, - allTransitiveDependencies: - MissingGenericsFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); MissingGenericsProvider._internal( @@ -594,9 +592,8 @@ class WrongOrderProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$wrongOrderHash, - dependencies: WrongOrderFamily._dependencies, - allTransitiveDependencies: - WrongOrderFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); WrongOrderProvider._internal( diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart index 9e8eb184b..94da25ae8 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart @@ -163,8 +163,8 @@ class GenericsProvider const bool.fromEnvironment('dart.vm.product') ? null : _$genericsHash, - dependencies: GenericsFamily._dependencies, - allTransitiveDependencies: GenericsFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); GenericsProvider._internal( @@ -326,9 +326,8 @@ class NoGenericsProvider const bool.fromEnvironment('dart.vm.product') ? null : _$noGenericsHash, - dependencies: NoGenericsFamily._dependencies, - allTransitiveDependencies: - NoGenericsFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); NoGenericsProvider._internal( @@ -490,9 +489,8 @@ class MissingGenericsProvider const bool.fromEnvironment('dart.vm.product') ? null : _$missingGenericsHash, - dependencies: MissingGenericsFamily._dependencies, - allTransitiveDependencies: - MissingGenericsFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); MissingGenericsProvider._internal( @@ -653,9 +651,8 @@ class WrongOrderProvider const bool.fromEnvironment('dart.vm.product') ? null : _$wrongOrderHash, - dependencies: WrongOrderFamily._dependencies, - allTransitiveDependencies: - WrongOrderFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, ); WrongOrderProvider._internal( diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index 79725bcd5..9bb608dba 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -137,8 +137,8 @@ class A3Provider extends AutoDisposeNotifierProviderImpl { name: r'a3Provider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$a3Hash, - dependencies: A3Family._dependencies, - allTransitiveDependencies: A3Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, param: param, ); @@ -317,8 +317,8 @@ class A4Provider extends NotifierProviderImpl { name: r'a4Provider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$a4Hash, - dependencies: A4Family._dependencies, - allTransitiveDependencies: A4Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, param: param, ); @@ -496,8 +496,8 @@ class A5Provider extends AutoDisposeAsyncNotifierProviderImpl { name: r'a5Provider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$a5Hash, - dependencies: A5Family._dependencies, - allTransitiveDependencies: A5Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, param: param, ); @@ -676,8 +676,8 @@ class A6Provider extends AsyncNotifierProviderImpl { name: r'a6Provider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$a6Hash, - dependencies: A6Family._dependencies, - allTransitiveDependencies: A6Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, param: param, ); @@ -856,8 +856,8 @@ class A7Provider extends AutoDisposeStreamNotifierProviderImpl { name: r'a7Provider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$a7Hash, - dependencies: A7Family._dependencies, - allTransitiveDependencies: A7Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, param: param, ); @@ -1036,8 +1036,8 @@ class A8Provider extends StreamNotifierProviderImpl { name: r'a8Provider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$a8Hash, - dependencies: A8Family._dependencies, - allTransitiveDependencies: A8Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, param: param, ); diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 25f926e94..cc9897bae 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -106,8 +106,8 @@ class GeneratorProvider extends Provider { const bool.fromEnvironment('dart.vm.product') ? null : _$generatorHash, - dependencies: GeneratorFamily._dependencies, - allTransitiveDependencies: GeneratorFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, value: value, ); diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index cc46b26a1..3f030438a 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -108,8 +108,8 @@ class FetchUserProvider extends AutoDisposeFutureProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$fetchUserHash, - dependencies: FetchUserFamily._dependencies, - allTransitiveDependencies: FetchUserFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, userId: userId, ); diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 8b69fbd36..491339e8e 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -108,8 +108,8 @@ class ExampleProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: ExampleFamily._dependencies, - allTransitiveDependencies: ExampleFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, param: param, ); diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index cb2ebbfa0..3a686ff46 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -120,8 +120,8 @@ class ExampleProvider extends AutoDisposeNotifierProviderImpl { const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: ExampleFamily._dependencies, - allTransitiveDependencies: ExampleFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, param1: param1, param2: param2, ); diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index d0777ec8e..5715ba689 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -112,8 +112,8 @@ class ExampleProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: ExampleFamily._dependencies, - allTransitiveDependencies: ExampleFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, param1: param1, param2: param2, ); diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index b6a9745f5..c3563946b 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -108,8 +108,8 @@ class LabelProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$labelHash, - dependencies: LabelFamily._dependencies, - allTransitiveDependencies: LabelFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, userName: userName, ); diff --git a/website/docs/essentials/passing_args/codegen/family.g.dart b/website/docs/essentials/passing_args/codegen/family.g.dart index 892084197..a6d769054 100644 --- a/website/docs/essentials/passing_args/codegen/family.g.dart +++ b/website/docs/essentials/passing_args/codegen/family.g.dart @@ -108,8 +108,8 @@ class ActivityProvider extends AutoDisposeFutureProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, - dependencies: ActivityFamily._dependencies, - allTransitiveDependencies: ActivityFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, activityType: activityType, ); diff --git a/website/docs/essentials/passing_args/codegen/provider.g.dart b/website/docs/essentials/passing_args/codegen/provider.g.dart index 1823fec59..d90aa2c9a 100644 --- a/website/docs/essentials/passing_args/codegen/provider.g.dart +++ b/website/docs/essentials/passing_args/codegen/provider.g.dart @@ -129,9 +129,8 @@ class ActivityNotifier2Provider const bool.fromEnvironment('dart.vm.product') ? null : _$activityNotifier2Hash, - dependencies: ActivityNotifier2Family._dependencies, - allTransitiveDependencies: - ActivityNotifier2Family._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, activityType: activityType, ); diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index ecdaa4ce6..0fb9d2b78 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -112,8 +112,8 @@ class RandomProvider extends AutoDisposeProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$randomHash, - dependencies: RandomFamily._dependencies, - allTransitiveDependencies: RandomFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, seed: seed, max: max, ); diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index 8bb8a5c3a..c61fdd056 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -113,9 +113,8 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { const bool.fromEnvironment('dart.vm.product') ? null : _$fetchPackagesHash, - dependencies: FetchPackagesFamily._dependencies, - allTransitiveDependencies: - FetchPackagesFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, page: page, search: search, ); diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index 310967406..0e521c68f 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -116,9 +116,8 @@ class BugsEncounteredNotifierProvider const bool.fromEnvironment('dart.vm.product') ? null : _$bugsEncounteredNotifierHash, - dependencies: BugsEncounteredNotifierFamily._dependencies, - allTransitiveDependencies: - BugsEncounteredNotifierFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, featureId: featureId, ); diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index cc46b26a1..3f030438a 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -108,8 +108,8 @@ class FetchUserProvider extends AutoDisposeFutureProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$fetchUserHash, - dependencies: FetchUserFamily._dependencies, - allTransitiveDependencies: FetchUserFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, userId: userId, ); diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index cc46b26a1..3f030438a 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -108,8 +108,8 @@ class FetchUserProvider extends AutoDisposeFutureProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$fetchUserHash, - dependencies: FetchUserFamily._dependencies, - allTransitiveDependencies: FetchUserFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, userId: userId, ); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index cc46b26a1..3f030438a 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -108,8 +108,8 @@ class FetchUserProvider extends AutoDisposeFutureProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$fetchUserHash, - dependencies: FetchUserFamily._dependencies, - allTransitiveDependencies: FetchUserFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, userId: userId, ); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index cc46b26a1..3f030438a 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -108,8 +108,8 @@ class FetchUserProvider extends AutoDisposeFutureProvider { const bool.fromEnvironment('dart.vm.product') ? null : _$fetchUserHash, - dependencies: FetchUserFamily._dependencies, - allTransitiveDependencies: FetchUserFamily._allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, userId: userId, ); From bcc7230e30091fe08c079273a62cde81ff62e7ef Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 28 Dec 2023 21:50:12 +0100 Subject: [PATCH 106/387] 2 more! --- packages/riverpod/lib/src/legacy_providers/notifier/family.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/riverpod/lib/src/legacy_providers/notifier/family.dart b/packages/riverpod/lib/src/legacy_providers/notifier/family.dart index 66d036677..b55b89af2 100644 --- a/packages/riverpod/lib/src/legacy_providers/notifier/family.dart +++ b/packages/riverpod/lib/src/legacy_providers/notifier/family.dart @@ -115,7 +115,7 @@ class NotifierProviderFamily, T, Arg> return FamilyOverride( from: this, createElement: (container, provider) { - provider as NotifierProviderFamily; + provider as FamilyNotifierProviderImpl; return NotifierFamilyProvider.internal( create, From 323445bcb2b6e18c02d8686acbd25e458f1a0910 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 28 Dec 2023 22:06:40 +0100 Subject: [PATCH 107/387] Remove unused code --- .../change_notifier_provider/base.dart | 8 +- .../lib/src/core/provider_container.dart | 19 ----- .../new/core/provider_container_test.dart | 78 ------------------- 3 files changed, 4 insertions(+), 101 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart index acb5253f9..6063327c0 100644 --- a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart +++ b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart @@ -178,10 +178,10 @@ class ChangeNotifierProvider class ChangeNotifierProviderElement extends ProviderElementBase implements ChangeNotifierProviderRef { - ChangeNotifierProviderElement._( - _ChangeNotifierProviderBase super._provider, - super.container, - ); + ChangeNotifierProviderElement._(this.provider, super.container); + + @override + final _ChangeNotifierProviderBase provider; @override NotifierT get notifier => _notifierNotifier.value; diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 63f73fa41..873f472da 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -341,24 +341,6 @@ class ProviderPointerManager { } } - /// Whether a provider was inserted at [container] instead of an ancestor. - bool isLocallyMounted(ProviderOrFamily provider) { - // If we are at the root, then providers are always mounted locally. - if (this.container.parent == null) return true; - - ProviderContainer? container; - - switch (provider) { - case ProviderBase(): - container = readPointer(provider)?.targetContainer ?? - readDirectory(provider)?.targetContainer; - case Family(): - container = familyPointers[provider]?.targetContainer; - } - - return container == this.container; - } - /// Obtains the [ProviderContainer] in which provider/family should be mounted, /// if the provider is locally scoped. /// @@ -930,7 +912,6 @@ class ProviderContainer implements Node { // Assert that the the provider wouldn't have a more up-to-date value // if it was locally overridden. if (kDebugMode && - !_pointerManager.isLocallyMounted(provider) && // Avoid having the assert trigger itself exponentially !_debugVerifyDependenciesAreRespectedEnabled) { try { diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index 7e97259e1..b69b8018a 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -84,84 +84,6 @@ void main() { }); group('ProviderPointerManager', () { - group('isLocallyMounted', () { - final a = Provider( - (_) => 0, - dependencies: const [], - ); - final b = Provider.family( - (_, __) => 0, - dependencies: const [], - ); - final c = Provider.family( - (_, __) => 0, - dependencies: const [], - )(42); - - test('returns true if in the root container', () { - final container = ProviderContainer.test(); - - expect(container.pointerManager.isLocallyMounted(a), true); - expect(container.pointerManager.isLocallyMounted(b), true); - expect(container.pointerManager.isLocallyMounted(c), true); - }); - - test('returns false if the provider is not mounted', () { - final root = ProviderContainer.test(); - final container = ProviderContainer.test( - parent: root, - overrides: [ - // An unrelated override, added to avoid the container optimizing - // pointers away. - Provider((ref) => null, dependencies: const []), - ], - ); - - expect(container.pointerManager.isLocallyMounted(a), false); - expect(container.pointerManager.isLocallyMounted(b), false); - expect(container.pointerManager.isLocallyMounted(c), false); - }); - - test('returns false if mounted but in a different container', () { - final root = ProviderContainer.test(); - - root.read(a); - root.read(b(21)); - root.read(c); - - // Creating after reads, to inherit elements from root - final container = ProviderContainer.test( - parent: root, - overrides: [ - // An unrelated override, added to avoid the container optimizing - // pointers away. - Provider((ref) => null, dependencies: const []), - ], - ); - - expect(container.pointerManager.isLocallyMounted(a), false); - expect(container.pointerManager.isLocallyMounted(b), false); - expect(container.pointerManager.isLocallyMounted(c), false); - }); - - test('returns true if mounted in the same container', () { - final root = ProviderContainer.test(); - final container = ProviderContainer.test( - parent: root, - overrides: [ - a.overrideWithValue(42), - b.overrideWith((ref, args) => 0), - c.overrideWithValue(42), - ], - ); - - expect(container.pointerManager.isLocallyMounted(a), true); - expect(container.pointerManager.isLocallyMounted(b), true); - expect(container.pointerManager.isLocallyMounted(b(21)), true); - expect(container.pointerManager.isLocallyMounted(c), true); - }); - }); - group('findDeepestTransitiveDependencyProviderContainer', () { final transitiveDependency = Provider( (_) => 0, From 53adb5aa8689dd953fd3eaafd21db4acf9235ac2 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 29 Dec 2023 00:22:23 +0100 Subject: [PATCH 108/387] Done for pkg:riverpod! --- .../flutter_riverpod/lib/src/consumer.dart | 3 + packages/riverpod/lib/src/core/element.dart | 122 ++++++----- .../riverpod/lib/src/core/foundation.dart | 20 +- .../lib/src/core/provider_container.dart | 48 ----- .../src/core/proxy_provider_listenable.dart | 5 +- packages/riverpod/lib/src/framework.dart | 3 +- packages/riverpod/test/new/core/ref_test.dart | 192 ++++++++++++++++++ .../framework/provider_container_test.dart | 8 +- .../old/framework/provider_element_test.dart | 8 +- .../test/old/framework/scope_test.dart | 64 ------ 10 files changed, 289 insertions(+), 184 deletions(-) create mode 100644 packages/riverpod/test/new/core/ref_test.dart diff --git a/packages/flutter_riverpod/lib/src/consumer.dart b/packages/flutter_riverpod/lib/src/consumer.dart index 776e22eaa..8a1195e20 100644 --- a/packages/flutter_riverpod/lib/src/consumer.dart +++ b/packages/flutter_riverpod/lib/src/consumer.dart @@ -427,6 +427,9 @@ abstract class ConsumerWidget extends ConsumerStatefulWidget { /// {@macro riverpod.consumerwidget} const ConsumerWidget({super.key}); + // TODO changelog & document + Iterable get dependencies; + /// Describes the part of the user interface represented by this widget. /// /// The framework calls this method when this widget is inserted into the tree diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index d7187839c..13962f98c 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -308,9 +308,9 @@ abstract class ProviderElementBase implements Ref, Node { void update(ProviderBase newProvider) {} @override - void invalidate(ProviderOrFamily provider) { - assert(_debugAssertCanDependOn(provider), ''); - container.invalidate(provider); + void invalidate(ProviderOrFamily providerOrFamily) { + if (kDebugMode) _debugAssertCanDependOn(providerOrFamily); + container.invalidate(providerOrFamily); } @override @@ -638,57 +638,67 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ); } - bool _debugAssertCanDependOn(ProviderListenableOrFamily listenable) { - assert( - () { - if (listenable is! ProviderBase) return true; - - try { - // Initializing the provider, to make sure its dependencies are setup. - container.readProviderElement(listenable); - } catch (err) { - // We don't care whether the provider is in error or not. We're just - // checking whether we're not in a circular dependency. - } + void _debugAssertCanDependOn(ProviderListenableOrFamily listenable) { + final dependency = switch (listenable) { + ProviderOrFamily() => listenable, + _ => listenable.listenedProvider, + }; - assert( - listenable != origin, - 'A provider cannot depend on itself', - ); + if (dependency == null) return; - assert( - // If the target has a null "dependencies", it should never be scoped. - // As such, the current provider's "dependencies" does not need to - // include the target in its dependencies. - listenable.dependencies == null || - provider != origin || - // Families are allowed to depend on themselves with different parameters. - (origin.from != null && listenable.from == origin.from) || - origin.dependencies == null || - origin.dependencies!.contains(listenable.from) || - origin.dependencies!.contains(listenable), - 'The provider $origin tried to read $listenable, but it specified a ' - "'dependencies' list yet that list does not contain $listenable.\n\n" - "To fix, add $listenable to $origin's 'dependencies' parameter", - ); + // TODO can we remove this? + try { + if (dependency is ProviderBase) + // Initializing the provider, to make sure its dependencies are setup. + container.readProviderElement(dependency); + } catch (err) { + // We don't care whether the provider is in error or not. We're just + // checking whether we're not in a circular dependency. + } - final queue = - Queue>.from(_providerDependents); + assert( + dependency != origin, + 'A provider cannot depend on itself', + ); - while (queue.isNotEmpty) { - final current = queue.removeFirst(); - queue.addAll(current._providerDependents); + final dependencies = origin.from?.dependencies ?? origin.dependencies ?? []; + final targetDependencies = + dependency.from?.dependencies ?? dependency.dependencies; + + if ( + // If the target has a null "dependencies", it should never be scoped. + !(targetDependencies == null || + // Ignore dependency check if from an override + provider != origin || + // Families are allowed to depend on themselves with different parameters. + (origin.from != null && dependency.from == origin.from) || + dependencies.contains(dependency.from) || + dependencies.contains(dependency))) { + throw StateError(''' +The provider `$origin` depends on `$dependency`, which may be scoped. +Yet `$dependency` is not part of `$origin`'s `dependencies` list. + +To fix, add $dependency to $origin's 'dependencies' parameter. +This can be done with either: + +@Riverpod(dependencies: []) + + +or: + +final = Provider(dependencies: []); +'''); + } - if (current.origin == listenable) { - throw CircularDependencyError._(); - } - } + final queue = Queue>.from(_providerDependents); + while (queue.isNotEmpty) { + final current = queue.removeFirst(); + queue.addAll(current._providerDependents); - return true; - }(), - '', - ); - return true; + if (current.origin == dependency) { + throw CircularDependencyError._(); + } + } } void _assertNotOutdated() { @@ -699,18 +709,18 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } @override - T refresh(Refreshable provider) { + T refresh(Refreshable refreshable) { _assertNotOutdated(); - assert(_debugAssertCanDependOn(provider), ''); - return container.refresh(provider); + if (kDebugMode) _debugAssertCanDependOn(refreshable); + return container.refresh(refreshable); } @override - T read(ProviderListenable provider) { + T read(ProviderListenable listenable) { _assertNotOutdated(); assert(!_debugIsRunningSelector, 'Cannot call ref.read inside a selector'); - assert(_debugAssertCanDependOn(provider), ''); - return container.read(provider); + if (kDebugMode) _debugAssertCanDependOn(listenable); + return container.read(listenable); } @override @@ -732,7 +742,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu return sub.read(); } - assert(_debugAssertCanDependOn(listenable), ''); + if (kDebugMode) _debugAssertCanDependOn(listenable); final element = container.readProviderElement(listenable); _dependencies.putIfAbsent(element, () { @@ -798,7 +808,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu }) { _assertNotOutdated(); assert(!_debugIsRunningSelector, 'Cannot call ref.read inside a selector'); - assert(_debugAssertCanDependOn(listenable), ''); + if (kDebugMode) _debugAssertCanDependOn(listenable); return listenable.addListener( this, diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index 094ce4d47..981b58f36 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -1,5 +1,8 @@ part of '../framework.dart'; +/// A shared interface between [ProviderListenable] and [Family]. +abstract class ProviderListenableOrFamily {} + /// A common interface shared by [ProviderBase] and [Family] @sealed sealed class ProviderOrFamily implements ProviderListenableOrFamily { @@ -81,8 +84,19 @@ sealed class ProviderOrFamily implements ProviderListenableOrFamily { final Iterable? allTransitiveDependencies; } -/// A shared interface between [ProviderListenable] and [Family]. -abstract class ProviderListenableOrFamily {} +extension on ProviderListenableOrFamily { + ProviderBase? get listenedProvider { + final that = this; + return switch (that) { + ProviderBase() => that, + // TODO refactor to listenable.provider + _ProviderSelector() => that.provider.listenedProvider, + _AsyncSelector() => that.provider.listenedProvider, + ProviderElementProxy() => that.provider, + _ => null, + }; + } +} /// Computes the list of all dependencies of a provider. @internal @@ -138,9 +152,11 @@ String shortHash(Object? object) { mixin ProviderListenable implements ProviderListenableOrFamily { /// Starts listening to this transformer ProviderSubscription addListener( + // TODO remove Node and pass directly the listened Element Node node, void Function(State? previous, State next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, + // TODO remove required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, }); diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 873f472da..d07d20ff7 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -519,8 +519,6 @@ class ProviderPointerManager { } } -var _debugVerifyDependenciesAreRespectedEnabled = true; - /// {@template riverpod.provider_container} /// An object that stores the state of the providers and allows overriding the /// behavior of a specific provider. @@ -909,52 +907,6 @@ class ProviderContainer implements Node { final element = _pointerManager.upsertElement(provider); - // Assert that the the provider wouldn't have a more up-to-date value - // if it was locally overridden. - if (kDebugMode && - // Avoid having the assert trigger itself exponentially - !_debugVerifyDependenciesAreRespectedEnabled) { - try { - _debugVerifyDependenciesAreRespectedEnabled = false; - - // Check that this containers doesn't have access to an overridden - // dependency of the targeted provider - final visitedDependencies = >{}; - final queue = Queue>(); - element.visitAncestors((e) => queue.add(e.origin)); - - while (queue.isNotEmpty) { - final dependency = queue.removeFirst(); - if (visitedDependencies.add(dependency)) { - final dependencyElement = readProviderElement( - dependency, - ); - - assert( - element.provider != element.origin || - dependencyElement == - element.container - .readProviderElement(dependency), - ''' -Tried to read $provider from a place where one of its dependencies were overridden but the provider is not. - -To fix this error, you can add $dependency (a) to the "dependencies" of $provider (b) such that we have: - -``` -final a = Provider(...); -final b = Provider((ref) => ref.watch(a), dependencies: [a]); -``` -''', - ); - - dependencyElement.visitAncestors((e) => queue.add(e.origin)); - } - } - } finally { - _debugVerifyDependenciesAreRespectedEnabled = true; - } - } - return element as ProviderElementBase; } diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index 0d3906f54..20b95730f 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -38,10 +38,7 @@ class _ProxySubscription extends ProviderSubscription { /// This API is not meant for public consumption. @internal class ProviderElementProxy - with - ProviderListenable, - ProviderListenable, - _ProviderRefreshable { + with ProviderListenable, _ProviderRefreshable { /// An internal utility for reading alternate values of a provider. /// /// For example, this is used by [FutureProvider] to differentiate: diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index a4f4ff5c2..df71e0e9d 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -2,11 +2,12 @@ library framework; import 'dart:async'; import 'dart:collection'; +import 'dart:io'; import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; -import 'package:state_notifier/state_notifier.dart'; import 'package:test/test.dart' as test; +import '../riverpod.dart'; import 'common/env.dart'; import 'internals.dart'; diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart new file mode 100644 index 000000000..2166ae3bb --- /dev/null +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -0,0 +1,192 @@ +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +// TODO automatically generate this list for maintainability +final refMethodsThatDependOnProviders = + )>{ + 'watch': (ref, p) => ref.watch(p), + 'read': (ref, p) => ref.read(p), + 'listen': (ref, p) => ref.listen(p, (prev, next) {}), + 'invalidate': (ref, p) => ref.invalidate(p), + 'refresh': (ref, p) => ref.refresh(p), +}; +final refMethodsThatDependOnListenables = + )>{ + 'watch': (ref, p) => ref.watch(p), + 'read': (ref, p) => ref.read(p), + 'listen': (ref, p) => ref.listen(p, (prev, next) {}), +}; +final refMethodsThatDependOnProviderOrFamilies = + { + 'invalidate': (ref, p) => ref.invalidate(p), +}; + +void main() { + group('Ref', () { + group( + 'asserts that a provider cannot depend on a provider that is not in its dependencies:', + () { + for (final entry in refMethodsThatDependOnProviders.entries) { + final method = entry.key; + final call = entry.value; + + test('Using `$method` when passing a provider', () { + // TODO changelog "reading a provider that is not part of its dependencies is now forbidden" + final transitiveDep = Provider((ref) => 0, dependencies: const []); + final dep = Provider((ref) => 0, dependencies: [transitiveDep]); + final depFamily = Provider.family( + (ref, id) => 0, + dependencies: const [], + ); + final unrelatedScoped = Provider((ref) => 0, dependencies: const []); + final unrelatedScopedFamily = Provider.family( + (ref, i) => 0, + dependencies: const [], + ); + final nonScopedProvider = Provider((ref) => 0); + final provider = Provider( + (ref) => ref, + dependencies: [dep, depFamily], + ); + final family = Provider.family( + (ref, id) => ref, + dependencies: [dep, depFamily], + ); + + final container = ProviderContainer.test(); + final ref = container.read(provider); + final ref2 = container.read(family(0)); + + // accepts providers that are part of its dependencies + call(ref, dep); + call(ref2, dep); + call(ref, depFamily(42)); + call(ref2, depFamily(42)); + + // accepts non-scoped providers + call(ref, nonScopedProvider); + call(ref2, nonScopedProvider); + + // rejects providers that are not part of its dependencies + expect( + () => call(ref, transitiveDep), + throwsA(isA()), + ); + expect( + () => call(ref2, transitiveDep), + throwsA(isA()), + ); + expect( + () => call(ref, unrelatedScoped), + throwsA(isA()), + ); + expect( + () => call(ref2, unrelatedScoped), + throwsA(isA()), + ); + expect( + () => call(ref2, unrelatedScopedFamily(42)), + throwsA(isA()), + ); + }); + } + + for (final entry in refMethodsThatDependOnListenables.entries) { + final method = entry.key; + final call = entry.value; + + test('Using `$method` when passing a listenable', () async { + // TODO changelog "reading a provider that is not part of its dependencies is now forbidden" + final transitiveDep = FutureProvider( + (ref) => 0, + dependencies: const [], + ); + final dep = FutureProvider((ref) => 0, dependencies: [transitiveDep]); + final depFamily = FutureProvider.family( + (ref, id) => 0, + dependencies: const [], + ); + final unrelatedScoped = FutureProvider( + (ref) => 0, + dependencies: const [], + ); + final nonScopedProvider = FutureProvider((ref) => 0); + final provider = FutureProvider( + (ref) => ref, + dependencies: [dep, depFamily], + ); + + final container = ProviderContainer.test(); + final ref = container.read(provider).requireValue; + + // accepts providers that are part of its dependencies + call(ref, dep.select((value) => 0)); + call(ref, dep.selectAsync((value) => 0)); + call(ref, depFamily(42).select((value) => 0)); + + // accepts non-scoped providers + call(ref, nonScopedProvider.select((value) => 0)); + + // rejects providers that are not part of its dependencies + await expectLater( + () => call(ref, unrelatedScoped.select((value) => 0)), + throwsA(isA()), + ); + await expectLater( + () => call(ref, unrelatedScoped.selectAsync((value) => 0)), + throwsA(isA()), + ); + await expectLater( + () => call(ref, unrelatedScoped.future), + throwsA(isA()), + ); + }); + } + + for (final entry in refMethodsThatDependOnProviderOrFamilies.entries) { + final method = entry.key; + final call = entry.value; + + test('Using `$method` when passing a family (not `family(arg)`)', () { + final transitiveDep = Provider.family( + (ref, i) => 0, + dependencies: const [], + ); + final dep = Provider.family( + (ref, id) => 0, + dependencies: [transitiveDep], + ); + final unrelatedScoped = Provider.family( + (ref, i) => 0, + dependencies: const [], + ); + final nonScopedProvider = Provider.family((ref, i) => 0); + + final provider = Provider( + (ref) => ref, + dependencies: [dep], + ); + + final container = ProviderContainer.test(); + final ref = container.read(provider); + + // accepts providers that are part of its dependencies + call(ref, dep); + + // accepts non-scoped providers + call(ref, nonScopedProvider); + + // rejects providers that are not part of its dependencies + expect( + () => call(ref, transitiveDep), + throwsA(isA()), + ); + expect( + () => call(ref, unrelatedScoped), + throwsA(isA()), + ); + }); + } + }); + }); +} diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index f926bd99e..5fdcfb8bd 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -105,8 +105,8 @@ void main() { ); expect( - () => container.readProviderElement(provider), - throwsA(isA()), + () => container.read(provider), + throwsA(isA()), ); }); @@ -127,8 +127,8 @@ void main() { ); expect( - () => container.readProviderElement(provider), - throwsA(isA()), + () => container.read(provider), + throwsA(isA()), ); }); }); diff --git a/packages/riverpod/test/old/framework/provider_element_test.dart b/packages/riverpod/test/old/framework/provider_element_test.dart index 33fc71945..7a9960a2e 100644 --- a/packages/riverpod/test/old/framework/provider_element_test.dart +++ b/packages/riverpod/test/old/framework/provider_element_test.dart @@ -257,16 +257,14 @@ void main() { }); test('clears only on the closest family override', () async { - late Ref ref; - final another = Provider( - (r) => ref = r, - dependencies: const [], - ); var result = 0; final provider = Provider.family( (r, i) => result, dependencies: const [], ); + late Ref ref; + final another = Provider((r) => ref = r, dependencies: [provider]); + final listener = Listener(); final listener2 = Listener(); final root = ProviderContainer.test(); diff --git a/packages/riverpod/test/old/framework/scope_test.dart b/packages/riverpod/test/old/framework/scope_test.dart index 9c98fcc3d..1d11046fa 100644 --- a/packages/riverpod/test/old/framework/scope_test.dart +++ b/packages/riverpod/test/old/framework/scope_test.dart @@ -764,70 +764,6 @@ Future main() async { ); expect(root.getAllProviderElements(), isEmpty); }); - - test( - 'does not throw if trying to watch a non-scoped provider that is not in the dependencies list', - () { - final container = ProviderContainer.test(); - final dep = Provider((ref) => 0); - final provider = Provider( - (ref) => ref.watch(dep), - dependencies: const [], - ); - - expect(container.read(provider), 0); - }); - - test( - 'Throw if trying to watch a scoped provider that is not in the dependencies list', - () { - final container = ProviderContainer.test(); - final dep = Provider((ref) => 0, dependencies: const []); - final dep2 = Provider((ref) => 0, dependencies: [dep]); - final provider = Provider( - dependencies: [dep], - (ref) => ref.watch(dep2), - ); - - expect( - () => container.read(provider), - throwsA(isA()), - ); - }); - - test( - 'Throw if trying to listen a scoped provider that is not in the dependencies list', - () { - final container = ProviderContainer.test(); - final dep = Provider((ref) => 0, dependencies: const []); - final dep2 = Provider((ref) => 0, dependencies: [dep]); - final provider = Provider( - dependencies: [dep], - (ref) => ref.listen(dep2, (_, __) {}), - ); - - expect( - () => container.read(provider), - throwsA(isA()), - ); - }); - - test( - 'Throw if trying to read a scoped provider that is not in the dependencies list', - () { - final container = ProviderContainer.test(); - final dep = Provider((ref) => 0, dependencies: const []); - final dep2 = Provider((ref) => 0, dependencies: [dep]); - final provider = Provider( - dependencies: [dep], - (ref) => ref.read(dep2), - ); - - expect( - () => container.read(provider), - throwsA(isA()), - ); - }); }); test('does not auto-scope provider overrides', () { From cebc085327562efbd6353f584b737233db9c70d1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 29 Dec 2023 00:24:36 +0100 Subject: [PATCH 109/387] Fix some warnings --- .../deprecated/change_notifier_provider/auto_dispose.dart | 2 +- packages/riverpod/lib/src/core/override_with_value.dart | 1 - packages/riverpod/lib/src/framework.dart | 1 - .../deprecated/state_notifier_provider/auto_dispose.dart | 2 +- .../deprecated/state_provider/auto_dispose.dart | 2 +- .../lib/src/legacy_providers/future_provider/auto_dispose.dart | 2 +- .../lib/src/legacy_providers/notifier/auto_dispose.dart | 2 +- .../lib/src/legacy_providers/stream_notifier/auto_dispose.dart | 2 +- .../lib/src/legacy_providers/stream_provider/auto_dispose.dart | 2 +- 9 files changed, 7 insertions(+), 9 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart index e0505782a..d1da7ec92 100644 --- a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart +++ b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart @@ -88,7 +88,7 @@ class AutoDisposeChangeNotifierProviderElement< implements AutoDisposeChangeNotifierProviderRef { /// The [ProviderElementBase] for [ChangeNotifier] AutoDisposeChangeNotifierProviderElement._( - AutoDisposeChangeNotifierProvider super._provider, + AutoDisposeChangeNotifierProvider super.provider, super.container, ) : super._(); } diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index 3be045bff..963a37ecb 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -125,7 +125,6 @@ class ValueProviderElement extends ProviderElementBase { @override void create({required bool didChangeDependency}) { - final provider = this.provider as ValueProvider; setState(provider._value); } diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index df71e0e9d..3e84bcb3c 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -2,7 +2,6 @@ library framework; import 'dart:async'; import 'dart:collection'; -import 'dart:io'; import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/auto_dispose.dart index 88da7802f..d00eb6d24 100644 --- a/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/auto_dispose.dart @@ -83,7 +83,7 @@ class AutoDisposeStateNotifierProviderElement< implements AutoDisposeStateNotifierProviderRef { /// The [ProviderElementBase] for [StateNotifierProvider] AutoDisposeStateNotifierProviderElement._( - AutoDisposeStateNotifierProvider super._provider, + AutoDisposeStateNotifierProvider super.provider, super.container, ) : super._(); } diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/auto_dispose.dart index 3649e75eb..c8510fb1b 100644 --- a/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/auto_dispose.dart @@ -75,7 +75,7 @@ class AutoDisposeStateProviderElement extends StateProviderElement implements AutoDisposeStateProviderRef { /// The [ProviderElementBase] for [StateProvider] AutoDisposeStateProviderElement._( - AutoDisposeStateProvider super._provider, + AutoDisposeStateProvider super.provider, super.container, ) : super._(); } diff --git a/packages/riverpod/lib/src/legacy_providers/future_provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/future_provider/auto_dispose.dart index c880f0e60..b71cb689f 100644 --- a/packages/riverpod/lib/src/legacy_providers/future_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/legacy_providers/future_provider/auto_dispose.dart @@ -79,7 +79,7 @@ class AutoDisposeFutureProviderElement extends FutureProviderElement /// The [ProviderElementBase] for [FutureProvider] @internal AutoDisposeFutureProviderElement( - AutoDisposeFutureProvider super._provider, + AutoDisposeFutureProvider super.provider, super.container, ) : super(); } diff --git a/packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose.dart index f2ea52f50..b851442cd 100644 --- a/packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose.dart +++ b/packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose.dart @@ -125,5 +125,5 @@ class AutoDisposeNotifierProviderElement, T> implements AutoDisposeNotifierProviderRef { /// The [ProviderElementBase] for [NotifierProvider] @internal - AutoDisposeNotifierProviderElement(super._provider, super.container); + AutoDisposeNotifierProviderElement(super.provider, super.container); } diff --git a/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose.dart index b8b370772..c3b6b53f5 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose.dart @@ -130,5 +130,5 @@ class AutoDisposeStreamNotifierProviderElement< implements AutoDisposeStreamNotifierProviderRef { /// The [ProviderElementBase] for [StreamNotifierProvider] @internal - AutoDisposeStreamNotifierProviderElement(super._provider, super.container); + AutoDisposeStreamNotifierProviderElement(super.provider, super.container); } diff --git a/packages/riverpod/lib/src/legacy_providers/stream_provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/stream_provider/auto_dispose.dart index 4f157efa7..aebff2a35 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_provider/auto_dispose.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_provider/auto_dispose.dart @@ -76,7 +76,7 @@ class AutoDisposeStreamProviderElement extends StreamProviderElement implements AutoDisposeStreamProviderRef { /// The [ProviderElementBase] for [StreamProvider] AutoDisposeStreamProviderElement( - AutoDisposeStreamProvider super._provider, + AutoDisposeStreamProvider super.provider, super.container, ); } From 5964dd14f004c06d677376003cd276bdd8f4142a Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 29 Dec 2023 01:54:09 +0100 Subject: [PATCH 110/387] A --- packages/riverpod/lib/src/core/element.dart | 33 +++++----------- packages/riverpod/test/new/core/ref_test.dart | 2 + .../old/framework/uni_directional_test.dart | 24 +++++------- .../test/old/legacy/framework_test.dart | 38 +++++++++++++++++-- 4 files changed, 56 insertions(+), 41 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 13962f98c..d40dc8405 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -142,13 +142,9 @@ abstract class ProviderElementBase implements Ref, Node { /// to expose a way to update the state, the practice is to expose a getter/setter. @internal void setState(State newState) { - assert( - () { - _debugDidSetState = true; - return true; - }(), - '', - ); + // TODO remove all body asserts + if (kDebugMode) _debugDidSetState = true; + final previousResult = getState(); final result = _state = ResultData(newState); @@ -177,12 +173,14 @@ abstract class ProviderElementBase implements Ref, Node { /// [readSelf]. @internal State get requireState { + const uninitializedError = + 'Tried to read the state of an uninitialized provider. ' + 'Do you maybe have a circular dependency?'; + assert( () { if (debugAssertDidSetStateEnabled && !_debugDidSetState) { - throw StateError( - 'Tried to read the state of an uninitialized provider', - ); + throw StateError(uninitializedError); } return true; }(), @@ -190,9 +188,7 @@ abstract class ProviderElementBase implements Ref, Node { ); final state = getState(); - if (state == null) { - throw StateError('Tried to read the state of an uninitialized provider'); - } + if (state == null) throw StateError(uninitializedError); return state.when( error: throwErrorWithCombinedStackTrace, @@ -646,16 +642,6 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu if (dependency == null) return; - // TODO can we remove this? - try { - if (dependency is ProviderBase) - // Initializing the provider, to make sure its dependencies are setup. - container.readProviderElement(dependency); - } catch (err) { - // We don't care whether the provider is in error or not. We're just - // checking whether we're not in a circular dependency. - } - assert( dependency != origin, 'A provider cannot depend on itself', @@ -690,6 +676,7 @@ final = Provider(dependencies: []); '''); } + // TODO move to a "onAddDependency" life-cycle final queue = Queue>.from(_providerDependents); while (queue.isNotEmpty) { final current = queue.removeFirst(); diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart index 2166ae3bb..8ef608a8a 100644 --- a/packages/riverpod/test/new/core/ref_test.dart +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -23,6 +23,8 @@ final refMethodsThatDependOnProviderOrFamilies = void main() { group('Ref', () { + // TODO ref.invalidate does not mount providers if they are not already mounted + group( 'asserts that a provider cannot depend on a provider that is not in its dependencies:', () { diff --git a/packages/riverpod/test/old/framework/uni_directional_test.dart b/packages/riverpod/test/old/framework/uni_directional_test.dart index cc39ec9d4..9fb9e5e90 100644 --- a/packages/riverpod/test/old/framework/uni_directional_test.dart +++ b/packages/riverpod/test/old/framework/uni_directional_test.dart @@ -14,27 +14,27 @@ void main() { }); test( - 'Catches circular dependency when dependencies are setup during provider initialization', - () { + 'Catches sync circular dependency when the dependency is not yet mounted', + skip: true, () { // regression for #1766 final container = ProviderContainer.test(); - final authInterceptorProvider = Provider((ref) => ref); + final c = Provider((ref) => ref); - final dioProvider = Provider((ref) { - ref.watch(authInterceptorProvider); + final a = Provider((ref) { + ref.watch(c); return 0; }); - final accessTokenProvider = Provider((ref) { - return ref.watch(dioProvider); + final b = Provider((ref) { + return ref.watch(a); }); - container.read(dioProvider); - final interceptor = container.read(authInterceptorProvider); + container.read(a); + final ref = container.read(c); expect( - () => interceptor.read(accessTokenProvider), + () => ref.read(b), throwsA(isA()), ); }); @@ -291,7 +291,3 @@ void main() { expect(errors, isNotEmpty); }); } - -// class VsyncMock extends Mock { -// void call(); -// } diff --git a/packages/riverpod/test/old/legacy/framework_test.dart b/packages/riverpod/test/old/legacy/framework_test.dart index 22a457429..0bf7cb77b 100644 --- a/packages/riverpod/test/old/legacy/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework_test.dart @@ -149,7 +149,7 @@ void main() { final container = ProviderContainer.test(); expect( () => container.read(provider), - throwsA(isA()), + throwsA(isA()), ); }); @@ -157,16 +157,46 @@ void main() { late Provider provider; final provider1 = Provider((ref) { - return ref.watch(provider)() + 1; + return () => ref.watch(provider)() + 1; }); final provider2 = Provider((ref) { - return ref.watch(provider1) + 1; + return () => ref.watch(provider1)() + 1; }); provider = Provider((ref) { - return () => ref.watch(provider2) + 1; + return () => ref.watch(provider2)() + 1; }); final container = ProviderContainer.test(); + + container.read(provider); + container.read(provider1); + container.read(provider2); + + expect( + () => container.read(provider)(), + throwsA(isA()), + ); + }); + + test('circular dependencies when dependencies are already mounted', () { + late Provider provider; + + final provider1 = Provider((ref) { + ref.watch(provider); + }); + final provider2 = Provider((ref) { + ref.watch(provider1); + }); + provider = Provider((ref) { + return () => ref.watch(provider2); + }); + + final container = ProviderContainer.test(); + + container.read(provider); + container.read(provider1); + container.read(provider2); + expect( () => container.read(provider)(), throwsA(isA()), From bd31cfe7fc2bf91acba3dd7499c54ad304b106b8 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 29 Dec 2023 01:54:52 +0100 Subject: [PATCH 111/387] Remove framework2 --- .../flutter_riverpod/lib/src/consumer.dart | 2 +- .../dependency_sources/consumer.dart | 11 - .../dependency_sources/container.dart | 69 ---- .../dependency_sources/provider.dart | 48 --- .../lib/src/framework2/framework.dart | 47 --- .../generated_providers/examples.dart | 91 ----- .../generated_providers/examples.g.dart | 113 ------ .../generated_providers/future_notifier.dart | 0 .../generated_providers/future_provider.dart | 85 ----- .../generated_providers/stream_notifier.dart | 0 .../generated_providers/stream_provider.dart | 0 .../generated_providers/sync_notifier.dart | 0 .../generated_providers/sync_provider.dart | 71 ---- .../framework2/legacy_providers/compat.dart | 6 - .../framework2/legacy_providers/provider.dart | 4 - .../riverpod/lib/src/framework2/override.dart | 25 -- .../riverpod/lib/src/framework2/provider.dart | 138 -------- .../src/framework2/provider_container.dart | 316 ----------------- .../lib/src/framework2/provider_element.dart | 334 ------------------ .../src/framework2/provider_listenable.dart | 53 --- .../lib/src/framework2/provider_observer.dart | 30 -- packages/riverpod/lib/src/framework2/ref.dart | 167 --------- .../lib/src/framework2/scheduler.dart | 66 ---- 23 files changed, 1 insertion(+), 1675 deletions(-) delete mode 100644 packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart delete mode 100644 packages/riverpod/lib/src/framework2/dependency_sources/container.dart delete mode 100644 packages/riverpod/lib/src/framework2/dependency_sources/provider.dart delete mode 100644 packages/riverpod/lib/src/framework2/framework.dart delete mode 100644 packages/riverpod/lib/src/framework2/generated_providers/examples.dart delete mode 100644 packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart delete mode 100644 packages/riverpod/lib/src/framework2/generated_providers/future_notifier.dart delete mode 100644 packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart delete mode 100644 packages/riverpod/lib/src/framework2/generated_providers/stream_notifier.dart delete mode 100644 packages/riverpod/lib/src/framework2/generated_providers/stream_provider.dart delete mode 100644 packages/riverpod/lib/src/framework2/generated_providers/sync_notifier.dart delete mode 100644 packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart delete mode 100644 packages/riverpod/lib/src/framework2/legacy_providers/compat.dart delete mode 100644 packages/riverpod/lib/src/framework2/legacy_providers/provider.dart delete mode 100644 packages/riverpod/lib/src/framework2/override.dart delete mode 100644 packages/riverpod/lib/src/framework2/provider.dart delete mode 100644 packages/riverpod/lib/src/framework2/provider_container.dart delete mode 100644 packages/riverpod/lib/src/framework2/provider_element.dart delete mode 100644 packages/riverpod/lib/src/framework2/provider_listenable.dart delete mode 100644 packages/riverpod/lib/src/framework2/provider_observer.dart delete mode 100644 packages/riverpod/lib/src/framework2/ref.dart delete mode 100644 packages/riverpod/lib/src/framework2/scheduler.dart diff --git a/packages/flutter_riverpod/lib/src/consumer.dart b/packages/flutter_riverpod/lib/src/consumer.dart index 8a1195e20..aeeb21535 100644 --- a/packages/flutter_riverpod/lib/src/consumer.dart +++ b/packages/flutter_riverpod/lib/src/consumer.dart @@ -428,7 +428,7 @@ abstract class ConsumerWidget extends ConsumerStatefulWidget { const ConsumerWidget({super.key}); // TODO changelog & document - Iterable get dependencies; + // Iterable get dependencies; /// Describes the part of the user interface represented by this widget. /// diff --git a/packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart b/packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart deleted file mode 100644 index 4377a13d6..000000000 --- a/packages/riverpod/lib/src/framework2/dependency_sources/consumer.dart +++ /dev/null @@ -1,11 +0,0 @@ -part of '../framework.dart'; - -@internal -sealed class DebugConsumerDependentSource extends DebugDependentSource { - DebugConsumerDependentSource({required this.consumer, required this.element}); - - // TODO - final Object consumer; - // TODO - final Object? element; -} diff --git a/packages/riverpod/lib/src/framework2/dependency_sources/container.dart b/packages/riverpod/lib/src/framework2/dependency_sources/container.dart deleted file mode 100644 index 91c85593c..000000000 --- a/packages/riverpod/lib/src/framework2/dependency_sources/container.dart +++ /dev/null @@ -1,69 +0,0 @@ -part of '../framework.dart'; - -@internal -sealed class DebugProviderContainerDependentSource - extends DebugDependentSource { - DebugProviderContainerDependentSource._({required this.container}); - - final ProviderContainer container; -} - -@internal -final class DebugProviderContainerListenDependentSource - extends DebugDependentSource { - DebugProviderContainerListenDependentSource({ - required this.container, - }); - - final ProviderContainer container; -} - -@internal -final class DebugProviderContainerReadDependentSource - extends DebugDependentSource { - DebugProviderContainerReadDependentSource({ - required this.container, - }); - - final ProviderContainer container; -} - -@internal -final class DebugProviderContainerExistsDependentSource - extends DebugDependentSource { - DebugProviderContainerExistsDependentSource({ - required this.container, - }); - - final ProviderContainer container; -} - -@internal -final class DebugProviderContainerInvalidateDependentSource - extends DebugDependentSource { - DebugProviderContainerInvalidateDependentSource({ - required this.container, - }); - - final ProviderContainer container; -} - -@internal -final class DebugProviderContainerRefreshDependentSource - extends DebugDependentSource { - DebugProviderContainerRefreshDependentSource({ - required this.container, - }); - - final ProviderContainer container; -} - -@internal -final class DebugProviderContainerReloadDependentSource - extends DebugDependentSource { - DebugProviderContainerReloadDependentSource({ - required this.container, - }); - - final ProviderContainer container; -} diff --git a/packages/riverpod/lib/src/framework2/dependency_sources/provider.dart b/packages/riverpod/lib/src/framework2/dependency_sources/provider.dart deleted file mode 100644 index e8bb0d4c4..000000000 --- a/packages/riverpod/lib/src/framework2/dependency_sources/provider.dart +++ /dev/null @@ -1,48 +0,0 @@ -part of '../framework.dart'; - -@internal -abstract class DebugDependentSource {} - -@internal -sealed class DebugProviderDependentSource extends DebugDependentSource { - DebugProviderDependentSource._({required this.provider}); - - final Provider provider; -} - -@internal -final class DebugRefWatchDependentSource extends DebugProviderDependentSource { - DebugRefWatchDependentSource({required super.provider}) : super._(); -} - -@internal -final class DebugRefListenDependentSource extends DebugProviderDependentSource { - DebugRefListenDependentSource({required super.provider}) : super._(); -} - -@internal -final class DebugRefReadDependentSource extends DebugProviderDependentSource { - DebugRefReadDependentSource({required super.provider}) : super._(); -} - -@internal -final class DebugRefInvalidateDependentSource - extends DebugProviderDependentSource { - DebugRefInvalidateDependentSource({required super.provider}) : super._(); -} - -@internal -final class DebugRefRefreshDependentSource - extends DebugProviderDependentSource { - DebugRefRefreshDependentSource({required super.provider}) : super._(); -} - -@internal -final class DebugRefReloadDependentSource extends DebugProviderDependentSource { - DebugRefReloadDependentSource({required super.provider}) : super._(); -} - -@internal -final class DebugRefExistsDependentSource extends DebugProviderDependentSource { - DebugRefExistsDependentSource({required super.provider}) : super._(); -} diff --git a/packages/riverpod/lib/src/framework2/framework.dart b/packages/riverpod/lib/src/framework2/framework.dart deleted file mode 100644 index 6fd1d6e0d..000000000 --- a/packages/riverpod/lib/src/framework2/framework.dart +++ /dev/null @@ -1,47 +0,0 @@ -import 'dart:async'; -import 'dart:collection'; - -import 'package:collection/collection.dart'; -import 'package:meta/meta.dart'; -import 'package:test/test.dart' as test; - -import '../core/async_value.dart'; -import '../tenable.dart'; - -part 'provider_container.dart'; -part 'provider_observer.dart'; -part 'provider_listenable.dart'; -part 'provider_element.dart'; -part 'provider.dart'; -part 'ref.dart'; -part 'override.dart'; -part 'dependency_sources/consumer.dart'; -part 'dependency_sources/container.dart'; -part 'dependency_sources/provider.dart'; -part 'scheduler.dart'; - -@internal -typedef OnError = void Function(Object error, StackTrace stackTrace); - -@internal -typedef ProviderListener = void Function( - StateT? previous, - StateT next, -); - -@internal -typedef OnAddListener = VoidCallback; -@internal -typedef OnRemoveListener = VoidCallback; -@internal -typedef OnResume = VoidCallback; -@internal -typedef OnCancel = VoidCallback; -@internal -typedef OnDispose = VoidCallback; - -@internal -typedef VoidCallback = void Function(); - -@internal -typedef Build> = T Function(RefT ref); diff --git a/packages/riverpod/lib/src/framework2/generated_providers/examples.dart b/packages/riverpod/lib/src/framework2/generated_providers/examples.dart deleted file mode 100644 index c81e3d5dc..000000000 --- a/packages/riverpod/lib/src/framework2/generated_providers/examples.dart +++ /dev/null @@ -1,91 +0,0 @@ -import 'dart:async'; - -import '../framework.dart'; -import 'future_provider.dart'; -import 'sync_provider.dart'; - -part 'examples.g.dart'; - -const riverpod = Object(); - -@riverpod -int syncExample(Ref ref) => 42; - -@riverpod -int syncExample2(Ref ref, {int? arg = 42}) { - return 42; -} - -// TODO -// extension on FutureOr { -// Future get sync { -// final that = this; -// if (that is Future) { -// return that; -// } else { -// return SynchronousFuture(that); -// } -// } -// } -// extension on Future { -// @Deprecated( -// 'Do not use "sync" on a Future. Either use a "FutureOr", or remove the "sync".', -// ) -// Never get sync => throw UnsupportedError( -// 'Do not use "sync" on a Future. Either use a "FutureOr", or remove the "sync".', -// ); -// } - -// TODO -// extension on Ref { -// /// A custom "return" keyword that enables synchronous value emit. -// /// -// /// Works by throwing an exception, which is caught and silenced by Riverpod. -// Never returnData(T value); - -// /// A custom "yield" keyword that enables synchronous value emit. -// /// -// /// The returned future typically completes immediately. -// /// But on paused providers, it will complete when the provider is resumed. -// /// -// /// This enables pausing asynchronous work. -// FutureOr emitData(T value) => state = value; -// } - -@riverpod -FutureOr asyncExample(Ref ref) async { - // "syncFuture" returns a SynchronousFuture from Flutter. - // This enables "await" to be synchronous. - // It unfortunately cannot be the default, due to SynchronousFuture not working - // with certain APIs (such as Future.wait) - // Riverpod_lint could have a warning to suggest using ".syncFuture" instead of ".future" - // when using "await". - final value = await ref.watch(asyncExampleProvider.syncFuture); - - return value; - - // final stream = Stream.periodic(const Duration(seconds: 1), (i) => i); - // // An example of iterating over a stream that supports pausing. - // // If the widget listening to this stream stops being visible, this loop would pause. - // // This would work thanks to "emitData" awaiting for the provider to be resumed. - // await for (final value in stream) { - // print('value: $value'); - // await ref.emitData(value); - // } - - // // Instead of "return 42", we use a custom "returnData" method. - // // This achieves the same result, but bypasses Future's asynchronous nature. - // ref.returnData(42); -} - -// @riverpod -// class SyncExampleNotifier extends _$SyncExampleNotifier { -// @override -// int build(Ref ref) => syncExample(ref); -// } - -// @riverpod -// class ScopedSyncExampleNotifier extends _$ScopedSyncExampleNotifier { -// @override -// int build(Ref ref); -// } diff --git a/packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart b/packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart deleted file mode 100644 index d3b17808c..000000000 --- a/packages/riverpod/lib/src/framework2/generated_providers/examples.g.dart +++ /dev/null @@ -1,113 +0,0 @@ -part of 'examples.dart'; - -const syncExampleProvider = SyncExampleProvider._(); - -final class SyncExampleProvider extends SyncProvider { - const SyncExampleProvider._() - : super( - name: 'syncExample', - from: null, - arguments: null, - debugSource: kDebugMode - ? const DebugProviderSource( - name: 'syncExample', - file: - 'package:riverpod/src/framework2/generated_providers/examples.dart:syncExample', - line: 42, - column: 42, - hash: '123', - ) - : null, - ); - - @override - Refreshable get notifier; - - @override - Refreshable get future; - - @override - int build(Ref ref) => syncExample(ref); - - static ProviderContainer? _$root; - - /// For unscoped providers, we can circumvent the override and map lookup - /// by statically caching the element. - /// This is only a performance optimization and should not be relied upon. - static ProviderElement? _$element; - - @override - ProviderElement getElement( - ProviderContainer container, { - required DebugDependentSource? debugDependentSource, - }) { - final target = container.root ?? container; - - final element = _$element; - if (element != null && _$root == target) return element; - - return _$element = super.getElement( - _$root = target, - debugDependentSource: debugDependentSource, - ); - } -} - -const asyncExampleProvider = AsyncExampleProvider._(); - -final class AsyncExampleProvider extends AsyncProvider { - const AsyncExampleProvider._() - : super( - name: 'asyncExample', - from: null, - arguments: null, - dependencies: null, - allTransitiveDependencies: null, - isAlwaysAlive: false, - debugSource: kDebugMode - ? const DebugProviderSource( - name: 'asyncExample', - file: - 'package:riverpod/src/framework2/generated_providers/examples.dart:asyncExample', - line: 42, - column: 42, - hash: '123', - ) - : null, - ); - - @override - Refreshable get notifier; - - @override - Refreshable> get future; - - @override - Refreshable> get syncFuture; - - @override - FutureOr build(Ref ref) => asyncExample(ref); - - static ProviderContainer? _$root; - - /// For unscoped providers, we can circumvent the override and map lookup - /// by statically caching the element. - /// This is only a performance optimization and should not be relied upon. - static ProviderElement? _$element; - - @override - ProviderElement getElement( - ProviderContainer container, { - required DebugDependentSource? debugDependentSource, - }) { - final target = container.root ?? container; - - final element = _$element; - if (element != null && _$root == target) return element; - - return _$element = super.getElement( - _$root = target, - debugDependentSource: debugDependentSource, - ); - } -} diff --git a/packages/riverpod/lib/src/framework2/generated_providers/future_notifier.dart b/packages/riverpod/lib/src/framework2/generated_providers/future_notifier.dart deleted file mode 100644 index e69de29bb..000000000 diff --git a/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart b/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart deleted file mode 100644 index cc4fae706..000000000 --- a/packages/riverpod/lib/src/framework2/generated_providers/future_provider.dart +++ /dev/null @@ -1,85 +0,0 @@ -import 'dart:async'; - -import 'package:meta/meta.dart'; - -import '../../core/async_value.dart'; -import '../framework.dart'; - -abstract base class AsyncProvider extends Provider> { - const AsyncProvider({ - required super.name, - required super.from, - required super.arguments, - required super.debugSource, - required super.dependencies, - required super.allTransitiveDependencies, - required super.isAlwaysAlive, - }); - - FutureOr build(Ref ref); - - Override overrideWith(Build, Ref> create); - - Override overrideWithValue(AsyncValue value); - - @override - ProviderElement createElement( - ProviderContainer container, - ) { - return AsyncProviderElement(this, container); - } - - @visibleForOverriding - @override - ProviderSubscription> addListener( - ProviderContainer container, - void Function(AsyncValue? previous, AsyncValue next) - listener, { - required bool fireImmediately, - required void Function(Object error, StackTrace stackTrace)? onError, - required DebugDependentSource? debugDependentSource, - required ProviderElement? dependent, - required void Function()? onCancel, - }) { - final element = getElement( - container, - debugDependentSource: debugDependentSource, - ) as AsyncProviderElement; - - return element.addListener( - listener, - convert: (value) => value, - fireImmediately: fireImmediately, - onError: onError, - debugDependentSource: debugDependentSource, - dependent: dependent, - onCancel: onCancel, - ); - } -} - -class AsyncProviderElement extends ProviderElement { - AsyncProviderElement(this.provider, super.container); - - @override - final AsyncProvider provider; - - @override - FutureOr build(Ref ref) { - try { - final futureOr = provider.build(ref); - - if (futureOr is Future) { - // TODO handle cancellation - return futureOr.then( - setData, - onError: setError, - ); - } else { - setData(futureOr); - } - } catch (err, stack) { - setError(err, stack); - } - } -} diff --git a/packages/riverpod/lib/src/framework2/generated_providers/stream_notifier.dart b/packages/riverpod/lib/src/framework2/generated_providers/stream_notifier.dart deleted file mode 100644 index e69de29bb..000000000 diff --git a/packages/riverpod/lib/src/framework2/generated_providers/stream_provider.dart b/packages/riverpod/lib/src/framework2/generated_providers/stream_provider.dart deleted file mode 100644 index e69de29bb..000000000 diff --git a/packages/riverpod/lib/src/framework2/generated_providers/sync_notifier.dart b/packages/riverpod/lib/src/framework2/generated_providers/sync_notifier.dart deleted file mode 100644 index e69de29bb..000000000 diff --git a/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart b/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart deleted file mode 100644 index 3a7d0bc52..000000000 --- a/packages/riverpod/lib/src/framework2/generated_providers/sync_provider.dart +++ /dev/null @@ -1,71 +0,0 @@ -import 'package:meta/meta.dart'; - -import '../../core/async_value.dart'; -import '../framework.dart'; - -abstract base class SyncProvider extends Provider { - const SyncProvider({ - required super.name, - required super.from, - required super.arguments, - required super.debugSource, - required super.dependencies, - required super.allTransitiveDependencies, - required super.isAlwaysAlive, - }); - - @internal - StateT build(Ref ref); - - Override overrideWith(Build> create); - - Override overrideWithValue(StateT value); - - @override - ProviderElement createElement(ProviderContainer container) { - return SyncProviderElement(this, container); - } - - @visibleForOverriding - @override - ProviderSubscription addListener( - ProviderContainer container, - void Function(StateT? previous, StateT next) listener, { - required bool fireImmediately, - required void Function(Object error, StackTrace stackTrace)? onError, - required DebugDependentSource? debugDependentSource, - required ProviderElement? dependent, - required void Function()? onCancel, - }) { - final element = getElement( - container, - debugDependentSource: debugDependentSource, - ) as SyncProviderElement; - - return element.addListener( - listener, - convert: (value) => value.requireValue, - fireImmediately: fireImmediately, - onError: onError, - debugDependentSource: debugDependentSource, - dependent: dependent, - onCancel: onCancel, - ); - } -} - -class SyncProviderElement extends ProviderElement { - SyncProviderElement(this.provider, super.container); - - @override - final SyncProvider provider; - - @override - void build(Ref ref) { - try { - setData(provider.build(ref)); - } catch (err, stack) { - setError(err, stack); - } - } -} diff --git a/packages/riverpod/lib/src/framework2/legacy_providers/compat.dart b/packages/riverpod/lib/src/framework2/legacy_providers/compat.dart deleted file mode 100644 index a8f93c90f..000000000 --- a/packages/riverpod/lib/src/framework2/legacy_providers/compat.dart +++ /dev/null @@ -1,6 +0,0 @@ -import '../framework.dart' as framework; - -export 'provider.dart' show Provider, ProviderRef; - -typedef ProviderElementBase = framework.ProviderElement; -typedef ProviderBase = framework.Provider; diff --git a/packages/riverpod/lib/src/framework2/legacy_providers/provider.dart b/packages/riverpod/lib/src/framework2/legacy_providers/provider.dart deleted file mode 100644 index 05f957979..000000000 --- a/packages/riverpod/lib/src/framework2/legacy_providers/provider.dart +++ /dev/null @@ -1,4 +0,0 @@ -@riverpod -T provider(ProviderRef ref, T Function(ProviderRef ref) create) { - return create(ref); -} diff --git a/packages/riverpod/lib/src/framework2/override.dart b/packages/riverpod/lib/src/framework2/override.dart deleted file mode 100644 index d43331ba5..000000000 --- a/packages/riverpod/lib/src/framework2/override.dart +++ /dev/null @@ -1,25 +0,0 @@ -part of 'framework.dart'; - -@immutable -sealed class Override { - const Override({required this.origin}); - - @internal - final Provider origin; -} - -@internal -final class OverrideWithValue extends Override { - const OverrideWithValue(this.value, {required super.origin}); - - @internal - final StateT value; -} - -@internal -abstract class OverrideWithCreate extends Override { - const OverrideWithCreate({required super.origin}); - - @internal - StateT create(ProviderElement ref); -} diff --git a/packages/riverpod/lib/src/framework2/provider.dart b/packages/riverpod/lib/src/framework2/provider.dart deleted file mode 100644 index 4c30528ef..000000000 --- a/packages/riverpod/lib/src/framework2/provider.dart +++ /dev/null @@ -1,138 +0,0 @@ -part of 'framework.dart'; - -abstract class ProviderListenableOrFamily {} - -abstract class ProviderOrFamily {} - -abstract base class Family implements ProviderOrFamily { - const Family(); -} - -/// {@template debug_provider_source} -/// Debug information about where a provider was defined. -/// -/// This can enable better error messages and better debugging experience. -/// For instance, it enables the devtool to open the IDE at the location -/// where the provider was defined. -/// {@endtemplate} -@internal -class DebugProviderSource { - const DebugProviderSource({ - required this.name, - required this.file, - required this.line, - required this.column, - required this.hash, - }); - - /// The name of the provider, as in the code. - final String name; - - /// The absolute path to the file where this provider was defined. - final String file; - - /// The line where this provider was defined. - final int line; - - /// The column where this provider was defined. - final int column; - - /// A hash of the source of this provider. - /// - /// This is used to determine if a provider was changed by a hot-reload. - final String hash; -} - -@deprecated -const renameProviderBaseToPRovider = Object(); - -@immutable -@renameProviderBaseToPRovider -abstract base class Provider - with ProviderListenable - implements ProviderOrFamily { - const Provider({ - required this.name, - required this.from, - required this.arguments, - required this.debugSource, - required this.dependencies, - required this.allTransitiveDependencies, - required this.isAlwaysAlive, - }); - - /// Whether the provider isn't automatically disposed when all its listeners - /// are removed. - /// - /// This is used for linting purposes. - final bool isAlwaysAlive; - - /// A debug name for this provider. - /// - /// This changes error messages, [toString] and other debug messages. - final String name; - - /// The "family" that owns this provider. - /// - /// A provider is part of a family if it has parameters. - /// In which case, the parameters used can be retrieved with [arguments]. - final Family? from; - - /// Debug information about where this provider was defined. - /// - /// This is prefilled by the code-generator. - final DebugProviderSource? debugSource; - - /// {@macro provider_arguments} - @Deprecated('Use arguments') - Object? get argument => arguments; - - /// {@template provider_arguments} - /// The arguments used to create this provider. - /// - /// If created using the code-generator, this will be a [Record] of all - /// the parameters used to create this provider. - /// {@endtemplate} - final Object? arguments; - - final List? dependencies; - final List? allTransitiveDependencies; - - Refreshable> get future; - Refreshable> get syncFuture; - Refreshable get notifier; - - /// A method that always create a new [ProviderElement]. - @visibleForOverriding - ProviderElement createElement(ProviderContainer container); - - /// A method for fast lookup of the [ProviderElement] associated to this provider. - /// - /// Providers that cannot be "scoped" may obtain their [ProviderElement] from - /// the "root" [ProviderContainer]. - /// - /// Providers may override this for even faster lookup, such as by caching - /// the [ProviderElement] in a static field. - @protected - ProviderElement getElement( - ProviderContainer container, { - required DebugDependentSource? debugDependentSource, - }) { - return container._insertProvider( - this, - debugDependentSource: debugDependentSource, - ); - } - - @visibleForOverriding - @override - ProviderSubscription addListener( - ProviderContainer container, - void Function(StateT? previous, StateT next) listener, { - required bool fireImmediately, - required void Function(Object error, StackTrace stackTrace)? onError, - required DebugDependentSource? debugDependentSource, - required ProviderElement? dependent, - required void Function()? onCancel, - }); -} diff --git a/packages/riverpod/lib/src/framework2/provider_container.dart b/packages/riverpod/lib/src/framework2/provider_container.dart deleted file mode 100644 index da02bb0d9..000000000 --- a/packages/riverpod/lib/src/framework2/provider_container.dart +++ /dev/null @@ -1,316 +0,0 @@ -part of 'framework.dart'; - -class _ProviderPointer { - _ProviderPointer({required this.isFromOverride}); - - /// Whether this pointer was created from an override. - /// - /// If so, this pointer should **never** be removed. - final bool isFromOverride; - ProviderElement? element; -} - -/// An object responsible for storing the a O(1) access to providers, -/// while also enabling the "scoping" of providers and ensuring all [ProviderContainer]s -/// are in sync. -/// -/// Instead of storing a [Map]. -/// -/// Then, when overriding a provider, it is guaranteed that the [ProviderContainer] -/// and all of its children have the same [_ProviderPointer] for a overridden provider. -/// -/// This way, we can read an overridden provider from any of the [ProviderContainer]s. -/// And no-matter where the first read is made, all [ProviderContainer]s will -/// share the same state. -class _ProviderPointers { - _ProviderPointers() - : _orphanPointers = HashMap(), - _familyPointers = HashMap(); - - _ProviderPointers.from(ProviderContainer parent) - : _orphanPointers = - HashMap.from(parent._providerPointers._orphanPointers), - _familyPointers = - HashMap.from(parent._providerPointers._familyPointers); - - late final ProviderContainer container; - final HashMap, _ProviderPointer> _orphanPointers; - final HashMap, _ProviderPointer>> - _familyPointers; - - /// Obtain and possibly mount the [ProviderElement] for a provider. - ProviderElement add( - Provider provider, { - required bool isFromOverride, - required DebugDependentSource? debugDependentSource, - }) { - final from = provider.from; - - _ProviderPointer mount() { - final pointer = _ProviderPointer(isFromOverride: isFromOverride); - final element = provider.createElement(container); - pointer.element = element; - - return pointer; - } - - if (from == null) { - final pointer = _orphanPointers.putIfAbsent(provider, mount); - final element = pointer.element!; - // TODO debugAddDependency(element, debugDependentSource: debugDependentSource); - - return element; - } else { - final _familyPointers = - this._familyPointers.putIfAbsent(from, HashMap.new); - final pointer = _familyPointers.putIfAbsent(provider, mount); - final element = pointer.element!; - // TODO debugAddDependency(element, debugDependentSource: debugDependentSource); - - return element; - } - } - - /// Obtain the pointer for a provider. Noop if it doesn't exist. - _ProviderPointer? _readPointer(Provider provider) { - final from = provider.from; - - if (from == null) { - return _orphanPointers[provider]; - } else { - return _familyPointers[from]?[provider]; - } - } - - /// Read the [ProviderElement] for a provider, without creating it if it doesn't exist. - ProviderElement? read( - Provider provider, { - required DebugDependentSource? debugDependentSource, - }) { - final element = _readPointer(provider)?.element; -// TODO debugAddDependency(element, debugDependentSource: debugDependentSource); - - return element; - } - - /// Read the [ProviderElement] for a provider, without creating it if it doesn't exist. - Iterable> readFamily( - Family family, { - required DebugDependentSource? debugDependentSource, - }) { - final _familyPointers = this._familyPointers[family]; - if (_familyPointers == null) return const []; - - return _familyPointers.values.map((e) { - final element = e.element; - // TODO debugAddDependency(element, debugDependentSource: debugDependentSource); - - return element; - }).whereNotNull(); - } - - /// Remove a provider from this container. - /// - /// Noop if the provider is from an override or doesn't exist. - void remove(Provider provider) { - final pointer = _readPointer(provider); - // If null, nothing to remove. If from an override, must not be removed. - if (pointer == null || pointer.isFromOverride) { - return; - } - - final from = provider.from; - - if (from == null) { - _orphanPointers.remove(provider); - } else { - final familyPointer = _familyPointers[from]; - - // Nothing to remove - if (familyPointer == null) return; - familyPointer.remove(provider); - - // Cleanup family if empty - - // The family isn't empty, nothing to do - if (familyPointer.isNotEmpty) return; - // The family is empty, remove it. - // It should be guaranteed that there this won't remove scoped provider pointers - // as there's a "isFromOverride" check at the beginning of this method. - _familyPointers.remove(from); - } - } -} - -final class ProviderContainer { - ProviderContainer({ - this.parent, - List overrides = const [], - List? observers, - }) : root = parent?.root ?? parent, - _providerPointers = parent != null - ? _ProviderPointers.from(parent) - : _ProviderPointers() { - _providerPointers.container = this; - } - - @visibleForTesting - factory ProviderContainer.test({ - ProviderContainer? parent, - List overrides = const [], - List? observers, - }) { - final container = ProviderContainer( - parent: parent, - overrides: overrides, - observers: observers, - ); - test.addTearDown(container.dispose); - - return container; - } - - final ProviderContainer? root; - final ProviderContainer? parent; - final _children = []; - final _ProviderPointers _providerPointers; - var _disposed = false; - final _scheduler = SchedulerBinding(); - - // TODO void updateOverrides(List overrides); - - // TODO void debugReassemble(); - - void invalidate( - ProviderOrFamily provider, { - bool asReload = false, - @internal DebugDependentSource? debugDependentSource, - }) { - switch (provider) { - case Provider(): - _providerPointers - .read( - provider, - debugDependentSource: kDebugMode - ? (debugDependentSource ?? - DebugProviderContainerInvalidateDependentSource( - container: this, - )) - : null, - ) - ?.markNeedsRebuild(asReload: asReload); - case Family(): - final elements = _providerPointers.readFamily( - provider, - debugDependentSource: debugDependentSource, - ); - for (final element in elements) { - element.markNeedsRebuild(asReload: asReload); - } - } - } - - StateT refresh( - Refreshable provider, { - @internal DebugDependentSource? debugDependentSource, - }) { - invalidate( - provider._refreshed, - debugDependentSource: kDebugMode - ? (debugDependentSource ?? - DebugProviderContainerRefreshDependentSource(container: this)) - : null, - ); - - return read( - provider, - debugDependentSource: kDebugMode - ? (debugDependentSource ?? - DebugProviderContainerRefreshDependentSource(container: this)) - : null, - ); - } - - ProviderElement _insertProvider( - Provider provider, { - required DebugDependentSource? debugDependentSource, - }) { - return _providerPointers.add( - provider, - // If the provider points to an override, a pointer should already be set. - // So always using `false` isn't an issue. - isFromOverride: false, - debugDependentSource: debugDependentSource, - ); - } - - StateT read( - ProviderListenable provider, { - @internal DebugDependentSource? debugDependentSource, - }) { - final subscription = listen( - provider, - (_, value) {}, - debugDependentSource: kDebugMode - ? (debugDependentSource ?? - DebugProviderContainerReadDependentSource(container: this)) - : null, - ); - try { - return subscription.read(); - } finally { - subscription.close(); - } - } - - ProviderSubscription listen( - ProviderListenable provider, - ProviderListener listener, { - bool fireImmediately = false, - OnError? onError, - @internal DebugDependentSource? debugDependentSource, - OnCancel? onCancel, - }) { - return provider.addListener( - this, - listener, - fireImmediately: fireImmediately, - onError: onError, - onCancel: onCancel, - dependent: null, - debugDependentSource: kDebugMode - ? (debugDependentSource ?? - DebugProviderContainerListenDependentSource(container: this)) - : null, - ); - } - - bool exists( - Provider provider, { - @internal DebugDependentSource? debugDependentSource, - }) { - return _providerPointers.read( - provider, - debugDependentSource: kDebugMode - ? (debugDependentSource ?? - DebugProviderContainerExistsDependentSource(container: this)) - : null, - ) != - null; - } - - // TODO Future pump(); - - void dispose() { - if (_disposed) return; - - _disposed = true; - parent?._children.remove(this); - } -} - -@internal -extension ProviderContainerTest on ProviderContainer { - bool get disposed => _disposed; -} diff --git a/packages/riverpod/lib/src/framework2/provider_element.dart b/packages/riverpod/lib/src/framework2/provider_element.dart deleted file mode 100644 index eb8b52d89..000000000 --- a/packages/riverpod/lib/src/framework2/provider_element.dart +++ /dev/null @@ -1,334 +0,0 @@ -part of 'framework.dart'; - -enum _DirtyType { - reload, - refresh, -} - -/// The element of a provider is a class responsible for managing the state -/// of a provider. -/// -/// It is responsible for: -/// - Initializing the provider -/// - Recomputing the provider when requested (such as with [Ref.watch] or [Ref.invalidate]) -/// - Disposing the state -abstract class ProviderElement { - ProviderElement(this.container); - - /// The provider associated with this [ProviderElement]. - Provider get provider; - - /// The container where this [ProviderElement] is attached to. - final ProviderContainer container; - - /// Whether this provider is currently paused. - /// - /// A provider is paused when if: - /// - It has no listeners - /// - All of its listeners are paused - /// - The provider was manually using [pause]. - bool get paused => - _subscriptions.isEmpty || _pauseCount > 0 || _pausedListenerCount > 0; - - bool get disposed => _disposed; - bool _disposed = false; - - _DirtyType? _dirty; - - /// What this provider is currently listening to. - List> _subscriptions = []; - - /// The listeners listening to this provider. - List> _listeners = []; - - var _pauseCount = 0; - var _pausedListenerCount = 0; - - // // The various life-cycles listeners of a provider. - // // We store them in the element instead of Ref for performance reasons. - // // This avoids having to create a new list for each Ref and is less DC intensive. - // TODO - // final _onDispose = VoidNotifier(); - // final _onAddListener = VoidNotifier(); - // final _onRemoveListener = VoidNotifier(); - // final _onResume = VoidNotifier(); - // final _onPause = VoidNotifier(); - - Ref? _ref; - - AsyncValue? get result => _result; - AsyncValue? _result; - - int get depthApproximation => _depthApproximation; - int _depthApproximation = 0; - - AsyncValue requestState() { - container._scheduler.scheduleBuildFor(this); - - final result = this.result; - if (result != null) return result; - - throw StateError( - 'Cannot request state while the provider is not built', - ); - } - - void _runProviderBuild() { - assert(_dirty != null); - - _dirty = null; - - setLoading(); - final ref = _ref = Ref._(this); - - List>? previousSubscriptions = _subscriptions; - _subscriptions = []; - - void closePreviousSubscriptions() { - for (final subscription in previousSubscriptions!) { - subscription.close(); - } - previousSubscriptions = null; - } - - // Prevent listeners from being notified while we are building. - // TODO assert(_lockNotifyListeners()); - - final tenable = Tenable.fromFutureOr(() => build(ref)); - - // Once "build" has completed, we fully close previous subscriptions. - tenable.whenComplete(closePreviousSubscriptions); - - // If "build" completed synchronously, subscriptions should already be closed. - // No need to pause them. - // We pause subscriptions _after_ starting build, for the sake of efficiency. - // This avoids both pausing and closing subscriptions in a quick succession. - if (previousSubscriptions != null) { - // Pause previous subscriptions to disable them while "build" is running. - // This avoids unnecessary work in providers that may not be used anymore. - for (final subscription in previousSubscriptions!) { - subscription.pause(); - } - } - - // TODO assert(_unlockNotifyListeners()); - assert(result != null); - // We notify listeners after "build" has completed. - // This avoids notifying listeners multiple times if multiple state change - // operations are performed at once. - // TODO _notifyListeners(); - } - - void setLoading() { - // TODO - } - - void setError(Object error, StackTrace stackTrace) { - // TODO - } - - void setData(StateT value) { - // TODO - } - - ProviderSubscription addListener( - ProviderListener listener, { - required bool fireImmediately, - required OnError? onError, - required ResultT Function(AsyncValue value) convert, - required DebugDependentSource? debugDependentSource, - required ProviderElement? dependent, - required OnCancel? onCancel, - }) { - final subscription = _ProviderSubscription( - this, - listener, - convert: convert, - fireImmediately: fireImmediately, - onError: onError, - debugDependentSource: debugDependentSource, - dependent: dependent, - originalDependentSubscriptions: _subscriptions, - onCancel: onCancel, - ); - - _listeners.add(subscription); - - if (dependent != null) { - dependent._subscriptions.add(subscription); - } - - return subscription; - } - - /// Invoke the "create" method of a provider. - /// - /// Should not notify listeners during the synchronous execution of the build - /// method. - @visibleForOverriding - FutureOr build(Ref ref); - - void pause() { - if (_disposed) throw StateError('Cannot pause a disposed ProviderElement'); - - _pauseCount++; - } - - void resume() { - if (_disposed) throw StateError('Cannot resume a disposed ProviderElement'); - - // Noop if not paused. - if (_pauseCount == 0) return; - - _pauseCount--; - } - - void markNeedsRebuild({bool asReload = false}) { - if (_dirty != null) { - // If at least one rebuild request asks for a "reload", then we reload. - // Otherwise we "refresh". - if (asReload) _dirty = _DirtyType.reload; - - return; - } - - _dirty = asReload ? _DirtyType.reload : _DirtyType.refresh; - - container._scheduler.scheduleBuildFor(this); - } - - void _runDispose() { - // By disposing the "ref" before invoking "onDispose", - // then we ensure that "onDispose" cannot call "ref.state=" & co. - _ref?._dispose(); - _ref = null; - - // TODO _onDispose - // ..notifyListeners() - // ..clear(); - } - - @mustCallSuper - void unmount() { - _runDispose(); - - _disposed = true; - - // Clearing the subscriptions before closing them, for efficiency. - // This avoids having to remove the subscriptions from the list. - // Cf _ProviderSubscription._originalDependentSubscriptions. - final subscriptions = _subscriptions; - final listeners = _listeners; - _listeners = []; - _subscriptions = []; - - for (final subscription in subscriptions) { - subscription.close(); - } - for (final listener in listeners) { - listener.close(); - } - - _ref = null; - _result = null; - } -} - -class _ProviderSubscription - implements ProviderSubscription { - _ProviderSubscription( - this._element, - this._listener, { - required ResultT Function(AsyncValue value) convert, - required bool fireImmediately, - required void Function(Object error, StackTrace stackTrace)? onError, - required DebugDependentSource? debugDependentSource, - required ProviderElement? dependent, - required List> originalDependentSubscriptions, - required void Function()? onCancel, - }) : _fireImmediately = fireImmediately, - _onError = onError, - _convert = convert, - _debugDependentSource = debugDependentSource, - _dependent = dependent, - _originalDependentSubscriptions = originalDependentSubscriptions, - _onCancel = onCancel; - - final ProviderElement _element; - final ResultT Function(AsyncValue) _convert; - final void Function(ResultT? previous, ResultT next) _listener; - final bool _fireImmediately; - final void Function(Object error, StackTrace stackTrace)? _onError; - final DebugDependentSource? _debugDependentSource; - final ProviderElement? _dependent; - final void Function()? _onCancel; - - /// [ProvidElement._subscriptions] at the time this subscription was created. - /// - /// Used to optimize the removal of this subscription from the list when the - /// provider's state was refreshed. - final List> _originalDependentSubscriptions; - - bool _closed = false; - int _pauseCount = 0; - - @override - ResultT read() { - if (_closed) { - throw StateError('Cannot read from a closed subscription'); - } - if (_pauseCount > 0) { - throw StateError('Cannot read from a paused subscription'); - } - - return _convert(_element.requestState()); - } - - @override - void pause() { - if (_closed) { - throw StateError('Cannot pause a closed subscription'); - } - - // If this is the first pause, pause the provider too. - if (_pauseCount == 0) _element._pausedListenerCount++; - - _pauseCount++; - } - - @override - void resume() { - if (_closed) { - throw StateError('Cannot resume a closed subscription'); - } - - // Noop if not paused. - if (_pauseCount == 0) return; - - // If this is the last resume, unpause the provider too. - if (_pauseCount == 1) _element._pausedListenerCount--; - - _pauseCount--; - } - - @override - void close() { - if (_closed) { - throw StateError('Cannot close a closed subscription'); - } - - _closed = true; - - // If closing a paused subscription, unpause the provider too. - if (_pauseCount > 0) _element._pausedListenerCount--; - - _onCancel?.call(); - - _element._listeners.remove(this); - - if (_dependent != null && - _dependent._subscriptions == _originalDependentSubscriptions) { - _dependent._subscriptions.remove(this); - } - } -} diff --git a/packages/riverpod/lib/src/framework2/provider_listenable.dart b/packages/riverpod/lib/src/framework2/provider_listenable.dart deleted file mode 100644 index f835da3c5..000000000 --- a/packages/riverpod/lib/src/framework2/provider_listenable.dart +++ /dev/null @@ -1,53 +0,0 @@ -part of 'framework.dart'; - -@immutable -mixin ProviderListenable implements ProviderListenableOrFamily { - @visibleForOverriding - ProviderSubscription addListener( - ProviderContainer container, - void Function(StateT? previous, StateT next) listener, { - required bool fireImmediately, - required void Function(Object error, StackTrace stackTrace)? onError, - required DebugDependentSource? debugDependentSource, - required ProviderElement? dependent, - required void Function()? onCancel, - }); - - // TODO select -} - -abstract class ProviderSubscription { - StateT read(); - - /// Pause the subscription. - /// - /// While paused, the subscription will not notify listeners. - /// If all subscriptions of a provider are paused, the provider itself - /// will be paused (invoking [Ref.onCancel]). From there on, the provider - /// will not rebuild unless read even if a dependency changes. - /// - /// If the subscription is already paused, calling [pause] again will have no effect. - /// - /// Calling [resume] will resume the subscription. - /// The [resume] method will have to be called as many times as [pause] was called. - void pause(); - - /// Resume the subscription. - /// - /// If the subscription is not paused, calling [resume] will have no effect. - /// - /// If the subscription was paused multiple times, it is necessary to call - /// [resume] as many times as [pause] was called to resume the subscription. - /// If resuming a subscription on a provider that is paused, the provider - /// will be resumed as well (invoking [Ref.onResume]). - /// - /// See also: - /// - [pause], which pauses the subscription. - void resume(); - - void close(); -} - -mixin Refreshable on ProviderListenable { - Provider get _refreshed; -} diff --git a/packages/riverpod/lib/src/framework2/provider_observer.dart b/packages/riverpod/lib/src/framework2/provider_observer.dart deleted file mode 100644 index 0b7e88760..000000000 --- a/packages/riverpod/lib/src/framework2/provider_observer.dart +++ /dev/null @@ -1,30 +0,0 @@ -part of 'framework.dart'; - -abstract class ProviderObserver { - const ProviderObserver(); - - void didAddProvider( - Provider provider, - Object? value, - ProviderContainer container, - ) {} - - void providerDidFail( - Provider provider, - Object error, - StackTrace stackTrace, - ProviderContainer container, - ) {} - - void didUpdateProvider( - Provider provider, - Object? previousValue, - Object? newValue, - ProviderContainer container, - ) {} - - void didDisposeProvider( - Provider provider, - ProviderContainer container, - ) {} -} diff --git a/packages/riverpod/lib/src/framework2/ref.dart b/packages/riverpod/lib/src/framework2/ref.dart deleted file mode 100644 index 0dd9640ec..000000000 --- a/packages/riverpod/lib/src/framework2/ref.dart +++ /dev/null @@ -1,167 +0,0 @@ -part of 'framework.dart'; - -class Ref { - Ref._(this._element); - - bool get mounted => !_element.disposed; - var _mounted = false; - - ProviderContainer get container { - _assertNotDisposed(); - return _element.container; - } - - // TODO deprecate state= - // StateT get state { - // _assertNotDisposed(); - // } - - // TODO - // FutureOr get future { - // _assertNotDisposed(); - // } - - final ProviderElement _element; - - void _assertNotDisposed() { - assert( - !_mounted, - ''' -Cannot use a disposed "ref". This may happen is: -- You are using a "ref" on a provider that was disposed (such as because it was no-longer listened). -- Your provider rebuilt, and therefore a more up-to-date "ref" is available. -''', - ); - } - - @useResult - T refresh(Refreshable provider) { - _assertNotDisposed(); - return container.refresh( - provider, - debugDependentSource: kDebugMode - ? DebugRefRefreshDependentSource(provider: _element.provider) - : null, - ); - } - - void invalidate(ProviderOrFamily provider, {bool asReload = false}) { - _assertNotDisposed(); - container.invalidate( - provider, - asReload: asReload, - debugDependentSource: kDebugMode - ? DebugRefInvalidateDependentSource(provider: _element.provider) - : null, - ); - } - - // TODO remove Reload dependent source - - bool exists(Provider provider) { - _assertNotDisposed(); - return container.exists( - provider, - debugDependentSource: kDebugMode - ? DebugRefExistsDependentSource(provider: _element.provider) - : null, - ); - } - - void invalidateSelf() { - _assertNotDisposed(); - _element.markNeedsRebuild(); - } - - void reloadSelf() { - _assertNotDisposed(); - _element.markNeedsRebuild(asReload: true); - } - - // TODO - // void notifyListeners() => _element.notifyListeners(); - - // void onAddListener(OnAddListener cb) { - // _assertNotDisposed(); - // _element.onAddListener(cb); - // } - - // void onRemoveListener(OnRemoveListener cb) { - // _assertNotDisposed(); - // _element.onRemoveListener(cb); - // } - - // void onResume(OnResume cb) { - // _assertNotDisposed(); - // _element.onResume(cb); - // } - - // void onCancel(OnCancel cb) { - // _assertNotDisposed(); - // _element.onCancel(cb); - // } - - // void onDispose(OnDispose cb) { - // _assertNotDisposed(); - // _element.onDispose(cb); - // } - - T read(ProviderListenable provider) { - _assertNotDisposed(); - final subscription = container.listen( - provider, - (_, value) {}, - debugDependentSource: kDebugMode - ? DebugRefReadDependentSource(provider: _element.provider) - : null, - ); - try { - return subscription.read(); - } finally { - subscription.close(); - } - } - - T watch(ProviderListenable provider) { - final subscription = container.listen( - provider, - (_, value) => reloadSelf(), - debugDependentSource: kDebugMode - ? DebugRefWatchDependentSource(provider: _element.provider) - : null, - ); - - return subscription.read(); - } - - ProviderSubscription listen( - ProviderListenable provider, - ProviderListener listener, { - OnError? onError, - VoidCallback? onCancel, - bool fireImmediately = false, - }) { - _assertNotDisposed(); - return container.listen( - provider, - listener, - onError: onError, - onCancel: onCancel, - fireImmediately: fireImmediately, - debugDependentSource: kDebugMode - ? DebugRefListenDependentSource(provider: _element.provider) - : null, - ); - } - - // Mention bout listening to self does not cause a provider to be "unpaused". - // TODO void listenSelf( - // ProviderListener listener, { - // OnError? onError, - // }) { - // _assertNotDisposed(); - // _element._listenSelf(listener, onError); - // } - - void _dispose() => _mounted = true; -} diff --git a/packages/riverpod/lib/src/framework2/scheduler.dart b/packages/riverpod/lib/src/framework2/scheduler.dart deleted file mode 100644 index 90d6fdf0c..000000000 --- a/packages/riverpod/lib/src/framework2/scheduler.dart +++ /dev/null @@ -1,66 +0,0 @@ -part of 'framework.dart'; - -@internal -class SchedulerBinding { - final _toBuild = >[]; - - bool _closed = false; - - int scheduleBuildFor(ProviderElement element) => - _depthBasedInsert(element); - - int _depthBasedInsert(ProviderElement element, [int start = 0]) { - final depth = element.depthApproximation; - final index = _toBuild.indexWhere( - (e) => e.depthApproximation > depth, - start, - ); - - if (index == -1) { - _toBuild.add(element); - return _toBuild.length - 1; - } else { - _toBuild.insert(index, element); - return index; - } - } - - int rescheduleBuildFor(ProviderElement element, int previousIndex) { - final index = _toBuild.indexOf(element, previousIndex); - assert(index >= 0, 'The element was not found in the list of providers'); - - _toBuild.removeAt(index); - - return _depthBasedInsert(element, index + 1); - } - - void _task() { - if (_closed) return; - - flushBuild(); - } - - void flushBuild() { - var debugDepth = 0; - - for (var x = 0; x < _toBuild.length; x++) { - // Assert that the elements are sorted by their depth - if (kDebugMode) { - assert( - debugDepth <= _toBuild[x].depthApproximation, - 'Bad state, the internal list of providers is incorrectly sorted', - ); - debugDepth = _toBuild[x].depthApproximation; - } - - final element = _toBuild[x]; - - if (!element.paused && !element.disposed) element._runProviderBuild(); - } - _toBuild.clear(); - } - - void close() { - _closed = true; - } -} From ca23b697f089c9d66777a10feacc0b0ae665c2a9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 29 Dec 2023 01:59:11 +0100 Subject: [PATCH 112/387] Add more dependencies --- .../flutter_riverpod/test/framework_test.dart | 2 +- ...to_dispose_change_notifier_provider_test.dart | 14 +++++++++----- .../change_notifier_provider_test.dart | 12 +++++++++--- ...to_dispose_change_notifier_provider_test.dart | 16 +++++++++++----- .../family_change_notifier_provider_test.dart | 4 +++- 5 files changed, 33 insertions(+), 15 deletions(-) diff --git a/packages/flutter_riverpod/test/framework_test.dart b/packages/flutter_riverpod/test/framework_test.dart index 7796a660a..340703104 100644 --- a/packages/flutter_riverpod/test/framework_test.dart +++ b/packages/flutter_riverpod/test/framework_test.dart @@ -238,7 +238,7 @@ void main() { testWidgets('ref.read obtains the nearest Provider possible', (tester) async { late WidgetRef ref; - final provider = Provider((watch) => 42); + final provider = Provider((watch) => 42, dependencies: const []); await tester.pumpWidget( ProviderScope( diff --git a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart index 7aa4cfa8e..a149a2601 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart @@ -72,8 +72,10 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () { - final provider = - ChangeNotifierProvider.autoDispose((ref) => ValueNotifier(0)); + final provider = ChangeNotifierProvider.autoDispose( + (ref) => ValueNotifier(0), + dependencies: const [], + ); final root = createContainer(); final container = createContainer(parent: root, overrides: [provider]); @@ -112,8 +114,10 @@ void main() { // }); test('when using provider.overrideWith', () { - final provider = - ChangeNotifierProvider.autoDispose((ref) => ValueNotifier(0)); + final provider = ChangeNotifierProvider.autoDispose( + (ref) => ValueNotifier(0), + dependencies: const [], + ); final root = createContainer(); final container = createContainer( parent: root, @@ -136,7 +140,7 @@ void main() { }); test('can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider((ref) => 0, dependencies: const []); final provider = ChangeNotifierProvider.autoDispose( (ref) => ValueNotifier(ref.watch(dep)), dependencies: [dep], diff --git a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart index 9a3e8ee65..b7a176863 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart @@ -150,7 +150,10 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () { - final provider = ChangeNotifierProvider((ref) => ValueNotifier(0)); + final provider = ChangeNotifierProvider( + (ref) => ValueNotifier(0), + dependencies: const [], + ); final root = createContainer(); final container = createContainer(parent: root, overrides: [provider]); @@ -188,7 +191,10 @@ void main() { // }); test('when using provider.overrideWith', () { - final provider = ChangeNotifierProvider((ref) => ValueNotifier(0)); + final provider = ChangeNotifierProvider( + (ref) => ValueNotifier(0), + dependencies: const [], + ); final root = createContainer(); final container = createContainer( parent: root, @@ -388,7 +394,7 @@ void main() { // }); test('ChangeNotifier can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider((ref) => 0, dependencies: const []); final provider = ChangeNotifierProvider( (ref) => ValueNotifier(ref.watch(dep)), dependencies: [dep], diff --git a/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart index e265e67f7..f16bb37ba 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart @@ -33,8 +33,11 @@ void main() { group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () async { - final provider = ChangeNotifierProvider.autoDispose - .family, int>((ref, _) => ValueNotifier(0)); + final provider = + ChangeNotifierProvider.autoDispose.family, int>( + (ref, _) => ValueNotifier(0), + dependencies: const [], + ); final root = createContainer(); final container = createContainer(parent: root, overrides: [provider]); @@ -51,7 +54,7 @@ void main() { }); test('ChangeNotifier can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider((ref) => 0, dependencies: const []); final provider = ChangeNotifierProvider.autoDispose.family, int>( (ref, i) => ValueNotifier(ref.watch(dep) + i), @@ -70,8 +73,11 @@ void main() { }); test('when using provider.overrideWith', () async { - final provider = ChangeNotifierProvider.autoDispose - .family, int>((ref, _) => ValueNotifier(0)); + final provider = + ChangeNotifierProvider.autoDispose.family, int>( + (ref, _) => ValueNotifier(0), + dependencies: const [], + ); final root = createContainer(); final container = createContainer( parent: root, diff --git a/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart index be9ecb317..959793d58 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart @@ -33,6 +33,7 @@ void main() { test('when passing the provider itself', () async { final provider = ChangeNotifierProvider.family, int>( (ref, _) => ValueNotifier(0), + dependencies: const [], ); final root = createContainer(); final container = createContainer(parent: root, overrides: [provider]); @@ -51,7 +52,7 @@ void main() { }); test('ChangeNotifier can be auto-scoped', () async { - final dep = Provider((ref) => 0); + final dep = Provider((ref) => 0, dependencies: const []); final provider = ChangeNotifierProvider.family, int>( (ref, i) => ValueNotifier(ref.watch(dep) + i), dependencies: [dep], @@ -71,6 +72,7 @@ void main() { test('when using provider.overrideWith', () async { final provider = ChangeNotifierProvider.family, int>( (ref, _) => ValueNotifier(0), + dependencies: const [], ); final root = createContainer(); final container = createContainer( From 5e2bef16aa7a113e9ea4a53d57a76d400a880327 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 29 Dec 2023 14:11:09 +0100 Subject: [PATCH 113/387] Move tests --- packages/riverpod/lib/riverpod.dart | 1 + .../new/core/provider_container_test.dart | 879 ++++++++- .../riverpod/test/new/core/provider_test.dart | 15 + packages/riverpod/test/new/core/ref_test.dart | 950 +++++++++- .../framework => new/core}/scope_test.dart | 129 +- packages/riverpod/test/new/utils.dart | 24 + .../test/old/framework/auto_dispose_test.dart | 328 +--- .../test/old/framework/family_test.dart | 2 +- .../test/old/framework/listen_test.dart | 1642 ----------------- 9 files changed, 1987 insertions(+), 1983 deletions(-) create mode 100644 packages/riverpod/test/new/core/provider_test.dart rename packages/riverpod/test/{old/framework => new/core}/scope_test.dart (86%) delete mode 100644 packages/riverpod/test/old/framework/listen_test.dart diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 51e670572..2242485e5 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -1,3 +1,4 @@ +// TODO this exports too many things export 'package:state_notifier/state_notifier.dart' hide Listener, LocatorMixin; export 'src/core/async_value.dart' hide AsyncTransition; diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index b69b8018a..18f87c6e2 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -1,5 +1,7 @@ +import 'dart:async'; + import 'package:mockito/mockito.dart'; -import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/riverpod.dart' hide ErrorListener; import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; @@ -1637,6 +1639,26 @@ void main() { }); group('dispose', () { + test( + 'Handles cases where the ProviderContainer is disposed yet Scheduler.performDispose is invoked anyway', + () async { + // regression test for https://github.com/rrousselGit/riverpod/issues/1400 + final provider = Provider.autoDispose( + (ref) => 0, + dependencies: const [], + ); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); + + container.read(provider); + container.dispose(); + + await root.pump(); + }); + test( 'after a child container is disposed, ' 'ref.watch keeps working on providers associated with the ancestor container', @@ -2090,6 +2112,861 @@ void main() { }); group('listen', () { + test('when no onError is specified, fallbacks to handleUncaughtError', + () async { + final container = ProviderContainer.test(); + final isErrored = StateProvider((ref) => false); + final dep = Provider((ref) { + if (ref.watch(isErrored)) throw UnimplementedError(); + return 0; + }); + final listener = Listener(); + final errors = []; + + runZonedGuarded( + () => container.listen(dep, listener.call), + (err, stack) => errors.add(err), + ); + + verifyZeroInteractions(listener); + expect(errors, isEmpty); + + container.read(isErrored.notifier).state = true; + + await container.pump(); + + verifyZeroInteractions(listener); + expect(errors, [isUnimplementedError]); + }); + + test( + 'when no onError is specified, selectors fallbacks to handleUncaughtError', + () async { + final container = ProviderContainer.test(); + final isErrored = StateProvider((ref) => false); + final dep = Provider((ref) { + if (ref.watch(isErrored)) throw UnimplementedError(); + return 0; + }); + final listener = Listener(); + final errors = []; + + runZonedGuarded( + () => container.listen(dep.select((value) => value), listener.call), + (err, stack) => errors.add(err), + ); + + verifyZeroInteractions(listener); + expect(errors, isEmpty); + + container.read(isErrored.notifier).state = true; + + await container.pump(); + + verifyZeroInteractions(listener); + expect(errors, [isUnimplementedError]); + }); + + test('when rebuild throws, calls onError', () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final provider = Provider((ref) { + if (ref.watch(dep) != 0) { + throw UnimplementedError(); + } + return 0; + }); + final errorListener = ErrorListener(); + final listener = Listener(); + + container.listen(provider, listener.call, onError: errorListener.call); + + verifyZeroInteractions(errorListener); + verifyZeroInteractions(listener); + + container.read(dep.notifier).state++; + await container.pump(); + + verifyZeroInteractions(listener); + verifyOnly( + errorListener, + errorListener(isUnimplementedError, any), + ); + }); + + test('when rebuild throws on selector, calls onError', () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final provider = Provider((ref) { + if (ref.watch(dep) != 0) { + throw UnimplementedError(); + } + return 0; + }); + final errorListener = ErrorListener(); + final listener = Listener(); + + container.listen( + provider.select((value) => value), + listener.call, + onError: errorListener.call, + ); + + verifyZeroInteractions(errorListener); + verifyZeroInteractions(listener); + + container.read(dep.notifier).state++; + await container.pump(); + + verifyZeroInteractions(listener); + verifyOnly( + errorListener, + errorListener(isUnimplementedError, any), + ); + }); + + test( + 'when using selectors, `previous` is the latest notification instead of latest event', + () { + final container = ProviderContainer.test(); + final provider = StateNotifierProvider, int>( + (ref) => StateController(0), + ); + final listener = Listener(); + + container.listen( + provider.select((value) => value.isEven), + listener.call, + fireImmediately: true, + ); + + verifyOnly(listener, listener(null, true)); + + container.read(provider.notifier).state += 2; + + verifyNoMoreInteractions(listener); + + container.read(provider.notifier).state++; + + verifyOnly(listener, listener(true, false)); + }); + + test('expose previous and new value on change', () { + final container = ProviderContainer.test(); + final provider = StateNotifierProvider, int>( + (ref) => StateController(0), + ); + final listener = Listener(); + + container.listen(provider, listener.call, fireImmediately: true); + + verifyOnly(listener, listener(null, 0)); + + container.read(provider.notifier).state++; + + verifyOnly(listener, listener(0, 1)); + }); + + test('can downcast the value', () async { + final listener = Listener(); + final dep = StateProvider((ref) => 0); + + final container = ProviderContainer.test(); + + container.listen(dep, listener.call); + + verifyZeroInteractions(listener); + + container.read(dep.notifier).state++; + await container.pump(); + + verifyOnly(listener, listener(0, 1)); + }); + + test( + 'if a listener adds a container.listen, the new listener is not called immediately', + () { + final provider = StateProvider((ref) => 0); + final container = ProviderContainer.test(); + + final listener = Listener(); + + container.listen(provider, (prev, value) { + listener(prev, value); + container.listen(provider, listener.call); + }); + + verifyZeroInteractions(listener); + + container.read(provider.notifier).state++; + + verify(listener(0, 1)).called(1); + + container.read(provider.notifier).state++; + + verify(listener(1, 2)).called(2); + }); + + test( + 'if a listener removes another provider.listen, the removed listener is still called', + () { + final provider = StateProvider((ref) => 0); + final container = ProviderContainer.test(); + + final listener = Listener(); + final listener2 = Listener(); + + final p = Provider((ref) { + ProviderSubscription? a; + ref.listen(provider, (prev, value) { + listener(prev, value); + a?.close(); + a = null; + }); + + a = ref.listen(provider, listener2.call); + }); + container.read(p); + + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); + + container.read(provider.notifier).state++; + + verifyInOrder([ + listener(0, 1), + listener2(0, 1), + ]); + + container.read(provider.notifier).state++; + + verify(listener(1, 2)).called(1); + verifyNoMoreInteractions(listener2); + }); + + test( + 'if a listener removes another provider.listen, the removed listener is still called (ProviderListenable)', + skip: true, + () { + final provider = StateProvider((ref) => 0); + final container = ProviderContainer.test(); + + final listener = Listener(); + final listener2 = Listener(); + + final p = Provider((ref) { + ProviderSubscription? a; + ref.listen(provider, (prev, value) { + listener(prev, value); + a?.close(); + a = null; + }); + + a = ref.listen(provider, listener2.call); + }); + container.read(p); + + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); + + container.read(provider.notifier).state++; + + verifyInOrder([ + listener(1, 1), + listener2(1, 1), + ]); + + container.read(provider.notifier).state++; + + verify(listener(2, 2)).called(1); + verifyNoMoreInteractions(listener2); + // TODO the problem is that ProviderListenable subscriptions are separate from + // ProviderElement subscriptions. So the ProviderElement.notifyListeners + // making a local copy of the list of subscriptions before notifying listeners + // does not apply to ProviderListenables + // Support for modifying listeners within a listener probably should be dropped anyway for performance. + // This would remove a list copy + }, + ); + + test( + 'if a listener adds a provider.listen, the new listener is not called immediately', + () { + final provider = StateProvider((ref) => 0); + final container = ProviderContainer.test(); + + final listener = Listener(); + + final p = Provider((ref) { + ref.listen(provider, (prev, value) { + listener(prev, value); + ref.listen(provider, listener.call); + }); + }); + container.read(p); + + verifyZeroInteractions(listener); + + container.read(provider.notifier).state++; + + verify(listener(0, 1)).called(1); + + container.read(provider.notifier).state++; + + verify(listener(1, 2)).called(2); + }); + + test( + 'if a listener removes another container.listen, the removed listener is still called (ProviderListenable)', + skip: true, + () { + final provider = StateProvider((ref) => 0); + final container = ProviderContainer.test(); + + final listener = Listener(); + final listener2 = Listener(); + + ProviderSubscription? a; + container.listen(provider, (prev, value) { + listener(prev, value); + a?.close(); + a = null; + }); + + a = container.listen(provider, listener2.call); + + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); + + container.read(provider.notifier).state++; + + verifyInOrder([ + listener(1, 1), + listener2(1, 1), + ]); + + container.read(provider.notifier).state++; + + verify(listener(2, 2)).called(1); + verifyNoMoreInteractions(listener2); + // TODO the problem is that ProviderListenable subscriptions are separate from + // ProviderElement subscriptions. So the ProviderElement.notifyListeners + // making a local copy of the list of subscriptions before notifying listeners + // does not apply to ProviderListenables + // Support for modifying listeners within a listener probably should be dropped anyway for performance. + // This would remove a list copy + }, + ); + + test( + 'if a listener removes another container.listen, the removed listener is still called', + () { + final provider = StateProvider((ref) => 0); + final container = ProviderContainer.test(); + + final listener = Listener(); + final listener2 = Listener(); + + ProviderSubscription? a; + container.listen(provider, (prev, value) { + listener(prev, value); + a?.close(); + a = null; + }); + + a = container.listen(provider, listener2.call); + + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); + + container.read(provider.notifier).state++; + + verifyInOrder([ + listener(0, 1), + listener2(0, 1), + ]); + + container.read(provider.notifier).state++; + + verify(listener(1, 2)).called(1); + verifyNoMoreInteractions(listener2); + }); + + group('fireImmediately', () { + test('when no onError is specified, fallbacks to handleUncaughtError', + () { + final container = ProviderContainer.test(); + final dep = Provider((ref) => throw UnimplementedError()); + final listener = Listener(); + final errors = []; + + runZonedGuarded( + () { + container.listen( + dep, + listener.call, + fireImmediately: true, + ); + }, + (err, stack) => errors.add(err), + ); + + verifyZeroInteractions(listener); + expect(errors, [ + isUnimplementedError, + ]); + }); + + test( + 'when no onError is specified on selectors, fallbacks to handleUncaughtError', + () { + final container = ProviderContainer.test(); + final dep = Provider((ref) => throw UnimplementedError()); + final listener = Listener(); + final errors = []; + + runZonedGuarded( + () { + container.listen( + dep.select((value) => value), + listener.call, + fireImmediately: true, + ); + }, + (err, stack) => errors.add(err), + ); + + verifyZeroInteractions(listener); + expect(errors, [ + isUnimplementedError, + ]); + }); + + test('on provider that threw, fireImmediately calls onError', () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => throw UnimplementedError()); + final listener = Listener(); + final errorListener = ErrorListener(); + + container.listen( + provider, + listener.call, + onError: errorListener.call, + fireImmediately: true, + ); + + verifyZeroInteractions(listener); + verifyOnly( + errorListener, + errorListener(isUnimplementedError, argThat(isNotNull)), + ); + }); + + test('supports selectors', () { + final container = ProviderContainer.test(); + final provider = StateProvider((ref) => 0); + final listener = Listener(); + final listener2 = Listener(); + + container.listen( + provider.select((v) => v.isEven), + listener.call, + fireImmediately: true, + ); + container.listen(provider.select((v) => v.isEven), listener2.call); + + verifyOnly(listener, listener(null, true)); + verifyZeroInteractions(listener2); + + container.read(provider.notifier).state = 21; + + verifyOnly(listener, listener(true, false)); + verifyOnly(listener2, listener2(true, false)); + }); + + test('passing fireImmediately: false skips the initial value', () { + final provider = StateProvider((ref) => 0); + final listener = Listener(); + + final container = ProviderContainer.test(); + + container.listen(provider, listener.call); + + verifyZeroInteractions(listener); + }); + + test( + 'correctly listens to the provider if selector onError listener throws', + () async { + final dep = StateProvider((ref) => 0); + final provider = Provider((ref) { + if (ref.watch(dep) == 0) { + throw UnimplementedError(); + } + return ref.watch(dep); + }); + final listener = Listener(); + final errorListener = ErrorListener(); + var isFirstCall = true; + + final container = ProviderContainer.test(); + final errors = []; + + final sub = runZonedGuarded( + () => container.listen( + provider.select((value) => value), + listener.call, + onError: (err, stack) { + errorListener(err, stack); + if (isFirstCall) { + isFirstCall = false; + throw StateError('Some error'); + } + }, + fireImmediately: true, + ), + (err, stack) => errors.add(err), + ); + + container.listen(provider, (prev, value) {}); + + expect(sub, isNotNull); + verifyZeroInteractions(listener); + verifyOnly( + errorListener, + errorListener(argThat(isUnimplementedError), argThat(isNotNull)), + ); + expect(errors, [isStateError]); + + container.read(dep.notifier).state++; + await container.pump(); + + verifyNoMoreInteractions(errorListener); + verifyOnly(listener, listener(null, 1)); + }); + + test( + 'correctly listens to the provider if normal onError listener throws', + () async { + final dep = StateProvider((ref) => 0); + final provider = Provider((ref) { + if (ref.watch(dep) == 0) { + throw UnimplementedError(); + } + return ref.watch(dep); + }); + final listener = Listener(); + final errorListener = ErrorListener(); + var isFirstCall = true; + + final container = ProviderContainer.test(); + final errors = []; + + final sub = runZonedGuarded( + () => container.listen( + provider, + listener.call, + onError: (err, stack) { + errorListener(err, stack); + if (isFirstCall) { + isFirstCall = false; + throw StateError('Some error'); + } + }, + fireImmediately: true, + ), + (err, stack) => errors.add(err), + ); + + container.listen(provider, (prev, value) {}); + + expect(sub, isNotNull); + verifyZeroInteractions(listener); + verifyOnly( + errorListener, + errorListener(argThat(isUnimplementedError), argThat(isNotNull)), + ); + expect(errors, [isStateError]); + + container.read(dep.notifier).state++; + await container.pump(); + + verifyNoMoreInteractions(errorListener); + verifyOnly(listener, listener(null, 1)); + }); + + test('correctly listens to the provider if selector listener throws', + () { + final provider = StateProvider((ref) => 0); + final listener = Listener(); + var isFirstCall = true; + + final container = ProviderContainer.test(); + final errors = []; + + final sub = runZonedGuarded( + () => container.listen( + provider.select((value) => value), + (prev, value) { + listener(prev, value); + if (isFirstCall) { + isFirstCall = false; + throw StateError('Some error'); + } + }, + fireImmediately: true, + ), + (err, stack) => errors.add(err), + ); + + expect(sub, isNotNull); + verifyOnly(listener, listener(null, 0)); + expect(errors, [isStateError]); + + container.read(provider.notifier).state++; + + verifyOnly(listener, listener(0, 1)); + }); + + test('correctly listens to the provider if normal listener throws', () { + final provider = StateProvider((ref) => 0); + final listener = Listener(); + var isFirstCall = true; + + final container = ProviderContainer.test(); + final errors = []; + + final sub = runZonedGuarded( + () => container.listen( + provider, + (prev, value) { + listener(prev, value); + if (isFirstCall) { + isFirstCall = false; + throw StateError('Some error'); + } + }, + fireImmediately: true, + ), + (err, stack) => errors.add(err), + ); + + expect(sub, isNotNull); + verifyOnly(listener, listener(null, 0)); + expect(errors, [isStateError]); + + container.read(provider.notifier).state++; + + verifyOnly(listener, listener(0, 1)); + }); + + test('correctly listens to the provider if normal listener throws', () { + final provider = StateProvider((ref) => 0); + final listener = Listener(); + var isFirstCall = true; + + final container = ProviderContainer.test(); + final errors = []; + + final sub = runZonedGuarded( + () => container.listen( + provider, + (prev, notifier) { + listener(prev, notifier); + if (isFirstCall) { + isFirstCall = false; + throw StateError('Some error'); + } + }, + fireImmediately: true, + ), + (err, stack) => errors.add(err), + ); + + expect(sub, isNotNull); + verifyOnly(listener, listener(null, 0)); + expect(errors, [isStateError]); + + container.read(provider.notifier).state++; + + verifyOnly(listener, listener(0, 1)); + }); + }); + + test('.read on closed subscription throws', () { + final provider = StateProvider((_) => 0); + final container = ProviderContainer.test(); + final listener = Listener(); + + final sub = + container.listen(provider, listener.call, fireImmediately: true); + + verify(listener(null, 0)).called(1); + verifyNoMoreInteractions(listener); + + sub.close(); + container.read(provider.notifier).state++; + + expect(sub.read, throwsStateError); + + verifyNoMoreInteractions(listener); + }); + + test('.read on closed selector subscription throws', () { + final provider = StateProvider((_) => 0); + final container = ProviderContainer.test(); + final listener = Listener(); + + final sub = container.listen( + provider.select((value) => value * 2), + listener.call, + fireImmediately: true, + ); + + verify(listener(null, 0)).called(1); + verifyNoMoreInteractions(listener); + + sub.close(); + container.read(provider.notifier).state++; + + expect(sub.read, throwsStateError); + verifyNoMoreInteractions(listener); + }); + + test("doesn't trow when creating a provider that failed", () { + final container = ProviderContainer.test(); + final provider = Provider((ref) { + throw Error(); + }); + + final sub = container.listen(provider, (_, __) {}); + + expect(sub, isA>()); + }); + + test('selectors can close listeners', () { + final container = ProviderContainer.test(); + final provider = StateProvider((ref) => 0); + + expect(container.readProviderElement(provider).hasListeners, false); + + final sub = container.listen( + provider.select((count) => count.isEven), + (prev, isEven) {}, + ); + + expect(container.readProviderElement(provider).hasListeners, true); + + sub.close(); + + expect(container.readProviderElement(provider).hasListeners, false); + }); + + test('can watch selectors', () async { + final container = ProviderContainer.test(); + final provider = StateProvider((ref) => 0); + final isAdultSelector = Selector(false, (c) => c >= 18); + final isAdultListener = Listener(); + + final controller = container.read(provider.notifier); + container.listen( + provider.select(isAdultSelector.call), + isAdultListener.call, + fireImmediately: true, + ); + + verifyOnly(isAdultSelector, isAdultSelector(0)); + verifyOnly(isAdultListener, isAdultListener(null, false)); + + controller.state += 10; + + verifyOnly(isAdultSelector, isAdultSelector(10)); + verifyNoMoreInteractions(isAdultListener); + + controller.state += 10; + + verifyOnly(isAdultSelector, isAdultSelector(20)); + verifyOnly(isAdultListener, isAdultListener(false, true)); + + controller.state += 10; + + verifyOnly(isAdultSelector, isAdultSelector(30)); + verifyNoMoreInteractions(isAdultListener); + }); + + test('calls immediately the listener with the current value', () { + final provider = Provider((ref) => 0); + final listener = Listener(); + + final container = ProviderContainer.test(); + + container.listen(provider, listener.call, fireImmediately: true); + + verifyOnly(listener, listener(null, 0)); + }); + + test('call listener when provider rebuilds', () async { + final controller = StreamController(); + addTearDown(controller.close); + final container = ProviderContainer.test(); + + final count = StateProvider((ref) => 0); + final provider = Provider((ref) => ref.watch(count)); + + container.listen( + provider, + (prev, value) => controller.add(value), + fireImmediately: true, + ); + + container.read(count.notifier).state++; + + await expectLater( + controller.stream, + emitsInOrder([0, 1]), + ); + }); + + test('call listener when provider emits an update', () async { + final container = ProviderContainer.test(); + + final count = StateProvider((ref) => 0); + final listener = Listener(); + + container.listen(count, listener.call); + + container.read(count.notifier).state++; + + verifyOnly(listener, listener(0, 1)); + + container.read(count.notifier).state++; + + verifyOnly(listener, listener(1, 2)); + }); + + test('supports selectors', () { + final container = ProviderContainer.test(); + + final count = StateProvider((ref) => 0); + final listener = Listener(); + + container.listen( + count.select((value) => value.isEven), + listener.call, + fireImmediately: true, + ); + + verifyOnly(listener, listener(null, true)); + + container.read(count.notifier).state = 2; + + verifyNoMoreInteractions(listener); + + container.read(count.notifier).state = 3; + + verifyOnly(listener, listener(true, false)); + }); + test('can downcast the listener value', () { final container = ProviderContainer.test(); final provider = StateProvider((ref) => 0); diff --git a/packages/riverpod/test/new/core/provider_test.dart b/packages/riverpod/test/new/core/provider_test.dart new file mode 100644 index 000000000..45e6d4085 --- /dev/null +++ b/packages/riverpod/test/new/core/provider_test.dart @@ -0,0 +1,15 @@ +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +void main() { + group('ProviderBase', () { + test('allTransitiveDependencies', () { + final a = Provider((ref) => 0); + final b = Provider.family((ref, _) => 0, dependencies: [a]); + final c = Provider((ref) => 0, dependencies: [b]); + final d = Provider((ref) => 0, dependencies: [c]); + + expect(d.allTransitiveDependencies, containsAll([a, b, c])); + }); + }); +} diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart index 8ef608a8a..eb90d94b2 100644 --- a/packages/riverpod/test/new/core/ref_test.dart +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -1,6 +1,11 @@ -import 'package:riverpod/riverpod.dart'; +import 'dart:async'; + +import 'package:mockito/mockito.dart'; +import 'package:riverpod/riverpod.dart' hide ErrorListener; import 'package:test/test.dart'; +import '../utils.dart'; + // TODO automatically generate this list for maintainability final refMethodsThatDependOnProviders = )>{ @@ -190,5 +195,948 @@ void main() { }); } }); + + group('Ref.listenSelf', () { + test('does not break autoDispose', () async { + final container = ProviderContainer.test(); + final provider = Provider.autoDispose((ref) { + ref.listenSelf((previous, next) {}); + }); + + container.read(provider); + expect(container.getAllProviderElements(), [anything]); + + await container.pump(); + + expect(container.getAllProviderElements(), isEmpty); + }); + + test('listens to mutations post build', () async { + final container = ProviderContainer.test(); + final listener = Listener(); + final listener2 = Listener(); + + late ProviderRef ref; + final provider = Provider((r) { + ref = r; + ref.listenSelf(listener.call); + ref.listenSelf(listener2.call); + + return 0; + }); + + container.read(provider); + + verifyInOrder([ + listener(null, 0), + listener2(null, 0), + ]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + ref.state = 42; + + verifyInOrder([ + listener(0, 42), + listener2(0, 42), + ]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('listens to rebuild', () async { + final container = ProviderContainer.test(); + final listener = Listener(); + final listener2 = Listener(); + var result = 0; + final provider = Provider((ref) { + ref.listenSelf(listener.call); + ref.listenSelf(listener2.call); + + return result; + }); + + container.read(provider); + + verifyInOrder([ + listener(null, 0), + listener2(null, 0), + ]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + result = 42; + container.refresh(provider); + + verifyInOrder([ + listener(0, 42), + listener2(0, 42), + ]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('notify listeners independently from updateShouldNotify', () async { + final container = ProviderContainer.test(); + final listener = Listener(); + final listener2 = Listener(); + final provider = Provider((ref) { + ref.listenSelf(listener.call); + ref.listenSelf(listener2.call); + + return 0; + }); + + container.read(provider); + + verifyInOrder([ + listener(null, 0), + listener2(null, 0), + ]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + container.refresh(provider); + + verifyInOrder([ + listener(0, 0), + listener2(0, 0), + ]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('clears state listeners on rebuild', () async { + final container = ProviderContainer.test(); + final listener = Listener(); + final listener2 = Listener(); + var result = 0; + final provider = Provider((ref) { + if (result == 0) { + ref.listenSelf(listener.call); + } else { + ref.listenSelf(listener2.call); + } + + return result; + }); + + container.read(provider); + + verifyOnly(listener, listener(null, 0)); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + result = 42; + container.refresh(provider); + + verifyOnly(listener2, listener2(0, 42)); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('listens to errors', () { + final container = ProviderContainer.test(); + final listener = Listener(); + final errorListener = ErrorListener(); + final errorListener2 = ErrorListener(); + var error = 42; + final provider = Provider((ref) { + ref.listenSelf(listener.call, onError: errorListener.call); + ref.listenSelf((prev, next) {}, onError: errorListener2.call); + + Error.throwWithStackTrace(error, StackTrace.empty); + }); + + expect(() => container.read(provider), throwsA(42)); + + verifyZeroInteractions(listener); + verifyInOrder([ + errorListener(42, StackTrace.empty), + errorListener2(42, StackTrace.empty), + ]); + verifyNoMoreInteractions(errorListener); + verifyNoMoreInteractions(errorListener2); + + error = 21; + expect(() => container.refresh(provider), throwsA(21)); + + verifyZeroInteractions(listener); + + verifyInOrder([ + errorListener(21, StackTrace.empty), + errorListener2(21, StackTrace.empty), + ]); + verifyNoMoreInteractions(errorListener); + verifyNoMoreInteractions(errorListener2); + }); + + test('executes error listener before other listeners', () { + final container = ProviderContainer.test(); + final errorListener = ErrorListener(); + final errorListener2 = ErrorListener(); + Exception? error; + final provider = Provider((ref) { + ref.listenSelf((prev, next) {}, onError: errorListener.call); + + if (error != null) Error.throwWithStackTrace(error, StackTrace.empty); + + return 0; + }); + + container.listen(provider, (prev, next) {}, + onError: errorListener2.call); + + verifyZeroInteractions(errorListener); + verifyZeroInteractions(errorListener2); + + error = Exception(); + expect(() => container.refresh(provider), throwsA(error)); + + verifyInOrder([ + errorListener(error, StackTrace.empty), + errorListener2(error, StackTrace.empty), + ]); + verifyNoMoreInteractions(errorListener); + verifyNoMoreInteractions(errorListener2); + }); + + test('executes state listener before other listeners', () { + final container = ProviderContainer.test(); + final listener = Listener(); + final listener2 = Listener(); + var result = 0; + final provider = Provider((ref) { + ref.listenSelf(listener.call); + return result; + }); + + container.listen(provider, listener2.call, fireImmediately: true); + + verifyInOrder([ + listener(null, 0), + listener2(null, 0), + ]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + result = 42; + container.refresh(provider); + + verifyInOrder([ + listener(0, 42), + listener2(0, 42), + ]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('listeners are not allowed to modify the state', () {}); + }); + + group('Ref.listen', () { + test( + 'when rebuild throws identical error/stack, listeners are still notified', + () { + final container = ProviderContainer.test(); + const stack = StackTrace.empty; + final listener = Listener(); + final errorListener = ErrorListener(); + final provider = Provider((ref) { + Error.throwWithStackTrace(42, stack); + }); + + container.listen( + provider, + listener.call, + onError: errorListener.call, + fireImmediately: true, + ); + + verifyZeroInteractions(listener); + verifyOnly(errorListener, errorListener(42, stack)); + + expect(() => container.refresh(provider), throwsA(42)); + + verifyZeroInteractions(listener); + verifyOnly(errorListener, errorListener(42, stack)); + }); + + test('cannot listen itself', () { + final container = ProviderContainer.test(); + final listener = Listener(); + late ProviderRef ref; + late Provider provider; + provider = Provider((r) { + ref = r; + ref.listen(provider, (previous, next) {}); + return 0; + }); + + expect(() => container.read(provider), throwsA(isAssertionError)); + + ref.state = 42; + + verifyZeroInteractions(listener); + }); + + test('expose previous and new value on change', () { + final container = ProviderContainer.test(); + final dep = StateNotifierProvider, int>( + (ref) => StateController(0), + ); + final listener = Listener(); + final provider = Provider((ref) { + ref.listen(dep, listener.call, fireImmediately: true); + }); + + container.read(provider); + + verifyOnly(listener, listener(null, 0)); + + container.read(dep.notifier).state++; + + verifyOnly(listener, listener(0, 1)); + }); + + test( + 'calling ref.listen on a provider with an outdated dependency flushes it, then add the listener', + () { + final container = ProviderContainer.test(); + var buildCount = 0; + final dep2 = StateNotifierProvider, int>( + (ref) => StateController(0), + ); + final dep = Provider((ref) { + buildCount++; + return ref.watch(dep2); + }); + final listener = Listener(); + final provider = Provider((ref) { + ref.listen(dep, listener.call); + }); + + container.read(dep); + container.read(dep2.notifier).state++; // mark `dep` as outdated + + expect(buildCount, 1); + verifyZeroInteractions(listener); + + container.read(provider); + + expect(buildCount, 2); + verifyZeroInteractions(listener); + }); + + test( + 'when using selectors, `previous` is the latest notification instead of latest event', + () { + final container = ProviderContainer.test(); + final dep = StateNotifierProvider, int>( + (ref) => StateController(0), + ); + final listener = Listener(); + final provider = Provider((ref) { + ref.listen( + dep.select((value) => value.isEven), + listener.call, + fireImmediately: true, + ); + }); + + container.read(provider); + verifyOnly(listener, listener(null, true)); + + container.read(dep.notifier).state += 2; + + verifyNoMoreInteractions(listener); + + container.read(dep.notifier).state++; + + verifyOnly(listener, listener(true, false)); + }); + + test('when no onError is specified, fallbacks to handleUncaughtError', + () async { + final container = ProviderContainer.test(); + final isErrored = StateProvider((ref) => false); + final dep = Provider((ref) { + if (ref.watch(isErrored)) throw UnimplementedError(); + return 0; + }); + final listener = Listener(); + final errors = []; + final provider = Provider((ref) { + runZonedGuarded( + () => ref.listen(dep, listener.call), + (err, stack) => errors.add(err), + ); + }); + + container.read(provider); + + verifyZeroInteractions(listener); + expect(errors, isEmpty); + + container.read(isErrored.notifier).state = true; + + await container.pump(); + + verifyZeroInteractions(listener); + expect(errors, [isUnimplementedError]); + }); + + test( + 'when no onError is specified, selectors fallbacks to handleUncaughtError', + () async { + final container = ProviderContainer.test(); + final isErrored = StateProvider((ref) => false); + final dep = Provider((ref) { + if (ref.watch(isErrored)) throw UnimplementedError(); + return 0; + }); + final listener = Listener(); + final errors = []; + final provider = Provider((ref) { + runZonedGuarded( + () => ref.listen(dep.select((value) => value), listener.call), + (err, stack) => errors.add(err), + ); + }); + + container.read(provider); + + verifyZeroInteractions(listener); + expect(errors, isEmpty); + + container.read(isErrored.notifier).state = true; + + await container.pump(); + + verifyZeroInteractions(listener); + expect(errors, [isUnimplementedError]); + }); + + test('when rebuild throws, calls onError', () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final provider = Provider((ref) { + if (ref.watch(dep) != 0) { + throw UnimplementedError(); + } + return 0; + }); + final errorListener = ErrorListener(); + final listener = Listener(); + + final a = Provider((ref) { + ref.listen(provider, listener.call, onError: errorListener.call); + }); + + container.read(a); + + verifyZeroInteractions(errorListener); + verifyZeroInteractions(listener); + + container.read(dep.notifier).state++; + await container.pump(); + + verifyZeroInteractions(listener); + verifyOnly( + errorListener, + errorListener(isUnimplementedError, any), + ); + }); + + test('when rebuild throws on selector, calls onError', () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final provider = Provider((ref) { + if (ref.watch(dep) != 0) { + throw UnimplementedError(); + } + return 0; + }); + final errorListener = ErrorListener(); + final listener = Listener(); + + final a = Provider((ref) { + ref.listen( + provider.select((value) => value), + listener.call, + onError: errorListener.call, + ); + }); + + container.read(a); + + verifyZeroInteractions(errorListener); + verifyZeroInteractions(listener); + + container.read(dep.notifier).state++; + await container.pump(); + + verifyZeroInteractions(listener); + verifyOnly( + errorListener, + errorListener(isUnimplementedError, any), + ); + }); + + group('fireImmediately', () { + test('when no onError is specified, fallbacks to handleUncaughtError', + () { + final container = ProviderContainer.test(); + final dep = Provider((ref) => throw UnimplementedError()); + final listener = Listener(); + final errors = []; + final provider = Provider((ref) { + runZonedGuarded( + () { + ref.listen( + dep, + listener.call, + fireImmediately: true, + ); + }, + (err, stack) => errors.add(err), + ); + }); + + container.read(provider); + + verifyZeroInteractions(listener); + expect(errors, [ + isUnimplementedError, + ]); + }); + + test( + 'when no onError is specified on selectors, fallbacks to handleUncaughtError', + () { + final container = ProviderContainer.test(); + final dep = Provider((ref) => throw UnimplementedError()); + final listener = Listener(); + final errors = []; + final provider = Provider((ref) { + runZonedGuarded( + () { + ref.listen( + dep.select((value) => value), + listener.call, + fireImmediately: true, + ); + }, + (err, stack) => errors.add(err), + ); + }); + + container.read(provider); + + verifyZeroInteractions(listener); + expect(errors, [ + isUnimplementedError, + ]); + }); + + test('on provider that threw, fireImmediately calls onError', () { + final container = ProviderContainer.test(); + final dep = Provider((ref) => throw UnimplementedError()); + final listener = Listener(); + final errorListener = ErrorListener(); + final provider = Provider((ref) { + ref.listen( + dep, + listener.call, + onError: errorListener.call, + fireImmediately: true, + ); + }); + + container.read(provider); + + verifyZeroInteractions(listener); + verifyOnly( + errorListener, + errorListener(isUnimplementedError, argThat(isNotNull)), + ); + }); + + test( + 'when selecting provider that threw, fireImmediately calls onError', + () { + final container = ProviderContainer.test(); + final dep = Provider((ref) => throw UnimplementedError()); + final listener = Listener(); + final errorListener = ErrorListener(); + final provider = Provider((ref) { + ref.listen( + dep.select((value) => 0), + listener.call, + onError: errorListener.call, + fireImmediately: true, + ); + }); + + container.read(provider); + + verifyZeroInteractions(listener); + verifyOnly( + errorListener, + errorListener(isUnimplementedError, argThat(isNotNull)), + ); + }); + + test('correctly listens to the provider if selector listener throws', + () { + final dep = StateProvider((ref) => 0); + final listener = Listener(); + var isFirstCall = true; + + final container = ProviderContainer.test(); + final errors = []; + + ProviderSubscription? sub; + + final provider = Provider((ref) { + sub = runZonedGuarded( + () => ref.listen( + dep.select((value) => value), + (prev, value) { + listener(prev, value); + if (isFirstCall) { + isFirstCall = false; + throw StateError('Some error'); + } + }, + fireImmediately: true, + ), + (err, stack) => errors.add(err), + ); + }); + + container.listen(provider, (prev, value) {}); + + expect(sub, isNotNull); + verifyOnly(listener, listener(null, 0)); + expect(errors, [isStateError]); + + container.read(dep.notifier).state++; + verifyOnly(listener, listener(0, 1)); + }); + + test('correctly listens to the provider if normal listener throws', () { + final dep = StateProvider((ref) => 0); + final listener = Listener(); + var isFirstCall = true; + + final container = ProviderContainer.test(); + final errors = []; + + ProviderSubscription? sub; + + final provider = Provider((ref) { + sub = runZonedGuarded( + () => ref.listen( + dep, + (prev, value) { + listener(prev, value); + if (isFirstCall) { + isFirstCall = false; + throw StateError('Some error'); + } + }, + fireImmediately: true, + ), + (err, stack) => errors.add(err), + ); + }); + + container.listen(provider, (prev, value) {}); + + expect(sub, isNotNull); + verifyOnly(listener, listener(null, 0)); + expect(errors, [isStateError]); + + container.read(dep.notifier).state++; + verifyOnly(listener, listener(0, 1)); + }); + + test( + 'correctly listens to the provider if selector onError listener throws', + () async { + final dep = StateProvider((ref) => 0); + final dep2 = Provider((ref) { + if (ref.watch(dep) == 0) { + throw UnimplementedError(); + } + return ref.watch(dep); + }); + final listener = Listener(); + final errorListener = ErrorListener(); + var isFirstCall = true; + + final container = ProviderContainer.test(); + final errors = []; + + ProviderSubscription? sub; + + final provider = Provider((ref) { + sub = runZonedGuarded( + () => ref.listen( + dep2.select((value) => value), + listener.call, + onError: (err, stack) { + errorListener(err, stack); + if (isFirstCall) { + isFirstCall = false; + throw StateError('Some error'); + } + }, + fireImmediately: true, + ), + (err, stack) => errors.add(err), + ); + }); + + container.read(provider); + + expect(sub, isNotNull); + verifyZeroInteractions(listener); + verifyOnly( + errorListener, + errorListener(argThat(isUnimplementedError), argThat(isNotNull)), + ); + expect(errors, [isStateError]); + + container.read(dep.notifier).state++; + await container.pump(); + + verifyNoMoreInteractions(errorListener); + verifyOnly(listener, listener(null, 1)); + }); + + test( + 'correctly listens to the provider if normal onError listener throws', + () async { + final dep = StateProvider((ref) => 0); + final dep2 = Provider((ref) { + if (ref.watch(dep) == 0) { + throw UnimplementedError(); + } + return ref.watch(dep); + }); + final listener = Listener(); + final errorListener = ErrorListener(); + var isFirstCall = true; + + final container = ProviderContainer.test(); + final errors = []; + + ProviderSubscription? sub; + + final provider = Provider((ref) { + sub = runZonedGuarded( + () => ref.listen( + dep2, + listener.call, + onError: (err, stack) { + errorListener(err, stack); + if (isFirstCall) { + isFirstCall = false; + throw StateError('Some error'); + } + }, + fireImmediately: true, + ), + (err, stack) => errors.add(err), + ); + }); + + container.read(provider); + + expect(sub, isNotNull); + verifyZeroInteractions(listener); + verifyOnly( + errorListener, + errorListener(argThat(isUnimplementedError), argThat(isNotNull)), + ); + expect(errors, [isStateError]); + + container.read(dep.notifier).state++; + await container.pump(); + + verifyNoMoreInteractions(errorListener); + verifyOnly(listener, listener(null, 1)); + }); + }); + }); + + group('ref.keepAlive', () { + test( + 'Does not cause an infinite loop if aborted directly in the callback', + () async { + final container = ProviderContainer.test(); + var buildCount = 0; + var disposeCount = 0; + final provider = Provider.autoDispose((ref) { + buildCount++; + ref.onDispose(() => disposeCount++); + final link = ref.keepAlive(); + link.close(); + return 'value'; + }); + + container.read(provider); + + expect(buildCount, 1); + expect(disposeCount, 0); + expect( + container.getAllProviderElements().map((e) => e.provider), + [provider], + ); + + await container.pump(); + + expect(buildCount, 1); + expect(disposeCount, 1); + expect( + container.getAllProviderElements().map((e) => e.provider), + isEmpty, + ); + }); + + test('when the provider rebuilds, links are cleared', () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + KeepAliveLink? a; + + final provider = Provider.autoDispose((ref) { + ref.watch(dep); + a ??= ref.keepAlive(); + }); + + container.read(provider); + await container.pump(); + + expect( + container.getAllProviderElements().map((e) => e.provider), + contains(provider), + ); + + container.read(dep.notifier).state++; + // manually trigger rebuild, as the provider is not listened + container.read(provider); + await container.pump(); + + expect( + container.getAllProviderElements().map((e) => e.provider), + isNot(contains(provider)), + ); + }); + + test('maintains the state of the provider until all links are closed', + () async { + final container = ProviderContainer.test(); + late KeepAliveLink a; + late KeepAliveLink b; + + final provider = Provider.autoDispose((ref) { + a = ref.keepAlive(); + b = ref.keepAlive(); + }); + + container.read(provider); + + expect( + container.getAllProviderElements().map((e) => e.provider), + [provider], + ); + + await container.pump(); + + expect( + container.getAllProviderElements().map((e) => e.provider), + [provider], + ); + + a.close(); + await container.pump(); + + expect( + container.getAllProviderElements().map((e) => e.provider), + [provider], + ); + + b.close(); + await container.pump(); + + expect( + container.getAllProviderElements(), + isEmpty, + ); + }); + + test( + 'when closing KeepAliveLink, does not dispose the provider if it is still being listened to', + () async { + final container = ProviderContainer.test(); + late KeepAliveLink a; + + final provider = Provider.autoDispose((ref) { + a = ref.keepAlive(); + }); + + final sub = container.listen(provider, (previous, next) {}); + + a.close(); + await container.pump(); + + expect( + container.getAllProviderElements().map((e) => e.provider), + [provider], + ); + + sub.close(); + await container.pump(); + + expect( + container.getAllProviderElements().map((e) => e.provider), + isEmpty, + ); + }); + + test( + 'when closing the last KeepAliveLink, then immediately adding a new link, ' + 'the provider will not be disposed.', () async { + final container = ProviderContainer.test(); + late KeepAliveLink a; + late AutoDisposeRef ref; + + final provider = Provider.autoDispose((r) { + ref = r; + a = ref.keepAlive(); + }); + + container.read(provider); + + a.close(); + final b = ref.keepAlive(); + await container.pump(); + + expect( + container.getAllProviderElements().map((e) => e.provider), + [provider], + ); + + b.close(); + await container.pump(); + + expect( + container.getAllProviderElements().map((e) => e.provider), + isEmpty, + ); + }); + }); }); } diff --git a/packages/riverpod/test/old/framework/scope_test.dart b/packages/riverpod/test/new/core/scope_test.dart similarity index 86% rename from packages/riverpod/test/old/framework/scope_test.dart rename to packages/riverpod/test/new/core/scope_test.dart index 1d11046fa..2b8e7618c 100644 --- a/packages/riverpod/test/old/framework/scope_test.dart +++ b/packages/riverpod/test/new/core/scope_test.dart @@ -4,19 +4,9 @@ import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; -import '../../new/core/provider_container_test.dart'; +import 'provider_container_test.dart'; Future main() async { - test( - 'transitive dependencies includes the transitive dependencies of families', - () { - final a = Provider((ref) => 0); - final b = Provider.family((ref, _) => 0, dependencies: [a]); - final c = Provider((ref) => 0, dependencies: [b]); - - expect(c.allTransitiveDependencies, containsAll([a, b])); - }); - test( 'reading a provider from a scoped container, ' 'then adding a new container with an override, ' @@ -829,4 +819,121 @@ Future main() async { expect(container.read(a), 42); expect(container.read(b(10)), 52); }); + + test('scoped autoDispose override preserve the override after one disposal', + () async { + final provider = Provider.autoDispose( + (ref) => 0, + dependencies: const [], + ); + + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); + + container.read(provider); + expect(root.getAllProviderElements(), isEmpty); + expect(container.getAllProviderElements(), isNotEmpty); + + await container.pump(); + + expect(root.getAllProviderElements(), isEmpty); + expect(container.getAllProviderElements(), isEmpty); + + container.read(provider); + + expect(root.getAllProviderElements(), isEmpty); + expect(container.getAllProviderElements(), isNotEmpty); + }); + + test( + 'scoped autoDispose override through intermediary unused container preserve the override after one disposal', + () async { + final provider = Provider.autoDispose( + (ref) => 0, + dependencies: const [], + ); + + final root = ProviderContainer.test(); + final mid = ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test(parent: mid); + + container.read(provider); + expect(root.getAllProviderElements(), isEmpty); + expect(mid.getAllProviderElements(), isNotEmpty); + expect(container.getAllProviderElements(), isEmpty); + + await container.pump(); + + expect(root.getAllProviderElements(), isEmpty); + expect(mid.getAllProviderElements(), isEmpty); + expect(container.getAllProviderElements(), isEmpty); + + container.read(provider); + + expect(root.getAllProviderElements(), isEmpty); + expect(mid.getAllProviderElements(), isNotEmpty); + expect(container.getAllProviderElements(), isEmpty); + }); + + test( + 'scoped autoDispose override preserve family override after one disposal', + () async { + final provider = Provider.autoDispose.family( + (ref, _) => 0, + dependencies: const [], + ); + + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [provider], + ); + + container.read(provider(0)); + expect(root.getAllProviderElements(), isEmpty); + expect(container.getAllProviderElements(), isNotEmpty); + + await container.pump(); + + expect(root.getAllProviderElements(), isEmpty); + expect(container.getAllProviderElements(), isEmpty); + + container.read(provider(0)); + + expect(root.getAllProviderElements(), isEmpty); + expect(container.getAllProviderElements(), isNotEmpty); + }); + + test( + 'scoped autoDispose override through intermediary unused container preserve family override after one disposal', + () async { + final provider = Provider.autoDispose.family( + (ref, _) => 0, + dependencies: const [], + ); + + final root = ProviderContainer.test(); + final mid = ProviderContainer.test(parent: root, overrides: [provider]); + final container = ProviderContainer.test(parent: mid); + + container.read(provider(0)); + expect(root.getAllProviderElements(), isEmpty); + expect(mid.getAllProviderElements(), isNotEmpty); + expect(container.getAllProviderElements(), isEmpty); + + await container.pump(); + + expect(root.getAllProviderElements(), isEmpty); + expect(mid.getAllProviderElements(), isEmpty); + expect(container.getAllProviderElements(), isEmpty); + + container.read(provider(0)); + + expect(root.getAllProviderElements(), isEmpty); + expect(mid.getAllProviderElements(), isNotEmpty); + expect(container.getAllProviderElements(), isEmpty); + }); } diff --git a/packages/riverpod/test/new/utils.dart b/packages/riverpod/test/new/utils.dart index caa067cd3..18c51f051 100644 --- a/packages/riverpod/test/new/utils.dart +++ b/packages/riverpod/test/new/utils.dart @@ -32,3 +32,27 @@ class Listener extends Mock { } final isAssertionError = isA(); + +class ErrorListener extends Mock { + void call(Object? error, StackTrace? stackTrace); +} + +class Selector extends Mock { + Selector(this.fake, Output Function(Input) selector) { + when(call(any)).thenAnswer((i) { + return selector( + i.positionalArguments.first as Input, + ); + }); + } + + final Output fake; + + Output call(Input? value) { + return super.noSuchMethod( + Invocation.method(#call, [value]), + returnValue: fake, + returnValueForMissingStub: fake, + ) as Output; + } +} diff --git a/packages/riverpod/test/old/framework/auto_dispose_test.dart b/packages/riverpod/test/old/framework/auto_dispose_test.dart index 067f49d4a..3e3e39a5d 100644 --- a/packages/riverpod/test/old/framework/auto_dispose_test.dart +++ b/packages/riverpod/test/old/framework/auto_dispose_test.dart @@ -5,203 +5,6 @@ import 'package:test/test.dart'; import '../utils.dart'; Future main() async { - test( - 'Handles cases where the ProviderContainer is disposed yet Scheduler.performDispose is invoked anyway', - () async { - // regression test for https://github.com/rrousselGit/riverpod/issues/1400 - final provider = Provider.autoDispose( - (ref) => 0, - dependencies: const [], - ); - final root = ProviderContainer.test(); - final container = ProviderContainer.test( - parent: root, - overrides: [provider], - ); - - container.read(provider); - container.dispose(); - - await root.pump(); - }); - - group('ref.keepAlive', () { - test('Does not cause an infinite loop if aborted directly in the callback', - () async { - final container = ProviderContainer.test(); - var buildCount = 0; - var disposeCount = 0; - final provider = Provider.autoDispose((ref) { - buildCount++; - ref.onDispose(() => disposeCount++); - final link = ref.keepAlive(); - link.close(); - return 'value'; - }); - - container.read(provider); - - expect(buildCount, 1); - expect(disposeCount, 0); - expect( - container.getAllProviderElements().map((e) => e.provider), - [provider], - ); - - await container.pump(); - - expect(buildCount, 1); - expect(disposeCount, 1); - expect( - container.getAllProviderElements().map((e) => e.provider), - isEmpty, - ); - }); - - test('when the provider rebuilds, links are cleared', () async { - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - KeepAliveLink? a; - - final provider = Provider.autoDispose((ref) { - ref.watch(dep); - a ??= ref.keepAlive(); - }); - - container.read(provider); - await container.pump(); - - expect( - container.getAllProviderElements().map((e) => e.provider), - contains(provider), - ); - - container.read(dep.notifier).state++; - // manually trigger rebuild, as the provider is not listened - container.read(provider); - await container.pump(); - - expect( - container.getAllProviderElements().map((e) => e.provider), - isNot(contains(provider)), - ); - }); - - test('maintains the state of the provider until all links are closed', - () async { - final container = ProviderContainer.test(); - late KeepAliveLink a; - late KeepAliveLink b; - - final provider = Provider.autoDispose((ref) { - a = ref.keepAlive(); - b = ref.keepAlive(); - }); - - container.read(provider); - - expect( - container.getAllProviderElements().map((e) => e.provider), - [provider], - ); - - await container.pump(); - - expect( - container.getAllProviderElements().map((e) => e.provider), - [provider], - ); - - a.close(); - await container.pump(); - - expect( - container.getAllProviderElements().map((e) => e.provider), - [provider], - ); - - b.close(); - await container.pump(); - - expect( - container.getAllProviderElements(), - isEmpty, - ); - }); - - test( - 'when closing KeepAliveLink, does not dispose the provider if it is still being listened to', - () async { - final container = ProviderContainer.test(); - late KeepAliveLink a; - - final provider = Provider.autoDispose((ref) { - a = ref.keepAlive(); - }); - - final sub = container.listen(provider, (previous, next) {}); - - a.close(); - await container.pump(); - - expect( - container.getAllProviderElements().map((e) => e.provider), - [provider], - ); - - sub.close(); - await container.pump(); - - expect( - container.getAllProviderElements().map((e) => e.provider), - isEmpty, - ); - }); - - test( - 'when closing the last KeepAliveLink, then immediately adding a new link, ' - 'the provider will not be disposed.', () async { - final container = ProviderContainer.test(); - late KeepAliveLink a; - late AutoDisposeRef ref; - - final provider = Provider.autoDispose((r) { - ref = r; - a = ref.keepAlive(); - }); - - container.read(provider); - - a.close(); - final b = ref.keepAlive(); - await container.pump(); - - expect( - container.getAllProviderElements().map((e) => e.provider), - [provider], - ); - - b.close(); - await container.pump(); - - expect( - container.getAllProviderElements().map((e) => e.provider), - isEmpty, - ); - }); - }); - - test('Can ref.read autoDispose selectors inside non-autoDispose providers', - () { - final autoDispose = Provider.autoDispose((ref) => 0); - - Provider((ref) { - ref.read( - autoDispose.select((value) => value), - ); - }); - }); - test( 'when a provider conditionally depends on another provider, rebuilding without the dependency can dispose the dependency', () async { @@ -290,135 +93,6 @@ Future main() async { verifyOnly(listener, listener(null, 42)); }); - test('scoped autoDispose override preserve the override after one disposal', - () async { - final provider = Provider.autoDispose( - (ref) => 0, - dependencies: const [], - ); - - final root = ProviderContainer.test(); - final container = ProviderContainer.test( - parent: root, - overrides: [provider], - ); - - container.read(provider); - expect(root.getAllProviderElements(), isEmpty); - expect(container.getAllProviderElements(), isNotEmpty); - - await container.pump(); - - expect(root.getAllProviderElements(), isEmpty); - expect(container.getAllProviderElements(), isEmpty); - - container.read(provider); - - expect(root.getAllProviderElements(), isEmpty); - expect(container.getAllProviderElements(), isNotEmpty); - }); - - test( - 'scoped autoDispose override through intermediary unused container preserve the override after one disposal', - () async { - final provider = Provider.autoDispose( - (ref) => 0, - dependencies: const [], - ); - - final root = ProviderContainer.test(); - final mid = ProviderContainer.test(parent: root, overrides: [provider]); - final container = ProviderContainer.test(parent: mid); - - container.read(provider); - expect(root.getAllProviderElements(), isEmpty); - expect(mid.getAllProviderElements(), isNotEmpty); - expect(container.getAllProviderElements(), isEmpty); - - await container.pump(); - - expect(root.getAllProviderElements(), isEmpty); - expect(mid.getAllProviderElements(), isEmpty); - expect(container.getAllProviderElements(), isEmpty); - - container.read(provider); - - expect(root.getAllProviderElements(), isEmpty); - expect(mid.getAllProviderElements(), isNotEmpty); - expect(container.getAllProviderElements(), isEmpty); - }); - - test( - 'scoped autoDispose override preserve family override after one disposal', - () async { - final provider = Provider.autoDispose.family( - (ref, _) => 0, - dependencies: const [], - ); - - final root = ProviderContainer.test(); - final container = ProviderContainer.test( - parent: root, - overrides: [provider], - ); - - container.read(provider(0)); - expect(root.getAllProviderElements(), isEmpty); - expect(container.getAllProviderElements(), isNotEmpty); - - await container.pump(); - - expect(root.getAllProviderElements(), isEmpty); - expect(container.getAllProviderElements(), isEmpty); - - container.read(provider(0)); - - expect(root.getAllProviderElements(), isEmpty); - expect(container.getAllProviderElements(), isNotEmpty); - }); - - test( - 'scoped autoDispose override through intermediary unused container preserve family override after one disposal', - () async { - final provider = Provider.autoDispose.family( - (ref, _) => 0, - dependencies: const [], - ); - - final root = ProviderContainer.test(); - final mid = ProviderContainer.test(parent: root, overrides: [provider]); - final container = ProviderContainer.test(parent: mid); - - container.read(provider(0)); - expect(root.getAllProviderElements(), isEmpty); - expect(mid.getAllProviderElements(), isNotEmpty); - expect(container.getAllProviderElements(), isEmpty); - - await container.pump(); - - expect(root.getAllProviderElements(), isEmpty); - expect(mid.getAllProviderElements(), isEmpty); - expect(container.getAllProviderElements(), isEmpty); - - container.read(provider(0)); - - expect(root.getAllProviderElements(), isEmpty); - expect(mid.getAllProviderElements(), isNotEmpty); - expect(container.getAllProviderElements(), isEmpty); - }); - - test( - 'can select auto-dispose providers if the selecting provider is auto-dispose too', - () { - final container = ProviderContainer.test(); - final selected = Provider.autoDispose((ref) => 0); - final isEven = Provider.autoDispose((ref) { - return ref.watch(selected.select((c) => c.isEven)); - }); - - expect(container.read(isEven), true); - }); - test('unsub to A then make B sub to A then unsub to B disposes B before A', () async { final container = ProviderContainer.test(); @@ -536,7 +210,7 @@ Future main() async { verifyNoMoreInteractions(bDispose); }); - test('ProviderContainer was disposed before AutoDisposer handled the dispose', + test('ProviderContainer was disposed before Scheduler handled the dispose', () async { final container = ProviderContainer.test(); final onDispose = OnDisposeMock(); diff --git a/packages/riverpod/test/old/framework/family_test.dart b/packages/riverpod/test/old/framework/family_test.dart index 8d5a76f29..b1fc0826e 100644 --- a/packages/riverpod/test/old/framework/family_test.dart +++ b/packages/riverpod/test/old/framework/family_test.dart @@ -131,7 +131,7 @@ void main() { ); }); - test('family override', () { + test('Can override both the family as a provider of that family', () { final family = Provider.family((ref, a) => 'Hello $a'); final container = ProviderContainer.test( overrides: [ diff --git a/packages/riverpod/test/old/framework/listen_test.dart b/packages/riverpod/test/old/framework/listen_test.dart deleted file mode 100644 index b188626a7..000000000 --- a/packages/riverpod/test/old/framework/listen_test.dart +++ /dev/null @@ -1,1642 +0,0 @@ -import 'dart:async'; - -import 'package:mockito/mockito.dart'; -import 'package:riverpod/riverpod.dart' hide ErrorListener; -import 'package:test/expect.dart'; -import 'package:test/scaffolding.dart'; - -import '../utils.dart'; - -void main() { - group('Ref.listenSelf', () { - test('does not break autoDispose', () async { - final container = ProviderContainer.test(); - final provider = Provider.autoDispose((ref) { - ref.listenSelf((previous, next) {}); - }); - - container.read(provider); - expect(container.getAllProviderElements(), [anything]); - - await container.pump(); - - expect(container.getAllProviderElements(), isEmpty); - }); - - test('listens to mutations post build', () async { - final container = ProviderContainer.test(); - final listener = Listener(); - final listener2 = Listener(); - - late ProviderRef ref; - final provider = Provider((r) { - ref = r; - ref.listenSelf(listener.call); - ref.listenSelf(listener2.call); - - return 0; - }); - - container.read(provider); - - verifyInOrder([ - listener(null, 0), - listener2(null, 0), - ]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - ref.state = 42; - - verifyInOrder([ - listener(0, 42), - listener2(0, 42), - ]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('listens to rebuild', () async { - final container = ProviderContainer.test(); - final listener = Listener(); - final listener2 = Listener(); - var result = 0; - final provider = Provider((ref) { - ref.listenSelf(listener.call); - ref.listenSelf(listener2.call); - - return result; - }); - - container.read(provider); - - verifyInOrder([ - listener(null, 0), - listener2(null, 0), - ]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - result = 42; - container.refresh(provider); - - verifyInOrder([ - listener(0, 42), - listener2(0, 42), - ]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('notify listeners independently from updateShouldNotify', () async { - final container = ProviderContainer.test(); - final listener = Listener(); - final listener2 = Listener(); - final provider = Provider((ref) { - ref.listenSelf(listener.call); - ref.listenSelf(listener2.call); - - return 0; - }); - - container.read(provider); - - verifyInOrder([ - listener(null, 0), - listener2(null, 0), - ]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - container.refresh(provider); - - verifyInOrder([ - listener(0, 0), - listener2(0, 0), - ]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('clears state listeners on rebuild', () async { - final container = ProviderContainer.test(); - final listener = Listener(); - final listener2 = Listener(); - var result = 0; - final provider = Provider((ref) { - if (result == 0) { - ref.listenSelf(listener.call); - } else { - ref.listenSelf(listener2.call); - } - - return result; - }); - - container.read(provider); - - verifyOnly(listener, listener(null, 0)); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - result = 42; - container.refresh(provider); - - verifyOnly(listener2, listener2(0, 42)); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('listens to errors', () { - final container = ProviderContainer.test(); - final listener = Listener(); - final errorListener = ErrorListener(); - final errorListener2 = ErrorListener(); - var error = 42; - final provider = Provider((ref) { - ref.listenSelf(listener.call, onError: errorListener.call); - ref.listenSelf((prev, next) {}, onError: errorListener2.call); - - Error.throwWithStackTrace(error, StackTrace.empty); - }); - - expect(() => container.read(provider), throwsA(42)); - - verifyZeroInteractions(listener); - verifyInOrder([ - errorListener(42, StackTrace.empty), - errorListener2(42, StackTrace.empty), - ]); - verifyNoMoreInteractions(errorListener); - verifyNoMoreInteractions(errorListener2); - - error = 21; - expect(() => container.refresh(provider), throwsA(21)); - - verifyZeroInteractions(listener); - - verifyInOrder([ - errorListener(21, StackTrace.empty), - errorListener2(21, StackTrace.empty), - ]); - verifyNoMoreInteractions(errorListener); - verifyNoMoreInteractions(errorListener2); - }); - - test('executes error listener before other listeners', () { - final container = ProviderContainer.test(); - final errorListener = ErrorListener(); - final errorListener2 = ErrorListener(); - Exception? error; - final provider = Provider((ref) { - ref.listenSelf((prev, next) {}, onError: errorListener.call); - - if (error != null) Error.throwWithStackTrace(error, StackTrace.empty); - - return 0; - }); - - container.listen(provider, (prev, next) {}, onError: errorListener2.call); - - verifyZeroInteractions(errorListener); - verifyZeroInteractions(errorListener2); - - error = Exception(); - expect(() => container.refresh(provider), throwsA(error)); - - verifyInOrder([ - errorListener(error, StackTrace.empty), - errorListener2(error, StackTrace.empty), - ]); - verifyNoMoreInteractions(errorListener); - verifyNoMoreInteractions(errorListener2); - }); - - test('executes state listener before other listeners', () { - final container = ProviderContainer.test(); - final listener = Listener(); - final listener2 = Listener(); - var result = 0; - final provider = Provider((ref) { - ref.listenSelf(listener.call); - return result; - }); - - container.listen(provider, listener2.call, fireImmediately: true); - - verifyInOrder([ - listener(null, 0), - listener2(null, 0), - ]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - result = 42; - container.refresh(provider); - - verifyInOrder([ - listener(0, 42), - listener2(0, 42), - ]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('listeners are not allowed to modify the state', () {}); - }); - - group('Ref.listen', () { - test( - 'when rebuild throws identical error/stack, listeners are still notified', - () { - final container = ProviderContainer.test(); - const stack = StackTrace.empty; - final listener = Listener(); - final errorListener = ErrorListener(); - final provider = Provider((ref) { - Error.throwWithStackTrace(42, stack); - }); - - container.listen( - provider, - listener.call, - onError: errorListener.call, - fireImmediately: true, - ); - - verifyZeroInteractions(listener); - verifyOnly(errorListener, errorListener(42, stack)); - - expect(() => container.refresh(provider), throwsA(42)); - - verifyZeroInteractions(listener); - verifyOnly(errorListener, errorListener(42, stack)); - }); - - test('cannot listen itself', () { - final container = ProviderContainer.test(); - final listener = Listener(); - late ProviderRef ref; - late Provider provider; - provider = Provider((r) { - ref = r; - ref.listen(provider, (previous, next) {}); - return 0; - }); - - expect(() => container.read(provider), throwsA(isAssertionError)); - - ref.state = 42; - - verifyZeroInteractions(listener); - }); - - test('expose previous and new value on change', () { - final container = ProviderContainer.test(); - final dep = StateNotifierProvider, int>( - (ref) => StateController(0), - ); - final listener = Listener(); - final provider = Provider((ref) { - ref.listen(dep, listener.call, fireImmediately: true); - }); - - container.read(provider); - - verifyOnly(listener, listener(null, 0)); - - container.read(dep.notifier).state++; - - verifyOnly(listener, listener(0, 1)); - }); - - test( - 'calling ref.listen on a provider with an outdated dependency flushes it, then add the listener', - () { - final container = ProviderContainer.test(); - var buildCount = 0; - final dep2 = StateNotifierProvider, int>( - (ref) => StateController(0), - ); - final dep = Provider((ref) { - buildCount++; - return ref.watch(dep2); - }); - final listener = Listener(); - final provider = Provider((ref) { - ref.listen(dep, listener.call); - }); - - container.read(dep); - container.read(dep2.notifier).state++; // mark `dep` as outdated - - expect(buildCount, 1); - verifyZeroInteractions(listener); - - container.read(provider); - - expect(buildCount, 2); - verifyZeroInteractions(listener); - }); - - test( - 'when using selectors, `previous` is the latest notification instead of latest event', - () { - final container = ProviderContainer.test(); - final dep = StateNotifierProvider, int>( - (ref) => StateController(0), - ); - final listener = Listener(); - final provider = Provider((ref) { - ref.listen( - dep.select((value) => value.isEven), - listener.call, - fireImmediately: true, - ); - }); - - container.read(provider); - verifyOnly(listener, listener(null, true)); - - container.read(dep.notifier).state += 2; - - verifyNoMoreInteractions(listener); - - container.read(dep.notifier).state++; - - verifyOnly(listener, listener(true, false)); - }); - - test('when no onError is specified, fallbacks to handleUncaughtError', - () async { - final container = ProviderContainer.test(); - final isErrored = StateProvider((ref) => false); - final dep = Provider((ref) { - if (ref.watch(isErrored)) throw UnimplementedError(); - return 0; - }); - final listener = Listener(); - final errors = []; - final provider = Provider((ref) { - runZonedGuarded( - () => ref.listen(dep, listener.call), - (err, stack) => errors.add(err), - ); - }); - - container.read(provider); - - verifyZeroInteractions(listener); - expect(errors, isEmpty); - - container.read(isErrored.notifier).state = true; - - await container.pump(); - - verifyZeroInteractions(listener); - expect(errors, [isUnimplementedError]); - }); - - test( - 'when no onError is specified, selectors fallbacks to handleUncaughtError', - () async { - final container = ProviderContainer.test(); - final isErrored = StateProvider((ref) => false); - final dep = Provider((ref) { - if (ref.watch(isErrored)) throw UnimplementedError(); - return 0; - }); - final listener = Listener(); - final errors = []; - final provider = Provider((ref) { - runZonedGuarded( - () => ref.listen(dep.select((value) => value), listener.call), - (err, stack) => errors.add(err), - ); - }); - - container.read(provider); - - verifyZeroInteractions(listener); - expect(errors, isEmpty); - - container.read(isErrored.notifier).state = true; - - await container.pump(); - - verifyZeroInteractions(listener); - expect(errors, [isUnimplementedError]); - }); - - test('when rebuild throws, calls onError', () async { - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - final provider = Provider((ref) { - if (ref.watch(dep) != 0) { - throw UnimplementedError(); - } - return 0; - }); - final errorListener = ErrorListener(); - final listener = Listener(); - - final a = Provider((ref) { - ref.listen(provider, listener.call, onError: errorListener.call); - }); - - container.read(a); - - verifyZeroInteractions(errorListener); - verifyZeroInteractions(listener); - - container.read(dep.notifier).state++; - await container.pump(); - - verifyZeroInteractions(listener); - verifyOnly( - errorListener, - errorListener(isUnimplementedError, any), - ); - }); - - test('when rebuild throws on selector, calls onError', () async { - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - final provider = Provider((ref) { - if (ref.watch(dep) != 0) { - throw UnimplementedError(); - } - return 0; - }); - final errorListener = ErrorListener(); - final listener = Listener(); - - final a = Provider((ref) { - ref.listen( - provider.select((value) => value), - listener.call, - onError: errorListener.call, - ); - }); - - container.read(a); - - verifyZeroInteractions(errorListener); - verifyZeroInteractions(listener); - - container.read(dep.notifier).state++; - await container.pump(); - - verifyZeroInteractions(listener); - verifyOnly( - errorListener, - errorListener(isUnimplementedError, any), - ); - }); - - group('fireImmediately', () { - test('when no onError is specified, fallbacks to handleUncaughtError', - () { - final container = ProviderContainer.test(); - final dep = Provider((ref) => throw UnimplementedError()); - final listener = Listener(); - final errors = []; - final provider = Provider((ref) { - runZonedGuarded( - () { - ref.listen( - dep, - listener.call, - fireImmediately: true, - ); - }, - (err, stack) => errors.add(err), - ); - }); - - container.read(provider); - - verifyZeroInteractions(listener); - expect(errors, [ - isUnimplementedError, - ]); - }); - - test( - 'when no onError is specified on selectors, fallbacks to handleUncaughtError', - () { - final container = ProviderContainer.test(); - final dep = Provider((ref) => throw UnimplementedError()); - final listener = Listener(); - final errors = []; - final provider = Provider((ref) { - runZonedGuarded( - () { - ref.listen( - dep.select((value) => value), - listener.call, - fireImmediately: true, - ); - }, - (err, stack) => errors.add(err), - ); - }); - - container.read(provider); - - verifyZeroInteractions(listener); - expect(errors, [ - isUnimplementedError, - ]); - }); - - test('on provider that threw, fireImmediately calls onError', () { - final container = ProviderContainer.test(); - final dep = Provider((ref) => throw UnimplementedError()); - final listener = Listener(); - final errorListener = ErrorListener(); - final provider = Provider((ref) { - ref.listen( - dep, - listener.call, - onError: errorListener.call, - fireImmediately: true, - ); - }); - - container.read(provider); - - verifyZeroInteractions(listener); - verifyOnly( - errorListener, - errorListener(isUnimplementedError, argThat(isNotNull)), - ); - }); - - test('when selecting provider that threw, fireImmediately calls onError', - () { - final container = ProviderContainer.test(); - final dep = Provider((ref) => throw UnimplementedError()); - final listener = Listener(); - final errorListener = ErrorListener(); - final provider = Provider((ref) { - ref.listen( - dep.select((value) => 0), - listener.call, - onError: errorListener.call, - fireImmediately: true, - ); - }); - - container.read(provider); - - verifyZeroInteractions(listener); - verifyOnly( - errorListener, - errorListener(isUnimplementedError, argThat(isNotNull)), - ); - }); - - test('correctly listens to the provider if selector listener throws', () { - final dep = StateProvider((ref) => 0); - final listener = Listener(); - var isFirstCall = true; - - final container = ProviderContainer.test(); - final errors = []; - - ProviderSubscription? sub; - - final provider = Provider((ref) { - sub = runZonedGuarded( - () => ref.listen( - dep.select((value) => value), - (prev, value) { - listener(prev, value); - if (isFirstCall) { - isFirstCall = false; - throw StateError('Some error'); - } - }, - fireImmediately: true, - ), - (err, stack) => errors.add(err), - ); - }); - - container.listen(provider, (prev, value) {}); - - expect(sub, isNotNull); - verifyOnly(listener, listener(null, 0)); - expect(errors, [isStateError]); - - container.read(dep.notifier).state++; - verifyOnly(listener, listener(0, 1)); - }); - - test('correctly listens to the provider if normal listener throws', () { - final dep = StateProvider((ref) => 0); - final listener = Listener(); - var isFirstCall = true; - - final container = ProviderContainer.test(); - final errors = []; - - ProviderSubscription? sub; - - final provider = Provider((ref) { - sub = runZonedGuarded( - () => ref.listen( - dep, - (prev, value) { - listener(prev, value); - if (isFirstCall) { - isFirstCall = false; - throw StateError('Some error'); - } - }, - fireImmediately: true, - ), - (err, stack) => errors.add(err), - ); - }); - - container.listen(provider, (prev, value) {}); - - expect(sub, isNotNull); - verifyOnly(listener, listener(null, 0)); - expect(errors, [isStateError]); - - container.read(dep.notifier).state++; - verifyOnly(listener, listener(0, 1)); - }); - - test( - 'correctly listens to the provider if selector onError listener throws', - () async { - final dep = StateProvider((ref) => 0); - final dep2 = Provider((ref) { - if (ref.watch(dep) == 0) { - throw UnimplementedError(); - } - return ref.watch(dep); - }); - final listener = Listener(); - final errorListener = ErrorListener(); - var isFirstCall = true; - - final container = ProviderContainer.test(); - final errors = []; - - ProviderSubscription? sub; - - final provider = Provider((ref) { - sub = runZonedGuarded( - () => ref.listen( - dep2.select((value) => value), - listener.call, - onError: (err, stack) { - errorListener(err, stack); - if (isFirstCall) { - isFirstCall = false; - throw StateError('Some error'); - } - }, - fireImmediately: true, - ), - (err, stack) => errors.add(err), - ); - }); - - container.read(provider); - - expect(sub, isNotNull); - verifyZeroInteractions(listener); - verifyOnly( - errorListener, - errorListener(argThat(isUnimplementedError), argThat(isNotNull)), - ); - expect(errors, [isStateError]); - - container.read(dep.notifier).state++; - await container.pump(); - - verifyNoMoreInteractions(errorListener); - verifyOnly(listener, listener(null, 1)); - }); - - test( - 'correctly listens to the provider if normal onError listener throws', - () async { - final dep = StateProvider((ref) => 0); - final dep2 = Provider((ref) { - if (ref.watch(dep) == 0) { - throw UnimplementedError(); - } - return ref.watch(dep); - }); - final listener = Listener(); - final errorListener = ErrorListener(); - var isFirstCall = true; - - final container = ProviderContainer.test(); - final errors = []; - - ProviderSubscription? sub; - - final provider = Provider((ref) { - sub = runZonedGuarded( - () => ref.listen( - dep2, - listener.call, - onError: (err, stack) { - errorListener(err, stack); - if (isFirstCall) { - isFirstCall = false; - throw StateError('Some error'); - } - }, - fireImmediately: true, - ), - (err, stack) => errors.add(err), - ); - }); - - container.read(provider); - - expect(sub, isNotNull); - verifyZeroInteractions(listener); - verifyOnly( - errorListener, - errorListener(argThat(isUnimplementedError), argThat(isNotNull)), - ); - expect(errors, [isStateError]); - - container.read(dep.notifier).state++; - await container.pump(); - - verifyNoMoreInteractions(errorListener); - verifyOnly(listener, listener(null, 1)); - }); - }); - }); - - group('ProviderContainer.listen', () { - test('when no onError is specified, fallbacks to handleUncaughtError', - () async { - final container = ProviderContainer.test(); - final isErrored = StateProvider((ref) => false); - final dep = Provider((ref) { - if (ref.watch(isErrored)) throw UnimplementedError(); - return 0; - }); - final listener = Listener(); - final errors = []; - - runZonedGuarded( - () => container.listen(dep, listener.call), - (err, stack) => errors.add(err), - ); - - verifyZeroInteractions(listener); - expect(errors, isEmpty); - - container.read(isErrored.notifier).state = true; - - await container.pump(); - - verifyZeroInteractions(listener); - expect(errors, [isUnimplementedError]); - }); - - test( - 'when no onError is specified, selectors fallbacks to handleUncaughtError', - () async { - final container = ProviderContainer.test(); - final isErrored = StateProvider((ref) => false); - final dep = Provider((ref) { - if (ref.watch(isErrored)) throw UnimplementedError(); - return 0; - }); - final listener = Listener(); - final errors = []; - - runZonedGuarded( - () => container.listen(dep.select((value) => value), listener.call), - (err, stack) => errors.add(err), - ); - - verifyZeroInteractions(listener); - expect(errors, isEmpty); - - container.read(isErrored.notifier).state = true; - - await container.pump(); - - verifyZeroInteractions(listener); - expect(errors, [isUnimplementedError]); - }); - - test('when rebuild throws, calls onError', () async { - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - final provider = Provider((ref) { - if (ref.watch(dep) != 0) { - throw UnimplementedError(); - } - return 0; - }); - final errorListener = ErrorListener(); - final listener = Listener(); - - container.listen(provider, listener.call, onError: errorListener.call); - - verifyZeroInteractions(errorListener); - verifyZeroInteractions(listener); - - container.read(dep.notifier).state++; - await container.pump(); - - verifyZeroInteractions(listener); - verifyOnly( - errorListener, - errorListener(isUnimplementedError, any), - ); - }); - - test('when rebuild throws on selector, calls onError', () async { - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - final provider = Provider((ref) { - if (ref.watch(dep) != 0) { - throw UnimplementedError(); - } - return 0; - }); - final errorListener = ErrorListener(); - final listener = Listener(); - - container.listen( - provider.select((value) => value), - listener.call, - onError: errorListener.call, - ); - - verifyZeroInteractions(errorListener); - verifyZeroInteractions(listener); - - container.read(dep.notifier).state++; - await container.pump(); - - verifyZeroInteractions(listener); - verifyOnly( - errorListener, - errorListener(isUnimplementedError, any), - ); - }); - - test( - 'when using selectors, `previous` is the latest notification instead of latest event', - () { - final container = ProviderContainer.test(); - final provider = StateNotifierProvider, int>( - (ref) => StateController(0), - ); - final listener = Listener(); - - container.listen( - provider.select((value) => value.isEven), - listener.call, - fireImmediately: true, - ); - - verifyOnly(listener, listener(null, true)); - - container.read(provider.notifier).state += 2; - - verifyNoMoreInteractions(listener); - - container.read(provider.notifier).state++; - - verifyOnly(listener, listener(true, false)); - }); - - test('expose previous and new value on change', () { - final container = ProviderContainer.test(); - final provider = StateNotifierProvider, int>( - (ref) => StateController(0), - ); - final listener = Listener(); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(listener, listener(null, 0)); - - container.read(provider.notifier).state++; - - verifyOnly(listener, listener(0, 1)); - }); - - test('can downcast the value', () async { - final listener = Listener(); - final dep = StateProvider((ref) => 0); - - final container = ProviderContainer.test(); - - container.listen(dep, listener.call); - - verifyZeroInteractions(listener); - - container.read(dep.notifier).state++; - await container.pump(); - - verifyOnly(listener, listener(0, 1)); - }); - - test( - 'if a listener adds a container.listen, the new listener is not called immediately', - () { - final provider = StateProvider((ref) => 0); - final container = ProviderContainer.test(); - - final listener = Listener(); - - container.listen(provider, (prev, value) { - listener(prev, value); - container.listen(provider, listener.call); - }); - - verifyZeroInteractions(listener); - - container.read(provider.notifier).state++; - - verify(listener(0, 1)).called(1); - - container.read(provider.notifier).state++; - - verify(listener(1, 2)).called(2); - }); - - test( - 'if a listener removes another provider.listen, the removed listener is still called', - () { - final provider = StateProvider((ref) => 0); - final container = ProviderContainer.test(); - - final listener = Listener(); - final listener2 = Listener(); - - final p = Provider((ref) { - ProviderSubscription? a; - ref.listen(provider, (prev, value) { - listener(prev, value); - a?.close(); - a = null; - }); - - a = ref.listen(provider, listener2.call); - }); - container.read(p); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - container.read(provider.notifier).state++; - - verifyInOrder([ - listener(0, 1), - listener2(0, 1), - ]); - - container.read(provider.notifier).state++; - - verify(listener(1, 2)).called(1); - verifyNoMoreInteractions(listener2); - }); - - test( - 'if a listener removes another provider.listen, the removed listener is still called (ProviderListenable)', - skip: true, - () { - final provider = StateProvider((ref) => 0); - final container = ProviderContainer.test(); - - final listener = Listener(); - final listener2 = Listener(); - - final p = Provider((ref) { - ProviderSubscription? a; - ref.listen(provider, (prev, value) { - listener(prev, value); - a?.close(); - a = null; - }); - - a = ref.listen(provider, listener2.call); - }); - container.read(p); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - container.read(provider.notifier).state++; - - verifyInOrder([ - listener(1, 1), - listener2(1, 1), - ]); - - container.read(provider.notifier).state++; - - verify(listener(2, 2)).called(1); - verifyNoMoreInteractions(listener2); - // TODO the problem is that ProviderListenable subscriptions are separate from - // ProviderElement subscriptions. So the ProviderElement.notifyListeners - // making a local copy of the list of subscriptions before notifying listeners - // does not apply to ProviderListenables - // Support for modifying listeners within a listener probably should be dropped anyway for performance. - // This would remove a list copy - }, - ); - - test( - 'if a listener adds a provider.listen, the new listener is not called immediately', - () { - final provider = StateProvider((ref) => 0); - final container = ProviderContainer.test(); - - final listener = Listener(); - - final p = Provider((ref) { - ref.listen(provider, (prev, value) { - listener(prev, value); - ref.listen(provider, listener.call); - }); - }); - container.read(p); - - verifyZeroInteractions(listener); - - container.read(provider.notifier).state++; - - verify(listener(0, 1)).called(1); - - container.read(provider.notifier).state++; - - verify(listener(1, 2)).called(2); - }); - - test( - 'if a listener removes another container.listen, the removed listener is still called (ProviderListenable)', - skip: true, - () { - final provider = StateProvider((ref) => 0); - final container = ProviderContainer.test(); - - final listener = Listener(); - final listener2 = Listener(); - - ProviderSubscription? a; - container.listen(provider, (prev, value) { - listener(prev, value); - a?.close(); - a = null; - }); - - a = container.listen(provider, listener2.call); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - container.read(provider.notifier).state++; - - verifyInOrder([ - listener(1, 1), - listener2(1, 1), - ]); - - container.read(provider.notifier).state++; - - verify(listener(2, 2)).called(1); - verifyNoMoreInteractions(listener2); - // TODO the problem is that ProviderListenable subscriptions are separate from - // ProviderElement subscriptions. So the ProviderElement.notifyListeners - // making a local copy of the list of subscriptions before notifying listeners - // does not apply to ProviderListenables - // Support for modifying listeners within a listener probably should be dropped anyway for performance. - // This would remove a list copy - }, - ); - - test( - 'if a listener removes another container.listen, the removed listener is still called', - () { - final provider = StateProvider((ref) => 0); - final container = ProviderContainer.test(); - - final listener = Listener(); - final listener2 = Listener(); - - ProviderSubscription? a; - container.listen(provider, (prev, value) { - listener(prev, value); - a?.close(); - a = null; - }); - - a = container.listen(provider, listener2.call); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - container.read(provider.notifier).state++; - - verifyInOrder([ - listener(0, 1), - listener2(0, 1), - ]); - - container.read(provider.notifier).state++; - - verify(listener(1, 2)).called(1); - verifyNoMoreInteractions(listener2); - }); - - group('fireImmediately', () { - test('when no onError is specified, fallbacks to handleUncaughtError', - () { - final container = ProviderContainer.test(); - final dep = Provider((ref) => throw UnimplementedError()); - final listener = Listener(); - final errors = []; - - runZonedGuarded( - () { - container.listen( - dep, - listener.call, - fireImmediately: true, - ); - }, - (err, stack) => errors.add(err), - ); - - verifyZeroInteractions(listener); - expect(errors, [ - isUnimplementedError, - ]); - }); - - test( - 'when no onError is specified on selectors, fallbacks to handleUncaughtError', - () { - final container = ProviderContainer.test(); - final dep = Provider((ref) => throw UnimplementedError()); - final listener = Listener(); - final errors = []; - - runZonedGuarded( - () { - container.listen( - dep.select((value) => value), - listener.call, - fireImmediately: true, - ); - }, - (err, stack) => errors.add(err), - ); - - verifyZeroInteractions(listener); - expect(errors, [ - isUnimplementedError, - ]); - }); - - test('on provider that threw, fireImmediately calls onError', () { - final container = ProviderContainer.test(); - final provider = Provider((ref) => throw UnimplementedError()); - final listener = Listener(); - final errorListener = ErrorListener(); - - container.listen( - provider, - listener.call, - onError: errorListener.call, - fireImmediately: true, - ); - - verifyZeroInteractions(listener); - verifyOnly( - errorListener, - errorListener(isUnimplementedError, argThat(isNotNull)), - ); - }); - - test('supports selectors', () { - final container = ProviderContainer.test(); - final provider = - StateNotifierProvider((ref) => Counter()); - final listener = Listener(); - final listener2 = Listener(); - - container.listen( - provider.select((v) => v.isEven), - listener.call, - fireImmediately: true, - ); - container.listen(provider.select((v) => v.isEven), listener2.call); - - verifyOnly(listener, listener(null, true)); - verifyZeroInteractions(listener2); - - container.read(provider.notifier).state = 21; - - verifyOnly(listener, listener(true, false)); - verifyOnly(listener2, listener2(true, false)); - }); - - test('passing fireImmediately: false skips the initial value', () { - final provider = StateProvider((ref) => 0); - final listener = Listener(); - - final container = ProviderContainer.test(); - - container.listen(provider, listener.call); - - verifyZeroInteractions(listener); - }); - - test( - 'correctly listens to the provider if selector onError listener throws', - () async { - final dep = StateProvider((ref) => 0); - final provider = Provider((ref) { - if (ref.watch(dep) == 0) { - throw UnimplementedError(); - } - return ref.watch(dep); - }); - final listener = Listener(); - final errorListener = ErrorListener(); - var isFirstCall = true; - - final container = ProviderContainer.test(); - final errors = []; - - final sub = runZonedGuarded( - () => container.listen( - provider.select((value) => value), - listener.call, - onError: (err, stack) { - errorListener(err, stack); - if (isFirstCall) { - isFirstCall = false; - throw StateError('Some error'); - } - }, - fireImmediately: true, - ), - (err, stack) => errors.add(err), - ); - - container.listen(provider, (prev, value) {}); - - expect(sub, isNotNull); - verifyZeroInteractions(listener); - verifyOnly( - errorListener, - errorListener(argThat(isUnimplementedError), argThat(isNotNull)), - ); - expect(errors, [isStateError]); - - container.read(dep.notifier).state++; - await container.pump(); - - verifyNoMoreInteractions(errorListener); - verifyOnly(listener, listener(null, 1)); - }); - - test( - 'correctly listens to the provider if normal onError listener throws', - () async { - final dep = StateProvider((ref) => 0); - final provider = Provider((ref) { - if (ref.watch(dep) == 0) { - throw UnimplementedError(); - } - return ref.watch(dep); - }); - final listener = Listener(); - final errorListener = ErrorListener(); - var isFirstCall = true; - - final container = ProviderContainer.test(); - final errors = []; - - final sub = runZonedGuarded( - () => container.listen( - provider, - listener.call, - onError: (err, stack) { - errorListener(err, stack); - if (isFirstCall) { - isFirstCall = false; - throw StateError('Some error'); - } - }, - fireImmediately: true, - ), - (err, stack) => errors.add(err), - ); - - container.listen(provider, (prev, value) {}); - - expect(sub, isNotNull); - verifyZeroInteractions(listener); - verifyOnly( - errorListener, - errorListener(argThat(isUnimplementedError), argThat(isNotNull)), - ); - expect(errors, [isStateError]); - - container.read(dep.notifier).state++; - await container.pump(); - - verifyNoMoreInteractions(errorListener); - verifyOnly(listener, listener(null, 1)); - }); - - test('correctly listens to the provider if selector listener throws', () { - final provider = StateProvider((ref) => 0); - final listener = Listener(); - var isFirstCall = true; - - final container = ProviderContainer.test(); - final errors = []; - - final sub = runZonedGuarded( - () => container.listen( - provider.select((value) => value), - (prev, value) { - listener(prev, value); - if (isFirstCall) { - isFirstCall = false; - throw StateError('Some error'); - } - }, - fireImmediately: true, - ), - (err, stack) => errors.add(err), - ); - - expect(sub, isNotNull); - verifyOnly(listener, listener(null, 0)); - expect(errors, [isStateError]); - - container.read(provider.notifier).state++; - - verifyOnly(listener, listener(0, 1)); - }); - - test('correctly listens to the provider if normal listener throws', () { - final provider = StateProvider((ref) => 0); - final listener = Listener(); - var isFirstCall = true; - - final container = ProviderContainer.test(); - final errors = []; - - final sub = runZonedGuarded( - () => container.listen( - provider, - (prev, value) { - listener(prev, value); - if (isFirstCall) { - isFirstCall = false; - throw StateError('Some error'); - } - }, - fireImmediately: true, - ), - (err, stack) => errors.add(err), - ); - - expect(sub, isNotNull); - verifyOnly(listener, listener(null, 0)); - expect(errors, [isStateError]); - - container.read(provider.notifier).state++; - - verifyOnly(listener, listener(0, 1)); - }); - - test('correctly listens to the provider if normal listener throws', () { - final provider = StateProvider((ref) => 0); - final listener = Listener(); - var isFirstCall = true; - - final container = ProviderContainer.test(); - final errors = []; - - final sub = runZonedGuarded( - () => container.listen( - provider, - (prev, notifier) { - listener(prev, notifier); - if (isFirstCall) { - isFirstCall = false; - throw StateError('Some error'); - } - }, - fireImmediately: true, - ), - (err, stack) => errors.add(err), - ); - - expect(sub, isNotNull); - verifyOnly(listener, listener(null, 0)); - expect(errors, [isStateError]); - - container.read(provider.notifier).state++; - - verifyOnly(listener, listener(0, 1)); - }); - }); - - test('.read on closed subscription throws', () { - final notifier = Counter(); - final provider = StateNotifierProvider((_) => notifier); - final container = ProviderContainer.test(); - final listener = Listener(); - - final sub = - container.listen(provider, listener.call, fireImmediately: true); - - verify(listener(null, 0)).called(1); - verifyNoMoreInteractions(listener); - - sub.close(); - notifier.increment(); - - expect(sub.read, throwsStateError); - - verifyNoMoreInteractions(listener); - }); - - test('.read on closed selector subscription throws', () { - final notifier = Counter(); - final provider = StateNotifierProvider((_) => notifier); - final container = ProviderContainer.test(); - final listener = Listener(); - - final sub = container.listen( - provider.select((value) => value * 2), - listener.call, - fireImmediately: true, - ); - - verify(listener(null, 0)).called(1); - verifyNoMoreInteractions(listener); - - sub.close(); - notifier.increment(); - - expect(sub.read, throwsStateError); - verifyNoMoreInteractions(listener); - }); - - test("doesn't trow when creating a provider that failed", () { - final container = ProviderContainer.test(); - final provider = Provider((ref) { - throw Error(); - }); - - final sub = container.listen(provider, (_, __) {}); - - expect(sub, isA>()); - }); - - test('selectors can close listeners', () { - final container = ProviderContainer.test(); - final provider = StateNotifierProvider((ref) => Counter()); - - expect(container.readProviderElement(provider).hasListeners, false); - - final sub = container.listen( - provider.select((count) => count.isEven), - (prev, isEven) {}, - ); - - expect(container.readProviderElement(provider).hasListeners, true); - - sub.close(); - - expect(container.readProviderElement(provider).hasListeners, false); - }); - - test('can watch selectors', () async { - final container = ProviderContainer.test(); - final provider = StateNotifierProvider((ref) => Counter()); - final isAdultSelector = Selector(false, (c) => c >= 18); - final isAdultListener = Listener(); - - final controller = container.read(provider.notifier); - container.listen( - provider.select(isAdultSelector.call), - isAdultListener.call, - fireImmediately: true, - ); - - verifyOnly(isAdultSelector, isAdultSelector(0)); - verifyOnly(isAdultListener, isAdultListener(null, false)); - - controller.state += 10; - - verifyOnly(isAdultSelector, isAdultSelector(10)); - verifyNoMoreInteractions(isAdultListener); - - controller.state += 10; - - verifyOnly(isAdultSelector, isAdultSelector(20)); - verifyOnly(isAdultListener, isAdultListener(false, true)); - - controller.state += 10; - - verifyOnly(isAdultSelector, isAdultSelector(30)); - verifyNoMoreInteractions(isAdultListener); - }); - - test('calls immediately the listener with the current value', () { - final provider = Provider((ref) => 0); - final listener = Listener(); - - final container = ProviderContainer.test(); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(listener, listener(null, 0)); - }); - - test('call listener when provider rebuilds', () async { - final controller = StreamController(); - addTearDown(controller.close); - final container = ProviderContainer.test(); - - final count = StateProvider((ref) => 0); - final provider = Provider((ref) => ref.watch(count)); - - container.listen( - provider, - (prev, value) => controller.add(value), - fireImmediately: true, - ); - - container.read(count.notifier).state++; - - await expectLater( - controller.stream, - emitsInOrder([0, 1]), - ); - }); - - test('call listener when provider emits an update', () async { - final container = ProviderContainer.test(); - - final count = StateProvider((ref) => 0); - final listener = Listener(); - - container.listen(count, listener.call); - - container.read(count.notifier).state++; - - verifyOnly(listener, listener(0, 1)); - - container.read(count.notifier).state++; - - verifyOnly(listener, listener(1, 2)); - }); - - test('supports selectors', () { - final container = ProviderContainer.test(); - - final count = StateProvider((ref) => 0); - final listener = Listener(); - - container.listen( - count.select((value) => value.isEven), - listener.call, - fireImmediately: true, - ); - - verifyOnly(listener, listener(null, true)); - - container.read(count.notifier).state = 2; - - verifyNoMoreInteractions(listener); - - container.read(count.notifier).state = 3; - - verifyOnly(listener, listener(true, false)); - }); - }); -} From da9ff7a5be0d03777ae022b0a3727f06297c8e7a Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 29 Dec 2023 14:16:09 +0100 Subject: [PATCH 114/387] Fix some TODOs --- packages/riverpod/lib/src/core/override.dart | 1 - .../lib/src/core/override_with_value.dart | 45 ------------------- .../lib/src/core/provider_container.dart | 10 +---- .../lib/src/legacy_providers/provider.dart | 39 +++++++++++++++- .../new/core/provider_container_test.dart | 11 +++-- .../async_notifier/async_notifier_test.dart | 2 - .../notifier/notifier_test.dart | 2 - .../stream_notifier/async_notifier_test.dart | 32 ------------- 8 files changed, 46 insertions(+), 96 deletions(-) diff --git a/packages/riverpod/lib/src/core/override.dart b/packages/riverpod/lib/src/core/override.dart index 399964870..6441e89dd 100644 --- a/packages/riverpod/lib/src/core/override.dart +++ b/packages/riverpod/lib/src/core/override.dart @@ -103,7 +103,6 @@ abstract class FamilyOverride implements _FamilyOverride { }) = _FamilyOverrideImpl; /// The family that was overridden. - // TODO make all fields private Family get from; /// The overridden [ProviderBase.createElement]. diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index 963a37ecb..f220d63be 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -1,50 +1,5 @@ part of '../framework.dart'; -/// A mixin to add [overrideWithValue] capability to a provider. -// TODO merge with Provider directy -mixin OverrideWithValueMixin on ProviderBase { - /// {@template riverpod.overrridewithvalue} - /// Overrides a provider with a value, ejecting the default behavior. - /// - /// This will also disable the auto-scoping mechanism, meaning that if the - /// overridden provider specified [dependencies], it will have no effect. - /// - /// Some common use-cases are: - /// - testing, by replacing a service with a fake implementation, or to reach - /// a very specific state easily. - /// - multiple environments, by changing the implementation of a class - /// based on the platform or other parameters. - /// - /// This function should be used in combination with `ProviderScope.overrides` - /// or `ProviderContainer.overrides`: - /// - /// ```dart - /// final myService = Provider((ref) => MyService()); - /// - /// runApp( - /// ProviderScope( - /// overrides: [ - /// myService.overrideWithValue( - /// // Replace the implementation of MyService with a fake implementation - /// MyFakeService(), - /// ), - /// ], - /// child: MyApp(), - /// ), - /// ); - /// ``` - /// {@endtemplate} - Override overrideWithValue(State value) { - return ProviderOverride( - origin: this, - providerOverride: ValueProvider(value), - ); - } - - @override - String toString(); -} - /// A provider that is driven by a value instead of a function. /// /// This is an implementation detail of `overrideWithValue`. diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index d07d20ff7..4948b7edb 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -7,8 +7,6 @@ extension on String { } } -ProviderBase? _circularDependencyLock; - abstract class _PointerBase { bool get isTransitiveOverride; @@ -346,7 +344,8 @@ class ProviderPointerManager { /// /// Returns `null` if it should be mounted at the root. ProviderContainer? findDeepestTransitiveDependencyProviderContainer( - ProviderOrFamily provider) { + ProviderOrFamily provider, + ) { if (container._parent == null) return null; final transitiveDependencies = provider.allTransitiveDependencies; @@ -649,11 +648,6 @@ class ProviderContainer implements Node { late final ProviderPointerManager _pointerManager; - // final _overrideForProvider = - // HashMap, ProviderBase>(); - // final _overrideForFamily = HashMap(); - // final Map, _StateReader> _stateReaders; - /// The list of observers attached to this container. /// /// Observers can be useful for logging purpose. diff --git a/packages/riverpod/lib/src/legacy_providers/provider.dart b/packages/riverpod/lib/src/legacy_providers/provider.dart index 93017df25..9213b7a32 100644 --- a/packages/riverpod/lib/src/legacy_providers/provider.dart +++ b/packages/riverpod/lib/src/legacy_providers/provider.dart @@ -12,8 +12,7 @@ part 'provider/base.dart'; /// /// Not meant for public consumption @internal -abstract class InternalProvider extends ProviderBase - with OverrideWithValueMixin { +abstract class InternalProvider extends ProviderBase { /// A base class for [Provider] /// /// Not meant for public consumption @@ -27,4 +26,40 @@ abstract class InternalProvider extends ProviderBase }); State _create(covariant ProviderElement ref); + + /// Overrides a provider with a value, ejecting the default behavior. + /// + /// This will also disable the auto-scoping mechanism, meaning that if the + /// overridden provider specified [dependencies], it will have no effect. + /// + /// Some common use-cases are: + /// - testing, by replacing a service with a fake implementation, or to reach + /// a very specific state easily. + /// - multiple environments, by changing the implementation of a class + /// based on the platform or other parameters. + /// + /// This function should be used in combination with `ProviderScope.overrides` + /// or `ProviderContainer.overrides`: + /// + /// ```dart + /// final myService = Provider((ref) => MyService()); + /// + /// runApp( + /// ProviderScope( + /// overrides: [ + /// myService.overrideWithValue( + /// // Replace the implementation of MyService with a fake implementation + /// MyFakeService(), + /// ), + /// ], + /// child: MyApp(), + /// ), + /// ); + /// ``` + Override overrideWithValue(State value) { + return ProviderOverride( + origin: this, + providerOverride: ValueProvider(value), + ); + } } diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index 18f87c6e2..55820dca0 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -540,10 +540,13 @@ void main() { final root = ProviderContainer.test(); final mid = ProviderContainer.test(parent: root, overrides: [dep]); final mid2 = ProviderContainer.test(parent: mid, overrides: [dep2]); - final leaf = ProviderContainer.test(parent: mid2, overrides: [ - // Disable scoping optimization - Provider((ref) => null, dependencies: const []), - ]); + final leaf = ProviderContainer.test( + parent: mid2, + overrides: [ + // Disable scoping optimization + Provider((ref) => null, dependencies: const []), + ], + ); leaf.pointerManager.upsertPointer(a); leaf.pointerManager.upsertPointer(b); diff --git a/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart b/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart index 41eed0c04..a075ef95e 100644 --- a/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart +++ b/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart @@ -1075,8 +1075,6 @@ void main() { ProviderListenable provider, ) {} - // TODO use package:expect_error to test that commented lined are not compiling - test('provider', () { final provider = AsyncNotifierProvider, int>( () => AsyncTestNotifier((ref) => 0), diff --git a/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart b/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart index 8251aae9c..3494e21c1 100644 --- a/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart +++ b/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart @@ -614,8 +614,6 @@ void main() { ProviderListenable provider, ) {} - // TODO use package:expect_error to test that commented lined are not compiling - test('provider', () { final provider = NotifierProvider, int>( () => TestNotifier((ref) => 0), diff --git a/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart b/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart index a13c7fade..73e6dc261 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart @@ -1015,8 +1015,6 @@ void main() { ProviderListenable provider, ) {} - // TODO use package:expect_error to test that commented lined are not compiling - test('provider', () { final provider = StreamNotifierProvider, int>( () => StreamTestNotifier((ref) => Stream.value(0)), @@ -1045,27 +1043,17 @@ void main() { autoDispose.selectAsync((int value) => 0); canBeAssignedToProviderListenable>(autoDispose); - // canBeAssignedToAlwaysAliveListenable>(autoDispose); canBeAssignedToRefreshable>(autoDispose); - // canBeAssignedToAlwaysAliveRefreshable>(autoDispose); canBeAssignedToProviderListenable>(autoDispose.future); - // canBeAssignedToAlwaysAliveListenable>(autoDispose.future); canBeAssignedToRefreshable>(autoDispose.future); - // canBeAssignedToAlwaysAliveRefreshable>(autoDispose.future); canBeAssignedToProviderListenable>( autoDispose.notifier, ); - // canBeAssignedToAlwaysAliveListenable>( - // autoDispose.notifier, - // ); canBeAssignedToRefreshable>( autoDispose.notifier, ); - // canBeAssignedToAlwaysAliveRefreshable>( - // autoDispose.notifier, - // ); }); test('family', () { @@ -1108,44 +1096,24 @@ void main() { canBeAssignedToProviderListenable>( autoDisposeFamily(0), ); - // canBeAssignedToAlwaysAliveListenable>( - // autoDisposeFamily(0), - // ); canBeAssignedToRefreshable>( autoDisposeFamily(0), ); - // canBeAssignedToAlwaysAliveRefreshable>( - // autoDisposeFamily(0), - // ); canBeAssignedToProviderListenable>( autoDisposeFamily(0).future, ); - // canBeAssignedToAlwaysAliveListenable>( - // autoDisposeFamily(0).future, - // ); canBeAssignedToRefreshable>( autoDisposeFamily(0).future, ); - // canBeAssignedToAlwaysAliveRefreshable>( - // autoDisposeFamily(0).future, - // ); canBeAssignedToProviderListenable< AutoDisposeFamilyStreamNotifier>( autoDisposeFamily(0).notifier, ); - // canBeAssignedToAlwaysAliveListenable< - // AutoDisposeFamilyStreamNotifier>( - // autoDisposeFamily(0).notifier, - // ); canBeAssignedToRefreshable>( autoDisposeFamily(0).notifier, ); - // canBeAssignedToAlwaysAliveRefreshable< - // AutoDisposeFamilyStreamNotifier>( - // autoDisposeFamily(0).notifier, - // ); }); }); } From cc371584f7cda8673dc2f4f2eb139d1e94a43df3 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 29 Dec 2023 14:41:41 +0100 Subject: [PATCH 115/387] Fix some ignores --- .../lib/flutter_riverpod.dart | 1 - .../deprecated/change_notifier_provider.dart | 1 - .../auto_dispose.dart | 2 -- .../change_notifier_provider/base.dart | 2 -- .../test/analysis_options.yaml | 10 ++++++ ...dispose_change_notifier_provider_test.dart | 1 - .../flutter_riverpod/test/consumer_test.dart | 13 ++++---- .../flutter_riverpod/test/framework_test.dart | 33 +++++++++---------- .../flutter_riverpod/test/provider_test.dart | 13 +++----- .../hooks_riverpod/lib/hooks_riverpod.dart | 1 - packages/riverpod/lib/src/core/element.dart | 1 - .../riverpod/lib/src/core/foundation.dart | 1 - packages/riverpod/lib/src/core/provider.dart | 2 -- .../lib/src/core/provider_container.dart | 1 - .../src/legacy_providers/async_notifier.dart | 1 - .../lib/src/legacy_providers/notifier.dart | 1 - packages/riverpod/test/analysis_options.yaml | 10 ++++++ .../test/new/core/async_value_test.dart | 4 +-- 18 files changed, 49 insertions(+), 49 deletions(-) create mode 100644 packages/flutter_riverpod/test/analysis_options.yaml create mode 100644 packages/riverpod/test/analysis_options.yaml diff --git a/packages/flutter_riverpod/lib/flutter_riverpod.dart b/packages/flutter_riverpod/lib/flutter_riverpod.dart index 5adedb89d..a08858e1a 100644 --- a/packages/flutter_riverpod/lib/flutter_riverpod.dart +++ b/packages/flutter_riverpod/lib/flutter_riverpod.dart @@ -1,4 +1,3 @@ -// ignore: invalid_export_of_internal_element export 'package:riverpod/riverpod.dart'; export 'src/consumer.dart'; diff --git a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider.dart b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider.dart index 9398cdf0b..8c293f53d 100644 --- a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider.dart @@ -24,7 +24,6 @@ ProviderElementProxy ); } -// ignore: subtype_of_sealed_class /// {@template riverpod.changenotifierprovider} /// Creates a [ChangeNotifier] and subscribes to it. /// diff --git a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart index d1da7ec92..961053767 100644 --- a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart +++ b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart @@ -8,7 +8,6 @@ abstract class AutoDisposeChangeNotifierProviderRef< extends ChangeNotifierProviderRef implements AutoDisposeRef {} -// ignore: subtype_of_sealed_class /// {@macro riverpod.change_notifier_provider} class AutoDisposeChangeNotifierProvider extends _ChangeNotifierProviderBase { @@ -93,7 +92,6 @@ class AutoDisposeChangeNotifierProviderElement< ) : super._(); } -// ignore: subtype_of_sealed_class /// The [Family] of [AutoDisposeChangeNotifierProvider]. class AutoDisposeChangeNotifierProviderFamily diff --git a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart index 6063327c0..9a68ed729 100644 --- a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart +++ b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart @@ -11,7 +11,6 @@ abstract class ChangeNotifierProviderRef NotifierT get notifier; } -// ignore: subtype_of_sealed_class /// {@template riverpod.change_notifier_provider} /// Creates a [ChangeNotifier] and exposes its current state. /// @@ -240,7 +239,6 @@ class ChangeNotifierProviderElement } } -// ignore: subtype_of_sealed_class /// The [Family] of [ChangeNotifierProvider]. class ChangeNotifierProviderFamily extends FamilyBase, NotifierT, Arg, diff --git a/packages/flutter_riverpod/test/analysis_options.yaml b/packages/flutter_riverpod/test/analysis_options.yaml new file mode 100644 index 000000000..99904038d --- /dev/null +++ b/packages/flutter_riverpod/test/analysis_options.yaml @@ -0,0 +1,10 @@ +include: ../../../analysis_options.yaml +analyzer: + errors: + unused_local_variable: ignore + +linter: + rules: + # Some tests may want to explicitly create an unused variable without type inference, + # for the sake of testing that that two types are assignable + omit_local_variable_types: false diff --git a/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart index 18d990ba6..8c5cf2f58 100644 --- a/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart @@ -196,7 +196,6 @@ class TestNotifier extends ChangeNotifier { bool mounted = true; @override - // ignore: unnecessary_overrides bool get hasListeners => super.hasListeners; int _count = 0; diff --git a/packages/flutter_riverpod/test/consumer_test.dart b/packages/flutter_riverpod/test/consumer_test.dart index 5a5804096..05bdb2e83 100644 --- a/packages/flutter_riverpod/test/consumer_test.dart +++ b/packages/flutter_riverpod/test/consumer_test.dart @@ -1,3 +1,5 @@ +import 'dart:async'; + import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/src/internals.dart'; @@ -190,8 +192,7 @@ void main() { expect(find.byType(Container), findsOneWidget); expect(buildCount, 1); - // ignore: unawaited_futures - tester.binding.reassembleApplication(); + unawaited(tester.binding.reassembleApplication()); await tester.pump(); expect(find.byType(Container), findsOneWidget); @@ -478,13 +479,13 @@ void main() { expect(find.text('isPositive true'), findsOneWidget); expect(buildCount, 1); - notifier.value = -10; + notifier.state = -10; await tester.pump(); expect(find.text('isPositive false'), findsOneWidget); expect(buildCount, 2); - notifier.value = -5; + notifier.state = -5; await tester.pump(); expect(find.text('isPositive false'), findsOneWidget); @@ -760,8 +761,8 @@ class TestNotifier extends StateNotifier { void increment() => state++; - // ignore: avoid_setters_without_getters - set value(int value) => state = value; + @override + int get state; } final _provider = Provider((ref) => 'hello world'); diff --git a/packages/flutter_riverpod/test/framework_test.dart b/packages/flutter_riverpod/test/framework_test.dart index 340703104..f3c627232 100644 --- a/packages/flutter_riverpod/test/framework_test.dart +++ b/packages/flutter_riverpod/test/framework_test.dart @@ -508,7 +508,7 @@ void main() { await tester.pumpWidget( ProviderScope( - child: InitState( + child: _InitState( initState: (context, ref) => result = ref.read(provider), ), ), @@ -828,17 +828,18 @@ void main() { expect(find.text('1'), findsOneWidget); - // ignore: unawaited_futures - key.currentState!.pushReplacement( - PageRouteBuilder( - pageBuilder: (_, __, ___) { - return Consumer( - builder: (context, ref, _) { - final count = ref.watch(counterProvider); - return Text('new $count'); - }, - ); - }, + unawaited( + key.currentState!.pushReplacement( + PageRouteBuilder( + pageBuilder: (_, __, ___) { + return Consumer( + builder: (context, ref, _) { + final count = ref.watch(counterProvider); + return Text('new $count'); + }, + ); + }, + ), ), ); @@ -850,18 +851,16 @@ void main() { }); } -class InitState extends ConsumerStatefulWidget { - const InitState({super.key, required this.initState}); +class _InitState extends ConsumerStatefulWidget { + const _InitState({required this.initState}); - // ignore: diagnostic_describe_all_properties final void Function(BuildContext context, WidgetRef ref) initState; @override - // ignore: library_private_types_in_public_api _InitStateState createState() => _InitStateState(); } -class _InitStateState extends ConsumerState { +class _InitStateState extends ConsumerState<_InitState> { @override void initState() { super.initState(); diff --git a/packages/flutter_riverpod/test/provider_test.dart b/packages/flutter_riverpod/test/provider_test.dart index 6f5791522..d3f6c051c 100644 --- a/packages/flutter_riverpod/test/provider_test.dart +++ b/packages/flutter_riverpod/test/provider_test.dart @@ -18,14 +18,10 @@ void main() { Consumer( builder: (context, ref, _) { - // ignore: omit_local_variable_types, unused_local_variable, prefer_final_locals - int providerValue = ref.read(provider); - // ignore: omit_local_variable_types, unused_local_variable, prefer_final_locals - AsyncValue futureProviderValue = ref.read(futureProvider); - // ignore: omit_local_variable_types, unused_local_variable, prefer_final_locals - AsyncValue streamProviderValue = ref.read(streamProvider); - // ignore: omit_local_variable_types, unused_local_variable, prefer_final_locals - ValueNotifier changeNotifierProviderValue = + final int providerValue = ref.read(provider); + final AsyncValue futureProviderValue = ref.read(futureProvider); + final AsyncValue streamProviderValue = ref.read(streamProvider); + final ValueNotifier changeNotifierProviderValue = ref.read(changeNotifierProvider); return Container(); @@ -295,7 +291,6 @@ void main() { // These check the type safety Ref? ref; - // ignore: omit_local_variable_types final Provider provider1 = Provider((r) { final first = r.watch(provider); ref = r; diff --git a/packages/hooks_riverpod/lib/hooks_riverpod.dart b/packages/hooks_riverpod/lib/hooks_riverpod.dart index af95e689b..05f37a134 100644 --- a/packages/hooks_riverpod/lib/hooks_riverpod.dart +++ b/packages/hooks_riverpod/lib/hooks_riverpod.dart @@ -1,4 +1,3 @@ -// ignore: invalid_export_of_internal_element export 'package:flutter_riverpod/flutter_riverpod.dart'; export 'src/consumer.dart'; diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index d40dc8405..68da578f9 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -294,7 +294,6 @@ abstract class ProviderElementBase implements Ref, Node { ); } - // ignore: use_setters_to_change_properties /// Called when the override of a provider changes. /// /// See also: diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index 981b58f36..141e97c85 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -4,7 +4,6 @@ part of '../framework.dart'; abstract class ProviderListenableOrFamily {} /// A common interface shared by [ProviderBase] and [Family] -@sealed sealed class ProviderOrFamily implements ProviderListenableOrFamily { /// A common interface shared by [ProviderBase] and [Family] const ProviderOrFamily({ diff --git a/packages/riverpod/lib/src/core/provider.dart b/packages/riverpod/lib/src/core/provider.dart index f5a005df4..6e89b50e2 100644 --- a/packages/riverpod/lib/src/core/provider.dart +++ b/packages/riverpod/lib/src/core/provider.dart @@ -110,7 +110,6 @@ abstract class ProviderBase extends ProviderOrFamily ProviderElementBase createElement(ProviderContainer container); @override - // ignore: avoid_equals_and_hash_code_on_mutable_classes int get hashCode { if (from == null) return super.hashCode; @@ -118,7 +117,6 @@ abstract class ProviderBase extends ProviderOrFamily } @override - // ignore: avoid_equals_and_hash_code_on_mutable_classes bool operator ==(Object other) { if (from == null) return identical(other, this); diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 4948b7edb..70c874856 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -198,7 +198,6 @@ class ProviderDirectory implements _PointerBase { } @override - // ignore: annotate_overrides, https://github.com/dart-lang/linter/issues/4819 String toString() { final buffer = StringBuffer(); buffer.writeln('ProviderDirectory$hashCode('); diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier.dart index 103ce77f3..6767c84fb 100644 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier.dart +++ b/packages/riverpod/lib/src/legacy_providers/async_notifier.dart @@ -50,7 +50,6 @@ abstract class AsyncNotifierBase { if (element == null) throw StateError(uninitializedElementError); element.flush(); - // ignore: invalid_use_of_protected_member return element.requireState; } diff --git a/packages/riverpod/lib/src/legacy_providers/notifier.dart b/packages/riverpod/lib/src/legacy_providers/notifier.dart index a78d482c6..2d0e35c0b 100644 --- a/packages/riverpod/lib/src/legacy_providers/notifier.dart +++ b/packages/riverpod/lib/src/legacy_providers/notifier.dart @@ -90,7 +90,6 @@ abstract class NotifierBase { final element = _element; if (element == null) throw StateError(uninitializedElementError); - // ignore: invalid_use_of_protected_member element.setState(value); } diff --git a/packages/riverpod/test/analysis_options.yaml b/packages/riverpod/test/analysis_options.yaml new file mode 100644 index 000000000..99904038d --- /dev/null +++ b/packages/riverpod/test/analysis_options.yaml @@ -0,0 +1,10 @@ +include: ../../../analysis_options.yaml +analyzer: + errors: + unused_local_variable: ignore + +linter: + rules: + # Some tests may want to explicitly create an unused variable without type inference, + # for the sake of testing that that two types are assignable + omit_local_variable_types: false diff --git a/packages/riverpod/test/new/core/async_value_test.dart b/packages/riverpod/test/new/core/async_value_test.dart index 4710bfb9a..edb7c9d32 100644 --- a/packages/riverpod/test/new/core/async_value_test.dart +++ b/packages/riverpod/test/new/core/async_value_test.dart @@ -1077,9 +1077,9 @@ void main() { }); test('==', () { - // ignore: prefer_const_declarations + // ignore: prefer_const_declarations, not using const to test runtime final value = 42; - // ignore: prefer_const_declarations + // ignore: prefer_const_declarations, not using const to test runtime final value2 = 21; final stack = StackTrace.current; From a9cd178b72c7f45c44186aef328638e56c9d2289 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 29 Dec 2023 15:01:57 +0100 Subject: [PATCH 116/387] Remove ignore --- packages/hooks_riverpod/lib/src/consumer.dart | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/hooks_riverpod/lib/src/consumer.dart b/packages/hooks_riverpod/lib/src/consumer.dart index 5bd6b0d99..38071a4fe 100644 --- a/packages/hooks_riverpod/lib/src/consumer.dart +++ b/packages/hooks_riverpod/lib/src/consumer.dart @@ -16,7 +16,6 @@ abstract class HookConsumerWidget extends ConsumerWidget { _HookConsumerElement createElement() => _HookConsumerElement(this); } -// ignore: invalid_use_of_visible_for_testing_member class _HookConsumerElement extends ConsumerStatefulElement with HookElement { _HookConsumerElement(HookConsumerWidget super.widget); } From 6bb2a8ea8169d2ec22d7880badc0598352ff74a5 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 30 Dec 2023 17:17:30 +0100 Subject: [PATCH 117/387] Remove some ignores --- .../test/async_notifier_test.dart | 4 ---- packages/riverpod_generator/test/async_test.dart | 4 ---- .../riverpod_generator/test/notifier_test.dart | 4 ---- .../test/stream_notifier_test.dart | 4 ---- packages/riverpod_generator/test/stream_test.dart | 4 ---- packages/riverpod_generator/test/sync_test.dart | 4 ---- .../golden/lib/constructor_providers.dart | 15 ++------------- .../test/integration/analysis_options.yaml | 5 +++++ .../assists/convert_to_stateful_base_widget.dart | 2 +- .../assists/convert_to_stateless_base_widget.dart | 3 ++- .../lib/src/assists/convert_to_widget_utils.dart | 1 - .../riverpod_lint_flutter_test/test/golden.dart | 2 +- 12 files changed, 11 insertions(+), 41 deletions(-) create mode 100644 packages/riverpod_graph/test/integration/analysis_options.yaml diff --git a/packages/riverpod_generator/test/async_notifier_test.dart b/packages/riverpod_generator/test/async_notifier_test.dart index c8664e5d2..df2d7d17f 100644 --- a/packages/riverpod_generator/test/async_notifier_test.dart +++ b/packages/riverpod_generator/test/async_notifier_test.dart @@ -90,8 +90,6 @@ void main() { familyClassProvider( 42, third: .42, - // ignore: avoid_redundant_argument_values - fourth: true, ), ); expect( @@ -99,8 +97,6 @@ void main() { familyClassProvider( 42, third: .42, - // ignore: avoid_redundant_argument_values - fourth: true, ).hashCode, ); diff --git a/packages/riverpod_generator/test/async_test.dart b/packages/riverpod_generator/test/async_test.dart index ed18a8e3f..9ba02be22 100644 --- a/packages/riverpod_generator/test/async_test.dart +++ b/packages/riverpod_generator/test/async_test.dart @@ -81,8 +81,6 @@ void main() { familyProvider( 42, third: .42, - // ignore: avoid_redundant_argument_values - fourth: true, ), ); expect( @@ -90,8 +88,6 @@ void main() { familyProvider( 42, third: .42, - // ignore: avoid_redundant_argument_values - fourth: true, ).hashCode, ); diff --git a/packages/riverpod_generator/test/notifier_test.dart b/packages/riverpod_generator/test/notifier_test.dart index bdeaf0fd1..a455f51ac 100644 --- a/packages/riverpod_generator/test/notifier_test.dart +++ b/packages/riverpod_generator/test/notifier_test.dart @@ -89,8 +89,6 @@ void main() { familyClassProvider( 42, third: .42, - // ignore: avoid_redundant_argument_values - fourth: true, ), ); expect( @@ -98,8 +96,6 @@ void main() { familyClassProvider( 42, third: .42, - // ignore: avoid_redundant_argument_values - fourth: true, ).hashCode, ); diff --git a/packages/riverpod_generator/test/stream_notifier_test.dart b/packages/riverpod_generator/test/stream_notifier_test.dart index d066c4a8d..5de59ca8c 100644 --- a/packages/riverpod_generator/test/stream_notifier_test.dart +++ b/packages/riverpod_generator/test/stream_notifier_test.dart @@ -92,8 +92,6 @@ void main() { familyClassProvider( 42, third: .42, - // ignore: avoid_redundant_argument_values - fourth: true, ), ); expect( @@ -101,8 +99,6 @@ void main() { familyClassProvider( 42, third: .42, - // ignore: avoid_redundant_argument_values - fourth: true, ).hashCode, ); diff --git a/packages/riverpod_generator/test/stream_test.dart b/packages/riverpod_generator/test/stream_test.dart index 256715423..fc23c0e5c 100644 --- a/packages/riverpod_generator/test/stream_test.dart +++ b/packages/riverpod_generator/test/stream_test.dart @@ -82,8 +82,6 @@ void main() { familyProvider( 42, third: .42, - // ignore: avoid_redundant_argument_values - fourth: true, ), ); expect( @@ -91,8 +89,6 @@ void main() { familyProvider( 42, third: .42, - // ignore: avoid_redundant_argument_values - fourth: true, ).hashCode, ); diff --git a/packages/riverpod_generator/test/sync_test.dart b/packages/riverpod_generator/test/sync_test.dart index c678e548e..232f49a5f 100644 --- a/packages/riverpod_generator/test/sync_test.dart +++ b/packages/riverpod_generator/test/sync_test.dart @@ -236,8 +236,6 @@ void main() { familyProvider( 42, third: .42, - // ignore: avoid_redundant_argument_values - fourth: true, ), ); expect( @@ -245,8 +243,6 @@ void main() { familyProvider( 42, third: .42, - // ignore: avoid_redundant_argument_values - fourth: true, ).hashCode, ); diff --git a/packages/riverpod_graph/test/integration/addition/golden/lib/constructor_providers.dart b/packages/riverpod_graph/test/integration/addition/golden/lib/constructor_providers.dart index dabe06388..c6988e5f2 100644 --- a/packages/riverpod_graph/test/integration/addition/golden/lib/constructor_providers.dart +++ b/packages/riverpod_graph/test/integration/addition/golden/lib/constructor_providers.dart @@ -1,40 +1,30 @@ import 'package:riverpod/riverpod.dart'; -/// standard example Counter class class Counter { - /// docs Counter({this.value = 0}); - /// counter value late final int value; - /// immutable increment Counter increment() { return Counter(value: value + 1); } } -/// -///Extract from example -/// class MarvelRepository { - // ignore: public_member_api_docs MarvelRepository( this.ref, { int Function()? getCurrentTimestamp, }) : _getCurrentTimestamp = getCurrentTimestamp ?? (() => DateTime.now().millisecondsSinceEpoch); - /// final Ref ref; - /// final int Function() _getCurrentTimestamp; } /// taken from the marvel example /// referenced in marvelTearOffConsumer -final marvelRefdProvider = Provider(MarvelRepository.new); +final marvelRefProvider = Provider(MarvelRepository.new); /// not ref'd anywhere final marvelLostProvider = Provider(MarvelRepository.new); @@ -43,7 +33,6 @@ final marvelLostProvider = Provider(MarvelRepository.new); /// /// analyze.dart docs say: Providers must be either top level element or static element of classes. class MarvelLostProviderContainer { - /// creating a reference static final marvelLostProviderInContainer = Provider(MarvelRepository.new); } @@ -53,6 +42,6 @@ final marvelTearOffConsumer = Provider((ref) { // ignore: unused_element void doSomething() { // ignore: unused_local_variable - final theTime = ref.read(marvelRefdProvider)._getCurrentTimestamp; + final theTime = ref.read(marvelRefProvider)._getCurrentTimestamp; } }); diff --git a/packages/riverpod_graph/test/integration/analysis_options.yaml b/packages/riverpod_graph/test/integration/analysis_options.yaml new file mode 100644 index 000000000..063188e3d --- /dev/null +++ b/packages/riverpod_graph/test/integration/analysis_options.yaml @@ -0,0 +1,5 @@ +include: ../../../../analysis_options.yaml + +linter: + rules: + public_member_api_docs: false \ No newline at end of file diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart index 784349bbd..782cc41df 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart @@ -1,6 +1,6 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/source/source_range.dart'; -// ignore: implementation_imports, somehow not exported by analyzer +// ignore: implementation_imports, https://github.com/dart-lang/sdk/issues/54480 import 'package:analyzer/src/generated/source.dart' show Source; import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart index 24555fa7f..1dbfcf287 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart @@ -1,6 +1,7 @@ import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/source/source_range.dart'; -// ignore: implementation_imports, somehow not exported by analyzer +// ignore: implementation_imports, blocked by https://github.com/dart-lang/sdk/issues/54480 import 'package:analyzer/src/generated/source.dart' show Source; import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart b/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart index ed5c43299..5f53d52d8 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart @@ -1,5 +1,4 @@ import 'package:analyzer/dart/ast/ast.dart'; -// ignore: implementation_imports, somehow not exported by analyzer import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; diff --git a/packages/riverpod_lint_flutter_test/test/golden.dart b/packages/riverpod_lint_flutter_test/test/golden.dart index 646a103f8..94d5fe242 100644 --- a/packages/riverpod_lint_flutter_test/test/golden.dart +++ b/packages/riverpod_lint_flutter_test/test/golden.dart @@ -36,7 +36,7 @@ void testGolden( matcherNormalizedPrioritizedSourceChangeSnapshot(fileName), ); } on TestFailure { - // ignore: deprecated_member_use_from_same_package + // ignore: deprecated_member_use_from_same_package, deprecated only to avoid commit if (!goldenWrite) rethrow; final file = File('test/$fileName'); From 13200fca6f9e46ccbd1cf1de876aee3ce99b6644 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 30 Dec 2023 17:25:54 +0100 Subject: [PATCH 118/387] Update state_notifier export --- packages/riverpod/lib/riverpod.dart | 5 +++-- .../riverpod/lib/src/core/proxy_provider_listenable.dart | 2 +- packages/riverpod/test/new/core/provider_container_test.dart | 2 +- packages/riverpod/test/new/core/ref_test.dart | 2 +- .../legacy_providers/async_notifier/async_notifier_test.dart | 2 +- .../test/old/legacy_providers/notifier/notifier_test.dart | 2 +- .../stream_notifier/async_notifier_test.dart | 2 +- 7 files changed, 9 insertions(+), 8 deletions(-) diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 2242485e5..7bfb724c1 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -1,5 +1,6 @@ -// TODO this exports too many things -export 'package:state_notifier/state_notifier.dart' hide Listener, LocatorMixin; +// TODO CHANGELOG breaking: Riverpod now only re-exports StateNotifier from pkg:state_notifier. +// for other classes, please add state_notifier as dependency. +export 'package:state_notifier/state_notifier.dart' show StateNotifier; export 'src/core/async_value.dart' hide AsyncTransition; export 'src/framework.dart' diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index 20b95730f..71ed30e47 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -8,7 +8,7 @@ class _ProxySubscription extends ProviderSubscription { }); final ProviderSubscription innerSubscription; - final RemoveListener _removeListeners; + final void Function() _removeListeners; final T Function() _read; @override diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index 55820dca0..649430d9d 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -1,7 +1,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; -import 'package:riverpod/riverpod.dart' hide ErrorListener; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart index eb90d94b2..6ffed4e1b 100644 --- a/packages/riverpod/test/new/core/ref_test.dart +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -1,7 +1,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; -import 'package:riverpod/riverpod.dart' hide ErrorListener; +import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; import '../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart b/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart index a075ef95e..f48f932ef 100644 --- a/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart +++ b/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart @@ -4,7 +4,7 @@ import 'dart:async'; import 'package:meta/meta.dart'; import 'package:mockito/mockito.dart'; -import 'package:riverpod/riverpod.dart' hide ErrorListener; +import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; import '../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart b/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart index 3494e21c1..0716402a7 100644 --- a/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart +++ b/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart @@ -2,7 +2,7 @@ import 'package:meta/meta.dart'; import 'package:mockito/mockito.dart'; -import 'package:riverpod/riverpod.dart' hide ErrorListener; +import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; import '../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart b/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart index 73e6dc261..32face8f7 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart @@ -4,7 +4,7 @@ import 'dart:async'; import 'package:meta/meta.dart'; import 'package:mockito/mockito.dart'; -import 'package:riverpod/riverpod.dart' hide ErrorListener; +import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; import '../../utils.dart'; From a077c2d755796e6f7395aacc2c2dfb74e9ac494c Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 30 Dec 2023 17:40:26 +0100 Subject: [PATCH 119/387] Fix some todos --- .../flutter_riverpod/lib/src/framework.dart | 52 +++--- .../riverpod/lib/src/common/listenable.dart | 9 +- packages/riverpod/lib/src/core/element.dart | 157 ++++++------------ .../lib/src/core/override_with_value.dart | 27 +-- .../lib/src/core/provider_container.dart | 15 +- packages/riverpod/lib/src/core/select.dart | 16 +- .../riverpod/lib/src/core/select_async.dart | 16 +- packages/riverpod/lib/src/framework.dart | 1 - .../stream_provider/base.dart | 2 - packages/riverpod/test/new/core/ref_test.dart | 7 +- .../stream_provider/stream_provider_test.dart | 37 +++-- 11 files changed, 122 insertions(+), 217 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/framework.dart b/packages/flutter_riverpod/lib/src/framework.dart index 99f76ba1c..dfb5a4c21 100644 --- a/packages/flutter_riverpod/lib/src/framework.dart +++ b/packages/flutter_riverpod/lib/src/framework.dart @@ -168,13 +168,9 @@ class ProviderScopeState extends State { super.initState(); final parent = _getParent(); - assert( - () { - _debugParentOwner = parent; - return true; - }(), - '', - ); + if (kDebugMode) { + _debugParentOwner = parent; + } container = ProviderContainer( parent: parent, @@ -223,25 +219,23 @@ class ProviderScopeState extends State { } } + void _debugAssertParentDidNotChange() { + // didUpdateWidget already takes care of widget.parent change + if (widget.parent != null) return; + + final parent = _getParent(); + + if (parent != _debugParentOwner) { + throw UnsupportedError( + 'ProviderScope was rebuilt with a different ProviderScope ancestor', + ); + } + } + @override Widget build(BuildContext context) { - assert( - () { - if (widget.parent != null) { - // didUpdateWidget already takes care of widget.parent change - return true; - } - final parent = _getParent(); - - if (parent != _debugParentOwner) { - throw UnsupportedError( - 'ProviderScope was rebuilt with a different ProviderScope ancestor', - ); - } - return true; - }(), - '', - ); + if (kDebugMode) _debugAssertParentDidNotChange(); + if (_dirty) { _dirty = false; container.updateOverrides(widget.overrides); @@ -312,13 +306,9 @@ class _UncontrolledProviderScopeElement extends InheritedElement { @override void reassemble() { super.reassemble(); - assert( - () { - _containerOf(widget).debugReassemble(); - return true; - }(), - '', - ); + if (kDebugMode) { + _containerOf(widget).debugReassemble(); + } } void _flutterVsync(void Function() task) { diff --git a/packages/riverpod/lib/src/common/listenable.dart b/packages/riverpod/lib/src/common/listenable.dart index 0e9ff1820..3a9ef802c 100644 --- a/packages/riverpod/lib/src/common/listenable.dart +++ b/packages/riverpod/lib/src/common/listenable.dart @@ -2,6 +2,7 @@ import 'package:meta/meta.dart'; import '../framework.dart' show ProviderElementBase; import '../internals.dart' show OnError; +import 'env.dart'; import 'pragma.dart'; import 'result.dart'; @@ -230,13 +231,7 @@ class _ValueListenable { /// listeners or not immediately before disposal. @mustCallSuper void dispose() { - assert( - () { - _debugDisposed = true; - return true; - }(), - '', - ); + if (kDebugMode) _debugDisposed = true; _listeners = _emptyListeners(); _count = 0; } diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 68da578f9..cff8af291 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -142,7 +142,6 @@ abstract class ProviderElementBase implements Ref, Node { /// to expose a way to update the state, the practice is to expose a getter/setter. @internal void setState(State newState) { - // TODO remove all body asserts if (kDebugMode) _debugDidSetState = true; final previousResult = getState(); @@ -177,15 +176,11 @@ abstract class ProviderElementBase implements Ref, Node { 'Tried to read the state of an uninitialized provider. ' 'Do you maybe have a circular dependency?'; - assert( - () { - if (debugAssertDidSetStateEnabled && !_debugDidSetState) { - throw StateError(uninitializedError); - } - return true; - }(), - '', - ); + if (kDebugMode) { + if (debugAssertDidSetStateEnabled && !_debugDidSetState) { + throw StateError(uninitializedError); + } + } final state = getState(); if (state == null) throw StateError(uninitializedError); @@ -210,33 +205,22 @@ abstract class ProviderElementBase implements Ref, Node { /// This life-cycle is used to check for change in [ProviderBase.debugGetCreateSourceHash], /// and invalidate the provider state on change. void debugReassemble() { - assert( - () { - final previousHash = _debugCurrentCreateHash; - _debugCurrentCreateHash = provider.debugGetCreateSourceHash?.call(); + final previousHash = _debugCurrentCreateHash; + _debugCurrentCreateHash = provider.debugGetCreateSourceHash?.call(); - if (previousHash != _debugCurrentCreateHash) { - invalidateSelf(); - } - - return true; - }(), - '', - ); + if (previousHash != _debugCurrentCreateHash) { + invalidateSelf(); + } } /// Called the first time a provider is obtained. @internal void mount() { _mounted = true; - assert( - () { - _debugCurrentCreateHash = provider.debugGetCreateSourceHash?.call(); + if (kDebugMode) { + _debugCurrentCreateHash = provider.debugGetCreateSourceHash?.call(); + } - return true; - }(), - '', - ); buildState(); _state!.map( @@ -370,33 +354,18 @@ abstract class ProviderElementBase implements Ref, Node { final previousStateResult = _state; - assert( - () { - _debugDidSetState = false; - return true; - }(), - '', - ); + if (kDebugMode) _debugDidSetState = false; + buildState(); if (!identical(_state, previousStateResult)) { - assert( - () { - // Asserts would otherwise prevent a provider rebuild from updating - // other providers - _debugSkipNotifyListenersAsserts = true; - return true; - }(), - '', - ); + // Asserts would otherwise prevent a provider rebuild from updating + // other providers + if (kDebugMode) _debugSkipNotifyListenersAsserts = true; + _notifyListeners(_state!, previousStateResult); - assert( - () { - _debugSkipNotifyListenersAsserts = false; - return true; - }(), - '', - ); + + if (kDebugMode) _debugSkipNotifyListenersAsserts = false; } // Unsubscribe to everything that a provider no longer depends on. @@ -426,37 +395,25 @@ abstract class ProviderElementBase implements Ref, Node { ProviderElementBase? debugPreviouslyBuildingElement; final previousDidChangeDependency = _didChangeDependency; _didChangeDependency = false; - assert( - () { - debugPreviouslyBuildingElement = _debugCurrentlyBuildingElement; - _debugCurrentlyBuildingElement = this; - return true; - }(), - '', - ); + if (kDebugMode) { + debugPreviouslyBuildingElement = _debugCurrentlyBuildingElement; + _debugCurrentlyBuildingElement = this; + } + _didBuild = false; try { // TODO move outside this function? _mounted = true; create(didChangeDependency: previousDidChangeDependency); } catch (err, stack) { - assert( - () { - _debugDidSetState = true; - return true; - }(), - '', - ); + if (kDebugMode) _debugDidSetState = true; + _state = Result.error(err, stack); } finally { _didBuild = true; - assert( - () { - _debugCurrentlyBuildingElement = debugPreviouslyBuildingElement; - return true; - }(), - '', - ); + if (kDebugMode) { + _debugCurrentlyBuildingElement = debugPreviouslyBuildingElement; + } assert( getState() != null, @@ -481,31 +438,29 @@ abstract class ProviderElementBase implements Ref, Node { } } - void _notifyListeners( - Result newState, - Result? previousStateResult, { - bool checkUpdateShouldNotify = true, - }) { - assert( - () { - if (_debugSkipNotifyListenersAsserts) return true; + void _debugAssertNotificationAllowed() { + if (_debugSkipNotifyListenersAsserts) return; - assert( - _debugCurrentlyBuildingElement == null || - _debugCurrentlyBuildingElement == this, - ''' + assert( + _debugCurrentlyBuildingElement == null || + _debugCurrentlyBuildingElement == this, + ''' Providers are not allowed to modify other providers during their initialization. The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while building. ''', - ); - - debugCanModifyProviders?.call(); - return true; - }(), - '', ); + debugCanModifyProviders?.call(); + } + + void _notifyListeners( + Result newState, + Result? previousStateResult, { + bool checkUpdateShouldNotify = true, + }) { + if (kDebugMode) _debugAssertNotificationAllowed(); + final previousState = previousStateResult?.stateOrNull; // listenSelf listeners do not respect updateShouldNotify @@ -737,17 +692,13 @@ final = Provider(dependencies: []); return previousSub; } - assert( - () { - // Flushing the provider before adding a new dependency - // as otherwise this could cause false positives with certain asserts. - // It's done only in debug mode since `readSelf` will flush the value - // again anyway, and the only value of this flush is to not break asserts. - element.flush(); - return true; - }(), - '', - ); + if (kDebugMode) { + // Flushing the provider before adding a new dependency + // as otherwise this could cause false positives with certain asserts. + // It's done only in debug mode since `readSelf` will flush the value + // again anyway, and the only value of this flush is to not break asserts. + element.flush(); + } element .._onListen() diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index f220d63be..d351d99bb 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -55,25 +55,16 @@ class ValueProviderElement extends ProviderElementBase { final previousState = getState()! as ResultData; if (newValue != previousState.state) { - assert( - () { - // Asserts would otherwise prevent a provider rebuild from updating - // other providers - _debugSkipNotifyListenersAsserts = true; - return true; - }(), - '', - ); + // Asserts would otherwise prevent a provider rebuild from updating + // other providers + if (kDebugMode) _debugSkipNotifyListenersAsserts = true; + setState(newValue); - assert( - () { - // Asserts would otherwise prevent a provider rebuild from updating - // other providers - _debugSkipNotifyListenersAsserts = false; - return true; - }(), - '', - ); + + // Asserts would otherwise prevent a provider rebuild from updating + // other providers + if (kDebugMode) _debugSkipNotifyListenersAsserts = false; + onChange?.call(newValue); } } diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 70c874856..12beff768 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -708,16 +708,11 @@ class ProviderContainer implements Node { // TODO hot-reload handle family adding parameters // TODO found "Future already completed error" after adding family parameter - assert( - () { - for (final element in getAllProviderElements()) { - element.debugReassemble(); - } - - return true; - }(), - '', - ); + if (kDebugMode) { + for (final element in getAllProviderElements()) { + element.debugReassemble(); + } + } } @override diff --git a/packages/riverpod/lib/src/core/select.dart b/packages/riverpod/lib/src/core/select.dart index b017d0627..77d4d7049 100644 --- a/packages/riverpod/lib/src/core/select.dart +++ b/packages/riverpod/lib/src/core/select.dart @@ -46,13 +46,7 @@ class _ProviderSelector with ProviderListenable { final Output Function(Input) selector; Result _select(Result value) { - assert( - () { - _debugIsRunningSelector = true; - return true; - }(), - '', - ); + if (kDebugMode) _debugIsRunningSelector = true; try { return value.map( @@ -64,13 +58,7 @@ class _ProviderSelector with ProviderListenable { // TODO test return Result.error(err, stack); } finally { - assert( - () { - _debugIsRunningSelector = false; - return true; - }(), - '', - ); + if (kDebugMode) _debugIsRunningSelector = false; } } diff --git a/packages/riverpod/lib/src/core/select_async.dart b/packages/riverpod/lib/src/core/select_async.dart index 8b8bf7346..1e4c4426a 100644 --- a/packages/riverpod/lib/src/core/select_async.dart +++ b/packages/riverpod/lib/src/core/select_async.dart @@ -84,26 +84,14 @@ class _AsyncSelector with ProviderListenable> { final Output Function(Input) selector; Result _select(Input value) { - assert( - () { - _debugIsRunningSelector = true; - return true; - }(), - '', - ); + if (kDebugMode) _debugIsRunningSelector = true; try { return Result.data(selector(value)); } catch (err, stack) { return Result.error(err, stack); } finally { - assert( - () { - _debugIsRunningSelector = false; - return true; - }(), - '', - ); + if (kDebugMode) _debugIsRunningSelector = false; } } diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index 3e84bcb3c..868b8dfe3 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -6,7 +6,6 @@ import 'dart:collection'; import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; import 'package:test/test.dart' as test; -import '../riverpod.dart'; import 'common/env.dart'; import 'internals.dart'; diff --git a/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart index 34b01ffa9..8307e1a5d 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart @@ -143,8 +143,6 @@ class StreamProviderElement extends ProviderElementBase> @internal StreamProviderElement(this.provider, super.container); - // TODO remove all ignores - @override final _StreamProviderBase provider; diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart index 6ffed4e1b..68a0240ce 100644 --- a/packages/riverpod/test/new/core/ref_test.dart +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -384,8 +384,11 @@ void main() { return 0; }); - container.listen(provider, (prev, next) {}, - onError: errorListener2.call); + container.listen( + provider, + (prev, next) {}, + onError: errorListener2.call, + ); verifyZeroInteractions(errorListener); verifyZeroInteractions(errorListener2); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart index 2894fbb80..947b690ce 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart @@ -9,20 +9,6 @@ import 'package:test/test.dart'; import '../../utils.dart'; void main() { - late StreamController controller; - final provider = StreamProvider((ref) => controller.stream); - late ProviderContainer container; - - // TODO remove this setup/teardown - setUp(() { - container = ProviderContainer.test(); - controller = StreamController(sync: true); - }); - tearDown(() { - container.dispose(); - controller.close(); - }); - test('supports overrideWith', () { final provider = StreamProvider( (ref) { @@ -300,7 +286,7 @@ void main() { expect(container.read(provider), const AsyncValue.data(1)); }); - group('scoping an override overrides all the associated subproviders', () { + group('scoping an override overrides all the associated sub-providers', () { test('when passing the provider itself', () async { final provider = StreamProvider( (ref) => Stream.value(0), @@ -375,6 +361,11 @@ void main() { }); test('Loading to data', () { + final container = ProviderContainer.test(); + final controller = StreamController(sync: true); + addTearDown(() => controller.close); + final provider = StreamProvider((ref) => controller.stream); + expect(container.read(provider), const AsyncValue.loading()); controller.add(42); @@ -383,6 +374,11 @@ void main() { }); test('Loading to error', () { + final container = ProviderContainer.test(); + final controller = StreamController(sync: true); + addTearDown(() => controller.close); + final provider = StreamProvider((ref) => controller.stream); + expect(container.read(provider), const AsyncValue.loading()); final stack = StackTrace.current; @@ -595,6 +591,11 @@ void main() { // }); test('does not filter identical values', () async { + final container = ProviderContainer.test(); + final controller = StreamController(sync: true); + addTearDown(() => controller.close); + final provider = StreamProvider((ref) => controller.stream); + final sub = container.listen(provider, (_, __) {}); expect(sub.read(), const AsyncValue.loading()); @@ -611,6 +612,8 @@ void main() { }); test('throwing inside "create" result in an AsyncValue.error', () { + final container = ProviderContainer.test(); + // ignore: only_throw_errors final provider = StreamProvider((ref) => throw 42); @@ -622,6 +625,8 @@ void main() { test('does not update dependents if the created stream did not change', () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); final provider = StreamProvider((ref) { ref.watch(dep); @@ -642,6 +647,8 @@ void main() { test( '.future does not update dependents if the created future did not change', () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); final provider = StreamProvider((ref) { From f7d76d8922747946d994ab2bdbf8cbd2c16253ab Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 30 Dec 2023 17:41:26 +0100 Subject: [PATCH 120/387] Fix lints --- packages/flutter_riverpod/test/listen_test.dart | 2 +- .../lib/src/assists/convert_to_stateless_base_widget.dart | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/flutter_riverpod/test/listen_test.dart b/packages/flutter_riverpod/test/listen_test.dart index 3c56c9696..a70ca4b9c 100644 --- a/packages/flutter_riverpod/test/listen_test.dart +++ b/packages/flutter_riverpod/test/listen_test.dart @@ -1,7 +1,7 @@ import 'dart:async'; import 'package:flutter/material.dart' hide Listener; -import 'package:flutter_riverpod/flutter_riverpod.dart' hide ErrorListener; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart index 1dbfcf287..245f39a9a 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart @@ -1,5 +1,4 @@ import 'package:analyzer/dart/ast/ast.dart'; -import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/source/source_range.dart'; // ignore: implementation_imports, blocked by https://github.com/dart-lang/sdk/issues/54480 import 'package:analyzer/src/generated/source.dart' show Source; From e194b99b9bb24ae766c0fae2fdb79e80cb2cb455 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 30 Dec 2023 17:46:20 +0100 Subject: [PATCH 121/387] Move flutter_riverpod folders --- .../lib/flutter_riverpod.dart | 3 +- packages/flutter_riverpod/lib/src/core.dart | 11 + .../lib/src/{ => core}/consumer.dart | 242 +----------------- .../provider_scope.dart} | 10 +- .../lib/src/core/widget_ref.dart | 238 +++++++++++++++++ .../flutter_riverpod/lib/src/internals.dart | 3 +- 6 files changed, 253 insertions(+), 254 deletions(-) create mode 100644 packages/flutter_riverpod/lib/src/core.dart rename packages/flutter_riverpod/lib/src/{ => core}/consumer.dart (60%) rename packages/flutter_riverpod/lib/src/{framework.dart => core/provider_scope.dart} (97%) create mode 100644 packages/flutter_riverpod/lib/src/core/widget_ref.dart diff --git a/packages/flutter_riverpod/lib/flutter_riverpod.dart b/packages/flutter_riverpod/lib/flutter_riverpod.dart index a08858e1a..d7600ee45 100644 --- a/packages/flutter_riverpod/lib/flutter_riverpod.dart +++ b/packages/flutter_riverpod/lib/flutter_riverpod.dart @@ -1,5 +1,4 @@ export 'package:riverpod/riverpod.dart'; -export 'src/consumer.dart'; -export 'src/framework.dart' hide ProviderScopeState; +export 'src/core.dart' hide ProviderScopeState; export 'src/legacy/deprecated/change_notifier_provider.dart'; diff --git a/packages/flutter_riverpod/lib/src/core.dart b/packages/flutter_riverpod/lib/src/core.dart new file mode 100644 index 000000000..2cdebf013 --- /dev/null +++ b/packages/flutter_riverpod/lib/src/core.dart @@ -0,0 +1,11 @@ +import 'package:flutter/foundation.dart' hide describeIdentity; +import 'package:flutter/material.dart'; +import 'package:flutter/scheduler.dart'; +import 'package:flutter/widgets.dart'; +import 'package:meta/meta.dart'; + +import './internals.dart'; + +part 'core/consumer.dart'; +part 'core/provider_scope.dart'; +part 'core/widget_ref.dart'; diff --git a/packages/flutter_riverpod/lib/src/consumer.dart b/packages/flutter_riverpod/lib/src/core/consumer.dart similarity index 60% rename from packages/flutter_riverpod/lib/src/consumer.dart rename to packages/flutter_riverpod/lib/src/core/consumer.dart index aeeb21535..6e50c5e99 100644 --- a/packages/flutter_riverpod/lib/src/consumer.dart +++ b/packages/flutter_riverpod/lib/src/core/consumer.dart @@ -1,244 +1,4 @@ -import 'package:flutter/widgets.dart'; -import 'package:meta/meta.dart'; - -import 'internals.dart'; - -/// An object that allows widgets to interact with providers. -abstract class WidgetRef { - /// The [BuildContext] of the widget associated to this [WidgetRef]. - /// - /// This is strictly identical to the [BuildContext] passed to [ConsumerWidget.build]. - BuildContext get context; - - /// Returns the value exposed by a provider and rebuild the widget when that - /// value changes. - /// - /// See also: - /// - /// - [ProviderListenable.select], which allows a widget to filter rebuilds by - /// observing only the selected properties. - /// - [listen], to react to changes on a provider, such as for showing modals. - T watch(ProviderListenable provider); - - /// Determines whether a provider is initialized or not. - /// - /// Writing logic that conditionally depends on the existence of a provider - /// is generally unsafe and should be avoided. - /// The problem is that once the provider gets initialized, logic that - /// depends on the existence or not of a provider won't be rerun; possibly - /// causing your state to get out of date. - /// - /// But it can be useful in some cases, such as to avoid re-fetching an - /// object if a different network request already obtained it: - /// - /// ```dart - /// final fetchItemList = FutureProvider>(...); - /// - /// final fetchItem = FutureProvider.autoDispose.family((ref, id) async { - /// if (ref.exists(fetchItemList)) { - /// // If `fetchItemList` is initialized, we look into its state - /// // and return the already obtained item. - /// final itemFromItemList = await ref.watch( - /// fetchItemList.selectAsync((items) => items.firstWhereOrNull((item) => item.id == id)), - /// ); - /// if (itemFromItemList != null) return itemFromItemList; - /// } - /// - /// // If `fetchItemList` is not initialized, perform a network request for - /// // "id" separately - /// - /// final json = await http.get('api/items/$id'); - /// return Item.fromJson(json); - /// }); - /// ``` - bool exists(ProviderBase provider); - - /// Listen to a provider and call `listener` whenever its value changes, - /// without having to take care of removing the listener. - /// - /// The [listen] method should exclusively be used within the `build` method - /// of a widget: - /// - /// ```dart - /// Consumer( - /// builder: (context, ref, child) { - /// ref.listen(counterProvider, (prev, next) { - /// print('counter changed $next'); - /// }); - /// }, - /// ) - /// ``` - /// - /// When used inside `build`, listeners will automatically be removed - /// if a widget rebuilds and stops listening to a provider. - /// - /// For listening to a provider from outside `build`, consider using [listenManual] instead. - /// - /// This is useful for showing modals or other imperative logic. - void listen( - ProviderListenable provider, - void Function(T? previous, T next) listener, { - void Function(Object error, StackTrace stackTrace)? onError, - }); - - /// Listen to a provider and call `listener` whenever its value changes. - /// - /// As opposed to [listen], [listenManual] is not safe to use within the `build` - /// method of a widget. - /// Instead, [listenManual] is designed to be used inside [State.initState] or - /// other [State] lifecycle. - /// - /// [listenManual] returns a [ProviderSubscription] which can be used to stop - /// listening to the provider, or to read the current value exposed by - /// the provider. - /// - /// It is not necessary to call [ProviderSubscription.close] inside [State.dispose]. - /// When the widget that calls [listenManual] is disposed, the subscription - /// will be disposed automatically. - ProviderSubscription listenManual( - ProviderListenable provider, - void Function(T? previous, T next) listener, { - void Function(Object error, StackTrace stackTrace)? onError, - bool fireImmediately, - }); - - /// Reads a provider without listening to it. - /// - /// **AVOID** calling [read] inside build if the value is used only for events: - /// - /// ```dart - /// Widget build(BuildContext context) { - /// // counter is used only for the onPressed of RaisedButton - /// final counter = ref.read(counterProvider); - /// - /// return RaisedButton( - /// onPressed: () => counter.increment(), - /// ); - /// } - /// ``` - /// - /// While this code is not bugged in itself, this is an anti-pattern. - /// It could easily lead to bugs in the future after refactoring the widget - /// to use `counter` for other things, but forget to change [read] into [Consumer]/`ref.watch(`. - /// - /// **CONSIDER** calling [read] inside event handlers: - /// - /// ```dart - /// Widget build(BuildContext context) { - /// return RaisedButton( - /// onPressed: () { - /// // as performant as the previous solution, but resilient to refactoring - /// ref.read(counterProvider).increment(), - /// }, - /// ); - /// } - /// ``` - /// - /// This has the same efficiency as the previous anti-pattern, but does not - /// suffer from the drawback of being brittle. - /// - /// **AVOID** using [read] for creating widgets with a value that never changes - /// - /// ```dart - /// Widget build(BuildContext context) { - /// // using read because we only use a value that never changes. - /// final model = ref.read(modelProvider); - /// - /// return Text('${model.valueThatNeverChanges}'); - /// } - /// ``` - /// - /// While the idea of not rebuilding the widget if unnecessary is good, - /// this should not be done with [read]. - /// Relying on [read] for optimisations is very brittle and dependent - /// on an implementation detail. - /// - /// **CONSIDER** using [Provider] or `select` for filtering unwanted rebuilds: - /// - /// ```dart - /// Widget build(BuildContext context) { - /// // Using select to listen only to the value that used - /// final valueThatNeverChanges = ref.watch(modelProvider.select((model) { - /// return model.valueThatNeverChanges; - /// })); - /// - /// return Text('$valueThatNeverChanges'); - /// } - /// ``` - /// - /// While more verbose than [read], using [Provider]/`select` is a lot safer. - /// It does not rely on implementation details on `Model`, and it makes - /// impossible to have a bug where our UI does not refresh. - T read(ProviderListenable provider); - - /// Forces a provider to re-evaluate its state immediately, and return the created value. - /// - /// Writing: - /// - /// ```dart - /// final newValue = ref.refresh(provider); - /// ``` - /// - /// is strictly identical to doing: - /// - /// ```dart - /// ref.invalidate(provider); - /// final newValue = ref.read(provider); - /// ``` - /// - /// If you do not care about the return value of [refresh], use [invalidate] instead. - /// Doing so has the benefit of: - /// - making the invalidation logic more resilient by avoiding multiple - /// refreshes at once. - /// - possibly avoids recomputing a provider if it isn't - /// needed immediately. - /// - /// This method is useful for features like "pull to refresh" or "retry on error", - /// to restart a specific provider. - /// - /// For example, a pull-to-refresh may be implemented by combining - /// [FutureProvider] and a `RefreshIndicator`: - /// - /// ```dart - /// final productsProvider = FutureProvider((ref) async { - /// final response = await httpClient.get('https://host.com/products'); - /// return Products.fromJson(response.data); - /// }); - /// - /// class Example extends ConsumerWidget { - /// @override - /// Widget build(BuildContext context, WidgetRef ref) { - /// final Products products = ref.watch(productsProvider); - /// - /// return RefreshIndicator( - /// onRefresh: () => ref.refresh(productsProvider.future), - /// child: ListView( - /// children: [ - /// for (final product in products.items) ProductItem(product: product), - /// ], - /// ), - /// ); - /// } - /// } - /// ``` - @useResult - State refresh(Refreshable provider); - - /// Invalidates the state of the provider, causing it to refresh. - /// - /// As opposed to [refresh], the refresh is not immediate and is instead - /// delayed to the next read or next frame. - /// - /// Calling [invalidate] multiple times will refresh the provider only - /// once. - /// - /// Calling [invalidate] will cause the provider to be disposed immediately. - /// - /// If used on a provider which is not initialized, this method will have no effect. - void invalidate(ProviderOrFamily provider); - - // TODO reload -} +part of '../core.dart'; /// A function that can also listen to providers /// diff --git a/packages/flutter_riverpod/lib/src/framework.dart b/packages/flutter_riverpod/lib/src/core/provider_scope.dart similarity index 97% rename from packages/flutter_riverpod/lib/src/framework.dart rename to packages/flutter_riverpod/lib/src/core/provider_scope.dart index dfb5a4c21..6b74ea797 100644 --- a/packages/flutter_riverpod/lib/src/framework.dart +++ b/packages/flutter_riverpod/lib/src/core/provider_scope.dart @@ -1,12 +1,5 @@ // ignore_for_file: invalid_use_of_internal_member - -import 'package:flutter/foundation.dart' hide describeIdentity; -import 'package:flutter/material.dart'; -import 'package:flutter/scheduler.dart'; -import 'package:flutter/widgets.dart'; -import 'package:meta/meta.dart'; - -import 'internals.dart'; +part of '../core.dart'; /// {@template riverpod.provider_scope} /// A widget that stores the state of providers. @@ -76,7 +69,6 @@ import 'internals.dart'; /// - [UncontrolledProviderScope], which exposes a [ProviderContainer] to the widget /// tree without managing its life-cycles. /// {@endtemplate} -@sealed class ProviderScope extends StatefulWidget { /// {@macro riverpod.provider_scope} const ProviderScope({ diff --git a/packages/flutter_riverpod/lib/src/core/widget_ref.dart b/packages/flutter_riverpod/lib/src/core/widget_ref.dart new file mode 100644 index 000000000..a0c6b7079 --- /dev/null +++ b/packages/flutter_riverpod/lib/src/core/widget_ref.dart @@ -0,0 +1,238 @@ +part of '../core.dart'; + +/// An object that allows widgets to interact with providers. +abstract class WidgetRef { + /// The [BuildContext] of the widget associated to this [WidgetRef]. + /// + /// This is strictly identical to the [BuildContext] passed to [ConsumerWidget.build]. + BuildContext get context; + + /// Returns the value exposed by a provider and rebuild the widget when that + /// value changes. + /// + /// See also: + /// + /// - [ProviderListenable.select], which allows a widget to filter rebuilds by + /// observing only the selected properties. + /// - [listen], to react to changes on a provider, such as for showing modals. + T watch(ProviderListenable provider); + + /// Determines whether a provider is initialized or not. + /// + /// Writing logic that conditionally depends on the existence of a provider + /// is generally unsafe and should be avoided. + /// The problem is that once the provider gets initialized, logic that + /// depends on the existence or not of a provider won't be rerun; possibly + /// causing your state to get out of date. + /// + /// But it can be useful in some cases, such as to avoid re-fetching an + /// object if a different network request already obtained it: + /// + /// ```dart + /// final fetchItemList = FutureProvider>(...); + /// + /// final fetchItem = FutureProvider.autoDispose.family((ref, id) async { + /// if (ref.exists(fetchItemList)) { + /// // If `fetchItemList` is initialized, we look into its state + /// // and return the already obtained item. + /// final itemFromItemList = await ref.watch( + /// fetchItemList.selectAsync((items) => items.firstWhereOrNull((item) => item.id == id)), + /// ); + /// if (itemFromItemList != null) return itemFromItemList; + /// } + /// + /// // If `fetchItemList` is not initialized, perform a network request for + /// // "id" separately + /// + /// final json = await http.get('api/items/$id'); + /// return Item.fromJson(json); + /// }); + /// ``` + bool exists(ProviderBase provider); + + /// Listen to a provider and call `listener` whenever its value changes, + /// without having to take care of removing the listener. + /// + /// The [listen] method should exclusively be used within the `build` method + /// of a widget: + /// + /// ```dart + /// Consumer( + /// builder: (context, ref, child) { + /// ref.listen(counterProvider, (prev, next) { + /// print('counter changed $next'); + /// }); + /// }, + /// ) + /// ``` + /// + /// When used inside `build`, listeners will automatically be removed + /// if a widget rebuilds and stops listening to a provider. + /// + /// For listening to a provider from outside `build`, consider using [listenManual] instead. + /// + /// This is useful for showing modals or other imperative logic. + void listen( + ProviderListenable provider, + void Function(T? previous, T next) listener, { + void Function(Object error, StackTrace stackTrace)? onError, + }); + + /// Listen to a provider and call `listener` whenever its value changes. + /// + /// As opposed to [listen], [listenManual] is not safe to use within the `build` + /// method of a widget. + /// Instead, [listenManual] is designed to be used inside [State.initState] or + /// other [State] lifecycle. + /// + /// [listenManual] returns a [ProviderSubscription] which can be used to stop + /// listening to the provider, or to read the current value exposed by + /// the provider. + /// + /// It is not necessary to call [ProviderSubscription.close] inside [State.dispose]. + /// When the widget that calls [listenManual] is disposed, the subscription + /// will be disposed automatically. + ProviderSubscription listenManual( + ProviderListenable provider, + void Function(T? previous, T next) listener, { + void Function(Object error, StackTrace stackTrace)? onError, + bool fireImmediately, + }); + + /// Reads a provider without listening to it. + /// + /// **AVOID** calling [read] inside build if the value is used only for events: + /// + /// ```dart + /// Widget build(BuildContext context) { + /// // counter is used only for the onPressed of RaisedButton + /// final counter = ref.read(counterProvider); + /// + /// return RaisedButton( + /// onPressed: () => counter.increment(), + /// ); + /// } + /// ``` + /// + /// While this code is not bugged in itself, this is an anti-pattern. + /// It could easily lead to bugs in the future after refactoring the widget + /// to use `counter` for other things, but forget to change [read] into [Consumer]/`ref.watch(`. + /// + /// **CONSIDER** calling [read] inside event handlers: + /// + /// ```dart + /// Widget build(BuildContext context) { + /// return RaisedButton( + /// onPressed: () { + /// // as performant as the previous solution, but resilient to refactoring + /// ref.read(counterProvider).increment(), + /// }, + /// ); + /// } + /// ``` + /// + /// This has the same efficiency as the previous anti-pattern, but does not + /// suffer from the drawback of being brittle. + /// + /// **AVOID** using [read] for creating widgets with a value that never changes + /// + /// ```dart + /// Widget build(BuildContext context) { + /// // using read because we only use a value that never changes. + /// final model = ref.read(modelProvider); + /// + /// return Text('${model.valueThatNeverChanges}'); + /// } + /// ``` + /// + /// While the idea of not rebuilding the widget if unnecessary is good, + /// this should not be done with [read]. + /// Relying on [read] for optimisations is very brittle and dependent + /// on an implementation detail. + /// + /// **CONSIDER** using [Provider] or `select` for filtering unwanted rebuilds: + /// + /// ```dart + /// Widget build(BuildContext context) { + /// // Using select to listen only to the value that used + /// final valueThatNeverChanges = ref.watch(modelProvider.select((model) { + /// return model.valueThatNeverChanges; + /// })); + /// + /// return Text('$valueThatNeverChanges'); + /// } + /// ``` + /// + /// While more verbose than [read], using [Provider]/`select` is a lot safer. + /// It does not rely on implementation details on `Model`, and it makes + /// impossible to have a bug where our UI does not refresh. + T read(ProviderListenable provider); + + /// Forces a provider to re-evaluate its state immediately, and return the created value. + /// + /// Writing: + /// + /// ```dart + /// final newValue = ref.refresh(provider); + /// ``` + /// + /// is strictly identical to doing: + /// + /// ```dart + /// ref.invalidate(provider); + /// final newValue = ref.read(provider); + /// ``` + /// + /// If you do not care about the return value of [refresh], use [invalidate] instead. + /// Doing so has the benefit of: + /// - making the invalidation logic more resilient by avoiding multiple + /// refreshes at once. + /// - possibly avoids recomputing a provider if it isn't + /// needed immediately. + /// + /// This method is useful for features like "pull to refresh" or "retry on error", + /// to restart a specific provider. + /// + /// For example, a pull-to-refresh may be implemented by combining + /// [FutureProvider] and a `RefreshIndicator`: + /// + /// ```dart + /// final productsProvider = FutureProvider((ref) async { + /// final response = await httpClient.get('https://host.com/products'); + /// return Products.fromJson(response.data); + /// }); + /// + /// class Example extends ConsumerWidget { + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// final Products products = ref.watch(productsProvider); + /// + /// return RefreshIndicator( + /// onRefresh: () => ref.refresh(productsProvider.future), + /// child: ListView( + /// children: [ + /// for (final product in products.items) ProductItem(product: product), + /// ], + /// ), + /// ); + /// } + /// } + /// ``` + @useResult + State refresh(Refreshable provider); + + /// Invalidates the state of the provider, causing it to refresh. + /// + /// As opposed to [refresh], the refresh is not immediate and is instead + /// delayed to the next read or next frame. + /// + /// Calling [invalidate] multiple times will refresh the provider only + /// once. + /// + /// Calling [invalidate] will cause the provider to be disposed immediately. + /// + /// If used on a provider which is not initialized, this method will have no effect. + void invalidate(ProviderOrFamily provider); + + // TODO reload +} diff --git a/packages/flutter_riverpod/lib/src/internals.dart b/packages/flutter_riverpod/lib/src/internals.dart index 6395cb62b..67419df19 100644 --- a/packages/flutter_riverpod/lib/src/internals.dart +++ b/packages/flutter_riverpod/lib/src/internals.dart @@ -1,5 +1,4 @@ export 'package:riverpod/src/internals.dart'; -export 'consumer.dart'; -export 'framework.dart'; +export './core.dart'; export 'legacy/deprecated/change_notifier_provider.dart'; From ccb7765b34ee19b5203e0eba9b0ee4cfe75c239f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 30 Dec 2023 17:57:18 +0100 Subject: [PATCH 122/387] More some tests --- .../core}/provider_observer_test.dart | 8 +- packages/riverpod/test/new/core/ref_test.dart | 379 ++++++++++++++++- .../core}/select_async_test.dart | 0 .../core}/uni_directional_test.dart | 14 +- .../core}/visit_states_test.dart | 0 packages/riverpod/test/new/utils.dart | 82 ++++ .../riverpod/test/old/framework/ref_test.dart | 383 ------------------ 7 files changed, 468 insertions(+), 398 deletions(-) rename packages/riverpod/test/{old/framework => new/core}/provider_observer_test.dart (99%) rename packages/riverpod/test/{old/framework => new/core}/select_async_test.dart (100%) rename packages/riverpod/test/{old/framework => new/core}/uni_directional_test.dart (96%) rename packages/riverpod/test/{old/framework => new/core}/visit_states_test.dart (100%) delete mode 100644 packages/riverpod/test/old/framework/ref_test.dart diff --git a/packages/riverpod/test/old/framework/provider_observer_test.dart b/packages/riverpod/test/new/core/provider_observer_test.dart similarity index 99% rename from packages/riverpod/test/old/framework/provider_observer_test.dart rename to packages/riverpod/test/new/core/provider_observer_test.dart index 0d2d87b6a..ddb138b33 100644 --- a/packages/riverpod/test/old/framework/provider_observer_test.dart +++ b/packages/riverpod/test/new/core/provider_observer_test.dart @@ -20,7 +20,7 @@ void main() { observer.providerDidFail(provider, 0, StackTrace.empty, container); }); - test('ProviderObservers can have const constructors', () { + test('can have const constructors', () { final root = ProviderContainer.test( observers: [ const ConstObserver(), @@ -256,7 +256,7 @@ void main() { ]); verifyNoMoreInteractions(observer); - counter.setState(-10); + counter.state = -10; await container.pump(); verifyInOrder([ @@ -701,8 +701,8 @@ class Counter extends StateNotifier { void increment() => state++; - // ignore: use_setters_to_change_properties - void setState(int value) => state = value; + @override + abstract int state; } class ConstObserver extends ProviderObserver { diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart index 68a0240ce..3614537d4 100644 --- a/packages/riverpod/test/new/core/ref_test.dart +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -30,6 +30,47 @@ void main() { group('Ref', () { // TODO ref.invalidate does not mount providers if they are not already mounted + test( + 'cannot call ref.watch/ref.read/ref.listen/ref.onDispose after a dependency changed', + () { + // TODO assert invalidate & co also throw + late Ref ref; + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final provider = Provider((r) { + r.watch(dep); + ref = r; + }); + + container.read(provider); + + container.read(dep.notifier).state++; + + final another = Provider((ref) => 0); + + expect( + () => ref.watch(another), + throwsA(isA()), + ); + expect( + () => ref.refresh(another), + throwsA(isA()), + ); + expect( + () => ref.read(another), + throwsA(isA()), + ); + expect( + () => ref.onDispose(() {}), + throwsA(isA()), + ); + expect( + () => ref.listen(another, (_, __) {}), + throwsA(isA()), + ); + }, + ); + group( 'asserts that a provider cannot depend on a provider that is not in its dependencies:', () { @@ -196,7 +237,7 @@ void main() { } }); - group('Ref.listenSelf', () { + group('listenSelf', () { test('does not break autoDispose', () async { final container = ProviderContainer.test(); final provider = Provider.autoDispose((ref) { @@ -437,7 +478,137 @@ void main() { test('listeners are not allowed to modify the state', () {}); }); - group('Ref.listen', () { + group('listen', () { + test('ref.listen on outdated provider causes it to rebuild', () { + final dep = StateProvider((ref) => 0); + var buildCount = 0; + final provider = Provider((ref) { + buildCount++; + return ref.watch(dep); + }); + final listener = Listener(); + final another = Provider((ref) { + ref.listen(provider, listener.call, fireImmediately: true); + }); + final container = ProviderContainer.test(); + + expect(container.read(provider), 0); + expect(buildCount, 1); + + container.read(dep.notifier).state = 42; + + expect(buildCount, 1); + + container.read(another); + + expect(buildCount, 2); + verifyOnly(listener, listener(null, 42)); + }); + + test('can downcast the value', () async { + final listener = Listener(); + final dep = StateProvider((ref) => 0); + final provider = Provider((ref) { + ref.listen(dep, listener.call); + }); + + final container = ProviderContainer.test(); + container.read(provider); + + verifyZeroInteractions(listener); + + container.read(dep.notifier).state++; + await container.pump(); + + verifyOnly(listener, listener(0, 1)); + }); + + test('can listen selectors', () async { + final container = ProviderContainer.test(); + final provider = + StateNotifierProvider, int>((ref) { + return StateController(0); + }); + final isEvenSelector = Selector(false, (c) => c.isEven); + final isEvenListener = Listener(); + var buildCount = 0; + + final another = Provider((ref) { + buildCount++; + ref.listen( + provider.select(isEvenSelector.call), + isEvenListener.call, + ); + return 0; + }); + + container.read(another); + + expect(buildCount, 1); + verifyZeroInteractions(isEvenListener); + verifyOnly(isEvenSelector, isEvenSelector(0)); + + container.read(provider.notifier).state = 2; + + verifyOnly(isEvenSelector, isEvenSelector(2)); + verifyZeroInteractions(isEvenListener); + + container.read(provider.notifier).state = 3; + + verifyOnly(isEvenSelector, isEvenSelector(3)); + verifyOnly(isEvenListener, isEvenListener(true, false)); + + container.read(provider.notifier).state = 4; + + verifyOnly(isEvenSelector, isEvenSelector(4)); + verifyOnly(isEvenListener, isEvenListener(false, true)); + + await container.pump(); + + expect(buildCount, 1); + }); + + test('listen on selectors supports fireImmediately', () async { + final container = ProviderContainer.test(); + final provider = + StateNotifierProvider, int>((ref) { + return StateController(0); + }); + final isEvenSelector = Selector(false, (c) => c.isEven); + final isEvenListener = Listener(); + var buildCount = 0; + + final another = Provider((ref) { + buildCount++; + ref.listen( + provider.select(isEvenSelector.call), + isEvenListener.call, + fireImmediately: true, + ); + return 0; + }); + + container.read(another); + + expect(buildCount, 1); + verifyOnly(isEvenListener, isEvenListener(null, true)); + verifyOnly(isEvenSelector, isEvenSelector(0)); + + container.read(provider.notifier).state = 2; + + verifyOnly(isEvenSelector, isEvenSelector(2)); + verifyNoMoreInteractions(isEvenListener); + + container.read(provider.notifier).state = 3; + + verifyOnly(isEvenSelector, isEvenSelector(3)); + verifyOnly(isEvenListener, isEvenListener(true, false)); + + await container.pump(); + + expect(buildCount, 1); + }); + test( 'when rebuild throws identical error/stack, listeners are still notified', () { @@ -975,7 +1146,7 @@ void main() { }); }); - group('ref.keepAlive', () { + group('keepAlive', () { test( 'Does not cause an infinite loop if aborted directly in the callback', () async { @@ -1141,5 +1312,207 @@ void main() { ); }); }); + + group('refresh', () { + test('refreshes a provider and return the new state', () { + var value = 0; + final state = Provider((ref) => value); + late Ref ref; + final provider = Provider((r) { + ref = r; + }); + final container = ProviderContainer.test(); + + container.read(provider); + + expect(container.read(state), 0); + + value = 42; + expect(ref.refresh(state), 42); + expect(container.read(state), 42); + }); + }); + + group('.onDispose', () { + test( + 'calls all the listeners in order when the ProviderContainer is disposed', + () { + final onDispose = OnDisposeMock(); + final onDispose2 = OnDisposeMock(); + final provider = Provider((ref) { + ref.onDispose(onDispose.call); + ref.onDispose(onDispose2.call); + }); + + final container = ProviderContainer(); + addTearDown(container.dispose); + + container.read(provider); // register the onDispose hooks + + verifyZeroInteractions(onDispose); + verifyZeroInteractions(onDispose2); + + container.dispose(); + + verifyInOrder([ + onDispose(), + onDispose2(), + ]); + verifyNoMoreInteractions(onDispose); + verifyNoMoreInteractions(onDispose2); + }); + + test('calls all listeners in order when one of its dependency changed', + () async { + final onDispose = OnDisposeMock(); + final onDispose2 = OnDisposeMock(); + + final count = StateProvider((ref) => 0); + final provider = Provider((ref) { + ref.watch(count); + ref.onDispose(onDispose.call); + ref.onDispose(onDispose2.call); + }); + + final container = ProviderContainer(); + addTearDown(container.dispose); + + container.read(provider); // register the onDispose hooks + + verifyZeroInteractions(onDispose); + verifyZeroInteractions(onDispose2); + + container.read(count.notifier).state++; + await container.pump(); + + verifyInOrder([ + onDispose(), + onDispose2(), + ]); + verifyNoMoreInteractions(onDispose); + verifyNoMoreInteractions(onDispose2); + }); + + test('does not call listeners again if more than one dependency changed', + () { + final onDispose = OnDisposeMock(); + + final count = StateProvider((ref) => 0); + final count2 = StateProvider((ref) => 0); + final provider = Provider((ref) { + ref.watch(count); + ref.watch(count2); + ref.onDispose(onDispose.call); + }); + + final container = ProviderContainer(); + addTearDown(container.dispose); + + container.read(provider); // register the onDispose hooks + + verifyZeroInteractions(onDispose); + + container.read(count.notifier).state++; + container.read(count2.notifier).state++; + + verifyOnly(onDispose, onDispose()); + }); + + test( + 'does not call listeners again if a dependency changed then ProviderContainer was disposed', + () async { + final onDispose = OnDisposeMock(); + var buildCount = 0; + + final count = StateProvider((ref) => 0); + final provider = Provider((ref) { + buildCount++; + ref.watch(count); + ref.onDispose(onDispose.call); + }); + + final container = ProviderContainer(); + addTearDown(container.dispose); + + container.read(provider); // register the onDispose hooks + expect(buildCount, 1); + + verifyZeroInteractions(onDispose); + + container.read(count.notifier).state++; + // no pump() because that would rebuild the provider, which means it would + // need to be disposed once again. + + verifyOnly(onDispose, onDispose()); + + container.dispose(); + + expect(buildCount, 1); + verifyNoMoreInteractions(onDispose); + }); + + test( + 'once a provider was disposed, cannot add more listeners until it is rebuilt', + () {}, + skip: 'TODO', + ); + }); + + group('mounted', () { + test('is false during onDispose caused by ref.watch', () { + final container = ProviderContainer.test(); + bool? mounted; + late ProviderElementBase element; + final dep = StateProvider((ref) => 0); + final provider = Provider((ref) { + ref.watch(dep); + element = ref as ProviderElementBase; + ref.onDispose(() => mounted = element.mounted); + }); + + container.read(provider); + expect(mounted, null); + + container.read(dep.notifier).state++; + + expect(mounted, false); + }); + + test('is false during onDispose caused by container dispose', () { + final container = ProviderContainer.test(); + bool? mounted; + late ProviderElementBase element; + final dep = StateProvider((ref) => 0); + final provider = Provider((ref) { + ref.watch(dep); + element = ref as ProviderElementBase; + ref.onDispose(() => mounted = element.mounted); + }); + + container.read(provider); + expect(mounted, null); + + container.dispose(); + + expect(mounted, false); + }); + + test('is false in between rebuilds', () { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + late ProviderElementBase element; + final provider = Provider((ref) { + ref.watch(dep); + element = ref as ProviderElementBase; + }); + + container.read(provider); + expect(element.mounted, true); + + container.read(dep.notifier).state++; + + expect(element.mounted, false); + }); + }); }); } diff --git a/packages/riverpod/test/old/framework/select_async_test.dart b/packages/riverpod/test/new/core/select_async_test.dart similarity index 100% rename from packages/riverpod/test/old/framework/select_async_test.dart rename to packages/riverpod/test/new/core/select_async_test.dart diff --git a/packages/riverpod/test/old/framework/uni_directional_test.dart b/packages/riverpod/test/new/core/uni_directional_test.dart similarity index 96% rename from packages/riverpod/test/old/framework/uni_directional_test.dart rename to packages/riverpod/test/new/core/uni_directional_test.dart index 9fb9e5e90..c3ef53f8a 100644 --- a/packages/riverpod/test/old/framework/uni_directional_test.dart +++ b/packages/riverpod/test/new/core/uni_directional_test.dart @@ -5,14 +5,6 @@ import 'package:test/test.dart'; import '../utils.dart'; void main() { - late ProviderContainer container; - setUp(() { - container = ProviderContainer(); - }); - tearDown(() { - container.dispose(); - }); - test( 'Catches sync circular dependency when the dependency is not yet mounted', skip: true, () { @@ -186,6 +178,7 @@ void main() { }); test("initState can't dirty ancestors", () { + final container = ProviderContainer.test(); final ancestor = StateProvider((_) => 0); final child = Provider((ref) { ref.watch(ancestor.notifier).state++; @@ -196,6 +189,7 @@ void main() { }); test("initState can't dirty siblings", () { + final container = ProviderContainer.test(); final ancestor = StateProvider((_) => 0, name: 'ancestor'); final counter = Counter(); final sibling = StateNotifierProvider( @@ -222,6 +216,7 @@ void main() { }); test("initState can't mark dirty other provider", () { + final container = ProviderContainer.test(); final provider = StateProvider((ref) => 0); final provider2 = Provider((ref) { ref.watch(provider.notifier).state = 42; @@ -234,6 +229,7 @@ void main() { }); test("nested initState can't mark dirty other providers", () { + final container = ProviderContainer.test(); final counter = Counter(); final provider = StateNotifierProvider((_) => counter); final nested = Provider((_) => 0); @@ -249,6 +245,7 @@ void main() { }); test('auto dispose can dirty providers', () async { + final container = ProviderContainer.test(); final counter = Counter(); final provider = StateNotifierProvider((_) => counter); var didDispose = false; @@ -273,6 +270,7 @@ void main() { }); test("Provider can't dirty anything on create", () { + final container = ProviderContainer.test(); final counter = Counter(); final provider = StateNotifierProvider((_) => counter); late List errors; diff --git a/packages/riverpod/test/old/framework/visit_states_test.dart b/packages/riverpod/test/new/core/visit_states_test.dart similarity index 100% rename from packages/riverpod/test/old/framework/visit_states_test.dart rename to packages/riverpod/test/new/core/visit_states_test.dart diff --git a/packages/riverpod/test/new/utils.dart b/packages/riverpod/test/new/utils.dart index 18c51f051..4b1a37f82 100644 --- a/packages/riverpod/test/new/utils.dart +++ b/packages/riverpod/test/new/utils.dart @@ -1,4 +1,7 @@ +import 'dart:async'; + import 'package:mockito/mockito.dart'; +import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; class OnDisposeMock extends Mock { @@ -56,3 +59,82 @@ class Selector extends Mock { ) as Output; } } + +class Counter extends StateNotifier { + Counter([super.initialValue = 0]); + + void increment() => state++; + + @override + int get state => super.state; + @override + set state(int value) => super.state = value; +} + +List errorsOf(void Function() cb) { + final errors = []; + runZonedGuarded(cb, (err, _) => errors.add(err)); + return [...errors]; +} + +class ObserverMock extends Mock implements ProviderObserver { + ObserverMock([this.label]); + + final String? label; + + @override + String toString() { + return label ?? super.toString(); + } + + @override + void didDisposeProvider( + ProviderBase? provider, + ProviderContainer? container, + ) { + super.noSuchMethod( + Invocation.method(#didDisposeProvider, [provider, container]), + ); + } + + @override + void providerDidFail( + ProviderBase? provider, + Object? error, + Object? stackTrace, + Object? container, + ) { + super.noSuchMethod( + Invocation.method( + #providerDidFail, + [provider, error, stackTrace, container], + ), + ); + } + + @override + void didAddProvider( + ProviderBase? provider, + Object? value, + ProviderContainer? container, + ) { + super.noSuchMethod( + Invocation.method(#didAddProvider, [provider, value, container]), + ); + } + + @override + void didUpdateProvider( + ProviderBase? provider, + Object? previousValue, + Object? newValue, + ProviderContainer? container, + ) { + super.noSuchMethod( + Invocation.method( + #didUpdateProvider, + [provider, previousValue, newValue, container], + ), + ); + } +} diff --git a/packages/riverpod/test/old/framework/ref_test.dart b/packages/riverpod/test/old/framework/ref_test.dart deleted file mode 100644 index 2fe507cc2..000000000 --- a/packages/riverpod/test/old/framework/ref_test.dart +++ /dev/null @@ -1,383 +0,0 @@ -import 'package:mockito/mockito.dart'; -import 'package:riverpod/riverpod.dart'; -import 'package:test/test.dart'; - -import '../utils.dart'; - -void main() { - group('Ref', () { - test( - 'cannot call ref.watch/ref.read/ref.listen/ref.onDispose after a dependency changed', - () { - late Ref ref; - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - final provider = Provider((r) { - r.watch(dep); - ref = r; - }); - - container.read(provider); - - container.read(dep.notifier).state++; - - final another = Provider((ref) => 0); - - expect( - () => ref.watch(another), - throwsA(isA()), - ); - expect( - () => ref.refresh(another), - throwsA(isA()), - ); - expect( - () => ref.read(another), - throwsA(isA()), - ); - expect( - () => ref.onDispose(() {}), - throwsA(isA()), - ); - expect( - () => ref.listen(another, (_, __) {}), - throwsA(isA()), - ); - }, - ); - - group('refresh', () { - test('refreshes a provider and return the new state', () { - var value = 0; - final state = Provider((ref) => value); - late Ref ref; - final provider = Provider((r) { - ref = r; - }); - final container = ProviderContainer.test(); - - container.read(provider); - - expect(container.read(state), 0); - - value = 42; - expect(ref.refresh(state), 42); - expect(container.read(state), 42); - }); - }); - - group('listen', () { - test('ref.listen on outdated provider causes it to rebuild', () { - final dep = StateProvider((ref) => 0); - var buildCount = 0; - final provider = Provider((ref) { - buildCount++; - return ref.watch(dep); - }); - final listener = Listener(); - final another = Provider((ref) { - ref.listen(provider, listener.call, fireImmediately: true); - }); - final container = ProviderContainer.test(); - - expect(container.read(provider), 0); - expect(buildCount, 1); - - container.read(dep.notifier).state = 42; - - expect(buildCount, 1); - - container.read(another); - - expect(buildCount, 2); - verifyOnly(listener, listener(null, 42)); - }); - - test('can downcast the value', () async { - final listener = Listener(); - final dep = StateProvider((ref) => 0); - final provider = Provider((ref) { - ref.listen(dep, listener.call); - }); - - final container = ProviderContainer.test(); - container.read(provider); - - verifyZeroInteractions(listener); - - container.read(dep.notifier).state++; - await container.pump(); - - verifyOnly(listener, listener(0, 1)); - }); - - test('can listen selectors', () async { - final container = ProviderContainer.test(); - final provider = - StateNotifierProvider, int>((ref) { - return StateController(0); - }); - final isEvenSelector = Selector(false, (c) => c.isEven); - final isEvenListener = Listener(); - var buildCount = 0; - - final another = Provider((ref) { - buildCount++; - ref.listen( - provider.select(isEvenSelector.call), - isEvenListener.call, - ); - return 0; - }); - - container.read(another); - - expect(buildCount, 1); - verifyZeroInteractions(isEvenListener); - verifyOnly(isEvenSelector, isEvenSelector(0)); - - container.read(provider.notifier).state = 2; - - verifyOnly(isEvenSelector, isEvenSelector(2)); - verifyZeroInteractions(isEvenListener); - - container.read(provider.notifier).state = 3; - - verifyOnly(isEvenSelector, isEvenSelector(3)); - verifyOnly(isEvenListener, isEvenListener(true, false)); - - container.read(provider.notifier).state = 4; - - verifyOnly(isEvenSelector, isEvenSelector(4)); - verifyOnly(isEvenListener, isEvenListener(false, true)); - - await container.pump(); - - expect(buildCount, 1); - }); - - test('listen on selectors supports fireImmediately', () async { - final container = ProviderContainer.test(); - final provider = - StateNotifierProvider, int>((ref) { - return StateController(0); - }); - final isEvenSelector = Selector(false, (c) => c.isEven); - final isEvenListener = Listener(); - var buildCount = 0; - - final another = Provider((ref) { - buildCount++; - ref.listen( - provider.select(isEvenSelector.call), - isEvenListener.call, - fireImmediately: true, - ); - return 0; - }); - - container.read(another); - - expect(buildCount, 1); - verifyOnly(isEvenListener, isEvenListener(null, true)); - verifyOnly(isEvenSelector, isEvenSelector(0)); - - container.read(provider.notifier).state = 2; - - verifyOnly(isEvenSelector, isEvenSelector(2)); - verifyNoMoreInteractions(isEvenListener); - - container.read(provider.notifier).state = 3; - - verifyOnly(isEvenSelector, isEvenSelector(3)); - verifyOnly(isEvenListener, isEvenListener(true, false)); - - await container.pump(); - - expect(buildCount, 1); - }); - }); - - group('.onDispose', () { - test( - 'calls all the listeners in order when the ProviderContainer is disposed', - () { - final onDispose = OnDisposeMock(); - final onDispose2 = OnDisposeMock(); - final provider = Provider((ref) { - ref.onDispose(onDispose.call); - ref.onDispose(onDispose2.call); - }); - - final container = ProviderContainer(); - addTearDown(container.dispose); - - container.read(provider); // register the onDispose hooks - - verifyZeroInteractions(onDispose); - verifyZeroInteractions(onDispose2); - - container.dispose(); - - verifyInOrder([ - onDispose(), - onDispose2(), - ]); - verifyNoMoreInteractions(onDispose); - verifyNoMoreInteractions(onDispose2); - }); - - test('calls all listeners in order when one of its dependency changed', - () async { - final onDispose = OnDisposeMock(); - final onDispose2 = OnDisposeMock(); - - final count = StateProvider((ref) => 0); - final provider = Provider((ref) { - ref.watch(count); - ref.onDispose(onDispose.call); - ref.onDispose(onDispose2.call); - }); - - final container = ProviderContainer(); - addTearDown(container.dispose); - - container.read(provider); // register the onDispose hooks - - verifyZeroInteractions(onDispose); - verifyZeroInteractions(onDispose2); - - container.read(count.notifier).state++; - await container.pump(); - - verifyInOrder([ - onDispose(), - onDispose2(), - ]); - verifyNoMoreInteractions(onDispose); - verifyNoMoreInteractions(onDispose2); - }); - - test('does not call listeners again if more than one dependency changed', - () { - final onDispose = OnDisposeMock(); - - final count = StateProvider((ref) => 0); - final count2 = StateProvider((ref) => 0); - final provider = Provider((ref) { - ref.watch(count); - ref.watch(count2); - ref.onDispose(onDispose.call); - }); - - final container = ProviderContainer(); - addTearDown(container.dispose); - - container.read(provider); // register the onDispose hooks - - verifyZeroInteractions(onDispose); - - container.read(count.notifier).state++; - container.read(count2.notifier).state++; - - verifyOnly(onDispose, onDispose()); - }); - - test( - 'does not call listeners again if a dependency changed then ProviderContainer was disposed', - () async { - final onDispose = OnDisposeMock(); - var buildCount = 0; - - final count = StateProvider((ref) => 0); - final provider = Provider((ref) { - buildCount++; - ref.watch(count); - ref.onDispose(onDispose.call); - }); - - final container = ProviderContainer(); - addTearDown(container.dispose); - - container.read(provider); // register the onDispose hooks - expect(buildCount, 1); - - verifyZeroInteractions(onDispose); - - container.read(count.notifier).state++; - // no pump() because that would rebuild the provider, which means it would - // need to be disposed once again. - - verifyOnly(onDispose, onDispose()); - - container.dispose(); - - expect(buildCount, 1); - verifyNoMoreInteractions(onDispose); - }); - - test( - 'once a provider was disposed, cannot add more listeners until it is rebuilt', - () {}, - skip: 'TODO', - ); - }); - - group('mounted', () { - test('is false during onDispose caused by ref.watch', () { - final container = ProviderContainer.test(); - bool? mounted; - late ProviderElementBase element; - final dep = StateProvider((ref) => 0); - final provider = Provider((ref) { - ref.watch(dep); - element = ref as ProviderElementBase; - ref.onDispose(() => mounted = element.mounted); - }); - - container.read(provider); - expect(mounted, null); - - container.read(dep.notifier).state++; - - expect(mounted, false); - }); - - test('is false during onDispose caused by container dispose', () { - final container = ProviderContainer.test(); - bool? mounted; - late ProviderElementBase element; - final dep = StateProvider((ref) => 0); - final provider = Provider((ref) { - ref.watch(dep); - element = ref as ProviderElementBase; - ref.onDispose(() => mounted = element.mounted); - }); - - container.read(provider); - expect(mounted, null); - - container.dispose(); - - expect(mounted, false); - }); - - test('is false in between rebuilds', () { - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - late ProviderElementBase element; - final provider = Provider((ref) { - ref.watch(dep); - element = ref as ProviderElementBase; - }); - - container.read(provider); - expect(element.mounted, true); - - container.read(dep.notifier).state++; - - expect(element.mounted, false); - }); - }); - }); -} From b5e716720bbc43a3197c493740a4e887030b00e4 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 10 Jan 2024 20:15:44 +0100 Subject: [PATCH 123/387] W --- .../change_notifier_provider/base.dart | 14 +- packages/riverpod/lib/riverpod.dart | 14 +- .../riverpod/lib/src/common/listenable.dart | 4 +- .../riverpod/lib/src/core/auto_dispose.dart | 54 -- packages/riverpod/lib/src/core/element.dart | 60 +- packages/riverpod/lib/src/core/family.dart | 264 ++++---- .../riverpod/lib/src/core/foundation.dart | 18 +- .../lib/src/core/modifiers/future.dart | 431 +++++++++++++ .../lib/src/core/{ => modifiers}/select.dart | 2 +- .../core/{ => modifiers}/select_async.dart | 66 +- packages/riverpod/lib/src/core/override.dart | 6 +- .../lib/src/core/override_with_value.dart | 13 +- .../core/provider/functional_provider.dart | 61 ++ .../src/core/provider/notifier_provider.dart | 219 +++++++ .../lib/src/core/{ => provider}/provider.dart | 83 +-- .../lib/src/core/provider_container.dart | 2 +- .../lib/src/core/provider_subscription.dart | 46 ++ .../src/core/proxy_provider_listenable.dart | 2 +- packages/riverpod/lib/src/core/ref.dart | 65 +- packages/riverpod/lib/src/core/scheduler.dart | 6 +- packages/riverpod/lib/src/framework.dart | 11 +- .../src/legacy_providers/async_notifier.dart | 153 ++--- .../async_notifier/auto_dispose.dart | 138 ---- .../async_notifier/auto_dispose_family.dart | 129 ---- .../legacy_providers/async_notifier/base.dart | 599 ------------------ .../async_notifier/family.dart | 141 ++--- .../async_notifier/orphan.dart | 174 +++++ .../lib/src/legacy_providers/builders.dart | 44 +- .../state_notifier_provider/base.dart | 12 +- .../deprecated/state_provider/base.dart | 16 +- .../src/legacy_providers/future_provider.dart | 128 +++- .../future_provider/auto_dispose.dart | 137 ---- .../future_provider/base.dart | 160 ----- .../lib/src/legacy_providers/notifier.dart | 26 +- .../src/legacy_providers/notifier/base.dart | 10 +- .../src/legacy_providers/notifier/family.dart | 2 +- .../lib/src/legacy_providers/provider.dart | 328 +++++++++- .../provider/auto_dispose.dart | 116 ---- .../src/legacy_providers/provider/base.dart | 397 ------------ .../src/legacy_providers/stream_notifier.dart | 136 ++-- .../stream_notifier/auto_dispose.dart | 134 ---- .../stream_notifier/auto_dispose_family.dart | 124 ---- .../stream_notifier/base.dart | 169 ----- .../stream_notifier/family.dart | 182 +++--- .../stream_notifier/orphan.dart | 101 +++ .../src/legacy_providers/stream_provider.dart | 213 ++++++- .../stream_provider/auto_dispose.dart | 124 ---- .../stream_provider/base.dart | 240 ------- packages/riverpod/pubspec.yaml | 3 +- packages/riverpod/test/meta_test.dart | 326 ++++++++++ .../old/framework/provider_element_test.dart | 10 +- .../old/legacy/framework2/framework_test.dart | 12 +- .../async_notifier/factory.dart | 8 +- .../stream_notifier/factory.dart | 8 +- .../lib/riverpod_annotation.dart | 4 +- .../protected_notifier_properties.g.dart | 4 +- .../bin/generate_providers.dart | 24 +- 57 files changed, 2604 insertions(+), 3369 deletions(-) delete mode 100644 packages/riverpod/lib/src/core/auto_dispose.dart create mode 100644 packages/riverpod/lib/src/core/modifiers/future.dart rename packages/riverpod/lib/src/core/{ => modifiers}/select.dart (99%) rename packages/riverpod/lib/src/core/{ => modifiers}/select_async.dart (64%) create mode 100644 packages/riverpod/lib/src/core/provider/functional_provider.dart create mode 100644 packages/riverpod/lib/src/core/provider/notifier_provider.dart rename packages/riverpod/lib/src/core/{ => provider}/provider.dart (57%) delete mode 100644 packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose_family.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/async_notifier/base.dart create mode 100644 packages/riverpod/lib/src/legacy_providers/async_notifier/orphan.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/future_provider/auto_dispose.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/future_provider/base.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/provider/auto_dispose.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/provider/base.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose_family.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/stream_notifier/base.dart create mode 100644 packages/riverpod/lib/src/legacy_providers/stream_notifier/orphan.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/stream_provider/auto_dispose.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart create mode 100644 packages/riverpod/test/meta_test.dart diff --git a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart index 9a68ed729..cb1d22d4e 100644 --- a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart +++ b/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart @@ -184,7 +184,7 @@ class ChangeNotifierProviderElement @override NotifierT get notifier => _notifierNotifier.value; - final _notifierNotifier = ProxyElementValueNotifier(); + final _notifierNotifier = ProxyElementValueListenable(); void Function()? _removeListener; @@ -228,21 +228,21 @@ class ChangeNotifierProviderElement @override void visitChildren({ required void Function(ProviderElementBase element) elementVisitor, - required void Function(ProxyElementValueNotifier element) - notifierVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, - notifierVisitor: notifierVisitor, + listenableVisitor: listenableVisitor, ); - notifierVisitor(_notifierNotifier); + listenableVisitor(_notifierNotifier); } } /// The [Family] of [ChangeNotifierProvider]. class ChangeNotifierProviderFamily - extends FamilyBase, NotifierT, Arg, - NotifierT, ChangeNotifierProvider> { + extends FunctionalFamily, NotifierT, + Arg, NotifierT, ChangeNotifierProvider> { /// The [Family] of [ChangeNotifierProvider]. ChangeNotifierProviderFamily( super._createFn, { diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 7bfb724c1..5b52d29a0 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -2,28 +2,30 @@ // for other classes, please add state_notifier as dependency. export 'package:state_notifier/state_notifier.dart' show StateNotifier; +// TODO assert all provider variants have const constructors + export 'src/core/async_value.dart' hide AsyncTransition; export 'src/framework.dart' hide ProviderScheduler, debugCanModifyProviders, Vsync, - ValueProviderElement, + _ValueProviderElement, ValueProvider, FamilyCreate, AsyncSelector, - FamilyBase, + FunctionalFamily, AutoDisposeProviderElementMixin, FamilyOverride, - NotifierFamilyBase, + ClassFamily, SetupFamilyOverride, SetupOverride, AutoDisposeNotifierFamilyBase, ProviderOverride, AutoDisposeFamilyBase, DebugGetCreateSourceHash, - ProviderNotifierCreate, - ProviderCreate, + ClassProviderFactory, + FunctionalProviderFactory, computeAllTransitiveDependencies, Create, Node, @@ -43,7 +45,7 @@ export 'src/legacy_providers/async_notifier.dart' AutoDisposeAsyncNotifierProviderImpl, AutoDisposeFamilyAsyncNotifierProviderImpl, FamilyAsyncNotifierProviderImpl, - AsyncNotifierBase, + _AsyncNotifierBase, AsyncNotifierProviderBase, CancelAsyncSubscription, BuildlessAsyncNotifier, diff --git a/packages/riverpod/lib/src/common/listenable.dart b/packages/riverpod/lib/src/common/listenable.dart index 3a9ef802c..529d6483a 100644 --- a/packages/riverpod/lib/src/common/listenable.dart +++ b/packages/riverpod/lib/src/common/listenable.dart @@ -18,7 +18,7 @@ class _Listener { /// A listenable object used by [ProviderElementBase] as a mean to subscribe /// to subsets of the state exposed by a provider. @internal -class ProxyElementValueNotifier extends _ValueListenable { +class ProxyElementValueListenable extends _ValueListenable { /// Directly obtain the value exposed, gratefully handling cases where /// [result] is null or in error state. T get value { @@ -43,7 +43,7 @@ class ProxyElementValueNotifier extends _ValueListenable { ); } - /// Updates the [result] of this [ProxyElementValueNotifier] without invoking listeners. + /// Updates the [result] of this [ProxyElementValueListenable] without invoking listeners. // ignore: use_setters_to_change_properties, non_constant_identifier_names void UNSAFE_setResultWithoutNotifyingListeners(Result? value) { _result = value; diff --git a/packages/riverpod/lib/src/core/auto_dispose.dart b/packages/riverpod/lib/src/core/auto_dispose.dart deleted file mode 100644 index 33bf85a5b..000000000 --- a/packages/riverpod/lib/src/core/auto_dispose.dart +++ /dev/null @@ -1,54 +0,0 @@ -part of '../framework.dart'; - -/// A mixin that adds auto dispose support to a [ProviderElementBase]. -@internal -mixin AutoDisposeProviderElementMixin on ProviderElementBase - implements AutoDisposeRef { - List? _keepAliveLinks; - - @override - KeepAliveLink keepAlive() { - final links = _keepAliveLinks ??= []; - - late KeepAliveLink link; - link = KeepAliveLink._(() { - if (links.remove(link)) { - if (links.isEmpty) mayNeedDispose(); - } - }); - links.add(link); - - return link; - } - - @override - void mayNeedDispose() { - final links = _keepAliveLinks; - - if (!hasListeners && (links == null || links.isEmpty)) { - container.scheduler.scheduleProviderDispose(this); - } - } - - @override - void runOnDispose() { - _keepAliveLinks?.clear(); - super.runOnDispose(); - assert( - _keepAliveLinks == null || _keepAliveLinks!.isEmpty, - 'Cannot call keepAlive() within onDispose listeners', - ); - } -} - -/// A object which maintains a provider alive. -class KeepAliveLink { - KeepAliveLink._(this._close); - - final void Function() _close; - - /// Release this [KeepAliveLink], allowing the associated provider to - /// be disposed if the provider is no-longer listener nor has any - /// remaining [KeepAliveLink]. - void close() => _close(); -} diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index cff8af291..c92a2db81 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -29,6 +29,8 @@ mixin _ProviderRefreshable implements Refreshable { @internal void Function()? debugCanModifyProviders; +class _Foo {} + /// {@template riverpod.provider_element_base} /// An internal class that handles the state of a provider. /// @@ -41,6 +43,7 @@ void Function()? debugCanModifyProviders; /// Do not use. /// {@endtemplate} // TODO rename to ProviderElement +@internal abstract class ProviderElementBase implements Ref, Node { /// {@macro riverpod.provider_element_base} // TODO changelog: ProviderElement no-longer takes a provider as parameter but takes a ProviderContainer @@ -54,10 +57,12 @@ abstract class ProviderElementBase implements Ref, Node { String? _debugCurrentCreateHash; var _debugSkipNotifyListenersAsserts = false; + _Foo? get foo => null; + /// The provider associated with this [ProviderElementBase], before applying overrides. // Not typed as because of https://github.com/rrousselGit/riverpod/issues/1100 ProviderBase get origin => _origin; - late ProviderBase _origin; + late final ProviderBase _origin; /// The provider associated with this [ProviderElementBase], after applying overrides. // TODO changelog ProviderElement.provider is now abstract @@ -129,6 +134,7 @@ abstract class ProviderElementBase implements Ref, Node { bool _debugDidSetState = false; bool _didBuild = false; + List? _keepAliveLinks; /* STATE */ Result? _state; @@ -172,9 +178,12 @@ abstract class ProviderElementBase implements Ref, Node { /// [readSelf]. @internal State get requireState { - const uninitializedError = - 'Tried to read the state of an uninitialized provider. ' - 'Do you maybe have a circular dependency?'; + const uninitializedError = ''' +Tried to read the state of an uninitialized provider. +This could mean a few things: +- You have a circular dependency, and your provider end-up depending on itself. +- You read "ref.state", but no value was set beforehand. +'''; if (kDebugMode) { if (debugAssertDidSetStateEnabled && !_debugDidSetState) { @@ -306,7 +315,8 @@ abstract class ProviderElementBase implements Ref, Node { // and "flush" it, as it will already get rebuilt. visitChildren( elementVisitor: (element) => element._markDependencyMayHaveChanged(), - notifierVisitor: (notifier) => notifier.notifyDependencyMayHaveChanged(), + listenableVisitor: (notifier) => + notifier.notifyDependencyMayHaveChanged(), ); } @@ -584,7 +594,8 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu visitChildren( elementVisitor: (element) => element._markDependencyMayHaveChanged(), - notifierVisitor: (notifier) => notifier.notifyDependencyMayHaveChanged(), + listenableVisitor: (notifier) => + notifier.notifyDependencyMayHaveChanged(), ); } @@ -773,6 +784,21 @@ final = Provider(dependencies: []); } } + @override + KeepAliveLink keepAlive() { + final links = _keepAliveLinks ??= []; + + late KeepAliveLink link; + link = KeepAliveLink._(() { + if (links.remove(link)) { + if (links.isEmpty) mayNeedDispose(); + } + }); + links.add(link); + + return link; + } + /// Returns the currently exposed by a provider /// /// May throw if the provider threw when creating the exposed value. @@ -792,8 +818,8 @@ final = Provider(dependencies: []); /// [listen] multiple times to an element, it may be visited multiple times. void visitChildren({ required void Function(ProviderElementBase element) elementVisitor, - required void Function(ProxyElementValueNotifier element) - notifierVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, }) { for (var i = 0; i < _providerDependents.length; i++) { elementVisitor(_providerDependents[i]); @@ -872,9 +898,16 @@ final = Provider(dependencies: []); /// /// - [AutoDisposeProviderElementMixin], which overrides this method to destroy the /// state of a provider when no longer used. - @protected @visibleForOverriding - void mayNeedDispose() {} + void mayNeedDispose() { + if (provider.isAutoDispose) { + final links = _keepAliveLinks; + + if (!hasListeners && (links == null || links.isEmpty)) { + container.scheduler.scheduleProviderDispose(this); + } + } + } @override @mustCallSuper @@ -896,6 +929,8 @@ final = Provider(dependencies: []); if (!_mounted) return; _mounted = false; + _keepAliveLinks?.clear(); + while (_listenedProviderSubscriptions.isNotEmpty) { _listenedProviderSubscriptions.first.close(); } @@ -918,6 +953,11 @@ final = Provider(dependencies: []); _onChangeSelfListeners = null; _onErrorSelfListeners = null; _didCancelOnce = false; + + assert( + _keepAliveLinks == null || _keepAliveLinks!.isEmpty, + 'Cannot call keepAlive() within onDispose listeners', + ); } @override diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index 2248d79d6..26f8a5913 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -2,40 +2,58 @@ part of '../framework.dart'; /// A typedef representing the constructor of any classical provider. @internal -typedef ProviderCreate = ProviderT - Function( - Create create, { +typedef FunctionalProviderFactory< // + ProviderT, + CreatedT, + RefT extends Ref, + ArgT> + = ProviderT Function( + Create create, { required String? name, // ignore: prefer_void_to_null, explicitly using Null to cause a compilation error if non-null value is assigned required Null dependencies, // ignore: prefer_void_to_null, explicitly using Null to cause a compilation error if non-null value is assigned required Null allTransitiveDependencies, required DebugGetCreateSourceHash? debugGetCreateSourceHash, - Family from, - Object? argument, + required bool isAutoDispose, + required Family from, + required ArgT argument, }); /// A typedef representing the constructor of a [NotifierProvider]. @internal -typedef ProviderNotifierCreate = ProviderT - Function( - Created Function() create, { +typedef ClassProviderFactory< // + NotifierT, + ProviderT, + CreatedT, + RefT extends Ref, + ArgT> + = ProviderT Function( + CreatedT Function() create, { required String? name, required Iterable? dependencies, - required Set? allTransitiveDependencies, + required Iterable? allTransitiveDependencies, required DebugGetCreateSourceHash? debugGetCreateSourceHash, - Family from, - Object? argument, + required bool isAutoDispose, + required Family from, + required ArgT argument, }); /// A [Create] equivalent used by [Family]. @internal -typedef FamilyCreate = T Function(R ref, Arg arg); +typedef FamilyCreate, ArgT> = CreatedT + Function(RefT ref, ArgT arg); /// A base class for all families -abstract class Family implements _FamilyOverride, ProviderOrFamily { +abstract class Family extends ProviderOrFamily implements _FamilyOverride { /// A base class for all families - const Family(); + const Family({ + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.isAutoDispose, + required super.debugGetCreateSourceHash, + }); @override Family get from => this; @@ -56,24 +74,32 @@ typedef SetupFamilyOverride = void Function( /// /// This API is not meant for public consumption. @internal -class FamilyBase, R, Arg, Created, - ProviderT extends ProviderBase> extends Family { +class FunctionalFamily< // + RefT extends Ref, + StateT, + ArgT, + CreatedT, + ProviderT extends FunctionalProvider> + extends Family { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. /// /// This API is not meant for public consumption. - const FamilyBase( + const FunctionalFamily( this._createFn, { - required ProviderCreate providerFactory, - required this.name, - required this.dependencies, - required this.allTransitiveDependencies, - required this.debugGetCreateSourceHash, + required FunctionalProviderFactory + providerFactory, + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.isAutoDispose, }) : _providerFactory = providerFactory; - final ProviderCreate _providerFactory; + final FunctionalProviderFactory + _providerFactory; - final Created Function(RefT ref, Arg arg) _createFn; + final CreatedT Function(RefT ref, ArgT arg) _createFn; /// {@template family.call} /// Create a provider from an external value. @@ -81,113 +107,83 @@ class FamilyBase, R, Arg, Created, /// That external value should be immutable and preferably override `==`/`hashCode`. /// See the documentation of [Provider.family] for more information. /// {@endtemplate} - ProviderT call(Arg argument) { + ProviderT call(ArgT argument) { return _providerFactory( (ref) => _createFn(ref, argument), name: name, + isAutoDispose: isAutoDispose, from: this, argument: argument, + // TODO test all families set dependencies as null dependencies: null, allTransitiveDependencies: null, debugGetCreateSourceHash: debugGetCreateSourceHash, ); } - @override - final String? name; - @override - final Iterable? dependencies; - @override - final Set? allTransitiveDependencies; - - /// {@macro riverpod.create_source_hash} - @internal - final DebugGetCreateSourceHash? debugGetCreateSourceHash; - - @override - String toString() => name ?? describeIdentity(this); -} - -/// A base implementation for [Family], used by the various providers to -/// help them define a [Family]. -/// -/// This API is not meant for public consumption. - -@internal -class AutoDisposeFamilyBase, R, Arg, Created, - ProviderT extends ProviderBase> extends Family { - /// A base implementation for [Family], used by the various providers to - /// help them define a [Family]. - /// - /// This API is not meant for public consumption. - const AutoDisposeFamilyBase( - this._createFn, { - required ProviderCreate providerFactory, - required this.name, - required this.dependencies, - required this.allTransitiveDependencies, - required this.debugGetCreateSourceHash, - }) : _providerFactory = providerFactory; - - final ProviderCreate _providerFactory; - - final Created Function(RefT ref, Arg arg) _createFn; - - /// {@macro family.call} - ProviderT call(Arg argument) { - return _providerFactory( - (ref) => _createFn(ref, argument), - name: name, + /// {@macro riverpod.override_with} + Override overrideWith( + CreatedT Function(RefT ref, ArgT arg) create, + ) { + return FamilyOverride( from: this, - argument: argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: debugGetCreateSourceHash, + createElement: (container, provider) { + provider as ProviderT; + + return provider + .copyWithCreate((ref) => create(ref, provider.argument as ArgT)) + .createElement(container); + }, ); } @override - final String? name; - @override - final Iterable? dependencies; - @override - final Set? allTransitiveDependencies; - - /// {@macro riverpod.create_source_hash} - @internal - final DebugGetCreateSourceHash? debugGetCreateSourceHash; + String toString() => name ?? describeIdentity(this); } -/// A base implementation for [Family] specific to autoDispose `Notifier`-based providers. +/// A base implementation for [Family] specific to `Notifier`-based providers. /// /// It offers a unique "create" function which does not take any argument. /// /// This API is not meant for public consumption. @internal -class AutoDisposeNotifierFamilyBase, R, Arg, NotifierT, - ProviderT extends ProviderBase> extends Family { +class ClassFamily< // + NotifierT extends ClassBase< // + StateT, + CreatedT>, + StateT, + RefT extends Ref, + ArgT, + CreatedT, + ProviderT extends ClassProvider> + extends Family { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. /// /// This API is not meant for public consumption. - const AutoDisposeNotifierFamilyBase( + const ClassFamily( this._createFn, { - required ProviderNotifierCreate providerFactory, - required this.name, - required this.dependencies, - required this.allTransitiveDependencies, - required this.debugGetCreateSourceHash, - }) : _providerFactory = providerFactory; - - final ProviderNotifierCreate _providerFactory; + required this.providerFactory, + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.isAutoDispose, + }); + +// TODO docs + @internal + final ClassProviderFactory + providerFactory; final NotifierT Function() _createFn; /// {@macro family.call} - ProviderT call(Arg argument) { - return _providerFactory( + ProviderT call(ArgT argument) { + return providerFactory( _createFn, name: name, + isAutoDispose: isAutoDispose, from: this, argument: argument, dependencies: dependencies, @@ -196,64 +192,32 @@ class AutoDisposeNotifierFamilyBase, R, Arg, NotifierT, ); } - @override - final String? name; - @override - final Iterable? dependencies; - @override - final Set? allTransitiveDependencies; - - /// {@macro riverpod.create_source_hash} - @internal - final DebugGetCreateSourceHash? debugGetCreateSourceHash; -} - -/// A base implementation for [Family] specific to `Notifier`-based providers. -/// -/// It offers a unique "create" function which does not take any argument. -/// -/// This API is not meant for public consumption. -@internal -class NotifierFamilyBase, R, Arg, NotifierT, - ProviderT extends ProviderBase> extends Family { - /// A base implementation for [Family], used by the various providers to - /// help them define a [Family]. - /// - /// This API is not meant for public consumption. - const NotifierFamilyBase( - this._createFn, { - required ProviderNotifierCreate providerFactory, - required this.name, - required this.dependencies, - required this.allTransitiveDependencies, - required this.debugGetCreateSourceHash, - }) : _providerFactory = providerFactory; - - final ProviderNotifierCreate _providerFactory; + /// {@macro riverpod.override_with} + Override overrideWith(NotifierT Function() create) { + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ProviderT; - final NotifierT Function() _createFn; + return provider.copyWithCreate(create).createElement(container); + }, + ); + } - /// {@macro family.call} - ProviderT call(Arg argument) { - return _providerFactory( - _createFn, - name: name, + /// {@macro riverpod.override_with} + Override overrideWithBuild( + RunNotifierBuild build, + ) { + return FamilyOverride( from: this, - argument: argument, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, + createElement: (container, provider) { + provider as ProviderT; + + return provider.copyWithBuild(build).createElement(container); + }, ); } @override - final String? name; - @override - final Iterable? dependencies; - @override - final Set? allTransitiveDependencies; - - /// {@macro riverpod.create_source_hash} - @internal - final DebugGetCreateSourceHash? debugGetCreateSourceHash; + String toString() => name ?? describeIdentity(this); } diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index 141e97c85..3274ec3a3 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -10,6 +10,8 @@ sealed class ProviderOrFamily implements ProviderListenableOrFamily { required this.name, required this.dependencies, required this.allTransitiveDependencies, + required this.isAutoDispose, + @internal required this.debugGetCreateSourceHash, }); /// The family that this provider/family depends on. @@ -81,6 +83,20 @@ sealed class ProviderOrFamily implements ProviderListenableOrFamily { /// All the dependencies of a provider and their dependencies too. final Iterable? allTransitiveDependencies; + + /// Whether the state associated to this provider should be disposed + /// automatically when the provider stops being listened. + final bool isAutoDispose; + + /// A debug-only function for obtaining a hash of the source code of the + /// initialization function. + /// + /// If after a hot-reload this function returns a different result, the + /// provider will be re-executed. + /// + /// This variable is only set by `riverpod_generator`. + @internal + final DebugGetCreateSourceHash? debugGetCreateSourceHash; } extension on ProviderListenableOrFamily { @@ -226,7 +242,7 @@ mixin ProviderListenable implements ProviderListenableOrFamily { /// } /// ``` /// - /// This will further optimise our widget by rebuilding it only when "isAdult" + /// This will further optimize our widget by rebuilding it only when "isAdult" /// changed instead of whenever the age changes. ProviderListenable select( Selected Function(State value) selector, diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart new file mode 100644 index 000000000..cbe491c5f --- /dev/null +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -0,0 +1,431 @@ +part of '../../framework.dart'; + +/// Internal typedef for cancelling the subscription to an async operation +@internal +typedef CancelAsyncSubscription = void Function(); + +@internal +base mixin FutureModifier on ProviderBase> { + /// Obtains the [Future] representing this provider. + /// + /// The instance of [Future] obtained may change over time. This typically + /// happens when a new "data" or "error" is emitted, or when the provider + /// re-enters a "loading" state. + /// + /// This modifier enables using `async`/`await` to easily combine + /// providers together: + /// + /// ```dart + /// final configsProvider = FutureProvider((ref) async => Configs()); + /// + /// final productsProvider = FutureProvider((ref) async { + /// // Wait for the configurations to resolve + /// final configs = await ref.watch(configsProvider.future); + /// + /// // Do something with the result + /// return await http.get('${configs.host}/products'); + /// }); + /// ``` + Refreshable> get future { + return ProviderElementProxy, Future>( + this, + (element) { + element as FutureModifierElement; + + return element.futureNotifier; + }, + ); + } + + /// {@template riverpod.async_select} + /// A variant of [select] for asynchronous values + /// + /// [selectAsync] is useful for filtering rebuilds of a provider + /// when it depends on asynchronous values, which we want to await. + /// + /// A common use-case would be to combine [selectAsync] with + /// [FutureProvider] to perform an async operation, where that + /// async operation depends on the result of another async operation. + /// + /// + /// ```dart + /// // A provider which asynchronously loads configurations, + /// // which may change over time. + /// final configsProvider = StreamProvider((ref) async { + /// // TO-DO fetch the configurations, such as by using Firebase + /// }); + /// + /// // A provider which fetches a list of products based on the configurations + /// final productsProvider = FutureProvider((ref) async { + /// // We obtain the host from the configs, while ignoring changes to + /// // other properties. As such, the productsProvider will rebuild only + /// // if the host changes + /// final host = await ref.watch(configsProvider.selectAsync((config) => config.host)); + /// + /// return http.get('$host/products'); + /// }); + /// ``` + /// {@endtemplate} + ProviderListenable> selectAsync( + Output Function(StateT data) selector, + ) { + return _AsyncSelector( + selector: selector, + provider: this, + future: future, + ); + } +} + +/// Mixin to help implement logic for listening to [Future]s/[Stream]s and setup +/// `provider.future` + convert the object into an [AsyncValue]. +@internal +// TODO merge with ProviderElementBase +mixin FutureModifierElement on ProviderElementBase> { + /// A default implementation for [ProviderElementBase.updateShouldNotify]. + static bool handleUpdateShouldNotify( + AsyncValue previous, + AsyncValue next, + ) { + final wasLoading = previous.isLoading; + final isLoading = next.isLoading; + + if (wasLoading || isLoading) return wasLoading != isLoading; + + return true; + } + + /// An observable for [FutureProvider.future]. + @internal + final futureNotifier = ProxyElementValueListenable>(); + Completer? _futureCompleter; + Future? _lastFuture; + CancelAsyncSubscription? _lastFutureSub; + CancelAsyncSubscription? _cancelSubscription; + + /// Handles manual state change (as opposed to automatic state change from + /// listening to the [Future]). + @override + @protected + AsyncValue get state => requireState; + + @override + @protected + set state(AsyncValue newState) { + // TODO assert Notifier isn't disposed + newState.map( + loading: _onLoading, + error: onError, + data: onData, + ); + } + + @override + bool updateShouldNotify( + AsyncValue previous, AsyncValue next) { + return FutureModifierElement.handleUpdateShouldNotify( + previous, + next, + ); + } + + void _onLoading(AsyncLoading value, {bool seamless = false}) { + asyncTransition(value, seamless: seamless); + if (_futureCompleter == null) { + final completer = _futureCompleter = Completer(); + futureNotifier.result = ResultData(completer.future); + } + } + + /// Life-cycle for when an error from the provider's "build" method is received. + /// + /// Might be invoked after the element is disposed in the case where `provider.future` + /// has yet to complete. + @internal + void onError(AsyncError value, {bool seamless = false}) { + asyncTransition(value, seamless: seamless); + + for (final observer in container.observers) { + runQuaternaryGuarded( + observer.providerDidFail, + provider, + value.error, + value.stackTrace, + container, + ); + } + + final completer = _futureCompleter; + if (completer != null) { + completer + // TODO test ignore + ..future.ignore() + ..completeError( + value.error, + value.stackTrace, + ); + _futureCompleter = null; + // TODO SynchronousFuture.error + } else { + futureNotifier.result = Result.data( + // TODO test ignore + Future.error( + value.error, + value.stackTrace, + )..ignore(), + ); + } + } + + /// Life-cycle for when a data from the provider's "build" method is received. + /// + /// Might be invoked after the element is disposed in the case where `provider.future` + /// has yet to complete. + @internal + void onData(AsyncData value, {bool seamless = false}) { + asyncTransition(value, seamless: seamless); + + final completer = _futureCompleter; + if (completer != null) { + completer.complete(value.value); + _futureCompleter = null; + } else { + futureNotifier.result = Result.data(Future.value(value.value)); + } + } + + /// Listens to a [Stream] and convert it into an [AsyncValue]. + @preferInline + @internal + void handleStream( + Stream Function() create, { + required bool didChangeDependency, + }) { + _handleAsync(didChangeDependency: didChangeDependency, ({ + required data, + required done, + required error, + required last, + }) { + final rawStream = create(); + final stream = rawStream.isBroadcast + ? rawStream + : rawStream.asBroadcastStream(onCancel: (sub) => sub.cancel()); + + stream.lastCancelable(last, orElseError: _missingLastValueError); + + final sub = stream.listen(data, onError: error, onDone: done); + return sub.cancel; + }); + } + + StateError _missingLastValueError() { + return StateError( + 'The provider $origin was disposed during loading state, ' + 'yet no value could be emitted.', + ); + } + + /// Listens to a [Future] and convert it into an [AsyncValue]. + @preferInline + @internal + void handleFuture( + FutureOr Function() create, { + required bool didChangeDependency, + }) { + _handleAsync(didChangeDependency: didChangeDependency, ({ + required data, + required done, + required error, + required last, + }) { + final futureOr = create(); + if (futureOr is! Future) { + data(futureOr); + done(); + return null; + } + // Received a Future + + var running = true; + void cancel() { + running = false; + } + + futureOr.then( + (value) { + if (!running) return; + data(value); + done(); + }, + // ignore: avoid_types_on_closure_parameters + onError: (Object err, StackTrace stackTrace) { + if (!running) return; + error(err, stackTrace); + done(); + }, + ); + + last(futureOr, cancel); + + return cancel; + }); + } + + /// Listens to a [Future] and transforms it into an [AsyncValue]. + void _handleAsync( + // Stream Function({required void Function(T) fireImmediately}) create, + CancelAsyncSubscription? Function({ + required void Function(StateT) data, + required void Function(Object, StackTrace) error, + required void Function() done, + required void Function(Future, CancelAsyncSubscription) last, + }) listen, { + required bool didChangeDependency, + }) { + _onLoading(AsyncLoading(), seamless: !didChangeDependency); + + try { + final sub = _cancelSubscription = listen( + data: (value) { + onData(AsyncData(value), seamless: !didChangeDependency); + }, + error: (error, stack) { + onError(AsyncError(error, stack), seamless: !didChangeDependency); + }, + last: (last, sub) { + assert(_lastFuture == null, 'bad state'); + assert(_lastFutureSub == null, 'bad state'); + _lastFuture = last; + _lastFutureSub = sub; + }, + done: () { + _lastFutureSub?.call(); + _lastFutureSub = null; + _lastFuture = null; + }, + ); + assert( + sub == null || _lastFuture != null, + 'An async operation is pending but the state for provider.future was not initialized.', + ); + + // TODO test build throws -> provider emits AsyncError synchronously & .future emits Future.error + // TODO test build resolves with error -> emits AsyncError & .future emits Future.error + // TODO test build emits value -> .future emits value & provider emits AsyncData + } catch (error, stackTrace) { + onError( + AsyncError(error, stackTrace), + seamless: !didChangeDependency, + ); + } + } + + @override + @internal + void runOnDispose() { + // Stops listening to the previous async operation + _lastFutureSub?.call(); + _lastFutureSub = null; + _lastFuture = null; + _cancelSubscription?.call(); + _cancelSubscription = null; + super.runOnDispose(); + } + + @override + void dispose() { + final completer = _futureCompleter; + if (completer != null) { + // Whatever happens after this, the error is emitted post dispose of the provider. + // So the error doesn't matter anymore. + completer.future.ignore(); + + final lastFuture = _lastFuture; + if (lastFuture != null) { + // The completer will be completed by the while loop in handleStream + + final cancelSubscription = _cancelSubscription; + if (cancelSubscription != null) { + completer.future + .then( + (_) {}, + // ignore: avoid_types_on_closure_parameters + onError: (Object _) {}, + ) + .whenComplete(cancelSubscription); + } + + // Prevent super.dispose from cancelling the subscription on the "last" + // stream value, so that it can be sent to `provider.future`. + _lastFuture = null; + _lastFutureSub = null; + _cancelSubscription = null; + } else { + // The listened stream completed during a "loading" state. + completer.completeError( + _missingLastValueError(), + StackTrace.current, + ); + } + } + super.dispose(); + } + + @override + void visitChildren({ + required void Function(ProviderElementBase element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); + listenableVisitor(futureNotifier); + } +} + +extension on Stream { + void lastCancelable( + void Function(Future, CancelAsyncSubscription) last, { + required Object Function() orElseError, + }) { + late StreamSubscription subscription; + final completer = Completer(); + + Result? result; + subscription = listen( + (event) => result = Result.data(event), + // ignore: avoid_types_on_closure_parameters + onError: (Object error, StackTrace stackTrace) { + result = Result.error(error, stackTrace); + }, + onDone: () { + if (result != null) { + result!.map( + data: (result) => completer.complete(result.state), + error: (result) { + // TODO: should this be reported to the zone? + completer.future.ignore(); + completer.completeError(result.error, result.stackTrace); + }, + ); + } else { + // The error happens after the associated provider is disposed. + // As such, it's normally never read. Reporting this error as uncaught + // would cause too many false-positives. And the edge-cases that + // do reach this error will throw anyway + completer.future.ignore(); + + completer.completeError( + orElseError(), + StackTrace.current, + ); + } + }, + ); + + last(completer.future, subscription.cancel); + } +} diff --git a/packages/riverpod/lib/src/core/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart similarity index 99% rename from packages/riverpod/lib/src/core/select.dart rename to packages/riverpod/lib/src/core/modifiers/select.dart index 77d4d7049..719416dd0 100644 --- a/packages/riverpod/lib/src/core/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -1,4 +1,4 @@ -part of '../framework.dart'; +part of '../../framework.dart'; /// An abstraction of both [ProviderContainer] and [ProviderElement] used by /// [ProviderListenable]. diff --git a/packages/riverpod/lib/src/core/select_async.dart b/packages/riverpod/lib/src/core/modifiers/select_async.dart similarity index 64% rename from packages/riverpod/lib/src/core/select_async.dart rename to packages/riverpod/lib/src/core/modifiers/select_async.dart index 1e4c4426a..b2b7f1a65 100644 --- a/packages/riverpod/lib/src/core/select_async.dart +++ b/packages/riverpod/lib/src/core/modifiers/select_async.dart @@ -1,68 +1,4 @@ -part of '../framework.dart'; - -/// Adds [selectAsync] to [ProviderListenable] -@internal -mixin AsyncSelector on ProviderListenable> { - /// Obtains the [Future] associated with a [FutureProvider]. - /// - /// The instance of [Future] obtained may change over time, if the provider - /// was recreated (such as when using [Ref.watch]). - /// - /// This provider allows using `async`/`await` to easily combine - /// [FutureProvider] together: - /// - /// ```dart - /// final configsProvider = FutureProvider((ref) async => Configs()); - /// - /// final productsProvider = FutureProvider((ref) async { - /// // Wait for the configurations to resolve - /// final configs = await ref.watch(configsProvider.future); - /// - /// // Do something with the result - /// return await http.get('${configs.host}/products'); - /// }); - /// ``` - Refreshable> get future; - - /// {@template riverpod.async_select} - /// A variant of [select] for asynchronous values - /// - /// [selectAsync] is useful for filtering rebuilds of a provider - /// when it depends on asynchronous values, which we want to await. - /// - /// A common use-case would be to combine [selectAsync] with - /// [FutureProvider] to perform an async operation, where that - /// async operation depends on the result of another async operation. - /// - /// - /// ```dart - /// // A provider which asynchronously loads configurations, - /// // which may change over time. - /// final configsProvider = StreamProvider((ref) async { - /// // TO-DO fetch the configurations, such as by using Firebase - /// }); - /// - /// // A provider which fetches a list of products based on the configurations - /// final productsProvider = FutureProvider((ref) async { - /// // We obtain the host from the configs, while ignoring changes to - /// // other properties. As such, the productsProvider will rebuild only - /// // if the host changes - /// final host = await ref.watch(configsProvider.selectAsync((config) => config.host)); - /// - /// return http.get('$host/products'); - /// }); - /// ``` - /// {@endtemplate} - ProviderListenable> selectAsync( - Output Function(Input data) selector, - ) { - return _AsyncSelector( - selector: selector, - provider: this, - future: future, - ); - } -} +part of '../../framework.dart'; /// An internal class for `ProviderBase.selectAsync`. @sealed diff --git a/packages/riverpod/lib/src/core/override.dart b/packages/riverpod/lib/src/core/override.dart index 6441e89dd..a2375e15b 100644 --- a/packages/riverpod/lib/src/core/override.dart +++ b/packages/riverpod/lib/src/core/override.dart @@ -55,7 +55,11 @@ class ProviderOverride implements _ProviderOverride { ProviderOverride({ required this.origin, required this.providerOverride, - }); + }) : assert( + providerOverride.dependencies == null && + providerOverride.allTransitiveDependencies == null, + 'Overriding a provider with dependencies is not supported.', + ); /// The provider that is overridden. final ProviderBase origin; diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index d351d99bb..f6db1b09d 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -5,7 +5,7 @@ part of '../framework.dart'; /// This is an implementation detail of `overrideWithValue`. @sealed @internal -class ValueProvider extends ProviderBase { +final class ValueProvider extends ProviderBase { /// Creates a [ValueProvider]. const ValueProvider(this._value) : super( @@ -15,6 +15,7 @@ class ValueProvider extends ProviderBase { debugGetCreateSourceHash: null, allTransitiveDependencies: null, dependencies: null, + isAutoDispose: false, ); final State _value; @@ -26,17 +27,15 @@ class ValueProvider extends ProviderBase { Set? get allTransitiveDependencies => null; @override - ValueProviderElement createElement(ProviderContainer container) { - return ValueProviderElement(this, container); + _ValueProviderElement createElement(ProviderContainer container) { + return _ValueProviderElement(this, container); } } /// The [ProviderElementBase] of a [ValueProvider] -@sealed -@internal -class ValueProviderElement extends ProviderElementBase { +class _ValueProviderElement extends ProviderElementBase { /// The [ProviderElementBase] of a [ValueProvider] - ValueProviderElement(this.provider, super.container); + _ValueProviderElement(this.provider, super.container); /// A custom listener called when `overrideWithValue` changes /// with a different value. diff --git a/packages/riverpod/lib/src/core/provider/functional_provider.dart b/packages/riverpod/lib/src/core/provider/functional_provider.dart new file mode 100644 index 000000000..01a319246 --- /dev/null +++ b/packages/riverpod/lib/src/core/provider/functional_provider.dart @@ -0,0 +1,61 @@ +part of '../../framework.dart'; + +@internal +abstract base class FunctionalProvider> extends ProviderBase { + const FunctionalProvider({ + required super.name, + required super.from, + required super.argument, + required super.debugGetCreateSourceHash, + required super.dependencies, + required super.allTransitiveDependencies, + required super.isAutoDispose, + }); + + @visibleForOverriding + FunctionalProvider copyWithCreate( + Create create, + ); + + /// {@template riverpod.override_with} + /// Override the provider with a new initialization function. + /// + /// This will also disable the auto-scoping mechanism, meaning that if the + /// overridden provider specified `dependencies`, it will have no effect. + /// + /// The override must not specify a `dependencies`. + /// + /// Some common use-cases are: + /// - testing, by replacing a service with a fake implementation, or to reach + /// a very specific state easily. + /// - multiple environments, by changing the implementation of a class + /// based on the platform or other parameters. + /// + /// This function should be used in combination with `ProviderScope.overrides` + /// or `ProviderContainer.overrides`: + /// + /// ```dart + /// final myService = Provider((ref) => MyService()); + /// + /// runApp( + /// ProviderScope( + /// overrides: [ + /// // Replace the implementation of the provider with a different one + /// myService.overrideWith((ref) { + /// ref.watch('other'); + /// return MyFakeService(), + /// })), + /// ], + /// child: MyApp(), + /// ), + /// ); + /// ``` + /// {@endtemplate} + Override overrideWith(Create create) { + return ProviderOverride( + origin: this, + providerOverride: copyWithCreate(create), + ); + } +} diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart new file mode 100644 index 000000000..7d0b24f3c --- /dev/null +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -0,0 +1,219 @@ +part of '../../framework.dart'; + +/// An error thrown if a Notifier is associated multiple times with a provider. +@internal +const alreadyInitializedError = ''' +A NotifierProvider returned a Notifier instance that is already associated +with another provider. + +To fix, do not reuse the same Notifier instance multiple times. +NotifierProviders are expected to always create a new Notifier instance. +'''; + +/// The error message for when a notifier is used when uninitialized. +@internal +const uninitializedElementError = ''' +Tried to use a notifier in an uninitialized state. +This means that you tried to either: +- Use ref/state inside the constructor of a notifier. + In this case you should move your logic inside the "build" method instead. +- Use ref/state after the notifier was disposed. + In this case, consider using `ref.onDispose` earlier in your notifier's lifecycle + to abort any pending logic that could try to use `ref/state`. +'''; + +@internal +typedef RunNotifierBuild< // + NotifierT, + CreatedT, + RefT extends Ref> + = CreatedT Function(RefT ref, NotifierT notifier); + +@internal +abstract class ClassBase { + ClassProviderElement, StateT, CreatedT>? _element; + + // TODO docs + @protected + Ref get ref { + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + return element; + } + + @visibleForTesting + @protected + StateT get state { + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + element.flush(); + return element.requireState; + } + + @visibleForTesting + @protected + set state(StateT newState) { + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + element.state = newState; + } + + @internal + CreatedT runBuild(); + + @visibleForOverriding + bool updateShouldNotify(StateT previous, StateT next); +} + +@internal +extension ClassBaseX on ClassBase { + ClassProviderElement, StateT, CreatedT>? + get element => _element; +} + +@internal +abstract base class ClassProvider< // + NotifierT extends ClassBase< // + StateT, + CreatedT>, + StateT, + CreatedT, + RefT extends Ref> extends ProviderBase { + const ClassProvider({ + required super.name, + required super.from, + required super.argument, + required super.debugGetCreateSourceHash, + required super.dependencies, + required super.allTransitiveDependencies, + required super.isAutoDispose, + required this.runNotifierBuildOverride, + }); + + @internal + final RunNotifierBuild? runNotifierBuildOverride; + + @internal + NotifierT create(); + + @visibleForOverriding + ClassProvider copyWithCreate( + NotifierT Function() create, + ); + + @visibleForOverriding + ClassProvider copyWithBuild( + RunNotifierBuild build, + ); + + /// {@macro riverpod.override_with} + Override overrideWith(NotifierT Function() create) { + return ProviderOverride( + origin: this, + providerOverride: copyWithCreate(create), + ); + } + + // TODO docs + Override overrideWithBuild( + RunNotifierBuild build, + ) { + return ProviderOverride( + origin: this, + providerOverride: copyWithBuild(build), + ); + } + + @override + ClassProviderElement< // + NotifierT, + StateT, + CreatedT> createElement(ProviderContainer container); +} + +abstract class ClassProviderElement< // + NotifierT extends ClassBase< // + StateT, + CreatedT>, + StateT, + CreatedT> // + extends ProviderElementBase { + ClassProviderElement(super.container); + + @override + ClassProvider> get provider; + + final classListenable = ProxyElementValueListenable(); + + @mustCallSuper + @override + void create({required bool didChangeDependency}) { + final result = classListenable.result ??= Result.guard(() { + final notifier = provider.create(); + if (notifier._element != null) { + throw StateError(alreadyInitializedError); + } + + notifier._element = this; + return notifier; + }); + + // TODO test notifier constructor throws -> provider emits AsyncError + // TODO test notifier constructor throws -> .notifier rethrows the error + // TODO test notifier constructor throws -> .future emits Future.error + + switch (result) { + case ResultData(): + try { + final created = + provider.runNotifierBuildOverride?.call(this, result.state) ?? + result.state.runBuild(); + handleValue(created, didChangeDependency: didChangeDependency); + } catch (err, stack) { + handleError(err, stack, didChangeDependency: didChangeDependency); + } + case ResultError(): + handleError( + result.error, + result.stackTrace, + didChangeDependency: didChangeDependency, + ); + } + } + + void handleValue(CreatedT created, {required bool didChangeDependency}); + void handleError( + Object error, + StackTrace stackTrace, { + required bool didChangeDependency, + }); + + @override + void dispose() { + super.dispose(); + classListenable.result?.stateOrNull?._element = null; + } + + @override + bool updateShouldNotify(StateT previous, StateT next) { + return classListenable.result?.stateOrNull + ?.updateShouldNotify(previous, next) ?? + true; + } + + @override + void visitChildren({ + required void Function(ProviderElementBase element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); + listenableVisitor(classListenable); + } +} diff --git a/packages/riverpod/lib/src/core/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart similarity index 57% rename from packages/riverpod/lib/src/core/provider.dart rename to packages/riverpod/lib/src/core/provider/provider.dart index 6e89b50e2..9ee3e36db 100644 --- a/packages/riverpod/lib/src/core/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -1,4 +1,4 @@ -part of '../framework.dart'; +part of '../../framework.dart'; /// A callback used by providers to create the value exposed. /// @@ -13,7 +13,7 @@ part of '../framework.dart'; /// - [Ref], which exposes the methods to read other providers. /// - [Provider], a provider that uses [Create] to expose an immutable value. @internal -typedef Create = T Function(R ref); +typedef Create> = T Function(R ref); /// A callback used to catches errors @internal @@ -25,34 +25,25 @@ typedef DebugGetCreateSourceHash = String Function(); /// A base class for _all_ providers. @immutable -abstract class ProviderBase extends ProviderOrFamily - with ProviderListenable - implements Refreshable, _ProviderOverride { +// TODO rename all generics to +// Marked as "base" because linters/generators rely on fields on const provider instances. +abstract base class ProviderBase extends ProviderOrFamily + with ProviderListenable + implements Refreshable, _ProviderOverride { /// A base class for _all_ providers. const ProviderBase({ required super.name, required this.from, required this.argument, - required this.debugGetCreateSourceHash, + required super.debugGetCreateSourceHash, required super.dependencies, required super.allTransitiveDependencies, + required super.isAutoDispose, }) : assert( from == null || allTransitiveDependencies == null, 'When from a family, providers cannot specify dependencies.', ); - /// {@template riverpod.create_source_hash} - /// A debug-only function for obtaining a hash of the source code of the - /// initialization function. - /// - /// If after a hot-reload this function returns a different result, the - /// provider will be re-executed. - /// - /// This variable is only set by `riverpod_generator`. - /// {@endtemplate} - @internal - final DebugGetCreateSourceHash? debugGetCreateSourceHash; - /// If this provider was created with the `.family` modifier, [from] is the `.family` instance. @override final Family? from; @@ -64,9 +55,9 @@ abstract class ProviderBase extends ProviderOrFamily final Object? argument; @override - ProviderSubscription addListener( + ProviderSubscription addListener( Node node, - void Function(State? previous, State next) listener, { + void Function(StateT? previous, StateT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, @@ -94,7 +85,7 @@ abstract class ProviderBase extends ProviderOrFamily } @override - State read(Node node) { + StateT read(Node node) { final element = node.readProviderElement(this); element.flush(); @@ -107,7 +98,7 @@ abstract class ProviderBase extends ProviderOrFamily /// An internal method that defines how a provider behaves. @visibleForOverriding - ProviderElementBase createElement(ProviderContainer container); + ProviderElementBase createElement(ProviderContainer container); @override int get hashCode { @@ -121,7 +112,7 @@ abstract class ProviderBase extends ProviderOrFamily if (from == null) return identical(other, this); return other.runtimeType == runtimeType && - other is ProviderBase && + other is ProviderBase && other.from == from && other.argument == argument; } @@ -143,49 +134,3 @@ abstract class ProviderBase extends ProviderOrFamily return '$label$leading'; } } - -var _debugIsRunningSelector = false; - -class _ExternalProviderSubscription - implements ProviderSubscription { - _ExternalProviderSubscription._( - this._listenedElement, - this._listener, { - required this.onError, - }); - - final void Function(State? previous, State next) _listener; - final ProviderElementBase _listenedElement; - final void Function(Object error, StackTrace stackTrace) onError; - var _closed = false; - - @override - void close() { - _closed = true; - _listenedElement._externalDependents.remove(this); - _listenedElement._onRemoveListener(); - } - - @override - State read() { - if (_closed) { - throw StateError( - 'called ProviderSubscription.read on a subscription that was closed', - ); - } - return _listenedElement.readSelf(); - } -} - -/// Deals with the internals of synchronously calling the listeners -/// when using `fireImmediately: true` -void _handleFireImmediately( - Result currentState, { - required void Function(State? previous, State current) listener, - required void Function(Object error, StackTrace stackTrace) onError, -}) { - currentState.map( - data: (data) => runBinaryGuarded(listener, null, data.state), - error: (error) => runBinaryGuarded(onError, error.error, error.stackTrace), - ); -} diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 12beff768..f97259689 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -1008,7 +1008,7 @@ class ProviderContainer implements Node { } }, // We only care about Elements here, so let's ignore notifiers - notifierVisitor: (_) {}, + listenableVisitor: (_) {}, ); } } diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index 214e9e82d..03a386ae9 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -36,3 +36,49 @@ class _ProviderListener implements ProviderSubscription { @override State read() => listenedElement.readSelf(); } + +var _debugIsRunningSelector = false; + +class _ExternalProviderSubscription + implements ProviderSubscription { + _ExternalProviderSubscription._( + this._listenedElement, + this._listener, { + required this.onError, + }); + + final void Function(State? previous, State next) _listener; + final ProviderElementBase _listenedElement; + final void Function(Object error, StackTrace stackTrace) onError; + var _closed = false; + + @override + void close() { + _closed = true; + _listenedElement._externalDependents.remove(this); + _listenedElement._onRemoveListener(); + } + + @override + State read() { + if (_closed) { + throw StateError( + 'called ProviderSubscription.read on a subscription that was closed', + ); + } + return _listenedElement.readSelf(); + } +} + +/// Deals with the internals of synchronously calling the listeners +/// when using `fireImmediately: true` +void _handleFireImmediately( + Result currentState, { + required void Function(State? previous, State current) listener, + required void Function(Object error, StackTrace stackTrace) onError, +}) { + currentState.map( + data: (data) => runBinaryGuarded(listener, null, data.state), + error: (error) => runBinaryGuarded(onError, error.error, error.stackTrace), + ); +} diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index 71ed30e47..81f205ef0 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -58,7 +58,7 @@ class ProviderElementProxy @override final ProviderBase provider; - final ProxyElementValueNotifier Function( + final ProxyElementValueListenable Function( ProviderElementBase element, ) _lense; diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index bf169ed20..6efaccd44 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -9,11 +9,35 @@ part of '../framework.dart'; /// - [read] and [watch], two methods that allow a provider to consume other providers. /// - [onDispose], a method that allows performing a task when the provider is destroyed. /// {@endtemplate} -@optionalTypeArgs -abstract class Ref { +abstract class Ref { + // TODO changelog breaking: AutoDisposeRef and related interfaces are removed. + // Use the non-autodispose variant instead. They now have the same API. + + /// Obtains the state currently exposed by this provider. + /// + /// Mutating this property will notify the provider listeners. + /// + /// If called before a value was set, there are two possible scenarios: + /// - on synchronous providers, this will throw a [StateError]. + /// - on asynchronous providers, this will return an [AsyncLoading]. + /// + /// Will throw if the provider threw during creation. + State get state; + set state(State newState); + /// The [ProviderContainer] that this provider is associated with. ProviderContainer get container; + /// Requests for the state of a provider to not be disposed when all the + /// listeners of the provider are removed. + /// + /// Returns an object which allows cancelling this operation, therefore + /// allowing the provider to dispose itself when all listeners are removed. + /// + /// If [keepAlive] is invoked multiple times, all [KeepAliveLink] will have + /// to be closed for the provider to dispose itself when all listeners are removed. + KeepAliveLink keepAlive(); + /// {@template riverpod.refresh} /// Forces a provider to re-evaluate its state immediately, and return the created value. /// @@ -307,35 +331,14 @@ abstract class Ref { }); } -/// A [Ref] for providers that are automatically destroyed when -/// no longer used. -/// -/// The difference with [Ref] is that it has an extra -/// [keepAlive] function to help determine if the state can be destroyed -/// or not. -abstract class AutoDisposeRef extends Ref { - /// Requests for the state of a provider to not be disposed when all the - /// listeners of the provider are removed. - /// - /// Returns an object which allows cancelling this operation, therefore - /// allowing the provider to dispose itself when all listeners are removed. - /// - /// If [keepAlive] is invoked multiple times, all [KeepAliveLink] will have - /// to be closed for the provider to dispose itself when all listeners are removed. - KeepAliveLink keepAlive(); +/// A object that maintains a provider alive. +class KeepAliveLink { + KeepAliveLink._(this._close); - @override - T watch( - // can read both auto-dispose and non-auto-dispose providers - ProviderListenable provider, - ); + final void Function() _close; - @override - ProviderSubscription listen( - // overridden to allow AutoDisposeProviderBase - ProviderListenable provider, - void Function(T? previous, T next) listener, { - bool fireImmediately, - void Function(Object error, StackTrace stackTrace)? onError, - }); + /// Release this [KeepAliveLink], allowing the associated provider to + /// be disposed if the provider is no-longer listener nor has any + /// remaining [KeepAliveLink]. + void close() => _close(); } diff --git a/packages/riverpod/lib/src/core/scheduler.dart b/packages/riverpod/lib/src/core/scheduler.dart index 683249186..8544ce1e1 100644 --- a/packages/riverpod/lib/src/core/scheduler.dart +++ b/packages/riverpod/lib/src/core/scheduler.dart @@ -50,7 +50,7 @@ class ProviderScheduler { return _defaultVsync; } - final _stateToDispose = >[]; + final _stateToDispose = >[]; final _stateToRefresh = >[]; Completer? _pendingTaskCompleter; @@ -95,9 +95,7 @@ class ProviderScheduler { } } - void scheduleProviderDispose( - AutoDisposeProviderElementMixin element, - ) { + void scheduleProviderDispose(ProviderElementBase element) { assert( !element.hasListeners, 'Tried to dispose ${element.origin} , but still has listeners', diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index 868b8dfe3..ac3c940ab 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -7,11 +7,13 @@ import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; import 'package:test/test.dart' as test; import 'common/env.dart'; +import 'common/pragma.dart'; import 'internals.dart'; -part 'core/auto_dispose.dart'; -part 'core/select_async.dart'; -part 'core/provider.dart'; +part 'core/modifiers/select_async.dart'; +part 'core/provider/provider.dart'; +part 'core/provider/functional_provider.dart'; +part 'core/provider/notifier_provider.dart'; part 'core/element.dart'; part 'core/provider_container.dart'; part 'core/family.dart'; @@ -19,8 +21,9 @@ part 'core/provider_subscription.dart'; part 'core/foundation.dart'; part 'core/proxy_provider_listenable.dart'; part 'core/ref.dart'; -part 'core/select.dart'; +part 'core/modifiers/select.dart'; part 'core/scheduler.dart'; part 'core/override_with_value.dart'; part 'core/override.dart'; part 'core/devtool.dart'; +part 'core/modifiers/future.dart'; diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier.dart index 6767c84fb..41a796ab6 100644 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier.dart +++ b/packages/riverpod/lib/src/legacy_providers/async_notifier.dart @@ -2,36 +2,21 @@ import 'dart:async'; import 'package:meta/meta.dart'; -import '../common/listenable.dart'; -import '../common/pragma.dart'; -import '../common/result.dart'; -import '../common/run_guarded.dart'; import '../core/async_value.dart'; import '../framework.dart'; import 'builders.dart'; import 'future_provider.dart' show FutureProvider; import 'notifier.dart'; -import 'stream_provider.dart'; -part 'async_notifier/auto_dispose.dart'; -part 'async_notifier/auto_dispose_family.dart'; -part 'async_notifier/base.dart'; +part 'async_notifier/orphan.dart'; part 'async_notifier/family.dart'; -part 'stream_notifier.dart'; -part 'stream_notifier/auto_dispose.dart'; -part 'stream_notifier/auto_dispose_family.dart'; -part 'stream_notifier/base.dart'; -part 'stream_notifier/family.dart'; -/// A base class for [AsyncNotifier]. -/// -/// Not meant for public consumption. -@internal -abstract class AsyncNotifierBase { - AsyncNotifierProviderElementBase, State>? - get _element; - - void _setElement(ProviderElementBase>? element); +abstract class _AsyncNotifierBase extends ClassBase< // + AsyncValue, + FutureOr> { + // TODO docs + @protected + Ref> get ref; /// The value currently exposed by this [AsyncNotifier]. /// @@ -45,26 +30,13 @@ abstract class AsyncNotifierBase { /// dependency has changed) will trigger [AsyncNotifier.build] to be re-executed. @visibleForTesting @protected - AsyncValue get state { - final element = _element; - if (element == null) throw StateError(uninitializedElementError); - - element.flush(); - return element.requireState; - } + @override + AsyncValue get state; @visibleForTesting @protected - set state(AsyncValue newState) { - final element = _element; - if (element == null) throw StateError(uninitializedElementError); - - element.state = newState; - } - - /// The [Ref] from the provider associated with this [AsyncNotifier]. - @protected - Ref> get ref; + @override + set state(AsyncValue newState); /// {@template riverpod.async_notifier.future} /// Obtains a [Future] that resolves with the first [state] value that is not @@ -79,10 +51,13 @@ abstract class AsyncNotifierBase { /// {@endtemplate} @visibleForTesting @protected - Future get future { - final element = _element; + Future get future { + // TODO remove downcast/upcast once "future" is merged with all providers + final Object? element = this.element; if (element == null) throw StateError(uninitializedElementError); + element as FutureModifierElement; + element.flush(); return element.futureNotifier.value; } @@ -103,14 +78,14 @@ abstract class AsyncNotifierBase { /// - [AsyncValue.guard], and alternate way to perform asynchronous operations. @visibleForTesting @protected - Future update( - FutureOr Function(State previousState) cb, { - FutureOr Function(Object err, StackTrace stackTrace)? onError, + Future update( + FutureOr Function(StateT previousState) cb, { + FutureOr Function(Object err, StackTrace stackTrace)? onError, }) async { // TODO cancel on rebuild? final newState = await future.then(cb, onError: onError); - state = AsyncData(newState); + state = AsyncData(newState); return newState; } @@ -132,50 +107,28 @@ abstract class AsyncNotifierBase { /// - [ProviderBase.select] and [AsyncSelector.selectAsync], which are /// alternative ways to filter out changes to [state]. @protected - bool updateShouldNotify(AsyncValue previous, AsyncValue next) { - return FutureHandlerProviderElementMixin.handleUpdateShouldNotify( + bool updateShouldNotify( + AsyncValue previous, + AsyncValue next, + ) { + return FutureModifierElement.handleUpdateShouldNotify( previous, next, ); } } -ProviderElementProxy, NotifierT> - _asyncNotifier, T>( - AsyncNotifierProviderBase that, -) { - return ProviderElementProxy, NotifierT>( - that, - (element) { - return (element as AsyncNotifierProviderElement) - ._notifierNotifier; - }, - ); -} - -ProviderElementProxy, Future> _asyncFuture( - AsyncNotifierProviderBase, T> that, -) { - return ProviderElementProxy, Future>( - that, - (element) { - return (element as AsyncNotifierProviderElement, T>) - .futureNotifier; - }, - ); -} - -/// A base class for [AsyncNotifierProvider] -/// -/// Not meant for public consumption -@visibleForTesting -@internal -abstract class AsyncNotifierProviderBase, - T> extends ProviderBase> with AsyncSelector { - /// A base class for [AsyncNotifierProvider] - /// - /// Not meant for public consumption - const AsyncNotifierProviderBase( +abstract base class _AsyncNotifierProviderBase< // + NotifierT extends _AsyncNotifierBase, + StateT> // + extends ClassProvider< // + NotifierT, + AsyncValue, + FutureOr, + Ref>> // + with + FutureModifier { + const _AsyncNotifierProviderBase( this._createNotifier, { required super.name, required super.from, @@ -183,38 +136,12 @@ abstract class AsyncNotifierProviderBase, required super.dependencies, required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, + required super.isAutoDispose, + required super.runNotifierBuildOverride, }); - /// Obtains the [AsyncNotifier] associated with this provider, without listening - /// to state changes. - /// - /// This is typically used to invoke methods on a [AsyncNotifier]. For example: - /// - /// ```dart - /// Button( - /// onTap: () => ref.read(stateNotifierProvider.notifier).increment(), - /// ) - /// ``` - /// - /// This listenable will notify its notifiers if the [AsyncNotifier] instance - /// changes. - /// This may happen if the provider is refreshed or one of its dependencies - /// has changes. - Refreshable get notifier; - - /// {@macro riverpod.async_notifier.future} - /// - /// Listening to this using [Ref.watch] will rebuild the widget/provider - /// when the [AsyncNotifier] emits a new value. - /// This will then return a new [Future] that resoles with the latest "state". - @override - Refreshable> get future; - final NotifierT Function() _createNotifier; - /// Runs the `build` method of a notifier. - /// - /// This is an implementation detail for differentiating [AsyncNotifier.build] - /// from [FamilyAsyncNotifier.build]. - FutureOr runNotifierBuild(AsyncNotifierBase notifier); + @override + NotifierT create() => _createNotifier(); } diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose.dart deleted file mode 100644 index 08bb25bbb..000000000 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose.dart +++ /dev/null @@ -1,138 +0,0 @@ -part of '../async_notifier.dart'; - -/// A [AutoDisposeAsyncNotifier] base class shared between family and non-family notifiers. -/// -/// Not meant for public consumption outside of riverpod_generator -@internal -abstract class BuildlessAutoDisposeAsyncNotifier - extends AsyncNotifierBase { - @override - AutoDisposeAsyncNotifierProviderElement, State>? - _element; - - @override - void _setElement(ProviderElementBase>? element) { - if (_element != null && element != null) { - throw StateError(alreadyInitializedError); - } - - _element = element as AutoDisposeAsyncNotifierProviderElement< - AsyncNotifierBase, State>?; - } - - @override - AutoDisposeAsyncNotifierProviderRef get ref { - final element = _element; - if (element == null) throw StateError(uninitializedElementError); - - return element; - } -} - -/// {@macro riverpod.async_notifier_provider} -/// -/// {@macro riverpod.async_notifier_provider_modifier} -abstract class AutoDisposeAsyncNotifier - extends BuildlessAutoDisposeAsyncNotifier { - /// {@macro riverpod.async_notifier.build} - @visibleForOverriding - FutureOr build(); -} - -/// {@macro riverpod.provider_ref_base} -abstract class AutoDisposeAsyncNotifierProviderRef - implements AsyncNotifierProviderRef, AutoDisposeRef> {} - -/// {@macro riverpod.async_notifier_provider} -/// -/// {@macro riverpod.async_notifier_provider_modifier} -typedef AutoDisposeAsyncNotifierProvider< - NotifierT extends AutoDisposeAsyncNotifier, T> - = AutoDisposeAsyncNotifierProviderImpl; - -/// The implementation of [AutoDisposeAsyncNotifierProvider] but with loosened type constraints -/// that can be shared with [AsyncNotifierProvider]. -/// -/// This enables tests to execute on both [AutoDisposeAsyncNotifierProvider] and -/// [AsyncNotifierProvider] at the same time. -@internal -class AutoDisposeAsyncNotifierProviderImpl< - NotifierT extends AsyncNotifierBase, - T> extends AsyncNotifierProviderBase with AsyncSelector { - /// {@macro riverpod.notifier} - AutoDisposeAsyncNotifierProviderImpl( - super._createNotifier, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - AutoDisposeAsyncNotifierProviderImpl.internal( - super._createNotifier, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.family} - static const family = AutoDisposeAsyncNotifierProviderFamily.new; - - @override - late final Refreshable notifier = - _asyncNotifier(this); - - @override - late final Refreshable> future = _asyncFuture(this); - - @override - AutoDisposeAsyncNotifierProviderElement createElement( - ProviderContainer container, - ) { - return AutoDisposeAsyncNotifierProviderElement(this, container); - } - - @override - @mustBeOverridden - FutureOr runNotifierBuild(AsyncNotifierBase notifier) { - return (notifier as AutoDisposeAsyncNotifier).build(); - } - - /// {@macro riverpod.override_with} - @mustBeOverridden - Override overrideWith(NotifierT Function() create) { - return ProviderOverride( - origin: this, - providerOverride: - AutoDisposeAsyncNotifierProviderImpl.internal( - create, - from: from, - argument: argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), - ); - } -} - -/// The element of [AutoDisposeAsyncNotifierProvider]. -class AutoDisposeAsyncNotifierProviderElement< - NotifierT extends AsyncNotifierBase, - T> extends AsyncNotifierProviderElement - with AutoDisposeProviderElementMixin> - implements AutoDisposeAsyncNotifierProviderRef { - /// The [ProviderElementBase] for [AsyncNotifierProvider] - @internal - AutoDisposeAsyncNotifierProviderElement(super.provider, super.container); -} diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose_family.dart deleted file mode 100644 index 5ef690d46..000000000 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier/auto_dispose_family.dart +++ /dev/null @@ -1,129 +0,0 @@ -part of '../async_notifier.dart'; - -/// {@macro riverpod.async_notifier_provider} -/// -/// {@macro riverpod.async_notifier_provider_modifier} -abstract class AutoDisposeFamilyAsyncNotifier - extends BuildlessAutoDisposeAsyncNotifier { - /// {@macro riverpod.notifier.family_arg} - late final Arg arg; - - @override - void _setElement(ProviderElementBase>? element) { - super._setElement(element); - if (element != null) { - arg = element.origin.argument as Arg; - } - } - - /// {@macro riverpod.async_notifier.build} - @visibleForOverriding - FutureOr build(Arg arg); -} - -/// {@macro riverpod.async_notifier_provider} -/// -/// {@macro riverpod.async_notifier_provider_modifier} -typedef AutoDisposeFamilyAsyncNotifierProvider< - NotifierT extends AutoDisposeFamilyAsyncNotifier, T, Arg> - = AutoDisposeFamilyAsyncNotifierProviderImpl; - -/// The implementation of [AutoDisposeAsyncNotifierProvider] but with loosened type constraints -/// that can be shared with [AsyncNotifierProvider]. -/// -/// This enables tests to execute on both [AutoDisposeAsyncNotifierProvider] and -/// [AsyncNotifierProvider] at the same time. -@internal -class AutoDisposeFamilyAsyncNotifierProviderImpl< - NotifierT extends AsyncNotifierBase, - T, - Arg> extends AsyncNotifierProviderBase with AsyncSelector { - /// {@macro riverpod.async_notifier_family_provider} - AutoDisposeFamilyAsyncNotifierProviderImpl( - super._createNotifier, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - AutoDisposeFamilyAsyncNotifierProviderImpl.internal( - super._createNotifier, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - @override - late final Refreshable notifier = - _asyncNotifier(this); - - @override - late final Refreshable> future = _asyncFuture(this); - - @override - AutoDisposeAsyncNotifierProviderElement createElement( - ProviderContainer container, - ) { - return AutoDisposeAsyncNotifierProviderElement(this, container); - } - - @override - FutureOr runNotifierBuild( - covariant AutoDisposeFamilyAsyncNotifier notifier, - ) { - return notifier.build(notifier.arg); - } -} - -/// The [Family] of [AsyncNotifierProvider]. -class AutoDisposeAsyncNotifierProviderFamily< - NotifierT extends AutoDisposeFamilyAsyncNotifier, T, Arg> - extends AutoDisposeNotifierFamilyBase< - AutoDisposeAsyncNotifierProviderRef, - AsyncValue, - Arg, - NotifierT, - AutoDisposeFamilyAsyncNotifierProvider> { - /// The [Family] of [AutoDisposeAsyncNotifierProvider]. - AutoDisposeAsyncNotifierProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: AutoDisposeFamilyAsyncNotifierProvider.internal, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, - ); - - /// {@macro riverpod.override_with} - Override overrideWith(NotifierT Function() create) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as AutoDisposeFamilyAsyncNotifierProvider; - - return AutoDisposeFamilyAsyncNotifierProvider.internal( - create, - from: provider.from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier/base.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/base.dart deleted file mode 100644 index 919992a33..000000000 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier/base.dart +++ /dev/null @@ -1,599 +0,0 @@ -part of '../async_notifier.dart'; - -/// A [AsyncNotifier] base class shared between family and non-family notifiers. -/// -/// Not meant for public consumption outside of riverpod_generator -@internal -abstract class BuildlessAsyncNotifier extends AsyncNotifierBase { - @override - AsyncNotifierProviderElement, State>? _element; - - @override - void _setElement(ProviderElementBase>? element) { - if (_element != null && element != null) { - throw StateError(alreadyInitializedError); - } - _element = element - as AsyncNotifierProviderElement, State>?; - } - - @override - AsyncNotifierProviderRef get ref { - final element = _element; - if (element == null) throw StateError(uninitializedElementError); - - return element; - } -} - -/// {@template riverpod.async_notifier} -/// A [Notifier] implementation that is asynchronously initialized. -/// -/// This is similar to a [FutureProvider] but allows to perform side-effects -/// by defining public methods. -/// -/// It is commonly used for: -/// - Caching a network request while also allowing to perform side-effects. -/// For example, `build` could fetch information about the current "user". -/// And the [AsyncNotifier] could expose methods such as "setName", -/// to allow changing the current user name. -/// - Initializing a [Notifier] from an asynchronous source of data. -/// For example, obtaining the initial state of [Notifier] from a local database. -/// {@endtemplate} -/// -/// {@macro riverpod.async_notifier_provider_modifier} -abstract class AsyncNotifier extends BuildlessAsyncNotifier { - /// {@template riverpod.async_notifier.build} - /// Initialize an [AsyncNotifier]. - /// - /// It is safe to use [Ref.watch] or [Ref.listen] inside this method. - /// - /// If a dependency of this [AsyncNotifier] (when using [Ref.watch]) changes, - /// then [build] will be re-executed. On the other hand, the [AsyncNotifier] - /// will **not** be recreated. Its instance will be preserved between - /// executions of [build]. - /// - /// If this method throws or returns a future that fails, the error - /// will be caught and an [AsyncError] will be emitted. - /// {@endtemplate} - @visibleForOverriding - FutureOr build(); -} - -/// {@macro riverpod.provider_ref_base} -abstract class AsyncNotifierProviderRef implements Ref> {} - -/// {@template riverpod.async_notifier_provider} -/// A provider which creates and listen to an [AsyncNotifier]. -/// -/// This is similar to [FutureProvider] but allows to perform side-effects. -/// -/// The syntax for using this provider is slightly different from the others -/// in that the provider's function doesn't receive a "ref" (and in case -/// of `family`, doesn't receive an argument either). -/// Instead the ref (and argument) are directly accessible in the associated -/// [AsyncNotifier]. -/// {@endtemplate} -/// -/// {@template riverpod.async_notifier_provider_modifier} -/// When using `autoDispose` or `family`, your notifier type changes. -/// Instead of extending [AsyncNotifier], you should extend either: -/// - [AutoDisposeAsyncNotifier] for `autoDispose` -/// - [FamilyAsyncNotifier] for `family` -/// - [AutoDisposeFamilyAsyncNotifier] for `autoDispose.family` -/// {@endtemplate} -typedef AsyncNotifierProvider, T> - = AsyncNotifierProviderImpl; - -/// The implementation of [AsyncNotifierProvider] but with loosened type constraints -/// that can be shared with [AutoDisposeAsyncNotifierProvider]. -/// -/// This enables tests to execute on both [AsyncNotifierProvider] and -/// [AutoDisposeAsyncNotifierProvider] at the same time. -@visibleForTesting -@internal -class AsyncNotifierProviderImpl, T> - extends AsyncNotifierProviderBase { - /// {@macro riverpod.async_notifier_provider} - /// - /// {@macro riverpod.async_notifier_provider_modifier} - AsyncNotifierProviderImpl( - super._createNotifier, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - AsyncNotifierProviderImpl.internal( - super._createNotifier, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeAsyncNotifierProviderBuilder(); - - /// {@macro riverpod.family} - static const family = AsyncNotifierProviderFamilyBuilder(); - - @override - late final Refreshable notifier = - _asyncNotifier(this); - - @override - late final Refreshable> future = _asyncFuture(this); - - @override - AsyncNotifierProviderElement createElement( - ProviderContainer container, - ) { - return AsyncNotifierProviderElement(this, container); - } - - @override - @mustBeOverridden - FutureOr runNotifierBuild(AsyncNotifierBase notifier) { - return (notifier as AsyncNotifier).build(); - } - - /// {@macro riverpod.override_with} - @mustBeOverridden - Override overrideWith(NotifierT Function() create) { - return ProviderOverride( - origin: this, - providerOverride: AsyncNotifierProviderImpl.internal( - create, - from: from, - argument: argument, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), - ); - } -} - -/// Internal typedef for cancelling the subscription to an async operation -@internal -typedef CancelAsyncSubscription = void Function(); - -/// Mixin to help implement logic for listening to [Future]s/[Stream]s and setup -/// `provider.future` + convert the object into an [AsyncValue]. -@internal -mixin FutureHandlerProviderElementMixin - on ProviderElementBase> { - /// A default implementation for [ProviderElementBase.updateShouldNotify]. - static bool handleUpdateShouldNotify( - AsyncValue previous, - AsyncValue next, - ) { - final wasLoading = previous.isLoading; - final isLoading = next.isLoading; - - if (wasLoading || isLoading) return wasLoading != isLoading; - - return true; - } - - /// An internal function used to obtain the private [futureNotifier] from the mixin - static ProxyElementValueNotifier> futureNotifierOf( - FutureHandlerProviderElementMixin handler, - ) { - return handler.futureNotifier; - } - - /// An observable for [FutureProvider.future]. - @internal - final futureNotifier = ProxyElementValueNotifier>(); - Completer? _futureCompleter; - Future? _lastFuture; - CancelAsyncSubscription? _lastFutureSub; - CancelAsyncSubscription? _cancelSubscription; - - /// Handles manual state change (as opposed to automatic state change from - /// listening to the [Future]). - @protected - AsyncValue get state => requireState; - - @protected - set state(AsyncValue newState) { - // TODO assert Notifier isn't disposed - newState.map( - loading: _onLoading, - error: onError, - data: onData, - ); - } - - @override - bool updateShouldNotify(AsyncValue previous, AsyncValue next) { - return FutureHandlerProviderElementMixin.handleUpdateShouldNotify( - previous, - next, - ); - } - - void _onLoading(AsyncLoading value, {bool seamless = false}) { - asyncTransition(value, seamless: seamless); - if (_futureCompleter == null) { - final completer = _futureCompleter = Completer(); - futureNotifier.result = ResultData(completer.future); - } - } - - /// Life-cycle for when an error from the provider's "build" method is received. - /// - /// Might be invoked after the element is disposed in the case where `provider.future` - /// has yet to complete. - @internal - void onError(AsyncError value, {bool seamless = false}) { - asyncTransition(value, seamless: seamless); - - for (final observer in container.observers) { - runQuaternaryGuarded( - observer.providerDidFail, - provider, - value.error, - value.stackTrace, - container, - ); - } - - final completer = _futureCompleter; - if (completer != null) { - completer - // TODO test ignore - ..future.ignore() - ..completeError( - value.error, - value.stackTrace, - ); - _futureCompleter = null; - // TODO SynchronousFuture.error - } else { - futureNotifier.result = Result.data( - // TODO test ignore - Future.error( - value.error, - value.stackTrace, - )..ignore(), - ); - } - } - - /// Life-cycle for when a data from the provider's "build" method is received. - /// - /// Might be invoked after the element is disposed in the case where `provider.future` - /// has yet to complete. - @internal - void onData(AsyncData value, {bool seamless = false}) { - asyncTransition(value, seamless: seamless); - - final completer = _futureCompleter; - if (completer != null) { - completer.complete(value.value); - _futureCompleter = null; - } else { - futureNotifier.result = Result.data(Future.value(value.value)); - } - } - - /// Listens to a [Stream] and convert it into an [AsyncValue]. - @preferInline - @internal - void handleStream( - Stream Function() create, { - required bool didChangeDependency, - }) { - _handleAsync(didChangeDependency: didChangeDependency, ({ - required data, - required done, - required error, - required last, - }) { - final rawStream = create(); - final stream = rawStream.isBroadcast - ? rawStream - : rawStream.asBroadcastStream(onCancel: (sub) => sub.cancel()); - - stream.lastCancelable(last, orElseError: _missingLastValueError); - - final sub = stream.listen(data, onError: error, onDone: done); - return sub.cancel; - }); - } - - StateError _missingLastValueError() { - return StateError( - 'The provider $origin was disposed during loading state, ' - 'yet no value could be emitted.', - ); - } - - /// Listens to a [Future] and convert it into an [AsyncValue]. - @preferInline - @internal - void handleFuture( - FutureOr Function() create, { - required bool didChangeDependency, - }) { - _handleAsync(didChangeDependency: didChangeDependency, ({ - required data, - required done, - required error, - required last, - }) { - final futureOr = create(); - if (futureOr is! Future) { - data(futureOr); - done(); - return null; - } - // Received a Future - - var running = true; - void cancel() { - running = false; - } - - futureOr.then( - (value) { - if (!running) return; - data(value); - done(); - }, - // ignore: avoid_types_on_closure_parameters - onError: (Object err, StackTrace stackTrace) { - if (!running) return; - error(err, stackTrace); - done(); - }, - ); - - last(futureOr, cancel); - - return cancel; - }); - } - - /// Listens to a [Future] and transforms it into an [AsyncValue]. - void _handleAsync( - // Stream Function({required void Function(T) fireImmediately}) create, - CancelAsyncSubscription? Function({ - required void Function(T) data, - required void Function(Object, StackTrace) error, - required void Function() done, - required void Function(Future, CancelAsyncSubscription) last, - }) listen, { - required bool didChangeDependency, - }) { - _onLoading(AsyncLoading(), seamless: !didChangeDependency); - - try { - final sub = _cancelSubscription = listen( - data: (value) { - onData(AsyncData(value), seamless: !didChangeDependency); - }, - error: (error, stack) { - onError(AsyncError(error, stack), seamless: !didChangeDependency); - }, - last: (last, sub) { - assert(_lastFuture == null, 'bad state'); - assert(_lastFutureSub == null, 'bad state'); - _lastFuture = last; - _lastFutureSub = sub; - }, - done: () { - _lastFutureSub?.call(); - _lastFutureSub = null; - _lastFuture = null; - }, - ); - assert( - sub == null || _lastFuture != null, - 'An async operation is pending but the state for provider.future was not initialized.', - ); - - // TODO test build throws -> provider emits AsyncError synchronously & .future emits Future.error - // TODO test build resolves with error -> emits AsyncError & .future emits Future.error - // TODO test build emits value -> .future emits value & provider emits AsyncData - } catch (error, stackTrace) { - onError( - AsyncError(error, stackTrace), - seamless: !didChangeDependency, - ); - } - } - - @override - @internal - void runOnDispose() { - // Stops listening to the previous async operation - _lastFutureSub?.call(); - _lastFutureSub = null; - _lastFuture = null; - _cancelSubscription?.call(); - _cancelSubscription = null; - super.runOnDispose(); - } - - @override - void dispose() { - final completer = _futureCompleter; - if (completer != null) { - // Whatever happens after this, the error is emitted post dispose of the provider. - // So the error doesn't matter anymore. - completer.future.ignore(); - - final lastFuture = _lastFuture; - if (lastFuture != null) { - // The completer will be completed by the while loop in handleStream - - final cancelSubscription = _cancelSubscription; - if (cancelSubscription != null) { - completer.future - .then( - (_) {}, - // ignore: avoid_types_on_closure_parameters - onError: (Object _) {}, - ) - .whenComplete(cancelSubscription); - } - - // Prevent super.dispose from cancelling the subscription on the "last" - // stream value, so that it can be sent to `provider.future`. - _lastFuture = null; - _lastFutureSub = null; - _cancelSubscription = null; - } else { - // The listened stream completed during a "loading" state. - completer.completeError( - _missingLastValueError(), - StackTrace.current, - ); - } - } - super.dispose(); - } - - @override - void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, - required void Function(ProxyElementValueNotifier element) - notifierVisitor, - }) { - super.visitChildren( - elementVisitor: elementVisitor, - notifierVisitor: notifierVisitor, - ); - notifierVisitor(futureNotifier); - } -} - -/// The element of [AsyncNotifierProvider]. -abstract class AsyncNotifierProviderElementBase< - NotifierT extends AsyncNotifierBase, - T> extends ProviderElementBase> - with FutureHandlerProviderElementMixin { - /// The element of [AsyncNotifierProvider]. - @internal - AsyncNotifierProviderElementBase(super.container); - - final _notifierNotifier = ProxyElementValueNotifier(); - - @override - void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, - required void Function(ProxyElementValueNotifier element) - notifierVisitor, - }) { - super.visitChildren( - elementVisitor: elementVisitor, - notifierVisitor: notifierVisitor, - ); - notifierVisitor(_notifierNotifier); - } - - @override - bool updateShouldNotify(AsyncValue previous, AsyncValue next) { - return _notifierNotifier.result?.stateOrNull - ?.updateShouldNotify(previous, next) ?? - true; - } - - @override - void dispose() { - super.dispose(); - _notifierNotifier.result?.stateOrNull?._setElement(null); - } -} - -/// The element of [AsyncNotifierProvider]. -class AsyncNotifierProviderElement, T> - extends AsyncNotifierProviderElementBase - implements AsyncNotifierProviderRef { - /// The element of [AsyncNotifierProvider]. - @internal - AsyncNotifierProviderElement(this.provider, super.container); - - @override - final AsyncNotifierProviderBase provider; - - @override - void create({required bool didChangeDependency}) { - final notifierResult = _notifierNotifier.result ??= Result.guard(() { - return provider._createNotifier().._setElement(this); - }); - - // TODO test notifier constructor throws -> provider emits AsyncError - // TODO test notifier constructor throws -> .notifier rethrows the error - // TODO test notifier constructor throws -> .future emits Future.error - notifierResult.when( - error: (error, stackTrace) { - onError(AsyncError(error, stackTrace), seamless: !didChangeDependency); - }, - data: (notifier) { - handleFuture( - () => provider.runNotifierBuild(notifier), - didChangeDependency: didChangeDependency, - ); - }, - ); - } -} - -extension on Stream { - void lastCancelable( - void Function(Future, CancelAsyncSubscription) last, { - required Object Function() orElseError, - }) { - late StreamSubscription subscription; - final completer = Completer(); - - Result? result; - subscription = listen( - (event) => result = Result.data(event), - // ignore: avoid_types_on_closure_parameters - onError: (Object error, StackTrace stackTrace) { - result = Result.error(error, stackTrace); - }, - onDone: () { - if (result != null) { - result!.map( - data: (result) => completer.complete(result.state), - error: (result) { - // TODO: should this be reported to the zone? - completer.future.ignore(); - completer.completeError(result.error, result.stackTrace); - }, - ); - } else { - // The error happens after the associated provider is disposed. - // As such, it's normally never read. Reporting this error as uncaught - // would cause too many false-positives. And the edge-cases that - // do reach this error will throw anyway - completer.future.ignore(); - - completer.completeError( - orElseError(), - StackTrace.current, - ); - } - }, - ); - - last(completer.future, subscription.cancel); - } -} diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart index fb3e93524..7180f3aad 100644 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart @@ -4,7 +4,7 @@ part of '../async_notifier.dart'; /// /// {@macro riverpod.async_notifier_provider_modifier} abstract class FamilyAsyncNotifier - extends BuildlessAsyncNotifier { + extends _AsyncNotifierBase { /// {@template riverpod.notifier.family_arg} /// The argument that was passed to this family. /// @@ -18,117 +18,110 @@ abstract class FamilyAsyncNotifier /// {@endtemplate} late final Arg arg; - @override - void _setElement(ProviderElementBase>? element) { - super._setElement(element); - if (element != null) { - arg = element.origin.argument as Arg; - } - } - /// {@macro riverpod.async_notifier.build} @visibleForOverriding FutureOr build(Arg arg); } -/// {@macro riverpod.async_notifier_provider} -/// -/// {@macro riverpod.async_notifier_provider_modifier} -typedef AsyncNotifierFamilyProvider< - NotifierT extends FamilyAsyncNotifier, T, Arg> - = FamilyAsyncNotifierProviderImpl; - -/// An internal implementation of [AsyncNotifierFamilyProvider] for testing purpose. -/// -/// Not meant for public consumption. -@visibleForTesting -@internal -class FamilyAsyncNotifierProviderImpl, T, - Arg> extends AsyncNotifierProviderBase { - /// {@macro riverpod.async_notifier_family_provider} - FamilyAsyncNotifierProviderImpl( +final class FamilyAsyncNotifierProvider< // + NotifierT extends FamilyAsyncNotifier, + StateT, + ArgT> // + extends _AsyncNotifierProviderBase { + const FamilyAsyncNotifierProvider( super._createNotifier, { super.name, super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.isAutoDispose, + required super.from, + required super.argument, + required super.runNotifierBuildOverride, + }); /// An implementation detail of Riverpod @internal - FamilyAsyncNotifierProviderImpl.internal( + const FamilyAsyncNotifierProvider.internal( super._createNotifier, { required super.name, required super.dependencies, required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, - super.from, - super.argument, + required super.from, + required super.argument, + required super.isAutoDispose, + required super.runNotifierBuildOverride, }); /// {@macro riverpod.autoDispose} static const autoDispose = AutoDisposeAsyncNotifierProviderFamily.new; @override - late final Refreshable notifier = - _asyncNotifier(this); + _AsyncNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _AsyncNotifierProviderElement(this, container); + } - @override - late final Refreshable> future = _asyncFuture(this); + FamilyAsyncNotifierProvider _copyWith({ + NotifierT Function()? create, + RunNotifierBuild< // + NotifierT, + FutureOr, + Ref>>? + build, + }) { + return FamilyAsyncNotifierProvider.internal( + create ?? _createNotifier, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + isAutoDispose: isAutoDispose, + runNotifierBuildOverride: build ?? runNotifierBuildOverride, + from: from, + argument: argument, + ); + } @override - AsyncNotifierProviderElement createElement( - ProviderContainer container, + FamilyAsyncNotifierProvider copyWithBuild( + RunNotifierBuild, Ref>> + build, ) { - return AsyncNotifierProviderElement(this, container); + return _copyWith(build: build); } @override - FutureOr runNotifierBuild( - covariant FamilyAsyncNotifier notifier, + FamilyAsyncNotifierProvider copyWithCreate( + NotifierT Function() create, ) { - return notifier.build(notifier.arg); + return _copyWith(create: create); } } /// The [Family] of [AsyncNotifierProvider]. -class AsyncNotifierProviderFamily, - T, Arg> - extends NotifierFamilyBase, AsyncValue, Arg, - NotifierT, AsyncNotifierFamilyProvider> { +class AsyncNotifierProviderFamily< // + NotifierT extends FamilyAsyncNotifier, + StateT, + ArgT> // + extends ClassFamily< // + NotifierT, + AsyncValue, + Ref>, + ArgT, + FutureOr, + FamilyAsyncNotifierProvider> { /// The [Family] of [AsyncNotifierProvider]. - AsyncNotifierProviderFamily( + AsyncNotifierProviderFamily.internal( super._createFn, { super.name, super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.isAutoDispose, }) : super( - providerFactory: AsyncNotifierFamilyProvider.internal, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, + providerFactory: FamilyAsyncNotifierProvider.internal, ); - - /// {@macro riverpod.override_with} - Override overrideWith(NotifierT Function() create) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as AsyncNotifierFamilyProvider; - - return AsyncNotifierFamilyProvider.internal( - create, - from: from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } } diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/orphan.dart new file mode 100644 index 000000000..f63bd1919 --- /dev/null +++ b/packages/riverpod/lib/src/legacy_providers/async_notifier/orphan.dart @@ -0,0 +1,174 @@ +part of '../async_notifier.dart'; + +/// {@template riverpod.async_notifier} +/// A [Notifier] implementation that is asynchronously initialized. +/// +/// This is similar to a [FutureProvider] but allows to perform side-effects +/// by defining public methods. +/// +/// It is commonly used for: +/// - Caching a network request while also allowing to perform side-effects. +/// For example, `build` could fetch information about the current "user". +/// And the [AsyncNotifier] could expose methods such as "setName", +/// to allow changing the current user name. +/// - Initializing a [Notifier] from an asynchronous source of data. +/// For example, obtaining the initial state of [Notifier] from a local database. +/// {@endtemplate} +/// +/// {@macro riverpod.async_notifier_provider_modifier} +abstract class AsyncNotifier extends _AsyncNotifierBase { + /// {@template riverpod.async_notifier.build} + /// Initialize an [AsyncNotifier]. + /// + /// It is safe to use [Ref.watch] or [Ref.listen] inside this method. + /// + /// If a dependency of this [AsyncNotifier] (when using [Ref.watch]) changes, + /// then [build] will be re-executed. On the other hand, the [AsyncNotifier] + /// will **not** be recreated. Its instance will be preserved between + /// executions of [build]. + /// + /// If this method throws or returns a future that fails, the error + /// will be caught and an [AsyncError] will be emitted. + /// {@endtemplate} + @visibleForOverriding + FutureOr build(); +} + +/// {@template riverpod.async_notifier_provider} +/// A provider which creates and listen to an [AsyncNotifier]. +/// +/// This is similar to [FutureProvider] but allows to perform side-effects. +/// +/// The syntax for using this provider is slightly different from the others +/// in that the provider's function doesn't receive a "ref" (and in case +/// of `family`, doesn't receive an argument either). +/// Instead the ref (and argument) are directly accessible in the associated +/// [AsyncNotifier]. +/// {@endtemplate} +/// +/// {@template riverpod.async_notifier_provider_modifier} +/// When using `autoDispose` or `family`, your notifier type changes. +/// Instead of extending [AsyncNotifier], you should extend either: +/// - [AutoDisposeAsyncNotifier] for `autoDispose` +/// - [FamilyAsyncNotifier] for `family` +/// - [AutoDisposeFamilyAsyncNotifier] for `autoDispose.family` +/// {@endtemplate} +final class AsyncNotifierProvider< // + NotifierT extends AsyncNotifier, + StateT> // + extends _AsyncNotifierProviderBase { + /// {@macro riverpod.async_notifier_provider} + /// + /// {@macro riverpod.async_notifier_provider_modifier} + AsyncNotifierProvider( + super._createNotifier, { + super.name, + super.dependencies, + super.runNotifierBuildOverride, + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, + isAutoDispose: false, + ); + + /// An implementation detail of Riverpod + @internal + AsyncNotifierProvider.internal( + super._createNotifier, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required super.argument, + required super.isAutoDispose, + required super.runNotifierBuildOverride, + }); + + /// {@macro riverpod.autoDispose} + static const autoDispose = AutoDisposeAsyncNotifierProviderBuilder(); + + /// {@macro riverpod.family} + static const family = AsyncNotifierProviderFamilyBuilder(); + + AsyncNotifierProvider _copyWith({ + NotifierT Function()? create, + RunNotifierBuild, Ref>>? + build, + }) { + return AsyncNotifierProvider.internal( + create ?? _createNotifier, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + argument: argument, + isAutoDispose: isAutoDispose, + runNotifierBuildOverride: build ?? runNotifierBuildOverride, + ); + } + + @internal + @override + _AsyncNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _AsyncNotifierProviderElement(this, container); + } + + @internal + @override + AsyncNotifierProvider copyWithBuild( + RunNotifierBuild, Ref>>? + build, + ) { + return _copyWith(build: build); + } + + @internal + @override + AsyncNotifierProvider copyWithCreate( + NotifierT Function() create, + ) { + return _copyWith(create: create); + } +} + +class _AsyncNotifierProviderElement< // + NotifierT extends _AsyncNotifierBase, + StateT> // + extends ClassProviderElement< // + NotifierT, + AsyncValue, + FutureOr> // + with + FutureModifierElement { + _AsyncNotifierProviderElement(this.provider, super.container); + + @override + final _AsyncNotifierProviderBase provider; + + @override + void handleError( + Object error, + StackTrace stackTrace, { + required bool didChangeDependency, + }) { + onError(AsyncError(error, stackTrace), seamless: !didChangeDependency); + } + + @override + void handleValue( + FutureOr created, { + required bool didChangeDependency, + }) { + handleFuture( + () => created, + didChangeDependency: didChangeDependency, + ); + } +} diff --git a/packages/riverpod/lib/src/legacy_providers/builders.dart b/packages/riverpod/lib/src/legacy_providers/builders.dart index 2e069c501..6a14190c4 100644 --- a/packages/riverpod/lib/src/legacy_providers/builders.dart +++ b/packages/riverpod/lib/src/legacy_providers/builders.dart @@ -685,7 +685,7 @@ class ProviderBuilder { /// {@macro riverpod.autoDispose} Provider call( - Create> create, { + Create> create, { String? name, Iterable? dependencies, }) { @@ -714,14 +714,17 @@ class ProviderFamilyBuilder { /// {@macro riverpod.family} ProviderFamily call( - FamilyCreate, Arg> create, { + FamilyCreate, Arg> create, { String? name, Iterable? dependencies, }) { - return ProviderFamily( + return ProviderFamily.internal( create, name: name, dependencies: dependencies, + isAutoDispose: false, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, ); } @@ -771,10 +774,13 @@ class FutureProviderFamilyBuilder { String? name, Iterable? dependencies, }) { - return FutureProviderFamily( + return FutureProviderFamily.internal( create, name: name, dependencies: dependencies, + allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + debugGetCreateSourceHash: null, + isAutoDispose: false, ); } @@ -791,7 +797,7 @@ class StreamProviderBuilder { /// {@macro riverpod.autoDispose} StreamProvider call( - Create, StreamProviderRef> create, { + Create, Ref>> create, { String? name, Iterable? dependencies, }) { @@ -820,11 +826,11 @@ class StreamProviderFamilyBuilder { /// {@macro riverpod.family} StreamProviderFamily call( - FamilyCreate, StreamProviderRef, Arg> create, { + FamilyCreate, Ref>, Arg> create, { String? name, Iterable? dependencies, }) { - return StreamProviderFamily( + return StreamProviderFamily.internal( create, name: name, dependencies: dependencies, @@ -934,15 +940,20 @@ class AutoDisposeProviderBuilder { const AutoDisposeProviderBuilder(); /// {@macro riverpod.autoDispose} - AutoDisposeProvider call( - Create> create, { + Provider call( + Create> create, { String? name, Iterable? dependencies, }) { - return AutoDisposeProvider( + return Provider.internal( create, name: name, dependencies: dependencies, + isAutoDispose: true, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + from: null, + argument: null, ); } @@ -952,21 +963,24 @@ class AutoDisposeProviderBuilder { } } -/// Builds a [AutoDisposeProviderFamily]. +/// Builds an auto-dispose [ProviderFamily]. class AutoDisposeProviderFamilyBuilder { - /// Builds a [AutoDisposeProviderFamily]. + /// Builds an auto-dispose [ProviderFamily]. const AutoDisposeProviderFamilyBuilder(); /// {@macro riverpod.family} - AutoDisposeProviderFamily call( - FamilyCreate, Arg> create, { + ProviderFamily call( + FamilyCreate, Arg> create, { String? name, Iterable? dependencies, }) { - return AutoDisposeProviderFamily( + return ProviderFamily.internal( create, name: name, + isAutoDispose: true, dependencies: dependencies, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, ); } } diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart index 9601dcc7d..1e0f18456 100644 --- a/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart @@ -154,7 +154,7 @@ class StateNotifierProviderElement, T> @override NotifierT get notifier => _notifierNotifier.value; - final _notifierNotifier = ProxyElementValueNotifier(); + final _notifierNotifier = ProxyElementValueListenable(); void Function()? _removeListener; @@ -195,20 +195,20 @@ class StateNotifierProviderElement, T> @override void visitChildren({ required void Function(ProviderElementBase element) elementVisitor, - required void Function(ProxyElementValueNotifier element) - notifierVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, - notifierVisitor: notifierVisitor, + listenableVisitor: listenableVisitor, ); - notifierVisitor(_notifierNotifier); + listenableVisitor(_notifierNotifier); } } /// The [Family] of [StateNotifierProvider]. class StateNotifierProviderFamily, T, Arg> - extends FamilyBase, T, Arg, + extends FunctionalFamily, T, Arg, NotifierT, StateNotifierProvider> { /// The [Family] of [StateNotifierProvider]. StateNotifierProviderFamily( diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart index 4f933acff..a22953825 100644 --- a/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart @@ -118,9 +118,9 @@ class StateProviderElement extends ProviderElementBase @override StateController get controller => _controllerNotifier.value; - final _controllerNotifier = ProxyElementValueNotifier>(); + final _controllerNotifier = ProxyElementValueListenable>(); - final _stateNotifier = ProxyElementValueNotifier>(); + final _stateNotifier = ProxyElementValueListenable>(); void Function()? _removeListener; @@ -159,21 +159,21 @@ class StateProviderElement extends ProviderElementBase @override void visitChildren({ required void Function(ProviderElementBase element) elementVisitor, - required void Function(ProxyElementValueNotifier element) - notifierVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, - notifierVisitor: notifierVisitor, + listenableVisitor: listenableVisitor, ); - notifierVisitor(_stateNotifier); - notifierVisitor(_controllerNotifier); + listenableVisitor(_stateNotifier); + listenableVisitor(_controllerNotifier); } } /// The [Family] of [StateProvider]. class StateProviderFamily - extends FamilyBase, R, Arg, R, StateProvider> { + extends FunctionalFamily, R, Arg, R, StateProvider> { /// The [Family] of [StateProvider]. StateProviderFamily( super._createFn, { diff --git a/packages/riverpod/lib/src/legacy_providers/future_provider.dart b/packages/riverpod/lib/src/legacy_providers/future_provider.dart index 0270408e9..c7187b1dd 100644 --- a/packages/riverpod/lib/src/legacy_providers/future_provider.dart +++ b/packages/riverpod/lib/src/legacy_providers/future_provider.dart @@ -9,22 +9,6 @@ import 'builders.dart'; import 'provider.dart' show Provider; import 'stream_provider.dart' show StreamProvider; -part 'future_provider/auto_dispose.dart'; -part 'future_provider/base.dart'; - -ProviderElementProxy, Future> _future( - _FutureProviderBase that, -) { - return ProviderElementProxy, Future>( - that, - (element) { - return FutureHandlerProviderElementMixin.futureNotifierOf( - element as FutureHandlerProviderElementMixin, - ); - }, - ); -} - /// {@template riverpod.future_provider} /// A provider that asynchronously creates a value. /// @@ -93,16 +77,116 @@ ProviderElementProxy, Future> _future( /// - [FutureProvider.family], to create a [FutureProvider] from external parameters /// - [FutureProvider.autoDispose], to destroy the state of a [FutureProvider] when no longer needed. /// {@endtemplate} -abstract class _FutureProviderBase extends ProviderBase> - with AsyncSelector { - const _FutureProviderBase({ +final class FutureProvider extends FunctionalProvider< + AsyncValue, + FutureOr, + FutureProviderRef> with FutureModifier { + /// {@macro riverpod.future_provider} + FutureProvider( + this._create, { + super.name, + super.dependencies, + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, + // TODO add autoDispose parameter + isAutoDispose: false, + ); + + /// An implementation detail of Riverpod + @internal + FutureProvider.internal( + this._create, { + required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.name, + required super.debugGetCreateSourceHash, required super.from, required super.argument, - required super.debugGetCreateSourceHash, + required super.isAutoDispose, }); - FutureOr _create(covariant FutureProviderElement ref); + /// {@macro riverpod.autoDispose} + static const autoDispose = AutoDisposeFutureProviderBuilder(); + + /// {@macro riverpod.family} + static const family = FutureProviderFamilyBuilder(); + + /// TODO make all "create" public, for the sake of dartdocs. + final Create, FutureProviderRef> _create; + + @override + FutureProviderElement createElement(ProviderContainer container) { + return FutureProviderElement(this, container); + } + + @override + FutureProvider copyWithCreate( + Create, FutureProviderRef> create, + ) { + return FutureProvider.internal( + create, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + argument: argument, + isAutoDispose: isAutoDispose, + ); + } +} + +/// {@macro riverpod.provider_ref_base} +abstract class FutureProviderRef implements Ref> { + /// Obtains the [Future] associated to this provider. + /// + /// This is equivalent to doing `ref.read(myProvider.future)`. + /// See also [FutureProvider.future]. + // TODO move to Ref + Future get future; +} + +/// The element of a [FutureProvider] +class FutureProviderElement extends ProviderElementBase> + with FutureModifierElement + implements FutureProviderRef { + /// The element of a [FutureProvider] + @internal + FutureProviderElement(this.provider, super.container); + + @override + final FutureProvider provider; + + @override + Future get future { + flush(); + return futureNotifier.value; + } + + @override + void create({required bool didChangeDependency}) { + handleFuture( + () => provider._create(this), + didChangeDependency: didChangeDependency, + ); + } +} + +/// The [Family] of a [FutureProvider] +class FutureProviderFamily extends FunctionalFamily< + FutureProviderRef, AsyncValue, Arg, FutureOr, FutureProvider> { + /// Implementation detail of the code-generator. + @internal + FutureProviderFamily.internal( + super._createFn, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.isAutoDispose, + }) : super(providerFactory: FutureProvider.internal); } diff --git a/packages/riverpod/lib/src/legacy_providers/future_provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/future_provider/auto_dispose.dart deleted file mode 100644 index b71cb689f..000000000 --- a/packages/riverpod/lib/src/legacy_providers/future_provider/auto_dispose.dart +++ /dev/null @@ -1,137 +0,0 @@ -part of '../future_provider.dart'; - -/// {@macro riverpod.provider_ref_base} -/// - [FutureProviderRef.state], the value currently exposed by this provider. -abstract class AutoDisposeFutureProviderRef - extends FutureProviderRef - implements AutoDisposeRef> {} - -/// {@macro riverpod.future_provider} -class AutoDisposeFutureProvider extends _FutureProviderBase - with AsyncSelector { - /// {@macro riverpod.future_provider} - AutoDisposeFutureProvider( - this._createFn, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - AutoDisposeFutureProvider.internal( - this._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.family} - static const family = AutoDisposeFutureProviderFamily.new; - - final Create, AutoDisposeFutureProviderRef> _createFn; - - @override - FutureOr _create(AutoDisposeFutureProviderElement ref) => - _createFn(ref); - - @override - AutoDisposeFutureProviderElement createElement( - ProviderContainer container, - ) { - return AutoDisposeFutureProviderElement(this, container); - } - - @override - late final Refreshable> future = _future(this); - - /// {@macro riverpod.override_with} - Override overrideWith( - Create, AutoDisposeFutureProviderRef> create, - ) { - return ProviderOverride( - origin: this, - providerOverride: AutoDisposeFutureProvider.internal( - create, - from: from, - argument: argument, - debugGetCreateSourceHash: null, - dependencies: null, - allTransitiveDependencies: null, - name: null, - ), - ); - } -} - -/// The [ProviderElementBase] of [AutoDisposeFutureProvider] -class AutoDisposeFutureProviderElement extends FutureProviderElement - with AutoDisposeProviderElementMixin> - implements AutoDisposeFutureProviderRef { - /// The [ProviderElementBase] for [FutureProvider] - @internal - AutoDisposeFutureProviderElement( - AutoDisposeFutureProvider super.provider, - super.container, - ) : super(); -} - -/// The [Family] of an [AutoDisposeFutureProvider] -class AutoDisposeFutureProviderFamily extends AutoDisposeFamilyBase< - AutoDisposeFutureProviderRef, - AsyncValue, - Arg, - FutureOr, - AutoDisposeFutureProvider> { - /// The [Family] of an [AutoDisposeFutureProvider] - AutoDisposeFutureProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: AutoDisposeFutureProvider.internal, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, - ); - - /// Implementation detail of the code-generator. - @internal - AutoDisposeFutureProviderFamily.generator( - super._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - }) : super(providerFactory: AutoDisposeFutureProvider.internal); - - /// {@macro riverpod.override_with} - Override overrideWith( - FutureOr Function(AutoDisposeFutureProviderRef ref, Arg arg) create, - ) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as AutoDisposeFutureProvider; - - return AutoDisposeFutureProvider.internal( - (ref) => create(ref, provider.argument as Arg), - from: provider.from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} diff --git a/packages/riverpod/lib/src/legacy_providers/future_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/future_provider/base.dart deleted file mode 100644 index b89ed5193..000000000 --- a/packages/riverpod/lib/src/legacy_providers/future_provider/base.dart +++ /dev/null @@ -1,160 +0,0 @@ -part of '../future_provider.dart'; - -/// {@macro riverpod.provider_ref_base} -/// - [state], the value currently exposed by this provider. -abstract class FutureProviderRef implements Ref> { - /// Obtains the state currently exposed by this provider. - /// - /// Mutating this property will notify the provider listeners. - /// - /// Cannot be called while a provider is creating, unless the setter was called first. - /// - /// Will return [AsyncLoading] if used during the first initialization. - /// Subsequent initializations will contain an [AsyncValue] with the previous - /// state and [AsyncValueX.isRefreshing]/[AsyncValueX.isReloading] set accordingly. - AsyncValue get state; - set state(AsyncValue newState); - - /// Obtains the [Future] associated to this provider. - /// - /// This is equivalent to doing `ref.read(myProvider.future)`. - /// See also [FutureProvider.future]. - Future get future; -} - -/// {@macro riverpod.future_provider} -class FutureProvider extends _FutureProviderBase { - /// {@macro riverpod.future_provider} - FutureProvider( - this._createFn, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - FutureProvider.internal( - this._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeFutureProviderBuilder(); - - /// {@macro riverpod.family} - static const family = FutureProviderFamilyBuilder(); - - final Create, FutureProviderRef> _createFn; - - @override - late final Refreshable> future = _future(this); - - @override - FutureOr _create(FutureProviderElement ref) => _createFn(ref); - - @override - FutureProviderElement createElement(ProviderContainer container) { - return FutureProviderElement(this, container); - } - - /// {@macro riverpod.override_with} - Override overrideWith(Create, FutureProviderRef> create) { - return ProviderOverride( - origin: this, - providerOverride: FutureProvider.internal( - create, - from: from, - argument: argument, - debugGetCreateSourceHash: null, - dependencies: null, - allTransitiveDependencies: null, - name: null, - ), - ); - } -} - -/// The element of a [FutureProvider] -class FutureProviderElement extends ProviderElementBase> - with FutureHandlerProviderElementMixin - implements FutureProviderRef { - /// The element of a [FutureProvider] - @internal - FutureProviderElement(this.provider, super.container); - - @override - final _FutureProviderBase provider; - - @override - Future get future { - flush(); - return futureNotifier.value; - } - - @override - void create({required bool didChangeDependency}) { - handleFuture( - () => provider._create(this), - didChangeDependency: didChangeDependency, - ); - } -} - -/// The [Family] of a [FutureProvider] -class FutureProviderFamily extends FamilyBase, - AsyncValue, Arg, FutureOr, FutureProvider> { - /// The [Family] of a [FutureProvider] - FutureProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: FutureProvider.internal, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, - ); - - /// Implementation detail of the code-generator. - @internal - FutureProviderFamily.generator( - super._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - }) : super(providerFactory: FutureProvider.internal); - - /// {@macro riverpod.override_with} - Override overrideWith( - FutureOr Function(FutureProviderRef ref, Arg arg) create, - ) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as FutureProvider; - - return FutureProvider.internal( - (ref) => create(ref, provider.argument as Arg), - from: provider.from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} diff --git a/packages/riverpod/lib/src/legacy_providers/notifier.dart b/packages/riverpod/lib/src/legacy_providers/notifier.dart index 2d0e35c0b..d8150439a 100644 --- a/packages/riverpod/lib/src/legacy_providers/notifier.dart +++ b/packages/riverpod/lib/src/legacy_providers/notifier.dart @@ -12,28 +12,6 @@ part 'notifier/auto_dispose_family.dart'; part 'notifier/base.dart'; part 'notifier/family.dart'; -/// An error thrown if a Notifier is associated multiple times with a provider. -@internal -const alreadyInitializedError = ''' -A NotifierProvider returned a Notifier instance that is already associated -with another provider. - -To fix, do not reuse the same Notifier instance multiple times. -NotifierProviders are expected to always create a new Notifier instance. -'''; - -/// The error message for when a notifier is used when uninitialized. -@internal -const uninitializedElementError = ''' -Tried to use a notifier in an uninitialized state. -This means that you tried to either: -- Use ref/state inside the constructor of a notifier. - In this case you should move your logic inside the "build" method instead. -- Use ref/state after the notifier was disposed. - In this case, consider using `ref.onDispose` earlier in your notifier's lifecycle - to abort any pending logic that could try to use `ref/state`. -'''; - /// A base class for [NotifierBase]. /// /// Not meant for public consumption. @@ -125,6 +103,7 @@ abstract class NotifierBase { /// comparison of the previous and new values. @protected bool updateShouldNotify(State previous, State next) { + // TODO unify updateShouldNotify to use == or identical everywhere return !identical(previous, next); } } @@ -146,7 +125,7 @@ ProviderElementProxy /// /// Not meant for public consumption. @internal -abstract class NotifierProviderBase, T> +abstract base class NotifierProviderBase, T> extends ProviderBase { /// An internal base class for [Notifier]. /// @@ -159,6 +138,7 @@ abstract class NotifierProviderBase, T> required super.dependencies, required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, + required super.isAutoDispose, }); /// Obtains the [Notifier] associated with this provider, without listening diff --git a/packages/riverpod/lib/src/legacy_providers/notifier/base.dart b/packages/riverpod/lib/src/legacy_providers/notifier/base.dart index f5e79f39f..2108cc018 100644 --- a/packages/riverpod/lib/src/legacy_providers/notifier/base.dart +++ b/packages/riverpod/lib/src/legacy_providers/notifier/base.dart @@ -197,7 +197,7 @@ class NotifierProviderElement, T> @override final NotifierProviderBase provider; - final _notifierNotifier = ProxyElementValueNotifier(); + final _notifierNotifier = ProxyElementValueListenable(); @override void create({required bool didChangeDependency}) { @@ -216,14 +216,14 @@ class NotifierProviderElement, T> @override void visitChildren({ required void Function(ProviderElementBase element) elementVisitor, - required void Function(ProxyElementValueNotifier element) - notifierVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, - notifierVisitor: notifierVisitor, + listenableVisitor: listenableVisitor, ); - notifierVisitor(_notifierNotifier); + listenableVisitor(_notifierNotifier); } @override diff --git a/packages/riverpod/lib/src/legacy_providers/notifier/family.dart b/packages/riverpod/lib/src/legacy_providers/notifier/family.dart index b55b89af2..97d0ae20a 100644 --- a/packages/riverpod/lib/src/legacy_providers/notifier/family.dart +++ b/packages/riverpod/lib/src/legacy_providers/notifier/family.dart @@ -85,7 +85,7 @@ class FamilyNotifierProviderImpl, T, Arg> /// The [Family] of [NotifierProvider]. class NotifierProviderFamily, T, Arg> - extends NotifierFamilyBase, T, Arg, NotifierT, + extends ClassFamily, T, Arg, NotifierT, NotifierFamilyProvider> { /// The [Family] of [NotifierProvider]. NotifierProviderFamily( diff --git a/packages/riverpod/lib/src/legacy_providers/provider.dart b/packages/riverpod/lib/src/legacy_providers/provider.dart index 9213b7a32..3f1e9ea2a 100644 --- a/packages/riverpod/lib/src/legacy_providers/provider.dart +++ b/packages/riverpod/lib/src/legacy_providers/provider.dart @@ -5,27 +5,70 @@ import 'builders.dart'; import 'deprecated/state_notifier_provider.dart' show StateNotifierProvider; import 'stream_provider.dart' show StreamProvider; -part 'provider/auto_dispose.dart'; -part 'provider/base.dart'; +// TODO changelog ProviderRef was removed. Used Ref directly +/// {@macro riverpod.provider} +final class Provider + extends FunctionalProvider> { + /// {@macro riverpod.provider} + // TODO make all providers const under all variations + Provider( + this._create, { + super.name, + super.dependencies, + // TODO make "autoDispose" an optional arg on the constructor + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, + isAutoDispose: false, + ); -/// A base class for [Provider] -/// -/// Not meant for public consumption -@internal -abstract class InternalProvider extends ProviderBase { - /// A base class for [Provider] - /// - /// Not meant for public consumption - const InternalProvider({ + /// An implementation detail of Riverpod + @internal + const Provider.internal( + this._create, { required super.name, - required super.from, - required super.argument, - required super.debugGetCreateSourceHash, required super.dependencies, required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required super.argument, + required super.isAutoDispose, }); - State _create(covariant ProviderElement ref); + /// {@macro riverpod.family} + static const family = ProviderFamilyBuilder(); + + /// {@macro riverpod.autoDispose} + static const autoDispose = AutoDisposeProviderBuilder(); + + final Create> _create; + + @override + ProviderElement createElement( + ProviderContainer container, + ) { + return ProviderElement(this, container); + } + + @visibleForOverriding + @override + Provider copyWithCreate( + Create> create, + ) { + return Provider.internal( + create, + from: from, + argument: argument, + isAutoDispose: isAutoDispose, + allTransitiveDependencies: null, + dependencies: null, + debugGetCreateSourceHash: null, + name: null, + ); + } /// Overrides a provider with a value, ejecting the default behavior. /// @@ -56,10 +99,261 @@ abstract class InternalProvider extends ProviderBase { /// ), /// ); /// ``` - Override overrideWithValue(State value) { + Override overrideWithValue(StateT value) { return ProviderOverride( origin: this, - providerOverride: ValueProvider(value), + providerOverride: ValueProvider(value), ); } } + +/// {@template riverpod.provider} +/// A provider that exposes a read-only value. +/// +/// ## What is a provider +/// +/// Providers are the most important components of `Riverpod`. In short, you can think +/// of providers as an access point to a **shared state**. +/// +/// Providers solve the following problems: +/// +/// - Providers have the flexibility of global variables, without their downsides.\ +/// Providers can be accessed from anywhere, while ensuring testability and scalability. +/// +/// - Providers are safe to use.\ +/// As opposed to most service-locator solutions, using a provider, it is not +/// possible to read a value in an uninitialized state.\ +/// If we can write the code to read a state, the code will execute properly. +/// Even if the state is loaded asynchronously. +/// +/// - Providers allow easily and efficiently listening to a piece of state.\ +/// They can be accessed in a single line of code, and offer many ways to optimize +/// your application. +/// +/// ## Creating a provider +/// +/// Providers come in many variants, but they all work the same way. +/// +/// The most common usage is to declare them as global variables like so: +/// +/// ```dart +/// final myProvider = Provider((ref) { +/// return MyValue(); +/// }); +/// ``` +/// +/// **NOTE** +/// Do not feel threatened by the fact that a provider is declared as a global. +/// While providers are globals, the variable is fully immutable. +/// This makes creating a provider no different from declaring a function or a class. +/// +/// This snippet consist of three components: +/// +/// - `final myProvider`, the declaration of a variable.\ +/// This variable is what we will use in the future to read the state of our provider. +/// It should always be immutable. +/// +/// - `Provider`, the provider that we decided to use.\ +/// [Provider] is the most basic of all providers. It exposes an object that never +/// changes.\ +/// We could replace [Provider] with other providers like [StreamProvider] or +/// [StateNotifierProvider], to change how the value is interacted with. +/// +/// - A function that creates the shared state.\ +/// That function will always receive an object called `ref` as a parameter. This object +/// allows us to read other providers or to perform some operations when the state +/// of our provider will be destroyed. +/// +/// The type of the object created by the function passed to a provider depends on +/// the provider used.\ +/// For example, the function of a [Provider] can create any object. +/// On the other hand, [StreamProvider]'s callback will be expected to return a [Stream]. +/// +/// **NOTE**: +/// You can declare as many providers as you want, without limitations.\ +/// As opposed to when using `package:provider`, in `Riverpod` we can have two +/// providers expose a state of the same "type": +/// +/// ```dart +/// final cityProvider = Provider((ref) => 'London'); +/// final countryProvider = Provider((ref) => 'England'); +/// ``` +/// +/// The fact that both providers create a `String` does not cause conflicts. +/// We will be able to read both values independently from each other without issue. +/// +/// **WARNING** +/// For providers to work, you need to add `ProviderScope` at the root of your +/// Flutter applications: +/// +/// ```dart +/// void main() { +/// runApp(ProviderScope(child: MyApp())); +/// } +/// ``` +/// +/// ## Combining providers +/// +/// We've previously seen how to create a simple provider. But the reality is, +/// in many situations a provider will want to read the state of another provider. +/// +/// To do that, we can use the `ref` object passed to the callback of our provider, +/// and use its `watch` method. +/// +/// As an example, consider the following provider: +/// +/// ```dart +/// final cityProvider = Provider((ref) => 'London'); +/// ``` +/// +/// We can now create another provider that will consume our `cityProvider`: +/// +/// ```dart +/// final weatherProvider = FutureProvider((ref) async { +/// // We use `ref.watch` to watch another provider, and we pass it the provider +/// // that we want to consume. Here: cityProvider +/// final city = ref.watch(cityProvider); +/// +/// // We can then use the result to do something based on the value of `cityProvider`. +/// return fetchWeather(city: city); +/// }); +/// ``` +/// +/// That's it. We've created a provider that depends on another provider. +/// +/// One interesting aspect of this code is, if `city` ever changes, +/// this will automatically call `fetchWeather` again and update the UI accordingly. +/// +/// ### Creating an object that depends on a lot of providers. +/// +/// Sometimes, we may want to create an object that depends on a lot of providers +/// like so: +/// +/// ```dart +/// final cityProvider = Provider((ref) => 'London'); +/// final countryProvider = Provider((ref) => 'England'); +/// +/// final weatherProvider = Provider((ref) { +/// final city = ref.watch(cityProvider); +/// final country = ref.watch(countryProvider); +/// +/// return Location(city: city, country: country); +/// }); +/// +/// class Location { +/// Location({required this.city, required this.country}); +/// +/// final String city; +/// final String country; +/// +/// String get label => '$city ($country)'; +/// } +/// ``` +/// +/// This can quickly become tedious. +/// +/// In that situation, it may be reasonable to pass the `ref` variable to our +/// object directly: +/// +/// ```dart +/// final cityProvider = Provider((ref) => 'London'); +/// final countryProvider = Provider((ref) => 'England'); +/// +/// final weatherProvider = Provider((ref) { +/// // Pass the `ref` object to our `Location` class. +/// // `Location` will then be able to call `ref.read` to read the providers. +/// return Location(ref); +/// }); +/// +/// class Location { +/// Location(this._ref); +/// +/// final Ref _ref; +/// +/// String get label { +/// final city = _ref.read(cityProvider); +/// final country = _ref.read(countryProvider); +/// return '$city ($country)'; +/// } +/// } +/// ``` +/// +/// This avoids having to implement a constructor, which makes changes on the object +/// easier. +/// +/// This is fine as, as opposed to `BuildContext` from Flutter, that `ref` object +/// is completely independent from Flutter/the UI.\ +/// As such the object can still be shared and tested. +/// +/// ## Disposing the resources the state is destroyed +/// +/// During the lifetime of an application, the state associated with a provider may +/// get destroyed.\ +/// In this situation, we may want to perform a clean-up before the state destruction. +/// +/// This is done by using the `ref` object that is passed to the callback of all providers. +/// +/// That `ref` object exposes an `onDispose` method, which can be used to listen to +/// the state destruction even to perform some task. +/// +/// The following example uses `ref.onDispose` to close a `StreamController`: +/// +/// ```dart +/// final example = StreamProvider.autoDispose((ref) { +/// final streamController = StreamController(); +/// +/// ref.onDispose(() { +/// // Closes the StreamController when the state of this provider is destroyed. +/// streamController.close(); +/// }); +/// +/// return streamController.stream; +/// }); +/// ``` +/// +/// See also: +/// +/// - [Provider.autoDispose], to automatically destroy the state of a provider +/// when that provider is no longer listened to. +/// - [Provider.family], to allow providers to create a value from external parameters. +/// {@endtemplate} +class ProviderElement extends ProviderElementBase { + /// A [ProviderElementBase] for [Provider] + @internal + ProviderElement(this.provider, super.container); + + @override + final Provider provider; + + @override + State get state => requireState; + + @override + set state(State newState) => setState(newState); + + @override + void create({required bool didChangeDependency}) { + setState(provider._create(this)); + } + + @override + bool updateShouldNotify(State previous, State next) { + return previous != next; + } +} + +/// The [Family] of [Provider] +// TODO remove custom family types +class ProviderFamily + extends FunctionalFamily, R, Arg, R, Provider> { + /// An implementation detail of Riverpod + @internal + ProviderFamily.internal( + super._createFn, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.isAutoDispose, + }) : super(providerFactory: Provider.internal); +} diff --git a/packages/riverpod/lib/src/legacy_providers/provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/provider/auto_dispose.dart deleted file mode 100644 index 87610cac0..000000000 --- a/packages/riverpod/lib/src/legacy_providers/provider/auto_dispose.dart +++ /dev/null @@ -1,116 +0,0 @@ -part of '../provider.dart'; - -/// {@macro riverpod.provider_ref_base} -abstract class AutoDisposeProviderRef extends ProviderRef - implements AutoDisposeRef {} - -/// {@macro riverpod.provider} -class AutoDisposeProvider extends InternalProvider { - /// {@macro riverpod.provider} - AutoDisposeProvider( - this._createFn, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - const AutoDisposeProvider.internal( - this._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.family} - static const family = AutoDisposeProviderFamily.new; - - final T Function(AutoDisposeProviderRef ref) _createFn; - - @override - T _create(AutoDisposeProviderElement ref) => _createFn(ref); - - @override - AutoDisposeProviderElement createElement( - ProviderContainer container, - ) { - return AutoDisposeProviderElement(this, container); - } - - /// {@macro riverpod.override_with} - Override overrideWith( - Create> create, - ) { - return ProviderOverride( - origin: this, - providerOverride: AutoDisposeProvider.internal( - create, - from: from, - argument: argument, - allTransitiveDependencies: null, - dependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), - ); - } -} - -/// The element of [AutoDisposeProvider] -class AutoDisposeProviderElement extends ProviderElement - with AutoDisposeProviderElementMixin - implements AutoDisposeProviderRef { - /// The [ProviderElementBase] for [Provider] - @internal - AutoDisposeProviderElement( - AutoDisposeProvider super.provider, - super.container, - ); -} - -/// The [Family] of [AutoDisposeProvider] -class AutoDisposeProviderFamily extends AutoDisposeFamilyBase< - AutoDisposeProviderRef, R, Arg, R, AutoDisposeProvider> { - /// The [Family] of [AutoDisposeProvider] - AutoDisposeProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: AutoDisposeProvider.internal, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, - ); - - /// {@macro riverpod.override_with} - Override overrideWith( - R Function(AutoDisposeProviderRef ref, Arg arg) create, - ) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as AutoDisposeProvider; - - return AutoDisposeProvider.internal( - (ref) => create(ref, provider.argument as Arg), - from: provider.from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} diff --git a/packages/riverpod/lib/src/legacy_providers/provider/base.dart b/packages/riverpod/lib/src/legacy_providers/provider/base.dart deleted file mode 100644 index 1b49dbd06..000000000 --- a/packages/riverpod/lib/src/legacy_providers/provider/base.dart +++ /dev/null @@ -1,397 +0,0 @@ -part of '../provider.dart'; - -/// {@macro riverpod.provider_ref_base} -/// - [state], the value currently exposed by this provider. -abstract class ProviderRef implements Ref { - /// Obtains the state currently exposed by this provider. - /// - /// Mutating this property will notify the provider listeners. - /// - /// Cannot be called while a provider is creating, unless the setter was called first. - /// - /// Will throw if the provider threw during creation. - State get state; - set state(State newState); -} - -/// {@macro riverpod.provider} -@sealed -class Provider extends InternalProvider { - /// {@macro riverpod.provider} - Provider( - this._createFn, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - const Provider.internal( - this._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.family} - static const family = ProviderFamilyBuilder(); - - /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeProviderBuilder(); - - final Create> _createFn; - - @override - State _create(ProviderElement ref) => _createFn(ref); - - @override - ProviderElement createElement( - ProviderContainer container, - ) { - return ProviderElement(this, container); - } - - /// {@template riverpod.override_with} - /// Override the provider with a new initialization function. - /// - /// This will also disable the auto-scoping mechanism, meaning that if the - /// overridden provider specified `dependencies`, it will have no effect. - /// - /// The override must not specify a `dependencies`. - /// - /// Some common use-cases are: - /// - testing, by replacing a service with a fake implementation, or to reach - /// a very specific state easily. - /// - multiple environments, by changing the implementation of a class - /// based on the platform or other parameters. - /// - /// This function should be used in combination with `ProviderScope.overrides` - /// or `ProviderContainer.overrides`: - /// - /// ```dart - /// final myService = Provider((ref) => MyService()); - /// - /// runApp( - /// ProviderScope( - /// overrides: [ - /// // Replace the implementation of the provider with a different one - /// myService.overrideWith((ref) { - /// ref.watch('other'); - /// return MyFakeService(), - /// })), - /// ], - /// child: MyApp(), - /// ), - /// ); - /// ``` - /// {@endtemplate} - Override overrideWith( - Create> create, - ) { - return ProviderOverride( - origin: this, - providerOverride: Provider.internal( - create, - from: from, - argument: argument, - allTransitiveDependencies: null, - dependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), - ); - } -} - -/// {@template riverpod.provider} -/// A provider that exposes a read-only value. -/// -/// ## What is a provider -/// -/// Providers are the most important components of `Riverpod`. In short, you can think -/// of providers as an access point to a **shared state**. -/// -/// Providers solve the following problems: -/// -/// - Providers have the flexibility of global variables, without their downsides.\ -/// Providers can be accessed from anywhere, while ensuring testability and scalability. -/// -/// - Providers are safe to use.\ -/// As opposed to most service-locator solutions, using a provider, it is not -/// possible to read a value in an uninitialized state.\ -/// If we can write the code to read a state, the code will execute properly. -/// Even if the state is loaded asynchronously. -/// -/// - Providers allow easily and efficiently listening to a piece of state.\ -/// They can be accessed in a single line of code, and offer many ways to optimize -/// your application. -/// -/// ## Creating a provider -/// -/// Providers come in many variants, but they all work the same way. -/// -/// The most common usage is to declare them as global variables like so: -/// -/// ```dart -/// final myProvider = Provider((ref) { -/// return MyValue(); -/// }); -/// ``` -/// -/// **NOTE** -/// Do not feel threatened by the fact that a provider is declared as a global. -/// While providers are globals, the variable is fully immutable. -/// This makes creating a provider no different from declaring a function or a class. -/// -/// This snippet consist of three components: -/// -/// - `final myProvider`, the declaration of a variable.\ -/// This variable is what we will use in the future to read the state of our provider. -/// It should always be immutable. -/// -/// - `Provider`, the provider that we decided to use.\ -/// [Provider] is the most basic of all providers. It exposes an object that never -/// changes.\ -/// We could replace [Provider] with other providers like [StreamProvider] or -/// [StateNotifierProvider], to change how the value is interacted with. -/// -/// - A function that creates the shared state.\ -/// That function will always receive an object called `ref` as a parameter. This object -/// allows us to read other providers or to perform some operations when the state -/// of our provider will be destroyed. -/// -/// The type of the object created by the function passed to a provider depends on -/// the provider used.\ -/// For example, the function of a [Provider] can create any object. -/// On the other hand, [StreamProvider]'s callback will be expected to return a [Stream]. -/// -/// **NOTE**: -/// You can declare as many providers as you want, without limitations.\ -/// As opposed to when using `package:provider`, in `Riverpod` we can have two -/// providers expose a state of the same "type": -/// -/// ```dart -/// final cityProvider = Provider((ref) => 'London'); -/// final countryProvider = Provider((ref) => 'England'); -/// ``` -/// -/// The fact that both providers create a `String` does not cause conflicts. -/// We will be able to read both values independently from each other without issue. -/// -/// **WARNING** -/// For providers to work, you need to add `ProviderScope` at the root of your -/// Flutter applications: -/// -/// ```dart -/// void main() { -/// runApp(ProviderScope(child: MyApp())); -/// } -/// ``` -/// -/// ## Combining providers -/// -/// We've previously seen how to create a simple provider. But the reality is, -/// in many situations a provider will want to read the state of another provider. -/// -/// To do that, we can use the `ref` object passed to the callback of our provider, -/// and use its `watch` method. -/// -/// As an example, consider the following provider: -/// -/// ```dart -/// final cityProvider = Provider((ref) => 'London'); -/// ``` -/// -/// We can now create another provider that will consume our `cityProvider`: -/// -/// ```dart -/// final weatherProvider = FutureProvider((ref) async { -/// // We use `ref.watch` to watch another provider, and we pass it the provider -/// // that we want to consume. Here: cityProvider -/// final city = ref.watch(cityProvider); -/// -/// // We can then use the result to do something based on the value of `cityProvider`. -/// return fetchWeather(city: city); -/// }); -/// ``` -/// -/// That's it. We've created a provider that depends on another provider. -/// -/// One interesting aspect of this code is, if `city` ever changes, -/// this will automatically call `fetchWeather` again and update the UI accordingly. -/// -/// ### Creating an object that depends on a lot of providers. -/// -/// Sometimes, we may want to create an object that depends on a lot of providers -/// like so: -/// -/// ```dart -/// final cityProvider = Provider((ref) => 'London'); -/// final countryProvider = Provider((ref) => 'England'); -/// -/// final weatherProvider = Provider((ref) { -/// final city = ref.watch(cityProvider); -/// final country = ref.watch(countryProvider); -/// -/// return Location(city: city, country: country); -/// }); -/// -/// class Location { -/// Location({required this.city, required this.country}); -/// -/// final String city; -/// final String country; -/// -/// String get label => '$city ($country)'; -/// } -/// ``` -/// -/// This can quickly become tedious. -/// -/// In that situation, it may be reasonable to pass the `ref` variable to our -/// object directly: -/// -/// ```dart -/// final cityProvider = Provider((ref) => 'London'); -/// final countryProvider = Provider((ref) => 'England'); -/// -/// final weatherProvider = Provider((ref) { -/// // Pass the `ref` object to our `Location` class. -/// // `Location` will then be able to call `ref.read` to read the providers. -/// return Location(ref); -/// }); -/// -/// class Location { -/// Location(this._ref); -/// -/// final Ref _ref; -/// -/// String get label { -/// final city = _ref.read(cityProvider); -/// final country = _ref.read(countryProvider); -/// return '$city ($country)'; -/// } -/// } -/// ``` -/// -/// This avoids having to implement a constructor, which makes changes on the object -/// easier. -/// -/// This is fine as, as opposed to `BuildContext` from Flutter, that `ref` object -/// is completely independent from Flutter/the UI.\ -/// As such the object can still be shared and tested. -/// -/// ## Disposing the resources the state is destroyed -/// -/// During the lifetime of an application, the state associated with a provider may -/// get destroyed.\ -/// In this situation, we may want to perform a clean-up before the state destruction. -/// -/// This is done by using the `ref` object that is passed to the callback of all providers. -/// -/// That `ref` object exposes an `onDispose` method, which can be used to listen to -/// the state destruction even to perform some task. -/// -/// The following example uses `ref.onDispose` to close a `StreamController`: -/// -/// ```dart -/// final example = StreamProvider.autoDispose((ref) { -/// final streamController = StreamController(); -/// -/// ref.onDispose(() { -/// // Closes the StreamController when the state of this provider is destroyed. -/// streamController.close(); -/// }); -/// -/// return streamController.stream; -/// }); -/// ``` -/// -/// See also: -/// -/// - [Provider.autoDispose], to automatically destroy the state of a provider -/// when that provider is no longer listened to. -/// - [Provider.family], to allow providers to create a value from external parameters. -/// {@endtemplate} -class ProviderElement extends ProviderElementBase - implements ProviderRef { - /// A [ProviderElementBase] for [Provider] - @internal - ProviderElement(this.provider, super.container); - - @override - final InternalProvider provider; - - @override - State get state => requireState; - - @override - set state(State newState) => setState(newState); - - @override - void create({required bool didChangeDependency}) { - setState(provider._create(this)); - } - - @override - bool updateShouldNotify(State previous, State next) { - return previous != next; - } -} - -/// The [Family] of [Provider] -class ProviderFamily - extends FamilyBase, R, Arg, R, Provider> { - /// The [Family] of [ProviderFamily] - ProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: Provider.internal, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - ProviderFamily.internal( - super._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - }) : super(providerFactory: Provider.internal); - - /// {@macro riverpod.override_with} - Override overrideWith( - R Function(ProviderRef ref, Arg arg) create, - ) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as Provider; - - return Provider.internal( - (ref) => create(ref, provider.argument as Arg), - from: provider.from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} diff --git a/packages/riverpod/lib/src/legacy_providers/stream_notifier.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier.dart index 870fb1bec..e78dfa656 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_notifier.dart @@ -1,42 +1,16 @@ part of 'async_notifier.dart'; -ProviderElementProxy, NotifierT> - _streamNotifier, T>( - StreamNotifierProviderBase that, -) { - return ProviderElementProxy, NotifierT>( - that, - (element) { - return (element as StreamNotifierProviderElement) - ._notifierNotifier; - }, - ); -} - -ProviderElementProxy, Future> _streamFuture( - StreamNotifierProviderBase, T> that, -) { - return ProviderElementProxy, Future>( - that, - (element) { - return (element as StreamNotifierProviderElement, T>) - .futureNotifier; - }, - ); -} - -/// A base class for [StreamNotifierProvider] -/// -/// Not meant for public consumption -@visibleForTesting -@internal -abstract class StreamNotifierProviderBase< - NotifierT extends AsyncNotifierBase, - T> extends ProviderBase> with AsyncSelector { - /// A base class for [StreamNotifierProvider] - /// - /// Not meant for public consumption - const StreamNotifierProviderBase( +abstract base class _StreamNotifierProviderBase< + NotifierT extends _AsyncNotifierBase, // + StateT> // + extends ClassProvider< // + NotifierT, + AsyncValue, + Stream, + Ref>> // + with + FutureModifier { + const _StreamNotifierProviderBase( this._createNotifier, { required super.name, required super.from, @@ -44,38 +18,70 @@ abstract class StreamNotifierProviderBase< required super.dependencies, required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, + required super.isAutoDispose, }); - /// Obtains the [StreamNotifier] associated with this provider, without listening - /// to state changes. - /// - /// This is typically used to invoke methods on a [StreamNotifier]. For example: - /// - /// ```dart - /// Button( - /// onTap: () => ref.read(streamNotifierProvider.notifier).increment(), - /// ) - /// ``` - /// - /// This listenable will notify its notifiers if the [StreamNotifier] instance - /// changes. - /// This may happen if the provider is refreshed or one of its dependencies - /// has changes. - Refreshable get notifier; + final NotifierT Function() _createNotifier; +} + +/// {@template riverpod.streamNotifier} +/// A variant of [AsyncNotifier] which has [build] creating a [Stream]. +/// +/// This can be considered as a [StreamProvider] that can mutate its value over time. +/// +/// The syntax for using this provider is slightly different from the others +/// in that the provider's function doesn't receive a "ref" (and in case +/// of `family`, doesn't receive an argument either). +/// Instead the ref (and argument) are directly accessible in the associated +/// [AsyncNotifier]. +/// +/// This can be considered as a [StreamProvider] that can mutate its value over time. +/// When using `family`, your notifier type changes. Instead of extending +/// [StreamNotifier], you should extend [FamilyStreamNotifier]. +/// {@endtemplate} +abstract class StreamNotifier extends _AsyncNotifierBase { + @override + Ref> get ref { + final element = _element; + if (element == null) throw StateError(uninitializedElementError); + + return element; + } + + /// {@macro riverpod.async_notifier.build} + @visibleForOverriding + Stream build(); +} + +// TODO hide all Elements and CreateElements from public API +class _StreamNotifierProviderElement< // + NotifierT extends _AsyncNotifierBase, + StateT> // + extends ProviderElementBase> + with + ClassProviderElement>, + FutureModifierElement { + _StreamNotifierProviderElement(this.provider, super.container); - /// {@macro riverpod.async_notifier.future} - /// - /// Listening to this using [Ref.watch] will rebuild the widget/provider - /// when the [StreamNotifier] emits a new value. - /// This will then return a new [Future] that resoles with the latest "state". @override - Refreshable> get future; + final _StreamNotifierProviderBase provider; - final NotifierT Function() _createNotifier; + @override + void create({required bool didChangeDependency}) { + final notifierResult = classListenable.result ??= Result.guard(() { + return provider._createNotifier().._setElement(this); + }); - /// Runs the `build` method of a notifier. - /// - /// This is an implementation detail for differentiating [StreamNotifier.build] - /// from [FamilyStreamNotifier.build]. - Stream runNotifierBuild(AsyncNotifierBase notifier); + notifierResult.when( + error: (error, stackTrace) { + onError(AsyncError(error, stackTrace), seamless: !didChangeDependency); + }, + data: (notifier) { + handleStream( + () => provider.runNotifierBuild(this, notifier), + didChangeDependency: didChangeDependency, + ); + }, + ); + } } diff --git a/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose.dart deleted file mode 100644 index c3b6b53f5..000000000 --- a/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose.dart +++ /dev/null @@ -1,134 +0,0 @@ -part of '../async_notifier.dart'; - -/// A [AutoDisposeStreamNotifier] base class shared between family and non-family notifiers. -/// -/// Not meant for public consumption outside of riverpod_generator -@internal -abstract class BuildlessAutoDisposeStreamNotifier - extends AsyncNotifierBase { - @override - AutoDisposeStreamNotifierProviderElement, State>? - _element; - - @override - void _setElement(ProviderElementBase>? element) { - if (_element != null && element != null) { - throw StateError(alreadyInitializedError); - } - _element = element as AutoDisposeStreamNotifierProviderElement< - AsyncNotifierBase, State>?; - } - - @override - AutoDisposeStreamNotifierProviderRef get ref { - final element = _element; - if (element == null) throw StateError(uninitializedElementError); - - return element; - } -} - -/// {@macro riverpod.streamNotifier} -abstract class AutoDisposeStreamNotifier - extends BuildlessAutoDisposeStreamNotifier { - /// {@macro riverpod.StreamNotifier.build} - @visibleForOverriding - Stream build(); -} - -/// {@macro riverpod.provider_ref_base} -abstract class AutoDisposeStreamNotifierProviderRef - implements StreamNotifierProviderRef, AutoDisposeRef> {} - -/// {@macro riverpod.StreamNotifier} -typedef AutoDisposeStreamNotifierProvider< - NotifierT extends AutoDisposeStreamNotifier, T> - = AutoDisposeStreamNotifierProviderImpl; - -/// The implementation of [AutoDisposeStreamNotifierProvider] but with loosened type constraints -/// that can be shared with [StreamNotifierProvider]. -/// -/// This enables tests to execute on both [AutoDisposeStreamNotifierProvider] and -/// [StreamNotifierProvider] at the same time. -@internal -class AutoDisposeStreamNotifierProviderImpl< - NotifierT extends AsyncNotifierBase, - T> extends StreamNotifierProviderBase with AsyncSelector { - /// {@macro riverpod.streamNotifier} - AutoDisposeStreamNotifierProviderImpl( - super._createNotifier, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - AutoDisposeStreamNotifierProviderImpl.internal( - super._createNotifier, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.family} - static const family = AutoDisposeStreamNotifierProviderFamily.new; - - @override - late final Refreshable notifier = - _streamNotifier(this); - - @override - late final Refreshable> future = _streamFuture(this); - - @override - AutoDisposeStreamNotifierProviderElement createElement( - ProviderContainer container, - ) { - return AutoDisposeStreamNotifierProviderElement(this, container); - } - - @override - Stream runNotifierBuild(AsyncNotifierBase notifier) { - // Not using "covariant" as riverpod_generator subclasses this with a - // different notifier type - return (notifier as AutoDisposeStreamNotifier).build(); - } - - /// {@macro riverpod.override_with} - @mustBeOverridden - Override overrideWith(NotifierT Function() create) { - return ProviderOverride( - origin: this, - providerOverride: - AutoDisposeStreamNotifierProviderImpl.internal( - create, - from: from, - argument: argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), - ); - } -} - -/// The element of [AutoDisposeStreamNotifierProvider]. -class AutoDisposeStreamNotifierProviderElement< - NotifierT extends AsyncNotifierBase, - T> extends StreamNotifierProviderElement - with AutoDisposeProviderElementMixin> - implements AutoDisposeStreamNotifierProviderRef { - /// The [ProviderElementBase] for [StreamNotifierProvider] - @internal - AutoDisposeStreamNotifierProviderElement(super.provider, super.container); -} diff --git a/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose_family.dart deleted file mode 100644 index 3703a8f98..000000000 --- a/packages/riverpod/lib/src/legacy_providers/stream_notifier/auto_dispose_family.dart +++ /dev/null @@ -1,124 +0,0 @@ -part of '../async_notifier.dart'; - -/// {@macro riverpod.streamNotifier} -abstract class AutoDisposeFamilyStreamNotifier - extends BuildlessAutoDisposeStreamNotifier { - /// {@macro riverpod.notifier.family_arg} - late final Arg arg; - - @override - void _setElement(ProviderElementBase>? element) { - super._setElement(element); - if (element != null) { - arg = element.origin.argument as Arg; - } - } - - /// {@macro riverpod.StreamNotifier.build} - @visibleForOverriding - Stream build(Arg arg); -} - -/// {@macro riverpod.StreamNotifier} -typedef AutoDisposeFamilyStreamNotifierProvider< - NotifierT extends AutoDisposeFamilyStreamNotifier, T, Arg> - = AutoDisposeFamilyStreamNotifierProviderImpl; - -/// The implementation of [AutoDisposeStreamNotifierProvider] but with loosened type constraints -/// that can be shared with [StreamNotifierProvider]. -/// -/// This enables tests to execute on both [AutoDisposeStreamNotifierProvider] and -/// [StreamNotifierProvider] at the same time. -@internal -class AutoDisposeFamilyStreamNotifierProviderImpl< - NotifierT extends AsyncNotifierBase, T, Arg> - extends StreamNotifierProviderBase with AsyncSelector { - /// {@macro riverpod.streamNotifier} - AutoDisposeFamilyStreamNotifierProviderImpl( - super._createNotifier, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - AutoDisposeFamilyStreamNotifierProviderImpl.internal( - super._createNotifier, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - @override - late final Refreshable notifier = - _streamNotifier(this); - - @override - late final Refreshable> future = _streamFuture(this); - - @override - AutoDisposeStreamNotifierProviderElement createElement( - ProviderContainer container, - ) { - return AutoDisposeStreamNotifierProviderElement(this, container); - } - - @override - Stream runNotifierBuild( - covariant AutoDisposeFamilyStreamNotifier notifier, - ) { - return notifier.build(notifier.arg); - } -} - -/// The [Family] of [StreamNotifierProvider]. -class AutoDisposeStreamNotifierProviderFamily< - NotifierT extends AutoDisposeFamilyStreamNotifier, T, Arg> - extends AutoDisposeNotifierFamilyBase< - AutoDisposeStreamNotifierProviderRef, - AsyncValue, - Arg, - NotifierT, - AutoDisposeFamilyStreamNotifierProvider> { - /// The [Family] of [AutoDisposeStreamNotifierProvider]. - AutoDisposeStreamNotifierProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: AutoDisposeFamilyStreamNotifierProvider.internal, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, - ); - - /// {@macro riverpod.override_with} - Override overrideWith(NotifierT Function() create) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as AutoDisposeFamilyStreamNotifierProvider; - - return AutoDisposeFamilyStreamNotifierProvider.internal( - create, - from: provider.from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} diff --git a/packages/riverpod/lib/src/legacy_providers/stream_notifier/base.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/base.dart deleted file mode 100644 index 46fe7633e..000000000 --- a/packages/riverpod/lib/src/legacy_providers/stream_notifier/base.dart +++ /dev/null @@ -1,169 +0,0 @@ -part of '../async_notifier.dart'; - -/// A [StreamNotifier] base class shared between family and non-family notifiers. -/// -/// Not meant for public consumption outside of riverpod_generator -@internal -abstract class BuildlessStreamNotifier extends AsyncNotifierBase { - @override - StreamNotifierProviderElement, State>? _element; - - @override - void _setElement(ProviderElementBase>? element) { - if (_element != null && element != null) { - throw StateError(alreadyInitializedError); - } - _element = element - as StreamNotifierProviderElement, State>?; - } - - @override - StreamNotifierProviderRef get ref { - final element = _element; - if (element == null) throw StateError(uninitializedElementError); - - return element; - } -} - -/// {@template riverpod.streamNotifier} -/// A variant of [AsyncNotifier] which has [build] creating a [Stream]. -/// -/// This can be considered as a [StreamProvider] that can mutate its value over time. -/// -/// The syntax for using this provider is slightly different from the others -/// in that the provider's function doesn't receive a "ref" (and in case -/// of `family`, doesn't receive an argument either). -/// Instead the ref (and argument) are directly accessible in the associated -/// [AsyncNotifier]. -/// -/// This can be considered as a [StreamProvider] that can mutate its value over time. -/// When using `autoDispose` or `family`, your notifier type changes. -/// Instead of extending [StreamNotifier], you should extend either: -/// - [AutoDisposeStreamNotifier] for `autoDispose` -/// - [FamilyStreamNotifier] for `family` -/// - [AutoDisposeFamilyStreamNotifier] for `autoDispose.family` -/// -/// {@endtemplate} -abstract class StreamNotifier extends BuildlessStreamNotifier { - /// {@macro riverpod.async_notifier.build} - @visibleForOverriding - Stream build(); -} - -/// {@macro riverpod.provider_ref_base} -abstract class StreamNotifierProviderRef implements Ref> {} - -/// {@macro riverpod.streamNotifier} -typedef StreamNotifierProvider, T> - = StreamNotifierProviderImpl; - -/// The implementation of [StreamNotifierProvider] but with loosened type constraints -/// that can be shared with [AutoDisposeStreamNotifierProvider]. -/// -/// This enables tests to execute on both [StreamNotifierProvider] and -/// [AutoDisposeStreamNotifierProvider] at the same time. -@visibleForTesting -@internal -class StreamNotifierProviderImpl, T> - extends StreamNotifierProviderBase { - /// {@macro riverpod.streamNotifier} - StreamNotifierProviderImpl( - super._createNotifier, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - StreamNotifierProviderImpl.internal( - super._createNotifier, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeStreamNotifierProviderBuilder(); - - /// {@macro riverpod.family} - static const family = StreamNotifierProviderFamilyBuilder(); - - @override - late final Refreshable notifier = - _streamNotifier(this); - - @override - late final Refreshable> future = _streamFuture(this); - - @override - StreamNotifierProviderElement createElement( - ProviderContainer container, - ) { - return StreamNotifierProviderElement(this, container); - } - - @override - Stream runNotifierBuild(AsyncNotifierBase notifier) { - // Not using "covariant" as riverpod_generator subclasses this with a - // different notifier type - return (notifier as StreamNotifier).build(); - } - - /// {@macro riverpod.override_with} - @mustBeOverridden - Override overrideWith(NotifierT Function() create) { - return ProviderOverride( - origin: this, - providerOverride: StreamNotifierProviderImpl.internal( - create, - from: from, - argument: argument, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), - ); - } -} - -/// The element of [StreamNotifierProvider]. -class StreamNotifierProviderElement, T> - extends AsyncNotifierProviderElementBase - implements StreamNotifierProviderRef { - /// The element of [StreamNotifierProvider]. - @internal - StreamNotifierProviderElement(this.provider, super.container); - - @override - final StreamNotifierProviderBase provider; - - @override - void create({required bool didChangeDependency}) { - final notifierResult = _notifierNotifier.result ??= Result.guard(() { - return provider._createNotifier().._setElement(this); - }); - - notifierResult.when( - error: (error, stackTrace) { - onError(AsyncError(error, stackTrace), seamless: !didChangeDependency); - }, - data: (notifier) { - handleStream( - () => provider.runNotifierBuild(notifier), - didChangeDependency: didChangeDependency, - ); - }, - ); - } -} diff --git a/packages/riverpod/lib/src/legacy_providers/stream_notifier/family.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/family.dart index 6477a805d..ed921604e 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_notifier/family.dart @@ -2,7 +2,7 @@ part of '../async_notifier.dart'; /// {@macro riverpod.streamNotifier} abstract class FamilyStreamNotifier - extends BuildlessStreamNotifier { + extends _AsyncNotifierBase { /// {@template riverpod.notifier.family_arg} /// The argument that was passed to this family. /// @@ -16,115 +16,135 @@ abstract class FamilyStreamNotifier /// {@endtemplate} late final Arg arg; - @override - void _setElement(ProviderElementBase>? element) { - super._setElement(element); - if (element != null) { - arg = element.origin.argument as Arg; - } - } - /// {@macro riverpod.StreamNotifier.build} @visibleForOverriding Stream build(Arg arg); } -/// {@macro riverpod.streamNotifier} -typedef StreamNotifierFamilyProvider< - NotifierT extends FamilyStreamNotifier, T, Arg> - = FamilyStreamNotifierProviderImpl; - -/// An internal implementation of [StreamNotifierFamilyProvider] for testing purpose. -/// -/// Not meant for public consumption. -@visibleForTesting -@internal -class FamilyStreamNotifierProviderImpl, - T, Arg> extends StreamNotifierProviderBase { - /// {@macro riverpod.streamNotifier} - FamilyStreamNotifierProviderImpl( - super._createNotifier, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod +final class FamilyStreamNotifierProvider< + NotifierT extends FamilyStreamNotifier, + StateT, + ArgT> extends _StreamNotifierProviderBase { @internal - FamilyStreamNotifierProviderImpl.internal( + const FamilyStreamNotifierProvider.internal( super._createNotifier, { required super.name, + required super.from, + required super.argument, required super.dependencies, required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); + required super.isAutoDispose, + required RunNotifierBuild, + Ref>>? + runNotifierBuild, + }) : _runNotifierBuildOverride = runNotifierBuild; /// {@macro riverpod.autoDispose} static const autoDispose = AutoDisposeStreamNotifierProviderFamily.new; - @override - late final Refreshable notifier = - _streamNotifier(this); + final RunNotifierBuild, Ref>>? + _runNotifierBuildOverride; - @override - late final Refreshable> future = _streamFuture(this); + FamilyStreamNotifierProvider _copyWith({ + NotifierT Function()? create, + RunNotifierBuild, Ref>>? build, + }) { + return FamilyStreamNotifierProvider.internal( + create ?? _createNotifier, + name: name, + from: from, + argument: argument, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + isAutoDispose: isAutoDispose, + runNotifierBuild: build ?? _runNotifierBuildOverride, + ); + } @override - StreamNotifierProviderElement createElement( + _StreamNotifierProviderElement createElement( ProviderContainer container, ) { - return StreamNotifierProviderElement(this, container); + return _StreamNotifierProviderElement(this, container); + } + + @internal + @override + ClassProvider< // + NotifierT, + AsyncValue, + Stream, + Ref>> copyWithBuild( + RunNotifierBuild, Ref>> build, + ) { + return _copyWith(build: build); + } + + @internal + @override + ClassProvider< // + NotifierT, + AsyncValue, + Stream, + Ref>> copyWithCreate(NotifierT Function() create) { + return _copyWith(create: create); } + @internal @override - Stream runNotifierBuild( - covariant FamilyStreamNotifier notifier, + Stream runNotifierBuild( + Ref> ref, + NotifierT notifier, ) { - return notifier.build(notifier.arg); + return notifier.build(argument as ArgT); } } /// The [Family] of [StreamNotifierProvider]. -class StreamNotifierProviderFamily< - NotifierT extends FamilyStreamNotifier, T, Arg> - extends NotifierFamilyBase, AsyncValue, Arg, - NotifierT, StreamNotifierFamilyProvider> { - /// The [Family] of [StreamNotifierProvider]. - StreamNotifierProviderFamily( +class StreamNotifierProviderFamily< // + NotifierT extends FamilyStreamNotifier, + StateT, + Arg> // + extends ClassFamily< // + NotifierT, + AsyncValue, + Ref>, + Arg, + Stream, + _StreamNotifierProviderBase> { + @internal + StreamNotifierProviderFamily.internal( super._createFn, { - super.name, - super.dependencies, + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.isAutoDispose, }) : super( - providerFactory: StreamNotifierFamilyProvider.internal, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, + providerFactory: ( + create, { + required name, + required dependencies, + required allTransitiveDependencies, + required debugGetCreateSourceHash, + required isAutoDispose, + required from, + required argument, + }) { + return FamilyStreamNotifierProvider.internal( + create, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + isAutoDispose: isAutoDispose, + from: from, + argument: argument, + runNotifierBuild: null, + ); + }, ); - - /// {@macro riverpod.override_with} - Override overrideWith(NotifierT Function() create) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as StreamNotifierFamilyProvider; - - return StreamNotifierFamilyProvider.internal( - create, - from: from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } } diff --git a/packages/riverpod/lib/src/legacy_providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/orphan.dart new file mode 100644 index 000000000..b97b178ee --- /dev/null +++ b/packages/riverpod/lib/src/legacy_providers/stream_notifier/orphan.dart @@ -0,0 +1,101 @@ +part of '../async_notifier.dart'; + +/// {@macro riverpod.streamNotifier} +final class StreamNotifierProvider< + NotifierT extends StreamNotifier, // + StateT> // + extends _StreamNotifierProviderBase { + /// {@macro riverpod.streamNotifier} + StreamNotifierProvider( + super._createNotifier, { + super.name, + super.dependencies, + }) : _runNotifierBuildOverride = null, + super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, + isAutoDispose: false, + ); + + @internal + const StreamNotifierProvider.internal( + super._createNotifier, { + required super.name, + required super.from, + required super.argument, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.isAutoDispose, + RunNotifierBuild, Ref>>? + runNotifierBuildOverride, + }) : _runNotifierBuildOverride = runNotifierBuildOverride; + + /// {@macro riverpod.autoDispose} + static const autoDispose = AutoDisposeStreamNotifierProviderBuilder(); + + /// {@macro riverpod.family} + static const family = StreamNotifierProviderFamilyBuilder(); + + final RunNotifierBuild, Ref>>? + _runNotifierBuildOverride; + + StreamNotifierProvider _copyWith({ + NotifierT Function()? create, + RunNotifierBuild, Ref>>? build, + }) { + return StreamNotifierProvider.internal( + create ?? _createNotifier, + name: name, + from: from, + argument: argument, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + isAutoDispose: isAutoDispose, + runNotifierBuildOverride: build ?? _runNotifierBuildOverride, + ); + } + + @internal + @override + _StreamNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _StreamNotifierProviderElement(this, container); + } + + @internal + @override + Stream runNotifierBuild( + Ref> ref, + NotifierT notifier, + ) { + return notifier.build(); + } + + @internal + @override + ClassProvider< // + NotifierT, + AsyncValue, + Stream, + Ref>> copyWithBuild( + RunNotifierBuild, Ref>> build, + ) { + return _copyWith(build: build); + } + + @internal + @override + ClassProvider< // + NotifierT, + AsyncValue, + Stream, + Ref>> copyWithCreate(NotifierT Function() create) { + return _copyWith(create: create); + } +} diff --git a/packages/riverpod/lib/src/legacy_providers/stream_provider.dart b/packages/riverpod/lib/src/legacy_providers/stream_provider.dart index 62f16ded4..2772616c6 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_provider.dart +++ b/packages/riverpod/lib/src/legacy_providers/stream_provider.dart @@ -6,35 +6,206 @@ import '../common/listenable.dart'; import '../common/result.dart'; import '../core/async_value.dart'; import '../framework.dart'; -import 'async_notifier.dart'; import 'builders.dart'; import 'future_provider.dart' show FutureProvider; import 'provider.dart' show Provider; -part 'stream_provider/auto_dispose.dart'; -part 'stream_provider/base.dart'; - -ProviderElementProxy, Future> _future( - _StreamProviderBase that, -) { - return ProviderElementProxy, Future>( - that, - (element) => FutureHandlerProviderElementMixin.futureNotifierOf( - element as FutureHandlerProviderElementMixin, - ), - ); -} +/// {@template riverpod.stream_provider} +/// Creates a stream and exposes its latest event. +/// +/// [StreamProvider] is identical in behavior/usage to [FutureProvider], modulo +/// the fact that the value created is a [Stream] instead of a [Future]. +/// +/// It can be used to express a value asynchronously loaded that can change over +/// time, such as an editable `Message` coming from a web socket: +/// +/// ```dart +/// final messageProvider = StreamProvider.autoDispose((ref) async* { +/// // Open the connection +/// final channel = IOWebSocketChannel.connect('ws://echo.websocket.org'); +/// +/// // Close the connection when the stream is destroyed +/// ref.onDispose(() => channel.sink.close()); +/// +/// // Parse the value received and emit a Message instance +/// await for (final value in channel.stream) { +/// yield value.toString(); +/// } +/// }); +/// ``` +/// +/// Which the UI can then listen: +/// +/// ```dart +/// Widget build(BuildContext context, WidgetRef ref) { +/// AsyncValue message = ref.watch(messageProvider); +/// +/// return message.when( +/// loading: () => const CircularProgressIndicator(), +/// error: (err, stack) => Text('Error: $err'), +/// data: (message) { +/// return Text(message); +/// }, +/// ); +/// } +/// ``` +/// +/// **Note**: +/// When listening to web sockets, firebase, or anything that consumes resources, +/// it is important to use [StreamProvider.autoDispose] instead of simply [StreamProvider]. +/// +/// This ensures that the resources are released when no longer needed as, +/// by default, a [StreamProvider] is almost never destroyed. +/// +/// See also: +/// +/// - [Provider], a provider that synchronously creates a value +/// - [FutureProvider], a provider that asynchronously exposes a value that +/// can change over time. +/// - [future], to obtain the last value emitted by a [Stream]. +/// - [StreamProvider.family], to create a [StreamProvider] from external parameters +/// - [StreamProvider.autoDispose], to destroy the state of a [StreamProvider] when no longer needed. +/// {@endtemplate} +final class StreamProvider + extends FunctionalProvider, Stream, Ref>> + with FutureModifier { + /// {@macro riverpod.stream_provider} + StreamProvider( + this._create, { + super.name, + super.dependencies, + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, + // TODO add autoDispose param + isAutoDispose: false, + ); -abstract class _StreamProviderBase extends ProviderBase> - with AsyncSelector { - const _StreamProviderBase({ - required super.allTransitiveDependencies, - required super.dependencies, + /// An implementation detail of Riverpod + @internal + StreamProvider.internal( + this._create, { required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, required super.from, required super.argument, - required super.debugGetCreateSourceHash, + required super.isAutoDispose, }); - Stream _create(covariant StreamProviderElement ref); + /// {@macro riverpod.autoDispose} + static const autoDispose = AutoDisposeStreamProviderBuilder(); + + /// {@macro riverpod.family} + static const family = StreamProviderFamilyBuilder(); + + final Create, Ref>> _create; + + @override + StreamProviderElement createElement( + ProviderContainer container, + ) { + return StreamProviderElement(this, container); + } + + @override + FunctionalProvider, Stream, Ref>> + copyWithCreate( + Create, Ref>> create, + ) { + return StreamProvider.internal( + create, + name: name, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + from: from, + argument: argument, + isAutoDispose: isAutoDispose, + ); + } +} + +/// The element of [StreamProvider]. +class StreamProviderElement extends ProviderElementBase> + with FutureModifierElement { + /// The element of [StreamProvider]. + @internal + StreamProviderElement(this.provider, super.container); + + @override + final StreamProvider provider; + + final _streamNotifier = ProxyElementValueListenable>(); + final StreamController _streamController = StreamController.broadcast(); + + @override + void create({required bool didChangeDependency}) { + asyncTransition(AsyncLoading(), seamless: !didChangeDependency); + _streamNotifier.result ??= Result.data(_streamController.stream); + + handleStream( + () => provider._create(this), + didChangeDependency: didChangeDependency, + ); + } + + @override + void dispose() { + super.dispose(); + + /// The controller isn't recreated on provider rebuild. So we only close it + /// when the element is destroyed, not on "ref.onDispose". + _streamController.close(); + } + + @override + void visitChildren({ + required void Function(ProviderElementBase element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); + listenableVisitor(_streamNotifier); + } + + @override + void onData(AsyncData value, {bool seamless = false}) { + if (!_streamController.isClosed) { + // The controller might be closed if onData is executed post dispose. Cf onData + _streamController.add(value.value); + } + super.onData(value, seamless: seamless); + } + + @override + void onError(AsyncError value, {bool seamless = false}) { + if (!_streamController.isClosed) { + // The controller might be closed if onError is executed post dispose. Cf onError + _streamController.addError(value.error, value.stackTrace); + } + super.onError(value, seamless: seamless); + } +} + +/// The [Family] of a [StreamProvider] +class StreamProviderFamily extends FunctionalFamily>, + AsyncValue, Arg, Stream, StreamProvider> { + /// Implementation detail of the code-generator. + @internal + StreamProviderFamily.internal( + super._createFn, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.isAutoDispose, + }) : super(providerFactory: StreamProvider.internal); } diff --git a/packages/riverpod/lib/src/legacy_providers/stream_provider/auto_dispose.dart b/packages/riverpod/lib/src/legacy_providers/stream_provider/auto_dispose.dart deleted file mode 100644 index aebff2a35..000000000 --- a/packages/riverpod/lib/src/legacy_providers/stream_provider/auto_dispose.dart +++ /dev/null @@ -1,124 +0,0 @@ -part of '../stream_provider.dart'; - -/// {@macro riverpod.provider_ref_base} -abstract class AutoDisposeStreamProviderRef - extends StreamProviderRef - implements AutoDisposeRef> {} - -/// {@macro riverpod.stream_provider} -class AutoDisposeStreamProvider extends _StreamProviderBase - with AsyncSelector { - /// {@macro riverpod.stream_provider} - AutoDisposeStreamProvider( - this._createFn, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - AutoDisposeStreamProvider.internal( - this._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.family} - static const family = AutoDisposeStreamProviderFamily.new; - - final Stream Function(AutoDisposeStreamProviderRef ref) _createFn; - - @override - Stream _create(AutoDisposeStreamProviderElement ref) => _createFn(ref); - - @override - AutoDisposeStreamProviderElement createElement( - ProviderContainer container, - ) { - return AutoDisposeStreamProviderElement(this, container); - } - - @override - late final Refreshable> future = _future(this); - - /// {@macro riverpod.override_with} - Override overrideWith( - Create, AutoDisposeStreamProviderRef> create, - ) { - return ProviderOverride( - origin: this, - providerOverride: AutoDisposeStreamProvider.internal( - create, - from: from, - argument: argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), - ); - } -} - -/// The element of [AutoDisposeStreamProvider]. -class AutoDisposeStreamProviderElement extends StreamProviderElement - with AutoDisposeProviderElementMixin> - implements AutoDisposeStreamProviderRef { - /// The [ProviderElementBase] for [StreamProvider] - AutoDisposeStreamProviderElement( - AutoDisposeStreamProvider super.provider, - super.container, - ); -} - -/// The [Family] of [AutoDisposeStreamProvider]. -class AutoDisposeStreamProviderFamily extends AutoDisposeFamilyBase< - AutoDisposeStreamProviderRef, - AsyncValue, - Arg, - Stream, - AutoDisposeStreamProvider> { - /// The [Family] of [AutoDisposeStreamProvider]. - AutoDisposeStreamProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: AutoDisposeStreamProvider.internal, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, - ); - - /// {@macro riverpod.override_with} - Override overrideWith( - Stream Function(AutoDisposeStreamProviderRef ref, Arg arg) create, - ) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as AutoDisposeStreamProvider; - - return AutoDisposeStreamProvider.internal( - (ref) => create(ref, provider.argument as Arg), - from: provider.from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} diff --git a/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart b/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart deleted file mode 100644 index 8307e1a5d..000000000 --- a/packages/riverpod/lib/src/legacy_providers/stream_provider/base.dart +++ /dev/null @@ -1,240 +0,0 @@ -part of '../stream_provider.dart'; - -/// {@macro riverpod.provider_ref_base} -/// - [StreamProviderRef.state], the value currently exposed by this provider. -abstract class StreamProviderRef implements Ref> { - /// Obtains the state currently exposed by this provider. - /// - /// Mutating this property will notify the provider listeners. - /// - /// Cannot be called while a provider is creating, unless the setter was called first. - /// - /// Will throw if the provider threw during creation. - AsyncValue get state; - set state(AsyncValue newState); -} - -/// {@template riverpod.stream_provider} -/// Creates a stream and exposes its latest event. -/// -/// [StreamProvider] is identical in behavior/usage to [FutureProvider], modulo -/// the fact that the value created is a [Stream] instead of a [Future]. -/// -/// It can be used to express a value asynchronously loaded that can change over -/// time, such as an editable `Message` coming from a web socket: -/// -/// ```dart -/// final messageProvider = StreamProvider.autoDispose((ref) async* { -/// // Open the connection -/// final channel = IOWebSocketChannel.connect('ws://echo.websocket.org'); -/// -/// // Close the connection when the stream is destroyed -/// ref.onDispose(() => channel.sink.close()); -/// -/// // Parse the value received and emit a Message instance -/// await for (final value in channel.stream) { -/// yield value.toString(); -/// } -/// }); -/// ``` -/// -/// Which the UI can then listen: -/// -/// ```dart -/// Widget build(BuildContext context, WidgetRef ref) { -/// AsyncValue message = ref.watch(messageProvider); -/// -/// return message.when( -/// loading: () => const CircularProgressIndicator(), -/// error: (err, stack) => Text('Error: $err'), -/// data: (message) { -/// return Text(message); -/// }, -/// ); -/// } -/// ``` -/// -/// **Note**: -/// When listening to web sockets, firebase, or anything that consumes resources, -/// it is important to use [StreamProvider.autoDispose] instead of simply [StreamProvider]. -/// -/// This ensures that the resources are released when no longer needed as, -/// by default, a [StreamProvider] is almost never destroyed. -/// -/// See also: -/// -/// - [Provider], a provider that synchronously creates a value -/// - [FutureProvider], a provider that asynchronously exposes a value that -/// can change over time. -/// - [future], to obtain the last value emitted by a [Stream]. -/// - [StreamProvider.family], to create a [StreamProvider] from external parameters -/// - [StreamProvider.autoDispose], to destroy the state of a [StreamProvider] when no longer needed. -/// {@endtemplate} -class StreamProvider extends _StreamProviderBase { - /// {@macro riverpod.stream_provider} - StreamProvider( - this._createFn, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - StreamProvider.internal( - this._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeStreamProviderBuilder(); - - /// {@macro riverpod.family} - static const family = StreamProviderFamilyBuilder(); - - final Stream Function(StreamProviderRef ref) _createFn; - - @override - late final Refreshable> future = _future(this); - - @override - Stream _create(StreamProviderElement ref) => _createFn(ref); - - @override - StreamProviderElement createElement( - ProviderContainer container, - ) { - return StreamProviderElement(this, container); - } - - /// {@macro riverpod.override_with} - @mustBeOverridden - Override overrideWith(Create, StreamProviderRef> create) { - return ProviderOverride( - origin: this, - providerOverride: StreamProvider.internal( - create, - from: from, - argument: argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), - ); - } -} - -/// The element of [StreamProvider]. -class StreamProviderElement extends ProviderElementBase> - with FutureHandlerProviderElementMixin - implements StreamProviderRef { - /// The element of [StreamProvider]. - @internal - StreamProviderElement(this.provider, super.container); - - @override - final _StreamProviderBase provider; - - final _streamNotifier = ProxyElementValueNotifier>(); - final StreamController _streamController = StreamController.broadcast(); - - @override - void create({required bool didChangeDependency}) { - asyncTransition(AsyncLoading(), seamless: !didChangeDependency); - _streamNotifier.result ??= Result.data(_streamController.stream); - - handleStream( - () => provider._create(this), - didChangeDependency: didChangeDependency, - ); - } - - @override - void dispose() { - super.dispose(); - - /// The controller isn't recreated on provider rebuild. So we only close it - /// when the element is destroyed, not on "ref.onDispose". - _streamController.close(); - } - - @override - void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, - required void Function(ProxyElementValueNotifier element) - notifierVisitor, - }) { - super.visitChildren( - elementVisitor: elementVisitor, - notifierVisitor: notifierVisitor, - ); - notifierVisitor(_streamNotifier); - } - - @override - void onData(AsyncData value, {bool seamless = false}) { - if (!_streamController.isClosed) { - // The controller might be closed if onData is executed post dispose. Cf onData - _streamController.add(value.value); - } - super.onData(value, seamless: seamless); - } - - @override - void onError(AsyncError value, {bool seamless = false}) { - if (!_streamController.isClosed) { - // The controller might be closed if onError is executed post dispose. Cf onError - _streamController.addError(value.error, value.stackTrace); - } - super.onError(value, seamless: seamless); - } -} - -/// The [Family] of [StreamProvider]. -class StreamProviderFamily extends FamilyBase, - AsyncValue, Arg, Stream, StreamProvider> { - /// The [Family] of [StreamProvider]. - StreamProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: StreamProvider.internal, - debugGetCreateSourceHash: null, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - ); - - /// {@macro riverpod.override_with} - Override overrideWith( - Stream Function(StreamProviderRef ref, Arg arg) create, - ) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as StreamProvider; - - return StreamProvider.internal( - (ref) => create(ref, provider.argument as Arg), - from: provider.from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} diff --git a/packages/riverpod/pubspec.yaml b/packages/riverpod/pubspec.yaml index 634960889..6632f1b55 100644 --- a/packages/riverpod/pubspec.yaml +++ b/packages/riverpod/pubspec.yaml @@ -20,6 +20,7 @@ dependencies: test: ^1.0.0 dev_dependencies: - analyzer: ">=5.12.0 <7.0.0" + analyzer: ^6.3.0 mockito: ^5.0.0 + path: ^1.9.0 trotter: ^2.0.0-dev.1 diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart new file mode 100644 index 000000000..cd99cb650 --- /dev/null +++ b/packages/riverpod/test/meta_test.dart @@ -0,0 +1,326 @@ +import 'package:analyzer/dart/analysis/results.dart'; +import 'package:analyzer/dart/analysis/utilities.dart'; +import 'package:analyzer/dart/element/element.dart'; +import 'package:analyzer/dart/element/type.dart'; +import 'package:analyzer/dart/element/visitor.dart'; +import 'package:path/path.dart' as path; +import 'package:test/test.dart'; + +void main() { + // This verifies that: + // - All public APIs are documented + // - public APIs have no unexported types + // - {@template} are not duplicated + // - all {@template} are used + // - all {@macro} have an associated {@template} + + late final LibraryElement riverpod; + late final _PublicAPIVisitor visitor; + + setUpAll(() async { + const file = './example/lib/main.dart'; + final absolute = path.normalize(path.absolute(file)); + + final result = await resolveFile2(path: absolute); + result as ResolvedUnitResult; + + riverpod = result.libraryElement.importedLibraries.firstWhere( + (e) => e.source.uri.toString() == 'package:riverpod/riverpod.dart', + ); + visitor = _PublicAPIVisitor(riverpod); + + riverpod.accept(visitor); + for (final publicApi in riverpod.exportNamespace.definedNames.values) { + publicApi.accept(visitor); + } + }); + + test('public API snapshot', () async { + expect(riverpod.exportNamespace.definedNames.keys, [ + 'StateNotifier', + 'AsyncValue', + 'AsyncData', + 'AsyncLoading', + 'AsyncError', + // TODO remove + 'AsyncValueX', + // TODO rename + 'ProviderBase', + // TODO remove + 'FunctionalProvider', + // TODO remove + 'RunNotifierBuild', + // TODO remove + 'ClassProvider', + // TODO remove + 'ClassProviderElement', + 'Refreshable', + // TODO remove + 'ProviderElementBase', + 'ProviderContainer', + 'ProviderObserver', + // TODO remove + 'CircularDependencyError', + 'Family', + 'ProviderSubscription', + // TODO remove + 'ProviderListenableOrFamily', + // TODO remove + 'ProviderOrFamily', + // TODO remove + 'describeIdentity', + // TODO remove + 'shortHash', + 'ProviderListenable', + 'Ref', + 'KeepAliveLink', + 'Override', + // TODO remove + 'FutureModifier', + // TODO remove + 'FutureModifierElement', + 'AsyncNotifier', + 'AsyncNotifierProvider', + 'FamilyAsyncNotifier', + 'FamilyAsyncNotifierProvider', + 'AsyncNotifierProviderFamily', + 'StreamNotifier', + 'StreamNotifierProvider', + 'FamilyStreamNotifier', + 'FamilyStreamNotifierProvider', + 'StreamNotifierProviderFamily', + 'StateController', + // TODO remove + 'AutoDisposeStateNotifierProviderRef', + // TODO remove + 'AutoDisposeStateNotifierProvider', + // TODO remove + 'AutoDisposeStateNotifierProviderElement', + // TODO remove + 'AutoDisposeStateNotifierProviderFamily', + // TODO remove + 'StateNotifierProviderRef', + 'StateNotifierProvider', + // TODO remove + 'StateNotifierProviderElement', + 'StateNotifierProviderFamily', + // TODO remove + 'AutoDisposeStateProviderRef', + // TODO remove + 'AutoDisposeStateProvider', + // TODO remove + 'AutoDisposeStateProviderElement', + // TODO remove + 'AutoDisposeStateProviderFamily', + // TODO remove + 'StateProviderRef', + 'StateProvider', + // TODO remove + 'StateProviderElement', + 'StateProviderFamily', + 'FutureProvider', + // TODO remove + 'FutureProviderRef', + // TODO remove + 'FutureProviderElement', + 'FutureProviderFamily', + // TODO remove + 'alreadyInitializedError', + // TODO remove + 'uninitializedElementError', + // TODO remove + 'AutoDisposeNotifier', + // TODO remove + 'AutoDisposeNotifierProviderRef', + // TODO remove + // TODO remove + // TODO remove + 'AutoDisposeNotifierProvider', + // TODO remove + 'AutoDisposeNotifierProviderElement', + // TODO remove + 'AutoDisposeFamilyNotifier', + // TODO remove + 'AutoDisposeFamilyNotifierProvider', + // TODO remove + 'AutoDisposeNotifierProviderFamily', + 'Notifier', + // TODO remove + 'NotifierProviderRef', + 'NotifierProvider', + // TODO remove + 'NotifierProviderElement', + 'FamilyNotifier', + 'NotifierFamilyProvider', + 'NotifierProviderFamily', + 'Provider', + // TODO remove + 'ProviderElement', + 'ProviderFamily', + 'StreamProvider', + // TODO remove + 'StreamProviderElement', + 'StreamProviderFamily', + ]); + + expect(visitor.undocumentedElements, isEmpty); + + expect(visitor.duplicateTemplates, isEmpty, reason: 'Duplicate templates'); + for (final template in visitor.templates) { + expect(visitor.macros, contains(template), reason: 'Unused template'); + } + for (final macro in visitor.macros) { + expect(visitor.templates, contains(macro), reason: 'Missing template'); + } + }); + + test('public API does not contain unexported elements', () { + expect(visitor.unexportedElements, isEmpty); + }); + + test('all public APIs are documented', () { + expect(visitor.undocumentedElements, isEmpty); + }); + + test('all templates are used', () { + expect(visitor.duplicateTemplates, isEmpty, reason: 'Duplicate templates'); + for (final template in visitor.templates) { + expect(visitor.macros, contains(template), reason: 'Unused template'); + } + for (final macro in visitor.macros) { + expect(visitor.templates, contains(macro), reason: 'Missing template'); + } + }); + + // TODO test @visibleForTesting/protected/internal & co are inherited when overridden +} + +class _PublicAPIVisitor extends GeneralizingElementVisitor { + _PublicAPIVisitor(this.riverpod); + + final LibraryElement riverpod; + final unexportedElements = {}; + final undocumentedElements = {}; + + final templates = {}; + final duplicateTemplates = {}; + final macros = {}; + + void _verifyTypeIsExported(DartType type, VariableElement element) { + if (type is TypeParameterType) { + _verifyTypeIsExported(type.bound, element); + return; + } + + if (type is FunctionType) { + _verifyTypeIsExported(type.returnType, element); + for (final parameter in type.parameters) { + _verifyTypeIsExported(parameter.type, element); + } + return; + } + + if (type.isCore) return; + + final key = type.element?.name ?? ''; + if (!riverpod.exportNamespace.definedNames.containsKey(key)) { + unexportedElements.add('${element.location}#$key'); + } + } + + void _verifyHasDocs(Element element) { + if (element.documentationComment?.isNotEmpty != true) { + undocumentedElements.add('${element.location}'); + } + } + + bool _isPublicApi(Element element) { + if (element.isPrivate) return false; + // Is part of an @internal element + if (element.thisOrAncestorMatching((e) => e.hasInternal) != null) { + return false; + } + + return true; + } + + @override + void visitElement(Element element) { + super.visitElement(element); + + if (_isPublicApi(element)) { + _verifyHasDocs(element); + _parseTemplatesAndMacros(element); + } + } + + @override + void visitClassElement(ClassElement element) { + super.visitClassElement(element); + + // Verify that inherited members also respect public API constraints + for (final superType in element.allSupertypes) { + visitElement(element); + } + } + + @override + void visitVariableElement(VariableElement element) { + super.visitVariableElement(element); + + _verifyTypeIsExported(element.type, element); + } + + void _parseTemplatesAndMacros(Element element) { + final docs = element.documentationComment; + if (docs == null) return; + + final regExp = RegExp(r'{@(\w+) (\S+)}', multiLine: true); + for (final match in regExp.allMatches(docs)) { + final type = match.group(1)!; + final name = match.group(2)!; + + if (type == 'template') { + if (!templates.add(name)) { + duplicateTemplates.add(name); + } + } else if (type == 'macro') { + macros.add(name); + } + } + } +} + +extension on DartType { + /// If it is from the Dart SDK + bool get isCore { + if (this is DynamicType || + this is VoidType || + isDartAsyncFuture || + isDartAsyncFutureOr || + isDartAsyncStream || + isDartCoreBool || + isDartCoreDouble || + isDartCoreEnum || + isDartCoreFunction || + isDartCoreInt || + isDartCoreIterable || + isDartCoreList || + isDartCoreMap || + isDartCoreNull || + isDartCoreNum || + isDartCoreObject || + isDartCoreRecord || + isDartCoreSet || + isDartCoreString || + isDartCoreSymbol || + isDartCoreType) { + return true; + } + + final element = this.element; + if (element == null) return false; + + return element.librarySource?.uri.toString().startsWith('dart:') ?? false; + } +} diff --git a/packages/riverpod/test/old/framework/provider_element_test.dart b/packages/riverpod/test/old/framework/provider_element_test.dart index 7a9960a2e..a92c0c30d 100644 --- a/packages/riverpod/test/old/framework/provider_element_test.dart +++ b/packages/riverpod/test/old/framework/provider_element_test.dart @@ -1227,9 +1227,8 @@ void main() { final children = >[]; - container - .readProviderElement(provider) - .visitChildren(elementVisitor: children.add, notifierVisitor: (_) {}); + container.readProviderElement(provider).visitChildren( + elementVisitor: children.add, listenableVisitor: (_) {}); expect( children, unorderedMatches([ @@ -1256,9 +1255,8 @@ void main() { final children = >[]; - container - .readProviderElement(provider) - .visitChildren(elementVisitor: children.add, notifierVisitor: (_) {}); + container.readProviderElement(provider).visitChildren( + elementVisitor: children.add, listenableVisitor: (_) {}); expect( children, unorderedMatches([ diff --git a/packages/riverpod/test/old/legacy/framework2/framework_test.dart b/packages/riverpod/test/old/legacy/framework2/framework_test.dart index 8a1007e2f..315f808ad 100644 --- a/packages/riverpod/test/old/legacy/framework2/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework2/framework_test.dart @@ -257,12 +257,12 @@ void main() { var firstDependents = >[]; firstElement.visitChildren( elementVisitor: firstDependents.add, - notifierVisitor: (_) {}, + listenableVisitor: (_) {}, ); var secondDependents = >[]; secondElement.visitChildren( elementVisitor: secondDependents.add, - notifierVisitor: (_) {}, + listenableVisitor: (_) {}, ); expect(firstDependents, [computedElement]); @@ -276,12 +276,12 @@ void main() { firstDependents = >[]; firstElement.visitChildren( elementVisitor: firstDependents.add, - notifierVisitor: (_) {}, + listenableVisitor: (_) {}, ); secondDependents = >[]; secondElement.visitChildren( elementVisitor: secondDependents.add, - notifierVisitor: (_) {}, + listenableVisitor: (_) {}, ); expect(firstDependents, [computedElement]); expect(firstElement.hasListeners, true); @@ -322,7 +322,7 @@ void main() { var firstDependents = >[]; firstElement.visitChildren( elementVisitor: firstDependents.add, - notifierVisitor: (_) {}, + listenableVisitor: (_) {}, ); expect(firstDependents, {computedElement}); expect(firstElement.hasListeners, true); @@ -333,7 +333,7 @@ void main() { firstDependents = >[]; firstElement.visitChildren( elementVisitor: firstDependents.add, - notifierVisitor: (_) {}, + listenableVisitor: (_) {}, ); expect(firstDependents, >{}); expect(firstElement.hasListeners, false); diff --git a/packages/riverpod/test/old/legacy_providers/async_notifier/factory.dart b/packages/riverpod/test/old/legacy_providers/async_notifier/factory.dart index cc916fa9d..2bb7a8274 100644 --- a/packages/riverpod/test/old/legacy_providers/async_notifier/factory.dart +++ b/packages/riverpod/test/old/legacy_providers/async_notifier/factory.dart @@ -4,7 +4,7 @@ import 'package:riverpod/src/internals.dart'; typedef AsyncNotifierProviderFactoryType = AsyncNotifierProviderBase - Function, T>( + Function, T>( NotifierT Function() create, { Iterable? dependencies, String? name, @@ -55,7 +55,7 @@ List matrix({ AsyncNotifierFactory( label: 'AsyncNotifierProviderFamily', isAutoDispose: false, - provider: , T>( + provider: , T>( create, { argument, dependencies, @@ -124,7 +124,7 @@ List matrix({ AsyncNotifierFactory( label: 'AutoDisposeAsyncNotifierProviderFamily', isAutoDispose: true, - provider: , T>( + provider: , T>( create, { argument, dependencies, @@ -189,7 +189,7 @@ class AsyncNotifierFactory { final SimpleTestProviderFactoryType simpleTestProvider; } -abstract class AsyncTestNotifierBase extends AsyncNotifierBase { +abstract class AsyncTestNotifierBase extends _AsyncNotifierBase { // overriding to remove the @protected @override Future update( diff --git a/packages/riverpod/test/old/legacy_providers/stream_notifier/factory.dart b/packages/riverpod/test/old/legacy_providers/stream_notifier/factory.dart index a2ce5ea0b..a4df4ebaa 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_notifier/factory.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_notifier/factory.dart @@ -4,7 +4,7 @@ import 'package:riverpod/src/internals.dart'; typedef StreamNotifierProviderFactoryType = StreamNotifierProviderBase - Function, T>( + Function, T>( NotifierT Function() create, { String? name, }); @@ -54,7 +54,7 @@ List matrix({ StreamNotifierFactory( label: 'StreamNotifierProviderFamily', isAutoDispose: false, - provider: , T>( + provider: , T>( create, { argument, dependencies, @@ -123,7 +123,7 @@ List matrix({ StreamNotifierFactory( label: 'AutoDisposeStreamNotifierProviderFamily', isAutoDispose: true, - provider: , T>( + provider: , T>( create, { argument, dependencies, @@ -188,7 +188,7 @@ class StreamNotifierFactory { final SimpleTestProviderFactoryType simpleTestProvider; } -abstract class StreamTestNotifierBase extends AsyncNotifierBase { +abstract class StreamTestNotifierBase extends _AsyncNotifierBase { // overriding to remove the @protected @override AsyncValue get state; diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index 009c06387..6344506d7 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -75,7 +75,7 @@ export 'package:riverpod/src/internals.dart' // AsyncNotifier AsyncNotifier, AutoDisposeAsyncNotifier, - AsyncNotifierProviderElement, + _AsyncNotifierProviderElement, AutoDisposeAsyncNotifierProviderElement, // ignore: invalid_use_of_internal_member AsyncNotifierProviderImpl, @@ -93,7 +93,7 @@ export 'package:riverpod/src/internals.dart' // StreamNotifier StreamNotifier, AutoDisposeStreamNotifier, - StreamNotifierProviderElement, + _StreamNotifierProviderElement, AutoDisposeStreamNotifierProviderElement, // ignore: invalid_use_of_internal_member StreamNotifierProviderImpl, diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index 9bb608dba..cf8c89092 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -766,7 +766,7 @@ mixin A6Ref on AsyncNotifierProviderRef { int get param; } -class _A6ProviderElement extends AsyncNotifierProviderElement +class _A6ProviderElement extends _AsyncNotifierProviderElement with A6Ref { _A6ProviderElement(super.provider, super.container); @@ -1126,7 +1126,7 @@ mixin A8Ref on StreamNotifierProviderRef { int get param; } -class _A8ProviderElement extends StreamNotifierProviderElement +class _A8ProviderElement extends _StreamNotifierProviderElement with A8Ref { _A8ProviderElement(super.provider, super.container); diff --git a/tools/generate_providers/bin/generate_providers.dart b/tools/generate_providers/bin/generate_providers.dart index fe9321f33..b53a13007 100644 --- a/tools/generate_providers/bin/generate_providers.dart +++ b/tools/generate_providers/bin/generate_providers.dart @@ -377,24 +377,24 @@ Future main(List args) async { ), StateDetails( className: 'Provider', - ref: 'ProviderRef', - constraints: 'State', - generics: 'State', - createType: 'State', + ref: 'Ref', + constraints: 'StateT', + generics: 'StateT', + createType: 'StateT', ), StateDetails( className: 'FutureProvider', - ref: 'FutureProviderRef', - constraints: 'State', - generics: 'State', - createType: 'FutureOr', + ref: 'FutureProviderRef', + constraints: 'StateT', + generics: 'StateT', + createType: 'FutureOr', ), StateDetails( className: 'StreamProvider', - ref: 'StreamProviderRef', - constraints: 'State', - generics: 'State', - createType: 'Stream', + ref: 'Ref', + constraints: 'StateT', + generics: 'StateT', + createType: 'Stream', ), ], ProviderType.values, From 82c414ad0115e8df626e76ee894a3e5bf44a4847 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 13 Jan 2024 15:18:33 +0100 Subject: [PATCH 124/387] Unexport deprecated providers from main import --- .../lib/flutter_riverpod.dart | 3 +- packages/flutter_riverpod/lib/legacy.dart | 3 ++ packages/riverpod/lib/legacy.dart | 5 +++ packages/riverpod/lib/riverpod.dart | 7 ++-- packages/riverpod/lib/src/core/family.dart | 7 +++- .../async_notifier/family.dart | 38 +++++++++---------- .../async_notifier/orphan.dart | 2 +- .../riverpod/test/new/core/provider_test.dart | 3 ++ 8 files changed, 40 insertions(+), 28 deletions(-) create mode 100644 packages/flutter_riverpod/lib/legacy.dart create mode 100644 packages/riverpod/lib/legacy.dart diff --git a/packages/flutter_riverpod/lib/flutter_riverpod.dart b/packages/flutter_riverpod/lib/flutter_riverpod.dart index d7600ee45..9f3929c79 100644 --- a/packages/flutter_riverpod/lib/flutter_riverpod.dart +++ b/packages/flutter_riverpod/lib/flutter_riverpod.dart @@ -1,4 +1,5 @@ export 'package:riverpod/riverpod.dart'; export 'src/core.dart' hide ProviderScopeState; -export 'src/legacy/deprecated/change_notifier_provider.dart'; +// TODO changelog breaking: StateNotifier & co are no-longer exported from pkg:riverpod/riverpod.dart +// Use pkg:riverpod/legacy.dart \ No newline at end of file diff --git a/packages/flutter_riverpod/lib/legacy.dart b/packages/flutter_riverpod/lib/legacy.dart new file mode 100644 index 000000000..e809c8df4 --- /dev/null +++ b/packages/flutter_riverpod/lib/legacy.dart @@ -0,0 +1,3 @@ +export 'flutter_riverpod.dart'; + +export 'src/legacy/deprecated/change_notifier_provider.dart'; diff --git a/packages/riverpod/lib/legacy.dart b/packages/riverpod/lib/legacy.dart new file mode 100644 index 000000000..138d2c66d --- /dev/null +++ b/packages/riverpod/lib/legacy.dart @@ -0,0 +1,5 @@ +export 'riverpod.dart'; + +export 'src/legacy_providers/deprecated/state_controller.dart'; +export 'src/legacy_providers/deprecated/state_notifier_provider.dart'; +export 'src/legacy_providers/deprecated/state_provider.dart'; diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 5b52d29a0..05b2ad834 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -58,9 +58,10 @@ export 'src/legacy_providers/async_notifier.dart' StreamNotifierProviderBase, BuildlessAutoDisposeStreamNotifier, BuildlessStreamNotifier; -export 'src/legacy_providers/deprecated/state_controller.dart'; -export 'src/legacy_providers/deprecated/state_notifier_provider.dart'; -export 'src/legacy_providers/deprecated/state_provider.dart'; + +// TODO changelog breaking: StateNotifier & co are no-longer exported from pkg:riverpod/riverpod.dart +// Use pkg:riverpod/legacy.dart + export 'src/legacy_providers/future_provider.dart'; export 'src/legacy_providers/notifier.dart' hide diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index 26f8a5913..53997265a 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -29,11 +29,13 @@ typedef ClassProviderFactory< // RefT extends Ref, ArgT> = ProviderT Function( - CreatedT Function() create, { + NotifierT Function() create, { required String? name, required Iterable? dependencies, required Iterable? allTransitiveDependencies, required DebugGetCreateSourceHash? debugGetCreateSourceHash, + required RunNotifierBuild? + runNotifierBuildOverride, required bool isAutoDispose, required Family from, required ArgT argument, @@ -173,7 +175,7 @@ class ClassFamily< // // TODO docs @internal - final ClassProviderFactory + final ClassProviderFactory providerFactory; final NotifierT Function() _createFn; @@ -189,6 +191,7 @@ class ClassFamily< // dependencies: dependencies, allTransitiveDependencies: allTransitiveDependencies, debugGetCreateSourceHash: debugGetCreateSourceHash, + runNotifierBuildOverride: null, ); } diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart index 7180f3aad..82b399004 100644 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart @@ -28,21 +28,8 @@ final class FamilyAsyncNotifierProvider< // StateT, ArgT> // extends _AsyncNotifierProviderBase { - const FamilyAsyncNotifierProvider( - super._createNotifier, { - super.name, - super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.isAutoDispose, - required super.from, - required super.argument, - required super.runNotifierBuildOverride, - }); - /// An implementation detail of Riverpod - @internal - const FamilyAsyncNotifierProvider.internal( + const FamilyAsyncNotifierProvider._( super._createNotifier, { required super.name, required super.dependencies, @@ -54,9 +41,6 @@ final class FamilyAsyncNotifierProvider< // required super.runNotifierBuildOverride, }); - /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeAsyncNotifierProviderFamily.new; - @override _AsyncNotifierProviderElement createElement( ProviderContainer container, @@ -72,7 +56,7 @@ final class FamilyAsyncNotifierProvider< // Ref>>? build, }) { - return FamilyAsyncNotifierProvider.internal( + return FamilyAsyncNotifierProvider._( create ?? _createNotifier, name: name, dependencies: dependencies, @@ -114,6 +98,20 @@ class AsyncNotifierProviderFamily< // FutureOr, FamilyAsyncNotifierProvider> { /// The [Family] of [AsyncNotifierProvider]. + AsyncNotifierProviderFamily( + super._createFn, { + super.name, + super.dependencies, + super.isAutoDispose = false, + }) : super( + providerFactory: FamilyAsyncNotifierProvider._, + debugGetCreateSourceHash: null, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + ); + + /// The [Family] of [AsyncNotifierProvider]. + @internal AsyncNotifierProviderFamily.internal( super._createFn, { super.name, @@ -121,7 +119,5 @@ class AsyncNotifierProviderFamily< // required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, required super.isAutoDispose, - }) : super( - providerFactory: FamilyAsyncNotifierProvider.internal, - ); + }) : super(providerFactory: FamilyAsyncNotifierProvider._); } diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier/orphan.dart index f63bd1919..33a6748cb 100644 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/legacy_providers/async_notifier/orphan.dart @@ -76,7 +76,7 @@ final class AsyncNotifierProvider< // /// An implementation detail of Riverpod @internal - AsyncNotifierProvider.internal( + const AsyncNotifierProvider.internal( super._createNotifier, { required super.name, required super.dependencies, diff --git a/packages/riverpod/test/new/core/provider_test.dart b/packages/riverpod/test/new/core/provider_test.dart index 45e6d4085..2590cd38c 100644 --- a/packages/riverpod/test/new/core/provider_test.dart +++ b/packages/riverpod/test/new/core/provider_test.dart @@ -3,6 +3,9 @@ import 'package:test/test.dart'; void main() { group('ProviderBase', () { + // TODO assert all providers have an "internal" const constructor + // TODO assert all non-internal constructors set allTransitiveDependencies + test('allTransitiveDependencies', () { final a = Provider((ref) => 0); final b = Provider.family((ref, _) => 0, dependencies: [a]); From 2e87e13c1a167dfd18115bc11fa403fd29eeecb3 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 15 Jan 2024 09:17:58 +0100 Subject: [PATCH 125/387] W --- packages/flutter_riverpod/lib/legacy.dart | 2 +- .../flutter_riverpod/lib/src/internals.dart | 2 +- .../legacy}/builders.dart | 0 .../legacy}/change_notifier_provider.dart | 0 .../auto_dispose.dart | 0 .../change_notifier_provider/base.dart | 0 packages/riverpod/lib/legacy.dart | 6 +- packages/riverpod/lib/riverpod.dart | 10 +- .../riverpod/lib/src/core/async_value.dart | 4 +- packages/riverpod/lib/src/core/builder.dart | 291 +++++ .../lib/src/core/modifiers/future.dart | 104 ++ packages/riverpod/lib/src/internals.dart | 15 +- .../src/legacy_providers/async_notifier.dart | 147 --- .../lib/src/legacy_providers/builders.dart | 1074 ----------------- .../src/legacy_providers/stream_notifier.dart | 87 -- .../stream_notifier/family.dart | 150 --- .../stream_notifier/orphan.dart | 101 -- .../lib/src/providers/async_notifier.dart | 46 + .../async_notifier/family.dart | 14 +- .../async_notifier/orphan.dart | 26 +- .../future_provider.dart | 52 +- .../legacy}/state_controller.dart | 0 .../legacy}/state_notifier_provider.dart | 0 .../state_notifier_provider/auto_dispose.dart | 0 .../legacy}/state_notifier_provider/base.dart | 0 .../legacy}/state_provider.dart | 0 .../legacy}/state_provider/auto_dispose.dart | 0 .../legacy}/state_provider/base.dart | 0 .../notifier.dart | 1 - .../notifier/auto_dispose.dart | 0 .../notifier/auto_dispose_family.dart | 0 .../notifier/base.dart | 0 .../notifier/family.dart | 0 .../provider.dart | 58 +- .../lib/src/providers/stream_notifier.dart | 45 + .../src/providers/stream_notifier/family.dart | 134 ++ .../src/providers/stream_notifier/orphan.dart | 179 +++ .../stream_provider.dart | 52 +- .../test/new/core/overrides_test.dart | 5 +- .../riverpod/test/new/core/provider_test.dart | 4 + .../bin/generate_providers.dart | 886 -------------- tools/generate_providers/pubspec.yaml | 13 - 42 files changed, 1006 insertions(+), 2502 deletions(-) rename packages/flutter_riverpod/lib/src/{legacy/deprecated => providers/legacy}/builders.dart (100%) rename packages/flutter_riverpod/lib/src/{legacy/deprecated => providers/legacy}/change_notifier_provider.dart (100%) rename packages/flutter_riverpod/lib/src/{legacy/deprecated => providers/legacy}/change_notifier_provider/auto_dispose.dart (100%) rename packages/flutter_riverpod/lib/src/{legacy/deprecated => providers/legacy}/change_notifier_provider/base.dart (100%) create mode 100644 packages/riverpod/lib/src/core/builder.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/async_notifier.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/builders.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/stream_notifier.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/stream_notifier/family.dart delete mode 100644 packages/riverpod/lib/src/legacy_providers/stream_notifier/orphan.dart create mode 100644 packages/riverpod/lib/src/providers/async_notifier.dart rename packages/riverpod/lib/src/{legacy_providers => providers}/async_notifier/family.dart (89%) rename packages/riverpod/lib/src/{legacy_providers => providers}/async_notifier/orphan.dart (88%) rename packages/riverpod/lib/src/{legacy_providers => providers}/future_provider.dart (81%) rename packages/riverpod/lib/src/{legacy_providers/deprecated => providers/legacy}/state_controller.dart (100%) rename packages/riverpod/lib/src/{legacy_providers/deprecated => providers/legacy}/state_notifier_provider.dart (100%) rename packages/riverpod/lib/src/{legacy_providers/deprecated => providers/legacy}/state_notifier_provider/auto_dispose.dart (100%) rename packages/riverpod/lib/src/{legacy_providers/deprecated => providers/legacy}/state_notifier_provider/base.dart (100%) rename packages/riverpod/lib/src/{legacy_providers/deprecated => providers/legacy}/state_provider.dart (100%) rename packages/riverpod/lib/src/{legacy_providers/deprecated => providers/legacy}/state_provider/auto_dispose.dart (100%) rename packages/riverpod/lib/src/{legacy_providers/deprecated => providers/legacy}/state_provider/base.dart (100%) rename packages/riverpod/lib/src/{legacy_providers => providers}/notifier.dart (99%) rename packages/riverpod/lib/src/{legacy_providers => providers}/notifier/auto_dispose.dart (100%) rename packages/riverpod/lib/src/{legacy_providers => providers}/notifier/auto_dispose_family.dart (100%) rename packages/riverpod/lib/src/{legacy_providers => providers}/notifier/base.dart (100%) rename packages/riverpod/lib/src/{legacy_providers => providers}/notifier/family.dart (100%) rename packages/riverpod/lib/src/{legacy_providers => providers}/provider.dart (89%) create mode 100644 packages/riverpod/lib/src/providers/stream_notifier.dart create mode 100644 packages/riverpod/lib/src/providers/stream_notifier/family.dart create mode 100644 packages/riverpod/lib/src/providers/stream_notifier/orphan.dart rename packages/riverpod/lib/src/{legacy_providers => providers}/stream_provider.dart (82%) delete mode 100644 tools/generate_providers/bin/generate_providers.dart delete mode 100644 tools/generate_providers/pubspec.yaml diff --git a/packages/flutter_riverpod/lib/legacy.dart b/packages/flutter_riverpod/lib/legacy.dart index e809c8df4..e15ce5741 100644 --- a/packages/flutter_riverpod/lib/legacy.dart +++ b/packages/flutter_riverpod/lib/legacy.dart @@ -1,3 +1,3 @@ export 'flutter_riverpod.dart'; -export 'src/legacy/deprecated/change_notifier_provider.dart'; +export 'src/providers/legacy/change_notifier_provider.dart'; diff --git a/packages/flutter_riverpod/lib/src/internals.dart b/packages/flutter_riverpod/lib/src/internals.dart index 67419df19..93b81e119 100644 --- a/packages/flutter_riverpod/lib/src/internals.dart +++ b/packages/flutter_riverpod/lib/src/internals.dart @@ -1,4 +1,4 @@ export 'package:riverpod/src/internals.dart'; export './core.dart'; -export 'legacy/deprecated/change_notifier_provider.dart'; +export 'providers/legacy/change_notifier_provider.dart'; diff --git a/packages/flutter_riverpod/lib/src/legacy/deprecated/builders.dart b/packages/flutter_riverpod/lib/src/providers/legacy/builders.dart similarity index 100% rename from packages/flutter_riverpod/lib/src/legacy/deprecated/builders.dart rename to packages/flutter_riverpod/lib/src/providers/legacy/builders.dart diff --git a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider.dart b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart similarity index 100% rename from packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider.dart rename to packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart diff --git a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider/auto_dispose.dart similarity index 100% rename from packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/auto_dispose.dart rename to packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider/auto_dispose.dart diff --git a/packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider/base.dart similarity index 100% rename from packages/flutter_riverpod/lib/src/legacy/deprecated/change_notifier_provider/base.dart rename to packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider/base.dart diff --git a/packages/riverpod/lib/legacy.dart b/packages/riverpod/lib/legacy.dart index 138d2c66d..34b72829b 100644 --- a/packages/riverpod/lib/legacy.dart +++ b/packages/riverpod/lib/legacy.dart @@ -1,5 +1,5 @@ export 'riverpod.dart'; -export 'src/legacy_providers/deprecated/state_controller.dart'; -export 'src/legacy_providers/deprecated/state_notifier_provider.dart'; -export 'src/legacy_providers/deprecated/state_provider.dart'; +export 'src/providers/legacy/state_controller.dart'; +export 'src/providers/legacy/state_notifier_provider.dart'; +export 'src/providers/legacy/state_provider.dart'; diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 05b2ad834..bc3d2ae55 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -39,7 +39,7 @@ export 'src/framework.dart' ProviderPointerManager, ProviderDirectory; -export 'src/legacy_providers/async_notifier.dart' +export 'src/providers/async_notifier.dart' hide AsyncNotifierProviderImpl, AutoDisposeAsyncNotifierProviderImpl, @@ -62,8 +62,8 @@ export 'src/legacy_providers/async_notifier.dart' // TODO changelog breaking: StateNotifier & co are no-longer exported from pkg:riverpod/riverpod.dart // Use pkg:riverpod/legacy.dart -export 'src/legacy_providers/future_provider.dart'; -export 'src/legacy_providers/notifier.dart' +export 'src/providers/future_provider.dart'; +export 'src/providers/notifier.dart' hide NotifierBase, NotifierProviderBase, @@ -73,5 +73,5 @@ export 'src/legacy_providers/notifier.dart' NotifierProviderImpl, BuildlessAutoDisposeNotifier, BuildlessNotifier; -export 'src/legacy_providers/provider.dart' hide InternalProvider; -export 'src/legacy_providers/stream_provider.dart'; +export 'src/providers/provider.dart' hide InternalProvider; +export 'src/providers/stream_provider.dart'; diff --git a/packages/riverpod/lib/src/core/async_value.dart b/packages/riverpod/lib/src/core/async_value.dart index 3eff83824..d0591febc 100644 --- a/packages/riverpod/lib/src/core/async_value.dart +++ b/packages/riverpod/lib/src/core/async_value.dart @@ -2,8 +2,8 @@ import 'package:meta/meta.dart'; import '../common/stack_trace.dart'; import '../framework.dart'; -import '../legacy_providers/future_provider.dart' show FutureProvider; -import '../legacy_providers/stream_provider.dart' show StreamProvider; +import '../providers/future_provider.dart' show FutureProvider; +import '../providers/stream_provider.dart' show StreamProvider; /// An extension for [asyncTransition]. @internal diff --git a/packages/riverpod/lib/src/core/builder.dart b/packages/riverpod/lib/src/core/builder.dart new file mode 100644 index 000000000..06d4c1249 --- /dev/null +++ b/packages/riverpod/lib/src/core/builder.dart @@ -0,0 +1,291 @@ +import 'package:meta/meta.dart'; + +import '../providers/future_provider.dart'; +import '../providers/stream_provider.dart'; + +typedef OrphanCreate = CreatedT Function(RefT ref); +typedef OrphanNotifierCreate = NotifierT Function(RefT ref); + +@internal +class FamilyBuilder { + const FamilyBuilder({ + required this.call, + required this.autoDispose, + }); + + /// {@template riverpod.family} + /// A group of providers that builds their value from an external parameter. + /// + /// Families can be useful to connect a provider with values that it doesn't + /// have access to. For example: + /// + /// - Allowing a "title provider" access the `Locale` + /// + /// ```dart + /// final titleFamily = Provider.family((ref, locale) { + /// if (locale == const Locale('en')) { + /// return 'English title'; + /// } else if (locale == const Locale('fr')) { + /// return 'Titre Français'; + /// } + /// }); + /// + /// // ... + /// + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// final locale = Localizations.localeOf(context); + /// + /// // Obtains the title based on the current Locale. + /// // Will automatically update the title when the Locale changes. + /// final title = ref.watch(titleFamily(locale)); + /// + /// return Text(title); + /// } + /// ``` + /// + /// - Have a "user provider" that receives the user ID as a parameter + /// + /// ```dart + /// final userFamily = FutureProvider.family((ref, userId) async { + /// final userRepository = ref.read(userRepositoryProvider); + /// return await userRepository.fetch(userId); + /// }); + /// + /// // ... + /// + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// int userId; // Read the user ID from somewhere + /// + /// // Read and potentially fetch the user with id `userId`. + /// // When `userId` changes, this will automatically update the UI + /// // Similarly, if two widgets tries to read `userFamily` with the same `userId` + /// // then the user will be fetched only once. + /// final user = ref.watch(userFamily(userId)); + /// + /// return user.when( + /// data: (user) => Text(user.name), + /// loading: () => const CircularProgressIndicator(), + /// error: (err, stack) => const Text('error'), + /// ); + /// } + /// ``` + /// + /// - Connect a provider with another provider without having a direct reference on it. + /// + /// ```dart + /// final repositoryProvider = Provider.family>((ref, configurationsProvider) { + /// // Read a provider without knowing what that provider is. + /// final configurations = await ref.read(configurationsProvider.future); + /// return Repository(host: configurations.host); + /// }); + /// ``` + /// + /// ## Usage + /// + /// The way families works is by adding an extra parameter to the provider. + /// This parameter can then be freely used in our provider to create some state. + /// + /// For example, we could combine `family` with [FutureProvider] to fetch + /// a `Message` from its ID: + /// + /// ```dart + /// final messagesFamily = FutureProvider.family((ref, id) async { + /// return dio.get('http://my_api.dev/messages/$id'); + /// }); + /// ``` + /// + /// Then, when using our `messagesFamily` provider, the syntax is slightly modified. + /// The usual: + /// + /// ```dart + /// Widget build(BuildContext context, WidgetRef ref) { + /// // Error – messagesFamily is not a provider + /// final response = ref.watch(messagesFamily); + /// } + /// ``` + /// + /// will not work anymore. + /// Instead, we need to pass a parameter to `messagesFamily`: + /// + /// ```dart + /// Widget build(BuildContext context, WidgetRef ref) { + /// final response = ref.watch(messagesFamily('id')); + /// } + /// ``` + /// + /// **NOTE**: It is totally possible to use a family with different parameters + /// simultaneously. For example, we could use a `titleFamily` to read both + /// the french and english translations at the same time: + /// + /// ```dart + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// final frenchTitle = ref.watch(titleFamily(const Locale('fr'))); + /// final englishTitle = ref.watch(titleFamily(const Locale('en'))); + /// + /// return Text('fr: $frenchTitle en: $englishTitle'); + /// } + /// ``` + /// + /// # Parameter restrictions + /// + /// For families to work correctly, it is critical for the parameter passed to + /// a provider to have a consistent `hashCode` and `==`. + /// + /// Ideally the parameter should either be a primitive (bool/int/double/String), + /// a constant (providers), or an immutable object that override `==` and `hashCode`. + /// + /// + /// - **PREFER** using `family` in combination with `autoDispose` if the + /// parameter passed to providers is a complex object: + /// + /// ```dart + /// final example = Provider.autoDispose.family((ref, param) { + /// }); + /// ``` + /// + /// This ensures that there is no memory leak if the parameter changed and is + /// never used again. + /// + /// # Passing multiple parameters to a family + /// + /// Families have no built-in support for passing multiple values to a provider. + /// + /// On the other hand, that value could be _anything_ (as long as it matches with + /// the restrictions mentioned previously). + /// + /// This includes: + /// - A tuple (using `package:tuple`) + /// - Objects generated with Freezed/built_value + /// - Objects based on `package:equatable` + /// + /// This includes: + /// - A tuple (using `package:tuple`) + /// - Objects generated with Freezed/built_value, such as: + /// ```dart + /// @freezed + /// abstract class MyParameter with _$MyParameter { + /// factory MyParameter({ + /// required int userId, + /// required Locale locale, + /// }) = _MyParameter; + /// } + /// + /// final exampleProvider = Provider.family((ref, myParameter) { + /// print(myParameter.userId); + /// print(myParameter.locale); + /// // Do something with userId/locale + /// }); + /// + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// int userId; // Read the user ID from somewhere + /// final locale = Localizations.localeOf(context); + /// + /// final something = ref.watch( + /// exampleProvider(MyParameter(userId: userId, locale: locale)), + /// ); + /// } + /// ``` + /// + /// - Objects based on `package:equatable`, such as: + /// ```dart + /// class MyParameter extends Equatable { + /// factory MyParameter({ + /// required this.userId, + /// requires this.locale, + /// }); + /// + /// final int userId; + /// final Local locale; + /// + /// @override + /// List get props => [userId, locale]; + /// } + /// + /// final exampleProvider = Provider.family((ref, myParameter) { + /// print(myParameter.userId); + /// print(myParameter.locale); + /// // Do something with userId/locale + /// }); + /// + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// int userId; // Read the user ID from somewhere + /// final locale = Localizations.localeOf(context); + /// + /// final something = ref.watch( + /// exampleProvider(MyParameter(userId: userId, locale: locale)), + /// ); + /// } + /// ``` + /// {@endtemplate} + final CallT call; + + /// {@template riverpod.autoDispose} + /// Marks the provider as automatically disposed when no longer listened to. + /// + /// Some typical use-cases: + /// + /// - Combined with [StreamProvider], this can be used as a mean to keep + /// the connection with Firebase alive only when truly needed (to reduce costs). + /// - Automatically reset a form state when leaving the screen. + /// - Automatically retry HTTP requests that failed when the user exit and + /// re-enter the screen. + /// - Cancel HTTP requests if the user leaves a screen before the request completed. + /// + /// Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. + /// + /// The `keepAlive` function is used to tell Riverpod that the state of the provider + /// should be preserved even if no longer listened to. + /// + /// A use-case would be to set this flag to `true` after an HTTP request have + /// completed: + /// + /// ```dart + /// final myProvider = FutureProvider.autoDispose((ref) async { + /// final response = await httpClient.get(...); + /// ref.keepAlive(); + /// return response; + /// }); + /// ``` + /// + /// This way, if the request failed and the UI leaves the screen then re-enters + /// it, then the request will be performed again. + /// But if the request completed successfully, the state will be preserved + /// and re-entering the screen will not trigger a new request. + /// + /// It can be combined with `ref.onDispose` for more advanced behaviors, such + /// as cancelling pending HTTP requests when the user leaves a screen. + /// For example, modifying our previous snippet and using `dio`, we would have: + /// + /// ```diff + /// final myProvider = FutureProvider.autoDispose((ref) async { + /// + final cancelToken = CancelToken(); + /// + ref.onDispose(() => cancelToken.cancel()); + /// + /// + final response = await dio.get('path', cancelToken: cancelToken); + /// - final response = await dio.get('path'); + /// ref.keepAlive(); + /// return response; + /// }); + /// ``` + /// {@endtemplate} + final AutoDisposeT autoDispose; +} + +@internal +class ProviderBuilder { + const ProviderBuilder({ + required this.call, + required this.family, + }); + + /// {@macro riverpod.autoDispose} + final CallT call; + + /// {@macro riverpod.family} + final FamilyT family; +} diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index cbe491c5f..79c13750c 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -4,6 +4,110 @@ part of '../../framework.dart'; @internal typedef CancelAsyncSubscription = void Function(); +@internal +mixin AsyncClassMixin + on ClassBase, CreatedT> { + /// The value currently exposed by this [AsyncNotifier]. + /// + /// Defaults to [AsyncLoading] inside the [AsyncNotifier.build] method. + /// + /// Invoking the setter will notify listeners if [updateShouldNotify] returns true. + /// By default, this always notifies listeners (unless going from "loading" + /// to "loading", in which case the change is ignored). + /// + /// Reading [state] if the provider is out of date (such as if one of its + /// dependency has changed) will trigger [AsyncNotifier.build] to be re-executed. + @visibleForTesting + @protected + @override + AsyncValue get state; + + @visibleForTesting + @protected + @override + set state(AsyncValue newState); + + /// {@template riverpod.async_notifier.future} + /// Obtains a [Future] that resolves with the first [state] value that is not + /// [AsyncLoading]. + /// + /// This future will not necessarily wait for [AsyncNotifier.build] to complete. + /// If [state] is modified before [AsyncNotifier.build] completes, then [future] + /// will resolve with that new [state] value. + /// + /// The future will fail if [state] is in error state. In which case the + /// error will be the same as [AsyncValue.error] and its stacktrace. + /// {@endtemplate} + @visibleForTesting + @protected + Future get future { + // TODO remove downcast/upcast once "future" is merged with all providers + final Object? element = this.element; + if (element == null) throw StateError(uninitializedElementError); + + element as FutureModifierElement; + + element.flush(); + return element.futureNotifier.value; + } + + /// A function to update [state] from its previous value, while + /// abstracting loading/error cases for [state]. + /// + /// This method neither causes [state] to go back to "loading" while the + /// operation is pending. Neither does it cause [state] to go to error state + /// if the operation fails. + /// + /// If [state] was in error state, the callback will not be invoked and instead + /// the error will be returned. Alternatively, [onError] can specified to + /// gracefully handle error states. + /// + /// See also: + /// - [future], for manually awaiting the resolution of [state]. + /// - [AsyncValue.guard], and alternate way to perform asynchronous operations. + @visibleForTesting + @protected + Future update( + FutureOr Function(StateT previousState) cb, { + FutureOr Function(Object err, StackTrace stackTrace)? onError, + }) async { + // TODO cancel on rebuild? + + final newState = await future.then(cb, onError: onError); + state = AsyncData(newState); + return newState; + } + + /// A method invoked when the state exposed by this [AsyncNotifier] changes. + /// + /// As opposed to with [Notifier.updateShouldNotify], this method + /// does not filter out changes to [state] that are equal to the previous + /// value. + /// By default, any change to [state] will emit an update. + /// This method can be overridden to implement custom filtering logic if that + /// is undesired. + /// + /// The reasoning for this default behavior is that [AsyncNotifier.build] + /// returns a [Future]. As such, the value of [state] typically transitions + /// from "loading" to "data" or "error". In that scenario, the value equality + /// does not matter. Checking `==` would only hinder performances for no reason. + /// + /// See also: + /// - [ProviderBase.select] and [AsyncSelector.selectAsync], which are + /// alternative ways to filter out changes to [state]. + @override + @protected + bool updateShouldNotify( + AsyncValue previous, + AsyncValue next, + ) { + return FutureModifierElement.handleUpdateShouldNotify( + previous, + next, + ); + } +} + @internal base mixin FutureModifier on ProviderBase> { /// Obtains the [Future] representing this provider. diff --git a/packages/riverpod/lib/src/internals.dart b/packages/riverpod/lib/src/internals.dart index 554d9b564..6f3b786d6 100644 --- a/packages/riverpod/lib/src/internals.dart +++ b/packages/riverpod/lib/src/internals.dart @@ -11,11 +11,10 @@ export 'common/run_guarded.dart'; export 'common/stack_trace.dart'; export 'core/async_value.dart'; export 'framework.dart'; -export 'legacy_providers/async_notifier.dart'; -export 'legacy_providers/builders.dart'; -export 'legacy_providers/deprecated/state_notifier_provider.dart'; -export 'legacy_providers/deprecated/state_provider.dart'; -export 'legacy_providers/future_provider.dart'; -export 'legacy_providers/notifier.dart'; -export 'legacy_providers/provider.dart'; -export 'legacy_providers/stream_provider.dart'; +export 'providers/async_notifier.dart'; +export 'providers/future_provider.dart'; +export 'providers/legacy/state_notifier_provider.dart'; +export 'providers/legacy/state_provider.dart'; +export 'providers/notifier.dart'; +export 'providers/provider.dart'; +export 'providers/stream_provider.dart'; diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier.dart b/packages/riverpod/lib/src/legacy_providers/async_notifier.dart deleted file mode 100644 index 41a796ab6..000000000 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier.dart +++ /dev/null @@ -1,147 +0,0 @@ -import 'dart:async'; - -import 'package:meta/meta.dart'; - -import '../core/async_value.dart'; -import '../framework.dart'; -import 'builders.dart'; -import 'future_provider.dart' show FutureProvider; -import 'notifier.dart'; - -part 'async_notifier/orphan.dart'; -part 'async_notifier/family.dart'; - -abstract class _AsyncNotifierBase extends ClassBase< // - AsyncValue, - FutureOr> { - // TODO docs - @protected - Ref> get ref; - - /// The value currently exposed by this [AsyncNotifier]. - /// - /// Defaults to [AsyncLoading] inside the [AsyncNotifier.build] method. - /// - /// Invoking the setter will notify listeners if [updateShouldNotify] returns true. - /// By default, this always notifies listeners (unless going from "loading" - /// to "loading", in which case the change is ignored). - /// - /// Reading [state] if the provider is out of date (such as if one of its - /// dependency has changed) will trigger [AsyncNotifier.build] to be re-executed. - @visibleForTesting - @protected - @override - AsyncValue get state; - - @visibleForTesting - @protected - @override - set state(AsyncValue newState); - - /// {@template riverpod.async_notifier.future} - /// Obtains a [Future] that resolves with the first [state] value that is not - /// [AsyncLoading]. - /// - /// This future will not necessarily wait for [AsyncNotifier.build] to complete. - /// If [state] is modified before [AsyncNotifier.build] completes, then [future] - /// will resolve with that new [state] value. - /// - /// The future will fail if [state] is in error state. In which case the - /// error will be the same as [AsyncValue.error] and its stacktrace. - /// {@endtemplate} - @visibleForTesting - @protected - Future get future { - // TODO remove downcast/upcast once "future" is merged with all providers - final Object? element = this.element; - if (element == null) throw StateError(uninitializedElementError); - - element as FutureModifierElement; - - element.flush(); - return element.futureNotifier.value; - } - - /// A function to update [state] from its previous value, while - /// abstracting loading/error cases for [state]. - /// - /// This method neither causes [state] to go back to "loading" while the - /// operation is pending. Neither does it cause [state] to go to error state - /// if the operation fails. - /// - /// If [state] was in error state, the callback will not be invoked and instead - /// the error will be returned. Alternatively, [onError] can specified to - /// gracefully handle error states. - /// - /// See also: - /// - [future], for manually awaiting the resolution of [state]. - /// - [AsyncValue.guard], and alternate way to perform asynchronous operations. - @visibleForTesting - @protected - Future update( - FutureOr Function(StateT previousState) cb, { - FutureOr Function(Object err, StackTrace stackTrace)? onError, - }) async { - // TODO cancel on rebuild? - - final newState = await future.then(cb, onError: onError); - state = AsyncData(newState); - return newState; - } - - /// A method invoked when the state exposed by this [AsyncNotifier] changes. - /// - /// As opposed to with [Notifier.updateShouldNotify], this method - /// does not filter out changes to [state] that are equal to the previous - /// value. - /// By default, any change to [state] will emit an update. - /// This method can be overridden to implement custom filtering logic if that - /// is undesired. - /// - /// The reasoning for this default behavior is that [AsyncNotifier.build] - /// returns a [Future]. As such, the value of [state] typically transitions - /// from "loading" to "data" or "error". In that scenario, the value equality - /// does not matter. Checking `==` would only hinder performances for no reason. - /// - /// See also: - /// - [ProviderBase.select] and [AsyncSelector.selectAsync], which are - /// alternative ways to filter out changes to [state]. - @protected - bool updateShouldNotify( - AsyncValue previous, - AsyncValue next, - ) { - return FutureModifierElement.handleUpdateShouldNotify( - previous, - next, - ); - } -} - -abstract base class _AsyncNotifierProviderBase< // - NotifierT extends _AsyncNotifierBase, - StateT> // - extends ClassProvider< // - NotifierT, - AsyncValue, - FutureOr, - Ref>> // - with - FutureModifier { - const _AsyncNotifierProviderBase( - this._createNotifier, { - required super.name, - required super.from, - required super.argument, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.isAutoDispose, - required super.runNotifierBuildOverride, - }); - - final NotifierT Function() _createNotifier; - - @override - NotifierT create() => _createNotifier(); -} diff --git a/packages/riverpod/lib/src/legacy_providers/builders.dart b/packages/riverpod/lib/src/legacy_providers/builders.dart deleted file mode 100644 index 6a14190c4..000000000 --- a/packages/riverpod/lib/src/legacy_providers/builders.dart +++ /dev/null @@ -1,1074 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND -// -// If you need to modify this file, instead update /tools/generate_providers/bin/generate_providers.dart -// -// You can install this utility by executing: -// dart pub global activate -s path /tools/generate_providers -// -// You can then use it in your terminal by executing: -// generate_providers - -import 'dart:async'; -import 'package:state_notifier/state_notifier.dart'; - -import '../internals.dart'; - -/// Builds a [AsyncNotifierProvider]. -class AsyncNotifierProviderBuilder { - /// Builds a [AsyncNotifierProvider]. - const AsyncNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - AsyncNotifierProvider - call, T>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AsyncNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeAsyncNotifierProviderBuilder get autoDispose { - return const AutoDisposeAsyncNotifierProviderBuilder(); - } - - /// {@macro riverpod.family} - AsyncNotifierProviderFamilyBuilder get family { - return const AsyncNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AsyncNotifierProviderFamily]. -class AsyncNotifierProviderFamilyBuilder { - /// Builds a [AsyncNotifierProviderFamily]. - const AsyncNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - AsyncNotifierProviderFamily - call, T, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AsyncNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeAsyncNotifierProviderFamilyBuilder get autoDispose { - return const AutoDisposeAsyncNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeAsyncNotifierProvider]. -class AutoDisposeAsyncNotifierProviderBuilder { - /// Builds a [AutoDisposeAsyncNotifierProvider]. - const AutoDisposeAsyncNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - AutoDisposeAsyncNotifierProvider - call, T>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeAsyncNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.family} - AutoDisposeAsyncNotifierProviderFamilyBuilder get family { - return const AutoDisposeAsyncNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeAsyncNotifierProviderFamily]. -class AutoDisposeAsyncNotifierProviderFamilyBuilder { - /// Builds a [AutoDisposeAsyncNotifierProviderFamily]. - const AutoDisposeAsyncNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - AutoDisposeAsyncNotifierProviderFamily - call, T, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeAsyncNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } -} - -/// Builds a [NotifierProvider]. -class NotifierProviderBuilder { - /// Builds a [NotifierProvider]. - const NotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - NotifierProvider - call, State>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return NotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeNotifierProviderBuilder get autoDispose { - return const AutoDisposeNotifierProviderBuilder(); - } - - /// {@macro riverpod.family} - NotifierProviderFamilyBuilder get family { - return const NotifierProviderFamilyBuilder(); - } -} - -/// Builds a [NotifierProviderFamily]. -class NotifierProviderFamilyBuilder { - /// Builds a [NotifierProviderFamily]. - const NotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - NotifierProviderFamily - call, State, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return NotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeNotifierProviderFamilyBuilder get autoDispose { - return const AutoDisposeNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeNotifierProvider]. -class AutoDisposeNotifierProviderBuilder { - /// Builds a [AutoDisposeNotifierProvider]. - const AutoDisposeNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - AutoDisposeNotifierProvider - call, State>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.family} - AutoDisposeNotifierProviderFamilyBuilder get family { - return const AutoDisposeNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeNotifierProviderFamily]. -class AutoDisposeNotifierProviderFamilyBuilder { - /// Builds a [AutoDisposeNotifierProviderFamily]. - const AutoDisposeNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - AutoDisposeNotifierProviderFamily - call, State, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } -} - -/// Builds a [StreamNotifierProvider]. -class StreamNotifierProviderBuilder { - /// Builds a [StreamNotifierProvider]. - const StreamNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - StreamNotifierProvider - call, T>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return StreamNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeStreamNotifierProviderBuilder get autoDispose { - return const AutoDisposeStreamNotifierProviderBuilder(); - } - - /// {@macro riverpod.family} - StreamNotifierProviderFamilyBuilder get family { - return const StreamNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [StreamNotifierProviderFamily]. -class StreamNotifierProviderFamilyBuilder { - /// Builds a [StreamNotifierProviderFamily]. - const StreamNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - StreamNotifierProviderFamily - call, T, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return StreamNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeStreamNotifierProviderFamilyBuilder get autoDispose { - return const AutoDisposeStreamNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeStreamNotifierProvider]. -class AutoDisposeStreamNotifierProviderBuilder { - /// Builds a [AutoDisposeStreamNotifierProvider]. - const AutoDisposeStreamNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - AutoDisposeStreamNotifierProvider - call, T>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeStreamNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.family} - AutoDisposeStreamNotifierProviderFamilyBuilder get family { - return const AutoDisposeStreamNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeStreamNotifierProviderFamily]. -class AutoDisposeStreamNotifierProviderFamilyBuilder { - /// Builds a [AutoDisposeStreamNotifierProviderFamily]. - const AutoDisposeStreamNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - AutoDisposeStreamNotifierProviderFamily - call, T, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeStreamNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } -} - -/// Builds a [StateProvider]. -class StateProviderBuilder { - /// Builds a [StateProvider]. - const StateProviderBuilder(); - - /// {@template riverpod.autoDispose} - /// Marks the provider as automatically disposed when no longer listened to. - /// - /// Some typical use-cases: - /// - /// - Combined with [StreamProvider], this can be used as a mean to keep - /// the connection with Firebase alive only when truly needed (to reduce costs). - /// - Automatically reset a form state when leaving the screen. - /// - Automatically retry HTTP requests that failed when the user exit and - /// re-enter the screen. - /// - Cancel HTTP requests if the user leaves a screen before the request completed. - /// - /// Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. - /// - /// The `keepAlive` function is used to tell Riverpod that the state of the provider - /// should be preserved even if no longer listened to. - /// - /// A use-case would be to set this flag to `true` after an HTTP request have - /// completed: - /// - /// ```dart - /// final myProvider = FutureProvider.autoDispose((ref) async { - /// final response = await httpClient.get(...); - /// ref.keepAlive(); - /// return response; - /// }); - /// ``` - /// - /// This way, if the request failed and the UI leaves the screen then re-enters - /// it, then the request will be performed again. - /// But if the request completed successfully, the state will be preserved - /// and re-entering the screen will not trigger a new request. - /// - /// It can be combined with `ref.onDispose` for more advanced behaviors, such - /// as cancelling pending HTTP requests when the user leaves a screen. - /// For example, modifying our previous snippet and using `dio`, we would have: - /// - /// ```diff - /// final myProvider = FutureProvider.autoDispose((ref) async { - /// + final cancelToken = CancelToken(); - /// + ref.onDispose(() => cancelToken.cancel()); - /// - /// + final response = await dio.get('path', cancelToken: cancelToken); - /// - final response = await dio.get('path'); - /// ref.keepAlive(); - /// return response; - /// }); - /// ``` - /// {@endtemplate} - StateProvider call( - Create> create, { - String? name, - Iterable? dependencies, - }) { - return StateProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeStateProviderBuilder get autoDispose { - return const AutoDisposeStateProviderBuilder(); - } - - /// {@template riverpod.family} - /// A group of providers that builds their value from an external parameter. - /// - /// Families can be useful to connect a provider with values that it doesn't - /// have access to. For example: - /// - /// - Allowing a "title provider" access the `Locale` - /// - /// ```dart - /// final titleFamily = Provider.family((ref, locale) { - /// if (locale == const Locale('en')) { - /// return 'English title'; - /// } else if (locale == const Locale('fr')) { - /// return 'Titre Français'; - /// } - /// }); - /// - /// // ... - /// - /// @override - /// Widget build(BuildContext context, WidgetRef ref) { - /// final locale = Localizations.localeOf(context); - /// - /// // Obtains the title based on the current Locale. - /// // Will automatically update the title when the Locale changes. - /// final title = ref.watch(titleFamily(locale)); - /// - /// return Text(title); - /// } - /// ``` - /// - /// - Have a "user provider" that receives the user ID as a parameter - /// - /// ```dart - /// final userFamily = FutureProvider.family((ref, userId) async { - /// final userRepository = ref.read(userRepositoryProvider); - /// return await userRepository.fetch(userId); - /// }); - /// - /// // ... - /// - /// @override - /// Widget build(BuildContext context, WidgetRef ref) { - /// int userId; // Read the user ID from somewhere - /// - /// // Read and potentially fetch the user with id `userId`. - /// // When `userId` changes, this will automatically update the UI - /// // Similarly, if two widgets tries to read `userFamily` with the same `userId` - /// // then the user will be fetched only once. - /// final user = ref.watch(userFamily(userId)); - /// - /// return user.when( - /// data: (user) => Text(user.name), - /// loading: () => const CircularProgressIndicator(), - /// error: (err, stack) => const Text('error'), - /// ); - /// } - /// ``` - /// - /// - Connect a provider with another provider without having a direct reference on it. - /// - /// ```dart - /// final repositoryProvider = Provider.family>((ref, configurationsProvider) { - /// // Read a provider without knowing what that provider is. - /// final configurations = await ref.read(configurationsProvider.future); - /// return Repository(host: configurations.host); - /// }); - /// ``` - /// - /// ## Usage - /// - /// The way families works is by adding an extra parameter to the provider. - /// This parameter can then be freely used in our provider to create some state. - /// - /// For example, we could combine `family` with [FutureProvider] to fetch - /// a `Message` from its ID: - /// - /// ```dart - /// final messagesFamily = FutureProvider.family((ref, id) async { - /// return dio.get('http://my_api.dev/messages/$id'); - /// }); - /// ``` - /// - /// Then, when using our `messagesFamily` provider, the syntax is slightly modified. - /// The usual: - /// - /// ```dart - /// Widget build(BuildContext context, WidgetRef ref) { - /// // Error – messagesFamily is not a provider - /// final response = ref.watch(messagesFamily); - /// } - /// ``` - /// - /// will not work anymore. - /// Instead, we need to pass a parameter to `messagesFamily`: - /// - /// ```dart - /// Widget build(BuildContext context, WidgetRef ref) { - /// final response = ref.watch(messagesFamily('id')); - /// } - /// ``` - /// - /// **NOTE**: It is totally possible to use a family with different parameters - /// simultaneously. For example, we could use a `titleFamily` to read both - /// the french and english translations at the same time: - /// - /// ```dart - /// @override - /// Widget build(BuildContext context, WidgetRef ref) { - /// final frenchTitle = ref.watch(titleFamily(const Locale('fr'))); - /// final englishTitle = ref.watch(titleFamily(const Locale('en'))); - /// - /// return Text('fr: $frenchTitle en: $englishTitle'); - /// } - /// ``` - /// - /// # Parameter restrictions - /// - /// For families to work correctly, it is critical for the parameter passed to - /// a provider to have a consistent `hashCode` and `==`. - /// - /// Ideally the parameter should either be a primitive (bool/int/double/String), - /// a constant (providers), or an immutable object that override `==` and `hashCode`. - /// - /// - /// - **PREFER** using `family` in combination with `autoDispose` if the - /// parameter passed to providers is a complex object: - /// - /// ```dart - /// final example = Provider.autoDispose.family((ref, param) { - /// }); - /// ``` - /// - /// This ensures that there is no memory leak if the parameter changed and is - /// never used again. - /// - /// # Passing multiple parameters to a family - /// - /// Families have no built-in support for passing multiple values to a provider. - /// - /// On the other hand, that value could be _anything_ (as long as it matches with - /// the restrictions mentioned previously). - /// - /// This includes: - /// - A tuple (using `package:tuple`) - /// - Objects generated with Freezed/built_value - /// - Objects based on `package:equatable` - /// - /// This includes: - /// - A tuple (using `package:tuple`) - /// - Objects generated with Freezed/built_value, such as: - /// ```dart - /// @freezed - /// abstract class MyParameter with _$MyParameter { - /// factory MyParameter({ - /// required int userId, - /// required Locale locale, - /// }) = _MyParameter; - /// } - /// - /// final exampleProvider = Provider.family((ref, myParameter) { - /// print(myParameter.userId); - /// print(myParameter.locale); - /// // Do something with userId/locale - /// }); - /// - /// @override - /// Widget build(BuildContext context, WidgetRef ref) { - /// int userId; // Read the user ID from somewhere - /// final locale = Localizations.localeOf(context); - /// - /// final something = ref.watch( - /// exampleProvider(MyParameter(userId: userId, locale: locale)), - /// ); - /// } - /// ``` - /// - /// - Objects based on `package:equatable`, such as: - /// ```dart - /// class MyParameter extends Equatable { - /// factory MyParameter({ - /// required this.userId, - /// requires this.locale, - /// }); - /// - /// final int userId; - /// final Local locale; - /// - /// @override - /// List get props => [userId, locale]; - /// } - /// - /// final exampleProvider = Provider.family((ref, myParameter) { - /// print(myParameter.userId); - /// print(myParameter.locale); - /// // Do something with userId/locale - /// }); - /// - /// @override - /// Widget build(BuildContext context, WidgetRef ref) { - /// int userId; // Read the user ID from somewhere - /// final locale = Localizations.localeOf(context); - /// - /// final something = ref.watch( - /// exampleProvider(MyParameter(userId: userId, locale: locale)), - /// ); - /// } - /// ``` - /// {@endtemplate} - StateProviderFamilyBuilder get family { - return const StateProviderFamilyBuilder(); - } -} - -/// Builds a [StateProviderFamily]. -class StateProviderFamilyBuilder { - /// Builds a [StateProviderFamily]. - const StateProviderFamilyBuilder(); - - /// {@macro riverpod.family} - StateProviderFamily call( - FamilyCreate, Arg> create, { - String? name, - Iterable? dependencies, - }) { - return StateProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeStateProviderFamilyBuilder get autoDispose { - return const AutoDisposeStateProviderFamilyBuilder(); - } -} - -/// Builds a [StateNotifierProvider]. -class StateNotifierProviderBuilder { - /// Builds a [StateNotifierProvider]. - const StateNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - StateNotifierProvider - call, State>( - Create> create, { - String? name, - Iterable? dependencies, - }) { - return StateNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeStateNotifierProviderBuilder get autoDispose { - return const AutoDisposeStateNotifierProviderBuilder(); - } - - /// {@macro riverpod.family} - StateNotifierProviderFamilyBuilder get family { - return const StateNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [StateNotifierProviderFamily]. -class StateNotifierProviderFamilyBuilder { - /// Builds a [StateNotifierProviderFamily]. - const StateNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - StateNotifierProviderFamily - call, State, Arg>( - FamilyCreate, Arg> - create, { - String? name, - Iterable? dependencies, - }) { - return StateNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeStateNotifierProviderFamilyBuilder get autoDispose { - return const AutoDisposeStateNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [Provider]. -class ProviderBuilder { - /// Builds a [Provider]. - const ProviderBuilder(); - - /// {@macro riverpod.autoDispose} - Provider call( - Create> create, { - String? name, - Iterable? dependencies, - }) { - return Provider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeProviderBuilder get autoDispose { - return const AutoDisposeProviderBuilder(); - } - - /// {@macro riverpod.family} - ProviderFamilyBuilder get family { - return const ProviderFamilyBuilder(); - } -} - -/// Builds a [ProviderFamily]. -class ProviderFamilyBuilder { - /// Builds a [ProviderFamily]. - const ProviderFamilyBuilder(); - - /// {@macro riverpod.family} - ProviderFamily call( - FamilyCreate, Arg> create, { - String? name, - Iterable? dependencies, - }) { - return ProviderFamily.internal( - create, - name: name, - dependencies: dependencies, - isAutoDispose: false, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeProviderFamilyBuilder get autoDispose { - return const AutoDisposeProviderFamilyBuilder(); - } -} - -/// Builds a [FutureProvider]. -class FutureProviderBuilder { - /// Builds a [FutureProvider]. - const FutureProviderBuilder(); - - /// {@macro riverpod.autoDispose} - FutureProvider call( - Create, FutureProviderRef> create, { - String? name, - Iterable? dependencies, - }) { - return FutureProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeFutureProviderBuilder get autoDispose { - return const AutoDisposeFutureProviderBuilder(); - } - - /// {@macro riverpod.family} - FutureProviderFamilyBuilder get family { - return const FutureProviderFamilyBuilder(); - } -} - -/// Builds a [FutureProviderFamily]. -class FutureProviderFamilyBuilder { - /// Builds a [FutureProviderFamily]. - const FutureProviderFamilyBuilder(); - - /// {@macro riverpod.family} - FutureProviderFamily call( - FamilyCreate, FutureProviderRef, Arg> create, { - String? name, - Iterable? dependencies, - }) { - return FutureProviderFamily.internal( - create, - name: name, - dependencies: dependencies, - allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, - isAutoDispose: false, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeFutureProviderFamilyBuilder get autoDispose { - return const AutoDisposeFutureProviderFamilyBuilder(); - } -} - -/// Builds a [StreamProvider]. -class StreamProviderBuilder { - /// Builds a [StreamProvider]. - const StreamProviderBuilder(); - - /// {@macro riverpod.autoDispose} - StreamProvider call( - Create, Ref>> create, { - String? name, - Iterable? dependencies, - }) { - return StreamProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeStreamProviderBuilder get autoDispose { - return const AutoDisposeStreamProviderBuilder(); - } - - /// {@macro riverpod.family} - StreamProviderFamilyBuilder get family { - return const StreamProviderFamilyBuilder(); - } -} - -/// Builds a [StreamProviderFamily]. -class StreamProviderFamilyBuilder { - /// Builds a [StreamProviderFamily]. - const StreamProviderFamilyBuilder(); - - /// {@macro riverpod.family} - StreamProviderFamily call( - FamilyCreate, Ref>, Arg> create, { - String? name, - Iterable? dependencies, - }) { - return StreamProviderFamily.internal( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeStreamProviderFamilyBuilder get autoDispose { - return const AutoDisposeStreamProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeStateProvider]. -class AutoDisposeStateProviderBuilder { - /// Builds a [AutoDisposeStateProvider]. - const AutoDisposeStateProviderBuilder(); - - /// {@macro riverpod.autoDispose} - AutoDisposeStateProvider call( - Create> create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeStateProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.family} - AutoDisposeStateProviderFamilyBuilder get family { - return const AutoDisposeStateProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeStateProviderFamily]. -class AutoDisposeStateProviderFamilyBuilder { - /// Builds a [AutoDisposeStateProviderFamily]. - const AutoDisposeStateProviderFamilyBuilder(); - - /// {@macro riverpod.family} - AutoDisposeStateProviderFamily call( - FamilyCreate, Arg> create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeStateProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } -} - -/// Builds a [AutoDisposeStateNotifierProvider]. -class AutoDisposeStateNotifierProviderBuilder { - /// Builds a [AutoDisposeStateNotifierProvider]. - const AutoDisposeStateNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - AutoDisposeStateNotifierProvider - call, State>( - Create> - create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeStateNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.family} - AutoDisposeStateNotifierProviderFamilyBuilder get family { - return const AutoDisposeStateNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeStateNotifierProviderFamily]. -class AutoDisposeStateNotifierProviderFamilyBuilder { - /// Builds a [AutoDisposeStateNotifierProviderFamily]. - const AutoDisposeStateNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - AutoDisposeStateNotifierProviderFamily - call, State, Arg>( - FamilyCreate, - Arg> - create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeStateNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } -} - -/// Builds a [AutoDisposeProvider]. -class AutoDisposeProviderBuilder { - /// Builds a [AutoDisposeProvider]. - const AutoDisposeProviderBuilder(); - - /// {@macro riverpod.autoDispose} - Provider call( - Create> create, { - String? name, - Iterable? dependencies, - }) { - return Provider.internal( - create, - name: name, - dependencies: dependencies, - isAutoDispose: true, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - from: null, - argument: null, - ); - } - - /// {@macro riverpod.family} - AutoDisposeProviderFamilyBuilder get family { - return const AutoDisposeProviderFamilyBuilder(); - } -} - -/// Builds an auto-dispose [ProviderFamily]. -class AutoDisposeProviderFamilyBuilder { - /// Builds an auto-dispose [ProviderFamily]. - const AutoDisposeProviderFamilyBuilder(); - - /// {@macro riverpod.family} - ProviderFamily call( - FamilyCreate, Arg> create, { - String? name, - Iterable? dependencies, - }) { - return ProviderFamily.internal( - create, - name: name, - isAutoDispose: true, - dependencies: dependencies, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - } -} - -/// Builds a [AutoDisposeFutureProvider]. -class AutoDisposeFutureProviderBuilder { - /// Builds a [AutoDisposeFutureProvider]. - const AutoDisposeFutureProviderBuilder(); - - /// {@macro riverpod.autoDispose} - AutoDisposeFutureProvider call( - Create, AutoDisposeFutureProviderRef> create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeFutureProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.family} - AutoDisposeFutureProviderFamilyBuilder get family { - return const AutoDisposeFutureProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeFutureProviderFamily]. -class AutoDisposeFutureProviderFamilyBuilder { - /// Builds a [AutoDisposeFutureProviderFamily]. - const AutoDisposeFutureProviderFamilyBuilder(); - - /// {@macro riverpod.family} - AutoDisposeFutureProviderFamily call( - FamilyCreate, AutoDisposeFutureProviderRef, Arg> - create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeFutureProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } -} - -/// Builds a [AutoDisposeStreamProvider]. -class AutoDisposeStreamProviderBuilder { - /// Builds a [AutoDisposeStreamProvider]. - const AutoDisposeStreamProviderBuilder(); - - /// {@macro riverpod.autoDispose} - AutoDisposeStreamProvider call( - Create, AutoDisposeStreamProviderRef> create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeStreamProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.family} - AutoDisposeStreamProviderFamilyBuilder get family { - return const AutoDisposeStreamProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeStreamProviderFamily]. -class AutoDisposeStreamProviderFamilyBuilder { - /// Builds a [AutoDisposeStreamProviderFamily]. - const AutoDisposeStreamProviderFamilyBuilder(); - - /// {@macro riverpod.family} - AutoDisposeStreamProviderFamily call( - FamilyCreate, AutoDisposeStreamProviderRef, Arg> - create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeStreamProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } -} diff --git a/packages/riverpod/lib/src/legacy_providers/stream_notifier.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier.dart deleted file mode 100644 index e78dfa656..000000000 --- a/packages/riverpod/lib/src/legacy_providers/stream_notifier.dart +++ /dev/null @@ -1,87 +0,0 @@ -part of 'async_notifier.dart'; - -abstract base class _StreamNotifierProviderBase< - NotifierT extends _AsyncNotifierBase, // - StateT> // - extends ClassProvider< // - NotifierT, - AsyncValue, - Stream, - Ref>> // - with - FutureModifier { - const _StreamNotifierProviderBase( - this._createNotifier, { - required super.name, - required super.from, - required super.argument, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.isAutoDispose, - }); - - final NotifierT Function() _createNotifier; -} - -/// {@template riverpod.streamNotifier} -/// A variant of [AsyncNotifier] which has [build] creating a [Stream]. -/// -/// This can be considered as a [StreamProvider] that can mutate its value over time. -/// -/// The syntax for using this provider is slightly different from the others -/// in that the provider's function doesn't receive a "ref" (and in case -/// of `family`, doesn't receive an argument either). -/// Instead the ref (and argument) are directly accessible in the associated -/// [AsyncNotifier]. -/// -/// This can be considered as a [StreamProvider] that can mutate its value over time. -/// When using `family`, your notifier type changes. Instead of extending -/// [StreamNotifier], you should extend [FamilyStreamNotifier]. -/// {@endtemplate} -abstract class StreamNotifier extends _AsyncNotifierBase { - @override - Ref> get ref { - final element = _element; - if (element == null) throw StateError(uninitializedElementError); - - return element; - } - - /// {@macro riverpod.async_notifier.build} - @visibleForOverriding - Stream build(); -} - -// TODO hide all Elements and CreateElements from public API -class _StreamNotifierProviderElement< // - NotifierT extends _AsyncNotifierBase, - StateT> // - extends ProviderElementBase> - with - ClassProviderElement>, - FutureModifierElement { - _StreamNotifierProviderElement(this.provider, super.container); - - @override - final _StreamNotifierProviderBase provider; - - @override - void create({required bool didChangeDependency}) { - final notifierResult = classListenable.result ??= Result.guard(() { - return provider._createNotifier().._setElement(this); - }); - - notifierResult.when( - error: (error, stackTrace) { - onError(AsyncError(error, stackTrace), seamless: !didChangeDependency); - }, - data: (notifier) { - handleStream( - () => provider.runNotifierBuild(this, notifier), - didChangeDependency: didChangeDependency, - ); - }, - ); - } -} diff --git a/packages/riverpod/lib/src/legacy_providers/stream_notifier/family.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/family.dart deleted file mode 100644 index ed921604e..000000000 --- a/packages/riverpod/lib/src/legacy_providers/stream_notifier/family.dart +++ /dev/null @@ -1,150 +0,0 @@ -part of '../async_notifier.dart'; - -/// {@macro riverpod.streamNotifier} -abstract class FamilyStreamNotifier - extends _AsyncNotifierBase { - /// {@template riverpod.notifier.family_arg} - /// The argument that was passed to this family. - /// - /// For example, when doing: - /// - /// ```dart - /// ref.watch(provider(0)); - /// ``` - /// - /// then [arg] will be `0`. - /// {@endtemplate} - late final Arg arg; - - /// {@macro riverpod.StreamNotifier.build} - @visibleForOverriding - Stream build(Arg arg); -} - -final class FamilyStreamNotifierProvider< - NotifierT extends FamilyStreamNotifier, - StateT, - ArgT> extends _StreamNotifierProviderBase { - @internal - const FamilyStreamNotifierProvider.internal( - super._createNotifier, { - required super.name, - required super.from, - required super.argument, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.isAutoDispose, - required RunNotifierBuild, - Ref>>? - runNotifierBuild, - }) : _runNotifierBuildOverride = runNotifierBuild; - - /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeStreamNotifierProviderFamily.new; - - final RunNotifierBuild, Ref>>? - _runNotifierBuildOverride; - - FamilyStreamNotifierProvider _copyWith({ - NotifierT Function()? create, - RunNotifierBuild, Ref>>? build, - }) { - return FamilyStreamNotifierProvider.internal( - create ?? _createNotifier, - name: name, - from: from, - argument: argument, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - isAutoDispose: isAutoDispose, - runNotifierBuild: build ?? _runNotifierBuildOverride, - ); - } - - @override - _StreamNotifierProviderElement createElement( - ProviderContainer container, - ) { - return _StreamNotifierProviderElement(this, container); - } - - @internal - @override - ClassProvider< // - NotifierT, - AsyncValue, - Stream, - Ref>> copyWithBuild( - RunNotifierBuild, Ref>> build, - ) { - return _copyWith(build: build); - } - - @internal - @override - ClassProvider< // - NotifierT, - AsyncValue, - Stream, - Ref>> copyWithCreate(NotifierT Function() create) { - return _copyWith(create: create); - } - - @internal - @override - Stream runNotifierBuild( - Ref> ref, - NotifierT notifier, - ) { - return notifier.build(argument as ArgT); - } -} - -/// The [Family] of [StreamNotifierProvider]. -class StreamNotifierProviderFamily< // - NotifierT extends FamilyStreamNotifier, - StateT, - Arg> // - extends ClassFamily< // - NotifierT, - AsyncValue, - Ref>, - Arg, - Stream, - _StreamNotifierProviderBase> { - @internal - StreamNotifierProviderFamily.internal( - super._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.isAutoDispose, - }) : super( - providerFactory: ( - create, { - required name, - required dependencies, - required allTransitiveDependencies, - required debugGetCreateSourceHash, - required isAutoDispose, - required from, - required argument, - }) { - return FamilyStreamNotifierProvider.internal( - create, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - isAutoDispose: isAutoDispose, - from: from, - argument: argument, - runNotifierBuild: null, - ); - }, - ); -} diff --git a/packages/riverpod/lib/src/legacy_providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/legacy_providers/stream_notifier/orphan.dart deleted file mode 100644 index b97b178ee..000000000 --- a/packages/riverpod/lib/src/legacy_providers/stream_notifier/orphan.dart +++ /dev/null @@ -1,101 +0,0 @@ -part of '../async_notifier.dart'; - -/// {@macro riverpod.streamNotifier} -final class StreamNotifierProvider< - NotifierT extends StreamNotifier, // - StateT> // - extends _StreamNotifierProviderBase { - /// {@macro riverpod.streamNotifier} - StreamNotifierProvider( - super._createNotifier, { - super.name, - super.dependencies, - }) : _runNotifierBuildOverride = null, - super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - isAutoDispose: false, - ); - - @internal - const StreamNotifierProvider.internal( - super._createNotifier, { - required super.name, - required super.from, - required super.argument, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.isAutoDispose, - RunNotifierBuild, Ref>>? - runNotifierBuildOverride, - }) : _runNotifierBuildOverride = runNotifierBuildOverride; - - /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeStreamNotifierProviderBuilder(); - - /// {@macro riverpod.family} - static const family = StreamNotifierProviderFamilyBuilder(); - - final RunNotifierBuild, Ref>>? - _runNotifierBuildOverride; - - StreamNotifierProvider _copyWith({ - NotifierT Function()? create, - RunNotifierBuild, Ref>>? build, - }) { - return StreamNotifierProvider.internal( - create ?? _createNotifier, - name: name, - from: from, - argument: argument, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - isAutoDispose: isAutoDispose, - runNotifierBuildOverride: build ?? _runNotifierBuildOverride, - ); - } - - @internal - @override - _StreamNotifierProviderElement createElement( - ProviderContainer container, - ) { - return _StreamNotifierProviderElement(this, container); - } - - @internal - @override - Stream runNotifierBuild( - Ref> ref, - NotifierT notifier, - ) { - return notifier.build(); - } - - @internal - @override - ClassProvider< // - NotifierT, - AsyncValue, - Stream, - Ref>> copyWithBuild( - RunNotifierBuild, Ref>> build, - ) { - return _copyWith(build: build); - } - - @internal - @override - ClassProvider< // - NotifierT, - AsyncValue, - Stream, - Ref>> copyWithCreate(NotifierT Function() create) { - return _copyWith(create: create); - } -} diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart new file mode 100644 index 000000000..ae7dd5a3b --- /dev/null +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -0,0 +1,46 @@ +import 'dart:async'; + +import 'package:meta/meta.dart'; + +import '../core/async_value.dart'; +import '../core/builder.dart'; +import '../framework.dart'; +import 'future_provider.dart' show FutureProvider; +import 'notifier.dart'; + +part 'async_notifier/orphan.dart'; +part 'async_notifier/family.dart'; + +abstract class _AsyncNotifierBase extends ClassBase< // + AsyncValue, + FutureOr> // + with + AsyncClassMixin> {} + +abstract base class _AsyncNotifierProviderBase< // + NotifierT extends _AsyncNotifierBase, + StateT> // + extends ClassProvider< // + NotifierT, + AsyncValue, + FutureOr, + Ref>> // + with + FutureModifier { + const _AsyncNotifierProviderBase( + this._createNotifier, { + required super.name, + required super.from, + required super.argument, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.isAutoDispose, + required super.runNotifierBuildOverride, + }); + + final NotifierT Function() _createNotifier; + + @override + NotifierT create() => _createNotifier(); +} diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart similarity index 89% rename from packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart rename to packages/riverpod/lib/src/providers/async_notifier/family.dart index 82b399004..3168d8d95 100644 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -98,7 +98,7 @@ class AsyncNotifierProviderFamily< // FutureOr, FamilyAsyncNotifierProvider> { /// The [Family] of [AsyncNotifierProvider]. - AsyncNotifierProviderFamily( + AsyncNotifierProviderFamily._( super._createFn, { super.name, super.dependencies, @@ -110,6 +110,18 @@ class AsyncNotifierProviderFamily< // computeAllTransitiveDependencies(dependencies), ); + AsyncNotifierProviderFamily._autoDispose( + super._createFn, { + super.name, + super.dependencies, + }) : super( + providerFactory: FamilyAsyncNotifierProvider._, + debugGetCreateSourceHash: null, + isAutoDispose: true, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + ); + /// The [Family] of [AsyncNotifierProvider]. @internal AsyncNotifierProviderFamily.internal( diff --git a/packages/riverpod/lib/src/legacy_providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart similarity index 88% rename from packages/riverpod/lib/src/legacy_providers/async_notifier/orphan.dart rename to packages/riverpod/lib/src/providers/async_notifier/orphan.dart index 33a6748cb..d98974499 100644 --- a/packages/riverpod/lib/src/legacy_providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -64,7 +64,6 @@ final class AsyncNotifierProvider< // super._createNotifier, { super.name, super.dependencies, - super.runNotifierBuildOverride, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), @@ -72,6 +71,21 @@ final class AsyncNotifierProvider< // argument: null, debugGetCreateSourceHash: null, isAutoDispose: false, + runNotifierBuildOverride: null, + ); + + AsyncNotifierProvider._autoDispose( + super._createNotifier, { + super.name, + super.dependencies, + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, + isAutoDispose: true, + runNotifierBuildOverride: null, ); /// An implementation detail of Riverpod @@ -89,10 +103,16 @@ final class AsyncNotifierProvider< // }); /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeAsyncNotifierProviderBuilder(); + static const autoDispose = ProviderBuilder( + call: AsyncNotifierProvider._autoDispose, + family: AsyncNotifierProviderFamily._, + ); /// {@macro riverpod.family} - static const family = AsyncNotifierProviderFamilyBuilder(); + static const family = FamilyBuilder( + call: AsyncNotifierProviderFamily._, + autoDispose: AsyncNotifierProviderFamily._autoDispose, + ); AsyncNotifierProvider _copyWith({ NotifierT Function()? create, diff --git a/packages/riverpod/lib/src/legacy_providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart similarity index 81% rename from packages/riverpod/lib/src/legacy_providers/future_provider.dart rename to packages/riverpod/lib/src/providers/future_provider.dart index c7187b1dd..19f27b6bf 100644 --- a/packages/riverpod/lib/src/legacy_providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -3,9 +3,9 @@ import 'dart:async'; import 'package:meta/meta.dart'; import '../core/async_value.dart'; +import '../core/builder.dart'; import '../framework.dart'; import 'async_notifier.dart'; -import 'builders.dart'; import 'provider.dart' show Provider; import 'stream_provider.dart' show StreamProvider; @@ -86,14 +86,26 @@ final class FutureProvider extends FunctionalProvider< this._create, { super.name, super.dependencies, + super.isAutoDispose = false, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), from: null, argument: null, debugGetCreateSourceHash: null, - // TODO add autoDispose parameter - isAutoDispose: false, + ); + + FutureProvider._autoDispose( + this._create, { + super.name, + super.dependencies, + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + isAutoDispose: true, + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod @@ -110,10 +122,16 @@ final class FutureProvider extends FunctionalProvider< }); /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeFutureProviderBuilder(); + static const autoDispose = ProviderBuilder( + call: FutureProvider._autoDispose, + family: FutureProviderFamily._, + ); /// {@macro riverpod.family} - static const family = FutureProviderFamilyBuilder(); + static const family = FamilyBuilder( + call: FutureProviderFamily._, + autoDispose: FutureProviderFamily._autoDispose, + ); /// TODO make all "create" public, for the sake of dartdocs. final Create, FutureProviderRef> _create; @@ -179,6 +197,30 @@ class FutureProviderElement extends ProviderElementBase> /// The [Family] of a [FutureProvider] class FutureProviderFamily extends FunctionalFamily< FutureProviderRef, AsyncValue, Arg, FutureOr, FutureProvider> { + FutureProviderFamily._( + super._createFn, { + super.name, + super.dependencies, + super.isAutoDispose = false, + }) : super( + providerFactory: FutureProvider.internal, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + debugGetCreateSourceHash: null, + ); + + FutureProviderFamily._autoDispose( + super._createFn, { + super.name, + super.dependencies, + }) : super( + providerFactory: FutureProvider.internal, + isAutoDispose: true, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + debugGetCreateSourceHash: null, + ); + /// Implementation detail of the code-generator. @internal FutureProviderFamily.internal( diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_controller.dart b/packages/riverpod/lib/src/providers/legacy/state_controller.dart similarity index 100% rename from packages/riverpod/lib/src/legacy_providers/deprecated/state_controller.dart rename to packages/riverpod/lib/src/providers/legacy/state_controller.dart diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart similarity index 100% rename from packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider.dart rename to packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/auto_dispose.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider/auto_dispose.dart similarity index 100% rename from packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/auto_dispose.dart rename to packages/riverpod/lib/src/providers/legacy/state_notifier_provider/auto_dispose.dart diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider/base.dart similarity index 100% rename from packages/riverpod/lib/src/legacy_providers/deprecated/state_notifier_provider/base.dart rename to packages/riverpod/lib/src/providers/legacy/state_notifier_provider/base.dart diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart similarity index 100% rename from packages/riverpod/lib/src/legacy_providers/deprecated/state_provider.dart rename to packages/riverpod/lib/src/providers/legacy/state_provider.dart diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/auto_dispose.dart b/packages/riverpod/lib/src/providers/legacy/state_provider/auto_dispose.dart similarity index 100% rename from packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/auto_dispose.dart rename to packages/riverpod/lib/src/providers/legacy/state_provider/auto_dispose.dart diff --git a/packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart b/packages/riverpod/lib/src/providers/legacy/state_provider/base.dart similarity index 100% rename from packages/riverpod/lib/src/legacy_providers/deprecated/state_provider/base.dart rename to packages/riverpod/lib/src/providers/legacy/state_provider/base.dart diff --git a/packages/riverpod/lib/src/legacy_providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart similarity index 99% rename from packages/riverpod/lib/src/legacy_providers/notifier.dart rename to packages/riverpod/lib/src/providers/notifier.dart index d8150439a..bcf138604 100644 --- a/packages/riverpod/lib/src/legacy_providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -4,7 +4,6 @@ import '../common/listenable.dart'; import '../common/result.dart'; import '../framework.dart'; import 'async_notifier.dart'; -import 'builders.dart'; import 'provider.dart'; part 'notifier/auto_dispose.dart'; diff --git a/packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose.dart b/packages/riverpod/lib/src/providers/notifier/auto_dispose.dart similarity index 100% rename from packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose.dart rename to packages/riverpod/lib/src/providers/notifier/auto_dispose.dart diff --git a/packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/providers/notifier/auto_dispose_family.dart similarity index 100% rename from packages/riverpod/lib/src/legacy_providers/notifier/auto_dispose_family.dart rename to packages/riverpod/lib/src/providers/notifier/auto_dispose_family.dart diff --git a/packages/riverpod/lib/src/legacy_providers/notifier/base.dart b/packages/riverpod/lib/src/providers/notifier/base.dart similarity index 100% rename from packages/riverpod/lib/src/legacy_providers/notifier/base.dart rename to packages/riverpod/lib/src/providers/notifier/base.dart diff --git a/packages/riverpod/lib/src/legacy_providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart similarity index 100% rename from packages/riverpod/lib/src/legacy_providers/notifier/family.dart rename to packages/riverpod/lib/src/providers/notifier/family.dart diff --git a/packages/riverpod/lib/src/legacy_providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart similarity index 89% rename from packages/riverpod/lib/src/legacy_providers/provider.dart rename to packages/riverpod/lib/src/providers/provider.dart index 3f1e9ea2a..decb957c9 100644 --- a/packages/riverpod/lib/src/legacy_providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -1,8 +1,8 @@ import 'package:meta/meta.dart'; +import '../core/builder.dart'; import '../framework.dart'; -import 'builders.dart'; -import 'deprecated/state_notifier_provider.dart' show StateNotifierProvider; +import 'legacy/state_notifier_provider.dart' show StateNotifierProvider; import 'stream_provider.dart' show StreamProvider; // TODO changelog ProviderRef was removed. Used Ref directly @@ -15,14 +15,26 @@ final class Provider this._create, { super.name, super.dependencies, - // TODO make "autoDispose" an optional arg on the constructor + super.isAutoDispose = false, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), from: null, argument: null, debugGetCreateSourceHash: null, - isAutoDispose: false, + ); + + Provider._autoDispose( + this._create, { + super.name, + super.dependencies, + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + isAutoDispose: true, + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod @@ -38,11 +50,17 @@ final class Provider required super.isAutoDispose, }); - /// {@macro riverpod.family} - static const family = ProviderFamilyBuilder(); - /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeProviderBuilder(); + static const autoDispose = ProviderBuilder( + call: Provider._autoDispose, + family: ProviderFamily._, + ); + + /// {@macro riverpod.family} + static const family = FamilyBuilder( + call: ProviderFamily._, + autoDispose: ProviderFamily._autoDispose, + ); final Create> _create; @@ -346,6 +364,30 @@ class ProviderElement extends ProviderElementBase { // TODO remove custom family types class ProviderFamily extends FunctionalFamily, R, Arg, R, Provider> { + ProviderFamily._( + super._createFn, { + super.name, + super.dependencies, + super.isAutoDispose = false, + }) : super( + providerFactory: Provider.internal, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + debugGetCreateSourceHash: null, + ); + + ProviderFamily._autoDispose( + super._createFn, { + super.name, + super.dependencies, + }) : super( + providerFactory: Provider.internal, + isAutoDispose: true, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + debugGetCreateSourceHash: null, + ); + /// An implementation detail of Riverpod @internal ProviderFamily.internal( diff --git a/packages/riverpod/lib/src/providers/stream_notifier.dart b/packages/riverpod/lib/src/providers/stream_notifier.dart new file mode 100644 index 000000000..0bdde1d98 --- /dev/null +++ b/packages/riverpod/lib/src/providers/stream_notifier.dart @@ -0,0 +1,45 @@ +import 'dart:async'; + +import 'package:meta/meta.dart'; + +import '../core/async_value.dart'; +import '../core/builder.dart'; +import '../framework.dart'; +import 'future_provider.dart' show FutureProvider; + +part 'stream_notifier/orphan.dart'; +part 'stream_notifier/family.dart'; + +abstract class _StreamNotifierBase extends ClassBase< // + AsyncValue, + Stream> // + with + AsyncClassMixin> {} + +abstract base class _StreamNotifierProviderBase< + NotifierT extends _StreamNotifierBase, // + StateT> // + extends ClassProvider< // + NotifierT, + AsyncValue, + Stream, + Ref>> // + with + FutureModifier { + const _StreamNotifierProviderBase( + this._createNotifier, { + required super.name, + required super.from, + required super.argument, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.isAutoDispose, + required super.runNotifierBuildOverride, + }); + + final NotifierT Function() _createNotifier; + + @override + NotifierT create() => _createNotifier(); +} diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart new file mode 100644 index 000000000..9ccf8162a --- /dev/null +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -0,0 +1,134 @@ +part of '../stream_notifier.dart'; + +/// {@macro riverpod.async_notifier} +/// +/// {@macro riverpod.async_notifier_provider_modifier} +abstract class FamilyStreamNotifier + extends _StreamNotifierBase { + /// {@template riverpod.notifier.family_arg} + /// The argument that was passed to this family. + /// + /// For example, when doing: + /// + /// ```dart + /// ref.watch(provider(0)); + /// ``` + /// + /// then [arg] will be `0`. + /// {@endtemplate} + late final Arg arg; + + /// {@macro riverpod.async_notifier.build} + @visibleForOverriding + Stream build(Arg arg); +} + +final class FamilyStreamNotifierProvider< // + NotifierT extends FamilyStreamNotifier, + StateT, + ArgT> // + extends _StreamNotifierProviderBase { + /// An implementation detail of Riverpod + const FamilyStreamNotifierProvider._( + super._createNotifier, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required super.argument, + required super.isAutoDispose, + required super.runNotifierBuildOverride, + }); + + @override + _StreamNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _StreamNotifierProviderElement(this, container); + } + + FamilyStreamNotifierProvider _copyWith({ + NotifierT Function()? create, + RunNotifierBuild< // + NotifierT, + Stream, + Ref>>? + build, + }) { + return FamilyStreamNotifierProvider._( + create ?? _createNotifier, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + isAutoDispose: isAutoDispose, + runNotifierBuildOverride: build ?? runNotifierBuildOverride, + from: from, + argument: argument, + ); + } + + @override + FamilyStreamNotifierProvider copyWithBuild( + RunNotifierBuild, Ref>> build, + ) { + return _copyWith(build: build); + } + + @override + FamilyStreamNotifierProvider copyWithCreate( + NotifierT Function() create, + ) { + return _copyWith(create: create); + } +} + +/// The [Family] of [StreamNotifierProvider]. +class StreamNotifierProviderFamily< // + NotifierT extends FamilyStreamNotifier, + StateT, + ArgT> // + extends ClassFamily< // + NotifierT, + AsyncValue, + Ref>, + ArgT, + Stream, + FamilyStreamNotifierProvider> { + /// The [Family] of [StreamNotifierProvider]. + StreamNotifierProviderFamily._( + super._createFn, { + super.name, + super.dependencies, + super.isAutoDispose = false, + }) : super( + providerFactory: FamilyStreamNotifierProvider._, + debugGetCreateSourceHash: null, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + ); + + StreamNotifierProviderFamily._autoDispose( + super._createFn, { + super.name, + super.dependencies, + }) : super( + providerFactory: FamilyStreamNotifierProvider._, + isAutoDispose: true, + debugGetCreateSourceHash: null, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + ); + + /// The [Family] of [StreamNotifierProvider]. + @internal + StreamNotifierProviderFamily.internal( + super._createFn, { + super.name, + super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.isAutoDispose, + }) : super(providerFactory: FamilyStreamNotifierProvider._); +} diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart new file mode 100644 index 000000000..feb25d40f --- /dev/null +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -0,0 +1,179 @@ +part of '../stream_notifier.dart'; + +/// {@template riverpod.streamNotifier} +/// A variant of [AsyncNotifier] which has [build] creating a [Stream]. +/// +/// This can be considered as a [StreamProvider] that can mutate its value over time. +/// +/// The syntax for using this provider is slightly different from the others +/// in that the provider's function doesn't receive a "ref" (and in case +/// of `family`, doesn't receive an argument either). +/// Instead the ref (and argument) are directly accessible in the associated +/// [AsyncNotifier]. +/// +/// This can be considered as a [StreamProvider] that can mutate its value over time. +/// When using `family`, your notifier type changes. Instead of extending +/// [StreamNotifier], you should extend [FamilyStreamNotifier]. +/// {@endtemplate} +abstract class StreamNotifier extends _StreamNotifierBase { + /// {@macro riverpod.async_notifier.build} + @visibleForOverriding + Stream build(); +} + +/// {@template riverpod.async_notifier_provider} +/// A provider which creates and listen to an [StreamNotifier]. +/// +/// This is similar to [FutureProvider] but allows to perform side-effects. +/// +/// The syntax for using this provider is slightly different from the others +/// in that the provider's function doesn't receive a "ref" (and in case +/// of `family`, doesn't receive an argument either). +/// Instead the ref (and argument) are directly accessible in the associated +/// [StreamNotifier]. +/// {@endtemplate} +/// +/// {@template riverpod.async_notifier_provider_modifier} +/// When using `autoDispose` or `family`, your notifier type changes. +/// Instead of extending [StreamNotifier], you should extend either: +/// - [AutoDisposeAsyncNotifier] for `autoDispose` +/// - [FamilyAsyncNotifier] for `family` +/// - [AutoDisposeFamilyAsyncNotifier] for `autoDispose.family` +/// {@endtemplate} +final class StreamNotifierProvider< // + NotifierT extends StreamNotifier, + StateT> // + extends _StreamNotifierProviderBase { + /// {@macro riverpod.async_notifier_provider} + /// + /// {@macro riverpod.async_notifier_provider_modifier} + StreamNotifierProvider( + super._createNotifier, { + super.name, + super.dependencies, + super.runNotifierBuildOverride, + super.isAutoDispose = false, + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, + ); + + StreamNotifierProvider._autoDispose( + super._createNotifier, { + super.name, + super.dependencies, + super.runNotifierBuildOverride, + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, + isAutoDispose: true, + ); + + /// An implementation detail of Riverpod + @internal + const StreamNotifierProvider.internal( + super._createNotifier, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required super.argument, + required super.isAutoDispose, + required super.runNotifierBuildOverride, + }); + + /// {@macro riverpod.autoDispose} + static const autoDispose = ProviderBuilder( + call: StreamNotifierProvider._autoDispose, + family: StreamNotifierProviderFamily._, + ); + + /// {@macro riverpod.family} + static const family = FamilyBuilder( + call: StreamNotifierProviderFamily._, + autoDispose: StreamNotifierProviderFamily._autoDispose, + ); + + StreamNotifierProvider _copyWith({ + NotifierT Function()? create, + RunNotifierBuild, Ref>>? build, + }) { + return StreamNotifierProvider.internal( + create ?? _createNotifier, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + argument: argument, + isAutoDispose: isAutoDispose, + runNotifierBuildOverride: build ?? runNotifierBuildOverride, + ); + } + + @internal + @override + _StreamNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _StreamNotifierProviderElement(this, container); + } + + @internal + @override + StreamNotifierProvider copyWithBuild( + RunNotifierBuild, Ref>>? build, + ) { + return _copyWith(build: build); + } + + @internal + @override + StreamNotifierProvider copyWithCreate( + NotifierT Function() create, + ) { + return _copyWith(create: create); + } +} + +class _StreamNotifierProviderElement< // + NotifierT extends _StreamNotifierBase, + StateT> // + extends ClassProviderElement< // + NotifierT, + AsyncValue, + Stream> // + with + FutureModifierElement { + _StreamNotifierProviderElement(this.provider, super.container); + + @override + final _StreamNotifierProviderBase provider; + + @override + void handleError( + Object error, + StackTrace stackTrace, { + required bool didChangeDependency, + }) { + onError(AsyncError(error, stackTrace), seamless: !didChangeDependency); + } + + @override + void handleValue( + Stream created, { + required bool didChangeDependency, + }) { + handleStream( + () => created, + didChangeDependency: didChangeDependency, + ); + } +} diff --git a/packages/riverpod/lib/src/legacy_providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart similarity index 82% rename from packages/riverpod/lib/src/legacy_providers/stream_provider.dart rename to packages/riverpod/lib/src/providers/stream_provider.dart index 2772616c6..a5e200a4e 100644 --- a/packages/riverpod/lib/src/legacy_providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -5,8 +5,8 @@ import 'package:meta/meta.dart'; import '../common/listenable.dart'; import '../common/result.dart'; import '../core/async_value.dart'; +import '../core/builder.dart'; import '../framework.dart'; -import 'builders.dart'; import 'future_provider.dart' show FutureProvider; import 'provider.dart' show Provider; @@ -74,14 +74,26 @@ final class StreamProvider this._create, { super.name, super.dependencies, + super.isAutoDispose = false, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), from: null, argument: null, debugGetCreateSourceHash: null, - // TODO add autoDispose param - isAutoDispose: false, + ); + + StreamProvider._autoDispose( + this._create, { + super.name, + super.dependencies, + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + isAutoDispose: true, + from: null, + argument: null, + debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod @@ -98,10 +110,16 @@ final class StreamProvider }); /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeStreamProviderBuilder(); + static const autoDispose = ProviderBuilder( + call: StreamProvider._autoDispose, + family: StreamProviderFamily._, + ); /// {@macro riverpod.family} - static const family = StreamProviderFamilyBuilder(); + static const family = FamilyBuilder( + call: StreamProviderFamily._, + autoDispose: StreamProviderFamily._autoDispose, + ); final Create, Ref>> _create; @@ -198,6 +216,18 @@ class StreamProviderElement extends ProviderElementBase> /// The [Family] of a [StreamProvider] class StreamProviderFamily extends FunctionalFamily>, AsyncValue, Arg, Stream, StreamProvider> { + StreamProviderFamily._( + super._createFn, { + super.name, + super.dependencies, + super.isAutoDispose = false, + }) : super( + providerFactory: StreamProvider.internal, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + debugGetCreateSourceHash: null, + ); + /// Implementation detail of the code-generator. @internal StreamProviderFamily.internal( @@ -208,4 +238,16 @@ class StreamProviderFamily extends FunctionalFamily>, required super.debugGetCreateSourceHash, required super.isAutoDispose, }) : super(providerFactory: StreamProvider.internal); + + StreamProviderFamily._autoDispose( + super._createFn, { + super.name, + super.dependencies, + }) : super( + providerFactory: StreamProvider.internal, + isAutoDispose: true, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + debugGetCreateSourceHash: null, + ); } diff --git a/packages/riverpod/test/new/core/overrides_test.dart b/packages/riverpod/test/new/core/overrides_test.dart index f985e34a0..097b7e65f 100644 --- a/packages/riverpod/test/new/core/overrides_test.dart +++ b/packages/riverpod/test/new/core/overrides_test.dart @@ -74,10 +74,13 @@ void main() { group('FamilyOverride', () { test('TransitiveOverride.toString', () { + final f = Provider.family; + final provider = Provider.family((_, b) => 42); + final provider2 = f.call((_, b) => 42); expect( - TransitiveFamilyOverride(provider).toString(), + TransitiveFamilyOverride(provider2).toString(), equalsIgnoringHashCodes('ProviderFamily#00000'), ); }); diff --git a/packages/riverpod/test/new/core/provider_test.dart b/packages/riverpod/test/new/core/provider_test.dart index 2590cd38c..975e1e168 100644 --- a/packages/riverpod/test/new/core/provider_test.dart +++ b/packages/riverpod/test/new/core/provider_test.dart @@ -5,6 +5,10 @@ void main() { group('ProviderBase', () { // TODO assert all providers have an "internal" const constructor // TODO assert all non-internal constructors set allTransitiveDependencies + // TODO assert all constructors have isAutoDispose optional parameter + // TODO assert all default constructors set isAutoDispose=false by default + // TODO assert all .autoDispose constructors set isAutoDispose=true + // TODO assert all families have a default constructor test('allTransitiveDependencies', () { final a = Provider((ref) => 0); diff --git a/tools/generate_providers/bin/generate_providers.dart b/tools/generate_providers/bin/generate_providers.dart deleted file mode 100644 index b53a13007..000000000 --- a/tools/generate_providers/bin/generate_providers.dart +++ /dev/null @@ -1,886 +0,0 @@ -// ignore_for_file: avoid_print -import 'dart:io'; - -import 'package:dart_style/dart_style.dart'; -import 'package:trotter/trotter.dart'; -import 'package:tuple/tuple.dart'; - -enum DisposeType { - none, - autoDispose, -} - -const disposeLabel = { - DisposeType.none: '', - DisposeType.autoDispose: 'AutoDispose', -}; - -class StateDetails { - StateDetails({ - required this.className, - required this.ref, - required this.constraints, - required this.generics, - required this.createType, - }); - - final String className; - final String ref; - final String constraints; - final String generics; - final String createType; -} - -enum ProviderType { - single, - family, -} - -const providerLabel = { - ProviderType.single: '', - ProviderType.family: 'Family', -}; - -const _autoDisposeDoc = ''' -/// {@template riverpod.autoDispose} -/// Marks the provider as automatically disposed when no longer listened to. -/// -/// Some typical use-cases: -/// -/// - Combined with [StreamProvider], this can be used as a mean to keep -/// the connection with Firebase alive only when truly needed (to reduce costs). -/// - Automatically reset a form state when leaving the screen. -/// - Automatically retry HTTP requests that failed when the user exit and -/// re-enter the screen. -/// - Cancel HTTP requests if the user leaves a screen before the request completed. -/// -/// Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. -/// -/// The `keepAlive` function is used to tell Riverpod that the state of the provider -/// should be preserved even if no longer listened to. -/// -/// A use-case would be to set this flag to `true` after an HTTP request have -/// completed: -/// -/// ```dart -/// final myProvider = FutureProvider.autoDispose((ref) async { -/// final response = await httpClient.get(...); -/// ref.keepAlive(); -/// return response; -/// }); -/// ``` -/// -/// This way, if the request failed and the UI leaves the screen then re-enters -/// it, then the request will be performed again. -/// But if the request completed successfully, the state will be preserved -/// and re-entering the screen will not trigger a new request. -/// -/// It can be combined with `ref.onDispose` for more advanced behaviors, such -/// as cancelling pending HTTP requests when the user leaves a screen. -/// For example, modifying our previous snippet and using `dio`, we would have: -/// -/// ```diff -/// final myProvider = FutureProvider.autoDispose((ref) async { -/// + final cancelToken = CancelToken(); -/// + ref.onDispose(() => cancelToken.cancel()); -/// -/// + final response = await dio.get('path', cancelToken: cancelToken); -/// - final response = await dio.get('path'); -/// ref.keepAlive(); -/// return response; -/// }); -/// ``` -/// {@endtemplate}'''; - -bool _didAddAutoDisposeTemplate = false; - -String autoDisposeDoc() { - if (_didAddAutoDisposeTemplate) { - return '/// {@macro riverpod.autoDispose}'; - } - _didAddAutoDisposeTemplate = true; - return _autoDisposeDoc; -} - -const _familyDoc = r''' -/// {@template riverpod.family} -/// A group of providers that builds their value from an external parameter. -/// -/// Families can be useful to connect a provider with values that it doesn't -/// have access to. For example: -/// -/// - Allowing a "title provider" access the `Locale` -/// -/// ```dart -/// final titleFamily = Provider.family((ref, locale) { -/// if (locale == const Locale('en')) { -/// return 'English title'; -/// } else if (locale == const Locale('fr')) { -/// return 'Titre Français'; -/// } -/// }); -/// -/// // ... -/// -/// @override -/// Widget build(BuildContext context, WidgetRef ref) { -/// final locale = Localizations.localeOf(context); -/// -/// // Obtains the title based on the current Locale. -/// // Will automatically update the title when the Locale changes. -/// final title = ref.watch(titleFamily(locale)); -/// -/// return Text(title); -/// } -/// ``` -/// -/// - Have a "user provider" that receives the user ID as a parameter -/// -/// ```dart -/// final userFamily = FutureProvider.family((ref, userId) async { -/// final userRepository = ref.read(userRepositoryProvider); -/// return await userRepository.fetch(userId); -/// }); -/// -/// // ... -/// -/// @override -/// Widget build(BuildContext context, WidgetRef ref) { -/// int userId; // Read the user ID from somewhere -/// -/// // Read and potentially fetch the user with id `userId`. -/// // When `userId` changes, this will automatically update the UI -/// // Similarly, if two widgets tries to read `userFamily` with the same `userId` -/// // then the user will be fetched only once. -/// final user = ref.watch(userFamily(userId)); -/// -/// return user.when( -/// data: (user) => Text(user.name), -/// loading: () => const CircularProgressIndicator(), -/// error: (err, stack) => const Text('error'), -/// ); -/// } -/// ``` -/// -/// - Connect a provider with another provider without having a direct reference on it. -/// -/// ```dart -/// final repositoryProvider = Provider.family>((ref, configurationsProvider) { -/// // Read a provider without knowing what that provider is. -/// final configurations = await ref.read(configurationsProvider.future); -/// return Repository(host: configurations.host); -/// }); -/// ``` -/// -/// ## Usage -/// -/// The way families works is by adding an extra parameter to the provider. -/// This parameter can then be freely used in our provider to create some state. -/// -/// For example, we could combine `family` with [FutureProvider] to fetch -/// a `Message` from its ID: -/// -/// ```dart -/// final messagesFamily = FutureProvider.family((ref, id) async { -/// return dio.get('http://my_api.dev/messages/$id'); -/// }); -/// ``` -/// -/// Then, when using our `messagesFamily` provider, the syntax is slightly modified. -/// The usual: -/// -/// ```dart -/// Widget build(BuildContext context, WidgetRef ref) { -/// // Error – messagesFamily is not a provider -/// final response = ref.watch(messagesFamily); -/// } -/// ``` -/// -/// will not work anymore. -/// Instead, we need to pass a parameter to `messagesFamily`: -/// -/// ```dart -/// Widget build(BuildContext context, WidgetRef ref) { -/// final response = ref.watch(messagesFamily('id')); -/// } -/// ``` -/// -/// **NOTE**: It is totally possible to use a family with different parameters -/// simultaneously. For example, we could use a `titleFamily` to read both -/// the french and english translations at the same time: -/// -/// ```dart -/// @override -/// Widget build(BuildContext context, WidgetRef ref) { -/// final frenchTitle = ref.watch(titleFamily(const Locale('fr'))); -/// final englishTitle = ref.watch(titleFamily(const Locale('en'))); -/// -/// return Text('fr: $frenchTitle en: $englishTitle'); -/// } -/// ``` -/// -/// # Parameter restrictions -/// -/// For families to work correctly, it is critical for the parameter passed to -/// a provider to have a consistent `hashCode` and `==`. -/// -/// Ideally the parameter should either be a primitive (bool/int/double/String), -/// a constant (providers), or an immutable object that override `==` and `hashCode`. -/// -/// -/// - **PREFER** using `family` in combination with `autoDispose` if the -/// parameter passed to providers is a complex object: -/// -/// ```dart -/// final example = Provider.autoDispose.family((ref, param) { -/// }); -/// ``` -/// -/// This ensures that there is no memory leak if the parameter changed and is -/// never used again. -/// -/// # Passing multiple parameters to a family -/// -/// Families have no built-in support for passing multiple values to a provider. -/// -/// On the other hand, that value could be _anything_ (as long as it matches with -/// the restrictions mentioned previously). -/// -/// This includes: -/// - A tuple (using `package:tuple`) -/// - Objects generated with Freezed/built_value -/// - Objects based on `package:equatable` -/// -/// This includes: -/// - A tuple (using `package:tuple`) -/// - Objects generated with Freezed/built_value, such as: -/// ```dart -/// @freezed -/// abstract class MyParameter with _$MyParameter { -/// factory MyParameter({ -/// required int userId, -/// required Locale locale, -/// }) = _MyParameter; -/// } -/// -/// final exampleProvider = Provider.family((ref, myParameter) { -/// print(myParameter.userId); -/// print(myParameter.locale); -/// // Do something with userId/locale -/// }); -/// -/// @override -/// Widget build(BuildContext context, WidgetRef ref) { -/// int userId; // Read the user ID from somewhere -/// final locale = Localizations.localeOf(context); -/// -/// final something = ref.watch( -/// exampleProvider(MyParameter(userId: userId, locale: locale)), -/// ); -/// } -/// ``` -/// -/// - Objects based on `package:equatable`, such as: -/// ```dart -/// class MyParameter extends Equatable { -/// factory MyParameter({ -/// required this.userId, -/// requires this.locale, -/// }); -/// -/// final int userId; -/// final Local locale; -/// -/// @override -/// List get props => [userId, locale]; -/// } -/// -/// final exampleProvider = Provider.family((ref, myParameter) { -/// print(myParameter.userId); -/// print(myParameter.locale); -/// // Do something with userId/locale -/// }); -/// -/// @override -/// Widget build(BuildContext context, WidgetRef ref) { -/// int userId; // Read the user ID from somewhere -/// final locale = Localizations.localeOf(context); -/// -/// final something = ref.watch( -/// exampleProvider(MyParameter(userId: userId, locale: locale)), -/// ); -/// } -/// ``` -/// {@endtemplate}'''; - -bool _didAddFamilyTemplate = false; - -String familyDoc() { - if (_didAddFamilyTemplate) { - return '/// {@macro riverpod.family}'; - } - _didAddFamilyTemplate = true; - return _familyDoc; -} - -Future main(List args) async { - if (args.length != 2) { - print('usage: generate_providers file'); - return; - } - if (args.first != 'riverpod' && args.first != 'flutter_riverpod') { - print('Unknown argument ${args.first}'); - return; - } - - final file = File.fromUri(Uri.parse(args[1])); - if (file.existsSync() && file.statSync().type != FileSystemEntityType.file) { - print('${args[1]} is not a file'); - return; - } - - Tuple3, List, List> matrix; - - final builder = StringBuffer( - ''' -// GENERATED CODE - DO NOT MODIFY BY HAND -// -// If you need to modify this file, instead update /tools/generate_providers/bin/generate_providers.dart -// -// You can install this utility by executing: -// dart pub global activate -s path /tools/generate_providers -// -// You can then use it in your terminal by executing: -// generate_providers - -''', - ); - - switch (args.first) { - case 'riverpod': - matrix = Tuple3( - DisposeType.values, - [ - StateDetails( - className: 'StateProvider', - ref: 'StateProviderRef', - constraints: 'State', - generics: 'State', - createType: 'State', - ), - StateDetails( - className: 'StateNotifierProvider', - ref: 'StateNotifierProviderRef', - constraints: 'Notifier extends StateNotifier, State', - generics: 'Notifier, State', - createType: 'Notifier', - ), - StateDetails( - className: 'Provider', - ref: 'Ref', - constraints: 'StateT', - generics: 'StateT', - createType: 'StateT', - ), - StateDetails( - className: 'FutureProvider', - ref: 'FutureProviderRef', - constraints: 'StateT', - generics: 'StateT', - createType: 'FutureOr', - ), - StateDetails( - className: 'StreamProvider', - ref: 'Ref', - constraints: 'StateT', - generics: 'StateT', - createType: 'Stream', - ), - ], - ProviderType.values, - ); - builder.writeln( - """ -import 'dart:async'; -import 'package:state_notifier/state_notifier.dart'; - -import 'internals.dart'; - -/// Builds a [AsyncNotifierProvider]. -class AsyncNotifierProviderBuilder { - /// Builds a [AsyncNotifierProvider]. - const AsyncNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - AsyncNotifierProvider - call, T>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AsyncNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeAsyncNotifierProviderBuilder get autoDispose { - return const AutoDisposeAsyncNotifierProviderBuilder(); - } - - /// {@macro riverpod.family} - AsyncNotifierProviderFamilyBuilder get family { - return const AsyncNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AsyncNotifierProviderFamily]. -class AsyncNotifierProviderFamilyBuilder { - /// Builds a [AsyncNotifierProviderFamily]. - const AsyncNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - AsyncNotifierProviderFamily - call, T, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AsyncNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeAsyncNotifierProviderFamilyBuilder get autoDispose { - return const AutoDisposeAsyncNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeAsyncNotifierProvider]. -class AutoDisposeAsyncNotifierProviderBuilder { - /// Builds a [AutoDisposeAsyncNotifierProvider]. - const AutoDisposeAsyncNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - AutoDisposeAsyncNotifierProvider - call, T>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeAsyncNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.family} - AutoDisposeAsyncNotifierProviderFamilyBuilder get family { - return const AutoDisposeAsyncNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeAsyncNotifierProviderFamily]. -class AutoDisposeAsyncNotifierProviderFamilyBuilder { - /// Builds a [AutoDisposeAsyncNotifierProviderFamily]. - const AutoDisposeAsyncNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - AutoDisposeAsyncNotifierProviderFamily - call, T, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeAsyncNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } -} - -/// Builds a [NotifierProvider]. -class NotifierProviderBuilder { - /// Builds a [NotifierProvider]. - const NotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - NotifierProvider - call, State>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return NotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeNotifierProviderBuilder get autoDispose { - return const AutoDisposeNotifierProviderBuilder(); - } - - /// {@macro riverpod.family} - NotifierProviderFamilyBuilder get family { - return const NotifierProviderFamilyBuilder(); - } -} - -/// Builds a [NotifierProviderFamily]. -class NotifierProviderFamilyBuilder { - /// Builds a [NotifierProviderFamily]. - const NotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - NotifierProviderFamily - call, State, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return NotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeNotifierProviderFamilyBuilder get autoDispose { - return const AutoDisposeNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeNotifierProvider]. -class AutoDisposeNotifierProviderBuilder { - /// Builds a [AutoDisposeNotifierProvider]. - const AutoDisposeNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - AutoDisposeNotifierProvider - call, State>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.family} - AutoDisposeNotifierProviderFamilyBuilder get family { - return const AutoDisposeNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeNotifierProviderFamily]. -class AutoDisposeNotifierProviderFamilyBuilder { - /// Builds a [AutoDisposeNotifierProviderFamily]. - const AutoDisposeNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - AutoDisposeNotifierProviderFamily - call, State, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } -} - -/// Builds a [StreamNotifierProvider]. -class StreamNotifierProviderBuilder { - /// Builds a [StreamNotifierProvider]. - const StreamNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - StreamNotifierProvider - call, T>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return StreamNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeStreamNotifierProviderBuilder get autoDispose { - return const AutoDisposeStreamNotifierProviderBuilder(); - } - - /// {@macro riverpod.family} - StreamNotifierProviderFamilyBuilder get family { - return const StreamNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [StreamNotifierProviderFamily]. -class StreamNotifierProviderFamilyBuilder { - /// Builds a [StreamNotifierProviderFamily]. - const StreamNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - StreamNotifierProviderFamily - call, T, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return StreamNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeStreamNotifierProviderFamilyBuilder get autoDispose { - return const AutoDisposeStreamNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeStreamNotifierProvider]. -class AutoDisposeStreamNotifierProviderBuilder { - /// Builds a [AutoDisposeStreamNotifierProvider]. - const AutoDisposeStreamNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - AutoDisposeStreamNotifierProvider - call, T>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeStreamNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.family} - AutoDisposeStreamNotifierProviderFamilyBuilder get family { - return const AutoDisposeStreamNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [AutoDisposeStreamNotifierProviderFamily]. -class AutoDisposeStreamNotifierProviderFamilyBuilder { - /// Builds a [AutoDisposeStreamNotifierProviderFamily]. - const AutoDisposeStreamNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - AutoDisposeStreamNotifierProviderFamily - call, T, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeStreamNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } -} -""", - ); - case 'flutter_riverpod': - matrix = Tuple3( - DisposeType.values, - [ - StateDetails( - className: 'ChangeNotifierProvider', - ref: 'ChangeNotifierProviderRef', - constraints: 'Notifier extends ChangeNotifier?', - generics: 'Notifier', - createType: 'Notifier', - ), - ], - ProviderType.values, - ); - builder.writeln( - """ -import 'package:flutter/foundation.dart'; -import 'internals.dart'; -""", - ); - default: - throw UnsupportedError('Unknown package ${args.first}'); - } - - builder.writeAll(generateAll(matrix), '\n'); - - await file.writeAsString( - DartFormatter().format(builder.toString()), - ); -} - -Iterable generateAll( - Tuple3, List, List> matrix, -) sync* { - final combos = Combinations(3, [ - ...matrix.item1, - ...matrix.item2, - ...matrix.item3, - ]); - for (final permutation in combos()) { - final first = permutation.first; - final second = permutation[1]; - final third = permutation[2]; - - if (first is DisposeType && - second is StateDetails && - third is ProviderType) { - yield* generate(Tuple3(first, second, third), matrix); - } - } -} - -extension on Tuple3 { - String get providerName { - return '${disposeLabel[item1]}${item2.className}${providerLabel[item3]}'; - } - - String get ref { - switch (item1) { - case DisposeType.autoDispose: - return 'AutoDispose${item2.ref}'; - case DisposeType.none: - default: - return item2.ref; - } - } - - String get constraint => item2.constraints; - - String get createType => item2.createType; - - String links( - Tuple3, List, List> matrix, - ) { - Iterable other() sync* { - if (item1 == DisposeType.none) { - yield ''' - -${autoDisposeDoc().replaceAll('///', ' ///')} - AutoDispose${providerName}Builder get autoDispose { - return const AutoDispose${providerName}Builder(); - }'''; - } - - if (item3 == ProviderType.single) { - yield ''' - -${familyDoc().replaceAll('///', ' ///')} - ${providerName}FamilyBuilder get family { - return const ${providerName}FamilyBuilder(); - }'''; - } - } - - return other().join('\n'); - } -} - -Iterable generate( - Tuple3 configs, - Tuple3, List, List> matrix, -) sync* { - if (configs.item3 == ProviderType.family) { - yield FamilyBuilder(configs, matrix); - } else { - yield ProviderBuilder(configs, matrix); - } -} - -class FamilyBuilder { - FamilyBuilder(this.configs, this.matrix); - final Tuple3 configs; - final Tuple3, List, List> - matrix; - - @override - String toString() { - final createNamedParams = [ - 'String? name', - 'Iterable? dependencies', - ].map((e) => '$e,').join(); - final providerParams = [ - 'create', - 'name: name', - 'dependencies: dependencies', - ].map((e) => '$e,').join(); - return ''' -/// Builds a [${configs.providerName}]. -class ${configs.providerName}Builder { - /// Builds a [${configs.providerName}]. - const ${configs.providerName}Builder(); - -${familyDoc().replaceAll('///', ' ///')} - ${configs.providerName}<${configs.item2.generics}, Arg> call<${configs.constraint}, Arg>( - FamilyCreate<${configs.createType}, ${configs.ref}, Arg> create, { $createNamedParams }) { - return ${configs.providerName}<${configs.item2.generics}, Arg>($providerParams); - } -${configs.links(matrix)} -} -'''; - } -} - -class ProviderBuilder { - ProviderBuilder(this.configs, this.matrix); - final Tuple3 configs; - final Tuple3, List, List> - matrix; - - @override - String toString() { - final callNamedParams = [ - 'String? name', - 'Iterable? dependencies', - ].map((e) => '$e,').join(); - final providerParams = [ - 'create', - 'name: name', - 'dependencies: dependencies', - ].map((e) => '$e,').join(); - - return ''' -/// Builds a [${configs.providerName}]. -class ${configs.providerName}Builder { - /// Builds a [${configs.providerName}]. - const ${configs.providerName}Builder(); - -${autoDisposeDoc().replaceAll('///', ' ///')} - ${configs.providerName}<${configs.item2.generics}> call<${configs.constraint}>( - Create<${configs.createType}, ${configs.ref}> create, { $callNamedParams }) { - return ${configs.providerName}<${configs.item2.generics}>($providerParams); - } -${configs.links(matrix)} -} -'''; - } -} diff --git a/tools/generate_providers/pubspec.yaml b/tools/generate_providers/pubspec.yaml deleted file mode 100644 index 836aafcda..000000000 --- a/tools/generate_providers/pubspec.yaml +++ /dev/null @@ -1,13 +0,0 @@ -name: generate_providers -publish_to: "none" - -environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" - -dependencies: - dart_style: ^2.0.0 - trotter: ^2.0.0 - tuple: ^2.0.0 - -executables: - generate_providers: \ No newline at end of file From ba7e5e031a7fc86d648b0e02896f8a505c48c71d Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 15 Jan 2024 09:20:04 +0100 Subject: [PATCH 126/387] Re-add builders generator --- .../bin/generate_providers.dart | 888 ++++++++++++++++++ tools/generate_providers/pubspec.yaml | 13 + 2 files changed, 901 insertions(+) create mode 100644 tools/generate_providers/bin/generate_providers.dart create mode 100644 tools/generate_providers/pubspec.yaml diff --git a/tools/generate_providers/bin/generate_providers.dart b/tools/generate_providers/bin/generate_providers.dart new file mode 100644 index 000000000..11d0fa8c4 --- /dev/null +++ b/tools/generate_providers/bin/generate_providers.dart @@ -0,0 +1,888 @@ +// ignore_for_file: avoid_print +import 'dart:io'; + +import 'package:dart_style/dart_style.dart'; +import 'package:trotter/trotter.dart'; +import 'package:tuple/tuple.dart'; + +enum DisposeType { + none, + autoDispose, +} + +const disposeLabel = { + DisposeType.none: '', + DisposeType.autoDispose: 'AutoDispose', +}; + +class StateDetails { + StateDetails({ + required this.className, + required this.ref, + required this.constraints, + required this.generics, + required this.createType, + }); + + final String className; + final String ref; + final String constraints; + final String generics; + final String createType; +} + +enum ProviderType { + single, + family, +} + +const providerLabel = { + ProviderType.single: '', + ProviderType.family: 'Family', +}; + +const _autoDisposeDoc = ''' +/// {@template riverpod.autoDispose} +/// Marks the provider as automatically disposed when no longer listened to. +/// +/// Some typical use-cases: +/// +/// - Combined with [StreamProvider], this can be used as a mean to keep +/// the connection with Firebase alive only when truly needed (to reduce costs). +/// - Automatically reset a form state when leaving the screen. +/// - Automatically retry HTTP requests that failed when the user exit and +/// re-enter the screen. +/// - Cancel HTTP requests if the user leaves a screen before the request completed. +/// +/// Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. +/// +/// The `keepAlive` function is used to tell Riverpod that the state of the provider +/// should be preserved even if no longer listened to. +/// +/// A use-case would be to set this flag to `true` after an HTTP request have +/// completed: +/// +/// ```dart +/// final myProvider = FutureProvider.autoDispose((ref) async { +/// final response = await httpClient.get(...); +/// ref.keepAlive(); +/// return response; +/// }); +/// ``` +/// +/// This way, if the request failed and the UI leaves the screen then re-enters +/// it, then the request will be performed again. +/// But if the request completed successfully, the state will be preserved +/// and re-entering the screen will not trigger a new request. +/// +/// It can be combined with `ref.onDispose` for more advanced behaviors, such +/// as cancelling pending HTTP requests when the user leaves a screen. +/// For example, modifying our previous snippet and using `dio`, we would have: +/// +/// ```diff +/// final myProvider = FutureProvider.autoDispose((ref) async { +/// + final cancelToken = CancelToken(); +/// + ref.onDispose(() => cancelToken.cancel()); +/// +/// + final response = await dio.get('path', cancelToken: cancelToken); +/// - final response = await dio.get('path'); +/// ref.keepAlive(); +/// return response; +/// }); +/// ``` +/// {@endtemplate}'''; + +bool _didAddAutoDisposeTemplate = false; + +String autoDisposeDoc() { + if (_didAddAutoDisposeTemplate) { + return '/// {@macro riverpod.autoDispose}'; + } + _didAddAutoDisposeTemplate = true; + return _autoDisposeDoc; +} + +const _familyDoc = r''' +/// {@template riverpod.family} +/// A group of providers that builds their value from an external parameter. +/// +/// Families can be useful to connect a provider with values that it doesn't +/// have access to. For example: +/// +/// - Allowing a "title provider" access the `Locale` +/// +/// ```dart +/// final titleFamily = Provider.family((ref, locale) { +/// if (locale == const Locale('en')) { +/// return 'English title'; +/// } else if (locale == const Locale('fr')) { +/// return 'Titre Français'; +/// } +/// }); +/// +/// // ... +/// +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// final locale = Localizations.localeOf(context); +/// +/// // Obtains the title based on the current Locale. +/// // Will automatically update the title when the Locale changes. +/// final title = ref.watch(titleFamily(locale)); +/// +/// return Text(title); +/// } +/// ``` +/// +/// - Have a "user provider" that receives the user ID as a parameter +/// +/// ```dart +/// final userFamily = FutureProvider.family((ref, userId) async { +/// final userRepository = ref.read(userRepositoryProvider); +/// return await userRepository.fetch(userId); +/// }); +/// +/// // ... +/// +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// int userId; // Read the user ID from somewhere +/// +/// // Read and potentially fetch the user with id `userId`. +/// // When `userId` changes, this will automatically update the UI +/// // Similarly, if two widgets tries to read `userFamily` with the same `userId` +/// // then the user will be fetched only once. +/// final user = ref.watch(userFamily(userId)); +/// +/// return user.when( +/// data: (user) => Text(user.name), +/// loading: () => const CircularProgressIndicator(), +/// error: (err, stack) => const Text('error'), +/// ); +/// } +/// ``` +/// +/// - Connect a provider with another provider without having a direct reference on it. +/// +/// ```dart +/// final repositoryProvider = Provider.family>((ref, configurationsProvider) { +/// // Read a provider without knowing what that provider is. +/// final configurations = await ref.read(configurationsProvider.future); +/// return Repository(host: configurations.host); +/// }); +/// ``` +/// +/// ## Usage +/// +/// The way families works is by adding an extra parameter to the provider. +/// This parameter can then be freely used in our provider to create some state. +/// +/// For example, we could combine `family` with [FutureProvider] to fetch +/// a `Message` from its ID: +/// +/// ```dart +/// final messagesFamily = FutureProvider.family((ref, id) async { +/// return dio.get('http://my_api.dev/messages/$id'); +/// }); +/// ``` +/// +/// Then, when using our `messagesFamily` provider, the syntax is slightly modified. +/// The usual: +/// +/// ```dart +/// Widget build(BuildContext context, WidgetRef ref) { +/// // Error – messagesFamily is not a provider +/// final response = ref.watch(messagesFamily); +/// } +/// ``` +/// +/// will not work anymore. +/// Instead, we need to pass a parameter to `messagesFamily`: +/// +/// ```dart +/// Widget build(BuildContext context, WidgetRef ref) { +/// final response = ref.watch(messagesFamily('id')); +/// } +/// ``` +/// +/// **NOTE**: It is totally possible to use a family with different parameters +/// simultaneously. For example, we could use a `titleFamily` to read both +/// the french and english translations at the same time: +/// +/// ```dart +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// final frenchTitle = ref.watch(titleFamily(const Locale('fr'))); +/// final englishTitle = ref.watch(titleFamily(const Locale('en'))); +/// +/// return Text('fr: $frenchTitle en: $englishTitle'); +/// } +/// ``` +/// +/// # Parameter restrictions +/// +/// For families to work correctly, it is critical for the parameter passed to +/// a provider to have a consistent `hashCode` and `==`. +/// +/// Ideally the parameter should either be a primitive (bool/int/double/String), +/// a constant (providers), or an immutable object that override `==` and `hashCode`. +/// +/// +/// - **PREFER** using `family` in combination with `autoDispose` if the +/// parameter passed to providers is a complex object: +/// +/// ```dart +/// final example = Provider.autoDispose.family((ref, param) { +/// }); +/// ``` +/// +/// This ensures that there is no memory leak if the parameter changed and is +/// never used again. +/// +/// # Passing multiple parameters to a family +/// +/// Families have no built-in support for passing multiple values to a provider. +/// +/// On the other hand, that value could be _anything_ (as long as it matches with +/// the restrictions mentioned previously). +/// +/// This includes: +/// - A tuple (using `package:tuple`) +/// - Objects generated with Freezed/built_value +/// - Objects based on `package:equatable` +/// +/// This includes: +/// - A tuple (using `package:tuple`) +/// - Objects generated with Freezed/built_value, such as: +/// ```dart +/// @freezed +/// abstract class MyParameter with _$MyParameter { +/// factory MyParameter({ +/// required int userId, +/// required Locale locale, +/// }) = _MyParameter; +/// } +/// +/// final exampleProvider = Provider.family((ref, myParameter) { +/// print(myParameter.userId); +/// print(myParameter.locale); +/// // Do something with userId/locale +/// }); +/// +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// int userId; // Read the user ID from somewhere +/// final locale = Localizations.localeOf(context); +/// +/// final something = ref.watch( +/// exampleProvider(MyParameter(userId: userId, locale: locale)), +/// ); +/// } +/// ``` +/// +/// - Objects based on `package:equatable`, such as: +/// ```dart +/// class MyParameter extends Equatable { +/// factory MyParameter({ +/// required this.userId, +/// requires this.locale, +/// }); +/// +/// final int userId; +/// final Local locale; +/// +/// @override +/// List get props => [userId, locale]; +/// } +/// +/// final exampleProvider = Provider.family((ref, myParameter) { +/// print(myParameter.userId); +/// print(myParameter.locale); +/// // Do something with userId/locale +/// }); +/// +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// int userId; // Read the user ID from somewhere +/// final locale = Localizations.localeOf(context); +/// +/// final something = ref.watch( +/// exampleProvider(MyParameter(userId: userId, locale: locale)), +/// ); +/// } +/// ``` +/// {@endtemplate}'''; + +bool _didAddFamilyTemplate = false; + +String familyDoc() { + if (_didAddFamilyTemplate) { + return '/// {@macro riverpod.family}'; + } + _didAddFamilyTemplate = true; + return _familyDoc; +} + +Future main(List args) async { + if (args.length != 2) { + print('usage: generate_providers file'); + return; + } + if (args.first != 'riverpod' && args.first != 'flutter_riverpod') { + print('Unknown argument ${args.first}'); + return; + } + + final file = File.fromUri(Uri.parse(args[1])); + if (file.existsSync() && file.statSync().type != FileSystemEntityType.file) { + print('${args[1]} is not a file'); + return; + } + + Tuple3, List, List> matrix; + + final builder = StringBuffer( + ''' +// GENERATED CODE - DO NOT MODIFY BY HAND +// +// If you need to modify this file, instead update /tools/generate_providers/bin/generate_providers.dart +// +// You can install this utility by executing: +// dart pub global activate -s path /tools/generate_providers +// +// You can then use it in your terminal by executing: +// generate_providers + +''', + ); + + switch (args.first) { + case 'riverpod': + matrix = Tuple3( + DisposeType.values, + [ + StateDetails( + className: 'StateProvider', + ref: 'StateProviderRef', + constraints: 'State', + generics: 'State', + createType: 'State', + ), + StateDetails( + className: 'StateNotifierProvider', + ref: 'StateNotifierProviderRef', + constraints: 'Notifier extends StateNotifier, State', + generics: 'Notifier, State', + createType: 'Notifier', + ), + StateDetails( + className: 'Provider', + ref: 'ProviderRef', + constraints: 'State', + generics: 'State', + createType: 'State', + ), + StateDetails( + className: 'FutureProvider', + ref: 'FutureProviderRef', + constraints: 'State', + generics: 'State', + createType: 'FutureOr', + ), + StateDetails( + className: 'StreamProvider', + ref: 'StreamProviderRef', + constraints: 'State', + generics: 'State', + createType: 'Stream', + ), + ], + ProviderType.values, + ); + builder.writeln( + """ +import 'dart:async'; +import 'package:state_notifier/state_notifier.dart'; + +import 'internals.dart'; + +/// Builds a [AsyncNotifierProvider]. +class AsyncNotifierProviderBuilder { + /// Builds a [AsyncNotifierProvider]. + const AsyncNotifierProviderBuilder(); + + /// {@macro riverpod.autoDispose} + AsyncNotifierProvider + call, T>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return AsyncNotifierProvider( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.autoDispose} + AutoDisposeAsyncNotifierProviderBuilder get autoDispose { + return const AutoDisposeAsyncNotifierProviderBuilder(); + } + + /// {@macro riverpod.family} + AsyncNotifierProviderFamilyBuilder get family { + return const AsyncNotifierProviderFamilyBuilder(); + } +} + +/// Builds a [AsyncNotifierProviderFamily]. +class AsyncNotifierProviderFamilyBuilder { + /// Builds a [AsyncNotifierProviderFamily]. + const AsyncNotifierProviderFamilyBuilder(); + + /// {@macro riverpod.family} + AsyncNotifierProviderFamily + call, T, Arg>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return AsyncNotifierProviderFamily( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.autoDispose} + AutoDisposeAsyncNotifierProviderFamilyBuilder get autoDispose { + return const AutoDisposeAsyncNotifierProviderFamilyBuilder(); + } +} + +/// Builds a [AutoDisposeAsyncNotifierProvider]. +class AutoDisposeAsyncNotifierProviderBuilder { + /// Builds a [AutoDisposeAsyncNotifierProvider]. + const AutoDisposeAsyncNotifierProviderBuilder(); + + /// {@macro riverpod.autoDispose} + AutoDisposeAsyncNotifierProvider + call, T>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return AutoDisposeAsyncNotifierProvider( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.family} + AutoDisposeAsyncNotifierProviderFamilyBuilder get family { + return const AutoDisposeAsyncNotifierProviderFamilyBuilder(); + } +} + +/// Builds a [AutoDisposeAsyncNotifierProviderFamily]. +class AutoDisposeAsyncNotifierProviderFamilyBuilder { + /// Builds a [AutoDisposeAsyncNotifierProviderFamily]. + const AutoDisposeAsyncNotifierProviderFamilyBuilder(); + + /// {@macro riverpod.family} + AutoDisposeAsyncNotifierProviderFamily + call, T, Arg>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return AutoDisposeAsyncNotifierProviderFamily( + create, + name: name, + dependencies: dependencies, + ); + } +} + +/// Builds a [NotifierProvider]. +class NotifierProviderBuilder { + /// Builds a [NotifierProvider]. + const NotifierProviderBuilder(); + + /// {@macro riverpod.autoDispose} + NotifierProvider + call, State>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return NotifierProvider( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.autoDispose} + AutoDisposeNotifierProviderBuilder get autoDispose { + return const AutoDisposeNotifierProviderBuilder(); + } + + /// {@macro riverpod.family} + NotifierProviderFamilyBuilder get family { + return const NotifierProviderFamilyBuilder(); + } +} + +/// Builds a [NotifierProviderFamily]. +class NotifierProviderFamilyBuilder { + /// Builds a [NotifierProviderFamily]. + const NotifierProviderFamilyBuilder(); + + /// {@macro riverpod.family} + NotifierProviderFamily + call, State, Arg>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return NotifierProviderFamily( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.autoDispose} + AutoDisposeNotifierProviderFamilyBuilder get autoDispose { + return const AutoDisposeNotifierProviderFamilyBuilder(); + } +} + +/// Builds a [AutoDisposeNotifierProvider]. +class AutoDisposeNotifierProviderBuilder { + /// Builds a [AutoDisposeNotifierProvider]. + const AutoDisposeNotifierProviderBuilder(); + + /// {@macro riverpod.autoDispose} + AutoDisposeNotifierProvider + call, State>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return AutoDisposeNotifierProvider( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.family} + AutoDisposeNotifierProviderFamilyBuilder get family { + return const AutoDisposeNotifierProviderFamilyBuilder(); + } +} + +/// Builds a [AutoDisposeNotifierProviderFamily]. +class AutoDisposeNotifierProviderFamilyBuilder { + /// Builds a [AutoDisposeNotifierProviderFamily]. + const AutoDisposeNotifierProviderFamilyBuilder(); + + /// {@macro riverpod.family} + AutoDisposeNotifierProviderFamily + call, State, Arg>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return AutoDisposeNotifierProviderFamily( + create, + name: name, + dependencies: dependencies, + ); + } +} + +/// Builds a [StreamNotifierProvider]. +class StreamNotifierProviderBuilder { + /// Builds a [StreamNotifierProvider]. + const StreamNotifierProviderBuilder(); + + /// {@macro riverpod.autoDispose} + StreamNotifierProvider + call, T>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return StreamNotifierProvider( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.autoDispose} + AutoDisposeStreamNotifierProviderBuilder get autoDispose { + return const AutoDisposeStreamNotifierProviderBuilder(); + } + + /// {@macro riverpod.family} + StreamNotifierProviderFamilyBuilder get family { + return const StreamNotifierProviderFamilyBuilder(); + } +} + +/// Builds a [StreamNotifierProviderFamily]. +class StreamNotifierProviderFamilyBuilder { + /// Builds a [StreamNotifierProviderFamily]. + const StreamNotifierProviderFamilyBuilder(); + + /// {@macro riverpod.family} + StreamNotifierProviderFamily + call, T, Arg>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return StreamNotifierProviderFamily( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.autoDispose} + AutoDisposeStreamNotifierProviderFamilyBuilder get autoDispose { + return const AutoDisposeStreamNotifierProviderFamilyBuilder(); + } +} + +/// Builds a [AutoDisposeStreamNotifierProvider]. +class AutoDisposeStreamNotifierProviderBuilder { + /// Builds a [AutoDisposeStreamNotifierProvider]. + const AutoDisposeStreamNotifierProviderBuilder(); + + /// {@macro riverpod.autoDispose} + AutoDisposeStreamNotifierProvider + call, T>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return AutoDisposeStreamNotifierProvider( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.family} + AutoDisposeStreamNotifierProviderFamilyBuilder get family { + return const AutoDisposeStreamNotifierProviderFamilyBuilder(); + } +} + +/// Builds a [AutoDisposeStreamNotifierProviderFamily]. +class AutoDisposeStreamNotifierProviderFamilyBuilder { + /// Builds a [AutoDisposeStreamNotifierProviderFamily]. + const AutoDisposeStreamNotifierProviderFamilyBuilder(); + + /// {@macro riverpod.family} + AutoDisposeStreamNotifierProviderFamily + call, T, Arg>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return AutoDisposeStreamNotifierProviderFamily( + create, + name: name, + dependencies: dependencies, + ); + } +} +""", + ); + break; + case 'flutter_riverpod': + matrix = Tuple3( + DisposeType.values, + [ + StateDetails( + className: 'ChangeNotifierProvider', + ref: 'ChangeNotifierProviderRef', + constraints: 'Notifier extends ChangeNotifier?', + generics: 'Notifier', + createType: 'Notifier', + ), + ], + ProviderType.values, + ); + builder.writeln( + """ +import 'package:flutter/foundation.dart'; +import 'internals.dart'; +""", + ); + break; + default: + throw UnsupportedError('Unknown package ${args.first}'); + } + + builder.writeAll(generateAll(matrix), '\n'); + + await file.writeAsString( + DartFormatter().format(builder.toString()), + ); +} + +Iterable generateAll( + Tuple3, List, List> matrix, +) sync* { + final combos = Combinations(3, [ + ...matrix.item1, + ...matrix.item2, + ...matrix.item3, + ]); + for (final permutation in combos()) { + final first = permutation.first; + final second = permutation[1]; + final third = permutation[2]; + + if (first is DisposeType && + second is StateDetails && + third is ProviderType) { + yield* generate(Tuple3(first, second, third), matrix); + } + } +} + +extension on Tuple3 { + String get providerName { + return '${disposeLabel[item1]}${item2.className}${providerLabel[item3]}'; + } + + String get ref { + switch (item1) { + case DisposeType.autoDispose: + return 'AutoDispose${item2.ref}'; + case DisposeType.none: + default: + return item2.ref; + } + } + + String get constraint => item2.constraints; + + String get createType => item2.createType; + + String links( + Tuple3, List, List> matrix, + ) { + Iterable other() sync* { + if (item1 == DisposeType.none) { + yield ''' + +${autoDisposeDoc().replaceAll('///', ' ///')} + AutoDispose${providerName}Builder get autoDispose { + return const AutoDispose${providerName}Builder(); + }'''; + } + + if (item3 == ProviderType.single) { + yield ''' + +${familyDoc().replaceAll('///', ' ///')} + ${providerName}FamilyBuilder get family { + return const ${providerName}FamilyBuilder(); + }'''; + } + } + + return other().join('\n'); + } +} + +Iterable generate( + Tuple3 configs, + Tuple3, List, List> matrix, +) sync* { + if (configs.item3 == ProviderType.family) { + yield FamilyBuilder(configs, matrix); + } else { + yield ProviderBuilder(configs, matrix); + } +} + +class FamilyBuilder { + FamilyBuilder(this.configs, this.matrix); + final Tuple3 configs; + final Tuple3, List, List> + matrix; + + @override + String toString() { + final createNamedParams = [ + 'String? name', + 'Iterable? dependencies', + ].map((e) => '$e,').join(); + final providerParams = [ + 'create', + 'name: name', + 'dependencies: dependencies', + ].map((e) => '$e,').join(); + return ''' +/// Builds a [${configs.providerName}]. +class ${configs.providerName}Builder { + /// Builds a [${configs.providerName}]. + const ${configs.providerName}Builder(); + +${familyDoc().replaceAll('///', ' ///')} + ${configs.providerName}<${configs.item2.generics}, Arg> call<${configs.constraint}, Arg>( + FamilyCreate<${configs.createType}, ${configs.ref}, Arg> create, { $createNamedParams }) { + return ${configs.providerName}<${configs.item2.generics}, Arg>($providerParams); + } +${configs.links(matrix)} +} +'''; + } +} + +class ProviderBuilder { + ProviderBuilder(this.configs, this.matrix); + final Tuple3 configs; + final Tuple3, List, List> + matrix; + + @override + String toString() { + final callNamedParams = [ + 'String? name', + 'Iterable? dependencies', + ].map((e) => '$e,').join(); + final providerParams = [ + 'create', + 'name: name', + 'dependencies: dependencies', + ].map((e) => '$e,').join(); + + return ''' +/// Builds a [${configs.providerName}]. +class ${configs.providerName}Builder { + /// Builds a [${configs.providerName}]. + const ${configs.providerName}Builder(); + +${autoDisposeDoc().replaceAll('///', ' ///')} + ${configs.providerName}<${configs.item2.generics}> call<${configs.constraint}>( + Create<${configs.createType}, ${configs.ref}> create, { $callNamedParams }) { + return ${configs.providerName}<${configs.item2.generics}>($providerParams); + } +${configs.links(matrix)} +} +'''; + } +} diff --git a/tools/generate_providers/pubspec.yaml b/tools/generate_providers/pubspec.yaml new file mode 100644 index 000000000..ab6a1bc59 --- /dev/null +++ b/tools/generate_providers/pubspec.yaml @@ -0,0 +1,13 @@ +name: generate_providers +publish_to: "none" + +environment: + sdk: ">=2.19.0 <4.0.0" + +dependencies: + dart_style: ^2.0.0 + trotter: ^2.0.0 + tuple: ^2.0.0 + +executables: + generate_providers: \ No newline at end of file From 7591f24005b122084d0ee76a91a24ba05ddf22f7 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Tue, 16 Jan 2024 02:11:23 +0100 Subject: [PATCH 127/387] Add builders again --- packages/riverpod/lib/src/builder.dart | 801 +++++++++++++ packages/riverpod/lib/src/core/builder.dart | 291 ----- packages/riverpod/lib/src/internals.dart | 1 + .../lib/src/providers/async_notifier.dart | 2 +- .../src/providers/async_notifier/orphan.dart | 10 +- .../lib/src/providers/future_provider.dart | 12 +- .../riverpod/lib/src/providers/provider.dart | 12 +- .../lib/src/providers/stream_notifier.dart | 4 +- .../src/providers/stream_notifier/orphan.dart | 10 +- .../lib/src/providers/stream_provider.dart | 12 +- .../bin/generate_providers.dart | 1059 +++++------------ tools/generate_providers/pubspec.yaml | 3 +- tools/generate_providers/src/docs.dart | 280 +++++ 13 files changed, 1375 insertions(+), 1122 deletions(-) create mode 100644 packages/riverpod/lib/src/builder.dart delete mode 100644 packages/riverpod/lib/src/core/builder.dart create mode 100644 tools/generate_providers/src/docs.dart diff --git a/packages/riverpod/lib/src/builder.dart b/packages/riverpod/lib/src/builder.dart new file mode 100644 index 000000000..ce77febc9 --- /dev/null +++ b/packages/riverpod/lib/src/builder.dart @@ -0,0 +1,801 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND +// +// If you need to modify this file, instead update /tools/generate_providers/bin/generate_providers.dart +// +// You can install this utility by executing: +// dart pub global activate -s path /tools/generate_providers +// +// You can then use it in your terminal by executing: +// generate_providers + +import 'dart:async'; + +import 'package:meta/meta.dart'; +import 'package:state_notifier/state_notifier.dart'; + +import 'internals.dart'; + +@internal +class StateProviderFamilyBuilder { + const StateProviderFamilyBuilder(); + + /// {@template riverpod.family} + /// A group of providers that builds their value from an external parameter. + /// + /// Families can be useful to connect a provider with values that it doesn't + /// have access to. For example: + /// + /// - Allowing a "title provider" access the `Locale` + /// + /// ```dart + /// final titleFamily = Provider.family((ref, locale) { + /// if (locale == const Locale('en')) { + /// return 'English title'; + /// } else if (locale == const Locale('fr')) { + /// return 'Titre Français'; + /// } + /// }); + /// + /// // ... + /// + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// final locale = Localizations.localeOf(context); + /// + /// // Obtains the title based on the current Locale. + /// // Will automatically update the title when the Locale changes. + /// final title = ref.watch(titleFamily(locale)); + /// + /// return Text(title); + /// } + /// ``` + /// + /// - Have a "user provider" that receives the user ID as a parameter + /// + /// ```dart + /// final userFamily = FutureProvider.family((ref, userId) async { + /// final userRepository = ref.read(userRepositoryProvider); + /// return await userRepository.fetch(userId); + /// }); + /// + /// // ... + /// + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// int userId; // Read the user ID from somewhere + /// + /// // Read and potentially fetch the user with id `userId`. + /// // When `userId` changes, this will automatically update the UI + /// // Similarly, if two widgets tries to read `userFamily` with the same `userId` + /// // then the user will be fetched only once. + /// final user = ref.watch(userFamily(userId)); + /// + /// return user.when( + /// data: (user) => Text(user.name), + /// loading: () => const CircularProgressIndicator(), + /// error: (err, stack) => const Text('error'), + /// ); + /// } + /// ``` + /// + /// - Connect a provider with another provider without having a direct reference on it. + /// + /// ```dart + /// final repositoryProvider = Provider.family>((ref, configurationsProvider) { + /// // Read a provider without knowing what that provider is. + /// final configurations = await ref.read(configurationsProvider.future); + /// return Repository(host: configurations.host); + /// }); + /// ``` + /// + /// ## Usage + /// + /// The way families works is by adding an extra parameter to the provider. + /// This parameter can then be freely used in our provider to create some state. + /// + /// For example, we could combine `family` with [FutureProvider] to fetch + /// a `Message` from its ID: + /// + /// ```dart + /// final messagesFamily = FutureProvider.family((ref, id) async { + /// return dio.get('http://my_api.dev/messages/$id'); + /// }); + /// ``` + /// + /// Then, when using our `messagesFamily` provider, the syntax is slightly modified. + /// The usual: + /// + /// ```dart + /// Widget build(BuildContext context, WidgetRef ref) { + /// // Error – messagesFamily is not a provider + /// final response = ref.watch(messagesFamily); + /// } + /// ``` + /// + /// will not work anymore. + /// Instead, we need to pass a parameter to `messagesFamily`: + /// + /// ```dart + /// Widget build(BuildContext context, WidgetRef ref) { + /// final response = ref.watch(messagesFamily('id')); + /// } + /// ``` + /// + /// **NOTE**: It is totally possible to use a family with different parameters + /// simultaneously. For example, we could use a `titleFamily` to read both + /// the french and english translations at the same time: + /// + /// ```dart + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// final frenchTitle = ref.watch(titleFamily(const Locale('fr'))); + /// final englishTitle = ref.watch(titleFamily(const Locale('en'))); + /// + /// return Text('fr: $frenchTitle en: $englishTitle'); + /// } + /// ``` + /// + /// # Parameter restrictions + /// + /// For families to work correctly, it is critical for the parameter passed to + /// a provider to have a consistent `hashCode` and `==`. + /// + /// Ideally the parameter should either be a primitive (bool/int/double/String), + /// a constant (providers), or an immutable object that override `==` and `hashCode`. + /// + /// + /// - **PREFER** using `family` in combination with `autoDispose` if the + /// parameter passed to providers is a complex object: + /// + /// ```dart + /// final example = Provider.autoDispose.family((ref, param) { + /// }); + /// ``` + /// + /// This ensures that there is no memory leak if the parameter changed and is + /// never used again. + /// + /// # Passing multiple parameters to a family + /// + /// Families have no built-in support for passing multiple values to a provider. + /// + /// On the other hand, that value could be _anything_ (as long as it matches with + /// the restrictions mentioned previously). + /// + /// This includes: + /// - A tuple (using `package:tuple`) + /// - Objects generated with Freezed/built_value + /// - Objects based on `package:equatable` + /// + /// This includes: + /// - A tuple (using `package:tuple`) + /// - Objects generated with Freezed/built_value, such as: + /// ```dart + /// @freezed + /// abstract class MyParameter with _$MyParameter { + /// factory MyParameter({ + /// required int userId, + /// required Locale locale, + /// }) = _MyParameter; + /// } + /// + /// final exampleProvider = Provider.family((ref, myParameter) { + /// print(myParameter.userId); + /// print(myParameter.locale); + /// // Do something with userId/locale + /// }); + /// + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// int userId; // Read the user ID from somewhere + /// final locale = Localizations.localeOf(context); + /// + /// final something = ref.watch( + /// exampleProvider(MyParameter(userId: userId, locale: locale)), + /// ); + /// } + /// ``` + /// + /// - Objects based on `package:equatable`, such as: + /// ```dart + /// class MyParameter extends Equatable { + /// factory MyParameter({ + /// required this.userId, + /// requires this.locale, + /// }); + /// + /// final int userId; + /// final Local locale; + /// + /// @override + /// List get props => [userId, locale]; + /// } + /// + /// final exampleProvider = Provider.family((ref, myParameter) { + /// print(myParameter.userId); + /// print(myParameter.locale); + /// // Do something with userId/locale + /// }); + /// + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// int userId; // Read the user ID from somewhere + /// final locale = Localizations.localeOf(context); + /// + /// final something = ref.watch( + /// exampleProvider(MyParameter(userId: userId, locale: locale)), + /// ); + /// } + /// ``` + /// {@endtemplate} + StateProviderFamily call( + StateT Function(StateProviderRef ref, ArgT param) create, { + String? name, + Iterable? dependencies, + }) { + return StateProviderFamily( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@template riverpod.autoDispose} + /// Marks the provider as automatically disposed when no longer listened to. + /// + /// Some typical use-cases: + /// + /// - Combined with [StreamProvider], this can be used as a mean to keep + /// the connection with Firebase alive only when truly needed (to reduce costs). + /// - Automatically reset a form state when leaving the screen. + /// - Automatically retry HTTP requests that failed when the user exit and + /// re-enter the screen. + /// - Cancel HTTP requests if the user leaves a screen before the request completed. + /// + /// Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. + /// + /// The `keepAlive` function is used to tell Riverpod that the state of the provider + /// should be preserved even if no longer listened to. + /// + /// A use-case would be to set this flag to `true` after an HTTP request have + /// completed: + /// + /// ```dart + /// final myProvider = FutureProvider.autoDispose((ref) async { + /// final response = await httpClient.get(...); + /// ref.keepAlive(); + /// return response; + /// }); + /// ``` + /// + /// This way, if the request failed and the UI leaves the screen then re-enters + /// it, then the request will be performed again. + /// But if the request completed successfully, the state will be preserved + /// and re-entering the screen will not trigger a new request. + /// + /// It can be combined with `ref.onDispose` for more advanced behaviors, such + /// as cancelling pending HTTP requests when the user leaves a screen. + /// For example, modifying our previous snippet and using `dio`, we would have: + /// + /// ```diff + /// final myProvider = FutureProvider.autoDispose((ref) async { + /// + final cancelToken = CancelToken(); + /// + ref.onDispose(() => cancelToken.cancel()); + /// + /// + final response = await dio.get('path', cancelToken: cancelToken); + /// - final response = await dio.get('path'); + /// ref.keepAlive(); + /// return response; + /// }); + /// ``` + /// {@endtemplate} + AutoDisposeStateProviderFamilyBuilder get autoDispose => + const AutoDisposeStateProviderFamilyBuilder(); +} + +@internal +class AutoDisposeStateProviderBuilder { + const AutoDisposeStateProviderBuilder(); + + /// {@macro riverpod.family} + StateProvider call( + StateT Function(StateProviderRef ref) create, { + String? name, + Iterable? dependencies, + }) { + return StateProvider( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.family} + AutoDisposeStateProviderFamilyBuilder get family => + const AutoDisposeStateProviderFamilyBuilder(); +} + +@internal +class AutoDisposeStateProviderFamilyBuilder { + const AutoDisposeStateProviderFamilyBuilder(); + + /// {@macro riverpod.family} + StateProviderFamily call( + StateT Function(StateProviderRef ref, ArgT param) create, { + String? name, + Iterable? dependencies, + }) { + return StateProviderFamily( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } +} + +@internal +class StateNotifierProviderFamilyBuilder { + const StateNotifierProviderFamilyBuilder(); + + /// {@macro riverpod.family} + StateNotifierProviderFamily + call, StateT, ArgT>( + NotifierT Function( + StateNotifierProviderRef ref, ArgT param) + create, { + String? name, + Iterable? dependencies, + }) { + return StateNotifierProviderFamily( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.autoDispose} + AutoDisposeStateNotifierProviderFamilyBuilder get autoDispose => + const AutoDisposeStateNotifierProviderFamilyBuilder(); +} + +@internal +class AutoDisposeStateNotifierProviderBuilder { + const AutoDisposeStateNotifierProviderBuilder(); + + /// {@macro riverpod.family} + StateNotifierProvider + call, StateT>( + NotifierT Function(StateNotifierProviderRef ref) + create, { + String? name, + Iterable? dependencies, + }) { + return StateNotifierProvider( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.family} + AutoDisposeStateNotifierProviderFamilyBuilder get family => + const AutoDisposeStateNotifierProviderFamilyBuilder(); +} + +@internal +class AutoDisposeStateNotifierProviderFamilyBuilder { + const AutoDisposeStateNotifierProviderFamilyBuilder(); + + /// {@macro riverpod.family} + StateNotifierProviderFamily + call, StateT, ArgT>( + NotifierT Function( + StateNotifierProviderRef ref, ArgT param) + create, { + String? name, + Iterable? dependencies, + }) { + return StateNotifierProviderFamily( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } +} + +@internal +class ProviderFamilyBuilder { + const ProviderFamilyBuilder(); + + /// {@macro riverpod.family} + ProviderFamily call( + StateT Function(Ref ref, ArgT param) create, { + String? name, + Iterable? dependencies, + }) { + return ProviderFamily( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.autoDispose} + AutoDisposeProviderFamilyBuilder get autoDispose => + const AutoDisposeProviderFamilyBuilder(); +} + +@internal +class AutoDisposeProviderBuilder { + const AutoDisposeProviderBuilder(); + + /// {@macro riverpod.family} + Provider call( + StateT Function(Ref ref) create, { + String? name, + Iterable? dependencies, + }) { + return Provider( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.family} + AutoDisposeProviderFamilyBuilder get family => + const AutoDisposeProviderFamilyBuilder(); +} + +@internal +class AutoDisposeProviderFamilyBuilder { + const AutoDisposeProviderFamilyBuilder(); + + /// {@macro riverpod.family} + ProviderFamily call( + StateT Function(Ref ref, ArgT param) create, { + String? name, + Iterable? dependencies, + }) { + return ProviderFamily( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } +} + +@internal +class FutureProviderFamilyBuilder { + const FutureProviderFamilyBuilder(); + + /// {@macro riverpod.family} + FutureProviderFamily call( + FutureOr Function(Ref> ref, ArgT param) create, { + String? name, + Iterable? dependencies, + }) { + return FutureProviderFamily( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.autoDispose} + AutoDisposeFutureProviderFamilyBuilder get autoDispose => + const AutoDisposeFutureProviderFamilyBuilder(); +} + +@internal +class AutoDisposeFutureProviderBuilder { + const AutoDisposeFutureProviderBuilder(); + + /// {@macro riverpod.family} + FutureProvider call( + FutureOr Function(Ref> ref) create, { + String? name, + Iterable? dependencies, + }) { + return FutureProvider( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.family} + AutoDisposeFutureProviderFamilyBuilder get family => + const AutoDisposeFutureProviderFamilyBuilder(); +} + +@internal +class AutoDisposeFutureProviderFamilyBuilder { + const AutoDisposeFutureProviderFamilyBuilder(); + + /// {@macro riverpod.family} + FutureProviderFamily call( + FutureOr Function(Ref> ref, ArgT param) create, { + String? name, + Iterable? dependencies, + }) { + return FutureProviderFamily( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } +} + +@internal +class StreamProviderFamilyBuilder { + const StreamProviderFamilyBuilder(); + + /// {@macro riverpod.family} + StreamProviderFamily call( + Stream Function(Ref> ref, ArgT param) create, { + String? name, + Iterable? dependencies, + }) { + return StreamProviderFamily( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.autoDispose} + AutoDisposeStreamProviderFamilyBuilder get autoDispose => + const AutoDisposeStreamProviderFamilyBuilder(); +} + +@internal +class AutoDisposeStreamProviderBuilder { + const AutoDisposeStreamProviderBuilder(); + + /// {@macro riverpod.family} + StreamProvider call( + Stream Function(Ref> ref) create, { + String? name, + Iterable? dependencies, + }) { + return StreamProvider( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.family} + AutoDisposeStreamProviderFamilyBuilder get family => + const AutoDisposeStreamProviderFamilyBuilder(); +} + +@internal +class AutoDisposeStreamProviderFamilyBuilder { + const AutoDisposeStreamProviderFamilyBuilder(); + + /// {@macro riverpod.family} + StreamProviderFamily call( + Stream Function(Ref> ref, ArgT param) create, { + String? name, + Iterable? dependencies, + }) { + return StreamProviderFamily( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } +} + +@internal +class NotifierProviderFamilyBuilder { + const NotifierProviderFamilyBuilder(); + + /// {@macro riverpod.autoDispose} + NotifierProvider + call, StateT>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return NotifierProvider( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.autoDispose} + AutoDisposeNotifierProviderFamilyBuilder get autoDispose => + const AutoDisposeNotifierProviderFamilyBuilder(); +} + +@internal +class AutoDisposeNotifierProviderBuilder { + const AutoDisposeNotifierProviderBuilder(); + + /// {@macro riverpod.autoDispose} + NotifierProvider + call, StateT>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return NotifierProvider( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.family} + AutoDisposeNotifierProviderFamilyBuilder get family => + const AutoDisposeNotifierProviderFamilyBuilder(); +} + +@internal +class AutoDisposeNotifierProviderFamilyBuilder { + const AutoDisposeNotifierProviderFamilyBuilder(); + + /// {@macro riverpod.autoDispose} + NotifierProvider + call, StateT>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return NotifierProvider( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } +} + +@internal +class StreamNotifierProviderFamilyBuilder { + const StreamNotifierProviderFamilyBuilder(); + + /// {@macro riverpod.autoDispose} + StreamNotifierProvider + call, StateT>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return StreamNotifierProvider( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.autoDispose} + AutoDisposeStreamNotifierProviderFamilyBuilder get autoDispose => + const AutoDisposeStreamNotifierProviderFamilyBuilder(); +} + +@internal +class AutoDisposeStreamNotifierProviderBuilder { + const AutoDisposeStreamNotifierProviderBuilder(); + + /// {@macro riverpod.autoDispose} + StreamNotifierProvider + call, StateT>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return StreamNotifierProvider( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.family} + AutoDisposeStreamNotifierProviderFamilyBuilder get family => + const AutoDisposeStreamNotifierProviderFamilyBuilder(); +} + +@internal +class AutoDisposeStreamNotifierProviderFamilyBuilder { + const AutoDisposeStreamNotifierProviderFamilyBuilder(); + + /// {@macro riverpod.autoDispose} + StreamNotifierProvider + call, StateT>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return StreamNotifierProvider( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } +} + +@internal +class AsyncNotifierProviderFamilyBuilder { + const AsyncNotifierProviderFamilyBuilder(); + + /// {@macro riverpod.autoDispose} + AsyncNotifierProvider + call, StateT>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return AsyncNotifierProvider( + create, + name: name, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.autoDispose} + AutoDisposeAsyncNotifierProviderFamilyBuilder get autoDispose => + const AutoDisposeAsyncNotifierProviderFamilyBuilder(); +} + +@internal +class AutoDisposeAsyncNotifierProviderBuilder { + const AutoDisposeAsyncNotifierProviderBuilder(); + + /// {@macro riverpod.autoDispose} + AsyncNotifierProvider + call, StateT>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return AsyncNotifierProvider( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } + + /// {@macro riverpod.family} + AutoDisposeAsyncNotifierProviderFamilyBuilder get family => + const AutoDisposeAsyncNotifierProviderFamilyBuilder(); +} + +@internal +class AutoDisposeAsyncNotifierProviderFamilyBuilder { + const AutoDisposeAsyncNotifierProviderFamilyBuilder(); + + /// {@macro riverpod.autoDispose} + AsyncNotifierProvider + call, StateT>( + NotifierT Function() create, { + String? name, + Iterable? dependencies, + }) { + return AsyncNotifierProvider( + create, + name: name, + isAutoDispose: true, + dependencies: dependencies, + ); + } +} diff --git a/packages/riverpod/lib/src/core/builder.dart b/packages/riverpod/lib/src/core/builder.dart deleted file mode 100644 index 06d4c1249..000000000 --- a/packages/riverpod/lib/src/core/builder.dart +++ /dev/null @@ -1,291 +0,0 @@ -import 'package:meta/meta.dart'; - -import '../providers/future_provider.dart'; -import '../providers/stream_provider.dart'; - -typedef OrphanCreate = CreatedT Function(RefT ref); -typedef OrphanNotifierCreate = NotifierT Function(RefT ref); - -@internal -class FamilyBuilder { - const FamilyBuilder({ - required this.call, - required this.autoDispose, - }); - - /// {@template riverpod.family} - /// A group of providers that builds their value from an external parameter. - /// - /// Families can be useful to connect a provider with values that it doesn't - /// have access to. For example: - /// - /// - Allowing a "title provider" access the `Locale` - /// - /// ```dart - /// final titleFamily = Provider.family((ref, locale) { - /// if (locale == const Locale('en')) { - /// return 'English title'; - /// } else if (locale == const Locale('fr')) { - /// return 'Titre Français'; - /// } - /// }); - /// - /// // ... - /// - /// @override - /// Widget build(BuildContext context, WidgetRef ref) { - /// final locale = Localizations.localeOf(context); - /// - /// // Obtains the title based on the current Locale. - /// // Will automatically update the title when the Locale changes. - /// final title = ref.watch(titleFamily(locale)); - /// - /// return Text(title); - /// } - /// ``` - /// - /// - Have a "user provider" that receives the user ID as a parameter - /// - /// ```dart - /// final userFamily = FutureProvider.family((ref, userId) async { - /// final userRepository = ref.read(userRepositoryProvider); - /// return await userRepository.fetch(userId); - /// }); - /// - /// // ... - /// - /// @override - /// Widget build(BuildContext context, WidgetRef ref) { - /// int userId; // Read the user ID from somewhere - /// - /// // Read and potentially fetch the user with id `userId`. - /// // When `userId` changes, this will automatically update the UI - /// // Similarly, if two widgets tries to read `userFamily` with the same `userId` - /// // then the user will be fetched only once. - /// final user = ref.watch(userFamily(userId)); - /// - /// return user.when( - /// data: (user) => Text(user.name), - /// loading: () => const CircularProgressIndicator(), - /// error: (err, stack) => const Text('error'), - /// ); - /// } - /// ``` - /// - /// - Connect a provider with another provider without having a direct reference on it. - /// - /// ```dart - /// final repositoryProvider = Provider.family>((ref, configurationsProvider) { - /// // Read a provider without knowing what that provider is. - /// final configurations = await ref.read(configurationsProvider.future); - /// return Repository(host: configurations.host); - /// }); - /// ``` - /// - /// ## Usage - /// - /// The way families works is by adding an extra parameter to the provider. - /// This parameter can then be freely used in our provider to create some state. - /// - /// For example, we could combine `family` with [FutureProvider] to fetch - /// a `Message` from its ID: - /// - /// ```dart - /// final messagesFamily = FutureProvider.family((ref, id) async { - /// return dio.get('http://my_api.dev/messages/$id'); - /// }); - /// ``` - /// - /// Then, when using our `messagesFamily` provider, the syntax is slightly modified. - /// The usual: - /// - /// ```dart - /// Widget build(BuildContext context, WidgetRef ref) { - /// // Error – messagesFamily is not a provider - /// final response = ref.watch(messagesFamily); - /// } - /// ``` - /// - /// will not work anymore. - /// Instead, we need to pass a parameter to `messagesFamily`: - /// - /// ```dart - /// Widget build(BuildContext context, WidgetRef ref) { - /// final response = ref.watch(messagesFamily('id')); - /// } - /// ``` - /// - /// **NOTE**: It is totally possible to use a family with different parameters - /// simultaneously. For example, we could use a `titleFamily` to read both - /// the french and english translations at the same time: - /// - /// ```dart - /// @override - /// Widget build(BuildContext context, WidgetRef ref) { - /// final frenchTitle = ref.watch(titleFamily(const Locale('fr'))); - /// final englishTitle = ref.watch(titleFamily(const Locale('en'))); - /// - /// return Text('fr: $frenchTitle en: $englishTitle'); - /// } - /// ``` - /// - /// # Parameter restrictions - /// - /// For families to work correctly, it is critical for the parameter passed to - /// a provider to have a consistent `hashCode` and `==`. - /// - /// Ideally the parameter should either be a primitive (bool/int/double/String), - /// a constant (providers), or an immutable object that override `==` and `hashCode`. - /// - /// - /// - **PREFER** using `family` in combination with `autoDispose` if the - /// parameter passed to providers is a complex object: - /// - /// ```dart - /// final example = Provider.autoDispose.family((ref, param) { - /// }); - /// ``` - /// - /// This ensures that there is no memory leak if the parameter changed and is - /// never used again. - /// - /// # Passing multiple parameters to a family - /// - /// Families have no built-in support for passing multiple values to a provider. - /// - /// On the other hand, that value could be _anything_ (as long as it matches with - /// the restrictions mentioned previously). - /// - /// This includes: - /// - A tuple (using `package:tuple`) - /// - Objects generated with Freezed/built_value - /// - Objects based on `package:equatable` - /// - /// This includes: - /// - A tuple (using `package:tuple`) - /// - Objects generated with Freezed/built_value, such as: - /// ```dart - /// @freezed - /// abstract class MyParameter with _$MyParameter { - /// factory MyParameter({ - /// required int userId, - /// required Locale locale, - /// }) = _MyParameter; - /// } - /// - /// final exampleProvider = Provider.family((ref, myParameter) { - /// print(myParameter.userId); - /// print(myParameter.locale); - /// // Do something with userId/locale - /// }); - /// - /// @override - /// Widget build(BuildContext context, WidgetRef ref) { - /// int userId; // Read the user ID from somewhere - /// final locale = Localizations.localeOf(context); - /// - /// final something = ref.watch( - /// exampleProvider(MyParameter(userId: userId, locale: locale)), - /// ); - /// } - /// ``` - /// - /// - Objects based on `package:equatable`, such as: - /// ```dart - /// class MyParameter extends Equatable { - /// factory MyParameter({ - /// required this.userId, - /// requires this.locale, - /// }); - /// - /// final int userId; - /// final Local locale; - /// - /// @override - /// List get props => [userId, locale]; - /// } - /// - /// final exampleProvider = Provider.family((ref, myParameter) { - /// print(myParameter.userId); - /// print(myParameter.locale); - /// // Do something with userId/locale - /// }); - /// - /// @override - /// Widget build(BuildContext context, WidgetRef ref) { - /// int userId; // Read the user ID from somewhere - /// final locale = Localizations.localeOf(context); - /// - /// final something = ref.watch( - /// exampleProvider(MyParameter(userId: userId, locale: locale)), - /// ); - /// } - /// ``` - /// {@endtemplate} - final CallT call; - - /// {@template riverpod.autoDispose} - /// Marks the provider as automatically disposed when no longer listened to. - /// - /// Some typical use-cases: - /// - /// - Combined with [StreamProvider], this can be used as a mean to keep - /// the connection with Firebase alive only when truly needed (to reduce costs). - /// - Automatically reset a form state when leaving the screen. - /// - Automatically retry HTTP requests that failed when the user exit and - /// re-enter the screen. - /// - Cancel HTTP requests if the user leaves a screen before the request completed. - /// - /// Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. - /// - /// The `keepAlive` function is used to tell Riverpod that the state of the provider - /// should be preserved even if no longer listened to. - /// - /// A use-case would be to set this flag to `true` after an HTTP request have - /// completed: - /// - /// ```dart - /// final myProvider = FutureProvider.autoDispose((ref) async { - /// final response = await httpClient.get(...); - /// ref.keepAlive(); - /// return response; - /// }); - /// ``` - /// - /// This way, if the request failed and the UI leaves the screen then re-enters - /// it, then the request will be performed again. - /// But if the request completed successfully, the state will be preserved - /// and re-entering the screen will not trigger a new request. - /// - /// It can be combined with `ref.onDispose` for more advanced behaviors, such - /// as cancelling pending HTTP requests when the user leaves a screen. - /// For example, modifying our previous snippet and using `dio`, we would have: - /// - /// ```diff - /// final myProvider = FutureProvider.autoDispose((ref) async { - /// + final cancelToken = CancelToken(); - /// + ref.onDispose(() => cancelToken.cancel()); - /// - /// + final response = await dio.get('path', cancelToken: cancelToken); - /// - final response = await dio.get('path'); - /// ref.keepAlive(); - /// return response; - /// }); - /// ``` - /// {@endtemplate} - final AutoDisposeT autoDispose; -} - -@internal -class ProviderBuilder { - const ProviderBuilder({ - required this.call, - required this.family, - }); - - /// {@macro riverpod.autoDispose} - final CallT call; - - /// {@macro riverpod.family} - final FamilyT family; -} diff --git a/packages/riverpod/lib/src/internals.dart b/packages/riverpod/lib/src/internals.dart index 6f3b786d6..06592ceaa 100644 --- a/packages/riverpod/lib/src/internals.dart +++ b/packages/riverpod/lib/src/internals.dart @@ -17,4 +17,5 @@ export 'providers/legacy/state_notifier_provider.dart'; export 'providers/legacy/state_provider.dart'; export 'providers/notifier.dart'; export 'providers/provider.dart'; +export 'providers/stream_notifier.dart'; export 'providers/stream_provider.dart'; diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index ae7dd5a3b..f7593298b 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -2,8 +2,8 @@ import 'dart:async'; import 'package:meta/meta.dart'; +import '../builder.dart'; import '../core/async_value.dart'; -import '../core/builder.dart'; import '../framework.dart'; import 'future_provider.dart' show FutureProvider; import 'notifier.dart'; diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index d98974499..fbbd96a91 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -103,16 +103,10 @@ final class AsyncNotifierProvider< // }); /// {@macro riverpod.autoDispose} - static const autoDispose = ProviderBuilder( - call: AsyncNotifierProvider._autoDispose, - family: AsyncNotifierProviderFamily._, - ); + static const autoDispose = AutoDisposeAsyncNotifierProviderBuilder(); /// {@macro riverpod.family} - static const family = FamilyBuilder( - call: AsyncNotifierProviderFamily._, - autoDispose: AsyncNotifierProviderFamily._autoDispose, - ); + static const family = AsyncNotifierProviderFamilyBuilder(); AsyncNotifierProvider _copyWith({ NotifierT Function()? create, diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 19f27b6bf..cab7c1f04 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -2,8 +2,8 @@ import 'dart:async'; import 'package:meta/meta.dart'; +import '../builder.dart'; import '../core/async_value.dart'; -import '../core/builder.dart'; import '../framework.dart'; import 'async_notifier.dart'; import 'provider.dart' show Provider; @@ -122,16 +122,10 @@ final class FutureProvider extends FunctionalProvider< }); /// {@macro riverpod.autoDispose} - static const autoDispose = ProviderBuilder( - call: FutureProvider._autoDispose, - family: FutureProviderFamily._, - ); + static const autoDispose = AutoDisposeFutureProviderBuilder(); /// {@macro riverpod.family} - static const family = FamilyBuilder( - call: FutureProviderFamily._, - autoDispose: FutureProviderFamily._autoDispose, - ); + static const family = FutureProviderFamilyBuilder(); /// TODO make all "create" public, for the sake of dartdocs. final Create, FutureProviderRef> _create; diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index decb957c9..00260baf3 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -1,6 +1,6 @@ import 'package:meta/meta.dart'; -import '../core/builder.dart'; +import '../builder.dart'; import '../framework.dart'; import 'legacy/state_notifier_provider.dart' show StateNotifierProvider; import 'stream_provider.dart' show StreamProvider; @@ -51,16 +51,10 @@ final class Provider }); /// {@macro riverpod.autoDispose} - static const autoDispose = ProviderBuilder( - call: Provider._autoDispose, - family: ProviderFamily._, - ); + static const autoDispose = AutoDisposeProviderBuilder(); /// {@macro riverpod.family} - static const family = FamilyBuilder( - call: ProviderFamily._, - autoDispose: ProviderFamily._autoDispose, - ); + static const family = ProviderFamilyBuilder(); final Create> _create; diff --git a/packages/riverpod/lib/src/providers/stream_notifier.dart b/packages/riverpod/lib/src/providers/stream_notifier.dart index 0bdde1d98..d15c8c782 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier.dart @@ -2,13 +2,13 @@ import 'dart:async'; import 'package:meta/meta.dart'; +import '../builder.dart'; import '../core/async_value.dart'; -import '../core/builder.dart'; import '../framework.dart'; import 'future_provider.dart' show FutureProvider; -part 'stream_notifier/orphan.dart'; part 'stream_notifier/family.dart'; +part 'stream_notifier/orphan.dart'; abstract class _StreamNotifierBase extends ClassBase< // AsyncValue, diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index feb25d40f..bbbbc2c50 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -90,16 +90,10 @@ final class StreamNotifierProvider< // }); /// {@macro riverpod.autoDispose} - static const autoDispose = ProviderBuilder( - call: StreamNotifierProvider._autoDispose, - family: StreamNotifierProviderFamily._, - ); + static const autoDispose = AutoDisposeStreamNotifierProviderBuilder(); /// {@macro riverpod.family} - static const family = FamilyBuilder( - call: StreamNotifierProviderFamily._, - autoDispose: StreamNotifierProviderFamily._autoDispose, - ); + static const family = StreamNotifierProviderFamilyBuilder(); StreamNotifierProvider _copyWith({ NotifierT Function()? create, diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index a5e200a4e..c2d9a4753 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -2,10 +2,10 @@ import 'dart:async'; import 'package:meta/meta.dart'; +import '../builder.dart'; import '../common/listenable.dart'; import '../common/result.dart'; import '../core/async_value.dart'; -import '../core/builder.dart'; import '../framework.dart'; import 'future_provider.dart' show FutureProvider; import 'provider.dart' show Provider; @@ -110,16 +110,10 @@ final class StreamProvider }); /// {@macro riverpod.autoDispose} - static const autoDispose = ProviderBuilder( - call: StreamProvider._autoDispose, - family: StreamProviderFamily._, - ); + static const autoDispose = AutoDisposeStreamProviderBuilder(); /// {@macro riverpod.family} - static const family = FamilyBuilder( - call: StreamProviderFamily._, - autoDispose: StreamProviderFamily._autoDispose, - ); + static const family = StreamProviderFamilyBuilder(); final Create, Ref>> _create; diff --git a/tools/generate_providers/bin/generate_providers.dart b/tools/generate_providers/bin/generate_providers.dart index 11d0fa8c4..64ce7e7d9 100644 --- a/tools/generate_providers/bin/generate_providers.dart +++ b/tools/generate_providers/bin/generate_providers.dart @@ -1,888 +1,381 @@ -// ignore_for_file: avoid_print import 'dart:io'; import 'package:dart_style/dart_style.dart'; -import 'package:trotter/trotter.dart'; -import 'package:tuple/tuple.dart'; -enum DisposeType { - none, - autoDispose, -} +import '../src/docs.dart'; + +const _header = ''' +// GENERATED CODE - DO NOT MODIFY BY HAND +// +// If you need to modify this file, instead update /tools/generate_providers/bin/generate_providers.dart +// +// You can install this utility by executing: +// dart pub global activate -s path /tools/generate_providers +// +// You can then use it in your terminal by executing: +// generate_providers + +'''; + +enum _DisposeType { keepAlive, autoDispose } -const disposeLabel = { - DisposeType.none: '', - DisposeType.autoDispose: 'AutoDispose', -}; - -class StateDetails { - StateDetails({ - required this.className, - required this.ref, - required this.constraints, - required this.generics, - required this.createType, +enum _ProviderKind { orphan, family } + +sealed class _Builder { + const _Builder( + this.providerName, { + required this.genericsDefinition, + required this.genericsUsage, }); - final String className; - final String ref; - final String constraints; - final String generics; - final String createType; + final String genericsDefinition; + final String genericsUsage; + final String providerName; } -enum ProviderType { - single, - family, -} +class _FunctionalBuilder extends _Builder { + _FunctionalBuilder( + super.providerName, { + required super.genericsDefinition, + required super.genericsUsage, + required this.createdT, + required this.refT, + }); -const providerLabel = { - ProviderType.single: '', - ProviderType.family: 'Family', -}; - -const _autoDisposeDoc = ''' -/// {@template riverpod.autoDispose} -/// Marks the provider as automatically disposed when no longer listened to. -/// -/// Some typical use-cases: -/// -/// - Combined with [StreamProvider], this can be used as a mean to keep -/// the connection with Firebase alive only when truly needed (to reduce costs). -/// - Automatically reset a form state when leaving the screen. -/// - Automatically retry HTTP requests that failed when the user exit and -/// re-enter the screen. -/// - Cancel HTTP requests if the user leaves a screen before the request completed. -/// -/// Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. -/// -/// The `keepAlive` function is used to tell Riverpod that the state of the provider -/// should be preserved even if no longer listened to. -/// -/// A use-case would be to set this flag to `true` after an HTTP request have -/// completed: -/// -/// ```dart -/// final myProvider = FutureProvider.autoDispose((ref) async { -/// final response = await httpClient.get(...); -/// ref.keepAlive(); -/// return response; -/// }); -/// ``` -/// -/// This way, if the request failed and the UI leaves the screen then re-enters -/// it, then the request will be performed again. -/// But if the request completed successfully, the state will be preserved -/// and re-entering the screen will not trigger a new request. -/// -/// It can be combined with `ref.onDispose` for more advanced behaviors, such -/// as cancelling pending HTTP requests when the user leaves a screen. -/// For example, modifying our previous snippet and using `dio`, we would have: -/// -/// ```diff -/// final myProvider = FutureProvider.autoDispose((ref) async { -/// + final cancelToken = CancelToken(); -/// + ref.onDispose(() => cancelToken.cancel()); -/// -/// + final response = await dio.get('path', cancelToken: cancelToken); -/// - final response = await dio.get('path'); -/// ref.keepAlive(); -/// return response; -/// }); -/// ``` -/// {@endtemplate}'''; - -bool _didAddAutoDisposeTemplate = false; - -String autoDisposeDoc() { - if (_didAddAutoDisposeTemplate) { - return '/// {@macro riverpod.autoDispose}'; - } - _didAddAutoDisposeTemplate = true; - return _autoDisposeDoc; + final String createdT; + final String refT; } -const _familyDoc = r''' -/// {@template riverpod.family} -/// A group of providers that builds their value from an external parameter. -/// -/// Families can be useful to connect a provider with values that it doesn't -/// have access to. For example: -/// -/// - Allowing a "title provider" access the `Locale` -/// -/// ```dart -/// final titleFamily = Provider.family((ref, locale) { -/// if (locale == const Locale('en')) { -/// return 'English title'; -/// } else if (locale == const Locale('fr')) { -/// return 'Titre Français'; -/// } -/// }); -/// -/// // ... -/// -/// @override -/// Widget build(BuildContext context, WidgetRef ref) { -/// final locale = Localizations.localeOf(context); -/// -/// // Obtains the title based on the current Locale. -/// // Will automatically update the title when the Locale changes. -/// final title = ref.watch(titleFamily(locale)); -/// -/// return Text(title); -/// } -/// ``` -/// -/// - Have a "user provider" that receives the user ID as a parameter -/// -/// ```dart -/// final userFamily = FutureProvider.family((ref, userId) async { -/// final userRepository = ref.read(userRepositoryProvider); -/// return await userRepository.fetch(userId); -/// }); -/// -/// // ... -/// -/// @override -/// Widget build(BuildContext context, WidgetRef ref) { -/// int userId; // Read the user ID from somewhere -/// -/// // Read and potentially fetch the user with id `userId`. -/// // When `userId` changes, this will automatically update the UI -/// // Similarly, if two widgets tries to read `userFamily` with the same `userId` -/// // then the user will be fetched only once. -/// final user = ref.watch(userFamily(userId)); -/// -/// return user.when( -/// data: (user) => Text(user.name), -/// loading: () => const CircularProgressIndicator(), -/// error: (err, stack) => const Text('error'), -/// ); -/// } -/// ``` -/// -/// - Connect a provider with another provider without having a direct reference on it. -/// -/// ```dart -/// final repositoryProvider = Provider.family>((ref, configurationsProvider) { -/// // Read a provider without knowing what that provider is. -/// final configurations = await ref.read(configurationsProvider.future); -/// return Repository(host: configurations.host); -/// }); -/// ``` -/// -/// ## Usage -/// -/// The way families works is by adding an extra parameter to the provider. -/// This parameter can then be freely used in our provider to create some state. -/// -/// For example, we could combine `family` with [FutureProvider] to fetch -/// a `Message` from its ID: -/// -/// ```dart -/// final messagesFamily = FutureProvider.family((ref, id) async { -/// return dio.get('http://my_api.dev/messages/$id'); -/// }); -/// ``` -/// -/// Then, when using our `messagesFamily` provider, the syntax is slightly modified. -/// The usual: -/// -/// ```dart -/// Widget build(BuildContext context, WidgetRef ref) { -/// // Error – messagesFamily is not a provider -/// final response = ref.watch(messagesFamily); -/// } -/// ``` -/// -/// will not work anymore. -/// Instead, we need to pass a parameter to `messagesFamily`: -/// -/// ```dart -/// Widget build(BuildContext context, WidgetRef ref) { -/// final response = ref.watch(messagesFamily('id')); -/// } -/// ``` -/// -/// **NOTE**: It is totally possible to use a family with different parameters -/// simultaneously. For example, we could use a `titleFamily` to read both -/// the french and english translations at the same time: -/// -/// ```dart -/// @override -/// Widget build(BuildContext context, WidgetRef ref) { -/// final frenchTitle = ref.watch(titleFamily(const Locale('fr'))); -/// final englishTitle = ref.watch(titleFamily(const Locale('en'))); -/// -/// return Text('fr: $frenchTitle en: $englishTitle'); -/// } -/// ``` -/// -/// # Parameter restrictions -/// -/// For families to work correctly, it is critical for the parameter passed to -/// a provider to have a consistent `hashCode` and `==`. -/// -/// Ideally the parameter should either be a primitive (bool/int/double/String), -/// a constant (providers), or an immutable object that override `==` and `hashCode`. -/// -/// -/// - **PREFER** using `family` in combination with `autoDispose` if the -/// parameter passed to providers is a complex object: -/// -/// ```dart -/// final example = Provider.autoDispose.family((ref, param) { -/// }); -/// ``` -/// -/// This ensures that there is no memory leak if the parameter changed and is -/// never used again. -/// -/// # Passing multiple parameters to a family -/// -/// Families have no built-in support for passing multiple values to a provider. -/// -/// On the other hand, that value could be _anything_ (as long as it matches with -/// the restrictions mentioned previously). -/// -/// This includes: -/// - A tuple (using `package:tuple`) -/// - Objects generated with Freezed/built_value -/// - Objects based on `package:equatable` -/// -/// This includes: -/// - A tuple (using `package:tuple`) -/// - Objects generated with Freezed/built_value, such as: -/// ```dart -/// @freezed -/// abstract class MyParameter with _$MyParameter { -/// factory MyParameter({ -/// required int userId, -/// required Locale locale, -/// }) = _MyParameter; -/// } -/// -/// final exampleProvider = Provider.family((ref, myParameter) { -/// print(myParameter.userId); -/// print(myParameter.locale); -/// // Do something with userId/locale -/// }); -/// -/// @override -/// Widget build(BuildContext context, WidgetRef ref) { -/// int userId; // Read the user ID from somewhere -/// final locale = Localizations.localeOf(context); -/// -/// final something = ref.watch( -/// exampleProvider(MyParameter(userId: userId, locale: locale)), -/// ); -/// } -/// ``` -/// -/// - Objects based on `package:equatable`, such as: -/// ```dart -/// class MyParameter extends Equatable { -/// factory MyParameter({ -/// required this.userId, -/// requires this.locale, -/// }); -/// -/// final int userId; -/// final Local locale; -/// -/// @override -/// List get props => [userId, locale]; -/// } -/// -/// final exampleProvider = Provider.family((ref, myParameter) { -/// print(myParameter.userId); -/// print(myParameter.locale); -/// // Do something with userId/locale -/// }); -/// -/// @override -/// Widget build(BuildContext context, WidgetRef ref) { -/// int userId; // Read the user ID from somewhere -/// final locale = Localizations.localeOf(context); -/// -/// final something = ref.watch( -/// exampleProvider(MyParameter(userId: userId, locale: locale)), -/// ); -/// } -/// ``` -/// {@endtemplate}'''; - -bool _didAddFamilyTemplate = false; - -String familyDoc() { - if (_didAddFamilyTemplate) { - return '/// {@macro riverpod.family}'; - } - _didAddFamilyTemplate = true; - return _familyDoc; +class _NotifierBuilder extends _Builder { + _NotifierBuilder( + super.providerName, { + required super.genericsDefinition, + required super.genericsUsage, + }); } +typedef Matrix = ({ + List<_DisposeType> disposeTypes, + List<_Builder> providers, + List<_ProviderKind> kinds, +}); + Future main(List args) async { if (args.length != 2) { - print('usage: generate_providers file'); + stdout.writeln( + 'usage: generate_providers file', + ); return; } if (args.first != 'riverpod' && args.first != 'flutter_riverpod') { - print('Unknown argument ${args.first}'); + stderr.writeln('Unknown argument ${args.first}'); return; } final file = File.fromUri(Uri.parse(args[1])); if (file.existsSync() && file.statSync().type != FileSystemEntityType.file) { - print('${args[1]} is not a file'); + stderr.writeln('${args[1]} is not a file'); return; } - Tuple3, List, List> matrix; - - final builder = StringBuffer( - ''' -// GENERATED CODE - DO NOT MODIFY BY HAND -// -// If you need to modify this file, instead update /tools/generate_providers/bin/generate_providers.dart -// -// You can install this utility by executing: -// dart pub global activate -s path /tools/generate_providers -// -// You can then use it in your terminal by executing: -// generate_providers - -''', - ); + Matrix matrix; + final buffer = StringBuffer(_header); switch (args.first) { case 'riverpod': - matrix = Tuple3( - DisposeType.values, - [ - StateDetails( - className: 'StateProvider', - ref: 'StateProviderRef', - constraints: 'State', - generics: 'State', - createType: 'State', + matrix = ( + disposeTypes: _DisposeType.values, + providers: [ + _FunctionalBuilder( + 'StateProvider', + genericsUsage: 'StateT', + genericsDefinition: 'StateT', + createdT: 'StateT', + refT: 'StateProviderRef', + ), + _FunctionalBuilder( + 'StateNotifierProvider', + genericsUsage: 'NotifierT, StateT', + genericsDefinition: + 'NotifierT extends StateNotifier, StateT', + createdT: 'NotifierT', + refT: 'StateNotifierProviderRef', ), - StateDetails( - className: 'StateNotifierProvider', - ref: 'StateNotifierProviderRef', - constraints: 'Notifier extends StateNotifier, State', - generics: 'Notifier, State', - createType: 'Notifier', + _FunctionalBuilder( + 'Provider', + genericsUsage: 'StateT', + genericsDefinition: 'StateT', + createdT: 'StateT', + refT: 'Ref', ), - StateDetails( - className: 'Provider', - ref: 'ProviderRef', - constraints: 'State', - generics: 'State', - createType: 'State', + _FunctionalBuilder( + 'FutureProvider', + genericsUsage: 'StateT', + genericsDefinition: 'StateT', + createdT: 'FutureOr', + refT: 'Ref>', ), - StateDetails( - className: 'FutureProvider', - ref: 'FutureProviderRef', - constraints: 'State', - generics: 'State', - createType: 'FutureOr', + _FunctionalBuilder( + 'StreamProvider', + genericsUsage: 'StateT', + genericsDefinition: 'StateT', + createdT: 'Stream', + refT: 'Ref>', ), - StateDetails( - className: 'StreamProvider', - ref: 'StreamProviderRef', - constraints: 'State', - generics: 'State', - createType: 'Stream', + _NotifierBuilder( + 'NotifierProvider', + genericsUsage: '', + genericsDefinition: ', StateT>', + ), + _NotifierBuilder( + 'StreamNotifierProvider', + genericsUsage: '', + genericsDefinition: + ', StateT>', + ), + _NotifierBuilder( + 'AsyncNotifierProvider', + genericsUsage: '', + genericsDefinition: + ', StateT>', ), ], - ProviderType.values, + kinds: _ProviderKind.values, ); - builder.writeln( + buffer.writeln( """ import 'dart:async'; + +import 'package:meta/meta.dart'; import 'package:state_notifier/state_notifier.dart'; import 'internals.dart'; +""", + ); -/// Builds a [AsyncNotifierProvider]. -class AsyncNotifierProviderBuilder { - /// Builds a [AsyncNotifierProvider]. - const AsyncNotifierProviderBuilder(); + case 'flutter_riverpod': + matrix = ( + disposeTypes: _DisposeType.values, + providers: [ + _FunctionalBuilder( + 'ChangeNotifierProvider', + genericsUsage: 'NotifierT', + genericsDefinition: 'NotifierT extends ChangeNotifier', + createdT: 'NotifierT', + refT: 'ChangeProviderRef', + ), + ], + kinds: _ProviderKind.values, + ); + buffer.writeln( + """ +import 'package:flutter/foundation.dart'; +import 'package:meta/meta.dart'; - /// {@macro riverpod.autoDispose} - AsyncNotifierProvider - call, T>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AsyncNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); +import 'internals.dart'; +""", + ); + default: + throw UnsupportedError('Unknown package ${args.first}'); } - /// {@macro riverpod.autoDispose} - AutoDisposeAsyncNotifierProviderBuilder get autoDispose { - return const AutoDisposeAsyncNotifierProviderBuilder(); - } + _generateAll(buffer, matrix); - /// {@macro riverpod.family} - AsyncNotifierProviderFamilyBuilder get family { - return const AsyncNotifierProviderFamilyBuilder(); - } + await file.writeAsString( + DartFormatter().format(buffer.toString()), + ); } -/// Builds a [AsyncNotifierProviderFamily]. -class AsyncNotifierProviderFamilyBuilder { - /// Builds a [AsyncNotifierProviderFamily]. - const AsyncNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - AsyncNotifierProviderFamily - call, T, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AsyncNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeAsyncNotifierProviderFamilyBuilder get autoDispose { - return const AutoDisposeAsyncNotifierProviderFamilyBuilder(); +void _generateAll(StringBuffer buffer, Matrix matrix) { + for (final provider in matrix.providers) { + for (final disposeType in matrix.disposeTypes) { + for (final kind in matrix.kinds) { + if (kind == _ProviderKind.orphan && + disposeType == _DisposeType.keepAlive) { + // That's handled by the provider itself + continue; + } + + switch (provider) { + case _NotifierBuilder(): + _generateNotifierOrphan(buffer, disposeType, provider, kind); + case _FunctionalBuilder(): + switch (kind) { + case _ProviderKind.orphan: + _generateFunctionalOrphan(buffer, disposeType, provider); + case _ProviderKind.family: + _generateFunctionalFamily(buffer, disposeType, provider); + } + } + } + } } } -/// Builds a [AutoDisposeAsyncNotifierProvider]. -class AutoDisposeAsyncNotifierProviderBuilder { - /// Builds a [AutoDisposeAsyncNotifierProvider]. - const AutoDisposeAsyncNotifierProviderBuilder(); +void _generateFunctionalFamily( + StringBuffer buffer, + _DisposeType disposeType, + _FunctionalBuilder provider, +) { + final builderName = _builderName( + provider, + disposeType, + kind: _ProviderKind.family, + ); + + buffer.writeln(''' +@internal +class $builderName { + const $builderName(); - /// {@macro riverpod.autoDispose} - AutoDisposeAsyncNotifierProvider - call, T>( - NotifierT Function() create, { + $familyDoc + ${provider.providerName}Family<${provider.genericsUsage}, ArgT> call<${provider.genericsDefinition}, ArgT>( + ${provider.createdT} Function(${provider.refT} ref, ArgT param) create, { String? name, Iterable? dependencies, }) { - return AutoDisposeAsyncNotifierProvider( + return ${provider.providerName}Family<${provider.genericsUsage}, ArgT>( create, name: name, + ${_isAutoDisposeParam(disposeType)} dependencies: dependencies, ); } - /// {@macro riverpod.family} - AutoDisposeAsyncNotifierProviderFamilyBuilder get family { - return const AutoDisposeAsyncNotifierProviderFamilyBuilder(); - } + ${_autoDisposeModifier(provider, disposeType, _ProviderKind.family)} } - -/// Builds a [AutoDisposeAsyncNotifierProviderFamily]. -class AutoDisposeAsyncNotifierProviderFamilyBuilder { - /// Builds a [AutoDisposeAsyncNotifierProviderFamily]. - const AutoDisposeAsyncNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - AutoDisposeAsyncNotifierProviderFamily - call, T, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeAsyncNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } +'''); } -/// Builds a [NotifierProvider]. -class NotifierProviderBuilder { - /// Builds a [NotifierProvider]. - const NotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - NotifierProvider - call, State>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return NotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeNotifierProviderBuilder get autoDispose { - return const AutoDisposeNotifierProviderBuilder(); - } - - /// {@macro riverpod.family} - NotifierProviderFamilyBuilder get family { - return const NotifierProviderFamilyBuilder(); - } -} +void _generateFunctionalOrphan( + StringBuffer buffer, + _DisposeType disposeType, + _FunctionalBuilder provider, +) { + final builderName = _builderName( + provider, + disposeType, + ); -/// Builds a [NotifierProviderFamily]. -class NotifierProviderFamilyBuilder { - /// Builds a [NotifierProviderFamily]. - const NotifierProviderFamilyBuilder(); + buffer.writeln(''' +@internal +class $builderName { + const $builderName(); - /// {@macro riverpod.family} - NotifierProviderFamily - call, State, Arg>( - NotifierT Function() create, { + $familyDoc + ${provider.providerName}<${provider.genericsUsage}> call<${provider.genericsDefinition}>( + ${provider.createdT} Function(${provider.refT} ref) create, { String? name, Iterable? dependencies, }) { - return NotifierProviderFamily( + return ${provider.providerName}<${provider.genericsUsage}>( create, name: name, + ${_isAutoDisposeParam(disposeType)} dependencies: dependencies, ); } - /// {@macro riverpod.autoDispose} - AutoDisposeNotifierProviderFamilyBuilder get autoDispose { - return const AutoDisposeNotifierProviderFamilyBuilder(); - } + ${_familyModifier(provider, disposeType, _ProviderKind.orphan)} + ${_autoDisposeModifier(provider, disposeType, _ProviderKind.orphan)} +} +'''); } -/// Builds a [AutoDisposeNotifierProvider]. -class AutoDisposeNotifierProviderBuilder { - /// Builds a [AutoDisposeNotifierProvider]. - const AutoDisposeNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - AutoDisposeNotifierProvider - call, State>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); +String _builderName( + _Builder provider, + _DisposeType disposeType, { + _ProviderKind kind = _ProviderKind.orphan, +}) { + var builderName = 'Builder'; + if (kind == _ProviderKind.family) { + builderName = 'Family$builderName'; } - - /// {@macro riverpod.family} - AutoDisposeNotifierProviderFamilyBuilder get family { - return const AutoDisposeNotifierProviderFamilyBuilder(); + builderName = '${provider.providerName}$builderName'; + if (disposeType == _DisposeType.autoDispose) { + builderName = 'AutoDispose$builderName'; } + return builderName; } -/// Builds a [AutoDisposeNotifierProviderFamily]. -class AutoDisposeNotifierProviderFamilyBuilder { - /// Builds a [AutoDisposeNotifierProviderFamily]. - const AutoDisposeNotifierProviderFamilyBuilder(); +String _autoDisposeModifier( + _Builder provider, + _DisposeType disposeType, + _ProviderKind kind, +) { + if (disposeType == _DisposeType.autoDispose) return ''; + + final targetBuilder = _builderName( + provider, + _DisposeType.autoDispose, + kind: kind, + ); - /// {@macro riverpod.family} - AutoDisposeNotifierProviderFamily - call, State, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } + return ''' + $autoDisposeDoc + $targetBuilder get autoDispose => const $targetBuilder(); +'''; } -/// Builds a [StreamNotifierProvider]. -class StreamNotifierProviderBuilder { - /// Builds a [StreamNotifierProvider]. - const StreamNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - StreamNotifierProvider - call, T>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return StreamNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeStreamNotifierProviderBuilder get autoDispose { - return const AutoDisposeStreamNotifierProviderBuilder(); - } +String _familyModifier( + _Builder provider, + _DisposeType disposeType, + _ProviderKind kind, +) { + if (kind == _ProviderKind.family) return ''; + + final targetBuilder = _builderName( + provider, + disposeType, + kind: _ProviderKind.family, + ); - /// {@macro riverpod.family} - StreamNotifierProviderFamilyBuilder get family { - return const StreamNotifierProviderFamilyBuilder(); - } + return ''' + $familyDoc + $targetBuilder get family => const $targetBuilder(); +'''; } -/// Builds a [StreamNotifierProviderFamily]. -class StreamNotifierProviderFamilyBuilder { - /// Builds a [StreamNotifierProviderFamily]. - const StreamNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - StreamNotifierProviderFamily - call, T, Arg>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return StreamNotifierProviderFamily( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeStreamNotifierProviderFamilyBuilder get autoDispose { - return const AutoDisposeStreamNotifierProviderFamilyBuilder(); +String _isAutoDisposeParam(_DisposeType disposeType) { + if (disposeType == _DisposeType.autoDispose) { + return 'isAutoDispose: true,'; } + return ''; } -/// Builds a [AutoDisposeStreamNotifierProvider]. -class AutoDisposeStreamNotifierProviderBuilder { - /// Builds a [AutoDisposeStreamNotifierProvider]. - const AutoDisposeStreamNotifierProviderBuilder(); - - /// {@macro riverpod.autoDispose} - AutoDisposeStreamNotifierProvider - call, T>( - NotifierT Function() create, { - String? name, - Iterable? dependencies, - }) { - return AutoDisposeStreamNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.family} - AutoDisposeStreamNotifierProviderFamilyBuilder get family { - return const AutoDisposeStreamNotifierProviderFamilyBuilder(); - } -} +void _generateNotifierOrphan( + StringBuffer buffer, + _DisposeType disposeType, + _NotifierBuilder provider, + _ProviderKind kind, +) { + final builderName = _builderName( + provider, + disposeType, + kind: kind, + ); -/// Builds a [AutoDisposeStreamNotifierProviderFamily]. -class AutoDisposeStreamNotifierProviderFamilyBuilder { - /// Builds a [AutoDisposeStreamNotifierProviderFamily]. - const AutoDisposeStreamNotifierProviderFamilyBuilder(); + buffer.writeln(''' +@internal +class $builderName { + const $builderName(); - /// {@macro riverpod.family} - AutoDisposeStreamNotifierProviderFamily - call, T, Arg>( + $autoDisposeDoc + ${provider.providerName}${provider.genericsUsage} call${provider.genericsDefinition}( NotifierT Function() create, { String? name, Iterable? dependencies, }) { - return AutoDisposeStreamNotifierProviderFamily( + return ${provider.providerName}${provider.genericsUsage}( create, name: name, + ${_isAutoDisposeParam(disposeType)} dependencies: dependencies, ); } -} -""", - ); - break; - case 'flutter_riverpod': - matrix = Tuple3( - DisposeType.values, - [ - StateDetails( - className: 'ChangeNotifierProvider', - ref: 'ChangeNotifierProviderRef', - constraints: 'Notifier extends ChangeNotifier?', - generics: 'Notifier', - createType: 'Notifier', - ), - ], - ProviderType.values, - ); - builder.writeln( - """ -import 'package:flutter/foundation.dart'; -import 'internals.dart'; -""", - ); - break; - default: - throw UnsupportedError('Unknown package ${args.first}'); - } - - builder.writeAll(generateAll(matrix), '\n'); - - await file.writeAsString( - DartFormatter().format(builder.toString()), - ); -} - -Iterable generateAll( - Tuple3, List, List> matrix, -) sync* { - final combos = Combinations(3, [ - ...matrix.item1, - ...matrix.item2, - ...matrix.item3, - ]); - for (final permutation in combos()) { - final first = permutation.first; - final second = permutation[1]; - final third = permutation[2]; - - if (first is DisposeType && - second is StateDetails && - third is ProviderType) { - yield* generate(Tuple3(first, second, third), matrix); - } - } -} - -extension on Tuple3 { - String get providerName { - return '${disposeLabel[item1]}${item2.className}${providerLabel[item3]}'; - } - - String get ref { - switch (item1) { - case DisposeType.autoDispose: - return 'AutoDispose${item2.ref}'; - case DisposeType.none: - default: - return item2.ref; - } - } - - String get constraint => item2.constraints; - - String get createType => item2.createType; - - String links( - Tuple3, List, List> matrix, - ) { - Iterable other() sync* { - if (item1 == DisposeType.none) { - yield ''' - -${autoDisposeDoc().replaceAll('///', ' ///')} - AutoDispose${providerName}Builder get autoDispose { - return const AutoDispose${providerName}Builder(); - }'''; - } - - if (item3 == ProviderType.single) { - yield ''' - -${familyDoc().replaceAll('///', ' ///')} - ${providerName}FamilyBuilder get family { - return const ${providerName}FamilyBuilder(); - }'''; - } - } - - return other().join('\n'); - } -} - -Iterable generate( - Tuple3 configs, - Tuple3, List, List> matrix, -) sync* { - if (configs.item3 == ProviderType.family) { - yield FamilyBuilder(configs, matrix); - } else { - yield ProviderBuilder(configs, matrix); - } -} - -class FamilyBuilder { - FamilyBuilder(this.configs, this.matrix); - final Tuple3 configs; - final Tuple3, List, List> - matrix; - - @override - String toString() { - final createNamedParams = [ - 'String? name', - 'Iterable? dependencies', - ].map((e) => '$e,').join(); - final providerParams = [ - 'create', - 'name: name', - 'dependencies: dependencies', - ].map((e) => '$e,').join(); - return ''' -/// Builds a [${configs.providerName}]. -class ${configs.providerName}Builder { - /// Builds a [${configs.providerName}]. - const ${configs.providerName}Builder(); - -${familyDoc().replaceAll('///', ' ///')} - ${configs.providerName}<${configs.item2.generics}, Arg> call<${configs.constraint}, Arg>( - FamilyCreate<${configs.createType}, ${configs.ref}, Arg> create, { $createNamedParams }) { - return ${configs.providerName}<${configs.item2.generics}, Arg>($providerParams); - } -${configs.links(matrix)} -} -'''; - } -} -class ProviderBuilder { - ProviderBuilder(this.configs, this.matrix); - final Tuple3 configs; - final Tuple3, List, List> - matrix; - - @override - String toString() { - final callNamedParams = [ - 'String? name', - 'Iterable? dependencies', - ].map((e) => '$e,').join(); - final providerParams = [ - 'create', - 'name: name', - 'dependencies: dependencies', - ].map((e) => '$e,').join(); - - return ''' -/// Builds a [${configs.providerName}]. -class ${configs.providerName}Builder { - /// Builds a [${configs.providerName}]. - const ${configs.providerName}Builder(); - -${autoDisposeDoc().replaceAll('///', ' ///')} - ${configs.providerName}<${configs.item2.generics}> call<${configs.constraint}>( - Create<${configs.createType}, ${configs.ref}> create, { $callNamedParams }) { - return ${configs.providerName}<${configs.item2.generics}>($providerParams); - } -${configs.links(matrix)} + ${_familyModifier(provider, disposeType, kind)} + ${_autoDisposeModifier(provider, disposeType, kind)} } -'''; - } +'''); } diff --git a/tools/generate_providers/pubspec.yaml b/tools/generate_providers/pubspec.yaml index ab6a1bc59..e086bf931 100644 --- a/tools/generate_providers/pubspec.yaml +++ b/tools/generate_providers/pubspec.yaml @@ -2,12 +2,11 @@ name: generate_providers publish_to: "none" environment: - sdk: ">=2.19.0 <4.0.0" + sdk: ">=3.0.0 <4.0.0" dependencies: dart_style: ^2.0.0 trotter: ^2.0.0 - tuple: ^2.0.0 executables: generate_providers: \ No newline at end of file diff --git a/tools/generate_providers/src/docs.dart b/tools/generate_providers/src/docs.dart new file mode 100644 index 000000000..43f28a444 --- /dev/null +++ b/tools/generate_providers/src/docs.dart @@ -0,0 +1,280 @@ +final _writtenDocs = {}; + +String _docs(String doc, {required String key}) { + if (!_writtenDocs.add(key)) { + return '/// {@macro $key}'; + } + + return ''' +/// {@template $key} +$doc +/// {@endtemplate}'''; +} + +String get autoDisposeDoc => _docs( + _autoDisposeDoc, + key: 'riverpod.autoDispose', + ); + +const _autoDisposeDoc = ''' +/// Marks the provider as automatically disposed when no longer listened to. +/// +/// Some typical use-cases: +/// +/// - Combined with [StreamProvider], this can be used as a mean to keep +/// the connection with Firebase alive only when truly needed (to reduce costs). +/// - Automatically reset a form state when leaving the screen. +/// - Automatically retry HTTP requests that failed when the user exit and +/// re-enter the screen. +/// - Cancel HTTP requests if the user leaves a screen before the request completed. +/// +/// Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. +/// +/// The `keepAlive` function is used to tell Riverpod that the state of the provider +/// should be preserved even if no longer listened to. +/// +/// A use-case would be to set this flag to `true` after an HTTP request have +/// completed: +/// +/// ```dart +/// final myProvider = FutureProvider.autoDispose((ref) async { +/// final response = await httpClient.get(...); +/// ref.keepAlive(); +/// return response; +/// }); +/// ``` +/// +/// This way, if the request failed and the UI leaves the screen then re-enters +/// it, then the request will be performed again. +/// But if the request completed successfully, the state will be preserved +/// and re-entering the screen will not trigger a new request. +/// +/// It can be combined with `ref.onDispose` for more advanced behaviors, such +/// as cancelling pending HTTP requests when the user leaves a screen. +/// For example, modifying our previous snippet and using `dio`, we would have: +/// +/// ```diff +/// final myProvider = FutureProvider.autoDispose((ref) async { +/// + final cancelToken = CancelToken(); +/// + ref.onDispose(() => cancelToken.cancel()); +/// +/// + final response = await dio.get('path', cancelToken: cancelToken); +/// - final response = await dio.get('path'); +/// ref.keepAlive(); +/// return response; +/// }); +/// ```'''; + +String get familyDoc => _docs( + _familyDoc, + key: 'riverpod.family', + ); + +const _familyDoc = r''' +/// A group of providers that builds their value from an external parameter. +/// +/// Families can be useful to connect a provider with values that it doesn't +/// have access to. For example: +/// +/// - Allowing a "title provider" access the `Locale` +/// +/// ```dart +/// final titleFamily = Provider.family((ref, locale) { +/// if (locale == const Locale('en')) { +/// return 'English title'; +/// } else if (locale == const Locale('fr')) { +/// return 'Titre Français'; +/// } +/// }); +/// +/// // ... +/// +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// final locale = Localizations.localeOf(context); +/// +/// // Obtains the title based on the current Locale. +/// // Will automatically update the title when the Locale changes. +/// final title = ref.watch(titleFamily(locale)); +/// +/// return Text(title); +/// } +/// ``` +/// +/// - Have a "user provider" that receives the user ID as a parameter +/// +/// ```dart +/// final userFamily = FutureProvider.family((ref, userId) async { +/// final userRepository = ref.read(userRepositoryProvider); +/// return await userRepository.fetch(userId); +/// }); +/// +/// // ... +/// +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// int userId; // Read the user ID from somewhere +/// +/// // Read and potentially fetch the user with id `userId`. +/// // When `userId` changes, this will automatically update the UI +/// // Similarly, if two widgets tries to read `userFamily` with the same `userId` +/// // then the user will be fetched only once. +/// final user = ref.watch(userFamily(userId)); +/// +/// return user.when( +/// data: (user) => Text(user.name), +/// loading: () => const CircularProgressIndicator(), +/// error: (err, stack) => const Text('error'), +/// ); +/// } +/// ``` +/// +/// - Connect a provider with another provider without having a direct reference on it. +/// +/// ```dart +/// final repositoryProvider = Provider.family>((ref, configurationsProvider) { +/// // Read a provider without knowing what that provider is. +/// final configurations = await ref.read(configurationsProvider.future); +/// return Repository(host: configurations.host); +/// }); +/// ``` +/// +/// ## Usage +/// +/// The way families works is by adding an extra parameter to the provider. +/// This parameter can then be freely used in our provider to create some state. +/// +/// For example, we could combine `family` with [FutureProvider] to fetch +/// a `Message` from its ID: +/// +/// ```dart +/// final messagesFamily = FutureProvider.family((ref, id) async { +/// return dio.get('http://my_api.dev/messages/$id'); +/// }); +/// ``` +/// +/// Then, when using our `messagesFamily` provider, the syntax is slightly modified. +/// The usual: +/// +/// ```dart +/// Widget build(BuildContext context, WidgetRef ref) { +/// // Error – messagesFamily is not a provider +/// final response = ref.watch(messagesFamily); +/// } +/// ``` +/// +/// will not work anymore. +/// Instead, we need to pass a parameter to `messagesFamily`: +/// +/// ```dart +/// Widget build(BuildContext context, WidgetRef ref) { +/// final response = ref.watch(messagesFamily('id')); +/// } +/// ``` +/// +/// **NOTE**: It is totally possible to use a family with different parameters +/// simultaneously. For example, we could use a `titleFamily` to read both +/// the french and english translations at the same time: +/// +/// ```dart +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// final frenchTitle = ref.watch(titleFamily(const Locale('fr'))); +/// final englishTitle = ref.watch(titleFamily(const Locale('en'))); +/// +/// return Text('fr: $frenchTitle en: $englishTitle'); +/// } +/// ``` +/// +/// # Parameter restrictions +/// +/// For families to work correctly, it is critical for the parameter passed to +/// a provider to have a consistent `hashCode` and `==`. +/// +/// Ideally the parameter should either be a primitive (bool/int/double/String), +/// a constant (providers), or an immutable object that override `==` and `hashCode`. +/// +/// +/// - **PREFER** using `family` in combination with `autoDispose` if the +/// parameter passed to providers is a complex object: +/// +/// ```dart +/// final example = Provider.autoDispose.family((ref, param) { +/// }); +/// ``` +/// +/// This ensures that there is no memory leak if the parameter changed and is +/// never used again. +/// +/// # Passing multiple parameters to a family +/// +/// Families have no built-in support for passing multiple values to a provider. +/// +/// On the other hand, that value could be _anything_ (as long as it matches with +/// the restrictions mentioned previously). +/// +/// This includes: +/// - A tuple (using `package:tuple`) +/// - Objects generated with Freezed/built_value +/// - Objects based on `package:equatable` +/// +/// This includes: +/// - A tuple (using `package:tuple`) +/// - Objects generated with Freezed/built_value, such as: +/// ```dart +/// @freezed +/// abstract class MyParameter with _$MyParameter { +/// factory MyParameter({ +/// required int userId, +/// required Locale locale, +/// }) = _MyParameter; +/// } +/// +/// final exampleProvider = Provider.family((ref, myParameter) { +/// print(myParameter.userId); +/// print(myParameter.locale); +/// // Do something with userId/locale +/// }); +/// +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// int userId; // Read the user ID from somewhere +/// final locale = Localizations.localeOf(context); +/// +/// final something = ref.watch( +/// exampleProvider(MyParameter(userId: userId, locale: locale)), +/// ); +/// } +/// ``` +/// +/// - Objects based on `package:equatable`, such as: +/// ```dart +/// class MyParameter extends Equatable { +/// factory MyParameter({ +/// required this.userId, +/// requires this.locale, +/// }); +/// +/// final int userId; +/// final Local locale; +/// +/// @override +/// List get props => [userId, locale]; +/// } +/// +/// final exampleProvider = Provider.family((ref, myParameter) { +/// print(myParameter.userId); +/// print(myParameter.locale); +/// // Do something with userId/locale +/// }); +/// +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// int userId; // Read the user ID from somewhere +/// final locale = Localizations.localeOf(context); +/// +/// final something = ref.watch( +/// exampleProvider(MyParameter(userId: userId, locale: locale)), +/// ); +/// } +/// ```'''; From 4f957bbd9323035d4a4331607ba493b5f6a6a69f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 21 Jan 2024 00:53:57 +0100 Subject: [PATCH 128/387] Update Notifier --- packages/riverpod/lib/riverpod.dart | 6 +- packages/riverpod/lib/src/core/element.dart | 8 +- .../src/providers/async_notifier/family.dart | 2 +- .../riverpod/lib/src/providers/notifier.dart | 100 ++------ .../src/providers/notifier/auto_dispose.dart | 129 ---------- .../notifier/auto_dispose_family.dart | 130 ---------- .../lib/src/providers/notifier/base.dart | 241 ------------------ .../lib/src/providers/notifier/family.dart | 144 +++++------ .../lib/src/providers/notifier/orphan.dart | 198 ++++++++++++++ packages/riverpod/test/meta_test.dart | 2 + .../legacy_providers/notifier/factory.dart | 18 +- .../lib/riverpod_annotation.dart | 2 +- .../protected_notifier_properties.g.dart | 2 +- 13 files changed, 308 insertions(+), 674 deletions(-) delete mode 100644 packages/riverpod/lib/src/providers/notifier/auto_dispose.dart delete mode 100644 packages/riverpod/lib/src/providers/notifier/auto_dispose_family.dart delete mode 100644 packages/riverpod/lib/src/providers/notifier/base.dart create mode 100644 packages/riverpod/lib/src/providers/notifier/orphan.dart diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index bc3d2ae55..bedaeabe9 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -65,12 +65,12 @@ export 'src/providers/async_notifier.dart' export 'src/providers/future_provider.dart'; export 'src/providers/notifier.dart' hide - NotifierBase, - NotifierProviderBase, + _NotifierBase, + _NotifierProviderBase, AutoDisposeFamilyNotifierProviderImpl, AutoDisposeNotifierProviderImpl, FamilyNotifierProviderImpl, - NotifierProviderImpl, + NotifierProvider, BuildlessAutoDisposeNotifier, BuildlessNotifier; export 'src/providers/provider.dart' hide InternalProvider; diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index c92a2db81..c0715ac7e 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -51,14 +51,18 @@ abstract class ProviderElementBase implements Ref, Node { static ProviderElementBase? _debugCurrentlyBuildingElement; + @override + State get state => readSelf(); + + @override + set state(State newState) => setState(newState); + /// The last result of [ProviderBase.debugGetCreateSourceHash]. /// /// Available only in debug mode. String? _debugCurrentCreateHash; var _debugSkipNotifyListenersAsserts = false; - _Foo? get foo => null; - /// The provider associated with this [ProviderElementBase], before applying overrides. // Not typed as because of https://github.com/rrousselGit/riverpod/issues/1100 ProviderBase get origin => _origin; diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index 3168d8d95..b3aefa9a3 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -102,10 +102,10 @@ class AsyncNotifierProviderFamily< // super._createFn, { super.name, super.dependencies, - super.isAutoDispose = false, }) : super( providerFactory: FamilyAsyncNotifierProvider._, debugGetCreateSourceHash: null, + isAutoDispose: false, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), ); diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index bcf138604..bf05e9ef6 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -1,25 +1,18 @@ +import 'dart:async'; + import 'package:meta/meta.dart'; -import '../common/listenable.dart'; -import '../common/result.dart'; +import '../builder.dart'; import '../framework.dart'; import 'async_notifier.dart'; -import 'provider.dart'; -part 'notifier/auto_dispose.dart'; -part 'notifier/auto_dispose_family.dart'; -part 'notifier/base.dart'; +part 'notifier/orphan.dart'; part 'notifier/family.dart'; -/// A base class for [NotifierBase]. +/// A base class for [_NotifierBase]. /// /// Not meant for public consumption. -@internal -abstract class NotifierBase { - NotifierProviderElement, State>? get _element; - - void _setElement(ProviderElementBase? element); - +abstract class _NotifierBase extends ClassBase { /// The value currently exposed by this [Notifier]. /// /// If used inside [Notifier.build], may throw if the notifier is not yet initialized. @@ -31,15 +24,10 @@ abstract class NotifierBase { /// dependency has changed) will trigger [Notifier.build] to be re-executed. /// /// If [Notifier.build] threw, reading [state] will rethrow the exception. + @override @protected @visibleForTesting - State get state { - final element = _element; - if (element == null) throw StateError(uninitializedElementError); - - element.flush(); - return element.requireState; - } + StateT get state; /// The value currently exposed by this [Notifier]. /// @@ -53,27 +41,14 @@ abstract class NotifierBase { /// dependency has changed) will trigger [Notifier.build] to be re-executed. @protected @visibleForTesting - State? get stateOrNull { - final element = _element; + StateT? get stateOrNull { + final element = this.element; if (element == null) throw StateError(uninitializedElementError); element.flush(); return element.getState()?.stateOrNull; } - @protected - @visibleForTesting - set state(State value) { - final element = _element; - if (element == null) throw StateError(uninitializedElementError); - - element.setState(value); - } - - /// The [Ref] from the provider associated with this [Notifier]. - @protected - Ref get ref; - /// A method invoked when the state exposed by this [Notifier] changes. /// It compares the previous and new value, and return whether listeners /// should be notified. @@ -100,36 +75,21 @@ abstract class NotifierBase { /// /// If you do not want that, you can override this method to perform a deep /// comparison of the previous and new values. - @protected - bool updateShouldNotify(State previous, State next) { + @override + @visibleForOverriding + bool updateShouldNotify(StateT previous, StateT next) { // TODO unify updateShouldNotify to use == or identical everywhere return !identical(previous, next); } } -ProviderElementProxy - _notifier, T>( - NotifierProviderBase that, -) { - return ProviderElementProxy( - that, - (element) { - return (element as NotifierProviderElement) - ._notifierNotifier; - }, - ); -} - -/// An internal base class for [Notifier]. -/// -/// Not meant for public consumption. -@internal -abstract base class NotifierProviderBase, T> - extends ProviderBase { +abstract base class _NotifierProvider // + , StateT> + extends ClassProvider> { /// An internal base class for [Notifier]. /// /// Not meant for public consumption. - const NotifierProviderBase( + const _NotifierProvider( this._createNotifier, { required super.name, required super.from, @@ -138,31 +98,11 @@ abstract base class NotifierProviderBase, T> required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, required super.isAutoDispose, + required super.runNotifierBuildOverride, }); - /// Obtains the [Notifier] associated with this provider, without listening - /// to state changes. - /// - /// This is typically used to invoke methods on a [Notifier]. For example: - /// - /// ```dart - /// Button( - /// onTap: () => ref.read(stateNotifierProvider.notifier).increment(), - /// ) - /// ``` - /// - /// This listenable will notify its notifiers if the [Notifier] instance - /// changes. - /// This may happen if the provider is refreshed or one of its dependencies - /// has changes. - ProviderListenable get notifier; - final NotifierT Function() _createNotifier; - /// Runs the `build` method of a notifier. - /// - /// This is an implementation detail for differentiating [Notifier.build] - /// from [FamilyNotifier.build]. - @visibleForOverriding - T runNotifierBuild(NotifierBase notifier); + @override + NotifierT create() => _createNotifier(); } diff --git a/packages/riverpod/lib/src/providers/notifier/auto_dispose.dart b/packages/riverpod/lib/src/providers/notifier/auto_dispose.dart deleted file mode 100644 index b851442cd..000000000 --- a/packages/riverpod/lib/src/providers/notifier/auto_dispose.dart +++ /dev/null @@ -1,129 +0,0 @@ -part of '../notifier.dart'; - -/// An [AutoDisposeNotifier] base class shared between family and non-family notifiers. -/// -/// Not meant for public consumption outside of riverpod_generator -@internal -abstract class BuildlessAutoDisposeNotifier extends NotifierBase { - @override - AutoDisposeNotifierProviderElement, State>? _element; - - @override - void _setElement(ProviderElementBase? element) { - if (_element != null && element != null) { - throw StateError(alreadyInitializedError); - } - _element = element - as AutoDisposeNotifierProviderElement, State>?; - } - - @override - AutoDisposeNotifierProviderRef get ref { - final element = _element; - if (element == null) throw StateError(uninitializedElementError); - - return element; - } -} - -/// {@macro riverpod.notifier} -/// -/// {@macro riverpod.notifier_provider_modifier} -abstract class AutoDisposeNotifier - extends BuildlessAutoDisposeNotifier { - /// {@macro riverpod.async_notifier.build} - @visibleForOverriding - State build(); -} - -/// {@macro riverpod.provider_ref_base} -abstract class AutoDisposeNotifierProviderRef - implements NotifierProviderRef, AutoDisposeRef {} - -/// {@macro riverpod.notifier_provider} -/// -/// {@macro riverpod.notifier_provider_modifier} -typedef AutoDisposeNotifierProvider, T> - = AutoDisposeNotifierProviderImpl; - -/// The implementation of [AutoDisposeNotifierProvider] but with loosened type constraints -/// that can be shared with [NotifierProvider]. -/// -/// This enables tests to execute on both [AutoDisposeNotifierProvider] and -/// [NotifierProvider] at the same time. -@internal -class AutoDisposeNotifierProviderImpl, T> - extends NotifierProviderBase { - /// {@macro riverpod.notifier_provider} - /// - /// {@macro riverpod.notifier_provider_modifier} - AutoDisposeNotifierProviderImpl( - super._createNotifier, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - AutoDisposeNotifierProviderImpl.internal( - super._createNotifier, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.family} - static const family = AutoDisposeNotifierProviderFamily.new; - - @override - late final Refreshable notifier = _notifier(this); - - @override - AutoDisposeNotifierProviderElement createElement( - ProviderContainer container, - ) { - return AutoDisposeNotifierProviderElement(this, container); - } - - @override - @mustBeOverridden - T runNotifierBuild(NotifierBase notifier) { - return (notifier as AutoDisposeNotifier).build(); - } - - /// {@macro riverpod.override_with} - @mustBeOverridden - Override overrideWith(NotifierT Function() create) { - return ProviderOverride( - origin: this, - providerOverride: AutoDisposeNotifierProviderImpl.internal( - create, - from: from, - argument: argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), - ); - } -} - -/// The element of [AutoDisposeNotifierProvider] -class AutoDisposeNotifierProviderElement, T> - extends NotifierProviderElement - with AutoDisposeProviderElementMixin - implements AutoDisposeNotifierProviderRef { - /// The [ProviderElementBase] for [NotifierProvider] - @internal - AutoDisposeNotifierProviderElement(super.provider, super.container); -} diff --git a/packages/riverpod/lib/src/providers/notifier/auto_dispose_family.dart b/packages/riverpod/lib/src/providers/notifier/auto_dispose_family.dart deleted file mode 100644 index 7215d63cf..000000000 --- a/packages/riverpod/lib/src/providers/notifier/auto_dispose_family.dart +++ /dev/null @@ -1,130 +0,0 @@ -part of '../notifier.dart'; - -/// {@macro riverpod.notifier} -/// -/// {@macro riverpod.notifier_provider_modifier} -abstract class AutoDisposeFamilyNotifier - extends BuildlessAutoDisposeNotifier { - /// {@macro riverpod.notifier.family_arg} - late final Arg arg; - - @override - void _setElement(ProviderElementBase? element) { - super._setElement(element); - if (element != null) { - arg = element.origin.argument as Arg; - } - } - - /// {@macro riverpod.async_notifier.build} - @visibleForOverriding - State build(Arg arg); -} - -/// {@macro riverpod.notifier_provider} -/// -/// {@macro riverpod.notifier_provider_modifier} -typedef AutoDisposeFamilyNotifierProvider< - NotifierT extends AutoDisposeFamilyNotifier, T, Arg> - = AutoDisposeFamilyNotifierProviderImpl; - -/// The implementation of [AutoDisposeNotifierProvider] but with loosened type constraints -/// that can be shared with [NotifierProvider]. -/// -/// This enables tests to execute on both [AutoDisposeNotifierProvider] and -/// [NotifierProvider] at the same time. -@internal -class AutoDisposeFamilyNotifierProviderImpl, - T, Arg> extends NotifierProviderBase { - /// {@macro riverpod.notifier_provider} - /// - /// {@macro riverpod.notifier_provider_modifier} - AutoDisposeFamilyNotifierProviderImpl( - super._createNotifier, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - AutoDisposeFamilyNotifierProviderImpl.internal( - super._createNotifier, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - @override - late final Refreshable notifier = _notifier(this); - - @override - AutoDisposeNotifierProviderElement createElement( - ProviderContainer container, - ) { - return AutoDisposeNotifierProviderElement(this, container); - } - - @override - T runNotifierBuild( - covariant AutoDisposeFamilyNotifier notifier, - ) { - return notifier.build(notifier.arg); - } -} - -/// The [Family] of [NotifierProvider]. -class AutoDisposeNotifierProviderFamily< - NotifierT extends AutoDisposeFamilyNotifier, T, Arg> - extends AutoDisposeNotifierFamilyBase, T, - Arg, NotifierT, AutoDisposeFamilyNotifierProvider> { - /// The [Family] of [AutoDisposeNotifierProvider]. - AutoDisposeNotifierProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: AutoDisposeFamilyNotifierProvider.internal, - debugGetCreateSourceHash: null, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - ); - - /// An implementation detail of Riverpod - @internal - AutoDisposeNotifierProviderFamily.internal( - super._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - }) : super(providerFactory: AutoDisposeFamilyNotifierProvider.internal); - - /// {@macro riverpod.override_with} - Override overrideWith(NotifierT Function() create) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as AutoDisposeFamilyNotifierProvider; - - return AutoDisposeFamilyNotifierProvider.internal( - create, - from: from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} diff --git a/packages/riverpod/lib/src/providers/notifier/base.dart b/packages/riverpod/lib/src/providers/notifier/base.dart deleted file mode 100644 index 2108cc018..000000000 --- a/packages/riverpod/lib/src/providers/notifier/base.dart +++ /dev/null @@ -1,241 +0,0 @@ -part of '../notifier.dart'; - -/// A [Notifier] base class shared between family and non-family notifiers. -/// -/// Not meant for public consumption outside of riverpod_generator -@internal -abstract class BuildlessNotifier extends NotifierBase { - @override - NotifierProviderElement, State>? _element; - - @override - void _setElement(ProviderElementBase? element) { - if (_element != null && element != null) { - throw StateError(alreadyInitializedError); - } - _element = element as NotifierProviderElement, State>?; - } - - @override - NotifierProviderRef get ref { - final element = _element; - if (element == null) throw StateError(uninitializedElementError); - - return element; - } -} - -/// {@template riverpod.notifier} -/// A class which exposes a state that can change over time. -/// -/// For example, [Notifier] can be used to implement a counter by doing: -/// -/// ```dart -/// final counterProvider = NotifierProvider(Counter.new); -/// -/// class Counter extends Notifier { -/// @override -/// int build() { -/// // Inside "build", we return the initial state of the counter. -/// return 0; -/// } -/// -/// void increment() { -/// state++; -/// } -/// } -/// ``` -/// -/// We can then listen to the counter inside widgets by doing: -/// -/// ```dart -/// Consumer( -/// builder: (context, ref) { -/// return Text('count: ${ref.watch(counterProvider)}'); -/// }, -/// ) -/// ``` -/// -/// And finally, we can update the counter by doing: -/// -/// ```dart -/// Consumer( -/// builder: (context, ref) { -/// return ElevatedButton( -/// onTap: () => ref.read(counterProvider.notifier).increment(), -/// child: const Text('increment'), -/// ); -/// }, -/// ) -/// ``` -/// -/// The state of [Notifier] is expected to be initialized synchronously. -/// For asynchronous initializations, see [AsyncNotifier]. -/// {@endtemplate} -/// -/// {@template riverpod.notifier_provider_modifier} -/// When using `autoDispose` or `family`, your notifier type changes. -/// Instead of extending [Notifier], you should extend either: -/// - [AutoDisposeNotifier] for `autoDispose` -/// - [FamilyNotifier] for `family` -/// - [AutoDisposeFamilyNotifier] for `autoDispose.family` -/// {@endtemplate} -abstract class Notifier extends BuildlessNotifier { - /// {@template riverpod.notifier.build} - /// Initialize a [Notifier]. - /// - /// It is safe to use [Ref.watch] or [Ref.listen] inside this method. - /// - /// If a dependency of this [Notifier] (when using [Ref.watch]) changes, - /// then [build] will be re-executed. On the other hand, the [Notifier] - /// will **not** be recreated. Its instance will be preserved between - /// executions of [build]. - /// - /// If this method throws, reading this provider will rethrow the error. - /// {@endtemplate} - @visibleForOverriding - State build(); -} - -/// {@macro riverpod.provider_ref_base} -abstract class NotifierProviderRef implements Ref {} - -/// {@template riverpod.notifier_provider} -/// A Provider which exposes a [Notifier] and listens to it. -/// -/// This is equivalent to a [Provider] that exposes ways to modify its state. -/// -/// See also [Notifier] for more information. -/// {@endtemplate} -/// -/// {@macro riverpod.notifier_provider_modifier} -typedef NotifierProvider, T> - = NotifierProviderImpl; - -/// The implementation of [NotifierProvider] but with loosened type constraints -/// that can be shared with [AutoDisposeNotifierProvider]. -/// -/// This enables tests to execute on both [NotifierProvider] and -/// [AutoDisposeNotifierProvider] at the same time. -@internal -class NotifierProviderImpl, T> - extends NotifierProviderBase { - /// {@macro riverpod.notifier_provider} - /// - /// {@macro riverpod.notifier_provider_modifier} - NotifierProviderImpl( - super._createNotifier, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - NotifierProviderImpl.internal( - super._createNotifier, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeNotifierProviderBuilder(); - - /// {@macro riverpod.family} - static const family = NotifierProviderFamilyBuilder(); - - @override - NotifierProviderElement createElement( - ProviderContainer container, - ) { - return NotifierProviderElement(this, container); - } - - @override - late final Refreshable notifier = _notifier(this); - - @override - @mustBeOverridden - T runNotifierBuild(NotifierBase notifier) { - return (notifier as Notifier).build(); - } - - /// {@macro riverpod.override_with} - @mustBeOverridden - Override overrideWith(NotifierT Function() create) { - return ProviderOverride( - origin: this, - providerOverride: NotifierProviderImpl.internal( - create, - from: from, - argument: argument, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), - ); - } -} - -/// The element of [NotifierProvider]. -class NotifierProviderElement, T> - extends ProviderElementBase implements NotifierProviderRef { - /// The element of [NotifierProvider]. - @internal - NotifierProviderElement(this.provider, super.container); - - @override - final NotifierProviderBase provider; - - final _notifierNotifier = ProxyElementValueListenable(); - - @override - void create({required bool didChangeDependency}) { - final notifierResult = _notifierNotifier.result ??= Result.guard(() { - return provider._createNotifier().._setElement(this); - }); - - // If the Notifier failed to create (such as if the constructor has an assert exception), - // then we purposefully rethrow the error. - // This way, doing `watch(provider)` will rethrow the error. - final notifier = notifierResult.requireState; - - setState(provider.runNotifierBuild(notifier)); - } - - @override - void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, - }) { - super.visitChildren( - elementVisitor: elementVisitor, - listenableVisitor: listenableVisitor, - ); - listenableVisitor(_notifierNotifier); - } - - @override - bool updateShouldNotify(T previous, T next) { - return _notifierNotifier.result?.stateOrNull - ?.updateShouldNotify(previous, next) ?? - true; - } - - @override - void dispose() { - super.dispose(); - _notifierNotifier.result?.stateOrNull?._setElement(null); - } -} diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index 97d0ae20a..6f7a5c0c4 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -3,27 +3,15 @@ part of '../notifier.dart'; /// {@macro riverpod.notifier} /// /// {@macro riverpod.notifier_provider_modifier} -abstract class FamilyNotifier extends BuildlessNotifier { +abstract class FamilyNotifier extends _NotifierBase { /// {@macro riverpod.notifier.family_arg} late final Arg arg; - @override - void _setElement(ProviderElementBase? element) { - super._setElement(element); - if (element != null) { - arg = element.origin.argument as Arg; - } - } - /// {@macro riverpod.async_notifier.build} @visibleForOverriding State build(Arg arg); } -/// The provider for [NotifierProviderFamily]. -typedef NotifierFamilyProvider, T, Arg> - = FamilyNotifierProviderImpl; - /// The implementation of [NotifierFamilyProvider] but with loosened type constraints /// that can be shared with [AutoDisposeNotifierProvider]. /// @@ -31,102 +19,104 @@ typedef NotifierFamilyProvider, T, Arg> /// [AutoDisposeNotifierProvider] at the same time. @visibleForTesting @internal -class FamilyNotifierProviderImpl, T, Arg> - extends NotifierProviderBase { - /// {@macro riverpod.notifier} - FamilyNotifierProviderImpl( - super._createNotifier, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - +final class FamilyNotifierProvider // + , StateT, ArgT> + extends _NotifierProvider { /// An implementation detail of Riverpod - @internal - FamilyNotifierProviderImpl.internal( + const FamilyNotifierProvider._( super._createNotifier, { required super.name, required super.dependencies, required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, - super.from, - super.argument, + required super.from, + required super.argument, + required super.isAutoDispose, + required super.runNotifierBuildOverride, }); - /// {@macro riverpod.autoDispose} - // ignore: prefer_const_declarations - static final autoDispose = AutoDisposeNotifierProviderFamily.new; - - // /// {@macro riverpod.family} - // static const family = NotifierProviderFamilyBuilder(); - @override - late final Refreshable notifier = _notifier(this); + _NotifierProviderElement createElement( + ProviderContainer container, + ) { + return _NotifierProviderElement(this, container); + } + + FamilyNotifierProvider _copyWith({ + NotifierT Function()? create, + RunNotifierBuild>? build, + }) { + return FamilyNotifierProvider._( + create ?? _createNotifier, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + isAutoDispose: isAutoDispose, + runNotifierBuildOverride: build ?? runNotifierBuildOverride, + from: from, + argument: argument, + ); + } @override - NotifierProviderElement createElement( - ProviderContainer container, + FamilyNotifierProvider copyWithBuild( + RunNotifierBuild> build, ) { - return NotifierProviderElement(this, container); + return _copyWith(build: build); } @override - T runNotifierBuild( - covariant FamilyNotifier notifier, + FamilyNotifierProvider copyWithCreate( + NotifierT Function() create, ) { - return notifier.build(notifier.arg); + return _copyWith(create: create); } } /// The [Family] of [NotifierProvider]. -class NotifierProviderFamily, T, Arg> - extends ClassFamily, T, Arg, NotifierT, - NotifierFamilyProvider> { - /// The [Family] of [NotifierProvider]. - NotifierProviderFamily( +class NotifierProviderFamily< + NotifierT extends FamilyNotifier, StateT, ArgT> + extends ClassFamily< // + NotifierT, + StateT, + Ref, + ArgT, + StateT, + FamilyNotifierProvider> { + /// The [Family] of [AsyncNotifierProvider]. + NotifierProviderFamily._( super._createFn, { super.name, super.dependencies, }) : super( - providerFactory: NotifierFamilyProvider.internal, + providerFactory: FamilyNotifierProvider._, + debugGetCreateSourceHash: null, + isAutoDispose: false, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + ); + + NotifierProviderFamily._autoDispose( + super._createFn, { + super.name, + super.dependencies, + }) : super( + providerFactory: FamilyNotifierProvider._, debugGetCreateSourceHash: null, + isAutoDispose: true, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), ); - /// An implementation detail of Riverpod + /// The [Family] of [AsyncNotifierProvider]. @internal NotifierProviderFamily.internal( super._createFn, { - required super.name, - required super.dependencies, + super.name, + super.dependencies, required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, - }) : super(providerFactory: NotifierFamilyProvider.internal); - - /// {@macro riverpod.override_with} - Override overrideWith(NotifierT Function() create) { - // TODO fix up nootifier names - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as FamilyNotifierProviderImpl; - - return NotifierFamilyProvider.internal( - create, - from: from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } + required super.isAutoDispose, + }) : super(providerFactory: FamilyNotifierProvider._); } diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart new file mode 100644 index 000000000..79c257762 --- /dev/null +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -0,0 +1,198 @@ +part of '../notifier.dart'; + +/// {@template riverpod.notifier} +/// A class which exposes a state that can change over time. +/// +/// For example, [Notifier] can be used to implement a counter by doing: +/// +/// ```dart +/// final counterProvider = NotifierProvider(Counter.new); +/// +/// class Counter extends Notifier { +/// @override +/// int build() { +/// // Inside "build", we return the initial state of the counter. +/// return 0; +/// } +/// +/// void increment() { +/// state++; +/// } +/// } +/// ``` +/// +/// We can then listen to the counter inside widgets by doing: +/// +/// ```dart +/// Consumer( +/// builder: (context, ref) { +/// return Text('count: ${ref.watch(counterProvider)}'); +/// }, +/// ) +/// ``` +/// +/// And finally, we can update the counter by doing: +/// +/// ```dart +/// Consumer( +/// builder: (context, ref) { +/// return ElevatedButton( +/// onTap: () => ref.read(counterProvider.notifier).increment(), +/// child: const Text('increment'), +/// ); +/// }, +/// ) +/// ``` +/// +/// The state of [Notifier] is expected to be initialized synchronously. +/// For asynchronous initializations, see [AsyncNotifier]. +/// {@endtemplate} +/// +/// {@template riverpod.notifier_provider_modifier} +/// When using `autoDispose` or `family`, your notifier type changes. +/// Instead of extending [Notifier], you should extend either: +/// - [AutoDisposeNotifier] for `autoDispose` +/// - [FamilyNotifier] for `family` +/// - [AutoDisposeFamilyNotifier] for `autoDispose.family` +/// {@endtemplate} +abstract class Notifier extends _NotifierBase { + /// {@template riverpod.notifier.build} + /// Initialize a [Notifier]. + /// + /// It is safe to use [Ref.watch] or [Ref.listen] inside this method. + /// + /// If a dependency of this [Notifier] (when using [Ref.watch]) changes, + /// then [build] will be re-executed. On the other hand, the [Notifier] + /// will **not** be recreated. Its instance will be preserved between + /// executions of [build]. + /// + /// If this method throws, reading this provider will rethrow the error. + /// {@endtemplate} + @visibleForOverriding + State build(); +} + +final class NotifierProvider, StateT> + extends _NotifierProvider { + /// {@macro riverpod.notifier_provider} + /// + /// {@macro riverpod.notifier_provider_modifier} + NotifierProvider( + super._createNotifier, { + super.name, + super.dependencies, + super.isAutoDispose = false, + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, + runNotifierBuildOverride: null, + ); + + NotifierProvider._autoDispose( + super._createNotifier, { + super.name, + super.dependencies, + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + isAutoDispose: true, + from: null, + argument: null, + debugGetCreateSourceHash: null, + runNotifierBuildOverride: null, + ); + + /// An implementation detail of Riverpod + @internal + NotifierProvider.internal( + super._createNotifier, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required super.argument, + required super.isAutoDispose, + required super.runNotifierBuildOverride, + }); + + /// {@macro riverpod.autoDispose} + static const autoDispose = AutoDisposeNotifierProviderBuilder(); + + /// {@macro riverpod.family} + static const family = NotifierProviderFamilyBuilder(); + + @override + _NotifierProviderElement createElement( + ProviderContainer container, + ) { + return _NotifierProviderElement(this, container); + } + + NotifierProvider _copyWith({ + NotifierT Function()? create, + RunNotifierBuild>? build, + }) { + return NotifierProvider.internal( + create ?? _createNotifier, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + argument: argument, + isAutoDispose: isAutoDispose, + runNotifierBuildOverride: build ?? runNotifierBuildOverride, + ); + } + + @internal + @override + NotifierProvider copyWithBuild( + RunNotifierBuild>? build, + ) { + return _copyWith(build: build); + } + + @internal + @override + NotifierProvider copyWithCreate( + NotifierT Function() create, + ) { + return _copyWith(create: create); + } +} + +class _NotifierProviderElement< // + NotifierT extends _NotifierBase, + StateT> // + extends ClassProviderElement< // + NotifierT, + StateT, + StateT> // +{ + _NotifierProviderElement(this.provider, super.container); + + @override + final _NotifierProvider provider; + + @override + void handleError( + Object error, + StackTrace stackTrace, { + required bool didChangeDependency, + }) { + Zone.current.handleUncaughtError(error, stackTrace); + } + + @override + void handleValue( + StateT created, { + required bool didChangeDependency, + }) { + state = created; + } +} diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index cd99cb650..6ab4ce311 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -7,6 +7,8 @@ import 'package:path/path.dart' as path; import 'package:test/test.dart'; void main() { + // TODO verify that inherited members reapply annotations + // This verifies that: // - All public APIs are documented // - public APIs have no unexported types diff --git a/packages/riverpod/test/old/legacy_providers/notifier/factory.dart b/packages/riverpod/test/old/legacy_providers/notifier/factory.dart index 23c5dbdd4..231db6f3e 100644 --- a/packages/riverpod/test/old/legacy_providers/notifier/factory.dart +++ b/packages/riverpod/test/old/legacy_providers/notifier/factory.dart @@ -1,7 +1,7 @@ import 'package:riverpod/src/internals.dart'; -typedef NotifierProviderFactoryType = NotifierProviderBase - Function, T>( +typedef NotifierProviderFactoryType = _NotifierProviderBase + Function, T>( NotifierT Function() create, { Iterable? dependencies, String? name, @@ -13,12 +13,12 @@ typedef NotifierFactoryType = TestNotifierBase Function( }); typedef SimpleTestProviderFactoryType - = NotifierProviderBase, T> Function( + = _NotifierProviderBase, T> Function( T Function(NotifierProviderRef ref) init, { bool Function(T prev, T next)? updateShouldNotify, }); -typedef TestProviderFactoryType = NotifierProviderBase, T> +typedef TestProviderFactoryType = _NotifierProviderBase, T> Function( TestNotifierBase Function() createNotifier, ); @@ -32,10 +32,10 @@ List matrix({ NotifierFactory( label: 'NotifierProvider', isAutoDispose: false, - provider: NotifierProviderImpl.new, + provider: NotifierProvider.new, notifier: TestNotifier.new, testProvider: (createNotifier) { - return NotifierProviderImpl, T>( + return NotifierProvider, T>( createNotifier, ); }, @@ -52,7 +52,7 @@ List matrix({ NotifierFactory( label: 'NotifierProviderFamily', isAutoDispose: false, - provider: , T>( + provider: , T>( create, { argument, dependencies, @@ -119,7 +119,7 @@ List matrix({ NotifierFactory( label: 'AutoDisposeNotifierProviderFamily', isAutoDispose: true, - provider: , T>( + provider: , T>( create, { argument, dependencies, @@ -184,7 +184,7 @@ class NotifierFactory { final SimpleTestProviderFactoryType simpleTestProvider; } -abstract class TestNotifierBase extends NotifierBase {} +abstract class TestNotifierBase extends _NotifierBase {} class TestNotifier extends Notifier implements TestNotifierBase { TestNotifier(this._init, {bool Function(T prev, T next)? updateShouldNotify}) diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index 6344506d7..0522bc04c 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -60,7 +60,7 @@ export 'package:riverpod/src/internals.dart' NotifierProviderElement, AutoDisposeNotifierProviderElement, // ignore: invalid_use_of_internal_member - NotifierProviderImpl, + NotifierProvider, // ignore: invalid_use_of_internal_member AutoDisposeNotifierProviderImpl, // ignore: invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index cf8c89092..3b9f440f6 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -307,7 +307,7 @@ class _$A4FamilyOverride implements FamilyOverride { } /// See also [A4]. -class A4Provider extends NotifierProviderImpl { +class A4Provider extends NotifierProvider { /// See also [A4]. A4Provider( int param, From 43b3cf4d7996c7aa02aef7725c68d8ddf2710686 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 21 Jan 2024 01:41:30 +0100 Subject: [PATCH 129/387] Update StateProvider --- packages/riverpod/lib/src/core/family.dart | 6 +- .../core/provider/functional_provider.dart | 7 +- .../legacy/state_notifier_provider.dart | 5 +- .../src/providers/legacy/state_provider.dart | 220 ++++++++++++++++-- .../legacy/state_provider/auto_dispose.dart | 119 ---------- .../providers/legacy/state_provider/base.dart | 210 ----------------- 6 files changed, 217 insertions(+), 350 deletions(-) delete mode 100644 packages/riverpod/lib/src/providers/legacy/state_provider/auto_dispose.dart delete mode 100644 packages/riverpod/lib/src/providers/legacy/state_provider/base.dart diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index 53997265a..e8b8c9204 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -10,10 +10,8 @@ typedef FunctionalProviderFactory< // = ProviderT Function( Create create, { required String? name, - // ignore: prefer_void_to_null, explicitly using Null to cause a compilation error if non-null value is assigned - required Null dependencies, - // ignore: prefer_void_to_null, explicitly using Null to cause a compilation error if non-null value is assigned - required Null allTransitiveDependencies, + required List? dependencies, + required List? allTransitiveDependencies, required DebugGetCreateSourceHash? debugGetCreateSourceHash, required bool isAutoDispose, required Family from, diff --git a/packages/riverpod/lib/src/core/provider/functional_provider.dart b/packages/riverpod/lib/src/core/provider/functional_provider.dart index 01a319246..24f8872e2 100644 --- a/packages/riverpod/lib/src/core/provider/functional_provider.dart +++ b/packages/riverpod/lib/src/core/provider/functional_provider.dart @@ -1,8 +1,11 @@ part of '../../framework.dart'; @internal -abstract base class FunctionalProvider> extends ProviderBase { +abstract base class FunctionalProvider< // + StateT, + CreatedT, + RefT extends Ref> // + extends ProviderBase { const FunctionalProvider({ required super.name, required super.from, diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index ef4853d46..c68ee654a 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -19,8 +19,8 @@ ProviderElementProxy ); } -abstract class _StateNotifierProviderBase, T> - extends ProviderBase { +abstract base class _StateNotifierProviderBase< + NotifierT extends StateNotifier, T> extends ProviderBase { const _StateNotifierProviderBase({ required super.name, required super.from, @@ -28,6 +28,7 @@ abstract class _StateNotifierProviderBase, T> required super.dependencies, required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, + required super.isAutoDispose, }); /// Obtains the [StateNotifier] associated with this provider, without listening diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 653f4e0dc..04312cca0 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -1,33 +1,227 @@ import 'package:meta/meta.dart'; +import '../../builder.dart'; import '../../internals.dart'; import 'state_controller.dart'; -part 'state_provider/auto_dispose.dart'; -part 'state_provider/base.dart'; - -ProviderElementProxy> _notifier( - _StateProviderBase that, +ProviderElementProxy> _notifier( + StateProvider that, ) { - return ProviderElementProxy>( + return ProviderElementProxy>( that, (element) { - return (element as StateProviderElement)._controllerNotifier; + return (element as StateProviderElement)._controllerNotifier; }, ); } -abstract class _StateProviderBase extends ProviderBase { - const _StateProviderBase({ +/// {@macro riverpod.provider_ref_base} +/// - [controller], the [StateController] currently exposed by this provider. +abstract class StateProviderRef implements Ref { + /// The [StateController] currently exposed by this provider. + /// + /// Cannot be accessed while creating the provider. + StateController get controller; +} + +/// A provider that exposes a value that can be modified from outside. +/// +/// It can be useful for very simple states, like a filter or the currently +/// selected item – which can then be combined with other providers or accessed +/// in multiple screens. +/// +/// The following code shows a list of products, and allows selecting +/// a product by tapping on it. +/// +/// ```dart +/// final selectedProductIdProvider = StateProvider((ref) => null); +/// final productsProvider = StateNotifierProvider>((ref) => ProductsNotifier()); +/// +/// Widget build(BuildContext context, WidgetRef ref) { +/// final List products = ref.watch(productsProvider); +/// final selectedProductId = ref.watch(selectedProductIdProvider); +/// +/// return ListView( +/// children: [ +/// for (final product in products) +/// GestureDetector( +/// onTap: () => ref.read(selectedProductIdProvider.notifier).state = product.id, +/// child: ProductItem( +/// product: product, +/// isSelected: selectedProductId.state == product.id, +/// ), +/// ), +/// ], +/// ); +/// } +/// ``` +final class StateProvider + extends FunctionalProvider> { + /// {@macro riverpod.stateprovider} + StateProvider( + this._createFn, { + super.name, + super.dependencies, + super.isAutoDispose = false, + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, + ); + + /// An implementation detail of Riverpod + @internal + StateProvider.internal( + this._createFn, { required super.name, - required super.from, - required super.argument, required super.dependencies, required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, + required super.isAutoDispose, + required super.from, + required super.argument, }); - ProviderListenable> get notifier; + /// {@macro riverpod.autoDispose} + static const autoDispose = AutoDisposeStateProviderBuilder(); + + /// {@macro riverpod.family} + static const family = StateProviderFamilyBuilder(); + + final StateT Function(StateProviderRef ref) _createFn; + + ProviderListenable> get notifier => _notifier(this); + + @override + StateProviderElement createElement( + ProviderContainer container, + ) { + return StateProviderElement._(this, container); + } + + @internal + @override + StateProvider copyWithCreate( + Create> create, + ) { + return StateProvider.internal( + create, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + argument: argument, + isAutoDispose: isAutoDispose, + ); + } +} + +/// The element of [StateProvider]. +class StateProviderElement extends ProviderElementBase + implements StateProviderRef { + StateProviderElement._(this.provider, super.container); + + @override + final StateProvider provider; - T _create(covariant StateProviderElement ref); + @override + StateController get controller => _controllerNotifier.value; + final _controllerNotifier = ProxyElementValueListenable>(); + + final _stateNotifier = ProxyElementValueListenable>(); + + void Function()? _removeListener; + + @override + void create({required bool didChangeDependency}) { + final initialState = provider._createFn(this); + + final controller = StateController(initialState); + _controllerNotifier.result = Result.data(controller); + + _removeListener = controller.addListener( + fireImmediately: true, + (state) { + _stateNotifier.result = _controllerNotifier.result; + setState(state); + }, + ); + } + + @override + bool updateShouldNotify(T previous, T next) { + return !identical(previous, next); + } + + @override + void runOnDispose() { + super.runOnDispose(); + + _removeListener?.call(); + _removeListener = null; + + _controllerNotifier.result?.stateOrNull?.dispose(); + _controllerNotifier.result = null; + } + + @override + void visitChildren({ + required void Function(ProviderElementBase element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); + listenableVisitor(_stateNotifier); + listenableVisitor(_controllerNotifier); + } +} + +/// The [Family] of [StateProvider]. +class StateProviderFamily extends FunctionalFamily< // + StateProviderRef, + StateT, + Arg, + StateT, + StateProvider> { + /// The [Family] of [AsyncNotifierProvider]. + StateProviderFamily._( + super._createFn, { + super.name, + super.dependencies, + }) : super( + providerFactory: StateProvider.internal, + debugGetCreateSourceHash: null, + isAutoDispose: false, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + ); + + StateProviderFamily._autoDispose( + super._createFn, { + super.name, + super.dependencies, + }) : super( + providerFactory: StateProvider.internal, + debugGetCreateSourceHash: null, + isAutoDispose: true, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + ); + + /// The [Family] of [AsyncNotifierProvider]. + @internal + StateProviderFamily.internal( + super._createFn, { + super.name, + super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.isAutoDispose, + }) : super(providerFactory: StateProvider.internal); } diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider/auto_dispose.dart b/packages/riverpod/lib/src/providers/legacy/state_provider/auto_dispose.dart deleted file mode 100644 index c8510fb1b..000000000 --- a/packages/riverpod/lib/src/providers/legacy/state_provider/auto_dispose.dart +++ /dev/null @@ -1,119 +0,0 @@ -part of '../state_provider.dart'; - -/// {@macro riverpod.provider_ref_base} -/// - [controller], the [StateController] currently exposed by this provider. -abstract class AutoDisposeStateProviderRef - extends StateProviderRef implements AutoDisposeRef {} - -/// {@macro riverpod.stateprovider} -class AutoDisposeStateProvider extends _StateProviderBase { - /// {@macro riverpod.stateprovider} - AutoDisposeStateProvider( - this._createFn, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - AutoDisposeStateProvider.internal( - this._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.family} - static const family = AutoDisposeStateProviderFamily.new; - - final T Function(AutoDisposeStateProviderRef ref) _createFn; - - @override - T _create(AutoDisposeStateProviderElement ref) => _createFn(ref); - - @override - AutoDisposeStateProviderElement createElement( - ProviderContainer container, - ) { - return AutoDisposeStateProviderElement._(this, container); - } - - @override - late final Refreshable> notifier = _notifier(this); - - /// {@macro riverpod.override_with} - Override overrideWith( - Create> create, - ) { - return ProviderOverride( - origin: this, - providerOverride: AutoDisposeStateProvider.internal( - create, - from: from, - argument: argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), - ); - } -} - -/// The element of [StateProvider]. -class AutoDisposeStateProviderElement extends StateProviderElement - with AutoDisposeProviderElementMixin - implements AutoDisposeStateProviderRef { - /// The [ProviderElementBase] for [StateProvider] - AutoDisposeStateProviderElement._( - AutoDisposeStateProvider super.provider, - super.container, - ) : super._(); -} - -/// The [Family] of [StateProvider]. -class AutoDisposeStateProviderFamily extends AutoDisposeFamilyBase< - AutoDisposeStateProviderRef, R, Arg, R, AutoDisposeStateProvider> { - /// The [Family] of [StateProvider]. - AutoDisposeStateProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: AutoDisposeStateProvider.internal, - debugGetCreateSourceHash: null, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - ); - - /// {@macro riverpod.override_with} - Override overrideWith( - R Function(AutoDisposeStateProviderRef ref, Arg arg) create, - ) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as AutoDisposeStateProvider; - - return AutoDisposeStateProvider.internal( - (ref) => create(ref, provider.argument as Arg), - from: provider.from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider/base.dart b/packages/riverpod/lib/src/providers/legacy/state_provider/base.dart deleted file mode 100644 index a22953825..000000000 --- a/packages/riverpod/lib/src/providers/legacy/state_provider/base.dart +++ /dev/null @@ -1,210 +0,0 @@ -part of '../state_provider.dart'; - -/// {@macro riverpod.provider_ref_base} -/// - [controller], the [StateController] currently exposed by this provider. -abstract class StateProviderRef implements Ref { - /// The [StateController] currently exposed by this provider. - /// - /// Cannot be accessed while creating the provider. - StateController get controller; -} - -/// {@template riverpod.stateprovider} -/// A provider that exposes a value that can be modified from outside. -/// -/// It can be useful for very simple states, like a filter or the currently -/// selected item – which can then be combined with other providers or accessed -/// in multiple screens. -/// -/// The following code shows a list of products, and allows selecting -/// a product by tapping on it. -/// -/// ```dart -/// final selectedProductIdProvider = StateProvider((ref) => null); -/// final productsProvider = StateNotifierProvider>((ref) => ProductsNotifier()); -/// -/// Widget build(BuildContext context, WidgetRef ref) { -/// final List products = ref.watch(productsProvider); -/// final selectedProductId = ref.watch(selectedProductIdProvider); -/// -/// return ListView( -/// children: [ -/// for (final product in products) -/// GestureDetector( -/// onTap: () => ref.read(selectedProductIdProvider.notifier).state = product.id, -/// child: ProductItem( -/// product: product, -/// isSelected: selectedProductId.state == product.id, -/// ), -/// ), -/// ], -/// ); -/// } -/// ``` -/// {@endtemplate} -class StateProvider extends _StateProviderBase { - /// {@macro riverpod.stateprovider} - StateProvider( - this._createFn, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - StateProvider.internal( - this._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeStateProviderBuilder(); - - /// {@macro riverpod.family} - static const family = StateProviderFamilyBuilder(); - - final T Function(StateProviderRef ref) _createFn; - - @override - T _create(StateProviderElement ref) => _createFn(ref); - - @override - StateProviderElement createElement( - ProviderContainer container, - ) { - return StateProviderElement._(this, container); - } - - @override - late final Refreshable> notifier = _notifier(this); - - /// {@macro riverpod.override_with} - Override overrideWith( - Create> create, - ) { - return ProviderOverride( - origin: this, - providerOverride: StateProvider.internal( - create, - from: from, - argument: argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), - ); - } -} - -/// The element of [StateProvider]. -class StateProviderElement extends ProviderElementBase - implements StateProviderRef { - StateProviderElement._(this.provider, super.container); - - @override - final _StateProviderBase provider; - - @override - StateController get controller => _controllerNotifier.value; - final _controllerNotifier = ProxyElementValueListenable>(); - - final _stateNotifier = ProxyElementValueListenable>(); - - void Function()? _removeListener; - - @override - void create({required bool didChangeDependency}) { - final initialState = provider._create(this); - - final controller = StateController(initialState); - _controllerNotifier.result = Result.data(controller); - - _removeListener = controller.addListener( - fireImmediately: true, - (state) { - _stateNotifier.result = _controllerNotifier.result; - setState(state); - }, - ); - } - - @override - bool updateShouldNotify(T previous, T next) { - return !identical(previous, next); - } - - @override - void runOnDispose() { - super.runOnDispose(); - - _removeListener?.call(); - _removeListener = null; - - _controllerNotifier.result?.stateOrNull?.dispose(); - _controllerNotifier.result = null; - } - - @override - void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, - }) { - super.visitChildren( - elementVisitor: elementVisitor, - listenableVisitor: listenableVisitor, - ); - listenableVisitor(_stateNotifier); - listenableVisitor(_controllerNotifier); - } -} - -/// The [Family] of [StateProvider]. -class StateProviderFamily - extends FunctionalFamily, R, Arg, R, StateProvider> { - /// The [Family] of [StateProvider]. - StateProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: StateProvider.internal, - debugGetCreateSourceHash: null, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - ); - - /// {@macro riverpod.override_with} - Override overrideWith( - R Function(StateProviderRef ref, Arg arg) create, - ) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as StateProvider; - - return StateProvider.internal( - (ref) => create(ref, provider.argument as Arg), - from: provider.from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} From 4835ded7886dfebb8b1365b3e42e5c0358f247b4 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 21 Jan 2024 01:44:13 +0100 Subject: [PATCH 130/387] Fix some builder errors --- .../riverpod/lib/src/providers/async_notifier/orphan.dart | 2 +- packages/riverpod/lib/src/providers/future_provider.dart | 2 +- .../riverpod/lib/src/providers/legacy/state_provider.dart | 4 ++-- packages/riverpod/lib/src/providers/provider.dart | 2 +- packages/riverpod/lib/src/providers/stream_provider.dart | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index fbbd96a91..1d6b22e5d 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -64,13 +64,13 @@ final class AsyncNotifierProvider< // super._createNotifier, { super.name, super.dependencies, + super.isAutoDispose = false, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), from: null, argument: null, debugGetCreateSourceHash: null, - isAutoDispose: false, runNotifierBuildOverride: null, ); diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index cab7c1f04..51b2dde1f 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -191,7 +191,7 @@ class FutureProviderElement extends ProviderElementBase> /// The [Family] of a [FutureProvider] class FutureProviderFamily extends FunctionalFamily< FutureProviderRef, AsyncValue, Arg, FutureOr, FutureProvider> { - FutureProviderFamily._( + FutureProviderFamily( super._createFn, { super.name, super.dependencies, diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 04312cca0..d62bf9841 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -190,14 +190,14 @@ class StateProviderFamily extends FunctionalFamily< // StateT, StateProvider> { /// The [Family] of [AsyncNotifierProvider]. - StateProviderFamily._( + StateProviderFamily( super._createFn, { super.name, super.dependencies, + super.isAutoDispose = false, }) : super( providerFactory: StateProvider.internal, debugGetCreateSourceHash: null, - isAutoDispose: false, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), ); diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 00260baf3..670d921d8 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -358,7 +358,7 @@ class ProviderElement extends ProviderElementBase { // TODO remove custom family types class ProviderFamily extends FunctionalFamily, R, Arg, R, Provider> { - ProviderFamily._( + ProviderFamily( super._createFn, { super.name, super.dependencies, diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index c2d9a4753..c77ce2fbc 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -210,7 +210,7 @@ class StreamProviderElement extends ProviderElementBase> /// The [Family] of a [StreamProvider] class StreamProviderFamily extends FunctionalFamily>, AsyncValue, Arg, Stream, StreamProvider> { - StreamProviderFamily._( + StreamProviderFamily( super._createFn, { super.name, super.dependencies, From d75f8cb1d2a368ff490d5e50c0b09d9e2a3d2a04 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 21 Jan 2024 01:50:58 +0100 Subject: [PATCH 131/387] Update StateNotifierProvider --- .../legacy/state_notifier_provider.dart | 232 ++++++++++++++-- .../state_notifier_provider/auto_dispose.dart | 136 ---------- .../legacy/state_notifier_provider/base.dart | 247 ------------------ 3 files changed, 217 insertions(+), 398 deletions(-) delete mode 100644 packages/riverpod/lib/src/providers/legacy/state_notifier_provider/auto_dispose.dart delete mode 100644 packages/riverpod/lib/src/providers/legacy/state_notifier_provider/base.dart diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index c68ee654a..9d1c4e9b4 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -1,36 +1,136 @@ import 'package:meta/meta.dart'; import 'package:state_notifier/state_notifier.dart'; +import '../../builder.dart'; import '../../internals.dart'; -part 'state_notifier_provider/auto_dispose.dart'; -part 'state_notifier_provider/base.dart'; - -ProviderElementProxy - _notifier, T>( - _StateNotifierProviderBase that, +ProviderElementProxy + _notifier, StateT>( + StateNotifierProvider that, ) { - return ProviderElementProxy( + return ProviderElementProxy( that, (element) { - return (element as StateNotifierProviderElement) + return (element as StateNotifierProviderElement) ._notifierNotifier; }, ); } -abstract base class _StateNotifierProviderBase< - NotifierT extends StateNotifier, T> extends ProviderBase { - const _StateNotifierProviderBase({ +/// {@macro riverpod.provider_ref_base} +abstract class StateNotifierProviderRef, T> + implements Ref { + /// The [StateNotifier] currently exposed by this provider. + /// + /// Cannot be accessed while creating the provider. + NotifierT get notifier; +} + +/// Creates a [StateNotifier] and exposes its current state. +/// +/// This provider is used in combination with `package:state_notifier`. +/// +/// Combined with [StateNotifier], [StateNotifierProvider] can be used to manipulate +/// advanced states, that would otherwise be difficult to represent with simpler +/// providers such as [Provider] or [FutureProvider]. +/// +/// For example, you may have a todo-list, where you can add and remove +/// and complete a todo. +/// Using [StateNotifier], you could represent such state as: +/// +/// ```dart +/// class TodosNotifier extends StateNotifier> { +/// TodosNotifier(): super([]); +/// +/// void add(Todo todo) { +/// state = [...state, todo]; +/// } +/// +/// void remove(String todoId) { +/// state = [ +/// for (final todo in state) +/// if (todo.id != todoId) todo, +/// ]; +/// } +/// +/// void toggle(String todoId) { +/// state = [ +/// for (final todo in state) +/// if (todo.id == todoId) todo.copyWith(completed: !todo.completed), +/// ]; +/// } +/// } +/// ``` +/// +/// Which you can then pass to a [StateNotifierProvider] like so: +/// +/// ```dart +/// final todosProvider = StateNotifierProvider>((ref) => TodosNotifier()); +/// ``` +/// +/// And finally, you can interact with it inside your UI: +/// +/// ```dart +/// Widget build(BuildContext context, WidgetRef ref) { +/// // rebuild the widget when the todo list changes +/// List todos = ref.watch(todosProvider); +/// +/// return ListView( +/// children: [ +/// for (final todo in todos) +/// CheckboxListTile( +/// value: todo.completed, +/// // When tapping on the todo, change its completed status +/// onChanged: (value) => ref.read(todosProvider.notifier).toggle(todo.id), +/// title: Text(todo.description), +/// ), +/// ], +/// ); +/// } +/// ``` +final class StateNotifierProvider< // + NotifierT extends StateNotifier, + StateT> // + extends FunctionalProvider< // + StateT, + NotifierT, + StateNotifierProviderRef> { + /// {@macro riverpod.statenotifierprovider} + StateNotifierProvider( + this._create, { + super.name, + super.dependencies, + super.isAutoDispose = false, + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, + ); + + /// An implementation detail of Riverpod + @internal + StateNotifierProvider.internal( + this._create, { required super.name, - required super.from, - required super.argument, required super.dependencies, required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, + required super.from, + required super.argument, required super.isAutoDispose, }); + /// {@macro riverpod.autoDispose} + static const autoDispose = AutoDisposeStateNotifierProviderBuilder(); + + /// {@macro riverpod.family} + static const family = StateNotifierProviderFamilyBuilder(); + + final NotifierT Function(StateNotifierProviderRef ref) + _create; + /// Obtains the [StateNotifier] associated with this provider, without listening /// to state changes. /// @@ -46,7 +146,109 @@ abstract base class _StateNotifierProviderBase< /// changes. /// This may happen if the provider is refreshed or one of its dependencies /// has changes. - ProviderListenable get notifier; + ProviderListenable get notifier => _notifier(this); + + @override + StateNotifierProviderElement createElement( + ProviderContainer container, + ) { + return StateNotifierProviderElement._(this, container); + } + + @override + StateNotifierProvider copyWithCreate( + Create> create, + ) { + return StateNotifierProvider.internal( + create, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + argument: argument, + isAutoDispose: isAutoDispose, + ); + } +} + +/// The element of [StateNotifierProvider]. +class StateNotifierProviderElement, T> + extends ProviderElementBase + implements StateNotifierProviderRef { + StateNotifierProviderElement._(this.provider, super.container); + + @override + final StateNotifierProvider provider; + + @override + NotifierT get notifier => _notifierNotifier.value; + final _notifierNotifier = ProxyElementValueListenable(); + + void Function()? _removeListener; + + @override + void create({required bool didChangeDependency}) { + final notifier = + _notifierNotifier.result = Result.guard(() => provider._create(this)); + + _removeListener = notifier + // TODO test requireState, as ref.read(p) is expected to throw if notifier creation failed + .requireState + .addListener(setState, fireImmediately: true); + } + + @override + bool updateShouldNotify(T previous, T next) { + // TODO test that updateShouldNotify is applied + return _notifierNotifier.result!.requireState + // ignore: invalid_use_of_protected_member + .updateShouldNotify(previous, next); + } + + @override + void runOnDispose() { + super.runOnDispose(); + + _removeListener?.call(); + _removeListener = null; + + final notifier = _notifierNotifier.result?.stateOrNull; + if (notifier != null) { + // TODO test STateNotifier.dispose is guarded + runGuarded(notifier.dispose); + } + _notifierNotifier.result = null; + } + + @override + void visitChildren({ + required void Function(ProviderElementBase element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); + listenableVisitor(_notifierNotifier); + } +} - NotifierT _create(covariant StateNotifierProviderElement ref); +/// The [Family] of [StateNotifierProvider]. +class StateNotifierProviderFamily, T, Arg> + extends FunctionalFamily, T, Arg, + NotifierT, StateNotifierProvider> { + /// The [Family] of [StateNotifierProvider]. + StateNotifierProviderFamily( + super._createFn, { + super.name, + super.dependencies, + super.isAutoDispose = false, + }) : super( + providerFactory: StateNotifierProvider.internal, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + debugGetCreateSourceHash: null, + ); } diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider/auto_dispose.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider/auto_dispose.dart deleted file mode 100644 index d00eb6d24..000000000 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider/auto_dispose.dart +++ /dev/null @@ -1,136 +0,0 @@ -part of '../state_notifier_provider.dart'; - -/// {@macro riverpod.provider_ref_base} -abstract class AutoDisposeStateNotifierProviderRef< - NotifierT extends StateNotifier, - T> extends StateNotifierProviderRef - implements AutoDisposeRef {} - -/// {@macro riverpod.statenotifierprovider} -class AutoDisposeStateNotifierProvider, T> - extends _StateNotifierProviderBase { - /// {@macro riverpod.statenotifierprovider} - AutoDisposeStateNotifierProvider( - this._createFn, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - AutoDisposeStateNotifierProvider.internal( - this._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.family} - static const family = AutoDisposeStateNotifierProviderFamily.new; - - final NotifierT Function( - AutoDisposeStateNotifierProviderRef ref, - ) _createFn; - - @override - NotifierT _create(AutoDisposeStateNotifierProviderElement ref) { - return _createFn(ref); - } - - @override - AutoDisposeStateNotifierProviderElement createElement( - ProviderContainer container, - ) { - return AutoDisposeStateNotifierProviderElement._(this, container); - } - - @override - late final Refreshable notifier = _notifier(this); - - /// {@macro riverpod.override_with} - Override overrideWith( - Create> create, - ) { - return ProviderOverride( - origin: this, - providerOverride: AutoDisposeStateNotifierProvider.internal( - create, - from: from, - argument: argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), - ); - } -} - -/// The element of [AutoDisposeStateNotifierProvider]. -class AutoDisposeStateNotifierProviderElement< - NotifierT extends StateNotifier, - T> extends StateNotifierProviderElement - with AutoDisposeProviderElementMixin - implements AutoDisposeStateNotifierProviderRef { - /// The [ProviderElementBase] for [StateNotifierProvider] - AutoDisposeStateNotifierProviderElement._( - AutoDisposeStateNotifierProvider super.provider, - super.container, - ) : super._(); -} - -/// The [Family] of [AutoDisposeStateNotifierProvider]. -class AutoDisposeStateNotifierProviderFamily, - T, Arg> - extends AutoDisposeFamilyBase< - AutoDisposeStateNotifierProviderRef, - T, - Arg, - NotifierT, - AutoDisposeStateNotifierProvider> { - /// The [Family] of [AutoDisposeStateNotifierProvider]. - AutoDisposeStateNotifierProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: AutoDisposeStateNotifierProvider.internal, - debugGetCreateSourceHash: null, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - ); - - /// {@macro riverpod.override_with} - Override overrideWith( - NotifierT Function( - AutoDisposeStateNotifierProviderRef ref, - Arg arg, - ) create, - ) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as AutoDisposeStateNotifierProvider; - - return AutoDisposeStateNotifierProvider.internal( - (ref) => create(ref, provider.argument as Arg), - from: provider.from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider/base.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider/base.dart deleted file mode 100644 index 1e0f18456..000000000 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider/base.dart +++ /dev/null @@ -1,247 +0,0 @@ -part of '../state_notifier_provider.dart'; - -/// {@macro riverpod.provider_ref_base} -abstract class StateNotifierProviderRef, T> - implements Ref { - /// The [StateNotifier] currently exposed by this provider. - /// - /// Cannot be accessed while creating the provider. - NotifierT get notifier; -} - -/// {@template riverpod.statenotifierprovider} -/// Creates a [StateNotifier] and exposes its current state. -/// -/// This provider is used in combination with `package:state_notifier`. -/// -/// Combined with [StateNotifier], [StateNotifierProvider] can be used to manipulate -/// advanced states, that would otherwise be difficult to represent with simpler -/// providers such as [Provider] or [FutureProvider]. -/// -/// For example, you may have a todo-list, where you can add and remove -/// and complete a todo. -/// Using [StateNotifier], you could represent such state as: -/// -/// ```dart -/// class TodosNotifier extends StateNotifier> { -/// TodosNotifier(): super([]); -/// -/// void add(Todo todo) { -/// state = [...state, todo]; -/// } -/// -/// void remove(String todoId) { -/// state = [ -/// for (final todo in state) -/// if (todo.id != todoId) todo, -/// ]; -/// } -/// -/// void toggle(String todoId) { -/// state = [ -/// for (final todo in state) -/// if (todo.id == todoId) todo.copyWith(completed: !todo.completed), -/// ]; -/// } -/// } -/// ``` -/// -/// Which you can then pass to a [StateNotifierProvider] like so: -/// -/// ```dart -/// final todosProvider = StateNotifierProvider>((ref) => TodosNotifier()); -/// ``` -/// -/// And finally, you can interact with it inside your UI: -/// -/// ```dart -/// Widget build(BuildContext context, WidgetRef ref) { -/// // rebuild the widget when the todo list changes -/// List todos = ref.watch(todosProvider); -/// -/// return ListView( -/// children: [ -/// for (final todo in todos) -/// CheckboxListTile( -/// value: todo.completed, -/// // When tapping on the todo, change its completed status -/// onChanged: (value) => ref.read(todosProvider.notifier).toggle(todo.id), -/// title: Text(todo.description), -/// ), -/// ], -/// ); -/// } -/// ``` -/// {@endtemplate} -class StateNotifierProvider, T> - extends _StateNotifierProviderBase { - /// {@macro riverpod.statenotifierprovider} - StateNotifierProvider( - this._createFn, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - StateNotifierProvider.internal( - this._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeStateNotifierProviderBuilder(); - - /// {@macro riverpod.family} - static const family = StateNotifierProviderFamilyBuilder(); - - final NotifierT Function(StateNotifierProviderRef ref) - _createFn; - - @override - NotifierT _create(StateNotifierProviderElement ref) { - return _createFn(ref); - } - - @override - StateNotifierProviderElement createElement( - ProviderContainer container, - ) { - return StateNotifierProviderElement._(this, container); - } - - @override - late final Refreshable notifier = _notifier(this); - - /// {@macro riverpod.override_with} - Override overrideWith( - Create> create, - ) { - return ProviderOverride( - origin: this, - providerOverride: StateNotifierProvider.internal( - create, - from: from, - argument: argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ), - ); - } -} - -/// The element of [StateNotifierProvider]. -class StateNotifierProviderElement, T> - extends ProviderElementBase - implements StateNotifierProviderRef { - StateNotifierProviderElement._(this.provider, super.container); - - @override - final _StateNotifierProviderBase provider; - - @override - NotifierT get notifier => _notifierNotifier.value; - final _notifierNotifier = ProxyElementValueListenable(); - - void Function()? _removeListener; - - @override - void create({required bool didChangeDependency}) { - final notifier = - _notifierNotifier.result = Result.guard(() => provider._create(this)); - - _removeListener = notifier - // TODO test requireState, as ref.read(p) is expected to throw if notifier creation failed - .requireState - .addListener(setState, fireImmediately: true); - } - - @override - bool updateShouldNotify(T previous, T next) { - // TODO test that updateShouldNotify is applied - return _notifierNotifier.result!.requireState - // ignore: invalid_use_of_protected_member - .updateShouldNotify(previous, next); - } - - @override - void runOnDispose() { - super.runOnDispose(); - - _removeListener?.call(); - _removeListener = null; - - final notifier = _notifierNotifier.result?.stateOrNull; - if (notifier != null) { - // TODO test STateNotifier.dispose is guarded - runGuarded(notifier.dispose); - } - _notifierNotifier.result = null; - } - - @override - void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, - }) { - super.visitChildren( - elementVisitor: elementVisitor, - listenableVisitor: listenableVisitor, - ); - listenableVisitor(_notifierNotifier); - } -} - -/// The [Family] of [StateNotifierProvider]. -class StateNotifierProviderFamily, T, Arg> - extends FunctionalFamily, T, Arg, - NotifierT, StateNotifierProvider> { - /// The [Family] of [StateNotifierProvider]. - StateNotifierProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: StateNotifierProvider.internal, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, - ); - - /// {@macro riverpod.override_with} - Override overrideWith( - NotifierT Function(StateNotifierProviderRef ref, Arg arg) - create, - ) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as StateNotifierProvider; - - return StateNotifierProvider.internal( - (ref) => create(ref, provider.argument as Arg), - from: provider.from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} From 6283a180fc2d91c8a90a8084d934c3defa614e34 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 21 Jan 2024 02:07:41 +0100 Subject: [PATCH 132/387] Fix some test errors --- packages/riverpod/lib/legacy.dart | 2 - .../legacy/state_notifier_provider.dart | 2 +- .../src/providers/legacy/state_provider.dart | 2 +- packages/riverpod/test/meta_test.dart | 1 + .../test/new/core/auto_dispose_test.dart | 1 + .../new/core/provider_container_test.dart | 1 + .../test/new/core/provider_observer_test.dart | 1 + packages/riverpod/test/new/core/ref_test.dart | 7 ++- .../test/new/core/select_async_test.dart | 1 + .../test/old/framework/family_test.dart | 1 + .../test/old/framework/modifiers_test.dart | 55 +++---------------- .../framework/provider_container_test.dart | 20 +++---- .../test/old/framework/ref_watch_test.dart | 1 + .../old/legacy/framework2/framework_test.dart | 1 + .../auto_dispose_family_test.dart | 1 + ..._dispose_state_notifier_provider_test.dart | 3 +- .../state_notifier_provider/family_test.dart | 1 + .../state_notifier_provider_test.dart | 6 +- .../state_provider/state_controller_test.dart | 1 + .../state_provider_auto_dispose_test.dart | 1 + ...ate_provider_family_auto_dispose_test.dart | 2 +- .../state_provider_family_test.dart | 2 +- .../state_provider/state_provider_test.dart | 5 +- .../auto_dispose_future_provider_test.dart | 3 +- .../future_provider/future_provider_test.dart | 5 +- .../provider/auto_dispose_provider_test.dart | 7 ++- .../provider/provider_test.dart | 13 +++-- .../scoped_provider/scoped_provider_test.dart | 1 + .../stream_notifier/async_notifier_test.dart | 1 + .../auto_dispose_stream_provider_test.dart | 3 +- .../stream_provider/stream_provider_test.dart | 11 ++-- 31 files changed, 72 insertions(+), 90 deletions(-) diff --git a/packages/riverpod/lib/legacy.dart b/packages/riverpod/lib/legacy.dart index 34b72829b..7905b80e2 100644 --- a/packages/riverpod/lib/legacy.dart +++ b/packages/riverpod/lib/legacy.dart @@ -1,5 +1,3 @@ -export 'riverpod.dart'; - export 'src/providers/legacy/state_controller.dart'; export 'src/providers/legacy/state_notifier_provider.dart'; export 'src/providers/legacy/state_provider.dart'; diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index 9d1c4e9b4..63978b501 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -146,7 +146,7 @@ final class StateNotifierProvider< // /// changes. /// This may happen if the provider is refreshed or one of its dependencies /// has changes. - ProviderListenable get notifier => _notifier(this); + Refreshable get notifier => _notifier(this); @override StateNotifierProviderElement createElement( diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index d62bf9841..fe6013ec2 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -92,7 +92,7 @@ final class StateProvider final StateT Function(StateProviderRef ref) _createFn; - ProviderListenable> get notifier => _notifier(this); + Refreshable> get notifier => _notifier(this); @override StateProviderElement createElement( diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index 6ab4ce311..d95361388 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -8,6 +8,7 @@ import 'package:test/test.dart'; void main() { // TODO verify that inherited members reapply annotations + // TODO assert all ".notifier" and ".future" implement Refreshable // This verifies that: // - All public APIs are documented diff --git a/packages/riverpod/test/new/core/auto_dispose_test.dart b/packages/riverpod/test/new/core/auto_dispose_test.dart index c45f956b7..ac9a58a54 100644 --- a/packages/riverpod/test/new/core/auto_dispose_test.dart +++ b/packages/riverpod/test/new/core/auto_dispose_test.dart @@ -1,4 +1,5 @@ import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index 649430d9d..aeed56724 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/new/core/provider_observer_test.dart b/packages/riverpod/test/new/core/provider_observer_test.dart index ddb138b33..609ed9a4b 100644 --- a/packages/riverpod/test/new/core/provider_observer_test.dart +++ b/packages/riverpod/test/new/core/provider_observer_test.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart index 3614537d4..9425589b9 100644 --- a/packages/riverpod/test/new/core/ref_test.dart +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; @@ -257,7 +258,7 @@ void main() { final listener = Listener(); final listener2 = Listener(); - late ProviderRef ref; + late Ref ref; final provider = Provider((r) { ref = r; ref.listenSelf(listener.call); @@ -639,7 +640,7 @@ void main() { test('cannot listen itself', () { final container = ProviderContainer.test(); final listener = Listener(); - late ProviderRef ref; + late Ref ref; late Provider provider; provider = Provider((r) { ref = r; @@ -1285,7 +1286,7 @@ void main() { 'the provider will not be disposed.', () async { final container = ProviderContainer.test(); late KeepAliveLink a; - late AutoDisposeRef ref; + late Ref ref; final provider = Provider.autoDispose((r) { ref = r; diff --git a/packages/riverpod/test/new/core/select_async_test.dart b/packages/riverpod/test/new/core/select_async_test.dart index 0d885080f..31b3451e8 100644 --- a/packages/riverpod/test/new/core/select_async_test.dart +++ b/packages/riverpod/test/new/core/select_async_test.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/old/framework/family_test.dart b/packages/riverpod/test/old/framework/family_test.dart index b1fc0826e..6d56330b6 100644 --- a/packages/riverpod/test/old/framework/family_test.dart +++ b/packages/riverpod/test/old/framework/family_test.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/old/framework/modifiers_test.dart b/packages/riverpod/test/old/framework/modifiers_test.dart index 2350804bf..350063396 100644 --- a/packages/riverpod/test/old/framework/modifiers_test.dart +++ b/packages/riverpod/test/old/framework/modifiers_test.dart @@ -1,6 +1,8 @@ // ignore_for_file: prefer_const_constructors +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/legacy_providers/builders.dart'; +import 'package:riverpod/src/builder.dart'; +import 'package:riverpod/src/internals.dart'; import 'package:test/test.dart'; void main() { @@ -17,7 +19,6 @@ void main() { }); test('FutureProvider', () { - final futureProviderBuilder = FutureProviderBuilder(); FutureProviderFamilyBuilder(); AutoDisposeFutureProviderBuilder(); AutoDisposeFutureProviderFamilyBuilder(); @@ -35,21 +36,12 @@ void main() { FutureProvider.family.autoDispose, ); expect( - futureProviderBuilder.autoDispose, - FutureProvider.autoDispose, - ); - expect( - futureProviderBuilder.family, - FutureProvider.family, - ); - expect( - futureProviderBuilder((ref) async => 42, name: 'foo'), + FutureProvider((ref) async => 42, name: 'foo'), isA>().having((s) => s.name, 'name', 'foo'), ); }); test('StreamProvider', () { - final streamProviderBuilder = StreamProviderBuilder(); StreamProviderFamilyBuilder(); AutoDisposeStreamProviderBuilder(); AutoDisposeStreamProviderFamilyBuilder(); @@ -67,21 +59,12 @@ void main() { StreamProvider.family.autoDispose, ); expect( - streamProviderBuilder.autoDispose, - StreamProvider.autoDispose, - ); - expect( - streamProviderBuilder.family, - StreamProvider.family, - ); - expect( - streamProviderBuilder((ref) => Stream.value(42), name: 'foo'), + StreamProvider((ref) => Stream.value(42), name: 'foo'), isA>().having((s) => s.name, 'name', 'foo'), ); }); test('StateNotifierProvider', () { - final stateNotifierProviderBuilder = StateNotifierProviderBuilder(); StateNotifierProviderFamilyBuilder(); AutoDisposeStateNotifierProviderBuilder(); AutoDisposeStateNotifierProviderFamilyBuilder(); @@ -99,15 +82,7 @@ void main() { StateNotifierProvider.family.autoDispose, ); expect( - stateNotifierProviderBuilder.autoDispose, - StateNotifierProvider.autoDispose, - ); - expect( - stateNotifierProviderBuilder.family, - StateNotifierProvider.family, - ); - expect( - stateNotifierProviderBuilder, int>( + StateNotifierProvider, int>( (ref) => StateController(42), name: 'foo', ), @@ -117,7 +92,6 @@ void main() { }); test('Provider', () { - final providerBuilder = ProviderBuilder(); ProviderFamilyBuilder(); AutoDisposeProviderBuilder(); AutoDisposeProviderFamilyBuilder(); @@ -135,22 +109,13 @@ void main() { Provider.family.autoDispose, ); expect( - providerBuilder.autoDispose, - Provider.autoDispose, - ); - expect( - providerBuilder.family, - Provider.family, - ); - expect( - providerBuilder((ref) => StateController(42), name: 'foo'), + Provider((ref) => StateController(42), name: 'foo'), isA>>() .having((s) => s.name, 'name', 'foo'), ); }); test('StateProvider', () { - final stateProviderBuilder = StateProviderBuilder(); StateProviderFamilyBuilder(); expect( @@ -158,11 +123,7 @@ void main() { const StateProviderFamilyBuilder(), ); expect( - stateProviderBuilder.family, - StateProvider.family, - ); - expect( - stateProviderBuilder((ref) => StateController(42), name: 'foo'), + StateProvider((ref) => StateController(42), name: 'foo'), isA>>() .having((s) => s.name, 'name', 'foo'), ); diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 5fdcfb8bd..19466e6f9 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -17,6 +17,9 @@ void main() { }); final constantHashBuild = OnBuildMock(); final constantHash = Provider.internal( + isAutoDispose: false, + from: null, + argument: null, name: null, dependencies: null, allTransitiveDependencies: null, @@ -29,6 +32,9 @@ void main() { var hashResult = '42'; final changingHashBuild = OnBuildMock(); final changingHash = Provider.internal( + isAutoDispose: false, + from: null, + argument: null, name: null, dependencies: null, allTransitiveDependencies: null, @@ -265,11 +271,8 @@ void main() { var sub = container.listen(provider, (_, __) {}); expect( - container.getAllProviderElements(), - unorderedMatches([ - isA>(), - isA>(), - ]), + container.getAllProviderElements().map((e) => e.origin), + unorderedEquals([provider, unrelated]), ); sub.close(); @@ -283,11 +286,8 @@ void main() { sub = container.listen(provider, (_, __) {}); expect( - container.getAllProviderElements(), - unorderedMatches([ - isA>(), - isA>(), - ]), + container.getAllProviderElements().map((e) => e.origin), + unorderedEquals([provider, unrelated]), ); }); }); diff --git a/packages/riverpod/test/old/framework/ref_watch_test.dart b/packages/riverpod/test/old/framework/ref_watch_test.dart index ef9213566..b9bcb24aa 100644 --- a/packages/riverpod/test/old/framework/ref_watch_test.dart +++ b/packages/riverpod/test/old/framework/ref_watch_test.dart @@ -1,4 +1,5 @@ import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/old/legacy/framework2/framework_test.dart b/packages/riverpod/test/old/legacy/framework2/framework_test.dart index 315f808ad..06fe01002 100644 --- a/packages/riverpod/test/old/legacy/framework2/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework2/framework_test.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart index f5a3ab47b..ad2abed15 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart @@ -1,3 +1,4 @@ +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart index d1193a5d7..6fde34f00 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart @@ -1,4 +1,5 @@ import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; @@ -8,7 +9,7 @@ void main() { test('can read and set current StateNotifier', () async { final container = ProviderContainer.test(); final listener = Listener(); - late AutoDisposeStateNotifierProviderRef ref; + late StateNotifierProviderRef ref; final provider = StateNotifierProvider.autoDispose((r) { ref = r; return Counter(); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart index 4e725767d..d185a5fe4 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart @@ -1,4 +1,5 @@ import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart index c079350fa..4fa7cf1b5 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_types_on_closure_parameters import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; @@ -20,8 +21,7 @@ void main() { (StateNotifierProviderRef ref) => TestNotifier(42), ), autoDispose.overrideWith( - (AutoDisposeStateNotifierProviderRef ref) => - TestNotifier(84), + (StateNotifierProviderRef ref) => TestNotifier(84), ), ], ); @@ -46,7 +46,7 @@ void main() { ), autoDisposeFamily.overrideWith( ( - AutoDisposeStateNotifierProviderRef ref, + StateNotifierProviderRef ref, int arg, ) => TestNotifier(84 + arg), diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_controller_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_controller_test.dart index a45896c5f..7b385d1f2 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_controller_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_controller_test.dart @@ -1,3 +1,4 @@ +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart index fdc1b0746..075a9f8c1 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart @@ -1,4 +1,5 @@ import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart index 2620e7195..5a979263a 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart @@ -1,7 +1,7 @@ +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; - void main() { test('supports .name', () { expect( diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart index ba417e83b..88d8bcbdc 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart @@ -1,7 +1,7 @@ +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; - void main() { test('supports .name', () { expect( diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart index 04ac24eab..46aed592a 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_types_on_closure_parameters import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; @@ -17,7 +18,7 @@ void main() { final container = ProviderContainer.test( overrides: [ provider.overrideWith((StateProviderRef ref) => 42), - autoDispose.overrideWith((AutoDisposeStateProviderRef ref) => 84), + autoDispose.overrideWith((StateProviderRef ref) => 84), ], ); @@ -36,7 +37,7 @@ void main() { (StateProviderRef ref, int arg) => '42 $arg', ), autoDisposeFamily.overrideWith( - (AutoDisposeStateProviderRef ref, int arg) => '84 $arg', + (StateProviderRef ref, int arg) => '84 $arg', ), ], ); diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart index 9f3fd2f57..b5f68f7d6 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; @@ -10,7 +11,7 @@ void main() { test('can read and set current AsyncValue', () { final container = ProviderContainer.test(); final listener = Listener>(); - late AutoDisposeFutureProviderRef ref; + late Ref> ref; final provider = FutureProvider.autoDispose((r) { ref = r; return 0; diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart index 543d2465a..8e78f9121 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart @@ -3,6 +3,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; @@ -79,7 +80,7 @@ void main() { overrides: [ provider.overrideWith((FutureProviderRef ref) => 42), autoDispose.overrideWith( - (AutoDisposeFutureProviderRef ref) => 84, + (FutureProviderRef ref) => 84, ), ], ); @@ -137,7 +138,7 @@ void main() { (FutureProviderRef ref, int arg) => '42 $arg', ), autoDisposeFamily.overrideWith( - (AutoDisposeFutureProviderRef ref, int arg) => '84 $arg', + (FutureProviderRef ref, int arg) => '84 $arg', ), ], ); diff --git a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart index 66c37306f..7561dc544 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart @@ -1,4 +1,5 @@ import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; @@ -10,7 +11,7 @@ void main() { test('can read and change current value', () { final container = ProviderContainer.test(); final listener = Listener(); - late ProviderRef ref; + late Ref ref; final provider = Provider.autoDispose((r) { ref = r; return 0; @@ -99,8 +100,8 @@ void main() { () async { final container = ProviderContainer.test(); final listener = Listener(); - late AutoDisposeProviderRef ref; - final provider = AutoDisposeProvider((r) { + late Ref ref; + final provider = Provider.autoDispose((r) { ref = r; return 0; }); diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart index 2979acdc8..387adc6ef 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_types_on_closure_parameters import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; @@ -13,9 +14,9 @@ void main() { final autoDispose = Provider.autoDispose((ref) => 0); final container = ProviderContainer.test( overrides: [ - provider.overrideWith((ProviderRef ref) => 42), + provider.overrideWith((Ref ref) => 42), autoDispose.overrideWith( - (AutoDisposeProviderRef ref) => 84, + (Ref ref) => 84, ), ], ); @@ -31,9 +32,9 @@ void main() { ); final container = ProviderContainer.test( overrides: [ - family.overrideWith((ProviderRef ref, int arg) => '42 $arg'), + family.overrideWith((Ref ref, int arg) => '42 $arg'), autoDisposeFamily.overrideWith( - (AutoDisposeProviderRef ref, int arg) => '84 $arg', + (Ref ref, int arg) => '84 $arg', ), ], ); @@ -77,7 +78,7 @@ void main() { test('can read and change current value', () { final container = ProviderContainer.test(); final listener = Listener(); - late ProviderRef ref; + late Ref ref; final provider = Provider((r) { ref = r; return 0; @@ -153,7 +154,7 @@ void main() { () async { final container = ProviderContainer.test(); final listener = Listener(); - late ProviderRef ref; + late Ref ref; final provider = Provider((r) { ref = r; return 0; diff --git a/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart index 752db9721..1bc3d9e48 100644 --- a/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart @@ -1,3 +1,4 @@ +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart b/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart index 32face8f7..617242152 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart @@ -4,6 +4,7 @@ import 'dart:async'; import 'package:meta/meta.dart'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart index fc6bb3e59..8dd7244fa 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; @@ -11,7 +12,7 @@ void main() { test('can read and set current AsyncValue', () async { final container = ProviderContainer.test(); final listener = Listener>(); - late AutoDisposeStreamProviderRef ref; + late Ref> ref; final provider = StreamProvider.autoDispose((r) { ref = r; return Stream.value(0); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart index 947b690ce..ca1e19da7 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart @@ -3,6 +3,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; @@ -24,11 +25,11 @@ void main() { ); final container = ProviderContainer.test( overrides: [ - provider.overrideWith((StreamProviderRef ref) { + provider.overrideWith((Ref> ref) { ref.state = const AsyncData(42); return Stream.value(43); }), - autoDispose.overrideWith((AutoDisposeStreamProviderRef ref) { + autoDispose.overrideWith((Ref> ref) { ref.state = const AsyncData(84); return Stream.value(85); }), @@ -53,13 +54,13 @@ void main() { final container = ProviderContainer.test( overrides: [ family.overrideWith( - (StreamProviderRef ref, int arg) { + (Ref> ref, int arg) { ref.state = AsyncData('42 $arg'); return Stream.value('43 $arg'); }, ), autoDisposeFamily.overrideWith( - (AutoDisposeStreamProviderRef ref, int arg) { + (Ref> ref, int arg) { ref.state = AsyncData('84 $arg'); return Stream.value('85 $arg'); }, @@ -166,7 +167,7 @@ void main() { test('can read and set current AsyncValue', () async { final container = ProviderContainer.test(); final listener = Listener>(); - late StreamProviderRef ref; + late Ref> ref; final provider = StreamProvider((r) { ref = r; return Stream.value(0); From bcb2f7575517c60292e638930adea7e9a343de65 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 21 Jan 2024 02:37:55 +0100 Subject: [PATCH 133/387] Fix test/new --- packages/riverpod/lib/legacy.dart | 1 + packages/riverpod/lib/src/core/override.dart | 6 +----- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/packages/riverpod/lib/legacy.dart b/packages/riverpod/lib/legacy.dart index 7905b80e2..713b6fc19 100644 --- a/packages/riverpod/lib/legacy.dart +++ b/packages/riverpod/lib/legacy.dart @@ -1,3 +1,4 @@ +// TODO add to flutter_riverpod and hooks_riverpod too export 'src/providers/legacy/state_controller.dart'; export 'src/providers/legacy/state_notifier_provider.dart'; export 'src/providers/legacy/state_provider.dart'; diff --git a/packages/riverpod/lib/src/core/override.dart b/packages/riverpod/lib/src/core/override.dart index a2375e15b..6441e89dd 100644 --- a/packages/riverpod/lib/src/core/override.dart +++ b/packages/riverpod/lib/src/core/override.dart @@ -55,11 +55,7 @@ class ProviderOverride implements _ProviderOverride { ProviderOverride({ required this.origin, required this.providerOverride, - }) : assert( - providerOverride.dependencies == null && - providerOverride.allTransitiveDependencies == null, - 'Overriding a provider with dependencies is not supported.', - ); + }); /// The provider that is overridden. final ProviderBase origin; From 385cc825872b856d71f274010945755be00452b1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 22 Jan 2024 13:00:16 +0100 Subject: [PATCH 134/387] W --- packages/riverpod/lib/src/builder.dart | 6 +- .../lib/src/providers/async_notifier.dart | 5 +- .../src/providers/async_notifier/family.dart | 68 +------------------ .../src/providers/async_notifier/orphan.dart | 4 +- packages/riverpod/test/new/matrix.dart | 27 ++++++++ .../async_notifier/factory.dart | 4 +- 6 files changed, 40 insertions(+), 74 deletions(-) create mode 100644 packages/riverpod/test/new/matrix.dart diff --git a/packages/riverpod/lib/src/builder.dart b/packages/riverpod/lib/src/builder.dart index ce77febc9..893d0ec38 100644 --- a/packages/riverpod/lib/src/builder.dart +++ b/packages/riverpod/lib/src/builder.dart @@ -738,13 +738,13 @@ class AsyncNotifierProviderFamilyBuilder { const AsyncNotifierProviderFamilyBuilder(); /// {@macro riverpod.autoDispose} - AsyncNotifierProvider - call, StateT>( + FamilyAsyncNotifierProvider + call, StateT, ArgT>( NotifierT Function() create, { String? name, Iterable? dependencies, }) { - return AsyncNotifierProvider( + return FamilyAsyncNotifierProvider( create, name: name, dependencies: dependencies, diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index f7593298b..cceb17cc8 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -11,14 +11,15 @@ import 'notifier.dart'; part 'async_notifier/orphan.dart'; part 'async_notifier/family.dart'; -abstract class _AsyncNotifierBase extends ClassBase< // +@internal +abstract class AsyncNotifierBase extends ClassBase< // AsyncValue, FutureOr> // with AsyncClassMixin> {} abstract base class _AsyncNotifierProviderBase< // - NotifierT extends _AsyncNotifierBase, + NotifierT extends AsyncNotifierBase, StateT> // extends ClassProvider< // NotifierT, diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index b3aefa9a3..bf7e6f039 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -4,7 +4,7 @@ part of '../async_notifier.dart'; /// /// {@macro riverpod.async_notifier_provider_modifier} abstract class FamilyAsyncNotifier - extends _AsyncNotifierBase { + extends AsyncNotifierBase { /// {@template riverpod.notifier.family_arg} /// The argument that was passed to this family. /// @@ -23,68 +23,6 @@ abstract class FamilyAsyncNotifier FutureOr build(Arg arg); } -final class FamilyAsyncNotifierProvider< // - NotifierT extends FamilyAsyncNotifier, - StateT, - ArgT> // - extends _AsyncNotifierProviderBase { - /// An implementation detail of Riverpod - const FamilyAsyncNotifierProvider._( - super._createNotifier, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required super.argument, - required super.isAutoDispose, - required super.runNotifierBuildOverride, - }); - - @override - _AsyncNotifierProviderElement createElement( - ProviderContainer container, - ) { - return _AsyncNotifierProviderElement(this, container); - } - - FamilyAsyncNotifierProvider _copyWith({ - NotifierT Function()? create, - RunNotifierBuild< // - NotifierT, - FutureOr, - Ref>>? - build, - }) { - return FamilyAsyncNotifierProvider._( - create ?? _createNotifier, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - isAutoDispose: isAutoDispose, - runNotifierBuildOverride: build ?? runNotifierBuildOverride, - from: from, - argument: argument, - ); - } - - @override - FamilyAsyncNotifierProvider copyWithBuild( - RunNotifierBuild, Ref>> - build, - ) { - return _copyWith(build: build); - } - - @override - FamilyAsyncNotifierProvider copyWithCreate( - NotifierT Function() create, - ) { - return _copyWith(create: create); - } -} - /// The [Family] of [AsyncNotifierProvider]. class AsyncNotifierProviderFamily< // NotifierT extends FamilyAsyncNotifier, @@ -96,14 +34,14 @@ class AsyncNotifierProviderFamily< // Ref>, ArgT, FutureOr, - FamilyAsyncNotifierProvider> { + AsyncNotifierProvider> { /// The [Family] of [AsyncNotifierProvider]. AsyncNotifierProviderFamily._( super._createFn, { super.name, super.dependencies, }) : super( - providerFactory: FamilyAsyncNotifierProvider._, + providerFactory: AsyncNotifierProvider.new, debugGetCreateSourceHash: null, isAutoDispose: false, allTransitiveDependencies: diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index 1d6b22e5d..88424932a 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -16,7 +16,7 @@ part of '../async_notifier.dart'; /// {@endtemplate} /// /// {@macro riverpod.async_notifier_provider_modifier} -abstract class AsyncNotifier extends _AsyncNotifierBase { +abstract class AsyncNotifier extends AsyncNotifierBase { /// {@template riverpod.async_notifier.build} /// Initialize an [AsyncNotifier]. /// @@ -153,7 +153,7 @@ final class AsyncNotifierProvider< // } class _AsyncNotifierProviderElement< // - NotifierT extends _AsyncNotifierBase, + NotifierT extends AsyncNotifierBase, StateT> // extends ClassProviderElement< // NotifierT, diff --git a/packages/riverpod/test/new/matrix.dart b/packages/riverpod/test/new/matrix.dart new file mode 100644 index 000000000..1acc87a57 --- /dev/null +++ b/packages/riverpod/test/new/matrix.dart @@ -0,0 +1,27 @@ +import 'package:riverpod/src/internals.dart'; + +typedef AsyncFactory = AsyncNotifierProvider + Function, StateT>( + NotifierT Function(), { + Iterable? dependencies, + String? name, +}); + +typedef AsyncFamilyFactory = AsyncNotifierProvider + Function, StateT>( + NotifierT Function(), { + Iterable? dependencies, + String? name, +}); + +final asyncOrphanFactory = [ + AsyncNotifierProvider.new, + AsyncNotifierProvider.autoDispose.call, +]; + +final asyncFamilyFactory = [ + AsyncNotifierProvider.family.call, + AsyncNotifierProvider.autoDispose.family.call, +]; + +final asyncFactory = []; diff --git a/packages/riverpod/test/old/legacy_providers/async_notifier/factory.dart b/packages/riverpod/test/old/legacy_providers/async_notifier/factory.dart index 2bb7a8274..42f7c367e 100644 --- a/packages/riverpod/test/old/legacy_providers/async_notifier/factory.dart +++ b/packages/riverpod/test/old/legacy_providers/async_notifier/factory.dart @@ -35,10 +35,10 @@ List matrix({ AsyncNotifierFactory( label: 'AsyncNotifierProvider', isAutoDispose: false, - provider: AsyncNotifierProviderImpl.new, + provider: AsyncNotifierProvider.new, notifier: AsyncTestNotifier.new, testProvider: (createNotifier) { - return AsyncNotifierProviderImpl, T>( + return AsyncNotifierProvider, T>( createNotifier, ); }, From 4b4c42d5c663c3aa58658f0d379c8619380e08d8 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 31 Jan 2024 17:12:11 +0100 Subject: [PATCH 135/387] W --- packages/riverpod/lib/riverpod.dart | 49 +++------- packages/riverpod/lib/src/builder.dart | 96 +++++++++---------- .../lib/src/providers/async_notifier.dart | 35 +++++++ .../src/providers/async_notifier/family.dart | 87 ++++++++++++----- .../src/providers/async_notifier/orphan.dart | 35 ------- .../lib/src/providers/notifier/family.dart | 28 +----- .../src/providers/stream_notifier/family.dart | 26 +---- .../bin/generate_providers.dart | 72 ++++++++++---- 8 files changed, 220 insertions(+), 208 deletions(-) diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index bedaeabe9..b5355d7c0 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -10,19 +10,14 @@ export 'src/framework.dart' ProviderScheduler, debugCanModifyProviders, Vsync, - _ValueProviderElement, ValueProvider, FamilyCreate, - AsyncSelector, FunctionalFamily, - AutoDisposeProviderElementMixin, FamilyOverride, ClassFamily, SetupFamilyOverride, SetupOverride, - AutoDisposeNotifierFamilyBase, ProviderOverride, - AutoDisposeFamilyBase, DebugGetCreateSourceHash, ClassProviderFactory, FunctionalProviderFactory, @@ -37,41 +32,25 @@ export 'src/framework.dart' TransitiveProviderOverride, ProviderPointer, ProviderPointerManager, - ProviderDirectory; - -export 'src/providers/async_notifier.dart' - hide - AsyncNotifierProviderImpl, - AutoDisposeAsyncNotifierProviderImpl, - AutoDisposeFamilyAsyncNotifierProviderImpl, - FamilyAsyncNotifierProviderImpl, - _AsyncNotifierBase, - AsyncNotifierProviderBase, + ProviderDirectory, + AsyncClassMixin, + FutureModifier, + ProviderElementBase, + ClassBaseX, CancelAsyncSubscription, - BuildlessAsyncNotifier, - BuildlessAutoDisposeAsyncNotifier, - FutureHandlerProviderElementMixin, - FamilyStreamNotifierProviderImpl, - StreamNotifierProviderImpl, - AutoDisposeStreamNotifierProviderImpl, - AutoDisposeFamilyStreamNotifierProviderImpl, - StreamNotifierProviderBase, - BuildlessAutoDisposeStreamNotifier, - BuildlessStreamNotifier; + ClassBase, + FutureModifierElement, + RunNotifierBuild, + FunctionalProvider, + ClassProvider; + +export 'src/providers/async_notifier.dart' hide AsyncNotifierBase; // TODO changelog breaking: StateNotifier & co are no-longer exported from pkg:riverpod/riverpod.dart // Use pkg:riverpod/legacy.dart export 'src/providers/future_provider.dart'; export 'src/providers/notifier.dart' - hide - _NotifierBase, - _NotifierProviderBase, - AutoDisposeFamilyNotifierProviderImpl, - AutoDisposeNotifierProviderImpl, - FamilyNotifierProviderImpl, - NotifierProvider, - BuildlessAutoDisposeNotifier, - BuildlessNotifier; -export 'src/providers/provider.dart' hide InternalProvider; + hide NotifierProvider, FamilyNotifierProvider; +export 'src/providers/provider.dart'; export 'src/providers/stream_provider.dart'; diff --git a/packages/riverpod/lib/src/builder.dart b/packages/riverpod/lib/src/builder.dart index 893d0ec38..6e3f9e066 100644 --- a/packages/riverpod/lib/src/builder.dart +++ b/packages/riverpod/lib/src/builder.dart @@ -600,8 +600,8 @@ class AutoDisposeStreamProviderFamilyBuilder { } @internal -class NotifierProviderFamilyBuilder { - const NotifierProviderFamilyBuilder(); +class AutoDisposeNotifierProviderBuilder { + const AutoDisposeNotifierProviderBuilder(); /// {@macro riverpod.autoDispose} NotifierProvider @@ -613,36 +613,36 @@ class NotifierProviderFamilyBuilder { return NotifierProvider( create, name: name, + isAutoDispose: true, dependencies: dependencies, ); } - /// {@macro riverpod.autoDispose} - AutoDisposeNotifierProviderFamilyBuilder get autoDispose => + /// {@macro riverpod.family} + AutoDisposeNotifierProviderFamilyBuilder get family => const AutoDisposeNotifierProviderFamilyBuilder(); } @internal -class AutoDisposeNotifierProviderBuilder { - const AutoDisposeNotifierProviderBuilder(); +class NotifierProviderFamilyBuilder { + const NotifierProviderFamilyBuilder(); /// {@macro riverpod.autoDispose} - NotifierProvider - call, StateT>( + NotifierProviderFamily + call, StateT, ArgT>( NotifierT Function() create, { String? name, Iterable? dependencies, }) { - return NotifierProvider( + return NotifierProviderFamily.internal( create, name: name, - isAutoDispose: true, dependencies: dependencies, ); } - /// {@macro riverpod.family} - AutoDisposeNotifierProviderFamilyBuilder get family => + /// {@macro riverpod.autoDispose} + AutoDisposeNotifierProviderFamilyBuilder get autoDispose => const AutoDisposeNotifierProviderFamilyBuilder(); } @@ -651,13 +651,13 @@ class AutoDisposeNotifierProviderFamilyBuilder { const AutoDisposeNotifierProviderFamilyBuilder(); /// {@macro riverpod.autoDispose} - NotifierProvider - call, StateT>( + NotifierProviderFamily + call, StateT, ArgT>( NotifierT Function() create, { String? name, Iterable? dependencies, }) { - return NotifierProvider( + return NotifierProviderFamily.internal( create, name: name, isAutoDispose: true, @@ -667,8 +667,8 @@ class AutoDisposeNotifierProviderFamilyBuilder { } @internal -class StreamNotifierProviderFamilyBuilder { - const StreamNotifierProviderFamilyBuilder(); +class AutoDisposeStreamNotifierProviderBuilder { + const AutoDisposeStreamNotifierProviderBuilder(); /// {@macro riverpod.autoDispose} StreamNotifierProvider @@ -680,36 +680,36 @@ class StreamNotifierProviderFamilyBuilder { return StreamNotifierProvider( create, name: name, + isAutoDispose: true, dependencies: dependencies, ); } - /// {@macro riverpod.autoDispose} - AutoDisposeStreamNotifierProviderFamilyBuilder get autoDispose => + /// {@macro riverpod.family} + AutoDisposeStreamNotifierProviderFamilyBuilder get family => const AutoDisposeStreamNotifierProviderFamilyBuilder(); } @internal -class AutoDisposeStreamNotifierProviderBuilder { - const AutoDisposeStreamNotifierProviderBuilder(); +class StreamNotifierProviderFamilyBuilder { + const StreamNotifierProviderFamilyBuilder(); /// {@macro riverpod.autoDispose} - StreamNotifierProvider - call, StateT>( + StreamNotifierProviderFamily + call, StateT, ArgT>( NotifierT Function() create, { String? name, Iterable? dependencies, }) { - return StreamNotifierProvider( + return StreamNotifierProviderFamily.internal( create, name: name, - isAutoDispose: true, dependencies: dependencies, ); } - /// {@macro riverpod.family} - AutoDisposeStreamNotifierProviderFamilyBuilder get family => + /// {@macro riverpod.autoDispose} + AutoDisposeStreamNotifierProviderFamilyBuilder get autoDispose => const AutoDisposeStreamNotifierProviderFamilyBuilder(); } @@ -718,13 +718,13 @@ class AutoDisposeStreamNotifierProviderFamilyBuilder { const AutoDisposeStreamNotifierProviderFamilyBuilder(); /// {@macro riverpod.autoDispose} - StreamNotifierProvider - call, StateT>( + StreamNotifierProviderFamily + call, StateT, ArgT>( NotifierT Function() create, { String? name, Iterable? dependencies, }) { - return StreamNotifierProvider( + return StreamNotifierProviderFamily.internal( create, name: name, isAutoDispose: true, @@ -734,49 +734,49 @@ class AutoDisposeStreamNotifierProviderFamilyBuilder { } @internal -class AsyncNotifierProviderFamilyBuilder { - const AsyncNotifierProviderFamilyBuilder(); +class AutoDisposeAsyncNotifierProviderBuilder { + const AutoDisposeAsyncNotifierProviderBuilder(); /// {@macro riverpod.autoDispose} - FamilyAsyncNotifierProvider - call, StateT, ArgT>( + AsyncNotifierProvider + call, StateT>( NotifierT Function() create, { String? name, Iterable? dependencies, }) { - return FamilyAsyncNotifierProvider( + return AsyncNotifierProvider( create, name: name, + isAutoDispose: true, dependencies: dependencies, ); } - /// {@macro riverpod.autoDispose} - AutoDisposeAsyncNotifierProviderFamilyBuilder get autoDispose => + /// {@macro riverpod.family} + AutoDisposeAsyncNotifierProviderFamilyBuilder get family => const AutoDisposeAsyncNotifierProviderFamilyBuilder(); } @internal -class AutoDisposeAsyncNotifierProviderBuilder { - const AutoDisposeAsyncNotifierProviderBuilder(); +class AsyncNotifierProviderFamilyBuilder { + const AsyncNotifierProviderFamilyBuilder(); /// {@macro riverpod.autoDispose} - AsyncNotifierProvider - call, StateT>( + AsyncNotifierProviderFamily + call, StateT, ArgT>( NotifierT Function() create, { String? name, Iterable? dependencies, }) { - return AsyncNotifierProvider( + return AsyncNotifierProviderFamily.internal( create, name: name, - isAutoDispose: true, dependencies: dependencies, ); } - /// {@macro riverpod.family} - AutoDisposeAsyncNotifierProviderFamilyBuilder get family => + /// {@macro riverpod.autoDispose} + AutoDisposeAsyncNotifierProviderFamilyBuilder get autoDispose => const AutoDisposeAsyncNotifierProviderFamilyBuilder(); } @@ -785,13 +785,13 @@ class AutoDisposeAsyncNotifierProviderFamilyBuilder { const AutoDisposeAsyncNotifierProviderFamilyBuilder(); /// {@macro riverpod.autoDispose} - AsyncNotifierProvider - call, StateT>( + AsyncNotifierProviderFamily + call, StateT, ArgT>( NotifierT Function() create, { String? name, Iterable? dependencies, }) { - return AsyncNotifierProvider( + return AsyncNotifierProviderFamily.internal( create, name: name, isAutoDispose: true, diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index cceb17cc8..f30ce905e 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -45,3 +45,38 @@ abstract base class _AsyncNotifierProviderBase< // @override NotifierT create() => _createNotifier(); } + +class _AsyncNotifierProviderElement< // + NotifierT extends AsyncNotifierBase, + StateT> // + extends ClassProviderElement< // + NotifierT, + AsyncValue, + FutureOr> // + with + FutureModifierElement { + _AsyncNotifierProviderElement(this.provider, super.container); + + @override + final _AsyncNotifierProviderBase provider; + + @override + void handleError( + Object error, + StackTrace stackTrace, { + required bool didChangeDependency, + }) { + onError(AsyncError(error, stackTrace), seamless: !didChangeDependency); + } + + @override + void handleValue( + FutureOr created, { + required bool didChangeDependency, + }) { + handleFuture( + () => created, + didChangeDependency: didChangeDependency, + ); + } +} diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index bf7e6f039..d5383b8d3 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -34,40 +34,81 @@ class AsyncNotifierProviderFamily< // Ref>, ArgT, FutureOr, - AsyncNotifierProvider> { + FamilyAsyncNotifierProvider> { /// The [Family] of [AsyncNotifierProvider]. - AsyncNotifierProviderFamily._( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: AsyncNotifierProvider.new, - debugGetCreateSourceHash: null, - isAutoDispose: false, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - ); - - AsyncNotifierProviderFamily._autoDispose( + @internal + AsyncNotifierProviderFamily.internal( super._createFn, { super.name, super.dependencies, + super.isAutoDispose = false, }) : super( providerFactory: FamilyAsyncNotifierProvider._, - debugGetCreateSourceHash: null, - isAutoDispose: true, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), + debugGetCreateSourceHash: null, ); +} - /// The [Family] of [AsyncNotifierProvider]. - @internal - AsyncNotifierProviderFamily.internal( - super._createFn, { - super.name, - super.dependencies, +/// The provider returned by [AsyncNotifierProviderFamily]. +final class FamilyAsyncNotifierProvider< // + NotifierT extends FamilyAsyncNotifier, + StateT, + ArgT> // + extends _AsyncNotifierProviderBase { + /// An implementation detail of Riverpod + const FamilyAsyncNotifierProvider._( + super._createNotifier, { + required super.name, + required super.dependencies, required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, + required super.from, + required super.argument, required super.isAutoDispose, - }) : super(providerFactory: FamilyAsyncNotifierProvider._); + required super.runNotifierBuildOverride, + }); + + FamilyAsyncNotifierProvider _copyWith({ + NotifierT Function()? create, + RunNotifierBuild, Ref>>? + build, + }) { + return FamilyAsyncNotifierProvider._( + create ?? _createNotifier, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + argument: argument, + isAutoDispose: isAutoDispose, + runNotifierBuildOverride: build ?? runNotifierBuildOverride, + ); + } + + @internal + @override + _AsyncNotifierProviderElement createElement( + ProviderContainer container, + ) { + return _AsyncNotifierProviderElement(this, container); + } + + @internal + @override + FamilyAsyncNotifierProvider copyWithBuild( + RunNotifierBuild, Ref>>? + build, + ) { + return _copyWith(build: build); + } + + @internal + @override + FamilyAsyncNotifierProvider copyWithCreate( + NotifierT Function() create, + ) { + return _copyWith(create: create); + } } diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index 88424932a..b6a072dbb 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -151,38 +151,3 @@ final class AsyncNotifierProvider< // return _copyWith(create: create); } } - -class _AsyncNotifierProviderElement< // - NotifierT extends AsyncNotifierBase, - StateT> // - extends ClassProviderElement< // - NotifierT, - AsyncValue, - FutureOr> // - with - FutureModifierElement { - _AsyncNotifierProviderElement(this.provider, super.container); - - @override - final _AsyncNotifierProviderBase provider; - - @override - void handleError( - Object error, - StackTrace stackTrace, { - required bool didChangeDependency, - }) { - onError(AsyncError(error, stackTrace), seamless: !didChangeDependency); - } - - @override - void handleValue( - FutureOr created, { - required bool didChangeDependency, - }) { - handleFuture( - () => created, - didChangeDependency: didChangeDependency, - ); - } -} diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index 6f7a5c0c4..a051c4deb 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -85,38 +85,16 @@ class NotifierProviderFamily< StateT, FamilyNotifierProvider> { /// The [Family] of [AsyncNotifierProvider]. - NotifierProviderFamily._( + @internal + NotifierProviderFamily.internal( super._createFn, { super.name, super.dependencies, + super.isAutoDispose = false, }) : super( providerFactory: FamilyNotifierProvider._, - debugGetCreateSourceHash: null, - isAutoDispose: false, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), - ); - - NotifierProviderFamily._autoDispose( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: FamilyNotifierProvider._, debugGetCreateSourceHash: null, - isAutoDispose: true, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), ); - - /// The [Family] of [AsyncNotifierProvider]. - @internal - NotifierProviderFamily.internal( - super._createFn, { - super.name, - super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.isAutoDispose, - }) : super(providerFactory: FamilyNotifierProvider._); } diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index 9ccf8162a..12eaa6f51 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -97,38 +97,16 @@ class StreamNotifierProviderFamily< // Stream, FamilyStreamNotifierProvider> { /// The [Family] of [StreamNotifierProvider]. - StreamNotifierProviderFamily._( + @internal + StreamNotifierProviderFamily.internal( super._createFn, { super.name, super.dependencies, super.isAutoDispose = false, }) : super( providerFactory: FamilyStreamNotifierProvider._, - debugGetCreateSourceHash: null, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), - ); - - StreamNotifierProviderFamily._autoDispose( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: FamilyStreamNotifierProvider._, - isAutoDispose: true, debugGetCreateSourceHash: null, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), ); - - /// The [Family] of [StreamNotifierProvider]. - @internal - StreamNotifierProviderFamily.internal( - super._createFn, { - super.name, - super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.isAutoDispose, - }) : super(providerFactory: FamilyStreamNotifierProvider._); } diff --git a/tools/generate_providers/bin/generate_providers.dart b/tools/generate_providers/bin/generate_providers.dart index 64ce7e7d9..d05eed261 100644 --- a/tools/generate_providers/bin/generate_providers.dart +++ b/tools/generate_providers/bin/generate_providers.dart @@ -49,9 +49,13 @@ class _FunctionalBuilder extends _Builder { class _NotifierBuilder extends _Builder { _NotifierBuilder( super.providerName, { + required this.isFamily, required super.genericsDefinition, required super.genericsUsage, }); + + // final String? familyBuilderName; + final bool isFamily; } typedef Matrix = ({ @@ -124,21 +128,45 @@ Future main(List args) async { ), _NotifierBuilder( 'NotifierProvider', + isFamily: false, genericsUsage: '', genericsDefinition: ', StateT>', ), + _NotifierBuilder( + 'NotifierProvider', + isFamily: true, + genericsUsage: '', + genericsDefinition: + ', StateT, ArgT>', + ), _NotifierBuilder( 'StreamNotifierProvider', + isFamily: false, genericsUsage: '', genericsDefinition: ', StateT>', ), + _NotifierBuilder( + 'StreamNotifierProvider', + isFamily: true, + genericsUsage: '', + genericsDefinition: + ', StateT, ArgT>', + ), _NotifierBuilder( 'AsyncNotifierProvider', + isFamily: false, genericsUsage: '', genericsDefinition: ', StateT>', ), + _NotifierBuilder( + 'AsyncNotifierProvider', + isFamily: true, + genericsUsage: '', + genericsDefinition: + ', StateT, ArgT>', + ), ], kinds: _ProviderKind.values, ); @@ -198,7 +226,9 @@ void _generateAll(StringBuffer buffer, Matrix matrix) { switch (provider) { case _NotifierBuilder(): - _generateNotifierOrphan(buffer, disposeType, provider, kind); + if (provider.isFamily == (kind == _ProviderKind.family)) { + _generateNotifier(buffer, disposeType, provider, kind); + } case _FunctionalBuilder(): switch (kind) { case _ProviderKind.orphan: @@ -218,7 +248,7 @@ void _generateFunctionalFamily( _FunctionalBuilder provider, ) { final builderName = _builderName( - provider, + provider.providerName, disposeType, kind: _ProviderKind.family, ); @@ -242,7 +272,7 @@ class $builderName { ); } - ${_autoDisposeModifier(provider, disposeType, _ProviderKind.family)} + ${_autoDisposeModifier(provider.providerName, disposeType, _ProviderKind.family)} } '''); } @@ -253,7 +283,7 @@ void _generateFunctionalOrphan( _FunctionalBuilder provider, ) { final builderName = _builderName( - provider, + provider.providerName, disposeType, ); @@ -276,14 +306,14 @@ class $builderName { ); } - ${_familyModifier(provider, disposeType, _ProviderKind.orphan)} - ${_autoDisposeModifier(provider, disposeType, _ProviderKind.orphan)} + ${_familyModifier(provider.providerName, disposeType, _ProviderKind.orphan)} + ${_autoDisposeModifier(provider.providerName, disposeType, _ProviderKind.orphan)} } '''); } String _builderName( - _Builder provider, + String name, _DisposeType disposeType, { _ProviderKind kind = _ProviderKind.orphan, }) { @@ -291,7 +321,7 @@ String _builderName( if (kind == _ProviderKind.family) { builderName = 'Family$builderName'; } - builderName = '${provider.providerName}$builderName'; + builderName = '$name$builderName'; if (disposeType == _DisposeType.autoDispose) { builderName = 'AutoDispose$builderName'; } @@ -299,14 +329,14 @@ String _builderName( } String _autoDisposeModifier( - _Builder provider, + String name, _DisposeType disposeType, _ProviderKind kind, ) { if (disposeType == _DisposeType.autoDispose) return ''; final targetBuilder = _builderName( - provider, + name, _DisposeType.autoDispose, kind: kind, ); @@ -318,14 +348,14 @@ String _autoDisposeModifier( } String _familyModifier( - _Builder provider, + String name, _DisposeType disposeType, _ProviderKind kind, ) { if (kind == _ProviderKind.family) return ''; final targetBuilder = _builderName( - provider, + name, disposeType, kind: _ProviderKind.family, ); @@ -343,30 +373,36 @@ String _isAutoDisposeParam(_DisposeType disposeType) { return ''; } -void _generateNotifierOrphan( +void _generateNotifier( StringBuffer buffer, _DisposeType disposeType, _NotifierBuilder provider, _ProviderKind kind, ) { final builderName = _builderName( - provider, + provider.providerName, disposeType, kind: kind, ); + final providerName = provider.isFamily + ? '${provider.providerName}Family' + : provider.providerName; + + final ctor = provider.isFamily ? '.internal' : ''; + buffer.writeln(''' @internal class $builderName { const $builderName(); $autoDisposeDoc - ${provider.providerName}${provider.genericsUsage} call${provider.genericsDefinition}( + $providerName${provider.genericsUsage} call${provider.genericsDefinition}( NotifierT Function() create, { String? name, Iterable? dependencies, }) { - return ${provider.providerName}${provider.genericsUsage}( + return $providerName${provider.genericsUsage}$ctor( create, name: name, ${_isAutoDisposeParam(disposeType)} @@ -374,8 +410,8 @@ class $builderName { ); } - ${_familyModifier(provider, disposeType, kind)} - ${_autoDisposeModifier(provider, disposeType, kind)} + ${_familyModifier(provider.providerName, disposeType, kind)} + ${_autoDisposeModifier(provider.providerName, disposeType, kind)} } '''); } From 39e8eadaf4a425da15004f36d7f1cb7cbb2d42f4 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 31 Jan 2024 17:19:33 +0100 Subject: [PATCH 136/387] Ref stuff --- packages/riverpod/lib/src/core/ref.dart | 2 +- packages/riverpod/test/new/core/ref_test.dart | 1 + website/docs/concepts/combining_providers.mdx | 2 +- website/docs/concepts/reading/counter/raw.dart | 2 +- .../from_state_notifier/family_and_dispose_old.dart | 9 +++++---- .../from_state_notifier/old_lifecycles_old.dart | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading_counter.dart | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading_counter.dart | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading.mdx | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading_counter.dart | 6 +++--- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading_counter.dart | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading_counter.dart | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading_counter.dart | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading_counter.dart | 6 +++--- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading/counter/raw.dart | 2 +- 24 files changed, 32 insertions(+), 30 deletions(-) diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 6efaccd44..480f800bf 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -196,7 +196,7 @@ abstract class Ref { /// class MyService { /// MyService(this.ref); /// - /// final Ref ref; + /// final Ref ref; /// /// Future fetchUser() { /// // We read the current configurations, but do not care about diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart index 9425589b9..5df81482d 100644 --- a/packages/riverpod/test/new/core/ref_test.dart +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -3,6 +3,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../utils.dart'; diff --git a/website/docs/concepts/combining_providers.mdx b/website/docs/concepts/combining_providers.mdx index a4d3ce76c..2a4ec3558 100644 --- a/website/docs/concepts/combining_providers.mdx +++ b/website/docs/concepts/combining_providers.mdx @@ -127,7 +127,7 @@ final repositoryProvider = Provider(Repository.new); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; Future fetchCatalog() async { String token = ref.read(userTokenProvider); diff --git a/website/docs/concepts/reading/counter/raw.dart b/website/docs/concepts/reading/counter/raw.dart index b97c93b00..f464c984e 100644 --- a/website/docs/concepts/reading/counter/raw.dart +++ b/website/docs/concepts/reading/counter/raw.dart @@ -15,7 +15,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter can use the "ref" to read other providers diff --git a/website/docs/migration/from_state_notifier/family_and_dispose_old.dart b/website/docs/migration/from_state_notifier/family_and_dispose_old.dart index 28f93a65c..844888f36 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose_old.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose_old.dart @@ -13,18 +13,19 @@ class BugsEncounteredNotifier extends StateNotifier> { required this.featureId, }) : super(const AsyncData(99)); final String featureId; - final Ref ref; + final Ref ref; Future fix(int amount) async { state = await AsyncValue.guard(() async { final old = state.requireValue; - final result = await ref.read(taskTrackerProvider).fix(id: featureId, fixed: amount); + final result = + await ref.read(taskTrackerProvider).fix(id: featureId, fixed: amount); return max(old - result, 0); }); } } -final bugsEncounteredNotifierProvider = - StateNotifierProvider.family.autoDispose((ref, id) { +final bugsEncounteredNotifierProvider = StateNotifierProvider.family + .autoDispose((ref, id) { return BugsEncounteredNotifier(ref: ref, featureId: id); }); diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_old.dart b/website/docs/migration/from_state_notifier/old_lifecycles_old.dart index 8f6eaa485..dd1d61592 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_old.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_old.dart @@ -20,7 +20,7 @@ class MyNotifier extends StateNotifier { _timer = Timer.periodic(period, (t) => update()); // 2 side effect on init } final Duration period; - final Ref ref; + final Ref ref; late final Timer _timer; Future update() async { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index 1ca5b48cc..970aea954 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -166,7 +166,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index 1ce474d55..44e9ba8ee 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -15,7 +15,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter এই "ref" অবজেক্ট ব্যবহার করে অন্য প্রভাইডার পড়তে পারবে diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index 91c4c2a46..c2902ddac 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -174,7 +174,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index 21a7accf8..cc1ea769a 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -15,7 +15,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter kann "ref" dazu benutzen um andere Provider auszulesen diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index 395bd4730..4c30a0c51 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -166,7 +166,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` Sin embargo, pasar `ref.read` da como resultado un código un poco menos verboso diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/reading.mdx b/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/reading.mdx index 81b1e7b2e..f49ebaf7c 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/reading.mdx +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/reading.mdx @@ -39,7 +39,7 @@ final counter = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref): super(0); - final Ref ref; + final Ref ref; void increment() { // `Counter` puede usar la "ref" para leer otros providers diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index cfa1da36c..82260ba01 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -174,7 +174,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index 236575f6d..8b479fe48 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -13,13 +13,13 @@ final counterProvider = StateNotifierProvider((ref) { }); class Counter extends StateNotifier { - Counter(this.ref): super(0); + Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter peut utiliser le "ref" pour lire d'autres providers final repository = ref.read(repositoryProvider); repository.post('...'); } -} \ No newline at end of file +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index eba244202..ed440f3d8 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -173,7 +173,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` L'unica differenza che comporta passare `ref.read` è la scrittura di meno codice, inoltre, diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index 973d0699a..60f50c878 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -15,7 +15,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter può usare "ref" per leggere altri provider diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index 7caaeb576..ce41b30d1 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -161,7 +161,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index 16683eff8..044150894 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -15,7 +15,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter は `ref` を使って他のプロバイダーを利用することができる diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index d71f1d0d9..3f9be80e9 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -173,7 +173,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index d593c044e..cdab5c7e2 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -15,7 +15,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter 클래스는 다른 프로바이더를 읽기 위해 "ref"를 사용할 수 있습니다. diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index 75d691be3..578714d56 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -179,7 +179,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index 848a31f27..ac9db13a0 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -13,13 +13,13 @@ final counterProvider = StateNotifierProvider((ref) { }); class Counter extends StateNotifier { - Counter(this.ref): super(0); + Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter может использовать "ref" для чтения других провайдеров final repository = ref.read(repositoryProvider); repository.post('...'); } -} \ No newline at end of file +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index d6282f10d..74fe18ef5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -144,7 +144,7 @@ final repositoryProvider = Provider(Repository.new); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; Future fetchCatalog() async { String token = ref.read(userTokenProvider); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart index b0a11f77f..df5878594 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart @@ -15,7 +15,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter可以使用“ref”读取其他provider From b3d2dea4e7b2ac0d7686123a8bf30e2d463dd070 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 31 Jan 2024 17:22:05 +0100 Subject: [PATCH 137/387] More ref stuff --- examples/marvel/lib/src/marvel.dart | 2 +- packages/riverpod/test/new/core/ref_test.dart | 10 +++--- .../old/framework/provider_element_test.dart | 32 +++++++++---------- .../golden/lib/constructor_providers.dart | 2 +- 4 files changed, 23 insertions(+), 23 deletions(-) diff --git a/examples/marvel/lib/src/marvel.dart b/examples/marvel/lib/src/marvel.dart index 594e04380..36f6aed18 100644 --- a/examples/marvel/lib/src/marvel.dart +++ b/examples/marvel/lib/src/marvel.dart @@ -29,7 +29,7 @@ class MarvelRepository { }) : _getCurrentTimestamp = getCurrentTimestamp ?? (() => DateTime.now().millisecondsSinceEpoch); - final Ref ref; + final Ref ref; final int Function() _getCurrentTimestamp; final _characterCache = {}; diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart index 5df81482d..e31054151 100644 --- a/packages/riverpod/test/new/core/ref_test.dart +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -10,7 +10,7 @@ import '../utils.dart'; // TODO automatically generate this list for maintainability final refMethodsThatDependOnProviders = - )>{ + ref, ProviderBase)>{ 'watch': (ref, p) => ref.watch(p), 'read': (ref, p) => ref.read(p), 'listen': (ref, p) => ref.listen(p, (prev, next) {}), @@ -18,13 +18,13 @@ final refMethodsThatDependOnProviders = 'refresh': (ref, p) => ref.refresh(p), }; final refMethodsThatDependOnListenables = - )>{ + ref, ProviderListenable)>{ 'watch': (ref, p) => ref.watch(p), 'read': (ref, p) => ref.read(p), 'listen': (ref, p) => ref.listen(p, (prev, next) {}), }; final refMethodsThatDependOnProviderOrFamilies = - { + ref, ProviderOrFamily)>{ 'invalidate': (ref, p) => ref.invalidate(p), }; @@ -36,7 +36,7 @@ void main() { 'cannot call ref.watch/ref.read/ref.listen/ref.onDispose after a dependency changed', () { // TODO assert invalidate & co also throw - late Ref ref; + late Ref ref; final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = Provider((r) { @@ -1319,7 +1319,7 @@ void main() { test('refreshes a provider and return the new state', () { var value = 0; final state = Provider((ref) => value); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; }); diff --git a/packages/riverpod/test/old/framework/provider_element_test.dart b/packages/riverpod/test/old/framework/provider_element_test.dart index a92c0c30d..e5cdbeab5 100644 --- a/packages/riverpod/test/old/framework/provider_element_test.dart +++ b/packages/riverpod/test/old/framework/provider_element_test.dart @@ -139,7 +139,7 @@ void main() { group('ref.refresh', () { test('Throws if a circular dependency is detected', () { // Regression test for https://github.com/rrousselGit/riverpod/issues/2336 - late Ref ref; + late Ref ref; final a = Provider((r) { ref = r; return 0; @@ -159,7 +159,7 @@ void main() { group('ref.invalidate', () { test('Throws if a circular dependency is detected', () { // Regression test for https://github.com/rrousselGit/riverpod/issues/2336 - late Ref ref; + late Ref ref; final a = Provider((r) { ref = r; return 0; @@ -176,7 +176,7 @@ void main() { }); test('Circular dependency ignores families', () { - late Ref ref; + late Ref ref; final a = Provider((r) { ref = r; return 0; @@ -197,7 +197,7 @@ void main() { final listener = Listener(); var result = 0; final provider = Provider((r) => result); - late Ref ref; + late Ref ref; final another = Provider((r) { ref = r; }); @@ -226,7 +226,7 @@ void main() { var result = 0; final unrelated = Provider((ref) => result); final provider = Provider.family((r, i) => '$result-$i'); - late Ref ref; + late Ref ref; final another = Provider((r) { ref = r; }); @@ -262,7 +262,7 @@ void main() { (r, i) => result, dependencies: const [], ); - late Ref ref; + late Ref ref; final another = Provider((r) => ref = r, dependencies: [provider]); final listener = Listener(); @@ -298,7 +298,7 @@ void main() { test('calls dispose immediately', () { final container = ProviderContainer.test(); final listener = OnDisposeMock(); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; ref.onDispose(listener.call); @@ -320,7 +320,7 @@ void main() { final container = ProviderContainer.test(); final listener = Listener(); var result = 0; - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; return result; @@ -344,7 +344,7 @@ void main() { final container = ProviderContainer.test(); final listener = Listener(); final dep = StateProvider((ref) => 0); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; return ref.watch(dep); @@ -419,7 +419,7 @@ void main() { ref.onRemoveListener(listener2.call); }, ); - late Ref ref; + late Ref ref; final provider = Provider( name: 'provider', (r) { @@ -464,7 +464,7 @@ void main() { ref.onRemoveListener(listener2.call); }, ); - late Ref ref; + late Ref ref; final provider = Provider( name: 'provider', (r) => ref = r, @@ -581,7 +581,7 @@ void main() { ref.onAddListener(listener2.call); }, ); - late Ref ref; + late Ref ref; final provider = Provider( name: 'provider', (r) => ref = r, @@ -614,7 +614,7 @@ void main() { ref.onAddListener(listener2.call); }, ); - late Ref ref; + late Ref ref; final provider = Provider( name: 'provider', (r) => ref = r, @@ -747,7 +747,7 @@ void main() { ref.onResume(listener2.call); }, ); - late Ref ref; + late Ref ref; final provider = Provider( name: 'provider', (r) => ref = r, @@ -801,7 +801,7 @@ void main() { ref.onAddListener(listener2.call); }, ); - late Ref ref; + late Ref ref; final provider = Provider( name: 'provider', (r) => ref = r, @@ -965,7 +965,7 @@ void main() { ref.onCancel(listener.call); ref.onCancel(listener2.call); }); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; }); diff --git a/packages/riverpod_graph/test/integration/addition/golden/lib/constructor_providers.dart b/packages/riverpod_graph/test/integration/addition/golden/lib/constructor_providers.dart index c6988e5f2..e77743866 100644 --- a/packages/riverpod_graph/test/integration/addition/golden/lib/constructor_providers.dart +++ b/packages/riverpod_graph/test/integration/addition/golden/lib/constructor_providers.dart @@ -17,7 +17,7 @@ class MarvelRepository { }) : _getCurrentTimestamp = getCurrentTimestamp ?? (() => DateTime.now().millisecondsSinceEpoch); - final Ref ref; + final Ref ref; final int Function() _getCurrentTimestamp; } From 418402209db424a3b308048d57d2db48f9df22cc Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 31 Jan 2024 17:36:20 +0100 Subject: [PATCH 138/387] Some warnings --- packages/riverpod/lib/riverpod.dart | 3 ++- .../lib/src/providers/async_notifier.dart | 7 ++--- .../src/providers/async_notifier/family.dart | 2 +- .../src/providers/async_notifier/orphan.dart | 2 +- packages/riverpod/test/new/matrix.dart | 27 ------------------- .../old/framework/provider_element_test.dart | 2 +- 6 files changed, 9 insertions(+), 34 deletions(-) delete mode 100644 packages/riverpod/test/new/matrix.dart diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index b5355d7c0..bf7ad8d7d 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -44,7 +44,8 @@ export 'src/framework.dart' FunctionalProvider, ClassProvider; -export 'src/providers/async_notifier.dart' hide AsyncNotifierBase; +export 'src/providers/async_notifier.dart' + hide AsyncNotifierBase, AsyncNotifierProviderBase; // TODO changelog breaking: StateNotifier & co are no-longer exported from pkg:riverpod/riverpod.dart // Use pkg:riverpod/legacy.dart diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index f30ce905e..bd9752927 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -18,7 +18,8 @@ abstract class AsyncNotifierBase extends ClassBase< // with AsyncClassMixin> {} -abstract base class _AsyncNotifierProviderBase< // +@internal +abstract base class AsyncNotifierProviderBase< // NotifierT extends AsyncNotifierBase, StateT> // extends ClassProvider< // @@ -28,7 +29,7 @@ abstract base class _AsyncNotifierProviderBase< // Ref>> // with FutureModifier { - const _AsyncNotifierProviderBase( + const AsyncNotifierProviderBase( this._createNotifier, { required super.name, required super.from, @@ -58,7 +59,7 @@ class _AsyncNotifierProviderElement< // _AsyncNotifierProviderElement(this.provider, super.container); @override - final _AsyncNotifierProviderBase provider; + final AsyncNotifierProviderBase provider; @override void handleError( diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index d5383b8d3..8b9f50918 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -55,7 +55,7 @@ final class FamilyAsyncNotifierProvider< // NotifierT extends FamilyAsyncNotifier, StateT, ArgT> // - extends _AsyncNotifierProviderBase { + extends AsyncNotifierProviderBase { /// An implementation detail of Riverpod const FamilyAsyncNotifierProvider._( super._createNotifier, { diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index b6a072dbb..f98f60a16 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -56,7 +56,7 @@ abstract class AsyncNotifier extends AsyncNotifierBase { final class AsyncNotifierProvider< // NotifierT extends AsyncNotifier, StateT> // - extends _AsyncNotifierProviderBase { + extends AsyncNotifierProviderBase { /// {@macro riverpod.async_notifier_provider} /// /// {@macro riverpod.async_notifier_provider_modifier} diff --git a/packages/riverpod/test/new/matrix.dart b/packages/riverpod/test/new/matrix.dart deleted file mode 100644 index 1acc87a57..000000000 --- a/packages/riverpod/test/new/matrix.dart +++ /dev/null @@ -1,27 +0,0 @@ -import 'package:riverpod/src/internals.dart'; - -typedef AsyncFactory = AsyncNotifierProvider - Function, StateT>( - NotifierT Function(), { - Iterable? dependencies, - String? name, -}); - -typedef AsyncFamilyFactory = AsyncNotifierProvider - Function, StateT>( - NotifierT Function(), { - Iterable? dependencies, - String? name, -}); - -final asyncOrphanFactory = [ - AsyncNotifierProvider.new, - AsyncNotifierProvider.autoDispose.call, -]; - -final asyncFamilyFactory = [ - AsyncNotifierProvider.family.call, - AsyncNotifierProvider.autoDispose.family.call, -]; - -final asyncFactory = []; diff --git a/packages/riverpod/test/old/framework/provider_element_test.dart b/packages/riverpod/test/old/framework/provider_element_test.dart index e5cdbeab5..7c1d2e7ea 100644 --- a/packages/riverpod/test/old/framework/provider_element_test.dart +++ b/packages/riverpod/test/old/framework/provider_element_test.dart @@ -619,7 +619,7 @@ void main() { name: 'provider', (r) => ref = r, ); - late Ref ref2; + late Ref ref2; final provider2 = Provider( name: 'provider', (r) => ref2 = r, From e9cb293d763828574c34166dfffe521ab8d008b4 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 31 Jan 2024 17:37:41 +0100 Subject: [PATCH 139/387] Fix some errors --- packages/riverpod/test/old/framework/ref_watch_test.dart | 1 + .../riverpod/test/old/legacy/framework2/framework_test.dart | 3 ++- packages/riverpod/test/old/legacy/framework_test.dart | 4 ++-- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/packages/riverpod/test/old/framework/ref_watch_test.dart b/packages/riverpod/test/old/framework/ref_watch_test.dart index b9bcb24aa..060321ddd 100644 --- a/packages/riverpod/test/old/framework/ref_watch_test.dart +++ b/packages/riverpod/test/old/framework/ref_watch_test.dart @@ -1,6 +1,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../utils.dart'; diff --git a/packages/riverpod/test/old/legacy/framework2/framework_test.dart b/packages/riverpod/test/old/legacy/framework2/framework_test.dart index 06fe01002..7eebb51cd 100644 --- a/packages/riverpod/test/old/legacy/framework2/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework2/framework_test.dart @@ -3,6 +3,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../utils.dart'; @@ -501,7 +502,7 @@ void main() { final root = ProviderContainer.test(); final container = ProviderContainer.test(parent: root); var callCount = 0; - late Ref providerReference; + late Ref providerReference; var result = 0; final provider = Provider((ref) { callCount++; diff --git a/packages/riverpod/test/old/legacy/framework_test.dart b/packages/riverpod/test/old/legacy/framework_test.dart index 0bf7cb77b..6527f924d 100644 --- a/packages/riverpod/test/old/legacy/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework_test.dart @@ -2,7 +2,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../utils.dart'; @@ -278,7 +278,7 @@ void main() { var callCount = 0; final onDispose = OnDisposeMock(); final error = Error(); - late Ref reference; + late Ref reference; final provider = Provider((ref) { reference = ref; callCount++; From 90b037ca40268b04e60de885903f9157af4b8020 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 31 Jan 2024 17:39:56 +0100 Subject: [PATCH 140/387] More errors --- .../state_notifier_provider/auto_dispose_family_test.dart | 1 + .../auto_dispose_state_notifier_provider_test.dart | 1 + .../deprecated/state_notifier_provider/family_test.dart | 1 + .../state_notifier_provider/state_notifier_provider_test.dart | 1 + .../deprecated/state_provider/state_controller_test.dart | 1 - .../state_provider/state_provider_auto_dispose_test.dart | 1 + .../state_provider/state_provider_family_auto_dispose_test.dart | 1 + .../deprecated/state_provider/state_provider_family_test.dart | 1 + .../deprecated/state_provider/state_provider_test.dart | 1 + .../future_provider/auto_dispose_future_provider_test.dart | 1 + .../future_provider/family_future_provider_test.dart | 2 +- .../legacy_providers/future_provider/future_provider_test.dart | 1 + .../provider/auto_dispose_provider_family_test.dart | 1 + .../legacy_providers/provider/auto_dispose_provider_test.dart | 1 + .../old/legacy_providers/provider/provider_family_test.dart | 2 +- .../test/old/legacy_providers/provider/provider_test.dart | 1 + .../legacy_providers/scoped_provider/scoped_provider_test.dart | 1 + .../auto_dispose_family_stream_provider_test.dart | 1 + .../stream_provider/auto_dispose_stream_provider_test.dart | 1 + .../stream_provider/stream_provider_family_test.dart | 2 +- .../legacy_providers/stream_provider/stream_provider_test.dart | 1 + 21 files changed, 20 insertions(+), 4 deletions(-) diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart index ad2abed15..80c372931 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart @@ -1,5 +1,6 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart index 6fde34f00..3693207e2 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart @@ -1,6 +1,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart index d185a5fe4..d75c86f22 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart @@ -1,6 +1,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart index 4fa7cf1b5..669f2e5a4 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart @@ -3,6 +3,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_controller_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_controller_test.dart index 7b385d1f2..814ec2a76 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_controller_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_controller_test.dart @@ -1,5 +1,4 @@ import 'package:riverpod/legacy.dart'; -import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; void main() { diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart index 075a9f8c1..fc7685341 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart @@ -1,6 +1,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart index 5a979263a..ec591c58f 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart @@ -1,5 +1,6 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; void main() { diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart index 88d8bcbdc..ec0cfdbc1 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart @@ -1,5 +1,6 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; void main() { diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart index 46aed592a..396666a8c 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart @@ -3,6 +3,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart index b5f68f7d6..acb77525b 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart @@ -3,6 +3,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart index 9400b76af..74a78dad1 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart @@ -1,7 +1,7 @@ import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; - void main() { test('specifies `from` & `argument` for related providers', () { final provider = FutureProvider.family((ref, _) => 0); diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart index 8e78f9121..6d20b3591 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart @@ -5,6 +5,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart index dfb118eed..831c53648 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart @@ -1,5 +1,6 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart index 7561dc544..57a8879cd 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart @@ -1,6 +1,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart index a7dda4431..cceaeff56 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart @@ -1,7 +1,7 @@ import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; - void main() { group('Provider.family', () { test('specifies `from` & `argument` for related providers', () { diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart index 387adc6ef..73543215d 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart @@ -3,6 +3,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart index 1bc3d9e48..74d86837b 100644 --- a/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart @@ -1,5 +1,6 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart index a9aba632b..7bdba77cb 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart @@ -1,4 +1,5 @@ import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart index 8dd7244fa..b7a7354c4 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart @@ -3,6 +3,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart index 5e3431553..647952fbe 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart @@ -1,7 +1,7 @@ import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; - void main() { group('StreamProvider.family', () { test('specifies `from` & `argument` for related providers', () { diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart index ca1e19da7..52c845e9f 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart @@ -5,6 +5,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../utils.dart'; From 4d442dcfa35676016ed728b5e2687451748d1dcb Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 1 Feb 2024 12:47:45 +0100 Subject: [PATCH 141/387] Re-enable AsyncNotifier tests --- .../lib/src/core/modifiers/future.dart | 14 +- .../src/core/provider/notifier_provider.dart | 15 + .../src/providers/async_notifier/family.dart | 6 +- .../src/providers/async_notifier/orphan.dart | 4 + .../lib/src/providers/future_provider.dart | 38 +- .../lib/src/providers/stream_provider.dart | 60 +- packages/riverpod/test/new/matrix.dart | 362 ++++ .../async_notifier/async_notifier_test.dart | 1594 ++++++++--------- .../async_notifier/factory.dart | 310 ---- 9 files changed, 1231 insertions(+), 1172 deletions(-) create mode 100644 packages/riverpod/test/new/matrix.dart delete mode 100644 packages/riverpod/test/old/legacy_providers/async_notifier/factory.dart diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 79c13750c..47c31cd30 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -224,15 +224,6 @@ mixin FutureModifierElement on ProviderElementBase> { ); } - @override - bool updateShouldNotify( - AsyncValue previous, AsyncValue next) { - return FutureModifierElement.handleUpdateShouldNotify( - previous, - next, - ); - } - void _onLoading(AsyncLoading value, {bool seamless = false}) { asyncTransition(value, seamless: seamless); if (_futureCompleter == null) { @@ -241,6 +232,11 @@ mixin FutureModifierElement on ProviderElementBase> { } } + void handleNotifier(Object? notifier, {required bool seamless}) { + // Overrides the default behavior of ClassProviderElement.handleNotifier + asyncTransition(AsyncLoading(), seamless: seamless); + } + /// Life-cycle for when an error from the provider's "build" method is received. /// /// Might be invoked after the element is disposed in the case where `provider.future` diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index 7d0b24f3c..95f37ba0c 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -93,6 +93,15 @@ abstract base class ClassProvider< // required this.runNotifierBuildOverride, }); + Refreshable get notifier { + return ProviderElementProxy( + this, + (element) => + (element as ClassProviderElement) + .classListenable, + ); + } + @internal final RunNotifierBuild? runNotifierBuildOverride; @@ -168,6 +177,8 @@ abstract class ClassProviderElement< // switch (result) { case ResultData(): try { + handleNotifier(result.state, seamless: !didChangeDependency); + final created = provider.runNotifierBuildOverride?.call(this, result.state) ?? result.state.runBuild(); @@ -184,6 +195,10 @@ abstract class ClassProviderElement< // } } + void handleNotifier(NotifierT notifier, {required bool seamless}) { + // Overridden by FutureModifier mixin + } + void handleValue(CreatedT created, {required bool didChangeDependency}); void handleError( Object error, diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index 8b9f50918..bdba74e7f 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -16,11 +16,15 @@ abstract class FamilyAsyncNotifier /// /// then [arg] will be `0`. /// {@endtemplate} - late final Arg arg; + late final Arg arg = (ref as ProviderElementBase).origin.argument as Arg; /// {@macro riverpod.async_notifier.build} @visibleForOverriding FutureOr build(Arg arg); + + @internal + @override + FutureOr runBuild() => build(arg); } /// The [Family] of [AsyncNotifierProvider]. diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index f98f60a16..cd8adfa61 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -32,6 +32,10 @@ abstract class AsyncNotifier extends AsyncNotifierBase { /// {@endtemplate} @visibleForOverriding FutureOr build(); + + @internal + @override + FutureOr runBuild() => build(); } /// {@template riverpod.async_notifier_provider} diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 51b2dde1f..de1770d30 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -153,28 +153,29 @@ final class FutureProvider extends FunctionalProvider< } /// {@macro riverpod.provider_ref_base} -abstract class FutureProviderRef implements Ref> { +abstract class FutureProviderRef implements Ref> { /// Obtains the [Future] associated to this provider. /// /// This is equivalent to doing `ref.read(myProvider.future)`. /// See also [FutureProvider.future]. // TODO move to Ref - Future get future; + Future get future; } /// The element of a [FutureProvider] -class FutureProviderElement extends ProviderElementBase> - with FutureModifierElement - implements FutureProviderRef { +class FutureProviderElement + extends ProviderElementBase> + with FutureModifierElement + implements FutureProviderRef { /// The element of a [FutureProvider] @internal FutureProviderElement(this.provider, super.container); @override - final FutureProvider provider; + final FutureProvider provider; @override - Future get future { + Future get future { flush(); return futureNotifier.value; } @@ -186,18 +187,31 @@ class FutureProviderElement extends ProviderElementBase> didChangeDependency: didChangeDependency, ); } + + @override + bool updateShouldNotify( + AsyncValue previous, AsyncValue next) { + return FutureModifierElement.handleUpdateShouldNotify( + previous, + next, + ); + } } /// The [Family] of a [FutureProvider] -class FutureProviderFamily extends FunctionalFamily< - FutureProviderRef, AsyncValue, Arg, FutureOr, FutureProvider> { +class FutureProviderFamily extends FunctionalFamily< + FutureProviderRef, + AsyncValue, + ArgT, + FutureOr, + FutureProvider> { FutureProviderFamily( super._createFn, { super.name, super.dependencies, super.isAutoDispose = false, }) : super( - providerFactory: FutureProvider.internal, + providerFactory: FutureProvider.internal, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), debugGetCreateSourceHash: null, @@ -208,7 +222,7 @@ class FutureProviderFamily extends FunctionalFamily< super.name, super.dependencies, }) : super( - providerFactory: FutureProvider.internal, + providerFactory: FutureProvider.internal, isAutoDispose: true, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), @@ -224,5 +238,5 @@ class FutureProviderFamily extends FunctionalFamily< required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, required super.isAutoDispose, - }) : super(providerFactory: FutureProvider.internal); + }) : super(providerFactory: FutureProvider.internal); } diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index c77ce2fbc..cd518ac92 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -66,9 +66,10 @@ import 'provider.dart' show Provider; /// - [StreamProvider.family], to create a [StreamProvider] from external parameters /// - [StreamProvider.autoDispose], to destroy the state of a [StreamProvider] when no longer needed. /// {@endtemplate} -final class StreamProvider - extends FunctionalProvider, Stream, Ref>> - with FutureModifier { +final class StreamProvider extends FunctionalProvider< + AsyncValue, + Stream, + Ref>> with FutureModifier { /// {@macro riverpod.stream_provider} StreamProvider( this._create, { @@ -115,21 +116,21 @@ final class StreamProvider /// {@macro riverpod.family} static const family = StreamProviderFamilyBuilder(); - final Create, Ref>> _create; + final Create, Ref>> _create; @override - StreamProviderElement createElement( + StreamProviderElement createElement( ProviderContainer container, ) { return StreamProviderElement(this, container); } @override - FunctionalProvider, Stream, Ref>> - copyWithCreate( - Create, Ref>> create, + FunctionalProvider, Stream, + Ref>> copyWithCreate( + Create, Ref>> create, ) { - return StreamProvider.internal( + return StreamProvider.internal( create, name: name, dependencies: null, @@ -143,21 +144,23 @@ final class StreamProvider } /// The element of [StreamProvider]. -class StreamProviderElement extends ProviderElementBase> - with FutureModifierElement { +class StreamProviderElement + extends ProviderElementBase> + with FutureModifierElement { /// The element of [StreamProvider]. @internal StreamProviderElement(this.provider, super.container); @override - final StreamProvider provider; + final StreamProvider provider; - final _streamNotifier = ProxyElementValueListenable>(); - final StreamController _streamController = StreamController.broadcast(); + final _streamNotifier = ProxyElementValueListenable>(); + final StreamController _streamController = + StreamController.broadcast(); @override void create({required bool didChangeDependency}) { - asyncTransition(AsyncLoading(), seamless: !didChangeDependency); + asyncTransition(AsyncLoading(), seamless: !didChangeDependency); _streamNotifier.result ??= Result.data(_streamController.stream); handleStream( @@ -189,7 +192,7 @@ class StreamProviderElement extends ProviderElementBase> } @override - void onData(AsyncData value, {bool seamless = false}) { + void onData(AsyncData value, {bool seamless = false}) { if (!_streamController.isClosed) { // The controller might be closed if onData is executed post dispose. Cf onData _streamController.add(value.value); @@ -198,25 +201,38 @@ class StreamProviderElement extends ProviderElementBase> } @override - void onError(AsyncError value, {bool seamless = false}) { + void onError(AsyncError value, {bool seamless = false}) { if (!_streamController.isClosed) { // The controller might be closed if onError is executed post dispose. Cf onError _streamController.addError(value.error, value.stackTrace); } super.onError(value, seamless: seamless); } + + @override + bool updateShouldNotify( + AsyncValue previous, AsyncValue next) { + return FutureModifierElement.handleUpdateShouldNotify( + previous, + next, + ); + } } /// The [Family] of a [StreamProvider] -class StreamProviderFamily extends FunctionalFamily>, - AsyncValue, Arg, Stream, StreamProvider> { +class StreamProviderFamily extends FunctionalFamily< + Ref>, + AsyncValue, + ArgT, + Stream, + StreamProvider> { StreamProviderFamily( super._createFn, { super.name, super.dependencies, super.isAutoDispose = false, }) : super( - providerFactory: StreamProvider.internal, + providerFactory: StreamProvider.internal, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), debugGetCreateSourceHash: null, @@ -231,14 +247,14 @@ class StreamProviderFamily extends FunctionalFamily>, required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, required super.isAutoDispose, - }) : super(providerFactory: StreamProvider.internal); + }) : super(providerFactory: StreamProvider.internal); StreamProviderFamily._autoDispose( super._createFn, { super.name, super.dependencies, }) : super( - providerFactory: StreamProvider.internal, + providerFactory: StreamProvider.internal, isAutoDispose: true, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), diff --git a/packages/riverpod/test/new/matrix.dart b/packages/riverpod/test/new/matrix.dart new file mode 100644 index 000000000..079d393cd --- /dev/null +++ b/packages/riverpod/test/new/matrix.dart @@ -0,0 +1,362 @@ +import 'dart:async'; + +import 'package:riverpod/src/internals.dart'; +import 'package:test/test.dart'; + +class TestMatrix> { + TestMatrix(this.values); + + final Map values; + + void createGroup(void Function(T factory) cb) { + for (final entry in values.entries) { + group(entry.key, () => cb(entry.value)); + } + } +} + +class TestFactory { + TestFactory({required this.value}); + + final T value; +} + +typedef ProviderFactory + = ProviderT Function([Object? arg]) Function( + BaseT Function(RefT ref, Object? arg) create, { + String? name, + Iterable? dependencies, +}); + +extension $Modifiers on ProviderBase { + Refreshable? get notifier { + final that = this; + return switch (that) { + ClassProvider() => that.notifier, + _ => null, + }; + } + + Refreshable>? get future { + final that = this; + return switch (that) { + FutureModifier() => that.future, + _ => null, + }; + } +} + +final providerFactory = + , Ref>>[ + (create, {name, dependencies}) => ([arg]) { + return Provider( + (ref) => create(ref, arg), + name: name, + dependencies: dependencies, + ); + }, + (create, {name, dependencies}) => ([arg]) { + return Provider.autoDispose( + (ref) => create(ref, arg), + name: name, + dependencies: dependencies, + ); + }, + (create, {name, dependencies}) => ([arg]) { + return Provider.family( + (ref, arg) => create(ref, arg), + name: name, + dependencies: dependencies, + )(arg); + }, + (create, {name, dependencies}) => ([arg]) { + return Provider.autoDispose.family( + (ref, arg) => create(ref, arg), + name: name, + dependencies: dependencies, + )(arg); + }, +]; + +final futureProviderFactories = + , FutureProvider, Ref>>[ + (create, {name, dependencies}) => ([arg]) { + return FutureProvider( + (ref) => create(ref, arg), + name: name, + dependencies: dependencies, + ); + }, + (create, {name, dependencies}) => ([arg]) { + return FutureProvider.autoDispose( + (ref) => create(ref, arg), + name: name, + dependencies: dependencies, + ); + }, + (create, {name, dependencies}) => ([arg]) { + return FutureProvider.family( + (ref, arg) => create(ref, arg), + name: name, + dependencies: dependencies, + )(arg); + }, + (create, {name, dependencies}) => ([arg]) { + return FutureProvider.autoDispose.family( + (ref, arg) => create(ref, arg), + name: name, + dependencies: dependencies, + )(arg); + }, +]; + +final streamProviderFactories = + , StreamProvider, Ref>>[ + (create, {name, dependencies}) => ([arg]) { + return StreamProvider( + (ref) => create(ref, arg), + name: name, + dependencies: dependencies, + ); + }, + (create, {name, dependencies}) => ([arg]) { + return StreamProvider.autoDispose( + (ref) => create(ref, arg), + name: name, + dependencies: dependencies, + ); + }, + (create, {name, dependencies}) => ([arg]) { + return StreamProvider.family( + (ref, arg) => create(ref, arg), + name: name, + dependencies: dependencies, + )(arg); + }, + (create, {name, dependencies}) => ([arg]) { + return StreamProvider.autoDispose.family( + (ref, arg) => create(ref, arg), + name: name, + dependencies: dependencies, + )(arg); + }, +]; + +final asyncProviderFactory = + >, Ref>>[ + for (final factory in futureProviderFactories) + (create, {name, dependencies}) => factory( + (ref, arg) async => create(ref, arg), + name: name, + dependencies: dependencies, + ), + for (final factory in streamProviderFactories) + (create, {name, dependencies}) => factory( + (ref, arg) => Stream.value(create(ref, arg)), + name: name, + dependencies: dependencies, + ), +]; + +final asyncNotifierProviderFactory = TestMatrix( + { + 'AsyncNotifierProvider': AsyncNotifierTestFactory( + deferredNotifier: DeferredAsyncNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return AsyncNotifierProvider, StateT>( + () => DeferredAsyncNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ); + }, + provider: (create) => + AsyncNotifierProvider, StateT>( + () => create() as AsyncNotifier, + ), + value: (create, {name, dependencies}) => ([arg]) { + return AsyncNotifierProvider, Object?>( + () => create(null, arg) as AsyncNotifier, + name: name, + dependencies: dependencies, + ); + }, + ), + 'AsyncNotifierProvider.autoDispose': AsyncNotifierTestFactory( + deferredNotifier: DeferredAsyncNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return AsyncNotifierProvider.autoDispose, + StateT>( + () => DeferredAsyncNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ); + }, + provider: (create) { + return AsyncNotifierProvider.autoDispose, StateT>( + () => create() as AsyncNotifier, + ); + }, + value: (create, {name, dependencies}) => ([arg]) { + return AsyncNotifierProvider.autoDispose, + Object?>( + () => create(null, arg) as AsyncNotifier, + name: name, + dependencies: dependencies, + ); + }, + ), + 'AsyncNotifierProvider.family': AsyncNotifierTestFactory( + deferredNotifier: DeferredFamilyAsyncNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return AsyncNotifierProvider.family, + StateT, Object?>( + () => DeferredFamilyAsyncNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ).call(42); + }, + provider: (create) { + return AsyncNotifierProvider.family< + FamilyAsyncNotifier, StateT, Object?>( + () => create() as FamilyAsyncNotifier, + ).call(42); + }, + value: (create, {name, dependencies}) => ([arg]) { + return AsyncNotifierProvider.family< + FamilyAsyncNotifier, Object?, Object?>( + () => create(null, arg) as FamilyAsyncNotifier, + name: name, + dependencies: dependencies, + )(arg); + }, + ), + 'AsyncNotifierProvider.autoDispose.family': AsyncNotifierTestFactory( + deferredNotifier: DeferredFamilyAsyncNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return AsyncNotifierProvider.family + .autoDispose, StateT, Object?>( + () => DeferredFamilyAsyncNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ) + .call(42); + }, + provider: (create) { + return AsyncNotifierProvider.autoDispose + .family, StateT, Object?>( + () => create() as FamilyAsyncNotifier, + ) + .call(42); + }, + value: (create, {name, dependencies}) => ([arg]) { + return AsyncNotifierProvider.autoDispose + .family, Object?, Object?>( + () => create(null, arg) as FamilyAsyncNotifier, + name: name, + dependencies: dependencies, + )(arg); + }, + ), + }, +); + +abstract class TestAsyncNotifier implements AsyncNotifierBase { + // Removing protected + @override + AsyncValue get state; + + @override + set state(AsyncValue value); +} + +class DeferredAsyncNotifier extends AsyncNotifier + implements TestAsyncNotifier { + DeferredAsyncNotifier( + this._create, { + bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + }) : _updateShouldNotify = updateShouldNotify; + + final FutureOr Function(Ref> ref) _create; + final bool Function( + AsyncValue previousState, + AsyncValue newState, + )? _updateShouldNotify; + + @override + FutureOr build() => _create(ref); + + @override + bool updateShouldNotify( + AsyncValue previousState, + AsyncValue newState, + ) => + _updateShouldNotify?.call(previousState, newState) ?? + super.updateShouldNotify(previousState, newState); +} + +class DeferredFamilyAsyncNotifier + extends FamilyAsyncNotifier + implements TestAsyncNotifier { + DeferredFamilyAsyncNotifier( + this._create, { + bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + }) : _updateShouldNotify = updateShouldNotify; + + final FutureOr Function(Ref> ref) _create; + + final bool Function( + AsyncValue previousState, + AsyncValue newState, + )? _updateShouldNotify; + + @override + FutureOr build(int arg) => _create(ref); + + @override + bool updateShouldNotify( + AsyncValue previousState, + AsyncValue newState, + ) => + _updateShouldNotify?.call(previousState, newState) ?? + super.updateShouldNotify(previousState, newState); +} + +class AsyncNotifierTestFactory extends TestFactory< + ProviderFactory, ProviderBase, void>> { + AsyncNotifierTestFactory({ + required super.value, + required this.deferredNotifier, + required this.deferredProvider, + required this.provider, + }); + + final TestAsyncNotifier Function( + FutureOr Function(Ref> ref) create, + ) deferredNotifier; + + final AsyncNotifierProviderBase, StateT> + Function( + FutureOr Function(Ref> ref) create, { + bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + }) deferredProvider; + + final AsyncNotifierProviderBase, StateT> + Function( + AsyncNotifierBase Function() create, + ) provider; + + AsyncNotifierProviderBase, StateT> + simpleTestProvider( + FutureOr Function(Ref> ref) create, { + bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + }) { + return deferredProvider( + (ref) => create(ref), + updateShouldNotify: updateShouldNotify, + ); + } +} diff --git a/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart b/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart index f48f932ef..16cc4c388 100644 --- a/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart +++ b/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart @@ -1,14 +1,12 @@ -// ignore_for_file: avoid_types_on_closure_parameters - import 'dart:async'; import 'package:meta/meta.dart'; import 'package:mockito/mockito.dart'; -import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/internals.dart'; import 'package:test/test.dart'; +import '../../../new/matrix.dart'; import '../../utils.dart'; -import 'factory.dart'; void main() { test('Throws if using notifier properties in its constructor', () { @@ -16,1009 +14,993 @@ void main() { CtorNotifier.new, throwsA(isA()), ); - expect( - AutoDisposeCtorNotifier.new, - throwsA(isA()), - ); - expect( - AutoDisposeFamilyCtorNotifier.new, - throwsA(isA()), - ); expect( FamilyCtorNotifier.new, throwsA(isA()), ); }); - for (final factory in matrix()) { - group(factory.label, () { - test('Cannot share a Notifier instance between providers ', () { - final container = ProviderContainer.test(); - final notifier = factory.notifier((ref) => 0); + asyncNotifierProviderFactory.createGroup((factory) { + test('Cannot share a Notifier instance between providers ', () { + final container = ProviderContainer.test(); + final notifier = factory.deferredNotifier((ref) => 0); - final provider = factory.provider, int>( - () => notifier, - ); - final provider2 = factory.provider, int>( - () => notifier, - ); + final provider = factory.provider(() => notifier); + final provider2 = factory.provider(() => notifier); - container.read(provider); + container.read(provider); - expect( - container.read(provider2), - isA>(), - ); - }); + expect( + container.read(provider2), + isA>(), + ); + }); - test('Can read state inside onDispose', () { - final container = ProviderContainer.test(); - late AsyncTestNotifierBase notifier; - final provider = factory.simpleTestProvider((ref) { - ref.onDispose(() { - notifier.state; - }); - return 0; + test('Can read state inside onDispose', () { + final container = ProviderContainer.test(); + late TestAsyncNotifier notifier; + final provider = factory.simpleTestProvider((ref) { + ref.onDispose(() { + notifier.state; }); + return 0; + }); - container.listen(provider.notifier, (prev, next) {}); - notifier = container.read(provider.notifier); + container.listen(provider.notifier, (prev, next) {}); + notifier = container.read(provider.notifier); - container.dispose(); - }); + container.dispose(); + }); + + test('Using the notifier after dispose throws', () { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider((ref) => 0); + + container.listen(provider.notifier, (prev, next) {}); + final notifier = container.read(provider.notifier); + + container.dispose(); + + expect(() => notifier.state, throwsStateError); + expect(() => notifier.future, throwsStateError); + expect(() => notifier.state = const AsyncData(42), throwsStateError); + // ignore: invalid_use_of_protected_member + expect(() => notifier.ref, throwsStateError); + expect(() => notifier.update((p1) => 42), throwsStateError); + }); + + test('Can assign `AsyncLoading` to `AsyncValue`', () { + // Regression test for https://github.com/rrousselGit/riverpod/issues/2120 + final provider = factory.simpleTestProvider((ref) => 42); + final container = ProviderContainer.test(); + + final sub = container.listen(provider.notifier, (prev, next) {}); + + // ignore: void_checks + expect(sub.read().state, const AsyncData(42)); + + sub.read().state = const AsyncLoading(); + + expect( + sub.read().state, + isA>() + .having((e) => e.hasValue, 'hasValue', true) + .having((e) => e.value, 'value', 42), + ); + }); + + test('Can assign `AsyncData` to `AsyncValue`', () { + // Regression test for https://github.com/rrousselGit/riverpod/issues/2120 + final provider = factory.simpleTestProvider((ref) => 42); + final container = ProviderContainer.test(); + + final sub = container.listen(provider.notifier, (prev, next) {}); + + // ignore: void_checks + expect(sub.read().state, const AsyncData(42)); - test('Using the notifier after dispose throws', () { + sub.read().state = const AsyncData(42); + + expect( + sub.read().state, + isA>() + .having((e) => e.hasValue, 'hasValue', true) + .having((e) => e.value, 'value', 42), + ); + }); + + test('Can assign `AsyncError` to `AsyncValue`', () { + // Regression test for https://github.com/rrousselGit/riverpod/issues/2120 + final provider = factory.simpleTestProvider((ref) => 42); + final container = ProviderContainer.test(); + + final sub = container.listen(provider.notifier, (prev, next) {}); + + // ignore: void_checks + expect(sub.read().state, const AsyncData(42)); + + sub.read().state = AsyncError(21, StackTrace.current); + + expect( + sub.read().state, + isA>() + .having((e) => e.hasValue, 'hasValue', true) + .having((e) => e.value, 'value', 42) + .having((e) => e.hasError, 'hasError', true) + .having((e) => e.error, 'error', 21), + ); + }); + + group('supports AsyncValue transition', () { + test( + 'performs seamless copyWithPrevious if triggered by ref.invalidate/ref.refresh', + () async { final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider((ref) => 0); + var count = 0; + final provider = factory.simpleTestProvider( + (ref) => Future.value(count++), + ); - container.listen(provider.notifier, (prev, next) {}); - final notifier = container.read(provider.notifier); + container.listen(provider, (previous, next) {}); - container.dispose(); + await expectLater(container.read(provider.future), completion(0)); + expect(container.read(provider), const AsyncData(0)); + + expect( + container.refresh(provider), + const AsyncLoading().copyWithPrevious(const AsyncData(0)), + ); + + await expectLater(container.read(provider.future), completion(1)); + expect(container.read(provider), const AsyncData(1)); + + container.invalidate(provider); - expect(() => notifier.state, throwsStateError); - expect(() => notifier.future, throwsStateError); - expect(() => notifier.state = const AsyncData(42), throwsStateError); - // ignore: invalid_use_of_protected_member - expect(() => notifier.ref, throwsStateError); - expect(() => notifier.update((p1) => 42), throwsStateError); + expect( + container.read(provider), + const AsyncLoading().copyWithPrevious(const AsyncData(1)), + ); + await expectLater(container.read(provider.future), completion(2)); + expect(container.read(provider), const AsyncData(2)); }); - test('Can assign `AsyncLoading` to `AsyncValue`', () { - // Regression test for https://github.com/rrousselGit/riverpod/issues/2120 - final provider = factory.simpleTestProvider((ref) => 42); + test( + 'performs seamless:false copyWithPrevious on `state = AsyncLoading()`', + () async { final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider((ref) => Future.value(0)); - final sub = container.listen(provider.notifier, (prev, next) {}); + final sub = container.listen(provider.notifier, (previous, next) {}); - // ignore: void_checks - expect(sub.read().state, const AsyncData(42)); + await expectLater(container.read(provider.future), completion(0)); + expect(container.read(provider), const AsyncData(0)); sub.read().state = const AsyncLoading(); expect( sub.read().state, - isA>() - .having((e) => e.hasValue, 'hasValue', true) - .having((e) => e.value, 'value', 42), + const AsyncLoading() + .copyWithPrevious(const AsyncData(0), isRefresh: false), ); }); - test('Can assign `AsyncData` to `AsyncValue`', () { - // Regression test for https://github.com/rrousselGit/riverpod/issues/2120 - final provider = factory.simpleTestProvider((ref) => 42); + test( + 'performs seamless:false copyWithPrevious if triggered by a dependency change', + () async { final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final provider = factory.simpleTestProvider( + (ref) => Future.value(ref.watch(dep)), + ); - final sub = container.listen(provider.notifier, (prev, next) {}); - - // ignore: void_checks - expect(sub.read().state, const AsyncData(42)); + container.listen(provider, (previous, next) {}); - sub.read().state = const AsyncData(42); + await expectLater(container.read(provider.future), completion(0)); + expect(container.read(provider), const AsyncData(0)); + container.read(dep.notifier).state++; expect( - sub.read().state, - isA>() - .having((e) => e.hasValue, 'hasValue', true) - .having((e) => e.value, 'value', 42), + container.read(provider), + const AsyncLoading() + .copyWithPrevious(const AsyncData(0), isRefresh: false), ); + + await expectLater(container.read(provider.future), completion(1)); + expect(container.read(provider), const AsyncData(1)); }); - test('Can assign `AsyncError` to `AsyncValue`', () { - // Regression test for https://github.com/rrousselGit/riverpod/issues/2120 - final provider = factory.simpleTestProvider((ref) => 42); + test('performs seamless data > loading > error transition', () async { final container = ProviderContainer.test(); + var result = Future.value(42); + final provider = FutureProvider((ref) => result); - final sub = container.listen(provider.notifier, (prev, next) {}); + final sub = container.listen(provider.future, (_, __) {}); - // ignore: void_checks - expect(sub.read().state, const AsyncData(42)); + expect(container.read(provider), const AsyncLoading()); + expect(await sub.read(), 42); + expect(container.read(provider), const AsyncData(42)); - sub.read().state = AsyncError(21, StackTrace.current); + result = Future.error('err', StackTrace.empty); + container.invalidate(provider); expect( - sub.read().state, - isA>() - .having((e) => e.hasValue, 'hasValue', true) - .having((e) => e.value, 'value', 42) - .having((e) => e.hasError, 'hasError', true) - .having((e) => e.error, 'error', 21), + container.read(provider), + const AsyncLoading().copyWithPrevious(const AsyncData(42)), + ); + await expectLater(sub.read(), throwsA('err')); + expect( + container.read(provider), + const AsyncError('err', StackTrace.empty) + .copyWithPrevious(const AsyncData(42)), ); }); - group('supports AsyncValue transition', () { - test( - 'performs seamless copyWithPrevious if triggered by ref.invalidate/ref.refresh', - () async { - final container = ProviderContainer.test(); - var count = 0; - final provider = factory.simpleTestProvider( - (ref) => Future.value(count++), - ); + test( + 'performs seamless:false copyWithPrevious if both triggered by a dependency change and ref.refresh', + () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final provider = factory.simpleTestProvider( + (ref) => Future.value(ref.watch(dep)), + ); - container.listen(provider, (previous, next) {}); + container.listen(provider, (previous, next) {}); - await expectLater(container.read(provider.future), completion(0)); - expect(container.read(provider), const AsyncData(0)); + await expectLater(container.read(provider.future), completion(0)); + expect(container.read(provider), const AsyncData(0)); - expect( - container.refresh(provider), - const AsyncLoading().copyWithPrevious(const AsyncData(0)), - ); + container.read(dep.notifier).state++; + expect( + container.refresh(provider), + const AsyncLoading() + .copyWithPrevious(const AsyncData(0), isRefresh: false), + ); - await expectLater(container.read(provider.future), completion(1)); - expect(container.read(provider), const AsyncData(1)); + await expectLater(container.read(provider.future), completion(1)); + expect(container.read(provider), const AsyncData(1)); + }); + }); - container.invalidate(provider); + test('does not notify listeners when refreshed during loading', () async { + final provider = factory.simpleTestProvider((ref) => Future.value(0)); + final container = ProviderContainer.test(); + final listener = Listener>(); - expect( - container.read(provider), - const AsyncLoading().copyWithPrevious(const AsyncData(1)), - ); - await expectLater(container.read(provider.future), completion(2)); - expect(container.read(provider), const AsyncData(2)); - }); + container.listen(provider, listener.call, fireImmediately: true); - test( - 'performs seamless:false copyWithPrevious on `state = AsyncLoading()`', - () async { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider((ref) => Future.value(0)); + verifyOnly(listener, listener(null, const AsyncLoading())); - final sub = container.listen(provider.notifier, (previous, next) {}); + container.refresh(provider); - await expectLater(container.read(provider.future), completion(0)); - expect(container.read(provider), const AsyncData(0)); + await container.read(provider.future); - sub.read().state = const AsyncLoading(); + verifyOnly( + listener, + listener(const AsyncLoading(), const AsyncData(0)), + ); + }); - expect( - sub.read().state, - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ); - }); + test('supports listenSelf', () { + final listener = Listener>(); + final onError = ErrorListener(); + final provider = factory.simpleTestProvider((ref) { + ref.listenSelf(listener.call, onError: onError.call); + Error.throwWithStackTrace(42, StackTrace.empty); + }); + final container = ProviderContainer.test(); - test( - 'performs seamless:false copyWithPrevious if triggered by a dependency change', - () async { - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) => Future.value(ref.watch(dep)), - ); + container.listen(provider, (previous, next) {}); - container.listen(provider, (previous, next) {}); + verifyOnly( + listener, + listener(null, const AsyncError(42, StackTrace.empty)), + ); + verifyZeroInteractions(onError); - await expectLater(container.read(provider.future), completion(0)); - expect(container.read(provider), const AsyncData(0)); + container.read(provider.notifier).state = const AsyncData(42); - container.read(dep.notifier).state++; - expect( - container.read(provider), - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ); + verifyNoMoreInteractions(onError); + verifyOnly( + listener, + listener( + const AsyncError(42, StackTrace.empty), + const AsyncData(42), + ), + ); + }); - await expectLater(container.read(provider.future), completion(1)); - expect(container.read(provider), const AsyncData(1)); - }); + test( + 'converts AsyncNotifier.build into an AsyncData if the future completes', + () async { + final provider = factory.simpleTestProvider((ref) => Future.value(0)); + final container = ProviderContainer.test(); + final listener = Listener>(); - test('performs seamless data > loading > error transition', () async { - final container = ProviderContainer.test(); - var result = Future.value(42); - final provider = FutureProvider((ref) => result); + container.listen(provider, listener.call, fireImmediately: true); - final sub = container.listen(provider.future, (_, __) {}); + verifyOnly(listener, listener(null, const AsyncLoading())); + expect( + container.read(provider.notifier).state, + const AsyncLoading(), + ); - expect(container.read(provider), const AsyncLoading()); - expect(await sub.read(), 42); - expect(container.read(provider), const AsyncData(42)); + expect(await container.read(provider.future), 0); - result = Future.error('err', StackTrace.empty); - container.invalidate(provider); + verifyOnly( + listener, + listener(const AsyncLoading(), const AsyncData(0)), + ); + expect( + container.read(provider.notifier).state, + const AsyncData(0), + ); + }); - expect( - container.read(provider), - const AsyncLoading().copyWithPrevious(const AsyncData(42)), - ); - await expectLater(sub.read(), throwsA('err')); - expect( - container.read(provider), - const AsyncError('err', StackTrace.empty) - .copyWithPrevious(const AsyncData(42)), - ); - }); + test('converts AsyncNotifier.build into an AsyncError if the future fails', + () async { + final provider = factory.simpleTestProvider( + (ref) => Future.error(0, StackTrace.empty), + ); + final container = ProviderContainer.test(); + final listener = Listener>(); - test( - 'performs seamless:false copyWithPrevious if both triggered by a dependency change and ref.refresh', - () async { - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) => Future.value(ref.watch(dep)), - ); + container.listen(provider, listener.call, fireImmediately: true); - container.listen(provider, (previous, next) {}); + verifyOnly(listener, listener(null, const AsyncLoading())); + expect( + container.read(provider.notifier).state, + const AsyncLoading(), + ); - await expectLater(container.read(provider.future), completion(0)); - expect(container.read(provider), const AsyncData(0)); + await expectLater(container.read(provider.future), throwsA(0)); - container.read(dep.notifier).state++; - expect( - container.refresh(provider), - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ); + verifyOnly( + listener, + listener(const AsyncLoading(), const AsyncError(0, StackTrace.empty)), + ); + expect( + container.read(provider.notifier).state, + const AsyncError(0, StackTrace.empty), + ); + }); - await expectLater(container.read(provider.future), completion(1)); - expect(container.read(provider), const AsyncData(1)); - }); - }); + test('supports cases where the AsyncNotifier constructor throws', () async { + final provider = factory.provider( + () => Error.throwWithStackTrace(0, StackTrace.empty), + ); + final container = ProviderContainer.test(); + final listener = Listener>(); - test('does not notify listeners when refreshed during loading', () async { - final provider = factory.simpleTestProvider((ref) => Future.value(0)); - final container = ProviderContainer.test(); - final listener = Listener>(); + container.listen(provider, listener.call, fireImmediately: true); - container.listen(provider, listener.call, fireImmediately: true); + verifyOnly( + listener, + listener(null, const AsyncError(0, StackTrace.empty)), + ); + expect( + () => container.read(provider.notifier), + throwsA(0), + ); - verifyOnly(listener, listener(null, const AsyncLoading())); + await expectLater(container.read(provider.future), throwsA(0)); + }); - container.refresh(provider); + test( + 'synchronously emits AsyncData if AsyncNotifier.build emits synchronously', + () async { + final provider = factory.simpleTestProvider((ref) => 0); + final container = ProviderContainer.test(); + final listener = Listener>(); - await container.read(provider.future); + container.listen(provider, listener.call, fireImmediately: true); - verifyOnly( - listener, - listener(const AsyncLoading(), const AsyncData(0)), - ); - }); + verifyOnly(listener, listener(null, const AsyncData(0))); + expect(container.read(provider.notifier).state, const AsyncData(0)); + await expectLater(container.read(provider.future), completion(0)); + }); - test('supports listenSelf', () { - final listener = Listener>(); - final onError = ErrorListener(); - final provider = factory.simpleTestProvider((ref) { - ref.listenSelf(listener.call, onError: onError.call); - Error.throwWithStackTrace(42, StackTrace.empty); - }); - final container = ProviderContainer.test(); + test( + 'synchronously emits AsyncError if AsyncNotifier.build throws synchronously', + () async { + final provider = factory.simpleTestProvider( + (ref) => Error.throwWithStackTrace(42, StackTrace.empty), + ); + final container = ProviderContainer.test(); + final listener = Listener>(); - container.listen(provider, (previous, next) {}); + container.listen(provider, listener.call, fireImmediately: true); - verifyOnly( - listener, - listener(null, const AsyncError(42, StackTrace.empty)), - ); - verifyZeroInteractions(onError); + verifyOnly( + listener, + listener(null, const AsyncError(42, StackTrace.empty)), + ); + expect( + container.read(provider.notifier).state, + const AsyncError(42, StackTrace.empty), + ); + await expectLater(container.read(provider.future), throwsA(42)); + }); - container.read(provider.notifier).state = const AsyncData(42); + test( + 'stops listening to the previous future data when the provider rebuilds', + () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final completers = { + 0: Completer.sync(), + 1: Completer.sync(), + }; + final provider = factory.simpleTestProvider( + (ref) => completers[ref.watch(dep)]!.future, + ); + final listener = Listener>(); - verifyNoMoreInteractions(onError); - verifyOnly( - listener, - listener( - const AsyncError(42, StackTrace.empty), - const AsyncData(42), - ), - ); - }); + container.listen(provider, listener.call); - test( - 'converts AsyncNotifier.build into an AsyncData if the future completes', - () async { - final provider = factory.simpleTestProvider((ref) => Future.value(0)); - final container = ProviderContainer.test(); - final listener = Listener>(); + expect( + container.read(provider.future), + completion(21), + reason: 'The provider rebuilt while the future was still pending, ' + 'so .future should resolve with the next value', + ); + verifyZeroInteractions(listener); + expect(container.read(provider), const AsyncLoading()); - container.listen(provider, listener.call, fireImmediately: true); + container.read(dep.notifier).state++; + completers[0]!.complete(42); - verifyOnly(listener, listener(null, const AsyncLoading())); - expect( - container.read(provider.notifier).state, - const AsyncLoading(), - ); + verifyZeroInteractions(listener); - expect(await container.read(provider.future), 0); + expect(container.read(provider.future), completion(21)); + expect(container.read(provider), const AsyncLoading()); - verifyOnly( - listener, - listener(const AsyncLoading(), const AsyncData(0)), - ); - expect( - container.read(provider.notifier).state, - const AsyncData(0), - ); - }); + completers[1]!.complete(21); - test( - 'converts AsyncNotifier.build into an AsyncError if the future fails', - () async { - final provider = factory.simpleTestProvider( - (ref) => Future.error(0, StackTrace.empty), - ); - final container = ProviderContainer.test(); - final listener = Listener>(); + expect(await container.read(provider.future), 21); + expect(container.read(provider), const AsyncData(21)); + }); - container.listen(provider, listener.call, fireImmediately: true); + test( + 'stops listening to the previous future error when the provider rebuilds', + () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final completers = { + 0: Completer.sync(), + 1: Completer.sync(), + }; + final provider = factory.simpleTestProvider( + (ref) => completers[ref.watch(dep)]!.future, + ); + final listener = Listener>(); - verifyOnly(listener, listener(null, const AsyncLoading())); - expect( - container.read(provider.notifier).state, - const AsyncLoading(), - ); + container.listen(provider, listener.call); - await expectLater(container.read(provider.future), throwsA(0)); + expect( + container.read(provider.future), + throwsA(21), + reason: 'The provider rebuilt while the future was still pending, ' + 'so .future should resolve with the next value', + ); + verifyZeroInteractions(listener); + expect(container.read(provider), const AsyncLoading()); - verifyOnly( - listener, - listener(const AsyncLoading(), const AsyncError(0, StackTrace.empty)), - ); - expect( - container.read(provider.notifier).state, - const AsyncError(0, StackTrace.empty), - ); - }); + container.read(dep.notifier).state++; + completers[0]!.completeError(42, StackTrace.empty); - test('supports cases where the AsyncNotifier constructor throws', - () async { - final provider = factory.testProvider( - () => Error.throwWithStackTrace(0, StackTrace.empty), - ); - final container = ProviderContainer.test(); - final listener = Listener>(); + verifyZeroInteractions(listener); - container.listen(provider, listener.call, fireImmediately: true); + expect(container.read(provider.future), throwsA(21)); + expect(container.read(provider), const AsyncLoading()); - verifyOnly( - listener, - listener(null, const AsyncError(0, StackTrace.empty)), - ); - expect( - () => container.read(provider.notifier), - throwsA(0), - ); + completers[1]!.completeError(21, StackTrace.empty); - await expectLater(container.read(provider.future), throwsA(0)); - }); + await expectLater(container.read(provider.future), throwsA(21)); + expect( + container.read(provider), + const AsyncError(21, StackTrace.empty), + ); + }); + group('AsyncNotifier.state', () { test( - 'synchronously emits AsyncData if AsyncNotifier.build emits synchronously', + 'when manually modifying the state, the new exposed value contains the previous state when possible', () async { final provider = factory.simpleTestProvider((ref) => 0); final container = ProviderContainer.test(); - final listener = Listener>(); - container.listen(provider, listener.call, fireImmediately: true); + final sub = container.listen(provider.notifier, (previous, next) {}); - verifyOnly(listener, listener(null, const AsyncData(0))); - expect(container.read(provider.notifier).state, const AsyncData(0)); - await expectLater(container.read(provider.future), completion(0)); - }); + // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` + final newState = AsyncData(84); + // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` + final newLoading = AsyncLoading(); + // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` + final newError = AsyncError(84, StackTrace.empty); - test( - 'synchronously emits AsyncError if AsyncNotifier.build throws synchronously', - () async { - final provider = factory.simpleTestProvider( - (ref) => Error.throwWithStackTrace(42, StackTrace.empty), - ); - final container = ProviderContainer.test(); - final listener = Listener>(); + sub.read().state = newState; - container.listen(provider, listener.call, fireImmediately: true); + expect(sub.read().state, same(newState)); - verifyOnly( - listener, - listener(null, const AsyncError(42, StackTrace.empty)), - ); - expect( - container.read(provider.notifier).state, - const AsyncError(42, StackTrace.empty), - ); - await expectLater(container.read(provider.future), throwsA(42)); - }); + sub.read().state = newLoading; - test( - 'stops listening to the previous future data when the provider rebuilds', - () async { - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - final completers = { - 0: Completer.sync(), - 1: Completer.sync(), - }; - final provider = factory.simpleTestProvider( - (ref) => completers[ref.watch(dep)]!.future, + expect( + sub.read().state, + const AsyncLoading() + .copyWithPrevious(newState, isRefresh: false), ); - final listener = Listener>(); - container.listen(provider, listener.call); + sub.read().state = newError; expect( - container.read(provider.future), - completion(21), - reason: 'The provider rebuilt while the future was still pending, ' - 'so .future should resolve with the next value', + sub.read().state, + newError.copyWithPrevious( + const AsyncLoading() + .copyWithPrevious(newState, isRefresh: false), + ), ); - verifyZeroInteractions(listener); - expect(container.read(provider), const AsyncLoading()); - - container.read(dep.notifier).state++; - completers[0]!.complete(42); - - verifyZeroInteractions(listener); - - expect(container.read(provider.future), completion(21)); - expect(container.read(provider), const AsyncLoading()); - - completers[1]!.complete(21); - - expect(await container.read(provider.future), 21); - expect(container.read(provider), const AsyncData(21)); }); test( - 'stops listening to the previous future error when the provider rebuilds', + 'when read on outdated provider, refreshes the provider and return the up-to-date state', () async { - final container = ProviderContainer.test(); + final listener = OnBuildMock(); final dep = StateProvider((ref) => 0); - final completers = { - 0: Completer.sync(), - 1: Completer.sync(), - }; final provider = factory.simpleTestProvider( - (ref) => completers[ref.watch(dep)]!.future, + (ref) { + listener(); + return Future.value(ref.watch(dep)); + }, ); - final listener = Listener>(); + final container = ProviderContainer.test(); - container.listen(provider, listener.call); + container.listen(provider, (previous, next) {}); + final notifier = container.read(provider.notifier); - expect( - container.read(provider.future), - throwsA(21), - reason: 'The provider rebuilt while the future was still pending, ' - 'so .future should resolve with the next value', - ); - verifyZeroInteractions(listener); - expect(container.read(provider), const AsyncLoading()); + expect(notifier.state, const AsyncLoading()); + expect(await container.read(provider.future), 0); + expect(notifier.state, const AsyncData(0)); + verify(listener()).called(1); container.read(dep.notifier).state++; - completers[0]!.completeError(42, StackTrace.empty); - - verifyZeroInteractions(listener); - expect(container.read(provider.future), throwsA(21)); - expect(container.read(provider), const AsyncLoading()); - - completers[1]!.completeError(21, StackTrace.empty); - - await expectLater(container.read(provider.future), throwsA(21)); expect( - container.read(provider), - const AsyncError(21, StackTrace.empty), + notifier.state, + const AsyncLoading() + .copyWithPrevious(const AsyncData(0), isRefresh: false), ); + expect(await container.read(provider.future), 1); + expect(notifier.state, const AsyncData(1)); + verify(listener()).called(1); }); - group('AsyncNotifier.state', () { - test( - 'when manually modifying the state, the new exposed value contains the previous state when possible', - () async { - final provider = factory.simpleTestProvider((ref) => 0); - final container = ProviderContainer.test(); - - final sub = container.listen(provider.notifier, (previous, next) {}); - - // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` - final newState = AsyncData(84); - // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` - final newLoading = AsyncLoading(); - // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` - final newError = AsyncError(84, StackTrace.empty); - - sub.read().state = newState; - - expect(sub.read().state, same(newState)); - - sub.read().state = newLoading; + test('can be read inside build', () { + final dep = StateProvider((ref) => 0); + late AsyncValue state; + final provider = factory.provider( + () { + late TestAsyncNotifier notifier; + return notifier = factory.deferredNotifier( + (ref) { + state = notifier.state; + return Future.value(ref.watch(dep)); + }, + ); + }, + ); + final container = ProviderContainer.test(); - expect( - sub.read().state, - const AsyncLoading() - .copyWithPrevious(newState, isRefresh: false), - ); + container.listen(provider, (previous, next) {}); - sub.read().state = newError; + expect(state, const AsyncLoading()); - expect( - sub.read().state, - newError.copyWithPrevious( - const AsyncLoading() - .copyWithPrevious(newState, isRefresh: false), - ), - ); - }); + container.read(provider.notifier).state = const AsyncData(42); + container.refresh(provider); - test( - 'when read on outdated provider, refreshes the provider and return the up-to-date state', - () async { - final listener = OnBuildMock(); - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) { - listener(); - return Future.value(ref.watch(dep)); - }, - ); - final container = ProviderContainer.test(); + expect( + state, + const AsyncLoading().copyWithPrevious(const AsyncData(42)), + ); + }); - container.listen(provider, (previous, next) {}); - final notifier = container.read(provider.notifier); + test('notifies listeners when the setter is called', () { + final provider = factory.simpleTestProvider((ref) => 0); + final container = ProviderContainer.test(); + final listener = Listener>(); - expect(notifier.state, const AsyncLoading()); - expect(await container.read(provider.future), 0); - expect(notifier.state, const AsyncData(0)); - verify(listener()).called(1); + container.listen(provider, listener.call); - container.read(dep.notifier).state++; + verifyZeroInteractions(listener); - expect( - notifier.state, - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ); - expect(await container.read(provider.future), 1); - expect(notifier.state, const AsyncData(1)); - verify(listener()).called(1); - }); + container.read(provider.notifier).state = const AsyncData(42); - test('can be read inside build', () { - final dep = StateProvider((ref) => 0); - late AsyncValue state; - final provider = factory.testProvider( - () { - late AsyncTestNotifierBase notifier; - return notifier = factory.notifier( - (ref) { - state = notifier.state; - return Future.value(ref.watch(dep)); - }, - ); - }, - ); - final container = ProviderContainer.test(); + verifyOnly( + listener, + listener(const AsyncData(0), const AsyncData(42)), + ); + }); + }); - container.listen(provider, (previous, next) {}); + group('AsyncNotifier.future', () { + test( + 'when disposed during loading, resolves with the content of AsyncNotifier.build', + () async { + final container = ProviderContainer.test(); + final completer = Completer.sync(); + final provider = factory.simpleTestProvider( + (ref) => completer.future, + ); - expect(state, const AsyncLoading()); + final future = container.read(provider.future); + container.dispose(); - container.read(provider.notifier).state = const AsyncData(42); - container.refresh(provider); + completer.complete(42); - expect( - state, - const AsyncLoading().copyWithPrevious(const AsyncData(42)), - ); - }); + await expectLater(future, completion(42)); + }); - test('notifies listeners when the setter is called', () { - final provider = factory.simpleTestProvider((ref) => 0); - final container = ProviderContainer.test(); - final listener = Listener>(); + test( + 'when disposed during loading, resolves with the error of AsyncNotifier.build', + () async { + final container = ProviderContainer.test(); + final completer = Completer.sync(); + final provider = factory.simpleTestProvider( + (ref) => completer.future, + ); - container.listen(provider, listener.call); + final future = container.read(provider.future); - verifyZeroInteractions(listener); + container.dispose(); - container.read(provider.notifier).state = const AsyncData(42); + completer.completeError(42); - verifyOnly( - listener, - listener(const AsyncData(0), const AsyncData(42)), - ); - }); + await expectLater(future, throwsA(42)); }); - group('AsyncNotifier.future', () { - test( - 'when disposed during loading, resolves with the content of AsyncNotifier.build', - () async { + test( + 'going data > loading while the future is still pending. ' + 'Resolves with last future result', + () async { final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( (ref) => completer.future, ); + container.read(provider); + container.read(provider.notifier).state = const AsyncData(42); + container.read(provider.notifier).state = const AsyncLoading(); + final future = container.read(provider.future); + container.dispose(); completer.complete(42); await expectLater(future, completion(42)); - }); + }, + ); - test( - 'when disposed during loading, resolves with the error of AsyncNotifier.build', - () async { + test( + 'if going back to loading after future resolved, throws StateError', + () async { final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( (ref) => completer.future, ); + container.read(provider); + + completer.complete(42); + + container.read(provider.notifier).state = const AsyncData(42); + container.read(provider.notifier).state = const AsyncLoading(); + final future = container.read(provider.future); container.dispose(); - completer.completeError(42); - - await expectLater(future, throwsA(42)); - }); + await expectLater(future, throwsStateError); + }, + ); - test( - 'going data > loading while the future is still pending. ' - 'Resolves with last future result', + test( + 'resolves with the new state if AsyncNotifier.state is modified during loading', () async { - final container = ProviderContainer.test(); - final completer = Completer.sync(); - final provider = factory.simpleTestProvider( - (ref) => completer.future, - ); + final container = ProviderContainer.test(); + final completer = Completer.sync(); + final provider = factory.simpleTestProvider( + (ref) => completer.future, + ); + final listener = Listener>(); - container.read(provider); - container.read(provider.notifier).state = const AsyncData(42); - container.read(provider.notifier).state = const AsyncLoading(); + final sub = container.listen(provider.notifier, (previous, next) {}); + container.listen(provider.future, listener.call); - final future = container.read(provider.future); + expect(sub.read().future, completion(21)); - container.dispose(); + sub.read().state = const AsyncData(21); - completer.complete(42); + completer.complete(42); - await expectLater(future, completion(42)); - }, - ); + expect(sub.read().future, completion(42)); + final capture = + verifyOnly(listener, listener(captureAny, captureAny)).captured; - test( - 'if going back to loading after future resolved, throws StateError', - () async { - final container = ProviderContainer.test(); - final completer = Completer.sync(); - final provider = factory.simpleTestProvider( - (ref) => completer.future, - ); + expect(capture.length, 2); + expect(capture.first, completion(21)); + expect(capture.last, completion(42)); + }); - container.read(provider); + test('resolves with the new state when notifier.state is changed', + () async { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider((ref) => 0); + final listener = Listener>(); - completer.complete(42); + final sub = container.listen(provider.notifier, (previous, next) {}); + container.listen( + provider.future, + listener.call, + fireImmediately: true, + ); - container.read(provider.notifier).state = const AsyncData(42); - container.read(provider.notifier).state = const AsyncLoading(); + await expectLater(sub.read().future, completion(0)); + verifyOnly( + listener, + listener(argThat(equals(null)), argThat(completion(0))), + ); - final future = container.read(provider.future); + sub.read().state = const AsyncData(1); - container.dispose(); + await expectLater(sub.read().future, completion(1)); + }); - await expectLater(future, throwsStateError); + test('returns a Future identical to that of .future', () { + final listener = OnBuildMock(); + final dep = StateProvider((ref) => 0); + final provider = factory.simpleTestProvider( + (ref) { + listener(); + return Future.value(ref.watch(dep)); }, ); + final container = ProviderContainer.test(); - test( - 'resolves with the new state if AsyncNotifier.state is modified during loading', - () async { - final container = ProviderContainer.test(); - final completer = Completer.sync(); - final provider = factory.simpleTestProvider( - (ref) => completer.future, - ); - final listener = Listener>(); - - final sub = container.listen(provider.notifier, (previous, next) {}); - container.listen(provider.future, listener.call); - - expect(sub.read().future, completion(21)); - - sub.read().state = const AsyncData(21); - - completer.complete(42); - - expect(sub.read().future, completion(42)); - final capture = - verifyOnly(listener, listener(captureAny, captureAny)).captured; - - expect(capture.length, 2); - expect(capture.first, completion(21)); - expect(capture.last, completion(42)); - }); + container.listen(provider.notifier, (previous, next) {}); + final notifier = container.read(provider.notifier); - test('resolves with the new state when notifier.state is changed', - () async { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider((ref) => 0); - final listener = Listener>(); - - final sub = container.listen(provider.notifier, (previous, next) {}); - container.listen( - provider.future, - listener.call, - fireImmediately: true, - ); + expect(notifier.future, same(container.read(provider.future))); + }); - await expectLater(sub.read().future, completion(0)); - verifyOnly( - listener, - listener(argThat(equals(null)), argThat(completion(0))), - ); + test( + 'when read on outdated provider, refreshes the provider and return the up-to-date state', + () async { + final listener = OnBuildMock(); + final dep = StateProvider((ref) => 0); + final provider = factory.simpleTestProvider( + (ref) { + listener(); + return Future.value(ref.watch(dep)); + }, + ); + final container = ProviderContainer.test(); - sub.read().state = const AsyncData(1); + container.listen(provider, (previous, next) {}); + final notifier = container.read(provider.notifier); - await expectLater(sub.read().future, completion(1)); - }); + expect(await container.read(provider.future), 0); + verify(listener()).called(1); - test('returns a Future identical to that of .future', () { - final listener = OnBuildMock(); - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) { - listener(); - return Future.value(ref.watch(dep)); - }, - ); - final container = ProviderContainer.test(); + container.read(dep.notifier).state++; - container.listen(provider.notifier, (previous, next) {}); - final notifier = container.read(provider.notifier); + expect(notifier.future, notifier.future); + expect(notifier.future, same(container.read(provider.future))); + expect(await notifier.future, 1); + verify(listener()).called(1); + }); + }); - expect(notifier.future, same(container.read(provider.future))); + group('AsyncNotifierProvider.notifier', () { + test( + 'never emits an update. The Notifier is never recreated once it is instantiated', + () async { + final listener = OnBuildMock(); + final dep = StateProvider((ref) => 0); + final provider = factory.provider(() { + listener(); + return factory.deferredNotifier((ref) => ref.watch(dep)); }); + final container = ProviderContainer.test(); - test( - 'when read on outdated provider, refreshes the provider and return the up-to-date state', - () async { - final listener = OnBuildMock(); - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) { - listener(); - return Future.value(ref.watch(dep)); - }, - ); - final container = ProviderContainer.test(); - - container.listen(provider, (previous, next) {}); - final notifier = container.read(provider.notifier); + container.listen(provider, (previous, next) {}); + final notifier = container.read(provider.notifier); - expect(await container.read(provider.future), 0); - verify(listener()).called(1); + verify(listener()).called(1); + expect(container.read(provider), const AsyncData(0)); - container.read(dep.notifier).state++; + container.read(dep.notifier).state++; - expect(notifier.future, notifier.future); - expect(notifier.future, same(container.read(provider.future))); - expect(await notifier.future, 1); - verify(listener()).called(1); - }); + expect(container.read(provider), const AsyncData(1)); + expect(container.read(provider.notifier), same(notifier)); + verifyNoMoreInteractions(listener); }); + }); - group('AsyncNotifierProvider.notifier', () { - test( - 'never emits an update. The Notifier is never recreated once it is instantiated', - () async { - final listener = OnBuildMock(); - final dep = StateProvider((ref) => 0); - final provider = factory.testProvider(() { - listener(); - return factory.notifier((ref) => ref.watch(dep)); - }); - final container = ProviderContainer.test(); - - container.listen(provider, (previous, next) {}); - final notifier = container.read(provider.notifier); + test( + 'Can override AsyncNotifier.updateShouldNotify to change the default filter logic', + () { + final provider = factory.simpleTestProvider>( + (ref) => Equal(42), + updateShouldNotify: (a, b) => a != b, + ); + final container = ProviderContainer.test(); + final listener = Listener>>(); - verify(listener()).called(1); - expect(container.read(provider), const AsyncData(0)); + container.listen(provider, listener.call); + final notifier = container.read(provider.notifier); - container.read(dep.notifier).state++; + // voluntarily assigning the same value + final self = notifier.state; + notifier.state = self; - expect(container.read(provider), const AsyncData(1)); - expect(container.read(provider.notifier), same(notifier)); - verifyNoMoreInteractions(listener); - }); - }); + verifyZeroInteractions(listener); - test( - 'Can override AsyncNotifier.updateShouldNotify to change the default filter logic', - () { - final provider = factory.simpleTestProvider>( - (ref) => Equal(42), - updateShouldNotify: (a, b) => a != b, - ); - final container = ProviderContainer.test(); - final listener = Listener>>(); + notifier.state = AsyncData(Equal(42)); - container.listen(provider, listener.call); - final notifier = container.read(provider.notifier); + verifyZeroInteractions(listener); - // voluntarily assigning the same value - final self = notifier.state; - notifier.state = self; + notifier.state = AsyncData(Equal(21)); - verifyZeroInteractions(listener); + verifyOnly( + listener, + listener(AsyncData(Equal(42)), AsyncData(Equal(21))), + ); + }); - notifier.state = AsyncData(Equal(42)); + group('AsyncNotifier.update', () { + test('passes in the latest state', () async { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider( + (ref) => 0, + ); - verifyZeroInteractions(listener); + final sub = container.listen(provider.notifier, (prev, next) {}); - notifier.state = AsyncData(Equal(21)); + expect( + container.read(provider), + const AsyncData(0), + ); - verifyOnly( - listener, - listener(AsyncData(Equal(42)), AsyncData(Equal(21))), + await expectLater( + sub.read().update((prev) => prev + 1), + completion(1), + ); + await expectLater( + sub.read().future, + completion(1), + ); + await expectLater( + sub.read().update((prev) => prev + 1), + completion(2), ); }); - group('AsyncNotifier.update', () { - test('passes in the latest state', () async { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider( - (ref) => 0, - ); - - final sub = container.listen(provider.notifier, (prev, next) {}); - - expect( - container.read(provider), - const AsyncData(0), - ); - - await expectLater( - sub.read().update((prev) => prev + 1), - completion(1), - ); - await expectLater( - sub.read().future, - completion(1), - ); - await expectLater( - sub.read().update((prev) => prev + 1), - completion(2), - ); - }); - - test('can specify onError to handle error scenario', () async { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider( - (ref) => Error.throwWithStackTrace(42, StackTrace.empty), - ); - var callCount = 0; - Object? actualErr; - Object? actualStack; + test('can specify onError to handle error scenario', () async { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider( + (ref) => Error.throwWithStackTrace(42, StackTrace.empty), + ); + var callCount = 0; + Object? actualErr; + Object? actualStack; - final sub = container.listen(provider.notifier, (prev, next) {}); + final sub = container.listen(provider.notifier, (prev, next) {}); - expect( - container.read(provider), - const AsyncError(42, StackTrace.empty), - ); + expect( + container.read(provider), + const AsyncError(42, StackTrace.empty), + ); - await expectLater( - sub.read().update( - (prev) { - callCount++; - return prev; - }, - onError: (err, stack) { - actualErr = err; - actualStack = stack; - return 21; - }, - ), - completion(21), - ); - expect(callCount, 0); - expect(actualErr, 42); - expect(actualStack, StackTrace.empty); - expect(container.read(provider), const AsyncData(21)); - }); + await expectLater( + sub.read().update( + (prev) { + callCount++; + return prev; + }, + onError: (err, stack) { + actualErr = err; + actualStack = stack; + return 21; + }, + ), + completion(21), + ); + expect(callCount, 0); + expect(actualErr, 42); + expect(actualStack, StackTrace.empty); + expect(container.read(provider), const AsyncData(21)); + }); - test('executes immediately with current state if a state is available', - () async { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider((ref) => 1); + test('executes immediately with current state if a state is available', + () async { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider((ref) => 1); - final sub = container.listen(provider.notifier, (prev, next) {}); + final sub = container.listen(provider.notifier, (prev, next) {}); - expect(container.read(provider), const AsyncData(1)); + expect(container.read(provider), const AsyncData(1)); - await expectLater( - sub.read().update((prev) => prev + 1), - completion(2), - ); - expect(container.read(provider), const AsyncData(2)); - }); + await expectLater( + sub.read().update((prev) => prev + 1), + completion(2), + ); + expect(container.read(provider), const AsyncData(2)); + }); - test('executes immediately with current state if an error is available', - () async { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider( - (ref) => Error.throwWithStackTrace(42, StackTrace.empty), - ); - var callCount = 0; + test('executes immediately with current state if an error is available', + () async { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider( + (ref) => Error.throwWithStackTrace(42, StackTrace.empty), + ); + var callCount = 0; - final sub = container.listen(provider.notifier, (prev, next) {}); + final sub = container.listen(provider.notifier, (prev, next) {}); - expect( - container.read(provider), - const AsyncError(42, StackTrace.empty), - ); + expect( + container.read(provider), + const AsyncError(42, StackTrace.empty), + ); - await expectLater( - sub.read().update((prev) { - callCount++; - return prev + 1; - }), - throwsA(42), - ); + await expectLater( + sub.read().update((prev) { + callCount++; + return prev + 1; + }), + throwsA(42), + ); - expect(callCount, 0); - expect( - container.read(provider), - const AsyncError(42, StackTrace.empty), - ); - }); + expect(callCount, 0); + expect( + container.read(provider), + const AsyncError(42, StackTrace.empty), + ); + }); - test('awaits the future resolution if in loading state', () async { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider( - (ref) => Future.value(42), - ); + test('awaits the future resolution if in loading state', () async { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider( + (ref) => Future.value(42), + ); - final sub = container.listen(provider.notifier, (prev, next) {}); + final sub = container.listen(provider.notifier, (prev, next) {}); - expect(container.read(provider), const AsyncLoading()); + expect(container.read(provider), const AsyncLoading()); - await expectLater( - sub.read().update((prev) => prev + 1), - completion(43), - ); - expect(container.read(provider), const AsyncData(43)); - }); + await expectLater( + sub.read().update((prev) => prev + 1), + completion(43), + ); + expect(container.read(provider), const AsyncData(43)); }); }); - } + }); test('supports overrideWith', () { - final provider = AsyncNotifierProvider, int>( - () => AsyncTestNotifier((ref) => 0), + final provider = AsyncNotifierProvider, int>( + () => DeferredAsyncNotifier((ref) => 0), ); - final autoDispose = AsyncNotifierProvider.autoDispose< - AutoDisposeAsyncTestNotifier, int>( - () => AutoDisposeAsyncTestNotifier((ref) => 0), + final autoDispose = + AsyncNotifierProvider.autoDispose, int>( + () => DeferredAsyncNotifier((ref) => 0), ); final container = ProviderContainer.test( overrides: [ - provider.overrideWith(() => AsyncTestNotifier((ref) => 42)), + provider.overrideWith(() => DeferredAsyncNotifier((ref) => 42)), autoDispose.overrideWith( - () => AutoDisposeAsyncTestNotifier((ref) => 84), + () => DeferredAsyncNotifier((ref) => 84), ), ], ); @@ -1028,21 +1010,21 @@ void main() { }); test('supports family overrideWith', () { - final family = - AsyncNotifierProvider.family, int, int>( - () => AsyncTestNotifierFamily((ref) => 0), + final family = AsyncNotifierProvider.family< + DeferredFamilyAsyncNotifier, int, int>( + () => DeferredFamilyAsyncNotifier((ref) => 0), ); final autoDisposeFamily = AsyncNotifierProvider.autoDispose - .family, int, int>( - () => AutoDisposeAsyncTestNotifierFamily((ref) => 0), + .family, int, int>( + () => DeferredFamilyAsyncNotifier((ref) => 0), ); final container = ProviderContainer.test( overrides: [ family.overrideWith( - () => AsyncTestNotifierFamily((ref) => 42), + () => DeferredFamilyAsyncNotifier((ref) => 42), ), autoDisposeFamily.overrideWith( - () => AutoDisposeAsyncTestNotifierFamily((ref) => 84), + () => DeferredFamilyAsyncNotifier((ref) => 84), ), ], ); @@ -1051,21 +1033,6 @@ void main() { expect(container.read(autoDisposeFamily(10)).value, 84); }); - group('AutoDispose variant', () { - test('can watch autoDispose providers', () { - final dep = Provider.autoDispose((ref) => 0); - final provider = AutoDisposeAsyncNotifierProvider< - AutoDisposeAsyncTestNotifier, int>( - () => AutoDisposeAsyncTestNotifier((ref) { - return ref.watch(dep); - }), - ); - final container = ProviderContainer.test(); - - expect(container.read(provider), const AsyncData(0)); - }); - }); - group('modifiers', () { void canBeAssignedToRefreshable( Refreshable provider, @@ -1076,11 +1043,13 @@ void main() { ) {} test('provider', () { - final provider = AsyncNotifierProvider, int>( - () => AsyncTestNotifier((ref) => 0), + final provider = AsyncNotifierProvider, int>( + () => DeferredAsyncNotifier((ref) => 0), ); + // ignore: avoid_types_on_closure_parameters provider.select((AsyncValue value) => 0); + // ignore: avoid_types_on_closure_parameters provider.selectAsync((int value) => 0); canBeAssignedToProviderListenable>(provider); @@ -1094,12 +1063,14 @@ void main() { }); test('autoDispose', () { - final autoDispose = AsyncNotifierProvider.autoDispose< - AutoDisposeAsyncTestNotifier, int>( - () => AutoDisposeAsyncTestNotifier((ref) => 0), + final autoDispose = + AsyncNotifierProvider.autoDispose, int>( + () => DeferredAsyncNotifier((ref) => 0), ); + // ignore: avoid_types_on_closure_parameters autoDispose.select((AsyncValue value) => 0); + // ignore: avoid_types_on_closure_parameters autoDispose.selectAsync((int value) => 0); canBeAssignedToProviderListenable>(autoDispose); @@ -1108,21 +1079,23 @@ void main() { canBeAssignedToProviderListenable>(autoDispose.future); canBeAssignedToRefreshable>(autoDispose.future); - canBeAssignedToProviderListenable>( + canBeAssignedToProviderListenable>( autoDispose.notifier, ); - canBeAssignedToRefreshable>( + canBeAssignedToRefreshable>( autoDispose.notifier, ); }); test('family', () { final family = AsyncNotifierProvider.family< - AsyncTestNotifierFamily, String, int>( - () => AsyncTestNotifierFamily((ref) => '0'), + DeferredFamilyAsyncNotifier, String, int>( + () => DeferredFamilyAsyncNotifier((ref) => '0'), ); + // ignore: avoid_types_on_closure_parameters family(0).select((AsyncValue value) => 0); + // ignore: avoid_types_on_closure_parameters family(0).selectAsync((String value) => 0); canBeAssignedToProviderListenable>(family(0)); @@ -1146,11 +1119,13 @@ void main() { ); final autoDisposeFamily = AsyncNotifierProvider.autoDispose - .family, String, int>( - () => AutoDisposeAsyncTestNotifierFamily((ref) => '0'), + .family, String, int>( + () => DeferredFamilyAsyncNotifier((ref) => '0'), ); + // ignore: avoid_types_on_closure_parameters autoDisposeFamily(0).select((AsyncValue value) => 0); + // ignore: avoid_types_on_closure_parameters autoDisposeFamily(0).selectAsync((String value) => 0); canBeAssignedToProviderListenable>( @@ -1167,11 +1142,10 @@ void main() { autoDisposeFamily(0).future, ); - canBeAssignedToProviderListenable< - AutoDisposeFamilyAsyncNotifier>( + canBeAssignedToProviderListenable>( autoDisposeFamily(0).notifier, ); - canBeAssignedToRefreshable>( + canBeAssignedToRefreshable>( autoDisposeFamily(0).notifier, ); }); @@ -1190,19 +1164,13 @@ class Equal { @override int get hashCode => Object.hash(runtimeType, value); -} - -class CtorNotifier extends AsyncNotifier { - CtorNotifier() { - state; - } @override - FutureOr build() => 0; + String toString() => 'Equal($value)'; } -class AutoDisposeCtorNotifier extends AutoDisposeAsyncNotifier { - AutoDisposeCtorNotifier() { +class CtorNotifier extends AsyncNotifier { + CtorNotifier() { state; } @@ -1210,16 +1178,6 @@ class AutoDisposeCtorNotifier extends AutoDisposeAsyncNotifier { FutureOr build() => 0; } -class AutoDisposeFamilyCtorNotifier - extends AutoDisposeFamilyAsyncNotifier { - AutoDisposeFamilyCtorNotifier() { - state; - } - - @override - FutureOr build(int arg) => 0; -} - class FamilyCtorNotifier extends FamilyAsyncNotifier { FamilyCtorNotifier() { state; diff --git a/packages/riverpod/test/old/legacy_providers/async_notifier/factory.dart b/packages/riverpod/test/old/legacy_providers/async_notifier/factory.dart deleted file mode 100644 index 42f7c367e..000000000 --- a/packages/riverpod/test/old/legacy_providers/async_notifier/factory.dart +++ /dev/null @@ -1,310 +0,0 @@ -import 'dart:async'; - -import 'package:riverpod/src/internals.dart'; - -typedef AsyncNotifierProviderFactoryType - = AsyncNotifierProviderBase - Function, T>( - NotifierT Function() create, { - Iterable? dependencies, - String? name, -}); - -typedef AsyncNotifierFactoryType = AsyncTestNotifierBase Function( - FutureOr Function(AsyncNotifierProviderRef), { - bool Function(AsyncValue, AsyncValue)? updateShouldNotify, -}); - -typedef SimpleTestProviderFactoryType - = AsyncNotifierProviderBase, T> Function( - FutureOr Function(AsyncNotifierProviderRef ref) init, { - bool Function(AsyncValue prev, AsyncValue next)? updateShouldNotify, -}); - -typedef TestProviderFactoryType - = AsyncNotifierProviderBase, T> Function( - AsyncTestNotifierBase Function() createNotifier, -); - -List matrix({ - bool alwaysAlive = true, - bool autoDispose = true, -}) { - return [ - if (alwaysAlive) - AsyncNotifierFactory( - label: 'AsyncNotifierProvider', - isAutoDispose: false, - provider: AsyncNotifierProvider.new, - notifier: AsyncTestNotifier.new, - testProvider: (createNotifier) { - return AsyncNotifierProvider, T>( - createNotifier, - ); - }, - simpleTestProvider: (init, {updateShouldNotify}) { - return AsyncNotifierProvider, T>( - () => AsyncTestNotifier( - init, - updateShouldNotify: updateShouldNotify, - ), - ); - }, - ), - if (alwaysAlive) - AsyncNotifierFactory( - label: 'AsyncNotifierProviderFamily', - isAutoDispose: false, - provider: , T>( - create, { - argument, - dependencies, - from, - name, - }) { - return FamilyAsyncNotifierProviderImpl.internal( - create, - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - notifier: AsyncTestNotifierFamily.new, - testProvider: (createNotifier) { - return FamilyAsyncNotifierProviderImpl, T, - int>.internal( - () => createNotifier() as AsyncTestNotifierFamily, - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - simpleTestProvider: (init, {updateShouldNotify}) { - return FamilyAsyncNotifierProviderImpl, T, - int>.internal( - () => AsyncTestNotifierFamily( - init, - updateShouldNotify: updateShouldNotify, - ), - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - ), - if (autoDispose) - AsyncNotifierFactory( - label: 'AutoDisposeAsyncNotifierProvider', - isAutoDispose: true, - provider: AutoDisposeAsyncNotifierProviderImpl.new, - notifier: AutoDisposeAsyncTestNotifier.new, - testProvider: (createNotifier) { - return AutoDisposeAsyncNotifierProviderImpl< - AutoDisposeAsyncTestNotifier, T>( - () => createNotifier() as AutoDisposeAsyncTestNotifier, - ); - }, - simpleTestProvider: (init, {updateShouldNotify}) { - return AutoDisposeAsyncNotifierProvider< - AutoDisposeAsyncTestNotifier, T>( - () => AutoDisposeAsyncTestNotifier( - init, - updateShouldNotify: updateShouldNotify, - ), - ); - }, - ), - if (autoDispose) - AsyncNotifierFactory( - label: 'AutoDisposeAsyncNotifierProviderFamily', - isAutoDispose: true, - provider: , T>( - create, { - argument, - dependencies, - from, - name, - }) { - return AutoDisposeFamilyAsyncNotifierProviderImpl.internal( - create, - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - notifier: AutoDisposeAsyncTestNotifierFamily.new, - testProvider: (createNotifier) { - return AutoDisposeFamilyAsyncNotifierProviderImpl< - AutoDisposeAsyncTestNotifierFamily, T, int>.internal( - () => createNotifier() as AutoDisposeAsyncTestNotifierFamily, - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - simpleTestProvider: (init, {updateShouldNotify}) { - return AutoDisposeFamilyAsyncNotifierProviderImpl< - AutoDisposeAsyncTestNotifierFamily, T, int>.internal( - () => AutoDisposeAsyncTestNotifierFamily( - init, - updateShouldNotify: updateShouldNotify, - ), - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - ), - ]; -} - -class AsyncNotifierFactory { - const AsyncNotifierFactory({ - required this.label, - required this.provider, - required this.notifier, - required this.isAutoDispose, - required this.testProvider, - required this.simpleTestProvider, - }); - - final String label; - final bool isAutoDispose; - final AsyncNotifierProviderFactoryType provider; - final AsyncNotifierFactoryType notifier; - final TestProviderFactoryType testProvider; - final SimpleTestProviderFactoryType simpleTestProvider; -} - -abstract class AsyncTestNotifierBase extends _AsyncNotifierBase { - // overriding to remove the @protected - @override - Future update( - FutureOr Function(T p1) cb, { - FutureOr Function(Object err, StackTrace stackTrace)? onError, - }) { - return super.update(cb); - } -} - -class AsyncTestNotifier extends AsyncNotifier - implements AsyncTestNotifierBase { - AsyncTestNotifier( - this._init, { - bool Function(AsyncValue prev, AsyncValue next)? updateShouldNotify, - }) : _updateShouldNotify = updateShouldNotify; - - final FutureOr Function(AsyncNotifierProviderRef ref) _init; - - final bool Function(AsyncValue prev, AsyncValue next)? - _updateShouldNotify; - - @override - FutureOr build() => _init(ref); - - @override - bool updateShouldNotify(AsyncValue prev, AsyncValue next) { - return _updateShouldNotify?.call(prev, next) ?? - super.updateShouldNotify(prev, next); - } - - @override - String toString() { - return 'AsyncTestNotifier<$T>#$hashCode'; - } -} - -class AsyncTestNotifierFamily extends FamilyAsyncNotifier - implements AsyncTestNotifierBase { - AsyncTestNotifierFamily( - this._init, { - bool Function(AsyncValue prev, AsyncValue next)? updateShouldNotify, - }) : _updateShouldNotify = updateShouldNotify; - - final FutureOr Function(AsyncNotifierProviderRef ref) _init; - - final bool Function(AsyncValue prev, AsyncValue next)? - _updateShouldNotify; - - @override - FutureOr build(int arg) => _init(ref); - - @override - bool updateShouldNotify(AsyncValue prev, AsyncValue next) { - return _updateShouldNotify?.call(prev, next) ?? - super.updateShouldNotify(prev, next); - } - - @override - String toString() { - return 'AsyncTestNotifierFamily<$T>#$hashCode'; - } -} - -class AutoDisposeAsyncTestNotifier extends AutoDisposeAsyncNotifier - implements AsyncTestNotifierBase { - AutoDisposeAsyncTestNotifier( - this._init2, { - bool Function(AsyncValue prev, AsyncValue next)? updateShouldNotify, - }) : _updateShouldNotify = updateShouldNotify; - - final FutureOr Function(AutoDisposeAsyncNotifierProviderRef ref) _init2; - - final bool Function(AsyncValue prev, AsyncValue next)? - _updateShouldNotify; - - @override - FutureOr build() => _init2(ref); - - @override - bool updateShouldNotify(AsyncValue prev, AsyncValue next) { - return _updateShouldNotify?.call(prev, next) ?? - super.updateShouldNotify(prev, next); - } - - @override - String toString() { - return 'AutoDisposeAsyncTestNotifier<$T>#$hashCode'; - } -} - -class AutoDisposeAsyncTestNotifierFamily - extends AutoDisposeFamilyAsyncNotifier - implements AsyncTestNotifierBase { - AutoDisposeAsyncTestNotifierFamily( - this._init2, { - bool Function(AsyncValue prev, AsyncValue next)? updateShouldNotify, - }) : _updateShouldNotify = updateShouldNotify; - - final FutureOr Function(AutoDisposeAsyncNotifierProviderRef ref) _init2; - - final bool Function(AsyncValue prev, AsyncValue next)? - _updateShouldNotify; - - @override - FutureOr build(int arg) => _init2(ref); - - @override - bool updateShouldNotify(AsyncValue prev, AsyncValue next) { - return _updateShouldNotify?.call(prev, next) ?? - super.updateShouldNotify(prev, next); - } - - @override - String toString() { - return 'AutoDisposeAsyncTestNotifierFamily<$T, int>#$hashCode'; - } -} From 43a4b454048a113148d6d3aeb30a580e6ea95498 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 1 Feb 2024 14:29:53 +0100 Subject: [PATCH 142/387] Restore StreamNotifier tests --- packages/riverpod/lib/riverpod.dart | 4 +- .../lib/src/providers/stream_notifier.dart | 10 +- .../src/providers/stream_notifier/family.dart | 10 +- .../src/providers/stream_notifier/orphan.dart | 12 +- packages/riverpod/test/new/matrix.dart | 206 +-- .../new/matrix/async_notifier_provider.dart | 204 +++ .../new/matrix/stream_notifier_provider.dart | 206 +++ .../stream_notifier/async_notifier_test.dart | 1171 ----------------- .../stream_notifier/factory.dart | 314 ----- .../stream_notifier/stream_notifier_test.dart | 1136 ++++++++++++++++ 10 files changed, 1572 insertions(+), 1701 deletions(-) create mode 100644 packages/riverpod/test/new/matrix/async_notifier_provider.dart create mode 100644 packages/riverpod/test/new/matrix/stream_notifier_provider.dart delete mode 100644 packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart delete mode 100644 packages/riverpod/test/old/legacy_providers/stream_notifier/factory.dart create mode 100644 packages/riverpod/test/old/legacy_providers/stream_notifier/stream_notifier_test.dart diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index bf7ad8d7d..f0e55c843 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -43,10 +43,8 @@ export 'src/framework.dart' RunNotifierBuild, FunctionalProvider, ClassProvider; - export 'src/providers/async_notifier.dart' hide AsyncNotifierBase, AsyncNotifierProviderBase; - // TODO changelog breaking: StateNotifier & co are no-longer exported from pkg:riverpod/riverpod.dart // Use pkg:riverpod/legacy.dart @@ -54,4 +52,6 @@ export 'src/providers/future_provider.dart'; export 'src/providers/notifier.dart' hide NotifierProvider, FamilyNotifierProvider; export 'src/providers/provider.dart'; +export 'src/providers/stream_notifier.dart' + hide StreamNotifierBase, StreamNotifierProviderBase; export 'src/providers/stream_provider.dart'; diff --git a/packages/riverpod/lib/src/providers/stream_notifier.dart b/packages/riverpod/lib/src/providers/stream_notifier.dart index d15c8c782..c1bbece19 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier.dart @@ -10,14 +10,16 @@ import 'future_provider.dart' show FutureProvider; part 'stream_notifier/family.dart'; part 'stream_notifier/orphan.dart'; -abstract class _StreamNotifierBase extends ClassBase< // +@internal +abstract class StreamNotifierBase extends ClassBase< // AsyncValue, Stream> // with AsyncClassMixin> {} -abstract base class _StreamNotifierProviderBase< - NotifierT extends _StreamNotifierBase, // +@internal +abstract base class StreamNotifierProviderBase< + NotifierT extends StreamNotifierBase, // StateT> // extends ClassProvider< // NotifierT, @@ -26,7 +28,7 @@ abstract base class _StreamNotifierProviderBase< Ref>> // with FutureModifier { - const _StreamNotifierProviderBase( + const StreamNotifierProviderBase( this._createNotifier, { required super.name, required super.from, diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index 12eaa6f51..f7cb426c2 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -4,7 +4,7 @@ part of '../stream_notifier.dart'; /// /// {@macro riverpod.async_notifier_provider_modifier} abstract class FamilyStreamNotifier - extends _StreamNotifierBase { + extends StreamNotifierBase { /// {@template riverpod.notifier.family_arg} /// The argument that was passed to this family. /// @@ -16,18 +16,22 @@ abstract class FamilyStreamNotifier /// /// then [arg] will be `0`. /// {@endtemplate} - late final Arg arg; + late final Arg arg = (ref as ProviderElementBase).origin.argument as Arg; /// {@macro riverpod.async_notifier.build} @visibleForOverriding Stream build(Arg arg); + + @internal + @override + Stream runBuild() => build(arg); } final class FamilyStreamNotifierProvider< // NotifierT extends FamilyStreamNotifier, StateT, ArgT> // - extends _StreamNotifierProviderBase { + extends StreamNotifierProviderBase { /// An implementation detail of Riverpod const FamilyStreamNotifierProvider._( super._createNotifier, { diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index bbbbc2c50..d85f187f8 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -15,10 +15,14 @@ part of '../stream_notifier.dart'; /// When using `family`, your notifier type changes. Instead of extending /// [StreamNotifier], you should extend [FamilyStreamNotifier]. /// {@endtemplate} -abstract class StreamNotifier extends _StreamNotifierBase { +abstract class StreamNotifier extends StreamNotifierBase { /// {@macro riverpod.async_notifier.build} @visibleForOverriding Stream build(); + + @internal + @override + Stream runBuild() => build(); } /// {@template riverpod.async_notifier_provider} @@ -43,7 +47,7 @@ abstract class StreamNotifier extends _StreamNotifierBase { final class StreamNotifierProvider< // NotifierT extends StreamNotifier, StateT> // - extends _StreamNotifierProviderBase { + extends StreamNotifierProviderBase { /// {@macro riverpod.async_notifier_provider} /// /// {@macro riverpod.async_notifier_provider_modifier} @@ -138,7 +142,7 @@ final class StreamNotifierProvider< // } class _StreamNotifierProviderElement< // - NotifierT extends _StreamNotifierBase, + NotifierT extends StreamNotifierBase, StateT> // extends ClassProviderElement< // NotifierT, @@ -149,7 +153,7 @@ class _StreamNotifierProviderElement< // _StreamNotifierProviderElement(this.provider, super.container); @override - final _StreamNotifierProviderBase provider; + final StreamNotifierProviderBase provider; @override void handleError( diff --git a/packages/riverpod/test/new/matrix.dart b/packages/riverpod/test/new/matrix.dart index 079d393cd..457be01f1 100644 --- a/packages/riverpod/test/new/matrix.dart +++ b/packages/riverpod/test/new/matrix.dart @@ -3,6 +3,9 @@ import 'dart:async'; import 'package:riverpod/src/internals.dart'; import 'package:test/test.dart'; +part 'matrix/async_notifier_provider.dart'; +part 'matrix/stream_notifier_provider.dart'; + class TestMatrix> { TestMatrix(this.values); @@ -157,206 +160,3 @@ final asyncProviderFactory = dependencies: dependencies, ), ]; - -final asyncNotifierProviderFactory = TestMatrix( - { - 'AsyncNotifierProvider': AsyncNotifierTestFactory( - deferredNotifier: DeferredAsyncNotifier.new, - deferredProvider: (create, {updateShouldNotify}) { - return AsyncNotifierProvider, StateT>( - () => DeferredAsyncNotifier( - create, - updateShouldNotify: updateShouldNotify, - ), - ); - }, - provider: (create) => - AsyncNotifierProvider, StateT>( - () => create() as AsyncNotifier, - ), - value: (create, {name, dependencies}) => ([arg]) { - return AsyncNotifierProvider, Object?>( - () => create(null, arg) as AsyncNotifier, - name: name, - dependencies: dependencies, - ); - }, - ), - 'AsyncNotifierProvider.autoDispose': AsyncNotifierTestFactory( - deferredNotifier: DeferredAsyncNotifier.new, - deferredProvider: (create, {updateShouldNotify}) { - return AsyncNotifierProvider.autoDispose, - StateT>( - () => DeferredAsyncNotifier( - create, - updateShouldNotify: updateShouldNotify, - ), - ); - }, - provider: (create) { - return AsyncNotifierProvider.autoDispose, StateT>( - () => create() as AsyncNotifier, - ); - }, - value: (create, {name, dependencies}) => ([arg]) { - return AsyncNotifierProvider.autoDispose, - Object?>( - () => create(null, arg) as AsyncNotifier, - name: name, - dependencies: dependencies, - ); - }, - ), - 'AsyncNotifierProvider.family': AsyncNotifierTestFactory( - deferredNotifier: DeferredFamilyAsyncNotifier.new, - deferredProvider: (create, {updateShouldNotify}) { - return AsyncNotifierProvider.family, - StateT, Object?>( - () => DeferredFamilyAsyncNotifier( - create, - updateShouldNotify: updateShouldNotify, - ), - ).call(42); - }, - provider: (create) { - return AsyncNotifierProvider.family< - FamilyAsyncNotifier, StateT, Object?>( - () => create() as FamilyAsyncNotifier, - ).call(42); - }, - value: (create, {name, dependencies}) => ([arg]) { - return AsyncNotifierProvider.family< - FamilyAsyncNotifier, Object?, Object?>( - () => create(null, arg) as FamilyAsyncNotifier, - name: name, - dependencies: dependencies, - )(arg); - }, - ), - 'AsyncNotifierProvider.autoDispose.family': AsyncNotifierTestFactory( - deferredNotifier: DeferredFamilyAsyncNotifier.new, - deferredProvider: (create, {updateShouldNotify}) { - return AsyncNotifierProvider.family - .autoDispose, StateT, Object?>( - () => DeferredFamilyAsyncNotifier( - create, - updateShouldNotify: updateShouldNotify, - ), - ) - .call(42); - }, - provider: (create) { - return AsyncNotifierProvider.autoDispose - .family, StateT, Object?>( - () => create() as FamilyAsyncNotifier, - ) - .call(42); - }, - value: (create, {name, dependencies}) => ([arg]) { - return AsyncNotifierProvider.autoDispose - .family, Object?, Object?>( - () => create(null, arg) as FamilyAsyncNotifier, - name: name, - dependencies: dependencies, - )(arg); - }, - ), - }, -); - -abstract class TestAsyncNotifier implements AsyncNotifierBase { - // Removing protected - @override - AsyncValue get state; - - @override - set state(AsyncValue value); -} - -class DeferredAsyncNotifier extends AsyncNotifier - implements TestAsyncNotifier { - DeferredAsyncNotifier( - this._create, { - bool Function(AsyncValue, AsyncValue)? updateShouldNotify, - }) : _updateShouldNotify = updateShouldNotify; - - final FutureOr Function(Ref> ref) _create; - final bool Function( - AsyncValue previousState, - AsyncValue newState, - )? _updateShouldNotify; - - @override - FutureOr build() => _create(ref); - - @override - bool updateShouldNotify( - AsyncValue previousState, - AsyncValue newState, - ) => - _updateShouldNotify?.call(previousState, newState) ?? - super.updateShouldNotify(previousState, newState); -} - -class DeferredFamilyAsyncNotifier - extends FamilyAsyncNotifier - implements TestAsyncNotifier { - DeferredFamilyAsyncNotifier( - this._create, { - bool Function(AsyncValue, AsyncValue)? updateShouldNotify, - }) : _updateShouldNotify = updateShouldNotify; - - final FutureOr Function(Ref> ref) _create; - - final bool Function( - AsyncValue previousState, - AsyncValue newState, - )? _updateShouldNotify; - - @override - FutureOr build(int arg) => _create(ref); - - @override - bool updateShouldNotify( - AsyncValue previousState, - AsyncValue newState, - ) => - _updateShouldNotify?.call(previousState, newState) ?? - super.updateShouldNotify(previousState, newState); -} - -class AsyncNotifierTestFactory extends TestFactory< - ProviderFactory, ProviderBase, void>> { - AsyncNotifierTestFactory({ - required super.value, - required this.deferredNotifier, - required this.deferredProvider, - required this.provider, - }); - - final TestAsyncNotifier Function( - FutureOr Function(Ref> ref) create, - ) deferredNotifier; - - final AsyncNotifierProviderBase, StateT> - Function( - FutureOr Function(Ref> ref) create, { - bool Function(AsyncValue, AsyncValue)? updateShouldNotify, - }) deferredProvider; - - final AsyncNotifierProviderBase, StateT> - Function( - AsyncNotifierBase Function() create, - ) provider; - - AsyncNotifierProviderBase, StateT> - simpleTestProvider( - FutureOr Function(Ref> ref) create, { - bool Function(AsyncValue, AsyncValue)? updateShouldNotify, - }) { - return deferredProvider( - (ref) => create(ref), - updateShouldNotify: updateShouldNotify, - ); - } -} diff --git a/packages/riverpod/test/new/matrix/async_notifier_provider.dart b/packages/riverpod/test/new/matrix/async_notifier_provider.dart new file mode 100644 index 000000000..7693dd14b --- /dev/null +++ b/packages/riverpod/test/new/matrix/async_notifier_provider.dart @@ -0,0 +1,204 @@ +part of '../matrix.dart'; + +final asyncNotifierProviderFactory = TestMatrix( + { + 'AsyncNotifierProvider': AsyncNotifierTestFactory( + deferredNotifier: DeferredAsyncNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return AsyncNotifierProvider, StateT>( + () => DeferredAsyncNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ); + }, + provider: (create) => + AsyncNotifierProvider, StateT>( + () => create() as AsyncNotifier, + ), + value: (create, {name, dependencies}) => ([arg]) { + return AsyncNotifierProvider, Object?>( + () => create(null, arg) as AsyncNotifier, + name: name, + dependencies: dependencies, + ); + }, + ), + 'AsyncNotifierProvider.autoDispose': AsyncNotifierTestFactory( + deferredNotifier: DeferredAsyncNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return AsyncNotifierProvider.autoDispose, + StateT>( + () => DeferredAsyncNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ); + }, + provider: (create) { + return AsyncNotifierProvider.autoDispose, StateT>( + () => create() as AsyncNotifier, + ); + }, + value: (create, {name, dependencies}) => ([arg]) { + return AsyncNotifierProvider.autoDispose, + Object?>( + () => create(null, arg) as AsyncNotifier, + name: name, + dependencies: dependencies, + ); + }, + ), + 'AsyncNotifierProvider.family': AsyncNotifierTestFactory( + deferredNotifier: DeferredFamilyAsyncNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return AsyncNotifierProvider.family, + StateT, Object?>( + () => DeferredFamilyAsyncNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ).call(42); + }, + provider: (create) { + return AsyncNotifierProvider.family< + FamilyAsyncNotifier, StateT, Object?>( + () => create() as FamilyAsyncNotifier, + ).call(42); + }, + value: (create, {name, dependencies}) => ([arg]) { + return AsyncNotifierProvider.family< + FamilyAsyncNotifier, Object?, Object?>( + () => create(null, arg) as FamilyAsyncNotifier, + name: name, + dependencies: dependencies, + )(arg); + }, + ), + 'AsyncNotifierProvider.autoDispose.family': AsyncNotifierTestFactory( + deferredNotifier: DeferredFamilyAsyncNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return AsyncNotifierProvider.family + .autoDispose, StateT, Object?>( + () => DeferredFamilyAsyncNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ) + .call(42); + }, + provider: (create) { + return AsyncNotifierProvider.autoDispose + .family, StateT, Object?>( + () => create() as FamilyAsyncNotifier, + ) + .call(42); + }, + value: (create, {name, dependencies}) => ([arg]) { + return AsyncNotifierProvider.autoDispose + .family, Object?, Object?>( + () => create(null, arg) as FamilyAsyncNotifier, + name: name, + dependencies: dependencies, + )(arg); + }, + ), + }, +); + +abstract class TestAsyncNotifier implements AsyncNotifierBase { + // Removing protected + @override + AsyncValue get state; + + @override + set state(AsyncValue value); +} + +class DeferredAsyncNotifier extends AsyncNotifier + implements TestAsyncNotifier { + DeferredAsyncNotifier( + this._create, { + bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + }) : _updateShouldNotify = updateShouldNotify; + + final FutureOr Function(Ref> ref) _create; + final bool Function( + AsyncValue previousState, + AsyncValue newState, + )? _updateShouldNotify; + + @override + FutureOr build() => _create(ref); + + @override + bool updateShouldNotify( + AsyncValue previousState, + AsyncValue newState, + ) => + _updateShouldNotify?.call(previousState, newState) ?? + super.updateShouldNotify(previousState, newState); +} + +class DeferredFamilyAsyncNotifier + extends FamilyAsyncNotifier + implements TestAsyncNotifier { + DeferredFamilyAsyncNotifier( + this._create, { + bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + }) : _updateShouldNotify = updateShouldNotify; + + final FutureOr Function(Ref> ref) _create; + + final bool Function( + AsyncValue previousState, + AsyncValue newState, + )? _updateShouldNotify; + + @override + FutureOr build(int arg) => _create(ref); + + @override + bool updateShouldNotify( + AsyncValue previousState, + AsyncValue newState, + ) => + _updateShouldNotify?.call(previousState, newState) ?? + super.updateShouldNotify(previousState, newState); +} + +class AsyncNotifierTestFactory extends TestFactory< + ProviderFactory, ProviderBase, void>> { + AsyncNotifierTestFactory({ + required super.value, + required this.deferredNotifier, + required this.deferredProvider, + required this.provider, + }); + + final TestAsyncNotifier Function( + FutureOr Function(Ref> ref) create, + ) deferredNotifier; + + final AsyncNotifierProviderBase, StateT> + Function( + FutureOr Function(Ref> ref) create, { + bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + }) deferredProvider; + + final AsyncNotifierProviderBase, StateT> + Function( + AsyncNotifierBase Function() create, + ) provider; + + AsyncNotifierProviderBase, StateT> + simpleTestProvider( + FutureOr Function(Ref> ref) create, { + bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + }) { + return deferredProvider( + (ref) => create(ref), + updateShouldNotify: updateShouldNotify, + ); + } +} diff --git a/packages/riverpod/test/new/matrix/stream_notifier_provider.dart b/packages/riverpod/test/new/matrix/stream_notifier_provider.dart new file mode 100644 index 000000000..d3b4f2c64 --- /dev/null +++ b/packages/riverpod/test/new/matrix/stream_notifier_provider.dart @@ -0,0 +1,206 @@ +part of '../matrix.dart'; + +final streamNotifierProviderFactory = TestMatrix( + { + 'StreamNotifierProvider': StreamNotifierTestFactory( + deferredNotifier: DeferredStreamNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return StreamNotifierProvider, StateT>( + () => DeferredStreamNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ); + }, + provider: (create) => + StreamNotifierProvider, StateT>( + () => create() as StreamNotifier, + ), + value: (create, {name, dependencies}) => ([arg]) { + return StreamNotifierProvider, Object?>( + () => create(null, arg) as StreamNotifier, + name: name, + dependencies: dependencies, + ); + }, + ), + 'StreamNotifierProvider.autoDispose': StreamNotifierTestFactory( + deferredNotifier: DeferredStreamNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return StreamNotifierProvider.autoDispose< + DeferredStreamNotifier, StateT>( + () => DeferredStreamNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ); + }, + provider: (create) { + return StreamNotifierProvider.autoDispose, + StateT>( + () => create() as StreamNotifier, + ); + }, + value: (create, {name, dependencies}) => ([arg]) { + return StreamNotifierProvider.autoDispose, + Object?>( + () => create(null, arg) as StreamNotifier, + name: name, + dependencies: dependencies, + ); + }, + ), + 'StreamNotifierProvider.family': StreamNotifierTestFactory( + deferredNotifier: DeferredFamilyStreamNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return StreamNotifierProvider.family< + DeferredFamilyStreamNotifier, StateT, Object?>( + () => DeferredFamilyStreamNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ).call(42); + }, + provider: (create) { + return StreamNotifierProvider.family< + FamilyStreamNotifier, StateT, Object?>( + () => create() as FamilyStreamNotifier, + ).call(42); + }, + value: (create, {name, dependencies}) => ([arg]) { + return StreamNotifierProvider.family< + FamilyStreamNotifier, Object?, Object?>( + () => create(null, arg) as FamilyStreamNotifier, + name: name, + dependencies: dependencies, + )(arg); + }, + ), + 'StreamNotifierProvider.autoDispose.family': StreamNotifierTestFactory( + deferredNotifier: DeferredFamilyStreamNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return StreamNotifierProvider.family + .autoDispose, StateT, Object?>( + () => DeferredFamilyStreamNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ) + .call(42); + }, + provider: (create) { + return StreamNotifierProvider.autoDispose + .family, StateT, Object?>( + () => create() as FamilyStreamNotifier, + ) + .call(42); + }, + value: (create, {name, dependencies}) => ([arg]) { + return StreamNotifierProvider.autoDispose + .family, Object?, Object?>( + () => create(null, arg) as FamilyStreamNotifier, + name: name, + dependencies: dependencies, + )(arg); + }, + ), + }, +); + +abstract class TestStreamNotifier + implements StreamNotifierBase { + // Removing protected + @override + AsyncValue get state; + + @override + set state(AsyncValue value); +} + +class DeferredStreamNotifier extends StreamNotifier + implements TestStreamNotifier { + DeferredStreamNotifier( + this._create, { + bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + }) : _updateShouldNotify = updateShouldNotify; + + final Stream Function(Ref> ref) _create; + final bool Function( + AsyncValue previousState, + AsyncValue newState, + )? _updateShouldNotify; + + @override + Stream build() => _create(ref); + + @override + bool updateShouldNotify( + AsyncValue previousState, + AsyncValue newState, + ) => + _updateShouldNotify?.call(previousState, newState) ?? + super.updateShouldNotify(previousState, newState); +} + +class DeferredFamilyStreamNotifier + extends FamilyStreamNotifier + implements TestStreamNotifier { + DeferredFamilyStreamNotifier( + this._create, { + bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + }) : _updateShouldNotify = updateShouldNotify; + + final Stream Function(Ref> ref) _create; + + final bool Function( + AsyncValue previousState, + AsyncValue newState, + )? _updateShouldNotify; + + @override + Stream build(int arg) => _create(ref); + + @override + bool updateShouldNotify( + AsyncValue previousState, + AsyncValue newState, + ) => + _updateShouldNotify?.call(previousState, newState) ?? + super.updateShouldNotify(previousState, newState); +} + +class StreamNotifierTestFactory extends TestFactory< + ProviderFactory, ProviderBase, void>> { + StreamNotifierTestFactory({ + required super.value, + required this.deferredNotifier, + required this.deferredProvider, + required this.provider, + }); + + final TestStreamNotifier Function( + Stream Function(Ref> ref) create, + ) deferredNotifier; + + final StreamNotifierProviderBase, StateT> + Function( + Stream Function(Ref> ref) create, { + bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + }) deferredProvider; + + final StreamNotifierProviderBase, StateT> + Function( + StreamNotifierBase Function() create, + ) provider; + + StreamNotifierProviderBase, StateT> + simpleTestProvider( + Stream Function(Ref> ref) create, { + bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + }) { + return deferredProvider( + (ref) => create(ref), + updateShouldNotify: updateShouldNotify, + ); + } +} diff --git a/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart b/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart deleted file mode 100644 index 617242152..000000000 --- a/packages/riverpod/test/old/legacy_providers/stream_notifier/async_notifier_test.dart +++ /dev/null @@ -1,1171 +0,0 @@ -// ignore_for_file: avoid_types_on_closure_parameters - -import 'dart:async'; - -import 'package:meta/meta.dart'; -import 'package:mockito/mockito.dart'; -import 'package:riverpod/legacy.dart'; -import 'package:riverpod/riverpod.dart'; -import 'package:test/test.dart'; - -import '../../utils.dart'; -import 'factory.dart'; - -void main() { - test('Throws if using notifier properties in its constructor', () { - expect( - CtorNotifier.new, - throwsA(isA()), - ); - expect( - AutoDisposeCtorNotifier.new, - throwsA(isA()), - ); - expect( - AutoDisposeFamilyCtorNotifier.new, - throwsA(isA()), - ); - expect( - FamilyCtorNotifier.new, - throwsA(isA()), - ); - }); - - for (final factory in matrix()) { - group(factory.label, () { - test('Cannot share a Notifier instance between providers ', () { - final container = ProviderContainer.test(); - final notifier = factory.notifier((ref) => Stream.value(0)); - - final provider = factory.provider, int>( - () => notifier, - ); - final provider2 = factory.provider, int>( - () => notifier, - ); - - container.read(provider); - - expect( - container.read(provider2), - isA>(), - ); - }); - - test('Can read state inside onDispose', () { - final container = ProviderContainer.test(); - late StreamTestNotifierBase notifier; - final provider = factory.simpleTestProvider((ref) { - ref.onDispose(() { - notifier.state; - }); - return Stream.value(0); - }); - - container.listen(provider.notifier, (prev, next) {}); - notifier = container.read(provider.notifier); - - container.dispose(); - }); - - test('Using the notifier after dispose throws', () { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider((ref) => Stream.value(0)); - - container.listen(provider.notifier, (prev, next) {}); - final notifier = container.read(provider.notifier); - - container.dispose(); - - expect(() => notifier.state, throwsStateError); - expect(() => notifier.future, throwsStateError); - expect(() => notifier.state = const AsyncData(42), throwsStateError); - // ignore: invalid_use_of_protected_member - expect(() => notifier.ref, throwsStateError); - expect(() => notifier.update((p1) => 42), throwsStateError); - }); - - group('supports AsyncValue transition', () { - test( - 'performs seamless copyWithPrevious if triggered by ref.invalidate/ref.refresh', - () async { - final container = ProviderContainer.test(); - var count = 0; - final provider = factory.simpleTestProvider( - (ref) => Stream.value(count++), - ); - - container.listen(provider, (previous, next) {}); - - await expectLater(container.read(provider.future), completion(0)); - expect(container.read(provider), const AsyncData(0)); - - expect( - container.refresh(provider), - const AsyncLoading().copyWithPrevious(const AsyncData(0)), - ); - - await expectLater(container.read(provider.future), completion(1)); - expect(container.read(provider), const AsyncData(1)); - - container.invalidate(provider); - - expect( - container.read(provider), - const AsyncLoading().copyWithPrevious(const AsyncData(1)), - ); - await expectLater(container.read(provider.future), completion(2)); - expect(container.read(provider), const AsyncData(2)); - }); - - test( - 'performs seamless:false copyWithPrevious on `state = AsyncLoading()`', - () async { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider((ref) => Stream.value(0)); - - final sub = container.listen(provider.notifier, (previous, next) {}); - - await expectLater(container.read(provider.future), completion(0)); - expect(container.read(provider), const AsyncData(0)); - - sub.read().state = const AsyncLoading(); - - expect( - sub.read().state, - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ); - }); - - test( - 'performs seamless:false copyWithPrevious if triggered by a dependency change', - () async { - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) => Stream.value(ref.watch(dep)), - ); - - container.listen(provider, (previous, next) {}); - - await expectLater(container.read(provider.future), completion(0)); - expect(container.read(provider), const AsyncData(0)); - - container.read(dep.notifier).state++; - expect( - container.read(provider), - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ); - - await expectLater(container.read(provider.future), completion(1)); - expect(container.read(provider), const AsyncData(1)); - }); - - test( - 'performs seamless:false copyWithPrevious if both triggered by a dependency change and ref.refresh', - () async { - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) => Stream.value(ref.watch(dep)), - ); - - container.listen(provider, (previous, next) {}); - - await expectLater(container.read(provider.future), completion(0)); - expect(container.read(provider), const AsyncData(0)); - - container.read(dep.notifier).state++; - expect( - container.refresh(provider), - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ); - - await expectLater(container.read(provider.future), completion(1)); - expect(container.read(provider), const AsyncData(1)); - }); - }); - - test('does not notify listeners when refreshed during loading', () async { - final provider = factory.simpleTestProvider((ref) => Stream.value(0)); - final container = ProviderContainer.test(); - final listener = Listener>(); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(listener, listener(null, const AsyncLoading())); - - container.refresh(provider); - - await container.read(provider.future); - - verifyOnly( - listener, - listener(const AsyncLoading(), const AsyncData(0)), - ); - }); - - test('supports listenSelf', () { - final listener = Listener>(); - final onError = ErrorListener(); - final provider = factory.simpleTestProvider((ref) { - ref.listenSelf(listener.call, onError: onError.call); - Error.throwWithStackTrace(42, StackTrace.empty); - }); - final container = ProviderContainer.test(); - - container.listen(provider, (previous, next) {}); - - verifyOnly( - listener, - listener(null, const AsyncError(42, StackTrace.empty)), - ); - verifyZeroInteractions(onError); - - container.read(provider.notifier).state = const AsyncData(42); - - verifyNoMoreInteractions(onError); - verifyOnly( - listener, - listener( - const AsyncError(42, StackTrace.empty), - const AsyncData(42), - ), - ); - }); - - test( - 'converts StreamNotifier.build into an AsyncData if the future completes', - () async { - final provider = factory.simpleTestProvider((ref) => Stream.value(0)); - final container = ProviderContainer.test(); - final listener = Listener>(); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(listener, listener(null, const AsyncLoading())); - expect( - container.read(provider.notifier).state, - const AsyncLoading(), - ); - - expect(await container.read(provider.future), 0); - - verifyOnly( - listener, - listener(const AsyncLoading(), const AsyncData(0)), - ); - expect( - container.read(provider.notifier).state, - const AsyncData(0), - ); - }); - - test( - 'converts StreamNotifier.build into an AsyncError if the future fails', - () async { - final provider = factory.simpleTestProvider( - (ref) => Stream.error(0, StackTrace.empty), - ); - final container = ProviderContainer.test(); - final listener = Listener>(); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(listener, listener(null, const AsyncLoading())); - expect( - container.read(provider.notifier).state, - const AsyncLoading(), - ); - - await expectLater(container.read(provider.future), throwsA(0)); - - verifyOnly( - listener, - listener(const AsyncLoading(), const AsyncError(0, StackTrace.empty)), - ); - expect( - container.read(provider.notifier).state, - const AsyncError(0, StackTrace.empty), - ); - }); - - test('supports cases where the StreamNotifier constructor throws', - () async { - final provider = factory.testProvider( - () => Error.throwWithStackTrace(0, StackTrace.empty), - ); - final container = ProviderContainer.test(); - final listener = Listener>(); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly( - listener, - listener(null, const AsyncError(0, StackTrace.empty)), - ); - expect( - () => container.read(provider.notifier), - throwsA(0), - ); - - await expectLater(container.read(provider.future), throwsA(0)); - }); - - test( - 'synchronously emits AsyncError if StreamNotifier.build throws synchronously', - () async { - final provider = factory.simpleTestProvider( - (ref) => Error.throwWithStackTrace(42, StackTrace.empty), - ); - final container = ProviderContainer.test(); - final listener = Listener>(); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly( - listener, - listener(null, const AsyncError(42, StackTrace.empty)), - ); - expect( - container.read(provider.notifier).state, - const AsyncError(42, StackTrace.empty), - ); - await expectLater(container.read(provider.future), throwsA(42)); - }); - - test( - 'stops listening to the previous future data when the provider rebuilds', - () async { - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - final completers = { - 0: Completer.sync(), - 1: Completer.sync(), - }; - final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completers[ref.watch(dep)]!.future), - ); - final listener = Listener>(); - - container.listen(provider, listener.call); - - expect( - container.read(provider.future), - completion(21), - reason: 'The provider rebuilt while the future was still pending, ' - 'so .future should resolve with the next value', - ); - verifyZeroInteractions(listener); - expect(container.read(provider), const AsyncLoading()); - - container.read(dep.notifier).state++; - completers[0]!.complete(42); - - verifyZeroInteractions(listener); - - expect(container.read(provider.future), completion(21)); - expect(container.read(provider), const AsyncLoading()); - - completers[1]!.complete(21); - - expect(await container.read(provider.future), 21); - expect(container.read(provider), const AsyncData(21)); - }); - - test( - 'stops listening to the previous future error when the provider rebuilds', - () async { - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - final completers = { - 0: Completer.sync(), - 1: Completer.sync(), - }; - final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completers[ref.watch(dep)]!.future), - ); - final listener = Listener>(); - - container.listen(provider, listener.call); - - expect( - container.read(provider.future), - throwsA(21), - reason: 'The provider rebuilt while the future was still pending, ' - 'so .future should resolve with the next value', - ); - verifyZeroInteractions(listener); - expect(container.read(provider), const AsyncLoading()); - - container.read(dep.notifier).state++; - completers[0]!.completeError(42, StackTrace.empty); - - verifyZeroInteractions(listener); - - expect(container.read(provider.future), throwsA(21)); - expect(container.read(provider), const AsyncLoading()); - - completers[1]!.completeError(21, StackTrace.empty); - - await expectLater(container.read(provider.future), throwsA(21)); - expect( - container.read(provider), - const AsyncError(21, StackTrace.empty), - ); - }); - - group('StreamNotifier.state', () { - test( - 'when manually modifying the state, the new exposed value contains the previous state when possible', - () async { - final provider = factory.simpleTestProvider( - (ref) => Stream.value(0), - ); - final container = ProviderContainer.test(); - - final sub = container.listen(provider.notifier, (previous, next) {}); - await container.read(provider.future); - - // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` - final newState = AsyncData(84); - // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` - final newLoading = AsyncLoading(); - // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` - final newError = AsyncError(84, StackTrace.empty); - - sub.read().state = newState; - - expect(sub.read().state, same(newState)); - - sub.read().state = newLoading; - - expect( - sub.read().state, - const AsyncLoading() - .copyWithPrevious(newState, isRefresh: false), - ); - - sub.read().state = newError; - - expect( - sub.read().state, - newError.copyWithPrevious( - const AsyncLoading() - .copyWithPrevious(newState, isRefresh: false), - ), - ); - }); - - test( - 'when read on outdated provider, refreshes the provider and return the up-to-date state', - () async { - final listener = OnBuildMock(); - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) { - listener(); - return Stream.value(ref.watch(dep)); - }, - ); - final container = ProviderContainer.test(); - - container.listen(provider, (previous, next) {}); - final notifier = container.read(provider.notifier); - - expect(notifier.state, const AsyncLoading()); - expect(await container.read(provider.future), 0); - expect(notifier.state, const AsyncData(0)); - verify(listener()).called(1); - - container.read(dep.notifier).state++; - - expect( - notifier.state, - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ); - expect(await container.read(provider.future), 1); - expect(notifier.state, const AsyncData(1)); - verify(listener()).called(1); - }); - - test('can be read inside build', () { - final dep = StateProvider((ref) => 0); - late AsyncValue state; - final provider = factory.testProvider( - () { - late StreamTestNotifierBase notifier; - return notifier = factory.notifier( - (ref) { - state = notifier.state; - return Stream.value(ref.watch(dep)); - }, - ); - }, - ); - final container = ProviderContainer.test(); - - container.listen(provider, (previous, next) {}); - - expect(state, const AsyncLoading()); - - container.read(provider.notifier).state = const AsyncData(42); - container.refresh(provider); - - expect( - state, - const AsyncLoading().copyWithPrevious(const AsyncData(42)), - ); - }); - - test('notifies listeners when the setter is called', () async { - final provider = factory.simpleTestProvider((ref) => Stream.value(0)); - final container = ProviderContainer.test(); - final listener = Listener>(); - - // Skip the loading - await container.listen(provider.future, (previous, next) {}).read(); - - container.listen(provider, listener.call); - - verifyZeroInteractions(listener); - - container.read(provider.notifier).state = const AsyncData(42); - - verifyOnly( - listener, - listener(const AsyncData(0), const AsyncData(42)), - ); - }); - }); - - group('StreamNotifier.future', () { - test( - 'when disposed during loading, resolves with the content of StreamNotifier.build', - () async { - final container = ProviderContainer.test(); - final completer = Completer.sync(); - final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completer.future), - ); - - final future = container.read(provider.future); - container.dispose(); - - completer.complete(42); - - await expectLater(future, completion(42)); - }); - - test( - 'when disposed during loading, resolves with the error of StreamNotifier.build', - () async { - final container = ProviderContainer.test(); - final completer = Completer.sync(); - final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completer.future), - ); - - final future = container.read(provider.future); - - container.dispose(); - - completer.completeError(42); - - await expectLater(future, throwsA(42)); - }); - - test( - 'going data > loading while the future is still pending. ' - 'Resolves with last future result', - () async { - final container = ProviderContainer.test(); - final completer = Completer.sync(); - final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completer.future), - ); - - container.read(provider); - container.read(provider.notifier).state = const AsyncData(42); - container.read(provider.notifier).state = const AsyncLoading(); - - final future = container.read(provider.future); - - container.dispose(); - - completer.complete(42); - - await expectLater(future, completion(42)); - }, - ); - - test( - 'if going back to loading after future resolved, throws StateError', - () async { - final container = ProviderContainer.test(); - final completer = Completer.sync(); - final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completer.future), - ); - - container.read(provider); - - completer.complete(42); - - container.read(provider.notifier).state = const AsyncData(42); - container.read(provider.notifier).state = const AsyncLoading(); - - final future = container.read(provider.future); - - container.dispose(); - - await expectLater(future, throwsStateError); - }, - ); - - test( - 'resolves with the new state if StreamNotifier.state is modified during loading', - () async { - final container = ProviderContainer.test(); - final completer = Completer.sync(); - final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completer.future), - ); - final listener = Listener>(); - - final sub = container.listen(provider.notifier, (previous, next) {}); - container.listen(provider.future, listener.call); - - expect(sub.read().future, completion(21)); - - sub.read().state = const AsyncData(21); - - completer.complete(42); - - expect(sub.read().future, completion(42)); - final capture = - verifyOnly(listener, listener(captureAny, captureAny)).captured; - - expect(capture.length, 2); - expect(capture.first, completion(21)); - expect(capture.last, completion(42)); - }); - - test('resolves with the new state when notifier.state is changed', - () async { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider( - (ref) => Stream.value(0), - ); - final listener = Listener>(); - - final sub = container.listen(provider.notifier, (previous, next) {}); - container.listen( - provider.future, - listener.call, - fireImmediately: true, - ); - - await expectLater(sub.read().future, completion(0)); - verifyOnly( - listener, - listener(argThat(equals(null)), argThat(completion(0))), - ); - - sub.read().state = const AsyncData(1); - - await expectLater(sub.read().future, completion(1)); - }); - - test('returns a Future identical to that of .future', () { - final listener = OnBuildMock(); - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) { - listener(); - return Stream.value(ref.watch(dep)); - }, - ); - final container = ProviderContainer.test(); - - container.listen(provider.notifier, (previous, next) {}); - final notifier = container.read(provider.notifier); - - expect(notifier.future, same(container.read(provider.future))); - }); - - test( - 'when read on outdated provider, refreshes the provider and return the up-to-date state', - () async { - final listener = OnBuildMock(); - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) { - listener(); - return Stream.value(ref.watch(dep)); - }, - ); - final container = ProviderContainer.test(); - - container.listen(provider, (previous, next) {}); - final notifier = container.read(provider.notifier); - - expect(await container.read(provider.future), 0); - verify(listener()).called(1); - - container.read(dep.notifier).state++; - - expect(notifier.future, notifier.future); - expect(notifier.future, same(container.read(provider.future))); - expect(await notifier.future, 1); - verify(listener()).called(1); - }); - }); - - group('StreamNotifierProvider.notifier', () { - test( - 'never emits an update. The Notifier is never recreated once it is instantiated', - () async { - final listener = OnBuildMock(); - final dep = StateProvider((ref) => 0); - final provider = factory.testProvider(() { - listener(); - return factory.notifier( - (ref) => Stream.value(ref.watch(dep)), - ); - }); - final container = ProviderContainer.test(); - - // Skip the loading - await container.listen(provider.future, (previous, next) {}).read(); - - container.listen(provider, (previous, next) {}); - final notifier = container.read(provider.notifier); - - verify(listener()).called(1); - expect(container.read(provider), const AsyncData(0)); - - container.read(dep.notifier).state++; - await container.read(provider.future); - - expect(container.read(provider), const AsyncData(1)); - expect(container.read(provider.notifier), same(notifier)); - verifyNoMoreInteractions(listener); - }); - }); - - test( - 'Can override StreamNotifier.updateShouldNotify to change the default filter logic', - () async { - final provider = factory.simpleTestProvider>( - (ref) => Stream.value(Equal(42)), - updateShouldNotify: (a, b) => a != b, - ); - final container = ProviderContainer.test(); - final listener = Listener>>(); - - // Skip the loading - await container.listen(provider.future, (previous, next) {}).read(); - - container.listen(provider, listener.call); - final notifier = container.read(provider.notifier); - - // voluntarily assigning the same value - final self = notifier.state; - notifier.state = self; - - verifyZeroInteractions(listener); - - notifier.state = AsyncData(Equal(42)); - - verifyZeroInteractions(listener); - - notifier.state = AsyncData(Equal(21)); - - verifyOnly( - listener, - listener(AsyncData(Equal(42)), AsyncData(Equal(21))), - ); - }); - - group('AsyncNotifier.update', () { - test('passes in the latest state', () async { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider( - (ref) => Stream.value(0), - ); - - // Skip the loading - await container.listen(provider.future, (previous, next) {}).read(); - - final sub = container.listen(provider.notifier, (prev, next) {}); - - expect( - container.read(provider), - const AsyncData(0), - ); - - await expectLater( - sub.read().update((prev) => prev + 1), - completion(1), - ); - await expectLater( - sub.read().future, - completion(1), - ); - await expectLater( - sub.read().update((prev) => prev + 1), - completion(2), - ); - }); - - test('can specify onError to handle error scenario', () async { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider( - (ref) => Error.throwWithStackTrace(42, StackTrace.empty), - ); - var callCount = 0; - Object? actualErr; - Object? actualStack; - - final sub = container.listen(provider.notifier, (prev, next) {}); - - expect( - container.read(provider), - const AsyncError(42, StackTrace.empty), - ); - - await expectLater( - sub.read().update( - (prev) { - callCount++; - return prev; - }, - onError: (err, stack) { - actualErr = err; - actualStack = stack; - return 21; - }, - ), - completion(21), - ); - expect(callCount, 0); - expect(actualErr, 42); - expect(actualStack, StackTrace.empty); - expect(container.read(provider), const AsyncData(21)); - }); - - test('executes immediately with current state if a state is available', - () async { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider( - (ref) => Stream.value(1), - ); - - // Skip the loading - await container.listen(provider.future, (previous, next) {}).read(); - - final sub = container.listen(provider.notifier, (prev, next) {}); - - expect(container.read(provider), const AsyncData(1)); - - await expectLater( - sub.read().update((prev) => prev + 1), - completion(2), - ); - expect(container.read(provider), const AsyncData(2)); - }); - - test('executes immediately with current state if an error is available', - () async { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider( - (ref) => Error.throwWithStackTrace(42, StackTrace.empty), - ); - var callCount = 0; - - final sub = container.listen(provider.notifier, (prev, next) {}); - - expect( - container.read(provider), - const AsyncError(42, StackTrace.empty), - ); - - await expectLater( - sub.read().update((prev) { - callCount++; - return prev + 1; - }), - throwsA(42), - ); - - expect(callCount, 0); - expect( - container.read(provider), - const AsyncError(42, StackTrace.empty), - ); - }); - - test('awaits the future resolution if in loading state', () async { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider( - (ref) => Stream.value(42), - ); - - final sub = container.listen(provider.notifier, (prev, next) {}); - - expect(container.read(provider), const AsyncLoading()); - - await expectLater( - sub.read().update((prev) => prev + 1), - completion(43), - ); - expect(container.read(provider), const AsyncData(43)); - }); - }); - }); - } - - test('supports overrideWith', () async { - final provider = StreamNotifierProvider, int>( - () => StreamTestNotifier((ref) => Stream.value(0)), - ); - final autoDispose = StreamNotifierProvider.autoDispose< - AutoDisposeStreamTestNotifier, int>( - () => AutoDisposeStreamTestNotifier((ref) => Stream.value(0)), - ); - final container = ProviderContainer.test( - overrides: [ - provider.overrideWith( - () => StreamTestNotifier((ref) => Stream.value(42)), - ), - autoDispose.overrideWith( - () => AutoDisposeStreamTestNotifier((ref) => Stream.value(84)), - ), - ], - ); - - // Skip the loading - await container.listen(provider.future, (previous, next) {}).read(); - await container.listen(autoDispose.future, (previous, next) {}).read(); - - expect(container.read(provider).value, 42); - expect(container.read(autoDispose).value, 84); - }); - - test('supports family overrideWith', () async { - final family = - StreamNotifierProvider.family, int, int>( - () => StreamTestNotifierFamily((ref) => Stream.value(0)), - ); - final autoDisposeFamily = StreamNotifierProvider.autoDispose - .family, int, int>( - () => AutoDisposeStreamTestNotifierFamily((ref) => Stream.value(0)), - ); - final container = ProviderContainer.test( - overrides: [ - family.overrideWith( - () => StreamTestNotifierFamily((ref) => Stream.value(42)), - ), - autoDisposeFamily.overrideWith( - () => AutoDisposeStreamTestNotifierFamily( - (ref) => Stream.value(84), - ), - ), - ], - ); - - // Skip the loading - await container.listen(family(10).future, (previous, next) {}).read(); - await container - .listen(autoDisposeFamily(10).future, (previous, next) {}) - .read(); - - expect(container.read(family(10)).value, 42); - expect(container.read(autoDisposeFamily(10)).value, 84); - }); - - group('AutoDispose variant', () { - test('can watch autoDispose providers', () async { - final dep = Provider.autoDispose((ref) => 0); - final provider = AutoDisposeStreamNotifierProvider< - AutoDisposeStreamTestNotifier, int>( - () => AutoDisposeStreamTestNotifier((ref) { - return Stream.value(ref.watch(dep)); - }), - ); - final container = ProviderContainer.test(); - - // Skip the loading - await container.listen(provider.future, (previous, next) {}).read(); - - expect(container.read(provider), const AsyncData(0)); - }); - }); - - group('modifiers', () { - void canBeAssignedToRefreshable( - Refreshable provider, - ) {} - - void canBeAssignedToProviderListenable( - ProviderListenable provider, - ) {} - - test('provider', () { - final provider = StreamNotifierProvider, int>( - () => StreamTestNotifier((ref) => Stream.value(0)), - ); - - provider.select((AsyncValue value) => 0); - provider.selectAsync((int value) => 0); - - canBeAssignedToProviderListenable>(provider); - canBeAssignedToRefreshable>(provider); - - canBeAssignedToProviderListenable>(provider.future); - canBeAssignedToRefreshable>(provider.future); - - canBeAssignedToProviderListenable>(provider.notifier); - canBeAssignedToRefreshable>(provider.notifier); - }); - - test('autoDispose', () { - final autoDispose = StreamNotifierProvider.autoDispose< - AutoDisposeStreamTestNotifier, int>( - () => AutoDisposeStreamTestNotifier((ref) => Stream.value(0)), - ); - - autoDispose.select((AsyncValue value) => 0); - autoDispose.selectAsync((int value) => 0); - - canBeAssignedToProviderListenable>(autoDispose); - canBeAssignedToRefreshable>(autoDispose); - - canBeAssignedToProviderListenable>(autoDispose.future); - canBeAssignedToRefreshable>(autoDispose.future); - - canBeAssignedToProviderListenable>( - autoDispose.notifier, - ); - canBeAssignedToRefreshable>( - autoDispose.notifier, - ); - }); - - test('family', () { - final family = StreamNotifierProvider.family< - StreamTestNotifierFamily, String, int>( - () => StreamTestNotifierFamily((ref) => Stream.value('0')), - ); - - family(0).select((AsyncValue value) => 0); - family(0).selectAsync((String value) => 0); - - canBeAssignedToProviderListenable>(family(0)); - canBeAssignedToRefreshable>(family(0)); - - canBeAssignedToProviderListenable>(family(0).future); - canBeAssignedToRefreshable>(family(0).future); - - canBeAssignedToProviderListenable>( - family(0).notifier, - ); - canBeAssignedToRefreshable>( - family(0).notifier, - ); - }); - - test('autoDisposeFamily', () { - expect( - StreamNotifierProvider.autoDispose.family, - same(StreamNotifierProvider.family.autoDispose), - ); - - final autoDisposeFamily = StreamNotifierProvider.autoDispose - .family, String, int>( - () => AutoDisposeStreamTestNotifierFamily((ref) => Stream.value('0')), - ); - - autoDisposeFamily(0).select((AsyncValue value) => 0); - autoDisposeFamily(0).selectAsync((String value) => 0); - - canBeAssignedToProviderListenable>( - autoDisposeFamily(0), - ); - canBeAssignedToRefreshable>( - autoDisposeFamily(0), - ); - - canBeAssignedToProviderListenable>( - autoDisposeFamily(0).future, - ); - canBeAssignedToRefreshable>( - autoDisposeFamily(0).future, - ); - - canBeAssignedToProviderListenable< - AutoDisposeFamilyStreamNotifier>( - autoDisposeFamily(0).notifier, - ); - canBeAssignedToRefreshable>( - autoDisposeFamily(0).notifier, - ); - }); - }); -} - -@immutable -class Equal { - // ignore: prefer_const_constructors_in_immutables - Equal(this.value); - - final T value; - - @override - bool operator ==(Object other) => other is Equal && other.value == value; - - @override - int get hashCode => Object.hash(runtimeType, value); -} - -class CtorNotifier extends StreamNotifier { - CtorNotifier() { - state; - } - - @override - Stream build() => Stream.value(0); -} - -class AutoDisposeCtorNotifier extends AutoDisposeStreamNotifier { - AutoDisposeCtorNotifier() { - state; - } - - @override - Stream build() => Stream.value(0); -} - -class AutoDisposeFamilyCtorNotifier - extends AutoDisposeFamilyStreamNotifier { - AutoDisposeFamilyCtorNotifier() { - state; - } - - @override - Stream build(int arg) => Stream.value(0); -} - -class FamilyCtorNotifier extends FamilyStreamNotifier { - FamilyCtorNotifier() { - state; - } - - @override - Stream build(int arg) => Stream.value(0); -} diff --git a/packages/riverpod/test/old/legacy_providers/stream_notifier/factory.dart b/packages/riverpod/test/old/legacy_providers/stream_notifier/factory.dart deleted file mode 100644 index a4df4ebaa..000000000 --- a/packages/riverpod/test/old/legacy_providers/stream_notifier/factory.dart +++ /dev/null @@ -1,314 +0,0 @@ -import 'dart:async'; - -import 'package:riverpod/src/internals.dart'; - -typedef StreamNotifierProviderFactoryType - = StreamNotifierProviderBase - Function, T>( - NotifierT Function() create, { - String? name, -}); - -typedef StreamNotifierFactoryType = StreamTestNotifierBase Function( - Stream Function(StreamNotifierProviderRef), { - bool Function(AsyncValue, AsyncValue)? updateShouldNotify, -}); - -typedef SimpleTestProviderFactoryType - = StreamNotifierProviderBase, T> Function( - Stream Function(StreamNotifierProviderRef ref) init, { - bool Function(AsyncValue prev, AsyncValue next)? updateShouldNotify, -}); - -typedef TestProviderFactoryType - = StreamNotifierProviderBase, T> Function( - StreamTestNotifierBase Function() createNotifier, -); - -List matrix({ - bool alwaysAlive = true, - bool autoDispose = true, -}) { - return [ - if (alwaysAlive) - StreamNotifierFactory( - label: 'StreamNotifierProvider', - isAutoDispose: false, - provider: StreamNotifierProviderImpl.new, - notifier: StreamTestNotifier.new, - testProvider: (createNotifier) { - return StreamNotifierProviderImpl, T>( - createNotifier, - ); - }, - simpleTestProvider: (init, {updateShouldNotify}) { - return StreamNotifierProvider, T>( - () => StreamTestNotifier( - init, - updateShouldNotify: updateShouldNotify, - ), - ); - }, - ), - if (alwaysAlive) - StreamNotifierFactory( - label: 'StreamNotifierProviderFamily', - isAutoDispose: false, - provider: , T>( - create, { - argument, - dependencies, - from, - name, - }) { - return FamilyStreamNotifierProviderImpl.internal( - create, - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - notifier: StreamTestNotifierFamily.new, - testProvider: (createNotifier) { - return FamilyStreamNotifierProviderImpl, - T, int>.internal( - () => createNotifier() as StreamTestNotifierFamily, - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - simpleTestProvider: (init, {updateShouldNotify}) { - return FamilyStreamNotifierProviderImpl, - T, int>.internal( - () => StreamTestNotifierFamily( - init, - updateShouldNotify: updateShouldNotify, - ), - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - ), - if (autoDispose) - StreamNotifierFactory( - label: 'AutoDisposeStreamNotifierProvider', - isAutoDispose: true, - provider: AutoDisposeStreamNotifierProviderImpl.new, - notifier: AutoDisposeStreamTestNotifier.new, - testProvider: (createNotifier) { - return AutoDisposeStreamNotifierProviderImpl< - AutoDisposeStreamTestNotifier, T>( - () => createNotifier() as AutoDisposeStreamTestNotifier, - ); - }, - simpleTestProvider: (init, {updateShouldNotify}) { - return AutoDisposeStreamNotifierProvider< - AutoDisposeStreamTestNotifier, T>( - () => AutoDisposeStreamTestNotifier( - init, - updateShouldNotify: updateShouldNotify, - ), - ); - }, - ), - if (autoDispose) - StreamNotifierFactory( - label: 'AutoDisposeStreamNotifierProviderFamily', - isAutoDispose: true, - provider: , T>( - create, { - argument, - dependencies, - from, - name, - }) { - return AutoDisposeFamilyStreamNotifierProviderImpl.internal( - create, - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - notifier: AutoDisposeStreamTestNotifierFamily.new, - testProvider: (createNotifier) { - return AutoDisposeFamilyStreamNotifierProviderImpl< - AutoDisposeStreamTestNotifierFamily, T, int>.internal( - () => createNotifier() as AutoDisposeStreamTestNotifierFamily, - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - simpleTestProvider: (init, {updateShouldNotify}) { - return AutoDisposeFamilyStreamNotifierProviderImpl< - AutoDisposeStreamTestNotifierFamily, T, int>.internal( - () => AutoDisposeStreamTestNotifierFamily( - init, - updateShouldNotify: updateShouldNotify, - ), - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - ), - ]; -} - -class StreamNotifierFactory { - const StreamNotifierFactory({ - required this.label, - required this.provider, - required this.notifier, - required this.isAutoDispose, - required this.testProvider, - required this.simpleTestProvider, - }); - - final String label; - final bool isAutoDispose; - final StreamNotifierProviderFactoryType provider; - final StreamNotifierFactoryType notifier; - final TestProviderFactoryType testProvider; - final SimpleTestProviderFactoryType simpleTestProvider; -} - -abstract class StreamTestNotifierBase extends _AsyncNotifierBase { - // overriding to remove the @protected - @override - AsyncValue get state; - - @override - set state(AsyncValue value); - - // overriding to remove the @protected - @override - Future update( - FutureOr Function(T p1) cb, { - FutureOr Function(Object err, StackTrace stackTrace)? onError, - }); -} - -class StreamTestNotifier extends StreamNotifier - implements StreamTestNotifierBase { - StreamTestNotifier( - this._init, { - bool Function(AsyncValue prev, AsyncValue next)? updateShouldNotify, - }) : _updateShouldNotify = updateShouldNotify; - - final Stream Function(StreamNotifierProviderRef ref) _init; - - final bool Function(AsyncValue prev, AsyncValue next)? - _updateShouldNotify; - - @override - Stream build() => _init(ref); - - @override - bool updateShouldNotify(AsyncValue prev, AsyncValue next) { - return _updateShouldNotify?.call(prev, next) ?? - super.updateShouldNotify(prev, next); - } - - @override - String toString() { - return 'StreamTestNotifier<$T>#$hashCode'; - } -} - -class StreamTestNotifierFamily extends FamilyStreamNotifier - implements StreamTestNotifierBase { - StreamTestNotifierFamily( - this._init, { - bool Function(AsyncValue prev, AsyncValue next)? updateShouldNotify, - }) : _updateShouldNotify = updateShouldNotify; - - final Stream Function(StreamNotifierProviderRef ref) _init; - - final bool Function(AsyncValue prev, AsyncValue next)? - _updateShouldNotify; - - @override - Stream build(int arg) => _init(ref); - - @override - bool updateShouldNotify(AsyncValue prev, AsyncValue next) { - return _updateShouldNotify?.call(prev, next) ?? - super.updateShouldNotify(prev, next); - } - - @override - String toString() { - return 'StreamTestNotifierFamily<$T>#$hashCode'; - } -} - -class AutoDisposeStreamTestNotifier extends AutoDisposeStreamNotifier - implements StreamTestNotifierBase { - AutoDisposeStreamTestNotifier( - this._init2, { - bool Function(AsyncValue prev, AsyncValue next)? updateShouldNotify, - }) : _updateShouldNotify = updateShouldNotify; - - final Stream Function(AutoDisposeStreamNotifierProviderRef ref) _init2; - - final bool Function(AsyncValue prev, AsyncValue next)? - _updateShouldNotify; - - @override - Stream build() => _init2(ref); - - @override - bool updateShouldNotify(AsyncValue prev, AsyncValue next) { - return _updateShouldNotify?.call(prev, next) ?? - super.updateShouldNotify(prev, next); - } - - @override - String toString() { - return 'AutoDisposeStreamTestNotifier<$T>#$hashCode'; - } -} - -class AutoDisposeStreamTestNotifierFamily - extends AutoDisposeFamilyStreamNotifier - implements StreamTestNotifierBase { - AutoDisposeStreamTestNotifierFamily( - this._init2, { - bool Function(AsyncValue prev, AsyncValue next)? updateShouldNotify, - }) : _updateShouldNotify = updateShouldNotify; - - final Stream Function(AutoDisposeStreamNotifierProviderRef ref) _init2; - - final bool Function(AsyncValue prev, AsyncValue next)? - _updateShouldNotify; - - @override - Stream build(int arg) => _init2(ref); - - @override - bool updateShouldNotify(AsyncValue prev, AsyncValue next) { - return _updateShouldNotify?.call(prev, next) ?? - super.updateShouldNotify(prev, next); - } - - @override - String toString() { - return 'AutoDisposeStreamTestNotifierFamily<$T, int>#$hashCode'; - } -} diff --git a/packages/riverpod/test/old/legacy_providers/stream_notifier/stream_notifier_test.dart b/packages/riverpod/test/old/legacy_providers/stream_notifier/stream_notifier_test.dart new file mode 100644 index 000000000..08d2ded34 --- /dev/null +++ b/packages/riverpod/test/old/legacy_providers/stream_notifier/stream_notifier_test.dart @@ -0,0 +1,1136 @@ +// ignore_for_file: avoid_types_on_closure_parameters + +import 'dart:async'; + +import 'package:meta/meta.dart'; +import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +import '../../../new/matrix.dart'; +import '../../utils.dart'; + +void main() { + test('Throws if using notifier properties in its constructor', () { + expect( + CtorNotifier.new, + throwsA(isA()), + ); + expect( + FamilyCtorNotifier.new, + throwsA(isA()), + ); + }); + + streamNotifierProviderFactory.createGroup((factory) { + test('Cannot share a Notifier instance between providers ', () { + final container = ProviderContainer.test(); + final notifier = factory.deferredNotifier((ref) => Stream.value(0)); + + final provider = factory.provider(() => notifier); + final provider2 = factory.provider(() => notifier); + + container.read(provider); + + expect( + container.read(provider2), + isA>(), + ); + }); + + test('Can read state inside onDispose', () { + final container = ProviderContainer.test(); + late TestStreamNotifier notifier; + final provider = factory.simpleTestProvider((ref) { + ref.onDispose(() { + notifier.state; + }); + return Stream.value(0); + }); + + container.listen(provider.notifier, (prev, next) {}); + notifier = container.read(provider.notifier); + + container.dispose(); + }); + + test('Using the notifier after dispose throws', () { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider((ref) => Stream.value(0)); + + container.listen(provider.notifier, (prev, next) {}); + final notifier = container.read(provider.notifier); + + container.dispose(); + + expect(() => notifier.state, throwsStateError); + expect(() => notifier.future, throwsStateError); + expect(() => notifier.state = const AsyncData(42), throwsStateError); + // ignore: invalid_use_of_protected_member + expect(() => notifier.ref, throwsStateError); + expect(() => notifier.update((p1) => 42), throwsStateError); + }); + + group('supports AsyncValue transition', () { + test( + 'performs seamless copyWithPrevious if triggered by ref.invalidate/ref.refresh', + () async { + final container = ProviderContainer.test(); + var count = 0; + final provider = factory.simpleTestProvider( + (ref) => Stream.value(count++), + ); + + container.listen(provider, (previous, next) {}); + + await expectLater(container.read(provider.future), completion(0)); + expect(container.read(provider), const AsyncData(0)); + + expect( + container.refresh(provider), + const AsyncLoading().copyWithPrevious(const AsyncData(0)), + ); + + await expectLater(container.read(provider.future), completion(1)); + expect(container.read(provider), const AsyncData(1)); + + container.invalidate(provider); + + expect( + container.read(provider), + const AsyncLoading().copyWithPrevious(const AsyncData(1)), + ); + await expectLater(container.read(provider.future), completion(2)); + expect(container.read(provider), const AsyncData(2)); + }); + + test( + 'performs seamless:false copyWithPrevious on `state = AsyncLoading()`', + () async { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider((ref) => Stream.value(0)); + + final sub = container.listen(provider.notifier, (previous, next) {}); + + await expectLater(container.read(provider.future), completion(0)); + expect(container.read(provider), const AsyncData(0)); + + sub.read().state = const AsyncLoading(); + + expect( + sub.read().state, + const AsyncLoading() + .copyWithPrevious(const AsyncData(0), isRefresh: false), + ); + }); + + test( + 'performs seamless:false copyWithPrevious if triggered by a dependency change', + () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final provider = factory.simpleTestProvider( + (ref) => Stream.value(ref.watch(dep)), + ); + + container.listen(provider, (previous, next) {}); + + await expectLater(container.read(provider.future), completion(0)); + expect(container.read(provider), const AsyncData(0)); + + container.read(dep.notifier).state++; + expect( + container.read(provider), + const AsyncLoading() + .copyWithPrevious(const AsyncData(0), isRefresh: false), + ); + + await expectLater(container.read(provider.future), completion(1)); + expect(container.read(provider), const AsyncData(1)); + }); + + test( + 'performs seamless:false copyWithPrevious if both triggered by a dependency change and ref.refresh', + () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final provider = factory.simpleTestProvider( + (ref) => Stream.value(ref.watch(dep)), + ); + + container.listen(provider, (previous, next) {}); + + await expectLater(container.read(provider.future), completion(0)); + expect(container.read(provider), const AsyncData(0)); + + container.read(dep.notifier).state++; + expect( + container.refresh(provider), + const AsyncLoading() + .copyWithPrevious(const AsyncData(0), isRefresh: false), + ); + + await expectLater(container.read(provider.future), completion(1)); + expect(container.read(provider), const AsyncData(1)); + }); + }); + + test('does not notify listeners when refreshed during loading', () async { + final provider = factory.simpleTestProvider((ref) => Stream.value(0)); + final container = ProviderContainer.test(); + final listener = Listener>(); + + container.listen(provider, listener.call, fireImmediately: true); + + verifyOnly(listener, listener(null, const AsyncLoading())); + + container.refresh(provider); + + await container.read(provider.future); + + verifyOnly( + listener, + listener(const AsyncLoading(), const AsyncData(0)), + ); + }); + + test('supports listenSelf', () { + final listener = Listener>(); + final onError = ErrorListener(); + final provider = factory.simpleTestProvider((ref) { + ref.listenSelf(listener.call, onError: onError.call); + Error.throwWithStackTrace(42, StackTrace.empty); + }); + final container = ProviderContainer.test(); + + container.listen(provider, (previous, next) {}); + + verifyOnly( + listener, + listener(null, const AsyncError(42, StackTrace.empty)), + ); + verifyZeroInteractions(onError); + + container.read(provider.notifier).state = const AsyncData(42); + + verifyNoMoreInteractions(onError); + verifyOnly( + listener, + listener( + const AsyncError(42, StackTrace.empty), + const AsyncData(42), + ), + ); + }); + + test( + 'converts StreamNotifier.build into an AsyncData if the future completes', + () async { + final provider = factory.simpleTestProvider((ref) => Stream.value(0)); + final container = ProviderContainer.test(); + final listener = Listener>(); + + container.listen(provider, listener.call, fireImmediately: true); + + verifyOnly(listener, listener(null, const AsyncLoading())); + expect( + container.read(provider.notifier).state, + const AsyncLoading(), + ); + + expect(await container.read(provider.future), 0); + + verifyOnly( + listener, + listener(const AsyncLoading(), const AsyncData(0)), + ); + expect( + container.read(provider.notifier).state, + const AsyncData(0), + ); + }); + + test('converts StreamNotifier.build into an AsyncError if the future fails', + () async { + final provider = factory.simpleTestProvider( + (ref) => Stream.error(0, StackTrace.empty), + ); + final container = ProviderContainer.test(); + final listener = Listener>(); + + container.listen(provider, listener.call, fireImmediately: true); + + verifyOnly(listener, listener(null, const AsyncLoading())); + expect( + container.read(provider.notifier).state, + const AsyncLoading(), + ); + + await expectLater(container.read(provider.future), throwsA(0)); + + verifyOnly( + listener, + listener(const AsyncLoading(), const AsyncError(0, StackTrace.empty)), + ); + expect( + container.read(provider.notifier).state, + const AsyncError(0, StackTrace.empty), + ); + }); + + test('supports cases where the StreamNotifier constructor throws', + () async { + final provider = factory.provider( + () => Error.throwWithStackTrace(0, StackTrace.empty), + ); + final container = ProviderContainer.test(); + final listener = Listener>(); + + container.listen(provider, listener.call, fireImmediately: true); + + verifyOnly( + listener, + listener(null, const AsyncError(0, StackTrace.empty)), + ); + expect( + () => container.read(provider.notifier), + throwsA(0), + ); + + await expectLater(container.read(provider.future), throwsA(0)); + }); + + test( + 'synchronously emits AsyncError if StreamNotifier.build throws synchronously', + () async { + final provider = factory.simpleTestProvider( + (ref) => Error.throwWithStackTrace(42, StackTrace.empty), + ); + final container = ProviderContainer.test(); + final listener = Listener>(); + + container.listen(provider, listener.call, fireImmediately: true); + + verifyOnly( + listener, + listener(null, const AsyncError(42, StackTrace.empty)), + ); + expect( + container.read(provider.notifier).state, + const AsyncError(42, StackTrace.empty), + ); + await expectLater(container.read(provider.future), throwsA(42)); + }); + + test( + 'stops listening to the previous future data when the provider rebuilds', + () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final completers = { + 0: Completer.sync(), + 1: Completer.sync(), + }; + final provider = factory.simpleTestProvider( + (ref) => Stream.fromFuture(completers[ref.watch(dep)]!.future), + ); + final listener = Listener>(); + + container.listen(provider, listener.call); + + expect( + container.read(provider.future), + completion(21), + reason: 'The provider rebuilt while the future was still pending, ' + 'so .future should resolve with the next value', + ); + verifyZeroInteractions(listener); + expect(container.read(provider), const AsyncLoading()); + + container.read(dep.notifier).state++; + completers[0]!.complete(42); + + verifyZeroInteractions(listener); + + expect(container.read(provider.future), completion(21)); + expect(container.read(provider), const AsyncLoading()); + + completers[1]!.complete(21); + + expect(await container.read(provider.future), 21); + expect(container.read(provider), const AsyncData(21)); + }); + + test( + 'stops listening to the previous future error when the provider rebuilds', + () async { + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final completers = { + 0: Completer.sync(), + 1: Completer.sync(), + }; + final provider = factory.simpleTestProvider( + (ref) => Stream.fromFuture(completers[ref.watch(dep)]!.future), + ); + final listener = Listener>(); + + container.listen(provider, listener.call); + + expect( + container.read(provider.future), + throwsA(21), + reason: 'The provider rebuilt while the future was still pending, ' + 'so .future should resolve with the next value', + ); + verifyZeroInteractions(listener); + expect(container.read(provider), const AsyncLoading()); + + container.read(dep.notifier).state++; + completers[0]!.completeError(42, StackTrace.empty); + + verifyZeroInteractions(listener); + + expect(container.read(provider.future), throwsA(21)); + expect(container.read(provider), const AsyncLoading()); + + completers[1]!.completeError(21, StackTrace.empty); + + await expectLater(container.read(provider.future), throwsA(21)); + expect( + container.read(provider), + const AsyncError(21, StackTrace.empty), + ); + }); + + group('StreamNotifier.state', () { + test( + 'when manually modifying the state, the new exposed value contains the previous state when possible', + () async { + final provider = factory.simpleTestProvider( + (ref) => Stream.value(0), + ); + final container = ProviderContainer.test(); + + final sub = container.listen(provider.notifier, (previous, next) {}); + await container.read(provider.future); + + // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` + final newState = AsyncData(84); + // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` + final newLoading = AsyncLoading(); + // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` + final newError = AsyncError(84, StackTrace.empty); + + sub.read().state = newState; + + expect(sub.read().state, same(newState)); + + sub.read().state = newLoading; + + expect( + sub.read().state, + const AsyncLoading() + .copyWithPrevious(newState, isRefresh: false), + ); + + sub.read().state = newError; + + expect( + sub.read().state, + newError.copyWithPrevious( + const AsyncLoading() + .copyWithPrevious(newState, isRefresh: false), + ), + ); + }); + + test( + 'when read on outdated provider, refreshes the provider and return the up-to-date state', + () async { + final listener = OnBuildMock(); + final dep = StateProvider((ref) => 0); + final provider = factory.simpleTestProvider( + (ref) { + listener(); + return Stream.value(ref.watch(dep)); + }, + ); + final container = ProviderContainer.test(); + + container.listen(provider, (previous, next) {}); + final notifier = container.read(provider.notifier); + + expect(notifier.state, const AsyncLoading()); + expect(await container.read(provider.future), 0); + expect(notifier.state, const AsyncData(0)); + verify(listener()).called(1); + + container.read(dep.notifier).state++; + + expect( + notifier.state, + const AsyncLoading() + .copyWithPrevious(const AsyncData(0), isRefresh: false), + ); + expect(await container.read(provider.future), 1); + expect(notifier.state, const AsyncData(1)); + verify(listener()).called(1); + }); + + test('can be read inside build', () { + final dep = StateProvider((ref) => 0); + late AsyncValue state; + final provider = factory.provider( + () { + late TestStreamNotifier notifier; + return notifier = factory.deferredNotifier( + (ref) { + state = notifier.state; + return Stream.value(ref.watch(dep)); + }, + ); + }, + ); + final container = ProviderContainer.test(); + + container.listen(provider, (previous, next) {}); + + expect(state, const AsyncLoading()); + + container.read(provider.notifier).state = const AsyncData(42); + container.refresh(provider); + + expect( + state, + const AsyncLoading().copyWithPrevious(const AsyncData(42)), + ); + }); + + test('notifies listeners when the setter is called', () async { + final provider = factory.simpleTestProvider((ref) => Stream.value(0)); + final container = ProviderContainer.test(); + final listener = Listener>(); + + // Skip the loading + await container.listen(provider.future, (previous, next) {}).read(); + + container.listen(provider, listener.call); + + verifyZeroInteractions(listener); + + container.read(provider.notifier).state = const AsyncData(42); + + verifyOnly( + listener, + listener(const AsyncData(0), const AsyncData(42)), + ); + }); + }); + + group('StreamNotifier.future', () { + test( + 'when disposed during loading, resolves with the content of StreamNotifier.build', + () async { + final container = ProviderContainer.test(); + final completer = Completer.sync(); + final provider = factory.simpleTestProvider( + (ref) => Stream.fromFuture(completer.future), + ); + + final future = container.read(provider.future); + container.dispose(); + + completer.complete(42); + + await expectLater(future, completion(42)); + }); + + test( + 'when disposed during loading, resolves with the error of StreamNotifier.build', + () async { + final container = ProviderContainer.test(); + final completer = Completer.sync(); + final provider = factory.simpleTestProvider( + (ref) => Stream.fromFuture(completer.future), + ); + + final future = container.read(provider.future); + + container.dispose(); + + completer.completeError(42); + + await expectLater(future, throwsA(42)); + }); + + test( + 'going data > loading while the future is still pending. ' + 'Resolves with last future result', + () async { + final container = ProviderContainer.test(); + final completer = Completer.sync(); + final provider = factory.simpleTestProvider( + (ref) => Stream.fromFuture(completer.future), + ); + + container.read(provider); + container.read(provider.notifier).state = const AsyncData(42); + container.read(provider.notifier).state = const AsyncLoading(); + + final future = container.read(provider.future); + + container.dispose(); + + completer.complete(42); + + await expectLater(future, completion(42)); + }, + ); + + test( + 'if going back to loading after future resolved, throws StateError', + () async { + final container = ProviderContainer.test(); + final completer = Completer.sync(); + final provider = factory.simpleTestProvider( + (ref) => Stream.fromFuture(completer.future), + ); + + container.read(provider); + + completer.complete(42); + + container.read(provider.notifier).state = const AsyncData(42); + container.read(provider.notifier).state = const AsyncLoading(); + + final future = container.read(provider.future); + + container.dispose(); + + await expectLater(future, throwsStateError); + }, + ); + + test( + 'resolves with the new state if StreamNotifier.state is modified during loading', + () async { + final container = ProviderContainer.test(); + final completer = Completer.sync(); + final provider = factory.simpleTestProvider( + (ref) => Stream.fromFuture(completer.future), + ); + final listener = Listener>(); + + final sub = container.listen(provider.notifier, (previous, next) {}); + container.listen(provider.future, listener.call); + + expect(sub.read().future, completion(21)); + + sub.read().state = const AsyncData(21); + + completer.complete(42); + + expect(sub.read().future, completion(42)); + final capture = + verifyOnly(listener, listener(captureAny, captureAny)).captured; + + expect(capture.length, 2); + expect(capture.first, completion(21)); + expect(capture.last, completion(42)); + }); + + test('resolves with the new state when notifier.state is changed', + () async { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider( + (ref) => Stream.value(0), + ); + final listener = Listener>(); + + final sub = container.listen(provider.notifier, (previous, next) {}); + container.listen( + provider.future, + listener.call, + fireImmediately: true, + ); + + await expectLater(sub.read().future, completion(0)); + verifyOnly( + listener, + listener(argThat(equals(null)), argThat(completion(0))), + ); + + sub.read().state = const AsyncData(1); + + await expectLater(sub.read().future, completion(1)); + }); + + test('returns a Future identical to that of .future', () { + final listener = OnBuildMock(); + final dep = StateProvider((ref) => 0); + final provider = factory.simpleTestProvider( + (ref) { + listener(); + return Stream.value(ref.watch(dep)); + }, + ); + final container = ProviderContainer.test(); + + container.listen(provider.notifier, (previous, next) {}); + final notifier = container.read(provider.notifier); + + expect(notifier.future, same(container.read(provider.future))); + }); + + test( + 'when read on outdated provider, refreshes the provider and return the up-to-date state', + () async { + final listener = OnBuildMock(); + final dep = StateProvider((ref) => 0); + final provider = factory.simpleTestProvider( + (ref) { + listener(); + return Stream.value(ref.watch(dep)); + }, + ); + final container = ProviderContainer.test(); + + container.listen(provider, (previous, next) {}); + final notifier = container.read(provider.notifier); + + expect(await container.read(provider.future), 0); + verify(listener()).called(1); + + container.read(dep.notifier).state++; + + expect(notifier.future, notifier.future); + expect(notifier.future, same(container.read(provider.future))); + expect(await notifier.future, 1); + verify(listener()).called(1); + }); + }); + + group('StreamNotifierProvider.notifier', () { + test( + 'never emits an update. The Notifier is never recreated once it is instantiated', + () async { + final listener = OnBuildMock(); + final dep = StateProvider((ref) => 0); + final provider = factory.provider(() { + listener(); + return factory.deferredNotifier( + (ref) => Stream.value(ref.watch(dep)), + ); + }); + final container = ProviderContainer.test(); + + // Skip the loading + await container.listen(provider.future, (previous, next) {}).read(); + + container.listen(provider, (previous, next) {}); + final notifier = container.read(provider.notifier); + + verify(listener()).called(1); + expect(container.read(provider), const AsyncData(0)); + + container.read(dep.notifier).state++; + await container.read(provider.future); + + expect(container.read(provider), const AsyncData(1)); + expect(container.read(provider.notifier), same(notifier)); + verifyNoMoreInteractions(listener); + }); + }); + + test( + 'Can override StreamNotifier.updateShouldNotify to change the default filter logic', + () async { + final provider = factory.simpleTestProvider>( + (ref) => Stream.value(Equal(42)), + updateShouldNotify: (a, b) => a != b, + ); + final container = ProviderContainer.test(); + final listener = Listener>>(); + + // Skip the loading + await container.listen(provider.future, (previous, next) {}).read(); + + container.listen(provider, listener.call); + final notifier = container.read(provider.notifier); + + // voluntarily assigning the same value + final self = notifier.state; + notifier.state = self; + + verifyZeroInteractions(listener); + + notifier.state = AsyncData(Equal(42)); + + verifyZeroInteractions(listener); + + notifier.state = AsyncData(Equal(21)); + + verifyOnly( + listener, + listener(AsyncData(Equal(42)), AsyncData(Equal(21))), + ); + }); + + group('AsyncNotifier.update', () { + test('passes in the latest state', () async { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider( + (ref) => Stream.value(0), + ); + + // Skip the loading + await container.listen(provider.future, (previous, next) {}).read(); + + final sub = container.listen(provider.notifier, (prev, next) {}); + + expect( + container.read(provider), + const AsyncData(0), + ); + + await expectLater( + sub.read().update((prev) => prev + 1), + completion(1), + ); + await expectLater( + sub.read().future, + completion(1), + ); + await expectLater( + sub.read().update((prev) => prev + 1), + completion(2), + ); + }); + + test('can specify onError to handle error scenario', () async { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider( + (ref) => Error.throwWithStackTrace(42, StackTrace.empty), + ); + var callCount = 0; + Object? actualErr; + Object? actualStack; + + final sub = container.listen(provider.notifier, (prev, next) {}); + + expect( + container.read(provider), + const AsyncError(42, StackTrace.empty), + ); + + await expectLater( + sub.read().update( + (prev) { + callCount++; + return prev; + }, + onError: (err, stack) { + actualErr = err; + actualStack = stack; + return 21; + }, + ), + completion(21), + ); + expect(callCount, 0); + expect(actualErr, 42); + expect(actualStack, StackTrace.empty); + expect(container.read(provider), const AsyncData(21)); + }); + + test('executes immediately with current state if a state is available', + () async { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider( + (ref) => Stream.value(1), + ); + + // Skip the loading + await container.listen(provider.future, (previous, next) {}).read(); + + final sub = container.listen(provider.notifier, (prev, next) {}); + + expect(container.read(provider), const AsyncData(1)); + + await expectLater( + sub.read().update((prev) => prev + 1), + completion(2), + ); + expect(container.read(provider), const AsyncData(2)); + }); + + test('executes immediately with current state if an error is available', + () async { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider( + (ref) => Error.throwWithStackTrace(42, StackTrace.empty), + ); + var callCount = 0; + + final sub = container.listen(provider.notifier, (prev, next) {}); + + expect( + container.read(provider), + const AsyncError(42, StackTrace.empty), + ); + + await expectLater( + sub.read().update((prev) { + callCount++; + return prev + 1; + }), + throwsA(42), + ); + + expect(callCount, 0); + expect( + container.read(provider), + const AsyncError(42, StackTrace.empty), + ); + }); + + test('awaits the future resolution if in loading state', () async { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider( + (ref) => Stream.value(42), + ); + + final sub = container.listen(provider.notifier, (prev, next) {}); + + expect(container.read(provider), const AsyncLoading()); + + await expectLater( + sub.read().update((prev) => prev + 1), + completion(43), + ); + expect(container.read(provider), const AsyncData(43)); + }); + }); + }); + + test('supports overrideWith', () async { + final provider = StreamNotifierProvider, int>( + () => DeferredStreamNotifier((ref) => Stream.value(0)), + ); + final autoDispose = + StreamNotifierProvider.autoDispose, int>( + () => DeferredStreamNotifier((ref) => Stream.value(0)), + ); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWith( + () => DeferredStreamNotifier((ref) => Stream.value(42)), + ), + autoDispose.overrideWith( + () => DeferredStreamNotifier((ref) => Stream.value(84)), + ), + ], + ); + + // Skip the loading + await container.listen(provider.future, (previous, next) {}).read(); + await container.listen(autoDispose.future, (previous, next) {}).read(); + + expect(container.read(provider).value, 42); + expect(container.read(autoDispose).value, 84); + }); + + test('supports family overrideWith', () async { + final family = StreamNotifierProvider.family< + DeferredFamilyStreamNotifier, int, int>( + () => DeferredFamilyStreamNotifier((ref) => Stream.value(0)), + ); + final autoDisposeFamily = StreamNotifierProvider.autoDispose + .family, int, int>( + () => DeferredFamilyStreamNotifier((ref) => Stream.value(0)), + ); + final container = ProviderContainer.test( + overrides: [ + family.overrideWith( + () => DeferredFamilyStreamNotifier((ref) => Stream.value(42)), + ), + autoDisposeFamily.overrideWith( + () => DeferredFamilyStreamNotifier( + (ref) => Stream.value(84), + ), + ), + ], + ); + + // Skip the loading + await container.listen(family(10).future, (previous, next) {}).read(); + await container + .listen(autoDisposeFamily(10).future, (previous, next) {}) + .read(); + + expect(container.read(family(10)).value, 42); + expect(container.read(autoDisposeFamily(10)).value, 84); + }); + + group('AutoDispose variant', () { + test('can watch autoDispose providers', () async { + final dep = Provider.autoDispose((ref) => 0); + final provider = + StreamNotifierProvider.autoDispose, int>( + () => DeferredStreamNotifier((ref) { + return Stream.value(ref.watch(dep)); + }), + ); + final container = ProviderContainer.test(); + + // Skip the loading + await container.listen(provider.future, (previous, next) {}).read(); + + expect(container.read(provider), const AsyncData(0)); + }); + }); + + group('modifiers', () { + void canBeAssignedToRefreshable( + Refreshable provider, + ) {} + + void canBeAssignedToProviderListenable( + ProviderListenable provider, + ) {} + + test('provider', () { + final provider = StreamNotifierProvider, int>( + () => DeferredStreamNotifier((ref) => Stream.value(0)), + ); + + provider.select((AsyncValue value) => 0); + provider.selectAsync((int value) => 0); + + canBeAssignedToProviderListenable>(provider); + canBeAssignedToRefreshable>(provider); + + canBeAssignedToProviderListenable>(provider.future); + canBeAssignedToRefreshable>(provider.future); + + canBeAssignedToProviderListenable>(provider.notifier); + canBeAssignedToRefreshable>(provider.notifier); + }); + + test('autoDispose', () { + final autoDispose = + StreamNotifierProvider.autoDispose, int>( + () => DeferredStreamNotifier((ref) => Stream.value(0)), + ); + + autoDispose.select((AsyncValue value) => 0); + autoDispose.selectAsync((int value) => 0); + + canBeAssignedToProviderListenable>(autoDispose); + canBeAssignedToRefreshable>(autoDispose); + + canBeAssignedToProviderListenable>(autoDispose.future); + canBeAssignedToRefreshable>(autoDispose.future); + + canBeAssignedToProviderListenable>( + autoDispose.notifier, + ); + canBeAssignedToRefreshable>( + autoDispose.notifier, + ); + }); + + test('family', () { + final family = StreamNotifierProvider.family< + DeferredFamilyStreamNotifier, String, int>( + () => DeferredFamilyStreamNotifier((ref) => Stream.value('0')), + ); + + family(0).select((AsyncValue value) => 0); + family(0).selectAsync((String value) => 0); + + canBeAssignedToProviderListenable>(family(0)); + canBeAssignedToRefreshable>(family(0)); + + canBeAssignedToProviderListenable>(family(0).future); + canBeAssignedToRefreshable>(family(0).future); + + canBeAssignedToProviderListenable>( + family(0).notifier, + ); + canBeAssignedToRefreshable>( + family(0).notifier, + ); + }); + + test('autoDisposeFamily', () { + expect( + StreamNotifierProvider.autoDispose.family, + same(StreamNotifierProvider.family.autoDispose), + ); + + final autoDisposeFamily = StreamNotifierProvider.autoDispose + .family, String, int>( + () => DeferredFamilyStreamNotifier((ref) => Stream.value('0')), + ); + + autoDisposeFamily(0).select((AsyncValue value) => 0); + autoDisposeFamily(0).selectAsync((String value) => 0); + + canBeAssignedToProviderListenable>( + autoDisposeFamily(0), + ); + canBeAssignedToRefreshable>( + autoDisposeFamily(0), + ); + + canBeAssignedToProviderListenable>( + autoDisposeFamily(0).future, + ); + canBeAssignedToRefreshable>( + autoDisposeFamily(0).future, + ); + + canBeAssignedToProviderListenable>( + autoDisposeFamily(0).notifier, + ); + canBeAssignedToRefreshable>( + autoDisposeFamily(0).notifier, + ); + }); + }); +} + +@immutable +class Equal { + // ignore: prefer_const_constructors_in_immutables + Equal(this.value); + + final T value; + + @override + bool operator ==(Object other) => other is Equal && other.value == value; + + @override + int get hashCode => Object.hash(runtimeType, value); +} + +class CtorNotifier extends StreamNotifier { + CtorNotifier() { + state; + } + + @override + Stream build() => Stream.value(0); +} + +class FamilyCtorNotifier extends FamilyStreamNotifier { + FamilyCtorNotifier() { + state; + } + + @override + Stream build(int arg) => Stream.value(0); +} From 5babea3e40b8200a67087f81a65a26b883b6dfbf Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 1 Feb 2024 15:00:41 +0100 Subject: [PATCH 143/387] Restore Notifier tests --- packages/riverpod/lib/riverpod.dart | 3 +- .../riverpod/lib/src/core/async_value.dart | 11 +- packages/riverpod/lib/src/core/element.dart | 51 +- .../lib/src/core/override_with_value.dart | 6 +- .../lib/src/core/provider/provider.dart | 2 +- .../legacy/state_notifier_provider.dart | 5 +- .../src/providers/legacy/state_provider.dart | 2 +- .../riverpod/lib/src/providers/notifier.dart | 17 +- .../lib/src/providers/notifier/family.dart | 16 +- .../lib/src/providers/notifier/orphan.dart | 16 +- .../riverpod/lib/src/providers/provider.dart | 5 +- packages/riverpod/test/new/matrix.dart | 7 +- .../new/matrix/async_notifier_provider.dart | 5 + .../test/new/matrix/notifier_provider.dart | 199 +++++ .../new/matrix/stream_notifier_provider.dart | 5 + .../old/framework/provider_element_test.dart | 2 +- .../legacy_providers/notifier/factory.dart | 288 ------ .../notifier/notifier_test.dart | 823 +++++++++--------- 18 files changed, 685 insertions(+), 778 deletions(-) create mode 100644 packages/riverpod/test/new/matrix/notifier_provider.dart delete mode 100644 packages/riverpod/test/old/legacy_providers/notifier/factory.dart diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index f0e55c843..ff97ed560 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -49,8 +49,7 @@ export 'src/providers/async_notifier.dart' // Use pkg:riverpod/legacy.dart export 'src/providers/future_provider.dart'; -export 'src/providers/notifier.dart' - hide NotifierProvider, FamilyNotifierProvider; +export 'src/providers/notifier.dart' hide NotifierBase, NotifierProviderBase; export 'src/providers/provider.dart'; export 'src/providers/stream_notifier.dart' hide StreamNotifierBase, StreamNotifierProviderBase; diff --git a/packages/riverpod/lib/src/core/async_value.dart b/packages/riverpod/lib/src/core/async_value.dart index d0591febc..70ae1eea2 100644 --- a/packages/riverpod/lib/src/core/async_value.dart +++ b/packages/riverpod/lib/src/core/async_value.dart @@ -1,5 +1,6 @@ import 'package:meta/meta.dart'; +import '../common/result.dart'; import '../common/stack_trace.dart'; import '../framework.dart'; import '../providers/future_provider.dart' show FutureProvider; @@ -18,15 +19,17 @@ extension AsyncTransition on ProviderElementBase> { required bool seamless, }) { // ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member - final previous = getState()?.requireState; + final previous = stateResult?.requireState; if (previous == null) { // ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member - setState(newState); + setStateResult(ResultData(newState)); } else { // ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member - setState( - newState._cast().copyWithPrevious(previous, isRefresh: seamless), + setStateResult( + ResultData( + newState._cast().copyWithPrevious(previous, isRefresh: seamless), + ), ); } } diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index c0715ac7e..5496ac4c9 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -55,7 +55,7 @@ abstract class ProviderElementBase implements Ref, Node { State get state => readSelf(); @override - set state(State newState) => setState(newState); + set state(State newState) => setStateResult(ResultData(newState)); /// The last result of [ProviderBase.debugGetCreateSourceHash]. /// @@ -141,7 +141,21 @@ abstract class ProviderElementBase implements Ref, Node { List? _keepAliveLinks; /* STATE */ - Result? _state; + Result? _stateResult; + + /// The current state of the provider. + /// + + /// Obtains the current state, or null if the provider has yet to initialize. + /// + /// The returned object will contain error information, if any. + /// This function does not cause the provider to rebuild if it somehow was + /// outdated. + /// + /// This is not meant for public consumption. Instead, public API should use + /// [readSelf]. + @internal + Result? get stateResult => _stateResult; /// Update the exposed value of a provider and notify its listeners. /// @@ -151,28 +165,17 @@ abstract class ProviderElementBase implements Ref, Node { /// This API is not meant for public consumption. Instead if a [Ref] needs /// to expose a way to update the state, the practice is to expose a getter/setter. @internal - void setState(State newState) { + void setStateResult(Result newState) { if (kDebugMode) _debugDidSetState = true; - final previousResult = getState(); - final result = _state = ResultData(newState); + final previousResult = stateResult; + final result = _stateResult = newState; if (_didBuild) { _notifyListeners(result, previousResult); } } - /// Obtains the current state, or null if the provider has yet to initialize. - /// - /// The returned object will contain error information, if any. - /// This function does not cause the provider to rebuild if it somehow was - /// outdated. - /// - /// This is not meant for public consumption. Instead, public API should use - /// [readSelf]. - @internal - Result? getState() => _state; - /// Read the current value of a provider and: /// /// - if in error state, rethrow the error @@ -195,7 +198,7 @@ This could mean a few things: } } - final state = getState(); + final state = stateResult; if (state == null) throw StateError(uninitializedError); return state.when( @@ -236,7 +239,7 @@ This could mean a few things: buildState(); - _state!.map( + _stateResult!.map( data: (newState) { final onChangeSelfListeners = _onChangeSelfListeners; if (onChangeSelfListeners != null) { @@ -366,18 +369,18 @@ This could mean a few things: _previousDependencies = _dependencies; _dependencies = HashMap(); - final previousStateResult = _state; + final previousStateResult = _stateResult; if (kDebugMode) _debugDidSetState = false; buildState(); - if (!identical(_state, previousStateResult)) { + if (!identical(_stateResult, previousStateResult)) { // Asserts would otherwise prevent a provider rebuild from updating // other providers if (kDebugMode) _debugSkipNotifyListenersAsserts = true; - _notifyListeners(_state!, previousStateResult); + _notifyListeners(_stateResult!, previousStateResult); if (kDebugMode) _debugSkipNotifyListenersAsserts = false; } @@ -422,7 +425,7 @@ This could mean a few things: } catch (err, stack) { if (kDebugMode) _debugDidSetState = true; - _state = Result.error(err, stack); + _stateResult = Result.error(err, stack); } finally { _didBuild = true; if (kDebugMode) { @@ -430,7 +433,7 @@ This could mean a few things: } assert( - getState() != null, + stateResult != null, 'Bad state, the provider did not initialize. Did "create" forget to set the state?', ); } @@ -438,7 +441,7 @@ This could mean a few things: @override void notifyListeners() { - final currentResult = getState(); + final currentResult = stateResult; // If `notifyListeners` is used during `build`, the result will be null. // Throwing would be unnecessarily inconvenient, so we simply skip it. if (currentResult == null) return; diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index f6db1b09d..c9688293a 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -51,14 +51,14 @@ class _ValueProviderElement extends ProviderElementBase { final newValue = provider._value; // `getState` will never be in error/loading state since there is no "create" - final previousState = getState()! as ResultData; + final previousState = stateResult! as ResultData; if (newValue != previousState.state) { // Asserts would otherwise prevent a provider rebuild from updating // other providers if (kDebugMode) _debugSkipNotifyListenersAsserts = true; - setState(newValue); + setStateResult(ResultData(newValue)); // Asserts would otherwise prevent a provider rebuild from updating // other providers @@ -70,7 +70,7 @@ class _ValueProviderElement extends ProviderElementBase { @override void create({required bool didChangeDependency}) { - setState(provider._value); + setStateResult(ResultData(provider._value)); } @override diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index 9ee3e36db..48ae0af67 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -69,7 +69,7 @@ abstract base class ProviderBase extends ProviderOrFamily element.flush(); if (fireImmediately) { _handleFireImmediately( - element.getState()!, + element.stateResult!, listener: listener, onError: onError, ); diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index 63978b501..78729777a 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -195,7 +195,10 @@ class StateNotifierProviderElement, T> _removeListener = notifier // TODO test requireState, as ref.read(p) is expected to throw if notifier creation failed .requireState - .addListener(setState, fireImmediately: true); + .addListener( + (newState) => setStateResult(ResultData(newState)), + fireImmediately: true, + ); } @override diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index fe6013ec2..51c052e04 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -146,7 +146,7 @@ class StateProviderElement extends ProviderElementBase fireImmediately: true, (state) { _stateNotifier.result = _controllerNotifier.result; - setState(state); + setStateResult(ResultData(state)); }, ); } diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index bf05e9ef6..6b7487a22 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -1,18 +1,18 @@ -import 'dart:async'; - import 'package:meta/meta.dart'; import '../builder.dart'; +import '../common/result.dart'; import '../framework.dart'; import 'async_notifier.dart'; part 'notifier/orphan.dart'; part 'notifier/family.dart'; -/// A base class for [_NotifierBase]. +/// A base class for [NotifierBase]. /// /// Not meant for public consumption. -abstract class _NotifierBase extends ClassBase { +@internal +abstract class NotifierBase extends ClassBase { /// The value currently exposed by this [Notifier]. /// /// If used inside [Notifier.build], may throw if the notifier is not yet initialized. @@ -46,7 +46,7 @@ abstract class _NotifierBase extends ClassBase { if (element == null) throw StateError(uninitializedElementError); element.flush(); - return element.getState()?.stateOrNull; + return element.stateResult?.stateOrNull; } /// A method invoked when the state exposed by this [Notifier] changes. @@ -83,13 +83,14 @@ abstract class _NotifierBase extends ClassBase { } } -abstract base class _NotifierProvider // - , StateT> +@internal +abstract base class NotifierProviderBase // + , StateT> extends ClassProvider> { /// An internal base class for [Notifier]. /// /// Not meant for public consumption. - const _NotifierProvider( + const NotifierProviderBase( this._createNotifier, { required super.name, required super.from, diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index a051c4deb..38e116bc5 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -3,13 +3,17 @@ part of '../notifier.dart'; /// {@macro riverpod.notifier} /// /// {@macro riverpod.notifier_provider_modifier} -abstract class FamilyNotifier extends _NotifierBase { +abstract class FamilyNotifier extends NotifierBase { /// {@macro riverpod.notifier.family_arg} - late final Arg arg; + late final ArgT arg = (ref as ProviderElementBase).origin.argument as ArgT; /// {@macro riverpod.async_notifier.build} @visibleForOverriding - State build(Arg arg); + StateT build(ArgT arg); + + @internal + @override + StateT runBuild() => build(arg); } /// The implementation of [NotifierFamilyProvider] but with loosened type constraints @@ -17,11 +21,9 @@ abstract class FamilyNotifier extends _NotifierBase { /// /// This enables tests to execute on both [NotifierProvider] and /// [AutoDisposeNotifierProvider] at the same time. -@visibleForTesting -@internal final class FamilyNotifierProvider // - , StateT, ArgT> - extends _NotifierProvider { + , StateT, ArgT> + extends NotifierProviderBase { /// An implementation detail of Riverpod const FamilyNotifierProvider._( super._createNotifier, { diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart index 79c257762..ffb7e7461 100644 --- a/packages/riverpod/lib/src/providers/notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -55,7 +55,7 @@ part of '../notifier.dart'; /// - [FamilyNotifier] for `family` /// - [AutoDisposeFamilyNotifier] for `autoDispose.family` /// {@endtemplate} -abstract class Notifier extends _NotifierBase { +abstract class Notifier extends NotifierBase { /// {@template riverpod.notifier.build} /// Initialize a [Notifier]. /// @@ -70,10 +70,14 @@ abstract class Notifier extends _NotifierBase { /// {@endtemplate} @visibleForOverriding State build(); + + @internal + @override + State runBuild() => build(); } final class NotifierProvider, StateT> - extends _NotifierProvider { + extends NotifierProviderBase { /// {@macro riverpod.notifier_provider} /// /// {@macro riverpod.notifier_provider_modifier} @@ -167,7 +171,7 @@ final class NotifierProvider, StateT> } class _NotifierProviderElement< // - NotifierT extends _NotifierBase, + NotifierT extends NotifierBase, StateT> // extends ClassProviderElement< // NotifierT, @@ -177,7 +181,7 @@ class _NotifierProviderElement< // _NotifierProviderElement(this.provider, super.container); @override - final _NotifierProvider provider; + final NotifierProviderBase provider; @override void handleError( @@ -185,7 +189,9 @@ class _NotifierProviderElement< // StackTrace stackTrace, { required bool didChangeDependency, }) { - Zone.current.handleUncaughtError(error, stackTrace); + setStateResult(ResultError(error, stackTrace)); + // TODO report uncaught error to the zone + // Zone.current.handleUncaughtError(error, stackTrace); } @override diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 670d921d8..ffbb8d580 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -1,6 +1,7 @@ import 'package:meta/meta.dart'; import '../builder.dart'; +import '../common/result.dart'; import '../framework.dart'; import 'legacy/state_notifier_provider.dart' show StateNotifierProvider; import 'stream_provider.dart' show StreamProvider; @@ -341,11 +342,11 @@ class ProviderElement extends ProviderElementBase { State get state => requireState; @override - set state(State newState) => setState(newState); + set state(State newState) => setStateResult(ResultData(newState)); @override void create({required bool didChangeDependency}) { - setState(provider._create(this)); + setStateResult(ResultData(provider._create(this))); } @override diff --git a/packages/riverpod/test/new/matrix.dart b/packages/riverpod/test/new/matrix.dart index 457be01f1..e995a6508 100644 --- a/packages/riverpod/test/new/matrix.dart +++ b/packages/riverpod/test/new/matrix.dart @@ -5,6 +5,7 @@ import 'package:test/test.dart'; part 'matrix/async_notifier_provider.dart'; part 'matrix/stream_notifier_provider.dart'; +part 'matrix/notifier_provider.dart'; class TestMatrix> { TestMatrix(this.values); @@ -19,9 +20,13 @@ class TestMatrix> { } class TestFactory { - TestFactory({required this.value}); + TestFactory({ + required this.value, + required this.isAutoDispose, + }); final T value; + final bool isAutoDispose; } typedef ProviderFactory diff --git a/packages/riverpod/test/new/matrix/async_notifier_provider.dart b/packages/riverpod/test/new/matrix/async_notifier_provider.dart index 7693dd14b..ba094ea86 100644 --- a/packages/riverpod/test/new/matrix/async_notifier_provider.dart +++ b/packages/riverpod/test/new/matrix/async_notifier_provider.dart @@ -3,6 +3,7 @@ part of '../matrix.dart'; final asyncNotifierProviderFactory = TestMatrix( { 'AsyncNotifierProvider': AsyncNotifierTestFactory( + isAutoDispose: false, deferredNotifier: DeferredAsyncNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return AsyncNotifierProvider, StateT>( @@ -25,6 +26,7 @@ final asyncNotifierProviderFactory = TestMatrix( }, ), 'AsyncNotifierProvider.autoDispose': AsyncNotifierTestFactory( + isAutoDispose: true, deferredNotifier: DeferredAsyncNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return AsyncNotifierProvider.autoDispose, @@ -50,6 +52,7 @@ final asyncNotifierProviderFactory = TestMatrix( }, ), 'AsyncNotifierProvider.family': AsyncNotifierTestFactory( + isAutoDispose: false, deferredNotifier: DeferredFamilyAsyncNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return AsyncNotifierProvider.family, @@ -76,6 +79,7 @@ final asyncNotifierProviderFactory = TestMatrix( }, ), 'AsyncNotifierProvider.autoDispose.family': AsyncNotifierTestFactory( + isAutoDispose: true, deferredNotifier: DeferredFamilyAsyncNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return AsyncNotifierProvider.family @@ -170,6 +174,7 @@ class DeferredFamilyAsyncNotifier class AsyncNotifierTestFactory extends TestFactory< ProviderFactory, ProviderBase, void>> { AsyncNotifierTestFactory({ + required super.isAutoDispose, required super.value, required this.deferredNotifier, required this.deferredProvider, diff --git a/packages/riverpod/test/new/matrix/notifier_provider.dart b/packages/riverpod/test/new/matrix/notifier_provider.dart new file mode 100644 index 000000000..024bd3c0f --- /dev/null +++ b/packages/riverpod/test/new/matrix/notifier_provider.dart @@ -0,0 +1,199 @@ +part of '../matrix.dart'; + +final notifierProviderFactory = TestMatrix( + { + 'NotifierProvider': NotifierTestFactory( + isAutoDispose: false, + deferredNotifier: DeferredNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return NotifierProvider, StateT>( + () => DeferredNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ); + }, + provider: (create) => NotifierProvider, StateT>( + () => create() as Notifier, + ), + value: (create, {name, dependencies}) => ([arg]) { + return NotifierProvider, Object?>( + () => create(null, arg) as Notifier, + name: name, + dependencies: dependencies, + ); + }, + ), + 'NotifierProvider.autoDispose': NotifierTestFactory( + isAutoDispose: true, + deferredNotifier: DeferredNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return NotifierProvider.autoDispose, StateT>( + () => DeferredNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ); + }, + provider: (create) { + return NotifierProvider.autoDispose, StateT>( + () => create() as Notifier, + ); + }, + value: (create, {name, dependencies}) => ([arg]) { + return NotifierProvider.autoDispose, Object?>( + () => create(null, arg) as Notifier, + name: name, + dependencies: dependencies, + ); + }, + ), + 'NotifierProvider.family': NotifierTestFactory( + isAutoDispose: false, + deferredNotifier: DeferredFamilyNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return NotifierProvider.family, StateT, + Object?>( + () => DeferredFamilyNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ).call(42); + }, + provider: (create) { + return NotifierProvider.family, StateT, + Object?>( + () => create() as FamilyNotifier, + ).call(42); + }, + value: (create, {name, dependencies}) => ([arg]) { + return NotifierProvider.family, + Object?, Object?>( + () => create(null, arg) as FamilyNotifier, + name: name, + dependencies: dependencies, + )(arg); + }, + ), + 'NotifierProvider.autoDispose.family': NotifierTestFactory( + isAutoDispose: true, + deferredNotifier: DeferredFamilyNotifier.new, + deferredProvider: (create, {updateShouldNotify}) { + return NotifierProvider.family + .autoDispose, StateT, Object?>( + () => DeferredFamilyNotifier( + create, + updateShouldNotify: updateShouldNotify, + ), + ) + .call(42); + }, + provider: (create) { + return NotifierProvider.autoDispose + .family, StateT, Object?>( + () => create() as FamilyNotifier, + ) + .call(42); + }, + value: (create, {name, dependencies}) => ([arg]) { + return NotifierProvider.autoDispose + .family, Object?, Object?>( + () => create(null, arg) as FamilyNotifier, + name: name, + dependencies: dependencies, + )(arg); + }, + ), + }, +); + +abstract class TestNotifier implements NotifierBase { + // Removing protected + @override + StateT get state; + + @override + set state(StateT value); +} + +class DeferredNotifier extends Notifier + implements TestNotifier { + DeferredNotifier( + this._create, { + bool Function(StateT, StateT)? updateShouldNotify, + }) : _updateShouldNotify = updateShouldNotify; + + final StateT Function(Ref ref) _create; + final bool Function( + StateT previousState, + StateT newState, + )? _updateShouldNotify; + + @override + StateT build() => _create(ref); + + @override + bool updateShouldNotify(StateT previousState, StateT newState) => + _updateShouldNotify?.call(previousState, newState) ?? + super.updateShouldNotify(previousState, newState); +} + +class DeferredFamilyNotifier extends FamilyNotifier + implements TestNotifier { + DeferredFamilyNotifier( + this._create, { + bool Function(StateT, StateT)? updateShouldNotify, + }) : _updateShouldNotify = updateShouldNotify; + + final StateT Function(Ref ref) _create; + + final bool Function( + StateT previousState, + StateT newState, + )? _updateShouldNotify; + + @override + StateT build(int arg) => _create(ref); + + @override + bool updateShouldNotify( + StateT previousState, + StateT newState, + ) => + _updateShouldNotify?.call(previousState, newState) ?? + super.updateShouldNotify(previousState, newState); +} + +class NotifierTestFactory extends TestFactory< + ProviderFactory, ProviderBase, void>> { + NotifierTestFactory({ + required super.isAutoDispose, + required super.value, + required this.deferredNotifier, + required this.deferredProvider, + required this.provider, + }); + + final TestNotifier Function( + StateT Function(Ref ref) create, + ) deferredNotifier; + + final NotifierProviderBase, StateT> Function( + StateT Function(Ref ref) create, { + bool Function(StateT, StateT)? updateShouldNotify, + }) deferredProvider; + + final NotifierProviderBase, StateT> Function( + NotifierBase Function() create, + ) provider; + + NotifierProviderBase, StateT> simpleTestProvider( + StateT Function(Ref ref) create, { + bool Function(StateT, StateT)? updateShouldNotify, + }) { + return deferredProvider( + (ref) => create(ref), + updateShouldNotify: updateShouldNotify, + ); + } +} diff --git a/packages/riverpod/test/new/matrix/stream_notifier_provider.dart b/packages/riverpod/test/new/matrix/stream_notifier_provider.dart index d3b4f2c64..c9245ded8 100644 --- a/packages/riverpod/test/new/matrix/stream_notifier_provider.dart +++ b/packages/riverpod/test/new/matrix/stream_notifier_provider.dart @@ -3,6 +3,7 @@ part of '../matrix.dart'; final streamNotifierProviderFactory = TestMatrix( { 'StreamNotifierProvider': StreamNotifierTestFactory( + isAutoDispose: false, deferredNotifier: DeferredStreamNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return StreamNotifierProvider, StateT>( @@ -25,6 +26,7 @@ final streamNotifierProviderFactory = TestMatrix( }, ), 'StreamNotifierProvider.autoDispose': StreamNotifierTestFactory( + isAutoDispose: true, deferredNotifier: DeferredStreamNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return StreamNotifierProvider.autoDispose< @@ -51,6 +53,7 @@ final streamNotifierProviderFactory = TestMatrix( }, ), 'StreamNotifierProvider.family': StreamNotifierTestFactory( + isAutoDispose: false, deferredNotifier: DeferredFamilyStreamNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return StreamNotifierProvider.family< @@ -77,6 +80,7 @@ final streamNotifierProviderFactory = TestMatrix( }, ), 'StreamNotifierProvider.autoDispose.family': StreamNotifierTestFactory( + isAutoDispose: true, deferredNotifier: DeferredFamilyStreamNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return StreamNotifierProvider.family @@ -172,6 +176,7 @@ class DeferredFamilyStreamNotifier class StreamNotifierTestFactory extends TestFactory< ProviderFactory, ProviderBase, void>> { StreamNotifierTestFactory({ + required super.isAutoDispose, required super.value, required this.deferredNotifier, required this.deferredProvider, diff --git a/packages/riverpod/test/old/framework/provider_element_test.dart b/packages/riverpod/test/old/framework/provider_element_test.dart index 7c1d2e7ea..74c57cdcf 100644 --- a/packages/riverpod/test/old/framework/provider_element_test.dart +++ b/packages/riverpod/test/old/framework/provider_element_test.dart @@ -1190,7 +1190,7 @@ void main() { final element = container.readProviderElement(provider); expect( - element.getState(), + element.stateResult, isA>() .having((e) => e.error, 'error', isUnimplementedError), ); diff --git a/packages/riverpod/test/old/legacy_providers/notifier/factory.dart b/packages/riverpod/test/old/legacy_providers/notifier/factory.dart deleted file mode 100644 index 231db6f3e..000000000 --- a/packages/riverpod/test/old/legacy_providers/notifier/factory.dart +++ /dev/null @@ -1,288 +0,0 @@ -import 'package:riverpod/src/internals.dart'; - -typedef NotifierProviderFactoryType = _NotifierProviderBase - Function, T>( - NotifierT Function() create, { - Iterable? dependencies, - String? name, -}); - -typedef NotifierFactoryType = TestNotifierBase Function( - T Function(NotifierProviderRef), { - bool Function(T, T)? updateShouldNotify, -}); - -typedef SimpleTestProviderFactoryType - = _NotifierProviderBase, T> Function( - T Function(NotifierProviderRef ref) init, { - bool Function(T prev, T next)? updateShouldNotify, -}); - -typedef TestProviderFactoryType = _NotifierProviderBase, T> - Function( - TestNotifierBase Function() createNotifier, -); - -List matrix({ - bool alwaysAlive = true, - bool autoDispose = true, -}) { - return [ - if (alwaysAlive) - NotifierFactory( - label: 'NotifierProvider', - isAutoDispose: false, - provider: NotifierProvider.new, - notifier: TestNotifier.new, - testProvider: (createNotifier) { - return NotifierProvider, T>( - createNotifier, - ); - }, - simpleTestProvider: (init, {updateShouldNotify}) { - return NotifierProvider, T>( - () => TestNotifier( - init, - updateShouldNotify: updateShouldNotify, - ), - ); - }, - ), - if (alwaysAlive) - NotifierFactory( - label: 'NotifierProviderFamily', - isAutoDispose: false, - provider: , T>( - create, { - argument, - dependencies, - from, - name, - }) { - return FamilyNotifierProviderImpl.internal( - create, - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - notifier: TestNotifierFamily.new, - testProvider: (createNotifier) { - return FamilyNotifierProviderImpl, T, - int>.internal( - () => createNotifier() as TestNotifierFamily, - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - simpleTestProvider: (init, {updateShouldNotify}) { - return FamilyNotifierProviderImpl, T, - int>.internal( - () => TestNotifierFamily( - init, - updateShouldNotify: updateShouldNotify, - ), - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - ), - if (autoDispose) - NotifierFactory( - label: 'AutoDisposeNotifierProvider', - isAutoDispose: true, - provider: AutoDisposeNotifierProviderImpl.new, - notifier: AutoDisposeTestNotifier.new, - testProvider: (createNotifier) { - return AutoDisposeNotifierProviderImpl, T>( - () => createNotifier() as AutoDisposeTestNotifier, - ); - }, - simpleTestProvider: (init, {updateShouldNotify}) { - return AutoDisposeNotifierProvider, T>( - () => AutoDisposeTestNotifier( - init, - updateShouldNotify: updateShouldNotify, - ), - ); - }, - ), - if (autoDispose) - NotifierFactory( - label: 'AutoDisposeNotifierProviderFamily', - isAutoDispose: true, - provider: , T>( - create, { - argument, - dependencies, - from, - name, - }) { - return AutoDisposeFamilyNotifierProviderImpl.internal( - create, - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - notifier: AutoDisposeTestNotifierFamily.new, - testProvider: (createNotifier) { - return AutoDisposeFamilyNotifierProviderImpl< - AutoDisposeTestNotifierFamily, T, int>.internal( - () => createNotifier() as AutoDisposeTestNotifierFamily, - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - simpleTestProvider: (init, {updateShouldNotify}) { - return AutoDisposeFamilyNotifierProviderImpl< - AutoDisposeTestNotifierFamily, T, int>.internal( - () => AutoDisposeTestNotifierFamily( - init, - updateShouldNotify: updateShouldNotify, - ), - argument: 0, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ); - }, - ), - ]; -} - -class NotifierFactory { - const NotifierFactory({ - required this.label, - required this.provider, - required this.notifier, - required this.isAutoDispose, - required this.testProvider, - required this.simpleTestProvider, - }); - - final String label; - final bool isAutoDispose; - final NotifierProviderFactoryType provider; - final NotifierFactoryType notifier; - final TestProviderFactoryType testProvider; - final SimpleTestProviderFactoryType simpleTestProvider; -} - -abstract class TestNotifierBase extends _NotifierBase {} - -class TestNotifier extends Notifier implements TestNotifierBase { - TestNotifier(this._init, {bool Function(T prev, T next)? updateShouldNotify}) - : _updateShouldNotify = updateShouldNotify; - - final T Function(NotifierProviderRef ref) _init; - - final bool Function(T prev, T next)? _updateShouldNotify; - - @override - T build() => _init(ref); - - @override - bool updateShouldNotify(T previous, T next) { - return _updateShouldNotify?.call(previous, next) ?? - super.updateShouldNotify(previous, next); - } - - @override - String toString() { - return 'TestNotifier<$T>#$hashCode'; - } -} - -class TestNotifierFamily extends FamilyNotifier - implements TestNotifierBase { - TestNotifierFamily( - this._init, { - bool Function(T prev, T next)? updateShouldNotify, - }) : _updateShouldNotify = updateShouldNotify; - - final T Function(NotifierProviderRef ref) _init; - - final bool Function(T prev, T next)? _updateShouldNotify; - - @override - T build(int arg) => _init(ref); - - @override - bool updateShouldNotify(T previous, T next) { - return _updateShouldNotify?.call(previous, next) ?? - super.updateShouldNotify(previous, next); - } - - @override - String toString() { - return 'TestNotifierFamily<$T>#$hashCode'; - } -} - -class AutoDisposeTestNotifier extends AutoDisposeNotifier - implements TestNotifierBase { - AutoDisposeTestNotifier( - this._init2, { - bool Function(T prev, T next)? updateShouldNotify, - }) : _updateShouldNotify = updateShouldNotify; - - final T Function(AutoDisposeNotifierProviderRef ref) _init2; - - final bool Function(T prev, T next)? _updateShouldNotify; - - @override - T build() => _init2(ref); - - @override - bool updateShouldNotify(T previous, T next) { - return _updateShouldNotify?.call(previous, next) ?? - super.updateShouldNotify(previous, next); - } - - @override - String toString() { - return 'AutoDisposeTestNotifier<$T>#$hashCode'; - } -} - -class AutoDisposeTestNotifierFamily extends AutoDisposeFamilyNotifier - implements TestNotifierBase { - AutoDisposeTestNotifierFamily( - this._init2, { - bool Function(T prev, T next)? updateShouldNotify, - }) : _updateShouldNotify = updateShouldNotify; - - final T Function(AutoDisposeNotifierProviderRef ref) _init2; - - final bool Function(T prev, T next)? _updateShouldNotify; - - @override - T build(int arg) => _init2(ref); - - @override - bool updateShouldNotify(T previous, T next) { - return _updateShouldNotify?.call(previous, next) ?? - super.updateShouldNotify(previous, next); - } - - @override - String toString() { - return 'AutoDisposeTestNotifierFamily<$T, int>#$hashCode'; - } -} diff --git a/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart b/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart index 0716402a7..c5e717cfd 100644 --- a/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart +++ b/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart @@ -2,11 +2,12 @@ import 'package:meta/meta.dart'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; +import '../../../new/matrix.dart'; import '../../utils.dart'; -import 'factory.dart'; void main() { test('Throws if using notifier properties in its constructor', () { @@ -14,524 +15,504 @@ void main() { CtorNotifier.new, throwsA(isA()), ); - expect( - AutoDisposeCtorNotifier.new, - throwsA(isA()), - ); - expect( - AutoDisposeFamilyCtorNotifier.new, - throwsA(isA()), - ); expect( FamilyCtorNotifier.new, throwsA(isA()), ); }); - for (final factory in matrix()) { - group(factory.label, () { - test('Cannot share a Notifier instance between providers ', () { - final container = ProviderContainer.test(); - final notifier = factory.notifier((ref) => 0); + notifierProviderFactory.createGroup((factory) { + test('Cannot share a Notifier instance between providers ', () { + final container = ProviderContainer.test(); + final notifier = factory.deferredNotifier((ref) => 0); - final provider = factory.provider, int>( - () => notifier, - ); - final provider2 = factory.provider, int>( - () => notifier, - ); + final provider = factory.provider(() => notifier); + final provider2 = factory.provider(() => notifier); - container.read(provider); + container.read(provider); - expect( - () => container.read(provider2), - throwsA(isA()), - ); - }); + expect( + () => container.read(provider2), + throwsA(isA()), + ); + }); - test('Can read state inside onDispose', () { - final container = ProviderContainer.test(); - late TestNotifierBase notifier; - final provider = factory.simpleTestProvider((ref) { - ref.onDispose(() { - notifier.state; - }); - return 0; + test('Can read state inside onDispose', () { + final container = ProviderContainer.test(); + late TestNotifier notifier; + final provider = factory.simpleTestProvider((ref) { + ref.onDispose(() { + notifier.state; }); - - container.listen(provider.notifier, (prev, next) {}); - notifier = container.read(provider.notifier); - - container.dispose(); + return 0; }); - test('Using the notifier after dispose throws', () { - final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider((ref) => 0); + container.listen(provider.notifier, (prev, next) {}); + notifier = container.read(provider.notifier); - container.listen(provider.notifier, (prev, next) {}); - final notifier = container.read(provider.notifier); + container.dispose(); + }); - container.dispose(); + test('Using the notifier after dispose throws', () { + final container = ProviderContainer.test(); + final provider = factory.simpleTestProvider((ref) => 0); - expect(() => notifier.state, throwsStateError); - expect(() => notifier.stateOrNull, throwsStateError); - expect(() => notifier.state = 42, throwsStateError); - // ignore: invalid_use_of_protected_member - expect(() => notifier.ref, throwsStateError); - }); - - test( - 'throws if the same Notifier instance is reused in different providers', - () { - // Regression test for https://github.com/rrousselGit/riverpod/issues/2617 - final container = ProviderContainer.test(); + container.listen(provider.notifier, (prev, next) {}); + final notifier = container.read(provider.notifier); - final notifier = factory.notifier((ref) => 0); + container.dispose(); - final provider = factory.provider, int>( - () => notifier, - ); - final provider2 = factory.provider, int>( - () => notifier, - ); + expect(() => notifier.state, throwsStateError); + expect(() => notifier.stateOrNull, throwsStateError); + expect(() => notifier.state = 42, throwsStateError); + // ignore: invalid_use_of_protected_member + expect(() => notifier.ref, throwsStateError); + }); - container.read(provider); + test( + 'throws if the same Notifier instance is reused in different providers', + () { + // Regression test for https://github.com/rrousselGit/riverpod/issues/2617 + final container = ProviderContainer.test(); - expect( - () => container.read(provider2), - throwsA(isA()), - ); - }); + final notifier = factory.deferredNotifier((ref) => 0); - group('Notifier.stateOrNull', () { - test('returns null during first build until state= is set', () { - final stateInBuild = []; + final provider = factory.provider(() => notifier); + final provider2 = factory.provider(() => notifier); - final provider = NotifierProvider, int>(() { - late TestNotifier notifier; - return notifier = TestNotifier((ref) { - stateInBuild.add(notifier.stateOrNull); - return 0; - }); - }); - final container = ProviderContainer.test(); + container.read(provider); - final sub = container.listen( - provider.notifier, - (_, __) {}, - ); + expect( + () => container.read(provider2), + throwsA(isA()), + ); + }); - expect(stateInBuild, [null]); + group('Notifier.stateOrNull', () { + // TODO should use matrix + test('returns null during first build until state= is set', () { + final stateInBuild = []; - expect(sub.read().stateOrNull, 0); + final provider = factory.provider(() { + late TestNotifier notifier; + return notifier = factory.deferredNotifier((ref) { + stateInBuild.add(notifier.stateOrNull); + return 0; + }); }); + final container = ProviderContainer.test(); - test('returns null if Notifier.build threw', () { - final provider = factory.simpleTestProvider( - (ref) => throw Exception('42'), - ); - final container = ProviderContainer.test(); + final sub = container.listen( + provider.notifier, + (_, __) {}, + ); - final sub = container.listen( - provider.notifier, - (_, __) {}, - ); + expect(stateInBuild, [null]); - expect(sub.read().stateOrNull, null); - }); + expect(sub.read().stateOrNull, 0); + }); - test( - 'returns the previous state if using inside Notifier.build ' - 'after the state was already initialized', () { - final stateInBuild = []; - - final provider = NotifierProvider, int>(() { - late TestNotifier notifier; - return notifier = TestNotifier((ref) { - stateInBuild.add(notifier.stateOrNull); - return 0; - }); - }); - final container = ProviderContainer.test(); + test('returns null if Notifier.build threw', () { + final provider = factory.simpleTestProvider( + (ref) => throw Exception('42'), + ); + final container = ProviderContainer.test(); - final sub = container.listen( - provider.notifier, - (_, __) {}, - ); + final sub = container.listen( + provider.notifier, + (_, __) {}, + ); - sub.read().state = 42; - container.refresh(provider); + expect(sub.read().stateOrNull, null); + }); - expect(stateInBuild, [null, 42]); + test( + 'returns the previous state if using inside Notifier.build ' + 'after the state was already initialized', () { + final stateInBuild = []; + + final provider = factory.provider(() { + late TestNotifier notifier; + return notifier = factory.deferredNotifier((ref) { + stateInBuild.add(notifier.stateOrNull); + return 0; + }); }); + final container = ProviderContainer.test(); - test('Post build, returns the current state', () { - final provider = factory.simpleTestProvider( - (ref) => 0, - ); - final container = ProviderContainer.test(); - - final sub = container.listen( - provider.notifier, - (_, __) {}, - ); - - expect(sub.read().stateOrNull, 0); - - sub.read().state = 42; + final sub = container.listen( + provider.notifier, + (_, __) {}, + ); - expect(sub.read().stateOrNull, 42); - }); + sub.read().state = 42; + container.refresh(provider); - test( - 'On invalidated providers, rebuilds the notifier and return the new state', - () { - final provider = factory.simpleTestProvider( - (ref) => 0, - ); - final container = ProviderContainer.test(); + expect(stateInBuild, [null, 42]); + }); - final sub = container.listen( - provider.notifier, - (_, __) {}, - ); + test('Post build, returns the current state', () { + final provider = factory.simpleTestProvider( + (ref) => 0, + ); + final container = ProviderContainer.test(); - sub.read().state = 42; + final sub = container.listen( + provider.notifier, + (_, __) {}, + ); - expect(sub.read().stateOrNull, 42); + expect(sub.read().stateOrNull, 0); - container.invalidate(provider); + sub.read().state = 42; - expect(sub.read().stateOrNull, 0); - }); + expect(sub.read().stateOrNull, 42); }); test( - 'uses notifier.build as initial state and update listeners when state changes', + 'On invalidated providers, rebuilds the notifier and return the new state', () { - final provider = factory.simpleTestProvider((ref) => 0); + final provider = factory.simpleTestProvider( + (ref) => 0, + ); final container = ProviderContainer.test(); - final listener = Listener(); - container.listen(provider, listener.call, fireImmediately: true); + final sub = container.listen( + provider.notifier, + (_, __) {}, + ); + + sub.read().state = 42; - verifyOnly(listener, listener(null, 0)); + expect(sub.read().stateOrNull, 42); - container.read(provider.notifier).state++; + container.invalidate(provider); - verifyOnly(listener, listener(0, 1)); + expect(sub.read().stateOrNull, 0); }); + }); - test('preserves the notifier between watch updates', () async { - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider((ref) { - return ref.watch(dep); - }); - final container = ProviderContainer.test(); - final listener = Listener>(); + test( + 'uses notifier.build as initial state and update listeners when state changes', + () { + final provider = factory.simpleTestProvider((ref) => 0); + final container = ProviderContainer.test(); + final listener = Listener(); - container.listen( - provider.notifier, - listener.call, - fireImmediately: true, - ); + container.listen(provider, listener.call, fireImmediately: true); - final notifier = container.read(provider.notifier); + verifyOnly(listener, listener(null, 0)); - verifyOnly(listener, listener(null, notifier)); + container.read(provider.notifier).state++; - container.read(dep.notifier).update((state) => state + 1); - await container.pump(); + verifyOnly(listener, listener(0, 1)); + }); - verifyNoMoreInteractions(listener); - expect(container.read(provider.notifier), notifier); + test('preserves the notifier between watch updates', () async { + final dep = StateProvider((ref) => 0); + final provider = factory.simpleTestProvider((ref) { + return ref.watch(dep); }); + final container = ProviderContainer.test(); + final listener = Listener>(); - test('calls notifier.build on every watch update', () async { - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider((ref) { - return ref.watch(dep); - }); - final container = ProviderContainer.test(); - final listener = Listener(); - - container.listen(provider, listener.call, fireImmediately: true); + container.listen( + provider.notifier, + listener.call, + fireImmediately: true, + ); - verifyOnly(listener, listener(null, 0)); + final notifier = container.read(provider.notifier); - container.read(dep.notifier).update((state) => state + 1); + verifyOnly(listener, listener(null, notifier)); - verifyNoMoreInteractions(listener); + container.read(dep.notifier).update((state) => state + 1); + await container.pump(); - await container.pump(); + verifyNoMoreInteractions(listener); + expect(container.read(provider.notifier), notifier); + }); - verifyOnly(listener, listener(0, 1)); + test('calls notifier.build on every watch update', () async { + final dep = StateProvider((ref) => 0); + final provider = factory.simpleTestProvider((ref) { + return ref.watch(dep); }); + final container = ProviderContainer.test(); + final listener = Listener(); - test( - 'After a state initialization error, the notifier is still available', - () { - final provider = factory.simpleTestProvider((ref) { - throw StateError('Hey'); - }); - final container = ProviderContainer.test(); + container.listen(provider, listener.call, fireImmediately: true); - expect( - () => container.read(provider), - throwsStateError, - ); + verifyOnly(listener, listener(null, 0)); + + container.read(dep.notifier).update((state) => state + 1); - container.read(provider.notifier); + verifyNoMoreInteractions(listener); + + await container.pump(); + + verifyOnly(listener, listener(0, 1)); + }); + + test('After a state initialization error, the notifier is still available', + () { + final provider = factory.simpleTestProvider((ref) { + throw StateError('Hey'); }); + final container = ProviderContainer.test(); - test('handles fail to initialize the notifier', () { - final err = UnimplementedError(); - final stack = StackTrace.current; - final provider = factory.provider, int>( - () => Error.throwWithStackTrace(err, stack), - ); - final container = ProviderContainer.test(); - final listener = ErrorListener(); + expect( + () => container.read(provider), + throwsStateError, + ); - expect( - () => container.read(provider.notifier), - throwsUnimplementedError, - ); - expect( - () => container.read(provider), - throwsUnimplementedError, - ); + container.read(provider.notifier); + }); - final stateSub = container.listen( - provider, - (previous, next) {}, - onError: listener.call, - ); + test('handles fail to initialize the notifier', () { + final err = UnimplementedError(); + final stack = StackTrace.current; + final provider = factory.provider( + () => Error.throwWithStackTrace(err, stack), + ); + final container = ProviderContainer.test(); + final listener = ErrorListener(); - verifyNoMoreInteractions(listener); + expect( + () => container.read(provider.notifier), + throwsUnimplementedError, + ); + expect( + () => container.read(provider), + throwsUnimplementedError, + ); - container.listen( - provider, - (previous, next) {}, - onError: listener.call, - fireImmediately: true, - ); + final stateSub = container.listen( + provider, + (previous, next) {}, + onError: listener.call, + ); - verifyOnly(listener, listener(err, stack)); + verifyNoMoreInteractions(listener); - final notifierSub = container.listen( - provider.notifier, - (previous, next) {}, - onError: listener.call, - ); + container.listen( + provider, + (previous, next) {}, + onError: listener.call, + fireImmediately: true, + ); - verifyNoMoreInteractions(listener); + verifyOnly(listener, listener(err, stack)); - container.listen( - provider.notifier, - (previous, next) {}, - onError: listener.call, - fireImmediately: true, - ); + final notifierSub = container.listen( + provider.notifier, + (previous, next) {}, + onError: listener.call, + ); - verifyOnly(listener, listener(err, stack)); + verifyNoMoreInteractions(listener); - expect(stateSub.read, throwsUnimplementedError); - expect(notifierSub.read, throwsUnimplementedError); - }); + container.listen( + provider.notifier, + (previous, next) {}, + onError: listener.call, + fireImmediately: true, + ); - test('can read/set the current state within the notifier', () { - final provider = factory.simpleTestProvider((ref) => 0); - final container = ProviderContainer.test(); - final listener = Listener(); + verifyOnly(listener, listener(err, stack)); - container.listen(provider, listener.call, fireImmediately: true); - final notifier = container.read(provider.notifier); + expect(stateSub.read, throwsUnimplementedError); + expect(notifierSub.read, throwsUnimplementedError); + }); - expect(notifier.state, 0); - verifyOnly(listener, listener(null, 0)); + test('can read/set the current state within the notifier', () { + final provider = factory.simpleTestProvider((ref) => 0); + final container = ProviderContainer.test(); + final listener = Listener(); - notifier.state++; + container.listen(provider, listener.call, fireImmediately: true); + final notifier = container.read(provider.notifier); - expect(notifier.state, 1); - verifyOnly(listener, listener(0, 1)); + expect(notifier.state, 0); + verifyOnly(listener, listener(null, 0)); - notifier.state++; + notifier.state++; - expect(notifier.state, 2); - verifyOnly(listener, listener(1, 2)); - }); + expect(notifier.state, 1); + verifyOnly(listener, listener(0, 1)); - test( - 'Reading the state inside the notifier rethrows initialization error, if any', - () { - final provider = factory - .simpleTestProvider((ref) => throw UnimplementedError()); - final container = ProviderContainer.test(); + notifier.state++; - final notifier = container.read(provider.notifier); + expect(notifier.state, 2); + verifyOnly(listener, listener(1, 2)); + }); - expect(() => notifier.state, throwsUnimplementedError); - }); + test( + 'Reading the state inside the notifier rethrows initialization error, if any', + () { + final provider = + factory.simpleTestProvider((ref) => throw UnimplementedError()); + final container = ProviderContainer.test(); - test( - 'Setting the state after an initialization error allow listening the state again', - () { - final err = UnimplementedError(); - final stack = StackTrace.current; - final provider = factory.simpleTestProvider( - (ref) => Error.throwWithStackTrace(err, stack), - ); - final container = ProviderContainer.test(); - final listener = Listener(); - final onError = ErrorListener(); - - container.listen( - provider, - listener.call, - onError: onError.call, - fireImmediately: true, - ); - final notifier = container.read(provider.notifier); + final notifier = container.read(provider.notifier); - verifyOnly(onError, onError(err, stack)); - verifyZeroInteractions(listener); + expect(() => notifier.state, throwsUnimplementedError); + }); - expect(() => notifier.state, throwsUnimplementedError); + test( + 'Setting the state after an initialization error allow listening the state again', + () { + final err = UnimplementedError(); + final stack = StackTrace.current; + final provider = factory.simpleTestProvider( + (ref) => Error.throwWithStackTrace(err, stack), + ); + final container = ProviderContainer.test(); + final listener = Listener(); + final onError = ErrorListener(); + + container.listen( + provider, + listener.call, + onError: onError.call, + fireImmediately: true, + ); + final notifier = container.read(provider.notifier); - notifier.state = 0; + verifyOnly(onError, onError(err, stack)); + verifyZeroInteractions(listener); - verifyOnly(listener, listener(null, 0)); - verifyNoMoreInteractions(onError); - expect(notifier.state, 0); - expect(container.read(provider), 0); + expect(() => notifier.state, throwsUnimplementedError); - container.listen( - provider, - listener.call, - onError: onError.call, - fireImmediately: true, - ); + notifier.state = 0; - verifyOnly(listener, listener(null, 0)); - verifyNoMoreInteractions(onError); - }); + verifyOnly(listener, listener(null, 0)); + verifyNoMoreInteractions(onError); + expect(notifier.state, 0); + expect(container.read(provider), 0); - test( - 'reading notifier.state on invalidated provider rebuilds the provider', - () { - final dep = StateProvider((ref) => 0); - final provider = - factory.simpleTestProvider((ref) => ref.watch(dep)); - final container = ProviderContainer.test(); - final listener = Listener(); + container.listen( + provider, + listener.call, + onError: onError.call, + fireImmediately: true, + ); - container.listen(provider, listener.call); - final notifier = container.read(provider.notifier); + verifyOnly(listener, listener(null, 0)); + verifyNoMoreInteractions(onError); + }); - expect(notifier.state, 0); + test('reading notifier.state on invalidated provider rebuilds the provider', + () { + final dep = StateProvider((ref) => 0); + final provider = factory.simpleTestProvider((ref) => ref.watch(dep)); + final container = ProviderContainer.test(); + final listener = Listener(); - notifier.state = -1; + container.listen(provider, listener.call); + final notifier = container.read(provider.notifier); - verifyOnly(listener, listener(0, -1)); + expect(notifier.state, 0); - container.read(dep.notifier).state++; + notifier.state = -1; - expect(notifier.state, 1); - verifyOnly(listener, listener(-1, 1)); - }); + verifyOnly(listener, listener(0, -1)); - test('supports ref.refresh(provider)', () { - final provider = factory.simpleTestProvider((ref) => 0); - final container = ProviderContainer.test(); + container.read(dep.notifier).state++; - final notifier = container.read(provider.notifier); + expect(notifier.state, 1); + verifyOnly(listener, listener(-1, 1)); + }); - expect(container.read(provider), 0); + test('supports ref.refresh(provider)', () { + final provider = factory.simpleTestProvider((ref) => 0); + final container = ProviderContainer.test(); - notifier.state = 42; + final notifier = container.read(provider.notifier); - expect(container.read(provider), 42); + expect(container.read(provider), 0); - expect(container.refresh(provider), 0); - expect(container.read(provider), 0); - expect(notifier.state, 0); - expect(container.read(provider.notifier), notifier); - }); + notifier.state = 42; - test('supports listenSelf((State? prev, State next) {})', () { - final listener = Listener(); - final onError = ErrorListener(); - final provider = factory.simpleTestProvider((ref) { - ref.listenSelf(listener.call, onError: onError.call); - Error.throwWithStackTrace(42, StackTrace.empty); - }); - final container = ProviderContainer.test(); + expect(container.read(provider), 42); - expect(() => container.read(provider), throwsA(42)); + expect(container.refresh(provider), 0); + expect(container.read(provider), 0); + expect(notifier.state, 0); + expect(container.read(provider.notifier), notifier); + }); - verifyOnly(onError, onError(42, StackTrace.empty)); + test('supports listenSelf((State? prev, State next) {})', () { + final listener = Listener(); + final onError = ErrorListener(); + final provider = factory.simpleTestProvider((ref) { + ref.listenSelf(listener.call, onError: onError.call); + Error.throwWithStackTrace(42, StackTrace.empty); }); + final container = ProviderContainer.test(); - test('filters state update by identical by default', () { - final provider = - factory.simpleTestProvider>((ref) => Equal(42)); - final container = ProviderContainer.test(); - final listener = Listener>(); + expect(() => container.read(provider), throwsA(42)); - container.listen(provider, listener.call); - final notifier = container.read(provider.notifier); - final firstState = notifier.state; + verifyOnly(onError, onError(42, StackTrace.empty)); + }); - // voluntarily assigning the same value - final self = notifier.state; - notifier.state = self; + test('filters state update by identical by default', () { + final provider = + factory.simpleTestProvider>((ref) => Equal(42)); + final container = ProviderContainer.test(); + final listener = Listener>(); - verifyZeroInteractions(listener); + container.listen(provider, listener.call); + final notifier = container.read(provider.notifier); + final firstState = notifier.state; - final secondState = notifier.state = Equal(42); + // voluntarily assigning the same value + final self = notifier.state; + notifier.state = self; - verifyOnly(listener, listener(firstState, secondState)); - }); + verifyZeroInteractions(listener); - test( - 'Can override Notifier.updateShouldNotify to change the default filter logic', - () { - final provider = factory.simpleTestProvider>( - (ref) => Equal(42), - updateShouldNotify: (a, b) => a != b, - ); - final container = ProviderContainer.test(); - final listener = Listener>(); + final secondState = notifier.state = Equal(42); - container.listen(provider, listener.call); - final notifier = container.read(provider.notifier); + verifyOnly(listener, listener(firstState, secondState)); + }); - // voluntarily assigning the same value - final self = notifier.state; - notifier.state = self; + test( + 'Can override Notifier.updateShouldNotify to change the default filter logic', + () { + final provider = factory.simpleTestProvider>( + (ref) => Equal(42), + updateShouldNotify: (a, b) => a != b, + ); + final container = ProviderContainer.test(); + final listener = Listener>(); - verifyZeroInteractions(listener); + container.listen(provider, listener.call); + final notifier = container.read(provider.notifier); - notifier.state = Equal(42); + // voluntarily assigning the same value + final self = notifier.state; + notifier.state = self; - verifyZeroInteractions(listener); + verifyZeroInteractions(listener); - notifier.state = Equal(21); + notifier.state = Equal(42); - verifyOnly(listener, listener(Equal(42), Equal(21))); - }); + verifyZeroInteractions(listener); - test( - 'can override the Notifier with a matching custom implementation', - () {}, - skip: 'TODO', - ); + notifier.state = Equal(21); - test('can override Notifier.build', () {}); + verifyOnly(listener, listener(Equal(42), Equal(21))); }); + test( + 'can override the Notifier with a matching custom implementation', + () {}, + skip: 'TODO', + ); + + test('can override Notifier.build', () {}); + if (factory.isAutoDispose) { group('autoDispose', () { test('keeps state alive if notifier is listened', () async { @@ -559,21 +540,21 @@ void main() { }); }); } - } + }); test('supports overrideWith', () { - final provider = NotifierProvider, int>( - () => TestNotifier((ref) => 0), + final provider = NotifierProvider, int>( + () => DeferredNotifier((ref) => 0), ); final autoDispose = - NotifierProvider.autoDispose, int>( - () => AutoDisposeTestNotifier((ref) => 0), + NotifierProvider.autoDispose, int>( + () => DeferredNotifier((ref) => 0), ); final container = ProviderContainer.test( overrides: [ - provider.overrideWith(() => TestNotifier((ref) => 42)), + provider.overrideWith(() => DeferredNotifier((ref) => 42)), autoDispose.overrideWith( - () => AutoDisposeTestNotifier((ref) => 84), + () => DeferredNotifier((ref) => 84), ), ], ); @@ -583,20 +564,21 @@ void main() { }); test('supports family overrideWith', () { - final family = NotifierProvider.family, int, int>( - () => TestNotifierFamily((ref) => 0), + final family = + NotifierProvider.family, int, int>( + () => DeferredFamilyNotifier((ref) => 0), ); final autoDisposeFamily = NotifierProvider.autoDispose - .family, int, int>( - () => AutoDisposeTestNotifierFamily((ref) => 0), + .family, int, int>( + () => DeferredFamilyNotifier((ref) => 0), ); final container = ProviderContainer.test( overrides: [ family.overrideWith( - () => TestNotifierFamily((ref) => 42), + () => DeferredFamilyNotifier((ref) => 42), ), autoDisposeFamily.overrideWith( - () => AutoDisposeTestNotifierFamily((ref) => 84), + () => DeferredFamilyNotifier((ref) => 84), ), ], ); @@ -615,8 +597,8 @@ void main() { ) {} test('provider', () { - final provider = NotifierProvider, int>( - () => TestNotifier((ref) => 0), + final provider = NotifierProvider, int>( + () => DeferredNotifier((ref) => 0), ); provider.select((int value) => 0); @@ -630,8 +612,8 @@ void main() { test('autoDispose', () { final autoDispose = - NotifierProvider.autoDispose, int>( - () => AutoDisposeTestNotifier((ref) => 0), + NotifierProvider.autoDispose, int>( + () => DeferredNotifier((ref) => 0), ); autoDispose.select((int value) => 0); @@ -639,18 +621,18 @@ void main() { canBeAssignedToProviderListenable(autoDispose); canBeAssignedToRefreshable(autoDispose); - canBeAssignedToProviderListenable>( + canBeAssignedToProviderListenable>( autoDispose.notifier, ); - canBeAssignedToRefreshable>( + canBeAssignedToRefreshable>( autoDispose.notifier, ); }); test('family', () { final family = - NotifierProvider.family, String, int>( - () => TestNotifierFamily((ref) => '0'), + NotifierProvider.family, String, int>( + () => DeferredFamilyNotifier((ref) => '0'), ); family(0).select((String value) => 0); @@ -673,8 +655,8 @@ void main() { ); final autoDisposeFamily = NotifierProvider.autoDispose - .family, String, int>( - () => AutoDisposeTestNotifierFamily((ref) => '0'), + .family, String, int>( + () => DeferredFamilyNotifier((ref) => '0'), ); autoDisposeFamily(0).select((String value) => 0); @@ -686,10 +668,10 @@ void main() { autoDisposeFamily(0), ); - canBeAssignedToProviderListenable>( + canBeAssignedToProviderListenable>( autoDisposeFamily(0).notifier, ); - canBeAssignedToRefreshable>( + canBeAssignedToRefreshable>( autoDisposeFamily(0).notifier, ); }); @@ -719,25 +701,6 @@ class CtorNotifier extends Notifier { int build() => 0; } -class AutoDisposeCtorNotifier extends AutoDisposeNotifier { - AutoDisposeCtorNotifier() { - state; - } - - @override - int build() => 0; -} - -class AutoDisposeFamilyCtorNotifier - extends AutoDisposeFamilyNotifier { - AutoDisposeFamilyCtorNotifier() { - state; - } - - @override - int build(int arg) => 0; -} - class FamilyCtorNotifier extends FamilyNotifier { FamilyCtorNotifier() { state; From 81d7bca431672593494afa9443bcb8e6f6d3a376 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 1 Feb 2024 16:18:51 +0100 Subject: [PATCH 144/387] Fix some lints --- packages/riverpod/lib/src/builder.dart | 10 ++++++---- packages/riverpod/lib/src/core/element.dart | 4 +--- .../riverpod/lib/src/providers/future_provider.dart | 4 +++- packages/riverpod/test/new/core/overrides_test.dart | 2 +- .../riverpod/test/old/framework/modifiers_test.dart | 1 - .../test/old/framework/provider_element_test.dart | 8 ++++++-- 6 files changed, 17 insertions(+), 12 deletions(-) diff --git a/packages/riverpod/lib/src/builder.dart b/packages/riverpod/lib/src/builder.dart index 6e3f9e066..6a48e7d43 100644 --- a/packages/riverpod/lib/src/builder.dart +++ b/packages/riverpod/lib/src/builder.dart @@ -343,8 +343,9 @@ class StateNotifierProviderFamilyBuilder { StateNotifierProviderFamily call, StateT, ArgT>( NotifierT Function( - StateNotifierProviderRef ref, ArgT param) - create, { + StateNotifierProviderRef ref, + ArgT param, + ) create, { String? name, Iterable? dependencies, }) { @@ -393,8 +394,9 @@ class AutoDisposeStateNotifierProviderFamilyBuilder { StateNotifierProviderFamily call, StateT, ArgT>( NotifierT Function( - StateNotifierProviderRef ref, ArgT param) - create, { + StateNotifierProviderRef ref, + ArgT param, + ) create, { String? name, Iterable? dependencies, }) { diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 5496ac4c9..4d4a197c2 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -29,8 +29,6 @@ mixin _ProviderRefreshable implements Refreshable { @internal void Function()? debugCanModifyProviders; -class _Foo {} - /// {@template riverpod.provider_element_base} /// An internal class that handles the state of a provider. /// @@ -396,7 +394,7 @@ This could mean a few things: /// Initialize a provider. /// - /// This function **must** call [setState] or throw (or both). + /// This function **must** call [setStateResult] or throw (or both). /// /// Exceptions within this function will be caught and set the provider in error /// state. Then, reading this provider will rethrow the thrown exception. diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index de1770d30..e7732af67 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -190,7 +190,9 @@ class FutureProviderElement @override bool updateShouldNotify( - AsyncValue previous, AsyncValue next) { + AsyncValue previous, + AsyncValue next, + ) { return FutureModifierElement.handleUpdateShouldNotify( previous, next, diff --git a/packages/riverpod/test/new/core/overrides_test.dart b/packages/riverpod/test/new/core/overrides_test.dart index 097b7e65f..6b59579b5 100644 --- a/packages/riverpod/test/new/core/overrides_test.dart +++ b/packages/riverpod/test/new/core/overrides_test.dart @@ -74,7 +74,7 @@ void main() { group('FamilyOverride', () { test('TransitiveOverride.toString', () { - final f = Provider.family; + const f = Provider.family; final provider = Provider.family((_, b) => 42); final provider2 = f.call((_, b) => 42); diff --git a/packages/riverpod/test/old/framework/modifiers_test.dart b/packages/riverpod/test/old/framework/modifiers_test.dart index 350063396..85ed775cd 100644 --- a/packages/riverpod/test/old/framework/modifiers_test.dart +++ b/packages/riverpod/test/old/framework/modifiers_test.dart @@ -2,7 +2,6 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/builder.dart'; -import 'package:riverpod/src/internals.dart'; import 'package:test/test.dart'; void main() { diff --git a/packages/riverpod/test/old/framework/provider_element_test.dart b/packages/riverpod/test/old/framework/provider_element_test.dart index 74c57cdcf..cba09875b 100644 --- a/packages/riverpod/test/old/framework/provider_element_test.dart +++ b/packages/riverpod/test/old/framework/provider_element_test.dart @@ -1228,7 +1228,9 @@ void main() { final children = >[]; container.readProviderElement(provider).visitChildren( - elementVisitor: children.add, listenableVisitor: (_) {}); + elementVisitor: children.add, + listenableVisitor: (_) {}, + ); expect( children, unorderedMatches([ @@ -1256,7 +1258,9 @@ void main() { final children = >[]; container.readProviderElement(provider).visitChildren( - elementVisitor: children.add, listenableVisitor: (_) {}); + elementVisitor: children.add, + listenableVisitor: (_) {}, + ); expect( children, unorderedMatches([ From 5c96bca0f8041b8d5f71d091547e987a6c7aaed8 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 1 Feb 2024 16:40:32 +0100 Subject: [PATCH 145/387] Update remaining remaining core packages --- .../flutter_riverpod/example/lib/main.dart | 1 + packages/flutter_riverpod/lib/legacy.dart | 3 +- .../src/{providers/legacy => }/builders.dart | 182 +++++------- .../legacy/change_notifier_provider.dart | 246 +++++++++++++-- .../auto_dispose.dart | 140 --------- .../legacy/change_notifier_provider/base.dart | 280 ------------------ ...dispose_change_notifier_provider_test.dart | 1 + .../test/consumer_listen_test.dart | 1 + .../flutter_riverpod/test/listen_test.dart | 1 + .../flutter_riverpod/test/provider_test.dart | 3 +- ...dispose_change_notifier_provider_test.dart | 2 +- .../change_notifier_provider_test.dart | 7 +- packages/hooks_riverpod/example/lib/main.dart | 1 + packages/hooks_riverpod/lib/legacy.dart | 2 + .../hooks_riverpod/test/internal_test.dart | 1 + .../bin/generate_providers.dart | 4 +- 16 files changed, 319 insertions(+), 556 deletions(-) rename packages/flutter_riverpod/lib/src/{providers/legacy => }/builders.dart (83%) delete mode 100644 packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider/auto_dispose.dart delete mode 100644 packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider/base.dart create mode 100644 packages/hooks_riverpod/lib/legacy.dart diff --git a/packages/flutter_riverpod/example/lib/main.dart b/packages/flutter_riverpod/example/lib/main.dart index d86ad7a20..d0210f8ef 100644 --- a/packages/flutter_riverpod/example/lib/main.dart +++ b/packages/flutter_riverpod/example/lib/main.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; // A Counter example implemented with riverpod diff --git a/packages/flutter_riverpod/lib/legacy.dart b/packages/flutter_riverpod/lib/legacy.dart index e15ce5741..a8c23ce8e 100644 --- a/packages/flutter_riverpod/lib/legacy.dart +++ b/packages/flutter_riverpod/lib/legacy.dart @@ -1,3 +1,4 @@ -export 'flutter_riverpod.dart'; +// TODO changelog added legacy.dart +export 'package:riverpod/legacy.dart'; export 'src/providers/legacy/change_notifier_provider.dart'; diff --git a/packages/flutter_riverpod/lib/src/providers/legacy/builders.dart b/packages/flutter_riverpod/lib/src/builders.dart similarity index 83% rename from packages/flutter_riverpod/lib/src/providers/legacy/builders.dart rename to packages/flutter_riverpod/lib/src/builders.dart index e0b5ef94b..cd025b087 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/builders.dart +++ b/packages/flutter_riverpod/lib/src/builders.dart @@ -8,81 +8,14 @@ // You can then use it in your terminal by executing: // generate_providers -// ignore_for_file: invalid_use_of_internal_member - import 'package:flutter/foundation.dart'; -import '../../internals.dart'; +import 'package:meta/meta.dart'; -/// Builds a [ChangeNotifierProvider]. -class ChangeNotifierProviderBuilder { - /// Builds a [ChangeNotifierProvider]. - const ChangeNotifierProviderBuilder(); +import 'internals.dart'; - /// {@template riverpod.autoDispose} - /// Marks the provider as automatically disposed when no longer listened to. - /// - /// Some typical use-cases: - /// - /// - Combined with [StreamProvider], this can be used as a mean to keep - /// the connection with Firebase alive only when truly needed (to reduce costs). - /// - Automatically reset a form state when leaving the screen. - /// - Automatically retry HTTP requests that failed when the user exit and - /// re-enter the screen. - /// - Cancel HTTP requests if the user leaves a screen before the request completed. - /// - /// Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. - /// - /// The `keepAlive` function is used to tell Riverpod that the state of the provider - /// should be preserved even if no longer listened to. - /// - /// A use-case would be to set this flag to `true` after an HTTP request have - /// completed: - /// - /// ```dart - /// final myProvider = FutureProvider.autoDispose((ref) async { - /// final response = await httpClient.get(...); - /// ref.keepAlive(); - /// return response; - /// }); - /// ``` - /// - /// This way, if the request failed and the UI leaves the screen then re-enters - /// it, then the request will be performed again. - /// But if the request completed successfully, the state will be preserved - /// and re-entering the screen will not trigger a new request. - /// - /// It can be combined with `ref.onDispose` for more advanced behaviors, such - /// as cancelling pending HTTP requests when the user leaves a screen. - /// For example, modifying our previous snippet and using `dio`, we would have: - /// - /// ```diff - /// final myProvider = FutureProvider.autoDispose((ref) async { - /// + final cancelToken = CancelToken(); - /// + ref.onDispose(() => cancelToken.cancel()); - /// - /// + final response = await dio.get('path', cancelToken: cancelToken); - /// - final response = await dio.get('path'); - /// ref.keepAlive(); - /// return response; - /// }); - /// ``` - /// {@endtemplate} - ChangeNotifierProvider call( - Create> create, { - String? name, - Iterable? dependencies, - }) { - return ChangeNotifierProvider( - create, - name: name, - dependencies: dependencies, - ); - } - - /// {@macro riverpod.autoDispose} - AutoDisposeChangeNotifierProviderBuilder get autoDispose { - return const AutoDisposeChangeNotifierProviderBuilder(); - } +@internal +class ChangeNotifierProviderFamilyBuilder { + const ChangeNotifierProviderFamilyBuilder(); /// {@template riverpod.family} /// A group of providers that builds their value from an external parameter. @@ -293,77 +226,112 @@ class ChangeNotifierProviderBuilder { /// } /// ``` /// {@endtemplate} - ChangeNotifierProviderFamilyBuilder get family { - return const ChangeNotifierProviderFamilyBuilder(); - } -} - -/// Builds a [ChangeNotifierProviderFamily]. -class ChangeNotifierProviderFamilyBuilder { - /// Builds a [ChangeNotifierProviderFamily]. - const ChangeNotifierProviderFamilyBuilder(); - - /// {@macro riverpod.family} - ChangeNotifierProviderFamily - call( - FamilyCreate, Arg> create, { + ChangeNotifierProviderFamily + call( + NotifierT Function(ChangeNotifierProviderRef ref, ArgT param) + create, { String? name, Iterable? dependencies, }) { - return ChangeNotifierProviderFamily( + return ChangeNotifierProviderFamily( create, name: name, dependencies: dependencies, ); } - /// {@macro riverpod.autoDispose} - AutoDisposeChangeNotifierProviderFamilyBuilder get autoDispose { - return const AutoDisposeChangeNotifierProviderFamilyBuilder(); - } + /// {@template riverpod.autoDispose} + /// Marks the provider as automatically disposed when no longer listened to. + /// + /// Some typical use-cases: + /// + /// - Combined with [StreamProvider], this can be used as a mean to keep + /// the connection with Firebase alive only when truly needed (to reduce costs). + /// - Automatically reset a form state when leaving the screen. + /// - Automatically retry HTTP requests that failed when the user exit and + /// re-enter the screen. + /// - Cancel HTTP requests if the user leaves a screen before the request completed. + /// + /// Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. + /// + /// The `keepAlive` function is used to tell Riverpod that the state of the provider + /// should be preserved even if no longer listened to. + /// + /// A use-case would be to set this flag to `true` after an HTTP request have + /// completed: + /// + /// ```dart + /// final myProvider = FutureProvider.autoDispose((ref) async { + /// final response = await httpClient.get(...); + /// ref.keepAlive(); + /// return response; + /// }); + /// ``` + /// + /// This way, if the request failed and the UI leaves the screen then re-enters + /// it, then the request will be performed again. + /// But if the request completed successfully, the state will be preserved + /// and re-entering the screen will not trigger a new request. + /// + /// It can be combined with `ref.onDispose` for more advanced behaviors, such + /// as cancelling pending HTTP requests when the user leaves a screen. + /// For example, modifying our previous snippet and using `dio`, we would have: + /// + /// ```diff + /// final myProvider = FutureProvider.autoDispose((ref) async { + /// + final cancelToken = CancelToken(); + /// + ref.onDispose(() => cancelToken.cancel()); + /// + /// + final response = await dio.get('path', cancelToken: cancelToken); + /// - final response = await dio.get('path'); + /// ref.keepAlive(); + /// return response; + /// }); + /// ``` + /// {@endtemplate} + AutoDisposeChangeNotifierProviderFamilyBuilder get autoDispose => + const AutoDisposeChangeNotifierProviderFamilyBuilder(); } -/// Builds a [AutoDisposeChangeNotifierProvider]. +@internal class AutoDisposeChangeNotifierProviderBuilder { - /// Builds a [AutoDisposeChangeNotifierProvider]. const AutoDisposeChangeNotifierProviderBuilder(); - /// {@macro riverpod.autoDispose} - AutoDisposeChangeNotifierProvider - call( - Create> create, { + /// {@macro riverpod.family} + ChangeNotifierProvider call( + NotifierT Function(ChangeNotifierProviderRef ref) create, { String? name, Iterable? dependencies, }) { - return AutoDisposeChangeNotifierProvider( + return ChangeNotifierProvider( create, name: name, + isAutoDispose: true, dependencies: dependencies, ); } /// {@macro riverpod.family} - AutoDisposeChangeNotifierProviderFamilyBuilder get family { - return const AutoDisposeChangeNotifierProviderFamilyBuilder(); - } + AutoDisposeChangeNotifierProviderFamilyBuilder get family => + const AutoDisposeChangeNotifierProviderFamilyBuilder(); } -/// Builds a [AutoDisposeChangeNotifierProviderFamily]. +@internal class AutoDisposeChangeNotifierProviderFamilyBuilder { - /// Builds a [AutoDisposeChangeNotifierProviderFamily]. const AutoDisposeChangeNotifierProviderFamilyBuilder(); /// {@macro riverpod.family} - AutoDisposeChangeNotifierProviderFamily - call( - FamilyCreate, Arg> + ChangeNotifierProviderFamily + call( + NotifierT Function(ChangeNotifierProviderRef ref, ArgT param) create, { String? name, Iterable? dependencies, }) { - return AutoDisposeChangeNotifierProviderFamily( + return ChangeNotifierProviderFamily( create, name: name, + isAutoDispose: true, dependencies: dependencies, ); } 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 index 8c293f53d..018daf734 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -6,14 +6,11 @@ import 'package:meta/meta.dart'; // ignore: implementation_imports import 'package:riverpod/src/internals.dart'; -import 'builders.dart'; - -part 'change_notifier_provider/auto_dispose.dart'; -part 'change_notifier_provider/base.dart'; +import '../../builders.dart'; ProviderElementProxy _notifier( - _ChangeNotifierProviderBase that, + ChangeNotifierProvider that, ) { return ProviderElementProxy( that, @@ -24,23 +21,109 @@ ProviderElementProxy ); } -/// {@template riverpod.changenotifierprovider} -/// Creates a [ChangeNotifier] and subscribes to it. +/// {@macro riverpod.provider_ref_base} +abstract class ChangeNotifierProviderRef + implements Ref { + /// The [ChangeNotifier] currently exposed by this provider. + /// + /// Cannot be accessed while creating the provider. + NotifierT get notifier; +} + +/// Creates a [ChangeNotifier] and exposes its current state. +/// +/// Combined with [ChangeNotifier], [ChangeNotifierProvider] can be used to manipulate +/// advanced states, that would otherwise be difficult to represent with simpler +/// providers such as [Provider] or [FutureProvider]. +/// +/// For example, you may have a todo-list, where you can add and remove +/// and complete a todo. +/// Using [ChangeNotifier], you could represent such state as: +/// +/// ```dart +/// class TodosNotifier extends ChangeNotifier { +/// List todos = []; +/// +/// void add(Todo todo) { +/// todos.add(todo); +/// notifyListeners(); +/// } +/// +/// void remove(String todoId) { +/// todos.removeWhere((todo) => todo.id == todoId); +/// notifyListeners(); +/// } +/// +/// void toggle(String todoId) { +/// final todo = todos.firstWhere((todo) => todo.id == todoId); +/// todo.completed = !todo.completed; +/// notifyListeners(); +/// } +/// } +/// ``` +/// +/// Which you can then pass to a [ChangeNotifierProvider] like so: /// -/// Note: By using Riverpod, [ChangeNotifier] will no longer be O(N^2) for -/// dispatching notifications, but instead O(N) -/// {@endtemplate} -abstract class _ChangeNotifierProviderBase - extends ProviderBase { - const _ChangeNotifierProviderBase({ +/// ```dart +/// final todosProvider = ChangeNotifierProvider>((ref) => TodosNotifier()); +/// ``` +/// +/// And finally, you can interact with it inside your UI: +/// +/// ```dart +/// Widget build(BuildContext context, WidgetRef ref) { +/// // rebuild the widget when the todo list changes +/// List todos = ref.watch(todosProvider).todos; +/// +/// return ListView( +/// children: [ +/// for (final todo in todos) +/// CheckboxListTile( +/// value: todo.completed, +/// // When tapping on the todo, change its completed status +/// onChanged: (value) => ref.read(todosProvider.notifier).toggle(todo.id), +/// title: Text(todo.description), +/// ), +/// ], +/// ); +/// } +/// ``` +final class ChangeNotifierProvider + extends FunctionalProvider> { + /// {@macro riverpod.change_notifier_provider} + ChangeNotifierProvider( + this._createFn, { + super.name, + super.dependencies, + super.isAutoDispose = false, + }) : super( + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + from: null, + argument: null, + debugGetCreateSourceHash: null, + ); + + /// An implementation detail of Riverpod + @internal + const ChangeNotifierProvider.internal( + this._createFn, { required super.name, - required super.from, - required super.argument, required super.dependencies, required super.allTransitiveDependencies, required super.debugGetCreateSourceHash, + required super.isAutoDispose, + super.from, + super.argument, }); + /// {@macro riverpod.autoDispose} + static const autoDispose = AutoDisposeChangeNotifierProviderBuilder(); + + /// {@macro riverpod.family} + static const family = ChangeNotifierProviderFamilyBuilder(); + /// Obtains the [ChangeNotifier] associated with this provider, without listening /// to state changes. /// @@ -56,11 +139,136 @@ abstract class _ChangeNotifierProviderBase /// changes. /// This may happen if the provider is refreshed or one of its dependencies /// has changes. - ProviderListenable get notifier; + Refreshable get notifier => _notifier(this); - NotifierT _create(covariant ChangeNotifierProviderElement ref); + final NotifierT Function(ChangeNotifierProviderRef ref) _createFn; - // Specified by ProviderBase @override - String toString(); + ChangeNotifierProviderElement createElement( + ProviderContainer container, + ) { + return ChangeNotifierProviderElement._(this, container); + } + + @override + ChangeNotifierProvider copyWithCreate( + Create> create, + ) { + return ChangeNotifierProvider.internal( + create, + name: name, + dependencies: dependencies, + isAutoDispose: isAutoDispose, + from: from, + argument: argument, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + ); + } +} + +/// The element of [ChangeNotifierProvider]. +class ChangeNotifierProviderElement + extends ProviderElementBase + implements ChangeNotifierProviderRef { + ChangeNotifierProviderElement._(this.provider, super.container); + + @override + final ChangeNotifierProvider provider; + + @override + NotifierT get notifier => _notifierNotifier.value; + final _notifierNotifier = ProxyElementValueListenable(); + + void Function()? _removeListener; + + @override + void create({required bool didChangeDependency}) { + final notifierResult = + _notifierNotifier.result = Result.guard(() => provider._createFn(this)); + + // TODO test requireState, as ref.read(p) is expected to throw if notifier creation failed + final notifier = notifierResult.requireState; + + setStateResult(ResultData(notifier)); + + if (notifier != null) { + void listener() => setStateResult(ResultData(notifier)); + notifier.addListener(listener); + _removeListener = () => notifier.removeListener(listener); + } + } + + @override + bool updateShouldNotify(NotifierT previous, NotifierT next) => true; + + @override + void runOnDispose() { + super.runOnDispose(); + + _removeListener?.call(); + _removeListener = null; + + final notifier = _notifierNotifier.result?.stateOrNull; + if (notifier != null) { + // TODO test ChangeNotifier.dispose is guarded + runGuarded(notifier.dispose); + } + _notifierNotifier.result = null; + } + + @override + void visitChildren({ + required void Function(ProviderElementBase element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); + listenableVisitor(_notifierNotifier); + } +} + +/// The [Family] of [ChangeNotifierProvider]. +class ChangeNotifierProviderFamily + extends FunctionalFamily, NotifierT, + Arg, NotifierT, ChangeNotifierProvider> { + /// The [Family] of [ChangeNotifierProvider]. + ChangeNotifierProviderFamily( + super._createFn, { + super.name, + super.dependencies, + super.isAutoDispose = false, + }) : super( + providerFactory: ChangeNotifierProvider.internal, + debugGetCreateSourceHash: null, + allTransitiveDependencies: + computeAllTransitiveDependencies(dependencies), + ); + + /// {@macro riverpod.override_with} + Override overrideWith( + NotifierT Function(ChangeNotifierProviderRef ref, Arg arg) + create, + ) { + return FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ChangeNotifierProvider; + + return ChangeNotifierProvider.internal( + (ref) => create(ref, provider.argument as Arg), + from: provider.from, + argument: provider.argument, + isAutoDispose: provider.isAutoDispose, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + name: null, + ).createElement(container); + }, + ); + } } diff --git a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider/auto_dispose.dart b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider/auto_dispose.dart deleted file mode 100644 index 961053767..000000000 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider/auto_dispose.dart +++ /dev/null @@ -1,140 +0,0 @@ -// ignore_for_file: invalid_use_of_internal_member - -part of '../change_notifier_provider.dart'; - -/// {@macro riverpod.provider_ref_base} -abstract class AutoDisposeChangeNotifierProviderRef< - NotifierT extends ChangeNotifier?> - extends ChangeNotifierProviderRef - implements AutoDisposeRef {} - -/// {@macro riverpod.change_notifier_provider} -class AutoDisposeChangeNotifierProvider - extends _ChangeNotifierProviderBase { - /// {@macro riverpod.change_notifier_provider} - AutoDisposeChangeNotifierProvider( - this._createFn, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - AutoDisposeChangeNotifierProvider.internal( - this._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.family} - static const family = AutoDisposeChangeNotifierProviderFamily.new; - - final NotifierT Function(AutoDisposeChangeNotifierProviderRef ref) - _createFn; - - @override - NotifierT _create(AutoDisposeChangeNotifierProviderElement ref) { - return _createFn(ref); - } - - @override - AutoDisposeChangeNotifierProviderElement createElement( - ProviderContainer container, - ) { - return AutoDisposeChangeNotifierProviderElement._( - this, - container, - ); - } - - @override - late final Refreshable notifier = _notifier(this); - - /// {@macro riverpod.override_with} - Override overrideWith( - Create> create, - ) { - return ProviderOverride( - origin: this, - providerOverride: AutoDisposeChangeNotifierProvider.internal( - create, - from: from, - argument: argument, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), - ); - } -} - -/// The element of [AutoDisposeChangeNotifierProvider]. -class AutoDisposeChangeNotifierProviderElement< - NotifierT extends ChangeNotifier?> - extends ChangeNotifierProviderElement - with AutoDisposeProviderElementMixin - implements AutoDisposeChangeNotifierProviderRef { - /// The [ProviderElementBase] for [ChangeNotifier] - AutoDisposeChangeNotifierProviderElement._( - AutoDisposeChangeNotifierProvider super.provider, - super.container, - ) : super._(); -} - -/// The [Family] of [AutoDisposeChangeNotifierProvider]. -class AutoDisposeChangeNotifierProviderFamily - extends AutoDisposeFamilyBase< - AutoDisposeChangeNotifierProviderRef, - NotifierT, - Arg, - NotifierT, - AutoDisposeChangeNotifierProvider> { - /// The [Family] of [AutoDisposeChangeNotifierProvider]. - AutoDisposeChangeNotifierProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: AutoDisposeChangeNotifierProvider.internal, - debugGetCreateSourceHash: null, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - ); - - /// {@macro riverpod.override_with} - Override overrideWith( - NotifierT Function( - AutoDisposeChangeNotifierProviderRef ref, - Arg arg, - ) create, - ) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as AutoDisposeChangeNotifierProvider; - - return AutoDisposeChangeNotifierProvider.internal( - (ref) => create(ref, provider.argument as Arg), - from: provider.from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} diff --git a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider/base.dart b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider/base.dart deleted file mode 100644 index cb1d22d4e..000000000 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider/base.dart +++ /dev/null @@ -1,280 +0,0 @@ -// ignore_for_file: invalid_use_of_internal_member - -part of '../change_notifier_provider.dart'; - -/// {@macro riverpod.provider_ref_base} -abstract class ChangeNotifierProviderRef - implements Ref { - /// The [ChangeNotifier] currently exposed by this provider. - /// - /// Cannot be accessed while creating the provider. - NotifierT get notifier; -} - -/// {@template riverpod.change_notifier_provider} -/// Creates a [ChangeNotifier] and exposes its current state. -/// -/// Combined with [ChangeNotifier], [ChangeNotifierProvider] can be used to manipulate -/// advanced states, that would otherwise be difficult to represent with simpler -/// providers such as [Provider] or [FutureProvider]. -/// -/// For example, you may have a todo-list, where you can add and remove -/// and complete a todo. -/// Using [ChangeNotifier], you could represent such state as: -/// -/// ```dart -/// class TodosNotifier extends ChangeNotifier { -/// List todos = []; -/// -/// void add(Todo todo) { -/// todos.add(todo); -/// notifyListeners(); -/// } -/// -/// void remove(String todoId) { -/// todos.removeWhere((todo) => todo.id == todoId); -/// notifyListeners(); -/// } -/// -/// void toggle(String todoId) { -/// final todo = todos.firstWhere((todo) => todo.id == todoId); -/// todo.completed = !todo.completed; -/// notifyListeners(); -/// } -/// } -/// ``` -/// -/// Which you can then pass to a [ChangeNotifierProvider] like so: -/// -/// ```dart -/// final todosProvider = ChangeNotifierProvider>((ref) => TodosNotifier()); -/// ``` -/// -/// And finally, you can interact with it inside your UI: -/// -/// ```dart -/// Widget build(BuildContext context, WidgetRef ref) { -/// // rebuild the widget when the todo list changes -/// List todos = ref.watch(todosProvider).todos; -/// -/// return ListView( -/// children: [ -/// for (final todo in todos) -/// CheckboxListTile( -/// value: todo.completed, -/// // When tapping on the todo, change its completed status -/// onChanged: (value) => ref.read(todosProvider.notifier).toggle(todo.id), -/// title: Text(todo.description), -/// ), -/// ], -/// ); -/// } -/// ``` -/// {@endtemplate} -class ChangeNotifierProvider - extends _ChangeNotifierProviderBase { - /// {@macro riverpod.change_notifier_provider} - ChangeNotifierProvider( - this._createFn, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - debugGetCreateSourceHash: null, - ); - - /// An implementation detail of Riverpod - @internal - ChangeNotifierProvider.internal( - this._createFn, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - super.from, - super.argument, - }); - - /// {@macro riverpod.autoDispose} - static const autoDispose = AutoDisposeChangeNotifierProviderBuilder(); - - /// {@macro riverpod.family} - static const family = ChangeNotifierProviderFamilyBuilder(); - - final NotifierT Function(ChangeNotifierProviderRef ref) _createFn; - - @override - NotifierT _create(ChangeNotifierProviderElement ref) { - return _createFn(ref); - } - - @override - ChangeNotifierProviderElement createElement( - ProviderContainer container, - ) { - return ChangeNotifierProviderElement._(this, container); - } - - @override - late final Refreshable notifier = _notifier(this); - - /// {@template riverpod.override_with} - /// Override the provider with a new initialization function. - /// - /// This will also disable the auto-scoping mechanism, meaning that if the - /// overridden provider specified `dependencies`, it will have no effect. - /// - /// The override must not specify a `dependencies`. - /// - /// Some common use-cases are: - /// - testing, by replacing a service with a fake implementation, or to reach - /// a very specific state easily. - /// - multiple environments, by changing the implementation of a class - /// based on the platform or other parameters. - /// - /// This function should be used in combination with `ProviderScope.overrides` - /// or `ProviderContainer.overrides`: - /// - /// ```dart - /// final myService = Provider((ref) => MyService()); - /// - /// runApp( - /// ProviderScope( - /// overrides: [ - /// // Replace the implementation of the provider with a different one - /// myService.overrideWith((ref) { - /// ref.watch('other'); - /// return MyFakeService(), - /// })), - /// ], - /// child: MyApp(), - /// ), - /// ); - /// ``` - /// {@endtemplate} - Override overrideWith( - Create> create, - ) { - return ProviderOverride( - origin: this, - providerOverride: ChangeNotifierProvider.internal( - create, - from: from, - argument: argument, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), - ); - } -} - -/// The element of [ChangeNotifierProvider]. -class ChangeNotifierProviderElement - extends ProviderElementBase - implements ChangeNotifierProviderRef { - ChangeNotifierProviderElement._(this.provider, super.container); - - @override - final _ChangeNotifierProviderBase provider; - - @override - NotifierT get notifier => _notifierNotifier.value; - final _notifierNotifier = ProxyElementValueListenable(); - - void Function()? _removeListener; - - @override - void create({required bool didChangeDependency}) { - final provider = this.provider as _ChangeNotifierProviderBase; - - final notifierResult = - _notifierNotifier.result = Result.guard(() => provider._create(this)); - - // TODO test requireState, as ref.read(p) is expected to throw if notifier creation failed - final notifier = notifierResult.requireState; - - setState(notifier); - - if (notifier != null) { - void listener() => setState(notifier); - notifier.addListener(listener); - _removeListener = () => notifier.removeListener(listener); - } - } - - @override - bool updateShouldNotify(NotifierT previous, NotifierT next) => true; - - @override - void runOnDispose() { - super.runOnDispose(); - - _removeListener?.call(); - _removeListener = null; - - final notifier = _notifierNotifier.result?.stateOrNull; - if (notifier != null) { - // TODO test ChangeNotifier.dispose is guarded - runGuarded(notifier.dispose); - } - _notifierNotifier.result = null; - } - - @override - void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, - }) { - super.visitChildren( - elementVisitor: elementVisitor, - listenableVisitor: listenableVisitor, - ); - listenableVisitor(_notifierNotifier); - } -} - -/// The [Family] of [ChangeNotifierProvider]. -class ChangeNotifierProviderFamily - extends FunctionalFamily, NotifierT, - Arg, NotifierT, ChangeNotifierProvider> { - /// The [Family] of [ChangeNotifierProvider]. - ChangeNotifierProviderFamily( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: ChangeNotifierProvider.internal, - debugGetCreateSourceHash: null, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - ); - - /// {@macro riverpod.override_with} - Override overrideWith( - NotifierT Function(ChangeNotifierProviderRef ref, Arg arg) - create, - ) { - return FamilyOverride( - from: this, - createElement: (container, provider) { - provider as ChangeNotifierProvider; - - return ChangeNotifierProvider.internal( - (ref) => create(ref, provider.argument as Arg), - from: provider.from, - argument: provider.argument, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - name: null, - ).createElement(container); - }, - ); - } -} diff --git a/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart index 8c5cf2f58..aaec9e601 100644 --- a/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart @@ -1,5 +1,6 @@ import 'package:flutter/widgets.dart' hide Listener; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; diff --git a/packages/flutter_riverpod/test/consumer_listen_test.dart b/packages/flutter_riverpod/test/consumer_listen_test.dart index f9530e9f5..fc6cbbfa9 100644 --- a/packages/flutter_riverpod/test/consumer_listen_test.dart +++ b/packages/flutter_riverpod/test/consumer_listen_test.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart' hide Listener; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; diff --git a/packages/flutter_riverpod/test/listen_test.dart b/packages/flutter_riverpod/test/listen_test.dart index a70ca4b9c..70daa3e5d 100644 --- a/packages/flutter_riverpod/test/listen_test.dart +++ b/packages/flutter_riverpod/test/listen_test.dart @@ -2,6 +2,7 @@ import 'dart:async'; import 'package:flutter/material.dart' hide Listener; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; diff --git a/packages/flutter_riverpod/test/provider_test.dart b/packages/flutter_riverpod/test/provider_test.dart index d3f6c051c..5c6b9d8f8 100644 --- a/packages/flutter_riverpod/test/provider_test.dart +++ b/packages/flutter_riverpod/test/provider_test.dart @@ -2,6 +2,7 @@ import 'dart:async'; import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; @@ -289,7 +290,7 @@ void main() { final provider = Provider((_) => 42); // These check the type safety - Ref? ref; + Ref? ref; final Provider provider1 = Provider((r) { final first = r.watch(provider); diff --git a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart index a149a2601..1b7b296b9 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart @@ -24,7 +24,7 @@ void main() { test('can read and set current ChangeNotifier', () async { final container = createContainer(); final listener = Listener>(); - late AutoDisposeChangeNotifierProviderRef> ref; + late ChangeNotifierProviderRef> ref; final provider = ChangeNotifierProvider.autoDispose>((r) { ref = r; diff --git a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart index b7a176863..b56f4d1a4 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart @@ -22,7 +22,7 @@ void main() { ValueNotifier(42), ), autoDispose.overrideWith( - (AutoDisposeChangeNotifierProviderRef> ref) => + (ChangeNotifierProviderRef> ref) => ValueNotifier(84), ), ], @@ -47,10 +47,7 @@ void main() { ValueNotifier('42 $arg'), ), autoDisposeFamily.overrideWith( - ( - AutoDisposeChangeNotifierProviderRef> ref, - int arg, - ) => + (ChangeNotifierProviderRef> ref, int arg) => ValueNotifier('84 $arg'), ), ], diff --git a/packages/hooks_riverpod/example/lib/main.dart b/packages/hooks_riverpod/example/lib/main.dart index a987bc7ea..39da1f8f6 100644 --- a/packages/hooks_riverpod/example/lib/main.dart +++ b/packages/hooks_riverpod/example/lib/main.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:hooks_riverpod/legacy.dart'; void main() { runApp( diff --git a/packages/hooks_riverpod/lib/legacy.dart b/packages/hooks_riverpod/lib/legacy.dart new file mode 100644 index 000000000..82e642bb3 --- /dev/null +++ b/packages/hooks_riverpod/lib/legacy.dart @@ -0,0 +1,2 @@ +// TODO changelog added legacy.dart +export 'package:flutter_riverpod/legacy.dart'; diff --git a/packages/hooks_riverpod/test/internal_test.dart b/packages/hooks_riverpod/test/internal_test.dart index de7b5de04..30bd39c51 100644 --- a/packages/hooks_riverpod/test/internal_test.dart +++ b/packages/hooks_riverpod/test/internal_test.dart @@ -1,6 +1,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:hooks_riverpod/legacy.dart'; void main() { // testWidgets('ref.watch supports changing the selected provider', diff --git a/tools/generate_providers/bin/generate_providers.dart b/tools/generate_providers/bin/generate_providers.dart index d05eed261..5dbb17b46 100644 --- a/tools/generate_providers/bin/generate_providers.dart +++ b/tools/generate_providers/bin/generate_providers.dart @@ -188,9 +188,9 @@ import 'internals.dart'; _FunctionalBuilder( 'ChangeNotifierProvider', genericsUsage: 'NotifierT', - genericsDefinition: 'NotifierT extends ChangeNotifier', + genericsDefinition: 'NotifierT extends ChangeNotifier?', createdT: 'NotifierT', - refT: 'ChangeProviderRef', + refT: 'ChangeNotifierProviderRef', ), ], kinds: _ProviderKind.values, From 6fb13b3dc51ea948125442e1d9952c5d5037becd Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 1 Feb 2024 17:03:39 +0100 Subject: [PATCH 146/387] Typos --- .../lib/src/templates/parameters.dart | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/riverpod_generator/lib/src/templates/parameters.dart b/packages/riverpod_generator/lib/src/templates/parameters.dart index eac55717e..0aa143fb8 100644 --- a/packages/riverpod_generator/lib/src/templates/parameters.dart +++ b/packages/riverpod_generator/lib/src/templates/parameters.dart @@ -13,10 +13,10 @@ String buildParamDefinitionQuery( 'Cannot enable both asThisParameter and asSuperParameter', ); - final requiredPositionals = parameters + final requiredPositional = parameters .where((element) => element.isRequiredPositional && !asRequiredNamed) .toList(); - final optionalPositionals = parameters + final optionalPositional = parameters .where((element) => element.isOptionalPositional && !asRequiredNamed) .toList(); final named = parameters @@ -48,12 +48,12 @@ String buildParamDefinitionQuery( } buffer.writeAll( - requiredPositionals.map(encodeParameter).expand((e) => [e, ',']), + requiredPositional.map(encodeParameter).expand((e) => [e, ',']), ); - if (optionalPositionals.isNotEmpty) { + if (optionalPositional.isNotEmpty) { if (writeBrackets && !asRecord) buffer.write('['); buffer.writeAll( - optionalPositionals.map(encodeParameter).expand((e) => [e, ',']), + optionalPositional.map(encodeParameter).expand((e) => [e, ',']), ); if (writeBrackets && !asRecord) buffer.write(']'); } @@ -82,7 +82,7 @@ String buildParamInvocationQuery( return buffer.toString(); } -extension ParamterType on FormalParameter { +extension ParameterType on FormalParameter { String get typeDisplayString { final that = this; switch (that) { From b57d44a4878c581275c229a85721e3a825a32e41 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 1 Feb 2024 17:30:45 +0100 Subject: [PATCH 147/387] Add bunch of warnings --- .../legacy/change_notifier_provider.dart | 2 + .../src/providers/async_notifier/family.dart | 6 +- .../src/providers/async_notifier/orphan.dart | 6 +- .../lib/src/providers/future_provider.dart | 2 + .../legacy/state_notifier_provider.dart | 2 + .../src/providers/legacy/state_provider.dart | 3 +- .../lib/src/providers/notifier/family.dart | 4 + .../lib/src/providers/notifier/orphan.dart | 6 +- .../riverpod/lib/src/providers/provider.dart | 1 + .../src/providers/stream_notifier/family.dart | 4 + .../src/providers/stream_notifier/orphan.dart | 6 +- .../lib/src/providers/stream_provider.dart | 2 + .../lib/riverpod_annotation.dart | 59 +--- .../src/templates/class_based_provider.dart | 22 +- .../lib/src/templates/family.dart | 47 ++- .../src/templates/functional_provider.dart | 22 +- .../test/integration/annotated.g.dart | 86 +++-- .../test/integration/async.g.dart | 187 +++++----- .../test/integration/auto_dispose.g.dart | 11 +- .../test/integration/dependencies.g.dart | 162 +++++---- .../test/integration/dependencies2.g.dart | 82 +++-- .../test/integration/generated.g.dart | 230 +++++++------ .../test/integration/hash/hash1.g.dart | 22 +- .../test/integration/scopes.g.dart | 7 +- .../test/integration/split.g.dart | 14 +- .../test/integration/stream.g.dart | 134 ++++---- .../test/integration/sync.g.dart | 324 ++++++++++-------- 27 files changed, 782 insertions(+), 671 deletions(-) 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 index 018daf734..b306ef0dc 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -150,6 +150,8 @@ final class ChangeNotifierProvider return ChangeNotifierProviderElement._(this, container); } + @mustBeOverridden + @visibleForOverriding @override ChangeNotifierProvider copyWithCreate( Create> create, diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index bdba74e7f..6d340031f 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -99,7 +99,8 @@ final class FamilyAsyncNotifierProvider< // return _AsyncNotifierProviderElement(this, container); } - @internal + @mustBeOverridden + @visibleForOverriding @override FamilyAsyncNotifierProvider copyWithBuild( RunNotifierBuild, Ref>>? @@ -108,7 +109,8 @@ final class FamilyAsyncNotifierProvider< // return _copyWith(build: build); } - @internal + @mustBeOverridden + @visibleForOverriding @override FamilyAsyncNotifierProvider copyWithCreate( NotifierT Function() create, diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index cd8adfa61..3e54e965d 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -138,7 +138,8 @@ final class AsyncNotifierProvider< // return _AsyncNotifierProviderElement(this, container); } - @internal + @mustBeOverridden + @visibleForOverriding @override AsyncNotifierProvider copyWithBuild( RunNotifierBuild, Ref>>? @@ -147,7 +148,8 @@ final class AsyncNotifierProvider< // return _copyWith(build: build); } - @internal + @mustBeOverridden + @visibleForOverriding @override AsyncNotifierProvider copyWithCreate( NotifierT Function() create, diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index e7732af67..56fde4ea0 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -135,6 +135,8 @@ final class FutureProvider extends FunctionalProvider< return FutureProviderElement(this, container); } + @mustBeOverridden + @visibleForOverriding @override FutureProvider copyWithCreate( Create, FutureProviderRef> create, diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index 78729777a..f4cff717f 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -155,6 +155,8 @@ final class StateNotifierProvider< // return StateNotifierProviderElement._(this, container); } + @mustBeOverridden + @visibleForOverriding @override StateNotifierProvider copyWithCreate( Create> create, diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 51c052e04..9c6cab662 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -101,7 +101,8 @@ final class StateProvider return StateProviderElement._(this, container); } - @internal + @mustBeOverridden + @visibleForOverriding @override StateProvider copyWithCreate( Create> create, diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index 38e116bc5..1f34d7c0c 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -62,12 +62,16 @@ final class FamilyNotifierProvider // } @override + @mustBeOverridden + @visibleForOverriding FamilyNotifierProvider copyWithBuild( RunNotifierBuild> build, ) { return _copyWith(build: build); } + @mustBeOverridden + @visibleForOverriding @override FamilyNotifierProvider copyWithCreate( NotifierT Function() create, diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart index ffb7e7461..e0a326840 100644 --- a/packages/riverpod/lib/src/providers/notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -153,7 +153,8 @@ final class NotifierProvider, StateT> ); } - @internal + @mustBeOverridden + @visibleForOverriding @override NotifierProvider copyWithBuild( RunNotifierBuild>? build, @@ -161,7 +162,8 @@ final class NotifierProvider, StateT> return _copyWith(build: build); } - @internal + @mustBeOverridden + @visibleForOverriding @override NotifierProvider copyWithCreate( NotifierT Function() create, diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index ffbb8d580..1fb4913c1 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -66,6 +66,7 @@ final class Provider return ProviderElement(this, container); } + @mustBeOverridden @visibleForOverriding @override Provider copyWithCreate( diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index f7cb426c2..93bda3b28 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -74,6 +74,8 @@ final class FamilyStreamNotifierProvider< // } @override + @mustBeOverridden + @visibleForOverriding FamilyStreamNotifierProvider copyWithBuild( RunNotifierBuild, Ref>> build, ) { @@ -81,6 +83,8 @@ final class FamilyStreamNotifierProvider< // } @override + @mustBeOverridden + @visibleForOverriding FamilyStreamNotifierProvider copyWithCreate( NotifierT Function() create, ) { diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index d85f187f8..35f175a84 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -124,7 +124,8 @@ final class StreamNotifierProvider< // return _StreamNotifierProviderElement(this, container); } - @internal + @mustBeOverridden + @visibleForOverriding @override StreamNotifierProvider copyWithBuild( RunNotifierBuild, Ref>>? build, @@ -132,7 +133,8 @@ final class StreamNotifierProvider< // return _copyWith(build: build); } - @internal + @mustBeOverridden + @visibleForOverriding @override StreamNotifierProvider copyWithCreate( NotifierT Function() create, diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index cd518ac92..22fd10faf 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -125,6 +125,8 @@ final class StreamProvider extends FunctionalProvider< return StreamProviderElement(this, container); } + @mustBeOverridden + @visibleForOverriding @override FunctionalProvider, Stream, Ref>> copyWithCreate( diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index 0522bc04c..1e244ac28 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -16,36 +16,23 @@ export 'package:riverpod/src/internals.dart' ProviderOverride, // ignore: invalid_use_of_internal_member, used by families for overrideWith FamilyOverride, + Ref, // Provider Provider, ProviderFamily, - ProviderRef, - AutoDisposeProvider, - AutoDisposeProviderFamily, - AutoDisposeProviderRef, ProviderElement, - AutoDisposeProviderElement, // FutureProvider FutureProvider, FutureProviderFamily, FutureProviderRef, - AutoDisposeFutureProvider, - AutoDisposeFutureProviderFamily, - AutoDisposeFutureProviderRef, FutureProviderElement, - AutoDisposeFutureProviderElement, // StreamProvider StreamProvider, StreamProviderFamily, - StreamProviderRef, - AutoDisposeStreamProvider, - AutoDisposeStreamProviderFamily, - AutoDisposeStreamProviderRef, StreamProviderElement, - AutoDisposeStreamProviderElement, // AsyncValue AsyncValue, @@ -56,56 +43,14 @@ export 'package:riverpod/src/internals.dart' // Notifier Notifier, - AutoDisposeNotifier, - NotifierProviderElement, - AutoDisposeNotifierProviderElement, // ignore: invalid_use_of_internal_member NotifierProvider, - // ignore: invalid_use_of_internal_member - AutoDisposeNotifierProviderImpl, - // ignore: invalid_use_of_internal_member - BuildlessNotifier, - // ignore: invalid_use_of_internal_member - BuildlessAutoDisposeNotifier, - NotifierProvider, - NotifierProviderRef, - AutoDisposeNotifierProvider, - AutoDisposeNotifierProviderRef, // AsyncNotifier AsyncNotifier, - AutoDisposeAsyncNotifier, - _AsyncNotifierProviderElement, - AutoDisposeAsyncNotifierProviderElement, - // ignore: invalid_use_of_internal_member - AsyncNotifierProviderImpl, - // ignore: invalid_use_of_internal_member - AutoDisposeAsyncNotifierProviderImpl, - // ignore: invalid_use_of_internal_member - BuildlessAsyncNotifier, - // ignore: invalid_use_of_internal_member - BuildlessAutoDisposeAsyncNotifier, AsyncNotifierProvider, - AsyncNotifierProviderRef, - AutoDisposeAsyncNotifierProvider, - AutoDisposeAsyncNotifierProviderRef, - // StreamNotifier StreamNotifier, - AutoDisposeStreamNotifier, - _StreamNotifierProviderElement, - AutoDisposeStreamNotifierProviderElement, - // ignore: invalid_use_of_internal_member - StreamNotifierProviderImpl, - // ignore: invalid_use_of_internal_member - AutoDisposeStreamNotifierProviderImpl, - // ignore: invalid_use_of_internal_member - BuildlessStreamNotifier, - // ignore: invalid_use_of_internal_member - BuildlessAutoDisposeStreamNotifier, - StreamNotifierProvider, - StreamNotifierProviderRef, - AutoDisposeStreamNotifierProvider, - AutoDisposeStreamNotifierProviderRef; + StreamNotifierProvider; export 'src/riverpod_annotation.dart'; diff --git a/packages/riverpod_generator/lib/src/templates/class_based_provider.dart b/packages/riverpod_generator/lib/src/templates/class_based_provider.dart index 1dda0cf4d..9143cc06d 100644 --- a/packages/riverpod_generator/lib/src/templates/class_based_provider.dart +++ b/packages/riverpod_generator/lib/src/templates/class_based_provider.dart @@ -89,23 +89,22 @@ class ClassBasedProviderTemplate extends Template { @override void run(StringBuffer buffer) { - var leading = ''; - if (!provider.annotation.element.keepAlive) { - leading = 'AutoDispose'; - } + final isAutoDispose = !provider.providerElement.annotation.keepAlive + ? 'isAutoDispose: true,' + : ''; - var notifierBaseType = '${leading}Notifier'; - var providerType = '${leading}NotifierProvider'; + var notifierBaseType = 'Notifier'; + var providerType = 'NotifierProvider'; final providerName = providerNameFor(provider.providerElement, options); final returnType = provider.createdTypeNode?.type; if (returnType != null && !returnType.isRaw) { if ((returnType.isDartAsyncFutureOr) || (returnType.isDartAsyncFuture)) { - notifierBaseType = '${leading}AsyncNotifier'; - providerType = '${leading}AsyncNotifierProvider'; + notifierBaseType = 'AsyncNotifier'; + providerType = 'AsyncNotifierProvider'; } else if (returnType.isDartAsyncStream) { - notifierBaseType = '${leading}StreamNotifier'; - providerType = '${leading}StreamNotifierProvider'; + notifierBaseType = 'StreamNotifier'; + providerType = 'StreamNotifierProvider'; } } @@ -116,6 +115,9 @@ ${metaAnnotations(provider.node.metadata)} final $providerName = $providerType<${provider.name}, ${provider.valueTypeDisplayString}>.internal( ${provider.providerElement.name}.new, name: r'$providerName', + from: null, + argument: null, + $isAutoDispose debugGetCreateSourceHash: $hashFn, dependencies: ${serializeDependencies(provider.providerElement.annotation, options)}, allTransitiveDependencies: ${serializeAllTransitiveDependencies(provider.providerElement.annotation, options)}, diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 2fb076c6a..f7d61f27d 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -59,29 +59,24 @@ class FamilyTemplate extends Template { required String hashFn, required BuildYamlOptions options, }) { - var leading = ''; - if (!provider.annotation.element.keepAlive) { - leading = 'AutoDispose'; - } - - var providerType = '${leading}Provider'; - var refType = '${leading}ProviderRef'; - var elementType = '${leading}ProviderElement'; + var providerType = 'Provider'; + var refType = 'Ref<${provider.valueTypeDisplayString}>'; + var elementType = 'ProviderElement'; var createdType = provider.createdTypeDisplayString; final returnType = provider.createdTypeNode?.type; if (returnType != null && !returnType.isRaw) { if (returnType.isDartAsyncFutureOr || returnType.isDartAsyncFuture) { - providerType = '${leading}FutureProvider'; - refType = '${leading}FutureProviderRef'; - elementType = '${leading}FutureProviderElement'; + providerType = 'FutureProvider'; + refType = 'Ref>'; + elementType = 'FutureProviderElement'; // Always use FutureOr in overrideWith as return value // or otherwise we get a compilation error. createdType = 'FutureOr<${provider.valueTypeDisplayString}>'; } else if (returnType.isDartAsyncStream) { - providerType = '${leading}StreamProvider'; - refType = '${leading}StreamProviderRef'; - elementType = '${leading}StreamProviderElement'; + providerType = 'StreamProvider'; + refType = 'Ref>'; + elementType = 'StreamProviderElement'; } } @@ -254,6 +249,10 @@ ${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} @override void run(StringBuffer buffer) { + final isAutoDispose = !provider.providerElement.annotation.keepAlive + ? 'isAutoDispose: true,' + : ''; + final providerTypeNameImpl = provider._providerImplName; final refNameImpl = provider._refImplName; final elementNameImpl = '_${providerTypeNameImpl.public}Element'; @@ -308,21 +307,19 @@ const $providerName = $familyName(); $docs class $familyName extends Family { $docs - const $familyName(); + const $familyName() + : super( + name: r'$providerName', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: $hashFn, + $isAutoDispose + ); static $dependenciesKeyword _dependencies = ${serializeDependencies(provider.providerElement.annotation, options)}; static $dependenciesKeyword _allTransitiveDependencies = ${serializeAllTransitiveDependencies(provider.providerElement.annotation, options)}; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => _allTransitiveDependencies; - - @override - String? get name => r'$providerName'; - $docs $providerTypeNameImpl$typeParametersUsage call$typeParametersDefinition($parameterDefinition) { return $providerTypeNameImpl$typeParametersUsage($parametersPassThrough); @@ -439,7 +436,7 @@ ${[ String toString() => '$encodedProviderName$encodedGenerics\$argument'; } -mixin $refNameImpl$typeParametersDefinition on $refType<${provider.valueTypeDisplayString}> { +mixin $refNameImpl$typeParametersDefinition on $refType { ${parameters.map((e) { return ''' /// The parameter `${e.name}` of this provider. diff --git a/packages/riverpod_generator/lib/src/templates/functional_provider.dart b/packages/riverpod_generator/lib/src/templates/functional_provider.dart index 66760f86e..8ffbaa5bd 100644 --- a/packages/riverpod_generator/lib/src/templates/functional_provider.dart +++ b/packages/riverpod_generator/lib/src/templates/functional_provider.dart @@ -27,20 +27,21 @@ class FunctionalProviderTemplate extends Template { @override void run(StringBuffer buffer) { - var leading = ''; + final isAutoDispose = !provider.providerElement.annotation.keepAlive + ? 'isAutoDispose: true,' + : ''; - if (!provider.annotation.element.keepAlive) { - leading = 'AutoDispose'; - } - - var providerType = '${leading}Provider'; + var providerType = 'Provider'; + var refType = 'Ref<${provider.valueTypeDisplayString}>'; final returnType = provider.createdTypeNode?.type; if (returnType != null && !returnType.isRaw) { if ((returnType.isDartAsyncFutureOr) || (returnType.isDartAsyncFuture)) { - providerType = '${leading}FutureProvider'; + providerType = 'FutureProvider'; + refType = 'Ref>'; } else if (returnType.isDartAsyncStream) { - providerType = '${leading}StreamProvider'; + providerType = 'StreamProvider'; + refType = 'Ref>'; } } @@ -63,11 +64,14 @@ final $providerName = $providerType<${provider.valueTypeDisplayString}>.internal $createFn, name: r'$providerName', debugGetCreateSourceHash: $hashFn, + from: null, + argument: null, + $isAutoDispose dependencies: ${serializeDependencies(provider.providerElement.annotation, options)}, allTransitiveDependencies: ${serializeAllTransitiveDependencies(provider.providerElement.annotation, options)}, ); -typedef $refName = ${providerType}Ref<${provider.valueTypeDisplayString}>; +typedef $refName = $refType; '''); } } diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 9d7ff448f..cd0d10a8f 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -13,16 +13,19 @@ String _$functionalHash() => r'69e260b1de8ba28cbeb8e24d628933366cde6b8b'; @Deprecated('Deprecation message') @visibleForTesting @protected -final functionalProvider = AutoDisposeProvider.internal( +final functionalProvider = Provider.internal( functional, name: r'functionalProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$functionalHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef FunctionalRef = AutoDisposeProviderRef; +typedef FunctionalRef = Ref; String _$familyHash() => r'd70685b83be840bfd9e79c11fb84c905d19d6e10'; /// Copied from Dart SDK @@ -56,22 +59,22 @@ const familyProvider = FamilyFamily(); /// See also [family]. class FamilyFamily extends Family { /// See also [family]. - const FamilyFamily(); + const FamilyFamily() + : super( + name: r'familyProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$familyHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'familyProvider'; - /// See also [family]. FamilyProvider call( int id, @@ -111,7 +114,7 @@ class _$FamilyFamilyOverride implements FamilyOverride { } /// See also [family]. -class FamilyProvider extends AutoDisposeProvider { +class FamilyProvider extends Provider { /// See also [family]. FamilyProvider( int id, @@ -204,13 +207,12 @@ class FamilyProvider extends AutoDisposeProvider { String toString() => 'familyProvider$argument'; } -mixin FamilyRef on AutoDisposeProviderRef { +mixin FamilyRef on Ref { /// The parameter `id` of this provider. int get id; } -class _FamilyProviderElement extends AutoDisposeProviderElement - with FamilyRef { +class _FamilyProviderElement extends ProviderElement with FamilyRef { _FamilyProviderElement(super.provider, super.container); @override @@ -222,17 +224,20 @@ String _$notCopiedFunctionalHash() => /// See also [notCopiedFunctional]. @ProviderFor(notCopiedFunctional) -final notCopiedFunctionalProvider = AutoDisposeProvider.internal( +final notCopiedFunctionalProvider = Provider.internal( notCopiedFunctional, name: r'notCopiedFunctionalProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$notCopiedFunctionalHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef NotCopiedFunctionalRef = AutoDisposeProviderRef; +typedef NotCopiedFunctionalRef = Ref; String _$notCopiedFamilyHash() => r'6ef06ce6ebd73b476870bbe1af41c4f3fbe8ddb1'; /// See also [notCopiedFamily]. @@ -242,22 +247,22 @@ const notCopiedFamilyProvider = NotCopiedFamilyFamily(); /// See also [notCopiedFamily]. class NotCopiedFamilyFamily extends Family { /// See also [notCopiedFamily]. - const NotCopiedFamilyFamily(); + const NotCopiedFamilyFamily() + : super( + name: r'notCopiedFamilyProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$notCopiedFamilyHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'notCopiedFamilyProvider'; - /// See also [notCopiedFamily]. NotCopiedFamilyProvider call( int id, @@ -297,7 +302,7 @@ class _$NotCopiedFamilyFamilyOverride implements FamilyOverride { } /// See also [notCopiedFamily]. -class NotCopiedFamilyProvider extends AutoDisposeProvider { +class NotCopiedFamilyProvider extends Provider { /// See also [notCopiedFamily]. NotCopiedFamilyProvider( int id, @@ -390,12 +395,12 @@ class NotCopiedFamilyProvider extends AutoDisposeProvider { String toString() => 'notCopiedFamilyProvider$argument'; } -mixin NotCopiedFamilyRef on AutoDisposeProviderRef { +mixin NotCopiedFamilyRef on Ref { /// The parameter `id` of this provider. int get id; } -class _NotCopiedFamilyProviderElement extends AutoDisposeProviderElement +class _NotCopiedFamilyProviderElement extends ProviderElement with NotCopiedFamilyRef { _NotCopiedFamilyProviderElement(super.provider, super.container); @@ -410,26 +415,31 @@ String _$classBasedHash() => r'f40d1a032ee264aafd7686a985cdf1937f2dc108'; @Deprecated('Deprecation message') @visibleForTesting @protected -final classBasedProvider = - AutoDisposeNotifierProvider.internal( +final classBasedProvider = NotifierProvider.internal( ClassBased.new, name: r'classBasedProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$classBasedHash, dependencies: null, allTransitiveDependencies: null, ); -typedef _$ClassBased = AutoDisposeNotifier; +typedef _$ClassBased = Notifier; String _$notCopiedClassBasedHash() => r'd2aefd08a78e3bb4c02000d4931a3bf15c01b495'; /// See also [NotCopiedClassBased]. @ProviderFor(NotCopiedClassBased) final notCopiedClassBasedProvider = - AutoDisposeNotifierProvider.internal( + NotifierProvider.internal( NotCopiedClassBased.new, name: r'notCopiedClassBasedProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$notCopiedClassBasedHash, @@ -437,6 +447,6 @@ final notCopiedClassBasedProvider = allTransitiveDependencies: null, ); -typedef _$NotCopiedClassBased = AutoDisposeNotifier; +typedef _$NotCopiedClassBased = Notifier; // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index cc8449f43..e667d8e37 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -36,22 +36,22 @@ const genericProvider = GenericFamily(); /// See also [generic]. class GenericFamily extends Family { /// See also [generic]. - const GenericFamily(); + const GenericFamily() + : super( + name: r'genericProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'genericProvider'; - /// See also [generic]. GenericProvider call() { return GenericProvider(); @@ -88,8 +88,7 @@ class _$GenericFamilyOverride implements FamilyOverride { } /// See also [generic]. -class GenericProvider - extends AutoDisposeFutureProvider> { +class GenericProvider extends FutureProvider> { /// See also [generic]. GenericProvider() : this._internal( @@ -174,10 +173,10 @@ class GenericProvider String toString() => 'genericProvider<$T>$argument'; } -mixin GenericRef on AutoDisposeFutureProviderRef> {} +mixin GenericRef on Ref>> {} class _GenericProviderElement - extends AutoDisposeFutureProviderElement> with GenericRef { + extends FutureProviderElement> with GenericRef { _GenericProviderElement(super.provider, super.container); } @@ -185,30 +184,36 @@ String _$publicHash() => r'9d99b79c013da13926d4ad89c72ebca4fc1cc257'; /// See also [public]. @ProviderFor(public) -final publicProvider = AutoDisposeFutureProvider.internal( +final publicProvider = FutureProvider.internal( public, name: r'publicProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$publicHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef PublicRef = AutoDisposeFutureProviderRef; +typedef PublicRef = Ref>; String _$privateHash() => r'bc0469a9315de114a0ccd82c7db4980844d0009f'; /// See also [_private]. @ProviderFor(_private) -final _privateProvider = AutoDisposeFutureProvider.internal( +final _privateProvider = FutureProvider.internal( _private, name: r'_privateProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$privateHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef _PrivateRef = AutoDisposeFutureProviderRef; +typedef _PrivateRef = Ref>; String _$familyOrHash() => r'1c3217e296b0ce52c07c18769d1fffb95850f482'; /// See also [familyOr]. @@ -218,22 +223,22 @@ const familyOrProvider = FamilyOrFamily(); /// See also [familyOr]. class FamilyOrFamily extends Family { /// See also [familyOr]. - const FamilyOrFamily(); + const FamilyOrFamily() + : super( + name: r'familyOrProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$familyOrHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'familyOrProvider'; - /// See also [familyOr]. FamilyOrProvider call( int first, @@ -273,7 +278,7 @@ class _$FamilyOrFamilyOverride implements FamilyOverride { } /// See also [familyOr]. -class FamilyOrProvider extends AutoDisposeFutureProvider { +class FamilyOrProvider extends FutureProvider { /// See also [familyOr]. FamilyOrProvider( int first, @@ -366,12 +371,12 @@ class FamilyOrProvider extends AutoDisposeFutureProvider { String toString() => 'familyOrProvider$argument'; } -mixin FamilyOrRef on AutoDisposeFutureProviderRef { +mixin FamilyOrRef on Ref> { /// The parameter `first` of this provider. int get first; } -class _FamilyOrProviderElement extends AutoDisposeFutureProviderElement +class _FamilyOrProviderElement extends FutureProviderElement with FamilyOrRef { _FamilyOrProviderElement(super.provider, super.container); @@ -388,22 +393,22 @@ const familyProvider = FamilyFamily(); /// See also [family]. class FamilyFamily extends Family { /// See also [family]. - const FamilyFamily(); + const FamilyFamily() + : super( + name: r'familyProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$familyHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'familyProvider'; - /// See also [family]. FamilyProvider call( int first, { @@ -451,7 +456,7 @@ class _$FamilyFamilyOverride implements FamilyOverride { } /// See also [family]. -class FamilyProvider extends AutoDisposeFutureProvider { +class FamilyProvider extends FutureProvider { /// See also [family]. FamilyProvider( int first, { @@ -593,7 +598,7 @@ class FamilyProvider extends AutoDisposeFutureProvider { String toString() => 'familyProvider$argument'; } -mixin FamilyRef on AutoDisposeFutureProviderRef { +mixin FamilyRef on Ref> { /// The parameter `first` of this provider. int get first; @@ -610,7 +615,7 @@ mixin FamilyRef on AutoDisposeFutureProviderRef { List? get fifth; } -class _FamilyProviderElement extends AutoDisposeFutureProviderElement +class _FamilyProviderElement extends FutureProviderElement with FamilyRef { _FamilyProviderElement(super.provider, super.container); @@ -640,22 +645,22 @@ const genericClassProvider = GenericClassFamily(); /// See also [GenericClass]. class GenericClassFamily extends Family { /// See also [GenericClass]. - const GenericClassFamily(); + const GenericClassFamily() + : super( + name: r'genericClassProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericClassHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'genericClassProvider'; - /// See also [GenericClass]. GenericClassProvider call() { return GenericClassProvider(); @@ -780,8 +785,7 @@ class GenericClassProvider String toString() => 'genericClassProvider<$T>$argument'; } -mixin GenericClassRef - on AutoDisposeAsyncNotifierProviderRef> {} +mixin GenericClassRef on AutoDisposeAsyncNotifierProviderRef {} class _GenericClassProviderElement extends AutoDisposeAsyncNotifierProviderElement, List> @@ -793,32 +797,37 @@ String _$publicClassHash() => r'e9bc69e44b72e8ed77d423524c0d74ad460d629d'; /// See also [PublicClass]. @ProviderFor(PublicClass) -final publicClassProvider = - AutoDisposeAsyncNotifierProvider.internal( +final publicClassProvider = AsyncNotifierProvider.internal( PublicClass.new, name: r'publicClassProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$publicClassHash, dependencies: null, allTransitiveDependencies: null, ); -typedef _$PublicClass = AutoDisposeAsyncNotifier; +typedef _$PublicClass = AsyncNotifier; String _$privateClassHash() => r'7e69cffe8315999710e4cb6bb3de9f179d3f2f5d'; /// See also [_PrivateClass]. @ProviderFor(_PrivateClass) final _privateClassProvider = - AutoDisposeAsyncNotifierProvider<_PrivateClass, String>.internal( + AsyncNotifierProvider<_PrivateClass, String>.internal( _PrivateClass.new, name: r'_privateClassProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$privateClassHash, dependencies: null, allTransitiveDependencies: null, ); -typedef _$PrivateClass = AutoDisposeAsyncNotifier; +typedef _$PrivateClass = AsyncNotifier; String _$familyOrClassHash() => r'b4882d4e79a03c63005d35eb7a021c9c4373a8d9'; abstract class _$FamilyOrClass @@ -837,22 +846,22 @@ const familyOrClassProvider = FamilyOrClassFamily(); /// See also [FamilyOrClass]. class FamilyOrClassFamily extends Family { /// See also [FamilyOrClass]. - const FamilyOrClassFamily(); + const FamilyOrClassFamily() + : super( + name: r'familyOrClassProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$familyOrClassHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'familyOrClassProvider'; - /// See also [FamilyOrClass]. FamilyOrClassProvider call( int first, @@ -990,7 +999,7 @@ class FamilyOrClassProvider String toString() => 'familyOrClassProvider$argument'; } -mixin FamilyOrClassRef on AutoDisposeAsyncNotifierProviderRef { +mixin FamilyOrClassRef on AutoDisposeAsyncNotifierProviderRef { /// The parameter `first` of this provider. int get first; } @@ -1029,22 +1038,22 @@ const familyClassProvider = FamilyClassFamily(); /// See also [FamilyClass]. class FamilyClassFamily extends Family { /// See also [FamilyClass]. - const FamilyClassFamily(); + const FamilyClassFamily() + : super( + name: r'familyClassProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$familyClassHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'familyClassProvider'; - /// See also [FamilyClass]. FamilyClassProvider call( int first, { @@ -1254,7 +1263,7 @@ class FamilyClassProvider String toString() => 'familyClassProvider$argument'; } -mixin FamilyClassRef on AutoDisposeAsyncNotifierProviderRef { +mixin FamilyClassRef on AutoDisposeAsyncNotifierProviderRef { /// The parameter `first` of this provider. int get first; diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 3d6ee6934..a5e1a26d3 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -15,24 +15,29 @@ final keepAliveProvider = Provider.internal( name: r'keepAliveProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$keepAliveHash, + from: null, + argument: null, dependencies: null, allTransitiveDependencies: null, ); -typedef KeepAliveRef = ProviderRef; +typedef KeepAliveRef = Ref; String _$notKeepAliveHash() => r'1ccc497d7c651f8e730ec1bcecf271ffe9615d83'; /// See also [notKeepAlive]. @ProviderFor(notKeepAlive) -final notKeepAliveProvider = AutoDisposeProvider.internal( +final notKeepAliveProvider = Provider.internal( notKeepAlive, name: r'notKeepAliveProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$notKeepAliveHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef NotKeepAliveRef = AutoDisposeProviderRef; +typedef NotKeepAliveRef = Ref; // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index b6775918a..568f92752 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -10,16 +10,19 @@ String _$depHash() => r'2213a401e03a1a914579b4a3a7707b783de9efba'; /// See also [dep]. @ProviderFor(dep) -final depProvider = AutoDisposeProvider.internal( +final depProvider = Provider.internal( dep, name: r'depProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$depHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef DepRef = AutoDisposeProviderRef; +typedef DepRef = Ref; String _$familyHash() => r'8c228ff14b8c6cf1f3d4d6266232d64b5057c440'; /// Copied from Dart SDK @@ -50,22 +53,22 @@ const familyProvider = FamilyFamily(); /// See also [family]. class FamilyFamily extends Family { /// See also [family]. - const FamilyFamily(); + const FamilyFamily() + : super( + name: r'familyProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$familyHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'familyProvider'; - /// See also [family]. FamilyProvider call( int id, @@ -105,7 +108,7 @@ class _$FamilyFamilyOverride implements FamilyOverride { } /// See also [family]. -class FamilyProvider extends AutoDisposeProvider { +class FamilyProvider extends Provider { /// See also [family]. FamilyProvider( int id, @@ -198,13 +201,12 @@ class FamilyProvider extends AutoDisposeProvider { String toString() => 'familyProvider$argument'; } -mixin FamilyRef on AutoDisposeProviderRef { +mixin FamilyRef on Ref { /// The parameter `id` of this provider. int get id; } -class _FamilyProviderElement extends AutoDisposeProviderElement - with FamilyRef { +class _FamilyProviderElement extends ProviderElement with FamilyRef { _FamilyProviderElement(super.provider, super.container); @override @@ -215,11 +217,14 @@ String _$providerHash() => r'6c9184ef4c6a410a2132e1ecc13a2e646e936d37'; /// See also [provider]. @ProviderFor(provider) -final providerProvider = AutoDisposeProvider.internal( +final providerProvider = Provider.internal( provider, name: r'providerProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$providerHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: { depProvider, familyProvider, @@ -238,16 +243,19 @@ final providerProvider = AutoDisposeProvider.internal( }, ); -typedef ProviderRef = AutoDisposeProviderRef; +typedef ProviderRef = Ref; String _$provider2Hash() => r'70d908579c5e64ce6558b42f433adfb80f4dc79b'; /// See also [provider2]. @ProviderFor(provider2) -final provider2Provider = AutoDisposeProvider.internal( +final provider2Provider = Provider.internal( provider2, name: r'provider2Provider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$provider2Hash, + from: null, + argument: null, + isAutoDispose: true, dependencies: { depProvider, familyProvider, @@ -266,18 +274,21 @@ final provider2Provider = AutoDisposeProvider.internal( }, ); -typedef Provider2Ref = AutoDisposeProviderRef; +typedef Provider2Ref = Ref; String _$transitiveDependenciesHash() => r'9c81823224bb28a5dc482328c04ce76293370877'; /// See also [transitiveDependencies]. @ProviderFor(transitiveDependencies) -final transitiveDependenciesProvider = AutoDisposeProvider.internal( +final transitiveDependenciesProvider = Provider.internal( transitiveDependencies, name: r'transitiveDependenciesProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$transitiveDependenciesHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: [providerProvider], allTransitiveDependencies: { providerProvider, @@ -285,19 +296,21 @@ final transitiveDependenciesProvider = AutoDisposeProvider.internal( }, ); -typedef TransitiveDependenciesRef = AutoDisposeProviderRef; +typedef TransitiveDependenciesRef = Ref; String _$smallTransitiveDependencyCountHash() => r'34689e1ba57e2959975cbf8ebd6c9483f4652a73'; /// See also [smallTransitiveDependencyCount]. @ProviderFor(smallTransitiveDependencyCount) -final smallTransitiveDependencyCountProvider = - AutoDisposeProvider.internal( +final smallTransitiveDependencyCountProvider = Provider.internal( smallTransitiveDependencyCount, name: r'smallTransitiveDependencyCountProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$smallTransitiveDependencyCountHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: [depProvider, familyProvider, dep2Provider], allTransitiveDependencies: { depProvider, @@ -309,34 +322,40 @@ final smallTransitiveDependencyCountProvider = }, ); -typedef SmallTransitiveDependencyCountRef = AutoDisposeProviderRef; +typedef SmallTransitiveDependencyCountRef = Ref; String _$emptyDependenciesFunctionalHash() => r'592bebd079450e2071fb12d68c3ae333d5c28359'; /// See also [emptyDependenciesFunctional]. @ProviderFor(emptyDependenciesFunctional) -final emptyDependenciesFunctionalProvider = AutoDisposeProvider.internal( +final emptyDependenciesFunctionalProvider = Provider.internal( emptyDependenciesFunctional, name: r'emptyDependenciesFunctionalProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$emptyDependenciesFunctionalHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: const [], allTransitiveDependencies: const {}, ); -typedef EmptyDependenciesFunctionalRef = AutoDisposeProviderRef; +typedef EmptyDependenciesFunctionalRef = Ref; String _$providerWithDependenciesHash() => r'beecbe7a41b647ab92367dbcc12055bcd6345af7'; /// See also [providerWithDependencies]. @ProviderFor(providerWithDependencies) -final providerWithDependenciesProvider = AutoDisposeProvider.internal( +final providerWithDependenciesProvider = Provider.internal( providerWithDependencies, name: r'providerWithDependenciesProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$providerWithDependenciesHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: [_privateDepProvider, publicDepProvider], allTransitiveDependencies: { _privateDepProvider, @@ -346,49 +365,58 @@ final providerWithDependenciesProvider = AutoDisposeProvider.internal( }, ); -typedef ProviderWithDependenciesRef = AutoDisposeProviderRef; +typedef ProviderWithDependenciesRef = Ref; String _$privateDepHash() => r'f610d91bd39e0dcffe6ff4e74160964a291289d9'; /// See also [_privateDep]. @ProviderFor(_privateDep) -final _privateDepProvider = AutoDisposeProvider.internal( +final _privateDepProvider = Provider.internal( _privateDep, name: r'_privateDepProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$privateDepHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef _PrivateDepRef = AutoDisposeProviderRef; +typedef _PrivateDepRef = Ref; String _$publicDepHash() => r'bcb69aace017c86c3c4b8eccf59fa22d010834bc'; /// See also [publicDep]. @ProviderFor(publicDep) -final publicDepProvider = AutoDisposeProvider.internal( +final publicDepProvider = Provider.internal( publicDep, name: r'publicDepProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$publicDepHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef PublicDepRef = AutoDisposeProviderRef; +typedef PublicDepRef = Ref; String _$dep2Hash() => r'2778537df77f6431148c2ce400724da3e2ab4b94'; /// See also [Dep2]. @ProviderFor(Dep2) -final dep2Provider = AutoDisposeNotifierProvider.internal( +final dep2Provider = NotifierProvider.internal( Dep2.new, name: r'dep2Provider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$dep2Hash, dependencies: null, allTransitiveDependencies: null, ); -typedef _$Dep2 = AutoDisposeNotifier; +typedef _$Dep2 = Notifier; String _$family2Hash() => r'ce727b262aae067b0d4f703f03670abb70ad8977'; abstract class _$Family2 extends BuildlessAutoDisposeNotifier { @@ -406,22 +434,22 @@ const family2Provider = Family2Family(); /// See also [Family2]. class Family2Family extends Family { /// See also [Family2]. - const Family2Family(); + const Family2Family() + : super( + name: r'family2Provider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$family2Hash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'family2Provider'; - /// See also [Family2]. Family2Provider call( int id, @@ -558,7 +586,7 @@ class Family2Provider extends AutoDisposeNotifierProviderImpl { String toString() => 'family2Provider$argument'; } -mixin Family2Ref on AutoDisposeNotifierProviderRef { +mixin Family2Ref on AutoDisposeNotifierProviderRef { /// The parameter `id` of this provider. int get id; } @@ -575,9 +603,12 @@ String _$provider3Hash() => r'dfdd6dec6cfee543c73d99593ce98d68f4db385c'; /// See also [Provider3]. @ProviderFor(Provider3) -final provider3Provider = AutoDisposeNotifierProvider.internal( +final provider3Provider = NotifierProvider.internal( Provider3.new, name: r'provider3Provider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$provider3Hash, dependencies: { @@ -598,7 +629,7 @@ final provider3Provider = AutoDisposeNotifierProvider.internal( }, ); -typedef _$Provider3 = AutoDisposeNotifier; +typedef _$Provider3 = Notifier; String _$provider4Hash() => r'1c955214d99695bb694c96374b277aac58e734df'; abstract class _$Provider4 extends BuildlessAutoDisposeNotifier { @@ -616,7 +647,17 @@ const provider4Provider = Provider4Family(); /// See also [Provider4]. class Provider4Family extends Family { /// See also [Provider4]. - const Provider4Family(); + const Provider4Family() + : super( + name: r'provider4Provider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$provider4Hash, + isAutoDispose: true, + ); static final Iterable _dependencies = { depProvider, @@ -637,16 +678,6 @@ class Provider4Family extends Family { ...?family2Provider.allTransitiveDependencies }; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'provider4Provider'; - /// See also [Provider4]. Provider4Provider call( int id, @@ -784,7 +815,7 @@ class Provider4Provider String toString() => 'provider4Provider$argument'; } -mixin Provider4Ref on AutoDisposeNotifierProviderRef { +mixin Provider4Ref on AutoDisposeNotifierProviderRef { /// The parameter `id` of this provider. int get id; } @@ -804,9 +835,12 @@ String _$emptyDependenciesClassBasedHash() => /// See also [EmptyDependenciesClassBased]. @ProviderFor(EmptyDependenciesClassBased) final emptyDependenciesClassBasedProvider = - AutoDisposeNotifierProvider.internal( + NotifierProvider.internal( EmptyDependenciesClassBased.new, name: r'emptyDependenciesClassBasedProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$emptyDependenciesClassBasedHash, @@ -814,6 +848,6 @@ final emptyDependenciesClassBasedProvider = allTransitiveDependencies: const {}, ); -typedef _$EmptyDependenciesClassBased = AutoDisposeNotifier; +typedef _$EmptyDependenciesClassBased = Notifier; // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index acb75115c..29b76d4f5 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -11,12 +11,15 @@ String _$providerWithDependencies2Hash() => /// See also [providerWithDependencies2]. @ProviderFor(providerWithDependencies2) -final providerWithDependencies2Provider = AutoDisposeProvider.internal( +final providerWithDependencies2Provider = Provider.internal( providerWithDependencies2, name: r'providerWithDependencies2Provider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$providerWithDependencies2Hash, + from: null, + argument: null, + isAutoDispose: true, dependencies: [ providerWithDependenciesProvider, _private2Provider, @@ -32,7 +35,7 @@ final providerWithDependencies2Provider = AutoDisposeProvider.internal( }, ); -typedef ProviderWithDependencies2Ref = AutoDisposeProviderRef; +typedef ProviderWithDependencies2Ref = Ref; String _$familyWithDependencies2Hash() => r'209b9e3ed4e5fad89572268d161fbe64a6ef0e87'; @@ -64,7 +67,17 @@ const familyWithDependencies2Provider = FamilyWithDependencies2Family(); /// See also [familyWithDependencies2]. class FamilyWithDependencies2Family extends Family { /// See also [familyWithDependencies2]. - const FamilyWithDependencies2Family(); + const FamilyWithDependencies2Family() + : super( + name: r'familyWithDependencies2Provider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$familyWithDependencies2Hash, + isAutoDispose: true, + ); static final Iterable _dependencies = [ providerWithDependenciesProvider, @@ -82,16 +95,6 @@ class FamilyWithDependencies2Family extends Family { ...?public2Provider.allTransitiveDependencies }; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'familyWithDependencies2Provider'; - /// See also [familyWithDependencies2]. FamilyWithDependencies2Provider call({ int? id, @@ -131,7 +134,7 @@ class _$FamilyWithDependencies2FamilyOverride implements FamilyOverride { } /// See also [familyWithDependencies2]. -class FamilyWithDependencies2Provider extends AutoDisposeProvider { +class FamilyWithDependencies2Provider extends Provider { /// See also [familyWithDependencies2]. FamilyWithDependencies2Provider({ int? id, @@ -226,13 +229,13 @@ class FamilyWithDependencies2Provider extends AutoDisposeProvider { String toString() => 'familyWithDependencies2Provider$argument'; } -mixin FamilyWithDependencies2Ref on AutoDisposeProviderRef { +mixin FamilyWithDependencies2Ref on Ref { /// The parameter `id` of this provider. int? get id; } -class _FamilyWithDependencies2ProviderElement - extends AutoDisposeProviderElement with FamilyWithDependencies2Ref { +class _FamilyWithDependencies2ProviderElement extends ProviderElement + with FamilyWithDependencies2Ref { _FamilyWithDependencies2ProviderElement(super.provider, super.container); @override @@ -243,39 +246,48 @@ String _$private2Hash() => r'5e0fa14ff40fb444c027ed25150a42362db3ef19'; /// See also [_private2]. @ProviderFor(_private2) -final _private2Provider = AutoDisposeProvider.internal( +final _private2Provider = Provider.internal( _private2, name: r'_private2Provider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$private2Hash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef _Private2Ref = AutoDisposeProviderRef; +typedef _Private2Ref = Ref; String _$public2Hash() => r'9767255f0182589fe48b29d217dd488b0a13b9d5'; /// See also [public2]. @ProviderFor(public2) -final public2Provider = AutoDisposeProvider.internal( +final public2Provider = Provider.internal( public2, name: r'public2Provider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$public2Hash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef Public2Ref = AutoDisposeProviderRef; +typedef Public2Ref = Ref; String _$notifierWithDependenciesHash() => r'becc68e5a54b0cc2b8277a6d54b74edef93bfe89'; /// See also [NotifierWithDependencies]. @ProviderFor(NotifierWithDependencies) final notifierWithDependenciesProvider = - AutoDisposeNotifierProvider.internal( + NotifierProvider.internal( NotifierWithDependencies.new, name: r'notifierWithDependenciesProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$notifierWithDependenciesHash, @@ -294,7 +306,7 @@ final notifierWithDependenciesProvider = }, ); -typedef _$NotifierWithDependencies = AutoDisposeNotifier; +typedef _$NotifierWithDependencies = Notifier; String _$notifierFamilyWithDependenciesHash() => r'b185ba93857cd028964c1412e748ee887dbd45c8'; @@ -315,7 +327,17 @@ const notifierFamilyWithDependenciesProvider = /// See also [NotifierFamilyWithDependencies]. class NotifierFamilyWithDependenciesFamily extends Family { /// See also [NotifierFamilyWithDependencies]. - const NotifierFamilyWithDependenciesFamily(); + const NotifierFamilyWithDependenciesFamily() + : super( + name: r'notifierFamilyWithDependenciesProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$notifierFamilyWithDependenciesHash, + isAutoDispose: true, + ); static final Iterable _dependencies = [ providerWithDependenciesProvider, @@ -333,16 +355,6 @@ class NotifierFamilyWithDependenciesFamily extends Family { ...?public2Provider.allTransitiveDependencies }; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'notifierFamilyWithDependenciesProvider'; - /// See also [NotifierFamilyWithDependencies]. NotifierFamilyWithDependenciesProvider call({ int? id, @@ -484,7 +496,7 @@ class NotifierFamilyWithDependenciesProvider String toString() => 'notifierFamilyWithDependenciesProvider$argument'; } -mixin NotifierFamilyWithDependenciesRef on AutoDisposeNotifierProviderRef { +mixin NotifierFamilyWithDependenciesRef on AutoDisposeNotifierProviderRef { /// The parameter `id` of this provider. int? get id; } diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 32382bf36..e795faf6e 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -10,16 +10,19 @@ String _$generatedHash() => r'e49f3520d06ed50d34a44de613fdcd20b19f48d4'; /// See also [generated]. @ProviderFor(generated) -final generatedProvider = AutoDisposeProvider<_Test>.internal( +final generatedProvider = Provider<_Test>.internal( generated, name: r'generatedProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$generatedHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef GeneratedRef = AutoDisposeProviderRef<_Test>; +typedef GeneratedRef = Ref<_Test>; String _$generatedFamilyHash() => r'ed284f58926c87acc81dab9168882d5d1c2cddf8'; /// Copied from Dart SDK @@ -50,22 +53,22 @@ const generatedFamilyProvider = GeneratedFamilyFamily(); /// See also [generatedFamily]. class GeneratedFamilyFamily extends Family { /// See also [generatedFamily]. - const GeneratedFamilyFamily(); + const GeneratedFamilyFamily() + : super( + name: r'generatedFamilyProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$generatedFamilyHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'generatedFamilyProvider'; - /// See also [generatedFamily]. GeneratedFamilyProvider call( _Test test, @@ -105,7 +108,7 @@ class _$GeneratedFamilyFamilyOverride implements FamilyOverride { } /// See also [generatedFamily]. -class GeneratedFamilyProvider extends AutoDisposeProvider<_Test> { +class GeneratedFamilyProvider extends Provider<_Test> { /// See also [generatedFamily]. GeneratedFamilyProvider( _Test test, @@ -198,12 +201,12 @@ class GeneratedFamilyProvider extends AutoDisposeProvider<_Test> { String toString() => 'generatedFamilyProvider$argument'; } -mixin GeneratedFamilyRef on AutoDisposeProviderRef<_Test> { +mixin GeneratedFamilyRef on Ref<_Test> { /// The parameter `test` of this provider. _Test get test; } -class _GeneratedFamilyProviderElement extends AutoDisposeProviderElement<_Test> +class _GeneratedFamilyProviderElement extends ProviderElement<_Test> with GeneratedFamilyRef { _GeneratedFamilyProviderElement(super.provider, super.container); @@ -215,16 +218,19 @@ String _$$dynamicHash() => r'f62d63d9340f30b253e687f76deacd8205fed0e7'; /// See also [$dynamic]. @ProviderFor($dynamic) -final $dynamicProvider = AutoDisposeProvider.internal( +final $dynamicProvider = Provider.internal( $dynamic, name: r'$dynamicProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$$dynamicHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef $DynamicRef = AutoDisposeProviderRef; +typedef $DynamicRef = Ref; String _$$dynamicFamilyHash() => r'b764133af8837b8321b08814892f198d4bc1aa18'; /// See also [$dynamicFamily]. @@ -234,22 +240,22 @@ const $dynamicFamilyProvider = $DynamicFamilyFamily(); /// See also [$dynamicFamily]. class $DynamicFamilyFamily extends Family { /// See also [$dynamicFamily]. - const $DynamicFamilyFamily(); + const $DynamicFamilyFamily() + : super( + name: r'$dynamicFamilyProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$$dynamicFamilyHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'$dynamicFamilyProvider'; - /// See also [$dynamicFamily]. $DynamicFamilyProvider call( test, @@ -289,7 +295,7 @@ class _$$DynamicFamilyFamilyOverride implements FamilyOverride { } /// See also [$dynamicFamily]. -class $DynamicFamilyProvider extends AutoDisposeProvider { +class $DynamicFamilyProvider extends Provider { /// See also [$dynamicFamily]. $DynamicFamilyProvider( test, @@ -382,12 +388,12 @@ class $DynamicFamilyProvider extends AutoDisposeProvider { String toString() => '\$dynamicFamilyProvider$argument'; } -mixin $DynamicFamilyRef on AutoDisposeProviderRef { +mixin $DynamicFamilyRef on Ref { /// The parameter `test` of this provider. get test; } -class _$DynamicFamilyProviderElement extends AutoDisposeProviderElement +class _$DynamicFamilyProviderElement extends ProviderElement with $DynamicFamilyRef { _$DynamicFamilyProviderElement(super.provider, super.container); @@ -404,22 +410,22 @@ const _dynamicProvider = _DynamicFamily(); /// See also [_dynamic]. class _DynamicFamily extends Family { /// See also [_dynamic]. - const _DynamicFamily(); + const _DynamicFamily() + : super( + name: r'_dynamicProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$dynamicHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'_dynamicProvider'; - /// See also [_dynamic]. _DynamicProvider call( test, @@ -459,7 +465,7 @@ class _$DynamicFamilyOverride implements FamilyOverride { } /// See also [_dynamic]. -class _DynamicProvider extends AutoDisposeProvider { +class _DynamicProvider extends Provider { /// See also [_dynamic]. _DynamicProvider( test, @@ -552,12 +558,12 @@ class _DynamicProvider extends AutoDisposeProvider { String toString() => '_dynamicProvider$argument'; } -mixin _DynamicRef on AutoDisposeProviderRef { +mixin _DynamicRef on Ref { /// The parameter `test` of this provider. get test; } -class _DynamicProviderElement extends AutoDisposeProviderElement +class _DynamicProviderElement extends ProviderElement with _DynamicRef { _DynamicProviderElement(super.provider, super.container); @@ -569,16 +575,19 @@ String _$aliasHash() => r'cc08ec4cc5ec0dc98bdb7f4dcbc035021b09bcf3'; /// See also [alias]. @ProviderFor(alias) -final aliasProvider = AutoDisposeProvider>.internal( +final aliasProvider = Provider>.internal( alias, name: r'aliasProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$aliasHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef AliasRef = AutoDisposeProviderRef>; +typedef AliasRef = Ref>; String _$aliasFamilyHash() => r'f345937d5750132f629aef41646b119a301f750b'; /// See also [aliasFamily]. @@ -588,22 +597,22 @@ const aliasFamilyProvider = AliasFamilyFamily(); /// See also [aliasFamily]. class AliasFamilyFamily extends Family { /// See also [aliasFamily]. - const AliasFamilyFamily(); + const AliasFamilyFamily() + : super( + name: r'aliasFamilyProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$aliasFamilyHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'aliasFamilyProvider'; - /// See also [aliasFamily]. AliasFamilyProvider call( r.AsyncValue test, @@ -643,7 +652,7 @@ class _$AliasFamilyFamilyOverride implements FamilyOverride { } /// See also [aliasFamily]. -class AliasFamilyProvider extends AutoDisposeProvider> { +class AliasFamilyProvider extends Provider> { /// See also [aliasFamily]. AliasFamilyProvider( r.AsyncValue test, @@ -736,13 +745,13 @@ class AliasFamilyProvider extends AutoDisposeProvider> { String toString() => 'aliasFamilyProvider$argument'; } -mixin AliasFamilyRef on AutoDisposeProviderRef> { +mixin AliasFamilyRef on Ref> { /// The parameter `test` of this provider. r.AsyncValue get test; } -class _AliasFamilyProviderElement - extends AutoDisposeProviderElement> with AliasFamilyRef { +class _AliasFamilyProviderElement extends ProviderElement> + with AliasFamilyRef { _AliasFamilyProviderElement(super.provider, super.container); @override @@ -753,10 +762,12 @@ String _$generatedClassHash() => r'984153f97e25de687d2f19756b277aabd56f6e72'; /// See also [GeneratedClass]. @ProviderFor(GeneratedClass) -final generatedClassProvider = - AutoDisposeNotifierProvider.internal( +final generatedClassProvider = NotifierProvider.internal( GeneratedClass.new, name: r'generatedClassProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$generatedClassHash, @@ -764,7 +775,7 @@ final generatedClassProvider = allTransitiveDependencies: null, ); -typedef _$GeneratedClass = AutoDisposeNotifier<_Test>; +typedef _$GeneratedClass = Notifier<_Test>; String _$generatedClassFamilyHash() => r'28d0a5a82af5b254f6ef07b492916e2feb7e6e63'; @@ -784,22 +795,22 @@ const generatedClassFamilyProvider = GeneratedClassFamilyFamily(); /// See also [GeneratedClassFamily]. class GeneratedClassFamilyFamily extends Family { /// See also [GeneratedClassFamily]. - const GeneratedClassFamilyFamily(); + const GeneratedClassFamilyFamily() + : super( + name: r'generatedClassFamilyProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$generatedClassFamilyHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'generatedClassFamilyProvider'; - /// See also [GeneratedClassFamily]. GeneratedClassFamilyProvider call( _Test test, @@ -937,7 +948,7 @@ class GeneratedClassFamilyProvider String toString() => 'generatedClassFamilyProvider$argument'; } -mixin GeneratedClassFamilyRef on AutoDisposeNotifierProviderRef<_Test> { +mixin GeneratedClassFamilyRef on AutoDisposeNotifierProviderRef { /// The parameter `test` of this provider. _Test get test; } @@ -955,10 +966,12 @@ String _$$dynamicClassHash() => r'c6d8e5191c3f060df3ce3eee66107433fd4c3292'; /// See also [$DynamicClass]. @ProviderFor($DynamicClass) -final $dynamicClassProvider = - AutoDisposeNotifierProvider<$DynamicClass, Object?>.internal( +final $dynamicClassProvider = NotifierProvider<$DynamicClass, Object?>.internal( $DynamicClass.new, name: r'$dynamicClassProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$$dynamicClassHash, @@ -966,7 +979,7 @@ final $dynamicClassProvider = allTransitiveDependencies: null, ); -typedef _$$DynamicClass = AutoDisposeNotifier; +typedef _$$DynamicClass = Notifier; String _$$dynamicClassFamilyHash() => r'bdda961386f3b647c071d79293a8da441580c470'; @@ -986,22 +999,22 @@ const $dynamicClassFamilyProvider = $DynamicClassFamilyFamily(); /// See also [$DynamicClassFamily]. class $DynamicClassFamilyFamily extends Family { /// See also [$DynamicClassFamily]. - const $DynamicClassFamilyFamily(); + const $DynamicClassFamilyFamily() + : super( + name: r'$dynamicClassFamilyProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$$dynamicClassFamilyHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'$dynamicClassFamilyProvider'; - /// See also [$DynamicClassFamily]. $DynamicClassFamilyProvider call( test, @@ -1139,7 +1152,7 @@ class $DynamicClassFamilyProvider String toString() => '\$dynamicClassFamilyProvider$argument'; } -mixin $DynamicClassFamilyRef on AutoDisposeNotifierProviderRef { +mixin $DynamicClassFamilyRef on AutoDisposeNotifierProviderRef { /// The parameter `test` of this provider. get test; } @@ -1158,16 +1171,19 @@ String _$aliasClassHash() => r'a6c6d7594ebd09ba728e42d79b12af560d09c379'; /// See also [AliasClass]. @ProviderFor(AliasClass) final aliasClassProvider = - AutoDisposeNotifierProvider>.internal( + NotifierProvider>.internal( AliasClass.new, name: r'aliasClassProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$aliasClassHash, dependencies: null, allTransitiveDependencies: null, ); -typedef _$AliasClass = AutoDisposeNotifier>; +typedef _$AliasClass = Notifier>; String _$aliasClassFamilyHash() => r'3f348beb95dae3a9890b4a4d0ce01481316fc66d'; abstract class _$AliasClassFamily @@ -1186,22 +1202,22 @@ const aliasClassFamilyProvider = AliasClassFamilyFamily(); /// See also [AliasClassFamily]. class AliasClassFamilyFamily extends Family { /// See also [AliasClassFamily]. - const AliasClassFamilyFamily(); + const AliasClassFamilyFamily() + : super( + name: r'aliasClassFamilyProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$aliasClassFamilyHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'aliasClassFamilyProvider'; - /// See also [AliasClassFamily]. AliasClassFamilyProvider call( r.AsyncValue test, @@ -1339,7 +1355,7 @@ class AliasClassFamilyProvider extends AutoDisposeNotifierProviderImpl< String toString() => 'aliasClassFamilyProvider$argument'; } -mixin AliasClassFamilyRef on AutoDisposeNotifierProviderRef> { +mixin AliasClassFamilyRef on AutoDisposeNotifierProviderRef { /// The parameter `test` of this provider. r.AsyncValue get test; } diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index 687aed714..6592d8dba 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -10,44 +10,52 @@ String _$simpleHash() => r'ff9f7451526aef5b3af6646814631a502ad76a5f'; /// See also [simple]. @ProviderFor(simple) -final simpleProvider = AutoDisposeProvider.internal( +final simpleProvider = Provider.internal( simple, name: r'simpleProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$simpleHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef SimpleRef = AutoDisposeProviderRef; +typedef SimpleRef = Ref; String _$simple2Hash() => r'06327442776394c5c9cbb33b048d7a42e709e7fd'; /// See also [simple2]. @ProviderFor(simple2) -final simple2Provider = AutoDisposeProvider.internal( +final simple2Provider = Provider.internal( simple2, name: r'simple2Provider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$simple2Hash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef Simple2Ref = AutoDisposeProviderRef; +typedef Simple2Ref = Ref; String _$simpleClassHash() => r'958123cd6179c5b88da040cfeb71eb3061765277'; /// See also [SimpleClass]. @ProviderFor(SimpleClass) -final simpleClassProvider = - AutoDisposeNotifierProvider.internal( +final simpleClassProvider = NotifierProvider.internal( SimpleClass.new, name: r'simpleClassProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$simpleClassHash, dependencies: null, allTransitiveDependencies: null, ); -typedef _$SimpleClass = AutoDisposeNotifier; +typedef _$SimpleClass = Notifier; // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 5417662f4..b21a33c48 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -10,7 +10,7 @@ String _$scopedHash() => r'590f1a203323105e732397a2616fbd7dac65f0cc'; /// See also [scoped]. @ProviderFor(scoped) -final scopedProvider = AutoDisposeProvider.internal( +final scopedProvider = Provider.internal( (_) => throw UnsupportedError( 'The provider "scopedProvider" is expected to get overridden/scoped, ' 'but was accessed without an override.', @@ -18,10 +18,13 @@ final scopedProvider = AutoDisposeProvider.internal( name: r'scopedProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$scopedHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef ScopedRef = AutoDisposeProviderRef; +typedef ScopedRef = Ref; // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index 3d46657c5..5232d6244 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -10,29 +10,35 @@ String _$counter2Hash() => r'9328919066a683f85226fc59201bb7c54f107a7d'; /// See also [counter2]. @ProviderFor(counter2) -final counter2Provider = AutoDisposeProvider.internal( +final counter2Provider = Provider.internal( counter2, name: r'counter2Provider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$counter2Hash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef Counter2Ref = AutoDisposeProviderRef; +typedef Counter2Ref = Ref; String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; /// See also [counter]. @ProviderFor(counter) -final counterProvider = AutoDisposeProvider.internal( +final counterProvider = Provider.internal( counter, name: r'counterProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef CounterRef = AutoDisposeProviderRef; +typedef CounterRef = Ref; // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 2ff6bddca..55d420962 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -36,22 +36,22 @@ const genericProvider = GenericFamily(); /// See also [generic]. class GenericFamily extends Family { /// See also [generic]. - const GenericFamily(); + const GenericFamily() + : super( + name: r'genericProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'genericProvider'; - /// See also [generic]. GenericProvider call() { return GenericProvider(); @@ -88,8 +88,7 @@ class _$GenericFamilyOverride implements FamilyOverride { } /// See also [generic]. -class GenericProvider - extends AutoDisposeStreamProvider> { +class GenericProvider extends StreamProvider> { /// See also [generic]. GenericProvider() : this._internal( @@ -174,10 +173,10 @@ class GenericProvider String toString() => 'genericProvider<$T>$argument'; } -mixin GenericRef on AutoDisposeStreamProviderRef> {} +mixin GenericRef on Ref>> {} class _GenericProviderElement - extends AutoDisposeStreamProviderElement> with GenericRef { + extends StreamProviderElement> with GenericRef { _GenericProviderElement(super.provider, super.container); } @@ -185,30 +184,36 @@ String _$publicHash() => r'c5cc0eac434371901cf6ab159a81bba49c58da12'; /// See also [public]. @ProviderFor(public) -final publicProvider = AutoDisposeStreamProvider.internal( +final publicProvider = StreamProvider.internal( public, name: r'publicProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$publicHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef PublicRef = AutoDisposeStreamProviderRef; +typedef PublicRef = Ref>; String _$privateHash() => r'bbee0c7e27bda81346b5f52c96b23b2e48f83077'; /// See also [_private]. @ProviderFor(_private) -final _privateProvider = AutoDisposeStreamProvider.internal( +final _privateProvider = StreamProvider.internal( _private, name: r'_privateProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$privateHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef _PrivateRef = AutoDisposeStreamProviderRef; +typedef _PrivateRef = Ref>; String _$familyHash() => r'6896fac2f6e3ccd7c38ecaa0d538cbd3577936b2'; /// See also [family]. @@ -218,22 +223,22 @@ const familyProvider = FamilyFamily(); /// See also [family]. class FamilyFamily extends Family { /// See also [family]. - const FamilyFamily(); + const FamilyFamily() + : super( + name: r'familyProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$familyHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'familyProvider'; - /// See also [family]. FamilyProvider call( int first, { @@ -281,7 +286,7 @@ class _$FamilyFamilyOverride implements FamilyOverride { } /// See also [family]. -class FamilyProvider extends AutoDisposeStreamProvider { +class FamilyProvider extends StreamProvider { /// See also [family]. FamilyProvider( int first, { @@ -423,7 +428,7 @@ class FamilyProvider extends AutoDisposeStreamProvider { String toString() => 'familyProvider$argument'; } -mixin FamilyRef on AutoDisposeStreamProviderRef { +mixin FamilyRef on Ref> { /// The parameter `first` of this provider. int get first; @@ -440,7 +445,7 @@ mixin FamilyRef on AutoDisposeStreamProviderRef { List? get fifth; } -class _FamilyProviderElement extends AutoDisposeStreamProviderElement +class _FamilyProviderElement extends StreamProviderElement with FamilyRef { _FamilyProviderElement(super.provider, super.container); @@ -470,22 +475,22 @@ const genericClassProvider = GenericClassFamily(); /// See also [GenericClass]. class GenericClassFamily extends Family { /// See also [GenericClass]. - const GenericClassFamily(); + const GenericClassFamily() + : super( + name: r'genericClassProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericClassHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'genericClassProvider'; - /// See also [GenericClass]. GenericClassProvider call() { return GenericClassProvider(); @@ -610,8 +615,7 @@ class GenericClassProvider String toString() => 'genericClassProvider<$T>$argument'; } -mixin GenericClassRef - on AutoDisposeStreamNotifierProviderRef> {} +mixin GenericClassRef on AutoDisposeStreamNotifierProviderRef {} class _GenericClassProviderElement extends AutoDisposeStreamNotifierProviderElement, List> @@ -624,31 +628,37 @@ String _$publicClassHash() => r'b1526943c8ff0aaa20642bf78e744e5833cf9d02'; /// See also [PublicClass]. @ProviderFor(PublicClass) final publicClassProvider = - AutoDisposeStreamNotifierProvider.internal( + StreamNotifierProvider.internal( PublicClass.new, name: r'publicClassProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$publicClassHash, dependencies: null, allTransitiveDependencies: null, ); -typedef _$PublicClass = AutoDisposeStreamNotifier; +typedef _$PublicClass = StreamNotifier; String _$privateClassHash() => r'8c0d52b7ab79c0546d0c84c011bb3512609e029e'; /// See also [_PrivateClass]. @ProviderFor(_PrivateClass) final _privateClassProvider = - AutoDisposeStreamNotifierProvider<_PrivateClass, String>.internal( + StreamNotifierProvider<_PrivateClass, String>.internal( _PrivateClass.new, name: r'_privateClassProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$privateClassHash, dependencies: null, allTransitiveDependencies: null, ); -typedef _$PrivateClass = AutoDisposeStreamNotifier; +typedef _$PrivateClass = StreamNotifier; String _$familyClassHash() => r'6ec16ca23da8df4c010ecb5eed72e3e655504460'; abstract class _$FamilyClass @@ -675,22 +685,22 @@ const familyClassProvider = FamilyClassFamily(); /// See also [FamilyClass]. class FamilyClassFamily extends Family { /// See also [FamilyClass]. - const FamilyClassFamily(); + const FamilyClassFamily() + : super( + name: r'familyClassProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$familyClassHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'familyClassProvider'; - /// See also [FamilyClass]. FamilyClassProvider call( int first, { @@ -900,7 +910,7 @@ class FamilyClassProvider String toString() => 'familyClassProvider$argument'; } -mixin FamilyClassRef on AutoDisposeStreamNotifierProviderRef { +mixin FamilyClassRef on AutoDisposeStreamNotifierProviderRef { /// The parameter `first` of this provider. int get first; diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index c45764d2c..b2b05565a 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -36,22 +36,22 @@ const genericProvider = GenericFamily(); /// See also [generic]. class GenericFamily extends Family { /// See also [generic]. - const GenericFamily(); + const GenericFamily() + : super( + name: r'genericProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'genericProvider'; - /// See also [generic]. GenericProvider call() { return GenericProvider(); @@ -88,7 +88,7 @@ class _$GenericFamilyOverride implements FamilyOverride { } /// See also [generic]. -class GenericProvider extends AutoDisposeProvider> { +class GenericProvider extends Provider> { /// See also [generic]. GenericProvider() : this._internal( @@ -173,10 +173,10 @@ class GenericProvider extends AutoDisposeProvider> { String toString() => 'genericProvider<$T>$argument'; } -mixin GenericRef on AutoDisposeProviderRef> {} +mixin GenericRef on Ref> {} -class _GenericProviderElement - extends AutoDisposeProviderElement> with GenericRef { +class _GenericProviderElement extends ProviderElement> + with GenericRef { _GenericProviderElement(super.provider, super.container); } @@ -189,22 +189,22 @@ const complexGenericProvider = ComplexGenericFamily(); /// See also [complexGeneric]. class ComplexGenericFamily extends Family { /// See also [complexGeneric]. - const ComplexGenericFamily(); + const ComplexGenericFamily() + : super( + name: r'complexGenericProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$complexGenericHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'complexGenericProvider'; - /// See also [complexGeneric]. ComplexGenericProvider call({ required T param, @@ -251,7 +251,7 @@ class _$ComplexGenericFamilyOverride implements FamilyOverride { /// See also [complexGeneric]. class ComplexGenericProvider - extends AutoDisposeProvider> { + extends Provider> { /// See also [complexGeneric]. ComplexGenericProvider({ required T param, @@ -364,8 +364,7 @@ class ComplexGenericProvider String toString() => 'complexGenericProvider<$T,$Foo>$argument'; } -mixin ComplexGenericRef - on AutoDisposeProviderRef> { +mixin ComplexGenericRef on Ref> { /// The parameter `param` of this provider. T get param; @@ -374,7 +373,7 @@ mixin ComplexGenericRef } class _ComplexGenericProviderElement - extends AutoDisposeProviderElement> with ComplexGenericRef { + extends ProviderElement> with ComplexGenericRef { _ComplexGenericProviderElement(super.provider, super.container); @override @@ -387,30 +386,36 @@ String _$rawFutureHash() => r'5203a56065b768023770326281618e3229ccb530'; /// See also [rawFuture]. @ProviderFor(rawFuture) -final rawFutureProvider = AutoDisposeProvider>>.internal( +final rawFutureProvider = Provider>>.internal( rawFuture, name: r'rawFutureProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$rawFutureHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef RawFutureRef = AutoDisposeProviderRef>>; +typedef RawFutureRef = Ref>>; String _$rawStreamHash() => r'2b764189753a8b74f47ba557a79416f00ef5cebd'; /// See also [rawStream]. @ProviderFor(rawStream) -final rawStreamProvider = AutoDisposeProvider>>.internal( +final rawStreamProvider = Provider>>.internal( rawStream, name: r'rawStreamProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$rawStreamHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef RawStreamRef = AutoDisposeProviderRef>>; +typedef RawStreamRef = Ref>>; String _$rawFamilyFutureHash() => r'485f59512081852e51279658facc015309743864'; /// See also [rawFamilyFuture]. @@ -420,22 +425,22 @@ const rawFamilyFutureProvider = RawFamilyFutureFamily(); /// See also [rawFamilyFuture]. class RawFamilyFutureFamily extends Family { /// See also [rawFamilyFuture]. - const RawFamilyFutureFamily(); + const RawFamilyFutureFamily() + : super( + name: r'rawFamilyFutureProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$rawFamilyFutureHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'rawFamilyFutureProvider'; - /// See also [rawFamilyFuture]. RawFamilyFutureProvider call( int id, @@ -476,7 +481,7 @@ class _$RawFamilyFutureFamilyOverride implements FamilyOverride { } /// See also [rawFamilyFuture]. -class RawFamilyFutureProvider extends AutoDisposeProvider>> { +class RawFamilyFutureProvider extends Provider>> { /// See also [rawFamilyFuture]. RawFamilyFutureProvider( int id, @@ -569,14 +574,13 @@ class RawFamilyFutureProvider extends AutoDisposeProvider>> { String toString() => 'rawFamilyFutureProvider$argument'; } -mixin RawFamilyFutureRef on AutoDisposeProviderRef>> { +mixin RawFamilyFutureRef on Ref>> { /// The parameter `id` of this provider. int get id; } class _RawFamilyFutureProviderElement - extends AutoDisposeProviderElement>> - with RawFamilyFutureRef { + extends ProviderElement>> with RawFamilyFutureRef { _RawFamilyFutureProviderElement(super.provider, super.container); @override @@ -592,22 +596,22 @@ const rawFamilyStreamProvider = RawFamilyStreamFamily(); /// See also [rawFamilyStream]. class RawFamilyStreamFamily extends Family { /// See also [rawFamilyStream]. - const RawFamilyStreamFamily(); + const RawFamilyStreamFamily() + : super( + name: r'rawFamilyStreamProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$rawFamilyStreamHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'rawFamilyStreamProvider'; - /// See also [rawFamilyStream]. RawFamilyStreamProvider call( int id, @@ -648,7 +652,7 @@ class _$RawFamilyStreamFamilyOverride implements FamilyOverride { } /// See also [rawFamilyStream]. -class RawFamilyStreamProvider extends AutoDisposeProvider>> { +class RawFamilyStreamProvider extends Provider>> { /// See also [rawFamilyStream]. RawFamilyStreamProvider( int id, @@ -741,14 +745,13 @@ class RawFamilyStreamProvider extends AutoDisposeProvider>> { String toString() => 'rawFamilyStreamProvider$argument'; } -mixin RawFamilyStreamRef on AutoDisposeProviderRef>> { +mixin RawFamilyStreamRef on Ref>> { /// The parameter `id` of this provider. int get id; } class _RawFamilyStreamProviderElement - extends AutoDisposeProviderElement>> - with RawFamilyStreamRef { + extends ProviderElement>> with RawFamilyStreamRef { _RawFamilyStreamProviderElement(super.provider, super.container); @override @@ -761,31 +764,37 @@ String _$publicHash() => r'138be35943899793ab085e711fe3f3d22696a3ba'; /// /// Copied from [public]. @ProviderFor(public) -final publicProvider = AutoDisposeProvider.internal( +final publicProvider = Provider.internal( public, name: r'publicProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$publicHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef PublicRef = AutoDisposeProviderRef; +typedef PublicRef = Ref; String _$supports$inNamesHash() => r'cbf929802fcbd0aa949ad72743d096fb3ef5f28f'; /// See also [supports$inNames]. @ProviderFor(supports$inNames) -final supports$inNamesProvider = AutoDisposeProvider.internal( +final supports$inNamesProvider = Provider.internal( supports$inNames, name: r'supports$inNamesProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$supports$inNamesHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef Supports$inNamesRef = AutoDisposeProviderRef; +typedef Supports$inNamesRef = Ref; String _$familyHash() => r'14d1ee238ca608d547630d0e222ef4c5866e9e61'; /// This is some documentation @@ -801,22 +810,22 @@ class FamilyFamily extends Family { /// This is some documentation /// /// Copied from [family]. - const FamilyFamily(); + const FamilyFamily() + : super( + name: r'familyProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$familyHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'familyProvider'; - /// This is some documentation /// /// Copied from [family]. @@ -868,7 +877,7 @@ class _$FamilyFamilyOverride implements FamilyOverride { /// This is some documentation /// /// Copied from [family]. -class FamilyProvider extends AutoDisposeProvider { +class FamilyProvider extends Provider { /// This is some documentation /// /// Copied from [family]. @@ -1012,7 +1021,7 @@ class FamilyProvider extends AutoDisposeProvider { String toString() => 'familyProvider$argument'; } -mixin FamilyRef on AutoDisposeProviderRef { +mixin FamilyRef on Ref { /// The parameter `first` of this provider. int get first; @@ -1029,8 +1038,7 @@ mixin FamilyRef on AutoDisposeProviderRef { List? get fifth; } -class _FamilyProviderElement extends AutoDisposeProviderElement - with FamilyRef { +class _FamilyProviderElement extends ProviderElement with FamilyRef { _FamilyProviderElement(super.provider, super.container); @override @@ -1049,30 +1057,36 @@ String _$privateHash() => r'519561bc7e88e394d7f75ca2102a5c0acc832c66'; /// See also [_private]. @ProviderFor(_private) -final _privateProvider = AutoDisposeProvider.internal( +final _privateProvider = Provider.internal( _private, name: r'_privateProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$privateHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef _PrivateRef = AutoDisposeProviderRef; +typedef _PrivateRef = Ref; String _$generatedHash() => r'fecbc1d5d9a05fc996b452a57fd1975ff368af91'; /// See also [generated]. @ProviderFor(generated) -final generatedProvider = AutoDisposeProvider.internal( +final generatedProvider = Provider.internal( generated, name: r'generatedProvider', debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$generatedHash, + from: null, + argument: null, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); -typedef GeneratedRef = AutoDisposeProviderRef; +typedef GeneratedRef = Ref; String _$genericClassHash() => r'671e348a5abf8e00ab06c5f247defbca8af9677b'; abstract class _$GenericClass @@ -1087,22 +1101,22 @@ const genericClassProvider = GenericClassFamily(); /// See also [GenericClass]. class GenericClassFamily extends Family { /// See also [GenericClass]. - const GenericClassFamily(); + const GenericClassFamily() + : super( + name: r'genericClassProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$genericClassHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'genericClassProvider'; - /// See also [GenericClass]. GenericClassProvider call() { return GenericClassProvider(); @@ -1227,8 +1241,7 @@ class GenericClassProvider String toString() => 'genericClassProvider<$T>$argument'; } -mixin GenericClassRef - on AutoDisposeNotifierProviderRef> {} +mixin GenericClassRef on AutoDisposeNotifierProviderRef {} class _GenericClassProviderElement extends AutoDisposeNotifierProviderElement, List> @@ -1241,9 +1254,12 @@ String _$rawFutureClassHash() => r'bf66f1cdbd99118b8845d206e6a2611b3101f45c'; /// See also [RawFutureClass]. @ProviderFor(RawFutureClass) final rawFutureClassProvider = - AutoDisposeNotifierProvider>>.internal( + NotifierProvider>>.internal( RawFutureClass.new, name: r'rawFutureClassProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$rawFutureClassHash, @@ -1251,15 +1267,18 @@ final rawFutureClassProvider = allTransitiveDependencies: null, ); -typedef _$RawFutureClass = AutoDisposeNotifier>>; +typedef _$RawFutureClass = Notifier>>; String _$rawStreamClassHash() => r'712cffcb2018cfb4ff45012c1aa6e43c8cbe9d5d'; /// See also [RawStreamClass]. @ProviderFor(RawStreamClass) final rawStreamClassProvider = - AutoDisposeNotifierProvider>>.internal( + NotifierProvider>>.internal( RawStreamClass.new, name: r'rawStreamClassProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$rawStreamClassHash, @@ -1267,7 +1286,7 @@ final rawStreamClassProvider = allTransitiveDependencies: null, ); -typedef _$RawStreamClass = AutoDisposeNotifier>>; +typedef _$RawStreamClass = Notifier>>; String _$rawFamilyFutureClassHash() => r'd7cacb0f2c51697d107de6daa68b242c04085dca'; @@ -1287,22 +1306,22 @@ const rawFamilyFutureClassProvider = RawFamilyFutureClassFamily(); /// See also [RawFamilyFutureClass]. class RawFamilyFutureClassFamily extends Family { /// See also [RawFamilyFutureClass]. - const RawFamilyFutureClassFamily(); + const RawFamilyFutureClassFamily() + : super( + name: r'rawFamilyFutureClassProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$rawFamilyFutureClassHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'rawFamilyFutureClassProvider'; - /// See also [RawFamilyFutureClass]. RawFamilyFutureClassProvider call( int id, @@ -1440,8 +1459,7 @@ class RawFamilyFutureClassProvider extends AutoDisposeNotifierProviderImpl< String toString() => 'rawFamilyFutureClassProvider$argument'; } -mixin RawFamilyFutureClassRef - on AutoDisposeNotifierProviderRef>> { +mixin RawFamilyFutureClassRef on AutoDisposeNotifierProviderRef { /// The parameter `id` of this provider. int get id; } @@ -1474,22 +1492,22 @@ const rawFamilyStreamClassProvider = RawFamilyStreamClassFamily(); /// See also [RawFamilyStreamClass]. class RawFamilyStreamClassFamily extends Family { /// See also [RawFamilyStreamClass]. - const RawFamilyStreamClassFamily(); + const RawFamilyStreamClassFamily() + : super( + name: r'rawFamilyStreamClassProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$rawFamilyStreamClassHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'rawFamilyStreamClassProvider'; - /// See also [RawFamilyStreamClass]. RawFamilyStreamClassProvider call( int id, @@ -1627,8 +1645,7 @@ class RawFamilyStreamClassProvider extends AutoDisposeNotifierProviderImpl< String toString() => 'rawFamilyStreamClassProvider$argument'; } -mixin RawFamilyStreamClassRef - on AutoDisposeNotifierProviderRef>> { +mixin RawFamilyStreamClassRef on AutoDisposeNotifierProviderRef { /// The parameter `id` of this provider. int get id; } @@ -1648,32 +1665,36 @@ String _$publicClassHash() => r'c8e7eec9e202acf8394e02496857cbe49405bf62'; /// /// Copied from [PublicClass]. @ProviderFor(PublicClass) -final publicClassProvider = - AutoDisposeNotifierProvider.internal( +final publicClassProvider = NotifierProvider.internal( PublicClass.new, name: r'publicClassProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$publicClassHash, dependencies: null, allTransitiveDependencies: null, ); -typedef _$PublicClass = AutoDisposeNotifier; +typedef _$PublicClass = Notifier; String _$privateClassHash() => r'6d41def3ffdc1f79e593beaefb3304ce4b211a77'; /// See also [_PrivateClass]. @ProviderFor(_PrivateClass) -final _privateClassProvider = - AutoDisposeNotifierProvider<_PrivateClass, String>.internal( +final _privateClassProvider = NotifierProvider<_PrivateClass, String>.internal( _PrivateClass.new, name: r'_privateClassProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$privateClassHash, dependencies: null, allTransitiveDependencies: null, ); -typedef _$PrivateClass = AutoDisposeNotifier; +typedef _$PrivateClass = Notifier; String _$familyClassHash() => r'01e3b9cb4d6d0bf12a2284761b1a11819d97d249'; abstract class _$FamilyClass extends BuildlessAutoDisposeNotifier { @@ -1705,22 +1726,22 @@ class FamilyClassFamily extends Family { /// This is some documentation /// /// Copied from [FamilyClass]. - const FamilyClassFamily(); + const FamilyClassFamily() + : super( + name: r'familyClassProvider', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$familyClassHash, + isAutoDispose: true, + ); static const Iterable? _dependencies = null; static const Iterable? _allTransitiveDependencies = null; - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'familyClassProvider'; - /// This is some documentation /// /// Copied from [FamilyClass]. @@ -1936,7 +1957,7 @@ class FamilyClassProvider String toString() => 'familyClassProvider$argument'; } -mixin FamilyClassRef on AutoDisposeNotifierProviderRef { +mixin FamilyClassRef on AutoDisposeNotifierProviderRef { /// The parameter `first` of this provider. int get first; @@ -1976,9 +1997,12 @@ String _$supports$InClassNameHash() => /// See also [Supports$InClassName]. @ProviderFor(Supports$InClassName) final supports$InClassNameProvider = - AutoDisposeNotifierProvider.internal( + NotifierProvider.internal( Supports$InClassName.new, name: r'supports$InClassNameProvider', + from: null, + argument: null, + isAutoDispose: true, debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$supports$InClassNameHash, @@ -1986,6 +2010,6 @@ final supports$InClassNameProvider = allTransitiveDependencies: null, ); -typedef _$Supports$InClassName = AutoDisposeNotifier; +typedef _$Supports$InClassName = Notifier; // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package From a2abace366bc58148f8bd5e1fe578a7f17f0772f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 1 Feb 2024 18:47:13 +0100 Subject: [PATCH 148/387] Work on codegen --- .../lib/src/providers/future_provider.dart | 6 +- .../riverpod/lib/src/providers/provider.dart | 2 +- .../lib/src/providers/stream_provider.dart | 6 +- .../lib/src/templates/family.dart | 148 +-- .../test/integration/annotated.g.dart | 194 +--- .../test/integration/async.g.dart | 702 +++-------- .../test/integration/dependencies.g.dart | 294 ++--- .../test/integration/dependencies2.g.dart | 212 +--- .../test/integration/generated.g.dart | 682 +++-------- .../test/integration/stream.g.dart | 503 ++------ .../test/integration/sync.g.dart | 1027 ++++------------- 11 files changed, 887 insertions(+), 2889 deletions(-) diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 56fde4ea0..8d8fdf767 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -77,10 +77,8 @@ import 'stream_provider.dart' show StreamProvider; /// - [FutureProvider.family], to create a [FutureProvider] from external parameters /// - [FutureProvider.autoDispose], to destroy the state of a [FutureProvider] when no longer needed. /// {@endtemplate} -final class FutureProvider extends FunctionalProvider< - AsyncValue, - FutureOr, - FutureProviderRef> with FutureModifier { +base class FutureProvider extends FunctionalProvider, + FutureOr, FutureProviderRef> with FutureModifier { /// {@macro riverpod.future_provider} FutureProvider( this._create, { diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 1fb4913c1..5b4759a92 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -8,7 +8,7 @@ import 'stream_provider.dart' show StreamProvider; // TODO changelog ProviderRef was removed. Used Ref directly /// {@macro riverpod.provider} -final class Provider +base class Provider extends FunctionalProvider> { /// {@macro riverpod.provider} // TODO make all providers const under all variations diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index 22fd10faf..7406389ba 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -66,10 +66,8 @@ import 'provider.dart' show Provider; /// - [StreamProvider.family], to create a [StreamProvider] from external parameters /// - [StreamProvider.autoDispose], to destroy the state of a [StreamProvider] when no longer needed. /// {@endtemplate} -final class StreamProvider extends FunctionalProvider< - AsyncValue, - Stream, - Ref>> with FutureModifier { +base class StreamProvider extends FunctionalProvider, + Stream, Ref>> with FutureModifier { /// {@macro riverpod.stream_provider} StreamProvider( this._create, { diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index f7d61f27d..1e069fd5e 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -62,7 +62,6 @@ class FamilyTemplate extends Template { var providerType = 'Provider'; var refType = 'Ref<${provider.valueTypeDisplayString}>'; var elementType = 'ProviderElement'; - var createdType = provider.createdTypeDisplayString; final returnType = provider.createdTypeNode?.type; if (returnType != null && !returnType.isRaw) { @@ -70,9 +69,6 @@ class FamilyTemplate extends Template { providerType = 'FutureProvider'; refType = 'Ref>'; elementType = 'FutureProviderElement'; - // Always use FutureOr in overrideWith as return value - // or otherwise we get a compilation error. - createdType = 'FutureOr<${provider.valueTypeDisplayString}>'; } else if (returnType.isDartAsyncStream) { providerType = 'StreamProvider'; refType = 'Ref>'; @@ -93,6 +89,9 @@ class FamilyTemplate extends Template { final typeParametersDefinition = genericDefinitionDisplayString(typeParameters); + final createType = + '${provider.createdTypeDisplayString} Function$typeParametersDefinition(${provider._refImplName} ref)'; + return FamilyTemplate._( provider, options: options, @@ -106,29 +105,8 @@ class FamilyTemplate extends Template { '(ref) => ${provider.name}$typeParametersUsage(ref as ${provider._refImplName}$typeParametersUsage, $parametersPassThrough)', providerType: providerType, parametersPassThrough: parametersPassThrough, - createType: - '${provider.createdTypeDisplayString} Function$typeParametersDefinition(${provider._refImplName} ref)', + createType: createType, overrideCreate: '(ref) => create(ref as ${provider._refImplName})', - providerOther: ''' - - @override - Override overrideWith( - $createdType Function(${provider._refImplName}$typeParametersUsage ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: ${provider._providerImplName}$typeParametersUsage._internal( - (ref) => create(ref as ${provider._refImplName}$typeParametersUsage), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, -${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} - ), - ); - } -''', ); } @@ -212,19 +190,14 @@ abstract class $notifierTypedefName$typeParametersDefinition extends $notifierBa return notifier.build($parametersPassThrough); } + @internal @override - Override overrideWith(${provider.name}$typeParametersUsage Function() create) { - return ProviderOverride( - origin: this, - providerOverride: ${provider._providerImplName}$typeParametersUsage._internal( - () => create()$cascadePropertyInit, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, -${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} - ), + $providerType copyWithBuild( + ${provider.name} Function() create, + ) { + return $providerType._internal( + create, + ${parameters.map((e) => '${e.name}: ${e.name},\n').join()} ); } ''', @@ -249,9 +222,7 @@ ${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} @override void run(StringBuffer buffer) { - final isAutoDispose = !provider.providerElement.annotation.keepAlive - ? 'isAutoDispose: true,' - : ''; + final isAutoDispose = !provider.providerElement.annotation.keepAlive; final providerTypeNameImpl = provider._providerImplName; final refNameImpl = provider._refImplName; @@ -259,9 +230,6 @@ ${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} final familyName = '${provider.providerElement.name.titled}Family'; final parameterDefinition = buildParamDefinitionQuery(parameters); - final parameterThisNamedPassThrough = parameters - .map((parameter) => '${parameter.name}: ${parameter.name},') - .join(); final docs = providerDocFor(provider.providerElement.element); final meta = metaAnnotations(provider.node.metadata); @@ -284,9 +252,6 @@ ${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} for (final parameter in parameters) parameter: parameter.name!.lexeme, }); - final familyOverrideClassName = - '_\$${provider.name.lexeme.titled.public}FamilyOverride'; - // TODO changelog updated to support createElement prototype change // TODO changelog toString() // TODO handle generics with $ in their name @@ -305,7 +270,7 @@ $meta const $providerName = $familyName(); $docs -class $familyName extends Family { +final class $familyName extends Family { $docs const $familyName() : super( @@ -313,7 +278,7 @@ class $familyName extends Family { dependencies: _dependencies, allTransitiveDependencies: _allTransitiveDependencies, debugGetCreateSourceHash: $hashFn, - $isAutoDispose + ${isAutoDispose ? 'isAutoDispose: true,' : ''} ); static $dependenciesKeyword _dependencies = ${serializeDependencies(provider.providerElement.annotation, options)}; @@ -325,88 +290,45 @@ class $familyName extends Family { return $providerTypeNameImpl$typeParametersUsage($parametersPassThrough); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith($createType create) { - return $familyOverrideClassName(this, create); - } - @override String toString() => '$encodedProviderName'; } -class $familyOverrideClassName implements FamilyOverride { - $familyOverrideClassName(this.from, this.create); - - final $createType create; - - @override - final $familyName from; - - @override - $elementNameImpl createElement( - ProviderContainer container, - covariant $providerTypeNameImpl provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => '$encodedProviderName.overrideWith(...)'; -} - $docs -class $providerTypeNameImpl$typeParametersDefinition extends $providerType$providerGenerics { +final class $providerTypeNameImpl$typeParametersDefinition extends $providerType$providerGenerics { $docs $providerTypeNameImpl($parameterDefinition) : this._internal( $providerCreate, - from: $providerName, - name: r'$providerName', - debugGetCreateSourceHash: $hashFn, - dependencies: null, - allTransitiveDependencies: null, - ${parameters.map((e) => '${e.name}: ${e.name},\n').join()} + argument: ($argumentsToRecord), ); $providerTypeNameImpl._internal( super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - ${buildParamDefinitionQuery( - parameters, - asThisParameter: true, - writeBrackets: false, - asRequiredNamed: true, - )} - }) : super.internal(); - -${parameters.map((e) => 'final ${e.typeDisplayString} ${e.name};').join()} + required ($argumentRecordType) super.argument, + }) : super.internal( + debugGetCreateSourceHash: $hashFn, + from: $providerName, + name: r'$providerName', + isAutoDispose: $isAutoDispose, + dependencies: null, + allTransitiveDependencies: null, + ); $providerOther - @override - ($argumentRecordType) get argument { - return ($argumentsToRecord); - } - @override $elementNameImpl$typeParametersUsage createElement(ProviderContainer container,) { return $elementNameImpl(this, container); } - $providerTypeNameImpl _copyWith( + @internal + @override + $providerTypeNameImpl copyWithCreate( $createType create, ) { return $providerTypeNameImpl._internal( $overrideCreate, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - $parameterThisNamedPassThrough + argument: argument as ($argumentRecordType), ); } @@ -417,20 +339,12 @@ $providerOther // If there are type parameters, check the runtimeType to check them too. if (typeParameters?.typeParameters.isNotEmpty ?? false) 'other.runtimeType == runtimeType', - ...parameters.map((e) => 'other.${e.name} == ${e.name}'), + 'other.argument == argument', ].join(' && ')}; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); -${[ - ...parameters.map((e) => e.name), - ...?typeParameters?.typeParameters.map((e) => e.name), - ].map((e) => 'hash = _SystemHash.combine(hash, $e.hashCode);').join()} - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => '$encodedProviderName$encodedGenerics\$argument'; diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index cd0d10a8f..9757455f8 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -57,7 +57,7 @@ class _SystemHash { const familyProvider = FamilyFamily(); /// See also [family]. -class FamilyFamily extends Family { +final class FamilyFamily extends Family { /// See also [family]. const FamilyFamily() : super( @@ -84,37 +84,12 @@ class FamilyFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(String Function(FamilyRef ref) create) { - return _$FamilyFamilyOverride(this, create); - } - @override String toString() => 'familyProvider'; } -class _$FamilyFamilyOverride implements FamilyOverride { - _$FamilyFamilyOverride(this.from, this.create); - - final String Function(FamilyRef ref) create; - - @override - final FamilyFamily from; - - @override - _FamilyProviderElement createElement( - ProviderContainer container, - covariant FamilyProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'familyProvider.overrideWith(...)'; -} - /// See also [family]. -class FamilyProvider extends Provider { +final class FamilyProvider extends Provider { /// See also [family]. FamilyProvider( int id, @@ -123,52 +98,24 @@ class FamilyProvider extends Provider { ref as FamilyRef, id, ), - from: familyProvider, - name: r'familyProvider', + argument: (id,), + ); + + FamilyProvider._internal( + super.create, { + required (int,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$familyHash, + from: familyProvider, + name: r'familyProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - id: id, ); - FamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.id, - }) : super.internal(); - - final int id; - - @override - Override overrideWith( - String Function(FamilyRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: FamilyProvider._internal( - (ref) => create(ref as FamilyRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - id: id, - ), - ); - } - - @override - (int,) get argument { - return (id,); - } - @override _FamilyProviderElement createElement( ProviderContainer container, @@ -176,32 +123,24 @@ class FamilyProvider extends Provider { return _FamilyProviderElement(this, container); } - FamilyProvider _copyWith( + @internal + @override + FamilyProvider copyWithCreate( String Function(FamilyRef ref) create, ) { return FamilyProvider._internal( (ref) => create(ref as FamilyRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - id: id, + argument: argument as (int,), ); } @override bool operator ==(Object other) { - return other is FamilyProvider && other.id == id; + return other is FamilyProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, id.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'familyProvider$argument'; @@ -245,7 +184,7 @@ String _$notCopiedFamilyHash() => r'6ef06ce6ebd73b476870bbe1af41c4f3fbe8ddb1'; const notCopiedFamilyProvider = NotCopiedFamilyFamily(); /// See also [notCopiedFamily]. -class NotCopiedFamilyFamily extends Family { +final class NotCopiedFamilyFamily extends Family { /// See also [notCopiedFamily]. const NotCopiedFamilyFamily() : super( @@ -272,37 +211,12 @@ class NotCopiedFamilyFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(String Function(NotCopiedFamilyRef ref) create) { - return _$NotCopiedFamilyFamilyOverride(this, create); - } - @override String toString() => 'notCopiedFamilyProvider'; } -class _$NotCopiedFamilyFamilyOverride implements FamilyOverride { - _$NotCopiedFamilyFamilyOverride(this.from, this.create); - - final String Function(NotCopiedFamilyRef ref) create; - - @override - final NotCopiedFamilyFamily from; - - @override - _NotCopiedFamilyProviderElement createElement( - ProviderContainer container, - covariant NotCopiedFamilyProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'notCopiedFamilyProvider.overrideWith(...)'; -} - /// See also [notCopiedFamily]. -class NotCopiedFamilyProvider extends Provider { +final class NotCopiedFamilyProvider extends Provider { /// See also [notCopiedFamily]. NotCopiedFamilyProvider( int id, @@ -311,52 +225,24 @@ class NotCopiedFamilyProvider extends Provider { ref as NotCopiedFamilyRef, id, ), - from: notCopiedFamilyProvider, - name: r'notCopiedFamilyProvider', + argument: (id,), + ); + + NotCopiedFamilyProvider._internal( + super.create, { + required (int,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$notCopiedFamilyHash, + from: notCopiedFamilyProvider, + name: r'notCopiedFamilyProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - id: id, ); - NotCopiedFamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.id, - }) : super.internal(); - - final int id; - - @override - Override overrideWith( - String Function(NotCopiedFamilyRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: NotCopiedFamilyProvider._internal( - (ref) => create(ref as NotCopiedFamilyRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - id: id, - ), - ); - } - - @override - (int,) get argument { - return (id,); - } - @override _NotCopiedFamilyProviderElement createElement( ProviderContainer container, @@ -364,32 +250,24 @@ class NotCopiedFamilyProvider extends Provider { return _NotCopiedFamilyProviderElement(this, container); } - NotCopiedFamilyProvider _copyWith( + @internal + @override + NotCopiedFamilyProvider copyWithCreate( String Function(NotCopiedFamilyRef ref) create, ) { return NotCopiedFamilyProvider._internal( (ref) => create(ref as NotCopiedFamilyRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - id: id, + argument: argument as (int,), ); } @override bool operator ==(Object other) { - return other is NotCopiedFamilyProvider && other.id == id; + return other is NotCopiedFamilyProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, id.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'notCopiedFamilyProvider$argument'; diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index e667d8e37..e05ee08de 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -34,7 +34,7 @@ class _SystemHash { const genericProvider = GenericFamily(); /// See also [generic]. -class GenericFamily extends Family { +final class GenericFamily extends Family { /// See also [generic]. const GenericFamily() : super( @@ -57,85 +57,36 @@ class GenericFamily extends Family { return GenericProvider(); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith( - FutureOr> Function(GenericRef ref) create) { - return _$GenericFamilyOverride(this, create); - } - @override String toString() => 'genericProvider'; } -class _$GenericFamilyOverride implements FamilyOverride { - _$GenericFamilyOverride(this.from, this.create); - - final FutureOr> Function(GenericRef ref) create; - - @override - final GenericFamily from; - - @override - _GenericProviderElement createElement( - ProviderContainer container, - covariant GenericProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'genericProvider.overrideWith(...)'; -} - /// See also [generic]. -class GenericProvider extends FutureProvider> { +final class GenericProvider extends FutureProvider> { /// See also [generic]. GenericProvider() : this._internal( (ref) => generic( ref as GenericRef, ), - from: genericProvider, - name: r'genericProvider', + argument: (), + ); + + GenericProvider._internal( + super.create, { + required () super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$genericHash, + from: genericProvider, + name: r'genericProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - GenericProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); - - @override - Override overrideWith( - FutureOr> Function(GenericRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: GenericProvider._internal( - (ref) => create(ref as GenericRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), - ); - } - - @override - () get argument { - return (); - } - @override _GenericProviderElement createElement( ProviderContainer container, @@ -143,31 +94,26 @@ class GenericProvider extends FutureProvider> { return _GenericProviderElement(this, container); } - GenericProvider _copyWith( - FutureOr> Function(GenericRef ref) create, + @internal + @override + GenericProvider copyWithCreate( + covariant FutureOr> Function(GenericRef ref) create, ) { return GenericProvider._internal( - (ref) => create(ref as GenericRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, + (ref) => create(ref as GenericRef), + argument: argument as (), ); } @override bool operator ==(Object other) { - return other is GenericProvider && other.runtimeType == runtimeType; + return other is GenericProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, T.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'genericProvider<$T>$argument'; @@ -221,7 +167,7 @@ String _$familyOrHash() => r'1c3217e296b0ce52c07c18769d1fffb95850f482'; const familyOrProvider = FamilyOrFamily(); /// See also [familyOr]. -class FamilyOrFamily extends Family { +final class FamilyOrFamily extends Family { /// See also [familyOr]. const FamilyOrFamily() : super( @@ -248,37 +194,12 @@ class FamilyOrFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(FutureOr Function(FamilyOrRef ref) create) { - return _$FamilyOrFamilyOverride(this, create); - } - @override String toString() => 'familyOrProvider'; } -class _$FamilyOrFamilyOverride implements FamilyOverride { - _$FamilyOrFamilyOverride(this.from, this.create); - - final FutureOr Function(FamilyOrRef ref) create; - - @override - final FamilyOrFamily from; - - @override - _FamilyOrProviderElement createElement( - ProviderContainer container, - covariant FamilyOrProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'familyOrProvider.overrideWith(...)'; -} - /// See also [familyOr]. -class FamilyOrProvider extends FutureProvider { +final class FamilyOrProvider extends FutureProvider { /// See also [familyOr]. FamilyOrProvider( int first, @@ -287,52 +208,24 @@ class FamilyOrProvider extends FutureProvider { ref as FamilyOrRef, first, ), - from: familyOrProvider, - name: r'familyOrProvider', + argument: (first,), + ); + + FamilyOrProvider._internal( + super.create, { + required (int,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$familyOrHash, + from: familyOrProvider, + name: r'familyOrProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - first: first, ); - FamilyOrProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.first, - }) : super.internal(); - - final int first; - - @override - Override overrideWith( - FutureOr Function(FamilyOrRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: FamilyOrProvider._internal( - (ref) => create(ref as FamilyOrRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - first: first, - ), - ); - } - - @override - (int,) get argument { - return (first,); - } - @override _FamilyOrProviderElement createElement( ProviderContainer container, @@ -340,32 +233,24 @@ class FamilyOrProvider extends FutureProvider { return _FamilyOrProviderElement(this, container); } - FamilyOrProvider _copyWith( + @internal + @override + FamilyOrProvider copyWithCreate( FutureOr Function(FamilyOrRef ref) create, ) { return FamilyOrProvider._internal( (ref) => create(ref as FamilyOrRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - first: first, + argument: argument as (int,), ); } @override bool operator ==(Object other) { - return other is FamilyOrProvider && other.first == first; + return other is FamilyOrProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, first.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'familyOrProvider$argument'; @@ -391,7 +276,7 @@ String _$familyHash() => r'eb6fad35a94d4238b621c2100253ee2c700bee77'; const familyProvider = FamilyFamily(); /// See also [family]. -class FamilyFamily extends Family { +final class FamilyFamily extends Family { /// See also [family]. const FamilyFamily() : super( @@ -426,37 +311,12 @@ class FamilyFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(FutureOr Function(FamilyRef ref) create) { - return _$FamilyFamilyOverride(this, create); - } - @override String toString() => 'familyProvider'; } -class _$FamilyFamilyOverride implements FamilyOverride { - _$FamilyFamilyOverride(this.from, this.create); - - final FutureOr Function(FamilyRef ref) create; - - @override - final FamilyFamily from; - - @override - _FamilyProviderElement createElement( - ProviderContainer container, - covariant FamilyProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'familyProvider.overrideWith(...)'; -} - /// See also [family]. -class FamilyProvider extends FutureProvider { +final class FamilyProvider extends FutureProvider { /// See also [family]. FamilyProvider( int first, { @@ -473,80 +333,37 @@ class FamilyProvider extends FutureProvider { fourth: fourth, fifth: fifth, ), - from: familyProvider, - name: r'familyProvider', + argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), + ); + + FamilyProvider._internal( + super.create, { + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$familyHash, + from: familyProvider, + name: r'familyProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, ); - FamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.first, - required this.second, - required this.third, - required this.fourth, - required this.fifth, - }) : super.internal(); - - final int first; - final String? second; - final double third; - final bool fourth; - final List? fifth; - - @override - Override overrideWith( - FutureOr Function(FamilyRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: FamilyProvider._internal( - (ref) => create(ref as FamilyRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - ); - } - - @override - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) get argument { - return ( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ); - } - @override _FamilyProviderElement createElement( ProviderContainer container, @@ -554,45 +371,30 @@ class FamilyProvider extends FutureProvider { return _FamilyProviderElement(this, container); } - FamilyProvider _copyWith( + @internal + @override + FamilyProvider copyWithCreate( FutureOr Function(FamilyRef ref) create, ) { return FamilyProvider._internal( (ref) => create(ref as FamilyRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, + argument: argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), ); } @override bool operator ==(Object other) { - return other is FamilyProvider && - other.first == first && - other.second == second && - other.third == third && - other.fourth == fourth && - other.fifth == fifth; + return other is FamilyProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, first.hashCode); - hash = _SystemHash.combine(hash, second.hashCode); - hash = _SystemHash.combine(hash, third.hashCode); - hash = _SystemHash.combine(hash, fourth.hashCode); - hash = _SystemHash.combine(hash, fifth.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'familyProvider$argument'; @@ -643,7 +445,7 @@ abstract class _$GenericClass const genericClassProvider = GenericClassFamily(); /// See also [GenericClass]. -class GenericClassFamily extends Family { +final class GenericClassFamily extends Family { /// See also [GenericClass]. const GenericClassFamily() : super( @@ -666,61 +468,35 @@ class GenericClassFamily extends Family { return GenericClassProvider(); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(GenericClass Function() create) { - return _$GenericClassFamilyOverride(this, create); - } - @override String toString() => 'genericClassProvider'; } -class _$GenericClassFamilyOverride implements FamilyOverride { - _$GenericClassFamilyOverride(this.from, this.create); - - final GenericClass Function() create; - - @override - final GenericClassFamily from; - - @override - _GenericClassProviderElement createElement( - ProviderContainer container, - covariant GenericClassProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'genericClassProvider.overrideWith(...)'; -} - /// See also [GenericClass]. -class GenericClassProvider +final class GenericClassProvider extends AutoDisposeAsyncNotifierProviderImpl, List> { /// See also [GenericClass]. GenericClassProvider() : this._internal( GenericClass.new, - from: genericClassProvider, - name: r'genericClassProvider', + argument: (), + ); + + GenericClassProvider._internal( + super.create, { + required () super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$genericClassHash, + from: genericClassProvider, + name: r'genericClassProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - GenericClassProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); - @override FutureOr> runNotifierBuild( covariant GenericClass notifier, @@ -728,26 +504,16 @@ class GenericClassProvider return notifier.build(); } + @internal @override - Override overrideWith(GenericClass Function() create) { - return ProviderOverride( - origin: this, - providerOverride: GenericClassProvider._internal( - () => create(), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), + AutoDisposeAsyncNotifierProviderImpl copyWithBuild( + GenericClass Function() create, + ) { + return AutoDisposeAsyncNotifierProviderImpl._internal( + create, ); } - @override - () get argument { - return (); - } - @override _GenericClassProviderElement createElement( ProviderContainer container, @@ -755,31 +521,26 @@ class GenericClassProvider return _GenericClassProviderElement(this, container); } - GenericClassProvider _copyWith( + @internal + @override + GenericClassProvider copyWithCreate( GenericClass Function() create, ) { return GenericClassProvider._internal( () => create(), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, + argument: argument as (), ); } @override bool operator ==(Object other) { - return other is GenericClassProvider && other.runtimeType == runtimeType; + return other is GenericClassProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, T.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'genericClassProvider<$T>$argument'; @@ -844,7 +605,7 @@ abstract class _$FamilyOrClass const familyOrClassProvider = FamilyOrClassFamily(); /// See also [FamilyOrClass]. -class FamilyOrClassFamily extends Family { +final class FamilyOrClassFamily extends Family { /// See also [FamilyOrClass]. const FamilyOrClassFamily() : super( @@ -871,66 +632,36 @@ class FamilyOrClassFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(FamilyOrClass Function() create) { - return _$FamilyOrClassFamilyOverride(this, create); - } - @override String toString() => 'familyOrClassProvider'; } -class _$FamilyOrClassFamilyOverride implements FamilyOverride { - _$FamilyOrClassFamilyOverride(this.from, this.create); - - final FamilyOrClass Function() create; - - @override - final FamilyOrClassFamily from; - - @override - _FamilyOrClassProviderElement createElement( - ProviderContainer container, - covariant FamilyOrClassProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'familyOrClassProvider.overrideWith(...)'; -} - /// See also [FamilyOrClass]. -class FamilyOrClassProvider +final class FamilyOrClassProvider extends AutoDisposeAsyncNotifierProviderImpl { /// See also [FamilyOrClass]. FamilyOrClassProvider( int first, ) : this._internal( () => FamilyOrClass()..first = first, - from: familyOrClassProvider, - name: r'familyOrClassProvider', + argument: (first,), + ); + + FamilyOrClassProvider._internal( + super.create, { + required (int,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$familyOrClassHash, + from: familyOrClassProvider, + name: r'familyOrClassProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - first: first, ); - FamilyOrClassProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.first, - }) : super.internal(); - - final int first; - @override FutureOr runNotifierBuild( covariant FamilyOrClass notifier, @@ -940,27 +671,17 @@ class FamilyOrClassProvider ); } + @internal @override - Override overrideWith(FamilyOrClass Function() create) { - return ProviderOverride( - origin: this, - providerOverride: FamilyOrClassProvider._internal( - () => create()..first = first, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - first: first, - ), + AutoDisposeAsyncNotifierProviderImpl copyWithBuild( + FamilyOrClass Function() create, + ) { + return AutoDisposeAsyncNotifierProviderImpl._internal( + create, + first: first, ); } - @override - (int,) get argument { - return (first,); - } - @override _FamilyOrClassProviderElement createElement( ProviderContainer container, @@ -968,32 +689,24 @@ class FamilyOrClassProvider return _FamilyOrClassProviderElement(this, container); } - FamilyOrClassProvider _copyWith( + @internal + @override + FamilyOrClassProvider copyWithCreate( FamilyOrClass Function() create, ) { return FamilyOrClassProvider._internal( () => create()..first = first, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - first: first, + argument: argument as (int,), ); } @override bool operator ==(Object other) { - return other is FamilyOrClassProvider && other.first == first; + return other is FamilyOrClassProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, first.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'familyOrClassProvider$argument'; @@ -1036,7 +749,7 @@ abstract class _$FamilyClass extends BuildlessAutoDisposeAsyncNotifier { const familyClassProvider = FamilyClassFamily(); /// See also [FamilyClass]. -class FamilyClassFamily extends Family { +final class FamilyClassFamily extends Family { /// See also [FamilyClass]. const FamilyClassFamily() : super( @@ -1071,37 +784,12 @@ class FamilyClassFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(FamilyClass Function() create) { - return _$FamilyClassFamilyOverride(this, create); - } - @override String toString() => 'familyClassProvider'; } -class _$FamilyClassFamilyOverride implements FamilyOverride { - _$FamilyClassFamilyOverride(this.from, this.create); - - final FamilyClass Function() create; - - @override - final FamilyClassFamily from; - - @override - _FamilyClassProviderElement createElement( - ProviderContainer container, - covariant FamilyClassProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'familyClassProvider.overrideWith(...)'; -} - /// See also [FamilyClass]. -class FamilyClassProvider +final class FamilyClassProvider extends AutoDisposeAsyncNotifierProviderImpl { /// See also [FamilyClass]. FamilyClassProvider( @@ -1117,41 +805,37 @@ class FamilyClassProvider ..third = third ..fourth = fourth ..fifth = fifth, - from: familyClassProvider, - name: r'familyClassProvider', + argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), + ); + + FamilyClassProvider._internal( + super.create, { + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$familyClassHash, + from: familyClassProvider, + name: r'familyClassProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, ); - FamilyClassProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.first, - required this.second, - required this.third, - required this.fourth, - required this.fifth, - }) : super.internal(); - - final int first; - final String? second; - final double third; - final bool fourth; - final List? fifth; - @override FutureOr runNotifierBuild( covariant FamilyClass notifier, @@ -1165,41 +849,14 @@ class FamilyClassProvider ); } + @internal @override - Override overrideWith(FamilyClass Function() create) { - return ProviderOverride( - origin: this, - providerOverride: FamilyClassProvider._internal( - () => create() - ..first = first - ..second = second - ..third = third - ..fourth = fourth - ..fifth = fifth, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - ); - } - - @override - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) get argument { - return ( - first, + AutoDisposeAsyncNotifierProviderImpl copyWithBuild( + FamilyClass Function() create, + ) { + return AutoDisposeAsyncNotifierProviderImpl._internal( + create, + first: first, second: second, third: third, fourth: fourth, @@ -1214,7 +871,9 @@ class FamilyClassProvider return _FamilyClassProviderElement(this, container); } - FamilyClassProvider _copyWith( + @internal + @override + FamilyClassProvider copyWithCreate( FamilyClass Function() create, ) { return FamilyClassProvider._internal( @@ -1224,40 +883,23 @@ class FamilyClassProvider ..third = third ..fourth = fourth ..fifth = fifth, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, + argument: argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), ); } @override bool operator ==(Object other) { - return other is FamilyClassProvider && - other.first == first && - other.second == second && - other.third == third && - other.fourth == fourth && - other.fifth == fifth; + return other is FamilyClassProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, first.hashCode); - hash = _SystemHash.combine(hash, second.hashCode); - hash = _SystemHash.combine(hash, third.hashCode); - hash = _SystemHash.combine(hash, fourth.hashCode); - hash = _SystemHash.combine(hash, fifth.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'familyClassProvider$argument'; diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 568f92752..647389129 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -51,7 +51,7 @@ class _SystemHash { const familyProvider = FamilyFamily(); /// See also [family]. -class FamilyFamily extends Family { +final class FamilyFamily extends Family { /// See also [family]. const FamilyFamily() : super( @@ -78,37 +78,12 @@ class FamilyFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(int Function(FamilyRef ref) create) { - return _$FamilyFamilyOverride(this, create); - } - @override String toString() => 'familyProvider'; } -class _$FamilyFamilyOverride implements FamilyOverride { - _$FamilyFamilyOverride(this.from, this.create); - - final int Function(FamilyRef ref) create; - - @override - final FamilyFamily from; - - @override - _FamilyProviderElement createElement( - ProviderContainer container, - covariant FamilyProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'familyProvider.overrideWith(...)'; -} - /// See also [family]. -class FamilyProvider extends Provider { +final class FamilyProvider extends Provider { /// See also [family]. FamilyProvider( int id, @@ -117,52 +92,24 @@ class FamilyProvider extends Provider { ref as FamilyRef, id, ), - from: familyProvider, - name: r'familyProvider', + argument: (id,), + ); + + FamilyProvider._internal( + super.create, { + required (int,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$familyHash, + from: familyProvider, + name: r'familyProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - id: id, ); - FamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.id, - }) : super.internal(); - - final int id; - - @override - Override overrideWith( - int Function(FamilyRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: FamilyProvider._internal( - (ref) => create(ref as FamilyRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - id: id, - ), - ); - } - - @override - (int,) get argument { - return (id,); - } - @override _FamilyProviderElement createElement( ProviderContainer container, @@ -170,32 +117,24 @@ class FamilyProvider extends Provider { return _FamilyProviderElement(this, container); } - FamilyProvider _copyWith( + @internal + @override + FamilyProvider copyWithCreate( int Function(FamilyRef ref) create, ) { return FamilyProvider._internal( (ref) => create(ref as FamilyRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - id: id, + argument: argument as (int,), ); } @override bool operator ==(Object other) { - return other is FamilyProvider && other.id == id; + return other is FamilyProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, id.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'familyProvider$argument'; @@ -432,7 +371,7 @@ abstract class _$Family2 extends BuildlessAutoDisposeNotifier { const family2Provider = Family2Family(); /// See also [Family2]. -class Family2Family extends Family { +final class Family2Family extends Family { /// See also [Family2]. const Family2Family() : super( @@ -459,65 +398,36 @@ class Family2Family extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(Family2 Function() create) { - return _$Family2FamilyOverride(this, create); - } - @override String toString() => 'family2Provider'; } -class _$Family2FamilyOverride implements FamilyOverride { - _$Family2FamilyOverride(this.from, this.create); - - final Family2 Function() create; - - @override - final Family2Family from; - - @override - _Family2ProviderElement createElement( - ProviderContainer container, - covariant Family2Provider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'family2Provider.overrideWith(...)'; -} - /// See also [Family2]. -class Family2Provider extends AutoDisposeNotifierProviderImpl { +final class Family2Provider + extends AutoDisposeNotifierProviderImpl { /// See also [Family2]. Family2Provider( int id, ) : this._internal( () => Family2()..id = id, - from: family2Provider, - name: r'family2Provider', + argument: (id,), + ); + + Family2Provider._internal( + super.create, { + required (int,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$family2Hash, + from: family2Provider, + name: r'family2Provider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - id: id, ); - Family2Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.id, - }) : super.internal(); - - final int id; - @override int runNotifierBuild( covariant Family2 notifier, @@ -527,27 +437,17 @@ class Family2Provider extends AutoDisposeNotifierProviderImpl { ); } + @internal @override - Override overrideWith(Family2 Function() create) { - return ProviderOverride( - origin: this, - providerOverride: Family2Provider._internal( - () => create()..id = id, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - id: id, - ), + AutoDisposeNotifierProviderImpl copyWithBuild( + Family2 Function() create, + ) { + return AutoDisposeNotifierProviderImpl._internal( + create, + id: id, ); } - @override - (int,) get argument { - return (id,); - } - @override _Family2ProviderElement createElement( ProviderContainer container, @@ -555,32 +455,24 @@ class Family2Provider extends AutoDisposeNotifierProviderImpl { return _Family2ProviderElement(this, container); } - Family2Provider _copyWith( + @internal + @override + Family2Provider copyWithCreate( Family2 Function() create, ) { return Family2Provider._internal( () => create()..id = id, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - id: id, + argument: argument as (int,), ); } @override bool operator ==(Object other) { - return other is Family2Provider && other.id == id; + return other is Family2Provider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, id.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'family2Provider$argument'; @@ -645,7 +537,7 @@ abstract class _$Provider4 extends BuildlessAutoDisposeNotifier { const provider4Provider = Provider4Family(); /// See also [Provider4]. -class Provider4Family extends Family { +final class Provider4Family extends Family { /// See also [Provider4]. const Provider4Family() : super( @@ -687,66 +579,36 @@ class Provider4Family extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(Provider4 Function() create) { - return _$Provider4FamilyOverride(this, create); - } - @override String toString() => 'provider4Provider'; } -class _$Provider4FamilyOverride implements FamilyOverride { - _$Provider4FamilyOverride(this.from, this.create); - - final Provider4 Function() create; - - @override - final Provider4Family from; - - @override - _Provider4ProviderElement createElement( - ProviderContainer container, - covariant Provider4Provider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'provider4Provider.overrideWith(...)'; -} - /// See also [Provider4]. -class Provider4Provider +final class Provider4Provider extends AutoDisposeNotifierProviderImpl { /// See also [Provider4]. Provider4Provider( int id, ) : this._internal( () => Provider4()..id = id, - from: provider4Provider, - name: r'provider4Provider', + argument: (id,), + ); + + Provider4Provider._internal( + super.create, { + required (int,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$provider4Hash, + from: provider4Provider, + name: r'provider4Provider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - id: id, ); - Provider4Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.id, - }) : super.internal(); - - final int id; - @override int runNotifierBuild( covariant Provider4 notifier, @@ -756,27 +618,17 @@ class Provider4Provider ); } + @internal @override - Override overrideWith(Provider4 Function() create) { - return ProviderOverride( - origin: this, - providerOverride: Provider4Provider._internal( - () => create()..id = id, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - id: id, - ), + AutoDisposeNotifierProviderImpl copyWithBuild( + Provider4 Function() create, + ) { + return AutoDisposeNotifierProviderImpl._internal( + create, + id: id, ); } - @override - (int,) get argument { - return (id,); - } - @override _Provider4ProviderElement createElement( ProviderContainer container, @@ -784,32 +636,24 @@ class Provider4Provider return _Provider4ProviderElement(this, container); } - Provider4Provider _copyWith( + @internal + @override + Provider4Provider copyWithCreate( Provider4 Function() create, ) { return Provider4Provider._internal( () => create()..id = id, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - id: id, + argument: argument as (int,), ); } @override bool operator ==(Object other) { - return other is Provider4Provider && other.id == id; + return other is Provider4Provider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, id.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'provider4Provider$argument'; diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 29b76d4f5..3e86f70d1 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -65,7 +65,7 @@ class _SystemHash { const familyWithDependencies2Provider = FamilyWithDependencies2Family(); /// See also [familyWithDependencies2]. -class FamilyWithDependencies2Family extends Family { +final class FamilyWithDependencies2Family extends Family { /// See also [familyWithDependencies2]. const FamilyWithDependencies2Family() : super( @@ -104,37 +104,12 @@ class FamilyWithDependencies2Family extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(int Function(FamilyWithDependencies2Ref ref) create) { - return _$FamilyWithDependencies2FamilyOverride(this, create); - } - @override String toString() => 'familyWithDependencies2Provider'; } -class _$FamilyWithDependencies2FamilyOverride implements FamilyOverride { - _$FamilyWithDependencies2FamilyOverride(this.from, this.create); - - final int Function(FamilyWithDependencies2Ref ref) create; - - @override - final FamilyWithDependencies2Family from; - - @override - _FamilyWithDependencies2ProviderElement createElement( - ProviderContainer container, - covariant FamilyWithDependencies2Provider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'familyWithDependencies2Provider.overrideWith(...)'; -} - /// See also [familyWithDependencies2]. -class FamilyWithDependencies2Provider extends Provider { +final class FamilyWithDependencies2Provider extends Provider { /// See also [familyWithDependencies2]. FamilyWithDependencies2Provider({ int? id, @@ -143,54 +118,27 @@ class FamilyWithDependencies2Provider extends Provider { ref as FamilyWithDependencies2Ref, id: id, ), - from: familyWithDependencies2Provider, - name: r'familyWithDependencies2Provider', + argument: (id: id,), + ); + + FamilyWithDependencies2Provider._internal( + super.create, { + required ({ + int? id, + }) + super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$familyWithDependencies2Hash, + from: familyWithDependencies2Provider, + name: r'familyWithDependencies2Provider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - id: id, ); - FamilyWithDependencies2Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.id, - }) : super.internal(); - - final int? id; - - @override - Override overrideWith( - int Function(FamilyWithDependencies2Ref ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: FamilyWithDependencies2Provider._internal( - (ref) => create(ref as FamilyWithDependencies2Ref), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - id: id, - ), - ); - } - - @override - ({ - int? id, - }) get argument { - return (id: id,); - } - @override _FamilyWithDependencies2ProviderElement createElement( ProviderContainer container, @@ -198,32 +146,27 @@ class FamilyWithDependencies2Provider extends Provider { return _FamilyWithDependencies2ProviderElement(this, container); } - FamilyWithDependencies2Provider _copyWith( + @internal + @override + FamilyWithDependencies2Provider copyWithCreate( int Function(FamilyWithDependencies2Ref ref) create, ) { return FamilyWithDependencies2Provider._internal( (ref) => create(ref as FamilyWithDependencies2Ref), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - id: id, + argument: argument as ({ + int? id, + }), ); } @override bool operator ==(Object other) { - return other is FamilyWithDependencies2Provider && other.id == id; + return other is FamilyWithDependencies2Provider && + other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, id.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'familyWithDependencies2Provider$argument'; @@ -325,7 +268,7 @@ const notifierFamilyWithDependenciesProvider = NotifierFamilyWithDependenciesFamily(); /// See also [NotifierFamilyWithDependencies]. -class NotifierFamilyWithDependenciesFamily extends Family { +final class NotifierFamilyWithDependenciesFamily extends Family { /// See also [NotifierFamilyWithDependencies]. const NotifierFamilyWithDependenciesFamily() : super( @@ -364,38 +307,12 @@ class NotifierFamilyWithDependenciesFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(NotifierFamilyWithDependencies Function() create) { - return _$NotifierFamilyWithDependenciesFamilyOverride(this, create); - } - @override String toString() => 'notifierFamilyWithDependenciesProvider'; } -class _$NotifierFamilyWithDependenciesFamilyOverride implements FamilyOverride { - _$NotifierFamilyWithDependenciesFamilyOverride(this.from, this.create); - - final NotifierFamilyWithDependencies Function() create; - - @override - final NotifierFamilyWithDependenciesFamily from; - - @override - _NotifierFamilyWithDependenciesProviderElement createElement( - ProviderContainer container, - covariant NotifierFamilyWithDependenciesProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => - 'notifierFamilyWithDependenciesProvider.overrideWith(...)'; -} - /// See also [NotifierFamilyWithDependencies]. -class NotifierFamilyWithDependenciesProvider +final class NotifierFamilyWithDependenciesProvider extends AutoDisposeNotifierProviderImpl { /// See also [NotifierFamilyWithDependencies]. @@ -403,29 +320,27 @@ class NotifierFamilyWithDependenciesProvider int? id, }) : this._internal( () => NotifierFamilyWithDependencies()..id = id, - from: notifierFamilyWithDependenciesProvider, - name: r'notifierFamilyWithDependenciesProvider', + argument: (id: id,), + ); + + NotifierFamilyWithDependenciesProvider._internal( + super.create, { + required ({ + int? id, + }) + super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$notifierFamilyWithDependenciesHash, + from: notifierFamilyWithDependenciesProvider, + name: r'notifierFamilyWithDependenciesProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - id: id, ); - NotifierFamilyWithDependenciesProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.id, - }) : super.internal(); - - final int? id; - @override int runNotifierBuild( covariant NotifierFamilyWithDependencies notifier, @@ -435,29 +350,17 @@ class NotifierFamilyWithDependenciesProvider ); } + @internal @override - Override overrideWith(NotifierFamilyWithDependencies Function() create) { - return ProviderOverride( - origin: this, - providerOverride: NotifierFamilyWithDependenciesProvider._internal( - () => create()..id = id, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - id: id, - ), + AutoDisposeNotifierProviderImpl copyWithBuild( + NotifierFamilyWithDependencies Function() create, + ) { + return AutoDisposeNotifierProviderImpl._internal( + create, + id: id, ); } - @override - ({ - int? id, - }) get argument { - return (id: id,); - } - @override _NotifierFamilyWithDependenciesProviderElement createElement( ProviderContainer container, @@ -465,32 +368,27 @@ class NotifierFamilyWithDependenciesProvider return _NotifierFamilyWithDependenciesProviderElement(this, container); } - NotifierFamilyWithDependenciesProvider _copyWith( + @internal + @override + NotifierFamilyWithDependenciesProvider copyWithCreate( NotifierFamilyWithDependencies Function() create, ) { return NotifierFamilyWithDependenciesProvider._internal( () => create()..id = id, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - id: id, + argument: argument as ({ + int? id, + }), ); } @override bool operator ==(Object other) { - return other is NotifierFamilyWithDependenciesProvider && other.id == id; + return other is NotifierFamilyWithDependenciesProvider && + other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, id.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'notifierFamilyWithDependenciesProvider$argument'; diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index e795faf6e..6e27e91fa 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -51,7 +51,7 @@ class _SystemHash { const generatedFamilyProvider = GeneratedFamilyFamily(); /// See also [generatedFamily]. -class GeneratedFamilyFamily extends Family { +final class GeneratedFamilyFamily extends Family { /// See also [generatedFamily]. const GeneratedFamilyFamily() : super( @@ -78,37 +78,12 @@ class GeneratedFamilyFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(_Test Function(GeneratedFamilyRef ref) create) { - return _$GeneratedFamilyFamilyOverride(this, create); - } - @override String toString() => 'generatedFamilyProvider'; } -class _$GeneratedFamilyFamilyOverride implements FamilyOverride { - _$GeneratedFamilyFamilyOverride(this.from, this.create); - - final _Test Function(GeneratedFamilyRef ref) create; - - @override - final GeneratedFamilyFamily from; - - @override - _GeneratedFamilyProviderElement createElement( - ProviderContainer container, - covariant GeneratedFamilyProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'generatedFamilyProvider.overrideWith(...)'; -} - /// See also [generatedFamily]. -class GeneratedFamilyProvider extends Provider<_Test> { +final class GeneratedFamilyProvider extends Provider<_Test> { /// See also [generatedFamily]. GeneratedFamilyProvider( _Test test, @@ -117,52 +92,24 @@ class GeneratedFamilyProvider extends Provider<_Test> { ref as GeneratedFamilyRef, test, ), - from: generatedFamilyProvider, - name: r'generatedFamilyProvider', + argument: (test,), + ); + + GeneratedFamilyProvider._internal( + super.create, { + required (_Test,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$generatedFamilyHash, + from: generatedFamilyProvider, + name: r'generatedFamilyProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - test: test, ); - GeneratedFamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.test, - }) : super.internal(); - - final _Test test; - - @override - Override overrideWith( - _Test Function(GeneratedFamilyRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: GeneratedFamilyProvider._internal( - (ref) => create(ref as GeneratedFamilyRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - test: test, - ), - ); - } - - @override - (_Test,) get argument { - return (test,); - } - @override _GeneratedFamilyProviderElement createElement( ProviderContainer container, @@ -170,32 +117,24 @@ class GeneratedFamilyProvider extends Provider<_Test> { return _GeneratedFamilyProviderElement(this, container); } - GeneratedFamilyProvider _copyWith( + @internal + @override + GeneratedFamilyProvider copyWithCreate( _Test Function(GeneratedFamilyRef ref) create, ) { return GeneratedFamilyProvider._internal( (ref) => create(ref as GeneratedFamilyRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - test: test, + argument: argument as (_Test,), ); } @override bool operator ==(Object other) { - return other is GeneratedFamilyProvider && other.test == test; + return other is GeneratedFamilyProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, test.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'generatedFamilyProvider$argument'; @@ -238,7 +177,7 @@ String _$$dynamicFamilyHash() => r'b764133af8837b8321b08814892f198d4bc1aa18'; const $dynamicFamilyProvider = $DynamicFamilyFamily(); /// See also [$dynamicFamily]. -class $DynamicFamilyFamily extends Family { +final class $DynamicFamilyFamily extends Family { /// See also [$dynamicFamily]. const $DynamicFamilyFamily() : super( @@ -265,37 +204,12 @@ class $DynamicFamilyFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(Object? Function($DynamicFamilyRef ref) create) { - return _$$DynamicFamilyFamilyOverride(this, create); - } - @override String toString() => '\$dynamicFamilyProvider'; } -class _$$DynamicFamilyFamilyOverride implements FamilyOverride { - _$$DynamicFamilyFamilyOverride(this.from, this.create); - - final Object? Function($DynamicFamilyRef ref) create; - - @override - final $DynamicFamilyFamily from; - - @override - _$DynamicFamilyProviderElement createElement( - ProviderContainer container, - covariant $DynamicFamilyProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => '\$dynamicFamilyProvider.overrideWith(...)'; -} - /// See also [$dynamicFamily]. -class $DynamicFamilyProvider extends Provider { +final class $DynamicFamilyProvider extends Provider { /// See also [$dynamicFamily]. $DynamicFamilyProvider( test, @@ -304,52 +218,24 @@ class $DynamicFamilyProvider extends Provider { ref as $DynamicFamilyRef, test, ), - from: $dynamicFamilyProvider, - name: r'$dynamicFamilyProvider', + argument: (test,), + ); + + $DynamicFamilyProvider._internal( + super.create, { + required (dynamic,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$$dynamicFamilyHash, + from: $dynamicFamilyProvider, + name: r'$dynamicFamilyProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - test: test, ); - $DynamicFamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.test, - }) : super.internal(); - - final test; - - @override - Override overrideWith( - Object? Function($DynamicFamilyRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: $DynamicFamilyProvider._internal( - (ref) => create(ref as $DynamicFamilyRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - test: test, - ), - ); - } - - @override - (dynamic,) get argument { - return (test,); - } - @override _$DynamicFamilyProviderElement createElement( ProviderContainer container, @@ -357,32 +243,24 @@ class $DynamicFamilyProvider extends Provider { return _$DynamicFamilyProviderElement(this, container); } - $DynamicFamilyProvider _copyWith( + @internal + @override + $DynamicFamilyProvider copyWithCreate( Object? Function($DynamicFamilyRef ref) create, ) { return $DynamicFamilyProvider._internal( (ref) => create(ref as $DynamicFamilyRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - test: test, + argument: argument as (dynamic,), ); } @override bool operator ==(Object other) { - return other is $DynamicFamilyProvider && other.test == test; + return other is $DynamicFamilyProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, test.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => '\$dynamicFamilyProvider$argument'; @@ -408,7 +286,7 @@ String _$dynamicHash() => r'da9dc07960139fff2cf5fe584dca5c524e4f2308'; const _dynamicProvider = _DynamicFamily(); /// See also [_dynamic]. -class _DynamicFamily extends Family { +final class _DynamicFamily extends Family { /// See also [_dynamic]. const _DynamicFamily() : super( @@ -435,37 +313,12 @@ class _DynamicFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(Object? Function(_DynamicRef ref) create) { - return _$DynamicFamilyOverride(this, create); - } - @override String toString() => '_dynamicProvider'; } -class _$DynamicFamilyOverride implements FamilyOverride { - _$DynamicFamilyOverride(this.from, this.create); - - final Object? Function(_DynamicRef ref) create; - - @override - final _DynamicFamily from; - - @override - _DynamicProviderElement createElement( - ProviderContainer container, - covariant _DynamicProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => '_dynamicProvider.overrideWith(...)'; -} - /// See also [_dynamic]. -class _DynamicProvider extends Provider { +final class _DynamicProvider extends Provider { /// See also [_dynamic]. _DynamicProvider( test, @@ -474,52 +327,24 @@ class _DynamicProvider extends Provider { ref as _DynamicRef, test, ), - from: _dynamicProvider, - name: r'_dynamicProvider', + argument: (test,), + ); + + _DynamicProvider._internal( + super.create, { + required (dynamic,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$dynamicHash, + from: _dynamicProvider, + name: r'_dynamicProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - test: test, ); - _DynamicProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.test, - }) : super.internal(); - - final test; - - @override - Override overrideWith( - Object? Function(_DynamicRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: _DynamicProvider._internal( - (ref) => create(ref as _DynamicRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - test: test, - ), - ); - } - - @override - (dynamic,) get argument { - return (test,); - } - @override _DynamicProviderElement createElement( ProviderContainer container, @@ -527,32 +352,24 @@ class _DynamicProvider extends Provider { return _DynamicProviderElement(this, container); } - _DynamicProvider _copyWith( + @internal + @override + _DynamicProvider copyWithCreate( Object? Function(_DynamicRef ref) create, ) { return _DynamicProvider._internal( (ref) => create(ref as _DynamicRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - test: test, + argument: argument as (dynamic,), ); } @override bool operator ==(Object other) { - return other is _DynamicProvider && other.test == test; + return other is _DynamicProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, test.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => '_dynamicProvider$argument'; @@ -595,7 +412,7 @@ String _$aliasFamilyHash() => r'f345937d5750132f629aef41646b119a301f750b'; const aliasFamilyProvider = AliasFamilyFamily(); /// See also [aliasFamily]. -class AliasFamilyFamily extends Family { +final class AliasFamilyFamily extends Family { /// See also [aliasFamily]. const AliasFamilyFamily() : super( @@ -622,37 +439,12 @@ class AliasFamilyFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(r.AsyncValue Function(AliasFamilyRef ref) create) { - return _$AliasFamilyFamilyOverride(this, create); - } - @override String toString() => 'aliasFamilyProvider'; } -class _$AliasFamilyFamilyOverride implements FamilyOverride { - _$AliasFamilyFamilyOverride(this.from, this.create); - - final r.AsyncValue Function(AliasFamilyRef ref) create; - - @override - final AliasFamilyFamily from; - - @override - _AliasFamilyProviderElement createElement( - ProviderContainer container, - covariant AliasFamilyProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'aliasFamilyProvider.overrideWith(...)'; -} - /// See also [aliasFamily]. -class AliasFamilyProvider extends Provider> { +final class AliasFamilyProvider extends Provider> { /// See also [aliasFamily]. AliasFamilyProvider( r.AsyncValue test, @@ -661,52 +453,24 @@ class AliasFamilyProvider extends Provider> { ref as AliasFamilyRef, test, ), - from: aliasFamilyProvider, - name: r'aliasFamilyProvider', + argument: (test,), + ); + + AliasFamilyProvider._internal( + super.create, { + required (r.AsyncValue,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$aliasFamilyHash, + from: aliasFamilyProvider, + name: r'aliasFamilyProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - test: test, ); - AliasFamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.test, - }) : super.internal(); - - final r.AsyncValue test; - - @override - Override overrideWith( - r.AsyncValue Function(AliasFamilyRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: AliasFamilyProvider._internal( - (ref) => create(ref as AliasFamilyRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - test: test, - ), - ); - } - - @override - (r.AsyncValue,) get argument { - return (test,); - } - @override _AliasFamilyProviderElement createElement( ProviderContainer container, @@ -714,32 +478,24 @@ class AliasFamilyProvider extends Provider> { return _AliasFamilyProviderElement(this, container); } - AliasFamilyProvider _copyWith( + @internal + @override + AliasFamilyProvider copyWithCreate( r.AsyncValue Function(AliasFamilyRef ref) create, ) { return AliasFamilyProvider._internal( (ref) => create(ref as AliasFamilyRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - test: test, + argument: argument as (r.AsyncValue,), ); } @override bool operator ==(Object other) { - return other is AliasFamilyProvider && other.test == test; + return other is AliasFamilyProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, test.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'aliasFamilyProvider$argument'; @@ -793,7 +549,7 @@ abstract class _$GeneratedClassFamily const generatedClassFamilyProvider = GeneratedClassFamilyFamily(); /// See also [GeneratedClassFamily]. -class GeneratedClassFamilyFamily extends Family { +final class GeneratedClassFamilyFamily extends Family { /// See also [GeneratedClassFamily]. const GeneratedClassFamilyFamily() : super( @@ -820,66 +576,36 @@ class GeneratedClassFamilyFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(GeneratedClassFamily Function() create) { - return _$GeneratedClassFamilyFamilyOverride(this, create); - } - @override String toString() => 'generatedClassFamilyProvider'; } -class _$GeneratedClassFamilyFamilyOverride implements FamilyOverride { - _$GeneratedClassFamilyFamilyOverride(this.from, this.create); - - final GeneratedClassFamily Function() create; - - @override - final GeneratedClassFamilyFamily from; - - @override - _GeneratedClassFamilyProviderElement createElement( - ProviderContainer container, - covariant GeneratedClassFamilyProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'generatedClassFamilyProvider.overrideWith(...)'; -} - /// See also [GeneratedClassFamily]. -class GeneratedClassFamilyProvider +final class GeneratedClassFamilyProvider extends AutoDisposeNotifierProviderImpl { /// See also [GeneratedClassFamily]. GeneratedClassFamilyProvider( _Test test, ) : this._internal( () => GeneratedClassFamily()..test = test, - from: generatedClassFamilyProvider, - name: r'generatedClassFamilyProvider', + argument: (test,), + ); + + GeneratedClassFamilyProvider._internal( + super.create, { + required (_Test,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$generatedClassFamilyHash, + from: generatedClassFamilyProvider, + name: r'generatedClassFamilyProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - test: test, ); - GeneratedClassFamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.test, - }) : super.internal(); - - final _Test test; - @override _Test runNotifierBuild( covariant GeneratedClassFamily notifier, @@ -889,27 +615,17 @@ class GeneratedClassFamilyProvider ); } + @internal @override - Override overrideWith(GeneratedClassFamily Function() create) { - return ProviderOverride( - origin: this, - providerOverride: GeneratedClassFamilyProvider._internal( - () => create()..test = test, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - test: test, - ), + AutoDisposeNotifierProviderImpl copyWithBuild( + GeneratedClassFamily Function() create, + ) { + return AutoDisposeNotifierProviderImpl._internal( + create, + test: test, ); } - @override - (_Test,) get argument { - return (test,); - } - @override _GeneratedClassFamilyProviderElement createElement( ProviderContainer container, @@ -917,32 +633,24 @@ class GeneratedClassFamilyProvider return _GeneratedClassFamilyProviderElement(this, container); } - GeneratedClassFamilyProvider _copyWith( + @internal + @override + GeneratedClassFamilyProvider copyWithCreate( GeneratedClassFamily Function() create, ) { return GeneratedClassFamilyProvider._internal( () => create()..test = test, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - test: test, + argument: argument as (_Test,), ); } @override bool operator ==(Object other) { - return other is GeneratedClassFamilyProvider && other.test == test; + return other is GeneratedClassFamilyProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, test.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'generatedClassFamilyProvider$argument'; @@ -997,7 +705,7 @@ abstract class _$$DynamicClassFamily const $dynamicClassFamilyProvider = $DynamicClassFamilyFamily(); /// See also [$DynamicClassFamily]. -class $DynamicClassFamilyFamily extends Family { +final class $DynamicClassFamilyFamily extends Family { /// See also [$DynamicClassFamily]. const $DynamicClassFamilyFamily() : super( @@ -1024,66 +732,36 @@ class $DynamicClassFamilyFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith($DynamicClassFamily Function() create) { - return _$$DynamicClassFamilyFamilyOverride(this, create); - } - @override String toString() => '\$dynamicClassFamilyProvider'; } -class _$$DynamicClassFamilyFamilyOverride implements FamilyOverride { - _$$DynamicClassFamilyFamilyOverride(this.from, this.create); - - final $DynamicClassFamily Function() create; - - @override - final $DynamicClassFamilyFamily from; - - @override - _$DynamicClassFamilyProviderElement createElement( - ProviderContainer container, - covariant $DynamicClassFamilyProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => '\$dynamicClassFamilyProvider.overrideWith(...)'; -} - /// See also [$DynamicClassFamily]. -class $DynamicClassFamilyProvider +final class $DynamicClassFamilyProvider extends AutoDisposeNotifierProviderImpl<$DynamicClassFamily, Object?> { /// See also [$DynamicClassFamily]. $DynamicClassFamilyProvider( test, ) : this._internal( () => $DynamicClassFamily()..test = test, - from: $dynamicClassFamilyProvider, - name: r'$dynamicClassFamilyProvider', + argument: (test,), + ); + + $DynamicClassFamilyProvider._internal( + super.create, { + required (dynamic,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$$dynamicClassFamilyHash, + from: $dynamicClassFamilyProvider, + name: r'$dynamicClassFamilyProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - test: test, ); - $DynamicClassFamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.test, - }) : super.internal(); - - final test; - @override Object? runNotifierBuild( covariant $DynamicClassFamily notifier, @@ -1093,27 +771,17 @@ class $DynamicClassFamilyProvider ); } + @internal @override - Override overrideWith($DynamicClassFamily Function() create) { - return ProviderOverride( - origin: this, - providerOverride: $DynamicClassFamilyProvider._internal( - () => create()..test = test, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - test: test, - ), + AutoDisposeNotifierProviderImpl copyWithBuild( + $DynamicClassFamily Function() create, + ) { + return AutoDisposeNotifierProviderImpl._internal( + create, + test: test, ); } - @override - (dynamic,) get argument { - return (test,); - } - @override _$DynamicClassFamilyProviderElement createElement( ProviderContainer container, @@ -1121,32 +789,24 @@ class $DynamicClassFamilyProvider return _$DynamicClassFamilyProviderElement(this, container); } - $DynamicClassFamilyProvider _copyWith( + @internal + @override + $DynamicClassFamilyProvider copyWithCreate( $DynamicClassFamily Function() create, ) { return $DynamicClassFamilyProvider._internal( () => create()..test = test, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - test: test, + argument: argument as (dynamic,), ); } @override bool operator ==(Object other) { - return other is $DynamicClassFamilyProvider && other.test == test; + return other is $DynamicClassFamilyProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, test.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => '\$dynamicClassFamilyProvider$argument'; @@ -1200,7 +860,7 @@ abstract class _$AliasClassFamily const aliasClassFamilyProvider = AliasClassFamilyFamily(); /// See also [AliasClassFamily]. -class AliasClassFamilyFamily extends Family { +final class AliasClassFamilyFamily extends Family { /// See also [AliasClassFamily]. const AliasClassFamilyFamily() : super( @@ -1227,66 +887,36 @@ class AliasClassFamilyFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(AliasClassFamily Function() create) { - return _$AliasClassFamilyFamilyOverride(this, create); - } - @override String toString() => 'aliasClassFamilyProvider'; } -class _$AliasClassFamilyFamilyOverride implements FamilyOverride { - _$AliasClassFamilyFamilyOverride(this.from, this.create); - - final AliasClassFamily Function() create; - - @override - final AliasClassFamilyFamily from; - - @override - _AliasClassFamilyProviderElement createElement( - ProviderContainer container, - covariant AliasClassFamilyProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'aliasClassFamilyProvider.overrideWith(...)'; -} - /// See also [AliasClassFamily]. -class AliasClassFamilyProvider extends AutoDisposeNotifierProviderImpl< +final class AliasClassFamilyProvider extends AutoDisposeNotifierProviderImpl< AliasClassFamily, r.AsyncValue> { /// See also [AliasClassFamily]. AliasClassFamilyProvider( r.AsyncValue test, ) : this._internal( () => AliasClassFamily()..test = test, - from: aliasClassFamilyProvider, - name: r'aliasClassFamilyProvider', + argument: (test,), + ); + + AliasClassFamilyProvider._internal( + super.create, { + required (r.AsyncValue,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$aliasClassFamilyHash, + from: aliasClassFamilyProvider, + name: r'aliasClassFamilyProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - test: test, ); - AliasClassFamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.test, - }) : super.internal(); - - final r.AsyncValue test; - @override r.AsyncValue runNotifierBuild( covariant AliasClassFamily notifier, @@ -1296,27 +926,17 @@ class AliasClassFamilyProvider extends AutoDisposeNotifierProviderImpl< ); } + @internal @override - Override overrideWith(AliasClassFamily Function() create) { - return ProviderOverride( - origin: this, - providerOverride: AliasClassFamilyProvider._internal( - () => create()..test = test, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - test: test, - ), + AutoDisposeNotifierProviderImpl copyWithBuild( + AliasClassFamily Function() create, + ) { + return AutoDisposeNotifierProviderImpl._internal( + create, + test: test, ); } - @override - (r.AsyncValue,) get argument { - return (test,); - } - @override _AliasClassFamilyProviderElement createElement( ProviderContainer container, @@ -1324,32 +944,24 @@ class AliasClassFamilyProvider extends AutoDisposeNotifierProviderImpl< return _AliasClassFamilyProviderElement(this, container); } - AliasClassFamilyProvider _copyWith( + @internal + @override + AliasClassFamilyProvider copyWithCreate( AliasClassFamily Function() create, ) { return AliasClassFamilyProvider._internal( () => create()..test = test, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - test: test, + argument: argument as (r.AsyncValue,), ); } @override bool operator ==(Object other) { - return other is AliasClassFamilyProvider && other.test == test; + return other is AliasClassFamilyProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, test.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'aliasClassFamilyProvider$argument'; diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 55d420962..2400be93c 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -34,7 +34,7 @@ class _SystemHash { const genericProvider = GenericFamily(); /// See also [generic]. -class GenericFamily extends Family { +final class GenericFamily extends Family { /// See also [generic]. const GenericFamily() : super( @@ -57,85 +57,36 @@ class GenericFamily extends Family { return GenericProvider(); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith( - Stream> Function(GenericRef ref) create) { - return _$GenericFamilyOverride(this, create); - } - @override String toString() => 'genericProvider'; } -class _$GenericFamilyOverride implements FamilyOverride { - _$GenericFamilyOverride(this.from, this.create); - - final Stream> Function(GenericRef ref) create; - - @override - final GenericFamily from; - - @override - _GenericProviderElement createElement( - ProviderContainer container, - covariant GenericProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'genericProvider.overrideWith(...)'; -} - /// See also [generic]. -class GenericProvider extends StreamProvider> { +final class GenericProvider extends StreamProvider> { /// See also [generic]. GenericProvider() : this._internal( (ref) => generic( ref as GenericRef, ), - from: genericProvider, - name: r'genericProvider', + argument: (), + ); + + GenericProvider._internal( + super.create, { + required () super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$genericHash, + from: genericProvider, + name: r'genericProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - GenericProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); - - @override - Override overrideWith( - Stream> Function(GenericRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: GenericProvider._internal( - (ref) => create(ref as GenericRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), - ); - } - - @override - () get argument { - return (); - } - @override _GenericProviderElement createElement( ProviderContainer container, @@ -143,31 +94,26 @@ class GenericProvider extends StreamProvider> { return _GenericProviderElement(this, container); } - GenericProvider _copyWith( + @internal + @override + GenericProvider copyWithCreate( Stream> Function(GenericRef ref) create, ) { return GenericProvider._internal( (ref) => create(ref as GenericRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, + argument: argument as (), ); } @override bool operator ==(Object other) { - return other is GenericProvider && other.runtimeType == runtimeType; + return other is GenericProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, T.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'genericProvider<$T>$argument'; @@ -221,7 +167,7 @@ String _$familyHash() => r'6896fac2f6e3ccd7c38ecaa0d538cbd3577936b2'; const familyProvider = FamilyFamily(); /// See also [family]. -class FamilyFamily extends Family { +final class FamilyFamily extends Family { /// See also [family]. const FamilyFamily() : super( @@ -256,37 +202,12 @@ class FamilyFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(Stream Function(FamilyRef ref) create) { - return _$FamilyFamilyOverride(this, create); - } - @override String toString() => 'familyProvider'; } -class _$FamilyFamilyOverride implements FamilyOverride { - _$FamilyFamilyOverride(this.from, this.create); - - final Stream Function(FamilyRef ref) create; - - @override - final FamilyFamily from; - - @override - _FamilyProviderElement createElement( - ProviderContainer container, - covariant FamilyProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'familyProvider.overrideWith(...)'; -} - /// See also [family]. -class FamilyProvider extends StreamProvider { +final class FamilyProvider extends StreamProvider { /// See also [family]. FamilyProvider( int first, { @@ -303,80 +224,37 @@ class FamilyProvider extends StreamProvider { fourth: fourth, fifth: fifth, ), - from: familyProvider, - name: r'familyProvider', + argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), + ); + + FamilyProvider._internal( + super.create, { + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$familyHash, + from: familyProvider, + name: r'familyProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, ); - FamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.first, - required this.second, - required this.third, - required this.fourth, - required this.fifth, - }) : super.internal(); - - final int first; - final String? second; - final double third; - final bool fourth; - final List? fifth; - - @override - Override overrideWith( - Stream Function(FamilyRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: FamilyProvider._internal( - (ref) => create(ref as FamilyRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - ); - } - - @override - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) get argument { - return ( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ); - } - @override _FamilyProviderElement createElement( ProviderContainer container, @@ -384,45 +262,30 @@ class FamilyProvider extends StreamProvider { return _FamilyProviderElement(this, container); } - FamilyProvider _copyWith( + @internal + @override + FamilyProvider copyWithCreate( Stream Function(FamilyRef ref) create, ) { return FamilyProvider._internal( (ref) => create(ref as FamilyRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, + argument: argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), ); } @override bool operator ==(Object other) { - return other is FamilyProvider && - other.first == first && - other.second == second && - other.third == third && - other.fourth == fourth && - other.fifth == fifth; + return other is FamilyProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, first.hashCode); - hash = _SystemHash.combine(hash, second.hashCode); - hash = _SystemHash.combine(hash, third.hashCode); - hash = _SystemHash.combine(hash, fourth.hashCode); - hash = _SystemHash.combine(hash, fifth.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'familyProvider$argument'; @@ -473,7 +336,7 @@ abstract class _$GenericClass const genericClassProvider = GenericClassFamily(); /// See also [GenericClass]. -class GenericClassFamily extends Family { +final class GenericClassFamily extends Family { /// See also [GenericClass]. const GenericClassFamily() : super( @@ -496,61 +359,35 @@ class GenericClassFamily extends Family { return GenericClassProvider(); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(GenericClass Function() create) { - return _$GenericClassFamilyOverride(this, create); - } - @override String toString() => 'genericClassProvider'; } -class _$GenericClassFamilyOverride implements FamilyOverride { - _$GenericClassFamilyOverride(this.from, this.create); - - final GenericClass Function() create; - - @override - final GenericClassFamily from; - - @override - _GenericClassProviderElement createElement( - ProviderContainer container, - covariant GenericClassProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'genericClassProvider.overrideWith(...)'; -} - /// See also [GenericClass]. -class GenericClassProvider +final class GenericClassProvider extends AutoDisposeStreamNotifierProviderImpl, List> { /// See also [GenericClass]. GenericClassProvider() : this._internal( GenericClass.new, - from: genericClassProvider, - name: r'genericClassProvider', + argument: (), + ); + + GenericClassProvider._internal( + super.create, { + required () super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$genericClassHash, + from: genericClassProvider, + name: r'genericClassProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - GenericClassProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); - @override Stream> runNotifierBuild( covariant GenericClass notifier, @@ -558,26 +395,16 @@ class GenericClassProvider return notifier.build(); } + @internal @override - Override overrideWith(GenericClass Function() create) { - return ProviderOverride( - origin: this, - providerOverride: GenericClassProvider._internal( - () => create(), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), + AutoDisposeStreamNotifierProviderImpl copyWithBuild( + GenericClass Function() create, + ) { + return AutoDisposeStreamNotifierProviderImpl._internal( + create, ); } - @override - () get argument { - return (); - } - @override _GenericClassProviderElement createElement( ProviderContainer container, @@ -585,31 +412,26 @@ class GenericClassProvider return _GenericClassProviderElement(this, container); } - GenericClassProvider _copyWith( + @internal + @override + GenericClassProvider copyWithCreate( GenericClass Function() create, ) { return GenericClassProvider._internal( () => create(), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, + argument: argument as (), ); } @override bool operator ==(Object other) { - return other is GenericClassProvider && other.runtimeType == runtimeType; + return other is GenericClassProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, T.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'genericClassProvider<$T>$argument'; @@ -683,7 +505,7 @@ abstract class _$FamilyClass const familyClassProvider = FamilyClassFamily(); /// See also [FamilyClass]. -class FamilyClassFamily extends Family { +final class FamilyClassFamily extends Family { /// See also [FamilyClass]. const FamilyClassFamily() : super( @@ -718,37 +540,12 @@ class FamilyClassFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(FamilyClass Function() create) { - return _$FamilyClassFamilyOverride(this, create); - } - @override String toString() => 'familyClassProvider'; } -class _$FamilyClassFamilyOverride implements FamilyOverride { - _$FamilyClassFamilyOverride(this.from, this.create); - - final FamilyClass Function() create; - - @override - final FamilyClassFamily from; - - @override - _FamilyClassProviderElement createElement( - ProviderContainer container, - covariant FamilyClassProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'familyClassProvider.overrideWith(...)'; -} - /// See also [FamilyClass]. -class FamilyClassProvider +final class FamilyClassProvider extends AutoDisposeStreamNotifierProviderImpl { /// See also [FamilyClass]. FamilyClassProvider( @@ -764,41 +561,37 @@ class FamilyClassProvider ..third = third ..fourth = fourth ..fifth = fifth, - from: familyClassProvider, - name: r'familyClassProvider', + argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), + ); + + FamilyClassProvider._internal( + super.create, { + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$familyClassHash, + from: familyClassProvider, + name: r'familyClassProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, ); - FamilyClassProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.first, - required this.second, - required this.third, - required this.fourth, - required this.fifth, - }) : super.internal(); - - final int first; - final String? second; - final double third; - final bool fourth; - final List? fifth; - @override Stream runNotifierBuild( covariant FamilyClass notifier, @@ -812,41 +605,14 @@ class FamilyClassProvider ); } + @internal @override - Override overrideWith(FamilyClass Function() create) { - return ProviderOverride( - origin: this, - providerOverride: FamilyClassProvider._internal( - () => create() - ..first = first - ..second = second - ..third = third - ..fourth = fourth - ..fifth = fifth, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - ); - } - - @override - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) get argument { - return ( - first, + AutoDisposeStreamNotifierProviderImpl copyWithBuild( + FamilyClass Function() create, + ) { + return AutoDisposeStreamNotifierProviderImpl._internal( + create, + first: first, second: second, third: third, fourth: fourth, @@ -861,7 +627,9 @@ class FamilyClassProvider return _FamilyClassProviderElement(this, container); } - FamilyClassProvider _copyWith( + @internal + @override + FamilyClassProvider copyWithCreate( FamilyClass Function() create, ) { return FamilyClassProvider._internal( @@ -871,40 +639,23 @@ class FamilyClassProvider ..third = third ..fourth = fourth ..fifth = fifth, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, + argument: argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), ); } @override bool operator ==(Object other) { - return other is FamilyClassProvider && - other.first == first && - other.second == second && - other.third == third && - other.fourth == fourth && - other.fifth == fifth; + return other is FamilyClassProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, first.hashCode); - hash = _SystemHash.combine(hash, second.hashCode); - hash = _SystemHash.combine(hash, third.hashCode); - hash = _SystemHash.combine(hash, fourth.hashCode); - hash = _SystemHash.combine(hash, fifth.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'familyClassProvider$argument'; diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index b2b05565a..f91e3f78b 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -34,7 +34,7 @@ class _SystemHash { const genericProvider = GenericFamily(); /// See also [generic]. -class GenericFamily extends Family { +final class GenericFamily extends Family { /// See also [generic]. const GenericFamily() : super( @@ -57,85 +57,36 @@ class GenericFamily extends Family { return GenericProvider(); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith( - List Function(GenericRef ref) create) { - return _$GenericFamilyOverride(this, create); - } - @override String toString() => 'genericProvider'; } -class _$GenericFamilyOverride implements FamilyOverride { - _$GenericFamilyOverride(this.from, this.create); - - final List Function(GenericRef ref) create; - - @override - final GenericFamily from; - - @override - _GenericProviderElement createElement( - ProviderContainer container, - covariant GenericProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'genericProvider.overrideWith(...)'; -} - /// See also [generic]. -class GenericProvider extends Provider> { +final class GenericProvider extends Provider> { /// See also [generic]. GenericProvider() : this._internal( (ref) => generic( ref as GenericRef, ), - from: genericProvider, - name: r'genericProvider', + argument: (), + ); + + GenericProvider._internal( + super.create, { + required () super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$genericHash, + from: genericProvider, + name: r'genericProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - GenericProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); - - @override - Override overrideWith( - List Function(GenericRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: GenericProvider._internal( - (ref) => create(ref as GenericRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), - ); - } - - @override - () get argument { - return (); - } - @override _GenericProviderElement createElement( ProviderContainer container, @@ -143,31 +94,26 @@ class GenericProvider extends Provider> { return _GenericProviderElement(this, container); } - GenericProvider _copyWith( + @internal + @override + GenericProvider copyWithCreate( List Function(GenericRef ref) create, ) { return GenericProvider._internal( (ref) => create(ref as GenericRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, + argument: argument as (), ); } @override bool operator ==(Object other) { - return other is GenericProvider && other.runtimeType == runtimeType; + return other is GenericProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, T.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'genericProvider<$T>$argument'; @@ -187,7 +133,7 @@ String _$complexGenericHash() => r'a5254e5552cd61bb8d65c018539ff2d8edfd5822'; const complexGenericProvider = ComplexGenericFamily(); /// See also [complexGeneric]. -class ComplexGenericFamily extends Family { +final class ComplexGenericFamily extends Family { /// See also [complexGeneric]. const ComplexGenericFamily() : super( @@ -216,41 +162,12 @@ class ComplexGenericFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith( - List Function( - ComplexGenericRef ref) - create) { - return _$ComplexGenericFamilyOverride(this, create); - } - @override String toString() => 'complexGenericProvider'; } -class _$ComplexGenericFamilyOverride implements FamilyOverride { - _$ComplexGenericFamilyOverride(this.from, this.create); - - final List Function( - ComplexGenericRef ref) create; - - @override - final ComplexGenericFamily from; - - @override - _ComplexGenericProviderElement createElement( - ProviderContainer container, - covariant ComplexGenericProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'complexGenericProvider.overrideWith(...)'; -} - /// See also [complexGeneric]. -class ComplexGenericProvider +final class ComplexGenericProvider extends Provider> { /// See also [complexGeneric]. ComplexGenericProvider({ @@ -262,62 +179,31 @@ class ComplexGenericProvider param: param, otherParam: otherParam, ), - from: complexGenericProvider, - name: r'complexGenericProvider', + argument: ( + param: param, + otherParam: otherParam, + ), + ); + + ComplexGenericProvider._internal( + super.create, { + required ({ + T param, + Foo? otherParam, + }) + super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$complexGenericHash, + from: complexGenericProvider, + name: r'complexGenericProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - param: param, - otherParam: otherParam, ); - ComplexGenericProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.param, - required this.otherParam, - }) : super.internal(); - - final T param; - final Foo? otherParam; - - @override - Override overrideWith( - List Function(ComplexGenericRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: ComplexGenericProvider._internal( - (ref) => create(ref as ComplexGenericRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - param: param, - otherParam: otherParam, - ), - ); - } - - @override - ({ - T param, - Foo? otherParam, - }) get argument { - return ( - param: param, - otherParam: otherParam, - ); - } - @override _ComplexGenericProviderElement createElement( ProviderContainer container, @@ -325,19 +211,18 @@ class ComplexGenericProvider return _ComplexGenericProviderElement(this, container); } - ComplexGenericProvider _copyWith( + @internal + @override + ComplexGenericProvider copyWithCreate( List Function(ComplexGenericRef ref) create, ) { return ComplexGenericProvider._internal( (ref) => create(ref as ComplexGenericRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - param: param, - otherParam: otherParam, + argument: argument as ({ + T param, + Foo? otherParam, + }), ); } @@ -345,20 +230,11 @@ class ComplexGenericProvider bool operator ==(Object other) { return other is ComplexGenericProvider && other.runtimeType == runtimeType && - other.param == param && - other.otherParam == otherParam; + other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, param.hashCode); - hash = _SystemHash.combine(hash, otherParam.hashCode); - hash = _SystemHash.combine(hash, T.hashCode); - hash = _SystemHash.combine(hash, Foo.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'complexGenericProvider<$T,$Foo>$argument'; @@ -423,7 +299,7 @@ String _$rawFamilyFutureHash() => r'485f59512081852e51279658facc015309743864'; const rawFamilyFutureProvider = RawFamilyFutureFamily(); /// See also [rawFamilyFuture]. -class RawFamilyFutureFamily extends Family { +final class RawFamilyFutureFamily extends Family { /// See also [rawFamilyFuture]. const RawFamilyFutureFamily() : super( @@ -450,38 +326,12 @@ class RawFamilyFutureFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith( - Raw> Function(RawFamilyFutureRef ref) create) { - return _$RawFamilyFutureFamilyOverride(this, create); - } - @override String toString() => 'rawFamilyFutureProvider'; } -class _$RawFamilyFutureFamilyOverride implements FamilyOverride { - _$RawFamilyFutureFamilyOverride(this.from, this.create); - - final Raw> Function(RawFamilyFutureRef ref) create; - - @override - final RawFamilyFutureFamily from; - - @override - _RawFamilyFutureProviderElement createElement( - ProviderContainer container, - covariant RawFamilyFutureProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'rawFamilyFutureProvider.overrideWith(...)'; -} - /// See also [rawFamilyFuture]. -class RawFamilyFutureProvider extends Provider>> { +final class RawFamilyFutureProvider extends Provider>> { /// See also [rawFamilyFuture]. RawFamilyFutureProvider( int id, @@ -490,52 +340,24 @@ class RawFamilyFutureProvider extends Provider>> { ref as RawFamilyFutureRef, id, ), - from: rawFamilyFutureProvider, - name: r'rawFamilyFutureProvider', + argument: (id,), + ); + + RawFamilyFutureProvider._internal( + super.create, { + required (int,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$rawFamilyFutureHash, + from: rawFamilyFutureProvider, + name: r'rawFamilyFutureProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - id: id, ); - RawFamilyFutureProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.id, - }) : super.internal(); - - final int id; - - @override - Override overrideWith( - Raw> Function(RawFamilyFutureRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: RawFamilyFutureProvider._internal( - (ref) => create(ref as RawFamilyFutureRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - id: id, - ), - ); - } - - @override - (int,) get argument { - return (id,); - } - @override _RawFamilyFutureProviderElement createElement( ProviderContainer container, @@ -543,32 +365,24 @@ class RawFamilyFutureProvider extends Provider>> { return _RawFamilyFutureProviderElement(this, container); } - RawFamilyFutureProvider _copyWith( + @internal + @override + RawFamilyFutureProvider copyWithCreate( Raw> Function(RawFamilyFutureRef ref) create, ) { return RawFamilyFutureProvider._internal( (ref) => create(ref as RawFamilyFutureRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - id: id, + argument: argument as (int,), ); } @override bool operator ==(Object other) { - return other is RawFamilyFutureProvider && other.id == id; + return other is RawFamilyFutureProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, id.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'rawFamilyFutureProvider$argument'; @@ -594,7 +408,7 @@ String _$rawFamilyStreamHash() => r'e778e5cfcb8ab381e2412f5c73213aaa03b93012'; const rawFamilyStreamProvider = RawFamilyStreamFamily(); /// See also [rawFamilyStream]. -class RawFamilyStreamFamily extends Family { +final class RawFamilyStreamFamily extends Family { /// See also [rawFamilyStream]. const RawFamilyStreamFamily() : super( @@ -621,38 +435,12 @@ class RawFamilyStreamFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith( - Raw> Function(RawFamilyStreamRef ref) create) { - return _$RawFamilyStreamFamilyOverride(this, create); - } - @override String toString() => 'rawFamilyStreamProvider'; } -class _$RawFamilyStreamFamilyOverride implements FamilyOverride { - _$RawFamilyStreamFamilyOverride(this.from, this.create); - - final Raw> Function(RawFamilyStreamRef ref) create; - - @override - final RawFamilyStreamFamily from; - - @override - _RawFamilyStreamProviderElement createElement( - ProviderContainer container, - covariant RawFamilyStreamProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'rawFamilyStreamProvider.overrideWith(...)'; -} - /// See also [rawFamilyStream]. -class RawFamilyStreamProvider extends Provider>> { +final class RawFamilyStreamProvider extends Provider>> { /// See also [rawFamilyStream]. RawFamilyStreamProvider( int id, @@ -661,52 +449,24 @@ class RawFamilyStreamProvider extends Provider>> { ref as RawFamilyStreamRef, id, ), - from: rawFamilyStreamProvider, - name: r'rawFamilyStreamProvider', + argument: (id,), + ); + + RawFamilyStreamProvider._internal( + super.create, { + required (int,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$rawFamilyStreamHash, + from: rawFamilyStreamProvider, + name: r'rawFamilyStreamProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - id: id, ); - RawFamilyStreamProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.id, - }) : super.internal(); - - final int id; - - @override - Override overrideWith( - Raw> Function(RawFamilyStreamRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: RawFamilyStreamProvider._internal( - (ref) => create(ref as RawFamilyStreamRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - id: id, - ), - ); - } - - @override - (int,) get argument { - return (id,); - } - @override _RawFamilyStreamProviderElement createElement( ProviderContainer container, @@ -714,32 +474,24 @@ class RawFamilyStreamProvider extends Provider>> { return _RawFamilyStreamProviderElement(this, container); } - RawFamilyStreamProvider _copyWith( + @internal + @override + RawFamilyStreamProvider copyWithCreate( Raw> Function(RawFamilyStreamRef ref) create, ) { return RawFamilyStreamProvider._internal( (ref) => create(ref as RawFamilyStreamRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - id: id, + argument: argument as (int,), ); } @override bool operator ==(Object other) { - return other is RawFamilyStreamProvider && other.id == id; + return other is RawFamilyStreamProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, id.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'rawFamilyStreamProvider$argument'; @@ -806,7 +558,7 @@ const familyProvider = FamilyFamily(); /// This is some documentation /// /// Copied from [family]. -class FamilyFamily extends Family { +final class FamilyFamily extends Family { /// This is some documentation /// /// Copied from [family]. @@ -845,39 +597,14 @@ class FamilyFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(String Function(FamilyRef ref) create) { - return _$FamilyFamilyOverride(this, create); - } - @override String toString() => 'familyProvider'; } -class _$FamilyFamilyOverride implements FamilyOverride { - _$FamilyFamilyOverride(this.from, this.create); - - final String Function(FamilyRef ref) create; - - @override - final FamilyFamily from; - - @override - _FamilyProviderElement createElement( - ProviderContainer container, - covariant FamilyProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'familyProvider.overrideWith(...)'; -} - /// This is some documentation /// /// Copied from [family]. -class FamilyProvider extends Provider { +final class FamilyProvider extends Provider { /// This is some documentation /// /// Copied from [family]. @@ -896,80 +623,37 @@ class FamilyProvider extends Provider { fourth: fourth, fifth: fifth, ), - from: familyProvider, - name: r'familyProvider', + argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), + ); + + FamilyProvider._internal( + super.create, { + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$familyHash, + from: familyProvider, + name: r'familyProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, ); - FamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.first, - required this.second, - required this.third, - required this.fourth, - required this.fifth, - }) : super.internal(); - - final int first; - final String? second; - final double third; - final bool fourth; - final List? fifth; - - @override - Override overrideWith( - String Function(FamilyRef ref) create, - ) { - return ProviderOverride( - origin: this, - providerOverride: FamilyProvider._internal( - (ref) => create(ref as FamilyRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - ); - } - - @override - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) get argument { - return ( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ); - } - @override _FamilyProviderElement createElement( ProviderContainer container, @@ -977,45 +661,30 @@ class FamilyProvider extends Provider { return _FamilyProviderElement(this, container); } - FamilyProvider _copyWith( + @internal + @override + FamilyProvider copyWithCreate( String Function(FamilyRef ref) create, ) { return FamilyProvider._internal( (ref) => create(ref as FamilyRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, + argument: argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), ); } @override bool operator ==(Object other) { - return other is FamilyProvider && - other.first == first && - other.second == second && - other.third == third && - other.fourth == fourth && - other.fifth == fifth; + return other is FamilyProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, first.hashCode); - hash = _SystemHash.combine(hash, second.hashCode); - hash = _SystemHash.combine(hash, third.hashCode); - hash = _SystemHash.combine(hash, fourth.hashCode); - hash = _SystemHash.combine(hash, fifth.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'familyProvider$argument'; @@ -1099,7 +768,7 @@ abstract class _$GenericClass const genericClassProvider = GenericClassFamily(); /// See also [GenericClass]. -class GenericClassFamily extends Family { +final class GenericClassFamily extends Family { /// See also [GenericClass]. const GenericClassFamily() : super( @@ -1122,61 +791,35 @@ class GenericClassFamily extends Family { return GenericClassProvider(); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(GenericClass Function() create) { - return _$GenericClassFamilyOverride(this, create); - } - @override String toString() => 'genericClassProvider'; } -class _$GenericClassFamilyOverride implements FamilyOverride { - _$GenericClassFamilyOverride(this.from, this.create); - - final GenericClass Function() create; - - @override - final GenericClassFamily from; - - @override - _GenericClassProviderElement createElement( - ProviderContainer container, - covariant GenericClassProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'genericClassProvider.overrideWith(...)'; -} - /// See also [GenericClass]. -class GenericClassProvider +final class GenericClassProvider extends AutoDisposeNotifierProviderImpl, List> { /// See also [GenericClass]. GenericClassProvider() : this._internal( GenericClass.new, - from: genericClassProvider, - name: r'genericClassProvider', + argument: (), + ); + + GenericClassProvider._internal( + super.create, { + required () super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$genericClassHash, + from: genericClassProvider, + name: r'genericClassProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - GenericClassProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); - @override List runNotifierBuild( covariant GenericClass notifier, @@ -1184,26 +827,16 @@ class GenericClassProvider return notifier.build(); } + @internal @override - Override overrideWith(GenericClass Function() create) { - return ProviderOverride( - origin: this, - providerOverride: GenericClassProvider._internal( - () => create(), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), + AutoDisposeNotifierProviderImpl copyWithBuild( + GenericClass Function() create, + ) { + return AutoDisposeNotifierProviderImpl._internal( + create, ); } - @override - () get argument { - return (); - } - @override _GenericClassProviderElement createElement( ProviderContainer container, @@ -1211,31 +844,26 @@ class GenericClassProvider return _GenericClassProviderElement(this, container); } - GenericClassProvider _copyWith( + @internal + @override + GenericClassProvider copyWithCreate( GenericClass Function() create, ) { return GenericClassProvider._internal( () => create(), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, + argument: argument as (), ); } @override bool operator ==(Object other) { - return other is GenericClassProvider && other.runtimeType == runtimeType; + return other is GenericClassProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, T.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'genericClassProvider<$T>$argument'; @@ -1304,7 +932,7 @@ abstract class _$RawFamilyFutureClass const rawFamilyFutureClassProvider = RawFamilyFutureClassFamily(); /// See also [RawFamilyFutureClass]. -class RawFamilyFutureClassFamily extends Family { +final class RawFamilyFutureClassFamily extends Family { /// See also [RawFamilyFutureClass]. const RawFamilyFutureClassFamily() : super( @@ -1331,66 +959,37 @@ class RawFamilyFutureClassFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(RawFamilyFutureClass Function() create) { - return _$RawFamilyFutureClassFamilyOverride(this, create); - } - @override String toString() => 'rawFamilyFutureClassProvider'; } -class _$RawFamilyFutureClassFamilyOverride implements FamilyOverride { - _$RawFamilyFutureClassFamilyOverride(this.from, this.create); - - final RawFamilyFutureClass Function() create; - - @override - final RawFamilyFutureClassFamily from; - - @override - _RawFamilyFutureClassProviderElement createElement( - ProviderContainer container, - covariant RawFamilyFutureClassProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'rawFamilyFutureClassProvider.overrideWith(...)'; -} - /// See also [RawFamilyFutureClass]. -class RawFamilyFutureClassProvider extends AutoDisposeNotifierProviderImpl< - RawFamilyFutureClass, Raw>> { +final class RawFamilyFutureClassProvider + extends AutoDisposeNotifierProviderImpl>> { /// See also [RawFamilyFutureClass]. RawFamilyFutureClassProvider( int id, ) : this._internal( () => RawFamilyFutureClass()..id = id, - from: rawFamilyFutureClassProvider, - name: r'rawFamilyFutureClassProvider', + argument: (id,), + ); + + RawFamilyFutureClassProvider._internal( + super.create, { + required (int,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$rawFamilyFutureClassHash, + from: rawFamilyFutureClassProvider, + name: r'rawFamilyFutureClassProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - id: id, ); - RawFamilyFutureClassProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.id, - }) : super.internal(); - - final int id; - @override Raw> runNotifierBuild( covariant RawFamilyFutureClass notifier, @@ -1400,27 +999,17 @@ class RawFamilyFutureClassProvider extends AutoDisposeNotifierProviderImpl< ); } + @internal @override - Override overrideWith(RawFamilyFutureClass Function() create) { - return ProviderOverride( - origin: this, - providerOverride: RawFamilyFutureClassProvider._internal( - () => create()..id = id, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - id: id, - ), + AutoDisposeNotifierProviderImpl copyWithBuild( + RawFamilyFutureClass Function() create, + ) { + return AutoDisposeNotifierProviderImpl._internal( + create, + id: id, ); } - @override - (int,) get argument { - return (id,); - } - @override _RawFamilyFutureClassProviderElement createElement( ProviderContainer container, @@ -1428,32 +1017,24 @@ class RawFamilyFutureClassProvider extends AutoDisposeNotifierProviderImpl< return _RawFamilyFutureClassProviderElement(this, container); } - RawFamilyFutureClassProvider _copyWith( + @internal + @override + RawFamilyFutureClassProvider copyWithCreate( RawFamilyFutureClass Function() create, ) { return RawFamilyFutureClassProvider._internal( () => create()..id = id, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - id: id, + argument: argument as (int,), ); } @override bool operator ==(Object other) { - return other is RawFamilyFutureClassProvider && other.id == id; + return other is RawFamilyFutureClassProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, id.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'rawFamilyFutureClassProvider$argument'; @@ -1490,7 +1071,7 @@ abstract class _$RawFamilyStreamClass const rawFamilyStreamClassProvider = RawFamilyStreamClassFamily(); /// See also [RawFamilyStreamClass]. -class RawFamilyStreamClassFamily extends Family { +final class RawFamilyStreamClassFamily extends Family { /// See also [RawFamilyStreamClass]. const RawFamilyStreamClassFamily() : super( @@ -1517,66 +1098,37 @@ class RawFamilyStreamClassFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(RawFamilyStreamClass Function() create) { - return _$RawFamilyStreamClassFamilyOverride(this, create); - } - @override String toString() => 'rawFamilyStreamClassProvider'; } -class _$RawFamilyStreamClassFamilyOverride implements FamilyOverride { - _$RawFamilyStreamClassFamilyOverride(this.from, this.create); - - final RawFamilyStreamClass Function() create; - - @override - final RawFamilyStreamClassFamily from; - - @override - _RawFamilyStreamClassProviderElement createElement( - ProviderContainer container, - covariant RawFamilyStreamClassProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'rawFamilyStreamClassProvider.overrideWith(...)'; -} - /// See also [RawFamilyStreamClass]. -class RawFamilyStreamClassProvider extends AutoDisposeNotifierProviderImpl< - RawFamilyStreamClass, Raw>> { +final class RawFamilyStreamClassProvider + extends AutoDisposeNotifierProviderImpl>> { /// See also [RawFamilyStreamClass]. RawFamilyStreamClassProvider( int id, ) : this._internal( () => RawFamilyStreamClass()..id = id, - from: rawFamilyStreamClassProvider, - name: r'rawFamilyStreamClassProvider', + argument: (id,), + ); + + RawFamilyStreamClassProvider._internal( + super.create, { + required (int,) super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$rawFamilyStreamClassHash, + from: rawFamilyStreamClassProvider, + name: r'rawFamilyStreamClassProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - id: id, ); - RawFamilyStreamClassProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.id, - }) : super.internal(); - - final int id; - @override Raw> runNotifierBuild( covariant RawFamilyStreamClass notifier, @@ -1586,27 +1138,17 @@ class RawFamilyStreamClassProvider extends AutoDisposeNotifierProviderImpl< ); } + @internal @override - Override overrideWith(RawFamilyStreamClass Function() create) { - return ProviderOverride( - origin: this, - providerOverride: RawFamilyStreamClassProvider._internal( - () => create()..id = id, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - id: id, - ), + AutoDisposeNotifierProviderImpl copyWithBuild( + RawFamilyStreamClass Function() create, + ) { + return AutoDisposeNotifierProviderImpl._internal( + create, + id: id, ); } - @override - (int,) get argument { - return (id,); - } - @override _RawFamilyStreamClassProviderElement createElement( ProviderContainer container, @@ -1614,32 +1156,24 @@ class RawFamilyStreamClassProvider extends AutoDisposeNotifierProviderImpl< return _RawFamilyStreamClassProviderElement(this, container); } - RawFamilyStreamClassProvider _copyWith( + @internal + @override + RawFamilyStreamClassProvider copyWithCreate( RawFamilyStreamClass Function() create, ) { return RawFamilyStreamClassProvider._internal( () => create()..id = id, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - id: id, + argument: argument as (int,), ); } @override bool operator ==(Object other) { - return other is RawFamilyStreamClassProvider && other.id == id; + return other is RawFamilyStreamClassProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, id.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'rawFamilyStreamClassProvider$argument'; @@ -1722,7 +1256,7 @@ const familyClassProvider = FamilyClassFamily(); /// This is some documentation /// /// Copied from [FamilyClass]. -class FamilyClassFamily extends Family { +final class FamilyClassFamily extends Family { /// This is some documentation /// /// Copied from [FamilyClass]. @@ -1761,39 +1295,14 @@ class FamilyClassFamily extends Family { ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(FamilyClass Function() create) { - return _$FamilyClassFamilyOverride(this, create); - } - @override String toString() => 'familyClassProvider'; } -class _$FamilyClassFamilyOverride implements FamilyOverride { - _$FamilyClassFamilyOverride(this.from, this.create); - - final FamilyClass Function() create; - - @override - final FamilyClassFamily from; - - @override - _FamilyClassProviderElement createElement( - ProviderContainer container, - covariant FamilyClassProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'familyClassProvider.overrideWith(...)'; -} - /// This is some documentation /// /// Copied from [FamilyClass]. -class FamilyClassProvider +final class FamilyClassProvider extends AutoDisposeNotifierProviderImpl { /// This is some documentation /// @@ -1811,41 +1320,37 @@ class FamilyClassProvider ..third = third ..fourth = fourth ..fifth = fifth, - from: familyClassProvider, - name: r'familyClassProvider', + argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), + ); + + FamilyClassProvider._internal( + super.create, { + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, + }) : super.internal( debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') ? null : _$familyClassHash, + from: familyClassProvider, + name: r'familyClassProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, ); - FamilyClassProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.first, - required this.second, - required this.third, - required this.fourth, - required this.fifth, - }) : super.internal(); - - final int first; - final String? second; - final double third; - final bool fourth; - final List? fifth; - @override String runNotifierBuild( covariant FamilyClass notifier, @@ -1859,41 +1364,14 @@ class FamilyClassProvider ); } + @internal @override - Override overrideWith(FamilyClass Function() create) { - return ProviderOverride( - origin: this, - providerOverride: FamilyClassProvider._internal( - () => create() - ..first = first - ..second = second - ..third = third - ..fourth = fourth - ..fifth = fifth, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - ); - } - - @override - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) get argument { - return ( - first, + AutoDisposeNotifierProviderImpl copyWithBuild( + FamilyClass Function() create, + ) { + return AutoDisposeNotifierProviderImpl._internal( + create, + first: first, second: second, third: third, fourth: fourth, @@ -1908,7 +1386,9 @@ class FamilyClassProvider return _FamilyClassProviderElement(this, container); } - FamilyClassProvider _copyWith( + @internal + @override + FamilyClassProvider copyWithCreate( FamilyClass Function() create, ) { return FamilyClassProvider._internal( @@ -1918,40 +1398,23 @@ class FamilyClassProvider ..third = third ..fourth = fourth ..fifth = fifth, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, + argument: argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), ); } @override bool operator ==(Object other) { - return other is FamilyClassProvider && - other.first == first && - other.second == second && - other.third == third && - other.fourth == fourth && - other.fifth == fifth; + return other is FamilyClassProvider && other.argument == argument; } @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, first.hashCode); - hash = _SystemHash.combine(hash, second.hashCode); - hash = _SystemHash.combine(hash, third.hashCode); - hash = _SystemHash.combine(hash, fourth.hashCode); - hash = _SystemHash.combine(hash, fifth.hashCode); - - return _SystemHash.finish(hash); - } + int get hashCode => Object.hash(argument, runtimeType); @override String toString() => 'familyClassProvider$argument'; From bc4b64ec054077e3d78f31785dd0e84085f20c4c Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 2 Feb 2024 14:49:24 +0100 Subject: [PATCH 149/387] Work on codegen --- examples/pub/lib/detail.g.dart | 8 +- examples/pub/lib/search.g.dart | 4 +- .../legacy/change_notifier_provider.dart | 4 +- packages/riverpod/lib/riverpod.dart | 8 +- packages/riverpod/lib/src/core/family.dart | 8 +- .../lib/src/core/modifiers/future.dart | 5 +- packages/riverpod/lib/src/core/override.dart | 27 +- .../core/provider/functional_provider.dart | 13 +- .../src/core/provider/notifier_provider.dart | 4 +- .../lib/src/core/provider_container.dart | 2 +- .../lib/src/providers/async_notifier.dart | 2 +- .../lib/src/providers/future_provider.dart | 33 +- .../legacy/state_notifier_provider.dart | 2 +- .../src/providers/legacy/state_provider.dart | 2 +- .../riverpod/lib/src/providers/provider.dart | 4 +- .../lib/src/providers/stream_notifier.dart | 2 +- .../lib/src/providers/stream_provider.dart | 8 +- packages/riverpod/test/meta_test.dart | 1 + packages/riverpod/test/new/matrix.dart | 2 +- .../generator_provider_declaration.dart | 3 +- .../lib/riverpod_annotation.dart | 53 +- packages/riverpod_annotation/pubspec.yaml | 2 +- .../integration/build_yaml/lib/main.g.dart | 24 +- .../lib/src/riverpod_generator.dart | 118 +- .../lib/src/templates/family.dart | 372 +---- .../lib/src/templates/family_back.dart | 426 +++++ .../lib/src/templates/hash.dart | 17 + .../lib/src/templates/parameters.dart | 9 +- .../lib/src/templates/provider.dart | 174 ++ .../lib/src/templates/provider_variable.dart | 31 + .../lib/src/templates/ref.dart | 21 + packages/riverpod_generator/lib/src/type.dart | 22 + packages/riverpod_generator/pubspec.yaml | 4 +- .../test/integration/annotated.dart | 66 +- .../test/integration/annotated.g.dart | 330 ---- .../test/integration/async.dart | 3 +- .../test/integration/async.g.dart | 1032 +++--------- .../test/integration/auto_dispose.dart | 22 +- .../test/integration/auto_dispose.g.dart | 43 - .../test/integration/dependencies.dart | 98 +- .../test/integration/dependencies.g.dart | 697 -------- .../test/integration/dependencies2.dart | 52 +- .../test/integration/dependencies2.g.dart | 412 ----- .../test/integration/generated.dart | 166 +- .../test/integration/generated.freezed.dart | 74 - .../test/integration/generated.g.dart | 984 ----------- .../test/integration/hash/hash1.g.dart | 145 +- .../test/integration/scopes.dart | 2 +- .../test/integration/scopes.g.dart | 30 - .../test/integration/split.dart | 12 +- .../test/integration/split.g.dart | 44 - .../test/integration/split2.dart | 6 +- .../test/integration/stream.dart | 138 +- .../test/integration/stream.g.dart | 698 -------- .../test/integration/sync.dart | 352 ++-- .../test/integration/sync.g.dart | 1478 ----------------- .../generated/golden/lib/sync.g.dart | 8 +- ..._class_based_provider_to_functional.g.dart | 8 +- ..._functional_provider_to_class_based.g.dart | 4 +- .../avoid_build_context_in_providers.g.dart | 8 +- .../avoid_public_notifier_properties.g.dart | 4 +- .../test/lints/dependencies.g.dart | 8 +- .../functional_ref/functional_ref.g.dart | 16 +- .../protected_notifier_properties.g.dart | 24 +- .../test/lints/provider_parameters.g.dart | 4 +- .../docs/concepts/about_codegen/main.g.dart | 4 +- .../about_codegen/provider_type/family.g.dart | 4 +- .../provider_type/family_class.g.dart | 4 +- .../provider_type/family_fn.g.dart | 4 +- .../invalidate_family_example/codegen.g.dart | 4 +- .../passing_args/codegen/family.g.dart | 4 +- .../passing_args/codegen/provider.g.dart | 4 +- .../docs/from_provider/family/family.g.dart | 4 +- .../introduction/why_riverpod/codegen.g.dart | 4 +- .../family_and_dispose.g.dart | 4 +- .../current/about_codegen/main.g.dart | 4 +- .../current/about_codegen/main.g.dart | 4 +- .../current/about_codegen/main.g.dart | 4 +- .../current/about_codegen/main.g.dart | 4 +- 79 files changed, 1749 insertions(+), 6690 deletions(-) create mode 100644 packages/riverpod_generator/lib/src/templates/family_back.dart create mode 100644 packages/riverpod_generator/lib/src/templates/hash.dart create mode 100644 packages/riverpod_generator/lib/src/templates/provider.dart create mode 100644 packages/riverpod_generator/lib/src/templates/provider_variable.dart create mode 100644 packages/riverpod_generator/lib/src/templates/ref.dart create mode 100644 packages/riverpod_generator/lib/src/type.dart delete mode 100644 packages/riverpod_generator/test/integration/annotated.g.dart delete mode 100644 packages/riverpod_generator/test/integration/auto_dispose.g.dart delete mode 100644 packages/riverpod_generator/test/integration/dependencies.g.dart delete mode 100644 packages/riverpod_generator/test/integration/dependencies2.g.dart delete mode 100644 packages/riverpod_generator/test/integration/generated.freezed.dart delete mode 100644 packages/riverpod_generator/test/integration/generated.g.dart delete mode 100644 packages/riverpod_generator/test/integration/scopes.g.dart delete mode 100644 packages/riverpod_generator/test/integration/split.g.dart delete mode 100644 packages/riverpod_generator/test/integration/stream.g.dart delete mode 100644 packages/riverpod_generator/test/integration/sync.g.dart diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 33cf0e3a2..240845577 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -74,7 +74,7 @@ class FetchPackageDetailsFamily extends Family { String toString() => 'fetchPackageDetailsProvider'; } -class _$FetchPackageDetailsFamilyOverride implements FamilyOverride { +class _$FetchPackageDetailsFamilyOverride implements $FamilyOverride { _$FetchPackageDetailsFamilyOverride(this.from, this.create); final FutureOr Function(FetchPackageDetailsRef ref) create; @@ -131,7 +131,7 @@ class FetchPackageDetailsProvider extends AutoDisposeFutureProvider { Override overrideWith( FutureOr Function(FetchPackageDetailsRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: FetchPackageDetailsProvider._internal( (ref) => create(ref as FetchPackageDetailsRef), @@ -311,7 +311,7 @@ class PackageMetricsFamily extends Family { String toString() => 'packageMetricsProvider'; } -class _$PackageMetricsFamilyOverride implements FamilyOverride { +class _$PackageMetricsFamilyOverride implements $FamilyOverride { _$PackageMetricsFamilyOverride(this.from, this.create); final PackageMetrics Function() create; @@ -385,7 +385,7 @@ class PackageMetricsProvider extends AutoDisposeAsyncNotifierProviderImpl< @override Override overrideWith(PackageMetrics Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: PackageMetricsProvider._internal( () => create()..packageName = packageName, diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index c93d95448..1914ec9d7 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -75,7 +75,7 @@ class FetchPackagesFamily extends Family { String toString() => 'fetchPackagesProvider'; } -class _$FetchPackagesFamilyOverride implements FamilyOverride { +class _$FetchPackagesFamilyOverride implements $FamilyOverride { _$FetchPackagesFamilyOverride(this.from, this.create); final FutureOr> Function(FetchPackagesRef ref) create; @@ -137,7 +137,7 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { Override overrideWith( FutureOr> Function(FetchPackagesRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: FetchPackagesProvider._internal( (ref) => create(ref as FetchPackagesRef), 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 index b306ef0dc..425a00309 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -89,7 +89,7 @@ abstract class ChangeNotifierProviderRef /// } /// ``` final class ChangeNotifierProvider - extends FunctionalProvider> { /// {@macro riverpod.change_notifier_provider} ChangeNotifierProvider( @@ -255,7 +255,7 @@ class ChangeNotifierProviderFamily NotifierT Function(ChangeNotifierProviderRef ref, Arg arg) create, ) { - return FamilyOverride( + return $FamilyOverride( from: this, createElement: (container, provider) { provider as ChangeNotifierProvider; diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index ff97ed560..1738b0aa9 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -13,11 +13,11 @@ export 'src/framework.dart' ValueProvider, FamilyCreate, FunctionalFamily, - FamilyOverride, + $FamilyOverride, ClassFamily, SetupFamilyOverride, SetupOverride, - ProviderOverride, + $ProviderOverride, DebugGetCreateSourceHash, ClassProviderFactory, FunctionalProviderFactory, @@ -34,14 +34,14 @@ export 'src/framework.dart' ProviderPointerManager, ProviderDirectory, AsyncClassMixin, - FutureModifier, + $FutureModifier, ProviderElementBase, ClassBaseX, CancelAsyncSubscription, ClassBase, FutureModifierElement, RunNotifierBuild, - FunctionalProvider, + $FunctionalProvider, ClassProvider; export 'src/providers/async_notifier.dart' hide AsyncNotifierBase, AsyncNotifierProviderBase; diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index e8b8c9204..981c17cbc 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -79,7 +79,7 @@ class FunctionalFamily< // StateT, ArgT, CreatedT, - ProviderT extends FunctionalProvider> + ProviderT extends $FunctionalProvider> extends Family { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. @@ -125,7 +125,7 @@ class FunctionalFamily< // Override overrideWith( CreatedT Function(RefT ref, ArgT arg) create, ) { - return FamilyOverride( + return $FamilyOverride( from: this, createElement: (container, provider) { provider as ProviderT; @@ -195,7 +195,7 @@ class ClassFamily< // /// {@macro riverpod.override_with} Override overrideWith(NotifierT Function() create) { - return FamilyOverride( + return $FamilyOverride( from: this, createElement: (container, provider) { provider as ProviderT; @@ -209,7 +209,7 @@ class ClassFamily< // Override overrideWithBuild( RunNotifierBuild build, ) { - return FamilyOverride( + return $FamilyOverride( from: this, createElement: (container, provider) { provider as ProviderT; diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 47c31cd30..371a34699 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -108,8 +108,9 @@ mixin AsyncClassMixin } } -@internal -base mixin FutureModifier on ProviderBase> { +/// Implementation detail for `riverpod_generator`. +/// Do not use. +base mixin $FutureModifier on ProviderBase> { /// Obtains the [Future] representing this provider. /// /// The instance of [Future] obtained may change over time. This typically diff --git a/packages/riverpod/lib/src/core/override.dart b/packages/riverpod/lib/src/core/override.dart index 6441e89dd..fe93f493a 100644 --- a/packages/riverpod/lib/src/core/override.dart +++ b/packages/riverpod/lib/src/core/override.dart @@ -14,7 +14,7 @@ extension on _ProviderOverride { final that = this; return switch (that) { ProviderBase() => that, - ProviderOverride() => that.origin, + $ProviderOverride() => that.origin, }; } @@ -23,7 +23,7 @@ extension on _ProviderOverride { final that = this; return switch (that) { ProviderBase() => that, - ProviderOverride() => that.providerOverride, + $ProviderOverride() => that.providerOverride, }; } } @@ -36,7 +36,7 @@ extension on _FamilyOverride { final that = this; return switch (that) { Family() => that, - FamilyOverride() => that.from, + $FamilyOverride() => that.from, }; } } @@ -44,15 +44,15 @@ extension on _FamilyOverride { /// An object used by [ProviderContainer] to override the behavior of a provider /// for a part of the application. /// -/// Do not implement/extend this class. +/// Do not use. /// /// See also: /// /// - [ProviderContainer], which uses this object. -/// - `overrideWithValue`, which creates a [ProviderOverride]. -class ProviderOverride implements _ProviderOverride { +/// - `overrideWithValue`, which creates a [$ProviderOverride]. +class $ProviderOverride implements _ProviderOverride { /// Override a provider - ProviderOverride({ + $ProviderOverride({ required this.origin, required this.providerOverride, }); @@ -77,7 +77,7 @@ class ProviderOverride implements _ProviderOverride { /// When a provider is automatically scoped due to specifying `dependencies`. @internal -class TransitiveProviderOverride implements ProviderOverride { +class TransitiveProviderOverride implements $ProviderOverride { TransitiveProviderOverride(this.origin); @override @@ -92,9 +92,10 @@ class TransitiveProviderOverride implements ProviderOverride { /// Do not use: Internal object to used by [ProviderContainer]/`ProviderScope` /// to override the behavior of a "family" for part of the application. -@internal -abstract class FamilyOverride implements _FamilyOverride { - factory FamilyOverride({ +abstract class $FamilyOverride implements _FamilyOverride { + /// Do not use: Internal object to used by [ProviderContainer]/`ProviderScope` + /// to override the behavior of a "family" for part of the application. + factory $FamilyOverride({ required ProviderElementBase Function( ProviderContainer container, ProviderBase provider, @@ -117,7 +118,7 @@ abstract class FamilyOverride implements _FamilyOverride { } @internal -class TransitiveFamilyOverride implements FamilyOverride { +class TransitiveFamilyOverride implements $FamilyOverride { TransitiveFamilyOverride(this.from); @override @@ -136,7 +137,7 @@ class TransitiveFamilyOverride implements FamilyOverride { } /// An [Override] for families -class _FamilyOverrideImpl implements FamilyOverride { +class _FamilyOverrideImpl implements $FamilyOverride { /// An [Override] for families // ignore: library_private_types_in_public_api _FamilyOverrideImpl({ diff --git a/packages/riverpod/lib/src/core/provider/functional_provider.dart b/packages/riverpod/lib/src/core/provider/functional_provider.dart index 24f8872e2..fd4f8cb5b 100644 --- a/packages/riverpod/lib/src/core/provider/functional_provider.dart +++ b/packages/riverpod/lib/src/core/provider/functional_provider.dart @@ -1,12 +1,15 @@ part of '../../framework.dart'; -@internal -abstract base class FunctionalProvider< // +/// Implementation detail of `riverpod_generator`. +/// Do not use, as this can be removed at any time. +abstract base class $FunctionalProvider< // StateT, CreatedT, RefT extends Ref> // extends ProviderBase { - const FunctionalProvider({ + /// Implementation detail of `riverpod_generator`. + /// Do not use, as this can be removed at any time. + const $FunctionalProvider({ required super.name, required super.from, required super.argument, @@ -17,7 +20,7 @@ abstract base class FunctionalProvider< // }); @visibleForOverriding - FunctionalProvider copyWithCreate( + $FunctionalProvider copyWithCreate( Create create, ); @@ -56,7 +59,7 @@ abstract base class FunctionalProvider< // /// ``` /// {@endtemplate} Override overrideWith(Create create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: copyWithCreate(create), ); diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index 95f37ba0c..09aa7c076 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -120,7 +120,7 @@ abstract base class ClassProvider< // /// {@macro riverpod.override_with} Override overrideWith(NotifierT Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: copyWithCreate(create), ); @@ -130,7 +130,7 @@ abstract base class ClassProvider< // Override overrideWithBuild( RunNotifierBuild build, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: copyWithBuild(build), ); diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index f97259689..8f72cdce1 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -171,7 +171,7 @@ class ProviderDirectory implements _PointerBase { override.providerOverride.createElement(pointer.targetContainer); // The family was overridden using overrideWith & co. - case (null, final FamilyOverride override): + case (null, final $FamilyOverride override): element = override.createElement(pointer.targetContainer, origin); // Either the provider wasn't overridden or it was scoped. diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index bd9752927..b1d3c6a52 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -28,7 +28,7 @@ abstract base class AsyncNotifierProviderBase< // FutureOr, Ref>> // with - FutureModifier { + $FutureModifier { const AsyncNotifierProviderBase( this._createNotifier, { required super.name, diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 8d8fdf767..6d38954ee 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -9,6 +9,12 @@ import 'async_notifier.dart'; import 'provider.dart' show Provider; import 'stream_provider.dart' show StreamProvider; +/// Implementation detail of `riverpod_generator`. +/// Do not use, as this may be removed at any time. +base mixin $FutureProvider on ProviderBase> { + FutureOr create(FutureProviderRef ref); +} + /// {@template riverpod.future_provider} /// A provider that asynchronously creates a value. /// @@ -77,8 +83,11 @@ import 'stream_provider.dart' show StreamProvider; /// - [FutureProvider.family], to create a [FutureProvider] from external parameters /// - [FutureProvider.autoDispose], to destroy the state of a [FutureProvider] when no longer needed. /// {@endtemplate} -base class FutureProvider extends FunctionalProvider, - FutureOr, FutureProviderRef> with FutureModifier { +final class FutureProvider extends $FunctionalProvider< + AsyncValue, FutureOr, FutureProviderRef> + with + $FutureModifier, + $FutureProvider> { /// {@macro riverpod.future_provider} FutureProvider( this._create, { @@ -125,12 +134,15 @@ base class FutureProvider extends FunctionalProvider, /// {@macro riverpod.family} static const family = FutureProviderFamilyBuilder(); - /// TODO make all "create" public, for the sake of dartdocs. + /// TODO add dartdoc on all create cbs. final Create, FutureProviderRef> _create; @override - FutureProviderElement createElement(ProviderContainer container) { - return FutureProviderElement(this, container); + FutureOr create(FutureProviderRef ref) => this._create(ref); + + @override + $FutureProviderElement createElement(ProviderContainer container) { + return $FutureProviderElement(this, container); } @mustBeOverridden @@ -163,16 +175,17 @@ abstract class FutureProviderRef implements Ref> { } /// The element of a [FutureProvider] -class FutureProviderElement +/// Implementation detail of `riverpod_generator`. Do not use. +class $FutureProviderElement extends ProviderElementBase> with FutureModifierElement implements FutureProviderRef { /// The element of a [FutureProvider] - @internal - FutureProviderElement(this.provider, super.container); + /// Implementation detail of `riverpod_generator`. Do not use. + $FutureProviderElement(this.provider, super.container); @override - final FutureProvider provider; + final $FutureProvider>> provider; @override Future get future { @@ -183,7 +196,7 @@ class FutureProviderElement @override void create({required bool didChangeDependency}) { handleFuture( - () => provider._create(this), + () => provider.create(this), didChangeDependency: didChangeDependency, ); } diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index f4cff717f..93b2b96b6 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -91,7 +91,7 @@ abstract class StateNotifierProviderRef, T> final class StateNotifierProvider< // NotifierT extends StateNotifier, StateT> // - extends FunctionalProvider< // + extends $FunctionalProvider< // StateT, NotifierT, StateNotifierProviderRef> { diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 9c6cab662..2ff538a75 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -56,7 +56,7 @@ abstract class StateProviderRef implements Ref { /// } /// ``` final class StateProvider - extends FunctionalProvider> { + extends $FunctionalProvider> { /// {@macro riverpod.stateprovider} StateProvider( this._createFn, { diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 5b4759a92..67103e359 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -9,7 +9,7 @@ import 'stream_provider.dart' show StreamProvider; // TODO changelog ProviderRef was removed. Used Ref directly /// {@macro riverpod.provider} base class Provider - extends FunctionalProvider> { + extends $FunctionalProvider> { /// {@macro riverpod.provider} // TODO make all providers const under all variations Provider( @@ -114,7 +114,7 @@ base class Provider /// ); /// ``` Override overrideWithValue(StateT value) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: ValueProvider(value), ); diff --git a/packages/riverpod/lib/src/providers/stream_notifier.dart b/packages/riverpod/lib/src/providers/stream_notifier.dart index c1bbece19..805f528dd 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier.dart @@ -27,7 +27,7 @@ abstract base class StreamNotifierProviderBase< Stream, Ref>> // with - FutureModifier { + $FutureModifier { const StreamNotifierProviderBase( this._createNotifier, { required super.name, diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index 7406389ba..7a6a8fbef 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -66,8 +66,10 @@ import 'provider.dart' show Provider; /// - [StreamProvider.family], to create a [StreamProvider] from external parameters /// - [StreamProvider.autoDispose], to destroy the state of a [StreamProvider] when no longer needed. /// {@endtemplate} -base class StreamProvider extends FunctionalProvider, - Stream, Ref>> with FutureModifier { +base class StreamProvider extends $FunctionalProvider< + AsyncValue, + Stream, + Ref>> with $FutureModifier { /// {@macro riverpod.stream_provider} StreamProvider( this._create, { @@ -126,7 +128,7 @@ base class StreamProvider extends FunctionalProvider, @mustBeOverridden @visibleForOverriding @override - FunctionalProvider, Stream, + $FunctionalProvider, Stream, Ref>> copyWithCreate( Create, Ref>> create, ) { diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index d95361388..09c6ab087 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -9,6 +9,7 @@ import 'package:test/test.dart'; void main() { // TODO verify that inherited members reapply annotations // TODO assert all ".notifier" and ".future" implement Refreshable + // TODO assert all constructor parameters point to a field with dartdoc. // This verifies that: // - All public APIs are documented diff --git a/packages/riverpod/test/new/matrix.dart b/packages/riverpod/test/new/matrix.dart index e995a6508..acaae71c7 100644 --- a/packages/riverpod/test/new/matrix.dart +++ b/packages/riverpod/test/new/matrix.dart @@ -48,7 +48,7 @@ extension $Modifiers on ProviderBase { Refreshable>? get future { final that = this; return switch (that) { - FutureModifier() => that.future, + $FutureModifier() => that.future, _ => null, }; } diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart index 09d84544f..09b99e3dd 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart @@ -57,7 +57,8 @@ extension on LibraryElement { } } -abstract class GeneratorProviderDeclaration extends ProviderDeclaration { +// TODO changelog made sealed +sealed class GeneratorProviderDeclaration extends ProviderDeclaration { @override GeneratorProviderDeclarationElement get providerElement; RiverpodAnnotation get annotation; diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index 1e244ac28..3e1ada1f6 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -7,15 +7,14 @@ export 'package:meta/meta.dart' show visibleForOverriding; export 'package:riverpod/src/internals.dart' show // General stuff - // TODO changelog exported ProviderContainer, + // TODO changelog changed exports, ProviderContainer, Family, ProviderOrFamily, Override, - // ignore: invalid_use_of_internal_member, Used by notifiers for overriding overrideWith - ProviderOverride, - // ignore: invalid_use_of_internal_member, used by families for overrideWith - FamilyOverride, + $FamilyOverride, + $FunctionalProvider, + $FutureModifier, Ref, // Provider @@ -24,33 +23,33 @@ export 'package:riverpod/src/internals.dart' ProviderElement, // FutureProvider - FutureProvider, - FutureProviderFamily, - FutureProviderRef, - FutureProviderElement, + $FutureProvider, + // FutureProviderFamily, + // FutureProviderRef, + $FutureProviderElement, - // StreamProvider - StreamProvider, - StreamProviderFamily, - StreamProviderElement, +// // StreamProvider +// StreamProvider, +// StreamProviderFamily, +// StreamProviderElement, - // AsyncValue +// AsyncValue AsyncValue, AsyncLoading, AsyncData, AsyncError, - AsyncValueX, - - // Notifier - Notifier, - // ignore: invalid_use_of_internal_member - NotifierProvider, - - // AsyncNotifier - AsyncNotifier, - AsyncNotifierProvider, - // StreamNotifier - StreamNotifier, - StreamNotifierProvider; + AsyncValueX; + +// // Notifier +// Notifier, +// // ignore: invalid_use_of_internal_member +// NotifierProvider, + +// // AsyncNotifier +// AsyncNotifier, +// AsyncNotifierProvider, +// // StreamNotifier +// StreamNotifier, +// StreamNotifierProvider; export 'src/riverpod_annotation.dart'; diff --git a/packages/riverpod_annotation/pubspec.yaml b/packages/riverpod_annotation/pubspec.yaml index b5c0c3658..520b6f0a9 100644 --- a/packages/riverpod_annotation/pubspec.yaml +++ b/packages/riverpod_annotation/pubspec.yaml @@ -11,7 +11,7 @@ environment: dependencies: meta: ^1.7.0 - riverpod: ^3.0.0-dev.3 + riverpod: 3.0.0-dev.3 dev_dependencies: test: ^1.21.0 diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index acb061de0..e6e698e75 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -112,7 +112,7 @@ class Count2Family extends Family { String toString() => 'count2ProviderFamily'; } -class _$Count2FamilyOverride implements FamilyOverride { +class _$Count2FamilyOverride implements $FamilyOverride { _$Count2FamilyOverride(this.from, this.create); final int Function(Count2Ref ref) create; @@ -169,7 +169,7 @@ class Count2Provider extends AutoDisposeProvider { Override overrideWith( int Function(Count2Ref ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: Count2Provider._internal( (ref) => create(ref as Count2Ref), @@ -282,7 +282,7 @@ class CountFuture2Family extends Family { String toString() => 'countFuture2ProviderFamily'; } -class _$CountFuture2FamilyOverride implements FamilyOverride { +class _$CountFuture2FamilyOverride implements $FamilyOverride { _$CountFuture2FamilyOverride(this.from, this.create); final FutureOr Function(CountFuture2Ref ref) create; @@ -339,7 +339,7 @@ class CountFuture2Provider extends AutoDisposeFutureProvider { Override overrideWith( FutureOr Function(CountFuture2Ref ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: CountFuture2Provider._internal( (ref) => create(ref as CountFuture2Ref), @@ -452,7 +452,7 @@ class CountStream2Family extends Family { String toString() => 'countStream2ProviderFamily'; } -class _$CountStream2FamilyOverride implements FamilyOverride { +class _$CountStream2FamilyOverride implements $FamilyOverride { _$CountStream2FamilyOverride(this.from, this.create); final Stream Function(CountStream2Ref ref) create; @@ -509,7 +509,7 @@ class CountStream2Provider extends AutoDisposeStreamProvider { Override overrideWith( Stream Function(CountStream2Ref ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: CountStream2Provider._internal( (ref) => create(ref as CountStream2Ref), @@ -680,7 +680,7 @@ class CountNotifier2Family extends Family { String toString() => 'countNotifier2ProviderFamily'; } -class _$CountNotifier2FamilyOverride implements FamilyOverride { +class _$CountNotifier2FamilyOverride implements $FamilyOverride { _$CountNotifier2FamilyOverride(this.from, this.create); final CountNotifier2 Function() create; @@ -742,7 +742,7 @@ class CountNotifier2Provider @override Override overrideWith(CountNotifier2 Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: CountNotifier2Provider._internal( () => create()..a = a, @@ -866,7 +866,7 @@ class CountAsyncNotifier2Family extends Family { String toString() => 'countAsyncNotifier2ProviderFamily'; } -class _$CountAsyncNotifier2FamilyOverride implements FamilyOverride { +class _$CountAsyncNotifier2FamilyOverride implements $FamilyOverride { _$CountAsyncNotifier2FamilyOverride(this.from, this.create); final CountAsyncNotifier2 Function() create; @@ -928,7 +928,7 @@ class CountAsyncNotifier2Provider @override Override overrideWith(CountAsyncNotifier2 Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: CountAsyncNotifier2Provider._internal( () => create()..a = a, @@ -1052,7 +1052,7 @@ class CountStreamNotifier2Family extends Family { String toString() => 'countStreamNotifier2ProviderFamily'; } -class _$CountStreamNotifier2FamilyOverride implements FamilyOverride { +class _$CountStreamNotifier2FamilyOverride implements $FamilyOverride { _$CountStreamNotifier2FamilyOverride(this.from, this.create); final CountStreamNotifier2 Function() create; @@ -1114,7 +1114,7 @@ class CountStreamNotifier2Provider @override Override overrideWith(CountStreamNotifier2 Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: CountStreamNotifier2Provider._internal( () => create()..a = a, diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index f7fd3434f..2998119f7 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -9,9 +9,11 @@ import 'package:source_gen/source_gen.dart'; import 'models.dart'; import 'parse_generator.dart'; -import 'templates/class_based_provider.dart'; import 'templates/family.dart'; -import 'templates/functional_provider.dart'; +import 'templates/hash.dart'; +import 'templates/provider.dart'; +import 'templates/provider_variable.dart'; +import 'templates/ref.dart'; const riverpodTypeChecker = TypeChecker.fromRuntime(Riverpod); @@ -37,19 +39,6 @@ String metaAnnotations(NodeList metadata) { return buffer.toString(); } -String _hashFn(GeneratorProviderDeclaration provider, String hashName) { - return "String $hashName() => r'${provider.computeProviderHash()}';"; -} - -String _hashFnName(ProviderDeclaration provider) { - return '_\$${provider.providerElement.name.public.lowerFirst}Hash'; -} - -String _hashFnIdentifier(String hashFnName) { - return "const bool.fromEnvironment('dart.vm.product') ? " - 'null : $hashFnName'; -} - const _defaultProviderNameSuffix = 'Provider'; /// May be thrown by generators during [Generator.generate]. @@ -95,9 +84,13 @@ class RiverpodGenerator extends ParserGenerator { // Only emit the header if we actually generated something if (buffer.isNotEmpty) { + buffer.writeln( + r"const $kDebugMode = bool.fromEnvironment('dart.vm.product');", + ); + buffer.write(''' // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package '''); } @@ -115,34 +108,12 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { String get familySuffix => options.providerFamilyNameSuffix ?? suffix; - var _didEmitHashUtils = false; - - void maybeEmitHashUtils() { - if (_didEmitHashUtils) return; - - _didEmitHashUtils = true; - buffer.write(''' -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} -'''); + void visitGeneratorProviderDeclaration( + GeneratorProviderDeclaration provider, + ) { + ProviderVariableTemplate(provider, options).run(buffer); + ProviderTemplate(provider).run(buffer); + HashFnTemplate(provider).run(buffer); } @override @@ -150,38 +121,7 @@ class _SystemHash { ClassBasedProviderDeclaration provider, ) { super.visitClassBasedProviderDeclaration(provider); - - final hashFunctionName = _hashFnName(provider); - final hashFn = _hashFnIdentifier(hashFunctionName); - buffer.write(_hashFn(provider, hashFunctionName)); - - if (!provider.providerElement.isFamily) { - final providerName = '${provider.providerElement.name.lowerFirst}$suffix'; - final notifierTypedefName = providerName.startsWith('_') - ? '_\$${provider.providerElement.name.substring(1)}' - : '_\$${provider.providerElement.name}'; - - ClassBasedProviderTemplate( - provider, - options: options, - notifierTypedefName: notifierTypedefName, - hashFn: hashFn, - ).run(buffer); - } else { - final providerName = - '${provider.providerElement.name.lowerFirst}$familySuffix'; - final notifierTypedefName = providerName.startsWith('_') - ? '_\$${provider.providerElement.name.substring(1)}' - : '_\$${provider.providerElement.name}'; - - maybeEmitHashUtils(); - FamilyTemplate.classBased( - provider, - options: options, - notifierTypedefName: notifierTypedefName, - hashFn: hashFn, - ).run(buffer); - } + visitGeneratorProviderDeclaration(provider); } @override @@ -189,28 +129,8 @@ class _SystemHash { FunctionalProviderDeclaration provider, ) { super.visitFunctionalProviderDeclaration(provider); - - final hashFunctionName = _hashFnName(provider); - final hashFn = _hashFnIdentifier(hashFunctionName); - buffer.write(_hashFn(provider, hashFunctionName)); - - // Using >1 as functional providers always have at least one parameter: ref - // So a provider is a "family" only if it has parameters besides the ref. - if (provider.providerElement.isFamily) { - maybeEmitHashUtils(); - FamilyTemplate.functional( - provider, - options: options, - hashFn: hashFn, - ).run(buffer); - } else { - final refName = '${provider.providerElement.name.titled}Ref'; - FunctionalProviderTemplate( - provider, - refName: refName, - options: options, - hashFn: hashFn, - ).run(buffer); - } + RefTemplate(provider).run(buffer); + FamilyTemplate(provider, options).run(buffer); + visitGeneratorProviderDeclaration(provider); } } diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 1e069fd5e..7c0383e8b 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -1,374 +1,56 @@ -import 'package:analyzer/dart/ast/ast.dart'; -import 'package:collection/collection.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import '../models.dart'; -import '../riverpod_generator.dart'; import 'class_based_provider.dart'; +import 'family_back.dart'; import 'parameters.dart'; import 'template.dart'; -String providerFamilyNameFor( - ProviderDeclarationElement provider, - BuildYamlOptions options, -) { - return '${provider.name.lowerFirst}${options.providerFamilyNameSuffix ?? options.providerNameSuffix ?? 'Provider'}'; -} - -String genericDefinitionDisplayString(TypeParameterList? typeParameters) { - return typeParameters?.toSource() ?? ''; -} - -String genericUsageDisplayString(TypeParameterList? typeParameterList) { - if (typeParameterList == null) { - return ''; - } - - return '<${typeParameterList.typeParameters.map((e) => e.name.lexeme).join(', ')}>'; -} - class FamilyTemplate extends Template { - FamilyTemplate._( - this.provider, { - required this.options, - required this.parameters, - required this.typeParameters, - required this.providerType, - required this.refType, - required this.elementType, - required this.providerGenerics, - required this.providerCreate, - required this.parametersPassThrough, - required this.hashFn, - required this.createType, - required this.overrideCreate, - this.other = '', - this.providerOther = '', - }) { - if (!provider.providerElement.isFamily) { - throw ArgumentError.value( - provider.providerElement.isFamily, - 'provider.providerElement.isFamily', - 'Expected a family provider', - ); - } - } - - factory FamilyTemplate.functional( - FunctionalProviderDeclaration provider, { - required String hashFn, - required BuildYamlOptions options, - }) { - var providerType = 'Provider'; - var refType = 'Ref<${provider.valueTypeDisplayString}>'; - var elementType = 'ProviderElement'; - - final returnType = provider.createdTypeNode?.type; - if (returnType != null && !returnType.isRaw) { - if (returnType.isDartAsyncFutureOr || returnType.isDartAsyncFuture) { - providerType = 'FutureProvider'; - refType = 'Ref>'; - elementType = 'FutureProviderElement'; - } else if (returnType.isDartAsyncStream) { - providerType = 'StreamProvider'; - refType = 'Ref>'; - elementType = 'StreamProviderElement'; - } - } - - final parameters = provider.node.functionExpression.parameters!.parameters - .skip(1) - .toList(); - - final parametersPassThrough = buildParamInvocationQuery({ - for (final parameter in parameters) parameter: parameter.name!.lexeme, - }); - - final typeParameters = provider.node.functionExpression.typeParameters; - final typeParametersUsage = genericUsageDisplayString(typeParameters); - final typeParametersDefinition = - genericDefinitionDisplayString(typeParameters); - - final createType = - '${provider.createdTypeDisplayString} Function$typeParametersDefinition(${provider._refImplName} ref)'; - - return FamilyTemplate._( - provider, - options: options, - parameters: parameters, - typeParameters: typeParameters, - hashFn: hashFn, - elementType: elementType, - refType: refType, - providerGenerics: '<${provider.valueTypeDisplayString}>', - providerCreate: - '(ref) => ${provider.name}$typeParametersUsage(ref as ${provider._refImplName}$typeParametersUsage, $parametersPassThrough)', - providerType: providerType, - parametersPassThrough: parametersPassThrough, - createType: createType, - overrideCreate: '(ref) => create(ref as ${provider._refImplName})', - ); - } - - factory FamilyTemplate.classBased( - ClassBasedProviderDeclaration provider, { - required String notifierTypedefName, - required String hashFn, - required BuildYamlOptions options, - }) { - var leading = ''; - if (!provider.annotation.element.keepAlive) { - leading = 'AutoDispose'; - } - - var providerType = '${leading}NotifierProviderImpl'; - var refType = '${leading}NotifierProviderRef'; - var notifierBaseType = 'Buildless${leading}Notifier'; - var elementType = '${leading}NotifierProviderElement'; - - final returnType = provider.createdTypeNode?.type; - if (returnType != null && !returnType.isRaw) { - if (returnType.isDartAsyncFutureOr || returnType.isDartAsyncFuture) { - providerType = '${leading}AsyncNotifierProviderImpl'; - refType = '${leading}AsyncNotifierProviderRef'; - notifierBaseType = 'Buildless${leading}AsyncNotifier'; - elementType = '${leading}AsyncNotifierProviderElement'; - } else if (returnType.isDartAsyncStream) { - providerType = '${leading}StreamNotifierProviderImpl'; - refType = '${leading}StreamNotifierProviderRef'; - notifierBaseType = 'Buildless${leading}StreamNotifier'; - elementType = '${leading}StreamNotifierProviderElement'; - } - } - - final parameters = - provider.buildMethod.parameters!.parameters.whereNotNull().toList(); - final parameterDefinition = buildParamDefinitionQuery(parameters); - final cascadePropertyInit = - parameters.map((e) => '..${e.name} = ${e.name}').join('\n'); - - final parametersPassThrough = buildParamInvocationQuery({ - for (final parameter in parameters) parameter: parameter.name!.lexeme, - }); - - final typeParameters = provider.node.typeParameters; - final typeParametersUsage = genericUsageDisplayString(typeParameters); - final typeParametersDefinition = - genericDefinitionDisplayString(typeParameters); - - return FamilyTemplate._( - provider, - options: options, - parameters: parameters, - typeParameters: typeParameters, - hashFn: hashFn, - elementType: elementType, - refType: refType, - providerGenerics: - '<${provider.name}$typeParametersUsage, ${provider.valueTypeDisplayString}>', - providerType: providerType, - providerCreate: parameters.isEmpty - // If the provider has no arguments (and therefore only generics), - // use tear-off constructor - ? '${provider.name.lexeme}$typeParametersUsage.new' - : '() => ${provider.name}$typeParametersUsage()$cascadePropertyInit', - parametersPassThrough: parametersPassThrough, - createType: '${provider.name} Function()', - overrideCreate: '() => create()$cascadePropertyInit', - other: ''' -abstract class $notifierTypedefName$typeParametersDefinition extends $notifierBaseType<${provider.valueTypeDisplayString}> { - ${parameters.map((e) => 'late final ${e.typeDisplayString} ${e.name};').join('\n')} - - ${provider.createdTypeDisplayString} build($parameterDefinition); -} -''', - providerOther: ''' - @override - ${provider.createdTypeDisplayString} runNotifierBuild( - covariant ${provider.name}$typeParametersUsage notifier, - ) { - return notifier.build($parametersPassThrough); - } - - @internal - @override - $providerType copyWithBuild( - ${provider.name} Function() create, - ) { - return $providerType._internal( - create, - ${parameters.map((e) => '${e.name}: ${e.name},\n').join()} - ); - } -''', - ); - } + FamilyTemplate(this.provider, this.options); final GeneratorProviderDeclaration provider; - final List parameters; - final TypeParameterList? typeParameters; final BuildYamlOptions options; - final String refType; - final String elementType; - final String providerType; - final String providerGenerics; - final String providerCreate; - final String other; - final String providerOther; - final String parametersPassThrough; - final String hashFn; - final String createType; - final String overrideCreate; @override void run(StringBuffer buffer) { - final isAutoDispose = !provider.providerElement.annotation.keepAlive; - - final providerTypeNameImpl = provider._providerImplName; - final refNameImpl = provider._refImplName; - final elementNameImpl = '_${providerTypeNameImpl.public}Element'; - final familyName = '${provider.providerElement.name.titled}Family'; + if (!provider.providerElement.isFamily) return; - final parameterDefinition = buildParamDefinitionQuery(parameters); + // TODO add docs everywhere in generated code - final docs = providerDocFor(provider.providerElement.element); - final meta = metaAnnotations(provider.node.metadata); - final providerName = - providerFamilyNameFor(provider.providerElement, options); + final generics = provider.generics(); + final genericsDefinition = provider.genericsDefinition(); - final dependenciesKeyword = - provider.providerElement.annotation.dependencies == null - ? 'const Iterable?' - : 'final Iterable'; + final parameterDefinition = buildParamDefinitionQuery(provider.parameters); - final typeParametersDefinition = - genericDefinitionDisplayString(typeParameters); - final typeParametersUsage = genericUsageDisplayString(typeParameters); - final argumentRecordType = buildParamDefinitionQuery( - parameters, - asRecord: true, - ); - final argumentsToRecord = buildParamInvocationQuery({ - for (final parameter in parameters) parameter: parameter.name!.lexeme, + final parametersPassThrough = buildParamInvocationQuery({ + for (final parameter in provider.parameters) + parameter: parameter.name!.lexeme, }); - - // TODO changelog updated to support createElement prototype change - // TODO changelog toString() - // TODO handle generics with $ in their name - - final encodedProviderName = providerName.encoded; - final encodedGenerics = typeParameters == null + final argument = provider.parameters.isEmpty ? '' - : '<${typeParameters!.typeParameters.map((e) => '\$${e.name.lexeme.encoded}').join(',')}>'; - - buffer.write(''' -$other - -$docs -@ProviderFor(${provider.name}) -$meta -const $providerName = $familyName(); - -$docs -final class $familyName extends Family { - $docs - const $familyName() - : super( - name: r'$providerName', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: $hashFn, - ${isAutoDispose ? 'isAutoDispose: true,' : ''} + : 'argument: ($parametersPassThrough),'; + + buffer.writeln(''' +final class ${provider.familyTypeName} extends Family{ + const ${provider.familyTypeName}._() + : super( + name: r'${provider.name}', + dependencies: ${serializeDependencies(provider.providerElement.annotation, options)}, + allTransitiveDependencies: ${serializeAllTransitiveDependencies(provider.providerElement.annotation, options)}, + debugGetCreateSourceHash: ${provider.hashFnName}, + ${provider.providerElement.isAutoDispose ? 'isAutoDispose: true,' : ''} ); - static $dependenciesKeyword _dependencies = ${serializeDependencies(provider.providerElement.annotation, options)}; - - static $dependenciesKeyword _allTransitiveDependencies = ${serializeAllTransitiveDependencies(provider.providerElement.annotation, options)}; - - $docs - $providerTypeNameImpl$typeParametersUsage call$typeParametersDefinition($parameterDefinition) { - return $providerTypeNameImpl$typeParametersUsage($parametersPassThrough); - } - - @override - String toString() => '$encodedProviderName'; -} - -$docs -final class $providerTypeNameImpl$typeParametersDefinition extends $providerType$providerGenerics { - $docs - $providerTypeNameImpl($parameterDefinition) : this._internal( - $providerCreate, - argument: ($argumentsToRecord), - ); - - $providerTypeNameImpl._internal( - super.create, { - required ($argumentRecordType) super.argument, - }) : super.internal( - debugGetCreateSourceHash: $hashFn, - from: $providerName, - name: r'$providerName', - isAutoDispose: $isAutoDispose, - dependencies: null, - allTransitiveDependencies: null, - ); - -$providerOther - - @override - $elementNameImpl$typeParametersUsage createElement(ProviderContainer container,) { - return $elementNameImpl(this, container); - } - - @internal - @override - $providerTypeNameImpl copyWithCreate( - $createType create, - ) { - return $providerTypeNameImpl._internal( - $overrideCreate, - argument: argument as ($argumentRecordType), + ${provider.providerTypeName}$generics call$genericsDefinition($parameterDefinition) + => ${provider.providerTypeName}._( + $argument + from: this ); - } @override - bool operator ==(Object other) { - return ${[ - 'other is $providerTypeNameImpl', - // If there are type parameters, check the runtimeType to check them too. - if (typeParameters?.typeParameters.isNotEmpty ?? false) - 'other.runtimeType == runtimeType', - 'other.argument == argument', - ].join(' && ')}; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => '$encodedProviderName$encodedGenerics\$argument'; -} - -mixin $refNameImpl$typeParametersDefinition on $refType { - ${parameters.map((e) { - return ''' -/// The parameter `${e.name}` of this provider. -${e.typeDisplayString} get ${e.name};'''; - }).join()} -} - -class $elementNameImpl$typeParametersDefinition extends $elementType$providerGenerics with $refNameImpl$typeParametersUsage { - $elementNameImpl(super.provider, super.container); - -${parameters.map((e) => '@override ${e.typeDisplayString} get ${e.name} => (origin as $providerTypeNameImpl$typeParametersUsage).${e.name};').join()} + String toString() => r'${provider.name}'; } '''); } } - -extension on GeneratorProviderDeclaration { - String get _providerImplName => '${providerElement.name.titled}Provider'; - - String get _refImplName => '${providerElement.name.titled}Ref'; -} diff --git a/packages/riverpod_generator/lib/src/templates/family_back.dart b/packages/riverpod_generator/lib/src/templates/family_back.dart new file mode 100644 index 000000000..af50144c5 --- /dev/null +++ b/packages/riverpod_generator/lib/src/templates/family_back.dart @@ -0,0 +1,426 @@ +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:collection/collection.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; + +import '../models.dart'; +import '../riverpod_generator.dart'; +import '../type.dart'; +import 'class_based_provider.dart'; +import 'parameters.dart'; +import 'template.dart'; + +String providerFamilyNameFor( + ProviderDeclarationElement provider, + BuildYamlOptions options, +) { + return '${provider.name.lowerFirst}${options.providerFamilyNameSuffix ?? options.providerNameSuffix ?? 'Provider'}'; +} + +String genericDefinitionDisplayString(TypeParameterList? typeParameters) { + return typeParameters?.toSource() ?? ''; +} + +String genericUsageDisplayString(TypeParameterList? typeParameterList) { + if (typeParameterList == null) { + return ''; + } + + return '<${typeParameterList.typeParameters.map((e) => e.name.lexeme).join(', ')}>'; +} + +class FamilyTemplate extends Template { + FamilyTemplate._( + this.provider, { + required this.options, + required this.parameters, + required this.typeParameters, + required this.providerType, + required this.refType, + required this.elementType, + required this.providerGenerics, + required this.providerCreate, + required this.parametersPassThrough, + required this.hashFn, + required this.createType, + required this.overrideCreate, + this.other = '', + this.providerOther = '', + }) { + if (!provider.providerElement.isFamily) { + throw ArgumentError.value( + provider.providerElement.isFamily, + 'provider.providerElement.isFamily', + 'Expected a family provider', + ); + } + } + + factory FamilyTemplate.functional( + FunctionalProviderDeclaration provider, { + required String hashFn, + required BuildYamlOptions options, + }) { + var providerType = 'Provider'; + var refType = 'Ref<${provider.valueTypeDisplayString}>'; + var elementType = 'ProviderElement'; + + final returnType = provider.createdTypeNode?.type; + if (returnType != null && !returnType.isRaw) { + if (returnType.isDartAsyncFutureOr || returnType.isDartAsyncFuture) { + providerType = 'FutureProvider'; + refType = 'Ref>'; + elementType = 'FutureProviderElement'; + } else if (returnType.isDartAsyncStream) { + providerType = 'StreamProvider'; + refType = 'Ref>'; + elementType = 'StreamProviderElement'; + } + } + + final parameters = provider.node.functionExpression.parameters!.parameters + .skip(1) + .toList(); + + final parametersPassThrough = buildParamInvocationQuery({ + for (final parameter in parameters) parameter: parameter.name!.lexeme, + }); + + final typeParameters = provider.node.functionExpression.typeParameters; + final typeParametersUsage = genericUsageDisplayString(typeParameters); + final typeParametersDefinition = + genericDefinitionDisplayString(typeParameters); + + final createType = + '${provider.createdTypeDisplayString} Function$typeParametersDefinition(${provider.refImplName} ref)'; + + return FamilyTemplate._( + provider, + options: options, + parameters: parameters, + typeParameters: typeParameters, + hashFn: hashFn, + elementType: elementType, + refType: refType, + providerGenerics: '<${provider.valueTypeDisplayString}>', + providerCreate: + '(ref) => ${provider.name}$typeParametersUsage(ref as ${provider.refImplName}$typeParametersUsage, $parametersPassThrough)', + providerType: providerType, + parametersPassThrough: parametersPassThrough, + createType: createType, + overrideCreate: '(ref) => create(ref as ${provider.refImplName})', + ); + } + + factory FamilyTemplate.classBased( + ClassBasedProviderDeclaration provider, { + required String notifierTypedefName, + required String hashFn, + required BuildYamlOptions options, + }) { + var leading = ''; + if (!provider.annotation.element.keepAlive) { + leading = 'AutoDispose'; + } + + var providerType = '${leading}NotifierProviderImpl'; + var refType = '${leading}NotifierProviderRef'; + var notifierBaseType = 'Buildless${leading}Notifier'; + var elementType = '${leading}NotifierProviderElement'; + + final returnType = provider.createdTypeNode?.type; + if (returnType != null && !returnType.isRaw) { + if (returnType.isDartAsyncFutureOr || returnType.isDartAsyncFuture) { + providerType = '${leading}AsyncNotifierProviderImpl'; + refType = '${leading}AsyncNotifierProviderRef'; + notifierBaseType = 'Buildless${leading}AsyncNotifier'; + elementType = '${leading}AsyncNotifierProviderElement'; + } else if (returnType.isDartAsyncStream) { + providerType = '${leading}StreamNotifierProviderImpl'; + refType = '${leading}StreamNotifierProviderRef'; + notifierBaseType = 'Buildless${leading}StreamNotifier'; + elementType = '${leading}StreamNotifierProviderElement'; + } + } + + final parameters = + provider.buildMethod.parameters!.parameters.whereNotNull().toList(); + final parameterDefinition = buildParamDefinitionQuery(parameters); + final cascadePropertyInit = + parameters.map((e) => '..${e.name} = ${e.name}').join('\n'); + + final parametersPassThrough = buildParamInvocationQuery({ + for (final parameter in parameters) parameter: parameter.name!.lexeme, + }); + + final typeParameters = provider.node.typeParameters; + final typeParametersUsage = genericUsageDisplayString(typeParameters); + final typeParametersDefinition = + genericDefinitionDisplayString(typeParameters); + + return FamilyTemplate._( + provider, + options: options, + parameters: parameters, + typeParameters: typeParameters, + hashFn: hashFn, + elementType: elementType, + refType: refType, + providerGenerics: + '<${provider.name}$typeParametersUsage, ${provider.valueTypeDisplayString}>', + providerType: providerType, + providerCreate: parameters.isEmpty + // If the provider has no arguments (and therefore only generics), + // use tear-off constructor + ? '${provider.name.lexeme}$typeParametersUsage.new' + : '() => ${provider.name}$typeParametersUsage()$cascadePropertyInit', + parametersPassThrough: parametersPassThrough, + createType: '${provider.name} Function()', + overrideCreate: '() => create()$cascadePropertyInit', + other: ''' +abstract class $notifierTypedefName$typeParametersDefinition extends $notifierBaseType<${provider.valueTypeDisplayString}> { + ${parameters.map((e) => 'late final ${e.typeDisplayString} ${e.name};').join('\n')} + + ${provider.createdTypeDisplayString} build($parameterDefinition); +} +''', + providerOther: ''' + @override + ${provider.createdTypeDisplayString} runNotifierBuild( + covariant ${provider.name}$typeParametersUsage notifier, + ) { + return notifier.build($parametersPassThrough); + } + + @internal + @override + $providerType copyWithBuild( + ${provider.name} Function() create, + ) { + return $providerType._internal( + create, + ${parameters.map((e) => '${e.name}: ${e.name},\n').join()} + ); + } +''', + ); + } + + final GeneratorProviderDeclaration provider; + final List parameters; + final TypeParameterList? typeParameters; + final BuildYamlOptions options; + final String refType; + final String elementType; + final String providerType; + final String providerGenerics; + final String providerCreate; + final String other; + final String providerOther; + final String parametersPassThrough; + final String hashFn; + final String createType; + final String overrideCreate; + + @override + void run(StringBuffer buffer) { + final isAutoDispose = !provider.providerElement.annotation.keepAlive; + + final providerTypeNameImpl = provider.providerTypeName; + final refNameImpl = provider.refImplName; + final elementNameImpl = '_${providerTypeNameImpl.public}Element'; + final familyName = provider.familyTypeName; + + final parameterDefinition = buildParamDefinitionQuery(parameters); + + final docs = providerDocFor(provider.providerElement.element); + final meta = metaAnnotations(provider.node.metadata); + final providerName = + providerFamilyNameFor(provider.providerElement, options); + + final dependenciesKeyword = + provider.providerElement.annotation.dependencies == null + ? 'const Iterable?' + : 'final Iterable'; + + final typeParametersDefinition = + genericDefinitionDisplayString(typeParameters); + final typeParametersUsage = genericUsageDisplayString(typeParameters); + final argumentRecordType = buildParamDefinitionQuery( + parameters, + asRecord: true, + ); + final argumentsToRecord = buildParamInvocationQuery({ + for (final parameter in parameters) parameter: parameter.name!.lexeme, + }); + + // TODO changelog updated to support createElement prototype change + // TODO changelog toString() + // TODO handle generics with $ in their name + + final encodedProviderName = providerName.encoded; + final encodedGenerics = typeParameters == null + ? '' + : '<${typeParameters!.typeParameters.map((e) => '\$${e.name.lexeme.encoded}').join(',')}>'; + + buffer.write(''' +$other + +$docs +@ProviderFor(${provider.name}) +$meta +const $providerName = $familyName(); + +$docs +final class $familyName extends Family { + $docs + const $familyName() + : super( + name: r'$providerName', + dependencies: _dependencies, + allTransitiveDependencies: _allTransitiveDependencies, + debugGetCreateSourceHash: $hashFn, + ${isAutoDispose ? 'isAutoDispose: true,' : ''} + ); + + static $dependenciesKeyword _dependencies = ${serializeDependencies(provider.providerElement.annotation, options)}; + + static $dependenciesKeyword _allTransitiveDependencies = ${serializeAllTransitiveDependencies(provider.providerElement.annotation, options)}; + + $docs + $providerTypeNameImpl$typeParametersUsage call$typeParametersDefinition($parameterDefinition) { + return $providerTypeNameImpl$typeParametersUsage($parametersPassThrough); + } + + @override + String toString() => '$encodedProviderName'; +} + +$docs +final class $providerTypeNameImpl$typeParametersDefinition extends $providerType$providerGenerics { + $docs + $providerTypeNameImpl($parameterDefinition) : this._internal( + $providerCreate, + argument: ($argumentsToRecord), + ); + + $providerTypeNameImpl._internal( + super.create, { + required ($argumentRecordType) super.argument, + }) : super.internal( + debugGetCreateSourceHash: $hashFn, + from: $providerName, + name: r'$providerName', + isAutoDispose: $isAutoDispose, + dependencies: null, + allTransitiveDependencies: null, + ); + +$providerOther + + @override + $elementNameImpl$typeParametersUsage createElement(ProviderContainer container,) { + return $elementNameImpl(this, container); + } + + @internal + @override + $providerTypeNameImpl copyWithCreate( + $createType create, + ) { + return $providerTypeNameImpl._internal( + $overrideCreate, + argument: argument as ($argumentRecordType), + ); + } + + @override + bool operator ==(Object other) { + return ${[ + 'other is $providerTypeNameImpl', + // If there are type parameters, check the runtimeType to check them too. + if (typeParameters?.typeParameters.isNotEmpty ?? false) + 'other.runtimeType == runtimeType', + 'other.argument == argument', + ].join(' && ')}; + } + + @override + int get hashCode => Object.hash(argument, runtimeType); + + @override + String toString() => '$encodedProviderName$encodedGenerics\$argument'; +} + +mixin $refNameImpl$typeParametersDefinition on $refType { + ${parameters.map((e) { + return ''' +/// The parameter `${e.name}` of this provider. +${e.typeDisplayString} get ${e.name};'''; + }).join()} +} + +class $elementNameImpl$typeParametersDefinition extends $elementType$providerGenerics with $refNameImpl$typeParametersUsage { + $elementNameImpl(super.provider, super.container); + +${parameters.map((e) => '@override ${e.typeDisplayString} get ${e.name} => (origin as $providerTypeNameImpl$typeParametersUsage).${e.name};').join()} +} +'''); + } +} + +extension ProviderNames on GeneratorProviderDeclaration { + String get providerTypeName => '${providerElement.name.titled}Provider'; + + String get refImplName => '${providerElement.name.titled}Ref'; + + String get familyTypeName => '${providerElement.name.titled}Family'; + + TypeParameterList? get typeParameters => switch (this) { + final FunctionalProviderDeclaration p => + p.node.functionExpression.typeParameters, + final ClassBasedProviderDeclaration p => p.node.typeParameters + }; + + String generics() => genericUsageDisplayString(typeParameters); + String genericsDefinition() => genericDefinitionDisplayString(typeParameters); + + String createType({bool withArguments = true}) { + final generics = this.generics(); + + final provider = this; + switch (provider) { + case FunctionalProviderDeclaration(): + final params = withArguments + ? buildParamDefinitionQuery( + parameters, + withDefaults: false, + ) + : ''; + + final refType = '${provider.refImplName}$generics'; + return '${provider.createdTypeDisplayString} Function($refType ref, $params)'; + case ClassBasedProviderDeclaration(): + return '${provider.createdTypeDisplayString} Function()'; + } + } + + String get elementName => switch (createdType) { + SupportedCreatedType.future => r'$FutureProviderElement', + SupportedCreatedType.stream => r'$StreamProviderElement', + SupportedCreatedType.value => r'$ProviderElement', + }; + + String get hashFnName => '_\$${providerElement.name.public.lowerFirst}Hash'; + + List get parameters { + final provider = this; + switch (provider) { + case FunctionalProviderDeclaration(): + return provider.node.functionExpression.parameters!.parameters + .skip(1) + .toList(); + case ClassBasedProviderDeclaration(): + return provider.buildMethod.parameters!.parameters.toList(); + } + } +} diff --git a/packages/riverpod_generator/lib/src/templates/hash.dart b/packages/riverpod_generator/lib/src/templates/hash.dart new file mode 100644 index 000000000..53613197a --- /dev/null +++ b/packages/riverpod_generator/lib/src/templates/hash.dart @@ -0,0 +1,17 @@ +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; + +import 'family_back.dart'; +import 'template.dart'; + +class HashFnTemplate extends Template { + HashFnTemplate(this.provider); + + final GeneratorProviderDeclaration provider; + + @override + void run(StringBuffer buffer) { + buffer.writeln( + "String ${provider.hashFnName}() => r'${provider.computeProviderHash()}';", + ); + } +} diff --git a/packages/riverpod_generator/lib/src/templates/parameters.dart b/packages/riverpod_generator/lib/src/templates/parameters.dart index 0aa143fb8..96bf6311d 100644 --- a/packages/riverpod_generator/lib/src/templates/parameters.dart +++ b/packages/riverpod_generator/lib/src/templates/parameters.dart @@ -7,6 +7,7 @@ String buildParamDefinitionQuery( bool writeBrackets = true, bool asRequiredNamed = false, bool asRecord = false, + bool withDefaults = true, }) { assert( !asThisParameter || !asSuperParameter, @@ -24,6 +25,7 @@ String buildParamDefinitionQuery( .toList(); final buffer = StringBuffer(); + String encodeParameter(FormalParameter parameter) { if (asRecord) { final type = parameter.typeDisplayString.isEmpty @@ -38,9 +40,10 @@ String buildParamDefinitionQuery( late final element = parameter.declaredElement!; late final leading = parameter.isRequiredNamed || asRequiredNamed ? 'required ' : ''; - late final trailing = element.defaultValueCode != null && !asRequiredNamed - ? '= ${element.defaultValueCode}' - : ''; + late final trailing = + element.defaultValueCode != null && !asRequiredNamed && withDefaults + ? '= ${element.defaultValueCode}' + : ''; if (asThisParameter) return '${leading}this.${parameter.name}$trailing'; if (asSuperParameter) return '${leading}super.${parameter.name}$trailing'; diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart new file mode 100644 index 000000000..be9fafeb3 --- /dev/null +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -0,0 +1,174 @@ +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; + +import '../type.dart'; +import 'family_back.dart'; +import 'parameters.dart'; +import 'template.dart'; + +class ProviderTemplate extends Template { + ProviderTemplate(this.provider); + + final GeneratorProviderDeclaration provider; + + @override + void run(StringBuffer buffer) { + final provider = this.provider; + final generics = provider.generics(); + final genericsDefinition = provider.genericsDefinition(); + + switch (provider) { + case FunctionalProviderDeclaration(): + final name = provider.providerTypeName; + final exposedType = provider.exposedTypeDisplayString; + final createdType = provider.createdTypeDisplayString; + final valueType = provider.valueTypeDisplayString; + + final refType = '${provider.refImplName}$generics'; + + final List modifiers; + + switch (provider.createdType) { + case SupportedCreatedType.future: + modifiers = [ + '\$FutureModifier<$valueType>', + '\$FutureProvider<$valueType, $refType>', + ]; + case SupportedCreatedType.stream: + modifiers = [ + '\$FutureModifier<$valueType>', + '\$StreamProvider<$valueType, $refType>', + ]; + case SupportedCreatedType.value: + modifiers = []; + } + + final mixins = modifiers.isEmpty ? '' : ' with ${modifiers.join(', ')}'; + + buffer.writeln( + ''' +final class $name$genericsDefinition + extends \$FunctionalProvider< + $exposedType, + $createdType, + $refType + > + $mixins { +''', + ); + + _writeMembers(buffer); + + buffer.writeln('}'); + + default: + } + } + + void _writeMembers(StringBuffer buffer) { + final provider = this.provider; + final generics = provider.generics(); + + final providerParameters = provider.parameters; + + final superParameters = [ + if (!provider.providerElement.isFamily) 'from: null,', + if (providerParameters.isEmpty) 'argument: null,', + ].join(); + + final argumentRecordType = buildParamDefinitionQuery( + provider.parameters, + asRecord: true, + ); + + final constructorParameters = [ + if (provider.providerElement.isFamily) + 'required ${provider.familyTypeName} super.from,', + if (providerParameters.isNotEmpty) + 'required ($argumentRecordType) super.argument,', + ].join(); + + final localArgumentDefinition = provider.parameters.isNotEmpty + ? 'final ($argumentRecordType) argument = this.argument! as ($argumentRecordType);' + : ''; + final paramsPassThrough = buildParamInvocationQuery({ + for (final (index, parameter) in provider.parameters.indexed) + if (parameter.isPositional) + parameter: 'argument.\$${index + 1}' + else + parameter: 'argument.${parameter.name!.lexeme}', + }); + + buffer.writeln(''' + const ${provider.providerTypeName}._({ + ${provider.createType()}? create, + $constructorParameters + }): _createCb = create, + super( + debugGetCreateSourceHash: ${provider.hashFnName}, + name: r'${provider.name}', + isAutoDispose: ${!provider.annotation.element.keepAlive}, + dependencies: null, + allTransitiveDependencies: null, + $superParameters + ); + + final ${provider.createType()}? _createCb; + + @override + ${provider.createdTypeDisplayString} create(${provider.refImplName}$generics ref){ + final fn = _createCb ?? ${provider.name}$generics; + $localArgumentDefinition + return fn(ref, $paramsPassThrough); + } + + @override + ${provider.elementName}<${provider.valueTypeDisplayString}> createElement( + ProviderContainer container + ) => ${provider.elementName}(this, container); +'''); + + switch (provider) { + case FunctionalProviderDeclaration(): + final parameters = [ + if (providerParameters.isNotEmpty) + 'argument: argument! as ($argumentRecordType),', + if (provider.providerElement.isFamily) + 'from: from! as ${provider.familyTypeName},', + ].join(); + + final createParams = buildParamDefinitionQuery(provider.parameters); + + final createFn = provider.parameters.isEmpty + ? 'create' + : '(ref, $createParams) => create(ref)'; + + buffer.writeln(''' + @override + ${provider.providerTypeName}$generics copyWithCreate( + ${provider.createType(withArguments: false)} create, + ) { + return ${provider.providerTypeName}$generics._( + create: $createFn, + $parameters + ); + } +'''); + default: + } + + if (provider.providerElement.isFamily) { + buffer.writeln(''' + @override + bool operator ==(Object other) { + return ${[ + 'other is ${provider.providerTypeName}', + // If there are type parameters, check the runtimeType to check them too. + if (provider.typeParameters?.typeParameters.isNotEmpty ?? false) + 'other.runtimeType == runtimeType', + 'other.argument == argument', + ].join(' && ')}; + } +'''); + } + } +} diff --git a/packages/riverpod_generator/lib/src/templates/provider_variable.dart b/packages/riverpod_generator/lib/src/templates/provider_variable.dart new file mode 100644 index 000000000..69378eec1 --- /dev/null +++ b/packages/riverpod_generator/lib/src/templates/provider_variable.dart @@ -0,0 +1,31 @@ +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; + +import '../models.dart'; +import 'class_based_provider.dart'; +import 'family_back.dart'; +import 'template.dart'; + +class ProviderVariableTemplate extends Template { + ProviderVariableTemplate(this.provider, this.options); + + final GeneratorProviderDeclaration provider; + final BuildYamlOptions options; + + @override + void run(StringBuffer buffer) { + final provider = this.provider; + + final providerName = providerNameFor(provider.providerElement, options); + + switch (provider) { + case _ when provider.providerElement.isFamily: + buffer.writeln('const $providerName = ${provider.familyTypeName}._();'); + + case FunctionalProviderDeclaration(): + final providerType = provider.providerTypeName; + + buffer.writeln('const $providerName = $providerType._();'); + default: + } + } +} diff --git a/packages/riverpod_generator/lib/src/templates/ref.dart b/packages/riverpod_generator/lib/src/templates/ref.dart new file mode 100644 index 000000000..39646e127 --- /dev/null +++ b/packages/riverpod_generator/lib/src/templates/ref.dart @@ -0,0 +1,21 @@ +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; + +import 'family_back.dart'; +import 'template.dart'; + +class RefTemplate extends Template { + RefTemplate(this.provider); + + final FunctionalProviderDeclaration provider; + + @override + void run(StringBuffer buffer) { + final typeParameters = provider.node.functionExpression.typeParameters; + final typeParametersDefinition = + genericDefinitionDisplayString(typeParameters); + + buffer.writeln(''' +typedef ${provider.refImplName}$typeParametersDefinition = Ref<${provider.exposedTypeDisplayString}>; +'''); + } +} diff --git a/packages/riverpod_generator/lib/src/type.dart b/packages/riverpod_generator/lib/src/type.dart new file mode 100644 index 000000000..59606851f --- /dev/null +++ b/packages/riverpod_generator/lib/src/type.dart @@ -0,0 +1,22 @@ +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; + +extension SwitchCreatedType on GeneratorProviderDeclaration { + SupportedCreatedType get createdType { + final dartType = createdTypeNode?.type; + switch (dartType) { + case != null + when dartType.isDartAsyncFutureOr || dartType.isDartAsyncFuture: + return SupportedCreatedType.future; + case != null when dartType.isDartAsyncStream: + return SupportedCreatedType.stream; + case _: + return SupportedCreatedType.value; + } + } +} + +enum SupportedCreatedType { + future, + stream, + value, +} diff --git a/packages/riverpod_generator/pubspec.yaml b/packages/riverpod_generator/pubspec.yaml index 133750c63..c7aa35a6b 100644 --- a/packages/riverpod_generator/pubspec.yaml +++ b/packages/riverpod_generator/pubspec.yaml @@ -18,7 +18,7 @@ dependencies: meta: ^1.7.0 path: ^1.8.0 riverpod_analyzer_utils: ^1.0.0-dev.1 - riverpod_annotation: ^3.0.0-dev.3 + riverpod_annotation: 3.0.0-dev.3 source_gen: ^1.2.0 dev_dependencies: @@ -26,5 +26,5 @@ dev_dependencies: build_verify: ^3.0.0 freezed: ^2.4.3 freezed_annotation: ^2.4.1 - riverpod: ^3.0.0-dev.3 + riverpod: 3.0.0-dev.3 test: ^1.21.0 diff --git a/packages/riverpod_generator/test/integration/annotated.dart b/packages/riverpod_generator/test/integration/annotated.dart index a60a58a4d..a1064b867 100644 --- a/packages/riverpod_generator/test/integration/annotated.dart +++ b/packages/riverpod_generator/test/integration/annotated.dart @@ -1,40 +1,40 @@ -import 'package:meta/meta.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:meta/meta.dart'; +// import 'package:riverpod_annotation/riverpod_annotation.dart'; -part 'annotated.g.dart'; +// part 'annotated.g.dart'; -@riverpod -@Deprecated('Deprecation message') -@visibleForTesting -@protected -String functional(FunctionalRef ref) => 'functional'; +// @riverpod +// @Deprecated('Deprecation message') +// @visibleForTesting +// @protected +// String functional(FunctionalRef ref) => 'functional'; -@riverpod -@Deprecated('Deprecation message') -@visibleForTesting -@protected -class ClassBased extends _$ClassBased { - @override - String build() => 'ClassBased'; -} +// @riverpod +// @Deprecated('Deprecation message') +// @visibleForTesting +// @protected +// class ClassBased extends _$ClassBased { +// @override +// String build() => 'ClassBased'; +// } -@riverpod -@Deprecated('Deprecation message') -@visibleForTesting -@protected -String family(FamilyRef ref, int id) => 'family $id'; +// @riverpod +// @Deprecated('Deprecation message') +// @visibleForTesting +// @protected +// String family(FamilyRef ref, int id) => 'family $id'; -@riverpod -@doNotStore -String notCopiedFunctional(NotCopiedFunctionalRef ref) => 'notCopiedFunctional'; +// @riverpod +// @doNotStore +// String notCopiedFunctional(NotCopiedFunctionalRef ref) => 'notCopiedFunctional'; -@riverpod -@doNotStore -class NotCopiedClassBased extends _$NotCopiedClassBased { - @override - String build() => 'NotCopiedClassBased'; -} +// @riverpod +// @doNotStore +// class NotCopiedClassBased extends _$NotCopiedClassBased { +// @override +// String build() => 'NotCopiedClassBased'; +// } -@riverpod -@doNotStore -String notCopiedFamily(NotCopiedFamilyRef ref, int id) => 'notCopiedFamily $id'; +// @riverpod +// @doNotStore +// String notCopiedFamily(NotCopiedFamilyRef ref, int id) => 'notCopiedFamily $id'; diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart deleted file mode 100644 index 9757455f8..000000000 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ /dev/null @@ -1,330 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'annotated.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -String _$functionalHash() => r'69e260b1de8ba28cbeb8e24d628933366cde6b8b'; - -/// See also [functional]. -@ProviderFor(functional) -@Deprecated('Deprecation message') -@visibleForTesting -@protected -final functionalProvider = Provider.internal( - functional, - name: r'functionalProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$functionalHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef FunctionalRef = Ref; -String _$familyHash() => r'd70685b83be840bfd9e79c11fb84c905d19d6e10'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [family]. -@ProviderFor(family) -@Deprecated('Deprecation message') -@visibleForTesting -@protected -const familyProvider = FamilyFamily(); - -/// See also [family]. -final class FamilyFamily extends Family { - /// See also [family]. - const FamilyFamily() - : super( - name: r'familyProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [family]. - FamilyProvider call( - int id, - ) { - return FamilyProvider( - id, - ); - } - - @override - String toString() => 'familyProvider'; -} - -/// See also [family]. -final class FamilyProvider extends Provider { - /// See also [family]. - FamilyProvider( - int id, - ) : this._internal( - (ref) => family( - ref as FamilyRef, - id, - ), - argument: (id,), - ); - - FamilyProvider._internal( - super.create, { - required (int,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyHash, - from: familyProvider, - name: r'familyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _FamilyProviderElement createElement( - ProviderContainer container, - ) { - return _FamilyProviderElement(this, container); - } - - @internal - @override - FamilyProvider copyWithCreate( - String Function(FamilyRef ref) create, - ) { - return FamilyProvider._internal( - (ref) => create(ref as FamilyRef), - argument: argument as (int,), - ); - } - - @override - bool operator ==(Object other) { - return other is FamilyProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'familyProvider$argument'; -} - -mixin FamilyRef on Ref { - /// The parameter `id` of this provider. - int get id; -} - -class _FamilyProviderElement extends ProviderElement with FamilyRef { - _FamilyProviderElement(super.provider, super.container); - - @override - int get id => (origin as FamilyProvider).id; -} - -String _$notCopiedFunctionalHash() => - r'30587ee9ceb75d5c8562015ad4a67ec0b107c1f6'; - -/// See also [notCopiedFunctional]. -@ProviderFor(notCopiedFunctional) -final notCopiedFunctionalProvider = Provider.internal( - notCopiedFunctional, - name: r'notCopiedFunctionalProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$notCopiedFunctionalHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef NotCopiedFunctionalRef = Ref; -String _$notCopiedFamilyHash() => r'6ef06ce6ebd73b476870bbe1af41c4f3fbe8ddb1'; - -/// See also [notCopiedFamily]. -@ProviderFor(notCopiedFamily) -const notCopiedFamilyProvider = NotCopiedFamilyFamily(); - -/// See also [notCopiedFamily]. -final class NotCopiedFamilyFamily extends Family { - /// See also [notCopiedFamily]. - const NotCopiedFamilyFamily() - : super( - name: r'notCopiedFamilyProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$notCopiedFamilyHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [notCopiedFamily]. - NotCopiedFamilyProvider call( - int id, - ) { - return NotCopiedFamilyProvider( - id, - ); - } - - @override - String toString() => 'notCopiedFamilyProvider'; -} - -/// See also [notCopiedFamily]. -final class NotCopiedFamilyProvider extends Provider { - /// See also [notCopiedFamily]. - NotCopiedFamilyProvider( - int id, - ) : this._internal( - (ref) => notCopiedFamily( - ref as NotCopiedFamilyRef, - id, - ), - argument: (id,), - ); - - NotCopiedFamilyProvider._internal( - super.create, { - required (int,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$notCopiedFamilyHash, - from: notCopiedFamilyProvider, - name: r'notCopiedFamilyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _NotCopiedFamilyProviderElement createElement( - ProviderContainer container, - ) { - return _NotCopiedFamilyProviderElement(this, container); - } - - @internal - @override - NotCopiedFamilyProvider copyWithCreate( - String Function(NotCopiedFamilyRef ref) create, - ) { - return NotCopiedFamilyProvider._internal( - (ref) => create(ref as NotCopiedFamilyRef), - argument: argument as (int,), - ); - } - - @override - bool operator ==(Object other) { - return other is NotCopiedFamilyProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'notCopiedFamilyProvider$argument'; -} - -mixin NotCopiedFamilyRef on Ref { - /// The parameter `id` of this provider. - int get id; -} - -class _NotCopiedFamilyProviderElement extends ProviderElement - with NotCopiedFamilyRef { - _NotCopiedFamilyProviderElement(super.provider, super.container); - - @override - int get id => (origin as NotCopiedFamilyProvider).id; -} - -String _$classBasedHash() => r'f40d1a032ee264aafd7686a985cdf1937f2dc108'; - -/// See also [ClassBased]. -@ProviderFor(ClassBased) -@Deprecated('Deprecation message') -@visibleForTesting -@protected -final classBasedProvider = NotifierProvider.internal( - ClassBased.new, - name: r'classBasedProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$classBasedHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$ClassBased = Notifier; -String _$notCopiedClassBasedHash() => - r'd2aefd08a78e3bb4c02000d4931a3bf15c01b495'; - -/// See also [NotCopiedClassBased]. -@ProviderFor(NotCopiedClassBased) -final notCopiedClassBasedProvider = - NotifierProvider.internal( - NotCopiedClassBased.new, - name: r'notCopiedClassBasedProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$notCopiedClassBasedHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$NotCopiedClassBased = Notifier; -// ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/async.dart b/packages/riverpod_generator/test/integration/async.dart index f82fedd70..6319b9168 100644 --- a/packages/riverpod_generator/test/integration/async.dart +++ b/packages/riverpod_generator/test/integration/async.dart @@ -1,3 +1,4 @@ +import 'package:riverpod/src/framework.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'async.g.dart'; @@ -20,7 +21,7 @@ FutureOr public(PublicRef ref) { return 'Hello world'; } -final privateProvider = _privateProvider; +const privateProvider = _privateProvider; @riverpod Future _private(_PrivateRef ref) async { diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index e05ee08de..6ef477e83 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -6,102 +6,70 @@ part of 'async.dart'; // RiverpodGenerator // ************************************************************************** -String _$genericHash() => r'6ee5473ece745b00328c1e048f6967c160343620'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [generic]. -@ProviderFor(generic) -const genericProvider = GenericFamily(); +typedef GenericRef = Ref>>; -/// See also [generic]. final class GenericFamily extends Family { - /// See also [generic]. - const GenericFamily() + const GenericFamily._() : super( - name: r'genericProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericHash, + name: r'generic', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$genericHash, isAutoDispose: true, ); - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [generic]. - GenericProvider call() { - return GenericProvider(); - } + GenericProvider call() => GenericProvider._(from: this); @override - String toString() => 'genericProvider'; + String toString() => r'generic'; } -/// See also [generic]. -final class GenericProvider extends FutureProvider> { - /// See also [generic]. - GenericProvider() - : this._internal( - (ref) => generic( - ref as GenericRef, - ), - argument: (), - ); - - GenericProvider._internal( - super.create, { - required () super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericHash, - from: genericProvider, - name: r'genericProvider', +const genericProvider = GenericFamily._(); + +final class GenericProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, GenericRef> + with $FutureModifier>, $FutureProvider, GenericRef> { + const GenericProvider._({ + FutureOr> Function( + GenericRef ref, + )? create, + required GenericFamily super.from, + }) : _createCb = create, + super( + debugGetCreateSourceHash: _$genericHash, + name: r'generic', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, + argument: null, ); + final FutureOr> Function( + GenericRef ref, + )? _createCb; + @override - _GenericProviderElement createElement( - ProviderContainer container, - ) { - return _GenericProviderElement(this, container); + FutureOr> create(GenericRef ref) { + final fn = _createCb ?? generic; + + return fn( + ref, + ); } - @internal + @override + $FutureProviderElement> createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + @override GenericProvider copyWithCreate( - covariant FutureOr> Function(GenericRef ref) create, + FutureOr> Function( + GenericRef ref, + ) create, ) { - return GenericProvider._internal( - (ref) => create(ref as GenericRef), - argument: argument as (), + return GenericProvider._( + create: create, + from: from! as GenericFamily, ); } @@ -111,711 +79,244 @@ final class GenericProvider extends FutureProvider> { other.runtimeType == runtimeType && other.argument == argument; } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'genericProvider<$T>$argument'; } -mixin GenericRef on Ref>> {} - -class _GenericProviderElement - extends FutureProviderElement> with GenericRef { - _GenericProviderElement(super.provider, super.container); -} - -String _$publicHash() => r'9d99b79c013da13926d4ad89c72ebca4fc1cc257'; - -/// See also [public]. -@ProviderFor(public) -final publicProvider = FutureProvider.internal( - public, - name: r'publicProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$publicHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - +String _$genericHash() => r'6ee5473ece745b00328c1e048f6967c160343620'; typedef PublicRef = Ref>; -String _$privateHash() => r'bc0469a9315de114a0ccd82c7db4980844d0009f'; - -/// See also [_private]. -@ProviderFor(_private) -final _privateProvider = FutureProvider.internal( - _private, - name: r'_privateProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$privateHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _PrivateRef = Ref>; -String _$familyOrHash() => r'1c3217e296b0ce52c07c18769d1fffb95850f482'; - -/// See also [familyOr]. -@ProviderFor(familyOr) -const familyOrProvider = FamilyOrFamily(); - -/// See also [familyOr]. -final class FamilyOrFamily extends Family { - /// See also [familyOr]. - const FamilyOrFamily() - : super( - name: r'familyOrProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyOrHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [familyOr]. - FamilyOrProvider call( - int first, - ) { - return FamilyOrProvider( - first, - ); - } - - @override - String toString() => 'familyOrProvider'; -} -/// See also [familyOr]. -final class FamilyOrProvider extends FutureProvider { - /// See also [familyOr]. - FamilyOrProvider( - int first, - ) : this._internal( - (ref) => familyOr( - ref as FamilyOrRef, - first, - ), - argument: (first,), - ); - - FamilyOrProvider._internal( - super.create, { - required (int,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyOrHash, - from: familyOrProvider, - name: r'familyOrProvider', +const publicProvider = PublicProvider._(); + +final class PublicProvider + extends $FunctionalProvider, FutureOr, PublicRef> + with $FutureModifier, $FutureProvider { + const PublicProvider._({ + FutureOr Function( + PublicRef ref, + )? create, + }) : _createCb = create, + super( + debugGetCreateSourceHash: _$publicHash, + name: r'public', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, + from: null, + argument: null, ); - @override - _FamilyOrProviderElement createElement( - ProviderContainer container, - ) { - return _FamilyOrProviderElement(this, container); - } - - @internal - @override - FamilyOrProvider copyWithCreate( - FutureOr Function(FamilyOrRef ref) create, - ) { - return FamilyOrProvider._internal( - (ref) => create(ref as FamilyOrRef), - argument: argument as (int,), - ); - } + final FutureOr Function( + PublicRef ref, + )? _createCb; @override - bool operator ==(Object other) { - return other is FamilyOrProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'familyOrProvider$argument'; -} - -mixin FamilyOrRef on Ref> { - /// The parameter `first` of this provider. - int get first; -} - -class _FamilyOrProviderElement extends FutureProviderElement - with FamilyOrRef { - _FamilyOrProviderElement(super.provider, super.container); + FutureOr create(PublicRef ref) { + final fn = _createCb ?? public; - @override - int get first => (origin as FamilyOrProvider).first; -} - -String _$familyHash() => r'eb6fad35a94d4238b621c2100253ee2c700bee77'; - -/// See also [family]. -@ProviderFor(family) -const familyProvider = FamilyFamily(); - -/// See also [family]. -final class FamilyFamily extends Family { - /// See also [family]. - const FamilyFamily() - : super( - name: r'familyProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [family]. - FamilyProvider call( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) { - return FamilyProvider( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, + return fn( + ref, ); } @override - String toString() => 'familyProvider'; -} + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); -/// See also [family]. -final class FamilyProvider extends FutureProvider { - /// See also [family]. - FamilyProvider( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) : this._internal( - (ref) => family( - ref as FamilyRef, - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - argument: ( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - ); - - FamilyProvider._internal( - super.create, { - required ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) - super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyHash, - from: familyProvider, - name: r'familyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _FamilyProviderElement createElement( - ProviderContainer container, - ) { - return _FamilyProviderElement(this, container); - } - - @internal @override - FamilyProvider copyWithCreate( - FutureOr Function(FamilyRef ref) create, + PublicProvider copyWithCreate( + FutureOr Function( + PublicRef ref, + ) create, ) { - return FamilyProvider._internal( - (ref) => create(ref as FamilyRef), - argument: argument as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }), + return PublicProvider._( + create: create, ); } - - @override - bool operator ==(Object other) { - return other is FamilyProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'familyProvider$argument'; -} - -mixin FamilyRef on Ref> { - /// The parameter `first` of this provider. - int get first; - - /// The parameter `second` of this provider. - String? get second; - - /// The parameter `third` of this provider. - double get third; - - /// The parameter `fourth` of this provider. - bool get fourth; - - /// The parameter `fifth` of this provider. - List? get fifth; -} - -class _FamilyProviderElement extends FutureProviderElement - with FamilyRef { - _FamilyProviderElement(super.provider, super.container); - - @override - int get first => (origin as FamilyProvider).first; - @override - String? get second => (origin as FamilyProvider).second; - @override - double get third => (origin as FamilyProvider).third; - @override - bool get fourth => (origin as FamilyProvider).fourth; - @override - List? get fifth => (origin as FamilyProvider).fifth; -} - -String _$genericClassHash() => r'd3c4acc9cdae12f6c666fbf1f89aee212bb086db'; - -abstract class _$GenericClass - extends BuildlessAutoDisposeAsyncNotifier> { - FutureOr> build(); -} - -/// See also [GenericClass]. -@ProviderFor(GenericClass) -const genericClassProvider = GenericClassFamily(); - -/// See also [GenericClass]. -final class GenericClassFamily extends Family { - /// See also [GenericClass]. - const GenericClassFamily() - : super( - name: r'genericClassProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericClassHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [GenericClass]. - GenericClassProvider call() { - return GenericClassProvider(); - } - - @override - String toString() => 'genericClassProvider'; } -/// See also [GenericClass]. -final class GenericClassProvider - extends AutoDisposeAsyncNotifierProviderImpl, List> { - /// See also [GenericClass]. - GenericClassProvider() - : this._internal( - GenericClass.new, - argument: (), - ); +String _$publicHash() => r'9d99b79c013da13926d4ad89c72ebca4fc1cc257'; +typedef _PrivateRef = Ref>; - GenericClassProvider._internal( - super.create, { - required () super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericClassHash, - from: genericClassProvider, - name: r'genericClassProvider', +const _privateProvider = _PrivateProvider._(); + +final class _PrivateProvider extends $FunctionalProvider, + FutureOr, _PrivateRef> + with $FutureModifier, $FutureProvider { + const _PrivateProvider._({ + FutureOr Function( + _PrivateRef ref, + )? create, + }) : _createCb = create, + super( + debugGetCreateSourceHash: _$privateHash, + name: r'_private', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, + from: null, + argument: null, ); - @override - FutureOr> runNotifierBuild( - covariant GenericClass notifier, - ) { - return notifier.build(); - } + final FutureOr Function( + _PrivateRef ref, + )? _createCb; - @internal @override - AutoDisposeAsyncNotifierProviderImpl copyWithBuild( - GenericClass Function() create, - ) { - return AutoDisposeAsyncNotifierProviderImpl._internal( - create, + FutureOr create(_PrivateRef ref) { + final fn = _createCb ?? _private; + + return fn( + ref, ); } @override - _GenericClassProviderElement createElement( - ProviderContainer container, - ) { - return _GenericClassProviderElement(this, container); - } + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); - @internal @override - GenericClassProvider copyWithCreate( - GenericClass Function() create, + _PrivateProvider copyWithCreate( + FutureOr Function( + _PrivateRef ref, + ) create, ) { - return GenericClassProvider._internal( - () => create(), - argument: argument as (), + return _PrivateProvider._( + create: create, ); } - - @override - bool operator ==(Object other) { - return other is GenericClassProvider && - other.runtimeType == runtimeType && - other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'genericClassProvider<$T>$argument'; -} - -mixin GenericClassRef on AutoDisposeAsyncNotifierProviderRef {} - -class _GenericClassProviderElement - extends AutoDisposeAsyncNotifierProviderElement, List> - with GenericClassRef { - _GenericClassProviderElement(super.provider, super.container); -} - -String _$publicClassHash() => r'e9bc69e44b72e8ed77d423524c0d74ad460d629d'; - -/// See also [PublicClass]. -@ProviderFor(PublicClass) -final publicClassProvider = AsyncNotifierProvider.internal( - PublicClass.new, - name: r'publicClassProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$publicClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$PublicClass = AsyncNotifier; -String _$privateClassHash() => r'7e69cffe8315999710e4cb6bb3de9f179d3f2f5d'; - -/// See also [_PrivateClass]. -@ProviderFor(_PrivateClass) -final _privateClassProvider = - AsyncNotifierProvider<_PrivateClass, String>.internal( - _PrivateClass.new, - name: r'_privateClassProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$privateClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$PrivateClass = AsyncNotifier; -String _$familyOrClassHash() => r'b4882d4e79a03c63005d35eb7a021c9c4373a8d9'; - -abstract class _$FamilyOrClass - extends BuildlessAutoDisposeAsyncNotifier { - late final int first; - - FutureOr build( - int first, - ); } -/// See also [FamilyOrClass]. -@ProviderFor(FamilyOrClass) -const familyOrClassProvider = FamilyOrClassFamily(); +String _$privateHash() => r'bc0469a9315de114a0ccd82c7db4980844d0009f'; +typedef FamilyOrRef = Ref>; -/// See also [FamilyOrClass]. -final class FamilyOrClassFamily extends Family { - /// See also [FamilyOrClass]. - const FamilyOrClassFamily() +final class FamilyOrFamily extends Family { + const FamilyOrFamily._() : super( - name: r'familyOrClassProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyOrClassHash, + name: r'familyOr', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$familyOrHash, isAutoDispose: true, ); - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [FamilyOrClass]. - FamilyOrClassProvider call( + FamilyOrProvider call( int first, - ) { - return FamilyOrClassProvider( - first, - ); - } + ) => + FamilyOrProvider._(argument: (first,), from: this); @override - String toString() => 'familyOrClassProvider'; + String toString() => r'familyOr'; } -/// See also [FamilyOrClass]. -final class FamilyOrClassProvider - extends AutoDisposeAsyncNotifierProviderImpl { - /// See also [FamilyOrClass]. - FamilyOrClassProvider( - int first, - ) : this._internal( - () => FamilyOrClass()..first = first, - argument: (first,), - ); - - FamilyOrClassProvider._internal( - super.create, { +const familyOrProvider = FamilyOrFamily._(); + +final class FamilyOrProvider extends $FunctionalProvider, + FutureOr, FamilyOrRef> + with $FutureModifier, $FutureProvider { + const FamilyOrProvider._({ + FutureOr Function( + FamilyOrRef ref, + int first, + )? create, + required FamilyOrFamily super.from, required (int,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyOrClassHash, - from: familyOrClassProvider, - name: r'familyOrClassProvider', + }) : _createCb = create, + super( + debugGetCreateSourceHash: _$familyOrHash, + name: r'familyOr', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - @override - FutureOr runNotifierBuild( - covariant FamilyOrClass notifier, - ) { - return notifier.build( - first, - ); - } + final FutureOr Function( + FamilyOrRef ref, + int first, + )? _createCb; - @internal @override - AutoDisposeAsyncNotifierProviderImpl copyWithBuild( - FamilyOrClass Function() create, - ) { - return AutoDisposeAsyncNotifierProviderImpl._internal( - create, - first: first, + FutureOr create(FamilyOrRef ref) { + final fn = _createCb ?? familyOr; + final (int,) argument = this.argument! as (int,); + return fn( + ref, + argument.$1, ); } @override - _FamilyOrClassProviderElement createElement( - ProviderContainer container, - ) { - return _FamilyOrClassProviderElement(this, container); - } + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); - @internal @override - FamilyOrClassProvider copyWithCreate( - FamilyOrClass Function() create, + FamilyOrProvider copyWithCreate( + FutureOr Function( + FamilyOrRef ref, + ) create, ) { - return FamilyOrClassProvider._internal( - () => create()..first = first, - argument: argument as (int,), + return FamilyOrProvider._( + create: ( + ref, + int first, + ) => + create(ref), + argument: argument! as (int,), + from: from! as FamilyOrFamily, ); } @override bool operator ==(Object other) { - return other is FamilyOrClassProvider && other.argument == argument; + return other is FamilyOrProvider && other.argument == argument; } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'familyOrClassProvider$argument'; } -mixin FamilyOrClassRef on AutoDisposeAsyncNotifierProviderRef { - /// The parameter `first` of this provider. - int get first; -} - -class _FamilyOrClassProviderElement - extends AutoDisposeAsyncNotifierProviderElement - with FamilyOrClassRef { - _FamilyOrClassProviderElement(super.provider, super.container); - - @override - int get first => (origin as FamilyOrClassProvider).first; -} - -String _$familyClassHash() => r'b7e3ca6091f12bbc99972e961acd885e05f42a15'; - -abstract class _$FamilyClass extends BuildlessAutoDisposeAsyncNotifier { - late final int first; - late final String? second; - late final double third; - late final bool fourth; - late final List? fifth; - - FutureOr build( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }); -} - -/// See also [FamilyClass]. -@ProviderFor(FamilyClass) -const familyClassProvider = FamilyClassFamily(); +String _$familyOrHash() => r'1c3217e296b0ce52c07c18769d1fffb95850f482'; +typedef FamilyRef = Ref>; -/// See also [FamilyClass]. -final class FamilyClassFamily extends Family { - /// See also [FamilyClass]. - const FamilyClassFamily() +final class FamilyFamily extends Family { + const FamilyFamily._() : super( - name: r'familyClassProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyClassHash, + name: r'family', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$familyHash, isAutoDispose: true, ); - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [FamilyClass]. - FamilyClassProvider call( + FamilyProvider call( int first, { String? second, required double third, bool fourth = true, List? fifth, - }) { - return FamilyClassProvider( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ); - } + }) => + FamilyProvider._(argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), from: this); @override - String toString() => 'familyClassProvider'; + String toString() => r'family'; } -/// See also [FamilyClass]. -final class FamilyClassProvider - extends AutoDisposeAsyncNotifierProviderImpl { - /// See also [FamilyClass]. - FamilyClassProvider( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) : this._internal( - () => FamilyClass() - ..first = first - ..second = second - ..third = third - ..fourth = fourth - ..fifth = fifth, - argument: ( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - ); +const familyProvider = FamilyFamily._(); - FamilyClassProvider._internal( - super.create, { +final class FamilyProvider + extends $FunctionalProvider, FutureOr, FamilyRef> + with $FutureModifier, $FutureProvider { + const FamilyProvider._({ + FutureOr Function( + FamilyRef ref, + int first, { + String? second, + required double third, + bool fourth, + List? fifth, + })? create, + required FamilyFamily super.from, required ( int, { String? second, @@ -824,119 +325,96 @@ final class FamilyClassProvider List? fifth, }) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyClassHash, - from: familyClassProvider, - name: r'familyClassProvider', + }) : _createCb = create, + super( + debugGetCreateSourceHash: _$familyHash, + name: r'family', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - @override - FutureOr runNotifierBuild( - covariant FamilyClass notifier, - ) { - return notifier.build( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ); - } + final FutureOr Function( + FamilyRef ref, + int first, { + String? second, + required double third, + bool fourth, + List? fifth, + })? _createCb; - @internal @override - AutoDisposeAsyncNotifierProviderImpl copyWithBuild( - FamilyClass Function() create, - ) { - return AutoDisposeAsyncNotifierProviderImpl._internal( - create, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, + FutureOr create(FamilyRef ref) { + final fn = _createCb ?? family; + final ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) argument = this.argument! as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + return fn( + ref, + argument.$1, + second: argument.second, + third: argument.third, + fourth: argument.fourth, + fifth: argument.fifth, ); } @override - _FamilyClassProviderElement createElement( - ProviderContainer container, - ) { - return _FamilyClassProviderElement(this, container); - } + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); - @internal @override - FamilyClassProvider copyWithCreate( - FamilyClass Function() create, + FamilyProvider copyWithCreate( + FutureOr Function( + FamilyRef ref, + ) create, ) { - return FamilyClassProvider._internal( - () => create() - ..first = first - ..second = second - ..third = third - ..fourth = fourth - ..fifth = fifth, - argument: argument as ( + return FamilyProvider._( + create: ( + ref, + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) => + create(ref), + argument: argument! as ( int, { String? second, double third, bool fourth, List? fifth, }), + from: from! as FamilyFamily, ); } @override bool operator ==(Object other) { - return other is FamilyClassProvider && other.argument == argument; + return other is FamilyProvider && other.argument == argument; } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'familyClassProvider$argument'; } -mixin FamilyClassRef on AutoDisposeAsyncNotifierProviderRef { - /// The parameter `first` of this provider. - int get first; - - /// The parameter `second` of this provider. - String? get second; - - /// The parameter `third` of this provider. - double get third; - - /// The parameter `fourth` of this provider. - bool get fourth; - - /// The parameter `fifth` of this provider. - List? get fifth; -} - -class _FamilyClassProviderElement - extends AutoDisposeAsyncNotifierProviderElement - with FamilyClassRef { - _FamilyClassProviderElement(super.provider, super.container); - - @override - int get first => (origin as FamilyClassProvider).first; - @override - String? get second => (origin as FamilyClassProvider).second; - @override - double get third => (origin as FamilyClassProvider).third; - @override - bool get fourth => (origin as FamilyClassProvider).fourth; - @override - List? get fifth => (origin as FamilyClassProvider).fifth; -} +String _$familyHash() => r'eb6fad35a94d4238b621c2100253ee2c700bee77'; +const genericClassProvider = GenericClassFamily._(); +String _$genericClassHash() => r'd3c4acc9cdae12f6c666fbf1f89aee212bb086db'; +String _$publicClassHash() => r'e9bc69e44b72e8ed77d423524c0d74ad460d629d'; +String _$privateClassHash() => r'7e69cffe8315999710e4cb6bb3de9f179d3f2f5d'; +const familyOrClassProvider = FamilyOrClassFamily._(); +String _$familyOrClassHash() => r'b4882d4e79a03c63005d35eb7a021c9c4373a8d9'; +const familyClassProvider = FamilyClassFamily._(); +String _$familyClassHash() => r'b7e3ca6091f12bbc99972e961acd885e05f42a15'; +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/auto_dispose.dart b/packages/riverpod_generator/test/integration/auto_dispose.dart index a63f1ce0e..f8e0aeb6d 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.dart @@ -1,14 +1,14 @@ -import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:riverpod_annotation/riverpod_annotation.dart'; -part 'auto_dispose.g.dart'; +// // part 'auto_dispose.g.dart'; -@Riverpod(keepAlive: true) -int keepAlive(KeepAliveRef ref) { - return 0; -} +// @Riverpod(keepAlive: true) +// int keepAlive(KeepAliveRef ref) { +// return 0; +// } -@Riverpod(keepAlive: false) -int notKeepAlive(NotKeepAliveRef ref) { - ref.keepAlive(); - return 0; -} +// @Riverpod(keepAlive: false) +// int notKeepAlive(NotKeepAliveRef ref) { +// ref.keepAlive(); +// return 0; +// } diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart deleted file mode 100644 index a5e1a26d3..000000000 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ /dev/null @@ -1,43 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'auto_dispose.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -String _$keepAliveHash() => r'72dd192676126d487c24c7695a91d59410c62696'; - -/// See also [keepAlive]. -@ProviderFor(keepAlive) -final keepAliveProvider = Provider.internal( - keepAlive, - name: r'keepAliveProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$keepAliveHash, - from: null, - argument: null, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef KeepAliveRef = Ref; -String _$notKeepAliveHash() => r'1ccc497d7c651f8e730ec1bcecf271ffe9615d83'; - -/// See also [notKeepAlive]. -@ProviderFor(notKeepAlive) -final notKeepAliveProvider = Provider.internal( - notKeepAlive, - name: r'notKeepAliveProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$notKeepAliveHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef NotKeepAliveRef = Ref; -// ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/dependencies.dart b/packages/riverpod_generator/test/integration/dependencies.dart index b90e3d13e..7e13a9c45 100644 --- a/packages/riverpod_generator/test/integration/dependencies.dart +++ b/packages/riverpod_generator/test/integration/dependencies.dart @@ -1,65 +1,65 @@ -import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:riverpod_annotation/riverpod_annotation.dart'; -part 'dependencies.g.dart'; +// // part 'dependencies.g.dart'; -@riverpod -int dep(DepRef ref) => 0; +// @riverpod +// int dep(DepRef ref) => 0; -@riverpod -int family(DepRef ref, int id) => 0; +// @riverpod +// int family(DepRef ref, int id) => 0; -@riverpod -class Dep2 extends _$Dep2 { - @override - int build() => 0; -} +// @riverpod +// class Dep2 extends _$Dep2 { +// @override +// int build() => 0; +// } -@riverpod -class Family2 extends _$Family2 { - @override - int build(int id) => 0; -} +// @riverpod +// class Family2 extends _$Family2 { +// @override +// int build(int id) => 0; +// } -@Riverpod(dependencies: [dep, family, Dep2, Family2]) -int provider(ProviderRef ref) => 0; +// @Riverpod(dependencies: [dep, family, Dep2, Family2]) +// int provider(ProviderRef ref) => 0; -@Riverpod(dependencies: [dep, family, Dep2, Family2]) -int provider2(Provider2Ref ref) => 0; +// @Riverpod(dependencies: [dep, family, Dep2, Family2]) +// int provider2(Provider2Ref ref) => 0; -@Riverpod(dependencies: [dep, family, Dep2, Family2]) -class Provider3 extends _$Provider3 { - @override - int build() => 0; -} +// @Riverpod(dependencies: [dep, family, Dep2, Family2]) +// class Provider3 extends _$Provider3 { +// @override +// int build() => 0; +// } -@Riverpod(dependencies: [dep, family, Dep2, Family2]) -class Provider4 extends _$Provider4 { - @override - int build(int id) => 0; -} +// @Riverpod(dependencies: [dep, family, Dep2, Family2]) +// class Provider4 extends _$Provider4 { +// @override +// int build(int id) => 0; +// } -@Riverpod(dependencies: [provider]) -int transitiveDependencies(TransitiveDependenciesRef ref) => 0; +// @Riverpod(dependencies: [provider]) +// int transitiveDependencies(TransitiveDependenciesRef ref) => 0; -@Riverpod(dependencies: [dep, family, Dep2]) -int smallTransitiveDependencyCount(SmallTransitiveDependencyCountRef ref) => 0; +// @Riverpod(dependencies: [dep, family, Dep2]) +// int smallTransitiveDependencyCount(SmallTransitiveDependencyCountRef ref) => 0; -@Riverpod(dependencies: []) -int emptyDependenciesFunctional(EmptyDependenciesFunctionalRef ref) => 0; +// @Riverpod(dependencies: []) +// int emptyDependenciesFunctional(EmptyDependenciesFunctionalRef ref) => 0; -@Riverpod(dependencies: []) -class EmptyDependenciesClassBased extends _$EmptyDependenciesClassBased { - @override - int build() => 0; -} +// @Riverpod(dependencies: []) +// class EmptyDependenciesClassBased extends _$EmptyDependenciesClassBased { +// @override +// int build() => 0; +// } -@Riverpod(dependencies: [_privateDep, publicDep]) -int providerWithDependencies(ProviderWithDependenciesRef ref) { - return 0; -} +// @Riverpod(dependencies: [_privateDep, publicDep]) +// int providerWithDependencies(ProviderWithDependenciesRef ref) { +// return 0; +// } -@riverpod -int _privateDep(_PrivateDepRef ref) => 0; +// @riverpod +// int _privateDep(_PrivateDepRef ref) => 0; -@riverpod -int publicDep(PublicDepRef ref) => 0; +// @riverpod +// int publicDep(PublicDepRef ref) => 0; diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart deleted file mode 100644 index 647389129..000000000 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ /dev/null @@ -1,697 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'dependencies.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -String _$depHash() => r'2213a401e03a1a914579b4a3a7707b783de9efba'; - -/// See also [dep]. -@ProviderFor(dep) -final depProvider = Provider.internal( - dep, - name: r'depProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$depHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef DepRef = Ref; -String _$familyHash() => r'8c228ff14b8c6cf1f3d4d6266232d64b5057c440'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [family]. -@ProviderFor(family) -const familyProvider = FamilyFamily(); - -/// See also [family]. -final class FamilyFamily extends Family { - /// See also [family]. - const FamilyFamily() - : super( - name: r'familyProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [family]. - FamilyProvider call( - int id, - ) { - return FamilyProvider( - id, - ); - } - - @override - String toString() => 'familyProvider'; -} - -/// See also [family]. -final class FamilyProvider extends Provider { - /// See also [family]. - FamilyProvider( - int id, - ) : this._internal( - (ref) => family( - ref as FamilyRef, - id, - ), - argument: (id,), - ); - - FamilyProvider._internal( - super.create, { - required (int,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyHash, - from: familyProvider, - name: r'familyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _FamilyProviderElement createElement( - ProviderContainer container, - ) { - return _FamilyProviderElement(this, container); - } - - @internal - @override - FamilyProvider copyWithCreate( - int Function(FamilyRef ref) create, - ) { - return FamilyProvider._internal( - (ref) => create(ref as FamilyRef), - argument: argument as (int,), - ); - } - - @override - bool operator ==(Object other) { - return other is FamilyProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'familyProvider$argument'; -} - -mixin FamilyRef on Ref { - /// The parameter `id` of this provider. - int get id; -} - -class _FamilyProviderElement extends ProviderElement with FamilyRef { - _FamilyProviderElement(super.provider, super.container); - - @override - int get id => (origin as FamilyProvider).id; -} - -String _$providerHash() => r'6c9184ef4c6a410a2132e1ecc13a2e646e936d37'; - -/// See also [provider]. -@ProviderFor(provider) -final providerProvider = Provider.internal( - provider, - name: r'providerProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$providerHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: { - depProvider, - familyProvider, - dep2Provider, - family2Provider - }, - allTransitiveDependencies: { - depProvider, - ...?depProvider.allTransitiveDependencies, - familyProvider, - ...?familyProvider.allTransitiveDependencies, - dep2Provider, - ...?dep2Provider.allTransitiveDependencies, - family2Provider, - ...?family2Provider.allTransitiveDependencies - }, -); - -typedef ProviderRef = Ref; -String _$provider2Hash() => r'70d908579c5e64ce6558b42f433adfb80f4dc79b'; - -/// See also [provider2]. -@ProviderFor(provider2) -final provider2Provider = Provider.internal( - provider2, - name: r'provider2Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$provider2Hash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: { - depProvider, - familyProvider, - dep2Provider, - family2Provider - }, - allTransitiveDependencies: { - depProvider, - ...?depProvider.allTransitiveDependencies, - familyProvider, - ...?familyProvider.allTransitiveDependencies, - dep2Provider, - ...?dep2Provider.allTransitiveDependencies, - family2Provider, - ...?family2Provider.allTransitiveDependencies - }, -); - -typedef Provider2Ref = Ref; -String _$transitiveDependenciesHash() => - r'9c81823224bb28a5dc482328c04ce76293370877'; - -/// See also [transitiveDependencies]. -@ProviderFor(transitiveDependencies) -final transitiveDependenciesProvider = Provider.internal( - transitiveDependencies, - name: r'transitiveDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$transitiveDependenciesHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: [providerProvider], - allTransitiveDependencies: { - providerProvider, - ...?providerProvider.allTransitiveDependencies - }, -); - -typedef TransitiveDependenciesRef = Ref; -String _$smallTransitiveDependencyCountHash() => - r'34689e1ba57e2959975cbf8ebd6c9483f4652a73'; - -/// See also [smallTransitiveDependencyCount]. -@ProviderFor(smallTransitiveDependencyCount) -final smallTransitiveDependencyCountProvider = Provider.internal( - smallTransitiveDependencyCount, - name: r'smallTransitiveDependencyCountProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$smallTransitiveDependencyCountHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: [depProvider, familyProvider, dep2Provider], - allTransitiveDependencies: { - depProvider, - ...?depProvider.allTransitiveDependencies, - familyProvider, - ...?familyProvider.allTransitiveDependencies, - dep2Provider, - ...?dep2Provider.allTransitiveDependencies - }, -); - -typedef SmallTransitiveDependencyCountRef = Ref; -String _$emptyDependenciesFunctionalHash() => - r'592bebd079450e2071fb12d68c3ae333d5c28359'; - -/// See also [emptyDependenciesFunctional]. -@ProviderFor(emptyDependenciesFunctional) -final emptyDependenciesFunctionalProvider = Provider.internal( - emptyDependenciesFunctional, - name: r'emptyDependenciesFunctionalProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$emptyDependenciesFunctionalHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef EmptyDependenciesFunctionalRef = Ref; -String _$providerWithDependenciesHash() => - r'beecbe7a41b647ab92367dbcc12055bcd6345af7'; - -/// See also [providerWithDependencies]. -@ProviderFor(providerWithDependencies) -final providerWithDependenciesProvider = Provider.internal( - providerWithDependencies, - name: r'providerWithDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$providerWithDependenciesHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: [_privateDepProvider, publicDepProvider], - allTransitiveDependencies: { - _privateDepProvider, - ...?_privateDepProvider.allTransitiveDependencies, - publicDepProvider, - ...?publicDepProvider.allTransitiveDependencies - }, -); - -typedef ProviderWithDependenciesRef = Ref; -String _$privateDepHash() => r'f610d91bd39e0dcffe6ff4e74160964a291289d9'; - -/// See also [_privateDep]. -@ProviderFor(_privateDep) -final _privateDepProvider = Provider.internal( - _privateDep, - name: r'_privateDepProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$privateDepHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _PrivateDepRef = Ref; -String _$publicDepHash() => r'bcb69aace017c86c3c4b8eccf59fa22d010834bc'; - -/// See also [publicDep]. -@ProviderFor(publicDep) -final publicDepProvider = Provider.internal( - publicDep, - name: r'publicDepProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$publicDepHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef PublicDepRef = Ref; -String _$dep2Hash() => r'2778537df77f6431148c2ce400724da3e2ab4b94'; - -/// See also [Dep2]. -@ProviderFor(Dep2) -final dep2Provider = NotifierProvider.internal( - Dep2.new, - name: r'dep2Provider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$dep2Hash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Dep2 = Notifier; -String _$family2Hash() => r'ce727b262aae067b0d4f703f03670abb70ad8977'; - -abstract class _$Family2 extends BuildlessAutoDisposeNotifier { - late final int id; - - int build( - int id, - ); -} - -/// See also [Family2]. -@ProviderFor(Family2) -const family2Provider = Family2Family(); - -/// See also [Family2]. -final class Family2Family extends Family { - /// See also [Family2]. - const Family2Family() - : super( - name: r'family2Provider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$family2Hash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [Family2]. - Family2Provider call( - int id, - ) { - return Family2Provider( - id, - ); - } - - @override - String toString() => 'family2Provider'; -} - -/// See also [Family2]. -final class Family2Provider - extends AutoDisposeNotifierProviderImpl { - /// See also [Family2]. - Family2Provider( - int id, - ) : this._internal( - () => Family2()..id = id, - argument: (id,), - ); - - Family2Provider._internal( - super.create, { - required (int,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$family2Hash, - from: family2Provider, - name: r'family2Provider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - int runNotifierBuild( - covariant Family2 notifier, - ) { - return notifier.build( - id, - ); - } - - @internal - @override - AutoDisposeNotifierProviderImpl copyWithBuild( - Family2 Function() create, - ) { - return AutoDisposeNotifierProviderImpl._internal( - create, - id: id, - ); - } - - @override - _Family2ProviderElement createElement( - ProviderContainer container, - ) { - return _Family2ProviderElement(this, container); - } - - @internal - @override - Family2Provider copyWithCreate( - Family2 Function() create, - ) { - return Family2Provider._internal( - () => create()..id = id, - argument: argument as (int,), - ); - } - - @override - bool operator ==(Object other) { - return other is Family2Provider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'family2Provider$argument'; -} - -mixin Family2Ref on AutoDisposeNotifierProviderRef { - /// The parameter `id` of this provider. - int get id; -} - -class _Family2ProviderElement - extends AutoDisposeNotifierProviderElement with Family2Ref { - _Family2ProviderElement(super.provider, super.container); - - @override - int get id => (origin as Family2Provider).id; -} - -String _$provider3Hash() => r'dfdd6dec6cfee543c73d99593ce98d68f4db385c'; - -/// See also [Provider3]. -@ProviderFor(Provider3) -final provider3Provider = NotifierProvider.internal( - Provider3.new, - name: r'provider3Provider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$provider3Hash, - dependencies: { - depProvider, - familyProvider, - dep2Provider, - family2Provider - }, - allTransitiveDependencies: { - depProvider, - ...?depProvider.allTransitiveDependencies, - familyProvider, - ...?familyProvider.allTransitiveDependencies, - dep2Provider, - ...?dep2Provider.allTransitiveDependencies, - family2Provider, - ...?family2Provider.allTransitiveDependencies - }, -); - -typedef _$Provider3 = Notifier; -String _$provider4Hash() => r'1c955214d99695bb694c96374b277aac58e734df'; - -abstract class _$Provider4 extends BuildlessAutoDisposeNotifier { - late final int id; - - int build( - int id, - ); -} - -/// See also [Provider4]. -@ProviderFor(Provider4) -const provider4Provider = Provider4Family(); - -/// See also [Provider4]. -final class Provider4Family extends Family { - /// See also [Provider4]. - const Provider4Family() - : super( - name: r'provider4Provider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$provider4Hash, - isAutoDispose: true, - ); - - static final Iterable _dependencies = { - depProvider, - familyProvider, - dep2Provider, - family2Provider - }; - - static final Iterable _allTransitiveDependencies = - { - depProvider, - ...?depProvider.allTransitiveDependencies, - familyProvider, - ...?familyProvider.allTransitiveDependencies, - dep2Provider, - ...?dep2Provider.allTransitiveDependencies, - family2Provider, - ...?family2Provider.allTransitiveDependencies - }; - - /// See also [Provider4]. - Provider4Provider call( - int id, - ) { - return Provider4Provider( - id, - ); - } - - @override - String toString() => 'provider4Provider'; -} - -/// See also [Provider4]. -final class Provider4Provider - extends AutoDisposeNotifierProviderImpl { - /// See also [Provider4]. - Provider4Provider( - int id, - ) : this._internal( - () => Provider4()..id = id, - argument: (id,), - ); - - Provider4Provider._internal( - super.create, { - required (int,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$provider4Hash, - from: provider4Provider, - name: r'provider4Provider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - int runNotifierBuild( - covariant Provider4 notifier, - ) { - return notifier.build( - id, - ); - } - - @internal - @override - AutoDisposeNotifierProviderImpl copyWithBuild( - Provider4 Function() create, - ) { - return AutoDisposeNotifierProviderImpl._internal( - create, - id: id, - ); - } - - @override - _Provider4ProviderElement createElement( - ProviderContainer container, - ) { - return _Provider4ProviderElement(this, container); - } - - @internal - @override - Provider4Provider copyWithCreate( - Provider4 Function() create, - ) { - return Provider4Provider._internal( - () => create()..id = id, - argument: argument as (int,), - ); - } - - @override - bool operator ==(Object other) { - return other is Provider4Provider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'provider4Provider$argument'; -} - -mixin Provider4Ref on AutoDisposeNotifierProviderRef { - /// The parameter `id` of this provider. - int get id; -} - -class _Provider4ProviderElement - extends AutoDisposeNotifierProviderElement - with Provider4Ref { - _Provider4ProviderElement(super.provider, super.container); - - @override - int get id => (origin as Provider4Provider).id; -} - -String _$emptyDependenciesClassBasedHash() => - r'e20c18353984a81977b656e9879b3841dbaedc6c'; - -/// See also [EmptyDependenciesClassBased]. -@ProviderFor(EmptyDependenciesClassBased) -final emptyDependenciesClassBasedProvider = - NotifierProvider.internal( - EmptyDependenciesClassBased.new, - name: r'emptyDependenciesClassBasedProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$emptyDependenciesClassBasedHash, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef _$EmptyDependenciesClassBased = Notifier; -// ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/dependencies2.dart b/packages/riverpod_generator/test/integration/dependencies2.dart index 59c79f9b4..7f195b67d 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.dart @@ -1,34 +1,34 @@ -import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:riverpod_annotation/riverpod_annotation.dart'; -import 'dependencies.dart'; +// import 'dependencies.dart'; -part 'dependencies2.g.dart'; +// part 'dependencies2.g.dart'; -// Regression test for https://github.com/rrousselGit/riverpod/issues/2490 -@Riverpod(dependencies: [providerWithDependencies, _private2, public2]) -int providerWithDependencies2(ProviderWithDependencies2Ref ref) { - return 0; -} +// // Regression test for https://github.com/rrousselGit/riverpod/issues/2490 +// @Riverpod(dependencies: [providerWithDependencies, _private2, public2]) +// int providerWithDependencies2(ProviderWithDependencies2Ref ref) { +// return 0; +// } -@Riverpod(dependencies: [providerWithDependencies, _private2, public2]) -int familyWithDependencies2(ProviderWithDependencies2Ref ref, {int? id}) { - return 0; -} +// @Riverpod(dependencies: [providerWithDependencies, _private2, public2]) +// int familyWithDependencies2(ProviderWithDependencies2Ref ref, {int? id}) { +// return 0; +// } -@Riverpod(dependencies: [providerWithDependencies, _private2, public2]) -class NotifierWithDependencies extends _$NotifierWithDependencies { - @override - int build() => 0; -} +// @Riverpod(dependencies: [providerWithDependencies, _private2, public2]) +// class NotifierWithDependencies extends _$NotifierWithDependencies { +// @override +// int build() => 0; +// } -@Riverpod(dependencies: [providerWithDependencies, _private2, public2]) -class NotifierFamilyWithDependencies extends _$NotifierFamilyWithDependencies { - @override - int build({int? id}) => 0; -} +// @Riverpod(dependencies: [providerWithDependencies, _private2, public2]) +// class NotifierFamilyWithDependencies extends _$NotifierFamilyWithDependencies { +// @override +// int build({int? id}) => 0; +// } -@riverpod -int _private2(_Private2Ref ref) => 0; +// @riverpod +// int _private2(_Private2Ref ref) => 0; -@riverpod -int public2(Public2Ref ref) => 0; +// @riverpod +// int public2(Public2Ref ref) => 0; diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart deleted file mode 100644 index 3e86f70d1..000000000 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ /dev/null @@ -1,412 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'dependencies2.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -String _$providerWithDependencies2Hash() => - r'90e090d5fa759369dceb59b2d2e219f67ed5f9e0'; - -/// See also [providerWithDependencies2]. -@ProviderFor(providerWithDependencies2) -final providerWithDependencies2Provider = Provider.internal( - providerWithDependencies2, - name: r'providerWithDependencies2Provider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$providerWithDependencies2Hash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: [ - providerWithDependenciesProvider, - _private2Provider, - public2Provider - ], - allTransitiveDependencies: { - providerWithDependenciesProvider, - ...?providerWithDependenciesProvider.allTransitiveDependencies, - _private2Provider, - ...?_private2Provider.allTransitiveDependencies, - public2Provider, - ...?public2Provider.allTransitiveDependencies - }, -); - -typedef ProviderWithDependencies2Ref = Ref; -String _$familyWithDependencies2Hash() => - r'209b9e3ed4e5fad89572268d161fbe64a6ef0e87'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [familyWithDependencies2]. -@ProviderFor(familyWithDependencies2) -const familyWithDependencies2Provider = FamilyWithDependencies2Family(); - -/// See also [familyWithDependencies2]. -final class FamilyWithDependencies2Family extends Family { - /// See also [familyWithDependencies2]. - const FamilyWithDependencies2Family() - : super( - name: r'familyWithDependencies2Provider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyWithDependencies2Hash, - isAutoDispose: true, - ); - - static final Iterable _dependencies = [ - providerWithDependenciesProvider, - _private2Provider, - public2Provider - ]; - - static final Iterable _allTransitiveDependencies = - { - providerWithDependenciesProvider, - ...?providerWithDependenciesProvider.allTransitiveDependencies, - _private2Provider, - ...?_private2Provider.allTransitiveDependencies, - public2Provider, - ...?public2Provider.allTransitiveDependencies - }; - - /// See also [familyWithDependencies2]. - FamilyWithDependencies2Provider call({ - int? id, - }) { - return FamilyWithDependencies2Provider( - id: id, - ); - } - - @override - String toString() => 'familyWithDependencies2Provider'; -} - -/// See also [familyWithDependencies2]. -final class FamilyWithDependencies2Provider extends Provider { - /// See also [familyWithDependencies2]. - FamilyWithDependencies2Provider({ - int? id, - }) : this._internal( - (ref) => familyWithDependencies2( - ref as FamilyWithDependencies2Ref, - id: id, - ), - argument: (id: id,), - ); - - FamilyWithDependencies2Provider._internal( - super.create, { - required ({ - int? id, - }) - super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyWithDependencies2Hash, - from: familyWithDependencies2Provider, - name: r'familyWithDependencies2Provider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _FamilyWithDependencies2ProviderElement createElement( - ProviderContainer container, - ) { - return _FamilyWithDependencies2ProviderElement(this, container); - } - - @internal - @override - FamilyWithDependencies2Provider copyWithCreate( - int Function(FamilyWithDependencies2Ref ref) create, - ) { - return FamilyWithDependencies2Provider._internal( - (ref) => create(ref as FamilyWithDependencies2Ref), - argument: argument as ({ - int? id, - }), - ); - } - - @override - bool operator ==(Object other) { - return other is FamilyWithDependencies2Provider && - other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'familyWithDependencies2Provider$argument'; -} - -mixin FamilyWithDependencies2Ref on Ref { - /// The parameter `id` of this provider. - int? get id; -} - -class _FamilyWithDependencies2ProviderElement extends ProviderElement - with FamilyWithDependencies2Ref { - _FamilyWithDependencies2ProviderElement(super.provider, super.container); - - @override - int? get id => (origin as FamilyWithDependencies2Provider).id; -} - -String _$private2Hash() => r'5e0fa14ff40fb444c027ed25150a42362db3ef19'; - -/// See also [_private2]. -@ProviderFor(_private2) -final _private2Provider = Provider.internal( - _private2, - name: r'_private2Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$private2Hash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _Private2Ref = Ref; -String _$public2Hash() => r'9767255f0182589fe48b29d217dd488b0a13b9d5'; - -/// See also [public2]. -@ProviderFor(public2) -final public2Provider = Provider.internal( - public2, - name: r'public2Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$public2Hash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef Public2Ref = Ref; -String _$notifierWithDependenciesHash() => - r'becc68e5a54b0cc2b8277a6d54b74edef93bfe89'; - -/// See also [NotifierWithDependencies]. -@ProviderFor(NotifierWithDependencies) -final notifierWithDependenciesProvider = - NotifierProvider.internal( - NotifierWithDependencies.new, - name: r'notifierWithDependenciesProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$notifierWithDependenciesHash, - dependencies: [ - providerWithDependenciesProvider, - _private2Provider, - public2Provider - ], - allTransitiveDependencies: { - providerWithDependenciesProvider, - ...?providerWithDependenciesProvider.allTransitiveDependencies, - _private2Provider, - ...?_private2Provider.allTransitiveDependencies, - public2Provider, - ...?public2Provider.allTransitiveDependencies - }, -); - -typedef _$NotifierWithDependencies = Notifier; -String _$notifierFamilyWithDependenciesHash() => - r'b185ba93857cd028964c1412e748ee887dbd45c8'; - -abstract class _$NotifierFamilyWithDependencies - extends BuildlessAutoDisposeNotifier { - late final int? id; - - int build({ - int? id, - }); -} - -/// See also [NotifierFamilyWithDependencies]. -@ProviderFor(NotifierFamilyWithDependencies) -const notifierFamilyWithDependenciesProvider = - NotifierFamilyWithDependenciesFamily(); - -/// See also [NotifierFamilyWithDependencies]. -final class NotifierFamilyWithDependenciesFamily extends Family { - /// See also [NotifierFamilyWithDependencies]. - const NotifierFamilyWithDependenciesFamily() - : super( - name: r'notifierFamilyWithDependenciesProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$notifierFamilyWithDependenciesHash, - isAutoDispose: true, - ); - - static final Iterable _dependencies = [ - providerWithDependenciesProvider, - _private2Provider, - public2Provider - ]; - - static final Iterable _allTransitiveDependencies = - { - providerWithDependenciesProvider, - ...?providerWithDependenciesProvider.allTransitiveDependencies, - _private2Provider, - ...?_private2Provider.allTransitiveDependencies, - public2Provider, - ...?public2Provider.allTransitiveDependencies - }; - - /// See also [NotifierFamilyWithDependencies]. - NotifierFamilyWithDependenciesProvider call({ - int? id, - }) { - return NotifierFamilyWithDependenciesProvider( - id: id, - ); - } - - @override - String toString() => 'notifierFamilyWithDependenciesProvider'; -} - -/// See also [NotifierFamilyWithDependencies]. -final class NotifierFamilyWithDependenciesProvider - extends AutoDisposeNotifierProviderImpl { - /// See also [NotifierFamilyWithDependencies]. - NotifierFamilyWithDependenciesProvider({ - int? id, - }) : this._internal( - () => NotifierFamilyWithDependencies()..id = id, - argument: (id: id,), - ); - - NotifierFamilyWithDependenciesProvider._internal( - super.create, { - required ({ - int? id, - }) - super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$notifierFamilyWithDependenciesHash, - from: notifierFamilyWithDependenciesProvider, - name: r'notifierFamilyWithDependenciesProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - int runNotifierBuild( - covariant NotifierFamilyWithDependencies notifier, - ) { - return notifier.build( - id: id, - ); - } - - @internal - @override - AutoDisposeNotifierProviderImpl copyWithBuild( - NotifierFamilyWithDependencies Function() create, - ) { - return AutoDisposeNotifierProviderImpl._internal( - create, - id: id, - ); - } - - @override - _NotifierFamilyWithDependenciesProviderElement createElement( - ProviderContainer container, - ) { - return _NotifierFamilyWithDependenciesProviderElement(this, container); - } - - @internal - @override - NotifierFamilyWithDependenciesProvider copyWithCreate( - NotifierFamilyWithDependencies Function() create, - ) { - return NotifierFamilyWithDependenciesProvider._internal( - () => create()..id = id, - argument: argument as ({ - int? id, - }), - ); - } - - @override - bool operator ==(Object other) { - return other is NotifierFamilyWithDependenciesProvider && - other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'notifierFamilyWithDependenciesProvider$argument'; -} - -mixin NotifierFamilyWithDependenciesRef on AutoDisposeNotifierProviderRef { - /// The parameter `id` of this provider. - int? get id; -} - -class _NotifierFamilyWithDependenciesProviderElement - extends AutoDisposeNotifierProviderElement with NotifierFamilyWithDependenciesRef { - _NotifierFamilyWithDependenciesProviderElement( - super.provider, super.container); - - @override - int? get id => (origin as NotifierFamilyWithDependenciesProvider).id; -} -// ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/generated.dart b/packages/riverpod_generator/test/integration/generated.dart index 2a117a8e6..e472d3b0d 100644 --- a/packages/riverpod_generator/test/integration/generated.dart +++ b/packages/riverpod_generator/test/integration/generated.dart @@ -1,83 +1,83 @@ -// ignore_for_file: library_private_types_in_public_api, inference_failure_on_function_return_type, always_declare_return_types, type_annotate_public_apis - -import 'package:freezed_annotation/freezed_annotation.dart'; -import 'package:riverpod/riverpod.dart' as r; -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -part 'generated.freezed.dart'; -part 'generated.g.dart'; - -@freezed -class Test with _$Test { - factory Test() = _Test; -} - -@riverpod -_Test generated(GeneratedRef ref) => _Test(); - -@riverpod -_Test generatedFamily(GeneratedFamilyRef ref, _Test test) => _Test(); - -@riverpod -class GeneratedClass extends _$GeneratedClass { - @override - _Test build() => _Test(); -} - -@riverpod -class GeneratedClassFamily extends _$GeneratedClassFamily { - @override - _Test build(_Test test) => _Test(); -} - -@riverpod -$dynamic($DynamicRef ref) => _Test(); - -@riverpod -$dynamicFamily($DynamicFamilyRef ref, test) => _Test(); - -@riverpod -class $DynamicClass extends _$$DynamicClass { - @override - build() => _Test(); -} - -@riverpod -class $DynamicClassFamily extends _$$DynamicClassFamily { - @override - build(test) => _Test(); -} - -@riverpod -_dynamic(_DynamicRef ref, test) => 0; - -@riverpod -r.AsyncValue alias(AliasRef ref) { - return const r.AsyncData(42); -} - -@riverpod -r.AsyncValue aliasFamily( - AliasFamilyRef ref, - r.AsyncValue test, -) { - return const r.AsyncData(42); -} - -@riverpod -class AliasClass extends _$AliasClass { - @override - r.AsyncValue build() { - return const r.AsyncData(42); - } -} - -@riverpod -class AliasClassFamily extends _$AliasClassFamily { - @override - r.AsyncValue build( - r.AsyncValue test, - ) { - return const r.AsyncData(42); - } -} +// // ignore_for_file: library_private_types_in_public_api, inference_failure_on_function_return_type, always_declare_return_types, type_annotate_public_apis + +// import 'package:freezed_annotation/freezed_annotation.dart'; +// import 'package:riverpod/riverpod.dart' as r; +// import 'package:riverpod_annotation/riverpod_annotation.dart'; + +// // part 'generated.freezed.dart'; +// // part 'generated.g.dart'; + +// @freezed +// class Test with _$Test { +// factory Test() = _Test; +// } + +// @riverpod +// _Test generated(GeneratedRef ref) => _Test(); + +// @riverpod +// _Test generatedFamily(GeneratedFamilyRef ref, _Test test) => _Test(); + +// @riverpod +// class GeneratedClass extends _$GeneratedClass { +// @override +// _Test build() => _Test(); +// } + +// @riverpod +// class GeneratedClassFamily extends _$GeneratedClassFamily { +// @override +// _Test build(_Test test) => _Test(); +// } + +// @riverpod +// $dynamic($DynamicRef ref) => _Test(); + +// @riverpod +// $dynamicFamily($DynamicFamilyRef ref, test) => _Test(); + +// @riverpod +// class $DynamicClass extends _$$DynamicClass { +// @override +// build() => _Test(); +// } + +// @riverpod +// class $DynamicClassFamily extends _$$DynamicClassFamily { +// @override +// build(test) => _Test(); +// } + +// @riverpod +// _dynamic(_DynamicRef ref, test) => 0; + +// @riverpod +// r.AsyncValue alias(AliasRef ref) { +// return const r.AsyncData(42); +// } + +// @riverpod +// r.AsyncValue aliasFamily( +// AliasFamilyRef ref, +// r.AsyncValue test, +// ) { +// return const r.AsyncData(42); +// } + +// @riverpod +// class AliasClass extends _$AliasClass { +// @override +// r.AsyncValue build() { +// return const r.AsyncData(42); +// } +// } + +// @riverpod +// class AliasClassFamily extends _$AliasClassFamily { +// @override +// r.AsyncValue build( +// r.AsyncValue test, +// ) { +// return const r.AsyncData(42); +// } +// } diff --git a/packages/riverpod_generator/test/integration/generated.freezed.dart b/packages/riverpod_generator/test/integration/generated.freezed.dart deleted file mode 100644 index 28fc84cf6..000000000 --- a/packages/riverpod_generator/test/integration/generated.freezed.dart +++ /dev/null @@ -1,74 +0,0 @@ -// coverage:ignore-file -// GENERATED CODE - DO NOT MODIFY BY HAND -// ignore_for_file: type=lint -// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark - -part of 'generated.dart'; - -// ************************************************************************** -// FreezedGenerator -// ************************************************************************** - -T _$identity(T value) => value; - -final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); - -/// @nodoc -mixin _$Test {} - -/// @nodoc -abstract class $TestCopyWith<$Res> { - factory $TestCopyWith(Test value, $Res Function(Test) then) = - _$TestCopyWithImpl<$Res, Test>; -} - -/// @nodoc -class _$TestCopyWithImpl<$Res, $Val extends Test> - implements $TestCopyWith<$Res> { - _$TestCopyWithImpl(this._value, this._then); - - // ignore: unused_field - final $Val _value; - // ignore: unused_field - final $Res Function($Val) _then; -} - -/// @nodoc -abstract class _$$TestImplCopyWith<$Res> { - factory _$$TestImplCopyWith( - _$TestImpl value, $Res Function(_$TestImpl) then) = - __$$TestImplCopyWithImpl<$Res>; -} - -/// @nodoc -class __$$TestImplCopyWithImpl<$Res> - extends _$TestCopyWithImpl<$Res, _$TestImpl> - implements _$$TestImplCopyWith<$Res> { - __$$TestImplCopyWithImpl(_$TestImpl _value, $Res Function(_$TestImpl) _then) - : super(_value, _then); -} - -/// @nodoc - -class _$TestImpl implements _Test { - _$TestImpl(); - - @override - String toString() { - return 'Test()'; - } - - @override - bool operator ==(Object other) { - return identical(this, other) || - (other.runtimeType == runtimeType && other is _$TestImpl); - } - - @override - int get hashCode => runtimeType.hashCode; -} - -abstract class _Test implements Test { - factory _Test() = _$TestImpl; -} diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart deleted file mode 100644 index 6e27e91fa..000000000 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ /dev/null @@ -1,984 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'generated.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -String _$generatedHash() => r'e49f3520d06ed50d34a44de613fdcd20b19f48d4'; - -/// See also [generated]. -@ProviderFor(generated) -final generatedProvider = Provider<_Test>.internal( - generated, - name: r'generatedProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$generatedHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef GeneratedRef = Ref<_Test>; -String _$generatedFamilyHash() => r'ed284f58926c87acc81dab9168882d5d1c2cddf8'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [generatedFamily]. -@ProviderFor(generatedFamily) -const generatedFamilyProvider = GeneratedFamilyFamily(); - -/// See also [generatedFamily]. -final class GeneratedFamilyFamily extends Family { - /// See also [generatedFamily]. - const GeneratedFamilyFamily() - : super( - name: r'generatedFamilyProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$generatedFamilyHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [generatedFamily]. - GeneratedFamilyProvider call( - _Test test, - ) { - return GeneratedFamilyProvider( - test, - ); - } - - @override - String toString() => 'generatedFamilyProvider'; -} - -/// See also [generatedFamily]. -final class GeneratedFamilyProvider extends Provider<_Test> { - /// See also [generatedFamily]. - GeneratedFamilyProvider( - _Test test, - ) : this._internal( - (ref) => generatedFamily( - ref as GeneratedFamilyRef, - test, - ), - argument: (test,), - ); - - GeneratedFamilyProvider._internal( - super.create, { - required (_Test,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$generatedFamilyHash, - from: generatedFamilyProvider, - name: r'generatedFamilyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _GeneratedFamilyProviderElement createElement( - ProviderContainer container, - ) { - return _GeneratedFamilyProviderElement(this, container); - } - - @internal - @override - GeneratedFamilyProvider copyWithCreate( - _Test Function(GeneratedFamilyRef ref) create, - ) { - return GeneratedFamilyProvider._internal( - (ref) => create(ref as GeneratedFamilyRef), - argument: argument as (_Test,), - ); - } - - @override - bool operator ==(Object other) { - return other is GeneratedFamilyProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'generatedFamilyProvider$argument'; -} - -mixin GeneratedFamilyRef on Ref<_Test> { - /// The parameter `test` of this provider. - _Test get test; -} - -class _GeneratedFamilyProviderElement extends ProviderElement<_Test> - with GeneratedFamilyRef { - _GeneratedFamilyProviderElement(super.provider, super.container); - - @override - _Test get test => (origin as GeneratedFamilyProvider).test; -} - -String _$$dynamicHash() => r'f62d63d9340f30b253e687f76deacd8205fed0e7'; - -/// See also [$dynamic]. -@ProviderFor($dynamic) -final $dynamicProvider = Provider.internal( - $dynamic, - name: r'$dynamicProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$$dynamicHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef $DynamicRef = Ref; -String _$$dynamicFamilyHash() => r'b764133af8837b8321b08814892f198d4bc1aa18'; - -/// See also [$dynamicFamily]. -@ProviderFor($dynamicFamily) -const $dynamicFamilyProvider = $DynamicFamilyFamily(); - -/// See also [$dynamicFamily]. -final class $DynamicFamilyFamily extends Family { - /// See also [$dynamicFamily]. - const $DynamicFamilyFamily() - : super( - name: r'$dynamicFamilyProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$$dynamicFamilyHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [$dynamicFamily]. - $DynamicFamilyProvider call( - test, - ) { - return $DynamicFamilyProvider( - test, - ); - } - - @override - String toString() => '\$dynamicFamilyProvider'; -} - -/// See also [$dynamicFamily]. -final class $DynamicFamilyProvider extends Provider { - /// See also [$dynamicFamily]. - $DynamicFamilyProvider( - test, - ) : this._internal( - (ref) => $dynamicFamily( - ref as $DynamicFamilyRef, - test, - ), - argument: (test,), - ); - - $DynamicFamilyProvider._internal( - super.create, { - required (dynamic,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$$dynamicFamilyHash, - from: $dynamicFamilyProvider, - name: r'$dynamicFamilyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _$DynamicFamilyProviderElement createElement( - ProviderContainer container, - ) { - return _$DynamicFamilyProviderElement(this, container); - } - - @internal - @override - $DynamicFamilyProvider copyWithCreate( - Object? Function($DynamicFamilyRef ref) create, - ) { - return $DynamicFamilyProvider._internal( - (ref) => create(ref as $DynamicFamilyRef), - argument: argument as (dynamic,), - ); - } - - @override - bool operator ==(Object other) { - return other is $DynamicFamilyProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => '\$dynamicFamilyProvider$argument'; -} - -mixin $DynamicFamilyRef on Ref { - /// The parameter `test` of this provider. - get test; -} - -class _$DynamicFamilyProviderElement extends ProviderElement - with $DynamicFamilyRef { - _$DynamicFamilyProviderElement(super.provider, super.container); - - @override - get test => (origin as $DynamicFamilyProvider).test; -} - -String _$dynamicHash() => r'da9dc07960139fff2cf5fe584dca5c524e4f2308'; - -/// See also [_dynamic]. -@ProviderFor(_dynamic) -const _dynamicProvider = _DynamicFamily(); - -/// See also [_dynamic]. -final class _DynamicFamily extends Family { - /// See also [_dynamic]. - const _DynamicFamily() - : super( - name: r'_dynamicProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$dynamicHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [_dynamic]. - _DynamicProvider call( - test, - ) { - return _DynamicProvider( - test, - ); - } - - @override - String toString() => '_dynamicProvider'; -} - -/// See also [_dynamic]. -final class _DynamicProvider extends Provider { - /// See also [_dynamic]. - _DynamicProvider( - test, - ) : this._internal( - (ref) => _dynamic( - ref as _DynamicRef, - test, - ), - argument: (test,), - ); - - _DynamicProvider._internal( - super.create, { - required (dynamic,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$dynamicHash, - from: _dynamicProvider, - name: r'_dynamicProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _DynamicProviderElement createElement( - ProviderContainer container, - ) { - return _DynamicProviderElement(this, container); - } - - @internal - @override - _DynamicProvider copyWithCreate( - Object? Function(_DynamicRef ref) create, - ) { - return _DynamicProvider._internal( - (ref) => create(ref as _DynamicRef), - argument: argument as (dynamic,), - ); - } - - @override - bool operator ==(Object other) { - return other is _DynamicProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => '_dynamicProvider$argument'; -} - -mixin _DynamicRef on Ref { - /// The parameter `test` of this provider. - get test; -} - -class _DynamicProviderElement extends ProviderElement - with _DynamicRef { - _DynamicProviderElement(super.provider, super.container); - - @override - get test => (origin as _DynamicProvider).test; -} - -String _$aliasHash() => r'cc08ec4cc5ec0dc98bdb7f4dcbc035021b09bcf3'; - -/// See also [alias]. -@ProviderFor(alias) -final aliasProvider = Provider>.internal( - alias, - name: r'aliasProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$aliasHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef AliasRef = Ref>; -String _$aliasFamilyHash() => r'f345937d5750132f629aef41646b119a301f750b'; - -/// See also [aliasFamily]. -@ProviderFor(aliasFamily) -const aliasFamilyProvider = AliasFamilyFamily(); - -/// See also [aliasFamily]. -final class AliasFamilyFamily extends Family { - /// See also [aliasFamily]. - const AliasFamilyFamily() - : super( - name: r'aliasFamilyProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$aliasFamilyHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [aliasFamily]. - AliasFamilyProvider call( - r.AsyncValue test, - ) { - return AliasFamilyProvider( - test, - ); - } - - @override - String toString() => 'aliasFamilyProvider'; -} - -/// See also [aliasFamily]. -final class AliasFamilyProvider extends Provider> { - /// See also [aliasFamily]. - AliasFamilyProvider( - r.AsyncValue test, - ) : this._internal( - (ref) => aliasFamily( - ref as AliasFamilyRef, - test, - ), - argument: (test,), - ); - - AliasFamilyProvider._internal( - super.create, { - required (r.AsyncValue,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$aliasFamilyHash, - from: aliasFamilyProvider, - name: r'aliasFamilyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _AliasFamilyProviderElement createElement( - ProviderContainer container, - ) { - return _AliasFamilyProviderElement(this, container); - } - - @internal - @override - AliasFamilyProvider copyWithCreate( - r.AsyncValue Function(AliasFamilyRef ref) create, - ) { - return AliasFamilyProvider._internal( - (ref) => create(ref as AliasFamilyRef), - argument: argument as (r.AsyncValue,), - ); - } - - @override - bool operator ==(Object other) { - return other is AliasFamilyProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'aliasFamilyProvider$argument'; -} - -mixin AliasFamilyRef on Ref> { - /// The parameter `test` of this provider. - r.AsyncValue get test; -} - -class _AliasFamilyProviderElement extends ProviderElement> - with AliasFamilyRef { - _AliasFamilyProviderElement(super.provider, super.container); - - @override - r.AsyncValue get test => (origin as AliasFamilyProvider).test; -} - -String _$generatedClassHash() => r'984153f97e25de687d2f19756b277aabd56f6e72'; - -/// See also [GeneratedClass]. -@ProviderFor(GeneratedClass) -final generatedClassProvider = NotifierProvider.internal( - GeneratedClass.new, - name: r'generatedClassProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$generatedClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$GeneratedClass = Notifier<_Test>; -String _$generatedClassFamilyHash() => - r'28d0a5a82af5b254f6ef07b492916e2feb7e6e63'; - -abstract class _$GeneratedClassFamily - extends BuildlessAutoDisposeNotifier<_Test> { - late final _Test test; - - _Test build( - _Test test, - ); -} - -/// See also [GeneratedClassFamily]. -@ProviderFor(GeneratedClassFamily) -const generatedClassFamilyProvider = GeneratedClassFamilyFamily(); - -/// See also [GeneratedClassFamily]. -final class GeneratedClassFamilyFamily extends Family { - /// See also [GeneratedClassFamily]. - const GeneratedClassFamilyFamily() - : super( - name: r'generatedClassFamilyProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$generatedClassFamilyHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [GeneratedClassFamily]. - GeneratedClassFamilyProvider call( - _Test test, - ) { - return GeneratedClassFamilyProvider( - test, - ); - } - - @override - String toString() => 'generatedClassFamilyProvider'; -} - -/// See also [GeneratedClassFamily]. -final class GeneratedClassFamilyProvider - extends AutoDisposeNotifierProviderImpl { - /// See also [GeneratedClassFamily]. - GeneratedClassFamilyProvider( - _Test test, - ) : this._internal( - () => GeneratedClassFamily()..test = test, - argument: (test,), - ); - - GeneratedClassFamilyProvider._internal( - super.create, { - required (_Test,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$generatedClassFamilyHash, - from: generatedClassFamilyProvider, - name: r'generatedClassFamilyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _Test runNotifierBuild( - covariant GeneratedClassFamily notifier, - ) { - return notifier.build( - test, - ); - } - - @internal - @override - AutoDisposeNotifierProviderImpl copyWithBuild( - GeneratedClassFamily Function() create, - ) { - return AutoDisposeNotifierProviderImpl._internal( - create, - test: test, - ); - } - - @override - _GeneratedClassFamilyProviderElement createElement( - ProviderContainer container, - ) { - return _GeneratedClassFamilyProviderElement(this, container); - } - - @internal - @override - GeneratedClassFamilyProvider copyWithCreate( - GeneratedClassFamily Function() create, - ) { - return GeneratedClassFamilyProvider._internal( - () => create()..test = test, - argument: argument as (_Test,), - ); - } - - @override - bool operator ==(Object other) { - return other is GeneratedClassFamilyProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'generatedClassFamilyProvider$argument'; -} - -mixin GeneratedClassFamilyRef on AutoDisposeNotifierProviderRef { - /// The parameter `test` of this provider. - _Test get test; -} - -class _GeneratedClassFamilyProviderElement - extends AutoDisposeNotifierProviderElement - with GeneratedClassFamilyRef { - _GeneratedClassFamilyProviderElement(super.provider, super.container); - - @override - _Test get test => (origin as GeneratedClassFamilyProvider).test; -} - -String _$$dynamicClassHash() => r'c6d8e5191c3f060df3ce3eee66107433fd4c3292'; - -/// See also [$DynamicClass]. -@ProviderFor($DynamicClass) -final $dynamicClassProvider = NotifierProvider<$DynamicClass, Object?>.internal( - $DynamicClass.new, - name: r'$dynamicClassProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$$dynamicClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$$DynamicClass = Notifier; -String _$$dynamicClassFamilyHash() => - r'bdda961386f3b647c071d79293a8da441580c470'; - -abstract class _$$DynamicClassFamily - extends BuildlessAutoDisposeNotifier { - late final test; - - Object? build( - test, - ); -} - -/// See also [$DynamicClassFamily]. -@ProviderFor($DynamicClassFamily) -const $dynamicClassFamilyProvider = $DynamicClassFamilyFamily(); - -/// See also [$DynamicClassFamily]. -final class $DynamicClassFamilyFamily extends Family { - /// See also [$DynamicClassFamily]. - const $DynamicClassFamilyFamily() - : super( - name: r'$dynamicClassFamilyProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$$dynamicClassFamilyHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [$DynamicClassFamily]. - $DynamicClassFamilyProvider call( - test, - ) { - return $DynamicClassFamilyProvider( - test, - ); - } - - @override - String toString() => '\$dynamicClassFamilyProvider'; -} - -/// See also [$DynamicClassFamily]. -final class $DynamicClassFamilyProvider - extends AutoDisposeNotifierProviderImpl<$DynamicClassFamily, Object?> { - /// See also [$DynamicClassFamily]. - $DynamicClassFamilyProvider( - test, - ) : this._internal( - () => $DynamicClassFamily()..test = test, - argument: (test,), - ); - - $DynamicClassFamilyProvider._internal( - super.create, { - required (dynamic,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$$dynamicClassFamilyHash, - from: $dynamicClassFamilyProvider, - name: r'$dynamicClassFamilyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - Object? runNotifierBuild( - covariant $DynamicClassFamily notifier, - ) { - return notifier.build( - test, - ); - } - - @internal - @override - AutoDisposeNotifierProviderImpl copyWithBuild( - $DynamicClassFamily Function() create, - ) { - return AutoDisposeNotifierProviderImpl._internal( - create, - test: test, - ); - } - - @override - _$DynamicClassFamilyProviderElement createElement( - ProviderContainer container, - ) { - return _$DynamicClassFamilyProviderElement(this, container); - } - - @internal - @override - $DynamicClassFamilyProvider copyWithCreate( - $DynamicClassFamily Function() create, - ) { - return $DynamicClassFamilyProvider._internal( - () => create()..test = test, - argument: argument as (dynamic,), - ); - } - - @override - bool operator ==(Object other) { - return other is $DynamicClassFamilyProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => '\$dynamicClassFamilyProvider$argument'; -} - -mixin $DynamicClassFamilyRef on AutoDisposeNotifierProviderRef { - /// The parameter `test` of this provider. - get test; -} - -class _$DynamicClassFamilyProviderElement - extends AutoDisposeNotifierProviderElement<$DynamicClassFamily, Object?> - with $DynamicClassFamilyRef { - _$DynamicClassFamilyProviderElement(super.provider, super.container); - - @override - get test => (origin as $DynamicClassFamilyProvider).test; -} - -String _$aliasClassHash() => r'a6c6d7594ebd09ba728e42d79b12af560d09c379'; - -/// See also [AliasClass]. -@ProviderFor(AliasClass) -final aliasClassProvider = - NotifierProvider>.internal( - AliasClass.new, - name: r'aliasClassProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$aliasClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$AliasClass = Notifier>; -String _$aliasClassFamilyHash() => r'3f348beb95dae3a9890b4a4d0ce01481316fc66d'; - -abstract class _$AliasClassFamily - extends BuildlessAutoDisposeNotifier> { - late final r.AsyncValue test; - - r.AsyncValue build( - r.AsyncValue test, - ); -} - -/// See also [AliasClassFamily]. -@ProviderFor(AliasClassFamily) -const aliasClassFamilyProvider = AliasClassFamilyFamily(); - -/// See also [AliasClassFamily]. -final class AliasClassFamilyFamily extends Family { - /// See also [AliasClassFamily]. - const AliasClassFamilyFamily() - : super( - name: r'aliasClassFamilyProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$aliasClassFamilyHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [AliasClassFamily]. - AliasClassFamilyProvider call( - r.AsyncValue test, - ) { - return AliasClassFamilyProvider( - test, - ); - } - - @override - String toString() => 'aliasClassFamilyProvider'; -} - -/// See also [AliasClassFamily]. -final class AliasClassFamilyProvider extends AutoDisposeNotifierProviderImpl< - AliasClassFamily, r.AsyncValue> { - /// See also [AliasClassFamily]. - AliasClassFamilyProvider( - r.AsyncValue test, - ) : this._internal( - () => AliasClassFamily()..test = test, - argument: (test,), - ); - - AliasClassFamilyProvider._internal( - super.create, { - required (r.AsyncValue,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$aliasClassFamilyHash, - from: aliasClassFamilyProvider, - name: r'aliasClassFamilyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - r.AsyncValue runNotifierBuild( - covariant AliasClassFamily notifier, - ) { - return notifier.build( - test, - ); - } - - @internal - @override - AutoDisposeNotifierProviderImpl copyWithBuild( - AliasClassFamily Function() create, - ) { - return AutoDisposeNotifierProviderImpl._internal( - create, - test: test, - ); - } - - @override - _AliasClassFamilyProviderElement createElement( - ProviderContainer container, - ) { - return _AliasClassFamilyProviderElement(this, container); - } - - @internal - @override - AliasClassFamilyProvider copyWithCreate( - AliasClassFamily Function() create, - ) { - return AliasClassFamilyProvider._internal( - () => create()..test = test, - argument: argument as (r.AsyncValue,), - ); - } - - @override - bool operator ==(Object other) { - return other is AliasClassFamilyProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'aliasClassFamilyProvider$argument'; -} - -mixin AliasClassFamilyRef on AutoDisposeNotifierProviderRef { - /// The parameter `test` of this provider. - r.AsyncValue get test; -} - -class _AliasClassFamilyProviderElement - extends AutoDisposeNotifierProviderElement> with AliasClassFamilyRef { - _AliasClassFamilyProviderElement(super.provider, super.container); - - @override - r.AsyncValue get test => (origin as AliasClassFamilyProvider).test; -} -// ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index 6592d8dba..11b809c10 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -6,56 +6,109 @@ part of 'hash1.dart'; // RiverpodGenerator // ************************************************************************** -String _$simpleHash() => r'ff9f7451526aef5b3af6646814631a502ad76a5f'; +typedef SimpleRef = Ref; -/// See also [simple]. -@ProviderFor(simple) -final simpleProvider = Provider.internal( - simple, - name: r'simpleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$simpleHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); +const simpleProvider = SimpleProvider._(); -typedef SimpleRef = Ref; -String _$simple2Hash() => r'06327442776394c5c9cbb33b048d7a42e709e7fd'; +final class SimpleProvider + extends $FunctionalProvider { + const SimpleProvider._({ + String Function( + SimpleRef ref, + )? create, + }) : _createCb = create, + super( + debugGetCreateSourceHash: _$simpleHash, + name: r'simple', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + from: null, + argument: null, + ); + + final String Function( + SimpleRef ref, + )? _createCb; -/// See also [simple2]. -@ProviderFor(simple2) -final simple2Provider = Provider.internal( - simple2, - name: r'simple2Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$simple2Hash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); + @override + String create(SimpleRef ref) { + final fn = _createCb ?? simple; + return fn( + ref, + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + SimpleProvider copyWithCreate( + String Function( + SimpleRef ref, + ) create, + ) { + return SimpleProvider._( + create: create, + ); + } +} + +String _$simpleHash() => r'ff9f7451526aef5b3af6646814631a502ad76a5f'; typedef Simple2Ref = Ref; -String _$simpleClassHash() => r'958123cd6179c5b88da040cfeb71eb3061765277'; -/// See also [SimpleClass]. -@ProviderFor(SimpleClass) -final simpleClassProvider = NotifierProvider.internal( - SimpleClass.new, - name: r'simpleClassProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$simpleClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$SimpleClass = Notifier; +const simple2Provider = Simple2Provider._(); + +final class Simple2Provider + extends $FunctionalProvider { + const Simple2Provider._({ + String Function( + Simple2Ref ref, + )? create, + }) : _createCb = create, + super( + debugGetCreateSourceHash: _$simple2Hash, + name: r'simple2', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + from: null, + argument: null, + ); + + final String Function( + Simple2Ref ref, + )? _createCb; + + @override + String create(Simple2Ref ref) { + final fn = _createCb ?? simple2; + + return fn( + ref, + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Simple2Provider copyWithCreate( + String Function( + Simple2Ref ref, + ) create, + ) { + return Simple2Provider._( + create: create, + ); + } +} + +String _$simple2Hash() => r'06327442776394c5c9cbb33b048d7a42e709e7fd'; +String _$simpleClassHash() => r'958123cd6179c5b88da040cfeb71eb3061765277'; +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/scopes.dart b/packages/riverpod_generator/test/integration/scopes.dart index 9e0b223c5..a61036d6c 100644 --- a/packages/riverpod_generator/test/integration/scopes.dart +++ b/packages/riverpod_generator/test/integration/scopes.dart @@ -1,6 +1,6 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; -part 'scopes.g.dart'; +// part 'scopes.g.dart'; @riverpod external int scoped(); diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart deleted file mode 100644 index b21a33c48..000000000 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ /dev/null @@ -1,30 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'scopes.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -String _$scopedHash() => r'590f1a203323105e732397a2616fbd7dac65f0cc'; - -/// See also [scoped]. -@ProviderFor(scoped) -final scopedProvider = Provider.internal( - (_) => throw UnsupportedError( - 'The provider "scopedProvider" is expected to get overridden/scoped, ' - 'but was accessed without an override.', - ), - name: r'scopedProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$scopedHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ScopedRef = Ref; -// ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/split.dart b/packages/riverpod_generator/test/integration/split.dart index 543f7e6fc..fa9a8d039 100644 --- a/packages/riverpod_generator/test/integration/split.dart +++ b/packages/riverpod_generator/test/integration/split.dart @@ -1,8 +1,8 @@ -// Regression test for https://github.com/rrousselGit/riverpod/issues/2175 -import 'package:riverpod_annotation/riverpod_annotation.dart'; +// // Regression test for https://github.com/rrousselGit/riverpod/issues/2175 +// import 'package:riverpod_annotation/riverpod_annotation.dart'; -part 'split2.dart'; -part 'split.g.dart'; +// part 'split2.dart'; +// part 'split.g.dart'; -@riverpod -int counter2(Counter2Ref ref) => 0; +// @riverpod +// int counter2(Counter2Ref ref) => 0; diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart deleted file mode 100644 index 5232d6244..000000000 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ /dev/null @@ -1,44 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'split.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -String _$counter2Hash() => r'9328919066a683f85226fc59201bb7c54f107a7d'; - -/// See also [counter2]. -@ProviderFor(counter2) -final counter2Provider = Provider.internal( - counter2, - name: r'counter2Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counter2Hash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef Counter2Ref = Ref; -String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; - -/// See also [counter]. -@ProviderFor(counter) -final counterProvider = Provider.internal( - counter, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CounterRef = Ref; -// ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/split2.dart b/packages/riverpod_generator/test/integration/split2.dart index 8dc266ec0..0a8e64558 100644 --- a/packages/riverpod_generator/test/integration/split2.dart +++ b/packages/riverpod_generator/test/integration/split2.dart @@ -1,4 +1,4 @@ -part of 'split.dart'; +// part of 'split.dart'; -@riverpod -int counter(CounterRef ref) => 0; +// @riverpod +// int counter(CounterRef ref) => 0; diff --git a/packages/riverpod_generator/test/integration/stream.dart b/packages/riverpod_generator/test/integration/stream.dart index 6481d6a72..af613b160 100644 --- a/packages/riverpod_generator/test/integration/stream.dart +++ b/packages/riverpod_generator/test/integration/stream.dart @@ -1,84 +1,84 @@ -import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:riverpod_annotation/riverpod_annotation.dart'; -part 'stream.g.dart'; +// part 'stream.g.dart'; -@riverpod -Stream> generic(GenericRef ref) async* { - yield []; -} +// @riverpod +// Stream> generic(GenericRef ref) async* { +// yield []; +// } -@riverpod -class GenericClass extends _$GenericClass { - @override - Stream> build() async* { - yield []; - } -} +// @riverpod +// class GenericClass extends _$GenericClass { +// @override +// Stream> build() async* { +// yield []; +// } +// } -@riverpod -Stream public(PublicRef ref) { - return Stream.value('Hello world'); -} +// @riverpod +// Stream public(PublicRef ref) { +// return Stream.value('Hello world'); +// } -final privateProvider = _privateProvider; +// final privateProvider = _privateProvider; -@riverpod -Stream _private(_PrivateRef ref) { - return Stream.value('Hello world'); -} +// @riverpod +// Stream _private(_PrivateRef ref) { +// return Stream.value('Hello world'); +// } -@riverpod -Stream family( - FamilyRef ref, - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, -}) { - return Stream.value( - '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)', - ); -} +// @riverpod +// Stream family( +// FamilyRef ref, +// int first, { +// String? second, +// required double third, +// bool fourth = true, +// List? fifth, +// }) { +// return Stream.value( +// '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)', +// ); +// } -@riverpod -class PublicClass extends _$PublicClass { - PublicClass([this.param]); +// @riverpod +// class PublicClass extends _$PublicClass { +// PublicClass([this.param]); - final Object? param; +// final Object? param; - @override - Stream build() { - return Stream.value('Hello world'); - } -} +// @override +// Stream build() { +// return Stream.value('Hello world'); +// } +// } -final privateClassProvider = _privateClassProvider; +// final privateClassProvider = _privateClassProvider; -@riverpod -class _PrivateClass extends _$PrivateClass { - @override - Stream build() { - return Stream.value('Hello world'); - } -} +// @riverpod +// class _PrivateClass extends _$PrivateClass { +// @override +// Stream build() { +// return Stream.value('Hello world'); +// } +// } -@riverpod -class FamilyClass extends _$FamilyClass { - FamilyClass([this.param]); +// @riverpod +// class FamilyClass extends _$FamilyClass { +// FamilyClass([this.param]); - final Object? param; +// final Object? param; - @override - Stream build( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) { - return Stream.value( - '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)', - ); - } -} +// @override +// Stream build( +// int first, { +// String? second, +// required double third, +// bool fourth = true, +// List? fifth, +// }) { +// return Stream.value( +// '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)', +// ); +// } +// } diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart deleted file mode 100644 index 2400be93c..000000000 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ /dev/null @@ -1,698 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'stream.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -String _$genericHash() => r'c1122edf55163d47de8d871ed5d15e0a7edddc05'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [generic]. -@ProviderFor(generic) -const genericProvider = GenericFamily(); - -/// See also [generic]. -final class GenericFamily extends Family { - /// See also [generic]. - const GenericFamily() - : super( - name: r'genericProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [generic]. - GenericProvider call() { - return GenericProvider(); - } - - @override - String toString() => 'genericProvider'; -} - -/// See also [generic]. -final class GenericProvider extends StreamProvider> { - /// See also [generic]. - GenericProvider() - : this._internal( - (ref) => generic( - ref as GenericRef, - ), - argument: (), - ); - - GenericProvider._internal( - super.create, { - required () super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericHash, - from: genericProvider, - name: r'genericProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _GenericProviderElement createElement( - ProviderContainer container, - ) { - return _GenericProviderElement(this, container); - } - - @internal - @override - GenericProvider copyWithCreate( - Stream> Function(GenericRef ref) create, - ) { - return GenericProvider._internal( - (ref) => create(ref as GenericRef), - argument: argument as (), - ); - } - - @override - bool operator ==(Object other) { - return other is GenericProvider && - other.runtimeType == runtimeType && - other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'genericProvider<$T>$argument'; -} - -mixin GenericRef on Ref>> {} - -class _GenericProviderElement - extends StreamProviderElement> with GenericRef { - _GenericProviderElement(super.provider, super.container); -} - -String _$publicHash() => r'c5cc0eac434371901cf6ab159a81bba49c58da12'; - -/// See also [public]. -@ProviderFor(public) -final publicProvider = StreamProvider.internal( - public, - name: r'publicProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$publicHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef PublicRef = Ref>; -String _$privateHash() => r'bbee0c7e27bda81346b5f52c96b23b2e48f83077'; - -/// See also [_private]. -@ProviderFor(_private) -final _privateProvider = StreamProvider.internal( - _private, - name: r'_privateProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$privateHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _PrivateRef = Ref>; -String _$familyHash() => r'6896fac2f6e3ccd7c38ecaa0d538cbd3577936b2'; - -/// See also [family]. -@ProviderFor(family) -const familyProvider = FamilyFamily(); - -/// See also [family]. -final class FamilyFamily extends Family { - /// See also [family]. - const FamilyFamily() - : super( - name: r'familyProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [family]. - FamilyProvider call( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) { - return FamilyProvider( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ); - } - - @override - String toString() => 'familyProvider'; -} - -/// See also [family]. -final class FamilyProvider extends StreamProvider { - /// See also [family]. - FamilyProvider( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) : this._internal( - (ref) => family( - ref as FamilyRef, - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - argument: ( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - ); - - FamilyProvider._internal( - super.create, { - required ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) - super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyHash, - from: familyProvider, - name: r'familyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _FamilyProviderElement createElement( - ProviderContainer container, - ) { - return _FamilyProviderElement(this, container); - } - - @internal - @override - FamilyProvider copyWithCreate( - Stream Function(FamilyRef ref) create, - ) { - return FamilyProvider._internal( - (ref) => create(ref as FamilyRef), - argument: argument as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }), - ); - } - - @override - bool operator ==(Object other) { - return other is FamilyProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'familyProvider$argument'; -} - -mixin FamilyRef on Ref> { - /// The parameter `first` of this provider. - int get first; - - /// The parameter `second` of this provider. - String? get second; - - /// The parameter `third` of this provider. - double get third; - - /// The parameter `fourth` of this provider. - bool get fourth; - - /// The parameter `fifth` of this provider. - List? get fifth; -} - -class _FamilyProviderElement extends StreamProviderElement - with FamilyRef { - _FamilyProviderElement(super.provider, super.container); - - @override - int get first => (origin as FamilyProvider).first; - @override - String? get second => (origin as FamilyProvider).second; - @override - double get third => (origin as FamilyProvider).third; - @override - bool get fourth => (origin as FamilyProvider).fourth; - @override - List? get fifth => (origin as FamilyProvider).fifth; -} - -String _$genericClassHash() => r'401ae1cfd97a4291dfd135a69ff8e1c436866e5a'; - -abstract class _$GenericClass - extends BuildlessAutoDisposeStreamNotifier> { - Stream> build(); -} - -/// See also [GenericClass]. -@ProviderFor(GenericClass) -const genericClassProvider = GenericClassFamily(); - -/// See also [GenericClass]. -final class GenericClassFamily extends Family { - /// See also [GenericClass]. - const GenericClassFamily() - : super( - name: r'genericClassProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericClassHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [GenericClass]. - GenericClassProvider call() { - return GenericClassProvider(); - } - - @override - String toString() => 'genericClassProvider'; -} - -/// See also [GenericClass]. -final class GenericClassProvider - extends AutoDisposeStreamNotifierProviderImpl, List> { - /// See also [GenericClass]. - GenericClassProvider() - : this._internal( - GenericClass.new, - argument: (), - ); - - GenericClassProvider._internal( - super.create, { - required () super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericClassHash, - from: genericClassProvider, - name: r'genericClassProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - Stream> runNotifierBuild( - covariant GenericClass notifier, - ) { - return notifier.build(); - } - - @internal - @override - AutoDisposeStreamNotifierProviderImpl copyWithBuild( - GenericClass Function() create, - ) { - return AutoDisposeStreamNotifierProviderImpl._internal( - create, - ); - } - - @override - _GenericClassProviderElement createElement( - ProviderContainer container, - ) { - return _GenericClassProviderElement(this, container); - } - - @internal - @override - GenericClassProvider copyWithCreate( - GenericClass Function() create, - ) { - return GenericClassProvider._internal( - () => create(), - argument: argument as (), - ); - } - - @override - bool operator ==(Object other) { - return other is GenericClassProvider && - other.runtimeType == runtimeType && - other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'genericClassProvider<$T>$argument'; -} - -mixin GenericClassRef on AutoDisposeStreamNotifierProviderRef {} - -class _GenericClassProviderElement - extends AutoDisposeStreamNotifierProviderElement, List> - with GenericClassRef { - _GenericClassProviderElement(super.provider, super.container); -} - -String _$publicClassHash() => r'b1526943c8ff0aaa20642bf78e744e5833cf9d02'; - -/// See also [PublicClass]. -@ProviderFor(PublicClass) -final publicClassProvider = - StreamNotifierProvider.internal( - PublicClass.new, - name: r'publicClassProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$publicClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$PublicClass = StreamNotifier; -String _$privateClassHash() => r'8c0d52b7ab79c0546d0c84c011bb3512609e029e'; - -/// See also [_PrivateClass]. -@ProviderFor(_PrivateClass) -final _privateClassProvider = - StreamNotifierProvider<_PrivateClass, String>.internal( - _PrivateClass.new, - name: r'_privateClassProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$privateClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$PrivateClass = StreamNotifier; -String _$familyClassHash() => r'6ec16ca23da8df4c010ecb5eed72e3e655504460'; - -abstract class _$FamilyClass - extends BuildlessAutoDisposeStreamNotifier { - late final int first; - late final String? second; - late final double third; - late final bool fourth; - late final List? fifth; - - Stream build( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }); -} - -/// See also [FamilyClass]. -@ProviderFor(FamilyClass) -const familyClassProvider = FamilyClassFamily(); - -/// See also [FamilyClass]. -final class FamilyClassFamily extends Family { - /// See also [FamilyClass]. - const FamilyClassFamily() - : super( - name: r'familyClassProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyClassHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [FamilyClass]. - FamilyClassProvider call( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) { - return FamilyClassProvider( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ); - } - - @override - String toString() => 'familyClassProvider'; -} - -/// See also [FamilyClass]. -final class FamilyClassProvider - extends AutoDisposeStreamNotifierProviderImpl { - /// See also [FamilyClass]. - FamilyClassProvider( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) : this._internal( - () => FamilyClass() - ..first = first - ..second = second - ..third = third - ..fourth = fourth - ..fifth = fifth, - argument: ( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - ); - - FamilyClassProvider._internal( - super.create, { - required ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) - super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyClassHash, - from: familyClassProvider, - name: r'familyClassProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - Stream runNotifierBuild( - covariant FamilyClass notifier, - ) { - return notifier.build( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ); - } - - @internal - @override - AutoDisposeStreamNotifierProviderImpl copyWithBuild( - FamilyClass Function() create, - ) { - return AutoDisposeStreamNotifierProviderImpl._internal( - create, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ); - } - - @override - _FamilyClassProviderElement createElement( - ProviderContainer container, - ) { - return _FamilyClassProviderElement(this, container); - } - - @internal - @override - FamilyClassProvider copyWithCreate( - FamilyClass Function() create, - ) { - return FamilyClassProvider._internal( - () => create() - ..first = first - ..second = second - ..third = third - ..fourth = fourth - ..fifth = fifth, - argument: argument as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }), - ); - } - - @override - bool operator ==(Object other) { - return other is FamilyClassProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'familyClassProvider$argument'; -} - -mixin FamilyClassRef on AutoDisposeStreamNotifierProviderRef { - /// The parameter `first` of this provider. - int get first; - - /// The parameter `second` of this provider. - String? get second; - - /// The parameter `third` of this provider. - double get third; - - /// The parameter `fourth` of this provider. - bool get fourth; - - /// The parameter `fifth` of this provider. - List? get fifth; -} - -class _FamilyClassProviderElement - extends AutoDisposeStreamNotifierProviderElement - with FamilyClassRef { - _FamilyClassProviderElement(super.provider, super.container); - - @override - int get first => (origin as FamilyClassProvider).first; - @override - String? get second => (origin as FamilyClassProvider).second; - @override - double get third => (origin as FamilyClassProvider).third; - @override - bool get fourth => (origin as FamilyClassProvider).fourth; - @override - List? get fifth => (origin as FamilyClassProvider).fifth; -} -// ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/sync.dart b/packages/riverpod_generator/test/integration/sync.dart index 184dfa1d9..d83cf84d2 100644 --- a/packages/riverpod_generator/test/integration/sync.dart +++ b/packages/riverpod_generator/test/integration/sync.dart @@ -1,176 +1,176 @@ -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -part 'sync.g.dart'; - -@riverpod -List generic(GenericRef ref) { - return [ - 'Hello world', - 42, - 3.14, - ].whereType().toList(); -} - -@riverpod -List complexGeneric( - ComplexGenericRef ref, { - required T param, - Foo? otherParam, -}) { - return []; -} - -@riverpod -class GenericClass extends _$GenericClass { - @override - List build() { - return []; - } -} - -@riverpod -Raw> rawFuture(RawFutureRef ref) async { - return 'Hello world'; -} - -@riverpod -Raw> rawStream(RawStreamRef ref) async* { - yield 'Hello world'; -} - -@riverpod -class RawFutureClass extends _$RawFutureClass { - @override - Raw> build() async { - return 'Hello world'; - } -} - -@riverpod -class RawStreamClass extends _$RawStreamClass { - @override - Raw> build() async* { - yield 'Hello world'; - } -} - -@riverpod -Raw> rawFamilyFuture(RawFamilyFutureRef ref, int id) async { - return 'Hello world'; -} - -@riverpod -Raw> rawFamilyStream(RawFamilyStreamRef ref, int id) async* { - yield 'Hello world'; -} - -@riverpod -class RawFamilyFutureClass extends _$RawFamilyFutureClass { - @override - Raw> build(int id) async { - return 'Hello world'; - } -} - -@riverpod -class RawFamilyStreamClass extends _$RawFamilyStreamClass { - @override - Raw> build(int id) async* { - yield 'Hello world'; - } -} - -/// This is some documentation -@riverpod -String public(PublicRef ref) { - return 'Hello world'; -} - -@riverpod -String supports$inNames(Supports$inNamesRef ref) { - return 'Hello world'; -} - -/// This is some documentation -@riverpod -String family( - FamilyRef ref, - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, -}) { - return '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)'; -} - -final privateProvider = _privateProvider; - -@riverpod -String _private(_PrivateRef ref) { - return 'Hello world'; -} - -/// This is some documentation -@riverpod -class PublicClass extends _$PublicClass { - PublicClass([this.param]); - - final Object? param; - - @override - String build() { - return 'Hello world'; - } -} - -final privateClassProvider = _privateClassProvider; - -@riverpod -class _PrivateClass extends _$PrivateClass { - @override - String build() { - return 'Hello world'; - } -} - -/// This is some documentation -@riverpod -class FamilyClass extends _$FamilyClass { - FamilyClass([this.param]); - - final Object? param; - - @override - String build( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) { - return '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)'; - } -} - -@riverpod -class Supports$InClassName extends _$Supports$InClassName { - @override - String build() { - return 'Hello world'; - } -} - -@riverpod -String generated(GeneratedRef ref) { - return 'Just a simple normal generated provider'; -} - -Provider someProvider() => Provider((ref) => 'hello'); - -// Regression test for https://github.com/rrousselGit/riverpod/issues/2299 -final _someProvider = someProvider(); - -// Regression test for https://github.com/rrousselGit/riverpod/issues/2294 -// ignore: unused_element -final _other = _someProvider; +// import 'package:riverpod_annotation/riverpod_annotation.dart'; + +// part 'sync.g.dart'; + +// @riverpod +// List generic(GenericRef ref) { +// return [ +// 'Hello world', +// 42, +// 3.14, +// ].whereType().toList(); +// } + +// @riverpod +// List complexGeneric( +// ComplexGenericRef ref, { +// required T param, +// Foo? otherParam, +// }) { +// return []; +// } + +// @riverpod +// class GenericClass extends _$GenericClass { +// @override +// List build() { +// return []; +// } +// } + +// @riverpod +// Raw> rawFuture(RawFutureRef ref) async { +// return 'Hello world'; +// } + +// @riverpod +// Raw> rawStream(RawStreamRef ref) async* { +// yield 'Hello world'; +// } + +// @riverpod +// class RawFutureClass extends _$RawFutureClass { +// @override +// Raw> build() async { +// return 'Hello world'; +// } +// } + +// @riverpod +// class RawStreamClass extends _$RawStreamClass { +// @override +// Raw> build() async* { +// yield 'Hello world'; +// } +// } + +// @riverpod +// Raw> rawFamilyFuture(RawFamilyFutureRef ref, int id) async { +// return 'Hello world'; +// } + +// @riverpod +// Raw> rawFamilyStream(RawFamilyStreamRef ref, int id) async* { +// yield 'Hello world'; +// } + +// @riverpod +// class RawFamilyFutureClass extends _$RawFamilyFutureClass { +// @override +// Raw> build(int id) async { +// return 'Hello world'; +// } +// } + +// @riverpod +// class RawFamilyStreamClass extends _$RawFamilyStreamClass { +// @override +// Raw> build(int id) async* { +// yield 'Hello world'; +// } +// } + +// /// This is some documentation +// @riverpod +// String public(PublicRef ref) { +// return 'Hello world'; +// } + +// @riverpod +// String supports$inNames(Supports$inNamesRef ref) { +// return 'Hello world'; +// } + +// /// This is some documentation +// @riverpod +// String family( +// FamilyRef ref, +// int first, { +// String? second, +// required double third, +// bool fourth = true, +// List? fifth, +// }) { +// return '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)'; +// } + +// final privateProvider = _privateProvider; + +// @riverpod +// String _private(_PrivateRef ref) { +// return 'Hello world'; +// } + +// /// This is some documentation +// @riverpod +// class PublicClass extends _$PublicClass { +// PublicClass([this.param]); + +// final Object? param; + +// @override +// String build() { +// return 'Hello world'; +// } +// } + +// final privateClassProvider = _privateClassProvider; + +// @riverpod +// class _PrivateClass extends _$PrivateClass { +// @override +// String build() { +// return 'Hello world'; +// } +// } + +// /// This is some documentation +// @riverpod +// class FamilyClass extends _$FamilyClass { +// FamilyClass([this.param]); + +// final Object? param; + +// @override +// String build( +// int first, { +// String? second, +// required double third, +// bool fourth = true, +// List? fifth, +// }) { +// return '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)'; +// } +// } + +// @riverpod +// class Supports$InClassName extends _$Supports$InClassName { +// @override +// String build() { +// return 'Hello world'; +// } +// } + +// @riverpod +// String generated(GeneratedRef ref) { +// return 'Just a simple normal generated provider'; +// } + +// Provider someProvider() => Provider((ref) => 'hello'); + +// // Regression test for https://github.com/rrousselGit/riverpod/issues/2299 +// final _someProvider = someProvider(); + +// // Regression test for https://github.com/rrousselGit/riverpod/issues/2294 +// // ignore: unused_element +// final _other = _someProvider; diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart deleted file mode 100644 index f91e3f78b..000000000 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ /dev/null @@ -1,1478 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'sync.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -String _$genericHash() => r'0fda19dd377694315cdffd7414d53f98569c655c'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [generic]. -@ProviderFor(generic) -const genericProvider = GenericFamily(); - -/// See also [generic]. -final class GenericFamily extends Family { - /// See also [generic]. - const GenericFamily() - : super( - name: r'genericProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [generic]. - GenericProvider call() { - return GenericProvider(); - } - - @override - String toString() => 'genericProvider'; -} - -/// See also [generic]. -final class GenericProvider extends Provider> { - /// See also [generic]. - GenericProvider() - : this._internal( - (ref) => generic( - ref as GenericRef, - ), - argument: (), - ); - - GenericProvider._internal( - super.create, { - required () super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericHash, - from: genericProvider, - name: r'genericProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _GenericProviderElement createElement( - ProviderContainer container, - ) { - return _GenericProviderElement(this, container); - } - - @internal - @override - GenericProvider copyWithCreate( - List Function(GenericRef ref) create, - ) { - return GenericProvider._internal( - (ref) => create(ref as GenericRef), - argument: argument as (), - ); - } - - @override - bool operator ==(Object other) { - return other is GenericProvider && - other.runtimeType == runtimeType && - other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'genericProvider<$T>$argument'; -} - -mixin GenericRef on Ref> {} - -class _GenericProviderElement extends ProviderElement> - with GenericRef { - _GenericProviderElement(super.provider, super.container); -} - -String _$complexGenericHash() => r'a5254e5552cd61bb8d65c018539ff2d8edfd5822'; - -/// See also [complexGeneric]. -@ProviderFor(complexGeneric) -const complexGenericProvider = ComplexGenericFamily(); - -/// See also [complexGeneric]. -final class ComplexGenericFamily extends Family { - /// See also [complexGeneric]. - const ComplexGenericFamily() - : super( - name: r'complexGenericProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$complexGenericHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [complexGeneric]. - ComplexGenericProvider call({ - required T param, - Foo? otherParam, - }) { - return ComplexGenericProvider( - param: param, - otherParam: otherParam, - ); - } - - @override - String toString() => 'complexGenericProvider'; -} - -/// See also [complexGeneric]. -final class ComplexGenericProvider - extends Provider> { - /// See also [complexGeneric]. - ComplexGenericProvider({ - required T param, - Foo? otherParam, - }) : this._internal( - (ref) => complexGeneric( - ref as ComplexGenericRef, - param: param, - otherParam: otherParam, - ), - argument: ( - param: param, - otherParam: otherParam, - ), - ); - - ComplexGenericProvider._internal( - super.create, { - required ({ - T param, - Foo? otherParam, - }) - super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$complexGenericHash, - from: complexGenericProvider, - name: r'complexGenericProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _ComplexGenericProviderElement createElement( - ProviderContainer container, - ) { - return _ComplexGenericProviderElement(this, container); - } - - @internal - @override - ComplexGenericProvider copyWithCreate( - List Function(ComplexGenericRef ref) - create, - ) { - return ComplexGenericProvider._internal( - (ref) => create(ref as ComplexGenericRef), - argument: argument as ({ - T param, - Foo? otherParam, - }), - ); - } - - @override - bool operator ==(Object other) { - return other is ComplexGenericProvider && - other.runtimeType == runtimeType && - other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'complexGenericProvider<$T,$Foo>$argument'; -} - -mixin ComplexGenericRef on Ref> { - /// The parameter `param` of this provider. - T get param; - - /// The parameter `otherParam` of this provider. - Foo? get otherParam; -} - -class _ComplexGenericProviderElement - extends ProviderElement> with ComplexGenericRef { - _ComplexGenericProviderElement(super.provider, super.container); - - @override - T get param => (origin as ComplexGenericProvider).param; - @override - Foo? get otherParam => (origin as ComplexGenericProvider).otherParam; -} - -String _$rawFutureHash() => r'5203a56065b768023770326281618e3229ccb530'; - -/// See also [rawFuture]. -@ProviderFor(rawFuture) -final rawFutureProvider = Provider>>.internal( - rawFuture, - name: r'rawFutureProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$rawFutureHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef RawFutureRef = Ref>>; -String _$rawStreamHash() => r'2b764189753a8b74f47ba557a79416f00ef5cebd'; - -/// See also [rawStream]. -@ProviderFor(rawStream) -final rawStreamProvider = Provider>>.internal( - rawStream, - name: r'rawStreamProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$rawStreamHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef RawStreamRef = Ref>>; -String _$rawFamilyFutureHash() => r'485f59512081852e51279658facc015309743864'; - -/// See also [rawFamilyFuture]. -@ProviderFor(rawFamilyFuture) -const rawFamilyFutureProvider = RawFamilyFutureFamily(); - -/// See also [rawFamilyFuture]. -final class RawFamilyFutureFamily extends Family { - /// See also [rawFamilyFuture]. - const RawFamilyFutureFamily() - : super( - name: r'rawFamilyFutureProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$rawFamilyFutureHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [rawFamilyFuture]. - RawFamilyFutureProvider call( - int id, - ) { - return RawFamilyFutureProvider( - id, - ); - } - - @override - String toString() => 'rawFamilyFutureProvider'; -} - -/// See also [rawFamilyFuture]. -final class RawFamilyFutureProvider extends Provider>> { - /// See also [rawFamilyFuture]. - RawFamilyFutureProvider( - int id, - ) : this._internal( - (ref) => rawFamilyFuture( - ref as RawFamilyFutureRef, - id, - ), - argument: (id,), - ); - - RawFamilyFutureProvider._internal( - super.create, { - required (int,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$rawFamilyFutureHash, - from: rawFamilyFutureProvider, - name: r'rawFamilyFutureProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _RawFamilyFutureProviderElement createElement( - ProviderContainer container, - ) { - return _RawFamilyFutureProviderElement(this, container); - } - - @internal - @override - RawFamilyFutureProvider copyWithCreate( - Raw> Function(RawFamilyFutureRef ref) create, - ) { - return RawFamilyFutureProvider._internal( - (ref) => create(ref as RawFamilyFutureRef), - argument: argument as (int,), - ); - } - - @override - bool operator ==(Object other) { - return other is RawFamilyFutureProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'rawFamilyFutureProvider$argument'; -} - -mixin RawFamilyFutureRef on Ref>> { - /// The parameter `id` of this provider. - int get id; -} - -class _RawFamilyFutureProviderElement - extends ProviderElement>> with RawFamilyFutureRef { - _RawFamilyFutureProviderElement(super.provider, super.container); - - @override - int get id => (origin as RawFamilyFutureProvider).id; -} - -String _$rawFamilyStreamHash() => r'e778e5cfcb8ab381e2412f5c73213aaa03b93012'; - -/// See also [rawFamilyStream]. -@ProviderFor(rawFamilyStream) -const rawFamilyStreamProvider = RawFamilyStreamFamily(); - -/// See also [rawFamilyStream]. -final class RawFamilyStreamFamily extends Family { - /// See also [rawFamilyStream]. - const RawFamilyStreamFamily() - : super( - name: r'rawFamilyStreamProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$rawFamilyStreamHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [rawFamilyStream]. - RawFamilyStreamProvider call( - int id, - ) { - return RawFamilyStreamProvider( - id, - ); - } - - @override - String toString() => 'rawFamilyStreamProvider'; -} - -/// See also [rawFamilyStream]. -final class RawFamilyStreamProvider extends Provider>> { - /// See also [rawFamilyStream]. - RawFamilyStreamProvider( - int id, - ) : this._internal( - (ref) => rawFamilyStream( - ref as RawFamilyStreamRef, - id, - ), - argument: (id,), - ); - - RawFamilyStreamProvider._internal( - super.create, { - required (int,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$rawFamilyStreamHash, - from: rawFamilyStreamProvider, - name: r'rawFamilyStreamProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _RawFamilyStreamProviderElement createElement( - ProviderContainer container, - ) { - return _RawFamilyStreamProviderElement(this, container); - } - - @internal - @override - RawFamilyStreamProvider copyWithCreate( - Raw> Function(RawFamilyStreamRef ref) create, - ) { - return RawFamilyStreamProvider._internal( - (ref) => create(ref as RawFamilyStreamRef), - argument: argument as (int,), - ); - } - - @override - bool operator ==(Object other) { - return other is RawFamilyStreamProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'rawFamilyStreamProvider$argument'; -} - -mixin RawFamilyStreamRef on Ref>> { - /// The parameter `id` of this provider. - int get id; -} - -class _RawFamilyStreamProviderElement - extends ProviderElement>> with RawFamilyStreamRef { - _RawFamilyStreamProviderElement(super.provider, super.container); - - @override - int get id => (origin as RawFamilyStreamProvider).id; -} - -String _$publicHash() => r'138be35943899793ab085e711fe3f3d22696a3ba'; - -/// This is some documentation -/// -/// Copied from [public]. -@ProviderFor(public) -final publicProvider = Provider.internal( - public, - name: r'publicProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$publicHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef PublicRef = Ref; -String _$supports$inNamesHash() => r'cbf929802fcbd0aa949ad72743d096fb3ef5f28f'; - -/// See also [supports$inNames]. -@ProviderFor(supports$inNames) -final supports$inNamesProvider = Provider.internal( - supports$inNames, - name: r'supports$inNamesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$supports$inNamesHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef Supports$inNamesRef = Ref; -String _$familyHash() => r'14d1ee238ca608d547630d0e222ef4c5866e9e61'; - -/// This is some documentation -/// -/// Copied from [family]. -@ProviderFor(family) -const familyProvider = FamilyFamily(); - -/// This is some documentation -/// -/// Copied from [family]. -final class FamilyFamily extends Family { - /// This is some documentation - /// - /// Copied from [family]. - const FamilyFamily() - : super( - name: r'familyProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// This is some documentation - /// - /// Copied from [family]. - FamilyProvider call( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) { - return FamilyProvider( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ); - } - - @override - String toString() => 'familyProvider'; -} - -/// This is some documentation -/// -/// Copied from [family]. -final class FamilyProvider extends Provider { - /// This is some documentation - /// - /// Copied from [family]. - FamilyProvider( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) : this._internal( - (ref) => family( - ref as FamilyRef, - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - argument: ( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - ); - - FamilyProvider._internal( - super.create, { - required ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) - super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyHash, - from: familyProvider, - name: r'familyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - _FamilyProviderElement createElement( - ProviderContainer container, - ) { - return _FamilyProviderElement(this, container); - } - - @internal - @override - FamilyProvider copyWithCreate( - String Function(FamilyRef ref) create, - ) { - return FamilyProvider._internal( - (ref) => create(ref as FamilyRef), - argument: argument as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }), - ); - } - - @override - bool operator ==(Object other) { - return other is FamilyProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'familyProvider$argument'; -} - -mixin FamilyRef on Ref { - /// The parameter `first` of this provider. - int get first; - - /// The parameter `second` of this provider. - String? get second; - - /// The parameter `third` of this provider. - double get third; - - /// The parameter `fourth` of this provider. - bool get fourth; - - /// The parameter `fifth` of this provider. - List? get fifth; -} - -class _FamilyProviderElement extends ProviderElement with FamilyRef { - _FamilyProviderElement(super.provider, super.container); - - @override - int get first => (origin as FamilyProvider).first; - @override - String? get second => (origin as FamilyProvider).second; - @override - double get third => (origin as FamilyProvider).third; - @override - bool get fourth => (origin as FamilyProvider).fourth; - @override - List? get fifth => (origin as FamilyProvider).fifth; -} - -String _$privateHash() => r'519561bc7e88e394d7f75ca2102a5c0acc832c66'; - -/// See also [_private]. -@ProviderFor(_private) -final _privateProvider = Provider.internal( - _private, - name: r'_privateProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$privateHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _PrivateRef = Ref; -String _$generatedHash() => r'fecbc1d5d9a05fc996b452a57fd1975ff368af91'; - -/// See also [generated]. -@ProviderFor(generated) -final generatedProvider = Provider.internal( - generated, - name: r'generatedProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$generatedHash, - from: null, - argument: null, - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef GeneratedRef = Ref; -String _$genericClassHash() => r'671e348a5abf8e00ab06c5f247defbca8af9677b'; - -abstract class _$GenericClass - extends BuildlessAutoDisposeNotifier> { - List build(); -} - -/// See also [GenericClass]. -@ProviderFor(GenericClass) -const genericClassProvider = GenericClassFamily(); - -/// See also [GenericClass]. -final class GenericClassFamily extends Family { - /// See also [GenericClass]. - const GenericClassFamily() - : super( - name: r'genericClassProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericClassHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [GenericClass]. - GenericClassProvider call() { - return GenericClassProvider(); - } - - @override - String toString() => 'genericClassProvider'; -} - -/// See also [GenericClass]. -final class GenericClassProvider - extends AutoDisposeNotifierProviderImpl, List> { - /// See also [GenericClass]. - GenericClassProvider() - : this._internal( - GenericClass.new, - argument: (), - ); - - GenericClassProvider._internal( - super.create, { - required () super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericClassHash, - from: genericClassProvider, - name: r'genericClassProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - List runNotifierBuild( - covariant GenericClass notifier, - ) { - return notifier.build(); - } - - @internal - @override - AutoDisposeNotifierProviderImpl copyWithBuild( - GenericClass Function() create, - ) { - return AutoDisposeNotifierProviderImpl._internal( - create, - ); - } - - @override - _GenericClassProviderElement createElement( - ProviderContainer container, - ) { - return _GenericClassProviderElement(this, container); - } - - @internal - @override - GenericClassProvider copyWithCreate( - GenericClass Function() create, - ) { - return GenericClassProvider._internal( - () => create(), - argument: argument as (), - ); - } - - @override - bool operator ==(Object other) { - return other is GenericClassProvider && - other.runtimeType == runtimeType && - other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'genericClassProvider<$T>$argument'; -} - -mixin GenericClassRef on AutoDisposeNotifierProviderRef {} - -class _GenericClassProviderElement - extends AutoDisposeNotifierProviderElement, List> - with GenericClassRef { - _GenericClassProviderElement(super.provider, super.container); -} - -String _$rawFutureClassHash() => r'bf66f1cdbd99118b8845d206e6a2611b3101f45c'; - -/// See also [RawFutureClass]. -@ProviderFor(RawFutureClass) -final rawFutureClassProvider = - NotifierProvider>>.internal( - RawFutureClass.new, - name: r'rawFutureClassProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$rawFutureClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$RawFutureClass = Notifier>>; -String _$rawStreamClassHash() => r'712cffcb2018cfb4ff45012c1aa6e43c8cbe9d5d'; - -/// See also [RawStreamClass]. -@ProviderFor(RawStreamClass) -final rawStreamClassProvider = - NotifierProvider>>.internal( - RawStreamClass.new, - name: r'rawStreamClassProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$rawStreamClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$RawStreamClass = Notifier>>; -String _$rawFamilyFutureClassHash() => - r'd7cacb0f2c51697d107de6daa68b242c04085dca'; - -abstract class _$RawFamilyFutureClass - extends BuildlessAutoDisposeNotifier>> { - late final int id; - - Raw> build( - int id, - ); -} - -/// See also [RawFamilyFutureClass]. -@ProviderFor(RawFamilyFutureClass) -const rawFamilyFutureClassProvider = RawFamilyFutureClassFamily(); - -/// See also [RawFamilyFutureClass]. -final class RawFamilyFutureClassFamily extends Family { - /// See also [RawFamilyFutureClass]. - const RawFamilyFutureClassFamily() - : super( - name: r'rawFamilyFutureClassProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$rawFamilyFutureClassHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [RawFamilyFutureClass]. - RawFamilyFutureClassProvider call( - int id, - ) { - return RawFamilyFutureClassProvider( - id, - ); - } - - @override - String toString() => 'rawFamilyFutureClassProvider'; -} - -/// See also [RawFamilyFutureClass]. -final class RawFamilyFutureClassProvider - extends AutoDisposeNotifierProviderImpl>> { - /// See also [RawFamilyFutureClass]. - RawFamilyFutureClassProvider( - int id, - ) : this._internal( - () => RawFamilyFutureClass()..id = id, - argument: (id,), - ); - - RawFamilyFutureClassProvider._internal( - super.create, { - required (int,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$rawFamilyFutureClassHash, - from: rawFamilyFutureClassProvider, - name: r'rawFamilyFutureClassProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - Raw> runNotifierBuild( - covariant RawFamilyFutureClass notifier, - ) { - return notifier.build( - id, - ); - } - - @internal - @override - AutoDisposeNotifierProviderImpl copyWithBuild( - RawFamilyFutureClass Function() create, - ) { - return AutoDisposeNotifierProviderImpl._internal( - create, - id: id, - ); - } - - @override - _RawFamilyFutureClassProviderElement createElement( - ProviderContainer container, - ) { - return _RawFamilyFutureClassProviderElement(this, container); - } - - @internal - @override - RawFamilyFutureClassProvider copyWithCreate( - RawFamilyFutureClass Function() create, - ) { - return RawFamilyFutureClassProvider._internal( - () => create()..id = id, - argument: argument as (int,), - ); - } - - @override - bool operator ==(Object other) { - return other is RawFamilyFutureClassProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'rawFamilyFutureClassProvider$argument'; -} - -mixin RawFamilyFutureClassRef on AutoDisposeNotifierProviderRef { - /// The parameter `id` of this provider. - int get id; -} - -class _RawFamilyFutureClassProviderElement - extends AutoDisposeNotifierProviderElement>> with RawFamilyFutureClassRef { - _RawFamilyFutureClassProviderElement(super.provider, super.container); - - @override - int get id => (origin as RawFamilyFutureClassProvider).id; -} - -String _$rawFamilyStreamClassHash() => - r'321796a0befc43fb83f7ccfdcb6b011fc8c7c599'; - -abstract class _$RawFamilyStreamClass - extends BuildlessAutoDisposeNotifier>> { - late final int id; - - Raw> build( - int id, - ); -} - -/// See also [RawFamilyStreamClass]. -@ProviderFor(RawFamilyStreamClass) -const rawFamilyStreamClassProvider = RawFamilyStreamClassFamily(); - -/// See also [RawFamilyStreamClass]. -final class RawFamilyStreamClassFamily extends Family { - /// See also [RawFamilyStreamClass]. - const RawFamilyStreamClassFamily() - : super( - name: r'rawFamilyStreamClassProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$rawFamilyStreamClassHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// See also [RawFamilyStreamClass]. - RawFamilyStreamClassProvider call( - int id, - ) { - return RawFamilyStreamClassProvider( - id, - ); - } - - @override - String toString() => 'rawFamilyStreamClassProvider'; -} - -/// See also [RawFamilyStreamClass]. -final class RawFamilyStreamClassProvider - extends AutoDisposeNotifierProviderImpl>> { - /// See also [RawFamilyStreamClass]. - RawFamilyStreamClassProvider( - int id, - ) : this._internal( - () => RawFamilyStreamClass()..id = id, - argument: (id,), - ); - - RawFamilyStreamClassProvider._internal( - super.create, { - required (int,) super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$rawFamilyStreamClassHash, - from: rawFamilyStreamClassProvider, - name: r'rawFamilyStreamClassProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - Raw> runNotifierBuild( - covariant RawFamilyStreamClass notifier, - ) { - return notifier.build( - id, - ); - } - - @internal - @override - AutoDisposeNotifierProviderImpl copyWithBuild( - RawFamilyStreamClass Function() create, - ) { - return AutoDisposeNotifierProviderImpl._internal( - create, - id: id, - ); - } - - @override - _RawFamilyStreamClassProviderElement createElement( - ProviderContainer container, - ) { - return _RawFamilyStreamClassProviderElement(this, container); - } - - @internal - @override - RawFamilyStreamClassProvider copyWithCreate( - RawFamilyStreamClass Function() create, - ) { - return RawFamilyStreamClassProvider._internal( - () => create()..id = id, - argument: argument as (int,), - ); - } - - @override - bool operator ==(Object other) { - return other is RawFamilyStreamClassProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'rawFamilyStreamClassProvider$argument'; -} - -mixin RawFamilyStreamClassRef on AutoDisposeNotifierProviderRef { - /// The parameter `id` of this provider. - int get id; -} - -class _RawFamilyStreamClassProviderElement - extends AutoDisposeNotifierProviderElement>> with RawFamilyStreamClassRef { - _RawFamilyStreamClassProviderElement(super.provider, super.container); - - @override - int get id => (origin as RawFamilyStreamClassProvider).id; -} - -String _$publicClassHash() => r'c8e7eec9e202acf8394e02496857cbe49405bf62'; - -/// This is some documentation -/// -/// Copied from [PublicClass]. -@ProviderFor(PublicClass) -final publicClassProvider = NotifierProvider.internal( - PublicClass.new, - name: r'publicClassProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$publicClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$PublicClass = Notifier; -String _$privateClassHash() => r'6d41def3ffdc1f79e593beaefb3304ce4b211a77'; - -/// See also [_PrivateClass]. -@ProviderFor(_PrivateClass) -final _privateClassProvider = NotifierProvider<_PrivateClass, String>.internal( - _PrivateClass.new, - name: r'_privateClassProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$privateClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$PrivateClass = Notifier; -String _$familyClassHash() => r'01e3b9cb4d6d0bf12a2284761b1a11819d97d249'; - -abstract class _$FamilyClass extends BuildlessAutoDisposeNotifier { - late final int first; - late final String? second; - late final double third; - late final bool fourth; - late final List? fifth; - - String build( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }); -} - -/// This is some documentation -/// -/// Copied from [FamilyClass]. -@ProviderFor(FamilyClass) -const familyClassProvider = FamilyClassFamily(); - -/// This is some documentation -/// -/// Copied from [FamilyClass]. -final class FamilyClassFamily extends Family { - /// This is some documentation - /// - /// Copied from [FamilyClass]. - const FamilyClassFamily() - : super( - name: r'familyClassProvider', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyClassHash, - isAutoDispose: true, - ); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - /// This is some documentation - /// - /// Copied from [FamilyClass]. - FamilyClassProvider call( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) { - return FamilyClassProvider( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ); - } - - @override - String toString() => 'familyClassProvider'; -} - -/// This is some documentation -/// -/// Copied from [FamilyClass]. -final class FamilyClassProvider - extends AutoDisposeNotifierProviderImpl { - /// This is some documentation - /// - /// Copied from [FamilyClass]. - FamilyClassProvider( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) : this._internal( - () => FamilyClass() - ..first = first - ..second = second - ..third = third - ..fourth = fourth - ..fifth = fifth, - argument: ( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), - ); - - FamilyClassProvider._internal( - super.create, { - required ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) - super.argument, - }) : super.internal( - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyClassHash, - from: familyClassProvider, - name: r'familyClassProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - @override - String runNotifierBuild( - covariant FamilyClass notifier, - ) { - return notifier.build( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ); - } - - @internal - @override - AutoDisposeNotifierProviderImpl copyWithBuild( - FamilyClass Function() create, - ) { - return AutoDisposeNotifierProviderImpl._internal( - create, - first: first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ); - } - - @override - _FamilyClassProviderElement createElement( - ProviderContainer container, - ) { - return _FamilyClassProviderElement(this, container); - } - - @internal - @override - FamilyClassProvider copyWithCreate( - FamilyClass Function() create, - ) { - return FamilyClassProvider._internal( - () => create() - ..first = first - ..second = second - ..third = third - ..fourth = fourth - ..fifth = fifth, - argument: argument as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }), - ); - } - - @override - bool operator ==(Object other) { - return other is FamilyClassProvider && other.argument == argument; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => 'familyClassProvider$argument'; -} - -mixin FamilyClassRef on AutoDisposeNotifierProviderRef { - /// The parameter `first` of this provider. - int get first; - - /// The parameter `second` of this provider. - String? get second; - - /// The parameter `third` of this provider. - double get third; - - /// The parameter `fourth` of this provider. - bool get fourth; - - /// The parameter `fifth` of this provider. - List? get fifth; -} - -class _FamilyClassProviderElement - extends AutoDisposeNotifierProviderElement - with FamilyClassRef { - _FamilyClassProviderElement(super.provider, super.container); - - @override - int get first => (origin as FamilyClassProvider).first; - @override - String? get second => (origin as FamilyClassProvider).second; - @override - double get third => (origin as FamilyClassProvider).third; - @override - bool get fourth => (origin as FamilyClassProvider).fourth; - @override - List? get fifth => (origin as FamilyClassProvider).fifth; -} - -String _$supports$InClassNameHash() => - r'4e99f433d9cb3598faaf4d172edf9f28b9e68091'; - -/// See also [Supports$InClassName]. -@ProviderFor(Supports$InClassName) -final supports$InClassNameProvider = - NotifierProvider.internal( - Supports$InClassName.new, - name: r'supports$InClassNameProvider', - from: null, - argument: null, - isAutoDispose: true, - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$supports$InClassNameHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Supports$InClassName = Notifier; -// ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 681ca5de5..d8a579524 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -119,7 +119,7 @@ class FamilyFamily extends Family { String toString() => 'familyProvider'; } -class _$FamilyFamilyOverride implements FamilyOverride { +class _$FamilyFamilyOverride implements $FamilyOverride { _$FamilyFamilyOverride(this.from, this.create); final String Function(FamilyRef ref) create; @@ -200,7 +200,7 @@ class FamilyProvider extends AutoDisposeProvider { Override overrideWith( String Function(FamilyRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: FamilyProvider._internal( (ref) => create(ref as FamilyRef), @@ -440,7 +440,7 @@ class FamilyClassFamily extends Family { String toString() => 'familyClassProvider'; } -class _$FamilyClassFamilyOverride implements FamilyOverride { +class _$FamilyClassFamilyOverride implements $FamilyOverride { _$FamilyClassFamilyOverride(this.from, this.create); final FamilyClass Function() create; @@ -531,7 +531,7 @@ class FamilyClassProvider @override Override overrideWith(FamilyClass Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: FamilyClassProvider._internal( () => create() diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index 99093ca9a..ff666fbbc 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -106,7 +106,7 @@ class ExampleFamilyFamily extends Family { String toString() => 'exampleFamilyProvider'; } -class _$ExampleFamilyFamilyOverride implements FamilyOverride { +class _$ExampleFamilyFamilyOverride implements $FamilyOverride { _$ExampleFamilyFamilyOverride(this.from, this.create); final ExampleFamily Function() create; @@ -179,7 +179,7 @@ class ExampleFamilyProvider @override Override overrideWith(ExampleFamily Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: ExampleFamilyProvider._internal( () => create() @@ -311,7 +311,7 @@ class GenericFamily extends Family { String toString() => 'genericProvider'; } -class _$GenericFamilyOverride implements FamilyOverride { +class _$GenericFamilyOverride implements $FamilyOverride { _$GenericFamilyOverride(this.from, this.create); final Generic Function() create; @@ -366,7 +366,7 @@ class GenericProvider @override Override overrideWith(Generic Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: GenericProvider._internal( () => create(), diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index a640116fa..cef497eee 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -96,7 +96,7 @@ class ExampleFamilyFamily extends Family { String toString() => 'exampleFamilyProvider'; } -class _$ExampleFamilyFamilyOverride implements FamilyOverride { +class _$ExampleFamilyFamilyOverride implements $FamilyOverride { _$ExampleFamilyFamilyOverride(this.from, this.create); final int Function(ExampleFamilyRef ref) create; @@ -162,7 +162,7 @@ class ExampleFamilyProvider extends AutoDisposeProvider { Override overrideWith( int Function(ExampleFamilyRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: ExampleFamilyProvider._internal( (ref) => create(ref as ExampleFamilyRef), diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 8a16d4e0a..a7ab5177b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -72,7 +72,7 @@ class FnFamily extends Family { String toString() => 'fnProvider'; } -class _$FnFamilyOverride implements FamilyOverride { +class _$FnFamilyOverride implements $FamilyOverride { _$FnFamilyOverride(this.from, this.create); final int Function(FnRef ref) create; @@ -132,7 +132,7 @@ class FnProvider extends AutoDisposeProvider { Override overrideWith( int Function(FnRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: FnProvider._internal( (ref) => create(ref as FnRef), @@ -272,7 +272,7 @@ class MyNotifierFamily extends Family { String toString() => 'myNotifierProvider'; } -class _$MyNotifierFamilyOverride implements FamilyOverride { +class _$MyNotifierFamilyOverride implements $FamilyOverride { _$MyNotifierFamilyOverride(this.from, this.create); final MyNotifier Function() create; @@ -341,7 +341,7 @@ class MyNotifierProvider @override Override overrideWith(MyNotifier Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: MyNotifierProvider._internal( () => create() diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index db079bcf6..ac1ab29b7 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -78,7 +78,7 @@ class GeneratedNotifierFamily extends Family { String toString() => 'generatedNotifierProvider'; } -class _$GeneratedNotifierFamilyOverride implements FamilyOverride { +class _$GeneratedNotifierFamilyOverride implements $FamilyOverride { _$GeneratedNotifierFamilyOverride(this.from, this.create); final GeneratedNotifier Function() create; @@ -140,7 +140,7 @@ class GeneratedNotifierProvider @override Override overrideWith(GeneratedNotifier Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: GeneratedNotifierProvider._internal( () => create()..param = param, diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index 7629f7c06..5614456e2 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -454,7 +454,7 @@ class FamilyDepFamily extends Family { String toString() => 'familyDepProvider'; } -class _$FamilyDepFamilyOverride implements FamilyOverride { +class _$FamilyDepFamilyOverride implements $FamilyOverride { _$FamilyDepFamilyOverride(this.from, this.create); final int Function(FamilyDepRef ref) create; @@ -511,7 +511,7 @@ class FamilyDepProvider extends AutoDisposeProvider { Override overrideWith( int Function(FamilyDepRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: FamilyDepProvider._internal( (ref) => create(ref as FamilyDepRef), @@ -630,7 +630,7 @@ class FamilyDep2Family extends Family { String toString() => 'familyDep2Provider'; } -class _$FamilyDep2FamilyOverride implements FamilyOverride { +class _$FamilyDep2FamilyOverride implements $FamilyOverride { _$FamilyDep2FamilyOverride(this.from, this.create); final int Function(FamilyDep2Ref ref) create; @@ -687,7 +687,7 @@ class FamilyDep2Provider extends AutoDisposeProvider { Override overrideWith( int Function(FamilyDep2Ref ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: FamilyDep2Provider._internal( (ref) => create(ref as FamilyDep2Ref), diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 7f326b2c2..3f25e19a8 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -98,7 +98,7 @@ class GenericsFamily extends Family { String toString() => 'genericsProvider'; } -class _$GenericsFamilyOverride implements FamilyOverride { +class _$GenericsFamilyOverride implements $FamilyOverride { _$GenericsFamilyOverride(this.from, this.create); final int Function(GenericsRef ref) create; @@ -149,7 +149,7 @@ class GenericsProvider extends AutoDisposeProvider { Override overrideWith( int Function(GenericsRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: GenericsProvider._internal( (ref) => create(ref as GenericsRef), @@ -252,7 +252,7 @@ class NoGenericsFamily extends Family { String toString() => 'noGenericsProvider'; } -class _$NoGenericsFamilyOverride implements FamilyOverride { +class _$NoGenericsFamilyOverride implements $FamilyOverride { _$NoGenericsFamilyOverride(this.from, this.create); final int Function(NoGenericsRef ref) create; @@ -303,7 +303,7 @@ class NoGenericsProvider extends AutoDisposeProvider { Override overrideWith( int Function(NoGenericsRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: NoGenericsProvider._internal( (ref) => create(ref as NoGenericsRef), @@ -405,7 +405,7 @@ class MissingGenericsFamily extends Family { String toString() => 'missingGenericsProvider'; } -class _$MissingGenericsFamilyOverride implements FamilyOverride { +class _$MissingGenericsFamilyOverride implements $FamilyOverride { _$MissingGenericsFamilyOverride(this.from, this.create); final int Function(MissingGenericsRef ref) create; @@ -456,7 +456,7 @@ class MissingGenericsProvider extends AutoDisposeProvider { Override overrideWith( int Function(MissingGenericsRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: MissingGenericsProvider._internal( (ref) => create(ref as MissingGenericsRef), @@ -558,7 +558,7 @@ class WrongOrderFamily extends Family { String toString() => 'wrongOrderProvider'; } -class _$WrongOrderFamilyOverride implements FamilyOverride { +class _$WrongOrderFamilyOverride implements $FamilyOverride { _$WrongOrderFamilyOverride(this.from, this.create); final int Function(WrongOrderRef ref) create; @@ -609,7 +609,7 @@ class WrongOrderProvider extends AutoDisposeProvider { Override overrideWith( int Function(WrongOrderRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: WrongOrderProvider._internal( (ref) => create(ref as WrongOrderRef), diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index 3b9f440f6..d9ed747c0 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -106,7 +106,7 @@ class A3Family extends Family { String toString() => 'a3Provider'; } -class _$A3FamilyOverride implements FamilyOverride { +class _$A3FamilyOverride implements $FamilyOverride { _$A3FamilyOverride(this.from, this.create); final A3 Function() create; @@ -165,7 +165,7 @@ class A3Provider extends AutoDisposeNotifierProviderImpl { @override Override overrideWith(A3 Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: A3Provider._internal( () => create()..param = param, @@ -286,7 +286,7 @@ class A4Family extends Family { String toString() => 'a4Provider'; } -class _$A4FamilyOverride implements FamilyOverride { +class _$A4FamilyOverride implements $FamilyOverride { _$A4FamilyOverride(this.from, this.create); final A4 Function() create; @@ -345,7 +345,7 @@ class A4Provider extends NotifierProvider { @override Override overrideWith(A4 Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: A4Provider._internal( () => create()..param = param, @@ -465,7 +465,7 @@ class A5Family extends Family { String toString() => 'a5Provider'; } -class _$A5FamilyOverride implements FamilyOverride { +class _$A5FamilyOverride implements $FamilyOverride { _$A5FamilyOverride(this.from, this.create); final A5 Function() create; @@ -524,7 +524,7 @@ class A5Provider extends AutoDisposeAsyncNotifierProviderImpl { @override Override overrideWith(A5 Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: A5Provider._internal( () => create()..param = param, @@ -645,7 +645,7 @@ class A6Family extends Family { String toString() => 'a6Provider'; } -class _$A6FamilyOverride implements FamilyOverride { +class _$A6FamilyOverride implements $FamilyOverride { _$A6FamilyOverride(this.from, this.create); final A6 Function() create; @@ -704,7 +704,7 @@ class A6Provider extends AsyncNotifierProviderImpl { @override Override overrideWith(A6 Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: A6Provider._internal( () => create()..param = param, @@ -825,7 +825,7 @@ class A7Family extends Family { String toString() => 'a7Provider'; } -class _$A7FamilyOverride implements FamilyOverride { +class _$A7FamilyOverride implements $FamilyOverride { _$A7FamilyOverride(this.from, this.create); final A7 Function() create; @@ -884,7 +884,7 @@ class A7Provider extends AutoDisposeStreamNotifierProviderImpl { @override Override overrideWith(A7 Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: A7Provider._internal( () => create()..param = param, @@ -1005,7 +1005,7 @@ class A8Family extends Family { String toString() => 'a8Provider'; } -class _$A8FamilyOverride implements FamilyOverride { +class _$A8FamilyOverride implements $FamilyOverride { _$A8FamilyOverride(this.from, this.create); final A8 Function() create; @@ -1064,7 +1064,7 @@ class A8Provider extends StreamNotifierProviderImpl { @override Override overrideWith(A8 Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: A8Provider._internal( () => create()..param = param, diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index cc9897bae..8b1d4c19a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -70,7 +70,7 @@ class GeneratorFamily extends Family { String toString() => 'generatorProvider'; } -class _$GeneratorFamilyOverride implements FamilyOverride { +class _$GeneratorFamilyOverride implements $FamilyOverride { _$GeneratorFamilyOverride(this.from, this.create); final int Function(GeneratorRef ref) create; @@ -127,7 +127,7 @@ class GeneratorProvider extends Provider { Override overrideWith( int Function(GeneratorRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: GeneratorProvider._internal( (ref) => create(ref as GeneratorRef), diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 3f030438a..7bb0e49dc 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -72,7 +72,7 @@ class FetchUserFamily extends Family { String toString() => 'fetchUserProvider'; } -class _$FetchUserFamilyOverride implements FamilyOverride { +class _$FetchUserFamilyOverride implements $FamilyOverride { _$FetchUserFamilyOverride(this.from, this.create); final FutureOr Function(FetchUserRef ref) create; @@ -129,7 +129,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { Override overrideWith( FutureOr Function(FetchUserRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: FetchUserProvider._internal( (ref) => create(ref as FetchUserRef), diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 491339e8e..3589da5d8 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -72,7 +72,7 @@ class ExampleFamily extends Family { String toString() => 'exampleProvider'; } -class _$ExampleFamilyOverride implements FamilyOverride { +class _$ExampleFamilyOverride implements $FamilyOverride { _$ExampleFamilyOverride(this.from, this.create); final String Function(ExampleRef ref) create; @@ -129,7 +129,7 @@ class ExampleProvider extends AutoDisposeProvider { Override overrideWith( String Function(ExampleRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: ExampleProvider._internal( (ref) => create(ref as ExampleRef), diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index 3a686ff46..99e03c23d 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -84,7 +84,7 @@ class ExampleFamily extends Family { String toString() => 'exampleProvider'; } -class _$ExampleFamilyOverride implements FamilyOverride { +class _$ExampleFamilyOverride implements $FamilyOverride { _$ExampleFamilyOverride(this.from, this.create); final Example Function() create; @@ -152,7 +152,7 @@ class ExampleProvider extends AutoDisposeNotifierProviderImpl { @override Override overrideWith(Example Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: ExampleProvider._internal( () => create() diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index 5715ba689..c18b13c8e 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -74,7 +74,7 @@ class ExampleFamily extends Family { String toString() => 'exampleProvider'; } -class _$ExampleFamilyOverride implements FamilyOverride { +class _$ExampleFamilyOverride implements $FamilyOverride { _$ExampleFamilyOverride(this.from, this.create); final String Function(ExampleRef ref) create; @@ -136,7 +136,7 @@ class ExampleProvider extends AutoDisposeProvider { Override overrideWith( String Function(ExampleRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: ExampleProvider._internal( (ref) => create(ref as ExampleRef), diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index c3563946b..890c5b5b2 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -72,7 +72,7 @@ class LabelFamily extends Family { String toString() => 'labelProvider'; } -class _$LabelFamilyOverride implements FamilyOverride { +class _$LabelFamilyOverride implements $FamilyOverride { _$LabelFamilyOverride(this.from, this.create); final String Function(LabelRef ref) create; @@ -129,7 +129,7 @@ class LabelProvider extends AutoDisposeProvider { Override overrideWith( String Function(LabelRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: LabelProvider._internal( (ref) => create(ref as LabelRef), diff --git a/website/docs/essentials/passing_args/codegen/family.g.dart b/website/docs/essentials/passing_args/codegen/family.g.dart index a6d769054..c2b6b5506 100644 --- a/website/docs/essentials/passing_args/codegen/family.g.dart +++ b/website/docs/essentials/passing_args/codegen/family.g.dart @@ -72,7 +72,7 @@ class ActivityFamily extends Family { String toString() => 'activityProvider'; } -class _$ActivityFamilyOverride implements FamilyOverride { +class _$ActivityFamilyOverride implements $FamilyOverride { _$ActivityFamilyOverride(this.from, this.create); final FutureOr Function(ActivityRef ref) create; @@ -129,7 +129,7 @@ class ActivityProvider extends AutoDisposeFutureProvider { Override overrideWith( FutureOr Function(ActivityRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: ActivityProvider._internal( (ref) => create(ref as ActivityRef), diff --git a/website/docs/essentials/passing_args/codegen/provider.g.dart b/website/docs/essentials/passing_args/codegen/provider.g.dart index d90aa2c9a..8bc5aa095 100644 --- a/website/docs/essentials/passing_args/codegen/provider.g.dart +++ b/website/docs/essentials/passing_args/codegen/provider.g.dart @@ -95,7 +95,7 @@ class ActivityNotifier2Family extends Family { String toString() => 'activityNotifier2Provider'; } -class _$ActivityNotifier2FamilyOverride implements FamilyOverride { +class _$ActivityNotifier2FamilyOverride implements $FamilyOverride { _$ActivityNotifier2FamilyOverride(this.from, this.create); final ActivityNotifier2 Function() create; @@ -157,7 +157,7 @@ class ActivityNotifier2Provider @override Override overrideWith(ActivityNotifier2 Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: ActivityNotifier2Provider._internal( () => create()..activityType = activityType, diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index 0fb9d2b78..fdb56c497 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -74,7 +74,7 @@ class RandomFamily extends Family { String toString() => 'randomProvider'; } -class _$RandomFamilyOverride implements FamilyOverride { +class _$RandomFamilyOverride implements $FamilyOverride { _$RandomFamilyOverride(this.from, this.create); final int Function(RandomRef ref) create; @@ -136,7 +136,7 @@ class RandomProvider extends AutoDisposeProvider { Override overrideWith( int Function(RandomRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: RandomProvider._internal( (ref) => create(ref as RandomRef), diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index c61fdd056..74c764e68 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -75,7 +75,7 @@ class FetchPackagesFamily extends Family { String toString() => 'fetchPackagesProvider'; } -class _$FetchPackagesFamilyOverride implements FamilyOverride { +class _$FetchPackagesFamilyOverride implements $FamilyOverride { _$FetchPackagesFamilyOverride(this.from, this.create); final FutureOr> Function(FetchPackagesRef ref) create; @@ -137,7 +137,7 @@ class FetchPackagesProvider extends AutoDisposeFutureProvider> { Override overrideWith( FutureOr> Function(FetchPackagesRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: FetchPackagesProvider._internal( (ref) => create(ref as FetchPackagesRef), diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index 0e521c68f..fb8e9c347 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -82,7 +82,7 @@ class BugsEncounteredNotifierFamily extends Family { String toString() => 'bugsEncounteredNotifierProvider'; } -class _$BugsEncounteredNotifierFamilyOverride implements FamilyOverride { +class _$BugsEncounteredNotifierFamilyOverride implements $FamilyOverride { _$BugsEncounteredNotifierFamilyOverride(this.from, this.create); final BugsEncounteredNotifier Function() create; @@ -144,7 +144,7 @@ class BugsEncounteredNotifierProvider @override Override overrideWith(BugsEncounteredNotifier Function() create) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: BugsEncounteredNotifierProvider._internal( () => create()..featureId = featureId, diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 3f030438a..7bb0e49dc 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -72,7 +72,7 @@ class FetchUserFamily extends Family { String toString() => 'fetchUserProvider'; } -class _$FetchUserFamilyOverride implements FamilyOverride { +class _$FetchUserFamilyOverride implements $FamilyOverride { _$FetchUserFamilyOverride(this.from, this.create); final FutureOr Function(FetchUserRef ref) create; @@ -129,7 +129,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { Override overrideWith( FutureOr Function(FetchUserRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: FetchUserProvider._internal( (ref) => create(ref as FetchUserRef), diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 3f030438a..7bb0e49dc 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -72,7 +72,7 @@ class FetchUserFamily extends Family { String toString() => 'fetchUserProvider'; } -class _$FetchUserFamilyOverride implements FamilyOverride { +class _$FetchUserFamilyOverride implements $FamilyOverride { _$FetchUserFamilyOverride(this.from, this.create); final FutureOr Function(FetchUserRef ref) create; @@ -129,7 +129,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { Override overrideWith( FutureOr Function(FetchUserRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: FetchUserProvider._internal( (ref) => create(ref as FetchUserRef), diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 3f030438a..7bb0e49dc 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -72,7 +72,7 @@ class FetchUserFamily extends Family { String toString() => 'fetchUserProvider'; } -class _$FetchUserFamilyOverride implements FamilyOverride { +class _$FetchUserFamilyOverride implements $FamilyOverride { _$FetchUserFamilyOverride(this.from, this.create); final FutureOr Function(FetchUserRef ref) create; @@ -129,7 +129,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { Override overrideWith( FutureOr Function(FetchUserRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: FetchUserProvider._internal( (ref) => create(ref as FetchUserRef), diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 3f030438a..7bb0e49dc 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -72,7 +72,7 @@ class FetchUserFamily extends Family { String toString() => 'fetchUserProvider'; } -class _$FetchUserFamilyOverride implements FamilyOverride { +class _$FetchUserFamilyOverride implements $FamilyOverride { _$FetchUserFamilyOverride(this.from, this.create); final FutureOr Function(FetchUserRef ref) create; @@ -129,7 +129,7 @@ class FetchUserProvider extends AutoDisposeFutureProvider { Override overrideWith( FutureOr Function(FetchUserRef ref) create, ) { - return ProviderOverride( + return $ProviderOverride( origin: this, providerOverride: FetchUserProvider._internal( (ref) => create(ref as FetchUserRef), From 0650eb8f35842f3f525105e14f7b97d7bb29ccef Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 2 Feb 2024 16:04:32 +0100 Subject: [PATCH 150/387] Wip --- packages/riverpod/lib/riverpod.dart | 12 +- packages/riverpod/lib/src/core/family.dart | 4 +- .../lib/src/core/modifiers/future.dart | 7 +- .../src/core/provider/notifier_provider.dart | 29 +- .../lib/src/providers/async_notifier.dart | 28 +- .../src/providers/async_notifier/family.dart | 9 +- .../src/providers/async_notifier/orphan.dart | 8 +- .../riverpod/lib/src/providers/notifier.dart | 52 +- .../lib/src/providers/notifier/family.dart | 10 +- .../lib/src/providers/notifier/orphan.dart | 41 +- .../lib/src/providers/stream_notifier.dart | 55 +- .../src/providers/stream_notifier/family.dart | 9 +- .../src/providers/stream_notifier/orphan.dart | 43 +- packages/riverpod/test/new/matrix.dart | 2 +- .../new/matrix/async_notifier_provider.dart | 13 +- .../test/new/matrix/notifier_provider.dart | 12 +- .../new/matrix/stream_notifier_provider.dart | 13 +- .../lib/riverpod_annotation.dart | 38 +- .../integration/build_yaml/lib/main.dart | 136 +- .../integration/build_yaml/lib/main.g.dart | 2376 ++++++++--------- .../lib/src/riverpod_generator.dart | 4 +- .../lib/src/templates/family_back.dart | 15 +- .../lib/src/templates/hash.dart | 2 +- .../lib/src/templates/notifier.dart | 41 + .../lib/src/templates/provider.dart | 79 +- .../lib/src/templates/provider_variable.dart | 11 +- .../test/async_notifier_test.dart | 298 +-- .../riverpod_generator/test/async_test.dart | 342 +-- .../test/auto_dispose_test.dart | 38 +- .../test/dependencies_test.dart | 264 +- .../riverpod_generator/test/hash_test.dart | 62 +- .../test/integration/async.dart | 4 +- .../test/integration/async.g.dart | 419 ++- .../test/integration/auto_dispose.dart | 2 +- .../test/integration/hash/hash1.dart | 30 +- .../test/integration/hash/hash1.g.dart | 114 - .../test/notifier_test.dart | 268 +- .../riverpod_generator/test/scoped_test.dart | 40 +- .../test/stream_notifier_test.dart | 276 +- .../riverpod_generator/test/stream_test.dart | 320 +-- .../riverpod_generator/test/sync_test.dart | 646 ++--- 41 files changed, 3209 insertions(+), 2963 deletions(-) create mode 100644 packages/riverpod_generator/lib/src/templates/notifier.dart delete mode 100644 packages/riverpod_generator/test/integration/hash/hash1.g.dart diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 1738b0aa9..e604a687b 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -33,24 +33,24 @@ export 'src/framework.dart' ProviderPointer, ProviderPointerManager, ProviderDirectory, - AsyncClassMixin, + $AsyncClassModifier, $FutureModifier, ProviderElementBase, ClassBaseX, CancelAsyncSubscription, - ClassBase, + $ClassBase, FutureModifierElement, RunNotifierBuild, $FunctionalProvider, - ClassProvider; + $ClassProvider; export 'src/providers/async_notifier.dart' - hide AsyncNotifierBase, AsyncNotifierProviderBase; + hide $AsyncNotifier, $AsyncNotifierProvider; // TODO changelog breaking: StateNotifier & co are no-longer exported from pkg:riverpod/riverpod.dart // Use pkg:riverpod/legacy.dart export 'src/providers/future_provider.dart'; -export 'src/providers/notifier.dart' hide NotifierBase, NotifierProviderBase; +export 'src/providers/notifier.dart' hide $Notifier, $NotifierProvider; export 'src/providers/provider.dart'; export 'src/providers/stream_notifier.dart' - hide StreamNotifierBase, StreamNotifierProviderBase; + hide $StreamNotifier, $StreamNotifierProvider; export 'src/providers/stream_provider.dart'; diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index 981c17cbc..00bcc045b 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -148,14 +148,14 @@ class FunctionalFamily< // /// This API is not meant for public consumption. @internal class ClassFamily< // - NotifierT extends ClassBase< // + NotifierT extends $ClassBase< // StateT, CreatedT>, StateT, RefT extends Ref, ArgT, CreatedT, - ProviderT extends ClassProvider> + ProviderT extends $ClassProvider> extends Family { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 371a34699..c01f9fc36 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -4,9 +4,10 @@ part of '../../framework.dart'; @internal typedef CancelAsyncSubscription = void Function(); -@internal -mixin AsyncClassMixin - on ClassBase, CreatedT> { +/// Implementation detail of `riverpod_generator`. +/// Do not use. +mixin $AsyncClassModifier + on $ClassBase, CreatedT> { /// The value currently exposed by this [AsyncNotifier]. /// /// Defaults to [AsyncLoading] inside the [AsyncNotifier.build] method. diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index 09aa7c076..fd33f34e5 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -29,9 +29,11 @@ typedef RunNotifierBuild< // RefT extends Ref> = CreatedT Function(RefT ref, NotifierT notifier); -@internal -abstract class ClassBase { - ClassProviderElement, StateT, CreatedT>? _element; +/// Implementation detail of `riverpod_generator`. +/// Do not use. +abstract class $ClassBase { + ClassProviderElement<$ClassBase, StateT, CreatedT>? + _element; // TODO docs @protected @@ -69,20 +71,21 @@ abstract class ClassBase { } @internal -extension ClassBaseX on ClassBase { - ClassProviderElement, StateT, CreatedT>? +extension ClassBaseX on $ClassBase { + ClassProviderElement<$ClassBase, StateT, CreatedT>? get element => _element; } -@internal -abstract base class ClassProvider< // - NotifierT extends ClassBase< // +/// Implementation detail of `riverpod_generator`. +/// Do not use. +abstract base class $ClassProvider< // + NotifierT extends $ClassBase< // StateT, CreatedT>, StateT, CreatedT, RefT extends Ref> extends ProviderBase { - const ClassProvider({ + const $ClassProvider({ required super.name, required super.from, required super.argument, @@ -109,12 +112,12 @@ abstract base class ClassProvider< // NotifierT create(); @visibleForOverriding - ClassProvider copyWithCreate( + $ClassProvider copyWithCreate( NotifierT Function() create, ); @visibleForOverriding - ClassProvider copyWithBuild( + $ClassProvider copyWithBuild( RunNotifierBuild build, ); @@ -144,7 +147,7 @@ abstract base class ClassProvider< // } abstract class ClassProviderElement< // - NotifierT extends ClassBase< // + NotifierT extends $ClassBase< // StateT, CreatedT>, StateT, @@ -153,7 +156,7 @@ abstract class ClassProviderElement< // ClassProviderElement(super.container); @override - ClassProvider> get provider; + $ClassProvider> get provider; final classListenable = ProxyElementValueListenable(); diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index b1d3c6a52..e8755fa5d 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -11,25 +11,27 @@ import 'notifier.dart'; part 'async_notifier/orphan.dart'; part 'async_notifier/family.dart'; -@internal -abstract class AsyncNotifierBase extends ClassBase< // +/// Implementation detail of `riverpod_generator`. +/// Do not use. +abstract class $AsyncNotifier extends $ClassBase< // AsyncValue, FutureOr> // with - AsyncClassMixin> {} + $AsyncClassModifier> {} -@internal -abstract base class AsyncNotifierProviderBase< // - NotifierT extends AsyncNotifierBase, +/// Implementation detail of `riverpod_generator`. +/// Do not use. +abstract base class $AsyncNotifierProvider< // + NotifierT extends $AsyncNotifier, StateT> // - extends ClassProvider< // + extends $ClassProvider< // NotifierT, AsyncValue, FutureOr, Ref>> // with $FutureModifier { - const AsyncNotifierProviderBase( + const $AsyncNotifierProvider( this._createNotifier, { required super.name, required super.from, @@ -47,8 +49,10 @@ abstract base class AsyncNotifierProviderBase< // NotifierT create() => _createNotifier(); } -class _AsyncNotifierProviderElement< // - NotifierT extends AsyncNotifierBase, +/// Implementation detail of `riverpod_generator`. +/// Do not use. +class $AsyncNotifierProviderElement< // + NotifierT extends $AsyncNotifier, StateT> // extends ClassProviderElement< // NotifierT, @@ -56,10 +60,10 @@ class _AsyncNotifierProviderElement< // FutureOr> // with FutureModifierElement { - _AsyncNotifierProviderElement(this.provider, super.container); + $AsyncNotifierProviderElement(this.provider, super.container); @override - final AsyncNotifierProviderBase provider; + final $AsyncNotifierProvider provider; @override void handleError( diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index 6d340031f..bfc5949d7 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -3,8 +3,7 @@ part of '../async_notifier.dart'; /// {@macro riverpod.async_notifier} /// /// {@macro riverpod.async_notifier_provider_modifier} -abstract class FamilyAsyncNotifier - extends AsyncNotifierBase { +abstract class FamilyAsyncNotifier extends $AsyncNotifier { /// {@template riverpod.notifier.family_arg} /// The argument that was passed to this family. /// @@ -59,7 +58,7 @@ final class FamilyAsyncNotifierProvider< // NotifierT extends FamilyAsyncNotifier, StateT, ArgT> // - extends AsyncNotifierProviderBase { + extends $AsyncNotifierProvider { /// An implementation detail of Riverpod const FamilyAsyncNotifierProvider._( super._createNotifier, { @@ -93,10 +92,10 @@ final class FamilyAsyncNotifierProvider< // @internal @override - _AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement createElement( ProviderContainer container, ) { - return _AsyncNotifierProviderElement(this, container); + return $AsyncNotifierProviderElement(this, container); } @mustBeOverridden diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index 3e54e965d..522a52f6f 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -16,7 +16,7 @@ part of '../async_notifier.dart'; /// {@endtemplate} /// /// {@macro riverpod.async_notifier_provider_modifier} -abstract class AsyncNotifier extends AsyncNotifierBase { +abstract class AsyncNotifier extends $AsyncNotifier { /// {@template riverpod.async_notifier.build} /// Initialize an [AsyncNotifier]. /// @@ -60,7 +60,7 @@ abstract class AsyncNotifier extends AsyncNotifierBase { final class AsyncNotifierProvider< // NotifierT extends AsyncNotifier, StateT> // - extends AsyncNotifierProviderBase { + extends $AsyncNotifierProvider { /// {@macro riverpod.async_notifier_provider} /// /// {@macro riverpod.async_notifier_provider_modifier} @@ -132,10 +132,10 @@ final class AsyncNotifierProvider< // @internal @override - _AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement createElement( ProviderContainer container, ) { - return _AsyncNotifierProviderElement(this, container); + return $AsyncNotifierProviderElement(this, container); } @mustBeOverridden diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index 6b7487a22..48d8e00ea 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -8,11 +8,9 @@ import 'async_notifier.dart'; part 'notifier/orphan.dart'; part 'notifier/family.dart'; -/// A base class for [NotifierBase]. -/// +/// A base class for [$Notifier]. /// Not meant for public consumption. -@internal -abstract class NotifierBase extends ClassBase { +abstract class $Notifier extends $ClassBase { /// The value currently exposed by this [Notifier]. /// /// If used inside [Notifier.build], may throw if the notifier is not yet initialized. @@ -83,14 +81,15 @@ abstract class NotifierBase extends ClassBase { } } -@internal -abstract base class NotifierProviderBase // - , StateT> - extends ClassProvider> { +/// An implementation detail of `riverpod_generator`. +/// Do not use. +abstract base class $NotifierProvider // + , StateT> + extends $ClassProvider> { /// An internal base class for [Notifier]. /// /// Not meant for public consumption. - const NotifierProviderBase( + const $NotifierProvider( this._createNotifier, { required super.name, required super.from, @@ -107,3 +106,38 @@ abstract base class NotifierProviderBase // @override NotifierT create() => _createNotifier(); } + +/// An implementation detail of `riverpod_generator`. +/// Do not use. +class $NotifierProviderElement< // + NotifierT extends $Notifier, + StateT> // + extends ClassProviderElement< // + NotifierT, + StateT, + StateT> // +{ + $NotifierProviderElement(this.provider, super.container); + + @override + final $NotifierProvider provider; + + @override + void handleError( + Object error, + StackTrace stackTrace, { + required bool didChangeDependency, + }) { + setStateResult(ResultError(error, stackTrace)); + // TODO report uncaught error to the zone + // Zone.current.handleUncaughtError(error, stackTrace); + } + + @override + void handleValue( + StateT created, { + required bool didChangeDependency, + }) { + state = created; + } +} diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index 1f34d7c0c..a54b04cc1 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -3,7 +3,7 @@ part of '../notifier.dart'; /// {@macro riverpod.notifier} /// /// {@macro riverpod.notifier_provider_modifier} -abstract class FamilyNotifier extends NotifierBase { +abstract class FamilyNotifier extends $Notifier { /// {@macro riverpod.notifier.family_arg} late final ArgT arg = (ref as ProviderElementBase).origin.argument as ArgT; @@ -22,8 +22,8 @@ abstract class FamilyNotifier extends NotifierBase { /// This enables tests to execute on both [NotifierProvider] and /// [AutoDisposeNotifierProvider] at the same time. final class FamilyNotifierProvider // - , StateT, ArgT> - extends NotifierProviderBase { + , StateT, ArgT> + extends $NotifierProvider { /// An implementation detail of Riverpod const FamilyNotifierProvider._( super._createNotifier, { @@ -38,10 +38,10 @@ final class FamilyNotifierProvider // }); @override - _NotifierProviderElement createElement( + $NotifierProviderElement createElement( ProviderContainer container, ) { - return _NotifierProviderElement(this, container); + return $NotifierProviderElement(this, container); } FamilyNotifierProvider _copyWith({ diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart index e0a326840..86fa0fce8 100644 --- a/packages/riverpod/lib/src/providers/notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -55,7 +55,7 @@ part of '../notifier.dart'; /// - [FamilyNotifier] for `family` /// - [AutoDisposeFamilyNotifier] for `autoDispose.family` /// {@endtemplate} -abstract class Notifier extends NotifierBase { +abstract class Notifier extends $Notifier { /// {@template riverpod.notifier.build} /// Initialize a [Notifier]. /// @@ -77,7 +77,7 @@ abstract class Notifier extends NotifierBase { } final class NotifierProvider, StateT> - extends NotifierProviderBase { + extends $NotifierProvider { /// {@macro riverpod.notifier_provider} /// /// {@macro riverpod.notifier_provider_modifier} @@ -130,10 +130,10 @@ final class NotifierProvider, StateT> static const family = NotifierProviderFamilyBuilder(); @override - _NotifierProviderElement createElement( + $NotifierProviderElement createElement( ProviderContainer container, ) { - return _NotifierProviderElement(this, container); + return $NotifierProviderElement(this, container); } NotifierProvider _copyWith({ @@ -171,36 +171,3 @@ final class NotifierProvider, StateT> return _copyWith(create: create); } } - -class _NotifierProviderElement< // - NotifierT extends NotifierBase, - StateT> // - extends ClassProviderElement< // - NotifierT, - StateT, - StateT> // -{ - _NotifierProviderElement(this.provider, super.container); - - @override - final NotifierProviderBase provider; - - @override - void handleError( - Object error, - StackTrace stackTrace, { - required bool didChangeDependency, - }) { - setStateResult(ResultError(error, stackTrace)); - // TODO report uncaught error to the zone - // Zone.current.handleUncaughtError(error, stackTrace); - } - - @override - void handleValue( - StateT created, { - required bool didChangeDependency, - }) { - state = created; - } -} diff --git a/packages/riverpod/lib/src/providers/stream_notifier.dart b/packages/riverpod/lib/src/providers/stream_notifier.dart index 805f528dd..6534d5ff5 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier.dart @@ -10,25 +10,27 @@ import 'future_provider.dart' show FutureProvider; part 'stream_notifier/family.dart'; part 'stream_notifier/orphan.dart'; -@internal -abstract class StreamNotifierBase extends ClassBase< // +/// Implementation detail of `riverpod_generator`. +/// Do not use. +abstract class $StreamNotifier extends $ClassBase< // AsyncValue, Stream> // with - AsyncClassMixin> {} + $AsyncClassModifier> {} -@internal -abstract base class StreamNotifierProviderBase< - NotifierT extends StreamNotifierBase, // +/// Implementation detail of `riverpod_generator`. +/// Do not use. +abstract base class $StreamNotifierProvider< + NotifierT extends $StreamNotifier, // StateT> // - extends ClassProvider< // + extends $ClassProvider< // NotifierT, AsyncValue, Stream, Ref>> // with $FutureModifier { - const StreamNotifierProviderBase( + const $StreamNotifierProvider( this._createNotifier, { required super.name, required super.from, @@ -45,3 +47,40 @@ abstract base class StreamNotifierProviderBase< @override NotifierT create() => _createNotifier(); } + +/// Implementation detail of `riverpod_generator`. +/// Do not use. +class $StreamNotifierProviderElement< // + NotifierT extends $StreamNotifier, + StateT> // + extends ClassProviderElement< // + NotifierT, + AsyncValue, + Stream> // + with + FutureModifierElement { + $StreamNotifierProviderElement(this.provider, super.container); + + @override + final $StreamNotifierProvider provider; + + @override + void handleError( + Object error, + StackTrace stackTrace, { + required bool didChangeDependency, + }) { + onError(AsyncError(error, stackTrace), seamless: !didChangeDependency); + } + + @override + void handleValue( + Stream created, { + required bool didChangeDependency, + }) { + handleStream( + () => created, + didChangeDependency: didChangeDependency, + ); + } +} diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index 93bda3b28..555f71b96 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -3,8 +3,7 @@ part of '../stream_notifier.dart'; /// {@macro riverpod.async_notifier} /// /// {@macro riverpod.async_notifier_provider_modifier} -abstract class FamilyStreamNotifier - extends StreamNotifierBase { +abstract class FamilyStreamNotifier extends $StreamNotifier { /// {@template riverpod.notifier.family_arg} /// The argument that was passed to this family. /// @@ -31,7 +30,7 @@ final class FamilyStreamNotifierProvider< // NotifierT extends FamilyStreamNotifier, StateT, ArgT> // - extends StreamNotifierProviderBase { + extends $StreamNotifierProvider { /// An implementation detail of Riverpod const FamilyStreamNotifierProvider._( super._createNotifier, { @@ -46,10 +45,10 @@ final class FamilyStreamNotifierProvider< // }); @override - _StreamNotifierProviderElement createElement( + $StreamNotifierProviderElement createElement( ProviderContainer container, ) { - return _StreamNotifierProviderElement(this, container); + return $StreamNotifierProviderElement(this, container); } FamilyStreamNotifierProvider _copyWith({ diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index 35f175a84..6dd32fefd 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -15,7 +15,7 @@ part of '../stream_notifier.dart'; /// When using `family`, your notifier type changes. Instead of extending /// [StreamNotifier], you should extend [FamilyStreamNotifier]. /// {@endtemplate} -abstract class StreamNotifier extends StreamNotifierBase { +abstract class StreamNotifier extends $StreamNotifier { /// {@macro riverpod.async_notifier.build} @visibleForOverriding Stream build(); @@ -47,7 +47,7 @@ abstract class StreamNotifier extends StreamNotifierBase { final class StreamNotifierProvider< // NotifierT extends StreamNotifier, StateT> // - extends StreamNotifierProviderBase { + extends $StreamNotifierProvider { /// {@macro riverpod.async_notifier_provider} /// /// {@macro riverpod.async_notifier_provider_modifier} @@ -118,10 +118,10 @@ final class StreamNotifierProvider< // @internal @override - _StreamNotifierProviderElement createElement( + $StreamNotifierProviderElement createElement( ProviderContainer container, ) { - return _StreamNotifierProviderElement(this, container); + return $StreamNotifierProviderElement(this, container); } @mustBeOverridden @@ -142,38 +142,3 @@ final class StreamNotifierProvider< // return _copyWith(create: create); } } - -class _StreamNotifierProviderElement< // - NotifierT extends StreamNotifierBase, - StateT> // - extends ClassProviderElement< // - NotifierT, - AsyncValue, - Stream> // - with - FutureModifierElement { - _StreamNotifierProviderElement(this.provider, super.container); - - @override - final StreamNotifierProviderBase provider; - - @override - void handleError( - Object error, - StackTrace stackTrace, { - required bool didChangeDependency, - }) { - onError(AsyncError(error, stackTrace), seamless: !didChangeDependency); - } - - @override - void handleValue( - Stream created, { - required bool didChangeDependency, - }) { - handleStream( - () => created, - didChangeDependency: didChangeDependency, - ); - } -} diff --git a/packages/riverpod/test/new/matrix.dart b/packages/riverpod/test/new/matrix.dart index acaae71c7..e0784edaf 100644 --- a/packages/riverpod/test/new/matrix.dart +++ b/packages/riverpod/test/new/matrix.dart @@ -40,7 +40,7 @@ extension $Modifiers on ProviderBase { Refreshable? get notifier { final that = this; return switch (that) { - ClassProvider() => that.notifier, + $ClassProvider() => that.notifier, _ => null, }; } diff --git a/packages/riverpod/test/new/matrix/async_notifier_provider.dart b/packages/riverpod/test/new/matrix/async_notifier_provider.dart index ba094ea86..485088326 100644 --- a/packages/riverpod/test/new/matrix/async_notifier_provider.dart +++ b/packages/riverpod/test/new/matrix/async_notifier_provider.dart @@ -110,7 +110,7 @@ final asyncNotifierProviderFactory = TestMatrix( }, ); -abstract class TestAsyncNotifier implements AsyncNotifierBase { +abstract class TestAsyncNotifier implements $AsyncNotifier { // Removing protected @override AsyncValue get state; @@ -172,7 +172,7 @@ class DeferredFamilyAsyncNotifier } class AsyncNotifierTestFactory extends TestFactory< - ProviderFactory, ProviderBase, void>> { + ProviderFactory<$AsyncNotifier, ProviderBase, void>> { AsyncNotifierTestFactory({ required super.isAutoDispose, required super.value, @@ -185,18 +185,17 @@ class AsyncNotifierTestFactory extends TestFactory< FutureOr Function(Ref> ref) create, ) deferredNotifier; - final AsyncNotifierProviderBase, StateT> + final $AsyncNotifierProvider, StateT> Function( FutureOr Function(Ref> ref) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) deferredProvider; - final AsyncNotifierProviderBase, StateT> - Function( - AsyncNotifierBase Function() create, + final $AsyncNotifierProvider<$AsyncNotifier, StateT> Function( + $AsyncNotifier Function() create, ) provider; - AsyncNotifierProviderBase, StateT> + $AsyncNotifierProvider, StateT> simpleTestProvider( FutureOr Function(Ref> ref) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, diff --git a/packages/riverpod/test/new/matrix/notifier_provider.dart b/packages/riverpod/test/new/matrix/notifier_provider.dart index 024bd3c0f..01247d368 100644 --- a/packages/riverpod/test/new/matrix/notifier_provider.dart +++ b/packages/riverpod/test/new/matrix/notifier_provider.dart @@ -107,7 +107,7 @@ final notifierProviderFactory = TestMatrix( }, ); -abstract class TestNotifier implements NotifierBase { +abstract class TestNotifier implements $Notifier { // Removing protected @override StateT get state; @@ -165,7 +165,7 @@ class DeferredFamilyNotifier extends FamilyNotifier } class NotifierTestFactory extends TestFactory< - ProviderFactory, ProviderBase, void>> { + ProviderFactory<$Notifier, ProviderBase, void>> { NotifierTestFactory({ required super.isAutoDispose, required super.value, @@ -178,16 +178,16 @@ class NotifierTestFactory extends TestFactory< StateT Function(Ref ref) create, ) deferredNotifier; - final NotifierProviderBase, StateT> Function( + final $NotifierProvider, StateT> Function( StateT Function(Ref ref) create, { bool Function(StateT, StateT)? updateShouldNotify, }) deferredProvider; - final NotifierProviderBase, StateT> Function( - NotifierBase Function() create, + final $NotifierProvider<$Notifier, StateT> Function( + $Notifier Function() create, ) provider; - NotifierProviderBase, StateT> simpleTestProvider( + $NotifierProvider, StateT> simpleTestProvider( StateT Function(Ref ref) create, { bool Function(StateT, StateT)? updateShouldNotify, }) { diff --git a/packages/riverpod/test/new/matrix/stream_notifier_provider.dart b/packages/riverpod/test/new/matrix/stream_notifier_provider.dart index c9245ded8..0939ebb59 100644 --- a/packages/riverpod/test/new/matrix/stream_notifier_provider.dart +++ b/packages/riverpod/test/new/matrix/stream_notifier_provider.dart @@ -111,8 +111,7 @@ final streamNotifierProviderFactory = TestMatrix( }, ); -abstract class TestStreamNotifier - implements StreamNotifierBase { +abstract class TestStreamNotifier implements $StreamNotifier { // Removing protected @override AsyncValue get state; @@ -174,7 +173,7 @@ class DeferredFamilyStreamNotifier } class StreamNotifierTestFactory extends TestFactory< - ProviderFactory, ProviderBase, void>> { + ProviderFactory<$StreamNotifier, ProviderBase, void>> { StreamNotifierTestFactory({ required super.isAutoDispose, required super.value, @@ -187,18 +186,18 @@ class StreamNotifierTestFactory extends TestFactory< Stream Function(Ref> ref) create, ) deferredNotifier; - final StreamNotifierProviderBase, StateT> + final $StreamNotifierProvider, StateT> Function( Stream Function(Ref> ref) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) deferredProvider; - final StreamNotifierProviderBase, StateT> + final $StreamNotifierProvider<$StreamNotifier, StateT> Function( - StreamNotifierBase Function() create, + $StreamNotifier Function() create, ) provider; - StreamNotifierProviderBase, StateT> + $StreamNotifierProvider, StateT> simpleTestProvider( Stream Function(Ref> ref) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index 3e1ada1f6..0a72aaed0 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -1,7 +1,7 @@ -export 'dart:async' show FutureOr; - // Annotations used by code-generators -export 'package:meta/meta.dart' show visibleForOverriding; +import 'package:meta/meta.dart' as meta; + +export 'dart:async' show FutureOr; // ignore: invalid_export_of_internal_element export 'package:riverpod/src/internals.dart' @@ -15,6 +15,9 @@ export 'package:riverpod/src/internals.dart' $FamilyOverride, $FunctionalProvider, $FutureModifier, + $ClassBase, + $AsyncClassModifier, + $ClassProvider, Ref, // Provider @@ -38,18 +41,25 @@ export 'package:riverpod/src/internals.dart' AsyncLoading, AsyncData, AsyncError, - AsyncValueX; + AsyncValueX, + + // AsyncNotifier + $AsyncNotifierProvider, + $AsyncNotifier, + $AsyncNotifierProviderElement, -// // Notifier -// Notifier, -// // ignore: invalid_use_of_internal_member -// NotifierProvider, + // StreamNotifier + $StreamNotifierProvider, + $StreamNotifierProviderElement, + $StreamNotifier, -// // AsyncNotifier -// AsyncNotifier, -// AsyncNotifierProvider, -// // StreamNotifier -// StreamNotifier, -// StreamNotifierProvider; + // Notifier + $NotifierProvider, + $NotifierProviderElement, + $Notifier; export 'src/riverpod_annotation.dart'; + +/// An implementation detail of `riverpod_generator`. +/// Do not use. +const $internal = meta.internal; diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.dart index 1cfb4ea9a..ff11a759c 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.dart @@ -1,81 +1,81 @@ -import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:riverpod_annotation/riverpod_annotation.dart'; -part 'main.g.dart'; +// part 'main.g.dart'; -@riverpod -int count(CountRef ref) { - return 1; -} +// @riverpod +// int count(CountRef ref) { +// return 1; +// } -@riverpod -FutureOr countFuture(CountFutureRef ref) { - return 1; -} +// @riverpod +// FutureOr countFuture(CountFutureRef ref) { +// return 1; +// } -@riverpod -Stream countStream(CountStreamRef ref) { - return Stream.value(1); -} +// @riverpod +// Stream countStream(CountStreamRef ref) { +// return Stream.value(1); +// } -@riverpod -class CountNotifier extends _$CountNotifier { - @override - int build() { - return 1; - } -} +// @riverpod +// class CountNotifier extends _$CountNotifier { +// @override +// int build() { +// return 1; +// } +// } -@riverpod -class CountAsyncNotifier extends _$CountAsyncNotifier { - @override - FutureOr build() { - return 1; - } -} +// @riverpod +// class CountAsyncNotifier extends _$CountAsyncNotifier { +// @override +// FutureOr build() { +// return 1; +// } +// } -@riverpod -class CountStreamNotifier extends _$CountStreamNotifier { - @override - Stream build() { - return Stream.value(1); - } -} +// @riverpod +// class CountStreamNotifier extends _$CountStreamNotifier { +// @override +// Stream build() { +// return Stream.value(1); +// } +// } -@riverpod -int count2(Count2Ref ref, int a) { - return 1; -} +// @riverpod +// int count2(Count2Ref ref, int a) { +// return 1; +// } -@riverpod -FutureOr countFuture2(CountFuture2Ref ref, int a) { - return 1; -} +// @riverpod +// FutureOr countFuture2(CountFuture2Ref ref, int a) { +// return 1; +// } -@riverpod -Stream countStream2(CountStream2Ref ref, int a) { - return Stream.value(1); -} +// @riverpod +// Stream countStream2(CountStream2Ref ref, int a) { +// return Stream.value(1); +// } -@riverpod -class CountNotifier2 extends _$CountNotifier2 { - @override - int build(int a) { - return 1; - } -} +// @riverpod +// class CountNotifier2 extends _$CountNotifier2 { +// @override +// int build(int a) { +// return 1; +// } +// } -@riverpod -class CountAsyncNotifier2 extends _$CountAsyncNotifier2 { - @override - FutureOr build(int a) { - return 1; - } -} +// @riverpod +// class CountAsyncNotifier2 extends _$CountAsyncNotifier2 { +// @override +// FutureOr build(int a) { +// return 1; +// } +// } -@riverpod -class CountStreamNotifier2 extends _$CountStreamNotifier2 { - @override - Stream build(int a) { - return Stream.value(1); - } -} +// @riverpod +// class CountStreamNotifier2 extends _$CountStreamNotifier2 { +// @override +// Stream build(int a) { +// return Stream.value(1); +// } +// } diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index e6e698e75..f22019d26 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -1,1188 +1,1188 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'main.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -String _$countHash() => r'4c7e72b275767a60ece5e8662ab1e28f73cf7e44'; - -/// See also [count]. -@ProviderFor(count) -final countPod = AutoDisposeProvider.internal( - count, - name: r'countPod', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$countHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CountRef = AutoDisposeProviderRef; -String _$countFutureHash() => r'ec7cc31ce1c1a10607f1dcb35dd217acd2877729'; - -/// See also [countFuture]. -@ProviderFor(countFuture) -final countFuturePod = AutoDisposeFutureProvider.internal( - countFuture, - name: r'countFuturePod', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$countFutureHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CountFutureRef = AutoDisposeFutureProviderRef; -String _$countStreamHash() => r'1dbe49244ea19e8dbc3af0534429bb323720c07a'; - -/// See also [countStream]. -@ProviderFor(countStream) -final countStreamPod = AutoDisposeStreamProvider.internal( - countStream, - name: r'countStreamPod', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$countStreamHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CountStreamRef = AutoDisposeStreamProviderRef; -String _$count2Hash() => r'6256825480d83bb13acde282cf3c9d9524cc3a6c'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [count2]. -@ProviderFor(count2) -const count2ProviderFamily = Count2Family(); - -/// See also [count2]. -class Count2Family extends Family { - /// See also [count2]. - const Count2Family(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'count2ProviderFamily'; - - /// See also [count2]. - Count2Provider call( - int a, - ) { - return Count2Provider( - a, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(int Function(Count2Ref ref) create) { - return _$Count2FamilyOverride(this, create); - } - - @override - String toString() => 'count2ProviderFamily'; -} - -class _$Count2FamilyOverride implements $FamilyOverride { - _$Count2FamilyOverride(this.from, this.create); - - final int Function(Count2Ref ref) create; - - @override - final Count2Family from; - - @override - _Count2ProviderElement createElement( - ProviderContainer container, - covariant Count2Provider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'count2ProviderFamily.overrideWith(...)'; -} - -/// See also [count2]. -class Count2Provider extends AutoDisposeProvider { - /// See also [count2]. - Count2Provider( - int a, - ) : this._internal( - (ref) => count2( - ref as Count2Ref, - a, - ), - from: count2ProviderFamily, - name: r'count2ProviderFamily', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$count2Hash, - dependencies: null, - allTransitiveDependencies: null, - a: a, - ); - - Count2Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.a, - }) : super.internal(); - - final int a; - - @override - Override overrideWith( - int Function(Count2Ref ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: Count2Provider._internal( - (ref) => create(ref as Count2Ref), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - a: a, - ), - ); - } - - @override - (int,) get argument { - return (a,); - } - - @override - _Count2ProviderElement createElement( - ProviderContainer container, - ) { - return _Count2ProviderElement(this, container); - } - - Count2Provider _copyWith( - int Function(Count2Ref ref) create, - ) { - return Count2Provider._internal( - (ref) => create(ref as Count2Ref), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - a: a, - ); - } - - @override - bool operator ==(Object other) { - return other is Count2Provider && other.a == a; - } - - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, a.hashCode); - - return _SystemHash.finish(hash); - } - - @override - String toString() => 'count2ProviderFamily$argument'; -} - -mixin Count2Ref on AutoDisposeProviderRef { - /// The parameter `a` of this provider. - int get a; -} - -class _Count2ProviderElement extends AutoDisposeProviderElement - with Count2Ref { - _Count2ProviderElement(super.provider, super.container); - - @override - int get a => (origin as Count2Provider).a; -} - -String _$countFuture2Hash() => r'096675b70a267f5d7c62ac7d3e7dd231ef529034'; - -/// See also [countFuture2]. -@ProviderFor(countFuture2) -const countFuture2ProviderFamily = CountFuture2Family(); - -/// See also [countFuture2]. -class CountFuture2Family extends Family { - /// See also [countFuture2]. - const CountFuture2Family(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'countFuture2ProviderFamily'; - - /// See also [countFuture2]. - CountFuture2Provider call( - int a, - ) { - return CountFuture2Provider( - a, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(FutureOr Function(CountFuture2Ref ref) create) { - return _$CountFuture2FamilyOverride(this, create); - } - - @override - String toString() => 'countFuture2ProviderFamily'; -} - -class _$CountFuture2FamilyOverride implements $FamilyOverride { - _$CountFuture2FamilyOverride(this.from, this.create); - - final FutureOr Function(CountFuture2Ref ref) create; - - @override - final CountFuture2Family from; - - @override - _CountFuture2ProviderElement createElement( - ProviderContainer container, - covariant CountFuture2Provider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'countFuture2ProviderFamily.overrideWith(...)'; -} - -/// See also [countFuture2]. -class CountFuture2Provider extends AutoDisposeFutureProvider { - /// See also [countFuture2]. - CountFuture2Provider( - int a, - ) : this._internal( - (ref) => countFuture2( - ref as CountFuture2Ref, - a, - ), - from: countFuture2ProviderFamily, - name: r'countFuture2ProviderFamily', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$countFuture2Hash, - dependencies: null, - allTransitiveDependencies: null, - a: a, - ); - - CountFuture2Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.a, - }) : super.internal(); - - final int a; - - @override - Override overrideWith( - FutureOr Function(CountFuture2Ref ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: CountFuture2Provider._internal( - (ref) => create(ref as CountFuture2Ref), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - a: a, - ), - ); - } - - @override - (int,) get argument { - return (a,); - } - - @override - _CountFuture2ProviderElement createElement( - ProviderContainer container, - ) { - return _CountFuture2ProviderElement(this, container); - } - - CountFuture2Provider _copyWith( - FutureOr Function(CountFuture2Ref ref) create, - ) { - return CountFuture2Provider._internal( - (ref) => create(ref as CountFuture2Ref), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - a: a, - ); - } - - @override - bool operator ==(Object other) { - return other is CountFuture2Provider && other.a == a; - } - - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, a.hashCode); - - return _SystemHash.finish(hash); - } - - @override - String toString() => 'countFuture2ProviderFamily$argument'; -} - -mixin CountFuture2Ref on AutoDisposeFutureProviderRef { - /// The parameter `a` of this provider. - int get a; -} - -class _CountFuture2ProviderElement extends AutoDisposeFutureProviderElement - with CountFuture2Ref { - _CountFuture2ProviderElement(super.provider, super.container); - - @override - int get a => (origin as CountFuture2Provider).a; -} - -String _$countStream2Hash() => r'051264dd685ebc0a57e454bb676957c93cb4ae20'; - -/// See also [countStream2]. -@ProviderFor(countStream2) -const countStream2ProviderFamily = CountStream2Family(); - -/// See also [countStream2]. -class CountStream2Family extends Family { - /// See also [countStream2]. - const CountStream2Family(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'countStream2ProviderFamily'; - - /// See also [countStream2]. - CountStream2Provider call( - int a, - ) { - return CountStream2Provider( - a, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(Stream Function(CountStream2Ref ref) create) { - return _$CountStream2FamilyOverride(this, create); - } - - @override - String toString() => 'countStream2ProviderFamily'; -} - -class _$CountStream2FamilyOverride implements $FamilyOverride { - _$CountStream2FamilyOverride(this.from, this.create); - - final Stream Function(CountStream2Ref ref) create; - - @override - final CountStream2Family from; - - @override - _CountStream2ProviderElement createElement( - ProviderContainer container, - covariant CountStream2Provider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'countStream2ProviderFamily.overrideWith(...)'; -} - -/// See also [countStream2]. -class CountStream2Provider extends AutoDisposeStreamProvider { - /// See also [countStream2]. - CountStream2Provider( - int a, - ) : this._internal( - (ref) => countStream2( - ref as CountStream2Ref, - a, - ), - from: countStream2ProviderFamily, - name: r'countStream2ProviderFamily', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$countStream2Hash, - dependencies: null, - allTransitiveDependencies: null, - a: a, - ); - - CountStream2Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.a, - }) : super.internal(); - - final int a; - - @override - Override overrideWith( - Stream Function(CountStream2Ref ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: CountStream2Provider._internal( - (ref) => create(ref as CountStream2Ref), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - a: a, - ), - ); - } - - @override - (int,) get argument { - return (a,); - } - - @override - _CountStream2ProviderElement createElement( - ProviderContainer container, - ) { - return _CountStream2ProviderElement(this, container); - } - - CountStream2Provider _copyWith( - Stream Function(CountStream2Ref ref) create, - ) { - return CountStream2Provider._internal( - (ref) => create(ref as CountStream2Ref), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - a: a, - ); - } - - @override - bool operator ==(Object other) { - return other is CountStream2Provider && other.a == a; - } - - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, a.hashCode); - - return _SystemHash.finish(hash); - } - - @override - String toString() => 'countStream2ProviderFamily$argument'; -} - -mixin CountStream2Ref on AutoDisposeStreamProviderRef { - /// The parameter `a` of this provider. - int get a; -} - -class _CountStream2ProviderElement extends AutoDisposeStreamProviderElement - with CountStream2Ref { - _CountStream2ProviderElement(super.provider, super.container); - - @override - int get a => (origin as CountStream2Provider).a; -} - -String _$countNotifierHash() => r'a8dd7a66ee0002b8af657245c4affaa206fd99ec'; - -/// See also [CountNotifier]. -@ProviderFor(CountNotifier) -final countNotifierPod = - AutoDisposeNotifierProvider.internal( - CountNotifier.new, - name: r'countNotifierPod', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$countNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$CountNotifier = AutoDisposeNotifier; -String _$countAsyncNotifierHash() => - r'2a7049d864bf396e44a5937b4001efb4774a5f29'; - -/// See also [CountAsyncNotifier]. -@ProviderFor(CountAsyncNotifier) -final countAsyncNotifierPod = - AutoDisposeAsyncNotifierProvider.internal( - CountAsyncNotifier.new, - name: r'countAsyncNotifierPod', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$countAsyncNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$CountAsyncNotifier = AutoDisposeAsyncNotifier; -String _$countStreamNotifierHash() => - r'61d2cd311c4808f8d7e8b2d67f5c7b85337666c6'; - -/// See also [CountStreamNotifier]. -@ProviderFor(CountStreamNotifier) -final countStreamNotifierPod = - AutoDisposeStreamNotifierProvider.internal( - CountStreamNotifier.new, - name: r'countStreamNotifierPod', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$countStreamNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$CountStreamNotifier = AutoDisposeStreamNotifier; -String _$countNotifier2Hash() => r'ef12bb4f94add336804ae43bcdbcd8e9b0bec420'; - -abstract class _$CountNotifier2 extends BuildlessAutoDisposeNotifier { - late final int a; - - int build( - int a, - ); -} - -/// See also [CountNotifier2]. -@ProviderFor(CountNotifier2) -const countNotifier2ProviderFamily = CountNotifier2Family(); - -/// See also [CountNotifier2]. -class CountNotifier2Family extends Family { - /// See also [CountNotifier2]. - const CountNotifier2Family(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'countNotifier2ProviderFamily'; - - /// See also [CountNotifier2]. - CountNotifier2Provider call( - int a, - ) { - return CountNotifier2Provider( - a, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(CountNotifier2 Function() create) { - return _$CountNotifier2FamilyOverride(this, create); - } - - @override - String toString() => 'countNotifier2ProviderFamily'; -} - -class _$CountNotifier2FamilyOverride implements $FamilyOverride { - _$CountNotifier2FamilyOverride(this.from, this.create); - - final CountNotifier2 Function() create; - - @override - final CountNotifier2Family from; - - @override - _CountNotifier2ProviderElement createElement( - ProviderContainer container, - covariant CountNotifier2Provider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'countNotifier2ProviderFamily.overrideWith(...)'; -} - -/// See also [CountNotifier2]. -class CountNotifier2Provider - extends AutoDisposeNotifierProviderImpl { - /// See also [CountNotifier2]. - CountNotifier2Provider( - int a, - ) : this._internal( - () => CountNotifier2()..a = a, - from: countNotifier2ProviderFamily, - name: r'countNotifier2ProviderFamily', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$countNotifier2Hash, - dependencies: null, - allTransitiveDependencies: null, - a: a, - ); - - CountNotifier2Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.a, - }) : super.internal(); - - final int a; - - @override - int runNotifierBuild( - covariant CountNotifier2 notifier, - ) { - return notifier.build( - a, - ); - } - - @override - Override overrideWith(CountNotifier2 Function() create) { - return $ProviderOverride( - origin: this, - providerOverride: CountNotifier2Provider._internal( - () => create()..a = a, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - a: a, - ), - ); - } - - @override - (int,) get argument { - return (a,); - } - - @override - _CountNotifier2ProviderElement createElement( - ProviderContainer container, - ) { - return _CountNotifier2ProviderElement(this, container); - } - - CountNotifier2Provider _copyWith( - CountNotifier2 Function() create, - ) { - return CountNotifier2Provider._internal( - () => create()..a = a, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - a: a, - ); - } - - @override - bool operator ==(Object other) { - return other is CountNotifier2Provider && other.a == a; - } - - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, a.hashCode); - - return _SystemHash.finish(hash); - } - - @override - String toString() => 'countNotifier2ProviderFamily$argument'; -} - -mixin CountNotifier2Ref on AutoDisposeNotifierProviderRef { - /// The parameter `a` of this provider. - int get a; -} - -class _CountNotifier2ProviderElement - extends AutoDisposeNotifierProviderElement - with CountNotifier2Ref { - _CountNotifier2ProviderElement(super.provider, super.container); - - @override - int get a => (origin as CountNotifier2Provider).a; -} - -String _$countAsyncNotifier2Hash() => - r'e4bd4d858edbb47fa0d7581f3cfa72e13c914d3d'; - -abstract class _$CountAsyncNotifier2 - extends BuildlessAutoDisposeAsyncNotifier { - late final int a; - - FutureOr build( - int a, - ); -} - -/// See also [CountAsyncNotifier2]. -@ProviderFor(CountAsyncNotifier2) -const countAsyncNotifier2ProviderFamily = CountAsyncNotifier2Family(); - -/// See also [CountAsyncNotifier2]. -class CountAsyncNotifier2Family extends Family { - /// See also [CountAsyncNotifier2]. - const CountAsyncNotifier2Family(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'countAsyncNotifier2ProviderFamily'; - - /// See also [CountAsyncNotifier2]. - CountAsyncNotifier2Provider call( - int a, - ) { - return CountAsyncNotifier2Provider( - a, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(CountAsyncNotifier2 Function() create) { - return _$CountAsyncNotifier2FamilyOverride(this, create); - } - - @override - String toString() => 'countAsyncNotifier2ProviderFamily'; -} - -class _$CountAsyncNotifier2FamilyOverride implements $FamilyOverride { - _$CountAsyncNotifier2FamilyOverride(this.from, this.create); - - final CountAsyncNotifier2 Function() create; - - @override - final CountAsyncNotifier2Family from; - - @override - _CountAsyncNotifier2ProviderElement createElement( - ProviderContainer container, - covariant CountAsyncNotifier2Provider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'countAsyncNotifier2ProviderFamily.overrideWith(...)'; -} - -/// See also [CountAsyncNotifier2]. -class CountAsyncNotifier2Provider - extends AutoDisposeAsyncNotifierProviderImpl { - /// See also [CountAsyncNotifier2]. - CountAsyncNotifier2Provider( - int a, - ) : this._internal( - () => CountAsyncNotifier2()..a = a, - from: countAsyncNotifier2ProviderFamily, - name: r'countAsyncNotifier2ProviderFamily', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$countAsyncNotifier2Hash, - dependencies: null, - allTransitiveDependencies: null, - a: a, - ); - - CountAsyncNotifier2Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.a, - }) : super.internal(); - - final int a; - - @override - FutureOr runNotifierBuild( - covariant CountAsyncNotifier2 notifier, - ) { - return notifier.build( - a, - ); - } - - @override - Override overrideWith(CountAsyncNotifier2 Function() create) { - return $ProviderOverride( - origin: this, - providerOverride: CountAsyncNotifier2Provider._internal( - () => create()..a = a, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - a: a, - ), - ); - } - - @override - (int,) get argument { - return (a,); - } - - @override - _CountAsyncNotifier2ProviderElement createElement( - ProviderContainer container, - ) { - return _CountAsyncNotifier2ProviderElement(this, container); - } - - CountAsyncNotifier2Provider _copyWith( - CountAsyncNotifier2 Function() create, - ) { - return CountAsyncNotifier2Provider._internal( - () => create()..a = a, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - a: a, - ); - } - - @override - bool operator ==(Object other) { - return other is CountAsyncNotifier2Provider && other.a == a; - } - - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, a.hashCode); - - return _SystemHash.finish(hash); - } - - @override - String toString() => 'countAsyncNotifier2ProviderFamily$argument'; -} - -mixin CountAsyncNotifier2Ref on AutoDisposeAsyncNotifierProviderRef { - /// The parameter `a` of this provider. - int get a; -} - -class _CountAsyncNotifier2ProviderElement - extends AutoDisposeAsyncNotifierProviderElement - with CountAsyncNotifier2Ref { - _CountAsyncNotifier2ProviderElement(super.provider, super.container); - - @override - int get a => (origin as CountAsyncNotifier2Provider).a; -} - -String _$countStreamNotifier2Hash() => - r'13be1b7aa32801b33c68f2a228851d2fb6a4a9ee'; - -abstract class _$CountStreamNotifier2 - extends BuildlessAutoDisposeStreamNotifier { - late final int a; - - Stream build( - int a, - ); -} - -/// See also [CountStreamNotifier2]. -@ProviderFor(CountStreamNotifier2) -const countStreamNotifier2ProviderFamily = CountStreamNotifier2Family(); - -/// See also [CountStreamNotifier2]. -class CountStreamNotifier2Family extends Family { - /// See also [CountStreamNotifier2]. - const CountStreamNotifier2Family(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'countStreamNotifier2ProviderFamily'; - - /// See also [CountStreamNotifier2]. - CountStreamNotifier2Provider call( - int a, - ) { - return CountStreamNotifier2Provider( - a, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(CountStreamNotifier2 Function() create) { - return _$CountStreamNotifier2FamilyOverride(this, create); - } - - @override - String toString() => 'countStreamNotifier2ProviderFamily'; -} - -class _$CountStreamNotifier2FamilyOverride implements $FamilyOverride { - _$CountStreamNotifier2FamilyOverride(this.from, this.create); - - final CountStreamNotifier2 Function() create; - - @override - final CountStreamNotifier2Family from; - - @override - _CountStreamNotifier2ProviderElement createElement( - ProviderContainer container, - covariant CountStreamNotifier2Provider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'countStreamNotifier2ProviderFamily.overrideWith(...)'; -} - -/// See also [CountStreamNotifier2]. -class CountStreamNotifier2Provider - extends AutoDisposeStreamNotifierProviderImpl { - /// See also [CountStreamNotifier2]. - CountStreamNotifier2Provider( - int a, - ) : this._internal( - () => CountStreamNotifier2()..a = a, - from: countStreamNotifier2ProviderFamily, - name: r'countStreamNotifier2ProviderFamily', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$countStreamNotifier2Hash, - dependencies: null, - allTransitiveDependencies: null, - a: a, - ); - - CountStreamNotifier2Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.a, - }) : super.internal(); - - final int a; - - @override - Stream runNotifierBuild( - covariant CountStreamNotifier2 notifier, - ) { - return notifier.build( - a, - ); - } - - @override - Override overrideWith(CountStreamNotifier2 Function() create) { - return $ProviderOverride( - origin: this, - providerOverride: CountStreamNotifier2Provider._internal( - () => create()..a = a, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - a: a, - ), - ); - } - - @override - (int,) get argument { - return (a,); - } - - @override - _CountStreamNotifier2ProviderElement createElement( - ProviderContainer container, - ) { - return _CountStreamNotifier2ProviderElement(this, container); - } - - CountStreamNotifier2Provider _copyWith( - CountStreamNotifier2 Function() create, - ) { - return CountStreamNotifier2Provider._internal( - () => create()..a = a, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - a: a, - ); - } - - @override - bool operator ==(Object other) { - return other is CountStreamNotifier2Provider && other.a == a; - } - - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, a.hashCode); - - return _SystemHash.finish(hash); - } - - @override - String toString() => 'countStreamNotifier2ProviderFamily$argument'; -} - -mixin CountStreamNotifier2Ref on AutoDisposeStreamNotifierProviderRef { - /// The parameter `a` of this provider. - int get a; -} - -class _CountStreamNotifier2ProviderElement - extends AutoDisposeStreamNotifierProviderElement - with CountStreamNotifier2Ref { - _CountStreamNotifier2ProviderElement(super.provider, super.container); - - @override - int get a => (origin as CountStreamNotifier2Provider).a; -} -// ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// // GENERATED CODE - DO NOT MODIFY BY HAND + +// part of 'main.dart'; + +// // ************************************************************************** +// // RiverpodGenerator +// // ************************************************************************** + +// String _$countHash() => r'4c7e72b275767a60ece5e8662ab1e28f73cf7e44'; + +// /// See also [count]. +// @ProviderFor(count) +// final countPod = AutoDisposeProvider.internal( +// count, +// name: r'countPod', +// debugGetCreateSourceHash: +// const bool.fromEnvironment('dart.vm.product') ? null : _$countHash, +// dependencies: null, +// allTransitiveDependencies: null, +// ); + +// typedef CountRef = AutoDisposeProviderRef; +// String _$countFutureHash() => r'ec7cc31ce1c1a10607f1dcb35dd217acd2877729'; + +// /// See also [countFuture]. +// @ProviderFor(countFuture) +// final countFuturePod = AutoDisposeFutureProvider.internal( +// countFuture, +// name: r'countFuturePod', +// debugGetCreateSourceHash: +// const bool.fromEnvironment('dart.vm.product') ? null : _$countFutureHash, +// dependencies: null, +// allTransitiveDependencies: null, +// ); + +// typedef CountFutureRef = AutoDisposeFutureProviderRef; +// String _$countStreamHash() => r'1dbe49244ea19e8dbc3af0534429bb323720c07a'; + +// /// See also [countStream]. +// @ProviderFor(countStream) +// final countStreamPod = AutoDisposeStreamProvider.internal( +// countStream, +// name: r'countStreamPod', +// debugGetCreateSourceHash: +// const bool.fromEnvironment('dart.vm.product') ? null : _$countStreamHash, +// dependencies: null, +// allTransitiveDependencies: null, +// ); + +// typedef CountStreamRef = AutoDisposeStreamProviderRef; +// String _$count2Hash() => r'6256825480d83bb13acde282cf3c9d9524cc3a6c'; + +// /// Copied from Dart SDK +// class _SystemHash { +// _SystemHash._(); + +// static int combine(int hash, int value) { +// // ignore: parameter_assignments +// hash = 0x1fffffff & (hash + value); +// // ignore: parameter_assignments +// hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); +// return hash ^ (hash >> 6); +// } + +// static int finish(int hash) { +// // ignore: parameter_assignments +// hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); +// // ignore: parameter_assignments +// hash = hash ^ (hash >> 11); +// return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); +// } +// } + +// /// See also [count2]. +// @ProviderFor(count2) +// const count2ProviderFamily = Count2Family(); + +// /// See also [count2]. +// class Count2Family extends Family { +// /// See also [count2]. +// const Count2Family(); + +// static const Iterable? _dependencies = null; + +// static const Iterable? _allTransitiveDependencies = null; + +// @override +// Iterable? get dependencies => _dependencies; + +// @override +// Iterable? get allTransitiveDependencies => +// _allTransitiveDependencies; + +// @override +// String? get name => r'count2ProviderFamily'; + +// /// See also [count2]. +// Count2Provider call( +// int a, +// ) { +// return Count2Provider( +// a, +// ); +// } + +// /// Enables overriding the behavior of this provider, no matter the parameters. +// Override overrideWith(int Function(Count2Ref ref) create) { +// return _$Count2FamilyOverride(this, create); +// } + +// @override +// String toString() => 'count2ProviderFamily'; +// } + +// class _$Count2FamilyOverride implements $FamilyOverride { +// _$Count2FamilyOverride(this.from, this.create); + +// final int Function(Count2Ref ref) create; + +// @override +// final Count2Family from; + +// @override +// _Count2ProviderElement createElement( +// ProviderContainer container, +// covariant Count2Provider provider, +// ) { +// return provider._copyWith(create).createElement(container); +// } + +// @override +// String toString() => 'count2ProviderFamily.overrideWith(...)'; +// } + +// /// See also [count2]. +// class Count2Provider extends AutoDisposeProvider { +// /// See also [count2]. +// Count2Provider( +// int a, +// ) : this._internal( +// (ref) => count2( +// ref as Count2Ref, +// a, +// ), +// from: count2ProviderFamily, +// name: r'count2ProviderFamily', +// debugGetCreateSourceHash: +// const bool.fromEnvironment('dart.vm.product') +// ? null +// : _$count2Hash, +// dependencies: null, +// allTransitiveDependencies: null, +// a: a, +// ); + +// Count2Provider._internal( +// super.create, { +// required super.name, +// required super.dependencies, +// required super.allTransitiveDependencies, +// required super.debugGetCreateSourceHash, +// required super.from, +// required this.a, +// }) : super.internal(); + +// final int a; + +// @override +// Override overrideWith( +// int Function(Count2Ref ref) create, +// ) { +// return $ProviderOverride( +// origin: this, +// providerOverride: Count2Provider._internal( +// (ref) => create(ref as Count2Ref), +// from: from, +// name: null, +// dependencies: null, +// allTransitiveDependencies: null, +// debugGetCreateSourceHash: null, +// a: a, +// ), +// ); +// } + +// @override +// (int,) get argument { +// return (a,); +// } + +// @override +// _Count2ProviderElement createElement( +// ProviderContainer container, +// ) { +// return _Count2ProviderElement(this, container); +// } + +// Count2Provider _copyWith( +// int Function(Count2Ref ref) create, +// ) { +// return Count2Provider._internal( +// (ref) => create(ref as Count2Ref), +// name: name, +// dependencies: dependencies, +// allTransitiveDependencies: allTransitiveDependencies, +// debugGetCreateSourceHash: debugGetCreateSourceHash, +// from: from, +// a: a, +// ); +// } + +// @override +// bool operator ==(Object other) { +// return other is Count2Provider && other.a == a; +// } + +// @override +// int get hashCode { +// var hash = _SystemHash.combine(0, runtimeType.hashCode); +// hash = _SystemHash.combine(hash, a.hashCode); + +// return _SystemHash.finish(hash); +// } + +// @override +// String toString() => 'count2ProviderFamily$argument'; +// } + +// mixin Count2Ref on AutoDisposeProviderRef { +// /// The parameter `a` of this provider. +// int get a; +// } + +// class _Count2ProviderElement extends AutoDisposeProviderElement +// with Count2Ref { +// _Count2ProviderElement(super.provider, super.container); + +// @override +// int get a => (origin as Count2Provider).a; +// } + +// String _$countFuture2Hash() => r'096675b70a267f5d7c62ac7d3e7dd231ef529034'; + +// /// See also [countFuture2]. +// @ProviderFor(countFuture2) +// const countFuture2ProviderFamily = CountFuture2Family(); + +// /// See also [countFuture2]. +// class CountFuture2Family extends Family { +// /// See also [countFuture2]. +// const CountFuture2Family(); + +// static const Iterable? _dependencies = null; + +// static const Iterable? _allTransitiveDependencies = null; + +// @override +// Iterable? get dependencies => _dependencies; + +// @override +// Iterable? get allTransitiveDependencies => +// _allTransitiveDependencies; + +// @override +// String? get name => r'countFuture2ProviderFamily'; + +// /// See also [countFuture2]. +// CountFuture2Provider call( +// int a, +// ) { +// return CountFuture2Provider( +// a, +// ); +// } + +// /// Enables overriding the behavior of this provider, no matter the parameters. +// Override overrideWith(FutureOr Function(CountFuture2Ref ref) create) { +// return _$CountFuture2FamilyOverride(this, create); +// } + +// @override +// String toString() => 'countFuture2ProviderFamily'; +// } + +// class _$CountFuture2FamilyOverride implements $FamilyOverride { +// _$CountFuture2FamilyOverride(this.from, this.create); + +// final FutureOr Function(CountFuture2Ref ref) create; + +// @override +// final CountFuture2Family from; + +// @override +// _CountFuture2ProviderElement createElement( +// ProviderContainer container, +// covariant CountFuture2Provider provider, +// ) { +// return provider._copyWith(create).createElement(container); +// } + +// @override +// String toString() => 'countFuture2ProviderFamily.overrideWith(...)'; +// } + +// /// See also [countFuture2]. +// class CountFuture2Provider extends AutoDisposeFutureProvider { +// /// See also [countFuture2]. +// CountFuture2Provider( +// int a, +// ) : this._internal( +// (ref) => countFuture2( +// ref as CountFuture2Ref, +// a, +// ), +// from: countFuture2ProviderFamily, +// name: r'countFuture2ProviderFamily', +// debugGetCreateSourceHash: +// const bool.fromEnvironment('dart.vm.product') +// ? null +// : _$countFuture2Hash, +// dependencies: null, +// allTransitiveDependencies: null, +// a: a, +// ); + +// CountFuture2Provider._internal( +// super.create, { +// required super.name, +// required super.dependencies, +// required super.allTransitiveDependencies, +// required super.debugGetCreateSourceHash, +// required super.from, +// required this.a, +// }) : super.internal(); + +// final int a; + +// @override +// Override overrideWith( +// FutureOr Function(CountFuture2Ref ref) create, +// ) { +// return $ProviderOverride( +// origin: this, +// providerOverride: CountFuture2Provider._internal( +// (ref) => create(ref as CountFuture2Ref), +// from: from, +// name: null, +// dependencies: null, +// allTransitiveDependencies: null, +// debugGetCreateSourceHash: null, +// a: a, +// ), +// ); +// } + +// @override +// (int,) get argument { +// return (a,); +// } + +// @override +// _CountFuture2ProviderElement createElement( +// ProviderContainer container, +// ) { +// return _CountFuture2ProviderElement(this, container); +// } + +// CountFuture2Provider _copyWith( +// FutureOr Function(CountFuture2Ref ref) create, +// ) { +// return CountFuture2Provider._internal( +// (ref) => create(ref as CountFuture2Ref), +// name: name, +// dependencies: dependencies, +// allTransitiveDependencies: allTransitiveDependencies, +// debugGetCreateSourceHash: debugGetCreateSourceHash, +// from: from, +// a: a, +// ); +// } + +// @override +// bool operator ==(Object other) { +// return other is CountFuture2Provider && other.a == a; +// } + +// @override +// int get hashCode { +// var hash = _SystemHash.combine(0, runtimeType.hashCode); +// hash = _SystemHash.combine(hash, a.hashCode); + +// return _SystemHash.finish(hash); +// } + +// @override +// String toString() => 'countFuture2ProviderFamily$argument'; +// } + +// mixin CountFuture2Ref on AutoDisposeFutureProviderRef { +// /// The parameter `a` of this provider. +// int get a; +// } + +// class _CountFuture2ProviderElement extends AutoDisposeFutureProviderElement +// with CountFuture2Ref { +// _CountFuture2ProviderElement(super.provider, super.container); + +// @override +// int get a => (origin as CountFuture2Provider).a; +// } + +// String _$countStream2Hash() => r'051264dd685ebc0a57e454bb676957c93cb4ae20'; + +// /// See also [countStream2]. +// @ProviderFor(countStream2) +// const countStream2ProviderFamily = CountStream2Family(); + +// /// See also [countStream2]. +// class CountStream2Family extends Family { +// /// See also [countStream2]. +// const CountStream2Family(); + +// static const Iterable? _dependencies = null; + +// static const Iterable? _allTransitiveDependencies = null; + +// @override +// Iterable? get dependencies => _dependencies; + +// @override +// Iterable? get allTransitiveDependencies => +// _allTransitiveDependencies; + +// @override +// String? get name => r'countStream2ProviderFamily'; + +// /// See also [countStream2]. +// CountStream2Provider call( +// int a, +// ) { +// return CountStream2Provider( +// a, +// ); +// } + +// /// Enables overriding the behavior of this provider, no matter the parameters. +// Override overrideWith(Stream Function(CountStream2Ref ref) create) { +// return _$CountStream2FamilyOverride(this, create); +// } + +// @override +// String toString() => 'countStream2ProviderFamily'; +// } + +// class _$CountStream2FamilyOverride implements $FamilyOverride { +// _$CountStream2FamilyOverride(this.from, this.create); + +// final Stream Function(CountStream2Ref ref) create; + +// @override +// final CountStream2Family from; + +// @override +// _CountStream2ProviderElement createElement( +// ProviderContainer container, +// covariant CountStream2Provider provider, +// ) { +// return provider._copyWith(create).createElement(container); +// } + +// @override +// String toString() => 'countStream2ProviderFamily.overrideWith(...)'; +// } + +// /// See also [countStream2]. +// class CountStream2Provider extends AutoDisposeStreamProvider { +// /// See also [countStream2]. +// CountStream2Provider( +// int a, +// ) : this._internal( +// (ref) => countStream2( +// ref as CountStream2Ref, +// a, +// ), +// from: countStream2ProviderFamily, +// name: r'countStream2ProviderFamily', +// debugGetCreateSourceHash: +// const bool.fromEnvironment('dart.vm.product') +// ? null +// : _$countStream2Hash, +// dependencies: null, +// allTransitiveDependencies: null, +// a: a, +// ); + +// CountStream2Provider._internal( +// super.create, { +// required super.name, +// required super.dependencies, +// required super.allTransitiveDependencies, +// required super.debugGetCreateSourceHash, +// required super.from, +// required this.a, +// }) : super.internal(); + +// final int a; + +// @override +// Override overrideWith( +// Stream Function(CountStream2Ref ref) create, +// ) { +// return $ProviderOverride( +// origin: this, +// providerOverride: CountStream2Provider._internal( +// (ref) => create(ref as CountStream2Ref), +// from: from, +// name: null, +// dependencies: null, +// allTransitiveDependencies: null, +// debugGetCreateSourceHash: null, +// a: a, +// ), +// ); +// } + +// @override +// (int,) get argument { +// return (a,); +// } + +// @override +// _CountStream2ProviderElement createElement( +// ProviderContainer container, +// ) { +// return _CountStream2ProviderElement(this, container); +// } + +// CountStream2Provider _copyWith( +// Stream Function(CountStream2Ref ref) create, +// ) { +// return CountStream2Provider._internal( +// (ref) => create(ref as CountStream2Ref), +// name: name, +// dependencies: dependencies, +// allTransitiveDependencies: allTransitiveDependencies, +// debugGetCreateSourceHash: debugGetCreateSourceHash, +// from: from, +// a: a, +// ); +// } + +// @override +// bool operator ==(Object other) { +// return other is CountStream2Provider && other.a == a; +// } + +// @override +// int get hashCode { +// var hash = _SystemHash.combine(0, runtimeType.hashCode); +// hash = _SystemHash.combine(hash, a.hashCode); + +// return _SystemHash.finish(hash); +// } + +// @override +// String toString() => 'countStream2ProviderFamily$argument'; +// } + +// mixin CountStream2Ref on AutoDisposeStreamProviderRef { +// /// The parameter `a` of this provider. +// int get a; +// } + +// class _CountStream2ProviderElement extends AutoDisposeStreamProviderElement +// with CountStream2Ref { +// _CountStream2ProviderElement(super.provider, super.container); + +// @override +// int get a => (origin as CountStream2Provider).a; +// } + +// String _$countNotifierHash() => r'a8dd7a66ee0002b8af657245c4affaa206fd99ec'; + +// /// See also [CountNotifier]. +// @ProviderFor(CountNotifier) +// final countNotifierPod = +// AutoDisposeNotifierProvider.internal( +// CountNotifier.new, +// name: r'countNotifierPod', +// debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') +// ? null +// : _$countNotifierHash, +// dependencies: null, +// allTransitiveDependencies: null, +// ); + +// typedef _$CountNotifier = AutoDisposeNotifier; +// String _$countAsyncNotifierHash() => +// r'2a7049d864bf396e44a5937b4001efb4774a5f29'; + +// /// See also [CountAsyncNotifier]. +// @ProviderFor(CountAsyncNotifier) +// final countAsyncNotifierPod = +// AutoDisposeAsyncNotifierProvider.internal( +// CountAsyncNotifier.new, +// name: r'countAsyncNotifierPod', +// debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') +// ? null +// : _$countAsyncNotifierHash, +// dependencies: null, +// allTransitiveDependencies: null, +// ); + +// typedef _$CountAsyncNotifier = AutoDisposeAsyncNotifier; +// String _$countStreamNotifierHash() => +// r'61d2cd311c4808f8d7e8b2d67f5c7b85337666c6'; + +// /// See also [CountStreamNotifier]. +// @ProviderFor(CountStreamNotifier) +// final countStreamNotifierPod = +// AutoDisposeStreamNotifierProvider.internal( +// CountStreamNotifier.new, +// name: r'countStreamNotifierPod', +// debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') +// ? null +// : _$countStreamNotifierHash, +// dependencies: null, +// allTransitiveDependencies: null, +// ); + +// typedef _$CountStreamNotifier = AutoDisposeStreamNotifier; +// String _$countNotifier2Hash() => r'ef12bb4f94add336804ae43bcdbcd8e9b0bec420'; + +// abstract class _$CountNotifier2 extends BuildlessAutoDisposeNotifier { +// late final int a; + +// int build( +// int a, +// ); +// } + +// /// See also [CountNotifier2]. +// @ProviderFor(CountNotifier2) +// const countNotifier2ProviderFamily = CountNotifier2Family(); + +// /// See also [CountNotifier2]. +// class CountNotifier2Family extends Family { +// /// See also [CountNotifier2]. +// const CountNotifier2Family(); + +// static const Iterable? _dependencies = null; + +// static const Iterable? _allTransitiveDependencies = null; + +// @override +// Iterable? get dependencies => _dependencies; + +// @override +// Iterable? get allTransitiveDependencies => +// _allTransitiveDependencies; + +// @override +// String? get name => r'countNotifier2ProviderFamily'; + +// /// See also [CountNotifier2]. +// CountNotifier2Provider call( +// int a, +// ) { +// return CountNotifier2Provider( +// a, +// ); +// } + +// /// Enables overriding the behavior of this provider, no matter the parameters. +// Override overrideWith(CountNotifier2 Function() create) { +// return _$CountNotifier2FamilyOverride(this, create); +// } + +// @override +// String toString() => 'countNotifier2ProviderFamily'; +// } + +// class _$CountNotifier2FamilyOverride implements $FamilyOverride { +// _$CountNotifier2FamilyOverride(this.from, this.create); + +// final CountNotifier2 Function() create; + +// @override +// final CountNotifier2Family from; + +// @override +// _CountNotifier2ProviderElement createElement( +// ProviderContainer container, +// covariant CountNotifier2Provider provider, +// ) { +// return provider._copyWith(create).createElement(container); +// } + +// @override +// String toString() => 'countNotifier2ProviderFamily.overrideWith(...)'; +// } + +// /// See also [CountNotifier2]. +// class CountNotifier2Provider +// extends AutoDisposeNotifierProviderImpl { +// /// See also [CountNotifier2]. +// CountNotifier2Provider( +// int a, +// ) : this._internal( +// () => CountNotifier2()..a = a, +// from: countNotifier2ProviderFamily, +// name: r'countNotifier2ProviderFamily', +// debugGetCreateSourceHash: +// const bool.fromEnvironment('dart.vm.product') +// ? null +// : _$countNotifier2Hash, +// dependencies: null, +// allTransitiveDependencies: null, +// a: a, +// ); + +// CountNotifier2Provider._internal( +// super.create, { +// required super.name, +// required super.dependencies, +// required super.allTransitiveDependencies, +// required super.debugGetCreateSourceHash, +// required super.from, +// required this.a, +// }) : super.internal(); + +// final int a; + +// @override +// int runNotifierBuild( +// covariant CountNotifier2 notifier, +// ) { +// return notifier.build( +// a, +// ); +// } + +// @override +// Override overrideWith(CountNotifier2 Function() create) { +// return $ProviderOverride( +// origin: this, +// providerOverride: CountNotifier2Provider._internal( +// () => create()..a = a, +// from: from, +// name: null, +// dependencies: null, +// allTransitiveDependencies: null, +// debugGetCreateSourceHash: null, +// a: a, +// ), +// ); +// } + +// @override +// (int,) get argument { +// return (a,); +// } + +// @override +// _CountNotifier2ProviderElement createElement( +// ProviderContainer container, +// ) { +// return _CountNotifier2ProviderElement(this, container); +// } + +// CountNotifier2Provider _copyWith( +// CountNotifier2 Function() create, +// ) { +// return CountNotifier2Provider._internal( +// () => create()..a = a, +// name: name, +// dependencies: dependencies, +// allTransitiveDependencies: allTransitiveDependencies, +// debugGetCreateSourceHash: debugGetCreateSourceHash, +// from: from, +// a: a, +// ); +// } + +// @override +// bool operator ==(Object other) { +// return other is CountNotifier2Provider && other.a == a; +// } + +// @override +// int get hashCode { +// var hash = _SystemHash.combine(0, runtimeType.hashCode); +// hash = _SystemHash.combine(hash, a.hashCode); + +// return _SystemHash.finish(hash); +// } + +// @override +// String toString() => 'countNotifier2ProviderFamily$argument'; +// } + +// mixin CountNotifier2Ref on AutoDisposeNotifierProviderRef { +// /// The parameter `a` of this provider. +// int get a; +// } + +// class _CountNotifier2ProviderElement +// extends AutoDisposeNotifierProviderElement +// with CountNotifier2Ref { +// _CountNotifier2ProviderElement(super.provider, super.container); + +// @override +// int get a => (origin as CountNotifier2Provider).a; +// } + +// String _$countAsyncNotifier2Hash() => +// r'e4bd4d858edbb47fa0d7581f3cfa72e13c914d3d'; + +// abstract class _$CountAsyncNotifier2 +// extends BuildlessAutoDisposeAsyncNotifier { +// late final int a; + +// FutureOr build( +// int a, +// ); +// } + +// /// See also [CountAsyncNotifier2]. +// @ProviderFor(CountAsyncNotifier2) +// const countAsyncNotifier2ProviderFamily = CountAsyncNotifier2Family(); + +// /// See also [CountAsyncNotifier2]. +// class CountAsyncNotifier2Family extends Family { +// /// See also [CountAsyncNotifier2]. +// const CountAsyncNotifier2Family(); + +// static const Iterable? _dependencies = null; + +// static const Iterable? _allTransitiveDependencies = null; + +// @override +// Iterable? get dependencies => _dependencies; + +// @override +// Iterable? get allTransitiveDependencies => +// _allTransitiveDependencies; + +// @override +// String? get name => r'countAsyncNotifier2ProviderFamily'; + +// /// See also [CountAsyncNotifier2]. +// CountAsyncNotifier2Provider call( +// int a, +// ) { +// return CountAsyncNotifier2Provider( +// a, +// ); +// } + +// /// Enables overriding the behavior of this provider, no matter the parameters. +// Override overrideWith(CountAsyncNotifier2 Function() create) { +// return _$CountAsyncNotifier2FamilyOverride(this, create); +// } + +// @override +// String toString() => 'countAsyncNotifier2ProviderFamily'; +// } + +// class _$CountAsyncNotifier2FamilyOverride implements $FamilyOverride { +// _$CountAsyncNotifier2FamilyOverride(this.from, this.create); + +// final CountAsyncNotifier2 Function() create; + +// @override +// final CountAsyncNotifier2Family from; + +// @override +// _CountAsyncNotifier2ProviderElement createElement( +// ProviderContainer container, +// covariant CountAsyncNotifier2Provider provider, +// ) { +// return provider._copyWith(create).createElement(container); +// } + +// @override +// String toString() => 'countAsyncNotifier2ProviderFamily.overrideWith(...)'; +// } + +// /// See also [CountAsyncNotifier2]. +// class CountAsyncNotifier2Provider +// extends AutoDisposeAsyncNotifierProviderImpl { +// /// See also [CountAsyncNotifier2]. +// CountAsyncNotifier2Provider( +// int a, +// ) : this._internal( +// () => CountAsyncNotifier2()..a = a, +// from: countAsyncNotifier2ProviderFamily, +// name: r'countAsyncNotifier2ProviderFamily', +// debugGetCreateSourceHash: +// const bool.fromEnvironment('dart.vm.product') +// ? null +// : _$countAsyncNotifier2Hash, +// dependencies: null, +// allTransitiveDependencies: null, +// a: a, +// ); + +// CountAsyncNotifier2Provider._internal( +// super.create, { +// required super.name, +// required super.dependencies, +// required super.allTransitiveDependencies, +// required super.debugGetCreateSourceHash, +// required super.from, +// required this.a, +// }) : super.internal(); + +// final int a; + +// @override +// FutureOr runNotifierBuild( +// covariant CountAsyncNotifier2 notifier, +// ) { +// return notifier.build( +// a, +// ); +// } + +// @override +// Override overrideWith(CountAsyncNotifier2 Function() create) { +// return $ProviderOverride( +// origin: this, +// providerOverride: CountAsyncNotifier2Provider._internal( +// () => create()..a = a, +// from: from, +// name: null, +// dependencies: null, +// allTransitiveDependencies: null, +// debugGetCreateSourceHash: null, +// a: a, +// ), +// ); +// } + +// @override +// (int,) get argument { +// return (a,); +// } + +// @override +// _CountAsyncNotifier2ProviderElement createElement( +// ProviderContainer container, +// ) { +// return _CountAsyncNotifier2ProviderElement(this, container); +// } + +// CountAsyncNotifier2Provider _copyWith( +// CountAsyncNotifier2 Function() create, +// ) { +// return CountAsyncNotifier2Provider._internal( +// () => create()..a = a, +// name: name, +// dependencies: dependencies, +// allTransitiveDependencies: allTransitiveDependencies, +// debugGetCreateSourceHash: debugGetCreateSourceHash, +// from: from, +// a: a, +// ); +// } + +// @override +// bool operator ==(Object other) { +// return other is CountAsyncNotifier2Provider && other.a == a; +// } + +// @override +// int get hashCode { +// var hash = _SystemHash.combine(0, runtimeType.hashCode); +// hash = _SystemHash.combine(hash, a.hashCode); + +// return _SystemHash.finish(hash); +// } + +// @override +// String toString() => 'countAsyncNotifier2ProviderFamily$argument'; +// } + +// mixin CountAsyncNotifier2Ref on AutoDisposeAsyncNotifierProviderRef { +// /// The parameter `a` of this provider. +// int get a; +// } + +// class _CountAsyncNotifier2ProviderElement +// extends AutoDisposeAsyncNotifierProviderElement +// with CountAsyncNotifier2Ref { +// _CountAsyncNotifier2ProviderElement(super.provider, super.container); + +// @override +// int get a => (origin as CountAsyncNotifier2Provider).a; +// } + +// String _$countStreamNotifier2Hash() => +// r'13be1b7aa32801b33c68f2a228851d2fb6a4a9ee'; + +// abstract class _$CountStreamNotifier2 +// extends BuildlessAutoDisposeStreamNotifier { +// late final int a; + +// Stream build( +// int a, +// ); +// } + +// /// See also [CountStreamNotifier2]. +// @ProviderFor(CountStreamNotifier2) +// const countStreamNotifier2ProviderFamily = CountStreamNotifier2Family(); + +// /// See also [CountStreamNotifier2]. +// class CountStreamNotifier2Family extends Family { +// /// See also [CountStreamNotifier2]. +// const CountStreamNotifier2Family(); + +// static const Iterable? _dependencies = null; + +// static const Iterable? _allTransitiveDependencies = null; + +// @override +// Iterable? get dependencies => _dependencies; + +// @override +// Iterable? get allTransitiveDependencies => +// _allTransitiveDependencies; + +// @override +// String? get name => r'countStreamNotifier2ProviderFamily'; + +// /// See also [CountStreamNotifier2]. +// CountStreamNotifier2Provider call( +// int a, +// ) { +// return CountStreamNotifier2Provider( +// a, +// ); +// } + +// /// Enables overriding the behavior of this provider, no matter the parameters. +// Override overrideWith(CountStreamNotifier2 Function() create) { +// return _$CountStreamNotifier2FamilyOverride(this, create); +// } + +// @override +// String toString() => 'countStreamNotifier2ProviderFamily'; +// } + +// class _$CountStreamNotifier2FamilyOverride implements $FamilyOverride { +// _$CountStreamNotifier2FamilyOverride(this.from, this.create); + +// final CountStreamNotifier2 Function() create; + +// @override +// final CountStreamNotifier2Family from; + +// @override +// _CountStreamNotifier2ProviderElement createElement( +// ProviderContainer container, +// covariant CountStreamNotifier2Provider provider, +// ) { +// return provider._copyWith(create).createElement(container); +// } + +// @override +// String toString() => 'countStreamNotifier2ProviderFamily.overrideWith(...)'; +// } + +// /// See also [CountStreamNotifier2]. +// class CountStreamNotifier2Provider +// extends AutoDisposeStreamNotifierProviderImpl { +// /// See also [CountStreamNotifier2]. +// CountStreamNotifier2Provider( +// int a, +// ) : this._internal( +// () => CountStreamNotifier2()..a = a, +// from: countStreamNotifier2ProviderFamily, +// name: r'countStreamNotifier2ProviderFamily', +// debugGetCreateSourceHash: +// const bool.fromEnvironment('dart.vm.product') +// ? null +// : _$countStreamNotifier2Hash, +// dependencies: null, +// allTransitiveDependencies: null, +// a: a, +// ); + +// CountStreamNotifier2Provider._internal( +// super.create, { +// required super.name, +// required super.dependencies, +// required super.allTransitiveDependencies, +// required super.debugGetCreateSourceHash, +// required super.from, +// required this.a, +// }) : super.internal(); + +// final int a; + +// @override +// Stream runNotifierBuild( +// covariant CountStreamNotifier2 notifier, +// ) { +// return notifier.build( +// a, +// ); +// } + +// @override +// Override overrideWith(CountStreamNotifier2 Function() create) { +// return $ProviderOverride( +// origin: this, +// providerOverride: CountStreamNotifier2Provider._internal( +// () => create()..a = a, +// from: from, +// name: null, +// dependencies: null, +// allTransitiveDependencies: null, +// debugGetCreateSourceHash: null, +// a: a, +// ), +// ); +// } + +// @override +// (int,) get argument { +// return (a,); +// } + +// @override +// _CountStreamNotifier2ProviderElement createElement( +// ProviderContainer container, +// ) { +// return _CountStreamNotifier2ProviderElement(this, container); +// } + +// CountStreamNotifier2Provider _copyWith( +// CountStreamNotifier2 Function() create, +// ) { +// return CountStreamNotifier2Provider._internal( +// () => create()..a = a, +// name: name, +// dependencies: dependencies, +// allTransitiveDependencies: allTransitiveDependencies, +// debugGetCreateSourceHash: debugGetCreateSourceHash, +// from: from, +// a: a, +// ); +// } + +// @override +// bool operator ==(Object other) { +// return other is CountStreamNotifier2Provider && other.a == a; +// } + +// @override +// int get hashCode { +// var hash = _SystemHash.combine(0, runtimeType.hashCode); +// hash = _SystemHash.combine(hash, a.hashCode); + +// return _SystemHash.finish(hash); +// } + +// @override +// String toString() => 'countStreamNotifier2ProviderFamily$argument'; +// } + +// mixin CountStreamNotifier2Ref on AutoDisposeStreamNotifierProviderRef { +// /// The parameter `a` of this provider. +// int get a; +// } + +// class _CountStreamNotifier2ProviderElement +// extends AutoDisposeStreamNotifierProviderElement +// with CountStreamNotifier2Ref { +// _CountStreamNotifier2ProviderElement(super.provider, super.container); + +// @override +// int get a => (origin as CountStreamNotifier2Provider).a; +// } +// // ignore_for_file: type=lint +// // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index 2998119f7..765469030 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -11,6 +11,7 @@ import 'models.dart'; import 'parse_generator.dart'; import 'templates/family.dart'; import 'templates/hash.dart'; +import 'templates/notifier.dart'; import 'templates/provider.dart'; import 'templates/provider_variable.dart'; import 'templates/ref.dart'; @@ -114,6 +115,7 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { ProviderVariableTemplate(provider, options).run(buffer); ProviderTemplate(provider).run(buffer); HashFnTemplate(provider).run(buffer); + FamilyTemplate(provider, options).run(buffer); } @override @@ -122,6 +124,7 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { ) { super.visitClassBasedProviderDeclaration(provider); visitGeneratorProviderDeclaration(provider); + NotifierTemplate(provider).run(buffer); } @override @@ -130,7 +133,6 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { ) { super.visitFunctionalProviderDeclaration(provider); RefTemplate(provider).run(buffer); - FamilyTemplate(provider, options).run(buffer); visitGeneratorProviderDeclaration(provider); } } diff --git a/packages/riverpod_generator/lib/src/templates/family_back.dart b/packages/riverpod_generator/lib/src/templates/family_back.dart index af50144c5..4fcae7493 100644 --- a/packages/riverpod_generator/lib/src/templates/family_back.dart +++ b/packages/riverpod_generator/lib/src/templates/family_back.dart @@ -404,10 +404,17 @@ extension ProviderNames on GeneratorProviderDeclaration { } } - String get elementName => switch (createdType) { - SupportedCreatedType.future => r'$FutureProviderElement', - SupportedCreatedType.stream => r'$StreamProviderElement', - SupportedCreatedType.value => r'$ProviderElement', + String get elementName => switch (this) { + ClassBasedProviderDeclaration() => switch (createdType) { + SupportedCreatedType.future => r'$AsyncNotifierProviderElement', + SupportedCreatedType.stream => r'$StreamNotifierProviderElement', + SupportedCreatedType.value => r'$NotifierProviderElement', + }, + FunctionalProviderDeclaration() => switch (createdType) { + SupportedCreatedType.future => r'$FutureProviderElement', + SupportedCreatedType.stream => r'$StreamProviderElement', + SupportedCreatedType.value => r'$ProviderElement', + }, }; String get hashFnName => '_\$${providerElement.name.public.lowerFirst}Hash'; diff --git a/packages/riverpod_generator/lib/src/templates/hash.dart b/packages/riverpod_generator/lib/src/templates/hash.dart index 53613197a..e99830a1b 100644 --- a/packages/riverpod_generator/lib/src/templates/hash.dart +++ b/packages/riverpod_generator/lib/src/templates/hash.dart @@ -11,7 +11,7 @@ class HashFnTemplate extends Template { @override void run(StringBuffer buffer) { buffer.writeln( - "String ${provider.hashFnName}() => r'${provider.computeProviderHash()}';", + "String ${provider.hashFnName}() => r'${provider.computeProviderHash()}';\n", ); } } diff --git a/packages/riverpod_generator/lib/src/templates/notifier.dart b/packages/riverpod_generator/lib/src/templates/notifier.dart new file mode 100644 index 000000000..dbd48827a --- /dev/null +++ b/packages/riverpod_generator/lib/src/templates/notifier.dart @@ -0,0 +1,41 @@ +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; + +import '../models.dart'; +import '../type.dart'; +import 'family_back.dart'; +import 'parameters.dart'; +import 'template.dart'; + +class NotifierTemplate extends Template { + NotifierTemplate(this.provider); + + final ClassBasedProviderDeclaration provider; + + @override + void run(StringBuffer buffer) { + final notifierBaseName = '_\$${provider.name.lexeme.public}'; + final genericsDefinition = provider.genericsDefinition(); + final buildParams = buildParamDefinitionQuery(provider.parameters); + + final baseClass = switch (provider.createdType) { + SupportedCreatedType.future => + '\$AsyncNotifier<${provider.valueTypeDisplayString}>', + SupportedCreatedType.stream => + '\$StreamNotifier<${provider.valueTypeDisplayString}>', + SupportedCreatedType.value => + '\$cNotifier<${provider.valueTypeDisplayString}>', + }; + + buffer.writeln(''' +abstract class $notifierBaseName$genericsDefinition extends $baseClass { + ${provider.createdTypeDisplayString} build($buildParams); + + @\$internal + @override + void runBuild() { + + } +} +'''); + } +} diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index be9fafeb3..cd8b31e61 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -16,15 +16,17 @@ class ProviderTemplate extends Template { final generics = provider.generics(); final genericsDefinition = provider.genericsDefinition(); + final name = provider.providerTypeName; + final exposedType = provider.exposedTypeDisplayString; + final createdType = provider.createdTypeDisplayString; + final valueType = provider.valueTypeDisplayString; + final refType = switch (provider) { + FunctionalProviderDeclaration() => '${provider.refImplName}$generics', + ClassBasedProviderDeclaration() => 'Ref<$exposedType>', + }; + switch (provider) { case FunctionalProviderDeclaration(): - final name = provider.providerTypeName; - final exposedType = provider.exposedTypeDisplayString; - final createdType = provider.createdTypeDisplayString; - final valueType = provider.valueTypeDisplayString; - - final refType = '${provider.refImplName}$generics'; - final List modifiers; switch (provider.createdType) { @@ -44,8 +46,7 @@ class ProviderTemplate extends Template { final mixins = modifiers.isEmpty ? '' : ' with ${modifiers.join(', ')}'; - buffer.writeln( - ''' + buffer.writeln(''' final class $name$genericsDefinition extends \$FunctionalProvider< $exposedType, @@ -53,15 +54,30 @@ final class $name$genericsDefinition $refType > $mixins { -''', - ); +'''); + + case ClassBasedProviderDeclaration(): + final notifierType = '${provider.name}$generics'; - _writeMembers(buffer); + final String baseClass; - buffer.writeln('}'); + switch (provider.createdType) { + case SupportedCreatedType.future: + baseClass = '\$AsyncNotifierProvider<$notifierType, $valueType>'; + case SupportedCreatedType.stream: + baseClass = '\$StreamNotifierProvider<$notifierType, $valueType>'; + case SupportedCreatedType.value: + baseClass = '\$NotifierProvider<$notifierType, $valueType>'; + } - default: + buffer.writeln( + 'final class $name$genericsDefinition extends $baseClass {', + ); } + + _writeMembers(buffer); + + buffer.writeln('}'); } void _writeMembers(StringBuffer buffer) { @@ -113,18 +129,6 @@ final class $name$genericsDefinition ); final ${provider.createType()}? _createCb; - - @override - ${provider.createdTypeDisplayString} create(${provider.refImplName}$generics ref){ - final fn = _createCb ?? ${provider.name}$generics; - $localArgumentDefinition - return fn(ref, $paramsPassThrough); - } - - @override - ${provider.elementName}<${provider.valueTypeDisplayString}> createElement( - ProviderContainer container - ) => ${provider.elementName}(this, container); '''); switch (provider) { @@ -144,6 +148,21 @@ final class $name$genericsDefinition buffer.writeln(''' @override + ${provider.elementName}<${provider.valueTypeDisplayString}> createElement( + ProviderContainer container + ) => ${provider.elementName}(this, container); +'''); + + buffer.writeln(''' + @override + ${provider.createdTypeDisplayString} create(${provider.refImplName}$generics ref){ + final fn = _createCb ?? ${provider.name}$generics; + $localArgumentDefinition + return fn(ref, $paramsPassThrough); + }'''); + + buffer.writeln(''' + @override ${provider.providerTypeName}$generics copyWithCreate( ${provider.createType(withArguments: false)} create, ) { @@ -153,7 +172,13 @@ final class $name$genericsDefinition ); } '''); - default: + case ClassBasedProviderDeclaration(): + buffer.writeln(''' + @override + ${provider.elementName}<${provider.name}$generics, ${provider.valueTypeDisplayString}> createElement( + ProviderContainer container + ) => ${provider.elementName}(this, container); +'''); } if (provider.providerElement.isFamily) { diff --git a/packages/riverpod_generator/lib/src/templates/provider_variable.dart b/packages/riverpod_generator/lib/src/templates/provider_variable.dart index 69378eec1..d5abbfc86 100644 --- a/packages/riverpod_generator/lib/src/templates/provider_variable.dart +++ b/packages/riverpod_generator/lib/src/templates/provider_variable.dart @@ -13,19 +13,16 @@ class ProviderVariableTemplate extends Template { @override void run(StringBuffer buffer) { - final provider = this.provider; - final providerName = providerNameFor(provider.providerElement, options); switch (provider) { case _ when provider.providerElement.isFamily: - buffer.writeln('const $providerName = ${provider.familyTypeName}._();'); + buffer + .writeln('const $providerName = ${provider.familyTypeName}._();\n'); - case FunctionalProviderDeclaration(): + case _: final providerType = provider.providerTypeName; - - buffer.writeln('const $providerName = $providerType._();'); - default: + buffer.writeln('const $providerName = $providerType._();\n'); } } } diff --git a/packages/riverpod_generator/test/async_notifier_test.dart b/packages/riverpod_generator/test/async_notifier_test.dart index df2d7d17f..60237ef91 100644 --- a/packages/riverpod_generator/test/async_notifier_test.dart +++ b/packages/riverpod_generator/test/async_notifier_test.dart @@ -1,149 +1,149 @@ -// ignore_for_file: omit_local_variable_types, unused_local_variable - -import 'package:riverpod_annotation/riverpod_annotation.dart'; -import 'package:test/test.dart'; - -import 'integration/async.dart'; -import 'utils.dart'; - -void main() { - test( - 'Creates an AsyncNotifierProvider if @riverpod is used on an async class', - () { - final container = createContainer(); - - final AutoDisposeAsyncNotifierProvider provider = - publicClassProvider; - final AsyncValue result = container.read(publicClassProvider); - - expect(result, const AsyncData('Hello world')); - }); - - test('Generates .name for providers', () { - expect(publicClassProvider.name, 'publicClassProvider'); - expect(privateClassProvider.name, '_privateClassProvider'); - - expect(familyClassProvider.name, 'familyClassProvider'); - expect(familyClassProvider(42, third: .42).name, 'familyClassProvider'); - }); - - test('Supports overriding non-family notifiers', () { - final container = createContainer( - overrides: [ - publicClassProvider.overrideWith(() => PublicClass('Hello world')), - ], - ); - - final notifier = container.read(publicClassProvider.notifier); - expect(notifier.param, 'Hello world'); - - expect(notifier.ref, isNotNull); - expect(notifier.state, isNotNull); - }); - - test('Supports overriding family notifiers', () { - final container = createContainer( - overrides: [ - familyClassProvider(42, third: .42) - .overrideWith(() => FamilyClass('Hello world')), - ], - ); - - final notifier = - container.read(familyClassProvider(42, third: .42).notifier); - expect(notifier.param, 'Hello world'); - expect(notifier.first, 42); - expect(notifier.second, null); - expect(notifier.third, .42); - expect(notifier.fourth, true); - expect(notifier.fifth, null); - - expect(notifier.ref, isNotNull); - expect(notifier.state, isNotNull); - }); - - test( - 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', - () async { - final container = createContainer(); - - const FamilyClassFamily family = familyClassProvider; - - expect(familyClassProvider(42, third: .42).from, familyClassProvider); - - expect( - familyClassProvider(42, third: .42), - familyClassProvider(42, third: .42), - ); - expect( - familyClassProvider(42, third: .42), - isNot(familyClassProvider(42, third: .21)), - ); - expect( - familyClassProvider(42, third: .42).hashCode, - isNot(familyClassProvider(42, third: .21).hashCode), - ); - - // handle defaults - expect( - familyClassProvider(42, third: .42), - familyClassProvider( - 42, - third: .42, - ), - ); - expect( - familyClassProvider(42, third: .42).hashCode, - familyClassProvider( - 42, - third: .42, - ).hashCode, - ); - - final FamilyClassProvider provider = familyClassProvider( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: const ['x42'], - ); - // ignore: invalid_use_of_internal_member - final AutoDisposeAsyncNotifierProviderImpl - futureProvider = provider; - - expect(provider.first, 42); - expect(provider.second, 'x42'); - expect(provider.third, .42); - expect(provider.fourth, false); - expect(provider.fifth, same(const ['x42'])); - - final sub = container.listen( - familyClassProvider( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: const ['x42'], - ).future, - (previous, next) {}, - ); - await sub.read(); - - final AsyncValue result = container.read( - familyClassProvider( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: const ['x42'], - ), - ); - - expect( - result, - const AsyncData( - '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', - ), - ); - }); -} +// // ignore_for_file: omit_local_variable_types, unused_local_variable + +// import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:test/test.dart'; + +// import 'integration/async.dart'; +// import 'utils.dart'; + +// void main() { +// test( +// 'Creates an AsyncNotifierProvider if @riverpod is used on an async class', +// () { +// final container = createContainer(); + +// final AutoDisposeAsyncNotifierProvider provider = +// publicClassProvider; +// final AsyncValue result = container.read(publicClassProvider); + +// expect(result, const AsyncData('Hello world')); +// }); + +// test('Generates .name for providers', () { +// expect(publicClassProvider.name, 'publicClassProvider'); +// expect(privateClassProvider.name, '_privateClassProvider'); + +// expect(familyClassProvider.name, 'familyClassProvider'); +// expect(familyClassProvider(42, third: .42).name, 'familyClassProvider'); +// }); + +// test('Supports overriding non-family notifiers', () { +// final container = createContainer( +// overrides: [ +// publicClassProvider.overrideWith(() => PublicClass('Hello world')), +// ], +// ); + +// final notifier = container.read(publicClassProvider.notifier); +// expect(notifier.param, 'Hello world'); + +// expect(notifier.ref, isNotNull); +// expect(notifier.state, isNotNull); +// }); + +// test('Supports overriding family notifiers', () { +// final container = createContainer( +// overrides: [ +// familyClassProvider(42, third: .42) +// .overrideWith(() => FamilyClass('Hello world')), +// ], +// ); + +// final notifier = +// container.read(familyClassProvider(42, third: .42).notifier); +// expect(notifier.param, 'Hello world'); +// expect(notifier.first, 42); +// expect(notifier.second, null); +// expect(notifier.third, .42); +// expect(notifier.fourth, true); +// expect(notifier.fifth, null); + +// expect(notifier.ref, isNotNull); +// expect(notifier.state, isNotNull); +// }); + +// test( +// 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', +// () async { +// final container = createContainer(); + +// const FamilyClassFamily family = familyClassProvider; + +// expect(familyClassProvider(42, third: .42).from, familyClassProvider); + +// expect( +// familyClassProvider(42, third: .42), +// familyClassProvider(42, third: .42), +// ); +// expect( +// familyClassProvider(42, third: .42), +// isNot(familyClassProvider(42, third: .21)), +// ); +// expect( +// familyClassProvider(42, third: .42).hashCode, +// isNot(familyClassProvider(42, third: .21).hashCode), +// ); + +// // handle defaults +// expect( +// familyClassProvider(42, third: .42), +// familyClassProvider( +// 42, +// third: .42, +// ), +// ); +// expect( +// familyClassProvider(42, third: .42).hashCode, +// familyClassProvider( +// 42, +// third: .42, +// ).hashCode, +// ); + +// final FamilyClassProvider provider = familyClassProvider( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: const ['x42'], +// ); +// // ignore: invalid_use_of_internal_member +// final AutoDisposeAsyncNotifierProviderImpl +// futureProvider = provider; + +// expect(provider.first, 42); +// expect(provider.second, 'x42'); +// expect(provider.third, .42); +// expect(provider.fourth, false); +// expect(provider.fifth, same(const ['x42'])); + +// final sub = container.listen( +// familyClassProvider( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: const ['x42'], +// ).future, +// (previous, next) {}, +// ); +// await sub.read(); + +// final AsyncValue result = container.read( +// familyClassProvider( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: const ['x42'], +// ), +// ); + +// expect( +// result, +// const AsyncData( +// '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', +// ), +// ); +// }); +// } diff --git a/packages/riverpod_generator/test/async_test.dart b/packages/riverpod_generator/test/async_test.dart index 9ba02be22..3a5964721 100644 --- a/packages/riverpod_generator/test/async_test.dart +++ b/packages/riverpod_generator/test/async_test.dart @@ -1,171 +1,171 @@ -// ignore_for_file: omit_local_variable_types, unused_local_variable - -import 'package:riverpod_annotation/riverpod_annotation.dart'; -import 'package:test/test.dart'; - -import 'integration/async.dart'; -import 'utils.dart'; - -void main() { - test( - 'Creates a FutureProvider if @riverpod is used on a FutureOr function', - () { - final container = createContainer(); - - final AutoDisposeFutureProvider provider = publicProvider; - final AsyncValue result = container.read(publicProvider); - - expect(result, const AsyncData('Hello world')); - }); - - test('Generates .name for providers', () { - expect(publicProvider.name, 'publicProvider'); - expect(privateProvider.name, '_privateProvider'); - - expect(familyProvider.name, 'familyProvider'); - expect(familyProvider(42, third: .42).name, 'familyProvider'); - }); - - test('Supports overriding non-family providers', () async { - final container = createContainer( - overrides: [ - publicProvider.overrideWith((ref) => Future.value('Hello world')), - ], - ); - - final result = container.read(publicProvider.future); - expect(await result, 'Hello world'); - }); - - test('Supports overriding family providers', () async { - final container = createContainer( - overrides: [ - familyProvider(42, third: .42).overrideWith( - (ref) => Future.value( - 'Hello world ${ref.first} ${ref.second} ' - '${ref.third} ${ref.fourth} ${ref.fifth}', - ), - ), - ], - ); - - final result = container.read(familyProvider(42, third: .42).future); - expect(await result, 'Hello world 42 null 0.42 true null'); - }); - - test( - 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', - () async { - final container = createContainer(); - - const FamilyFamily family = familyProvider; - - expect(familyProvider(42, third: .42).from, familyProvider); - - expect( - familyProvider(42, third: .42), - familyProvider(42, third: .42), - ); - expect( - familyProvider(42, third: .42), - isNot(familyProvider(42, third: .21)), - ); - expect( - familyProvider(42, third: .42).hashCode, - isNot(familyProvider(42, third: .21).hashCode), - ); - - // handle defaults - expect( - familyProvider(42, third: .42), - familyProvider( - 42, - third: .42, - ), - ); - expect( - familyProvider(42, third: .42).hashCode, - familyProvider( - 42, - third: .42, - ).hashCode, - ); - - final FamilyProvider provider = familyProvider( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: const ['x42'], - ); - final AutoDisposeFutureProvider futureProvider = provider; - - expect(provider.first, 42); - expect(provider.second, 'x42'); - expect(provider.third, .42); - expect(provider.fourth, false); - expect(provider.fifth, same(const ['x42'])); - - final sub = container.listen( - familyProvider( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: const ['x42'], - ).future, - (previous, next) {}, - ); - await sub.read(); - - final AsyncValue result = container.read( - familyProvider( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: const ['x42'], - ), - ); - - expect( - result, - const AsyncData( - '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', - ), - ); - }); - - test('can override providers', () { - final container = createContainer( - overrides: [ - publicProvider.overrideWith((ref) { - const FutureOr result = 'test'; - return result; - }), - publicClassProvider.overrideWith(() => PublicClass(42)), - familyProvider.overrideWith( - (ref) { - final FutureOr result = - 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})'; - return result; - }, - ), - familyClassProvider.overrideWith(() => FamilyClass(42)), - ], - ); - - expect(container.read(publicProvider).requireValue, 'test'); - expect(container.read(publicClassProvider.notifier).param, 42); - expect( - container.read(familyProvider(42, second: '42', third: .42)).requireValue, - 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', - ); - expect( - container - .read(familyClassProvider(42, second: '42', third: .42).notifier) - .param, - 42, - ); - }); -} +// // ignore_for_file: omit_local_variable_types, unused_local_variable + +// import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:test/test.dart'; + +// import 'integration/async.dart'; +// import 'utils.dart'; + +// void main() { +// test( +// 'Creates a FutureProvider if @riverpod is used on a FutureOr function', +// () { +// final container = createContainer(); + +// final AutoDisposeFutureProvider provider = publicProvider; +// final AsyncValue result = container.read(publicProvider); + +// expect(result, const AsyncData('Hello world')); +// }); + +// test('Generates .name for providers', () { +// expect(publicProvider.name, 'publicProvider'); +// expect(privateProvider.name, '_privateProvider'); + +// expect(familyProvider.name, 'familyProvider'); +// expect(familyProvider(42, third: .42).name, 'familyProvider'); +// }); + +// test('Supports overriding non-family providers', () async { +// final container = createContainer( +// overrides: [ +// publicProvider.overrideWith((ref) => Future.value('Hello world')), +// ], +// ); + +// final result = container.read(publicProvider.future); +// expect(await result, 'Hello world'); +// }); + +// test('Supports overriding family providers', () async { +// final container = createContainer( +// overrides: [ +// familyProvider(42, third: .42).overrideWith( +// (ref) => Future.value( +// 'Hello world ${ref.first} ${ref.second} ' +// '${ref.third} ${ref.fourth} ${ref.fifth}', +// ), +// ), +// ], +// ); + +// final result = container.read(familyProvider(42, third: .42).future); +// expect(await result, 'Hello world 42 null 0.42 true null'); +// }); + +// test( +// 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', +// () async { +// final container = createContainer(); + +// const FamilyFamily family = familyProvider; + +// expect(familyProvider(42, third: .42).from, familyProvider); + +// expect( +// familyProvider(42, third: .42), +// familyProvider(42, third: .42), +// ); +// expect( +// familyProvider(42, third: .42), +// isNot(familyProvider(42, third: .21)), +// ); +// expect( +// familyProvider(42, third: .42).hashCode, +// isNot(familyProvider(42, third: .21).hashCode), +// ); + +// // handle defaults +// expect( +// familyProvider(42, third: .42), +// familyProvider( +// 42, +// third: .42, +// ), +// ); +// expect( +// familyProvider(42, third: .42).hashCode, +// familyProvider( +// 42, +// third: .42, +// ).hashCode, +// ); + +// final FamilyProvider provider = familyProvider( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: const ['x42'], +// ); +// final AutoDisposeFutureProvider futureProvider = provider; + +// expect(provider.first, 42); +// expect(provider.second, 'x42'); +// expect(provider.third, .42); +// expect(provider.fourth, false); +// expect(provider.fifth, same(const ['x42'])); + +// final sub = container.listen( +// familyProvider( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: const ['x42'], +// ).future, +// (previous, next) {}, +// ); +// await sub.read(); + +// final AsyncValue result = container.read( +// familyProvider( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: const ['x42'], +// ), +// ); + +// expect( +// result, +// const AsyncData( +// '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', +// ), +// ); +// }); + +// test('can override providers', () { +// final container = createContainer( +// overrides: [ +// publicProvider.overrideWith((ref) { +// const FutureOr result = 'test'; +// return result; +// }), +// publicClassProvider.overrideWith(() => PublicClass(42)), +// familyProvider.overrideWith( +// (ref) { +// final FutureOr result = +// 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})'; +// return result; +// }, +// ), +// familyClassProvider.overrideWith(() => FamilyClass(42)), +// ], +// ); + +// expect(container.read(publicProvider).requireValue, 'test'); +// expect(container.read(publicClassProvider.notifier).param, 42); +// expect( +// container.read(familyProvider(42, second: '42', third: .42)).requireValue, +// 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', +// ); +// expect( +// container +// .read(familyClassProvider(42, second: '42', third: .42).notifier) +// .param, +// 42, +// ); +// }); +// } diff --git a/packages/riverpod_generator/test/auto_dispose_test.dart b/packages/riverpod_generator/test/auto_dispose_test.dart index affc1e10e..affab90e1 100644 --- a/packages/riverpod_generator/test/auto_dispose_test.dart +++ b/packages/riverpod_generator/test/auto_dispose_test.dart @@ -1,24 +1,24 @@ -// ignore_for_file: omit_local_variable_types, unused_local_variable +// // ignore_for_file: omit_local_variable_types, unused_local_variable -import 'package:riverpod_annotation/riverpod_annotation.dart'; -import 'package:test/test.dart'; +// import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:test/test.dart'; -import 'integration/auto_dispose.dart'; -import 'utils.dart'; +// import 'integration/auto_dispose.dart'; +// import 'utils.dart'; -void main() { - test('Respects keepAlive parameter', () { - final container = createContainer(); +// void main() { +// test('Respects keepAlive parameter', () { +// final container = createContainer(); - container.read(keepAliveProvider); +// container.read(keepAliveProvider); - expect( - container.readProviderElement(keepAliveProvider), - isA>(), - ); - expect( - container.readProviderElement(keepAliveProvider), - isNot(isA>()), - ); - }); -} +// expect( +// container.readProviderElement(keepAliveProvider), +// isA>(), +// ); +// expect( +// container.readProviderElement(keepAliveProvider), +// isNot(isA>()), +// ); +// }); +// } diff --git a/packages/riverpod_generator/test/dependencies_test.dart b/packages/riverpod_generator/test/dependencies_test.dart index 86f489f5e..03d51ad78 100644 --- a/packages/riverpod_generator/test/dependencies_test.dart +++ b/packages/riverpod_generator/test/dependencies_test.dart @@ -1,146 +1,146 @@ -import 'package:riverpod_annotation/riverpod_annotation.dart'; -import 'package:test/test.dart'; +// import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:test/test.dart'; -import 'integration/dependencies.dart'; +// import 'integration/dependencies.dart'; -void main() { - test('Supports specifying dependencies', () { - expect(depProvider.dependencies, null); - expect(dep2Provider.dependencies, null); - expect(familyProvider.dependencies, null); - expect(family2Provider.dependencies, null); +// void main() { +// test('Supports specifying dependencies', () { +// expect(depProvider.dependencies, null); +// expect(dep2Provider.dependencies, null); +// expect(familyProvider.dependencies, null); +// expect(family2Provider.dependencies, null); - expect( - providerProvider.dependencies, - [depProvider, familyProvider, dep2Provider, family2Provider], - ); - expect( - provider2Provider.dependencies, - [depProvider, familyProvider, dep2Provider, family2Provider], - ); - expect( - provider3Provider.dependencies, - [depProvider, familyProvider, dep2Provider, family2Provider], - ); - expect( - provider4Provider.dependencies, - [depProvider, familyProvider, dep2Provider, family2Provider], - ); +// expect( +// providerProvider.dependencies, +// [depProvider, familyProvider, dep2Provider, family2Provider], +// ); +// expect( +// provider2Provider.dependencies, +// [depProvider, familyProvider, dep2Provider, family2Provider], +// ); +// expect( +// provider3Provider.dependencies, +// [depProvider, familyProvider, dep2Provider, family2Provider], +// ); +// expect( +// provider4Provider.dependencies, +// [depProvider, familyProvider, dep2Provider, family2Provider], +// ); - expect(transitiveDependenciesProvider.dependencies, [providerProvider]); +// expect(transitiveDependenciesProvider.dependencies, [providerProvider]); - expect( - emptyDependenciesFunctionalProvider.dependencies, - same(const []), - ); +// expect( +// emptyDependenciesFunctionalProvider.dependencies, +// same(const []), +// ); - expect( - emptyDependenciesClassBasedProvider.dependencies, - same(const []), - ); - }); +// expect( +// emptyDependenciesClassBasedProvider.dependencies, +// same(const []), +// ); +// }); - test('Generates transitive dependencies', () { - expect(depProvider.allTransitiveDependencies, null); - expect(dep2Provider.allTransitiveDependencies, null); - expect(familyProvider.allTransitiveDependencies, null); - expect(family2Provider.allTransitiveDependencies, null); +// test('Generates transitive dependencies', () { +// expect(depProvider.allTransitiveDependencies, null); +// expect(dep2Provider.allTransitiveDependencies, null); +// expect(familyProvider.allTransitiveDependencies, null); +// expect(family2Provider.allTransitiveDependencies, null); - expect( - providerProvider.allTransitiveDependencies, - [depProvider, familyProvider, dep2Provider, family2Provider], - ); - expect( - provider2Provider.allTransitiveDependencies, - [depProvider, familyProvider, dep2Provider, family2Provider], - ); - expect( - provider3Provider.allTransitiveDependencies, - [depProvider, familyProvider, dep2Provider, family2Provider], - ); - expect( - provider4Provider.allTransitiveDependencies, - [depProvider, familyProvider, dep2Provider, family2Provider], - ); +// expect( +// providerProvider.allTransitiveDependencies, +// [depProvider, familyProvider, dep2Provider, family2Provider], +// ); +// expect( +// provider2Provider.allTransitiveDependencies, +// [depProvider, familyProvider, dep2Provider, family2Provider], +// ); +// expect( +// provider3Provider.allTransitiveDependencies, +// [depProvider, familyProvider, dep2Provider, family2Provider], +// ); +// expect( +// provider4Provider.allTransitiveDependencies, +// [depProvider, familyProvider, dep2Provider, family2Provider], +// ); - expect( - transitiveDependenciesProvider.allTransitiveDependencies, - [ - providerProvider, - depProvider, - familyProvider, - dep2Provider, - family2Provider, - ], - ); +// expect( +// transitiveDependenciesProvider.allTransitiveDependencies, +// [ +// providerProvider, +// depProvider, +// familyProvider, +// dep2Provider, +// family2Provider, +// ], +// ); - expect( - emptyDependenciesFunctionalProvider.allTransitiveDependencies, - same(const {}), - ); +// expect( +// emptyDependenciesFunctionalProvider.allTransitiveDependencies, +// same(const {}), +// ); - expect( - emptyDependenciesClassBasedProvider.allTransitiveDependencies, - same(const {}), - ); - }); +// expect( +// emptyDependenciesClassBasedProvider.allTransitiveDependencies, +// same(const {}), +// ); +// }); - test( - 'On families, passes `null` as dependencies/allTransitiveDependencies to the providers', - () { - expect(provider4Provider(42).dependencies, null); - expect(provider4Provider(42).allTransitiveDependencies, null); - }); +// test( +// 'On families, passes `null` as dependencies/allTransitiveDependencies to the providers', +// () { +// expect(provider4Provider(42).dependencies, null); +// expect(provider4Provider(42).allTransitiveDependencies, null); +// }); - test('Caches dependencies', () { - expect( - providerProvider.dependencies, - same(providerProvider.dependencies), - ); - expect( - provider2Provider.dependencies, - same(provider2Provider.dependencies), - ); - expect( - provider3Provider.dependencies, - same(provider3Provider.dependencies), - ); - expect( - provider4Provider.dependencies, - same(provider4Provider.dependencies), - ); - expect( - transitiveDependenciesProvider.dependencies, - same(transitiveDependenciesProvider.dependencies), - ); - expect( - smallTransitiveDependencyCountProvider.dependencies, - same(smallTransitiveDependencyCountProvider.dependencies), - ); - expect( - emptyDependenciesFunctionalProvider.dependencies, - same(emptyDependenciesFunctionalProvider.dependencies), - ); - expect( - emptyDependenciesClassBasedProvider.dependencies, - same(emptyDependenciesClassBasedProvider.dependencies), - ); +// test('Caches dependencies', () { +// expect( +// providerProvider.dependencies, +// same(providerProvider.dependencies), +// ); +// expect( +// provider2Provider.dependencies, +// same(provider2Provider.dependencies), +// ); +// expect( +// provider3Provider.dependencies, +// same(provider3Provider.dependencies), +// ); +// expect( +// provider4Provider.dependencies, +// same(provider4Provider.dependencies), +// ); +// expect( +// transitiveDependenciesProvider.dependencies, +// same(transitiveDependenciesProvider.dependencies), +// ); +// expect( +// smallTransitiveDependencyCountProvider.dependencies, +// same(smallTransitiveDependencyCountProvider.dependencies), +// ); +// expect( +// emptyDependenciesFunctionalProvider.dependencies, +// same(emptyDependenciesFunctionalProvider.dependencies), +// ); +// expect( +// emptyDependenciesClassBasedProvider.dependencies, +// same(emptyDependenciesClassBasedProvider.dependencies), +// ); - expect( - provider3Provider.allTransitiveDependencies, - same(provider3Provider.allTransitiveDependencies), - ); - expect( - provider4Provider.allTransitiveDependencies, - same(provider4Provider.allTransitiveDependencies), - ); - expect( - transitiveDependenciesProvider.allTransitiveDependencies, - same(transitiveDependenciesProvider.allTransitiveDependencies), - ); - expect( - smallTransitiveDependencyCountProvider.allTransitiveDependencies, - same(smallTransitiveDependencyCountProvider.allTransitiveDependencies), - ); - }); -} +// expect( +// provider3Provider.allTransitiveDependencies, +// same(provider3Provider.allTransitiveDependencies), +// ); +// expect( +// provider4Provider.allTransitiveDependencies, +// same(provider4Provider.allTransitiveDependencies), +// ); +// expect( +// transitiveDependenciesProvider.allTransitiveDependencies, +// same(transitiveDependenciesProvider.allTransitiveDependencies), +// ); +// expect( +// smallTransitiveDependencyCountProvider.allTransitiveDependencies, +// same(smallTransitiveDependencyCountProvider.allTransitiveDependencies), +// ); +// }); +// } diff --git a/packages/riverpod_generator/test/hash_test.dart b/packages/riverpod_generator/test/hash_test.dart index 377699172..42dbee531 100644 --- a/packages/riverpod_generator/test/hash_test.dart +++ b/packages/riverpod_generator/test/hash_test.dart @@ -1,35 +1,35 @@ -// ignore_for_file: invalid_use_of_internal_member +// // ignore_for_file: invalid_use_of_internal_member -import 'package:test/test.dart'; +// import 'package:test/test.dart'; -import 'integration/hash/hash1.dart'; +// import 'integration/hash/hash1.dart'; -void main() { - test('Generates hash function for providers', () { - expect( - simpleProvider.debugGetCreateSourceHash!(), - simpleProvider.debugGetCreateSourceHash!(), - ); - expect( - simple2Provider.debugGetCreateSourceHash!(), - simple2Provider.debugGetCreateSourceHash!(), - ); - expect( - simpleClassProvider.debugGetCreateSourceHash!(), - simpleClassProvider.debugGetCreateSourceHash!(), - ); +// void main() { +// test('Generates hash function for providers', () { +// expect( +// simpleProvider.debugGetCreateSourceHash!(), +// simpleProvider.debugGetCreateSourceHash!(), +// ); +// expect( +// simple2Provider.debugGetCreateSourceHash!(), +// simple2Provider.debugGetCreateSourceHash!(), +// ); +// expect( +// simpleClassProvider.debugGetCreateSourceHash!(), +// simpleClassProvider.debugGetCreateSourceHash!(), +// ); - expect( - simpleProvider.debugGetCreateSourceHash!(), - isNot(simple2Provider.debugGetCreateSourceHash!()), - ); - expect( - simpleProvider.debugGetCreateSourceHash!(), - isNot(simpleClassProvider.debugGetCreateSourceHash!()), - ); - expect( - simpleProvider.debugGetCreateSourceHash!(), - isNot(simple2Provider.debugGetCreateSourceHash!()), - ); - }); -} +// expect( +// simpleProvider.debugGetCreateSourceHash!(), +// isNot(simple2Provider.debugGetCreateSourceHash!()), +// ); +// expect( +// simpleProvider.debugGetCreateSourceHash!(), +// isNot(simpleClassProvider.debugGetCreateSourceHash!()), +// ); +// expect( +// simpleProvider.debugGetCreateSourceHash!(), +// isNot(simple2Provider.debugGetCreateSourceHash!()), +// ); +// }); +// } diff --git a/packages/riverpod_generator/test/integration/async.dart b/packages/riverpod_generator/test/integration/async.dart index 6319b9168..469608b30 100644 --- a/packages/riverpod_generator/test/integration/async.dart +++ b/packages/riverpod_generator/test/integration/async.dart @@ -1,4 +1,3 @@ -import 'package:riverpod/src/framework.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'async.g.dart'; @@ -57,8 +56,9 @@ class PublicClass extends _$PublicClass { } } -final privateClassProvider = _privateClassProvider; +const privateClassProvider = _privateClassProvider; +// @riverpod class _PrivateClass extends _$PrivateClass { @override diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 6ef477e83..aac84ca43 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -8,22 +8,6 @@ part of 'async.dart'; typedef GenericRef = Ref>>; -final class GenericFamily extends Family { - const GenericFamily._() - : super( - name: r'generic', - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: _$genericHash, - isAutoDispose: true, - ); - - GenericProvider call() => GenericProvider._(from: this); - - @override - String toString() => r'generic'; -} - const genericProvider = GenericFamily._(); final class GenericProvider extends $FunctionalProvider< @@ -48,6 +32,10 @@ final class GenericProvider extends $FunctionalProvider< GenericRef ref, )? _createCb; + @override + $FutureProviderElement> createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + @override FutureOr> create(GenericRef ref) { final fn = _createCb ?? generic; @@ -57,10 +45,6 @@ final class GenericProvider extends $FunctionalProvider< ); } - @override - $FutureProviderElement> createElement(ProviderContainer container) => - $FutureProviderElement(this, container); - @override GenericProvider copyWithCreate( FutureOr> Function( @@ -82,6 +66,23 @@ final class GenericProvider extends $FunctionalProvider< } String _$genericHash() => r'6ee5473ece745b00328c1e048f6967c160343620'; + +final class GenericFamily extends Family { + const GenericFamily._() + : super( + name: r'generic', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$genericHash, + isAutoDispose: true, + ); + + GenericProvider call() => GenericProvider._(from: this); + + @override + String toString() => r'generic'; +} + typedef PublicRef = Ref>; const publicProvider = PublicProvider._(); @@ -108,6 +109,10 @@ final class PublicProvider PublicRef ref, )? _createCb; + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + @override FutureOr create(PublicRef ref) { final fn = _createCb ?? public; @@ -117,10 +122,6 @@ final class PublicProvider ); } - @override - $FutureProviderElement createElement(ProviderContainer container) => - $FutureProviderElement(this, container); - @override PublicProvider copyWithCreate( FutureOr Function( @@ -134,6 +135,7 @@ final class PublicProvider } String _$publicHash() => r'9d99b79c013da13926d4ad89c72ebca4fc1cc257'; + typedef _PrivateRef = Ref>; const _privateProvider = _PrivateProvider._(); @@ -160,6 +162,10 @@ final class _PrivateProvider extends $FunctionalProvider, _PrivateRef ref, )? _createCb; + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + @override FutureOr create(_PrivateRef ref) { final fn = _createCb ?? _private; @@ -169,10 +175,6 @@ final class _PrivateProvider extends $FunctionalProvider, ); } - @override - $FutureProviderElement createElement(ProviderContainer container) => - $FutureProviderElement(this, container); - @override _PrivateProvider copyWithCreate( FutureOr Function( @@ -186,26 +188,8 @@ final class _PrivateProvider extends $FunctionalProvider, } String _$privateHash() => r'bc0469a9315de114a0ccd82c7db4980844d0009f'; -typedef FamilyOrRef = Ref>; - -final class FamilyOrFamily extends Family { - const FamilyOrFamily._() - : super( - name: r'familyOr', - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: _$familyOrHash, - isAutoDispose: true, - ); - - FamilyOrProvider call( - int first, - ) => - FamilyOrProvider._(argument: (first,), from: this); - @override - String toString() => r'familyOr'; -} +typedef FamilyOrRef = Ref>; const familyOrProvider = FamilyOrFamily._(); @@ -233,6 +217,10 @@ final class FamilyOrProvider extends $FunctionalProvider, int first, )? _createCb; + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + @override FutureOr create(FamilyOrRef ref) { final fn = _createCb ?? familyOr; @@ -243,10 +231,6 @@ final class FamilyOrProvider extends $FunctionalProvider, ); } - @override - $FutureProviderElement createElement(ProviderContainer container) => - $FutureProviderElement(this, container); - @override FamilyOrProvider copyWithCreate( FutureOr Function( @@ -271,37 +255,28 @@ final class FamilyOrProvider extends $FunctionalProvider, } String _$familyOrHash() => r'1c3217e296b0ce52c07c18769d1fffb95850f482'; -typedef FamilyRef = Ref>; -final class FamilyFamily extends Family { - const FamilyFamily._() +final class FamilyOrFamily extends Family { + const FamilyOrFamily._() : super( - name: r'family', + name: r'familyOr', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$familyHash, + debugGetCreateSourceHash: _$familyOrHash, isAutoDispose: true, ); - FamilyProvider call( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) => - FamilyProvider._(argument: ( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), from: this); + FamilyOrProvider call( + int first, + ) => + FamilyOrProvider._(argument: (first,), from: this); @override - String toString() => r'family'; + String toString() => r'familyOr'; } +typedef FamilyRef = Ref>; + const familyProvider = FamilyFamily._(); final class FamilyProvider @@ -343,6 +318,10 @@ final class FamilyProvider List? fifth, })? _createCb; + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + @override FutureOr create(FamilyRef ref) { final fn = _createCb ?? family; @@ -369,10 +348,6 @@ final class FamilyProvider ); } - @override - $FutureProviderElement createElement(ProviderContainer container) => - $FutureProviderElement(this, container); - @override FamilyProvider copyWithCreate( FutureOr Function( @@ -407,14 +382,308 @@ final class FamilyProvider } String _$familyHash() => r'eb6fad35a94d4238b621c2100253ee2c700bee77'; + +final class FamilyFamily extends Family { + const FamilyFamily._() + : super( + name: r'family', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$familyHash, + isAutoDispose: true, + ); + + FamilyProvider call( + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) => + FamilyProvider._(argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), from: this); + + @override + String toString() => r'family'; +} + const genericClassProvider = GenericClassFamily._(); + +final class GenericClassProvider + extends $AsyncNotifierProvider, List> { + const GenericClassProvider._({ + FutureOr> Function()? create, + required GenericClassFamily super.from, + }) : _createCb = create, + super( + debugGetCreateSourceHash: _$genericClassHash, + name: r'GenericClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + argument: null, + ); + + final FutureOr> Function()? _createCb; + + @override + $AsyncNotifierProviderElement, List> createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is GenericClassProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } +} + String _$genericClassHash() => r'd3c4acc9cdae12f6c666fbf1f89aee212bb086db'; + +final class GenericClassFamily extends Family { + const GenericClassFamily._() + : super( + name: r'GenericClass', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$genericClassHash, + isAutoDispose: true, + ); + + GenericClassProvider call() => + GenericClassProvider._(from: this); + + @override + String toString() => r'GenericClass'; +} + +abstract class _$GenericClass extends $AsyncNotifier> { + FutureOr> build(); + + @$internal + @override + void runBuild() {} +} + +const publicClassProvider = PublicClassProvider._(); + +final class PublicClassProvider + extends $AsyncNotifierProvider { + const PublicClassProvider._({ + FutureOr Function()? create, + }) : _createCb = create, + super( + debugGetCreateSourceHash: _$publicClassHash, + name: r'PublicClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + from: null, + argument: null, + ); + + final FutureOr Function()? _createCb; + + @override + $AsyncNotifierProviderElement createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + String _$publicClassHash() => r'e9bc69e44b72e8ed77d423524c0d74ad460d629d'; + +abstract class _$PublicClass extends $AsyncNotifier { + FutureOr build(); + + @$internal + @override + void runBuild() {} +} + +const _privateClassProvider = _PrivateClassProvider._(); + +final class _PrivateClassProvider + extends $AsyncNotifierProvider<_PrivateClass, String> { + const _PrivateClassProvider._({ + FutureOr Function()? create, + }) : _createCb = create, + super( + debugGetCreateSourceHash: _$privateClassHash, + name: r'_PrivateClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + from: null, + argument: null, + ); + + final FutureOr Function()? _createCb; + + @override + $AsyncNotifierProviderElement<_PrivateClass, String> createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + String _$privateClassHash() => r'7e69cffe8315999710e4cb6bb3de9f179d3f2f5d'; + +abstract class _$PrivateClass extends $AsyncNotifier { + FutureOr build(); + + @$internal + @override + void runBuild() {} +} + const familyOrClassProvider = FamilyOrClassFamily._(); + +final class FamilyOrClassProvider + extends $AsyncNotifierProvider { + const FamilyOrClassProvider._({ + FutureOr Function()? create, + required FamilyOrClassFamily super.from, + required (int,) super.argument, + }) : _createCb = create, + super( + debugGetCreateSourceHash: _$familyOrClassHash, + name: r'FamilyOrClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function()? _createCb; + + @override + $AsyncNotifierProviderElement createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is FamilyOrClassProvider && other.argument == argument; + } +} + String _$familyOrClassHash() => r'b4882d4e79a03c63005d35eb7a021c9c4373a8d9'; + +final class FamilyOrClassFamily extends Family { + const FamilyOrClassFamily._() + : super( + name: r'FamilyOrClass', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$familyOrClassHash, + isAutoDispose: true, + ); + + FamilyOrClassProvider call( + int first, + ) => + FamilyOrClassProvider._(argument: (first,), from: this); + + @override + String toString() => r'FamilyOrClass'; +} + +abstract class _$FamilyOrClass extends $AsyncNotifier { + FutureOr build( + int first, + ); + + @$internal + @override + void runBuild() {} +} + const familyClassProvider = FamilyClassFamily._(); + +final class FamilyClassProvider + extends $AsyncNotifierProvider { + const FamilyClassProvider._({ + FutureOr Function()? create, + required FamilyClassFamily super.from, + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, + }) : _createCb = create, + super( + debugGetCreateSourceHash: _$familyClassHash, + name: r'FamilyClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function()? _createCb; + + @override + $AsyncNotifierProviderElement createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is FamilyClassProvider && other.argument == argument; + } +} + String _$familyClassHash() => r'b7e3ca6091f12bbc99972e961acd885e05f42a15'; + +final class FamilyClassFamily extends Family { + const FamilyClassFamily._() + : super( + name: r'FamilyClass', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$familyClassHash, + isAutoDispose: true, + ); + + FamilyClassProvider call( + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) => + FamilyClassProvider._(argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), from: this); + + @override + String toString() => r'FamilyClass'; +} + +abstract class _$FamilyClass extends $AsyncNotifier { + FutureOr build( + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }); + + @$internal + @override + void runBuild() {} +} + const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/auto_dispose.dart b/packages/riverpod_generator/test/integration/auto_dispose.dart index f8e0aeb6d..b384e20cf 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.dart @@ -1,6 +1,6 @@ // import 'package:riverpod_annotation/riverpod_annotation.dart'; -// // part 'auto_dispose.g.dart'; +// part 'auto_dispose.g.dart'; // @Riverpod(keepAlive: true) // int keepAlive(KeepAliveRef ref) { diff --git a/packages/riverpod_generator/test/integration/hash/hash1.dart b/packages/riverpod_generator/test/integration/hash/hash1.dart index a299a420e..abfeb7e6b 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.dart @@ -1,19 +1,19 @@ -import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:riverpod_annotation/riverpod_annotation.dart'; -part 'hash1.g.dart'; +// part 'hash1.g.dart'; -@riverpod -String simple(SimpleRef ref) { - return 'Hello world'; -} +// @riverpod +// String simple(SimpleRef ref) { +// return 'Hello world'; +// } -@riverpod -String simple2(Simple2Ref ref) { - return 'Hello world2'; -} +// @riverpod +// String simple2(Simple2Ref ref) { +// // return 'Hello world2'; +// } -@riverpod -class SimpleClass extends _$SimpleClass { - @override - String build() => 'Hello world'; -} +// @riverpod +// class SimpleClass extends _$SimpleClass { +// @override +// String build() => 'Hello world'; +// } diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart deleted file mode 100644 index 11b809c10..000000000 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ /dev/null @@ -1,114 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'hash1.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -typedef SimpleRef = Ref; - -const simpleProvider = SimpleProvider._(); - -final class SimpleProvider - extends $FunctionalProvider { - const SimpleProvider._({ - String Function( - SimpleRef ref, - )? create, - }) : _createCb = create, - super( - debugGetCreateSourceHash: _$simpleHash, - name: r'simple', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - from: null, - argument: null, - ); - - final String Function( - SimpleRef ref, - )? _createCb; - - @override - String create(SimpleRef ref) { - final fn = _createCb ?? simple; - - return fn( - ref, - ); - } - - @override - $ProviderElement createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - SimpleProvider copyWithCreate( - String Function( - SimpleRef ref, - ) create, - ) { - return SimpleProvider._( - create: create, - ); - } -} - -String _$simpleHash() => r'ff9f7451526aef5b3af6646814631a502ad76a5f'; -typedef Simple2Ref = Ref; - -const simple2Provider = Simple2Provider._(); - -final class Simple2Provider - extends $FunctionalProvider { - const Simple2Provider._({ - String Function( - Simple2Ref ref, - )? create, - }) : _createCb = create, - super( - debugGetCreateSourceHash: _$simple2Hash, - name: r'simple2', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - from: null, - argument: null, - ); - - final String Function( - Simple2Ref ref, - )? _createCb; - - @override - String create(Simple2Ref ref) { - final fn = _createCb ?? simple2; - - return fn( - ref, - ); - } - - @override - $ProviderElement createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - Simple2Provider copyWithCreate( - String Function( - Simple2Ref ref, - ) create, - ) { - return Simple2Provider._( - create: create, - ); - } -} - -String _$simple2Hash() => r'06327442776394c5c9cbb33b048d7a42e709e7fd'; -String _$simpleClassHash() => r'958123cd6179c5b88da040cfeb71eb3061765277'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); -// ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/notifier_test.dart b/packages/riverpod_generator/test/notifier_test.dart index a455f51ac..e1180c259 100644 --- a/packages/riverpod_generator/test/notifier_test.dart +++ b/packages/riverpod_generator/test/notifier_test.dart @@ -1,134 +1,134 @@ -// ignore_for_file: omit_local_variable_types, unused_local_variable - -import 'package:riverpod_annotation/riverpod_annotation.dart'; -import 'package:test/test.dart'; - -import 'integration/sync.dart'; -import 'utils.dart'; - -void main() { - test('Creates a Provider if @riverpod is used on a synchronous function', - () { - final container = createContainer(); - - final AutoDisposeNotifierProvider provider = - publicClassProvider; - final String result = container.read(publicProvider); - - expect(result, 'Hello world'); - }); - - test('Generates .name for providers', () { - expect(publicClassProvider.name, 'publicClassProvider'); - expect(privateClassProvider.name, '_privateClassProvider'); - - expect(familyClassProvider.name, 'familyClassProvider'); - expect(familyClassProvider(42, third: .42).name, 'familyClassProvider'); - }); - - test('Supports overriding non-family notifiers', () { - final container = createContainer( - overrides: [ - publicClassProvider.overrideWith(() => PublicClass('Hello world')), - ], - ); - - final notifier = container.read(publicClassProvider.notifier); - expect(notifier.param, 'Hello world'); - - expect(notifier.ref, isNotNull); - expect(notifier.state, isNotNull); - }); - - test('Supports overriding family notifiers', () { - final container = createContainer( - overrides: [ - familyClassProvider(42, third: .42) - .overrideWith(() => FamilyClass('Hello world')), - ], - ); - - final notifier = - container.read(familyClassProvider(42, third: .42).notifier); - expect(notifier.param, 'Hello world'); - expect(notifier.first, 42); - expect(notifier.second, null); - expect(notifier.third, .42); - expect(notifier.fourth, true); - expect(notifier.fifth, null); - - expect(notifier.ref, isNotNull); - expect(notifier.state, isNotNull); - }); - - test( - 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', - () { - final container = createContainer(); - - const FamilyClassFamily family = familyClassProvider; - - expect(familyClassProvider(42, third: .42).from, familyClassProvider); - - expect( - familyClassProvider(42, third: .42), - familyClassProvider(42, third: .42), - ); - expect( - familyClassProvider(42, third: .42), - isNot(familyClassProvider(42, third: .21)), - ); - expect( - familyClassProvider(42, third: .42).hashCode, - isNot(familyClassProvider(42, third: .21).hashCode), - ); - - // handle defaults - expect( - familyClassProvider(42, third: .42), - familyClassProvider( - 42, - third: .42, - ), - ); - expect( - familyClassProvider(42, third: .42).hashCode, - familyClassProvider( - 42, - third: .42, - ).hashCode, - ); - - final FamilyClassProvider provider = familyClassProvider( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: ['x42'], - ); - // ignore: invalid_use_of_internal_member - final AutoDisposeNotifierProviderImpl futureProvider = - provider; - - expect(provider.first, 42); - expect(provider.second, 'x42'); - expect(provider.third, .42); - expect(provider.fourth, false); - expect(provider.fifth, ['x42']); - - final String result = container.read( - familyClassProvider( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: ['x42'], - ), - ); - - expect( - result, - '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', - ); - }); -} +// // ignore_for_file: omit_local_variable_types, unused_local_variable + +// import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:test/test.dart'; + +// import 'integration/sync.dart'; +// import 'utils.dart'; + +// void main() { +// test('Creates a Provider if @riverpod is used on a synchronous function', +// () { +// final container = createContainer(); + +// final AutoDisposeNotifierProvider provider = +// publicClassProvider; +// final String result = container.read(publicProvider); + +// expect(result, 'Hello world'); +// }); + +// test('Generates .name for providers', () { +// expect(publicClassProvider.name, 'publicClassProvider'); +// expect(privateClassProvider.name, '_privateClassProvider'); + +// expect(familyClassProvider.name, 'familyClassProvider'); +// expect(familyClassProvider(42, third: .42).name, 'familyClassProvider'); +// }); + +// test('Supports overriding non-family notifiers', () { +// final container = createContainer( +// overrides: [ +// publicClassProvider.overrideWith(() => PublicClass('Hello world')), +// ], +// ); + +// final notifier = container.read(publicClassProvider.notifier); +// expect(notifier.param, 'Hello world'); + +// expect(notifier.ref, isNotNull); +// expect(notifier.state, isNotNull); +// }); + +// test('Supports overriding family notifiers', () { +// final container = createContainer( +// overrides: [ +// familyClassProvider(42, third: .42) +// .overrideWith(() => FamilyClass('Hello world')), +// ], +// ); + +// final notifier = +// container.read(familyClassProvider(42, third: .42).notifier); +// expect(notifier.param, 'Hello world'); +// expect(notifier.first, 42); +// expect(notifier.second, null); +// expect(notifier.third, .42); +// expect(notifier.fourth, true); +// expect(notifier.fifth, null); + +// expect(notifier.ref, isNotNull); +// expect(notifier.state, isNotNull); +// }); + +// test( +// 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', +// () { +// final container = createContainer(); + +// const FamilyClassFamily family = familyClassProvider; + +// expect(familyClassProvider(42, third: .42).from, familyClassProvider); + +// expect( +// familyClassProvider(42, third: .42), +// familyClassProvider(42, third: .42), +// ); +// expect( +// familyClassProvider(42, third: .42), +// isNot(familyClassProvider(42, third: .21)), +// ); +// expect( +// familyClassProvider(42, third: .42).hashCode, +// isNot(familyClassProvider(42, third: .21).hashCode), +// ); + +// // handle defaults +// expect( +// familyClassProvider(42, third: .42), +// familyClassProvider( +// 42, +// third: .42, +// ), +// ); +// expect( +// familyClassProvider(42, third: .42).hashCode, +// familyClassProvider( +// 42, +// third: .42, +// ).hashCode, +// ); + +// final FamilyClassProvider provider = familyClassProvider( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: ['x42'], +// ); +// // ignore: invalid_use_of_internal_member +// final AutoDisposeNotifierProviderImpl futureProvider = +// provider; + +// expect(provider.first, 42); +// expect(provider.second, 'x42'); +// expect(provider.third, .42); +// expect(provider.fourth, false); +// expect(provider.fifth, ['x42']); + +// final String result = container.read( +// familyClassProvider( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: ['x42'], +// ), +// ); + +// expect( +// result, +// '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', +// ); +// }); +// } diff --git a/packages/riverpod_generator/test/scoped_test.dart b/packages/riverpod_generator/test/scoped_test.dart index 4e64663d6..41a679b3f 100644 --- a/packages/riverpod_generator/test/scoped_test.dart +++ b/packages/riverpod_generator/test/scoped_test.dart @@ -1,25 +1,25 @@ -import 'package:test/test.dart'; +// import 'package:test/test.dart'; -import 'integration/scopes.dart'; -import 'utils.dart'; +// import 'integration/scopes.dart'; +// import 'utils.dart'; -void main() { - test('throws UnsupportedError if accessed without an override', () { - final container = createContainer(); +// void main() { +// test('throws UnsupportedError if accessed without an override', () { +// final container = createContainer(); - expect( - () => container.read(scopedProvider), - throwsUnsupportedError, - ); - }); +// expect( +// () => container.read(scopedProvider), +// throwsUnsupportedError, +// ); +// }); - test('Can be accessed without problem if the provider is overridden', () { - final container = createContainer( - overrides: [ - scopedProvider.overrideWith((ref) => 42), - ], - ); +// test('Can be accessed without problem if the provider is overridden', () { +// final container = createContainer( +// overrides: [ +// scopedProvider.overrideWith((ref) => 42), +// ], +// ); - expect(container.read(scopedProvider), 42); - }); -} +// expect(container.read(scopedProvider), 42); +// }); +// } diff --git a/packages/riverpod_generator/test/stream_notifier_test.dart b/packages/riverpod_generator/test/stream_notifier_test.dart index 5de59ca8c..a4422815d 100644 --- a/packages/riverpod_generator/test/stream_notifier_test.dart +++ b/packages/riverpod_generator/test/stream_notifier_test.dart @@ -1,138 +1,138 @@ -// ignore_for_file: omit_local_variable_types, unused_local_variable - -import 'package:riverpod_annotation/riverpod_annotation.dart'; -import 'package:test/test.dart'; - -import 'integration/stream.dart'; -import 'utils.dart'; - -void main() { - test( - 'Creates a StreamNotifierProvider if @riverpod is used on a Stream class', - () async { - final container = createContainer(); - - final AutoDisposeStreamNotifierProvider provider = - publicClassProvider; - - expect( - await container.listen(publicClassProvider.future, (_, __) {}).read(), - 'Hello world', - ); - }); - - test('Generates .name for providers', () { - expect(publicClassProvider.name, 'publicClassProvider'); - expect(privateClassProvider.name, '_privateClassProvider'); - - expect(familyClassProvider.name, 'familyClassProvider'); - expect(familyClassProvider(42, third: .42).name, 'familyClassProvider'); - }); - - test('Supports overriding non-family notifiers', () { - final container = createContainer( - overrides: [ - publicClassProvider.overrideWith(() => PublicClass('Hello world')), - ], - ); - - final notifier = container.read(publicClassProvider.notifier); - expect(notifier.param, 'Hello world'); - - expect(notifier.ref, isNotNull); - expect(notifier.state, isNotNull); - }); - - test('Supports overriding family notifiers', () { - final container = createContainer( - overrides: [ - familyClassProvider(42, third: .42) - .overrideWith(() => FamilyClass('Hello world')), - ], - ); - - final notifier = - container.read(familyClassProvider(42, third: .42).notifier); - expect(notifier.param, 'Hello world'); - expect(notifier.first, 42); - expect(notifier.second, null); - expect(notifier.third, .42); - expect(notifier.fourth, true); - expect(notifier.fifth, null); - - expect(notifier.ref, isNotNull); - expect(notifier.state, isNotNull); - }); - - test( - 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', - () async { - final container = createContainer(); - - const FamilyClassFamily family = familyClassProvider; - - expect(familyClassProvider(42, third: .42).from, familyClassProvider); - - expect( - familyClassProvider(42, third: .42), - familyClassProvider(42, third: .42), - ); - expect( - familyClassProvider(42, third: .42), - isNot(familyClassProvider(42, third: .21)), - ); - expect( - familyClassProvider(42, third: .42).hashCode, - isNot(familyClassProvider(42, third: .21).hashCode), - ); - - // handle defaults - expect( - familyClassProvider(42, third: .42), - familyClassProvider( - 42, - third: .42, - ), - ); - expect( - familyClassProvider(42, third: .42).hashCode, - familyClassProvider( - 42, - third: .42, - ).hashCode, - ); - - final FamilyClassProvider provider = familyClassProvider( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: ['x42'], - ); - // ignore: invalid_use_of_internal_member - final AutoDisposeStreamNotifierProviderImpl - futureProvider = provider; - - expect(provider.first, 42); - expect(provider.second, 'x42'); - expect(provider.third, .42); - expect(provider.fourth, false); - expect(provider.fifth, ['x42']); - - expect( - await container - .listen( - familyClassProvider( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: ['x42'], - ).future, - (_, __) {}, - ) - .read(), - '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', - ); - }); -} +// // ignore_for_file: omit_local_variable_types, unused_local_variable + +// import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:test/test.dart'; + +// import 'integration/stream.dart'; +// import 'utils.dart'; + +// void main() { +// test( +// 'Creates a StreamNotifierProvider if @riverpod is used on a Stream class', +// () async { +// final container = createContainer(); + +// final AutoDisposeStreamNotifierProvider provider = +// publicClassProvider; + +// expect( +// await container.listen(publicClassProvider.future, (_, __) {}).read(), +// 'Hello world', +// ); +// }); + +// test('Generates .name for providers', () { +// expect(publicClassProvider.name, 'publicClassProvider'); +// expect(privateClassProvider.name, '_privateClassProvider'); + +// expect(familyClassProvider.name, 'familyClassProvider'); +// expect(familyClassProvider(42, third: .42).name, 'familyClassProvider'); +// }); + +// test('Supports overriding non-family notifiers', () { +// final container = createContainer( +// overrides: [ +// publicClassProvider.overrideWith(() => PublicClass('Hello world')), +// ], +// ); + +// final notifier = container.read(publicClassProvider.notifier); +// expect(notifier.param, 'Hello world'); + +// expect(notifier.ref, isNotNull); +// expect(notifier.state, isNotNull); +// }); + +// test('Supports overriding family notifiers', () { +// final container = createContainer( +// overrides: [ +// familyClassProvider(42, third: .42) +// .overrideWith(() => FamilyClass('Hello world')), +// ], +// ); + +// final notifier = +// container.read(familyClassProvider(42, third: .42).notifier); +// expect(notifier.param, 'Hello world'); +// expect(notifier.first, 42); +// expect(notifier.second, null); +// expect(notifier.third, .42); +// expect(notifier.fourth, true); +// expect(notifier.fifth, null); + +// expect(notifier.ref, isNotNull); +// expect(notifier.state, isNotNull); +// }); + +// test( +// 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', +// () async { +// final container = createContainer(); + +// const FamilyClassFamily family = familyClassProvider; + +// expect(familyClassProvider(42, third: .42).from, familyClassProvider); + +// expect( +// familyClassProvider(42, third: .42), +// familyClassProvider(42, third: .42), +// ); +// expect( +// familyClassProvider(42, third: .42), +// isNot(familyClassProvider(42, third: .21)), +// ); +// expect( +// familyClassProvider(42, third: .42).hashCode, +// isNot(familyClassProvider(42, third: .21).hashCode), +// ); + +// // handle defaults +// expect( +// familyClassProvider(42, third: .42), +// familyClassProvider( +// 42, +// third: .42, +// ), +// ); +// expect( +// familyClassProvider(42, third: .42).hashCode, +// familyClassProvider( +// 42, +// third: .42, +// ).hashCode, +// ); + +// final FamilyClassProvider provider = familyClassProvider( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: ['x42'], +// ); +// // ignore: invalid_use_of_internal_member +// final AutoDisposeStreamNotifierProviderImpl +// futureProvider = provider; + +// expect(provider.first, 42); +// expect(provider.second, 'x42'); +// expect(provider.third, .42); +// expect(provider.fourth, false); +// expect(provider.fifth, ['x42']); + +// expect( +// await container +// .listen( +// familyClassProvider( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: ['x42'], +// ).future, +// (_, __) {}, +// ) +// .read(), +// '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', +// ); +// }); +// } diff --git a/packages/riverpod_generator/test/stream_test.dart b/packages/riverpod_generator/test/stream_test.dart index fc23c0e5c..4f128ff3f 100644 --- a/packages/riverpod_generator/test/stream_test.dart +++ b/packages/riverpod_generator/test/stream_test.dart @@ -1,160 +1,160 @@ -// ignore_for_file: omit_local_variable_types, unused_local_variable - -import 'package:riverpod_annotation/riverpod_annotation.dart'; -import 'package:test/test.dart'; - -import 'integration/stream.dart'; -import 'utils.dart'; - -void main() { - test('Creates a StreamProvider if @riverpod is used on a Stream function', - () async { - final container = createContainer(); - - final AutoDisposeStreamProvider provider = publicProvider; - - expect( - await container.listen(publicProvider.future, (_, __) {}).read(), - 'Hello world', - ); - }); - - test('Generates .name for providers', () { - expect(publicProvider.name, 'publicProvider'); - expect(privateProvider.name, '_privateProvider'); - - expect(familyProvider.name, 'familyProvider'); - expect(familyProvider(42, third: .42).name, 'familyProvider'); - }); - - test('Supports overriding non-family providers', () async { - final container = createContainer( - overrides: [ - publicProvider.overrideWith((ref) => Stream.value('Hello world')), - ], - ); - - final result = container.read(publicProvider.future); - expect(await result, 'Hello world'); - }); - - test('Supports overriding family providers', () async { - final container = createContainer( - overrides: [ - familyProvider(42, third: .42).overrideWith( - (ref) => Stream.value( - 'Hello world ${ref.first} ${ref.second} ' - '${ref.third} ${ref.fourth} ${ref.fifth}', - ), - ), - ], - ); - - final result = container.read(familyProvider(42, third: .42).future); - expect(await result, 'Hello world 42 null 0.42 true null'); - }); - - test( - 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', - () async { - final container = createContainer(); - - const FamilyFamily family = familyProvider; - - expect(familyProvider(42, third: .42).from, familyProvider); - - expect( - familyProvider(42, third: .42), - familyProvider(42, third: .42), - ); - expect( - familyProvider(42, third: .42), - isNot(familyProvider(42, third: .21)), - ); - expect( - familyProvider(42, third: .42).hashCode, - isNot(familyProvider(42, third: .21).hashCode), - ); - - // handle defaults - expect( - familyProvider(42, third: .42), - familyProvider( - 42, - third: .42, - ), - ); - expect( - familyProvider(42, third: .42).hashCode, - familyProvider( - 42, - third: .42, - ).hashCode, - ); - - final FamilyProvider provider = familyProvider( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: ['x42'], - ); - final AutoDisposeStreamProvider futureProvider = provider; - - expect(provider.first, 42); - expect(provider.second, 'x42'); - expect(provider.third, .42); - expect(provider.fourth, false); - expect(provider.fifth, ['x42']); - - expect( - await container - .listen( - familyProvider( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: ['x42'], - ).future, - (_, __) {}, - ) - .read(), - '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', - ); - }); - - test('can override providers', () { - final container = createContainer( - overrides: [ - publicProvider.overrideWith((ref) { - ref.state = const AsyncData('test'); - return const Stream.empty(); - }), - publicClassProvider.overrideWith(() => PublicClass(42)), - familyProvider.overrideWith( - (ref) { - ref.state = AsyncData( - 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})', - ); - return const Stream.empty(); - }, - ), - familyClassProvider.overrideWith(() => FamilyClass(42)), - ], - ); - - expect(container.read(publicProvider).requireValue, 'test'); - expect(container.read(publicClassProvider.notifier).param, 42); - expect( - container.read(familyProvider(42, second: '42', third: .42)).requireValue, - 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', - ); - expect( - container - .read(familyClassProvider(42, second: '42', third: .42).notifier) - .param, - 42, - ); - }); -} +// // ignore_for_file: omit_local_variable_types, unused_local_variable + +// import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:test/test.dart'; + +// import 'integration/stream.dart'; +// import 'utils.dart'; + +// void main() { +// test('Creates a StreamProvider if @riverpod is used on a Stream function', +// () async { +// final container = createContainer(); + +// final AutoDisposeStreamProvider provider = publicProvider; + +// expect( +// await container.listen(publicProvider.future, (_, __) {}).read(), +// 'Hello world', +// ); +// }); + +// test('Generates .name for providers', () { +// expect(publicProvider.name, 'publicProvider'); +// expect(privateProvider.name, '_privateProvider'); + +// expect(familyProvider.name, 'familyProvider'); +// expect(familyProvider(42, third: .42).name, 'familyProvider'); +// }); + +// test('Supports overriding non-family providers', () async { +// final container = createContainer( +// overrides: [ +// publicProvider.overrideWith((ref) => Stream.value('Hello world')), +// ], +// ); + +// final result = container.read(publicProvider.future); +// expect(await result, 'Hello world'); +// }); + +// test('Supports overriding family providers', () async { +// final container = createContainer( +// overrides: [ +// familyProvider(42, third: .42).overrideWith( +// (ref) => Stream.value( +// 'Hello world ${ref.first} ${ref.second} ' +// '${ref.third} ${ref.fourth} ${ref.fifth}', +// ), +// ), +// ], +// ); + +// final result = container.read(familyProvider(42, third: .42).future); +// expect(await result, 'Hello world 42 null 0.42 true null'); +// }); + +// test( +// 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', +// () async { +// final container = createContainer(); + +// const FamilyFamily family = familyProvider; + +// expect(familyProvider(42, third: .42).from, familyProvider); + +// expect( +// familyProvider(42, third: .42), +// familyProvider(42, third: .42), +// ); +// expect( +// familyProvider(42, third: .42), +// isNot(familyProvider(42, third: .21)), +// ); +// expect( +// familyProvider(42, third: .42).hashCode, +// isNot(familyProvider(42, third: .21).hashCode), +// ); + +// // handle defaults +// expect( +// familyProvider(42, third: .42), +// familyProvider( +// 42, +// third: .42, +// ), +// ); +// expect( +// familyProvider(42, third: .42).hashCode, +// familyProvider( +// 42, +// third: .42, +// ).hashCode, +// ); + +// final FamilyProvider provider = familyProvider( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: ['x42'], +// ); +// final AutoDisposeStreamProvider futureProvider = provider; + +// expect(provider.first, 42); +// expect(provider.second, 'x42'); +// expect(provider.third, .42); +// expect(provider.fourth, false); +// expect(provider.fifth, ['x42']); + +// expect( +// await container +// .listen( +// familyProvider( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: ['x42'], +// ).future, +// (_, __) {}, +// ) +// .read(), +// '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', +// ); +// }); + +// test('can override providers', () { +// final container = createContainer( +// overrides: [ +// publicProvider.overrideWith((ref) { +// ref.state = const AsyncData('test'); +// return const Stream.empty(); +// }), +// publicClassProvider.overrideWith(() => PublicClass(42)), +// familyProvider.overrideWith( +// (ref) { +// ref.state = AsyncData( +// 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})', +// ); +// return const Stream.empty(); +// }, +// ), +// familyClassProvider.overrideWith(() => FamilyClass(42)), +// ], +// ); + +// expect(container.read(publicProvider).requireValue, 'test'); +// expect(container.read(publicClassProvider.notifier).param, 42); +// expect( +// container.read(familyProvider(42, second: '42', third: .42)).requireValue, +// 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', +// ); +// expect( +// container +// .read(familyClassProvider(42, second: '42', third: .42).notifier) +// .param, +// 42, +// ); +// }); +// } diff --git a/packages/riverpod_generator/test/sync_test.dart b/packages/riverpod_generator/test/sync_test.dart index 232f49a5f..395ce6e4d 100644 --- a/packages/riverpod_generator/test/sync_test.dart +++ b/packages/riverpod_generator/test/sync_test.dart @@ -1,323 +1,323 @@ -// ignore_for_file: omit_local_variable_types, unused_local_variable, require_trailing_commas - -import 'package:riverpod_annotation/riverpod_annotation.dart'; -import 'package:test/test.dart'; - -import 'integration/sync.dart'; -import 'utils.dart'; - -void main() { - // TODO test that the generated providers contain the docs from the annotated element - - group('Supports generics', () { - test('checks generics in hashCode', () { - expect( - genericProvider().hashCode, - genericProvider().hashCode, - ); - expect( - genericProvider().hashCode, - isNot(genericProvider().hashCode), - ); - expect( - genericProvider().hashCode, - isNot(genericProvider().hashCode), - ); - expect( - genericProvider().hashCode, - isNot(genericProvider().hashCode), - ); - expect( - genericProvider().hashCode, - genericProvider().hashCode, - ); - }); - - test('checks generics in ==', () { - expect( - genericProvider(), - genericProvider(), - ); - expect( - genericProvider(), - isNot(genericProvider()), - ); - expect( - genericProvider(), - isNot(genericProvider()), - ); - expect( - genericProvider(), - isNot(genericProvider()), - ); - expect( - genericProvider(), - genericProvider(), - ); - }); - - test('in simple scenarios', () { - final container = createContainer(); - - expect( - container.listen(genericProvider(), (p, n) {}).read(), - [42], - ); - expect( - container.listen(genericProvider(), (p, n) {}).read(), - [3.14], - ); - expect( - container.listen(genericProvider(), (p, n) {}).read(), - [42, 3.14], - ); - }); - }); - - test('Supports Raw', () async { - final container = createContainer(); - - expect( - container.read(rawFutureProvider), - isA>(), - ); - expect( - container.read(rawFutureClassProvider), - isA>(), - ); - expect( - container.read(rawFutureClassProvider.notifier), - isA(), - ); - - expect( - container.read(rawStreamProvider), - isA>(), - ); - expect( - container.read(rawStreamClassProvider), - isA>(), - ); - expect( - container.read(rawStreamClassProvider.notifier), - isA(), - ); - - expect( - container.read(rawFamilyFutureProvider(0)), - isA>(), - ); - expect( - container.read(rawFamilyFutureClassProvider(0)), - isA>(), - ); - expect( - container.read(rawFamilyFutureClassProvider(0).notifier), - isA(), - ); - - expect( - container.read(rawFamilyStreamProvider(0)), - isA>(), - ); - expect( - container.read(rawFamilyStreamClassProvider(0)), - isA>(), - ); - expect( - container.read(rawFamilyStreamClassProvider(0).notifier), - isA(), - ); - }); - - test('overrides toString', () { - expect(publicProvider.toString(), 'publicProvider'); - expect(familyProvider.toString(), 'familyProvider'); - expect( - familyProvider.call(42, second: 'foo', third: .3).toString(), - 'familyProvider(42, fifth: null, fourth: true, second: foo, third: 0.3)', - ); - - expect( - publicProvider.overrideWithValue('foo').toString(), - 'publicProvider.overrideWithValue(foo)', - ); - expect( - familyProvider.overrideWith((ref) => 'foo').toString(), - 'familyProvider.overrideWith(...)', - ); - expect( - familyProvider(42, second: 'foo', third: .3) - .overrideWith((ref) => '') - .toString(), - 'familyProvider(42, fifth: null, fourth: true, second: foo, third: 0.3).overrideWith(...)', - ); - }); - - test('Supports overriding non-family providers', () { - final container = createContainer( - overrides: [ - publicProvider.overrideWith((ref) => 'Hello world'), - ], - ); - - final result = container.read(publicProvider); - expect(result, 'Hello world'); - }); - - test('Supports overriding family providers', () { - final container = createContainer( - overrides: [ - familyProvider(42, third: .42).overrideWith( - (ref) => 'Hello world ${ref.first} ${ref.second} ' - '${ref.third} ${ref.fourth} ${ref.fifth}', - ), - ], - ); - - final result = container.read(familyProvider(42, third: .42)); - expect(result, 'Hello world 42 null 0.42 true null'); - }); - - test( - 'Creates a Provider if @riverpod is used on an stream function wrapped in Raw', - () async { - final container = createContainer(); - - final AutoDisposeProvider> provider = rawStreamProvider; - final Stream result = container.read(rawStreamProvider); - - await expectLater(result, emits('Hello world')); - }); - - test('Creates a Provider if @riverpod is used on a synchronous function', - () { - final container = createContainer(); - - final AutoDisposeProvider provider = publicProvider; - final String result = container.read(publicProvider); - - expect(result, 'Hello world'); - }); - - test('Generates .name for providers', () { - expect(publicProvider.name, 'publicProvider'); - expect(privateProvider.name, '_privateProvider'); - - expect(familyProvider.name, 'familyProvider'); - expect(familyProvider(42, third: .42).name, 'familyProvider'); - }); - - test( - 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', - () { - final container = createContainer(); - - const FamilyFamily family = familyProvider; - - expect(familyProvider(42, third: .42).from, familyProvider); - - expect( - familyProvider(42, third: .42), - familyProvider(42, third: .42), - ); - expect( - familyProvider(42, third: .42), - isNot(familyProvider(42, third: .21)), - ); - expect( - familyProvider(42, third: .42).hashCode, - isNot(familyProvider(42, third: .21).hashCode), - ); - - // handle defaults - expect( - familyProvider(42, third: .42), - familyProvider( - 42, - third: .42, - ), - ); - expect( - familyProvider(42, third: .42).hashCode, - familyProvider( - 42, - third: .42, - ).hashCode, - ); - - final FamilyProvider provider = familyProvider( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: const ['x42'], - ); - final AutoDisposeProvider futureProvider = provider; - - expect(provider.first, 42); - expect(provider.second, 'x42'); - expect(provider.third, .42); - expect(provider.fourth, false); - expect(provider.fifth, ['x42']); - - final ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) argument = provider.argument; - - expect( - argument, - ( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: const ['x42'], - ), - ); - - final String result = container.read( - familyProvider( - 42, - second: 'x42', - third: .42, - fourth: false, - fifth: ['x42'], - ), - ); - - expect( - result, - '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', - ); - }); - - test('can override providers', () { - final container = createContainer(overrides: [ - publicProvider.overrideWith((ref) => 'test'), - publicClassProvider.overrideWith(() => PublicClass(42)), - familyProvider.overrideWith( - (ref) => - 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})', - ), - familyClassProvider.overrideWith(() => FamilyClass(42)), - ]); - - expect(container.read(publicProvider), 'test'); - expect(container.read(publicClassProvider.notifier).param, 42); - expect( - container.read(familyProvider(42, second: '42', third: .42)), - 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', - ); - expect( - container - .read(familyClassProvider(42, second: '42', third: .42).notifier) - .param, - 42, - ); - }); -} +// // ignore_for_file: omit_local_variable_types, unused_local_variable, require_trailing_commas + +// import 'package:riverpod_annotation/riverpod_annotation.dart'; +// import 'package:test/test.dart'; + +// import 'integration/sync.dart'; +// import 'utils.dart'; + +// void main() { +// // TODO test that the generated providers contain the docs from the annotated element + +// group('Supports generics', () { +// test('checks generics in hashCode', () { +// expect( +// genericProvider().hashCode, +// genericProvider().hashCode, +// ); +// expect( +// genericProvider().hashCode, +// isNot(genericProvider().hashCode), +// ); +// expect( +// genericProvider().hashCode, +// isNot(genericProvider().hashCode), +// ); +// expect( +// genericProvider().hashCode, +// isNot(genericProvider().hashCode), +// ); +// expect( +// genericProvider().hashCode, +// genericProvider().hashCode, +// ); +// }); + +// test('checks generics in ==', () { +// expect( +// genericProvider(), +// genericProvider(), +// ); +// expect( +// genericProvider(), +// isNot(genericProvider()), +// ); +// expect( +// genericProvider(), +// isNot(genericProvider()), +// ); +// expect( +// genericProvider(), +// isNot(genericProvider()), +// ); +// expect( +// genericProvider(), +// genericProvider(), +// ); +// }); + +// test('in simple scenarios', () { +// final container = createContainer(); + +// expect( +// container.listen(genericProvider(), (p, n) {}).read(), +// [42], +// ); +// expect( +// container.listen(genericProvider(), (p, n) {}).read(), +// [3.14], +// ); +// expect( +// container.listen(genericProvider(), (p, n) {}).read(), +// [42, 3.14], +// ); +// }); +// }); + +// test('Supports Raw', () async { +// final container = createContainer(); + +// expect( +// container.read(rawFutureProvider), +// isA>(), +// ); +// expect( +// container.read(rawFutureClassProvider), +// isA>(), +// ); +// expect( +// container.read(rawFutureClassProvider.notifier), +// isA(), +// ); + +// expect( +// container.read(rawStreamProvider), +// isA>(), +// ); +// expect( +// container.read(rawStreamClassProvider), +// isA>(), +// ); +// expect( +// container.read(rawStreamClassProvider.notifier), +// isA(), +// ); + +// expect( +// container.read(rawFamilyFutureProvider(0)), +// isA>(), +// ); +// expect( +// container.read(rawFamilyFutureClassProvider(0)), +// isA>(), +// ); +// expect( +// container.read(rawFamilyFutureClassProvider(0).notifier), +// isA(), +// ); + +// expect( +// container.read(rawFamilyStreamProvider(0)), +// isA>(), +// ); +// expect( +// container.read(rawFamilyStreamClassProvider(0)), +// isA>(), +// ); +// expect( +// container.read(rawFamilyStreamClassProvider(0).notifier), +// isA(), +// ); +// }); + +// test('overrides toString', () { +// expect(publicProvider.toString(), 'publicProvider'); +// expect(familyProvider.toString(), 'familyProvider'); +// expect( +// familyProvider.call(42, second: 'foo', third: .3).toString(), +// 'familyProvider(42, fifth: null, fourth: true, second: foo, third: 0.3)', +// ); + +// expect( +// publicProvider.overrideWithValue('foo').toString(), +// 'publicProvider.overrideWithValue(foo)', +// ); +// expect( +// familyProvider.overrideWith((ref) => 'foo').toString(), +// 'familyProvider.overrideWith(...)', +// ); +// expect( +// familyProvider(42, second: 'foo', third: .3) +// .overrideWith((ref) => '') +// .toString(), +// 'familyProvider(42, fifth: null, fourth: true, second: foo, third: 0.3).overrideWith(...)', +// ); +// }); + +// test('Supports overriding non-family providers', () { +// final container = createContainer( +// overrides: [ +// publicProvider.overrideWith((ref) => 'Hello world'), +// ], +// ); + +// final result = container.read(publicProvider); +// expect(result, 'Hello world'); +// }); + +// test('Supports overriding family providers', () { +// final container = createContainer( +// overrides: [ +// familyProvider(42, third: .42).overrideWith( +// (ref) => 'Hello world ${ref.first} ${ref.second} ' +// '${ref.third} ${ref.fourth} ${ref.fifth}', +// ), +// ], +// ); + +// final result = container.read(familyProvider(42, third: .42)); +// expect(result, 'Hello world 42 null 0.42 true null'); +// }); + +// test( +// 'Creates a Provider if @riverpod is used on an stream function wrapped in Raw', +// () async { +// final container = createContainer(); + +// final AutoDisposeProvider> provider = rawStreamProvider; +// final Stream result = container.read(rawStreamProvider); + +// await expectLater(result, emits('Hello world')); +// }); + +// test('Creates a Provider if @riverpod is used on a synchronous function', +// () { +// final container = createContainer(); + +// final AutoDisposeProvider provider = publicProvider; +// final String result = container.read(publicProvider); + +// expect(result, 'Hello world'); +// }); + +// test('Generates .name for providers', () { +// expect(publicProvider.name, 'publicProvider'); +// expect(privateProvider.name, '_privateProvider'); + +// expect(familyProvider.name, 'familyProvider'); +// expect(familyProvider(42, third: .42).name, 'familyProvider'); +// }); + +// test( +// 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', +// () { +// final container = createContainer(); + +// const FamilyFamily family = familyProvider; + +// expect(familyProvider(42, third: .42).from, familyProvider); + +// expect( +// familyProvider(42, third: .42), +// familyProvider(42, third: .42), +// ); +// expect( +// familyProvider(42, third: .42), +// isNot(familyProvider(42, third: .21)), +// ); +// expect( +// familyProvider(42, third: .42).hashCode, +// isNot(familyProvider(42, third: .21).hashCode), +// ); + +// // handle defaults +// expect( +// familyProvider(42, third: .42), +// familyProvider( +// 42, +// third: .42, +// ), +// ); +// expect( +// familyProvider(42, third: .42).hashCode, +// familyProvider( +// 42, +// third: .42, +// ).hashCode, +// ); + +// final FamilyProvider provider = familyProvider( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: const ['x42'], +// ); +// final AutoDisposeProvider futureProvider = provider; + +// expect(provider.first, 42); +// expect(provider.second, 'x42'); +// expect(provider.third, .42); +// expect(provider.fourth, false); +// expect(provider.fifth, ['x42']); + +// final ( +// int, { +// String? second, +// double third, +// bool fourth, +// List? fifth, +// }) argument = provider.argument; + +// expect( +// argument, +// ( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: const ['x42'], +// ), +// ); + +// final String result = container.read( +// familyProvider( +// 42, +// second: 'x42', +// third: .42, +// fourth: false, +// fifth: ['x42'], +// ), +// ); + +// expect( +// result, +// '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', +// ); +// }); + +// test('can override providers', () { +// final container = createContainer(overrides: [ +// publicProvider.overrideWith((ref) => 'test'), +// publicClassProvider.overrideWith(() => PublicClass(42)), +// familyProvider.overrideWith( +// (ref) => +// 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})', +// ), +// familyClassProvider.overrideWith(() => FamilyClass(42)), +// ]); + +// expect(container.read(publicProvider), 'test'); +// expect(container.read(publicClassProvider.notifier).param, 42); +// expect( +// container.read(familyProvider(42, second: '42', third: .42)), +// 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', +// ); +// expect( +// container +// .read(familyClassProvider(42, second: '42', third: .42).notifier) +// .param, +// 42, +// ); +// }); +// } From 38fde0e3a079393ab1541126b8966e6a4b7aa4d1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 2 Feb 2024 17:04:38 +0100 Subject: [PATCH 151/387] More generator --- .../lib/src/providers/async_notifier.dart | 8 +- .../src/providers/async_notifier/family.dart | 7 +- .../src/providers/async_notifier/orphan.dart | 11 +- .../lib/src/riverpod_generator.dart | 2 +- .../src/templates/class_based_provider.dart | 12 +- .../lib/src/templates/family.dart | 5 +- .../lib/src/templates/family_back.dart | 8 +- .../lib/src/templates/notifier.dart | 30 +- .../lib/src/templates/provider.dart | 175 +++++--- .../test/integration/async.dart | 1 + .../test/integration/async.g.dart | 403 ++++++++++++------ .../test/integration/auto_dispose.dart | 22 +- .../test/integration/auto_dispose.g.dart | 111 +++++ 13 files changed, 564 insertions(+), 231 deletions(-) create mode 100644 packages/riverpod_generator/test/integration/auto_dispose.g.dart diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index e8755fa5d..8878b0682 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -31,8 +31,7 @@ abstract base class $AsyncNotifierProvider< // Ref>> // with $FutureModifier { - const $AsyncNotifierProvider( - this._createNotifier, { + const $AsyncNotifierProvider({ required super.name, required super.from, required super.argument, @@ -42,11 +41,6 @@ abstract base class $AsyncNotifierProvider< // required super.isAutoDispose, required super.runNotifierBuildOverride, }); - - final NotifierT Function() _createNotifier; - - @override - NotifierT create() => _createNotifier(); } /// Implementation detail of `riverpod_generator`. diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index bfc5949d7..cccdaa33d 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -61,7 +61,7 @@ final class FamilyAsyncNotifierProvider< // extends $AsyncNotifierProvider { /// An implementation detail of Riverpod const FamilyAsyncNotifierProvider._( - super._createNotifier, { + this._createNotifier, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -90,6 +90,11 @@ final class FamilyAsyncNotifierProvider< // ); } + final NotifierT Function() _createNotifier; + + @override + NotifierT create() => _createNotifier(); + @internal @override $AsyncNotifierProviderElement createElement( diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index 522a52f6f..b8a68e622 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -65,7 +65,7 @@ final class AsyncNotifierProvider< // /// /// {@macro riverpod.async_notifier_provider_modifier} AsyncNotifierProvider( - super._createNotifier, { + this._createNotifier, { super.name, super.dependencies, super.isAutoDispose = false, @@ -79,7 +79,7 @@ final class AsyncNotifierProvider< // ); AsyncNotifierProvider._autoDispose( - super._createNotifier, { + this._createNotifier, { super.name, super.dependencies, }) : super( @@ -95,7 +95,7 @@ final class AsyncNotifierProvider< // /// An implementation detail of Riverpod @internal const AsyncNotifierProvider.internal( - super._createNotifier, { + this._createNotifier, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -112,6 +112,11 @@ final class AsyncNotifierProvider< // /// {@macro riverpod.family} static const family = AsyncNotifierProviderFamilyBuilder(); + final NotifierT Function() _createNotifier; + + @override + NotifierT create() => _createNotifier(); + AsyncNotifierProvider _copyWith({ NotifierT Function()? create, RunNotifierBuild, Ref>>? diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index 765469030..d6979eaf5 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -113,7 +113,7 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { GeneratorProviderDeclaration provider, ) { ProviderVariableTemplate(provider, options).run(buffer); - ProviderTemplate(provider).run(buffer); + ProviderTemplate(provider, options).run(buffer); HashFnTemplate(provider).run(buffer); FamilyTemplate(provider, options).run(buffer); } diff --git a/packages/riverpod_generator/lib/src/templates/class_based_provider.dart b/packages/riverpod_generator/lib/src/templates/class_based_provider.dart index 9143cc06d..cd863978d 100644 --- a/packages/riverpod_generator/lib/src/templates/class_based_provider.dart +++ b/packages/riverpod_generator/lib/src/templates/class_based_provider.dart @@ -10,16 +10,14 @@ String providerNameFor( return '${provider.name.lowerFirst}${options.providerNameSuffix ?? 'Provider'}'; } -String? serializeDependencies( +String serializeDependencies( RiverpodAnnotationElement annotation, BuildYamlOptions options, ) { final dependencies = annotation.dependencies; if (dependencies == null) return 'null'; - final buffer = StringBuffer( - '${dependencies.isEmpty ? 'const ' : ''}', - ); + final buffer = StringBuffer('const '); // Use list vs set based on the number of dependencies to optimize "contains" call if (dependencies.length < 4) { buffer.write('['); @@ -40,7 +38,7 @@ String? serializeDependencies( return buffer.toString(); } -String? serializeAllTransitiveDependencies( +String serializeAllTransitiveDependencies( RiverpodAnnotationElement annotation, BuildYamlOptions options, ) { @@ -51,9 +49,7 @@ String? serializeAllTransitiveDependencies( final dependencies = annotation.dependencies; if (dependencies == null) return 'null'; - final buffer = StringBuffer( - '${dependencies.isEmpty ? 'const ' : ''}', - ); + final buffer = StringBuffer('const '); buffer.write('{'); buffer.writeAll( diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 7c0383e8b..9507a92cb 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -1,7 +1,6 @@ import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import '../models.dart'; -import 'class_based_provider.dart'; import 'family_back.dart'; import 'parameters.dart'; import 'template.dart'; @@ -36,8 +35,8 @@ final class ${provider.familyTypeName} extends Family{ const ${provider.familyTypeName}._() : super( name: r'${provider.name}', - dependencies: ${serializeDependencies(provider.providerElement.annotation, options)}, - allTransitiveDependencies: ${serializeAllTransitiveDependencies(provider.providerElement.annotation, options)}, + dependencies: ${provider.dependencies(options)}, + allTransitiveDependencies: ${provider.allTransitiveDependencies(options)}, debugGetCreateSourceHash: ${provider.hashFnName}, ${provider.providerElement.isAutoDispose ? 'isAutoDispose: true,' : ''} ); diff --git a/packages/riverpod_generator/lib/src/templates/family_back.dart b/packages/riverpod_generator/lib/src/templates/family_back.dart index 4fcae7493..5465808ad 100644 --- a/packages/riverpod_generator/lib/src/templates/family_back.dart +++ b/packages/riverpod_generator/lib/src/templates/family_back.dart @@ -400,7 +400,7 @@ extension ProviderNames on GeneratorProviderDeclaration { final refType = '${provider.refImplName}$generics'; return '${provider.createdTypeDisplayString} Function($refType ref, $params)'; case ClassBasedProviderDeclaration(): - return '${provider.createdTypeDisplayString} Function()'; + return '${provider.name}$generics Function()'; } } @@ -430,4 +430,10 @@ extension ProviderNames on GeneratorProviderDeclaration { return provider.buildMethod.parameters!.parameters.toList(); } } + + String dependencies(BuildYamlOptions options) => + serializeDependencies(providerElement.annotation, options); + + String allTransitiveDependencies(BuildYamlOptions options) => + serializeAllTransitiveDependencies(providerElement.annotation, options); } diff --git a/packages/riverpod_generator/lib/src/templates/notifier.dart b/packages/riverpod_generator/lib/src/templates/notifier.dart index dbd48827a..ac62fc8f7 100644 --- a/packages/riverpod_generator/lib/src/templates/notifier.dart +++ b/packages/riverpod_generator/lib/src/templates/notifier.dart @@ -26,15 +26,39 @@ class NotifierTemplate extends Template { '\$cNotifier<${provider.valueTypeDisplayString}>', }; + final argumentRecordType = buildParamDefinitionQuery( + provider.parameters, + asRecord: true, + ); + + final paramsPassThrough = buildParamInvocationQuery({ + for (final (index, parameter) in provider.parameters.indexed) + if (parameter.isPositional) + parameter: '_\$args.\$${index + 1}' + else + parameter: '_\$args.${parameter.name!.lexeme}', + }); + + final _$args = r'late final _$args = ' + '(ref as ${provider.elementName}).origin.argument as ($argumentRecordType);'; + var paramOffset = 0; + final parametersAsFields = provider.parameters + .map( + (p) => '${p.typeDisplayString} get ${p.name!.lexeme} => ' + '_\$args.${p.isPositional ? '\$${++paramOffset}' : p.name!.lexeme};', + ) + .join(); + buffer.writeln(''' abstract class $notifierBaseName$genericsDefinition extends $baseClass { + ${provider.parameters.isNotEmpty ? _$args : ''} + $parametersAsFields + ${provider.createdTypeDisplayString} build($buildParams); @\$internal @override - void runBuild() { - - } + ${provider.createdTypeDisplayString} runBuild() => build($paramsPassThrough); } '''); } diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index cd8b31e61..bd24216ff 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -1,29 +1,39 @@ import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import '../models.dart'; import '../type.dart'; import 'family_back.dart'; import 'parameters.dart'; import 'template.dart'; class ProviderTemplate extends Template { - ProviderTemplate(this.provider); + ProviderTemplate(this.provider, this.options); final GeneratorProviderDeclaration provider; + final BuildYamlOptions options; + + late final _argumentRecordType = buildParamDefinitionQuery( + provider.parameters, + asRecord: true, + ); + + late final _generics = provider.generics(); + late final _genericsDefinition = provider.genericsDefinition(); + + late final _refType = switch (provider) { + FunctionalProviderDeclaration() => '${provider.refImplName}$_generics', + ClassBasedProviderDeclaration() => + 'Ref<${provider.exposedTypeDisplayString}>', + }; @override void run(StringBuffer buffer) { final provider = this.provider; - final generics = provider.generics(); - final genericsDefinition = provider.genericsDefinition(); final name = provider.providerTypeName; final exposedType = provider.exposedTypeDisplayString; final createdType = provider.createdTypeDisplayString; final valueType = provider.valueTypeDisplayString; - final refType = switch (provider) { - FunctionalProviderDeclaration() => '${provider.refImplName}$generics', - ClassBasedProviderDeclaration() => 'Ref<$exposedType>', - }; switch (provider) { case FunctionalProviderDeclaration(): @@ -33,12 +43,12 @@ class ProviderTemplate extends Template { case SupportedCreatedType.future: modifiers = [ '\$FutureModifier<$valueType>', - '\$FutureProvider<$valueType, $refType>', + '\$FutureProvider<$valueType, $_refType>', ]; case SupportedCreatedType.stream: modifiers = [ '\$FutureModifier<$valueType>', - '\$StreamProvider<$valueType, $refType>', + '\$StreamProvider<$valueType, $_refType>', ]; case SupportedCreatedType.value: modifiers = []; @@ -47,17 +57,17 @@ class ProviderTemplate extends Template { final mixins = modifiers.isEmpty ? '' : ' with ${modifiers.join(', ')}'; buffer.writeln(''' -final class $name$genericsDefinition +final class $name$_genericsDefinition extends \$FunctionalProvider< $exposedType, $createdType, - $refType + $_refType > $mixins { '''); case ClassBasedProviderDeclaration(): - final notifierType = '${provider.name}$generics'; + final notifierType = '${provider.name}$_generics'; final String baseClass; @@ -71,7 +81,7 @@ final class $name$genericsDefinition } buffer.writeln( - 'final class $name$genericsDefinition extends $baseClass {', + 'final class $name$_genericsDefinition extends $baseClass {', ); } @@ -80,66 +90,64 @@ final class $name$genericsDefinition buffer.writeln('}'); } - void _writeMembers(StringBuffer buffer) { - final provider = this.provider; - final generics = provider.generics(); - - final providerParameters = provider.parameters; - + void _writeConstructor(StringBuffer buffer) { final superParameters = [ if (!provider.providerElement.isFamily) 'from: null,', - if (providerParameters.isEmpty) 'argument: null,', + if (provider.parameters.isEmpty) 'argument: null,', ].join(); - final argumentRecordType = buildParamDefinitionQuery( - provider.parameters, - asRecord: true, - ); - final constructorParameters = [ if (provider.providerElement.isFamily) 'required ${provider.familyTypeName} super.from,', - if (providerParameters.isNotEmpty) - 'required ($argumentRecordType) super.argument,', + if (provider.parameters.isNotEmpty) + 'required ($_argumentRecordType) super.argument,', + if (provider is ClassBasedProviderDeclaration) + 'super.runNotifierBuildOverride,', ].join(); - final localArgumentDefinition = provider.parameters.isNotEmpty - ? 'final ($argumentRecordType) argument = this.argument! as ($argumentRecordType);' - : ''; - final paramsPassThrough = buildParamInvocationQuery({ - for (final (index, parameter) in provider.parameters.indexed) - if (parameter.isPositional) - parameter: 'argument.\$${index + 1}' - else - parameter: 'argument.${parameter.name!.lexeme}', - }); - buffer.writeln(''' const ${provider.providerTypeName}._({ - ${provider.createType()}? create, $constructorParameters + ${provider.createType()}? create }): _createCb = create, super( + $superParameters debugGetCreateSourceHash: ${provider.hashFnName}, name: r'${provider.name}', isAutoDispose: ${!provider.annotation.element.keepAlive}, - dependencies: null, - allTransitiveDependencies: null, - $superParameters + dependencies: ${!provider.providerElement.isFamily ? provider.dependencies(options) : 'null'}, + allTransitiveDependencies: ${!provider.providerElement.isFamily ? provider.allTransitiveDependencies(options) : 'null'}, ); +'''); + } + void _writeMembers(StringBuffer buffer) { + _writeConstructor(buffer); + + buffer.writeln(''' final ${provider.createType()}? _createCb; '''); + final localArgumentDefinition = provider.parameters.isNotEmpty + ? 'final ($_argumentRecordType) argument = this.argument! as ($_argumentRecordType);' + : ''; + final paramsPassThrough = buildParamInvocationQuery({ + for (final (index, parameter) in provider.parameters.indexed) + if (parameter.isPositional) + parameter: 'argument.\$${index + 1}' + else + parameter: 'argument.${parameter.name!.lexeme}', + }); + + final copyParameters = [ + if (provider.parameters.isNotEmpty) + 'argument: argument! as ($_argumentRecordType),', + if (provider.providerElement.isFamily) + 'from: from! as ${provider.familyTypeName},', + ].join(); + switch (provider) { case FunctionalProviderDeclaration(): - final parameters = [ - if (providerParameters.isNotEmpty) - 'argument: argument! as ($argumentRecordType),', - if (provider.providerElement.isFamily) - 'from: from! as ${provider.familyTypeName},', - ].join(); - final createParams = buildParamDefinitionQuery(provider.parameters); final createFn = provider.parameters.isEmpty @@ -155,45 +163,78 @@ final class $name$genericsDefinition buffer.writeln(''' @override - ${provider.createdTypeDisplayString} create(${provider.refImplName}$generics ref){ - final fn = _createCb ?? ${provider.name}$generics; + ${provider.createdTypeDisplayString} create(${provider.refImplName}$_generics ref){ + final fn = _createCb ?? ${provider.name}$_generics; $localArgumentDefinition return fn(ref, $paramsPassThrough); }'''); buffer.writeln(''' @override - ${provider.providerTypeName}$generics copyWithCreate( + ${provider.providerTypeName}$_generics copyWithCreate( ${provider.createType(withArguments: false)} create, ) { - return ${provider.providerTypeName}$generics._( - create: $createFn, - $parameters + return ${provider.providerTypeName}$_generics._( + $copyParameters + create: $createFn ); } '''); case ClassBasedProviderDeclaration(): + final notifierType = '${provider.name}$_generics'; + buffer.writeln(''' + @\$internal + @override + $notifierType create() => _createCb?.call() ?? $notifierType(); + + @\$internal + @override + ${provider.providerTypeName}$_generics copyWithCreate( + $notifierType Function() create, + ) { + return ${provider.providerTypeName}$_generics._( + $copyParameters + create: create + ); + } + + @\$internal + @override + ${provider.providerTypeName}$_generics copyWithBuild( + ${provider.createdTypeDisplayString} Function($_refType, $notifierType) build, + ) { + return ${provider.providerTypeName}$_generics._( + $copyParameters + runNotifierBuildOverride: build + ); + } + + @\$internal @override - ${provider.elementName}<${provider.name}$generics, ${provider.valueTypeDisplayString}> createElement( + ${provider.elementName}<$notifierType, ${provider.valueTypeDisplayString}> createElement( ProviderContainer container ) => ${provider.elementName}(this, container); '''); } - if (provider.providerElement.isFamily) { - buffer.writeln(''' + _writeEqual(buffer); + } + + void _writeEqual(StringBuffer buffer) { + if (!provider.providerElement.isFamily) return; + + buffer.writeln(''' @override bool operator ==(Object other) { return ${[ - 'other is ${provider.providerTypeName}', - // If there are type parameters, check the runtimeType to check them too. - if (provider.typeParameters?.typeParameters.isNotEmpty ?? false) - 'other.runtimeType == runtimeType', - 'other.argument == argument', - ].join(' && ')}; - } -'''); - } + 'other is ${provider.providerTypeName}', + // If there are type parameters, check the runtimeType to check them too. + if (provider.typeParameters?.typeParameters.isNotEmpty ?? false) + 'other.runtimeType == runtimeType', + 'other.argument == argument', + ].join(' && ')}; + } + '''); } } diff --git a/packages/riverpod_generator/test/integration/async.dart b/packages/riverpod_generator/test/integration/async.dart index 469608b30..398f74981 100644 --- a/packages/riverpod_generator/test/integration/async.dart +++ b/packages/riverpod_generator/test/integration/async.dart @@ -1,3 +1,4 @@ +import 'package:riverpod/src/framework.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'async.g.dart'; diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index aac84ca43..85291533f 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -13,19 +13,19 @@ const genericProvider = GenericFamily._(); final class GenericProvider extends $FunctionalProvider< AsyncValue>, FutureOr>, GenericRef> with $FutureModifier>, $FutureProvider, GenericRef> { - const GenericProvider._({ - FutureOr> Function( - GenericRef ref, - )? create, - required GenericFamily super.from, - }) : _createCb = create, + const GenericProvider._( + {required GenericFamily super.from, + FutureOr> Function( + GenericRef ref, + )? create}) + : _createCb = create, super( + argument: null, debugGetCreateSourceHash: _$genericHash, name: r'generic', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - argument: null, ); final FutureOr> Function( @@ -51,10 +51,7 @@ final class GenericProvider extends $FunctionalProvider< GenericRef ref, ) create, ) { - return GenericProvider._( - create: create, - from: from! as GenericFamily, - ); + return GenericProvider._(from: from! as GenericFamily, create: create); } @override @@ -90,19 +87,19 @@ const publicProvider = PublicProvider._(); final class PublicProvider extends $FunctionalProvider, FutureOr, PublicRef> with $FutureModifier, $FutureProvider { - const PublicProvider._({ - FutureOr Function( - PublicRef ref, - )? create, - }) : _createCb = create, + const PublicProvider._( + {FutureOr Function( + PublicRef ref, + )? create}) + : _createCb = create, super( + from: null, + argument: null, debugGetCreateSourceHash: _$publicHash, name: r'public', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - from: null, - argument: null, ); final FutureOr Function( @@ -128,9 +125,7 @@ final class PublicProvider PublicRef ref, ) create, ) { - return PublicProvider._( - create: create, - ); + return PublicProvider._(create: create); } } @@ -143,19 +138,19 @@ const _privateProvider = _PrivateProvider._(); final class _PrivateProvider extends $FunctionalProvider, FutureOr, _PrivateRef> with $FutureModifier, $FutureProvider { - const _PrivateProvider._({ - FutureOr Function( - _PrivateRef ref, - )? create, - }) : _createCb = create, + const _PrivateProvider._( + {FutureOr Function( + _PrivateRef ref, + )? create}) + : _createCb = create, super( + from: null, + argument: null, debugGetCreateSourceHash: _$privateHash, name: r'_private', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - from: null, - argument: null, ); final FutureOr Function( @@ -181,9 +176,7 @@ final class _PrivateProvider extends $FunctionalProvider, _PrivateRef ref, ) create, ) { - return _PrivateProvider._( - create: create, - ); + return _PrivateProvider._(create: create); } } @@ -196,14 +189,14 @@ const familyOrProvider = FamilyOrFamily._(); final class FamilyOrProvider extends $FunctionalProvider, FutureOr, FamilyOrRef> with $FutureModifier, $FutureProvider { - const FamilyOrProvider._({ - FutureOr Function( - FamilyOrRef ref, - int first, - )? create, - required FamilyOrFamily super.from, - required (int,) super.argument, - }) : _createCb = create, + const FamilyOrProvider._( + {required FamilyOrFamily super.from, + required (int,) super.argument, + FutureOr Function( + FamilyOrRef ref, + int first, + )? create}) + : _createCb = create, super( debugGetCreateSourceHash: _$familyOrHash, name: r'familyOr', @@ -238,14 +231,13 @@ final class FamilyOrProvider extends $FunctionalProvider, ) create, ) { return FamilyOrProvider._( - create: ( - ref, - int first, - ) => - create(ref), - argument: argument! as (int,), - from: from! as FamilyOrFamily, - ); + argument: argument! as (int,), + from: from! as FamilyOrFamily, + create: ( + ref, + int first, + ) => + create(ref)); } @override @@ -282,25 +274,25 @@ const familyProvider = FamilyFamily._(); final class FamilyProvider extends $FunctionalProvider, FutureOr, FamilyRef> with $FutureModifier, $FutureProvider { - const FamilyProvider._({ - FutureOr Function( - FamilyRef ref, - int first, { - String? second, - required double third, - bool fourth, - List? fifth, - })? create, - required FamilyFamily super.from, - required ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) - super.argument, - }) : _createCb = create, + const FamilyProvider._( + {required FamilyFamily super.from, + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, + FutureOr Function( + FamilyRef ref, + int first, { + String? second, + required double third, + bool fourth, + List? fifth, + })? create}) + : _createCb = create, super( debugGetCreateSourceHash: _$familyHash, name: r'family', @@ -355,24 +347,23 @@ final class FamilyProvider ) create, ) { return FamilyProvider._( - create: ( - ref, - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) => - create(ref), - argument: argument! as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }), - from: from! as FamilyFamily, - ); + argument: argument! as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), + from: from! as FamilyFamily, + create: ( + ref, + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) => + create(ref)); } @override @@ -416,21 +407,45 @@ const genericClassProvider = GenericClassFamily._(); final class GenericClassProvider extends $AsyncNotifierProvider, List> { - const GenericClassProvider._({ - FutureOr> Function()? create, - required GenericClassFamily super.from, - }) : _createCb = create, + const GenericClassProvider._( + {required GenericClassFamily super.from, + super.runNotifierBuildOverride, + GenericClass Function()? create}) + : _createCb = create, super( + argument: null, debugGetCreateSourceHash: _$genericClassHash, name: r'GenericClass', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - argument: null, ); - final FutureOr> Function()? _createCb; + final GenericClass Function()? _createCb; + @$internal + @override + GenericClass create() => _createCb?.call() ?? GenericClass(); + + @$internal + @override + GenericClassProvider copyWithCreate( + GenericClass Function() create, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, create: create); + } + + @$internal + @override + GenericClassProvider copyWithBuild( + FutureOr> Function(Ref>>, GenericClass) build, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, runNotifierBuildOverride: build); + } + + @$internal @override $AsyncNotifierProviderElement, List> createElement( ProviderContainer container) => @@ -468,28 +483,49 @@ abstract class _$GenericClass extends $AsyncNotifier> { @$internal @override - void runBuild() {} + FutureOr> runBuild() => build(); } const publicClassProvider = PublicClassProvider._(); final class PublicClassProvider extends $AsyncNotifierProvider { - const PublicClassProvider._({ - FutureOr Function()? create, - }) : _createCb = create, + const PublicClassProvider._( + {super.runNotifierBuildOverride, PublicClass Function()? create}) + : _createCb = create, super( + from: null, + argument: null, debugGetCreateSourceHash: _$publicClassHash, name: r'PublicClass', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - from: null, - argument: null, ); - final FutureOr Function()? _createCb; + final PublicClass Function()? _createCb; + + @$internal + @override + PublicClass create() => _createCb?.call() ?? PublicClass(); + + @$internal + @override + PublicClassProvider copyWithCreate( + PublicClass Function() create, + ) { + return PublicClassProvider._(create: create); + } + @$internal + @override + PublicClassProvider copyWithBuild( + FutureOr Function(Ref>, PublicClass) build, + ) { + return PublicClassProvider._(runNotifierBuildOverride: build); + } + + @$internal @override $AsyncNotifierProviderElement createElement( ProviderContainer container) => @@ -503,28 +539,49 @@ abstract class _$PublicClass extends $AsyncNotifier { @$internal @override - void runBuild() {} + FutureOr runBuild() => build(); } const _privateClassProvider = _PrivateClassProvider._(); final class _PrivateClassProvider extends $AsyncNotifierProvider<_PrivateClass, String> { - const _PrivateClassProvider._({ - FutureOr Function()? create, - }) : _createCb = create, + const _PrivateClassProvider._( + {super.runNotifierBuildOverride, _PrivateClass Function()? create}) + : _createCb = create, super( + from: null, + argument: null, debugGetCreateSourceHash: _$privateClassHash, name: r'_PrivateClass', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - from: null, - argument: null, ); - final FutureOr Function()? _createCb; + final _PrivateClass Function()? _createCb; + + @$internal + @override + _PrivateClass create() => _createCb?.call() ?? _PrivateClass(); + + @$internal + @override + _PrivateClassProvider copyWithCreate( + _PrivateClass Function() create, + ) { + return _PrivateClassProvider._(create: create); + } + @$internal + @override + _PrivateClassProvider copyWithBuild( + FutureOr Function(Ref>, _PrivateClass) build, + ) { + return _PrivateClassProvider._(runNotifierBuildOverride: build); + } + + @$internal @override $AsyncNotifierProviderElement<_PrivateClass, String> createElement( ProviderContainer container) => @@ -538,18 +595,19 @@ abstract class _$PrivateClass extends $AsyncNotifier { @$internal @override - void runBuild() {} + FutureOr runBuild() => build(); } const familyOrClassProvider = FamilyOrClassFamily._(); final class FamilyOrClassProvider extends $AsyncNotifierProvider { - const FamilyOrClassProvider._({ - FutureOr Function()? create, - required FamilyOrClassFamily super.from, - required (int,) super.argument, - }) : _createCb = create, + const FamilyOrClassProvider._( + {required FamilyOrClassFamily super.from, + required (int,) super.argument, + super.runNotifierBuildOverride, + FamilyOrClass Function()? create}) + : _createCb = create, super( debugGetCreateSourceHash: _$familyOrClassHash, name: r'FamilyOrClass', @@ -558,8 +616,35 @@ final class FamilyOrClassProvider allTransitiveDependencies: null, ); - final FutureOr Function()? _createCb; + final FamilyOrClass Function()? _createCb; + @$internal + @override + FamilyOrClass create() => _createCb?.call() ?? FamilyOrClass(); + + @$internal + @override + FamilyOrClassProvider copyWithCreate( + FamilyOrClass Function() create, + ) { + return FamilyOrClassProvider._( + argument: argument! as (int,), + from: from! as FamilyOrClassFamily, + create: create); + } + + @$internal + @override + FamilyOrClassProvider copyWithBuild( + FutureOr Function(Ref>, FamilyOrClass) build, + ) { + return FamilyOrClassProvider._( + argument: argument! as (int,), + from: from! as FamilyOrClassFamily, + runNotifierBuildOverride: build); + } + + @$internal @override $AsyncNotifierProviderElement createElement( ProviderContainer container) => @@ -593,31 +678,38 @@ final class FamilyOrClassFamily extends Family { } abstract class _$FamilyOrClass extends $AsyncNotifier { + late final _$args = + (ref as $AsyncNotifierProviderElement).origin.argument as (int,); + int get first => _$args.$1; + FutureOr build( int first, ); @$internal @override - void runBuild() {} + FutureOr runBuild() => build( + _$args.$1, + ); } const familyClassProvider = FamilyClassFamily._(); final class FamilyClassProvider extends $AsyncNotifierProvider { - const FamilyClassProvider._({ - FutureOr Function()? create, - required FamilyClassFamily super.from, - required ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) - super.argument, - }) : _createCb = create, + const FamilyClassProvider._( + {required FamilyClassFamily super.from, + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, + super.runNotifierBuildOverride, + FamilyClass Function()? create}) + : _createCb = create, super( debugGetCreateSourceHash: _$familyClassHash, name: r'FamilyClass', @@ -626,8 +718,47 @@ final class FamilyClassProvider allTransitiveDependencies: null, ); - final FutureOr Function()? _createCb; + final FamilyClass Function()? _createCb; + @$internal + @override + FamilyClass create() => _createCb?.call() ?? FamilyClass(); + + @$internal + @override + FamilyClassProvider copyWithCreate( + FamilyClass Function() create, + ) { + return FamilyClassProvider._( + argument: argument! as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), + from: from! as FamilyClassFamily, + create: create); + } + + @$internal + @override + FamilyClassProvider copyWithBuild( + FutureOr Function(Ref>, FamilyClass) build, + ) { + return FamilyClassProvider._( + argument: argument! as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), + from: from! as FamilyClassFamily, + runNotifierBuildOverride: build); + } + + @$internal @override $AsyncNotifierProviderElement createElement( ProviderContainer container) => @@ -671,6 +802,20 @@ final class FamilyClassFamily extends Family { } abstract class _$FamilyClass extends $AsyncNotifier { + late final _$args = + (ref as $AsyncNotifierProviderElement).origin.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + int get first => _$args.$1; + String? get second => _$args.second; + double get third => _$args.third; + bool get fourth => _$args.fourth; + List? get fifth => _$args.fifth; + FutureOr build( int first, { String? second, @@ -681,7 +826,13 @@ abstract class _$FamilyClass extends $AsyncNotifier { @$internal @override - void runBuild() {} + FutureOr runBuild() => build( + _$args.$1, + second: _$args.second, + third: _$args.third, + fourth: _$args.fourth, + fifth: _$args.fifth, + ); } const $kDebugMode = bool.fromEnvironment('dart.vm.product'); diff --git a/packages/riverpod_generator/test/integration/auto_dispose.dart b/packages/riverpod_generator/test/integration/auto_dispose.dart index b384e20cf..a63f1ce0e 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.dart @@ -1,14 +1,14 @@ -// import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; -// part 'auto_dispose.g.dart'; +part 'auto_dispose.g.dart'; -// @Riverpod(keepAlive: true) -// int keepAlive(KeepAliveRef ref) { -// return 0; -// } +@Riverpod(keepAlive: true) +int keepAlive(KeepAliveRef ref) { + return 0; +} -// @Riverpod(keepAlive: false) -// int notKeepAlive(NotKeepAliveRef ref) { -// ref.keepAlive(); -// return 0; -// } +@Riverpod(keepAlive: false) +int notKeepAlive(NotKeepAliveRef ref) { + ref.keepAlive(); + return 0; +} diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart new file mode 100644 index 000000000..02bb98dc8 --- /dev/null +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -0,0 +1,111 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'auto_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef KeepAliveRef = Ref; + +const keepAliveProvider = KeepAliveProvider._(); + +final class KeepAliveProvider + extends $FunctionalProvider { + const KeepAliveProvider._( + {int Function( + KeepAliveRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$keepAliveHash, + name: r'keepAlive', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + KeepAliveRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(KeepAliveRef ref) { + final fn = _createCb ?? keepAlive; + + return fn( + ref, + ); + } + + @override + KeepAliveProvider copyWithCreate( + int Function( + KeepAliveRef ref, + ) create, + ) { + return KeepAliveProvider._(create: create); + } +} + +String _$keepAliveHash() => r'72dd192676126d487c24c7695a91d59410c62696'; + +typedef NotKeepAliveRef = Ref; + +const notKeepAliveProvider = NotKeepAliveProvider._(); + +final class NotKeepAliveProvider + extends $FunctionalProvider { + const NotKeepAliveProvider._( + {int Function( + NotKeepAliveRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$notKeepAliveHash, + name: r'notKeepAlive', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + NotKeepAliveRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(NotKeepAliveRef ref) { + final fn = _createCb ?? notKeepAlive; + + return fn( + ref, + ); + } + + @override + NotKeepAliveProvider copyWithCreate( + int Function( + NotKeepAliveRef ref, + ) create, + ) { + return NotKeepAliveProvider._(create: create); + } +} + +String _$notKeepAliveHash() => r'1ccc497d7c651f8e730ec1bcecf271ffe9615d83'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package From d831e4089c27536f6578882404594ef318677ba4 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 2 Feb 2024 18:28:00 +0100 Subject: [PATCH 152/387] W --- packages/riverpod/lib/src/core/element.dart | 2 +- .../lib/src/core/modifiers/select.dart | 2 +- .../lib/src/providers/future_provider.dart | 2 +- .../riverpod/lib/src/providers/provider.dart | 31 +- .../lib/src/providers/stream_provider.dart | 29 +- .../riverpod/test/new/core/scope_test.dart | 4 +- .../framework/provider_container_test.dart | 14 +- .../old/legacy/framework2/framework_test.dart | 4 +- .../test/old/legacy/framework_test.dart | 4 +- .../provider/provider_test.dart | 2 +- .../lib/riverpod_annotation.dart | 16 +- .../src/templates/class_based_provider.dart | 17 +- .../lib/src/templates/notifier.dart | 2 +- .../lib/src/templates/provider.dart | 2 +- .../test/integration/auto_dispose.g.dart | 6 +- .../test/integration/dependencies.dart | 98 +- .../test/integration/dependencies.g.dart | 995 +++++++++++ .../test/integration/dependencies2.dart | 52 +- .../test/integration/dependencies2.g.dart | 470 +++++ .../test/integration/generated.dart | 166 +- .../test/integration/generated.freezed.dart | 74 + .../test/integration/generated.g.dart | 963 +++++++++++ .../test/integration/scopes.dart | 2 +- .../test/integration/scopes.g.dart | 61 + .../test/integration/split.dart | 12 +- .../test/integration/split.g.dart | 111 ++ .../test/integration/split2.dart | 6 +- .../test/integration/stream.dart | 138 +- .../test/integration/stream.g.dart | 660 +++++++ .../test/integration/sync.dart | 353 ++-- .../test/integration/sync.g.dart | 1518 +++++++++++++++++ .../test/lints/provider_parameters.g.dart | 3 +- 32 files changed, 5340 insertions(+), 479 deletions(-) create mode 100644 packages/riverpod_generator/test/integration/dependencies.g.dart create mode 100644 packages/riverpod_generator/test/integration/dependencies2.g.dart create mode 100644 packages/riverpod_generator/test/integration/generated.freezed.dart create mode 100644 packages/riverpod_generator/test/integration/generated.g.dart create mode 100644 packages/riverpod_generator/test/integration/scopes.g.dart create mode 100644 packages/riverpod_generator/test/integration/split.g.dart create mode 100644 packages/riverpod_generator/test/integration/stream.g.dart create mode 100644 packages/riverpod_generator/test/integration/sync.g.dart diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 4d4a197c2..9da85eec9 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -813,7 +813,7 @@ final = Provider(dependencies: []); return requireState; } - /// Visit the [ProviderElement]s of providers that are listening to this element. + /// Visit the [$ProviderElement]s of providers that are listening to this element. /// /// A provider is considered as listening to this element if it either [watch] /// or [listen] this element. diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index 719416dd0..3c65bc63b 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -1,6 +1,6 @@ part of '../../framework.dart'; -/// An abstraction of both [ProviderContainer] and [ProviderElement] used by +/// An abstraction of both [ProviderContainer] and [$ProviderElement] used by /// [ProviderListenable]. @internal abstract class Node { diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 6d38954ee..131dfdebe 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -12,7 +12,7 @@ import 'stream_provider.dart' show StreamProvider; /// Implementation detail of `riverpod_generator`. /// Do not use, as this may be removed at any time. base mixin $FutureProvider on ProviderBase> { - FutureOr create(FutureProviderRef ref); + FutureOr create(RefT ref); } /// {@template riverpod.future_provider} diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 67103e359..831920a79 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -6,10 +6,17 @@ import '../framework.dart'; import 'legacy/state_notifier_provider.dart' show StateNotifierProvider; import 'stream_provider.dart' show StreamProvider; +/// Implementation detail of `riverpod_generator`. +/// Do not use, as this may be removed at any time. +base mixin $Provider on ProviderBase { + StateT create(RefT ref); +} + // TODO changelog ProviderRef was removed. Used Ref directly /// {@macro riverpod.provider} base class Provider - extends $FunctionalProvider> { + extends $FunctionalProvider> + with $Provider> { /// {@macro riverpod.provider} // TODO make all providers const under all variations Provider( @@ -60,10 +67,13 @@ base class Provider final Create> _create; @override - ProviderElement createElement( + StateT create(Ref ref) => _create(ref); + + @override + $ProviderElement createElement( ProviderContainer container, ) { - return ProviderElement(this, container); + return $ProviderElement(this, container); } @mustBeOverridden @@ -331,27 +341,26 @@ base class Provider /// when that provider is no longer listened to. /// - [Provider.family], to allow providers to create a value from external parameters. /// {@endtemplate} -class ProviderElement extends ProviderElementBase { +class $ProviderElement extends ProviderElementBase { /// A [ProviderElementBase] for [Provider] - @internal - ProviderElement(this.provider, super.container); + $ProviderElement(this.provider, super.container); @override - final Provider provider; + final $Provider> provider; @override - State get state => requireState; + StateT get state => requireState; @override - set state(State newState) => setStateResult(ResultData(newState)); + set state(StateT newState) => setStateResult(ResultData(newState)); @override void create({required bool didChangeDependency}) { - setStateResult(ResultData(provider._create(this))); + setStateResult(ResultData(provider.create(this))); } @override - bool updateShouldNotify(State previous, State next) { + bool updateShouldNotify(StateT previous, StateT next) { return previous != next; } } diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index 7a6a8fbef..569c02056 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -10,6 +10,12 @@ import '../framework.dart'; import 'future_provider.dart' show FutureProvider; import 'provider.dart' show Provider; +/// Implementation detail of `riverpod_generator`. +/// Do not use, as this may be removed at any time. +base mixin $StreamProvider on ProviderBase> { + Stream create(RefT ref); +} + /// {@template riverpod.stream_provider} /// Creates a stream and exposes its latest event. /// @@ -67,9 +73,10 @@ import 'provider.dart' show Provider; /// - [StreamProvider.autoDispose], to destroy the state of a [StreamProvider] when no longer needed. /// {@endtemplate} base class StreamProvider extends $FunctionalProvider< - AsyncValue, - Stream, - Ref>> with $FutureModifier { + AsyncValue, Stream, Ref>> + with + $FutureModifier, + $StreamProvider>> { /// {@macro riverpod.stream_provider} StreamProvider( this._create, { @@ -119,10 +126,13 @@ base class StreamProvider extends $FunctionalProvider< final Create, Ref>> _create; @override - StreamProviderElement createElement( + Stream create(Ref> ref) => _create(ref); + + @override + $StreamProviderElement createElement( ProviderContainer container, ) { - return StreamProviderElement(this, container); + return $StreamProviderElement(this, container); } @mustBeOverridden @@ -146,15 +156,14 @@ base class StreamProvider extends $FunctionalProvider< } /// The element of [StreamProvider]. -class StreamProviderElement +class $StreamProviderElement extends ProviderElementBase> with FutureModifierElement { /// The element of [StreamProvider]. - @internal - StreamProviderElement(this.provider, super.container); + $StreamProviderElement(this.provider, super.container); @override - final StreamProvider provider; + final $StreamProvider>> provider; final _streamNotifier = ProxyElementValueListenable>(); final StreamController _streamController = @@ -166,7 +175,7 @@ class StreamProviderElement _streamNotifier.result ??= Result.data(_streamController.stream); handleStream( - () => provider._create(this), + () => provider.create(this), didChangeDependency: didChangeDependency, ); } diff --git a/packages/riverpod/test/new/core/scope_test.dart b/packages/riverpod/test/new/core/scope_test.dart index 2b8e7618c..6f8b8a619 100644 --- a/packages/riverpod/test/new/core/scope_test.dart +++ b/packages/riverpod/test/new/core/scope_test.dart @@ -163,7 +163,7 @@ Future main() async { expect(child.read(provider), 0); expect(child.getAllProviderElements(), [ - isA>() + isA<$ProviderElement>() .having((e) => e.provider, 'provider', provider), ]); expect(container.getAllProviderElements(), isEmpty); @@ -293,7 +293,7 @@ Future main() async { expect(child.read(provider(0)), 0); expect(child.getAllProviderElements(), [ - isA>() + isA<$ProviderElement>() .having((e) => e.provider, 'provider', provider(0)), ]); expect(container.getAllProviderElements(), isEmpty); diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 19466e6f9..bd0777ee8 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -191,7 +191,7 @@ void main() { expect( child.getAllProviderElements().single, - isA>() + isA<$ProviderElement>() .having((e) => e.origin, 'origin', scopedProvider), ); }); @@ -214,7 +214,7 @@ void main() { expect( child.getAllProviderElements().single, - isA>() + isA<$ProviderElement>() .having((e) => e.origin, 'origin', scopedProvider), ); }); @@ -247,17 +247,17 @@ void main() { expect( root.getAllProviderElements().single, - isA>() + isA<$ProviderElement>() .having((e) => e.provider, 'provider', provider), ); expect( mid.getAllProviderElements().single, - isA>() + isA<$ProviderElement>() .having((e) => e.provider, 'provider', provider2), ); expect( leaf.getAllProviderElements().single, - isA>() + isA<$ProviderElement>() .having((e) => e.provider, 'provider', provider3), ); }); @@ -308,7 +308,7 @@ void main() { expect( child.getAllProviderElementsInOrder().single, - isA>() + isA<$ProviderElement>() .having((e) => e.origin, 'origin', scopedProvider), ); }); @@ -331,7 +331,7 @@ void main() { expect( child.getAllProviderElementsInOrder().single, - isA>() + isA<$ProviderElement>() .having((e) => e.origin, 'origin', scopedProvider), ); }); diff --git a/packages/riverpod/test/old/legacy/framework2/framework_test.dart b/packages/riverpod/test/old/legacy/framework2/framework_test.dart index 7eebb51cd..d9cdd3f81 100644 --- a/packages/riverpod/test/old/legacy/framework2/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework2/framework_test.dart @@ -287,7 +287,7 @@ void main() { ); expect(firstDependents, [computedElement]); expect(firstElement.hasListeners, true); - expect(secondDependents, >[]); + expect(secondDependents, <$ProviderElement>[]); expect(secondElement.hasListeners, false); }); @@ -337,7 +337,7 @@ void main() { elementVisitor: firstDependents.add, listenableVisitor: (_) {}, ); - expect(firstDependents, >{}); + expect(firstDependents, <$ProviderElement>{}); expect(firstElement.hasListeners, false); }); diff --git a/packages/riverpod/test/old/legacy/framework_test.dart b/packages/riverpod/test/old/legacy/framework_test.dart index 6527f924d..485b032aa 100644 --- a/packages/riverpod/test/old/legacy/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework_test.dart @@ -259,9 +259,9 @@ void main() { test('Ref is unusable after dispose (read/onDispose)', () { final container = ProviderContainer.test(); - late ProviderElement ref; + late $ProviderElement ref; final provider = Provider((s) { - ref = s as ProviderElement; + ref = s as $ProviderElement; return 42; }); final other = Provider((_) => 42); diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart index 73543215d..6360304ea 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart @@ -68,7 +68,7 @@ void main() { ); final element = - container.readProviderElement(provider) as ProviderElement; + container.readProviderElement(provider) as $ProviderElement; expect( () => element.state, diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index 0a72aaed0..5ac6e6d2f 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -21,22 +21,18 @@ export 'package:riverpod/src/internals.dart' Ref, // Provider - Provider, - ProviderFamily, - ProviderElement, + $Provider, + $ProviderElement, // FutureProvider $FutureProvider, - // FutureProviderFamily, - // FutureProviderRef, $FutureProviderElement, -// // StreamProvider -// StreamProvider, -// StreamProviderFamily, -// StreamProviderElement, + // StreamProvider + $StreamProvider, + $StreamProviderElement, -// AsyncValue + // AsyncValue AsyncValue, AsyncLoading, AsyncData, diff --git a/packages/riverpod_generator/lib/src/templates/class_based_provider.dart b/packages/riverpod_generator/lib/src/templates/class_based_provider.dart index cd863978d..b33ce5aba 100644 --- a/packages/riverpod_generator/lib/src/templates/class_based_provider.dart +++ b/packages/riverpod_generator/lib/src/templates/class_based_provider.dart @@ -18,23 +18,14 @@ String serializeDependencies( if (dependencies == null) return 'null'; final buffer = StringBuffer('const '); - // Use list vs set based on the number of dependencies to optimize "contains" call - if (dependencies.length < 4) { - buffer.write('['); - } else { - buffer.write('{'); - } + buffer.write('['); buffer.writeAll( dependencies.map((e) => providerNameFor(e, options)), ',', ); - if (dependencies.length < 4) { - buffer.write(']'); - } else { - buffer.write('}'); - } + buffer.write(']'); return buffer.toString(); } @@ -51,14 +42,14 @@ String serializeAllTransitiveDependencies( final buffer = StringBuffer('const '); - buffer.write('{'); + buffer.write('['); buffer.writeAll( dependencies .map((e) => providerNameFor(e, options)) .map((e) => '$e, ...?$e.allTransitiveDependencies'), ',', ); - buffer.write('}'); + buffer.write(']'); return buffer.toString(); } diff --git a/packages/riverpod_generator/lib/src/templates/notifier.dart b/packages/riverpod_generator/lib/src/templates/notifier.dart index ac62fc8f7..a3bd74ca4 100644 --- a/packages/riverpod_generator/lib/src/templates/notifier.dart +++ b/packages/riverpod_generator/lib/src/templates/notifier.dart @@ -23,7 +23,7 @@ class NotifierTemplate extends Template { SupportedCreatedType.stream => '\$StreamNotifier<${provider.valueTypeDisplayString}>', SupportedCreatedType.value => - '\$cNotifier<${provider.valueTypeDisplayString}>', + '\$Notifier<${provider.valueTypeDisplayString}>', }; final argumentRecordType = buildParamDefinitionQuery( diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index bd24216ff..5b605a5d5 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -51,7 +51,7 @@ class ProviderTemplate extends Template { '\$StreamProvider<$valueType, $_refType>', ]; case SupportedCreatedType.value: - modifiers = []; + modifiers = ['\$Provider<$valueType, $_refType>']; } final mixins = modifiers.isEmpty ? '' : ' with ${modifiers.join(', ')}'; diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 02bb98dc8..5649fd839 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -11,7 +11,8 @@ typedef KeepAliveRef = Ref; const keepAliveProvider = KeepAliveProvider._(); final class KeepAliveProvider - extends $FunctionalProvider { + extends $FunctionalProvider + with $Provider { const KeepAliveProvider._( {int Function( KeepAliveRef ref, @@ -61,7 +62,8 @@ typedef NotKeepAliveRef = Ref; const notKeepAliveProvider = NotKeepAliveProvider._(); final class NotKeepAliveProvider - extends $FunctionalProvider { + extends $FunctionalProvider + with $Provider { const NotKeepAliveProvider._( {int Function( NotKeepAliveRef ref, diff --git a/packages/riverpod_generator/test/integration/dependencies.dart b/packages/riverpod_generator/test/integration/dependencies.dart index 7e13a9c45..b90e3d13e 100644 --- a/packages/riverpod_generator/test/integration/dependencies.dart +++ b/packages/riverpod_generator/test/integration/dependencies.dart @@ -1,65 +1,65 @@ -// import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; -// // part 'dependencies.g.dart'; +part 'dependencies.g.dart'; -// @riverpod -// int dep(DepRef ref) => 0; +@riverpod +int dep(DepRef ref) => 0; -// @riverpod -// int family(DepRef ref, int id) => 0; +@riverpod +int family(DepRef ref, int id) => 0; -// @riverpod -// class Dep2 extends _$Dep2 { -// @override -// int build() => 0; -// } +@riverpod +class Dep2 extends _$Dep2 { + @override + int build() => 0; +} -// @riverpod -// class Family2 extends _$Family2 { -// @override -// int build(int id) => 0; -// } +@riverpod +class Family2 extends _$Family2 { + @override + int build(int id) => 0; +} -// @Riverpod(dependencies: [dep, family, Dep2, Family2]) -// int provider(ProviderRef ref) => 0; +@Riverpod(dependencies: [dep, family, Dep2, Family2]) +int provider(ProviderRef ref) => 0; -// @Riverpod(dependencies: [dep, family, Dep2, Family2]) -// int provider2(Provider2Ref ref) => 0; +@Riverpod(dependencies: [dep, family, Dep2, Family2]) +int provider2(Provider2Ref ref) => 0; -// @Riverpod(dependencies: [dep, family, Dep2, Family2]) -// class Provider3 extends _$Provider3 { -// @override -// int build() => 0; -// } +@Riverpod(dependencies: [dep, family, Dep2, Family2]) +class Provider3 extends _$Provider3 { + @override + int build() => 0; +} -// @Riverpod(dependencies: [dep, family, Dep2, Family2]) -// class Provider4 extends _$Provider4 { -// @override -// int build(int id) => 0; -// } +@Riverpod(dependencies: [dep, family, Dep2, Family2]) +class Provider4 extends _$Provider4 { + @override + int build(int id) => 0; +} -// @Riverpod(dependencies: [provider]) -// int transitiveDependencies(TransitiveDependenciesRef ref) => 0; +@Riverpod(dependencies: [provider]) +int transitiveDependencies(TransitiveDependenciesRef ref) => 0; -// @Riverpod(dependencies: [dep, family, Dep2]) -// int smallTransitiveDependencyCount(SmallTransitiveDependencyCountRef ref) => 0; +@Riverpod(dependencies: [dep, family, Dep2]) +int smallTransitiveDependencyCount(SmallTransitiveDependencyCountRef ref) => 0; -// @Riverpod(dependencies: []) -// int emptyDependenciesFunctional(EmptyDependenciesFunctionalRef ref) => 0; +@Riverpod(dependencies: []) +int emptyDependenciesFunctional(EmptyDependenciesFunctionalRef ref) => 0; -// @Riverpod(dependencies: []) -// class EmptyDependenciesClassBased extends _$EmptyDependenciesClassBased { -// @override -// int build() => 0; -// } +@Riverpod(dependencies: []) +class EmptyDependenciesClassBased extends _$EmptyDependenciesClassBased { + @override + int build() => 0; +} -// @Riverpod(dependencies: [_privateDep, publicDep]) -// int providerWithDependencies(ProviderWithDependenciesRef ref) { -// return 0; -// } +@Riverpod(dependencies: [_privateDep, publicDep]) +int providerWithDependencies(ProviderWithDependenciesRef ref) { + return 0; +} -// @riverpod -// int _privateDep(_PrivateDepRef ref) => 0; +@riverpod +int _privateDep(_PrivateDepRef ref) => 0; -// @riverpod -// int publicDep(PublicDepRef ref) => 0; +@riverpod +int publicDep(PublicDepRef ref) => 0; diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart new file mode 100644 index 000000000..e2ec7cf69 --- /dev/null +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -0,0 +1,995 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'dependencies.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef DepRef = Ref; + +const depProvider = DepProvider._(); + +final class DepProvider extends $FunctionalProvider + with $Provider { + const DepProvider._( + {int Function( + DepRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$depHash, + name: r'dep', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + DepRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(DepRef ref) { + final fn = _createCb ?? dep; + + return fn( + ref, + ); + } + + @override + DepProvider copyWithCreate( + int Function( + DepRef ref, + ) create, + ) { + return DepProvider._(create: create); + } +} + +String _$depHash() => r'2213a401e03a1a914579b4a3a7707b783de9efba'; + +typedef FamilyRef = Ref; + +const familyProvider = FamilyFamily._(); + +final class FamilyProvider extends $FunctionalProvider + with $Provider { + const FamilyProvider._( + {required FamilyFamily super.from, + required (int,) super.argument, + int Function( + FamilyRef ref, + int id, + )? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$familyHash, + name: r'family', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + FamilyRef ref, + int id, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(FamilyRef ref) { + final fn = _createCb ?? family; + final (int,) argument = this.argument! as (int,); + return fn( + ref, + argument.$1, + ); + } + + @override + FamilyProvider copyWithCreate( + int Function( + FamilyRef ref, + ) create, + ) { + return FamilyProvider._( + argument: argument! as (int,), + from: from! as FamilyFamily, + create: ( + ref, + int id, + ) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is FamilyProvider && other.argument == argument; + } +} + +String _$familyHash() => r'8c228ff14b8c6cf1f3d4d6266232d64b5057c440'; + +final class FamilyFamily extends Family { + const FamilyFamily._() + : super( + name: r'family', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$familyHash, + isAutoDispose: true, + ); + + FamilyProvider call( + int id, + ) => + FamilyProvider._(argument: (id,), from: this); + + @override + String toString() => r'family'; +} + +typedef ProviderRef = Ref; + +const providerProvider = ProviderProvider._(); + +final class ProviderProvider extends $FunctionalProvider + with $Provider { + const ProviderProvider._( + {int Function( + ProviderRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$providerHash, + name: r'provider', + isAutoDispose: true, + dependencies: const [ + depProvider, + familyProvider, + dep2Provider, + family2Provider + ], + allTransitiveDependencies: const [ + depProvider, + ...?depProvider.allTransitiveDependencies, + familyProvider, + ...?familyProvider.allTransitiveDependencies, + dep2Provider, + ...?dep2Provider.allTransitiveDependencies, + family2Provider, + ...?family2Provider.allTransitiveDependencies + ], + ); + + final int Function( + ProviderRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(ProviderRef ref) { + final fn = _createCb ?? provider; + + return fn( + ref, + ); + } + + @override + ProviderProvider copyWithCreate( + int Function( + ProviderRef ref, + ) create, + ) { + return ProviderProvider._(create: create); + } +} + +String _$providerHash() => r'6c9184ef4c6a410a2132e1ecc13a2e646e936d37'; + +typedef Provider2Ref = Ref; + +const provider2Provider = Provider2Provider._(); + +final class Provider2Provider + extends $FunctionalProvider + with $Provider { + const Provider2Provider._( + {int Function( + Provider2Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$provider2Hash, + name: r'provider2', + isAutoDispose: true, + dependencies: const [ + depProvider, + familyProvider, + dep2Provider, + family2Provider + ], + allTransitiveDependencies: const [ + depProvider, + ...?depProvider.allTransitiveDependencies, + familyProvider, + ...?familyProvider.allTransitiveDependencies, + dep2Provider, + ...?dep2Provider.allTransitiveDependencies, + family2Provider, + ...?family2Provider.allTransitiveDependencies + ], + ); + + final int Function( + Provider2Ref ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(Provider2Ref ref) { + final fn = _createCb ?? provider2; + + return fn( + ref, + ); + } + + @override + Provider2Provider copyWithCreate( + int Function( + Provider2Ref ref, + ) create, + ) { + return Provider2Provider._(create: create); + } +} + +String _$provider2Hash() => r'70d908579c5e64ce6558b42f433adfb80f4dc79b'; + +typedef TransitiveDependenciesRef = Ref; + +const transitiveDependenciesProvider = TransitiveDependenciesProvider._(); + +final class TransitiveDependenciesProvider + extends $FunctionalProvider + with $Provider { + const TransitiveDependenciesProvider._( + {int Function( + TransitiveDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$transitiveDependenciesHash, + name: r'transitiveDependencies', + isAutoDispose: true, + dependencies: const [providerProvider], + allTransitiveDependencies: const [ + providerProvider, + ...?providerProvider.allTransitiveDependencies + ], + ); + + final int Function( + TransitiveDependenciesRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(TransitiveDependenciesRef ref) { + final fn = _createCb ?? transitiveDependencies; + + return fn( + ref, + ); + } + + @override + TransitiveDependenciesProvider copyWithCreate( + int Function( + TransitiveDependenciesRef ref, + ) create, + ) { + return TransitiveDependenciesProvider._(create: create); + } +} + +String _$transitiveDependenciesHash() => + r'9c81823224bb28a5dc482328c04ce76293370877'; + +typedef SmallTransitiveDependencyCountRef = Ref; + +const smallTransitiveDependencyCountProvider = + SmallTransitiveDependencyCountProvider._(); + +final class SmallTransitiveDependencyCountProvider + extends $FunctionalProvider + with $Provider { + const SmallTransitiveDependencyCountProvider._( + {int Function( + SmallTransitiveDependencyCountRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$smallTransitiveDependencyCountHash, + name: r'smallTransitiveDependencyCount', + isAutoDispose: true, + dependencies: const [ + depProvider, + familyProvider, + dep2Provider + ], + allTransitiveDependencies: const [ + depProvider, + ...?depProvider.allTransitiveDependencies, + familyProvider, + ...?familyProvider.allTransitiveDependencies, + dep2Provider, + ...?dep2Provider.allTransitiveDependencies + ], + ); + + final int Function( + SmallTransitiveDependencyCountRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(SmallTransitiveDependencyCountRef ref) { + final fn = _createCb ?? smallTransitiveDependencyCount; + + return fn( + ref, + ); + } + + @override + SmallTransitiveDependencyCountProvider copyWithCreate( + int Function( + SmallTransitiveDependencyCountRef ref, + ) create, + ) { + return SmallTransitiveDependencyCountProvider._(create: create); + } +} + +String _$smallTransitiveDependencyCountHash() => + r'34689e1ba57e2959975cbf8ebd6c9483f4652a73'; + +typedef EmptyDependenciesFunctionalRef = Ref; + +const emptyDependenciesFunctionalProvider = + EmptyDependenciesFunctionalProvider._(); + +final class EmptyDependenciesFunctionalProvider + extends $FunctionalProvider + with $Provider { + const EmptyDependenciesFunctionalProvider._( + {int Function( + EmptyDependenciesFunctionalRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$emptyDependenciesFunctionalHash, + name: r'emptyDependenciesFunctional', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + EmptyDependenciesFunctionalRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(EmptyDependenciesFunctionalRef ref) { + final fn = _createCb ?? emptyDependenciesFunctional; + + return fn( + ref, + ); + } + + @override + EmptyDependenciesFunctionalProvider copyWithCreate( + int Function( + EmptyDependenciesFunctionalRef ref, + ) create, + ) { + return EmptyDependenciesFunctionalProvider._(create: create); + } +} + +String _$emptyDependenciesFunctionalHash() => + r'592bebd079450e2071fb12d68c3ae333d5c28359'; + +typedef ProviderWithDependenciesRef = Ref; + +const providerWithDependenciesProvider = ProviderWithDependenciesProvider._(); + +final class ProviderWithDependenciesProvider + extends $FunctionalProvider + with $Provider { + const ProviderWithDependenciesProvider._( + {int Function( + ProviderWithDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$providerWithDependenciesHash, + name: r'providerWithDependencies', + isAutoDispose: true, + dependencies: const [ + _privateDepProvider, + publicDepProvider + ], + allTransitiveDependencies: const [ + _privateDepProvider, + ...?_privateDepProvider.allTransitiveDependencies, + publicDepProvider, + ...?publicDepProvider.allTransitiveDependencies + ], + ); + + final int Function( + ProviderWithDependenciesRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(ProviderWithDependenciesRef ref) { + final fn = _createCb ?? providerWithDependencies; + + return fn( + ref, + ); + } + + @override + ProviderWithDependenciesProvider copyWithCreate( + int Function( + ProviderWithDependenciesRef ref, + ) create, + ) { + return ProviderWithDependenciesProvider._(create: create); + } +} + +String _$providerWithDependenciesHash() => + r'beecbe7a41b647ab92367dbcc12055bcd6345af7'; + +typedef _PrivateDepRef = Ref; + +const _privateDepProvider = _PrivateDepProvider._(); + +final class _PrivateDepProvider + extends $FunctionalProvider + with $Provider { + const _PrivateDepProvider._( + {int Function( + _PrivateDepRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$privateDepHash, + name: r'_privateDep', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + _PrivateDepRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(_PrivateDepRef ref) { + final fn = _createCb ?? _privateDep; + + return fn( + ref, + ); + } + + @override + _PrivateDepProvider copyWithCreate( + int Function( + _PrivateDepRef ref, + ) create, + ) { + return _PrivateDepProvider._(create: create); + } +} + +String _$privateDepHash() => r'f610d91bd39e0dcffe6ff4e74160964a291289d9'; + +typedef PublicDepRef = Ref; + +const publicDepProvider = PublicDepProvider._(); + +final class PublicDepProvider + extends $FunctionalProvider + with $Provider { + const PublicDepProvider._( + {int Function( + PublicDepRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$publicDepHash, + name: r'publicDep', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + PublicDepRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(PublicDepRef ref) { + final fn = _createCb ?? publicDep; + + return fn( + ref, + ); + } + + @override + PublicDepProvider copyWithCreate( + int Function( + PublicDepRef ref, + ) create, + ) { + return PublicDepProvider._(create: create); + } +} + +String _$publicDepHash() => r'bcb69aace017c86c3c4b8eccf59fa22d010834bc'; + +const dep2Provider = Dep2Provider._(); + +final class Dep2Provider extends $NotifierProvider { + const Dep2Provider._( + {super.runNotifierBuildOverride, Dep2 Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$dep2Hash, + name: r'Dep2', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Dep2 Function()? _createCb; + + @$internal + @override + Dep2 create() => _createCb?.call() ?? Dep2(); + + @$internal + @override + Dep2Provider copyWithCreate( + Dep2 Function() create, + ) { + return Dep2Provider._(create: create); + } + + @$internal + @override + Dep2Provider copyWithBuild( + int Function(Ref, Dep2) build, + ) { + return Dep2Provider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$dep2Hash() => r'2778537df77f6431148c2ce400724da3e2ab4b94'; + +abstract class _$Dep2 extends $Notifier { + int build(); + + @$internal + @override + int runBuild() => build(); +} + +const family2Provider = Family2Family._(); + +final class Family2Provider extends $NotifierProvider { + const Family2Provider._( + {required Family2Family super.from, + required (int,) super.argument, + super.runNotifierBuildOverride, + Family2 Function()? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$family2Hash, + name: r'Family2', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Family2 Function()? _createCb; + + @$internal + @override + Family2 create() => _createCb?.call() ?? Family2(); + + @$internal + @override + Family2Provider copyWithCreate( + Family2 Function() create, + ) { + return Family2Provider._( + argument: argument! as (int,), + from: from! as Family2Family, + create: create); + } + + @$internal + @override + Family2Provider copyWithBuild( + int Function(Ref, Family2) build, + ) { + return Family2Provider._( + argument: argument! as (int,), + from: from! as Family2Family, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is Family2Provider && other.argument == argument; + } +} + +String _$family2Hash() => r'ce727b262aae067b0d4f703f03670abb70ad8977'; + +final class Family2Family extends Family { + const Family2Family._() + : super( + name: r'Family2', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$family2Hash, + isAutoDispose: true, + ); + + Family2Provider call( + int id, + ) => + Family2Provider._(argument: (id,), from: this); + + @override + String toString() => r'Family2'; +} + +abstract class _$Family2 extends $Notifier { + late final _$args = + (ref as $NotifierProviderElement).origin.argument as (int,); + int get id => _$args.$1; + + int build( + int id, + ); + + @$internal + @override + int runBuild() => build( + _$args.$1, + ); +} + +const provider3Provider = Provider3Provider._(); + +final class Provider3Provider extends $NotifierProvider { + const Provider3Provider._( + {super.runNotifierBuildOverride, Provider3 Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$provider3Hash, + name: r'Provider3', + isAutoDispose: true, + dependencies: const [ + depProvider, + familyProvider, + dep2Provider, + family2Provider + ], + allTransitiveDependencies: const [ + depProvider, + ...?depProvider.allTransitiveDependencies, + familyProvider, + ...?familyProvider.allTransitiveDependencies, + dep2Provider, + ...?dep2Provider.allTransitiveDependencies, + family2Provider, + ...?family2Provider.allTransitiveDependencies + ], + ); + + final Provider3 Function()? _createCb; + + @$internal + @override + Provider3 create() => _createCb?.call() ?? Provider3(); + + @$internal + @override + Provider3Provider copyWithCreate( + Provider3 Function() create, + ) { + return Provider3Provider._(create: create); + } + + @$internal + @override + Provider3Provider copyWithBuild( + int Function(Ref, Provider3) build, + ) { + return Provider3Provider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$provider3Hash() => r'dfdd6dec6cfee543c73d99593ce98d68f4db385c'; + +abstract class _$Provider3 extends $Notifier { + int build(); + + @$internal + @override + int runBuild() => build(); +} + +const provider4Provider = Provider4Family._(); + +final class Provider4Provider extends $NotifierProvider { + const Provider4Provider._( + {required Provider4Family super.from, + required (int,) super.argument, + super.runNotifierBuildOverride, + Provider4 Function()? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$provider4Hash, + name: r'Provider4', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Provider4 Function()? _createCb; + + @$internal + @override + Provider4 create() => _createCb?.call() ?? Provider4(); + + @$internal + @override + Provider4Provider copyWithCreate( + Provider4 Function() create, + ) { + return Provider4Provider._( + argument: argument! as (int,), + from: from! as Provider4Family, + create: create); + } + + @$internal + @override + Provider4Provider copyWithBuild( + int Function(Ref, Provider4) build, + ) { + return Provider4Provider._( + argument: argument! as (int,), + from: from! as Provider4Family, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is Provider4Provider && other.argument == argument; + } +} + +String _$provider4Hash() => r'1c955214d99695bb694c96374b277aac58e734df'; + +final class Provider4Family extends Family { + const Provider4Family._() + : super( + name: r'Provider4', + dependencies: const [ + depProvider, + familyProvider, + dep2Provider, + family2Provider + ], + allTransitiveDependencies: const [ + depProvider, + ...?depProvider.allTransitiveDependencies, + familyProvider, + ...?familyProvider.allTransitiveDependencies, + dep2Provider, + ...?dep2Provider.allTransitiveDependencies, + family2Provider, + ...?family2Provider.allTransitiveDependencies + ], + debugGetCreateSourceHash: _$provider4Hash, + isAutoDispose: true, + ); + + Provider4Provider call( + int id, + ) => + Provider4Provider._(argument: (id,), from: this); + + @override + String toString() => r'Provider4'; +} + +abstract class _$Provider4 extends $Notifier { + late final _$args = + (ref as $NotifierProviderElement).origin.argument as (int,); + int get id => _$args.$1; + + int build( + int id, + ); + + @$internal + @override + int runBuild() => build( + _$args.$1, + ); +} + +const emptyDependenciesClassBasedProvider = + EmptyDependenciesClassBasedProvider._(); + +final class EmptyDependenciesClassBasedProvider + extends $NotifierProvider { + const EmptyDependenciesClassBasedProvider._( + {super.runNotifierBuildOverride, + EmptyDependenciesClassBased Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$emptyDependenciesClassBasedHash, + name: r'EmptyDependenciesClassBased', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final EmptyDependenciesClassBased Function()? _createCb; + + @$internal + @override + EmptyDependenciesClassBased create() => + _createCb?.call() ?? EmptyDependenciesClassBased(); + + @$internal + @override + EmptyDependenciesClassBasedProvider copyWithCreate( + EmptyDependenciesClassBased Function() create, + ) { + return EmptyDependenciesClassBasedProvider._(create: create); + } + + @$internal + @override + EmptyDependenciesClassBasedProvider copyWithBuild( + int Function(Ref, EmptyDependenciesClassBased) build, + ) { + return EmptyDependenciesClassBasedProvider._( + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$emptyDependenciesClassBasedHash() => + r'e20c18353984a81977b656e9879b3841dbaedc6c'; + +abstract class _$EmptyDependenciesClassBased extends $Notifier { + int build(); + + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/dependencies2.dart b/packages/riverpod_generator/test/integration/dependencies2.dart index 7f195b67d..59c79f9b4 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.dart @@ -1,34 +1,34 @@ -// import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; -// import 'dependencies.dart'; +import 'dependencies.dart'; -// part 'dependencies2.g.dart'; +part 'dependencies2.g.dart'; -// // Regression test for https://github.com/rrousselGit/riverpod/issues/2490 -// @Riverpod(dependencies: [providerWithDependencies, _private2, public2]) -// int providerWithDependencies2(ProviderWithDependencies2Ref ref) { -// return 0; -// } +// Regression test for https://github.com/rrousselGit/riverpod/issues/2490 +@Riverpod(dependencies: [providerWithDependencies, _private2, public2]) +int providerWithDependencies2(ProviderWithDependencies2Ref ref) { + return 0; +} -// @Riverpod(dependencies: [providerWithDependencies, _private2, public2]) -// int familyWithDependencies2(ProviderWithDependencies2Ref ref, {int? id}) { -// return 0; -// } +@Riverpod(dependencies: [providerWithDependencies, _private2, public2]) +int familyWithDependencies2(ProviderWithDependencies2Ref ref, {int? id}) { + return 0; +} -// @Riverpod(dependencies: [providerWithDependencies, _private2, public2]) -// class NotifierWithDependencies extends _$NotifierWithDependencies { -// @override -// int build() => 0; -// } +@Riverpod(dependencies: [providerWithDependencies, _private2, public2]) +class NotifierWithDependencies extends _$NotifierWithDependencies { + @override + int build() => 0; +} -// @Riverpod(dependencies: [providerWithDependencies, _private2, public2]) -// class NotifierFamilyWithDependencies extends _$NotifierFamilyWithDependencies { -// @override -// int build({int? id}) => 0; -// } +@Riverpod(dependencies: [providerWithDependencies, _private2, public2]) +class NotifierFamilyWithDependencies extends _$NotifierFamilyWithDependencies { + @override + int build({int? id}) => 0; +} -// @riverpod -// int _private2(_Private2Ref ref) => 0; +@riverpod +int _private2(_Private2Ref ref) => 0; -// @riverpod -// int public2(Public2Ref ref) => 0; +@riverpod +int public2(Public2Ref ref) => 0; diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart new file mode 100644 index 000000000..defa37d2d --- /dev/null +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -0,0 +1,470 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'dependencies2.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ProviderWithDependencies2Ref = Ref; + +const providerWithDependencies2Provider = ProviderWithDependencies2Provider._(); + +final class ProviderWithDependencies2Provider + extends $FunctionalProvider + with $Provider { + const ProviderWithDependencies2Provider._( + {int Function( + ProviderWithDependencies2Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$providerWithDependencies2Hash, + name: r'providerWithDependencies2', + isAutoDispose: true, + dependencies: const [ + providerWithDependenciesProvider, + _private2Provider, + public2Provider + ], + allTransitiveDependencies: const [ + providerWithDependenciesProvider, + ...?providerWithDependenciesProvider.allTransitiveDependencies, + _private2Provider, + ...?_private2Provider.allTransitiveDependencies, + public2Provider, + ...?public2Provider.allTransitiveDependencies + ], + ); + + final int Function( + ProviderWithDependencies2Ref ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(ProviderWithDependencies2Ref ref) { + final fn = _createCb ?? providerWithDependencies2; + + return fn( + ref, + ); + } + + @override + ProviderWithDependencies2Provider copyWithCreate( + int Function( + ProviderWithDependencies2Ref ref, + ) create, + ) { + return ProviderWithDependencies2Provider._(create: create); + } +} + +String _$providerWithDependencies2Hash() => + r'90e090d5fa759369dceb59b2d2e219f67ed5f9e0'; + +typedef FamilyWithDependencies2Ref = Ref; + +const familyWithDependencies2Provider = FamilyWithDependencies2Family._(); + +final class FamilyWithDependencies2Provider + extends $FunctionalProvider + with $Provider { + const FamilyWithDependencies2Provider._( + {required FamilyWithDependencies2Family super.from, + required ({ + int? id, + }) + super.argument, + int Function( + FamilyWithDependencies2Ref ref, { + int? id, + })? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$familyWithDependencies2Hash, + name: r'familyWithDependencies2', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + FamilyWithDependencies2Ref ref, { + int? id, + })? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(FamilyWithDependencies2Ref ref) { + final fn = _createCb ?? familyWithDependencies2; + final ({ + int? id, + }) argument = this.argument! as ({ + int? id, + }); + return fn( + ref, + id: argument.id, + ); + } + + @override + FamilyWithDependencies2Provider copyWithCreate( + int Function( + FamilyWithDependencies2Ref ref, + ) create, + ) { + return FamilyWithDependencies2Provider._( + argument: argument! as ({ + int? id, + }), + from: from! as FamilyWithDependencies2Family, + create: ( + ref, { + int? id, + }) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is FamilyWithDependencies2Provider && + other.argument == argument; + } +} + +String _$familyWithDependencies2Hash() => + r'209b9e3ed4e5fad89572268d161fbe64a6ef0e87'; + +final class FamilyWithDependencies2Family extends Family { + const FamilyWithDependencies2Family._() + : super( + name: r'familyWithDependencies2', + dependencies: const [ + providerWithDependenciesProvider, + _private2Provider, + public2Provider + ], + allTransitiveDependencies: const [ + providerWithDependenciesProvider, + ...?providerWithDependenciesProvider.allTransitiveDependencies, + _private2Provider, + ...?_private2Provider.allTransitiveDependencies, + public2Provider, + ...?public2Provider.allTransitiveDependencies + ], + debugGetCreateSourceHash: _$familyWithDependencies2Hash, + isAutoDispose: true, + ); + + FamilyWithDependencies2Provider call({ + int? id, + }) => + FamilyWithDependencies2Provider._(argument: (id: id,), from: this); + + @override + String toString() => r'familyWithDependencies2'; +} + +typedef _Private2Ref = Ref; + +const _private2Provider = _Private2Provider._(); + +final class _Private2Provider + extends $FunctionalProvider + with $Provider { + const _Private2Provider._( + {int Function( + _Private2Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$private2Hash, + name: r'_private2', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + _Private2Ref ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(_Private2Ref ref) { + final fn = _createCb ?? _private2; + + return fn( + ref, + ); + } + + @override + _Private2Provider copyWithCreate( + int Function( + _Private2Ref ref, + ) create, + ) { + return _Private2Provider._(create: create); + } +} + +String _$private2Hash() => r'5e0fa14ff40fb444c027ed25150a42362db3ef19'; + +typedef Public2Ref = Ref; + +const public2Provider = Public2Provider._(); + +final class Public2Provider extends $FunctionalProvider + with $Provider { + const Public2Provider._( + {int Function( + Public2Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$public2Hash, + name: r'public2', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + Public2Ref ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(Public2Ref ref) { + final fn = _createCb ?? public2; + + return fn( + ref, + ); + } + + @override + Public2Provider copyWithCreate( + int Function( + Public2Ref ref, + ) create, + ) { + return Public2Provider._(create: create); + } +} + +String _$public2Hash() => r'9767255f0182589fe48b29d217dd488b0a13b9d5'; + +const notifierWithDependenciesProvider = NotifierWithDependenciesProvider._(); + +final class NotifierWithDependenciesProvider + extends $NotifierProvider { + const NotifierWithDependenciesProvider._( + {super.runNotifierBuildOverride, + NotifierWithDependencies Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$notifierWithDependenciesHash, + name: r'NotifierWithDependencies', + isAutoDispose: true, + dependencies: const [ + providerWithDependenciesProvider, + _private2Provider, + public2Provider + ], + allTransitiveDependencies: const [ + providerWithDependenciesProvider, + ...?providerWithDependenciesProvider.allTransitiveDependencies, + _private2Provider, + ...?_private2Provider.allTransitiveDependencies, + public2Provider, + ...?public2Provider.allTransitiveDependencies + ], + ); + + final NotifierWithDependencies Function()? _createCb; + + @$internal + @override + NotifierWithDependencies create() => + _createCb?.call() ?? NotifierWithDependencies(); + + @$internal + @override + NotifierWithDependenciesProvider copyWithCreate( + NotifierWithDependencies Function() create, + ) { + return NotifierWithDependenciesProvider._(create: create); + } + + @$internal + @override + NotifierWithDependenciesProvider copyWithBuild( + int Function(Ref, NotifierWithDependencies) build, + ) { + return NotifierWithDependenciesProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$notifierWithDependenciesHash() => + r'becc68e5a54b0cc2b8277a6d54b74edef93bfe89'; + +abstract class _$NotifierWithDependencies extends $Notifier { + int build(); + + @$internal + @override + int runBuild() => build(); +} + +const notifierFamilyWithDependenciesProvider = + NotifierFamilyWithDependenciesFamily._(); + +final class NotifierFamilyWithDependenciesProvider + extends $NotifierProvider { + const NotifierFamilyWithDependenciesProvider._( + {required NotifierFamilyWithDependenciesFamily super.from, + required ({ + int? id, + }) + super.argument, + super.runNotifierBuildOverride, + NotifierFamilyWithDependencies Function()? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$notifierFamilyWithDependenciesHash, + name: r'NotifierFamilyWithDependencies', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final NotifierFamilyWithDependencies Function()? _createCb; + + @$internal + @override + NotifierFamilyWithDependencies create() => + _createCb?.call() ?? NotifierFamilyWithDependencies(); + + @$internal + @override + NotifierFamilyWithDependenciesProvider copyWithCreate( + NotifierFamilyWithDependencies Function() create, + ) { + return NotifierFamilyWithDependenciesProvider._( + argument: argument! as ({ + int? id, + }), + from: from! as NotifierFamilyWithDependenciesFamily, + create: create); + } + + @$internal + @override + NotifierFamilyWithDependenciesProvider copyWithBuild( + int Function(Ref, NotifierFamilyWithDependencies) build, + ) { + return NotifierFamilyWithDependenciesProvider._( + argument: argument! as ({ + int? id, + }), + from: from! as NotifierFamilyWithDependenciesFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is NotifierFamilyWithDependenciesProvider && + other.argument == argument; + } +} + +String _$notifierFamilyWithDependenciesHash() => + r'b185ba93857cd028964c1412e748ee887dbd45c8'; + +final class NotifierFamilyWithDependenciesFamily extends Family { + const NotifierFamilyWithDependenciesFamily._() + : super( + name: r'NotifierFamilyWithDependencies', + dependencies: const [ + providerWithDependenciesProvider, + _private2Provider, + public2Provider + ], + allTransitiveDependencies: const [ + providerWithDependenciesProvider, + ...?providerWithDependenciesProvider.allTransitiveDependencies, + _private2Provider, + ...?_private2Provider.allTransitiveDependencies, + public2Provider, + ...?public2Provider.allTransitiveDependencies + ], + debugGetCreateSourceHash: _$notifierFamilyWithDependenciesHash, + isAutoDispose: true, + ); + + NotifierFamilyWithDependenciesProvider call({ + int? id, + }) => + NotifierFamilyWithDependenciesProvider._(argument: (id: id,), from: this); + + @override + String toString() => r'NotifierFamilyWithDependencies'; +} + +abstract class _$NotifierFamilyWithDependencies extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as ({ + int? id, + }); + int? get id => _$args.id; + + int build({ + int? id, + }); + + @$internal + @override + int runBuild() => build( + id: _$args.id, + ); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/generated.dart b/packages/riverpod_generator/test/integration/generated.dart index e472d3b0d..2a117a8e6 100644 --- a/packages/riverpod_generator/test/integration/generated.dart +++ b/packages/riverpod_generator/test/integration/generated.dart @@ -1,83 +1,83 @@ -// // ignore_for_file: library_private_types_in_public_api, inference_failure_on_function_return_type, always_declare_return_types, type_annotate_public_apis - -// import 'package:freezed_annotation/freezed_annotation.dart'; -// import 'package:riverpod/riverpod.dart' as r; -// import 'package:riverpod_annotation/riverpod_annotation.dart'; - -// // part 'generated.freezed.dart'; -// // part 'generated.g.dart'; - -// @freezed -// class Test with _$Test { -// factory Test() = _Test; -// } - -// @riverpod -// _Test generated(GeneratedRef ref) => _Test(); - -// @riverpod -// _Test generatedFamily(GeneratedFamilyRef ref, _Test test) => _Test(); - -// @riverpod -// class GeneratedClass extends _$GeneratedClass { -// @override -// _Test build() => _Test(); -// } - -// @riverpod -// class GeneratedClassFamily extends _$GeneratedClassFamily { -// @override -// _Test build(_Test test) => _Test(); -// } - -// @riverpod -// $dynamic($DynamicRef ref) => _Test(); - -// @riverpod -// $dynamicFamily($DynamicFamilyRef ref, test) => _Test(); - -// @riverpod -// class $DynamicClass extends _$$DynamicClass { -// @override -// build() => _Test(); -// } - -// @riverpod -// class $DynamicClassFamily extends _$$DynamicClassFamily { -// @override -// build(test) => _Test(); -// } - -// @riverpod -// _dynamic(_DynamicRef ref, test) => 0; - -// @riverpod -// r.AsyncValue alias(AliasRef ref) { -// return const r.AsyncData(42); -// } - -// @riverpod -// r.AsyncValue aliasFamily( -// AliasFamilyRef ref, -// r.AsyncValue test, -// ) { -// return const r.AsyncData(42); -// } - -// @riverpod -// class AliasClass extends _$AliasClass { -// @override -// r.AsyncValue build() { -// return const r.AsyncData(42); -// } -// } - -// @riverpod -// class AliasClassFamily extends _$AliasClassFamily { -// @override -// r.AsyncValue build( -// r.AsyncValue test, -// ) { -// return const r.AsyncData(42); -// } -// } +// ignore_for_file: library_private_types_in_public_api, inference_failure_on_function_return_type, always_declare_return_types, type_annotate_public_apis + +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod/riverpod.dart' as r; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'generated.freezed.dart'; +part 'generated.g.dart'; + +@freezed +class Test with _$Test { + factory Test() = _Test; +} + +@riverpod +_Test generated(GeneratedRef ref) => _Test(); + +@riverpod +_Test generatedFamily(GeneratedFamilyRef ref, _Test test) => _Test(); + +@riverpod +class GeneratedClass extends _$GeneratedClass { + @override + _Test build() => _Test(); +} + +@riverpod +class GeneratedClassFamily extends _$GeneratedClassFamily { + @override + _Test build(_Test test) => _Test(); +} + +@riverpod +$dynamic($DynamicRef ref) => _Test(); + +@riverpod +$dynamicFamily($DynamicFamilyRef ref, test) => _Test(); + +@riverpod +class $DynamicClass extends _$$DynamicClass { + @override + build() => _Test(); +} + +@riverpod +class $DynamicClassFamily extends _$$DynamicClassFamily { + @override + build(test) => _Test(); +} + +@riverpod +_dynamic(_DynamicRef ref, test) => 0; + +@riverpod +r.AsyncValue alias(AliasRef ref) { + return const r.AsyncData(42); +} + +@riverpod +r.AsyncValue aliasFamily( + AliasFamilyRef ref, + r.AsyncValue test, +) { + return const r.AsyncData(42); +} + +@riverpod +class AliasClass extends _$AliasClass { + @override + r.AsyncValue build() { + return const r.AsyncData(42); + } +} + +@riverpod +class AliasClassFamily extends _$AliasClassFamily { + @override + r.AsyncValue build( + r.AsyncValue test, + ) { + return const r.AsyncData(42); + } +} diff --git a/packages/riverpod_generator/test/integration/generated.freezed.dart b/packages/riverpod_generator/test/integration/generated.freezed.dart new file mode 100644 index 000000000..28fc84cf6 --- /dev/null +++ b/packages/riverpod_generator/test/integration/generated.freezed.dart @@ -0,0 +1,74 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'generated.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + +/// @nodoc +mixin _$Test {} + +/// @nodoc +abstract class $TestCopyWith<$Res> { + factory $TestCopyWith(Test value, $Res Function(Test) then) = + _$TestCopyWithImpl<$Res, Test>; +} + +/// @nodoc +class _$TestCopyWithImpl<$Res, $Val extends Test> + implements $TestCopyWith<$Res> { + _$TestCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; +} + +/// @nodoc +abstract class _$$TestImplCopyWith<$Res> { + factory _$$TestImplCopyWith( + _$TestImpl value, $Res Function(_$TestImpl) then) = + __$$TestImplCopyWithImpl<$Res>; +} + +/// @nodoc +class __$$TestImplCopyWithImpl<$Res> + extends _$TestCopyWithImpl<$Res, _$TestImpl> + implements _$$TestImplCopyWith<$Res> { + __$$TestImplCopyWithImpl(_$TestImpl _value, $Res Function(_$TestImpl) _then) + : super(_value, _then); +} + +/// @nodoc + +class _$TestImpl implements _Test { + _$TestImpl(); + + @override + String toString() { + return 'Test()'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && other is _$TestImpl); + } + + @override + int get hashCode => runtimeType.hashCode; +} + +abstract class _Test implements Test { + factory _Test() = _$TestImpl; +} diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart new file mode 100644 index 000000000..4a3153ff9 --- /dev/null +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -0,0 +1,963 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'generated.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef GeneratedRef = Ref<_Test>; + +const generatedProvider = GeneratedProvider._(); + +final class GeneratedProvider + extends $FunctionalProvider<_Test, _Test, GeneratedRef> + with $Provider<_Test, GeneratedRef> { + const GeneratedProvider._( + {_Test Function( + GeneratedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$generatedHash, + name: r'generated', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final _Test Function( + GeneratedRef ref, + )? _createCb; + + @override + $ProviderElement<_Test> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + _Test create(GeneratedRef ref) { + final fn = _createCb ?? generated; + + return fn( + ref, + ); + } + + @override + GeneratedProvider copyWithCreate( + _Test Function( + GeneratedRef ref, + ) create, + ) { + return GeneratedProvider._(create: create); + } +} + +String _$generatedHash() => r'e49f3520d06ed50d34a44de613fdcd20b19f48d4'; + +typedef GeneratedFamilyRef = Ref<_Test>; + +const generatedFamilyProvider = GeneratedFamilyFamily._(); + +final class GeneratedFamilyProvider + extends $FunctionalProvider<_Test, _Test, GeneratedFamilyRef> + with $Provider<_Test, GeneratedFamilyRef> { + const GeneratedFamilyProvider._( + {required GeneratedFamilyFamily super.from, + required (_Test,) super.argument, + _Test Function( + GeneratedFamilyRef ref, + _Test test, + )? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$generatedFamilyHash, + name: r'generatedFamily', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final _Test Function( + GeneratedFamilyRef ref, + _Test test, + )? _createCb; + + @override + $ProviderElement<_Test> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + _Test create(GeneratedFamilyRef ref) { + final fn = _createCb ?? generatedFamily; + final (_Test,) argument = this.argument! as (_Test,); + return fn( + ref, + argument.$1, + ); + } + + @override + GeneratedFamilyProvider copyWithCreate( + _Test Function( + GeneratedFamilyRef ref, + ) create, + ) { + return GeneratedFamilyProvider._( + argument: argument! as (_Test,), + from: from! as GeneratedFamilyFamily, + create: ( + ref, + _Test test, + ) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is GeneratedFamilyProvider && other.argument == argument; + } +} + +String _$generatedFamilyHash() => r'ed284f58926c87acc81dab9168882d5d1c2cddf8'; + +final class GeneratedFamilyFamily extends Family { + const GeneratedFamilyFamily._() + : super( + name: r'generatedFamily', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$generatedFamilyHash, + isAutoDispose: true, + ); + + GeneratedFamilyProvider call( + _Test test, + ) => + GeneratedFamilyProvider._(argument: (test,), from: this); + + @override + String toString() => r'generatedFamily'; +} + +typedef $DynamicRef = Ref; + +const $dynamicProvider = $DynamicProvider._(); + +final class $DynamicProvider + extends $FunctionalProvider + with $Provider { + const $DynamicProvider._( + {Object? Function( + $DynamicRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$$dynamicHash, + name: r'$dynamic', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Object? Function( + $DynamicRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Object? create($DynamicRef ref) { + final fn = _createCb ?? $dynamic; + + return fn( + ref, + ); + } + + @override + $DynamicProvider copyWithCreate( + Object? Function( + $DynamicRef ref, + ) create, + ) { + return $DynamicProvider._(create: create); + } +} + +String _$$dynamicHash() => r'f62d63d9340f30b253e687f76deacd8205fed0e7'; + +typedef $DynamicFamilyRef = Ref; + +const $dynamicFamilyProvider = $DynamicFamilyFamily._(); + +final class $DynamicFamilyProvider + extends $FunctionalProvider + with $Provider { + const $DynamicFamilyProvider._( + {required $DynamicFamilyFamily super.from, + required (dynamic,) super.argument, + Object? Function( + $DynamicFamilyRef ref, + test, + )? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$$dynamicFamilyHash, + name: r'$dynamicFamily', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Object? Function( + $DynamicFamilyRef ref, + test, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Object? create($DynamicFamilyRef ref) { + final fn = _createCb ?? $dynamicFamily; + final (dynamic,) argument = this.argument! as (dynamic,); + return fn( + ref, + argument.$1, + ); + } + + @override + $DynamicFamilyProvider copyWithCreate( + Object? Function( + $DynamicFamilyRef ref, + ) create, + ) { + return $DynamicFamilyProvider._( + argument: argument! as (dynamic,), + from: from! as $DynamicFamilyFamily, + create: ( + ref, + test, + ) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is $DynamicFamilyProvider && other.argument == argument; + } +} + +String _$$dynamicFamilyHash() => r'b764133af8837b8321b08814892f198d4bc1aa18'; + +final class $DynamicFamilyFamily extends Family { + const $DynamicFamilyFamily._() + : super( + name: r'$dynamicFamily', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$$dynamicFamilyHash, + isAutoDispose: true, + ); + + $DynamicFamilyProvider call( + test, + ) => + $DynamicFamilyProvider._(argument: (test,), from: this); + + @override + String toString() => r'$dynamicFamily'; +} + +typedef _DynamicRef = Ref; + +const _dynamicProvider = _DynamicFamily._(); + +final class _DynamicProvider + extends $FunctionalProvider + with $Provider { + const _DynamicProvider._( + {required _DynamicFamily super.from, + required (dynamic,) super.argument, + Object? Function( + _DynamicRef ref, + test, + )? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$dynamicHash, + name: r'_dynamic', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Object? Function( + _DynamicRef ref, + test, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Object? create(_DynamicRef ref) { + final fn = _createCb ?? _dynamic; + final (dynamic,) argument = this.argument! as (dynamic,); + return fn( + ref, + argument.$1, + ); + } + + @override + _DynamicProvider copyWithCreate( + Object? Function( + _DynamicRef ref, + ) create, + ) { + return _DynamicProvider._( + argument: argument! as (dynamic,), + from: from! as _DynamicFamily, + create: ( + ref, + test, + ) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is _DynamicProvider && other.argument == argument; + } +} + +String _$dynamicHash() => r'da9dc07960139fff2cf5fe584dca5c524e4f2308'; + +final class _DynamicFamily extends Family { + const _DynamicFamily._() + : super( + name: r'_dynamic', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$dynamicHash, + isAutoDispose: true, + ); + + _DynamicProvider call( + test, + ) => + _DynamicProvider._(argument: (test,), from: this); + + @override + String toString() => r'_dynamic'; +} + +typedef AliasRef = Ref>; + +const aliasProvider = AliasProvider._(); + +final class AliasProvider + extends $FunctionalProvider, r.AsyncValue, AliasRef> + with $Provider, AliasRef> { + const AliasProvider._( + {r.AsyncValue Function( + AliasRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$aliasHash, + name: r'alias', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final r.AsyncValue Function( + AliasRef ref, + )? _createCb; + + @override + $ProviderElement> createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + r.AsyncValue create(AliasRef ref) { + final fn = _createCb ?? alias; + + return fn( + ref, + ); + } + + @override + AliasProvider copyWithCreate( + r.AsyncValue Function( + AliasRef ref, + ) create, + ) { + return AliasProvider._(create: create); + } +} + +String _$aliasHash() => r'cc08ec4cc5ec0dc98bdb7f4dcbc035021b09bcf3'; + +typedef AliasFamilyRef = Ref>; + +const aliasFamilyProvider = AliasFamilyFamily._(); + +final class AliasFamilyProvider extends $FunctionalProvider< + r.AsyncValue, + r.AsyncValue, + AliasFamilyRef> with $Provider, AliasFamilyRef> { + const AliasFamilyProvider._( + {required AliasFamilyFamily super.from, + required (r.AsyncValue,) super.argument, + r.AsyncValue Function( + AliasFamilyRef ref, + r.AsyncValue test, + )? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$aliasFamilyHash, + name: r'aliasFamily', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final r.AsyncValue Function( + AliasFamilyRef ref, + r.AsyncValue test, + )? _createCb; + + @override + $ProviderElement> createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + r.AsyncValue create(AliasFamilyRef ref) { + final fn = _createCb ?? aliasFamily; + final (r.AsyncValue,) argument = + this.argument! as (r.AsyncValue,); + return fn( + ref, + argument.$1, + ); + } + + @override + AliasFamilyProvider copyWithCreate( + r.AsyncValue Function( + AliasFamilyRef ref, + ) create, + ) { + return AliasFamilyProvider._( + argument: argument! as (r.AsyncValue,), + from: from! as AliasFamilyFamily, + create: ( + ref, + r.AsyncValue test, + ) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is AliasFamilyProvider && other.argument == argument; + } +} + +String _$aliasFamilyHash() => r'f345937d5750132f629aef41646b119a301f750b'; + +final class AliasFamilyFamily extends Family { + const AliasFamilyFamily._() + : super( + name: r'aliasFamily', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$aliasFamilyHash, + isAutoDispose: true, + ); + + AliasFamilyProvider call( + r.AsyncValue test, + ) => + AliasFamilyProvider._(argument: (test,), from: this); + + @override + String toString() => r'aliasFamily'; +} + +const generatedClassProvider = GeneratedClassProvider._(); + +final class GeneratedClassProvider + extends $NotifierProvider { + const GeneratedClassProvider._( + {super.runNotifierBuildOverride, GeneratedClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$generatedClassHash, + name: r'GeneratedClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final GeneratedClass Function()? _createCb; + + @$internal + @override + GeneratedClass create() => _createCb?.call() ?? GeneratedClass(); + + @$internal + @override + GeneratedClassProvider copyWithCreate( + GeneratedClass Function() create, + ) { + return GeneratedClassProvider._(create: create); + } + + @$internal + @override + GeneratedClassProvider copyWithBuild( + _Test Function(Ref<_Test>, GeneratedClass) build, + ) { + return GeneratedClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$generatedClassHash() => r'984153f97e25de687d2f19756b277aabd56f6e72'; + +abstract class _$GeneratedClass extends $Notifier<_Test> { + _Test build(); + + @$internal + @override + _Test runBuild() => build(); +} + +const generatedClassFamilyProvider = GeneratedClassFamilyFamily._(); + +final class GeneratedClassFamilyProvider + extends $NotifierProvider { + const GeneratedClassFamilyProvider._( + {required GeneratedClassFamilyFamily super.from, + required (_Test,) super.argument, + super.runNotifierBuildOverride, + GeneratedClassFamily Function()? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$generatedClassFamilyHash, + name: r'GeneratedClassFamily', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final GeneratedClassFamily Function()? _createCb; + + @$internal + @override + GeneratedClassFamily create() => _createCb?.call() ?? GeneratedClassFamily(); + + @$internal + @override + GeneratedClassFamilyProvider copyWithCreate( + GeneratedClassFamily Function() create, + ) { + return GeneratedClassFamilyProvider._( + argument: argument! as (_Test,), + from: from! as GeneratedClassFamilyFamily, + create: create); + } + + @$internal + @override + GeneratedClassFamilyProvider copyWithBuild( + _Test Function(Ref<_Test>, GeneratedClassFamily) build, + ) { + return GeneratedClassFamilyProvider._( + argument: argument! as (_Test,), + from: from! as GeneratedClassFamilyFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is GeneratedClassFamilyProvider && other.argument == argument; + } +} + +String _$generatedClassFamilyHash() => + r'28d0a5a82af5b254f6ef07b492916e2feb7e6e63'; + +final class GeneratedClassFamilyFamily extends Family { + const GeneratedClassFamilyFamily._() + : super( + name: r'GeneratedClassFamily', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$generatedClassFamilyHash, + isAutoDispose: true, + ); + + GeneratedClassFamilyProvider call( + _Test test, + ) => + GeneratedClassFamilyProvider._(argument: (test,), from: this); + + @override + String toString() => r'GeneratedClassFamily'; +} + +abstract class _$GeneratedClassFamily extends $Notifier<_Test> { + late final _$args = + (ref as $NotifierProviderElement).origin.argument as (_Test,); + _Test get test => _$args.$1; + + _Test build( + _Test test, + ); + + @$internal + @override + _Test runBuild() => build( + _$args.$1, + ); +} + +const $dynamicClassProvider = $DynamicClassProvider._(); + +final class $DynamicClassProvider + extends $NotifierProvider<$DynamicClass, Object?> { + const $DynamicClassProvider._( + {super.runNotifierBuildOverride, $DynamicClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$$dynamicClassHash, + name: r'$DynamicClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final $DynamicClass Function()? _createCb; + + @$internal + @override + $DynamicClass create() => _createCb?.call() ?? $DynamicClass(); + + @$internal + @override + $DynamicClassProvider copyWithCreate( + $DynamicClass Function() create, + ) { + return $DynamicClassProvider._(create: create); + } + + @$internal + @override + $DynamicClassProvider copyWithBuild( + Object? Function(Ref, $DynamicClass) build, + ) { + return $DynamicClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement<$DynamicClass, Object?> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$$dynamicClassHash() => r'c6d8e5191c3f060df3ce3eee66107433fd4c3292'; + +abstract class _$$DynamicClass extends $Notifier { + Object? build(); + + @$internal + @override + Object? runBuild() => build(); +} + +const $dynamicClassFamilyProvider = $DynamicClassFamilyFamily._(); + +final class $DynamicClassFamilyProvider + extends $NotifierProvider<$DynamicClassFamily, Object?> { + const $DynamicClassFamilyProvider._( + {required $DynamicClassFamilyFamily super.from, + required (dynamic,) super.argument, + super.runNotifierBuildOverride, + $DynamicClassFamily Function()? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$$dynamicClassFamilyHash, + name: r'$DynamicClassFamily', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final $DynamicClassFamily Function()? _createCb; + + @$internal + @override + $DynamicClassFamily create() => _createCb?.call() ?? $DynamicClassFamily(); + + @$internal + @override + $DynamicClassFamilyProvider copyWithCreate( + $DynamicClassFamily Function() create, + ) { + return $DynamicClassFamilyProvider._( + argument: argument! as (dynamic,), + from: from! as $DynamicClassFamilyFamily, + create: create); + } + + @$internal + @override + $DynamicClassFamilyProvider copyWithBuild( + Object? Function(Ref, $DynamicClassFamily) build, + ) { + return $DynamicClassFamilyProvider._( + argument: argument! as (dynamic,), + from: from! as $DynamicClassFamilyFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement<$DynamicClassFamily, Object?> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is $DynamicClassFamilyProvider && other.argument == argument; + } +} + +String _$$dynamicClassFamilyHash() => + r'bdda961386f3b647c071d79293a8da441580c470'; + +final class $DynamicClassFamilyFamily extends Family { + const $DynamicClassFamilyFamily._() + : super( + name: r'$DynamicClassFamily', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$$dynamicClassFamilyHash, + isAutoDispose: true, + ); + + $DynamicClassFamilyProvider call( + test, + ) => + $DynamicClassFamilyProvider._(argument: (test,), from: this); + + @override + String toString() => r'$DynamicClassFamily'; +} + +abstract class _$$DynamicClassFamily extends $Notifier { + late final _$args = + (ref as $NotifierProviderElement).origin.argument as (dynamic,); + get test => _$args.$1; + + Object? build( + test, + ); + + @$internal + @override + Object? runBuild() => build( + _$args.$1, + ); +} + +const aliasClassProvider = AliasClassProvider._(); + +final class AliasClassProvider + extends $NotifierProvider> { + const AliasClassProvider._( + {super.runNotifierBuildOverride, AliasClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$aliasClassHash, + name: r'AliasClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final AliasClass Function()? _createCb; + + @$internal + @override + AliasClass create() => _createCb?.call() ?? AliasClass(); + + @$internal + @override + AliasClassProvider copyWithCreate( + AliasClass Function() create, + ) { + return AliasClassProvider._(create: create); + } + + @$internal + @override + AliasClassProvider copyWithBuild( + r.AsyncValue Function(Ref>, AliasClass) build, + ) { + return AliasClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$aliasClassHash() => r'a6c6d7594ebd09ba728e42d79b12af560d09c379'; + +abstract class _$AliasClass extends $Notifier> { + r.AsyncValue build(); + + @$internal + @override + r.AsyncValue runBuild() => build(); +} + +const aliasClassFamilyProvider = AliasClassFamilyFamily._(); + +final class AliasClassFamilyProvider + extends $NotifierProvider> { + const AliasClassFamilyProvider._( + {required AliasClassFamilyFamily super.from, + required (r.AsyncValue,) super.argument, + super.runNotifierBuildOverride, + AliasClassFamily Function()? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$aliasClassFamilyHash, + name: r'AliasClassFamily', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final AliasClassFamily Function()? _createCb; + + @$internal + @override + AliasClassFamily create() => _createCb?.call() ?? AliasClassFamily(); + + @$internal + @override + AliasClassFamilyProvider copyWithCreate( + AliasClassFamily Function() create, + ) { + return AliasClassFamilyProvider._( + argument: argument! as (r.AsyncValue,), + from: from! as AliasClassFamilyFamily, + create: create); + } + + @$internal + @override + AliasClassFamilyProvider copyWithBuild( + r.AsyncValue Function(Ref>, AliasClassFamily) build, + ) { + return AliasClassFamilyProvider._( + argument: argument! as (r.AsyncValue,), + from: from! as AliasClassFamilyFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is AliasClassFamilyProvider && other.argument == argument; + } +} + +String _$aliasClassFamilyHash() => r'3f348beb95dae3a9890b4a4d0ce01481316fc66d'; + +final class AliasClassFamilyFamily extends Family { + const AliasClassFamilyFamily._() + : super( + name: r'AliasClassFamily', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$aliasClassFamilyHash, + isAutoDispose: true, + ); + + AliasClassFamilyProvider call( + r.AsyncValue test, + ) => + AliasClassFamilyProvider._(argument: (test,), from: this); + + @override + String toString() => r'AliasClassFamily'; +} + +abstract class _$AliasClassFamily extends $Notifier> { + late final _$args = + (ref as $NotifierProviderElement).origin.argument as (r.AsyncValue,); + r.AsyncValue get test => _$args.$1; + + r.AsyncValue build( + r.AsyncValue test, + ); + + @$internal + @override + r.AsyncValue runBuild() => build( + _$args.$1, + ); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/scopes.dart b/packages/riverpod_generator/test/integration/scopes.dart index a61036d6c..9e0b223c5 100644 --- a/packages/riverpod_generator/test/integration/scopes.dart +++ b/packages/riverpod_generator/test/integration/scopes.dart @@ -1,6 +1,6 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; -// part 'scopes.g.dart'; +part 'scopes.g.dart'; @riverpod external int scoped(); diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart new file mode 100644 index 000000000..4323090d1 --- /dev/null +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -0,0 +1,61 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'scopes.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ScopedRef = Ref; + +const scopedProvider = ScopedProvider._(); + +final class ScopedProvider extends $FunctionalProvider + with $Provider { + const ScopedProvider._( + {int Function( + ScopedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$scopedHash, + name: r'scoped', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ScopedRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(ScopedRef ref) { + final fn = _createCb ?? scoped; + + return fn( + ref, + ); + } + + @override + ScopedProvider copyWithCreate( + int Function( + ScopedRef ref, + ) create, + ) { + return ScopedProvider._(create: create); + } +} + +String _$scopedHash() => r'590f1a203323105e732397a2616fbd7dac65f0cc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/split.dart b/packages/riverpod_generator/test/integration/split.dart index fa9a8d039..543f7e6fc 100644 --- a/packages/riverpod_generator/test/integration/split.dart +++ b/packages/riverpod_generator/test/integration/split.dart @@ -1,8 +1,8 @@ -// // Regression test for https://github.com/rrousselGit/riverpod/issues/2175 -// import 'package:riverpod_annotation/riverpod_annotation.dart'; +// Regression test for https://github.com/rrousselGit/riverpod/issues/2175 +import 'package:riverpod_annotation/riverpod_annotation.dart'; -// part 'split2.dart'; -// part 'split.g.dart'; +part 'split2.dart'; +part 'split.g.dart'; -// @riverpod -// int counter2(Counter2Ref ref) => 0; +@riverpod +int counter2(Counter2Ref ref) => 0; diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart new file mode 100644 index 000000000..c91cb926a --- /dev/null +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -0,0 +1,111 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'split.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef Counter2Ref = Ref; + +const counter2Provider = Counter2Provider._(); + +final class Counter2Provider extends $FunctionalProvider + with $Provider { + const Counter2Provider._( + {int Function( + Counter2Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$counter2Hash, + name: r'counter2', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + Counter2Ref ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(Counter2Ref ref) { + final fn = _createCb ?? counter2; + + return fn( + ref, + ); + } + + @override + Counter2Provider copyWithCreate( + int Function( + Counter2Ref ref, + ) create, + ) { + return Counter2Provider._(create: create); + } +} + +String _$counter2Hash() => r'9328919066a683f85226fc59201bb7c54f107a7d'; + +typedef CounterRef = Ref; + +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $FunctionalProvider + with $Provider { + const CounterProvider._( + {int Function( + CounterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$counterHash, + name: r'counter', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CounterRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(CounterRef ref) { + final fn = _createCb ?? counter; + + return fn( + ref, + ); + } + + @override + CounterProvider copyWithCreate( + int Function( + CounterRef ref, + ) create, + ) { + return CounterProvider._(create: create); + } +} + +String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/split2.dart b/packages/riverpod_generator/test/integration/split2.dart index 0a8e64558..8dc266ec0 100644 --- a/packages/riverpod_generator/test/integration/split2.dart +++ b/packages/riverpod_generator/test/integration/split2.dart @@ -1,4 +1,4 @@ -// part of 'split.dart'; +part of 'split.dart'; -// @riverpod -// int counter(CounterRef ref) => 0; +@riverpod +int counter(CounterRef ref) => 0; diff --git a/packages/riverpod_generator/test/integration/stream.dart b/packages/riverpod_generator/test/integration/stream.dart index af613b160..00f919624 100644 --- a/packages/riverpod_generator/test/integration/stream.dart +++ b/packages/riverpod_generator/test/integration/stream.dart @@ -1,84 +1,84 @@ -// import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; -// part 'stream.g.dart'; +part 'stream.g.dart'; -// @riverpod -// Stream> generic(GenericRef ref) async* { -// yield []; -// } +@riverpod +Stream> generic(GenericRef ref) async* { + yield []; +} -// @riverpod -// class GenericClass extends _$GenericClass { -// @override -// Stream> build() async* { -// yield []; -// } -// } +@riverpod +class GenericClass extends _$GenericClass { + @override + Stream> build() async* { + yield []; + } +} -// @riverpod -// Stream public(PublicRef ref) { -// return Stream.value('Hello world'); -// } +@riverpod +Stream public(PublicRef ref) { + return Stream.value('Hello world'); +} -// final privateProvider = _privateProvider; +const privateProvider = _privateProvider; -// @riverpod -// Stream _private(_PrivateRef ref) { -// return Stream.value('Hello world'); -// } +@riverpod +Stream _private(_PrivateRef ref) { + return Stream.value('Hello world'); +} -// @riverpod -// Stream family( -// FamilyRef ref, -// int first, { -// String? second, -// required double third, -// bool fourth = true, -// List? fifth, -// }) { -// return Stream.value( -// '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)', -// ); -// } +@riverpod +Stream family( + FamilyRef ref, + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, +}) { + return Stream.value( + '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)', + ); +} -// @riverpod -// class PublicClass extends _$PublicClass { -// PublicClass([this.param]); +@riverpod +class PublicClass extends _$PublicClass { + PublicClass([this.param]); -// final Object? param; + final Object? param; -// @override -// Stream build() { -// return Stream.value('Hello world'); -// } -// } + @override + Stream build() { + return Stream.value('Hello world'); + } +} -// final privateClassProvider = _privateClassProvider; +const privateClassProvider = _privateClassProvider; -// @riverpod -// class _PrivateClass extends _$PrivateClass { -// @override -// Stream build() { -// return Stream.value('Hello world'); -// } -// } +@riverpod +class _PrivateClass extends _$PrivateClass { + @override + Stream build() { + return Stream.value('Hello world'); + } +} -// @riverpod -// class FamilyClass extends _$FamilyClass { -// FamilyClass([this.param]); +@riverpod +class FamilyClass extends _$FamilyClass { + FamilyClass([this.param]); -// final Object? param; + final Object? param; -// @override -// Stream build( -// int first, { -// String? second, -// required double third, -// bool fourth = true, -// List? fifth, -// }) { -// return Stream.value( -// '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)', -// ); -// } -// } + @override + Stream build( + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) { + return Stream.value( + '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)', + ); + } +} diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart new file mode 100644 index 000000000..9574329c5 --- /dev/null +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -0,0 +1,660 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'stream.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef GenericRef = Ref>>; + +const genericProvider = GenericFamily._(); + +final class GenericProvider extends $FunctionalProvider< + AsyncValue>, Stream>, GenericRef> + with $FutureModifier>, $StreamProvider, GenericRef> { + const GenericProvider._( + {required GenericFamily super.from, + Stream> Function( + GenericRef ref, + )? create}) + : _createCb = create, + super( + argument: null, + debugGetCreateSourceHash: _$genericHash, + name: r'generic', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream> Function( + GenericRef ref, + )? _createCb; + + @override + $StreamProviderElement> createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + Stream> create(GenericRef ref) { + final fn = _createCb ?? generic; + + return fn( + ref, + ); + } + + @override + GenericProvider copyWithCreate( + Stream> Function( + GenericRef ref, + ) create, + ) { + return GenericProvider._(from: from! as GenericFamily, create: create); + } + + @override + bool operator ==(Object other) { + return other is GenericProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } +} + +String _$genericHash() => r'c1122edf55163d47de8d871ed5d15e0a7edddc05'; + +final class GenericFamily extends Family { + const GenericFamily._() + : super( + name: r'generic', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$genericHash, + isAutoDispose: true, + ); + + GenericProvider call() => GenericProvider._(from: this); + + @override + String toString() => r'generic'; +} + +typedef PublicRef = Ref>; + +const publicProvider = PublicProvider._(); + +final class PublicProvider + extends $FunctionalProvider, Stream, PublicRef> + with $FutureModifier, $StreamProvider { + const PublicProvider._( + {Stream Function( + PublicRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$publicHash, + name: r'public', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + PublicRef ref, + )? _createCb; + + @override + $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + Stream create(PublicRef ref) { + final fn = _createCb ?? public; + + return fn( + ref, + ); + } + + @override + PublicProvider copyWithCreate( + Stream Function( + PublicRef ref, + ) create, + ) { + return PublicProvider._(create: create); + } +} + +String _$publicHash() => r'c5cc0eac434371901cf6ab159a81bba49c58da12'; + +typedef _PrivateRef = Ref>; + +const _privateProvider = _PrivateProvider._(); + +final class _PrivateProvider + extends $FunctionalProvider, Stream, _PrivateRef> + with $FutureModifier, $StreamProvider { + const _PrivateProvider._( + {Stream Function( + _PrivateRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$privateHash, + name: r'_private', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + _PrivateRef ref, + )? _createCb; + + @override + $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + Stream create(_PrivateRef ref) { + final fn = _createCb ?? _private; + + return fn( + ref, + ); + } + + @override + _PrivateProvider copyWithCreate( + Stream Function( + _PrivateRef ref, + ) create, + ) { + return _PrivateProvider._(create: create); + } +} + +String _$privateHash() => r'bbee0c7e27bda81346b5f52c96b23b2e48f83077'; + +typedef FamilyRef = Ref>; + +const familyProvider = FamilyFamily._(); + +final class FamilyProvider + extends $FunctionalProvider, Stream, FamilyRef> + with $FutureModifier, $StreamProvider { + const FamilyProvider._( + {required FamilyFamily super.from, + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, + Stream Function( + FamilyRef ref, + int first, { + String? second, + required double third, + bool fourth, + List? fifth, + })? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$familyHash, + name: r'family', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + FamilyRef ref, + int first, { + String? second, + required double third, + bool fourth, + List? fifth, + })? _createCb; + + @override + $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + Stream create(FamilyRef ref) { + final fn = _createCb ?? family; + final ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) argument = this.argument! as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + return fn( + ref, + argument.$1, + second: argument.second, + third: argument.third, + fourth: argument.fourth, + fifth: argument.fifth, + ); + } + + @override + FamilyProvider copyWithCreate( + Stream Function( + FamilyRef ref, + ) create, + ) { + return FamilyProvider._( + argument: argument! as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), + from: from! as FamilyFamily, + create: ( + ref, + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is FamilyProvider && other.argument == argument; + } +} + +String _$familyHash() => r'6896fac2f6e3ccd7c38ecaa0d538cbd3577936b2'; + +final class FamilyFamily extends Family { + const FamilyFamily._() + : super( + name: r'family', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$familyHash, + isAutoDispose: true, + ); + + FamilyProvider call( + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) => + FamilyProvider._(argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), from: this); + + @override + String toString() => r'family'; +} + +const genericClassProvider = GenericClassFamily._(); + +final class GenericClassProvider + extends $StreamNotifierProvider, List> { + const GenericClassProvider._( + {required GenericClassFamily super.from, + super.runNotifierBuildOverride, + GenericClass Function()? create}) + : _createCb = create, + super( + argument: null, + debugGetCreateSourceHash: _$genericClassHash, + name: r'GenericClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final GenericClass Function()? _createCb; + + @$internal + @override + GenericClass create() => _createCb?.call() ?? GenericClass(); + + @$internal + @override + GenericClassProvider copyWithCreate( + GenericClass Function() create, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, create: create); + } + + @$internal + @override + GenericClassProvider copyWithBuild( + Stream> Function(Ref>>, GenericClass) build, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, runNotifierBuildOverride: build); + } + + @$internal + @override + $StreamNotifierProviderElement, List> createElement( + ProviderContainer container) => + $StreamNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is GenericClassProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } +} + +String _$genericClassHash() => r'401ae1cfd97a4291dfd135a69ff8e1c436866e5a'; + +final class GenericClassFamily extends Family { + const GenericClassFamily._() + : super( + name: r'GenericClass', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$genericClassHash, + isAutoDispose: true, + ); + + GenericClassProvider call() => + GenericClassProvider._(from: this); + + @override + String toString() => r'GenericClass'; +} + +abstract class _$GenericClass extends $StreamNotifier> { + Stream> build(); + + @$internal + @override + Stream> runBuild() => build(); +} + +const publicClassProvider = PublicClassProvider._(); + +final class PublicClassProvider + extends $StreamNotifierProvider { + const PublicClassProvider._( + {super.runNotifierBuildOverride, PublicClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$publicClassHash, + name: r'PublicClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final PublicClass Function()? _createCb; + + @$internal + @override + PublicClass create() => _createCb?.call() ?? PublicClass(); + + @$internal + @override + PublicClassProvider copyWithCreate( + PublicClass Function() create, + ) { + return PublicClassProvider._(create: create); + } + + @$internal + @override + PublicClassProvider copyWithBuild( + Stream Function(Ref>, PublicClass) build, + ) { + return PublicClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $StreamNotifierProviderElement createElement( + ProviderContainer container) => + $StreamNotifierProviderElement(this, container); +} + +String _$publicClassHash() => r'b1526943c8ff0aaa20642bf78e744e5833cf9d02'; + +abstract class _$PublicClass extends $StreamNotifier { + Stream build(); + + @$internal + @override + Stream runBuild() => build(); +} + +const _privateClassProvider = _PrivateClassProvider._(); + +final class _PrivateClassProvider + extends $StreamNotifierProvider<_PrivateClass, String> { + const _PrivateClassProvider._( + {super.runNotifierBuildOverride, _PrivateClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$privateClassHash, + name: r'_PrivateClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final _PrivateClass Function()? _createCb; + + @$internal + @override + _PrivateClass create() => _createCb?.call() ?? _PrivateClass(); + + @$internal + @override + _PrivateClassProvider copyWithCreate( + _PrivateClass Function() create, + ) { + return _PrivateClassProvider._(create: create); + } + + @$internal + @override + _PrivateClassProvider copyWithBuild( + Stream Function(Ref>, _PrivateClass) build, + ) { + return _PrivateClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $StreamNotifierProviderElement<_PrivateClass, String> createElement( + ProviderContainer container) => + $StreamNotifierProviderElement(this, container); +} + +String _$privateClassHash() => r'8c0d52b7ab79c0546d0c84c011bb3512609e029e'; + +abstract class _$PrivateClass extends $StreamNotifier { + Stream build(); + + @$internal + @override + Stream runBuild() => build(); +} + +const familyClassProvider = FamilyClassFamily._(); + +final class FamilyClassProvider + extends $StreamNotifierProvider { + const FamilyClassProvider._( + {required FamilyClassFamily super.from, + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, + super.runNotifierBuildOverride, + FamilyClass Function()? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$familyClassHash, + name: r'FamilyClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FamilyClass Function()? _createCb; + + @$internal + @override + FamilyClass create() => _createCb?.call() ?? FamilyClass(); + + @$internal + @override + FamilyClassProvider copyWithCreate( + FamilyClass Function() create, + ) { + return FamilyClassProvider._( + argument: argument! as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), + from: from! as FamilyClassFamily, + create: create); + } + + @$internal + @override + FamilyClassProvider copyWithBuild( + Stream Function(Ref>, FamilyClass) build, + ) { + return FamilyClassProvider._( + argument: argument! as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), + from: from! as FamilyClassFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $StreamNotifierProviderElement createElement( + ProviderContainer container) => + $StreamNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is FamilyClassProvider && other.argument == argument; + } +} + +String _$familyClassHash() => r'6ec16ca23da8df4c010ecb5eed72e3e655504460'; + +final class FamilyClassFamily extends Family { + const FamilyClassFamily._() + : super( + name: r'FamilyClass', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$familyClassHash, + isAutoDispose: true, + ); + + FamilyClassProvider call( + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) => + FamilyClassProvider._(argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), from: this); + + @override + String toString() => r'FamilyClass'; +} + +abstract class _$FamilyClass extends $StreamNotifier { + late final _$args = + (ref as $StreamNotifierProviderElement).origin.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + int get first => _$args.$1; + String? get second => _$args.second; + double get third => _$args.third; + bool get fourth => _$args.fourth; + List? get fifth => _$args.fifth; + + Stream build( + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }); + + @$internal + @override + Stream runBuild() => build( + _$args.$1, + second: _$args.second, + third: _$args.third, + fourth: _$args.fourth, + fifth: _$args.fifth, + ); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/sync.dart b/packages/riverpod_generator/test/integration/sync.dart index d83cf84d2..3c6182844 100644 --- a/packages/riverpod_generator/test/integration/sync.dart +++ b/packages/riverpod_generator/test/integration/sync.dart @@ -1,176 +1,177 @@ -// import 'package:riverpod_annotation/riverpod_annotation.dart'; - -// part 'sync.g.dart'; - -// @riverpod -// List generic(GenericRef ref) { -// return [ -// 'Hello world', -// 42, -// 3.14, -// ].whereType().toList(); -// } - -// @riverpod -// List complexGeneric( -// ComplexGenericRef ref, { -// required T param, -// Foo? otherParam, -// }) { -// return []; -// } - -// @riverpod -// class GenericClass extends _$GenericClass { -// @override -// List build() { -// return []; -// } -// } - -// @riverpod -// Raw> rawFuture(RawFutureRef ref) async { -// return 'Hello world'; -// } - -// @riverpod -// Raw> rawStream(RawStreamRef ref) async* { -// yield 'Hello world'; -// } - -// @riverpod -// class RawFutureClass extends _$RawFutureClass { -// @override -// Raw> build() async { -// return 'Hello world'; -// } -// } - -// @riverpod -// class RawStreamClass extends _$RawStreamClass { -// @override -// Raw> build() async* { -// yield 'Hello world'; -// } -// } - -// @riverpod -// Raw> rawFamilyFuture(RawFamilyFutureRef ref, int id) async { -// return 'Hello world'; -// } - -// @riverpod -// Raw> rawFamilyStream(RawFamilyStreamRef ref, int id) async* { -// yield 'Hello world'; -// } - -// @riverpod -// class RawFamilyFutureClass extends _$RawFamilyFutureClass { -// @override -// Raw> build(int id) async { -// return 'Hello world'; -// } -// } - -// @riverpod -// class RawFamilyStreamClass extends _$RawFamilyStreamClass { -// @override -// Raw> build(int id) async* { -// yield 'Hello world'; -// } -// } - -// /// This is some documentation -// @riverpod -// String public(PublicRef ref) { -// return 'Hello world'; -// } - -// @riverpod -// String supports$inNames(Supports$inNamesRef ref) { -// return 'Hello world'; -// } - -// /// This is some documentation -// @riverpod -// String family( -// FamilyRef ref, -// int first, { -// String? second, -// required double third, -// bool fourth = true, -// List? fifth, -// }) { -// return '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)'; -// } - -// final privateProvider = _privateProvider; - -// @riverpod -// String _private(_PrivateRef ref) { -// return 'Hello world'; -// } - -// /// This is some documentation -// @riverpod -// class PublicClass extends _$PublicClass { -// PublicClass([this.param]); - -// final Object? param; - -// @override -// String build() { -// return 'Hello world'; -// } -// } - -// final privateClassProvider = _privateClassProvider; - -// @riverpod -// class _PrivateClass extends _$PrivateClass { -// @override -// String build() { -// return 'Hello world'; -// } -// } - -// /// This is some documentation -// @riverpod -// class FamilyClass extends _$FamilyClass { -// FamilyClass([this.param]); - -// final Object? param; - -// @override -// String build( -// int first, { -// String? second, -// required double third, -// bool fourth = true, -// List? fifth, -// }) { -// return '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)'; -// } -// } - -// @riverpod -// class Supports$InClassName extends _$Supports$InClassName { -// @override -// String build() { -// return 'Hello world'; -// } -// } - -// @riverpod -// String generated(GeneratedRef ref) { -// return 'Just a simple normal generated provider'; -// } - -// Provider someProvider() => Provider((ref) => 'hello'); - -// // Regression test for https://github.com/rrousselGit/riverpod/issues/2299 -// final _someProvider = someProvider(); - -// // Regression test for https://github.com/rrousselGit/riverpod/issues/2294 -// // ignore: unused_element -// final _other = _someProvider; +import 'package:riverpod/riverpod.dart' as r; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'sync.g.dart'; + +@riverpod +List generic(GenericRef ref) { + return [ + 'Hello world', + 42, + 3.14, + ].whereType().toList(); +} + +@riverpod +List complexGeneric( + ComplexGenericRef ref, { + required T param, + Foo? otherParam, +}) { + return []; +} + +@riverpod +class GenericClass extends _$GenericClass { + @override + List build() { + return []; + } +} + +@riverpod +Raw> rawFuture(RawFutureRef ref) async { + return 'Hello world'; +} + +@riverpod +Raw> rawStream(RawStreamRef ref) async* { + yield 'Hello world'; +} + +@riverpod +class RawFutureClass extends _$RawFutureClass { + @override + Raw> build() async { + return 'Hello world'; + } +} + +@riverpod +class RawStreamClass extends _$RawStreamClass { + @override + Raw> build() async* { + yield 'Hello world'; + } +} + +@riverpod +Raw> rawFamilyFuture(RawFamilyFutureRef ref, int id) async { + return 'Hello world'; +} + +@riverpod +Raw> rawFamilyStream(RawFamilyStreamRef ref, int id) async* { + yield 'Hello world'; +} + +@riverpod +class RawFamilyFutureClass extends _$RawFamilyFutureClass { + @override + Raw> build(int id) async { + return 'Hello world'; + } +} + +@riverpod +class RawFamilyStreamClass extends _$RawFamilyStreamClass { + @override + Raw> build(int id) async* { + yield 'Hello world'; + } +} + +/// This is some documentation +@riverpod +String public(PublicRef ref) { + return 'Hello world'; +} + +@riverpod +String supports$inNames(Supports$inNamesRef ref) { + return 'Hello world'; +} + +/// This is some documentation +@riverpod +String family( + FamilyRef ref, + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, +}) { + return '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)'; +} + +final privateProvider = _privateProvider; + +@riverpod +String _private(_PrivateRef ref) { + return 'Hello world'; +} + +/// This is some documentation +@riverpod +class PublicClass extends _$PublicClass { + PublicClass([this.param]); + + final Object? param; + + @override + String build() { + return 'Hello world'; + } +} + +final privateClassProvider = _privateClassProvider; + +@riverpod +class _PrivateClass extends _$PrivateClass { + @override + String build() { + return 'Hello world'; + } +} + +/// This is some documentation +@riverpod +class FamilyClass extends _$FamilyClass { + FamilyClass([this.param]); + + final Object? param; + + @override + String build( + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) { + return '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)'; + } +} + +@riverpod +class Supports$InClassName extends _$Supports$InClassName { + @override + String build() { + return 'Hello world'; + } +} + +@riverpod +String generated(GeneratedRef ref) { + return 'Just a simple normal generated provider'; +} + +r.Provider someProvider() => r.Provider((ref) => 'hello'); + +// Regression test for https://github.com/rrousselGit/riverpod/issues/2299 +final _someProvider = someProvider(); + +// Regression test for https://github.com/rrousselGit/riverpod/issues/2294 +// ignore: unused_element +final _other = _someProvider; diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart new file mode 100644 index 000000000..e568471a9 --- /dev/null +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -0,0 +1,1518 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'sync.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef GenericRef = Ref>; + +const genericProvider = GenericFamily._(); + +final class GenericProvider + extends $FunctionalProvider, List, GenericRef> + with $Provider, GenericRef> { + const GenericProvider._( + {required GenericFamily super.from, + List Function( + GenericRef ref, + )? create}) + : _createCb = create, + super( + argument: null, + debugGetCreateSourceHash: _$genericHash, + name: r'generic', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + GenericRef ref, + )? _createCb; + + @override + $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + List create(GenericRef ref) { + final fn = _createCb ?? generic; + + return fn( + ref, + ); + } + + @override + GenericProvider copyWithCreate( + List Function( + GenericRef ref, + ) create, + ) { + return GenericProvider._(from: from! as GenericFamily, create: create); + } + + @override + bool operator ==(Object other) { + return other is GenericProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } +} + +String _$genericHash() => r'0fda19dd377694315cdffd7414d53f98569c655c'; + +final class GenericFamily extends Family { + const GenericFamily._() + : super( + name: r'generic', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$genericHash, + isAutoDispose: true, + ); + + GenericProvider call() => GenericProvider._(from: this); + + @override + String toString() => r'generic'; +} + +typedef ComplexGenericRef = Ref>; + +const complexGenericProvider = ComplexGenericFamily._(); + +final class ComplexGenericProvider + extends $FunctionalProvider, List, ComplexGenericRef> + with $Provider, ComplexGenericRef> { + const ComplexGenericProvider._( + {required ComplexGenericFamily super.from, + required ({ + T param, + Foo? otherParam, + }) + super.argument, + List Function( + ComplexGenericRef ref, { + required T param, + Foo? otherParam, + })? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$complexGenericHash, + name: r'complexGeneric', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + ComplexGenericRef ref, { + required T param, + Foo? otherParam, + })? _createCb; + + @override + $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + List create(ComplexGenericRef ref) { + final fn = _createCb ?? complexGeneric; + final ({ + T param, + Foo? otherParam, + }) argument = this.argument! as ({ + T param, + Foo? otherParam, + }); + return fn( + ref, + param: argument.param, + otherParam: argument.otherParam, + ); + } + + @override + ComplexGenericProvider copyWithCreate( + List Function( + ComplexGenericRef ref, + ) create, + ) { + return ComplexGenericProvider._( + argument: argument! as ({ + T param, + Foo? otherParam, + }), + from: from! as ComplexGenericFamily, + create: ( + ref, { + required T param, + Foo? otherParam, + }) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is ComplexGenericProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } +} + +String _$complexGenericHash() => r'a5254e5552cd61bb8d65c018539ff2d8edfd5822'; + +final class ComplexGenericFamily extends Family { + const ComplexGenericFamily._() + : super( + name: r'complexGeneric', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$complexGenericHash, + isAutoDispose: true, + ); + + ComplexGenericProvider call({ + required T param, + Foo? otherParam, + }) => + ComplexGenericProvider._(argument: ( + param: param, + otherParam: otherParam, + ), from: this); + + @override + String toString() => r'complexGeneric'; +} + +typedef RawFutureRef = Ref>>; + +const rawFutureProvider = RawFutureProvider._(); + +final class RawFutureProvider extends $FunctionalProvider>, + Raw>, RawFutureRef> + with + $FutureModifier>>, + $FutureProvider>, RawFutureRef> { + const RawFutureProvider._( + {Raw> Function( + RawFutureRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$rawFutureHash, + name: r'rawFuture', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + RawFutureRef ref, + )? _createCb; + + @override + $FutureProviderElement>> createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + Raw> create(RawFutureRef ref) { + final fn = _createCb ?? rawFuture; + + return fn( + ref, + ); + } + + @override + RawFutureProvider copyWithCreate( + Raw> Function( + RawFutureRef ref, + ) create, + ) { + return RawFutureProvider._(create: create); + } +} + +String _$rawFutureHash() => r'5203a56065b768023770326281618e3229ccb530'; + +typedef RawStreamRef = Ref>>; + +const rawStreamProvider = RawStreamProvider._(); + +final class RawStreamProvider extends $FunctionalProvider>, + Raw>, RawStreamRef> + with + $FutureModifier>>, + $StreamProvider>, RawStreamRef> { + const RawStreamProvider._( + {Raw> Function( + RawStreamRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$rawStreamHash, + name: r'rawStream', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + RawStreamRef ref, + )? _createCb; + + @override + $StreamProviderElement>> createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + Raw> create(RawStreamRef ref) { + final fn = _createCb ?? rawStream; + + return fn( + ref, + ); + } + + @override + RawStreamProvider copyWithCreate( + Raw> Function( + RawStreamRef ref, + ) create, + ) { + return RawStreamProvider._(create: create); + } +} + +String _$rawStreamHash() => r'2b764189753a8b74f47ba557a79416f00ef5cebd'; + +typedef RawFamilyFutureRef = Ref>>; + +const rawFamilyFutureProvider = RawFamilyFutureFamily._(); + +final class RawFamilyFutureProvider extends $FunctionalProvider< + Raw>, Raw>, RawFamilyFutureRef> + with + $FutureModifier>>, + $FutureProvider>, RawFamilyFutureRef> { + const RawFamilyFutureProvider._( + {required RawFamilyFutureFamily super.from, + required (int,) super.argument, + Raw> Function( + RawFamilyFutureRef ref, + int id, + )? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$rawFamilyFutureHash, + name: r'rawFamilyFuture', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + RawFamilyFutureRef ref, + int id, + )? _createCb; + + @override + $FutureProviderElement>> createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + Raw> create(RawFamilyFutureRef ref) { + final fn = _createCb ?? rawFamilyFuture; + final (int,) argument = this.argument! as (int,); + return fn( + ref, + argument.$1, + ); + } + + @override + RawFamilyFutureProvider copyWithCreate( + Raw> Function( + RawFamilyFutureRef ref, + ) create, + ) { + return RawFamilyFutureProvider._( + argument: argument! as (int,), + from: from! as RawFamilyFutureFamily, + create: ( + ref, + int id, + ) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is RawFamilyFutureProvider && other.argument == argument; + } +} + +String _$rawFamilyFutureHash() => r'485f59512081852e51279658facc015309743864'; + +final class RawFamilyFutureFamily extends Family { + const RawFamilyFutureFamily._() + : super( + name: r'rawFamilyFuture', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$rawFamilyFutureHash, + isAutoDispose: true, + ); + + RawFamilyFutureProvider call( + int id, + ) => + RawFamilyFutureProvider._(argument: (id,), from: this); + + @override + String toString() => r'rawFamilyFuture'; +} + +typedef RawFamilyStreamRef = Ref>>; + +const rawFamilyStreamProvider = RawFamilyStreamFamily._(); + +final class RawFamilyStreamProvider extends $FunctionalProvider< + Raw>, Raw>, RawFamilyStreamRef> + with + $FutureModifier>>, + $StreamProvider>, RawFamilyStreamRef> { + const RawFamilyStreamProvider._( + {required RawFamilyStreamFamily super.from, + required (int,) super.argument, + Raw> Function( + RawFamilyStreamRef ref, + int id, + )? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$rawFamilyStreamHash, + name: r'rawFamilyStream', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + RawFamilyStreamRef ref, + int id, + )? _createCb; + + @override + $StreamProviderElement>> createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + Raw> create(RawFamilyStreamRef ref) { + final fn = _createCb ?? rawFamilyStream; + final (int,) argument = this.argument! as (int,); + return fn( + ref, + argument.$1, + ); + } + + @override + RawFamilyStreamProvider copyWithCreate( + Raw> Function( + RawFamilyStreamRef ref, + ) create, + ) { + return RawFamilyStreamProvider._( + argument: argument! as (int,), + from: from! as RawFamilyStreamFamily, + create: ( + ref, + int id, + ) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is RawFamilyStreamProvider && other.argument == argument; + } +} + +String _$rawFamilyStreamHash() => r'e778e5cfcb8ab381e2412f5c73213aaa03b93012'; + +final class RawFamilyStreamFamily extends Family { + const RawFamilyStreamFamily._() + : super( + name: r'rawFamilyStream', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$rawFamilyStreamHash, + isAutoDispose: true, + ); + + RawFamilyStreamProvider call( + int id, + ) => + RawFamilyStreamProvider._(argument: (id,), from: this); + + @override + String toString() => r'rawFamilyStream'; +} + +typedef PublicRef = Ref; + +const publicProvider = PublicProvider._(); + +final class PublicProvider + extends $FunctionalProvider + with $Provider { + const PublicProvider._( + {String Function( + PublicRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$publicHash, + name: r'public', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + PublicRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + String create(PublicRef ref) { + final fn = _createCb ?? public; + + return fn( + ref, + ); + } + + @override + PublicProvider copyWithCreate( + String Function( + PublicRef ref, + ) create, + ) { + return PublicProvider._(create: create); + } +} + +String _$publicHash() => r'138be35943899793ab085e711fe3f3d22696a3ba'; + +typedef Supports$inNamesRef = Ref; + +const supports$inNamesProvider = Supports$inNamesProvider._(); + +final class Supports$inNamesProvider + extends $FunctionalProvider + with $Provider { + const Supports$inNamesProvider._( + {String Function( + Supports$inNamesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$supports$inNamesHash, + name: r'supports$inNames', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + Supports$inNamesRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + String create(Supports$inNamesRef ref) { + final fn = _createCb ?? supports$inNames; + + return fn( + ref, + ); + } + + @override + Supports$inNamesProvider copyWithCreate( + String Function( + Supports$inNamesRef ref, + ) create, + ) { + return Supports$inNamesProvider._(create: create); + } +} + +String _$supports$inNamesHash() => r'cbf929802fcbd0aa949ad72743d096fb3ef5f28f'; + +typedef FamilyRef = Ref; + +const familyProvider = FamilyFamily._(); + +final class FamilyProvider + extends $FunctionalProvider + with $Provider { + const FamilyProvider._( + {required FamilyFamily super.from, + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, + String Function( + FamilyRef ref, + int first, { + String? second, + required double third, + bool fourth, + List? fifth, + })? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$familyHash, + name: r'family', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + FamilyRef ref, + int first, { + String? second, + required double third, + bool fourth, + List? fifth, + })? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + String create(FamilyRef ref) { + final fn = _createCb ?? family; + final ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) argument = this.argument! as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + return fn( + ref, + argument.$1, + second: argument.second, + third: argument.third, + fourth: argument.fourth, + fifth: argument.fifth, + ); + } + + @override + FamilyProvider copyWithCreate( + String Function( + FamilyRef ref, + ) create, + ) { + return FamilyProvider._( + argument: argument! as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), + from: from! as FamilyFamily, + create: ( + ref, + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is FamilyProvider && other.argument == argument; + } +} + +String _$familyHash() => r'14d1ee238ca608d547630d0e222ef4c5866e9e61'; + +final class FamilyFamily extends Family { + const FamilyFamily._() + : super( + name: r'family', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$familyHash, + isAutoDispose: true, + ); + + FamilyProvider call( + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) => + FamilyProvider._(argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), from: this); + + @override + String toString() => r'family'; +} + +typedef _PrivateRef = Ref; + +const _privateProvider = _PrivateProvider._(); + +final class _PrivateProvider + extends $FunctionalProvider + with $Provider { + const _PrivateProvider._( + {String Function( + _PrivateRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$privateHash, + name: r'_private', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + _PrivateRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + String create(_PrivateRef ref) { + final fn = _createCb ?? _private; + + return fn( + ref, + ); + } + + @override + _PrivateProvider copyWithCreate( + String Function( + _PrivateRef ref, + ) create, + ) { + return _PrivateProvider._(create: create); + } +} + +String _$privateHash() => r'519561bc7e88e394d7f75ca2102a5c0acc832c66'; + +typedef GeneratedRef = Ref; + +const generatedProvider = GeneratedProvider._(); + +final class GeneratedProvider + extends $FunctionalProvider + with $Provider { + const GeneratedProvider._( + {String Function( + GeneratedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$generatedHash, + name: r'generated', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + GeneratedRef ref, + )? _createCb; + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + String create(GeneratedRef ref) { + final fn = _createCb ?? generated; + + return fn( + ref, + ); + } + + @override + GeneratedProvider copyWithCreate( + String Function( + GeneratedRef ref, + ) create, + ) { + return GeneratedProvider._(create: create); + } +} + +String _$generatedHash() => r'fecbc1d5d9a05fc996b452a57fd1975ff368af91'; + +const genericClassProvider = GenericClassFamily._(); + +final class GenericClassProvider + extends $NotifierProvider, List> { + const GenericClassProvider._( + {required GenericClassFamily super.from, + super.runNotifierBuildOverride, + GenericClass Function()? create}) + : _createCb = create, + super( + argument: null, + debugGetCreateSourceHash: _$genericClassHash, + name: r'GenericClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final GenericClass Function()? _createCb; + + @$internal + @override + GenericClass create() => _createCb?.call() ?? GenericClass(); + + @$internal + @override + GenericClassProvider copyWithCreate( + GenericClass Function() create, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, create: create); + } + + @$internal + @override + GenericClassProvider copyWithBuild( + List Function(Ref>, GenericClass) build, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement, List> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is GenericClassProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } +} + +String _$genericClassHash() => r'671e348a5abf8e00ab06c5f247defbca8af9677b'; + +final class GenericClassFamily extends Family { + const GenericClassFamily._() + : super( + name: r'GenericClass', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$genericClassHash, + isAutoDispose: true, + ); + + GenericClassProvider call() => + GenericClassProvider._(from: this); + + @override + String toString() => r'GenericClass'; +} + +abstract class _$GenericClass extends $Notifier> { + List build(); + + @$internal + @override + List runBuild() => build(); +} + +const rawFutureClassProvider = RawFutureClassProvider._(); + +final class RawFutureClassProvider + extends $AsyncNotifierProvider>> { + const RawFutureClassProvider._( + {super.runNotifierBuildOverride, RawFutureClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$rawFutureClassHash, + name: r'RawFutureClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final RawFutureClass Function()? _createCb; + + @$internal + @override + RawFutureClass create() => _createCb?.call() ?? RawFutureClass(); + + @$internal + @override + RawFutureClassProvider copyWithCreate( + RawFutureClass Function() create, + ) { + return RawFutureClassProvider._(create: create); + } + + @$internal + @override + RawFutureClassProvider copyWithBuild( + Raw> Function(Ref>>, RawFutureClass) + build, + ) { + return RawFutureClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement>> + createElement(ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$rawFutureClassHash() => r'bf66f1cdbd99118b8845d206e6a2611b3101f45c'; + +abstract class _$RawFutureClass extends $AsyncNotifier>> { + Raw> build(); + + @$internal + @override + Raw> runBuild() => build(); +} + +const rawStreamClassProvider = RawStreamClassProvider._(); + +final class RawStreamClassProvider + extends $StreamNotifierProvider>> { + const RawStreamClassProvider._( + {super.runNotifierBuildOverride, RawStreamClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$rawStreamClassHash, + name: r'RawStreamClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final RawStreamClass Function()? _createCb; + + @$internal + @override + RawStreamClass create() => _createCb?.call() ?? RawStreamClass(); + + @$internal + @override + RawStreamClassProvider copyWithCreate( + RawStreamClass Function() create, + ) { + return RawStreamClassProvider._(create: create); + } + + @$internal + @override + RawStreamClassProvider copyWithBuild( + Raw> Function(Ref>>, RawStreamClass) + build, + ) { + return RawStreamClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $StreamNotifierProviderElement>> + createElement(ProviderContainer container) => + $StreamNotifierProviderElement(this, container); +} + +String _$rawStreamClassHash() => r'712cffcb2018cfb4ff45012c1aa6e43c8cbe9d5d'; + +abstract class _$RawStreamClass extends $StreamNotifier>> { + Raw> build(); + + @$internal + @override + Raw> runBuild() => build(); +} + +const rawFamilyFutureClassProvider = RawFamilyFutureClassFamily._(); + +final class RawFamilyFutureClassProvider + extends $AsyncNotifierProvider>> { + const RawFamilyFutureClassProvider._( + {required RawFamilyFutureClassFamily super.from, + required (int,) super.argument, + super.runNotifierBuildOverride, + RawFamilyFutureClass Function()? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$rawFamilyFutureClassHash, + name: r'RawFamilyFutureClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final RawFamilyFutureClass Function()? _createCb; + + @$internal + @override + RawFamilyFutureClass create() => _createCb?.call() ?? RawFamilyFutureClass(); + + @$internal + @override + RawFamilyFutureClassProvider copyWithCreate( + RawFamilyFutureClass Function() create, + ) { + return RawFamilyFutureClassProvider._( + argument: argument! as (int,), + from: from! as RawFamilyFutureClassFamily, + create: create); + } + + @$internal + @override + RawFamilyFutureClassProvider copyWithBuild( + Raw> Function(Ref>>, RawFamilyFutureClass) + build, + ) { + return RawFamilyFutureClassProvider._( + argument: argument! as (int,), + from: from! as RawFamilyFutureClassFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement>> + createElement(ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is RawFamilyFutureClassProvider && other.argument == argument; + } +} + +String _$rawFamilyFutureClassHash() => + r'd7cacb0f2c51697d107de6daa68b242c04085dca'; + +final class RawFamilyFutureClassFamily extends Family { + const RawFamilyFutureClassFamily._() + : super( + name: r'RawFamilyFutureClass', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$rawFamilyFutureClassHash, + isAutoDispose: true, + ); + + RawFamilyFutureClassProvider call( + int id, + ) => + RawFamilyFutureClassProvider._(argument: (id,), from: this); + + @override + String toString() => r'RawFamilyFutureClass'; +} + +abstract class _$RawFamilyFutureClass + extends $AsyncNotifier>> { + late final _$args = + (ref as $AsyncNotifierProviderElement).origin.argument as (int,); + int get id => _$args.$1; + + Raw> build( + int id, + ); + + @$internal + @override + Raw> runBuild() => build( + _$args.$1, + ); +} + +const rawFamilyStreamClassProvider = RawFamilyStreamClassFamily._(); + +final class RawFamilyStreamClassProvider + extends $StreamNotifierProvider>> { + const RawFamilyStreamClassProvider._( + {required RawFamilyStreamClassFamily super.from, + required (int,) super.argument, + super.runNotifierBuildOverride, + RawFamilyStreamClass Function()? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$rawFamilyStreamClassHash, + name: r'RawFamilyStreamClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final RawFamilyStreamClass Function()? _createCb; + + @$internal + @override + RawFamilyStreamClass create() => _createCb?.call() ?? RawFamilyStreamClass(); + + @$internal + @override + RawFamilyStreamClassProvider copyWithCreate( + RawFamilyStreamClass Function() create, + ) { + return RawFamilyStreamClassProvider._( + argument: argument! as (int,), + from: from! as RawFamilyStreamClassFamily, + create: create); + } + + @$internal + @override + RawFamilyStreamClassProvider copyWithBuild( + Raw> Function(Ref>>, RawFamilyStreamClass) + build, + ) { + return RawFamilyStreamClassProvider._( + argument: argument! as (int,), + from: from! as RawFamilyStreamClassFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $StreamNotifierProviderElement>> + createElement(ProviderContainer container) => + $StreamNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is RawFamilyStreamClassProvider && other.argument == argument; + } +} + +String _$rawFamilyStreamClassHash() => + r'321796a0befc43fb83f7ccfdcb6b011fc8c7c599'; + +final class RawFamilyStreamClassFamily extends Family { + const RawFamilyStreamClassFamily._() + : super( + name: r'RawFamilyStreamClass', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$rawFamilyStreamClassHash, + isAutoDispose: true, + ); + + RawFamilyStreamClassProvider call( + int id, + ) => + RawFamilyStreamClassProvider._(argument: (id,), from: this); + + @override + String toString() => r'RawFamilyStreamClass'; +} + +abstract class _$RawFamilyStreamClass + extends $StreamNotifier>> { + late final _$args = + (ref as $StreamNotifierProviderElement).origin.argument as (int,); + int get id => _$args.$1; + + Raw> build( + int id, + ); + + @$internal + @override + Raw> runBuild() => build( + _$args.$1, + ); +} + +const publicClassProvider = PublicClassProvider._(); + +final class PublicClassProvider extends $NotifierProvider { + const PublicClassProvider._( + {super.runNotifierBuildOverride, PublicClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$publicClassHash, + name: r'PublicClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final PublicClass Function()? _createCb; + + @$internal + @override + PublicClass create() => _createCb?.call() ?? PublicClass(); + + @$internal + @override + PublicClassProvider copyWithCreate( + PublicClass Function() create, + ) { + return PublicClassProvider._(create: create); + } + + @$internal + @override + PublicClassProvider copyWithBuild( + String Function(Ref, PublicClass) build, + ) { + return PublicClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$publicClassHash() => r'c8e7eec9e202acf8394e02496857cbe49405bf62'; + +abstract class _$PublicClass extends $Notifier { + String build(); + + @$internal + @override + String runBuild() => build(); +} + +const _privateClassProvider = _PrivateClassProvider._(); + +final class _PrivateClassProvider + extends $NotifierProvider<_PrivateClass, String> { + const _PrivateClassProvider._( + {super.runNotifierBuildOverride, _PrivateClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$privateClassHash, + name: r'_PrivateClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final _PrivateClass Function()? _createCb; + + @$internal + @override + _PrivateClass create() => _createCb?.call() ?? _PrivateClass(); + + @$internal + @override + _PrivateClassProvider copyWithCreate( + _PrivateClass Function() create, + ) { + return _PrivateClassProvider._(create: create); + } + + @$internal + @override + _PrivateClassProvider copyWithBuild( + String Function(Ref, _PrivateClass) build, + ) { + return _PrivateClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement<_PrivateClass, String> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$privateClassHash() => r'6d41def3ffdc1f79e593beaefb3304ce4b211a77'; + +abstract class _$PrivateClass extends $Notifier { + String build(); + + @$internal + @override + String runBuild() => build(); +} + +const familyClassProvider = FamilyClassFamily._(); + +final class FamilyClassProvider extends $NotifierProvider { + const FamilyClassProvider._( + {required FamilyClassFamily super.from, + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, + super.runNotifierBuildOverride, + FamilyClass Function()? create}) + : _createCb = create, + super( + debugGetCreateSourceHash: _$familyClassHash, + name: r'FamilyClass', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FamilyClass Function()? _createCb; + + @$internal + @override + FamilyClass create() => _createCb?.call() ?? FamilyClass(); + + @$internal + @override + FamilyClassProvider copyWithCreate( + FamilyClass Function() create, + ) { + return FamilyClassProvider._( + argument: argument! as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), + from: from! as FamilyClassFamily, + create: create); + } + + @$internal + @override + FamilyClassProvider copyWithBuild( + String Function(Ref, FamilyClass) build, + ) { + return FamilyClassProvider._( + argument: argument! as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), + from: from! as FamilyClassFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is FamilyClassProvider && other.argument == argument; + } +} + +String _$familyClassHash() => r'01e3b9cb4d6d0bf12a2284761b1a11819d97d249'; + +final class FamilyClassFamily extends Family { + const FamilyClassFamily._() + : super( + name: r'FamilyClass', + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: _$familyClassHash, + isAutoDispose: true, + ); + + FamilyClassProvider call( + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) => + FamilyClassProvider._(argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), from: this); + + @override + String toString() => r'FamilyClass'; +} + +abstract class _$FamilyClass extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + int get first => _$args.$1; + String? get second => _$args.second; + double get third => _$args.third; + bool get fourth => _$args.fourth; + List? get fifth => _$args.fifth; + + String build( + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }); + + @$internal + @override + String runBuild() => build( + _$args.$1, + second: _$args.second, + third: _$args.third, + fourth: _$args.fourth, + fifth: _$args.fifth, + ); +} + +const supports$InClassNameProvider = Supports$InClassNameProvider._(); + +final class Supports$InClassNameProvider + extends $NotifierProvider { + const Supports$InClassNameProvider._( + {super.runNotifierBuildOverride, Supports$InClassName Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$supports$InClassNameHash, + name: r'Supports$InClassName', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Supports$InClassName Function()? _createCb; + + @$internal + @override + Supports$InClassName create() => _createCb?.call() ?? Supports$InClassName(); + + @$internal + @override + Supports$InClassNameProvider copyWithCreate( + Supports$InClassName Function() create, + ) { + return Supports$InClassNameProvider._(create: create); + } + + @$internal + @override + Supports$InClassNameProvider copyWithBuild( + String Function(Ref, Supports$InClassName) build, + ) { + return Supports$InClassNameProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$supports$InClassNameHash() => + r'4e99f433d9cb3598faaf4d172edf9f28b9e68091'; + +abstract class _$Supports$InClassName extends $Notifier { + String build(); + + @$internal + @override + String runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 8b1d4c19a..3b8b3fa3f 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -191,7 +191,8 @@ mixin GeneratorRef on ProviderRef { Object? get value; } -class _GeneratorProviderElement extends ProviderElement with GeneratorRef { +class _GeneratorProviderElement extends $ProviderElement + with GeneratorRef { _GeneratorProviderElement(super.provider, super.container); @override From 15fc990396f60c85105c844b4baf910138daa3b2 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 12:58:08 +0100 Subject: [PATCH 153/387] Handle dependencies (mostly) --- .../legacy/change_notifier_provider.dart | 3 +- packages/riverpod/lib/riverpod.dart | 4 +- .../lib/src/core/override_with_value.dart | 7 +- .../lib/src/core/provider/provider.dart | 52 ++- .../src/providers/async_notifier/family.dart | 3 +- .../src/providers/async_notifier/orphan.dart | 3 +- .../lib/src/providers/future_provider.dart | 3 +- .../legacy/state_notifier_provider.dart | 3 +- .../src/providers/legacy/state_provider.dart | 3 +- .../lib/src/providers/notifier/family.dart | 3 +- .../lib/src/providers/notifier/orphan.dart | 3 +- .../riverpod/lib/src/providers/provider.dart | 2 +- .../src/providers/stream_notifier/family.dart | 3 +- .../src/providers/stream_notifier/orphan.dart | 3 +- .../lib/src/providers/stream_provider.dart | 3 +- .../lib/src/riverpod_generator.dart | 207 +++++++++- .../src/templates/class_based_provider.dart | 56 +-- .../lib/src/templates/family.dart | 11 +- .../lib/src/templates/family_back.dart | 86 +--- .../src/templates/functional_provider.dart | 3 +- .../lib/src/templates/hash.dart | 2 +- .../lib/src/templates/notifier.dart | 2 +- .../lib/src/templates/provider.dart | 29 +- .../lib/src/templates/provider_variable.dart | 5 +- .../lib/src/templates/ref.dart | 6 +- .../test/integration/async.g.dart | 30 ++ .../test/integration/auto_dispose.g.dart | 6 + .../test/integration/dependencies.dart | 10 + .../test/integration/dependencies.g.dart | 374 +++++++++++++++--- .../test/integration/dependencies2.g.dart | 110 ++++-- .../test/integration/generated.freezed.dart | 2 +- .../test/integration/generated.g.dart | 39 ++ .../test/integration/scopes.g.dart | 3 + .../test/integration/split.g.dart | 6 + .../test/integration/stream.g.dart | 24 ++ .../test/integration/sync.g.dart | 60 +++ 36 files changed, 895 insertions(+), 274 deletions(-) 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 index 425a00309..2fc7cdf30 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -90,7 +90,8 @@ abstract class ChangeNotifierProviderRef /// ``` final class ChangeNotifierProvider extends $FunctionalProvider> { + ChangeNotifierProviderRef> + with LegacyProviderEqualMixin { /// {@macro riverpod.change_notifier_provider} ChangeNotifierProvider( this._createFn, { diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index e604a687b..4059d1c40 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -42,7 +42,9 @@ export 'src/framework.dart' FutureModifierElement, RunNotifierBuild, $FunctionalProvider, - $ClassProvider; + $ClassProvider, + LegacyProviderEqualMixin; + export 'src/providers/async_notifier.dart' hide $AsyncNotifier, $AsyncNotifierProvider; // TODO changelog breaking: StateNotifier & co are no-longer exported from pkg:riverpod/riverpod.dart diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index c9688293a..dc6945313 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -5,7 +5,8 @@ part of '../framework.dart'; /// This is an implementation detail of `overrideWithValue`. @sealed @internal -final class ValueProvider extends ProviderBase { +final class ValueProvider extends ProviderBase + with LegacyProviderEqualMixin { /// Creates a [ValueProvider]. const ValueProvider(this._value) : super( @@ -18,7 +19,7 @@ final class ValueProvider extends ProviderBase { isAutoDispose: false, ); - final State _value; + final StateT _value; @override Iterable? get dependencies => null; @@ -27,7 +28,7 @@ final class ValueProvider extends ProviderBase { Set? get allTransitiveDependencies => null; @override - _ValueProviderElement createElement(ProviderContainer container) { + _ValueProviderElement createElement(ProviderContainer container) { return _ValueProviderElement(this, container); } } diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index 48ae0af67..2e553a8b1 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -100,6 +100,42 @@ abstract base class ProviderBase extends ProviderOrFamily @visibleForOverriding ProviderElementBase createElement(ProviderContainer container); + /// Do not use. + /// + /// An unimplemented method, for the sole purpose of forcing all + /// non-code-generators to apply a mixin that overrides ==/hashCode. + /// This is because `riverpod_generator` expects all generated providers + /// to not override ==/hashCode, for the sake of inserting providers in a + /// constant [Set]. + /// + /// At the same time, all non-generated providers must override ==/hashCode. + /// So to prevent forgetting to override ==/hashCode, this method is added. + /// This method is then expected to be implemented using [LegacyProviderEqualMixin] + void $unimplemented(); + + @override + String toString() { + var leading = ''; + if (from != null) { + leading = '($argument)'; + } + + String label; + if (name case final name?) { + label = name; + } else { + label = describeIdentity(this); + } + + return '$label$leading'; + } +} + +/// A mixin that implements ==/hashCode for providers that are not code-generated. +/// +/// See [ProviderBase.$unimplemented] for explanation. +@internal +base mixin LegacyProviderEqualMixin on ProviderBase { @override int get hashCode { if (from == null) return super.hashCode; @@ -118,19 +154,5 @@ abstract base class ProviderBase extends ProviderOrFamily } @override - String toString() { - var leading = ''; - if (from != null) { - leading = '($argument)'; - } - - String label; - if (name case final name?) { - label = name; - } else { - label = describeIdentity(this); - } - - return '$label$leading'; - } + void $unimplemented() {} } diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index cccdaa33d..b02ea6ef8 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -58,7 +58,8 @@ final class FamilyAsyncNotifierProvider< // NotifierT extends FamilyAsyncNotifier, StateT, ArgT> // - extends $AsyncNotifierProvider { + extends $AsyncNotifierProvider + with LegacyProviderEqualMixin> { /// An implementation detail of Riverpod const FamilyAsyncNotifierProvider._( this._createNotifier, { diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index b8a68e622..cfb06caa9 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -60,7 +60,8 @@ abstract class AsyncNotifier extends $AsyncNotifier { final class AsyncNotifierProvider< // NotifierT extends AsyncNotifier, StateT> // - extends $AsyncNotifierProvider { + extends $AsyncNotifierProvider + with LegacyProviderEqualMixin> { /// {@macro riverpod.async_notifier_provider} /// /// {@macro riverpod.async_notifier_provider_modifier} diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 131dfdebe..9567de20b 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -87,7 +87,8 @@ final class FutureProvider extends $FunctionalProvider< AsyncValue, FutureOr, FutureProviderRef> with $FutureModifier, - $FutureProvider> { + $FutureProvider>, + LegacyProviderEqualMixin> { /// {@macro riverpod.future_provider} FutureProvider( this._create, { diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index 93b2b96b6..da350035c 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -94,7 +94,8 @@ final class StateNotifierProvider< // extends $FunctionalProvider< // StateT, NotifierT, - StateNotifierProviderRef> { + StateNotifierProviderRef> + with LegacyProviderEqualMixin { /// {@macro riverpod.statenotifierprovider} StateNotifierProvider( this._create, { diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 2ff538a75..6bdc8d321 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -56,7 +56,8 @@ abstract class StateProviderRef implements Ref { /// } /// ``` final class StateProvider - extends $FunctionalProvider> { + extends $FunctionalProvider> + with LegacyProviderEqualMixin { /// {@macro riverpod.stateprovider} StateProvider( this._createFn, { diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index a54b04cc1..0a479a74a 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -23,7 +23,8 @@ abstract class FamilyNotifier extends $Notifier { /// [AutoDisposeNotifierProvider] at the same time. final class FamilyNotifierProvider // , StateT, ArgT> - extends $NotifierProvider { + extends $NotifierProvider + with LegacyProviderEqualMixin { /// An implementation detail of Riverpod const FamilyNotifierProvider._( super._createNotifier, { diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart index 86fa0fce8..706dbd644 100644 --- a/packages/riverpod/lib/src/providers/notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -77,7 +77,8 @@ abstract class Notifier extends $Notifier { } final class NotifierProvider, StateT> - extends $NotifierProvider { + extends $NotifierProvider + with LegacyProviderEqualMixin { /// {@macro riverpod.notifier_provider} /// /// {@macro riverpod.notifier_provider_modifier} diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 831920a79..a9193ad21 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -16,7 +16,7 @@ base mixin $Provider on ProviderBase { /// {@macro riverpod.provider} base class Provider extends $FunctionalProvider> - with $Provider> { + with $Provider>, LegacyProviderEqualMixin { /// {@macro riverpod.provider} // TODO make all providers const under all variations Provider( diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index 555f71b96..b73bee07f 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -30,7 +30,8 @@ final class FamilyStreamNotifierProvider< // NotifierT extends FamilyStreamNotifier, StateT, ArgT> // - extends $StreamNotifierProvider { + extends $StreamNotifierProvider + with LegacyProviderEqualMixin> { /// An implementation detail of Riverpod const FamilyStreamNotifierProvider._( super._createNotifier, { diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index 6dd32fefd..6cffbc001 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -47,7 +47,8 @@ abstract class StreamNotifier extends $StreamNotifier { final class StreamNotifierProvider< // NotifierT extends StreamNotifier, StateT> // - extends $StreamNotifierProvider { + extends $StreamNotifierProvider + with LegacyProviderEqualMixin> { /// {@macro riverpod.async_notifier_provider} /// /// {@macro riverpod.async_notifier_provider_modifier} diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index 569c02056..e9905d46b 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -76,7 +76,8 @@ base class StreamProvider extends $FunctionalProvider< AsyncValue, Stream, Ref>> with $FutureModifier, - $StreamProvider>> { + $StreamProvider>>, + LegacyProviderEqualMixin> { /// {@macro riverpod.stream_provider} StreamProvider( this._create, { diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index d6979eaf5..ea5b3fc8d 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -12,9 +12,11 @@ import 'parse_generator.dart'; import 'templates/family.dart'; import 'templates/hash.dart'; import 'templates/notifier.dart'; +import 'templates/parameters.dart'; import 'templates/provider.dart'; import 'templates/provider_variable.dart'; import 'templates/ref.dart'; +import 'type.dart'; const riverpodTypeChecker = TypeChecker.fromRuntime(Riverpod); @@ -112,10 +114,75 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { void visitGeneratorProviderDeclaration( GeneratorProviderDeclaration provider, ) { + final allTransitiveDependencies = + _computeAllTransitiveDependencies(provider); + ProviderVariableTemplate(provider, options).run(buffer); - ProviderTemplate(provider, options).run(buffer); + ProviderTemplate( + provider, + options, + allTransitiveDependencies: allTransitiveDependencies, + ).run(buffer); HashFnTemplate(provider).run(buffer); - FamilyTemplate(provider, options).run(buffer); + FamilyTemplate( + provider, + options, + allTransitiveDependencies: allTransitiveDependencies, + ).run(buffer); + } + + List? _computeAllTransitiveDependencies( + GeneratorProviderDeclaration provider, + ) { + // TODO throw if a dependency is not accessible in the current library. + final dependencies = provider.annotation.dependencies?.dependencies; + if (dependencies == null) return null; + + final allTransitiveDependencies = []; + + Iterable + computeAllTransitiveDependencies( + GeneratorProviderDeclarationElement provider, + ) sync* { + final deps = provider.annotation.dependencies; + if (deps == null) return; + + final uniqueDependencies = {}; + + for (final transitiveDependency in deps) { + if (!uniqueDependencies.add(transitiveDependency)) continue; + yield transitiveDependency; + yield* computeAllTransitiveDependencies(transitiveDependency); + } + } + + final uniqueDependencies = {}; + for (final dependency in dependencies) { + if (!uniqueDependencies.add(dependency.provider)) continue; + + // TODO verify that the provider is accessible in the current library + allTransitiveDependencies.add(dependency.provider.providerName(options)); + + final uniqueTransitiveDependencies = + computeAllTransitiveDependencies(dependency.provider) + // Since generated code trims duplicate dependencies, + // we have to trim them back when parsing the dependencies to + // keep the index correct. + .toSet() + .indexed; + + for (final (index, transitiveDependency) + in uniqueTransitiveDependencies) { + if (!uniqueDependencies.add(transitiveDependency)) continue; + + // TODO verify that the provider is accessible in the current library + allTransitiveDependencies.add( + '${dependency.provider.providerTypeName}.\$allTransitiveDependencies$index', + ); + } + } + + return allTransitiveDependencies; } @override @@ -136,3 +203,139 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { visitGeneratorProviderDeclaration(provider); } } + +extension ProviderElementNames on GeneratorProviderDeclarationElement { + String providerName(BuildYamlOptions options) { + return '${name.lowerFirst}${options.providerNameSuffix ?? 'Provider'}'; + } + + String get providerTypeName => '${name.titled}Provider'; + String get refImplName => '${name.titled}Ref'; + String get familyTypeName => '${name.titled}Family'; + + String dependencies(BuildYamlOptions options) { + final dependencies = annotation.dependencies; + if (dependencies == null) return 'null'; + + final buffer = StringBuffer('const '); + buffer.write('['); + + buffer.writeAll( + dependencies.map((e) => e.providerName(options)), + ',', + ); + + buffer.write(']'); + return buffer.toString(); + } + + String allTransitiveDependencies(List? allTransitiveDependencies) { + if (allTransitiveDependencies == null) return 'null'; + + final buffer = StringBuffer('const '); + if (allTransitiveDependencies.length < 4) { + buffer.write('['); + } else { + buffer.write('{'); + } + + for (var i = 0; i < allTransitiveDependencies.length; i++) { + buffer.write('$providerTypeName.\$allTransitiveDependencies$i,'); + } + + if (allTransitiveDependencies.length < 4) { + buffer.write(']'); + } else { + buffer.write('}'); + } + + return buffer.toString(); + } +} + +extension ProviderNames on GeneratorProviderDeclaration { + String providerName(BuildYamlOptions options) { + return providerElement.providerName(options); + } + + String get providerTypeName => providerElement.providerTypeName; + String get refImplName => providerElement.refImplName; + String get familyTypeName => providerElement.familyTypeName; + + // TODO possibly no-longer needed + String dependencies(BuildYamlOptions options) => + providerElement.dependencies(options); + // TODO possibly no-longer needed + String allTransitiveDependencies(List? allTransitiveDependencies) { + return providerElement.allTransitiveDependencies(allTransitiveDependencies); + } + + TypeParameterList? get typeParameters => switch (this) { + final FunctionalProviderDeclaration p => + p.node.functionExpression.typeParameters, + final ClassBasedProviderDeclaration p => p.node.typeParameters + }; + + String generics() => _genericUsageDisplayString(typeParameters); + String genericsDefinition() => + _genericDefinitionDisplayString(typeParameters); + + String createType({bool withArguments = true}) { + final generics = this.generics(); + + final provider = this; + switch (provider) { + case FunctionalProviderDeclaration(): + final params = withArguments + ? buildParamDefinitionQuery( + parameters, + withDefaults: false, + ) + : ''; + + final refType = '${provider.refImplName}$generics'; + return '${provider.createdTypeDisplayString} Function($refType ref, $params)'; + case ClassBasedProviderDeclaration(): + return '${provider.name}$generics Function()'; + } + } + + String get elementName => switch (this) { + ClassBasedProviderDeclaration() => switch (createdType) { + SupportedCreatedType.future => r'$AsyncNotifierProviderElement', + SupportedCreatedType.stream => r'$StreamNotifierProviderElement', + SupportedCreatedType.value => r'$NotifierProviderElement', + }, + FunctionalProviderDeclaration() => switch (createdType) { + SupportedCreatedType.future => r'$FutureProviderElement', + SupportedCreatedType.stream => r'$StreamProviderElement', + SupportedCreatedType.value => r'$ProviderElement', + }, + }; + + String get hashFnName => '_\$${providerElement.name.public.lowerFirst}Hash'; + + List get parameters { + final provider = this; + switch (provider) { + case FunctionalProviderDeclaration(): + return provider.node.functionExpression.parameters!.parameters + .skip(1) + .toList(); + case ClassBasedProviderDeclaration(): + return provider.buildMethod.parameters!.parameters.toList(); + } + } +} + +String _genericDefinitionDisplayString(TypeParameterList? typeParameters) { + return typeParameters?.toSource() ?? ''; +} + +String _genericUsageDisplayString(TypeParameterList? typeParameterList) { + if (typeParameterList == null) { + return ''; + } + + return '<${typeParameterList.typeParameters.map((e) => e.name.lexeme).join(', ')}>'; +} diff --git a/packages/riverpod_generator/lib/src/templates/class_based_provider.dart b/packages/riverpod_generator/lib/src/templates/class_based_provider.dart index b33ce5aba..7536df004 100644 --- a/packages/riverpod_generator/lib/src/templates/class_based_provider.dart +++ b/packages/riverpod_generator/lib/src/templates/class_based_provider.dart @@ -1,59 +1,9 @@ import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import '../models.dart'; import '../riverpod_generator.dart'; +import 'family_back.dart'; import 'template.dart'; -String providerNameFor( - ProviderDeclarationElement provider, - BuildYamlOptions options, -) { - return '${provider.name.lowerFirst}${options.providerNameSuffix ?? 'Provider'}'; -} - -String serializeDependencies( - RiverpodAnnotationElement annotation, - BuildYamlOptions options, -) { - final dependencies = annotation.dependencies; - if (dependencies == null) return 'null'; - - final buffer = StringBuffer('const '); - buffer.write('['); - - buffer.writeAll( - dependencies.map((e) => providerNameFor(e, options)), - ',', - ); - - buffer.write(']'); - return buffer.toString(); -} - -String serializeAllTransitiveDependencies( - RiverpodAnnotationElement annotation, - BuildYamlOptions options, -) { - // Not optimizing based off "allTransitiveDependencies" yet due to https://github.com/dart-lang/language/issues/3037 - // This could be worked around by having the "Provider" type expose - // the transitive dependencies. - // But this assumes that all providers have their custom Provider class. - final dependencies = annotation.dependencies; - if (dependencies == null) return 'null'; - - final buffer = StringBuffer('const '); - - buffer.write('['); - buffer.writeAll( - dependencies - .map((e) => providerNameFor(e, options)) - .map((e) => '$e, ...?$e.allTransitiveDependencies'), - ',', - ); - buffer.write(']'); - - return buffer.toString(); -} - class ClassBasedProviderTemplate extends Template { ClassBasedProviderTemplate( this.provider, { @@ -106,8 +56,8 @@ final $providerName = $providerType<${provider.name}, ${provider.valueTypeDispla argument: null, $isAutoDispose debugGetCreateSourceHash: $hashFn, - dependencies: ${serializeDependencies(provider.providerElement.annotation, options)}, - allTransitiveDependencies: ${serializeAllTransitiveDependencies(provider.providerElement.annotation, options)}, + dependencies: ${provider.dependencies(options)}, + allTransitiveDependencies: null, ); typedef $notifierTypedefName = $notifierBaseType<${provider.valueTypeDisplayString}>; diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 9507a92cb..cf6dd0474 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -1,15 +1,20 @@ import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import '../models.dart'; -import 'family_back.dart'; +import '../riverpod_generator.dart'; import 'parameters.dart'; import 'template.dart'; class FamilyTemplate extends Template { - FamilyTemplate(this.provider, this.options); + FamilyTemplate( + this.provider, + this.options, { + required this.allTransitiveDependencies, + }); final GeneratorProviderDeclaration provider; final BuildYamlOptions options; + final List? allTransitiveDependencies; @override void run(StringBuffer buffer) { @@ -36,7 +41,7 @@ final class ${provider.familyTypeName} extends Family{ : super( name: r'${provider.name}', dependencies: ${provider.dependencies(options)}, - allTransitiveDependencies: ${provider.allTransitiveDependencies(options)}, + allTransitiveDependencies: ${provider.allTransitiveDependencies(allTransitiveDependencies)}, debugGetCreateSourceHash: ${provider.hashFnName}, ${provider.providerElement.isAutoDispose ? 'isAutoDispose: true,' : ''} ); diff --git a/packages/riverpod_generator/lib/src/templates/family_back.dart b/packages/riverpod_generator/lib/src/templates/family_back.dart index 5465808ad..987c08b51 100644 --- a/packages/riverpod_generator/lib/src/templates/family_back.dart +++ b/packages/riverpod_generator/lib/src/templates/family_back.dart @@ -16,18 +16,6 @@ String providerFamilyNameFor( return '${provider.name.lowerFirst}${options.providerFamilyNameSuffix ?? options.providerNameSuffix ?? 'Provider'}'; } -String genericDefinitionDisplayString(TypeParameterList? typeParameters) { - return typeParameters?.toSource() ?? ''; -} - -String genericUsageDisplayString(TypeParameterList? typeParameterList) { - if (typeParameterList == null) { - return ''; - } - - return '<${typeParameterList.typeParameters.map((e) => e.name.lexeme).join(', ')}>'; -} - class FamilyTemplate extends Template { FamilyTemplate._( this.provider, { @@ -282,9 +270,9 @@ final class $familyName extends Family { ${isAutoDispose ? 'isAutoDispose: true,' : ''} ); - static $dependenciesKeyword _dependencies = ${serializeDependencies(provider.providerElement.annotation, options)}; + static $dependenciesKeyword _dependencies = ${provider.dependencies(options)}; - static $dependenciesKeyword _allTransitiveDependencies = ${serializeAllTransitiveDependencies(provider.providerElement.annotation, options)}; + static $dependenciesKeyword _allTransitiveDependencies = ${null}; $docs $providerTypeNameImpl$typeParametersUsage call$typeParametersDefinition($parameterDefinition) { @@ -367,73 +355,3 @@ ${parameters.map((e) => '@override ${e.typeDisplayString} get ${e.name} => (orig '''); } } - -extension ProviderNames on GeneratorProviderDeclaration { - String get providerTypeName => '${providerElement.name.titled}Provider'; - - String get refImplName => '${providerElement.name.titled}Ref'; - - String get familyTypeName => '${providerElement.name.titled}Family'; - - TypeParameterList? get typeParameters => switch (this) { - final FunctionalProviderDeclaration p => - p.node.functionExpression.typeParameters, - final ClassBasedProviderDeclaration p => p.node.typeParameters - }; - - String generics() => genericUsageDisplayString(typeParameters); - String genericsDefinition() => genericDefinitionDisplayString(typeParameters); - - String createType({bool withArguments = true}) { - final generics = this.generics(); - - final provider = this; - switch (provider) { - case FunctionalProviderDeclaration(): - final params = withArguments - ? buildParamDefinitionQuery( - parameters, - withDefaults: false, - ) - : ''; - - final refType = '${provider.refImplName}$generics'; - return '${provider.createdTypeDisplayString} Function($refType ref, $params)'; - case ClassBasedProviderDeclaration(): - return '${provider.name}$generics Function()'; - } - } - - String get elementName => switch (this) { - ClassBasedProviderDeclaration() => switch (createdType) { - SupportedCreatedType.future => r'$AsyncNotifierProviderElement', - SupportedCreatedType.stream => r'$StreamNotifierProviderElement', - SupportedCreatedType.value => r'$NotifierProviderElement', - }, - FunctionalProviderDeclaration() => switch (createdType) { - SupportedCreatedType.future => r'$FutureProviderElement', - SupportedCreatedType.stream => r'$StreamProviderElement', - SupportedCreatedType.value => r'$ProviderElement', - }, - }; - - String get hashFnName => '_\$${providerElement.name.public.lowerFirst}Hash'; - - List get parameters { - final provider = this; - switch (provider) { - case FunctionalProviderDeclaration(): - return provider.node.functionExpression.parameters!.parameters - .skip(1) - .toList(); - case ClassBasedProviderDeclaration(): - return provider.buildMethod.parameters!.parameters.toList(); - } - } - - String dependencies(BuildYamlOptions options) => - serializeDependencies(providerElement.annotation, options); - - String allTransitiveDependencies(BuildYamlOptions options) => - serializeAllTransitiveDependencies(providerElement.annotation, options); -} diff --git a/packages/riverpod_generator/lib/src/templates/functional_provider.dart b/packages/riverpod_generator/lib/src/templates/functional_provider.dart index 8ffbaa5bd..4c1ca9137 100644 --- a/packages/riverpod_generator/lib/src/templates/functional_provider.dart +++ b/packages/riverpod_generator/lib/src/templates/functional_provider.dart @@ -1,7 +1,6 @@ import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import '../models.dart'; import '../riverpod_generator.dart'; -import 'class_based_provider.dart'; import 'template.dart'; class FunctionalProviderTemplate extends Template { @@ -45,7 +44,7 @@ class FunctionalProviderTemplate extends Template { } } - final providerName = providerNameFor(provider.providerElement, options); + final providerName = provider.providerName(options); final createFn = provider.node.externalKeyword == null ? provider.providerElement.name diff --git a/packages/riverpod_generator/lib/src/templates/hash.dart b/packages/riverpod_generator/lib/src/templates/hash.dart index e99830a1b..71a5946d9 100644 --- a/packages/riverpod_generator/lib/src/templates/hash.dart +++ b/packages/riverpod_generator/lib/src/templates/hash.dart @@ -1,6 +1,6 @@ import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; -import 'family_back.dart'; +import '../riverpod_generator.dart'; import 'template.dart'; class HashFnTemplate extends Template { diff --git a/packages/riverpod_generator/lib/src/templates/notifier.dart b/packages/riverpod_generator/lib/src/templates/notifier.dart index a3bd74ca4..170918c38 100644 --- a/packages/riverpod_generator/lib/src/templates/notifier.dart +++ b/packages/riverpod_generator/lib/src/templates/notifier.dart @@ -1,8 +1,8 @@ import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import '../models.dart'; +import '../riverpod_generator.dart'; import '../type.dart'; -import 'family_back.dart'; import 'parameters.dart'; import 'template.dart'; diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 5b605a5d5..e426b7321 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -1,16 +1,21 @@ import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import '../models.dart'; +import '../riverpod_generator.dart'; import '../type.dart'; -import 'family_back.dart'; import 'parameters.dart'; import 'template.dart'; class ProviderTemplate extends Template { - ProviderTemplate(this.provider, this.options); + ProviderTemplate( + this.provider, + this.options, { + required this.allTransitiveDependencies, + }); final GeneratorProviderDeclaration provider; final BuildYamlOptions options; + final List? allTransitiveDependencies; late final _argumentRecordType = buildParamDefinitionQuery( provider.parameters, @@ -116,16 +121,34 @@ final class $name$_genericsDefinition name: r'${provider.name}', isAutoDispose: ${!provider.annotation.element.keepAlive}, dependencies: ${!provider.providerElement.isFamily ? provider.dependencies(options) : 'null'}, - allTransitiveDependencies: ${!provider.providerElement.isFamily ? provider.allTransitiveDependencies(options) : 'null'}, + allTransitiveDependencies: ${!provider.providerElement.isFamily ? provider.allTransitiveDependencies(allTransitiveDependencies) : 'null'}, ); '''); } + void _writeDependencies(StringBuffer buffer) { + final allTransitiveDependencies = this.allTransitiveDependencies; + if (allTransitiveDependencies == null) return; + + for (final (index, transitiveDependency) + in allTransitiveDependencies.indexed) { + buffer.writeln( + 'static const \$allTransitiveDependencies$index = $transitiveDependency;', + ); + } + + buffer.writeln(); + } + void _writeMembers(StringBuffer buffer) { _writeConstructor(buffer); + _writeDependencies(buffer); buffer.writeln(''' final ${provider.createType()}? _createCb; + + @override + void \$unimplemented() {} '''); final localArgumentDefinition = provider.parameters.isNotEmpty diff --git a/packages/riverpod_generator/lib/src/templates/provider_variable.dart b/packages/riverpod_generator/lib/src/templates/provider_variable.dart index d5abbfc86..81833b778 100644 --- a/packages/riverpod_generator/lib/src/templates/provider_variable.dart +++ b/packages/riverpod_generator/lib/src/templates/provider_variable.dart @@ -1,8 +1,7 @@ import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import '../models.dart'; -import 'class_based_provider.dart'; -import 'family_back.dart'; +import '../riverpod_generator.dart'; import 'template.dart'; class ProviderVariableTemplate extends Template { @@ -13,7 +12,7 @@ class ProviderVariableTemplate extends Template { @override void run(StringBuffer buffer) { - final providerName = providerNameFor(provider.providerElement, options); + final providerName = provider.providerName(options); switch (provider) { case _ when provider.providerElement.isFamily: diff --git a/packages/riverpod_generator/lib/src/templates/ref.dart b/packages/riverpod_generator/lib/src/templates/ref.dart index 39646e127..6762a76b6 100644 --- a/packages/riverpod_generator/lib/src/templates/ref.dart +++ b/packages/riverpod_generator/lib/src/templates/ref.dart @@ -1,6 +1,6 @@ import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; -import 'family_back.dart'; +import '../riverpod_generator.dart'; import 'template.dart'; class RefTemplate extends Template { @@ -10,9 +10,7 @@ class RefTemplate extends Template { @override void run(StringBuffer buffer) { - final typeParameters = provider.node.functionExpression.typeParameters; - final typeParametersDefinition = - genericDefinitionDisplayString(typeParameters); + final typeParametersDefinition = provider.genericsDefinition(); buffer.writeln(''' typedef ${provider.refImplName}$typeParametersDefinition = Ref<${provider.exposedTypeDisplayString}>; diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 85291533f..9eebb5fa2 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -32,6 +32,9 @@ final class GenericProvider extends $FunctionalProvider< GenericRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $FutureProviderElement> createElement(ProviderContainer container) => $FutureProviderElement(this, container); @@ -106,6 +109,9 @@ final class PublicProvider PublicRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $FutureProviderElement createElement(ProviderContainer container) => $FutureProviderElement(this, container); @@ -157,6 +163,9 @@ final class _PrivateProvider extends $FunctionalProvider, _PrivateRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $FutureProviderElement createElement(ProviderContainer container) => $FutureProviderElement(this, container); @@ -210,6 +219,9 @@ final class FamilyOrProvider extends $FunctionalProvider, int first, )? _createCb; + @override + void $unimplemented() {} + @override $FutureProviderElement createElement(ProviderContainer container) => $FutureProviderElement(this, container); @@ -310,6 +322,9 @@ final class FamilyProvider List? fifth, })? _createCb; + @override + void $unimplemented() {} + @override $FutureProviderElement createElement(ProviderContainer container) => $FutureProviderElement(this, container); @@ -423,6 +438,9 @@ final class GenericClassProvider final GenericClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override GenericClass create() => _createCb?.call() ?? GenericClass(); @@ -505,6 +523,9 @@ final class PublicClassProvider final PublicClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override PublicClass create() => _createCb?.call() ?? PublicClass(); @@ -561,6 +582,9 @@ final class _PrivateClassProvider final _PrivateClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override _PrivateClass create() => _createCb?.call() ?? _PrivateClass(); @@ -618,6 +642,9 @@ final class FamilyOrClassProvider final FamilyOrClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override FamilyOrClass create() => _createCb?.call() ?? FamilyOrClass(); @@ -720,6 +747,9 @@ final class FamilyClassProvider final FamilyClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override FamilyClass create() => _createCb?.call() ?? FamilyClass(); diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 5649fd839..2839450dc 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -32,6 +32,9 @@ final class KeepAliveProvider KeepAliveRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -83,6 +86,9 @@ final class NotKeepAliveProvider NotKeepAliveRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); diff --git a/packages/riverpod_generator/test/integration/dependencies.dart b/packages/riverpod_generator/test/integration/dependencies.dart index b90e3d13e..e87eb23bd 100644 --- a/packages/riverpod_generator/test/integration/dependencies.dart +++ b/packages/riverpod_generator/test/integration/dependencies.dart @@ -63,3 +63,13 @@ int _privateDep(_PrivateDepRef ref) => 0; @riverpod int publicDep(PublicDepRef ref) => 0; + +@Riverpod(dependencies: [dep, dep, Dep2, Dep2]) +int duplicateDependencies(DuplicateDependenciesRef ref) => 0; + +@Riverpod(dependencies: [family, family, Family2, Family2]) +int duplicateDependencies2(DuplicateDependencies2Ref ref) => 0; + +@Riverpod(dependencies: [duplicateDependencies, duplicateDependencies2]) +int transitiveDuplicateDependencies(TransitiveDuplicateDependenciesRef ref) => + 0; diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index e2ec7cf69..faa8ed5f6 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -31,6 +31,9 @@ final class DepProvider extends $FunctionalProvider DepRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -83,6 +86,9 @@ final class FamilyProvider extends $FunctionalProvider int id, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -163,22 +169,26 @@ final class ProviderProvider extends $FunctionalProvider dep2Provider, family2Provider ], - allTransitiveDependencies: const [ - depProvider, - ...?depProvider.allTransitiveDependencies, - familyProvider, - ...?familyProvider.allTransitiveDependencies, - dep2Provider, - ...?dep2Provider.allTransitiveDependencies, - family2Provider, - ...?family2Provider.allTransitiveDependencies - ], + allTransitiveDependencies: const { + ProviderProvider.$allTransitiveDependencies0, + ProviderProvider.$allTransitiveDependencies1, + ProviderProvider.$allTransitiveDependencies2, + ProviderProvider.$allTransitiveDependencies3, + }, ); + static const $allTransitiveDependencies0 = depProvider; + static const $allTransitiveDependencies1 = familyProvider; + static const $allTransitiveDependencies2 = dep2Provider; + static const $allTransitiveDependencies3 = family2Provider; + final int Function( ProviderRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -228,22 +238,26 @@ final class Provider2Provider dep2Provider, family2Provider ], - allTransitiveDependencies: const [ - depProvider, - ...?depProvider.allTransitiveDependencies, - familyProvider, - ...?familyProvider.allTransitiveDependencies, - dep2Provider, - ...?dep2Provider.allTransitiveDependencies, - family2Provider, - ...?family2Provider.allTransitiveDependencies - ], + allTransitiveDependencies: const { + Provider2Provider.$allTransitiveDependencies0, + Provider2Provider.$allTransitiveDependencies1, + Provider2Provider.$allTransitiveDependencies2, + Provider2Provider.$allTransitiveDependencies3, + }, ); + static const $allTransitiveDependencies0 = depProvider; + static const $allTransitiveDependencies1 = familyProvider; + static const $allTransitiveDependencies2 = dep2Provider; + static const $allTransitiveDependencies3 = family2Provider; + final int Function( Provider2Ref ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -288,16 +302,32 @@ final class TransitiveDependenciesProvider name: r'transitiveDependencies', isAutoDispose: true, dependencies: const [providerProvider], - allTransitiveDependencies: const [ - providerProvider, - ...?providerProvider.allTransitiveDependencies - ], + allTransitiveDependencies: const { + TransitiveDependenciesProvider.$allTransitiveDependencies0, + TransitiveDependenciesProvider.$allTransitiveDependencies1, + TransitiveDependenciesProvider.$allTransitiveDependencies2, + TransitiveDependenciesProvider.$allTransitiveDependencies3, + TransitiveDependenciesProvider.$allTransitiveDependencies4, + }, ); + static const $allTransitiveDependencies0 = providerProvider; + static const $allTransitiveDependencies1 = + ProviderProvider.$allTransitiveDependencies0; + static const $allTransitiveDependencies2 = + ProviderProvider.$allTransitiveDependencies1; + static const $allTransitiveDependencies3 = + ProviderProvider.$allTransitiveDependencies2; + static const $allTransitiveDependencies4 = + ProviderProvider.$allTransitiveDependencies3; + final int Function( TransitiveDependenciesRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -349,19 +379,23 @@ final class SmallTransitiveDependencyCountProvider dep2Provider ], allTransitiveDependencies: const [ - depProvider, - ...?depProvider.allTransitiveDependencies, - familyProvider, - ...?familyProvider.allTransitiveDependencies, - dep2Provider, - ...?dep2Provider.allTransitiveDependencies + SmallTransitiveDependencyCountProvider.$allTransitiveDependencies0, + SmallTransitiveDependencyCountProvider.$allTransitiveDependencies1, + SmallTransitiveDependencyCountProvider.$allTransitiveDependencies2, ], ); + static const $allTransitiveDependencies0 = depProvider; + static const $allTransitiveDependencies1 = familyProvider; + static const $allTransitiveDependencies2 = dep2Provider; + final int Function( SmallTransitiveDependencyCountRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -415,6 +449,9 @@ final class EmptyDependenciesFunctionalProvider EmptyDependenciesFunctionalRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -464,17 +501,21 @@ final class ProviderWithDependenciesProvider publicDepProvider ], allTransitiveDependencies: const [ - _privateDepProvider, - ...?_privateDepProvider.allTransitiveDependencies, - publicDepProvider, - ...?publicDepProvider.allTransitiveDependencies + ProviderWithDependenciesProvider.$allTransitiveDependencies0, + ProviderWithDependenciesProvider.$allTransitiveDependencies1, ], ); + static const $allTransitiveDependencies0 = _privateDepProvider; + static const $allTransitiveDependencies1 = publicDepProvider; + final int Function( ProviderWithDependenciesRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -527,6 +568,9 @@ final class _PrivateDepProvider _PrivateDepRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -578,6 +622,9 @@ final class PublicDepProvider PublicDepRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -603,6 +650,208 @@ final class PublicDepProvider String _$publicDepHash() => r'bcb69aace017c86c3c4b8eccf59fa22d010834bc'; +typedef DuplicateDependenciesRef = Ref; + +const duplicateDependenciesProvider = DuplicateDependenciesProvider._(); + +final class DuplicateDependenciesProvider + extends $FunctionalProvider + with $Provider { + const DuplicateDependenciesProvider._( + {int Function( + DuplicateDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$duplicateDependenciesHash, + name: r'duplicateDependencies', + isAutoDispose: true, + dependencies: const [depProvider, dep2Provider], + allTransitiveDependencies: const [ + DuplicateDependenciesProvider.$allTransitiveDependencies0, + DuplicateDependenciesProvider.$allTransitiveDependencies1, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + static const $allTransitiveDependencies1 = dep2Provider; + + final int Function( + DuplicateDependenciesRef ref, + )? _createCb; + + @override + void $unimplemented() {} + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(DuplicateDependenciesRef ref) { + final fn = _createCb ?? duplicateDependencies; + + return fn( + ref, + ); + } + + @override + DuplicateDependenciesProvider copyWithCreate( + int Function( + DuplicateDependenciesRef ref, + ) create, + ) { + return DuplicateDependenciesProvider._(create: create); + } +} + +String _$duplicateDependenciesHash() => + r'8e4c4b40d7500e97e8490874d48cc960c64af712'; + +typedef DuplicateDependencies2Ref = Ref; + +const duplicateDependencies2Provider = DuplicateDependencies2Provider._(); + +final class DuplicateDependencies2Provider + extends $FunctionalProvider + with $Provider { + const DuplicateDependencies2Provider._( + {int Function( + DuplicateDependencies2Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$duplicateDependencies2Hash, + name: r'duplicateDependencies2', + isAutoDispose: true, + dependencies: const [ + familyProvider, + family2Provider + ], + allTransitiveDependencies: const [ + DuplicateDependencies2Provider.$allTransitiveDependencies0, + DuplicateDependencies2Provider.$allTransitiveDependencies1, + ], + ); + + static const $allTransitiveDependencies0 = familyProvider; + static const $allTransitiveDependencies1 = family2Provider; + + final int Function( + DuplicateDependencies2Ref ref, + )? _createCb; + + @override + void $unimplemented() {} + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(DuplicateDependencies2Ref ref) { + final fn = _createCb ?? duplicateDependencies2; + + return fn( + ref, + ); + } + + @override + DuplicateDependencies2Provider copyWithCreate( + int Function( + DuplicateDependencies2Ref ref, + ) create, + ) { + return DuplicateDependencies2Provider._(create: create); + } +} + +String _$duplicateDependencies2Hash() => + r'43a4ff16a760fc697426a5b1ebc1f8882c816cfb'; + +typedef TransitiveDuplicateDependenciesRef = Ref; + +const transitiveDuplicateDependenciesProvider = + TransitiveDuplicateDependenciesProvider._(); + +final class TransitiveDuplicateDependenciesProvider + extends $FunctionalProvider + with $Provider { + const TransitiveDuplicateDependenciesProvider._( + {int Function( + TransitiveDuplicateDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + debugGetCreateSourceHash: _$transitiveDuplicateDependenciesHash, + name: r'transitiveDuplicateDependencies', + isAutoDispose: true, + dependencies: const [ + duplicateDependenciesProvider, + duplicateDependencies2Provider + ], + allTransitiveDependencies: const { + TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies0, + TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies1, + TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies2, + TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies3, + TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies4, + TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies5, + }, + ); + + static const $allTransitiveDependencies0 = duplicateDependenciesProvider; + static const $allTransitiveDependencies1 = + DuplicateDependenciesProvider.$allTransitiveDependencies0; + static const $allTransitiveDependencies2 = + DuplicateDependenciesProvider.$allTransitiveDependencies1; + static const $allTransitiveDependencies3 = duplicateDependencies2Provider; + static const $allTransitiveDependencies4 = + DuplicateDependencies2Provider.$allTransitiveDependencies0; + static const $allTransitiveDependencies5 = + DuplicateDependencies2Provider.$allTransitiveDependencies1; + + final int Function( + TransitiveDuplicateDependenciesRef ref, + )? _createCb; + + @override + void $unimplemented() {} + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(TransitiveDuplicateDependenciesRef ref) { + final fn = _createCb ?? transitiveDuplicateDependencies; + + return fn( + ref, + ); + } + + @override + TransitiveDuplicateDependenciesProvider copyWithCreate( + int Function( + TransitiveDuplicateDependenciesRef ref, + ) create, + ) { + return TransitiveDuplicateDependenciesProvider._(create: create); + } +} + +String _$transitiveDuplicateDependenciesHash() => + r'aba44b6c1cf82eea782ad260f2e95d9f771f12ac'; + const dep2Provider = Dep2Provider._(); final class Dep2Provider extends $NotifierProvider { @@ -621,6 +870,9 @@ final class Dep2Provider extends $NotifierProvider { final Dep2 Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override Dep2 create() => _createCb?.call() ?? Dep2(); @@ -677,6 +929,9 @@ final class Family2Provider extends $NotifierProvider { final Family2 Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override Family2 create() => _createCb?.call() ?? Family2(); @@ -770,20 +1025,24 @@ final class Provider3Provider extends $NotifierProvider { dep2Provider, family2Provider ], - allTransitiveDependencies: const [ - depProvider, - ...?depProvider.allTransitiveDependencies, - familyProvider, - ...?familyProvider.allTransitiveDependencies, - dep2Provider, - ...?dep2Provider.allTransitiveDependencies, - family2Provider, - ...?family2Provider.allTransitiveDependencies - ], + allTransitiveDependencies: const { + Provider3Provider.$allTransitiveDependencies0, + Provider3Provider.$allTransitiveDependencies1, + Provider3Provider.$allTransitiveDependencies2, + Provider3Provider.$allTransitiveDependencies3, + }, ); + static const $allTransitiveDependencies0 = depProvider; + static const $allTransitiveDependencies1 = familyProvider; + static const $allTransitiveDependencies2 = dep2Provider; + static const $allTransitiveDependencies3 = family2Provider; + final Provider3 Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override Provider3 create() => _createCb?.call() ?? Provider3(); @@ -838,8 +1097,16 @@ final class Provider4Provider extends $NotifierProvider { allTransitiveDependencies: null, ); + static const $allTransitiveDependencies0 = depProvider; + static const $allTransitiveDependencies1 = familyProvider; + static const $allTransitiveDependencies2 = dep2Provider; + static const $allTransitiveDependencies3 = family2Provider; + final Provider4 Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override Provider4 create() => _createCb?.call() ?? Provider4(); @@ -890,16 +1157,12 @@ final class Provider4Family extends Family { dep2Provider, family2Provider ], - allTransitiveDependencies: const [ - depProvider, - ...?depProvider.allTransitiveDependencies, - familyProvider, - ...?familyProvider.allTransitiveDependencies, - dep2Provider, - ...?dep2Provider.allTransitiveDependencies, - family2Provider, - ...?family2Provider.allTransitiveDependencies - ], + allTransitiveDependencies: const { + Provider4Provider.$allTransitiveDependencies0, + Provider4Provider.$allTransitiveDependencies1, + Provider4Provider.$allTransitiveDependencies2, + Provider4Provider.$allTransitiveDependencies3, + }, debugGetCreateSourceHash: _$provider4Hash, isAutoDispose: true, ); @@ -950,6 +1213,9 @@ final class EmptyDependenciesClassBasedProvider final EmptyDependenciesClassBased Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override EmptyDependenciesClassBased create() => diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index defa37d2d..196b282de 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -29,20 +29,30 @@ final class ProviderWithDependencies2Provider _private2Provider, public2Provider ], - allTransitiveDependencies: const [ - providerWithDependenciesProvider, - ...?providerWithDependenciesProvider.allTransitiveDependencies, - _private2Provider, - ...?_private2Provider.allTransitiveDependencies, - public2Provider, - ...?public2Provider.allTransitiveDependencies - ], + allTransitiveDependencies: const { + ProviderWithDependencies2Provider.$allTransitiveDependencies0, + ProviderWithDependencies2Provider.$allTransitiveDependencies1, + ProviderWithDependencies2Provider.$allTransitiveDependencies2, + ProviderWithDependencies2Provider.$allTransitiveDependencies3, + ProviderWithDependencies2Provider.$allTransitiveDependencies4, + }, ); + static const $allTransitiveDependencies0 = providerWithDependenciesProvider; + static const $allTransitiveDependencies1 = + ProviderWithDependenciesProvider.$allTransitiveDependencies0; + static const $allTransitiveDependencies2 = + ProviderWithDependenciesProvider.$allTransitiveDependencies1; + static const $allTransitiveDependencies3 = _private2Provider; + static const $allTransitiveDependencies4 = public2Provider; + final int Function( ProviderWithDependencies2Ref ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -95,11 +105,22 @@ final class FamilyWithDependencies2Provider allTransitiveDependencies: null, ); + static const $allTransitiveDependencies0 = providerWithDependenciesProvider; + static const $allTransitiveDependencies1 = + ProviderWithDependenciesProvider.$allTransitiveDependencies0; + static const $allTransitiveDependencies2 = + ProviderWithDependenciesProvider.$allTransitiveDependencies1; + static const $allTransitiveDependencies3 = _private2Provider; + static const $allTransitiveDependencies4 = public2Provider; + final int Function( FamilyWithDependencies2Ref ref, { int? id, })? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -155,14 +176,13 @@ final class FamilyWithDependencies2Family extends Family { _private2Provider, public2Provider ], - allTransitiveDependencies: const [ - providerWithDependenciesProvider, - ...?providerWithDependenciesProvider.allTransitiveDependencies, - _private2Provider, - ...?_private2Provider.allTransitiveDependencies, - public2Provider, - ...?public2Provider.allTransitiveDependencies - ], + allTransitiveDependencies: const { + FamilyWithDependencies2Provider.$allTransitiveDependencies0, + FamilyWithDependencies2Provider.$allTransitiveDependencies1, + FamilyWithDependencies2Provider.$allTransitiveDependencies2, + FamilyWithDependencies2Provider.$allTransitiveDependencies3, + FamilyWithDependencies2Provider.$allTransitiveDependencies4, + }, debugGetCreateSourceHash: _$familyWithDependencies2Hash, isAutoDispose: true, ); @@ -202,6 +222,9 @@ final class _Private2Provider _Private2Ref ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -252,6 +275,9 @@ final class Public2Provider extends $FunctionalProvider Public2Ref ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -296,18 +322,28 @@ final class NotifierWithDependenciesProvider _private2Provider, public2Provider ], - allTransitiveDependencies: const [ - providerWithDependenciesProvider, - ...?providerWithDependenciesProvider.allTransitiveDependencies, - _private2Provider, - ...?_private2Provider.allTransitiveDependencies, - public2Provider, - ...?public2Provider.allTransitiveDependencies - ], + allTransitiveDependencies: const { + NotifierWithDependenciesProvider.$allTransitiveDependencies0, + NotifierWithDependenciesProvider.$allTransitiveDependencies1, + NotifierWithDependenciesProvider.$allTransitiveDependencies2, + NotifierWithDependenciesProvider.$allTransitiveDependencies3, + NotifierWithDependenciesProvider.$allTransitiveDependencies4, + }, ); + static const $allTransitiveDependencies0 = providerWithDependenciesProvider; + static const $allTransitiveDependencies1 = + ProviderWithDependenciesProvider.$allTransitiveDependencies0; + static const $allTransitiveDependencies2 = + ProviderWithDependenciesProvider.$allTransitiveDependencies1; + static const $allTransitiveDependencies3 = _private2Provider; + static const $allTransitiveDependencies4 = public2Provider; + final NotifierWithDependencies Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override NotifierWithDependencies create() => @@ -369,8 +405,19 @@ final class NotifierFamilyWithDependenciesProvider allTransitiveDependencies: null, ); + static const $allTransitiveDependencies0 = providerWithDependenciesProvider; + static const $allTransitiveDependencies1 = + ProviderWithDependenciesProvider.$allTransitiveDependencies0; + static const $allTransitiveDependencies2 = + ProviderWithDependenciesProvider.$allTransitiveDependencies1; + static const $allTransitiveDependencies3 = _private2Provider; + static const $allTransitiveDependencies4 = public2Provider; + final NotifierFamilyWithDependencies Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override NotifierFamilyWithDependencies create() => @@ -427,14 +474,13 @@ final class NotifierFamilyWithDependenciesFamily extends Family { _private2Provider, public2Provider ], - allTransitiveDependencies: const [ - providerWithDependenciesProvider, - ...?providerWithDependenciesProvider.allTransitiveDependencies, - _private2Provider, - ...?_private2Provider.allTransitiveDependencies, - public2Provider, - ...?public2Provider.allTransitiveDependencies - ], + allTransitiveDependencies: const { + NotifierFamilyWithDependenciesProvider.$allTransitiveDependencies0, + NotifierFamilyWithDependenciesProvider.$allTransitiveDependencies1, + NotifierFamilyWithDependenciesProvider.$allTransitiveDependencies2, + NotifierFamilyWithDependenciesProvider.$allTransitiveDependencies3, + NotifierFamilyWithDependenciesProvider.$allTransitiveDependencies4, + }, debugGetCreateSourceHash: _$notifierFamilyWithDependenciesHash, isAutoDispose: true, ); diff --git a/packages/riverpod_generator/test/integration/generated.freezed.dart b/packages/riverpod_generator/test/integration/generated.freezed.dart index 28fc84cf6..d175170d4 100644 --- a/packages/riverpod_generator/test/integration/generated.freezed.dart +++ b/packages/riverpod_generator/test/integration/generated.freezed.dart @@ -12,7 +12,7 @@ part of 'generated.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$Test {} diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 4a3153ff9..3b640b4f3 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -32,6 +32,9 @@ final class GeneratedProvider GeneratedRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement<_Test> createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -85,6 +88,9 @@ final class GeneratedFamilyProvider _Test test, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement<_Test> createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -168,6 +174,9 @@ final class $DynamicProvider $DynamicRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -221,6 +230,9 @@ final class $DynamicFamilyProvider test, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -306,6 +318,9 @@ final class _DynamicProvider test, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -389,6 +404,9 @@ final class AliasProvider AliasRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement> createElement( ProviderContainer container) => @@ -444,6 +462,9 @@ final class AliasFamilyProvider extends $FunctionalProvider< r.AsyncValue test, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement> createElement( ProviderContainer container) => @@ -522,6 +543,9 @@ final class GeneratedClassProvider final GeneratedClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override GeneratedClass create() => _createCb?.call() ?? GeneratedClass(); @@ -579,6 +603,9 @@ final class GeneratedClassFamilyProvider final GeneratedClassFamily Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override GeneratedClassFamily create() => _createCb?.call() ?? GeneratedClassFamily(); @@ -674,6 +701,9 @@ final class $DynamicClassProvider final $DynamicClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override $DynamicClass create() => _createCb?.call() ?? $DynamicClass(); @@ -731,6 +761,9 @@ final class $DynamicClassFamilyProvider final $DynamicClassFamily Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override $DynamicClassFamily create() => _createCb?.call() ?? $DynamicClassFamily(); @@ -826,6 +859,9 @@ final class AliasClassProvider final AliasClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override AliasClass create() => _createCb?.call() ?? AliasClass(); @@ -883,6 +919,9 @@ final class AliasClassFamilyProvider final AliasClassFamily Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override AliasClassFamily create() => _createCb?.call() ?? AliasClassFamily(); diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 4323090d1..71d2ba033 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -31,6 +31,9 @@ final class ScopedProvider extends $FunctionalProvider ScopedRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index c91cb926a..945efcd90 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -31,6 +31,9 @@ final class Counter2Provider extends $FunctionalProvider Counter2Ref ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -81,6 +84,9 @@ final class CounterProvider extends $FunctionalProvider CounterRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 9574329c5..0dfbe6596 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -32,6 +32,9 @@ final class GenericProvider extends $FunctionalProvider< GenericRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $StreamProviderElement> createElement(ProviderContainer container) => $StreamProviderElement(this, container); @@ -106,6 +109,9 @@ final class PublicProvider PublicRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $StreamProviderElement createElement(ProviderContainer container) => $StreamProviderElement(this, container); @@ -157,6 +163,9 @@ final class _PrivateProvider _PrivateRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $StreamProviderElement createElement(ProviderContainer container) => $StreamProviderElement(this, container); @@ -225,6 +234,9 @@ final class FamilyProvider List? fifth, })? _createCb; + @override + void $unimplemented() {} + @override $StreamProviderElement createElement(ProviderContainer container) => $StreamProviderElement(this, container); @@ -338,6 +350,9 @@ final class GenericClassProvider final GenericClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override GenericClass create() => _createCb?.call() ?? GenericClass(); @@ -420,6 +435,9 @@ final class PublicClassProvider final PublicClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override PublicClass create() => _createCb?.call() ?? PublicClass(); @@ -476,6 +494,9 @@ final class _PrivateClassProvider final _PrivateClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override _PrivateClass create() => _createCb?.call() ?? _PrivateClass(); @@ -540,6 +561,9 @@ final class FamilyClassProvider final FamilyClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override FamilyClass create() => _createCb?.call() ?? FamilyClass(); diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index e568471a9..9f0bced46 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -32,6 +32,9 @@ final class GenericProvider GenericRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement> createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -114,6 +117,9 @@ final class ComplexGenericProvider Foo? otherParam, })? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement> createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -216,6 +222,9 @@ final class RawFutureProvider extends $FunctionalProvider>, RawFutureRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $FutureProviderElement>> createElement( ProviderContainer container) => @@ -270,6 +279,9 @@ final class RawStreamProvider extends $FunctionalProvider>, RawStreamRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $StreamProviderElement>> createElement( ProviderContainer container) => @@ -326,6 +338,9 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< int id, )? _createCb; + @override + void $unimplemented() {} + @override $FutureProviderElement>> createElement( ProviderContainer container) => @@ -414,6 +429,9 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< int id, )? _createCb; + @override + void $unimplemented() {} + @override $StreamProviderElement>> createElement( ProviderContainer container) => @@ -498,6 +516,9 @@ final class PublicProvider PublicRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -549,6 +570,9 @@ final class Supports$inNamesProvider Supports$inNamesRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -617,6 +641,9 @@ final class FamilyProvider List? fifth, })? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -736,6 +763,9 @@ final class _PrivateProvider _PrivateRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -787,6 +817,9 @@ final class GeneratedProvider GeneratedRef ref, )? _createCb; + @override + void $unimplemented() {} + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -832,6 +865,9 @@ final class GenericClassProvider final GenericClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override GenericClass create() => _createCb?.call() ?? GenericClass(); @@ -914,6 +950,9 @@ final class RawFutureClassProvider final RawFutureClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override RawFutureClass create() => _createCb?.call() ?? RawFutureClass(); @@ -971,6 +1010,9 @@ final class RawStreamClassProvider final RawStreamClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override RawStreamClass create() => _createCb?.call() ?? RawStreamClass(); @@ -1029,6 +1071,9 @@ final class RawFamilyFutureClassProvider final RawFamilyFutureClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override RawFamilyFutureClass create() => _createCb?.call() ?? RawFamilyFutureClass(); @@ -1127,6 +1172,9 @@ final class RawFamilyStreamClassProvider final RawFamilyStreamClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override RawFamilyStreamClass create() => _createCb?.call() ?? RawFamilyStreamClass(); @@ -1223,6 +1271,9 @@ final class PublicClassProvider extends $NotifierProvider { final PublicClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override PublicClass create() => _createCb?.call() ?? PublicClass(); @@ -1279,6 +1330,9 @@ final class _PrivateClassProvider final _PrivateClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override _PrivateClass create() => _createCb?.call() ?? _PrivateClass(); @@ -1342,6 +1396,9 @@ final class FamilyClassProvider extends $NotifierProvider { final FamilyClass Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override FamilyClass create() => _createCb?.call() ?? FamilyClass(); @@ -1475,6 +1532,9 @@ final class Supports$InClassNameProvider final Supports$InClassName Function()? _createCb; + @override + void $unimplemented() {} + @$internal @override Supports$InClassName create() => _createCb?.call() ?? Supports$InClassName(); From ce2a08c302480f436923174c858061c7b86add84 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 13:02:20 +0100 Subject: [PATCH 154/387] Normalize notifier params --- packages/riverpod/lib/src/providers/notifier.dart | 8 +------- .../riverpod/lib/src/providers/notifier/family.dart | 7 ++++++- .../riverpod/lib/src/providers/notifier/orphan.dart | 11 ++++++++--- .../riverpod/lib/src/providers/stream_notifier.dart | 8 +------- .../lib/src/providers/stream_notifier/family.dart | 7 ++++++- .../lib/src/providers/stream_notifier/orphan.dart | 11 ++++++++--- 6 files changed, 30 insertions(+), 22 deletions(-) diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index 48d8e00ea..ff496b2c0 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -89,8 +89,7 @@ abstract base class $NotifierProvider // /// An internal base class for [Notifier]. /// /// Not meant for public consumption. - const $NotifierProvider( - this._createNotifier, { + const $NotifierProvider({ required super.name, required super.from, required super.argument, @@ -100,11 +99,6 @@ abstract base class $NotifierProvider // required super.isAutoDispose, required super.runNotifierBuildOverride, }); - - final NotifierT Function() _createNotifier; - - @override - NotifierT create() => _createNotifier(); } /// An implementation detail of `riverpod_generator`. diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index 0a479a74a..4ce4ade05 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -27,7 +27,7 @@ final class FamilyNotifierProvider // with LegacyProviderEqualMixin { /// An implementation detail of Riverpod const FamilyNotifierProvider._( - super._createNotifier, { + this._createNotifier, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -38,6 +38,11 @@ final class FamilyNotifierProvider // required super.runNotifierBuildOverride, }); + final NotifierT Function() _createNotifier; + + @override + NotifierT create() => _createNotifier(); + @override $NotifierProviderElement createElement( ProviderContainer container, diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart index 706dbd644..fe0585e42 100644 --- a/packages/riverpod/lib/src/providers/notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -83,7 +83,7 @@ final class NotifierProvider, StateT> /// /// {@macro riverpod.notifier_provider_modifier} NotifierProvider( - super._createNotifier, { + this._createNotifier, { super.name, super.dependencies, super.isAutoDispose = false, @@ -97,7 +97,7 @@ final class NotifierProvider, StateT> ); NotifierProvider._autoDispose( - super._createNotifier, { + this._createNotifier, { super.name, super.dependencies, }) : super( @@ -113,7 +113,7 @@ final class NotifierProvider, StateT> /// An implementation detail of Riverpod @internal NotifierProvider.internal( - super._createNotifier, { + this._createNotifier, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -130,6 +130,11 @@ final class NotifierProvider, StateT> /// {@macro riverpod.family} static const family = NotifierProviderFamilyBuilder(); + final NotifierT Function() _createNotifier; + + @override + NotifierT create() => _createNotifier(); + @override $NotifierProviderElement createElement( ProviderContainer container, diff --git a/packages/riverpod/lib/src/providers/stream_notifier.dart b/packages/riverpod/lib/src/providers/stream_notifier.dart index 6534d5ff5..369477d73 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier.dart @@ -30,8 +30,7 @@ abstract base class $StreamNotifierProvider< Ref>> // with $FutureModifier { - const $StreamNotifierProvider( - this._createNotifier, { + const $StreamNotifierProvider({ required super.name, required super.from, required super.argument, @@ -41,11 +40,6 @@ abstract base class $StreamNotifierProvider< required super.isAutoDispose, required super.runNotifierBuildOverride, }); - - final NotifierT Function() _createNotifier; - - @override - NotifierT create() => _createNotifier(); } /// Implementation detail of `riverpod_generator`. diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index b73bee07f..d0ce86682 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -34,7 +34,7 @@ final class FamilyStreamNotifierProvider< // with LegacyProviderEqualMixin> { /// An implementation detail of Riverpod const FamilyStreamNotifierProvider._( - super._createNotifier, { + this._createNotifier, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -45,6 +45,11 @@ final class FamilyStreamNotifierProvider< // required super.runNotifierBuildOverride, }); + final NotifierT Function() _createNotifier; + + @override + NotifierT create() => _createNotifier(); + @override $StreamNotifierProviderElement createElement( ProviderContainer container, diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index 6cffbc001..40aabbbbc 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -53,7 +53,7 @@ final class StreamNotifierProvider< // /// /// {@macro riverpod.async_notifier_provider_modifier} StreamNotifierProvider( - super._createNotifier, { + this._createNotifier, { super.name, super.dependencies, super.runNotifierBuildOverride, @@ -67,7 +67,7 @@ final class StreamNotifierProvider< // ); StreamNotifierProvider._autoDispose( - super._createNotifier, { + this._createNotifier, { super.name, super.dependencies, super.runNotifierBuildOverride, @@ -83,7 +83,7 @@ final class StreamNotifierProvider< // /// An implementation detail of Riverpod @internal const StreamNotifierProvider.internal( - super._createNotifier, { + this._createNotifier, { required super.name, required super.dependencies, required super.allTransitiveDependencies, @@ -100,6 +100,11 @@ final class StreamNotifierProvider< // /// {@macro riverpod.family} static const family = StreamNotifierProviderFamilyBuilder(); + final NotifierT Function() _createNotifier; + + @override + NotifierT create() => _createNotifier(); + StreamNotifierProvider _copyWith({ NotifierT Function()? create, RunNotifierBuild, Ref>>? build, From 6120efac15f930e6acd10f98ab3f9fe5a7aeaa3e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 13:12:09 +0100 Subject: [PATCH 155/387] Make debugHash a method instead of field --- .../legacy/change_notifier_provider.dart | 7 +---- packages/riverpod/lib/riverpod.dart | 3 +-- packages/riverpod/lib/src/core/element.dart | 4 +-- packages/riverpod/lib/src/core/family.dart | 13 +++++---- .../riverpod/lib/src/core/foundation.dart | 7 ++--- .../lib/src/core/override_with_value.dart | 3 +-- .../core/provider/functional_provider.dart | 1 - .../src/core/provider/notifier_provider.dart | 1 - .../lib/src/core/provider/provider.dart | 27 +++---------------- .../lib/src/providers/async_notifier.dart | 1 - .../src/providers/async_notifier/family.dart | 5 +--- .../src/providers/async_notifier/orphan.dart | 6 +---- .../lib/src/providers/future_provider.dart | 9 +------ .../legacy/state_notifier_provider.dart | 6 +---- .../src/providers/legacy/state_provider.dart | 8 +----- .../riverpod/lib/src/providers/notifier.dart | 1 - .../lib/src/providers/notifier/family.dart | 5 +--- .../lib/src/providers/notifier/orphan.dart | 6 +---- .../riverpod/lib/src/providers/provider.dart | 9 +------ .../lib/src/providers/stream_notifier.dart | 1 - .../src/providers/stream_notifier/family.dart | 5 +--- .../src/providers/stream_notifier/orphan.dart | 6 +---- .../lib/src/providers/stream_provider.dart | 9 +------ .../framework/provider_container_test.dart | 2 -- .../lib/src/templates/family.dart | 2 +- 25 files changed, 31 insertions(+), 116 deletions(-) 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 index 2fc7cdf30..b48026a07 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -91,7 +91,7 @@ abstract class ChangeNotifierProviderRef final class ChangeNotifierProvider extends $FunctionalProvider> - with LegacyProviderEqualMixin { + with LegacyProviderMixin { /// {@macro riverpod.change_notifier_provider} ChangeNotifierProvider( this._createFn, { @@ -103,7 +103,6 @@ final class ChangeNotifierProvider computeAllTransitiveDependencies(dependencies), from: null, argument: null, - debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod @@ -113,7 +112,6 @@ final class ChangeNotifierProvider required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.isAutoDispose, super.from, super.argument, @@ -165,7 +163,6 @@ final class ChangeNotifierProvider from: from, argument: argument, allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, ); } } @@ -246,7 +243,6 @@ class ChangeNotifierProviderFamily super.isAutoDispose = false, }) : super( providerFactory: ChangeNotifierProvider.internal, - debugGetCreateSourceHash: null, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), ); @@ -268,7 +264,6 @@ class ChangeNotifierProviderFamily isAutoDispose: provider.isAutoDispose, dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: null, name: null, ).createElement(container); }, diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 4059d1c40..b83351bf3 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -18,7 +18,6 @@ export 'src/framework.dart' SetupFamilyOverride, SetupOverride, $ProviderOverride, - DebugGetCreateSourceHash, ClassProviderFactory, FunctionalProviderFactory, computeAllTransitiveDependencies, @@ -43,7 +42,7 @@ export 'src/framework.dart' RunNotifierBuild, $FunctionalProvider, $ClassProvider, - LegacyProviderEqualMixin; + LegacyProviderMixin; export 'src/providers/async_notifier.dart' hide $AsyncNotifier, $AsyncNotifierProvider; diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 9da85eec9..8255b03c2 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -220,7 +220,7 @@ This could mean a few things: /// and invalidate the provider state on change. void debugReassemble() { final previousHash = _debugCurrentCreateHash; - _debugCurrentCreateHash = provider.debugGetCreateSourceHash?.call(); + _debugCurrentCreateHash = provider.debugGetCreateSourceHash(); if (previousHash != _debugCurrentCreateHash) { invalidateSelf(); @@ -232,7 +232,7 @@ This could mean a few things: void mount() { _mounted = true; if (kDebugMode) { - _debugCurrentCreateHash = provider.debugGetCreateSourceHash?.call(); + _debugCurrentCreateHash = provider.debugGetCreateSourceHash(); } buildState(); diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index 00bcc045b..6df18a979 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -12,7 +12,6 @@ typedef FunctionalProviderFactory< // required String? name, required List? dependencies, required List? allTransitiveDependencies, - required DebugGetCreateSourceHash? debugGetCreateSourceHash, required bool isAutoDispose, required Family from, required ArgT argument, @@ -31,7 +30,6 @@ typedef ClassProviderFactory< // required String? name, required Iterable? dependencies, required Iterable? allTransitiveDependencies, - required DebugGetCreateSourceHash? debugGetCreateSourceHash, required RunNotifierBuild? runNotifierBuildOverride, required bool isAutoDispose, @@ -52,7 +50,6 @@ abstract class Family extends ProviderOrFamily implements _FamilyOverride { required super.dependencies, required super.allTransitiveDependencies, required super.isAutoDispose, - required super.debugGetCreateSourceHash, }); @override @@ -92,7 +89,6 @@ class FunctionalFamily< // required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.isAutoDispose, }) : _providerFactory = providerFactory; @@ -117,10 +113,12 @@ class FunctionalFamily< // // TODO test all families set dependencies as null dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: debugGetCreateSourceHash, ); } + @override + String? debugGetCreateSourceHash() => null; + /// {@macro riverpod.override_with} Override overrideWith( CreatedT Function(RefT ref, ArgT arg) create, @@ -167,7 +165,6 @@ class ClassFamily< // required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.isAutoDispose, }); @@ -188,11 +185,13 @@ class ClassFamily< // argument: argument, dependencies: dependencies, allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, runNotifierBuildOverride: null, ); } + @override + String? debugGetCreateSourceHash() => null; + /// {@macro riverpod.override_with} Override overrideWith(NotifierT Function() create) { return $FamilyOverride( diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index 3274ec3a3..60ce69acc 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -11,7 +11,6 @@ sealed class ProviderOrFamily implements ProviderListenableOrFamily { required this.dependencies, required this.allTransitiveDependencies, required this.isAutoDispose, - @internal required this.debugGetCreateSourceHash, }); /// The family that this provider/family depends on. @@ -94,9 +93,11 @@ sealed class ProviderOrFamily implements ProviderListenableOrFamily { /// If after a hot-reload this function returns a different result, the /// provider will be re-executed. /// - /// This variable is only set by `riverpod_generator`. + /// This method only returns a non-null value when using `riverpod_generator`. + // This is voluntarily not implemented by default, to force all non-generated + // providers to apply the LegacyProviderMixin. @internal - final DebugGetCreateSourceHash? debugGetCreateSourceHash; + String? debugGetCreateSourceHash(); } extension on ProviderListenableOrFamily { diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index dc6945313..44d7479ef 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -6,14 +6,13 @@ part of '../framework.dart'; @sealed @internal final class ValueProvider extends ProviderBase - with LegacyProviderEqualMixin { + with LegacyProviderMixin { /// Creates a [ValueProvider]. const ValueProvider(this._value) : super( name: null, from: null, argument: null, - debugGetCreateSourceHash: null, allTransitiveDependencies: null, dependencies: null, isAutoDispose: false, diff --git a/packages/riverpod/lib/src/core/provider/functional_provider.dart b/packages/riverpod/lib/src/core/provider/functional_provider.dart index fd4f8cb5b..2243f706b 100644 --- a/packages/riverpod/lib/src/core/provider/functional_provider.dart +++ b/packages/riverpod/lib/src/core/provider/functional_provider.dart @@ -13,7 +13,6 @@ abstract base class $FunctionalProvider< // required super.name, required super.from, required super.argument, - required super.debugGetCreateSourceHash, required super.dependencies, required super.allTransitiveDependencies, required super.isAutoDispose, diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index fd33f34e5..55f682d2f 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -89,7 +89,6 @@ abstract base class $ClassProvider< // required super.name, required super.from, required super.argument, - required super.debugGetCreateSourceHash, required super.dependencies, required super.allTransitiveDependencies, required super.isAutoDispose, diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index 2e553a8b1..5ef4db0f5 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -19,10 +19,6 @@ typedef Create> = T Function(R ref); @internal typedef OnError = void Function(Object, StackTrace); -/// A typedef for `debugGetCreateSourceHash` parameters. -@internal -typedef DebugGetCreateSourceHash = String Function(); - /// A base class for _all_ providers. @immutable // TODO rename all generics to @@ -35,7 +31,6 @@ abstract base class ProviderBase extends ProviderOrFamily required super.name, required this.from, required this.argument, - required super.debugGetCreateSourceHash, required super.dependencies, required super.allTransitiveDependencies, required super.isAutoDispose, @@ -100,19 +95,6 @@ abstract base class ProviderBase extends ProviderOrFamily @visibleForOverriding ProviderElementBase createElement(ProviderContainer container); - /// Do not use. - /// - /// An unimplemented method, for the sole purpose of forcing all - /// non-code-generators to apply a mixin that overrides ==/hashCode. - /// This is because `riverpod_generator` expects all generated providers - /// to not override ==/hashCode, for the sake of inserting providers in a - /// constant [Set]. - /// - /// At the same time, all non-generated providers must override ==/hashCode. - /// So to prevent forgetting to override ==/hashCode, this method is added. - /// This method is then expected to be implemented using [LegacyProviderEqualMixin] - void $unimplemented(); - @override String toString() { var leading = ''; @@ -131,11 +113,9 @@ abstract base class ProviderBase extends ProviderOrFamily } } -/// A mixin that implements ==/hashCode for providers that are not code-generated. -/// -/// See [ProviderBase.$unimplemented] for explanation. +/// A mixin that implements some methods for non-generic providers. @internal -base mixin LegacyProviderEqualMixin on ProviderBase { +base mixin LegacyProviderMixin on ProviderBase { @override int get hashCode { if (from == null) return super.hashCode; @@ -153,6 +133,7 @@ base mixin LegacyProviderEqualMixin on ProviderBase { other.argument == argument; } + @internal @override - void $unimplemented() {} + String? debugGetCreateSourceHash() => null; } diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index 8878b0682..13a7e3e03 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -37,7 +37,6 @@ abstract base class $AsyncNotifierProvider< // required super.argument, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.isAutoDispose, required super.runNotifierBuildOverride, }); diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index b02ea6ef8..463eb5e66 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -49,7 +49,6 @@ class AsyncNotifierProviderFamily< // providerFactory: FamilyAsyncNotifierProvider._, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, ); } @@ -59,14 +58,13 @@ final class FamilyAsyncNotifierProvider< // StateT, ArgT> // extends $AsyncNotifierProvider - with LegacyProviderEqualMixin> { + with LegacyProviderMixin> { /// An implementation detail of Riverpod const FamilyAsyncNotifierProvider._( this._createNotifier, { required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.from, required super.argument, required super.isAutoDispose, @@ -83,7 +81,6 @@ final class FamilyAsyncNotifierProvider< // name: name, dependencies: dependencies, allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, from: from, argument: argument, isAutoDispose: isAutoDispose, diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index cfb06caa9..a53807293 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -61,7 +61,7 @@ final class AsyncNotifierProvider< // NotifierT extends AsyncNotifier, StateT> // extends $AsyncNotifierProvider - with LegacyProviderEqualMixin> { + with LegacyProviderMixin> { /// {@macro riverpod.async_notifier_provider} /// /// {@macro riverpod.async_notifier_provider_modifier} @@ -75,7 +75,6 @@ final class AsyncNotifierProvider< // computeAllTransitiveDependencies(dependencies), from: null, argument: null, - debugGetCreateSourceHash: null, runNotifierBuildOverride: null, ); @@ -88,7 +87,6 @@ final class AsyncNotifierProvider< // computeAllTransitiveDependencies(dependencies), from: null, argument: null, - debugGetCreateSourceHash: null, isAutoDispose: true, runNotifierBuildOverride: null, ); @@ -100,7 +98,6 @@ final class AsyncNotifierProvider< // required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.from, required super.argument, required super.isAutoDispose, @@ -128,7 +125,6 @@ final class AsyncNotifierProvider< // name: name, dependencies: dependencies, allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, from: from, argument: argument, isAutoDispose: isAutoDispose, diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 9567de20b..fe5f71884 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -88,7 +88,7 @@ final class FutureProvider extends $FunctionalProvider< with $FutureModifier, $FutureProvider>, - LegacyProviderEqualMixin> { + LegacyProviderMixin> { /// {@macro riverpod.future_provider} FutureProvider( this._create, { @@ -100,7 +100,6 @@ final class FutureProvider extends $FunctionalProvider< computeAllTransitiveDependencies(dependencies), from: null, argument: null, - debugGetCreateSourceHash: null, ); FutureProvider._autoDispose( @@ -113,7 +112,6 @@ final class FutureProvider extends $FunctionalProvider< isAutoDispose: true, from: null, argument: null, - debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod @@ -123,7 +121,6 @@ final class FutureProvider extends $FunctionalProvider< required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.from, required super.argument, required super.isAutoDispose, @@ -157,7 +154,6 @@ final class FutureProvider extends $FunctionalProvider< name: name, dependencies: dependencies, allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, from: from, argument: argument, isAutoDispose: isAutoDispose, @@ -230,7 +226,6 @@ class FutureProviderFamily extends FunctionalFamily< providerFactory: FutureProvider.internal, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, ); FutureProviderFamily._autoDispose( @@ -242,7 +237,6 @@ class FutureProviderFamily extends FunctionalFamily< isAutoDispose: true, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, ); /// Implementation detail of the code-generator. @@ -252,7 +246,6 @@ class FutureProviderFamily extends FunctionalFamily< required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.isAutoDispose, }) : super(providerFactory: FutureProvider.internal); } diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index da350035c..0167fb196 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -95,7 +95,7 @@ final class StateNotifierProvider< // StateT, NotifierT, StateNotifierProviderRef> - with LegacyProviderEqualMixin { + with LegacyProviderMixin { /// {@macro riverpod.statenotifierprovider} StateNotifierProvider( this._create, { @@ -107,7 +107,6 @@ final class StateNotifierProvider< // computeAllTransitiveDependencies(dependencies), from: null, argument: null, - debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod @@ -117,7 +116,6 @@ final class StateNotifierProvider< // required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.from, required super.argument, required super.isAutoDispose, @@ -167,7 +165,6 @@ final class StateNotifierProvider< // name: name, dependencies: dependencies, allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, from: from, argument: argument, isAutoDispose: isAutoDispose, @@ -255,6 +252,5 @@ class StateNotifierProviderFamily, T, Arg> providerFactory: StateNotifierProvider.internal, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, ); } diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 6bdc8d321..80db39d5e 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -57,7 +57,7 @@ abstract class StateProviderRef implements Ref { /// ``` final class StateProvider extends $FunctionalProvider> - with LegacyProviderEqualMixin { + with LegacyProviderMixin { /// {@macro riverpod.stateprovider} StateProvider( this._createFn, { @@ -69,7 +69,6 @@ final class StateProvider computeAllTransitiveDependencies(dependencies), from: null, argument: null, - debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod @@ -79,7 +78,6 @@ final class StateProvider required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.isAutoDispose, required super.from, required super.argument, @@ -113,7 +111,6 @@ final class StateProvider name: name, dependencies: dependencies, allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, from: from, argument: argument, isAutoDispose: isAutoDispose, @@ -199,7 +196,6 @@ class StateProviderFamily extends FunctionalFamily< // super.isAutoDispose = false, }) : super( providerFactory: StateProvider.internal, - debugGetCreateSourceHash: null, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), ); @@ -210,7 +206,6 @@ class StateProviderFamily extends FunctionalFamily< // super.dependencies, }) : super( providerFactory: StateProvider.internal, - debugGetCreateSourceHash: null, isAutoDispose: true, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), @@ -223,7 +218,6 @@ class StateProviderFamily extends FunctionalFamily< // super.name, super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.isAutoDispose, }) : super(providerFactory: StateProvider.internal); } diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index ff496b2c0..fe6faca6a 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -95,7 +95,6 @@ abstract base class $NotifierProvider // required super.argument, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.isAutoDispose, required super.runNotifierBuildOverride, }); diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index 4ce4ade05..4632c25ee 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -24,14 +24,13 @@ abstract class FamilyNotifier extends $Notifier { final class FamilyNotifierProvider // , StateT, ArgT> extends $NotifierProvider - with LegacyProviderEqualMixin { + with LegacyProviderMixin { /// An implementation detail of Riverpod const FamilyNotifierProvider._( this._createNotifier, { required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.from, required super.argument, required super.isAutoDispose, @@ -59,7 +58,6 @@ final class FamilyNotifierProvider // name: name, dependencies: dependencies, allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, isAutoDispose: isAutoDispose, runNotifierBuildOverride: build ?? runNotifierBuildOverride, from: from, @@ -107,6 +105,5 @@ class NotifierProviderFamily< providerFactory: FamilyNotifierProvider._, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, ); } diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart index fe0585e42..407d69286 100644 --- a/packages/riverpod/lib/src/providers/notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -78,7 +78,7 @@ abstract class Notifier extends $Notifier { final class NotifierProvider, StateT> extends $NotifierProvider - with LegacyProviderEqualMixin { + with LegacyProviderMixin { /// {@macro riverpod.notifier_provider} /// /// {@macro riverpod.notifier_provider_modifier} @@ -92,7 +92,6 @@ final class NotifierProvider, StateT> computeAllTransitiveDependencies(dependencies), from: null, argument: null, - debugGetCreateSourceHash: null, runNotifierBuildOverride: null, ); @@ -106,7 +105,6 @@ final class NotifierProvider, StateT> isAutoDispose: true, from: null, argument: null, - debugGetCreateSourceHash: null, runNotifierBuildOverride: null, ); @@ -117,7 +115,6 @@ final class NotifierProvider, StateT> required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.from, required super.argument, required super.isAutoDispose, @@ -151,7 +148,6 @@ final class NotifierProvider, StateT> name: name, dependencies: dependencies, allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, from: from, argument: argument, isAutoDispose: isAutoDispose, diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index a9193ad21..07d18a765 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -16,7 +16,7 @@ base mixin $Provider on ProviderBase { /// {@macro riverpod.provider} base class Provider extends $FunctionalProvider> - with $Provider>, LegacyProviderEqualMixin { + with $Provider>, LegacyProviderMixin { /// {@macro riverpod.provider} // TODO make all providers const under all variations Provider( @@ -29,7 +29,6 @@ base class Provider computeAllTransitiveDependencies(dependencies), from: null, argument: null, - debugGetCreateSourceHash: null, ); Provider._autoDispose( @@ -42,7 +41,6 @@ base class Provider isAutoDispose: true, from: null, argument: null, - debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod @@ -52,7 +50,6 @@ base class Provider required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.from, required super.argument, required super.isAutoDispose, @@ -89,7 +86,6 @@ base class Provider isAutoDispose: isAutoDispose, allTransitiveDependencies: null, dependencies: null, - debugGetCreateSourceHash: null, name: null, ); } @@ -378,7 +374,6 @@ class ProviderFamily providerFactory: Provider.internal, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, ); ProviderFamily._autoDispose( @@ -390,7 +385,6 @@ class ProviderFamily isAutoDispose: true, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod @@ -400,7 +394,6 @@ class ProviderFamily required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.isAutoDispose, }) : super(providerFactory: Provider.internal); } diff --git a/packages/riverpod/lib/src/providers/stream_notifier.dart b/packages/riverpod/lib/src/providers/stream_notifier.dart index 369477d73..8274c6974 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier.dart @@ -36,7 +36,6 @@ abstract base class $StreamNotifierProvider< required super.argument, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.isAutoDispose, required super.runNotifierBuildOverride, }); diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index d0ce86682..a4ebc5f45 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -31,14 +31,13 @@ final class FamilyStreamNotifierProvider< // StateT, ArgT> // extends $StreamNotifierProvider - with LegacyProviderEqualMixin> { + with LegacyProviderMixin> { /// An implementation detail of Riverpod const FamilyStreamNotifierProvider._( this._createNotifier, { required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.from, required super.argument, required super.isAutoDispose, @@ -70,7 +69,6 @@ final class FamilyStreamNotifierProvider< // name: name, dependencies: dependencies, allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, isAutoDispose: isAutoDispose, runNotifierBuildOverride: build ?? runNotifierBuildOverride, from: from, @@ -120,6 +118,5 @@ class StreamNotifierProviderFamily< // providerFactory: FamilyStreamNotifierProvider._, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, ); } diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index 40aabbbbc..63b280383 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -48,7 +48,7 @@ final class StreamNotifierProvider< // NotifierT extends StreamNotifier, StateT> // extends $StreamNotifierProvider - with LegacyProviderEqualMixin> { + with LegacyProviderMixin> { /// {@macro riverpod.async_notifier_provider} /// /// {@macro riverpod.async_notifier_provider_modifier} @@ -63,7 +63,6 @@ final class StreamNotifierProvider< // computeAllTransitiveDependencies(dependencies), from: null, argument: null, - debugGetCreateSourceHash: null, ); StreamNotifierProvider._autoDispose( @@ -76,7 +75,6 @@ final class StreamNotifierProvider< // computeAllTransitiveDependencies(dependencies), from: null, argument: null, - debugGetCreateSourceHash: null, isAutoDispose: true, ); @@ -87,7 +85,6 @@ final class StreamNotifierProvider< // required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.from, required super.argument, required super.isAutoDispose, @@ -114,7 +111,6 @@ final class StreamNotifierProvider< // name: name, dependencies: dependencies, allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, from: from, argument: argument, isAutoDispose: isAutoDispose, diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index e9905d46b..16456edce 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -77,7 +77,7 @@ base class StreamProvider extends $FunctionalProvider< with $FutureModifier, $StreamProvider>>, - LegacyProviderEqualMixin> { + LegacyProviderMixin> { /// {@macro riverpod.stream_provider} StreamProvider( this._create, { @@ -89,7 +89,6 @@ base class StreamProvider extends $FunctionalProvider< computeAllTransitiveDependencies(dependencies), from: null, argument: null, - debugGetCreateSourceHash: null, ); StreamProvider._autoDispose( @@ -102,7 +101,6 @@ base class StreamProvider extends $FunctionalProvider< isAutoDispose: true, from: null, argument: null, - debugGetCreateSourceHash: null, ); /// An implementation detail of Riverpod @@ -112,7 +110,6 @@ base class StreamProvider extends $FunctionalProvider< required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.from, required super.argument, required super.isAutoDispose, @@ -148,7 +145,6 @@ base class StreamProvider extends $FunctionalProvider< name: name, dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: null, from: from, argument: argument, isAutoDispose: isAutoDispose, @@ -247,7 +243,6 @@ class StreamProviderFamily extends FunctionalFamily< providerFactory: StreamProvider.internal, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, ); /// Implementation detail of the code-generator. @@ -257,7 +252,6 @@ class StreamProviderFamily extends FunctionalFamily< required super.name, required super.dependencies, required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, required super.isAutoDispose, }) : super(providerFactory: StreamProvider.internal); @@ -270,6 +264,5 @@ class StreamProviderFamily extends FunctionalFamily< isAutoDispose: true, allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), - debugGetCreateSourceHash: null, ); } diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index bd0777ee8..61466a5c1 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -23,7 +23,6 @@ void main() { name: null, dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: () => 'hash', (ref) { constantHashBuild(); return 0; @@ -38,7 +37,6 @@ void main() { name: null, dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: () => hashResult, (ref) { changingHashBuild(); return 0; diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index cf6dd0474..fb80317ca 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -36,7 +36,7 @@ class FamilyTemplate extends Template { : 'argument: ($parametersPassThrough),'; buffer.writeln(''' -final class ${provider.familyTypeName} extends Family{ +final class ${provider.familyTypeName} extends Family { const ${provider.familyTypeName}._() : super( name: r'${provider.name}', From ba683268c752c2e0dca56a41ef53d890b1bdb32f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 13:14:05 +0100 Subject: [PATCH 156/387] Update generated hash to be a method too --- .../lib/src/templates/family.dart | 4 +- .../lib/src/templates/provider.dart | 3 +- .../test/integration/async.g.dart | 54 ++++++----- .../test/integration/auto_dispose.g.dart | 6 +- .../test/integration/dependencies.g.dart | 66 ++++++------- .../test/integration/dependencies2.g.dart | 26 +++-- .../test/integration/generated.g.dart | 67 ++++++------- .../test/integration/scopes.g.dart | 3 +- .../test/integration/split.g.dart | 6 +- .../test/integration/stream.g.dart | 40 ++++---- .../test/integration/sync.g.dart | 96 +++++++++---------- 11 files changed, 177 insertions(+), 194 deletions(-) diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index fb80317ca..b6c97ceb1 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -42,7 +42,6 @@ final class ${provider.familyTypeName} extends Family { name: r'${provider.name}', dependencies: ${provider.dependencies(options)}, allTransitiveDependencies: ${provider.allTransitiveDependencies(allTransitiveDependencies)}, - debugGetCreateSourceHash: ${provider.hashFnName}, ${provider.providerElement.isAutoDispose ? 'isAutoDispose: true,' : ''} ); @@ -52,6 +51,9 @@ final class ${provider.familyTypeName} extends Family { from: this ); + @override + String debugGetCreateSourceHash() => ${provider.hashFnName}(); + @override String toString() => r'${provider.name}'; } diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index e426b7321..dcd149a2b 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -117,7 +117,6 @@ final class $name$_genericsDefinition }): _createCb = create, super( $superParameters - debugGetCreateSourceHash: ${provider.hashFnName}, name: r'${provider.name}', isAutoDispose: ${!provider.annotation.element.keepAlive}, dependencies: ${!provider.providerElement.isFamily ? provider.dependencies(options) : 'null'}, @@ -148,7 +147,7 @@ final class $name$_genericsDefinition final ${provider.createType()}? _createCb; @override - void \$unimplemented() {} + String debugGetCreateSourceHash() => ${provider.hashFnName}(); '''); final localArgumentDefinition = provider.parameters.isNotEmpty diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 9eebb5fa2..917689d29 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -21,7 +21,6 @@ final class GenericProvider extends $FunctionalProvider< : _createCb = create, super( argument: null, - debugGetCreateSourceHash: _$genericHash, name: r'generic', isAutoDispose: true, dependencies: null, @@ -33,7 +32,7 @@ final class GenericProvider extends $FunctionalProvider< )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$genericHash(); @override $FutureProviderElement> createElement(ProviderContainer container) => @@ -73,12 +72,14 @@ final class GenericFamily extends Family { name: r'generic', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$genericHash, isAutoDispose: true, ); GenericProvider call() => GenericProvider._(from: this); + @override + String debugGetCreateSourceHash() => _$genericHash(); + @override String toString() => r'generic'; } @@ -98,7 +99,6 @@ final class PublicProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$publicHash, name: r'public', isAutoDispose: true, dependencies: null, @@ -110,7 +110,7 @@ final class PublicProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$publicHash(); @override $FutureProviderElement createElement(ProviderContainer container) => @@ -152,7 +152,6 @@ final class _PrivateProvider extends $FunctionalProvider, super( from: null, argument: null, - debugGetCreateSourceHash: _$privateHash, name: r'_private', isAutoDispose: true, dependencies: null, @@ -164,7 +163,7 @@ final class _PrivateProvider extends $FunctionalProvider, )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$privateHash(); @override $FutureProviderElement createElement(ProviderContainer container) => @@ -207,7 +206,6 @@ final class FamilyOrProvider extends $FunctionalProvider, )? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$familyOrHash, name: r'familyOr', isAutoDispose: true, dependencies: null, @@ -220,7 +218,7 @@ final class FamilyOrProvider extends $FunctionalProvider, )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$familyOrHash(); @override $FutureProviderElement createElement(ProviderContainer container) => @@ -266,7 +264,6 @@ final class FamilyOrFamily extends Family { name: r'familyOr', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$familyOrHash, isAutoDispose: true, ); @@ -275,6 +272,9 @@ final class FamilyOrFamily extends Family { ) => FamilyOrProvider._(argument: (first,), from: this); + @override + String debugGetCreateSourceHash() => _$familyOrHash(); + @override String toString() => r'familyOr'; } @@ -306,7 +306,6 @@ final class FamilyProvider })? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$familyHash, name: r'family', isAutoDispose: true, dependencies: null, @@ -323,7 +322,7 @@ final class FamilyProvider })? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$familyHash(); @override $FutureProviderElement createElement(ProviderContainer container) => @@ -395,7 +394,6 @@ final class FamilyFamily extends Family { name: r'family', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$familyHash, isAutoDispose: true, ); @@ -414,6 +412,9 @@ final class FamilyFamily extends Family { fifth: fifth, ), from: this); + @override + String debugGetCreateSourceHash() => _$familyHash(); + @override String toString() => r'family'; } @@ -429,7 +430,6 @@ final class GenericClassProvider : _createCb = create, super( argument: null, - debugGetCreateSourceHash: _$genericClassHash, name: r'GenericClass', isAutoDispose: true, dependencies: null, @@ -439,7 +439,7 @@ final class GenericClassProvider final GenericClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$genericClassHash(); @$internal @override @@ -485,13 +485,15 @@ final class GenericClassFamily extends Family { name: r'GenericClass', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$genericClassHash, isAutoDispose: true, ); GenericClassProvider call() => GenericClassProvider._(from: this); + @override + String debugGetCreateSourceHash() => _$genericClassHash(); + @override String toString() => r'GenericClass'; } @@ -514,7 +516,6 @@ final class PublicClassProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$publicClassHash, name: r'PublicClass', isAutoDispose: true, dependencies: null, @@ -524,7 +525,7 @@ final class PublicClassProvider final PublicClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$publicClassHash(); @$internal @override @@ -573,7 +574,6 @@ final class _PrivateClassProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$privateClassHash, name: r'_PrivateClass', isAutoDispose: true, dependencies: null, @@ -583,7 +583,7 @@ final class _PrivateClassProvider final _PrivateClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$privateClassHash(); @$internal @override @@ -633,7 +633,6 @@ final class FamilyOrClassProvider FamilyOrClass Function()? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$familyOrClassHash, name: r'FamilyOrClass', isAutoDispose: true, dependencies: null, @@ -643,7 +642,7 @@ final class FamilyOrClassProvider final FamilyOrClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$familyOrClassHash(); @$internal @override @@ -691,7 +690,6 @@ final class FamilyOrClassFamily extends Family { name: r'FamilyOrClass', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$familyOrClassHash, isAutoDispose: true, ); @@ -700,6 +698,9 @@ final class FamilyOrClassFamily extends Family { ) => FamilyOrClassProvider._(argument: (first,), from: this); + @override + String debugGetCreateSourceHash() => _$familyOrClassHash(); + @override String toString() => r'FamilyOrClass'; } @@ -738,7 +739,6 @@ final class FamilyClassProvider FamilyClass Function()? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$familyClassHash, name: r'FamilyClass', isAutoDispose: true, dependencies: null, @@ -748,7 +748,7 @@ final class FamilyClassProvider final FamilyClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$familyClassHash(); @$internal @override @@ -808,7 +808,6 @@ final class FamilyClassFamily extends Family { name: r'FamilyClass', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$familyClassHash, isAutoDispose: true, ); @@ -827,6 +826,9 @@ final class FamilyClassFamily extends Family { fifth: fifth, ), from: this); + @override + String debugGetCreateSourceHash() => _$familyClassHash(); + @override String toString() => r'FamilyClass'; } diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 2839450dc..9714f6e9e 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -21,7 +21,6 @@ final class KeepAliveProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$keepAliveHash, name: r'keepAlive', isAutoDispose: false, dependencies: null, @@ -33,7 +32,7 @@ final class KeepAliveProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$keepAliveHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -75,7 +74,6 @@ final class NotKeepAliveProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$notKeepAliveHash, name: r'notKeepAlive', isAutoDispose: true, dependencies: null, @@ -87,7 +85,7 @@ final class NotKeepAliveProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$notKeepAliveHash(); @override $ProviderElement createElement(ProviderContainer container) => diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index faa8ed5f6..981e3527b 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -20,7 +20,6 @@ final class DepProvider extends $FunctionalProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$depHash, name: r'dep', isAutoDispose: true, dependencies: null, @@ -32,7 +31,7 @@ final class DepProvider extends $FunctionalProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$depHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -74,7 +73,6 @@ final class FamilyProvider extends $FunctionalProvider )? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$familyHash, name: r'family', isAutoDispose: true, dependencies: null, @@ -87,7 +85,7 @@ final class FamilyProvider extends $FunctionalProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$familyHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -133,7 +131,6 @@ final class FamilyFamily extends Family { name: r'family', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$familyHash, isAutoDispose: true, ); @@ -142,6 +139,9 @@ final class FamilyFamily extends Family { ) => FamilyProvider._(argument: (id,), from: this); + @override + String debugGetCreateSourceHash() => _$familyHash(); + @override String toString() => r'family'; } @@ -160,7 +160,6 @@ final class ProviderProvider extends $FunctionalProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$providerHash, name: r'provider', isAutoDispose: true, dependencies: const [ @@ -187,7 +186,7 @@ final class ProviderProvider extends $FunctionalProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$providerHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -229,7 +228,6 @@ final class Provider2Provider super( from: null, argument: null, - debugGetCreateSourceHash: _$provider2Hash, name: r'provider2', isAutoDispose: true, dependencies: const [ @@ -256,7 +254,7 @@ final class Provider2Provider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$provider2Hash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -298,7 +296,6 @@ final class TransitiveDependenciesProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$transitiveDependenciesHash, name: r'transitiveDependencies', isAutoDispose: true, dependencies: const [providerProvider], @@ -326,7 +323,7 @@ final class TransitiveDependenciesProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$transitiveDependenciesHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -370,7 +367,6 @@ final class SmallTransitiveDependencyCountProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$smallTransitiveDependencyCountHash, name: r'smallTransitiveDependencyCount', isAutoDispose: true, dependencies: const [ @@ -394,7 +390,7 @@ final class SmallTransitiveDependencyCountProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$smallTransitiveDependencyCountHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -438,7 +434,6 @@ final class EmptyDependenciesFunctionalProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$emptyDependenciesFunctionalHash, name: r'emptyDependenciesFunctional', isAutoDispose: true, dependencies: const [], @@ -450,7 +445,7 @@ final class EmptyDependenciesFunctionalProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$emptyDependenciesFunctionalHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -493,7 +488,6 @@ final class ProviderWithDependenciesProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$providerWithDependenciesHash, name: r'providerWithDependencies', isAutoDispose: true, dependencies: const [ @@ -514,7 +508,7 @@ final class ProviderWithDependenciesProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$providerWithDependenciesHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -557,7 +551,6 @@ final class _PrivateDepProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$privateDepHash, name: r'_privateDep', isAutoDispose: true, dependencies: null, @@ -569,7 +562,7 @@ final class _PrivateDepProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$privateDepHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -611,7 +604,6 @@ final class PublicDepProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$publicDepHash, name: r'publicDep', isAutoDispose: true, dependencies: null, @@ -623,7 +615,7 @@ final class PublicDepProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$publicDepHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -665,7 +657,6 @@ final class DuplicateDependenciesProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$duplicateDependenciesHash, name: r'duplicateDependencies', isAutoDispose: true, dependencies: const [depProvider, dep2Provider], @@ -683,7 +674,7 @@ final class DuplicateDependenciesProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$duplicateDependenciesHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -726,7 +717,6 @@ final class DuplicateDependencies2Provider super( from: null, argument: null, - debugGetCreateSourceHash: _$duplicateDependencies2Hash, name: r'duplicateDependencies2', isAutoDispose: true, dependencies: const [ @@ -747,7 +737,7 @@ final class DuplicateDependencies2Provider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$duplicateDependencies2Hash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -791,7 +781,6 @@ final class TransitiveDuplicateDependenciesProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$transitiveDuplicateDependenciesHash, name: r'transitiveDuplicateDependencies', isAutoDispose: true, dependencies: const [ @@ -824,7 +813,7 @@ final class TransitiveDuplicateDependenciesProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$transitiveDuplicateDependenciesHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -861,7 +850,6 @@ final class Dep2Provider extends $NotifierProvider { super( from: null, argument: null, - debugGetCreateSourceHash: _$dep2Hash, name: r'Dep2', isAutoDispose: true, dependencies: null, @@ -871,7 +859,7 @@ final class Dep2Provider extends $NotifierProvider { final Dep2 Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$dep2Hash(); @$internal @override @@ -920,7 +908,6 @@ final class Family2Provider extends $NotifierProvider { Family2 Function()? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$family2Hash, name: r'Family2', isAutoDispose: true, dependencies: null, @@ -930,7 +917,7 @@ final class Family2Provider extends $NotifierProvider { final Family2 Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$family2Hash(); @$internal @override @@ -978,7 +965,6 @@ final class Family2Family extends Family { name: r'Family2', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$family2Hash, isAutoDispose: true, ); @@ -987,6 +973,9 @@ final class Family2Family extends Family { ) => Family2Provider._(argument: (id,), from: this); + @override + String debugGetCreateSourceHash() => _$family2Hash(); + @override String toString() => r'Family2'; } @@ -1016,7 +1005,6 @@ final class Provider3Provider extends $NotifierProvider { super( from: null, argument: null, - debugGetCreateSourceHash: _$provider3Hash, name: r'Provider3', isAutoDispose: true, dependencies: const [ @@ -1041,7 +1029,7 @@ final class Provider3Provider extends $NotifierProvider { final Provider3 Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$provider3Hash(); @$internal @override @@ -1090,7 +1078,6 @@ final class Provider4Provider extends $NotifierProvider { Provider4 Function()? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$provider4Hash, name: r'Provider4', isAutoDispose: true, dependencies: null, @@ -1105,7 +1092,7 @@ final class Provider4Provider extends $NotifierProvider { final Provider4 Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$provider4Hash(); @$internal @override @@ -1163,7 +1150,6 @@ final class Provider4Family extends Family { Provider4Provider.$allTransitiveDependencies2, Provider4Provider.$allTransitiveDependencies3, }, - debugGetCreateSourceHash: _$provider4Hash, isAutoDispose: true, ); @@ -1172,6 +1158,9 @@ final class Provider4Family extends Family { ) => Provider4Provider._(argument: (id,), from: this); + @override + String debugGetCreateSourceHash() => _$provider4Hash(); + @override String toString() => r'Provider4'; } @@ -1204,7 +1193,6 @@ final class EmptyDependenciesClassBasedProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$emptyDependenciesClassBasedHash, name: r'EmptyDependenciesClassBased', isAutoDispose: true, dependencies: const [], @@ -1214,7 +1202,7 @@ final class EmptyDependenciesClassBasedProvider final EmptyDependenciesClassBased Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$emptyDependenciesClassBasedHash(); @$internal @override diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 196b282de..a2f99463c 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -21,7 +21,6 @@ final class ProviderWithDependencies2Provider super( from: null, argument: null, - debugGetCreateSourceHash: _$providerWithDependencies2Hash, name: r'providerWithDependencies2', isAutoDispose: true, dependencies: const [ @@ -51,7 +50,7 @@ final class ProviderWithDependencies2Provider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$providerWithDependencies2Hash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -98,7 +97,6 @@ final class FamilyWithDependencies2Provider })? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$familyWithDependencies2Hash, name: r'familyWithDependencies2', isAutoDispose: true, dependencies: null, @@ -119,7 +117,7 @@ final class FamilyWithDependencies2Provider })? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$familyWithDependencies2Hash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -183,7 +181,6 @@ final class FamilyWithDependencies2Family extends Family { FamilyWithDependencies2Provider.$allTransitiveDependencies3, FamilyWithDependencies2Provider.$allTransitiveDependencies4, }, - debugGetCreateSourceHash: _$familyWithDependencies2Hash, isAutoDispose: true, ); @@ -192,6 +189,9 @@ final class FamilyWithDependencies2Family extends Family { }) => FamilyWithDependencies2Provider._(argument: (id: id,), from: this); + @override + String debugGetCreateSourceHash() => _$familyWithDependencies2Hash(); + @override String toString() => r'familyWithDependencies2'; } @@ -211,7 +211,6 @@ final class _Private2Provider super( from: null, argument: null, - debugGetCreateSourceHash: _$private2Hash, name: r'_private2', isAutoDispose: true, dependencies: null, @@ -223,7 +222,7 @@ final class _Private2Provider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$private2Hash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -264,7 +263,6 @@ final class Public2Provider extends $FunctionalProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$public2Hash, name: r'public2', isAutoDispose: true, dependencies: null, @@ -276,7 +274,7 @@ final class Public2Provider extends $FunctionalProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$public2Hash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -314,7 +312,6 @@ final class NotifierWithDependenciesProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$notifierWithDependenciesHash, name: r'NotifierWithDependencies', isAutoDispose: true, dependencies: const [ @@ -342,7 +339,7 @@ final class NotifierWithDependenciesProvider final NotifierWithDependencies Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$notifierWithDependenciesHash(); @$internal @override @@ -398,7 +395,6 @@ final class NotifierFamilyWithDependenciesProvider NotifierFamilyWithDependencies Function()? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$notifierFamilyWithDependenciesHash, name: r'NotifierFamilyWithDependencies', isAutoDispose: true, dependencies: null, @@ -416,7 +412,7 @@ final class NotifierFamilyWithDependenciesProvider final NotifierFamilyWithDependencies Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$notifierFamilyWithDependenciesHash(); @$internal @override @@ -481,7 +477,6 @@ final class NotifierFamilyWithDependenciesFamily extends Family { NotifierFamilyWithDependenciesProvider.$allTransitiveDependencies3, NotifierFamilyWithDependenciesProvider.$allTransitiveDependencies4, }, - debugGetCreateSourceHash: _$notifierFamilyWithDependenciesHash, isAutoDispose: true, ); @@ -490,6 +485,9 @@ final class NotifierFamilyWithDependenciesFamily extends Family { }) => NotifierFamilyWithDependenciesProvider._(argument: (id: id,), from: this); + @override + String debugGetCreateSourceHash() => _$notifierFamilyWithDependenciesHash(); + @override String toString() => r'NotifierFamilyWithDependencies'; } diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 3b640b4f3..9b65631cf 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -21,7 +21,6 @@ final class GeneratedProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$generatedHash, name: r'generated', isAutoDispose: true, dependencies: null, @@ -33,7 +32,7 @@ final class GeneratedProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$generatedHash(); @override $ProviderElement<_Test> createElement(ProviderContainer container) => @@ -76,7 +75,6 @@ final class GeneratedFamilyProvider )? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$generatedFamilyHash, name: r'generatedFamily', isAutoDispose: true, dependencies: null, @@ -89,7 +87,7 @@ final class GeneratedFamilyProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$generatedFamilyHash(); @override $ProviderElement<_Test> createElement(ProviderContainer container) => @@ -135,7 +133,6 @@ final class GeneratedFamilyFamily extends Family { name: r'generatedFamily', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$generatedFamilyHash, isAutoDispose: true, ); @@ -144,6 +141,9 @@ final class GeneratedFamilyFamily extends Family { ) => GeneratedFamilyProvider._(argument: (test,), from: this); + @override + String debugGetCreateSourceHash() => _$generatedFamilyHash(); + @override String toString() => r'generatedFamily'; } @@ -163,7 +163,6 @@ final class $DynamicProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$$dynamicHash, name: r'$dynamic', isAutoDispose: true, dependencies: null, @@ -175,7 +174,7 @@ final class $DynamicProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$$dynamicHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -218,7 +217,6 @@ final class $DynamicFamilyProvider )? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$$dynamicFamilyHash, name: r'$dynamicFamily', isAutoDispose: true, dependencies: null, @@ -231,7 +229,7 @@ final class $DynamicFamilyProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$$dynamicFamilyHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -277,7 +275,6 @@ final class $DynamicFamilyFamily extends Family { name: r'$dynamicFamily', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$$dynamicFamilyHash, isAutoDispose: true, ); @@ -286,6 +283,9 @@ final class $DynamicFamilyFamily extends Family { ) => $DynamicFamilyProvider._(argument: (test,), from: this); + @override + String debugGetCreateSourceHash() => _$$dynamicFamilyHash(); + @override String toString() => r'$dynamicFamily'; } @@ -306,7 +306,6 @@ final class _DynamicProvider )? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$dynamicHash, name: r'_dynamic', isAutoDispose: true, dependencies: null, @@ -319,7 +318,7 @@ final class _DynamicProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$dynamicHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -365,7 +364,6 @@ final class _DynamicFamily extends Family { name: r'_dynamic', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$dynamicHash, isAutoDispose: true, ); @@ -374,6 +372,9 @@ final class _DynamicFamily extends Family { ) => _DynamicProvider._(argument: (test,), from: this); + @override + String debugGetCreateSourceHash() => _$dynamicHash(); + @override String toString() => r'_dynamic'; } @@ -393,7 +394,6 @@ final class AliasProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$aliasHash, name: r'alias', isAutoDispose: true, dependencies: null, @@ -405,7 +405,7 @@ final class AliasProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$aliasHash(); @override $ProviderElement> createElement( @@ -450,7 +450,6 @@ final class AliasFamilyProvider extends $FunctionalProvider< )? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$aliasFamilyHash, name: r'aliasFamily', isAutoDispose: true, dependencies: null, @@ -463,7 +462,7 @@ final class AliasFamilyProvider extends $FunctionalProvider< )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$aliasFamilyHash(); @override $ProviderElement> createElement( @@ -511,7 +510,6 @@ final class AliasFamilyFamily extends Family { name: r'aliasFamily', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$aliasFamilyHash, isAutoDispose: true, ); @@ -520,6 +518,9 @@ final class AliasFamilyFamily extends Family { ) => AliasFamilyProvider._(argument: (test,), from: this); + @override + String debugGetCreateSourceHash() => _$aliasFamilyHash(); + @override String toString() => r'aliasFamily'; } @@ -534,7 +535,6 @@ final class GeneratedClassProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$generatedClassHash, name: r'GeneratedClass', isAutoDispose: true, dependencies: null, @@ -544,7 +544,7 @@ final class GeneratedClassProvider final GeneratedClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$generatedClassHash(); @$internal @override @@ -594,7 +594,6 @@ final class GeneratedClassFamilyProvider GeneratedClassFamily Function()? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$generatedClassFamilyHash, name: r'GeneratedClassFamily', isAutoDispose: true, dependencies: null, @@ -604,7 +603,7 @@ final class GeneratedClassFamilyProvider final GeneratedClassFamily Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$generatedClassFamilyHash(); @$internal @override @@ -653,7 +652,6 @@ final class GeneratedClassFamilyFamily extends Family { name: r'GeneratedClassFamily', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$generatedClassFamilyHash, isAutoDispose: true, ); @@ -662,6 +660,9 @@ final class GeneratedClassFamilyFamily extends Family { ) => GeneratedClassFamilyProvider._(argument: (test,), from: this); + @override + String debugGetCreateSourceHash() => _$generatedClassFamilyHash(); + @override String toString() => r'GeneratedClassFamily'; } @@ -692,7 +693,6 @@ final class $DynamicClassProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$$dynamicClassHash, name: r'$DynamicClass', isAutoDispose: true, dependencies: null, @@ -702,7 +702,7 @@ final class $DynamicClassProvider final $DynamicClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$$dynamicClassHash(); @$internal @override @@ -752,7 +752,6 @@ final class $DynamicClassFamilyProvider $DynamicClassFamily Function()? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$$dynamicClassFamilyHash, name: r'$DynamicClassFamily', isAutoDispose: true, dependencies: null, @@ -762,7 +761,7 @@ final class $DynamicClassFamilyProvider final $DynamicClassFamily Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$$dynamicClassFamilyHash(); @$internal @override @@ -811,7 +810,6 @@ final class $DynamicClassFamilyFamily extends Family { name: r'$DynamicClassFamily', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$$dynamicClassFamilyHash, isAutoDispose: true, ); @@ -820,6 +818,9 @@ final class $DynamicClassFamilyFamily extends Family { ) => $DynamicClassFamilyProvider._(argument: (test,), from: this); + @override + String debugGetCreateSourceHash() => _$$dynamicClassFamilyHash(); + @override String toString() => r'$DynamicClassFamily'; } @@ -850,7 +851,6 @@ final class AliasClassProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$aliasClassHash, name: r'AliasClass', isAutoDispose: true, dependencies: null, @@ -860,7 +860,7 @@ final class AliasClassProvider final AliasClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$aliasClassHash(); @$internal @override @@ -910,7 +910,6 @@ final class AliasClassFamilyProvider AliasClassFamily Function()? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$aliasClassFamilyHash, name: r'AliasClassFamily', isAutoDispose: true, dependencies: null, @@ -920,7 +919,7 @@ final class AliasClassFamilyProvider final AliasClassFamily Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$aliasClassFamilyHash(); @$internal @override @@ -968,7 +967,6 @@ final class AliasClassFamilyFamily extends Family { name: r'AliasClassFamily', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$aliasClassFamilyHash, isAutoDispose: true, ); @@ -977,6 +975,9 @@ final class AliasClassFamilyFamily extends Family { ) => AliasClassFamilyProvider._(argument: (test,), from: this); + @override + String debugGetCreateSourceHash() => _$aliasClassFamilyHash(); + @override String toString() => r'AliasClassFamily'; } diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 71d2ba033..e84106f57 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -20,7 +20,6 @@ final class ScopedProvider extends $FunctionalProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$scopedHash, name: r'scoped', isAutoDispose: true, dependencies: null, @@ -32,7 +31,7 @@ final class ScopedProvider extends $FunctionalProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$scopedHash(); @override $ProviderElement createElement(ProviderContainer container) => diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index 945efcd90..73c5bd54a 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -20,7 +20,6 @@ final class Counter2Provider extends $FunctionalProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$counter2Hash, name: r'counter2', isAutoDispose: true, dependencies: null, @@ -32,7 +31,7 @@ final class Counter2Provider extends $FunctionalProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$counter2Hash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -73,7 +72,6 @@ final class CounterProvider extends $FunctionalProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$counterHash, name: r'counter', isAutoDispose: true, dependencies: null, @@ -85,7 +83,7 @@ final class CounterProvider extends $FunctionalProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$counterHash(); @override $ProviderElement createElement(ProviderContainer container) => diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 0dfbe6596..492799042 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -21,7 +21,6 @@ final class GenericProvider extends $FunctionalProvider< : _createCb = create, super( argument: null, - debugGetCreateSourceHash: _$genericHash, name: r'generic', isAutoDispose: true, dependencies: null, @@ -33,7 +32,7 @@ final class GenericProvider extends $FunctionalProvider< )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$genericHash(); @override $StreamProviderElement> createElement(ProviderContainer container) => @@ -73,12 +72,14 @@ final class GenericFamily extends Family { name: r'generic', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$genericHash, isAutoDispose: true, ); GenericProvider call() => GenericProvider._(from: this); + @override + String debugGetCreateSourceHash() => _$genericHash(); + @override String toString() => r'generic'; } @@ -98,7 +99,6 @@ final class PublicProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$publicHash, name: r'public', isAutoDispose: true, dependencies: null, @@ -110,7 +110,7 @@ final class PublicProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$publicHash(); @override $StreamProviderElement createElement(ProviderContainer container) => @@ -152,7 +152,6 @@ final class _PrivateProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$privateHash, name: r'_private', isAutoDispose: true, dependencies: null, @@ -164,7 +163,7 @@ final class _PrivateProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$privateHash(); @override $StreamProviderElement createElement(ProviderContainer container) => @@ -218,7 +217,6 @@ final class FamilyProvider })? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$familyHash, name: r'family', isAutoDispose: true, dependencies: null, @@ -235,7 +233,7 @@ final class FamilyProvider })? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$familyHash(); @override $StreamProviderElement createElement(ProviderContainer container) => @@ -307,7 +305,6 @@ final class FamilyFamily extends Family { name: r'family', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$familyHash, isAutoDispose: true, ); @@ -326,6 +323,9 @@ final class FamilyFamily extends Family { fifth: fifth, ), from: this); + @override + String debugGetCreateSourceHash() => _$familyHash(); + @override String toString() => r'family'; } @@ -341,7 +341,6 @@ final class GenericClassProvider : _createCb = create, super( argument: null, - debugGetCreateSourceHash: _$genericClassHash, name: r'GenericClass', isAutoDispose: true, dependencies: null, @@ -351,7 +350,7 @@ final class GenericClassProvider final GenericClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$genericClassHash(); @$internal @override @@ -397,13 +396,15 @@ final class GenericClassFamily extends Family { name: r'GenericClass', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$genericClassHash, isAutoDispose: true, ); GenericClassProvider call() => GenericClassProvider._(from: this); + @override + String debugGetCreateSourceHash() => _$genericClassHash(); + @override String toString() => r'GenericClass'; } @@ -426,7 +427,6 @@ final class PublicClassProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$publicClassHash, name: r'PublicClass', isAutoDispose: true, dependencies: null, @@ -436,7 +436,7 @@ final class PublicClassProvider final PublicClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$publicClassHash(); @$internal @override @@ -485,7 +485,6 @@ final class _PrivateClassProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$privateClassHash, name: r'_PrivateClass', isAutoDispose: true, dependencies: null, @@ -495,7 +494,7 @@ final class _PrivateClassProvider final _PrivateClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$privateClassHash(); @$internal @override @@ -552,7 +551,6 @@ final class FamilyClassProvider FamilyClass Function()? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$familyClassHash, name: r'FamilyClass', isAutoDispose: true, dependencies: null, @@ -562,7 +560,7 @@ final class FamilyClassProvider final FamilyClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$familyClassHash(); @$internal @override @@ -622,7 +620,6 @@ final class FamilyClassFamily extends Family { name: r'FamilyClass', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$familyClassHash, isAutoDispose: true, ); @@ -641,6 +638,9 @@ final class FamilyClassFamily extends Family { fifth: fifth, ), from: this); + @override + String debugGetCreateSourceHash() => _$familyClassHash(); + @override String toString() => r'FamilyClass'; } diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 9f0bced46..031885281 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -21,7 +21,6 @@ final class GenericProvider : _createCb = create, super( argument: null, - debugGetCreateSourceHash: _$genericHash, name: r'generic', isAutoDispose: true, dependencies: null, @@ -33,7 +32,7 @@ final class GenericProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$genericHash(); @override $ProviderElement> createElement(ProviderContainer container) => @@ -73,12 +72,14 @@ final class GenericFamily extends Family { name: r'generic', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$genericHash, isAutoDispose: true, ); GenericProvider call() => GenericProvider._(from: this); + @override + String debugGetCreateSourceHash() => _$genericHash(); + @override String toString() => r'generic'; } @@ -104,7 +105,6 @@ final class ComplexGenericProvider })? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$complexGenericHash, name: r'complexGeneric', isAutoDispose: true, dependencies: null, @@ -118,7 +118,7 @@ final class ComplexGenericProvider })? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$complexGenericHash(); @override $ProviderElement> createElement(ProviderContainer container) => @@ -177,7 +177,6 @@ final class ComplexGenericFamily extends Family { name: r'complexGeneric', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$complexGenericHash, isAutoDispose: true, ); @@ -190,6 +189,9 @@ final class ComplexGenericFamily extends Family { otherParam: otherParam, ), from: this); + @override + String debugGetCreateSourceHash() => _$complexGenericHash(); + @override String toString() => r'complexGeneric'; } @@ -211,7 +213,6 @@ final class RawFutureProvider extends $FunctionalProvider>, super( from: null, argument: null, - debugGetCreateSourceHash: _$rawFutureHash, name: r'rawFuture', isAutoDispose: true, dependencies: null, @@ -223,7 +224,7 @@ final class RawFutureProvider extends $FunctionalProvider>, )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$rawFutureHash(); @override $FutureProviderElement>> createElement( @@ -268,7 +269,6 @@ final class RawStreamProvider extends $FunctionalProvider>, super( from: null, argument: null, - debugGetCreateSourceHash: _$rawStreamHash, name: r'rawStream', isAutoDispose: true, dependencies: null, @@ -280,7 +280,7 @@ final class RawStreamProvider extends $FunctionalProvider>, )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$rawStreamHash(); @override $StreamProviderElement>> createElement( @@ -326,7 +326,6 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< )? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$rawFamilyFutureHash, name: r'rawFamilyFuture', isAutoDispose: true, dependencies: null, @@ -339,7 +338,7 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$rawFamilyFutureHash(); @override $FutureProviderElement>> createElement( @@ -386,7 +385,6 @@ final class RawFamilyFutureFamily extends Family { name: r'rawFamilyFuture', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$rawFamilyFutureHash, isAutoDispose: true, ); @@ -395,6 +393,9 @@ final class RawFamilyFutureFamily extends Family { ) => RawFamilyFutureProvider._(argument: (id,), from: this); + @override + String debugGetCreateSourceHash() => _$rawFamilyFutureHash(); + @override String toString() => r'rawFamilyFuture'; } @@ -417,7 +418,6 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< )? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$rawFamilyStreamHash, name: r'rawFamilyStream', isAutoDispose: true, dependencies: null, @@ -430,7 +430,7 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$rawFamilyStreamHash(); @override $StreamProviderElement>> createElement( @@ -477,7 +477,6 @@ final class RawFamilyStreamFamily extends Family { name: r'rawFamilyStream', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$rawFamilyStreamHash, isAutoDispose: true, ); @@ -486,6 +485,9 @@ final class RawFamilyStreamFamily extends Family { ) => RawFamilyStreamProvider._(argument: (id,), from: this); + @override + String debugGetCreateSourceHash() => _$rawFamilyStreamHash(); + @override String toString() => r'rawFamilyStream'; } @@ -505,7 +507,6 @@ final class PublicProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$publicHash, name: r'public', isAutoDispose: true, dependencies: null, @@ -517,7 +518,7 @@ final class PublicProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$publicHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -559,7 +560,6 @@ final class Supports$inNamesProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$supports$inNamesHash, name: r'supports$inNames', isAutoDispose: true, dependencies: null, @@ -571,7 +571,7 @@ final class Supports$inNamesProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$supports$inNamesHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -625,7 +625,6 @@ final class FamilyProvider })? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$familyHash, name: r'family', isAutoDispose: true, dependencies: null, @@ -642,7 +641,7 @@ final class FamilyProvider })? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$familyHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -714,7 +713,6 @@ final class FamilyFamily extends Family { name: r'family', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$familyHash, isAutoDispose: true, ); @@ -733,6 +731,9 @@ final class FamilyFamily extends Family { fifth: fifth, ), from: this); + @override + String debugGetCreateSourceHash() => _$familyHash(); + @override String toString() => r'family'; } @@ -752,7 +753,6 @@ final class _PrivateProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$privateHash, name: r'_private', isAutoDispose: true, dependencies: null, @@ -764,7 +764,7 @@ final class _PrivateProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$privateHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -806,7 +806,6 @@ final class GeneratedProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$generatedHash, name: r'generated', isAutoDispose: true, dependencies: null, @@ -818,7 +817,7 @@ final class GeneratedProvider )? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$generatedHash(); @override $ProviderElement createElement(ProviderContainer container) => @@ -856,7 +855,6 @@ final class GenericClassProvider : _createCb = create, super( argument: null, - debugGetCreateSourceHash: _$genericClassHash, name: r'GenericClass', isAutoDispose: true, dependencies: null, @@ -866,7 +864,7 @@ final class GenericClassProvider final GenericClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$genericClassHash(); @$internal @override @@ -912,13 +910,15 @@ final class GenericClassFamily extends Family { name: r'GenericClass', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$genericClassHash, isAutoDispose: true, ); GenericClassProvider call() => GenericClassProvider._(from: this); + @override + String debugGetCreateSourceHash() => _$genericClassHash(); + @override String toString() => r'GenericClass'; } @@ -941,7 +941,6 @@ final class RawFutureClassProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$rawFutureClassHash, name: r'RawFutureClass', isAutoDispose: true, dependencies: null, @@ -951,7 +950,7 @@ final class RawFutureClassProvider final RawFutureClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$rawFutureClassHash(); @$internal @override @@ -1001,7 +1000,6 @@ final class RawStreamClassProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$rawStreamClassHash, name: r'RawStreamClass', isAutoDispose: true, dependencies: null, @@ -1011,7 +1009,7 @@ final class RawStreamClassProvider final RawStreamClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$rawStreamClassHash(); @$internal @override @@ -1062,7 +1060,6 @@ final class RawFamilyFutureClassProvider RawFamilyFutureClass Function()? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$rawFamilyFutureClassHash, name: r'RawFamilyFutureClass', isAutoDispose: true, dependencies: null, @@ -1072,7 +1069,7 @@ final class RawFamilyFutureClassProvider final RawFamilyFutureClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$rawFamilyFutureClassHash(); @$internal @override @@ -1122,7 +1119,6 @@ final class RawFamilyFutureClassFamily extends Family { name: r'RawFamilyFutureClass', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$rawFamilyFutureClassHash, isAutoDispose: true, ); @@ -1131,6 +1127,9 @@ final class RawFamilyFutureClassFamily extends Family { ) => RawFamilyFutureClassProvider._(argument: (id,), from: this); + @override + String debugGetCreateSourceHash() => _$rawFamilyFutureClassHash(); + @override String toString() => r'RawFamilyFutureClass'; } @@ -1163,7 +1162,6 @@ final class RawFamilyStreamClassProvider RawFamilyStreamClass Function()? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$rawFamilyStreamClassHash, name: r'RawFamilyStreamClass', isAutoDispose: true, dependencies: null, @@ -1173,7 +1171,7 @@ final class RawFamilyStreamClassProvider final RawFamilyStreamClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$rawFamilyStreamClassHash(); @$internal @override @@ -1223,7 +1221,6 @@ final class RawFamilyStreamClassFamily extends Family { name: r'RawFamilyStreamClass', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$rawFamilyStreamClassHash, isAutoDispose: true, ); @@ -1232,6 +1229,9 @@ final class RawFamilyStreamClassFamily extends Family { ) => RawFamilyStreamClassProvider._(argument: (id,), from: this); + @override + String debugGetCreateSourceHash() => _$rawFamilyStreamClassHash(); + @override String toString() => r'RawFamilyStreamClass'; } @@ -1262,7 +1262,6 @@ final class PublicClassProvider extends $NotifierProvider { super( from: null, argument: null, - debugGetCreateSourceHash: _$publicClassHash, name: r'PublicClass', isAutoDispose: true, dependencies: null, @@ -1272,7 +1271,7 @@ final class PublicClassProvider extends $NotifierProvider { final PublicClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$publicClassHash(); @$internal @override @@ -1321,7 +1320,6 @@ final class _PrivateClassProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$privateClassHash, name: r'_PrivateClass', isAutoDispose: true, dependencies: null, @@ -1331,7 +1329,7 @@ final class _PrivateClassProvider final _PrivateClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$privateClassHash(); @$internal @override @@ -1387,7 +1385,6 @@ final class FamilyClassProvider extends $NotifierProvider { FamilyClass Function()? create}) : _createCb = create, super( - debugGetCreateSourceHash: _$familyClassHash, name: r'FamilyClass', isAutoDispose: true, dependencies: null, @@ -1397,7 +1394,7 @@ final class FamilyClassProvider extends $NotifierProvider { final FamilyClass Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$familyClassHash(); @$internal @override @@ -1457,7 +1454,6 @@ final class FamilyClassFamily extends Family { name: r'FamilyClass', dependencies: null, allTransitiveDependencies: null, - debugGetCreateSourceHash: _$familyClassHash, isAutoDispose: true, ); @@ -1476,6 +1472,9 @@ final class FamilyClassFamily extends Family { fifth: fifth, ), from: this); + @override + String debugGetCreateSourceHash() => _$familyClassHash(); + @override String toString() => r'FamilyClass'; } @@ -1523,7 +1522,6 @@ final class Supports$InClassNameProvider super( from: null, argument: null, - debugGetCreateSourceHash: _$supports$InClassNameHash, name: r'Supports$InClassName', isAutoDispose: true, dependencies: null, @@ -1533,7 +1531,7 @@ final class Supports$InClassNameProvider final Supports$InClassName Function()? _createCb; @override - void $unimplemented() {} + String debugGetCreateSourceHash() => _$supports$InClassNameHash(); @$internal @override From 59d5a2d6cf2259c18e9bc3bf553a8f86436b539a Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 13:25:47 +0100 Subject: [PATCH 157/387] Fix provider names --- .../integration/build_yaml/lib/main.dart | 136 +- .../integration/build_yaml/lib/main.g.dart | 2098 +++++++---------- .../lib/src/riverpod_generator.dart | 6 +- .../lib/src/templates/family.dart | 2 +- .../lib/src/templates/provider.dart | 2 +- .../test/integration/async.g.dart | 32 +- .../test/integration/auto_dispose.g.dart | 4 +- .../test/integration/dependencies.g.dart | 42 +- .../test/integration/dependencies2.g.dart | 16 +- .../test/integration/generated.g.dart | 40 +- .../test/integration/scopes.g.dart | 2 +- .../test/integration/split.g.dart | 4 +- .../test/integration/stream.g.dart | 24 +- .../test/integration/sync.g.dart | 58 +- 14 files changed, 1096 insertions(+), 1370 deletions(-) diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.dart index ff11a759c..1cfb4ea9a 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.dart @@ -1,81 +1,81 @@ -// import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; -// part 'main.g.dart'; +part 'main.g.dart'; -// @riverpod -// int count(CountRef ref) { -// return 1; -// } +@riverpod +int count(CountRef ref) { + return 1; +} -// @riverpod -// FutureOr countFuture(CountFutureRef ref) { -// return 1; -// } +@riverpod +FutureOr countFuture(CountFutureRef ref) { + return 1; +} -// @riverpod -// Stream countStream(CountStreamRef ref) { -// return Stream.value(1); -// } +@riverpod +Stream countStream(CountStreamRef ref) { + return Stream.value(1); +} -// @riverpod -// class CountNotifier extends _$CountNotifier { -// @override -// int build() { -// return 1; -// } -// } +@riverpod +class CountNotifier extends _$CountNotifier { + @override + int build() { + return 1; + } +} -// @riverpod -// class CountAsyncNotifier extends _$CountAsyncNotifier { -// @override -// FutureOr build() { -// return 1; -// } -// } +@riverpod +class CountAsyncNotifier extends _$CountAsyncNotifier { + @override + FutureOr build() { + return 1; + } +} -// @riverpod -// class CountStreamNotifier extends _$CountStreamNotifier { -// @override -// Stream build() { -// return Stream.value(1); -// } -// } +@riverpod +class CountStreamNotifier extends _$CountStreamNotifier { + @override + Stream build() { + return Stream.value(1); + } +} -// @riverpod -// int count2(Count2Ref ref, int a) { -// return 1; -// } +@riverpod +int count2(Count2Ref ref, int a) { + return 1; +} -// @riverpod -// FutureOr countFuture2(CountFuture2Ref ref, int a) { -// return 1; -// } +@riverpod +FutureOr countFuture2(CountFuture2Ref ref, int a) { + return 1; +} -// @riverpod -// Stream countStream2(CountStream2Ref ref, int a) { -// return Stream.value(1); -// } +@riverpod +Stream countStream2(CountStream2Ref ref, int a) { + return Stream.value(1); +} -// @riverpod -// class CountNotifier2 extends _$CountNotifier2 { -// @override -// int build(int a) { -// return 1; -// } -// } +@riverpod +class CountNotifier2 extends _$CountNotifier2 { + @override + int build(int a) { + return 1; + } +} -// @riverpod -// class CountAsyncNotifier2 extends _$CountAsyncNotifier2 { -// @override -// FutureOr build(int a) { -// return 1; -// } -// } +@riverpod +class CountAsyncNotifier2 extends _$CountAsyncNotifier2 { + @override + FutureOr build(int a) { + return 1; + } +} -// @riverpod -// class CountStreamNotifier2 extends _$CountStreamNotifier2 { -// @override -// Stream build(int a) { -// return Stream.value(1); -// } -// } +@riverpod +class CountStreamNotifier2 extends _$CountStreamNotifier2 { + @override + Stream build(int a) { + return Stream.value(1); + } +} diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index f22019d26..64974141c 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -1,1188 +1,910 @@ -// // GENERATED CODE - DO NOT MODIFY BY HAND - -// part of 'main.dart'; - -// // ************************************************************************** -// // RiverpodGenerator -// // ************************************************************************** - -// String _$countHash() => r'4c7e72b275767a60ece5e8662ab1e28f73cf7e44'; - -// /// See also [count]. -// @ProviderFor(count) -// final countPod = AutoDisposeProvider.internal( -// count, -// name: r'countPod', -// debugGetCreateSourceHash: -// const bool.fromEnvironment('dart.vm.product') ? null : _$countHash, -// dependencies: null, -// allTransitiveDependencies: null, -// ); - -// typedef CountRef = AutoDisposeProviderRef; -// String _$countFutureHash() => r'ec7cc31ce1c1a10607f1dcb35dd217acd2877729'; - -// /// See also [countFuture]. -// @ProviderFor(countFuture) -// final countFuturePod = AutoDisposeFutureProvider.internal( -// countFuture, -// name: r'countFuturePod', -// debugGetCreateSourceHash: -// const bool.fromEnvironment('dart.vm.product') ? null : _$countFutureHash, -// dependencies: null, -// allTransitiveDependencies: null, -// ); - -// typedef CountFutureRef = AutoDisposeFutureProviderRef; -// String _$countStreamHash() => r'1dbe49244ea19e8dbc3af0534429bb323720c07a'; - -// /// See also [countStream]. -// @ProviderFor(countStream) -// final countStreamPod = AutoDisposeStreamProvider.internal( -// countStream, -// name: r'countStreamPod', -// debugGetCreateSourceHash: -// const bool.fromEnvironment('dart.vm.product') ? null : _$countStreamHash, -// dependencies: null, -// allTransitiveDependencies: null, -// ); - -// typedef CountStreamRef = AutoDisposeStreamProviderRef; -// String _$count2Hash() => r'6256825480d83bb13acde282cf3c9d9524cc3a6c'; - -// /// Copied from Dart SDK -// class _SystemHash { -// _SystemHash._(); - -// static int combine(int hash, int value) { -// // ignore: parameter_assignments -// hash = 0x1fffffff & (hash + value); -// // ignore: parameter_assignments -// hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); -// return hash ^ (hash >> 6); -// } - -// static int finish(int hash) { -// // ignore: parameter_assignments -// hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); -// // ignore: parameter_assignments -// hash = hash ^ (hash >> 11); -// return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); -// } -// } - -// /// See also [count2]. -// @ProviderFor(count2) -// const count2ProviderFamily = Count2Family(); - -// /// See also [count2]. -// class Count2Family extends Family { -// /// See also [count2]. -// const Count2Family(); - -// static const Iterable? _dependencies = null; - -// static const Iterable? _allTransitiveDependencies = null; - -// @override -// Iterable? get dependencies => _dependencies; - -// @override -// Iterable? get allTransitiveDependencies => -// _allTransitiveDependencies; - -// @override -// String? get name => r'count2ProviderFamily'; - -// /// See also [count2]. -// Count2Provider call( -// int a, -// ) { -// return Count2Provider( -// a, -// ); -// } - -// /// Enables overriding the behavior of this provider, no matter the parameters. -// Override overrideWith(int Function(Count2Ref ref) create) { -// return _$Count2FamilyOverride(this, create); -// } - -// @override -// String toString() => 'count2ProviderFamily'; -// } - -// class _$Count2FamilyOverride implements $FamilyOverride { -// _$Count2FamilyOverride(this.from, this.create); - -// final int Function(Count2Ref ref) create; - -// @override -// final Count2Family from; - -// @override -// _Count2ProviderElement createElement( -// ProviderContainer container, -// covariant Count2Provider provider, -// ) { -// return provider._copyWith(create).createElement(container); -// } - -// @override -// String toString() => 'count2ProviderFamily.overrideWith(...)'; -// } - -// /// See also [count2]. -// class Count2Provider extends AutoDisposeProvider { -// /// See also [count2]. -// Count2Provider( -// int a, -// ) : this._internal( -// (ref) => count2( -// ref as Count2Ref, -// a, -// ), -// from: count2ProviderFamily, -// name: r'count2ProviderFamily', -// debugGetCreateSourceHash: -// const bool.fromEnvironment('dart.vm.product') -// ? null -// : _$count2Hash, -// dependencies: null, -// allTransitiveDependencies: null, -// a: a, -// ); - -// Count2Provider._internal( -// super.create, { -// required super.name, -// required super.dependencies, -// required super.allTransitiveDependencies, -// required super.debugGetCreateSourceHash, -// required super.from, -// required this.a, -// }) : super.internal(); - -// final int a; - -// @override -// Override overrideWith( -// int Function(Count2Ref ref) create, -// ) { -// return $ProviderOverride( -// origin: this, -// providerOverride: Count2Provider._internal( -// (ref) => create(ref as Count2Ref), -// from: from, -// name: null, -// dependencies: null, -// allTransitiveDependencies: null, -// debugGetCreateSourceHash: null, -// a: a, -// ), -// ); -// } - -// @override -// (int,) get argument { -// return (a,); -// } - -// @override -// _Count2ProviderElement createElement( -// ProviderContainer container, -// ) { -// return _Count2ProviderElement(this, container); -// } - -// Count2Provider _copyWith( -// int Function(Count2Ref ref) create, -// ) { -// return Count2Provider._internal( -// (ref) => create(ref as Count2Ref), -// name: name, -// dependencies: dependencies, -// allTransitiveDependencies: allTransitiveDependencies, -// debugGetCreateSourceHash: debugGetCreateSourceHash, -// from: from, -// a: a, -// ); -// } - -// @override -// bool operator ==(Object other) { -// return other is Count2Provider && other.a == a; -// } - -// @override -// int get hashCode { -// var hash = _SystemHash.combine(0, runtimeType.hashCode); -// hash = _SystemHash.combine(hash, a.hashCode); - -// return _SystemHash.finish(hash); -// } - -// @override -// String toString() => 'count2ProviderFamily$argument'; -// } - -// mixin Count2Ref on AutoDisposeProviderRef { -// /// The parameter `a` of this provider. -// int get a; -// } - -// class _Count2ProviderElement extends AutoDisposeProviderElement -// with Count2Ref { -// _Count2ProviderElement(super.provider, super.container); - -// @override -// int get a => (origin as Count2Provider).a; -// } - -// String _$countFuture2Hash() => r'096675b70a267f5d7c62ac7d3e7dd231ef529034'; - -// /// See also [countFuture2]. -// @ProviderFor(countFuture2) -// const countFuture2ProviderFamily = CountFuture2Family(); - -// /// See also [countFuture2]. -// class CountFuture2Family extends Family { -// /// See also [countFuture2]. -// const CountFuture2Family(); - -// static const Iterable? _dependencies = null; - -// static const Iterable? _allTransitiveDependencies = null; - -// @override -// Iterable? get dependencies => _dependencies; - -// @override -// Iterable? get allTransitiveDependencies => -// _allTransitiveDependencies; - -// @override -// String? get name => r'countFuture2ProviderFamily'; - -// /// See also [countFuture2]. -// CountFuture2Provider call( -// int a, -// ) { -// return CountFuture2Provider( -// a, -// ); -// } - -// /// Enables overriding the behavior of this provider, no matter the parameters. -// Override overrideWith(FutureOr Function(CountFuture2Ref ref) create) { -// return _$CountFuture2FamilyOverride(this, create); -// } - -// @override -// String toString() => 'countFuture2ProviderFamily'; -// } - -// class _$CountFuture2FamilyOverride implements $FamilyOverride { -// _$CountFuture2FamilyOverride(this.from, this.create); - -// final FutureOr Function(CountFuture2Ref ref) create; - -// @override -// final CountFuture2Family from; - -// @override -// _CountFuture2ProviderElement createElement( -// ProviderContainer container, -// covariant CountFuture2Provider provider, -// ) { -// return provider._copyWith(create).createElement(container); -// } - -// @override -// String toString() => 'countFuture2ProviderFamily.overrideWith(...)'; -// } - -// /// See also [countFuture2]. -// class CountFuture2Provider extends AutoDisposeFutureProvider { -// /// See also [countFuture2]. -// CountFuture2Provider( -// int a, -// ) : this._internal( -// (ref) => countFuture2( -// ref as CountFuture2Ref, -// a, -// ), -// from: countFuture2ProviderFamily, -// name: r'countFuture2ProviderFamily', -// debugGetCreateSourceHash: -// const bool.fromEnvironment('dart.vm.product') -// ? null -// : _$countFuture2Hash, -// dependencies: null, -// allTransitiveDependencies: null, -// a: a, -// ); - -// CountFuture2Provider._internal( -// super.create, { -// required super.name, -// required super.dependencies, -// required super.allTransitiveDependencies, -// required super.debugGetCreateSourceHash, -// required super.from, -// required this.a, -// }) : super.internal(); - -// final int a; - -// @override -// Override overrideWith( -// FutureOr Function(CountFuture2Ref ref) create, -// ) { -// return $ProviderOverride( -// origin: this, -// providerOverride: CountFuture2Provider._internal( -// (ref) => create(ref as CountFuture2Ref), -// from: from, -// name: null, -// dependencies: null, -// allTransitiveDependencies: null, -// debugGetCreateSourceHash: null, -// a: a, -// ), -// ); -// } - -// @override -// (int,) get argument { -// return (a,); -// } - -// @override -// _CountFuture2ProviderElement createElement( -// ProviderContainer container, -// ) { -// return _CountFuture2ProviderElement(this, container); -// } - -// CountFuture2Provider _copyWith( -// FutureOr Function(CountFuture2Ref ref) create, -// ) { -// return CountFuture2Provider._internal( -// (ref) => create(ref as CountFuture2Ref), -// name: name, -// dependencies: dependencies, -// allTransitiveDependencies: allTransitiveDependencies, -// debugGetCreateSourceHash: debugGetCreateSourceHash, -// from: from, -// a: a, -// ); -// } - -// @override -// bool operator ==(Object other) { -// return other is CountFuture2Provider && other.a == a; -// } - -// @override -// int get hashCode { -// var hash = _SystemHash.combine(0, runtimeType.hashCode); -// hash = _SystemHash.combine(hash, a.hashCode); - -// return _SystemHash.finish(hash); -// } - -// @override -// String toString() => 'countFuture2ProviderFamily$argument'; -// } - -// mixin CountFuture2Ref on AutoDisposeFutureProviderRef { -// /// The parameter `a` of this provider. -// int get a; -// } - -// class _CountFuture2ProviderElement extends AutoDisposeFutureProviderElement -// with CountFuture2Ref { -// _CountFuture2ProviderElement(super.provider, super.container); - -// @override -// int get a => (origin as CountFuture2Provider).a; -// } - -// String _$countStream2Hash() => r'051264dd685ebc0a57e454bb676957c93cb4ae20'; - -// /// See also [countStream2]. -// @ProviderFor(countStream2) -// const countStream2ProviderFamily = CountStream2Family(); - -// /// See also [countStream2]. -// class CountStream2Family extends Family { -// /// See also [countStream2]. -// const CountStream2Family(); - -// static const Iterable? _dependencies = null; - -// static const Iterable? _allTransitiveDependencies = null; - -// @override -// Iterable? get dependencies => _dependencies; - -// @override -// Iterable? get allTransitiveDependencies => -// _allTransitiveDependencies; - -// @override -// String? get name => r'countStream2ProviderFamily'; - -// /// See also [countStream2]. -// CountStream2Provider call( -// int a, -// ) { -// return CountStream2Provider( -// a, -// ); -// } - -// /// Enables overriding the behavior of this provider, no matter the parameters. -// Override overrideWith(Stream Function(CountStream2Ref ref) create) { -// return _$CountStream2FamilyOverride(this, create); -// } - -// @override -// String toString() => 'countStream2ProviderFamily'; -// } - -// class _$CountStream2FamilyOverride implements $FamilyOverride { -// _$CountStream2FamilyOverride(this.from, this.create); - -// final Stream Function(CountStream2Ref ref) create; - -// @override -// final CountStream2Family from; - -// @override -// _CountStream2ProviderElement createElement( -// ProviderContainer container, -// covariant CountStream2Provider provider, -// ) { -// return provider._copyWith(create).createElement(container); -// } - -// @override -// String toString() => 'countStream2ProviderFamily.overrideWith(...)'; -// } - -// /// See also [countStream2]. -// class CountStream2Provider extends AutoDisposeStreamProvider { -// /// See also [countStream2]. -// CountStream2Provider( -// int a, -// ) : this._internal( -// (ref) => countStream2( -// ref as CountStream2Ref, -// a, -// ), -// from: countStream2ProviderFamily, -// name: r'countStream2ProviderFamily', -// debugGetCreateSourceHash: -// const bool.fromEnvironment('dart.vm.product') -// ? null -// : _$countStream2Hash, -// dependencies: null, -// allTransitiveDependencies: null, -// a: a, -// ); - -// CountStream2Provider._internal( -// super.create, { -// required super.name, -// required super.dependencies, -// required super.allTransitiveDependencies, -// required super.debugGetCreateSourceHash, -// required super.from, -// required this.a, -// }) : super.internal(); - -// final int a; - -// @override -// Override overrideWith( -// Stream Function(CountStream2Ref ref) create, -// ) { -// return $ProviderOverride( -// origin: this, -// providerOverride: CountStream2Provider._internal( -// (ref) => create(ref as CountStream2Ref), -// from: from, -// name: null, -// dependencies: null, -// allTransitiveDependencies: null, -// debugGetCreateSourceHash: null, -// a: a, -// ), -// ); -// } - -// @override -// (int,) get argument { -// return (a,); -// } - -// @override -// _CountStream2ProviderElement createElement( -// ProviderContainer container, -// ) { -// return _CountStream2ProviderElement(this, container); -// } - -// CountStream2Provider _copyWith( -// Stream Function(CountStream2Ref ref) create, -// ) { -// return CountStream2Provider._internal( -// (ref) => create(ref as CountStream2Ref), -// name: name, -// dependencies: dependencies, -// allTransitiveDependencies: allTransitiveDependencies, -// debugGetCreateSourceHash: debugGetCreateSourceHash, -// from: from, -// a: a, -// ); -// } - -// @override -// bool operator ==(Object other) { -// return other is CountStream2Provider && other.a == a; -// } - -// @override -// int get hashCode { -// var hash = _SystemHash.combine(0, runtimeType.hashCode); -// hash = _SystemHash.combine(hash, a.hashCode); - -// return _SystemHash.finish(hash); -// } - -// @override -// String toString() => 'countStream2ProviderFamily$argument'; -// } - -// mixin CountStream2Ref on AutoDisposeStreamProviderRef { -// /// The parameter `a` of this provider. -// int get a; -// } - -// class _CountStream2ProviderElement extends AutoDisposeStreamProviderElement -// with CountStream2Ref { -// _CountStream2ProviderElement(super.provider, super.container); - -// @override -// int get a => (origin as CountStream2Provider).a; -// } - -// String _$countNotifierHash() => r'a8dd7a66ee0002b8af657245c4affaa206fd99ec'; - -// /// See also [CountNotifier]. -// @ProviderFor(CountNotifier) -// final countNotifierPod = -// AutoDisposeNotifierProvider.internal( -// CountNotifier.new, -// name: r'countNotifierPod', -// debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') -// ? null -// : _$countNotifierHash, -// dependencies: null, -// allTransitiveDependencies: null, -// ); - -// typedef _$CountNotifier = AutoDisposeNotifier; -// String _$countAsyncNotifierHash() => -// r'2a7049d864bf396e44a5937b4001efb4774a5f29'; - -// /// See also [CountAsyncNotifier]. -// @ProviderFor(CountAsyncNotifier) -// final countAsyncNotifierPod = -// AutoDisposeAsyncNotifierProvider.internal( -// CountAsyncNotifier.new, -// name: r'countAsyncNotifierPod', -// debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') -// ? null -// : _$countAsyncNotifierHash, -// dependencies: null, -// allTransitiveDependencies: null, -// ); - -// typedef _$CountAsyncNotifier = AutoDisposeAsyncNotifier; -// String _$countStreamNotifierHash() => -// r'61d2cd311c4808f8d7e8b2d67f5c7b85337666c6'; - -// /// See also [CountStreamNotifier]. -// @ProviderFor(CountStreamNotifier) -// final countStreamNotifierPod = -// AutoDisposeStreamNotifierProvider.internal( -// CountStreamNotifier.new, -// name: r'countStreamNotifierPod', -// debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') -// ? null -// : _$countStreamNotifierHash, -// dependencies: null, -// allTransitiveDependencies: null, -// ); - -// typedef _$CountStreamNotifier = AutoDisposeStreamNotifier; -// String _$countNotifier2Hash() => r'ef12bb4f94add336804ae43bcdbcd8e9b0bec420'; - -// abstract class _$CountNotifier2 extends BuildlessAutoDisposeNotifier { -// late final int a; - -// int build( -// int a, -// ); -// } - -// /// See also [CountNotifier2]. -// @ProviderFor(CountNotifier2) -// const countNotifier2ProviderFamily = CountNotifier2Family(); - -// /// See also [CountNotifier2]. -// class CountNotifier2Family extends Family { -// /// See also [CountNotifier2]. -// const CountNotifier2Family(); - -// static const Iterable? _dependencies = null; - -// static const Iterable? _allTransitiveDependencies = null; - -// @override -// Iterable? get dependencies => _dependencies; - -// @override -// Iterable? get allTransitiveDependencies => -// _allTransitiveDependencies; - -// @override -// String? get name => r'countNotifier2ProviderFamily'; - -// /// See also [CountNotifier2]. -// CountNotifier2Provider call( -// int a, -// ) { -// return CountNotifier2Provider( -// a, -// ); -// } - -// /// Enables overriding the behavior of this provider, no matter the parameters. -// Override overrideWith(CountNotifier2 Function() create) { -// return _$CountNotifier2FamilyOverride(this, create); -// } - -// @override -// String toString() => 'countNotifier2ProviderFamily'; -// } - -// class _$CountNotifier2FamilyOverride implements $FamilyOverride { -// _$CountNotifier2FamilyOverride(this.from, this.create); - -// final CountNotifier2 Function() create; - -// @override -// final CountNotifier2Family from; - -// @override -// _CountNotifier2ProviderElement createElement( -// ProviderContainer container, -// covariant CountNotifier2Provider provider, -// ) { -// return provider._copyWith(create).createElement(container); -// } - -// @override -// String toString() => 'countNotifier2ProviderFamily.overrideWith(...)'; -// } - -// /// See also [CountNotifier2]. -// class CountNotifier2Provider -// extends AutoDisposeNotifierProviderImpl { -// /// See also [CountNotifier2]. -// CountNotifier2Provider( -// int a, -// ) : this._internal( -// () => CountNotifier2()..a = a, -// from: countNotifier2ProviderFamily, -// name: r'countNotifier2ProviderFamily', -// debugGetCreateSourceHash: -// const bool.fromEnvironment('dart.vm.product') -// ? null -// : _$countNotifier2Hash, -// dependencies: null, -// allTransitiveDependencies: null, -// a: a, -// ); - -// CountNotifier2Provider._internal( -// super.create, { -// required super.name, -// required super.dependencies, -// required super.allTransitiveDependencies, -// required super.debugGetCreateSourceHash, -// required super.from, -// required this.a, -// }) : super.internal(); - -// final int a; - -// @override -// int runNotifierBuild( -// covariant CountNotifier2 notifier, -// ) { -// return notifier.build( -// a, -// ); -// } - -// @override -// Override overrideWith(CountNotifier2 Function() create) { -// return $ProviderOverride( -// origin: this, -// providerOverride: CountNotifier2Provider._internal( -// () => create()..a = a, -// from: from, -// name: null, -// dependencies: null, -// allTransitiveDependencies: null, -// debugGetCreateSourceHash: null, -// a: a, -// ), -// ); -// } - -// @override -// (int,) get argument { -// return (a,); -// } - -// @override -// _CountNotifier2ProviderElement createElement( -// ProviderContainer container, -// ) { -// return _CountNotifier2ProviderElement(this, container); -// } - -// CountNotifier2Provider _copyWith( -// CountNotifier2 Function() create, -// ) { -// return CountNotifier2Provider._internal( -// () => create()..a = a, -// name: name, -// dependencies: dependencies, -// allTransitiveDependencies: allTransitiveDependencies, -// debugGetCreateSourceHash: debugGetCreateSourceHash, -// from: from, -// a: a, -// ); -// } - -// @override -// bool operator ==(Object other) { -// return other is CountNotifier2Provider && other.a == a; -// } - -// @override -// int get hashCode { -// var hash = _SystemHash.combine(0, runtimeType.hashCode); -// hash = _SystemHash.combine(hash, a.hashCode); - -// return _SystemHash.finish(hash); -// } - -// @override -// String toString() => 'countNotifier2ProviderFamily$argument'; -// } - -// mixin CountNotifier2Ref on AutoDisposeNotifierProviderRef { -// /// The parameter `a` of this provider. -// int get a; -// } - -// class _CountNotifier2ProviderElement -// extends AutoDisposeNotifierProviderElement -// with CountNotifier2Ref { -// _CountNotifier2ProviderElement(super.provider, super.container); - -// @override -// int get a => (origin as CountNotifier2Provider).a; -// } - -// String _$countAsyncNotifier2Hash() => -// r'e4bd4d858edbb47fa0d7581f3cfa72e13c914d3d'; - -// abstract class _$CountAsyncNotifier2 -// extends BuildlessAutoDisposeAsyncNotifier { -// late final int a; - -// FutureOr build( -// int a, -// ); -// } - -// /// See also [CountAsyncNotifier2]. -// @ProviderFor(CountAsyncNotifier2) -// const countAsyncNotifier2ProviderFamily = CountAsyncNotifier2Family(); - -// /// See also [CountAsyncNotifier2]. -// class CountAsyncNotifier2Family extends Family { -// /// See also [CountAsyncNotifier2]. -// const CountAsyncNotifier2Family(); - -// static const Iterable? _dependencies = null; - -// static const Iterable? _allTransitiveDependencies = null; - -// @override -// Iterable? get dependencies => _dependencies; - -// @override -// Iterable? get allTransitiveDependencies => -// _allTransitiveDependencies; - -// @override -// String? get name => r'countAsyncNotifier2ProviderFamily'; - -// /// See also [CountAsyncNotifier2]. -// CountAsyncNotifier2Provider call( -// int a, -// ) { -// return CountAsyncNotifier2Provider( -// a, -// ); -// } - -// /// Enables overriding the behavior of this provider, no matter the parameters. -// Override overrideWith(CountAsyncNotifier2 Function() create) { -// return _$CountAsyncNotifier2FamilyOverride(this, create); -// } - -// @override -// String toString() => 'countAsyncNotifier2ProviderFamily'; -// } - -// class _$CountAsyncNotifier2FamilyOverride implements $FamilyOverride { -// _$CountAsyncNotifier2FamilyOverride(this.from, this.create); - -// final CountAsyncNotifier2 Function() create; - -// @override -// final CountAsyncNotifier2Family from; - -// @override -// _CountAsyncNotifier2ProviderElement createElement( -// ProviderContainer container, -// covariant CountAsyncNotifier2Provider provider, -// ) { -// return provider._copyWith(create).createElement(container); -// } - -// @override -// String toString() => 'countAsyncNotifier2ProviderFamily.overrideWith(...)'; -// } - -// /// See also [CountAsyncNotifier2]. -// class CountAsyncNotifier2Provider -// extends AutoDisposeAsyncNotifierProviderImpl { -// /// See also [CountAsyncNotifier2]. -// CountAsyncNotifier2Provider( -// int a, -// ) : this._internal( -// () => CountAsyncNotifier2()..a = a, -// from: countAsyncNotifier2ProviderFamily, -// name: r'countAsyncNotifier2ProviderFamily', -// debugGetCreateSourceHash: -// const bool.fromEnvironment('dart.vm.product') -// ? null -// : _$countAsyncNotifier2Hash, -// dependencies: null, -// allTransitiveDependencies: null, -// a: a, -// ); - -// CountAsyncNotifier2Provider._internal( -// super.create, { -// required super.name, -// required super.dependencies, -// required super.allTransitiveDependencies, -// required super.debugGetCreateSourceHash, -// required super.from, -// required this.a, -// }) : super.internal(); - -// final int a; - -// @override -// FutureOr runNotifierBuild( -// covariant CountAsyncNotifier2 notifier, -// ) { -// return notifier.build( -// a, -// ); -// } - -// @override -// Override overrideWith(CountAsyncNotifier2 Function() create) { -// return $ProviderOverride( -// origin: this, -// providerOverride: CountAsyncNotifier2Provider._internal( -// () => create()..a = a, -// from: from, -// name: null, -// dependencies: null, -// allTransitiveDependencies: null, -// debugGetCreateSourceHash: null, -// a: a, -// ), -// ); -// } - -// @override -// (int,) get argument { -// return (a,); -// } - -// @override -// _CountAsyncNotifier2ProviderElement createElement( -// ProviderContainer container, -// ) { -// return _CountAsyncNotifier2ProviderElement(this, container); -// } - -// CountAsyncNotifier2Provider _copyWith( -// CountAsyncNotifier2 Function() create, -// ) { -// return CountAsyncNotifier2Provider._internal( -// () => create()..a = a, -// name: name, -// dependencies: dependencies, -// allTransitiveDependencies: allTransitiveDependencies, -// debugGetCreateSourceHash: debugGetCreateSourceHash, -// from: from, -// a: a, -// ); -// } - -// @override -// bool operator ==(Object other) { -// return other is CountAsyncNotifier2Provider && other.a == a; -// } - -// @override -// int get hashCode { -// var hash = _SystemHash.combine(0, runtimeType.hashCode); -// hash = _SystemHash.combine(hash, a.hashCode); - -// return _SystemHash.finish(hash); -// } - -// @override -// String toString() => 'countAsyncNotifier2ProviderFamily$argument'; -// } - -// mixin CountAsyncNotifier2Ref on AutoDisposeAsyncNotifierProviderRef { -// /// The parameter `a` of this provider. -// int get a; -// } - -// class _CountAsyncNotifier2ProviderElement -// extends AutoDisposeAsyncNotifierProviderElement -// with CountAsyncNotifier2Ref { -// _CountAsyncNotifier2ProviderElement(super.provider, super.container); - -// @override -// int get a => (origin as CountAsyncNotifier2Provider).a; -// } - -// String _$countStreamNotifier2Hash() => -// r'13be1b7aa32801b33c68f2a228851d2fb6a4a9ee'; - -// abstract class _$CountStreamNotifier2 -// extends BuildlessAutoDisposeStreamNotifier { -// late final int a; - -// Stream build( -// int a, -// ); -// } - -// /// See also [CountStreamNotifier2]. -// @ProviderFor(CountStreamNotifier2) -// const countStreamNotifier2ProviderFamily = CountStreamNotifier2Family(); - -// /// See also [CountStreamNotifier2]. -// class CountStreamNotifier2Family extends Family { -// /// See also [CountStreamNotifier2]. -// const CountStreamNotifier2Family(); - -// static const Iterable? _dependencies = null; - -// static const Iterable? _allTransitiveDependencies = null; - -// @override -// Iterable? get dependencies => _dependencies; - -// @override -// Iterable? get allTransitiveDependencies => -// _allTransitiveDependencies; - -// @override -// String? get name => r'countStreamNotifier2ProviderFamily'; - -// /// See also [CountStreamNotifier2]. -// CountStreamNotifier2Provider call( -// int a, -// ) { -// return CountStreamNotifier2Provider( -// a, -// ); -// } - -// /// Enables overriding the behavior of this provider, no matter the parameters. -// Override overrideWith(CountStreamNotifier2 Function() create) { -// return _$CountStreamNotifier2FamilyOverride(this, create); -// } - -// @override -// String toString() => 'countStreamNotifier2ProviderFamily'; -// } - -// class _$CountStreamNotifier2FamilyOverride implements $FamilyOverride { -// _$CountStreamNotifier2FamilyOverride(this.from, this.create); - -// final CountStreamNotifier2 Function() create; - -// @override -// final CountStreamNotifier2Family from; - -// @override -// _CountStreamNotifier2ProviderElement createElement( -// ProviderContainer container, -// covariant CountStreamNotifier2Provider provider, -// ) { -// return provider._copyWith(create).createElement(container); -// } - -// @override -// String toString() => 'countStreamNotifier2ProviderFamily.overrideWith(...)'; -// } - -// /// See also [CountStreamNotifier2]. -// class CountStreamNotifier2Provider -// extends AutoDisposeStreamNotifierProviderImpl { -// /// See also [CountStreamNotifier2]. -// CountStreamNotifier2Provider( -// int a, -// ) : this._internal( -// () => CountStreamNotifier2()..a = a, -// from: countStreamNotifier2ProviderFamily, -// name: r'countStreamNotifier2ProviderFamily', -// debugGetCreateSourceHash: -// const bool.fromEnvironment('dart.vm.product') -// ? null -// : _$countStreamNotifier2Hash, -// dependencies: null, -// allTransitiveDependencies: null, -// a: a, -// ); - -// CountStreamNotifier2Provider._internal( -// super.create, { -// required super.name, -// required super.dependencies, -// required super.allTransitiveDependencies, -// required super.debugGetCreateSourceHash, -// required super.from, -// required this.a, -// }) : super.internal(); - -// final int a; - -// @override -// Stream runNotifierBuild( -// covariant CountStreamNotifier2 notifier, -// ) { -// return notifier.build( -// a, -// ); -// } - -// @override -// Override overrideWith(CountStreamNotifier2 Function() create) { -// return $ProviderOverride( -// origin: this, -// providerOverride: CountStreamNotifier2Provider._internal( -// () => create()..a = a, -// from: from, -// name: null, -// dependencies: null, -// allTransitiveDependencies: null, -// debugGetCreateSourceHash: null, -// a: a, -// ), -// ); -// } - -// @override -// (int,) get argument { -// return (a,); -// } - -// @override -// _CountStreamNotifier2ProviderElement createElement( -// ProviderContainer container, -// ) { -// return _CountStreamNotifier2ProviderElement(this, container); -// } - -// CountStreamNotifier2Provider _copyWith( -// CountStreamNotifier2 Function() create, -// ) { -// return CountStreamNotifier2Provider._internal( -// () => create()..a = a, -// name: name, -// dependencies: dependencies, -// allTransitiveDependencies: allTransitiveDependencies, -// debugGetCreateSourceHash: debugGetCreateSourceHash, -// from: from, -// a: a, -// ); -// } - -// @override -// bool operator ==(Object other) { -// return other is CountStreamNotifier2Provider && other.a == a; -// } - -// @override -// int get hashCode { -// var hash = _SystemHash.combine(0, runtimeType.hashCode); -// hash = _SystemHash.combine(hash, a.hashCode); - -// return _SystemHash.finish(hash); -// } - -// @override -// String toString() => 'countStreamNotifier2ProviderFamily$argument'; -// } - -// mixin CountStreamNotifier2Ref on AutoDisposeStreamNotifierProviderRef { -// /// The parameter `a` of this provider. -// int get a; -// } - -// class _CountStreamNotifier2ProviderElement -// extends AutoDisposeStreamNotifierProviderElement -// with CountStreamNotifier2Ref { -// _CountStreamNotifier2ProviderElement(super.provider, super.container); - -// @override -// int get a => (origin as CountStreamNotifier2Provider).a; -// } -// // ignore_for_file: type=lint -// // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'main.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CountRef = Ref; + +const countPod = CountProvider._(); + +final class CountProvider extends $FunctionalProvider + with $Provider { + const CountProvider._( + {int Function( + CountRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'countPod', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CountRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$countHash(); + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(CountRef ref) { + final fn = _createCb ?? count; + + return fn( + ref, + ); + } + + @override + CountProvider copyWithCreate( + int Function( + CountRef ref, + ) create, + ) { + return CountProvider._(create: create); + } +} + +String _$countHash() => r'4c7e72b275767a60ece5e8662ab1e28f73cf7e44'; + +typedef CountFutureRef = Ref>; + +const countFuturePod = CountFutureProvider._(); + +final class CountFutureProvider + extends $FunctionalProvider, FutureOr, CountFutureRef> + with $FutureModifier, $FutureProvider { + const CountFutureProvider._( + {FutureOr Function( + CountFutureRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'countFuturePod', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + CountFutureRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$countFutureHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + FutureOr create(CountFutureRef ref) { + final fn = _createCb ?? countFuture; + + return fn( + ref, + ); + } + + @override + CountFutureProvider copyWithCreate( + FutureOr Function( + CountFutureRef ref, + ) create, + ) { + return CountFutureProvider._(create: create); + } +} + +String _$countFutureHash() => r'ec7cc31ce1c1a10607f1dcb35dd217acd2877729'; + +typedef CountStreamRef = Ref>; + +const countStreamPod = CountStreamProvider._(); + +final class CountStreamProvider + extends $FunctionalProvider, Stream, CountStreamRef> + with $FutureModifier, $StreamProvider { + const CountStreamProvider._( + {Stream Function( + CountStreamRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'countStreamPod', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + CountStreamRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$countStreamHash(); + + @override + $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + Stream create(CountStreamRef ref) { + final fn = _createCb ?? countStream; + + return fn( + ref, + ); + } + + @override + CountStreamProvider copyWithCreate( + Stream Function( + CountStreamRef ref, + ) create, + ) { + return CountStreamProvider._(create: create); + } +} + +String _$countStreamHash() => r'1dbe49244ea19e8dbc3af0534429bb323720c07a'; + +typedef Count2Ref = Ref; + +const count2ProviderFamily = Count2Family._(); + +final class Count2Provider extends $FunctionalProvider + with $Provider { + const Count2Provider._( + {required Count2Family super.from, + required (int,) super.argument, + int Function( + Count2Ref ref, + int a, + )? create}) + : _createCb = create, + super( + name: r'count2ProviderFamily', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + Count2Ref ref, + int a, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$count2Hash(); + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + int create(Count2Ref ref) { + final fn = _createCb ?? count2; + final (int,) argument = this.argument! as (int,); + return fn( + ref, + argument.$1, + ); + } + + @override + Count2Provider copyWithCreate( + int Function( + Count2Ref ref, + ) create, + ) { + return Count2Provider._( + argument: argument! as (int,), + from: from! as Count2Family, + create: ( + ref, + int a, + ) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is Count2Provider && other.argument == argument; + } +} + +String _$count2Hash() => r'6256825480d83bb13acde282cf3c9d9524cc3a6c'; + +final class Count2Family extends Family { + const Count2Family._() + : super( + name: r'count2ProviderFamily', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + Count2Provider call( + int a, + ) => + Count2Provider._(argument: (a,), from: this); + + @override + String debugGetCreateSourceHash() => _$count2Hash(); + + @override + String toString() => r'count2'; +} + +typedef CountFuture2Ref = Ref>; + +const countFuture2ProviderFamily = CountFuture2Family._(); + +final class CountFuture2Provider + extends $FunctionalProvider, FutureOr, CountFuture2Ref> + with $FutureModifier, $FutureProvider { + const CountFuture2Provider._( + {required CountFuture2Family super.from, + required (int,) super.argument, + FutureOr Function( + CountFuture2Ref ref, + int a, + )? create}) + : _createCb = create, + super( + name: r'countFuture2ProviderFamily', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + CountFuture2Ref ref, + int a, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$countFuture2Hash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + FutureOr create(CountFuture2Ref ref) { + final fn = _createCb ?? countFuture2; + final (int,) argument = this.argument! as (int,); + return fn( + ref, + argument.$1, + ); + } + + @override + CountFuture2Provider copyWithCreate( + FutureOr Function( + CountFuture2Ref ref, + ) create, + ) { + return CountFuture2Provider._( + argument: argument! as (int,), + from: from! as CountFuture2Family, + create: ( + ref, + int a, + ) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is CountFuture2Provider && other.argument == argument; + } +} + +String _$countFuture2Hash() => r'096675b70a267f5d7c62ac7d3e7dd231ef529034'; + +final class CountFuture2Family extends Family { + const CountFuture2Family._() + : super( + name: r'countFuture2ProviderFamily', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + CountFuture2Provider call( + int a, + ) => + CountFuture2Provider._(argument: (a,), from: this); + + @override + String debugGetCreateSourceHash() => _$countFuture2Hash(); + + @override + String toString() => r'countFuture2'; +} + +typedef CountStream2Ref = Ref>; + +const countStream2ProviderFamily = CountStream2Family._(); + +final class CountStream2Provider + extends $FunctionalProvider, Stream, CountStream2Ref> + with $FutureModifier, $StreamProvider { + const CountStream2Provider._( + {required CountStream2Family super.from, + required (int,) super.argument, + Stream Function( + CountStream2Ref ref, + int a, + )? create}) + : _createCb = create, + super( + name: r'countStream2ProviderFamily', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + CountStream2Ref ref, + int a, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$countStream2Hash(); + + @override + $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + Stream create(CountStream2Ref ref) { + final fn = _createCb ?? countStream2; + final (int,) argument = this.argument! as (int,); + return fn( + ref, + argument.$1, + ); + } + + @override + CountStream2Provider copyWithCreate( + Stream Function( + CountStream2Ref ref, + ) create, + ) { + return CountStream2Provider._( + argument: argument! as (int,), + from: from! as CountStream2Family, + create: ( + ref, + int a, + ) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is CountStream2Provider && other.argument == argument; + } +} + +String _$countStream2Hash() => r'051264dd685ebc0a57e454bb676957c93cb4ae20'; + +final class CountStream2Family extends Family { + const CountStream2Family._() + : super( + name: r'countStream2ProviderFamily', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + CountStream2Provider call( + int a, + ) => + CountStream2Provider._(argument: (a,), from: this); + + @override + String debugGetCreateSourceHash() => _$countStream2Hash(); + + @override + String toString() => r'countStream2'; +} + +const countNotifierPod = CountNotifierProvider._(); + +final class CountNotifierProvider + extends $NotifierProvider { + const CountNotifierProvider._( + {super.runNotifierBuildOverride, CountNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'countNotifierPod', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CountNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$countNotifierHash(); + + @$internal + @override + CountNotifier create() => _createCb?.call() ?? CountNotifier(); + + @$internal + @override + CountNotifierProvider copyWithCreate( + CountNotifier Function() create, + ) { + return CountNotifierProvider._(create: create); + } + + @$internal + @override + CountNotifierProvider copyWithBuild( + int Function(Ref, CountNotifier) build, + ) { + return CountNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$countNotifierHash() => r'a8dd7a66ee0002b8af657245c4affaa206fd99ec'; + +abstract class _$CountNotifier extends $Notifier { + int build(); + + @$internal + @override + int runBuild() => build(); +} + +const countAsyncNotifierPod = CountAsyncNotifierProvider._(); + +final class CountAsyncNotifierProvider + extends $AsyncNotifierProvider { + const CountAsyncNotifierProvider._( + {super.runNotifierBuildOverride, CountAsyncNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'countAsyncNotifierPod', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CountAsyncNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$countAsyncNotifierHash(); + + @$internal + @override + CountAsyncNotifier create() => _createCb?.call() ?? CountAsyncNotifier(); + + @$internal + @override + CountAsyncNotifierProvider copyWithCreate( + CountAsyncNotifier Function() create, + ) { + return CountAsyncNotifierProvider._(create: create); + } + + @$internal + @override + CountAsyncNotifierProvider copyWithBuild( + FutureOr Function(Ref>, CountAsyncNotifier) build, + ) { + return CountAsyncNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$countAsyncNotifierHash() => + r'2a7049d864bf396e44a5937b4001efb4774a5f29'; + +abstract class _$CountAsyncNotifier extends $AsyncNotifier { + FutureOr build(); + + @$internal + @override + FutureOr runBuild() => build(); +} + +const countStreamNotifierPod = CountStreamNotifierProvider._(); + +final class CountStreamNotifierProvider + extends $StreamNotifierProvider { + const CountStreamNotifierProvider._( + {super.runNotifierBuildOverride, CountStreamNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'countStreamNotifierPod', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CountStreamNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$countStreamNotifierHash(); + + @$internal + @override + CountStreamNotifier create() => _createCb?.call() ?? CountStreamNotifier(); + + @$internal + @override + CountStreamNotifierProvider copyWithCreate( + CountStreamNotifier Function() create, + ) { + return CountStreamNotifierProvider._(create: create); + } + + @$internal + @override + CountStreamNotifierProvider copyWithBuild( + Stream Function(Ref>, CountStreamNotifier) build, + ) { + return CountStreamNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $StreamNotifierProviderElement createElement( + ProviderContainer container) => + $StreamNotifierProviderElement(this, container); +} + +String _$countStreamNotifierHash() => + r'61d2cd311c4808f8d7e8b2d67f5c7b85337666c6'; + +abstract class _$CountStreamNotifier extends $StreamNotifier { + Stream build(); + + @$internal + @override + Stream runBuild() => build(); +} + +const countNotifier2ProviderFamily = CountNotifier2Family._(); + +final class CountNotifier2Provider + extends $NotifierProvider { + const CountNotifier2Provider._( + {required CountNotifier2Family super.from, + required (int,) super.argument, + super.runNotifierBuildOverride, + CountNotifier2 Function()? create}) + : _createCb = create, + super( + name: r'countNotifier2ProviderFamily', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CountNotifier2 Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$countNotifier2Hash(); + + @$internal + @override + CountNotifier2 create() => _createCb?.call() ?? CountNotifier2(); + + @$internal + @override + CountNotifier2Provider copyWithCreate( + CountNotifier2 Function() create, + ) { + return CountNotifier2Provider._( + argument: argument! as (int,), + from: from! as CountNotifier2Family, + create: create); + } + + @$internal + @override + CountNotifier2Provider copyWithBuild( + int Function(Ref, CountNotifier2) build, + ) { + return CountNotifier2Provider._( + argument: argument! as (int,), + from: from! as CountNotifier2Family, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is CountNotifier2Provider && other.argument == argument; + } +} + +String _$countNotifier2Hash() => r'ef12bb4f94add336804ae43bcdbcd8e9b0bec420'; + +final class CountNotifier2Family extends Family { + const CountNotifier2Family._() + : super( + name: r'countNotifier2ProviderFamily', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + CountNotifier2Provider call( + int a, + ) => + CountNotifier2Provider._(argument: (a,), from: this); + + @override + String debugGetCreateSourceHash() => _$countNotifier2Hash(); + + @override + String toString() => r'CountNotifier2'; +} + +abstract class _$CountNotifier2 extends $Notifier { + late final _$args = + (ref as $NotifierProviderElement).origin.argument as (int,); + int get a => _$args.$1; + + int build( + int a, + ); + + @$internal + @override + int runBuild() => build( + _$args.$1, + ); +} + +const countAsyncNotifier2ProviderFamily = CountAsyncNotifier2Family._(); + +final class CountAsyncNotifier2Provider + extends $AsyncNotifierProvider { + const CountAsyncNotifier2Provider._( + {required CountAsyncNotifier2Family super.from, + required (int,) super.argument, + super.runNotifierBuildOverride, + CountAsyncNotifier2 Function()? create}) + : _createCb = create, + super( + name: r'countAsyncNotifier2ProviderFamily', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CountAsyncNotifier2 Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$countAsyncNotifier2Hash(); + + @$internal + @override + CountAsyncNotifier2 create() => _createCb?.call() ?? CountAsyncNotifier2(); + + @$internal + @override + CountAsyncNotifier2Provider copyWithCreate( + CountAsyncNotifier2 Function() create, + ) { + return CountAsyncNotifier2Provider._( + argument: argument! as (int,), + from: from! as CountAsyncNotifier2Family, + create: create); + } + + @$internal + @override + CountAsyncNotifier2Provider copyWithBuild( + FutureOr Function(Ref>, CountAsyncNotifier2) build, + ) { + return CountAsyncNotifier2Provider._( + argument: argument! as (int,), + from: from! as CountAsyncNotifier2Family, + runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is CountAsyncNotifier2Provider && other.argument == argument; + } +} + +String _$countAsyncNotifier2Hash() => + r'e4bd4d858edbb47fa0d7581f3cfa72e13c914d3d'; + +final class CountAsyncNotifier2Family extends Family { + const CountAsyncNotifier2Family._() + : super( + name: r'countAsyncNotifier2ProviderFamily', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + CountAsyncNotifier2Provider call( + int a, + ) => + CountAsyncNotifier2Provider._(argument: (a,), from: this); + + @override + String debugGetCreateSourceHash() => _$countAsyncNotifier2Hash(); + + @override + String toString() => r'CountAsyncNotifier2'; +} + +abstract class _$CountAsyncNotifier2 extends $AsyncNotifier { + late final _$args = + (ref as $AsyncNotifierProviderElement).origin.argument as (int,); + int get a => _$args.$1; + + FutureOr build( + int a, + ); + + @$internal + @override + FutureOr runBuild() => build( + _$args.$1, + ); +} + +const countStreamNotifier2ProviderFamily = CountStreamNotifier2Family._(); + +final class CountStreamNotifier2Provider + extends $StreamNotifierProvider { + const CountStreamNotifier2Provider._( + {required CountStreamNotifier2Family super.from, + required (int,) super.argument, + super.runNotifierBuildOverride, + CountStreamNotifier2 Function()? create}) + : _createCb = create, + super( + name: r'countStreamNotifier2ProviderFamily', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CountStreamNotifier2 Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$countStreamNotifier2Hash(); + + @$internal + @override + CountStreamNotifier2 create() => _createCb?.call() ?? CountStreamNotifier2(); + + @$internal + @override + CountStreamNotifier2Provider copyWithCreate( + CountStreamNotifier2 Function() create, + ) { + return CountStreamNotifier2Provider._( + argument: argument! as (int,), + from: from! as CountStreamNotifier2Family, + create: create); + } + + @$internal + @override + CountStreamNotifier2Provider copyWithBuild( + Stream Function(Ref>, CountStreamNotifier2) build, + ) { + return CountStreamNotifier2Provider._( + argument: argument! as (int,), + from: from! as CountStreamNotifier2Family, + runNotifierBuildOverride: build); + } + + @$internal + @override + $StreamNotifierProviderElement createElement( + ProviderContainer container) => + $StreamNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is CountStreamNotifier2Provider && other.argument == argument; + } +} + +String _$countStreamNotifier2Hash() => + r'13be1b7aa32801b33c68f2a228851d2fb6a4a9ee'; + +final class CountStreamNotifier2Family extends Family { + const CountStreamNotifier2Family._() + : super( + name: r'countStreamNotifier2ProviderFamily', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + CountStreamNotifier2Provider call( + int a, + ) => + CountStreamNotifier2Provider._(argument: (a,), from: this); + + @override + String debugGetCreateSourceHash() => _$countStreamNotifier2Hash(); + + @override + String toString() => r'CountStreamNotifier2'; +} + +abstract class _$CountStreamNotifier2 extends $StreamNotifier { + late final _$args = + (ref as $StreamNotifierProviderElement).origin.argument as (int,); + int get a => _$args.$1; + + Stream build( + int a, + ); + + @$internal + @override + Stream runBuild() => build( + _$args.$1, + ); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index ea5b3fc8d..c4b51c860 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -206,7 +206,11 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { extension ProviderElementNames on GeneratorProviderDeclarationElement { String providerName(BuildYamlOptions options) { - return '${name.lowerFirst}${options.providerNameSuffix ?? 'Provider'}'; + final suffix = isFamily + ? options.providerFamilyNameSuffix + : options.providerNameSuffix; + + return '${name.lowerFirst}${suffix ?? 'Provider'}'; } String get providerTypeName => '${name.titled}Provider'; diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index b6c97ceb1..88e84af65 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -39,7 +39,7 @@ class FamilyTemplate extends Template { final class ${provider.familyTypeName} extends Family { const ${provider.familyTypeName}._() : super( - name: r'${provider.name}', + name: r'${provider.providerName(options)}', dependencies: ${provider.dependencies(options)}, allTransitiveDependencies: ${provider.allTransitiveDependencies(allTransitiveDependencies)}, ${provider.providerElement.isAutoDispose ? 'isAutoDispose: true,' : ''} diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index dcd149a2b..341c7a014 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -117,7 +117,7 @@ final class $name$_genericsDefinition }): _createCb = create, super( $superParameters - name: r'${provider.name}', + name: r'${provider.providerName(options)}', isAutoDispose: ${!provider.annotation.element.keepAlive}, dependencies: ${!provider.providerElement.isFamily ? provider.dependencies(options) : 'null'}, allTransitiveDependencies: ${!provider.providerElement.isFamily ? provider.allTransitiveDependencies(allTransitiveDependencies) : 'null'}, diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 917689d29..707b4ce0d 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -21,7 +21,7 @@ final class GenericProvider extends $FunctionalProvider< : _createCb = create, super( argument: null, - name: r'generic', + name: r'genericProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -69,7 +69,7 @@ String _$genericHash() => r'6ee5473ece745b00328c1e048f6967c160343620'; final class GenericFamily extends Family { const GenericFamily._() : super( - name: r'generic', + name: r'genericProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -99,7 +99,7 @@ final class PublicProvider super( from: null, argument: null, - name: r'public', + name: r'publicProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -152,7 +152,7 @@ final class _PrivateProvider extends $FunctionalProvider, super( from: null, argument: null, - name: r'_private', + name: r'_privateProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -206,7 +206,7 @@ final class FamilyOrProvider extends $FunctionalProvider, )? create}) : _createCb = create, super( - name: r'familyOr', + name: r'familyOrProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -261,7 +261,7 @@ String _$familyOrHash() => r'1c3217e296b0ce52c07c18769d1fffb95850f482'; final class FamilyOrFamily extends Family { const FamilyOrFamily._() : super( - name: r'familyOr', + name: r'familyOrProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -306,7 +306,7 @@ final class FamilyProvider })? create}) : _createCb = create, super( - name: r'family', + name: r'familyProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -391,7 +391,7 @@ String _$familyHash() => r'eb6fad35a94d4238b621c2100253ee2c700bee77'; final class FamilyFamily extends Family { const FamilyFamily._() : super( - name: r'family', + name: r'familyProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -430,7 +430,7 @@ final class GenericClassProvider : _createCb = create, super( argument: null, - name: r'GenericClass', + name: r'genericClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -482,7 +482,7 @@ String _$genericClassHash() => r'd3c4acc9cdae12f6c666fbf1f89aee212bb086db'; final class GenericClassFamily extends Family { const GenericClassFamily._() : super( - name: r'GenericClass', + name: r'genericClassProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -516,7 +516,7 @@ final class PublicClassProvider super( from: null, argument: null, - name: r'PublicClass', + name: r'publicClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -574,7 +574,7 @@ final class _PrivateClassProvider super( from: null, argument: null, - name: r'_PrivateClass', + name: r'_privateClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -633,7 +633,7 @@ final class FamilyOrClassProvider FamilyOrClass Function()? create}) : _createCb = create, super( - name: r'FamilyOrClass', + name: r'familyOrClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -687,7 +687,7 @@ String _$familyOrClassHash() => r'b4882d4e79a03c63005d35eb7a021c9c4373a8d9'; final class FamilyOrClassFamily extends Family { const FamilyOrClassFamily._() : super( - name: r'FamilyOrClass', + name: r'familyOrClassProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -739,7 +739,7 @@ final class FamilyClassProvider FamilyClass Function()? create}) : _createCb = create, super( - name: r'FamilyClass', + name: r'familyClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -805,7 +805,7 @@ String _$familyClassHash() => r'b7e3ca6091f12bbc99972e961acd885e05f42a15'; final class FamilyClassFamily extends Family { const FamilyClassFamily._() : super( - name: r'FamilyClass', + name: r'familyClassProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 9714f6e9e..2bf075a09 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -21,7 +21,7 @@ final class KeepAliveProvider super( from: null, argument: null, - name: r'keepAlive', + name: r'keepAliveProvider', isAutoDispose: false, dependencies: null, allTransitiveDependencies: null, @@ -74,7 +74,7 @@ final class NotKeepAliveProvider super( from: null, argument: null, - name: r'notKeepAlive', + name: r'notKeepAliveProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 981e3527b..1cb8c42bc 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -20,7 +20,7 @@ final class DepProvider extends $FunctionalProvider super( from: null, argument: null, - name: r'dep', + name: r'depProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -73,7 +73,7 @@ final class FamilyProvider extends $FunctionalProvider )? create}) : _createCb = create, super( - name: r'family', + name: r'familyProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -128,7 +128,7 @@ String _$familyHash() => r'8c228ff14b8c6cf1f3d4d6266232d64b5057c440'; final class FamilyFamily extends Family { const FamilyFamily._() : super( - name: r'family', + name: r'familyProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -160,7 +160,7 @@ final class ProviderProvider extends $FunctionalProvider super( from: null, argument: null, - name: r'provider', + name: r'providerProvider', isAutoDispose: true, dependencies: const [ depProvider, @@ -228,7 +228,7 @@ final class Provider2Provider super( from: null, argument: null, - name: r'provider2', + name: r'provider2Provider', isAutoDispose: true, dependencies: const [ depProvider, @@ -296,7 +296,7 @@ final class TransitiveDependenciesProvider super( from: null, argument: null, - name: r'transitiveDependencies', + name: r'transitiveDependenciesProvider', isAutoDispose: true, dependencies: const [providerProvider], allTransitiveDependencies: const { @@ -367,7 +367,7 @@ final class SmallTransitiveDependencyCountProvider super( from: null, argument: null, - name: r'smallTransitiveDependencyCount', + name: r'smallTransitiveDependencyCountProvider', isAutoDispose: true, dependencies: const [ depProvider, @@ -434,7 +434,7 @@ final class EmptyDependenciesFunctionalProvider super( from: null, argument: null, - name: r'emptyDependenciesFunctional', + name: r'emptyDependenciesFunctionalProvider', isAutoDispose: true, dependencies: const [], allTransitiveDependencies: const [], @@ -488,7 +488,7 @@ final class ProviderWithDependenciesProvider super( from: null, argument: null, - name: r'providerWithDependencies', + name: r'providerWithDependenciesProvider', isAutoDispose: true, dependencies: const [ _privateDepProvider, @@ -551,7 +551,7 @@ final class _PrivateDepProvider super( from: null, argument: null, - name: r'_privateDep', + name: r'_privateDepProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -604,7 +604,7 @@ final class PublicDepProvider super( from: null, argument: null, - name: r'publicDep', + name: r'publicDepProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -657,7 +657,7 @@ final class DuplicateDependenciesProvider super( from: null, argument: null, - name: r'duplicateDependencies', + name: r'duplicateDependenciesProvider', isAutoDispose: true, dependencies: const [depProvider, dep2Provider], allTransitiveDependencies: const [ @@ -717,7 +717,7 @@ final class DuplicateDependencies2Provider super( from: null, argument: null, - name: r'duplicateDependencies2', + name: r'duplicateDependencies2Provider', isAutoDispose: true, dependencies: const [ familyProvider, @@ -781,7 +781,7 @@ final class TransitiveDuplicateDependenciesProvider super( from: null, argument: null, - name: r'transitiveDuplicateDependencies', + name: r'transitiveDuplicateDependenciesProvider', isAutoDispose: true, dependencies: const [ duplicateDependenciesProvider, @@ -850,7 +850,7 @@ final class Dep2Provider extends $NotifierProvider { super( from: null, argument: null, - name: r'Dep2', + name: r'dep2Provider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -908,7 +908,7 @@ final class Family2Provider extends $NotifierProvider { Family2 Function()? create}) : _createCb = create, super( - name: r'Family2', + name: r'family2Provider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -962,7 +962,7 @@ String _$family2Hash() => r'ce727b262aae067b0d4f703f03670abb70ad8977'; final class Family2Family extends Family { const Family2Family._() : super( - name: r'Family2', + name: r'family2Provider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -1005,7 +1005,7 @@ final class Provider3Provider extends $NotifierProvider { super( from: null, argument: null, - name: r'Provider3', + name: r'provider3Provider', isAutoDispose: true, dependencies: const [ depProvider, @@ -1078,7 +1078,7 @@ final class Provider4Provider extends $NotifierProvider { Provider4 Function()? create}) : _createCb = create, super( - name: r'Provider4', + name: r'provider4Provider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -1137,7 +1137,7 @@ String _$provider4Hash() => r'1c955214d99695bb694c96374b277aac58e734df'; final class Provider4Family extends Family { const Provider4Family._() : super( - name: r'Provider4', + name: r'provider4Provider', dependencies: const [ depProvider, familyProvider, @@ -1193,7 +1193,7 @@ final class EmptyDependenciesClassBasedProvider super( from: null, argument: null, - name: r'EmptyDependenciesClassBased', + name: r'emptyDependenciesClassBasedProvider', isAutoDispose: true, dependencies: const [], allTransitiveDependencies: const [], diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index a2f99463c..4bafc60ca 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -21,7 +21,7 @@ final class ProviderWithDependencies2Provider super( from: null, argument: null, - name: r'providerWithDependencies2', + name: r'providerWithDependencies2Provider', isAutoDispose: true, dependencies: const [ providerWithDependenciesProvider, @@ -97,7 +97,7 @@ final class FamilyWithDependencies2Provider })? create}) : _createCb = create, super( - name: r'familyWithDependencies2', + name: r'familyWithDependencies2Provider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -168,7 +168,7 @@ String _$familyWithDependencies2Hash() => final class FamilyWithDependencies2Family extends Family { const FamilyWithDependencies2Family._() : super( - name: r'familyWithDependencies2', + name: r'familyWithDependencies2Provider', dependencies: const [ providerWithDependenciesProvider, _private2Provider, @@ -211,7 +211,7 @@ final class _Private2Provider super( from: null, argument: null, - name: r'_private2', + name: r'_private2Provider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -263,7 +263,7 @@ final class Public2Provider extends $FunctionalProvider super( from: null, argument: null, - name: r'public2', + name: r'public2Provider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -312,7 +312,7 @@ final class NotifierWithDependenciesProvider super( from: null, argument: null, - name: r'NotifierWithDependencies', + name: r'notifierWithDependenciesProvider', isAutoDispose: true, dependencies: const [ providerWithDependenciesProvider, @@ -395,7 +395,7 @@ final class NotifierFamilyWithDependenciesProvider NotifierFamilyWithDependencies Function()? create}) : _createCb = create, super( - name: r'NotifierFamilyWithDependencies', + name: r'notifierFamilyWithDependenciesProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -464,7 +464,7 @@ String _$notifierFamilyWithDependenciesHash() => final class NotifierFamilyWithDependenciesFamily extends Family { const NotifierFamilyWithDependenciesFamily._() : super( - name: r'NotifierFamilyWithDependencies', + name: r'notifierFamilyWithDependenciesProvider', dependencies: const [ providerWithDependenciesProvider, _private2Provider, diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 9b65631cf..a7098865b 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -21,7 +21,7 @@ final class GeneratedProvider super( from: null, argument: null, - name: r'generated', + name: r'generatedProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -75,7 +75,7 @@ final class GeneratedFamilyProvider )? create}) : _createCb = create, super( - name: r'generatedFamily', + name: r'generatedFamilyProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -130,7 +130,7 @@ String _$generatedFamilyHash() => r'ed284f58926c87acc81dab9168882d5d1c2cddf8'; final class GeneratedFamilyFamily extends Family { const GeneratedFamilyFamily._() : super( - name: r'generatedFamily', + name: r'generatedFamilyProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -163,7 +163,7 @@ final class $DynamicProvider super( from: null, argument: null, - name: r'$dynamic', + name: r'$dynamicProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -217,7 +217,7 @@ final class $DynamicFamilyProvider )? create}) : _createCb = create, super( - name: r'$dynamicFamily', + name: r'$dynamicFamilyProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -272,7 +272,7 @@ String _$$dynamicFamilyHash() => r'b764133af8837b8321b08814892f198d4bc1aa18'; final class $DynamicFamilyFamily extends Family { const $DynamicFamilyFamily._() : super( - name: r'$dynamicFamily', + name: r'$dynamicFamilyProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -306,7 +306,7 @@ final class _DynamicProvider )? create}) : _createCb = create, super( - name: r'_dynamic', + name: r'_dynamicProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -361,7 +361,7 @@ String _$dynamicHash() => r'da9dc07960139fff2cf5fe584dca5c524e4f2308'; final class _DynamicFamily extends Family { const _DynamicFamily._() : super( - name: r'_dynamic', + name: r'_dynamicProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -394,7 +394,7 @@ final class AliasProvider super( from: null, argument: null, - name: r'alias', + name: r'aliasProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -450,7 +450,7 @@ final class AliasFamilyProvider extends $FunctionalProvider< )? create}) : _createCb = create, super( - name: r'aliasFamily', + name: r'aliasFamilyProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -507,7 +507,7 @@ String _$aliasFamilyHash() => r'f345937d5750132f629aef41646b119a301f750b'; final class AliasFamilyFamily extends Family { const AliasFamilyFamily._() : super( - name: r'aliasFamily', + name: r'aliasFamilyProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -535,7 +535,7 @@ final class GeneratedClassProvider super( from: null, argument: null, - name: r'GeneratedClass', + name: r'generatedClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -594,7 +594,7 @@ final class GeneratedClassFamilyProvider GeneratedClassFamily Function()? create}) : _createCb = create, super( - name: r'GeneratedClassFamily', + name: r'generatedClassFamilyProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -649,7 +649,7 @@ String _$generatedClassFamilyHash() => final class GeneratedClassFamilyFamily extends Family { const GeneratedClassFamilyFamily._() : super( - name: r'GeneratedClassFamily', + name: r'generatedClassFamilyProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -693,7 +693,7 @@ final class $DynamicClassProvider super( from: null, argument: null, - name: r'$DynamicClass', + name: r'$dynamicClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -752,7 +752,7 @@ final class $DynamicClassFamilyProvider $DynamicClassFamily Function()? create}) : _createCb = create, super( - name: r'$DynamicClassFamily', + name: r'$dynamicClassFamilyProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -807,7 +807,7 @@ String _$$dynamicClassFamilyHash() => final class $DynamicClassFamilyFamily extends Family { const $DynamicClassFamilyFamily._() : super( - name: r'$DynamicClassFamily', + name: r'$dynamicClassFamilyProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -851,7 +851,7 @@ final class AliasClassProvider super( from: null, argument: null, - name: r'AliasClass', + name: r'aliasClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -910,7 +910,7 @@ final class AliasClassFamilyProvider AliasClassFamily Function()? create}) : _createCb = create, super( - name: r'AliasClassFamily', + name: r'aliasClassFamilyProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -964,7 +964,7 @@ String _$aliasClassFamilyHash() => r'3f348beb95dae3a9890b4a4d0ce01481316fc66d'; final class AliasClassFamilyFamily extends Family { const AliasClassFamilyFamily._() : super( - name: r'AliasClassFamily', + name: r'aliasClassFamilyProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index e84106f57..44b032d91 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -20,7 +20,7 @@ final class ScopedProvider extends $FunctionalProvider super( from: null, argument: null, - name: r'scoped', + name: r'scopedProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index 73c5bd54a..0f39cdc2a 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -20,7 +20,7 @@ final class Counter2Provider extends $FunctionalProvider super( from: null, argument: null, - name: r'counter2', + name: r'counter2Provider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -72,7 +72,7 @@ final class CounterProvider extends $FunctionalProvider super( from: null, argument: null, - name: r'counter', + name: r'counterProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 492799042..f1f4489c9 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -21,7 +21,7 @@ final class GenericProvider extends $FunctionalProvider< : _createCb = create, super( argument: null, - name: r'generic', + name: r'genericProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -69,7 +69,7 @@ String _$genericHash() => r'c1122edf55163d47de8d871ed5d15e0a7edddc05'; final class GenericFamily extends Family { const GenericFamily._() : super( - name: r'generic', + name: r'genericProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -99,7 +99,7 @@ final class PublicProvider super( from: null, argument: null, - name: r'public', + name: r'publicProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -152,7 +152,7 @@ final class _PrivateProvider super( from: null, argument: null, - name: r'_private', + name: r'_privateProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -217,7 +217,7 @@ final class FamilyProvider })? create}) : _createCb = create, super( - name: r'family', + name: r'familyProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -302,7 +302,7 @@ String _$familyHash() => r'6896fac2f6e3ccd7c38ecaa0d538cbd3577936b2'; final class FamilyFamily extends Family { const FamilyFamily._() : super( - name: r'family', + name: r'familyProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -341,7 +341,7 @@ final class GenericClassProvider : _createCb = create, super( argument: null, - name: r'GenericClass', + name: r'genericClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -393,7 +393,7 @@ String _$genericClassHash() => r'401ae1cfd97a4291dfd135a69ff8e1c436866e5a'; final class GenericClassFamily extends Family { const GenericClassFamily._() : super( - name: r'GenericClass', + name: r'genericClassProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -427,7 +427,7 @@ final class PublicClassProvider super( from: null, argument: null, - name: r'PublicClass', + name: r'publicClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -485,7 +485,7 @@ final class _PrivateClassProvider super( from: null, argument: null, - name: r'_PrivateClass', + name: r'_privateClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -551,7 +551,7 @@ final class FamilyClassProvider FamilyClass Function()? create}) : _createCb = create, super( - name: r'FamilyClass', + name: r'familyClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -617,7 +617,7 @@ String _$familyClassHash() => r'6ec16ca23da8df4c010ecb5eed72e3e655504460'; final class FamilyClassFamily extends Family { const FamilyClassFamily._() : super( - name: r'FamilyClass', + name: r'familyClassProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 031885281..fdbbfa155 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -21,7 +21,7 @@ final class GenericProvider : _createCb = create, super( argument: null, - name: r'generic', + name: r'genericProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -69,7 +69,7 @@ String _$genericHash() => r'0fda19dd377694315cdffd7414d53f98569c655c'; final class GenericFamily extends Family { const GenericFamily._() : super( - name: r'generic', + name: r'genericProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -105,7 +105,7 @@ final class ComplexGenericProvider })? create}) : _createCb = create, super( - name: r'complexGeneric', + name: r'complexGenericProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -174,7 +174,7 @@ String _$complexGenericHash() => r'a5254e5552cd61bb8d65c018539ff2d8edfd5822'; final class ComplexGenericFamily extends Family { const ComplexGenericFamily._() : super( - name: r'complexGeneric', + name: r'complexGenericProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -213,7 +213,7 @@ final class RawFutureProvider extends $FunctionalProvider>, super( from: null, argument: null, - name: r'rawFuture', + name: r'rawFutureProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -269,7 +269,7 @@ final class RawStreamProvider extends $FunctionalProvider>, super( from: null, argument: null, - name: r'rawStream', + name: r'rawStreamProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -326,7 +326,7 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< )? create}) : _createCb = create, super( - name: r'rawFamilyFuture', + name: r'rawFamilyFutureProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -382,7 +382,7 @@ String _$rawFamilyFutureHash() => r'485f59512081852e51279658facc015309743864'; final class RawFamilyFutureFamily extends Family { const RawFamilyFutureFamily._() : super( - name: r'rawFamilyFuture', + name: r'rawFamilyFutureProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -418,7 +418,7 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< )? create}) : _createCb = create, super( - name: r'rawFamilyStream', + name: r'rawFamilyStreamProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -474,7 +474,7 @@ String _$rawFamilyStreamHash() => r'e778e5cfcb8ab381e2412f5c73213aaa03b93012'; final class RawFamilyStreamFamily extends Family { const RawFamilyStreamFamily._() : super( - name: r'rawFamilyStream', + name: r'rawFamilyStreamProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -507,7 +507,7 @@ final class PublicProvider super( from: null, argument: null, - name: r'public', + name: r'publicProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -560,7 +560,7 @@ final class Supports$inNamesProvider super( from: null, argument: null, - name: r'supports$inNames', + name: r'supports$inNamesProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -625,7 +625,7 @@ final class FamilyProvider })? create}) : _createCb = create, super( - name: r'family', + name: r'familyProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -710,7 +710,7 @@ String _$familyHash() => r'14d1ee238ca608d547630d0e222ef4c5866e9e61'; final class FamilyFamily extends Family { const FamilyFamily._() : super( - name: r'family', + name: r'familyProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -753,7 +753,7 @@ final class _PrivateProvider super( from: null, argument: null, - name: r'_private', + name: r'_privateProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -806,7 +806,7 @@ final class GeneratedProvider super( from: null, argument: null, - name: r'generated', + name: r'generatedProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -855,7 +855,7 @@ final class GenericClassProvider : _createCb = create, super( argument: null, - name: r'GenericClass', + name: r'genericClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -907,7 +907,7 @@ String _$genericClassHash() => r'671e348a5abf8e00ab06c5f247defbca8af9677b'; final class GenericClassFamily extends Family { const GenericClassFamily._() : super( - name: r'GenericClass', + name: r'genericClassProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -941,7 +941,7 @@ final class RawFutureClassProvider super( from: null, argument: null, - name: r'RawFutureClass', + name: r'rawFutureClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -1000,7 +1000,7 @@ final class RawStreamClassProvider super( from: null, argument: null, - name: r'RawStreamClass', + name: r'rawStreamClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -1060,7 +1060,7 @@ final class RawFamilyFutureClassProvider RawFamilyFutureClass Function()? create}) : _createCb = create, super( - name: r'RawFamilyFutureClass', + name: r'rawFamilyFutureClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -1116,7 +1116,7 @@ String _$rawFamilyFutureClassHash() => final class RawFamilyFutureClassFamily extends Family { const RawFamilyFutureClassFamily._() : super( - name: r'RawFamilyFutureClass', + name: r'rawFamilyFutureClassProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -1162,7 +1162,7 @@ final class RawFamilyStreamClassProvider RawFamilyStreamClass Function()? create}) : _createCb = create, super( - name: r'RawFamilyStreamClass', + name: r'rawFamilyStreamClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -1218,7 +1218,7 @@ String _$rawFamilyStreamClassHash() => final class RawFamilyStreamClassFamily extends Family { const RawFamilyStreamClassFamily._() : super( - name: r'RawFamilyStreamClass', + name: r'rawFamilyStreamClassProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -1262,7 +1262,7 @@ final class PublicClassProvider extends $NotifierProvider { super( from: null, argument: null, - name: r'PublicClass', + name: r'publicClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -1320,7 +1320,7 @@ final class _PrivateClassProvider super( from: null, argument: null, - name: r'_PrivateClass', + name: r'_privateClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -1385,7 +1385,7 @@ final class FamilyClassProvider extends $NotifierProvider { FamilyClass Function()? create}) : _createCb = create, super( - name: r'FamilyClass', + name: r'familyClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -1451,7 +1451,7 @@ String _$familyClassHash() => r'01e3b9cb4d6d0bf12a2284761b1a11819d97d249'; final class FamilyClassFamily extends Family { const FamilyClassFamily._() : super( - name: r'FamilyClass', + name: r'familyClassProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, @@ -1522,7 +1522,7 @@ final class Supports$InClassNameProvider super( from: null, argument: null, - name: r'Supports$InClassName', + name: r'supports$InClassNameProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, From 8f48db33956ea4dcaa3018d71db299b7f2dc1f94 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 14:28:00 +0100 Subject: [PATCH 158/387] W --- packages/riverpod_generator/CHANGELOG.md | 4 + .../test/async_notifier_test.dart | 298 ++++---- .../riverpod_generator/test/async_test.dart | 342 +++++----- .../test/auto_dispose_test.dart | 38 +- .../test/dependencies_test.dart | 267 ++++---- .../riverpod_generator/test/hash_test.dart | 62 +- .../test/integration/annotated.dart | 66 +- .../test/integration/annotated.g.dart | 412 +++++++++++ .../test/integration/hash/hash1.dart | 30 +- .../test/integration/hash/hash1.g.dart | 174 +++++ .../test/integration/scopes.dart | 6 + .../test/integration/scopes.g.dart | 57 ++ .../test/notifier_test.dart | 268 ++++---- .../riverpod_generator/test/scoped_test.dart | 40 +- .../test/stream_notifier_test.dart | 276 ++++---- .../riverpod_generator/test/stream_test.dart | 320 ++++----- .../riverpod_generator/test/sync_test.dart | 641 +++++++++--------- 17 files changed, 1976 insertions(+), 1325 deletions(-) create mode 100644 packages/riverpod_generator/test/integration/annotated.g.dart create mode 100644 packages/riverpod_generator/test/integration/hash/hash1.g.dart diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 19db2a2da..ef1858fc0 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -1,3 +1,7 @@ +## Unreleased build + +- **Breaking** Removed support for `@riverpod external int fn();`. + ## 3.0.0-dev.11 - 2023-11-27 - `riverpod_annotation` upgraded to `3.0.0-dev.3` diff --git a/packages/riverpod_generator/test/async_notifier_test.dart b/packages/riverpod_generator/test/async_notifier_test.dart index 60237ef91..df2d7d17f 100644 --- a/packages/riverpod_generator/test/async_notifier_test.dart +++ b/packages/riverpod_generator/test/async_notifier_test.dart @@ -1,149 +1,149 @@ -// // ignore_for_file: omit_local_variable_types, unused_local_variable - -// import 'package:riverpod_annotation/riverpod_annotation.dart'; -// import 'package:test/test.dart'; - -// import 'integration/async.dart'; -// import 'utils.dart'; - -// void main() { -// test( -// 'Creates an AsyncNotifierProvider if @riverpod is used on an async class', -// () { -// final container = createContainer(); - -// final AutoDisposeAsyncNotifierProvider provider = -// publicClassProvider; -// final AsyncValue result = container.read(publicClassProvider); - -// expect(result, const AsyncData('Hello world')); -// }); - -// test('Generates .name for providers', () { -// expect(publicClassProvider.name, 'publicClassProvider'); -// expect(privateClassProvider.name, '_privateClassProvider'); - -// expect(familyClassProvider.name, 'familyClassProvider'); -// expect(familyClassProvider(42, third: .42).name, 'familyClassProvider'); -// }); - -// test('Supports overriding non-family notifiers', () { -// final container = createContainer( -// overrides: [ -// publicClassProvider.overrideWith(() => PublicClass('Hello world')), -// ], -// ); - -// final notifier = container.read(publicClassProvider.notifier); -// expect(notifier.param, 'Hello world'); - -// expect(notifier.ref, isNotNull); -// expect(notifier.state, isNotNull); -// }); - -// test('Supports overriding family notifiers', () { -// final container = createContainer( -// overrides: [ -// familyClassProvider(42, third: .42) -// .overrideWith(() => FamilyClass('Hello world')), -// ], -// ); - -// final notifier = -// container.read(familyClassProvider(42, third: .42).notifier); -// expect(notifier.param, 'Hello world'); -// expect(notifier.first, 42); -// expect(notifier.second, null); -// expect(notifier.third, .42); -// expect(notifier.fourth, true); -// expect(notifier.fifth, null); - -// expect(notifier.ref, isNotNull); -// expect(notifier.state, isNotNull); -// }); - -// test( -// 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', -// () async { -// final container = createContainer(); - -// const FamilyClassFamily family = familyClassProvider; - -// expect(familyClassProvider(42, third: .42).from, familyClassProvider); - -// expect( -// familyClassProvider(42, third: .42), -// familyClassProvider(42, third: .42), -// ); -// expect( -// familyClassProvider(42, third: .42), -// isNot(familyClassProvider(42, third: .21)), -// ); -// expect( -// familyClassProvider(42, third: .42).hashCode, -// isNot(familyClassProvider(42, third: .21).hashCode), -// ); - -// // handle defaults -// expect( -// familyClassProvider(42, third: .42), -// familyClassProvider( -// 42, -// third: .42, -// ), -// ); -// expect( -// familyClassProvider(42, third: .42).hashCode, -// familyClassProvider( -// 42, -// third: .42, -// ).hashCode, -// ); - -// final FamilyClassProvider provider = familyClassProvider( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: const ['x42'], -// ); -// // ignore: invalid_use_of_internal_member -// final AutoDisposeAsyncNotifierProviderImpl -// futureProvider = provider; - -// expect(provider.first, 42); -// expect(provider.second, 'x42'); -// expect(provider.third, .42); -// expect(provider.fourth, false); -// expect(provider.fifth, same(const ['x42'])); - -// final sub = container.listen( -// familyClassProvider( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: const ['x42'], -// ).future, -// (previous, next) {}, -// ); -// await sub.read(); - -// final AsyncValue result = container.read( -// familyClassProvider( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: const ['x42'], -// ), -// ); - -// expect( -// result, -// const AsyncData( -// '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', -// ), -// ); -// }); -// } +// ignore_for_file: omit_local_variable_types, unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:test/test.dart'; + +import 'integration/async.dart'; +import 'utils.dart'; + +void main() { + test( + 'Creates an AsyncNotifierProvider if @riverpod is used on an async class', + () { + final container = createContainer(); + + final AutoDisposeAsyncNotifierProvider provider = + publicClassProvider; + final AsyncValue result = container.read(publicClassProvider); + + expect(result, const AsyncData('Hello world')); + }); + + test('Generates .name for providers', () { + expect(publicClassProvider.name, 'publicClassProvider'); + expect(privateClassProvider.name, '_privateClassProvider'); + + expect(familyClassProvider.name, 'familyClassProvider'); + expect(familyClassProvider(42, third: .42).name, 'familyClassProvider'); + }); + + test('Supports overriding non-family notifiers', () { + final container = createContainer( + overrides: [ + publicClassProvider.overrideWith(() => PublicClass('Hello world')), + ], + ); + + final notifier = container.read(publicClassProvider.notifier); + expect(notifier.param, 'Hello world'); + + expect(notifier.ref, isNotNull); + expect(notifier.state, isNotNull); + }); + + test('Supports overriding family notifiers', () { + final container = createContainer( + overrides: [ + familyClassProvider(42, third: .42) + .overrideWith(() => FamilyClass('Hello world')), + ], + ); + + final notifier = + container.read(familyClassProvider(42, third: .42).notifier); + expect(notifier.param, 'Hello world'); + expect(notifier.first, 42); + expect(notifier.second, null); + expect(notifier.third, .42); + expect(notifier.fourth, true); + expect(notifier.fifth, null); + + expect(notifier.ref, isNotNull); + expect(notifier.state, isNotNull); + }); + + test( + 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', + () async { + final container = createContainer(); + + const FamilyClassFamily family = familyClassProvider; + + expect(familyClassProvider(42, third: .42).from, familyClassProvider); + + expect( + familyClassProvider(42, third: .42), + familyClassProvider(42, third: .42), + ); + expect( + familyClassProvider(42, third: .42), + isNot(familyClassProvider(42, third: .21)), + ); + expect( + familyClassProvider(42, third: .42).hashCode, + isNot(familyClassProvider(42, third: .21).hashCode), + ); + + // handle defaults + expect( + familyClassProvider(42, third: .42), + familyClassProvider( + 42, + third: .42, + ), + ); + expect( + familyClassProvider(42, third: .42).hashCode, + familyClassProvider( + 42, + third: .42, + ).hashCode, + ); + + final FamilyClassProvider provider = familyClassProvider( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: const ['x42'], + ); + // ignore: invalid_use_of_internal_member + final AutoDisposeAsyncNotifierProviderImpl + futureProvider = provider; + + expect(provider.first, 42); + expect(provider.second, 'x42'); + expect(provider.third, .42); + expect(provider.fourth, false); + expect(provider.fifth, same(const ['x42'])); + + final sub = container.listen( + familyClassProvider( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: const ['x42'], + ).future, + (previous, next) {}, + ); + await sub.read(); + + final AsyncValue result = container.read( + familyClassProvider( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: const ['x42'], + ), + ); + + expect( + result, + const AsyncData( + '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', + ), + ); + }); +} diff --git a/packages/riverpod_generator/test/async_test.dart b/packages/riverpod_generator/test/async_test.dart index 3a5964721..9ba02be22 100644 --- a/packages/riverpod_generator/test/async_test.dart +++ b/packages/riverpod_generator/test/async_test.dart @@ -1,171 +1,171 @@ -// // ignore_for_file: omit_local_variable_types, unused_local_variable - -// import 'package:riverpod_annotation/riverpod_annotation.dart'; -// import 'package:test/test.dart'; - -// import 'integration/async.dart'; -// import 'utils.dart'; - -// void main() { -// test( -// 'Creates a FutureProvider if @riverpod is used on a FutureOr function', -// () { -// final container = createContainer(); - -// final AutoDisposeFutureProvider provider = publicProvider; -// final AsyncValue result = container.read(publicProvider); - -// expect(result, const AsyncData('Hello world')); -// }); - -// test('Generates .name for providers', () { -// expect(publicProvider.name, 'publicProvider'); -// expect(privateProvider.name, '_privateProvider'); - -// expect(familyProvider.name, 'familyProvider'); -// expect(familyProvider(42, third: .42).name, 'familyProvider'); -// }); - -// test('Supports overriding non-family providers', () async { -// final container = createContainer( -// overrides: [ -// publicProvider.overrideWith((ref) => Future.value('Hello world')), -// ], -// ); - -// final result = container.read(publicProvider.future); -// expect(await result, 'Hello world'); -// }); - -// test('Supports overriding family providers', () async { -// final container = createContainer( -// overrides: [ -// familyProvider(42, third: .42).overrideWith( -// (ref) => Future.value( -// 'Hello world ${ref.first} ${ref.second} ' -// '${ref.third} ${ref.fourth} ${ref.fifth}', -// ), -// ), -// ], -// ); - -// final result = container.read(familyProvider(42, third: .42).future); -// expect(await result, 'Hello world 42 null 0.42 true null'); -// }); - -// test( -// 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', -// () async { -// final container = createContainer(); - -// const FamilyFamily family = familyProvider; - -// expect(familyProvider(42, third: .42).from, familyProvider); - -// expect( -// familyProvider(42, third: .42), -// familyProvider(42, third: .42), -// ); -// expect( -// familyProvider(42, third: .42), -// isNot(familyProvider(42, third: .21)), -// ); -// expect( -// familyProvider(42, third: .42).hashCode, -// isNot(familyProvider(42, third: .21).hashCode), -// ); - -// // handle defaults -// expect( -// familyProvider(42, third: .42), -// familyProvider( -// 42, -// third: .42, -// ), -// ); -// expect( -// familyProvider(42, third: .42).hashCode, -// familyProvider( -// 42, -// third: .42, -// ).hashCode, -// ); - -// final FamilyProvider provider = familyProvider( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: const ['x42'], -// ); -// final AutoDisposeFutureProvider futureProvider = provider; - -// expect(provider.first, 42); -// expect(provider.second, 'x42'); -// expect(provider.third, .42); -// expect(provider.fourth, false); -// expect(provider.fifth, same(const ['x42'])); - -// final sub = container.listen( -// familyProvider( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: const ['x42'], -// ).future, -// (previous, next) {}, -// ); -// await sub.read(); - -// final AsyncValue result = container.read( -// familyProvider( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: const ['x42'], -// ), -// ); - -// expect( -// result, -// const AsyncData( -// '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', -// ), -// ); -// }); - -// test('can override providers', () { -// final container = createContainer( -// overrides: [ -// publicProvider.overrideWith((ref) { -// const FutureOr result = 'test'; -// return result; -// }), -// publicClassProvider.overrideWith(() => PublicClass(42)), -// familyProvider.overrideWith( -// (ref) { -// final FutureOr result = -// 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})'; -// return result; -// }, -// ), -// familyClassProvider.overrideWith(() => FamilyClass(42)), -// ], -// ); - -// expect(container.read(publicProvider).requireValue, 'test'); -// expect(container.read(publicClassProvider.notifier).param, 42); -// expect( -// container.read(familyProvider(42, second: '42', third: .42)).requireValue, -// 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', -// ); -// expect( -// container -// .read(familyClassProvider(42, second: '42', third: .42).notifier) -// .param, -// 42, -// ); -// }); -// } +// ignore_for_file: omit_local_variable_types, unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:test/test.dart'; + +import 'integration/async.dart'; +import 'utils.dart'; + +void main() { + test( + 'Creates a FutureProvider if @riverpod is used on a FutureOr function', + () { + final container = createContainer(); + + final AutoDisposeFutureProvider provider = publicProvider; + final AsyncValue result = container.read(publicProvider); + + expect(result, const AsyncData('Hello world')); + }); + + test('Generates .name for providers', () { + expect(publicProvider.name, 'publicProvider'); + expect(privateProvider.name, '_privateProvider'); + + expect(familyProvider.name, 'familyProvider'); + expect(familyProvider(42, third: .42).name, 'familyProvider'); + }); + + test('Supports overriding non-family providers', () async { + final container = createContainer( + overrides: [ + publicProvider.overrideWith((ref) => Future.value('Hello world')), + ], + ); + + final result = container.read(publicProvider.future); + expect(await result, 'Hello world'); + }); + + test('Supports overriding family providers', () async { + final container = createContainer( + overrides: [ + familyProvider(42, third: .42).overrideWith( + (ref) => Future.value( + 'Hello world ${ref.first} ${ref.second} ' + '${ref.third} ${ref.fourth} ${ref.fifth}', + ), + ), + ], + ); + + final result = container.read(familyProvider(42, third: .42).future); + expect(await result, 'Hello world 42 null 0.42 true null'); + }); + + test( + 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', + () async { + final container = createContainer(); + + const FamilyFamily family = familyProvider; + + expect(familyProvider(42, third: .42).from, familyProvider); + + expect( + familyProvider(42, third: .42), + familyProvider(42, third: .42), + ); + expect( + familyProvider(42, third: .42), + isNot(familyProvider(42, third: .21)), + ); + expect( + familyProvider(42, third: .42).hashCode, + isNot(familyProvider(42, third: .21).hashCode), + ); + + // handle defaults + expect( + familyProvider(42, third: .42), + familyProvider( + 42, + third: .42, + ), + ); + expect( + familyProvider(42, third: .42).hashCode, + familyProvider( + 42, + third: .42, + ).hashCode, + ); + + final FamilyProvider provider = familyProvider( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: const ['x42'], + ); + final AutoDisposeFutureProvider futureProvider = provider; + + expect(provider.first, 42); + expect(provider.second, 'x42'); + expect(provider.third, .42); + expect(provider.fourth, false); + expect(provider.fifth, same(const ['x42'])); + + final sub = container.listen( + familyProvider( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: const ['x42'], + ).future, + (previous, next) {}, + ); + await sub.read(); + + final AsyncValue result = container.read( + familyProvider( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: const ['x42'], + ), + ); + + expect( + result, + const AsyncData( + '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', + ), + ); + }); + + test('can override providers', () { + final container = createContainer( + overrides: [ + publicProvider.overrideWith((ref) { + const FutureOr result = 'test'; + return result; + }), + publicClassProvider.overrideWith(() => PublicClass(42)), + familyProvider.overrideWith( + (ref) { + final FutureOr result = + 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})'; + return result; + }, + ), + familyClassProvider.overrideWith(() => FamilyClass(42)), + ], + ); + + expect(container.read(publicProvider).requireValue, 'test'); + expect(container.read(publicClassProvider.notifier).param, 42); + expect( + container.read(familyProvider(42, second: '42', third: .42)).requireValue, + 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', + ); + expect( + container + .read(familyClassProvider(42, second: '42', third: .42).notifier) + .param, + 42, + ); + }); +} diff --git a/packages/riverpod_generator/test/auto_dispose_test.dart b/packages/riverpod_generator/test/auto_dispose_test.dart index affab90e1..affc1e10e 100644 --- a/packages/riverpod_generator/test/auto_dispose_test.dart +++ b/packages/riverpod_generator/test/auto_dispose_test.dart @@ -1,24 +1,24 @@ -// // ignore_for_file: omit_local_variable_types, unused_local_variable +// ignore_for_file: omit_local_variable_types, unused_local_variable -// import 'package:riverpod_annotation/riverpod_annotation.dart'; -// import 'package:test/test.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:test/test.dart'; -// import 'integration/auto_dispose.dart'; -// import 'utils.dart'; +import 'integration/auto_dispose.dart'; +import 'utils.dart'; -// void main() { -// test('Respects keepAlive parameter', () { -// final container = createContainer(); +void main() { + test('Respects keepAlive parameter', () { + final container = createContainer(); -// container.read(keepAliveProvider); + container.read(keepAliveProvider); -// expect( -// container.readProviderElement(keepAliveProvider), -// isA>(), -// ); -// expect( -// container.readProviderElement(keepAliveProvider), -// isNot(isA>()), -// ); -// }); -// } + expect( + container.readProviderElement(keepAliveProvider), + isA>(), + ); + expect( + container.readProviderElement(keepAliveProvider), + isNot(isA>()), + ); + }); +} diff --git a/packages/riverpod_generator/test/dependencies_test.dart b/packages/riverpod_generator/test/dependencies_test.dart index 03d51ad78..dfda6ca78 100644 --- a/packages/riverpod_generator/test/dependencies_test.dart +++ b/packages/riverpod_generator/test/dependencies_test.dart @@ -1,146 +1,149 @@ -// import 'package:riverpod_annotation/riverpod_annotation.dart'; -// import 'package:test/test.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:test/test.dart'; -// import 'integration/dependencies.dart'; +import 'integration/dependencies.dart'; -// void main() { -// test('Supports specifying dependencies', () { -// expect(depProvider.dependencies, null); -// expect(dep2Provider.dependencies, null); -// expect(familyProvider.dependencies, null); -// expect(family2Provider.dependencies, null); +void main() { + test('Supports specifying dependencies', () { + expect(depProvider.dependencies, null); + expect(dep2Provider.dependencies, null); + expect(familyProvider.dependencies, null); + expect(family2Provider.dependencies, null); -// expect( -// providerProvider.dependencies, -// [depProvider, familyProvider, dep2Provider, family2Provider], -// ); -// expect( -// provider2Provider.dependencies, -// [depProvider, familyProvider, dep2Provider, family2Provider], -// ); -// expect( -// provider3Provider.dependencies, -// [depProvider, familyProvider, dep2Provider, family2Provider], -// ); -// expect( -// provider4Provider.dependencies, -// [depProvider, familyProvider, dep2Provider, family2Provider], -// ); + expect( + providerProvider.dependencies, + [depProvider, familyProvider, dep2Provider, family2Provider], + ); + expect( + provider2Provider.dependencies, + [depProvider, familyProvider, dep2Provider, family2Provider], + ); + expect( + provider3Provider.dependencies, + [depProvider, familyProvider, dep2Provider, family2Provider], + ); + expect( + provider4Provider.dependencies, + [depProvider, familyProvider, dep2Provider, family2Provider], + ); -// expect(transitiveDependenciesProvider.dependencies, [providerProvider]); + expect(transitiveDependenciesProvider.dependencies, [providerProvider]); -// expect( -// emptyDependenciesFunctionalProvider.dependencies, -// same(const []), -// ); + expect( + emptyDependenciesFunctionalProvider.dependencies, + same(const []), + ); -// expect( -// emptyDependenciesClassBasedProvider.dependencies, -// same(const []), -// ); -// }); + expect( + emptyDependenciesClassBasedProvider.dependencies, + same(const []), + ); + }); -// test('Generates transitive dependencies', () { -// expect(depProvider.allTransitiveDependencies, null); -// expect(dep2Provider.allTransitiveDependencies, null); -// expect(familyProvider.allTransitiveDependencies, null); -// expect(family2Provider.allTransitiveDependencies, null); + test('Generates transitive dependencies', () { + expect(depProvider.allTransitiveDependencies, null); + expect(dep2Provider.allTransitiveDependencies, null); + expect(familyProvider.allTransitiveDependencies, null); + expect(family2Provider.allTransitiveDependencies, null); -// expect( -// providerProvider.allTransitiveDependencies, -// [depProvider, familyProvider, dep2Provider, family2Provider], -// ); -// expect( -// provider2Provider.allTransitiveDependencies, -// [depProvider, familyProvider, dep2Provider, family2Provider], -// ); -// expect( -// provider3Provider.allTransitiveDependencies, -// [depProvider, familyProvider, dep2Provider, family2Provider], -// ); -// expect( -// provider4Provider.allTransitiveDependencies, -// [depProvider, familyProvider, dep2Provider, family2Provider], -// ); + expect( + providerProvider.allTransitiveDependencies, + [depProvider, familyProvider, dep2Provider, family2Provider], + ); + expect( + provider2Provider.allTransitiveDependencies, + [depProvider, familyProvider, dep2Provider, family2Provider], + ); + expect( + provider3Provider.allTransitiveDependencies, + [depProvider, familyProvider, dep2Provider, family2Provider], + ); + expect( + provider4Provider.allTransitiveDependencies, + [depProvider, familyProvider, dep2Provider, family2Provider], + ); -// expect( -// transitiveDependenciesProvider.allTransitiveDependencies, -// [ -// providerProvider, -// depProvider, -// familyProvider, -// dep2Provider, -// family2Provider, -// ], -// ); + expect( + transitiveDependenciesProvider.allTransitiveDependencies, + [ + providerProvider, + depProvider, + familyProvider, + dep2Provider, + family2Provider, + ], + ); -// expect( -// emptyDependenciesFunctionalProvider.allTransitiveDependencies, -// same(const {}), -// ); + expect( + emptyDependenciesFunctionalProvider.allTransitiveDependencies, + same(const {}), + ); -// expect( -// emptyDependenciesClassBasedProvider.allTransitiveDependencies, -// same(const {}), -// ); -// }); + expect( + emptyDependenciesClassBasedProvider.allTransitiveDependencies, + same(const {}), + ); + }); -// test( -// 'On families, passes `null` as dependencies/allTransitiveDependencies to the providers', -// () { -// expect(provider4Provider(42).dependencies, null); -// expect(provider4Provider(42).allTransitiveDependencies, null); -// }); + test( + 'On families, passes `null` as dependencies/allTransitiveDependencies to the providers', + () { + expect(provider4Provider(42).dependencies, null); + expect(provider4Provider(42).allTransitiveDependencies, null); + }); -// test('Caches dependencies', () { -// expect( -// providerProvider.dependencies, -// same(providerProvider.dependencies), -// ); -// expect( -// provider2Provider.dependencies, -// same(provider2Provider.dependencies), -// ); -// expect( -// provider3Provider.dependencies, -// same(provider3Provider.dependencies), -// ); -// expect( -// provider4Provider.dependencies, -// same(provider4Provider.dependencies), -// ); -// expect( -// transitiveDependenciesProvider.dependencies, -// same(transitiveDependenciesProvider.dependencies), -// ); -// expect( -// smallTransitiveDependencyCountProvider.dependencies, -// same(smallTransitiveDependencyCountProvider.dependencies), -// ); -// expect( -// emptyDependenciesFunctionalProvider.dependencies, -// same(emptyDependenciesFunctionalProvider.dependencies), -// ); -// expect( -// emptyDependenciesClassBasedProvider.dependencies, -// same(emptyDependenciesClassBasedProvider.dependencies), -// ); + test('Caches dependencies', () { + expect( + providerProvider.dependencies, + same(providerProvider.dependencies), + ); + expect( + provider2Provider.dependencies, + same(provider2Provider.dependencies), + ); + expect( + provider3Provider.dependencies, + same(provider3Provider.dependencies), + ); + expect( + provider4Provider.dependencies, + same(provider4Provider.dependencies), + ); + expect( + transitiveDependenciesProvider.dependencies, + same(transitiveDependenciesProvider.dependencies), + ); + expect( + smallTransitiveDependencyCountProvider.dependencies, + same(smallTransitiveDependencyCountProvider.dependencies), + ); + expect( + emptyDependenciesFunctionalProvider.dependencies, + same(emptyDependenciesFunctionalProvider.dependencies), + ); + expect( + emptyDependenciesClassBasedProvider.dependencies, + same(emptyDependenciesClassBasedProvider.dependencies), + ); -// expect( -// provider3Provider.allTransitiveDependencies, -// same(provider3Provider.allTransitiveDependencies), -// ); -// expect( -// provider4Provider.allTransitiveDependencies, -// same(provider4Provider.allTransitiveDependencies), -// ); -// expect( -// transitiveDependenciesProvider.allTransitiveDependencies, -// same(transitiveDependenciesProvider.allTransitiveDependencies), -// ); -// expect( -// smallTransitiveDependencyCountProvider.allTransitiveDependencies, -// same(smallTransitiveDependencyCountProvider.allTransitiveDependencies), -// ); -// }); -// } + expect( + provider3Provider.allTransitiveDependencies, + same(provider3Provider.allTransitiveDependencies), + ); + expect( + provider4Provider.allTransitiveDependencies, + same(provider4Provider.allTransitiveDependencies), + ); + expect( + transitiveDependenciesProvider.allTransitiveDependencies, + same(transitiveDependenciesProvider.allTransitiveDependencies), + ); + expect( + smallTransitiveDependencyCountProvider.allTransitiveDependencies, + same(smallTransitiveDependencyCountProvider.allTransitiveDependencies), + ); + }); + + // TODO add tests for duplicate variants + // TODO add tests for set vs list +} diff --git a/packages/riverpod_generator/test/hash_test.dart b/packages/riverpod_generator/test/hash_test.dart index 42dbee531..0967e11c8 100644 --- a/packages/riverpod_generator/test/hash_test.dart +++ b/packages/riverpod_generator/test/hash_test.dart @@ -1,35 +1,35 @@ -// // ignore_for_file: invalid_use_of_internal_member +// ignore_for_file: invalid_use_of_internal_member -// import 'package:test/test.dart'; +import 'package:test/test.dart'; -// import 'integration/hash/hash1.dart'; +import 'integration/hash/hash1.dart'; -// void main() { -// test('Generates hash function for providers', () { -// expect( -// simpleProvider.debugGetCreateSourceHash!(), -// simpleProvider.debugGetCreateSourceHash!(), -// ); -// expect( -// simple2Provider.debugGetCreateSourceHash!(), -// simple2Provider.debugGetCreateSourceHash!(), -// ); -// expect( -// simpleClassProvider.debugGetCreateSourceHash!(), -// simpleClassProvider.debugGetCreateSourceHash!(), -// ); +void main() { + test('Generates hash function for providers', () { + expect( + simpleProvider.debugGetCreateSourceHash(), + simpleProvider.debugGetCreateSourceHash(), + ); + expect( + simple2Provider.debugGetCreateSourceHash(), + simple2Provider.debugGetCreateSourceHash(), + ); + expect( + simpleClassProvider.debugGetCreateSourceHash(), + simpleClassProvider.debugGetCreateSourceHash(), + ); -// expect( -// simpleProvider.debugGetCreateSourceHash!(), -// isNot(simple2Provider.debugGetCreateSourceHash!()), -// ); -// expect( -// simpleProvider.debugGetCreateSourceHash!(), -// isNot(simpleClassProvider.debugGetCreateSourceHash!()), -// ); -// expect( -// simpleProvider.debugGetCreateSourceHash!(), -// isNot(simple2Provider.debugGetCreateSourceHash!()), -// ); -// }); -// } + expect( + simpleProvider.debugGetCreateSourceHash(), + isNot(simple2Provider.debugGetCreateSourceHash()), + ); + expect( + simpleProvider.debugGetCreateSourceHash(), + isNot(simpleClassProvider.debugGetCreateSourceHash()), + ); + expect( + simpleProvider.debugGetCreateSourceHash(), + isNot(simple2Provider.debugGetCreateSourceHash()), + ); + }); +} diff --git a/packages/riverpod_generator/test/integration/annotated.dart b/packages/riverpod_generator/test/integration/annotated.dart index a1064b867..a60a58a4d 100644 --- a/packages/riverpod_generator/test/integration/annotated.dart +++ b/packages/riverpod_generator/test/integration/annotated.dart @@ -1,40 +1,40 @@ -// import 'package:meta/meta.dart'; -// import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:meta/meta.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; -// part 'annotated.g.dart'; +part 'annotated.g.dart'; -// @riverpod -// @Deprecated('Deprecation message') -// @visibleForTesting -// @protected -// String functional(FunctionalRef ref) => 'functional'; +@riverpod +@Deprecated('Deprecation message') +@visibleForTesting +@protected +String functional(FunctionalRef ref) => 'functional'; -// @riverpod -// @Deprecated('Deprecation message') -// @visibleForTesting -// @protected -// class ClassBased extends _$ClassBased { -// @override -// String build() => 'ClassBased'; -// } +@riverpod +@Deprecated('Deprecation message') +@visibleForTesting +@protected +class ClassBased extends _$ClassBased { + @override + String build() => 'ClassBased'; +} -// @riverpod -// @Deprecated('Deprecation message') -// @visibleForTesting -// @protected -// String family(FamilyRef ref, int id) => 'family $id'; +@riverpod +@Deprecated('Deprecation message') +@visibleForTesting +@protected +String family(FamilyRef ref, int id) => 'family $id'; -// @riverpod -// @doNotStore -// String notCopiedFunctional(NotCopiedFunctionalRef ref) => 'notCopiedFunctional'; +@riverpod +@doNotStore +String notCopiedFunctional(NotCopiedFunctionalRef ref) => 'notCopiedFunctional'; -// @riverpod -// @doNotStore -// class NotCopiedClassBased extends _$NotCopiedClassBased { -// @override -// String build() => 'NotCopiedClassBased'; -// } +@riverpod +@doNotStore +class NotCopiedClassBased extends _$NotCopiedClassBased { + @override + String build() => 'NotCopiedClassBased'; +} -// @riverpod -// @doNotStore -// String notCopiedFamily(NotCopiedFamilyRef ref, int id) => 'notCopiedFamily $id'; +@riverpod +@doNotStore +String notCopiedFamily(NotCopiedFamilyRef ref, int id) => 'notCopiedFamily $id'; diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart new file mode 100644 index 000000000..8dbe1bf7c --- /dev/null +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -0,0 +1,412 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'annotated.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef FunctionalRef = Ref; + +const functionalProvider = FunctionalProvider._(); + +final class FunctionalProvider + extends $FunctionalProvider + with $Provider { + const FunctionalProvider._( + {String Function( + FunctionalRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'functionalProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + FunctionalRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$functionalHash(); + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + String create(FunctionalRef ref) { + final fn = _createCb ?? functional; + + return fn( + ref, + ); + } + + @override + FunctionalProvider copyWithCreate( + String Function( + FunctionalRef ref, + ) create, + ) { + return FunctionalProvider._(create: create); + } +} + +String _$functionalHash() => r'69e260b1de8ba28cbeb8e24d628933366cde6b8b'; + +typedef FamilyRef = Ref; + +const familyProvider = FamilyFamily._(); + +final class FamilyProvider + extends $FunctionalProvider + with $Provider { + const FamilyProvider._( + {required FamilyFamily super.from, + required (int,) super.argument, + String Function( + FamilyRef ref, + int id, + )? create}) + : _createCb = create, + super( + name: r'familyProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + FamilyRef ref, + int id, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$familyHash(); + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + String create(FamilyRef ref) { + final fn = _createCb ?? family; + final (int,) argument = this.argument! as (int,); + return fn( + ref, + argument.$1, + ); + } + + @override + FamilyProvider copyWithCreate( + String Function( + FamilyRef ref, + ) create, + ) { + return FamilyProvider._( + argument: argument! as (int,), + from: from! as FamilyFamily, + create: ( + ref, + int id, + ) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is FamilyProvider && other.argument == argument; + } +} + +String _$familyHash() => r'd70685b83be840bfd9e79c11fb84c905d19d6e10'; + +final class FamilyFamily extends Family { + const FamilyFamily._() + : super( + name: r'familyProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + FamilyProvider call( + int id, + ) => + FamilyProvider._(argument: (id,), from: this); + + @override + String debugGetCreateSourceHash() => _$familyHash(); + + @override + String toString() => r'family'; +} + +typedef NotCopiedFunctionalRef = Ref; + +const notCopiedFunctionalProvider = NotCopiedFunctionalProvider._(); + +final class NotCopiedFunctionalProvider + extends $FunctionalProvider + with $Provider { + const NotCopiedFunctionalProvider._( + {String Function( + NotCopiedFunctionalRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'notCopiedFunctionalProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + NotCopiedFunctionalRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$notCopiedFunctionalHash(); + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + String create(NotCopiedFunctionalRef ref) { + final fn = _createCb ?? notCopiedFunctional; + + return fn( + ref, + ); + } + + @override + NotCopiedFunctionalProvider copyWithCreate( + String Function( + NotCopiedFunctionalRef ref, + ) create, + ) { + return NotCopiedFunctionalProvider._(create: create); + } +} + +String _$notCopiedFunctionalHash() => + r'30587ee9ceb75d5c8562015ad4a67ec0b107c1f6'; + +typedef NotCopiedFamilyRef = Ref; + +const notCopiedFamilyProvider = NotCopiedFamilyFamily._(); + +final class NotCopiedFamilyProvider + extends $FunctionalProvider + with $Provider { + const NotCopiedFamilyProvider._( + {required NotCopiedFamilyFamily super.from, + required (int,) super.argument, + String Function( + NotCopiedFamilyRef ref, + int id, + )? create}) + : _createCb = create, + super( + name: r'notCopiedFamilyProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + NotCopiedFamilyRef ref, + int id, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$notCopiedFamilyHash(); + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + String create(NotCopiedFamilyRef ref) { + final fn = _createCb ?? notCopiedFamily; + final (int,) argument = this.argument! as (int,); + return fn( + ref, + argument.$1, + ); + } + + @override + NotCopiedFamilyProvider copyWithCreate( + String Function( + NotCopiedFamilyRef ref, + ) create, + ) { + return NotCopiedFamilyProvider._( + argument: argument! as (int,), + from: from! as NotCopiedFamilyFamily, + create: ( + ref, + int id, + ) => + create(ref)); + } + + @override + bool operator ==(Object other) { + return other is NotCopiedFamilyProvider && other.argument == argument; + } +} + +String _$notCopiedFamilyHash() => r'6ef06ce6ebd73b476870bbe1af41c4f3fbe8ddb1'; + +final class NotCopiedFamilyFamily extends Family { + const NotCopiedFamilyFamily._() + : super( + name: r'notCopiedFamilyProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + NotCopiedFamilyProvider call( + int id, + ) => + NotCopiedFamilyProvider._(argument: (id,), from: this); + + @override + String debugGetCreateSourceHash() => _$notCopiedFamilyHash(); + + @override + String toString() => r'notCopiedFamily'; +} + +const classBasedProvider = ClassBasedProvider._(); + +final class ClassBasedProvider extends $NotifierProvider { + const ClassBasedProvider._( + {super.runNotifierBuildOverride, ClassBased Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'classBasedProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ClassBased Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$classBasedHash(); + + @$internal + @override + ClassBased create() => _createCb?.call() ?? ClassBased(); + + @$internal + @override + ClassBasedProvider copyWithCreate( + ClassBased Function() create, + ) { + return ClassBasedProvider._(create: create); + } + + @$internal + @override + ClassBasedProvider copyWithBuild( + String Function(Ref, ClassBased) build, + ) { + return ClassBasedProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$classBasedHash() => r'f40d1a032ee264aafd7686a985cdf1937f2dc108'; + +abstract class _$ClassBased extends $Notifier { + String build(); + + @$internal + @override + String runBuild() => build(); +} + +const notCopiedClassBasedProvider = NotCopiedClassBasedProvider._(); + +final class NotCopiedClassBasedProvider + extends $NotifierProvider { + const NotCopiedClassBasedProvider._( + {super.runNotifierBuildOverride, NotCopiedClassBased Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'notCopiedClassBasedProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final NotCopiedClassBased Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$notCopiedClassBasedHash(); + + @$internal + @override + NotCopiedClassBased create() => _createCb?.call() ?? NotCopiedClassBased(); + + @$internal + @override + NotCopiedClassBasedProvider copyWithCreate( + NotCopiedClassBased Function() create, + ) { + return NotCopiedClassBasedProvider._(create: create); + } + + @$internal + @override + NotCopiedClassBasedProvider copyWithBuild( + String Function(Ref, NotCopiedClassBased) build, + ) { + return NotCopiedClassBasedProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$notCopiedClassBasedHash() => + r'd2aefd08a78e3bb4c02000d4931a3bf15c01b495'; + +abstract class _$NotCopiedClassBased extends $Notifier { + String build(); + + @$internal + @override + String runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/hash/hash1.dart b/packages/riverpod_generator/test/integration/hash/hash1.dart index abfeb7e6b..a299a420e 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.dart @@ -1,19 +1,19 @@ -// import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; -// part 'hash1.g.dart'; +part 'hash1.g.dart'; -// @riverpod -// String simple(SimpleRef ref) { -// return 'Hello world'; -// } +@riverpod +String simple(SimpleRef ref) { + return 'Hello world'; +} -// @riverpod -// String simple2(Simple2Ref ref) { -// // return 'Hello world2'; -// } +@riverpod +String simple2(Simple2Ref ref) { + return 'Hello world2'; +} -// @riverpod -// class SimpleClass extends _$SimpleClass { -// @override -// String build() => 'Hello world'; -// } +@riverpod +class SimpleClass extends _$SimpleClass { + @override + String build() => 'Hello world'; +} diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart new file mode 100644 index 000000000..d14305c9b --- /dev/null +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -0,0 +1,174 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'hash1.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef SimpleRef = Ref; + +const simpleProvider = SimpleProvider._(); + +final class SimpleProvider + extends $FunctionalProvider + with $Provider { + const SimpleProvider._( + {String Function( + SimpleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'simpleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + SimpleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$simpleHash(); + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + String create(SimpleRef ref) { + final fn = _createCb ?? simple; + + return fn( + ref, + ); + } + + @override + SimpleProvider copyWithCreate( + String Function( + SimpleRef ref, + ) create, + ) { + return SimpleProvider._(create: create); + } +} + +String _$simpleHash() => r'ff9f7451526aef5b3af6646814631a502ad76a5f'; + +typedef Simple2Ref = Ref; + +const simple2Provider = Simple2Provider._(); + +final class Simple2Provider + extends $FunctionalProvider + with $Provider { + const Simple2Provider._( + {String Function( + Simple2Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'simple2Provider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + Simple2Ref ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$simple2Hash(); + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + String create(Simple2Ref ref) { + final fn = _createCb ?? simple2; + + return fn( + ref, + ); + } + + @override + Simple2Provider copyWithCreate( + String Function( + Simple2Ref ref, + ) create, + ) { + return Simple2Provider._(create: create); + } +} + +String _$simple2Hash() => r'06327442776394c5c9cbb33b048d7a42e709e7fd'; + +const simpleClassProvider = SimpleClassProvider._(); + +final class SimpleClassProvider extends $NotifierProvider { + const SimpleClassProvider._( + {super.runNotifierBuildOverride, SimpleClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'simpleClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final SimpleClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$simpleClassHash(); + + @$internal + @override + SimpleClass create() => _createCb?.call() ?? SimpleClass(); + + @$internal + @override + SimpleClassProvider copyWithCreate( + SimpleClass Function() create, + ) { + return SimpleClassProvider._(create: create); + } + + @$internal + @override + SimpleClassProvider copyWithBuild( + String Function(Ref, SimpleClass) build, + ) { + return SimpleClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$simpleClassHash() => r'958123cd6179c5b88da040cfeb71eb3061765277'; + +abstract class _$SimpleClass extends $Notifier { + String build(); + + @$internal + @override + String runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/scopes.dart b/packages/riverpod_generator/test/integration/scopes.dart index 9e0b223c5..d1b29e563 100644 --- a/packages/riverpod_generator/test/integration/scopes.dart +++ b/packages/riverpod_generator/test/integration/scopes.dart @@ -4,3 +4,9 @@ part 'scopes.g.dart'; @riverpod external int scoped(); + +// TODO changelog added support for abstract build method. +@riverpod +class ScopedClass extends _$ScopedClass { + int build(); +} diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 44b032d91..2e92c4293 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -58,6 +58,63 @@ final class ScopedProvider extends $FunctionalProvider String _$scopedHash() => r'590f1a203323105e732397a2616fbd7dac65f0cc'; +const scopedClassProvider = ScopedClassProvider._(); + +final class ScopedClassProvider extends $NotifierProvider { + const ScopedClassProvider._( + {super.runNotifierBuildOverride, ScopedClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'scopedClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ScopedClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$scopedClassHash(); + + @$internal + @override + ScopedClass create() => _createCb?.call() ?? ScopedClass(); + + @$internal + @override + ScopedClassProvider copyWithCreate( + ScopedClass Function() create, + ) { + return ScopedClassProvider._(create: create); + } + + @$internal + @override + ScopedClassProvider copyWithBuild( + int Function(Ref, ScopedClass) build, + ) { + return ScopedClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$scopedClassHash() => r'12c0c3f2bbda7eaeaaf1c30cb6398f056f801647'; + +abstract class _$ScopedClass extends $Notifier { + int build(); + + @$internal + @override + int runBuild() => build(); +} + const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/notifier_test.dart b/packages/riverpod_generator/test/notifier_test.dart index e1180c259..a455f51ac 100644 --- a/packages/riverpod_generator/test/notifier_test.dart +++ b/packages/riverpod_generator/test/notifier_test.dart @@ -1,134 +1,134 @@ -// // ignore_for_file: omit_local_variable_types, unused_local_variable - -// import 'package:riverpod_annotation/riverpod_annotation.dart'; -// import 'package:test/test.dart'; - -// import 'integration/sync.dart'; -// import 'utils.dart'; - -// void main() { -// test('Creates a Provider if @riverpod is used on a synchronous function', -// () { -// final container = createContainer(); - -// final AutoDisposeNotifierProvider provider = -// publicClassProvider; -// final String result = container.read(publicProvider); - -// expect(result, 'Hello world'); -// }); - -// test('Generates .name for providers', () { -// expect(publicClassProvider.name, 'publicClassProvider'); -// expect(privateClassProvider.name, '_privateClassProvider'); - -// expect(familyClassProvider.name, 'familyClassProvider'); -// expect(familyClassProvider(42, third: .42).name, 'familyClassProvider'); -// }); - -// test('Supports overriding non-family notifiers', () { -// final container = createContainer( -// overrides: [ -// publicClassProvider.overrideWith(() => PublicClass('Hello world')), -// ], -// ); - -// final notifier = container.read(publicClassProvider.notifier); -// expect(notifier.param, 'Hello world'); - -// expect(notifier.ref, isNotNull); -// expect(notifier.state, isNotNull); -// }); - -// test('Supports overriding family notifiers', () { -// final container = createContainer( -// overrides: [ -// familyClassProvider(42, third: .42) -// .overrideWith(() => FamilyClass('Hello world')), -// ], -// ); - -// final notifier = -// container.read(familyClassProvider(42, third: .42).notifier); -// expect(notifier.param, 'Hello world'); -// expect(notifier.first, 42); -// expect(notifier.second, null); -// expect(notifier.third, .42); -// expect(notifier.fourth, true); -// expect(notifier.fifth, null); - -// expect(notifier.ref, isNotNull); -// expect(notifier.state, isNotNull); -// }); - -// test( -// 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', -// () { -// final container = createContainer(); - -// const FamilyClassFamily family = familyClassProvider; - -// expect(familyClassProvider(42, third: .42).from, familyClassProvider); - -// expect( -// familyClassProvider(42, third: .42), -// familyClassProvider(42, third: .42), -// ); -// expect( -// familyClassProvider(42, third: .42), -// isNot(familyClassProvider(42, third: .21)), -// ); -// expect( -// familyClassProvider(42, third: .42).hashCode, -// isNot(familyClassProvider(42, third: .21).hashCode), -// ); - -// // handle defaults -// expect( -// familyClassProvider(42, third: .42), -// familyClassProvider( -// 42, -// third: .42, -// ), -// ); -// expect( -// familyClassProvider(42, third: .42).hashCode, -// familyClassProvider( -// 42, -// third: .42, -// ).hashCode, -// ); - -// final FamilyClassProvider provider = familyClassProvider( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: ['x42'], -// ); -// // ignore: invalid_use_of_internal_member -// final AutoDisposeNotifierProviderImpl futureProvider = -// provider; - -// expect(provider.first, 42); -// expect(provider.second, 'x42'); -// expect(provider.third, .42); -// expect(provider.fourth, false); -// expect(provider.fifth, ['x42']); - -// final String result = container.read( -// familyClassProvider( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: ['x42'], -// ), -// ); - -// expect( -// result, -// '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', -// ); -// }); -// } +// ignore_for_file: omit_local_variable_types, unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:test/test.dart'; + +import 'integration/sync.dart'; +import 'utils.dart'; + +void main() { + test('Creates a Provider if @riverpod is used on a synchronous function', + () { + final container = createContainer(); + + final AutoDisposeNotifierProvider provider = + publicClassProvider; + final String result = container.read(publicProvider); + + expect(result, 'Hello world'); + }); + + test('Generates .name for providers', () { + expect(publicClassProvider.name, 'publicClassProvider'); + expect(privateClassProvider.name, '_privateClassProvider'); + + expect(familyClassProvider.name, 'familyClassProvider'); + expect(familyClassProvider(42, third: .42).name, 'familyClassProvider'); + }); + + test('Supports overriding non-family notifiers', () { + final container = createContainer( + overrides: [ + publicClassProvider.overrideWith(() => PublicClass('Hello world')), + ], + ); + + final notifier = container.read(publicClassProvider.notifier); + expect(notifier.param, 'Hello world'); + + expect(notifier.ref, isNotNull); + expect(notifier.state, isNotNull); + }); + + test('Supports overriding family notifiers', () { + final container = createContainer( + overrides: [ + familyClassProvider(42, third: .42) + .overrideWith(() => FamilyClass('Hello world')), + ], + ); + + final notifier = + container.read(familyClassProvider(42, third: .42).notifier); + expect(notifier.param, 'Hello world'); + expect(notifier.first, 42); + expect(notifier.second, null); + expect(notifier.third, .42); + expect(notifier.fourth, true); + expect(notifier.fifth, null); + + expect(notifier.ref, isNotNull); + expect(notifier.state, isNotNull); + }); + + test( + 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', + () { + final container = createContainer(); + + const FamilyClassFamily family = familyClassProvider; + + expect(familyClassProvider(42, third: .42).from, familyClassProvider); + + expect( + familyClassProvider(42, third: .42), + familyClassProvider(42, third: .42), + ); + expect( + familyClassProvider(42, third: .42), + isNot(familyClassProvider(42, third: .21)), + ); + expect( + familyClassProvider(42, third: .42).hashCode, + isNot(familyClassProvider(42, third: .21).hashCode), + ); + + // handle defaults + expect( + familyClassProvider(42, third: .42), + familyClassProvider( + 42, + third: .42, + ), + ); + expect( + familyClassProvider(42, third: .42).hashCode, + familyClassProvider( + 42, + third: .42, + ).hashCode, + ); + + final FamilyClassProvider provider = familyClassProvider( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: ['x42'], + ); + // ignore: invalid_use_of_internal_member + final AutoDisposeNotifierProviderImpl futureProvider = + provider; + + expect(provider.first, 42); + expect(provider.second, 'x42'); + expect(provider.third, .42); + expect(provider.fourth, false); + expect(provider.fifth, ['x42']); + + final String result = container.read( + familyClassProvider( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: ['x42'], + ), + ); + + expect( + result, + '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', + ); + }); +} diff --git a/packages/riverpod_generator/test/scoped_test.dart b/packages/riverpod_generator/test/scoped_test.dart index 41a679b3f..4e64663d6 100644 --- a/packages/riverpod_generator/test/scoped_test.dart +++ b/packages/riverpod_generator/test/scoped_test.dart @@ -1,25 +1,25 @@ -// import 'package:test/test.dart'; +import 'package:test/test.dart'; -// import 'integration/scopes.dart'; -// import 'utils.dart'; +import 'integration/scopes.dart'; +import 'utils.dart'; -// void main() { -// test('throws UnsupportedError if accessed without an override', () { -// final container = createContainer(); +void main() { + test('throws UnsupportedError if accessed without an override', () { + final container = createContainer(); -// expect( -// () => container.read(scopedProvider), -// throwsUnsupportedError, -// ); -// }); + expect( + () => container.read(scopedProvider), + throwsUnsupportedError, + ); + }); -// test('Can be accessed without problem if the provider is overridden', () { -// final container = createContainer( -// overrides: [ -// scopedProvider.overrideWith((ref) => 42), -// ], -// ); + test('Can be accessed without problem if the provider is overridden', () { + final container = createContainer( + overrides: [ + scopedProvider.overrideWith((ref) => 42), + ], + ); -// expect(container.read(scopedProvider), 42); -// }); -// } + expect(container.read(scopedProvider), 42); + }); +} diff --git a/packages/riverpod_generator/test/stream_notifier_test.dart b/packages/riverpod_generator/test/stream_notifier_test.dart index a4422815d..5de59ca8c 100644 --- a/packages/riverpod_generator/test/stream_notifier_test.dart +++ b/packages/riverpod_generator/test/stream_notifier_test.dart @@ -1,138 +1,138 @@ -// // ignore_for_file: omit_local_variable_types, unused_local_variable - -// import 'package:riverpod_annotation/riverpod_annotation.dart'; -// import 'package:test/test.dart'; - -// import 'integration/stream.dart'; -// import 'utils.dart'; - -// void main() { -// test( -// 'Creates a StreamNotifierProvider if @riverpod is used on a Stream class', -// () async { -// final container = createContainer(); - -// final AutoDisposeStreamNotifierProvider provider = -// publicClassProvider; - -// expect( -// await container.listen(publicClassProvider.future, (_, __) {}).read(), -// 'Hello world', -// ); -// }); - -// test('Generates .name for providers', () { -// expect(publicClassProvider.name, 'publicClassProvider'); -// expect(privateClassProvider.name, '_privateClassProvider'); - -// expect(familyClassProvider.name, 'familyClassProvider'); -// expect(familyClassProvider(42, third: .42).name, 'familyClassProvider'); -// }); - -// test('Supports overriding non-family notifiers', () { -// final container = createContainer( -// overrides: [ -// publicClassProvider.overrideWith(() => PublicClass('Hello world')), -// ], -// ); - -// final notifier = container.read(publicClassProvider.notifier); -// expect(notifier.param, 'Hello world'); - -// expect(notifier.ref, isNotNull); -// expect(notifier.state, isNotNull); -// }); - -// test('Supports overriding family notifiers', () { -// final container = createContainer( -// overrides: [ -// familyClassProvider(42, third: .42) -// .overrideWith(() => FamilyClass('Hello world')), -// ], -// ); - -// final notifier = -// container.read(familyClassProvider(42, third: .42).notifier); -// expect(notifier.param, 'Hello world'); -// expect(notifier.first, 42); -// expect(notifier.second, null); -// expect(notifier.third, .42); -// expect(notifier.fourth, true); -// expect(notifier.fifth, null); - -// expect(notifier.ref, isNotNull); -// expect(notifier.state, isNotNull); -// }); - -// test( -// 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', -// () async { -// final container = createContainer(); - -// const FamilyClassFamily family = familyClassProvider; - -// expect(familyClassProvider(42, third: .42).from, familyClassProvider); - -// expect( -// familyClassProvider(42, third: .42), -// familyClassProvider(42, third: .42), -// ); -// expect( -// familyClassProvider(42, third: .42), -// isNot(familyClassProvider(42, third: .21)), -// ); -// expect( -// familyClassProvider(42, third: .42).hashCode, -// isNot(familyClassProvider(42, third: .21).hashCode), -// ); - -// // handle defaults -// expect( -// familyClassProvider(42, third: .42), -// familyClassProvider( -// 42, -// third: .42, -// ), -// ); -// expect( -// familyClassProvider(42, third: .42).hashCode, -// familyClassProvider( -// 42, -// third: .42, -// ).hashCode, -// ); - -// final FamilyClassProvider provider = familyClassProvider( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: ['x42'], -// ); -// // ignore: invalid_use_of_internal_member -// final AutoDisposeStreamNotifierProviderImpl -// futureProvider = provider; - -// expect(provider.first, 42); -// expect(provider.second, 'x42'); -// expect(provider.third, .42); -// expect(provider.fourth, false); -// expect(provider.fifth, ['x42']); - -// expect( -// await container -// .listen( -// familyClassProvider( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: ['x42'], -// ).future, -// (_, __) {}, -// ) -// .read(), -// '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', -// ); -// }); -// } +// ignore_for_file: omit_local_variable_types, unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:test/test.dart'; + +import 'integration/stream.dart'; +import 'utils.dart'; + +void main() { + test( + 'Creates a StreamNotifierProvider if @riverpod is used on a Stream class', + () async { + final container = createContainer(); + + final AutoDisposeStreamNotifierProvider provider = + publicClassProvider; + + expect( + await container.listen(publicClassProvider.future, (_, __) {}).read(), + 'Hello world', + ); + }); + + test('Generates .name for providers', () { + expect(publicClassProvider.name, 'publicClassProvider'); + expect(privateClassProvider.name, '_privateClassProvider'); + + expect(familyClassProvider.name, 'familyClassProvider'); + expect(familyClassProvider(42, third: .42).name, 'familyClassProvider'); + }); + + test('Supports overriding non-family notifiers', () { + final container = createContainer( + overrides: [ + publicClassProvider.overrideWith(() => PublicClass('Hello world')), + ], + ); + + final notifier = container.read(publicClassProvider.notifier); + expect(notifier.param, 'Hello world'); + + expect(notifier.ref, isNotNull); + expect(notifier.state, isNotNull); + }); + + test('Supports overriding family notifiers', () { + final container = createContainer( + overrides: [ + familyClassProvider(42, third: .42) + .overrideWith(() => FamilyClass('Hello world')), + ], + ); + + final notifier = + container.read(familyClassProvider(42, third: .42).notifier); + expect(notifier.param, 'Hello world'); + expect(notifier.first, 42); + expect(notifier.second, null); + expect(notifier.third, .42); + expect(notifier.fourth, true); + expect(notifier.fifth, null); + + expect(notifier.ref, isNotNull); + expect(notifier.state, isNotNull); + }); + + test( + 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', + () async { + final container = createContainer(); + + const FamilyClassFamily family = familyClassProvider; + + expect(familyClassProvider(42, third: .42).from, familyClassProvider); + + expect( + familyClassProvider(42, third: .42), + familyClassProvider(42, third: .42), + ); + expect( + familyClassProvider(42, third: .42), + isNot(familyClassProvider(42, third: .21)), + ); + expect( + familyClassProvider(42, third: .42).hashCode, + isNot(familyClassProvider(42, third: .21).hashCode), + ); + + // handle defaults + expect( + familyClassProvider(42, third: .42), + familyClassProvider( + 42, + third: .42, + ), + ); + expect( + familyClassProvider(42, third: .42).hashCode, + familyClassProvider( + 42, + third: .42, + ).hashCode, + ); + + final FamilyClassProvider provider = familyClassProvider( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: ['x42'], + ); + // ignore: invalid_use_of_internal_member + final AutoDisposeStreamNotifierProviderImpl + futureProvider = provider; + + expect(provider.first, 42); + expect(provider.second, 'x42'); + expect(provider.third, .42); + expect(provider.fourth, false); + expect(provider.fifth, ['x42']); + + expect( + await container + .listen( + familyClassProvider( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: ['x42'], + ).future, + (_, __) {}, + ) + .read(), + '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', + ); + }); +} diff --git a/packages/riverpod_generator/test/stream_test.dart b/packages/riverpod_generator/test/stream_test.dart index 4f128ff3f..fc23c0e5c 100644 --- a/packages/riverpod_generator/test/stream_test.dart +++ b/packages/riverpod_generator/test/stream_test.dart @@ -1,160 +1,160 @@ -// // ignore_for_file: omit_local_variable_types, unused_local_variable - -// import 'package:riverpod_annotation/riverpod_annotation.dart'; -// import 'package:test/test.dart'; - -// import 'integration/stream.dart'; -// import 'utils.dart'; - -// void main() { -// test('Creates a StreamProvider if @riverpod is used on a Stream function', -// () async { -// final container = createContainer(); - -// final AutoDisposeStreamProvider provider = publicProvider; - -// expect( -// await container.listen(publicProvider.future, (_, __) {}).read(), -// 'Hello world', -// ); -// }); - -// test('Generates .name for providers', () { -// expect(publicProvider.name, 'publicProvider'); -// expect(privateProvider.name, '_privateProvider'); - -// expect(familyProvider.name, 'familyProvider'); -// expect(familyProvider(42, third: .42).name, 'familyProvider'); -// }); - -// test('Supports overriding non-family providers', () async { -// final container = createContainer( -// overrides: [ -// publicProvider.overrideWith((ref) => Stream.value('Hello world')), -// ], -// ); - -// final result = container.read(publicProvider.future); -// expect(await result, 'Hello world'); -// }); - -// test('Supports overriding family providers', () async { -// final container = createContainer( -// overrides: [ -// familyProvider(42, third: .42).overrideWith( -// (ref) => Stream.value( -// 'Hello world ${ref.first} ${ref.second} ' -// '${ref.third} ${ref.fourth} ${ref.fifth}', -// ), -// ), -// ], -// ); - -// final result = container.read(familyProvider(42, third: .42).future); -// expect(await result, 'Hello world 42 null 0.42 true null'); -// }); - -// test( -// 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', -// () async { -// final container = createContainer(); - -// const FamilyFamily family = familyProvider; - -// expect(familyProvider(42, third: .42).from, familyProvider); - -// expect( -// familyProvider(42, third: .42), -// familyProvider(42, third: .42), -// ); -// expect( -// familyProvider(42, third: .42), -// isNot(familyProvider(42, third: .21)), -// ); -// expect( -// familyProvider(42, third: .42).hashCode, -// isNot(familyProvider(42, third: .21).hashCode), -// ); - -// // handle defaults -// expect( -// familyProvider(42, third: .42), -// familyProvider( -// 42, -// third: .42, -// ), -// ); -// expect( -// familyProvider(42, third: .42).hashCode, -// familyProvider( -// 42, -// third: .42, -// ).hashCode, -// ); - -// final FamilyProvider provider = familyProvider( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: ['x42'], -// ); -// final AutoDisposeStreamProvider futureProvider = provider; - -// expect(provider.first, 42); -// expect(provider.second, 'x42'); -// expect(provider.third, .42); -// expect(provider.fourth, false); -// expect(provider.fifth, ['x42']); - -// expect( -// await container -// .listen( -// familyProvider( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: ['x42'], -// ).future, -// (_, __) {}, -// ) -// .read(), -// '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', -// ); -// }); - -// test('can override providers', () { -// final container = createContainer( -// overrides: [ -// publicProvider.overrideWith((ref) { -// ref.state = const AsyncData('test'); -// return const Stream.empty(); -// }), -// publicClassProvider.overrideWith(() => PublicClass(42)), -// familyProvider.overrideWith( -// (ref) { -// ref.state = AsyncData( -// 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})', -// ); -// return const Stream.empty(); -// }, -// ), -// familyClassProvider.overrideWith(() => FamilyClass(42)), -// ], -// ); - -// expect(container.read(publicProvider).requireValue, 'test'); -// expect(container.read(publicClassProvider.notifier).param, 42); -// expect( -// container.read(familyProvider(42, second: '42', third: .42)).requireValue, -// 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', -// ); -// expect( -// container -// .read(familyClassProvider(42, second: '42', third: .42).notifier) -// .param, -// 42, -// ); -// }); -// } +// ignore_for_file: omit_local_variable_types, unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:test/test.dart'; + +import 'integration/stream.dart'; +import 'utils.dart'; + +void main() { + test('Creates a StreamProvider if @riverpod is used on a Stream function', + () async { + final container = createContainer(); + + final AutoDisposeStreamProvider provider = publicProvider; + + expect( + await container.listen(publicProvider.future, (_, __) {}).read(), + 'Hello world', + ); + }); + + test('Generates .name for providers', () { + expect(publicProvider.name, 'publicProvider'); + expect(privateProvider.name, '_privateProvider'); + + expect(familyProvider.name, 'familyProvider'); + expect(familyProvider(42, third: .42).name, 'familyProvider'); + }); + + test('Supports overriding non-family providers', () async { + final container = createContainer( + overrides: [ + publicProvider.overrideWith((ref) => Stream.value('Hello world')), + ], + ); + + final result = container.read(publicProvider.future); + expect(await result, 'Hello world'); + }); + + test('Supports overriding family providers', () async { + final container = createContainer( + overrides: [ + familyProvider(42, third: .42).overrideWith( + (ref) => Stream.value( + 'Hello world ${ref.first} ${ref.second} ' + '${ref.third} ${ref.fourth} ${ref.fifth}', + ), + ), + ], + ); + + final result = container.read(familyProvider(42, third: .42).future); + expect(await result, 'Hello world 42 null 0.42 true null'); + }); + + test( + 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', + () async { + final container = createContainer(); + + const FamilyFamily family = familyProvider; + + expect(familyProvider(42, third: .42).from, familyProvider); + + expect( + familyProvider(42, third: .42), + familyProvider(42, third: .42), + ); + expect( + familyProvider(42, third: .42), + isNot(familyProvider(42, third: .21)), + ); + expect( + familyProvider(42, third: .42).hashCode, + isNot(familyProvider(42, third: .21).hashCode), + ); + + // handle defaults + expect( + familyProvider(42, third: .42), + familyProvider( + 42, + third: .42, + ), + ); + expect( + familyProvider(42, third: .42).hashCode, + familyProvider( + 42, + third: .42, + ).hashCode, + ); + + final FamilyProvider provider = familyProvider( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: ['x42'], + ); + final AutoDisposeStreamProvider futureProvider = provider; + + expect(provider.first, 42); + expect(provider.second, 'x42'); + expect(provider.third, .42); + expect(provider.fourth, false); + expect(provider.fifth, ['x42']); + + expect( + await container + .listen( + familyProvider( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: ['x42'], + ).future, + (_, __) {}, + ) + .read(), + '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', + ); + }); + + test('can override providers', () { + final container = createContainer( + overrides: [ + publicProvider.overrideWith((ref) { + ref.state = const AsyncData('test'); + return const Stream.empty(); + }), + publicClassProvider.overrideWith(() => PublicClass(42)), + familyProvider.overrideWith( + (ref) { + ref.state = AsyncData( + 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})', + ); + return const Stream.empty(); + }, + ), + familyClassProvider.overrideWith(() => FamilyClass(42)), + ], + ); + + expect(container.read(publicProvider).requireValue, 'test'); + expect(container.read(publicClassProvider.notifier).param, 42); + expect( + container.read(familyProvider(42, second: '42', third: .42)).requireValue, + 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', + ); + expect( + container + .read(familyClassProvider(42, second: '42', third: .42).notifier) + .param, + 42, + ); + }); +} diff --git a/packages/riverpod_generator/test/sync_test.dart b/packages/riverpod_generator/test/sync_test.dart index 395ce6e4d..e958227cc 100644 --- a/packages/riverpod_generator/test/sync_test.dart +++ b/packages/riverpod_generator/test/sync_test.dart @@ -1,323 +1,318 @@ -// // ignore_for_file: omit_local_variable_types, unused_local_variable, require_trailing_commas - -// import 'package:riverpod_annotation/riverpod_annotation.dart'; -// import 'package:test/test.dart'; - -// import 'integration/sync.dart'; -// import 'utils.dart'; - -// void main() { -// // TODO test that the generated providers contain the docs from the annotated element - -// group('Supports generics', () { -// test('checks generics in hashCode', () { -// expect( -// genericProvider().hashCode, -// genericProvider().hashCode, -// ); -// expect( -// genericProvider().hashCode, -// isNot(genericProvider().hashCode), -// ); -// expect( -// genericProvider().hashCode, -// isNot(genericProvider().hashCode), -// ); -// expect( -// genericProvider().hashCode, -// isNot(genericProvider().hashCode), -// ); -// expect( -// genericProvider().hashCode, -// genericProvider().hashCode, -// ); -// }); - -// test('checks generics in ==', () { -// expect( -// genericProvider(), -// genericProvider(), -// ); -// expect( -// genericProvider(), -// isNot(genericProvider()), -// ); -// expect( -// genericProvider(), -// isNot(genericProvider()), -// ); -// expect( -// genericProvider(), -// isNot(genericProvider()), -// ); -// expect( -// genericProvider(), -// genericProvider(), -// ); -// }); - -// test('in simple scenarios', () { -// final container = createContainer(); - -// expect( -// container.listen(genericProvider(), (p, n) {}).read(), -// [42], -// ); -// expect( -// container.listen(genericProvider(), (p, n) {}).read(), -// [3.14], -// ); -// expect( -// container.listen(genericProvider(), (p, n) {}).read(), -// [42, 3.14], -// ); -// }); -// }); - -// test('Supports Raw', () async { -// final container = createContainer(); - -// expect( -// container.read(rawFutureProvider), -// isA>(), -// ); -// expect( -// container.read(rawFutureClassProvider), -// isA>(), -// ); -// expect( -// container.read(rawFutureClassProvider.notifier), -// isA(), -// ); - -// expect( -// container.read(rawStreamProvider), -// isA>(), -// ); -// expect( -// container.read(rawStreamClassProvider), -// isA>(), -// ); -// expect( -// container.read(rawStreamClassProvider.notifier), -// isA(), -// ); - -// expect( -// container.read(rawFamilyFutureProvider(0)), -// isA>(), -// ); -// expect( -// container.read(rawFamilyFutureClassProvider(0)), -// isA>(), -// ); -// expect( -// container.read(rawFamilyFutureClassProvider(0).notifier), -// isA(), -// ); - -// expect( -// container.read(rawFamilyStreamProvider(0)), -// isA>(), -// ); -// expect( -// container.read(rawFamilyStreamClassProvider(0)), -// isA>(), -// ); -// expect( -// container.read(rawFamilyStreamClassProvider(0).notifier), -// isA(), -// ); -// }); - -// test('overrides toString', () { -// expect(publicProvider.toString(), 'publicProvider'); -// expect(familyProvider.toString(), 'familyProvider'); -// expect( -// familyProvider.call(42, second: 'foo', third: .3).toString(), -// 'familyProvider(42, fifth: null, fourth: true, second: foo, third: 0.3)', -// ); - -// expect( -// publicProvider.overrideWithValue('foo').toString(), -// 'publicProvider.overrideWithValue(foo)', -// ); -// expect( -// familyProvider.overrideWith((ref) => 'foo').toString(), -// 'familyProvider.overrideWith(...)', -// ); -// expect( -// familyProvider(42, second: 'foo', third: .3) -// .overrideWith((ref) => '') -// .toString(), -// 'familyProvider(42, fifth: null, fourth: true, second: foo, third: 0.3).overrideWith(...)', -// ); -// }); - -// test('Supports overriding non-family providers', () { -// final container = createContainer( -// overrides: [ -// publicProvider.overrideWith((ref) => 'Hello world'), -// ], -// ); - -// final result = container.read(publicProvider); -// expect(result, 'Hello world'); -// }); - -// test('Supports overriding family providers', () { -// final container = createContainer( -// overrides: [ -// familyProvider(42, third: .42).overrideWith( -// (ref) => 'Hello world ${ref.first} ${ref.second} ' -// '${ref.third} ${ref.fourth} ${ref.fifth}', -// ), -// ], -// ); - -// final result = container.read(familyProvider(42, third: .42)); -// expect(result, 'Hello world 42 null 0.42 true null'); -// }); - -// test( -// 'Creates a Provider if @riverpod is used on an stream function wrapped in Raw', -// () async { -// final container = createContainer(); - -// final AutoDisposeProvider> provider = rawStreamProvider; -// final Stream result = container.read(rawStreamProvider); - -// await expectLater(result, emits('Hello world')); -// }); - -// test('Creates a Provider if @riverpod is used on a synchronous function', -// () { -// final container = createContainer(); - -// final AutoDisposeProvider provider = publicProvider; -// final String result = container.read(publicProvider); - -// expect(result, 'Hello world'); -// }); - -// test('Generates .name for providers', () { -// expect(publicProvider.name, 'publicProvider'); -// expect(privateProvider.name, '_privateProvider'); - -// expect(familyProvider.name, 'familyProvider'); -// expect(familyProvider(42, third: .42).name, 'familyProvider'); -// }); - -// test( -// 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', -// () { -// final container = createContainer(); - -// const FamilyFamily family = familyProvider; - -// expect(familyProvider(42, third: .42).from, familyProvider); - -// expect( -// familyProvider(42, third: .42), -// familyProvider(42, third: .42), -// ); -// expect( -// familyProvider(42, third: .42), -// isNot(familyProvider(42, third: .21)), -// ); -// expect( -// familyProvider(42, third: .42).hashCode, -// isNot(familyProvider(42, third: .21).hashCode), -// ); - -// // handle defaults -// expect( -// familyProvider(42, third: .42), -// familyProvider( -// 42, -// third: .42, -// ), -// ); -// expect( -// familyProvider(42, third: .42).hashCode, -// familyProvider( -// 42, -// third: .42, -// ).hashCode, -// ); - -// final FamilyProvider provider = familyProvider( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: const ['x42'], -// ); -// final AutoDisposeProvider futureProvider = provider; - -// expect(provider.first, 42); -// expect(provider.second, 'x42'); -// expect(provider.third, .42); -// expect(provider.fourth, false); -// expect(provider.fifth, ['x42']); - -// final ( -// int, { -// String? second, -// double third, -// bool fourth, -// List? fifth, -// }) argument = provider.argument; - -// expect( -// argument, -// ( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: const ['x42'], -// ), -// ); - -// final String result = container.read( -// familyProvider( -// 42, -// second: 'x42', -// third: .42, -// fourth: false, -// fifth: ['x42'], -// ), -// ); - -// expect( -// result, -// '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', -// ); -// }); - -// test('can override providers', () { -// final container = createContainer(overrides: [ -// publicProvider.overrideWith((ref) => 'test'), -// publicClassProvider.overrideWith(() => PublicClass(42)), -// familyProvider.overrideWith( -// (ref) => -// 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})', -// ), -// familyClassProvider.overrideWith(() => FamilyClass(42)), -// ]); - -// expect(container.read(publicProvider), 'test'); -// expect(container.read(publicClassProvider.notifier).param, 42); -// expect( -// container.read(familyProvider(42, second: '42', third: .42)), -// 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', -// ); -// expect( -// container -// .read(familyClassProvider(42, second: '42', third: .42).notifier) -// .param, -// 42, -// ); -// }); -// } +// ignore_for_file: omit_local_variable_types, unused_local_variable, require_trailing_commas + +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +import 'integration/sync.dart'; +import 'utils.dart'; + +void main() { + // TODO test that the generated providers contain the docs from the annotated element + + group('Supports generics', () { + test('checks generics in hashCode', () { + expect( + genericProvider().hashCode, + genericProvider().hashCode, + ); + expect( + genericProvider().hashCode, + isNot(genericProvider().hashCode), + ); + expect( + genericProvider().hashCode, + isNot(genericProvider().hashCode), + ); + expect( + genericProvider().hashCode, + isNot(genericProvider().hashCode), + ); + expect( + genericProvider().hashCode, + genericProvider().hashCode, + ); + }); + + test('checks generics in ==', () { + expect( + genericProvider(), + genericProvider(), + ); + expect( + genericProvider(), + isNot(genericProvider()), + ); + expect( + genericProvider(), + isNot(genericProvider()), + ); + expect( + genericProvider(), + isNot(genericProvider()), + ); + expect( + genericProvider(), + genericProvider(), + ); + }); + + test('in simple scenarios', () { + final container = createContainer(); + + expect( + container.listen(genericProvider(), (p, n) {}).read(), + [42], + ); + expect( + container.listen(genericProvider(), (p, n) {}).read(), + [3.14], + ); + expect( + container.listen(genericProvider(), (p, n) {}).read(), + [42, 3.14], + ); + }); + }); + + test('Supports Raw', () async { + final container = createContainer(); + + expect( + container.read(rawFutureProvider), + isA>(), + ); + expect( + container.read(rawFutureClassProvider), + isA>(), + ); + expect( + container.read(rawFutureClassProvider.notifier), + isA(), + ); + + expect( + container.read(rawStreamProvider), + isA>(), + ); + expect( + container.read(rawStreamClassProvider), + isA>(), + ); + expect( + container.read(rawStreamClassProvider.notifier), + isA(), + ); + + expect( + container.read(rawFamilyFutureProvider(0)), + isA>(), + ); + expect( + container.read(rawFamilyFutureClassProvider(0)), + isA>(), + ); + expect( + container.read(rawFamilyFutureClassProvider(0).notifier), + isA(), + ); + + expect( + container.read(rawFamilyStreamProvider(0)), + isA>(), + ); + expect( + container.read(rawFamilyStreamClassProvider(0)), + isA>(), + ); + expect( + container.read(rawFamilyStreamClassProvider(0).notifier), + isA(), + ); + }); + + test('overrides toString', () { + expect(publicProvider.toString(), 'publicProvider'); + expect(familyProvider.toString(), 'familyProvider'); + expect( + familyProvider.call(42, second: 'foo', third: .3).toString(), + 'familyProvider(42, fifth: null, fourth: true, second: foo, third: 0.3)', + ); + + expect( + publicProvider.overrideWithValue('foo').toString(), + 'publicProvider.overrideWithValue(foo)', + ); + expect( + familyProvider.overrideWith((ref) => 'foo').toString(), + 'familyProvider.overrideWith(...)', + ); + expect( + familyProvider(42, second: 'foo', third: .3) + .overrideWith((ref) => '') + .toString(), + 'familyProvider(42, fifth: null, fourth: true, second: foo, third: 0.3).overrideWith(...)', + ); + }); + + test('Supports overriding non-family providers', () { + final container = createContainer( + overrides: [ + publicProvider.overrideWith((ref) => 'Hello world'), + ], + ); + + final result = container.read(publicProvider); + expect(result, 'Hello world'); + }); + + test('Supports overriding family providers', () { + final container = createContainer( + overrides: [ + familyProvider(42, third: .42).overrideWith( + (ref, args) => 'Hello world ${args.first} ${args.second} ' + '${args.third} ${args.fourth} ${args.fifth}', + ), + ], + ); + + final result = container.read(familyProvider(42, third: .42)); + expect(result, 'Hello world 42 null 0.42 true null'); + }); + + test( + 'Creates a Provider if @riverpod is used on an stream function wrapped in Raw', + () async { + final container = createContainer(); + + const ProviderBase> provider = rawStreamProvider; + final Stream result = container.read(rawStreamProvider); + + await expectLater(result, emits('Hello world')); + }); + + test('Creates a Provider if @riverpod is used on a synchronous function', + () { + final container = createContainer(); + + const ProviderBase provider = publicProvider; + final String result = container.read(publicProvider); + + expect(result, 'Hello world'); + }); + + test('Generates .name for providers', () { + expect(publicProvider.name, 'publicProvider'); + expect(privateProvider.name, '_privateProvider'); + + expect(familyProvider.name, 'familyProvider'); + expect(familyProvider(42, third: .42).name, 'familyProvider'); + }); + + test( + 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', + () { + final container = createContainer(); + + const FamilyFamily family = familyProvider; + + expect(familyProvider(42, third: .42).from, familyProvider); + + expect( + familyProvider(42, third: .42), + familyProvider(42, third: .42), + ); + expect( + familyProvider(42, third: .42), + isNot(familyProvider(42, third: .21)), + ); + expect( + familyProvider(42, third: .42).hashCode, + isNot(familyProvider(42, third: .21).hashCode), + ); + + // handle defaults + expect( + familyProvider(42, third: .42), + familyProvider( + 42, + third: .42, + ), + ); + expect( + familyProvider(42, third: .42).hashCode, + familyProvider( + 42, + third: .42, + ).hashCode, + ); + + final FamilyProvider provider = familyProvider( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: const ['x42'], + ); + + final ProviderBase futureProvider = provider; + + final argument = provider.argument! as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + + expect( + argument, + ( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: const ['x42'], + ), + ); + + final String result = container.read( + familyProvider( + 42, + second: 'x42', + third: .42, + fourth: false, + fifth: ['x42'], + ), + ); + + expect( + result, + '(first: 42, second: x42, third: 0.42, fourth: false, fifth: [x42])', + ); + }); + + test('can override providers', () { + final container = createContainer(overrides: [ + publicProvider.overrideWith((ref) => 'test'), + publicClassProvider.overrideWith(() => PublicClass(42)), + familyProvider.overrideWith( + (ref) => + 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})', + ), + familyClassProvider.overrideWith(() => FamilyClass(42)), + ]); + + expect(container.read(publicProvider), 'test'); + expect(container.read(publicClassProvider.notifier).param, 42); + expect( + container.read(familyProvider(42, second: '42', third: .42)), + 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', + ); + expect( + container + .read(familyClassProvider(42, second: '42', third: .42).notifier) + .param, + 42, + ); + }); +} From 2a9cab0c5d09c50979a28bdb2b4ea02004a61ce2 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 15:20:36 +0100 Subject: [PATCH 159/387] Fix raw --- packages/riverpod_generator/CHANGELOG.md | 13 +++ .../lib/src/templates/family.dart | 69 +++++++++++++- packages/riverpod_generator/lib/src/type.dart | 5 +- .../test/integration/async.g.dart | 4 +- .../test/integration/stream.g.dart | 4 +- .../test/integration/sync.g.dart | 90 +++++++++---------- .../riverpod_generator/test/sync_test.dart | 4 +- 7 files changed, 131 insertions(+), 58 deletions(-) diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index ef1858fc0..5265ab2aa 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -1,6 +1,19 @@ ## Unreleased build - **Breaking** Removed support for `@riverpod external int fn();`. +- **Breaking** Family arguments are no-longer available on the `Ref` object. + The various override methods now take two parameters: + + ```dart + @riverpod + String example(ExampleRef ref, int arg, {required int anotherArg}) {...} + // ... + exampleProvider.overrideWith( + (ref, ({int arg, int anotherArg}) args) { + + } + ) + ``` ## 3.0.0-dev.11 - 2023-11-27 diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 88e84af65..6d2420905 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -20,6 +20,8 @@ class FamilyTemplate extends Template { void run(StringBuffer buffer) { if (!provider.providerElement.isFamily) return; + final topLevelBuffer = StringBuffer(); + // TODO add docs everywhere in generated code final generics = provider.generics(); @@ -46,7 +48,7 @@ final class ${provider.familyTypeName} extends Family { ); ${provider.providerTypeName}$generics call$genericsDefinition($parameterDefinition) - => ${provider.providerTypeName}._( + => ${provider.providerTypeName}$generics._( $argument from: this ); @@ -56,6 +58,71 @@ final class ${provider.familyTypeName} extends Family { @override String toString() => r'${provider.name}'; +'''); + + // _writeOverrides( + // buffer, + // topLevelBuffer: topLevelBuffer, + // ); + + buffer.writeln('}'); + + buffer.write(topLevelBuffer); + } + + void _writeOverrides( + StringBuffer buffer, { + required StringBuffer topLevelBuffer, + }) { + // overrideWith + _writeOverrideWith(buffer, topLevelBuffer: topLevelBuffer); + + // overrideWithBuild + final provider = this.provider; + if (provider is ClassBasedProviderDeclaration) { + _writeOverrideWithBuild( + buffer, + provider, + topLevelBuffer: topLevelBuffer, + ); + } + } + + void _writeOverrideWith( + StringBuffer buffer, { + required StringBuffer topLevelBuffer, + }) { + late final argumentsType = + '(${buildParamDefinitionQuery(provider.parameters, asRecord: true)})'; + + final createType = switch (provider) { + FunctionalProviderDeclaration(parameters: [_, ...]) => + '${provider.createdTypeDisplayString} Function${provider.genericsDefinition()}(${provider.refImplName} ref, $argumentsType args)', + FunctionalProviderDeclaration(parameters: []) => + '${provider.createdTypeDisplayString} Function${provider.genericsDefinition()}(${provider.refImplName} ref)', + ClassBasedProviderDeclaration(parameters: [_, ...]) => + '${provider.createdTypeDisplayString} Function${provider.genericsDefinition()}(${provider.refImplName} ref, $argumentsType args)', + ClassBasedProviderDeclaration() => + '${provider.createdTypeDisplayString} Function${provider.genericsDefinition()}(${provider.refImplName} re)', + }; + + // TODO docs + buffer.writeln(''' +Override overrideWith($createType create,) { + +} +'''); + } + + void _writeOverrideWithBuild( + StringBuffer buffer, + ClassBasedProviderDeclaration provider, { + required StringBuffer topLevelBuffer, + }) { + // TODO docs + buffer.writeln(''' +Override overrideWithBuild() { + } '''); } diff --git a/packages/riverpod_generator/lib/src/type.dart b/packages/riverpod_generator/lib/src/type.dart index 59606851f..1883c4d61 100644 --- a/packages/riverpod_generator/lib/src/type.dart +++ b/packages/riverpod_generator/lib/src/type.dart @@ -5,9 +5,10 @@ extension SwitchCreatedType on GeneratorProviderDeclaration { final dartType = createdTypeNode?.type; switch (dartType) { case != null - when dartType.isDartAsyncFutureOr || dartType.isDartAsyncFuture: + when !dartType.isRaw && + (dartType.isDartAsyncFutureOr || dartType.isDartAsyncFuture): return SupportedCreatedType.future; - case != null when dartType.isDartAsyncStream: + case != null when !dartType.isRaw && dartType.isDartAsyncStream: return SupportedCreatedType.stream; case _: return SupportedCreatedType.value; diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 707b4ce0d..329c02a38 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -75,7 +75,7 @@ final class GenericFamily extends Family { isAutoDispose: true, ); - GenericProvider call() => GenericProvider._(from: this); + GenericProvider call() => GenericProvider._(from: this); @override String debugGetCreateSourceHash() => _$genericHash(); @@ -489,7 +489,7 @@ final class GenericClassFamily extends Family { ); GenericClassProvider call() => - GenericClassProvider._(from: this); + GenericClassProvider._(from: this); @override String debugGetCreateSourceHash() => _$genericClassHash(); diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index f1f4489c9..64a9768d3 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -75,7 +75,7 @@ final class GenericFamily extends Family { isAutoDispose: true, ); - GenericProvider call() => GenericProvider._(from: this); + GenericProvider call() => GenericProvider._(from: this); @override String debugGetCreateSourceHash() => _$genericHash(); @@ -400,7 +400,7 @@ final class GenericClassFamily extends Family { ); GenericClassProvider call() => - GenericClassProvider._(from: this); + GenericClassProvider._(from: this); @override String debugGetCreateSourceHash() => _$genericClassHash(); diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index fdbbfa155..f4701a983 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -75,7 +75,7 @@ final class GenericFamily extends Family { isAutoDispose: true, ); - GenericProvider call() => GenericProvider._(from: this); + GenericProvider call() => GenericProvider._(from: this); @override String debugGetCreateSourceHash() => _$genericHash(); @@ -184,7 +184,7 @@ final class ComplexGenericFamily extends Family { required T param, Foo? otherParam, }) => - ComplexGenericProvider._(argument: ( + ComplexGenericProvider._(argument: ( param: param, otherParam: otherParam, ), from: this); @@ -200,11 +200,10 @@ typedef RawFutureRef = Ref>>; const rawFutureProvider = RawFutureProvider._(); -final class RawFutureProvider extends $FunctionalProvider>, - Raw>, RawFutureRef> - with - $FutureModifier>>, - $FutureProvider>, RawFutureRef> { +final class RawFutureProvider extends $FunctionalProvider< + Raw>, + Raw>, + RawFutureRef> with $Provider>, RawFutureRef> { const RawFutureProvider._( {Raw> Function( RawFutureRef ref, @@ -227,9 +226,9 @@ final class RawFutureProvider extends $FunctionalProvider>, String debugGetCreateSourceHash() => _$rawFutureHash(); @override - $FutureProviderElement>> createElement( + $ProviderElement>> createElement( ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderElement(this, container); @override Raw> create(RawFutureRef ref) { @@ -256,11 +255,10 @@ typedef RawStreamRef = Ref>>; const rawStreamProvider = RawStreamProvider._(); -final class RawStreamProvider extends $FunctionalProvider>, - Raw>, RawStreamRef> - with - $FutureModifier>>, - $StreamProvider>, RawStreamRef> { +final class RawStreamProvider extends $FunctionalProvider< + Raw>, + Raw>, + RawStreamRef> with $Provider>, RawStreamRef> { const RawStreamProvider._( {Raw> Function( RawStreamRef ref, @@ -283,9 +281,9 @@ final class RawStreamProvider extends $FunctionalProvider>, String debugGetCreateSourceHash() => _$rawStreamHash(); @override - $StreamProviderElement>> createElement( + $ProviderElement>> createElement( ProviderContainer container) => - $StreamProviderElement(this, container); + $ProviderElement(this, container); @override Raw> create(RawStreamRef ref) { @@ -314,9 +312,7 @@ const rawFamilyFutureProvider = RawFamilyFutureFamily._(); final class RawFamilyFutureProvider extends $FunctionalProvider< Raw>, Raw>, RawFamilyFutureRef> - with - $FutureModifier>>, - $FutureProvider>, RawFamilyFutureRef> { + with $Provider>, RawFamilyFutureRef> { const RawFamilyFutureProvider._( {required RawFamilyFutureFamily super.from, required (int,) super.argument, @@ -341,9 +337,9 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< String debugGetCreateSourceHash() => _$rawFamilyFutureHash(); @override - $FutureProviderElement>> createElement( + $ProviderElement>> createElement( ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderElement(this, container); @override Raw> create(RawFamilyFutureRef ref) { @@ -406,9 +402,7 @@ const rawFamilyStreamProvider = RawFamilyStreamFamily._(); final class RawFamilyStreamProvider extends $FunctionalProvider< Raw>, Raw>, RawFamilyStreamRef> - with - $FutureModifier>>, - $StreamProvider>, RawFamilyStreamRef> { + with $Provider>, RawFamilyStreamRef> { const RawFamilyStreamProvider._( {required RawFamilyStreamFamily super.from, required (int,) super.argument, @@ -433,9 +427,9 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< String debugGetCreateSourceHash() => _$rawFamilyStreamHash(); @override - $StreamProviderElement>> createElement( + $ProviderElement>> createElement( ProviderContainer container) => - $StreamProviderElement(this, container); + $ProviderElement(this, container); @override Raw> create(RawFamilyStreamRef ref) { @@ -914,7 +908,7 @@ final class GenericClassFamily extends Family { ); GenericClassProvider call() => - GenericClassProvider._(from: this); + GenericClassProvider._(from: this); @override String debugGetCreateSourceHash() => _$genericClassHash(); @@ -934,7 +928,7 @@ abstract class _$GenericClass extends $Notifier> { const rawFutureClassProvider = RawFutureClassProvider._(); final class RawFutureClassProvider - extends $AsyncNotifierProvider>> { + extends $NotifierProvider>> { const RawFutureClassProvider._( {super.runNotifierBuildOverride, RawFutureClass Function()? create}) : _createCb = create, @@ -975,14 +969,14 @@ final class RawFutureClassProvider @$internal @override - $AsyncNotifierProviderElement>> - createElement(ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $NotifierProviderElement>> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } String _$rawFutureClassHash() => r'bf66f1cdbd99118b8845d206e6a2611b3101f45c'; -abstract class _$RawFutureClass extends $AsyncNotifier>> { +abstract class _$RawFutureClass extends $Notifier>> { Raw> build(); @$internal @@ -993,7 +987,7 @@ abstract class _$RawFutureClass extends $AsyncNotifier>> { const rawStreamClassProvider = RawStreamClassProvider._(); final class RawStreamClassProvider - extends $StreamNotifierProvider>> { + extends $NotifierProvider>> { const RawStreamClassProvider._( {super.runNotifierBuildOverride, RawStreamClass Function()? create}) : _createCb = create, @@ -1034,14 +1028,14 @@ final class RawStreamClassProvider @$internal @override - $StreamNotifierProviderElement>> - createElement(ProviderContainer container) => - $StreamNotifierProviderElement(this, container); + $NotifierProviderElement>> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } String _$rawStreamClassHash() => r'712cffcb2018cfb4ff45012c1aa6e43c8cbe9d5d'; -abstract class _$RawStreamClass extends $StreamNotifier>> { +abstract class _$RawStreamClass extends $Notifier>> { Raw> build(); @$internal @@ -1052,7 +1046,7 @@ abstract class _$RawStreamClass extends $StreamNotifier>> { const rawFamilyFutureClassProvider = RawFamilyFutureClassFamily._(); final class RawFamilyFutureClassProvider - extends $AsyncNotifierProvider>> { + extends $NotifierProvider>> { const RawFamilyFutureClassProvider._( {required RawFamilyFutureClassFamily super.from, required (int,) super.argument, @@ -1100,9 +1094,9 @@ final class RawFamilyFutureClassProvider @$internal @override - $AsyncNotifierProviderElement>> + $NotifierProviderElement>> createElement(ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $NotifierProviderElement(this, container); @override bool operator ==(Object other) { @@ -1134,10 +1128,9 @@ final class RawFamilyFutureClassFamily extends Family { String toString() => r'RawFamilyFutureClass'; } -abstract class _$RawFamilyFutureClass - extends $AsyncNotifier>> { +abstract class _$RawFamilyFutureClass extends $Notifier>> { late final _$args = - (ref as $AsyncNotifierProviderElement).origin.argument as (int,); + (ref as $NotifierProviderElement).origin.argument as (int,); int get id => _$args.$1; Raw> build( @@ -1154,7 +1147,7 @@ abstract class _$RawFamilyFutureClass const rawFamilyStreamClassProvider = RawFamilyStreamClassFamily._(); final class RawFamilyStreamClassProvider - extends $StreamNotifierProvider>> { + extends $NotifierProvider>> { const RawFamilyStreamClassProvider._( {required RawFamilyStreamClassFamily super.from, required (int,) super.argument, @@ -1202,9 +1195,9 @@ final class RawFamilyStreamClassProvider @$internal @override - $StreamNotifierProviderElement>> + $NotifierProviderElement>> createElement(ProviderContainer container) => - $StreamNotifierProviderElement(this, container); + $NotifierProviderElement(this, container); @override bool operator ==(Object other) { @@ -1236,10 +1229,9 @@ final class RawFamilyStreamClassFamily extends Family { String toString() => r'RawFamilyStreamClass'; } -abstract class _$RawFamilyStreamClass - extends $StreamNotifier>> { +abstract class _$RawFamilyStreamClass extends $Notifier>> { late final _$args = - (ref as $StreamNotifierProviderElement).origin.argument as (int,); + (ref as $NotifierProviderElement).origin.argument as (int,); int get id => _$args.$1; Raw> build( diff --git a/packages/riverpod_generator/test/sync_test.dart b/packages/riverpod_generator/test/sync_test.dart index e958227cc..388995bd4 100644 --- a/packages/riverpod_generator/test/sync_test.dart +++ b/packages/riverpod_generator/test/sync_test.dart @@ -296,8 +296,8 @@ void main() { publicProvider.overrideWith((ref) => 'test'), publicClassProvider.overrideWith(() => PublicClass(42)), familyProvider.overrideWith( - (ref) => - 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})', + (ref, args) => + 'test (first: ${args.first}, second: ${args.second}, third: ${args.third}, fourth: ${args.fourth}, fifth: ${args.fifth})', ), familyClassProvider.overrideWith(() => FamilyClass(42)), ]); From 5bb464e3e73fca311ac1976a4cf7657f0d122563 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 15:32:49 +0100 Subject: [PATCH 160/387] W --- .../lib/src/riverpod_element.dart | 3 +- .../integration/build_yaml/lib/main.g.dart | 48 +++++++++++ .../lib/src/riverpod_generator.dart | 15 +++- .../lib/src/templates/family.dart | 25 +++--- .../test/integration/annotated.g.dart | 14 ++++ .../test/integration/async.g.dart | 55 +++++++++++++ .../test/integration/dependencies.g.dart | 25 ++++++ .../test/integration/dependencies2.g.dart | 20 +++++ .../test/integration/generated.g.dart | 55 +++++++++++++ .../test/integration/stream.g.dart | 38 +++++++++ .../test/integration/sync.g.dart | 80 +++++++++++++++++++ 11 files changed, 367 insertions(+), 11 deletions(-) diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart index 7d3ff264e..62408ad9d 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart @@ -256,7 +256,8 @@ class LegacyFamilyInvocationElement { final DartType parameterType; } -abstract class GeneratorProviderDeclarationElement +// TODO changelog made sealed +sealed class GeneratorProviderDeclarationElement implements ProviderDeclarationElement { RiverpodAnnotationElement get annotation; diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 64974141c..56895202d 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -250,6 +250,13 @@ final class Count2Family extends Family { @override String toString() => r'count2'; + + Override overrideWith( + int Function( + Count2Ref ref, + (int,) args, + ) create, + ) {} } typedef CountFuture2Ref = Ref>; @@ -339,6 +346,13 @@ final class CountFuture2Family extends Family { @override String toString() => r'countFuture2'; + + Override overrideWith( + FutureOr Function( + CountFuture2Ref ref, + (int,) args, + ) create, + ) {} } typedef CountStream2Ref = Ref>; @@ -428,6 +442,13 @@ final class CountStream2Family extends Family { @override String toString() => r'countStream2'; + + Override overrideWith( + Stream Function( + CountStream2Ref ref, + (int,) args, + ) create, + ) {} } const countNotifierPod = CountNotifierProvider._(); @@ -687,6 +708,15 @@ final class CountNotifier2Family extends Family { @override String toString() => r'CountNotifier2'; + + Override overrideWith( + int Function( + Ref ref, + (int,) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$CountNotifier2 extends $Notifier { @@ -787,6 +817,15 @@ final class CountAsyncNotifier2Family extends Family { @override String toString() => r'CountAsyncNotifier2'; + + Override overrideWith( + FutureOr Function( + Ref> ref, + (int,) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$CountAsyncNotifier2 extends $AsyncNotifier { @@ -887,6 +926,15 @@ final class CountStreamNotifier2Family extends Family { @override String toString() => r'CountStreamNotifier2'; + + Override overrideWith( + Stream Function( + Ref> ref, + (int,) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$CountStreamNotifier2 extends $StreamNotifier { diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index c4b51c860..012acdc92 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -214,7 +214,11 @@ extension ProviderElementNames on GeneratorProviderDeclarationElement { } String get providerTypeName => '${name.titled}Provider'; - String get refImplName => '${name.titled}Ref'; + String get refImplName => switch (this) { + ClassBasedProviderDeclarationElement() => 'Ref', + FunctionalProviderDeclarationElement() => '${name.titled}Ref' + }; + String get familyTypeName => '${name.titled}Family'; String dependencies(BuildYamlOptions options) { @@ -264,6 +268,15 @@ extension ProviderNames on GeneratorProviderDeclaration { String get providerTypeName => providerElement.providerTypeName; String get refImplName => providerElement.refImplName; + String get refWithGenerics { + switch (this) { + case FunctionalProviderDeclaration(): + return '${providerElement.refImplName}${generics()}'; + case ClassBasedProviderDeclaration(): + return '${providerElement.refImplName}<$exposedTypeDisplayString>'; + } + } + String get familyTypeName => providerElement.familyTypeName; // TODO possibly no-longer needed diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 6d2420905..3cf38e2de 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -60,10 +60,11 @@ final class ${provider.familyTypeName} extends Family { String toString() => r'${provider.name}'; '''); - // _writeOverrides( - // buffer, - // topLevelBuffer: topLevelBuffer, - // ); + _writeOverrides( + buffer, + topLevelBuffer: topLevelBuffer, + genericsDefinition: genericsDefinition, + ); buffer.writeln('}'); @@ -73,9 +74,14 @@ final class ${provider.familyTypeName} extends Family { void _writeOverrides( StringBuffer buffer, { required StringBuffer topLevelBuffer, + required String genericsDefinition, }) { // overrideWith - _writeOverrideWith(buffer, topLevelBuffer: topLevelBuffer); + _writeOverrideWith( + buffer, + topLevelBuffer: topLevelBuffer, + genericsDefinition: genericsDefinition, + ); // overrideWithBuild final provider = this.provider; @@ -91,19 +97,20 @@ final class ${provider.familyTypeName} extends Family { void _writeOverrideWith( StringBuffer buffer, { required StringBuffer topLevelBuffer, + required String genericsDefinition, }) { late final argumentsType = '(${buildParamDefinitionQuery(provider.parameters, asRecord: true)})'; final createType = switch (provider) { FunctionalProviderDeclaration(parameters: [_, ...]) => - '${provider.createdTypeDisplayString} Function${provider.genericsDefinition()}(${provider.refImplName} ref, $argumentsType args)', + '${provider.createdTypeDisplayString} Function$genericsDefinition(${provider.refWithGenerics} ref, $argumentsType args,)', FunctionalProviderDeclaration(parameters: []) => - '${provider.createdTypeDisplayString} Function${provider.genericsDefinition()}(${provider.refImplName} ref)', + '${provider.createdTypeDisplayString} Function$genericsDefinition(${provider.refWithGenerics} ref)', ClassBasedProviderDeclaration(parameters: [_, ...]) => - '${provider.createdTypeDisplayString} Function${provider.genericsDefinition()}(${provider.refImplName} ref, $argumentsType args)', + '${provider.createdTypeDisplayString} Function$genericsDefinition(${provider.refWithGenerics} ref, $argumentsType args,)', ClassBasedProviderDeclaration() => - '${provider.createdTypeDisplayString} Function${provider.genericsDefinition()}(${provider.refImplName} re)', + '${provider.createdTypeDisplayString} Function$genericsDefinition(${provider.refWithGenerics} re)', }; // TODO docs diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 8dbe1bf7c..94d0bdc31 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -146,6 +146,13 @@ final class FamilyFamily extends Family { @override String toString() => r'family'; + + Override overrideWith( + String Function( + FamilyRef ref, + (int,) args, + ) create, + ) {} } typedef NotCopiedFunctionalRef = Ref; @@ -289,6 +296,13 @@ final class NotCopiedFamilyFamily extends Family { @override String toString() => r'notCopiedFamily'; + + Override overrideWith( + String Function( + NotCopiedFamilyRef ref, + (int,) args, + ) create, + ) {} } const classBasedProvider = ClassBasedProvider._(); diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 329c02a38..360debc53 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -82,6 +82,10 @@ final class GenericFamily extends Family { @override String toString() => r'generic'; + + Override overrideWith( + FutureOr> Function(GenericRef ref) create, + ) {} } typedef PublicRef = Ref>; @@ -277,6 +281,13 @@ final class FamilyOrFamily extends Family { @override String toString() => r'familyOr'; + + Override overrideWith( + FutureOr Function( + FamilyOrRef ref, + (int,) args, + ) create, + ) {} } typedef FamilyRef = Ref>; @@ -417,6 +428,19 @@ final class FamilyFamily extends Family { @override String toString() => r'family'; + + Override overrideWith( + FutureOr Function( + FamilyRef ref, + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) args, + ) create, + ) {} } const genericClassProvider = GenericClassFamily._(); @@ -496,6 +520,13 @@ final class GenericClassFamily extends Family { @override String toString() => r'GenericClass'; + + Override overrideWith( + FutureOr> Function(Ref>> re) + create, + ) {} + + Override overrideWithBuild() {} } abstract class _$GenericClass extends $AsyncNotifier> { @@ -703,6 +734,15 @@ final class FamilyOrClassFamily extends Family { @override String toString() => r'FamilyOrClass'; + + Override overrideWith( + FutureOr Function( + Ref> ref, + (int,) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$FamilyOrClass extends $AsyncNotifier { @@ -831,6 +871,21 @@ final class FamilyClassFamily extends Family { @override String toString() => r'FamilyClass'; + + Override overrideWith( + FutureOr Function( + Ref> ref, + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$FamilyClass extends $AsyncNotifier { diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 1cb8c42bc..f2ab18d62 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -144,6 +144,13 @@ final class FamilyFamily extends Family { @override String toString() => r'family'; + + Override overrideWith( + int Function( + FamilyRef ref, + (int,) args, + ) create, + ) {} } typedef ProviderRef = Ref; @@ -978,6 +985,15 @@ final class Family2Family extends Family { @override String toString() => r'Family2'; + + Override overrideWith( + int Function( + Ref ref, + (int,) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$Family2 extends $Notifier { @@ -1163,6 +1179,15 @@ final class Provider4Family extends Family { @override String toString() => r'Provider4'; + + Override overrideWith( + int Function( + Ref ref, + (int,) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$Provider4 extends $Notifier { diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 4bafc60ca..e64062134 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -194,6 +194,15 @@ final class FamilyWithDependencies2Family extends Family { @override String toString() => r'familyWithDependencies2'; + + Override overrideWith( + int Function( + FamilyWithDependencies2Ref ref, + ({ + int? id, + }) args, + ) create, + ) {} } typedef _Private2Ref = Ref; @@ -490,6 +499,17 @@ final class NotifierFamilyWithDependenciesFamily extends Family { @override String toString() => r'NotifierFamilyWithDependencies'; + + Override overrideWith( + int Function( + Ref ref, + ({ + int? id, + }) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$NotifierFamilyWithDependencies extends $Notifier { diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index a7098865b..1610f4984 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -146,6 +146,13 @@ final class GeneratedFamilyFamily extends Family { @override String toString() => r'generatedFamily'; + + Override overrideWith( + _Test Function( + GeneratedFamilyRef ref, + (_Test,) args, + ) create, + ) {} } typedef $DynamicRef = Ref; @@ -288,6 +295,13 @@ final class $DynamicFamilyFamily extends Family { @override String toString() => r'$dynamicFamily'; + + Override overrideWith( + Object? Function( + $DynamicFamilyRef ref, + (dynamic,) args, + ) create, + ) {} } typedef _DynamicRef = Ref; @@ -377,6 +391,13 @@ final class _DynamicFamily extends Family { @override String toString() => r'_dynamic'; + + Override overrideWith( + Object? Function( + _DynamicRef ref, + (dynamic,) args, + ) create, + ) {} } typedef AliasRef = Ref>; @@ -523,6 +544,13 @@ final class AliasFamilyFamily extends Family { @override String toString() => r'aliasFamily'; + + Override overrideWith( + r.AsyncValue Function( + AliasFamilyRef ref, + (r.AsyncValue,) args, + ) create, + ) {} } const generatedClassProvider = GeneratedClassProvider._(); @@ -665,6 +693,15 @@ final class GeneratedClassFamilyFamily extends Family { @override String toString() => r'GeneratedClassFamily'; + + Override overrideWith( + _Test Function( + Ref<_Test> ref, + (_Test,) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$GeneratedClassFamily extends $Notifier<_Test> { @@ -823,6 +860,15 @@ final class $DynamicClassFamilyFamily extends Family { @override String toString() => r'$DynamicClassFamily'; + + Override overrideWith( + Object? Function( + Ref ref, + (dynamic,) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$$DynamicClassFamily extends $Notifier { @@ -980,6 +1026,15 @@ final class AliasClassFamilyFamily extends Family { @override String toString() => r'AliasClassFamily'; + + Override overrideWith( + r.AsyncValue Function( + Ref> ref, + (r.AsyncValue,) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$AliasClassFamily extends $Notifier> { diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 64a9768d3..4870ac64d 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -82,6 +82,10 @@ final class GenericFamily extends Family { @override String toString() => r'generic'; + + Override overrideWith( + Stream> Function(GenericRef ref) create, + ) {} } typedef PublicRef = Ref>; @@ -328,6 +332,19 @@ final class FamilyFamily extends Family { @override String toString() => r'family'; + + Override overrideWith( + Stream Function( + FamilyRef ref, + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) args, + ) create, + ) {} } const genericClassProvider = GenericClassFamily._(); @@ -407,6 +424,12 @@ final class GenericClassFamily extends Family { @override String toString() => r'GenericClass'; + + Override overrideWith( + Stream> Function(Ref>> re) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$GenericClass extends $StreamNotifier> { @@ -643,6 +666,21 @@ final class FamilyClassFamily extends Family { @override String toString() => r'FamilyClass'; + + Override overrideWith( + Stream Function( + Ref> ref, + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$FamilyClass extends $StreamNotifier { diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index f4701a983..0940935b7 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -82,6 +82,10 @@ final class GenericFamily extends Family { @override String toString() => r'generic'; + + Override overrideWith( + List Function(GenericRef ref) create, + ) {} } typedef ComplexGenericRef = Ref>; @@ -194,6 +198,16 @@ final class ComplexGenericFamily extends Family { @override String toString() => r'complexGeneric'; + + Override overrideWith( + List Function( + ComplexGenericRef ref, + ({ + T param, + Foo? otherParam, + }) args, + ) create, + ) {} } typedef RawFutureRef = Ref>>; @@ -394,6 +408,13 @@ final class RawFamilyFutureFamily extends Family { @override String toString() => r'rawFamilyFuture'; + + Override overrideWith( + Raw> Function( + RawFamilyFutureRef ref, + (int,) args, + ) create, + ) {} } typedef RawFamilyStreamRef = Ref>>; @@ -484,6 +505,13 @@ final class RawFamilyStreamFamily extends Family { @override String toString() => r'rawFamilyStream'; + + Override overrideWith( + Raw> Function( + RawFamilyStreamRef ref, + (int,) args, + ) create, + ) {} } typedef PublicRef = Ref; @@ -730,6 +758,19 @@ final class FamilyFamily extends Family { @override String toString() => r'family'; + + Override overrideWith( + String Function( + FamilyRef ref, + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) args, + ) create, + ) {} } typedef _PrivateRef = Ref; @@ -915,6 +956,12 @@ final class GenericClassFamily extends Family { @override String toString() => r'GenericClass'; + + Override overrideWith( + List Function(Ref> re) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$GenericClass extends $Notifier> { @@ -1126,6 +1173,15 @@ final class RawFamilyFutureClassFamily extends Family { @override String toString() => r'RawFamilyFutureClass'; + + Override overrideWith( + Raw> Function( + Ref>> ref, + (int,) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$RawFamilyFutureClass extends $Notifier>> { @@ -1227,6 +1283,15 @@ final class RawFamilyStreamClassFamily extends Family { @override String toString() => r'RawFamilyStreamClass'; + + Override overrideWith( + Raw> Function( + Ref>> ref, + (int,) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$RawFamilyStreamClass extends $Notifier>> { @@ -1469,6 +1534,21 @@ final class FamilyClassFamily extends Family { @override String toString() => r'FamilyClass'; + + Override overrideWith( + String Function( + Ref ref, + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) args, + ) create, + ) {} + + Override overrideWithBuild() {} } abstract class _$FamilyClass extends $Notifier { From 96e3ecce3f696529b975838e82ab1a25f30aa7aa Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 15:33:15 +0100 Subject: [PATCH 161/387] W --- .../legacy/change_notifier_provider.dart | 2 +- packages/riverpod/lib/src/core/family.dart | 6 +- .../core/provider/functional_provider.dart | 4 +- .../src/core/provider/notifier_provider.dart | 8 +-- .../src/providers/async_notifier/family.dart | 4 +- .../src/providers/async_notifier/orphan.dart | 4 +- .../lib/src/providers/future_provider.dart | 2 +- .../legacy/state_notifier_provider.dart | 2 +- .../src/providers/legacy/state_provider.dart | 2 +- .../lib/src/providers/notifier/family.dart | 4 +- .../lib/src/providers/notifier/orphan.dart | 4 +- .../riverpod/lib/src/providers/provider.dart | 2 +- .../src/providers/stream_notifier/family.dart | 4 +- .../src/providers/stream_notifier/orphan.dart | 4 +- .../lib/src/providers/stream_provider.dart | 2 +- .../integration/build_yaml/lib/main.g.dart | 36 ++++++------ .../lib/src/templates/family_back.dart | 4 +- .../lib/src/templates/provider.dart | 6 +- .../test/integration/annotated.g.dart | 16 ++--- .../test/integration/async.g.dart | 30 +++++----- .../test/integration/auto_dispose.g.dart | 4 +- .../test/integration/dependencies.g.dart | 46 +++++++-------- .../test/integration/dependencies2.g.dart | 16 ++--- .../test/integration/generated.g.dart | 38 ++++++------ .../test/integration/hash/hash1.g.dart | 8 +-- .../test/integration/scopes.g.dart | 6 +- .../test/integration/split.g.dart | 4 +- .../test/integration/stream.g.dart | 24 ++++---- .../test/integration/sync.g.dart | 58 +++++++++---------- 29 files changed, 175 insertions(+), 175 deletions(-) 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 index b48026a07..aee9413aa 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -152,7 +152,7 @@ final class ChangeNotifierProvider @mustBeOverridden @visibleForOverriding @override - ChangeNotifierProvider copyWithCreate( + ChangeNotifierProvider $copyWithCreate( Create> create, ) { return ChangeNotifierProvider.internal( diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index 6df18a979..ce382bc0c 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -129,7 +129,7 @@ class FunctionalFamily< // provider as ProviderT; return provider - .copyWithCreate((ref) => create(ref, provider.argument as ArgT)) + .$copyWithCreate((ref) => create(ref, provider.argument as ArgT)) .createElement(container); }, ); @@ -199,7 +199,7 @@ class ClassFamily< // createElement: (container, provider) { provider as ProviderT; - return provider.copyWithCreate(create).createElement(container); + return provider.$copyWithCreate(create).createElement(container); }, ); } @@ -213,7 +213,7 @@ class ClassFamily< // createElement: (container, provider) { provider as ProviderT; - return provider.copyWithBuild(build).createElement(container); + return provider.$copyWithBuild(build).createElement(container); }, ); } diff --git a/packages/riverpod/lib/src/core/provider/functional_provider.dart b/packages/riverpod/lib/src/core/provider/functional_provider.dart index 2243f706b..7eec88140 100644 --- a/packages/riverpod/lib/src/core/provider/functional_provider.dart +++ b/packages/riverpod/lib/src/core/provider/functional_provider.dart @@ -19,7 +19,7 @@ abstract base class $FunctionalProvider< // }); @visibleForOverriding - $FunctionalProvider copyWithCreate( + $FunctionalProvider $copyWithCreate( Create create, ); @@ -60,7 +60,7 @@ abstract base class $FunctionalProvider< // Override overrideWith(Create create) { return $ProviderOverride( origin: this, - providerOverride: copyWithCreate(create), + providerOverride: $copyWithCreate(create), ); } } diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index 55f682d2f..f9188068e 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -111,12 +111,12 @@ abstract base class $ClassProvider< // NotifierT create(); @visibleForOverriding - $ClassProvider copyWithCreate( + $ClassProvider $copyWithCreate( NotifierT Function() create, ); @visibleForOverriding - $ClassProvider copyWithBuild( + $ClassProvider $copyWithBuild( RunNotifierBuild build, ); @@ -124,7 +124,7 @@ abstract base class $ClassProvider< // Override overrideWith(NotifierT Function() create) { return $ProviderOverride( origin: this, - providerOverride: copyWithCreate(create), + providerOverride: $copyWithCreate(create), ); } @@ -134,7 +134,7 @@ abstract base class $ClassProvider< // ) { return $ProviderOverride( origin: this, - providerOverride: copyWithBuild(build), + providerOverride: $copyWithBuild(build), ); } diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index 463eb5e66..6653a2a98 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -104,7 +104,7 @@ final class FamilyAsyncNotifierProvider< // @mustBeOverridden @visibleForOverriding @override - FamilyAsyncNotifierProvider copyWithBuild( + FamilyAsyncNotifierProvider $copyWithBuild( RunNotifierBuild, Ref>>? build, ) { @@ -114,7 +114,7 @@ final class FamilyAsyncNotifierProvider< // @mustBeOverridden @visibleForOverriding @override - FamilyAsyncNotifierProvider copyWithCreate( + FamilyAsyncNotifierProvider $copyWithCreate( NotifierT Function() create, ) { return _copyWith(create: create); diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index a53807293..188989791 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -143,7 +143,7 @@ final class AsyncNotifierProvider< // @mustBeOverridden @visibleForOverriding @override - AsyncNotifierProvider copyWithBuild( + AsyncNotifierProvider $copyWithBuild( RunNotifierBuild, Ref>>? build, ) { @@ -153,7 +153,7 @@ final class AsyncNotifierProvider< // @mustBeOverridden @visibleForOverriding @override - AsyncNotifierProvider copyWithCreate( + AsyncNotifierProvider $copyWithCreate( NotifierT Function() create, ) { return _copyWith(create: create); diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index fe5f71884..3e2463425 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -146,7 +146,7 @@ final class FutureProvider extends $FunctionalProvider< @mustBeOverridden @visibleForOverriding @override - FutureProvider copyWithCreate( + FutureProvider $copyWithCreate( Create, FutureProviderRef> create, ) { return FutureProvider.internal( diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index 0167fb196..51ca3d829 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -157,7 +157,7 @@ final class StateNotifierProvider< // @mustBeOverridden @visibleForOverriding @override - StateNotifierProvider copyWithCreate( + StateNotifierProvider $copyWithCreate( Create> create, ) { return StateNotifierProvider.internal( diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 80db39d5e..792a2acc3 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -103,7 +103,7 @@ final class StateProvider @mustBeOverridden @visibleForOverriding @override - StateProvider copyWithCreate( + StateProvider $copyWithCreate( Create> create, ) { return StateProvider.internal( diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index 4632c25ee..2a0114bdf 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -68,7 +68,7 @@ final class FamilyNotifierProvider // @override @mustBeOverridden @visibleForOverriding - FamilyNotifierProvider copyWithBuild( + FamilyNotifierProvider $copyWithBuild( RunNotifierBuild> build, ) { return _copyWith(build: build); @@ -77,7 +77,7 @@ final class FamilyNotifierProvider // @mustBeOverridden @visibleForOverriding @override - FamilyNotifierProvider copyWithCreate( + FamilyNotifierProvider $copyWithCreate( NotifierT Function() create, ) { return _copyWith(create: create); diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart index 407d69286..a87615857 100644 --- a/packages/riverpod/lib/src/providers/notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -158,7 +158,7 @@ final class NotifierProvider, StateT> @mustBeOverridden @visibleForOverriding @override - NotifierProvider copyWithBuild( + NotifierProvider $copyWithBuild( RunNotifierBuild>? build, ) { return _copyWith(build: build); @@ -167,7 +167,7 @@ final class NotifierProvider, StateT> @mustBeOverridden @visibleForOverriding @override - NotifierProvider copyWithCreate( + NotifierProvider $copyWithCreate( NotifierT Function() create, ) { return _copyWith(create: create); diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 07d18a765..3c9a688db 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -76,7 +76,7 @@ base class Provider @mustBeOverridden @visibleForOverriding @override - Provider copyWithCreate( + Provider $copyWithCreate( Create> create, ) { return Provider.internal( diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index a4ebc5f45..ea3f997c4 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -79,7 +79,7 @@ final class FamilyStreamNotifierProvider< // @override @mustBeOverridden @visibleForOverriding - FamilyStreamNotifierProvider copyWithBuild( + FamilyStreamNotifierProvider $copyWithBuild( RunNotifierBuild, Ref>> build, ) { return _copyWith(build: build); @@ -88,7 +88,7 @@ final class FamilyStreamNotifierProvider< // @override @mustBeOverridden @visibleForOverriding - FamilyStreamNotifierProvider copyWithCreate( + FamilyStreamNotifierProvider $copyWithCreate( NotifierT Function() create, ) { return _copyWith(create: create); diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index 63b280383..8172b46b2 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -129,7 +129,7 @@ final class StreamNotifierProvider< // @mustBeOverridden @visibleForOverriding @override - StreamNotifierProvider copyWithBuild( + StreamNotifierProvider $copyWithBuild( RunNotifierBuild, Ref>>? build, ) { return _copyWith(build: build); @@ -138,7 +138,7 @@ final class StreamNotifierProvider< // @mustBeOverridden @visibleForOverriding @override - StreamNotifierProvider copyWithCreate( + StreamNotifierProvider $copyWithCreate( NotifierT Function() create, ) { return _copyWith(create: create); diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index 16456edce..cca559450 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -137,7 +137,7 @@ base class StreamProvider extends $FunctionalProvider< @visibleForOverriding @override $FunctionalProvider, Stream, - Ref>> copyWithCreate( + Ref>> $copyWithCreate( Create, Ref>> create, ) { return StreamProvider.internal( diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 56895202d..a46fefda7 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -47,7 +47,7 @@ final class CountProvider extends $FunctionalProvider } @override - CountProvider copyWithCreate( + CountProvider $copyWithCreate( int Function( CountRef ref, ) create, @@ -100,7 +100,7 @@ final class CountFutureProvider } @override - CountFutureProvider copyWithCreate( + CountFutureProvider $copyWithCreate( FutureOr Function( CountFutureRef ref, ) create, @@ -153,7 +153,7 @@ final class CountStreamProvider } @override - CountStreamProvider copyWithCreate( + CountStreamProvider $copyWithCreate( Stream Function( CountStreamRef ref, ) create, @@ -208,7 +208,7 @@ final class Count2Provider extends $FunctionalProvider } @override - Count2Provider copyWithCreate( + Count2Provider $copyWithCreate( int Function( Count2Ref ref, ) create, @@ -304,7 +304,7 @@ final class CountFuture2Provider } @override - CountFuture2Provider copyWithCreate( + CountFuture2Provider $copyWithCreate( FutureOr Function( CountFuture2Ref ref, ) create, @@ -400,7 +400,7 @@ final class CountStream2Provider } @override - CountStream2Provider copyWithCreate( + CountStream2Provider $copyWithCreate( Stream Function( CountStream2Ref ref, ) create, @@ -478,7 +478,7 @@ final class CountNotifierProvider @$internal @override - CountNotifierProvider copyWithCreate( + CountNotifierProvider $copyWithCreate( CountNotifier Function() create, ) { return CountNotifierProvider._(create: create); @@ -486,7 +486,7 @@ final class CountNotifierProvider @$internal @override - CountNotifierProvider copyWithBuild( + CountNotifierProvider $copyWithBuild( int Function(Ref, CountNotifier) build, ) { return CountNotifierProvider._(runNotifierBuildOverride: build); @@ -536,7 +536,7 @@ final class CountAsyncNotifierProvider @$internal @override - CountAsyncNotifierProvider copyWithCreate( + CountAsyncNotifierProvider $copyWithCreate( CountAsyncNotifier Function() create, ) { return CountAsyncNotifierProvider._(create: create); @@ -544,7 +544,7 @@ final class CountAsyncNotifierProvider @$internal @override - CountAsyncNotifierProvider copyWithBuild( + CountAsyncNotifierProvider $copyWithBuild( FutureOr Function(Ref>, CountAsyncNotifier) build, ) { return CountAsyncNotifierProvider._(runNotifierBuildOverride: build); @@ -595,7 +595,7 @@ final class CountStreamNotifierProvider @$internal @override - CountStreamNotifierProvider copyWithCreate( + CountStreamNotifierProvider $copyWithCreate( CountStreamNotifier Function() create, ) { return CountStreamNotifierProvider._(create: create); @@ -603,7 +603,7 @@ final class CountStreamNotifierProvider @$internal @override - CountStreamNotifierProvider copyWithBuild( + CountStreamNotifierProvider $copyWithBuild( Stream Function(Ref>, CountStreamNotifier) build, ) { return CountStreamNotifierProvider._(runNotifierBuildOverride: build); @@ -655,7 +655,7 @@ final class CountNotifier2Provider @$internal @override - CountNotifier2Provider copyWithCreate( + CountNotifier2Provider $copyWithCreate( CountNotifier2 Function() create, ) { return CountNotifier2Provider._( @@ -666,7 +666,7 @@ final class CountNotifier2Provider @$internal @override - CountNotifier2Provider copyWithBuild( + CountNotifier2Provider $copyWithBuild( int Function(Ref, CountNotifier2) build, ) { return CountNotifier2Provider._( @@ -763,7 +763,7 @@ final class CountAsyncNotifier2Provider @$internal @override - CountAsyncNotifier2Provider copyWithCreate( + CountAsyncNotifier2Provider $copyWithCreate( CountAsyncNotifier2 Function() create, ) { return CountAsyncNotifier2Provider._( @@ -774,7 +774,7 @@ final class CountAsyncNotifier2Provider @$internal @override - CountAsyncNotifier2Provider copyWithBuild( + CountAsyncNotifier2Provider $copyWithBuild( FutureOr Function(Ref>, CountAsyncNotifier2) build, ) { return CountAsyncNotifier2Provider._( @@ -872,7 +872,7 @@ final class CountStreamNotifier2Provider @$internal @override - CountStreamNotifier2Provider copyWithCreate( + CountStreamNotifier2Provider $copyWithCreate( CountStreamNotifier2 Function() create, ) { return CountStreamNotifier2Provider._( @@ -883,7 +883,7 @@ final class CountStreamNotifier2Provider @$internal @override - CountStreamNotifier2Provider copyWithBuild( + CountStreamNotifier2Provider $copyWithBuild( Stream Function(Ref>, CountStreamNotifier2) build, ) { return CountStreamNotifier2Provider._( diff --git a/packages/riverpod_generator/lib/src/templates/family_back.dart b/packages/riverpod_generator/lib/src/templates/family_back.dart index 987c08b51..e0998216a 100644 --- a/packages/riverpod_generator/lib/src/templates/family_back.dart +++ b/packages/riverpod_generator/lib/src/templates/family_back.dart @@ -181,7 +181,7 @@ abstract class $notifierTypedefName$typeParametersDefinition extends $notifierBa @internal @override - $providerType copyWithBuild( + $providerType $copyWithBuild( ${provider.name} Function() create, ) { return $providerType._internal( @@ -312,7 +312,7 @@ $providerOther @internal @override - $providerTypeNameImpl copyWithCreate( + $providerTypeNameImpl $copyWithCreate( $createType create, ) { return $providerTypeNameImpl._internal( diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 341c7a014..808ef13d9 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -193,7 +193,7 @@ final class $name$_genericsDefinition buffer.writeln(''' @override - ${provider.providerTypeName}$_generics copyWithCreate( + ${provider.providerTypeName}$_generics $copyWithCreate( ${provider.createType(withArguments: false)} create, ) { return ${provider.providerTypeName}$_generics._( @@ -212,7 +212,7 @@ final class $name$_genericsDefinition @\$internal @override - ${provider.providerTypeName}$_generics copyWithCreate( + ${provider.providerTypeName}$_generics $copyWithCreate( $notifierType Function() create, ) { return ${provider.providerTypeName}$_generics._( @@ -223,7 +223,7 @@ final class $name$_genericsDefinition @\$internal @override - ${provider.providerTypeName}$_generics copyWithBuild( + ${provider.providerTypeName}$_generics $copyWithBuild( ${provider.createdTypeDisplayString} Function($_refType, $notifierType) build, ) { return ${provider.providerTypeName}$_generics._( diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 94d0bdc31..614fdce16 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -48,7 +48,7 @@ final class FunctionalProvider } @override - FunctionalProvider copyWithCreate( + FunctionalProvider $copyWithCreate( String Function( FunctionalRef ref, ) create, @@ -104,7 +104,7 @@ final class FamilyProvider } @override - FamilyProvider copyWithCreate( + FamilyProvider $copyWithCreate( String Function( FamilyRef ref, ) create, @@ -197,7 +197,7 @@ final class NotCopiedFunctionalProvider } @override - NotCopiedFunctionalProvider copyWithCreate( + NotCopiedFunctionalProvider $copyWithCreate( String Function( NotCopiedFunctionalRef ref, ) create, @@ -254,7 +254,7 @@ final class NotCopiedFamilyProvider } @override - NotCopiedFamilyProvider copyWithCreate( + NotCopiedFamilyProvider $copyWithCreate( String Function( NotCopiedFamilyRef ref, ) create, @@ -331,7 +331,7 @@ final class ClassBasedProvider extends $NotifierProvider { @$internal @override - ClassBasedProvider copyWithCreate( + ClassBasedProvider $copyWithCreate( ClassBased Function() create, ) { return ClassBasedProvider._(create: create); @@ -339,7 +339,7 @@ final class ClassBasedProvider extends $NotifierProvider { @$internal @override - ClassBasedProvider copyWithBuild( + ClassBasedProvider $copyWithBuild( String Function(Ref, ClassBased) build, ) { return ClassBasedProvider._(runNotifierBuildOverride: build); @@ -389,7 +389,7 @@ final class NotCopiedClassBasedProvider @$internal @override - NotCopiedClassBasedProvider copyWithCreate( + NotCopiedClassBasedProvider $copyWithCreate( NotCopiedClassBased Function() create, ) { return NotCopiedClassBasedProvider._(create: create); @@ -397,7 +397,7 @@ final class NotCopiedClassBasedProvider @$internal @override - NotCopiedClassBasedProvider copyWithBuild( + NotCopiedClassBasedProvider $copyWithBuild( String Function(Ref, NotCopiedClassBased) build, ) { return NotCopiedClassBasedProvider._(runNotifierBuildOverride: build); diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 360debc53..252d22931 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -48,7 +48,7 @@ final class GenericProvider extends $FunctionalProvider< } @override - GenericProvider copyWithCreate( + GenericProvider $copyWithCreate( FutureOr> Function( GenericRef ref, ) create, @@ -130,7 +130,7 @@ final class PublicProvider } @override - PublicProvider copyWithCreate( + PublicProvider $copyWithCreate( FutureOr Function( PublicRef ref, ) create, @@ -183,7 +183,7 @@ final class _PrivateProvider extends $FunctionalProvider, } @override - _PrivateProvider copyWithCreate( + _PrivateProvider $copyWithCreate( FutureOr Function( _PrivateRef ref, ) create, @@ -239,7 +239,7 @@ final class FamilyOrProvider extends $FunctionalProvider, } @override - FamilyOrProvider copyWithCreate( + FamilyOrProvider $copyWithCreate( FutureOr Function( FamilyOrRef ref, ) create, @@ -366,7 +366,7 @@ final class FamilyProvider } @override - FamilyProvider copyWithCreate( + FamilyProvider $copyWithCreate( FutureOr Function( FamilyRef ref, ) create, @@ -471,7 +471,7 @@ final class GenericClassProvider @$internal @override - GenericClassProvider copyWithCreate( + GenericClassProvider $copyWithCreate( GenericClass Function() create, ) { return GenericClassProvider._( @@ -480,7 +480,7 @@ final class GenericClassProvider @$internal @override - GenericClassProvider copyWithBuild( + GenericClassProvider $copyWithBuild( FutureOr> Function(Ref>>, GenericClass) build, ) { return GenericClassProvider._( @@ -564,7 +564,7 @@ final class PublicClassProvider @$internal @override - PublicClassProvider copyWithCreate( + PublicClassProvider $copyWithCreate( PublicClass Function() create, ) { return PublicClassProvider._(create: create); @@ -572,7 +572,7 @@ final class PublicClassProvider @$internal @override - PublicClassProvider copyWithBuild( + PublicClassProvider $copyWithBuild( FutureOr Function(Ref>, PublicClass) build, ) { return PublicClassProvider._(runNotifierBuildOverride: build); @@ -622,7 +622,7 @@ final class _PrivateClassProvider @$internal @override - _PrivateClassProvider copyWithCreate( + _PrivateClassProvider $copyWithCreate( _PrivateClass Function() create, ) { return _PrivateClassProvider._(create: create); @@ -630,7 +630,7 @@ final class _PrivateClassProvider @$internal @override - _PrivateClassProvider copyWithBuild( + _PrivateClassProvider $copyWithBuild( FutureOr Function(Ref>, _PrivateClass) build, ) { return _PrivateClassProvider._(runNotifierBuildOverride: build); @@ -681,7 +681,7 @@ final class FamilyOrClassProvider @$internal @override - FamilyOrClassProvider copyWithCreate( + FamilyOrClassProvider $copyWithCreate( FamilyOrClass Function() create, ) { return FamilyOrClassProvider._( @@ -692,7 +692,7 @@ final class FamilyOrClassProvider @$internal @override - FamilyOrClassProvider copyWithBuild( + FamilyOrClassProvider $copyWithBuild( FutureOr Function(Ref>, FamilyOrClass) build, ) { return FamilyOrClassProvider._( @@ -796,7 +796,7 @@ final class FamilyClassProvider @$internal @override - FamilyClassProvider copyWithCreate( + FamilyClassProvider $copyWithCreate( FamilyClass Function() create, ) { return FamilyClassProvider._( @@ -813,7 +813,7 @@ final class FamilyClassProvider @$internal @override - FamilyClassProvider copyWithBuild( + FamilyClassProvider $copyWithBuild( FutureOr Function(Ref>, FamilyClass) build, ) { return FamilyClassProvider._( diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 2bf075a09..f5af96f30 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -48,7 +48,7 @@ final class KeepAliveProvider } @override - KeepAliveProvider copyWithCreate( + KeepAliveProvider $copyWithCreate( int Function( KeepAliveRef ref, ) create, @@ -101,7 +101,7 @@ final class NotKeepAliveProvider } @override - NotKeepAliveProvider copyWithCreate( + NotKeepAliveProvider $copyWithCreate( int Function( NotKeepAliveRef ref, ) create, diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index f2ab18d62..f06b12f98 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -47,7 +47,7 @@ final class DepProvider extends $FunctionalProvider } @override - DepProvider copyWithCreate( + DepProvider $copyWithCreate( int Function( DepRef ref, ) create, @@ -102,7 +102,7 @@ final class FamilyProvider extends $FunctionalProvider } @override - FamilyProvider copyWithCreate( + FamilyProvider $copyWithCreate( int Function( FamilyRef ref, ) create, @@ -209,7 +209,7 @@ final class ProviderProvider extends $FunctionalProvider } @override - ProviderProvider copyWithCreate( + ProviderProvider $copyWithCreate( int Function( ProviderRef ref, ) create, @@ -277,7 +277,7 @@ final class Provider2Provider } @override - Provider2Provider copyWithCreate( + Provider2Provider $copyWithCreate( int Function( Provider2Ref ref, ) create, @@ -346,7 +346,7 @@ final class TransitiveDependenciesProvider } @override - TransitiveDependenciesProvider copyWithCreate( + TransitiveDependenciesProvider $copyWithCreate( int Function( TransitiveDependenciesRef ref, ) create, @@ -413,7 +413,7 @@ final class SmallTransitiveDependencyCountProvider } @override - SmallTransitiveDependencyCountProvider copyWithCreate( + SmallTransitiveDependencyCountProvider $copyWithCreate( int Function( SmallTransitiveDependencyCountRef ref, ) create, @@ -468,7 +468,7 @@ final class EmptyDependenciesFunctionalProvider } @override - EmptyDependenciesFunctionalProvider copyWithCreate( + EmptyDependenciesFunctionalProvider $copyWithCreate( int Function( EmptyDependenciesFunctionalRef ref, ) create, @@ -531,7 +531,7 @@ final class ProviderWithDependenciesProvider } @override - ProviderWithDependenciesProvider copyWithCreate( + ProviderWithDependenciesProvider $copyWithCreate( int Function( ProviderWithDependenciesRef ref, ) create, @@ -585,7 +585,7 @@ final class _PrivateDepProvider } @override - _PrivateDepProvider copyWithCreate( + _PrivateDepProvider $copyWithCreate( int Function( _PrivateDepRef ref, ) create, @@ -638,7 +638,7 @@ final class PublicDepProvider } @override - PublicDepProvider copyWithCreate( + PublicDepProvider $copyWithCreate( int Function( PublicDepRef ref, ) create, @@ -697,7 +697,7 @@ final class DuplicateDependenciesProvider } @override - DuplicateDependenciesProvider copyWithCreate( + DuplicateDependenciesProvider $copyWithCreate( int Function( DuplicateDependenciesRef ref, ) create, @@ -760,7 +760,7 @@ final class DuplicateDependencies2Provider } @override - DuplicateDependencies2Provider copyWithCreate( + DuplicateDependencies2Provider $copyWithCreate( int Function( DuplicateDependencies2Ref ref, ) create, @@ -836,7 +836,7 @@ final class TransitiveDuplicateDependenciesProvider } @override - TransitiveDuplicateDependenciesProvider copyWithCreate( + TransitiveDuplicateDependenciesProvider $copyWithCreate( int Function( TransitiveDuplicateDependenciesRef ref, ) create, @@ -874,7 +874,7 @@ final class Dep2Provider extends $NotifierProvider { @$internal @override - Dep2Provider copyWithCreate( + Dep2Provider $copyWithCreate( Dep2 Function() create, ) { return Dep2Provider._(create: create); @@ -882,7 +882,7 @@ final class Dep2Provider extends $NotifierProvider { @$internal @override - Dep2Provider copyWithBuild( + Dep2Provider $copyWithBuild( int Function(Ref, Dep2) build, ) { return Dep2Provider._(runNotifierBuildOverride: build); @@ -932,7 +932,7 @@ final class Family2Provider extends $NotifierProvider { @$internal @override - Family2Provider copyWithCreate( + Family2Provider $copyWithCreate( Family2 Function() create, ) { return Family2Provider._( @@ -943,7 +943,7 @@ final class Family2Provider extends $NotifierProvider { @$internal @override - Family2Provider copyWithBuild( + Family2Provider $copyWithBuild( int Function(Ref, Family2) build, ) { return Family2Provider._( @@ -1053,7 +1053,7 @@ final class Provider3Provider extends $NotifierProvider { @$internal @override - Provider3Provider copyWithCreate( + Provider3Provider $copyWithCreate( Provider3 Function() create, ) { return Provider3Provider._(create: create); @@ -1061,7 +1061,7 @@ final class Provider3Provider extends $NotifierProvider { @$internal @override - Provider3Provider copyWithBuild( + Provider3Provider $copyWithBuild( int Function(Ref, Provider3) build, ) { return Provider3Provider._(runNotifierBuildOverride: build); @@ -1116,7 +1116,7 @@ final class Provider4Provider extends $NotifierProvider { @$internal @override - Provider4Provider copyWithCreate( + Provider4Provider $copyWithCreate( Provider4 Function() create, ) { return Provider4Provider._( @@ -1127,7 +1127,7 @@ final class Provider4Provider extends $NotifierProvider { @$internal @override - Provider4Provider copyWithBuild( + Provider4Provider $copyWithBuild( int Function(Ref, Provider4) build, ) { return Provider4Provider._( @@ -1236,7 +1236,7 @@ final class EmptyDependenciesClassBasedProvider @$internal @override - EmptyDependenciesClassBasedProvider copyWithCreate( + EmptyDependenciesClassBasedProvider $copyWithCreate( EmptyDependenciesClassBased Function() create, ) { return EmptyDependenciesClassBasedProvider._(create: create); @@ -1244,7 +1244,7 @@ final class EmptyDependenciesClassBasedProvider @$internal @override - EmptyDependenciesClassBasedProvider copyWithBuild( + EmptyDependenciesClassBasedProvider $copyWithBuild( int Function(Ref, EmptyDependenciesClassBased) build, ) { return EmptyDependenciesClassBasedProvider._( diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index e64062134..f43dbfc65 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -66,7 +66,7 @@ final class ProviderWithDependencies2Provider } @override - ProviderWithDependencies2Provider copyWithCreate( + ProviderWithDependencies2Provider $copyWithCreate( int Function( ProviderWithDependencies2Ref ref, ) create, @@ -138,7 +138,7 @@ final class FamilyWithDependencies2Provider } @override - FamilyWithDependencies2Provider copyWithCreate( + FamilyWithDependencies2Provider $copyWithCreate( int Function( FamilyWithDependencies2Ref ref, ) create, @@ -247,7 +247,7 @@ final class _Private2Provider } @override - _Private2Provider copyWithCreate( + _Private2Provider $copyWithCreate( int Function( _Private2Ref ref, ) create, @@ -299,7 +299,7 @@ final class Public2Provider extends $FunctionalProvider } @override - Public2Provider copyWithCreate( + Public2Provider $copyWithCreate( int Function( Public2Ref ref, ) create, @@ -357,7 +357,7 @@ final class NotifierWithDependenciesProvider @$internal @override - NotifierWithDependenciesProvider copyWithCreate( + NotifierWithDependenciesProvider $copyWithCreate( NotifierWithDependencies Function() create, ) { return NotifierWithDependenciesProvider._(create: create); @@ -365,7 +365,7 @@ final class NotifierWithDependenciesProvider @$internal @override - NotifierWithDependenciesProvider copyWithBuild( + NotifierWithDependenciesProvider $copyWithBuild( int Function(Ref, NotifierWithDependencies) build, ) { return NotifierWithDependenciesProvider._(runNotifierBuildOverride: build); @@ -430,7 +430,7 @@ final class NotifierFamilyWithDependenciesProvider @$internal @override - NotifierFamilyWithDependenciesProvider copyWithCreate( + NotifierFamilyWithDependenciesProvider $copyWithCreate( NotifierFamilyWithDependencies Function() create, ) { return NotifierFamilyWithDependenciesProvider._( @@ -443,7 +443,7 @@ final class NotifierFamilyWithDependenciesProvider @$internal @override - NotifierFamilyWithDependenciesProvider copyWithBuild( + NotifierFamilyWithDependenciesProvider $copyWithBuild( int Function(Ref, NotifierFamilyWithDependencies) build, ) { return NotifierFamilyWithDependenciesProvider._( diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 1610f4984..4c366b4a1 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -48,7 +48,7 @@ final class GeneratedProvider } @override - GeneratedProvider copyWithCreate( + GeneratedProvider $copyWithCreate( _Test Function( GeneratedRef ref, ) create, @@ -104,7 +104,7 @@ final class GeneratedFamilyProvider } @override - GeneratedFamilyProvider copyWithCreate( + GeneratedFamilyProvider $copyWithCreate( _Test Function( GeneratedFamilyRef ref, ) create, @@ -197,7 +197,7 @@ final class $DynamicProvider } @override - $DynamicProvider copyWithCreate( + $DynamicProvider $copyWithCreate( Object? Function( $DynamicRef ref, ) create, @@ -253,7 +253,7 @@ final class $DynamicFamilyProvider } @override - $DynamicFamilyProvider copyWithCreate( + $DynamicFamilyProvider $copyWithCreate( Object? Function( $DynamicFamilyRef ref, ) create, @@ -349,7 +349,7 @@ final class _DynamicProvider } @override - _DynamicProvider copyWithCreate( + _DynamicProvider $copyWithCreate( Object? Function( _DynamicRef ref, ) create, @@ -443,7 +443,7 @@ final class AliasProvider } @override - AliasProvider copyWithCreate( + AliasProvider $copyWithCreate( r.AsyncValue Function( AliasRef ref, ) create, @@ -502,7 +502,7 @@ final class AliasFamilyProvider extends $FunctionalProvider< } @override - AliasFamilyProvider copyWithCreate( + AliasFamilyProvider $copyWithCreate( r.AsyncValue Function( AliasFamilyRef ref, ) create, @@ -580,7 +580,7 @@ final class GeneratedClassProvider @$internal @override - GeneratedClassProvider copyWithCreate( + GeneratedClassProvider $copyWithCreate( GeneratedClass Function() create, ) { return GeneratedClassProvider._(create: create); @@ -588,7 +588,7 @@ final class GeneratedClassProvider @$internal @override - GeneratedClassProvider copyWithBuild( + GeneratedClassProvider $copyWithBuild( _Test Function(Ref<_Test>, GeneratedClass) build, ) { return GeneratedClassProvider._(runNotifierBuildOverride: build); @@ -639,7 +639,7 @@ final class GeneratedClassFamilyProvider @$internal @override - GeneratedClassFamilyProvider copyWithCreate( + GeneratedClassFamilyProvider $copyWithCreate( GeneratedClassFamily Function() create, ) { return GeneratedClassFamilyProvider._( @@ -650,7 +650,7 @@ final class GeneratedClassFamilyProvider @$internal @override - GeneratedClassFamilyProvider copyWithBuild( + GeneratedClassFamilyProvider $copyWithBuild( _Test Function(Ref<_Test>, GeneratedClassFamily) build, ) { return GeneratedClassFamilyProvider._( @@ -747,7 +747,7 @@ final class $DynamicClassProvider @$internal @override - $DynamicClassProvider copyWithCreate( + $DynamicClassProvider $copyWithCreate( $DynamicClass Function() create, ) { return $DynamicClassProvider._(create: create); @@ -755,7 +755,7 @@ final class $DynamicClassProvider @$internal @override - $DynamicClassProvider copyWithBuild( + $DynamicClassProvider $copyWithBuild( Object? Function(Ref, $DynamicClass) build, ) { return $DynamicClassProvider._(runNotifierBuildOverride: build); @@ -806,7 +806,7 @@ final class $DynamicClassFamilyProvider @$internal @override - $DynamicClassFamilyProvider copyWithCreate( + $DynamicClassFamilyProvider $copyWithCreate( $DynamicClassFamily Function() create, ) { return $DynamicClassFamilyProvider._( @@ -817,7 +817,7 @@ final class $DynamicClassFamilyProvider @$internal @override - $DynamicClassFamilyProvider copyWithBuild( + $DynamicClassFamilyProvider $copyWithBuild( Object? Function(Ref, $DynamicClassFamily) build, ) { return $DynamicClassFamilyProvider._( @@ -914,7 +914,7 @@ final class AliasClassProvider @$internal @override - AliasClassProvider copyWithCreate( + AliasClassProvider $copyWithCreate( AliasClass Function() create, ) { return AliasClassProvider._(create: create); @@ -922,7 +922,7 @@ final class AliasClassProvider @$internal @override - AliasClassProvider copyWithBuild( + AliasClassProvider $copyWithBuild( r.AsyncValue Function(Ref>, AliasClass) build, ) { return AliasClassProvider._(runNotifierBuildOverride: build); @@ -973,7 +973,7 @@ final class AliasClassFamilyProvider @$internal @override - AliasClassFamilyProvider copyWithCreate( + AliasClassFamilyProvider $copyWithCreate( AliasClassFamily Function() create, ) { return AliasClassFamilyProvider._( @@ -984,7 +984,7 @@ final class AliasClassFamilyProvider @$internal @override - AliasClassFamilyProvider copyWithBuild( + AliasClassFamilyProvider $copyWithBuild( r.AsyncValue Function(Ref>, AliasClassFamily) build, ) { return AliasClassFamilyProvider._( diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index d14305c9b..f08401c5a 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -48,7 +48,7 @@ final class SimpleProvider } @override - SimpleProvider copyWithCreate( + SimpleProvider $copyWithCreate( String Function( SimpleRef ref, ) create, @@ -101,7 +101,7 @@ final class Simple2Provider } @override - Simple2Provider copyWithCreate( + Simple2Provider $copyWithCreate( String Function( Simple2Ref ref, ) create, @@ -138,7 +138,7 @@ final class SimpleClassProvider extends $NotifierProvider { @$internal @override - SimpleClassProvider copyWithCreate( + SimpleClassProvider $copyWithCreate( SimpleClass Function() create, ) { return SimpleClassProvider._(create: create); @@ -146,7 +146,7 @@ final class SimpleClassProvider extends $NotifierProvider { @$internal @override - SimpleClassProvider copyWithBuild( + SimpleClassProvider $copyWithBuild( String Function(Ref, SimpleClass) build, ) { return SimpleClassProvider._(runNotifierBuildOverride: build); diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 2e92c4293..56ff2c83e 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -47,7 +47,7 @@ final class ScopedProvider extends $FunctionalProvider } @override - ScopedProvider copyWithCreate( + ScopedProvider $copyWithCreate( int Function( ScopedRef ref, ) create, @@ -84,7 +84,7 @@ final class ScopedClassProvider extends $NotifierProvider { @$internal @override - ScopedClassProvider copyWithCreate( + ScopedClassProvider $copyWithCreate( ScopedClass Function() create, ) { return ScopedClassProvider._(create: create); @@ -92,7 +92,7 @@ final class ScopedClassProvider extends $NotifierProvider { @$internal @override - ScopedClassProvider copyWithBuild( + ScopedClassProvider $copyWithBuild( int Function(Ref, ScopedClass) build, ) { return ScopedClassProvider._(runNotifierBuildOverride: build); diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index 0f39cdc2a..9c61ab693 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -47,7 +47,7 @@ final class Counter2Provider extends $FunctionalProvider } @override - Counter2Provider copyWithCreate( + Counter2Provider $copyWithCreate( int Function( Counter2Ref ref, ) create, @@ -99,7 +99,7 @@ final class CounterProvider extends $FunctionalProvider } @override - CounterProvider copyWithCreate( + CounterProvider $copyWithCreate( int Function( CounterRef ref, ) create, diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 4870ac64d..2a6e73456 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -48,7 +48,7 @@ final class GenericProvider extends $FunctionalProvider< } @override - GenericProvider copyWithCreate( + GenericProvider $copyWithCreate( Stream> Function( GenericRef ref, ) create, @@ -130,7 +130,7 @@ final class PublicProvider } @override - PublicProvider copyWithCreate( + PublicProvider $copyWithCreate( Stream Function( PublicRef ref, ) create, @@ -183,7 +183,7 @@ final class _PrivateProvider } @override - _PrivateProvider copyWithCreate( + _PrivateProvider $copyWithCreate( Stream Function( _PrivateRef ref, ) create, @@ -270,7 +270,7 @@ final class FamilyProvider } @override - FamilyProvider copyWithCreate( + FamilyProvider $copyWithCreate( Stream Function( FamilyRef ref, ) create, @@ -375,7 +375,7 @@ final class GenericClassProvider @$internal @override - GenericClassProvider copyWithCreate( + GenericClassProvider $copyWithCreate( GenericClass Function() create, ) { return GenericClassProvider._( @@ -384,7 +384,7 @@ final class GenericClassProvider @$internal @override - GenericClassProvider copyWithBuild( + GenericClassProvider $copyWithBuild( Stream> Function(Ref>>, GenericClass) build, ) { return GenericClassProvider._( @@ -467,7 +467,7 @@ final class PublicClassProvider @$internal @override - PublicClassProvider copyWithCreate( + PublicClassProvider $copyWithCreate( PublicClass Function() create, ) { return PublicClassProvider._(create: create); @@ -475,7 +475,7 @@ final class PublicClassProvider @$internal @override - PublicClassProvider copyWithBuild( + PublicClassProvider $copyWithBuild( Stream Function(Ref>, PublicClass) build, ) { return PublicClassProvider._(runNotifierBuildOverride: build); @@ -525,7 +525,7 @@ final class _PrivateClassProvider @$internal @override - _PrivateClassProvider copyWithCreate( + _PrivateClassProvider $copyWithCreate( _PrivateClass Function() create, ) { return _PrivateClassProvider._(create: create); @@ -533,7 +533,7 @@ final class _PrivateClassProvider @$internal @override - _PrivateClassProvider copyWithBuild( + _PrivateClassProvider $copyWithBuild( Stream Function(Ref>, _PrivateClass) build, ) { return _PrivateClassProvider._(runNotifierBuildOverride: build); @@ -591,7 +591,7 @@ final class FamilyClassProvider @$internal @override - FamilyClassProvider copyWithCreate( + FamilyClassProvider $copyWithCreate( FamilyClass Function() create, ) { return FamilyClassProvider._( @@ -608,7 +608,7 @@ final class FamilyClassProvider @$internal @override - FamilyClassProvider copyWithBuild( + FamilyClassProvider $copyWithBuild( Stream Function(Ref>, FamilyClass) build, ) { return FamilyClassProvider._( diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 0940935b7..2ddb6c083 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -48,7 +48,7 @@ final class GenericProvider } @override - GenericProvider copyWithCreate( + GenericProvider $copyWithCreate( List Function( GenericRef ref, ) create, @@ -146,7 +146,7 @@ final class ComplexGenericProvider } @override - ComplexGenericProvider copyWithCreate( + ComplexGenericProvider $copyWithCreate( List Function( ComplexGenericRef ref, ) create, @@ -254,7 +254,7 @@ final class RawFutureProvider extends $FunctionalProvider< } @override - RawFutureProvider copyWithCreate( + RawFutureProvider $copyWithCreate( Raw> Function( RawFutureRef ref, ) create, @@ -309,7 +309,7 @@ final class RawStreamProvider extends $FunctionalProvider< } @override - RawStreamProvider copyWithCreate( + RawStreamProvider $copyWithCreate( Raw> Function( RawStreamRef ref, ) create, @@ -366,7 +366,7 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< } @override - RawFamilyFutureProvider copyWithCreate( + RawFamilyFutureProvider $copyWithCreate( Raw> Function( RawFamilyFutureRef ref, ) create, @@ -463,7 +463,7 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< } @override - RawFamilyStreamProvider copyWithCreate( + RawFamilyStreamProvider $copyWithCreate( Raw> Function( RawFamilyStreamRef ref, ) create, @@ -556,7 +556,7 @@ final class PublicProvider } @override - PublicProvider copyWithCreate( + PublicProvider $copyWithCreate( String Function( PublicRef ref, ) create, @@ -609,7 +609,7 @@ final class Supports$inNamesProvider } @override - Supports$inNamesProvider copyWithCreate( + Supports$inNamesProvider $copyWithCreate( String Function( Supports$inNamesRef ref, ) create, @@ -696,7 +696,7 @@ final class FamilyProvider } @override - FamilyProvider copyWithCreate( + FamilyProvider $copyWithCreate( String Function( FamilyRef ref, ) create, @@ -815,7 +815,7 @@ final class _PrivateProvider } @override - _PrivateProvider copyWithCreate( + _PrivateProvider $copyWithCreate( String Function( _PrivateRef ref, ) create, @@ -868,7 +868,7 @@ final class GeneratedProvider } @override - GeneratedProvider copyWithCreate( + GeneratedProvider $copyWithCreate( String Function( GeneratedRef ref, ) create, @@ -907,7 +907,7 @@ final class GenericClassProvider @$internal @override - GenericClassProvider copyWithCreate( + GenericClassProvider $copyWithCreate( GenericClass Function() create, ) { return GenericClassProvider._( @@ -916,7 +916,7 @@ final class GenericClassProvider @$internal @override - GenericClassProvider copyWithBuild( + GenericClassProvider $copyWithBuild( List Function(Ref>, GenericClass) build, ) { return GenericClassProvider._( @@ -999,7 +999,7 @@ final class RawFutureClassProvider @$internal @override - RawFutureClassProvider copyWithCreate( + RawFutureClassProvider $copyWithCreate( RawFutureClass Function() create, ) { return RawFutureClassProvider._(create: create); @@ -1007,7 +1007,7 @@ final class RawFutureClassProvider @$internal @override - RawFutureClassProvider copyWithBuild( + RawFutureClassProvider $copyWithBuild( Raw> Function(Ref>>, RawFutureClass) build, ) { @@ -1058,7 +1058,7 @@ final class RawStreamClassProvider @$internal @override - RawStreamClassProvider copyWithCreate( + RawStreamClassProvider $copyWithCreate( RawStreamClass Function() create, ) { return RawStreamClassProvider._(create: create); @@ -1066,7 +1066,7 @@ final class RawStreamClassProvider @$internal @override - RawStreamClassProvider copyWithBuild( + RawStreamClassProvider $copyWithBuild( Raw> Function(Ref>>, RawStreamClass) build, ) { @@ -1118,7 +1118,7 @@ final class RawFamilyFutureClassProvider @$internal @override - RawFamilyFutureClassProvider copyWithCreate( + RawFamilyFutureClassProvider $copyWithCreate( RawFamilyFutureClass Function() create, ) { return RawFamilyFutureClassProvider._( @@ -1129,7 +1129,7 @@ final class RawFamilyFutureClassProvider @$internal @override - RawFamilyFutureClassProvider copyWithBuild( + RawFamilyFutureClassProvider $copyWithBuild( Raw> Function(Ref>>, RawFamilyFutureClass) build, ) { @@ -1228,7 +1228,7 @@ final class RawFamilyStreamClassProvider @$internal @override - RawFamilyStreamClassProvider copyWithCreate( + RawFamilyStreamClassProvider $copyWithCreate( RawFamilyStreamClass Function() create, ) { return RawFamilyStreamClassProvider._( @@ -1239,7 +1239,7 @@ final class RawFamilyStreamClassProvider @$internal @override - RawFamilyStreamClassProvider copyWithBuild( + RawFamilyStreamClassProvider $copyWithBuild( Raw> Function(Ref>>, RawFamilyStreamClass) build, ) { @@ -1336,7 +1336,7 @@ final class PublicClassProvider extends $NotifierProvider { @$internal @override - PublicClassProvider copyWithCreate( + PublicClassProvider $copyWithCreate( PublicClass Function() create, ) { return PublicClassProvider._(create: create); @@ -1344,7 +1344,7 @@ final class PublicClassProvider extends $NotifierProvider { @$internal @override - PublicClassProvider copyWithBuild( + PublicClassProvider $copyWithBuild( String Function(Ref, PublicClass) build, ) { return PublicClassProvider._(runNotifierBuildOverride: build); @@ -1394,7 +1394,7 @@ final class _PrivateClassProvider @$internal @override - _PrivateClassProvider copyWithCreate( + _PrivateClassProvider $copyWithCreate( _PrivateClass Function() create, ) { return _PrivateClassProvider._(create: create); @@ -1402,7 +1402,7 @@ final class _PrivateClassProvider @$internal @override - _PrivateClassProvider copyWithBuild( + _PrivateClassProvider $copyWithBuild( String Function(Ref, _PrivateClass) build, ) { return _PrivateClassProvider._(runNotifierBuildOverride: build); @@ -1459,7 +1459,7 @@ final class FamilyClassProvider extends $NotifierProvider { @$internal @override - FamilyClassProvider copyWithCreate( + FamilyClassProvider $copyWithCreate( FamilyClass Function() create, ) { return FamilyClassProvider._( @@ -1476,7 +1476,7 @@ final class FamilyClassProvider extends $NotifierProvider { @$internal @override - FamilyClassProvider copyWithBuild( + FamilyClassProvider $copyWithBuild( String Function(Ref, FamilyClass) build, ) { return FamilyClassProvider._( @@ -1611,7 +1611,7 @@ final class Supports$InClassNameProvider @$internal @override - Supports$InClassNameProvider copyWithCreate( + Supports$InClassNameProvider $copyWithCreate( Supports$InClassName Function() create, ) { return Supports$InClassNameProvider._(create: create); @@ -1619,7 +1619,7 @@ final class Supports$InClassNameProvider @$internal @override - Supports$InClassNameProvider copyWithBuild( + Supports$InClassNameProvider $copyWithBuild( String Function(Ref, Supports$InClassName) build, ) { return Supports$InClassNameProvider._(runNotifierBuildOverride: build); From e6b2f43be5f0e4e04757a5644ddc84d8bcec9125 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 15:35:32 +0100 Subject: [PATCH 162/387] W --- packages/riverpod_generator/lib/src/templates/provider.dart | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 808ef13d9..564f9749e 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -193,7 +193,7 @@ final class $name$_genericsDefinition buffer.writeln(''' @override - ${provider.providerTypeName}$_generics $copyWithCreate( + ${provider.providerTypeName}$_generics \$copyWithCreate( ${provider.createType(withArguments: false)} create, ) { return ${provider.providerTypeName}$_generics._( @@ -212,7 +212,7 @@ final class $name$_genericsDefinition @\$internal @override - ${provider.providerTypeName}$_generics $copyWithCreate( + ${provider.providerTypeName}$_generics \$copyWithCreate( $notifierType Function() create, ) { return ${provider.providerTypeName}$_generics._( @@ -223,7 +223,7 @@ final class $name$_genericsDefinition @\$internal @override - ${provider.providerTypeName}$_generics $copyWithBuild( + ${provider.providerTypeName}$_generics \$copyWithBuild( ${provider.createdTypeDisplayString} Function($_refType, $notifierType) build, ) { return ${provider.providerTypeName}$_generics._( From af04fac8a741e101a16f31a811e527d1c870af02 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 16:19:00 +0100 Subject: [PATCH 163/387] Remove record when there's only a single arg --- .../integration/build_yaml/lib/main.g.dart | 195 ++++------ .../lib/src/riverpod_generator.dart | 26 ++ .../lib/src/templates/family.dart | 50 ++- .../lib/src/templates/parameters.dart | 5 +- .../lib/src/templates/provider.dart | 64 ++-- .../test/integration/annotated.g.dart | 96 ++--- .../test/integration/async.g.dart | 192 ++++------ .../test/integration/auto_dispose.g.dart | 30 +- .../test/integration/dependencies.g.dart | 247 +++++-------- .../test/integration/dependencies2.g.dart | 115 ++---- .../test/integration/generated.g.dart | 251 +++++-------- .../test/integration/hash/hash1.g.dart | 30 +- .../test/integration/scopes.g.dart | 15 +- .../test/integration/split.g.dart | 30 +- .../test/integration/stream.g.dart | 141 +++---- .../test/integration/sync.g.dart | 347 +++++++----------- 16 files changed, 705 insertions(+), 1129 deletions(-) diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index a46fefda7..b002b1834 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -37,15 +37,6 @@ final class CountProvider extends $FunctionalProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(CountRef ref) { - final fn = _createCb ?? count; - - return fn( - ref, - ); - } - @override CountProvider $copyWithCreate( int Function( @@ -54,6 +45,12 @@ final class CountProvider extends $FunctionalProvider ) { return CountProvider._(create: create); } + + @override + int create(CountRef ref) { + final fn = _createCb ?? count; + return fn(ref); + } } String _$countHash() => r'4c7e72b275767a60ece5e8662ab1e28f73cf7e44'; @@ -90,15 +87,6 @@ final class CountFutureProvider $FutureProviderElement createElement(ProviderContainer container) => $FutureProviderElement(this, container); - @override - FutureOr create(CountFutureRef ref) { - final fn = _createCb ?? countFuture; - - return fn( - ref, - ); - } - @override CountFutureProvider $copyWithCreate( FutureOr Function( @@ -107,6 +95,12 @@ final class CountFutureProvider ) { return CountFutureProvider._(create: create); } + + @override + FutureOr create(CountFutureRef ref) { + final fn = _createCb ?? countFuture; + return fn(ref); + } } String _$countFutureHash() => r'ec7cc31ce1c1a10607f1dcb35dd217acd2877729'; @@ -143,15 +137,6 @@ final class CountStreamProvider $StreamProviderElement createElement(ProviderContainer container) => $StreamProviderElement(this, container); - @override - Stream create(CountStreamRef ref) { - final fn = _createCb ?? countStream; - - return fn( - ref, - ); - } - @override CountStreamProvider $copyWithCreate( Stream Function( @@ -160,6 +145,12 @@ final class CountStreamProvider ) { return CountStreamProvider._(create: create); } + + @override + Stream create(CountStreamRef ref) { + final fn = _createCb ?? countStream; + return fn(ref); + } } String _$countStreamHash() => r'1dbe49244ea19e8dbc3af0534429bb323720c07a'; @@ -172,7 +163,7 @@ final class Count2Provider extends $FunctionalProvider with $Provider { const Count2Provider._( {required Count2Family super.from, - required (int,) super.argument, + required int super.argument, int Function( Count2Ref ref, int a, @@ -197,16 +188,6 @@ final class Count2Provider extends $FunctionalProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(Count2Ref ref) { - final fn = _createCb ?? count2; - final (int,) argument = this.argument! as (int,); - return fn( - ref, - argument.$1, - ); - } - @override Count2Provider $copyWithCreate( int Function( @@ -214,7 +195,7 @@ final class Count2Provider extends $FunctionalProvider ) create, ) { return Count2Provider._( - argument: argument! as (int,), + argument: argument as int, from: from! as Count2Family, create: ( ref, @@ -223,6 +204,16 @@ final class Count2Provider extends $FunctionalProvider create(ref)); } + @override + int create(Count2Ref ref) { + final fn = _createCb ?? count2; + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } + @override bool operator ==(Object other) { return other is Count2Provider && other.argument == argument; @@ -243,20 +234,13 @@ final class Count2Family extends Family { Count2Provider call( int a, ) => - Count2Provider._(argument: (a,), from: this); + Count2Provider._(argument: a, from: this); @override String debugGetCreateSourceHash() => _$count2Hash(); @override String toString() => r'count2'; - - Override overrideWith( - int Function( - Count2Ref ref, - (int,) args, - ) create, - ) {} } typedef CountFuture2Ref = Ref>; @@ -268,7 +252,7 @@ final class CountFuture2Provider with $FutureModifier, $FutureProvider { const CountFuture2Provider._( {required CountFuture2Family super.from, - required (int,) super.argument, + required int super.argument, FutureOr Function( CountFuture2Ref ref, int a, @@ -293,16 +277,6 @@ final class CountFuture2Provider $FutureProviderElement createElement(ProviderContainer container) => $FutureProviderElement(this, container); - @override - FutureOr create(CountFuture2Ref ref) { - final fn = _createCb ?? countFuture2; - final (int,) argument = this.argument! as (int,); - return fn( - ref, - argument.$1, - ); - } - @override CountFuture2Provider $copyWithCreate( FutureOr Function( @@ -310,7 +284,7 @@ final class CountFuture2Provider ) create, ) { return CountFuture2Provider._( - argument: argument! as (int,), + argument: argument as int, from: from! as CountFuture2Family, create: ( ref, @@ -319,6 +293,16 @@ final class CountFuture2Provider create(ref)); } + @override + FutureOr create(CountFuture2Ref ref) { + final fn = _createCb ?? countFuture2; + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } + @override bool operator ==(Object other) { return other is CountFuture2Provider && other.argument == argument; @@ -339,20 +323,13 @@ final class CountFuture2Family extends Family { CountFuture2Provider call( int a, ) => - CountFuture2Provider._(argument: (a,), from: this); + CountFuture2Provider._(argument: a, from: this); @override String debugGetCreateSourceHash() => _$countFuture2Hash(); @override String toString() => r'countFuture2'; - - Override overrideWith( - FutureOr Function( - CountFuture2Ref ref, - (int,) args, - ) create, - ) {} } typedef CountStream2Ref = Ref>; @@ -364,7 +341,7 @@ final class CountStream2Provider with $FutureModifier, $StreamProvider { const CountStream2Provider._( {required CountStream2Family super.from, - required (int,) super.argument, + required int super.argument, Stream Function( CountStream2Ref ref, int a, @@ -389,16 +366,6 @@ final class CountStream2Provider $StreamProviderElement createElement(ProviderContainer container) => $StreamProviderElement(this, container); - @override - Stream create(CountStream2Ref ref) { - final fn = _createCb ?? countStream2; - final (int,) argument = this.argument! as (int,); - return fn( - ref, - argument.$1, - ); - } - @override CountStream2Provider $copyWithCreate( Stream Function( @@ -406,7 +373,7 @@ final class CountStream2Provider ) create, ) { return CountStream2Provider._( - argument: argument! as (int,), + argument: argument as int, from: from! as CountStream2Family, create: ( ref, @@ -415,6 +382,16 @@ final class CountStream2Provider create(ref)); } + @override + Stream create(CountStream2Ref ref) { + final fn = _createCb ?? countStream2; + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } + @override bool operator ==(Object other) { return other is CountStream2Provider && other.argument == argument; @@ -435,20 +412,13 @@ final class CountStream2Family extends Family { CountStream2Provider call( int a, ) => - CountStream2Provider._(argument: (a,), from: this); + CountStream2Provider._(argument: a, from: this); @override String debugGetCreateSourceHash() => _$countStream2Hash(); @override String toString() => r'countStream2'; - - Override overrideWith( - Stream Function( - CountStream2Ref ref, - (int,) args, - ) create, - ) {} } const countNotifierPod = CountNotifierProvider._(); @@ -633,7 +603,7 @@ final class CountNotifier2Provider extends $NotifierProvider { const CountNotifier2Provider._( {required CountNotifier2Family super.from, - required (int,) super.argument, + required int super.argument, super.runNotifierBuildOverride, CountNotifier2 Function()? create}) : _createCb = create, @@ -659,7 +629,7 @@ final class CountNotifier2Provider CountNotifier2 Function() create, ) { return CountNotifier2Provider._( - argument: argument! as (int,), + argument: argument as int, from: from! as CountNotifier2Family, create: create); } @@ -670,7 +640,7 @@ final class CountNotifier2Provider int Function(Ref, CountNotifier2) build, ) { return CountNotifier2Provider._( - argument: argument! as (int,), + argument: argument as int, from: from! as CountNotifier2Family, runNotifierBuildOverride: build); } @@ -701,22 +671,13 @@ final class CountNotifier2Family extends Family { CountNotifier2Provider call( int a, ) => - CountNotifier2Provider._(argument: (a,), from: this); + CountNotifier2Provider._(argument: a, from: this); @override String debugGetCreateSourceHash() => _$countNotifier2Hash(); @override String toString() => r'CountNotifier2'; - - Override overrideWith( - int Function( - Ref ref, - (int,) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$CountNotifier2 extends $Notifier { @@ -741,7 +702,7 @@ final class CountAsyncNotifier2Provider extends $AsyncNotifierProvider { const CountAsyncNotifier2Provider._( {required CountAsyncNotifier2Family super.from, - required (int,) super.argument, + required int super.argument, super.runNotifierBuildOverride, CountAsyncNotifier2 Function()? create}) : _createCb = create, @@ -767,7 +728,7 @@ final class CountAsyncNotifier2Provider CountAsyncNotifier2 Function() create, ) { return CountAsyncNotifier2Provider._( - argument: argument! as (int,), + argument: argument as int, from: from! as CountAsyncNotifier2Family, create: create); } @@ -778,7 +739,7 @@ final class CountAsyncNotifier2Provider FutureOr Function(Ref>, CountAsyncNotifier2) build, ) { return CountAsyncNotifier2Provider._( - argument: argument! as (int,), + argument: argument as int, from: from! as CountAsyncNotifier2Family, runNotifierBuildOverride: build); } @@ -810,22 +771,13 @@ final class CountAsyncNotifier2Family extends Family { CountAsyncNotifier2Provider call( int a, ) => - CountAsyncNotifier2Provider._(argument: (a,), from: this); + CountAsyncNotifier2Provider._(argument: a, from: this); @override String debugGetCreateSourceHash() => _$countAsyncNotifier2Hash(); @override String toString() => r'CountAsyncNotifier2'; - - Override overrideWith( - FutureOr Function( - Ref> ref, - (int,) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$CountAsyncNotifier2 extends $AsyncNotifier { @@ -850,7 +802,7 @@ final class CountStreamNotifier2Provider extends $StreamNotifierProvider { const CountStreamNotifier2Provider._( {required CountStreamNotifier2Family super.from, - required (int,) super.argument, + required int super.argument, super.runNotifierBuildOverride, CountStreamNotifier2 Function()? create}) : _createCb = create, @@ -876,7 +828,7 @@ final class CountStreamNotifier2Provider CountStreamNotifier2 Function() create, ) { return CountStreamNotifier2Provider._( - argument: argument! as (int,), + argument: argument as int, from: from! as CountStreamNotifier2Family, create: create); } @@ -887,7 +839,7 @@ final class CountStreamNotifier2Provider Stream Function(Ref>, CountStreamNotifier2) build, ) { return CountStreamNotifier2Provider._( - argument: argument! as (int,), + argument: argument as int, from: from! as CountStreamNotifier2Family, runNotifierBuildOverride: build); } @@ -919,22 +871,13 @@ final class CountStreamNotifier2Family extends Family { CountStreamNotifier2Provider call( int a, ) => - CountStreamNotifier2Provider._(argument: (a,), from: this); + CountStreamNotifier2Provider._(argument: a, from: this); @override String debugGetCreateSourceHash() => _$countStreamNotifier2Hash(); @override String toString() => r'CountStreamNotifier2'; - - Override overrideWith( - Stream Function( - Ref> ref, - (int,) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$CountStreamNotifier2 extends $StreamNotifier { diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index 012acdc92..d3e38412c 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -279,6 +279,32 @@ extension ProviderNames on GeneratorProviderDeclaration { String get familyTypeName => providerElement.familyTypeName; + String get argumentRecordType { + switch (parameters) { + case [_]: + return parameters.first.typeDisplayString; + case []: + return 'Never'; + case [...]: + return '(${buildParamDefinitionQuery(parameters, asRecord: true)})'; + } + } + + String argumentToRecord({String? variableName}) { + switch (parameters) { + case [final p]: + return variableName ?? p.name.toString(); + case [...]: + return '(${buildParamInvocationQuery({ + for (final parameter in parameters) + if (variableName != null) + parameter: '$variableName.${parameter.name}' + else + parameter: parameter.name.toString(), + })})'; + } + } + // TODO possibly no-longer needed String dependencies(BuildYamlOptions options) => providerElement.dependencies(options); diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 3cf38e2de..75bea0a10 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -16,6 +16,8 @@ class FamilyTemplate extends Template { final BuildYamlOptions options; final List? allTransitiveDependencies; + late final _argumentRecordType = provider.argumentRecordType; + @override void run(StringBuffer buffer) { if (!provider.providerElement.isFamily) return; @@ -29,13 +31,9 @@ class FamilyTemplate extends Template { final parameterDefinition = buildParamDefinitionQuery(provider.parameters); - final parametersPassThrough = buildParamInvocationQuery({ - for (final parameter in provider.parameters) - parameter: parameter.name!.lexeme, - }); - final argument = provider.parameters.isEmpty - ? '' - : 'argument: ($parametersPassThrough),'; + final parametersPassThrough = provider.argumentToRecord(); + final argument = + provider.parameters.isEmpty ? '' : 'argument: $parametersPassThrough,'; buffer.writeln(''' final class ${provider.familyTypeName} extends Family { @@ -60,11 +58,11 @@ final class ${provider.familyTypeName} extends Family { String toString() => r'${provider.name}'; '''); - _writeOverrides( - buffer, - topLevelBuffer: topLevelBuffer, - genericsDefinition: genericsDefinition, - ); + // _writeOverrides( + // buffer, + // topLevelBuffer: topLevelBuffer, + // genericsDefinition: genericsDefinition, + // ); buffer.writeln('}'); @@ -99,8 +97,14 @@ final class ${provider.familyTypeName} extends Family { required StringBuffer topLevelBuffer, required String genericsDefinition, }) { - late final argumentsType = - '(${buildParamDefinitionQuery(provider.parameters, asRecord: true)})'; + // Encode the list of parameters into a record. + // We do so only if there are at least two parameters. + // TODO test + late final argumentsType = switch (provider.parameters) { + [final p] => p.typeDisplayString, + _ => + '(${buildParamDefinitionQuery(provider.parameters, asRecord: true)})', + }; final createType = switch (provider) { FunctionalProviderDeclaration(parameters: [_, ...]) => @@ -116,7 +120,25 @@ final class ${provider.familyTypeName} extends Family { // TODO docs buffer.writeln(''' Override overrideWith($createType create,) { + return \$FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ProviderT; +'''); + + switch (provider.parameters) { + case [_]: + buffer.writeln(''' + final args = provider.argument! as ${provider.parameters.single.typeDisplayString}; + '''); + } + + (''' + final args = provider.argument! as $_argumentRecordType; + return provider.\$copyWithCreate(create).createElement(container); + }, + ); } '''); } diff --git a/packages/riverpod_generator/lib/src/templates/parameters.dart b/packages/riverpod_generator/lib/src/templates/parameters.dart index 96bf6311d..f8a253ff7 100644 --- a/packages/riverpod_generator/lib/src/templates/parameters.dart +++ b/packages/riverpod_generator/lib/src/templates/parameters.dart @@ -92,8 +92,9 @@ extension ParameterType on FormalParameter { case DefaultFormalParameter(): return that.parameter.typeDisplayString; case SimpleFormalParameter(): - // No type, so let's just return '' - return that.type?.toSource() ?? ''; + // TODO changelog no type = dynamic + // No type, so let's just return 'dynamic' + return that.type?.toSource() ?? 'dynamic'; case FieldFormalParameter(): case FunctionTypedFormalParameter(): case SuperFormalParameter(): diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 564f9749e..13f92c353 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -17,10 +17,7 @@ class ProviderTemplate extends Template { final BuildYamlOptions options; final List? allTransitiveDependencies; - late final _argumentRecordType = buildParamDefinitionQuery( - provider.parameters, - asRecord: true, - ); + late final _argumentRecordType = provider.argumentRecordType; late final _generics = provider.generics(); late final _genericsDefinition = provider.genericsDefinition(); @@ -105,7 +102,7 @@ final class $name$_genericsDefinition if (provider.providerElement.isFamily) 'required ${provider.familyTypeName} super.from,', if (provider.parameters.isNotEmpty) - 'required ($_argumentRecordType) super.argument,', + 'required $_argumentRecordType super.argument,', if (provider is ClassBasedProviderDeclaration) 'super.runNotifierBuildOverride,', ].join(); @@ -150,20 +147,9 @@ final class $name$_genericsDefinition String debugGetCreateSourceHash() => ${provider.hashFnName}(); '''); - final localArgumentDefinition = provider.parameters.isNotEmpty - ? 'final ($_argumentRecordType) argument = this.argument! as ($_argumentRecordType);' - : ''; - final paramsPassThrough = buildParamInvocationQuery({ - for (final (index, parameter) in provider.parameters.indexed) - if (parameter.isPositional) - parameter: 'argument.\$${index + 1}' - else - parameter: 'argument.${parameter.name!.lexeme}', - }); - final copyParameters = [ if (provider.parameters.isNotEmpty) - 'argument: argument! as ($_argumentRecordType),', + 'argument: argument as $_argumentRecordType,', if (provider.providerElement.isFamily) 'from: from! as ${provider.familyTypeName},', ].join(); @@ -171,7 +157,6 @@ final class $name$_genericsDefinition switch (provider) { case FunctionalProviderDeclaration(): final createParams = buildParamDefinitionQuery(provider.parameters); - final createFn = provider.parameters.isEmpty ? 'create' : '(ref, $createParams) => create(ref)'; @@ -181,17 +166,7 @@ final class $name$_genericsDefinition ${provider.elementName}<${provider.valueTypeDisplayString}> createElement( ProviderContainer container ) => ${provider.elementName}(this, container); -'''); - buffer.writeln(''' - @override - ${provider.createdTypeDisplayString} create(${provider.refImplName}$_generics ref){ - final fn = _createCb ?? ${provider.name}$_generics; - $localArgumentDefinition - return fn(ref, $paramsPassThrough); - }'''); - - buffer.writeln(''' @override ${provider.providerTypeName}$_generics \$copyWithCreate( ${provider.createType(withArguments: false)} create, @@ -202,6 +177,9 @@ final class $name$_genericsDefinition ); } '''); + + _writeFunctionalCreate(buffer); + case ClassBasedProviderDeclaration(): final notifierType = '${provider.name}$_generics'; @@ -243,6 +221,36 @@ final class $name$_genericsDefinition _writeEqual(buffer); } + void _writeFunctionalCreate(StringBuffer buffer) { + buffer.write(''' + @override + ${provider.createdTypeDisplayString} create(${provider.refImplName}$_generics ref) { + final fn = _createCb ?? ${provider.name}$_generics; +'''); + + switch (provider.parameters) { + case []: + buffer.writeln('return fn(ref);'); + case [...]: + final paramsPassThrough = buildParamInvocationQuery({ + for (final (index, parameter) in provider.parameters.indexed) + if (provider.parameters.length == 1) + parameter: 'argument' + else if (parameter.isPositional) + parameter: 'argument.\$${index + 1}' + else + parameter: 'argument.${parameter.name!.lexeme}', + }); + + buffer.writeln(''' + final $_argumentRecordType argument = this.argument as $_argumentRecordType; + return fn(ref, $paramsPassThrough); + '''); + } + + buffer.writeln('}'); + } + void _writeEqual(StringBuffer buffer) { if (!provider.providerElement.isFamily) return; diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 614fdce16..cb559c3e8 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -38,15 +38,6 @@ final class FunctionalProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - String create(FunctionalRef ref) { - final fn = _createCb ?? functional; - - return fn( - ref, - ); - } - @override FunctionalProvider $copyWithCreate( String Function( @@ -55,6 +46,12 @@ final class FunctionalProvider ) { return FunctionalProvider._(create: create); } + + @override + String create(FunctionalRef ref) { + final fn = _createCb ?? functional; + return fn(ref); + } } String _$functionalHash() => r'69e260b1de8ba28cbeb8e24d628933366cde6b8b'; @@ -68,7 +65,7 @@ final class FamilyProvider with $Provider { const FamilyProvider._( {required FamilyFamily super.from, - required (int,) super.argument, + required int super.argument, String Function( FamilyRef ref, int id, @@ -93,16 +90,6 @@ final class FamilyProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - String create(FamilyRef ref) { - final fn = _createCb ?? family; - final (int,) argument = this.argument! as (int,); - return fn( - ref, - argument.$1, - ); - } - @override FamilyProvider $copyWithCreate( String Function( @@ -110,7 +97,7 @@ final class FamilyProvider ) create, ) { return FamilyProvider._( - argument: argument! as (int,), + argument: argument as int, from: from! as FamilyFamily, create: ( ref, @@ -119,6 +106,16 @@ final class FamilyProvider create(ref)); } + @override + String create(FamilyRef ref) { + final fn = _createCb ?? family; + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } + @override bool operator ==(Object other) { return other is FamilyProvider && other.argument == argument; @@ -139,20 +136,13 @@ final class FamilyFamily extends Family { FamilyProvider call( int id, ) => - FamilyProvider._(argument: (id,), from: this); + FamilyProvider._(argument: id, from: this); @override String debugGetCreateSourceHash() => _$familyHash(); @override String toString() => r'family'; - - Override overrideWith( - String Function( - FamilyRef ref, - (int,) args, - ) create, - ) {} } typedef NotCopiedFunctionalRef = Ref; @@ -187,15 +177,6 @@ final class NotCopiedFunctionalProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - String create(NotCopiedFunctionalRef ref) { - final fn = _createCb ?? notCopiedFunctional; - - return fn( - ref, - ); - } - @override NotCopiedFunctionalProvider $copyWithCreate( String Function( @@ -204,6 +185,12 @@ final class NotCopiedFunctionalProvider ) { return NotCopiedFunctionalProvider._(create: create); } + + @override + String create(NotCopiedFunctionalRef ref) { + final fn = _createCb ?? notCopiedFunctional; + return fn(ref); + } } String _$notCopiedFunctionalHash() => @@ -218,7 +205,7 @@ final class NotCopiedFamilyProvider with $Provider { const NotCopiedFamilyProvider._( {required NotCopiedFamilyFamily super.from, - required (int,) super.argument, + required int super.argument, String Function( NotCopiedFamilyRef ref, int id, @@ -243,16 +230,6 @@ final class NotCopiedFamilyProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - String create(NotCopiedFamilyRef ref) { - final fn = _createCb ?? notCopiedFamily; - final (int,) argument = this.argument! as (int,); - return fn( - ref, - argument.$1, - ); - } - @override NotCopiedFamilyProvider $copyWithCreate( String Function( @@ -260,7 +237,7 @@ final class NotCopiedFamilyProvider ) create, ) { return NotCopiedFamilyProvider._( - argument: argument! as (int,), + argument: argument as int, from: from! as NotCopiedFamilyFamily, create: ( ref, @@ -269,6 +246,16 @@ final class NotCopiedFamilyProvider create(ref)); } + @override + String create(NotCopiedFamilyRef ref) { + final fn = _createCb ?? notCopiedFamily; + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } + @override bool operator ==(Object other) { return other is NotCopiedFamilyProvider && other.argument == argument; @@ -289,20 +276,13 @@ final class NotCopiedFamilyFamily extends Family { NotCopiedFamilyProvider call( int id, ) => - NotCopiedFamilyProvider._(argument: (id,), from: this); + NotCopiedFamilyProvider._(argument: id, from: this); @override String debugGetCreateSourceHash() => _$notCopiedFamilyHash(); @override String toString() => r'notCopiedFamily'; - - Override overrideWith( - String Function( - NotCopiedFamilyRef ref, - (int,) args, - ) create, - ) {} } const classBasedProvider = ClassBasedProvider._(); diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 252d22931..70ff2bc8f 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -38,15 +38,6 @@ final class GenericProvider extends $FunctionalProvider< $FutureProviderElement> createElement(ProviderContainer container) => $FutureProviderElement(this, container); - @override - FutureOr> create(GenericRef ref) { - final fn = _createCb ?? generic; - - return fn( - ref, - ); - } - @override GenericProvider $copyWithCreate( FutureOr> Function( @@ -56,6 +47,12 @@ final class GenericProvider extends $FunctionalProvider< return GenericProvider._(from: from! as GenericFamily, create: create); } + @override + FutureOr> create(GenericRef ref) { + final fn = _createCb ?? generic; + return fn(ref); + } + @override bool operator ==(Object other) { return other is GenericProvider && @@ -82,10 +79,6 @@ final class GenericFamily extends Family { @override String toString() => r'generic'; - - Override overrideWith( - FutureOr> Function(GenericRef ref) create, - ) {} } typedef PublicRef = Ref>; @@ -120,15 +113,6 @@ final class PublicProvider $FutureProviderElement createElement(ProviderContainer container) => $FutureProviderElement(this, container); - @override - FutureOr create(PublicRef ref) { - final fn = _createCb ?? public; - - return fn( - ref, - ); - } - @override PublicProvider $copyWithCreate( FutureOr Function( @@ -137,6 +121,12 @@ final class PublicProvider ) { return PublicProvider._(create: create); } + + @override + FutureOr create(PublicRef ref) { + final fn = _createCb ?? public; + return fn(ref); + } } String _$publicHash() => r'9d99b79c013da13926d4ad89c72ebca4fc1cc257'; @@ -173,15 +163,6 @@ final class _PrivateProvider extends $FunctionalProvider, $FutureProviderElement createElement(ProviderContainer container) => $FutureProviderElement(this, container); - @override - FutureOr create(_PrivateRef ref) { - final fn = _createCb ?? _private; - - return fn( - ref, - ); - } - @override _PrivateProvider $copyWithCreate( FutureOr Function( @@ -190,6 +171,12 @@ final class _PrivateProvider extends $FunctionalProvider, ) { return _PrivateProvider._(create: create); } + + @override + FutureOr create(_PrivateRef ref) { + final fn = _createCb ?? _private; + return fn(ref); + } } String _$privateHash() => r'bc0469a9315de114a0ccd82c7db4980844d0009f'; @@ -203,7 +190,7 @@ final class FamilyOrProvider extends $FunctionalProvider, with $FutureModifier, $FutureProvider { const FamilyOrProvider._( {required FamilyOrFamily super.from, - required (int,) super.argument, + required int super.argument, FutureOr Function( FamilyOrRef ref, int first, @@ -228,16 +215,6 @@ final class FamilyOrProvider extends $FunctionalProvider, $FutureProviderElement createElement(ProviderContainer container) => $FutureProviderElement(this, container); - @override - FutureOr create(FamilyOrRef ref) { - final fn = _createCb ?? familyOr; - final (int,) argument = this.argument! as (int,); - return fn( - ref, - argument.$1, - ); - } - @override FamilyOrProvider $copyWithCreate( FutureOr Function( @@ -245,7 +222,7 @@ final class FamilyOrProvider extends $FunctionalProvider, ) create, ) { return FamilyOrProvider._( - argument: argument! as (int,), + argument: argument as int, from: from! as FamilyOrFamily, create: ( ref, @@ -254,6 +231,16 @@ final class FamilyOrProvider extends $FunctionalProvider, create(ref)); } + @override + FutureOr create(FamilyOrRef ref) { + final fn = _createCb ?? familyOr; + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } + @override bool operator ==(Object other) { return other is FamilyOrProvider && other.argument == argument; @@ -274,20 +261,13 @@ final class FamilyOrFamily extends Family { FamilyOrProvider call( int first, ) => - FamilyOrProvider._(argument: (first,), from: this); + FamilyOrProvider._(argument: first, from: this); @override String debugGetCreateSourceHash() => _$familyOrHash(); @override String toString() => r'familyOr'; - - Override overrideWith( - FutureOr Function( - FamilyOrRef ref, - (int,) args, - ) create, - ) {} } typedef FamilyRef = Ref>; @@ -339,32 +319,6 @@ final class FamilyProvider $FutureProviderElement createElement(ProviderContainer container) => $FutureProviderElement(this, container); - @override - FutureOr create(FamilyRef ref) { - final fn = _createCb ?? family; - final ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) argument = this.argument! as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }); - return fn( - ref, - argument.$1, - second: argument.second, - third: argument.third, - fourth: argument.fourth, - fifth: argument.fifth, - ); - } - @override FamilyProvider $copyWithCreate( FutureOr Function( @@ -372,7 +326,7 @@ final class FamilyProvider ) create, ) { return FamilyProvider._( - argument: argument! as ( + argument: argument as ( int, { String? second, double third, @@ -391,6 +345,32 @@ final class FamilyProvider create(ref)); } + @override + FutureOr create(FamilyRef ref) { + final fn = _createCb ?? family; + final ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) argument = this.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + return fn( + ref, + argument.$1, + second: argument.second, + third: argument.third, + fourth: argument.fourth, + fifth: argument.fifth, + ); + } + @override bool operator ==(Object other) { return other is FamilyProvider && other.argument == argument; @@ -428,19 +408,6 @@ final class FamilyFamily extends Family { @override String toString() => r'family'; - - Override overrideWith( - FutureOr Function( - FamilyRef ref, - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) args, - ) create, - ) {} } const genericClassProvider = GenericClassFamily._(); @@ -520,13 +487,6 @@ final class GenericClassFamily extends Family { @override String toString() => r'GenericClass'; - - Override overrideWith( - FutureOr> Function(Ref>> re) - create, - ) {} - - Override overrideWithBuild() {} } abstract class _$GenericClass extends $AsyncNotifier> { @@ -659,7 +619,7 @@ final class FamilyOrClassProvider extends $AsyncNotifierProvider { const FamilyOrClassProvider._( {required FamilyOrClassFamily super.from, - required (int,) super.argument, + required int super.argument, super.runNotifierBuildOverride, FamilyOrClass Function()? create}) : _createCb = create, @@ -685,7 +645,7 @@ final class FamilyOrClassProvider FamilyOrClass Function() create, ) { return FamilyOrClassProvider._( - argument: argument! as (int,), + argument: argument as int, from: from! as FamilyOrClassFamily, create: create); } @@ -696,7 +656,7 @@ final class FamilyOrClassProvider FutureOr Function(Ref>, FamilyOrClass) build, ) { return FamilyOrClassProvider._( - argument: argument! as (int,), + argument: argument as int, from: from! as FamilyOrClassFamily, runNotifierBuildOverride: build); } @@ -727,22 +687,13 @@ final class FamilyOrClassFamily extends Family { FamilyOrClassProvider call( int first, ) => - FamilyOrClassProvider._(argument: (first,), from: this); + FamilyOrClassProvider._(argument: first, from: this); @override String debugGetCreateSourceHash() => _$familyOrClassHash(); @override String toString() => r'FamilyOrClass'; - - Override overrideWith( - FutureOr Function( - Ref> ref, - (int,) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$FamilyOrClass extends $AsyncNotifier { @@ -800,7 +751,7 @@ final class FamilyClassProvider FamilyClass Function() create, ) { return FamilyClassProvider._( - argument: argument! as ( + argument: argument as ( int, { String? second, double third, @@ -817,7 +768,7 @@ final class FamilyClassProvider FutureOr Function(Ref>, FamilyClass) build, ) { return FamilyClassProvider._( - argument: argument! as ( + argument: argument as ( int, { String? second, double third, @@ -871,21 +822,6 @@ final class FamilyClassFamily extends Family { @override String toString() => r'FamilyClass'; - - Override overrideWith( - FutureOr Function( - Ref> ref, - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$FamilyClass extends $AsyncNotifier { diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index f5af96f30..1eebde258 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -38,15 +38,6 @@ final class KeepAliveProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(KeepAliveRef ref) { - final fn = _createCb ?? keepAlive; - - return fn( - ref, - ); - } - @override KeepAliveProvider $copyWithCreate( int Function( @@ -55,6 +46,12 @@ final class KeepAliveProvider ) { return KeepAliveProvider._(create: create); } + + @override + int create(KeepAliveRef ref) { + final fn = _createCb ?? keepAlive; + return fn(ref); + } } String _$keepAliveHash() => r'72dd192676126d487c24c7695a91d59410c62696'; @@ -91,15 +88,6 @@ final class NotKeepAliveProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(NotKeepAliveRef ref) { - final fn = _createCb ?? notKeepAlive; - - return fn( - ref, - ); - } - @override NotKeepAliveProvider $copyWithCreate( int Function( @@ -108,6 +96,12 @@ final class NotKeepAliveProvider ) { return NotKeepAliveProvider._(create: create); } + + @override + int create(NotKeepAliveRef ref) { + final fn = _createCb ?? notKeepAlive; + return fn(ref); + } } String _$notKeepAliveHash() => r'1ccc497d7c651f8e730ec1bcecf271ffe9615d83'; diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index f06b12f98..a8de63456 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -37,15 +37,6 @@ final class DepProvider extends $FunctionalProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(DepRef ref) { - final fn = _createCb ?? dep; - - return fn( - ref, - ); - } - @override DepProvider $copyWithCreate( int Function( @@ -54,6 +45,12 @@ final class DepProvider extends $FunctionalProvider ) { return DepProvider._(create: create); } + + @override + int create(DepRef ref) { + final fn = _createCb ?? dep; + return fn(ref); + } } String _$depHash() => r'2213a401e03a1a914579b4a3a7707b783de9efba'; @@ -66,7 +63,7 @@ final class FamilyProvider extends $FunctionalProvider with $Provider { const FamilyProvider._( {required FamilyFamily super.from, - required (int,) super.argument, + required int super.argument, int Function( FamilyRef ref, int id, @@ -91,16 +88,6 @@ final class FamilyProvider extends $FunctionalProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(FamilyRef ref) { - final fn = _createCb ?? family; - final (int,) argument = this.argument! as (int,); - return fn( - ref, - argument.$1, - ); - } - @override FamilyProvider $copyWithCreate( int Function( @@ -108,7 +95,7 @@ final class FamilyProvider extends $FunctionalProvider ) create, ) { return FamilyProvider._( - argument: argument! as (int,), + argument: argument as int, from: from! as FamilyFamily, create: ( ref, @@ -117,6 +104,16 @@ final class FamilyProvider extends $FunctionalProvider create(ref)); } + @override + int create(FamilyRef ref) { + final fn = _createCb ?? family; + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } + @override bool operator ==(Object other) { return other is FamilyProvider && other.argument == argument; @@ -137,20 +134,13 @@ final class FamilyFamily extends Family { FamilyProvider call( int id, ) => - FamilyProvider._(argument: (id,), from: this); + FamilyProvider._(argument: id, from: this); @override String debugGetCreateSourceHash() => _$familyHash(); @override String toString() => r'family'; - - Override overrideWith( - int Function( - FamilyRef ref, - (int,) args, - ) create, - ) {} } typedef ProviderRef = Ref; @@ -199,15 +189,6 @@ final class ProviderProvider extends $FunctionalProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(ProviderRef ref) { - final fn = _createCb ?? provider; - - return fn( - ref, - ); - } - @override ProviderProvider $copyWithCreate( int Function( @@ -216,6 +197,12 @@ final class ProviderProvider extends $FunctionalProvider ) { return ProviderProvider._(create: create); } + + @override + int create(ProviderRef ref) { + final fn = _createCb ?? provider; + return fn(ref); + } } String _$providerHash() => r'6c9184ef4c6a410a2132e1ecc13a2e646e936d37'; @@ -267,15 +254,6 @@ final class Provider2Provider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(Provider2Ref ref) { - final fn = _createCb ?? provider2; - - return fn( - ref, - ); - } - @override Provider2Provider $copyWithCreate( int Function( @@ -284,6 +262,12 @@ final class Provider2Provider ) { return Provider2Provider._(create: create); } + + @override + int create(Provider2Ref ref) { + final fn = _createCb ?? provider2; + return fn(ref); + } } String _$provider2Hash() => r'70d908579c5e64ce6558b42f433adfb80f4dc79b'; @@ -336,15 +320,6 @@ final class TransitiveDependenciesProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(TransitiveDependenciesRef ref) { - final fn = _createCb ?? transitiveDependencies; - - return fn( - ref, - ); - } - @override TransitiveDependenciesProvider $copyWithCreate( int Function( @@ -353,6 +328,12 @@ final class TransitiveDependenciesProvider ) { return TransitiveDependenciesProvider._(create: create); } + + @override + int create(TransitiveDependenciesRef ref) { + final fn = _createCb ?? transitiveDependencies; + return fn(ref); + } } String _$transitiveDependenciesHash() => @@ -403,15 +384,6 @@ final class SmallTransitiveDependencyCountProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(SmallTransitiveDependencyCountRef ref) { - final fn = _createCb ?? smallTransitiveDependencyCount; - - return fn( - ref, - ); - } - @override SmallTransitiveDependencyCountProvider $copyWithCreate( int Function( @@ -420,6 +392,12 @@ final class SmallTransitiveDependencyCountProvider ) { return SmallTransitiveDependencyCountProvider._(create: create); } + + @override + int create(SmallTransitiveDependencyCountRef ref) { + final fn = _createCb ?? smallTransitiveDependencyCount; + return fn(ref); + } } String _$smallTransitiveDependencyCountHash() => @@ -458,15 +436,6 @@ final class EmptyDependenciesFunctionalProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(EmptyDependenciesFunctionalRef ref) { - final fn = _createCb ?? emptyDependenciesFunctional; - - return fn( - ref, - ); - } - @override EmptyDependenciesFunctionalProvider $copyWithCreate( int Function( @@ -475,6 +444,12 @@ final class EmptyDependenciesFunctionalProvider ) { return EmptyDependenciesFunctionalProvider._(create: create); } + + @override + int create(EmptyDependenciesFunctionalRef ref) { + final fn = _createCb ?? emptyDependenciesFunctional; + return fn(ref); + } } String _$emptyDependenciesFunctionalHash() => @@ -521,15 +496,6 @@ final class ProviderWithDependenciesProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(ProviderWithDependenciesRef ref) { - final fn = _createCb ?? providerWithDependencies; - - return fn( - ref, - ); - } - @override ProviderWithDependenciesProvider $copyWithCreate( int Function( @@ -538,6 +504,12 @@ final class ProviderWithDependenciesProvider ) { return ProviderWithDependenciesProvider._(create: create); } + + @override + int create(ProviderWithDependenciesRef ref) { + final fn = _createCb ?? providerWithDependencies; + return fn(ref); + } } String _$providerWithDependenciesHash() => @@ -575,15 +547,6 @@ final class _PrivateDepProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(_PrivateDepRef ref) { - final fn = _createCb ?? _privateDep; - - return fn( - ref, - ); - } - @override _PrivateDepProvider $copyWithCreate( int Function( @@ -592,6 +555,12 @@ final class _PrivateDepProvider ) { return _PrivateDepProvider._(create: create); } + + @override + int create(_PrivateDepRef ref) { + final fn = _createCb ?? _privateDep; + return fn(ref); + } } String _$privateDepHash() => r'f610d91bd39e0dcffe6ff4e74160964a291289d9'; @@ -628,15 +597,6 @@ final class PublicDepProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(PublicDepRef ref) { - final fn = _createCb ?? publicDep; - - return fn( - ref, - ); - } - @override PublicDepProvider $copyWithCreate( int Function( @@ -645,6 +605,12 @@ final class PublicDepProvider ) { return PublicDepProvider._(create: create); } + + @override + int create(PublicDepRef ref) { + final fn = _createCb ?? publicDep; + return fn(ref); + } } String _$publicDepHash() => r'bcb69aace017c86c3c4b8eccf59fa22d010834bc'; @@ -687,15 +653,6 @@ final class DuplicateDependenciesProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(DuplicateDependenciesRef ref) { - final fn = _createCb ?? duplicateDependencies; - - return fn( - ref, - ); - } - @override DuplicateDependenciesProvider $copyWithCreate( int Function( @@ -704,6 +661,12 @@ final class DuplicateDependenciesProvider ) { return DuplicateDependenciesProvider._(create: create); } + + @override + int create(DuplicateDependenciesRef ref) { + final fn = _createCb ?? duplicateDependencies; + return fn(ref); + } } String _$duplicateDependenciesHash() => @@ -750,15 +713,6 @@ final class DuplicateDependencies2Provider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(DuplicateDependencies2Ref ref) { - final fn = _createCb ?? duplicateDependencies2; - - return fn( - ref, - ); - } - @override DuplicateDependencies2Provider $copyWithCreate( int Function( @@ -767,6 +721,12 @@ final class DuplicateDependencies2Provider ) { return DuplicateDependencies2Provider._(create: create); } + + @override + int create(DuplicateDependencies2Ref ref) { + final fn = _createCb ?? duplicateDependencies2; + return fn(ref); + } } String _$duplicateDependencies2Hash() => @@ -826,15 +786,6 @@ final class TransitiveDuplicateDependenciesProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(TransitiveDuplicateDependenciesRef ref) { - final fn = _createCb ?? transitiveDuplicateDependencies; - - return fn( - ref, - ); - } - @override TransitiveDuplicateDependenciesProvider $copyWithCreate( int Function( @@ -843,6 +794,12 @@ final class TransitiveDuplicateDependenciesProvider ) { return TransitiveDuplicateDependenciesProvider._(create: create); } + + @override + int create(TransitiveDuplicateDependenciesRef ref) { + final fn = _createCb ?? transitiveDuplicateDependencies; + return fn(ref); + } } String _$transitiveDuplicateDependenciesHash() => @@ -910,7 +867,7 @@ const family2Provider = Family2Family._(); final class Family2Provider extends $NotifierProvider { const Family2Provider._( {required Family2Family super.from, - required (int,) super.argument, + required int super.argument, super.runNotifierBuildOverride, Family2 Function()? create}) : _createCb = create, @@ -936,7 +893,7 @@ final class Family2Provider extends $NotifierProvider { Family2 Function() create, ) { return Family2Provider._( - argument: argument! as (int,), + argument: argument as int, from: from! as Family2Family, create: create); } @@ -947,7 +904,7 @@ final class Family2Provider extends $NotifierProvider { int Function(Ref, Family2) build, ) { return Family2Provider._( - argument: argument! as (int,), + argument: argument as int, from: from! as Family2Family, runNotifierBuildOverride: build); } @@ -978,22 +935,13 @@ final class Family2Family extends Family { Family2Provider call( int id, ) => - Family2Provider._(argument: (id,), from: this); + Family2Provider._(argument: id, from: this); @override String debugGetCreateSourceHash() => _$family2Hash(); @override String toString() => r'Family2'; - - Override overrideWith( - int Function( - Ref ref, - (int,) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$Family2 extends $Notifier { @@ -1089,7 +1037,7 @@ const provider4Provider = Provider4Family._(); final class Provider4Provider extends $NotifierProvider { const Provider4Provider._( {required Provider4Family super.from, - required (int,) super.argument, + required int super.argument, super.runNotifierBuildOverride, Provider4 Function()? create}) : _createCb = create, @@ -1120,7 +1068,7 @@ final class Provider4Provider extends $NotifierProvider { Provider4 Function() create, ) { return Provider4Provider._( - argument: argument! as (int,), + argument: argument as int, from: from! as Provider4Family, create: create); } @@ -1131,7 +1079,7 @@ final class Provider4Provider extends $NotifierProvider { int Function(Ref, Provider4) build, ) { return Provider4Provider._( - argument: argument! as (int,), + argument: argument as int, from: from! as Provider4Family, runNotifierBuildOverride: build); } @@ -1172,22 +1120,13 @@ final class Provider4Family extends Family { Provider4Provider call( int id, ) => - Provider4Provider._(argument: (id,), from: this); + Provider4Provider._(argument: id, from: this); @override String debugGetCreateSourceHash() => _$provider4Hash(); @override String toString() => r'Provider4'; - - Override overrideWith( - int Function( - Ref ref, - (int,) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$Provider4 extends $Notifier { diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index f43dbfc65..4409e3482 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -56,15 +56,6 @@ final class ProviderWithDependencies2Provider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(ProviderWithDependencies2Ref ref) { - final fn = _createCb ?? providerWithDependencies2; - - return fn( - ref, - ); - } - @override ProviderWithDependencies2Provider $copyWithCreate( int Function( @@ -73,6 +64,12 @@ final class ProviderWithDependencies2Provider ) { return ProviderWithDependencies2Provider._(create: create); } + + @override + int create(ProviderWithDependencies2Ref ref) { + final fn = _createCb ?? providerWithDependencies2; + return fn(ref); + } } String _$providerWithDependencies2Hash() => @@ -87,10 +84,7 @@ final class FamilyWithDependencies2Provider with $Provider { const FamilyWithDependencies2Provider._( {required FamilyWithDependencies2Family super.from, - required ({ - int? id, - }) - super.argument, + required int? super.argument, int Function( FamilyWithDependencies2Ref ref, { int? id, @@ -123,20 +117,6 @@ final class FamilyWithDependencies2Provider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(FamilyWithDependencies2Ref ref) { - final fn = _createCb ?? familyWithDependencies2; - final ({ - int? id, - }) argument = this.argument! as ({ - int? id, - }); - return fn( - ref, - id: argument.id, - ); - } - @override FamilyWithDependencies2Provider $copyWithCreate( int Function( @@ -144,9 +124,7 @@ final class FamilyWithDependencies2Provider ) create, ) { return FamilyWithDependencies2Provider._( - argument: argument! as ({ - int? id, - }), + argument: argument as int?, from: from! as FamilyWithDependencies2Family, create: ( ref, { @@ -155,6 +133,16 @@ final class FamilyWithDependencies2Provider create(ref)); } + @override + int create(FamilyWithDependencies2Ref ref) { + final fn = _createCb ?? familyWithDependencies2; + final int? argument = this.argument as int?; + return fn( + ref, + id: argument, + ); + } + @override bool operator ==(Object other) { return other is FamilyWithDependencies2Provider && @@ -187,22 +175,13 @@ final class FamilyWithDependencies2Family extends Family { FamilyWithDependencies2Provider call({ int? id, }) => - FamilyWithDependencies2Provider._(argument: (id: id,), from: this); + FamilyWithDependencies2Provider._(argument: id, from: this); @override String debugGetCreateSourceHash() => _$familyWithDependencies2Hash(); @override String toString() => r'familyWithDependencies2'; - - Override overrideWith( - int Function( - FamilyWithDependencies2Ref ref, - ({ - int? id, - }) args, - ) create, - ) {} } typedef _Private2Ref = Ref; @@ -237,15 +216,6 @@ final class _Private2Provider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(_Private2Ref ref) { - final fn = _createCb ?? _private2; - - return fn( - ref, - ); - } - @override _Private2Provider $copyWithCreate( int Function( @@ -254,6 +224,12 @@ final class _Private2Provider ) { return _Private2Provider._(create: create); } + + @override + int create(_Private2Ref ref) { + final fn = _createCb ?? _private2; + return fn(ref); + } } String _$private2Hash() => r'5e0fa14ff40fb444c027ed25150a42362db3ef19'; @@ -289,15 +265,6 @@ final class Public2Provider extends $FunctionalProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(Public2Ref ref) { - final fn = _createCb ?? public2; - - return fn( - ref, - ); - } - @override Public2Provider $copyWithCreate( int Function( @@ -306,6 +273,12 @@ final class Public2Provider extends $FunctionalProvider ) { return Public2Provider._(create: create); } + + @override + int create(Public2Ref ref) { + final fn = _createCb ?? public2; + return fn(ref); + } } String _$public2Hash() => r'9767255f0182589fe48b29d217dd488b0a13b9d5'; @@ -396,10 +369,7 @@ final class NotifierFamilyWithDependenciesProvider extends $NotifierProvider { const NotifierFamilyWithDependenciesProvider._( {required NotifierFamilyWithDependenciesFamily super.from, - required ({ - int? id, - }) - super.argument, + required int? super.argument, super.runNotifierBuildOverride, NotifierFamilyWithDependencies Function()? create}) : _createCb = create, @@ -434,9 +404,7 @@ final class NotifierFamilyWithDependenciesProvider NotifierFamilyWithDependencies Function() create, ) { return NotifierFamilyWithDependenciesProvider._( - argument: argument! as ({ - int? id, - }), + argument: argument as int?, from: from! as NotifierFamilyWithDependenciesFamily, create: create); } @@ -447,9 +415,7 @@ final class NotifierFamilyWithDependenciesProvider int Function(Ref, NotifierFamilyWithDependencies) build, ) { return NotifierFamilyWithDependenciesProvider._( - argument: argument! as ({ - int? id, - }), + argument: argument as int?, from: from! as NotifierFamilyWithDependenciesFamily, runNotifierBuildOverride: build); } @@ -492,24 +458,13 @@ final class NotifierFamilyWithDependenciesFamily extends Family { NotifierFamilyWithDependenciesProvider call({ int? id, }) => - NotifierFamilyWithDependenciesProvider._(argument: (id: id,), from: this); + NotifierFamilyWithDependenciesProvider._(argument: id, from: this); @override String debugGetCreateSourceHash() => _$notifierFamilyWithDependenciesHash(); @override String toString() => r'NotifierFamilyWithDependencies'; - - Override overrideWith( - int Function( - Ref ref, - ({ - int? id, - }) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$NotifierFamilyWithDependencies extends $Notifier { diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 4c366b4a1..d855517f9 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -38,15 +38,6 @@ final class GeneratedProvider $ProviderElement<_Test> createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - _Test create(GeneratedRef ref) { - final fn = _createCb ?? generated; - - return fn( - ref, - ); - } - @override GeneratedProvider $copyWithCreate( _Test Function( @@ -55,6 +46,12 @@ final class GeneratedProvider ) { return GeneratedProvider._(create: create); } + + @override + _Test create(GeneratedRef ref) { + final fn = _createCb ?? generated; + return fn(ref); + } } String _$generatedHash() => r'e49f3520d06ed50d34a44de613fdcd20b19f48d4'; @@ -68,7 +65,7 @@ final class GeneratedFamilyProvider with $Provider<_Test, GeneratedFamilyRef> { const GeneratedFamilyProvider._( {required GeneratedFamilyFamily super.from, - required (_Test,) super.argument, + required _Test super.argument, _Test Function( GeneratedFamilyRef ref, _Test test, @@ -93,16 +90,6 @@ final class GeneratedFamilyProvider $ProviderElement<_Test> createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - _Test create(GeneratedFamilyRef ref) { - final fn = _createCb ?? generatedFamily; - final (_Test,) argument = this.argument! as (_Test,); - return fn( - ref, - argument.$1, - ); - } - @override GeneratedFamilyProvider $copyWithCreate( _Test Function( @@ -110,7 +97,7 @@ final class GeneratedFamilyProvider ) create, ) { return GeneratedFamilyProvider._( - argument: argument! as (_Test,), + argument: argument as _Test, from: from! as GeneratedFamilyFamily, create: ( ref, @@ -119,6 +106,16 @@ final class GeneratedFamilyProvider create(ref)); } + @override + _Test create(GeneratedFamilyRef ref) { + final fn = _createCb ?? generatedFamily; + final _Test argument = this.argument as _Test; + return fn( + ref, + argument, + ); + } + @override bool operator ==(Object other) { return other is GeneratedFamilyProvider && other.argument == argument; @@ -139,20 +136,13 @@ final class GeneratedFamilyFamily extends Family { GeneratedFamilyProvider call( _Test test, ) => - GeneratedFamilyProvider._(argument: (test,), from: this); + GeneratedFamilyProvider._(argument: test, from: this); @override String debugGetCreateSourceHash() => _$generatedFamilyHash(); @override String toString() => r'generatedFamily'; - - Override overrideWith( - _Test Function( - GeneratedFamilyRef ref, - (_Test,) args, - ) create, - ) {} } typedef $DynamicRef = Ref; @@ -187,15 +177,6 @@ final class $DynamicProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - Object? create($DynamicRef ref) { - final fn = _createCb ?? $dynamic; - - return fn( - ref, - ); - } - @override $DynamicProvider $copyWithCreate( Object? Function( @@ -204,6 +185,12 @@ final class $DynamicProvider ) { return $DynamicProvider._(create: create); } + + @override + Object? create($DynamicRef ref) { + final fn = _createCb ?? $dynamic; + return fn(ref); + } } String _$$dynamicHash() => r'f62d63d9340f30b253e687f76deacd8205fed0e7'; @@ -217,10 +204,10 @@ final class $DynamicFamilyProvider with $Provider { const $DynamicFamilyProvider._( {required $DynamicFamilyFamily super.from, - required (dynamic,) super.argument, + required dynamic super.argument, Object? Function( $DynamicFamilyRef ref, - test, + dynamic test, )? create}) : _createCb = create, super( @@ -232,7 +219,7 @@ final class $DynamicFamilyProvider final Object? Function( $DynamicFamilyRef ref, - test, + dynamic test, )? _createCb; @override @@ -242,16 +229,6 @@ final class $DynamicFamilyProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - Object? create($DynamicFamilyRef ref) { - final fn = _createCb ?? $dynamicFamily; - final (dynamic,) argument = this.argument! as (dynamic,); - return fn( - ref, - argument.$1, - ); - } - @override $DynamicFamilyProvider $copyWithCreate( Object? Function( @@ -259,15 +236,25 @@ final class $DynamicFamilyProvider ) create, ) { return $DynamicFamilyProvider._( - argument: argument! as (dynamic,), + argument: argument as dynamic, from: from! as $DynamicFamilyFamily, create: ( ref, - test, + dynamic test, ) => create(ref)); } + @override + Object? create($DynamicFamilyRef ref) { + final fn = _createCb ?? $dynamicFamily; + final dynamic argument = this.argument as dynamic; + return fn( + ref, + argument, + ); + } + @override bool operator ==(Object other) { return other is $DynamicFamilyProvider && other.argument == argument; @@ -286,22 +273,15 @@ final class $DynamicFamilyFamily extends Family { ); $DynamicFamilyProvider call( - test, + dynamic test, ) => - $DynamicFamilyProvider._(argument: (test,), from: this); + $DynamicFamilyProvider._(argument: test, from: this); @override String debugGetCreateSourceHash() => _$$dynamicFamilyHash(); @override String toString() => r'$dynamicFamily'; - - Override overrideWith( - Object? Function( - $DynamicFamilyRef ref, - (dynamic,) args, - ) create, - ) {} } typedef _DynamicRef = Ref; @@ -313,10 +293,10 @@ final class _DynamicProvider with $Provider { const _DynamicProvider._( {required _DynamicFamily super.from, - required (dynamic,) super.argument, + required dynamic super.argument, Object? Function( _DynamicRef ref, - test, + dynamic test, )? create}) : _createCb = create, super( @@ -328,7 +308,7 @@ final class _DynamicProvider final Object? Function( _DynamicRef ref, - test, + dynamic test, )? _createCb; @override @@ -338,16 +318,6 @@ final class _DynamicProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - Object? create(_DynamicRef ref) { - final fn = _createCb ?? _dynamic; - final (dynamic,) argument = this.argument! as (dynamic,); - return fn( - ref, - argument.$1, - ); - } - @override _DynamicProvider $copyWithCreate( Object? Function( @@ -355,15 +325,25 @@ final class _DynamicProvider ) create, ) { return _DynamicProvider._( - argument: argument! as (dynamic,), + argument: argument as dynamic, from: from! as _DynamicFamily, create: ( ref, - test, + dynamic test, ) => create(ref)); } + @override + Object? create(_DynamicRef ref) { + final fn = _createCb ?? _dynamic; + final dynamic argument = this.argument as dynamic; + return fn( + ref, + argument, + ); + } + @override bool operator ==(Object other) { return other is _DynamicProvider && other.argument == argument; @@ -382,22 +362,15 @@ final class _DynamicFamily extends Family { ); _DynamicProvider call( - test, + dynamic test, ) => - _DynamicProvider._(argument: (test,), from: this); + _DynamicProvider._(argument: test, from: this); @override String debugGetCreateSourceHash() => _$dynamicHash(); @override String toString() => r'_dynamic'; - - Override overrideWith( - Object? Function( - _DynamicRef ref, - (dynamic,) args, - ) create, - ) {} } typedef AliasRef = Ref>; @@ -433,15 +406,6 @@ final class AliasProvider ProviderContainer container) => $ProviderElement(this, container); - @override - r.AsyncValue create(AliasRef ref) { - final fn = _createCb ?? alias; - - return fn( - ref, - ); - } - @override AliasProvider $copyWithCreate( r.AsyncValue Function( @@ -450,6 +414,12 @@ final class AliasProvider ) { return AliasProvider._(create: create); } + + @override + r.AsyncValue create(AliasRef ref) { + final fn = _createCb ?? alias; + return fn(ref); + } } String _$aliasHash() => r'cc08ec4cc5ec0dc98bdb7f4dcbc035021b09bcf3'; @@ -464,7 +434,7 @@ final class AliasFamilyProvider extends $FunctionalProvider< AliasFamilyRef> with $Provider, AliasFamilyRef> { const AliasFamilyProvider._( {required AliasFamilyFamily super.from, - required (r.AsyncValue,) super.argument, + required r.AsyncValue super.argument, r.AsyncValue Function( AliasFamilyRef ref, r.AsyncValue test, @@ -490,17 +460,6 @@ final class AliasFamilyProvider extends $FunctionalProvider< ProviderContainer container) => $ProviderElement(this, container); - @override - r.AsyncValue create(AliasFamilyRef ref) { - final fn = _createCb ?? aliasFamily; - final (r.AsyncValue,) argument = - this.argument! as (r.AsyncValue,); - return fn( - ref, - argument.$1, - ); - } - @override AliasFamilyProvider $copyWithCreate( r.AsyncValue Function( @@ -508,7 +467,7 @@ final class AliasFamilyProvider extends $FunctionalProvider< ) create, ) { return AliasFamilyProvider._( - argument: argument! as (r.AsyncValue,), + argument: argument as r.AsyncValue, from: from! as AliasFamilyFamily, create: ( ref, @@ -517,6 +476,16 @@ final class AliasFamilyProvider extends $FunctionalProvider< create(ref)); } + @override + r.AsyncValue create(AliasFamilyRef ref) { + final fn = _createCb ?? aliasFamily; + final r.AsyncValue argument = this.argument as r.AsyncValue; + return fn( + ref, + argument, + ); + } + @override bool operator ==(Object other) { return other is AliasFamilyProvider && other.argument == argument; @@ -537,20 +506,13 @@ final class AliasFamilyFamily extends Family { AliasFamilyProvider call( r.AsyncValue test, ) => - AliasFamilyProvider._(argument: (test,), from: this); + AliasFamilyProvider._(argument: test, from: this); @override String debugGetCreateSourceHash() => _$aliasFamilyHash(); @override String toString() => r'aliasFamily'; - - Override overrideWith( - r.AsyncValue Function( - AliasFamilyRef ref, - (r.AsyncValue,) args, - ) create, - ) {} } const generatedClassProvider = GeneratedClassProvider._(); @@ -617,7 +579,7 @@ final class GeneratedClassFamilyProvider extends $NotifierProvider { const GeneratedClassFamilyProvider._( {required GeneratedClassFamilyFamily super.from, - required (_Test,) super.argument, + required _Test super.argument, super.runNotifierBuildOverride, GeneratedClassFamily Function()? create}) : _createCb = create, @@ -643,7 +605,7 @@ final class GeneratedClassFamilyProvider GeneratedClassFamily Function() create, ) { return GeneratedClassFamilyProvider._( - argument: argument! as (_Test,), + argument: argument as _Test, from: from! as GeneratedClassFamilyFamily, create: create); } @@ -654,7 +616,7 @@ final class GeneratedClassFamilyProvider _Test Function(Ref<_Test>, GeneratedClassFamily) build, ) { return GeneratedClassFamilyProvider._( - argument: argument! as (_Test,), + argument: argument as _Test, from: from! as GeneratedClassFamilyFamily, runNotifierBuildOverride: build); } @@ -686,22 +648,13 @@ final class GeneratedClassFamilyFamily extends Family { GeneratedClassFamilyProvider call( _Test test, ) => - GeneratedClassFamilyProvider._(argument: (test,), from: this); + GeneratedClassFamilyProvider._(argument: test, from: this); @override String debugGetCreateSourceHash() => _$generatedClassFamilyHash(); @override String toString() => r'GeneratedClassFamily'; - - Override overrideWith( - _Test Function( - Ref<_Test> ref, - (_Test,) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$GeneratedClassFamily extends $Notifier<_Test> { @@ -784,7 +737,7 @@ final class $DynamicClassFamilyProvider extends $NotifierProvider<$DynamicClassFamily, Object?> { const $DynamicClassFamilyProvider._( {required $DynamicClassFamilyFamily super.from, - required (dynamic,) super.argument, + required dynamic super.argument, super.runNotifierBuildOverride, $DynamicClassFamily Function()? create}) : _createCb = create, @@ -810,7 +763,7 @@ final class $DynamicClassFamilyProvider $DynamicClassFamily Function() create, ) { return $DynamicClassFamilyProvider._( - argument: argument! as (dynamic,), + argument: argument as dynamic, from: from! as $DynamicClassFamilyFamily, create: create); } @@ -821,7 +774,7 @@ final class $DynamicClassFamilyProvider Object? Function(Ref, $DynamicClassFamily) build, ) { return $DynamicClassFamilyProvider._( - argument: argument! as (dynamic,), + argument: argument as dynamic, from: from! as $DynamicClassFamilyFamily, runNotifierBuildOverride: build); } @@ -851,33 +804,24 @@ final class $DynamicClassFamilyFamily extends Family { ); $DynamicClassFamilyProvider call( - test, + dynamic test, ) => - $DynamicClassFamilyProvider._(argument: (test,), from: this); + $DynamicClassFamilyProvider._(argument: test, from: this); @override String debugGetCreateSourceHash() => _$$dynamicClassFamilyHash(); @override String toString() => r'$DynamicClassFamily'; - - Override overrideWith( - Object? Function( - Ref ref, - (dynamic,) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$$DynamicClassFamily extends $Notifier { late final _$args = (ref as $NotifierProviderElement).origin.argument as (dynamic,); - get test => _$args.$1; + dynamic get test => _$args.$1; Object? build( - test, + dynamic test, ); @$internal @@ -951,7 +895,7 @@ final class AliasClassFamilyProvider extends $NotifierProvider> { const AliasClassFamilyProvider._( {required AliasClassFamilyFamily super.from, - required (r.AsyncValue,) super.argument, + required r.AsyncValue super.argument, super.runNotifierBuildOverride, AliasClassFamily Function()? create}) : _createCb = create, @@ -977,7 +921,7 @@ final class AliasClassFamilyProvider AliasClassFamily Function() create, ) { return AliasClassFamilyProvider._( - argument: argument! as (r.AsyncValue,), + argument: argument as r.AsyncValue, from: from! as AliasClassFamilyFamily, create: create); } @@ -988,7 +932,7 @@ final class AliasClassFamilyProvider r.AsyncValue Function(Ref>, AliasClassFamily) build, ) { return AliasClassFamilyProvider._( - argument: argument! as (r.AsyncValue,), + argument: argument as r.AsyncValue, from: from! as AliasClassFamilyFamily, runNotifierBuildOverride: build); } @@ -1019,22 +963,13 @@ final class AliasClassFamilyFamily extends Family { AliasClassFamilyProvider call( r.AsyncValue test, ) => - AliasClassFamilyProvider._(argument: (test,), from: this); + AliasClassFamilyProvider._(argument: test, from: this); @override String debugGetCreateSourceHash() => _$aliasClassFamilyHash(); @override String toString() => r'AliasClassFamily'; - - Override overrideWith( - r.AsyncValue Function( - Ref> ref, - (r.AsyncValue,) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$AliasClassFamily extends $Notifier> { diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index f08401c5a..1c7e96e18 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -38,15 +38,6 @@ final class SimpleProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - String create(SimpleRef ref) { - final fn = _createCb ?? simple; - - return fn( - ref, - ); - } - @override SimpleProvider $copyWithCreate( String Function( @@ -55,6 +46,12 @@ final class SimpleProvider ) { return SimpleProvider._(create: create); } + + @override + String create(SimpleRef ref) { + final fn = _createCb ?? simple; + return fn(ref); + } } String _$simpleHash() => r'ff9f7451526aef5b3af6646814631a502ad76a5f'; @@ -91,15 +88,6 @@ final class Simple2Provider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - String create(Simple2Ref ref) { - final fn = _createCb ?? simple2; - - return fn( - ref, - ); - } - @override Simple2Provider $copyWithCreate( String Function( @@ -108,6 +96,12 @@ final class Simple2Provider ) { return Simple2Provider._(create: create); } + + @override + String create(Simple2Ref ref) { + final fn = _createCb ?? simple2; + return fn(ref); + } } String _$simple2Hash() => r'06327442776394c5c9cbb33b048d7a42e709e7fd'; diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 56ff2c83e..7c059ea16 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -37,15 +37,6 @@ final class ScopedProvider extends $FunctionalProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(ScopedRef ref) { - final fn = _createCb ?? scoped; - - return fn( - ref, - ); - } - @override ScopedProvider $copyWithCreate( int Function( @@ -54,6 +45,12 @@ final class ScopedProvider extends $FunctionalProvider ) { return ScopedProvider._(create: create); } + + @override + int create(ScopedRef ref) { + final fn = _createCb ?? scoped; + return fn(ref); + } } String _$scopedHash() => r'590f1a203323105e732397a2616fbd7dac65f0cc'; diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index 9c61ab693..2e3ad7024 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -37,15 +37,6 @@ final class Counter2Provider extends $FunctionalProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(Counter2Ref ref) { - final fn = _createCb ?? counter2; - - return fn( - ref, - ); - } - @override Counter2Provider $copyWithCreate( int Function( @@ -54,6 +45,12 @@ final class Counter2Provider extends $FunctionalProvider ) { return Counter2Provider._(create: create); } + + @override + int create(Counter2Ref ref) { + final fn = _createCb ?? counter2; + return fn(ref); + } } String _$counter2Hash() => r'9328919066a683f85226fc59201bb7c54f107a7d'; @@ -89,15 +86,6 @@ final class CounterProvider extends $FunctionalProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - int create(CounterRef ref) { - final fn = _createCb ?? counter; - - return fn( - ref, - ); - } - @override CounterProvider $copyWithCreate( int Function( @@ -106,6 +94,12 @@ final class CounterProvider extends $FunctionalProvider ) { return CounterProvider._(create: create); } + + @override + int create(CounterRef ref) { + final fn = _createCb ?? counter; + return fn(ref); + } } String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 2a6e73456..78ad186cf 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -38,15 +38,6 @@ final class GenericProvider extends $FunctionalProvider< $StreamProviderElement> createElement(ProviderContainer container) => $StreamProviderElement(this, container); - @override - Stream> create(GenericRef ref) { - final fn = _createCb ?? generic; - - return fn( - ref, - ); - } - @override GenericProvider $copyWithCreate( Stream> Function( @@ -56,6 +47,12 @@ final class GenericProvider extends $FunctionalProvider< return GenericProvider._(from: from! as GenericFamily, create: create); } + @override + Stream> create(GenericRef ref) { + final fn = _createCb ?? generic; + return fn(ref); + } + @override bool operator ==(Object other) { return other is GenericProvider && @@ -82,10 +79,6 @@ final class GenericFamily extends Family { @override String toString() => r'generic'; - - Override overrideWith( - Stream> Function(GenericRef ref) create, - ) {} } typedef PublicRef = Ref>; @@ -120,15 +113,6 @@ final class PublicProvider $StreamProviderElement createElement(ProviderContainer container) => $StreamProviderElement(this, container); - @override - Stream create(PublicRef ref) { - final fn = _createCb ?? public; - - return fn( - ref, - ); - } - @override PublicProvider $copyWithCreate( Stream Function( @@ -137,6 +121,12 @@ final class PublicProvider ) { return PublicProvider._(create: create); } + + @override + Stream create(PublicRef ref) { + final fn = _createCb ?? public; + return fn(ref); + } } String _$publicHash() => r'c5cc0eac434371901cf6ab159a81bba49c58da12'; @@ -173,15 +163,6 @@ final class _PrivateProvider $StreamProviderElement createElement(ProviderContainer container) => $StreamProviderElement(this, container); - @override - Stream create(_PrivateRef ref) { - final fn = _createCb ?? _private; - - return fn( - ref, - ); - } - @override _PrivateProvider $copyWithCreate( Stream Function( @@ -190,6 +171,12 @@ final class _PrivateProvider ) { return _PrivateProvider._(create: create); } + + @override + Stream create(_PrivateRef ref) { + final fn = _createCb ?? _private; + return fn(ref); + } } String _$privateHash() => r'bbee0c7e27bda81346b5f52c96b23b2e48f83077'; @@ -243,32 +230,6 @@ final class FamilyProvider $StreamProviderElement createElement(ProviderContainer container) => $StreamProviderElement(this, container); - @override - Stream create(FamilyRef ref) { - final fn = _createCb ?? family; - final ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) argument = this.argument! as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }); - return fn( - ref, - argument.$1, - second: argument.second, - third: argument.third, - fourth: argument.fourth, - fifth: argument.fifth, - ); - } - @override FamilyProvider $copyWithCreate( Stream Function( @@ -276,7 +237,7 @@ final class FamilyProvider ) create, ) { return FamilyProvider._( - argument: argument! as ( + argument: argument as ( int, { String? second, double third, @@ -295,6 +256,32 @@ final class FamilyProvider create(ref)); } + @override + Stream create(FamilyRef ref) { + final fn = _createCb ?? family; + final ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) argument = this.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + return fn( + ref, + argument.$1, + second: argument.second, + third: argument.third, + fourth: argument.fourth, + fifth: argument.fifth, + ); + } + @override bool operator ==(Object other) { return other is FamilyProvider && other.argument == argument; @@ -332,19 +319,6 @@ final class FamilyFamily extends Family { @override String toString() => r'family'; - - Override overrideWith( - Stream Function( - FamilyRef ref, - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) args, - ) create, - ) {} } const genericClassProvider = GenericClassFamily._(); @@ -424,12 +398,6 @@ final class GenericClassFamily extends Family { @override String toString() => r'GenericClass'; - - Override overrideWith( - Stream> Function(Ref>> re) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$GenericClass extends $StreamNotifier> { @@ -595,7 +563,7 @@ final class FamilyClassProvider FamilyClass Function() create, ) { return FamilyClassProvider._( - argument: argument! as ( + argument: argument as ( int, { String? second, double third, @@ -612,7 +580,7 @@ final class FamilyClassProvider Stream Function(Ref>, FamilyClass) build, ) { return FamilyClassProvider._( - argument: argument! as ( + argument: argument as ( int, { String? second, double third, @@ -666,21 +634,6 @@ final class FamilyClassFamily extends Family { @override String toString() => r'FamilyClass'; - - Override overrideWith( - Stream Function( - Ref> ref, - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$FamilyClass extends $StreamNotifier { diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 2ddb6c083..9b57c3f4c 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -38,15 +38,6 @@ final class GenericProvider $ProviderElement> createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - List create(GenericRef ref) { - final fn = _createCb ?? generic; - - return fn( - ref, - ); - } - @override GenericProvider $copyWithCreate( List Function( @@ -56,6 +47,12 @@ final class GenericProvider return GenericProvider._(from: from! as GenericFamily, create: create); } + @override + List create(GenericRef ref) { + final fn = _createCb ?? generic; + return fn(ref); + } + @override bool operator ==(Object other) { return other is GenericProvider && @@ -82,10 +79,6 @@ final class GenericFamily extends Family { @override String toString() => r'generic'; - - Override overrideWith( - List Function(GenericRef ref) create, - ) {} } typedef ComplexGenericRef = Ref>; @@ -128,23 +121,6 @@ final class ComplexGenericProvider $ProviderElement> createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - List create(ComplexGenericRef ref) { - final fn = _createCb ?? complexGeneric; - final ({ - T param, - Foo? otherParam, - }) argument = this.argument! as ({ - T param, - Foo? otherParam, - }); - return fn( - ref, - param: argument.param, - otherParam: argument.otherParam, - ); - } - @override ComplexGenericProvider $copyWithCreate( List Function( @@ -152,7 +128,7 @@ final class ComplexGenericProvider ) create, ) { return ComplexGenericProvider._( - argument: argument! as ({ + argument: argument as ({ T param, Foo? otherParam, }), @@ -165,6 +141,23 @@ final class ComplexGenericProvider create(ref)); } + @override + List create(ComplexGenericRef ref) { + final fn = _createCb ?? complexGeneric; + final ({ + T param, + Foo? otherParam, + }) argument = this.argument as ({ + T param, + Foo? otherParam, + }); + return fn( + ref, + param: argument.param, + otherParam: argument.otherParam, + ); + } + @override bool operator ==(Object other) { return other is ComplexGenericProvider && @@ -198,16 +191,6 @@ final class ComplexGenericFamily extends Family { @override String toString() => r'complexGeneric'; - - Override overrideWith( - List Function( - ComplexGenericRef ref, - ({ - T param, - Foo? otherParam, - }) args, - ) create, - ) {} } typedef RawFutureRef = Ref>>; @@ -244,15 +227,6 @@ final class RawFutureProvider extends $FunctionalProvider< ProviderContainer container) => $ProviderElement(this, container); - @override - Raw> create(RawFutureRef ref) { - final fn = _createCb ?? rawFuture; - - return fn( - ref, - ); - } - @override RawFutureProvider $copyWithCreate( Raw> Function( @@ -261,6 +235,12 @@ final class RawFutureProvider extends $FunctionalProvider< ) { return RawFutureProvider._(create: create); } + + @override + Raw> create(RawFutureRef ref) { + final fn = _createCb ?? rawFuture; + return fn(ref); + } } String _$rawFutureHash() => r'5203a56065b768023770326281618e3229ccb530'; @@ -299,15 +279,6 @@ final class RawStreamProvider extends $FunctionalProvider< ProviderContainer container) => $ProviderElement(this, container); - @override - Raw> create(RawStreamRef ref) { - final fn = _createCb ?? rawStream; - - return fn( - ref, - ); - } - @override RawStreamProvider $copyWithCreate( Raw> Function( @@ -316,6 +287,12 @@ final class RawStreamProvider extends $FunctionalProvider< ) { return RawStreamProvider._(create: create); } + + @override + Raw> create(RawStreamRef ref) { + final fn = _createCb ?? rawStream; + return fn(ref); + } } String _$rawStreamHash() => r'2b764189753a8b74f47ba557a79416f00ef5cebd'; @@ -329,7 +306,7 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< with $Provider>, RawFamilyFutureRef> { const RawFamilyFutureProvider._( {required RawFamilyFutureFamily super.from, - required (int,) super.argument, + required int super.argument, Raw> Function( RawFamilyFutureRef ref, int id, @@ -355,16 +332,6 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< ProviderContainer container) => $ProviderElement(this, container); - @override - Raw> create(RawFamilyFutureRef ref) { - final fn = _createCb ?? rawFamilyFuture; - final (int,) argument = this.argument! as (int,); - return fn( - ref, - argument.$1, - ); - } - @override RawFamilyFutureProvider $copyWithCreate( Raw> Function( @@ -372,7 +339,7 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< ) create, ) { return RawFamilyFutureProvider._( - argument: argument! as (int,), + argument: argument as int, from: from! as RawFamilyFutureFamily, create: ( ref, @@ -381,6 +348,16 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< create(ref)); } + @override + Raw> create(RawFamilyFutureRef ref) { + final fn = _createCb ?? rawFamilyFuture; + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } + @override bool operator ==(Object other) { return other is RawFamilyFutureProvider && other.argument == argument; @@ -401,20 +378,13 @@ final class RawFamilyFutureFamily extends Family { RawFamilyFutureProvider call( int id, ) => - RawFamilyFutureProvider._(argument: (id,), from: this); + RawFamilyFutureProvider._(argument: id, from: this); @override String debugGetCreateSourceHash() => _$rawFamilyFutureHash(); @override String toString() => r'rawFamilyFuture'; - - Override overrideWith( - Raw> Function( - RawFamilyFutureRef ref, - (int,) args, - ) create, - ) {} } typedef RawFamilyStreamRef = Ref>>; @@ -426,7 +396,7 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< with $Provider>, RawFamilyStreamRef> { const RawFamilyStreamProvider._( {required RawFamilyStreamFamily super.from, - required (int,) super.argument, + required int super.argument, Raw> Function( RawFamilyStreamRef ref, int id, @@ -452,16 +422,6 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< ProviderContainer container) => $ProviderElement(this, container); - @override - Raw> create(RawFamilyStreamRef ref) { - final fn = _createCb ?? rawFamilyStream; - final (int,) argument = this.argument! as (int,); - return fn( - ref, - argument.$1, - ); - } - @override RawFamilyStreamProvider $copyWithCreate( Raw> Function( @@ -469,7 +429,7 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< ) create, ) { return RawFamilyStreamProvider._( - argument: argument! as (int,), + argument: argument as int, from: from! as RawFamilyStreamFamily, create: ( ref, @@ -478,6 +438,16 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< create(ref)); } + @override + Raw> create(RawFamilyStreamRef ref) { + final fn = _createCb ?? rawFamilyStream; + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } + @override bool operator ==(Object other) { return other is RawFamilyStreamProvider && other.argument == argument; @@ -498,20 +468,13 @@ final class RawFamilyStreamFamily extends Family { RawFamilyStreamProvider call( int id, ) => - RawFamilyStreamProvider._(argument: (id,), from: this); + RawFamilyStreamProvider._(argument: id, from: this); @override String debugGetCreateSourceHash() => _$rawFamilyStreamHash(); @override String toString() => r'rawFamilyStream'; - - Override overrideWith( - Raw> Function( - RawFamilyStreamRef ref, - (int,) args, - ) create, - ) {} } typedef PublicRef = Ref; @@ -546,15 +509,6 @@ final class PublicProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - String create(PublicRef ref) { - final fn = _createCb ?? public; - - return fn( - ref, - ); - } - @override PublicProvider $copyWithCreate( String Function( @@ -563,6 +517,12 @@ final class PublicProvider ) { return PublicProvider._(create: create); } + + @override + String create(PublicRef ref) { + final fn = _createCb ?? public; + return fn(ref); + } } String _$publicHash() => r'138be35943899793ab085e711fe3f3d22696a3ba'; @@ -599,15 +559,6 @@ final class Supports$inNamesProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - String create(Supports$inNamesRef ref) { - final fn = _createCb ?? supports$inNames; - - return fn( - ref, - ); - } - @override Supports$inNamesProvider $copyWithCreate( String Function( @@ -616,6 +567,12 @@ final class Supports$inNamesProvider ) { return Supports$inNamesProvider._(create: create); } + + @override + String create(Supports$inNamesRef ref) { + final fn = _createCb ?? supports$inNames; + return fn(ref); + } } String _$supports$inNamesHash() => r'cbf929802fcbd0aa949ad72743d096fb3ef5f28f'; @@ -669,32 +626,6 @@ final class FamilyProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - String create(FamilyRef ref) { - final fn = _createCb ?? family; - final ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) argument = this.argument! as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }); - return fn( - ref, - argument.$1, - second: argument.second, - third: argument.third, - fourth: argument.fourth, - fifth: argument.fifth, - ); - } - @override FamilyProvider $copyWithCreate( String Function( @@ -702,7 +633,7 @@ final class FamilyProvider ) create, ) { return FamilyProvider._( - argument: argument! as ( + argument: argument as ( int, { String? second, double third, @@ -721,6 +652,32 @@ final class FamilyProvider create(ref)); } + @override + String create(FamilyRef ref) { + final fn = _createCb ?? family; + final ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) argument = this.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + return fn( + ref, + argument.$1, + second: argument.second, + third: argument.third, + fourth: argument.fourth, + fifth: argument.fifth, + ); + } + @override bool operator ==(Object other) { return other is FamilyProvider && other.argument == argument; @@ -758,19 +715,6 @@ final class FamilyFamily extends Family { @override String toString() => r'family'; - - Override overrideWith( - String Function( - FamilyRef ref, - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) args, - ) create, - ) {} } typedef _PrivateRef = Ref; @@ -805,15 +749,6 @@ final class _PrivateProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - String create(_PrivateRef ref) { - final fn = _createCb ?? _private; - - return fn( - ref, - ); - } - @override _PrivateProvider $copyWithCreate( String Function( @@ -822,6 +757,12 @@ final class _PrivateProvider ) { return _PrivateProvider._(create: create); } + + @override + String create(_PrivateRef ref) { + final fn = _createCb ?? _private; + return fn(ref); + } } String _$privateHash() => r'519561bc7e88e394d7f75ca2102a5c0acc832c66'; @@ -858,15 +799,6 @@ final class GeneratedProvider $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); - @override - String create(GeneratedRef ref) { - final fn = _createCb ?? generated; - - return fn( - ref, - ); - } - @override GeneratedProvider $copyWithCreate( String Function( @@ -875,6 +807,12 @@ final class GeneratedProvider ) { return GeneratedProvider._(create: create); } + + @override + String create(GeneratedRef ref) { + final fn = _createCb ?? generated; + return fn(ref); + } } String _$generatedHash() => r'fecbc1d5d9a05fc996b452a57fd1975ff368af91'; @@ -956,12 +894,6 @@ final class GenericClassFamily extends Family { @override String toString() => r'GenericClass'; - - Override overrideWith( - List Function(Ref> re) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$GenericClass extends $Notifier> { @@ -1096,7 +1028,7 @@ final class RawFamilyFutureClassProvider extends $NotifierProvider>> { const RawFamilyFutureClassProvider._( {required RawFamilyFutureClassFamily super.from, - required (int,) super.argument, + required int super.argument, super.runNotifierBuildOverride, RawFamilyFutureClass Function()? create}) : _createCb = create, @@ -1122,7 +1054,7 @@ final class RawFamilyFutureClassProvider RawFamilyFutureClass Function() create, ) { return RawFamilyFutureClassProvider._( - argument: argument! as (int,), + argument: argument as int, from: from! as RawFamilyFutureClassFamily, create: create); } @@ -1134,7 +1066,7 @@ final class RawFamilyFutureClassProvider build, ) { return RawFamilyFutureClassProvider._( - argument: argument! as (int,), + argument: argument as int, from: from! as RawFamilyFutureClassFamily, runNotifierBuildOverride: build); } @@ -1166,22 +1098,13 @@ final class RawFamilyFutureClassFamily extends Family { RawFamilyFutureClassProvider call( int id, ) => - RawFamilyFutureClassProvider._(argument: (id,), from: this); + RawFamilyFutureClassProvider._(argument: id, from: this); @override String debugGetCreateSourceHash() => _$rawFamilyFutureClassHash(); @override String toString() => r'RawFamilyFutureClass'; - - Override overrideWith( - Raw> Function( - Ref>> ref, - (int,) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$RawFamilyFutureClass extends $Notifier>> { @@ -1206,7 +1129,7 @@ final class RawFamilyStreamClassProvider extends $NotifierProvider>> { const RawFamilyStreamClassProvider._( {required RawFamilyStreamClassFamily super.from, - required (int,) super.argument, + required int super.argument, super.runNotifierBuildOverride, RawFamilyStreamClass Function()? create}) : _createCb = create, @@ -1232,7 +1155,7 @@ final class RawFamilyStreamClassProvider RawFamilyStreamClass Function() create, ) { return RawFamilyStreamClassProvider._( - argument: argument! as (int,), + argument: argument as int, from: from! as RawFamilyStreamClassFamily, create: create); } @@ -1244,7 +1167,7 @@ final class RawFamilyStreamClassProvider build, ) { return RawFamilyStreamClassProvider._( - argument: argument! as (int,), + argument: argument as int, from: from! as RawFamilyStreamClassFamily, runNotifierBuildOverride: build); } @@ -1276,22 +1199,13 @@ final class RawFamilyStreamClassFamily extends Family { RawFamilyStreamClassProvider call( int id, ) => - RawFamilyStreamClassProvider._(argument: (id,), from: this); + RawFamilyStreamClassProvider._(argument: id, from: this); @override String debugGetCreateSourceHash() => _$rawFamilyStreamClassHash(); @override String toString() => r'RawFamilyStreamClass'; - - Override overrideWith( - Raw> Function( - Ref>> ref, - (int,) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$RawFamilyStreamClass extends $Notifier>> { @@ -1463,7 +1377,7 @@ final class FamilyClassProvider extends $NotifierProvider { FamilyClass Function() create, ) { return FamilyClassProvider._( - argument: argument! as ( + argument: argument as ( int, { String? second, double third, @@ -1480,7 +1394,7 @@ final class FamilyClassProvider extends $NotifierProvider { String Function(Ref, FamilyClass) build, ) { return FamilyClassProvider._( - argument: argument! as ( + argument: argument as ( int, { String? second, double third, @@ -1534,21 +1448,6 @@ final class FamilyClassFamily extends Family { @override String toString() => r'FamilyClass'; - - Override overrideWith( - String Function( - Ref ref, - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) args, - ) create, - ) {} - - Override overrideWithBuild() {} } abstract class _$FamilyClass extends $Notifier { From b640ddd2abf79d9e4f907893bcab6481eb7f8c21 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 21:14:40 +0100 Subject: [PATCH 164/387] Fix some tests --- .../integration/build_yaml/lib/main.g.dart | 275 ++++++- .../lib/src/riverpod_generator.dart | 47 +- .../lib/src/templates/family.dart | 138 ++-- .../lib/src/templates/notifier.dart | 17 +- .../lib/src/templates/provider.dart | 65 +- .../test/integration/annotated.g.dart | 68 +- .../test/integration/async.g.dart | 306 +++++++- .../test/integration/dependencies.g.dart | 158 +++- .../test/integration/dependencies2.g.dart | 94 ++- .../test/integration/generated.g.dart | 305 +++++++- .../test/integration/hash/hash1.g.dart | 5 +- .../test/integration/scopes.g.dart | 5 +- .../test/integration/stream.g.dart | 219 +++++- .../test/integration/sync.dart | 7 +- .../test/integration/sync.g.dart | 688 ++++++++++++++++-- .../riverpod_generator/test/sync_test.dart | 66 +- 16 files changed, 2233 insertions(+), 230 deletions(-) diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index b002b1834..75bf2c150 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -184,6 +184,13 @@ final class Count2Provider extends $FunctionalProvider @override String debugGetCreateSourceHash() => _$count2Hash(); + @override + String toString() { + return r'count2ProviderFamily' + '' + '($argument)'; + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -240,7 +247,27 @@ final class Count2Family extends Family { String debugGetCreateSourceHash() => _$count2Hash(); @override - String toString() => r'count2'; + String toString() => r'count2ProviderFamily'; + + Override overrideWith( + int Function( + Count2Ref ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Count2Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } typedef CountFuture2Ref = Ref>; @@ -273,6 +300,13 @@ final class CountFuture2Provider @override String debugGetCreateSourceHash() => _$countFuture2Hash(); + @override + String toString() { + return r'countFuture2ProviderFamily' + '' + '($argument)'; + } + @override $FutureProviderElement createElement(ProviderContainer container) => $FutureProviderElement(this, container); @@ -329,7 +363,27 @@ final class CountFuture2Family extends Family { String debugGetCreateSourceHash() => _$countFuture2Hash(); @override - String toString() => r'countFuture2'; + String toString() => r'countFuture2ProviderFamily'; + + Override overrideWith( + FutureOr Function( + CountFuture2Ref ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as CountFuture2Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } typedef CountStream2Ref = Ref>; @@ -362,6 +416,13 @@ final class CountStream2Provider @override String debugGetCreateSourceHash() => _$countStream2Hash(); + @override + String toString() { + return r'countStream2ProviderFamily' + '' + '($argument)'; + } + @override $StreamProviderElement createElement(ProviderContainer container) => $StreamProviderElement(this, container); @@ -418,7 +479,27 @@ final class CountStream2Family extends Family { String debugGetCreateSourceHash() => _$countStream2Hash(); @override - String toString() => r'countStream2'; + String toString() => r'countStream2ProviderFamily'; + + Override overrideWith( + Stream Function( + CountStream2Ref ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as CountStream2Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } const countNotifierPod = CountNotifierProvider._(); @@ -457,7 +538,10 @@ final class CountNotifierProvider @$internal @override CountNotifierProvider $copyWithBuild( - int Function(Ref, CountNotifier) build, + int Function( + Ref, + CountNotifier, + ) build, ) { return CountNotifierProvider._(runNotifierBuildOverride: build); } @@ -515,7 +599,10 @@ final class CountAsyncNotifierProvider @$internal @override CountAsyncNotifierProvider $copyWithBuild( - FutureOr Function(Ref>, CountAsyncNotifier) build, + FutureOr Function( + Ref>, + CountAsyncNotifier, + ) build, ) { return CountAsyncNotifierProvider._(runNotifierBuildOverride: build); } @@ -574,7 +661,10 @@ final class CountStreamNotifierProvider @$internal @override CountStreamNotifierProvider $copyWithBuild( - Stream Function(Ref>, CountStreamNotifier) build, + Stream Function( + Ref>, + CountStreamNotifier, + ) build, ) { return CountStreamNotifierProvider._(runNotifierBuildOverride: build); } @@ -619,6 +709,13 @@ final class CountNotifier2Provider @override String debugGetCreateSourceHash() => _$countNotifier2Hash(); + @override + String toString() { + return r'countNotifier2ProviderFamily' + '' + '($argument)'; + } + @$internal @override CountNotifier2 create() => _createCb?.call() ?? CountNotifier2(); @@ -637,7 +734,10 @@ final class CountNotifier2Provider @$internal @override CountNotifier2Provider $copyWithBuild( - int Function(Ref, CountNotifier2) build, + int Function( + Ref, + CountNotifier2, + ) build, ) { return CountNotifier2Provider._( argument: argument as int, @@ -677,13 +777,48 @@ final class CountNotifier2Family extends Family { String debugGetCreateSourceHash() => _$countNotifier2Hash(); @override - String toString() => r'CountNotifier2'; + String toString() => r'countNotifier2ProviderFamily'; + + Override overrideWith( + CountNotifier2 Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as CountNotifier2Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + int Function(Ref ref, CountNotifier2 notifier, int argument) build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as CountNotifier2Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$CountNotifier2 extends $Notifier { - late final _$args = - (ref as $NotifierProviderElement).origin.argument as (int,); - int get a => _$args.$1; + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + int get a => _$args; int build( int a, @@ -692,7 +827,7 @@ abstract class _$CountNotifier2 extends $Notifier { @$internal @override int runBuild() => build( - _$args.$1, + _$args, ); } @@ -718,6 +853,13 @@ final class CountAsyncNotifier2Provider @override String debugGetCreateSourceHash() => _$countAsyncNotifier2Hash(); + @override + String toString() { + return r'countAsyncNotifier2ProviderFamily' + '' + '($argument)'; + } + @$internal @override CountAsyncNotifier2 create() => _createCb?.call() ?? CountAsyncNotifier2(); @@ -736,7 +878,10 @@ final class CountAsyncNotifier2Provider @$internal @override CountAsyncNotifier2Provider $copyWithBuild( - FutureOr Function(Ref>, CountAsyncNotifier2) build, + FutureOr Function( + Ref>, + CountAsyncNotifier2, + ) build, ) { return CountAsyncNotifier2Provider._( argument: argument as int, @@ -777,13 +922,51 @@ final class CountAsyncNotifier2Family extends Family { String debugGetCreateSourceHash() => _$countAsyncNotifier2Hash(); @override - String toString() => r'CountAsyncNotifier2'; + String toString() => r'countAsyncNotifier2ProviderFamily'; + + Override overrideWith( + CountAsyncNotifier2 Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as CountAsyncNotifier2Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + FutureOr Function(Ref> ref, + CountAsyncNotifier2 notifier, int argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as CountAsyncNotifier2Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$CountAsyncNotifier2 extends $AsyncNotifier { late final _$args = - (ref as $AsyncNotifierProviderElement).origin.argument as (int,); - int get a => _$args.$1; + (ref as $AsyncNotifierProviderElement).origin.argument as int; + int get a => _$args; FutureOr build( int a, @@ -792,7 +975,7 @@ abstract class _$CountAsyncNotifier2 extends $AsyncNotifier { @$internal @override FutureOr runBuild() => build( - _$args.$1, + _$args, ); } @@ -818,6 +1001,13 @@ final class CountStreamNotifier2Provider @override String debugGetCreateSourceHash() => _$countStreamNotifier2Hash(); + @override + String toString() { + return r'countStreamNotifier2ProviderFamily' + '' + '($argument)'; + } + @$internal @override CountStreamNotifier2 create() => _createCb?.call() ?? CountStreamNotifier2(); @@ -836,7 +1026,10 @@ final class CountStreamNotifier2Provider @$internal @override CountStreamNotifier2Provider $copyWithBuild( - Stream Function(Ref>, CountStreamNotifier2) build, + Stream Function( + Ref>, + CountStreamNotifier2, + ) build, ) { return CountStreamNotifier2Provider._( argument: argument as int, @@ -877,13 +1070,51 @@ final class CountStreamNotifier2Family extends Family { String debugGetCreateSourceHash() => _$countStreamNotifier2Hash(); @override - String toString() => r'CountStreamNotifier2'; + String toString() => r'countStreamNotifier2ProviderFamily'; + + Override overrideWith( + CountStreamNotifier2 Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as CountStreamNotifier2Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + Stream Function(Ref> ref, + CountStreamNotifier2 notifier, int argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as CountStreamNotifier2Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$CountStreamNotifier2 extends $StreamNotifier { late final _$args = - (ref as $StreamNotifierProviderElement).origin.argument as (int,); - int get a => _$args.$1; + (ref as $StreamNotifierProviderElement).origin.argument as int; + int get a => _$args; Stream build( int a, @@ -892,7 +1123,7 @@ abstract class _$CountStreamNotifier2 extends $StreamNotifier { @$internal @override Stream runBuild() => build( - _$args.$1, + _$args, ); } diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index d3e38412c..ba0b48fae 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -268,18 +268,13 @@ extension ProviderNames on GeneratorProviderDeclaration { String get providerTypeName => providerElement.providerTypeName; String get refImplName => providerElement.refImplName; - String get refWithGenerics { - switch (this) { - case FunctionalProviderDeclaration(): - return '${providerElement.refImplName}${generics()}'; - case ClassBasedProviderDeclaration(): - return '${providerElement.refImplName}<$exposedTypeDisplayString>'; - } - } String get familyTypeName => providerElement.familyTypeName; String get argumentRecordType { + // Encode the list of parameters into a record. + // We do so only if there are at least two parameters. + // TODO test switch (parameters) { case [_]: return parameters.first.typeDisplayString; @@ -323,8 +318,38 @@ extension ProviderNames on GeneratorProviderDeclaration { String genericsDefinition() => _genericDefinitionDisplayString(typeParameters); - String createType({bool withArguments = true}) { + String get refWithGenerics { + return switch (this) { + FunctionalProviderDeclaration() => '$refImplName${generics()}', + ClassBasedProviderDeclaration() => 'Ref<$exposedTypeDisplayString>', + }; + } + + String notifierBuildType({ + bool withGenericDefinition = false, + bool withArguments = false, + }) { + final genericsDefinition = + withGenericDefinition ? this.genericsDefinition() : ''; + final notifierType = '$name${generics()}'; + + final parameters = withArguments + ? buildParamDefinitionQuery( + this.parameters, + withDefaults: false, + ) + : ''; + + return '$createdTypeDisplayString Function$genericsDefinition($refWithGenerics, $notifierType, $parameters)'; + } + + String createType({ + bool withArguments = true, + bool withGenericDefinition = false, + }) { final generics = this.generics(); + final genericsDefinition = + withGenericDefinition ? this.genericsDefinition() : ''; final provider = this; switch (provider) { @@ -337,9 +362,9 @@ extension ProviderNames on GeneratorProviderDeclaration { : ''; final refType = '${provider.refImplName}$generics'; - return '${provider.createdTypeDisplayString} Function($refType ref, $params)'; + return '${provider.createdTypeDisplayString} Function$genericsDefinition($refType ref, $params)'; case ClassBasedProviderDeclaration(): - return '${provider.name}$generics Function()'; + return '${provider.name}$generics Function$genericsDefinition()'; } } diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 75bea0a10..b480bd0f7 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -18,6 +18,12 @@ class FamilyTemplate extends Template { late final _argumentRecordType = provider.argumentRecordType; + late final _generics = provider.generics(); + late final _genericsDefinition = provider.genericsDefinition(); + late final _parameterDefinition = + buildParamDefinitionQuery(provider.parameters); + late final _notifierType = '${provider.name}$_generics'; + @override void run(StringBuffer buffer) { if (!provider.providerElement.isFamily) return; @@ -26,11 +32,6 @@ class FamilyTemplate extends Template { // TODO add docs everywhere in generated code - final generics = provider.generics(); - final genericsDefinition = provider.genericsDefinition(); - - final parameterDefinition = buildParamDefinitionQuery(provider.parameters); - final parametersPassThrough = provider.argumentToRecord(); final argument = provider.parameters.isEmpty ? '' : 'argument: $parametersPassThrough,'; @@ -45,8 +46,8 @@ final class ${provider.familyTypeName} extends Family { ${provider.providerElement.isAutoDispose ? 'isAutoDispose: true,' : ''} ); - ${provider.providerTypeName}$generics call$genericsDefinition($parameterDefinition) - => ${provider.providerTypeName}$generics._( + ${provider.providerTypeName}$_generics call$_genericsDefinition($_parameterDefinition) + => ${provider.providerTypeName}$_generics._( $argument from: this ); @@ -55,14 +56,10 @@ final class ${provider.familyTypeName} extends Family { String debugGetCreateSourceHash() => ${provider.hashFnName}(); @override - String toString() => r'${provider.name}'; + String toString() => r'${provider.providerName(options)}'; '''); - // _writeOverrides( - // buffer, - // topLevelBuffer: topLevelBuffer, - // genericsDefinition: genericsDefinition, - // ); + _writeOverrides(buffer, topLevelBuffer: topLevelBuffer); buffer.writeln('}'); @@ -72,13 +69,11 @@ final class ${provider.familyTypeName} extends Family { void _writeOverrides( StringBuffer buffer, { required StringBuffer topLevelBuffer, - required String genericsDefinition, }) { // overrideWith _writeOverrideWith( buffer, topLevelBuffer: topLevelBuffer, - genericsDefinition: genericsDefinition, ); // overrideWithBuild @@ -95,26 +90,16 @@ final class ${provider.familyTypeName} extends Family { void _writeOverrideWith( StringBuffer buffer, { required StringBuffer topLevelBuffer, - required String genericsDefinition, }) { - // Encode the list of parameters into a record. - // We do so only if there are at least two parameters. - // TODO test - late final argumentsType = switch (provider.parameters) { - [final p] => p.typeDisplayString, - _ => - '(${buildParamDefinitionQuery(provider.parameters, asRecord: true)})', - }; - final createType = switch (provider) { FunctionalProviderDeclaration(parameters: [_, ...]) => - '${provider.createdTypeDisplayString} Function$genericsDefinition(${provider.refWithGenerics} ref, $argumentsType args,)', + '${provider.createdTypeDisplayString} Function$_genericsDefinition(${provider.refWithGenerics} ref, $_argumentRecordType args,)', FunctionalProviderDeclaration(parameters: []) => - '${provider.createdTypeDisplayString} Function$genericsDefinition(${provider.refWithGenerics} ref)', + '${provider.createdTypeDisplayString} Function$_genericsDefinition(${provider.refWithGenerics} ref)', ClassBasedProviderDeclaration(parameters: [_, ...]) => - '${provider.createdTypeDisplayString} Function$genericsDefinition(${provider.refWithGenerics} ref, $argumentsType args,)', + '$_notifierType Function$_genericsDefinition($_argumentRecordType args,)', ClassBasedProviderDeclaration() => - '${provider.createdTypeDisplayString} Function$genericsDefinition(${provider.refWithGenerics} re)', + '$_notifierType Function$_genericsDefinition()', }; // TODO docs @@ -123,24 +108,46 @@ Override overrideWith($createType create,) { return \$FamilyOverride( from: this, createElement: (container, provider) { - provider as ProviderT; + provider as ${provider.providerTypeName}; '''); - switch (provider.parameters) { - case [_]: + switch (( + hasParameters: provider.parameters.isNotEmpty, + hasGenerics: provider.typeParameters?.typeParameters.isNotEmpty ?? false, + )) { + case (hasParameters: false, hasGenerics: false): + buffer.writeln( + r'return provider.$copyWithCreate(create).createElement(container);', + ); + case (hasParameters: true, hasGenerics: false): buffer.writeln(''' - final args = provider.argument! as ${provider.parameters.single.typeDisplayString}; + final argument = provider.argument as $_argumentRecordType; + + return provider.\$copyWithCreate(${switch (provider) { + FunctionalProviderDeclaration() => '(ref) => create(ref, argument)', + ClassBasedProviderDeclaration() => '() => create(argument)', + }}).createElement(container); '''); - } - (''' - final args = provider.argument! as $_argumentRecordType; + case (hasParameters: false, hasGenerics: true): + buffer.writeln( + 'return provider._copyWithCreate(create).createElement(container);', + ); + + case (hasParameters: true, hasGenerics: true): + buffer.writeln(''' + return provider._copyWithCreate($_genericsDefinition(ref, $_parameterDefinition) { + final argument = provider.argument as $_argumentRecordType; + + return create(ref, argument); + }).createElement(container); + '''); + } - return provider.\$copyWithCreate(create).createElement(container); + buffer.writeln(''' }, ); -} -'''); +}'''); } void _writeOverrideWithBuild( @@ -148,11 +155,58 @@ Override overrideWith($createType create,) { ClassBasedProviderDeclaration provider, { required StringBuffer topLevelBuffer, }) { + final runNotifierBuildType = ''' +${provider.createdTypeDisplayString} Function$_genericsDefinition( + ${provider.refWithGenerics} ref, + $_notifierType notifier + ${switch (provider.parameters) { + [] => '', + [_, ...] => ', $_argumentRecordType argument', + }} +)'''; + // TODO docs buffer.writeln(''' -Override overrideWithBuild() { - -} +Override overrideWithBuild($runNotifierBuildType build,) { + return \$FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ${provider.providerTypeName}; '''); + + switch (( + hasParameters: provider.parameters.isNotEmpty, + hasGenerics: provider.typeParameters?.typeParameters.isNotEmpty ?? false, + )) { + case (hasParameters: false, hasGenerics: false): + buffer.writeln( + r'return provider.$copyWithBuild(build).createElement(container);', + ); + case (hasParameters: true, hasGenerics: false): + buffer.writeln(''' + final argument = provider.argument as $_argumentRecordType; + + return provider.\$copyWithBuild((ref, notifier) => build(ref, notifier, argument)).createElement(container); + '''); + + case (hasParameters: false, hasGenerics: true): + buffer.writeln( + 'return provider._copyWithBuild(build).createElement(container);', + ); + + case (hasParameters: true, hasGenerics: true): + buffer.writeln(''' + return provider._copyWithBuild($_genericsDefinition(ref, notifier, $_parameterDefinition) { + final argument = provider.argument as $_argumentRecordType; + + return build(ref, notifier, argument); + }).createElement(container); + '''); + } + + buffer.writeln(''' + }, + ); +}'''); } } diff --git a/packages/riverpod_generator/lib/src/templates/notifier.dart b/packages/riverpod_generator/lib/src/templates/notifier.dart index 170918c38..1d8aebec4 100644 --- a/packages/riverpod_generator/lib/src/templates/notifier.dart +++ b/packages/riverpod_generator/lib/src/templates/notifier.dart @@ -26,26 +26,27 @@ class NotifierTemplate extends Template { '\$Notifier<${provider.valueTypeDisplayString}>', }; - final argumentRecordType = buildParamDefinitionQuery( - provider.parameters, - asRecord: true, - ); - final paramsPassThrough = buildParamInvocationQuery({ for (final (index, parameter) in provider.parameters.indexed) - if (parameter.isPositional) + if (provider.parameters.length == 1) + parameter: r'_$args' + else if (parameter.isPositional) parameter: '_\$args.\$${index + 1}' else parameter: '_\$args.${parameter.name!.lexeme}', }); final _$args = r'late final _$args = ' - '(ref as ${provider.elementName}).origin.argument as ($argumentRecordType);'; + '(ref as ${provider.elementName}).origin.argument as ${provider.argumentRecordType};'; var paramOffset = 0; final parametersAsFields = provider.parameters .map( - (p) => '${p.typeDisplayString} get ${p.name!.lexeme} => ' + (p) => + '${p.typeDisplayString} get ${p.name!.lexeme} => ${switch (provider.parameters) { + [_] => r'_$args;', + _ => '_\$args.${p.isPositional ? '\$${++paramOffset}' : p.name!.lexeme};', + }}', ) .join(); diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 13f92c353..93effec9c 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -22,11 +22,7 @@ class ProviderTemplate extends Template { late final _generics = provider.generics(); late final _genericsDefinition = provider.genericsDefinition(); - late final _refType = switch (provider) { - FunctionalProviderDeclaration() => '${provider.refImplName}$_generics', - ClassBasedProviderDeclaration() => - 'Ref<${provider.exposedTypeDisplayString}>', - }; + late final _refType = provider.refWithGenerics; @override void run(StringBuffer buffer) { @@ -154,6 +150,9 @@ final class $name$_genericsDefinition 'from: from! as ${provider.familyTypeName},', ].join(); + _writeGenericCopyWith(buffer, copyParameters: copyParameters); + _writeToString(buffer); + switch (provider) { case FunctionalProviderDeclaration(): final createParams = buildParamDefinitionQuery(provider.parameters); @@ -202,7 +201,7 @@ final class $name$_genericsDefinition @\$internal @override ${provider.providerTypeName}$_generics \$copyWithBuild( - ${provider.createdTypeDisplayString} Function($_refType, $notifierType) build, + ${provider.notifierBuildType()} build, ) { return ${provider.providerTypeName}$_generics._( $copyParameters @@ -221,6 +220,37 @@ final class $name$_genericsDefinition _writeEqual(buffer); } + void _writeGenericCopyWith( + StringBuffer buffer, { + required String copyParameters, + }) { + if (provider.typeParameters?.typeParameters.isEmpty ?? true) return; + + buffer.writeln(''' + ${provider.providerTypeName}$_generics _copyWithCreate( + ${provider.createType(withGenericDefinition: true)} create, + ) { + return ${provider.providerTypeName}$_generics._( + $copyParameters + create: create$_generics + ); + } + '''); + + if (provider is ClassBasedProviderDeclaration) { + buffer.writeln(''' + ${provider.providerTypeName}$_generics _copyWithBuild( + ${provider.notifierBuildType(withGenericDefinition: true)} build, + ) { + return ${provider.providerTypeName}$_generics._( + $copyParameters + runNotifierBuildOverride: build$_generics + ); + } + '''); + } + } + void _writeFunctionalCreate(StringBuffer buffer) { buffer.write(''' @override @@ -267,4 +297,27 @@ final class $name$_genericsDefinition } '''); } + + void _writeToString(StringBuffer buffer) { + if (!provider.providerElement.isFamily) return; + + final encodedGenerics = provider.typeParameters?.typeParameters.isEmpty ?? + true + ? '' + : '<${provider.typeParameters!.typeParameters.map((e) => '\${${e.name}}').join(', ')}>'; + + buffer.writeln(''' +@override +String toString() { + return r'${provider.providerName(options)}' + '$encodedGenerics' + '${switch (provider.parameters) { + [] => '()', + [_] => r'($argument)', + // Calling toString on a record, do we don't add the () to avoid `provider((...))` + [_, ...] => r'$argument', + }}'; +} +'''); + } } diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index cb559c3e8..2d6223239 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -86,6 +86,13 @@ final class FamilyProvider @override String debugGetCreateSourceHash() => _$familyHash(); + @override + String toString() { + return r'familyProvider' + '' + '($argument)'; + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -142,7 +149,27 @@ final class FamilyFamily extends Family { String debugGetCreateSourceHash() => _$familyHash(); @override - String toString() => r'family'; + String toString() => r'familyProvider'; + + Override overrideWith( + String Function( + FamilyRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } typedef NotCopiedFunctionalRef = Ref; @@ -226,6 +253,13 @@ final class NotCopiedFamilyProvider @override String debugGetCreateSourceHash() => _$notCopiedFamilyHash(); + @override + String toString() { + return r'notCopiedFamilyProvider' + '' + '($argument)'; + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -282,7 +316,27 @@ final class NotCopiedFamilyFamily extends Family { String debugGetCreateSourceHash() => _$notCopiedFamilyHash(); @override - String toString() => r'notCopiedFamily'; + String toString() => r'notCopiedFamilyProvider'; + + Override overrideWith( + String Function( + NotCopiedFamilyRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as NotCopiedFamilyProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } const classBasedProvider = ClassBasedProvider._(); @@ -320,7 +374,10 @@ final class ClassBasedProvider extends $NotifierProvider { @$internal @override ClassBasedProvider $copyWithBuild( - String Function(Ref, ClassBased) build, + String Function( + Ref, + ClassBased, + ) build, ) { return ClassBasedProvider._(runNotifierBuildOverride: build); } @@ -378,7 +435,10 @@ final class NotCopiedClassBasedProvider @$internal @override NotCopiedClassBasedProvider $copyWithBuild( - String Function(Ref, NotCopiedClassBased) build, + String Function( + Ref, + NotCopiedClassBased, + ) build, ) { return NotCopiedClassBasedProvider._(runNotifierBuildOverride: build); } diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 70ff2bc8f..7a373e51f 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -34,6 +34,22 @@ final class GenericProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$genericHash(); + GenericProvider _copyWithCreate( + FutureOr> Function( + GenericRef ref, + ) create, + ) { + return GenericProvider._( + from: from! as GenericFamily, create: create); + } + + @override + String toString() { + return r'genericProvider' + '<${T}>' + '()'; + } + @override $FutureProviderElement> createElement(ProviderContainer container) => $FutureProviderElement(this, container); @@ -78,7 +94,20 @@ final class GenericFamily extends Family { String debugGetCreateSourceHash() => _$genericHash(); @override - String toString() => r'generic'; + String toString() => r'genericProvider'; + + Override overrideWith( + FutureOr> Function(GenericRef ref) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericProvider; + + return provider._copyWithCreate(create).createElement(container); + }, + ); + } } typedef PublicRef = Ref>; @@ -211,6 +240,13 @@ final class FamilyOrProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$familyOrHash(); + @override + String toString() { + return r'familyOrProvider' + '' + '($argument)'; + } + @override $FutureProviderElement createElement(ProviderContainer container) => $FutureProviderElement(this, container); @@ -267,7 +303,27 @@ final class FamilyOrFamily extends Family { String debugGetCreateSourceHash() => _$familyOrHash(); @override - String toString() => r'familyOr'; + String toString() => r'familyOrProvider'; + + Override overrideWith( + FutureOr Function( + FamilyOrRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyOrProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } typedef FamilyRef = Ref>; @@ -315,6 +371,13 @@ final class FamilyProvider @override String debugGetCreateSourceHash() => _$familyHash(); + @override + String toString() { + return r'familyProvider' + '' + '$argument'; + } + @override $FutureProviderElement createElement(ProviderContainer container) => $FutureProviderElement(this, container); @@ -407,7 +470,39 @@ final class FamilyFamily extends Family { String debugGetCreateSourceHash() => _$familyHash(); @override - String toString() => r'family'; + String toString() => r'familyProvider'; + + Override overrideWith( + FutureOr Function( + FamilyRef ref, + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyProvider; + + final argument = provider.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } const genericClassProvider = GenericClassFamily._(); @@ -432,6 +527,30 @@ final class GenericClassProvider @override String debugGetCreateSourceHash() => _$genericClassHash(); + GenericClassProvider _copyWithCreate( + GenericClass Function() create, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, create: create); + } + + GenericClassProvider _copyWithBuild( + FutureOr> Function( + Ref>>, + GenericClass, + ) build, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, runNotifierBuildOverride: build); + } + + @override + String toString() { + return r'genericClassProvider' + '<${T}>' + '()'; + } + @$internal @override GenericClass create() => _createCb?.call() ?? GenericClass(); @@ -448,7 +567,10 @@ final class GenericClassProvider @$internal @override GenericClassProvider $copyWithBuild( - FutureOr> Function(Ref>>, GenericClass) build, + FutureOr> Function( + Ref>>, + GenericClass, + ) build, ) { return GenericClassProvider._( from: from! as GenericClassFamily, runNotifierBuildOverride: build); @@ -486,7 +608,35 @@ final class GenericClassFamily extends Family { String debugGetCreateSourceHash() => _$genericClassHash(); @override - String toString() => r'GenericClass'; + String toString() => r'genericClassProvider'; + + Override overrideWith( + GenericClass Function() create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericClassProvider; + + return provider._copyWithCreate(create).createElement(container); + }, + ); + } + + Override overrideWithBuild( + FutureOr> Function( + Ref>> ref, GenericClass notifier) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericClassProvider; + + return provider._copyWithBuild(build).createElement(container); + }, + ); + } } abstract class _$GenericClass extends $AsyncNotifier> { @@ -533,7 +683,10 @@ final class PublicClassProvider @$internal @override PublicClassProvider $copyWithBuild( - FutureOr Function(Ref>, PublicClass) build, + FutureOr Function( + Ref>, + PublicClass, + ) build, ) { return PublicClassProvider._(runNotifierBuildOverride: build); } @@ -591,7 +744,10 @@ final class _PrivateClassProvider @$internal @override _PrivateClassProvider $copyWithBuild( - FutureOr Function(Ref>, _PrivateClass) build, + FutureOr Function( + Ref>, + _PrivateClass, + ) build, ) { return _PrivateClassProvider._(runNotifierBuildOverride: build); } @@ -635,6 +791,13 @@ final class FamilyOrClassProvider @override String debugGetCreateSourceHash() => _$familyOrClassHash(); + @override + String toString() { + return r'familyOrClassProvider' + '' + '($argument)'; + } + @$internal @override FamilyOrClass create() => _createCb?.call() ?? FamilyOrClass(); @@ -653,7 +816,10 @@ final class FamilyOrClassProvider @$internal @override FamilyOrClassProvider $copyWithBuild( - FutureOr Function(Ref>, FamilyOrClass) build, + FutureOr Function( + Ref>, + FamilyOrClass, + ) build, ) { return FamilyOrClassProvider._( argument: argument as int, @@ -693,13 +859,51 @@ final class FamilyOrClassFamily extends Family { String debugGetCreateSourceHash() => _$familyOrClassHash(); @override - String toString() => r'FamilyOrClass'; + String toString() => r'familyOrClassProvider'; + + Override overrideWith( + FamilyOrClass Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyOrClassProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + FutureOr Function( + Ref> ref, FamilyOrClass notifier, int argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyOrClassProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$FamilyOrClass extends $AsyncNotifier { late final _$args = - (ref as $AsyncNotifierProviderElement).origin.argument as (int,); - int get first => _$args.$1; + (ref as $AsyncNotifierProviderElement).origin.argument as int; + int get first => _$args; FutureOr build( int first, @@ -708,7 +912,7 @@ abstract class _$FamilyOrClass extends $AsyncNotifier { @$internal @override FutureOr runBuild() => build( - _$args.$1, + _$args, ); } @@ -741,6 +945,13 @@ final class FamilyClassProvider @override String debugGetCreateSourceHash() => _$familyClassHash(); + @override + String toString() { + return r'familyClassProvider' + '' + '$argument'; + } + @$internal @override FamilyClass create() => _createCb?.call() ?? FamilyClass(); @@ -765,7 +976,10 @@ final class FamilyClassProvider @$internal @override FamilyClassProvider $copyWithBuild( - FutureOr Function(Ref>, FamilyClass) build, + FutureOr Function( + Ref>, + FamilyClass, + ) build, ) { return FamilyClassProvider._( argument: argument as ( @@ -821,7 +1035,71 @@ final class FamilyClassFamily extends Family { String debugGetCreateSourceHash() => _$familyClassHash(); @override - String toString() => r'FamilyClass'; + String toString() => r'familyClassProvider'; + + Override overrideWith( + FamilyClass Function( + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyClassProvider; + + final argument = provider.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + FutureOr Function( + Ref> ref, + FamilyClass notifier, + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyClassProvider; + + final argument = provider.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$FamilyClass extends $AsyncNotifier { diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index a8de63456..6b0eb0cca 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -84,6 +84,13 @@ final class FamilyProvider extends $FunctionalProvider @override String debugGetCreateSourceHash() => _$familyHash(); + @override + String toString() { + return r'familyProvider' + '' + '($argument)'; + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -140,7 +147,27 @@ final class FamilyFamily extends Family { String debugGetCreateSourceHash() => _$familyHash(); @override - String toString() => r'family'; + String toString() => r'familyProvider'; + + Override overrideWith( + int Function( + FamilyRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } typedef ProviderRef = Ref; @@ -840,7 +867,10 @@ final class Dep2Provider extends $NotifierProvider { @$internal @override Dep2Provider $copyWithBuild( - int Function(Ref, Dep2) build, + int Function( + Ref, + Dep2, + ) build, ) { return Dep2Provider._(runNotifierBuildOverride: build); } @@ -883,6 +913,13 @@ final class Family2Provider extends $NotifierProvider { @override String debugGetCreateSourceHash() => _$family2Hash(); + @override + String toString() { + return r'family2Provider' + '' + '($argument)'; + } + @$internal @override Family2 create() => _createCb?.call() ?? Family2(); @@ -901,7 +938,10 @@ final class Family2Provider extends $NotifierProvider { @$internal @override Family2Provider $copyWithBuild( - int Function(Ref, Family2) build, + int Function( + Ref, + Family2, + ) build, ) { return Family2Provider._( argument: argument as int, @@ -941,13 +981,48 @@ final class Family2Family extends Family { String debugGetCreateSourceHash() => _$family2Hash(); @override - String toString() => r'Family2'; + String toString() => r'family2Provider'; + + Override overrideWith( + Family2 Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Family2Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + int Function(Ref ref, Family2 notifier, int argument) build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Family2Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$Family2 extends $Notifier { - late final _$args = - (ref as $NotifierProviderElement).origin.argument as (int,); - int get id => _$args.$1; + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + int get id => _$args; int build( int id, @@ -956,7 +1031,7 @@ abstract class _$Family2 extends $Notifier { @$internal @override int runBuild() => build( - _$args.$1, + _$args, ); } @@ -1010,7 +1085,10 @@ final class Provider3Provider extends $NotifierProvider { @$internal @override Provider3Provider $copyWithBuild( - int Function(Ref, Provider3) build, + int Function( + Ref, + Provider3, + ) build, ) { return Provider3Provider._(runNotifierBuildOverride: build); } @@ -1058,6 +1136,13 @@ final class Provider4Provider extends $NotifierProvider { @override String debugGetCreateSourceHash() => _$provider4Hash(); + @override + String toString() { + return r'provider4Provider' + '' + '($argument)'; + } + @$internal @override Provider4 create() => _createCb?.call() ?? Provider4(); @@ -1076,7 +1161,10 @@ final class Provider4Provider extends $NotifierProvider { @$internal @override Provider4Provider $copyWithBuild( - int Function(Ref, Provider4) build, + int Function( + Ref, + Provider4, + ) build, ) { return Provider4Provider._( argument: argument as int, @@ -1126,13 +1214,48 @@ final class Provider4Family extends Family { String debugGetCreateSourceHash() => _$provider4Hash(); @override - String toString() => r'Provider4'; + String toString() => r'provider4Provider'; + + Override overrideWith( + Provider4 Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Provider4Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + int Function(Ref ref, Provider4 notifier, int argument) build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Provider4Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$Provider4 extends $Notifier { - late final _$args = - (ref as $NotifierProviderElement).origin.argument as (int,); - int get id => _$args.$1; + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + int get id => _$args; int build( int id, @@ -1141,7 +1264,7 @@ abstract class _$Provider4 extends $Notifier { @$internal @override int runBuild() => build( - _$args.$1, + _$args, ); } @@ -1184,7 +1307,10 @@ final class EmptyDependenciesClassBasedProvider @$internal @override EmptyDependenciesClassBasedProvider $copyWithBuild( - int Function(Ref, EmptyDependenciesClassBased) build, + int Function( + Ref, + EmptyDependenciesClassBased, + ) build, ) { return EmptyDependenciesClassBasedProvider._( runNotifierBuildOverride: build); diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 4409e3482..3c0bc2620 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -113,6 +113,13 @@ final class FamilyWithDependencies2Provider @override String debugGetCreateSourceHash() => _$familyWithDependencies2Hash(); + @override + String toString() { + return r'familyWithDependencies2Provider' + '' + '($argument)'; + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -181,7 +188,27 @@ final class FamilyWithDependencies2Family extends Family { String debugGetCreateSourceHash() => _$familyWithDependencies2Hash(); @override - String toString() => r'familyWithDependencies2'; + String toString() => r'familyWithDependencies2Provider'; + + Override overrideWith( + int Function( + FamilyWithDependencies2Ref ref, + int? args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyWithDependencies2Provider; + + final argument = provider.argument as int?; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } typedef _Private2Ref = Ref; @@ -339,7 +366,10 @@ final class NotifierWithDependenciesProvider @$internal @override NotifierWithDependenciesProvider $copyWithBuild( - int Function(Ref, NotifierWithDependencies) build, + int Function( + Ref, + NotifierWithDependencies, + ) build, ) { return NotifierWithDependenciesProvider._(runNotifierBuildOverride: build); } @@ -393,6 +423,13 @@ final class NotifierFamilyWithDependenciesProvider @override String debugGetCreateSourceHash() => _$notifierFamilyWithDependenciesHash(); + @override + String toString() { + return r'notifierFamilyWithDependenciesProvider' + '' + '($argument)'; + } + @$internal @override NotifierFamilyWithDependencies create() => @@ -412,7 +449,10 @@ final class NotifierFamilyWithDependenciesProvider @$internal @override NotifierFamilyWithDependenciesProvider $copyWithBuild( - int Function(Ref, NotifierFamilyWithDependencies) build, + int Function( + Ref, + NotifierFamilyWithDependencies, + ) build, ) { return NotifierFamilyWithDependenciesProvider._( argument: argument as int?, @@ -464,14 +504,50 @@ final class NotifierFamilyWithDependenciesFamily extends Family { String debugGetCreateSourceHash() => _$notifierFamilyWithDependenciesHash(); @override - String toString() => r'NotifierFamilyWithDependencies'; + String toString() => r'notifierFamilyWithDependenciesProvider'; + + Override overrideWith( + NotifierFamilyWithDependencies Function( + int? args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as NotifierFamilyWithDependenciesProvider; + + final argument = provider.argument as int?; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + int Function(Ref ref, NotifierFamilyWithDependencies notifier, + int? argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as NotifierFamilyWithDependenciesProvider; + + final argument = provider.argument as int?; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$NotifierFamilyWithDependencies extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as ({ - int? id, - }); - int? get id => _$args.id; + late final _$args = (ref as $NotifierProviderElement).origin.argument as int?; + int? get id => _$args; int build({ int? id, @@ -480,7 +556,7 @@ abstract class _$NotifierFamilyWithDependencies extends $Notifier { @$internal @override int runBuild() => build( - id: _$args.id, + id: _$args, ); } diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index d855517f9..550c87dcb 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -86,6 +86,13 @@ final class GeneratedFamilyProvider @override String debugGetCreateSourceHash() => _$generatedFamilyHash(); + @override + String toString() { + return r'generatedFamilyProvider' + '' + '($argument)'; + } + @override $ProviderElement<_Test> createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -142,7 +149,27 @@ final class GeneratedFamilyFamily extends Family { String debugGetCreateSourceHash() => _$generatedFamilyHash(); @override - String toString() => r'generatedFamily'; + String toString() => r'generatedFamilyProvider'; + + Override overrideWith( + _Test Function( + GeneratedFamilyRef ref, + _Test args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GeneratedFamilyProvider; + + final argument = provider.argument as _Test; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } typedef $DynamicRef = Ref; @@ -225,6 +252,13 @@ final class $DynamicFamilyProvider @override String debugGetCreateSourceHash() => _$$dynamicFamilyHash(); + @override + String toString() { + return r'$dynamicFamilyProvider' + '' + '($argument)'; + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -281,7 +315,27 @@ final class $DynamicFamilyFamily extends Family { String debugGetCreateSourceHash() => _$$dynamicFamilyHash(); @override - String toString() => r'$dynamicFamily'; + String toString() => r'$dynamicFamilyProvider'; + + Override overrideWith( + Object? Function( + $DynamicFamilyRef ref, + dynamic args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as $DynamicFamilyProvider; + + final argument = provider.argument as dynamic; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } typedef _DynamicRef = Ref; @@ -314,6 +368,13 @@ final class _DynamicProvider @override String debugGetCreateSourceHash() => _$dynamicHash(); + @override + String toString() { + return r'_dynamicProvider' + '' + '($argument)'; + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -370,7 +431,27 @@ final class _DynamicFamily extends Family { String debugGetCreateSourceHash() => _$dynamicHash(); @override - String toString() => r'_dynamic'; + String toString() => r'_dynamicProvider'; + + Override overrideWith( + Object? Function( + _DynamicRef ref, + dynamic args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as _DynamicProvider; + + final argument = provider.argument as dynamic; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } typedef AliasRef = Ref>; @@ -455,6 +536,13 @@ final class AliasFamilyProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$aliasFamilyHash(); + @override + String toString() { + return r'aliasFamilyProvider' + '' + '($argument)'; + } + @override $ProviderElement> createElement( ProviderContainer container) => @@ -512,7 +600,27 @@ final class AliasFamilyFamily extends Family { String debugGetCreateSourceHash() => _$aliasFamilyHash(); @override - String toString() => r'aliasFamily'; + String toString() => r'aliasFamilyProvider'; + + Override overrideWith( + r.AsyncValue Function( + AliasFamilyRef ref, + r.AsyncValue args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as AliasFamilyProvider; + + final argument = provider.argument as r.AsyncValue; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } const generatedClassProvider = GeneratedClassProvider._(); @@ -551,7 +659,10 @@ final class GeneratedClassProvider @$internal @override GeneratedClassProvider $copyWithBuild( - _Test Function(Ref<_Test>, GeneratedClass) build, + _Test Function( + Ref<_Test>, + GeneratedClass, + ) build, ) { return GeneratedClassProvider._(runNotifierBuildOverride: build); } @@ -595,6 +706,13 @@ final class GeneratedClassFamilyProvider @override String debugGetCreateSourceHash() => _$generatedClassFamilyHash(); + @override + String toString() { + return r'generatedClassFamilyProvider' + '' + '($argument)'; + } + @$internal @override GeneratedClassFamily create() => _createCb?.call() ?? GeneratedClassFamily(); @@ -613,7 +731,10 @@ final class GeneratedClassFamilyProvider @$internal @override GeneratedClassFamilyProvider $copyWithBuild( - _Test Function(Ref<_Test>, GeneratedClassFamily) build, + _Test Function( + Ref<_Test>, + GeneratedClassFamily, + ) build, ) { return GeneratedClassFamilyProvider._( argument: argument as _Test, @@ -654,13 +775,51 @@ final class GeneratedClassFamilyFamily extends Family { String debugGetCreateSourceHash() => _$generatedClassFamilyHash(); @override - String toString() => r'GeneratedClassFamily'; + String toString() => r'generatedClassFamilyProvider'; + + Override overrideWith( + GeneratedClassFamily Function( + _Test args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GeneratedClassFamilyProvider; + + final argument = provider.argument as _Test; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + _Test Function( + Ref<_Test> ref, GeneratedClassFamily notifier, _Test argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GeneratedClassFamilyProvider; + + final argument = provider.argument as _Test; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$GeneratedClassFamily extends $Notifier<_Test> { late final _$args = - (ref as $NotifierProviderElement).origin.argument as (_Test,); - _Test get test => _$args.$1; + (ref as $NotifierProviderElement).origin.argument as _Test; + _Test get test => _$args; _Test build( _Test test, @@ -669,7 +828,7 @@ abstract class _$GeneratedClassFamily extends $Notifier<_Test> { @$internal @override _Test runBuild() => build( - _$args.$1, + _$args, ); } @@ -709,7 +868,10 @@ final class $DynamicClassProvider @$internal @override $DynamicClassProvider $copyWithBuild( - Object? Function(Ref, $DynamicClass) build, + Object? Function( + Ref, + $DynamicClass, + ) build, ) { return $DynamicClassProvider._(runNotifierBuildOverride: build); } @@ -753,6 +915,13 @@ final class $DynamicClassFamilyProvider @override String debugGetCreateSourceHash() => _$$dynamicClassFamilyHash(); + @override + String toString() { + return r'$dynamicClassFamilyProvider' + '' + '($argument)'; + } + @$internal @override $DynamicClassFamily create() => _createCb?.call() ?? $DynamicClassFamily(); @@ -771,7 +940,10 @@ final class $DynamicClassFamilyProvider @$internal @override $DynamicClassFamilyProvider $copyWithBuild( - Object? Function(Ref, $DynamicClassFamily) build, + Object? Function( + Ref, + $DynamicClassFamily, + ) build, ) { return $DynamicClassFamilyProvider._( argument: argument as dynamic, @@ -812,13 +984,51 @@ final class $DynamicClassFamilyFamily extends Family { String debugGetCreateSourceHash() => _$$dynamicClassFamilyHash(); @override - String toString() => r'$DynamicClassFamily'; + String toString() => r'$dynamicClassFamilyProvider'; + + Override overrideWith( + $DynamicClassFamily Function( + dynamic args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as $DynamicClassFamilyProvider; + + final argument = provider.argument as dynamic; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + Object? Function( + Ref ref, $DynamicClassFamily notifier, dynamic argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as $DynamicClassFamilyProvider; + + final argument = provider.argument as dynamic; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$$DynamicClassFamily extends $Notifier { late final _$args = - (ref as $NotifierProviderElement).origin.argument as (dynamic,); - dynamic get test => _$args.$1; + (ref as $NotifierProviderElement).origin.argument as dynamic; + dynamic get test => _$args; Object? build( dynamic test, @@ -827,7 +1037,7 @@ abstract class _$$DynamicClassFamily extends $Notifier { @$internal @override Object? runBuild() => build( - _$args.$1, + _$args, ); } @@ -867,7 +1077,10 @@ final class AliasClassProvider @$internal @override AliasClassProvider $copyWithBuild( - r.AsyncValue Function(Ref>, AliasClass) build, + r.AsyncValue Function( + Ref>, + AliasClass, + ) build, ) { return AliasClassProvider._(runNotifierBuildOverride: build); } @@ -911,6 +1124,13 @@ final class AliasClassFamilyProvider @override String debugGetCreateSourceHash() => _$aliasClassFamilyHash(); + @override + String toString() { + return r'aliasClassFamilyProvider' + '' + '($argument)'; + } + @$internal @override AliasClassFamily create() => _createCb?.call() ?? AliasClassFamily(); @@ -929,7 +1149,10 @@ final class AliasClassFamilyProvider @$internal @override AliasClassFamilyProvider $copyWithBuild( - r.AsyncValue Function(Ref>, AliasClassFamily) build, + r.AsyncValue Function( + Ref>, + AliasClassFamily, + ) build, ) { return AliasClassFamilyProvider._( argument: argument as r.AsyncValue, @@ -969,13 +1192,51 @@ final class AliasClassFamilyFamily extends Family { String debugGetCreateSourceHash() => _$aliasClassFamilyHash(); @override - String toString() => r'AliasClassFamily'; + String toString() => r'aliasClassFamilyProvider'; + + Override overrideWith( + AliasClassFamily Function( + r.AsyncValue args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as AliasClassFamilyProvider; + + final argument = provider.argument as r.AsyncValue; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + r.AsyncValue Function(Ref> ref, + AliasClassFamily notifier, r.AsyncValue argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as AliasClassFamilyProvider; + + final argument = provider.argument as r.AsyncValue; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$AliasClassFamily extends $Notifier> { late final _$args = - (ref as $NotifierProviderElement).origin.argument as (r.AsyncValue,); - r.AsyncValue get test => _$args.$1; + (ref as $NotifierProviderElement).origin.argument as r.AsyncValue; + r.AsyncValue get test => _$args; r.AsyncValue build( r.AsyncValue test, @@ -984,7 +1245,7 @@ abstract class _$AliasClassFamily extends $Notifier> { @$internal @override r.AsyncValue runBuild() => build( - _$args.$1, + _$args, ); } diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index 1c7e96e18..cd9e6212a 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -141,7 +141,10 @@ final class SimpleClassProvider extends $NotifierProvider { @$internal @override SimpleClassProvider $copyWithBuild( - String Function(Ref, SimpleClass) build, + String Function( + Ref, + SimpleClass, + ) build, ) { return SimpleClassProvider._(runNotifierBuildOverride: build); } diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 7c059ea16..a1f38efe9 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -90,7 +90,10 @@ final class ScopedClassProvider extends $NotifierProvider { @$internal @override ScopedClassProvider $copyWithBuild( - int Function(Ref, ScopedClass) build, + int Function( + Ref, + ScopedClass, + ) build, ) { return ScopedClassProvider._(runNotifierBuildOverride: build); } diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 78ad186cf..621dc1b2c 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -34,6 +34,22 @@ final class GenericProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$genericHash(); + GenericProvider _copyWithCreate( + Stream> Function( + GenericRef ref, + ) create, + ) { + return GenericProvider._( + from: from! as GenericFamily, create: create); + } + + @override + String toString() { + return r'genericProvider' + '<${T}>' + '()'; + } + @override $StreamProviderElement> createElement(ProviderContainer container) => $StreamProviderElement(this, container); @@ -78,7 +94,20 @@ final class GenericFamily extends Family { String debugGetCreateSourceHash() => _$genericHash(); @override - String toString() => r'generic'; + String toString() => r'genericProvider'; + + Override overrideWith( + Stream> Function(GenericRef ref) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericProvider; + + return provider._copyWithCreate(create).createElement(container); + }, + ); + } } typedef PublicRef = Ref>; @@ -226,6 +255,13 @@ final class FamilyProvider @override String debugGetCreateSourceHash() => _$familyHash(); + @override + String toString() { + return r'familyProvider' + '' + '$argument'; + } + @override $StreamProviderElement createElement(ProviderContainer container) => $StreamProviderElement(this, container); @@ -318,7 +354,39 @@ final class FamilyFamily extends Family { String debugGetCreateSourceHash() => _$familyHash(); @override - String toString() => r'family'; + String toString() => r'familyProvider'; + + Override overrideWith( + Stream Function( + FamilyRef ref, + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyProvider; + + final argument = provider.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } const genericClassProvider = GenericClassFamily._(); @@ -343,6 +411,30 @@ final class GenericClassProvider @override String debugGetCreateSourceHash() => _$genericClassHash(); + GenericClassProvider _copyWithCreate( + GenericClass Function() create, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, create: create); + } + + GenericClassProvider _copyWithBuild( + Stream> Function( + Ref>>, + GenericClass, + ) build, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, runNotifierBuildOverride: build); + } + + @override + String toString() { + return r'genericClassProvider' + '<${T}>' + '()'; + } + @$internal @override GenericClass create() => _createCb?.call() ?? GenericClass(); @@ -359,7 +451,10 @@ final class GenericClassProvider @$internal @override GenericClassProvider $copyWithBuild( - Stream> Function(Ref>>, GenericClass) build, + Stream> Function( + Ref>>, + GenericClass, + ) build, ) { return GenericClassProvider._( from: from! as GenericClassFamily, runNotifierBuildOverride: build); @@ -397,7 +492,35 @@ final class GenericClassFamily extends Family { String debugGetCreateSourceHash() => _$genericClassHash(); @override - String toString() => r'GenericClass'; + String toString() => r'genericClassProvider'; + + Override overrideWith( + GenericClass Function() create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericClassProvider; + + return provider._copyWithCreate(create).createElement(container); + }, + ); + } + + Override overrideWithBuild( + Stream> Function( + Ref>> ref, GenericClass notifier) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericClassProvider; + + return provider._copyWithBuild(build).createElement(container); + }, + ); + } } abstract class _$GenericClass extends $StreamNotifier> { @@ -444,7 +567,10 @@ final class PublicClassProvider @$internal @override PublicClassProvider $copyWithBuild( - Stream Function(Ref>, PublicClass) build, + Stream Function( + Ref>, + PublicClass, + ) build, ) { return PublicClassProvider._(runNotifierBuildOverride: build); } @@ -502,7 +628,10 @@ final class _PrivateClassProvider @$internal @override _PrivateClassProvider $copyWithBuild( - Stream Function(Ref>, _PrivateClass) build, + Stream Function( + Ref>, + _PrivateClass, + ) build, ) { return _PrivateClassProvider._(runNotifierBuildOverride: build); } @@ -553,6 +682,13 @@ final class FamilyClassProvider @override String debugGetCreateSourceHash() => _$familyClassHash(); + @override + String toString() { + return r'familyClassProvider' + '' + '$argument'; + } + @$internal @override FamilyClass create() => _createCb?.call() ?? FamilyClass(); @@ -577,7 +713,10 @@ final class FamilyClassProvider @$internal @override FamilyClassProvider $copyWithBuild( - Stream Function(Ref>, FamilyClass) build, + Stream Function( + Ref>, + FamilyClass, + ) build, ) { return FamilyClassProvider._( argument: argument as ( @@ -633,7 +772,71 @@ final class FamilyClassFamily extends Family { String debugGetCreateSourceHash() => _$familyClassHash(); @override - String toString() => r'FamilyClass'; + String toString() => r'familyClassProvider'; + + Override overrideWith( + FamilyClass Function( + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyClassProvider; + + final argument = provider.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + Stream Function( + Ref> ref, + FamilyClass notifier, + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyClassProvider; + + final argument = provider.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$FamilyClass extends $StreamNotifier { diff --git a/packages/riverpod_generator/test/integration/sync.dart b/packages/riverpod_generator/test/integration/sync.dart index 3c6182844..52af9c043 100644 --- a/packages/riverpod_generator/test/integration/sync.dart +++ b/packages/riverpod_generator/test/integration/sync.dart @@ -155,7 +155,12 @@ class FamilyClass extends _$FamilyClass { } @riverpod -class Supports$InClassName extends _$Supports$InClassName { +String supports$InFnName(Supports$InFnNameRef ref) { + return 'Hello world'; +} + +@riverpod +class Supports$InClassName extends _$Supports$InClassName { @override String build() { return 'Hello world'; diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 9b57c3f4c..ac2cd3318 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -34,6 +34,22 @@ final class GenericProvider @override String debugGetCreateSourceHash() => _$genericHash(); + GenericProvider _copyWithCreate( + List Function( + GenericRef ref, + ) create, + ) { + return GenericProvider._( + from: from! as GenericFamily, create: create); + } + + @override + String toString() { + return r'genericProvider' + '<${T}>' + '()'; + } + @override $ProviderElement> createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -78,7 +94,20 @@ final class GenericFamily extends Family { String debugGetCreateSourceHash() => _$genericHash(); @override - String toString() => r'generic'; + String toString() => r'genericProvider'; + + Override overrideWith( + List Function(GenericRef ref) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericProvider; + + return provider._copyWithCreate(create).createElement(container); + }, + ); + } } typedef ComplexGenericRef = Ref>; @@ -117,6 +146,29 @@ final class ComplexGenericProvider @override String debugGetCreateSourceHash() => _$complexGenericHash(); + ComplexGenericProvider _copyWithCreate( + List Function( + ComplexGenericRef ref, { + required T param, + Foo? otherParam, + }) create, + ) { + return ComplexGenericProvider._( + argument: argument as ({ + T param, + Foo? otherParam, + }), + from: from! as ComplexGenericFamily, + create: create); + } + + @override + String toString() { + return r'complexGenericProvider' + '<${T}, ${Foo}>' + '$argument'; + } + @override $ProviderElement> createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -190,7 +242,37 @@ final class ComplexGenericFamily extends Family { String debugGetCreateSourceHash() => _$complexGenericHash(); @override - String toString() => r'complexGeneric'; + String toString() => r'complexGenericProvider'; + + Override overrideWith( + List Function( + ComplexGenericRef ref, + ({ + T param, + Foo? otherParam, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ComplexGenericProvider; + + return provider._copyWithCreate(( + ref, { + required T param, + Foo? otherParam, + }) { + final argument = provider.argument as ({ + T param, + Foo? otherParam, + }); + + return create(ref, argument); + }).createElement(container); + }, + ); + } } typedef RawFutureRef = Ref>>; @@ -327,6 +409,13 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$rawFamilyFutureHash(); + @override + String toString() { + return r'rawFamilyFutureProvider' + '' + '($argument)'; + } + @override $ProviderElement>> createElement( ProviderContainer container) => @@ -384,7 +473,27 @@ final class RawFamilyFutureFamily extends Family { String debugGetCreateSourceHash() => _$rawFamilyFutureHash(); @override - String toString() => r'rawFamilyFuture'; + String toString() => r'rawFamilyFutureProvider'; + + Override overrideWith( + Raw> Function( + RawFamilyFutureRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as RawFamilyFutureProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } typedef RawFamilyStreamRef = Ref>>; @@ -417,6 +526,13 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$rawFamilyStreamHash(); + @override + String toString() { + return r'rawFamilyStreamProvider' + '' + '($argument)'; + } + @override $ProviderElement>> createElement( ProviderContainer container) => @@ -474,7 +590,27 @@ final class RawFamilyStreamFamily extends Family { String debugGetCreateSourceHash() => _$rawFamilyStreamHash(); @override - String toString() => r'rawFamilyStream'; + String toString() => r'rawFamilyStreamProvider'; + + Override overrideWith( + Raw> Function( + RawFamilyStreamRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as RawFamilyStreamProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } typedef PublicRef = Ref; @@ -622,6 +758,13 @@ final class FamilyProvider @override String debugGetCreateSourceHash() => _$familyHash(); + @override + String toString() { + return r'familyProvider' + '' + '$argument'; + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -714,7 +857,39 @@ final class FamilyFamily extends Family { String debugGetCreateSourceHash() => _$familyHash(); @override - String toString() => r'family'; + String toString() => r'familyProvider'; + + Override overrideWith( + String Function( + FamilyRef ref, + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyProvider; + + final argument = provider.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } typedef _PrivateRef = Ref; @@ -767,6 +942,112 @@ final class _PrivateProvider String _$privateHash() => r'519561bc7e88e394d7f75ca2102a5c0acc832c66'; +typedef Supports$InFnNameRef = Ref; + +const supports$InFnNameProvider = Supports$InFnNameFamily._(); + +final class Supports$InFnNameProvider + extends $FunctionalProvider> + with $Provider> { + const Supports$InFnNameProvider._( + {required Supports$InFnNameFamily super.from, + String Function( + Supports$InFnNameRef ref, + )? create}) + : _createCb = create, + super( + argument: null, + name: r'supports$InFnNameProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + Supports$InFnNameRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$supports$InFnNameHash(); + + Supports$InFnNameProvider _copyWithCreate( + String Function( + Supports$InFnNameRef ref, + ) create, + ) { + return Supports$InFnNameProvider._( + from: from! as Supports$InFnNameFamily, create: create); + } + + @override + String toString() { + return r'supports$InFnNameProvider' + '<${And$InT}>' + '()'; + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Supports$InFnNameProvider $copyWithCreate( + String Function( + Supports$InFnNameRef ref, + ) create, + ) { + return Supports$InFnNameProvider._( + from: from! as Supports$InFnNameFamily, create: create); + } + + @override + String create(Supports$InFnNameRef ref) { + final fn = _createCb ?? supports$InFnName; + return fn(ref); + } + + @override + bool operator ==(Object other) { + return other is Supports$InFnNameProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } +} + +String _$supports$InFnNameHash() => r'fec3daca655669a46760cc54921f098b9cbaac3d'; + +final class Supports$InFnNameFamily extends Family { + const Supports$InFnNameFamily._() + : super( + name: r'supports$InFnNameProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + Supports$InFnNameProvider call() => + Supports$InFnNameProvider._(from: this); + + @override + String debugGetCreateSourceHash() => _$supports$InFnNameHash(); + + @override + String toString() => r'supports$InFnNameProvider'; + + Override overrideWith( + String Function(Supports$InFnNameRef ref) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Supports$InFnNameProvider; + + return provider._copyWithCreate(create).createElement(container); + }, + ); + } +} + typedef GeneratedRef = Ref; const generatedProvider = GeneratedProvider._(); @@ -839,6 +1120,30 @@ final class GenericClassProvider @override String debugGetCreateSourceHash() => _$genericClassHash(); + GenericClassProvider _copyWithCreate( + GenericClass Function() create, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, create: create); + } + + GenericClassProvider _copyWithBuild( + List Function( + Ref>, + GenericClass, + ) build, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, runNotifierBuildOverride: build); + } + + @override + String toString() { + return r'genericClassProvider' + '<${T}>' + '()'; + } + @$internal @override GenericClass create() => _createCb?.call() ?? GenericClass(); @@ -855,7 +1160,10 @@ final class GenericClassProvider @$internal @override GenericClassProvider $copyWithBuild( - List Function(Ref>, GenericClass) build, + List Function( + Ref>, + GenericClass, + ) build, ) { return GenericClassProvider._( from: from! as GenericClassFamily, runNotifierBuildOverride: build); @@ -893,7 +1201,34 @@ final class GenericClassFamily extends Family { String debugGetCreateSourceHash() => _$genericClassHash(); @override - String toString() => r'GenericClass'; + String toString() => r'genericClassProvider'; + + Override overrideWith( + GenericClass Function() create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericClassProvider; + + return provider._copyWithCreate(create).createElement(container); + }, + ); + } + + Override overrideWithBuild( + List Function(Ref> ref, GenericClass notifier) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericClassProvider; + + return provider._copyWithBuild(build).createElement(container); + }, + ); + } } abstract class _$GenericClass extends $Notifier> { @@ -940,8 +1275,10 @@ final class RawFutureClassProvider @$internal @override RawFutureClassProvider $copyWithBuild( - Raw> Function(Ref>>, RawFutureClass) - build, + Raw> Function( + Ref>>, + RawFutureClass, + ) build, ) { return RawFutureClassProvider._(runNotifierBuildOverride: build); } @@ -999,8 +1336,10 @@ final class RawStreamClassProvider @$internal @override RawStreamClassProvider $copyWithBuild( - Raw> Function(Ref>>, RawStreamClass) - build, + Raw> Function( + Ref>>, + RawStreamClass, + ) build, ) { return RawStreamClassProvider._(runNotifierBuildOverride: build); } @@ -1044,6 +1383,13 @@ final class RawFamilyFutureClassProvider @override String debugGetCreateSourceHash() => _$rawFamilyFutureClassHash(); + @override + String toString() { + return r'rawFamilyFutureClassProvider' + '' + '($argument)'; + } + @$internal @override RawFamilyFutureClass create() => _createCb?.call() ?? RawFamilyFutureClass(); @@ -1062,8 +1408,10 @@ final class RawFamilyFutureClassProvider @$internal @override RawFamilyFutureClassProvider $copyWithBuild( - Raw> Function(Ref>>, RawFamilyFutureClass) - build, + Raw> Function( + Ref>>, + RawFamilyFutureClass, + ) build, ) { return RawFamilyFutureClassProvider._( argument: argument as int, @@ -1104,13 +1452,50 @@ final class RawFamilyFutureClassFamily extends Family { String debugGetCreateSourceHash() => _$rawFamilyFutureClassHash(); @override - String toString() => r'RawFamilyFutureClass'; + String toString() => r'rawFamilyFutureClassProvider'; + + Override overrideWith( + RawFamilyFutureClass Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as RawFamilyFutureClassProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + Raw> Function(Ref>> ref, + RawFamilyFutureClass notifier, int argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as RawFamilyFutureClassProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$RawFamilyFutureClass extends $Notifier>> { - late final _$args = - (ref as $NotifierProviderElement).origin.argument as (int,); - int get id => _$args.$1; + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + int get id => _$args; Raw> build( int id, @@ -1119,7 +1504,7 @@ abstract class _$RawFamilyFutureClass extends $Notifier>> { @$internal @override Raw> runBuild() => build( - _$args.$1, + _$args, ); } @@ -1145,6 +1530,13 @@ final class RawFamilyStreamClassProvider @override String debugGetCreateSourceHash() => _$rawFamilyStreamClassHash(); + @override + String toString() { + return r'rawFamilyStreamClassProvider' + '' + '($argument)'; + } + @$internal @override RawFamilyStreamClass create() => _createCb?.call() ?? RawFamilyStreamClass(); @@ -1163,8 +1555,10 @@ final class RawFamilyStreamClassProvider @$internal @override RawFamilyStreamClassProvider $copyWithBuild( - Raw> Function(Ref>>, RawFamilyStreamClass) - build, + Raw> Function( + Ref>>, + RawFamilyStreamClass, + ) build, ) { return RawFamilyStreamClassProvider._( argument: argument as int, @@ -1205,13 +1599,50 @@ final class RawFamilyStreamClassFamily extends Family { String debugGetCreateSourceHash() => _$rawFamilyStreamClassHash(); @override - String toString() => r'RawFamilyStreamClass'; + String toString() => r'rawFamilyStreamClassProvider'; + + Override overrideWith( + RawFamilyStreamClass Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as RawFamilyStreamClassProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + Raw> Function(Ref>> ref, + RawFamilyStreamClass notifier, int argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as RawFamilyStreamClassProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$RawFamilyStreamClass extends $Notifier>> { - late final _$args = - (ref as $NotifierProviderElement).origin.argument as (int,); - int get id => _$args.$1; + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + int get id => _$args; Raw> build( int id, @@ -1220,7 +1651,7 @@ abstract class _$RawFamilyStreamClass extends $Notifier>> { @$internal @override Raw> runBuild() => build( - _$args.$1, + _$args, ); } @@ -1259,7 +1690,10 @@ final class PublicClassProvider extends $NotifierProvider { @$internal @override PublicClassProvider $copyWithBuild( - String Function(Ref, PublicClass) build, + String Function( + Ref, + PublicClass, + ) build, ) { return PublicClassProvider._(runNotifierBuildOverride: build); } @@ -1317,7 +1751,10 @@ final class _PrivateClassProvider @$internal @override _PrivateClassProvider $copyWithBuild( - String Function(Ref, _PrivateClass) build, + String Function( + Ref, + _PrivateClass, + ) build, ) { return _PrivateClassProvider._(runNotifierBuildOverride: build); } @@ -1367,6 +1804,13 @@ final class FamilyClassProvider extends $NotifierProvider { @override String debugGetCreateSourceHash() => _$familyClassHash(); + @override + String toString() { + return r'familyClassProvider' + '' + '$argument'; + } + @$internal @override FamilyClass create() => _createCb?.call() ?? FamilyClass(); @@ -1391,7 +1835,10 @@ final class FamilyClassProvider extends $NotifierProvider { @$internal @override FamilyClassProvider $copyWithBuild( - String Function(Ref, FamilyClass) build, + String Function( + Ref, + FamilyClass, + ) build, ) { return FamilyClassProvider._( argument: argument as ( @@ -1447,7 +1894,71 @@ final class FamilyClassFamily extends Family { String debugGetCreateSourceHash() => _$familyClassHash(); @override - String toString() => r'FamilyClass'; + String toString() => r'familyClassProvider'; + + Override overrideWith( + FamilyClass Function( + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyClassProvider; + + final argument = provider.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + String Function( + Ref ref, + FamilyClass notifier, + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyClassProvider; + + final argument = provider.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } abstract class _$FamilyClass extends $Notifier { @@ -1483,15 +1994,16 @@ abstract class _$FamilyClass extends $Notifier { ); } -const supports$InClassNameProvider = Supports$InClassNameProvider._(); +const supports$InClassNameProvider = Supports$InClassNameFamily._(); -final class Supports$InClassNameProvider - extends $NotifierProvider { +final class Supports$InClassNameProvider + extends $NotifierProvider, String> { const Supports$InClassNameProvider._( - {super.runNotifierBuildOverride, Supports$InClassName Function()? create}) + {required Supports$InClassNameFamily super.from, + super.runNotifierBuildOverride, + Supports$InClassName Function()? create}) : _createCb = create, super( - from: null, argument: null, name: r'supports$InClassNameProvider', isAutoDispose: true, @@ -1499,42 +2011,128 @@ final class Supports$InClassNameProvider allTransitiveDependencies: null, ); - final Supports$InClassName Function()? _createCb; + final Supports$InClassName Function()? _createCb; @override String debugGetCreateSourceHash() => _$supports$InClassNameHash(); + Supports$InClassNameProvider _copyWithCreate( + Supports$InClassName Function() create, + ) { + return Supports$InClassNameProvider._( + from: from! as Supports$InClassNameFamily, create: create); + } + + Supports$InClassNameProvider _copyWithBuild( + String Function( + Ref, + Supports$InClassName, + ) build, + ) { + return Supports$InClassNameProvider._( + from: from! as Supports$InClassNameFamily, + runNotifierBuildOverride: build); + } + + @override + String toString() { + return r'supports$InClassNameProvider' + '<${And$InT}>' + '()'; + } + @$internal @override - Supports$InClassName create() => _createCb?.call() ?? Supports$InClassName(); + Supports$InClassName create() => + _createCb?.call() ?? Supports$InClassName(); @$internal @override - Supports$InClassNameProvider $copyWithCreate( - Supports$InClassName Function() create, + Supports$InClassNameProvider $copyWithCreate( + Supports$InClassName Function() create, ) { - return Supports$InClassNameProvider._(create: create); + return Supports$InClassNameProvider._( + from: from! as Supports$InClassNameFamily, create: create); } @$internal @override - Supports$InClassNameProvider $copyWithBuild( - String Function(Ref, Supports$InClassName) build, + Supports$InClassNameProvider $copyWithBuild( + String Function( + Ref, + Supports$InClassName, + ) build, ) { - return Supports$InClassNameProvider._(runNotifierBuildOverride: build); + return Supports$InClassNameProvider._( + from: from! as Supports$InClassNameFamily, + runNotifierBuildOverride: build); } @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement, String> createElement( ProviderContainer container) => $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is Supports$InClassNameProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } } String _$supports$InClassNameHash() => - r'4e99f433d9cb3598faaf4d172edf9f28b9e68091'; + r'9eeab74a85af26136dd698df79669df4cec4c42b'; + +final class Supports$InClassNameFamily extends Family { + const Supports$InClassNameFamily._() + : super( + name: r'supports$InClassNameProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + Supports$InClassNameProvider call() => + Supports$InClassNameProvider._(from: this); + + @override + String debugGetCreateSourceHash() => _$supports$InClassNameHash(); + + @override + String toString() => r'supports$InClassNameProvider'; + + Override overrideWith( + Supports$InClassName Function() create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Supports$InClassNameProvider; + + return provider._copyWithCreate(create).createElement(container); + }, + ); + } + + Override overrideWithBuild( + String Function( + Ref ref, Supports$InClassName notifier) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Supports$InClassNameProvider; + + return provider._copyWithBuild(build).createElement(container); + }, + ); + } +} -abstract class _$Supports$InClassName extends $Notifier { +abstract class _$Supports$InClassName extends $Notifier { String build(); @$internal diff --git a/packages/riverpod_generator/test/sync_test.dart b/packages/riverpod_generator/test/sync_test.dart index 388995bd4..64fd53a5f 100644 --- a/packages/riverpod_generator/test/sync_test.dart +++ b/packages/riverpod_generator/test/sync_test.dart @@ -1,4 +1,4 @@ -// ignore_for_file: omit_local_variable_types, unused_local_variable, require_trailing_commas +// ignore_for_file: omit_local_variable_types, unused_local_variable import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; @@ -138,12 +138,13 @@ void main() { 'familyProvider(42, fifth: null, fourth: true, second: foo, third: 0.3)', ); + // TODO uncomment + // expect( + // publicProvider.overrideWithValue('foo').toString(), + // 'publicProvider.overrideWithValue(foo)', + // ); expect( - publicProvider.overrideWithValue('foo').toString(), - 'publicProvider.overrideWithValue(foo)', - ); - expect( - familyProvider.overrideWith((ref) => 'foo').toString(), + familyProvider.overrideWith((ref, _) => 'foo').toString(), 'familyProvider.overrideWith(...)', ); expect( @@ -152,6 +153,23 @@ void main() { .toString(), 'familyProvider(42, fifth: null, fourth: true, second: foo, third: 0.3).overrideWith(...)', ); + + expect( + complexGenericProvider(param: 42).toString(), + 'complexGenericProvider(otherParam: null, param: 42)', + ); + expect( + rawFamilyStreamProvider(42).toString(), + 'rawFamilyStreamProvider(42)', + ); + expect( + supports$InFnNameProvider().toString(), + r'supports$InFnNameProvider()', + ); + expect( + supports$InClassNameProvider().toString(), + r'supports$InClassNameProvider()', + ); }); test('Supports overriding non-family providers', () { @@ -168,15 +186,20 @@ void main() { test('Supports overriding family providers', () { final container = createContainer( overrides: [ - familyProvider(42, third: .42).overrideWith( - (ref, args) => 'Hello world ${args.first} ${args.second} ' + familyProvider.overrideWith( + (ref, args) => 'Hello world ${args.$1} ${args.second} ' '${args.third} ${args.fourth} ${args.fifth}', ), + familyProvider(42, third: .42).overrideWith((ref) => 'Override'), ], ); - final result = container.read(familyProvider(42, third: .42)); - expect(result, 'Hello world 42 null 0.42 true null'); + expect( + container.read(familyProvider(21, third: .21)), + 'Hello world 21 null 0.21 true null', + ); + + expect(container.read(familyProvider(42, third: .42)), 'Override'); }); test( @@ -292,15 +315,18 @@ void main() { }); test('can override providers', () { - final container = createContainer(overrides: [ - publicProvider.overrideWith((ref) => 'test'), - publicClassProvider.overrideWith(() => PublicClass(42)), - familyProvider.overrideWith( - (ref, args) => - 'test (first: ${args.first}, second: ${args.second}, third: ${args.third}, fourth: ${args.fourth}, fifth: ${args.fifth})', - ), - familyClassProvider.overrideWith(() => FamilyClass(42)), - ]); + final container = createContainer( + overrides: [ + publicProvider.overrideWith((ref) => 'test'), + publicClassProvider.overrideWith(() => PublicClass(42)), + // TODO test overrideWithBuild + familyProvider.overrideWith( + (ref, args) => + 'test (first: ${args.$1}, second: ${args.second}, third: ${args.third}, fourth: ${args.fourth}, fifth: ${args.fifth})', + ), + familyClassProvider.overrideWith(FamilyClass.new), + ], + ); expect(container.read(publicProvider), 'test'); expect(container.read(publicClassProvider.notifier).param, 42); @@ -312,7 +338,7 @@ void main() { container .read(familyClassProvider(42, second: '42', third: .42).notifier) .param, - 42, + (42, second: '42', third: 0.42, fourth: true, fifth: null), ); }); } From 923e408e931071e913a71135ddfb96d634dbe646 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 21:20:13 +0100 Subject: [PATCH 165/387] Fix remaining sync tests --- .../integration/build_yaml/lib/main.g.dart | 30 ++++++++++ .../lib/src/templates/provider.dart | 12 +++- .../test/integration/annotated.g.dart | 10 ++++ .../test/integration/async.g.dart | 30 ++++++++++ .../test/integration/dependencies.g.dart | 15 +++++ .../test/integration/dependencies2.g.dart | 10 ++++ .../test/integration/generated.g.dart | 35 ++++++++++++ .../test/integration/stream.g.dart | 20 +++++++ .../test/integration/sync.g.dart | 55 +++++++++++++++++++ 9 files changed, 215 insertions(+), 2 deletions(-) diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 75bf2c150..4b3022d42 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -225,6 +225,11 @@ final class Count2Provider extends $FunctionalProvider bool operator ==(Object other) { return other is Count2Provider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$count2Hash() => r'6256825480d83bb13acde282cf3c9d9524cc3a6c'; @@ -341,6 +346,11 @@ final class CountFuture2Provider bool operator ==(Object other) { return other is CountFuture2Provider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$countFuture2Hash() => r'096675b70a267f5d7c62ac7d3e7dd231ef529034'; @@ -457,6 +467,11 @@ final class CountStream2Provider bool operator ==(Object other) { return other is CountStream2Provider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$countStream2Hash() => r'051264dd685ebc0a57e454bb676957c93cb4ae20'; @@ -755,6 +770,11 @@ final class CountNotifier2Provider bool operator ==(Object other) { return other is CountNotifier2Provider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$countNotifier2Hash() => r'ef12bb4f94add336804ae43bcdbcd8e9b0bec420'; @@ -899,6 +919,11 @@ final class CountAsyncNotifier2Provider bool operator ==(Object other) { return other is CountAsyncNotifier2Provider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$countAsyncNotifier2Hash() => @@ -1047,6 +1072,11 @@ final class CountStreamNotifier2Provider bool operator ==(Object other) { return other is CountStreamNotifier2Provider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$countStreamNotifier2Hash() => diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 93effec9c..58730a5c0 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -294,8 +294,16 @@ final class $name$_genericsDefinition 'other.runtimeType == runtimeType', 'other.argument == argument', ].join(' && ')}; - } - '''); + } + + @override + int get hashCode { + return ${switch (provider.typeParameters?.typeParameters ?? []) { + [] => 'argument.hashCode', + [_, ...] => 'Object.hash(runtimeType, argument)', + }}; + } +'''); } void _writeToString(StringBuffer buffer) { diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 2d6223239..b567d5ad6 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -127,6 +127,11 @@ final class FamilyProvider bool operator ==(Object other) { return other is FamilyProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$familyHash() => r'd70685b83be840bfd9e79c11fb84c905d19d6e10'; @@ -294,6 +299,11 @@ final class NotCopiedFamilyProvider bool operator ==(Object other) { return other is NotCopiedFamilyProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$notCopiedFamilyHash() => r'6ef06ce6ebd73b476870bbe1af41c4f3fbe8ddb1'; diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 7a373e51f..de0d147a9 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -75,6 +75,11 @@ final class GenericProvider extends $FunctionalProvider< other.runtimeType == runtimeType && other.argument == argument; } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } } String _$genericHash() => r'6ee5473ece745b00328c1e048f6967c160343620'; @@ -281,6 +286,11 @@ final class FamilyOrProvider extends $FunctionalProvider, bool operator ==(Object other) { return other is FamilyOrProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$familyOrHash() => r'1c3217e296b0ce52c07c18769d1fffb95850f482'; @@ -438,6 +448,11 @@ final class FamilyProvider bool operator ==(Object other) { return other is FamilyProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$familyHash() => r'eb6fad35a94d4238b621c2100253ee2c700bee77'; @@ -588,6 +603,11 @@ final class GenericClassProvider other.runtimeType == runtimeType && other.argument == argument; } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } } String _$genericClassHash() => r'd3c4acc9cdae12f6c666fbf1f89aee212bb086db'; @@ -837,6 +857,11 @@ final class FamilyOrClassProvider bool operator ==(Object other) { return other is FamilyOrClassProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$familyOrClassHash() => r'b4882d4e79a03c63005d35eb7a021c9c4373a8d9'; @@ -1003,6 +1028,11 @@ final class FamilyClassProvider bool operator ==(Object other) { return other is FamilyClassProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$familyClassHash() => r'b7e3ca6091f12bbc99972e961acd885e05f42a15'; diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 6b0eb0cca..d54c92314 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -125,6 +125,11 @@ final class FamilyProvider extends $FunctionalProvider bool operator ==(Object other) { return other is FamilyProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$familyHash() => r'8c228ff14b8c6cf1f3d4d6266232d64b5057c440'; @@ -959,6 +964,11 @@ final class Family2Provider extends $NotifierProvider { bool operator ==(Object other) { return other is Family2Provider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$family2Hash() => r'ce727b262aae067b0d4f703f03670abb70ad8977'; @@ -1182,6 +1192,11 @@ final class Provider4Provider extends $NotifierProvider { bool operator ==(Object other) { return other is Provider4Provider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$provider4Hash() => r'1c955214d99695bb694c96374b277aac58e734df'; diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 3c0bc2620..4ac2787fd 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -155,6 +155,11 @@ final class FamilyWithDependencies2Provider return other is FamilyWithDependencies2Provider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$familyWithDependencies2Hash() => @@ -471,6 +476,11 @@ final class NotifierFamilyWithDependenciesProvider return other is NotifierFamilyWithDependenciesProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$notifierFamilyWithDependenciesHash() => diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 550c87dcb..3878dbbe9 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -127,6 +127,11 @@ final class GeneratedFamilyProvider bool operator ==(Object other) { return other is GeneratedFamilyProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$generatedFamilyHash() => r'ed284f58926c87acc81dab9168882d5d1c2cddf8'; @@ -293,6 +298,11 @@ final class $DynamicFamilyProvider bool operator ==(Object other) { return other is $DynamicFamilyProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$$dynamicFamilyHash() => r'b764133af8837b8321b08814892f198d4bc1aa18'; @@ -409,6 +419,11 @@ final class _DynamicProvider bool operator ==(Object other) { return other is _DynamicProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$dynamicHash() => r'da9dc07960139fff2cf5fe584dca5c524e4f2308'; @@ -578,6 +593,11 @@ final class AliasFamilyProvider extends $FunctionalProvider< bool operator ==(Object other) { return other is AliasFamilyProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$aliasFamilyHash() => r'f345937d5750132f629aef41646b119a301f750b'; @@ -752,6 +772,11 @@ final class GeneratedClassFamilyProvider bool operator ==(Object other) { return other is GeneratedClassFamilyProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$generatedClassFamilyHash() => @@ -961,6 +986,11 @@ final class $DynamicClassFamilyProvider bool operator ==(Object other) { return other is $DynamicClassFamilyProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$$dynamicClassFamilyHash() => @@ -1170,6 +1200,11 @@ final class AliasClassFamilyProvider bool operator ==(Object other) { return other is AliasClassFamilyProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$aliasClassFamilyHash() => r'3f348beb95dae3a9890b4a4d0ce01481316fc66d'; diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 621dc1b2c..667b6be15 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -75,6 +75,11 @@ final class GenericProvider extends $FunctionalProvider< other.runtimeType == runtimeType && other.argument == argument; } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } } String _$genericHash() => r'c1122edf55163d47de8d871ed5d15e0a7edddc05'; @@ -322,6 +327,11 @@ final class FamilyProvider bool operator ==(Object other) { return other is FamilyProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$familyHash() => r'6896fac2f6e3ccd7c38ecaa0d538cbd3577936b2'; @@ -472,6 +482,11 @@ final class GenericClassProvider other.runtimeType == runtimeType && other.argument == argument; } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } } String _$genericClassHash() => r'401ae1cfd97a4291dfd135a69ff8e1c436866e5a'; @@ -740,6 +755,11 @@ final class FamilyClassProvider bool operator ==(Object other) { return other is FamilyClassProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$familyClassHash() => r'6ec16ca23da8df4c010ecb5eed72e3e655504460'; diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index ac2cd3318..b8b6a6676 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -75,6 +75,11 @@ final class GenericProvider other.runtimeType == runtimeType && other.argument == argument; } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } } String _$genericHash() => r'0fda19dd377694315cdffd7414d53f98569c655c'; @@ -216,6 +221,11 @@ final class ComplexGenericProvider other.runtimeType == runtimeType && other.argument == argument; } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } } String _$complexGenericHash() => r'a5254e5552cd61bb8d65c018539ff2d8edfd5822'; @@ -451,6 +461,11 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< bool operator ==(Object other) { return other is RawFamilyFutureProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$rawFamilyFutureHash() => r'485f59512081852e51279658facc015309743864'; @@ -568,6 +583,11 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< bool operator ==(Object other) { return other is RawFamilyStreamProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$rawFamilyStreamHash() => r'e778e5cfcb8ab381e2412f5c73213aaa03b93012'; @@ -825,6 +845,11 @@ final class FamilyProvider bool operator ==(Object other) { return other is FamilyProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$familyHash() => r'14d1ee238ca608d547630d0e222ef4c5866e9e61'; @@ -1012,6 +1037,11 @@ final class Supports$InFnNameProvider other.runtimeType == runtimeType && other.argument == argument; } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } } String _$supports$InFnNameHash() => r'fec3daca655669a46760cc54921f098b9cbaac3d'; @@ -1181,6 +1211,11 @@ final class GenericClassProvider other.runtimeType == runtimeType && other.argument == argument; } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } } String _$genericClassHash() => r'671e348a5abf8e00ab06c5f247defbca8af9677b'; @@ -1429,6 +1464,11 @@ final class RawFamilyFutureClassProvider bool operator ==(Object other) { return other is RawFamilyFutureClassProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$rawFamilyFutureClassHash() => @@ -1576,6 +1616,11 @@ final class RawFamilyStreamClassProvider bool operator ==(Object other) { return other is RawFamilyStreamClassProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$rawFamilyStreamClassHash() => @@ -1862,6 +1907,11 @@ final class FamilyClassProvider extends $NotifierProvider { bool operator ==(Object other) { return other is FamilyClassProvider && other.argument == argument; } + + @override + int get hashCode { + return argument.hashCode; + } } String _$familyClassHash() => r'01e3b9cb4d6d0bf12a2284761b1a11819d97d249'; @@ -2080,6 +2130,11 @@ final class Supports$InClassNameProvider other.runtimeType == runtimeType && other.argument == argument; } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } } String _$supports$InClassNameHash() => From d1ad70d172dac174221f8f64181b1f8636948707 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 21:38:18 +0100 Subject: [PATCH 166/387] Fix most tests --- .../test/async_notifier_test.dart | 16 ++---- .../riverpod_generator/test/async_test.dart | 33 ++++++------ .../test/auto_dispose_test.dart | 20 ++------ .../test/dependencies_test.dart | 4 +- .../test/integration/auto_dispose.dart | 5 ++ .../test/integration/auto_dispose.g.dart | 50 +++++++++++++++++++ .../test/notifier_test.dart | 16 ++---- .../test/stream_notifier_test.dart | 16 ++---- .../riverpod_generator/test/stream_test.dart | 40 ++++++++------- .../riverpod_generator/test/sync_test.dart | 2 +- 10 files changed, 115 insertions(+), 87 deletions(-) diff --git a/packages/riverpod_generator/test/async_notifier_test.dart b/packages/riverpod_generator/test/async_notifier_test.dart index df2d7d17f..e1f72c319 100644 --- a/packages/riverpod_generator/test/async_notifier_test.dart +++ b/packages/riverpod_generator/test/async_notifier_test.dart @@ -1,5 +1,5 @@ // ignore_for_file: omit_local_variable_types, unused_local_variable - +import 'package:riverpod/riverpod.dart' show ProviderBase; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:test/test.dart'; @@ -12,8 +12,7 @@ void main() { () { final container = createContainer(); - final AutoDisposeAsyncNotifierProvider provider = - publicClassProvider; + const ProviderBase> provider = publicClassProvider; final AsyncValue result = container.read(publicClassProvider); expect(result, const AsyncData('Hello world')); @@ -37,6 +36,7 @@ void main() { final notifier = container.read(publicClassProvider.notifier); expect(notifier.param, 'Hello world'); + // ignore: invalid_use_of_protected_member expect(notifier.ref, isNotNull); expect(notifier.state, isNotNull); }); @@ -58,6 +58,7 @@ void main() { expect(notifier.fourth, true); expect(notifier.fifth, null); + // ignore: invalid_use_of_protected_member expect(notifier.ref, isNotNull); expect(notifier.state, isNotNull); }); @@ -108,14 +109,7 @@ void main() { fifth: const ['x42'], ); // ignore: invalid_use_of_internal_member - final AutoDisposeAsyncNotifierProviderImpl - futureProvider = provider; - - expect(provider.first, 42); - expect(provider.second, 'x42'); - expect(provider.third, .42); - expect(provider.fourth, false); - expect(provider.fifth, same(const ['x42'])); + final ProviderBase> futureProvider = provider; final sub = container.listen( familyClassProvider( diff --git a/packages/riverpod_generator/test/async_test.dart b/packages/riverpod_generator/test/async_test.dart index 9ba02be22..bf1c24887 100644 --- a/packages/riverpod_generator/test/async_test.dart +++ b/packages/riverpod_generator/test/async_test.dart @@ -1,5 +1,6 @@ // ignore_for_file: omit_local_variable_types, unused_local_variable +import 'package:riverpod/riverpod.dart' show ProviderBase; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:test/test.dart'; @@ -12,7 +13,7 @@ void main() { () { final container = createContainer(); - final AutoDisposeFutureProvider provider = publicProvider; + const ProviderBase> provider = publicProvider; final AsyncValue result = container.read(publicProvider); expect(result, const AsyncData('Hello world')); @@ -40,10 +41,13 @@ void main() { test('Supports overriding family providers', () async { final container = createContainer( overrides: [ - familyProvider(42, third: .42).overrideWith( - (ref) => Future.value( - 'Hello world ${ref.first} ${ref.second} ' - '${ref.third} ${ref.fourth} ${ref.fifth}', + familyProvider(21, third: .21).overrideWith( + (ref) => Future.value('Override'), + ), + familyProvider.overrideWith( + (ref, args) => Future.value( + 'Hello world ${args.$1} ${args.second} ' + '${args.third} ${args.fourth} ${args.fifth}', ), ), ], @@ -51,6 +55,9 @@ void main() { final result = container.read(familyProvider(42, third: .42).future); expect(await result, 'Hello world 42 null 0.42 true null'); + + final result2 = container.read(familyProvider(21, third: .21).future); + expect(await result2, 'Override'); }); test( @@ -98,13 +105,7 @@ void main() { fourth: false, fifth: const ['x42'], ); - final AutoDisposeFutureProvider futureProvider = provider; - - expect(provider.first, 42); - expect(provider.second, 'x42'); - expect(provider.third, .42); - expect(provider.fourth, false); - expect(provider.fifth, same(const ['x42'])); + final ProviderBase> futureProvider = provider; final sub = container.listen( familyProvider( @@ -145,13 +146,13 @@ void main() { }), publicClassProvider.overrideWith(() => PublicClass(42)), familyProvider.overrideWith( - (ref) { + (ref, args) { final FutureOr result = - 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})'; + 'test (first: ${args.$1}, second: ${args.second}, third: ${args.third}, fourth: ${args.fourth}, fifth: ${args.fifth})'; return result; }, ), - familyClassProvider.overrideWith(() => FamilyClass(42)), + familyClassProvider.overrideWith(FamilyClass.new), ], ); @@ -165,7 +166,7 @@ void main() { container .read(familyClassProvider(42, second: '42', third: .42).notifier) .param, - 42, + (42, second: '42', third: 0.42, fourth: true, fifth: null), ); }); } diff --git a/packages/riverpod_generator/test/auto_dispose_test.dart b/packages/riverpod_generator/test/auto_dispose_test.dart index affc1e10e..a5415e9f9 100644 --- a/packages/riverpod_generator/test/auto_dispose_test.dart +++ b/packages/riverpod_generator/test/auto_dispose_test.dart @@ -1,24 +1,10 @@ -// ignore_for_file: omit_local_variable_types, unused_local_variable - -import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:test/test.dart'; - import 'integration/auto_dispose.dart'; -import 'utils.dart'; void main() { test('Respects keepAlive parameter', () { - final container = createContainer(); - - container.read(keepAliveProvider); - - expect( - container.readProviderElement(keepAliveProvider), - isA>(), - ); - expect( - container.readProviderElement(keepAliveProvider), - isNot(isA>()), - ); + expect(keepAliveProvider.isAutoDispose, isFalse); + expect(notKeepAliveProvider.isAutoDispose, isTrue); + expect(defaultKeepAliveProvider.isAutoDispose, isTrue); }); } diff --git a/packages/riverpod_generator/test/dependencies_test.dart b/packages/riverpod_generator/test/dependencies_test.dart index dfda6ca78..a0d4e93fa 100644 --- a/packages/riverpod_generator/test/dependencies_test.dart +++ b/packages/riverpod_generator/test/dependencies_test.dart @@ -76,12 +76,12 @@ void main() { expect( emptyDependenciesFunctionalProvider.allTransitiveDependencies, - same(const {}), + same(const []), ); expect( emptyDependenciesClassBasedProvider.allTransitiveDependencies, - same(const {}), + same(const []), ); }); diff --git a/packages/riverpod_generator/test/integration/auto_dispose.dart b/packages/riverpod_generator/test/integration/auto_dispose.dart index a63f1ce0e..744d77f09 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.dart @@ -12,3 +12,8 @@ int notKeepAlive(NotKeepAliveRef ref) { ref.keepAlive(); return 0; } + +@riverpod +int defaultKeepAlive(DefaultKeepAliveRef ref) { + return 0; +} diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 1eebde258..feb8ca659 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -106,6 +106,56 @@ final class NotKeepAliveProvider String _$notKeepAliveHash() => r'1ccc497d7c651f8e730ec1bcecf271ffe9615d83'; +typedef DefaultKeepAliveRef = Ref; + +const defaultKeepAliveProvider = DefaultKeepAliveProvider._(); + +final class DefaultKeepAliveProvider + extends $FunctionalProvider + with $Provider { + const DefaultKeepAliveProvider._( + {int Function( + DefaultKeepAliveRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'defaultKeepAliveProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + DefaultKeepAliveRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$defaultKeepAliveHash(); + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DefaultKeepAliveProvider $copyWithCreate( + int Function( + DefaultKeepAliveRef ref, + ) create, + ) { + return DefaultKeepAliveProvider._(create: create); + } + + @override + int create(DefaultKeepAliveRef ref) { + final fn = _createCb ?? defaultKeepAlive; + return fn(ref); + } +} + +String _$defaultKeepAliveHash() => r'1c236764d83a62ca442c5d5b4a83bd0d6e4548cf'; + const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/notifier_test.dart b/packages/riverpod_generator/test/notifier_test.dart index a455f51ac..a0bd63b88 100644 --- a/packages/riverpod_generator/test/notifier_test.dart +++ b/packages/riverpod_generator/test/notifier_test.dart @@ -1,6 +1,6 @@ // ignore_for_file: omit_local_variable_types, unused_local_variable -import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:riverpod/riverpod.dart' show ProviderBase; import 'package:test/test.dart'; import 'integration/sync.dart'; @@ -11,8 +11,7 @@ void main() { () { final container = createContainer(); - final AutoDisposeNotifierProvider provider = - publicClassProvider; + const ProviderBase provider = publicClassProvider; final String result = container.read(publicProvider); expect(result, 'Hello world'); @@ -36,6 +35,7 @@ void main() { final notifier = container.read(publicClassProvider.notifier); expect(notifier.param, 'Hello world'); + // ignore: invalid_use_of_protected_member expect(notifier.ref, isNotNull); expect(notifier.state, isNotNull); }); @@ -57,6 +57,7 @@ void main() { expect(notifier.fourth, true); expect(notifier.fifth, null); + // ignore: invalid_use_of_protected_member expect(notifier.ref, isNotNull); expect(notifier.state, isNotNull); }); @@ -107,14 +108,7 @@ void main() { fifth: ['x42'], ); // ignore: invalid_use_of_internal_member - final AutoDisposeNotifierProviderImpl futureProvider = - provider; - - expect(provider.first, 42); - expect(provider.second, 'x42'); - expect(provider.third, .42); - expect(provider.fourth, false); - expect(provider.fifth, ['x42']); + final ProviderBase futureProvider = provider; final String result = container.read( familyClassProvider( diff --git a/packages/riverpod_generator/test/stream_notifier_test.dart b/packages/riverpod_generator/test/stream_notifier_test.dart index 5de59ca8c..e69ef6d0a 100644 --- a/packages/riverpod_generator/test/stream_notifier_test.dart +++ b/packages/riverpod_generator/test/stream_notifier_test.dart @@ -1,5 +1,6 @@ // ignore_for_file: omit_local_variable_types, unused_local_variable +import 'package:riverpod/riverpod.dart' show ProviderBase; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:test/test.dart'; @@ -12,8 +13,7 @@ void main() { () async { final container = createContainer(); - final AutoDisposeStreamNotifierProvider provider = - publicClassProvider; + const ProviderBase> provider = publicClassProvider; expect( await container.listen(publicClassProvider.future, (_, __) {}).read(), @@ -39,6 +39,7 @@ void main() { final notifier = container.read(publicClassProvider.notifier); expect(notifier.param, 'Hello world'); + // ignore: invalid_use_of_protected_member expect(notifier.ref, isNotNull); expect(notifier.state, isNotNull); }); @@ -60,6 +61,7 @@ void main() { expect(notifier.fourth, true); expect(notifier.fifth, null); + // ignore: invalid_use_of_protected_member expect(notifier.ref, isNotNull); expect(notifier.state, isNotNull); }); @@ -109,15 +111,7 @@ void main() { fourth: false, fifth: ['x42'], ); - // ignore: invalid_use_of_internal_member - final AutoDisposeStreamNotifierProviderImpl - futureProvider = provider; - - expect(provider.first, 42); - expect(provider.second, 'x42'); - expect(provider.third, .42); - expect(provider.fourth, false); - expect(provider.fifth, ['x42']); + final ProviderBase> futureProvider = provider; expect( await container diff --git a/packages/riverpod_generator/test/stream_test.dart b/packages/riverpod_generator/test/stream_test.dart index fc23c0e5c..9967aff14 100644 --- a/packages/riverpod_generator/test/stream_test.dart +++ b/packages/riverpod_generator/test/stream_test.dart @@ -1,5 +1,6 @@ // ignore_for_file: omit_local_variable_types, unused_local_variable +import 'package:riverpod/riverpod.dart' show ProviderBase; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:test/test.dart'; @@ -11,7 +12,7 @@ void main() { () async { final container = createContainer(); - final AutoDisposeStreamProvider provider = publicProvider; + const ProviderBase> provider = publicProvider; expect( await container.listen(publicProvider.future, (_, __) {}).read(), @@ -41,17 +42,26 @@ void main() { test('Supports overriding family providers', () async { final container = createContainer( overrides: [ - familyProvider(42, third: .42).overrideWith( - (ref) => Stream.value( - 'Hello world ${ref.first} ${ref.second} ' - '${ref.third} ${ref.fourth} ${ref.fifth}', + familyProvider.overrideWith( + (ref, args) => Stream.value( + 'Hello world ${args.$1} ${args.second} ' + '${args.third} ${args.fourth} ${args.fifth}', ), ), + familyProvider(21, third: .21).overrideWith( + (ref) => Stream.value('Override'), + ), ], ); - final result = container.read(familyProvider(42, third: .42).future); - expect(await result, 'Hello world 42 null 0.42 true null'); + expect( + await container.read(familyProvider(42, third: .42).future), + 'Hello world 42 null 0.42 true null', + ); + expect( + await container.read(familyProvider(21, third: .21).future), + 'Override', + ); }); test( @@ -99,13 +109,7 @@ void main() { fourth: false, fifth: ['x42'], ); - final AutoDisposeStreamProvider futureProvider = provider; - - expect(provider.first, 42); - expect(provider.second, 'x42'); - expect(provider.third, .42); - expect(provider.fourth, false); - expect(provider.fifth, ['x42']); + final ProviderBase> futureProvider = provider; expect( await container @@ -133,14 +137,14 @@ void main() { }), publicClassProvider.overrideWith(() => PublicClass(42)), familyProvider.overrideWith( - (ref) { + (ref, args) { ref.state = AsyncData( - 'test (first: ${ref.first}, second: ${ref.second}, third: ${ref.third}, fourth: ${ref.fourth}, fifth: ${ref.fifth})', + 'test (first: ${args.$1}, second: ${args.second}, third: ${args.third}, fourth: ${args.fourth}, fifth: ${args.fifth})', ); return const Stream.empty(); }, ), - familyClassProvider.overrideWith(() => FamilyClass(42)), + familyClassProvider.overrideWith(FamilyClass.new), ], ); @@ -154,7 +158,7 @@ void main() { container .read(familyClassProvider(42, second: '42', third: .42).notifier) .param, - 42, + (42, second: '42', third: 0.42, fourth: true, fifth: null), ); }); } diff --git a/packages/riverpod_generator/test/sync_test.dart b/packages/riverpod_generator/test/sync_test.dart index 64fd53a5f..515d860da 100644 --- a/packages/riverpod_generator/test/sync_test.dart +++ b/packages/riverpod_generator/test/sync_test.dart @@ -1,6 +1,6 @@ // ignore_for_file: omit_local_variable_types, unused_local_variable -import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/riverpod.dart' show ProviderBase; import 'package:test/test.dart'; import 'integration/sync.dart'; From f90649776a6aaeffc60adeea6e56cd8438e092fc Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 21:55:20 +0100 Subject: [PATCH 167/387] Add more $ tests --- .../lib/src/templates/family.dart | 27 +- .../test/annotated_test.dart | 2 + .../test/integration/sync.dart | 25 + .../test/integration/sync.g.dart | 426 +++++++++++++++++- 4 files changed, 468 insertions(+), 12 deletions(-) diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index b480bd0f7..40ecd401e 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -114,12 +114,13 @@ Override overrideWith($createType create,) { switch (( hasParameters: provider.parameters.isNotEmpty, hasGenerics: provider.typeParameters?.typeParameters.isNotEmpty ?? false, + provider, )) { - case (hasParameters: false, hasGenerics: false): + case (hasParameters: false, hasGenerics: false, _): buffer.writeln( r'return provider.$copyWithCreate(create).createElement(container);', ); - case (hasParameters: true, hasGenerics: false): + case (hasParameters: true, hasGenerics: false, _): buffer.writeln(''' final argument = provider.argument as $_argumentRecordType; @@ -129,17 +130,31 @@ Override overrideWith($createType create,) { }}).createElement(container); '''); - case (hasParameters: false, hasGenerics: true): + case (hasParameters: false, hasGenerics: true, _): buffer.writeln( 'return provider._copyWithCreate(create).createElement(container);', ); - case (hasParameters: true, hasGenerics: true): + case ( + hasParameters: true, + hasGenerics: true, + FunctionalProviderDeclaration() + ): buffer.writeln(''' return provider._copyWithCreate($_genericsDefinition(ref, $_parameterDefinition) { + return create(ref, ${provider.argumentToRecord()}); + }).createElement(container); + '''); + case ( + hasParameters: true, + hasGenerics: true, + ClassBasedProviderDeclaration() + ): + buffer.writeln(''' + return provider._copyWithCreate($_genericsDefinition() { final argument = provider.argument as $_argumentRecordType; - return create(ref, argument); + return create(argument); }).createElement(container); '''); } @@ -196,7 +211,7 @@ Override overrideWithBuild($runNotifierBuildType build,) { case (hasParameters: true, hasGenerics: true): buffer.writeln(''' - return provider._copyWithBuild($_genericsDefinition(ref, notifier, $_parameterDefinition) { + return provider._copyWithBuild($_genericsDefinition(ref, notifier) { final argument = provider.argument as $_argumentRecordType; return build(ref, notifier, argument); diff --git a/packages/riverpod_generator/test/annotated_test.dart b/packages/riverpod_generator/test/annotated_test.dart index 01ffe8571..30aeb2e32 100644 --- a/packages/riverpod_generator/test/annotated_test.dart +++ b/packages/riverpod_generator/test/annotated_test.dart @@ -12,6 +12,8 @@ void main() async { .whereType() .toList(); + // TODO test import docs + test('Annotations on generated functionalProvider', () async { final annotations = topLevelDeclarations .findNamed('functionalProvider') diff --git a/packages/riverpod_generator/test/integration/sync.dart b/packages/riverpod_generator/test/integration/sync.dart index 52af9c043..b83aae4cb 100644 --- a/packages/riverpod_generator/test/integration/sync.dart +++ b/packages/riverpod_generator/test/integration/sync.dart @@ -159,6 +159,18 @@ String supports$InFnName(Supports$InFnNameRef ref) { return 'Hello world'; } +const default$value = ''; + +@riverpod +String supports$InFnNameFamily( + Supports$InFnNameFamilyRef ref, + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg = default$value, +}) { + return 'Hello world'; +} + @riverpod class Supports$InClassName extends _$Supports$InClassName { @override @@ -167,6 +179,19 @@ class Supports$InClassName extends _$Supports$InClassName { } } +@riverpod +class Supports$InClassFamilyName + extends _$Supports$InClassFamilyName { + @override + String build( + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg = default$value, + }) { + return 'Hello world'; + } +} + @riverpod String generated(GeneratedRef ref) { return 'Just a simple normal generated provider'; diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index b8b6a6676..84beba633 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -273,12 +273,10 @@ final class ComplexGenericFamily extends Family { required T param, Foo? otherParam, }) { - final argument = provider.argument as ({ - T param, - Foo? otherParam, - }); - - return create(ref, argument); + return create(ref, ( + param: param, + otherParam: otherParam, + )); }).createElement(container); }, ); @@ -1078,6 +1076,191 @@ final class Supports$InFnNameFamily extends Family { } } +typedef Supports$InFnNameFamilyRef = Ref; + +const supports$InFnNameFamilyProvider = Supports$InFnNameFamilyFamily._(); + +final class Supports$InFnNameFamilyProvider + extends $FunctionalProvider> + with $Provider> { + const Supports$InFnNameFamilyProvider._( + {required Supports$InFnNameFamilyFamily super.from, + required ( + And$InT, { + And$InT named$arg, + String defaultArg, + }) + super.argument, + String Function( + Supports$InFnNameFamilyRef ref, + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg, + })? create}) + : _createCb = create, + super( + name: r'supports$InFnNameFamilyProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + Supports$InFnNameFamilyRef ref, + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg, + })? _createCb; + + @override + String debugGetCreateSourceHash() => _$supports$InFnNameFamilyHash(); + + Supports$InFnNameFamilyProvider _copyWithCreate( + String Function( + Supports$InFnNameFamilyRef ref, + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg, + }) create, + ) { + return Supports$InFnNameFamilyProvider._( + argument: argument as ( + And$InT, { + And$InT named$arg, + String defaultArg, + }), + from: from! as Supports$InFnNameFamilyFamily, + create: create); + } + + @override + String toString() { + return r'supports$InFnNameFamilyProvider' + '<${And$InT}>' + '$argument'; + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Supports$InFnNameFamilyProvider $copyWithCreate( + String Function( + Supports$InFnNameFamilyRef ref, + ) create, + ) { + return Supports$InFnNameFamilyProvider._( + argument: argument as ( + And$InT, { + And$InT named$arg, + String defaultArg, + }), + from: from! as Supports$InFnNameFamilyFamily, + create: ( + ref, + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg = default$value, + }) => + create(ref)); + } + + @override + String create(Supports$InFnNameFamilyRef ref) { + final fn = _createCb ?? supports$InFnNameFamily; + final ( + And$InT, { + And$InT named$arg, + String defaultArg, + }) argument = this.argument as ( + And$InT, { + And$InT named$arg, + String defaultArg, + }); + return fn( + ref, + argument.$1, + named$arg: argument.named$arg, + defaultArg: argument.defaultArg, + ); + } + + @override + bool operator ==(Object other) { + return other is Supports$InFnNameFamilyProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } +} + +String _$supports$InFnNameFamilyHash() => + r'1daa434fa2ad9ff37deade29ba3ca8155833df1b'; + +final class Supports$InFnNameFamilyFamily extends Family { + const Supports$InFnNameFamilyFamily._() + : super( + name: r'supports$InFnNameFamilyProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + Supports$InFnNameFamilyProvider call( + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg = default$value, + }) => + Supports$InFnNameFamilyProvider._(argument: ( + positional$arg, + named$arg: named$arg, + defaultArg: defaultArg, + ), from: this); + + @override + String debugGetCreateSourceHash() => _$supports$InFnNameFamilyHash(); + + @override + String toString() => r'supports$InFnNameFamilyProvider'; + + Override overrideWith( + String Function( + Supports$InFnNameFamilyRef ref, + ( + And$InT, { + And$InT named$arg, + String defaultArg, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Supports$InFnNameFamilyProvider; + + return provider._copyWithCreate(( + ref, + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg = default$value, + }) { + return create(ref, ( + positional$arg, + named$arg: named$arg, + defaultArg: defaultArg, + )); + }).createElement(container); + }, + ); + } +} + typedef GeneratedRef = Ref; const generatedProvider = GeneratedProvider._(); @@ -2195,6 +2378,237 @@ abstract class _$Supports$InClassName extends $Notifier { String runBuild() => build(); } +const supports$InClassFamilyNameProvider = Supports$InClassFamilyNameFamily._(); + +final class Supports$InClassFamilyNameProvider + extends $NotifierProvider, String> { + const Supports$InClassFamilyNameProvider._( + {required Supports$InClassFamilyNameFamily super.from, + required ( + And$InT, { + And$InT named$arg, + String defaultArg, + }) + super.argument, + super.runNotifierBuildOverride, + Supports$InClassFamilyName Function()? create}) + : _createCb = create, + super( + name: r'supports$InClassFamilyNameProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Supports$InClassFamilyName Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$supports$InClassFamilyNameHash(); + + Supports$InClassFamilyNameProvider _copyWithCreate( + Supports$InClassFamilyName Function() create, + ) { + return Supports$InClassFamilyNameProvider._( + argument: argument as ( + And$InT, { + And$InT named$arg, + String defaultArg, + }), + from: from! as Supports$InClassFamilyNameFamily, + create: create); + } + + Supports$InClassFamilyNameProvider _copyWithBuild( + String Function( + Ref, + Supports$InClassFamilyName, + ) build, + ) { + return Supports$InClassFamilyNameProvider._( + argument: argument as ( + And$InT, { + And$InT named$arg, + String defaultArg, + }), + from: from! as Supports$InClassFamilyNameFamily, + runNotifierBuildOverride: build); + } + + @override + String toString() { + return r'supports$InClassFamilyNameProvider' + '<${And$InT}>' + '$argument'; + } + + @$internal + @override + Supports$InClassFamilyName create() => + _createCb?.call() ?? Supports$InClassFamilyName(); + + @$internal + @override + Supports$InClassFamilyNameProvider $copyWithCreate( + Supports$InClassFamilyName Function() create, + ) { + return Supports$InClassFamilyNameProvider._( + argument: argument as ( + And$InT, { + And$InT named$arg, + String defaultArg, + }), + from: from! as Supports$InClassFamilyNameFamily, + create: create); + } + + @$internal + @override + Supports$InClassFamilyNameProvider $copyWithBuild( + String Function( + Ref, + Supports$InClassFamilyName, + ) build, + ) { + return Supports$InClassFamilyNameProvider._( + argument: argument as ( + And$InT, { + And$InT named$arg, + String defaultArg, + }), + from: from! as Supports$InClassFamilyNameFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement, String> + createElement(ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is Supports$InClassFamilyNameProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } +} + +String _$supports$InClassFamilyNameHash() => + r'39e844561e4f4727011bb2f97169d0334c928b20'; + +final class Supports$InClassFamilyNameFamily extends Family { + const Supports$InClassFamilyNameFamily._() + : super( + name: r'supports$InClassFamilyNameProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + Supports$InClassFamilyNameProvider call( + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg = default$value, + }) => + Supports$InClassFamilyNameProvider._(argument: ( + positional$arg, + named$arg: named$arg, + defaultArg: defaultArg, + ), from: this); + + @override + String debugGetCreateSourceHash() => _$supports$InClassFamilyNameHash(); + + @override + String toString() => r'supports$InClassFamilyNameProvider'; + + Override overrideWith( + Supports$InClassFamilyName Function( + ( + And$InT, { + And$InT named$arg, + String defaultArg, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Supports$InClassFamilyNameProvider; + + return provider._copyWithCreate(() { + final argument = provider.argument as ( + And$InT, { + And$InT named$arg, + String defaultArg, + }); + + return create(argument); + }).createElement(container); + }, + ); + } + + Override overrideWithBuild( + String Function( + Ref ref, + Supports$InClassFamilyName notifier, + ( + And$InT, { + And$InT named$arg, + String defaultArg, + }) argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Supports$InClassFamilyNameProvider; + + return provider._copyWithBuild((ref, notifier) { + final argument = provider.argument as ( + And$InT, { + And$InT named$arg, + String defaultArg, + }); + + return build(ref, notifier, argument); + }).createElement(container); + }, + ); + } +} + +abstract class _$Supports$InClassFamilyName extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as ( + And$InT, { + And$InT named$arg, + String defaultArg, + }); + And$InT get positional$arg => _$args.$1; + And$InT get named$arg => _$args.named$arg; + String get defaultArg => _$args.defaultArg; + + String build( + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg = default$value, + }); + + @$internal + @override + String runBuild() => build( + _$args.$1, + named$arg: _$args.named$arg, + defaultArg: _$args.defaultArg, + ); +} + const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package From 1a703761c91cdebe975a5d6002bd8e31491d5c21 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 22:02:30 +0100 Subject: [PATCH 168/387] Fix some errors --- .../lib/src/riverpod_generator.dart | 4 +- .../src/templates/class_based_provider.dart | 66 ---- .../lib/src/templates/family_back.dart | 357 ------------------ .../src/templates/functional_provider.dart | 76 ---- .../test/integration/async.dart | 1 - .../test/integration/sync.dart | 4 +- 6 files changed, 3 insertions(+), 505 deletions(-) delete mode 100644 packages/riverpod_generator/lib/src/templates/class_based_provider.dart delete mode 100644 packages/riverpod_generator/lib/src/templates/family_back.dart delete mode 100644 packages/riverpod_generator/lib/src/templates/functional_provider.dart diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index ba0b48fae..43fc40d1f 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -274,7 +274,6 @@ extension ProviderNames on GeneratorProviderDeclaration { String get argumentRecordType { // Encode the list of parameters into a record. // We do so only if there are at least two parameters. - // TODO test switch (parameters) { case [_]: return parameters.first.typeDisplayString; @@ -300,10 +299,9 @@ extension ProviderNames on GeneratorProviderDeclaration { } } - // TODO possibly no-longer needed String dependencies(BuildYamlOptions options) => providerElement.dependencies(options); - // TODO possibly no-longer needed + String allTransitiveDependencies(List? allTransitiveDependencies) { return providerElement.allTransitiveDependencies(allTransitiveDependencies); } diff --git a/packages/riverpod_generator/lib/src/templates/class_based_provider.dart b/packages/riverpod_generator/lib/src/templates/class_based_provider.dart deleted file mode 100644 index 7536df004..000000000 --- a/packages/riverpod_generator/lib/src/templates/class_based_provider.dart +++ /dev/null @@ -1,66 +0,0 @@ -import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; -import '../models.dart'; -import '../riverpod_generator.dart'; -import 'family_back.dart'; -import 'template.dart'; - -class ClassBasedProviderTemplate extends Template { - ClassBasedProviderTemplate( - this.provider, { - required this.notifierTypedefName, - required this.hashFn, - required this.options, - }) { - if (provider.providerElement.isFamily) { - throw ArgumentError.value( - provider.providerElement.isFamily, - 'provider.providerElement.isFamily', - 'Expected a non-family provider', - ); - } - } - final ClassBasedProviderDeclaration provider; - final String notifierTypedefName; - final String hashFn; - final BuildYamlOptions options; - - @override - void run(StringBuffer buffer) { - final isAutoDispose = !provider.providerElement.annotation.keepAlive - ? 'isAutoDispose: true,' - : ''; - - var notifierBaseType = 'Notifier'; - var providerType = 'NotifierProvider'; - - final providerName = providerNameFor(provider.providerElement, options); - final returnType = provider.createdTypeNode?.type; - if (returnType != null && !returnType.isRaw) { - if ((returnType.isDartAsyncFutureOr) || (returnType.isDartAsyncFuture)) { - notifierBaseType = 'AsyncNotifier'; - providerType = 'AsyncNotifierProvider'; - } else if (returnType.isDartAsyncStream) { - notifierBaseType = 'StreamNotifier'; - providerType = 'StreamNotifierProvider'; - } - } - - buffer.write(''' -${providerDocFor(provider.providerElement.element)} -@ProviderFor(${provider.name}) -${metaAnnotations(provider.node.metadata)} -final $providerName = $providerType<${provider.name}, ${provider.valueTypeDisplayString}>.internal( - ${provider.providerElement.name}.new, - name: r'$providerName', - from: null, - argument: null, - $isAutoDispose - debugGetCreateSourceHash: $hashFn, - dependencies: ${provider.dependencies(options)}, - allTransitiveDependencies: null, -); - -typedef $notifierTypedefName = $notifierBaseType<${provider.valueTypeDisplayString}>; -'''); - } -} diff --git a/packages/riverpod_generator/lib/src/templates/family_back.dart b/packages/riverpod_generator/lib/src/templates/family_back.dart deleted file mode 100644 index e0998216a..000000000 --- a/packages/riverpod_generator/lib/src/templates/family_back.dart +++ /dev/null @@ -1,357 +0,0 @@ -import 'package:analyzer/dart/ast/ast.dart'; -import 'package:collection/collection.dart'; -import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; - -import '../models.dart'; -import '../riverpod_generator.dart'; -import '../type.dart'; -import 'class_based_provider.dart'; -import 'parameters.dart'; -import 'template.dart'; - -String providerFamilyNameFor( - ProviderDeclarationElement provider, - BuildYamlOptions options, -) { - return '${provider.name.lowerFirst}${options.providerFamilyNameSuffix ?? options.providerNameSuffix ?? 'Provider'}'; -} - -class FamilyTemplate extends Template { - FamilyTemplate._( - this.provider, { - required this.options, - required this.parameters, - required this.typeParameters, - required this.providerType, - required this.refType, - required this.elementType, - required this.providerGenerics, - required this.providerCreate, - required this.parametersPassThrough, - required this.hashFn, - required this.createType, - required this.overrideCreate, - this.other = '', - this.providerOther = '', - }) { - if (!provider.providerElement.isFamily) { - throw ArgumentError.value( - provider.providerElement.isFamily, - 'provider.providerElement.isFamily', - 'Expected a family provider', - ); - } - } - - factory FamilyTemplate.functional( - FunctionalProviderDeclaration provider, { - required String hashFn, - required BuildYamlOptions options, - }) { - var providerType = 'Provider'; - var refType = 'Ref<${provider.valueTypeDisplayString}>'; - var elementType = 'ProviderElement'; - - final returnType = provider.createdTypeNode?.type; - if (returnType != null && !returnType.isRaw) { - if (returnType.isDartAsyncFutureOr || returnType.isDartAsyncFuture) { - providerType = 'FutureProvider'; - refType = 'Ref>'; - elementType = 'FutureProviderElement'; - } else if (returnType.isDartAsyncStream) { - providerType = 'StreamProvider'; - refType = 'Ref>'; - elementType = 'StreamProviderElement'; - } - } - - final parameters = provider.node.functionExpression.parameters!.parameters - .skip(1) - .toList(); - - final parametersPassThrough = buildParamInvocationQuery({ - for (final parameter in parameters) parameter: parameter.name!.lexeme, - }); - - final typeParameters = provider.node.functionExpression.typeParameters; - final typeParametersUsage = genericUsageDisplayString(typeParameters); - final typeParametersDefinition = - genericDefinitionDisplayString(typeParameters); - - final createType = - '${provider.createdTypeDisplayString} Function$typeParametersDefinition(${provider.refImplName} ref)'; - - return FamilyTemplate._( - provider, - options: options, - parameters: parameters, - typeParameters: typeParameters, - hashFn: hashFn, - elementType: elementType, - refType: refType, - providerGenerics: '<${provider.valueTypeDisplayString}>', - providerCreate: - '(ref) => ${provider.name}$typeParametersUsage(ref as ${provider.refImplName}$typeParametersUsage, $parametersPassThrough)', - providerType: providerType, - parametersPassThrough: parametersPassThrough, - createType: createType, - overrideCreate: '(ref) => create(ref as ${provider.refImplName})', - ); - } - - factory FamilyTemplate.classBased( - ClassBasedProviderDeclaration provider, { - required String notifierTypedefName, - required String hashFn, - required BuildYamlOptions options, - }) { - var leading = ''; - if (!provider.annotation.element.keepAlive) { - leading = 'AutoDispose'; - } - - var providerType = '${leading}NotifierProviderImpl'; - var refType = '${leading}NotifierProviderRef'; - var notifierBaseType = 'Buildless${leading}Notifier'; - var elementType = '${leading}NotifierProviderElement'; - - final returnType = provider.createdTypeNode?.type; - if (returnType != null && !returnType.isRaw) { - if (returnType.isDartAsyncFutureOr || returnType.isDartAsyncFuture) { - providerType = '${leading}AsyncNotifierProviderImpl'; - refType = '${leading}AsyncNotifierProviderRef'; - notifierBaseType = 'Buildless${leading}AsyncNotifier'; - elementType = '${leading}AsyncNotifierProviderElement'; - } else if (returnType.isDartAsyncStream) { - providerType = '${leading}StreamNotifierProviderImpl'; - refType = '${leading}StreamNotifierProviderRef'; - notifierBaseType = 'Buildless${leading}StreamNotifier'; - elementType = '${leading}StreamNotifierProviderElement'; - } - } - - final parameters = - provider.buildMethod.parameters!.parameters.whereNotNull().toList(); - final parameterDefinition = buildParamDefinitionQuery(parameters); - final cascadePropertyInit = - parameters.map((e) => '..${e.name} = ${e.name}').join('\n'); - - final parametersPassThrough = buildParamInvocationQuery({ - for (final parameter in parameters) parameter: parameter.name!.lexeme, - }); - - final typeParameters = provider.node.typeParameters; - final typeParametersUsage = genericUsageDisplayString(typeParameters); - final typeParametersDefinition = - genericDefinitionDisplayString(typeParameters); - - return FamilyTemplate._( - provider, - options: options, - parameters: parameters, - typeParameters: typeParameters, - hashFn: hashFn, - elementType: elementType, - refType: refType, - providerGenerics: - '<${provider.name}$typeParametersUsage, ${provider.valueTypeDisplayString}>', - providerType: providerType, - providerCreate: parameters.isEmpty - // If the provider has no arguments (and therefore only generics), - // use tear-off constructor - ? '${provider.name.lexeme}$typeParametersUsage.new' - : '() => ${provider.name}$typeParametersUsage()$cascadePropertyInit', - parametersPassThrough: parametersPassThrough, - createType: '${provider.name} Function()', - overrideCreate: '() => create()$cascadePropertyInit', - other: ''' -abstract class $notifierTypedefName$typeParametersDefinition extends $notifierBaseType<${provider.valueTypeDisplayString}> { - ${parameters.map((e) => 'late final ${e.typeDisplayString} ${e.name};').join('\n')} - - ${provider.createdTypeDisplayString} build($parameterDefinition); -} -''', - providerOther: ''' - @override - ${provider.createdTypeDisplayString} runNotifierBuild( - covariant ${provider.name}$typeParametersUsage notifier, - ) { - return notifier.build($parametersPassThrough); - } - - @internal - @override - $providerType $copyWithBuild( - ${provider.name} Function() create, - ) { - return $providerType._internal( - create, - ${parameters.map((e) => '${e.name}: ${e.name},\n').join()} - ); - } -''', - ); - } - - final GeneratorProviderDeclaration provider; - final List parameters; - final TypeParameterList? typeParameters; - final BuildYamlOptions options; - final String refType; - final String elementType; - final String providerType; - final String providerGenerics; - final String providerCreate; - final String other; - final String providerOther; - final String parametersPassThrough; - final String hashFn; - final String createType; - final String overrideCreate; - - @override - void run(StringBuffer buffer) { - final isAutoDispose = !provider.providerElement.annotation.keepAlive; - - final providerTypeNameImpl = provider.providerTypeName; - final refNameImpl = provider.refImplName; - final elementNameImpl = '_${providerTypeNameImpl.public}Element'; - final familyName = provider.familyTypeName; - - final parameterDefinition = buildParamDefinitionQuery(parameters); - - final docs = providerDocFor(provider.providerElement.element); - final meta = metaAnnotations(provider.node.metadata); - final providerName = - providerFamilyNameFor(provider.providerElement, options); - - final dependenciesKeyword = - provider.providerElement.annotation.dependencies == null - ? 'const Iterable?' - : 'final Iterable'; - - final typeParametersDefinition = - genericDefinitionDisplayString(typeParameters); - final typeParametersUsage = genericUsageDisplayString(typeParameters); - final argumentRecordType = buildParamDefinitionQuery( - parameters, - asRecord: true, - ); - final argumentsToRecord = buildParamInvocationQuery({ - for (final parameter in parameters) parameter: parameter.name!.lexeme, - }); - - // TODO changelog updated to support createElement prototype change - // TODO changelog toString() - // TODO handle generics with $ in their name - - final encodedProviderName = providerName.encoded; - final encodedGenerics = typeParameters == null - ? '' - : '<${typeParameters!.typeParameters.map((e) => '\$${e.name.lexeme.encoded}').join(',')}>'; - - buffer.write(''' -$other - -$docs -@ProviderFor(${provider.name}) -$meta -const $providerName = $familyName(); - -$docs -final class $familyName extends Family { - $docs - const $familyName() - : super( - name: r'$providerName', - dependencies: _dependencies, - allTransitiveDependencies: _allTransitiveDependencies, - debugGetCreateSourceHash: $hashFn, - ${isAutoDispose ? 'isAutoDispose: true,' : ''} - ); - - static $dependenciesKeyword _dependencies = ${provider.dependencies(options)}; - - static $dependenciesKeyword _allTransitiveDependencies = ${null}; - - $docs - $providerTypeNameImpl$typeParametersUsage call$typeParametersDefinition($parameterDefinition) { - return $providerTypeNameImpl$typeParametersUsage($parametersPassThrough); - } - - @override - String toString() => '$encodedProviderName'; -} - -$docs -final class $providerTypeNameImpl$typeParametersDefinition extends $providerType$providerGenerics { - $docs - $providerTypeNameImpl($parameterDefinition) : this._internal( - $providerCreate, - argument: ($argumentsToRecord), - ); - - $providerTypeNameImpl._internal( - super.create, { - required ($argumentRecordType) super.argument, - }) : super.internal( - debugGetCreateSourceHash: $hashFn, - from: $providerName, - name: r'$providerName', - isAutoDispose: $isAutoDispose, - dependencies: null, - allTransitiveDependencies: null, - ); - -$providerOther - - @override - $elementNameImpl$typeParametersUsage createElement(ProviderContainer container,) { - return $elementNameImpl(this, container); - } - - @internal - @override - $providerTypeNameImpl $copyWithCreate( - $createType create, - ) { - return $providerTypeNameImpl._internal( - $overrideCreate, - argument: argument as ($argumentRecordType), - ); - } - - @override - bool operator ==(Object other) { - return ${[ - 'other is $providerTypeNameImpl', - // If there are type parameters, check the runtimeType to check them too. - if (typeParameters?.typeParameters.isNotEmpty ?? false) - 'other.runtimeType == runtimeType', - 'other.argument == argument', - ].join(' && ')}; - } - - @override - int get hashCode => Object.hash(argument, runtimeType); - - @override - String toString() => '$encodedProviderName$encodedGenerics\$argument'; -} - -mixin $refNameImpl$typeParametersDefinition on $refType { - ${parameters.map((e) { - return ''' -/// The parameter `${e.name}` of this provider. -${e.typeDisplayString} get ${e.name};'''; - }).join()} -} - -class $elementNameImpl$typeParametersDefinition extends $elementType$providerGenerics with $refNameImpl$typeParametersUsage { - $elementNameImpl(super.provider, super.container); - -${parameters.map((e) => '@override ${e.typeDisplayString} get ${e.name} => (origin as $providerTypeNameImpl$typeParametersUsage).${e.name};').join()} -} -'''); - } -} diff --git a/packages/riverpod_generator/lib/src/templates/functional_provider.dart b/packages/riverpod_generator/lib/src/templates/functional_provider.dart deleted file mode 100644 index 4c1ca9137..000000000 --- a/packages/riverpod_generator/lib/src/templates/functional_provider.dart +++ /dev/null @@ -1,76 +0,0 @@ -import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; -import '../models.dart'; -import '../riverpod_generator.dart'; -import 'template.dart'; - -class FunctionalProviderTemplate extends Template { - FunctionalProviderTemplate( - this.provider, { - required this.refName, - required this.hashFn, - required this.options, - }) { - if (provider.providerElement.isFamily) { - throw ArgumentError.value( - provider.providerElement.isFamily, - 'provider.providerElement.isFamily', - 'Expected a non-family provider', - ); - } - } - - final FunctionalProviderDeclaration provider; - final String refName; - final String hashFn; - final BuildYamlOptions options; - - @override - void run(StringBuffer buffer) { - final isAutoDispose = !provider.providerElement.annotation.keepAlive - ? 'isAutoDispose: true,' - : ''; - - var providerType = 'Provider'; - var refType = 'Ref<${provider.valueTypeDisplayString}>'; - - final returnType = provider.createdTypeNode?.type; - if (returnType != null && !returnType.isRaw) { - if ((returnType.isDartAsyncFutureOr) || (returnType.isDartAsyncFuture)) { - providerType = 'FutureProvider'; - refType = 'Ref>'; - } else if (returnType.isDartAsyncStream) { - providerType = 'StreamProvider'; - refType = 'Ref>'; - } - } - - final providerName = provider.providerName(options); - - final createFn = provider.node.externalKeyword == null - ? provider.providerElement.name - : ''' -(_) => throw UnsupportedError( - 'The provider "$providerName" is expected to get overridden/scoped, ' - 'but was accessed without an override.', -) -'''; - - buffer.write(''' -${providerDocFor(provider.providerElement.element)} -@ProviderFor(${provider.name}) -${metaAnnotations(provider.node.metadata)} -final $providerName = $providerType<${provider.valueTypeDisplayString}>.internal( - $createFn, - name: r'$providerName', - debugGetCreateSourceHash: $hashFn, - from: null, - argument: null, - $isAutoDispose - dependencies: ${serializeDependencies(provider.providerElement.annotation, options)}, - allTransitiveDependencies: ${serializeAllTransitiveDependencies(provider.providerElement.annotation, options)}, -); - -typedef $refName = $refType; -'''); - } -} diff --git a/packages/riverpod_generator/test/integration/async.dart b/packages/riverpod_generator/test/integration/async.dart index 398f74981..469608b30 100644 --- a/packages/riverpod_generator/test/integration/async.dart +++ b/packages/riverpod_generator/test/integration/async.dart @@ -1,4 +1,3 @@ -import 'package:riverpod/src/framework.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'async.g.dart'; diff --git a/packages/riverpod_generator/test/integration/sync.dart b/packages/riverpod_generator/test/integration/sync.dart index b83aae4cb..6a8a3c845 100644 --- a/packages/riverpod_generator/test/integration/sync.dart +++ b/packages/riverpod_generator/test/integration/sync.dart @@ -105,7 +105,7 @@ String family( return '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)'; } -final privateProvider = _privateProvider; +const privateProvider = _privateProvider; @riverpod String _private(_PrivateRef ref) { @@ -125,7 +125,7 @@ class PublicClass extends _$PublicClass { } } -final privateClassProvider = _privateClassProvider; +const privateClassProvider = _privateClassProvider; @riverpod class _PrivateClass extends _$PrivateClass { From 5c3e285a2f329711902f39f6b75be778d15b1e18 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 9 Feb 2024 22:13:32 +0100 Subject: [PATCH 169/387] Remove todo --- packages/riverpod_generator/lib/src/templates/parameters.dart | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/riverpod_generator/lib/src/templates/parameters.dart b/packages/riverpod_generator/lib/src/templates/parameters.dart index f8a253ff7..40019186c 100644 --- a/packages/riverpod_generator/lib/src/templates/parameters.dart +++ b/packages/riverpod_generator/lib/src/templates/parameters.dart @@ -92,7 +92,6 @@ extension ParameterType on FormalParameter { case DefaultFormalParameter(): return that.parameter.typeDisplayString; case SimpleFormalParameter(): - // TODO changelog no type = dynamic // No type, so let's just return 'dynamic' return that.type?.toSource() ?? 'dynamic'; case FieldFormalParameter(): From a4afd3c4190e63b942f8bab0f8d7024d8cd242e1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 07:34:45 +0100 Subject: [PATCH 170/387] lint --- packages/riverpod_generator/test/integration/generated.dart | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/riverpod_generator/test/integration/generated.dart b/packages/riverpod_generator/test/integration/generated.dart index 2a117a8e6..0122f491d 100644 --- a/packages/riverpod_generator/test/integration/generated.dart +++ b/packages/riverpod_generator/test/integration/generated.dart @@ -48,6 +48,8 @@ class $DynamicClassFamily extends _$$DynamicClassFamily { build(test) => _Test(); } +const dynamicProvider = _dynamicProvider; + @riverpod _dynamic(_DynamicRef ref, test) => 0; From 459c4d92e98223cf081f6673041c7488719ce35a Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 08:58:26 +0100 Subject: [PATCH 171/387] Handle docs and annotations --- .../test/analyzer_test_utils.dart | 4 +- .../test/consumer_test.dart | 46 ++ .../integration/build_yaml/lib/main.g.dart | 12 + .../lib/src/riverpod_generator.dart | 42 +- .../lib/src/templates/family.dart | 4 +- .../lib/src/templates/notifier.dart | 19 +- .../lib/src/templates/provider.dart | 6 +- .../lib/src/templates/provider_variable.dart | 3 + .../lib/src/templates/ref.dart | 2 +- .../test/integration/annotated.g.dart | 15 + .../test/integration/async.g.dart | 10 + .../test/integration/auto_dispose.g.dart | 3 + .../test/integration/dependencies.g.dart | 18 + .../test/integration/dependencies2.g.dart | 6 + .../test/integration/documented.dart | 41 ++ .../test/integration/documented.g.dart | 431 ++++++++++++++++++ .../test/integration/generated.g.dart | 13 + .../test/integration/hash/hash1.g.dart | 3 + .../test/integration/scopes.g.dart | 2 + .../test/integration/split.g.dart | 2 + .../test/integration/stream.g.dart | 8 + .../test/integration/sync.g.dart | 41 ++ 22 files changed, 711 insertions(+), 20 deletions(-) create mode 100644 packages/riverpod_generator/test/integration/documented.dart create mode 100644 packages/riverpod_generator/test/integration/documented.g.dart diff --git a/packages/riverpod_analyzer_utils_tests/test/analyzer_test_utils.dart b/packages/riverpod_analyzer_utils_tests/test/analyzer_test_utils.dart index 724b7a7d9..e661455ea 100644 --- a/packages/riverpod_analyzer_utils_tests/test/analyzer_test_utils.dart +++ b/packages/riverpod_analyzer_utils_tests/test/analyzer_test_utils.dart @@ -126,7 +126,7 @@ extension ResolverX on Resolver { String libraryName = 'foo', bool ignoreErrors = false, }) async { - final library = await _requireFindLibraryByName( + final library = await requireFindLibraryByName( libraryName, ignoreErrors: ignoreErrors, ); @@ -143,7 +143,7 @@ extension ResolverX on Resolver { return result; } - Future _requireFindLibraryByName( + Future requireFindLibraryByName( String libraryName, { required bool ignoreErrors, }) async { diff --git a/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart b/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart index b23769ef2..e92b22e4c 100644 --- a/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart @@ -1,9 +1,55 @@ +import 'package:analyzer/dart/analysis/results.dart'; +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/ast/token.dart'; +import 'package:analyzer/dart/ast/visitor.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import 'package:test/test.dart'; import 'analyzer_test_utils.dart'; +class MyVisitor extends RecursiveAstVisitor { + @override + void visitClassDeclaration(ClassDeclaration node) { + print(node); + final buffer = StringBuffer(); + for (Token? a = node.documentationComment!.beginToken; + a != null; + a = a.next) { + buffer.write(a); + } + print(buffer); + print('`${node.declaredElement?.documentationComment}`'); + } + + @override + void visitFunctionDeclaration(FunctionDeclaration node) { + print(node); + print('`${node.documentationComment}`'); + print('`${node.declaredElement?.documentationComment}`'); + } +} + void main() { + testSource('MyTest', source: ''' +library foo; +/// Hello world +class Foo {} + +/// Hello world +void fn() {} +''', (resolver) async { + final library = await resolver.requireFindLibraryByName( + 'foo', + ignoreErrors: true, + ); + final libraryAst = + await library.session.getResolvedLibraryByElement(library); + libraryAst as ResolvedLibraryResult; + + final visitor = MyVisitor(); + libraryAst.units.first.unit.accept(visitor); + }); + testSource('Handles consumers with a ProviderBase inside', source: ''' import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter/material.dart'; diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 4b3022d42..11e0998ff 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -8,6 +8,7 @@ part of 'main.dart'; typedef CountRef = Ref; +@ProviderFor(count) const countPod = CountProvider._(); final class CountProvider extends $FunctionalProvider @@ -57,6 +58,7 @@ String _$countHash() => r'4c7e72b275767a60ece5e8662ab1e28f73cf7e44'; typedef CountFutureRef = Ref>; +@ProviderFor(countFuture) const countFuturePod = CountFutureProvider._(); final class CountFutureProvider @@ -107,6 +109,7 @@ String _$countFutureHash() => r'ec7cc31ce1c1a10607f1dcb35dd217acd2877729'; typedef CountStreamRef = Ref>; +@ProviderFor(countStream) const countStreamPod = CountStreamProvider._(); final class CountStreamProvider @@ -157,6 +160,7 @@ String _$countStreamHash() => r'1dbe49244ea19e8dbc3af0534429bb323720c07a'; typedef Count2Ref = Ref; +@ProviderFor(count2) const count2ProviderFamily = Count2Family._(); final class Count2Provider extends $FunctionalProvider @@ -277,6 +281,7 @@ final class Count2Family extends Family { typedef CountFuture2Ref = Ref>; +@ProviderFor(countFuture2) const countFuture2ProviderFamily = CountFuture2Family._(); final class CountFuture2Provider @@ -398,6 +403,7 @@ final class CountFuture2Family extends Family { typedef CountStream2Ref = Ref>; +@ProviderFor(countStream2) const countStream2ProviderFamily = CountStream2Family._(); final class CountStream2Provider @@ -517,6 +523,7 @@ final class CountStream2Family extends Family { } } +@ProviderFor(CountNotifier) const countNotifierPod = CountNotifierProvider._(); final class CountNotifierProvider @@ -578,6 +585,7 @@ abstract class _$CountNotifier extends $Notifier { int runBuild() => build(); } +@ProviderFor(CountAsyncNotifier) const countAsyncNotifierPod = CountAsyncNotifierProvider._(); final class CountAsyncNotifierProvider @@ -640,6 +648,7 @@ abstract class _$CountAsyncNotifier extends $AsyncNotifier { FutureOr runBuild() => build(); } +@ProviderFor(CountStreamNotifier) const countStreamNotifierPod = CountStreamNotifierProvider._(); final class CountStreamNotifierProvider @@ -702,6 +711,7 @@ abstract class _$CountStreamNotifier extends $StreamNotifier { Stream runBuild() => build(); } +@ProviderFor(CountNotifier2) const countNotifier2ProviderFamily = CountNotifier2Family._(); final class CountNotifier2Provider @@ -851,6 +861,7 @@ abstract class _$CountNotifier2 extends $Notifier { ); } +@ProviderFor(CountAsyncNotifier2) const countAsyncNotifier2ProviderFamily = CountAsyncNotifier2Family._(); final class CountAsyncNotifier2Provider @@ -1004,6 +1015,7 @@ abstract class _$CountAsyncNotifier2 extends $AsyncNotifier { ); } +@ProviderFor(CountStreamNotifier2) const countStreamNotifier2ProviderFamily = CountStreamNotifier2Family._(); final class CountStreamNotifier2Provider diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index 43fc40d1f..01778bc88 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -1,4 +1,5 @@ import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/ast/token.dart'; import 'package:analyzer/dart/element/element.dart'; import 'package:meta/meta.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; @@ -18,8 +19,6 @@ import 'templates/provider_variable.dart'; import 'templates/ref.dart'; import 'type.dart'; -const riverpodTypeChecker = TypeChecker.fromRuntime(Riverpod); - String providerDocFor(Element element) { return element.documentationComment == null ? '/// See also [${element.name}].' @@ -284,6 +283,21 @@ extension ProviderNames on GeneratorProviderDeclaration { } } + Iterable get metadata { + return ['@ProviderFor($name)'].followedBy( + node.metadata.where((e) { + if (e.elementAnnotation!.isDoNotStore) return false; + + final valueType = e.elementAnnotation!.computeConstantValue()?.type; + if (valueType == null) return false; + + return !riverpodType.isExactlyType(valueType); + }).map((e) => e.toString()), + ); + } + + String get doc => node.doc; + String argumentToRecord({String? variableName}) { switch (parameters) { case [final p]: @@ -405,3 +419,27 @@ String _genericUsageDisplayString(TypeParameterList? typeParameterList) { return '<${typeParameterList.typeParameters.map((e) => e.name.lexeme).join(', ')}>'; } + +extension ParameterDoc on AstNode { + String get doc { + final builder = StringBuffer(); + final that = this; + + switch (that) { + case AnnotatedNode(): + for (var token = that.documentationComment?.beginToken; + token != null; + token = token.next) { + builder.writeln(token); + } + case _: + for (Token? token = beginToken.precedingComments; + token != null; + token = token.next) { + builder.writeln(token); + } + } + + return builder.toString(); + } +} diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 40ecd401e..aaa14624a 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -37,7 +37,7 @@ class FamilyTemplate extends Template { provider.parameters.isEmpty ? '' : 'argument: $parametersPassThrough,'; buffer.writeln(''' -final class ${provider.familyTypeName} extends Family { +${provider.doc} final class ${provider.familyTypeName} extends Family { const ${provider.familyTypeName}._() : super( name: r'${provider.providerName(options)}', @@ -46,7 +46,7 @@ final class ${provider.familyTypeName} extends Family { ${provider.providerElement.isAutoDispose ? 'isAutoDispose: true,' : ''} ); - ${provider.providerTypeName}$_generics call$_genericsDefinition($_parameterDefinition) + ${provider.doc} ${provider.providerTypeName}$_generics call$_genericsDefinition($_parameterDefinition) => ${provider.providerTypeName}$_generics._( $argument from: this diff --git a/packages/riverpod_generator/lib/src/templates/notifier.dart b/packages/riverpod_generator/lib/src/templates/notifier.dart index 1d8aebec4..690da6464 100644 --- a/packages/riverpod_generator/lib/src/templates/notifier.dart +++ b/packages/riverpod_generator/lib/src/templates/notifier.dart @@ -39,16 +39,15 @@ class NotifierTemplate extends Template { final _$args = r'late final _$args = ' '(ref as ${provider.elementName}).origin.argument as ${provider.argumentRecordType};'; var paramOffset = 0; - final parametersAsFields = provider.parameters - .map( - (p) => - '${p.typeDisplayString} get ${p.name!.lexeme} => ${switch (provider.parameters) { - [_] => r'_$args;', - _ => - '_\$args.${p.isPositional ? '\$${++paramOffset}' : p.name!.lexeme};', - }}', - ) - .join(); + final parametersAsFields = provider.parameters.map( + (p) { + return '${p.doc} ${p.typeDisplayString} get ${p.name!.lexeme} => ${switch (provider.parameters) { + [_] => r'_$args;', + _ => + '_\$args.${p.isPositional ? '\$${++paramOffset}' : p.name!.lexeme};', + }}'; + }, + ).join(); buffer.writeln(''' abstract class $notifierBaseName$genericsDefinition extends $baseClass { diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 58730a5c0..65147a7d2 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -55,7 +55,7 @@ class ProviderTemplate extends Template { final mixins = modifiers.isEmpty ? '' : ' with ${modifiers.join(', ')}'; buffer.writeln(''' -final class $name$_genericsDefinition +${provider.doc} final class $name$_genericsDefinition extends \$FunctionalProvider< $exposedType, $createdType, @@ -79,7 +79,7 @@ final class $name$_genericsDefinition } buffer.writeln( - 'final class $name$_genericsDefinition extends $baseClass {', + '${provider.doc} final class $name$_genericsDefinition extends $baseClass {', ); } @@ -104,7 +104,7 @@ final class $name$_genericsDefinition ].join(); buffer.writeln(''' - const ${provider.providerTypeName}._({ + ${provider.doc} const ${provider.providerTypeName}._({ $constructorParameters ${provider.createType()}? create }): _createCb = create, diff --git a/packages/riverpod_generator/lib/src/templates/provider_variable.dart b/packages/riverpod_generator/lib/src/templates/provider_variable.dart index 81833b778..6be3b03c4 100644 --- a/packages/riverpod_generator/lib/src/templates/provider_variable.dart +++ b/packages/riverpod_generator/lib/src/templates/provider_variable.dart @@ -14,6 +14,9 @@ class ProviderVariableTemplate extends Template { void run(StringBuffer buffer) { final providerName = provider.providerName(options); + buffer.write(provider.doc); + provider.metadata.forEach(buffer.writeln); + switch (provider) { case _ when provider.providerElement.isFamily: buffer diff --git a/packages/riverpod_generator/lib/src/templates/ref.dart b/packages/riverpod_generator/lib/src/templates/ref.dart index 6762a76b6..88aaa9ae0 100644 --- a/packages/riverpod_generator/lib/src/templates/ref.dart +++ b/packages/riverpod_generator/lib/src/templates/ref.dart @@ -13,7 +13,7 @@ class RefTemplate extends Template { final typeParametersDefinition = provider.genericsDefinition(); buffer.writeln(''' -typedef ${provider.refImplName}$typeParametersDefinition = Ref<${provider.exposedTypeDisplayString}>; +${provider.doc} typedef ${provider.refImplName}$typeParametersDefinition = Ref<${provider.exposedTypeDisplayString}>; '''); } } diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index b567d5ad6..8161c3d60 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -8,6 +8,10 @@ part of 'annotated.dart'; typedef FunctionalRef = Ref; +@ProviderFor(functional) +@Deprecated('Deprecation message') +@visibleForTesting +@protected const functionalProvider = FunctionalProvider._(); final class FunctionalProvider @@ -58,6 +62,10 @@ String _$functionalHash() => r'69e260b1de8ba28cbeb8e24d628933366cde6b8b'; typedef FamilyRef = Ref; +@ProviderFor(family) +@Deprecated('Deprecation message') +@visibleForTesting +@protected const familyProvider = FamilyFamily._(); final class FamilyProvider @@ -179,6 +187,7 @@ final class FamilyFamily extends Family { typedef NotCopiedFunctionalRef = Ref; +@ProviderFor(notCopiedFunctional) const notCopiedFunctionalProvider = NotCopiedFunctionalProvider._(); final class NotCopiedFunctionalProvider @@ -230,6 +239,7 @@ String _$notCopiedFunctionalHash() => typedef NotCopiedFamilyRef = Ref; +@ProviderFor(notCopiedFamily) const notCopiedFamilyProvider = NotCopiedFamilyFamily._(); final class NotCopiedFamilyProvider @@ -349,6 +359,10 @@ final class NotCopiedFamilyFamily extends Family { } } +@ProviderFor(ClassBased) +@Deprecated('Deprecation message') +@visibleForTesting +@protected const classBasedProvider = ClassBasedProvider._(); final class ClassBasedProvider extends $NotifierProvider { @@ -409,6 +423,7 @@ abstract class _$ClassBased extends $Notifier { String runBuild() => build(); } +@ProviderFor(NotCopiedClassBased) const notCopiedClassBasedProvider = NotCopiedClassBasedProvider._(); final class NotCopiedClassBasedProvider diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index de0d147a9..96daa4fb4 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -8,6 +8,7 @@ part of 'async.dart'; typedef GenericRef = Ref>>; +@ProviderFor(generic) const genericProvider = GenericFamily._(); final class GenericProvider extends $FunctionalProvider< @@ -117,6 +118,7 @@ final class GenericFamily extends Family { typedef PublicRef = Ref>; +@ProviderFor(public) const publicProvider = PublicProvider._(); final class PublicProvider @@ -167,6 +169,7 @@ String _$publicHash() => r'9d99b79c013da13926d4ad89c72ebca4fc1cc257'; typedef _PrivateRef = Ref>; +@ProviderFor(_private) const _privateProvider = _PrivateProvider._(); final class _PrivateProvider extends $FunctionalProvider, @@ -217,6 +220,7 @@ String _$privateHash() => r'bc0469a9315de114a0ccd82c7db4980844d0009f'; typedef FamilyOrRef = Ref>; +@ProviderFor(familyOr) const familyOrProvider = FamilyOrFamily._(); final class FamilyOrProvider extends $FunctionalProvider, @@ -338,6 +342,7 @@ final class FamilyOrFamily extends Family { typedef FamilyRef = Ref>; +@ProviderFor(family) const familyProvider = FamilyFamily._(); final class FamilyProvider @@ -520,6 +525,7 @@ final class FamilyFamily extends Family { } } +@ProviderFor(GenericClass) const genericClassProvider = GenericClassFamily._(); final class GenericClassProvider @@ -667,6 +673,7 @@ abstract class _$GenericClass extends $AsyncNotifier> { FutureOr> runBuild() => build(); } +@ProviderFor(PublicClass) const publicClassProvider = PublicClassProvider._(); final class PublicClassProvider @@ -728,6 +735,7 @@ abstract class _$PublicClass extends $AsyncNotifier { FutureOr runBuild() => build(); } +@ProviderFor(_PrivateClass) const _privateClassProvider = _PrivateClassProvider._(); final class _PrivateClassProvider @@ -789,6 +797,7 @@ abstract class _$PrivateClass extends $AsyncNotifier { FutureOr runBuild() => build(); } +@ProviderFor(FamilyOrClass) const familyOrClassProvider = FamilyOrClassFamily._(); final class FamilyOrClassProvider @@ -941,6 +950,7 @@ abstract class _$FamilyOrClass extends $AsyncNotifier { ); } +@ProviderFor(FamilyClass) const familyClassProvider = FamilyClassFamily._(); final class FamilyClassProvider diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index feb8ca659..afd0586fa 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -8,6 +8,7 @@ part of 'auto_dispose.dart'; typedef KeepAliveRef = Ref; +@ProviderFor(keepAlive) const keepAliveProvider = KeepAliveProvider._(); final class KeepAliveProvider @@ -58,6 +59,7 @@ String _$keepAliveHash() => r'72dd192676126d487c24c7695a91d59410c62696'; typedef NotKeepAliveRef = Ref; +@ProviderFor(notKeepAlive) const notKeepAliveProvider = NotKeepAliveProvider._(); final class NotKeepAliveProvider @@ -108,6 +110,7 @@ String _$notKeepAliveHash() => r'1ccc497d7c651f8e730ec1bcecf271ffe9615d83'; typedef DefaultKeepAliveRef = Ref; +@ProviderFor(defaultKeepAlive) const defaultKeepAliveProvider = DefaultKeepAliveProvider._(); final class DefaultKeepAliveProvider diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index d54c92314..887a366a6 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -8,6 +8,7 @@ part of 'dependencies.dart'; typedef DepRef = Ref; +@ProviderFor(dep) const depProvider = DepProvider._(); final class DepProvider extends $FunctionalProvider @@ -57,6 +58,7 @@ String _$depHash() => r'2213a401e03a1a914579b4a3a7707b783de9efba'; typedef FamilyRef = Ref; +@ProviderFor(family) const familyProvider = FamilyFamily._(); final class FamilyProvider extends $FunctionalProvider @@ -177,6 +179,7 @@ final class FamilyFamily extends Family { typedef ProviderRef = Ref; +@ProviderFor(provider) const providerProvider = ProviderProvider._(); final class ProviderProvider extends $FunctionalProvider @@ -241,6 +244,7 @@ String _$providerHash() => r'6c9184ef4c6a410a2132e1ecc13a2e646e936d37'; typedef Provider2Ref = Ref; +@ProviderFor(provider2) const provider2Provider = Provider2Provider._(); final class Provider2Provider @@ -306,6 +310,7 @@ String _$provider2Hash() => r'70d908579c5e64ce6558b42f433adfb80f4dc79b'; typedef TransitiveDependenciesRef = Ref; +@ProviderFor(transitiveDependencies) const transitiveDependenciesProvider = TransitiveDependenciesProvider._(); final class TransitiveDependenciesProvider @@ -373,6 +378,7 @@ String _$transitiveDependenciesHash() => typedef SmallTransitiveDependencyCountRef = Ref; +@ProviderFor(smallTransitiveDependencyCount) const smallTransitiveDependencyCountProvider = SmallTransitiveDependencyCountProvider._(); @@ -437,6 +443,7 @@ String _$smallTransitiveDependencyCountHash() => typedef EmptyDependenciesFunctionalRef = Ref; +@ProviderFor(emptyDependenciesFunctional) const emptyDependenciesFunctionalProvider = EmptyDependenciesFunctionalProvider._(); @@ -489,6 +496,7 @@ String _$emptyDependenciesFunctionalHash() => typedef ProviderWithDependenciesRef = Ref; +@ProviderFor(providerWithDependencies) const providerWithDependenciesProvider = ProviderWithDependenciesProvider._(); final class ProviderWithDependenciesProvider @@ -549,6 +557,7 @@ String _$providerWithDependenciesHash() => typedef _PrivateDepRef = Ref; +@ProviderFor(_privateDep) const _privateDepProvider = _PrivateDepProvider._(); final class _PrivateDepProvider @@ -599,6 +608,7 @@ String _$privateDepHash() => r'f610d91bd39e0dcffe6ff4e74160964a291289d9'; typedef PublicDepRef = Ref; +@ProviderFor(publicDep) const publicDepProvider = PublicDepProvider._(); final class PublicDepProvider @@ -649,6 +659,7 @@ String _$publicDepHash() => r'bcb69aace017c86c3c4b8eccf59fa22d010834bc'; typedef DuplicateDependenciesRef = Ref; +@ProviderFor(duplicateDependencies) const duplicateDependenciesProvider = DuplicateDependenciesProvider._(); final class DuplicateDependenciesProvider @@ -706,6 +717,7 @@ String _$duplicateDependenciesHash() => typedef DuplicateDependencies2Ref = Ref; +@ProviderFor(duplicateDependencies2) const duplicateDependencies2Provider = DuplicateDependencies2Provider._(); final class DuplicateDependencies2Provider @@ -766,6 +778,7 @@ String _$duplicateDependencies2Hash() => typedef TransitiveDuplicateDependenciesRef = Ref; +@ProviderFor(transitiveDuplicateDependencies) const transitiveDuplicateDependenciesProvider = TransitiveDuplicateDependenciesProvider._(); @@ -837,6 +850,7 @@ final class TransitiveDuplicateDependenciesProvider String _$transitiveDuplicateDependenciesHash() => r'aba44b6c1cf82eea782ad260f2e95d9f771f12ac'; +@ProviderFor(Dep2) const dep2Provider = Dep2Provider._(); final class Dep2Provider extends $NotifierProvider { @@ -897,6 +911,7 @@ abstract class _$Dep2 extends $Notifier { int runBuild() => build(); } +@ProviderFor(Family2) const family2Provider = Family2Family._(); final class Family2Provider extends $NotifierProvider { @@ -1045,6 +1060,7 @@ abstract class _$Family2 extends $Notifier { ); } +@ProviderFor(Provider3) const provider3Provider = Provider3Provider._(); final class Provider3Provider extends $NotifierProvider { @@ -1120,6 +1136,7 @@ abstract class _$Provider3 extends $Notifier { int runBuild() => build(); } +@ProviderFor(Provider4) const provider4Provider = Provider4Family._(); final class Provider4Provider extends $NotifierProvider { @@ -1283,6 +1300,7 @@ abstract class _$Provider4 extends $Notifier { ); } +@ProviderFor(EmptyDependenciesClassBased) const emptyDependenciesClassBasedProvider = EmptyDependenciesClassBasedProvider._(); diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 4ac2787fd..c51733419 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -8,6 +8,7 @@ part of 'dependencies2.dart'; typedef ProviderWithDependencies2Ref = Ref; +@ProviderFor(providerWithDependencies2) const providerWithDependencies2Provider = ProviderWithDependencies2Provider._(); final class ProviderWithDependencies2Provider @@ -77,6 +78,7 @@ String _$providerWithDependencies2Hash() => typedef FamilyWithDependencies2Ref = Ref; +@ProviderFor(familyWithDependencies2) const familyWithDependencies2Provider = FamilyWithDependencies2Family._(); final class FamilyWithDependencies2Provider @@ -218,6 +220,7 @@ final class FamilyWithDependencies2Family extends Family { typedef _Private2Ref = Ref; +@ProviderFor(_private2) const _private2Provider = _Private2Provider._(); final class _Private2Provider @@ -268,6 +271,7 @@ String _$private2Hash() => r'5e0fa14ff40fb444c027ed25150a42362db3ef19'; typedef Public2Ref = Ref; +@ProviderFor(public2) const public2Provider = Public2Provider._(); final class Public2Provider extends $FunctionalProvider @@ -315,6 +319,7 @@ final class Public2Provider extends $FunctionalProvider String _$public2Hash() => r'9767255f0182589fe48b29d217dd488b0a13b9d5'; +@ProviderFor(NotifierWithDependencies) const notifierWithDependenciesProvider = NotifierWithDependenciesProvider._(); final class NotifierWithDependenciesProvider @@ -397,6 +402,7 @@ abstract class _$NotifierWithDependencies extends $Notifier { int runBuild() => build(); } +@ProviderFor(NotifierFamilyWithDependencies) const notifierFamilyWithDependenciesProvider = NotifierFamilyWithDependenciesFamily._(); diff --git a/packages/riverpod_generator/test/integration/documented.dart b/packages/riverpod_generator/test/integration/documented.dart new file mode 100644 index 000000000..0a03bf001 --- /dev/null +++ b/packages/riverpod_generator/test/integration/documented.dart @@ -0,0 +1,41 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'documented.g.dart'; + +// Foo +/// Hello world +@riverpod +String functional(FunctionalRef ref) => 'functional'; + +/// Hello world +// Foo +@riverpod +class ClassBased extends _$ClassBased { + @override + String build() => 'ClassBased'; +} + +/// Hello world +// Foo +@riverpod +String family( + FamilyRef ref, + + /// Hello Id + int id, +) { + return 'family $id'; +} + +/// Hello world +// Foo +@riverpod +class ClassFamilyBased extends _$ClassFamilyBased { + @override + String build( + /// Hello world + // Foo + int id, + ) => + 'ClassBased'; +} diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart new file mode 100644 index 000000000..f9e0d541d --- /dev/null +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -0,0 +1,431 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'documented.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +/// Hello world +typedef FunctionalRef = Ref; + +/// Hello world +@ProviderFor(functional) +const functionalProvider = FunctionalProvider._(); + +/// Hello world +final class FunctionalProvider + extends $FunctionalProvider + with $Provider { + /// Hello world + const FunctionalProvider._( + {String Function( + FunctionalRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'functionalProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + FunctionalRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$functionalHash(); + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FunctionalProvider $copyWithCreate( + String Function( + FunctionalRef ref, + ) create, + ) { + return FunctionalProvider._(create: create); + } + + @override + String create(FunctionalRef ref) { + final fn = _createCb ?? functional; + return fn(ref); + } +} + +String _$functionalHash() => r'1198a9a7842513019f6a8cd1b32e72217a00ee8f'; + +/// Hello world +// Foo +typedef FamilyRef = Ref; + +/// Hello world +// Foo +@ProviderFor(family) +const familyProvider = FamilyFamily._(); + +/// Hello world +// Foo +final class FamilyProvider + extends $FunctionalProvider + with $Provider { + /// Hello world +// Foo + const FamilyProvider._( + {required FamilyFamily super.from, + required int super.argument, + String Function( + FamilyRef ref, + int id, + )? create}) + : _createCb = create, + super( + name: r'familyProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + FamilyRef ref, + int id, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$familyHash(); + + @override + String toString() { + return r'familyProvider' + '' + '($argument)'; + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FamilyProvider $copyWithCreate( + String Function( + FamilyRef ref, + ) create, + ) { + return FamilyProvider._( + argument: argument as int, + from: from! as FamilyFamily, + create: ( + ref, + int id, + ) => + create(ref)); + } + + @override + String create(FamilyRef ref) { + final fn = _createCb ?? family; + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is FamilyProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$familyHash() => r'339f0a8e0733a30bbb2220ce7ff6b9de7abe6022'; + +/// Hello world +// Foo +final class FamilyFamily extends Family { + const FamilyFamily._() + : super( + name: r'familyProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + /// Hello world +// Foo + FamilyProvider call( + int id, + ) => + FamilyProvider._(argument: id, from: this); + + @override + String debugGetCreateSourceHash() => _$familyHash(); + + @override + String toString() => r'familyProvider'; + + Override overrideWith( + String Function( + FamilyRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } +} + +/// Hello world +// Foo +@ProviderFor(ClassBased) +const classBasedProvider = ClassBasedProvider._(); + +/// Hello world +// Foo +final class ClassBasedProvider extends $NotifierProvider { + /// Hello world +// Foo + const ClassBasedProvider._( + {super.runNotifierBuildOverride, ClassBased Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'classBasedProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ClassBased Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$classBasedHash(); + + @$internal + @override + ClassBased create() => _createCb?.call() ?? ClassBased(); + + @$internal + @override + ClassBasedProvider $copyWithCreate( + ClassBased Function() create, + ) { + return ClassBasedProvider._(create: create); + } + + @$internal + @override + ClassBasedProvider $copyWithBuild( + String Function( + Ref, + ClassBased, + ) build, + ) { + return ClassBasedProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$classBasedHash() => r'f1139017b1fcf38017402b514c61fb32dae40c39'; + +abstract class _$ClassBased extends $Notifier { + String build(); + + @$internal + @override + String runBuild() => build(); +} + +/// Hello world +// Foo +@ProviderFor(ClassFamilyBased) +const classFamilyBasedProvider = ClassFamilyBasedFamily._(); + +/// Hello world +// Foo +final class ClassFamilyBasedProvider + extends $NotifierProvider { + /// Hello world +// Foo + const ClassFamilyBasedProvider._( + {required ClassFamilyBasedFamily super.from, + required int super.argument, + super.runNotifierBuildOverride, + ClassFamilyBased Function()? create}) + : _createCb = create, + super( + name: r'classFamilyBasedProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ClassFamilyBased Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$classFamilyBasedHash(); + + @override + String toString() { + return r'classFamilyBasedProvider' + '' + '($argument)'; + } + + @$internal + @override + ClassFamilyBased create() => _createCb?.call() ?? ClassFamilyBased(); + + @$internal + @override + ClassFamilyBasedProvider $copyWithCreate( + ClassFamilyBased Function() create, + ) { + return ClassFamilyBasedProvider._( + argument: argument as int, + from: from! as ClassFamilyBasedFamily, + create: create); + } + + @$internal + @override + ClassFamilyBasedProvider $copyWithBuild( + String Function( + Ref, + ClassFamilyBased, + ) build, + ) { + return ClassFamilyBasedProvider._( + argument: argument as int, + from: from! as ClassFamilyBasedFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is ClassFamilyBasedProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$classFamilyBasedHash() => r'8d83e9a88356796298419574f360e8bf95aa0729'; + +/// Hello world +// Foo +final class ClassFamilyBasedFamily extends Family { + const ClassFamilyBasedFamily._() + : super( + name: r'classFamilyBasedProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + /// Hello world +// Foo + ClassFamilyBasedProvider call( + int id, + ) => + ClassFamilyBasedProvider._(argument: id, from: this); + + @override + String debugGetCreateSourceHash() => _$classFamilyBasedHash(); + + @override + String toString() => r'classFamilyBasedProvider'; + + Override overrideWith( + ClassFamilyBased Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ClassFamilyBasedProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + String Function(Ref ref, ClassFamilyBased notifier, int argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ClassFamilyBasedProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } +} + +abstract class _$ClassFamilyBased extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + + /// Hello world +// Foo + int get id => _$args; + + String build( + int id, + ); + + @$internal + @override + String runBuild() => build( + _$args, + ); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 3878dbbe9..8358b8638 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -8,6 +8,7 @@ part of 'generated.dart'; typedef GeneratedRef = Ref<_Test>; +@ProviderFor(generated) const generatedProvider = GeneratedProvider._(); final class GeneratedProvider @@ -58,6 +59,7 @@ String _$generatedHash() => r'e49f3520d06ed50d34a44de613fdcd20b19f48d4'; typedef GeneratedFamilyRef = Ref<_Test>; +@ProviderFor(generatedFamily) const generatedFamilyProvider = GeneratedFamilyFamily._(); final class GeneratedFamilyProvider @@ -179,6 +181,7 @@ final class GeneratedFamilyFamily extends Family { typedef $DynamicRef = Ref; +@ProviderFor($dynamic) const $dynamicProvider = $DynamicProvider._(); final class $DynamicProvider @@ -229,6 +232,7 @@ String _$$dynamicHash() => r'f62d63d9340f30b253e687f76deacd8205fed0e7'; typedef $DynamicFamilyRef = Ref; +@ProviderFor($dynamicFamily) const $dynamicFamilyProvider = $DynamicFamilyFamily._(); final class $DynamicFamilyProvider @@ -350,6 +354,7 @@ final class $DynamicFamilyFamily extends Family { typedef _DynamicRef = Ref; +@ProviderFor(_dynamic) const _dynamicProvider = _DynamicFamily._(); final class _DynamicProvider @@ -471,6 +476,7 @@ final class _DynamicFamily extends Family { typedef AliasRef = Ref>; +@ProviderFor(alias) const aliasProvider = AliasProvider._(); final class AliasProvider @@ -522,6 +528,7 @@ String _$aliasHash() => r'cc08ec4cc5ec0dc98bdb7f4dcbc035021b09bcf3'; typedef AliasFamilyRef = Ref>; +@ProviderFor(aliasFamily) const aliasFamilyProvider = AliasFamilyFamily._(); final class AliasFamilyProvider extends $FunctionalProvider< @@ -643,6 +650,7 @@ final class AliasFamilyFamily extends Family { } } +@ProviderFor(GeneratedClass) const generatedClassProvider = GeneratedClassProvider._(); final class GeneratedClassProvider @@ -704,6 +712,7 @@ abstract class _$GeneratedClass extends $Notifier<_Test> { _Test runBuild() => build(); } +@ProviderFor(GeneratedClassFamily) const generatedClassFamilyProvider = GeneratedClassFamilyFamily._(); final class GeneratedClassFamilyProvider @@ -857,6 +866,7 @@ abstract class _$GeneratedClassFamily extends $Notifier<_Test> { ); } +@ProviderFor($DynamicClass) const $dynamicClassProvider = $DynamicClassProvider._(); final class $DynamicClassProvider @@ -918,6 +928,7 @@ abstract class _$$DynamicClass extends $Notifier { Object? runBuild() => build(); } +@ProviderFor($DynamicClassFamily) const $dynamicClassFamilyProvider = $DynamicClassFamilyFamily._(); final class $DynamicClassFamilyProvider @@ -1071,6 +1082,7 @@ abstract class _$$DynamicClassFamily extends $Notifier { ); } +@ProviderFor(AliasClass) const aliasClassProvider = AliasClassProvider._(); final class AliasClassProvider @@ -1132,6 +1144,7 @@ abstract class _$AliasClass extends $Notifier> { r.AsyncValue runBuild() => build(); } +@ProviderFor(AliasClassFamily) const aliasClassFamilyProvider = AliasClassFamilyFamily._(); final class AliasClassFamilyProvider diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index cd9e6212a..b22937a9a 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -8,6 +8,7 @@ part of 'hash1.dart'; typedef SimpleRef = Ref; +@ProviderFor(simple) const simpleProvider = SimpleProvider._(); final class SimpleProvider @@ -58,6 +59,7 @@ String _$simpleHash() => r'ff9f7451526aef5b3af6646814631a502ad76a5f'; typedef Simple2Ref = Ref; +@ProviderFor(simple2) const simple2Provider = Simple2Provider._(); final class Simple2Provider @@ -106,6 +108,7 @@ final class Simple2Provider String _$simple2Hash() => r'06327442776394c5c9cbb33b048d7a42e709e7fd'; +@ProviderFor(SimpleClass) const simpleClassProvider = SimpleClassProvider._(); final class SimpleClassProvider extends $NotifierProvider { diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index a1f38efe9..4a0df2dbe 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -8,6 +8,7 @@ part of 'scopes.dart'; typedef ScopedRef = Ref; +@ProviderFor(scoped) const scopedProvider = ScopedProvider._(); final class ScopedProvider extends $FunctionalProvider @@ -55,6 +56,7 @@ final class ScopedProvider extends $FunctionalProvider String _$scopedHash() => r'590f1a203323105e732397a2616fbd7dac65f0cc'; +@ProviderFor(ScopedClass) const scopedClassProvider = ScopedClassProvider._(); final class ScopedClassProvider extends $NotifierProvider { diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index 2e3ad7024..c330ad6f1 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -8,6 +8,7 @@ part of 'split.dart'; typedef Counter2Ref = Ref; +@ProviderFor(counter2) const counter2Provider = Counter2Provider._(); final class Counter2Provider extends $FunctionalProvider @@ -57,6 +58,7 @@ String _$counter2Hash() => r'9328919066a683f85226fc59201bb7c54f107a7d'; typedef CounterRef = Ref; +@ProviderFor(counter) const counterProvider = CounterProvider._(); final class CounterProvider extends $FunctionalProvider diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 667b6be15..6d841c155 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -8,6 +8,7 @@ part of 'stream.dart'; typedef GenericRef = Ref>>; +@ProviderFor(generic) const genericProvider = GenericFamily._(); final class GenericProvider extends $FunctionalProvider< @@ -117,6 +118,7 @@ final class GenericFamily extends Family { typedef PublicRef = Ref>; +@ProviderFor(public) const publicProvider = PublicProvider._(); final class PublicProvider @@ -167,6 +169,7 @@ String _$publicHash() => r'c5cc0eac434371901cf6ab159a81bba49c58da12'; typedef _PrivateRef = Ref>; +@ProviderFor(_private) const _privateProvider = _PrivateProvider._(); final class _PrivateProvider @@ -217,6 +220,7 @@ String _$privateHash() => r'bbee0c7e27bda81346b5f52c96b23b2e48f83077'; typedef FamilyRef = Ref>; +@ProviderFor(family) const familyProvider = FamilyFamily._(); final class FamilyProvider @@ -399,6 +403,7 @@ final class FamilyFamily extends Family { } } +@ProviderFor(GenericClass) const genericClassProvider = GenericClassFamily._(); final class GenericClassProvider @@ -546,6 +551,7 @@ abstract class _$GenericClass extends $StreamNotifier> { Stream> runBuild() => build(); } +@ProviderFor(PublicClass) const publicClassProvider = PublicClassProvider._(); final class PublicClassProvider @@ -607,6 +613,7 @@ abstract class _$PublicClass extends $StreamNotifier { Stream runBuild() => build(); } +@ProviderFor(_PrivateClass) const _privateClassProvider = _PrivateClassProvider._(); final class _PrivateClassProvider @@ -668,6 +675,7 @@ abstract class _$PrivateClass extends $StreamNotifier { Stream runBuild() => build(); } +@ProviderFor(FamilyClass) const familyClassProvider = FamilyClassFamily._(); final class FamilyClassProvider diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 84beba633..e7129a71d 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -8,6 +8,7 @@ part of 'sync.dart'; typedef GenericRef = Ref>; +@ProviderFor(generic) const genericProvider = GenericFamily._(); final class GenericProvider @@ -117,6 +118,7 @@ final class GenericFamily extends Family { typedef ComplexGenericRef = Ref>; +@ProviderFor(complexGeneric) const complexGenericProvider = ComplexGenericFamily._(); final class ComplexGenericProvider @@ -285,6 +287,7 @@ final class ComplexGenericFamily extends Family { typedef RawFutureRef = Ref>>; +@ProviderFor(rawFuture) const rawFutureProvider = RawFutureProvider._(); final class RawFutureProvider extends $FunctionalProvider< @@ -337,6 +340,7 @@ String _$rawFutureHash() => r'5203a56065b768023770326281618e3229ccb530'; typedef RawStreamRef = Ref>>; +@ProviderFor(rawStream) const rawStreamProvider = RawStreamProvider._(); final class RawStreamProvider extends $FunctionalProvider< @@ -389,6 +393,7 @@ String _$rawStreamHash() => r'2b764189753a8b74f47ba557a79416f00ef5cebd'; typedef RawFamilyFutureRef = Ref>>; +@ProviderFor(rawFamilyFuture) const rawFamilyFutureProvider = RawFamilyFutureFamily._(); final class RawFamilyFutureProvider extends $FunctionalProvider< @@ -511,6 +516,7 @@ final class RawFamilyFutureFamily extends Family { typedef RawFamilyStreamRef = Ref>>; +@ProviderFor(rawFamilyStream) const rawFamilyStreamProvider = RawFamilyStreamFamily._(); final class RawFamilyStreamProvider extends $FunctionalProvider< @@ -631,13 +637,18 @@ final class RawFamilyStreamFamily extends Family { } } +/// This is some documentation typedef PublicRef = Ref; +/// This is some documentation +@ProviderFor(public) const publicProvider = PublicProvider._(); +/// This is some documentation final class PublicProvider extends $FunctionalProvider with $Provider { + /// This is some documentation const PublicProvider._( {String Function( PublicRef ref, @@ -683,6 +694,7 @@ String _$publicHash() => r'138be35943899793ab085e711fe3f3d22696a3ba'; typedef Supports$inNamesRef = Ref; +@ProviderFor(supports$inNames) const supports$inNamesProvider = Supports$inNamesProvider._(); final class Supports$inNamesProvider @@ -731,13 +743,18 @@ final class Supports$inNamesProvider String _$supports$inNamesHash() => r'cbf929802fcbd0aa949ad72743d096fb3ef5f28f'; +/// This is some documentation typedef FamilyRef = Ref; +/// This is some documentation +@ProviderFor(family) const familyProvider = FamilyFamily._(); +/// This is some documentation final class FamilyProvider extends $FunctionalProvider with $Provider { + /// This is some documentation const FamilyProvider._( {required FamilyFamily super.from, required ( @@ -852,6 +869,7 @@ final class FamilyProvider String _$familyHash() => r'14d1ee238ca608d547630d0e222ef4c5866e9e61'; +/// This is some documentation final class FamilyFamily extends Family { const FamilyFamily._() : super( @@ -861,6 +879,7 @@ final class FamilyFamily extends Family { isAutoDispose: true, ); + /// This is some documentation FamilyProvider call( int first, { String? second, @@ -917,6 +936,7 @@ final class FamilyFamily extends Family { typedef _PrivateRef = Ref; +@ProviderFor(_private) const _privateProvider = _PrivateProvider._(); final class _PrivateProvider @@ -967,6 +987,7 @@ String _$privateHash() => r'519561bc7e88e394d7f75ca2102a5c0acc832c66'; typedef Supports$InFnNameRef = Ref; +@ProviderFor(supports$InFnName) const supports$InFnNameProvider = Supports$InFnNameFamily._(); final class Supports$InFnNameProvider @@ -1078,6 +1099,7 @@ final class Supports$InFnNameFamily extends Family { typedef Supports$InFnNameFamilyRef = Ref; +@ProviderFor(supports$InFnNameFamily) const supports$InFnNameFamilyProvider = Supports$InFnNameFamilyFamily._(); final class Supports$InFnNameFamilyProvider @@ -1263,6 +1285,7 @@ final class Supports$InFnNameFamilyFamily extends Family { typedef GeneratedRef = Ref; +@ProviderFor(generated) const generatedProvider = GeneratedProvider._(); final class GeneratedProvider @@ -1311,6 +1334,7 @@ final class GeneratedProvider String _$generatedHash() => r'fecbc1d5d9a05fc996b452a57fd1975ff368af91'; +@ProviderFor(GenericClass) const genericClassProvider = GenericClassFamily._(); final class GenericClassProvider @@ -1457,6 +1481,7 @@ abstract class _$GenericClass extends $Notifier> { List runBuild() => build(); } +@ProviderFor(RawFutureClass) const rawFutureClassProvider = RawFutureClassProvider._(); final class RawFutureClassProvider @@ -1518,6 +1543,7 @@ abstract class _$RawFutureClass extends $Notifier>> { Raw> runBuild() => build(); } +@ProviderFor(RawStreamClass) const rawStreamClassProvider = RawStreamClassProvider._(); final class RawStreamClassProvider @@ -1579,6 +1605,7 @@ abstract class _$RawStreamClass extends $Notifier>> { Raw> runBuild() => build(); } +@ProviderFor(RawFamilyFutureClass) const rawFamilyFutureClassProvider = RawFamilyFutureClassFamily._(); final class RawFamilyFutureClassProvider @@ -1731,6 +1758,7 @@ abstract class _$RawFamilyFutureClass extends $Notifier>> { ); } +@ProviderFor(RawFamilyStreamClass) const rawFamilyStreamClassProvider = RawFamilyStreamClassFamily._(); final class RawFamilyStreamClassProvider @@ -1883,9 +1911,13 @@ abstract class _$RawFamilyStreamClass extends $Notifier>> { ); } +/// This is some documentation +@ProviderFor(PublicClass) const publicClassProvider = PublicClassProvider._(); +/// This is some documentation final class PublicClassProvider extends $NotifierProvider { + /// This is some documentation const PublicClassProvider._( {super.runNotifierBuildOverride, PublicClass Function()? create}) : _createCb = create, @@ -1943,6 +1975,7 @@ abstract class _$PublicClass extends $Notifier { String runBuild() => build(); } +@ProviderFor(_PrivateClass) const _privateClassProvider = _PrivateClassProvider._(); final class _PrivateClassProvider @@ -2004,9 +2037,13 @@ abstract class _$PrivateClass extends $Notifier { String runBuild() => build(); } +/// This is some documentation +@ProviderFor(FamilyClass) const familyClassProvider = FamilyClassFamily._(); +/// This is some documentation final class FamilyClassProvider extends $NotifierProvider { + /// This is some documentation const FamilyClassProvider._( {required FamilyClassFamily super.from, required ( @@ -2099,6 +2136,7 @@ final class FamilyClassProvider extends $NotifierProvider { String _$familyClassHash() => r'01e3b9cb4d6d0bf12a2284761b1a11819d97d249'; +/// This is some documentation final class FamilyClassFamily extends Family { const FamilyClassFamily._() : super( @@ -2108,6 +2146,7 @@ final class FamilyClassFamily extends Family { isAutoDispose: true, ); + /// This is some documentation FamilyClassProvider call( int first, { String? second, @@ -2227,6 +2266,7 @@ abstract class _$FamilyClass extends $Notifier { ); } +@ProviderFor(Supports$InClassName) const supports$InClassNameProvider = Supports$InClassNameFamily._(); final class Supports$InClassNameProvider @@ -2378,6 +2418,7 @@ abstract class _$Supports$InClassName extends $Notifier { String runBuild() => build(); } +@ProviderFor(Supports$InClassFamilyName) const supports$InClassFamilyNameProvider = Supports$InClassFamilyNameFamily._(); final class Supports$InClassFamilyNameProvider From f8797f3c197794e34abdfd98ec17929000b463fb Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 09:29:42 +0100 Subject: [PATCH 172/387] Support param annotations --- .../lib/src/templates/notifier.dart | 5 +- .../lib/src/templates/parameters.dart | 9 +- .../test/annotated_test.dart | 82 +++++--- .../riverpod_generator/test/doc_test.dart | 56 +++++ .../test/integration/annotated.dart | 5 +- .../test/integration/annotated.g.dart | 192 ++++++++++++++++-- .../test/integration/documented.dart | 2 +- .../test/integration/documented.g.dart | 4 + 8 files changed, 304 insertions(+), 51 deletions(-) create mode 100644 packages/riverpod_generator/test/doc_test.dart diff --git a/packages/riverpod_generator/lib/src/templates/notifier.dart b/packages/riverpod_generator/lib/src/templates/notifier.dart index 690da6464..e4e0452c6 100644 --- a/packages/riverpod_generator/lib/src/templates/notifier.dart +++ b/packages/riverpod_generator/lib/src/templates/notifier.dart @@ -41,7 +41,10 @@ class NotifierTemplate extends Template { var paramOffset = 0; final parametersAsFields = provider.parameters.map( (p) { - return '${p.doc} ${p.typeDisplayString} get ${p.name!.lexeme} => ${switch (provider.parameters) { + final metadata = p.metadata.isNotEmpty + ? '${p.metadata.map((e) => e.toSource()).join(' ')} ' + : ''; + return '${p.doc} $metadata ${p.typeDisplayString} get ${p.name!.lexeme} => ${switch (provider.parameters) { [_] => r'_$args;', _ => '_\$args.${p.isPositional ? '\$${++paramOffset}' : p.name!.lexeme};', diff --git a/packages/riverpod_generator/lib/src/templates/parameters.dart b/packages/riverpod_generator/lib/src/templates/parameters.dart index 40019186c..7710322e0 100644 --- a/packages/riverpod_generator/lib/src/templates/parameters.dart +++ b/packages/riverpod_generator/lib/src/templates/parameters.dart @@ -37,9 +37,14 @@ String buildParamDefinitionQuery( return type; } + late final metadata = parameter.metadata.isNotEmpty + ? '${parameter.metadata.map((e) => e.toSource()).join(' ')} ' + : ''; + late final element = parameter.declaredElement!; - late final leading = - parameter.isRequiredNamed || asRequiredNamed ? 'required ' : ''; + late final leading = parameter.isRequiredNamed || asRequiredNamed + ? 'required $metadata' + : metadata; late final trailing = element.defaultValueCode != null && !asRequiredNamed && withDefaults ? '= ${element.defaultValueCode}' diff --git a/packages/riverpod_generator/test/annotated_test.dart b/packages/riverpod_generator/test/annotated_test.dart index 30aeb2e32..62bb044ae 100644 --- a/packages/riverpod_generator/test/annotated_test.dart +++ b/packages/riverpod_generator/test/annotated_test.dart @@ -8,17 +8,33 @@ import 'package:test/test.dart'; void main() async { final file = File('test/integration/annotated.g.dart').absolute; final result = await resolveFile2(path: file.path) as ResolvedUnitResult; - final topLevelDeclarations = result.unit.declarations - .whereType() - .toList(); + final declarations = result.unit.declarations; - // TODO test import docs + test('Annotations on parameters', () { + // TODO changelog added support for annotations on family parameters + final notifier = + declarations.findNamed(r'_$ClassBased') as ClassDeclaration; + final id = notifier.members.findNamed('id'); + final family = + declarations.findNamed('ClassBasedFamily') as ClassDeclaration; + final call = family.members.findNamed('call') as MethodDeclaration; - test('Annotations on generated functionalProvider', () async { - final annotations = topLevelDeclarations - .findNamed('functionalProvider') - .metadata - .toString(); + expect( + id.metadata.toString(), + "[@Deprecated('field')]", + ); + expect( + call.parameters!.parameters + .firstWhere((e) => e.name!.lexeme == 'id') + .metadata + .toString(), + "[@Deprecated('field')]", + ); + }); + + test('Annotations on generated functionalProvider', () { + final annotations = + declarations.findNamed('functionalProvider').metadata.toString(); expect( annotations, @@ -26,11 +42,9 @@ void main() async { ); }); - test('Annotations on generated classBasedProvider', () async { - final annotations = topLevelDeclarations - .findNamed('classBasedProvider') - .metadata - .toString(); + test('Annotations on generated classBasedProvider', () { + final annotations = + declarations.findNamed('classBasedProvider').metadata.toString(); expect( annotations, @@ -38,17 +52,17 @@ void main() async { ); }); - test('Annotations on generated familyProvider', () async { + test('Annotations on generated familyProvider', () { final annotations = - topLevelDeclarations.findNamed('familyProvider').metadata.toString(); + declarations.findNamed('familyProvider').metadata.toString(); expect( annotations, "[@ProviderFor(family), @Deprecated('Deprecation message'), @visibleForTesting, @protected]", ); }); - test('Annotations on generated notCopiedFunctionalProvider', () async { - final annotations = topLevelDeclarations + test('Annotations on generated notCopiedFunctionalProvider', () { + final annotations = declarations .findNamed('notCopiedFunctionalProvider') .metadata .toString(); @@ -58,8 +72,8 @@ void main() async { ); }); - test('Annotations on generated notCopiedClassBasedProvider', () async { - final annotations = topLevelDeclarations + test('Annotations on generated notCopiedClassBasedProvider', () { + final annotations = declarations .findNamed('notCopiedClassBasedProvider') .metadata .toString(); @@ -69,11 +83,9 @@ void main() async { ); }); - test('Annotations on generated notCopiedFamilyProvider', () async { - final annotations = topLevelDeclarations - .findNamed('notCopiedFamilyProvider') - .metadata - .toString(); + test('Annotations on generated notCopiedFamilyProvider', () { + final annotations = + declarations.findNamed('notCopiedFamilyProvider').metadata.toString(); expect( annotations, '[@ProviderFor(notCopiedFamily)]', @@ -81,11 +93,23 @@ void main() async { }); } -extension TopLevelVariableDeclarationFindNamedX - on List { - TopLevelVariableDeclaration findNamed(String name) { +extension TopLevelVariableDeclarationFindNamedX on List { + Declaration findNamed(String name) { return singleWhere((element) { - return element.variables.variables.first.name.lexeme == name; + switch (element) { + case TopLevelVariableDeclaration(): + return element.variables.variables.first.name.lexeme == name; + case FieldDeclaration(): + return element.fields.variables.first.name.lexeme == name; + case MethodDeclaration(): + return element.name.lexeme == name; + case NamedCompilationUnitMember(): + return element.name.lexeme == name; + case ConstructorDeclaration(): + return element.name?.lexeme == name; + case _: + throw UnsupportedError(element.runtimeType.toString()); + } }); } } diff --git a/packages/riverpod_generator/test/doc_test.dart b/packages/riverpod_generator/test/doc_test.dart new file mode 100644 index 000000000..569218dcb --- /dev/null +++ b/packages/riverpod_generator/test/doc_test.dart @@ -0,0 +1,56 @@ +import 'dart:io'; + +import 'package:analyzer/dart/analysis/results.dart'; +import 'package:analyzer/dart/analysis/utilities.dart'; +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:riverpod_generator/src/riverpod_generator.dart'; +import 'package:test/test.dart'; + +import 'annotated_test.dart'; + +void main() async { + final file = File('test/integration/documented.g.dart').absolute; + final result = await resolveFile2(path: file.path) as ResolvedUnitResult; + final topLevelDeclarations = result.unit.declarations.toList(); + + // TODO changelog added support for documentation on providers/parameters + test('Doc on generated variables', () async { + final doc = topLevelDeclarations.findNamed('functionalProvider').doc; + + expect(doc, '/// Hello world\n// Foo\n'); + }); + + test('Doc on generated provider', () async { + final doc = topLevelDeclarations.findNamed('FunctionalProvider').doc; + + expect(doc, '/// Hello world\n// Foo\n'); + }); + + test('Doc on generated ref', () async { + final doc = topLevelDeclarations.findNamed('FamilyRef').doc; + + expect(doc, '/// Hello world\n// Foo\n'); + }); + + test('Doc on generated family', () async { + final family = + topLevelDeclarations.findNamed('FamilyFamily') as ClassDeclaration; + + expect( + family.members.findNamed('call').doc, + '/// Hello world\n// Foo\n', + ); + + expect(family.doc, '/// Hello world\n// Foo\n'); + }); + + test('Doc on generated class', () async { + final classBased = topLevelDeclarations.findNamed(r'_$ClassFamilyBased') + as ClassDeclaration; + + expect( + classBased.members.findNamed('id').doc, + '/// Hello world\n// Foo\n', + ); + }); +} diff --git a/packages/riverpod_generator/test/integration/annotated.dart b/packages/riverpod_generator/test/integration/annotated.dart index a60a58a4d..21bcee88f 100644 --- a/packages/riverpod_generator/test/integration/annotated.dart +++ b/packages/riverpod_generator/test/integration/annotated.dart @@ -7,7 +7,8 @@ part 'annotated.g.dart'; @Deprecated('Deprecation message') @visibleForTesting @protected -String functional(FunctionalRef ref) => 'functional'; +String functional(FunctionalRef ref, @Deprecated('field') int id) => + 'functional'; @riverpod @Deprecated('Deprecation message') @@ -15,7 +16,7 @@ String functional(FunctionalRef ref) => 'functional'; @protected class ClassBased extends _$ClassBased { @override - String build() => 'ClassBased'; + String build(@Deprecated('field') int id) => 'ClassBased'; } @riverpod diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 8161c3d60..5308acc12 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -12,19 +12,20 @@ typedef FunctionalRef = Ref; @Deprecated('Deprecation message') @visibleForTesting @protected -const functionalProvider = FunctionalProvider._(); +const functionalProvider = FunctionalFamily._(); final class FunctionalProvider extends $FunctionalProvider with $Provider { const FunctionalProvider._( - {String Function( + {required FunctionalFamily super.from, + required int super.argument, + String Function( FunctionalRef ref, + @Deprecated('field') int id, )? create}) : _createCb = create, super( - from: null, - argument: null, name: r'functionalProvider', isAutoDispose: true, dependencies: null, @@ -33,11 +34,19 @@ final class FunctionalProvider final String Function( FunctionalRef ref, + @Deprecated('field') int id, )? _createCb; @override String debugGetCreateSourceHash() => _$functionalHash(); + @override + String toString() { + return r'functionalProvider' + '' + '($argument)'; + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -48,17 +57,79 @@ final class FunctionalProvider FunctionalRef ref, ) create, ) { - return FunctionalProvider._(create: create); + return FunctionalProvider._( + argument: argument as int, + from: from! as FunctionalFamily, + create: ( + ref, + @Deprecated('field') int id, + ) => + create(ref)); } @override String create(FunctionalRef ref) { final fn = _createCb ?? functional; - return fn(ref); + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is FunctionalProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; } } -String _$functionalHash() => r'69e260b1de8ba28cbeb8e24d628933366cde6b8b'; +String _$functionalHash() => r'288107f94c896141a9b3999f606e4ccdf078f15e'; + +final class FunctionalFamily extends Family { + const FunctionalFamily._() + : super( + name: r'functionalProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + FunctionalProvider call( + @Deprecated('field') int id, + ) => + FunctionalProvider._(argument: id, from: this); + + @override + String debugGetCreateSourceHash() => _$functionalHash(); + + @override + String toString() => r'functionalProvider'; + + Override overrideWith( + String Function( + FunctionalRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FunctionalProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } +} typedef FamilyRef = Ref; @@ -363,15 +434,16 @@ final class NotCopiedFamilyFamily extends Family { @Deprecated('Deprecation message') @visibleForTesting @protected -const classBasedProvider = ClassBasedProvider._(); +const classBasedProvider = ClassBasedFamily._(); final class ClassBasedProvider extends $NotifierProvider { const ClassBasedProvider._( - {super.runNotifierBuildOverride, ClassBased Function()? create}) + {required ClassBasedFamily super.from, + required int super.argument, + super.runNotifierBuildOverride, + ClassBased Function()? create}) : _createCb = create, super( - from: null, - argument: null, name: r'classBasedProvider', isAutoDispose: true, dependencies: null, @@ -383,6 +455,13 @@ final class ClassBasedProvider extends $NotifierProvider { @override String debugGetCreateSourceHash() => _$classBasedHash(); + @override + String toString() { + return r'classBasedProvider' + '' + '($argument)'; + } + @$internal @override ClassBased create() => _createCb?.call() ?? ClassBased(); @@ -392,7 +471,10 @@ final class ClassBasedProvider extends $NotifierProvider { ClassBasedProvider $copyWithCreate( ClassBased Function() create, ) { - return ClassBasedProvider._(create: create); + return ClassBasedProvider._( + argument: argument as int, + from: from! as ClassBasedFamily, + create: create); } @$internal @@ -403,7 +485,10 @@ final class ClassBasedProvider extends $NotifierProvider { ClassBased, ) build, ) { - return ClassBasedProvider._(runNotifierBuildOverride: build); + return ClassBasedProvider._( + argument: argument as int, + from: from! as ClassBasedFamily, + runNotifierBuildOverride: build); } @$internal @@ -411,16 +496,91 @@ final class ClassBasedProvider extends $NotifierProvider { $NotifierProviderElement createElement( ProviderContainer container) => $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is ClassBasedProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } } -String _$classBasedHash() => r'f40d1a032ee264aafd7686a985cdf1937f2dc108'; +String _$classBasedHash() => r'92b444806ef8a304c6e0dc3d8e2383601e781183'; + +final class ClassBasedFamily extends Family { + const ClassBasedFamily._() + : super( + name: r'classBasedProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + ClassBasedProvider call( + @Deprecated('field') int id, + ) => + ClassBasedProvider._(argument: id, from: this); + + @override + String debugGetCreateSourceHash() => _$classBasedHash(); + + @override + String toString() => r'classBasedProvider'; + + Override overrideWith( + ClassBased Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ClassBasedProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + Override overrideWithBuild( + String Function(Ref ref, ClassBased notifier, int argument) build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ClassBasedProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } +} abstract class _$ClassBased extends $Notifier { - String build(); + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + @Deprecated('field') + int get id => _$args; + + String build( + @Deprecated('field') int id, + ); @$internal @override - String runBuild() => build(); + String runBuild() => build( + _$args, + ); } @ProviderFor(NotCopiedClassBased) diff --git a/packages/riverpod_generator/test/integration/documented.dart b/packages/riverpod_generator/test/integration/documented.dart index 0a03bf001..ead656b6e 100644 --- a/packages/riverpod_generator/test/integration/documented.dart +++ b/packages/riverpod_generator/test/integration/documented.dart @@ -2,8 +2,8 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'documented.g.dart'; -// Foo /// Hello world +// Foo @riverpod String functional(FunctionalRef ref) => 'functional'; diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index f9e0d541d..f09a68d70 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -7,17 +7,21 @@ part of 'documented.dart'; // ************************************************************************** /// Hello world +// Foo typedef FunctionalRef = Ref; /// Hello world +// Foo @ProviderFor(functional) const functionalProvider = FunctionalProvider._(); /// Hello world +// Foo final class FunctionalProvider extends $FunctionalProvider with $Provider { /// Hello world +// Foo const FunctionalProvider._( {String Function( FunctionalRef ref, From 819f58b051acbde2a349e05293ed58b73bc38fe1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 10:14:24 +0100 Subject: [PATCH 173/387] Add overrideWithValue --- packages/riverpod/lib/riverpod.dart | 2 +- packages/riverpod/lib/src/core/override.dart | 2 +- .../lib/src/core/override_with_value.dart | 16 +- .../src/core/provider/notifier_provider.dart | 3 + .../riverpod/lib/src/providers/provider.dart | 4 +- .../test/consumer_test.dart | 46 ---- .../lib/riverpod_annotation.dart | 2 + .../integration/build_yaml/lib/main.g.dart | 41 ++++ .../lib/src/riverpod_generator.dart | 4 - .../lib/src/templates/family.dart | 6 +- .../lib/src/templates/provider.dart | 15 ++ .../test/dependencies_test.dart | 36 +++- .../test/integration/annotated.g.dart | 53 +++++ .../test/integration/async.g.dart | 9 + .../test/integration/auto_dispose.g.dart | 24 +++ .../test/integration/dependencies.g.dart | 149 +++++++++++++ .../test/integration/dependencies2.g.dart | 51 +++++ .../test/integration/documented.g.dart | 35 +++ .../test/integration/generated.g.dart | 114 ++++++++++ .../test/integration/hash/hash1.g.dart | 24 +++ .../test/integration/scopes.g.dart | 16 ++ .../test/integration/split.g.dart | 16 ++ .../test/integration/stream.g.dart | 6 + .../test/integration/sync.g.dart | 203 ++++++++++++++++++ .../riverpod_generator/test/sync_test.dart | 13 +- 25 files changed, 815 insertions(+), 75 deletions(-) diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index b83351bf3..3cfd8f660 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -10,7 +10,7 @@ export 'src/framework.dart' ProviderScheduler, debugCanModifyProviders, Vsync, - ValueProvider, + $ValueProvider, FamilyCreate, FunctionalFamily, $FamilyOverride, diff --git a/packages/riverpod/lib/src/core/override.dart b/packages/riverpod/lib/src/core/override.dart index fe93f493a..79e766644 100644 --- a/packages/riverpod/lib/src/core/override.dart +++ b/packages/riverpod/lib/src/core/override.dart @@ -67,7 +67,7 @@ class $ProviderOverride implements _ProviderOverride { @override String toString() { switch (providerOverride) { - case ValueProvider(:final _value): + case $ValueProvider(:final _value): return '$origin.overrideWithValue($_value)'; default: return '$origin.overrideWith(...)'; diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index 44d7479ef..cea8e5e4a 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -3,12 +3,10 @@ part of '../framework.dart'; /// A provider that is driven by a value instead of a function. /// /// This is an implementation detail of `overrideWithValue`. -@sealed -@internal -final class ValueProvider extends ProviderBase +final class $ValueProvider extends ProviderBase with LegacyProviderMixin { - /// Creates a [ValueProvider]. - const ValueProvider(this._value) + /// Creates a [$ValueProvider]. + const $ValueProvider(this._value) : super( name: null, from: null, @@ -32,9 +30,9 @@ final class ValueProvider extends ProviderBase } } -/// The [ProviderElementBase] of a [ValueProvider] +/// The [ProviderElementBase] of a [$ValueProvider] class _ValueProviderElement extends ProviderElementBase { - /// The [ProviderElementBase] of a [ValueProvider] + /// The [ProviderElementBase] of a [$ValueProvider] _ValueProviderElement(this.provider, super.container); /// A custom listener called when `overrideWithValue` changes @@ -42,10 +40,10 @@ class _ValueProviderElement extends ProviderElementBase { void Function(State value)? onChange; @override - ValueProvider provider; + $ValueProvider provider; @override - void update(covariant ValueProvider newProvider) { + void update(covariant $ValueProvider newProvider) { super.update(newProvider); provider = newProvider; final newValue = provider._value; diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index f9188068e..18611caff 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -129,6 +129,9 @@ abstract base class $ClassProvider< // } // TODO docs + /// {@template riverpod.override_with_build} + /// Hello world + /// {@endtemplate} Override overrideWithBuild( RunNotifierBuild build, ) { diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 3c9a688db..64064370c 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -90,6 +90,7 @@ base class Provider ); } + /// {@template riverpod.override_with_value} /// Overrides a provider with a value, ejecting the default behavior. /// /// This will also disable the auto-scoping mechanism, meaning that if the @@ -119,10 +120,11 @@ base class Provider /// ), /// ); /// ``` + /// {@endtemplate} Override overrideWithValue(StateT value) { return $ProviderOverride( origin: this, - providerOverride: ValueProvider(value), + providerOverride: $ValueProvider(value), ); } } diff --git a/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart b/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart index e92b22e4c..b23769ef2 100644 --- a/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart @@ -1,55 +1,9 @@ -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/ast/ast.dart'; -import 'package:analyzer/dart/ast/token.dart'; -import 'package:analyzer/dart/ast/visitor.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import 'package:test/test.dart'; import 'analyzer_test_utils.dart'; -class MyVisitor extends RecursiveAstVisitor { - @override - void visitClassDeclaration(ClassDeclaration node) { - print(node); - final buffer = StringBuffer(); - for (Token? a = node.documentationComment!.beginToken; - a != null; - a = a.next) { - buffer.write(a); - } - print(buffer); - print('`${node.declaredElement?.documentationComment}`'); - } - - @override - void visitFunctionDeclaration(FunctionDeclaration node) { - print(node); - print('`${node.documentationComment}`'); - print('`${node.declaredElement?.documentationComment}`'); - } -} - void main() { - testSource('MyTest', source: ''' -library foo; -/// Hello world -class Foo {} - -/// Hello world -void fn() {} -''', (resolver) async { - final library = await resolver.requireFindLibraryByName( - 'foo', - ignoreErrors: true, - ); - final libraryAst = - await library.session.getResolvedLibraryByElement(library); - libraryAst as ResolvedLibraryResult; - - final visitor = MyVisitor(); - libraryAst.units.first.unit.accept(visitor); - }); - testSource('Handles consumers with a ProviderBase inside', source: ''' import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter/material.dart'; diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index 5ac6e6d2f..364260ddb 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -19,6 +19,8 @@ export 'package:riverpod/src/internals.dart' $AsyncClassModifier, $ClassProvider, Ref, + $ValueProvider, + $ProviderOverride, // Provider $Provider, diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 11e0998ff..7fdbaeab2 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -34,6 +34,14 @@ final class CountProvider extends $FunctionalProvider @override String debugGetCreateSourceHash() => _$countHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -195,6 +203,14 @@ final class Count2Provider extends $FunctionalProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -258,6 +274,7 @@ final class Count2Family extends Family { @override String toString() => r'count2ProviderFamily'; + /// {@macro riverpod.override_with} Override overrideWith( int Function( Count2Ref ref, @@ -380,6 +397,7 @@ final class CountFuture2Family extends Family { @override String toString() => r'countFuture2ProviderFamily'; + /// {@macro riverpod.override_with} Override overrideWith( FutureOr Function( CountFuture2Ref ref, @@ -502,6 +520,7 @@ final class CountStream2Family extends Family { @override String toString() => r'countStream2ProviderFamily'; + /// {@macro riverpod.override_with} Override overrideWith( Stream Function( CountStream2Ref ref, @@ -545,6 +564,14 @@ final class CountNotifierProvider @override String debugGetCreateSourceHash() => _$countNotifierHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override CountNotifier create() => _createCb?.call() ?? CountNotifier(); @@ -741,6 +768,14 @@ final class CountNotifier2Provider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override CountNotifier2 create() => _createCb?.call() ?? CountNotifier2(); @@ -809,6 +844,7 @@ final class CountNotifier2Family extends Family { @override String toString() => r'countNotifier2ProviderFamily'; + /// {@macro riverpod.override_with} Override overrideWith( CountNotifier2 Function( int args, @@ -828,6 +864,7 @@ final class CountNotifier2Family extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( int Function(Ref ref, CountNotifier2 notifier, int argument) build, ) { @@ -960,6 +997,7 @@ final class CountAsyncNotifier2Family extends Family { @override String toString() => r'countAsyncNotifier2ProviderFamily'; + /// {@macro riverpod.override_with} Override overrideWith( CountAsyncNotifier2 Function( int args, @@ -979,6 +1017,7 @@ final class CountAsyncNotifier2Family extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( FutureOr Function(Ref> ref, CountAsyncNotifier2 notifier, int argument) @@ -1114,6 +1153,7 @@ final class CountStreamNotifier2Family extends Family { @override String toString() => r'countStreamNotifier2ProviderFamily'; + /// {@macro riverpod.override_with} Override overrideWith( CountStreamNotifier2 Function( int args, @@ -1133,6 +1173,7 @@ final class CountStreamNotifier2Family extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( Stream Function(Ref> ref, CountStreamNotifier2 notifier, int argument) diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index 01778bc88..8c22fed54 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -54,8 +54,6 @@ class RiverpodInvalidGenerationSourceError }); final AstNode? astNode; - -// TODO override toString to render AST nodes. } @immutable @@ -159,7 +157,6 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { for (final dependency in dependencies) { if (!uniqueDependencies.add(dependency.provider)) continue; - // TODO verify that the provider is accessible in the current library allTransitiveDependencies.add(dependency.provider.providerName(options)); final uniqueTransitiveDependencies = @@ -174,7 +171,6 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { in uniqueTransitiveDependencies) { if (!uniqueDependencies.add(transitiveDependency)) continue; - // TODO verify that the provider is accessible in the current library allTransitiveDependencies.add( '${dependency.provider.providerTypeName}.\$allTransitiveDependencies$index', ); diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index aaa14624a..a6f3725a9 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -30,8 +30,6 @@ class FamilyTemplate extends Template { final topLevelBuffer = StringBuffer(); - // TODO add docs everywhere in generated code - final parametersPassThrough = provider.argumentToRecord(); final argument = provider.parameters.isEmpty ? '' : 'argument: $parametersPassThrough,'; @@ -102,8 +100,8 @@ ${provider.doc} final class ${provider.familyTypeName} extends Family { '$_notifierType Function$_genericsDefinition()', }; - // TODO docs buffer.writeln(''' +/// {@macro riverpod.override_with} Override overrideWith($createType create,) { return \$FamilyOverride( from: this, @@ -180,8 +178,8 @@ ${provider.createdTypeDisplayString} Function$_genericsDefinition( }} )'''; - // TODO docs buffer.writeln(''' +/// {@macro riverpod.override_with_build} Override overrideWithBuild($runNotifierBuildType build,) { return \$FamilyOverride( from: this, diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 65147a7d2..496218f10 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -152,6 +152,7 @@ ${provider.doc} final class $name$_genericsDefinition _writeGenericCopyWith(buffer, copyParameters: copyParameters); _writeToString(buffer); + _writeOverrideWithValue(buffer); switch (provider) { case FunctionalProviderDeclaration(): @@ -220,6 +221,20 @@ ${provider.doc} final class $name$_genericsDefinition _writeEqual(buffer); } + void _writeOverrideWithValue(StringBuffer buffer) { + if (provider.createdType != SupportedCreatedType.value) return; + + buffer.writeln(''' + /// {@macro riverpod.override_with_value} + Override overrideWithValue(${provider.exposedTypeDisplayString} value) { + return \$ProviderOverride( + origin: this, + providerOverride: \$ValueProvider<${provider.exposedTypeDisplayString}>(value), + ); + } +'''); + } + void _writeGenericCopyWith( StringBuffer buffer, { required String copyParameters, diff --git a/packages/riverpod_generator/test/dependencies_test.dart b/packages/riverpod_generator/test/dependencies_test.dart index a0d4e93fa..b57635134 100644 --- a/packages/riverpod_generator/test/dependencies_test.dart +++ b/packages/riverpod_generator/test/dependencies_test.dart @@ -144,6 +144,38 @@ void main() { ); }); - // TODO add tests for duplicate variants - // TODO add tests for set vs list + test('remove duplicate dependencies', () { + expect( + duplicateDependenciesProvider.dependencies, + same(const [depProvider, dep2Provider]), + ); + expect( + duplicateDependenciesProvider.allTransitiveDependencies, + same(const [depProvider, dep2Provider]), + ); + + expect( + transitiveDuplicateDependenciesProvider.allTransitiveDependencies, + same(const { + duplicateDependenciesProvider, + depProvider, + dep2Provider, + duplicateDependencies2Provider, + familyProvider, + family2Provider, + }), + ); + }); + + test('uses a set or a list based on the length', () { + expect( + smallTransitiveDependencyCountProvider.allTransitiveDependencies, + isA>(), + ); + + expect( + transitiveDependenciesProvider.allTransitiveDependencies, + isA>(), + ); + }); } diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 5308acc12..832122339 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -47,6 +47,14 @@ final class FunctionalProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -110,6 +118,7 @@ final class FunctionalFamily extends Family { @override String toString() => r'functionalProvider'; + /// {@macro riverpod.override_with} Override overrideWith( String Function( FunctionalRef ref, @@ -172,6 +181,14 @@ final class FamilyProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -235,6 +252,7 @@ final class FamilyFamily extends Family { @override String toString() => r'familyProvider'; + /// {@macro riverpod.override_with} Override overrideWith( String Function( FamilyRef ref, @@ -285,6 +303,14 @@ final class NotCopiedFunctionalProvider @override String debugGetCreateSourceHash() => _$notCopiedFunctionalHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -346,6 +372,14 @@ final class NotCopiedFamilyProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -409,6 +443,7 @@ final class NotCopiedFamilyFamily extends Family { @override String toString() => r'notCopiedFamilyProvider'; + /// {@macro riverpod.override_with} Override overrideWith( String Function( NotCopiedFamilyRef ref, @@ -462,6 +497,14 @@ final class ClassBasedProvider extends $NotifierProvider { '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override ClassBased create() => _createCb?.call() ?? ClassBased(); @@ -530,6 +573,7 @@ final class ClassBasedFamily extends Family { @override String toString() => r'classBasedProvider'; + /// {@macro riverpod.override_with} Override overrideWith( ClassBased Function( int args, @@ -549,6 +593,7 @@ final class ClassBasedFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( String Function(Ref ref, ClassBased notifier, int argument) build, ) { @@ -605,6 +650,14 @@ final class NotCopiedClassBasedProvider @override String debugGetCreateSourceHash() => _$notCopiedClassBasedHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override NotCopiedClassBased create() => _createCb?.call() ?? NotCopiedClassBased(); diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 96daa4fb4..c966d33bc 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -102,6 +102,7 @@ final class GenericFamily extends Family { @override String toString() => r'genericProvider'; + /// {@macro riverpod.override_with} Override overrideWith( FutureOr> Function(GenericRef ref) create, ) { @@ -319,6 +320,7 @@ final class FamilyOrFamily extends Family { @override String toString() => r'familyOrProvider'; + /// {@macro riverpod.override_with} Override overrideWith( FutureOr Function( FamilyOrRef ref, @@ -492,6 +494,7 @@ final class FamilyFamily extends Family { @override String toString() => r'familyProvider'; + /// {@macro riverpod.override_with} Override overrideWith( FutureOr Function( FamilyRef ref, @@ -636,6 +639,7 @@ final class GenericClassFamily extends Family { @override String toString() => r'genericClassProvider'; + /// {@macro riverpod.override_with} Override overrideWith( GenericClass Function() create, ) { @@ -649,6 +653,7 @@ final class GenericClassFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( FutureOr> Function( Ref>> ref, GenericClass notifier) @@ -895,6 +900,7 @@ final class FamilyOrClassFamily extends Family { @override String toString() => r'familyOrClassProvider'; + /// {@macro riverpod.override_with} Override overrideWith( FamilyOrClass Function( int args, @@ -914,6 +920,7 @@ final class FamilyOrClassFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( FutureOr Function( Ref> ref, FamilyOrClass notifier, int argument) @@ -1077,6 +1084,7 @@ final class FamilyClassFamily extends Family { @override String toString() => r'familyClassProvider'; + /// {@macro riverpod.override_with} Override overrideWith( FamilyClass Function( ( @@ -1108,6 +1116,7 @@ final class FamilyClassFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( FutureOr Function( Ref> ref, diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index afd0586fa..e90a1988a 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -35,6 +35,14 @@ final class KeepAliveProvider @override String debugGetCreateSourceHash() => _$keepAliveHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -86,6 +94,14 @@ final class NotKeepAliveProvider @override String debugGetCreateSourceHash() => _$notKeepAliveHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -137,6 +153,14 @@ final class DefaultKeepAliveProvider @override String debugGetCreateSourceHash() => _$defaultKeepAliveHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 887a366a6..e63eb83df 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -34,6 +34,14 @@ final class DepProvider extends $FunctionalProvider @override String debugGetCreateSourceHash() => _$depHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -93,6 +101,14 @@ final class FamilyProvider extends $FunctionalProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -156,6 +172,7 @@ final class FamilyFamily extends Family { @override String toString() => r'familyProvider'; + /// {@macro riverpod.override_with} Override overrideWith( int Function( FamilyRef ref, @@ -220,6 +237,14 @@ final class ProviderProvider extends $FunctionalProvider @override String debugGetCreateSourceHash() => _$providerHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -286,6 +311,14 @@ final class Provider2Provider @override String debugGetCreateSourceHash() => _$provider2Hash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -353,6 +386,14 @@ final class TransitiveDependenciesProvider @override String debugGetCreateSourceHash() => _$transitiveDependenciesHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -418,6 +459,14 @@ final class SmallTransitiveDependencyCountProvider @override String debugGetCreateSourceHash() => _$smallTransitiveDependencyCountHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -471,6 +520,14 @@ final class EmptyDependenciesFunctionalProvider @override String debugGetCreateSourceHash() => _$emptyDependenciesFunctionalHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -532,6 +589,14 @@ final class ProviderWithDependenciesProvider @override String debugGetCreateSourceHash() => _$providerWithDependenciesHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -584,6 +649,14 @@ final class _PrivateDepProvider @override String debugGetCreateSourceHash() => _$privateDepHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -635,6 +708,14 @@ final class PublicDepProvider @override String debugGetCreateSourceHash() => _$publicDepHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -692,6 +773,14 @@ final class DuplicateDependenciesProvider @override String debugGetCreateSourceHash() => _$duplicateDependenciesHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -753,6 +842,14 @@ final class DuplicateDependencies2Provider @override String debugGetCreateSourceHash() => _$duplicateDependencies2Hash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -827,6 +924,14 @@ final class TransitiveDuplicateDependenciesProvider @override String debugGetCreateSourceHash() => _$transitiveDuplicateDependenciesHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -871,6 +976,14 @@ final class Dep2Provider extends $NotifierProvider { @override String debugGetCreateSourceHash() => _$dep2Hash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override Dep2 create() => _createCb?.call() ?? Dep2(); @@ -940,6 +1053,14 @@ final class Family2Provider extends $NotifierProvider { '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override Family2 create() => _createCb?.call() ?? Family2(); @@ -1008,6 +1129,7 @@ final class Family2Family extends Family { @override String toString() => r'family2Provider'; + /// {@macro riverpod.override_with} Override overrideWith( Family2 Function( int args, @@ -1027,6 +1149,7 @@ final class Family2Family extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( int Function(Ref ref, Family2 notifier, int argument) build, ) { @@ -1096,6 +1219,14 @@ final class Provider3Provider extends $NotifierProvider { @override String debugGetCreateSourceHash() => _$provider3Hash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override Provider3 create() => _createCb?.call() ?? Provider3(); @@ -1170,6 +1301,14 @@ final class Provider4Provider extends $NotifierProvider { '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override Provider4 create() => _createCb?.call() ?? Provider4(); @@ -1248,6 +1387,7 @@ final class Provider4Family extends Family { @override String toString() => r'provider4Provider'; + /// {@macro riverpod.override_with} Override overrideWith( Provider4 Function( int args, @@ -1267,6 +1407,7 @@ final class Provider4Family extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( int Function(Ref ref, Provider4 notifier, int argument) build, ) { @@ -1324,6 +1465,14 @@ final class EmptyDependenciesClassBasedProvider @override String debugGetCreateSourceHash() => _$emptyDependenciesClassBasedHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override EmptyDependenciesClassBased create() => diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index c51733419..124335e8f 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -53,6 +53,14 @@ final class ProviderWithDependencies2Provider @override String debugGetCreateSourceHash() => _$providerWithDependencies2Hash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -122,6 +130,14 @@ final class FamilyWithDependencies2Provider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -197,6 +213,7 @@ final class FamilyWithDependencies2Family extends Family { @override String toString() => r'familyWithDependencies2Provider'; + /// {@macro riverpod.override_with} Override overrideWith( int Function( FamilyWithDependencies2Ref ref, @@ -247,6 +264,14 @@ final class _Private2Provider @override String debugGetCreateSourceHash() => _$private2Hash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -297,6 +322,14 @@ final class Public2Provider extends $FunctionalProvider @override String debugGetCreateSourceHash() => _$public2Hash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -360,6 +393,14 @@ final class NotifierWithDependenciesProvider @override String debugGetCreateSourceHash() => _$notifierWithDependenciesHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override NotifierWithDependencies create() => @@ -441,6 +482,14 @@ final class NotifierFamilyWithDependenciesProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override NotifierFamilyWithDependencies create() => @@ -522,6 +571,7 @@ final class NotifierFamilyWithDependenciesFamily extends Family { @override String toString() => r'notifierFamilyWithDependenciesProvider'; + /// {@macro riverpod.override_with} Override overrideWith( NotifierFamilyWithDependencies Function( int? args, @@ -541,6 +591,7 @@ final class NotifierFamilyWithDependenciesFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( int Function(Ref ref, NotifierFamilyWithDependencies notifier, int? argument) diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index f09a68d70..4cd8c3faa 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -43,6 +43,14 @@ final class FunctionalProvider @override String debugGetCreateSourceHash() => _$functionalHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -111,6 +119,14 @@ final class FamilyProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -178,6 +194,7 @@ final class FamilyFamily extends Family { @override String toString() => r'familyProvider'; + /// {@macro riverpod.override_with} Override overrideWith( String Function( FamilyRef ref, @@ -226,6 +243,14 @@ final class ClassBasedProvider extends $NotifierProvider { @override String debugGetCreateSourceHash() => _$classBasedHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override ClassBased create() => _createCb?.call() ?? ClassBased(); @@ -302,6 +327,14 @@ final class ClassFamilyBasedProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override ClassFamilyBased create() => _createCb?.call() ?? ClassFamilyBased(); @@ -374,6 +407,7 @@ final class ClassFamilyBasedFamily extends Family { @override String toString() => r'classFamilyBasedProvider'; + /// {@macro riverpod.override_with} Override overrideWith( ClassFamilyBased Function( int args, @@ -393,6 +427,7 @@ final class ClassFamilyBasedFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( String Function(Ref ref, ClassFamilyBased notifier, int argument) build, diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 8358b8638..0504cfed0 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -35,6 +35,14 @@ final class GeneratedProvider @override String debugGetCreateSourceHash() => _$generatedHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(_Test value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider<_Test>(value), + ); + } + @override $ProviderElement<_Test> createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -95,6 +103,14 @@ final class GeneratedFamilyProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(_Test value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider<_Test>(value), + ); + } + @override $ProviderElement<_Test> createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -158,6 +174,7 @@ final class GeneratedFamilyFamily extends Family { @override String toString() => r'generatedFamilyProvider'; + /// {@macro riverpod.override_with} Override overrideWith( _Test Function( GeneratedFamilyRef ref, @@ -208,6 +225,14 @@ final class $DynamicProvider @override String debugGetCreateSourceHash() => _$$dynamicHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Object? value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -268,6 +293,14 @@ final class $DynamicFamilyProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Object? value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -331,6 +364,7 @@ final class $DynamicFamilyFamily extends Family { @override String toString() => r'$dynamicFamilyProvider'; + /// {@macro riverpod.override_with} Override overrideWith( Object? Function( $DynamicFamilyRef ref, @@ -390,6 +424,14 @@ final class _DynamicProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Object? value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -453,6 +495,7 @@ final class _DynamicFamily extends Family { @override String toString() => r'_dynamicProvider'; + /// {@macro riverpod.override_with} Override overrideWith( Object? Function( _DynamicRef ref, @@ -503,6 +546,14 @@ final class AliasProvider @override String debugGetCreateSourceHash() => _$aliasHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(r.AsyncValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + @override $ProviderElement> createElement( ProviderContainer container) => @@ -565,6 +616,14 @@ final class AliasFamilyProvider extends $FunctionalProvider< '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(r.AsyncValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + @override $ProviderElement> createElement( ProviderContainer container) => @@ -629,6 +688,7 @@ final class AliasFamilyFamily extends Family { @override String toString() => r'aliasFamilyProvider'; + /// {@macro riverpod.override_with} Override overrideWith( r.AsyncValue Function( AliasFamilyRef ref, @@ -672,6 +732,14 @@ final class GeneratedClassProvider @override String debugGetCreateSourceHash() => _$generatedClassHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(_Test value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider<_Test>(value), + ); + } + @$internal @override GeneratedClass create() => _createCb?.call() ?? GeneratedClass(); @@ -742,6 +810,14 @@ final class GeneratedClassFamilyProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(_Test value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider<_Test>(value), + ); + } + @$internal @override GeneratedClassFamily create() => _createCb?.call() ?? GeneratedClassFamily(); @@ -811,6 +887,7 @@ final class GeneratedClassFamilyFamily extends Family { @override String toString() => r'generatedClassFamilyProvider'; + /// {@macro riverpod.override_with} Override overrideWith( GeneratedClassFamily Function( _Test args, @@ -830,6 +907,7 @@ final class GeneratedClassFamilyFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( _Test Function( Ref<_Test> ref, GeneratedClassFamily notifier, _Test argument) @@ -888,6 +966,14 @@ final class $DynamicClassProvider @override String debugGetCreateSourceHash() => _$$dynamicClassHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Object? value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override $DynamicClass create() => _createCb?.call() ?? $DynamicClass(); @@ -958,6 +1044,14 @@ final class $DynamicClassFamilyProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Object? value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override $DynamicClassFamily create() => _createCb?.call() ?? $DynamicClassFamily(); @@ -1027,6 +1121,7 @@ final class $DynamicClassFamilyFamily extends Family { @override String toString() => r'$dynamicClassFamilyProvider'; + /// {@macro riverpod.override_with} Override overrideWith( $DynamicClassFamily Function( dynamic args, @@ -1046,6 +1141,7 @@ final class $DynamicClassFamilyFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( Object? Function( Ref ref, $DynamicClassFamily notifier, dynamic argument) @@ -1104,6 +1200,14 @@ final class AliasClassProvider @override String debugGetCreateSourceHash() => _$aliasClassHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(r.AsyncValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + @$internal @override AliasClass create() => _createCb?.call() ?? AliasClass(); @@ -1174,6 +1278,14 @@ final class AliasClassFamilyProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(r.AsyncValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + @$internal @override AliasClassFamily create() => _createCb?.call() ?? AliasClassFamily(); @@ -1242,6 +1354,7 @@ final class AliasClassFamilyFamily extends Family { @override String toString() => r'aliasClassFamilyProvider'; + /// {@macro riverpod.override_with} Override overrideWith( AliasClassFamily Function( r.AsyncValue args, @@ -1261,6 +1374,7 @@ final class AliasClassFamilyFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( r.AsyncValue Function(Ref> ref, AliasClassFamily notifier, r.AsyncValue argument) diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index b22937a9a..dd8129083 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -35,6 +35,14 @@ final class SimpleProvider @override String debugGetCreateSourceHash() => _$simpleHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -86,6 +94,14 @@ final class Simple2Provider @override String debugGetCreateSourceHash() => _$simple2Hash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -129,6 +145,14 @@ final class SimpleClassProvider extends $NotifierProvider { @override String debugGetCreateSourceHash() => _$simpleClassHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override SimpleClass create() => _createCb?.call() ?? SimpleClass(); diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 4a0df2dbe..04c3f4feb 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -34,6 +34,14 @@ final class ScopedProvider extends $FunctionalProvider @override String debugGetCreateSourceHash() => _$scopedHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -77,6 +85,14 @@ final class ScopedClassProvider extends $NotifierProvider { @override String debugGetCreateSourceHash() => _$scopedClassHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override ScopedClass create() => _createCb?.call() ?? ScopedClass(); diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index c330ad6f1..5a7df070b 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -34,6 +34,14 @@ final class Counter2Provider extends $FunctionalProvider @override String debugGetCreateSourceHash() => _$counter2Hash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -84,6 +92,14 @@ final class CounterProvider extends $FunctionalProvider @override String debugGetCreateSourceHash() => _$counterHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 6d841c155..ab390e60a 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -102,6 +102,7 @@ final class GenericFamily extends Family { @override String toString() => r'genericProvider'; + /// {@macro riverpod.override_with} Override overrideWith( Stream> Function(GenericRef ref) create, ) { @@ -370,6 +371,7 @@ final class FamilyFamily extends Family { @override String toString() => r'familyProvider'; + /// {@macro riverpod.override_with} Override overrideWith( Stream Function( FamilyRef ref, @@ -514,6 +516,7 @@ final class GenericClassFamily extends Family { @override String toString() => r'genericClassProvider'; + /// {@macro riverpod.override_with} Override overrideWith( GenericClass Function() create, ) { @@ -527,6 +530,7 @@ final class GenericClassFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( Stream> Function( Ref>> ref, GenericClass notifier) @@ -802,6 +806,7 @@ final class FamilyClassFamily extends Family { @override String toString() => r'familyClassProvider'; + /// {@macro riverpod.override_with} Override overrideWith( FamilyClass Function( ( @@ -833,6 +838,7 @@ final class FamilyClassFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( Stream Function( Ref> ref, diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index e7129a71d..ee8e62581 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -51,6 +51,14 @@ final class GenericProvider '()'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + @override $ProviderElement> createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -102,6 +110,7 @@ final class GenericFamily extends Family { @override String toString() => r'genericProvider'; + /// {@macro riverpod.override_with} Override overrideWith( List Function(GenericRef ref) create, ) { @@ -176,6 +185,14 @@ final class ComplexGenericProvider '$argument'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + @override $ProviderElement> createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -256,6 +273,7 @@ final class ComplexGenericFamily extends Family { @override String toString() => r'complexGenericProvider'; + /// {@macro riverpod.override_with} Override overrideWith( List Function( ComplexGenericRef ref, @@ -315,6 +333,14 @@ final class RawFutureProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$rawFutureHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + @override $ProviderElement>> createElement( ProviderContainer container) => @@ -368,6 +394,14 @@ final class RawStreamProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$rawStreamHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + @override $ProviderElement>> createElement( ProviderContainer container) => @@ -429,6 +463,14 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + @override $ProviderElement>> createElement( ProviderContainer container) => @@ -493,6 +535,7 @@ final class RawFamilyFutureFamily extends Family { @override String toString() => r'rawFamilyFutureProvider'; + /// {@macro riverpod.override_with} Override overrideWith( Raw> Function( RawFamilyFutureRef ref, @@ -552,6 +595,14 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + @override $ProviderElement>> createElement( ProviderContainer container) => @@ -616,6 +667,7 @@ final class RawFamilyStreamFamily extends Family { @override String toString() => r'rawFamilyStreamProvider'; + /// {@macro riverpod.override_with} Override overrideWith( Raw> Function( RawFamilyStreamRef ref, @@ -670,6 +722,14 @@ final class PublicProvider @override String debugGetCreateSourceHash() => _$publicHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -721,6 +781,14 @@ final class Supports$inNamesProvider @override String debugGetCreateSourceHash() => _$supports$inNamesHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -800,6 +868,14 @@ final class FamilyProvider '$argument'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -901,6 +977,7 @@ final class FamilyFamily extends Family { @override String toString() => r'familyProvider'; + /// {@macro riverpod.override_with} Override overrideWith( String Function( FamilyRef ref, @@ -963,6 +1040,14 @@ final class _PrivateProvider @override String debugGetCreateSourceHash() => _$privateHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -1030,6 +1115,14 @@ final class Supports$InFnNameProvider '()'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -1083,6 +1176,7 @@ final class Supports$InFnNameFamily extends Family { @override String toString() => r'supports$InFnNameProvider'; + /// {@macro riverpod.override_with} Override overrideWith( String Function(Supports$InFnNameRef ref) create, ) { @@ -1163,6 +1257,14 @@ final class Supports$InFnNameFamilyProvider '$argument'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -1251,6 +1353,7 @@ final class Supports$InFnNameFamilyFamily extends Family { @override String toString() => r'supports$InFnNameFamilyProvider'; + /// {@macro riverpod.override_with} Override overrideWith( String Function( Supports$InFnNameFamilyRef ref, @@ -1312,6 +1415,14 @@ final class GeneratedProvider @override String debugGetCreateSourceHash() => _$generatedHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @override $ProviderElement createElement(ProviderContainer container) => $ProviderElement(this, container); @@ -1381,6 +1492,14 @@ final class GenericClassProvider '()'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + @$internal @override GenericClass create() => _createCb?.call() ?? GenericClass(); @@ -1445,6 +1564,7 @@ final class GenericClassFamily extends Family { @override String toString() => r'genericClassProvider'; + /// {@macro riverpod.override_with} Override overrideWith( GenericClass Function() create, ) { @@ -1458,6 +1578,7 @@ final class GenericClassFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( List Function(Ref> ref, GenericClass notifier) build, @@ -1503,6 +1624,14 @@ final class RawFutureClassProvider @override String debugGetCreateSourceHash() => _$rawFutureClassHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + @$internal @override RawFutureClass create() => _createCb?.call() ?? RawFutureClass(); @@ -1565,6 +1694,14 @@ final class RawStreamClassProvider @override String debugGetCreateSourceHash() => _$rawStreamClassHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + @$internal @override RawStreamClass create() => _createCb?.call() ?? RawStreamClass(); @@ -1635,6 +1772,14 @@ final class RawFamilyFutureClassProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + @$internal @override RawFamilyFutureClass create() => _createCb?.call() ?? RawFamilyFutureClass(); @@ -1704,6 +1849,7 @@ final class RawFamilyFutureClassFamily extends Family { @override String toString() => r'rawFamilyFutureClassProvider'; + /// {@macro riverpod.override_with} Override overrideWith( RawFamilyFutureClass Function( int args, @@ -1723,6 +1869,7 @@ final class RawFamilyFutureClassFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( Raw> Function(Ref>> ref, RawFamilyFutureClass notifier, int argument) @@ -1788,6 +1935,14 @@ final class RawFamilyStreamClassProvider '($argument)'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + @$internal @override RawFamilyStreamClass create() => _createCb?.call() ?? RawFamilyStreamClass(); @@ -1857,6 +2012,7 @@ final class RawFamilyStreamClassFamily extends Family { @override String toString() => r'rawFamilyStreamClassProvider'; + /// {@macro riverpod.override_with} Override overrideWith( RawFamilyStreamClass Function( int args, @@ -1876,6 +2032,7 @@ final class RawFamilyStreamClassFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( Raw> Function(Ref>> ref, RawFamilyStreamClass notifier, int argument) @@ -1935,6 +2092,14 @@ final class PublicClassProvider extends $NotifierProvider { @override String debugGetCreateSourceHash() => _$publicClassHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override PublicClass create() => _createCb?.call() ?? PublicClass(); @@ -1997,6 +2162,14 @@ final class _PrivateClassProvider @override String debugGetCreateSourceHash() => _$privateClassHash(); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override _PrivateClass create() => _createCb?.call() ?? _PrivateClass(); @@ -2076,6 +2249,14 @@ final class FamilyClassProvider extends $NotifierProvider { '$argument'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override FamilyClass create() => _createCb?.call() ?? FamilyClass(); @@ -2168,6 +2349,7 @@ final class FamilyClassFamily extends Family { @override String toString() => r'familyClassProvider'; + /// {@macro riverpod.override_with} Override overrideWith( FamilyClass Function( ( @@ -2199,6 +2381,7 @@ final class FamilyClassFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( String Function( Ref ref, @@ -2314,6 +2497,14 @@ final class Supports$InClassNameProvider '()'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override Supports$InClassName create() => @@ -2381,6 +2572,7 @@ final class Supports$InClassNameFamily extends Family { @override String toString() => r'supports$InClassNameProvider'; + /// {@macro riverpod.override_with} Override overrideWith( Supports$InClassName Function() create, ) { @@ -2394,6 +2586,7 @@ final class Supports$InClassNameFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( String Function( Ref ref, Supports$InClassName notifier) @@ -2482,6 +2675,14 @@ final class Supports$InClassFamilyNameProvider '$argument'; } + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override Supports$InClassFamilyName create() => @@ -2568,6 +2769,7 @@ final class Supports$InClassFamilyNameFamily extends Family { @override String toString() => r'supports$InClassFamilyNameProvider'; + /// {@macro riverpod.override_with} Override overrideWith( Supports$InClassFamilyName Function( ( @@ -2595,6 +2797,7 @@ final class Supports$InClassFamilyNameFamily extends Family { ); } + /// {@macro riverpod.override_with_build} Override overrideWithBuild( String Function( Ref ref, diff --git a/packages/riverpod_generator/test/sync_test.dart b/packages/riverpod_generator/test/sync_test.dart index 515d860da..1f28be855 100644 --- a/packages/riverpod_generator/test/sync_test.dart +++ b/packages/riverpod_generator/test/sync_test.dart @@ -7,8 +7,6 @@ import 'integration/sync.dart'; import 'utils.dart'; void main() { - // TODO test that the generated providers contain the docs from the annotated element - group('Supports generics', () { test('checks generics in hashCode', () { expect( @@ -138,11 +136,10 @@ void main() { 'familyProvider(42, fifth: null, fourth: true, second: foo, third: 0.3)', ); - // TODO uncomment - // expect( - // publicProvider.overrideWithValue('foo').toString(), - // 'publicProvider.overrideWithValue(foo)', - // ); + expect( + publicProvider.overrideWithValue('foo').toString(), + 'publicProvider.overrideWithValue(foo)', + ); expect( familyProvider.overrideWith((ref, _) => 'foo').toString(), 'familyProvider.overrideWith(...)', @@ -324,6 +321,7 @@ void main() { (ref, args) => 'test (first: ${args.$1}, second: ${args.second}, third: ${args.third}, fourth: ${args.fourth}, fifth: ${args.fifth})', ), + familyProvider(21, third: .21).overrideWithValue('Override'), familyClassProvider.overrideWith(FamilyClass.new), ], ); @@ -334,6 +332,7 @@ void main() { container.read(familyProvider(42, second: '42', third: .42)), 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', ); + expect(container.read(familyProvider(21, third: .21)), 'Override'); expect( container .read(familyClassProvider(42, second: '42', third: .42).notifier) From bb9b4248dd1330dfe2e88c8cdcf5d314a9f1cfae Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 10:19:31 +0100 Subject: [PATCH 174/387] Test overrideWithValue/Build and remove createContainer --- .../test/async_notifier_test.dart | 9 ++-- .../riverpod_generator/test/async_test.dart | 11 +++-- .../test/notifier_test.dart | 11 +++-- .../riverpod_generator/test/scoped_test.dart | 6 +-- .../test/stream_notifier_test.dart | 9 ++-- .../riverpod_generator/test/stream_test.dart | 11 +++-- .../riverpod_generator/test/sync_test.dart | 41 ++++++++++++++----- packages/riverpod_generator/test/utils.dart | 16 -------- 8 files changed, 56 insertions(+), 58 deletions(-) delete mode 100644 packages/riverpod_generator/test/utils.dart diff --git a/packages/riverpod_generator/test/async_notifier_test.dart b/packages/riverpod_generator/test/async_notifier_test.dart index e1f72c319..a5ba8c171 100644 --- a/packages/riverpod_generator/test/async_notifier_test.dart +++ b/packages/riverpod_generator/test/async_notifier_test.dart @@ -4,13 +4,12 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:test/test.dart'; import 'integration/async.dart'; -import 'utils.dart'; void main() { test( 'Creates an AsyncNotifierProvider if @riverpod is used on an async class', () { - final container = createContainer(); + final container = ProviderContainer.test(); const ProviderBase> provider = publicClassProvider; final AsyncValue result = container.read(publicClassProvider); @@ -27,7 +26,7 @@ void main() { }); test('Supports overriding non-family notifiers', () { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ publicClassProvider.overrideWith(() => PublicClass('Hello world')), ], @@ -42,7 +41,7 @@ void main() { }); test('Supports overriding family notifiers', () { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ familyClassProvider(42, third: .42) .overrideWith(() => FamilyClass('Hello world')), @@ -66,7 +65,7 @@ void main() { test( 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', () async { - final container = createContainer(); + final container = ProviderContainer.test(); const FamilyClassFamily family = familyClassProvider; diff --git a/packages/riverpod_generator/test/async_test.dart b/packages/riverpod_generator/test/async_test.dart index bf1c24887..3a4c54c0d 100644 --- a/packages/riverpod_generator/test/async_test.dart +++ b/packages/riverpod_generator/test/async_test.dart @@ -5,13 +5,12 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:test/test.dart'; import 'integration/async.dart'; -import 'utils.dart'; void main() { test( 'Creates a FutureProvider if @riverpod is used on a FutureOr function', () { - final container = createContainer(); + final container = ProviderContainer.test(); const ProviderBase> provider = publicProvider; final AsyncValue result = container.read(publicProvider); @@ -28,7 +27,7 @@ void main() { }); test('Supports overriding non-family providers', () async { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ publicProvider.overrideWith((ref) => Future.value('Hello world')), ], @@ -39,7 +38,7 @@ void main() { }); test('Supports overriding family providers', () async { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ familyProvider(21, third: .21).overrideWith( (ref) => Future.value('Override'), @@ -63,7 +62,7 @@ void main() { test( 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', () async { - final container = createContainer(); + final container = ProviderContainer.test(); const FamilyFamily family = familyProvider; @@ -138,7 +137,7 @@ void main() { }); test('can override providers', () { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ publicProvider.overrideWith((ref) { const FutureOr result = 'test'; diff --git a/packages/riverpod_generator/test/notifier_test.dart b/packages/riverpod_generator/test/notifier_test.dart index a0bd63b88..cad4957f6 100644 --- a/packages/riverpod_generator/test/notifier_test.dart +++ b/packages/riverpod_generator/test/notifier_test.dart @@ -1,15 +1,14 @@ // ignore_for_file: omit_local_variable_types, unused_local_variable -import 'package:riverpod/riverpod.dart' show ProviderBase; +import 'package:riverpod/riverpod.dart' show ProviderBase, ProviderContainer; import 'package:test/test.dart'; import 'integration/sync.dart'; -import 'utils.dart'; void main() { test('Creates a Provider if @riverpod is used on a synchronous function', () { - final container = createContainer(); + final container = ProviderContainer.test(); const ProviderBase provider = publicClassProvider; final String result = container.read(publicProvider); @@ -26,7 +25,7 @@ void main() { }); test('Supports overriding non-family notifiers', () { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ publicClassProvider.overrideWith(() => PublicClass('Hello world')), ], @@ -41,7 +40,7 @@ void main() { }); test('Supports overriding family notifiers', () { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ familyClassProvider(42, third: .42) .overrideWith(() => FamilyClass('Hello world')), @@ -65,7 +64,7 @@ void main() { test( 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', () { - final container = createContainer(); + final container = ProviderContainer.test(); const FamilyClassFamily family = familyClassProvider; diff --git a/packages/riverpod_generator/test/scoped_test.dart b/packages/riverpod_generator/test/scoped_test.dart index 4e64663d6..80cfa0e54 100644 --- a/packages/riverpod_generator/test/scoped_test.dart +++ b/packages/riverpod_generator/test/scoped_test.dart @@ -1,11 +1,11 @@ +import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; import 'integration/scopes.dart'; -import 'utils.dart'; void main() { test('throws UnsupportedError if accessed without an override', () { - final container = createContainer(); + final container = ProviderContainer.test(); expect( () => container.read(scopedProvider), @@ -14,7 +14,7 @@ void main() { }); test('Can be accessed without problem if the provider is overridden', () { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ scopedProvider.overrideWith((ref) => 42), ], diff --git a/packages/riverpod_generator/test/stream_notifier_test.dart b/packages/riverpod_generator/test/stream_notifier_test.dart index e69ef6d0a..283bc1dee 100644 --- a/packages/riverpod_generator/test/stream_notifier_test.dart +++ b/packages/riverpod_generator/test/stream_notifier_test.dart @@ -5,13 +5,12 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:test/test.dart'; import 'integration/stream.dart'; -import 'utils.dart'; void main() { test( 'Creates a StreamNotifierProvider if @riverpod is used on a Stream class', () async { - final container = createContainer(); + final container = ProviderContainer.test(); const ProviderBase> provider = publicClassProvider; @@ -30,7 +29,7 @@ void main() { }); test('Supports overriding non-family notifiers', () { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ publicClassProvider.overrideWith(() => PublicClass('Hello world')), ], @@ -45,7 +44,7 @@ void main() { }); test('Supports overriding family notifiers', () { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ familyClassProvider(42, third: .42) .overrideWith(() => FamilyClass('Hello world')), @@ -69,7 +68,7 @@ void main() { test( 'Creates a NotifierProvider.family if @riverpod is used on a synchronous function with parameters', () async { - final container = createContainer(); + final container = ProviderContainer.test(); const FamilyClassFamily family = familyClassProvider; diff --git a/packages/riverpod_generator/test/stream_test.dart b/packages/riverpod_generator/test/stream_test.dart index 9967aff14..8b4901f07 100644 --- a/packages/riverpod_generator/test/stream_test.dart +++ b/packages/riverpod_generator/test/stream_test.dart @@ -5,12 +5,11 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:test/test.dart'; import 'integration/stream.dart'; -import 'utils.dart'; void main() { test('Creates a StreamProvider if @riverpod is used on a Stream function', () async { - final container = createContainer(); + final container = ProviderContainer.test(); const ProviderBase> provider = publicProvider; @@ -29,7 +28,7 @@ void main() { }); test('Supports overriding non-family providers', () async { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ publicProvider.overrideWith((ref) => Stream.value('Hello world')), ], @@ -40,7 +39,7 @@ void main() { }); test('Supports overriding family providers', () async { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ familyProvider.overrideWith( (ref, args) => Stream.value( @@ -67,7 +66,7 @@ void main() { test( 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', () async { - final container = createContainer(); + final container = ProviderContainer.test(); const FamilyFamily family = familyProvider; @@ -129,7 +128,7 @@ void main() { }); test('can override providers', () { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ publicProvider.overrideWith((ref) { ref.state = const AsyncData('test'); diff --git a/packages/riverpod_generator/test/sync_test.dart b/packages/riverpod_generator/test/sync_test.dart index 1f28be855..54b17509b 100644 --- a/packages/riverpod_generator/test/sync_test.dart +++ b/packages/riverpod_generator/test/sync_test.dart @@ -1,10 +1,9 @@ // ignore_for_file: omit_local_variable_types, unused_local_variable -import 'package:riverpod/riverpod.dart' show ProviderBase; +import 'package:riverpod/riverpod.dart' show ProviderBase, ProviderContainer; import 'package:test/test.dart'; import 'integration/sync.dart'; -import 'utils.dart'; void main() { group('Supports generics', () { @@ -55,7 +54,7 @@ void main() { }); test('in simple scenarios', () { - final container = createContainer(); + final container = ProviderContainer.test(); expect( container.listen(genericProvider(), (p, n) {}).read(), @@ -73,7 +72,7 @@ void main() { }); test('Supports Raw', () async { - final container = createContainer(); + final container = ProviderContainer.test(); expect( container.read(rawFutureProvider), @@ -170,7 +169,7 @@ void main() { }); test('Supports overriding non-family providers', () { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ publicProvider.overrideWith((ref) => 'Hello world'), ], @@ -181,7 +180,7 @@ void main() { }); test('Supports overriding family providers', () { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ familyProvider.overrideWith( (ref, args) => 'Hello world ${args.$1} ${args.second} ' @@ -202,7 +201,7 @@ void main() { test( 'Creates a Provider if @riverpod is used on an stream function wrapped in Raw', () async { - final container = createContainer(); + final container = ProviderContainer.test(); const ProviderBase> provider = rawStreamProvider; final Stream result = container.read(rawStreamProvider); @@ -212,7 +211,7 @@ void main() { test('Creates a Provider if @riverpod is used on a synchronous function', () { - final container = createContainer(); + final container = ProviderContainer.test(); const ProviderBase provider = publicProvider; final String result = container.read(publicProvider); @@ -231,7 +230,7 @@ void main() { test( 'Creates a Provider.family if @riverpod is used on a synchronous function with parameters', () { - final container = createContainer(); + final container = ProviderContainer.test(); const FamilyFamily family = familyProvider; @@ -312,11 +311,10 @@ void main() { }); test('can override providers', () { - final container = createContainer( + final container = ProviderContainer.test( overrides: [ publicProvider.overrideWith((ref) => 'test'), publicClassProvider.overrideWith(() => PublicClass(42)), - // TODO test overrideWithBuild familyProvider.overrideWith( (ref, args) => 'test (first: ${args.$1}, second: ${args.second}, third: ${args.third}, fourth: ${args.fourth}, fifth: ${args.fifth})', @@ -325,6 +323,17 @@ void main() { familyClassProvider.overrideWith(FamilyClass.new), ], ); + final container2 = ProviderContainer.test( + overrides: [ + publicClassProvider.overrideWithBuild((ref, notifier) => 'Hello world'), + familyClassProvider.overrideWithBuild((ref, notifier, args) { + return 'FamilyClass$args'; + }), + familyClassProvider(21, third: .21).overrideWithBuild((ref, notifier) { + return 'Override'; + }), + ], + ); expect(container.read(publicProvider), 'test'); expect(container.read(publicClassProvider.notifier).param, 42); @@ -339,5 +348,15 @@ void main() { .param, (42, second: '42', third: 0.42, fourth: true, fifth: null), ); + + expect(container2.read(publicClassProvider), 'Hello world'); + expect( + container2.read(familyClassProvider(42, third: .42)), + 'FamilyClass(42, fifth: null, fourth: true, second: null, third: 0.42)', + ); + expect( + container2.read(familyClassProvider(21, third: .21)), + 'Override', + ); }); } diff --git a/packages/riverpod_generator/test/utils.dart b/packages/riverpod_generator/test/utils.dart deleted file mode 100644 index 57e3436da..000000000 --- a/packages/riverpod_generator/test/utils.dart +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:riverpod/riverpod.dart'; -import 'package:test/test.dart'; - -ProviderContainer createContainer({ - ProviderContainer? parent, - List overrides = const [], - List? observers, -}) { - final container = ProviderContainer( - parent: parent, - overrides: overrides, - observers: observers, - ); - addTearDown(container.dispose); - return container; -} From ad33369eb13c1c56bbc8d8701a0dd3c1a4533bfb Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 10:38:32 +0100 Subject: [PATCH 175/387] Support scoped notifiers --- .../lib/src/riverpod_element.dart | 10 +- .../lib/src/riverpod_annotation.dart | 20 ++ .../integration/build_yaml/lib/main.g.dart | 6 - .../lib/src/templates/notifier.dart | 17 +- .../test/integration/annotated.g.dart | 2 - .../test/integration/async.g.dart | 5 - .../test/integration/dependencies.g.dart | 5 - .../test/integration/dependencies2.g.dart | 2 - .../test/integration/documented.g.dart | 2 - .../test/integration/generated.g.dart | 6 - .../test/integration/hash/hash1.g.dart | 1 - .../test/integration/scopes.dart | 10 +- .../test/integration/scopes.g.dart | 197 +++++++++++++----- .../test/integration/stream.g.dart | 4 - .../test/integration/sync.g.dart | 10 - .../riverpod_generator/test/scoped_test.dart | 33 ++- 16 files changed, 224 insertions(+), 106 deletions(-) diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart index 62408ad9d..cd2b3c3c5 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart @@ -265,7 +265,15 @@ sealed class GeneratorProviderDeclarationElement /// or type parameters. bool get isFamily; - bool get isScoped => annotation.dependencies != null; + bool get isScoped { + if (annotation.dependencies != null) return true; + + // TODO changelog isScoped now supports abstract build methods + // TODO test + final that = this; + return that is ClassBasedProviderDeclarationElement && + that.buildMethod.isAbstract; + } @override bool get isAutoDispose => !annotation.keepAlive; diff --git a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart index 4086d1242..861316a7a 100644 --- a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart @@ -2,6 +2,7 @@ import 'package:meta/meta.dart'; import 'package:meta/meta_meta.dart'; +import 'package:riverpod/src/internals.dart'; import '../riverpod_annotation.dart'; @@ -101,3 +102,22 @@ class ProviderFor { /// /// {@endtemplate} typedef Raw = T; + +/// An exception thrown when a scoped provider is accessed when not yet overridden. +class MissingScopeException implements Exception { + /// An exception thrown when a scoped provider is accessed when not yet overridden. + MissingScopeException(this.ref); + + /// The [Ref] that threw the exception + final Ref ref; + + @override + String toString() { + // ignore: invalid_use_of_internal_member + final element = ref as ProviderElementBase; + + return 'MissingScopeException: The provider ${element.origin} is scoped, ' + 'but was accessed in a place where it is not overridden. ' + 'Either you forgot to override the provider, or you tried to read it outside of where it is defined'; + } +} diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 7fdbaeab2..811c9a094 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -606,7 +606,6 @@ String _$countNotifierHash() => r'a8dd7a66ee0002b8af657245c4affaa206fd99ec'; abstract class _$CountNotifier extends $Notifier { int build(); - @$internal @override int runBuild() => build(); @@ -669,7 +668,6 @@ String _$countAsyncNotifierHash() => abstract class _$CountAsyncNotifier extends $AsyncNotifier { FutureOr build(); - @$internal @override FutureOr runBuild() => build(); @@ -732,7 +730,6 @@ String _$countStreamNotifierHash() => abstract class _$CountStreamNotifier extends $StreamNotifier { Stream build(); - @$internal @override Stream runBuild() => build(); @@ -890,7 +887,6 @@ abstract class _$CountNotifier2 extends $Notifier { int build( int a, ); - @$internal @override int runBuild() => build( @@ -1046,7 +1042,6 @@ abstract class _$CountAsyncNotifier2 extends $AsyncNotifier { FutureOr build( int a, ); - @$internal @override FutureOr runBuild() => build( @@ -1202,7 +1197,6 @@ abstract class _$CountStreamNotifier2 extends $StreamNotifier { Stream build( int a, ); - @$internal @override Stream runBuild() => build( diff --git a/packages/riverpod_generator/lib/src/templates/notifier.dart b/packages/riverpod_generator/lib/src/templates/notifier.dart index e4e0452c6..e25d19d29 100644 --- a/packages/riverpod_generator/lib/src/templates/notifier.dart +++ b/packages/riverpod_generator/lib/src/templates/notifier.dart @@ -15,7 +15,6 @@ class NotifierTemplate extends Template { void run(StringBuffer buffer) { final notifierBaseName = '_\$${provider.name.lexeme.public}'; final genericsDefinition = provider.genericsDefinition(); - final buildParams = buildParamDefinitionQuery(provider.parameters); final baseClass = switch (provider.createdType) { SupportedCreatedType.future => @@ -56,13 +55,27 @@ class NotifierTemplate extends Template { abstract class $notifierBaseName$genericsDefinition extends $baseClass { ${provider.parameters.isNotEmpty ? _$args : ''} $parametersAsFields +'''); - ${provider.createdTypeDisplayString} build($buildParams); + _writeBuild(buffer); + buffer.writeln(''' @\$internal @override ${provider.createdTypeDisplayString} runBuild() => build($paramsPassThrough); } '''); } + + void _writeBuild(StringBuffer buffer) { + final buildParams = buildParamDefinitionQuery(provider.parameters); + + buffer.write('${provider.createdTypeDisplayString} build($buildParams)'); + + if (provider.buildMethod.isAbstract) { + buffer.writeln('=> throw MissingScopeException(ref);'); + } else { + buffer.writeln(';'); + } + } } diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 832122339..68926168e 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -620,7 +620,6 @@ abstract class _$ClassBased extends $Notifier { String build( @Deprecated('field') int id, ); - @$internal @override String runBuild() => build( @@ -693,7 +692,6 @@ String _$notCopiedClassBasedHash() => abstract class _$NotCopiedClassBased extends $Notifier { String build(); - @$internal @override String runBuild() => build(); diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index c966d33bc..375c2bf14 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -672,7 +672,6 @@ final class GenericClassFamily extends Family { abstract class _$GenericClass extends $AsyncNotifier> { FutureOr> build(); - @$internal @override FutureOr> runBuild() => build(); @@ -734,7 +733,6 @@ String _$publicClassHash() => r'e9bc69e44b72e8ed77d423524c0d74ad460d629d'; abstract class _$PublicClass extends $AsyncNotifier { FutureOr build(); - @$internal @override FutureOr runBuild() => build(); @@ -796,7 +794,6 @@ String _$privateClassHash() => r'7e69cffe8315999710e4cb6bb3de9f179d3f2f5d'; abstract class _$PrivateClass extends $AsyncNotifier { FutureOr build(); - @$internal @override FutureOr runBuild() => build(); @@ -949,7 +946,6 @@ abstract class _$FamilyOrClass extends $AsyncNotifier { FutureOr build( int first, ); - @$internal @override FutureOr runBuild() => build( @@ -1173,7 +1169,6 @@ abstract class _$FamilyClass extends $AsyncNotifier { bool fourth = true, List? fifth, }); - @$internal @override FutureOr runBuild() => build( diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index e63eb83df..1d387479a 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -1018,7 +1018,6 @@ String _$dep2Hash() => r'2778537df77f6431148c2ce400724da3e2ab4b94'; abstract class _$Dep2 extends $Notifier { int build(); - @$internal @override int runBuild() => build(); @@ -1175,7 +1174,6 @@ abstract class _$Family2 extends $Notifier { int build( int id, ); - @$internal @override int runBuild() => build( @@ -1261,7 +1259,6 @@ String _$provider3Hash() => r'dfdd6dec6cfee543c73d99593ce98d68f4db385c'; abstract class _$Provider3 extends $Notifier { int build(); - @$internal @override int runBuild() => build(); @@ -1433,7 +1430,6 @@ abstract class _$Provider4 extends $Notifier { int build( int id, ); - @$internal @override int runBuild() => build( @@ -1510,7 +1506,6 @@ String _$emptyDependenciesClassBasedHash() => abstract class _$EmptyDependenciesClassBased extends $Notifier { int build(); - @$internal @override int runBuild() => build(); diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 124335e8f..0d6a1fde1 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -437,7 +437,6 @@ String _$notifierWithDependenciesHash() => abstract class _$NotifierWithDependencies extends $Notifier { int build(); - @$internal @override int runBuild() => build(); @@ -619,7 +618,6 @@ abstract class _$NotifierFamilyWithDependencies extends $Notifier { int build({ int? id, }); - @$internal @override int runBuild() => build( diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index 4cd8c3faa..8b6968ca7 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -285,7 +285,6 @@ String _$classBasedHash() => r'f1139017b1fcf38017402b514c61fb32dae40c39'; abstract class _$ClassBased extends $Notifier { String build(); - @$internal @override String runBuild() => build(); @@ -457,7 +456,6 @@ abstract class _$ClassFamilyBased extends $Notifier { String build( int id, ); - @$internal @override String runBuild() => build( diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 0504cfed0..7b74138f7 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -774,7 +774,6 @@ String _$generatedClassHash() => r'984153f97e25de687d2f19756b277aabd56f6e72'; abstract class _$GeneratedClass extends $Notifier<_Test> { _Test build(); - @$internal @override _Test runBuild() => build(); @@ -936,7 +935,6 @@ abstract class _$GeneratedClassFamily extends $Notifier<_Test> { _Test build( _Test test, ); - @$internal @override _Test runBuild() => build( @@ -1008,7 +1006,6 @@ String _$$dynamicClassHash() => r'c6d8e5191c3f060df3ce3eee66107433fd4c3292'; abstract class _$$DynamicClass extends $Notifier { Object? build(); - @$internal @override Object? runBuild() => build(); @@ -1170,7 +1167,6 @@ abstract class _$$DynamicClassFamily extends $Notifier { Object? build( dynamic test, ); - @$internal @override Object? runBuild() => build( @@ -1242,7 +1238,6 @@ String _$aliasClassHash() => r'a6c6d7594ebd09ba728e42d79b12af560d09c379'; abstract class _$AliasClass extends $Notifier> { r.AsyncValue build(); - @$internal @override r.AsyncValue runBuild() => build(); @@ -1403,7 +1398,6 @@ abstract class _$AliasClassFamily extends $Notifier> { r.AsyncValue build( r.AsyncValue test, ); - @$internal @override r.AsyncValue runBuild() => build( diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index dd8129083..349f3c5f4 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -187,7 +187,6 @@ String _$simpleClassHash() => r'958123cd6179c5b88da040cfeb71eb3061765277'; abstract class _$SimpleClass extends $Notifier { String build(); - @$internal @override String runBuild() => build(); diff --git a/packages/riverpod_generator/test/integration/scopes.dart b/packages/riverpod_generator/test/integration/scopes.dart index d1b29e563..0669c2bdf 100644 --- a/packages/riverpod_generator/test/integration/scopes.dart +++ b/packages/riverpod_generator/test/integration/scopes.dart @@ -2,11 +2,15 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'scopes.g.dart'; -@riverpod -external int scoped(); - // TODO changelog added support for abstract build method. @riverpod class ScopedClass extends _$ScopedClass { + @override int build(); } + +@riverpod +class ScopedClassFamily extends _$ScopedClassFamily { + @override + int build(int a); +} diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 04c3f4feb..c7110ca8d 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -6,33 +6,26 @@ part of 'scopes.dart'; // RiverpodGenerator // ************************************************************************** -typedef ScopedRef = Ref; - -@ProviderFor(scoped) -const scopedProvider = ScopedProvider._(); +@ProviderFor(ScopedClass) +const scopedClassProvider = ScopedClassProvider._(); -final class ScopedProvider extends $FunctionalProvider - with $Provider { - const ScopedProvider._( - {int Function( - ScopedRef ref, - )? create}) +final class ScopedClassProvider extends $NotifierProvider { + const ScopedClassProvider._( + {super.runNotifierBuildOverride, ScopedClass Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'scopedProvider', + name: r'scopedClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final int Function( - ScopedRef ref, - )? _createCb; + final ScopedClass Function()? _createCb; @override - String debugGetCreateSourceHash() => _$scopedHash(); + String debugGetCreateSourceHash() => _$scopedClassHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -42,48 +35,74 @@ final class ScopedProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => - $ProviderElement(this, container); + ScopedClass create() => _createCb?.call() ?? ScopedClass(); + @$internal @override - ScopedProvider $copyWithCreate( - int Function( - ScopedRef ref, - ) create, + ScopedClassProvider $copyWithCreate( + ScopedClass Function() create, ) { - return ScopedProvider._(create: create); + return ScopedClassProvider._(create: create); } + @$internal @override - int create(ScopedRef ref) { - final fn = _createCb ?? scoped; - return fn(ref); + ScopedClassProvider $copyWithBuild( + int Function( + Ref, + ScopedClass, + ) build, + ) { + return ScopedClassProvider._(runNotifierBuildOverride: build); } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -String _$scopedHash() => r'590f1a203323105e732397a2616fbd7dac65f0cc'; +String _$scopedClassHash() => r'113acc46a2e61abfeb61cf4b89a1dc555e915793'; -@ProviderFor(ScopedClass) -const scopedClassProvider = ScopedClassProvider._(); +abstract class _$ScopedClass extends $Notifier { + int build() => throw MissingScopeException(ref); + @$internal + @override + int runBuild() => build(); +} -final class ScopedClassProvider extends $NotifierProvider { - const ScopedClassProvider._( - {super.runNotifierBuildOverride, ScopedClass Function()? create}) +@ProviderFor(ScopedClassFamily) +const scopedClassFamilyProvider = ScopedClassFamilyFamily._(); + +final class ScopedClassFamilyProvider + extends $NotifierProvider { + const ScopedClassFamilyProvider._( + {required ScopedClassFamilyFamily super.from, + required int super.argument, + super.runNotifierBuildOverride, + ScopedClassFamily Function()? create}) : _createCb = create, super( - from: null, - argument: null, - name: r'scopedClassProvider', + name: r'scopedClassFamilyProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final ScopedClass Function()? _createCb; + final ScopedClassFamily Function()? _createCb; @override - String debugGetCreateSourceHash() => _$scopedClassHash(); + String debugGetCreateSourceHash() => _$scopedClassFamilyHash(); + + @override + String toString() { + return r'scopedClassFamilyProvider' + '' + '($argument)'; + } /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -95,42 +114,124 @@ final class ScopedClassProvider extends $NotifierProvider { @$internal @override - ScopedClass create() => _createCb?.call() ?? ScopedClass(); + ScopedClassFamily create() => _createCb?.call() ?? ScopedClassFamily(); @$internal @override - ScopedClassProvider $copyWithCreate( - ScopedClass Function() create, + ScopedClassFamilyProvider $copyWithCreate( + ScopedClassFamily Function() create, ) { - return ScopedClassProvider._(create: create); + return ScopedClassFamilyProvider._( + argument: argument as int, + from: from! as ScopedClassFamilyFamily, + create: create); } @$internal @override - ScopedClassProvider $copyWithBuild( + ScopedClassFamilyProvider $copyWithBuild( int Function( Ref, - ScopedClass, + ScopedClassFamily, ) build, ) { - return ScopedClassProvider._(runNotifierBuildOverride: build); + return ScopedClassFamilyProvider._( + argument: argument as int, + from: from! as ScopedClassFamilyFamily, + runNotifierBuildOverride: build); } @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement createElement( ProviderContainer container) => $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is ScopedClassFamilyProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } } -String _$scopedClassHash() => r'12c0c3f2bbda7eaeaaf1c30cb6398f056f801647'; +String _$scopedClassFamilyHash() => r'04aeb0bbfdc363e2c8714c7a5967368a7f990d58'; -abstract class _$ScopedClass extends $Notifier { - int build(); +final class ScopedClassFamilyFamily extends Family { + const ScopedClassFamilyFamily._() + : super( + name: r'scopedClassFamilyProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + ScopedClassFamilyProvider call( + int a, + ) => + ScopedClassFamilyProvider._(argument: a, from: this); + + @override + String debugGetCreateSourceHash() => _$scopedClassFamilyHash(); + + @override + String toString() => r'scopedClassFamilyProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + ScopedClassFamily Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ScopedClassFamilyProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + int Function(Ref ref, ScopedClassFamily notifier, int argument) build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ScopedClassFamilyProvider; + + final argument = provider.argument as int; + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } +} + +abstract class _$ScopedClassFamily extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + int get a => _$args; + + int build( + int a, + ) => + throw MissingScopeException(ref); @$internal @override - int runBuild() => build(); + int runBuild() => build( + _$args, + ); } const $kDebugMode = bool.fromEnvironment('dart.vm.product'); diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index ab390e60a..c292a5908 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -549,7 +549,6 @@ final class GenericClassFamily extends Family { abstract class _$GenericClass extends $StreamNotifier> { Stream> build(); - @$internal @override Stream> runBuild() => build(); @@ -611,7 +610,6 @@ String _$publicClassHash() => r'b1526943c8ff0aaa20642bf78e744e5833cf9d02'; abstract class _$PublicClass extends $StreamNotifier { Stream build(); - @$internal @override Stream runBuild() => build(); @@ -673,7 +671,6 @@ String _$privateClassHash() => r'8c0d52b7ab79c0546d0c84c011bb3512609e029e'; abstract class _$PrivateClass extends $StreamNotifier { Stream build(); - @$internal @override Stream runBuild() => build(); @@ -895,7 +892,6 @@ abstract class _$FamilyClass extends $StreamNotifier { bool fourth = true, List? fifth, }); - @$internal @override Stream runBuild() => build( diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index ee8e62581..96d5b7453 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -1596,7 +1596,6 @@ final class GenericClassFamily extends Family { abstract class _$GenericClass extends $Notifier> { List build(); - @$internal @override List runBuild() => build(); @@ -1666,7 +1665,6 @@ String _$rawFutureClassHash() => r'bf66f1cdbd99118b8845d206e6a2611b3101f45c'; abstract class _$RawFutureClass extends $Notifier>> { Raw> build(); - @$internal @override Raw> runBuild() => build(); @@ -1736,7 +1734,6 @@ String _$rawStreamClassHash() => r'712cffcb2018cfb4ff45012c1aa6e43c8cbe9d5d'; abstract class _$RawStreamClass extends $Notifier>> { Raw> build(); - @$internal @override Raw> runBuild() => build(); @@ -1897,7 +1894,6 @@ abstract class _$RawFamilyFutureClass extends $Notifier>> { Raw> build( int id, ); - @$internal @override Raw> runBuild() => build( @@ -2060,7 +2056,6 @@ abstract class _$RawFamilyStreamClass extends $Notifier>> { Raw> build( int id, ); - @$internal @override Raw> runBuild() => build( @@ -2134,7 +2129,6 @@ String _$publicClassHash() => r'c8e7eec9e202acf8394e02496857cbe49405bf62'; abstract class _$PublicClass extends $Notifier { String build(); - @$internal @override String runBuild() => build(); @@ -2204,7 +2198,6 @@ String _$privateClassHash() => r'6d41def3ffdc1f79e593beaefb3304ce4b211a77'; abstract class _$PrivateClass extends $Notifier { String build(); - @$internal @override String runBuild() => build(); @@ -2437,7 +2430,6 @@ abstract class _$FamilyClass extends $Notifier { bool fourth = true, List? fifth, }); - @$internal @override String runBuild() => build( @@ -2605,7 +2597,6 @@ final class Supports$InClassNameFamily extends Family { abstract class _$Supports$InClassName extends $Notifier { String build(); - @$internal @override String runBuild() => build(); @@ -2843,7 +2834,6 @@ abstract class _$Supports$InClassFamilyName extends $Notifier { required And$InT named$arg, String defaultArg = default$value, }); - @$internal @override String runBuild() => build( diff --git a/packages/riverpod_generator/test/scoped_test.dart b/packages/riverpod_generator/test/scoped_test.dart index 80cfa0e54..6706a9699 100644 --- a/packages/riverpod_generator/test/scoped_test.dart +++ b/packages/riverpod_generator/test/scoped_test.dart @@ -1,4 +1,4 @@ -import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:test/test.dart'; import 'integration/scopes.dart'; @@ -8,18 +8,33 @@ void main() { final container = ProviderContainer.test(); expect( - () => container.read(scopedProvider), - throwsUnsupportedError, + () => container.read(scopedClassProvider), + throwsA( + isA().having( + (e) => e.toString(), + 'toString', + startsWith( + 'MissingScopeException: The provider scopedClassProvider is scoped, ', + ), + ), + ), ); }); test('Can be accessed without problem if the provider is overridden', () { - final container = ProviderContainer.test( - overrides: [ - scopedProvider.overrideWith((ref) => 42), - ], - ); + final container = ProviderContainer.test(); - expect(container.read(scopedProvider), 42); + expect( + () => container.read(scopedClassFamilyProvider(42)), + throwsA( + isA().having( + (e) => e.toString(), + 'toString', + startsWith( + 'MissingScopeException: The provider scopedClassFamilyProvider(42) is scoped, ', + ), + ), + ), + ); }); } From ed0020b6e0fcce2a2f729d734213db9ebd3a8fe2 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 10:45:22 +0100 Subject: [PATCH 176/387] Update generated files --- examples/counter/lib/main.g.dart | 92 +- .../marvel/lib/src/configuration.freezed.dart | 2 +- examples/marvel/lib/src/marvel.freezed.dart | 2 +- examples/marvel/lib/src/result.freezed.dart | 2 +- .../marvel/lib/src/screens/home.freezed.dart | 2 +- examples/pub/lib/detail.g.dart | 629 ++--- examples/pub/lib/pub_repository.freezed.dart | 2 +- examples/pub/lib/search.g.dart | 297 +- .../stackoverflow/lib/question.freezed.dart | 2 +- examples/stackoverflow/lib/tag.freezed.dart | 2 +- examples/stackoverflow/lib/user.freezed.dart | 2 +- .../riverpod/example/lib/models.freezed.dart | 2 +- .../lib/src/riverpod_annotation.dart | 6 +- .../consumer_widget/golden/lib/main.dart | 1 + .../generated/golden/lib/sync.dart | 4 +- .../generated/golden/lib/sync.g.dart | 1197 ++++---- .../pubspec_overrides.yaml | 1 + ..._class_based_provider_to_functional.g.dart | 627 ++--- ..._functional_provider_to_class_based.g.dart | 346 ++- .../test/lints/another.g.dart | 71 +- .../avoid_build_context_in_providers.g.dart | 655 +++-- .../avoid_public_notifier_properties.g.dart | 276 +- .../test/lints/dependencies.g.dart | 2452 ++++++++++++----- .../functional_ref/functional_ref.g.dart | 896 +++--- .../notifier_extends/notifier_extends.g.dart | 1169 ++++---- .../protected_notifier_properties.g.dart | 1656 +++++------ .../provider_dependencies.g.dart | 887 ++++-- .../lints/provider_parameters.freezed.dart | 2 +- .../test/lints/provider_parameters.g.dart | 249 +- ...oviders_should_specify_dependencies.g.dart | 212 +- .../lints/unsupported_provider_value.g.dart | 1550 +++++++++-- .../advanced/select/select/codegen.g.dart | 71 +- .../select/select_async/codegen.g.dart | 72 +- .../cancel/detail_screen/codegen.freezed.dart | 2 +- .../cancel/detail_screen/codegen.g.dart | 64 +- .../detail_screen_cancel/codegen.g.dart | 64 +- .../detail_screen_debounce/codegen.g.dart | 64 +- .../provider_with_extension/codegen.g.dart | 64 +- .../activity/codegen.freezed.dart | 2 +- .../fetch_activity/codegen.g.dart | 64 +- .../full_app/codegen.freezed.dart | 2 +- .../pull_to_refresh/full_app/codegen.g.dart | 64 +- .../docs/concepts/about_codegen/main.g.dart | 246 +- .../provider_type/async_class_future.g.dart | 74 +- .../provider_type/async_class_stream.g.dart | 74 +- .../provider_type/async_fn_future.g.dart | 64 +- .../provider_type/async_fn_stream.g.dart | 64 +- .../provider_type/auto_dispose.g.dart | 141 +- .../about_codegen/provider_type/family.g.dart | 248 +- .../provider_type/family_class.g.dart | 345 +-- .../provider_type/family_fn.g.dart | 296 +- .../provider_type/sync_class.g.dart | 81 +- .../provider_type/sync_fn.g.dart | 72 +- .../characters_provider/codegen.g.dart | 131 +- .../city_provider/codegen.g.dart | 71 +- .../codegen.g.dart | 73 +- .../read_in_provider/codegen.g.dart | 140 +- .../select_async_provider/codegen.g.dart | 131 +- .../todo_list_provider/codegen.freezed.dart | 2 +- .../todo_list_provider/codegen.g.dart | 82 +- .../weather_provider/codegen.g.dart | 132 +- .../whole_object_provider/codegen.g.dart | 131 +- .../lifecycle_on_dispose/codegen.g.dart | 64 +- .../creating_a_provider/codegen.g.dart | 71 +- .../declaring_many_providers/codegen.g.dart | 140 +- .../concepts/reading/counter/codegen.g.dart | 81 +- .../concepts/reading/listen/codegen.g.dart | 71 +- .../reading/listen_build/codegen.g.dart | 81 +- .../reading/listen_build/codegen_hooks.g.dart | 81 +- .../concepts/reading/provider/codegen.g.dart | 140 +- .../docs/concepts/reading/read/codegen.g.dart | 81 +- .../reading/read/codegen_hooks.g.dart | 81 +- .../reading/read_build/codegen.g.dart | 81 +- .../read_notifier_build/codegen.g.dart | 81 +- .../concepts/reading/watch/codegen.g.dart | 220 +- .../reading/watch_build/codegen.g.dart | 150 +- .../reading/watch_build/codegen_hooks.g.dart | 150 +- .../watch_notifier_build/codegen.g.dart | 81 +- .../why_immutability/codegen.freezed.dart | 2 +- .../concepts/why_immutability/codegen.g.dart | 84 +- .../cache_for_usage/codegen.g.dart | 64 +- .../auto_dispose/codegen_keep_alive.g.dart | 71 +- .../invalidate_family_example/codegen.g.dart | 247 +- .../auto_dispose/keep_alive/codegen.g.dart | 64 +- .../on_dispose_example/codegen.g.dart | 132 +- .../functional_ref/codegen.g.dart | 139 +- .../listen_example/codegen.g.dart | 71 +- .../notifier_ref/codegen.g.dart | 149 +- .../read_example/codegen.g.dart | 82 +- .../watch_example/codegen.g.dart | 137 +- .../watch_placement/codegen.g.dart | 150 +- .../require_value/codegen.g.dart | 64 +- .../codegen/activity.freezed.dart | 2 +- .../first_request/codegen/provider.g.dart | 71 +- .../passing_args/codegen/family.g.dart | 242 +- .../passing_args/codegen/provider.g.dart | 318 +-- .../codegen/todo_list_notifier.freezed.dart | 2 +- .../codegen/todo_list_notifier.g.dart | 75 +- .../todo_list_notifier_add_todo.g.dart | 75 +- .../codegen/todo_list_provider.freezed.dart | 2 +- .../codegen/todo_list_provider.g.dart | 65 +- .../testing/notifier_mock/codegen.g.dart | 82 +- .../testing/provider_to_mock/codegen.g.dart | 64 +- .../pipe_change_notifier.g.dart | 81 +- .../websockets_sync/raw_usage.g.dart | 74 +- .../shared_pipe_change_notifier.g.dart | 146 +- .../stream_provider/codegen.g.dart | 65 +- .../sync_definition/codegen.g.dart | 73 +- .../docs/from_provider/family/family.g.dart | 291 +- .../from_provider/helpers/item.freezed.dart | 2 +- .../async_values/async_values.g.dart | 134 +- .../auto_dispose/auto_dispose.g.dart | 141 +- .../motivation/combine/combine.g.dart | 139 +- .../motivation/same_type/same_type.g.dart | 141 +- .../dart_hello_world/main.g.dart | 72 +- .../hello_world/hooks_codegen/main.g.dart | 72 +- .../getting_started/hello_world/main.g.dart | 72 +- .../introduction/why_riverpod/codegen.g.dart | 297 +- .../declaration/declaration.g.dart | 75 +- .../initialization/initialization.g.dart | 75 +- .../migrated/migrated.g.dart | 75 +- .../add_listener/add_listener.g.dart | 82 +- .../async_notifier/async_notifier.g.dart | 76 +- .../build_init/build_init.g.dart | 84 +- .../family_and_dispose.g.dart | 277 +- .../from_state_provider.g.dart | 84 +- .../old_lifecycles/old_lifecycles.g.dart | 82 +- .../old_lifecycles_final.g.dart | 82 +- .../config_provider/codegen.g.dart | 71 +- .../remote_todos/codegen.freezed.dart | 2 +- .../remote_todos/codegen.g.dart | 75 +- .../todos/codegen.freezed.dart | 2 +- .../notifier_provider/todos/codegen.g.dart | 81 +- .../completed_todos/completed_todos.g.dart | 73 +- .../optimized_previous_button.g.dart | 151 +- .../docs/providers/provider/todo/todo.g.dart | 81 +- .../unoptimized_previous_button.g.dart | 81 +- .../live_stream_chat_provider/codegen.g.dart | 65 +- .../current/about_codegen/main.g.dart | 246 +- .../dart_hello_world/main.g.dart | 72 +- .../getting_started/hello_world/main.g.dart | 72 +- .../remote_todos/codegen.freezed.dart | 2 +- .../remote_todos/codegen.g.dart | 75 +- .../todos/codegen.freezed.dart | 2 +- .../notifier_provider/todos/codegen.g.dart | 81 +- .../current/about_codegen/main.g.dart | 246 +- .../dart_hello_world/main.g.dart | 72 +- .../getting_started/hello_world/main.g.dart | 72 +- .../current/about_codegen/main.g.dart | 246 +- .../dart_hello_world/main.g.dart | 72 +- .../getting_started/hello_world/main.g.dart | 72 +- .../config_provider/codegen.g.dart | 71 +- .../current/about_codegen/main.g.dart | 246 +- .../lifecycle_on_dispose/codegen.g.dart | 64 +- .../concepts/reading/counter/codegen.g.dart | 81 +- .../concepts/reading/listen/codegen.g.dart | 71 +- .../reading/listen_build/codegen.g.dart | 81 +- .../concepts/reading/provider/codegen.g.dart | 140 +- .../concepts/reading/read/codegen.g.dart | 81 +- .../reading/read_build/codegen.g.dart | 81 +- .../read_notifier_build/codegen.g.dart | 81 +- .../concepts/reading/watch/codegen.g.dart | 220 +- .../reading/watch_build/codegen.g.dart | 150 +- .../watch_notifier_build/codegen.g.dart | 81 +- .../dart_hello_world/main.g.dart | 72 +- .../getting_started/hello_world/main.g.dart | 72 +- .../hello_world/main_hooks.g.dart | 72 +- .../config_provider/codegen.g.dart | 71 +- .../remote_todos/codegen.freezed.dart | 2 +- .../remote_todos/codegen.g.dart | 75 +- .../todos/codegen.freezed.dart | 2 +- .../notifier_provider/todos/codegen.g.dart | 81 +- .../completed_todos/completed_todos.g.dart | 73 +- .../optimized_previous_button.g.dart | 151 +- .../providers/provider/todo/todo.g.dart | 81 +- .../unoptimized_previous_button.g.dart | 81 +- website/static/snippets/async.g.dart | 69 +- website/static/snippets/combine.g.dart | 73 +- website/static/snippets/create.g.dart | 65 +- website/static/snippets/declare.g.dart | 81 +- 180 files changed, 18470 insertions(+), 9435 deletions(-) diff --git a/examples/counter/lib/main.g.dart b/examples/counter/lib/main.g.dart index deb83f61c..b0615e05c 100644 --- a/examples/counter/lib/main.g.dart +++ b/examples/counter/lib/main.g.dart @@ -6,24 +6,86 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$counterHash() => r'4243b34530f53accfd9014a9f0e316fe304ada3e'; - /// Annotating a class by `@riverpod` defines a new shared state for your application, /// accessible using the generated [counterProvider]. /// This class is both responsible for initializing the state (through the [build] method) /// and exposing ways to modify it (cf [increment]). -/// -/// Copied from [Counter]. @ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +const counterProvider = CounterProvider._(); + +/// Annotating a class by `@riverpod` defines a new shared state for your application, +/// accessible using the generated [counterProvider]. +/// This class is both responsible for initializing the state (through the [build] method) +/// and exposing ways to modify it (cf [increment]). +final class CounterProvider extends $NotifierProvider { + /// Annotating a class by `@riverpod` defines a new shared state for your application, + /// accessible using the generated [counterProvider]. + /// This class is both responsible for initializing the state (through the [build] method) + /// and exposing ways to modify it (cf [increment]). + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterHash() => r'4243b34530f53accfd9014a9f0e316fe304ada3e'; + +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/examples/marvel/lib/src/configuration.freezed.dart b/examples/marvel/lib/src/configuration.freezed.dart index 6ae5361b4..3bc79273e 100644 --- a/examples/marvel/lib/src/configuration.freezed.dart +++ b/examples/marvel/lib/src/configuration.freezed.dart @@ -12,7 +12,7 @@ part of 'configuration.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Configuration _$ConfigurationFromJson(Map json) { return _Configuration.fromJson(json); diff --git a/examples/marvel/lib/src/marvel.freezed.dart b/examples/marvel/lib/src/marvel.freezed.dart index 236aca293..c3950b0c2 100644 --- a/examples/marvel/lib/src/marvel.freezed.dart +++ b/examples/marvel/lib/src/marvel.freezed.dart @@ -12,7 +12,7 @@ part of 'marvel.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$MarvelListCharactersResponse { diff --git a/examples/marvel/lib/src/result.freezed.dart b/examples/marvel/lib/src/result.freezed.dart index daaf92469..ea52cc1de 100644 --- a/examples/marvel/lib/src/result.freezed.dart +++ b/examples/marvel/lib/src/result.freezed.dart @@ -12,7 +12,7 @@ part of 'result.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$Result { diff --git a/examples/marvel/lib/src/screens/home.freezed.dart b/examples/marvel/lib/src/screens/home.freezed.dart index a0f9e8ea9..93450e7ed 100644 --- a/examples/marvel/lib/src/screens/home.freezed.dart +++ b/examples/marvel/lib/src/screens/home.freezed.dart @@ -12,7 +12,7 @@ part of 'home.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$CharacterPagination { diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 240845577..aafa38054 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -8,455 +8,426 @@ part of 'detail.dart'; // RiverpodGenerator // ************************************************************************** -String _$fetchPackageDetailsHash() => - r'e65ba332cb8397cc5a1aca6e656233dff698391a'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); +typedef FetchPackageDetailsRef = Ref>; - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [fetchPackageDetails]. @ProviderFor(fetchPackageDetails) -const fetchPackageDetailsProvider = FetchPackageDetailsFamily(); - -/// See also [fetchPackageDetails]. -class FetchPackageDetailsFamily extends Family { - /// See also [fetchPackageDetails]. - const FetchPackageDetailsFamily(); +const fetchPackageDetailsProvider = FetchPackageDetailsFamily._(); + +final class FetchPackageDetailsProvider extends $FunctionalProvider< + AsyncValue, FutureOr, FetchPackageDetailsRef> + with + $FutureModifier, + $FutureProvider { + const FetchPackageDetailsProvider._( + {required FetchPackageDetailsFamily super.from, + required String super.argument, + FutureOr Function( + FetchPackageDetailsRef ref, { + required String packageName, + })? create}) + : _createCb = create, + super( + name: r'fetchPackageDetailsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - static const Iterable? _dependencies = null; + final FutureOr Function( + FetchPackageDetailsRef ref, { + required String packageName, + })? _createCb; - static const Iterable? _allTransitiveDependencies = null; + @override + String debugGetCreateSourceHash() => _$fetchPackageDetailsHash(); @override - Iterable? get dependencies => _dependencies; + String toString() { + return r'fetchPackageDetailsProvider' + '' + '($argument)'; + } @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); @override - String? get name => r'fetchPackageDetailsProvider'; + FetchPackageDetailsProvider $copyWithCreate( + FutureOr Function( + FetchPackageDetailsRef ref, + ) create, + ) { + return FetchPackageDetailsProvider._( + argument: argument as String, + from: from! as FetchPackageDetailsFamily, + create: ( + ref, { + required String packageName, + }) => + create(ref)); + } - /// See also [fetchPackageDetails]. - FetchPackageDetailsProvider call({ - required String packageName, - }) { - return FetchPackageDetailsProvider( - packageName: packageName, + @override + FutureOr create(FetchPackageDetailsRef ref) { + final fn = _createCb ?? fetchPackageDetails; + final String argument = this.argument as String; + return fn( + ref, + packageName: argument, ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith( - FutureOr Function(FetchPackageDetailsRef ref) create) { - return _$FetchPackageDetailsFamilyOverride(this, create); + @override + bool operator ==(Object other) { + return other is FetchPackageDetailsProvider && other.argument == argument; } @override - String toString() => 'fetchPackageDetailsProvider'; + int get hashCode { + return argument.hashCode; + } } -class _$FetchPackageDetailsFamilyOverride implements $FamilyOverride { - _$FetchPackageDetailsFamilyOverride(this.from, this.create); +String _$fetchPackageDetailsHash() => + r'e65ba332cb8397cc5a1aca6e656233dff698391a'; - final FutureOr Function(FetchPackageDetailsRef ref) create; +final class FetchPackageDetailsFamily extends Family { + const FetchPackageDetailsFamily._() + : super( + name: r'fetchPackageDetailsProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + FetchPackageDetailsProvider call({ + required String packageName, + }) => + FetchPackageDetailsProvider._(argument: packageName, from: this); @override - final FetchPackageDetailsFamily from; + String debugGetCreateSourceHash() => _$fetchPackageDetailsHash(); @override - _FetchPackageDetailsProviderElement createElement( - ProviderContainer container, - covariant FetchPackageDetailsProvider provider, + String toString() => r'fetchPackageDetailsProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr Function( + FetchPackageDetailsRef ref, + String args, + ) create, ) { - return provider._copyWith(create).createElement(container); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FetchPackageDetailsProvider; - @override - String toString() => 'fetchPackageDetailsProvider.overrideWith(...)'; + final argument = provider.argument as String; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } -/// See also [fetchPackageDetails]. -class FetchPackageDetailsProvider extends AutoDisposeFutureProvider { - /// See also [fetchPackageDetails]. - FetchPackageDetailsProvider({ - required String packageName, - }) : this._internal( - (ref) => fetchPackageDetails( - ref as FetchPackageDetailsRef, - packageName: packageName, - ), - from: fetchPackageDetailsProvider, - name: r'fetchPackageDetailsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$fetchPackageDetailsHash, +typedef LikedPackagesRef = Ref>>; + +@ProviderFor(likedPackages) +const likedPackagesProvider = LikedPackagesProvider._(); + +final class LikedPackagesProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, LikedPackagesRef> + with + $FutureModifier>, + $FutureProvider, LikedPackagesRef> { + const LikedPackagesProvider._( + {FutureOr> Function( + LikedPackagesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'likedPackagesProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - packageName: packageName, ); - FetchPackageDetailsProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.packageName, - }) : super.internal(); - - final String packageName; + final FutureOr> Function( + LikedPackagesRef ref, + )? _createCb; @override - Override overrideWith( - FutureOr Function(FetchPackageDetailsRef ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: FetchPackageDetailsProvider._internal( - (ref) => create(ref as FetchPackageDetailsRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - packageName: packageName, - ), - ); - } + String debugGetCreateSourceHash() => _$likedPackagesHash(); @override - ({ - String packageName, - }) get argument { - return (packageName: packageName,); - } + $FutureProviderElement> createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); @override - _FetchPackageDetailsProviderElement createElement( - ProviderContainer container, + LikedPackagesProvider $copyWithCreate( + FutureOr> Function( + LikedPackagesRef ref, + ) create, ) { - return _FetchPackageDetailsProviderElement(this, container); - } - - FetchPackageDetailsProvider _copyWith( - FutureOr Function(FetchPackageDetailsRef ref) create, - ) { - return FetchPackageDetailsProvider._internal( - (ref) => create(ref as FetchPackageDetailsRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - packageName: packageName, - ); + return LikedPackagesProvider._(create: create); } @override - bool operator ==(Object other) { - return other is FetchPackageDetailsProvider && - other.packageName == packageName; + FutureOr> create(LikedPackagesRef ref) { + final fn = _createCb ?? likedPackages; + return fn(ref); } +} + +String _$likedPackagesHash() => r'304a4def167e245812638cba776e8d5eb66d8844'; + +typedef PubRepositoryRef = Ref; + +@ProviderFor(pubRepository) +const pubRepositoryProvider = PubRepositoryProvider._(); + +final class PubRepositoryProvider + extends $FunctionalProvider + with $Provider { + const PubRepositoryProvider._( + {PubRepository Function( + PubRepositoryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'pubRepositoryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final PubRepository Function( + PubRepositoryRef ref, + )? _createCb; @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, packageName.hashCode); + String debugGetCreateSourceHash() => _$pubRepositoryHash(); - return _SystemHash.finish(hash); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(PubRepository value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); } @override - String toString() => 'fetchPackageDetailsProvider$argument'; -} - -mixin FetchPackageDetailsRef on AutoDisposeFutureProviderRef { - /// The parameter `packageName` of this provider. - String get packageName; -} + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); -class _FetchPackageDetailsProviderElement - extends AutoDisposeFutureProviderElement - with FetchPackageDetailsRef { - _FetchPackageDetailsProviderElement(super.provider, super.container); + @override + PubRepositoryProvider $copyWithCreate( + PubRepository Function( + PubRepositoryRef ref, + ) create, + ) { + return PubRepositoryProvider._(create: create); + } @override - String get packageName => (origin as FetchPackageDetailsProvider).packageName; + PubRepository create(PubRepositoryRef ref) { + final fn = _createCb ?? pubRepository; + return fn(ref); + } } -String _$likedPackagesHash() => r'304a4def167e245812638cba776e8d5eb66d8844'; - -/// See also [likedPackages]. -@ProviderFor(likedPackages) -final likedPackagesProvider = AutoDisposeFutureProvider>.internal( - likedPackages, - name: r'likedPackagesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$likedPackagesHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef LikedPackagesRef = AutoDisposeFutureProviderRef>; String _$pubRepositoryHash() => r'1f4dbfa0911f6467067fab244677acbcb8c7ad4e'; -/// See also [pubRepository]. -@ProviderFor(pubRepository) -final pubRepositoryProvider = AutoDisposeProvider.internal( - pubRepository, - name: r'pubRepositoryProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$pubRepositoryHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef PubRepositoryRef = AutoDisposeProviderRef; -String _$packageMetricsHash() => r'67cd25e50357e6e970d432c1d255085a23b856ac'; - -abstract class _$PackageMetrics - extends BuildlessAutoDisposeAsyncNotifier { - late final String packageName; - - FutureOr build({ - required String packageName, - }); -} - /// A provider that fetches the likes count, popularity score and pub points /// for a given package. /// /// It also exposes utilities to like/unlike a package, assuming the user /// is logged-in. -/// -/// Copied from [PackageMetrics]. @ProviderFor(PackageMetrics) -const packageMetricsProvider = PackageMetricsFamily(); +const packageMetricsProvider = PackageMetricsFamily._(); /// A provider that fetches the likes count, popularity score and pub points /// for a given package. /// /// It also exposes utilities to like/unlike a package, assuming the user /// is logged-in. -/// -/// Copied from [PackageMetrics]. -class PackageMetricsFamily extends Family { +final class PackageMetricsProvider + extends $AsyncNotifierProvider { /// A provider that fetches the likes count, popularity score and pub points /// for a given package. /// /// It also exposes utilities to like/unlike a package, assuming the user /// is logged-in. - /// - /// Copied from [PackageMetrics]. - const PackageMetricsFamily(); - - static const Iterable? _dependencies = null; + const PackageMetricsProvider._( + {required PackageMetricsFamily super.from, + required String super.argument, + super.runNotifierBuildOverride, + PackageMetrics Function()? create}) + : _createCb = create, + super( + name: r'packageMetricsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - static const Iterable? _allTransitiveDependencies = null; + final PackageMetrics Function()? _createCb; @override - Iterable? get dependencies => _dependencies; + String debugGetCreateSourceHash() => _$packageMetricsHash(); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String toString() { + return r'packageMetricsProvider' + '' + '($argument)'; + } + @$internal @override - String? get name => r'packageMetricsProvider'; + PackageMetrics create() => _createCb?.call() ?? PackageMetrics(); - /// A provider that fetches the likes count, popularity score and pub points - /// for a given package. - /// - /// It also exposes utilities to like/unlike a package, assuming the user - /// is logged-in. - /// - /// Copied from [PackageMetrics]. - PackageMetricsProvider call({ - required String packageName, - }) { - return PackageMetricsProvider( - packageName: packageName, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(PackageMetrics Function() create) { - return _$PackageMetricsFamilyOverride(this, create); + @$internal + @override + PackageMetricsProvider $copyWithCreate( + PackageMetrics Function() create, + ) { + return PackageMetricsProvider._( + argument: argument as String, + from: from! as PackageMetricsFamily, + create: create); } + @$internal @override - String toString() => 'packageMetricsProvider'; -} - -class _$PackageMetricsFamilyOverride implements $FamilyOverride { - _$PackageMetricsFamilyOverride(this.from, this.create); - - final PackageMetrics Function() create; + PackageMetricsProvider $copyWithBuild( + FutureOr Function( + Ref>, + PackageMetrics, + ) build, + ) { + return PackageMetricsProvider._( + argument: argument as String, + from: from! as PackageMetricsFamily, + runNotifierBuildOverride: build); + } + @$internal @override - final PackageMetricsFamily from; + $AsyncNotifierProviderElement + createElement(ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); @override - _PackageMetricsProviderElement createElement( - ProviderContainer container, - covariant PackageMetricsProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is PackageMetricsProvider && other.argument == argument; } @override - String toString() => 'packageMetricsProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } +String _$packageMetricsHash() => r'67cd25e50357e6e970d432c1d255085a23b856ac'; + /// A provider that fetches the likes count, popularity score and pub points /// for a given package. /// /// It also exposes utilities to like/unlike a package, assuming the user /// is logged-in. -/// -/// Copied from [PackageMetrics]. -class PackageMetricsProvider extends AutoDisposeAsyncNotifierProviderImpl< - PackageMetrics, PackageMetricsScore> { +final class PackageMetricsFamily extends Family { + const PackageMetricsFamily._() + : super( + name: r'packageMetricsProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + /// A provider that fetches the likes count, popularity score and pub points /// for a given package. /// /// It also exposes utilities to like/unlike a package, assuming the user /// is logged-in. - /// - /// Copied from [PackageMetrics]. - PackageMetricsProvider({ + PackageMetricsProvider call({ required String packageName, - }) : this._internal( - () => PackageMetrics()..packageName = packageName, - from: packageMetricsProvider, - name: r'packageMetricsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$packageMetricsHash, - dependencies: null, - allTransitiveDependencies: null, - packageName: packageName, - ); - - PackageMetricsProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.packageName, - }) : super.internal(); - - final String packageName; + }) => + PackageMetricsProvider._(argument: packageName, from: this); @override - FutureOr runNotifierBuild( - covariant PackageMetrics notifier, - ) { - return notifier.build( - packageName: packageName, - ); - } - - @override - Override overrideWith(PackageMetrics Function() create) { - return $ProviderOverride( - origin: this, - providerOverride: PackageMetricsProvider._internal( - () => create()..packageName = packageName, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - packageName: packageName, - ), - ); - } + String debugGetCreateSourceHash() => _$packageMetricsHash(); @override - ({ - String packageName, - }) get argument { - return (packageName: packageName,); - } + String toString() => r'packageMetricsProvider'; - @override - _PackageMetricsProviderElement createElement( - ProviderContainer container, + /// {@macro riverpod.override_with} + Override overrideWith( + PackageMetrics Function( + String args, + ) create, ) { - return _PackageMetricsProviderElement(this, container); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as PackageMetricsProvider; - PackageMetricsProvider _copyWith( - PackageMetrics Function() create, - ) { - return PackageMetricsProvider._internal( - () => create()..packageName = packageName, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - packageName: packageName, + final argument = provider.argument as String; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, ); } - @override - bool operator ==(Object other) { - return other is PackageMetricsProvider && other.packageName == packageName; - } + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + FutureOr Function( + Ref> ref, + PackageMetrics notifier, + String argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as PackageMetricsProvider; - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, packageName.hashCode); + final argument = provider.argument as String; - return _SystemHash.finish(hash); + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'packageMetricsProvider$argument'; -} - -mixin PackageMetricsRef - on AutoDisposeAsyncNotifierProviderRef { - /// The parameter `packageName` of this provider. - String get packageName; } -class _PackageMetricsProviderElement - extends AutoDisposeAsyncNotifierProviderElement with PackageMetricsRef { - _PackageMetricsProviderElement(super.provider, super.container); +abstract class _$PackageMetrics extends $AsyncNotifier { + late final _$args = + (ref as $AsyncNotifierProviderElement).origin.argument as String; + String get packageName => _$args; + FutureOr build({ + required String packageName, + }); + @$internal @override - String get packageName => (origin as PackageMetricsProvider).packageName; + FutureOr runBuild() => build( + packageName: _$args, + ); } + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/examples/pub/lib/pub_repository.freezed.dart b/examples/pub/lib/pub_repository.freezed.dart index c4cda8db7..b86c3f5d8 100644 --- a/examples/pub/lib/pub_repository.freezed.dart +++ b/examples/pub/lib/pub_repository.freezed.dart @@ -12,7 +12,7 @@ part of 'pub_repository.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); PackageMetricsScore _$PackageMetricsScoreFromJson(Map json) { return _PackageMetricsScore.fromJson(json); diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 1914ec9d7..ca63df2ea 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -8,220 +8,159 @@ part of 'search.dart'; // RiverpodGenerator // ************************************************************************** -String _$fetchPackagesHash() => r'3637226080ea667823875a135a6c4cf002cb0329'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} +typedef FetchPackagesRef = Ref>>; -/// See also [fetchPackages]. @ProviderFor(fetchPackages) -const fetchPackagesProvider = FetchPackagesFamily(); - -/// See also [fetchPackages]. -class FetchPackagesFamily extends Family { - /// See also [fetchPackages]. - const FetchPackagesFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; +const fetchPackagesProvider = FetchPackagesFamily._(); + +final class FetchPackagesProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, FetchPackagesRef> + with + $FutureModifier>, + $FutureProvider, FetchPackagesRef> { + const FetchPackagesProvider._( + {required FetchPackagesFamily super.from, + required ({ + int page, + String search, + }) + super.argument, + FutureOr> Function( + FetchPackagesRef ref, { + required int page, + String search, + })? create}) + : _createCb = create, + super( + name: r'fetchPackagesProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get dependencies => _dependencies; + final FutureOr> Function( + FetchPackagesRef ref, { + required int page, + String search, + })? _createCb; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$fetchPackagesHash(); @override - String? get name => r'fetchPackagesProvider'; - - /// See also [fetchPackages]. - FetchPackagesProvider call({ - required int page, - String search = '', - }) { - return FetchPackagesProvider( - page: page, - search: search, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith( - FutureOr> Function(FetchPackagesRef ref) create) { - return _$FetchPackagesFamilyOverride(this, create); + String toString() { + return r'fetchPackagesProvider' + '' + '$argument'; } @override - String toString() => 'fetchPackagesProvider'; -} + $FutureProviderElement> createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); -class _$FetchPackagesFamilyOverride implements $FamilyOverride { - _$FetchPackagesFamilyOverride(this.from, this.create); - - final FutureOr> Function(FetchPackagesRef ref) create; + @override + FetchPackagesProvider $copyWithCreate( + FutureOr> Function( + FetchPackagesRef ref, + ) create, + ) { + return FetchPackagesProvider._( + argument: argument as ({ + int page, + String search, + }), + from: from! as FetchPackagesFamily, + create: ( + ref, { + required int page, + String search = '', + }) => + create(ref)); + } @override - final FetchPackagesFamily from; + FutureOr> create(FetchPackagesRef ref) { + final fn = _createCb ?? fetchPackages; + final ({ + int page, + String search, + }) argument = this.argument as ({ + int page, + String search, + }); + return fn( + ref, + page: argument.page, + search: argument.search, + ); + } @override - _FetchPackagesProviderElement createElement( - ProviderContainer container, - covariant FetchPackagesProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is FetchPackagesProvider && other.argument == argument; } @override - String toString() => 'fetchPackagesProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [fetchPackages]. -class FetchPackagesProvider extends AutoDisposeFutureProvider> { - /// See also [fetchPackages]. - FetchPackagesProvider({ - required int page, - String search = '', - }) : this._internal( - (ref) => fetchPackages( - ref as FetchPackagesRef, - page: page, - search: search, - ), - from: fetchPackagesProvider, +String _$fetchPackagesHash() => r'3637226080ea667823875a135a6c4cf002cb0329'; + +final class FetchPackagesFamily extends Family { + const FetchPackagesFamily._() + : super( name: r'fetchPackagesProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$fetchPackagesHash, dependencies: null, allTransitiveDependencies: null, - page: page, - search: search, + isAutoDispose: true, ); - FetchPackagesProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.page, - required this.search, - }) : super.internal(); - - final int page; - final String search; - - @override - Override overrideWith( - FutureOr> Function(FetchPackagesRef ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: FetchPackagesProvider._internal( - (ref) => create(ref as FetchPackagesRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, + FetchPackagesProvider call({ + required int page, + String search = '', + }) => + FetchPackagesProvider._(argument: ( page: page, search: search, - ), - ); - } + ), from: this); @override - ({ - int page, - String search, - }) get argument { - return ( - page: page, - search: search, - ); - } + String debugGetCreateSourceHash() => _$fetchPackagesHash(); @override - _FetchPackagesProviderElement createElement( - ProviderContainer container, - ) { - return _FetchPackagesProviderElement(this, container); - } + String toString() => r'fetchPackagesProvider'; - FetchPackagesProvider _copyWith( - FutureOr> Function(FetchPackagesRef ref) create, + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr> Function( + FetchPackagesRef ref, + ({ + int page, + String search, + }) args, + ) create, ) { - return FetchPackagesProvider._internal( - (ref) => create(ref as FetchPackagesRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - page: page, - search: search, + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FetchPackagesProvider; + + final argument = provider.argument as ({ + int page, + String search, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, ); } - - @override - bool operator ==(Object other) { - return other is FetchPackagesProvider && - other.page == page && - other.search == search; - } - - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, page.hashCode); - hash = _SystemHash.combine(hash, search.hashCode); - - return _SystemHash.finish(hash); - } - - @override - String toString() => 'fetchPackagesProvider$argument'; -} - -mixin FetchPackagesRef on AutoDisposeFutureProviderRef> { - /// The parameter `page` of this provider. - int get page; - - /// The parameter `search` of this provider. - String get search; } -class _FetchPackagesProviderElement - extends AutoDisposeFutureProviderElement> - with FetchPackagesRef { - _FetchPackagesProviderElement(super.provider, super.container); - - @override - int get page => (origin as FetchPackagesProvider).page; - @override - String get search => (origin as FetchPackagesProvider).search; -} +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/examples/stackoverflow/lib/question.freezed.dart b/examples/stackoverflow/lib/question.freezed.dart index a9cdf80e0..5d31e4eff 100644 --- a/examples/stackoverflow/lib/question.freezed.dart +++ b/examples/stackoverflow/lib/question.freezed.dart @@ -12,7 +12,7 @@ part of 'question.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); QuestionsResponse _$QuestionsResponseFromJson(Map json) { return _QuestionsResponse.fromJson(json); diff --git a/examples/stackoverflow/lib/tag.freezed.dart b/examples/stackoverflow/lib/tag.freezed.dart index 50ec013ca..b96ae82e2 100644 --- a/examples/stackoverflow/lib/tag.freezed.dart +++ b/examples/stackoverflow/lib/tag.freezed.dart @@ -12,7 +12,7 @@ part of 'tag.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$TagTheme { diff --git a/examples/stackoverflow/lib/user.freezed.dart b/examples/stackoverflow/lib/user.freezed.dart index ea66623e1..f276b487d 100644 --- a/examples/stackoverflow/lib/user.freezed.dart +++ b/examples/stackoverflow/lib/user.freezed.dart @@ -12,7 +12,7 @@ part of 'user.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); User _$UserFromJson(Map json) { return _User.fromJson(json); diff --git a/packages/riverpod/example/lib/models.freezed.dart b/packages/riverpod/example/lib/models.freezed.dart index b0e3ebd83..64e8bd61f 100644 --- a/packages/riverpod/example/lib/models.freezed.dart +++ b/packages/riverpod/example/lib/models.freezed.dart @@ -12,7 +12,7 @@ part of 'models.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Configuration _$ConfigurationFromJson(Map json) { return _Configuration.fromJson(json); diff --git a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart index 861316a7a..eb3ccce64 100644 --- a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart @@ -2,9 +2,9 @@ import 'package:meta/meta.dart'; import 'package:meta/meta_meta.dart'; -import 'package:riverpod/src/internals.dart'; - -import '../riverpod_annotation.dart'; +import 'package:riverpod/riverpod.dart'; +// ignore: implementation_imports, invalid_use_of_internal_member +import 'package:riverpod/src/internals.dart' show ProviderElementBase; /// {@template riverpod_annotation.provider} /// An annotation placed on classes or functions. diff --git a/packages/riverpod_graph/test/integration/consumer_widget/golden/lib/main.dart b/packages/riverpod_graph/test/integration/consumer_widget/golden/lib/main.dart index 5f86352e3..31d508987 100644 --- a/packages/riverpod_graph/test/integration/consumer_widget/golden/lib/main.dart +++ b/packages/riverpod_graph/test/integration/consumer_widget/golden/lib/main.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /// Counter provider. final counterProvider = StateProvider((ref) => 0); diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart index 24bc4f7d6..df024ab3f 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart @@ -29,7 +29,7 @@ String family( } /// A private generated provider. -final AutoDisposeProvider privateProvider = _privateProvider; +const privateProvider = _privateProvider; @riverpod String _private(_PrivateRef ref) { @@ -46,7 +46,7 @@ class PublicClass extends _$PublicClass { } /// A private generate provider from a class. -final privateClassProvider = _privateClassProvider; +const privateClassProvider = _privateClassProvider; @riverpod class _PrivateClass extends _$PrivateClass { diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index d8a579524..a3666510f 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -6,679 +6,842 @@ part of 'sync.dart'; // RiverpodGenerator // ************************************************************************** -String _$publicHash() => r'138be35943899793ab085e711fe3f3d22696a3ba'; +/// A public generated provider. +typedef PublicRef = Ref; /// A public generated provider. -/// -/// Copied from [public]. @ProviderFor(public) -final publicProvider = AutoDisposeProvider.internal( - public, - name: r'publicProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$publicHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef PublicRef = AutoDisposeProviderRef; -String _$supports$inNamesHash() => r'baacdb7b92917860b02aba1fa7010c7056da4a67'; +const publicProvider = PublicProvider._(); -/// A generated provider with a '$' in its name. -/// -/// Copied from [supports$inNames]. -@ProviderFor(supports$inNames) -final supports$inNamesProvider = AutoDisposeProvider.internal( - supports$inNames, - name: r'supports$inNamesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$supports$inNamesHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef Supports$inNamesRef = AutoDisposeProviderRef; -String _$familyHash() => r'ebf082969854dcc358b9870a2e5e9b922423e59b'; +/// A public generated provider. +final class PublicProvider + extends $FunctionalProvider + with $Provider { + /// A public generated provider. + const PublicProvider._( + {String Function( + PublicRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'publicProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); + final String Function( + PublicRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$publicHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); + @override + PublicProvider $copyWithCreate( + String Function( + PublicRef ref, + ) create, + ) { + return PublicProvider._(create: create); } - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + @override + String create(PublicRef ref) { + final fn = _createCb ?? public; + return fn(ref); } } -/// A generated family provider. -/// -/// Copied from [family]. -@ProviderFor(family) -const familyProvider = FamilyFamily(); +String _$publicHash() => r'138be35943899793ab085e711fe3f3d22696a3ba'; -/// A generated family provider. -/// -/// Copied from [family]. -class FamilyFamily extends Family { - /// A generated family provider. - /// - /// Copied from [family]. - const FamilyFamily(); +/// A generated provider with a '$' in its name. +typedef Supports$inNamesRef = Ref; - static const Iterable? _dependencies = null; +/// A generated provider with a '$' in its name. +@ProviderFor(supports$inNames) +const supports$inNamesProvider = Supports$inNamesProvider._(); + +/// A generated provider with a '$' in its name. +final class Supports$inNamesProvider + extends $FunctionalProvider + with $Provider { + /// A generated provider with a '$' in its name. + const Supports$inNamesProvider._( + {String Function( + Supports$inNamesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'supports$inNamesProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + Supports$inNamesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$supports$inNamesHash(); - static const Iterable? _allTransitiveDependencies = null; + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } @override - Iterable? get dependencies => _dependencies; + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + Supports$inNamesProvider $copyWithCreate( + String Function( + Supports$inNamesRef ref, + ) create, + ) { + return Supports$inNamesProvider._(create: create); + } @override - String? get name => r'familyProvider'; + String create(Supports$inNamesRef ref) { + final fn = _createCb ?? supports$inNames; + return fn(ref); + } +} + +String _$supports$inNamesHash() => r'baacdb7b92917860b02aba1fa7010c7056da4a67'; +/// A generated family provider. +typedef FamilyRef = Ref; + +/// A generated family provider. +@ProviderFor(family) +const familyProvider = FamilyFamily._(); + +/// A generated family provider. +final class FamilyProvider + extends $FunctionalProvider + with $Provider { /// A generated family provider. - /// - /// Copied from [family]. - FamilyProvider call( + const FamilyProvider._( + {required FamilyFamily super.from, + required ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }) + super.argument, + String Function( + FamilyRef ref, + int first, { + String? second, + required double third, + bool forth, + List? fifth, + })? create}) + : _createCb = create, + super( + name: r'familyProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + FamilyRef ref, int first, { String? second, required double third, - bool forth = true, + bool forth, List? fifth, - }) { - return FamilyProvider( - first, - second: second, - third: third, - forth: forth, - fifth: fifth, - ); + })? _createCb; + + @override + String debugGetCreateSourceHash() => _$familyHash(); + + @override + String toString() { + return r'familyProvider' + '' + '$argument'; } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(String Function(FamilyRef ref) create) { - return _$FamilyFamilyOverride(this, create); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); } @override - String toString() => 'familyProvider'; -} - -class _$FamilyFamilyOverride implements $FamilyOverride { - _$FamilyFamilyOverride(this.from, this.create); + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); - final String Function(FamilyRef ref) create; + @override + FamilyProvider $copyWithCreate( + String Function( + FamilyRef ref, + ) create, + ) { + return FamilyProvider._( + argument: argument as ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }), + from: from! as FamilyFamily, + create: ( + ref, + int first, { + String? second, + required double third, + bool forth = true, + List? fifth, + }) => + create(ref)); + } @override - final FamilyFamily from; + String create(FamilyRef ref) { + final fn = _createCb ?? family; + final ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }) argument = this.argument as ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }); + return fn( + ref, + argument.$1, + second: argument.second, + third: argument.third, + forth: argument.forth, + fifth: argument.fifth, + ); + } @override - _FamilyProviderElement createElement( - ProviderContainer container, - covariant FamilyProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is FamilyProvider && other.argument == argument; } @override - String toString() => 'familyProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } +String _$familyHash() => r'ebf082969854dcc358b9870a2e5e9b922423e59b'; + /// A generated family provider. -/// -/// Copied from [family]. -class FamilyProvider extends AutoDisposeProvider { +final class FamilyFamily extends Family { + const FamilyFamily._() + : super( + name: r'familyProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + /// A generated family provider. - /// - /// Copied from [family]. - FamilyProvider( + FamilyProvider call( int first, { String? second, required double third, bool forth = true, List? fifth, - }) : this._internal( - (ref) => family( - ref as FamilyRef, - first, - second: second, - third: third, - forth: forth, - fifth: fifth, - ), - from: familyProvider, - name: r'familyProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyHash, + }) => + FamilyProvider._(argument: ( + first, + second: second, + third: third, + forth: forth, + fifth: fifth, + ), from: this); + + @override + String debugGetCreateSourceHash() => _$familyHash(); + + @override + String toString() => r'familyProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + String Function( + FamilyRef ref, + ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyProvider; + + final argument = provider.argument as ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } +} + +typedef _PrivateRef = Ref; + +@ProviderFor(_private) +const _privateProvider = _PrivateProvider._(); + +final class _PrivateProvider + extends $FunctionalProvider + with $Provider { + const _PrivateProvider._( + {String Function( + _PrivateRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'_privateProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - first: first, - second: second, - third: third, - forth: forth, - fifth: fifth, ); - FamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.first, - required this.second, - required this.third, - required this.forth, - required this.fifth, - }) : super.internal(); - - final int first; - final String? second; - final double third; - final bool forth; - final List? fifth; + final String Function( + _PrivateRef ref, + )? _createCb; @override - Override overrideWith( - String Function(FamilyRef ref) create, - ) { + String debugGetCreateSourceHash() => _$privateHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { return $ProviderOverride( origin: this, - providerOverride: FamilyProvider._internal( - (ref) => create(ref as FamilyRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - first: first, - second: second, - third: third, - forth: forth, - fifth: fifth, - ), + providerOverride: $ValueProvider(value), ); } @override - ( - int, { - String? second, - double third, - bool forth, - List? fifth, - }) get argument { - return ( - first, - second: second, - third: third, - forth: forth, - fifth: fifth, - ); - } + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); @override - _FamilyProviderElement createElement( - ProviderContainer container, + _PrivateProvider $copyWithCreate( + String Function( + _PrivateRef ref, + ) create, ) { - return _FamilyProviderElement(this, container); + return _PrivateProvider._(create: create); } - FamilyProvider _copyWith( - String Function(FamilyRef ref) create, - ) { - return FamilyProvider._internal( - (ref) => create(ref as FamilyRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - first: first, - second: second, - third: third, - forth: forth, - fifth: fifth, - ); + @override + String create(_PrivateRef ref) { + final fn = _createCb ?? _private; + return fn(ref); } +} + +String _$privateHash() => r'9a87ed0765ad8448525fa1290b34760c79e7402b'; + +/// A generated public provider from a class +@ProviderFor(PublicClass) +const publicClassProvider = PublicClassProvider._(); + +/// A generated public provider from a class +final class PublicClassProvider extends $NotifierProvider { + /// A generated public provider from a class + const PublicClassProvider._( + {super.runNotifierBuildOverride, PublicClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'publicClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final PublicClass Function()? _createCb; @override - bool operator ==(Object other) { - return other is FamilyProvider && - other.first == first && - other.second == second && - other.third == third && - other.forth == forth && - other.fifth == fifth; + String debugGetCreateSourceHash() => _$publicClassHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); } + @$internal @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, first.hashCode); - hash = _SystemHash.combine(hash, second.hashCode); - hash = _SystemHash.combine(hash, third.hashCode); - hash = _SystemHash.combine(hash, forth.hashCode); - hash = _SystemHash.combine(hash, fifth.hashCode); + PublicClass create() => _createCb?.call() ?? PublicClass(); - return _SystemHash.finish(hash); + @$internal + @override + PublicClassProvider $copyWithCreate( + PublicClass Function() create, + ) { + return PublicClassProvider._(create: create); } + @$internal @override - String toString() => 'familyProvider$argument'; + PublicClassProvider $copyWithBuild( + String Function( + Ref, + PublicClass, + ) build, + ) { + return PublicClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -mixin FamilyRef on AutoDisposeProviderRef { - /// The parameter `first` of this provider. - int get first; +String _$publicClassHash() => r'c27eae39f455b986e570abb84f1471de7445ef3b'; - /// The parameter `second` of this provider. - String? get second; +abstract class _$PublicClass extends $Notifier { + String build(); + @$internal + @override + String runBuild() => build(); +} - /// The parameter `third` of this provider. - double get third; +@ProviderFor(_PrivateClass) +const _privateClassProvider = _PrivateClassProvider._(); + +final class _PrivateClassProvider + extends $NotifierProvider<_PrivateClass, String> { + const _PrivateClassProvider._( + {super.runNotifierBuildOverride, _PrivateClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'_privateClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - /// The parameter `forth` of this provider. - bool get forth; + final _PrivateClass Function()? _createCb; - /// The parameter `fifth` of this provider. - List? get fifth; -} + @override + String debugGetCreateSourceHash() => _$privateClassHash(); -class _FamilyProviderElement extends AutoDisposeProviderElement - with FamilyRef { - _FamilyProviderElement(super.provider, super.container); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override - int get first => (origin as FamilyProvider).first; - @override - String? get second => (origin as FamilyProvider).second; + _PrivateClass create() => _createCb?.call() ?? _PrivateClass(); + + @$internal @override - double get third => (origin as FamilyProvider).third; + _PrivateClassProvider $copyWithCreate( + _PrivateClass Function() create, + ) { + return _PrivateClassProvider._(create: create); + } + + @$internal @override - bool get forth => (origin as FamilyProvider).forth; + _PrivateClassProvider $copyWithBuild( + String Function( + Ref, + _PrivateClass, + ) build, + ) { + return _PrivateClassProvider._(runNotifierBuildOverride: build); + } + + @$internal @override - List? get fifth => (origin as FamilyProvider).fifth; + $NotifierProviderElement<_PrivateClass, String> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -String _$privateHash() => r'9a87ed0765ad8448525fa1290b34760c79e7402b'; - -/// See also [_private]. -@ProviderFor(_private) -final _privateProvider = AutoDisposeProvider.internal( - _private, - name: r'_privateProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$privateHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _PrivateRef = AutoDisposeProviderRef; -String _$publicClassHash() => r'c27eae39f455b986e570abb84f1471de7445ef3b'; - -/// A generated public provider from a class -/// -/// Copied from [PublicClass]. -@ProviderFor(PublicClass) -final publicClassProvider = - AutoDisposeNotifierProvider.internal( - PublicClass.new, - name: r'publicClassProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$publicClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$PublicClass = AutoDisposeNotifier; String _$privateClassHash() => r'3b08af72c6d4f24aed264efcf181572525b75603'; -/// See also [_PrivateClass]. -@ProviderFor(_PrivateClass) -final _privateClassProvider = - AutoDisposeNotifierProvider<_PrivateClass, String>.internal( - _PrivateClass.new, - name: r'_privateClassProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$privateClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$PrivateClass = AutoDisposeNotifier; -String _$familyClassHash() => r'721bdd2f1ca0d7cee1a0ae476d7bfe93f9ce6875'; - -abstract class _$FamilyClass extends BuildlessAutoDisposeNotifier { - late final int first; - late final String? second; - late final double third; - late final bool forth; - late final List? fifth; - - String build( - int first, { - String? second, - required double third, - bool forth = true, - List? fifth, - }); +abstract class _$PrivateClass extends $Notifier { + String build(); + @$internal + @override + String runBuild() => build(); } /// A generated family provider from a class. -/// -/// Copied from [FamilyClass]. @ProviderFor(FamilyClass) -const familyClassProvider = FamilyClassFamily(); +const familyClassProvider = FamilyClassFamily._(); /// A generated family provider from a class. -/// -/// Copied from [FamilyClass]. -class FamilyClassFamily extends Family { +final class FamilyClassProvider extends $NotifierProvider { /// A generated family provider from a class. - /// - /// Copied from [FamilyClass]. - const FamilyClassFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; + const FamilyClassProvider._( + {required FamilyClassFamily super.from, + required ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }) + super.argument, + super.runNotifierBuildOverride, + FamilyClass Function()? create}) + : _createCb = create, + super( + name: r'familyClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get dependencies => _dependencies; + final FamilyClass Function()? _createCb; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$familyClassHash(); @override - String? get name => r'familyClassProvider'; - - /// A generated family provider from a class. - /// - /// Copied from [FamilyClass]. - FamilyClassProvider call( - int first, { - String? second, - required double third, - bool forth = true, - List? fifth, - }) { - return FamilyClassProvider( - first, - second: second, - third: third, - forth: forth, - fifth: fifth, - ); + String toString() { + return r'familyClassProvider' + '' + '$argument'; } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(FamilyClass Function() create) { - return _$FamilyClassFamilyOverride(this, create); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); } + @$internal @override - String toString() => 'familyClassProvider'; -} + FamilyClass create() => _createCb?.call() ?? FamilyClass(); -class _$FamilyClassFamilyOverride implements $FamilyOverride { - _$FamilyClassFamilyOverride(this.from, this.create); + @$internal + @override + FamilyClassProvider $copyWithCreate( + FamilyClass Function() create, + ) { + return FamilyClassProvider._( + argument: argument as ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }), + from: from! as FamilyClassFamily, + create: create); + } - final FamilyClass Function() create; + @$internal + @override + FamilyClassProvider $copyWithBuild( + String Function( + Ref, + FamilyClass, + ) build, + ) { + return FamilyClassProvider._( + argument: argument as ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }), + from: from! as FamilyClassFamily, + runNotifierBuildOverride: build); + } + @$internal @override - final FamilyClassFamily from; + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); @override - _FamilyClassProviderElement createElement( - ProviderContainer container, - covariant FamilyClassProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is FamilyClassProvider && other.argument == argument; } @override - String toString() => 'familyClassProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } +String _$familyClassHash() => r'721bdd2f1ca0d7cee1a0ae476d7bfe93f9ce6875'; + /// A generated family provider from a class. -/// -/// Copied from [FamilyClass]. -class FamilyClassProvider - extends AutoDisposeNotifierProviderImpl { +final class FamilyClassFamily extends Family { + const FamilyClassFamily._() + : super( + name: r'familyClassProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + /// A generated family provider from a class. - /// - /// Copied from [FamilyClass]. - FamilyClassProvider( + FamilyClassProvider call( int first, { String? second, required double third, bool forth = true, List? fifth, - }) : this._internal( - () => FamilyClass() - ..first = first - ..second = second - ..third = third - ..forth = forth - ..fifth = fifth, - from: familyClassProvider, - name: r'familyClassProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyClassHash, - dependencies: null, - allTransitiveDependencies: null, - first: first, - second: second, - third: third, - forth: forth, - fifth: fifth, - ); - - FamilyClassProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.first, - required this.second, - required this.third, - required this.forth, - required this.fifth, - }) : super.internal(); - - final int first; - final String? second; - final double third; - final bool forth; - final List? fifth; - - @override - String runNotifierBuild( - covariant FamilyClass notifier, - ) { - return notifier.build( - first, - second: second, - third: third, - forth: forth, - fifth: fifth, - ); - } - - @override - Override overrideWith(FamilyClass Function() create) { - return $ProviderOverride( - origin: this, - providerOverride: FamilyClassProvider._internal( - () => create() - ..first = first - ..second = second - ..third = third - ..forth = forth - ..fifth = fifth, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - first: first, + }) => + FamilyClassProvider._(argument: ( + first, second: second, third: third, forth: forth, fifth: fifth, - ), - ); - } + ), from: this); @override - ( - int, { - String? second, - double third, - bool forth, - List? fifth, - }) get argument { - return ( - first, - second: second, - third: third, - forth: forth, - fifth: fifth, - ); - } + String debugGetCreateSourceHash() => _$familyClassHash(); @override - _FamilyClassProviderElement createElement( - ProviderContainer container, - ) { - return _FamilyClassProviderElement(this, container); - } + String toString() => r'familyClassProvider'; - FamilyClassProvider _copyWith( - FamilyClass Function() create, + /// {@macro riverpod.override_with} + Override overrideWith( + FamilyClass Function( + ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }) args, + ) create, ) { - return FamilyClassProvider._internal( - () => create() - ..first = first - ..second = second - ..third = third - ..forth = forth - ..fifth = fifth, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - first: first, - second: second, - third: third, - forth: forth, - fifth: fifth, + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyClassProvider; + + final argument = provider.argument as ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }); + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, ); } - @override - bool operator ==(Object other) { - return other is FamilyClassProvider && - other.first == first && - other.second == second && - other.third == third && - other.forth == forth && - other.fifth == fifth; + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + String Function( + Ref ref, + FamilyClass notifier, + ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }) argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyClassProvider; + + final argument = provider.argument as ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }); + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); } +} - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, first.hashCode); - hash = _SystemHash.combine(hash, second.hashCode); - hash = _SystemHash.combine(hash, third.hashCode); - hash = _SystemHash.combine(hash, forth.hashCode); - hash = _SystemHash.combine(hash, fifth.hashCode); - - return _SystemHash.finish(hash); - } +abstract class _$FamilyClass extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as ( + int, { + String? second, + double third, + bool forth, + List? fifth, + }); + int get first => _$args.$1; + String? get second => _$args.second; + double get third => _$args.third; + bool get forth => _$args.forth; + List? get fifth => _$args.fifth; - @override - String toString() => 'familyClassProvider$argument'; + String build( + int first, { + String? second, + required double third, + bool forth = true, + List? fifth, + }); + @$internal + @override + String runBuild() => build( + _$args.$1, + second: _$args.second, + third: _$args.third, + forth: _$args.forth, + fifth: _$args.fifth, + ); } -mixin FamilyClassRef on AutoDisposeNotifierProviderRef { - /// The parameter `first` of this provider. - int get first; - - /// The parameter `second` of this provider. - String? get second; +/// A generated provider from a class with a '$' in its name. +@ProviderFor(Supports$InClassName) +const supports$InClassNameProvider = Supports$InClassNameProvider._(); - /// The parameter `third` of this provider. - double get third; +/// A generated provider from a class with a '$' in its name. +final class Supports$InClassNameProvider + extends $NotifierProvider { + /// A generated provider from a class with a '$' in its name. + const Supports$InClassNameProvider._( + {super.runNotifierBuildOverride, Supports$InClassName Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'supports$InClassNameProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - /// The parameter `forth` of this provider. - bool get forth; + final Supports$InClassName Function()? _createCb; - /// The parameter `fifth` of this provider. - List? get fifth; -} + @override + String debugGetCreateSourceHash() => _$supports$InClassNameHash(); -class _FamilyClassProviderElement - extends AutoDisposeNotifierProviderElement - with FamilyClassRef { - _FamilyClassProviderElement(super.provider, super.container); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override - int get first => (origin as FamilyClassProvider).first; - @override - String? get second => (origin as FamilyClassProvider).second; + Supports$InClassName create() => _createCb?.call() ?? Supports$InClassName(); + + @$internal @override - double get third => (origin as FamilyClassProvider).third; + Supports$InClassNameProvider $copyWithCreate( + Supports$InClassName Function() create, + ) { + return Supports$InClassNameProvider._(create: create); + } + + @$internal @override - bool get forth => (origin as FamilyClassProvider).forth; + Supports$InClassNameProvider $copyWithBuild( + String Function( + Ref, + Supports$InClassName, + ) build, + ) { + return Supports$InClassNameProvider._(runNotifierBuildOverride: build); + } + + @$internal @override - List? get fifth => (origin as FamilyClassProvider).fifth; + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } String _$supports$InClassNameHash() => r'dd23b01994664e5a2c22ba3a61f3b23d2128861b'; -/// A generated provider from a class with a '$' in its name. -/// -/// Copied from [Supports$InClassName]. -@ProviderFor(Supports$InClassName) -final supports$InClassNameProvider = - AutoDisposeNotifierProvider.internal( - Supports$InClassName.new, - name: r'supports$InClassNameProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$supports$InClassNameHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Supports$InClassName = AutoDisposeNotifier; +abstract class _$Supports$InClassName extends $Notifier { + String build(); + @$internal + @override + String runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml b/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml index aef4942a3..7bf01aa5b 100644 --- a/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml +++ b/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml @@ -15,3 +15,4 @@ dependency_overrides: riverpod_lint: path: ../riverpod_lint test_api: ^0.6.1 + vm_service: ^14.0.0 \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index ff666fbbc..43808b9a3 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -6,428 +6,431 @@ part of 'convert_class_based_provider_to_functional.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'081776126bafed3e1583bba9c1fadef798215ad7'; - /// Some comment -/// -/// Copied from [Example]. @ProviderFor(Example) -final exampleProvider = AutoDisposeNotifierProvider.internal( - Example.new, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Example = AutoDisposeNotifier; -String _$exampleFamilyHash() => r'37d4a4fd66999562cd92051f91266270d5a1e5ea'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -abstract class _$ExampleFamily extends BuildlessAutoDisposeNotifier { - late final int a; - late final String b; - - int build({ - required int a, - String b = '42', - }); -} +const exampleProvider = ExampleProvider._(); /// Some comment -/// -/// Copied from [ExampleFamily]. -@ProviderFor(ExampleFamily) -const exampleFamilyProvider = ExampleFamilyFamily(); - -/// Some comment -/// -/// Copied from [ExampleFamily]. -class ExampleFamilyFamily extends Family { +final class ExampleProvider extends $NotifierProvider { /// Some comment - /// - /// Copied from [ExampleFamily]. - const ExampleFamilyFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - @override - Iterable? get dependencies => _dependencies; + const ExampleProvider._( + {super.runNotifierBuildOverride, Example Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final Example Function()? _createCb; @override - String? get name => r'exampleFamilyProvider'; + String debugGetCreateSourceHash() => _$exampleHash(); - /// Some comment - /// - /// Copied from [ExampleFamily]. - ExampleFamilyProvider call({ - required int a, - String b = '42', - }) { - return ExampleFamilyProvider( - a: a, - b: b, + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(ExampleFamily Function() create) { - return _$ExampleFamilyFamilyOverride(this, create); - } - + @$internal @override - String toString() => 'exampleFamilyProvider'; -} - -class _$ExampleFamilyFamilyOverride implements $FamilyOverride { - _$ExampleFamilyFamilyOverride(this.from, this.create); - - final ExampleFamily Function() create; + Example create() => _createCb?.call() ?? Example(); + @$internal @override - final ExampleFamilyFamily from; + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._(create: create); + } + @$internal @override - _ExampleFamilyProviderElement createElement( - ProviderContainer container, - covariant ExampleFamilyProvider provider, + ExampleProvider $copyWithBuild( + int Function( + Ref, + Example, + ) build, ) { - return provider._copyWith(create).createElement(container); + return ExampleProvider._(runNotifierBuildOverride: build); } + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$exampleHash() => r'081776126bafed3e1583bba9c1fadef798215ad7'; + +abstract class _$Example extends $Notifier { + int build(); + @$internal @override - String toString() => 'exampleFamilyProvider.overrideWith(...)'; + int runBuild() => build(); } /// Some comment -/// -/// Copied from [ExampleFamily]. -class ExampleFamilyProvider - extends AutoDisposeNotifierProviderImpl { +@ProviderFor(ExampleFamily) +const exampleFamilyProvider = ExampleFamilyFamily._(); + +/// Some comment +final class ExampleFamilyProvider + extends $NotifierProvider { /// Some comment - /// - /// Copied from [ExampleFamily]. - ExampleFamilyProvider({ - required int a, - String b = '42', - }) : this._internal( - () => ExampleFamily() - ..a = a - ..b = b, - from: exampleFamilyProvider, + const ExampleFamilyProvider._( + {required ExampleFamilyFamily super.from, + required ({ + int a, + String b, + }) + super.argument, + super.runNotifierBuildOverride, + ExampleFamily Function()? create}) + : _createCb = create, + super( name: r'exampleFamilyProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$exampleFamilyHash, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - a: a, - b: b, ); - ExampleFamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.a, - required this.b, - }) : super.internal(); + final ExampleFamily Function()? _createCb; - final int a; - final String b; + @override + String debugGetCreateSourceHash() => _$exampleFamilyHash(); @override - int runNotifierBuild( - covariant ExampleFamily notifier, - ) { - return notifier.build( - a: a, - b: b, - ); + String toString() { + return r'exampleFamilyProvider' + '' + '$argument'; } - @override - Override overrideWith(ExampleFamily Function() create) { + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { return $ProviderOverride( origin: this, - providerOverride: ExampleFamilyProvider._internal( - () => create() - ..a = a - ..b = b, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - a: a, - b: b, - ), + providerOverride: $ValueProvider(value), ); } + @$internal @override - ({ - int a, - String b, - }) get argument { - return ( - a: a, - b: b, - ); - } + ExampleFamily create() => _createCb?.call() ?? ExampleFamily(); + @$internal @override - _ExampleFamilyProviderElement createElement( - ProviderContainer container, + ExampleFamilyProvider $copyWithCreate( + ExampleFamily Function() create, ) { - return _ExampleFamilyProviderElement(this, container); + return ExampleFamilyProvider._( + argument: argument as ({ + int a, + String b, + }), + from: from! as ExampleFamilyFamily, + create: create); } - ExampleFamilyProvider _copyWith( - ExampleFamily Function() create, + @$internal + @override + ExampleFamilyProvider $copyWithBuild( + int Function( + Ref, + ExampleFamily, + ) build, ) { - return ExampleFamilyProvider._internal( - () => create() - ..a = a - ..b = b, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - a: a, - b: b, - ); + return ExampleFamilyProvider._( + argument: argument as ({ + int a, + String b, + }), + from: from! as ExampleFamilyFamily, + runNotifierBuildOverride: build); } + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + @override bool operator ==(Object other) { - return other is ExampleFamilyProvider && other.a == a && other.b == b; + return other is ExampleFamilyProvider && other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, a.hashCode); - hash = _SystemHash.combine(hash, b.hashCode); - - return _SystemHash.finish(hash); + return argument.hashCode; } - - @override - String toString() => 'exampleFamilyProvider$argument'; } -mixin ExampleFamilyRef on AutoDisposeNotifierProviderRef { - /// The parameter `a` of this provider. - int get a; +String _$exampleFamilyHash() => r'37d4a4fd66999562cd92051f91266270d5a1e5ea'; - /// The parameter `b` of this provider. - String get b; -} +/// Some comment +final class ExampleFamilyFamily extends Family { + const ExampleFamilyFamily._() + : super( + name: r'exampleFamilyProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); -class _ExampleFamilyProviderElement - extends AutoDisposeNotifierProviderElement - with ExampleFamilyRef { - _ExampleFamilyProviderElement(super.provider, super.container); + /// Some comment + ExampleFamilyProvider call({ + required int a, + String b = '42', + }) => + ExampleFamilyProvider._(argument: ( + a: a, + b: b, + ), from: this); @override - int get a => (origin as ExampleFamilyProvider).a; + String debugGetCreateSourceHash() => _$exampleFamilyHash(); + @override - String get b => (origin as ExampleFamilyProvider).b; + String toString() => r'exampleFamilyProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + ExampleFamily Function( + ({ + int a, + String b, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleFamilyProvider; + + final argument = provider.argument as ({ + int a, + String b, + }); + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + int Function( + Ref ref, + ExampleFamily notifier, + ({ + int a, + String b, + }) argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleFamilyProvider; + + final argument = provider.argument as ({ + int a, + String b, + }); + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } -String _$genericHash() => r'0a3792d7b59723aebd92715eef2c74d2f267cbd2'; +abstract class _$ExampleFamily extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as ({ + int a, + String b, + }); + int get a => _$args.a; + String get b => _$args.b; -abstract class _$Generic extends BuildlessAutoDisposeNotifier { - int build(); + int build({ + required int a, + String b = '42', + }); + @$internal + @override + int runBuild() => build( + a: _$args.a, + b: _$args.b, + ); } -/// See also [Generic]. @ProviderFor(Generic) -const genericProvider = GenericFamily(); - -/// See also [Generic]. -class GenericFamily extends Family { - /// See also [Generic]. - const GenericFamily(); - - static const Iterable? _dependencies = null; +const genericProvider = GenericFamily._(); + +final class GenericProvider + extends $NotifierProvider, int> { + const GenericProvider._( + {required GenericFamily super.from, + super.runNotifierBuildOverride, + Generic Function()? create}) + : _createCb = create, + super( + argument: null, + name: r'genericProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - static const Iterable? _allTransitiveDependencies = null; + final Generic Function()? _createCb; @override - Iterable? get dependencies => _dependencies; + String debugGetCreateSourceHash() => _$genericHash(); - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + GenericProvider _copyWithCreate( + Generic Function() create, + ) { + return GenericProvider._( + from: from! as GenericFamily, create: create); + } - @override - String? get name => r'genericProvider'; + GenericProvider _copyWithBuild( + int Function( + Ref, + Generic, + ) build, + ) { + return GenericProvider._( + from: from! as GenericFamily, runNotifierBuildOverride: build); + } - /// See also [Generic]. - GenericProvider call() { - return GenericProvider(); + @override + String toString() { + return r'genericProvider' + '<${A}, ${B}>' + '()'; } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(Generic Function() create) { - return _$GenericFamilyOverride(this, create); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); } + @$internal @override - String toString() => 'genericProvider'; -} + Generic create() => _createCb?.call() ?? Generic(); -class _$GenericFamilyOverride implements $FamilyOverride { - _$GenericFamilyOverride(this.from, this.create); + @$internal + @override + GenericProvider $copyWithCreate( + Generic Function() create, + ) { + return GenericProvider._( + from: from! as GenericFamily, create: create); + } - final Generic Function() create; + @$internal + @override + GenericProvider $copyWithBuild( + int Function( + Ref, + Generic, + ) build, + ) { + return GenericProvider._( + from: from! as GenericFamily, runNotifierBuildOverride: build); + } + @$internal @override - final GenericFamily from; + $NotifierProviderElement, int> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); @override - _GenericProviderElement createElement( - ProviderContainer container, - covariant GenericProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is GenericProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override - String toString() => 'genericProvider.overrideWith(...)'; + int get hashCode { + return Object.hash(runtimeType, argument); + } } -/// See also [Generic]. -class GenericProvider - extends AutoDisposeNotifierProviderImpl, int> { - /// See also [Generic]. - GenericProvider() - : this._internal( - Generic.new, - from: genericProvider, +String _$genericHash() => r'0a3792d7b59723aebd92715eef2c74d2f267cbd2'; + +final class GenericFamily extends Family { + const GenericFamily._() + : super( name: r'genericProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericHash, dependencies: null, allTransitiveDependencies: null, + isAutoDispose: true, ); - GenericProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); + GenericProvider call() => GenericProvider._(from: this); @override - int runNotifierBuild( - covariant Generic notifier, - ) { - return notifier.build(); - } - - @override - Override overrideWith(Generic Function() create) { - return $ProviderOverride( - origin: this, - providerOverride: GenericProvider._internal( - () => create(), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), - ); - } + String debugGetCreateSourceHash() => _$genericHash(); @override - () get argument { - return (); - } + String toString() => r'genericProvider'; - @override - _GenericProviderElement createElement( - ProviderContainer container, + /// {@macro riverpod.override_with} + Override overrideWith( + Generic Function() create, ) { - return _GenericProviderElement(this, container); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericProvider; - GenericProvider _copyWith( - Generic Function() create, - ) { - return GenericProvider._internal( - () => create(), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, + return provider._copyWithCreate(create).createElement(container); + }, ); } - @override - bool operator ==(Object other) { - return other is GenericProvider && other.runtimeType == runtimeType; - } - - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, A.hashCode); - hash = _SystemHash.combine(hash, B.hashCode); + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + int Function(Ref ref, Generic notifier) build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericProvider; - return _SystemHash.finish(hash); + return provider._copyWithBuild(build).createElement(container); + }, + ); } +} +abstract class _$Generic extends $Notifier { + int build(); + @$internal @override - String toString() => 'genericProvider<$A,$B>$argument'; + int runBuild() => build(); } -mixin GenericRef on AutoDisposeNotifierProviderRef {} - -class _GenericProviderElement - extends AutoDisposeNotifierProviderElement, int> - with GenericRef { - _GenericProviderElement(super.provider, super.container); -} +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index cef497eee..59489306c 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -6,244 +6,232 @@ part of 'convert_functional_provider_to_class_based.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'638d7db2be22eaad0f51ea0b3ae38e0483d43725'; - /// Some comment -/// -/// Copied from [example]. -@ProviderFor(example) -final exampleProvider = AutoDisposeProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeProviderRef; -String _$exampleFamilyHash() => r'f5547d3d88c42b135db5efea7dfaa542b3db9cc1'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} +typedef ExampleRef = Ref; /// Some comment -/// -/// Copied from [exampleFamily]. -@ProviderFor(exampleFamily) -const exampleFamilyProvider = ExampleFamilyFamily(); +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); /// Some comment -/// -/// Copied from [exampleFamily]. -class ExampleFamilyFamily extends Family { +final class ExampleProvider extends $FunctionalProvider + with $Provider { /// Some comment - /// - /// Copied from [exampleFamily]. - const ExampleFamilyFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - @override - Iterable? get dependencies => _dependencies; + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final int Function( + ExampleRef ref, + )? _createCb; @override - String? get name => r'exampleFamilyProvider'; + String debugGetCreateSourceHash() => _$exampleHash(); - /// Some comment - /// - /// Copied from [exampleFamily]. - ExampleFamilyProvider call({ - required int a, - String b = '42', - }) { - return ExampleFamilyProvider( - a: a, - b: b, + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(int Function(ExampleFamilyRef ref) create) { - return _$ExampleFamilyFamilyOverride(this, create); - } - - @override - String toString() => 'exampleFamilyProvider'; -} - -class _$ExampleFamilyFamilyOverride implements $FamilyOverride { - _$ExampleFamilyFamilyOverride(this.from, this.create); - - final int Function(ExampleFamilyRef ref) create; - @override - final ExampleFamilyFamily from; + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); @override - _ExampleFamilyProviderElement createElement( - ProviderContainer container, - covariant ExampleFamilyProvider provider, + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, ) { - return provider._copyWith(create).createElement(container); + return ExampleProvider._(create: create); } @override - String toString() => 'exampleFamilyProvider.overrideWith(...)'; + int create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } } +String _$exampleHash() => r'638d7db2be22eaad0f51ea0b3ae38e0483d43725'; + +/// Some comment +typedef ExampleFamilyRef = Ref; + +/// Some comment +@ProviderFor(exampleFamily) +const exampleFamilyProvider = ExampleFamilyFamily._(); + /// Some comment -/// -/// Copied from [exampleFamily]. -class ExampleFamilyProvider extends AutoDisposeProvider { +final class ExampleFamilyProvider + extends $FunctionalProvider + with $Provider { /// Some comment - /// - /// Copied from [exampleFamily]. - ExampleFamilyProvider({ - required int a, - String b = '42', - }) : this._internal( - (ref) => exampleFamily( - ref as ExampleFamilyRef, - a: a, - b: b, - ), - from: exampleFamilyProvider, + const ExampleFamilyProvider._( + {required ExampleFamilyFamily super.from, + required ({ + int a, + String b, + }) + super.argument, + int Function( + ExampleFamilyRef ref, { + required int a, + String b, + })? create}) + : _createCb = create, + super( name: r'exampleFamilyProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$exampleFamilyHash, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - a: a, - b: b, ); - ExampleFamilyProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.a, - required this.b, - }) : super.internal(); + final int Function( + ExampleFamilyRef ref, { + required int a, + String b, + })? _createCb; - final int a; - final String b; + @override + String debugGetCreateSourceHash() => _$exampleFamilyHash(); @override - Override overrideWith( - int Function(ExampleFamilyRef ref) create, - ) { + String toString() { + return r'exampleFamilyProvider' + '' + '$argument'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { return $ProviderOverride( origin: this, - providerOverride: ExampleFamilyProvider._internal( - (ref) => create(ref as ExampleFamilyRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - a: a, - b: b, - ), + providerOverride: $ValueProvider(value), ); } @override - ({ - int a, - String b, - }) get argument { - return ( - a: a, - b: b, - ); - } + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); @override - _ExampleFamilyProviderElement createElement( - ProviderContainer container, + ExampleFamilyProvider $copyWithCreate( + int Function( + ExampleFamilyRef ref, + ) create, ) { - return _ExampleFamilyProviderElement(this, container); + return ExampleFamilyProvider._( + argument: argument as ({ + int a, + String b, + }), + from: from! as ExampleFamilyFamily, + create: ( + ref, { + required int a, + String b = '42', + }) => + create(ref)); } - ExampleFamilyProvider _copyWith( - int Function(ExampleFamilyRef ref) create, - ) { - return ExampleFamilyProvider._internal( - (ref) => create(ref as ExampleFamilyRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - a: a, - b: b, + @override + int create(ExampleFamilyRef ref) { + final fn = _createCb ?? exampleFamily; + final ({ + int a, + String b, + }) argument = this.argument as ({ + int a, + String b, + }); + return fn( + ref, + a: argument.a, + b: argument.b, ); } @override bool operator ==(Object other) { - return other is ExampleFamilyProvider && other.a == a && other.b == b; + return other is ExampleFamilyProvider && other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, a.hashCode); - hash = _SystemHash.combine(hash, b.hashCode); - - return _SystemHash.finish(hash); + return argument.hashCode; } - - @override - String toString() => 'exampleFamilyProvider$argument'; } -mixin ExampleFamilyRef on AutoDisposeProviderRef { - /// The parameter `a` of this provider. - int get a; +String _$exampleFamilyHash() => r'f5547d3d88c42b135db5efea7dfaa542b3db9cc1'; - /// The parameter `b` of this provider. - String get b; -} +/// Some comment +final class ExampleFamilyFamily extends Family { + const ExampleFamilyFamily._() + : super( + name: r'exampleFamilyProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); -class _ExampleFamilyProviderElement extends AutoDisposeProviderElement - with ExampleFamilyRef { - _ExampleFamilyProviderElement(super.provider, super.container); + /// Some comment + ExampleFamilyProvider call({ + required int a, + String b = '42', + }) => + ExampleFamilyProvider._(argument: ( + a: a, + b: b, + ), from: this); @override - int get a => (origin as ExampleFamilyProvider).a; + String debugGetCreateSourceHash() => _$exampleFamilyHash(); + @override - String get b => (origin as ExampleFamilyProvider).b; + String toString() => r'exampleFamilyProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + int Function( + ExampleFamilyRef ref, + ({ + int a, + String b, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleFamilyProvider; + + final argument = provider.argument as ({ + int a, + String b, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/another.g.dart b/packages/riverpod_lint_flutter_test/test/lints/another.g.dart index a294d3fd5..3df36ad4b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/another.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/another.g.dart @@ -6,19 +6,64 @@ part of 'another.dart'; // RiverpodGenerator // ************************************************************************** -String _$bHash() => r'52593050701642f22b31c590f20c003dc2ee1579'; +typedef BRef = Ref; -/// See also [b]. @ProviderFor(b) -final bProvider = AutoDisposeProvider.internal( - b, - name: r'bProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$bHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef BRef = AutoDisposeProviderRef; +const bProvider = BProvider._(); + +final class BProvider extends $FunctionalProvider + with $Provider { + const BProvider._( + {int Function( + BRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'bProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + BRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$bHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + BProvider $copyWithCreate( + int Function( + BRef ref, + ) create, + ) { + return BProvider._(create: create); + } + + @override + int create(BRef ref) { + final fn = _createCb ?? b; + return fn(ref); + } +} + +String _$bHash() => r'52593050701642f22b31c590f20c003dc2ee1579'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index a7ab5177b..67f163c41 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -6,447 +6,428 @@ part of 'avoid_build_context_in_providers.dart'; // RiverpodGenerator // ************************************************************************** -String _$fnHash() => r'7b8d0cf179067c80b8553b3232fd886fac83f387'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} +typedef FnRef = Ref; -/// See also [fn]. @ProviderFor(fn) -const fnProvider = FnFamily(); - -/// See also [fn]. -class FnFamily extends Family { - /// See also [fn]. - const FnFamily(); +const fnProvider = FnFamily._(); + +final class FnProvider extends $FunctionalProvider + with $Provider { + const FnProvider._( + {required FnFamily super.from, + required ( + BuildContext, { + BuildContext context2, + }) + super.argument, + int Function( + FnRef ref, + BuildContext context1, { + required BuildContext context2, + })? create}) + : _createCb = create, + super( + name: r'fnProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - static const Iterable? _dependencies = null; + final int Function( + FnRef ref, + BuildContext context1, { + required BuildContext context2, + })? _createCb; - static const Iterable? _allTransitiveDependencies = null; + @override + String debugGetCreateSourceHash() => _$fnHash(); @override - Iterable? get dependencies => _dependencies; + String toString() { + return r'fnProvider' + '' + '$argument'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); @override - String? get name => r'fnProvider'; + FnProvider $copyWithCreate( + int Function( + FnRef ref, + ) create, + ) { + return FnProvider._( + argument: argument as ( + BuildContext, { + BuildContext context2, + }), + from: from! as FnFamily, + create: ( + ref, + BuildContext context1, { + required BuildContext context2, + }) => + create(ref)); + } - /// See also [fn]. - FnProvider call( - BuildContext context1, { - required BuildContext context2, - }) { - return FnProvider( - context1, - context2: context2, + @override + int create(FnRef ref) { + final fn = _createCb ?? fn; + final ( + BuildContext, { + BuildContext context2, + }) argument = this.argument as ( + BuildContext, { + BuildContext context2, + }); + return fn( + ref, + argument.$1, + context2: argument.context2, ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(int Function(FnRef ref) create) { - return _$FnFamilyOverride(this, create); + @override + bool operator ==(Object other) { + return other is FnProvider && other.argument == argument; } @override - String toString() => 'fnProvider'; + int get hashCode { + return argument.hashCode; + } } -class _$FnFamilyOverride implements $FamilyOverride { - _$FnFamilyOverride(this.from, this.create); +String _$fnHash() => r'7b8d0cf179067c80b8553b3232fd886fac83f387'; - final int Function(FnRef ref) create; +final class FnFamily extends Family { + const FnFamily._() + : super( + name: r'fnProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + FnProvider call( + BuildContext context1, { + required BuildContext context2, + }) => + FnProvider._(argument: ( + context1, + context2: context2, + ), from: this); @override - final FnFamily from; + String debugGetCreateSourceHash() => _$fnHash(); @override - _FnProviderElement createElement( - ProviderContainer container, - covariant FnProvider provider, + String toString() => r'fnProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + int Function( + FnRef ref, + ( + BuildContext, { + BuildContext context2, + }) args, + ) create, ) { - return provider._copyWith(create).createElement(container); + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FnProvider; + + final argument = provider.argument as ( + BuildContext, { + BuildContext context2, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'fnProvider.overrideWith(...)'; } -/// See also [fn]. -class FnProvider extends AutoDisposeProvider { - /// See also [fn]. - FnProvider( - BuildContext context1, { - required BuildContext context2, - }) : this._internal( - (ref) => fn( - ref as FnRef, - context1, - context2: context2, - ), - from: fnProvider, - name: r'fnProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$fnHash, +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierFamily._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {required MyNotifierFamily super.from, + required ( + BuildContext, { + BuildContext context2, + }) + super.argument, + super.runNotifierBuildOverride, + MyNotifier Function()? create}) + : _createCb = create, + super( + name: r'myNotifierProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - context1: context1, - context2: context2, ); - FnProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.context1, - required this.context2, - }) : super.internal(); + final MyNotifier Function()? _createCb; - final BuildContext context1; - final BuildContext context2; + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); @override - Override overrideWith( - int Function(FnRef ref) create, - ) { + String toString() { + return r'myNotifierProvider' + '' + '$argument'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { return $ProviderOverride( origin: this, - providerOverride: FnProvider._internal( - (ref) => create(ref as FnRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - context1: context1, - context2: context2, - ), + providerOverride: $ValueProvider(value), ); } + @$internal @override - ( - BuildContext, { - BuildContext context2, - }) get argument { - return ( - context1, - context2: context2, - ); - } + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + @$internal @override - _FnProviderElement createElement( - ProviderContainer container, + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, ) { - return _FnProviderElement(this, container); + return MyNotifierProvider._( + argument: argument as ( + BuildContext, { + BuildContext context2, + }), + from: from! as MyNotifierFamily, + create: create); } - FnProvider _copyWith( - int Function(FnRef ref) create, + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, ) { - return FnProvider._internal( - (ref) => create(ref as FnRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - context1: context1, - context2: context2, - ); + return MyNotifierProvider._( + argument: argument as ( + BuildContext, { + BuildContext context2, + }), + from: from! as MyNotifierFamily, + runNotifierBuildOverride: build); } + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + @override bool operator ==(Object other) { - return other is FnProvider && - other.context1 == context1 && - other.context2 == context2; + return other is MyNotifierProvider && other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, context1.hashCode); - hash = _SystemHash.combine(hash, context2.hashCode); - - return _SystemHash.finish(hash); + return argument.hashCode; } - - @override - String toString() => 'fnProvider$argument'; -} - -mixin FnRef on AutoDisposeProviderRef { - /// The parameter `context1` of this provider. - BuildContext get context1; - - /// The parameter `context2` of this provider. - BuildContext get context2; -} - -class _FnProviderElement extends AutoDisposeProviderElement with FnRef { - _FnProviderElement(super.provider, super.container); - - @override - BuildContext get context1 => (origin as FnProvider).context1; - @override - BuildContext get context2 => (origin as FnProvider).context2; } String _$myNotifierHash() => r'04a0cf33dbda80e3fa80748fe46546b1c968da22'; -abstract class _$MyNotifier extends BuildlessAutoDisposeNotifier { - late final BuildContext context1; - late final BuildContext context2; +final class MyNotifierFamily extends Family { + const MyNotifierFamily._() + : super( + name: r'myNotifierProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); - int build( + MyNotifierProvider call( BuildContext context1, { required BuildContext context2, - }); -} - -/// See also [MyNotifier]. -@ProviderFor(MyNotifier) -const myNotifierProvider = MyNotifierFamily(); - -/// See also [MyNotifier]. -class MyNotifierFamily extends Family { - /// See also [MyNotifier]. - const MyNotifierFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - @override - Iterable? get dependencies => _dependencies; + }) => + MyNotifierProvider._(argument: ( + context1, + context2: context2, + ), from: this); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$myNotifierHash(); @override - String? get name => r'myNotifierProvider'; + String toString() => r'myNotifierProvider'; - /// See also [MyNotifier]. - MyNotifierProvider call( - BuildContext context1, { - required BuildContext context2, - }) { - return MyNotifierProvider( - context1, - context2: context2, + /// {@macro riverpod.override_with} + Override overrideWith( + MyNotifier Function( + ( + BuildContext, { + BuildContext context2, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as MyNotifierProvider; + + final argument = provider.argument as ( + BuildContext, { + BuildContext context2, + }); + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(MyNotifier Function() create) { - return _$MyNotifierFamilyOverride(this, create); + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + int Function( + Ref ref, + MyNotifier notifier, + ( + BuildContext, { + BuildContext context2, + }) argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as MyNotifierProvider; + + final argument = provider.argument as ( + BuildContext, { + BuildContext context2, + }); + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'myNotifierProvider'; } -class _$MyNotifierFamilyOverride implements $FamilyOverride { - _$MyNotifierFamilyOverride(this.from, this.create); - - final MyNotifier Function() create; - - @override - final MyNotifierFamily from; - - @override - _MyNotifierProviderElement createElement( - ProviderContainer container, - covariant MyNotifierProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } +abstract class _$MyNotifier extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as ( + BuildContext, { + BuildContext context2, + }); + // expect_lint: avoid_build_context_in_providers + BuildContext get context1 => + _$args.$1; // expect_lint: avoid_build_context_in_providers + BuildContext get context2 => _$args.context2; + int build( + BuildContext context1, { + required BuildContext context2, + }); + @$internal @override - String toString() => 'myNotifierProvider.overrideWith(...)'; + int runBuild() => build( + _$args.$1, + context2: _$args.context2, + ); } -/// See also [MyNotifier]. -class MyNotifierProvider - extends AutoDisposeNotifierProviderImpl { - /// See also [MyNotifier]. - MyNotifierProvider( - BuildContext context1, { - required BuildContext context2, - }) : this._internal( - () => MyNotifier() - ..context1 = context1 - ..context2 = context2, - from: myNotifierProvider, - name: r'myNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$myNotifierHash, +@ProviderFor(Regresion2959) +const regresion2959Provider = Regresion2959Provider._(); + +final class Regresion2959Provider + extends $NotifierProvider { + const Regresion2959Provider._( + {super.runNotifierBuildOverride, Regresion2959 Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'regresion2959Provider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - context1: context1, - context2: context2, ); - MyNotifierProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.context1, - required this.context2, - }) : super.internal(); - - final BuildContext context1; - final BuildContext context2; + final Regresion2959 Function()? _createCb; @override - int runNotifierBuild( - covariant MyNotifier notifier, - ) { - return notifier.build( - context1, - context2: context2, - ); - } + String debugGetCreateSourceHash() => _$regresion2959Hash(); - @override - Override overrideWith(MyNotifier Function() create) { + /// {@macro riverpod.override_with_value} + Override overrideWithValue(void value) { return $ProviderOverride( origin: this, - providerOverride: MyNotifierProvider._internal( - () => create() - ..context1 = context1 - ..context2 = context2, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - context1: context1, - context2: context2, - ), + providerOverride: $ValueProvider(value), ); } + @$internal @override - ( - BuildContext, { - BuildContext context2, - }) get argument { - return ( - context1, - context2: context2, - ); - } + Regresion2959 create() => _createCb?.call() ?? Regresion2959(); + @$internal @override - _MyNotifierProviderElement createElement( - ProviderContainer container, + Regresion2959Provider $copyWithCreate( + Regresion2959 Function() create, ) { - return _MyNotifierProviderElement(this, container); - } - - MyNotifierProvider _copyWith( - MyNotifier Function() create, - ) { - return MyNotifierProvider._internal( - () => create() - ..context1 = context1 - ..context2 = context2, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - context1: context1, - context2: context2, - ); + return Regresion2959Provider._(create: create); } + @$internal @override - bool operator ==(Object other) { - return other is MyNotifierProvider && - other.context1 == context1 && - other.context2 == context2; - } - - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, context1.hashCode); - hash = _SystemHash.combine(hash, context2.hashCode); - - return _SystemHash.finish(hash); + Regresion2959Provider $copyWithBuild( + void Function( + Ref, + Regresion2959, + ) build, + ) { + return Regresion2959Provider._(runNotifierBuildOverride: build); } + @$internal @override - String toString() => 'myNotifierProvider$argument'; + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -mixin MyNotifierRef on AutoDisposeNotifierProviderRef { - /// The parameter `context1` of this provider. - BuildContext get context1; - - /// The parameter `context2` of this provider. - BuildContext get context2; -} - -class _MyNotifierProviderElement - extends AutoDisposeNotifierProviderElement - with MyNotifierRef { - _MyNotifierProviderElement(super.provider, super.container); +String _$regresion2959Hash() => r'bcf9a829ce75026a78569de680451d157c7d90a2'; +abstract class _$Regresion2959 extends $Notifier { + void build(); + @$internal @override - BuildContext get context1 => (origin as MyNotifierProvider).context1; - @override - BuildContext get context2 => (origin as MyNotifierProvider).context2; + void runBuild() => build(); } -String _$regresion2959Hash() => r'bcf9a829ce75026a78569de680451d157c7d90a2'; - -/// See also [Regresion2959]. -@ProviderFor(Regresion2959) -final regresion2959Provider = - AutoDisposeNotifierProvider.internal( - Regresion2959.new, - name: r'regresion2959Provider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$regresion2959Hash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Regresion2959 = AutoDisposeNotifier; +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index ac1ab29b7..137ae6019 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -6,209 +6,165 @@ part of 'avoid_public_notifier_properties.dart'; // RiverpodGenerator // ************************************************************************** -String _$generatedNotifierHash() => r'2b7f4fba816b6e8ccd0e8b7d11fcd207bbb79828'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -abstract class _$GeneratedNotifier extends BuildlessAutoDisposeNotifier { - late final int param; - - int build( - int param, - ); -} - -/// See also [GeneratedNotifier]. @ProviderFor(GeneratedNotifier) -const generatedNotifierProvider = GeneratedNotifierFamily(); - -/// See also [GeneratedNotifier]. -class GeneratedNotifierFamily extends Family { - /// See also [GeneratedNotifier]. - const GeneratedNotifierFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; +const generatedNotifierProvider = GeneratedNotifierFamily._(); + +final class GeneratedNotifierProvider + extends $NotifierProvider { + const GeneratedNotifierProvider._( + {required GeneratedNotifierFamily super.from, + required int super.argument, + super.runNotifierBuildOverride, + GeneratedNotifier Function()? create}) + : _createCb = create, + super( + name: r'generatedNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get dependencies => _dependencies; + final GeneratedNotifier Function()? _createCb; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$generatedNotifierHash(); @override - String? get name => r'generatedNotifierProvider'; - - /// See also [GeneratedNotifier]. - GeneratedNotifierProvider call( - int param, - ) { - return GeneratedNotifierProvider( - param, - ); + String toString() { + return r'generatedNotifierProvider' + '' + '($argument)'; } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(GeneratedNotifier Function() create) { - return _$GeneratedNotifierFamilyOverride(this, create); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); } + @$internal @override - String toString() => 'generatedNotifierProvider'; -} + GeneratedNotifier create() => _createCb?.call() ?? GeneratedNotifier(); -class _$GeneratedNotifierFamilyOverride implements $FamilyOverride { - _$GeneratedNotifierFamilyOverride(this.from, this.create); + @$internal + @override + GeneratedNotifierProvider $copyWithCreate( + GeneratedNotifier Function() create, + ) { + return GeneratedNotifierProvider._( + argument: argument as int, + from: from! as GeneratedNotifierFamily, + create: create); + } - final GeneratedNotifier Function() create; + @$internal + @override + GeneratedNotifierProvider $copyWithBuild( + int Function( + Ref, + GeneratedNotifier, + ) build, + ) { + return GeneratedNotifierProvider._( + argument: argument as int, + from: from! as GeneratedNotifierFamily, + runNotifierBuildOverride: build); + } + @$internal @override - final GeneratedNotifierFamily from; + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); @override - _GeneratedNotifierProviderElement createElement( - ProviderContainer container, - covariant GeneratedNotifierProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is GeneratedNotifierProvider && other.argument == argument; } @override - String toString() => 'generatedNotifierProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [GeneratedNotifier]. -class GeneratedNotifierProvider - extends AutoDisposeNotifierProviderImpl { - /// See also [GeneratedNotifier]. - GeneratedNotifierProvider( - int param, - ) : this._internal( - () => GeneratedNotifier()..param = param, - from: generatedNotifierProvider, +String _$generatedNotifierHash() => r'2b7f4fba816b6e8ccd0e8b7d11fcd207bbb79828'; + +final class GeneratedNotifierFamily extends Family { + const GeneratedNotifierFamily._() + : super( name: r'generatedNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$generatedNotifierHash, dependencies: null, allTransitiveDependencies: null, - param: param, + isAutoDispose: true, ); - GeneratedNotifierProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.param, - }) : super.internal(); - - final int param; - - @override - int runNotifierBuild( - covariant GeneratedNotifier notifier, - ) { - return notifier.build( - param, - ); - } + GeneratedNotifierProvider call( + int param, + ) => + GeneratedNotifierProvider._(argument: param, from: this); @override - Override overrideWith(GeneratedNotifier Function() create) { - return $ProviderOverride( - origin: this, - providerOverride: GeneratedNotifierProvider._internal( - () => create()..param = param, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - param: param, - ), - ); - } + String debugGetCreateSourceHash() => _$generatedNotifierHash(); @override - (int,) get argument { - return (param,); - } + String toString() => r'generatedNotifierProvider'; - @override - _GeneratedNotifierProviderElement createElement( - ProviderContainer container, + /// {@macro riverpod.override_with} + Override overrideWith( + GeneratedNotifier Function( + int args, + ) create, ) { - return _GeneratedNotifierProviderElement(this, container); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GeneratedNotifierProvider; - GeneratedNotifierProvider _copyWith( - GeneratedNotifier Function() create, - ) { - return GeneratedNotifierProvider._internal( - () => create()..param = param, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - param: param, + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, ); } - @override - bool operator ==(Object other) { - return other is GeneratedNotifierProvider && other.param == param; - } + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + int Function(Ref ref, GeneratedNotifier notifier, int argument) build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GeneratedNotifierProvider; - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, param.hashCode); + final argument = provider.argument as int; - return _SystemHash.finish(hash); + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'generatedNotifierProvider$argument'; -} - -mixin GeneratedNotifierRef on AutoDisposeNotifierProviderRef { - /// The parameter `param` of this provider. - int get param; } -class _GeneratedNotifierProviderElement - extends AutoDisposeNotifierProviderElement - with GeneratedNotifierRef { - _GeneratedNotifierProviderElement(super.provider, super.container); +abstract class _$GeneratedNotifier extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + int get param => _$args; + int build( + int param, + ); + @$internal @override - int get param => (origin as GeneratedNotifierProvider).param; + int runBuild() => build( + _$args, + ); } + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index 5614456e2..4b739a5f4 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -6,842 +6,1964 @@ part of 'dependencies.dart'; // RiverpodGenerator // ************************************************************************** +typedef UnimplementedScopedRef = Ref; + +@ProviderFor(unimplementedScoped) +const unimplementedScopedProvider = UnimplementedScopedProvider._(); + +final class UnimplementedScopedProvider + extends $FunctionalProvider + with $Provider { + const UnimplementedScopedProvider._( + {int Function( + UnimplementedScopedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'unimplementedScopedProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + UnimplementedScopedRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$unimplementedScopedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + UnimplementedScopedProvider $copyWithCreate( + int Function( + UnimplementedScopedRef ref, + ) create, + ) { + return UnimplementedScopedProvider._(create: create); + } + + @override + int create(UnimplementedScopedRef ref) { + final fn = _createCb ?? unimplementedScoped; + return fn(ref); + } +} + String _$unimplementedScopedHash() => r'5f32fc56f4157238612d62ef54038fe92b7cdfe8'; -/// See also [unimplementedScoped]. -@ProviderFor(unimplementedScoped) -final unimplementedScopedProvider = AutoDisposeProvider.internal( - (_) => throw UnsupportedError( - 'The provider "unimplementedScopedProvider" is expected to get overridden/scoped, ' - 'but was accessed without an override.', - ), - name: r'unimplementedScopedProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$unimplementedScopedHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef UnimplementedScopedRef = AutoDisposeProviderRef; -String _$depHash() => r'749c4d696d29c72686cabcabd6fa7855f5cbf4db'; +typedef DepRef = Ref; -/// See also [dep]. @ProviderFor(dep) -final depProvider = AutoDisposeProvider.internal( - dep, - name: r'depProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$depHash, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef DepRef = AutoDisposeProviderRef; -String _$generatedScopedHash() => r'2eefb4cc872ddccfeb862142fd5f7e6d8bd82159'; +const depProvider = DepProvider._(); + +final class DepProvider extends $FunctionalProvider + with $Provider { + const DepProvider._( + {int Function( + DepRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'depProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + DepRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$depHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DepProvider $copyWithCreate( + int Function( + DepRef ref, + ) create, + ) { + return DepProvider._(create: create); + } + + @override + int create(DepRef ref) { + final fn = _createCb ?? dep; + return fn(ref); + } +} + +String _$depHash() => r'749c4d696d29c72686cabcabd6fa7855f5cbf4db'; + +typedef GeneratedScopedRef = Ref; -/// See also [generatedScoped]. @ProviderFor(generatedScoped) -final generatedScopedProvider = AutoDisposeProvider.internal( - generatedScoped, - name: r'generatedScopedProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$generatedScopedHash, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef GeneratedScopedRef = AutoDisposeProviderRef; -String _$generatedRootHash() => r'080e3393566db0f44add3607e28a5a2980948704'; +const generatedScopedProvider = GeneratedScopedProvider._(); + +final class GeneratedScopedProvider + extends $FunctionalProvider + with $Provider { + const GeneratedScopedProvider._( + {int Function( + GeneratedScopedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'generatedScopedProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + GeneratedScopedRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$generatedScopedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + GeneratedScopedProvider $copyWithCreate( + int Function( + GeneratedScopedRef ref, + ) create, + ) { + return GeneratedScopedProvider._(create: create); + } + + @override + int create(GeneratedScopedRef ref) { + final fn = _createCb ?? generatedScoped; + return fn(ref); + } +} + +String _$generatedScopedHash() => r'2eefb4cc872ddccfeb862142fd5f7e6d8bd82159'; + +typedef GeneratedRootRef = Ref; -/// See also [generatedRoot]. @ProviderFor(generatedRoot) -final generatedRootProvider = AutoDisposeProvider.internal( - generatedRoot, - name: r'generatedRootProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$generatedRootHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef GeneratedRootRef = AutoDisposeProviderRef; +const generatedRootProvider = GeneratedRootProvider._(); + +final class GeneratedRootProvider + extends $FunctionalProvider + with $Provider { + const GeneratedRootProvider._( + {int Function( + GeneratedRootRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'generatedRootProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + GeneratedRootRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$generatedRootHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + GeneratedRootProvider $copyWithCreate( + int Function( + GeneratedRootRef ref, + ) create, + ) { + return GeneratedRootProvider._(create: create); + } + + @override + int create(GeneratedRootRef ref) { + final fn = _createCb ?? generatedRoot; + return fn(ref); + } +} + +String _$generatedRootHash() => r'080e3393566db0f44add3607e28a5a2980948704'; + +typedef WatchScopedButNoDependenciesRef = Ref; + +@ProviderFor(watchScopedButNoDependencies) +const watchScopedButNoDependenciesProvider = + WatchScopedButNoDependenciesProvider._(); + +final class WatchScopedButNoDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchScopedButNoDependenciesProvider._( + {int Function( + WatchScopedButNoDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchScopedButNoDependenciesProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + WatchScopedButNoDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$watchScopedButNoDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchScopedButNoDependenciesProvider $copyWithCreate( + int Function( + WatchScopedButNoDependenciesRef ref, + ) create, + ) { + return WatchScopedButNoDependenciesProvider._(create: create); + } + + @override + int create(WatchScopedButNoDependenciesRef ref) { + final fn = _createCb ?? watchScopedButNoDependencies; + return fn(ref); + } +} + String _$watchScopedButNoDependenciesHash() => r'3ec52c4ab2ea2b3204b7aa049d1756c01c014ff0'; -/// See also [watchScopedButNoDependencies]. -@ProviderFor(watchScopedButNoDependencies) -final watchScopedButNoDependenciesProvider = AutoDisposeProvider.internal( - watchScopedButNoDependencies, - name: r'watchScopedButNoDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchScopedButNoDependenciesHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef WatchScopedButNoDependenciesRef = AutoDisposeProviderRef; +typedef WatchExternalButNoDependenciesRef = Ref; + +@ProviderFor(watchExternalButNoDependencies) +const watchExternalButNoDependenciesProvider = + WatchExternalButNoDependenciesProvider._(); + +final class WatchExternalButNoDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchExternalButNoDependenciesProvider._( + {int Function( + WatchExternalButNoDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchExternalButNoDependenciesProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + WatchExternalButNoDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$watchExternalButNoDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchExternalButNoDependenciesProvider $copyWithCreate( + int Function( + WatchExternalButNoDependenciesRef ref, + ) create, + ) { + return WatchExternalButNoDependenciesProvider._(create: create); + } + + @override + int create(WatchExternalButNoDependenciesRef ref) { + final fn = _createCb ?? watchExternalButNoDependencies; + return fn(ref); + } +} + String _$watchExternalButNoDependenciesHash() => r'bbe1ed12645a261e2030222549308d378f5f368c'; -/// See also [watchExternalButNoDependencies]. -@ProviderFor(watchExternalButNoDependencies) -final watchExternalButNoDependenciesProvider = - AutoDisposeProvider.internal( - watchExternalButNoDependencies, - name: r'watchExternalButNoDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchExternalButNoDependenciesHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef WatchExternalButNoDependenciesRef = AutoDisposeProviderRef; +typedef WatchGeneratedScopedButNoDependenciesRef = Ref; + +@ProviderFor(watchGeneratedScopedButNoDependencies) +const watchGeneratedScopedButNoDependenciesProvider = + WatchGeneratedScopedButNoDependenciesProvider._(); + +final class WatchGeneratedScopedButNoDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchGeneratedScopedButNoDependenciesProvider._( + {int Function( + WatchGeneratedScopedButNoDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchGeneratedScopedButNoDependenciesProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + WatchGeneratedScopedButNoDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$watchGeneratedScopedButNoDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchGeneratedScopedButNoDependenciesProvider $copyWithCreate( + int Function( + WatchGeneratedScopedButNoDependenciesRef ref, + ) create, + ) { + return WatchGeneratedScopedButNoDependenciesProvider._(create: create); + } + + @override + int create(WatchGeneratedScopedButNoDependenciesRef ref) { + final fn = _createCb ?? watchGeneratedScopedButNoDependencies; + return fn(ref); + } +} + String _$watchGeneratedScopedButNoDependenciesHash() => r'2a4aba824078fe2c999260b4138939dee96c4fba'; -/// See also [watchGeneratedScopedButNoDependencies]. -@ProviderFor(watchGeneratedScopedButNoDependencies) -final watchGeneratedScopedButNoDependenciesProvider = - AutoDisposeProvider.internal( - watchGeneratedScopedButNoDependencies, - name: r'watchGeneratedScopedButNoDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchGeneratedScopedButNoDependenciesHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef WatchGeneratedScopedButNoDependenciesRef = AutoDisposeProviderRef; +typedef WatchRootButNoDependenciesRef = Ref; + +@ProviderFor(watchRootButNoDependencies) +const watchRootButNoDependenciesProvider = + WatchRootButNoDependenciesProvider._(); + +final class WatchRootButNoDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchRootButNoDependenciesProvider._( + {int Function( + WatchRootButNoDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchRootButNoDependenciesProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + WatchRootButNoDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$watchRootButNoDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchRootButNoDependenciesProvider $copyWithCreate( + int Function( + WatchRootButNoDependenciesRef ref, + ) create, + ) { + return WatchRootButNoDependenciesProvider._(create: create); + } + + @override + int create(WatchRootButNoDependenciesRef ref) { + final fn = _createCb ?? watchRootButNoDependencies; + return fn(ref); + } +} + String _$watchRootButNoDependenciesHash() => r'037187e333a5bd5d11d00147d179640b8a0f18dd'; -/// See also [watchRootButNoDependencies]. -@ProviderFor(watchRootButNoDependencies) -final watchRootButNoDependenciesProvider = AutoDisposeProvider.internal( - watchRootButNoDependencies, - name: r'watchRootButNoDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchRootButNoDependenciesHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef WatchRootButNoDependenciesRef = AutoDisposeProviderRef; -String _$watchGeneratedRootButNoDependenciesHash() => - r'ecf43cc257376d2828638ce937813d2b72b46967'; +typedef WatchGeneratedRootButNoDependenciesRef = Ref; + +@ProviderFor(watchGeneratedRootButNoDependencies) +const watchGeneratedRootButNoDependenciesProvider = + WatchGeneratedRootButNoDependenciesProvider._(); + +final class WatchGeneratedRootButNoDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchGeneratedRootButNoDependenciesProvider._( + {int Function( + WatchGeneratedRootButNoDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchGeneratedRootButNoDependenciesProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + WatchGeneratedRootButNoDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$watchGeneratedRootButNoDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchGeneratedRootButNoDependenciesProvider $copyWithCreate( + int Function( + WatchGeneratedRootButNoDependenciesRef ref, + ) create, + ) { + return WatchGeneratedRootButNoDependenciesProvider._(create: create); + } + + @override + int create(WatchGeneratedRootButNoDependenciesRef ref) { + final fn = _createCb ?? watchGeneratedRootButNoDependencies; + return fn(ref); + } +} + +String _$watchGeneratedRootButNoDependenciesHash() => + r'ecf43cc257376d2828638ce937813d2b72b46967'; + +typedef WatchScopedButEmptyDependenciesRef = Ref; + +@ProviderFor(watchScopedButEmptyDependencies) +const watchScopedButEmptyDependenciesProvider = + WatchScopedButEmptyDependenciesProvider._(); + +final class WatchScopedButEmptyDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchScopedButEmptyDependenciesProvider._( + {int Function( + WatchScopedButEmptyDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchScopedButEmptyDependenciesProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + WatchScopedButEmptyDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$watchScopedButEmptyDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchScopedButEmptyDependenciesProvider $copyWithCreate( + int Function( + WatchScopedButEmptyDependenciesRef ref, + ) create, + ) { + return WatchScopedButEmptyDependenciesProvider._(create: create); + } + + @override + int create(WatchScopedButEmptyDependenciesRef ref) { + final fn = _createCb ?? watchScopedButEmptyDependencies; + return fn(ref); + } +} + +String _$watchScopedButEmptyDependenciesHash() => + r'6b7526eb9dfd70c8249c71efffc60d612ca92f16'; + +typedef WatchGeneratedScopedButEmptyDependenciesRef = Ref; + +@ProviderFor(watchGeneratedScopedButEmptyDependencies) +const watchGeneratedScopedButEmptyDependenciesProvider = + WatchGeneratedScopedButEmptyDependenciesProvider._(); + +final class WatchGeneratedScopedButEmptyDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchGeneratedScopedButEmptyDependenciesProvider._( + {int Function( + WatchGeneratedScopedButEmptyDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchGeneratedScopedButEmptyDependenciesProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + WatchGeneratedScopedButEmptyDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$watchGeneratedScopedButEmptyDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchGeneratedScopedButEmptyDependenciesProvider $copyWithCreate( + int Function( + WatchGeneratedScopedButEmptyDependenciesRef ref, + ) create, + ) { + return WatchGeneratedScopedButEmptyDependenciesProvider._(create: create); + } + + @override + int create(WatchGeneratedScopedButEmptyDependenciesRef ref) { + final fn = _createCb ?? watchGeneratedScopedButEmptyDependencies; + return fn(ref); + } +} + +String _$watchGeneratedScopedButEmptyDependenciesHash() => + r'5dc6791ab2f661a378de3e8335943a48e8305435'; + +typedef WatchRootButEmptyDependenciesRef = Ref; + +@ProviderFor(watchRootButEmptyDependencies) +const watchRootButEmptyDependenciesProvider = + WatchRootButEmptyDependenciesProvider._(); + +final class WatchRootButEmptyDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchRootButEmptyDependenciesProvider._( + {int Function( + WatchRootButEmptyDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchRootButEmptyDependenciesProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + WatchRootButEmptyDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$watchRootButEmptyDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchRootButEmptyDependenciesProvider $copyWithCreate( + int Function( + WatchRootButEmptyDependenciesRef ref, + ) create, + ) { + return WatchRootButEmptyDependenciesProvider._(create: create); + } + + @override + int create(WatchRootButEmptyDependenciesRef ref) { + final fn = _createCb ?? watchRootButEmptyDependencies; + return fn(ref); + } +} + +String _$watchRootButEmptyDependenciesHash() => + r'c95800f6aec446737168ac8dc3e6edcaeeed3bc0'; + +typedef WatchGeneratedRootButEmptyDependenciesRef = Ref; + +@ProviderFor(watchGeneratedRootButEmptyDependencies) +const watchGeneratedRootButEmptyDependenciesProvider = + WatchGeneratedRootButEmptyDependenciesProvider._(); + +final class WatchGeneratedRootButEmptyDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchGeneratedRootButEmptyDependenciesProvider._( + {int Function( + WatchGeneratedRootButEmptyDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchGeneratedRootButEmptyDependenciesProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + WatchGeneratedRootButEmptyDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$watchGeneratedRootButEmptyDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchGeneratedRootButEmptyDependenciesProvider $copyWithCreate( + int Function( + WatchGeneratedRootButEmptyDependenciesRef ref, + ) create, + ) { + return WatchGeneratedRootButEmptyDependenciesProvider._(create: create); + } + + @override + int create(WatchGeneratedRootButEmptyDependenciesRef ref) { + final fn = _createCb ?? watchGeneratedRootButEmptyDependencies; + return fn(ref); + } +} + +String _$watchGeneratedRootButEmptyDependenciesHash() => + r'9fb97c1fa207a18870cd23c682305dcef413a706'; + +typedef WatchScopedButMissingDependenciesRef = Ref; + +@ProviderFor(watchScopedButMissingDependencies) +const watchScopedButMissingDependenciesProvider = + WatchScopedButMissingDependenciesProvider._(); + +final class WatchScopedButMissingDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchScopedButMissingDependenciesProvider._( + {int Function( + WatchScopedButMissingDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchScopedButMissingDependenciesProvider', + isAutoDispose: true, + dependencies: const [depProvider], + allTransitiveDependencies: const [ + WatchScopedButMissingDependenciesProvider + .$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + + final int Function( + WatchScopedButMissingDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$watchScopedButMissingDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchScopedButMissingDependenciesProvider $copyWithCreate( + int Function( + WatchScopedButMissingDependenciesRef ref, + ) create, + ) { + return WatchScopedButMissingDependenciesProvider._(create: create); + } + + @override + int create(WatchScopedButMissingDependenciesRef ref) { + final fn = _createCb ?? watchScopedButMissingDependencies; + return fn(ref); + } +} + +String _$watchScopedButMissingDependenciesHash() => + r'9bc337d57438161120d179de48443ed4be4c5b65'; + +typedef WatchGeneratedScopedButMissingDependenciesRef = Ref; + +@ProviderFor(watchGeneratedScopedButMissingDependencies) +const watchGeneratedScopedButMissingDependenciesProvider = + WatchGeneratedScopedButMissingDependenciesProvider._(); + +final class WatchGeneratedScopedButMissingDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchGeneratedScopedButMissingDependenciesProvider._( + {int Function( + WatchGeneratedScopedButMissingDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchGeneratedScopedButMissingDependenciesProvider', + isAutoDispose: true, + dependencies: const [depProvider], + allTransitiveDependencies: const [ + WatchGeneratedScopedButMissingDependenciesProvider + .$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + + final int Function( + WatchGeneratedScopedButMissingDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$watchGeneratedScopedButMissingDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchGeneratedScopedButMissingDependenciesProvider $copyWithCreate( + int Function( + WatchGeneratedScopedButMissingDependenciesRef ref, + ) create, + ) { + return WatchGeneratedScopedButMissingDependenciesProvider._(create: create); + } + + @override + int create(WatchGeneratedScopedButMissingDependenciesRef ref) { + final fn = _createCb ?? watchGeneratedScopedButMissingDependencies; + return fn(ref); + } +} + +String _$watchGeneratedScopedButMissingDependenciesHash() => + r'be4cf146ec2bebf4c92f6acd73e1dee60e689c20'; + +typedef WatchRootButMissingDependenciesRef = Ref; + +@ProviderFor(watchRootButMissingDependencies) +const watchRootButMissingDependenciesProvider = + WatchRootButMissingDependenciesProvider._(); + +final class WatchRootButMissingDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchRootButMissingDependenciesProvider._( + {int Function( + WatchRootButMissingDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchRootButMissingDependenciesProvider', + isAutoDispose: true, + dependencies: const [depProvider], + allTransitiveDependencies: const [ + WatchRootButMissingDependenciesProvider.$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + + final int Function( + WatchRootButMissingDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$watchRootButMissingDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchRootButMissingDependenciesProvider $copyWithCreate( + int Function( + WatchRootButMissingDependenciesRef ref, + ) create, + ) { + return WatchRootButMissingDependenciesProvider._(create: create); + } + + @override + int create(WatchRootButMissingDependenciesRef ref) { + final fn = _createCb ?? watchRootButMissingDependencies; + return fn(ref); + } +} + +String _$watchRootButMissingDependenciesHash() => + r'aa6ca4efaba18ad3d2132439f1bb26773cceb170'; + +typedef WatchGeneratedRootButMissingDependenciesRef = Ref; + +@ProviderFor(watchGeneratedRootButMissingDependencies) +const watchGeneratedRootButMissingDependenciesProvider = + WatchGeneratedRootButMissingDependenciesProvider._(); + +final class WatchGeneratedRootButMissingDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchGeneratedRootButMissingDependenciesProvider._( + {int Function( + WatchGeneratedRootButMissingDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchGeneratedRootButMissingDependenciesProvider', + isAutoDispose: true, + dependencies: const [depProvider], + allTransitiveDependencies: const [ + WatchGeneratedRootButMissingDependenciesProvider + .$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + + final int Function( + WatchGeneratedRootButMissingDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$watchGeneratedRootButMissingDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchGeneratedRootButMissingDependenciesProvider $copyWithCreate( + int Function( + WatchGeneratedRootButMissingDependenciesRef ref, + ) create, + ) { + return WatchGeneratedRootButMissingDependenciesProvider._(create: create); + } + + @override + int create(WatchGeneratedRootButMissingDependenciesRef ref) { + final fn = _createCb ?? watchGeneratedRootButMissingDependencies; + return fn(ref); + } +} + +String _$watchGeneratedRootButMissingDependenciesHash() => + r'eda2f1b9c3aaf26cd152108104b8bbb71774c906'; + +typedef WatchGeneratedScopedAndContainsDependencyRef = Ref; + +@ProviderFor(watchGeneratedScopedAndContainsDependency) +const watchGeneratedScopedAndContainsDependencyProvider = + WatchGeneratedScopedAndContainsDependencyProvider._(); + +final class WatchGeneratedScopedAndContainsDependencyProvider + extends $FunctionalProvider + with $Provider { + const WatchGeneratedScopedAndContainsDependencyProvider._( + {int Function( + WatchGeneratedScopedAndContainsDependencyRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchGeneratedScopedAndContainsDependencyProvider', + isAutoDispose: true, + dependencies: const [generatedScopedProvider], + allTransitiveDependencies: const [ + WatchGeneratedScopedAndContainsDependencyProvider + .$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = generatedScopedProvider; + + final int Function( + WatchGeneratedScopedAndContainsDependencyRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$watchGeneratedScopedAndContainsDependencyHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchGeneratedScopedAndContainsDependencyProvider $copyWithCreate( + int Function( + WatchGeneratedScopedAndContainsDependencyRef ref, + ) create, + ) { + return WatchGeneratedScopedAndContainsDependencyProvider._(create: create); + } + + @override + int create(WatchGeneratedScopedAndContainsDependencyRef ref) { + final fn = _createCb ?? watchGeneratedScopedAndContainsDependency; + return fn(ref); + } +} + +String _$watchGeneratedScopedAndContainsDependencyHash() => + r'320592737e763091c1229a79ae07fe961e7aab72'; + +typedef WatchGeneratedRootAndContainsDependencyRef = Ref; + +@ProviderFor(watchGeneratedRootAndContainsDependency) +const watchGeneratedRootAndContainsDependencyProvider = + WatchGeneratedRootAndContainsDependencyProvider._(); + +final class WatchGeneratedRootAndContainsDependencyProvider + extends $FunctionalProvider + with $Provider { + const WatchGeneratedRootAndContainsDependencyProvider._( + {int Function( + WatchGeneratedRootAndContainsDependencyRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'watchGeneratedRootAndContainsDependencyProvider', + isAutoDispose: true, + dependencies: const [generatedRootProvider], + allTransitiveDependencies: const [ + WatchGeneratedRootAndContainsDependencyProvider + .$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = generatedRootProvider; + + final int Function( + WatchGeneratedRootAndContainsDependencyRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$watchGeneratedRootAndContainsDependencyHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + WatchGeneratedRootAndContainsDependencyProvider $copyWithCreate( + int Function( + WatchGeneratedRootAndContainsDependencyRef ref, + ) create, + ) { + return WatchGeneratedRootAndContainsDependencyProvider._(create: create); + } + + @override + int create(WatchGeneratedRootAndContainsDependencyRef ref) { + final fn = _createCb ?? watchGeneratedRootAndContainsDependency; + return fn(ref); + } +} -/// See also [watchGeneratedRootButNoDependencies]. -@ProviderFor(watchGeneratedRootButNoDependencies) -final watchGeneratedRootButNoDependenciesProvider = - AutoDisposeProvider.internal( - watchGeneratedRootButNoDependencies, - name: r'watchGeneratedRootButNoDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchGeneratedRootButNoDependenciesHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef WatchGeneratedRootButNoDependenciesRef = AutoDisposeProviderRef; -String _$watchScopedButEmptyDependenciesHash() => - r'6b7526eb9dfd70c8249c71efffc60d612ca92f16'; +String _$watchGeneratedRootAndContainsDependencyHash() => + r'5bb8cc73e375ce8c5dbd03d5ca3c16fb2d5b199f'; -/// See also [watchScopedButEmptyDependencies]. -@ProviderFor(watchScopedButEmptyDependencies) -final watchScopedButEmptyDependenciesProvider = - AutoDisposeProvider.internal( - watchScopedButEmptyDependencies, - name: r'watchScopedButEmptyDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchScopedButEmptyDependenciesHash, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef WatchScopedButEmptyDependenciesRef = AutoDisposeProviderRef; -String _$watchGeneratedScopedButEmptyDependenciesHash() => - r'5dc6791ab2f661a378de3e8335943a48e8305435'; +typedef SpecifiedDependencyButNeverUsedRef = Ref; -/// See also [watchGeneratedScopedButEmptyDependencies]. -@ProviderFor(watchGeneratedScopedButEmptyDependencies) -final watchGeneratedScopedButEmptyDependenciesProvider = - AutoDisposeProvider.internal( - watchGeneratedScopedButEmptyDependencies, - name: r'watchGeneratedScopedButEmptyDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchGeneratedScopedButEmptyDependenciesHash, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef WatchGeneratedScopedButEmptyDependenciesRef - = AutoDisposeProviderRef; -String _$watchRootButEmptyDependenciesHash() => - r'c95800f6aec446737168ac8dc3e6edcaeeed3bc0'; +@ProviderFor(specifiedDependencyButNeverUsed) +const specifiedDependencyButNeverUsedProvider = + SpecifiedDependencyButNeverUsedProvider._(); + +final class SpecifiedDependencyButNeverUsedProvider + extends $FunctionalProvider + with $Provider { + const SpecifiedDependencyButNeverUsedProvider._( + {int Function( + SpecifiedDependencyButNeverUsedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'specifiedDependencyButNeverUsedProvider', + isAutoDispose: true, + dependencies: const [ + depProvider, + generatedRootProvider + ], + allTransitiveDependencies: const [ + SpecifiedDependencyButNeverUsedProvider.$allTransitiveDependencies0, + SpecifiedDependencyButNeverUsedProvider.$allTransitiveDependencies1, + ], + ); -/// See also [watchRootButEmptyDependencies]. -@ProviderFor(watchRootButEmptyDependencies) -final watchRootButEmptyDependenciesProvider = AutoDisposeProvider.internal( - watchRootButEmptyDependencies, - name: r'watchRootButEmptyDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchRootButEmptyDependenciesHash, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef WatchRootButEmptyDependenciesRef = AutoDisposeProviderRef; -String _$watchGeneratedRootButEmptyDependenciesHash() => - r'9fb97c1fa207a18870cd23c682305dcef413a706'; + static const $allTransitiveDependencies0 = depProvider; + static const $allTransitiveDependencies1 = generatedRootProvider; -/// See also [watchGeneratedRootButEmptyDependencies]. -@ProviderFor(watchGeneratedRootButEmptyDependencies) -final watchGeneratedRootButEmptyDependenciesProvider = - AutoDisposeProvider.internal( - watchGeneratedRootButEmptyDependencies, - name: r'watchGeneratedRootButEmptyDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchGeneratedRootButEmptyDependenciesHash, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef WatchGeneratedRootButEmptyDependenciesRef = AutoDisposeProviderRef; -String _$watchScopedButMissingDependenciesHash() => - r'9bc337d57438161120d179de48443ed4be4c5b65'; + final int Function( + SpecifiedDependencyButNeverUsedRef ref, + )? _createCb; -/// See also [watchScopedButMissingDependencies]. -@ProviderFor(watchScopedButMissingDependencies) -final watchScopedButMissingDependenciesProvider = - AutoDisposeProvider.internal( - watchScopedButMissingDependencies, - name: r'watchScopedButMissingDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchScopedButMissingDependenciesHash, - dependencies: [depProvider], - allTransitiveDependencies: { - depProvider, - ...?depProvider.allTransitiveDependencies - }, -); - -typedef WatchScopedButMissingDependenciesRef = AutoDisposeProviderRef; -String _$watchGeneratedScopedButMissingDependenciesHash() => - r'be4cf146ec2bebf4c92f6acd73e1dee60e689c20'; + @override + String debugGetCreateSourceHash() => _$specifiedDependencyButNeverUsedHash(); -/// See also [watchGeneratedScopedButMissingDependencies]. -@ProviderFor(watchGeneratedScopedButMissingDependencies) -final watchGeneratedScopedButMissingDependenciesProvider = - AutoDisposeProvider.internal( - watchGeneratedScopedButMissingDependencies, - name: r'watchGeneratedScopedButMissingDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchGeneratedScopedButMissingDependenciesHash, - dependencies: [depProvider], - allTransitiveDependencies: { - depProvider, - ...?depProvider.allTransitiveDependencies - }, -); - -typedef WatchGeneratedScopedButMissingDependenciesRef - = AutoDisposeProviderRef; -String _$watchRootButMissingDependenciesHash() => - r'aa6ca4efaba18ad3d2132439f1bb26773cceb170'; + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } -/// See also [watchRootButMissingDependencies]. -@ProviderFor(watchRootButMissingDependencies) -final watchRootButMissingDependenciesProvider = - AutoDisposeProvider.internal( - watchRootButMissingDependencies, - name: r'watchRootButMissingDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchRootButMissingDependenciesHash, - dependencies: [depProvider], - allTransitiveDependencies: { - depProvider, - ...?depProvider.allTransitiveDependencies - }, -); - -typedef WatchRootButMissingDependenciesRef = AutoDisposeProviderRef; -String _$watchGeneratedRootButMissingDependenciesHash() => - r'eda2f1b9c3aaf26cd152108104b8bbb71774c906'; + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); -/// See also [watchGeneratedRootButMissingDependencies]. -@ProviderFor(watchGeneratedRootButMissingDependencies) -final watchGeneratedRootButMissingDependenciesProvider = - AutoDisposeProvider.internal( - watchGeneratedRootButMissingDependencies, - name: r'watchGeneratedRootButMissingDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchGeneratedRootButMissingDependenciesHash, - dependencies: [depProvider], - allTransitiveDependencies: { - depProvider, - ...?depProvider.allTransitiveDependencies - }, -); - -typedef WatchGeneratedRootButMissingDependenciesRef - = AutoDisposeProviderRef; -String _$watchGeneratedScopedAndContainsDependencyHash() => - r'320592737e763091c1229a79ae07fe961e7aab72'; + @override + SpecifiedDependencyButNeverUsedProvider $copyWithCreate( + int Function( + SpecifiedDependencyButNeverUsedRef ref, + ) create, + ) { + return SpecifiedDependencyButNeverUsedProvider._(create: create); + } -/// See also [watchGeneratedScopedAndContainsDependency]. -@ProviderFor(watchGeneratedScopedAndContainsDependency) -final watchGeneratedScopedAndContainsDependencyProvider = - AutoDisposeProvider.internal( - watchGeneratedScopedAndContainsDependency, - name: r'watchGeneratedScopedAndContainsDependencyProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchGeneratedScopedAndContainsDependencyHash, - dependencies: [generatedScopedProvider], - allTransitiveDependencies: { - generatedScopedProvider, - ...?generatedScopedProvider.allTransitiveDependencies - }, -); - -typedef WatchGeneratedScopedAndContainsDependencyRef - = AutoDisposeProviderRef; -String _$watchGeneratedRootAndContainsDependencyHash() => - r'5bb8cc73e375ce8c5dbd03d5ca3c16fb2d5b199f'; + @override + int create(SpecifiedDependencyButNeverUsedRef ref) { + final fn = _createCb ?? specifiedDependencyButNeverUsed; + return fn(ref); + } +} -/// See also [watchGeneratedRootAndContainsDependency]. -@ProviderFor(watchGeneratedRootAndContainsDependency) -final watchGeneratedRootAndContainsDependencyProvider = - AutoDisposeProvider.internal( - watchGeneratedRootAndContainsDependency, - name: r'watchGeneratedRootAndContainsDependencyProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$watchGeneratedRootAndContainsDependencyHash, - dependencies: [generatedRootProvider], - allTransitiveDependencies: { - generatedRootProvider, - ...?generatedRootProvider.allTransitiveDependencies - }, -); - -typedef WatchGeneratedRootAndContainsDependencyRef - = AutoDisposeProviderRef; String _$specifiedDependencyButNeverUsedHash() => r'b0254ee8c3a0360ec249686083f430b12f3b4940'; -/// See also [specifiedDependencyButNeverUsed]. -@ProviderFor(specifiedDependencyButNeverUsed) -final specifiedDependencyButNeverUsedProvider = - AutoDisposeProvider.internal( - specifiedDependencyButNeverUsed, - name: r'specifiedDependencyButNeverUsedProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$specifiedDependencyButNeverUsedHash, - dependencies: [depProvider, generatedRootProvider], - allTransitiveDependencies: { - depProvider, - ...?depProvider.allTransitiveDependencies, - generatedRootProvider, - ...?generatedRootProvider.allTransitiveDependencies - }, -); - -typedef SpecifiedDependencyButNeverUsedRef = AutoDisposeProviderRef; -String _$regression2348Hash() => r'72fbbe420e9835c9843c28b7c9375ca3d99ca4b7'; +typedef Regression2348Ref = Ref; -/// See also [regression2348]. @ProviderFor(regression2348) -final regression2348Provider = AutoDisposeProvider.internal( - regression2348, - name: r'regression2348Provider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$regression2348Hash, - dependencies: [generatedScopedProvider], - allTransitiveDependencies: { - generatedScopedProvider, - ...?generatedScopedProvider.allTransitiveDependencies - }, -); - -typedef Regression2348Ref = AutoDisposeProviderRef; -String _$familyDepHash() => r'1c152873ed2b3e88da09d8e1fc53a33635cbe3b3'; +const regression2348Provider = Regression2348Provider._(); + +final class Regression2348Provider + extends $FunctionalProvider + with $Provider { + const Regression2348Provider._( + {int Function( + Regression2348Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'regression2348Provider', + isAutoDispose: true, + dependencies: const [generatedScopedProvider], + allTransitiveDependencies: const [ + Regression2348Provider.$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = generatedScopedProvider; + + final int Function( + Regression2348Ref ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$regression2348Hash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); + @override + Regression2348Provider $copyWithCreate( + int Function( + Regression2348Ref ref, + ) create, + ) { + return Regression2348Provider._(create: create); } - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + @override + int create(Regression2348Ref ref) { + final fn = _createCb ?? regression2348; + return fn(ref); } } -/// See also [familyDep]. -@ProviderFor(familyDep) -const familyDepProvider = FamilyDepFamily(); +String _$regression2348Hash() => r'72fbbe420e9835c9843c28b7c9375ca3d99ca4b7'; -/// See also [familyDep]. -class FamilyDepFamily extends Family { - /// See also [familyDep]. - const FamilyDepFamily(); +typedef FamilyDepRef = Ref; + +@ProviderFor(familyDep) +const familyDepProvider = FamilyDepFamily._(); + +final class FamilyDepProvider + extends $FunctionalProvider + with $Provider { + const FamilyDepProvider._( + {required FamilyDepFamily super.from, + required int super.argument, + int Function( + FamilyDepRef ref, + int p, + )? create}) + : _createCb = create, + super( + name: r'familyDepProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - static final Iterable _dependencies = [ - depProvider - ]; + static const $allTransitiveDependencies0 = depProvider; - static final Iterable _allTransitiveDependencies = - { - depProvider, - ...?depProvider.allTransitiveDependencies - }; + final int Function( + FamilyDepRef ref, + int p, + )? _createCb; @override - Iterable? get dependencies => _dependencies; + String debugGetCreateSourceHash() => _$familyDepHash(); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String toString() { + return r'familyDepProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } @override - String? get name => r'familyDepProvider'; + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); - /// See also [familyDep]. - FamilyDepProvider call( - int p, + @override + FamilyDepProvider $copyWithCreate( + int Function( + FamilyDepRef ref, + ) create, ) { - return FamilyDepProvider( - p, + return FamilyDepProvider._( + argument: argument as int, + from: from! as FamilyDepFamily, + create: ( + ref, + int p, + ) => + create(ref)); + } + + @override + int create(FamilyDepRef ref) { + final fn = _createCb ?? familyDep; + final int argument = this.argument as int; + return fn( + ref, + argument, ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(int Function(FamilyDepRef ref) create) { - return _$FamilyDepFamilyOverride(this, create); + @override + bool operator ==(Object other) { + return other is FamilyDepProvider && other.argument == argument; } @override - String toString() => 'familyDepProvider'; + int get hashCode { + return argument.hashCode; + } } -class _$FamilyDepFamilyOverride implements $FamilyOverride { - _$FamilyDepFamilyOverride(this.from, this.create); +String _$familyDepHash() => r'1c152873ed2b3e88da09d8e1fc53a33635cbe3b3'; + +final class FamilyDepFamily extends Family { + const FamilyDepFamily._() + : super( + name: r'familyDepProvider', + dependencies: const [depProvider], + allTransitiveDependencies: const [ + FamilyDepProvider.$allTransitiveDependencies0, + ], + isAutoDispose: true, + ); - final int Function(FamilyDepRef ref) create; + FamilyDepProvider call( + int p, + ) => + FamilyDepProvider._(argument: p, from: this); @override - final FamilyDepFamily from; + String debugGetCreateSourceHash() => _$familyDepHash(); @override - _FamilyDepProviderElement createElement( - ProviderContainer container, - covariant FamilyDepProvider provider, + String toString() => r'familyDepProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + int Function( + FamilyDepRef ref, + int args, + ) create, ) { - return provider._copyWith(create).createElement(container); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyDepProvider; - @override - String toString() => 'familyDepProvider.overrideWith(...)'; + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } -/// See also [familyDep]. -class FamilyDepProvider extends AutoDisposeProvider { - /// See also [familyDep]. - FamilyDepProvider( - int p, - ) : this._internal( - (ref) => familyDep( - ref as FamilyDepRef, - p, - ), - from: familyDepProvider, - name: r'familyDepProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyDepHash, +typedef FamilyDep2Ref = Ref; + +@ProviderFor(familyDep2) +const familyDep2Provider = FamilyDep2Family._(); + +final class FamilyDep2Provider + extends $FunctionalProvider + with $Provider { + const FamilyDep2Provider._( + {required FamilyDep2Family super.from, + required int super.argument, + int Function( + FamilyDep2Ref ref, + int p, + )? create}) + : _createCb = create, + super( + name: r'familyDep2Provider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - p: p, ); - FamilyDepProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.p, - }) : super.internal(); + static const $allTransitiveDependencies0 = familyDepProvider; + static const $allTransitiveDependencies1 = + FamilyDepProvider.$allTransitiveDependencies0; + + final int Function( + FamilyDep2Ref ref, + int p, + )? _createCb; - final int p; + @override + String debugGetCreateSourceHash() => _$familyDep2Hash(); @override - Override overrideWith( - int Function(FamilyDepRef ref) create, - ) { + String toString() { + return r'familyDep2Provider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { return $ProviderOverride( origin: this, - providerOverride: FamilyDepProvider._internal( - (ref) => create(ref as FamilyDepRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - p: p, - ), + providerOverride: $ValueProvider(value), ); } @override - (int,) get argument { - return (p,); - } + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); @override - _FamilyDepProviderElement createElement( - ProviderContainer container, + FamilyDep2Provider $copyWithCreate( + int Function( + FamilyDep2Ref ref, + ) create, ) { - return _FamilyDepProviderElement(this, container); + return FamilyDep2Provider._( + argument: argument as int, + from: from! as FamilyDep2Family, + create: ( + ref, + int p, + ) => + create(ref)); } - FamilyDepProvider _copyWith( - int Function(FamilyDepRef ref) create, - ) { - return FamilyDepProvider._internal( - (ref) => create(ref as FamilyDepRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - p: p, + @override + int create(FamilyDep2Ref ref) { + final fn = _createCb ?? familyDep2; + final int argument = this.argument as int; + return fn( + ref, + argument, ); } @override bool operator ==(Object other) { - return other is FamilyDepProvider && other.p == p; + return other is FamilyDep2Provider && other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, p.hashCode); - - return _SystemHash.finish(hash); + return argument.hashCode; } - - @override - String toString() => 'familyDepProvider$argument'; } -mixin FamilyDepRef on AutoDisposeProviderRef { - /// The parameter `p` of this provider. - int get p; -} +String _$familyDep2Hash() => r'd81e2e56d75dd08a695b834853a3a6cea99ea305'; + +final class FamilyDep2Family extends Family { + const FamilyDep2Family._() + : super( + name: r'familyDep2Provider', + dependencies: const [familyDepProvider], + allTransitiveDependencies: const [ + FamilyDep2Provider.$allTransitiveDependencies0, + FamilyDep2Provider.$allTransitiveDependencies1, + ], + isAutoDispose: true, + ); -class _FamilyDepProviderElement extends AutoDisposeProviderElement - with FamilyDepRef { - _FamilyDepProviderElement(super.provider, super.container); + FamilyDep2Provider call( + int p, + ) => + FamilyDep2Provider._(argument: p, from: this); @override - int get p => (origin as FamilyDepProvider).p; -} + String debugGetCreateSourceHash() => _$familyDep2Hash(); -String _$familyDep2Hash() => r'd81e2e56d75dd08a695b834853a3a6cea99ea305'; + @override + String toString() => r'familyDep2Provider'; -/// See also [familyDep2]. -@ProviderFor(familyDep2) -const familyDep2Provider = FamilyDep2Family(); + /// {@macro riverpod.override_with} + Override overrideWith( + int Function( + FamilyDep2Ref ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FamilyDep2Provider; -/// See also [familyDep2]. -class FamilyDep2Family extends Family { - /// See also [familyDep2]. - const FamilyDep2Family(); + final argument = provider.argument as int; - static final Iterable _dependencies = [ - familyDepProvider - ]; + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } +} - static final Iterable _allTransitiveDependencies = - { - familyDepProvider, - ...?familyDepProvider.allTransitiveDependencies - }; +typedef AliasRef = Ref; - @override - Iterable? get dependencies => _dependencies; +@ProviderFor(alias) +const aliasProvider = AliasProvider._(); + +final class AliasProvider extends $FunctionalProvider + with $Provider { + const AliasProvider._( + {int Function( + AliasRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'aliasProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + final int Function( + AliasRef ref, + )? _createCb; @override - String? get name => r'familyDep2Provider'; + String debugGetCreateSourceHash() => _$aliasHash(); - /// See also [familyDep2]. - FamilyDep2Provider call( - int p, - ) { - return FamilyDep2Provider( - p, + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), ); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(int Function(FamilyDep2Ref ref) create) { - return _$FamilyDep2FamilyOverride(this, create); + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + AliasProvider $copyWithCreate( + int Function( + AliasRef ref, + ) create, + ) { + return AliasProvider._(create: create); } @override - String toString() => 'familyDep2Provider'; + int create(AliasRef ref) { + final fn = _createCb ?? alias; + return fn(ref); + } } -class _$FamilyDep2FamilyOverride implements $FamilyOverride { - _$FamilyDep2FamilyOverride(this.from, this.create); +String _$aliasHash() => r'871c6c7ab22e4bbed2dc46917daf42e7fc1b9d88'; + +@ProviderFor(ClassWatchGeneratedRootButMissingDependencies) +const classWatchGeneratedRootButMissingDependenciesProvider = + ClassWatchGeneratedRootButMissingDependenciesProvider._(); + +final class ClassWatchGeneratedRootButMissingDependenciesProvider + extends $NotifierProvider { + const ClassWatchGeneratedRootButMissingDependenciesProvider._( + {super.runNotifierBuildOverride, + ClassWatchGeneratedRootButMissingDependencies Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'classWatchGeneratedRootButMissingDependenciesProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final ClassWatchGeneratedRootButMissingDependencies Function()? _createCb; + + @override + String debugGetCreateSourceHash() => + _$classWatchGeneratedRootButMissingDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } - final int Function(FamilyDep2Ref ref) create; + @$internal + @override + ClassWatchGeneratedRootButMissingDependencies create() => + _createCb?.call() ?? ClassWatchGeneratedRootButMissingDependencies(); + @$internal @override - final FamilyDep2Family from; + ClassWatchGeneratedRootButMissingDependenciesProvider $copyWithCreate( + ClassWatchGeneratedRootButMissingDependencies Function() create, + ) { + return ClassWatchGeneratedRootButMissingDependenciesProvider._( + create: create); + } + @$internal @override - _FamilyDep2ProviderElement createElement( - ProviderContainer container, - covariant FamilyDep2Provider provider, + ClassWatchGeneratedRootButMissingDependenciesProvider $copyWithBuild( + int Function( + Ref, + ClassWatchGeneratedRootButMissingDependencies, + ) build, ) { - return provider._copyWith(create).createElement(container); + return ClassWatchGeneratedRootButMissingDependenciesProvider._( + runNotifierBuildOverride: build); } + @$internal @override - String toString() => 'familyDep2Provider.overrideWith(...)'; + $NotifierProviderElement + createElement(ProviderContainer container) => + $NotifierProviderElement(this, container); } -/// See also [familyDep2]. -class FamilyDep2Provider extends AutoDisposeProvider { - /// See also [familyDep2]. - FamilyDep2Provider( - int p, - ) : this._internal( - (ref) => familyDep2( - ref as FamilyDep2Ref, - p, - ), - from: familyDep2Provider, - name: r'familyDep2Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$familyDep2Hash, - dependencies: null, - allTransitiveDependencies: null, - p: p, - ); +String _$classWatchGeneratedRootButMissingDependenciesHash() => + r'e36d7126a86ea9ded6dc66a6f33eabb2724455a9'; + +abstract class _$ClassWatchGeneratedRootButMissingDependencies + extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} - FamilyDep2Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.p, - }) : super.internal(); +@ProviderFor(ClassWatchGeneratedScopedButMissingDependencies) +const classWatchGeneratedScopedButMissingDependenciesProvider = + ClassWatchGeneratedScopedButMissingDependenciesProvider._(); + +final class ClassWatchGeneratedScopedButMissingDependenciesProvider + extends $NotifierProvider { + const ClassWatchGeneratedScopedButMissingDependenciesProvider._( + {super.runNotifierBuildOverride, + ClassWatchGeneratedScopedButMissingDependencies Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'classWatchGeneratedScopedButMissingDependenciesProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); - final int p; + final ClassWatchGeneratedScopedButMissingDependencies Function()? _createCb; @override - Override overrideWith( - int Function(FamilyDep2Ref ref) create, - ) { + String debugGetCreateSourceHash() => + _$classWatchGeneratedScopedButMissingDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { return $ProviderOverride( origin: this, - providerOverride: FamilyDep2Provider._internal( - (ref) => create(ref as FamilyDep2Ref), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - p: p, - ), + providerOverride: $ValueProvider(value), ); } + @$internal @override - (int,) get argument { - return (p,); - } + ClassWatchGeneratedScopedButMissingDependencies create() => + _createCb?.call() ?? ClassWatchGeneratedScopedButMissingDependencies(); + @$internal @override - _FamilyDep2ProviderElement createElement( - ProviderContainer container, + ClassWatchGeneratedScopedButMissingDependenciesProvider $copyWithCreate( + ClassWatchGeneratedScopedButMissingDependencies Function() create, ) { - return _FamilyDep2ProviderElement(this, container); + return ClassWatchGeneratedScopedButMissingDependenciesProvider._( + create: create); } - FamilyDep2Provider _copyWith( - int Function(FamilyDep2Ref ref) create, + @$internal + @override + ClassWatchGeneratedScopedButMissingDependenciesProvider $copyWithBuild( + int Function( + Ref, + ClassWatchGeneratedScopedButMissingDependencies, + ) build, ) { - return FamilyDep2Provider._internal( - (ref) => create(ref as FamilyDep2Ref), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - p: p, - ); + return ClassWatchGeneratedScopedButMissingDependenciesProvider._( + runNotifierBuildOverride: build); } + @$internal @override - bool operator ==(Object other) { - return other is FamilyDep2Provider && other.p == p; + $NotifierProviderElement + createElement(ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$classWatchGeneratedScopedButMissingDependenciesHash() => + r'f5a5ba5f572ee2d0654c89de9e991cef9f15b936'; + +abstract class _$ClassWatchGeneratedScopedButMissingDependencies + extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +@ProviderFor(Regression2417) +const regression2417Provider = Regression2417Provider._(); + +final class Regression2417Provider + extends $NotifierProvider { + const Regression2417Provider._( + {super.runNotifierBuildOverride, Regression2417 Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'regression2417Provider', + isAutoDispose: true, + dependencies: const [generatedScopedProvider], + allTransitiveDependencies: const [ + Regression2417Provider.$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = generatedScopedProvider; + + final Regression2417 Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$regression2417Hash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); } + @$internal @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, p.hashCode); + Regression2417 create() => _createCb?.call() ?? Regression2417(); - return _SystemHash.finish(hash); + @$internal + @override + Regression2417Provider $copyWithCreate( + Regression2417 Function() create, + ) { + return Regression2417Provider._(create: create); } + @$internal @override - String toString() => 'familyDep2Provider$argument'; -} + Regression2417Provider $copyWithBuild( + int Function( + Ref, + Regression2417, + ) build, + ) { + return Regression2417Provider._(runNotifierBuildOverride: build); + } -mixin FamilyDep2Ref on AutoDisposeProviderRef { - /// The parameter `p` of this provider. - int get p; + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -class _FamilyDep2ProviderElement extends AutoDisposeProviderElement - with FamilyDep2Ref { - _FamilyDep2ProviderElement(super.provider, super.container); +String _$regression2417Hash() => r'c9ac0ba44e849ea1460c79c1f676feba1b5400da'; +abstract class _$Regression2417 extends $Notifier { + int build(); + @$internal @override - int get p => (origin as FamilyDep2Provider).p; + int runBuild() => build(); } -String _$aliasHash() => r'871c6c7ab22e4bbed2dc46917daf42e7fc1b9d88'; +@ProviderFor(AliasClass) +const aliasClassProvider = AliasClassProvider._(); + +final class AliasClassProvider extends $NotifierProvider { + const AliasClassProvider._( + {super.runNotifierBuildOverride, AliasClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'aliasClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); -/// See also [alias]. -@ProviderFor(alias) -final aliasProvider = AutoDisposeProvider.internal( - alias, - name: r'aliasProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$aliasHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef AliasRef = AutoDisposeProviderRef; -String _$classWatchGeneratedRootButMissingDependenciesHash() => - r'e36d7126a86ea9ded6dc66a6f33eabb2724455a9'; + final AliasClass Function()? _createCb; -/// See also [ClassWatchGeneratedRootButMissingDependencies]. -@ProviderFor(ClassWatchGeneratedRootButMissingDependencies) -final classWatchGeneratedRootButMissingDependenciesProvider = - AutoDisposeNotifierProvider.internal( - ClassWatchGeneratedRootButMissingDependencies.new, - name: r'classWatchGeneratedRootButMissingDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$classWatchGeneratedRootButMissingDependenciesHash, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef _$ClassWatchGeneratedRootButMissingDependencies - = AutoDisposeNotifier; -String _$classWatchGeneratedScopedButMissingDependenciesHash() => - r'f5a5ba5f572ee2d0654c89de9e991cef9f15b936'; + @override + String debugGetCreateSourceHash() => _$aliasClassHash(); -/// See also [ClassWatchGeneratedScopedButMissingDependencies]. -@ProviderFor(ClassWatchGeneratedScopedButMissingDependencies) -final classWatchGeneratedScopedButMissingDependenciesProvider = - AutoDisposeNotifierProvider.internal( - ClassWatchGeneratedScopedButMissingDependencies.new, - name: r'classWatchGeneratedScopedButMissingDependenciesProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$classWatchGeneratedScopedButMissingDependenciesHash, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef _$ClassWatchGeneratedScopedButMissingDependencies - = AutoDisposeNotifier; -String _$regression2417Hash() => r'c9ac0ba44e849ea1460c79c1f676feba1b5400da'; + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + AliasClass create() => _createCb?.call() ?? AliasClass(); + + @$internal + @override + AliasClassProvider $copyWithCreate( + AliasClass Function() create, + ) { + return AliasClassProvider._(create: create); + } + + @$internal + @override + AliasClassProvider $copyWithBuild( + int Function( + Ref, + AliasClass, + ) build, + ) { + return AliasClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} -/// See also [Regression2417]. -@ProviderFor(Regression2417) -final regression2417Provider = - AutoDisposeNotifierProvider.internal( - Regression2417.new, - name: r'regression2417Provider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$regression2417Hash, - dependencies: [generatedScopedProvider], - allTransitiveDependencies: { - generatedScopedProvider, - ...?generatedScopedProvider.allTransitiveDependencies - }, -); - -typedef _$Regression2417 = AutoDisposeNotifier; String _$aliasClassHash() => r'f5c1f43e7541638274ca7dc334a713763c9c8071'; -/// See also [AliasClass]. -@ProviderFor(AliasClass) -final aliasClassProvider = - AutoDisposeNotifierProvider.internal( - AliasClass.new, - name: r'aliasClassProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$aliasClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$AliasClass = AutoDisposeNotifier; +abstract class _$AliasClass extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 3f25e19a8..098a7917f 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -6,670 +6,606 @@ part of 'functional_ref.dart'; // RiverpodGenerator // ************************************************************************** -String _$namelessHash() => r'1a2aa61445a64c65301051820b159c5998195606'; +typedef NamelessRef = Ref; -/// See also [nameless]. @ProviderFor(nameless) -final namelessProvider = AutoDisposeProvider.internal( - nameless, - name: r'namelessProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$namelessHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef NamelessRef = AutoDisposeProviderRef; -String _$scopedHash() => r'590f1a203323105e732397a2616fbd7dac65f0cc'; - -/// See also [scoped]. -@ProviderFor(scoped) -final scopedProvider = AutoDisposeProvider.internal( - (_) => throw UnsupportedError( - 'The provider "scopedProvider" is expected to get overridden/scoped, ' - 'but was accessed without an override.', - ), - name: r'scopedProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$scopedHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ScopedRef = AutoDisposeProviderRef; -String _$genericsHash() => r'b5813cf6a00581bafea48d8ab66f7d5468fff0e4'; +const namelessProvider = NamelessProvider._(); + +final class NamelessProvider extends $FunctionalProvider + with $Provider { + const NamelessProvider._( + {int Function( + NamelessRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'namelessProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); + final int Function( + NamelessRef ref, + )? _createCb; - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } + @override + String debugGetCreateSourceHash() => _$namelessHash(); - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); } -} - -/// See also [generics]. -@ProviderFor(generics) -const genericsProvider = GenericsFamily(); - -/// See also [generics]. -class GenericsFamily extends Family { - /// See also [generics]. - const GenericsFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; @override - Iterable? get dependencies => _dependencies; + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + NamelessProvider $copyWithCreate( + int Function( + NamelessRef ref, + ) create, + ) { + return NamelessProvider._(create: create); + } @override - String? get name => r'genericsProvider'; - - /// See also [generics]. - GenericsProvider call() { - return GenericsProvider(); + int create(NamelessRef ref) { + final fn = _createCb ?? nameless; + return fn(ref); } +} - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith( - int Function(GenericsRef ref) create) { - return _$GenericsFamilyOverride(this, create); - } +String _$namelessHash() => r'1a2aa61445a64c65301051820b159c5998195606'; - @override - String toString() => 'genericsProvider'; -} +typedef ScopedRef = Ref; -class _$GenericsFamilyOverride implements $FamilyOverride { - _$GenericsFamilyOverride(this.from, this.create); +@ProviderFor(scoped) +const scopedProvider = ScopedProvider._(); + +final class ScopedProvider extends $FunctionalProvider + with $Provider { + const ScopedProvider._( + {int Function( + ScopedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'scopedProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - final int Function(GenericsRef ref) create; + final int Function( + ScopedRef ref, + )? _createCb; @override - final GenericsFamily from; + String debugGetCreateSourceHash() => _$scopedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } @override - _GenericsProviderElement createElement( - ProviderContainer container, - covariant GenericsProvider provider, + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ScopedProvider $copyWithCreate( + int Function( + ScopedRef ref, + ) create, ) { - return provider._copyWith(create).createElement(container); + return ScopedProvider._(create: create); } @override - String toString() => 'genericsProvider.overrideWith(...)'; + int create(ScopedRef ref) { + final fn = _createCb ?? scoped; + return fn(ref); + } } -/// See also [generics]. -class GenericsProvider extends AutoDisposeProvider { - /// See also [generics]. - GenericsProvider() - : this._internal( - (ref) => generics( - ref as GenericsRef, - ), - from: genericsProvider, +String _$scopedHash() => r'590f1a203323105e732397a2616fbd7dac65f0cc'; + +typedef GenericsRef = Ref; + +@ProviderFor(generics) +const genericsProvider = GenericsFamily._(); + +final class GenericsProvider + extends $FunctionalProvider> + with $Provider> { + const GenericsProvider._( + {required GenericsFamily super.from, + int Function( + GenericsRef ref, + )? create}) + : _createCb = create, + super( + argument: null, name: r'genericsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericsHash, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - GenericsProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); + final int Function( + GenericsRef ref, + )? _createCb; @override - Override overrideWith( - int Function(GenericsRef ref) create, + String debugGetCreateSourceHash() => _$genericsHash(); + + GenericsProvider _copyWithCreate( + int Function( + GenericsRef ref, + ) create, ) { + return GenericsProvider._( + from: from! as GenericsFamily, create: create); + } + + @override + String toString() { + return r'genericsProvider' + '<${A}, ${B}>' + '()'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { return $ProviderOverride( origin: this, - providerOverride: GenericsProvider._internal( - (ref) => create(ref as GenericsRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), + providerOverride: $ValueProvider(value), ); } @override - () get argument { - return (); - } + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); @override - _GenericsProviderElement createElement( - ProviderContainer container, + GenericsProvider $copyWithCreate( + int Function( + GenericsRef ref, + ) create, ) { - return _GenericsProviderElement(this, container); + return GenericsProvider._( + from: from! as GenericsFamily, create: create); } - GenericsProvider _copyWith( - int Function(GenericsRef ref) create, - ) { - return GenericsProvider._internal( - (ref) => create(ref as GenericsRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - ); + @override + int create(GenericsRef ref) { + final fn = _createCb ?? generics; + return fn(ref); } @override bool operator ==(Object other) { - return other is GenericsProvider && other.runtimeType == runtimeType; + return other is GenericsProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, A.hashCode); - hash = _SystemHash.combine(hash, B.hashCode); - - return _SystemHash.finish(hash); + return Object.hash(runtimeType, argument); } - - @override - String toString() => 'genericsProvider<$A,$B>$argument'; } -mixin GenericsRef on AutoDisposeProviderRef {} - -class _GenericsProviderElement - extends AutoDisposeProviderElement with GenericsRef { - _GenericsProviderElement(super.provider, super.container); -} - -String _$noGenericsHash() => r'449264e25990bc14ad811c0940117c8cde4d730a'; - -/// See also [noGenerics]. -@ProviderFor(noGenerics) -const noGenericsProvider = NoGenericsFamily(); - -/// See also [noGenerics]. -class NoGenericsFamily extends Family { - /// See also [noGenerics]. - const NoGenericsFamily(); - - static const Iterable? _dependencies = null; +String _$genericsHash() => r'b5813cf6a00581bafea48d8ab66f7d5468fff0e4'; - static const Iterable? _allTransitiveDependencies = null; +final class GenericsFamily extends Family { + const GenericsFamily._() + : super( + name: r'genericsProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); - @override - Iterable? get dependencies => _dependencies; + GenericsProvider call() => + GenericsProvider._(from: this); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$genericsHash(); @override - String? get name => r'noGenericsProvider'; + String toString() => r'genericsProvider'; - /// See also [noGenerics]. - NoGenericsProvider call() { - return NoGenericsProvider(); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. + /// {@macro riverpod.override_with} Override overrideWith( - int Function(NoGenericsRef ref) create) { - return _$NoGenericsFamilyOverride(this, create); - } - - @override - String toString() => 'noGenericsProvider'; -} - -class _$NoGenericsFamilyOverride implements $FamilyOverride { - _$NoGenericsFamilyOverride(this.from, this.create); - - final int Function(NoGenericsRef ref) create; - - @override - final NoGenericsFamily from; - - @override - _NoGenericsProviderElement createElement( - ProviderContainer container, - covariant NoGenericsProvider provider, + int Function(GenericsRef ref) create, ) { - return provider._copyWith(create).createElement(container); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericsProvider; - @override - String toString() => 'noGenericsProvider.overrideWith(...)'; + return provider._copyWithCreate(create).createElement(container); + }, + ); + } } -/// See also [noGenerics]. -class NoGenericsProvider extends AutoDisposeProvider { - /// See also [noGenerics]. - NoGenericsProvider() - : this._internal( - (ref) => noGenerics( - ref as NoGenericsRef, - ), - from: noGenericsProvider, +typedef NoGenericsRef = Ref; + +@ProviderFor(noGenerics) +const noGenericsProvider = NoGenericsFamily._(); + +final class NoGenericsProvider + extends $FunctionalProvider> + with $Provider> { + const NoGenericsProvider._( + {required NoGenericsFamily super.from, + int Function( + NoGenericsRef ref, + )? create}) + : _createCb = create, + super( + argument: null, name: r'noGenericsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$noGenericsHash, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - NoGenericsProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); + final int Function( + NoGenericsRef ref, + )? _createCb; @override - Override overrideWith( - int Function(NoGenericsRef ref) create, + String debugGetCreateSourceHash() => _$noGenericsHash(); + + NoGenericsProvider _copyWithCreate( + int Function( + NoGenericsRef ref, + ) create, ) { + return NoGenericsProvider._( + from: from! as NoGenericsFamily, create: create); + } + + @override + String toString() { + return r'noGenericsProvider' + '<${A}, ${B}>' + '()'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { return $ProviderOverride( origin: this, - providerOverride: NoGenericsProvider._internal( - (ref) => create(ref as NoGenericsRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), + providerOverride: $ValueProvider(value), ); } @override - () get argument { - return (); - } + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); @override - _NoGenericsProviderElement createElement( - ProviderContainer container, + NoGenericsProvider $copyWithCreate( + int Function( + NoGenericsRef ref, + ) create, ) { - return _NoGenericsProviderElement(this, container); + return NoGenericsProvider._( + from: from! as NoGenericsFamily, create: create); } - NoGenericsProvider _copyWith( - int Function(NoGenericsRef ref) create, - ) { - return NoGenericsProvider._internal( - (ref) => create(ref as NoGenericsRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - ); + @override + int create(NoGenericsRef ref) { + final fn = _createCb ?? noGenerics; + return fn(ref); } @override bool operator ==(Object other) { - return other is NoGenericsProvider && other.runtimeType == runtimeType; + return other is NoGenericsProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, A.hashCode); - hash = _SystemHash.combine(hash, B.hashCode); - - return _SystemHash.finish(hash); + return Object.hash(runtimeType, argument); } - - @override - String toString() => 'noGenericsProvider<$A,$B>$argument'; } -mixin NoGenericsRef on AutoDisposeProviderRef {} - -class _NoGenericsProviderElement - extends AutoDisposeProviderElement with NoGenericsRef { - _NoGenericsProviderElement(super.provider, super.container); -} - -String _$missingGenericsHash() => r'7d8bc49e4f1e466260fbf6a61a3f9e62b4aef28f'; - -/// See also [missingGenerics]. -@ProviderFor(missingGenerics) -const missingGenericsProvider = MissingGenericsFamily(); - -/// See also [missingGenerics]. -class MissingGenericsFamily extends Family { - /// See also [missingGenerics]. - const MissingGenericsFamily(); - - static const Iterable? _dependencies = null; +String _$noGenericsHash() => r'449264e25990bc14ad811c0940117c8cde4d730a'; - static const Iterable? _allTransitiveDependencies = null; +final class NoGenericsFamily extends Family { + const NoGenericsFamily._() + : super( + name: r'noGenericsProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); - @override - Iterable? get dependencies => _dependencies; + NoGenericsProvider call() => + NoGenericsProvider._(from: this); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$noGenericsHash(); @override - String? get name => r'missingGenericsProvider'; + String toString() => r'noGenericsProvider'; - /// See also [missingGenerics]. - MissingGenericsProvider call() { - return MissingGenericsProvider(); - } + /// {@macro riverpod.override_with} + Override overrideWith( + int Function(NoGenericsRef ref) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as NoGenericsProvider; - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(int Function(MissingGenericsRef ref) create) { - return _$MissingGenericsFamilyOverride(this, create); + return provider._copyWithCreate(create).createElement(container); + }, + ); } - - @override - String toString() => 'missingGenericsProvider'; } -class _$MissingGenericsFamilyOverride implements $FamilyOverride { - _$MissingGenericsFamilyOverride(this.from, this.create); - - final int Function(MissingGenericsRef ref) create; - - @override - final MissingGenericsFamily from; - - @override - _MissingGenericsProviderElement createElement( - ProviderContainer container, - covariant MissingGenericsProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'missingGenericsProvider.overrideWith(...)'; -} +typedef MissingGenericsRef = Ref; -/// See also [missingGenerics]. -class MissingGenericsProvider extends AutoDisposeProvider { - /// See also [missingGenerics]. - MissingGenericsProvider() - : this._internal( - (ref) => missingGenerics( - ref as MissingGenericsRef, - ), - from: missingGenericsProvider, +@ProviderFor(missingGenerics) +const missingGenericsProvider = MissingGenericsFamily._(); + +final class MissingGenericsProvider + extends $FunctionalProvider> + with $Provider> { + const MissingGenericsProvider._( + {required MissingGenericsFamily super.from, + int Function( + MissingGenericsRef ref, + )? create}) + : _createCb = create, + super( + argument: null, name: r'missingGenericsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$missingGenericsHash, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - MissingGenericsProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); + final int Function( + MissingGenericsRef ref, + )? _createCb; @override - Override overrideWith( - int Function(MissingGenericsRef ref) create, + String debugGetCreateSourceHash() => _$missingGenericsHash(); + + MissingGenericsProvider _copyWithCreate( + int Function( + MissingGenericsRef ref, + ) create, ) { + return MissingGenericsProvider._( + from: from! as MissingGenericsFamily, create: create); + } + + @override + String toString() { + return r'missingGenericsProvider' + '<${A}, ${B}>' + '()'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { return $ProviderOverride( origin: this, - providerOverride: MissingGenericsProvider._internal( - (ref) => create(ref as MissingGenericsRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), + providerOverride: $ValueProvider(value), ); } @override - () get argument { - return (); - } + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); @override - _MissingGenericsProviderElement createElement( - ProviderContainer container, + MissingGenericsProvider $copyWithCreate( + int Function( + MissingGenericsRef ref, + ) create, ) { - return _MissingGenericsProviderElement(this, container); + return MissingGenericsProvider._( + from: from! as MissingGenericsFamily, create: create); } - MissingGenericsProvider _copyWith( - int Function(MissingGenericsRef ref) create, - ) { - return MissingGenericsProvider._internal( - (ref) => create(ref as MissingGenericsRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - ); + @override + int create(MissingGenericsRef ref) { + final fn = _createCb ?? missingGenerics; + return fn(ref); } @override bool operator ==(Object other) { - return other is MissingGenericsProvider && other.runtimeType == runtimeType; + return other is MissingGenericsProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, A.hashCode); - hash = _SystemHash.combine(hash, B.hashCode); - - return _SystemHash.finish(hash); + return Object.hash(runtimeType, argument); } - - @override - String toString() => 'missingGenericsProvider<$A,$B>$argument'; } -mixin MissingGenericsRef on AutoDisposeProviderRef {} - -class _MissingGenericsProviderElement - extends AutoDisposeProviderElement with MissingGenericsRef { - _MissingGenericsProviderElement(super.provider, super.container); -} - -String _$wrongOrderHash() => r'6732863e85b220c07f82c2d13be15c1e6f08192d'; - -/// See also [wrongOrder]. -@ProviderFor(wrongOrder) -const wrongOrderProvider = WrongOrderFamily(); - -/// See also [wrongOrder]. -class WrongOrderFamily extends Family { - /// See also [wrongOrder]. - const WrongOrderFamily(); - - static const Iterable? _dependencies = null; +String _$missingGenericsHash() => r'7d8bc49e4f1e466260fbf6a61a3f9e62b4aef28f'; - static const Iterable? _allTransitiveDependencies = null; +final class MissingGenericsFamily extends Family { + const MissingGenericsFamily._() + : super( + name: r'missingGenericsProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); - @override - Iterable? get dependencies => _dependencies; + MissingGenericsProvider call() => + MissingGenericsProvider._(from: this); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$missingGenericsHash(); @override - String? get name => r'wrongOrderProvider'; + String toString() => r'missingGenericsProvider'; - /// See also [wrongOrder]. - WrongOrderProvider call() { - return WrongOrderProvider(); - } + /// {@macro riverpod.override_with} + Override overrideWith( + int Function(MissingGenericsRef ref) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as MissingGenericsProvider; - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(int Function(WrongOrderRef ref) create) { - return _$WrongOrderFamilyOverride(this, create); + return provider._copyWithCreate(create).createElement(container); + }, + ); } - - @override - String toString() => 'wrongOrderProvider'; } -class _$WrongOrderFamilyOverride implements $FamilyOverride { - _$WrongOrderFamilyOverride(this.from, this.create); - - final int Function(WrongOrderRef ref) create; +typedef WrongOrderRef = Ref; - @override - final WrongOrderFamily from; - - @override - _WrongOrderProviderElement createElement( - ProviderContainer container, - covariant WrongOrderProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'wrongOrderProvider.overrideWith(...)'; -} - -/// See also [wrongOrder]. -class WrongOrderProvider extends AutoDisposeProvider { - /// See also [wrongOrder]. - WrongOrderProvider() - : this._internal( - (ref) => wrongOrder( - ref as WrongOrderRef, - ), - from: wrongOrderProvider, +@ProviderFor(wrongOrder) +const wrongOrderProvider = WrongOrderFamily._(); + +final class WrongOrderProvider + extends $FunctionalProvider> + with $Provider> { + const WrongOrderProvider._( + {required WrongOrderFamily super.from, + int Function( + WrongOrderRef ref, + )? create}) + : _createCb = create, + super( + argument: null, name: r'wrongOrderProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$wrongOrderHash, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - WrongOrderProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); + final int Function( + WrongOrderRef ref, + )? _createCb; @override - Override overrideWith( - int Function(WrongOrderRef ref) create, + String debugGetCreateSourceHash() => _$wrongOrderHash(); + + WrongOrderProvider _copyWithCreate( + int Function( + WrongOrderRef ref, + ) create, ) { + return WrongOrderProvider._( + from: from! as WrongOrderFamily, create: create); + } + + @override + String toString() { + return r'wrongOrderProvider' + '<${B}, ${A}>' + '()'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { return $ProviderOverride( origin: this, - providerOverride: WrongOrderProvider._internal( - (ref) => create(ref as WrongOrderRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), + providerOverride: $ValueProvider(value), ); } @override - () get argument { - return (); - } + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); @override - _WrongOrderProviderElement createElement( - ProviderContainer container, + WrongOrderProvider $copyWithCreate( + int Function( + WrongOrderRef ref, + ) create, ) { - return _WrongOrderProviderElement(this, container); + return WrongOrderProvider._( + from: from! as WrongOrderFamily, create: create); } - WrongOrderProvider _copyWith( - int Function(WrongOrderRef ref) create, - ) { - return WrongOrderProvider._internal( - (ref) => create(ref as WrongOrderRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - ); + @override + int create(WrongOrderRef ref) { + final fn = _createCb ?? wrongOrder; + return fn(ref); } @override bool operator ==(Object other) { - return other is WrongOrderProvider && other.runtimeType == runtimeType; + return other is WrongOrderProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, B.hashCode); - hash = _SystemHash.combine(hash, A.hashCode); - - return _SystemHash.finish(hash); + return Object.hash(runtimeType, argument); } +} + +String _$wrongOrderHash() => r'6732863e85b220c07f82c2d13be15c1e6f08192d'; + +final class WrongOrderFamily extends Family { + const WrongOrderFamily._() + : super( + name: r'wrongOrderProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + WrongOrderProvider call() => + WrongOrderProvider._(from: this); @override - String toString() => 'wrongOrderProvider<$B,$A>$argument'; -} + String debugGetCreateSourceHash() => _$wrongOrderHash(); -mixin WrongOrderRef on AutoDisposeProviderRef {} + @override + String toString() => r'wrongOrderProvider'; -class _WrongOrderProviderElement extends AutoDisposeProviderElement - with WrongOrderRef { - _WrongOrderProviderElement(super.provider, super.container); + /// {@macro riverpod.override_with} + Override overrideWith( + int Function(WrongOrderRef ref) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as WrongOrderProvider; + + return provider._copyWithCreate(create).createElement(container); + }, + ); + } } + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart index 94da25ae8..1165ddeae 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart @@ -6,735 +6,902 @@ part of 'notifier_extends.dart'; // RiverpodGenerator // ************************************************************************** -String _$myNotifierHash() => r'58f5439a3b1036ba7804f63a5a6ebe0114125039'; - -/// See also [MyNotifier]. @ProviderFor(MyNotifier) -final myNotifierProvider = - AutoDisposeNotifierProvider.internal( - MyNotifier.new, - name: r'myNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$MyNotifier = AutoDisposeNotifier; -String _$noExtendsHash() => r'3f1276999a9a6d3676c628c25ed853cbefb21ce9'; +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); -/// See also [NoExtends]. -@ProviderFor(NoExtends) -final noExtendsProvider = AutoDisposeNotifierProvider.internal( - NoExtends.new, - name: r'noExtendsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$noExtendsHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$NoExtends = AutoDisposeNotifier; -String _$wrongExtendsHash() => r'6479055793af10a34e225373a67f7eaac4d7c0de'; + final MyNotifier Function()? _createCb; -/// See also [WrongExtends]. -@ProviderFor(WrongExtends) -final wrongExtendsProvider = - AutoDisposeNotifierProvider.internal( - WrongExtends.new, - name: r'wrongExtendsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$wrongExtendsHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$WrongExtends = AutoDisposeNotifier; -String _$privateClassHash() => r'ba68a29a609566bb8bc0792391f842762356e124'; + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); -/// See also [_PrivateClass]. -@ProviderFor(_PrivateClass) -final _privateClassProvider = - AutoDisposeNotifierProvider<_PrivateClass, String>.internal( - _PrivateClass.new, - name: r'_privateClassProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$privateClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$PrivateClass = AutoDisposeNotifier; -String _$genericsHash() => r'0a1bf00e0610ccb1fb5615460e1bc4afb2555f69'; + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); } - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -abstract class _$Generics - extends BuildlessAutoDisposeNotifier { +String _$myNotifierHash() => r'58f5439a3b1036ba7804f63a5a6ebe0114125039'; + +abstract class _$MyNotifier extends $Notifier { int build(); + @$internal + @override + int runBuild() => build(); } -/// See also [Generics]. -@ProviderFor(Generics) -const genericsProvider = GenericsFamily(); +@ProviderFor(NoExtends) +const noExtendsProvider = NoExtendsProvider._(); + +final class NoExtendsProvider extends $NotifierProvider { + const NoExtendsProvider._( + {super.runNotifierBuildOverride, NoExtends Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'noExtendsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); -/// See also [Generics]. -class GenericsFamily extends Family { - /// See also [Generics]. - const GenericsFamily(); + final NoExtends Function()? _createCb; - static const Iterable? _dependencies = null; + @override + String debugGetCreateSourceHash() => _$noExtendsHash(); - static const Iterable? _allTransitiveDependencies = null; + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override - Iterable? get dependencies => _dependencies; + NoExtends create() => _createCb?.call() ?? NoExtends(); + @$internal @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + NoExtendsProvider $copyWithCreate( + NoExtends Function() create, + ) { + return NoExtendsProvider._(create: create); + } + @$internal @override - String? get name => r'genericsProvider'; - - /// See also [Generics]. - GenericsProvider call() { - return GenericsProvider(); + NoExtendsProvider $copyWithBuild( + int Function( + Ref, + NoExtends, + ) build, + ) { + return NoExtendsProvider._(runNotifierBuildOverride: build); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(Generics Function() create) { - return _$GenericsFamilyOverride(this, create); - } + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$noExtendsHash() => r'3f1276999a9a6d3676c628c25ed853cbefb21ce9'; +abstract class _$NoExtends extends $Notifier { + int build(); + @$internal @override - String toString() => 'genericsProvider'; + int runBuild() => build(); } -class _$GenericsFamilyOverride implements FamilyOverride { - _$GenericsFamilyOverride(this.from, this.create); +@ProviderFor(WrongExtends) +const wrongExtendsProvider = WrongExtendsProvider._(); + +final class WrongExtendsProvider extends $NotifierProvider { + const WrongExtendsProvider._( + {super.runNotifierBuildOverride, WrongExtends Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'wrongExtendsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final WrongExtends Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$wrongExtendsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } - final Generics Function() create; + @$internal + @override + WrongExtends create() => _createCb?.call() ?? WrongExtends(); + @$internal @override - final GenericsFamily from; + WrongExtendsProvider $copyWithCreate( + WrongExtends Function() create, + ) { + return WrongExtendsProvider._(create: create); + } + @$internal @override - _GenericsProviderElement createElement( - ProviderContainer container, - covariant GenericsProvider provider, + WrongExtendsProvider $copyWithBuild( + int Function( + Ref, + WrongExtends, + ) build, ) { - return provider._copyWith(create).createElement(container); + return WrongExtendsProvider._(runNotifierBuildOverride: build); } + @$internal @override - String toString() => 'genericsProvider.overrideWith(...)'; + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -/// See also [Generics]. -class GenericsProvider - extends AutoDisposeNotifierProviderImpl, int> { - /// See also [Generics]. - GenericsProvider() - : this._internal( - Generics.new, - from: genericsProvider, - name: r'genericsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$genericsHash, +String _$wrongExtendsHash() => r'6479055793af10a34e225373a67f7eaac4d7c0de'; + +abstract class _$WrongExtends extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +@ProviderFor(_PrivateClass) +const _privateClassProvider = _PrivateClassProvider._(); + +final class _PrivateClassProvider + extends $NotifierProvider<_PrivateClass, String> { + const _PrivateClassProvider._( + {super.runNotifierBuildOverride, _PrivateClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'_privateClassProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - GenericsProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); + final _PrivateClass Function()? _createCb; @override - int runNotifierBuild( - covariant Generics notifier, - ) { - return notifier.build(); - } + String debugGetCreateSourceHash() => _$privateClassHash(); - @override - Override overrideWith(Generics Function() create) { - return ProviderOverride( + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( origin: this, - providerOverride: GenericsProvider._internal( - () => create(), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), + providerOverride: $ValueProvider(value), ); } + @$internal @override - () get argument { - return (); - } + _PrivateClass create() => _createCb?.call() ?? _PrivateClass(); + @$internal @override - _GenericsProviderElement createElement( - ProviderContainer container, + _PrivateClassProvider $copyWithCreate( + _PrivateClass Function() create, ) { - return _GenericsProviderElement(this, container); - } - - GenericsProvider _copyWith( - Generics Function() create, - ) { - return GenericsProvider._internal( - () => create(), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - ); + return _PrivateClassProvider._(create: create); } + @$internal @override - bool operator ==(Object other) { - return other is GenericsProvider && other.runtimeType == runtimeType; + _PrivateClassProvider $copyWithBuild( + String Function( + Ref, + _PrivateClass, + ) build, + ) { + return _PrivateClassProvider._(runNotifierBuildOverride: build); } + @$internal @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, A.hashCode); - hash = _SystemHash.combine(hash, B.hashCode); + $NotifierProviderElement<_PrivateClass, String> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} - return _SystemHash.finish(hash); - } +String _$privateClassHash() => r'ba68a29a609566bb8bc0792391f842762356e124'; +abstract class _$PrivateClass extends $Notifier { + String build(); + @$internal @override - String toString() => 'genericsProvider<$A,$B>$argument'; + String runBuild() => build(); } -mixin GenericsRef on AutoDisposeNotifierProviderRef {} - -class _GenericsProviderElement - extends AutoDisposeNotifierProviderElement, int> - with GenericsRef { - _GenericsProviderElement(super.provider, super.container); -} +@ProviderFor(Generics) +const genericsProvider = GenericsFamily._(); + +final class GenericsProvider + extends $NotifierProvider, int> { + const GenericsProvider._( + {required GenericsFamily super.from, + super.runNotifierBuildOverride, + Generics Function()? create}) + : _createCb = create, + super( + argument: null, + name: r'genericsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); -String _$noGenericsHash() => r'30d5d20092f43cb17ede1f619773757df7cecb30'; + final Generics Function()? _createCb; -abstract class _$NoGenerics - extends BuildlessAutoDisposeNotifier { - int build(); -} + @override + String debugGetCreateSourceHash() => _$genericsHash(); -/// See also [NoGenerics]. -@ProviderFor(NoGenerics) -const noGenericsProvider = NoGenericsFamily(); + GenericsProvider _copyWithCreate( + Generics Function() create, + ) { + return GenericsProvider._( + from: from! as GenericsFamily, create: create); + } -/// See also [NoGenerics]. -class NoGenericsFamily extends Family { - /// See also [NoGenerics]. - const NoGenericsFamily(); + GenericsProvider _copyWithBuild( + int Function( + Ref, + Generics, + ) build, + ) { + return GenericsProvider._( + from: from! as GenericsFamily, runNotifierBuildOverride: build); + } - static const Iterable? _dependencies = null; + @override + String toString() { + return r'genericsProvider' + '<${A}, ${B}>' + '()'; + } - static const Iterable? _allTransitiveDependencies = null; + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override - Iterable? get dependencies => _dependencies; + Generics create() => _createCb?.call() ?? Generics(); + @$internal @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + GenericsProvider $copyWithCreate( + Generics Function() create, + ) { + return GenericsProvider._( + from: from! as GenericsFamily, create: create); + } + @$internal @override - String? get name => r'noGenericsProvider'; - - /// See also [NoGenerics]. - NoGenericsProvider call() { - return NoGenericsProvider(); + GenericsProvider $copyWithBuild( + int Function( + Ref, + Generics, + ) build, + ) { + return GenericsProvider._( + from: from! as GenericsFamily, runNotifierBuildOverride: build); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(NoGenerics Function() create) { - return _$NoGenericsFamilyOverride(this, create); + @$internal + @override + $NotifierProviderElement, int> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is GenericsProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override - String toString() => 'noGenericsProvider'; + int get hashCode { + return Object.hash(runtimeType, argument); + } } -class _$NoGenericsFamilyOverride implements FamilyOverride { - _$NoGenericsFamilyOverride(this.from, this.create); +String _$genericsHash() => r'0a1bf00e0610ccb1fb5615460e1bc4afb2555f69'; + +final class GenericsFamily extends Family { + const GenericsFamily._() + : super( + name: r'genericsProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); - final NoGenerics Function() create; + GenericsProvider call() => + GenericsProvider._(from: this); @override - final NoGenericsFamily from; + String debugGetCreateSourceHash() => _$genericsHash(); @override - _NoGenericsProviderElement createElement( - ProviderContainer container, - covariant NoGenericsProvider provider, + String toString() => r'genericsProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + Generics Function() create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericsProvider; + + return provider._copyWithCreate(create).createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + int Function(Ref ref, Generics notifier) build, ) { - return provider._copyWith(create).createElement(container); + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericsProvider; + + return provider._copyWithBuild(build).createElement(container); + }, + ); } +} +abstract class _$Generics extends $Notifier { + int build(); + @$internal @override - String toString() => 'noGenericsProvider.overrideWith(...)'; + int runBuild() => build(); } -/// See also [NoGenerics]. -class NoGenericsProvider - extends AutoDisposeNotifierProviderImpl, int> { - /// See also [NoGenerics]. - NoGenericsProvider() - : this._internal( - NoGenerics.new, - from: noGenericsProvider, +@ProviderFor(NoGenerics) +const noGenericsProvider = NoGenericsFamily._(); + +final class NoGenericsProvider + extends $NotifierProvider, int> { + const NoGenericsProvider._( + {required NoGenericsFamily super.from, + super.runNotifierBuildOverride, + NoGenerics Function()? create}) + : _createCb = create, + super( + argument: null, name: r'noGenericsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$noGenericsHash, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - NoGenericsProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); + final NoGenerics Function()? _createCb; @override - int runNotifierBuild( - covariant NoGenerics notifier, + String debugGetCreateSourceHash() => _$noGenericsHash(); + + NoGenericsProvider _copyWithCreate( + NoGenerics Function() create, ) { - return notifier.build(); + return NoGenericsProvider._( + from: from! as NoGenericsFamily, create: create); + } + + NoGenericsProvider _copyWithBuild( + int Function( + Ref, + NoGenerics, + ) build, + ) { + return NoGenericsProvider._( + from: from! as NoGenericsFamily, runNotifierBuildOverride: build); } @override - Override overrideWith(NoGenerics Function() create) { - return ProviderOverride( + String toString() { + return r'noGenericsProvider' + '<${A}, ${B}>' + '()'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( origin: this, - providerOverride: NoGenericsProvider._internal( - () => create(), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), + providerOverride: $ValueProvider(value), ); } + @$internal @override - () get argument { - return (); - } + NoGenerics create() => _createCb?.call() ?? NoGenerics(); + @$internal @override - _NoGenericsProviderElement createElement( - ProviderContainer container, + NoGenericsProvider $copyWithCreate( + NoGenerics Function() create, ) { - return _NoGenericsProviderElement(this, container); + return NoGenericsProvider._( + from: from! as NoGenericsFamily, create: create); } - NoGenericsProvider _copyWith( - NoGenerics Function() create, + @$internal + @override + NoGenericsProvider $copyWithBuild( + int Function( + Ref, + NoGenerics, + ) build, ) { - return NoGenericsProvider._internal( - () => create(), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - ); + return NoGenericsProvider._( + from: from! as NoGenericsFamily, runNotifierBuildOverride: build); } + @$internal + @override + $NotifierProviderElement, int> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + @override bool operator ==(Object other) { - return other is NoGenericsProvider && other.runtimeType == runtimeType; + return other is NoGenericsProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, A.hashCode); - hash = _SystemHash.combine(hash, B.hashCode); - - return _SystemHash.finish(hash); + return Object.hash(runtimeType, argument); } - - @override - String toString() => 'noGenericsProvider<$A,$B>$argument'; } -mixin NoGenericsRef on AutoDisposeNotifierProviderRef {} - -class _NoGenericsProviderElement - extends AutoDisposeNotifierProviderElement, int> - with NoGenericsRef { - _NoGenericsProviderElement(super.provider, super.container); -} - -String _$missingGenericsHash() => r'b611c76d5fb87fdde78b5fc017912e0569762c23'; - -abstract class _$MissingGenerics - extends BuildlessAutoDisposeNotifier { - int build(); -} - -/// See also [MissingGenerics]. -@ProviderFor(MissingGenerics) -const missingGenericsProvider = MissingGenericsFamily(); - -/// See also [MissingGenerics]. -class MissingGenericsFamily extends Family { - /// See also [MissingGenerics]. - const MissingGenericsFamily(); - - static const Iterable? _dependencies = null; +String _$noGenericsHash() => r'30d5d20092f43cb17ede1f619773757df7cecb30'; - static const Iterable? _allTransitiveDependencies = null; +final class NoGenericsFamily extends Family { + const NoGenericsFamily._() + : super( + name: r'noGenericsProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); - @override - Iterable? get dependencies => _dependencies; + NoGenericsProvider call() => + NoGenericsProvider._(from: this); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$noGenericsHash(); @override - String? get name => r'missingGenericsProvider'; + String toString() => r'noGenericsProvider'; - /// See also [MissingGenerics]. - MissingGenericsProvider call() { - return MissingGenericsProvider(); - } + /// {@macro riverpod.override_with} + Override overrideWith( + NoGenerics Function() create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as NoGenericsProvider; - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(MissingGenerics Function() create) { - return _$MissingGenericsFamilyOverride(this, create); + return provider._copyWithCreate(create).createElement(container); + }, + ); } - @override - String toString() => 'missingGenericsProvider'; -} - -class _$MissingGenericsFamilyOverride implements FamilyOverride { - _$MissingGenericsFamilyOverride(this.from, this.create); - - final MissingGenerics Function() create; - - @override - final MissingGenericsFamily from; - - @override - _MissingGenericsProviderElement createElement( - ProviderContainer container, - covariant MissingGenericsProvider provider, + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + int Function(Ref ref, NoGenerics notifier) + build, ) { - return provider._copyWith(create).createElement(container); + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as NoGenericsProvider; + + return provider._copyWithBuild(build).createElement(container); + }, + ); } +} +abstract class _$NoGenerics extends $Notifier { + int build(); + @$internal @override - String toString() => 'missingGenericsProvider.overrideWith(...)'; + int runBuild() => build(); } -/// See also [MissingGenerics]. -class MissingGenericsProvider - extends AutoDisposeNotifierProviderImpl, int> { - /// See also [MissingGenerics]. - MissingGenericsProvider() - : this._internal( - MissingGenerics.new, - from: missingGenericsProvider, +@ProviderFor(MissingGenerics) +const missingGenericsProvider = MissingGenericsFamily._(); + +final class MissingGenericsProvider + extends $NotifierProvider, int> { + const MissingGenericsProvider._( + {required MissingGenericsFamily super.from, + super.runNotifierBuildOverride, + MissingGenerics Function()? create}) + : _createCb = create, + super( + argument: null, name: r'missingGenericsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$missingGenericsHash, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - MissingGenericsProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); + final MissingGenerics Function()? _createCb; @override - int runNotifierBuild( - covariant MissingGenerics notifier, + String debugGetCreateSourceHash() => _$missingGenericsHash(); + + MissingGenericsProvider _copyWithCreate( + MissingGenerics Function() create, + ) { + return MissingGenericsProvider._( + from: from! as MissingGenericsFamily, create: create); + } + + MissingGenericsProvider _copyWithBuild( + int Function( + Ref, + MissingGenerics, + ) build, ) { - return notifier.build(); + return MissingGenericsProvider._( + from: from! as MissingGenericsFamily, + runNotifierBuildOverride: build); } @override - Override overrideWith(MissingGenerics Function() create) { - return ProviderOverride( + String toString() { + return r'missingGenericsProvider' + '<${A}, ${B}>' + '()'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( origin: this, - providerOverride: MissingGenericsProvider._internal( - () => create(), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), + providerOverride: $ValueProvider(value), ); } + @$internal @override - () get argument { - return (); - } + MissingGenerics create() => + _createCb?.call() ?? MissingGenerics(); + @$internal @override - _MissingGenericsProviderElement createElement( - ProviderContainer container, + MissingGenericsProvider $copyWithCreate( + MissingGenerics Function() create, ) { - return _MissingGenericsProviderElement(this, container); + return MissingGenericsProvider._( + from: from! as MissingGenericsFamily, create: create); } - MissingGenericsProvider _copyWith( - MissingGenerics Function() create, + @$internal + @override + MissingGenericsProvider $copyWithBuild( + int Function( + Ref, + MissingGenerics, + ) build, ) { - return MissingGenericsProvider._internal( - () => create(), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - ); + return MissingGenericsProvider._( + from: from! as MissingGenericsFamily, runNotifierBuildOverride: build); } + @$internal + @override + $NotifierProviderElement, int> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + @override bool operator ==(Object other) { - return other is MissingGenericsProvider && other.runtimeType == runtimeType; + return other is MissingGenericsProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, A.hashCode); - hash = _SystemHash.combine(hash, B.hashCode); - - return _SystemHash.finish(hash); + return Object.hash(runtimeType, argument); } - - @override - String toString() => 'missingGenericsProvider<$A,$B>$argument'; -} - -mixin MissingGenericsRef on AutoDisposeNotifierProviderRef {} - -class _MissingGenericsProviderElement - extends AutoDisposeNotifierProviderElement, int> - with MissingGenericsRef { - _MissingGenericsProviderElement(super.provider, super.container); -} - -String _$wrongOrderHash() => r'7757670a2f67406ebc96c87edf088deb9cb248a1'; - -abstract class _$WrongOrder extends BuildlessAutoDisposeNotifier { - int build(); } -/// See also [WrongOrder]. -@ProviderFor(WrongOrder) -const wrongOrderProvider = WrongOrderFamily(); - -/// See also [WrongOrder]. -class WrongOrderFamily extends Family { - /// See also [WrongOrder]. - const WrongOrderFamily(); - - static const Iterable? _dependencies = null; +String _$missingGenericsHash() => r'b611c76d5fb87fdde78b5fc017912e0569762c23'; - static const Iterable? _allTransitiveDependencies = null; +final class MissingGenericsFamily extends Family { + const MissingGenericsFamily._() + : super( + name: r'missingGenericsProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); - @override - Iterable? get dependencies => _dependencies; + MissingGenericsProvider call() => + MissingGenericsProvider._(from: this); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$missingGenericsHash(); @override - String? get name => r'wrongOrderProvider'; + String toString() => r'missingGenericsProvider'; - /// See also [WrongOrder]. - WrongOrderProvider call() { - return WrongOrderProvider(); - } + /// {@macro riverpod.override_with} + Override overrideWith( + MissingGenerics Function() create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as MissingGenericsProvider; - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(WrongOrder Function() create) { - return _$WrongOrderFamilyOverride(this, create); + return provider._copyWithCreate(create).createElement(container); + }, + ); } - @override - String toString() => 'wrongOrderProvider'; -} - -class _$WrongOrderFamilyOverride implements FamilyOverride { - _$WrongOrderFamilyOverride(this.from, this.create); - - final WrongOrder Function() create; - - @override - final WrongOrderFamily from; - - @override - _WrongOrderProviderElement createElement( - ProviderContainer container, - covariant WrongOrderProvider provider, + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + int Function(Ref ref, MissingGenerics notifier) build, ) { - return provider._copyWith(create).createElement(container); + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as MissingGenericsProvider; + + return provider._copyWithBuild(build).createElement(container); + }, + ); } +} +abstract class _$MissingGenerics extends $Notifier { + int build(); + @$internal @override - String toString() => 'wrongOrderProvider.overrideWith(...)'; + int runBuild() => build(); } -/// See also [WrongOrder]. -class WrongOrderProvider - extends AutoDisposeNotifierProviderImpl, int> { - /// See also [WrongOrder]. - WrongOrderProvider() - : this._internal( - WrongOrder.new, - from: wrongOrderProvider, +@ProviderFor(WrongOrder) +const wrongOrderProvider = WrongOrderFamily._(); + +final class WrongOrderProvider + extends $NotifierProvider, int> { + const WrongOrderProvider._( + {required WrongOrderFamily super.from, + super.runNotifierBuildOverride, + WrongOrder Function()? create}) + : _createCb = create, + super( + argument: null, name: r'wrongOrderProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$wrongOrderHash, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - WrongOrderProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - }) : super.internal(); + final WrongOrder Function()? _createCb; @override - int runNotifierBuild( - covariant WrongOrder notifier, + String debugGetCreateSourceHash() => _$wrongOrderHash(); + + WrongOrderProvider _copyWithCreate( + WrongOrder Function() create, ) { - return notifier.build(); + return WrongOrderProvider._( + from: from! as WrongOrderFamily, create: create); + } + + WrongOrderProvider _copyWithBuild( + int Function( + Ref, + WrongOrder, + ) build, + ) { + return WrongOrderProvider._( + from: from! as WrongOrderFamily, runNotifierBuildOverride: build); } @override - Override overrideWith(WrongOrder Function() create) { - return ProviderOverride( + String toString() { + return r'wrongOrderProvider' + '<${A}, ${B}>' + '()'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( origin: this, - providerOverride: WrongOrderProvider._internal( - () => create(), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - ), + providerOverride: $ValueProvider(value), ); } + @$internal @override - () get argument { - return (); - } + WrongOrder create() => _createCb?.call() ?? WrongOrder(); + @$internal @override - _WrongOrderProviderElement createElement( - ProviderContainer container, + WrongOrderProvider $copyWithCreate( + WrongOrder Function() create, ) { - return _WrongOrderProviderElement(this, container); + return WrongOrderProvider._( + from: from! as WrongOrderFamily, create: create); } - WrongOrderProvider _copyWith( - WrongOrder Function() create, + @$internal + @override + WrongOrderProvider $copyWithBuild( + int Function( + Ref, + WrongOrder, + ) build, ) { - return WrongOrderProvider._internal( - () => create(), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - ); + return WrongOrderProvider._( + from: from! as WrongOrderFamily, runNotifierBuildOverride: build); } + @$internal + @override + $NotifierProviderElement, int> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + @override bool operator ==(Object other) { - return other is WrongOrderProvider && other.runtimeType == runtimeType; + return other is WrongOrderProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, A.hashCode); - hash = _SystemHash.combine(hash, B.hashCode); - - return _SystemHash.finish(hash); + return Object.hash(runtimeType, argument); } +} + +String _$wrongOrderHash() => r'7757670a2f67406ebc96c87edf088deb9cb248a1'; + +final class WrongOrderFamily extends Family { + const WrongOrderFamily._() + : super( + name: r'wrongOrderProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + WrongOrderProvider call() => + WrongOrderProvider._(from: this); @override - String toString() => 'wrongOrderProvider<$A,$B>$argument'; -} + String debugGetCreateSourceHash() => _$wrongOrderHash(); + + @override + String toString() => r'wrongOrderProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + WrongOrder Function() create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as WrongOrderProvider; + + return provider._copyWithCreate(create).createElement(container); + }, + ); + } -mixin WrongOrderRef on AutoDisposeNotifierProviderRef {} + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + int Function(Ref ref, WrongOrder notifier) build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as WrongOrderProvider; + + return provider._copyWithBuild(build).createElement(container); + }, + ); + } +} -class _WrongOrderProviderElement - extends AutoDisposeNotifierProviderElement, int> - with WrongOrderRef { - _WrongOrderProviderElement(super.provider, super.container); +abstract class _$WrongOrder extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); } + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index d9ed747c0..a7cca41d1 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -6,1161 +6,1181 @@ part of 'protected_notifier_properties.dart'; // RiverpodGenerator // ************************************************************************** -String _$aHash() => r'9bf449b010f4dd5800e78f9f5b8a431b1a79c8b7'; - -/// See also [A]. @ProviderFor(A) -final aProvider = AutoDisposeNotifierProvider.internal( - A.new, - name: r'aProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$aHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$A = AutoDisposeNotifier; -String _$a2Hash() => r'898d46cbcec03233c7b8b0754810a6903226aa2e'; +const aProvider = AProvider._(); + +final class AProvider extends $NotifierProvider { + const AProvider._({super.runNotifierBuildOverride, A Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'aProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); -/// See also [A2]. -@ProviderFor(A2) -final a2Provider = NotifierProvider.internal( - A2.new, - name: r'a2Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$a2Hash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$A2 = Notifier; -String _$a3Hash() => r'2e21e9af8b67b5412611e0d23b862ead56deb8e1'; + final A Function()? _createCb; -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); + @override + String debugGetCreateSourceHash() => _$aHash(); - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); } - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + @$internal + @override + A create() => _createCb?.call() ?? A(); + + @$internal + @override + AProvider $copyWithCreate( + A Function() create, + ) { + return AProvider._(create: create); } -} -abstract class _$A3 extends BuildlessAutoDisposeNotifier { - late final int param; + @$internal + @override + AProvider $copyWithBuild( + int Function( + Ref, + A, + ) build, + ) { + return AProvider._(runNotifierBuildOverride: build); + } - int build( - int param, - ); + @$internal + @override + $NotifierProviderElement createElement(ProviderContainer container) => + $NotifierProviderElement(this, container); } -/// See also [A3]. -@ProviderFor(A3) -const a3Provider = A3Family(); +String _$aHash() => r'9bf449b010f4dd5800e78f9f5b8a431b1a79c8b7'; -/// See also [A3]. -class A3Family extends Family { - /// See also [A3]. - const A3Family(); +abstract class _$A extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} - static const Iterable? _dependencies = null; +@ProviderFor(A2) +const a2Provider = A2Provider._(); + +final class A2Provider extends $NotifierProvider { + const A2Provider._({super.runNotifierBuildOverride, A2 Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'a2Provider', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); - static const Iterable? _allTransitiveDependencies = null; + final A2 Function()? _createCb; @override - Iterable? get dependencies => _dependencies; + String debugGetCreateSourceHash() => _$a2Hash(); - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override - String? get name => r'a3Provider'; + A2 create() => _createCb?.call() ?? A2(); - /// See also [A3]. - A3Provider call( - int param, + @$internal + @override + A2Provider $copyWithCreate( + A2 Function() create, ) { - return A3Provider( - param, - ); + return A2Provider._(create: create); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(A3 Function() create) { - return _$A3FamilyOverride(this, create); + @$internal + @override + A2Provider $copyWithBuild( + int Function( + Ref, + A2, + ) build, + ) { + return A2Provider._(runNotifierBuildOverride: build); } + @$internal @override - String toString() => 'a3Provider'; + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -class _$A3FamilyOverride implements $FamilyOverride { - _$A3FamilyOverride(this.from, this.create); - - final A3 Function() create; - - @override - final A3Family from; - - @override - _A3ProviderElement createElement( - ProviderContainer container, - covariant A3Provider provider, - ) { - return provider._copyWith(create).createElement(container); - } +String _$a2Hash() => r'898d46cbcec03233c7b8b0754810a6903226aa2e'; +abstract class _$A2 extends $Notifier { + int build(); + @$internal @override - String toString() => 'a3Provider.overrideWith(...)'; + int runBuild() => build(); } -/// See also [A3]. -class A3Provider extends AutoDisposeNotifierProviderImpl { - /// See also [A3]. - A3Provider( - int param, - ) : this._internal( - () => A3()..param = param, - from: a3Provider, +@ProviderFor(A3) +const a3Provider = A3Family._(); + +final class A3Provider extends $NotifierProvider { + const A3Provider._( + {required A3Family super.from, + required int super.argument, + super.runNotifierBuildOverride, + A3 Function()? create}) + : _createCb = create, + super( name: r'a3Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$a3Hash, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - param: param, ); - A3Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.param, - }) : super.internal(); + final A3 Function()? _createCb; - final int param; + @override + String debugGetCreateSourceHash() => _$a3Hash(); @override - int runNotifierBuild( - covariant A3 notifier, - ) { - return notifier.build( - param, - ); + String toString() { + return r'a3Provider' + '' + '($argument)'; } - @override - Override overrideWith(A3 Function() create) { + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { return $ProviderOverride( origin: this, - providerOverride: A3Provider._internal( - () => create()..param = param, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - param: param, - ), + providerOverride: $ValueProvider(value), ); } + @$internal @override - (int,) get argument { - return (param,); - } + A3 create() => _createCb?.call() ?? A3(); + @$internal @override - _A3ProviderElement createElement( - ProviderContainer container, + A3Provider $copyWithCreate( + A3 Function() create, ) { - return _A3ProviderElement(this, container); + return A3Provider._( + argument: argument as int, from: from! as A3Family, create: create); } - A3Provider _copyWith( - A3 Function() create, + @$internal + @override + A3Provider $copyWithBuild( + int Function( + Ref, + A3, + ) build, ) { - return A3Provider._internal( - () => create()..param = param, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - param: param, - ); + return A3Provider._( + argument: argument as int, + from: from! as A3Family, + runNotifierBuildOverride: build); } + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + @override bool operator ==(Object other) { - return other is A3Provider && other.param == param; + return other is A3Provider && other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, param.hashCode); - - return _SystemHash.finish(hash); + return argument.hashCode; } - - @override - String toString() => 'a3Provider$argument'; } -mixin A3Ref on AutoDisposeNotifierProviderRef { - /// The parameter `param` of this provider. - int get param; -} - -class _A3ProviderElement extends AutoDisposeNotifierProviderElement - with A3Ref { - _A3ProviderElement(super.provider, super.container); - - @override - int get param => (origin as A3Provider).param; -} - -String _$a4Hash() => r'cdd9ad09099881cafe06d7b3095a8b06dbe7d876'; +String _$a3Hash() => r'2e21e9af8b67b5412611e0d23b862ead56deb8e1'; -abstract class _$A4 extends BuildlessNotifier { - late final int param; +final class A3Family extends Family { + const A3Family._() + : super( + name: r'a3Provider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); - int build( + A3Provider call( int param, - ); -} - -/// See also [A4]. -@ProviderFor(A4) -const a4Provider = A4Family(); - -/// See also [A4]. -class A4Family extends Family { - /// See also [A4]. - const A4Family(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - @override - Iterable? get dependencies => _dependencies; + ) => + A3Provider._(argument: param, from: this); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$a3Hash(); @override - String? get name => r'a4Provider'; + String toString() => r'a3Provider'; - /// See also [A4]. - A4Provider call( - int param, + /// {@macro riverpod.override_with} + Override overrideWith( + A3 Function( + int args, + ) create, ) { - return A4Provider( - param, - ); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as A3Provider; - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(A4 Function() create) { - return _$A4FamilyOverride(this, create); - } + final argument = provider.argument as int; - @override - String toString() => 'a4Provider'; -} - -class _$A4FamilyOverride implements $FamilyOverride { - _$A4FamilyOverride(this.from, this.create); + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } - final A4 Function() create; + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + int Function(Ref ref, A3 notifier, int argument) build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as A3Provider; - @override - final A4Family from; + final argument = provider.argument as int; - @override - _A4ProviderElement createElement( - ProviderContainer container, - covariant A4Provider provider, - ) { - return provider._copyWith(create).createElement(container); + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); } +} +abstract class _$A3 extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + int get param => _$args; + + int build( + int param, + ); + @$internal @override - String toString() => 'a4Provider.overrideWith(...)'; + int runBuild() => build( + _$args, + ); } -/// See also [A4]. -class A4Provider extends NotifierProvider { - /// See also [A4]. - A4Provider( - int param, - ) : this._internal( - () => A4()..param = param, - from: a4Provider, +@ProviderFor(A4) +const a4Provider = A4Family._(); + +final class A4Provider extends $NotifierProvider { + const A4Provider._( + {required A4Family super.from, + required int super.argument, + super.runNotifierBuildOverride, + A4 Function()? create}) + : _createCb = create, + super( name: r'a4Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$a4Hash, + isAutoDispose: false, dependencies: null, allTransitiveDependencies: null, - param: param, ); - A4Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.param, - }) : super.internal(); + final A4 Function()? _createCb; - final int param; + @override + String debugGetCreateSourceHash() => _$a4Hash(); @override - int runNotifierBuild( - covariant A4 notifier, - ) { - return notifier.build( - param, - ); + String toString() { + return r'a4Provider' + '' + '($argument)'; } - @override - Override overrideWith(A4 Function() create) { + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { return $ProviderOverride( origin: this, - providerOverride: A4Provider._internal( - () => create()..param = param, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - param: param, - ), + providerOverride: $ValueProvider(value), ); } + @$internal @override - (int,) get argument { - return (param,); - } + A4 create() => _createCb?.call() ?? A4(); + @$internal @override - _A4ProviderElement createElement( - ProviderContainer container, + A4Provider $copyWithCreate( + A4 Function() create, ) { - return _A4ProviderElement(this, container); + return A4Provider._( + argument: argument as int, from: from! as A4Family, create: create); } - A4Provider _copyWith( - A4 Function() create, + @$internal + @override + A4Provider $copyWithBuild( + int Function( + Ref, + A4, + ) build, ) { - return A4Provider._internal( - () => create()..param = param, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - param: param, - ); + return A4Provider._( + argument: argument as int, + from: from! as A4Family, + runNotifierBuildOverride: build); } + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + @override bool operator ==(Object other) { - return other is A4Provider && other.param == param; + return other is A4Provider && other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, param.hashCode); - - return _SystemHash.finish(hash); + return argument.hashCode; } - - @override - String toString() => 'a4Provider$argument'; } -mixin A4Ref on NotifierProviderRef { - /// The parameter `param` of this provider. - int get param; -} - -class _A4ProviderElement extends NotifierProviderElement with A4Ref { - _A4ProviderElement(super.provider, super.container); - - @override - int get param => (origin as A4Provider).param; -} - -String _$a5Hash() => r'c83634c22b6a9149aa8787e45c3b7cd6c88b5958'; +String _$a4Hash() => r'cdd9ad09099881cafe06d7b3095a8b06dbe7d876'; -abstract class _$A5 extends BuildlessAutoDisposeAsyncNotifier { - late final int param; +final class A4Family extends Family { + const A4Family._() + : super( + name: r'a4Provider', + dependencies: null, + allTransitiveDependencies: null, + ); - FutureOr build( + A4Provider call( int param, - ); -} - -/// See also [A5]. -@ProviderFor(A5) -const a5Provider = A5Family(); - -/// See also [A5]. -class A5Family extends Family { - /// See also [A5]. - const A5Family(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - @override - Iterable? get dependencies => _dependencies; + ) => + A4Provider._(argument: param, from: this); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$a4Hash(); @override - String? get name => r'a5Provider'; + String toString() => r'a4Provider'; - /// See also [A5]. - A5Provider call( - int param, + /// {@macro riverpod.override_with} + Override overrideWith( + A4 Function( + int args, + ) create, ) { - return A5Provider( - param, - ); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as A4Provider; - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(A5 Function() create) { - return _$A5FamilyOverride(this, create); - } - - @override - String toString() => 'a5Provider'; -} + final argument = provider.argument as int; -class _$A5FamilyOverride implements $FamilyOverride { - _$A5FamilyOverride(this.from, this.create); + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } - final A5 Function() create; + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + int Function(Ref ref, A4 notifier, int argument) build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as A4Provider; - @override - final A5Family from; + final argument = provider.argument as int; - @override - _A5ProviderElement createElement( - ProviderContainer container, - covariant A5Provider provider, - ) { - return provider._copyWith(create).createElement(container); + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); } +} + +abstract class _$A4 extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + int get param => _$args; + int build( + int param, + ); + @$internal @override - String toString() => 'a5Provider.overrideWith(...)'; + int runBuild() => build( + _$args, + ); } -/// See also [A5]. -class A5Provider extends AutoDisposeAsyncNotifierProviderImpl { - /// See also [A5]. - A5Provider( - int param, - ) : this._internal( - () => A5()..param = param, - from: a5Provider, +@ProviderFor(A5) +const a5Provider = A5Family._(); + +final class A5Provider extends $AsyncNotifierProvider { + const A5Provider._( + {required A5Family super.from, + required int super.argument, + super.runNotifierBuildOverride, + A5 Function()? create}) + : _createCb = create, + super( name: r'a5Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$a5Hash, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - param: param, ); - A5Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.param, - }) : super.internal(); - - final int param; + final A5 Function()? _createCb; @override - FutureOr runNotifierBuild( - covariant A5 notifier, - ) { - return notifier.build( - param, - ); - } + String debugGetCreateSourceHash() => _$a5Hash(); @override - Override overrideWith(A5 Function() create) { - return $ProviderOverride( - origin: this, - providerOverride: A5Provider._internal( - () => create()..param = param, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - param: param, - ), - ); + String toString() { + return r'a5Provider' + '' + '($argument)'; } + @$internal @override - (int,) get argument { - return (param,); - } + A5 create() => _createCb?.call() ?? A5(); + @$internal @override - _A5ProviderElement createElement( - ProviderContainer container, + A5Provider $copyWithCreate( + A5 Function() create, ) { - return _A5ProviderElement(this, container); + return A5Provider._( + argument: argument as int, from: from! as A5Family, create: create); } - A5Provider _copyWith( - A5 Function() create, + @$internal + @override + A5Provider $copyWithBuild( + FutureOr Function( + Ref>, + A5, + ) build, ) { - return A5Provider._internal( - () => create()..param = param, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - param: param, - ); + return A5Provider._( + argument: argument as int, + from: from! as A5Family, + runNotifierBuildOverride: build); } + @$internal + @override + $AsyncNotifierProviderElement createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); + @override bool operator ==(Object other) { - return other is A5Provider && other.param == param; + return other is A5Provider && other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, param.hashCode); - - return _SystemHash.finish(hash); + return argument.hashCode; } - - @override - String toString() => 'a5Provider$argument'; } -mixin A5Ref on AutoDisposeAsyncNotifierProviderRef { - /// The parameter `param` of this provider. - int get param; -} +String _$a5Hash() => r'c83634c22b6a9149aa8787e45c3b7cd6c88b5958'; -class _A5ProviderElement - extends AutoDisposeAsyncNotifierProviderElement with A5Ref { - _A5ProviderElement(super.provider, super.container); +final class A5Family extends Family { + const A5Family._() + : super( + name: r'a5Provider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + A5Provider call( + int param, + ) => + A5Provider._(argument: param, from: this); @override - int get param => (origin as A5Provider).param; -} + String debugGetCreateSourceHash() => _$a5Hash(); -String _$a6Hash() => r'fe641c72cacf3dd119eb77a34fe8fc71c5c30139'; + @override + String toString() => r'a5Provider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + A5 Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as A5Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + FutureOr Function(Ref> ref, A5 notifier, int argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as A5Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } +} -abstract class _$A6 extends BuildlessAsyncNotifier { - late final int param; +abstract class _$A5 extends $AsyncNotifier { + late final _$args = + (ref as $AsyncNotifierProviderElement).origin.argument as int; + int get param => _$args; FutureOr build( int param, ); + @$internal + @override + FutureOr runBuild() => build( + _$args, + ); } -/// See also [A6]. @ProviderFor(A6) -const a6Provider = A6Family(); - -/// See also [A6]. -class A6Family extends Family { - /// See also [A6]. - const A6Family(); +const a6Provider = A6Family._(); + +final class A6Provider extends $AsyncNotifierProvider { + const A6Provider._( + {required A6Family super.from, + required int super.argument, + super.runNotifierBuildOverride, + A6 Function()? create}) + : _createCb = create, + super( + name: r'a6Provider', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); - static const Iterable? _dependencies = null; + final A6 Function()? _createCb; - static const Iterable? _allTransitiveDependencies = null; + @override + String debugGetCreateSourceHash() => _$a6Hash(); @override - Iterable? get dependencies => _dependencies; + String toString() { + return r'a6Provider' + '' + '($argument)'; + } + @$internal @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + A6 create() => _createCb?.call() ?? A6(); + @$internal @override - String? get name => r'a6Provider'; + A6Provider $copyWithCreate( + A6 Function() create, + ) { + return A6Provider._( + argument: argument as int, from: from! as A6Family, create: create); + } - /// See also [A6]. - A6Provider call( - int param, + @$internal + @override + A6Provider $copyWithBuild( + FutureOr Function( + Ref>, + A6, + ) build, ) { - return A6Provider( - param, - ); + return A6Provider._( + argument: argument as int, + from: from! as A6Family, + runNotifierBuildOverride: build); } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(A6 Function() create) { - return _$A6FamilyOverride(this, create); + @$internal + @override + $AsyncNotifierProviderElement createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is A6Provider && other.argument == argument; } @override - String toString() => 'a6Provider'; + int get hashCode { + return argument.hashCode; + } } -class _$A6FamilyOverride implements $FamilyOverride { - _$A6FamilyOverride(this.from, this.create); +String _$a6Hash() => r'fe641c72cacf3dd119eb77a34fe8fc71c5c30139'; - final A6 Function() create; +final class A6Family extends Family { + const A6Family._() + : super( + name: r'a6Provider', + dependencies: null, + allTransitiveDependencies: null, + ); + + A6Provider call( + int param, + ) => + A6Provider._(argument: param, from: this); @override - final A6Family from; + String debugGetCreateSourceHash() => _$a6Hash(); @override - _A6ProviderElement createElement( - ProviderContainer container, - covariant A6Provider provider, + String toString() => r'a6Provider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + A6 Function( + int args, + ) create, ) { - return provider._copyWith(create).createElement(container); + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as A6Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); } - @override - String toString() => 'a6Provider.overrideWith(...)'; + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + FutureOr Function(Ref> ref, A6 notifier, int argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as A6Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } } -/// See also [A6]. -class A6Provider extends AsyncNotifierProviderImpl { - /// See also [A6]. - A6Provider( +abstract class _$A6 extends $AsyncNotifier { + late final _$args = + (ref as $AsyncNotifierProviderElement).origin.argument as int; + int get param => _$args; + + FutureOr build( int param, - ) : this._internal( - () => A6()..param = param, - from: a6Provider, - name: r'a6Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$a6Hash, + ); + @$internal + @override + FutureOr runBuild() => build( + _$args, + ); +} + +@ProviderFor(A7) +const a7Provider = A7Family._(); + +final class A7Provider extends $StreamNotifierProvider { + const A7Provider._( + {required A7Family super.from, + required int super.argument, + super.runNotifierBuildOverride, + A7 Function()? create}) + : _createCb = create, + super( + name: r'a7Provider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - param: param, ); - A6Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.param, - }) : super.internal(); - - final int param; + final A7 Function()? _createCb; @override - FutureOr runNotifierBuild( - covariant A6 notifier, - ) { - return notifier.build( - param, - ); - } + String debugGetCreateSourceHash() => _$a7Hash(); @override - Override overrideWith(A6 Function() create) { - return $ProviderOverride( - origin: this, - providerOverride: A6Provider._internal( - () => create()..param = param, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - param: param, - ), - ); + String toString() { + return r'a7Provider' + '' + '($argument)'; } + @$internal @override - (int,) get argument { - return (param,); - } + A7 create() => _createCb?.call() ?? A7(); + @$internal @override - _A6ProviderElement createElement( - ProviderContainer container, + A7Provider $copyWithCreate( + A7 Function() create, ) { - return _A6ProviderElement(this, container); + return A7Provider._( + argument: argument as int, from: from! as A7Family, create: create); } - A6Provider _copyWith( - A6 Function() create, + @$internal + @override + A7Provider $copyWithBuild( + Stream Function( + Ref>, + A7, + ) build, ) { - return A6Provider._internal( - () => create()..param = param, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - param: param, - ); + return A7Provider._( + argument: argument as int, + from: from! as A7Family, + runNotifierBuildOverride: build); } + @$internal + @override + $StreamNotifierProviderElement createElement( + ProviderContainer container) => + $StreamNotifierProviderElement(this, container); + @override bool operator ==(Object other) { - return other is A6Provider && other.param == param; + return other is A7Provider && other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, param.hashCode); - - return _SystemHash.finish(hash); + return argument.hashCode; } - - @override - String toString() => 'a6Provider$argument'; -} - -mixin A6Ref on AsyncNotifierProviderRef { - /// The parameter `param` of this provider. - int get param; -} - -class _A6ProviderElement extends _AsyncNotifierProviderElement - with A6Ref { - _A6ProviderElement(super.provider, super.container); - - @override - int get param => (origin as A6Provider).param; } String _$a7Hash() => r'd3d9ab5090e21987d65522f14ebb70d0058fc56a'; -abstract class _$A7 extends BuildlessAutoDisposeStreamNotifier { - late final int param; +final class A7Family extends Family { + const A7Family._() + : super( + name: r'a7Provider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); - Stream build( + A7Provider call( int param, - ); -} - -/// See also [A7]. -@ProviderFor(A7) -const a7Provider = A7Family(); - -/// See also [A7]. -class A7Family extends Family { - /// See also [A7]. - const A7Family(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; + ) => + A7Provider._(argument: param, from: this); @override - Iterable? get dependencies => _dependencies; + String debugGetCreateSourceHash() => _$a7Hash(); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String toString() => r'a7Provider'; - @override - String? get name => r'a7Provider'; - - /// See also [A7]. - A7Provider call( - int param, + /// {@macro riverpod.override_with} + Override overrideWith( + A7 Function( + int args, + ) create, ) { - return A7Provider( - param, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(A7 Function() create) { - return _$A7FamilyOverride(this, create); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as A7Provider; - @override - String toString() => 'a7Provider'; -} + final argument = provider.argument as int; -class _$A7FamilyOverride implements $FamilyOverride { - _$A7FamilyOverride(this.from, this.create); + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } - final A7 Function() create; + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + Stream Function(Ref> ref, A7 notifier, int argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as A7Provider; - @override - final A7Family from; + final argument = provider.argument as int; - @override - _A7ProviderElement createElement( - ProviderContainer container, - covariant A7Provider provider, - ) { - return provider._copyWith(create).createElement(container); + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); } +} + +abstract class _$A7 extends $StreamNotifier { + late final _$args = + (ref as $StreamNotifierProviderElement).origin.argument as int; + int get param => _$args; + Stream build( + int param, + ); + @$internal @override - String toString() => 'a7Provider.overrideWith(...)'; + Stream runBuild() => build( + _$args, + ); } -/// See also [A7]. -class A7Provider extends AutoDisposeStreamNotifierProviderImpl { - /// See also [A7]. - A7Provider( - int param, - ) : this._internal( - () => A7()..param = param, - from: a7Provider, - name: r'a7Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$a7Hash, +@ProviderFor(A8) +const a8Provider = A8Family._(); + +final class A8Provider extends $StreamNotifierProvider { + const A8Provider._( + {required A8Family super.from, + required int super.argument, + super.runNotifierBuildOverride, + A8 Function()? create}) + : _createCb = create, + super( + name: r'a8Provider', + isAutoDispose: false, dependencies: null, allTransitiveDependencies: null, - param: param, ); - A7Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.param, - }) : super.internal(); - - final int param; + final A8 Function()? _createCb; @override - Stream runNotifierBuild( - covariant A7 notifier, - ) { - return notifier.build( - param, - ); - } + String debugGetCreateSourceHash() => _$a8Hash(); @override - Override overrideWith(A7 Function() create) { - return $ProviderOverride( - origin: this, - providerOverride: A7Provider._internal( - () => create()..param = param, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - param: param, - ), - ); + String toString() { + return r'a8Provider' + '' + '($argument)'; } + @$internal @override - (int,) get argument { - return (param,); - } + A8 create() => _createCb?.call() ?? A8(); + @$internal @override - _A7ProviderElement createElement( - ProviderContainer container, + A8Provider $copyWithCreate( + A8 Function() create, ) { - return _A7ProviderElement(this, container); + return A8Provider._( + argument: argument as int, from: from! as A8Family, create: create); } - A7Provider _copyWith( - A7 Function() create, + @$internal + @override + A8Provider $copyWithBuild( + Stream Function( + Ref>, + A8, + ) build, ) { - return A7Provider._internal( - () => create()..param = param, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - param: param, - ); + return A8Provider._( + argument: argument as int, + from: from! as A8Family, + runNotifierBuildOverride: build); } + @$internal + @override + $StreamNotifierProviderElement createElement( + ProviderContainer container) => + $StreamNotifierProviderElement(this, container); + @override bool operator ==(Object other) { - return other is A7Provider && other.param == param; + return other is A8Provider && other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, param.hashCode); - - return _SystemHash.finish(hash); + return argument.hashCode; } - - @override - String toString() => 'a7Provider$argument'; -} - -mixin A7Ref on AutoDisposeStreamNotifierProviderRef { - /// The parameter `param` of this provider. - int get param; -} - -class _A7ProviderElement - extends AutoDisposeStreamNotifierProviderElement with A7Ref { - _A7ProviderElement(super.provider, super.container); - - @override - int get param => (origin as A7Provider).param; } String _$a8Hash() => r'54f4a841a283161bed3d444dcee53bf367958678'; -abstract class _$A8 extends BuildlessStreamNotifier { - late final int param; +final class A8Family extends Family { + const A8Family._() + : super( + name: r'a8Provider', + dependencies: null, + allTransitiveDependencies: null, + ); - Stream build( + A8Provider call( int param, - ); -} + ) => + A8Provider._(argument: param, from: this); -/// See also [A8]. -@ProviderFor(A8) -const a8Provider = A8Family(); + @override + String debugGetCreateSourceHash() => _$a8Hash(); -/// See also [A8]. -class A8Family extends Family { - /// See also [A8]. - const A8Family(); + @override + String toString() => r'a8Provider'; - static const Iterable? _dependencies = null; + /// {@macro riverpod.override_with} + Override overrideWith( + A8 Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as A8Provider; - static const Iterable? _allTransitiveDependencies = null; + final argument = provider.argument as int; - @override - Iterable? get dependencies => _dependencies; + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + Stream Function(Ref> ref, A8 notifier, int argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as A8Provider; - @override - String? get name => r'a8Provider'; + final argument = provider.argument as int; - /// See also [A8]. - A8Provider call( - int param, - ) { - return A8Provider( - param, + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, ); } +} - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(A8 Function() create) { - return _$A8FamilyOverride(this, create); - } +abstract class _$A8 extends $StreamNotifier { + late final _$args = + (ref as $StreamNotifierProviderElement).origin.argument as int; + int get param => _$args; + Stream build( + int param, + ); + @$internal @override - String toString() => 'a8Provider'; + Stream runBuild() => build( + _$args, + ); } -class _$A8FamilyOverride implements $FamilyOverride { - _$A8FamilyOverride(this.from, this.create); +@ProviderFor(B) +const bProvider = BProvider._(); + +final class BProvider extends $NotifierProvider { + const BProvider._({super.runNotifierBuildOverride, B Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'bProvider', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); + + final B Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$bHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } - final A8 Function() create; + @$internal + @override + B create() => _createCb?.call() ?? B(); + @$internal @override - final A8Family from; + BProvider $copyWithCreate( + B Function() create, + ) { + return BProvider._(create: create); + } + @$internal @override - _A8ProviderElement createElement( - ProviderContainer container, - covariant A8Provider provider, + BProvider $copyWithBuild( + int Function( + Ref, + B, + ) build, ) { - return provider._copyWith(create).createElement(container); + return BProvider._(runNotifierBuildOverride: build); } + @$internal @override - String toString() => 'a8Provider.overrideWith(...)'; + $NotifierProviderElement createElement(ProviderContainer container) => + $NotifierProviderElement(this, container); } -/// See also [A8]. -class A8Provider extends StreamNotifierProviderImpl { - /// See also [A8]. - A8Provider( - int param, - ) : this._internal( - () => A8()..param = param, - from: a8Provider, - name: r'a8Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$a8Hash, +String _$bHash() => r'44288285e9c28f846d609ba892520f577ecf7867'; + +abstract class _$B extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +@ProviderFor(B2) +const b2Provider = B2Provider._(); + +final class B2Provider extends $NotifierProvider { + const B2Provider._({super.runNotifierBuildOverride, B2 Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'b2Provider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - param: param, ); - A8Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.param, - }) : super.internal(); - - final int param; + final B2 Function()? _createCb; @override - Stream runNotifierBuild( - covariant A8 notifier, - ) { - return notifier.build( - param, - ); - } + String debugGetCreateSourceHash() => _$b2Hash(); - @override - Override overrideWith(A8 Function() create) { + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { return $ProviderOverride( origin: this, - providerOverride: A8Provider._internal( - () => create()..param = param, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - param: param, - ), + providerOverride: $ValueProvider(value), ); } + @$internal @override - (int,) get argument { - return (param,); - } + B2 create() => _createCb?.call() ?? B2(); + @$internal @override - _A8ProviderElement createElement( - ProviderContainer container, + B2Provider $copyWithCreate( + B2 Function() create, ) { - return _A8ProviderElement(this, container); - } - - A8Provider _copyWith( - A8 Function() create, - ) { - return A8Provider._internal( - () => create()..param = param, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - param: param, - ); - } - - @override - bool operator ==(Object other) { - return other is A8Provider && other.param == param; + return B2Provider._(create: create); } + @$internal @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, param.hashCode); - - return _SystemHash.finish(hash); + B2Provider $copyWithBuild( + int Function( + Ref, + B2, + ) build, + ) { + return B2Provider._(runNotifierBuildOverride: build); } + @$internal @override - String toString() => 'a8Provider$argument'; + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -mixin A8Ref on StreamNotifierProviderRef { - /// The parameter `param` of this provider. - int get param; -} - -class _A8ProviderElement extends _StreamNotifierProviderElement - with A8Ref { - _A8ProviderElement(super.provider, super.container); +String _$b2Hash() => r'292925c285c6975ed6585d541c5a9ae18977d73c'; +abstract class _$B2 extends $Notifier { + int build(); + @$internal @override - int get param => (origin as A8Provider).param; + int runBuild() => build(); } -String _$bHash() => r'44288285e9c28f846d609ba892520f577ecf7867'; - -/// See also [B]. -@ProviderFor(B) -final bProvider = NotifierProvider.internal( - B.new, - name: r'bProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$bHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$B = Notifier; -String _$b2Hash() => r'292925c285c6975ed6585d541c5a9ae18977d73c'; - -/// See also [B2]. -@ProviderFor(B2) -final b2Provider = AutoDisposeNotifierProvider.internal( - B2.new, - name: r'b2Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$b2Hash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$B2 = AutoDisposeNotifier; +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart index c2d7a638d..40105c6e0 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart @@ -6,200 +6,745 @@ part of 'provider_dependencies.dart'; // RiverpodGenerator // ************************************************************************** -String _$depHash() => r'749c4d696d29c72686cabcabd6fa7855f5cbf4db'; +typedef DepRef = Ref; -/// See also [dep]. @ProviderFor(dep) -final depProvider = AutoDisposeProvider.internal( - dep, - name: r'depProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$depHash, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef DepRef = AutoDisposeProviderRef; -String _$dep2Hash() => r'13cd909366c79168e3d9cd95f529ddbcee6de7dc'; +const depProvider = DepProvider._(); + +final class DepProvider extends $FunctionalProvider + with $Provider { + const DepProvider._( + {int Function( + DepRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'depProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + DepRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$depHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DepProvider $copyWithCreate( + int Function( + DepRef ref, + ) create, + ) { + return DepProvider._(create: create); + } + + @override + int create(DepRef ref) { + final fn = _createCb ?? dep; + return fn(ref); + } +} + +String _$depHash() => r'749c4d696d29c72686cabcabd6fa7855f5cbf4db'; + +typedef Dep2Ref = Ref; -/// See also [dep2]. @ProviderFor(dep2) -final dep2Provider = AutoDisposeProvider.internal( - dep2, - name: r'dep2Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$dep2Hash, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef Dep2Ref = AutoDisposeProviderRef; -String _$plainAnnotationHash() => - r'ceeb01dfcbd115f3676c8e38ce35a03cff16246b'; //////////// -/// -/// Copied from [plainAnnotation]. +const dep2Provider = Dep2Provider._(); + +final class Dep2Provider extends $FunctionalProvider + with $Provider { + const Dep2Provider._( + {int Function( + Dep2Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'dep2Provider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + Dep2Ref ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$dep2Hash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Dep2Provider $copyWithCreate( + int Function( + Dep2Ref ref, + ) create, + ) { + return Dep2Provider._(create: create); + } + + @override + int create(Dep2Ref ref) { + final fn = _createCb ?? dep2; + return fn(ref); + } +} + +String _$dep2Hash() => r'13cd909366c79168e3d9cd95f529ddbcee6de7dc'; + +//////////// +// expect_lint: provider_dependencies +typedef PlainAnnotationRef = Ref; + +//////////// +// expect_lint: provider_dependencies @ProviderFor(plainAnnotation) -final plainAnnotationProvider = AutoDisposeProvider.internal( - plainAnnotation, - name: r'plainAnnotationProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$plainAnnotationHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef PlainAnnotationRef = AutoDisposeProviderRef; -String _$customAnnotationHash() => r'04faed9b424be360e594870f91c4ef4689f05672'; +const plainAnnotationProvider = PlainAnnotationProvider._(); + +//////////// +// expect_lint: provider_dependencies +final class PlainAnnotationProvider + extends $FunctionalProvider + with $Provider { + //////////// +// expect_lint: provider_dependencies + const PlainAnnotationProvider._( + {int Function( + PlainAnnotationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'plainAnnotationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + PlainAnnotationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$plainAnnotationHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + PlainAnnotationProvider $copyWithCreate( + int Function( + PlainAnnotationRef ref, + ) create, + ) { + return PlainAnnotationProvider._(create: create); + } + + @override + int create(PlainAnnotationRef ref) { + final fn = _createCb ?? plainAnnotation; + return fn(ref); + } +} + +String _$plainAnnotationHash() => r'ceeb01dfcbd115f3676c8e38ce35a03cff16246b'; + +typedef CustomAnnotationRef = Ref; -/// See also [customAnnotation]. @ProviderFor(customAnnotation) -final customAnnotationProvider = AutoDisposeProvider.internal( - customAnnotation, - name: r'customAnnotationProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$customAnnotationHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CustomAnnotationRef = AutoDisposeProviderRef; +const customAnnotationProvider = CustomAnnotationProvider._(); + +final class CustomAnnotationProvider + extends $FunctionalProvider + with $Provider { + const CustomAnnotationProvider._( + {int Function( + CustomAnnotationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'customAnnotationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CustomAnnotationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$customAnnotationHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CustomAnnotationProvider $copyWithCreate( + int Function( + CustomAnnotationRef ref, + ) create, + ) { + return CustomAnnotationProvider._(create: create); + } + + @override + int create(CustomAnnotationRef ref) { + final fn = _createCb ?? customAnnotation; + return fn(ref); + } +} + +String _$customAnnotationHash() => r'04faed9b424be360e594870f91c4ef4689f05672'; + +typedef CustomAnnotationWithTrailingCommaRef = Ref; + +@ProviderFor(customAnnotationWithTrailingComma) +const customAnnotationWithTrailingCommaProvider = + CustomAnnotationWithTrailingCommaProvider._(); + +final class CustomAnnotationWithTrailingCommaProvider + extends $FunctionalProvider + with $Provider { + const CustomAnnotationWithTrailingCommaProvider._( + {int Function( + CustomAnnotationWithTrailingCommaRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'customAnnotationWithTrailingCommaProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CustomAnnotationWithTrailingCommaRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$customAnnotationWithTrailingCommaHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CustomAnnotationWithTrailingCommaProvider $copyWithCreate( + int Function( + CustomAnnotationWithTrailingCommaRef ref, + ) create, + ) { + return CustomAnnotationWithTrailingCommaProvider._(create: create); + } + + @override + int create(CustomAnnotationWithTrailingCommaRef ref) { + final fn = _createCb ?? customAnnotationWithTrailingComma; + return fn(ref); + } +} + String _$customAnnotationWithTrailingCommaHash() => r'b5c62d769dfc53d6d77e8fde9e0eb7d8a0ab9d18'; -/// See also [customAnnotationWithTrailingComma]. -@ProviderFor(customAnnotationWithTrailingComma) -final customAnnotationWithTrailingCommaProvider = - AutoDisposeProvider.internal( - customAnnotationWithTrailingComma, - name: r'customAnnotationWithTrailingCommaProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$customAnnotationWithTrailingCommaHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CustomAnnotationWithTrailingCommaRef = AutoDisposeProviderRef; -String _$existingDepHash() => r'8d7866d1af7e350d7c792e43a542cd47b130b239'; +typedef ExistingDepRef = Ref; -/// See also [existingDep]. @ProviderFor(existingDep) -final existingDepProvider = AutoDisposeProvider.internal( - existingDep, - name: r'existingDepProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$existingDepHash, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef ExistingDepRef = AutoDisposeProviderRef; -String _$multipleDepsHash() => r'9d08791636a0435ba115062a453d0d9e530ecf71'; +const existingDepProvider = ExistingDepProvider._(); + +final class ExistingDepProvider + extends $FunctionalProvider + with $Provider { + const ExistingDepProvider._( + {int Function( + ExistingDepRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'existingDepProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + ExistingDepRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$existingDepHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExistingDepProvider $copyWithCreate( + int Function( + ExistingDepRef ref, + ) create, + ) { + return ExistingDepProvider._(create: create); + } + + @override + int create(ExistingDepRef ref) { + final fn = _createCb ?? existingDep; + return fn(ref); + } +} + +String _$existingDepHash() => r'8d7866d1af7e350d7c792e43a542cd47b130b239'; + +typedef MultipleDepsRef = Ref; -/// See also [multipleDeps]. @ProviderFor(multipleDeps) -final multipleDepsProvider = AutoDisposeProvider.internal( - multipleDeps, - name: r'multipleDepsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$multipleDepsHash, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef MultipleDepsRef = AutoDisposeProviderRef; -String _$extraDepHash() => r'038d9c819b5d91eb1f7166194d8e646f17ea24d7'; +const multipleDepsProvider = MultipleDepsProvider._(); + +final class MultipleDepsProvider + extends $FunctionalProvider + with $Provider { + const MultipleDepsProvider._( + {int Function( + MultipleDepsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'multipleDepsProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + MultipleDepsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$multipleDepsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + MultipleDepsProvider $copyWithCreate( + int Function( + MultipleDepsRef ref, + ) create, + ) { + return MultipleDepsProvider._(create: create); + } + + @override + int create(MultipleDepsRef ref) { + final fn = _createCb ?? multipleDeps; + return fn(ref); + } +} + +String _$multipleDepsHash() => r'9d08791636a0435ba115062a453d0d9e530ecf71'; + +typedef ExtraDepRef = Ref; -/// See also [extraDep]. @ProviderFor(extraDep) -final extraDepProvider = AutoDisposeProvider.internal( - extraDep, - name: r'extraDepProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$extraDepHash, - dependencies: [depProvider, dep2Provider], - allTransitiveDependencies: { - depProvider, - ...?depProvider.allTransitiveDependencies, - dep2Provider, - ...?dep2Provider.allTransitiveDependencies - }, -); - -typedef ExtraDepRef = AutoDisposeProviderRef; -String _$noDepHash() => r'38d78ded1eba491968c0200cc0b51969fcf3ec9a'; +const extraDepProvider = ExtraDepProvider._(); + +final class ExtraDepProvider extends $FunctionalProvider + with $Provider { + const ExtraDepProvider._( + {int Function( + ExtraDepRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'extraDepProvider', + isAutoDispose: true, + dependencies: const [depProvider, dep2Provider], + allTransitiveDependencies: const [ + ExtraDepProvider.$allTransitiveDependencies0, + ExtraDepProvider.$allTransitiveDependencies1, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + static const $allTransitiveDependencies1 = dep2Provider; + + final int Function( + ExtraDepRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$extraDepHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExtraDepProvider $copyWithCreate( + int Function( + ExtraDepRef ref, + ) create, + ) { + return ExtraDepProvider._(create: create); + } + + @override + int create(ExtraDepRef ref) { + final fn = _createCb ?? extraDep; + return fn(ref); + } +} + +String _$extraDepHash() => r'038d9c819b5d91eb1f7166194d8e646f17ea24d7'; + +typedef NoDepRef = Ref; -/// See also [noDep]. @ProviderFor(noDep) -final noDepProvider = AutoDisposeProvider.internal( - noDep, - name: r'noDepProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$noDepHash, - dependencies: [depProvider], - allTransitiveDependencies: { - depProvider, - ...?depProvider.allTransitiveDependencies - }, -); - -typedef NoDepRef = AutoDisposeProviderRef; +const noDepProvider = NoDepProvider._(); + +final class NoDepProvider extends $FunctionalProvider + with $Provider { + const NoDepProvider._( + {int Function( + NoDepRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'noDepProvider', + isAutoDispose: true, + dependencies: const [depProvider], + allTransitiveDependencies: const [ + NoDepProvider.$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + + final int Function( + NoDepRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$noDepHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + NoDepProvider $copyWithCreate( + int Function( + NoDepRef ref, + ) create, + ) { + return NoDepProvider._(create: create); + } + + @override + int create(NoDepRef ref) { + final fn = _createCb ?? noDep; + return fn(ref); + } +} + +String _$noDepHash() => r'38d78ded1eba491968c0200cc0b51969fcf3ec9a'; + +typedef DependenciesFirstThenKeepAliveRef = Ref; + +@ProviderFor(dependenciesFirstThenKeepAlive) +const dependenciesFirstThenKeepAliveProvider = + DependenciesFirstThenKeepAliveProvider._(); + +final class DependenciesFirstThenKeepAliveProvider + extends $FunctionalProvider + with $Provider { + const DependenciesFirstThenKeepAliveProvider._( + {int Function( + DependenciesFirstThenKeepAliveRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'dependenciesFirstThenKeepAliveProvider', + isAutoDispose: true, + dependencies: const [depProvider], + allTransitiveDependencies: const [ + DependenciesFirstThenKeepAliveProvider.$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + + final int Function( + DependenciesFirstThenKeepAliveRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$dependenciesFirstThenKeepAliveHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DependenciesFirstThenKeepAliveProvider $copyWithCreate( + int Function( + DependenciesFirstThenKeepAliveRef ref, + ) create, + ) { + return DependenciesFirstThenKeepAliveProvider._(create: create); + } + + @override + int create(DependenciesFirstThenKeepAliveRef ref) { + final fn = _createCb ?? dependenciesFirstThenKeepAlive; + return fn(ref); + } +} + String _$dependenciesFirstThenKeepAliveHash() => r'15604dafd167408515dfb4e846fab0af46e7e566'; -/// See also [dependenciesFirstThenKeepAlive]. -@ProviderFor(dependenciesFirstThenKeepAlive) -final dependenciesFirstThenKeepAliveProvider = - AutoDisposeProvider.internal( - dependenciesFirstThenKeepAlive, - name: r'dependenciesFirstThenKeepAliveProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$dependenciesFirstThenKeepAliveHash, - dependencies: [depProvider], - allTransitiveDependencies: { - depProvider, - ...?depProvider.allTransitiveDependencies - }, -); - -typedef DependenciesFirstThenKeepAliveRef = AutoDisposeProviderRef; -String _$noDepNoParamHash() => r'fe52f15a4d98159beafe8b9a177073f6b6cbae6d'; +typedef NoDepNoParamRef = Ref; -/// See also [noDepNoParam]. @ProviderFor(noDepNoParam) -final noDepNoParamProvider = AutoDisposeProvider.internal( - noDepNoParam, - name: r'noDepNoParamProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$noDepNoParamHash, - dependencies: [depProvider], - allTransitiveDependencies: { - depProvider, - ...?depProvider.allTransitiveDependencies - }, -); - -typedef NoDepNoParamRef = AutoDisposeProviderRef; -String _$noDepWithoutCommaHash() => r'59d5a7874da40605b1b187766ebb4927d2eaae81'; +const noDepNoParamProvider = NoDepNoParamProvider._(); + +final class NoDepNoParamProvider + extends $FunctionalProvider + with $Provider { + const NoDepNoParamProvider._( + {int Function( + NoDepNoParamRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'noDepNoParamProvider', + isAutoDispose: true, + dependencies: const [depProvider], + allTransitiveDependencies: const [ + NoDepNoParamProvider.$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + + final int Function( + NoDepNoParamRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$noDepNoParamHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + NoDepNoParamProvider $copyWithCreate( + int Function( + NoDepNoParamRef ref, + ) create, + ) { + return NoDepNoParamProvider._(create: create); + } + + @override + int create(NoDepNoParamRef ref) { + final fn = _createCb ?? noDepNoParam; + return fn(ref); + } +} + +String _$noDepNoParamHash() => r'fe52f15a4d98159beafe8b9a177073f6b6cbae6d'; + +typedef NoDepWithoutCommaRef = Ref; -/// See also [noDepWithoutComma]. @ProviderFor(noDepWithoutComma) -final noDepWithoutCommaProvider = AutoDisposeProvider.internal( - noDepWithoutComma, - name: r'noDepWithoutCommaProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$noDepWithoutCommaHash, - dependencies: [depProvider], - allTransitiveDependencies: { - depProvider, - ...?depProvider.allTransitiveDependencies - }, -); - -typedef NoDepWithoutCommaRef = AutoDisposeProviderRef; +const noDepWithoutCommaProvider = NoDepWithoutCommaProvider._(); + +final class NoDepWithoutCommaProvider + extends $FunctionalProvider + with $Provider { + const NoDepWithoutCommaProvider._( + {int Function( + NoDepWithoutCommaRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'noDepWithoutCommaProvider', + isAutoDispose: true, + dependencies: const [depProvider], + allTransitiveDependencies: const [ + NoDepWithoutCommaProvider.$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + + final int Function( + NoDepWithoutCommaRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$noDepWithoutCommaHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + NoDepWithoutCommaProvider $copyWithCreate( + int Function( + NoDepWithoutCommaRef ref, + ) create, + ) { + return NoDepWithoutCommaProvider._(create: create); + } + + @override + int create(NoDepWithoutCommaRef ref) { + final fn = _createCb ?? noDepWithoutComma; + return fn(ref); + } +} + +String _$noDepWithoutCommaHash() => r'59d5a7874da40605b1b187766ebb4927d2eaae81'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.freezed.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.freezed.dart index 1b1c8d964..d3b95eea0 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.freezed.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.freezed.dart @@ -12,7 +12,7 @@ part of 'provider_parameters.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$FreezedExample {} diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 3b8b3fa3f..a6e959b5c 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -6,197 +6,136 @@ part of 'provider_parameters.dart'; // RiverpodGenerator // ************************************************************************** -String _$generatorHash() => r'e76b8050c3a272ecef1985e4dc7dfe5df3270f2f'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); +typedef GeneratorRef = Ref; - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [generator]. @ProviderFor(generator) -const generatorProvider = GeneratorFamily(); - -/// See also [generator]. -class GeneratorFamily extends Family { - /// See also [generator]. - const GeneratorFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; +const generatorProvider = GeneratorFamily._(); + +final class GeneratorProvider + extends $FunctionalProvider + with $Provider { + const GeneratorProvider._( + {required GeneratorFamily super.from, + required Object? super.argument, + int Function( + GeneratorRef ref, { + Object? value, + })? create}) + : _createCb = create, + super( + name: r'generatorProvider', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get dependencies => _dependencies; + final int Function( + GeneratorRef ref, { + Object? value, + })? _createCb; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$generatorHash(); @override - String? get name => r'generatorProvider'; - - /// See also [generator]. - GeneratorProvider call({ - Object? value, - }) { - return GeneratorProvider( - value: value, - ); + String toString() { + return r'generatorProvider' + '' + '($argument)'; } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(int Function(GeneratorRef ref) create) { - return _$GeneratorFamilyOverride(this, create); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); } @override - String toString() => 'generatorProvider'; -} - -class _$GeneratorFamilyOverride implements $FamilyOverride { - _$GeneratorFamilyOverride(this.from, this.create); + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); - final int Function(GeneratorRef ref) create; + @override + GeneratorProvider $copyWithCreate( + int Function( + GeneratorRef ref, + ) create, + ) { + return GeneratorProvider._( + argument: argument as Object?, + from: from! as GeneratorFamily, + create: ( + ref, { + Object? value, + }) => + create(ref)); + } @override - final GeneratorFamily from; + int create(GeneratorRef ref) { + final fn = _createCb ?? generator; + final Object? argument = this.argument as Object?; + return fn( + ref, + value: argument, + ); + } @override - _GeneratorProviderElement createElement( - ProviderContainer container, - covariant GeneratorProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is GeneratorProvider && other.argument == argument; } @override - String toString() => 'generatorProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [generator]. -class GeneratorProvider extends Provider { - /// See also [generator]. - GeneratorProvider({ - Object? value, - }) : this._internal( - (ref) => generator( - ref as GeneratorRef, - value: value, - ), - from: generatorProvider, +String _$generatorHash() => r'e76b8050c3a272ecef1985e4dc7dfe5df3270f2f'; + +final class GeneratorFamily extends Family { + const GeneratorFamily._() + : super( name: r'generatorProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$generatorHash, dependencies: null, allTransitiveDependencies: null, - value: value, ); - GeneratorProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.value, - }) : super.internal(); - - final Object? value; - - @override - Override overrideWith( - int Function(GeneratorRef ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: GeneratorProvider._internal( - (ref) => create(ref as GeneratorRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - value: value, - ), - ); - } + GeneratorProvider call({ + Object? value, + }) => + GeneratorProvider._(argument: value, from: this); @override - ({ - Object? value, - }) get argument { - return (value: value,); - } + String debugGetCreateSourceHash() => _$generatorHash(); @override - _GeneratorProviderElement createElement( - ProviderContainer container, - ) { - return _GeneratorProviderElement(this, container); - } + String toString() => r'generatorProvider'; - GeneratorProvider _copyWith( - int Function(GeneratorRef ref) create, + /// {@macro riverpod.override_with} + Override overrideWith( + int Function( + GeneratorRef ref, + Object? args, + ) create, ) { - return GeneratorProvider._internal( - (ref) => create(ref as GeneratorRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - value: value, - ); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GeneratorProvider; - @override - bool operator ==(Object other) { - return other is GeneratorProvider && other.value == value; - } - - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, value.hashCode); + final argument = provider.argument as Object?; - return _SystemHash.finish(hash); + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'generatorProvider$argument'; -} - -mixin GeneratorRef on ProviderRef { - /// The parameter `value` of this provider. - Object? get value; } -class _GeneratorProviderElement extends $ProviderElement - with GeneratorRef { - _GeneratorProviderElement(super.provider, super.container); - - @override - Object? get value => (origin as GeneratorProvider).value; -} +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart index baf6beb59..176f20e36 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart @@ -6,52 +6,182 @@ part of 'scoped_providers_should_specify_dependencies.dart'; // RiverpodGenerator // ************************************************************************** -String _$scopedHash() => r'bbf25968b1186d2dd63d10545364453712d491cf'; +typedef ScopedRef = Ref; -/// See also [scoped]. @ProviderFor(scoped) -final scopedProvider = AutoDisposeProvider.internal( - scoped, - name: r'scopedProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$scopedHash, - dependencies: const [], - allTransitiveDependencies: const {}, -); - -typedef ScopedRef = AutoDisposeProviderRef; +const scopedProvider = ScopedProvider._(); + +final class ScopedProvider extends $FunctionalProvider + with $Provider { + const ScopedProvider._( + {int Function( + ScopedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'scopedProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + ScopedRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$scopedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ScopedProvider $copyWithCreate( + int Function( + ScopedRef ref, + ) create, + ) { + return ScopedProvider._(create: create); + } + + @override + int create(ScopedRef ref) { + final fn = _createCb ?? scoped; + return fn(ref); + } +} + +String _$scopedHash() => r'bbf25968b1186d2dd63d10545364453712d491cf'; + +typedef UnimplementedScopedRef = Ref; + +@ProviderFor(unimplementedScoped) +const unimplementedScopedProvider = UnimplementedScopedProvider._(); + +final class UnimplementedScopedProvider + extends $FunctionalProvider + with $Provider { + const UnimplementedScopedProvider._( + {int Function( + UnimplementedScopedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'unimplementedScopedProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + UnimplementedScopedRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$unimplementedScopedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + UnimplementedScopedProvider $copyWithCreate( + int Function( + UnimplementedScopedRef ref, + ) create, + ) { + return UnimplementedScopedProvider._(create: create); + } + + @override + int create(UnimplementedScopedRef ref) { + final fn = _createCb ?? unimplementedScoped; + return fn(ref); + } +} + String _$unimplementedScopedHash() => r'5f32fc56f4157238612d62ef54038fe92b7cdfe8'; -/// See also [unimplementedScoped]. -@ProviderFor(unimplementedScoped) -final unimplementedScopedProvider = AutoDisposeProvider.internal( - (_) => throw UnsupportedError( - 'The provider "unimplementedScopedProvider" is expected to get overridden/scoped, ' - 'but was accessed without an override.', - ), - name: r'unimplementedScopedProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$unimplementedScopedHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef UnimplementedScopedRef = AutoDisposeProviderRef; -String _$rootHash() => r'1cd85d73316aad02169ff0f5e7af5cf1423410ff'; +typedef RootRef = Ref; -/// See also [root]. @ProviderFor(root) -final rootProvider = AutoDisposeProvider.internal( - root, - name: r'rootProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$rootHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef RootRef = AutoDisposeProviderRef; +const rootProvider = RootProvider._(); + +final class RootProvider extends $FunctionalProvider + with $Provider { + const RootProvider._( + {int Function( + RootRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'rootProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + RootRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$rootHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RootProvider $copyWithCreate( + int Function( + RootRef ref, + ) create, + ) { + return RootProvider._(create: create); + } + + @override + int create(RootRef ref) { + final fn = _createCb ?? root; + return fn(ref); + } +} + +String _$rootHash() => r'1cd85d73316aad02169ff0f5e7af5cf1423410ff'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart index daa5c7372..3323f2f13 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart @@ -6,343 +6,1315 @@ part of 'unsupported_provider_value.dart'; // RiverpodGenerator // ************************************************************************** -String _$integerHash() => r'a8ce0296e677f64c8b9d1893eed85598c096765e'; +typedef IntegerRef = Ref; -/// See also [integer]. @ProviderFor(integer) -final integerProvider = AutoDisposeProvider.internal( - integer, - name: r'integerProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$integerHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef IntegerRef = AutoDisposeProviderRef; -String _$stateNotifierHash() => r'5d517187bf927e19246ffbcc279d59e15df8ef30'; +const integerProvider = IntegerProvider._(); + +final class IntegerProvider extends $FunctionalProvider + with $Provider { + const IntegerProvider._( + {int Function( + IntegerRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'integerProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + IntegerRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$integerHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + IntegerProvider $copyWithCreate( + int Function( + IntegerRef ref, + ) create, + ) { + return IntegerProvider._(create: create); + } + + @override + int create(IntegerRef ref) { + final fn = _createCb ?? integer; + return fn(ref); + } +} + +String _$integerHash() => r'a8ce0296e677f64c8b9d1893eed85598c096765e'; + +typedef StateNotifierRef = Ref; -/// See also [stateNotifier]. @ProviderFor(stateNotifier) -final stateNotifierProvider = AutoDisposeProvider.internal( - stateNotifier, - name: r'stateNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$stateNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef StateNotifierRef = AutoDisposeProviderRef; +const stateNotifierProvider = StateNotifierProvider._(); + +final class StateNotifierProvider extends $FunctionalProvider< + MyStateNotifier, + MyStateNotifier, + StateNotifierRef> with $Provider { + const StateNotifierProvider._( + {MyStateNotifier Function( + StateNotifierRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'stateNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyStateNotifier Function( + StateNotifierRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$stateNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyStateNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + StateNotifierProvider $copyWithCreate( + MyStateNotifier Function( + StateNotifierRef ref, + ) create, + ) { + return StateNotifierProvider._(create: create); + } + + @override + MyStateNotifier create(StateNotifierRef ref) { + final fn = _createCb ?? stateNotifier; + return fn(ref); + } +} + +String _$stateNotifierHash() => r'5d517187bf927e19246ffbcc279d59e15df8ef30'; + +typedef AsyncStateNotifierRef = Ref>; + +@ProviderFor(asyncStateNotifier) +const asyncStateNotifierProvider = AsyncStateNotifierProvider._(); + +final class AsyncStateNotifierProvider extends $FunctionalProvider< + AsyncValue, + FutureOr, + AsyncStateNotifierRef> + with + $FutureModifier, + $FutureProvider { + const AsyncStateNotifierProvider._( + {FutureOr Function( + AsyncStateNotifierRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'asyncStateNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + AsyncStateNotifierRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$asyncStateNotifierHash(); + + @override + $FutureProviderElement createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + AsyncStateNotifierProvider $copyWithCreate( + FutureOr Function( + AsyncStateNotifierRef ref, + ) create, + ) { + return AsyncStateNotifierProvider._(create: create); + } + + @override + FutureOr create(AsyncStateNotifierRef ref) { + final fn = _createCb ?? asyncStateNotifier; + return fn(ref); + } +} + String _$asyncStateNotifierHash() => r'66442390f13e38cd9594f841a7610ab0f632db81'; -/// See also [asyncStateNotifier]. -@ProviderFor(asyncStateNotifier) -final asyncStateNotifierProvider = - AutoDisposeFutureProvider.internal( - asyncStateNotifier, - name: r'asyncStateNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$asyncStateNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef AsyncStateNotifierRef = AutoDisposeFutureProviderRef; +typedef StateNotifierAsyncRef = Ref>; + +@ProviderFor(stateNotifierAsync) +const stateNotifierAsyncProvider = StateNotifierAsyncProvider._(); + +final class StateNotifierAsyncProvider extends $FunctionalProvider< + AsyncValue, + FutureOr, + StateNotifierAsyncRef> + with + $FutureModifier, + $FutureProvider { + const StateNotifierAsyncProvider._( + {FutureOr Function( + StateNotifierAsyncRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'stateNotifierAsyncProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + StateNotifierAsyncRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$stateNotifierAsyncHash(); + + @override + $FutureProviderElement createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + StateNotifierAsyncProvider $copyWithCreate( + FutureOr Function( + StateNotifierAsyncRef ref, + ) create, + ) { + return StateNotifierAsyncProvider._(create: create); + } + + @override + FutureOr create(StateNotifierAsyncRef ref) { + final fn = _createCb ?? stateNotifierAsync; + return fn(ref); + } +} + String _$stateNotifierAsyncHash() => r'9a9b1986076dfdfa4490cc109f1bd0f112a7455c'; -/// See also [stateNotifierAsync]. -@ProviderFor(stateNotifierAsync) -final stateNotifierAsyncProvider = - AutoDisposeFutureProvider.internal( - stateNotifierAsync, - name: r'stateNotifierAsyncProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$stateNotifierAsyncHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef StateNotifierAsyncRef = AutoDisposeFutureProviderRef; -String _$changeNotifierHash() => r'6325328c129773979364c3cfd628f8f696bbaf66'; +typedef ChangeNotifierRef = Ref; -/// See also [changeNotifier]. @ProviderFor(changeNotifier) -final changeNotifierProvider = AutoDisposeProvider.internal( - changeNotifier, - name: r'changeNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$changeNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ChangeNotifierRef = AutoDisposeProviderRef; -String _$notifierHash() => r'2f323c78400044790faaf61912fc98c6153942f6'; +const changeNotifierProvider = ChangeNotifierProvider._(); + +final class ChangeNotifierProvider extends $FunctionalProvider< + MyChangeNotifier, + MyChangeNotifier, + ChangeNotifierRef> with $Provider { + const ChangeNotifierProvider._( + {MyChangeNotifier Function( + ChangeNotifierRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'changeNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyChangeNotifier Function( + ChangeNotifierRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$changeNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyChangeNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + ChangeNotifierProvider $copyWithCreate( + MyChangeNotifier Function( + ChangeNotifierRef ref, + ) create, + ) { + return ChangeNotifierProvider._(create: create); + } + + @override + MyChangeNotifier create(ChangeNotifierRef ref) { + final fn = _createCb ?? changeNotifier; + return fn(ref); + } +} + +String _$changeNotifierHash() => r'6325328c129773979364c3cfd628f8f696bbaf66'; + +typedef NotifierRef = Ref; -/// See also [notifier]. @ProviderFor(notifier) -final notifierProvider = AutoDisposeProvider.internal( - notifier, - name: r'notifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$notifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef NotifierRef = AutoDisposeProviderRef; +const notifierProvider = NotifierProvider._(); + +final class NotifierProvider + extends $FunctionalProvider + with $Provider { + const NotifierProvider._( + {MyNotifier Function( + NotifierRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'notifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function( + NotifierRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$notifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + NotifierProvider $copyWithCreate( + MyNotifier Function( + NotifierRef ref, + ) create, + ) { + return NotifierProvider._(create: create); + } + + @override + MyNotifier create(NotifierRef ref) { + final fn = _createCb ?? notifier; + return fn(ref); + } +} + +String _$notifierHash() => r'2f323c78400044790faaf61912fc98c6153942f6'; + +typedef AutoDisposeNotifierRef = Ref; + +@ProviderFor(autoDisposeNotifier) +const autoDisposeNotifierProvider = AutoDisposeNotifierProvider._(); + +final class AutoDisposeNotifierProvider extends $FunctionalProvider< + MyAutoDisposeNotifier, MyAutoDisposeNotifier, AutoDisposeNotifierRef> + with $Provider { + const AutoDisposeNotifierProvider._( + {MyAutoDisposeNotifier Function( + AutoDisposeNotifierRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'autoDisposeNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyAutoDisposeNotifier Function( + AutoDisposeNotifierRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$autoDisposeNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyAutoDisposeNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + AutoDisposeNotifierProvider $copyWithCreate( + MyAutoDisposeNotifier Function( + AutoDisposeNotifierRef ref, + ) create, + ) { + return AutoDisposeNotifierProvider._(create: create); + } + + @override + MyAutoDisposeNotifier create(AutoDisposeNotifierRef ref) { + final fn = _createCb ?? autoDisposeNotifier; + return fn(ref); + } +} + String _$autoDisposeNotifierHash() => r'620df0fc11c887f01e125454afe8de553cfea6d0'; -/// See also [autoDisposeNotifier]. -@ProviderFor(autoDisposeNotifier) -final autoDisposeNotifierProvider = - AutoDisposeProvider.internal( - autoDisposeNotifier, - name: r'autoDisposeNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$autoDisposeNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef AutoDisposeNotifierRef = AutoDisposeProviderRef; -String _$asyncNotifierHash() => r'c90348efac71d241468236924f6c6bc80ae0d0e0'; +typedef AsyncNotifierRef = Ref; -/// See also [asyncNotifier]. @ProviderFor(asyncNotifier) -final asyncNotifierProvider = AutoDisposeProvider.internal( - asyncNotifier, - name: r'asyncNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$asyncNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef AsyncNotifierRef = AutoDisposeProviderRef; -String _$rawNotifierHash() => r'c01adc70a8e08258bf5d13024aa8e9b86359a2b2'; +const asyncNotifierProvider = AsyncNotifierProvider._(); + +final class AsyncNotifierProvider extends $FunctionalProvider< + MyAsyncNotifier, + MyAsyncNotifier, + AsyncNotifierRef> with $Provider { + const AsyncNotifierProvider._( + {MyAsyncNotifier Function( + AsyncNotifierRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'asyncNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyAsyncNotifier Function( + AsyncNotifierRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$asyncNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyAsyncNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + AsyncNotifierProvider $copyWithCreate( + MyAsyncNotifier Function( + AsyncNotifierRef ref, + ) create, + ) { + return AsyncNotifierProvider._(create: create); + } + + @override + MyAsyncNotifier create(AsyncNotifierRef ref) { + final fn = _createCb ?? asyncNotifier; + return fn(ref); + } +} + +String _$asyncNotifierHash() => r'c90348efac71d241468236924f6c6bc80ae0d0e0'; + +typedef RawNotifierRef = Ref>; -/// See also [rawNotifier]. @ProviderFor(rawNotifier) -final rawNotifierProvider = AutoDisposeProvider>.internal( - rawNotifier, - name: r'rawNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$rawNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef RawNotifierRef = AutoDisposeProviderRef>; -String _$rawFutureNotifierHash() => r'883253dbf7ade868c44b288ec3da02be64dcfb20'; +const rawNotifierProvider = RawNotifierProvider._(); + +final class RawNotifierProvider extends $FunctionalProvider< + Raw, + Raw, + RawNotifierRef> with $Provider, RawNotifierRef> { + const RawNotifierProvider._( + {Raw Function( + RawNotifierRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'rawNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw Function( + RawNotifierRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$rawNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @override + $ProviderElement> createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + RawNotifierProvider $copyWithCreate( + Raw Function( + RawNotifierRef ref, + ) create, + ) { + return RawNotifierProvider._(create: create); + } + + @override + Raw create(RawNotifierRef ref) { + final fn = _createCb ?? rawNotifier; + return fn(ref); + } +} + +String _$rawNotifierHash() => r'c01adc70a8e08258bf5d13024aa8e9b86359a2b2'; + +typedef RawFutureNotifierRef = Ref>>; -/// See also [rawFutureNotifier]. @ProviderFor(rawFutureNotifier) -final rawFutureNotifierProvider = - AutoDisposeProvider>>.internal( - rawFutureNotifier, - name: r'rawFutureNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$rawFutureNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef RawFutureNotifierRef - = AutoDisposeProviderRef>>; -String _$rawStreamNotifierHash() => r'f22f6a906e275c6245365bf029e2dc217cf3a301'; +const rawFutureNotifierProvider = RawFutureNotifierProvider._(); + +final class RawFutureNotifierProvider extends $FunctionalProvider< + Raw>, + Raw>, + RawFutureNotifierRef> + with $Provider>, RawFutureNotifierRef> { + const RawFutureNotifierProvider._( + {Raw> Function( + RawFutureNotifierRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'rawFutureNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + RawFutureNotifierRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$rawFutureNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @override + $ProviderElement>> createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + RawFutureNotifierProvider $copyWithCreate( + Raw> Function( + RawFutureNotifierRef ref, + ) create, + ) { + return RawFutureNotifierProvider._(create: create); + } + + @override + Raw> create(RawFutureNotifierRef ref) { + final fn = _createCb ?? rawFutureNotifier; + return fn(ref); + } +} + +String _$rawFutureNotifierHash() => r'883253dbf7ade868c44b288ec3da02be64dcfb20'; + +typedef RawStreamNotifierRef = Ref>>; -/// See also [rawStreamNotifier]. @ProviderFor(rawStreamNotifier) -final rawStreamNotifierProvider = - AutoDisposeProvider>>.internal( - rawStreamNotifier, - name: r'rawStreamNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$rawStreamNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef RawStreamNotifierRef - = AutoDisposeProviderRef>>; -String _$futureRawNotifierHash() => r'd70ca757ff2539fc698ff924c135ee5e88a98018'; +const rawStreamNotifierProvider = RawStreamNotifierProvider._(); + +final class RawStreamNotifierProvider extends $FunctionalProvider< + Raw>, + Raw>, + RawStreamNotifierRef> + with $Provider>, RawStreamNotifierRef> { + const RawStreamNotifierProvider._( + {Raw> Function( + RawStreamNotifierRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'rawStreamNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + RawStreamNotifierRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$rawStreamNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @override + $ProviderElement>> createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + RawStreamNotifierProvider $copyWithCreate( + Raw> Function( + RawStreamNotifierRef ref, + ) create, + ) { + return RawStreamNotifierProvider._(create: create); + } + + @override + Raw> create(RawStreamNotifierRef ref) { + final fn = _createCb ?? rawStreamNotifier; + return fn(ref); + } +} + +String _$rawStreamNotifierHash() => r'f22f6a906e275c6245365bf029e2dc217cf3a301'; + +typedef FutureRawNotifierRef = Ref>>; -/// See also [futureRawNotifier]. @ProviderFor(futureRawNotifier) -final futureRawNotifierProvider = - AutoDisposeFutureProvider>.internal( - futureRawNotifier, - name: r'futureRawNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$futureRawNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef FutureRawNotifierRef - = AutoDisposeFutureProviderRef>; -String _$streamRawNotifierHash() => r'b1075c37ef3e8a83dfb9a3d469b76bd4855c336f'; +const futureRawNotifierProvider = FutureRawNotifierProvider._(); + +final class FutureRawNotifierProvider extends $FunctionalProvider< + AsyncValue>, + FutureOr>, + FutureRawNotifierRef> + with + $FutureModifier>, + $FutureProvider, FutureRawNotifierRef> { + const FutureRawNotifierProvider._( + {FutureOr> Function( + FutureRawNotifierRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'futureRawNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + FutureRawNotifierRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$futureRawNotifierHash(); + + @override + $FutureProviderElement> createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + FutureRawNotifierProvider $copyWithCreate( + FutureOr> Function( + FutureRawNotifierRef ref, + ) create, + ) { + return FutureRawNotifierProvider._(create: create); + } + + @override + FutureOr> create(FutureRawNotifierRef ref) { + final fn = _createCb ?? futureRawNotifier; + return fn(ref); + } +} + +String _$futureRawNotifierHash() => r'd70ca757ff2539fc698ff924c135ee5e88a98018'; + +typedef StreamRawNotifierRef = Ref>>; -/// See also [streamRawNotifier]. @ProviderFor(streamRawNotifier) -final streamRawNotifierProvider = - AutoDisposeStreamProvider>.internal( - streamRawNotifier, - name: r'streamRawNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$streamRawNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef StreamRawNotifierRef - = AutoDisposeStreamProviderRef>; +const streamRawNotifierProvider = StreamRawNotifierProvider._(); + +final class StreamRawNotifierProvider extends $FunctionalProvider< + AsyncValue>, + Stream>, + StreamRawNotifierRef> + with + $FutureModifier>, + $StreamProvider, StreamRawNotifierRef> { + const StreamRawNotifierProvider._( + {Stream> Function( + StreamRawNotifierRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'streamRawNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream> Function( + StreamRawNotifierRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$streamRawNotifierHash(); + + @override + $StreamProviderElement> createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + StreamRawNotifierProvider $copyWithCreate( + Stream> Function( + StreamRawNotifierRef ref, + ) create, + ) { + return StreamRawNotifierProvider._(create: create); + } + + @override + Stream> create(StreamRawNotifierRef ref) { + final fn = _createCb ?? streamRawNotifier; + return fn(ref); + } +} + +String _$streamRawNotifierHash() => r'b1075c37ef3e8a83dfb9a3d469b76bd4855c336f'; + +@ProviderFor(StateNotifierClass) +const stateNotifierClassProvider = StateNotifierClassProvider._(); + +final class StateNotifierClassProvider + extends $NotifierProvider { + const StateNotifierClassProvider._( + {super.runNotifierBuildOverride, StateNotifierClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'stateNotifierClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final StateNotifierClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$stateNotifierClassHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyStateNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + StateNotifierClass create() => _createCb?.call() ?? StateNotifierClass(); + + @$internal + @override + StateNotifierClassProvider $copyWithCreate( + StateNotifierClass Function() create, + ) { + return StateNotifierClassProvider._(create: create); + } + + @$internal + @override + StateNotifierClassProvider $copyWithBuild( + MyStateNotifier Function( + Ref, + StateNotifierClass, + ) build, + ) { + return StateNotifierClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$stateNotifierClassHash() => r'576978be5b8a02c212afe7afbe37c733a49ecbce'; -/// See also [StateNotifierClass]. -@ProviderFor(StateNotifierClass) -final stateNotifierClassProvider = - AutoDisposeNotifierProvider.internal( - StateNotifierClass.new, - name: r'stateNotifierClassProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$stateNotifierClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$StateNotifierClass = AutoDisposeNotifier; -String _$selfNotifierHash() => r'5a857f5c92a9b7a35daa4e527bd333cf3d8d19ac'; +abstract class _$StateNotifierClass extends $Notifier { + MyStateNotifier build(); + @$internal + @override + MyStateNotifier runBuild() => build(); +} -/// See also [SelfNotifier]. @ProviderFor(SelfNotifier) -final selfNotifierProvider = - AutoDisposeAsyncNotifierProvider.internal( - SelfNotifier.new, - name: r'selfNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$selfNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$SelfNotifier = AutoDisposeAsyncNotifier; -String _$syncSelfNotifierHash() => r'4f3a2463cb5693a5c8d7e772b4d7c9774b9ba637'; +const selfNotifierProvider = SelfNotifierProvider._(); + +final class SelfNotifierProvider + extends $AsyncNotifierProvider { + const SelfNotifierProvider._( + {super.runNotifierBuildOverride, SelfNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'selfNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final SelfNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$selfNotifierHash(); + + @$internal + @override + SelfNotifier create() => _createCb?.call() ?? SelfNotifier(); + + @$internal + @override + SelfNotifierProvider $copyWithCreate( + SelfNotifier Function() create, + ) { + return SelfNotifierProvider._(create: create); + } + + @$internal + @override + SelfNotifierProvider $copyWithBuild( + FutureOr Function( + Ref>, + SelfNotifier, + ) build, + ) { + return SelfNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$selfNotifierHash() => r'5a857f5c92a9b7a35daa4e527bd333cf3d8d19ac'; + +abstract class _$SelfNotifier extends $AsyncNotifier { + FutureOr build(); + @$internal + @override + FutureOr runBuild() => build(); +} -/// See also [SyncSelfNotifier]. @ProviderFor(SyncSelfNotifier) -final syncSelfNotifierProvider = - AutoDisposeNotifierProvider.internal( - SyncSelfNotifier.new, - name: r'syncSelfNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$syncSelfNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$SyncSelfNotifier = AutoDisposeNotifier; +const syncSelfNotifierProvider = SyncSelfNotifierProvider._(); + +final class SyncSelfNotifierProvider + extends $NotifierProvider { + const SyncSelfNotifierProvider._( + {super.runNotifierBuildOverride, SyncSelfNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'syncSelfNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final SyncSelfNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$syncSelfNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(SyncSelfNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + SyncSelfNotifier create() => _createCb?.call() ?? SyncSelfNotifier(); + + @$internal + @override + SyncSelfNotifierProvider $copyWithCreate( + SyncSelfNotifier Function() create, + ) { + return SyncSelfNotifierProvider._(create: create); + } + + @$internal + @override + SyncSelfNotifierProvider $copyWithBuild( + SyncSelfNotifier Function( + Ref, + SyncSelfNotifier, + ) build, + ) { + return SyncSelfNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$syncSelfNotifierHash() => r'4f3a2463cb5693a5c8d7e772b4d7c9774b9ba637'; + +abstract class _$SyncSelfNotifier extends $Notifier { + SyncSelfNotifier build(); + @$internal + @override + SyncSelfNotifier runBuild() => build(); +} + +@ProviderFor(StreamSelfNotifier) +const streamSelfNotifierProvider = StreamSelfNotifierProvider._(); + +final class StreamSelfNotifierProvider + extends $StreamNotifierProvider { + const StreamSelfNotifierProvider._( + {super.runNotifierBuildOverride, StreamSelfNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'streamSelfNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final StreamSelfNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$streamSelfNotifierHash(); + + @$internal + @override + StreamSelfNotifier create() => _createCb?.call() ?? StreamSelfNotifier(); + + @$internal + @override + StreamSelfNotifierProvider $copyWithCreate( + StreamSelfNotifier Function() create, + ) { + return StreamSelfNotifierProvider._(create: create); + } + + @$internal + @override + StreamSelfNotifierProvider $copyWithBuild( + Stream Function( + Ref>, + StreamSelfNotifier, + ) build, + ) { + return StreamSelfNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $StreamNotifierProviderElement + createElement(ProviderContainer container) => + $StreamNotifierProviderElement(this, container); +} + String _$streamSelfNotifierHash() => r'18705475d157d8e592205406c0b884b7213d329e'; -/// See also [StreamSelfNotifier]. -@ProviderFor(StreamSelfNotifier) -final streamSelfNotifierProvider = AutoDisposeStreamNotifierProvider< - StreamSelfNotifier, StreamSelfNotifier>.internal( - StreamSelfNotifier.new, - name: r'streamSelfNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$streamSelfNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$StreamSelfNotifier = AutoDisposeStreamNotifier; +abstract class _$StreamSelfNotifier + extends $StreamNotifier { + Stream build(); + @$internal + @override + Stream runBuild() => build(); +} + +@ProviderFor(StateNotifierClassAsync) +const stateNotifierClassAsyncProvider = StateNotifierClassAsyncProvider._(); + +final class StateNotifierClassAsyncProvider + extends $AsyncNotifierProvider { + const StateNotifierClassAsyncProvider._( + {super.runNotifierBuildOverride, + StateNotifierClassAsync Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'stateNotifierClassAsyncProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final StateNotifierClassAsync Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$stateNotifierClassAsyncHash(); + + @$internal + @override + StateNotifierClassAsync create() => + _createCb?.call() ?? StateNotifierClassAsync(); + + @$internal + @override + StateNotifierClassAsyncProvider $copyWithCreate( + StateNotifierClassAsync Function() create, + ) { + return StateNotifierClassAsyncProvider._(create: create); + } + + @$internal + @override + StateNotifierClassAsyncProvider $copyWithBuild( + FutureOr Function( + Ref>, + StateNotifierClassAsync, + ) build, + ) { + return StateNotifierClassAsyncProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement + createElement(ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + String _$stateNotifierClassAsyncHash() => r'06c519ed7dbdcd9440365dd2dc3ec12e603b6b7e'; -/// See also [StateNotifierClassAsync]. -@ProviderFor(StateNotifierClassAsync) -final stateNotifierClassAsyncProvider = AutoDisposeAsyncNotifierProvider< - StateNotifierClassAsync, MyStateNotifier>.internal( - StateNotifierClassAsync.new, - name: r'stateNotifierClassAsyncProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$stateNotifierClassAsyncHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$StateNotifierClassAsync = AutoDisposeAsyncNotifier; +abstract class _$StateNotifierClassAsync + extends $AsyncNotifier { + FutureOr build(); + @$internal + @override + FutureOr runBuild() => build(); +} + +@ProviderFor(ChangeNotifierClass) +const changeNotifierClassProvider = ChangeNotifierClassProvider._(); + +final class ChangeNotifierClassProvider + extends $NotifierProvider { + const ChangeNotifierClassProvider._( + {super.runNotifierBuildOverride, ChangeNotifierClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'changeNotifierClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ChangeNotifierClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$changeNotifierClassHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyChangeNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + ChangeNotifierClass create() => _createCb?.call() ?? ChangeNotifierClass(); + + @$internal + @override + ChangeNotifierClassProvider $copyWithCreate( + ChangeNotifierClass Function() create, + ) { + return ChangeNotifierClassProvider._(create: create); + } + + @$internal + @override + ChangeNotifierClassProvider $copyWithBuild( + MyChangeNotifier Function( + Ref, + ChangeNotifierClass, + ) build, + ) { + return ChangeNotifierClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$changeNotifierClassHash() => r'c9716469ce2f8e7a1a6063587ae8733999e51a6e'; -/// See also [ChangeNotifierClass]. -@ProviderFor(ChangeNotifierClass) -final changeNotifierClassProvider = - AutoDisposeNotifierProvider.internal( - ChangeNotifierClass.new, - name: r'changeNotifierClassProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$changeNotifierClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$ChangeNotifierClass = AutoDisposeNotifier; -String _$notifierClassHash() => r'e7eefebec2fca4f982582449e7ec14322932b748'; +abstract class _$ChangeNotifierClass extends $Notifier { + MyChangeNotifier build(); + @$internal + @override + MyChangeNotifier runBuild() => build(); +} -/// See also [NotifierClass]. @ProviderFor(NotifierClass) -final notifierClassProvider = - AutoDisposeNotifierProvider.internal( - NotifierClass.new, - name: r'notifierClassProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$notifierClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$NotifierClass = AutoDisposeNotifier; +const notifierClassProvider = NotifierClassProvider._(); + +final class NotifierClassProvider + extends $NotifierProvider { + const NotifierClassProvider._( + {super.runNotifierBuildOverride, NotifierClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'notifierClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final NotifierClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$notifierClassHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + NotifierClass create() => _createCb?.call() ?? NotifierClass(); + + @$internal + @override + NotifierClassProvider $copyWithCreate( + NotifierClass Function() create, + ) { + return NotifierClassProvider._(create: create); + } + + @$internal + @override + NotifierClassProvider $copyWithBuild( + MyNotifier Function( + Ref, + NotifierClass, + ) build, + ) { + return NotifierClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$notifierClassHash() => r'e7eefebec2fca4f982582449e7ec14322932b748'; + +abstract class _$NotifierClass extends $Notifier { + MyNotifier build(); + @$internal + @override + MyNotifier runBuild() => build(); +} + +@ProviderFor(AsyncNotifierClass) +const asyncNotifierClassProvider = AsyncNotifierClassProvider._(); + +final class AsyncNotifierClassProvider + extends $NotifierProvider { + const AsyncNotifierClassProvider._( + {super.runNotifierBuildOverride, AsyncNotifierClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'asyncNotifierClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final AsyncNotifierClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$asyncNotifierClassHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyAsyncNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + AsyncNotifierClass create() => _createCb?.call() ?? AsyncNotifierClass(); + + @$internal + @override + AsyncNotifierClassProvider $copyWithCreate( + AsyncNotifierClass Function() create, + ) { + return AsyncNotifierClassProvider._(create: create); + } + + @$internal + @override + AsyncNotifierClassProvider $copyWithBuild( + MyAsyncNotifier Function( + Ref, + AsyncNotifierClass, + ) build, + ) { + return AsyncNotifierClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$asyncNotifierClassHash() => r'815a238752d324b136166c409a39fd3f0db67267'; -/// See also [AsyncNotifierClass]. -@ProviderFor(AsyncNotifierClass) -final asyncNotifierClassProvider = - AutoDisposeNotifierProvider.internal( - AsyncNotifierClass.new, - name: r'asyncNotifierClassProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$asyncNotifierClassHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$AsyncNotifierClass = AutoDisposeNotifier; +abstract class _$AsyncNotifierClass extends $Notifier { + MyAsyncNotifier build(); + @$internal + @override + MyAsyncNotifier runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/advanced/select/select/codegen.g.dart b/website/docs/advanced/select/select/codegen.g.dart index 9e44ffe6d..6c0d06d33 100644 --- a/website/docs/advanced/select/select/codegen.g.dart +++ b/website/docs/advanced/select/select/codegen.g.dart @@ -8,19 +8,64 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'72881c6147d44adb957180debefe7696d93107f0'; +typedef ExampleRef = Ref; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {User Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final User Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(User value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + User Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + User create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'72881c6147d44adb957180debefe7696d93107f0'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/advanced/select/select_async/codegen.g.dart b/website/docs/advanced/select/select_async/codegen.g.dart index 1f422ec8a..67c604d36 100644 --- a/website/docs/advanced/select/select_async/codegen.g.dart +++ b/website/docs/advanced/select/select_async/codegen.g.dart @@ -8,19 +8,65 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'1fccbdbec0e3585bc9d3a5709ac88a8919dd78fa'; +typedef ExampleRef = Ref; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {Object? Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Object? Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Object? value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + Object? Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + Object? create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'1fccbdbec0e3585bc9d3a5709ac88a8919dd78fa'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.freezed.dart b/website/docs/case_studies/cancel/detail_screen/codegen.freezed.dart index 96f1b9a0b..1020def96 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.freezed.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Activity _$ActivityFromJson(Map json) { return _Activity.fromJson(json); diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart index 4d688e552..7f234a266 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart @@ -28,19 +28,57 @@ Map _$$ActivityImplToJson(_$ActivityImpl instance) => // RiverpodGenerator // ************************************************************************** -String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; +typedef ActivityRef = Ref>; -/// See also [activity]. @ProviderFor(activity) -final activityProvider = AutoDisposeFutureProvider.internal( - activity, - name: r'activityProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ActivityRef = AutoDisposeFutureProviderRef; +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final fn = _createCb ?? activity; + return fn(ref); + } +} + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart index 67a5099bf..0c963f9b6 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -8,19 +8,57 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$activityHash() => r'304864a6b8051925061a2bba397574ec45b94d08'; +typedef ActivityRef = Ref>; -/// See also [activity]. @ProviderFor(activity) -final activityProvider = AutoDisposeFutureProvider.internal( - activity, - name: r'activityProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ActivityRef = AutoDisposeFutureProviderRef; +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final fn = _createCb ?? activity; + return fn(ref); + } +} + +String _$activityHash() => r'304864a6b8051925061a2bba397574ec45b94d08'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart index 2f62270bc..3d96babf2 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -8,19 +8,57 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$activityHash() => r'ef908e3b46693862f082769663b14d5369d6e155'; +typedef ActivityRef = Ref>; -/// See also [activity]. @ProviderFor(activity) -final activityProvider = AutoDisposeFutureProvider.internal( - activity, - name: r'activityProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ActivityRef = AutoDisposeFutureProviderRef; +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final fn = _createCb ?? activity; + return fn(ref); + } +} + +String _$activityHash() => r'ef908e3b46693862f082769663b14d5369d6e155'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart index 7c8195c7b..7f45384f6 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -8,19 +8,57 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$activityHash() => r'f045dd6e89fde6bbe12a89f243290d289a3e692d'; +typedef ActivityRef = Ref>; -/// See also [activity]. @ProviderFor(activity) -final activityProvider = AutoDisposeFutureProvider.internal( - activity, - name: r'activityProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ActivityRef = AutoDisposeFutureProviderRef; +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final fn = _createCb ?? activity; + return fn(ref); + } +} + +String _$activityHash() => r'f045dd6e89fde6bbe12a89f243290d289a3e692d'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/pull_to_refresh/activity/codegen.freezed.dart b/website/docs/case_studies/pull_to_refresh/activity/codegen.freezed.dart index 96f1b9a0b..1020def96 100644 --- a/website/docs/case_studies/pull_to_refresh/activity/codegen.freezed.dart +++ b/website/docs/case_studies/pull_to_refresh/activity/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Activity _$ActivityFromJson(Map json) { return _Activity.fromJson(json); diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart index fa23157e9..d9f41cf7a 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -8,19 +8,57 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; +typedef ActivityRef = Ref>; -/// See also [activity]. @ProviderFor(activity) -final activityProvider = AutoDisposeFutureProvider.internal( - activity, - name: r'activityProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ActivityRef = AutoDisposeFutureProviderRef; +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final fn = _createCb ?? activity; + return fn(ref); + } +} + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.freezed.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.freezed.dart index 96f1b9a0b..1020def96 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.freezed.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Activity _$ActivityFromJson(Map json) { return _Activity.fromJson(json); diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart index 4d688e552..7f234a266 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -28,19 +28,57 @@ Map _$$ActivityImplToJson(_$ActivityImpl instance) => // RiverpodGenerator // ************************************************************************** -String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; +typedef ActivityRef = Ref>; -/// See also [activity]. @ProviderFor(activity) -final activityProvider = AutoDisposeFutureProvider.internal( - activity, - name: r'activityProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ActivityRef = AutoDisposeFutureProviderRef; +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final fn = _createCb ?? activity; + return fn(ref); + } +} + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 7bb0e49dc..86fce98be 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -8,197 +8,129 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$fetchUserHash() => r'ff427bbb4130a8a6994fa623ae70997f7b0f6bdb'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); +typedef FetchUserRef = Ref>; - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [fetchUser]. @ProviderFor(fetchUser) -const fetchUserProvider = FetchUserFamily(); - -/// See also [fetchUser]. -class FetchUserFamily extends Family { - /// See also [fetchUser]. - const FetchUserFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; +const fetchUserProvider = FetchUserFamily._(); + +final class FetchUserProvider + extends $FunctionalProvider, FutureOr, FetchUserRef> + with $FutureModifier, $FutureProvider { + const FetchUserProvider._( + {required FetchUserFamily super.from, + required int super.argument, + FutureOr Function( + FetchUserRef ref, { + required int userId, + })? create}) + : _createCb = create, + super( + name: r'fetchUserProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get dependencies => _dependencies; + final FutureOr Function( + FetchUserRef ref, { + required int userId, + })? _createCb; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$fetchUserHash(); @override - String? get name => r'fetchUserProvider'; - - /// See also [fetchUser]. - FetchUserProvider call({ - required int userId, - }) { - return FetchUserProvider( - userId: userId, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(FutureOr Function(FetchUserRef ref) create) { - return _$FetchUserFamilyOverride(this, create); + String toString() { + return r'fetchUserProvider' + '' + '($argument)'; } @override - String toString() => 'fetchUserProvider'; -} + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); -class _$FetchUserFamilyOverride implements $FamilyOverride { - _$FetchUserFamilyOverride(this.from, this.create); - - final FutureOr Function(FetchUserRef ref) create; + @override + FetchUserProvider $copyWithCreate( + FutureOr Function( + FetchUserRef ref, + ) create, + ) { + return FetchUserProvider._( + argument: argument as int, + from: from! as FetchUserFamily, + create: ( + ref, { + required int userId, + }) => + create(ref)); + } @override - final FetchUserFamily from; + FutureOr create(FetchUserRef ref) { + final fn = _createCb ?? fetchUser; + final int argument = this.argument as int; + return fn( + ref, + userId: argument, + ); + } @override - _FetchUserProviderElement createElement( - ProviderContainer container, - covariant FetchUserProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is FetchUserProvider && other.argument == argument; } @override - String toString() => 'fetchUserProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [fetchUser]. -class FetchUserProvider extends AutoDisposeFutureProvider { - /// See also [fetchUser]. - FetchUserProvider({ - required int userId, - }) : this._internal( - (ref) => fetchUser( - ref as FetchUserRef, - userId: userId, - ), - from: fetchUserProvider, +String _$fetchUserHash() => r'ff427bbb4130a8a6994fa623ae70997f7b0f6bdb'; + +final class FetchUserFamily extends Family { + const FetchUserFamily._() + : super( name: r'fetchUserProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$fetchUserHash, dependencies: null, allTransitiveDependencies: null, - userId: userId, + isAutoDispose: true, ); - FetchUserProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.userId, - }) : super.internal(); - - final int userId; - - @override - Override overrideWith( - FutureOr Function(FetchUserRef ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: FetchUserProvider._internal( - (ref) => create(ref as FetchUserRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - userId: userId, - ), - ); - } + FetchUserProvider call({ + required int userId, + }) => + FetchUserProvider._(argument: userId, from: this); @override - ({ - int userId, - }) get argument { - return (userId: userId,); - } + String debugGetCreateSourceHash() => _$fetchUserHash(); @override - _FetchUserProviderElement createElement( - ProviderContainer container, - ) { - return _FetchUserProviderElement(this, container); - } + String toString() => r'fetchUserProvider'; - FetchUserProvider _copyWith( - FutureOr Function(FetchUserRef ref) create, + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr Function( + FetchUserRef ref, + int args, + ) create, ) { - return FetchUserProvider._internal( - (ref) => create(ref as FetchUserRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - userId: userId, - ); - } - - @override - bool operator ==(Object other) { - return other is FetchUserProvider && other.userId == userId; - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FetchUserProvider; - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, userId.hashCode); + final argument = provider.argument as int; - return _SystemHash.finish(hash); + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'fetchUserProvider$argument'; -} - -mixin FetchUserRef on AutoDisposeFutureProviderRef { - /// The parameter `userId` of this provider. - int get userId; } -class _FetchUserProviderElement extends AutoDisposeFutureProviderElement - with FetchUserRef { - _FetchUserProviderElement(super.provider, super.container); - - @override - int get userId => (origin as FetchUserProvider).userId; -} +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart index 0fe4488e1..7ca059265 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart @@ -8,20 +8,66 @@ part of 'async_class_future.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $AsyncNotifierProvider { + const ExampleProvider._( + {super.runNotifierBuildOverride, Example Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Example Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + Example create() => _createCb?.call() ?? Example(); + + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._(create: create); + } + + @$internal + @override + ExampleProvider $copyWithBuild( + FutureOr Function( + Ref>, + Example, + ) build, + ) { + return ExampleProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + String _$exampleHash() => r'8a906741b8ea4b9b0d3f0b924779704b3e1773a1'; -/// See also [Example]. -@ProviderFor(Example) -final exampleProvider = - AutoDisposeAsyncNotifierProvider.internal( - Example.new, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Example = AutoDisposeAsyncNotifier; +abstract class _$Example extends $AsyncNotifier { + FutureOr build(); + @$internal + @override + FutureOr runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart index e44bf1860..ad70f244a 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart @@ -8,20 +8,66 @@ part of 'async_class_stream.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $StreamNotifierProvider { + const ExampleProvider._( + {super.runNotifierBuildOverride, Example Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Example Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + Example create() => _createCb?.call() ?? Example(); + + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._(create: create); + } + + @$internal + @override + ExampleProvider $copyWithBuild( + Stream Function( + Ref>, + Example, + ) build, + ) { + return ExampleProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $StreamNotifierProviderElement createElement( + ProviderContainer container) => + $StreamNotifierProviderElement(this, container); +} + String _$exampleHash() => r'4bca936132b77a9a804549f086f33571724b4804'; -/// See also [Example]. -@ProviderFor(Example) -final exampleProvider = - AutoDisposeStreamNotifierProvider.internal( - Example.new, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Example = AutoDisposeStreamNotifier; +abstract class _$Example extends $StreamNotifier { + Stream build(); + @$internal + @override + Stream runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart index f22d58704..06a72a0be 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -8,19 +8,57 @@ part of 'async_fn_future.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'e620af6b870a76eea4228989433de0666957d813'; +typedef ExampleRef = Ref>; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeFutureProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeFutureProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'e620af6b870a76eea4228989433de0666957d813'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart index 56ff2877e..2e2196c6f 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -8,19 +8,57 @@ part of 'async_fn_stream.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'8a2b19776fb9bbb1631f898bd6446b57b102dd9d'; +typedef ExampleRef = Ref>; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeStreamProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeStreamProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider, Stream, ExampleRef> + with $FutureModifier, $StreamProvider { + const ExampleProvider._( + {Stream Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + Stream Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + Stream create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'8a2b19776fb9bbb1631f898bd6446b57b102dd9d'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart index 98e4139ea..2633ed7f0 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -8,33 +8,124 @@ part of 'auto_dispose.dart'; // RiverpodGenerator // ************************************************************************** -String _$example1Hash() => r'8a5f0865f758792cc8e4f2ca67db334196df6e88'; +typedef Example1Ref = Ref; -/// See also [example1]. @ProviderFor(example1) -final example1Provider = AutoDisposeProvider.internal( - example1, - name: r'example1Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$example1Hash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef Example1Ref = AutoDisposeProviderRef; -String _$example2Hash() => r'bc25731d759be185125d12d995d0b89b07d1e271'; +const example1Provider = Example1Provider._(); + +final class Example1Provider + extends $FunctionalProvider + with $Provider { + const Example1Provider._( + {String Function( + Example1Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'example1Provider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + Example1Ref ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$example1Hash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Example1Provider $copyWithCreate( + String Function( + Example1Ref ref, + ) create, + ) { + return Example1Provider._(create: create); + } + + @override + String create(Example1Ref ref) { + final fn = _createCb ?? example1; + return fn(ref); + } +} + +String _$example1Hash() => r'8a5f0865f758792cc8e4f2ca67db334196df6e88'; + +typedef Example2Ref = Ref; -/// See also [example2]. @ProviderFor(example2) -final example2Provider = Provider.internal( - example2, - name: r'example2Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$example2Hash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef Example2Ref = ProviderRef; +const example2Provider = Example2Provider._(); + +final class Example2Provider + extends $FunctionalProvider + with $Provider { + const Example2Provider._( + {String Function( + Example2Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'example2Provider', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + Example2Ref ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$example2Hash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Example2Provider $copyWithCreate( + String Function( + Example2Ref ref, + ) create, + ) { + return Example2Provider._(create: create); + } + + @override + String create(Example2Ref ref) { + final fn = _createCb ?? example2; + return fn(ref); + } +} + +String _$example2Hash() => r'bc25731d759be185125d12d995d0b89b07d1e271'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 3589da5d8..64aa3c009 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -8,195 +8,137 @@ part of 'family.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'c4f5a651a55bcf34b0c92d98d77436844cbdc097'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); +typedef ExampleRef = Ref; - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [example]. @ProviderFor(example) -const exampleProvider = ExampleFamily(); - -/// See also [example]. -class ExampleFamily extends Family { - /// See also [example]. - const ExampleFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; +const exampleProvider = ExampleFamily._(); + +final class ExampleProvider + extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {required ExampleFamily super.from, + required int super.argument, + String Function( + ExampleRef ref, + int param, + )? create}) + : _createCb = create, + super( + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get dependencies => _dependencies; + final String Function( + ExampleRef ref, + int param, + )? _createCb; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$exampleHash(); @override - String? get name => r'exampleProvider'; - - /// See also [example]. - ExampleProvider call( - int param, - ) { - return ExampleProvider( - param, - ); + String toString() { + return r'exampleProvider' + '' + '($argument)'; } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(String Function(ExampleRef ref) create) { - return _$ExampleFamilyOverride(this, create); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); } @override - String toString() => 'exampleProvider'; -} + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); -class _$ExampleFamilyOverride implements $FamilyOverride { - _$ExampleFamilyOverride(this.from, this.create); - - final String Function(ExampleRef ref) create; + @override + ExampleProvider $copyWithCreate( + String Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._( + argument: argument as int, + from: from! as ExampleFamily, + create: ( + ref, + int param, + ) => + create(ref)); + } @override - final ExampleFamily from; + String create(ExampleRef ref) { + final fn = _createCb ?? example; + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } @override - _ExampleProviderElement createElement( - ProviderContainer container, - covariant ExampleProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is ExampleProvider && other.argument == argument; } @override - String toString() => 'exampleProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [example]. -class ExampleProvider extends AutoDisposeProvider { - /// See also [example]. - ExampleProvider( - int param, - ) : this._internal( - (ref) => example( - ref as ExampleRef, - param, - ), - from: exampleProvider, +String _$exampleHash() => r'c4f5a651a55bcf34b0c92d98d77436844cbdc097'; + +final class ExampleFamily extends Family { + const ExampleFamily._() + : super( name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$exampleHash, dependencies: null, allTransitiveDependencies: null, - param: param, + isAutoDispose: true, ); - ExampleProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.param, - }) : super.internal(); - - final int param; - - @override - Override overrideWith( - String Function(ExampleRef ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: ExampleProvider._internal( - (ref) => create(ref as ExampleRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - param: param, - ), - ); - } + ExampleProvider call( + int param, + ) => + ExampleProvider._(argument: param, from: this); @override - (int,) get argument { - return (param,); - } + String debugGetCreateSourceHash() => _$exampleHash(); @override - _ExampleProviderElement createElement( - ProviderContainer container, - ) { - return _ExampleProviderElement(this, container); - } + String toString() => r'exampleProvider'; - ExampleProvider _copyWith( - String Function(ExampleRef ref) create, + /// {@macro riverpod.override_with} + Override overrideWith( + String Function( + ExampleRef ref, + int args, + ) create, ) { - return ExampleProvider._internal( - (ref) => create(ref as ExampleRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - param: param, - ); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleProvider; - @override - bool operator ==(Object other) { - return other is ExampleProvider && other.param == param; - } - - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, param.hashCode); + final argument = provider.argument as int; - return _SystemHash.finish(hash); + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'exampleProvider$argument'; -} - -mixin ExampleRef on AutoDisposeProviderRef { - /// The parameter `param` of this provider. - int get param; } -class _ExampleProviderElement extends AutoDisposeProviderElement - with ExampleRef { - _ExampleProviderElement(super.provider, super.container); - - @override - int get param => (origin as ExampleProvider).param; -} +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index 99e03c23d..e0128c307 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -8,239 +8,200 @@ part of 'family_class.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'c81e9d94e763b25403ab6b7fa03f092003570142'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -abstract class _$Example extends BuildlessAutoDisposeNotifier { - late final int param1; - late final String param2; - - String build( - int param1, { - String param2 = 'foo', - }); -} - -/// See also [Example]. @ProviderFor(Example) -const exampleProvider = ExampleFamily(); - -/// See also [Example]. -class ExampleFamily extends Family { - /// See also [Example]. - const ExampleFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; +const exampleProvider = ExampleFamily._(); + +final class ExampleProvider extends $NotifierProvider { + const ExampleProvider._( + {required ExampleFamily super.from, + required ( + int, { + String param2, + }) + super.argument, + super.runNotifierBuildOverride, + Example Function()? create}) + : _createCb = create, + super( + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get dependencies => _dependencies; + final Example Function()? _createCb; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$exampleHash(); @override - String? get name => r'exampleProvider'; - - /// See also [Example]. - ExampleProvider call( - int param1, { - String param2 = 'foo', - }) { - return ExampleProvider( - param1, - param2: param2, - ); + String toString() { + return r'exampleProvider' + '' + '$argument'; } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(Example Function() create) { - return _$ExampleFamilyOverride(this, create); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); } + @$internal @override - String toString() => 'exampleProvider'; -} + Example create() => _createCb?.call() ?? Example(); -class _$ExampleFamilyOverride implements $FamilyOverride { - _$ExampleFamilyOverride(this.from, this.create); + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._( + argument: argument as ( + int, { + String param2, + }), + from: from! as ExampleFamily, + create: create); + } - final Example Function() create; + @$internal + @override + ExampleProvider $copyWithBuild( + String Function( + Ref, + Example, + ) build, + ) { + return ExampleProvider._( + argument: argument as ( + int, { + String param2, + }), + from: from! as ExampleFamily, + runNotifierBuildOverride: build); + } + @$internal @override - final ExampleFamily from; + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); @override - _ExampleProviderElement createElement( - ProviderContainer container, - covariant ExampleProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is ExampleProvider && other.argument == argument; } @override - String toString() => 'exampleProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [Example]. -class ExampleProvider extends AutoDisposeNotifierProviderImpl { - /// See also [Example]. - ExampleProvider( - int param1, { - String param2 = 'foo', - }) : this._internal( - () => Example() - ..param1 = param1 - ..param2 = param2, - from: exampleProvider, +String _$exampleHash() => r'c81e9d94e763b25403ab6b7fa03f092003570142'; + +final class ExampleFamily extends Family { + const ExampleFamily._() + : super( name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$exampleHash, dependencies: null, allTransitiveDependencies: null, - param1: param1, - param2: param2, + isAutoDispose: true, ); - ExampleProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.param1, - required this.param2, - }) : super.internal(); - - final int param1; - final String param2; - - @override - String runNotifierBuild( - covariant Example notifier, - ) { - return notifier.build( - param1, - param2: param2, - ); - } - - @override - Override overrideWith(Example Function() create) { - return $ProviderOverride( - origin: this, - providerOverride: ExampleProvider._internal( - () => create() - ..param1 = param1 - ..param2 = param2, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - param1: param1, + ExampleProvider call( + int param1, { + String param2 = 'foo', + }) => + ExampleProvider._(argument: ( + param1, param2: param2, - ), - ); - } + ), from: this); @override - ( - int, { - String param2, - }) get argument { - return ( - param1, - param2: param2, - ); - } + String debugGetCreateSourceHash() => _$exampleHash(); @override - _ExampleProviderElement createElement( - ProviderContainer container, - ) { - return _ExampleProviderElement(this, container); - } + String toString() => r'exampleProvider'; - ExampleProvider _copyWith( - Example Function() create, + /// {@macro riverpod.override_with} + Override overrideWith( + Example Function( + ( + int, { + String param2, + }) args, + ) create, ) { - return ExampleProvider._internal( - () => create() - ..param1 = param1 - ..param2 = param2, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - param1: param1, - param2: param2, + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleProvider; + + final argument = provider.argument as ( + int, { + String param2, + }); + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, ); } - @override - bool operator ==(Object other) { - return other is ExampleProvider && - other.param1 == param1 && - other.param2 == param2; - } - - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, param1.hashCode); - hash = _SystemHash.combine(hash, param2.hashCode); - - return _SystemHash.finish(hash); + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + String Function( + Ref ref, + Example notifier, + ( + int, { + String param2, + }) argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleProvider; + + final argument = provider.argument as ( + int, { + String param2, + }); + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'exampleProvider$argument'; } -mixin ExampleRef on AutoDisposeNotifierProviderRef { - /// The parameter `param1` of this provider. - int get param1; - - /// The parameter `param2` of this provider. - String get param2; -} - -class _ExampleProviderElement - extends AutoDisposeNotifierProviderElement - with ExampleRef { - _ExampleProviderElement(super.provider, super.container); +abstract class _$Example extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as ( + int, { + String param2, + }); + int get param1 => _$args.$1; + String get param2 => _$args.param2; + String build( + int param1, { + String param2 = 'foo', + }); + @$internal @override - int get param1 => (origin as ExampleProvider).param1; - @override - String get param2 => (origin as ExampleProvider).param2; + String runBuild() => build( + _$args.$1, + param2: _$args.param2, + ); } + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index c18b13c8e..01c4e68ef 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -8,218 +8,164 @@ part of 'family_fn.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'99b3ed3d53932bd1354259200ebf08493af9ada2'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} +typedef ExampleRef = Ref; -/// See also [example]. @ProviderFor(example) -const exampleProvider = ExampleFamily(); - -/// See also [example]. -class ExampleFamily extends Family { - /// See also [example]. - const ExampleFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'exampleProvider'; - - /// See also [example]. - ExampleProvider call( - int param1, { - String param2 = 'foo', - }) { - return ExampleProvider( - param1, - param2: param2, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(String Function(ExampleRef ref) create) { - return _$ExampleFamilyOverride(this, create); - } - - @override - String toString() => 'exampleProvider'; -} - -class _$ExampleFamilyOverride implements $FamilyOverride { - _$ExampleFamilyOverride(this.from, this.create); - - final String Function(ExampleRef ref) create; - - @override - final ExampleFamily from; - - @override - _ExampleProviderElement createElement( - ProviderContainer container, - covariant ExampleProvider provider, - ) { - return provider._copyWith(create).createElement(container); - } - - @override - String toString() => 'exampleProvider.overrideWith(...)'; -} - -/// See also [example]. -class ExampleProvider extends AutoDisposeProvider { - /// See also [example]. - ExampleProvider( - int param1, { - String param2 = 'foo', - }) : this._internal( - (ref) => example( - ref as ExampleRef, - param1, - param2: param2, - ), - from: exampleProvider, +const exampleProvider = ExampleFamily._(); + +final class ExampleProvider + extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {required ExampleFamily super.from, + required ( + int, { + String param2, + }) + super.argument, + String Function( + ExampleRef ref, + int param1, { + String param2, + })? create}) + : _createCb = create, + super( name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$exampleHash, + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, - param1: param1, - param2: param2, ); - ExampleProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.param1, - required this.param2, - }) : super.internal(); + final String Function( + ExampleRef ref, + int param1, { + String param2, + })? _createCb; - final int param1; - final String param2; + @override + String debugGetCreateSourceHash() => _$exampleHash(); @override - Override overrideWith( - String Function(ExampleRef ref) create, - ) { + String toString() { + return r'exampleProvider' + '' + '$argument'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { return $ProviderOverride( origin: this, - providerOverride: ExampleProvider._internal( - (ref) => create(ref as ExampleRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - param1: param1, - param2: param2, - ), + providerOverride: $ValueProvider(value), ); } @override - ( - int, { - String param2, - }) get argument { - return ( - param1, - param2: param2, - ); - } + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); @override - _ExampleProviderElement createElement( - ProviderContainer container, + ExampleProvider $copyWithCreate( + String Function( + ExampleRef ref, + ) create, ) { - return _ExampleProviderElement(this, container); + return ExampleProvider._( + argument: argument as ( + int, { + String param2, + }), + from: from! as ExampleFamily, + create: ( + ref, + int param1, { + String param2 = 'foo', + }) => + create(ref)); } - ExampleProvider _copyWith( - String Function(ExampleRef ref) create, - ) { - return ExampleProvider._internal( - (ref) => create(ref as ExampleRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - param1: param1, - param2: param2, + @override + String create(ExampleRef ref) { + final fn = _createCb ?? example; + final ( + int, { + String param2, + }) argument = this.argument as ( + int, { + String param2, + }); + return fn( + ref, + argument.$1, + param2: argument.param2, ); } @override bool operator ==(Object other) { - return other is ExampleProvider && - other.param1 == param1 && - other.param2 == param2; + return other is ExampleProvider && other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, param1.hashCode); - hash = _SystemHash.combine(hash, param2.hashCode); - - return _SystemHash.finish(hash); + return argument.hashCode; } - - @override - String toString() => 'exampleProvider$argument'; } -mixin ExampleRef on AutoDisposeProviderRef { - /// The parameter `param1` of this provider. - int get param1; +String _$exampleHash() => r'99b3ed3d53932bd1354259200ebf08493af9ada2'; - /// The parameter `param2` of this provider. - String get param2; -} +final class ExampleFamily extends Family { + const ExampleFamily._() + : super( + name: r'exampleProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); -class _ExampleProviderElement extends AutoDisposeProviderElement - with ExampleRef { - _ExampleProviderElement(super.provider, super.container); + ExampleProvider call( + int param1, { + String param2 = 'foo', + }) => + ExampleProvider._(argument: ( + param1, + param2: param2, + ), from: this); @override - int get param1 => (origin as ExampleProvider).param1; + String debugGetCreateSourceHash() => _$exampleHash(); + @override - String get param2 => (origin as ExampleProvider).param2; + String toString() => r'exampleProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + String Function( + ExampleRef ref, + ( + int, { + String param2, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleProvider; + + final argument = provider.argument as ( + int, { + String param2, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart index d4c658779..578bb4b68 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart @@ -8,19 +8,74 @@ part of 'sync_class.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $NotifierProvider { + const ExampleProvider._( + {super.runNotifierBuildOverride, Example Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Example Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Example create() => _createCb?.call() ?? Example(); + + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._(create: create); + } + + @$internal + @override + ExampleProvider $copyWithBuild( + String Function( + Ref, + Example, + ) build, + ) { + return ExampleProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$exampleHash() => r'c237193ab6d57674973aaa02eb73db6f6822eb26'; -/// See also [Example]. -@ProviderFor(Example) -final exampleProvider = AutoDisposeNotifierProvider.internal( - Example.new, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Example = AutoDisposeNotifier; +abstract class _$Example extends $Notifier { + String build(); + @$internal + @override + String runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart index daabcdd71..f747be61b 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -8,19 +8,65 @@ part of 'sync_fn.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'dd4e9043c704a42a3fc025e7fef9515f659fc78a'; +typedef ExampleRef = Ref; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {String Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + String Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + String create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'dd4e9043c704a42a3fc025e7fef9515f659fc78a'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart index 710947519..5e2c3d28b 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -8,33 +8,114 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$configsHash() => r'166cbe95e6b49ed7bc78c96041fb14abddbf6911'; +typedef ConfigsRef = Ref>; -/// See also [configs]. @ProviderFor(configs) -final configsProvider = AutoDisposeStreamProvider.internal( - configs, - name: r'configsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$configsHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ConfigsRef = AutoDisposeStreamProviderRef; -String _$charactersHash() => r'b1e8e15bbeab60d92fe959d9e1dd4ceba6a31446'; +const configsProvider = ConfigsProvider._(); + +final class ConfigsProvider extends $FunctionalProvider< + AsyncValue, Stream, ConfigsRef> + with + $FutureModifier, + $StreamProvider { + const ConfigsProvider._( + {Stream Function( + ConfigsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'configsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ConfigsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$configsHash(); + + @override + $StreamProviderElement createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ConfigsProvider $copyWithCreate( + Stream Function( + ConfigsRef ref, + ) create, + ) { + return ConfigsProvider._(create: create); + } + + @override + Stream create(ConfigsRef ref) { + final fn = _createCb ?? configs; + return fn(ref); + } +} + +String _$configsHash() => r'166cbe95e6b49ed7bc78c96041fb14abddbf6911'; + +typedef CharactersRef = Ref>>; -/// See also [characters]. @ProviderFor(characters) -final charactersProvider = AutoDisposeFutureProvider>.internal( - characters, - name: r'charactersProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$charactersHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CharactersRef = AutoDisposeFutureProviderRef>; +const charactersProvider = CharactersProvider._(); + +final class CharactersProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, CharactersRef> + with + $FutureModifier>, + $FutureProvider, CharactersRef> { + const CharactersProvider._( + {FutureOr> Function( + CharactersRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'charactersProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + CharactersRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$charactersHash(); + + @override + $FutureProviderElement> createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + CharactersProvider $copyWithCreate( + FutureOr> Function( + CharactersRef ref, + ) create, + ) { + return CharactersProvider._(create: create); + } + + @override + FutureOr> create(CharactersRef ref) { + final fn = _createCb ?? characters; + return fn(ref); + } +} + +String _$charactersHash() => r'b1e8e15bbeab60d92fe959d9e1dd4ceba6a31446'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart index ac0b5a099..372c293ac 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -8,19 +8,64 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; +typedef CityRef = Ref; -/// See also [city]. @ProviderFor(city) -final cityProvider = AutoDisposeProvider.internal( - city, - name: r'cityProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$cityHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CityRef = AutoDisposeProviderRef; +const cityProvider = CityProvider._(); + +final class CityProvider extends $FunctionalProvider + with $Provider { + const CityProvider._( + {String Function( + CityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'cityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + CityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$cityHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CityProvider $copyWithCreate( + String Function( + CityRef ref, + ) create, + ) { + return CityProvider._(create: create); + } + + @override + String create(CityRef ref) { + final fn = _createCb ?? city; + return fn(ref); + } +} + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart index c26fbd6ba..f7c13276a 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -8,20 +8,65 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$filteredTodoListHash() => r'1c35eb0fce8fc7c7cda86413b02f606f8c8ae2b4'; +typedef FilteredTodoListRef = Ref>; -/// See also [filteredTodoList]. @ProviderFor(filteredTodoList) -final filteredTodoListProvider = AutoDisposeProvider>.internal( - filteredTodoList, - name: r'filteredTodoListProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$filteredTodoListHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef FilteredTodoListRef = AutoDisposeProviderRef>; +const filteredTodoListProvider = FilteredTodoListProvider._(); + +final class FilteredTodoListProvider + extends $FunctionalProvider, List, FilteredTodoListRef> + with $Provider, FilteredTodoListRef> { + const FilteredTodoListProvider._( + {List Function( + FilteredTodoListRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filteredTodoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + FilteredTodoListRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filteredTodoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @override + $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilteredTodoListProvider $copyWithCreate( + List Function( + FilteredTodoListRef ref, + ) create, + ) { + return FilteredTodoListProvider._(create: create); + } + + @override + List create(FilteredTodoListRef ref) { + final fn = _createCb ?? filteredTodoList; + return fn(ref); + } +} + +String _$filteredTodoListHash() => r'1c35eb0fce8fc7c7cda86413b02f606f8c8ae2b4'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart index 50ab2adaf..3c0fc5ac4 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -8,33 +8,123 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$anotherHash() => r'bb412edc55657c14eace37792cd18e5254604a36'; +typedef AnotherRef = Ref; -/// See also [another]. @ProviderFor(another) -final anotherProvider = AutoDisposeProvider.internal( - another, - name: r'anotherProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$anotherHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef AnotherRef = AutoDisposeProviderRef; -String _$myHash() => r'2712c772be4dbaabd4c99fd803f927a7e9938b21'; +const anotherProvider = AnotherProvider._(); + +final class AnotherProvider + extends $FunctionalProvider + with $Provider { + const AnotherProvider._( + {MyValue Function( + AnotherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'anotherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyValue Function( + AnotherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$anotherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + AnotherProvider $copyWithCreate( + MyValue Function( + AnotherRef ref, + ) create, + ) { + return AnotherProvider._(create: create); + } + + @override + MyValue create(AnotherRef ref) { + final fn = _createCb ?? another; + return fn(ref); + } +} + +String _$anotherHash() => r'bb412edc55657c14eace37792cd18e5254604a36'; + +typedef MyRef = Ref; -/// See also [my]. @ProviderFor(my) -final myProvider = AutoDisposeProvider.internal( - my, - name: r'myProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$myHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef MyRef = AutoDisposeProviderRef; +const myProvider = MyProvider._(); + +final class MyProvider extends $FunctionalProvider + with $Provider { + const MyProvider._( + {MyValue Function( + MyRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyValue Function( + MyRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$myHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + MyProvider $copyWithCreate( + MyValue Function( + MyRef ref, + ) create, + ) { + return MyProvider._(create: create); + } + + @override + MyValue create(MyRef ref) { + final fn = _createCb ?? my; + return fn(ref); + } +} + +String _$myHash() => r'2712c772be4dbaabd4c99fd803f927a7e9938b21'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart index cc039edb4..a6056dddf 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -8,33 +8,114 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$configHash() => r'3021d1a8aac384e99d5d22714ffe6e868954888b'; +typedef ConfigRef = Ref>; -/// See also [config]. @ProviderFor(config) -final configProvider = AutoDisposeStreamProvider.internal( - config, - name: r'configProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$configHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ConfigRef = AutoDisposeStreamProviderRef; -String _$productsHash() => r'd1f4523880408cf8ee0e68969c40cf87d5c78557'; +const configProvider = ConfigProvider._(); + +final class ConfigProvider extends $FunctionalProvider< + AsyncValue, Stream, ConfigRef> + with + $FutureModifier, + $StreamProvider { + const ConfigProvider._( + {Stream Function( + ConfigRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'configProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ConfigRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$configHash(); + + @override + $StreamProviderElement createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ConfigProvider $copyWithCreate( + Stream Function( + ConfigRef ref, + ) create, + ) { + return ConfigProvider._(create: create); + } + + @override + Stream create(ConfigRef ref) { + final fn = _createCb ?? config; + return fn(ref); + } +} + +String _$configHash() => r'3021d1a8aac384e99d5d22714ffe6e868954888b'; + +typedef ProductsRef = Ref>>; -/// See also [products]. @ProviderFor(products) -final productsProvider = AutoDisposeFutureProvider>.internal( - products, - name: r'productsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$productsHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ProductsRef = AutoDisposeFutureProviderRef>; +const productsProvider = ProductsProvider._(); + +final class ProductsProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, ProductsRef> + with + $FutureModifier>, + $FutureProvider, ProductsRef> { + const ProductsProvider._( + {FutureOr> Function( + ProductsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'productsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + ProductsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$productsHash(); + + @override + $FutureProviderElement> createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ProductsProvider $copyWithCreate( + FutureOr> Function( + ProductsRef ref, + ) create, + ) { + return ProductsProvider._(create: create); + } + + @override + FutureOr> create(ProductsRef ref) { + final fn = _createCb ?? products; + return fn(ref); + } +} + +String _$productsHash() => r'd1f4523880408cf8ee0e68969c40cf87d5c78557'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart index a2fc72563..0b73d3548 100644 --- a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart +++ b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$Todo { diff --git a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart index f7076044d..e76be1409 100644 --- a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart @@ -8,20 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(TodoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider extends $NotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + List Function( + Ref>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$todoListHash() => r'6c965beb867ffeee119133f0ae2e6ebeb68e6f7e'; -/// See also [TodoList]. -@ProviderFor(TodoList) -final todoListProvider = - AutoDisposeNotifierProvider>.internal( - TodoList.new, - name: r'todoListProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$TodoList = AutoDisposeNotifier>; +abstract class _$TodoList extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart index a259eb12b..2c4cea851 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -8,33 +8,115 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; +typedef CityRef = Ref; -/// See also [city]. @ProviderFor(city) -final cityProvider = AutoDisposeProvider.internal( - city, - name: r'cityProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$cityHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CityRef = AutoDisposeProviderRef; -String _$weatherHash() => r'9a79d0269032630918eef9d3f562ff35b5860061'; +const cityProvider = CityProvider._(); + +final class CityProvider extends $FunctionalProvider + with $Provider { + const CityProvider._( + {String Function( + CityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'cityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + CityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$cityHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CityProvider $copyWithCreate( + String Function( + CityRef ref, + ) create, + ) { + return CityProvider._(create: create); + } + + @override + String create(CityRef ref) { + final fn = _createCb ?? city; + return fn(ref); + } +} + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +typedef WeatherRef = Ref>; -/// See also [weather]. @ProviderFor(weather) -final weatherProvider = AutoDisposeFutureProvider.internal( - weather, - name: r'weatherProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$weatherHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef WeatherRef = AutoDisposeFutureProviderRef; +const weatherProvider = WeatherProvider._(); + +final class WeatherProvider extends $FunctionalProvider, + FutureOr, WeatherRef> + with $FutureModifier, $FutureProvider { + const WeatherProvider._( + {FutureOr Function( + WeatherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'weatherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + WeatherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$weatherHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + WeatherProvider $copyWithCreate( + FutureOr Function( + WeatherRef ref, + ) create, + ) { + return WeatherProvider._(create: create); + } + + @override + FutureOr create(WeatherRef ref) { + final fn = _createCb ?? weather; + return fn(ref); + } +} + +String _$weatherHash() => r'9a79d0269032630918eef9d3f562ff35b5860061'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart index 25c5a7ded..fb641140b 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -8,33 +8,114 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$configHash() => r'3021d1a8aac384e99d5d22714ffe6e868954888b'; +typedef ConfigRef = Ref>; -/// See also [config]. @ProviderFor(config) -final configProvider = AutoDisposeStreamProvider.internal( - config, - name: r'configProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$configHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ConfigRef = AutoDisposeStreamProviderRef; -String _$productsHash() => r'637254615fa398af0d36e212f09e5d3d8ff866aa'; +const configProvider = ConfigProvider._(); + +final class ConfigProvider extends $FunctionalProvider< + AsyncValue, Stream, ConfigRef> + with + $FutureModifier, + $StreamProvider { + const ConfigProvider._( + {Stream Function( + ConfigRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'configProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ConfigRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$configHash(); + + @override + $StreamProviderElement createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ConfigProvider $copyWithCreate( + Stream Function( + ConfigRef ref, + ) create, + ) { + return ConfigProvider._(create: create); + } + + @override + Stream create(ConfigRef ref) { + final fn = _createCb ?? config; + return fn(ref); + } +} + +String _$configHash() => r'3021d1a8aac384e99d5d22714ffe6e868954888b'; + +typedef ProductsRef = Ref>>; -/// See also [products]. @ProviderFor(products) -final productsProvider = AutoDisposeFutureProvider>.internal( - products, - name: r'productsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$productsHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ProductsRef = AutoDisposeFutureProviderRef>; +const productsProvider = ProductsProvider._(); + +final class ProductsProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, ProductsRef> + with + $FutureModifier>, + $FutureProvider, ProductsRef> { + const ProductsProvider._( + {FutureOr> Function( + ProductsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'productsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + ProductsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$productsHash(); + + @override + $FutureProviderElement> createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ProductsProvider $copyWithCreate( + FutureOr> Function( + ProductsRef ref, + ) create, + ) { + return ProductsProvider._(create: create); + } + + @override + FutureOr> create(ProductsRef ref) { + final fn = _createCb ?? products; + return fn(ref); + } +} + +String _$productsHash() => r'637254615fa398af0d36e212f09e5d3d8ff866aa'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart index 29ee85fa1..acc03feaa 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart @@ -8,19 +8,57 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'e2c4eb8a7cf06c7a0e5d07ee2bd51db254033fa6'; +typedef ExampleRef = Ref>; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeStreamProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeStreamProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider, Stream, ExampleRef> + with $FutureModifier, $StreamProvider { + const ExampleProvider._( + {Stream Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + Stream Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + Stream create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'e2c4eb8a7cf06c7a0e5d07ee2bd51db254033fa6'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart index 71bf0484e..6bd530b72 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart @@ -8,19 +8,64 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$myHash() => r'0810ee24cae78c131d00773ac20d254c83eefab7'; +typedef MyRef = Ref; -/// See also [my]. @ProviderFor(my) -final myProvider = AutoDisposeProvider.internal( - my, - name: r'myProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$myHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef MyRef = AutoDisposeProviderRef; +const myProvider = MyProvider._(); + +final class MyProvider extends $FunctionalProvider + with $Provider { + const MyProvider._( + {MyValue Function( + MyRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyValue Function( + MyRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$myHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + MyProvider $copyWithCreate( + MyValue Function( + MyRef ref, + ) create, + ) { + return MyProvider._(create: create); + } + + @override + MyValue create(MyRef ref) { + final fn = _createCb ?? my; + return fn(ref); + } +} + +String _$myHash() => r'0810ee24cae78c131d00773ac20d254c83eefab7'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart index 84913df77..69234a30c 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart @@ -8,33 +8,123 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; +typedef CityRef = Ref; -/// See also [city]. @ProviderFor(city) -final cityProvider = AutoDisposeProvider.internal( - city, - name: r'cityProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$cityHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CityRef = AutoDisposeProviderRef; -String _$countryHash() => r'd1513349c3bc0c99763cb4fb29eb012f2351bc4c'; +const cityProvider = CityProvider._(); + +final class CityProvider extends $FunctionalProvider + with $Provider { + const CityProvider._( + {String Function( + CityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'cityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + CityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$cityHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CityProvider $copyWithCreate( + String Function( + CityRef ref, + ) create, + ) { + return CityProvider._(create: create); + } + + @override + String create(CityRef ref) { + final fn = _createCb ?? city; + return fn(ref); + } +} + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +typedef CountryRef = Ref; -/// See also [country]. @ProviderFor(country) -final countryProvider = AutoDisposeProvider.internal( - country, - name: r'countryProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$countryHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CountryRef = AutoDisposeProviderRef; +const countryProvider = CountryProvider._(); + +final class CountryProvider + extends $FunctionalProvider + with $Provider { + const CountryProvider._( + {String Function( + CountryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'countryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + CountryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$countryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CountryProvider $copyWithCreate( + String Function( + CountryRef ref, + ) create, + ) { + return CountryProvider._(create: create); + } + + @override + String create(CountryRef ref) { + final fn = _createCb ?? country; + return fn(ref); + } +} + +String _$countryHash() => r'd1513349c3bc0c99763cb4fb29eb012f2351bc4c'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/counter/codegen.g.dart b/website/docs/concepts/reading/counter/codegen.g.dart index d892e8ba8..4b69a56e1 100644 --- a/website/docs/concepts/reading/counter/codegen.g.dart +++ b/website/docs/concepts/reading/counter/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterHash() => r'6bd7806869af024b3288645da03c077af9478083'; -/// See also [Counter]. -@ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/listen/codegen.g.dart b/website/docs/concepts/reading/listen/codegen.g.dart index 60b68adf7..dfc6e7497 100644 --- a/website/docs/concepts/reading/listen/codegen.g.dart +++ b/website/docs/concepts/reading/listen/codegen.g.dart @@ -8,19 +8,64 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$anotherHash() => r'2208f9221f3d898305609874d4f43c28bdfff2b4'; +typedef AnotherRef = Ref; -/// See also [another]. @ProviderFor(another) -final anotherProvider = AutoDisposeProvider.internal( - another, - name: r'anotherProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$anotherHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef AnotherRef = AutoDisposeProviderRef; +const anotherProvider = AnotherProvider._(); + +final class AnotherProvider extends $FunctionalProvider + with $Provider { + const AnotherProvider._( + {void Function( + AnotherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'anotherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final void Function( + AnotherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$anotherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(void value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + AnotherProvider $copyWithCreate( + void Function( + AnotherRef ref, + ) create, + ) { + return AnotherProvider._(create: create); + } + + @override + void create(AnotherRef ref) { + final fn = _createCb ?? another; + return fn(ref); + } +} + +String _$anotherHash() => r'2208f9221f3d898305609874d4f43c28bdfff2b4'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/listen_build/codegen.g.dart b/website/docs/concepts/reading/listen_build/codegen.g.dart index 1e834cdbe..f59d40e8f 100644 --- a/website/docs/concepts/reading/listen_build/codegen.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterHash() => r'4320f811608c7a6e7342b83e3031965a34f7cb8e'; -/// See also [Counter]. -@ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart index 9affdaea0..c3c44541a 100644 --- a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart @@ -8,19 +8,74 @@ part of 'codegen_hooks.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterHash() => r'4320f811608c7a6e7342b83e3031965a34f7cb8e'; -/// See also [Counter]. -@ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/provider/codegen.g.dart b/website/docs/concepts/reading/provider/codegen.g.dart index 0e7d74954..fee467e75 100644 --- a/website/docs/concepts/reading/provider/codegen.g.dart +++ b/website/docs/concepts/reading/provider/codegen.g.dart @@ -8,33 +8,123 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$repositoryHash() => r'c6dc3b5b727028966b5b850b27ffc7294b485273'; +typedef RepositoryRef = Ref; -/// See also [repository]. @ProviderFor(repository) -final repositoryProvider = AutoDisposeProvider.internal( - repository, - name: r'repositoryProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$repositoryHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef RepositoryRef = AutoDisposeProviderRef; -String _$valueHash() => r'8c26f7aaa911af815cff9e513a18e4d8dcc6d1df'; +const repositoryProvider = RepositoryProvider._(); + +final class RepositoryProvider + extends $FunctionalProvider + with $Provider { + const RepositoryProvider._( + {Repository Function( + RepositoryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'repositoryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Repository Function( + RepositoryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$repositoryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Repository value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RepositoryProvider $copyWithCreate( + Repository Function( + RepositoryRef ref, + ) create, + ) { + return RepositoryProvider._(create: create); + } + + @override + Repository create(RepositoryRef ref) { + final fn = _createCb ?? repository; + return fn(ref); + } +} + +String _$repositoryHash() => r'c6dc3b5b727028966b5b850b27ffc7294b485273'; + +typedef ValueRef = Ref; -/// See also [value]. @ProviderFor(value) -final valueProvider = AutoDisposeProvider.internal( - value, - name: r'valueProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$valueHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ValueRef = AutoDisposeProviderRef; +const valueProvider = ValueProvider._(); + +final class ValueProvider extends $FunctionalProvider + with $Provider { + const ValueProvider._( + {String Function( + ValueRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'valueProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + ValueRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$valueHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ValueProvider $copyWithCreate( + String Function( + ValueRef ref, + ) create, + ) { + return ValueProvider._(create: create); + } + + @override + String create(ValueRef ref) { + final fn = _createCb ?? value; + return fn(ref); + } +} + +String _$valueHash() => r'8c26f7aaa911af815cff9e513a18e4d8dcc6d1df'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/read/codegen.g.dart b/website/docs/concepts/reading/read/codegen.g.dart index 041865b99..090ded96f 100644 --- a/website/docs/concepts/reading/read/codegen.g.dart +++ b/website/docs/concepts/reading/read/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; -/// See also [Counter]. -@ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/read/codegen_hooks.g.dart b/website/docs/concepts/reading/read/codegen_hooks.g.dart index 5fd373b49..0449b9928 100644 --- a/website/docs/concepts/reading/read/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/read/codegen_hooks.g.dart @@ -8,19 +8,74 @@ part of 'codegen_hooks.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; -/// See also [Counter]. -@ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/read_build/codegen.g.dart b/website/docs/concepts/reading/read_build/codegen.g.dart index 041865b99..090ded96f 100644 --- a/website/docs/concepts/reading/read_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_build/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; -/// See also [Counter]. -@ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart index 041865b99..090ded96f 100644 --- a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; -/// See also [Counter]. -@ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/watch/codegen.g.dart b/website/docs/concepts/reading/watch/codegen.g.dart index 8221391a4..5b7deccb5 100644 --- a/website/docs/concepts/reading/watch/codegen.g.dart +++ b/website/docs/concepts/reading/watch/codegen.g.dart @@ -8,48 +8,192 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$filterTypeHash() => r'42b68b163daecff7a0b9b069b16025a89910b4fb'; +typedef FilterTypeRef = Ref; -/// See also [filterType]. @ProviderFor(filterType) -final filterTypeProvider = AutoDisposeProvider.internal( - filterType, - name: r'filterTypeProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$filterTypeHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef FilterTypeRef = AutoDisposeProviderRef; -String _$filteredTodoListHash() => r'34f1e929a9e7850946ea8634d9f3e8f38ae5687d'; +const filterTypeProvider = FilterTypeProvider._(); + +final class FilterTypeProvider + extends $FunctionalProvider + with $Provider { + const FilterTypeProvider._( + {FilterType Function( + FilterTypeRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filterTypeProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FilterType Function( + FilterTypeRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filterTypeHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(FilterType value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilterTypeProvider $copyWithCreate( + FilterType Function( + FilterTypeRef ref, + ) create, + ) { + return FilterTypeProvider._(create: create); + } + + @override + FilterType create(FilterTypeRef ref) { + final fn = _createCb ?? filterType; + return fn(ref); + } +} + +String _$filterTypeHash() => r'42b68b163daecff7a0b9b069b16025a89910b4fb'; + +typedef FilteredTodoListRef = Ref>; -/// See also [filteredTodoList]. @ProviderFor(filteredTodoList) -final filteredTodoListProvider = AutoDisposeProvider>.internal( - filteredTodoList, - name: r'filteredTodoListProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$filteredTodoListHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef FilteredTodoListRef = AutoDisposeProviderRef>; -String _$todosHash() => r'b66ac2b1e5cf7ac7957d25864cfdffad1af233a6'; +const filteredTodoListProvider = FilteredTodoListProvider._(); + +final class FilteredTodoListProvider + extends $FunctionalProvider, List, FilteredTodoListRef> + with $Provider, FilteredTodoListRef> { + const FilteredTodoListProvider._( + {List Function( + FilteredTodoListRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filteredTodoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + FilteredTodoListRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filteredTodoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @override + $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilteredTodoListProvider $copyWithCreate( + List Function( + FilteredTodoListRef ref, + ) create, + ) { + return FilteredTodoListProvider._(create: create); + } + + @override + List create(FilteredTodoListRef ref) { + final fn = _createCb ?? filteredTodoList; + return fn(ref); + } +} + +String _$filteredTodoListHash() => r'34f1e929a9e7850946ea8634d9f3e8f38ae5687d'; -/// See also [Todos]. @ProviderFor(Todos) -final todosProvider = AutoDisposeNotifierProvider>.internal( - Todos.new, - name: r'todosProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$todosHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Todos = AutoDisposeNotifier>; +const todosProvider = TodosProvider._(); + +final class TodosProvider extends $NotifierProvider> { + const TodosProvider._( + {super.runNotifierBuildOverride, Todos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Todos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + Todos create() => _createCb?.call() ?? Todos(); + + @$internal + @override + TodosProvider $copyWithCreate( + Todos Function() create, + ) { + return TodosProvider._(create: create); + } + + @$internal + @override + TodosProvider $copyWithBuild( + List Function( + Ref>, + Todos, + ) build, + ) { + return TodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todosHash() => r'b66ac2b1e5cf7ac7957d25864cfdffad1af233a6'; + +abstract class _$Todos extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/watch_build/codegen.g.dart b/website/docs/concepts/reading/watch_build/codegen.g.dart index 347684842..dcc5cec2c 100644 --- a/website/docs/concepts/reading/watch_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen.g.dart @@ -8,34 +8,132 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; +typedef CounterRef = Ref; -/// See also [counter]. @ProviderFor(counter) -final counterProvider = AutoDisposeProvider.internal( - counter, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CounterRef = AutoDisposeProviderRef; -String _$todoListHash() => r'77f007cd4f5105330a4c2ab8555ea0d1716945c1'; +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $FunctionalProvider + with $Provider { + const CounterProvider._( + {int Function( + CounterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CounterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CounterProvider $copyWithCreate( + int Function( + CounterRef ref, + ) create, + ) { + return CounterProvider._(create: create); + } + + @override + int create(CounterRef ref) { + final fn = _createCb ?? counter; + return fn(ref); + } +} + +String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; -/// See also [TodoList]. @ProviderFor(TodoList) -final todoListProvider = - AutoDisposeNotifierProvider>.internal( - TodoList.new, - name: r'todoListProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$TodoList = AutoDisposeNotifier>; +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider extends $NotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + List Function( + Ref>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todoListHash() => r'77f007cd4f5105330a4c2ab8555ea0d1716945c1'; + +abstract class _$TodoList extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart index f5b4cfea1..b1aa4b007 100644 --- a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart @@ -8,34 +8,132 @@ part of 'codegen_hooks.dart'; // RiverpodGenerator // ************************************************************************** -String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; +typedef CounterRef = Ref; -/// See also [counter]. @ProviderFor(counter) -final counterProvider = AutoDisposeProvider.internal( - counter, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CounterRef = AutoDisposeProviderRef; -String _$todoListHash() => r'77f007cd4f5105330a4c2ab8555ea0d1716945c1'; +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $FunctionalProvider + with $Provider { + const CounterProvider._( + {int Function( + CounterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CounterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CounterProvider $copyWithCreate( + int Function( + CounterRef ref, + ) create, + ) { + return CounterProvider._(create: create); + } + + @override + int create(CounterRef ref) { + final fn = _createCb ?? counter; + return fn(ref); + } +} + +String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; -/// See also [TodoList]. @ProviderFor(TodoList) -final todoListProvider = - AutoDisposeNotifierProvider>.internal( - TodoList.new, - name: r'todoListProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$TodoList = AutoDisposeNotifier>; +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider extends $NotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + List Function( + Ref>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todoListHash() => r'77f007cd4f5105330a4c2ab8555ea0d1716945c1'; + +abstract class _$TodoList extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart index 041865b99..090ded96f 100644 --- a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; -/// See also [Counter]. -@ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/concepts/why_immutability/codegen.freezed.dart b/website/docs/concepts/why_immutability/codegen.freezed.dart index 78422f4d9..6e8c8082b 100644 --- a/website/docs/concepts/why_immutability/codegen.freezed.dart +++ b/website/docs/concepts/why_immutability/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$ThemeSettings { diff --git a/website/docs/concepts/why_immutability/codegen.g.dart b/website/docs/concepts/why_immutability/codegen.g.dart index 44ea6ef85..03fc4c4ad 100644 --- a/website/docs/concepts/why_immutability/codegen.g.dart +++ b/website/docs/concepts/why_immutability/codegen.g.dart @@ -8,21 +8,75 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(ThemeNotifier) +const themeNotifierProvider = ThemeNotifierProvider._(); + +final class ThemeNotifierProvider + extends $NotifierProvider { + const ThemeNotifierProvider._( + {super.runNotifierBuildOverride, ThemeNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'themeNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ThemeNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$themeNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(ThemeSettings value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + ThemeNotifier create() => _createCb?.call() ?? ThemeNotifier(); + + @$internal + @override + ThemeNotifierProvider $copyWithCreate( + ThemeNotifier Function() create, + ) { + return ThemeNotifierProvider._(create: create); + } + + @$internal + @override + ThemeNotifierProvider $copyWithBuild( + ThemeSettings Function( + Ref, + ThemeNotifier, + ) build, + ) { + return ThemeNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$themeNotifierHash() => r'e119d56d9bf8b8d7c19624997f99d116098b45e9'; -/// See also [ThemeNotifier]. -@ProviderFor(ThemeNotifier) -final themeNotifierProvider = - AutoDisposeNotifierProvider.internal( - ThemeNotifier.new, - name: r'themeNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$themeNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$ThemeNotifier = AutoDisposeNotifier; +abstract class _$ThemeNotifier extends $Notifier { + ThemeSettings build(); + @$internal + @override + ThemeSettings runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart index 98fd6ea63..f909dfe06 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -8,19 +8,57 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'3ff29b1cd8fa864286a2a04e39adf1c8589b4275'; +typedef ExampleRef = Ref>; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeFutureProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeFutureProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'3ff29b1cd8fa864286a2a04e39adf1c8589b4275'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart index 854d2df27..e9e227986 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -8,19 +8,64 @@ part of 'codegen_keep_alive.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'78f9426f6cbda80564387a9db8cd02368d890a85'; +typedef ExampleRef = Ref; -/// See also [example]. @ProviderFor(example) -final exampleProvider = Provider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = ProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + int create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'78f9426f6cbda80564387a9db8cd02368d890a85'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index 890c5b5b2..f0e348941 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -8,195 +8,136 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$labelHash() => r'20aa8ce0231205540f466f91259732bd86953c64'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); +typedef LabelRef = Ref; - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [label]. @ProviderFor(label) -const labelProvider = LabelFamily(); - -/// See also [label]. -class LabelFamily extends Family { - /// See also [label]. - const LabelFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; +const labelProvider = LabelFamily._(); + +final class LabelProvider extends $FunctionalProvider + with $Provider { + const LabelProvider._( + {required LabelFamily super.from, + required String super.argument, + String Function( + LabelRef ref, + String userName, + )? create}) + : _createCb = create, + super( + name: r'labelProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get dependencies => _dependencies; + final String Function( + LabelRef ref, + String userName, + )? _createCb; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$labelHash(); @override - String? get name => r'labelProvider'; - - /// See also [label]. - LabelProvider call( - String userName, - ) { - return LabelProvider( - userName, - ); + String toString() { + return r'labelProvider' + '' + '($argument)'; } - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(String Function(LabelRef ref) create) { - return _$LabelFamilyOverride(this, create); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); } @override - String toString() => 'labelProvider'; -} + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); -class _$LabelFamilyOverride implements $FamilyOverride { - _$LabelFamilyOverride(this.from, this.create); - - final String Function(LabelRef ref) create; + @override + LabelProvider $copyWithCreate( + String Function( + LabelRef ref, + ) create, + ) { + return LabelProvider._( + argument: argument as String, + from: from! as LabelFamily, + create: ( + ref, + String userName, + ) => + create(ref)); + } @override - final LabelFamily from; + String create(LabelRef ref) { + final fn = _createCb ?? label; + final String argument = this.argument as String; + return fn( + ref, + argument, + ); + } @override - _LabelProviderElement createElement( - ProviderContainer container, - covariant LabelProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is LabelProvider && other.argument == argument; } @override - String toString() => 'labelProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [label]. -class LabelProvider extends AutoDisposeProvider { - /// See also [label]. - LabelProvider( - String userName, - ) : this._internal( - (ref) => label( - ref as LabelRef, - userName, - ), - from: labelProvider, +String _$labelHash() => r'20aa8ce0231205540f466f91259732bd86953c64'; + +final class LabelFamily extends Family { + const LabelFamily._() + : super( name: r'labelProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$labelHash, dependencies: null, allTransitiveDependencies: null, - userName: userName, + isAutoDispose: true, ); - LabelProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.userName, - }) : super.internal(); - - final String userName; - - @override - Override overrideWith( - String Function(LabelRef ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: LabelProvider._internal( - (ref) => create(ref as LabelRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - userName: userName, - ), - ); - } + LabelProvider call( + String userName, + ) => + LabelProvider._(argument: userName, from: this); @override - (String,) get argument { - return (userName,); - } + String debugGetCreateSourceHash() => _$labelHash(); @override - _LabelProviderElement createElement( - ProviderContainer container, - ) { - return _LabelProviderElement(this, container); - } + String toString() => r'labelProvider'; - LabelProvider _copyWith( - String Function(LabelRef ref) create, + /// {@macro riverpod.override_with} + Override overrideWith( + String Function( + LabelRef ref, + String args, + ) create, ) { - return LabelProvider._internal( - (ref) => create(ref as LabelRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - userName: userName, - ); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as LabelProvider; - @override - bool operator ==(Object other) { - return other is LabelProvider && other.userName == userName; - } - - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, userName.hashCode); + final argument = provider.argument as String; - return _SystemHash.finish(hash); + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'labelProvider$argument'; -} - -mixin LabelRef on AutoDisposeProviderRef { - /// The parameter `userName` of this provider. - String get userName; } -class _LabelProviderElement extends AutoDisposeProviderElement - with LabelRef { - _LabelProviderElement(super.provider, super.container); - - @override - String get userName => (origin as LabelProvider).userName; -} +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart index bf38010f2..e487e303f 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -8,19 +8,57 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'4fa856c55e84da9525dcecfab1c897e61456325b'; +typedef ExampleRef = Ref>; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeFutureProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeFutureProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'4fa856c55e84da9525dcecfab1c897e61456325b'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart index 448c6784e..fa2c901fb 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -8,33 +8,115 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; +typedef OtherRef = Ref; -/// See also [other]. @ProviderFor(other) -final otherProvider = AutoDisposeProvider.internal( - other, - name: r'otherProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$otherHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef OtherRef = AutoDisposeProviderRef; -String _$exampleHash() => r'29f92958e0d0e3f13ac033e92cd2e4072339c7db'; +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final fn = _createCb ?? other; + return fn(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +typedef ExampleRef = Ref>; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeStreamProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeStreamProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider, Stream, ExampleRef> + with $FutureModifier, $StreamProvider { + const ExampleProvider._( + {Stream Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + Stream Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + Stream create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'29f92958e0d0e3f13ac033e92cd2e4072339c7db'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart index 8df442e58..db867e1e7 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart @@ -8,33 +8,122 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; +typedef OtherRef = Ref; -/// See also [other]. @ProviderFor(other) -final otherProvider = AutoDisposeProvider.internal( - other, - name: r'otherProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$otherHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef OtherRef = AutoDisposeProviderRef; -String _$exampleHash() => r'4429d7d3bb2b31fea4cc42c2f2af02d3f3d10693'; +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final fn = _createCb ?? other; + return fn(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +typedef ExampleRef = Ref; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + int create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'4429d7d3bb2b31fea4cc42c2f2af02d3f3d10693'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart index eb3006429..32435c94f 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart @@ -8,19 +8,64 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'd614303f372e06e6ab96035affc4c07a53b28741'; +typedef ExampleRef = Ref; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + int create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'd614303f372e06e6ab96035affc4c07a53b28741'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart index 8109b649d..25735301f 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -8,33 +8,132 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; +typedef OtherRef = Ref; -/// See also [other]. @ProviderFor(other) -final otherProvider = AutoDisposeProvider.internal( - other, - name: r'otherProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$otherHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef OtherRef = AutoDisposeProviderRef; -String _$exampleHash() => r'893db991b377b8e314e60c429043e5e81f1fd526'; +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final fn = _createCb ?? other; + return fn(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; -/// See also [Example]. @ProviderFor(Example) -final exampleProvider = AutoDisposeNotifierProvider.internal( - Example.new, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Example = AutoDisposeNotifier; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $NotifierProvider { + const ExampleProvider._( + {super.runNotifierBuildOverride, Example Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Example Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Example create() => _createCb?.call() ?? Example(); + + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._(create: create); + } + + @$internal + @override + ExampleProvider $copyWithBuild( + int Function( + Ref, + Example, + ) build, + ) { + return ExampleProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$exampleHash() => r'893db991b377b8e314e60c429043e5e81f1fd526'; + +abstract class _$Example extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/read_example/codegen.g.dart b/website/docs/essentials/combining_requests/read_example/codegen.g.dart index 4bac3c78b..842246fd0 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.g.dart @@ -8,20 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$myNotifierHash() => r'353efe22dd5a91b2d036286211ac9e60c9de5f6d'; -/// See also [MyNotifier]. -@ProviderFor(MyNotifier) -final myNotifierProvider = - AutoDisposeNotifierProvider.internal( - MyNotifier.new, - name: r'myNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$MyNotifier = AutoDisposeNotifier; +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart index 2bf4a34f4..7dc32950b 100644 --- a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart @@ -8,37 +8,116 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$locationHash() => r'22e666f1e1ce04ce03d8f8d5652e25b54c1d1af3'; +typedef LocationRef = Ref>; -/// See also [location]. @ProviderFor(location) -final locationProvider = - AutoDisposeStreamProvider<({double longitude, double latitude})>.internal( - location, - name: r'locationProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$locationHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef LocationRef - = AutoDisposeStreamProviderRef<({double longitude, double latitude})>; -String _$restaurantsNearMeHash() => r'dd49cc1e6f16abb34dd15286d171e322c06b93b8'; +const locationProvider = LocationProvider._(); + +final class LocationProvider extends $FunctionalProvider< + AsyncValue<({double longitude, double latitude})>, + Stream<({double longitude, double latitude})>, + LocationRef> + with + $FutureModifier<({double longitude, double latitude})>, + $StreamProvider<({double longitude, double latitude}), LocationRef> { + const LocationProvider._( + {Stream<({double longitude, double latitude})> Function( + LocationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'locationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream<({double longitude, double latitude})> Function( + LocationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$locationHash(); + + @override + $StreamProviderElement<({double longitude, double latitude})> createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + LocationProvider $copyWithCreate( + Stream<({double longitude, double latitude})> Function( + LocationRef ref, + ) create, + ) { + return LocationProvider._(create: create); + } + + @override + Stream<({double longitude, double latitude})> create(LocationRef ref) { + final fn = _createCb ?? location; + return fn(ref); + } +} + +String _$locationHash() => r'22e666f1e1ce04ce03d8f8d5652e25b54c1d1af3'; + +typedef RestaurantsNearMeRef = Ref>>; -/// See also [restaurantsNearMe]. @ProviderFor(restaurantsNearMe) -final restaurantsNearMeProvider = - AutoDisposeFutureProvider>.internal( - restaurantsNearMe, - name: r'restaurantsNearMeProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$restaurantsNearMeHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef RestaurantsNearMeRef = AutoDisposeFutureProviderRef>; +const restaurantsNearMeProvider = RestaurantsNearMeProvider._(); + +final class RestaurantsNearMeProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, RestaurantsNearMeRef> + with + $FutureModifier>, + $FutureProvider, RestaurantsNearMeRef> { + const RestaurantsNearMeProvider._( + {FutureOr> Function( + RestaurantsNearMeRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'restaurantsNearMeProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + RestaurantsNearMeRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$restaurantsNearMeHash(); + + @override + $FutureProviderElement> createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + RestaurantsNearMeProvider $copyWithCreate( + FutureOr> Function( + RestaurantsNearMeRef ref, + ) create, + ) { + return RestaurantsNearMeProvider._(create: create); + } + + @override + FutureOr> create(RestaurantsNearMeRef ref) { + final fn = _createCb ?? restaurantsNearMe; + return fn(ref); + } +} + +String _$restaurantsNearMeHash() => r'dd49cc1e6f16abb34dd15286d171e322c06b93b8'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart index c845e281b..9e01a0926 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart @@ -8,34 +8,132 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'd4d63f5cf1aaec5b7c6a19e6fee18ddf070147ec'; +typedef ExampleRef = Ref; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeProviderRef; -String _$myNotifierHash() => r'ad79fdb5b0e72a800fa03efc1e7157f0d1524844'; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + int create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'd4d63f5cf1aaec5b7c6a19e6fee18ddf070147ec'; -/// See also [MyNotifier]. @ProviderFor(MyNotifier) -final myNotifierProvider = - AutoDisposeNotifierProvider.internal( - MyNotifier.new, - name: r'myNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$MyNotifier = AutoDisposeNotifier; +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'ad79fdb5b0e72a800fa03efc1e7157f0d1524844'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart index dd85f62f9..e63365ff5 100644 --- a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart +++ b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart @@ -8,19 +8,57 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; +typedef ExampleRef = Ref>; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeFutureProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeFutureProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/first_request/codegen/activity.freezed.dart b/website/docs/essentials/first_request/codegen/activity.freezed.dart index 3f862d5e5..6ffa343c1 100644 --- a/website/docs/essentials/first_request/codegen/activity.freezed.dart +++ b/website/docs/essentials/first_request/codegen/activity.freezed.dart @@ -12,7 +12,7 @@ part of 'activity.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Activity _$ActivityFromJson(Map json) { return _Activity.fromJson(json); diff --git a/website/docs/essentials/first_request/codegen/provider.g.dart b/website/docs/essentials/first_request/codegen/provider.g.dart index f410c01d1..65e729a20 100644 --- a/website/docs/essentials/first_request/codegen/provider.g.dart +++ b/website/docs/essentials/first_request/codegen/provider.g.dart @@ -8,22 +8,65 @@ part of 'provider.dart'; // RiverpodGenerator // ************************************************************************** -String _$activityHash() => r'636cd5510e09cbfc46f31b74a70d9e98c89e95a4'; +/// This will create a provider named `activityProvider` +/// which will cache the result of this function. +typedef ActivityRef = Ref>; /// This will create a provider named `activityProvider` /// which will cache the result of this function. -/// -/// Copied from [activity]. @ProviderFor(activity) -final activityProvider = AutoDisposeFutureProvider.internal( - activity, - name: r'activityProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ActivityRef = AutoDisposeFutureProviderRef; +const activityProvider = ActivityProvider._(); + +/// This will create a provider named `activityProvider` +/// which will cache the result of this function. +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + /// This will create a provider named `activityProvider` + /// which will cache the result of this function. + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final fn = _createCb ?? activity; + return fn(ref); + } +} + +String _$activityHash() => r'636cd5510e09cbfc46f31b74a70d9e98c89e95a4'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/passing_args/codegen/family.g.dart b/website/docs/essentials/passing_args/codegen/family.g.dart index c2b6b5506..4753ec99c 100644 --- a/website/docs/essentials/passing_args/codegen/family.g.dart +++ b/website/docs/essentials/passing_args/codegen/family.g.dart @@ -8,195 +8,129 @@ part of 'family.dart'; // RiverpodGenerator // ************************************************************************** -String _$activityHash() => r'cb76e67cd45f1823d3ed497a235be53819ce2eaf'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } +typedef ActivityRef = Ref>; - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [activity]. @ProviderFor(activity) -const activityProvider = ActivityFamily(); - -/// See also [activity]. -class ActivityFamily extends Family { - /// See also [activity]. - const ActivityFamily(); - - static const Iterable? _dependencies = null; +const activityProvider = ActivityFamily._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {required ActivityFamily super.from, + required String super.argument, + FutureOr Function( + ActivityRef ref, + String activityType, + )? create}) + : _createCb = create, + super( + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - static const Iterable? _allTransitiveDependencies = null; + final FutureOr Function( + ActivityRef ref, + String activityType, + )? _createCb; @override - Iterable? get dependencies => _dependencies; + String debugGetCreateSourceHash() => _$activityHash(); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String toString() { + return r'activityProvider' + '' + '($argument)'; + } @override - String? get name => r'activityProvider'; + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); - /// See also [activity]. - ActivityProvider call( - String activityType, + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, ) { - return ActivityProvider( - activityType, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(FutureOr Function(ActivityRef ref) create) { - return _$ActivityFamilyOverride(this, create); + return ActivityProvider._( + argument: argument as String, + from: from! as ActivityFamily, + create: ( + ref, + String activityType, + ) => + create(ref)); } @override - String toString() => 'activityProvider'; -} - -class _$ActivityFamilyOverride implements $FamilyOverride { - _$ActivityFamilyOverride(this.from, this.create); - - final FutureOr Function(ActivityRef ref) create; - - @override - final ActivityFamily from; + FutureOr create(ActivityRef ref) { + final fn = _createCb ?? activity; + final String argument = this.argument as String; + return fn( + ref, + argument, + ); + } @override - _ActivityProviderElement createElement( - ProviderContainer container, - covariant ActivityProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is ActivityProvider && other.argument == argument; } @override - String toString() => 'activityProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [activity]. -class ActivityProvider extends AutoDisposeFutureProvider { - /// See also [activity]. - ActivityProvider( - String activityType, - ) : this._internal( - (ref) => activity( - ref as ActivityRef, - activityType, - ), - from: activityProvider, +String _$activityHash() => r'cb76e67cd45f1823d3ed497a235be53819ce2eaf'; + +final class ActivityFamily extends Family { + const ActivityFamily._() + : super( name: r'activityProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$activityHash, dependencies: null, allTransitiveDependencies: null, - activityType: activityType, + isAutoDispose: true, ); - ActivityProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.activityType, - }) : super.internal(); - - final String activityType; - - @override - Override overrideWith( - FutureOr Function(ActivityRef ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: ActivityProvider._internal( - (ref) => create(ref as ActivityRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - activityType: activityType, - ), - ); - } + ActivityProvider call( + String activityType, + ) => + ActivityProvider._(argument: activityType, from: this); @override - (String,) get argument { - return (activityType,); - } + String debugGetCreateSourceHash() => _$activityHash(); @override - _ActivityProviderElement createElement( - ProviderContainer container, - ) { - return _ActivityProviderElement(this, container); - } + String toString() => r'activityProvider'; - ActivityProvider _copyWith( - FutureOr Function(ActivityRef ref) create, + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr Function( + ActivityRef ref, + String args, + ) create, ) { - return ActivityProvider._internal( - (ref) => create(ref as ActivityRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - activityType: activityType, - ); - } - - @override - bool operator ==(Object other) { - return other is ActivityProvider && other.activityType == activityType; - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ActivityProvider; - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, activityType.hashCode); + final argument = provider.argument as String; - return _SystemHash.finish(hash); + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'activityProvider$argument'; -} - -mixin ActivityRef on AutoDisposeFutureProviderRef { - /// The parameter `activityType` of this provider. - String get activityType; } -class _ActivityProviderElement - extends AutoDisposeFutureProviderElement with ActivityRef { - _ActivityProviderElement(super.provider, super.container); - - @override - String get activityType => (origin as ActivityProvider).activityType; -} +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/passing_args/codegen/provider.g.dart b/website/docs/essentials/passing_args/codegen/provider.g.dart index 8bc5aa095..0639868a7 100644 --- a/website/docs/essentials/passing_args/codegen/provider.g.dart +++ b/website/docs/essentials/passing_args/codegen/provider.g.dart @@ -8,225 +8,211 @@ part of 'provider.dart'; // RiverpodGenerator // ************************************************************************** -String _$activityHash() => r'2f9496c5d70de9314c67e5c48ac44d8b149bc471'; +typedef ActivityRef = Ref>; -/// See also [activity]. @ProviderFor(activity) -final activityProvider = AutoDisposeFutureProvider.internal( - activity, - name: r'activityProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ActivityRef = AutoDisposeFutureProviderRef; -String _$activityNotifier2Hash() => r'9e67c655d53a9f98c3b012a0534421385dde0339'; +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); + final FutureOr Function( + ActivityRef ref, + )? _createCb; - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); } - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + @override + FutureOr create(ActivityRef ref) { + final fn = _createCb ?? activity; + return fn(ref); } } -abstract class _$ActivityNotifier2 - extends BuildlessAutoDisposeAsyncNotifier { - late final String activityType; - - FutureOr build( - String activityType, - ); -} +String _$activityHash() => r'2f9496c5d70de9314c67e5c48ac44d8b149bc471'; -/// See also [ActivityNotifier2]. @ProviderFor(ActivityNotifier2) -const activityNotifier2Provider = ActivityNotifier2Family(); - -/// See also [ActivityNotifier2]. -class ActivityNotifier2Family extends Family { - /// See also [ActivityNotifier2]. - const ActivityNotifier2Family(); - - static const Iterable? _dependencies = null; +const activityNotifier2Provider = ActivityNotifier2Family._(); + +final class ActivityNotifier2Provider + extends $AsyncNotifierProvider { + const ActivityNotifier2Provider._( + {required ActivityNotifier2Family super.from, + required String super.argument, + super.runNotifierBuildOverride, + ActivityNotifier2 Function()? create}) + : _createCb = create, + super( + name: r'activityNotifier2Provider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - static const Iterable? _allTransitiveDependencies = null; + final ActivityNotifier2 Function()? _createCb; @override - Iterable? get dependencies => _dependencies; + String debugGetCreateSourceHash() => _$activityNotifier2Hash(); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String toString() { + return r'activityNotifier2Provider' + '' + '($argument)'; + } + @$internal @override - String? get name => r'activityNotifier2Provider'; + ActivityNotifier2 create() => _createCb?.call() ?? ActivityNotifier2(); - /// See also [ActivityNotifier2]. - ActivityNotifier2Provider call( - String activityType, + @$internal + @override + ActivityNotifier2Provider $copyWithCreate( + ActivityNotifier2 Function() create, ) { - return ActivityNotifier2Provider( - activityType, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(ActivityNotifier2 Function() create) { - return _$ActivityNotifier2FamilyOverride(this, create); + return ActivityNotifier2Provider._( + argument: argument as String, + from: from! as ActivityNotifier2Family, + create: create); } + @$internal @override - String toString() => 'activityNotifier2Provider'; -} - -class _$ActivityNotifier2FamilyOverride implements $FamilyOverride { - _$ActivityNotifier2FamilyOverride(this.from, this.create); - - final ActivityNotifier2 Function() create; + ActivityNotifier2Provider $copyWithBuild( + FutureOr Function( + Ref>, + ActivityNotifier2, + ) build, + ) { + return ActivityNotifier2Provider._( + argument: argument as String, + from: from! as ActivityNotifier2Family, + runNotifierBuildOverride: build); + } + @$internal @override - final ActivityNotifier2Family from; + $AsyncNotifierProviderElement createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); @override - _ActivityNotifier2ProviderElement createElement( - ProviderContainer container, - covariant ActivityNotifier2Provider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is ActivityNotifier2Provider && other.argument == argument; } @override - String toString() => 'activityNotifier2Provider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [ActivityNotifier2]. -class ActivityNotifier2Provider - extends AutoDisposeAsyncNotifierProviderImpl { - /// See also [ActivityNotifier2]. - ActivityNotifier2Provider( - String activityType, - ) : this._internal( - () => ActivityNotifier2()..activityType = activityType, - from: activityNotifier2Provider, +String _$activityNotifier2Hash() => r'9e67c655d53a9f98c3b012a0534421385dde0339'; + +final class ActivityNotifier2Family extends Family { + const ActivityNotifier2Family._() + : super( name: r'activityNotifier2Provider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$activityNotifier2Hash, dependencies: null, allTransitiveDependencies: null, - activityType: activityType, + isAutoDispose: true, ); - ActivityNotifier2Provider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.activityType, - }) : super.internal(); - - final String activityType; - - @override - FutureOr runNotifierBuild( - covariant ActivityNotifier2 notifier, - ) { - return notifier.build( - activityType, - ); - } + ActivityNotifier2Provider call( + String activityType, + ) => + ActivityNotifier2Provider._(argument: activityType, from: this); @override - Override overrideWith(ActivityNotifier2 Function() create) { - return $ProviderOverride( - origin: this, - providerOverride: ActivityNotifier2Provider._internal( - () => create()..activityType = activityType, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - activityType: activityType, - ), - ); - } + String debugGetCreateSourceHash() => _$activityNotifier2Hash(); @override - (String,) get argument { - return (activityType,); - } + String toString() => r'activityNotifier2Provider'; - @override - _ActivityNotifier2ProviderElement createElement( - ProviderContainer container, + /// {@macro riverpod.override_with} + Override overrideWith( + ActivityNotifier2 Function( + String args, + ) create, ) { - return _ActivityNotifier2ProviderElement(this, container); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ActivityNotifier2Provider; - ActivityNotifier2Provider _copyWith( - ActivityNotifier2 Function() create, - ) { - return ActivityNotifier2Provider._internal( - () => create()..activityType = activityType, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - activityType: activityType, + final argument = provider.argument as String; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, ); } - @override - bool operator ==(Object other) { - return other is ActivityNotifier2Provider && - other.activityType == activityType; - } + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + FutureOr Function(Ref> ref, + ActivityNotifier2 notifier, String argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ActivityNotifier2Provider; - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, activityType.hashCode); + final argument = provider.argument as String; - return _SystemHash.finish(hash); + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'activityNotifier2Provider$argument'; -} - -mixin ActivityNotifier2Ref on AutoDisposeAsyncNotifierProviderRef { - /// The parameter `activityType` of this provider. - String get activityType; } -class _ActivityNotifier2ProviderElement - extends AutoDisposeAsyncNotifierProviderElement - with ActivityNotifier2Ref { - _ActivityNotifier2ProviderElement(super.provider, super.container); +abstract class _$ActivityNotifier2 extends $AsyncNotifier { + late final _$args = + (ref as $AsyncNotifierProviderElement).origin.argument as String; + String get activityType => _$args; + FutureOr build( + String activityType, + ); + @$internal @override - String get activityType => (origin as ActivityNotifier2Provider).activityType; + FutureOr runBuild() => build( + _$args, + ); } + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier.freezed.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier.freezed.dart index 6fb514afd..3326f9ffa 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier.freezed.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier.freezed.dart @@ -12,7 +12,7 @@ part of 'todo_list_notifier.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Todo _$TodoFromJson(Map json) { return _Todo.fromJson(json); diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart index 4e6801ff7..45e12c72f 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -23,20 +23,67 @@ Map _$$TodoImplToJson(_$TodoImpl instance) => // RiverpodGenerator // ************************************************************************** +@ProviderFor(TodoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider + extends $AsyncNotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + String _$todoListHash() => r'c939d438b07da6065dbbcfab86c27ef363bdb76c'; -/// See also [TodoList]. -@ProviderFor(TodoList) -final todoListProvider = - AutoDisposeAsyncNotifierProvider>.internal( - TodoList.new, - name: r'todoListProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$TodoList = AutoDisposeAsyncNotifier>; +abstract class _$TodoList extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart index 8d2e07c04..5f5ae9c4a 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -8,20 +8,67 @@ part of 'todo_list_notifier_add_todo.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(TodoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider + extends $AsyncNotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + String _$todoListHash() => r'4008395aaca8f55312f668c0b2a32e7599f82349'; -/// See also [TodoList]. -@ProviderFor(TodoList) -final todoListProvider = - AutoDisposeAsyncNotifierProvider>.internal( - TodoList.new, - name: r'todoListProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$TodoList = AutoDisposeAsyncNotifier>; +abstract class _$TodoList extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.freezed.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.freezed.dart index 67a84d8b7..26a2d640c 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.freezed.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.freezed.dart @@ -12,7 +12,7 @@ part of 'todo_list_provider.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$Todo { diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart index caa526bca..a00197e61 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -8,19 +8,58 @@ part of 'todo_list_provider.dart'; // RiverpodGenerator // ************************************************************************** -String _$todoListHash() => r'26b30307668c8feefa7cbe3c400b73e6edccbc39'; +typedef TodoListRef = Ref>>; -/// See also [todoList]. @ProviderFor(todoList) -final todoListProvider = AutoDisposeFutureProvider>.internal( - todoList, - name: r'todoListProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef TodoListRef = AutoDisposeFutureProviderRef>; +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider extends $FunctionalProvider>, + FutureOr>, TodoListRef> + with $FutureModifier>, $FutureProvider, TodoListRef> { + const TodoListProvider._( + {FutureOr> Function( + TodoListRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + TodoListRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + @override + $FutureProviderElement> createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + TodoListProvider $copyWithCreate( + FutureOr> Function( + TodoListRef ref, + ) create, + ) { + return TodoListProvider._(create: create); + } + + @override + FutureOr> create(TodoListRef ref) { + final fn = _createCb ?? todoList; + return fn(ref); + } +} + +String _$todoListHash() => r'26b30307668c8feefa7cbe3c400b73e6edccbc39'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/testing/notifier_mock/codegen.g.dart b/website/docs/essentials/testing/notifier_mock/codegen.g.dart index b2d7b9dac..9522fdb07 100644 --- a/website/docs/essentials/testing/notifier_mock/codegen.g.dart +++ b/website/docs/essentials/testing/notifier_mock/codegen.g.dart @@ -8,20 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$myNotifierHash() => r'912fa35c2296626fc0825bcbcfc6b6c85958be02'; -/// See also [MyNotifier]. -@ProviderFor(MyNotifier) -final myNotifierProvider = - AutoDisposeNotifierProvider.internal( - MyNotifier.new, - name: r'myNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$MyNotifier = AutoDisposeNotifier; +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart index dd85f62f9..e63365ff5 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart @@ -8,19 +8,57 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; +typedef ExampleRef = Ref>; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeFutureProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeFutureProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart index f64dd3222..5d07f3f51 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -8,22 +8,75 @@ part of 'pipe_change_notifier.dart'; // RiverpodGenerator // ************************************************************************** -String _$myListenableHash() => r'4cc07df2f47050c4aa761e5467f341ab6c312d09'; +/// A provider which creates a ValueNotifier and update its listeners +/// whenever the value changes. +typedef MyListenableRef = Ref>; /// A provider which creates a ValueNotifier and update its listeners /// whenever the value changes. -/// -/// Copied from [myListenable]. @ProviderFor(myListenable) -final myListenableProvider = AutoDisposeProvider>.internal( - myListenable, - name: r'myListenableProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$myListenableHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef MyListenableRef = AutoDisposeProviderRef>; +const myListenableProvider = MyListenableProvider._(); + +/// A provider which creates a ValueNotifier and update its listeners +/// whenever the value changes. +final class MyListenableProvider extends $FunctionalProvider< + ValueNotifier, + ValueNotifier, + MyListenableRef> with $Provider, MyListenableRef> { + /// A provider which creates a ValueNotifier and update its listeners + /// whenever the value changes. + const MyListenableProvider._( + {ValueNotifier Function( + MyListenableRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myListenableProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ValueNotifier Function( + MyListenableRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$myListenableHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(ValueNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @override + $ProviderElement> createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + MyListenableProvider $copyWithCreate( + ValueNotifier Function( + MyListenableRef ref, + ) create, + ) { + return MyListenableProvider._(create: create); + } + + @override + ValueNotifier create(MyListenableRef ref) { + final fn = _createCb ?? myListenable; + return fn(ref); + } +} + +String _$myListenableHash() => r'4cc07df2f47050c4aa761e5467f341ab6c312d09'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/raw_usage.g.dart b/website/docs/essentials/websockets_sync/raw_usage.g.dart index bd06ba4bc..1803d0cf7 100644 --- a/website/docs/essentials/websockets_sync/raw_usage.g.dart +++ b/website/docs/essentials/websockets_sync/raw_usage.g.dart @@ -8,19 +8,67 @@ part of 'raw_usage.dart'; // RiverpodGenerator // ************************************************************************** -String _$rawStreamHash() => r'7e7c2e8f4f08d33a4d86d60449e143c419ca4822'; +typedef RawStreamRef = Ref>>; -/// See also [rawStream]. @ProviderFor(rawStream) -final rawStreamProvider = AutoDisposeProvider>>.internal( - rawStream, - name: r'rawStreamProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$rawStreamHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef RawStreamRef = AutoDisposeProviderRef>>; +const rawStreamProvider = RawStreamProvider._(); + +final class RawStreamProvider extends $FunctionalProvider< + Raw>, + Raw>, + RawStreamRef> with $Provider>, RawStreamRef> { + const RawStreamProvider._( + {Raw> Function( + RawStreamRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'rawStreamProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + RawStreamRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$rawStreamHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @override + $ProviderElement>> createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + RawStreamProvider $copyWithCreate( + Raw> Function( + RawStreamRef ref, + ) create, + ) { + return RawStreamProvider._(create: create); + } + + @override + Raw> create(RawStreamRef ref) { + final fn = _createCb ?? rawStream; + return fn(ref); + } +} + +String _$rawStreamHash() => r'7e7c2e8f4f08d33a4d86d60449e143c419ca4822'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart index fbc40c61b..f530c0b0f 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -8,35 +8,127 @@ part of 'shared_pipe_change_notifier.dart'; // RiverpodGenerator // ************************************************************************** -String _$myListenableHash() => r'7096094cd24ed50dbabb9fb9ab64b340176c04bf'; +typedef MyListenableRef = Ref>; -/// See also [myListenable]. @ProviderFor(myListenable) -final myListenableProvider = AutoDisposeProvider>.internal( - myListenable, - name: r'myListenableProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$myListenableHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef MyListenableRef = AutoDisposeProviderRef>; -String _$anotherListenableHash() => r'38bfe5dbf5f148819b3671ad69d15c8e05264c23'; +const myListenableProvider = MyListenableProvider._(); + +final class MyListenableProvider extends $FunctionalProvider< + ValueNotifier, + ValueNotifier, + MyListenableRef> with $Provider, MyListenableRef> { + const MyListenableProvider._( + {ValueNotifier Function( + MyListenableRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myListenableProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ValueNotifier Function( + MyListenableRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$myListenableHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(ValueNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @override + $ProviderElement> createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + MyListenableProvider $copyWithCreate( + ValueNotifier Function( + MyListenableRef ref, + ) create, + ) { + return MyListenableProvider._(create: create); + } + + @override + ValueNotifier create(MyListenableRef ref) { + final fn = _createCb ?? myListenable; + return fn(ref); + } +} + +String _$myListenableHash() => r'7096094cd24ed50dbabb9fb9ab64b340176c04bf'; + +typedef AnotherListenableRef = Ref>; -/// See also [anotherListenable]. @ProviderFor(anotherListenable) -final anotherListenableProvider = - AutoDisposeProvider>.internal( - anotherListenable, - name: r'anotherListenableProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$anotherListenableHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef AnotherListenableRef = AutoDisposeProviderRef>; +const anotherListenableProvider = AnotherListenableProvider._(); + +final class AnotherListenableProvider extends $FunctionalProvider< + ValueNotifier, ValueNotifier, AnotherListenableRef> + with $Provider, AnotherListenableRef> { + const AnotherListenableProvider._( + {ValueNotifier Function( + AnotherListenableRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'anotherListenableProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ValueNotifier Function( + AnotherListenableRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$anotherListenableHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(ValueNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @override + $ProviderElement> createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + AnotherListenableProvider $copyWithCreate( + ValueNotifier Function( + AnotherListenableRef ref, + ) create, + ) { + return AnotherListenableProvider._(create: create); + } + + @override + ValueNotifier create(AnotherListenableRef ref) { + final fn = _createCb ?? anotherListenable; + return fn(ref); + } +} + +String _$anotherListenableHash() => r'38bfe5dbf5f148819b3671ad69d15c8e05264c23'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart index b8ef976c4..e4a7ad5f4 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -8,20 +8,57 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$streamExampleHash() => r'ca9993b22f6d587b20c041133cacd28d01933074'; +typedef StreamExampleRef = Ref>; -/// See also [streamExample]. @ProviderFor(streamExample) -final streamExampleProvider = AutoDisposeStreamProvider.internal( - streamExample, - name: r'streamExampleProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$streamExampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef StreamExampleRef = AutoDisposeStreamProviderRef; +const streamExampleProvider = StreamExampleProvider._(); + +final class StreamExampleProvider + extends $FunctionalProvider, Stream, StreamExampleRef> + with $FutureModifier, $StreamProvider { + const StreamExampleProvider._( + {Stream Function( + StreamExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'streamExampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + StreamExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$streamExampleHash(); + + @override + $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + StreamExampleProvider $copyWithCreate( + Stream Function( + StreamExampleRef ref, + ) create, + ) { + return StreamExampleProvider._(create: create); + } + + @override + Stream create(StreamExampleRef ref) { + final fn = _createCb ?? streamExample; + return fn(ref); + } +} + +String _$streamExampleHash() => r'ca9993b22f6d587b20c041133cacd28d01933074'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart index ef1015d6e..74e048bcb 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -8,21 +8,66 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +typedef SynchronousExampleRef = Ref; + +@ProviderFor(synchronousExample) +const synchronousExampleProvider = SynchronousExampleProvider._(); + +final class SynchronousExampleProvider + extends $FunctionalProvider + with $Provider { + const SynchronousExampleProvider._( + {int Function( + SynchronousExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'synchronousExampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + SynchronousExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$synchronousExampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + SynchronousExampleProvider $copyWithCreate( + int Function( + SynchronousExampleRef ref, + ) create, + ) { + return SynchronousExampleProvider._(create: create); + } + + @override + int create(SynchronousExampleRef ref) { + final fn = _createCb ?? synchronousExample; + return fn(ref); + } +} + String _$synchronousExampleHash() => r'98df96e07d554683041f668c06b36f183ff534c1'; -/// See also [synchronousExample]. -@ProviderFor(synchronousExample) -final synchronousExampleProvider = AutoDisposeProvider.internal( - synchronousExample, - name: r'synchronousExampleProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$synchronousExampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef SynchronousExampleRef = AutoDisposeProviderRef; +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index fdb56c497..8fce032bd 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -8,216 +8,163 @@ part of 'family.dart'; // RiverpodGenerator // ************************************************************************** -String _$randomHash() => r'517b12aad4df7b31f8872b89af74e7880377b2ea'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} +typedef RandomRef = Ref; -/// See also [random]. @ProviderFor(random) -const randomProvider = RandomFamily(); - -/// See also [random]. -class RandomFamily extends Family { - /// See also [random]. - const RandomFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; - - @override - Iterable? get dependencies => _dependencies; - - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; - - @override - String? get name => r'randomProvider'; +const randomProvider = RandomFamily._(); + +final class RandomProvider extends $FunctionalProvider + with $Provider { + const RandomProvider._( + {required RandomFamily super.from, + required ({ + int seed, + int max, + }) + super.argument, + int Function( + RandomRef ref, { + required int seed, + required int max, + })? create}) + : _createCb = create, + super( + name: r'randomProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - /// See also [random]. - RandomProvider call({ + final int Function( + RandomRef ref, { required int seed, required int max, - }) { - return RandomProvider( - seed: seed, - max: max, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(int Function(RandomRef ref) create) { - return _$RandomFamilyOverride(this, create); - } - - @override - String toString() => 'randomProvider'; -} - -class _$RandomFamilyOverride implements $FamilyOverride { - _$RandomFamilyOverride(this.from, this.create); - - final int Function(RandomRef ref) create; + })? _createCb; @override - final RandomFamily from; + String debugGetCreateSourceHash() => _$randomHash(); @override - _RandomProviderElement createElement( - ProviderContainer container, - covariant RandomProvider provider, - ) { - return provider._copyWith(create).createElement(container); + String toString() { + return r'randomProvider' + '' + '$argument'; } - @override - String toString() => 'randomProvider.overrideWith(...)'; -} - -/// See also [random]. -class RandomProvider extends AutoDisposeProvider { - /// See also [random]. - RandomProvider({ - required int seed, - required int max, - }) : this._internal( - (ref) => random( - ref as RandomRef, - seed: seed, - max: max, - ), - from: randomProvider, - name: r'randomProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$randomHash, - dependencies: null, - allTransitiveDependencies: null, - seed: seed, - max: max, - ); - - RandomProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.seed, - required this.max, - }) : super.internal(); - - final int seed; - final int max; - - @override - Override overrideWith( - int Function(RandomRef ref) create, - ) { + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { return $ProviderOverride( origin: this, - providerOverride: RandomProvider._internal( - (ref) => create(ref as RandomRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - seed: seed, - max: max, - ), + providerOverride: $ValueProvider(value), ); } @override - ({ - int seed, - int max, - }) get argument { - return ( - seed: seed, - max: max, - ); - } + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); @override - _RandomProviderElement createElement( - ProviderContainer container, + RandomProvider $copyWithCreate( + int Function( + RandomRef ref, + ) create, ) { - return _RandomProviderElement(this, container); + return RandomProvider._( + argument: argument as ({ + int seed, + int max, + }), + from: from! as RandomFamily, + create: ( + ref, { + required int seed, + required int max, + }) => + create(ref)); } - RandomProvider _copyWith( - int Function(RandomRef ref) create, - ) { - return RandomProvider._internal( - (ref) => create(ref as RandomRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - seed: seed, - max: max, + @override + int create(RandomRef ref) { + final fn = _createCb ?? random; + final ({ + int seed, + int max, + }) argument = this.argument as ({ + int seed, + int max, + }); + return fn( + ref, + seed: argument.seed, + max: argument.max, ); } @override bool operator ==(Object other) { - return other is RandomProvider && other.seed == seed && other.max == max; + return other is RandomProvider && other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, seed.hashCode); - hash = _SystemHash.combine(hash, max.hashCode); - - return _SystemHash.finish(hash); + return argument.hashCode; } - - @override - String toString() => 'randomProvider$argument'; } -mixin RandomRef on AutoDisposeProviderRef { - /// The parameter `seed` of this provider. - int get seed; +String _$randomHash() => r'517b12aad4df7b31f8872b89af74e7880377b2ea'; - /// The parameter `max` of this provider. - int get max; -} +final class RandomFamily extends Family { + const RandomFamily._() + : super( + name: r'randomProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); -class _RandomProviderElement extends AutoDisposeProviderElement - with RandomRef { - _RandomProviderElement(super.provider, super.container); + RandomProvider call({ + required int seed, + required int max, + }) => + RandomProvider._(argument: ( + seed: seed, + max: max, + ), from: this); @override - int get seed => (origin as RandomProvider).seed; + String debugGetCreateSourceHash() => _$randomHash(); + @override - int get max => (origin as RandomProvider).max; + String toString() => r'randomProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + int Function( + RandomRef ref, + ({ + int seed, + int max, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as RandomProvider; + + final argument = provider.argument as ({ + int seed, + int max, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } } + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/helpers/item.freezed.dart b/website/docs/from_provider/helpers/item.freezed.dart index 2ad228f69..e578c8154 100644 --- a/website/docs/from_provider/helpers/item.freezed.dart +++ b/website/docs/from_provider/helpers/item.freezed.dart @@ -12,7 +12,7 @@ part of 'item.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Item _$ItemFromJson(Map json) { return _Item.fromJson(json); diff --git a/website/docs/from_provider/motivation/async_values/async_values.g.dart b/website/docs/from_provider/motivation/async_values/async_values.g.dart index 0765d3a65..521a6e1cd 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.g.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.g.dart @@ -8,33 +8,117 @@ part of 'async_values.dart'; // RiverpodGenerator // ************************************************************************** -String _$itemsApiHash() => r'b32ccb7b85305e361d8ed752cbe11d9524c96190'; +typedef ItemsApiRef = Ref>>; -/// See also [itemsApi]. @ProviderFor(itemsApi) -final itemsApiProvider = AutoDisposeFutureProvider>.internal( - itemsApi, - name: r'itemsApiProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$itemsApiHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ItemsApiRef = AutoDisposeFutureProviderRef>; -String _$evenItemsHash() => r'55ae98f9b6108203dfc4a139f1ade9fbd8ba8ddd'; +const itemsApiProvider = ItemsApiProvider._(); + +final class ItemsApiProvider extends $FunctionalProvider>, + FutureOr>, ItemsApiRef> + with $FutureModifier>, $FutureProvider, ItemsApiRef> { + const ItemsApiProvider._( + {FutureOr> Function( + ItemsApiRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'itemsApiProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + ItemsApiRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$itemsApiHash(); + + @override + $FutureProviderElement> createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ItemsApiProvider $copyWithCreate( + FutureOr> Function( + ItemsApiRef ref, + ) create, + ) { + return ItemsApiProvider._(create: create); + } + + @override + FutureOr> create(ItemsApiRef ref) { + final fn = _createCb ?? itemsApi; + return fn(ref); + } +} + +String _$itemsApiHash() => r'b32ccb7b85305e361d8ed752cbe11d9524c96190'; + +typedef EvenItemsRef = Ref>; -/// See also [evenItems]. @ProviderFor(evenItems) -final evenItemsProvider = AutoDisposeProvider>.internal( - evenItems, - name: r'evenItemsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$evenItemsHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef EvenItemsRef = AutoDisposeProviderRef>; +const evenItemsProvider = EvenItemsProvider._(); + +final class EvenItemsProvider + extends $FunctionalProvider, List, EvenItemsRef> + with $Provider, EvenItemsRef> { + const EvenItemsProvider._( + {List Function( + EvenItemsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'evenItemsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + EvenItemsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$evenItemsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @override + $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + EvenItemsProvider $copyWithCreate( + List Function( + EvenItemsRef ref, + ) create, + ) { + return EvenItemsProvider._(create: create); + } + + @override + List create(EvenItemsRef ref) { + final fn = _createCb ?? evenItems; + return fn(ref); + } +} + +String _$evenItemsHash() => r'55ae98f9b6108203dfc4a139f1ade9fbd8ba8ddd'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart index 9397a920f..dc741cf2b 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -8,34 +8,123 @@ part of 'auto_dispose.dart'; // RiverpodGenerator // ************************************************************************** -String _$diceRollHash() => r'dfd5ac8b74351a0076da9d131c10277f53ff11b9'; +typedef DiceRollRef = Ref; -/// See also [diceRoll]. @ProviderFor(diceRoll) -final diceRollProvider = AutoDisposeProvider.internal( - diceRoll, - name: r'diceRollProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$diceRollHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef DiceRollRef = AutoDisposeProviderRef; -String _$cachedDiceRollHash() => r'fc31fcb804f10360d75362e56329976343ee7abb'; +const diceRollProvider = DiceRollProvider._(); + +final class DiceRollProvider extends $FunctionalProvider + with $Provider { + const DiceRollProvider._( + {int Function( + DiceRollRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'diceRollProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + DiceRollRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$diceRollHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DiceRollProvider $copyWithCreate( + int Function( + DiceRollRef ref, + ) create, + ) { + return DiceRollProvider._(create: create); + } + + @override + int create(DiceRollRef ref) { + final fn = _createCb ?? diceRoll; + return fn(ref); + } +} + +String _$diceRollHash() => r'dfd5ac8b74351a0076da9d131c10277f53ff11b9'; + +typedef CachedDiceRollRef = Ref; -/// See also [cachedDiceRoll]. @ProviderFor(cachedDiceRoll) -final cachedDiceRollProvider = AutoDisposeProvider.internal( - cachedDiceRoll, - name: r'cachedDiceRollProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$cachedDiceRollHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CachedDiceRollRef = AutoDisposeProviderRef; +const cachedDiceRollProvider = CachedDiceRollProvider._(); + +final class CachedDiceRollProvider + extends $FunctionalProvider + with $Provider { + const CachedDiceRollProvider._( + {int Function( + CachedDiceRollRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'cachedDiceRollProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CachedDiceRollRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$cachedDiceRollHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CachedDiceRollProvider $copyWithCreate( + int Function( + CachedDiceRollRef ref, + ) create, + ) { + return CachedDiceRollProvider._(create: create); + } + + @override + int create(CachedDiceRollRef ref) { + final fn = _createCb ?? cachedDiceRoll; + return fn(ref); + } +} + +String _$cachedDiceRollHash() => r'fc31fcb804f10360d75362e56329976343ee7abb'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/motivation/combine/combine.g.dart b/website/docs/from_provider/motivation/combine/combine.g.dart index 501f580ef..8343bbb00 100644 --- a/website/docs/from_provider/motivation/combine/combine.g.dart +++ b/website/docs/from_provider/motivation/combine/combine.g.dart @@ -8,33 +8,122 @@ part of 'combine.dart'; // RiverpodGenerator // ************************************************************************** -String _$numberHash() => r'725e25be57b9cc2bd914752f156e26a214596b63'; +typedef NumberRef = Ref; -/// See also [number]. @ProviderFor(number) -final numberProvider = AutoDisposeProvider.internal( - number, - name: r'numberProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$numberHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef NumberRef = AutoDisposeProviderRef; -String _$doubledHash() => r'ddc640c876bdbe49fe72fe1632b5ff48687c9279'; +const numberProvider = NumberProvider._(); + +final class NumberProvider extends $FunctionalProvider + with $Provider { + const NumberProvider._( + {int Function( + NumberRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'numberProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + NumberRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$numberHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + NumberProvider $copyWithCreate( + int Function( + NumberRef ref, + ) create, + ) { + return NumberProvider._(create: create); + } + + @override + int create(NumberRef ref) { + final fn = _createCb ?? number; + return fn(ref); + } +} + +String _$numberHash() => r'725e25be57b9cc2bd914752f156e26a214596b63'; + +typedef DoubledRef = Ref; -/// See also [doubled]. @ProviderFor(doubled) -final doubledProvider = AutoDisposeProvider.internal( - doubled, - name: r'doubledProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$doubledHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef DoubledRef = AutoDisposeProviderRef; +const doubledProvider = DoubledProvider._(); + +final class DoubledProvider extends $FunctionalProvider + with $Provider { + const DoubledProvider._( + {int Function( + DoubledRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'doubledProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + DoubledRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$doubledHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DoubledProvider $copyWithCreate( + int Function( + DoubledRef ref, + ) create, + ) { + return DoubledProvider._(create: create); + } + + @override + int create(DoubledRef ref) { + final fn = _createCb ?? doubled; + return fn(ref); + } +} + +String _$doubledHash() => r'ddc640c876bdbe49fe72fe1632b5ff48687c9279'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/motivation/same_type/same_type.g.dart b/website/docs/from_provider/motivation/same_type/same_type.g.dart index e421d5b6d..cda93475f 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.g.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.g.dart @@ -8,33 +8,124 @@ part of 'same_type.dart'; // RiverpodGenerator // ************************************************************************** -String _$itemsHash() => r'f0a8fa6874f4868db9ead31e82c75d976f9d2033'; +typedef ItemsRef = Ref>; -/// See also [items]. @ProviderFor(items) -final itemsProvider = AutoDisposeProvider>.internal( - items, - name: r'itemsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$itemsHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ItemsRef = AutoDisposeProviderRef>; -String _$evenItemsHash() => r'82b4525e91604745f2b4664531b32d4aff5717d4'; +const itemsProvider = ItemsProvider._(); + +final class ItemsProvider + extends $FunctionalProvider, List, ItemsRef> + with $Provider, ItemsRef> { + const ItemsProvider._( + {List Function( + ItemsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'itemsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + ItemsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$itemsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @override + $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ItemsProvider $copyWithCreate( + List Function( + ItemsRef ref, + ) create, + ) { + return ItemsProvider._(create: create); + } + + @override + List create(ItemsRef ref) { + final fn = _createCb ?? items; + return fn(ref); + } +} + +String _$itemsHash() => r'f0a8fa6874f4868db9ead31e82c75d976f9d2033'; + +typedef EvenItemsRef = Ref>; -/// See also [evenItems]. @ProviderFor(evenItems) -final evenItemsProvider = AutoDisposeProvider>.internal( - evenItems, - name: r'evenItemsProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$evenItemsHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef EvenItemsRef = AutoDisposeProviderRef>; +const evenItemsProvider = EvenItemsProvider._(); + +final class EvenItemsProvider + extends $FunctionalProvider, List, EvenItemsRef> + with $Provider, EvenItemsRef> { + const EvenItemsProvider._( + {List Function( + EvenItemsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'evenItemsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + EvenItemsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$evenItemsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @override + $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + EvenItemsProvider $copyWithCreate( + List Function( + EvenItemsRef ref, + ) create, + ) { + return EvenItemsProvider._(create: create); + } + + @override + List create(EvenItemsRef ref) { + final fn = _createCb ?? evenItems; + return fn(ref); + } +} + +String _$evenItemsHash() => r'82b4525e91604745f2b4664531b32d4aff5717d4'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart index a7cc420dc..61dcc5f0e 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart @@ -8,19 +8,65 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +typedef HelloWorldRef = Ref; -/// See also [helloWorld]. @ProviderFor(helloWorld) -final helloWorldProvider = AutoDisposeProvider.internal( - helloWorld, - name: r'helloWorldProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef HelloWorldRef = AutoDisposeProviderRef; +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final fn = _createCb ?? helloWorld; + return fn(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart index a7cc420dc..61dcc5f0e 100644 --- a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -8,19 +8,65 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +typedef HelloWorldRef = Ref; -/// See also [helloWorld]. @ProviderFor(helloWorld) -final helloWorldProvider = AutoDisposeProvider.internal( - helloWorld, - name: r'helloWorldProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef HelloWorldRef = AutoDisposeProviderRef; +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final fn = _createCb ?? helloWorld; + return fn(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/introduction/getting_started/hello_world/main.g.dart b/website/docs/introduction/getting_started/hello_world/main.g.dart index a7cc420dc..61dcc5f0e 100644 --- a/website/docs/introduction/getting_started/hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/main.g.dart @@ -8,19 +8,65 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +typedef HelloWorldRef = Ref; -/// See also [helloWorld]. @ProviderFor(helloWorld) -final helloWorldProvider = AutoDisposeProvider.internal( - helloWorld, - name: r'helloWorldProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef HelloWorldRef = AutoDisposeProviderRef; +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final fn = _createCb ?? helloWorld; + return fn(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index 74c764e68..6250b4cc7 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -8,220 +8,159 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$fetchPackagesHash() => r'eebf7d838a57f493fffebfd2c8d8ab76d3233165'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} +typedef FetchPackagesRef = Ref>>; -/// See also [fetchPackages]. @ProviderFor(fetchPackages) -const fetchPackagesProvider = FetchPackagesFamily(); - -/// See also [fetchPackages]. -class FetchPackagesFamily extends Family { - /// See also [fetchPackages]. - const FetchPackagesFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; +const fetchPackagesProvider = FetchPackagesFamily._(); + +final class FetchPackagesProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, FetchPackagesRef> + with + $FutureModifier>, + $FutureProvider, FetchPackagesRef> { + const FetchPackagesProvider._( + {required FetchPackagesFamily super.from, + required ({ + int page, + String search, + }) + super.argument, + FutureOr> Function( + FetchPackagesRef ref, { + required int page, + String search, + })? create}) + : _createCb = create, + super( + name: r'fetchPackagesProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get dependencies => _dependencies; + final FutureOr> Function( + FetchPackagesRef ref, { + required int page, + String search, + })? _createCb; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$fetchPackagesHash(); @override - String? get name => r'fetchPackagesProvider'; - - /// See also [fetchPackages]. - FetchPackagesProvider call({ - required int page, - String search = '', - }) { - return FetchPackagesProvider( - page: page, - search: search, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith( - FutureOr> Function(FetchPackagesRef ref) create) { - return _$FetchPackagesFamilyOverride(this, create); + String toString() { + return r'fetchPackagesProvider' + '' + '$argument'; } @override - String toString() => 'fetchPackagesProvider'; -} + $FutureProviderElement> createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); -class _$FetchPackagesFamilyOverride implements $FamilyOverride { - _$FetchPackagesFamilyOverride(this.from, this.create); - - final FutureOr> Function(FetchPackagesRef ref) create; + @override + FetchPackagesProvider $copyWithCreate( + FutureOr> Function( + FetchPackagesRef ref, + ) create, + ) { + return FetchPackagesProvider._( + argument: argument as ({ + int page, + String search, + }), + from: from! as FetchPackagesFamily, + create: ( + ref, { + required int page, + String search = '', + }) => + create(ref)); + } @override - final FetchPackagesFamily from; + FutureOr> create(FetchPackagesRef ref) { + final fn = _createCb ?? fetchPackages; + final ({ + int page, + String search, + }) argument = this.argument as ({ + int page, + String search, + }); + return fn( + ref, + page: argument.page, + search: argument.search, + ); + } @override - _FetchPackagesProviderElement createElement( - ProviderContainer container, - covariant FetchPackagesProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is FetchPackagesProvider && other.argument == argument; } @override - String toString() => 'fetchPackagesProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [fetchPackages]. -class FetchPackagesProvider extends AutoDisposeFutureProvider> { - /// See also [fetchPackages]. - FetchPackagesProvider({ - required int page, - String search = '', - }) : this._internal( - (ref) => fetchPackages( - ref as FetchPackagesRef, - page: page, - search: search, - ), - from: fetchPackagesProvider, +String _$fetchPackagesHash() => r'eebf7d838a57f493fffebfd2c8d8ab76d3233165'; + +final class FetchPackagesFamily extends Family { + const FetchPackagesFamily._() + : super( name: r'fetchPackagesProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$fetchPackagesHash, dependencies: null, allTransitiveDependencies: null, - page: page, - search: search, + isAutoDispose: true, ); - FetchPackagesProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.page, - required this.search, - }) : super.internal(); - - final int page; - final String search; - - @override - Override overrideWith( - FutureOr> Function(FetchPackagesRef ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: FetchPackagesProvider._internal( - (ref) => create(ref as FetchPackagesRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, + FetchPackagesProvider call({ + required int page, + String search = '', + }) => + FetchPackagesProvider._(argument: ( page: page, search: search, - ), - ); - } + ), from: this); @override - ({ - int page, - String search, - }) get argument { - return ( - page: page, - search: search, - ); - } + String debugGetCreateSourceHash() => _$fetchPackagesHash(); @override - _FetchPackagesProviderElement createElement( - ProviderContainer container, - ) { - return _FetchPackagesProviderElement(this, container); - } + String toString() => r'fetchPackagesProvider'; - FetchPackagesProvider _copyWith( - FutureOr> Function(FetchPackagesRef ref) create, + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr> Function( + FetchPackagesRef ref, + ({ + int page, + String search, + }) args, + ) create, ) { - return FetchPackagesProvider._internal( - (ref) => create(ref as FetchPackagesRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - page: page, - search: search, + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FetchPackagesProvider; + + final argument = provider.argument as ({ + int page, + String search, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, ); } - - @override - bool operator ==(Object other) { - return other is FetchPackagesProvider && - other.page == page && - other.search == search; - } - - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, page.hashCode); - hash = _SystemHash.combine(hash, search.hashCode); - - return _SystemHash.finish(hash); - } - - @override - String toString() => 'fetchPackagesProvider$argument'; -} - -mixin FetchPackagesRef on AutoDisposeFutureProviderRef> { - /// The parameter `page` of this provider. - int get page; - - /// The parameter `search` of this provider. - String get search; } -class _FetchPackagesProviderElement - extends AutoDisposeFutureProviderElement> - with FetchPackagesRef { - _FetchPackagesProviderElement(super.provider, super.container); - - @override - int get page => (origin as FetchPackagesProvider).page; - @override - String get search => (origin as FetchPackagesProvider).search; -} +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart index 317354e31..0606a445e 100644 --- a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart +++ b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart @@ -8,20 +8,67 @@ part of 'declaration.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider + extends $AsyncNotifierProvider> { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + String _$myNotifierHash() => r'fc9a07f8ef9f792da2ac660d76ea0a809335ba18'; -/// See also [MyNotifier]. -@ProviderFor(MyNotifier) -final myNotifierProvider = - AutoDisposeAsyncNotifierProvider>.internal( - MyNotifier.new, - name: r'myNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$MyNotifier = AutoDisposeAsyncNotifier>; +abstract class _$MyNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart index 376ce998f..40edfea06 100644 --- a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart +++ b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart @@ -8,20 +8,67 @@ part of 'initialization.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider + extends $AsyncNotifierProvider> { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + String _$myNotifierHash() => r'1c67c12443102cf8c43efbf6c630d3028d9847c3'; -/// See also [MyNotifier]. -@ProviderFor(MyNotifier) -final myNotifierProvider = - AutoDisposeAsyncNotifierProvider>.internal( - MyNotifier.new, - name: r'myNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$MyNotifier = AutoDisposeAsyncNotifier>; +abstract class _$MyNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart index 8eaddcfd9..a5fc09228 100644 --- a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart +++ b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart @@ -8,20 +8,67 @@ part of 'migrated.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider + extends $AsyncNotifierProvider> { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + String _$myNotifierHash() => r'bde95c56aa12eff7c8c01ede57ae4ad2b616c225'; -/// See also [MyNotifier]. -@ProviderFor(MyNotifier) -final myNotifierProvider = - AutoDisposeAsyncNotifierProvider>.internal( - MyNotifier.new, - name: r'myNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$MyNotifier = AutoDisposeAsyncNotifier>; +abstract class _$MyNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart index 161b3bba0..c9e7ae8af 100644 --- a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart +++ b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -8,20 +8,74 @@ part of 'add_listener.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$myNotifierHash() => r'9acd382ed579c545ace755687b155e28eba01d22'; -/// See also [MyNotifier]. -@ProviderFor(MyNotifier) -final myNotifierProvider = - AutoDisposeNotifierProvider.internal( - MyNotifier.new, - name: r'myNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$MyNotifier = AutoDisposeNotifier; +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart index 25bcda60d..c91630e7b 100644 --- a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart +++ b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -8,22 +8,68 @@ part of 'async_notifier.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(AsyncTodosNotifier) +const asyncTodosNotifierProvider = AsyncTodosNotifierProvider._(); + +final class AsyncTodosNotifierProvider + extends $AsyncNotifierProvider> { + const AsyncTodosNotifierProvider._( + {super.runNotifierBuildOverride, AsyncTodosNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'asyncTodosNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final AsyncTodosNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$asyncTodosNotifierHash(); + + @$internal + @override + AsyncTodosNotifier create() => _createCb?.call() ?? AsyncTodosNotifier(); + + @$internal + @override + AsyncTodosNotifierProvider $copyWithCreate( + AsyncTodosNotifier Function() create, + ) { + return AsyncTodosNotifierProvider._(create: create); + } + + @$internal + @override + AsyncTodosNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + AsyncTodosNotifier, + ) build, + ) { + return AsyncTodosNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + String _$asyncTodosNotifierHash() => r'10207327c7dee180e9da8beece5bfffedcf86e98'; -/// See also [AsyncTodosNotifier]. -@ProviderFor(AsyncTodosNotifier) -final asyncTodosNotifierProvider = - AutoDisposeAsyncNotifierProvider>.internal( - AsyncTodosNotifier.new, - name: r'asyncTodosNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$asyncTodosNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$AsyncTodosNotifier = AutoDisposeAsyncNotifier>; +abstract class _$AsyncTodosNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart index 6b4621ecb..cd06e8415 100644 --- a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart +++ b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart @@ -8,21 +8,75 @@ part of 'build_init.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(CounterNotifier) +const counterNotifierProvider = CounterNotifierProvider._(); + +final class CounterNotifierProvider + extends $NotifierProvider { + const CounterNotifierProvider._( + {super.runNotifierBuildOverride, CounterNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CounterNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + CounterNotifier create() => _createCb?.call() ?? CounterNotifier(); + + @$internal + @override + CounterNotifierProvider $copyWithCreate( + CounterNotifier Function() create, + ) { + return CounterNotifierProvider._(create: create); + } + + @$internal + @override + CounterNotifierProvider $copyWithBuild( + int Function( + Ref, + CounterNotifier, + ) build, + ) { + return CounterNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterNotifierHash() => r'8d4e4011da15a0ef79af9622336839a0c9e406ab'; -/// See also [CounterNotifier]. -@ProviderFor(CounterNotifier) -final counterNotifierProvider = - AutoDisposeNotifierProvider.internal( - CounterNotifier.new, - name: r'counterNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$counterNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$CounterNotifier = AutoDisposeNotifier; +abstract class _$CounterNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index fb8e9c347..3bd132aa5 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -8,212 +8,163 @@ part of 'family_and_dispose.dart'; // RiverpodGenerator // ************************************************************************** -String _$bugsEncounteredNotifierHash() => - r'c76e924f84db91c57d226896b062d9f4e8ab79e5'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -abstract class _$BugsEncounteredNotifier - extends BuildlessAutoDisposeAsyncNotifier { - late final String featureId; - - FutureOr build( - String featureId, - ); -} - -/// See also [BugsEncounteredNotifier]. @ProviderFor(BugsEncounteredNotifier) -const bugsEncounteredNotifierProvider = BugsEncounteredNotifierFamily(); - -/// See also [BugsEncounteredNotifier]. -class BugsEncounteredNotifierFamily extends Family { - /// See also [BugsEncounteredNotifier]. - const BugsEncounteredNotifierFamily(); - - static const Iterable? _dependencies = null; +const bugsEncounteredNotifierProvider = BugsEncounteredNotifierFamily._(); + +final class BugsEncounteredNotifierProvider + extends $AsyncNotifierProvider { + const BugsEncounteredNotifierProvider._( + {required BugsEncounteredNotifierFamily super.from, + required String super.argument, + super.runNotifierBuildOverride, + BugsEncounteredNotifier Function()? create}) + : _createCb = create, + super( + name: r'bugsEncounteredNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - static const Iterable? _allTransitiveDependencies = null; + final BugsEncounteredNotifier Function()? _createCb; @override - Iterable? get dependencies => _dependencies; + String debugGetCreateSourceHash() => _$bugsEncounteredNotifierHash(); @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String toString() { + return r'bugsEncounteredNotifierProvider' + '' + '($argument)'; + } + @$internal @override - String? get name => r'bugsEncounteredNotifierProvider'; + BugsEncounteredNotifier create() => + _createCb?.call() ?? BugsEncounteredNotifier(); - /// See also [BugsEncounteredNotifier]. - BugsEncounteredNotifierProvider call( - String featureId, + @$internal + @override + BugsEncounteredNotifierProvider $copyWithCreate( + BugsEncounteredNotifier Function() create, ) { - return BugsEncounteredNotifierProvider( - featureId, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(BugsEncounteredNotifier Function() create) { - return _$BugsEncounteredNotifierFamilyOverride(this, create); + return BugsEncounteredNotifierProvider._( + argument: argument as String, + from: from! as BugsEncounteredNotifierFamily, + create: create); } + @$internal @override - String toString() => 'bugsEncounteredNotifierProvider'; -} - -class _$BugsEncounteredNotifierFamilyOverride implements $FamilyOverride { - _$BugsEncounteredNotifierFamilyOverride(this.from, this.create); - - final BugsEncounteredNotifier Function() create; + BugsEncounteredNotifierProvider $copyWithBuild( + FutureOr Function( + Ref>, + BugsEncounteredNotifier, + ) build, + ) { + return BugsEncounteredNotifierProvider._( + argument: argument as String, + from: from! as BugsEncounteredNotifierFamily, + runNotifierBuildOverride: build); + } + @$internal @override - final BugsEncounteredNotifierFamily from; + $AsyncNotifierProviderElement createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); @override - _BugsEncounteredNotifierProviderElement createElement( - ProviderContainer container, - covariant BugsEncounteredNotifierProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is BugsEncounteredNotifierProvider && + other.argument == argument; } @override - String toString() => 'bugsEncounteredNotifierProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [BugsEncounteredNotifier]. -class BugsEncounteredNotifierProvider - extends AutoDisposeAsyncNotifierProviderImpl { - /// See also [BugsEncounteredNotifier]. - BugsEncounteredNotifierProvider( - String featureId, - ) : this._internal( - () => BugsEncounteredNotifier()..featureId = featureId, - from: bugsEncounteredNotifierProvider, +String _$bugsEncounteredNotifierHash() => + r'c76e924f84db91c57d226896b062d9f4e8ab79e5'; + +final class BugsEncounteredNotifierFamily extends Family { + const BugsEncounteredNotifierFamily._() + : super( name: r'bugsEncounteredNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$bugsEncounteredNotifierHash, dependencies: null, allTransitiveDependencies: null, - featureId: featureId, + isAutoDispose: true, ); - BugsEncounteredNotifierProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.featureId, - }) : super.internal(); - - final String featureId; - - @override - FutureOr runNotifierBuild( - covariant BugsEncounteredNotifier notifier, - ) { - return notifier.build( - featureId, - ); - } + BugsEncounteredNotifierProvider call( + String featureId, + ) => + BugsEncounteredNotifierProvider._(argument: featureId, from: this); @override - Override overrideWith(BugsEncounteredNotifier Function() create) { - return $ProviderOverride( - origin: this, - providerOverride: BugsEncounteredNotifierProvider._internal( - () => create()..featureId = featureId, - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - featureId: featureId, - ), - ); - } + String debugGetCreateSourceHash() => _$bugsEncounteredNotifierHash(); @override - (String,) get argument { - return (featureId,); - } + String toString() => r'bugsEncounteredNotifierProvider'; - @override - _BugsEncounteredNotifierProviderElement createElement( - ProviderContainer container, + /// {@macro riverpod.override_with} + Override overrideWith( + BugsEncounteredNotifier Function( + String args, + ) create, ) { - return _BugsEncounteredNotifierProviderElement(this, container); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as BugsEncounteredNotifierProvider; - BugsEncounteredNotifierProvider _copyWith( - BugsEncounteredNotifier Function() create, - ) { - return BugsEncounteredNotifierProvider._internal( - () => create()..featureId = featureId, - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - featureId: featureId, + final argument = provider.argument as String; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, ); } - @override - bool operator ==(Object other) { - return other is BugsEncounteredNotifierProvider && - other.featureId == featureId; - } + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + FutureOr Function(Ref> ref, + BugsEncounteredNotifier notifier, String argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as BugsEncounteredNotifierProvider; - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, featureId.hashCode); + final argument = provider.argument as String; - return _SystemHash.finish(hash); + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'bugsEncounteredNotifierProvider$argument'; -} - -mixin BugsEncounteredNotifierRef on AutoDisposeAsyncNotifierProviderRef { - /// The parameter `featureId` of this provider. - String get featureId; } -class _BugsEncounteredNotifierProviderElement - extends AutoDisposeAsyncNotifierProviderElement with BugsEncounteredNotifierRef { - _BugsEncounteredNotifierProviderElement(super.provider, super.container); +abstract class _$BugsEncounteredNotifier extends $AsyncNotifier { + late final _$args = + (ref as $AsyncNotifierProviderElement).origin.argument as String; + String get featureId => _$args; + FutureOr build( + String featureId, + ); + @$internal @override - String get featureId => (origin as BugsEncounteredNotifierProvider).featureId; + FutureOr runBuild() => build( + _$args, + ); } + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart index 9a3edeebc..4d01b64c0 100644 --- a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart +++ b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -8,21 +8,75 @@ part of 'from_state_provider.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(CounterNotifier) +const counterNotifierProvider = CounterNotifierProvider._(); + +final class CounterNotifierProvider + extends $NotifierProvider { + const CounterNotifierProvider._( + {super.runNotifierBuildOverride, CounterNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CounterNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + CounterNotifier create() => _createCb?.call() ?? CounterNotifier(); + + @$internal + @override + CounterNotifierProvider $copyWithCreate( + CounterNotifier Function() create, + ) { + return CounterNotifierProvider._(create: create); + } + + @$internal + @override + CounterNotifierProvider $copyWithBuild( + int Function( + Ref, + CounterNotifier, + ) build, + ) { + return CounterNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterNotifierHash() => r'b32033040f0fff627f1a6dfd9cfb4e93a842390b'; -/// See also [CounterNotifier]. -@ProviderFor(CounterNotifier) -final counterNotifierProvider = - AutoDisposeNotifierProvider.internal( - CounterNotifier.new, - name: r'counterNotifierProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$counterNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$CounterNotifier = AutoDisposeNotifier; +abstract class _$CounterNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart index d28e242a3..8b27c0d96 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -8,20 +8,74 @@ part of 'old_lifecycles.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$myNotifierHash() => r'0495c52ce893ee0304d4d5ac5648c634ed4a241e'; -/// See also [MyNotifier]. -@ProviderFor(MyNotifier) -final myNotifierProvider = - AutoDisposeNotifierProvider.internal( - MyNotifier.new, - name: r'myNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$MyNotifier = AutoDisposeNotifier; +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart index 7c55609e1..f2fd0d752 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -8,20 +8,74 @@ part of 'old_lifecycles_final.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$myNotifierHash() => r'8ea2586ea29d12306efd4b8b847142136dd20338'; -/// See also [MyNotifier]. -@ProviderFor(MyNotifier) -final myNotifierProvider = - AutoDisposeNotifierProvider.internal( - MyNotifier.new, - name: r'myNotifierProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$MyNotifier = AutoDisposeNotifier; +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/providers/future_provider/config_provider/codegen.g.dart b/website/docs/providers/future_provider/config_provider/codegen.g.dart index ce4740543..7af35b388 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.g.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.g.dart @@ -8,22 +8,63 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +typedef FetchConfigurationRef = Ref>; + +@ProviderFor(fetchConfiguration) +const fetchConfigurationProvider = FetchConfigurationProvider._(); + +final class FetchConfigurationProvider extends $FunctionalProvider< + AsyncValue, + FutureOr, + FetchConfigurationRef> + with + $FutureModifier, + $FutureProvider { + const FetchConfigurationProvider._( + {FutureOr Function( + FetchConfigurationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'fetchConfigurationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + FetchConfigurationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$fetchConfigurationHash(); + + @override + $FutureProviderElement createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + FetchConfigurationProvider $copyWithCreate( + FutureOr Function( + FetchConfigurationRef ref, + ) create, + ) { + return FetchConfigurationProvider._(create: create); + } + + @override + FutureOr create(FetchConfigurationRef ref) { + final fn = _createCb ?? fetchConfiguration; + return fn(ref); + } +} + String _$fetchConfigurationHash() => r'6c0f062e6f20baf883c4282856f1197fbe633d89'; -/// See also [fetchConfiguration]. -@ProviderFor(fetchConfiguration) -final fetchConfigurationProvider = - AutoDisposeFutureProvider.internal( - fetchConfiguration, - name: r'fetchConfigurationProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$fetchConfigurationHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef FetchConfigurationRef = AutoDisposeFutureProviderRef; +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/providers/notifier_provider/remote_todos/codegen.freezed.dart b/website/docs/providers/notifier_provider/remote_todos/codegen.freezed.dart index 3fbfdcf6c..d1b8a01d5 100644 --- a/website/docs/providers/notifier_provider/remote_todos/codegen.freezed.dart +++ b/website/docs/providers/notifier_provider/remote_todos/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Todo _$TodoFromJson(Map json) { return _Todo.fromJson(json); diff --git a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart index 8783f8ed4..7404f0524 100644 --- a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart @@ -25,20 +25,67 @@ Map _$$TodoImplToJson(_$TodoImpl instance) => // RiverpodGenerator // ************************************************************************** +@ProviderFor(AsyncTodos) +const asyncTodosProvider = AsyncTodosProvider._(); + +final class AsyncTodosProvider + extends $AsyncNotifierProvider> { + const AsyncTodosProvider._( + {super.runNotifierBuildOverride, AsyncTodos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'asyncTodosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final AsyncTodos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$asyncTodosHash(); + + @$internal + @override + AsyncTodos create() => _createCb?.call() ?? AsyncTodos(); + + @$internal + @override + AsyncTodosProvider $copyWithCreate( + AsyncTodos Function() create, + ) { + return AsyncTodosProvider._(create: create); + } + + @$internal + @override + AsyncTodosProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + AsyncTodos, + ) build, + ) { + return AsyncTodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + String _$asyncTodosHash() => r'fd0d7502a1c17b7cedd2350519649dd680fc48cd'; -/// See also [AsyncTodos]. -@ProviderFor(AsyncTodos) -final asyncTodosProvider = - AutoDisposeAsyncNotifierProvider>.internal( - AsyncTodos.new, - name: r'asyncTodosProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$asyncTodosHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$AsyncTodos = AutoDisposeAsyncNotifier>; +abstract class _$AsyncTodos extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/providers/notifier_provider/todos/codegen.freezed.dart b/website/docs/providers/notifier_provider/todos/codegen.freezed.dart index a2fc72563..0b73d3548 100644 --- a/website/docs/providers/notifier_provider/todos/codegen.freezed.dart +++ b/website/docs/providers/notifier_provider/todos/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$Todo { diff --git a/website/docs/providers/notifier_provider/todos/codegen.g.dart b/website/docs/providers/notifier_provider/todos/codegen.g.dart index 0abb46e3f..75ff6212e 100644 --- a/website/docs/providers/notifier_provider/todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/todos/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Todos) +const todosProvider = TodosProvider._(); + +final class TodosProvider extends $NotifierProvider> { + const TodosProvider._( + {super.runNotifierBuildOverride, Todos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Todos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + Todos create() => _createCb?.call() ?? Todos(); + + @$internal + @override + TodosProvider $copyWithCreate( + Todos Function() create, + ) { + return TodosProvider._(create: create); + } + + @$internal + @override + TodosProvider $copyWithBuild( + List Function( + Ref>, + Todos, + ) build, + ) { + return TodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$todosHash() => r'3485c14ec4db07efe5fe52243258a66e6f99b2b4'; -/// See also [Todos]. -@ProviderFor(Todos) -final todosProvider = AutoDisposeNotifierProvider>.internal( - Todos.new, - name: r'todosProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$todosHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Todos = AutoDisposeNotifier>; +abstract class _$Todos extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/providers/provider/completed_todos/completed_todos.g.dart b/website/docs/providers/provider/completed_todos/completed_todos.g.dart index be2ec7731..2323ad997 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.g.dart @@ -8,20 +8,65 @@ part of 'completed_todos.dart'; // RiverpodGenerator // ************************************************************************** -String _$completedTodosHash() => r'855706c09268f428696b3b382ae1605818361b83'; +typedef CompletedTodosRef = Ref>; -/// See also [completedTodos]. @ProviderFor(completedTodos) -final completedTodosProvider = AutoDisposeProvider>.internal( - completedTodos, - name: r'completedTodosProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$completedTodosHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CompletedTodosRef = AutoDisposeProviderRef>; +const completedTodosProvider = CompletedTodosProvider._(); + +final class CompletedTodosProvider + extends $FunctionalProvider, List, CompletedTodosRef> + with $Provider, CompletedTodosRef> { + const CompletedTodosProvider._( + {List Function( + CompletedTodosRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'completedTodosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + CompletedTodosRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$completedTodosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @override + $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CompletedTodosProvider $copyWithCreate( + List Function( + CompletedTodosRef ref, + ) create, + ) { + return CompletedTodosProvider._(create: create); + } + + @override + List create(CompletedTodosRef ref) { + final fn = _createCb ?? completedTodos; + return fn(ref); + } +} + +String _$completedTodosHash() => r'855706c09268f428696b3b382ae1605818361b83'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index 096a056f2..63b0464de 100644 --- a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -8,35 +8,134 @@ part of 'optimized_previous_button.dart'; // RiverpodGenerator // ************************************************************************** +typedef CanGoToPreviousPageRef = Ref; + +@ProviderFor(canGoToPreviousPage) +const canGoToPreviousPageProvider = CanGoToPreviousPageProvider._(); + +final class CanGoToPreviousPageProvider + extends $FunctionalProvider + with $Provider { + const CanGoToPreviousPageProvider._( + {bool Function( + CanGoToPreviousPageRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'canGoToPreviousPageProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final bool Function( + CanGoToPreviousPageRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$canGoToPreviousPageHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(bool value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CanGoToPreviousPageProvider $copyWithCreate( + bool Function( + CanGoToPreviousPageRef ref, + ) create, + ) { + return CanGoToPreviousPageProvider._(create: create); + } + + @override + bool create(CanGoToPreviousPageRef ref) { + final fn = _createCb ?? canGoToPreviousPage; + return fn(ref); + } +} + String _$canGoToPreviousPageHash() => r'801fe8182a37cd21ae83bdfccbe36c125b4d14fb'; -/// See also [canGoToPreviousPage]. -@ProviderFor(canGoToPreviousPage) -final canGoToPreviousPageProvider = AutoDisposeProvider.internal( - canGoToPreviousPage, - name: r'canGoToPreviousPageProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$canGoToPreviousPageHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CanGoToPreviousPageRef = AutoDisposeProviderRef; +@ProviderFor(PageIndex) +const pageIndexProvider = PageIndexProvider._(); + +final class PageIndexProvider extends $NotifierProvider { + const PageIndexProvider._( + {super.runNotifierBuildOverride, PageIndex Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'pageIndexProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final PageIndex Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$pageIndexHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + PageIndex create() => _createCb?.call() ?? PageIndex(); + + @$internal + @override + PageIndexProvider $copyWithCreate( + PageIndex Function() create, + ) { + return PageIndexProvider._(create: create); + } + + @$internal + @override + PageIndexProvider $copyWithBuild( + int Function( + Ref, + PageIndex, + ) build, + ) { + return PageIndexProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$pageIndexHash() => r'59307ecf23b5b2432833da5ad6b312bf36435d0e'; -/// See also [PageIndex]. -@ProviderFor(PageIndex) -final pageIndexProvider = AutoDisposeNotifierProvider.internal( - PageIndex.new, - name: r'pageIndexProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$pageIndexHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$PageIndex = AutoDisposeNotifier; +abstract class _$PageIndex extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/providers/provider/todo/todo.g.dart b/website/docs/providers/provider/todo/todo.g.dart index 0b4a0a56d..3d278dd0e 100644 --- a/website/docs/providers/provider/todo/todo.g.dart +++ b/website/docs/providers/provider/todo/todo.g.dart @@ -8,19 +8,74 @@ part of 'todo.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Todos) +const todosProvider = TodosProvider._(); + +final class TodosProvider extends $NotifierProvider> { + const TodosProvider._( + {super.runNotifierBuildOverride, Todos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Todos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + Todos create() => _createCb?.call() ?? Todos(); + + @$internal + @override + TodosProvider $copyWithCreate( + Todos Function() create, + ) { + return TodosProvider._(create: create); + } + + @$internal + @override + TodosProvider $copyWithBuild( + List Function( + Ref>, + Todos, + ) build, + ) { + return TodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$todosHash() => r'4bd25c3c15bfff56ad6e733bd17ecb7284c4ceb2'; -/// See also [Todos]. -@ProviderFor(Todos) -final todosProvider = AutoDisposeNotifierProvider>.internal( - Todos.new, - name: r'todosProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$todosHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Todos = AutoDisposeNotifier>; +abstract class _$Todos extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart index e02ece976..e82d88b84 100644 --- a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart +++ b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -8,19 +8,74 @@ part of 'unoptimized_previous_button.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(PageIndex) +const pageIndexProvider = PageIndexProvider._(); + +final class PageIndexProvider extends $NotifierProvider { + const PageIndexProvider._( + {super.runNotifierBuildOverride, PageIndex Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'pageIndexProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final PageIndex Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$pageIndexHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + PageIndex create() => _createCb?.call() ?? PageIndex(); + + @$internal + @override + PageIndexProvider $copyWithCreate( + PageIndex Function() create, + ) { + return PageIndexProvider._(create: create); + } + + @$internal + @override + PageIndexProvider $copyWithBuild( + int Function( + Ref, + PageIndex, + ) build, + ) { + return PageIndexProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$pageIndexHash() => r'59307ecf23b5b2432833da5ad6b312bf36435d0e'; -/// See also [PageIndex]. -@ProviderFor(PageIndex) -final pageIndexProvider = AutoDisposeNotifierProvider.internal( - PageIndex.new, - name: r'pageIndexProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$pageIndexHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$PageIndex = AutoDisposeNotifier; +abstract class _$PageIndex extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart index ed660f3fa..d5a34b788 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -8,19 +8,58 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$chatHash() => r'db1302132f90e854fe2f5da9d97d89c9a3c8b858'; +typedef ChatRef = Ref>>; -/// See also [chat]. @ProviderFor(chat) -final chatProvider = AutoDisposeStreamProvider>.internal( - chat, - name: r'chatProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$chatHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ChatRef = AutoDisposeStreamProviderRef>; +const chatProvider = ChatProvider._(); + +final class ChatProvider extends $FunctionalProvider>, + Stream>, ChatRef> + with $FutureModifier>, $StreamProvider, ChatRef> { + const ChatProvider._( + {Stream> Function( + ChatRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'chatProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream> Function( + ChatRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$chatHash(); + + @override + $StreamProviderElement> createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ChatProvider $copyWithCreate( + Stream> Function( + ChatRef ref, + ) create, + ) { + return ChatProvider._(create: create); + } + + @override + Stream> create(ChatRef ref) { + final fn = _createCb ?? chat; + return fn(ref); + } +} + +String _$chatHash() => r'db1302132f90e854fe2f5da9d97d89c9a3c8b858'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 7bb0e49dc..86fce98be 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -8,197 +8,129 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$fetchUserHash() => r'ff427bbb4130a8a6994fa623ae70997f7b0f6bdb'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); +typedef FetchUserRef = Ref>; - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [fetchUser]. @ProviderFor(fetchUser) -const fetchUserProvider = FetchUserFamily(); - -/// See also [fetchUser]. -class FetchUserFamily extends Family { - /// See also [fetchUser]. - const FetchUserFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; +const fetchUserProvider = FetchUserFamily._(); + +final class FetchUserProvider + extends $FunctionalProvider, FutureOr, FetchUserRef> + with $FutureModifier, $FutureProvider { + const FetchUserProvider._( + {required FetchUserFamily super.from, + required int super.argument, + FutureOr Function( + FetchUserRef ref, { + required int userId, + })? create}) + : _createCb = create, + super( + name: r'fetchUserProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get dependencies => _dependencies; + final FutureOr Function( + FetchUserRef ref, { + required int userId, + })? _createCb; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$fetchUserHash(); @override - String? get name => r'fetchUserProvider'; - - /// See also [fetchUser]. - FetchUserProvider call({ - required int userId, - }) { - return FetchUserProvider( - userId: userId, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(FutureOr Function(FetchUserRef ref) create) { - return _$FetchUserFamilyOverride(this, create); + String toString() { + return r'fetchUserProvider' + '' + '($argument)'; } @override - String toString() => 'fetchUserProvider'; -} + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); -class _$FetchUserFamilyOverride implements $FamilyOverride { - _$FetchUserFamilyOverride(this.from, this.create); - - final FutureOr Function(FetchUserRef ref) create; + @override + FetchUserProvider $copyWithCreate( + FutureOr Function( + FetchUserRef ref, + ) create, + ) { + return FetchUserProvider._( + argument: argument as int, + from: from! as FetchUserFamily, + create: ( + ref, { + required int userId, + }) => + create(ref)); + } @override - final FetchUserFamily from; + FutureOr create(FetchUserRef ref) { + final fn = _createCb ?? fetchUser; + final int argument = this.argument as int; + return fn( + ref, + userId: argument, + ); + } @override - _FetchUserProviderElement createElement( - ProviderContainer container, - covariant FetchUserProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is FetchUserProvider && other.argument == argument; } @override - String toString() => 'fetchUserProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [fetchUser]. -class FetchUserProvider extends AutoDisposeFutureProvider { - /// See also [fetchUser]. - FetchUserProvider({ - required int userId, - }) : this._internal( - (ref) => fetchUser( - ref as FetchUserRef, - userId: userId, - ), - from: fetchUserProvider, +String _$fetchUserHash() => r'ff427bbb4130a8a6994fa623ae70997f7b0f6bdb'; + +final class FetchUserFamily extends Family { + const FetchUserFamily._() + : super( name: r'fetchUserProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$fetchUserHash, dependencies: null, allTransitiveDependencies: null, - userId: userId, + isAutoDispose: true, ); - FetchUserProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.userId, - }) : super.internal(); - - final int userId; - - @override - Override overrideWith( - FutureOr Function(FetchUserRef ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: FetchUserProvider._internal( - (ref) => create(ref as FetchUserRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - userId: userId, - ), - ); - } + FetchUserProvider call({ + required int userId, + }) => + FetchUserProvider._(argument: userId, from: this); @override - ({ - int userId, - }) get argument { - return (userId: userId,); - } + String debugGetCreateSourceHash() => _$fetchUserHash(); @override - _FetchUserProviderElement createElement( - ProviderContainer container, - ) { - return _FetchUserProviderElement(this, container); - } + String toString() => r'fetchUserProvider'; - FetchUserProvider _copyWith( - FutureOr Function(FetchUserRef ref) create, + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr Function( + FetchUserRef ref, + int args, + ) create, ) { - return FetchUserProvider._internal( - (ref) => create(ref as FetchUserRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - userId: userId, - ); - } - - @override - bool operator ==(Object other) { - return other is FetchUserProvider && other.userId == userId; - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FetchUserProvider; - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, userId.hashCode); + final argument = provider.argument as int; - return _SystemHash.finish(hash); + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'fetchUserProvider$argument'; -} - -mixin FetchUserRef on AutoDisposeFutureProviderRef { - /// The parameter `userId` of this provider. - int get userId; } -class _FetchUserProviderElement extends AutoDisposeFutureProviderElement - with FetchUserRef { - _FetchUserProviderElement(super.provider, super.container); - - @override - int get userId => (origin as FetchUserProvider).userId; -} +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index a7cc420dc..61dcc5f0e 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -8,19 +8,65 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +typedef HelloWorldRef = Ref; -/// See also [helloWorld]. @ProviderFor(helloWorld) -final helloWorldProvider = AutoDisposeProvider.internal( - helloWorld, - name: r'helloWorldProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef HelloWorldRef = AutoDisposeProviderRef; +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final fn = _createCb ?? helloWorld; + return fn(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index a7cc420dc..61dcc5f0e 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -8,19 +8,65 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +typedef HelloWorldRef = Ref; -/// See also [helloWorld]. @ProviderFor(helloWorld) -final helloWorldProvider = AutoDisposeProvider.internal( - helloWorld, - name: r'helloWorldProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef HelloWorldRef = AutoDisposeProviderRef; +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final fn = _createCb ?? helloWorld; + return fn(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart index 3fbfdcf6c..d1b8a01d5 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Todo _$TodoFromJson(Map json) { return _Todo.fromJson(json); diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart index 8783f8ed4..7404f0524 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart @@ -25,20 +25,67 @@ Map _$$TodoImplToJson(_$TodoImpl instance) => // RiverpodGenerator // ************************************************************************** +@ProviderFor(AsyncTodos) +const asyncTodosProvider = AsyncTodosProvider._(); + +final class AsyncTodosProvider + extends $AsyncNotifierProvider> { + const AsyncTodosProvider._( + {super.runNotifierBuildOverride, AsyncTodos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'asyncTodosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final AsyncTodos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$asyncTodosHash(); + + @$internal + @override + AsyncTodos create() => _createCb?.call() ?? AsyncTodos(); + + @$internal + @override + AsyncTodosProvider $copyWithCreate( + AsyncTodos Function() create, + ) { + return AsyncTodosProvider._(create: create); + } + + @$internal + @override + AsyncTodosProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + AsyncTodos, + ) build, + ) { + return AsyncTodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + String _$asyncTodosHash() => r'fd0d7502a1c17b7cedd2350519649dd680fc48cd'; -/// See also [AsyncTodos]. -@ProviderFor(AsyncTodos) -final asyncTodosProvider = - AutoDisposeAsyncNotifierProvider>.internal( - AsyncTodos.new, - name: r'asyncTodosProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$asyncTodosHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$AsyncTodos = AutoDisposeAsyncNotifier>; +abstract class _$AsyncTodos extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart index a2fc72563..0b73d3548 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$Todo { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart index 0abb46e3f..75ff6212e 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Todos) +const todosProvider = TodosProvider._(); + +final class TodosProvider extends $NotifierProvider> { + const TodosProvider._( + {super.runNotifierBuildOverride, Todos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Todos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + Todos create() => _createCb?.call() ?? Todos(); + + @$internal + @override + TodosProvider $copyWithCreate( + Todos Function() create, + ) { + return TodosProvider._(create: create); + } + + @$internal + @override + TodosProvider $copyWithBuild( + List Function( + Ref>, + Todos, + ) build, + ) { + return TodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$todosHash() => r'3485c14ec4db07efe5fe52243258a66e6f99b2b4'; -/// See also [Todos]. -@ProviderFor(Todos) -final todosProvider = AutoDisposeNotifierProvider>.internal( - Todos.new, - name: r'todosProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$todosHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Todos = AutoDisposeNotifier>; +abstract class _$Todos extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 7bb0e49dc..86fce98be 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -8,197 +8,129 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$fetchUserHash() => r'ff427bbb4130a8a6994fa623ae70997f7b0f6bdb'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); +typedef FetchUserRef = Ref>; - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [fetchUser]. @ProviderFor(fetchUser) -const fetchUserProvider = FetchUserFamily(); - -/// See also [fetchUser]. -class FetchUserFamily extends Family { - /// See also [fetchUser]. - const FetchUserFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; +const fetchUserProvider = FetchUserFamily._(); + +final class FetchUserProvider + extends $FunctionalProvider, FutureOr, FetchUserRef> + with $FutureModifier, $FutureProvider { + const FetchUserProvider._( + {required FetchUserFamily super.from, + required int super.argument, + FutureOr Function( + FetchUserRef ref, { + required int userId, + })? create}) + : _createCb = create, + super( + name: r'fetchUserProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get dependencies => _dependencies; + final FutureOr Function( + FetchUserRef ref, { + required int userId, + })? _createCb; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$fetchUserHash(); @override - String? get name => r'fetchUserProvider'; - - /// See also [fetchUser]. - FetchUserProvider call({ - required int userId, - }) { - return FetchUserProvider( - userId: userId, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(FutureOr Function(FetchUserRef ref) create) { - return _$FetchUserFamilyOverride(this, create); + String toString() { + return r'fetchUserProvider' + '' + '($argument)'; } @override - String toString() => 'fetchUserProvider'; -} + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); -class _$FetchUserFamilyOverride implements $FamilyOverride { - _$FetchUserFamilyOverride(this.from, this.create); - - final FutureOr Function(FetchUserRef ref) create; + @override + FetchUserProvider $copyWithCreate( + FutureOr Function( + FetchUserRef ref, + ) create, + ) { + return FetchUserProvider._( + argument: argument as int, + from: from! as FetchUserFamily, + create: ( + ref, { + required int userId, + }) => + create(ref)); + } @override - final FetchUserFamily from; + FutureOr create(FetchUserRef ref) { + final fn = _createCb ?? fetchUser; + final int argument = this.argument as int; + return fn( + ref, + userId: argument, + ); + } @override - _FetchUserProviderElement createElement( - ProviderContainer container, - covariant FetchUserProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is FetchUserProvider && other.argument == argument; } @override - String toString() => 'fetchUserProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [fetchUser]. -class FetchUserProvider extends AutoDisposeFutureProvider { - /// See also [fetchUser]. - FetchUserProvider({ - required int userId, - }) : this._internal( - (ref) => fetchUser( - ref as FetchUserRef, - userId: userId, - ), - from: fetchUserProvider, +String _$fetchUserHash() => r'ff427bbb4130a8a6994fa623ae70997f7b0f6bdb'; + +final class FetchUserFamily extends Family { + const FetchUserFamily._() + : super( name: r'fetchUserProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$fetchUserHash, dependencies: null, allTransitiveDependencies: null, - userId: userId, + isAutoDispose: true, ); - FetchUserProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.userId, - }) : super.internal(); - - final int userId; - - @override - Override overrideWith( - FutureOr Function(FetchUserRef ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: FetchUserProvider._internal( - (ref) => create(ref as FetchUserRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - userId: userId, - ), - ); - } + FetchUserProvider call({ + required int userId, + }) => + FetchUserProvider._(argument: userId, from: this); @override - ({ - int userId, - }) get argument { - return (userId: userId,); - } + String debugGetCreateSourceHash() => _$fetchUserHash(); @override - _FetchUserProviderElement createElement( - ProviderContainer container, - ) { - return _FetchUserProviderElement(this, container); - } + String toString() => r'fetchUserProvider'; - FetchUserProvider _copyWith( - FutureOr Function(FetchUserRef ref) create, + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr Function( + FetchUserRef ref, + int args, + ) create, ) { - return FetchUserProvider._internal( - (ref) => create(ref as FetchUserRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - userId: userId, - ); - } - - @override - bool operator ==(Object other) { - return other is FetchUserProvider && other.userId == userId; - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FetchUserProvider; - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, userId.hashCode); + final argument = provider.argument as int; - return _SystemHash.finish(hash); + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'fetchUserProvider$argument'; -} - -mixin FetchUserRef on AutoDisposeFutureProviderRef { - /// The parameter `userId` of this provider. - int get userId; } -class _FetchUserProviderElement extends AutoDisposeFutureProviderElement - with FetchUserRef { - _FetchUserProviderElement(super.provider, super.container); - - @override - int get userId => (origin as FetchUserProvider).userId; -} +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index a7cc420dc..61dcc5f0e 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -8,19 +8,65 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +typedef HelloWorldRef = Ref; -/// See also [helloWorld]. @ProviderFor(helloWorld) -final helloWorldProvider = AutoDisposeProvider.internal( - helloWorld, - name: r'helloWorldProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef HelloWorldRef = AutoDisposeProviderRef; +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final fn = _createCb ?? helloWorld; + return fn(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index a7cc420dc..61dcc5f0e 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -8,19 +8,65 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +typedef HelloWorldRef = Ref; -/// See also [helloWorld]. @ProviderFor(helloWorld) -final helloWorldProvider = AutoDisposeProvider.internal( - helloWorld, - name: r'helloWorldProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef HelloWorldRef = AutoDisposeProviderRef; +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final fn = _createCb ?? helloWorld; + return fn(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 7bb0e49dc..86fce98be 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -8,197 +8,129 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$fetchUserHash() => r'ff427bbb4130a8a6994fa623ae70997f7b0f6bdb'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); +typedef FetchUserRef = Ref>; - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [fetchUser]. @ProviderFor(fetchUser) -const fetchUserProvider = FetchUserFamily(); - -/// See also [fetchUser]. -class FetchUserFamily extends Family { - /// See also [fetchUser]. - const FetchUserFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; +const fetchUserProvider = FetchUserFamily._(); + +final class FetchUserProvider + extends $FunctionalProvider, FutureOr, FetchUserRef> + with $FutureModifier, $FutureProvider { + const FetchUserProvider._( + {required FetchUserFamily super.from, + required int super.argument, + FutureOr Function( + FetchUserRef ref, { + required int userId, + })? create}) + : _createCb = create, + super( + name: r'fetchUserProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get dependencies => _dependencies; + final FutureOr Function( + FetchUserRef ref, { + required int userId, + })? _createCb; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$fetchUserHash(); @override - String? get name => r'fetchUserProvider'; - - /// See also [fetchUser]. - FetchUserProvider call({ - required int userId, - }) { - return FetchUserProvider( - userId: userId, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(FutureOr Function(FetchUserRef ref) create) { - return _$FetchUserFamilyOverride(this, create); + String toString() { + return r'fetchUserProvider' + '' + '($argument)'; } @override - String toString() => 'fetchUserProvider'; -} + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); -class _$FetchUserFamilyOverride implements $FamilyOverride { - _$FetchUserFamilyOverride(this.from, this.create); - - final FutureOr Function(FetchUserRef ref) create; + @override + FetchUserProvider $copyWithCreate( + FutureOr Function( + FetchUserRef ref, + ) create, + ) { + return FetchUserProvider._( + argument: argument as int, + from: from! as FetchUserFamily, + create: ( + ref, { + required int userId, + }) => + create(ref)); + } @override - final FetchUserFamily from; + FutureOr create(FetchUserRef ref) { + final fn = _createCb ?? fetchUser; + final int argument = this.argument as int; + return fn( + ref, + userId: argument, + ); + } @override - _FetchUserProviderElement createElement( - ProviderContainer container, - covariant FetchUserProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is FetchUserProvider && other.argument == argument; } @override - String toString() => 'fetchUserProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [fetchUser]. -class FetchUserProvider extends AutoDisposeFutureProvider { - /// See also [fetchUser]. - FetchUserProvider({ - required int userId, - }) : this._internal( - (ref) => fetchUser( - ref as FetchUserRef, - userId: userId, - ), - from: fetchUserProvider, +String _$fetchUserHash() => r'ff427bbb4130a8a6994fa623ae70997f7b0f6bdb'; + +final class FetchUserFamily extends Family { + const FetchUserFamily._() + : super( name: r'fetchUserProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$fetchUserHash, dependencies: null, allTransitiveDependencies: null, - userId: userId, + isAutoDispose: true, ); - FetchUserProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.userId, - }) : super.internal(); - - final int userId; - - @override - Override overrideWith( - FutureOr Function(FetchUserRef ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: FetchUserProvider._internal( - (ref) => create(ref as FetchUserRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - userId: userId, - ), - ); - } + FetchUserProvider call({ + required int userId, + }) => + FetchUserProvider._(argument: userId, from: this); @override - ({ - int userId, - }) get argument { - return (userId: userId,); - } + String debugGetCreateSourceHash() => _$fetchUserHash(); @override - _FetchUserProviderElement createElement( - ProviderContainer container, - ) { - return _FetchUserProviderElement(this, container); - } + String toString() => r'fetchUserProvider'; - FetchUserProvider _copyWith( - FutureOr Function(FetchUserRef ref) create, + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr Function( + FetchUserRef ref, + int args, + ) create, ) { - return FetchUserProvider._internal( - (ref) => create(ref as FetchUserRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - userId: userId, - ); - } - - @override - bool operator ==(Object other) { - return other is FetchUserProvider && other.userId == userId; - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FetchUserProvider; - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, userId.hashCode); + final argument = provider.argument as int; - return _SystemHash.finish(hash); + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'fetchUserProvider$argument'; -} - -mixin FetchUserRef on AutoDisposeFutureProviderRef { - /// The parameter `userId` of this provider. - int get userId; } -class _FetchUserProviderElement extends AutoDisposeFutureProviderElement - with FetchUserRef { - _FetchUserProviderElement(super.provider, super.container); - - @override - int get userId => (origin as FetchUserProvider).userId; -} +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index a7cc420dc..61dcc5f0e 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -8,19 +8,65 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +typedef HelloWorldRef = Ref; -/// See also [helloWorld]. @ProviderFor(helloWorld) -final helloWorldProvider = AutoDisposeProvider.internal( - helloWorld, - name: r'helloWorldProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef HelloWorldRef = AutoDisposeProviderRef; +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final fn = _createCb ?? helloWorld; + return fn(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index a7cc420dc..61dcc5f0e 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -8,19 +8,65 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +typedef HelloWorldRef = Ref; -/// See also [helloWorld]. @ProviderFor(helloWorld) -final helloWorldProvider = AutoDisposeProvider.internal( - helloWorld, - name: r'helloWorldProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef HelloWorldRef = AutoDisposeProviderRef; +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final fn = _createCb ?? helloWorld; + return fn(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart index ce4740543..7af35b388 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart @@ -8,22 +8,63 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +typedef FetchConfigurationRef = Ref>; + +@ProviderFor(fetchConfiguration) +const fetchConfigurationProvider = FetchConfigurationProvider._(); + +final class FetchConfigurationProvider extends $FunctionalProvider< + AsyncValue, + FutureOr, + FetchConfigurationRef> + with + $FutureModifier, + $FutureProvider { + const FetchConfigurationProvider._( + {FutureOr Function( + FetchConfigurationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'fetchConfigurationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + FetchConfigurationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$fetchConfigurationHash(); + + @override + $FutureProviderElement createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + FetchConfigurationProvider $copyWithCreate( + FutureOr Function( + FetchConfigurationRef ref, + ) create, + ) { + return FetchConfigurationProvider._(create: create); + } + + @override + FutureOr create(FetchConfigurationRef ref) { + final fn = _createCb ?? fetchConfiguration; + return fn(ref); + } +} + String _$fetchConfigurationHash() => r'6c0f062e6f20baf883c4282856f1197fbe633d89'; -/// See also [fetchConfiguration]. -@ProviderFor(fetchConfiguration) -final fetchConfigurationProvider = - AutoDisposeFutureProvider.internal( - fetchConfiguration, - name: r'fetchConfigurationProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$fetchConfigurationHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef FetchConfigurationRef = AutoDisposeFutureProviderRef; +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 7bb0e49dc..86fce98be 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -8,197 +8,129 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$fetchUserHash() => r'ff427bbb4130a8a6994fa623ae70997f7b0f6bdb'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); +typedef FetchUserRef = Ref>; - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} - -/// See also [fetchUser]. @ProviderFor(fetchUser) -const fetchUserProvider = FetchUserFamily(); - -/// See also [fetchUser]. -class FetchUserFamily extends Family { - /// See also [fetchUser]. - const FetchUserFamily(); - - static const Iterable? _dependencies = null; - - static const Iterable? _allTransitiveDependencies = null; +const fetchUserProvider = FetchUserFamily._(); + +final class FetchUserProvider + extends $FunctionalProvider, FutureOr, FetchUserRef> + with $FutureModifier, $FutureProvider { + const FetchUserProvider._( + {required FetchUserFamily super.from, + required int super.argument, + FutureOr Function( + FetchUserRef ref, { + required int userId, + })? create}) + : _createCb = create, + super( + name: r'fetchUserProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - @override - Iterable? get dependencies => _dependencies; + final FutureOr Function( + FetchUserRef ref, { + required int userId, + })? _createCb; @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + String debugGetCreateSourceHash() => _$fetchUserHash(); @override - String? get name => r'fetchUserProvider'; - - /// See also [fetchUser]. - FetchUserProvider call({ - required int userId, - }) { - return FetchUserProvider( - userId: userId, - ); - } - - /// Enables overriding the behavior of this provider, no matter the parameters. - Override overrideWith(FutureOr Function(FetchUserRef ref) create) { - return _$FetchUserFamilyOverride(this, create); + String toString() { + return r'fetchUserProvider' + '' + '($argument)'; } @override - String toString() => 'fetchUserProvider'; -} + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); -class _$FetchUserFamilyOverride implements $FamilyOverride { - _$FetchUserFamilyOverride(this.from, this.create); - - final FutureOr Function(FetchUserRef ref) create; + @override + FetchUserProvider $copyWithCreate( + FutureOr Function( + FetchUserRef ref, + ) create, + ) { + return FetchUserProvider._( + argument: argument as int, + from: from! as FetchUserFamily, + create: ( + ref, { + required int userId, + }) => + create(ref)); + } @override - final FetchUserFamily from; + FutureOr create(FetchUserRef ref) { + final fn = _createCb ?? fetchUser; + final int argument = this.argument as int; + return fn( + ref, + userId: argument, + ); + } @override - _FetchUserProviderElement createElement( - ProviderContainer container, - covariant FetchUserProvider provider, - ) { - return provider._copyWith(create).createElement(container); + bool operator ==(Object other) { + return other is FetchUserProvider && other.argument == argument; } @override - String toString() => 'fetchUserProvider.overrideWith(...)'; + int get hashCode { + return argument.hashCode; + } } -/// See also [fetchUser]. -class FetchUserProvider extends AutoDisposeFutureProvider { - /// See also [fetchUser]. - FetchUserProvider({ - required int userId, - }) : this._internal( - (ref) => fetchUser( - ref as FetchUserRef, - userId: userId, - ), - from: fetchUserProvider, +String _$fetchUserHash() => r'ff427bbb4130a8a6994fa623ae70997f7b0f6bdb'; + +final class FetchUserFamily extends Family { + const FetchUserFamily._() + : super( name: r'fetchUserProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$fetchUserHash, dependencies: null, allTransitiveDependencies: null, - userId: userId, + isAutoDispose: true, ); - FetchUserProvider._internal( - super.create, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.userId, - }) : super.internal(); - - final int userId; - - @override - Override overrideWith( - FutureOr Function(FetchUserRef ref) create, - ) { - return $ProviderOverride( - origin: this, - providerOverride: FetchUserProvider._internal( - (ref) => create(ref as FetchUserRef), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - userId: userId, - ), - ); - } + FetchUserProvider call({ + required int userId, + }) => + FetchUserProvider._(argument: userId, from: this); @override - ({ - int userId, - }) get argument { - return (userId: userId,); - } + String debugGetCreateSourceHash() => _$fetchUserHash(); @override - _FetchUserProviderElement createElement( - ProviderContainer container, - ) { - return _FetchUserProviderElement(this, container); - } + String toString() => r'fetchUserProvider'; - FetchUserProvider _copyWith( - FutureOr Function(FetchUserRef ref) create, + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr Function( + FetchUserRef ref, + int args, + ) create, ) { - return FetchUserProvider._internal( - (ref) => create(ref as FetchUserRef), - name: name, - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, - debugGetCreateSourceHash: debugGetCreateSourceHash, - from: from, - userId: userId, - ); - } - - @override - bool operator ==(Object other) { - return other is FetchUserProvider && other.userId == userId; - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FetchUserProvider; - @override - int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, userId.hashCode); + final argument = provider.argument as int; - return _SystemHash.finish(hash); + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); } - - @override - String toString() => 'fetchUserProvider$argument'; -} - -mixin FetchUserRef on AutoDisposeFutureProviderRef { - /// The parameter `userId` of this provider. - int get userId; } -class _FetchUserProviderElement extends AutoDisposeFutureProviderElement - with FetchUserRef { - _FetchUserProviderElement(super.provider, super.container); - - @override - int get userId => (origin as FetchUserProvider).userId; -} +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart index 29ee85fa1..acc03feaa 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart @@ -8,19 +8,57 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$exampleHash() => r'e2c4eb8a7cf06c7a0e5d07ee2bd51db254033fa6'; +typedef ExampleRef = Ref>; -/// See also [example]. @ProviderFor(example) -final exampleProvider = AutoDisposeStreamProvider.internal( - example, - name: r'exampleProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ExampleRef = AutoDisposeStreamProviderRef; +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider, Stream, ExampleRef> + with $FutureModifier, $StreamProvider { + const ExampleProvider._( + {Stream Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + Stream Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + Stream create(ExampleRef ref) { + final fn = _createCb ?? example; + return fn(ref); + } +} + +String _$exampleHash() => r'e2c4eb8a7cf06c7a0e5d07ee2bd51db254033fa6'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart index d892e8ba8..4b69a56e1 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterHash() => r'6bd7806869af024b3288645da03c077af9478083'; -/// See also [Counter]. -@ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart index 60b68adf7..dfc6e7497 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart @@ -8,19 +8,64 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$anotherHash() => r'2208f9221f3d898305609874d4f43c28bdfff2b4'; +typedef AnotherRef = Ref; -/// See also [another]. @ProviderFor(another) -final anotherProvider = AutoDisposeProvider.internal( - another, - name: r'anotherProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$anotherHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef AnotherRef = AutoDisposeProviderRef; +const anotherProvider = AnotherProvider._(); + +final class AnotherProvider extends $FunctionalProvider + with $Provider { + const AnotherProvider._( + {void Function( + AnotherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'anotherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final void Function( + AnotherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$anotherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(void value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + AnotherProvider $copyWithCreate( + void Function( + AnotherRef ref, + ) create, + ) { + return AnotherProvider._(create: create); + } + + @override + void create(AnotherRef ref) { + final fn = _createCb ?? another; + return fn(ref); + } +} + +String _$anotherHash() => r'2208f9221f3d898305609874d4f43c28bdfff2b4'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart index 1e834cdbe..f59d40e8f 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterHash() => r'4320f811608c7a6e7342b83e3031965a34f7cb8e'; -/// See also [Counter]. -@ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart index 0e7d74954..fee467e75 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart @@ -8,33 +8,123 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$repositoryHash() => r'c6dc3b5b727028966b5b850b27ffc7294b485273'; +typedef RepositoryRef = Ref; -/// See also [repository]. @ProviderFor(repository) -final repositoryProvider = AutoDisposeProvider.internal( - repository, - name: r'repositoryProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$repositoryHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef RepositoryRef = AutoDisposeProviderRef; -String _$valueHash() => r'8c26f7aaa911af815cff9e513a18e4d8dcc6d1df'; +const repositoryProvider = RepositoryProvider._(); + +final class RepositoryProvider + extends $FunctionalProvider + with $Provider { + const RepositoryProvider._( + {Repository Function( + RepositoryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'repositoryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Repository Function( + RepositoryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$repositoryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Repository value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RepositoryProvider $copyWithCreate( + Repository Function( + RepositoryRef ref, + ) create, + ) { + return RepositoryProvider._(create: create); + } + + @override + Repository create(RepositoryRef ref) { + final fn = _createCb ?? repository; + return fn(ref); + } +} + +String _$repositoryHash() => r'c6dc3b5b727028966b5b850b27ffc7294b485273'; + +typedef ValueRef = Ref; -/// See also [value]. @ProviderFor(value) -final valueProvider = AutoDisposeProvider.internal( - value, - name: r'valueProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$valueHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ValueRef = AutoDisposeProviderRef; +const valueProvider = ValueProvider._(); + +final class ValueProvider extends $FunctionalProvider + with $Provider { + const ValueProvider._( + {String Function( + ValueRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'valueProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + ValueRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$valueHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ValueProvider $copyWithCreate( + String Function( + ValueRef ref, + ) create, + ) { + return ValueProvider._(create: create); + } + + @override + String create(ValueRef ref) { + final fn = _createCb ?? value; + return fn(ref); + } +} + +String _$valueHash() => r'8c26f7aaa911af815cff9e513a18e4d8dcc6d1df'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart index 041865b99..090ded96f 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; -/// See also [Counter]. -@ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart index 041865b99..090ded96f 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; -/// See also [Counter]. -@ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart index 041865b99..090ded96f 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; -/// See also [Counter]. -@ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart index 8221391a4..5b7deccb5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart @@ -8,48 +8,192 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$filterTypeHash() => r'42b68b163daecff7a0b9b069b16025a89910b4fb'; +typedef FilterTypeRef = Ref; -/// See also [filterType]. @ProviderFor(filterType) -final filterTypeProvider = AutoDisposeProvider.internal( - filterType, - name: r'filterTypeProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$filterTypeHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef FilterTypeRef = AutoDisposeProviderRef; -String _$filteredTodoListHash() => r'34f1e929a9e7850946ea8634d9f3e8f38ae5687d'; +const filterTypeProvider = FilterTypeProvider._(); + +final class FilterTypeProvider + extends $FunctionalProvider + with $Provider { + const FilterTypeProvider._( + {FilterType Function( + FilterTypeRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filterTypeProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FilterType Function( + FilterTypeRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filterTypeHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(FilterType value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilterTypeProvider $copyWithCreate( + FilterType Function( + FilterTypeRef ref, + ) create, + ) { + return FilterTypeProvider._(create: create); + } + + @override + FilterType create(FilterTypeRef ref) { + final fn = _createCb ?? filterType; + return fn(ref); + } +} + +String _$filterTypeHash() => r'42b68b163daecff7a0b9b069b16025a89910b4fb'; + +typedef FilteredTodoListRef = Ref>; -/// See also [filteredTodoList]. @ProviderFor(filteredTodoList) -final filteredTodoListProvider = AutoDisposeProvider>.internal( - filteredTodoList, - name: r'filteredTodoListProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$filteredTodoListHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef FilteredTodoListRef = AutoDisposeProviderRef>; -String _$todosHash() => r'b66ac2b1e5cf7ac7957d25864cfdffad1af233a6'; +const filteredTodoListProvider = FilteredTodoListProvider._(); + +final class FilteredTodoListProvider + extends $FunctionalProvider, List, FilteredTodoListRef> + with $Provider, FilteredTodoListRef> { + const FilteredTodoListProvider._( + {List Function( + FilteredTodoListRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filteredTodoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + FilteredTodoListRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filteredTodoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @override + $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilteredTodoListProvider $copyWithCreate( + List Function( + FilteredTodoListRef ref, + ) create, + ) { + return FilteredTodoListProvider._(create: create); + } + + @override + List create(FilteredTodoListRef ref) { + final fn = _createCb ?? filteredTodoList; + return fn(ref); + } +} + +String _$filteredTodoListHash() => r'34f1e929a9e7850946ea8634d9f3e8f38ae5687d'; -/// See also [Todos]. @ProviderFor(Todos) -final todosProvider = AutoDisposeNotifierProvider>.internal( - Todos.new, - name: r'todosProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$todosHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Todos = AutoDisposeNotifier>; +const todosProvider = TodosProvider._(); + +final class TodosProvider extends $NotifierProvider> { + const TodosProvider._( + {super.runNotifierBuildOverride, Todos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Todos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + Todos create() => _createCb?.call() ?? Todos(); + + @$internal + @override + TodosProvider $copyWithCreate( + Todos Function() create, + ) { + return TodosProvider._(create: create); + } + + @$internal + @override + TodosProvider $copyWithBuild( + List Function( + Ref>, + Todos, + ) build, + ) { + return TodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todosHash() => r'b66ac2b1e5cf7ac7957d25864cfdffad1af233a6'; + +abstract class _$Todos extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart index 347684842..dcc5cec2c 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart @@ -8,34 +8,132 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; +typedef CounterRef = Ref; -/// See also [counter]. @ProviderFor(counter) -final counterProvider = AutoDisposeProvider.internal( - counter, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CounterRef = AutoDisposeProviderRef; -String _$todoListHash() => r'77f007cd4f5105330a4c2ab8555ea0d1716945c1'; +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $FunctionalProvider + with $Provider { + const CounterProvider._( + {int Function( + CounterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CounterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CounterProvider $copyWithCreate( + int Function( + CounterRef ref, + ) create, + ) { + return CounterProvider._(create: create); + } + + @override + int create(CounterRef ref) { + final fn = _createCb ?? counter; + return fn(ref); + } +} + +String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; -/// See also [TodoList]. @ProviderFor(TodoList) -final todoListProvider = - AutoDisposeNotifierProvider>.internal( - TodoList.new, - name: r'todoListProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$TodoList = AutoDisposeNotifier>; +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider extends $NotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + List Function( + Ref>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todoListHash() => r'77f007cd4f5105330a4c2ab8555ea0d1716945c1'; + +abstract class _$TodoList extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart index 041865b99..090ded96f 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; -/// See also [Counter]. -@ProviderFor(Counter) -final counterProvider = AutoDisposeNotifierProvider.internal( - Counter.new, - name: r'counterProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Counter = AutoDisposeNotifier; +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index a7cc420dc..61dcc5f0e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -8,19 +8,65 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +typedef HelloWorldRef = Ref; -/// See also [helloWorld]. @ProviderFor(helloWorld) -final helloWorldProvider = AutoDisposeProvider.internal( - helloWorld, - name: r'helloWorldProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef HelloWorldRef = AutoDisposeProviderRef; +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final fn = _createCb ?? helloWorld; + return fn(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index a7cc420dc..61dcc5f0e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -8,19 +8,65 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +typedef HelloWorldRef = Ref; -/// See also [helloWorld]. @ProviderFor(helloWorld) -final helloWorldProvider = AutoDisposeProvider.internal( - helloWorld, - name: r'helloWorldProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef HelloWorldRef = AutoDisposeProviderRef; +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final fn = _createCb ?? helloWorld; + return fn(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart index e44b1758b..c6f7ac8eb 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart @@ -8,19 +8,65 @@ part of 'main_hooks.dart'; // RiverpodGenerator // ************************************************************************** -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +typedef HelloWorldRef = Ref; -/// See also [helloWorld]. @ProviderFor(helloWorld) -final helloWorldProvider = AutoDisposeProvider.internal( - helloWorld, - name: r'helloWorldProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef HelloWorldRef = AutoDisposeProviderRef; +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final fn = _createCb ?? helloWorld; + return fn(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart index ce4740543..7af35b388 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart @@ -8,22 +8,63 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +typedef FetchConfigurationRef = Ref>; + +@ProviderFor(fetchConfiguration) +const fetchConfigurationProvider = FetchConfigurationProvider._(); + +final class FetchConfigurationProvider extends $FunctionalProvider< + AsyncValue, + FutureOr, + FetchConfigurationRef> + with + $FutureModifier, + $FutureProvider { + const FetchConfigurationProvider._( + {FutureOr Function( + FetchConfigurationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'fetchConfigurationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + FetchConfigurationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$fetchConfigurationHash(); + + @override + $FutureProviderElement createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + FetchConfigurationProvider $copyWithCreate( + FutureOr Function( + FetchConfigurationRef ref, + ) create, + ) { + return FetchConfigurationProvider._(create: create); + } + + @override + FutureOr create(FetchConfigurationRef ref) { + final fn = _createCb ?? fetchConfiguration; + return fn(ref); + } +} + String _$fetchConfigurationHash() => r'6c0f062e6f20baf883c4282856f1197fbe633d89'; -/// See also [fetchConfiguration]. -@ProviderFor(fetchConfiguration) -final fetchConfigurationProvider = - AutoDisposeFutureProvider.internal( - fetchConfiguration, - name: r'fetchConfigurationProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$fetchConfigurationHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef FetchConfigurationRef = AutoDisposeFutureProviderRef; +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart index 3fbfdcf6c..d1b8a01d5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Todo _$TodoFromJson(Map json) { return _Todo.fromJson(json); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart index 8783f8ed4..7404f0524 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart @@ -25,20 +25,67 @@ Map _$$TodoImplToJson(_$TodoImpl instance) => // RiverpodGenerator // ************************************************************************** +@ProviderFor(AsyncTodos) +const asyncTodosProvider = AsyncTodosProvider._(); + +final class AsyncTodosProvider + extends $AsyncNotifierProvider> { + const AsyncTodosProvider._( + {super.runNotifierBuildOverride, AsyncTodos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'asyncTodosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final AsyncTodos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$asyncTodosHash(); + + @$internal + @override + AsyncTodos create() => _createCb?.call() ?? AsyncTodos(); + + @$internal + @override + AsyncTodosProvider $copyWithCreate( + AsyncTodos Function() create, + ) { + return AsyncTodosProvider._(create: create); + } + + @$internal + @override + AsyncTodosProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + AsyncTodos, + ) build, + ) { + return AsyncTodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + String _$asyncTodosHash() => r'fd0d7502a1c17b7cedd2350519649dd680fc48cd'; -/// See also [AsyncTodos]. -@ProviderFor(AsyncTodos) -final asyncTodosProvider = - AutoDisposeAsyncNotifierProvider>.internal( - AsyncTodos.new, - name: r'asyncTodosProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$asyncTodosHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$AsyncTodos = AutoDisposeAsyncNotifier>; +abstract class _$AsyncTodos extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart index a2fc72563..0b73d3548 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$Todo { diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart index 0abb46e3f..75ff6212e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart @@ -8,19 +8,74 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Todos) +const todosProvider = TodosProvider._(); + +final class TodosProvider extends $NotifierProvider> { + const TodosProvider._( + {super.runNotifierBuildOverride, Todos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Todos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + Todos create() => _createCb?.call() ?? Todos(); + + @$internal + @override + TodosProvider $copyWithCreate( + Todos Function() create, + ) { + return TodosProvider._(create: create); + } + + @$internal + @override + TodosProvider $copyWithBuild( + List Function( + Ref>, + Todos, + ) build, + ) { + return TodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$todosHash() => r'3485c14ec4db07efe5fe52243258a66e6f99b2b4'; -/// See also [Todos]. -@ProviderFor(Todos) -final todosProvider = AutoDisposeNotifierProvider>.internal( - Todos.new, - name: r'todosProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$todosHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Todos = AutoDisposeNotifier>; +abstract class _$Todos extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart index be2ec7731..2323ad997 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart @@ -8,20 +8,65 @@ part of 'completed_todos.dart'; // RiverpodGenerator // ************************************************************************** -String _$completedTodosHash() => r'855706c09268f428696b3b382ae1605818361b83'; +typedef CompletedTodosRef = Ref>; -/// See also [completedTodos]. @ProviderFor(completedTodos) -final completedTodosProvider = AutoDisposeProvider>.internal( - completedTodos, - name: r'completedTodosProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$completedTodosHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CompletedTodosRef = AutoDisposeProviderRef>; +const completedTodosProvider = CompletedTodosProvider._(); + +final class CompletedTodosProvider + extends $FunctionalProvider, List, CompletedTodosRef> + with $Provider, CompletedTodosRef> { + const CompletedTodosProvider._( + {List Function( + CompletedTodosRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'completedTodosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + CompletedTodosRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$completedTodosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @override + $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CompletedTodosProvider $copyWithCreate( + List Function( + CompletedTodosRef ref, + ) create, + ) { + return CompletedTodosProvider._(create: create); + } + + @override + List create(CompletedTodosRef ref) { + final fn = _createCb ?? completedTodos; + return fn(ref); + } +} + +String _$completedTodosHash() => r'855706c09268f428696b3b382ae1605818361b83'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index 096a056f2..63b0464de 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -8,35 +8,134 @@ part of 'optimized_previous_button.dart'; // RiverpodGenerator // ************************************************************************** +typedef CanGoToPreviousPageRef = Ref; + +@ProviderFor(canGoToPreviousPage) +const canGoToPreviousPageProvider = CanGoToPreviousPageProvider._(); + +final class CanGoToPreviousPageProvider + extends $FunctionalProvider + with $Provider { + const CanGoToPreviousPageProvider._( + {bool Function( + CanGoToPreviousPageRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'canGoToPreviousPageProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final bool Function( + CanGoToPreviousPageRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$canGoToPreviousPageHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(bool value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CanGoToPreviousPageProvider $copyWithCreate( + bool Function( + CanGoToPreviousPageRef ref, + ) create, + ) { + return CanGoToPreviousPageProvider._(create: create); + } + + @override + bool create(CanGoToPreviousPageRef ref) { + final fn = _createCb ?? canGoToPreviousPage; + return fn(ref); + } +} + String _$canGoToPreviousPageHash() => r'801fe8182a37cd21ae83bdfccbe36c125b4d14fb'; -/// See also [canGoToPreviousPage]. -@ProviderFor(canGoToPreviousPage) -final canGoToPreviousPageProvider = AutoDisposeProvider.internal( - canGoToPreviousPage, - name: r'canGoToPreviousPageProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$canGoToPreviousPageHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef CanGoToPreviousPageRef = AutoDisposeProviderRef; +@ProviderFor(PageIndex) +const pageIndexProvider = PageIndexProvider._(); + +final class PageIndexProvider extends $NotifierProvider { + const PageIndexProvider._( + {super.runNotifierBuildOverride, PageIndex Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'pageIndexProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final PageIndex Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$pageIndexHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + PageIndex create() => _createCb?.call() ?? PageIndex(); + + @$internal + @override + PageIndexProvider $copyWithCreate( + PageIndex Function() create, + ) { + return PageIndexProvider._(create: create); + } + + @$internal + @override + PageIndexProvider $copyWithBuild( + int Function( + Ref, + PageIndex, + ) build, + ) { + return PageIndexProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$pageIndexHash() => r'59307ecf23b5b2432833da5ad6b312bf36435d0e'; -/// See also [PageIndex]. -@ProviderFor(PageIndex) -final pageIndexProvider = AutoDisposeNotifierProvider.internal( - PageIndex.new, - name: r'pageIndexProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$pageIndexHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$PageIndex = AutoDisposeNotifier; +abstract class _$PageIndex extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart index 0b4a0a56d..3d278dd0e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart @@ -8,19 +8,74 @@ part of 'todo.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Todos) +const todosProvider = TodosProvider._(); + +final class TodosProvider extends $NotifierProvider> { + const TodosProvider._( + {super.runNotifierBuildOverride, Todos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Todos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + Todos create() => _createCb?.call() ?? Todos(); + + @$internal + @override + TodosProvider $copyWithCreate( + Todos Function() create, + ) { + return TodosProvider._(create: create); + } + + @$internal + @override + TodosProvider $copyWithBuild( + List Function( + Ref>, + Todos, + ) build, + ) { + return TodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$todosHash() => r'4bd25c3c15bfff56ad6e733bd17ecb7284c4ceb2'; -/// See also [Todos]. -@ProviderFor(Todos) -final todosProvider = AutoDisposeNotifierProvider>.internal( - Todos.new, - name: r'todosProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$todosHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Todos = AutoDisposeNotifier>; +abstract class _$Todos extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart index e02ece976..e82d88b84 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -8,19 +8,74 @@ part of 'unoptimized_previous_button.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(PageIndex) +const pageIndexProvider = PageIndexProvider._(); + +final class PageIndexProvider extends $NotifierProvider { + const PageIndexProvider._( + {super.runNotifierBuildOverride, PageIndex Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'pageIndexProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final PageIndex Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$pageIndexHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + PageIndex create() => _createCb?.call() ?? PageIndex(); + + @$internal + @override + PageIndexProvider $copyWithCreate( + PageIndex Function() create, + ) { + return PageIndexProvider._(create: create); + } + + @$internal + @override + PageIndexProvider $copyWithBuild( + int Function( + Ref, + PageIndex, + ) build, + ) { + return PageIndexProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$pageIndexHash() => r'59307ecf23b5b2432833da5ad6b312bf36435d0e'; -/// See also [PageIndex]. -@ProviderFor(PageIndex) -final pageIndexProvider = AutoDisposeNotifierProvider.internal( - PageIndex.new, - name: r'pageIndexProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$pageIndexHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$PageIndex = AutoDisposeNotifier; +abstract class _$PageIndex extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/static/snippets/async.g.dart b/website/static/snippets/async.g.dart index a5b75d791..bd207ff2c 100644 --- a/website/static/snippets/async.g.dart +++ b/website/static/snippets/async.g.dart @@ -8,21 +8,60 @@ part of 'async.dart'; // RiverpodGenerator // ************************************************************************** -String _$configurationsHash() => r'27f534f8b2a22c39b2d28c2414358a228c552155'; +typedef ConfigurationsRef = Ref>; -/// See also [configurations]. @ProviderFor(configurations) -final configurationsProvider = - AutoDisposeFutureProvider.internal( - configurations, - name: r'configurationsProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$configurationsHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef ConfigurationsRef = AutoDisposeFutureProviderRef; +const configurationsProvider = ConfigurationsProvider._(); + +final class ConfigurationsProvider extends $FunctionalProvider< + AsyncValue, FutureOr, ConfigurationsRef> + with + $FutureModifier, + $FutureProvider { + const ConfigurationsProvider._( + {FutureOr Function( + ConfigurationsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'configurationsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ConfigurationsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$configurationsHash(); + + @override + $FutureProviderElement createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ConfigurationsProvider $copyWithCreate( + FutureOr Function( + ConfigurationsRef ref, + ) create, + ) { + return ConfigurationsProvider._(create: create); + } + + @override + FutureOr create(ConfigurationsRef ref) { + final fn = _createCb ?? configurations; + return fn(ref); + } +} + +String _$configurationsHash() => r'27f534f8b2a22c39b2d28c2414358a228c552155'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/static/snippets/combine.g.dart b/website/static/snippets/combine.g.dart index 6e60eb019..4452a8b90 100644 --- a/website/static/snippets/combine.g.dart +++ b/website/static/snippets/combine.g.dart @@ -8,20 +8,65 @@ part of 'combine.dart'; // RiverpodGenerator // ************************************************************************** -String _$filteredTodosHash() => r'bcb1e81823aaf9b967948b619c177ebc571d96a7'; +typedef FilteredTodosRef = Ref>; -/// See also [filteredTodos]. @ProviderFor(filteredTodos) -final filteredTodosProvider = AutoDisposeProvider>.internal( - filteredTodos, - name: r'filteredTodosProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$filteredTodosHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef FilteredTodosRef = AutoDisposeProviderRef>; +const filteredTodosProvider = FilteredTodosProvider._(); + +final class FilteredTodosProvider + extends $FunctionalProvider, List, FilteredTodosRef> + with $Provider, FilteredTodosRef> { + const FilteredTodosProvider._( + {List Function( + FilteredTodosRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filteredTodosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + FilteredTodosRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filteredTodosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @override + $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilteredTodosProvider $copyWithCreate( + List Function( + FilteredTodosRef ref, + ) create, + ) { + return FilteredTodosProvider._(create: create); + } + + @override + List create(FilteredTodosRef ref) { + final fn = _createCb ?? filteredTodos; + return fn(ref); + } +} + +String _$filteredTodosHash() => r'bcb1e81823aaf9b967948b619c177ebc571d96a7'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/static/snippets/create.g.dart b/website/static/snippets/create.g.dart index ad4d118fe..1e935715b 100644 --- a/website/static/snippets/create.g.dart +++ b/website/static/snippets/create.g.dart @@ -8,20 +8,57 @@ part of 'create.dart'; // RiverpodGenerator // ************************************************************************** -String _$boredSuggestionHash() => r'5975efd623c41e5bc92ecd326209e6124cb1736d'; +typedef BoredSuggestionRef = Ref>; -/// See also [boredSuggestion]. @ProviderFor(boredSuggestion) -final boredSuggestionProvider = AutoDisposeFutureProvider.internal( - boredSuggestion, - name: r'boredSuggestionProvider', - debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') - ? null - : _$boredSuggestionHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef BoredSuggestionRef = AutoDisposeFutureProviderRef; +const boredSuggestionProvider = BoredSuggestionProvider._(); + +final class BoredSuggestionProvider extends $FunctionalProvider< + AsyncValue, FutureOr, BoredSuggestionRef> + with $FutureModifier, $FutureProvider { + const BoredSuggestionProvider._( + {FutureOr Function( + BoredSuggestionRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'boredSuggestionProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + BoredSuggestionRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$boredSuggestionHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + BoredSuggestionProvider $copyWithCreate( + FutureOr Function( + BoredSuggestionRef ref, + ) create, + ) { + return BoredSuggestionProvider._(create: create); + } + + @override + FutureOr create(BoredSuggestionRef ref) { + final fn = _createCb ?? boredSuggestion; + return fn(ref); + } +} + +String _$boredSuggestionHash() => r'5975efd623c41e5bc92ecd326209e6124cb1736d'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package diff --git a/website/static/snippets/declare.g.dart b/website/static/snippets/declare.g.dart index d6543db42..8f854411d 100644 --- a/website/static/snippets/declare.g.dart +++ b/website/static/snippets/declare.g.dart @@ -8,19 +8,74 @@ part of 'declare.dart'; // RiverpodGenerator // ************************************************************************** +@ProviderFor(Count) +const countProvider = CountProvider._(); + +final class CountProvider extends $NotifierProvider { + const CountProvider._( + {super.runNotifierBuildOverride, Count Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'countProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Count Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$countHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Count create() => _createCb?.call() ?? Count(); + + @$internal + @override + CountProvider $copyWithCreate( + Count Function() create, + ) { + return CountProvider._(create: create); + } + + @$internal + @override + CountProvider $copyWithBuild( + int Function( + Ref, + Count, + ) build, + ) { + return CountProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + String _$countHash() => r'6fc5f8ad4bbd390899dd0d14c7b902407d4413bd'; -/// See also [Count]. -@ProviderFor(Count) -final countProvider = AutoDisposeNotifierProvider.internal( - Count.new, - name: r'countProvider', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') ? null : _$countHash, - dependencies: null, - allTransitiveDependencies: null, -); - -typedef _$Count = AutoDisposeNotifier; +abstract class _$Count extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package From 177d5d899c8cc0b8ab3cf4dd23ccde37742281bd Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 10:46:47 +0100 Subject: [PATCH 177/387] Fix example --- examples/pub/lib/detail.dart | 2 +- examples/pub/lib/search.dart | 2 +- examples/random_number/lib/main.dart | 1 + examples/todos/lib/main.dart | 5 +++-- 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/examples/pub/lib/detail.dart b/examples/pub/lib/detail.dart index b7717dfa6..7dfa523cd 100644 --- a/examples/pub/lib/detail.dart +++ b/examples/pub/lib/detail.dart @@ -12,7 +12,7 @@ import 'search.dart'; part 'detail.g.dart'; -extension CancelTokenX on Ref { +extension CancelTokenX on Ref { CancelToken cancelToken() { final cancelToken = CancelToken(); onDispose(cancelToken.cancel); diff --git a/examples/pub/lib/search.dart b/examples/pub/lib/search.dart index aedb63c88..eeafba4f1 100644 --- a/examples/pub/lib/search.dart +++ b/examples/pub/lib/search.dart @@ -45,7 +45,7 @@ Future> fetchPackages( return Future.wait([ for (final package in searchedPackages) ref.watch( - FetchPackageDetailsProvider(packageName: package.package).future, + fetchPackageDetailsProvider(packageName: package.package).future, ), ]); } diff --git a/examples/random_number/lib/main.dart b/examples/random_number/lib/main.dart index 05d6efb34..ca2df51af 100644 --- a/examples/random_number/lib/main.dart +++ b/examples/random_number/lib/main.dart @@ -2,6 +2,7 @@ import 'dart:math'; import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; void main() { runApp(const ProviderScope(child: RandomNumberApp())); diff --git a/examples/todos/lib/main.dart b/examples/todos/lib/main.dart index f5568d9b0..e4c71cacd 100644 --- a/examples/todos/lib/main.dart +++ b/examples/todos/lib/main.dart @@ -1,6 +1,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:hooks_riverpod/legacy.dart'; import 'todo.dart'; @@ -10,7 +11,7 @@ final activeFilterKey = UniqueKey(); final completedFilterKey = UniqueKey(); final allFilterKey = UniqueKey(); -/// Creates a [TodoList] and initialise it with pre-defined values. +/// Creates a [TodoList] and initialize it with pre-defined values. /// /// We are using [StateNotifierProvider] here as a `List` is a complex /// object, with advanced business logic like how to edit a todo. @@ -35,7 +36,7 @@ final todoListFilter = StateProvider((_) => TodoListFilter.all); /// Even multiple widgets try to read the number of uncompleted todos, /// the value will be computed only once (until the todo-list changes). /// -/// This will also optimise unneeded rebuilds if the todo-list changes, but the +/// This will also optimize unneeded rebuilds if the todo-list changes, but the /// number of uncompleted todos doesn't (such as when editing a todo). final uncompletedTodosCount = Provider((ref) { return ref.watch(todoListProvider).where((todo) => !todo.completed).length; From deb15998d34c7e4866f441400db08def25b90286 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 11:04:01 +0100 Subject: [PATCH 178/387] Update website --- website/docs/advanced/select/select_async/codegen.dart | 1 + .../case_studies/pull_to_refresh/fetch_activity/raw.dart | 1 + .../non_code_gen/async_notifier_provider.dart | 2 +- .../provider_type/non_code_gen/notifier_provider.dart | 2 +- .../non_code_gen/stream_notifier_provider.dart | 2 +- website/docs/concepts/async_initialization.dart | 1 + .../characters_provider/codegen.dart | 1 + .../characters_provider/raw.dart | 1 + .../filtered_todo_list_provider/codegen.dart | 1 + .../filtered_todo_list_provider/raw.dart | 3 ++- website/docs/concepts/dialog_scope.dart | 1 + website/docs/concepts/provider_observer_logger.dart | 1 + website/docs/concepts/reading/counter/codegen.dart | 1 + website/docs/concepts/reading/counter/raw.dart | 3 ++- website/docs/concepts/reading/listen_build/raw.dart | 4 ++-- .../docs/concepts/reading/listen_build/raw_hooks.dart | 4 ++-- website/docs/concepts/reading/read/raw.dart | 1 + website/docs/concepts/reading/read/raw_hooks.dart | 6 +++--- website/docs/concepts/reading/read_build/raw.dart | 1 + .../docs/concepts/reading/read_notifier_build/raw.dart | 1 + website/docs/concepts/reading/watch/raw.dart | 1 + website/docs/concepts/reading/watch_build/raw.dart | 1 + website/docs/concepts/reading/watch_build/raw_hooks.dart | 3 ++- .../docs/concepts/reading/watch_notifier_build/raw.dart | 1 + website/docs/concepts/subtree_scope.dart | 1 + website/docs/concepts/theme_scope.dart | 1 + website/docs/cookbooks/testing_original_test_dart.dart | 1 + .../docs/cookbooks/testing_original_test_flutter.dart | 1 + .../essentials/auto_dispose/cache_for_extension.dart | 2 +- .../essentials/auto_dispose/cache_for_usage/raw.dart | 1 + website/docs/essentials/auto_dispose/keep_alive/raw.dart | 1 + .../essentials/auto_dispose/on_dispose_example/raw.dart | 1 + .../docs/essentials/auto_dispose/raw_auto_dispose.dart | 1 + .../combining_requests/functional_ref/raw.dart | 1 + .../combining_requests/listen_example/codegen.dart | 1 + .../combining_requests/listen_example/raw.dart | 1 + .../essentials/combining_requests/notifier_ref/raw.dart | 1 + .../combining_requests/read_example/codegen.dart | 1 + .../essentials/combining_requests/read_example/raw.dart | 1 + .../combining_requests/watch_example/codegen.dart | 1 + .../essentials/combining_requests/watch_example/raw.dart | 1 + .../combining_requests/watch_placement/codegen.dart | 1 + .../combining_requests/watch_placement/raw.dart | 1 + website/docs/essentials/passing_args/raw/family.dart | 5 ++--- .../side_effects/raw/invalidate_self_add_todo.dart | 2 +- .../essentials/side_effects/raw/manual_add_todo.dart | 2 +- .../side_effects/raw/mutable_manual_add_todo.dart | 2 +- .../docs/essentials/side_effects/raw/rest_add_todo.dart | 2 +- .../essentials/side_effects/raw/todo_list_notifier.dart | 4 ++-- .../side_effects/raw/todo_list_notifier_add_todo.dart | 2 +- .../websockets_sync/change_notifier_provider.dart | 1 + website/docs/from_provider/family/raw.dart | 1 + .../docs/from_provider/motivation/async_values/raw.dart | 1 + .../docs/from_provider/motivation/auto_dispose/raw.dart | 1 + website/docs/from_provider/motivation/combine/raw.dart | 1 + website/docs/from_provider/motivation/same_type/raw.dart | 1 + website/docs/migration/from_change_notifier.mdx | 2 +- .../migration/from_change_notifier/declaration/raw.dart | 6 ++++-- .../from_change_notifier/initialization/raw.dart | 6 ++++-- .../migration/from_change_notifier/migrated/raw.dart | 6 ++++-- website/docs/migration/from_change_notifier/old.dart | 1 + website/docs/migration/from_state_notifier.mdx | 8 ++++---- .../migration/from_state_notifier/add_listener/raw.dart | 1 + .../migration/from_state_notifier/add_listener_old.dart | 1 + .../from_state_notifier/async_notifier/raw.dart | 4 +++- .../migration/from_state_notifier/build_init_old.dart | 4 +++- .../from_state_notifier/consumers_dont_change.dart | 4 +++- .../from_state_notifier/family_and_dispose/raw.dart | 9 +++++---- .../from_state_notifier/family_and_dispose_old.dart | 5 +++-- .../from_state_notifier/from_state_provider/raw.dart | 4 +++- .../from_state_notifier/from_state_provider_old.dart | 1 + .../from_state_notifier/obtain_notifier_on_tests.dart | 7 ++++--- .../old_lifecycles/old_lifecycles.dart | 1 + .../from_state_notifier/old_lifecycles/raw.dart | 1 + .../old_lifecycles_final/old_lifecycles_final.dart | 1 + .../from_state_notifier/old_lifecycles_final/raw.dart | 1 + .../from_state_notifier/old_lifecycles_old.dart | 3 ++- .../docs/providers/change_notifier_provider/todos.dart | 1 + .../provider/optimized_previous_button/raw.dart | 1 + .../provider/unoptimized_previous_button/raw.dart | 1 + .../docs/providers/state_notifier_provider/todos.dart | 8 +++++--- website/docs/providers/state_provider/full.dart | 1 + website/docs/providers/state_provider/sort_provider.dart | 1 + .../docs/providers/state_provider/update_read_once.dart | 3 ++- .../docs/providers/state_provider/update_read_twice.dart | 6 ++++-- .../current/concepts/provider_observer_logger.dart | 1 + .../current/concepts/reading_counter.dart | 3 ++- .../current/concepts/reading_listen.dart | 3 ++- .../current/concepts/reading_listen_build.dart | 5 +++-- .../current/concepts/reading_read.dart | 4 ++-- .../current/concepts/reading_read_build.dart | 1 + .../current/concepts/reading_read_notifier_build.dart | 3 ++- .../current/concepts/reading_watch.dart | 1 + .../current/concepts/reading_watch_build.dart | 1 + .../current/concepts/reading_watch_notifier_build.dart | 1 + .../current/cookbooks/testing_original_test_dart.dart | 1 + .../current/cookbooks/testing_original_test_flutter.dart | 1 + .../providers/provider/optimized_previous_button.dart | 1 + .../current/providers/provider/todo.dart | 1 + .../providers/provider/unoptimized_previous_button.dart | 1 + .../current/providers/state_notifier_provider/todos.dart | 1 + .../current/providers/state_provider/full.dart | 1 + .../current/providers/state_provider/sort_provider.dart | 2 +- .../providers/state_provider/update_read_once.dart | 3 ++- .../providers/state_provider/update_read_twice.dart | 1 + .../current/concepts/provider_observer_logger.dart | 1 + .../current/concepts/reading_counter.dart | 3 ++- .../current/concepts/reading_listen.dart | 3 ++- .../current/concepts/reading_listen_build.dart | 5 +++-- .../current/concepts/reading_read.dart | 4 ++-- .../current/concepts/reading_read_build.dart | 1 + .../current/concepts/reading_read_notifier_build.dart | 3 ++- .../current/concepts/reading_watch.dart | 1 + .../current/concepts/reading_watch_build.dart | 1 + .../current/concepts/reading_watch_notifier_build.dart | 1 + .../current/cookbooks/testing_original_test_dart.dart | 1 + .../current/cookbooks/testing_original_test_flutter.dart | 1 + .../providers/provider/optimized_previous_button.dart | 1 + .../current/providers/provider/todo.dart | 1 + .../providers/provider/unoptimized_previous_button.dart | 1 + .../current/providers/state_notifier_provider/todos.dart | 1 + .../current/providers/state_provider/full.dart | 1 + .../current/providers/state_provider/sort_provider.dart | 1 + .../providers/state_provider/update_read_once.dart | 3 ++- .../providers/state_provider/update_read_twice.dart | 1 + .../current/concepts/reading/counter/codegen.dart | 1 + .../current/concepts/reading/counter/raw.dart | 3 ++- website/static/snippets/combine.dart | 2 +- 128 files changed, 190 insertions(+), 74 deletions(-) diff --git a/website/docs/advanced/select/select_async/codegen.dart b/website/docs/advanced/select/select_async/codegen.dart index 3d91c3095..ad79e2d26 100644 --- a/website/docs/advanced/select/select_async/codegen.dart +++ b/website/docs/advanced/select/select_async/codegen.dart @@ -1,5 +1,6 @@ // ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors, body_might_complete_normally_nullable +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/raw.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/raw.dart index 1cec3b128..c4498fe3e 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/raw.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/raw.dart @@ -1,6 +1,7 @@ import 'dart:convert'; import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../activity/raw.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart b/website/docs/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart index 7a880eed7..650fd958f 100644 --- a/website/docs/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart +++ b/website/docs/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart @@ -6,7 +6,7 @@ final exampleProvider = ExampleNotifier.new, ); -class ExampleNotifier extends AutoDisposeAsyncNotifier { +class ExampleNotifier extends AsyncNotifier { @override Future build() async { return Future.value('foo'); diff --git a/website/docs/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart b/website/docs/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart index 66b1ca9fc..caef36fc8 100644 --- a/website/docs/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart +++ b/website/docs/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart @@ -5,7 +5,7 @@ final exampleProvider = NotifierProvider.autoDispose( ExampleNotifier.new, ); -class ExampleNotifier extends AutoDisposeNotifier { +class ExampleNotifier extends Notifier { @override String build() { return 'foo'; diff --git a/website/docs/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart b/website/docs/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart index 6b8af6b85..35fb9f012 100644 --- a/website/docs/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart +++ b/website/docs/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart @@ -6,7 +6,7 @@ final exampleProvider = return ExampleNotifier(); }); -class ExampleNotifier extends AutoDisposeStreamNotifier { +class ExampleNotifier extends StreamNotifier { @override Stream build() async* { yield 'foo'; diff --git a/website/docs/concepts/async_initialization.dart b/website/docs/concepts/async_initialization.dart index 18817b776..4ee56e95a 100644 --- a/website/docs/concepts/async_initialization.dart +++ b/website/docs/concepts/async_initialization.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:shared_preferences/shared_preferences.dart'; class LoadingScreen extends StatelessWidget { diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart index b544b3778..5afc50017 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart @@ -1,5 +1,6 @@ import 'package:dio/dio.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'models.dart'; diff --git a/website/docs/concepts/combining_provider_states/characters_provider/raw.dart b/website/docs/concepts/combining_provider_states/characters_provider/raw.dart index 948148bd0..e788cfcb8 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/raw.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/raw.dart @@ -1,5 +1,6 @@ import 'package:dio/dio.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'models.dart'; diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart index 0d2e49b28..0eaae7c1e 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart @@ -1,4 +1,5 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../todo_list_provider/raw.dart'; diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart index 85885e800..2c3d79b71 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart @@ -1,4 +1,5 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import '../todo_list_provider/raw.dart'; enum Filter { @@ -23,4 +24,4 @@ final filteredTodoListProvider = Provider>((ref) { case Filter.uncompleted: return todos.where((todo) => !todo.completed).toList(); } -}); \ No newline at end of file +}); diff --git a/website/docs/concepts/dialog_scope.dart b/website/docs/concepts/dialog_scope.dart index 4ee7792f9..e51bdc528 100644 --- a/website/docs/concepts/dialog_scope.dart +++ b/website/docs/concepts/dialog_scope.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/docs/concepts/provider_observer_logger.dart b/website/docs/concepts/provider_observer_logger.dart index 40f8120e6..8ab5ecbae 100644 --- a/website/docs/concepts/provider_observer_logger.dart +++ b/website/docs/concepts/provider_observer_logger.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/docs/concepts/reading/counter/codegen.dart b/website/docs/concepts/reading/counter/codegen.dart index ca1edf42e..06d95f510 100644 --- a/website/docs/concepts/reading/counter/codegen.dart +++ b/website/docs/concepts/reading/counter/codegen.dart @@ -1,3 +1,4 @@ +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/reading/counter/raw.dart b/website/docs/concepts/reading/counter/raw.dart index f464c984e..5d248ab57 100644 --- a/website/docs/concepts/reading/counter/raw.dart +++ b/website/docs/concepts/reading/counter/raw.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; final repositoryProvider = Provider((ref) => Repository()); @@ -15,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter can use the "ref" to read other providers diff --git a/website/docs/concepts/reading/listen_build/raw.dart b/website/docs/concepts/reading/listen_build/raw.dart index e59ddaf57..87ba0a7d8 100644 --- a/website/docs/concepts/reading/listen_build/raw.dart +++ b/website/docs/concepts/reading/listen_build/raw.dart @@ -2,12 +2,12 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import '../counter/raw.dart'; /* SNIPPET START */ -final counterProvider = - StateNotifierProvider(Counter.new); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { const HomeView({super.key}); diff --git a/website/docs/concepts/reading/listen_build/raw_hooks.dart b/website/docs/concepts/reading/listen_build/raw_hooks.dart index 9f86fc19f..ac38732a5 100644 --- a/website/docs/concepts/reading/listen_build/raw_hooks.dart +++ b/website/docs/concepts/reading/listen_build/raw_hooks.dart @@ -2,13 +2,13 @@ import 'package:flutter/material.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import '../counter/raw.dart'; /* SNIPPET START */ -final counterProvider = - StateNotifierProvider(Counter.new); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends HookConsumerWidget { const HomeView({super.key}); diff --git a/website/docs/concepts/reading/read/raw.dart b/website/docs/concepts/reading/read/raw.dart index 7d8685155..c30eeb5f2 100644 --- a/website/docs/concepts/reading/read/raw.dart +++ b/website/docs/concepts/reading/read/raw.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import '../counter/raw.dart'; diff --git a/website/docs/concepts/reading/read/raw_hooks.dart b/website/docs/concepts/reading/read/raw_hooks.dart index acc6ba980..bde77d3a8 100644 --- a/website/docs/concepts/reading/read/raw_hooks.dart +++ b/website/docs/concepts/reading/read/raw_hooks.dart @@ -2,14 +2,14 @@ import 'package:flutter/material.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import '../counter/raw.dart'; /* SNIPPET START */ -final counterProvider = - StateNotifierProvider(Counter.new); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends HookConsumerWidget { const HomeView({super.key}); @@ -17,7 +17,7 @@ class HomeView extends HookConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { final greeting = useState('Hello'); - + return Scaffold( body: Center(child: Text(greeting.value)), floatingActionButton: FloatingActionButton( diff --git a/website/docs/concepts/reading/read_build/raw.dart b/website/docs/concepts/reading/read_build/raw.dart index 266e00224..f90cd968f 100644 --- a/website/docs/concepts/reading/read_build/raw.dart +++ b/website/docs/concepts/reading/read_build/raw.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/docs/concepts/reading/read_notifier_build/raw.dart b/website/docs/concepts/reading/read_notifier_build/raw.dart index 0ec5b5958..95bdab6c5 100644 --- a/website/docs/concepts/reading/read_notifier_build/raw.dart +++ b/website/docs/concepts/reading/read_notifier_build/raw.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/docs/concepts/reading/watch/raw.dart b/website/docs/concepts/reading/watch/raw.dart index 625c0fe9a..bde11d2e4 100644 --- a/website/docs/concepts/reading/watch/raw.dart +++ b/website/docs/concepts/reading/watch/raw.dart @@ -1,6 +1,7 @@ // ignore_for_file: omit_local_variable_types import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/docs/concepts/reading/watch_build/raw.dart b/website/docs/concepts/reading/watch_build/raw.dart index 8d5d430eb..90639ac8c 100644 --- a/website/docs/concepts/reading/watch_build/raw.dart +++ b/website/docs/concepts/reading/watch_build/raw.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/docs/concepts/reading/watch_build/raw_hooks.dart b/website/docs/concepts/reading/watch_build/raw_hooks.dart index 5f297850a..f125f6553 100644 --- a/website/docs/concepts/reading/watch_build/raw_hooks.dart +++ b/website/docs/concepts/reading/watch_build/raw_hooks.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; enum FilterType { @@ -28,7 +29,7 @@ class HomeView extends HookConsumerWidget { Widget build(BuildContext context, WidgetRef ref) { // You can use hooks inside a HookConsumerWidget final greeting = useState('Hello'); - + // use ref to listen to a provider final counter = ref.watch(counterProvider); diff --git a/website/docs/concepts/reading/watch_notifier_build/raw.dart b/website/docs/concepts/reading/watch_notifier_build/raw.dart index 66c630717..94d77b5e3 100644 --- a/website/docs/concepts/reading/watch_notifier_build/raw.dart +++ b/website/docs/concepts/reading/watch_notifier_build/raw.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/docs/concepts/subtree_scope.dart b/website/docs/concepts/subtree_scope.dart index 9aa1903e5..4f0d04e0e 100644 --- a/website/docs/concepts/subtree_scope.dart +++ b/website/docs/concepts/subtree_scope.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/docs/concepts/theme_scope.dart b/website/docs/concepts/theme_scope.dart index d17f15f02..c7335582a 100644 --- a/website/docs/concepts/theme_scope.dart +++ b/website/docs/concepts/theme_scope.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/docs/cookbooks/testing_original_test_dart.dart b/website/docs/cookbooks/testing_original_test_dart.dart index 6995de9b8..d78668653 100644 --- a/website/docs/cookbooks/testing_original_test_dart.dart +++ b/website/docs/cookbooks/testing_original_test_dart.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; diff --git a/website/docs/cookbooks/testing_original_test_flutter.dart b/website/docs/cookbooks/testing_original_test_flutter.dart index f76abe181..3aaac7a9e 100644 --- a/website/docs/cookbooks/testing_original_test_flutter.dart +++ b/website/docs/cookbooks/testing_original_test_flutter.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; /* SNIPPET START */ diff --git a/website/docs/essentials/auto_dispose/cache_for_extension.dart b/website/docs/essentials/auto_dispose/cache_for_extension.dart index d7cb19827..25e0e5a44 100644 --- a/website/docs/essentials/auto_dispose/cache_for_extension.dart +++ b/website/docs/essentials/auto_dispose/cache_for_extension.dart @@ -3,7 +3,7 @@ import 'dart:async'; import 'package:hooks_riverpod/hooks_riverpod.dart'; /* SNIPPET START */ -extension CacheForExtension on AutoDisposeRef { +extension CacheForExtension on Ref { /// Keeps the provider alive for [duration]. void cacheFor(Duration duration) { // Immediately prevent the state from getting destroyed. diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/raw.dart b/website/docs/essentials/auto_dispose/cache_for_usage/raw.dart index 2a2cf358a..9f15f5802 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/raw.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/raw.dart @@ -1,6 +1,7 @@ // ignore_for_file: unused_local_variable import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../cache_for_extension.dart'; diff --git a/website/docs/essentials/auto_dispose/keep_alive/raw.dart b/website/docs/essentials/auto_dispose/keep_alive/raw.dart index f0fc6a3ba..a6a31d8db 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/raw.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/raw.dart @@ -1,6 +1,7 @@ // ignore_for_file: unused_local_variable import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/raw.dart b/website/docs/essentials/auto_dispose/on_dispose_example/raw.dart index 4e4940777..dff812ea0 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/raw.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/raw.dart @@ -2,6 +2,7 @@ import 'dart:async'; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ diff --git a/website/docs/essentials/auto_dispose/raw_auto_dispose.dart b/website/docs/essentials/auto_dispose/raw_auto_dispose.dart index d474c8874..c863fcffd 100644 --- a/website/docs/essentials/auto_dispose/raw_auto_dispose.dart +++ b/website/docs/essentials/auto_dispose/raw_auto_dispose.dart @@ -1,3 +1,4 @@ +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ diff --git a/website/docs/essentials/combining_requests/functional_ref/raw.dart b/website/docs/essentials/combining_requests/functional_ref/raw.dart index 19962d9cd..d49ee63fa 100644 --- a/website/docs/essentials/combining_requests/functional_ref/raw.dart +++ b/website/docs/essentials/combining_requests/functional_ref/raw.dart @@ -1,5 +1,6 @@ // ignore_for_file: unused_local_variable +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; final otherProvider = Provider((ref) => 0); diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.dart b/website/docs/essentials/combining_requests/listen_example/codegen.dart index 25c6a2f37..e3e9f23ba 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.dart @@ -1,5 +1,6 @@ // ignore_for_file: unused_local_variable, avoid_print +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/listen_example/raw.dart b/website/docs/essentials/combining_requests/listen_example/raw.dart index 12b578dd0..1ed959e92 100644 --- a/website/docs/essentials/combining_requests/listen_example/raw.dart +++ b/website/docs/essentials/combining_requests/listen_example/raw.dart @@ -1,4 +1,5 @@ // ignore_for_file: unused_local_variable, avoid_print +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; final otherProvider = Provider((ref) => 0); diff --git a/website/docs/essentials/combining_requests/notifier_ref/raw.dart b/website/docs/essentials/combining_requests/notifier_ref/raw.dart index d292fea5e..50674b120 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/raw.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/raw.dart @@ -1,5 +1,6 @@ // ignore_for_file: unused_local_variable +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; final otherProvider = Provider((ref) => 0); diff --git a/website/docs/essentials/combining_requests/read_example/codegen.dart b/website/docs/essentials/combining_requests/read_example/codegen.dart index 0b6522564..2d629b553 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.dart @@ -1,5 +1,6 @@ // ignore_for_file: unused_local_variable +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/read_example/raw.dart b/website/docs/essentials/combining_requests/read_example/raw.dart index e269310eb..c800827b6 100644 --- a/website/docs/essentials/combining_requests/read_example/raw.dart +++ b/website/docs/essentials/combining_requests/read_example/raw.dart @@ -1,5 +1,6 @@ // ignore_for_file: unused_local_variable +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; final otherProvider = Provider((ref) => 0); diff --git a/website/docs/essentials/combining_requests/watch_example/codegen.dart b/website/docs/essentials/combining_requests/watch_example/codegen.dart index a81329ba0..34775b9d6 100644 --- a/website/docs/essentials/combining_requests/watch_example/codegen.dart +++ b/website/docs/essentials/combining_requests/watch_example/codegen.dart @@ -3,6 +3,7 @@ import 'dart:convert'; import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/watch_example/raw.dart b/website/docs/essentials/combining_requests/watch_example/raw.dart index f4e85466e..a9a6ab519 100644 --- a/website/docs/essentials/combining_requests/watch_example/raw.dart +++ b/website/docs/essentials/combining_requests/watch_example/raw.dart @@ -3,6 +3,7 @@ import 'dart:convert'; import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; final otherProvider = Provider((ref) => 0); diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.dart index 736d1ecc7..103abe81a 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.dart @@ -1,6 +1,7 @@ // ignore_for_file: unused_local_variable import 'package:flutter/foundation.dart'; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/watch_placement/raw.dart b/website/docs/essentials/combining_requests/watch_placement/raw.dart index 34fa8f6c9..163f181bb 100644 --- a/website/docs/essentials/combining_requests/watch_placement/raw.dart +++ b/website/docs/essentials/combining_requests/watch_placement/raw.dart @@ -1,6 +1,7 @@ // ignore_for_file: unused_local_variable import 'package:flutter/foundation.dart'; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; final otherProvider = Provider((ref) => 0); diff --git a/website/docs/essentials/passing_args/raw/family.dart b/website/docs/essentials/passing_args/raw/family.dart index dece07b5b..ba48f7208 100644 --- a/website/docs/essentials/passing_args/raw/family.dart +++ b/website/docs/essentials/passing_args/raw/family.dart @@ -27,9 +27,8 @@ final activityProvider2 = AsyncNotifierProvider.autoDispose // When using ".family" with notifiers, we need to change the notifier subclass: // AsyncNotifier -> FamilyAsyncNotifier -// AutoDisposeAsyncNotifier -> AutoDisposeFamilyAsyncNotifier -class ActivityNotifier - extends AutoDisposeFamilyAsyncNotifier { +// AsyncNotifier -> FamilyAsyncNotifier +class ActivityNotifier extends FamilyAsyncNotifier { /// Family arguments are passed to the build method and accessible with this.arg @override Future build(String activityType) async { diff --git a/website/docs/essentials/side_effects/raw/invalidate_self_add_todo.dart b/website/docs/essentials/side_effects/raw/invalidate_self_add_todo.dart index 09b58fb1e..506edef44 100644 --- a/website/docs/essentials/side_effects/raw/invalidate_self_add_todo.dart +++ b/website/docs/essentials/side_effects/raw/invalidate_self_add_todo.dart @@ -12,7 +12,7 @@ final todoListProvider = TodoList.new, ); -class TodoList extends AutoDisposeAsyncNotifier> { +class TodoList extends AsyncNotifier> { @override Future> build() async => [/* ... */]; diff --git a/website/docs/essentials/side_effects/raw/manual_add_todo.dart b/website/docs/essentials/side_effects/raw/manual_add_todo.dart index ca909a751..e7d579680 100644 --- a/website/docs/essentials/side_effects/raw/manual_add_todo.dart +++ b/website/docs/essentials/side_effects/raw/manual_add_todo.dart @@ -12,7 +12,7 @@ final todoListProvider = TodoList.new, ); -class TodoList extends AutoDisposeAsyncNotifier> { +class TodoList extends AsyncNotifier> { @override Future> build() async => [/* ... */]; diff --git a/website/docs/essentials/side_effects/raw/mutable_manual_add_todo.dart b/website/docs/essentials/side_effects/raw/mutable_manual_add_todo.dart index db41ecff9..80c284c69 100644 --- a/website/docs/essentials/side_effects/raw/mutable_manual_add_todo.dart +++ b/website/docs/essentials/side_effects/raw/mutable_manual_add_todo.dart @@ -12,7 +12,7 @@ final todoListProvider = TodoList.new, ); -class TodoList extends AutoDisposeAsyncNotifier> { +class TodoList extends AsyncNotifier> { @override Future> build() async => [/* ... */]; diff --git a/website/docs/essentials/side_effects/raw/rest_add_todo.dart b/website/docs/essentials/side_effects/raw/rest_add_todo.dart index e5a2a30df..e678a6013 100644 --- a/website/docs/essentials/side_effects/raw/rest_add_todo.dart +++ b/website/docs/essentials/side_effects/raw/rest_add_todo.dart @@ -12,7 +12,7 @@ final todoListProvider = TodoList.new, ); -class TodoList extends AutoDisposeAsyncNotifier> { +class TodoList extends AsyncNotifier> { @override Future> build() async => [/* ... */]; diff --git a/website/docs/essentials/side_effects/raw/todo_list_notifier.dart b/website/docs/essentials/side_effects/raw/todo_list_notifier.dart index 9a6d5f2e5..bbcc5af84 100644 --- a/website/docs/essentials/side_effects/raw/todo_list_notifier.dart +++ b/website/docs/essentials/side_effects/raw/todo_list_notifier.dart @@ -30,9 +30,9 @@ final todoListProvider = ); // We use an AsyncNotifier because our logic is asynchronous. -// More specifically, we'll need AutoDisposeAsyncNotifier because +// More specifically, we'll need AsyncNotifier because // of the "autoDispose" modifier. -class TodoList extends AutoDisposeAsyncNotifier> { +class TodoList extends AsyncNotifier> { @override Future> build() async { // The logic we previously had in our FutureProvider is now in the build method. diff --git a/website/docs/essentials/side_effects/raw/todo_list_notifier_add_todo.dart b/website/docs/essentials/side_effects/raw/todo_list_notifier_add_todo.dart index 2023bdc99..e4f87baee 100644 --- a/website/docs/essentials/side_effects/raw/todo_list_notifier_add_todo.dart +++ b/website/docs/essentials/side_effects/raw/todo_list_notifier_add_todo.dart @@ -13,7 +13,7 @@ final todoListProvider = ); /* SNIPPET START */ -class TodoList extends AutoDisposeAsyncNotifier> { +class TodoList extends AsyncNotifier> { @override Future> build() async => [/* ... */]; diff --git a/website/docs/essentials/websockets_sync/change_notifier_provider.dart b/website/docs/essentials/websockets_sync/change_notifier_provider.dart index 629e62a4d..b2e23e45d 100644 --- a/website/docs/essentials/websockets_sync/change_notifier_provider.dart +++ b/website/docs/essentials/websockets_sync/change_notifier_provider.dart @@ -2,6 +2,7 @@ import 'package:flutter/widgets.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ final myProvider = ChangeNotifierProvider>((ref) { diff --git a/website/docs/from_provider/family/raw.dart b/website/docs/from_provider/family/raw.dart index 68b84d40d..4f83a7e4e 100644 --- a/website/docs/from_provider/family/raw.dart +++ b/website/docs/from_provider/family/raw.dart @@ -1,6 +1,7 @@ import 'dart:math'; import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; @immutable diff --git a/website/docs/from_provider/motivation/async_values/raw.dart b/website/docs/from_provider/motivation/async_values/raw.dart index 1ca8987ef..0fcb13614 100644 --- a/website/docs/from_provider/motivation/async_values/raw.dart +++ b/website/docs/from_provider/motivation/async_values/raw.dart @@ -1,5 +1,6 @@ import 'package:collection/collection.dart'; import 'package:dio/dio.dart'; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../helpers/item.dart'; diff --git a/website/docs/from_provider/motivation/auto_dispose/raw.dart b/website/docs/from_provider/motivation/auto_dispose/raw.dart index d5961ad90..b69b74919 100644 --- a/website/docs/from_provider/motivation/auto_dispose/raw.dart +++ b/website/docs/from_provider/motivation/auto_dispose/raw.dart @@ -1,5 +1,6 @@ import 'dart:math'; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ diff --git a/website/docs/from_provider/motivation/combine/raw.dart b/website/docs/from_provider/motivation/combine/raw.dart index ad33636e7..28999af75 100644 --- a/website/docs/from_provider/motivation/combine/raw.dart +++ b/website/docs/from_provider/motivation/combine/raw.dart @@ -1,5 +1,6 @@ import 'dart:math'; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ diff --git a/website/docs/from_provider/motivation/same_type/raw.dart b/website/docs/from_provider/motivation/same_type/raw.dart index dacfe9b9d..22c2afa2a 100644 --- a/website/docs/from_provider/motivation/same_type/raw.dart +++ b/website/docs/from_provider/motivation/same_type/raw.dart @@ -1,4 +1,5 @@ import 'package:collection/collection.dart'; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../helpers/item.dart'; diff --git a/website/docs/migration/from_change_notifier.mdx b/website/docs/migration/from_change_notifier.mdx index 9af75d89e..281603b42 100644 --- a/website/docs/migration/from_change_notifier.mdx +++ b/website/docs/migration/from_change_notifier.mdx @@ -70,7 +70,7 @@ There's no need to think about the right class names and their *specific* APIs. `@riverpod` only asks you to write a class with its return type, and you're good to go. ::: -Technically, the best fit here is to define a `AutoDisposeAsyncNotifier>`, +Technically, the best fit here is to define a `AsyncNotifier>`, which meets all the above requirements. Let's write some pseudocode first. diff --git a/website/docs/migration/from_change_notifier/declaration/raw.dart b/website/docs/migration/from_change_notifier/declaration/raw.dart index c7485bbba..f43a57875 100644 --- a/website/docs/migration/from_change_notifier/declaration/raw.dart +++ b/website/docs/migration/from_change_notifier/declaration/raw.dart @@ -1,5 +1,6 @@ // ignore_for_file: avoid_print, avoid_unused_constructor_parameters +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; class Todo { @@ -18,7 +19,7 @@ final http = Http(); /* SNIPPET START */ @riverpod -class MyNotifier extends AutoDisposeAsyncNotifier> { +class MyNotifier extends AsyncNotifier> { @override FutureOr> build() { // TODO ... @@ -30,4 +31,5 @@ class MyNotifier extends AutoDisposeAsyncNotifier> { } } -final myNotifierProvider = AsyncNotifierProvider.autoDispose(MyNotifier.new); +final myNotifierProvider = + AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/docs/migration/from_change_notifier/initialization/raw.dart b/website/docs/migration/from_change_notifier/initialization/raw.dart index 24ab265f7..10f11e686 100644 --- a/website/docs/migration/from_change_notifier/initialization/raw.dart +++ b/website/docs/migration/from_change_notifier/initialization/raw.dart @@ -1,5 +1,6 @@ // ignore_for_file: avoid_print, avoid_unused_constructor_parameters +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; class Todo { @@ -18,7 +19,7 @@ final http = Http(); /* SNIPPET START */ @riverpod -class MyNotifier extends AutoDisposeAsyncNotifier> { +class MyNotifier extends AsyncNotifier> { @override FutureOr> build() async { final json = await http.get('api/todos'); @@ -26,4 +27,5 @@ class MyNotifier extends AutoDisposeAsyncNotifier> { } } -final myNotifierProvider = AsyncNotifierProvider.autoDispose(MyNotifier.new); +final myNotifierProvider = + AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/docs/migration/from_change_notifier/migrated/raw.dart b/website/docs/migration/from_change_notifier/migrated/raw.dart index 8572db71d..c03870a12 100644 --- a/website/docs/migration/from_change_notifier/migrated/raw.dart +++ b/website/docs/migration/from_change_notifier/migrated/raw.dart @@ -1,5 +1,6 @@ // ignore_for_file: avoid_print, avoid_unused_constructor_parameters +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; class Todo { @@ -18,7 +19,7 @@ final http = Http(); /* SNIPPET START */ @riverpod -class MyNotifier extends AutoDisposeAsyncNotifier> { +class MyNotifier extends AsyncNotifier> { @override FutureOr> build() async { final json = await http.get('api/todos'); @@ -34,4 +35,5 @@ class MyNotifier extends AutoDisposeAsyncNotifier> { } } -final myNotifierProvider = AsyncNotifierProvider.autoDispose(MyNotifier.new); +final myNotifierProvider = + AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/docs/migration/from_change_notifier/old.dart b/website/docs/migration/from_change_notifier/old.dart index 4e65e823d..c4f1970cc 100644 --- a/website/docs/migration/from_change_notifier/old.dart +++ b/website/docs/migration/from_change_notifier/old.dart @@ -2,6 +2,7 @@ import 'package:flutter/foundation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; class Todo { const Todo(this.id); diff --git a/website/docs/migration/from_state_notifier.mdx b/website/docs/migration/from_state_notifier.mdx index 48543d362..cef691c0c 100644 --- a/website/docs/migration/from_state_notifier.mdx +++ b/website/docs/migration/from_state_notifier.mdx @@ -76,8 +76,8 @@ Here's the above example, rewritten with the new `AsyncNotifier` APIs: Here, it's easy to see `AsyncNotifer` as a `FutureProvider` with methods. `AsyncNotifer` comes with a set of utilities and getters that `StateNotifier` doesn't have, such as e.g. -[`future`](https://pub.dev/documentation/riverpod/latest/riverpod/AutoDisposeAsyncNotifier/future.html) -and [`update`](https://pub.dev/documentation/riverpod/latest/riverpod/AutoDisposeAsyncNotifier/update.html). +[`future`](https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifier/future.html) +and [`update`](https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifier/update.html). This enables us to write much simpler logic when handling asynchronous mutations and side-effects. See also . :::tip @@ -104,9 +104,9 @@ Let's go further down and highlight more differences and similarities. Another important difference is how families and auto dispose is handled with the new APIs. `Notifier`, has its own `.family` and `.autoDispose` counterparts, such as `FamilyNotifier` -and `AutoDisposeNotifier`. +and `Notifier`. As always, such modifications can be combined (aka `AutoDisposeFamilyNotifier`). -`AsyncNotifer` has its asynchronous equivalent, too (e.g. `AutoDisposeFamilyAsyncNotifier`). +`AsyncNotifer` has its asynchronous equivalent, too (e.g. `FamilyAsyncNotifier`). Modifications are explicitly stated inside the class; any parameters are directly injected in the `build` method, so that they're available to the initialization logic. diff --git a/website/docs/migration/from_state_notifier/add_listener/raw.dart b/website/docs/migration/from_state_notifier/add_listener/raw.dart index e25b4a181..f4c1c627b 100644 --- a/website/docs/migration/from_state_notifier/add_listener/raw.dart +++ b/website/docs/migration/from_state_notifier/add_listener/raw.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_print import 'package:flutter/material.dart'; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ diff --git a/website/docs/migration/from_state_notifier/add_listener_old.dart b/website/docs/migration/from_state_notifier/add_listener_old.dart index 5934a0f88..39a173d8c 100644 --- a/website/docs/migration/from_state_notifier/add_listener_old.dart +++ b/website/docs/migration/from_state_notifier/add_listener_old.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ class MyNotifier extends StateNotifier { diff --git a/website/docs/migration/from_state_notifier/async_notifier/raw.dart b/website/docs/migration/from_state_notifier/async_notifier/raw.dart index 52da61d76..ac91d2f88 100644 --- a/website/docs/migration/from_state_notifier/async_notifier/raw.dart +++ b/website/docs/migration/from_state_notifier/async_notifier/raw.dart @@ -1,5 +1,6 @@ // ignore_for_file: avoid_print, avoid_unused_constructor_parameters +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; class Todo { @@ -24,6 +25,7 @@ class AsyncTodosNotifier extends AsyncNotifier> { // ... } -final asyncTodosNotifier = AsyncNotifierProvider>( +final asyncTodosNotifier = + AsyncNotifierProvider>( AsyncTodosNotifier.new, ); diff --git a/website/docs/migration/from_state_notifier/build_init_old.dart b/website/docs/migration/from_state_notifier/build_init_old.dart index 82a8c54bd..034b059ec 100644 --- a/website/docs/migration/from_state_notifier/build_init_old.dart +++ b/website/docs/migration/from_state_notifier/build_init_old.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; /* SNIPPET START */ @@ -8,6 +9,7 @@ class CounterNotifier extends StateNotifier { void decrement() => state++; } -final counterNotifierProvider = StateNotifierProvider((ref) { +final counterNotifierProvider = + StateNotifierProvider((ref) { return CounterNotifier(); }); diff --git a/website/docs/migration/from_state_notifier/consumers_dont_change.dart b/website/docs/migration/from_state_notifier/consumers_dont_change.dart index 6a964a5a6..7c7c656ee 100644 --- a/website/docs/migration/from_state_notifier/consumers_dont_change.dart +++ b/website/docs/migration/from_state_notifier/consumers_dont_change.dart @@ -1,4 +1,5 @@ import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; class CounterNotifier extends StateNotifier { @@ -8,7 +9,8 @@ class CounterNotifier extends StateNotifier { void decrement() => state++; } -final counterNotifierProvider = StateNotifierProvider((ref) { +final counterNotifierProvider = + StateNotifierProvider((ref) { return CounterNotifier(); }); diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/raw.dart b/website/docs/migration/from_state_notifier/family_and_dispose/raw.dart index 8dfce9447..b7068013a 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/raw.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/raw.dart @@ -8,7 +8,7 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../utils.dart'; /* SNIPPET START */ -class BugsEncounteredNotifier extends AutoDisposeFamilyAsyncNotifier { +class BugsEncounteredNotifier extends FamilyAsyncNotifier { @override FutureOr build(String featureId) { return 99; @@ -16,12 +16,13 @@ class BugsEncounteredNotifier extends AutoDisposeFamilyAsyncNotifier fix(int amount) async { final old = await future; - final result = await ref.read(taskTrackerProvider).fix(id: this.arg, fixed: amount); + final result = + await ref.read(taskTrackerProvider).fix(id: this.arg, fixed: amount); state = AsyncData(max(old - result, 0)); } } -final bugsEncounteredNotifierProvider = - AsyncNotifierProvider.family.autoDispose( +final bugsEncounteredNotifierProvider = AsyncNotifierProvider.family + .autoDispose( BugsEncounteredNotifier.new, ); diff --git a/website/docs/migration/from_state_notifier/family_and_dispose_old.dart b/website/docs/migration/from_state_notifier/family_and_dispose_old.dart index 844888f36..f01455cf7 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose_old.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose_old.dart @@ -2,6 +2,7 @@ import 'dart:math'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import '../utils.dart'; @@ -13,7 +14,7 @@ class BugsEncounteredNotifier extends StateNotifier> { required this.featureId, }) : super(const AsyncData(99)); final String featureId; - final Ref ref; + final Ref> ref; Future fix(int amount) async { state = await AsyncValue.guard(() async { @@ -26,6 +27,6 @@ class BugsEncounteredNotifier extends StateNotifier> { } final bugsEncounteredNotifierProvider = StateNotifierProvider.family - .autoDispose((ref, id) { + .autoDispose, String>((ref, id) { return BugsEncounteredNotifier(ref: ref, featureId: id); }); diff --git a/website/docs/migration/from_state_notifier/from_state_provider/raw.dart b/website/docs/migration/from_state_notifier/from_state_provider/raw.dart index 97e4564f3..8f7dc85a4 100644 --- a/website/docs/migration/from_state_notifier/from_state_provider/raw.dart +++ b/website/docs/migration/from_state_notifier/from_state_provider/raw.dart @@ -1,3 +1,4 @@ +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ @@ -10,4 +11,5 @@ class CounterNotifier extends Notifier { int update(int Function(int state) cb) => state = cb(state); } -final counterNotifierProvider = NotifierProvider(CounterNotifier.new); +final counterNotifierProvider = + NotifierProvider(CounterNotifier.new); diff --git a/website/docs/migration/from_state_notifier/from_state_provider_old.dart b/website/docs/migration/from_state_notifier/from_state_provider_old.dart index 246f44a0c..2f30f8ef0 100644 --- a/website/docs/migration/from_state_notifier/from_state_provider_old.dart +++ b/website/docs/migration/from_state_notifier/from_state_provider_old.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; /* SNIPPET START */ diff --git a/website/docs/migration/from_state_notifier/obtain_notifier_on_tests.dart b/website/docs/migration/from_state_notifier/obtain_notifier_on_tests.dart index df97a0fb2..3b80edf9e 100644 --- a/website/docs/migration/from_state_notifier/obtain_notifier_on_tests.dart +++ b/website/docs/migration/from_state_notifier/obtain_notifier_on_tests.dart @@ -3,14 +3,15 @@ import 'package:flutter_test/flutter_test.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -class MyNotifier extends AutoDisposeNotifier { +class MyNotifier extends Notifier { @override int build() { return 0; } } -final myNotifierProvider = NotifierProvider.autoDispose(MyNotifier.new); +final myNotifierProvider = + NotifierProvider.autoDispose(MyNotifier.new); /* SNIPPET START */ void main(List args) { @@ -20,7 +21,7 @@ void main(List args) { // Obtaining a notifier /* highlight-start */ - final AutoDisposeNotifier notifier = container.read(myNotifierProvider.notifier); + final Notifier notifier = container.read(myNotifierProvider.notifier); /* highlight-end */ // Obtaining its exposed state diff --git a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart index a96f294c6..1313cc7bd 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:dio/dio.dart'; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../utils.dart'; diff --git a/website/docs/migration/from_state_notifier/old_lifecycles/raw.dart b/website/docs/migration/from_state_notifier/old_lifecycles/raw.dart index 691d71af9..953be404a 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles/raw.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles/raw.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:dio/dio.dart'; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../utils.dart'; diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart index 47bfe2516..46370f3d6 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:dio/dio.dart'; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../utils.dart'; diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/raw.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/raw.dart index 94814a191..1d49268d0 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/raw.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/raw.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:dio/dio.dart'; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../utils.dart'; diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_old.dart b/website/docs/migration/from_state_notifier/old_lifecycles_old.dart index dd1d61592..880fcee10 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_old.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_old.dart @@ -2,6 +2,7 @@ import 'dart:async'; import 'package:dio/dio.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import '../utils.dart'; @@ -20,7 +21,7 @@ class MyNotifier extends StateNotifier { _timer = Timer.periodic(period, (t) => update()); // 2 side effect on init } final Duration period; - final Ref ref; + final Ref ref; late final Timer _timer; Future update() async { diff --git a/website/docs/providers/change_notifier_provider/todos.dart b/website/docs/providers/change_notifier_provider/todos.dart index d766920b1..901b73abd 100644 --- a/website/docs/providers/change_notifier_provider/todos.dart +++ b/website/docs/providers/change_notifier_provider/todos.dart @@ -1,5 +1,6 @@ import 'package:flutter/foundation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/docs/providers/provider/optimized_previous_button/raw.dart b/website/docs/providers/provider/optimized_previous_button/raw.dart index 30b1cc673..a4d3cb4b9 100644 --- a/website/docs/providers/provider/optimized_previous_button/raw.dart +++ b/website/docs/providers/provider/optimized_previous_button/raw.dart @@ -1,6 +1,7 @@ // A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/docs/providers/provider/unoptimized_previous_button/raw.dart b/website/docs/providers/provider/unoptimized_previous_button/raw.dart index 828d382d5..b670eaae3 100644 --- a/website/docs/providers/provider/unoptimized_previous_button/raw.dart +++ b/website/docs/providers/provider/unoptimized_previous_button/raw.dart @@ -1,6 +1,7 @@ // A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/docs/providers/state_notifier_provider/todos.dart b/website/docs/providers/state_notifier_provider/todos.dart index 1318bbcbf..c55836e55 100644 --- a/website/docs/providers/state_notifier_provider/todos.dart +++ b/website/docs/providers/state_notifier_provider/todos.dart @@ -1,5 +1,6 @@ import 'package:flutter/foundation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ @@ -7,7 +8,8 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; // We could also use packages like Freezed to help with the implementation. @immutable class Todo { - const Todo({required this.id, required this.description, required this.completed}); + const Todo( + {required this.id, required this.description, required this.completed}); // All properties should be `final` on our class. final String id; @@ -31,7 +33,7 @@ class Todo { // The public methods on this class will be what allow the UI to modify the state. class TodosNotifier extends StateNotifier> { // We initialize the list of todos to an empty list - TodosNotifier(): super([]); + TodosNotifier() : super([]); // Let's allow the UI to add todos. void addTodo(Todo todo) { @@ -75,4 +77,4 @@ class TodosNotifier extends StateNotifier> { // our TodosNotifier class. final todosProvider = StateNotifierProvider>((ref) { return TodosNotifier(); -}); \ No newline at end of file +}); diff --git a/website/docs/providers/state_provider/full.dart b/website/docs/providers/state_provider/full.dart index 4c598055f..28eb1f863 100644 --- a/website/docs/providers/state_provider/full.dart +++ b/website/docs/providers/state_provider/full.dart @@ -5,6 +5,7 @@ import 'package:collection/collection.dart'; import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; void main() { runApp(const ProviderScope(child: MyApp())); diff --git a/website/docs/providers/state_provider/sort_provider.dart b/website/docs/providers/state_provider/sort_provider.dart index 60a5f60c1..63d080dd8 100644 --- a/website/docs/providers/state_provider/sort_provider.dart +++ b/website/docs/providers/state_provider/sort_provider.dart @@ -1,4 +1,5 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'dropdown.dart'; diff --git a/website/docs/providers/state_provider/update_read_once.dart b/website/docs/providers/state_provider/update_read_once.dart index 825df6d0f..3cd8e6878 100644 --- a/website/docs/providers/state_provider/update_read_once.dart +++ b/website/docs/providers/state_provider/update_read_once.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ @@ -20,4 +21,4 @@ class HomeView extends ConsumerWidget { ), ); } -} \ No newline at end of file +} diff --git a/website/docs/providers/state_provider/update_read_twice.dart b/website/docs/providers/state_provider/update_read_twice.dart index c029e0730..58f866fc9 100644 --- a/website/docs/providers/state_provider/update_read_twice.dart +++ b/website/docs/providers/state_provider/update_read_twice.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ @@ -15,9 +16,10 @@ class HomeView extends ConsumerWidget { onPressed: () { // We're updating the state from the previous value, we ended-up reading // the provider twice! - ref.read(counterProvider.notifier).state = ref.read(counterProvider.notifier).state + 1; + ref.read(counterProvider.notifier).state = + ref.read(counterProvider.notifier).state + 1; }, ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index 0d801dbce..8c47f5c10 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index 44e9ba8ee..d4cacfdd8 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; final repositoryProvider = Provider((ref) => Repository()); @@ -15,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter এই "ref" অবজেক্ট ব্যবহার করে অন্য প্রভাইডার পড়তে পারবে diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index 4ed90e7af..620d39d3d 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -1,5 +1,6 @@ // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'reading_counter.dart'; @@ -12,4 +13,4 @@ final anotherProvider = Provider((ref) { print('The counter changed $newCount'); }); // ... -}); \ No newline at end of file +}); diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 066565b67..ec3488a7f 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'reading_counter.dart'; /* SNIPPET START */ @@ -16,7 +17,7 @@ class HomeView extends ConsumerWidget { ref.listen(counterProvider, (int? previousCount, int newCount) { print('The counter changed $newCount'); }); - + return Container(); } -} \ No newline at end of file +} diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index 91be089df..471610860 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -2,13 +2,13 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = - StateNotifierProvider(Counter.new); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { const HomeView({super.key}); diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart index 685d5ac4d..4a17f4645 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart index 34104aead..95bdab6c5 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ @@ -13,4 +14,4 @@ Widget build(BuildContext context, WidgetRef ref) { onPressed: () => counter.state++, child: const Text('button'), ); -} \ No newline at end of file +} diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart index 1bc535f2e..17eb632ef 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart @@ -1,6 +1,7 @@ // ignore_for_file: omit_local_variable_types import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index bc0c7bdf4..1e60d2751 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart index 66c630717..94d77b5e3 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart index 86a9b7977..53b8628a5 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart @@ -1,5 +1,6 @@ import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; /* SNIPPET START */ diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart index 3e06a14d0..d4af0686e 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -3,6 +3,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index 2848a2a91..147b1b2ca 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -1,6 +1,7 @@ // A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/todo.dart index 1922735f5..69923c0f9 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/todo.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_positional_boolean_parameters import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index 9ae43a3eb..0a04b3bb9 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -1,6 +1,7 @@ // A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 30f9cf0fe..bc14dc2b8 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,6 @@ import 'package:flutter/foundation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 3c59ff2da..df714ea54 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -5,6 +5,7 @@ import 'package:collection/collection.dart'; import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; void main() { runApp(const ProviderScope(child: MyApp())); diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart index 225b7f4ad..1c8a38251 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart @@ -1,4 +1,4 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'dropdown.dart'; diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 825df6d0f..3cd8e6878 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ @@ -20,4 +21,4 @@ class HomeView extends ConsumerWidget { ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index 59590fa5b..0880a114a 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index 238d1eaf8..cf052b3e9 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index cc1ea769a..feee2608b 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; final repositoryProvider = Provider((ref) => Repository()); @@ -15,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter kann "ref" dazu benutzen um andere Provider auszulesen diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index 4ed90e7af..620d39d3d 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -1,5 +1,6 @@ // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'reading_counter.dart'; @@ -12,4 +13,4 @@ final anotherProvider = Provider((ref) { print('The counter changed $newCount'); }); // ... -}); \ No newline at end of file +}); diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 066565b67..ec3488a7f 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'reading_counter.dart'; /* SNIPPET START */ @@ -16,7 +17,7 @@ class HomeView extends ConsumerWidget { ref.listen(counterProvider, (int? previousCount, int newCount) { print('The counter changed $newCount'); }); - + return Container(); } -} \ No newline at end of file +} diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index 1c42dd23f..1628a02ec 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -2,13 +2,13 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'reading_counter.dart'; /* SNIPPET START */ -final counterProvider = - StateNotifierProvider(Counter.new); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { const HomeView({super.key}); diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart index 0ebe6a990..059b28e97 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart index 34104aead..95bdab6c5 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ @@ -13,4 +14,4 @@ Widget build(BuildContext context, WidgetRef ref) { onPressed: () => counter.state++, child: const Text('button'), ); -} \ No newline at end of file +} diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart index 5c688ee3f..35ae259c0 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart @@ -1,6 +1,7 @@ // ignore_for_file: omit_local_variable_types import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index d7fc059f6..9f0547f55 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart index 66c630717..94d77b5e3 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart index 256d26f0a..4ca727bed 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart index db1ba949f..3a7cc81fc 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; /* SNIPPET START */ diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index 4e04ebdb7..ac23258a2 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -1,6 +1,7 @@ // A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/todo.dart index 1922735f5..69923c0f9 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/todo.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_positional_boolean_parameters import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index 99efdd26b..c2b762562 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -1,6 +1,7 @@ // Ein Provider, der die aktuelle Seite kontrolliert import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 3f2b4e839..b5d6172ee 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,6 @@ import 'package:flutter/foundation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index d47fb2427..22ca5c5f2 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -5,6 +5,7 @@ import 'package:collection/collection.dart'; import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; void main() { runApp(const ProviderScope(child: MyApp())); diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart index 49d416646..2781895b6 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart @@ -1,4 +1,5 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'dropdown.dart'; diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 825df6d0f..3cd8e6878 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ @@ -20,4 +21,4 @@ class HomeView extends ConsumerWidget { ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index 91b877290..6d7df059f 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart index 75543d461..cff9d8609 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart @@ -1,3 +1,4 @@ +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart index df5878594..03642c727 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; final repositoryProvider = Provider((ref) => Repository()); @@ -15,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter可以使用“ref”读取其他provider diff --git a/website/static/snippets/combine.dart b/website/static/snippets/combine.dart index 051941774..1e3a25b04 100644 --- a/website/static/snippets/combine.dart +++ b/website/static/snippets/combine.dart @@ -1,6 +1,6 @@ // ignore_for_file: omit_local_variable_types -import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'combine.g.dart'; From 94878d51e67cd5f0660be71c67f151d9639b817d Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 11:29:56 +0100 Subject: [PATCH 179/387] Run riverpod_lint on website --- examples/counter/pubspec_overrides.yaml | 5 +++-- website/analysis_options.yaml | 6 ++---- website/pubspec.yaml | 3 +++ website/pubspec_overrides.yaml | 5 +++++ 4 files changed, 13 insertions(+), 6 deletions(-) diff --git a/examples/counter/pubspec_overrides.yaml b/examples/counter/pubspec_overrides.yaml index d1006257e..1e5dc912a 100644 --- a/examples/counter/pubspec_overrides.yaml +++ b/examples/counter/pubspec_overrides.yaml @@ -14,5 +14,6 @@ dependency_overrides: path: ../../packages/riverpod_annotation riverpod_generator: path: ../../packages/riverpod_generator - # https://github.com/vegardit/dart-hotreloader/issues/14 - vm_service: ">=8.0.0 <14.0.0" \ No newline at end of file + + # hotreloader issue + vm_service: ^14.0.0 diff --git a/website/analysis_options.yaml b/website/analysis_options.yaml index 94fd46be7..3d417ff37 100644 --- a/website/analysis_options.yaml +++ b/website/analysis_options.yaml @@ -4,7 +4,5 @@ analyzer: - build/** errors: todo: ignore - -linter: - rules: - require_trailing_commas: false + plugins: + - custom_lint diff --git a/website/pubspec.yaml b/website/pubspec.yaml index daf9e9d3f..9c8e77974 100644 --- a/website/pubspec.yaml +++ b/website/pubspec.yaml @@ -25,12 +25,15 @@ dependencies: dev_dependencies: build_runner: + custom_lint: ^0.5.11 flutter_test: sdk: flutter freezed: ^2.2.0 http: ^0.13.5 json_serializable: ^6.6.1 riverpod_generator: + riverpod_lint: + path: ../packages/riverpod_lint flutter: uses-material-design: true diff --git a/website/pubspec_overrides.yaml b/website/pubspec_overrides.yaml index d1866eb35..2814084ad 100644 --- a/website/pubspec_overrides.yaml +++ b/website/pubspec_overrides.yaml @@ -12,7 +12,12 @@ dependency_overrides: path: ../packages/riverpod_generator riverpod_analyzer_utils: path: ../packages/riverpod_analyzer_utils + riverpod_lint: + path: ../packages/riverpod_lint ## Needed due to Flutter not supporting 6.0.0 yet analyzer: ^6.0.0 analyzer_plugin: ^0.11.3 + + # Hotreloader issue + vm_service: ^14.0.0 \ No newline at end of file From 579ec75c4239060b95d391f84a2c63a6f4caada7 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 11:30:00 +0100 Subject: [PATCH 180/387] Fix missing imports --- website/docs/case_studies/cancel/extension.dart | 2 +- .../docs/case_studies/pull_to_refresh/fetch_activity/raw.dart | 1 - .../combining_provider_states/characters_provider/codegen.dart | 1 - .../filtered_todo_list_provider/codegen.dart | 1 - website/docs/essentials/auto_dispose/cache_for_usage/raw.dart | 1 - website/docs/essentials/auto_dispose/keep_alive/raw.dart | 1 - .../docs/essentials/auto_dispose/on_dispose_example/raw.dart | 1 - website/docs/essentials/auto_dispose/raw_auto_dispose.dart | 1 - .../docs/essentials/combining_requests/functional_ref/raw.dart | 1 - .../docs/essentials/combining_requests/listen_example/raw.dart | 1 - .../docs/essentials/combining_requests/notifier_ref/raw.dart | 1 - .../docs/essentials/combining_requests/read_example/raw.dart | 1 - .../docs/essentials/combining_requests/watch_example/raw.dart | 1 - .../essentials/combining_requests/watch_placement/raw.dart | 1 - .../essentials/websockets_sync/change_notifier_provider.dart | 1 - .../websockets_sync/shared_pipe_change_notifier.dart | 3 +-- website/docs/from_provider/family/raw.dart | 1 - website/docs/from_provider/motivation/async_values/raw.dart | 1 - website/docs/from_provider/motivation/auto_dispose/raw.dart | 1 - website/docs/from_provider/motivation/combine/raw.dart | 1 - website/docs/from_provider/motivation/same_type/raw.dart | 1 - website/docs/migration/from_change_notifier/old.dart | 1 - .../docs/migration/from_state_notifier/add_listener/raw.dart | 1 - website/docs/migration/from_state_notifier/build_init/raw.dart | 1 - .../migration/from_state_notifier/from_state_provider/raw.dart | 1 - .../migration/from_state_notifier/from_state_provider_old.dart | 1 - .../docs/migration/from_state_notifier/old_lifecycles/raw.dart | 1 - .../from_state_notifier/old_lifecycles_final/raw.dart | 1 - website/docs/providers/change_notifier_provider/todos.dart | 1 - website/docs/providers/state_provider/sort_provider.dart | 1 - .../current/providers/state_provider/sort_provider.dart | 1 - .../current/providers/provider/optimized_previous_button.dart | 1 + .../current/providers/provider/todo.dart | 1 + .../providers/provider/unoptimized_previous_button.dart | 1 + .../current/providers/state_notifier_provider/todos.dart | 1 + .../current/providers/state_provider/full.dart | 1 + .../current/providers/state_provider/sort_provider.dart | 2 +- .../current/providers/state_provider/update_read_once.dart | 1 + .../current/providers/state_provider/update_read_twice.dart | 1 + .../current/concepts/async_initialization.dart | 1 + .../current/concepts/dialog_scope.dart | 1 + .../current/concepts/provider_observer_logger.dart | 1 + .../current/concepts/reading_counter.dart | 3 ++- .../current/concepts/reading_listen.dart | 1 + .../current/concepts/reading_listen_build.dart | 2 ++ .../current/concepts/reading_read.dart | 1 + .../current/concepts/reading_read_build.dart | 1 + .../current/concepts/reading_read_notifier_build.dart | 1 + .../current/concepts/reading_watch.dart | 1 + .../current/concepts/reading_watch_build.dart | 1 + .../current/concepts/reading_watch_notifier_build.dart | 1 + .../current/concepts/subtree_scope.dart | 1 + .../current/concepts/theme_scope.dart | 1 + .../current/providers/change_notifier_provider/todos.dart | 2 +- .../current/providers/provider/optimized_previous_button.dart | 1 + .../current/providers/provider/todo.dart | 1 + .../providers/provider/unoptimized_previous_button.dart | 1 + .../current/providers/state_notifier_provider/todos.dart | 1 + .../current/providers/state_provider/full.dart | 1 + .../current/providers/state_provider/sort_provider.dart | 2 +- .../current/providers/state_provider/update_read_once.dart | 1 + .../current/providers/state_provider/update_read_twice.dart | 1 + .../current/concepts/provider_observer_logger.dart | 1 + .../current/concepts/reading_counter.dart | 3 ++- .../current/concepts/reading_listen.dart | 1 + .../current/concepts/reading_listen_build.dart | 2 ++ .../current/concepts/reading_read.dart | 1 + .../current/concepts/reading_read_build.dart | 1 + .../current/concepts/reading_read_notifier_build.dart | 1 + .../current/concepts/reading_watch.dart | 1 + .../current/concepts/reading_watch_build.dart | 1 + .../current/concepts/reading_watch_notifier_build.dart | 1 + .../current/cookbooks/testing_original_test_dart.dart | 1 + .../current/cookbooks/testing_original_test_flutter.dart | 1 + .../current/providers/provider/optimized_previous_button.dart | 1 + .../current/providers/provider/todo.dart | 1 + .../providers/provider/unoptimized_previous_button.dart | 1 + .../current/providers/state_notifier_provider/todos.dart | 1 + .../current/providers/state_provider/full.dart | 1 + .../current/providers/state_provider/sort_provider.dart | 2 +- .../current/providers/state_provider/update_read_twice.dart | 1 + .../current/concepts/provider_observer_logger.dart | 1 + .../current/concepts/reading_counter.dart | 3 ++- .../current/concepts/reading_listen.dart | 1 + .../current/concepts/reading_listen_build.dart | 2 ++ .../current/concepts/reading_read.dart | 1 + .../current/concepts/reading_read_build.dart | 1 + .../current/concepts/reading_read_notifier_build.dart | 1 + .../current/concepts/reading_watch.dart | 1 + .../current/concepts/reading_watch_build.dart | 1 + .../current/concepts/reading_watch_notifier_build.dart | 1 + .../current/cookbooks/testing_original_test_dart.dart | 1 + .../current/cookbooks/testing_original_test_flutter.dart | 1 + .../current/providers/change_notifier_provider/todos.dart | 2 +- .../current/providers/provider/optimized_previous_button.dart | 1 + .../current/providers/provider/todo.dart | 1 + .../providers/provider/unoptimized_previous_button.dart | 1 + .../current/providers/state_notifier_provider/todos.dart | 1 + .../current/providers/state_provider/full.dart | 1 + .../current/providers/state_provider/sort_provider.dart | 2 +- .../current/providers/state_provider/update_read_once.dart | 1 + .../current/providers/state_provider/update_read_twice.dart | 1 + .../current/concepts/provider_observer_logger.dart | 1 + .../current/concepts/reading_counter.dart | 3 ++- .../current/concepts/reading_listen.dart | 1 + .../current/concepts/reading_listen_build.dart | 2 ++ .../current/concepts/reading_read.dart | 1 + .../current/concepts/reading_read_build.dart | 1 + .../current/concepts/reading_read_notifier_build.dart | 1 + .../current/concepts/reading_watch.dart | 1 + .../current/concepts/reading_watch_build.dart | 1 + .../current/concepts/reading_watch_notifier_build.dart | 1 + .../current/cookbooks/testing_original_test_dart.dart | 1 + .../current/cookbooks/testing_original_test_flutter.dart | 1 + .../current/providers/change_notifier_provider/todos.dart | 2 +- .../current/providers/provider/optimized_previous_button.dart | 1 + .../current/providers/provider/todo.dart | 1 + .../providers/provider/unoptimized_previous_button.dart | 1 + .../current/providers/state_notifier_provider/todos.dart | 1 + .../current/providers/state_provider/full.dart | 1 + .../current/providers/state_provider/sort_provider.dart | 2 +- .../current/providers/state_provider/update_read_once.dart | 1 + .../current/providers/state_provider/update_read_twice.dart | 1 + .../current/concepts/provider_observer_logger.dart | 1 + .../current/concepts/reading_counter.dart | 3 ++- .../current/concepts/reading_listen.dart | 1 + .../current/concepts/reading_listen_build.dart | 2 ++ .../current/concepts/reading_read.dart | 1 + .../current/concepts/reading_read_build.dart | 1 + .../current/concepts/reading_read_notifier_build.dart | 1 + .../current/concepts/reading_watch.dart | 1 + .../current/concepts/reading_watch_build.dart | 1 + .../current/concepts/reading_watch_notifier_build.dart | 1 + .../current/cookbooks/testing_original_test_dart.dart | 1 + .../current/cookbooks/testing_original_test_flutter.dart | 1 + .../current/providers/change_notifier_provider/todos.dart | 2 +- .../current/providers/provider/optimized_previous_button.dart | 1 + .../current/providers/provider/todo.dart | 1 + .../providers/provider/unoptimized_previous_button.dart | 1 + .../current/providers/state_notifier_provider/todos.dart | 1 + .../current/providers/state_provider/full.dart | 1 + .../current/providers/state_provider/sort_provider.dart | 2 +- .../current/providers/state_provider/update_read_once.dart | 1 + .../current/providers/state_provider/update_read_twice.dart | 1 + .../current/concepts/reading/listen_build/raw.dart | 2 ++ .../current/concepts/reading/read/raw.dart | 1 + .../current/concepts/reading/read_build/raw.dart | 1 + .../current/concepts/reading/read_notifier_build/raw.dart | 1 + .../current/concepts/reading/watch/raw.dart | 1 + .../current/concepts/reading/watch_build/raw.dart | 1 + .../current/concepts/reading/watch_notifier_build/raw.dart | 1 + .../current/providers/change_notifier_provider/todos.dart | 2 +- .../providers/provider/optimized_previous_button/raw.dart | 1 + .../current/providers/provider/todo/raw.dart | 1 + .../providers/provider/unoptimized_previous_button/raw.dart | 1 + .../current/providers/state_notifier_provider/todos.dart | 1 + .../current/providers/state_provider/full.dart | 1 + .../current/providers/state_provider/sort_provider.dart | 2 +- .../current/providers/state_provider/update_read_once.dart | 1 + .../current/providers/state_provider/update_read_twice.dart | 1 + 160 files changed, 142 insertions(+), 49 deletions(-) diff --git a/website/docs/case_studies/cancel/extension.dart b/website/docs/case_studies/cancel/extension.dart index a45355d7e..7af2f1489 100644 --- a/website/docs/case_studies/cancel/extension.dart +++ b/website/docs/case_studies/cancel/extension.dart @@ -2,7 +2,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; /* SNIPPET START */ -extension DebounceAndCancelExtension on Ref { +extension DebounceAndCancelExtension on Ref { /// Wait for [duration] (defaults to 500ms), and then return a [http.Client] /// which can be used to make a request. /// diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/raw.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/raw.dart index c4498fe3e..04de1232b 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/raw.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/raw.dart @@ -2,7 +2,6 @@ import 'dart:convert'; import 'package:http/http.dart' as http; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../activity/raw.dart'; diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart index 5afc50017..8d6e7389e 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart @@ -1,5 +1,4 @@ import 'package:dio/dio.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart index 0eaae7c1e..6de519eeb 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/raw.dart b/website/docs/essentials/auto_dispose/cache_for_usage/raw.dart index 9f15f5802..f0d6490ff 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/raw.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/raw.dart @@ -2,7 +2,6 @@ import 'package:http/http.dart' as http; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../cache_for_extension.dart'; diff --git a/website/docs/essentials/auto_dispose/keep_alive/raw.dart b/website/docs/essentials/auto_dispose/keep_alive/raw.dart index a6a31d8db..75e73c3b7 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/raw.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/raw.dart @@ -2,7 +2,6 @@ import 'package:http/http.dart' as http; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ final provider = FutureProvider.autoDispose((ref) async { diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/raw.dart b/website/docs/essentials/auto_dispose/on_dispose_example/raw.dart index dff812ea0..6b5a7ade1 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/raw.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/raw.dart @@ -3,7 +3,6 @@ import 'dart:async'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ final provider = StreamProvider((ref) { diff --git a/website/docs/essentials/auto_dispose/raw_auto_dispose.dart b/website/docs/essentials/auto_dispose/raw_auto_dispose.dart index c863fcffd..de83b5c78 100644 --- a/website/docs/essentials/auto_dispose/raw_auto_dispose.dart +++ b/website/docs/essentials/auto_dispose/raw_auto_dispose.dart @@ -1,5 +1,4 @@ import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ // We can specify autoDispose to enable automatic state destruction. diff --git a/website/docs/essentials/combining_requests/functional_ref/raw.dart b/website/docs/essentials/combining_requests/functional_ref/raw.dart index d49ee63fa..f92fd1bc2 100644 --- a/website/docs/essentials/combining_requests/functional_ref/raw.dart +++ b/website/docs/essentials/combining_requests/functional_ref/raw.dart @@ -1,7 +1,6 @@ // ignore_for_file: unused_local_variable import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; final otherProvider = Provider((ref) => 0); diff --git a/website/docs/essentials/combining_requests/listen_example/raw.dart b/website/docs/essentials/combining_requests/listen_example/raw.dart index 1ed959e92..334f73b5a 100644 --- a/website/docs/essentials/combining_requests/listen_example/raw.dart +++ b/website/docs/essentials/combining_requests/listen_example/raw.dart @@ -1,6 +1,5 @@ // ignore_for_file: unused_local_variable, avoid_print import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; final otherProvider = Provider((ref) => 0); diff --git a/website/docs/essentials/combining_requests/notifier_ref/raw.dart b/website/docs/essentials/combining_requests/notifier_ref/raw.dart index 50674b120..c0602a6fc 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/raw.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/raw.dart @@ -1,7 +1,6 @@ // ignore_for_file: unused_local_variable import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; final otherProvider = Provider((ref) => 0); diff --git a/website/docs/essentials/combining_requests/read_example/raw.dart b/website/docs/essentials/combining_requests/read_example/raw.dart index c800827b6..4735ea632 100644 --- a/website/docs/essentials/combining_requests/read_example/raw.dart +++ b/website/docs/essentials/combining_requests/read_example/raw.dart @@ -1,7 +1,6 @@ // ignore_for_file: unused_local_variable import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; final otherProvider = Provider((ref) => 0); diff --git a/website/docs/essentials/combining_requests/watch_example/raw.dart b/website/docs/essentials/combining_requests/watch_example/raw.dart index a9a6ab519..0d36e859e 100644 --- a/website/docs/essentials/combining_requests/watch_example/raw.dart +++ b/website/docs/essentials/combining_requests/watch_example/raw.dart @@ -4,7 +4,6 @@ import 'dart:convert'; import 'package:http/http.dart' as http; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; final otherProvider = Provider((ref) => 0); diff --git a/website/docs/essentials/combining_requests/watch_placement/raw.dart b/website/docs/essentials/combining_requests/watch_placement/raw.dart index 163f181bb..6bec34337 100644 --- a/website/docs/essentials/combining_requests/watch_placement/raw.dart +++ b/website/docs/essentials/combining_requests/watch_placement/raw.dart @@ -2,7 +2,6 @@ import 'package:flutter/foundation.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; final otherProvider = Provider((ref) => 0); diff --git a/website/docs/essentials/websockets_sync/change_notifier_provider.dart b/website/docs/essentials/websockets_sync/change_notifier_provider.dart index b2e23e45d..332940a22 100644 --- a/website/docs/essentials/websockets_sync/change_notifier_provider.dart +++ b/website/docs/essentials/websockets_sync/change_notifier_provider.dart @@ -1,7 +1,6 @@ // ignore_for_file: omit_local_variable_types import 'package:flutter/widgets.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart index e6ad4ab7f..2e7af1e00 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart @@ -1,13 +1,12 @@ // ignore_for_file: omit_local_variable_types import 'package:flutter/widgets.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'shared_pipe_change_notifier.g.dart'; /* SNIPPET START */ -extension on Ref { +extension on Ref { // We can move the previous logic to a Ref extension. // This enables reusing the logic between providers T disposeAndListenChangeNotifier(T notifier) { diff --git a/website/docs/from_provider/family/raw.dart b/website/docs/from_provider/family/raw.dart index 4f83a7e4e..e1977b568 100644 --- a/website/docs/from_provider/family/raw.dart +++ b/website/docs/from_provider/family/raw.dart @@ -2,7 +2,6 @@ import 'dart:math'; import 'package:freezed_annotation/freezed_annotation.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; @immutable abstract class Equatable { diff --git a/website/docs/from_provider/motivation/async_values/raw.dart b/website/docs/from_provider/motivation/async_values/raw.dart index 0fcb13614..f21a954e5 100644 --- a/website/docs/from_provider/motivation/async_values/raw.dart +++ b/website/docs/from_provider/motivation/async_values/raw.dart @@ -1,7 +1,6 @@ import 'package:collection/collection.dart'; import 'package:dio/dio.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../helpers/item.dart'; import '../../helpers/json.dart'; diff --git a/website/docs/from_provider/motivation/auto_dispose/raw.dart b/website/docs/from_provider/motivation/auto_dispose/raw.dart index b69b74919..c206757b3 100644 --- a/website/docs/from_provider/motivation/auto_dispose/raw.dart +++ b/website/docs/from_provider/motivation/auto_dispose/raw.dart @@ -1,7 +1,6 @@ import 'dart:math'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ diff --git a/website/docs/from_provider/motivation/combine/raw.dart b/website/docs/from_provider/motivation/combine/raw.dart index 28999af75..1b8412dd0 100644 --- a/website/docs/from_provider/motivation/combine/raw.dart +++ b/website/docs/from_provider/motivation/combine/raw.dart @@ -1,7 +1,6 @@ import 'dart:math'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ diff --git a/website/docs/from_provider/motivation/same_type/raw.dart b/website/docs/from_provider/motivation/same_type/raw.dart index 22c2afa2a..1a2456978 100644 --- a/website/docs/from_provider/motivation/same_type/raw.dart +++ b/website/docs/from_provider/motivation/same_type/raw.dart @@ -1,6 +1,5 @@ import 'package:collection/collection.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../helpers/item.dart'; diff --git a/website/docs/migration/from_change_notifier/old.dart b/website/docs/migration/from_change_notifier/old.dart index c4f1970cc..932804174 100644 --- a/website/docs/migration/from_change_notifier/old.dart +++ b/website/docs/migration/from_change_notifier/old.dart @@ -1,7 +1,6 @@ // ignore_for_file: avoid_print, avoid_unused_constructor_parameters import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; class Todo { diff --git a/website/docs/migration/from_state_notifier/add_listener/raw.dart b/website/docs/migration/from_state_notifier/add_listener/raw.dart index f4c1c627b..d032a4c2d 100644 --- a/website/docs/migration/from_state_notifier/add_listener/raw.dart +++ b/website/docs/migration/from_state_notifier/add_listener/raw.dart @@ -2,7 +2,6 @@ import 'package:flutter/material.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ class MyNotifier extends Notifier { diff --git a/website/docs/migration/from_state_notifier/build_init/raw.dart b/website/docs/migration/from_state_notifier/build_init/raw.dart index 0ba8eebed..9456a84da 100644 --- a/website/docs/migration/from_state_notifier/build_init/raw.dart +++ b/website/docs/migration/from_state_notifier/build_init/raw.dart @@ -1,7 +1,6 @@ // ignore_for_file: avoid_print import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ class CounterNotifier extends Notifier { diff --git a/website/docs/migration/from_state_notifier/from_state_provider/raw.dart b/website/docs/migration/from_state_notifier/from_state_provider/raw.dart index 8f7dc85a4..ee7eb761e 100644 --- a/website/docs/migration/from_state_notifier/from_state_provider/raw.dart +++ b/website/docs/migration/from_state_notifier/from_state_provider/raw.dart @@ -1,5 +1,4 @@ import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; /* SNIPPET START */ class CounterNotifier extends Notifier { diff --git a/website/docs/migration/from_state_notifier/from_state_provider_old.dart b/website/docs/migration/from_state_notifier/from_state_provider_old.dart index 2f30f8ef0..4b4ec6aa4 100644 --- a/website/docs/migration/from_state_notifier/from_state_provider_old.dart +++ b/website/docs/migration/from_state_notifier/from_state_provider_old.dart @@ -1,5 +1,4 @@ import 'package:flutter_riverpod/legacy.dart'; -import 'package:riverpod/riverpod.dart'; /* SNIPPET START */ final counterProvider = StateProvider((ref) { diff --git a/website/docs/migration/from_state_notifier/old_lifecycles/raw.dart b/website/docs/migration/from_state_notifier/old_lifecycles/raw.dart index 953be404a..92e6b49f2 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles/raw.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles/raw.dart @@ -2,7 +2,6 @@ import 'dart:async'; import 'package:dio/dio.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../utils.dart'; diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/raw.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/raw.dart index 1d49268d0..e394e83f6 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/raw.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/raw.dart @@ -2,7 +2,6 @@ import 'dart:async'; import 'package:dio/dio.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../utils.dart'; diff --git a/website/docs/providers/change_notifier_provider/todos.dart b/website/docs/providers/change_notifier_provider/todos.dart index 901b73abd..a88c25c71 100644 --- a/website/docs/providers/change_notifier_provider/todos.dart +++ b/website/docs/providers/change_notifier_provider/todos.dart @@ -1,5 +1,4 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/docs/providers/state_provider/sort_provider.dart b/website/docs/providers/state_provider/sort_provider.dart index 63d080dd8..d42eb8cc5 100644 --- a/website/docs/providers/state_provider/sort_provider.dart +++ b/website/docs/providers/state_provider/sort_provider.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; import 'dropdown.dart'; diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart index 2781895b6..de83f8cee 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; import 'dropdown.dart'; diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index 397c8dc1b..3ac1127d0 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -1,6 +1,7 @@ // A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/todo.dart index 3770a91d8..9adb03185 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/todo.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_positional_boolean_parameters import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index 24f11a845..bfab931e1 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -1,6 +1,7 @@ // A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index bf6761114..22d3437df 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,6 @@ import 'package:flutter/foundation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 283d4c4bd..41a3ec1dc 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -5,6 +5,7 @@ import 'package:collection/collection.dart'; import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; void main() { runApp(const ProviderScope(child: MyApp())); diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart index 6a1821d68..c3bccd1e8 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart @@ -1,4 +1,4 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'dropdown.dart'; diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 825df6d0f..dbab3d32e 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index b60695d94..c6c124a45 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart index 8fcbf1d1a..4ef6f927c 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:shared_preferences/shared_preferences.dart'; class LoadingScreen extends StatelessWidget { diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart index e70c72515..e85d2abca 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index 71ccc1557..52e334029 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index 8b479fe48..9c7c301a1 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; final repositoryProvider = Provider((ref) => Repository()); @@ -15,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter peut utiliser le "ref" pour lire d'autres providers diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index 4ed90e7af..b06e75410 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print import 'package:riverpod/riverpod.dart'; diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 066565b67..51a41e2c6 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -2,6 +2,8 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + import 'reading_counter.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index 23a1a9a97..5282ba004 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'reading_counter.dart'; diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart index c51b7cb52..7b896f699 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart index 34104aead..39d5b6e70 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart index 545d7832e..89140b230 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart @@ -1,6 +1,7 @@ // ignore_for_file: omit_local_variable_types import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index e87b2436b..a4d8dfb54 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart index 66c630717..94d77b5e3 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart index cb4fc4046..266c1fc64 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart index af60e2a4e..90f3aca5c 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart index a07051956..b043e8744 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart @@ -1,5 +1,5 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index 0ca446615..496a6a5e7 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -1,6 +1,7 @@ // A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/todo.dart index 4e41c2c2b..5c17c4682 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/todo.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_positional_boolean_parameters import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index 9a60b44fc..3ed04fbbf 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -1,6 +1,7 @@ // A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index d22ba9169..dbc3246f9 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,6 @@ import 'package:flutter/foundation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index bb48b1107..ceaaeb4f1 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -5,6 +5,7 @@ import 'package:collection/collection.dart'; import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; void main() { runApp(const ProviderScope(child: MyApp())); diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart index 38f28bb13..0d5ff387e 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart @@ -1,4 +1,4 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'dropdown.dart'; diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 825df6d0f..dbab3d32e 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index 37d6d4a19..4a039a7ef 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index fbca504d5..e5ccc8f67 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index 60f50c878..4aa3a0d47 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; final repositoryProvider = Provider((ref) => Repository()); @@ -15,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter può usare "ref" per leggere altri provider diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index 4ed90e7af..b06e75410 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print import 'package:riverpod/riverpod.dart'; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 066565b67..51a41e2c6 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -2,6 +2,8 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + import 'reading_counter.dart'; /* SNIPPET START */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index f6e0d4112..8d84480d5 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'reading_counter.dart'; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart index 4308f6162..377f230a8 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart index 34104aead..39d5b6e70 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart index 3f9faba6d..5532608ea 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart @@ -1,6 +1,7 @@ // ignore_for_file: omit_local_variable_types import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index 9976365c8..54df66390 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart index 66c630717..94d77b5e3 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart index 531e2682b..e6fada862 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart index bb0bfab5f..012ae1c80 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; /* SNIPPET START */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index a9a7d2469..36be0acf2 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -1,6 +1,7 @@ // Un provider che controlla la pagina corrente import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo.dart index 04fecf970..c686eb47d 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_positional_boolean_parameters import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index f8a4596df..af740d653 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -1,6 +1,7 @@ // Un provider che controlla la pagina corrente import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 997d9d5f5..5f9a8f35a 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,6 @@ import 'package:flutter/foundation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 966f4dec3..837bcf153 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -5,6 +5,7 @@ import 'package:collection/collection.dart'; import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; void main() { runApp(const ProviderScope(child: MyApp())); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart index 259a89b1c..3a777ba11 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart @@ -1,4 +1,4 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'dropdown.dart'; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index e3896c225..66cf7ccda 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index d6e0a046d..610ec29b1 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index 044150894..3c02b890e 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; final repositoryProvider = Provider((ref) => Repository()); @@ -15,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter は `ref` を使って他のプロバイダーを利用することができる diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index 4ed90e7af..b06e75410 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print import 'package:riverpod/riverpod.dart'; diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 066565b67..51a41e2c6 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -2,6 +2,8 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + import 'reading_counter.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index e9afa56c4..946a555e1 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'reading_counter.dart'; diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart index 6c3b9cd94..0b00ae81b 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart index 34104aead..39d5b6e70 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart index ff93df1b5..c5f778f4f 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart @@ -1,6 +1,7 @@ // ignore_for_file: omit_local_variable_types import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index fc1744463..b72c8defb 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart index 66c630717..94d77b5e3 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart index 59e077459..b5e5b8024 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart index 0cce126ca..1d5d5d444 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart index 2dc19b955..fe364b71c 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart @@ -1,5 +1,5 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index 58ed9ed3e..79c41f21b 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -1,6 +1,7 @@ // A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/todo.dart index 9f400c8e9..37aaf7241 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/todo.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_positional_boolean_parameters import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index 0f1f4a503..6458b031f 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -1,6 +1,7 @@ // A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index f57f590f8..1bc97b848 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,6 @@ import 'package:flutter/foundation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 283d4c4bd..41a3ec1dc 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -5,6 +5,7 @@ import 'package:collection/collection.dart'; import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; void main() { runApp(const ProviderScope(child: MyApp())); diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart index d95c25eca..44be1181f 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart @@ -1,4 +1,4 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'dropdown.dart'; diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 825df6d0f..dbab3d32e 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index 645be50ee..c652e490d 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index 1574317f9..0bed9e8cc 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index cdab5c7e2..122acb3a0 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; final repositoryProvider = Provider((ref) => Repository()); @@ -15,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter 클래스는 다른 프로바이더를 읽기 위해 "ref"를 사용할 수 있습니다. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index 4ed90e7af..b06e75410 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print import 'package:riverpod/riverpod.dart'; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 066565b67..51a41e2c6 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -2,6 +2,8 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + import 'reading_counter.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index b3573a256..acf5898e3 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'reading_counter.dart'; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart index 8f2ba0bd6..52098b6fd 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart index 34104aead..39d5b6e70 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart index 9fef0a435..bf82e165d 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart @@ -1,6 +1,7 @@ // ignore_for_file: omit_local_variable_types import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index 6ace027ca..472b04626 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart index 66c630717..94d77b5e3 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart index 215bb7951..2e85fdcd2 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart index 60b545a5d..973da6f86 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart index c181f8fd7..219de4b0a 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart @@ -1,5 +1,5 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index b7c497a43..3582930ca 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -1,6 +1,7 @@ // A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo.dart index 74a2e6609..58c675162 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_positional_boolean_parameters import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index e5f56b568..abec2c57c 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -1,6 +1,7 @@ // 현재 페이지를 제어하는 프로바이더 import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 1318bbcbf..13049bd42 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,6 @@ import 'package:flutter/foundation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 4c598055f..28eb1f863 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -5,6 +5,7 @@ import 'package:collection/collection.dart'; import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; void main() { runApp(const ProviderScope(child: MyApp())); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart index 60a5f60c1..d42eb8cc5 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart @@ -1,4 +1,4 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'dropdown.dart'; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 825df6d0f..dbab3d32e 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index c029e0730..172721f1a 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index da15a3a50..f1c5065a8 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index ac9db13a0..a92076a79 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; final repositoryProvider = Provider((ref) => Repository()); @@ -15,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter может использовать "ref" для чтения других провайдеров diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index 4ed90e7af..b06e75410 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print import 'package:riverpod/riverpod.dart'; diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 066565b67..51a41e2c6 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -2,6 +2,8 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + import 'reading_counter.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index 957ccc2cc..5b5adfc31 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'reading_counter.dart'; diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart index 342131974..1aaa8e8ea 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart index 34104aead..39d5b6e70 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart index e7724c3a8..46065cbaa 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart @@ -1,6 +1,7 @@ // ignore_for_file: omit_local_variable_types import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index 779ffb0a1..9c56970ad 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart index 66c630717..94d77b5e3 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart index 7967027a3..62f7185d8 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart index a7d623a5c..9b63aa012 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'package:flutter_test/flutter_test.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart index 5745f2fde..5df6b1ba1 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart @@ -1,5 +1,5 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index f1a86304d..f52da7f12 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -1,6 +1,7 @@ // Провайдер, контролирующий текущую страницу import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/todo.dart index bef9aabd1..4da01abb1 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/todo.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_positional_boolean_parameters import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index 106bdd5af..ecaab8cec 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -1,6 +1,7 @@ // Провайдер, контролирующий текущую страницу import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index a6d9c8652..51dff035d 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,6 @@ import 'package:flutter/foundation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index f96b8f7d3..1431292c4 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -5,6 +5,7 @@ import 'package:collection/collection.dart'; import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; void main() { runApp(const ProviderScope(child: MyApp())); diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart index 695e000a9..af59b1a1e 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart @@ -1,4 +1,4 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'dropdown.dart'; diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 825df6d0f..dbab3d32e 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index 80c4b2505..9f884228b 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw.dart index e59ddaf57..34921310e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw.dart @@ -2,6 +2,8 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + import '../counter/raw.dart'; /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart index f191278b0..6478ae609 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import '../counter/raw.dart'; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart index 51a2a7ca3..f79b28ca9 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/raw.dart index 0ec5b5958..95bdab6c5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/raw.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart index 17b249eb2..7a9fe7b85 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart @@ -1,6 +1,7 @@ // ignore_for_file: omit_local_variable_types import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart index 71886bdae..f7cdb0ae5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; enum FilterType { none, diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/raw.dart index 66c630717..94d77b5e3 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/raw.dart @@ -2,6 +2,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart index c181f8fd7..219de4b0a 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart @@ -1,5 +1,5 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart index 01727215d..13af06e5a 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart @@ -1,6 +1,7 @@ // A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart index f8722a998..5ba7906e6 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_positional_boolean_parameters import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart index 9948a72fd..537cd328a 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart @@ -1,6 +1,7 @@ // A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 1318bbcbf..13049bd42 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,6 @@ import 'package:flutter/foundation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 4c598055f..28eb1f863 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -5,6 +5,7 @@ import 'package:collection/collection.dart'; import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; void main() { runApp(const ProviderScope(child: MyApp())); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart index 60a5f60c1..d42eb8cc5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart @@ -1,4 +1,4 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; import 'dropdown.dart'; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index 825df6d0f..dbab3d32e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index c029e0730..172721f1a 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -1,5 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ From d712d123b873390811d0cbc532654b7e21a064d8 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 11:30:30 +0100 Subject: [PATCH 181/387] Fix lints --- website/docs/concepts/about_hooks/hook_and_consumer.dart | 2 +- .../characters_provider/codegen.dart | 2 +- .../combining_provider_states/characters_provider/raw.dart | 2 +- website/docs/concepts/dialog_scope.dart | 2 +- website/docs/concepts/subtree_scope.dart | 2 +- website/docs/concepts/theme_scope.dart | 2 +- website/docs/cookbooks/testing_dart.dart | 2 +- website/docs/cookbooks/testing_flutter.dart | 2 +- website/docs/cookbooks/testing_full.dart | 6 +++--- website/docs/cookbooks/testing_original_test_flutter.dart | 2 +- .../docs/essentials/side_effects/raw/render_add_todo.dart | 2 +- .../essentials/side_effects/raw/render_add_todo_hooks.dart | 2 +- .../from_state_notifier/consumers_dont_change.dart | 2 +- website/docs/providers/provider/todos_consumer.dart | 2 +- website/docs/providers/state_notifier_provider/todos.dart | 2 +- .../docs/providers/state_provider/connected_dropdown.dart | 2 +- .../current/cookbooks/testing_dart.dart | 2 +- .../current/cookbooks/testing_flutter.dart | 2 +- .../current/cookbooks/testing_full.dart | 4 ++-- .../current/cookbooks/testing_original_test_flutter.dart | 2 +- .../current/providers/provider/todos_consumer.dart | 2 +- .../current/providers/state_notifier_provider/todos.dart | 2 +- .../providers/state_provider/connected_dropdown.dart | 2 +- .../current/cookbooks/testing_dart.dart | 2 +- .../current/cookbooks/testing_flutter.dart | 2 +- .../current/cookbooks/testing_full.dart | 4 ++-- .../current/cookbooks/testing_original_test_flutter.dart | 2 +- .../current/providers/provider/todos_consumer.dart | 2 +- .../current/providers/state_notifier_provider/todos.dart | 2 +- .../providers/state_provider/connected_dropdown.dart | 2 +- .../providers/state_provider/connected_dropdown.dart | 2 +- .../current/concepts/dialog_scope.dart | 2 +- .../current/concepts/subtree_scope.dart | 2 +- .../current/concepts/theme_scope.dart | 2 +- .../current/providers/provider/todos_consumer.dart | 2 +- .../providers/state_provider/connected_dropdown.dart | 2 +- .../current/cookbooks/testing_dart.dart | 2 +- .../current/cookbooks/testing_flutter.dart | 2 +- .../current/cookbooks/testing_full.dart | 2 +- .../current/cookbooks/testing_original_test_flutter.dart | 2 +- .../current/providers/provider/todos_consumer.dart | 2 +- .../providers/state_provider/connected_dropdown.dart | 2 +- .../current/cookbooks/testing_dart.dart | 2 +- .../current/cookbooks/testing_flutter.dart | 2 +- .../current/cookbooks/testing_full.dart | 6 +++--- .../current/cookbooks/testing_original_test_flutter.dart | 2 +- .../current/providers/provider/todos_consumer.dart | 2 +- .../providers/state_provider/connected_dropdown.dart | 2 +- .../current/cookbooks/testing_dart.dart | 2 +- .../current/cookbooks/testing_flutter.dart | 2 +- .../current/cookbooks/testing_full.dart | 4 ++-- .../current/cookbooks/testing_original_test_flutter.dart | 2 +- .../providers/future_provider/config_consumer/hooks.dart | 2 +- .../future_provider/config_consumer/hooks_codegen.dart | 2 +- .../current/providers/provider/todos_consumer.dart | 2 +- .../providers/state_provider/connected_dropdown.dart | 2 +- .../current/cookbooks/testing_dart.dart | 2 +- .../current/cookbooks/testing_flutter.dart | 2 +- .../current/cookbooks/testing_full.dart | 6 +++--- .../current/cookbooks/testing_original_test_flutter.dart | 2 +- .../current/providers/provider/todos_consumer.dart | 2 +- .../providers/state_provider/connected_dropdown.dart | 2 +- .../providers/future_provider/config_consumer/hooks.dart | 2 +- .../future_provider/config_consumer/hooks_codegen.dart | 2 +- .../current/providers/provider/todos_consumer.dart | 2 +- .../providers/state_provider/connected_dropdown.dart | 2 +- 66 files changed, 75 insertions(+), 75 deletions(-) diff --git a/website/docs/concepts/about_hooks/hook_and_consumer.dart b/website/docs/concepts/about_hooks/hook_and_consumer.dart index 2c230084a..f9ad71919 100644 --- a/website/docs/concepts/about_hooks/hook_and_consumer.dart +++ b/website/docs/concepts/about_hooks/hook_and_consumer.dart @@ -21,7 +21,7 @@ class Example extends StatelessWidget { final value = ref.watch(myProvider); return Text('Hello $counter $value'); - }); + },); }, ); } diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart index 8d6e7389e..67439d571 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart @@ -23,7 +23,7 @@ Future> characters(CharactersRef ref) async { final search = ref.watch(searchProvider); final configs = await ref.watch(configsProvider.future); final response = await dio.get>>( - '${configs.host}/characters?search=$search'); + '${configs.host}/characters?search=$search',); return response.data!.map(Character.fromJson).toList(); } diff --git a/website/docs/concepts/combining_provider_states/characters_provider/raw.dart b/website/docs/concepts/combining_provider_states/characters_provider/raw.dart index e788cfcb8..57c054dcd 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/raw.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/raw.dart @@ -20,7 +20,7 @@ final charactersProvider = FutureProvider>((ref) async { final search = ref.watch(searchProvider); final configs = await ref.watch(configsProvider.future); final response = await dio.get>>( - '${configs.host}/characters?search=$search'); + '${configs.host}/characters?search=$search',); return response.data!.map(Character.fromJson).toList(); }); diff --git a/website/docs/concepts/dialog_scope.dart b/website/docs/concepts/dialog_scope.dart index e51bdc528..7ecdfa8f1 100644 --- a/website/docs/concepts/dialog_scope.dart +++ b/website/docs/concepts/dialog_scope.dart @@ -44,7 +44,7 @@ class Home extends ConsumerWidget { onPressed: () { ref.read(counterProvider.notifier).state++; }, - )); + ),); } } diff --git a/website/docs/concepts/subtree_scope.dart b/website/docs/concepts/subtree_scope.dart index 4f0d04e0e..31d6bc5bd 100644 --- a/website/docs/concepts/subtree_scope.dart +++ b/website/docs/concepts/subtree_scope.dart @@ -53,7 +53,7 @@ class Home extends ConsumerWidget { // This particular display will use the provider state from the root ProviderScope const CounterDisplay(), ], - )); + ),); } } diff --git a/website/docs/concepts/theme_scope.dart b/website/docs/concepts/theme_scope.dart index c7335582a..ccd34647d 100644 --- a/website/docs/concepts/theme_scope.dart +++ b/website/docs/concepts/theme_scope.dart @@ -44,7 +44,7 @@ class Home extends ConsumerWidget { child: const Text('Increment Count'), ), ], - )); + ),); } } diff --git a/website/docs/cookbooks/testing_dart.dart b/website/docs/cookbooks/testing_dart.dart index 2d25bb8e8..73c643a16 100644 --- a/website/docs/cookbooks/testing_dart.dart +++ b/website/docs/cookbooks/testing_dart.dart @@ -22,7 +22,7 @@ test('override repositoryProvider', () async { // Override the behavior of repositoryProvider to return // FakeRepository instead of Repository. /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), /* highlight-end */ // We do not have to override `todoListProvider`, it will automatically // use the overridden repositoryProvider diff --git a/website/docs/cookbooks/testing_flutter.dart b/website/docs/cookbooks/testing_flutter.dart index 6685a1bdb..650642e95 100644 --- a/website/docs/cookbooks/testing_flutter.dart +++ b/website/docs/cookbooks/testing_flutter.dart @@ -26,7 +26,7 @@ testWidgets('override repositoryProvider', (tester) async { // Override the behavior of repositoryProvider to return // FakeRepository instead of Repository. /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), /* highlight-end */ // We do not have to override `todoListProvider`, it will automatically // use the overridden repositoryProvider diff --git a/website/docs/cookbooks/testing_full.dart b/website/docs/cookbooks/testing_full.dart index 0f79b4ee8..62e7bb2ef 100644 --- a/website/docs/cookbooks/testing_full.dart +++ b/website/docs/cookbooks/testing_full.dart @@ -56,7 +56,7 @@ void main() { await tester.pumpWidget( ProviderScope( overrides: [ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), ], // Our application, which will read from todoListProvider to display the todo-list. // You may extract this into a MyApp widget @@ -70,10 +70,10 @@ void main() { } return ListView( children: [ - for (final todo in todos.asData!.value) TodoItem(todo: todo) + for (final todo in todos.asData!.value) TodoItem(todo: todo), ], ); - }), + },), ), ), ), diff --git a/website/docs/cookbooks/testing_original_test_flutter.dart b/website/docs/cookbooks/testing_original_test_flutter.dart index 3aaac7a9e..a3044da37 100644 --- a/website/docs/cookbooks/testing_original_test_flutter.dart +++ b/website/docs/cookbooks/testing_original_test_flutter.dart @@ -25,7 +25,7 @@ class MyApp extends StatelessWidget { onPressed: () => ref.read(counterProvider.notifier).state++, child: Text('$counter'), ); - }), + },), ); } } diff --git a/website/docs/essentials/side_effects/raw/render_add_todo.dart b/website/docs/essentials/side_effects/raw/render_add_todo.dart index af32f97ee..4dafb6147 100644 --- a/website/docs/essentials/side_effects/raw/render_add_todo.dart +++ b/website/docs/essentials/side_effects/raw/render_add_todo.dart @@ -68,7 +68,7 @@ class _ExampleState extends ConsumerState { if (snapshot.connectionState == ConnectionState.waiting) ...[ const SizedBox(width: 8), const CircularProgressIndicator(), - ] + ], ], ); }, diff --git a/website/docs/essentials/side_effects/raw/render_add_todo_hooks.dart b/website/docs/essentials/side_effects/raw/render_add_todo_hooks.dart index 7fa419228..c80e95dc2 100644 --- a/website/docs/essentials/side_effects/raw/render_add_todo_hooks.dart +++ b/website/docs/essentials/side_effects/raw/render_add_todo_hooks.dart @@ -60,7 +60,7 @@ class Example extends HookConsumerWidget { if (snapshot.connectionState == ConnectionState.waiting) ...[ const SizedBox(width: 8), const CircularProgressIndicator(), - ] + ], ], ); } diff --git a/website/docs/migration/from_state_notifier/consumers_dont_change.dart b/website/docs/migration/from_state_notifier/consumers_dont_change.dart index 7c7c656ee..e358a2e54 100644 --- a/website/docs/migration/from_state_notifier/consumers_dont_change.dart +++ b/website/docs/migration/from_state_notifier/consumers_dont_change.dart @@ -31,7 +31,7 @@ class SomeConsumer extends ConsumerWidget { onPressed: ref.read(counterNotifierProvider.notifier).increment, /* highlight-end */ child: const Text('Count even more!'), - ) + ), ], ); } diff --git a/website/docs/providers/provider/todos_consumer.dart b/website/docs/providers/provider/todos_consumer.dart index 9b93e9185..96471e694 100644 --- a/website/docs/providers/provider/todos_consumer.dart +++ b/website/docs/providers/provider/todos_consumer.dart @@ -13,6 +13,6 @@ Consumer(builder: (context, ref, child) { // TODO show the todos using a ListView/GridView/.../* SKIP */ return Container(); /* SKIP END */ -}); +},); /* SNIPPET END */ } diff --git a/website/docs/providers/state_notifier_provider/todos.dart b/website/docs/providers/state_notifier_provider/todos.dart index c55836e55..b0bf6db9f 100644 --- a/website/docs/providers/state_notifier_provider/todos.dart +++ b/website/docs/providers/state_notifier_provider/todos.dart @@ -9,7 +9,7 @@ import 'package:flutter_riverpod/legacy.dart'; @immutable class Todo { const Todo( - {required this.id, required this.description, required this.completed}); + {required this.id, required this.description, required this.completed,}); // All properties should be `final` on our class. final String id; diff --git a/website/docs/providers/state_provider/connected_dropdown.dart b/website/docs/providers/state_provider/connected_dropdown.dart index 189ff3c6a..31566a52a 100644 --- a/website/docs/providers/state_provider/connected_dropdown.dart +++ b/website/docs/providers/state_provider/connected_dropdown.dart @@ -21,5 +21,5 @@ DropdownButton( ], ), /* SNIPPET END */ - ]); + ],); } diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart index d9f880273..437fafe48 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart @@ -22,7 +22,7 @@ void main() { // repositoryProvider এর আচরণ পরিবর্তন করে // FakeRepository রিটার্ন করবে আসল Repository এর বদলে /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), /* highlight-end */ // আমাদের `todoListProvider` প্রভাইডার ওভাররাইড করার প্রয়োজন নেই, // এটি অটোমেটিকলী ওভাররাইডেন repositoryProvider ব্যবহার করবে diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart index 36ff78123..540d254d5 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -26,7 +26,7 @@ void main() { // repositoryProvider এর আচরণ পরিবর্তন করে // FakeRepository রিটার্ন করবে আসল Repository এর বদলে /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), /* highlight-end */ // আমাদের `todoListProvider` প্রভাইডার ওভাররাইড করার প্রয়োজন নেই, // এটি অটোমেটিকলী ওভাররাইডেন repositoryProvider ব্যবহার করবে diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index 128e211f7..2a4ee4691 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -67,10 +67,10 @@ void main() { } return ListView( children: [ - for (final todo in todos.asData!.value) TodoItem(todo: todo) + for (final todo in todos.asData!.value) TodoItem(todo: todo), ], ); - }), + },), ), ), ), diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart index d4af0686e..581de4cf8 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -25,7 +25,7 @@ class MyApp extends StatelessWidget { onPressed: () => ref.read(counterProvider.notifier).state++, child: Text('$counter'), ); - }), + },), ); } } diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart index 5cb9b7ff4..617958070 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart @@ -13,6 +13,6 @@ Consumer(builder: (context, ref, child) { // TODO show the todos using a ListView/GridView/.../* SKIP */ return Container(); /* SKIP END */ -}); +},); /* SNIPPET END */ } diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index bc14dc2b8..69ca1eaf9 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -9,7 +9,7 @@ import 'package:flutter_riverpod/legacy.dart'; @immutable class Todo { const Todo( - {required this.id, required this.description, required this.completed}); + {required this.id, required this.description, required this.completed,}); // সমস্ত বৈশিষ্ট্য আমাদের ক্লাসে 'final' হওয়া উচিত। final String id; diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart index dc1a2fb01..c6c62662d 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart @@ -20,5 +20,5 @@ Widget build(BuildContext context, WidgetRef ref) { ], ), /* SNIPPET END */ - ]); + ],); } diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart index aa6ab759a..2b0eb7c2b 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart @@ -22,7 +22,7 @@ void main() { // Überschreiben Sie das Verhalten von repositoryProvider, um // FakeRepository anstelle von Repository zurückzugeben. /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), /* highlight-end */ // Wir müssen den `todoListProvider` nicht überschreiben, er wird // automatisch den überschriebenen repositoryProvider verwenden diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart index 58b425278..56280727e 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -26,7 +26,7 @@ void main() { // Überschreiben Sie das Verhalten von repositoryProvider, um // FakeRepository anstelle von Repository zurückzugeben. /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), /* highlight-end */ // Wir müssen den `todoListProvider` nicht überschreiben, er wird // automatisch den überschriebenen repositoryProvider verwenden diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index 4bfe5b24a..a6feb44ba 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -68,10 +68,10 @@ void main() { } return ListView( children: [ - for (final todo in todos.asData!.value) TodoItem(todo: todo) + for (final todo in todos.asData!.value) TodoItem(todo: todo), ], ); - }), + },), ), ), ), diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart index 3a7cc81fc..0996f4110 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -26,7 +26,7 @@ class MyApp extends StatelessWidget { onPressed: () => ref.read(counterProvider.notifier).state++, child: Text('$counter'), ); - }), + },), ); } } diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart index 5cb9b7ff4..617958070 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart @@ -13,6 +13,6 @@ Consumer(builder: (context, ref, child) { // TODO show the todos using a ListView/GridView/.../* SKIP */ return Container(); /* SKIP END */ -}); +},); /* SNIPPET END */ } diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index b5d6172ee..765def566 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -9,7 +9,7 @@ import 'package:flutter_riverpod/legacy.dart'; @immutable class Todo { const Todo( - {required this.id, required this.description, required this.completed}); + {required this.id, required this.description, required this.completed,}); // Alle variablen in unserer Klasse sollten `final` sein. final String id; diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart index f37d6998d..e0f947f73 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart @@ -21,5 +21,5 @@ Widget build(BuildContext context, WidgetRef ref) { ], ), /* SNIPPET END */ - ]); + ],); } diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart index dfe9372f6..e3076af8d 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart @@ -21,5 +21,5 @@ DropdownButton( ], ), /* SNIPPET END */ - ]); + ],); } diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart index e85d2abca..d315c6028 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart @@ -44,7 +44,7 @@ class Home extends ConsumerWidget { onPressed: () { ref.read(counterProvider.notifier).state++; }, - )); + ),); } } diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart index 266c1fc64..0e5fbfc67 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart @@ -54,7 +54,7 @@ class Home extends ConsumerWidget { // Cet affichage particulier utilisera l'état du provider à partir du ProviderScope racine. const CounterDisplay(), ], - )); + ),); } } diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart index 90f3aca5c..f48651071 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart @@ -44,7 +44,7 @@ class Home extends ConsumerWidget { child: const Text('Incrémenter le compteur'), ), ], - )); + ),); } } diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart index a8b63aed3..38801e499 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart @@ -12,6 +12,6 @@ Widget build() { // TODO afficher les todos en utilisant un ListView/GridView/... /* SKIP */ return Container(); /* SKIP END */ - }); + },); /* SNIPPET END */ } diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart index 128337612..b75e1435a 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart @@ -22,5 +22,5 @@ Widget build(BuildContext context, WidgetRef ref) { ], ), /* SNIPPET END */ - ]); + ],); } diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart index 6c297d700..ab3f1ad57 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart @@ -22,7 +22,7 @@ void main() { // Sovrascrive il comportamento di repositoryProvider per restituire // FakeRepository al posto di Repository. /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), /* highlight-end */ // Non dobbiamo sovrascrivere `todoListProvider`, // utilizzerà automaticamente il repositoryProvider sovrascritto diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart index 0b50be457..86e25c917 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -26,7 +26,7 @@ void main() { // Sovrascrive il comportamento di repositoryProvider per restituire // FakeRepository al posto di Repository. /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), /* highlight-end */ // Non dobbiamo sovrascrivere `todoListProvider`, // utilizzerà automaticamente il repositoryProvider sovrascritto diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index ec47bdfed..2919f8570 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -69,7 +69,7 @@ void main() { return ListView( children: [for (final todo in todos.asData!.value) TodoItem(todo: todo)], ); - }), + },), ), ), ), diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart index 012ae1c80..f2c23c05a 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -25,7 +25,7 @@ class MyApp extends StatelessWidget { onPressed: () => ref.read(counterProvider.notifier).state++, child: Text('$counter'), ); - }), + },), ); } } diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart index 96801bb7c..0f5c1d5f7 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart @@ -13,6 +13,6 @@ Widget build() { // TODO mostrare i todo usando ListView/GridView/.../* SKIP */ return Container(); /* SKIP END */ - }); + },); /* SNIPPET END */ } diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart index 163008a66..04728f4aa 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart @@ -20,5 +20,5 @@ Widget build(BuildContext context, WidgetRef ref) { ], ), /* SNIPPET END */ - ]); + ],); } diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart index a8c896a18..bd968a444 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart @@ -22,7 +22,7 @@ test('override repositoryProvider', () async { // repositoryProvider の挙動をオーバーライドして // Repository の代わりに FakeRepository を戻り値とする /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), /* highlight-end */ // `todoListProvider` はオーバーライドされた repositoryProvider を // 自動的に利用することになるため、オーバーライド不要 diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart index 823aa3d30..82b2a65e6 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -26,7 +26,7 @@ testWidgets('override repositoryProvider', (tester) async { // repositoryProvider の挙動をオーバーライドして // Repository の代わりに FakeRepository を戻り値とする /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), /* highlight-end */ // `todoListProvider` はオーバーライドされた repositoryProvider を // 自動的に利用することになるため、オーバーライド不要 diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index ba5140848..4c1dd783c 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -56,7 +56,7 @@ void main() { await tester.pumpWidget( ProviderScope( overrides: [ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), ], // todoListProvider の値を監視して Todo リストを表示するアプリ // 以下を抽出して MyApp ウィジェットとしても可 @@ -70,10 +70,10 @@ void main() { } return ListView( children: [ - for (final todo in todos.asData!.value) TodoItem(todo: todo) + for (final todo in todos.asData!.value) TodoItem(todo: todo), ], ); - }), + },), ), ), ), diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart index 1d5d5d444..7515cacf6 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -25,7 +25,7 @@ class MyApp extends StatelessWidget { onPressed: () => ref.read(counterProvider.notifier).state++, child: Text('$counter'), ); - }), + },), ); } } diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart index 8f81a12cf..a93b55e17 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart @@ -13,6 +13,6 @@ Consumer(builder: (context, ref, child) { // TODO ListView/GridView/... を使って Todo リストを表示する /* SKIP */ return Container(); /* SKIP END */ -}); +},); /* SNIPPET END */ } diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart index 0634004b6..843d03d7e 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart @@ -21,5 +21,5 @@ DropdownButton( ], ), /* SNIPPET END */ - ]); + ],); } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart index ec0c951cf..7605a2f1c 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart @@ -22,7 +22,7 @@ void main() { // repositoryProvider의 행위를 오버라이드하여 // Repository 대신 FakeRepository를 반환합니다. /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), /* highlight-end */ // 오버라이드된 repositoryProvider를 자동적으로 사용하기 때문에 // `todoListProvider`를 override하지 않아도 됩니다. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart index eb475ff23..9c1a90bf5 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -26,7 +26,7 @@ void main() { // repositoryProvider의 행위를 오버라이드하여 // Repository 대신 FakeRepository를 반환합니다. /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), /* highlight-end */ // 오버라이드된 repositoryProvider를 자동적으로 사용하기 때문에 // `todoListProvider`를 override하지 않아도 됩니다. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index 8b290d56d..3a740b01c 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -67,10 +67,10 @@ void main() { } return ListView( children: [ - for (final todo in todos.asData!.value) TodoItem(todo: todo) + for (final todo in todos.asData!.value) TodoItem(todo: todo), ], ); - }), + },), ), ), ), diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart index 973da6f86..c48426a03 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -24,7 +24,7 @@ class MyApp extends StatelessWidget { onPressed: () => ref.read(counterProvider.notifier).state++, child: Text('$counter'), ); - }), + },), ); } } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart index 3f9e2231c..3844b1540 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart @@ -17,6 +17,6 @@ class MyConfiguration extends HookConsumerWidget { data: (config) { return Center(child: Text(config.host)); }, - )); + ),); } } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart index ece077f72..6b2cccbd6 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart @@ -20,6 +20,6 @@ class MyConfiguration extends HookConsumerWidget { data: (config) { return Center(child: Text(config.host)); }, - )); + ),); } } \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart index d3c19dfde..984a3038e 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart @@ -13,6 +13,6 @@ Widget build() { // TODO a ListView/GridView/...등을 사용하여 todos를 표시하기/* SKIP */ return Container(); /* SKIP END */ - }); + },); /* SNIPPET END */ } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart index 189ff3c6a..31566a52a 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart @@ -21,5 +21,5 @@ DropdownButton( ], ), /* SNIPPET END */ - ]); + ],); } diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart index 5b32fecad..51143123b 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart @@ -22,7 +22,7 @@ test('override repositoryProvider', () async { // Переопределяем поведение repositoryProvider, чтобы он // возвращал FakeRepository вместо Repository. /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), /* highlight-end */ // Нам не нужно переопределять `todoListProvider`. // Он автоматически будет использовать diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart index 35b35a589..b07f63563 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -26,7 +26,7 @@ testWidgets('override repositoryProvider', (tester) async { // Переопределяем поведение repositoryProvider, чтобы он // возвращал FakeRepository вместо Repository. /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), /* highlight-end */ // Нам не нужно переопределять `todoListProvider`. // Он автоматически будет использовать diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index fdd7f1e04..eaeffe953 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -56,7 +56,7 @@ void main() { await tester.pumpWidget( ProviderScope( overrides: [ - repositoryProvider.overrideWithValue(FakeRepository()) + repositoryProvider.overrideWithValue(FakeRepository()), ], // Наше приложение, которые читает значение todoListProvider // для отображение списка задач. @@ -71,10 +71,10 @@ void main() { } return ListView( children: [ - for (final todo in todos.asData!.value) TodoItem(todo: todo) + for (final todo in todos.asData!.value) TodoItem(todo: todo), ], ); - }), + },), ), ), ), diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart index 9b63aa012..9ad0c9d15 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -26,7 +26,7 @@ class MyApp extends StatelessWidget { onPressed: () => ref.read(counterProvider.notifier).state++, child: Text('$counter'), ); - }), + },), ); } } diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart index d85ec14ef..aa979c72e 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart @@ -13,6 +13,6 @@ Consumer(builder: (context, ref, child) { // TODO: отобразить задачи с помощью ListView/GridView/.../* SKIP */ return Container(); /* SKIP END */ -}); +},); /* SNIPPET END */ } diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart index f1d7b6c0c..6b469c46e 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart @@ -20,5 +20,5 @@ DropdownButton( ], ), /* SNIPPET END */ - ]); + ],); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart index 3f9e2231c..3844b1540 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart @@ -17,6 +17,6 @@ class MyConfiguration extends HookConsumerWidget { data: (config) { return Center(child: Text(config.host)); }, - )); + ),); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart index ece077f72..6b2cccbd6 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart @@ -20,6 +20,6 @@ class MyConfiguration extends HookConsumerWidget { data: (config) { return Center(child: Text(config.host)); }, - )); + ),); } } \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart index aa99c4541..69b73e5fd 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart @@ -13,6 +13,6 @@ Consumer(builder: (context, ref, child) { // TODO 使用ListView/GridView/……展示待办清单列表 /* SKIP */ return Container(); /* SKIP END */ -}); +},); /* SNIPPET END */ } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart index 189ff3c6a..31566a52a 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart @@ -21,5 +21,5 @@ DropdownButton( ], ), /* SNIPPET END */ - ]); + ],); } From ce727898e80bbc95abdb26142369fff346280f9f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 11:31:48 +0100 Subject: [PATCH 182/387] Disable unreachable_from_main in generated code --- packages/riverpod_generator/lib/src/riverpod_generator.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index 8c22fed54..c423958cc 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -90,7 +90,7 @@ class RiverpodGenerator extends ParserGenerator { buffer.write(''' // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main '''); } From 92918a6817fd6edcedc589dc574e7672109bc98c Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 11:32:45 +0100 Subject: [PATCH 183/387] Update generated code --- examples/counter/lib/main.g.dart | 2 +- examples/pub/lib/detail.g.dart | 2 +- examples/pub/lib/search.g.dart | 4 ++-- .../riverpod_generator/integration/build_yaml/lib/main.g.dart | 2 +- packages/riverpod_generator/test/integration/annotated.g.dart | 2 +- packages/riverpod_generator/test/integration/async.g.dart | 2 +- .../riverpod_generator/test/integration/auto_dispose.g.dart | 2 +- .../riverpod_generator/test/integration/dependencies.g.dart | 2 +- .../riverpod_generator/test/integration/dependencies2.g.dart | 2 +- .../riverpod_generator/test/integration/documented.g.dart | 2 +- packages/riverpod_generator/test/integration/generated.g.dart | 2 +- .../riverpod_generator/test/integration/hash/hash1.g.dart | 2 +- packages/riverpod_generator/test/integration/scopes.g.dart | 2 +- packages/riverpod_generator/test/integration/split.g.dart | 2 +- packages/riverpod_generator/test/integration/stream.g.dart | 2 +- packages/riverpod_generator/test/integration/sync.g.dart | 2 +- .../test/integration/generated/golden/lib/sync.g.dart | 2 +- .../convert_class_based_provider_to_functional.g.dart | 2 +- .../convert_functional_provider_to_class_based.g.dart | 2 +- packages/riverpod_lint_flutter_test/test/lints/another.g.dart | 2 +- .../test/lints/avoid_build_context_in_providers.g.dart | 2 +- .../test/lints/avoid_public_notifier_properties.g.dart | 2 +- .../riverpod_lint_flutter_test/test/lints/dependencies.g.dart | 2 +- .../test/lints/functional_ref/functional_ref.g.dart | 2 +- .../test/lints/notifier_extends/notifier_extends.g.dart | 2 +- .../test/lints/protected_notifier_properties.g.dart | 2 +- .../lints/provider_dependencies/provider_dependencies.g.dart | 2 +- .../test/lints/provider_parameters.g.dart | 2 +- .../lints/scoped_providers_should_specify_dependencies.g.dart | 2 +- .../test/lints/unsupported_provider_value.g.dart | 2 +- website/docs/advanced/select/select/codegen.g.dart | 2 +- website/docs/advanced/select/select_async/codegen.g.dart | 2 +- website/docs/case_studies/cancel/detail_screen/codegen.g.dart | 2 +- .../case_studies/cancel/detail_screen_cancel/codegen.g.dart | 2 +- .../case_studies/cancel/detail_screen_debounce/codegen.g.dart | 2 +- .../cancel/provider_with_extension/codegen.g.dart | 2 +- .../pull_to_refresh/fetch_activity/codegen.g.dart | 2 +- .../docs/case_studies/pull_to_refresh/full_app/codegen.g.dart | 2 +- website/docs/concepts/about_codegen/main.g.dart | 2 +- .../about_codegen/provider_type/async_class_future.g.dart | 2 +- .../about_codegen/provider_type/async_class_stream.g.dart | 2 +- .../about_codegen/provider_type/async_fn_future.g.dart | 2 +- .../about_codegen/provider_type/async_fn_stream.g.dart | 2 +- .../concepts/about_codegen/provider_type/auto_dispose.g.dart | 2 +- .../docs/concepts/about_codegen/provider_type/family.g.dart | 2 +- .../concepts/about_codegen/provider_type/family_class.g.dart | 2 +- .../concepts/about_codegen/provider_type/family_fn.g.dart | 2 +- .../concepts/about_codegen/provider_type/sync_class.g.dart | 2 +- .../docs/concepts/about_codegen/provider_type/sync_fn.g.dart | 2 +- .../characters_provider/codegen.g.dart | 2 +- .../combining_provider_states/city_provider/codegen.g.dart | 2 +- .../filtered_todo_list_provider/codegen.g.dart | 2 +- .../combining_provider_states/read_in_provider/codegen.g.dart | 2 +- .../select_async_provider/codegen.g.dart | 2 +- .../todo_list_provider/codegen.g.dart | 2 +- .../combining_provider_states/weather_provider/codegen.g.dart | 2 +- .../whole_object_provider/codegen.g.dart | 2 +- website/docs/concepts/lifecycle_on_dispose/codegen.g.dart | 2 +- .../concepts/providers/creating_a_provider/codegen.g.dart | 2 +- .../providers/declaring_many_providers/codegen.g.dart | 2 +- website/docs/concepts/reading/counter/codegen.g.dart | 2 +- website/docs/concepts/reading/listen/codegen.g.dart | 2 +- website/docs/concepts/reading/listen_build/codegen.g.dart | 2 +- .../docs/concepts/reading/listen_build/codegen_hooks.g.dart | 2 +- website/docs/concepts/reading/provider/codegen.g.dart | 2 +- website/docs/concepts/reading/read/codegen.g.dart | 2 +- website/docs/concepts/reading/read/codegen_hooks.g.dart | 2 +- website/docs/concepts/reading/read_build/codegen.g.dart | 2 +- .../docs/concepts/reading/read_notifier_build/codegen.g.dart | 2 +- website/docs/concepts/reading/watch/codegen.g.dart | 2 +- website/docs/concepts/reading/watch_build/codegen.g.dart | 2 +- .../docs/concepts/reading/watch_build/codegen_hooks.g.dart | 2 +- .../docs/concepts/reading/watch_notifier_build/codegen.g.dart | 2 +- website/docs/concepts/why_immutability/codegen.g.dart | 2 +- .../essentials/auto_dispose/cache_for_usage/codegen.g.dart | 2 +- .../docs/essentials/auto_dispose/codegen_keep_alive.g.dart | 2 +- .../auto_dispose/invalidate_family_example/codegen.g.dart | 2 +- .../docs/essentials/auto_dispose/keep_alive/codegen.g.dart | 2 +- .../essentials/auto_dispose/on_dispose_example/codegen.g.dart | 2 +- .../combining_requests/functional_ref/codegen.g.dart | 2 +- .../combining_requests/listen_example/codegen.g.dart | 2 +- .../essentials/combining_requests/notifier_ref/codegen.g.dart | 2 +- .../essentials/combining_requests/read_example/codegen.g.dart | 2 +- .../combining_requests/watch_example/codegen.g.dart | 2 +- .../combining_requests/watch_placement/codegen.g.dart | 2 +- .../eager_initialization/require_value/codegen.g.dart | 2 +- website/docs/essentials/first_request/codegen/provider.g.dart | 2 +- website/docs/essentials/passing_args/codegen/family.g.dart | 2 +- website/docs/essentials/passing_args/codegen/provider.g.dart | 2 +- .../essentials/side_effects/codegen/todo_list_notifier.g.dart | 2 +- .../side_effects/codegen/todo_list_notifier_add_todo.g.dart | 2 +- .../essentials/side_effects/codegen/todo_list_provider.g.dart | 2 +- website/docs/essentials/testing/notifier_mock/codegen.g.dart | 2 +- .../docs/essentials/testing/provider_to_mock/codegen.g.dart | 2 +- .../essentials/websockets_sync/pipe_change_notifier.g.dart | 2 +- website/docs/essentials/websockets_sync/raw_usage.g.dart | 2 +- .../websockets_sync/shared_pipe_change_notifier.g.dart | 2 +- .../essentials/websockets_sync/stream_provider/codegen.g.dart | 2 +- .../essentials/websockets_sync/sync_definition/codegen.g.dart | 2 +- website/docs/from_provider/family/family.g.dart | 2 +- .../from_provider/motivation/async_values/async_values.g.dart | 2 +- .../from_provider/motivation/auto_dispose/auto_dispose.g.dart | 2 +- website/docs/from_provider/motivation/combine/combine.g.dart | 2 +- .../docs/from_provider/motivation/same_type/same_type.g.dart | 2 +- .../introduction/getting_started/dart_hello_world/main.g.dart | 2 +- .../getting_started/hello_world/hooks_codegen/main.g.dart | 2 +- .../docs/introduction/getting_started/hello_world/main.g.dart | 2 +- website/docs/introduction/why_riverpod/codegen.g.dart | 2 +- .../from_change_notifier/declaration/declaration.g.dart | 2 +- .../from_change_notifier/initialization/initialization.g.dart | 2 +- .../migration/from_change_notifier/migrated/migrated.g.dart | 2 +- .../from_state_notifier/add_listener/add_listener.g.dart | 2 +- .../from_state_notifier/async_notifier/async_notifier.g.dart | 2 +- .../from_state_notifier/build_init/build_init.g.dart | 2 +- .../family_and_dispose/family_and_dispose.g.dart | 2 +- .../from_state_provider/from_state_provider.g.dart | 2 +- .../from_state_notifier/old_lifecycles/old_lifecycles.g.dart | 2 +- .../old_lifecycles_final/old_lifecycles_final.g.dart | 2 +- .../providers/future_provider/config_provider/codegen.g.dart | 2 +- .../providers/notifier_provider/remote_todos/codegen.g.dart | 2 +- website/docs/providers/notifier_provider/todos/codegen.g.dart | 2 +- .../providers/provider/completed_todos/completed_todos.g.dart | 2 +- .../optimized_previous_button.g.dart | 2 +- website/docs/providers/provider/todo/todo.g.dart | 2 +- .../unoptimized_previous_button.g.dart | 2 +- .../stream_provider/live_stream_chat_provider/codegen.g.dart | 2 +- .../current/about_codegen/main.g.dart | 2 +- .../current/getting_started/dart_hello_world/main.g.dart | 2 +- .../current/getting_started/hello_world/main.g.dart | 2 +- .../providers/notifier_provider/remote_todos/codegen.g.dart | 2 +- .../current/providers/notifier_provider/todos/codegen.g.dart | 2 +- .../current/about_codegen/main.g.dart | 2 +- .../current/getting_started/dart_hello_world/main.g.dart | 2 +- .../current/getting_started/hello_world/main.g.dart | 2 +- .../current/about_codegen/main.g.dart | 2 +- .../current/getting_started/dart_hello_world/main.g.dart | 2 +- .../current/getting_started/hello_world/main.g.dart | 2 +- .../providers/future_provider/config_provider/codegen.g.dart | 2 +- .../current/about_codegen/main.g.dart | 2 +- .../current/concepts/lifecycle_on_dispose/codegen.g.dart | 2 +- .../current/concepts/reading/counter/codegen.g.dart | 2 +- .../current/concepts/reading/listen/codegen.g.dart | 2 +- .../current/concepts/reading/listen_build/codegen.g.dart | 2 +- .../current/concepts/reading/provider/codegen.g.dart | 2 +- .../current/concepts/reading/read/codegen.g.dart | 2 +- .../current/concepts/reading/read_build/codegen.g.dart | 2 +- .../concepts/reading/read_notifier_build/codegen.g.dart | 2 +- .../current/concepts/reading/watch/codegen.g.dart | 2 +- .../current/concepts/reading/watch_build/codegen.g.dart | 2 +- .../concepts/reading/watch_notifier_build/codegen.g.dart | 2 +- .../current/getting_started/dart_hello_world/main.g.dart | 2 +- .../current/getting_started/hello_world/main.g.dart | 2 +- .../current/getting_started/hello_world/main_hooks.g.dart | 2 +- .../providers/future_provider/config_provider/codegen.g.dart | 2 +- .../providers/notifier_provider/remote_todos/codegen.g.dart | 2 +- .../current/providers/notifier_provider/todos/codegen.g.dart | 2 +- .../providers/provider/completed_todos/completed_todos.g.dart | 2 +- .../optimized_previous_button.g.dart | 2 +- .../current/providers/provider/todo/todo.g.dart | 2 +- .../unoptimized_previous_button.g.dart | 2 +- website/static/snippets/async.g.dart | 2 +- website/static/snippets/combine.g.dart | 2 +- website/static/snippets/create.g.dart | 2 +- website/static/snippets/declare.g.dart | 2 +- 164 files changed, 165 insertions(+), 165 deletions(-) diff --git a/examples/counter/lib/main.g.dart b/examples/counter/lib/main.g.dart index b0615e05c..0f7638885 100644 --- a/examples/counter/lib/main.g.dart +++ b/examples/counter/lib/main.g.dart @@ -88,4 +88,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index aafa38054..9b3ba8ab5 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -430,4 +430,4 @@ abstract class _$PackageMetrics extends $AsyncNotifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index ca63df2ea..311ce995b 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -107,7 +107,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< } } -String _$fetchPackagesHash() => r'3637226080ea667823875a135a6c4cf002cb0329'; +String _$fetchPackagesHash() => r'46519fce4d1661e1358deac4d806374fa68f12c8'; final class FetchPackagesFamily extends Family { const FetchPackagesFamily._() @@ -163,4 +163,4 @@ final class FetchPackagesFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 811c9a094..033e9bf33 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -1206,4 +1206,4 @@ abstract class _$CountStreamNotifier2 extends $StreamNotifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 68926168e..77e7689bd 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -699,4 +699,4 @@ abstract class _$NotCopiedClassBased extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 375c2bf14..b0adb45f2 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -1182,4 +1182,4 @@ abstract class _$FamilyClass extends $AsyncNotifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index e90a1988a..812e0ad27 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -185,4 +185,4 @@ String _$defaultKeepAliveHash() => r'1c236764d83a62ca442c5d5b4a83bd0d6e4548cf'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 1d387479a..79ddf107e 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -1513,4 +1513,4 @@ abstract class _$EmptyDependenciesClassBased extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 0d6a1fde1..a7e0ce408 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -627,4 +627,4 @@ abstract class _$NotifierFamilyWithDependencies extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index 8b6968ca7..1f92c6c44 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -465,4 +465,4 @@ abstract class _$ClassFamilyBased extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 7b74138f7..86334352b 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -1407,4 +1407,4 @@ abstract class _$AliasClassFamily extends $Notifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index 349f3c5f4..454c63447 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -194,4 +194,4 @@ abstract class _$SimpleClass extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index c7110ca8d..27e9abed6 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -236,4 +236,4 @@ abstract class _$ScopedClassFamily extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index 5a7df070b..8cef40eab 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -124,4 +124,4 @@ String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index c292a5908..6bbdf5136 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -905,4 +905,4 @@ abstract class _$FamilyClass extends $StreamNotifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 96d5b7453..e8d159b9c 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -2845,4 +2845,4 @@ abstract class _$Supports$InClassFamilyName extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index a3666510f..4fb6d61b9 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -844,4 +844,4 @@ abstract class _$Supports$InClassName extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index 43808b9a3..d42db52f3 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -433,4 +433,4 @@ abstract class _$Generic extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index 59489306c..a5367f1dc 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -234,4 +234,4 @@ final class ExampleFamilyFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/another.g.dart b/packages/riverpod_lint_flutter_test/test/lints/another.g.dart index 3df36ad4b..0d1229ab3 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/another.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/another.g.dart @@ -66,4 +66,4 @@ String _$bHash() => r'52593050701642f22b31c590f20c003dc2ee1579'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 67f163c41..c258882b6 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -430,4 +430,4 @@ abstract class _$Regresion2959 extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index 137ae6019..a416e4830 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -167,4 +167,4 @@ abstract class _$GeneratedNotifier extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index 4b739a5f4..ddd8d01c1 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -1966,4 +1966,4 @@ abstract class _$AliasClass extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 098a7917f..0415af67f 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -608,4 +608,4 @@ final class WrongOrderFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart index 1165ddeae..9b09de53f 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart @@ -904,4 +904,4 @@ abstract class _$WrongOrder extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index a7cca41d1..4c69c365b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -1183,4 +1183,4 @@ abstract class _$B2 extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart index 40105c6e0..1c68cf50d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart @@ -747,4 +747,4 @@ String _$noDepWithoutCommaHash() => r'59d5a7874da40605b1b187766ebb4927d2eaae81'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index a6e959b5c..6f28526d4 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -138,4 +138,4 @@ final class GeneratorFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart index 176f20e36..1d26d4c6e 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart @@ -184,4 +184,4 @@ String _$rootHash() => r'1cd85d73316aad02169ff0f5e7af5cf1423410ff'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart index 3323f2f13..4af3eaf0d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart @@ -1317,4 +1317,4 @@ abstract class _$AsyncNotifierClass extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/advanced/select/select/codegen.g.dart b/website/docs/advanced/select/select/codegen.g.dart index 6c0d06d33..f6057ff06 100644 --- a/website/docs/advanced/select/select/codegen.g.dart +++ b/website/docs/advanced/select/select/codegen.g.dart @@ -68,4 +68,4 @@ String _$exampleHash() => r'72881c6147d44adb957180debefe7696d93107f0'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/advanced/select/select_async/codegen.g.dart b/website/docs/advanced/select/select_async/codegen.g.dart index 67c604d36..d0bd8c0e0 100644 --- a/website/docs/advanced/select/select_async/codegen.g.dart +++ b/website/docs/advanced/select/select_async/codegen.g.dart @@ -69,4 +69,4 @@ String _$exampleHash() => r'1fccbdbec0e3585bc9d3a5709ac88a8919dd78fa'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart index 7f234a266..ecdab0bce 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart @@ -81,4 +81,4 @@ String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart index 0c963f9b6..be6062d04 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -61,4 +61,4 @@ String _$activityHash() => r'304864a6b8051925061a2bba397574ec45b94d08'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart index 3d96babf2..e86787356 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -61,4 +61,4 @@ String _$activityHash() => r'ef908e3b46693862f082769663b14d5369d6e155'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart index 7f45384f6..ca0e8ec04 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -61,4 +61,4 @@ String _$activityHash() => r'f045dd6e89fde6bbe12a89f243290d289a3e692d'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart index d9f41cf7a..8b10f4971 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -61,4 +61,4 @@ String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart index 7f234a266..ecdab0bce 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -81,4 +81,4 @@ String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 86fce98be..81038cb6b 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -133,4 +133,4 @@ final class FetchUserFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart index 7ca059265..35fb4c701 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart @@ -70,4 +70,4 @@ abstract class _$Example extends $AsyncNotifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart index ad70f244a..f10c14ef9 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart @@ -70,4 +70,4 @@ abstract class _$Example extends $StreamNotifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart index 06a72a0be..2fbdf1243 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -61,4 +61,4 @@ String _$exampleHash() => r'e620af6b870a76eea4228989433de0666957d813'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart index 2e2196c6f..b937f6ae5 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -61,4 +61,4 @@ String _$exampleHash() => r'8a2b19776fb9bbb1631f898bd6446b57b102dd9d'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart index 2633ed7f0..18d1ccc7f 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -128,4 +128,4 @@ String _$example2Hash() => r'bc25731d759be185125d12d995d0b89b07d1e271'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 64aa3c009..2f9a63665 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -141,4 +141,4 @@ final class ExampleFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index e0128c307..d20abc8e9 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -204,4 +204,4 @@ abstract class _$Example extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index 01c4e68ef..aca3edc62 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -168,4 +168,4 @@ final class ExampleFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart index 578bb4b68..02a235091 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart @@ -78,4 +78,4 @@ abstract class _$Example extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart index f747be61b..e16298e38 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -69,4 +69,4 @@ String _$exampleHash() => r'dd4e9043c704a42a3fc025e7fef9515f659fc78a'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart index 5e2c3d28b..834165c28 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -118,4 +118,4 @@ String _$charactersHash() => r'b1e8e15bbeab60d92fe959d9e1dd4ceba6a31446'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart index 372c293ac..4d3ef30a9 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -68,4 +68,4 @@ String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart index f7c13276a..07500a16d 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -69,4 +69,4 @@ String _$filteredTodoListHash() => r'1c35eb0fce8fc7c7cda86413b02f606f8c8ae2b4'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart index 3c0fc5ac4..543a2a8aa 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -127,4 +127,4 @@ String _$myHash() => r'2712c772be4dbaabd4c99fd803f927a7e9938b21'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart index a6056dddf..62a465661 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -118,4 +118,4 @@ String _$productsHash() => r'd1f4523880408cf8ee0e68969c40cf87d5c78557'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart index e76be1409..40969f405 100644 --- a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$TodoList extends $Notifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart index 2c4cea851..cdbf9a6d0 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -119,4 +119,4 @@ String _$weatherHash() => r'9a79d0269032630918eef9d3f562ff35b5860061'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart index fb641140b..dff9516ff 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -118,4 +118,4 @@ String _$productsHash() => r'637254615fa398af0d36e212f09e5d3d8ff866aa'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart index acc03feaa..95c3c31bc 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart @@ -61,4 +61,4 @@ String _$exampleHash() => r'e2c4eb8a7cf06c7a0e5d07ee2bd51db254033fa6'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart index 6bd530b72..4487de80c 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart @@ -68,4 +68,4 @@ String _$myHash() => r'0810ee24cae78c131d00773ac20d254c83eefab7'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart index 69234a30c..551c40c07 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart @@ -127,4 +127,4 @@ String _$countryHash() => r'd1513349c3bc0c99763cb4fb29eb012f2351bc4c'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/counter/codegen.g.dart b/website/docs/concepts/reading/counter/codegen.g.dart index 4b69a56e1..8de5da5f8 100644 --- a/website/docs/concepts/reading/counter/codegen.g.dart +++ b/website/docs/concepts/reading/counter/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/listen/codegen.g.dart b/website/docs/concepts/reading/listen/codegen.g.dart index dfc6e7497..96a88ef69 100644 --- a/website/docs/concepts/reading/listen/codegen.g.dart +++ b/website/docs/concepts/reading/listen/codegen.g.dart @@ -68,4 +68,4 @@ String _$anotherHash() => r'2208f9221f3d898305609874d4f43c28bdfff2b4'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/listen_build/codegen.g.dart b/website/docs/concepts/reading/listen_build/codegen.g.dart index f59d40e8f..cdc8bea0e 100644 --- a/website/docs/concepts/reading/listen_build/codegen.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart index c3c44541a..33dd3b590 100644 --- a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/provider/codegen.g.dart b/website/docs/concepts/reading/provider/codegen.g.dart index fee467e75..d1a6c89b7 100644 --- a/website/docs/concepts/reading/provider/codegen.g.dart +++ b/website/docs/concepts/reading/provider/codegen.g.dart @@ -127,4 +127,4 @@ String _$valueHash() => r'8c26f7aaa911af815cff9e513a18e4d8dcc6d1df'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/read/codegen.g.dart b/website/docs/concepts/reading/read/codegen.g.dart index 090ded96f..dc0a6828f 100644 --- a/website/docs/concepts/reading/read/codegen.g.dart +++ b/website/docs/concepts/reading/read/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/read/codegen_hooks.g.dart b/website/docs/concepts/reading/read/codegen_hooks.g.dart index 0449b9928..235643163 100644 --- a/website/docs/concepts/reading/read/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/read/codegen_hooks.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/read_build/codegen.g.dart b/website/docs/concepts/reading/read_build/codegen.g.dart index 090ded96f..dc0a6828f 100644 --- a/website/docs/concepts/reading/read_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_build/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart index 090ded96f..dc0a6828f 100644 --- a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/watch/codegen.g.dart b/website/docs/concepts/reading/watch/codegen.g.dart index 5b7deccb5..3855e5438 100644 --- a/website/docs/concepts/reading/watch/codegen.g.dart +++ b/website/docs/concepts/reading/watch/codegen.g.dart @@ -196,4 +196,4 @@ abstract class _$Todos extends $Notifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/watch_build/codegen.g.dart b/website/docs/concepts/reading/watch_build/codegen.g.dart index dcc5cec2c..011551c7d 100644 --- a/website/docs/concepts/reading/watch_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen.g.dart @@ -136,4 +136,4 @@ abstract class _$TodoList extends $Notifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart index b1aa4b007..d949cfae4 100644 --- a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart @@ -136,4 +136,4 @@ abstract class _$TodoList extends $Notifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart index 090ded96f..dc0a6828f 100644 --- a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/why_immutability/codegen.g.dart b/website/docs/concepts/why_immutability/codegen.g.dart index 03fc4c4ad..c1859edee 100644 --- a/website/docs/concepts/why_immutability/codegen.g.dart +++ b/website/docs/concepts/why_immutability/codegen.g.dart @@ -79,4 +79,4 @@ abstract class _$ThemeNotifier extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart index f909dfe06..20657689e 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -61,4 +61,4 @@ String _$exampleHash() => r'3ff29b1cd8fa864286a2a04e39adf1c8589b4275'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart index e9e227986..bbda271f7 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -68,4 +68,4 @@ String _$exampleHash() => r'78f9426f6cbda80564387a9db8cd02368d890a85'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index f0e348941..8c5ee9c5d 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -140,4 +140,4 @@ final class LabelFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart index e487e303f..b916108fe 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -61,4 +61,4 @@ String _$exampleHash() => r'4fa856c55e84da9525dcecfab1c897e61456325b'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart index fa2c901fb..84d21d8ac 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -119,4 +119,4 @@ String _$exampleHash() => r'29f92958e0d0e3f13ac033e92cd2e4072339c7db'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart index db867e1e7..4ae133dfa 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart @@ -126,4 +126,4 @@ String _$exampleHash() => r'4429d7d3bb2b31fea4cc42c2f2af02d3f3d10693'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart index 32435c94f..9f292b611 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart @@ -68,4 +68,4 @@ String _$exampleHash() => r'd614303f372e06e6ab96035affc4c07a53b28741'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart index 25735301f..222349caa 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -136,4 +136,4 @@ abstract class _$Example extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/combining_requests/read_example/codegen.g.dart b/website/docs/essentials/combining_requests/read_example/codegen.g.dart index 842246fd0..95e65af9d 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$MyNotifier extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart index 7dc32950b..07848b382 100644 --- a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart @@ -120,4 +120,4 @@ String _$restaurantsNearMeHash() => r'dd49cc1e6f16abb34dd15286d171e322c06b93b8'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart index 9e01a0926..0690dacec 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart @@ -136,4 +136,4 @@ abstract class _$MyNotifier extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart index e63365ff5..3b64e7e32 100644 --- a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart +++ b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart @@ -61,4 +61,4 @@ String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/first_request/codegen/provider.g.dart b/website/docs/essentials/first_request/codegen/provider.g.dart index 65e729a20..4709142f3 100644 --- a/website/docs/essentials/first_request/codegen/provider.g.dart +++ b/website/docs/essentials/first_request/codegen/provider.g.dart @@ -69,4 +69,4 @@ String _$activityHash() => r'636cd5510e09cbfc46f31b74a70d9e98c89e95a4'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/passing_args/codegen/family.g.dart b/website/docs/essentials/passing_args/codegen/family.g.dart index 4753ec99c..6cd1c2329 100644 --- a/website/docs/essentials/passing_args/codegen/family.g.dart +++ b/website/docs/essentials/passing_args/codegen/family.g.dart @@ -133,4 +133,4 @@ final class ActivityFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/passing_args/codegen/provider.g.dart b/website/docs/essentials/passing_args/codegen/provider.g.dart index 0639868a7..47145a6bf 100644 --- a/website/docs/essentials/passing_args/codegen/provider.g.dart +++ b/website/docs/essentials/passing_args/codegen/provider.g.dart @@ -215,4 +215,4 @@ abstract class _$ActivityNotifier2 extends $AsyncNotifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart index 45e12c72f..8bff9688e 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -86,4 +86,4 @@ abstract class _$TodoList extends $AsyncNotifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart index 5f5ae9c4a..dd6531193 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -71,4 +71,4 @@ abstract class _$TodoList extends $AsyncNotifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart index a00197e61..7ffb53391 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -62,4 +62,4 @@ String _$todoListHash() => r'26b30307668c8feefa7cbe3c400b73e6edccbc39'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/testing/notifier_mock/codegen.g.dart b/website/docs/essentials/testing/notifier_mock/codegen.g.dart index 9522fdb07..c35d5f4e0 100644 --- a/website/docs/essentials/testing/notifier_mock/codegen.g.dart +++ b/website/docs/essentials/testing/notifier_mock/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$MyNotifier extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart index e63365ff5..3b64e7e32 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart @@ -61,4 +61,4 @@ String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart index 5d07f3f51..1f680865f 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -79,4 +79,4 @@ String _$myListenableHash() => r'4cc07df2f47050c4aa761e5467f341ab6c312d09'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/websockets_sync/raw_usage.g.dart b/website/docs/essentials/websockets_sync/raw_usage.g.dart index 1803d0cf7..3e78c80e5 100644 --- a/website/docs/essentials/websockets_sync/raw_usage.g.dart +++ b/website/docs/essentials/websockets_sync/raw_usage.g.dart @@ -71,4 +71,4 @@ String _$rawStreamHash() => r'7e7c2e8f4f08d33a4d86d60449e143c419ca4822'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart index f530c0b0f..6c47dda8a 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -131,4 +131,4 @@ String _$anotherListenableHash() => r'38bfe5dbf5f148819b3671ad69d15c8e05264c23'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart index e4a7ad5f4..23923a9d8 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -61,4 +61,4 @@ String _$streamExampleHash() => r'ca9993b22f6d587b20c041133cacd28d01933074'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart index 74e048bcb..c98ec668b 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -70,4 +70,4 @@ String _$synchronousExampleHash() => const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index 8fce032bd..b58209748 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -167,4 +167,4 @@ final class RandomFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/from_provider/motivation/async_values/async_values.g.dart b/website/docs/from_provider/motivation/async_values/async_values.g.dart index 521a6e1cd..4691a521b 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.g.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.g.dart @@ -121,4 +121,4 @@ String _$evenItemsHash() => r'55ae98f9b6108203dfc4a139f1ade9fbd8ba8ddd'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart index dc741cf2b..cae767b2c 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -127,4 +127,4 @@ String _$cachedDiceRollHash() => r'fc31fcb804f10360d75362e56329976343ee7abb'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/from_provider/motivation/combine/combine.g.dart b/website/docs/from_provider/motivation/combine/combine.g.dart index 8343bbb00..5ec2fddbf 100644 --- a/website/docs/from_provider/motivation/combine/combine.g.dart +++ b/website/docs/from_provider/motivation/combine/combine.g.dart @@ -126,4 +126,4 @@ String _$doubledHash() => r'ddc640c876bdbe49fe72fe1632b5ff48687c9279'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/from_provider/motivation/same_type/same_type.g.dart b/website/docs/from_provider/motivation/same_type/same_type.g.dart index cda93475f..c4bba2a82 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.g.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.g.dart @@ -128,4 +128,4 @@ String _$evenItemsHash() => r'82b4525e91604745f2b4664531b32d4aff5717d4'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart index 61dcc5f0e..aaa2a2e1d 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart @@ -69,4 +69,4 @@ String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart index 61dcc5f0e..aaa2a2e1d 100644 --- a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -69,4 +69,4 @@ String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/introduction/getting_started/hello_world/main.g.dart b/website/docs/introduction/getting_started/hello_world/main.g.dart index 61dcc5f0e..aaa2a2e1d 100644 --- a/website/docs/introduction/getting_started/hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/main.g.dart @@ -69,4 +69,4 @@ String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index 6250b4cc7..204ee6a37 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -163,4 +163,4 @@ final class FetchPackagesFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart index 0606a445e..ef339d618 100644 --- a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart +++ b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart @@ -71,4 +71,4 @@ abstract class _$MyNotifier extends $AsyncNotifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart index 40edfea06..c1562595c 100644 --- a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart +++ b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart @@ -71,4 +71,4 @@ abstract class _$MyNotifier extends $AsyncNotifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart index a5fc09228..e69a58188 100644 --- a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart +++ b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart @@ -71,4 +71,4 @@ abstract class _$MyNotifier extends $AsyncNotifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart index c9e7ae8af..42e402af9 100644 --- a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart +++ b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -78,4 +78,4 @@ abstract class _$MyNotifier extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart index c91630e7b..60a2d5a08 100644 --- a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart +++ b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -72,4 +72,4 @@ abstract class _$AsyncTodosNotifier extends $AsyncNotifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart index cd06e8415..2642321bd 100644 --- a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart +++ b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart @@ -79,4 +79,4 @@ abstract class _$CounterNotifier extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index 3bd132aa5..9e3d13419 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -167,4 +167,4 @@ abstract class _$BugsEncounteredNotifier extends $AsyncNotifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart index 4d01b64c0..250bb687e 100644 --- a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart +++ b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -79,4 +79,4 @@ abstract class _$CounterNotifier extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart index 8b27c0d96..4a704ffd3 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -78,4 +78,4 @@ abstract class _$MyNotifier extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart index f2fd0d752..c52bfa3a0 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -78,4 +78,4 @@ abstract class _$MyNotifier extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/future_provider/config_provider/codegen.g.dart b/website/docs/providers/future_provider/config_provider/codegen.g.dart index 7af35b388..40743bd0e 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.g.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.g.dart @@ -67,4 +67,4 @@ String _$fetchConfigurationHash() => const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart index 7404f0524..a60fc353e 100644 --- a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart @@ -88,4 +88,4 @@ abstract class _$AsyncTodos extends $AsyncNotifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/notifier_provider/todos/codegen.g.dart b/website/docs/providers/notifier_provider/todos/codegen.g.dart index 75ff6212e..39133c828 100644 --- a/website/docs/providers/notifier_provider/todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/todos/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Todos extends $Notifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/provider/completed_todos/completed_todos.g.dart b/website/docs/providers/provider/completed_todos/completed_todos.g.dart index 2323ad997..c25e2c8c0 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.g.dart @@ -69,4 +69,4 @@ String _$completedTodosHash() => r'855706c09268f428696b3b382ae1605818361b83'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index 63b0464de..3036755b6 100644 --- a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -138,4 +138,4 @@ abstract class _$PageIndex extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/provider/todo/todo.g.dart b/website/docs/providers/provider/todo/todo.g.dart index 3d278dd0e..9d32d9ce3 100644 --- a/website/docs/providers/provider/todo/todo.g.dart +++ b/website/docs/providers/provider/todo/todo.g.dart @@ -78,4 +78,4 @@ abstract class _$Todos extends $Notifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart index e82d88b84..ce25f1881 100644 --- a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart +++ b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -78,4 +78,4 @@ abstract class _$PageIndex extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart index d5a34b788..446d35ecf 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -62,4 +62,4 @@ String _$chatHash() => r'db1302132f90e854fe2f5da9d97d89c9a3c8b858'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 86fce98be..81038cb6b 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -133,4 +133,4 @@ final class FetchUserFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index 61dcc5f0e..aaa2a2e1d 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -69,4 +69,4 @@ String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index 61dcc5f0e..aaa2a2e1d 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -69,4 +69,4 @@ String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart index 7404f0524..a60fc353e 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart @@ -88,4 +88,4 @@ abstract class _$AsyncTodos extends $AsyncNotifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart index 75ff6212e..39133c828 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Todos extends $Notifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 86fce98be..81038cb6b 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -133,4 +133,4 @@ final class FetchUserFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index 61dcc5f0e..aaa2a2e1d 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -69,4 +69,4 @@ String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index 61dcc5f0e..aaa2a2e1d 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -69,4 +69,4 @@ String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 86fce98be..81038cb6b 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -133,4 +133,4 @@ final class FetchUserFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index 61dcc5f0e..aaa2a2e1d 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -69,4 +69,4 @@ String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index 61dcc5f0e..aaa2a2e1d 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -69,4 +69,4 @@ String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart index 7af35b388..40743bd0e 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart @@ -67,4 +67,4 @@ String _$fetchConfigurationHash() => const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 86fce98be..81038cb6b 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -133,4 +133,4 @@ final class FetchUserFamily extends Family { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart index acc03feaa..95c3c31bc 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart @@ -61,4 +61,4 @@ String _$exampleHash() => r'e2c4eb8a7cf06c7a0e5d07ee2bd51db254033fa6'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart index 4b69a56e1..8de5da5f8 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart index dfc6e7497..96a88ef69 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart @@ -68,4 +68,4 @@ String _$anotherHash() => r'2208f9221f3d898305609874d4f43c28bdfff2b4'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart index f59d40e8f..cdc8bea0e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart index fee467e75..d1a6c89b7 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart @@ -127,4 +127,4 @@ String _$valueHash() => r'8c26f7aaa911af815cff9e513a18e4d8dcc6d1df'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart index 090ded96f..dc0a6828f 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart index 090ded96f..dc0a6828f 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart index 090ded96f..dc0a6828f 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart index 5b7deccb5..3855e5438 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart @@ -196,4 +196,4 @@ abstract class _$Todos extends $Notifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart index dcc5cec2c..011551c7d 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart @@ -136,4 +136,4 @@ abstract class _$TodoList extends $Notifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart index 090ded96f..dc0a6828f 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index 61dcc5f0e..aaa2a2e1d 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -69,4 +69,4 @@ String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index 61dcc5f0e..aaa2a2e1d 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -69,4 +69,4 @@ String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart index c6f7ac8eb..34b181036 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart @@ -69,4 +69,4 @@ String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart index 7af35b388..40743bd0e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart @@ -67,4 +67,4 @@ String _$fetchConfigurationHash() => const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart index 7404f0524..a60fc353e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart @@ -88,4 +88,4 @@ abstract class _$AsyncTodos extends $AsyncNotifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart index 75ff6212e..39133c828 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Todos extends $Notifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart index 2323ad997..c25e2c8c0 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart @@ -69,4 +69,4 @@ String _$completedTodosHash() => r'855706c09268f428696b3b382ae1605818361b83'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index 63b0464de..3036755b6 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -138,4 +138,4 @@ abstract class _$PageIndex extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart index 3d278dd0e..9d32d9ce3 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart @@ -78,4 +78,4 @@ abstract class _$Todos extends $Notifier> { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart index e82d88b84..ce25f1881 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -78,4 +78,4 @@ abstract class _$PageIndex extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/static/snippets/async.g.dart b/website/static/snippets/async.g.dart index bd207ff2c..402a5ed6f 100644 --- a/website/static/snippets/async.g.dart +++ b/website/static/snippets/async.g.dart @@ -64,4 +64,4 @@ String _$configurationsHash() => r'27f534f8b2a22c39b2d28c2414358a228c552155'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/static/snippets/combine.g.dart b/website/static/snippets/combine.g.dart index 4452a8b90..4feeda0c7 100644 --- a/website/static/snippets/combine.g.dart +++ b/website/static/snippets/combine.g.dart @@ -69,4 +69,4 @@ String _$filteredTodosHash() => r'bcb1e81823aaf9b967948b619c177ebc571d96a7'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/static/snippets/create.g.dart b/website/static/snippets/create.g.dart index 1e935715b..95952947a 100644 --- a/website/static/snippets/create.g.dart +++ b/website/static/snippets/create.g.dart @@ -61,4 +61,4 @@ String _$boredSuggestionHash() => r'5975efd623c41e5bc92ecd326209e6124cb1736d'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/static/snippets/declare.g.dart b/website/static/snippets/declare.g.dart index 8f854411d..5cc275e32 100644 --- a/website/static/snippets/declare.g.dart +++ b/website/static/snippets/declare.g.dart @@ -78,4 +78,4 @@ abstract class _$Count extends $Notifier { const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main From d6383d02a60183bb7bab2e5b3d4a2c0d6a8a579c Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 11:40:39 +0100 Subject: [PATCH 184/387] Fix some lints --- examples/counter/lib/main.dart | 2 ++ .../lib/src/providers/legacy/change_notifier_provider.dart | 2 +- packages/riverpod/lib/src/providers/stream_provider.dart | 4 +++- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/examples/counter/lib/main.dart b/examples/counter/lib/main.dart index da3b7410e..db7c29ef1 100644 --- a/examples/counter/lib/main.dart +++ b/examples/counter/lib/main.dart @@ -1,3 +1,5 @@ +// ignore_for_file: unreachable_from_main, https://github.com/dart-lang/linter/issues/4652 + import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.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 index aee9413aa..b892db39a 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -247,7 +247,7 @@ class ChangeNotifierProviderFamily computeAllTransitiveDependencies(dependencies), ); - /// {@macro riverpod.override_with} + @override Override overrideWith( NotifierT Function(ChangeNotifierProviderRef ref, Arg arg) create, diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index cca559450..7b0bcbf46 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -219,7 +219,9 @@ class $StreamProviderElement @override bool updateShouldNotify( - AsyncValue previous, AsyncValue next) { + AsyncValue previous, + AsyncValue next, + ) { return FutureModifierElement.handleUpdateShouldNotify( previous, next, From 5dd5b1e622f3d0aa8b844a786acc2a47bde466f0 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 11:42:45 +0100 Subject: [PATCH 185/387] Fix unreachable_from_main --- .../introduction/getting_started/dart_hello_world/main.dart | 2 +- .../getting_started/hello_world/hooks_codegen/main.dart | 2 +- .../docs/introduction/getting_started/hello_world/main.dart | 2 +- .../family_and_dispose/family_and_dispose.dart | 4 +++- .../current/getting_started/dart_hello_world/main.dart | 2 +- .../current/getting_started/hello_world/main.dart | 2 +- .../current/getting_started/dart_hello_world/main.dart | 2 +- .../current/getting_started/hello_world/main.dart | 2 +- .../current/getting_started/dart_hello_world/main.dart | 2 +- .../current/getting_started/hello_world/main.dart | 2 +- .../current/getting_started/dart_hello_world/main.dart | 2 +- .../current/getting_started/hello_world/main.dart | 2 +- .../current/getting_started/hello_world/main_hooks.dart | 2 +- 13 files changed, 15 insertions(+), 13 deletions(-) diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.dart b/website/docs/introduction/getting_started/dart_hello_world/main.dart index ae7a30285..a7c49d638 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.dart @@ -1,4 +1,4 @@ -// ignore_for_file: avoid_print +// ignore_for_file: avoid_print, unreachable_from_main /* SNIPPET START */ diff --git a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.dart b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.dart index 70064d5d7..c9cdae4aa 100644 --- a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.dart +++ b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.dart @@ -1,4 +1,4 @@ -// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, unreachable_from_main /* SNIPPET START */ diff --git a/website/docs/introduction/getting_started/hello_world/main.dart b/website/docs/introduction/getting_started/hello_world/main.dart index da5ffb095..f03708b64 100644 --- a/website/docs/introduction/getting_started/hello_world/main.dart +++ b/website/docs/introduction/getting_started/hello_world/main.dart @@ -1,4 +1,4 @@ -// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, unreachable_from_main /* SNIPPET START */ diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart index 9a695614c..c093fbfd8 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart @@ -18,7 +18,9 @@ class BugsEncounteredNotifier extends _$BugsEncounteredNotifier { Future fix(int amount) async { final old = await future; - final result = await ref.read(taskTrackerProvider).fix(id: this.featureId, fixed: amount); + final result = await ref + .read(taskTrackerProvider) + .fix(id: this.featureId, fixed: amount); state = AsyncData(max(old - result, 0)); } } diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart index ae7a30285..a7c49d638 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart @@ -1,4 +1,4 @@ -// ignore_for_file: avoid_print +// ignore_for_file: avoid_print, unreachable_from_main /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart index da5ffb095..f03708b64 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart @@ -1,4 +1,4 @@ -// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, unreachable_from_main /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart index ae7a30285..a7c49d638 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart @@ -1,4 +1,4 @@ -// ignore_for_file: avoid_print +// ignore_for_file: avoid_print, unreachable_from_main /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart index da5ffb095..f03708b64 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart @@ -1,4 +1,4 @@ -// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, unreachable_from_main /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart index ae7a30285..a7c49d638 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart @@ -1,4 +1,4 @@ -// ignore_for_file: avoid_print +// ignore_for_file: avoid_print, unreachable_from_main /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart index da5ffb095..f03708b64 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart @@ -1,4 +1,4 @@ -// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, unreachable_from_main /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart index 34bb333db..529b61e53 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart @@ -1,4 +1,4 @@ -// ignore_for_file: avoid_print +// ignore_for_file: avoid_print, unreachable_from_main /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart index 1ea9ff208..291b3365f 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart @@ -1,4 +1,4 @@ -// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, unreachable_from_main /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.dart index c08110c6b..11e5736b2 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.dart @@ -1,4 +1,4 @@ -// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, unreachable_from_main /* SNIPPET START */ From 681404be8538ee9947dfa625c544bcbf909521ab Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 11:45:11 +0100 Subject: [PATCH 186/387] Fix lints --- .../docs/essentials/passing_args/raw/consumer_list_family.dart | 2 +- .../current/concepts/async_initialization.dart | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/essentials/passing_args/raw/consumer_list_family.dart b/website/docs/essentials/passing_args/raw/consumer_list_family.dart index ef70e4846..0c22a27e2 100644 --- a/website/docs/essentials/passing_args/raw/consumer_list_family.dart +++ b/website/docs/essentials/passing_args/raw/consumer_list_family.dart @@ -1,4 +1,4 @@ -// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals, provider_parameters import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart index 4ef6f927c..7a8f04444 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart @@ -32,7 +32,7 @@ final sharedPreferencesProvider = Future main() async { // Affiche un indicateur de chargement avant de lancer l'application complète (facultatif) // L'écran de chargement de la plate-forme sera utilisé pendant l'attente si vous omettez cette option. - runApp(const LoadingScreen()); + runApp(const ProviderScope(child: LoadingScreen())); // Obtention de l'instance de shared preferences final prefs = await SharedPreferences.getInstance(); From eaa780e8f6610ff03ff12901b2e30097a17a6527 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 12:02:13 +0100 Subject: [PATCH 187/387] Fix some lints --- .../riverpod_lint_flutter_test/test/lints/another.dart | 1 + .../test/lints/avoid_public_notifier_properties.dart | 9 ++++----- .../test/lints/dependencies.dart | 10 +--------- .../test/lints/notifier_build/notifier_build.dart | 3 ++- .../test/lints/notifier_extends/notifier_extends.dart | 1 + .../test/lints/unsupported_provider_value.dart | 2 +- website/docs/concepts/async_initialization.dart | 2 +- .../websockets_sync/pipe_change_notifier.dart | 2 +- .../websockets_sync/shared_pipe_change_notifier.dart | 4 ++-- .../from_change_notifier/declaration/raw.dart | 1 - .../from_change_notifier/initialization/raw.dart | 1 - .../migration/from_change_notifier/migrated/raw.dart | 1 - 12 files changed, 14 insertions(+), 23 deletions(-) diff --git a/packages/riverpod_lint_flutter_test/test/lints/another.dart b/packages/riverpod_lint_flutter_test/test/lints/another.dart index a7d58b340..01792a321 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/another.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/another.dart @@ -1,3 +1,4 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'another.g.dart'; diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.dart index c212b93f9..bda98cfd4 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.dart @@ -43,7 +43,7 @@ class MyNotifier extends Notifier { } } -class MyAutoDisposeNotifier extends AutoDisposeNotifier { +class MyAutoDisposeNotifier extends Notifier { int get _privateGetter => 0; // expect_lint: avoid_public_notifier_properties @@ -53,7 +53,7 @@ class MyAutoDisposeNotifier extends AutoDisposeNotifier { int build() => 0; } -class MyAutoDisposeFamilyNotifier extends AutoDisposeFamilyNotifier { +class MyAutoDisposeFamilyNotifier extends FamilyNotifier { int get _privateGetter => 0; // expect_lint: avoid_public_notifier_properties @@ -73,7 +73,7 @@ class MyAsyncNotifier extends AsyncNotifier { Future build() async => 0; } -class MyAutoDisposeAsyncNotifier extends AutoDisposeAsyncNotifier { +class MyAutoDisposeAsyncNotifier extends AsyncNotifier { int get _privateGetter => 0; // expect_lint: avoid_public_notifier_properties @@ -83,8 +83,7 @@ class MyAutoDisposeAsyncNotifier extends AutoDisposeAsyncNotifier { Future build() async => 0; } -class MyAutoDisposeFamilyAsyncNotifier - extends AutoDisposeFamilyAsyncNotifier { +class MyAutoDisposeFamilyAsyncNotifier extends FamilyAsyncNotifier { int get _privateGetter => 0; // expect_lint: avoid_public_notifier_properties diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.dart index 2f0f1d8ce..4799003b5 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.dart @@ -1,13 +1,11 @@ // ignore_for_file: unused_field +import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'another.dart' as import_alias; part 'dependencies.g.dart'; -@riverpod -external int unimplementedScoped(); - @Riverpod(dependencies: []) int dep(DepRef ref) => 0; @@ -29,12 +27,6 @@ int watchScopedButNoDependencies(WatchScopedButNoDependenciesRef ref) { return ref.watch(scoped); } -// expect_lint: provider_dependencies -@riverpod -int watchExternalButNoDependencies(WatchExternalButNoDependenciesRef ref) { - return ref.watch(unimplementedScopedProvider); -} - // expect_lint: provider_dependencies @riverpod int watchGeneratedScopedButNoDependencies( diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/notifier_build.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_build/notifier_build.dart index 52ac1fe58..e8fee3138 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/notifier_build.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_build/notifier_build.dart @@ -1,10 +1,11 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; /// Fake Provider typedef _$ExampleProvider1 = Object; /// Fake Provider -typedef _$ExampleProvider = AutoDisposeNotifier; +typedef _$ExampleProvider = Notifier; @riverpod // expect_lint: notifier_build diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.dart index f80904594..5a607d83b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.dart @@ -1,3 +1,4 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'notifier_extends.g.dart'; diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.dart index 6ff155393..597432c2e 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.dart @@ -89,7 +89,7 @@ class MyNotifier extends Notifier { int build() => 0; } -class MyAutoDisposeNotifier extends AutoDisposeNotifier { +class MyAutoDisposeNotifier extends Notifier { @override int build() => 0; } diff --git a/website/docs/concepts/async_initialization.dart b/website/docs/concepts/async_initialization.dart index 4ee56e95a..a006cf77d 100644 --- a/website/docs/concepts/async_initialization.dart +++ b/website/docs/concepts/async_initialization.dart @@ -32,7 +32,7 @@ final sharedPreferencesProvider = Future main() async { // Show a loading indicator before running the full app (optional) // The platform's loading screen will be used while awaiting if you omit this. - runApp(const LoadingScreen()); + runApp(const ProviderScope(child: LoadingScreen())); // Get the instance of shared preferences final prefs = await SharedPreferences.getInstance(); diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.dart index baa42f22e..03c6756bc 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.dart @@ -9,7 +9,7 @@ part 'pipe_change_notifier.g.dart'; /// A provider which creates a ValueNotifier and update its listeners /// whenever the value changes. @riverpod -ValueNotifier myListenable(MyListenableRef ref) { +Raw> myListenable(MyListenableRef ref) { final notifier = ValueNotifier(0); // Dispose of the notifier when the provider is destroyed diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart index 2e7af1e00..4969e1e58 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart @@ -18,11 +18,11 @@ extension on Ref { } @riverpod -ValueNotifier myListenable(MyListenableRef ref) { +Raw> myListenable(MyListenableRef ref) { return ref.disposeAndListenChangeNotifier(ValueNotifier(0)); } @riverpod -ValueNotifier anotherListenable(AnotherListenableRef ref) { +Raw> anotherListenable(AnotherListenableRef ref) { return ref.disposeAndListenChangeNotifier(ValueNotifier(42)); } diff --git a/website/docs/migration/from_change_notifier/declaration/raw.dart b/website/docs/migration/from_change_notifier/declaration/raw.dart index f43a57875..0c723f63c 100644 --- a/website/docs/migration/from_change_notifier/declaration/raw.dart +++ b/website/docs/migration/from_change_notifier/declaration/raw.dart @@ -18,7 +18,6 @@ class Http { final http = Http(); /* SNIPPET START */ -@riverpod class MyNotifier extends AsyncNotifier> { @override FutureOr> build() { diff --git a/website/docs/migration/from_change_notifier/initialization/raw.dart b/website/docs/migration/from_change_notifier/initialization/raw.dart index 10f11e686..5ef9e85c1 100644 --- a/website/docs/migration/from_change_notifier/initialization/raw.dart +++ b/website/docs/migration/from_change_notifier/initialization/raw.dart @@ -18,7 +18,6 @@ class Http { final http = Http(); /* SNIPPET START */ -@riverpod class MyNotifier extends AsyncNotifier> { @override FutureOr> build() async { diff --git a/website/docs/migration/from_change_notifier/migrated/raw.dart b/website/docs/migration/from_change_notifier/migrated/raw.dart index c03870a12..6927bd057 100644 --- a/website/docs/migration/from_change_notifier/migrated/raw.dart +++ b/website/docs/migration/from_change_notifier/migrated/raw.dart @@ -18,7 +18,6 @@ class Http { final http = Http(); /* SNIPPET START */ -@riverpod class MyNotifier extends AsyncNotifier> { @override FutureOr> build() async { From 77508d61be12f9d5f59603cd4ca8774cecc400c2 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 12:02:53 +0100 Subject: [PATCH 188/387] Update generated files --- .../test/lints/dependencies.g.dart | 121 ------------------ 1 file changed, 121 deletions(-) diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index ddd8d01c1..e4071dbe0 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -6,66 +6,6 @@ part of 'dependencies.dart'; // RiverpodGenerator // ************************************************************************** -typedef UnimplementedScopedRef = Ref; - -@ProviderFor(unimplementedScoped) -const unimplementedScopedProvider = UnimplementedScopedProvider._(); - -final class UnimplementedScopedProvider - extends $FunctionalProvider - with $Provider { - const UnimplementedScopedProvider._( - {int Function( - UnimplementedScopedRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'unimplementedScopedProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - UnimplementedScopedRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$unimplementedScopedHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @override - $ProviderElement createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - UnimplementedScopedProvider $copyWithCreate( - int Function( - UnimplementedScopedRef ref, - ) create, - ) { - return UnimplementedScopedProvider._(create: create); - } - - @override - int create(UnimplementedScopedRef ref) { - final fn = _createCb ?? unimplementedScoped; - return fn(ref); - } -} - -String _$unimplementedScopedHash() => - r'5f32fc56f4157238612d62ef54038fe92b7cdfe8'; - typedef DepRef = Ref; @ProviderFor(dep) @@ -303,67 +243,6 @@ final class WatchScopedButNoDependenciesProvider String _$watchScopedButNoDependenciesHash() => r'3ec52c4ab2ea2b3204b7aa049d1756c01c014ff0'; -typedef WatchExternalButNoDependenciesRef = Ref; - -@ProviderFor(watchExternalButNoDependencies) -const watchExternalButNoDependenciesProvider = - WatchExternalButNoDependenciesProvider._(); - -final class WatchExternalButNoDependenciesProvider - extends $FunctionalProvider - with $Provider { - const WatchExternalButNoDependenciesProvider._( - {int Function( - WatchExternalButNoDependenciesRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'watchExternalButNoDependenciesProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - WatchExternalButNoDependenciesRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$watchExternalButNoDependenciesHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @override - $ProviderElement createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - WatchExternalButNoDependenciesProvider $copyWithCreate( - int Function( - WatchExternalButNoDependenciesRef ref, - ) create, - ) { - return WatchExternalButNoDependenciesProvider._(create: create); - } - - @override - int create(WatchExternalButNoDependenciesRef ref) { - final fn = _createCb ?? watchExternalButNoDependencies; - return fn(ref); - } -} - -String _$watchExternalButNoDependenciesHash() => - r'bbe1ed12645a261e2030222549308d378f5f368c'; - typedef WatchGeneratedScopedButNoDependenciesRef = Ref; @ProviderFor(watchGeneratedScopedButNoDependencies) From 83ab0b404df6e1bd26f821d77fd88120ac7373b0 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 12:05:55 +0100 Subject: [PATCH 189/387] Fix keepAlive family --- .../lib/src/templates/family.dart | 2 +- .../test/integration/auto_dispose.dart | 16 + .../test/integration/auto_dispose.g.dart | 396 ++++++++++++++++++ .../protected_notifier_properties.g.dart | 3 + .../test/lints/provider_parameters.g.dart | 1 + 5 files changed, 417 insertions(+), 1 deletion(-) diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index a6f3725a9..921b9f6b6 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -41,7 +41,7 @@ ${provider.doc} final class ${provider.familyTypeName} extends Family { name: r'${provider.providerName(options)}', dependencies: ${provider.dependencies(options)}, allTransitiveDependencies: ${provider.allTransitiveDependencies(allTransitiveDependencies)}, - ${provider.providerElement.isAutoDispose ? 'isAutoDispose: true,' : ''} + isAutoDispose: ${provider.providerElement.isAutoDispose}, ); ${provider.doc} ${provider.providerTypeName}$_generics call$_genericsDefinition($_parameterDefinition) diff --git a/packages/riverpod_generator/test/integration/auto_dispose.dart b/packages/riverpod_generator/test/integration/auto_dispose.dart index 744d77f09..9ae30399d 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.dart @@ -17,3 +17,19 @@ int notKeepAlive(NotKeepAliveRef ref) { int defaultKeepAlive(DefaultKeepAliveRef ref) { return 0; } + +@Riverpod(keepAlive: true) +int keepAliveFamily(KeepAliveFamilyRef ref, int a) { + return 0; +} + +@Riverpod(keepAlive: false) +int notKeepAliveFamily(NotKeepAliveFamilyRef ref, int a) { + ref.keepAlive(); + return 0; +} + +@riverpod +int defaultKeepAliveFamily(DefaultKeepAliveFamilyRef ref, int a) { + return 0; +} diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 812e0ad27..f6b8a7932 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -183,6 +183,402 @@ final class DefaultKeepAliveProvider String _$defaultKeepAliveHash() => r'1c236764d83a62ca442c5d5b4a83bd0d6e4548cf'; +typedef KeepAliveFamilyRef = Ref; + +@ProviderFor(keepAliveFamily) +const keepAliveFamilyProvider = KeepAliveFamilyFamily._(); + +final class KeepAliveFamilyProvider + extends $FunctionalProvider + with $Provider { + const KeepAliveFamilyProvider._( + {required KeepAliveFamilyFamily super.from, + required int super.argument, + int Function( + KeepAliveFamilyRef ref, + int a, + )? create}) + : _createCb = create, + super( + name: r'keepAliveFamilyProvider', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + KeepAliveFamilyRef ref, + int a, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$keepAliveFamilyHash(); + + @override + String toString() { + return r'keepAliveFamilyProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + KeepAliveFamilyProvider $copyWithCreate( + int Function( + KeepAliveFamilyRef ref, + ) create, + ) { + return KeepAliveFamilyProvider._( + argument: argument as int, + from: from! as KeepAliveFamilyFamily, + create: ( + ref, + int a, + ) => + create(ref)); + } + + @override + int create(KeepAliveFamilyRef ref) { + final fn = _createCb ?? keepAliveFamily; + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is KeepAliveFamilyProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$keepAliveFamilyHash() => r'80d684923a104e2488ec281097bf9b5b04b4fa5a'; + +final class KeepAliveFamilyFamily extends Family { + const KeepAliveFamilyFamily._() + : super( + name: r'keepAliveFamilyProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: false, + ); + + KeepAliveFamilyProvider call( + int a, + ) => + KeepAliveFamilyProvider._(argument: a, from: this); + + @override + String debugGetCreateSourceHash() => _$keepAliveFamilyHash(); + + @override + String toString() => r'keepAliveFamilyProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + int Function( + KeepAliveFamilyRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as KeepAliveFamilyProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } +} + +typedef NotKeepAliveFamilyRef = Ref; + +@ProviderFor(notKeepAliveFamily) +const notKeepAliveFamilyProvider = NotKeepAliveFamilyFamily._(); + +final class NotKeepAliveFamilyProvider + extends $FunctionalProvider + with $Provider { + const NotKeepAliveFamilyProvider._( + {required NotKeepAliveFamilyFamily super.from, + required int super.argument, + int Function( + NotKeepAliveFamilyRef ref, + int a, + )? create}) + : _createCb = create, + super( + name: r'notKeepAliveFamilyProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + NotKeepAliveFamilyRef ref, + int a, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$notKeepAliveFamilyHash(); + + @override + String toString() { + return r'notKeepAliveFamilyProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + NotKeepAliveFamilyProvider $copyWithCreate( + int Function( + NotKeepAliveFamilyRef ref, + ) create, + ) { + return NotKeepAliveFamilyProvider._( + argument: argument as int, + from: from! as NotKeepAliveFamilyFamily, + create: ( + ref, + int a, + ) => + create(ref)); + } + + @override + int create(NotKeepAliveFamilyRef ref) { + final fn = _createCb ?? notKeepAliveFamily; + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is NotKeepAliveFamilyProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$notKeepAliveFamilyHash() => + r'9f530635a3310431aff36f0f9150f80c56348a51'; + +final class NotKeepAliveFamilyFamily extends Family { + const NotKeepAliveFamilyFamily._() + : super( + name: r'notKeepAliveFamilyProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + NotKeepAliveFamilyProvider call( + int a, + ) => + NotKeepAliveFamilyProvider._(argument: a, from: this); + + @override + String debugGetCreateSourceHash() => _$notKeepAliveFamilyHash(); + + @override + String toString() => r'notKeepAliveFamilyProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + int Function( + NotKeepAliveFamilyRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as NotKeepAliveFamilyProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } +} + +typedef DefaultKeepAliveFamilyRef = Ref; + +@ProviderFor(defaultKeepAliveFamily) +const defaultKeepAliveFamilyProvider = DefaultKeepAliveFamilyFamily._(); + +final class DefaultKeepAliveFamilyProvider + extends $FunctionalProvider + with $Provider { + const DefaultKeepAliveFamilyProvider._( + {required DefaultKeepAliveFamilyFamily super.from, + required int super.argument, + int Function( + DefaultKeepAliveFamilyRef ref, + int a, + )? create}) + : _createCb = create, + super( + name: r'defaultKeepAliveFamilyProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + DefaultKeepAliveFamilyRef ref, + int a, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$defaultKeepAliveFamilyHash(); + + @override + String toString() { + return r'defaultKeepAliveFamilyProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DefaultKeepAliveFamilyProvider $copyWithCreate( + int Function( + DefaultKeepAliveFamilyRef ref, + ) create, + ) { + return DefaultKeepAliveFamilyProvider._( + argument: argument as int, + from: from! as DefaultKeepAliveFamilyFamily, + create: ( + ref, + int a, + ) => + create(ref)); + } + + @override + int create(DefaultKeepAliveFamilyRef ref) { + final fn = _createCb ?? defaultKeepAliveFamily; + final int argument = this.argument as int; + return fn( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is DefaultKeepAliveFamilyProvider && + other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$defaultKeepAliveFamilyHash() => + r'a1d9a5a40b8d43983428273ebee0660fe39250ed'; + +final class DefaultKeepAliveFamilyFamily extends Family { + const DefaultKeepAliveFamilyFamily._() + : super( + name: r'defaultKeepAliveFamilyProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + DefaultKeepAliveFamilyProvider call( + int a, + ) => + DefaultKeepAliveFamilyProvider._(argument: a, from: this); + + @override + String debugGetCreateSourceHash() => _$defaultKeepAliveFamilyHash(); + + @override + String toString() => r'defaultKeepAliveFamilyProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + int Function( + DefaultKeepAliveFamilyRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as DefaultKeepAliveFamilyProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } +} + const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index 4c69c365b..49350f93c 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -384,6 +384,7 @@ final class A4Family extends Family { name: r'a4Provider', dependencies: null, allTransitiveDependencies: null, + isAutoDispose: false, ); A4Provider call( @@ -681,6 +682,7 @@ final class A6Family extends Family { name: r'a6Provider', dependencies: null, allTransitiveDependencies: null, + isAutoDispose: false, ); A6Provider call( @@ -980,6 +982,7 @@ final class A8Family extends Family { name: r'a8Provider', dependencies: null, allTransitiveDependencies: null, + isAutoDispose: false, ); A8Provider call( diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 6f28526d4..a15a84d1f 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -101,6 +101,7 @@ final class GeneratorFamily extends Family { name: r'generatorProvider', dependencies: null, allTransitiveDependencies: null, + isAutoDispose: false, ); GeneratorProvider call({ From e49419cf07874b31ddc2387154d5478414e013af Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 12:16:52 +0100 Subject: [PATCH 190/387] Avoid unnecessary cast --- .../lib/src/riverpod_generator.dart | 6 + .../lib/src/templates/family.dart | 9 +- .../lib/src/templates/notifier.dart | 2 +- .../lib/src/templates/provider.dart | 4 +- .../test/integration/annotated.g.dart | 6 +- .../test/integration/async.g.dart | 10 +- .../test/integration/auto_dispose.g.dart | 6 +- .../test/integration/dependencies.g.dart | 2 +- .../test/integration/dependencies2.g.dart | 2 +- .../test/integration/documented.g.dart | 2 +- .../test/integration/generated.g.dart | 8 +- .../test/integration/stream.g.dart | 8 +- .../test/integration/sync.dart | 14 + .../test/integration/sync.g.dart | 316 +++++++++++++++++- 14 files changed, 342 insertions(+), 53 deletions(-) diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index c423958cc..713ff5c90 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -294,6 +294,12 @@ extension ProviderNames on GeneratorProviderDeclaration { String get doc => node.doc; + String get argumentCast { + final type = argumentRecordType; + if (type == 'Object?') return ''; + return ' as $type'; + } + String argumentToRecord({String? variableName}) { switch (parameters) { case [final p]: diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 921b9f6b6..2b65cca08 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -23,6 +23,7 @@ class FamilyTemplate extends Template { late final _parameterDefinition = buildParamDefinitionQuery(provider.parameters); late final _notifierType = '${provider.name}$_generics'; + late final _argumentCast = provider.argumentCast; @override void run(StringBuffer buffer) { @@ -120,7 +121,7 @@ Override overrideWith($createType create,) { ); case (hasParameters: true, hasGenerics: false, _): buffer.writeln(''' - final argument = provider.argument as $_argumentRecordType; + final argument = provider.argument$_argumentCast; return provider.\$copyWithCreate(${switch (provider) { FunctionalProviderDeclaration() => '(ref) => create(ref, argument)', @@ -150,7 +151,7 @@ Override overrideWith($createType create,) { ): buffer.writeln(''' return provider._copyWithCreate($_genericsDefinition() { - final argument = provider.argument as $_argumentRecordType; + final argument = provider.argument$_argumentCast; return create(argument); }).createElement(container); @@ -197,7 +198,7 @@ Override overrideWithBuild($runNotifierBuildType build,) { ); case (hasParameters: true, hasGenerics: false): buffer.writeln(''' - final argument = provider.argument as $_argumentRecordType; + final argument = provider.argument$_argumentCast; return provider.\$copyWithBuild((ref, notifier) => build(ref, notifier, argument)).createElement(container); '''); @@ -210,7 +211,7 @@ Override overrideWithBuild($runNotifierBuildType build,) { case (hasParameters: true, hasGenerics: true): buffer.writeln(''' return provider._copyWithBuild($_genericsDefinition(ref, notifier) { - final argument = provider.argument as $_argumentRecordType; + final argument = provider.argument$_argumentCast; return build(ref, notifier, argument); }).createElement(container); diff --git a/packages/riverpod_generator/lib/src/templates/notifier.dart b/packages/riverpod_generator/lib/src/templates/notifier.dart index e25d19d29..f2e29b7a0 100644 --- a/packages/riverpod_generator/lib/src/templates/notifier.dart +++ b/packages/riverpod_generator/lib/src/templates/notifier.dart @@ -36,7 +36,7 @@ class NotifierTemplate extends Template { }); final _$args = r'late final _$args = ' - '(ref as ${provider.elementName}).origin.argument as ${provider.argumentRecordType};'; + '(ref as ${provider.elementName}).origin.argument${provider.argumentCast};'; var paramOffset = 0; final parametersAsFields = provider.parameters.map( (p) { diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 496218f10..0ef3e1671 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -145,7 +145,7 @@ ${provider.doc} final class $name$_genericsDefinition final copyParameters = [ if (provider.parameters.isNotEmpty) - 'argument: argument as $_argumentRecordType,', + 'argument: argument${provider.argumentCast},', if (provider.providerElement.isFamily) 'from: from! as ${provider.familyTypeName},', ].join(); @@ -288,7 +288,7 @@ ${provider.doc} final class $name$_genericsDefinition }); buffer.writeln(''' - final $_argumentRecordType argument = this.argument as $_argumentRecordType; + final argument = this.argument${provider.argumentCast}; return fn(ref, $paramsPassThrough); '''); } diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 77e7689bd..ea8c67a11 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -78,7 +78,7 @@ final class FunctionalProvider @override String create(FunctionalRef ref) { final fn = _createCb ?? functional; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, @@ -212,7 +212,7 @@ final class FamilyProvider @override String create(FamilyRef ref) { final fn = _createCb ?? family; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, @@ -403,7 +403,7 @@ final class NotCopiedFamilyProvider @override String create(NotCopiedFamilyRef ref) { final fn = _createCb ?? notCopiedFamily; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index b0adb45f2..3329f4ab1 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -280,7 +280,7 @@ final class FamilyOrProvider extends $FunctionalProvider, @override FutureOr create(FamilyOrRef ref) { final fn = _createCb ?? familyOr; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, @@ -428,13 +428,7 @@ final class FamilyProvider @override FutureOr create(FamilyRef ref) { final fn = _createCb ?? family; - final ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) argument = this.argument as ( + final argument = this.argument as ( int, { String? second, double third, diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index f6b8a7932..70d33f012 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -252,7 +252,7 @@ final class KeepAliveFamilyProvider @override int create(KeepAliveFamilyRef ref) { final fn = _createCb ?? keepAliveFamily; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, @@ -383,7 +383,7 @@ final class NotKeepAliveFamilyProvider @override int create(NotKeepAliveFamilyRef ref) { final fn = _createCb ?? notKeepAliveFamily; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, @@ -515,7 +515,7 @@ final class DefaultKeepAliveFamilyProvider @override int create(DefaultKeepAliveFamilyRef ref) { final fn = _createCb ?? defaultKeepAliveFamily; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 79ddf107e..d330af741 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -132,7 +132,7 @@ final class FamilyProvider extends $FunctionalProvider @override int create(FamilyRef ref) { final fn = _createCb ?? family; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index a7e0ce408..23e503dbb 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -161,7 +161,7 @@ final class FamilyWithDependencies2Provider @override int create(FamilyWithDependencies2Ref ref) { final fn = _createCb ?? familyWithDependencies2; - final int? argument = this.argument as int?; + final argument = this.argument as int?; return fn( ref, id: argument, diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index 1f92c6c44..c63827fda 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -150,7 +150,7 @@ final class FamilyProvider @override String create(FamilyRef ref) { final fn = _createCb ?? family; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 86334352b..736fcd1df 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -134,7 +134,7 @@ final class GeneratedFamilyProvider @override _Test create(GeneratedFamilyRef ref) { final fn = _createCb ?? generatedFamily; - final _Test argument = this.argument as _Test; + final argument = this.argument as _Test; return fn( ref, argument, @@ -324,7 +324,7 @@ final class $DynamicFamilyProvider @override Object? create($DynamicFamilyRef ref) { final fn = _createCb ?? $dynamicFamily; - final dynamic argument = this.argument as dynamic; + final argument = this.argument as dynamic; return fn( ref, argument, @@ -455,7 +455,7 @@ final class _DynamicProvider @override Object? create(_DynamicRef ref) { final fn = _createCb ?? _dynamic; - final dynamic argument = this.argument as dynamic; + final argument = this.argument as dynamic; return fn( ref, argument, @@ -648,7 +648,7 @@ final class AliasFamilyProvider extends $FunctionalProvider< @override r.AsyncValue create(AliasFamilyRef ref) { final fn = _createCb ?? aliasFamily; - final r.AsyncValue argument = this.argument as r.AsyncValue; + final argument = this.argument as r.AsyncValue; return fn( ref, argument, diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 6bbdf5136..d8d03d470 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -305,13 +305,7 @@ final class FamilyProvider @override Stream create(FamilyRef ref) { final fn = _createCb ?? family; - final ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) argument = this.argument as ( + final argument = this.argument as ( int, { String? second, double third, diff --git a/packages/riverpod_generator/test/integration/sync.dart b/packages/riverpod_generator/test/integration/sync.dart index 6a8a3c845..4357dbad1 100644 --- a/packages/riverpod_generator/test/integration/sync.dart +++ b/packages/riverpod_generator/test/integration/sync.dart @@ -205,3 +205,17 @@ final _someProvider = someProvider(); // Regression test for https://github.com/rrousselGit/riverpod/issues/2294 // ignore: unused_element final _other = _someProvider; + +// Regression test for now casting `as Object?` when not needed +@riverpod +String unnecessaryCast(GeneratedRef ref, Object? arg) { + return 'Just a simple normal generated provider'; +} + +@riverpod +class UnnecessaryCastClass extends _$UnnecessaryCastClass { + @override + String build(Object? arg) { + return 'Just a simple normal generated provider'; + } +} diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index e8d159b9c..ce66ce731 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -220,10 +220,7 @@ final class ComplexGenericProvider @override List create(ComplexGenericRef ref) { final fn = _createCb ?? complexGeneric; - final ({ - T param, - Foo? otherParam, - }) argument = this.argument as ({ + final argument = this.argument as ({ T param, Foo? otherParam, }); @@ -495,7 +492,7 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< @override Raw> create(RawFamilyFutureRef ref) { final fn = _createCb ?? rawFamilyFuture; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, @@ -627,7 +624,7 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< @override Raw> create(RawFamilyStreamRef ref) { final fn = _createCb ?? rawFamilyStream; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, @@ -909,13 +906,7 @@ final class FamilyProvider @override String create(FamilyRef ref) { final fn = _createCb ?? family; - final ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) argument = this.argument as ( + final argument = this.argument as ( int, { String? second, double third, @@ -1294,11 +1285,7 @@ final class Supports$InFnNameFamilyProvider @override String create(Supports$InFnNameFamilyRef ref) { final fn = _createCb ?? supports$InFnNameFamily; - final ( - And$InT, { - And$InT named$arg, - String defaultArg, - }) argument = this.argument as ( + final argument = this.argument as ( And$InT, { And$InT named$arg, String defaultArg, @@ -1445,6 +1432,137 @@ final class GeneratedProvider String _$generatedHash() => r'fecbc1d5d9a05fc996b452a57fd1975ff368af91'; +typedef UnnecessaryCastRef = Ref; + +@ProviderFor(unnecessaryCast) +const unnecessaryCastProvider = UnnecessaryCastFamily._(); + +final class UnnecessaryCastProvider + extends $FunctionalProvider + with $Provider { + const UnnecessaryCastProvider._( + {required UnnecessaryCastFamily super.from, + required Object? super.argument, + String Function( + UnnecessaryCastRef ref, + Object? arg, + )? create}) + : _createCb = create, + super( + name: r'unnecessaryCastProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + UnnecessaryCastRef ref, + Object? arg, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$unnecessaryCastHash(); + + @override + String toString() { + return r'unnecessaryCastProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + UnnecessaryCastProvider $copyWithCreate( + String Function( + UnnecessaryCastRef ref, + ) create, + ) { + return UnnecessaryCastProvider._( + argument: argument, + from: from! as UnnecessaryCastFamily, + create: ( + ref, + Object? arg, + ) => + create(ref)); + } + + @override + String create(UnnecessaryCastRef ref) { + final fn = _createCb ?? unnecessaryCast; + final argument = this.argument; + return fn( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is UnnecessaryCastProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$unnecessaryCastHash() => r'282c11ef4f55267c3e6ed70af1a260cd1c2163e6'; + +final class UnnecessaryCastFamily extends Family { + const UnnecessaryCastFamily._() + : super( + name: r'unnecessaryCastProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + UnnecessaryCastProvider call( + Object? arg, + ) => + UnnecessaryCastProvider._(argument: arg, from: this); + + @override + String debugGetCreateSourceHash() => _$unnecessaryCastHash(); + + @override + String toString() => r'unnecessaryCastProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + String Function( + UnnecessaryCastRef ref, + Object? args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as UnnecessaryCastProvider; + + final argument = provider.argument; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .createElement(container); + }, + ); + } +} + @ProviderFor(GenericClass) const genericClassProvider = GenericClassFamily._(); @@ -2843,6 +2961,168 @@ abstract class _$Supports$InClassFamilyName extends $Notifier { ); } +@ProviderFor(UnnecessaryCastClass) +const unnecessaryCastClassProvider = UnnecessaryCastClassFamily._(); + +final class UnnecessaryCastClassProvider + extends $NotifierProvider { + const UnnecessaryCastClassProvider._( + {required UnnecessaryCastClassFamily super.from, + required Object? super.argument, + super.runNotifierBuildOverride, + UnnecessaryCastClass Function()? create}) + : _createCb = create, + super( + name: r'unnecessaryCastClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final UnnecessaryCastClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$unnecessaryCastClassHash(); + + @override + String toString() { + return r'unnecessaryCastClassProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + UnnecessaryCastClass create() => _createCb?.call() ?? UnnecessaryCastClass(); + + @$internal + @override + UnnecessaryCastClassProvider $copyWithCreate( + UnnecessaryCastClass Function() create, + ) { + return UnnecessaryCastClassProvider._( + argument: argument, + from: from! as UnnecessaryCastClassFamily, + create: create); + } + + @$internal + @override + UnnecessaryCastClassProvider $copyWithBuild( + String Function( + Ref, + UnnecessaryCastClass, + ) build, + ) { + return UnnecessaryCastClassProvider._( + argument: argument, + from: from! as UnnecessaryCastClassFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is UnnecessaryCastClassProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$unnecessaryCastClassHash() => + r'8cbf80b29c4edf7f5401e4447feca553e921e734'; + +final class UnnecessaryCastClassFamily extends Family { + const UnnecessaryCastClassFamily._() + : super( + name: r'unnecessaryCastClassProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + UnnecessaryCastClassProvider call( + Object? arg, + ) => + UnnecessaryCastClassProvider._(argument: arg, from: this); + + @override + String debugGetCreateSourceHash() => _$unnecessaryCastClassHash(); + + @override + String toString() => r'unnecessaryCastClassProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + UnnecessaryCastClass Function( + Object? args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as UnnecessaryCastClassProvider; + + final argument = provider.argument; + + return provider + .$copyWithCreate(() => create(argument)) + .createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + String Function( + Ref ref, UnnecessaryCastClass notifier, Object? argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as UnnecessaryCastClassProvider; + + final argument = provider.argument; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .createElement(container); + }, + ); + } +} + +abstract class _$UnnecessaryCastClass extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument; + Object? get arg => _$args; + + String build( + Object? arg, + ); + @$internal + @override + String runBuild() => build( + _$args, + ); +} + const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main From b1a6de8f167c95146567d185aa00108c0a294680 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 12:17:46 +0100 Subject: [PATCH 191/387] Update generated code --- examples/pub/lib/detail.g.dart | 2 +- examples/pub/lib/search.g.dart | 5 +- .../integration/build_yaml/lib/main.g.dart | 6 +-- .../generated/golden/lib/sync.g.dart | 8 +--- ..._functional_provider_to_class_based.g.dart | 5 +- .../avoid_build_context_in_providers.g.dart | 5 +- .../test/lints/dependencies.g.dart | 4 +- .../test/lints/provider_parameters.g.dart | 6 +-- .../docs/concepts/about_codegen/main.g.dart | 2 +- .../about_codegen/provider_type/family.g.dart | 2 +- .../provider_type/family_fn.g.dart | 5 +- .../invalidate_family_example/codegen.g.dart | 2 +- .../passing_args/codegen/family.g.dart | 2 +- .../pipe_change_notifier.g.dart | 24 +++++----- .../shared_pipe_change_notifier.g.dart | 46 +++++++++---------- .../docs/from_provider/family/family.g.dart | 5 +- .../introduction/why_riverpod/codegen.g.dart | 5 +- .../current/about_codegen/main.g.dart | 2 +- .../current/about_codegen/main.g.dart | 2 +- .../current/about_codegen/main.g.dart | 2 +- .../current/about_codegen/main.g.dart | 2 +- 21 files changed, 59 insertions(+), 83 deletions(-) diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 9b3ba8ab5..90eee44de 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -71,7 +71,7 @@ final class FetchPackageDetailsProvider extends $FunctionalProvider< @override FutureOr create(FetchPackageDetailsRef ref) { final fn = _createCb ?? fetchPackageDetails; - final String argument = this.argument as String; + final argument = this.argument as String; return fn( ref, packageName: argument, diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 311ce995b..fbee4752c 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -82,10 +82,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< @override FutureOr> create(FetchPackagesRef ref) { final fn = _createCb ?? fetchPackages; - final ({ - int page, - String search, - }) argument = this.argument as ({ + final argument = this.argument as ({ int page, String search, }); diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 033e9bf33..841c0ed9d 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -234,7 +234,7 @@ final class Count2Provider extends $FunctionalProvider @override int create(Count2Ref ref) { final fn = _createCb ?? count2; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, @@ -357,7 +357,7 @@ final class CountFuture2Provider @override FutureOr create(CountFuture2Ref ref) { final fn = _createCb ?? countFuture2; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, @@ -480,7 +480,7 @@ final class CountStream2Provider @override Stream create(CountStream2Ref ref) { final fn = _createCb ?? countStream2; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 4fb6d61b9..0b7d1b81e 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -230,13 +230,7 @@ final class FamilyProvider @override String create(FamilyRef ref) { final fn = _createCb ?? family; - final ( - int, { - String? second, - double third, - bool forth, - List? fifth, - }) argument = this.argument as ( + final argument = this.argument as ( int, { String? second, double third, diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index a5367f1dc..4652c6bf1 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -151,10 +151,7 @@ final class ExampleFamilyProvider @override int create(ExampleFamilyRef ref) { final fn = _createCb ?? exampleFamily; - final ({ - int a, - String b, - }) argument = this.argument as ({ + final argument = this.argument as ({ int a, String b, }); diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index c258882b6..d2fcee51b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -84,10 +84,7 @@ final class FnProvider extends $FunctionalProvider @override int create(FnRef ref) { final fn = _createCb ?? fn; - final ( - BuildContext, { - BuildContext context2, - }) argument = this.argument as ( + final argument = this.argument as ( BuildContext, { BuildContext context2, }); diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index e4071dbe0..7fcdaf062 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -1286,7 +1286,7 @@ final class FamilyDepProvider @override int create(FamilyDepRef ref) { final fn = _createCb ?? familyDep; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, @@ -1423,7 +1423,7 @@ final class FamilyDep2Provider @override int create(FamilyDep2Ref ref) { final fn = _createCb ?? familyDep2; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index a15a84d1f..875c0c85c 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -63,7 +63,7 @@ final class GeneratorProvider ) create, ) { return GeneratorProvider._( - argument: argument as Object?, + argument: argument, from: from! as GeneratorFamily, create: ( ref, { @@ -75,7 +75,7 @@ final class GeneratorProvider @override int create(GeneratorRef ref) { final fn = _createCb ?? generator; - final Object? argument = this.argument as Object?; + final argument = this.argument; return fn( ref, value: argument, @@ -127,7 +127,7 @@ final class GeneratorFamily extends Family { createElement: (container, provider) { provider as GeneratorProvider; - final argument = provider.argument as Object?; + final argument = provider.argument; return provider .$copyWithCreate((ref) => create(ref, argument)) diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 81038cb6b..8affd2176 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -69,7 +69,7 @@ final class FetchUserProvider @override FutureOr create(FetchUserRef ref) { final fn = _createCb ?? fetchUser; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, userId: argument, diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 2f9a63665..0f1713374 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -77,7 +77,7 @@ final class ExampleProvider @override String create(ExampleRef ref) { final fn = _createCb ?? example; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, argument, diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index aca3edc62..7772a1ecd 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -87,10 +87,7 @@ final class ExampleProvider @override String create(ExampleRef ref) { final fn = _createCb ?? example; - final ( - int, { - String param2, - }) argument = this.argument as ( + final argument = this.argument as ( int, { String param2, }); diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index 8c5ee9c5d..c64a1b14a 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -76,7 +76,7 @@ final class LabelProvider extends $FunctionalProvider @override String create(LabelRef ref) { final fn = _createCb ?? label; - final String argument = this.argument as String; + final argument = this.argument as String; return fn( ref, argument, diff --git a/website/docs/essentials/passing_args/codegen/family.g.dart b/website/docs/essentials/passing_args/codegen/family.g.dart index 6cd1c2329..8989f84b4 100644 --- a/website/docs/essentials/passing_args/codegen/family.g.dart +++ b/website/docs/essentials/passing_args/codegen/family.g.dart @@ -69,7 +69,7 @@ final class ActivityProvider extends $FunctionalProvider, @override FutureOr create(ActivityRef ref) { final fn = _createCb ?? activity; - final String argument = this.argument as String; + final argument = this.argument as String; return fn( ref, argument, diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart index 1f680865f..804a81250 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -10,7 +10,7 @@ part of 'pipe_change_notifier.dart'; /// A provider which creates a ValueNotifier and update its listeners /// whenever the value changes. -typedef MyListenableRef = Ref>; +typedef MyListenableRef = Ref>>; /// A provider which creates a ValueNotifier and update its listeners /// whenever the value changes. @@ -20,13 +20,13 @@ const myListenableProvider = MyListenableProvider._(); /// A provider which creates a ValueNotifier and update its listeners /// whenever the value changes. final class MyListenableProvider extends $FunctionalProvider< - ValueNotifier, - ValueNotifier, - MyListenableRef> with $Provider, MyListenableRef> { + Raw>, + Raw>, + MyListenableRef> with $Provider>, MyListenableRef> { /// A provider which creates a ValueNotifier and update its listeners /// whenever the value changes. const MyListenableProvider._( - {ValueNotifier Function( + {Raw> Function( MyListenableRef ref, )? create}) : _createCb = create, @@ -39,7 +39,7 @@ final class MyListenableProvider extends $FunctionalProvider< allTransitiveDependencies: null, ); - final ValueNotifier Function( + final Raw> Function( MyListenableRef ref, )? _createCb; @@ -47,21 +47,21 @@ final class MyListenableProvider extends $FunctionalProvider< String debugGetCreateSourceHash() => _$myListenableHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(ValueNotifier value) { + Override overrideWithValue(Raw> value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>(value), + providerOverride: $ValueProvider>>(value), ); } @override - $ProviderElement> createElement( + $ProviderElement>> createElement( ProviderContainer container) => $ProviderElement(this, container); @override MyListenableProvider $copyWithCreate( - ValueNotifier Function( + Raw> Function( MyListenableRef ref, ) create, ) { @@ -69,13 +69,13 @@ final class MyListenableProvider extends $FunctionalProvider< } @override - ValueNotifier create(MyListenableRef ref) { + Raw> create(MyListenableRef ref) { final fn = _createCb ?? myListenable; return fn(ref); } } -String _$myListenableHash() => r'4cc07df2f47050c4aa761e5467f341ab6c312d09'; +String _$myListenableHash() => r'c80799a0224092668fca44187b98ccfcd2b33ae1'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart index 6c47dda8a..334302523 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -8,17 +8,17 @@ part of 'shared_pipe_change_notifier.dart'; // RiverpodGenerator // ************************************************************************** -typedef MyListenableRef = Ref>; +typedef MyListenableRef = Ref>>; @ProviderFor(myListenable) const myListenableProvider = MyListenableProvider._(); final class MyListenableProvider extends $FunctionalProvider< - ValueNotifier, - ValueNotifier, - MyListenableRef> with $Provider, MyListenableRef> { + Raw>, + Raw>, + MyListenableRef> with $Provider>, MyListenableRef> { const MyListenableProvider._( - {ValueNotifier Function( + {Raw> Function( MyListenableRef ref, )? create}) : _createCb = create, @@ -31,7 +31,7 @@ final class MyListenableProvider extends $FunctionalProvider< allTransitiveDependencies: null, ); - final ValueNotifier Function( + final Raw> Function( MyListenableRef ref, )? _createCb; @@ -39,21 +39,21 @@ final class MyListenableProvider extends $FunctionalProvider< String debugGetCreateSourceHash() => _$myListenableHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(ValueNotifier value) { + Override overrideWithValue(Raw> value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>(value), + providerOverride: $ValueProvider>>(value), ); } @override - $ProviderElement> createElement( + $ProviderElement>> createElement( ProviderContainer container) => $ProviderElement(this, container); @override MyListenableProvider $copyWithCreate( - ValueNotifier Function( + Raw> Function( MyListenableRef ref, ) create, ) { @@ -61,24 +61,24 @@ final class MyListenableProvider extends $FunctionalProvider< } @override - ValueNotifier create(MyListenableRef ref) { + Raw> create(MyListenableRef ref) { final fn = _createCb ?? myListenable; return fn(ref); } } -String _$myListenableHash() => r'7096094cd24ed50dbabb9fb9ab64b340176c04bf'; +String _$myListenableHash() => r'90f4227ef5442f978d742115663e5f0869622a27'; -typedef AnotherListenableRef = Ref>; +typedef AnotherListenableRef = Ref>>; @ProviderFor(anotherListenable) const anotherListenableProvider = AnotherListenableProvider._(); final class AnotherListenableProvider extends $FunctionalProvider< - ValueNotifier, ValueNotifier, AnotherListenableRef> - with $Provider, AnotherListenableRef> { + Raw>, Raw>, AnotherListenableRef> + with $Provider>, AnotherListenableRef> { const AnotherListenableProvider._( - {ValueNotifier Function( + {Raw> Function( AnotherListenableRef ref, )? create}) : _createCb = create, @@ -91,7 +91,7 @@ final class AnotherListenableProvider extends $FunctionalProvider< allTransitiveDependencies: null, ); - final ValueNotifier Function( + final Raw> Function( AnotherListenableRef ref, )? _createCb; @@ -99,21 +99,21 @@ final class AnotherListenableProvider extends $FunctionalProvider< String debugGetCreateSourceHash() => _$anotherListenableHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(ValueNotifier value) { + Override overrideWithValue(Raw> value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>(value), + providerOverride: $ValueProvider>>(value), ); } @override - $ProviderElement> createElement( + $ProviderElement>> createElement( ProviderContainer container) => $ProviderElement(this, container); @override AnotherListenableProvider $copyWithCreate( - ValueNotifier Function( + Raw> Function( AnotherListenableRef ref, ) create, ) { @@ -121,13 +121,13 @@ final class AnotherListenableProvider extends $FunctionalProvider< } @override - ValueNotifier create(AnotherListenableRef ref) { + Raw> create(AnotherListenableRef ref) { final fn = _createCb ?? anotherListenable; return fn(ref); } } -String _$anotherListenableHash() => r'38bfe5dbf5f148819b3671ad69d15c8e05264c23'; +String _$anotherListenableHash() => r'50dd36b21e07c50818944ec49f9e68d21fcae876'; const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index b58209748..f4df07c2b 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -86,10 +86,7 @@ final class RandomProvider extends $FunctionalProvider @override int create(RandomRef ref) { final fn = _createCb ?? random; - final ({ - int seed, - int max, - }) argument = this.argument as ({ + final argument = this.argument as ({ int seed, int max, }); diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index 204ee6a37..db47e6dbf 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -82,10 +82,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< @override FutureOr> create(FetchPackagesRef ref) { final fn = _createCb ?? fetchPackages; - final ({ - int page, - String search, - }) argument = this.argument as ({ + final argument = this.argument as ({ int page, String search, }); diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 81038cb6b..8affd2176 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -69,7 +69,7 @@ final class FetchUserProvider @override FutureOr create(FetchUserRef ref) { final fn = _createCb ?? fetchUser; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, userId: argument, diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 81038cb6b..8affd2176 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -69,7 +69,7 @@ final class FetchUserProvider @override FutureOr create(FetchUserRef ref) { final fn = _createCb ?? fetchUser; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, userId: argument, diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 81038cb6b..8affd2176 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -69,7 +69,7 @@ final class FetchUserProvider @override FutureOr create(FetchUserRef ref) { final fn = _createCb ?? fetchUser; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, userId: argument, diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 81038cb6b..8affd2176 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -69,7 +69,7 @@ final class FetchUserProvider @override FutureOr create(FetchUserRef ref) { final fn = _createCb ?? fetchUser; - final int argument = this.argument as int; + final argument = this.argument as int; return fn( ref, userId: argument, From 0c610244cc686f76ea3c87e022008907d2f17e1b Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 12:21:00 +0100 Subject: [PATCH 192/387] Rename cb --- packages/riverpod_generator/lib/src/templates/provider.dart | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 0ef3e1671..ce97ef41b 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -270,12 +270,12 @@ ${provider.doc} final class $name$_genericsDefinition buffer.write(''' @override ${provider.createdTypeDisplayString} create(${provider.refImplName}$_generics ref) { - final fn = _createCb ?? ${provider.name}$_generics; + final _\$cb = _createCb ?? ${provider.name}$_generics; '''); switch (provider.parameters) { case []: - buffer.writeln('return fn(ref);'); + buffer.writeln(r'return _$cb(ref);'); case [...]: final paramsPassThrough = buildParamInvocationQuery({ for (final (index, parameter) in provider.parameters.indexed) @@ -289,7 +289,7 @@ ${provider.doc} final class $name$_genericsDefinition buffer.writeln(''' final argument = this.argument${provider.argumentCast}; - return fn(ref, $paramsPassThrough); + return _\$cb(ref, $paramsPassThrough); '''); } From 4f8a89379b83ab1f673c6a1367936700056d2f43 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 12:21:54 +0100 Subject: [PATCH 193/387] Update generated code --- examples/pub/lib/detail.g.dart | 12 +-- examples/pub/lib/search.g.dart | 4 +- .../integration/build_yaml/lib/main.g.dart | 24 ++--- .../test/integration/annotated.g.dart | 16 ++-- .../test/integration/async.g.dart | 20 ++--- .../test/integration/auto_dispose.g.dart | 24 ++--- .../test/integration/dependencies.g.dart | 52 +++++------ .../test/integration/dependencies2.g.dart | 16 ++-- .../test/integration/documented.g.dart | 8 +- .../test/integration/generated.g.dart | 28 +++--- .../test/integration/hash/hash1.g.dart | 8 +- .../test/integration/split.g.dart | 8 +- .../test/integration/stream.g.dart | 16 ++-- .../test/integration/sync.g.dart | 56 ++++++------ .../generated/golden/lib/sync.g.dart | 16 ++-- ..._functional_provider_to_class_based.g.dart | 8 +- .../test/lints/another.g.dart | 4 +- .../avoid_build_context_in_providers.g.dart | 4 +- .../test/lints/dependencies.g.dart | 88 +++++++++---------- .../functional_ref/functional_ref.g.dart | 24 ++--- .../provider_dependencies.g.dart | 48 +++++----- .../test/lints/provider_parameters.g.dart | 4 +- ...oviders_should_specify_dependencies.g.dart | 12 +-- .../lints/unsupported_provider_value.g.dart | 52 +++++------ .../advanced/select/select/codegen.g.dart | 4 +- .../select/select_async/codegen.g.dart | 4 +- .../cancel/detail_screen/codegen.g.dart | 4 +- .../detail_screen_cancel/codegen.g.dart | 4 +- .../detail_screen_debounce/codegen.g.dart | 4 +- .../provider_with_extension/codegen.g.dart | 4 +- .../fetch_activity/codegen.g.dart | 4 +- .../pull_to_refresh/full_app/codegen.g.dart | 4 +- .../docs/concepts/about_codegen/main.g.dart | 4 +- .../provider_type/async_fn_future.g.dart | 4 +- .../provider_type/async_fn_stream.g.dart | 4 +- .../provider_type/auto_dispose.g.dart | 8 +- .../about_codegen/provider_type/family.g.dart | 4 +- .../provider_type/family_fn.g.dart | 4 +- .../provider_type/sync_fn.g.dart | 4 +- .../characters_provider/codegen.g.dart | 8 +- .../city_provider/codegen.g.dart | 4 +- .../codegen.g.dart | 4 +- .../read_in_provider/codegen.g.dart | 8 +- .../select_async_provider/codegen.g.dart | 8 +- .../weather_provider/codegen.g.dart | 8 +- .../whole_object_provider/codegen.g.dart | 8 +- .../lifecycle_on_dispose/codegen.g.dart | 4 +- .../creating_a_provider/codegen.g.dart | 4 +- .../declaring_many_providers/codegen.g.dart | 8 +- .../concepts/reading/listen/codegen.g.dart | 4 +- .../concepts/reading/provider/codegen.g.dart | 8 +- .../concepts/reading/watch/codegen.g.dart | 8 +- .../reading/watch_build/codegen.g.dart | 4 +- .../reading/watch_build/codegen_hooks.g.dart | 4 +- .../cache_for_usage/codegen.g.dart | 4 +- .../auto_dispose/codegen_keep_alive.g.dart | 4 +- .../invalidate_family_example/codegen.g.dart | 4 +- .../auto_dispose/keep_alive/codegen.g.dart | 4 +- .../on_dispose_example/codegen.g.dart | 8 +- .../functional_ref/codegen.g.dart | 8 +- .../listen_example/codegen.g.dart | 4 +- .../notifier_ref/codegen.g.dart | 4 +- .../watch_example/codegen.g.dart | 8 +- .../watch_placement/codegen.g.dart | 4 +- .../require_value/codegen.g.dart | 4 +- .../first_request/codegen/provider.g.dart | 4 +- .../passing_args/codegen/family.g.dart | 4 +- .../passing_args/codegen/provider.g.dart | 4 +- .../codegen/todo_list_provider.g.dart | 4 +- .../testing/provider_to_mock/codegen.g.dart | 4 +- .../pipe_change_notifier.g.dart | 4 +- .../websockets_sync/raw_usage.g.dart | 4 +- .../shared_pipe_change_notifier.g.dart | 8 +- .../stream_provider/codegen.g.dart | 4 +- .../sync_definition/codegen.g.dart | 4 +- .../docs/from_provider/family/family.g.dart | 4 +- .../async_values/async_values.g.dart | 8 +- .../auto_dispose/auto_dispose.g.dart | 8 +- .../motivation/combine/combine.g.dart | 8 +- .../motivation/same_type/same_type.g.dart | 8 +- .../dart_hello_world/main.g.dart | 4 +- .../hello_world/hooks_codegen/main.g.dart | 4 +- .../getting_started/hello_world/main.g.dart | 4 +- .../introduction/why_riverpod/codegen.g.dart | 4 +- .../config_provider/codegen.g.dart | 4 +- .../completed_todos/completed_todos.g.dart | 4 +- .../optimized_previous_button.g.dart | 4 +- .../live_stream_chat_provider/codegen.g.dart | 4 +- .../current/about_codegen/main.g.dart | 4 +- .../dart_hello_world/main.g.dart | 4 +- .../getting_started/hello_world/main.g.dart | 4 +- .../current/about_codegen/main.g.dart | 4 +- .../dart_hello_world/main.g.dart | 4 +- .../getting_started/hello_world/main.g.dart | 4 +- .../current/about_codegen/main.g.dart | 4 +- .../dart_hello_world/main.g.dart | 4 +- .../getting_started/hello_world/main.g.dart | 4 +- .../config_provider/codegen.g.dart | 4 +- .../current/about_codegen/main.g.dart | 4 +- .../lifecycle_on_dispose/codegen.g.dart | 4 +- .../concepts/reading/listen/codegen.g.dart | 4 +- .../concepts/reading/provider/codegen.g.dart | 8 +- .../concepts/reading/watch/codegen.g.dart | 8 +- .../reading/watch_build/codegen.g.dart | 4 +- .../dart_hello_world/main.g.dart | 4 +- .../getting_started/hello_world/main.g.dart | 4 +- .../hello_world/main_hooks.g.dart | 4 +- .../config_provider/codegen.g.dart | 4 +- .../completed_todos/completed_todos.g.dart | 4 +- .../optimized_previous_button.g.dart | 4 +- website/static/snippets/async.g.dart | 4 +- website/static/snippets/combine.g.dart | 4 +- website/static/snippets/create.g.dart | 4 +- 113 files changed, 492 insertions(+), 492 deletions(-) diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 90eee44de..ae55af2bc 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -70,9 +70,9 @@ final class FetchPackageDetailsProvider extends $FunctionalProvider< @override FutureOr create(FetchPackageDetailsRef ref) { - final fn = _createCb ?? fetchPackageDetails; + final _$cb = _createCb ?? fetchPackageDetails; final argument = this.argument as String; - return fn( + return _$cb( ref, packageName: argument, ); @@ -181,8 +181,8 @@ final class LikedPackagesProvider extends $FunctionalProvider< @override FutureOr> create(LikedPackagesRef ref) { - final fn = _createCb ?? likedPackages; - return fn(ref); + final _$cb = _createCb ?? likedPackages; + return _$cb(ref); } } @@ -240,8 +240,8 @@ final class PubRepositoryProvider @override PubRepository create(PubRepositoryRef ref) { - final fn = _createCb ?? pubRepository; - return fn(ref); + final _$cb = _createCb ?? pubRepository; + return _$cb(ref); } } diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index fbee4752c..f17e33b14 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -81,12 +81,12 @@ final class FetchPackagesProvider extends $FunctionalProvider< @override FutureOr> create(FetchPackagesRef ref) { - final fn = _createCb ?? fetchPackages; + final _$cb = _createCb ?? fetchPackages; final argument = this.argument as ({ int page, String search, }); - return fn( + return _$cb( ref, page: argument.page, search: argument.search, diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 841c0ed9d..83df22b4c 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -57,8 +57,8 @@ final class CountProvider extends $FunctionalProvider @override int create(CountRef ref) { - final fn = _createCb ?? count; - return fn(ref); + final _$cb = _createCb ?? count; + return _$cb(ref); } } @@ -108,8 +108,8 @@ final class CountFutureProvider @override FutureOr create(CountFutureRef ref) { - final fn = _createCb ?? countFuture; - return fn(ref); + final _$cb = _createCb ?? countFuture; + return _$cb(ref); } } @@ -159,8 +159,8 @@ final class CountStreamProvider @override Stream create(CountStreamRef ref) { - final fn = _createCb ?? countStream; - return fn(ref); + final _$cb = _createCb ?? countStream; + return _$cb(ref); } } @@ -233,9 +233,9 @@ final class Count2Provider extends $FunctionalProvider @override int create(Count2Ref ref) { - final fn = _createCb ?? count2; + final _$cb = _createCb ?? count2; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); @@ -356,9 +356,9 @@ final class CountFuture2Provider @override FutureOr create(CountFuture2Ref ref) { - final fn = _createCb ?? countFuture2; + final _$cb = _createCb ?? countFuture2; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); @@ -479,9 +479,9 @@ final class CountStream2Provider @override Stream create(CountStream2Ref ref) { - final fn = _createCb ?? countStream2; + final _$cb = _createCb ?? countStream2; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index ea8c67a11..3df6e5865 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -77,9 +77,9 @@ final class FunctionalProvider @override String create(FunctionalRef ref) { - final fn = _createCb ?? functional; + final _$cb = _createCb ?? functional; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); @@ -211,9 +211,9 @@ final class FamilyProvider @override String create(FamilyRef ref) { - final fn = _createCb ?? family; + final _$cb = _createCb ?? family; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); @@ -326,8 +326,8 @@ final class NotCopiedFunctionalProvider @override String create(NotCopiedFunctionalRef ref) { - final fn = _createCb ?? notCopiedFunctional; - return fn(ref); + final _$cb = _createCb ?? notCopiedFunctional; + return _$cb(ref); } } @@ -402,9 +402,9 @@ final class NotCopiedFamilyProvider @override String create(NotCopiedFamilyRef ref) { - final fn = _createCb ?? notCopiedFamily; + final _$cb = _createCb ?? notCopiedFamily; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 3329f4ab1..57769b683 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -66,8 +66,8 @@ final class GenericProvider extends $FunctionalProvider< @override FutureOr> create(GenericRef ref) { - final fn = _createCb ?? generic; - return fn(ref); + final _$cb = _createCb ?? generic; + return _$cb(ref); } @override @@ -161,8 +161,8 @@ final class PublicProvider @override FutureOr create(PublicRef ref) { - final fn = _createCb ?? public; - return fn(ref); + final _$cb = _createCb ?? public; + return _$cb(ref); } } @@ -212,8 +212,8 @@ final class _PrivateProvider extends $FunctionalProvider, @override FutureOr create(_PrivateRef ref) { - final fn = _createCb ?? _private; - return fn(ref); + final _$cb = _createCb ?? _private; + return _$cb(ref); } } @@ -279,9 +279,9 @@ final class FamilyOrProvider extends $FunctionalProvider, @override FutureOr create(FamilyOrRef ref) { - final fn = _createCb ?? familyOr; + final _$cb = _createCb ?? familyOr; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); @@ -427,7 +427,7 @@ final class FamilyProvider @override FutureOr create(FamilyRef ref) { - final fn = _createCb ?? family; + final _$cb = _createCb ?? family; final argument = this.argument as ( int, { String? second, @@ -435,7 +435,7 @@ final class FamilyProvider bool fourth, List? fifth, }); - return fn( + return _$cb( ref, argument.$1, second: argument.second, diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 70d33f012..86eb591f2 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -58,8 +58,8 @@ final class KeepAliveProvider @override int create(KeepAliveRef ref) { - final fn = _createCb ?? keepAlive; - return fn(ref); + final _$cb = _createCb ?? keepAlive; + return _$cb(ref); } } @@ -117,8 +117,8 @@ final class NotKeepAliveProvider @override int create(NotKeepAliveRef ref) { - final fn = _createCb ?? notKeepAlive; - return fn(ref); + final _$cb = _createCb ?? notKeepAlive; + return _$cb(ref); } } @@ -176,8 +176,8 @@ final class DefaultKeepAliveProvider @override int create(DefaultKeepAliveRef ref) { - final fn = _createCb ?? defaultKeepAlive; - return fn(ref); + final _$cb = _createCb ?? defaultKeepAlive; + return _$cb(ref); } } @@ -251,9 +251,9 @@ final class KeepAliveFamilyProvider @override int create(KeepAliveFamilyRef ref) { - final fn = _createCb ?? keepAliveFamily; + final _$cb = _createCb ?? keepAliveFamily; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); @@ -382,9 +382,9 @@ final class NotKeepAliveFamilyProvider @override int create(NotKeepAliveFamilyRef ref) { - final fn = _createCb ?? notKeepAliveFamily; + final _$cb = _createCb ?? notKeepAliveFamily; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); @@ -514,9 +514,9 @@ final class DefaultKeepAliveFamilyProvider @override int create(DefaultKeepAliveFamilyRef ref) { - final fn = _createCb ?? defaultKeepAliveFamily; + final _$cb = _createCb ?? defaultKeepAliveFamily; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index d330af741..4d740b514 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -57,8 +57,8 @@ final class DepProvider extends $FunctionalProvider @override int create(DepRef ref) { - final fn = _createCb ?? dep; - return fn(ref); + final _$cb = _createCb ?? dep; + return _$cb(ref); } } @@ -131,9 +131,9 @@ final class FamilyProvider extends $FunctionalProvider @override int create(FamilyRef ref) { - final fn = _createCb ?? family; + final _$cb = _createCb ?? family; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); @@ -260,8 +260,8 @@ final class ProviderProvider extends $FunctionalProvider @override int create(ProviderRef ref) { - final fn = _createCb ?? provider; - return fn(ref); + final _$cb = _createCb ?? provider; + return _$cb(ref); } } @@ -334,8 +334,8 @@ final class Provider2Provider @override int create(Provider2Ref ref) { - final fn = _createCb ?? provider2; - return fn(ref); + final _$cb = _createCb ?? provider2; + return _$cb(ref); } } @@ -409,8 +409,8 @@ final class TransitiveDependenciesProvider @override int create(TransitiveDependenciesRef ref) { - final fn = _createCb ?? transitiveDependencies; - return fn(ref); + final _$cb = _createCb ?? transitiveDependencies; + return _$cb(ref); } } @@ -482,8 +482,8 @@ final class SmallTransitiveDependencyCountProvider @override int create(SmallTransitiveDependencyCountRef ref) { - final fn = _createCb ?? smallTransitiveDependencyCount; - return fn(ref); + final _$cb = _createCb ?? smallTransitiveDependencyCount; + return _$cb(ref); } } @@ -543,8 +543,8 @@ final class EmptyDependenciesFunctionalProvider @override int create(EmptyDependenciesFunctionalRef ref) { - final fn = _createCb ?? emptyDependenciesFunctional; - return fn(ref); + final _$cb = _createCb ?? emptyDependenciesFunctional; + return _$cb(ref); } } @@ -612,8 +612,8 @@ final class ProviderWithDependenciesProvider @override int create(ProviderWithDependenciesRef ref) { - final fn = _createCb ?? providerWithDependencies; - return fn(ref); + final _$cb = _createCb ?? providerWithDependencies; + return _$cb(ref); } } @@ -672,8 +672,8 @@ final class _PrivateDepProvider @override int create(_PrivateDepRef ref) { - final fn = _createCb ?? _privateDep; - return fn(ref); + final _$cb = _createCb ?? _privateDep; + return _$cb(ref); } } @@ -731,8 +731,8 @@ final class PublicDepProvider @override int create(PublicDepRef ref) { - final fn = _createCb ?? publicDep; - return fn(ref); + final _$cb = _createCb ?? publicDep; + return _$cb(ref); } } @@ -796,8 +796,8 @@ final class DuplicateDependenciesProvider @override int create(DuplicateDependenciesRef ref) { - final fn = _createCb ?? duplicateDependencies; - return fn(ref); + final _$cb = _createCb ?? duplicateDependencies; + return _$cb(ref); } } @@ -865,8 +865,8 @@ final class DuplicateDependencies2Provider @override int create(DuplicateDependencies2Ref ref) { - final fn = _createCb ?? duplicateDependencies2; - return fn(ref); + final _$cb = _createCb ?? duplicateDependencies2; + return _$cb(ref); } } @@ -947,8 +947,8 @@ final class TransitiveDuplicateDependenciesProvider @override int create(TransitiveDuplicateDependenciesRef ref) { - final fn = _createCb ?? transitiveDuplicateDependencies; - return fn(ref); + final _$cb = _createCb ?? transitiveDuplicateDependencies; + return _$cb(ref); } } diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 23e503dbb..c535f3288 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -76,8 +76,8 @@ final class ProviderWithDependencies2Provider @override int create(ProviderWithDependencies2Ref ref) { - final fn = _createCb ?? providerWithDependencies2; - return fn(ref); + final _$cb = _createCb ?? providerWithDependencies2; + return _$cb(ref); } } @@ -160,9 +160,9 @@ final class FamilyWithDependencies2Provider @override int create(FamilyWithDependencies2Ref ref) { - final fn = _createCb ?? familyWithDependencies2; + final _$cb = _createCb ?? familyWithDependencies2; final argument = this.argument as int?; - return fn( + return _$cb( ref, id: argument, ); @@ -287,8 +287,8 @@ final class _Private2Provider @override int create(_Private2Ref ref) { - final fn = _createCb ?? _private2; - return fn(ref); + final _$cb = _createCb ?? _private2; + return _$cb(ref); } } @@ -345,8 +345,8 @@ final class Public2Provider extends $FunctionalProvider @override int create(Public2Ref ref) { - final fn = _createCb ?? public2; - return fn(ref); + final _$cb = _createCb ?? public2; + return _$cb(ref); } } diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index c63827fda..67ff42809 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -66,8 +66,8 @@ final class FunctionalProvider @override String create(FunctionalRef ref) { - final fn = _createCb ?? functional; - return fn(ref); + final _$cb = _createCb ?? functional; + return _$cb(ref); } } @@ -149,9 +149,9 @@ final class FamilyProvider @override String create(FamilyRef ref) { - final fn = _createCb ?? family; + final _$cb = _createCb ?? family; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 736fcd1df..ff0301881 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -58,8 +58,8 @@ final class GeneratedProvider @override _Test create(GeneratedRef ref) { - final fn = _createCb ?? generated; - return fn(ref); + final _$cb = _createCb ?? generated; + return _$cb(ref); } } @@ -133,9 +133,9 @@ final class GeneratedFamilyProvider @override _Test create(GeneratedFamilyRef ref) { - final fn = _createCb ?? generatedFamily; + final _$cb = _createCb ?? generatedFamily; final argument = this.argument as _Test; - return fn( + return _$cb( ref, argument, ); @@ -248,8 +248,8 @@ final class $DynamicProvider @override Object? create($DynamicRef ref) { - final fn = _createCb ?? $dynamic; - return fn(ref); + final _$cb = _createCb ?? $dynamic; + return _$cb(ref); } } @@ -323,9 +323,9 @@ final class $DynamicFamilyProvider @override Object? create($DynamicFamilyRef ref) { - final fn = _createCb ?? $dynamicFamily; + final _$cb = _createCb ?? $dynamicFamily; final argument = this.argument as dynamic; - return fn( + return _$cb( ref, argument, ); @@ -454,9 +454,9 @@ final class _DynamicProvider @override Object? create(_DynamicRef ref) { - final fn = _createCb ?? _dynamic; + final _$cb = _createCb ?? _dynamic; final argument = this.argument as dynamic; - return fn( + return _$cb( ref, argument, ); @@ -570,8 +570,8 @@ final class AliasProvider @override r.AsyncValue create(AliasRef ref) { - final fn = _createCb ?? alias; - return fn(ref); + final _$cb = _createCb ?? alias; + return _$cb(ref); } } @@ -647,9 +647,9 @@ final class AliasFamilyProvider extends $FunctionalProvider< @override r.AsyncValue create(AliasFamilyRef ref) { - final fn = _createCb ?? aliasFamily; + final _$cb = _createCb ?? aliasFamily; final argument = this.argument as r.AsyncValue; - return fn( + return _$cb( ref, argument, ); diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index 454c63447..38eb71510 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -58,8 +58,8 @@ final class SimpleProvider @override String create(SimpleRef ref) { - final fn = _createCb ?? simple; - return fn(ref); + final _$cb = _createCb ?? simple; + return _$cb(ref); } } @@ -117,8 +117,8 @@ final class Simple2Provider @override String create(Simple2Ref ref) { - final fn = _createCb ?? simple2; - return fn(ref); + final _$cb = _createCb ?? simple2; + return _$cb(ref); } } diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index 8cef40eab..7f00613a8 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -57,8 +57,8 @@ final class Counter2Provider extends $FunctionalProvider @override int create(Counter2Ref ref) { - final fn = _createCb ?? counter2; - return fn(ref); + final _$cb = _createCb ?? counter2; + return _$cb(ref); } } @@ -115,8 +115,8 @@ final class CounterProvider extends $FunctionalProvider @override int create(CounterRef ref) { - final fn = _createCb ?? counter; - return fn(ref); + final _$cb = _createCb ?? counter; + return _$cb(ref); } } diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index d8d03d470..908d63591 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -66,8 +66,8 @@ final class GenericProvider extends $FunctionalProvider< @override Stream> create(GenericRef ref) { - final fn = _createCb ?? generic; - return fn(ref); + final _$cb = _createCb ?? generic; + return _$cb(ref); } @override @@ -161,8 +161,8 @@ final class PublicProvider @override Stream create(PublicRef ref) { - final fn = _createCb ?? public; - return fn(ref); + final _$cb = _createCb ?? public; + return _$cb(ref); } } @@ -212,8 +212,8 @@ final class _PrivateProvider @override Stream create(_PrivateRef ref) { - final fn = _createCb ?? _private; - return fn(ref); + final _$cb = _createCb ?? _private; + return _$cb(ref); } } @@ -304,7 +304,7 @@ final class FamilyProvider @override Stream create(FamilyRef ref) { - final fn = _createCb ?? family; + final _$cb = _createCb ?? family; final argument = this.argument as ( int, { String? second, @@ -312,7 +312,7 @@ final class FamilyProvider bool fourth, List? fifth, }); - return fn( + return _$cb( ref, argument.$1, second: argument.second, diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index ce66ce731..6a517afd0 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -74,8 +74,8 @@ final class GenericProvider @override List create(GenericRef ref) { - final fn = _createCb ?? generic; - return fn(ref); + final _$cb = _createCb ?? generic; + return _$cb(ref); } @override @@ -219,12 +219,12 @@ final class ComplexGenericProvider @override List create(ComplexGenericRef ref) { - final fn = _createCb ?? complexGeneric; + final _$cb = _createCb ?? complexGeneric; final argument = this.argument as ({ T param, Foo? otherParam, }); - return fn( + return _$cb( ref, param: argument.param, otherParam: argument.otherParam, @@ -354,8 +354,8 @@ final class RawFutureProvider extends $FunctionalProvider< @override Raw> create(RawFutureRef ref) { - final fn = _createCb ?? rawFuture; - return fn(ref); + final _$cb = _createCb ?? rawFuture; + return _$cb(ref); } } @@ -415,8 +415,8 @@ final class RawStreamProvider extends $FunctionalProvider< @override Raw> create(RawStreamRef ref) { - final fn = _createCb ?? rawStream; - return fn(ref); + final _$cb = _createCb ?? rawStream; + return _$cb(ref); } } @@ -491,9 +491,9 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< @override Raw> create(RawFamilyFutureRef ref) { - final fn = _createCb ?? rawFamilyFuture; + final _$cb = _createCb ?? rawFamilyFuture; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); @@ -623,9 +623,9 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< @override Raw> create(RawFamilyStreamRef ref) { - final fn = _createCb ?? rawFamilyStream; + final _$cb = _createCb ?? rawFamilyStream; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); @@ -742,8 +742,8 @@ final class PublicProvider @override String create(PublicRef ref) { - final fn = _createCb ?? public; - return fn(ref); + final _$cb = _createCb ?? public; + return _$cb(ref); } } @@ -801,8 +801,8 @@ final class Supports$inNamesProvider @override String create(Supports$inNamesRef ref) { - final fn = _createCb ?? supports$inNames; - return fn(ref); + final _$cb = _createCb ?? supports$inNames; + return _$cb(ref); } } @@ -905,7 +905,7 @@ final class FamilyProvider @override String create(FamilyRef ref) { - final fn = _createCb ?? family; + final _$cb = _createCb ?? family; final argument = this.argument as ( int, { String? second, @@ -913,7 +913,7 @@ final class FamilyProvider bool fourth, List? fifth, }); - return fn( + return _$cb( ref, argument.$1, second: argument.second, @@ -1054,8 +1054,8 @@ final class _PrivateProvider @override String create(_PrivateRef ref) { - final fn = _createCb ?? _private; - return fn(ref); + final _$cb = _createCb ?? _private; + return _$cb(ref); } } @@ -1130,8 +1130,8 @@ final class Supports$InFnNameProvider @override String create(Supports$InFnNameRef ref) { - final fn = _createCb ?? supports$InFnName; - return fn(ref); + final _$cb = _createCb ?? supports$InFnName; + return _$cb(ref); } @override @@ -1284,13 +1284,13 @@ final class Supports$InFnNameFamilyProvider @override String create(Supports$InFnNameFamilyRef ref) { - final fn = _createCb ?? supports$InFnNameFamily; + final _$cb = _createCb ?? supports$InFnNameFamily; final argument = this.argument as ( And$InT, { And$InT named$arg, String defaultArg, }); - return fn( + return _$cb( ref, argument.$1, named$arg: argument.named$arg, @@ -1425,8 +1425,8 @@ final class GeneratedProvider @override String create(GeneratedRef ref) { - final fn = _createCb ?? generated; - return fn(ref); + final _$cb = _createCb ?? generated; + return _$cb(ref); } } @@ -1500,9 +1500,9 @@ final class UnnecessaryCastProvider @override String create(UnnecessaryCastRef ref) { - final fn = _createCb ?? unnecessaryCast; + final _$cb = _createCb ?? unnecessaryCast; final argument = this.argument; - return fn( + return _$cb( ref, argument, ); diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 0b7d1b81e..34a2636b8 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -62,8 +62,8 @@ final class PublicProvider @override String create(PublicRef ref) { - final fn = _createCb ?? public; - return fn(ref); + final _$cb = _createCb ?? public; + return _$cb(ref); } } @@ -125,8 +125,8 @@ final class Supports$inNamesProvider @override String create(Supports$inNamesRef ref) { - final fn = _createCb ?? supports$inNames; - return fn(ref); + final _$cb = _createCb ?? supports$inNames; + return _$cb(ref); } } @@ -229,7 +229,7 @@ final class FamilyProvider @override String create(FamilyRef ref) { - final fn = _createCb ?? family; + final _$cb = _createCb ?? family; final argument = this.argument as ( int, { String? second, @@ -237,7 +237,7 @@ final class FamilyProvider bool forth, List? fifth, }); - return fn( + return _$cb( ref, argument.$1, second: argument.second, @@ -378,8 +378,8 @@ final class _PrivateProvider @override String create(_PrivateRef ref) { - final fn = _createCb ?? _private; - return fn(ref); + final _$cb = _createCb ?? _private; + return _$cb(ref); } } diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index 4652c6bf1..6835004da 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -61,8 +61,8 @@ final class ExampleProvider extends $FunctionalProvider @override int create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } @@ -150,12 +150,12 @@ final class ExampleFamilyProvider @override int create(ExampleFamilyRef ref) { - final fn = _createCb ?? exampleFamily; + final _$cb = _createCb ?? exampleFamily; final argument = this.argument as ({ int a, String b, }); - return fn( + return _$cb( ref, a: argument.a, b: argument.b, diff --git a/packages/riverpod_lint_flutter_test/test/lints/another.g.dart b/packages/riverpod_lint_flutter_test/test/lints/another.g.dart index 0d1229ab3..88968f6a9 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/another.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/another.g.dart @@ -57,8 +57,8 @@ final class BProvider extends $FunctionalProvider @override int create(BRef ref) { - final fn = _createCb ?? b; - return fn(ref); + final _$cb = _createCb ?? b; + return _$cb(ref); } } diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index d2fcee51b..c397dd31c 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -83,12 +83,12 @@ final class FnProvider extends $FunctionalProvider @override int create(FnRef ref) { - final fn = _createCb ?? fn; + final _$cb = _createCb ?? fn; final argument = this.argument as ( BuildContext, { BuildContext context2, }); - return fn( + return _$cb( ref, argument.$1, context2: argument.context2, diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index 7fcdaf062..5e5982dc4 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -57,8 +57,8 @@ final class DepProvider extends $FunctionalProvider @override int create(DepRef ref) { - final fn = _createCb ?? dep; - return fn(ref); + final _$cb = _createCb ?? dep; + return _$cb(ref); } } @@ -116,8 +116,8 @@ final class GeneratedScopedProvider @override int create(GeneratedScopedRef ref) { - final fn = _createCb ?? generatedScoped; - return fn(ref); + final _$cb = _createCb ?? generatedScoped; + return _$cb(ref); } } @@ -175,8 +175,8 @@ final class GeneratedRootProvider @override int create(GeneratedRootRef ref) { - final fn = _createCb ?? generatedRoot; - return fn(ref); + final _$cb = _createCb ?? generatedRoot; + return _$cb(ref); } } @@ -235,8 +235,8 @@ final class WatchScopedButNoDependenciesProvider @override int create(WatchScopedButNoDependenciesRef ref) { - final fn = _createCb ?? watchScopedButNoDependencies; - return fn(ref); + final _$cb = _createCb ?? watchScopedButNoDependencies; + return _$cb(ref); } } @@ -298,8 +298,8 @@ final class WatchGeneratedScopedButNoDependenciesProvider @override int create(WatchGeneratedScopedButNoDependenciesRef ref) { - final fn = _createCb ?? watchGeneratedScopedButNoDependencies; - return fn(ref); + final _$cb = _createCb ?? watchGeneratedScopedButNoDependencies; + return _$cb(ref); } } @@ -359,8 +359,8 @@ final class WatchRootButNoDependenciesProvider @override int create(WatchRootButNoDependenciesRef ref) { - final fn = _createCb ?? watchRootButNoDependencies; - return fn(ref); + final _$cb = _createCb ?? watchRootButNoDependencies; + return _$cb(ref); } } @@ -422,8 +422,8 @@ final class WatchGeneratedRootButNoDependenciesProvider @override int create(WatchGeneratedRootButNoDependenciesRef ref) { - final fn = _createCb ?? watchGeneratedRootButNoDependencies; - return fn(ref); + final _$cb = _createCb ?? watchGeneratedRootButNoDependencies; + return _$cb(ref); } } @@ -483,8 +483,8 @@ final class WatchScopedButEmptyDependenciesProvider @override int create(WatchScopedButEmptyDependenciesRef ref) { - final fn = _createCb ?? watchScopedButEmptyDependencies; - return fn(ref); + final _$cb = _createCb ?? watchScopedButEmptyDependencies; + return _$cb(ref); } } @@ -546,8 +546,8 @@ final class WatchGeneratedScopedButEmptyDependenciesProvider @override int create(WatchGeneratedScopedButEmptyDependenciesRef ref) { - final fn = _createCb ?? watchGeneratedScopedButEmptyDependencies; - return fn(ref); + final _$cb = _createCb ?? watchGeneratedScopedButEmptyDependencies; + return _$cb(ref); } } @@ -607,8 +607,8 @@ final class WatchRootButEmptyDependenciesProvider @override int create(WatchRootButEmptyDependenciesRef ref) { - final fn = _createCb ?? watchRootButEmptyDependencies; - return fn(ref); + final _$cb = _createCb ?? watchRootButEmptyDependencies; + return _$cb(ref); } } @@ -670,8 +670,8 @@ final class WatchGeneratedRootButEmptyDependenciesProvider @override int create(WatchGeneratedRootButEmptyDependenciesRef ref) { - final fn = _createCb ?? watchGeneratedRootButEmptyDependencies; - return fn(ref); + final _$cb = _createCb ?? watchGeneratedRootButEmptyDependencies; + return _$cb(ref); } } @@ -737,8 +737,8 @@ final class WatchScopedButMissingDependenciesProvider @override int create(WatchScopedButMissingDependenciesRef ref) { - final fn = _createCb ?? watchScopedButMissingDependencies; - return fn(ref); + final _$cb = _createCb ?? watchScopedButMissingDependencies; + return _$cb(ref); } } @@ -805,8 +805,8 @@ final class WatchGeneratedScopedButMissingDependenciesProvider @override int create(WatchGeneratedScopedButMissingDependenciesRef ref) { - final fn = _createCb ?? watchGeneratedScopedButMissingDependencies; - return fn(ref); + final _$cb = _createCb ?? watchGeneratedScopedButMissingDependencies; + return _$cb(ref); } } @@ -870,8 +870,8 @@ final class WatchRootButMissingDependenciesProvider @override int create(WatchRootButMissingDependenciesRef ref) { - final fn = _createCb ?? watchRootButMissingDependencies; - return fn(ref); + final _$cb = _createCb ?? watchRootButMissingDependencies; + return _$cb(ref); } } @@ -938,8 +938,8 @@ final class WatchGeneratedRootButMissingDependenciesProvider @override int create(WatchGeneratedRootButMissingDependenciesRef ref) { - final fn = _createCb ?? watchGeneratedRootButMissingDependencies; - return fn(ref); + final _$cb = _createCb ?? watchGeneratedRootButMissingDependencies; + return _$cb(ref); } } @@ -1006,8 +1006,8 @@ final class WatchGeneratedScopedAndContainsDependencyProvider @override int create(WatchGeneratedScopedAndContainsDependencyRef ref) { - final fn = _createCb ?? watchGeneratedScopedAndContainsDependency; - return fn(ref); + final _$cb = _createCb ?? watchGeneratedScopedAndContainsDependency; + return _$cb(ref); } } @@ -1074,8 +1074,8 @@ final class WatchGeneratedRootAndContainsDependencyProvider @override int create(WatchGeneratedRootAndContainsDependencyRef ref) { - final fn = _createCb ?? watchGeneratedRootAndContainsDependency; - return fn(ref); + final _$cb = _createCb ?? watchGeneratedRootAndContainsDependency; + return _$cb(ref); } } @@ -1144,8 +1144,8 @@ final class SpecifiedDependencyButNeverUsedProvider @override int create(SpecifiedDependencyButNeverUsedRef ref) { - final fn = _createCb ?? specifiedDependencyButNeverUsed; - return fn(ref); + final _$cb = _createCb ?? specifiedDependencyButNeverUsed; + return _$cb(ref); } } @@ -1208,8 +1208,8 @@ final class Regression2348Provider @override int create(Regression2348Ref ref) { - final fn = _createCb ?? regression2348; - return fn(ref); + final _$cb = _createCb ?? regression2348; + return _$cb(ref); } } @@ -1285,9 +1285,9 @@ final class FamilyDepProvider @override int create(FamilyDepRef ref) { - final fn = _createCb ?? familyDep; + final _$cb = _createCb ?? familyDep; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); @@ -1422,9 +1422,9 @@ final class FamilyDep2Provider @override int create(FamilyDep2Ref ref) { - final fn = _createCb ?? familyDep2; + final _$cb = _createCb ?? familyDep2; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); @@ -1539,8 +1539,8 @@ final class AliasProvider extends $FunctionalProvider @override int create(AliasRef ref) { - final fn = _createCb ?? alias; - return fn(ref); + final _$cb = _createCb ?? alias; + return _$cb(ref); } } diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 0415af67f..087a255a4 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -57,8 +57,8 @@ final class NamelessProvider extends $FunctionalProvider @override int create(NamelessRef ref) { - final fn = _createCb ?? nameless; - return fn(ref); + final _$cb = _createCb ?? nameless; + return _$cb(ref); } } @@ -115,8 +115,8 @@ final class ScopedProvider extends $FunctionalProvider @override int create(ScopedRef ref) { - final fn = _createCb ?? scoped; - return fn(ref); + final _$cb = _createCb ?? scoped; + return _$cb(ref); } } @@ -191,8 +191,8 @@ final class GenericsProvider @override int create(GenericsRef ref) { - final fn = _createCb ?? generics; - return fn(ref); + final _$cb = _createCb ?? generics; + return _$cb(ref); } @override @@ -312,8 +312,8 @@ final class NoGenericsProvider @override int create(NoGenericsRef ref) { - final fn = _createCb ?? noGenerics; - return fn(ref); + final _$cb = _createCb ?? noGenerics; + return _$cb(ref); } @override @@ -433,8 +433,8 @@ final class MissingGenericsProvider @override int create(MissingGenericsRef ref) { - final fn = _createCb ?? missingGenerics; - return fn(ref); + final _$cb = _createCb ?? missingGenerics; + return _$cb(ref); } @override @@ -554,8 +554,8 @@ final class WrongOrderProvider @override int create(WrongOrderRef ref) { - final fn = _createCb ?? wrongOrder; - return fn(ref); + final _$cb = _createCb ?? wrongOrder; + return _$cb(ref); } @override diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart index 1c68cf50d..98cb70621 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart @@ -57,8 +57,8 @@ final class DepProvider extends $FunctionalProvider @override int create(DepRef ref) { - final fn = _createCb ?? dep; - return fn(ref); + final _$cb = _createCb ?? dep; + return _$cb(ref); } } @@ -115,8 +115,8 @@ final class Dep2Provider extends $FunctionalProvider @override int create(Dep2Ref ref) { - final fn = _createCb ?? dep2; - return fn(ref); + final _$cb = _createCb ?? dep2; + return _$cb(ref); } } @@ -182,8 +182,8 @@ final class PlainAnnotationProvider @override int create(PlainAnnotationRef ref) { - final fn = _createCb ?? plainAnnotation; - return fn(ref); + final _$cb = _createCb ?? plainAnnotation; + return _$cb(ref); } } @@ -241,8 +241,8 @@ final class CustomAnnotationProvider @override int create(CustomAnnotationRef ref) { - final fn = _createCb ?? customAnnotation; - return fn(ref); + final _$cb = _createCb ?? customAnnotation; + return _$cb(ref); } } @@ -302,8 +302,8 @@ final class CustomAnnotationWithTrailingCommaProvider @override int create(CustomAnnotationWithTrailingCommaRef ref) { - final fn = _createCb ?? customAnnotationWithTrailingComma; - return fn(ref); + final _$cb = _createCb ?? customAnnotationWithTrailingComma; + return _$cb(ref); } } @@ -362,8 +362,8 @@ final class ExistingDepProvider @override int create(ExistingDepRef ref) { - final fn = _createCb ?? existingDep; - return fn(ref); + final _$cb = _createCb ?? existingDep; + return _$cb(ref); } } @@ -421,8 +421,8 @@ final class MultipleDepsProvider @override int create(MultipleDepsRef ref) { - final fn = _createCb ?? multipleDeps; - return fn(ref); + final _$cb = _createCb ?? multipleDeps; + return _$cb(ref); } } @@ -485,8 +485,8 @@ final class ExtraDepProvider extends $FunctionalProvider @override int create(ExtraDepRef ref) { - final fn = _createCb ?? extraDep; - return fn(ref); + final _$cb = _createCb ?? extraDep; + return _$cb(ref); } } @@ -547,8 +547,8 @@ final class NoDepProvider extends $FunctionalProvider @override int create(NoDepRef ref) { - final fn = _createCb ?? noDep; - return fn(ref); + final _$cb = _createCb ?? noDep; + return _$cb(ref); } } @@ -611,8 +611,8 @@ final class DependenciesFirstThenKeepAliveProvider @override int create(DependenciesFirstThenKeepAliveRef ref) { - final fn = _createCb ?? dependenciesFirstThenKeepAlive; - return fn(ref); + final _$cb = _createCb ?? dependenciesFirstThenKeepAlive; + return _$cb(ref); } } @@ -675,8 +675,8 @@ final class NoDepNoParamProvider @override int create(NoDepNoParamRef ref) { - final fn = _createCb ?? noDepNoParam; - return fn(ref); + final _$cb = _createCb ?? noDepNoParam; + return _$cb(ref); } } @@ -738,8 +738,8 @@ final class NoDepWithoutCommaProvider @override int create(NoDepWithoutCommaRef ref) { - final fn = _createCb ?? noDepWithoutComma; - return fn(ref); + final _$cb = _createCb ?? noDepWithoutComma; + return _$cb(ref); } } diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 875c0c85c..f327620e0 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -74,9 +74,9 @@ final class GeneratorProvider @override int create(GeneratorRef ref) { - final fn = _createCb ?? generator; + final _$cb = _createCb ?? generator; final argument = this.argument; - return fn( + return _$cb( ref, value: argument, ); diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart index 1d26d4c6e..cf6a92a00 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart @@ -57,8 +57,8 @@ final class ScopedProvider extends $FunctionalProvider @override int create(ScopedRef ref) { - final fn = _createCb ?? scoped; - return fn(ref); + final _$cb = _createCb ?? scoped; + return _$cb(ref); } } @@ -116,8 +116,8 @@ final class UnimplementedScopedProvider @override int create(UnimplementedScopedRef ref) { - final fn = _createCb ?? unimplementedScoped; - return fn(ref); + final _$cb = _createCb ?? unimplementedScoped; + return _$cb(ref); } } @@ -175,8 +175,8 @@ final class RootProvider extends $FunctionalProvider @override int create(RootRef ref) { - final fn = _createCb ?? root; - return fn(ref); + final _$cb = _createCb ?? root; + return _$cb(ref); } } diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart index 4af3eaf0d..638a9b5e4 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart @@ -57,8 +57,8 @@ final class IntegerProvider extends $FunctionalProvider @override int create(IntegerRef ref) { - final fn = _createCb ?? integer; - return fn(ref); + final _$cb = _createCb ?? integer; + return _$cb(ref); } } @@ -118,8 +118,8 @@ final class StateNotifierProvider extends $FunctionalProvider< @override MyStateNotifier create(StateNotifierRef ref) { - final fn = _createCb ?? stateNotifier; - return fn(ref); + final _$cb = _createCb ?? stateNotifier; + return _$cb(ref); } } @@ -174,8 +174,8 @@ final class AsyncStateNotifierProvider extends $FunctionalProvider< @override FutureOr create(AsyncStateNotifierRef ref) { - final fn = _createCb ?? asyncStateNotifier; - return fn(ref); + final _$cb = _createCb ?? asyncStateNotifier; + return _$cb(ref); } } @@ -231,8 +231,8 @@ final class StateNotifierAsyncProvider extends $FunctionalProvider< @override FutureOr create(StateNotifierAsyncRef ref) { - final fn = _createCb ?? stateNotifierAsync; - return fn(ref); + final _$cb = _createCb ?? stateNotifierAsync; + return _$cb(ref); } } @@ -293,8 +293,8 @@ final class ChangeNotifierProvider extends $FunctionalProvider< @override MyChangeNotifier create(ChangeNotifierRef ref) { - final fn = _createCb ?? changeNotifier; - return fn(ref); + final _$cb = _createCb ?? changeNotifier; + return _$cb(ref); } } @@ -352,8 +352,8 @@ final class NotifierProvider @override MyNotifier create(NotifierRef ref) { - final fn = _createCb ?? notifier; - return fn(ref); + final _$cb = _createCb ?? notifier; + return _$cb(ref); } } @@ -412,8 +412,8 @@ final class AutoDisposeNotifierProvider extends $FunctionalProvider< @override MyAutoDisposeNotifier create(AutoDisposeNotifierRef ref) { - final fn = _createCb ?? autoDisposeNotifier; - return fn(ref); + final _$cb = _createCb ?? autoDisposeNotifier; + return _$cb(ref); } } @@ -474,8 +474,8 @@ final class AsyncNotifierProvider extends $FunctionalProvider< @override MyAsyncNotifier create(AsyncNotifierRef ref) { - final fn = _createCb ?? asyncNotifier; - return fn(ref); + final _$cb = _createCb ?? asyncNotifier; + return _$cb(ref); } } @@ -535,8 +535,8 @@ final class RawNotifierProvider extends $FunctionalProvider< @override Raw create(RawNotifierRef ref) { - final fn = _createCb ?? rawNotifier; - return fn(ref); + final _$cb = _createCb ?? rawNotifier; + return _$cb(ref); } } @@ -597,8 +597,8 @@ final class RawFutureNotifierProvider extends $FunctionalProvider< @override Raw> create(RawFutureNotifierRef ref) { - final fn = _createCb ?? rawFutureNotifier; - return fn(ref); + final _$cb = _createCb ?? rawFutureNotifier; + return _$cb(ref); } } @@ -659,8 +659,8 @@ final class RawStreamNotifierProvider extends $FunctionalProvider< @override Raw> create(RawStreamNotifierRef ref) { - final fn = _createCb ?? rawStreamNotifier; - return fn(ref); + final _$cb = _createCb ?? rawStreamNotifier; + return _$cb(ref); } } @@ -715,8 +715,8 @@ final class FutureRawNotifierProvider extends $FunctionalProvider< @override FutureOr> create(FutureRawNotifierRef ref) { - final fn = _createCb ?? futureRawNotifier; - return fn(ref); + final _$cb = _createCb ?? futureRawNotifier; + return _$cb(ref); } } @@ -771,8 +771,8 @@ final class StreamRawNotifierProvider extends $FunctionalProvider< @override Stream> create(StreamRawNotifierRef ref) { - final fn = _createCb ?? streamRawNotifier; - return fn(ref); + final _$cb = _createCb ?? streamRawNotifier; + return _$cb(ref); } } diff --git a/website/docs/advanced/select/select/codegen.g.dart b/website/docs/advanced/select/select/codegen.g.dart index f6057ff06..3014d78df 100644 --- a/website/docs/advanced/select/select/codegen.g.dart +++ b/website/docs/advanced/select/select/codegen.g.dart @@ -59,8 +59,8 @@ final class ExampleProvider extends $FunctionalProvider @override User create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/advanced/select/select_async/codegen.g.dart b/website/docs/advanced/select/select_async/codegen.g.dart index d0bd8c0e0..a0f33eb3c 100644 --- a/website/docs/advanced/select/select_async/codegen.g.dart +++ b/website/docs/advanced/select/select_async/codegen.g.dart @@ -60,8 +60,8 @@ final class ExampleProvider @override Object? create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart index ecdab0bce..0c36b2053 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart @@ -72,8 +72,8 @@ final class ActivityProvider extends $FunctionalProvider, @override FutureOr create(ActivityRef ref) { - final fn = _createCb ?? activity; - return fn(ref); + final _$cb = _createCb ?? activity; + return _$cb(ref); } } diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart index be6062d04..44faaf40b 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -52,8 +52,8 @@ final class ActivityProvider extends $FunctionalProvider, @override FutureOr create(ActivityRef ref) { - final fn = _createCb ?? activity; - return fn(ref); + final _$cb = _createCb ?? activity; + return _$cb(ref); } } diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart index e86787356..61417d472 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -52,8 +52,8 @@ final class ActivityProvider extends $FunctionalProvider, @override FutureOr create(ActivityRef ref) { - final fn = _createCb ?? activity; - return fn(ref); + final _$cb = _createCb ?? activity; + return _$cb(ref); } } diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart index ca0e8ec04..f4ff64ea1 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -52,8 +52,8 @@ final class ActivityProvider extends $FunctionalProvider, @override FutureOr create(ActivityRef ref) { - final fn = _createCb ?? activity; - return fn(ref); + final _$cb = _createCb ?? activity; + return _$cb(ref); } } diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart index 8b10f4971..30843751f 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -52,8 +52,8 @@ final class ActivityProvider extends $FunctionalProvider, @override FutureOr create(ActivityRef ref) { - final fn = _createCb ?? activity; - return fn(ref); + final _$cb = _createCb ?? activity; + return _$cb(ref); } } diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart index ecdab0bce..0c36b2053 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -72,8 +72,8 @@ final class ActivityProvider extends $FunctionalProvider, @override FutureOr create(ActivityRef ref) { - final fn = _createCb ?? activity; - return fn(ref); + final _$cb = _createCb ?? activity; + return _$cb(ref); } } diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 8affd2176..646d4ba60 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -68,9 +68,9 @@ final class FetchUserProvider @override FutureOr create(FetchUserRef ref) { - final fn = _createCb ?? fetchUser; + final _$cb = _createCb ?? fetchUser; final argument = this.argument as int; - return fn( + return _$cb( ref, userId: argument, ); diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart index 2fbdf1243..b94f5401e 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -52,8 +52,8 @@ final class ExampleProvider extends $FunctionalProvider, @override FutureOr create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart index b937f6ae5..cbda18ab2 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -52,8 +52,8 @@ final class ExampleProvider @override Stream create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart index 18d1ccc7f..3d647a07d 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -60,8 +60,8 @@ final class Example1Provider @override String create(Example1Ref ref) { - final fn = _createCb ?? example1; - return fn(ref); + final _$cb = _createCb ?? example1; + return _$cb(ref); } } @@ -119,8 +119,8 @@ final class Example2Provider @override String create(Example2Ref ref) { - final fn = _createCb ?? example2; - return fn(ref); + final _$cb = _createCb ?? example2; + return _$cb(ref); } } diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 0f1713374..a529e472e 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -76,9 +76,9 @@ final class ExampleProvider @override String create(ExampleRef ref) { - final fn = _createCb ?? example; + final _$cb = _createCb ?? example; final argument = this.argument as int; - return fn( + return _$cb( ref, argument, ); diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index 7772a1ecd..8a03656f1 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -86,12 +86,12 @@ final class ExampleProvider @override String create(ExampleRef ref) { - final fn = _createCb ?? example; + final _$cb = _createCb ?? example; final argument = this.argument as ( int, { String param2, }); - return fn( + return _$cb( ref, argument.$1, param2: argument.param2, diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart index e16298e38..4cea95277 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -60,8 +60,8 @@ final class ExampleProvider @override String create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart index 834165c28..6dd0be274 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -55,8 +55,8 @@ final class ConfigsProvider extends $FunctionalProvider< @override Stream create(ConfigsRef ref) { - final fn = _createCb ?? configs; - return fn(ref); + final _$cb = _createCb ?? configs; + return _$cb(ref); } } @@ -109,8 +109,8 @@ final class CharactersProvider extends $FunctionalProvider< @override FutureOr> create(CharactersRef ref) { - final fn = _createCb ?? characters; - return fn(ref); + final _$cb = _createCb ?? characters; + return _$cb(ref); } } diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart index 4d3ef30a9..d17ff088f 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -59,8 +59,8 @@ final class CityProvider extends $FunctionalProvider @override String create(CityRef ref) { - final fn = _createCb ?? city; - return fn(ref); + final _$cb = _createCb ?? city; + return _$cb(ref); } } diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart index 07500a16d..1a1dbc2ab 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -60,8 +60,8 @@ final class FilteredTodoListProvider @override List create(FilteredTodoListRef ref) { - final fn = _createCb ?? filteredTodoList; - return fn(ref); + final _$cb = _createCb ?? filteredTodoList; + return _$cb(ref); } } diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart index 543a2a8aa..6245253cc 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -60,8 +60,8 @@ final class AnotherProvider @override MyValue create(AnotherRef ref) { - final fn = _createCb ?? another; - return fn(ref); + final _$cb = _createCb ?? another; + return _$cb(ref); } } @@ -118,8 +118,8 @@ final class MyProvider extends $FunctionalProvider @override MyValue create(MyRef ref) { - final fn = _createCb ?? my; - return fn(ref); + final _$cb = _createCb ?? my; + return _$cb(ref); } } diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart index 62a465661..ce2291f66 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -55,8 +55,8 @@ final class ConfigProvider extends $FunctionalProvider< @override Stream create(ConfigRef ref) { - final fn = _createCb ?? config; - return fn(ref); + final _$cb = _createCb ?? config; + return _$cb(ref); } } @@ -109,8 +109,8 @@ final class ProductsProvider extends $FunctionalProvider< @override FutureOr> create(ProductsRef ref) { - final fn = _createCb ?? products; - return fn(ref); + final _$cb = _createCb ?? products; + return _$cb(ref); } } diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart index cdbf9a6d0..b7bb28b9b 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -59,8 +59,8 @@ final class CityProvider extends $FunctionalProvider @override String create(CityRef ref) { - final fn = _createCb ?? city; - return fn(ref); + final _$cb = _createCb ?? city; + return _$cb(ref); } } @@ -110,8 +110,8 @@ final class WeatherProvider extends $FunctionalProvider, @override FutureOr create(WeatherRef ref) { - final fn = _createCb ?? weather; - return fn(ref); + final _$cb = _createCb ?? weather; + return _$cb(ref); } } diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart index dff9516ff..a9317e8b9 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -55,8 +55,8 @@ final class ConfigProvider extends $FunctionalProvider< @override Stream create(ConfigRef ref) { - final fn = _createCb ?? config; - return fn(ref); + final _$cb = _createCb ?? config; + return _$cb(ref); } } @@ -109,8 +109,8 @@ final class ProductsProvider extends $FunctionalProvider< @override FutureOr> create(ProductsRef ref) { - final fn = _createCb ?? products; - return fn(ref); + final _$cb = _createCb ?? products; + return _$cb(ref); } } diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart index 95c3c31bc..ee97df1b7 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart @@ -52,8 +52,8 @@ final class ExampleProvider @override Stream create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart index 4487de80c..57eef91e0 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart @@ -59,8 +59,8 @@ final class MyProvider extends $FunctionalProvider @override MyValue create(MyRef ref) { - final fn = _createCb ?? my; - return fn(ref); + final _$cb = _createCb ?? my; + return _$cb(ref); } } diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart index 551c40c07..73887db79 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart @@ -59,8 +59,8 @@ final class CityProvider extends $FunctionalProvider @override String create(CityRef ref) { - final fn = _createCb ?? city; - return fn(ref); + final _$cb = _createCb ?? city; + return _$cb(ref); } } @@ -118,8 +118,8 @@ final class CountryProvider @override String create(CountryRef ref) { - final fn = _createCb ?? country; - return fn(ref); + final _$cb = _createCb ?? country; + return _$cb(ref); } } diff --git a/website/docs/concepts/reading/listen/codegen.g.dart b/website/docs/concepts/reading/listen/codegen.g.dart index 96a88ef69..f67a22f9e 100644 --- a/website/docs/concepts/reading/listen/codegen.g.dart +++ b/website/docs/concepts/reading/listen/codegen.g.dart @@ -59,8 +59,8 @@ final class AnotherProvider extends $FunctionalProvider @override void create(AnotherRef ref) { - final fn = _createCb ?? another; - return fn(ref); + final _$cb = _createCb ?? another; + return _$cb(ref); } } diff --git a/website/docs/concepts/reading/provider/codegen.g.dart b/website/docs/concepts/reading/provider/codegen.g.dart index d1a6c89b7..0d25dbdcc 100644 --- a/website/docs/concepts/reading/provider/codegen.g.dart +++ b/website/docs/concepts/reading/provider/codegen.g.dart @@ -60,8 +60,8 @@ final class RepositoryProvider @override Repository create(RepositoryRef ref) { - final fn = _createCb ?? repository; - return fn(ref); + final _$cb = _createCb ?? repository; + return _$cb(ref); } } @@ -118,8 +118,8 @@ final class ValueProvider extends $FunctionalProvider @override String create(ValueRef ref) { - final fn = _createCb ?? value; - return fn(ref); + final _$cb = _createCb ?? value; + return _$cb(ref); } } diff --git a/website/docs/concepts/reading/watch/codegen.g.dart b/website/docs/concepts/reading/watch/codegen.g.dart index 3855e5438..585133263 100644 --- a/website/docs/concepts/reading/watch/codegen.g.dart +++ b/website/docs/concepts/reading/watch/codegen.g.dart @@ -60,8 +60,8 @@ final class FilterTypeProvider @override FilterType create(FilterTypeRef ref) { - final fn = _createCb ?? filterType; - return fn(ref); + final _$cb = _createCb ?? filterType; + return _$cb(ref); } } @@ -119,8 +119,8 @@ final class FilteredTodoListProvider @override List create(FilteredTodoListRef ref) { - final fn = _createCb ?? filteredTodoList; - return fn(ref); + final _$cb = _createCb ?? filteredTodoList; + return _$cb(ref); } } diff --git a/website/docs/concepts/reading/watch_build/codegen.g.dart b/website/docs/concepts/reading/watch_build/codegen.g.dart index 011551c7d..571be96d3 100644 --- a/website/docs/concepts/reading/watch_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen.g.dart @@ -59,8 +59,8 @@ final class CounterProvider extends $FunctionalProvider @override int create(CounterRef ref) { - final fn = _createCb ?? counter; - return fn(ref); + final _$cb = _createCb ?? counter; + return _$cb(ref); } } diff --git a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart index d949cfae4..7bd663d14 100644 --- a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart @@ -59,8 +59,8 @@ final class CounterProvider extends $FunctionalProvider @override int create(CounterRef ref) { - final fn = _createCb ?? counter; - return fn(ref); + final _$cb = _createCb ?? counter; + return _$cb(ref); } } diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart index 20657689e..2b0c0fde5 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -52,8 +52,8 @@ final class ExampleProvider extends $FunctionalProvider, @override FutureOr create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart index bbda271f7..f388f08f3 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -59,8 +59,8 @@ final class ExampleProvider extends $FunctionalProvider @override int create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index c64a1b14a..f7fe3e526 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -75,9 +75,9 @@ final class LabelProvider extends $FunctionalProvider @override String create(LabelRef ref) { - final fn = _createCb ?? label; + final _$cb = _createCb ?? label; final argument = this.argument as String; - return fn( + return _$cb( ref, argument, ); diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart index b916108fe..76513b615 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -52,8 +52,8 @@ final class ExampleProvider extends $FunctionalProvider, @override FutureOr create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart index 84d21d8ac..f8ee2895c 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -59,8 +59,8 @@ final class OtherProvider extends $FunctionalProvider @override int create(OtherRef ref) { - final fn = _createCb ?? other; - return fn(ref); + final _$cb = _createCb ?? other; + return _$cb(ref); } } @@ -110,8 +110,8 @@ final class ExampleProvider @override Stream create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart index 4ae133dfa..2d2aa51b4 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart @@ -59,8 +59,8 @@ final class OtherProvider extends $FunctionalProvider @override int create(OtherRef ref) { - final fn = _createCb ?? other; - return fn(ref); + final _$cb = _createCb ?? other; + return _$cb(ref); } } @@ -117,8 +117,8 @@ final class ExampleProvider extends $FunctionalProvider @override int create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart index 9f292b611..3696d27bc 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart @@ -59,8 +59,8 @@ final class ExampleProvider extends $FunctionalProvider @override int create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart index 222349caa..3373f4a7a 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -59,8 +59,8 @@ final class OtherProvider extends $FunctionalProvider @override int create(OtherRef ref) { - final fn = _createCb ?? other; - return fn(ref); + final _$cb = _createCb ?? other; + return _$cb(ref); } } diff --git a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart index 07848b382..4ab444d4f 100644 --- a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart @@ -57,8 +57,8 @@ final class LocationProvider extends $FunctionalProvider< @override Stream<({double longitude, double latitude})> create(LocationRef ref) { - final fn = _createCb ?? location; - return fn(ref); + final _$cb = _createCb ?? location; + return _$cb(ref); } } @@ -111,8 +111,8 @@ final class RestaurantsNearMeProvider extends $FunctionalProvider< @override FutureOr> create(RestaurantsNearMeRef ref) { - final fn = _createCb ?? restaurantsNearMe; - return fn(ref); + final _$cb = _createCb ?? restaurantsNearMe; + return _$cb(ref); } } diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart index 0690dacec..5993dc5c7 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart @@ -59,8 +59,8 @@ final class ExampleProvider extends $FunctionalProvider @override int create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart index 3b64e7e32..7ced3b8b4 100644 --- a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart +++ b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart @@ -52,8 +52,8 @@ final class ExampleProvider extends $FunctionalProvider, @override FutureOr create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/essentials/first_request/codegen/provider.g.dart b/website/docs/essentials/first_request/codegen/provider.g.dart index 4709142f3..f8ec4b80b 100644 --- a/website/docs/essentials/first_request/codegen/provider.g.dart +++ b/website/docs/essentials/first_request/codegen/provider.g.dart @@ -60,8 +60,8 @@ final class ActivityProvider extends $FunctionalProvider, @override FutureOr create(ActivityRef ref) { - final fn = _createCb ?? activity; - return fn(ref); + final _$cb = _createCb ?? activity; + return _$cb(ref); } } diff --git a/website/docs/essentials/passing_args/codegen/family.g.dart b/website/docs/essentials/passing_args/codegen/family.g.dart index 8989f84b4..6068e640d 100644 --- a/website/docs/essentials/passing_args/codegen/family.g.dart +++ b/website/docs/essentials/passing_args/codegen/family.g.dart @@ -68,9 +68,9 @@ final class ActivityProvider extends $FunctionalProvider, @override FutureOr create(ActivityRef ref) { - final fn = _createCb ?? activity; + final _$cb = _createCb ?? activity; final argument = this.argument as String; - return fn( + return _$cb( ref, argument, ); diff --git a/website/docs/essentials/passing_args/codegen/provider.g.dart b/website/docs/essentials/passing_args/codegen/provider.g.dart index 47145a6bf..38fa644b5 100644 --- a/website/docs/essentials/passing_args/codegen/provider.g.dart +++ b/website/docs/essentials/passing_args/codegen/provider.g.dart @@ -52,8 +52,8 @@ final class ActivityProvider extends $FunctionalProvider, @override FutureOr create(ActivityRef ref) { - final fn = _createCb ?? activity; - return fn(ref); + final _$cb = _createCb ?? activity; + return _$cb(ref); } } diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart index 7ffb53391..cd63468c9 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -53,8 +53,8 @@ final class TodoListProvider extends $FunctionalProvider>, @override FutureOr> create(TodoListRef ref) { - final fn = _createCb ?? todoList; - return fn(ref); + final _$cb = _createCb ?? todoList; + return _$cb(ref); } } diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart index 3b64e7e32..7ced3b8b4 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart @@ -52,8 +52,8 @@ final class ExampleProvider extends $FunctionalProvider, @override FutureOr create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart index 804a81250..0e7e7e269 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -70,8 +70,8 @@ final class MyListenableProvider extends $FunctionalProvider< @override Raw> create(MyListenableRef ref) { - final fn = _createCb ?? myListenable; - return fn(ref); + final _$cb = _createCb ?? myListenable; + return _$cb(ref); } } diff --git a/website/docs/essentials/websockets_sync/raw_usage.g.dart b/website/docs/essentials/websockets_sync/raw_usage.g.dart index 3e78c80e5..280caca0a 100644 --- a/website/docs/essentials/websockets_sync/raw_usage.g.dart +++ b/website/docs/essentials/websockets_sync/raw_usage.g.dart @@ -62,8 +62,8 @@ final class RawStreamProvider extends $FunctionalProvider< @override Raw> create(RawStreamRef ref) { - final fn = _createCb ?? rawStream; - return fn(ref); + final _$cb = _createCb ?? rawStream; + return _$cb(ref); } } diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart index 334302523..789d750c9 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -62,8 +62,8 @@ final class MyListenableProvider extends $FunctionalProvider< @override Raw> create(MyListenableRef ref) { - final fn = _createCb ?? myListenable; - return fn(ref); + final _$cb = _createCb ?? myListenable; + return _$cb(ref); } } @@ -122,8 +122,8 @@ final class AnotherListenableProvider extends $FunctionalProvider< @override Raw> create(AnotherListenableRef ref) { - final fn = _createCb ?? anotherListenable; - return fn(ref); + final _$cb = _createCb ?? anotherListenable; + return _$cb(ref); } } diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart index 23923a9d8..9f8f57d4c 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -52,8 +52,8 @@ final class StreamExampleProvider @override Stream create(StreamExampleRef ref) { - final fn = _createCb ?? streamExample; - return fn(ref); + final _$cb = _createCb ?? streamExample; + return _$cb(ref); } } diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart index c98ec668b..9529882fd 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -60,8 +60,8 @@ final class SynchronousExampleProvider @override int create(SynchronousExampleRef ref) { - final fn = _createCb ?? synchronousExample; - return fn(ref); + final _$cb = _createCb ?? synchronousExample; + return _$cb(ref); } } diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index f4df07c2b..3950f7105 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -85,12 +85,12 @@ final class RandomProvider extends $FunctionalProvider @override int create(RandomRef ref) { - final fn = _createCb ?? random; + final _$cb = _createCb ?? random; final argument = this.argument as ({ int seed, int max, }); - return fn( + return _$cb( ref, seed: argument.seed, max: argument.max, diff --git a/website/docs/from_provider/motivation/async_values/async_values.g.dart b/website/docs/from_provider/motivation/async_values/async_values.g.dart index 4691a521b..c439c28d3 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.g.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.g.dart @@ -53,8 +53,8 @@ final class ItemsApiProvider extends $FunctionalProvider>, @override FutureOr> create(ItemsApiRef ref) { - final fn = _createCb ?? itemsApi; - return fn(ref); + final _$cb = _createCb ?? itemsApi; + return _$cb(ref); } } @@ -112,8 +112,8 @@ final class EvenItemsProvider @override List create(EvenItemsRef ref) { - final fn = _createCb ?? evenItems; - return fn(ref); + final _$cb = _createCb ?? evenItems; + return _$cb(ref); } } diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart index cae767b2c..8d5d68959 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -59,8 +59,8 @@ final class DiceRollProvider extends $FunctionalProvider @override int create(DiceRollRef ref) { - final fn = _createCb ?? diceRoll; - return fn(ref); + final _$cb = _createCb ?? diceRoll; + return _$cb(ref); } } @@ -118,8 +118,8 @@ final class CachedDiceRollProvider @override int create(CachedDiceRollRef ref) { - final fn = _createCb ?? cachedDiceRoll; - return fn(ref); + final _$cb = _createCb ?? cachedDiceRoll; + return _$cb(ref); } } diff --git a/website/docs/from_provider/motivation/combine/combine.g.dart b/website/docs/from_provider/motivation/combine/combine.g.dart index 5ec2fddbf..a4e9e2790 100644 --- a/website/docs/from_provider/motivation/combine/combine.g.dart +++ b/website/docs/from_provider/motivation/combine/combine.g.dart @@ -59,8 +59,8 @@ final class NumberProvider extends $FunctionalProvider @override int create(NumberRef ref) { - final fn = _createCb ?? number; - return fn(ref); + final _$cb = _createCb ?? number; + return _$cb(ref); } } @@ -117,8 +117,8 @@ final class DoubledProvider extends $FunctionalProvider @override int create(DoubledRef ref) { - final fn = _createCb ?? doubled; - return fn(ref); + final _$cb = _createCb ?? doubled; + return _$cb(ref); } } diff --git a/website/docs/from_provider/motivation/same_type/same_type.g.dart b/website/docs/from_provider/motivation/same_type/same_type.g.dart index c4bba2a82..4e5a7d2c4 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.g.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.g.dart @@ -60,8 +60,8 @@ final class ItemsProvider @override List create(ItemsRef ref) { - final fn = _createCb ?? items; - return fn(ref); + final _$cb = _createCb ?? items; + return _$cb(ref); } } @@ -119,8 +119,8 @@ final class EvenItemsProvider @override List create(EvenItemsRef ref) { - final fn = _createCb ?? evenItems; - return fn(ref); + final _$cb = _createCb ?? evenItems; + return _$cb(ref); } } diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart index aaa2a2e1d..4870ba625 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart @@ -60,8 +60,8 @@ final class HelloWorldProvider @override String create(HelloWorldRef ref) { - final fn = _createCb ?? helloWorld; - return fn(ref); + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); } } diff --git a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart index aaa2a2e1d..4870ba625 100644 --- a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -60,8 +60,8 @@ final class HelloWorldProvider @override String create(HelloWorldRef ref) { - final fn = _createCb ?? helloWorld; - return fn(ref); + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); } } diff --git a/website/docs/introduction/getting_started/hello_world/main.g.dart b/website/docs/introduction/getting_started/hello_world/main.g.dart index aaa2a2e1d..4870ba625 100644 --- a/website/docs/introduction/getting_started/hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/main.g.dart @@ -60,8 +60,8 @@ final class HelloWorldProvider @override String create(HelloWorldRef ref) { - final fn = _createCb ?? helloWorld; - return fn(ref); + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); } } diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index db47e6dbf..a98af4f5d 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -81,12 +81,12 @@ final class FetchPackagesProvider extends $FunctionalProvider< @override FutureOr> create(FetchPackagesRef ref) { - final fn = _createCb ?? fetchPackages; + final _$cb = _createCb ?? fetchPackages; final argument = this.argument as ({ int page, String search, }); - return fn( + return _$cb( ref, page: argument.page, search: argument.search, diff --git a/website/docs/providers/future_provider/config_provider/codegen.g.dart b/website/docs/providers/future_provider/config_provider/codegen.g.dart index 40743bd0e..93f719767 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.g.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.g.dart @@ -57,8 +57,8 @@ final class FetchConfigurationProvider extends $FunctionalProvider< @override FutureOr create(FetchConfigurationRef ref) { - final fn = _createCb ?? fetchConfiguration; - return fn(ref); + final _$cb = _createCb ?? fetchConfiguration; + return _$cb(ref); } } diff --git a/website/docs/providers/provider/completed_todos/completed_todos.g.dart b/website/docs/providers/provider/completed_todos/completed_todos.g.dart index c25e2c8c0..20298ab4d 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.g.dart @@ -60,8 +60,8 @@ final class CompletedTodosProvider @override List create(CompletedTodosRef ref) { - final fn = _createCb ?? completedTodos; - return fn(ref); + final _$cb = _createCb ?? completedTodos; + return _$cb(ref); } } diff --git a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index 3036755b6..9ce4d750a 100644 --- a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -60,8 +60,8 @@ final class CanGoToPreviousPageProvider @override bool create(CanGoToPreviousPageRef ref) { - final fn = _createCb ?? canGoToPreviousPage; - return fn(ref); + final _$cb = _createCb ?? canGoToPreviousPage; + return _$cb(ref); } } diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart index 446d35ecf..a8417e609 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -53,8 +53,8 @@ final class ChatProvider extends $FunctionalProvider>, @override Stream> create(ChatRef ref) { - final fn = _createCb ?? chat; - return fn(ref); + final _$cb = _createCb ?? chat; + return _$cb(ref); } } diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 8affd2176..646d4ba60 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -68,9 +68,9 @@ final class FetchUserProvider @override FutureOr create(FetchUserRef ref) { - final fn = _createCb ?? fetchUser; + final _$cb = _createCb ?? fetchUser; final argument = this.argument as int; - return fn( + return _$cb( ref, userId: argument, ); diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index aaa2a2e1d..4870ba625 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -60,8 +60,8 @@ final class HelloWorldProvider @override String create(HelloWorldRef ref) { - final fn = _createCb ?? helloWorld; - return fn(ref); + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); } } diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index aaa2a2e1d..4870ba625 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -60,8 +60,8 @@ final class HelloWorldProvider @override String create(HelloWorldRef ref) { - final fn = _createCb ?? helloWorld; - return fn(ref); + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); } } diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 8affd2176..646d4ba60 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -68,9 +68,9 @@ final class FetchUserProvider @override FutureOr create(FetchUserRef ref) { - final fn = _createCb ?? fetchUser; + final _$cb = _createCb ?? fetchUser; final argument = this.argument as int; - return fn( + return _$cb( ref, userId: argument, ); diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index aaa2a2e1d..4870ba625 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -60,8 +60,8 @@ final class HelloWorldProvider @override String create(HelloWorldRef ref) { - final fn = _createCb ?? helloWorld; - return fn(ref); + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); } } diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index aaa2a2e1d..4870ba625 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -60,8 +60,8 @@ final class HelloWorldProvider @override String create(HelloWorldRef ref) { - final fn = _createCb ?? helloWorld; - return fn(ref); + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); } } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 8affd2176..646d4ba60 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -68,9 +68,9 @@ final class FetchUserProvider @override FutureOr create(FetchUserRef ref) { - final fn = _createCb ?? fetchUser; + final _$cb = _createCb ?? fetchUser; final argument = this.argument as int; - return fn( + return _$cb( ref, userId: argument, ); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index aaa2a2e1d..4870ba625 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -60,8 +60,8 @@ final class HelloWorldProvider @override String create(HelloWorldRef ref) { - final fn = _createCb ?? helloWorld; - return fn(ref); + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); } } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index aaa2a2e1d..4870ba625 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -60,8 +60,8 @@ final class HelloWorldProvider @override String create(HelloWorldRef ref) { - final fn = _createCb ?? helloWorld; - return fn(ref); + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); } } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart index 40743bd0e..93f719767 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart @@ -57,8 +57,8 @@ final class FetchConfigurationProvider extends $FunctionalProvider< @override FutureOr create(FetchConfigurationRef ref) { - final fn = _createCb ?? fetchConfiguration; - return fn(ref); + final _$cb = _createCb ?? fetchConfiguration; + return _$cb(ref); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 8affd2176..646d4ba60 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -68,9 +68,9 @@ final class FetchUserProvider @override FutureOr create(FetchUserRef ref) { - final fn = _createCb ?? fetchUser; + final _$cb = _createCb ?? fetchUser; final argument = this.argument as int; - return fn( + return _$cb( ref, userId: argument, ); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart index 95c3c31bc..ee97df1b7 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart @@ -52,8 +52,8 @@ final class ExampleProvider @override Stream create(ExampleRef ref) { - final fn = _createCb ?? example; - return fn(ref); + final _$cb = _createCb ?? example; + return _$cb(ref); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart index 96a88ef69..f67a22f9e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart @@ -59,8 +59,8 @@ final class AnotherProvider extends $FunctionalProvider @override void create(AnotherRef ref) { - final fn = _createCb ?? another; - return fn(ref); + final _$cb = _createCb ?? another; + return _$cb(ref); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart index d1a6c89b7..0d25dbdcc 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart @@ -60,8 +60,8 @@ final class RepositoryProvider @override Repository create(RepositoryRef ref) { - final fn = _createCb ?? repository; - return fn(ref); + final _$cb = _createCb ?? repository; + return _$cb(ref); } } @@ -118,8 +118,8 @@ final class ValueProvider extends $FunctionalProvider @override String create(ValueRef ref) { - final fn = _createCb ?? value; - return fn(ref); + final _$cb = _createCb ?? value; + return _$cb(ref); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart index 3855e5438..585133263 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart @@ -60,8 +60,8 @@ final class FilterTypeProvider @override FilterType create(FilterTypeRef ref) { - final fn = _createCb ?? filterType; - return fn(ref); + final _$cb = _createCb ?? filterType; + return _$cb(ref); } } @@ -119,8 +119,8 @@ final class FilteredTodoListProvider @override List create(FilteredTodoListRef ref) { - final fn = _createCb ?? filteredTodoList; - return fn(ref); + final _$cb = _createCb ?? filteredTodoList; + return _$cb(ref); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart index 011551c7d..571be96d3 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart @@ -59,8 +59,8 @@ final class CounterProvider extends $FunctionalProvider @override int create(CounterRef ref) { - final fn = _createCb ?? counter; - return fn(ref); + final _$cb = _createCb ?? counter; + return _$cb(ref); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index aaa2a2e1d..4870ba625 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -60,8 +60,8 @@ final class HelloWorldProvider @override String create(HelloWorldRef ref) { - final fn = _createCb ?? helloWorld; - return fn(ref); + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index aaa2a2e1d..4870ba625 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -60,8 +60,8 @@ final class HelloWorldProvider @override String create(HelloWorldRef ref) { - final fn = _createCb ?? helloWorld; - return fn(ref); + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart index 34b181036..de3607b66 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart @@ -60,8 +60,8 @@ final class HelloWorldProvider @override String create(HelloWorldRef ref) { - final fn = _createCb ?? helloWorld; - return fn(ref); + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart index 40743bd0e..93f719767 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart @@ -57,8 +57,8 @@ final class FetchConfigurationProvider extends $FunctionalProvider< @override FutureOr create(FetchConfigurationRef ref) { - final fn = _createCb ?? fetchConfiguration; - return fn(ref); + final _$cb = _createCb ?? fetchConfiguration; + return _$cb(ref); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart index c25e2c8c0..20298ab4d 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart @@ -60,8 +60,8 @@ final class CompletedTodosProvider @override List create(CompletedTodosRef ref) { - final fn = _createCb ?? completedTodos; - return fn(ref); + final _$cb = _createCb ?? completedTodos; + return _$cb(ref); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index 3036755b6..9ce4d750a 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -60,8 +60,8 @@ final class CanGoToPreviousPageProvider @override bool create(CanGoToPreviousPageRef ref) { - final fn = _createCb ?? canGoToPreviousPage; - return fn(ref); + final _$cb = _createCb ?? canGoToPreviousPage; + return _$cb(ref); } } diff --git a/website/static/snippets/async.g.dart b/website/static/snippets/async.g.dart index 402a5ed6f..f0124f872 100644 --- a/website/static/snippets/async.g.dart +++ b/website/static/snippets/async.g.dart @@ -55,8 +55,8 @@ final class ConfigurationsProvider extends $FunctionalProvider< @override FutureOr create(ConfigurationsRef ref) { - final fn = _createCb ?? configurations; - return fn(ref); + final _$cb = _createCb ?? configurations; + return _$cb(ref); } } diff --git a/website/static/snippets/combine.g.dart b/website/static/snippets/combine.g.dart index 4feeda0c7..726d404c5 100644 --- a/website/static/snippets/combine.g.dart +++ b/website/static/snippets/combine.g.dart @@ -60,8 +60,8 @@ final class FilteredTodosProvider @override List create(FilteredTodosRef ref) { - final fn = _createCb ?? filteredTodos; - return fn(ref); + final _$cb = _createCb ?? filteredTodos; + return _$cb(ref); } } diff --git a/website/static/snippets/create.g.dart b/website/static/snippets/create.g.dart index 95952947a..d58210c28 100644 --- a/website/static/snippets/create.g.dart +++ b/website/static/snippets/create.g.dart @@ -52,8 +52,8 @@ final class BoredSuggestionProvider extends $FunctionalProvider< @override FutureOr create(BoredSuggestionRef ref) { - final fn = _createCb ?? boredSuggestion; - return fn(ref); + final _$cb = _createCb ?? boredSuggestion; + return _$cb(ref); } } From f839418c23fd318358d3cd737d36b51c867fc1ce Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 12:45:44 +0100 Subject: [PATCH 194/387] fix lints --- .../lib/src/riverpod_element.dart | 14 +- .../lib/src/riverpod_types.dart | 127 ++++++++---------- .../legacy_provider_declaration_test.dart | 44 ------ .../src/lints/avoid_read_auto_dispose.dart | 6 +- 4 files changed, 59 insertions(+), 132 deletions(-) diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart index cd2b3c3c5..3f45be286 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart @@ -115,7 +115,7 @@ class RiverpodAnnotationElement { } abstract class ProviderDeclarationElement { - bool get isAutoDispose; + // TODO changelog breaking: removed isAutoDispose from ProviderDeclarationElement Element get element; String get name; } @@ -183,7 +183,6 @@ class LegacyProviderDeclarationElement implements ProviderDeclarationElement { LegacyProviderDeclarationElement._({ required this.name, required this.element, - required this.isAutoDispose, required this.familyElement, required this.providerType, }); @@ -201,13 +200,9 @@ class LegacyProviderDeclarationElement implements ProviderDeclarationElement { return null; } - bool isAutoDispose; LegacyFamilyInvocationElement? familyElement; LegacyProviderType? providerType; if (providerBaseType.isAssignableFromType(element.type)) { - isAutoDispose = !alwaysAliveProviderListenableType - .isAssignableFromType(element.type); - providerType = LegacyProviderType._parse(element.type); } else if (familyType.isAssignableFromType(element.type)) { final callFn = (element.type as InterfaceType).lookUpMethod2( @@ -216,8 +211,6 @@ class LegacyProviderDeclarationElement implements ProviderDeclarationElement { )!; final parameter = callFn.parameters.single; - isAutoDispose = !alwaysAliveProviderListenableType - .isAssignableFromType(callFn.returnType); providerType = LegacyProviderType._parse(callFn.returnType); familyElement = LegacyFamilyInvocationElement._(parameter.type); } else { @@ -228,7 +221,6 @@ class LegacyProviderDeclarationElement implements ProviderDeclarationElement { return LegacyProviderDeclarationElement._( name: element.name, element: element, - isAutoDispose: isAutoDispose, familyElement: familyElement, providerType: providerType, ); @@ -243,9 +235,6 @@ class LegacyProviderDeclarationElement implements ProviderDeclarationElement { @override final String name; - @override - final bool isAutoDispose; - final LegacyFamilyInvocationElement? familyElement; final LegacyProviderType? providerType; @@ -275,7 +264,6 @@ sealed class GeneratorProviderDeclarationElement that.buildMethod.isAbstract; } - @override bool get isAutoDispose => !annotation.keepAlive; } diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_types.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_types.dart index 8d95da378..ca72dd611 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_types.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_types.dart @@ -36,77 +36,41 @@ const uncontrolledProviderScopeType = TypeChecker.fromName( packageName: 'flutter_riverpod', ); -/// [TypeChecker] for `AlwaysAliveProviderListenable` -const alwaysAliveProviderListenableType = TypeChecker.any([ - TypeChecker.fromName( - 'AlwaysAliveProviderListenable', - packageName: 'riverpod', - ), -]); - /// Either FutureProvider or AutoDisposeFutureProvider -const anyFutureProviderType = TypeChecker.any([ - TypeChecker.fromName('FutureProvider', packageName: 'riverpod'), - TypeChecker.fromName('AutoDisposeFutureProvider', packageName: 'riverpod'), -]); +const anyFutureProviderType = TypeChecker.fromName( + 'FutureProvider', + packageName: 'riverpod', +); /// Either StreamProvider or AutoDisposeStreamProvider -const anyStreamProviderType = TypeChecker.any([ - TypeChecker.fromName('StreamProvider', packageName: 'riverpod'), - TypeChecker.fromName('AutoDisposeStreamProvider', packageName: 'riverpod'), -]); +const anyStreamProviderType = TypeChecker.fromName( + 'StreamProvider', + packageName: 'riverpod', +); /// Either NotifierProvider or AutoDisposeNotifierProvider or their family form -const anyNotifierProviderType = TypeChecker.any([ - TypeChecker.fromName('NotifierProviderImpl', packageName: 'riverpod'), - TypeChecker.fromName('FamilyNotifierProviderImpl', packageName: 'riverpod'), - TypeChecker.fromName( - 'AutoDisposeNotifierProviderImpl', - packageName: 'riverpod', - ), - TypeChecker.fromName( - 'AutoDisposeFamilyNotifierProviderImpl', - packageName: 'riverpod', - ), -]); +const anyNotifierProviderType = TypeChecker.fromName( + r'$NotifierProvider', + packageName: 'riverpod', +); /// Either AsyncNotifierProvider or AutoDisposeAsyncNotifierProvider or their family form const anyAsyncNotifierProviderType = TypeChecker.any([ - TypeChecker.fromName('AsyncNotifierProviderImpl', packageName: 'riverpod'), - TypeChecker.fromName( - 'FamilyAsyncNotifierProviderImpl', - packageName: 'riverpod', - ), - TypeChecker.fromName( - 'AutoDisposeAsyncNotifierProviderImpl', - packageName: 'riverpod', - ), - TypeChecker.fromName( - 'AutoDisposeFamilyAsyncNotifierProviderImpl', - packageName: 'riverpod', - ), + TypeChecker.fromName(r'$AsyncNotifierProvider', packageName: 'riverpod'), + TypeChecker.fromName(r'$StreamNotifierProvider', packageName: 'riverpod'), ]); /// Either ChangeNotifierProvider or AutoDisposeChangeNotifierProvider -const anyChangeNotifierProviderType = TypeChecker.any([ - TypeChecker.fromName( - 'ChangeNotifierProvider', - packageName: 'flutter_riverpod', - ), - TypeChecker.fromName( - 'AutoDisposeChangeNotifierProvider', - packageName: 'flutter_riverpod', - ), -]); +const anyChangeNotifierProviderType = TypeChecker.fromName( + 'ChangeNotifierProvider', + packageName: 'flutter_riverpod', +); /// Either StateNotifierProvider or AutoDisposeStateNotifierProvider -const anyStateNotifierProviderType = TypeChecker.any([ - TypeChecker.fromName('StateNotifierProvider', packageName: 'riverpod'), - TypeChecker.fromName( - 'AutoDisposeStateNotifierProvider', - packageName: 'riverpod', - ), -]); +const anyStateNotifierProviderType = TypeChecker.fromName( + 'StateNotifierProvider', + packageName: 'riverpod', +); /// [TypeChecker] for `StateNotifier` const stateNotifierType = TypeChecker.fromName( @@ -121,16 +85,16 @@ const changeNotifierType = TypeChecker.fromName( ); /// Either StateProvider or AutoDisposeStateProvider -const anyStateProviderType = TypeChecker.any([ - TypeChecker.fromName('StateProvider', packageName: 'riverpod'), - TypeChecker.fromName('AutoDisposeStateProvider', packageName: 'riverpod'), -]); +const anyStateProviderType = TypeChecker.fromName( + 'StateProvider', + packageName: 'riverpod', +); /// Either Provider or AutoDisposeProvider -const anyProviderType = TypeChecker.any([ - TypeChecker.fromName('Provider', packageName: 'riverpod'), - TypeChecker.fromName('AutoDisposeProvider', packageName: 'riverpod'), -]); +const anyProviderType = TypeChecker.fromName( + 'Provider', + packageName: 'riverpod', +); /// [TypeChecker] for `Family` const familyType = TypeChecker.fromName('Family', packageName: 'riverpod'); @@ -142,20 +106,33 @@ const futureType = TypeChecker.fromUrl('dart:async#Future'); const streamType = TypeChecker.fromUrl('dart:async#Stream'); /// [TypeChecker] for `ProviderContainer` -const containerType = - TypeChecker.fromName('ProviderContainer', packageName: 'riverpod'); +const containerType = TypeChecker.fromName( + 'ProviderContainer', + packageName: 'riverpod', +); + +/// [TypeChecker] for `AsyncNotifierBase` +const asyncNotifierBaseType = TypeChecker.fromName( + r'$AsyncNotifier', + packageName: 'riverpod', +); /// [TypeChecker] for `AsyncNotifierBase` -const asyncNotifierBaseType = - TypeChecker.fromName('AsyncNotifierBase', packageName: 'riverpod'); +const streamNotifierBaseType = TypeChecker.fromName( + r'$StreamNotifier', + packageName: 'riverpod', +); /// [TypeChecker] for `NotifierBase` -const notifierBaseType = - TypeChecker.fromName('NotifierBase', packageName: 'riverpod'); +const notifierBaseType = TypeChecker.fromName( + r'$Notifier', + packageName: 'riverpod', +); /// Either `NotifierBase` or `AsyncNotifierBase` const anyNotifierType = TypeChecker.any([ asyncNotifierBaseType, + streamNotifierBaseType, notifierBaseType, ]); @@ -172,8 +149,10 @@ const widgetType = TypeChecker.fromName('Widget', packageName: 'flutter'); const widgetStateType = TypeChecker.fromName('State', packageName: 'flutter'); /// [TypeChecker] from `WidgetRef` -const widgetRefType = - TypeChecker.fromName('WidgetRef', packageName: 'flutter_riverpod'); +const widgetRefType = TypeChecker.fromName( + 'WidgetRef', + packageName: 'flutter_riverpod', +); /// Checks that the value is coming from a `package:riverpod` package const isFromRiverpod = TypeChecker.fromPackage('riverpod'); diff --git a/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart b/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart index 032ce4fb5..5534a7037 100644 --- a/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart @@ -639,50 +639,6 @@ final explicitAutoDisposeFamily = AutoDisposeStateNotifierProviderFamily((ref) => 0); -final alwaysAliveFamily = Provider.family((ref, id) => 0); -final explicitAlwaysAliveFamily = ProviderFamily((ref, id) => 0); - -final autoDisposeProvider = Provider.autoDispose((ref) => 0); -final explicitAutoDisposeProvider = AutoDisposeProvider((ref) => 0); -final autoDisposeFamily = Provider.autoDispose.family((ref, id) => 0); -final autoDisposeFamily2 = Provider.family.autoDispose((ref, id) => 0); -final explicitAutoDisposeFamily = AutoDisposeProviderFamily((ref, id) => 0); -''', (resolver) async { - final result = await resolver.resolveRiverpodAnalysisResult(); - final autoDisposeProviders = result.legacyProviderDeclarations.takeAll([ - 'autoDisposeProvider', - 'explicitAutoDisposeProvider', - 'autoDisposeFamily', - 'autoDisposeFamily2', - 'explicitAutoDisposeFamily', - ]); - - final alwaysAliveProviders = result.legacyProviderDeclarations.takeAll([ - 'alwaysAliveProvider', - 'alwaysAliveFamily', - 'explicitAlwaysAliveFamily', - ]); - - for (final provider in autoDisposeProviders.entries) { - expect( - provider.value.providerElement.isAutoDispose, - true, - reason: '${provider.key} is autoDispose', - ); - } - for (final provider in alwaysAliveProviders.entries) { - expect( - provider.value.providerElement.isAutoDispose, - false, - reason: '${provider.key} is not autoDispose', - ); - } - }); - testSource('Decode families', source: ''' import 'package:riverpod/riverpod.dart'; diff --git a/packages/riverpod_lint/lib/src/lints/avoid_read_auto_dispose.dart b/packages/riverpod_lint/lib/src/lints/avoid_read_auto_dispose.dart index de5ba3534..28f1de5bc 100644 --- a/packages/riverpod_lint/lib/src/lints/avoid_read_auto_dispose.dart +++ b/packages/riverpod_lint/lib/src/lints/avoid_read_auto_dispose.dart @@ -1,5 +1,6 @@ import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import '../riverpod_custom_lint.dart'; @@ -23,7 +24,10 @@ Then dispose of the listener when you no longer need the autoDispose provider to CustomLintContext context, ) { riverpodRegistry(context).addRefReadInvocation((read) { - if (read.provider.providerElement?.isAutoDispose ?? false) { + final provider = read.provider.providerElement; + + if (provider is GeneratorProviderDeclarationElement && + provider.isAutoDispose) { reporter.reportErrorForNode( _code, read.node, From 5365a2cfb99e4ba8671c591c2daadc9d12f8cd15 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 12:48:14 +0100 Subject: [PATCH 195/387] Fix some lints --- .../advanced/select/select_async/codegen.dart | 11 ++-- .../select/select_async/codegen.g.dart | 51 ++++++++++++++++ .../characters_provider/codegen.dart | 7 ++- .../characters_provider/codegen.g.dart | 59 +++++++++++++++++++ .../watch_placement/codegen.dart | 4 +- .../watch_placement/codegen.g.dart | 58 ++++++++++++++++++ 6 files changed, 180 insertions(+), 10 deletions(-) diff --git a/website/docs/advanced/select/select_async/codegen.dart b/website/docs/advanced/select/select_async/codegen.dart index ad79e2d26..94f86d4de 100644 --- a/website/docs/advanced/select/select_async/codegen.dart +++ b/website/docs/advanced/select/select_async/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors, body_might_complete_normally_nullable -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; @@ -9,11 +8,13 @@ class User { late String firstName, lastName; } -final userProvider = FutureProvider( - (ref) => User() +@riverpod +FutureOr user(UserRef ref) { + return User() ..firstName = 'John' - ..lastName = 'Doe', -); + ..lastName = 'Doe'; +} + /* SNIPPET START */ @riverpod Object? example(ExampleRef ref) async { diff --git a/website/docs/advanced/select/select_async/codegen.g.dart b/website/docs/advanced/select/select_async/codegen.g.dart index a0f33eb3c..6711018e4 100644 --- a/website/docs/advanced/select/select_async/codegen.g.dart +++ b/website/docs/advanced/select/select_async/codegen.g.dart @@ -8,6 +8,57 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +typedef UserRef = Ref>; + +@ProviderFor(user) +const userProvider = UserProvider._(); + +final class UserProvider + extends $FunctionalProvider, FutureOr, UserRef> + with $FutureModifier, $FutureProvider { + const UserProvider._( + {FutureOr Function( + UserRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'userProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + UserRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$userHash(); + + @override + $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + UserProvider $copyWithCreate( + FutureOr Function( + UserRef ref, + ) create, + ) { + return UserProvider._(create: create); + } + + @override + FutureOr create(UserRef ref) { + final _$cb = _createCb ?? user; + return _$cb(ref); + } +} + +String _$userHash() => r'19a4464690c31301e47fd7bd5bf6ea475c1a73eb'; + typedef ExampleRef = Ref; @ProviderFor(example) diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart index 67439d571..8c5ea014e 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart @@ -1,5 +1,4 @@ import 'package:dio/dio.dart'; -import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'models.dart'; @@ -11,7 +10,8 @@ final dio = Dio(); /* SNIPPET START */ // The current search filter -final searchProvider = StateProvider((ref) => ''); +@riverpod +String search(SearchRef ref) => ''; @riverpod Stream configs(ConfigsRef ref) { @@ -23,7 +23,8 @@ Future> characters(CharactersRef ref) async { final search = ref.watch(searchProvider); final configs = await ref.watch(configsProvider.future); final response = await dio.get>>( - '${configs.host}/characters?search=$search',); + '${configs.host}/characters?search=$search', + ); return response.data!.map(Character.fromJson).toList(); } diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart index 6dd0be274..7bbd14b6c 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -8,6 +8,65 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +typedef SearchRef = Ref; + +@ProviderFor(search) +const searchProvider = SearchProvider._(); + +final class SearchProvider + extends $FunctionalProvider + with $Provider { + const SearchProvider._( + {String Function( + SearchRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'searchProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + SearchRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$searchHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + SearchProvider $copyWithCreate( + String Function( + SearchRef ref, + ) create, + ) { + return SearchProvider._(create: create); + } + + @override + String create(SearchRef ref) { + final _$cb = _createCb ?? search; + return _$cb(ref); + } +} + +String _$searchHash() => r'a093687a671a5d5481789cf3e401a09f96f8896d'; + typedef ConfigsRef = Ref>; @ProviderFor(configs) diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.dart index 103abe81a..36f97a531 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.dart @@ -1,12 +1,12 @@ // ignore_for_file: unused_local_variable import 'package:flutter/foundation.dart'; -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; -final otherProvider = Provider((ref) => 0); +@riverpod +int other(OtherRef ref) => 0; /* SNIPPET START */ @riverpod diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart index 5993dc5c7..8362725da 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart @@ -8,6 +8,64 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + typedef ExampleRef = Ref; @ProviderFor(example) From 433f63df98a98fafe68ee7894b95a17d3246029d Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 12:53:59 +0100 Subject: [PATCH 196/387] More lints --- .../filtered_todo_list_provider/codegen.dart | 6 +- .../codegen.g.dart | 59 +++++++++ .../concepts/reading/counter/codegen.dart | 4 +- .../concepts/reading/counter/codegen.g.dart | 59 +++++++++ .../docs/concepts/reading/listen/codegen.dart | 2 +- .../listen_example/codegen.dart | 4 +- .../listen_example/codegen.g.dart | 58 +++++++++ .../read_example/codegen.dart | 4 +- .../read_example/codegen.g.dart | 58 +++++++++ .../family_and_dispose.dart | 3 + .../family_and_dispose.g.dart | 61 +++++++++ .../old_lifecycles/old_lifecycles.dart | 12 +- .../old_lifecycles_final.dart | 12 +- .../old_lifecycles_final.g.dart | 118 ++++++++++++++++++ .../concepts/reading/counter/codegen.dart | 4 +- .../concepts/reading/counter/codegen.g.dart | 59 +++++++++ .../concepts/reading/listen/codegen.dart | 2 +- website/static/snippets/combine.dart | 8 +- website/static/snippets/combine.g.dart | 118 ++++++++++++++++++ 19 files changed, 618 insertions(+), 33 deletions(-) diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart index 6de519eeb..c224a8c57 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart @@ -1,7 +1,6 @@ -import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; -import '../todo_list_provider/raw.dart'; +import '../todo_list_provider/codegen.dart'; part 'codegen.g.dart'; @@ -11,7 +10,8 @@ enum Filter { uncompleted, } -final filterProvider = StateProvider((ref) => Filter.none); +@riverpod +Filter filter(FilterRef ref) => Filter.none; /* SNIPPET START */ diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart index 1a1dbc2ab..1995572f6 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -8,6 +8,65 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +typedef FilterRef = Ref; + +@ProviderFor(filter) +const filterProvider = FilterProvider._(); + +final class FilterProvider + extends $FunctionalProvider + with $Provider { + const FilterProvider._( + {Filter Function( + FilterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Filter Function( + FilterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Filter value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilterProvider $copyWithCreate( + Filter Function( + FilterRef ref, + ) create, + ) { + return FilterProvider._(create: create); + } + + @override + Filter create(FilterRef ref) { + final _$cb = _createCb ?? filter; + return _$cb(ref); + } +} + +String _$filterHash() => r'53b85f9e189dabb39aa269e62536a3f1a3559ef7'; + typedef FilteredTodoListRef = Ref>; @ProviderFor(filteredTodoList) diff --git a/website/docs/concepts/reading/counter/codegen.dart b/website/docs/concepts/reading/counter/codegen.dart index 06d95f510..a23405835 100644 --- a/website/docs/concepts/reading/counter/codegen.dart +++ b/website/docs/concepts/reading/counter/codegen.dart @@ -1,9 +1,9 @@ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; -final repositoryProvider = Provider((ref) => Repository()); +@riverpod +Repository repository(RepositoryRef ref) => Repository(); class Repository { Future post(String url) async {} diff --git a/website/docs/concepts/reading/counter/codegen.g.dart b/website/docs/concepts/reading/counter/codegen.g.dart index 8de5da5f8..94660bb89 100644 --- a/website/docs/concepts/reading/counter/codegen.g.dart +++ b/website/docs/concepts/reading/counter/codegen.g.dart @@ -8,6 +8,65 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +typedef RepositoryRef = Ref; + +@ProviderFor(repository) +const repositoryProvider = RepositoryProvider._(); + +final class RepositoryProvider + extends $FunctionalProvider + with $Provider { + const RepositoryProvider._( + {Repository Function( + RepositoryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'repositoryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Repository Function( + RepositoryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$repositoryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Repository value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RepositoryProvider $copyWithCreate( + Repository Function( + RepositoryRef ref, + ) create, + ) { + return RepositoryProvider._(create: create); + } + + @override + Repository create(RepositoryRef ref) { + final _$cb = _createCb ?? repository; + return _$cb(ref); + } +} + +String _$repositoryHash() => r'c6dc3b5b727028966b5b850b27ffc7294b485273'; + @ProviderFor(Counter) const counterProvider = CounterProvider._(); diff --git a/website/docs/concepts/reading/listen/codegen.dart b/website/docs/concepts/reading/listen/codegen.dart index 154e25e27..0037c4c8d 100644 --- a/website/docs/concepts/reading/listen/codegen.dart +++ b/website/docs/concepts/reading/listen/codegen.dart @@ -1,7 +1,7 @@ // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print import 'package:riverpod_annotation/riverpod_annotation.dart'; -import '../counter/raw.dart'; +import '../counter/codegen.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.dart b/website/docs/essentials/combining_requests/listen_example/codegen.dart index e3e9f23ba..7a417d13b 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.dart @@ -1,11 +1,11 @@ // ignore_for_file: unused_local_variable, avoid_print -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; -final otherProvider = Provider((ref) => 0); +@riverpod +int other(OtherRef ref) => 0; /* SNIPPET START */ @riverpod diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart index 3696d27bc..03ea8dc9b 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart @@ -8,6 +8,64 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + typedef ExampleRef = Ref; @ProviderFor(example) diff --git a/website/docs/essentials/combining_requests/read_example/codegen.dart b/website/docs/essentials/combining_requests/read_example/codegen.dart index 2d629b553..5024b4f25 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.dart @@ -1,11 +1,11 @@ // ignore_for_file: unused_local_variable -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; -final otherProvider = Provider((ref) => 0); +@riverpod +int other(OtherRef ref) => 0; /* SNIPPET START */ @riverpod diff --git a/website/docs/essentials/combining_requests/read_example/codegen.g.dart b/website/docs/essentials/combining_requests/read_example/codegen.g.dart index 95e65af9d..07b21821f 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.g.dart @@ -8,6 +8,64 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + @ProviderFor(MyNotifier) const myNotifierProvider = MyNotifierProvider._(); diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart index c093fbfd8..54df8a0ab 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart @@ -8,6 +8,9 @@ import '../../utils.dart'; part 'family_and_dispose.g.dart'; +@riverpod +TaskTrackerRepo taskTracker(TaskTrackerRef ref) => TaskTrackerRepo(); + /* SNIPPET START */ @riverpod class BugsEncounteredNotifier extends _$BugsEncounteredNotifier { diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index 9e3d13419..f88efca58 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -8,6 +8,67 @@ part of 'family_and_dispose.dart'; // RiverpodGenerator // ************************************************************************** +typedef TaskTrackerRef = Ref; + +@ProviderFor(taskTracker) +const taskTrackerProvider = TaskTrackerProvider._(); + +final class TaskTrackerProvider extends $FunctionalProvider< + TaskTrackerRepo, + TaskTrackerRepo, + TaskTrackerRef> with $Provider { + const TaskTrackerProvider._( + {TaskTrackerRepo Function( + TaskTrackerRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'taskTrackerProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TaskTrackerRepo Function( + TaskTrackerRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$taskTrackerHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(TaskTrackerRepo value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + TaskTrackerProvider $copyWithCreate( + TaskTrackerRepo Function( + TaskTrackerRef ref, + ) create, + ) { + return TaskTrackerProvider._(create: create); + } + + @override + TaskTrackerRepo create(TaskTrackerRef ref) { + final _$cb = _createCb ?? taskTracker; + return _$cb(ref); + } +} + +String _$taskTrackerHash() => r'd78149146c3a07b78e7dc1d03fa60ed1941c3702'; + @ProviderFor(BugsEncounteredNotifier) const bugsEncounteredNotifierProvider = BugsEncounteredNotifierFamily._(); diff --git a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart index 1313cc7bd..d8f3aba8b 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart @@ -1,21 +1,11 @@ import 'dart:async'; -import 'package:dio/dio.dart'; -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; -import '../../utils.dart'; +import '../old_lifecycles_final/old_lifecycles_final.dart'; part 'old_lifecycles.g.dart'; -final repositoryProvider = Provider<_MyRepo>((ref) { - return _MyRepo(); -}); - -class _MyRepo { - Future update(int i, {CancelToken? token}) async {} -} - /* SNIPPET START */ @riverpod class MyNotifier extends _$MyNotifier { diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart index 46370f3d6..6f9ec0b17 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart @@ -1,16 +1,16 @@ import 'dart:async'; import 'package:dio/dio.dart'; -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; -import '../../utils.dart'; - part 'old_lifecycles_final.g.dart'; -final repositoryProvider = Provider<_MyRepo>((ref) { - return _MyRepo(); -}); +@riverpod +Duration duration(DurationRef ref) => const Duration(seconds: 1); + +@riverpod +// ignore: library_private_types_in_public_api +_MyRepo repository(RepositoryRef ref) => _MyRepo(); class _MyRepo { Future update(int i, {CancelToken? token}) async {} diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart index c52bfa3a0..5ea0b669f 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -8,6 +8,124 @@ part of 'old_lifecycles_final.dart'; // RiverpodGenerator // ************************************************************************** +typedef DurationRef = Ref; + +@ProviderFor(duration) +const durationProvider = DurationProvider._(); + +final class DurationProvider + extends $FunctionalProvider + with $Provider { + const DurationProvider._( + {Duration Function( + DurationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'durationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Duration Function( + DurationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$durationHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Duration value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DurationProvider $copyWithCreate( + Duration Function( + DurationRef ref, + ) create, + ) { + return DurationProvider._(create: create); + } + + @override + Duration create(DurationRef ref) { + final _$cb = _createCb ?? duration; + return _$cb(ref); + } +} + +String _$durationHash() => r'be282a34a01007c6f3e04447579609199306aecc'; + +typedef RepositoryRef = Ref<_MyRepo>; + +@ProviderFor(repository) +const repositoryProvider = RepositoryProvider._(); + +final class RepositoryProvider + extends $FunctionalProvider<_MyRepo, _MyRepo, RepositoryRef> + with $Provider<_MyRepo, RepositoryRef> { + const RepositoryProvider._( + {_MyRepo Function( + RepositoryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'repositoryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final _MyRepo Function( + RepositoryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$repositoryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(_MyRepo value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider<_MyRepo>(value), + ); + } + + @override + $ProviderElement<_MyRepo> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RepositoryProvider $copyWithCreate( + _MyRepo Function( + RepositoryRef ref, + ) create, + ) { + return RepositoryProvider._(create: create); + } + + @override + _MyRepo create(RepositoryRef ref) { + final _$cb = _createCb ?? repository; + return _$cb(ref); + } +} + +String _$repositoryHash() => r'80732dff4b7c3731f85f4c5ae72c820ae349c7fe'; + @ProviderFor(MyNotifier) const myNotifierProvider = MyNotifierProvider._(); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart index cff9d8609..6d27d9d4d 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart @@ -1,9 +1,9 @@ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; -final repositoryProvider = Provider((ref) => Repository()); +@riverpod +Repository repository(RepositoryRef ref) => Repository(); class Repository { Future post(String url) async {} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart index 8de5da5f8..94660bb89 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart @@ -8,6 +8,65 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** +typedef RepositoryRef = Ref; + +@ProviderFor(repository) +const repositoryProvider = RepositoryProvider._(); + +final class RepositoryProvider + extends $FunctionalProvider + with $Provider { + const RepositoryProvider._( + {Repository Function( + RepositoryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'repositoryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Repository Function( + RepositoryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$repositoryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Repository value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RepositoryProvider $copyWithCreate( + Repository Function( + RepositoryRef ref, + ) create, + ) { + return RepositoryProvider._(create: create); + } + + @override + Repository create(RepositoryRef ref) { + final _$cb = _createCb ?? repository; + return _$cb(ref); + } +} + +String _$repositoryHash() => r'c6dc3b5b727028966b5b850b27ffc7294b485273'; + @ProviderFor(Counter) const counterProvider = CounterProvider._(); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.dart index 154e25e27..0037c4c8d 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.dart @@ -1,7 +1,7 @@ // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print import 'package:riverpod_annotation/riverpod_annotation.dart'; -import '../counter/raw.dart'; +import '../counter/codegen.dart'; part 'codegen.g.dart'; diff --git a/website/static/snippets/combine.dart b/website/static/snippets/combine.dart index 1e3a25b04..0ac4d44eb 100644 --- a/website/static/snippets/combine.dart +++ b/website/static/snippets/combine.dart @@ -1,6 +1,5 @@ // ignore_for_file: omit_local_variable_types -import 'package:flutter_riverpod/legacy.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'combine.g.dart'; @@ -15,8 +14,11 @@ enum Filter { uncompleted, } -final todosProvider = StateProvider>((ref) => []); -final filterProvider = StateProvider((ref) => Filter.all); +@riverpod +List todos(TodosRef ref) => []; + +@riverpod +Filter filter(FilterRef ref) => Filter.all; /* SNIPPET START */ diff --git a/website/static/snippets/combine.g.dart b/website/static/snippets/combine.g.dart index 726d404c5..63e0d6350 100644 --- a/website/static/snippets/combine.g.dart +++ b/website/static/snippets/combine.g.dart @@ -8,6 +8,124 @@ part of 'combine.dart'; // RiverpodGenerator // ************************************************************************** +typedef TodosRef = Ref>; + +@ProviderFor(todos) +const todosProvider = TodosProvider._(); + +final class TodosProvider + extends $FunctionalProvider, List, TodosRef> + with $Provider, TodosRef> { + const TodosProvider._( + {List Function( + TodosRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + TodosRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$todosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @override + $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + TodosProvider $copyWithCreate( + List Function( + TodosRef ref, + ) create, + ) { + return TodosProvider._(create: create); + } + + @override + List create(TodosRef ref) { + final _$cb = _createCb ?? todos; + return _$cb(ref); + } +} + +String _$todosHash() => r'146df519c4c2f843a867e4c6f5983259194f34fc'; + +typedef FilterRef = Ref; + +@ProviderFor(filter) +const filterProvider = FilterProvider._(); + +final class FilterProvider + extends $FunctionalProvider + with $Provider { + const FilterProvider._( + {Filter Function( + FilterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Filter Function( + FilterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Filter value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @override + $ProviderElement createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilterProvider $copyWithCreate( + Filter Function( + FilterRef ref, + ) create, + ) { + return FilterProvider._(create: create); + } + + @override + Filter create(FilterRef ref) { + final _$cb = _createCb ?? filter; + return _$cb(ref); + } +} + +String _$filterHash() => r'db6b594dad9378c59a08eaee9a1208065cb916eb'; + typedef FilteredTodosRef = Ref>; @ProviderFor(filteredTodos) From ad34d52a75985b7e306c8b67528f4489d5a2960d Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 14:14:18 +0100 Subject: [PATCH 197/387] Fix some lints --- packages/riverpod/lib/riverpod.dart | 3 ++- packages/riverpod/lib/src/core/element.dart | 14 ++++------- .../lib/src/core/modifiers/future.dart | 2 +- .../src/core/provider/notifier_provider.dart | 1 + .../lib/src/core/provider/provider.dart | 2 +- .../src/core/proxy_provider_listenable.dart | 2 +- packages/riverpod/lib/src/core/ref.dart | 4 ++-- .../lib/src/providers/async_notifier.dart | 4 ++++ .../src/providers/async_notifier/orphan.dart | 20 ++-------------- .../lib/src/providers/future_provider.dart | 23 ------------------- .../src/providers/legacy/state_provider.dart | 12 ---------- .../riverpod/lib/src/providers/notifier.dart | 5 ++-- .../lib/src/providers/notifier/family.dart | 5 ---- .../lib/src/providers/notifier/orphan.dart | 20 ++-------------- .../riverpod/lib/src/providers/provider.dart | 23 ------------------- .../lib/src/providers/stream_notifier.dart | 6 +++++ .../src/providers/stream_notifier/orphan.dart | 20 ++-------------- .../lib/src/providers/stream_provider.dart | 23 ------------------- .../notifier/notifier_test.dart | 1 - 19 files changed, 31 insertions(+), 159 deletions(-) diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 3cfd8f660..035a0ca3b 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -42,7 +42,8 @@ export 'src/framework.dart' RunNotifierBuild, $FunctionalProvider, $ClassProvider, - LegacyProviderMixin; + LegacyProviderMixin, + ClassProviderElement; export 'src/providers/async_notifier.dart' hide $AsyncNotifier, $AsyncNotifierProvider; diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 8255b03c2..2a17ccd67 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -77,7 +77,7 @@ abstract class ProviderElementBase implements Ref, Node { /// Whether this [ProviderElementBase] is currently listened to or not. /// /// This maps to listeners added with [listen]. - /// See also [mayNeedDispose], called when [hasListeners] may have changed. + /// See also [_mayNeedDispose], called when [hasListeners] may have changed. bool get hasListeners => _externalDependents.isNotEmpty || _subscribers.isNotEmpty || @@ -796,7 +796,7 @@ final = Provider(dependencies: []); late KeepAliveLink link; link = KeepAliveLink._(() { if (links.remove(link)) { - if (links.isEmpty) mayNeedDispose(); + if (links.isEmpty) _mayNeedDispose(); } }); links.add(link); @@ -894,17 +894,11 @@ final = Provider(dependencies: []); _didCancelOnce = true; _onCancelListeners?.forEach(runGuarded); } - mayNeedDispose(); + _mayNeedDispose(); } /// Life-cycle for when a listener is removed. - /// - /// See also: - /// - /// - [AutoDisposeProviderElementMixin], which overrides this method to destroy the - /// state of a provider when no longer used. - @visibleForOverriding - void mayNeedDispose() { + void _mayNeedDispose() { if (provider.isAutoDispose) { final links = _keepAliveLinks; diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index c01f9fc36..77b7c9dbf 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -94,7 +94,7 @@ mixin $AsyncClassModifier /// does not matter. Checking `==` would only hinder performances for no reason. /// /// See also: - /// - [ProviderBase.select] and [AsyncSelector.selectAsync], which are + /// - [ProviderBase.select] and [$FutureModifier.selectAsync], which are /// alternative ways to filter out changes to [state]. @override @protected diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index 18611caff..e4f8f0950 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -148,6 +148,7 @@ abstract base class $ClassProvider< // CreatedT> createElement(ProviderContainer container); } +@internal abstract class ClassProviderElement< // NotifierT extends $ClassBase< // StateT, diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index 5ef4db0f5..1e9019fce 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -86,7 +86,7 @@ abstract base class ProviderBase extends ProviderOrFamily element.flush(); // In case `read` was called on a provider that has no listener - element.mayNeedDispose(); + element._mayNeedDispose(); return element.requireState; } diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index 81f205ef0..dcb0f1d2f 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -112,7 +112,7 @@ class ProviderElementProxy Output read(Node node) { final element = node.readProviderElement(provider); element.flush(); - element.mayNeedDispose(); + element._mayNeedDispose(); return _lense(element).value; } diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 480f800bf..357bfcad4 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -138,7 +138,7 @@ abstract class Ref { /// (and [onCancel] was triggered). /// /// See also: - /// - [AutoDisposeRef.keepAlive], which can be combined with [onCancel] for + /// - [keepAlive], which can be combined with [onCancel] for /// advanced manipulation on when the provider should get disposed. /// - [Provider.autoDispose], a modifier which tell a provider that it should /// destroy its state when no longer listened to. @@ -157,7 +157,7 @@ abstract class Ref { /// is removed, a new listener is immediately added. /// /// See also: - /// - [AutoDisposeRef.keepAlive], which can be combined with [onCancel] for + /// - [keepAlive], which can be combined with [onCancel] for /// advanced manipulation on when the provider should get disposed. /// - [Provider.autoDispose], a modifier which tell a provider that it should /// destroy its state when no longer listened to. diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index 13a7e3e03..b04df5a87 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -31,6 +31,8 @@ abstract base class $AsyncNotifierProvider< // Ref>> // with $FutureModifier { + /// Implementation detail of `riverpod_generator`. + /// Do not use. const $AsyncNotifierProvider({ required super.name, required super.from, @@ -53,6 +55,8 @@ class $AsyncNotifierProviderElement< // FutureOr> // with FutureModifierElement { + /// Implementation detail of `riverpod_generator`. + /// Do not use. $AsyncNotifierProviderElement(this.provider, super.container); @override diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index 188989791..6a5d2216f 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -51,11 +51,8 @@ abstract class AsyncNotifier extends $AsyncNotifier { /// {@endtemplate} /// /// {@template riverpod.async_notifier_provider_modifier} -/// When using `autoDispose` or `family`, your notifier type changes. -/// Instead of extending [AsyncNotifier], you should extend either: -/// - [AutoDisposeAsyncNotifier] for `autoDispose` -/// - [FamilyAsyncNotifier] for `family` -/// - [AutoDisposeFamilyAsyncNotifier] for `autoDispose.family` +/// When using `family`, your notifier type changes. +/// Instead of extending [AsyncNotifier], you should extend [FamilyAsyncNotifier]. /// {@endtemplate} final class AsyncNotifierProvider< // NotifierT extends AsyncNotifier, @@ -78,19 +75,6 @@ final class AsyncNotifierProvider< // runNotifierBuildOverride: null, ); - AsyncNotifierProvider._autoDispose( - this._createNotifier, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - isAutoDispose: true, - runNotifierBuildOverride: null, - ); - /// An implementation detail of Riverpod @internal const AsyncNotifierProvider.internal( diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 3e2463425..5fd94a14d 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -102,18 +102,6 @@ final class FutureProvider extends $FunctionalProvider< argument: null, ); - FutureProvider._autoDispose( - this._create, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - isAutoDispose: true, - from: null, - argument: null, - ); - /// An implementation detail of Riverpod @internal FutureProvider.internal( @@ -228,17 +216,6 @@ class FutureProviderFamily extends FunctionalFamily< computeAllTransitiveDependencies(dependencies), ); - FutureProviderFamily._autoDispose( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: FutureProvider.internal, - isAutoDispose: true, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - ); - /// Implementation detail of the code-generator. @internal FutureProviderFamily.internal( diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 792a2acc3..25c728ebe 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -58,7 +58,6 @@ abstract class StateProviderRef implements Ref { final class StateProvider extends $FunctionalProvider> with LegacyProviderMixin { - /// {@macro riverpod.stateprovider} StateProvider( this._createFn, { super.name, @@ -200,17 +199,6 @@ class StateProviderFamily extends FunctionalFamily< // computeAllTransitiveDependencies(dependencies), ); - StateProviderFamily._autoDispose( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: StateProvider.internal, - isAutoDispose: true, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - ); - /// The [Family] of [AsyncNotifierProvider]. @internal StateProviderFamily.internal( diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index fe6faca6a..66c728262 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -108,8 +108,9 @@ class $NotifierProviderElement< // extends ClassProviderElement< // NotifierT, StateT, - StateT> // -{ + StateT> { + /// An implementation detail of `riverpod_generator`. + /// Do not use. $NotifierProviderElement(this.provider, super.container); @override diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index 2a0114bdf..182ac5f23 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -16,11 +16,6 @@ abstract class FamilyNotifier extends $Notifier { StateT runBuild() => build(arg); } -/// The implementation of [NotifierFamilyProvider] but with loosened type constraints -/// that can be shared with [AutoDisposeNotifierProvider]. -/// -/// This enables tests to execute on both [NotifierProvider] and -/// [AutoDisposeNotifierProvider] at the same time. final class FamilyNotifierProvider // , StateT, ArgT> extends $NotifierProvider diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart index a87615857..980c8dcdc 100644 --- a/packages/riverpod/lib/src/providers/notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -49,11 +49,8 @@ part of '../notifier.dart'; /// {@endtemplate} /// /// {@template riverpod.notifier_provider_modifier} -/// When using `autoDispose` or `family`, your notifier type changes. -/// Instead of extending [Notifier], you should extend either: -/// - [AutoDisposeNotifier] for `autoDispose` -/// - [FamilyNotifier] for `family` -/// - [AutoDisposeFamilyNotifier] for `autoDispose.family` +/// When using `family`, your notifier type changes. +/// Instead of extending [Notifier], you should extend [FamilyNotifier]. /// {@endtemplate} abstract class Notifier extends $Notifier { /// {@template riverpod.notifier.build} @@ -95,19 +92,6 @@ final class NotifierProvider, StateT> runNotifierBuildOverride: null, ); - NotifierProvider._autoDispose( - this._createNotifier, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - isAutoDispose: true, - from: null, - argument: null, - runNotifierBuildOverride: null, - ); - /// An implementation detail of Riverpod @internal NotifierProvider.internal( diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 64064370c..797ef10f4 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -31,18 +31,6 @@ base class Provider argument: null, ); - Provider._autoDispose( - this._create, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - isAutoDispose: true, - from: null, - argument: null, - ); - /// An implementation detail of Riverpod @internal const Provider.internal( @@ -378,17 +366,6 @@ class ProviderFamily computeAllTransitiveDependencies(dependencies), ); - ProviderFamily._autoDispose( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: Provider.internal, - isAutoDispose: true, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - ); - /// An implementation detail of Riverpod @internal ProviderFamily.internal( diff --git a/packages/riverpod/lib/src/providers/stream_notifier.dart b/packages/riverpod/lib/src/providers/stream_notifier.dart index 8274c6974..f3dc1f542 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier.dart @@ -5,7 +5,9 @@ import 'package:meta/meta.dart'; import '../builder.dart'; import '../core/async_value.dart'; import '../framework.dart'; +import 'async_notifier.dart'; import 'future_provider.dart' show FutureProvider; +import 'stream_provider.dart'; part 'stream_notifier/family.dart'; part 'stream_notifier/orphan.dart'; @@ -30,6 +32,8 @@ abstract base class $StreamNotifierProvider< Ref>> // with $FutureModifier { + /// Implementation detail of `riverpod_generator`. + /// Do not use. const $StreamNotifierProvider({ required super.name, required super.from, @@ -52,6 +56,8 @@ class $StreamNotifierProviderElement< // Stream> // with FutureModifierElement { + /// Implementation detail of `riverpod_generator`. + /// Do not use. $StreamNotifierProviderElement(this.provider, super.container); @override diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index 8172b46b2..42d52e7dd 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -38,11 +38,8 @@ abstract class StreamNotifier extends $StreamNotifier { /// {@endtemplate} /// /// {@template riverpod.async_notifier_provider_modifier} -/// When using `autoDispose` or `family`, your notifier type changes. -/// Instead of extending [StreamNotifier], you should extend either: -/// - [AutoDisposeAsyncNotifier] for `autoDispose` -/// - [FamilyAsyncNotifier] for `family` -/// - [AutoDisposeFamilyAsyncNotifier] for `autoDispose.family` +/// When using your notifier type changes. +/// Instead of extending [StreamNotifier], you should extend [FamilyStreamNotifier]. /// {@endtemplate} final class StreamNotifierProvider< // NotifierT extends StreamNotifier, @@ -65,19 +62,6 @@ final class StreamNotifierProvider< // argument: null, ); - StreamNotifierProvider._autoDispose( - this._createNotifier, { - super.name, - super.dependencies, - super.runNotifierBuildOverride, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - from: null, - argument: null, - isAutoDispose: true, - ); - /// An implementation detail of Riverpod @internal const StreamNotifierProvider.internal( diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index 7b0bcbf46..1ee63ad72 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -91,18 +91,6 @@ base class StreamProvider extends $FunctionalProvider< argument: null, ); - StreamProvider._autoDispose( - this._create, { - super.name, - super.dependencies, - }) : super( - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - isAutoDispose: true, - from: null, - argument: null, - ); - /// An implementation detail of Riverpod @internal StreamProvider.internal( @@ -256,15 +244,4 @@ class StreamProviderFamily extends FunctionalFamily< required super.allTransitiveDependencies, required super.isAutoDispose, }) : super(providerFactory: StreamProvider.internal); - - StreamProviderFamily._autoDispose( - super._createFn, { - super.name, - super.dependencies, - }) : super( - providerFactory: StreamProvider.internal, - isAutoDispose: true, - allTransitiveDependencies: - computeAllTransitiveDependencies(dependencies), - ); } diff --git a/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart b/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart index c5e717cfd..02caff0d0 100644 --- a/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart +++ b/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart @@ -89,7 +89,6 @@ void main() { }); group('Notifier.stateOrNull', () { - // TODO should use matrix test('returns null during first build until state= is set', () { final stateInBuild = []; From f27ac61c04dca90ef26ff9274b0935c4f721a952 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 15:09:19 +0100 Subject: [PATCH 198/387] createElement->$createElement --- .../legacy/change_notifier_provider.dart | 5 +++-- packages/riverpod/lib/src/core/family.dart | 6 +++--- packages/riverpod/lib/src/core/override.dart | 2 +- .../lib/src/core/override_with_value.dart | 2 +- .../lib/src/core/provider/notifier_provider.dart | 2 +- .../riverpod/lib/src/core/provider/provider.dart | 2 +- .../lib/src/core/provider_container.dart | 4 ++-- .../lib/src/providers/async_notifier/family.dart | 2 +- .../lib/src/providers/async_notifier/orphan.dart | 2 +- .../lib/src/providers/future_provider.dart | 3 ++- .../legacy/state_notifier_provider.dart | 3 ++- .../lib/src/providers/legacy/state_provider.dart | 3 ++- .../lib/src/providers/notifier/family.dart | 3 ++- .../lib/src/providers/notifier/orphan.dart | 3 ++- .../riverpod/lib/src/providers/provider.dart | 3 ++- .../src/providers/stream_notifier/family.dart | 3 ++- .../src/providers/stream_notifier/orphan.dart | 2 +- .../lib/src/providers/stream_provider.dart | 3 ++- .../lib/src/templates/family.dart | 16 ++++++++-------- .../lib/src/templates/provider.dart | 5 +++-- 20 files changed, 42 insertions(+), 32 deletions(-) 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 index b892db39a..ebd9ecdc5 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -142,8 +142,9 @@ final class ChangeNotifierProvider final NotifierT Function(ChangeNotifierProviderRef ref) _createFn; + @internal @override - ChangeNotifierProviderElement createElement( + ChangeNotifierProviderElement $createElement( ProviderContainer container, ) { return ChangeNotifierProviderElement._(this, container); @@ -265,7 +266,7 @@ class ChangeNotifierProviderFamily dependencies: null, allTransitiveDependencies: null, name: null, - ).createElement(container); + ).$createElement(container); }, ); } diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index ce382bc0c..239d08303 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -130,7 +130,7 @@ class FunctionalFamily< // return provider .$copyWithCreate((ref) => create(ref, provider.argument as ArgT)) - .createElement(container); + .$createElement(container); }, ); } @@ -199,7 +199,7 @@ class ClassFamily< // createElement: (container, provider) { provider as ProviderT; - return provider.$copyWithCreate(create).createElement(container); + return provider.$copyWithCreate(create).$createElement(container); }, ); } @@ -213,7 +213,7 @@ class ClassFamily< // createElement: (container, provider) { provider as ProviderT; - return provider.$copyWithBuild(build).createElement(container); + return provider.$copyWithBuild(build).$createElement(container); }, ); } diff --git a/packages/riverpod/lib/src/core/override.dart b/packages/riverpod/lib/src/core/override.dart index 79e766644..883fcc28a 100644 --- a/packages/riverpod/lib/src/core/override.dart +++ b/packages/riverpod/lib/src/core/override.dart @@ -129,7 +129,7 @@ class TransitiveFamilyOverride implements $FamilyOverride { ProviderContainer container, ProviderBase provider, ) { - return provider.createElement(container); + return provider.$createElement(container); } @override diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index cea8e5e4a..c9629aa88 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -25,7 +25,7 @@ final class $ValueProvider extends ProviderBase Set? get allTransitiveDependencies => null; @override - _ValueProviderElement createElement(ProviderContainer container) { + _ValueProviderElement $createElement(ProviderContainer container) { return _ValueProviderElement(this, container); } } diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index e4f8f0950..4f453dff7 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -145,7 +145,7 @@ abstract base class $ClassProvider< // ClassProviderElement< // NotifierT, StateT, - CreatedT> createElement(ProviderContainer container); + CreatedT> $createElement(ProviderContainer container); } @internal diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index 1e9019fce..e2935be06 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -93,7 +93,7 @@ abstract base class ProviderBase extends ProviderOrFamily /// An internal method that defines how a provider behaves. @visibleForOverriding - ProviderElementBase createElement(ProviderContainer container); + ProviderElementBase $createElement(ProviderContainer container); @override String toString() { diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 8f72cdce1..17372ae44 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -168,7 +168,7 @@ class ProviderDirectory implements _PointerBase { // The provider is overridden. This takes over any family override case (final override?, _): element = - override.providerOverride.createElement(pointer.targetContainer); + override.providerOverride.$createElement(pointer.targetContainer); // The family was overridden using overrideWith & co. case (null, final $FamilyOverride override): @@ -176,7 +176,7 @@ class ProviderDirectory implements _PointerBase { // Either the provider wasn't overridden or it was scoped. case (null, _FamilyOverride() || null): - element = origin.createElement(pointer.targetContainer); + element = origin.$createElement(pointer.targetContainer); } /// Assigning the element before calling "mount" to guarantee diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index 6653a2a98..b6a354f09 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -95,7 +95,7 @@ final class FamilyAsyncNotifierProvider< // @internal @override - $AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement $createElement( ProviderContainer container, ) { return $AsyncNotifierProviderElement(this, container); diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index 6a5d2216f..2145bca99 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -118,7 +118,7 @@ final class AsyncNotifierProvider< // @internal @override - $AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement $createElement( ProviderContainer container, ) { return $AsyncNotifierProviderElement(this, container); diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 5fd94a14d..2997218f0 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -126,8 +126,9 @@ final class FutureProvider extends $FunctionalProvider< @override FutureOr create(FutureProviderRef ref) => this._create(ref); + @internal @override - $FutureProviderElement createElement(ProviderContainer container) { + $FutureProviderElement $createElement(ProviderContainer container) { return $FutureProviderElement(this, container); } diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index 51ca3d829..99d9ec0ec 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -147,8 +147,9 @@ final class StateNotifierProvider< // /// has changes. Refreshable get notifier => _notifier(this); + @internal @override - StateNotifierProviderElement createElement( + StateNotifierProviderElement $createElement( ProviderContainer container, ) { return StateNotifierProviderElement._(this, container); diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 25c728ebe..77d78a05f 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -92,8 +92,9 @@ final class StateProvider Refreshable> get notifier => _notifier(this); + @internal @override - StateProviderElement createElement( + StateProviderElement $createElement( ProviderContainer container, ) { return StateProviderElement._(this, container); diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index 182ac5f23..85b955cb8 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -37,8 +37,9 @@ final class FamilyNotifierProvider // @override NotifierT create() => _createNotifier(); + @internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container, ) { return $NotifierProviderElement(this, container); diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart index 980c8dcdc..a60c242c7 100644 --- a/packages/riverpod/lib/src/providers/notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -116,8 +116,9 @@ final class NotifierProvider, StateT> @override NotifierT create() => _createNotifier(); + @internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container, ) { return $NotifierProviderElement(this, container); diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 797ef10f4..b78160cbf 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -54,8 +54,9 @@ base class Provider @override StateT create(Ref ref) => _create(ref); + @internal @override - $ProviderElement createElement( + $ProviderElement $createElement( ProviderContainer container, ) { return $ProviderElement(this, container); diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index ea3f997c4..481e56e75 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -49,8 +49,9 @@ final class FamilyStreamNotifierProvider< // @override NotifierT create() => _createNotifier(); + @internal @override - $StreamNotifierProviderElement createElement( + $StreamNotifierProviderElement $createElement( ProviderContainer container, ) { return $StreamNotifierProviderElement(this, container); diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index 42d52e7dd..49b4b2451 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -104,7 +104,7 @@ final class StreamNotifierProvider< // @internal @override - $StreamNotifierProviderElement createElement( + $StreamNotifierProviderElement $createElement( ProviderContainer container, ) { return $StreamNotifierProviderElement(this, container); diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index 1ee63ad72..6e2509477 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -114,8 +114,9 @@ base class StreamProvider extends $FunctionalProvider< @override Stream create(Ref> ref) => _create(ref); + @internal @override - $StreamProviderElement createElement( + $StreamProviderElement $createElement( ProviderContainer container, ) { return $StreamProviderElement(this, container); diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 2b65cca08..7469289d2 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -117,7 +117,7 @@ Override overrideWith($createType create,) { )) { case (hasParameters: false, hasGenerics: false, _): buffer.writeln( - r'return provider.$copyWithCreate(create).createElement(container);', + r'return provider.$copyWithCreate(create).$createElement(container);', ); case (hasParameters: true, hasGenerics: false, _): buffer.writeln(''' @@ -126,12 +126,12 @@ Override overrideWith($createType create,) { return provider.\$copyWithCreate(${switch (provider) { FunctionalProviderDeclaration() => '(ref) => create(ref, argument)', ClassBasedProviderDeclaration() => '() => create(argument)', - }}).createElement(container); + }}).\$createElement(container); '''); case (hasParameters: false, hasGenerics: true, _): buffer.writeln( - 'return provider._copyWithCreate(create).createElement(container);', + r'return provider._copyWithCreate(create).$createElement(container);', ); case ( @@ -142,7 +142,7 @@ Override overrideWith($createType create,) { buffer.writeln(''' return provider._copyWithCreate($_genericsDefinition(ref, $_parameterDefinition) { return create(ref, ${provider.argumentToRecord()}); - }).createElement(container); + }).\$createElement(container); '''); case ( hasParameters: true, @@ -154,7 +154,7 @@ Override overrideWith($createType create,) { final argument = provider.argument$_argumentCast; return create(argument); - }).createElement(container); + }).\$createElement(container); '''); } @@ -194,7 +194,7 @@ Override overrideWithBuild($runNotifierBuildType build,) { )) { case (hasParameters: false, hasGenerics: false): buffer.writeln( - r'return provider.$copyWithBuild(build).createElement(container);', + r'return provider.$copyWithBuild(build).$createElement(container);', ); case (hasParameters: true, hasGenerics: false): buffer.writeln(''' @@ -205,7 +205,7 @@ Override overrideWithBuild($runNotifierBuildType build,) { case (hasParameters: false, hasGenerics: true): buffer.writeln( - 'return provider._copyWithBuild(build).createElement(container);', + r'return provider._copyWithBuild(build).$createElement(container);', ); case (hasParameters: true, hasGenerics: true): @@ -214,7 +214,7 @@ Override overrideWithBuild($runNotifierBuildType build,) { final argument = provider.argument$_argumentCast; return build(ref, notifier, argument); - }).createElement(container); + }).\$createElement(container); '''); } diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index ce97ef41b..2b32352cd 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -162,8 +162,9 @@ ${provider.doc} final class $name$_genericsDefinition : '(ref, $createParams) => create(ref)'; buffer.writeln(''' + @\$internal @override - ${provider.elementName}<${provider.valueTypeDisplayString}> createElement( + ${provider.elementName}<${provider.valueTypeDisplayString}> \$createElement( ProviderContainer container ) => ${provider.elementName}(this, container); @@ -212,7 +213,7 @@ ${provider.doc} final class $name$_genericsDefinition @\$internal @override - ${provider.elementName}<$notifierType, ${provider.valueTypeDisplayString}> createElement( + ${provider.elementName}<$notifierType, ${provider.valueTypeDisplayString}> \$createElement( ProviderContainer container ) => ${provider.elementName}(this, container); '''); From 34dc25ec2f3e1c5c0995967d9bddffb2e0f9b524 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 15:11:14 +0100 Subject: [PATCH 199/387] Update generated code --- examples/counter/lib/main.g.dart | 2 +- examples/pub/lib/detail.g.dart | 17 +-- examples/pub/lib/search.g.dart | 5 +- .../integration/build_yaml/lib/main.g.dart | 48 ++++---- .../lib/src/templates/family.dart | 2 +- .../test/integration/annotated.g.dart | 26 ++-- .../test/integration/async.g.dart | 43 ++++--- .../test/integration/auto_dispose.g.dart | 24 ++-- .../test/integration/dependencies.g.dart | 59 +++++---- .../test/integration/dependencies2.g.dart | 22 ++-- .../test/integration/documented.g.dart | 16 +-- .../test/integration/generated.g.dart | 53 +++++---- .../test/integration/hash/hash1.g.dart | 8 +- .../test/integration/scopes.g.dart | 8 +- .../test/integration/split.g.dart | 6 +- .../test/integration/stream.g.dart | 32 ++--- .../test/integration/sync.g.dart | 112 ++++++++++-------- .../generated/golden/lib/sync.g.dart | 26 ++-- ..._class_based_provider_to_functional.g.dart | 14 +-- ..._functional_provider_to_class_based.g.dart | 8 +- .../test/lints/another.g.dart | 3 +- .../avoid_build_context_in_providers.g.dart | 13 +- .../avoid_public_notifier_properties.g.dart | 6 +- .../test/lints/dependencies.g.dart | 78 +++++++----- .../functional_ref/functional_ref.g.dart | 26 ++-- .../notifier_extends/notifier_extends.g.dart | 32 ++--- .../protected_notifier_properties.g.dart | 46 +++---- .../provider_dependencies.g.dart | 36 ++++-- .../test/lints/provider_parameters.g.dart | 5 +- ...oviders_should_specify_dependencies.g.dart | 9 +- .../lints/unsupported_provider_value.g.dart | 59 +++++---- .../advanced/select/select/codegen.g.dart | 3 +- .../select/select_async/codegen.g.dart | 6 +- .../cancel/detail_screen/codegen.g.dart | 4 +- .../detail_screen_cancel/codegen.g.dart | 4 +- .../detail_screen_debounce/codegen.g.dart | 4 +- .../provider_with_extension/codegen.g.dart | 4 +- .../fetch_activity/codegen.g.dart | 4 +- .../pull_to_refresh/full_app/codegen.g.dart | 4 +- .../docs/concepts/about_codegen/main.g.dart | 5 +- .../provider_type/async_class_future.g.dart | 2 +- .../provider_type/async_class_stream.g.dart | 2 +- .../provider_type/async_fn_future.g.dart | 3 +- .../provider_type/async_fn_stream.g.dart | 3 +- .../provider_type/auto_dispose.g.dart | 6 +- .../about_codegen/provider_type/family.g.dart | 5 +- .../provider_type/family_class.g.dart | 6 +- .../provider_type/family_fn.g.dart | 5 +- .../provider_type/sync_class.g.dart | 2 +- .../provider_type/sync_fn.g.dart | 3 +- .../characters_provider/codegen.g.dart | 9 +- .../city_provider/codegen.g.dart | 3 +- .../codegen.g.dart | 6 +- .../read_in_provider/codegen.g.dart | 6 +- .../select_async_provider/codegen.g.dart | 6 +- .../todo_list_provider/codegen.g.dart | 2 +- .../weather_provider/codegen.g.dart | 6 +- .../whole_object_provider/codegen.g.dart | 6 +- .../lifecycle_on_dispose/codegen.g.dart | 3 +- .../creating_a_provider/codegen.g.dart | 3 +- .../declaring_many_providers/codegen.g.dart | 6 +- .../concepts/reading/counter/codegen.g.dart | 5 +- .../concepts/reading/listen/codegen.g.dart | 3 +- .../reading/listen_build/codegen.g.dart | 2 +- .../reading/listen_build/codegen_hooks.g.dart | 2 +- .../concepts/reading/provider/codegen.g.dart | 6 +- .../docs/concepts/reading/read/codegen.g.dart | 2 +- .../reading/read/codegen_hooks.g.dart | 2 +- .../reading/read_build/codegen.g.dart | 2 +- .../read_notifier_build/codegen.g.dart | 2 +- .../concepts/reading/watch/codegen.g.dart | 8 +- .../reading/watch_build/codegen.g.dart | 5 +- .../reading/watch_build/codegen_hooks.g.dart | 5 +- .../watch_notifier_build/codegen.g.dart | 2 +- .../concepts/why_immutability/codegen.g.dart | 2 +- .../cache_for_usage/codegen.g.dart | 3 +- .../auto_dispose/codegen_keep_alive.g.dart | 3 +- .../invalidate_family_example/codegen.g.dart | 5 +- .../auto_dispose/keep_alive/codegen.g.dart | 3 +- .../on_dispose_example/codegen.g.dart | 6 +- .../functional_ref/codegen.g.dart | 6 +- .../listen_example/codegen.g.dart | 6 +- .../notifier_ref/codegen.g.dart | 5 +- .../read_example/codegen.g.dart | 5 +- .../watch_example/codegen.g.dart | 6 +- .../watch_placement/codegen.g.dart | 8 +- .../require_value/codegen.g.dart | 3 +- .../first_request/codegen/provider.g.dart | 4 +- .../passing_args/codegen/family.g.dart | 6 +- .../passing_args/codegen/provider.g.dart | 10 +- .../codegen/todo_list_notifier.g.dart | 2 +- .../todo_list_notifier_add_todo.g.dart | 2 +- .../codegen/todo_list_provider.g.dart | 3 +- .../testing/notifier_mock/codegen.g.dart | 2 +- .../testing/provider_to_mock/codegen.g.dart | 3 +- .../pipe_change_notifier.g.dart | 3 +- .../websockets_sync/raw_usage.g.dart | 3 +- .../shared_pipe_change_notifier.g.dart | 6 +- .../stream_provider/codegen.g.dart | 3 +- .../sync_definition/codegen.g.dart | 3 +- .../docs/from_provider/family/family.g.dart | 5 +- .../async_values/async_values.g.dart | 6 +- .../auto_dispose/auto_dispose.g.dart | 6 +- .../motivation/combine/combine.g.dart | 6 +- .../motivation/same_type/same_type.g.dart | 6 +- .../dart_hello_world/main.g.dart | 3 +- .../hello_world/hooks_codegen/main.g.dart | 3 +- .../getting_started/hello_world/main.g.dart | 3 +- .../introduction/why_riverpod/codegen.g.dart | 5 +- .../declaration/declaration.g.dart | 2 +- .../initialization/initialization.g.dart | 2 +- .../migrated/migrated.g.dart | 2 +- .../add_listener/add_listener.g.dart | 2 +- .../async_notifier/async_notifier.g.dart | 2 +- .../build_init/build_init.g.dart | 2 +- .../family_and_dispose.g.dart | 9 +- .../from_state_provider.g.dart | 2 +- .../old_lifecycles/old_lifecycles.g.dart | 2 +- .../old_lifecycles_final.g.dart | 8 +- .../config_provider/codegen.g.dart | 3 +- .../remote_todos/codegen.g.dart | 2 +- .../notifier_provider/todos/codegen.g.dart | 2 +- .../completed_todos/completed_todos.g.dart | 3 +- .../optimized_previous_button.g.dart | 5 +- .../docs/providers/provider/todo/todo.g.dart | 2 +- .../unoptimized_previous_button.g.dart | 2 +- .../live_stream_chat_provider/codegen.g.dart | 3 +- .../current/about_codegen/main.g.dart | 5 +- .../dart_hello_world/main.g.dart | 3 +- .../getting_started/hello_world/main.g.dart | 3 +- .../remote_todos/codegen.g.dart | 2 +- .../notifier_provider/todos/codegen.g.dart | 2 +- .../current/about_codegen/main.g.dart | 5 +- .../dart_hello_world/main.g.dart | 3 +- .../getting_started/hello_world/main.g.dart | 3 +- .../current/about_codegen/main.g.dart | 5 +- .../dart_hello_world/main.g.dart | 3 +- .../getting_started/hello_world/main.g.dart | 3 +- .../config_provider/codegen.g.dart | 3 +- .../current/about_codegen/main.g.dart | 5 +- .../lifecycle_on_dispose/codegen.g.dart | 3 +- .../concepts/reading/counter/codegen.g.dart | 5 +- .../concepts/reading/listen/codegen.g.dart | 3 +- .../reading/listen_build/codegen.g.dart | 2 +- .../concepts/reading/provider/codegen.g.dart | 6 +- .../concepts/reading/read/codegen.g.dart | 2 +- .../reading/read_build/codegen.g.dart | 2 +- .../read_notifier_build/codegen.g.dart | 2 +- .../concepts/reading/watch/codegen.g.dart | 8 +- .../reading/watch_build/codegen.g.dart | 5 +- .../watch_notifier_build/codegen.g.dart | 2 +- .../dart_hello_world/main.g.dart | 3 +- .../getting_started/hello_world/main.g.dart | 3 +- .../hello_world/main_hooks.g.dart | 3 +- .../config_provider/codegen.g.dart | 3 +- .../remote_todos/codegen.g.dart | 2 +- .../notifier_provider/todos/codegen.g.dart | 2 +- .../completed_todos/completed_todos.g.dart | 3 +- .../optimized_previous_button.g.dart | 5 +- .../providers/provider/todo/todo.g.dart | 2 +- .../unoptimized_previous_button.g.dart | 2 +- website/static/snippets/async.g.dart | 3 +- website/static/snippets/combine.g.dart | 9 +- website/static/snippets/create.g.dart | 3 +- website/static/snippets/declare.g.dart | 2 +- 165 files changed, 815 insertions(+), 545 deletions(-) diff --git a/examples/counter/lib/main.g.dart b/examples/counter/lib/main.g.dart index 0f7638885..fb9ec79d9 100644 --- a/examples/counter/lib/main.g.dart +++ b/examples/counter/lib/main.g.dart @@ -72,7 +72,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index ae55af2bc..32555b792 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -48,8 +48,9 @@ final class FetchPackageDetailsProvider extends $FunctionalProvider< '($argument)'; } + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -128,7 +129,7 @@ final class FetchPackageDetailsFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -165,8 +166,9 @@ final class LikedPackagesProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$likedPackagesHash(); + @$internal @override - $FutureProviderElement> createElement( + $FutureProviderElement> $createElement( ProviderContainer container) => $FutureProviderElement(this, container); @@ -225,8 +227,9 @@ final class PubRepositoryProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -324,7 +327,7 @@ final class PackageMetricsProvider @$internal @override $AsyncNotifierProviderElement - createElement(ProviderContainer container) => + $createElement(ProviderContainer container) => $AsyncNotifierProviderElement(this, container); @override @@ -385,7 +388,7 @@ final class PackageMetricsFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -407,7 +410,7 @@ final class PackageMetricsFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index f17e33b14..6e35485e5 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -54,8 +54,9 @@ final class FetchPackagesProvider extends $FunctionalProvider< '$argument'; } + @$internal @override - $FutureProviderElement> createElement( + $FutureProviderElement> $createElement( ProviderContainer container) => $FutureProviderElement(this, container); @@ -152,7 +153,7 @@ final class FetchPackagesFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 83df22b4c..d467d51bb 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -42,8 +42,9 @@ final class CountProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -93,8 +94,9 @@ final class CountFutureProvider @override String debugGetCreateSourceHash() => _$countFutureHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -144,8 +146,9 @@ final class CountStreamProvider @override String debugGetCreateSourceHash() => _$countStreamHash(); + @$internal @override - $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement $createElement(ProviderContainer container) => $StreamProviderElement(this, container); @override @@ -211,8 +214,9 @@ final class Count2Provider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -290,7 +294,7 @@ final class Count2Family extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -334,8 +338,9 @@ final class CountFuture2Provider '($argument)'; } + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -413,7 +418,7 @@ final class CountFuture2Family extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -457,8 +462,9 @@ final class CountStream2Provider '($argument)'; } + @$internal @override - $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement $createElement(ProviderContainer container) => $StreamProviderElement(this, container); @override @@ -536,7 +542,7 @@ final class CountStream2Family extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -597,7 +603,7 @@ final class CountNotifierProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -658,7 +664,7 @@ final class CountAsyncNotifierProvider @$internal @override - $AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } @@ -720,7 +726,7 @@ final class CountStreamNotifierProvider @$internal @override - $StreamNotifierProviderElement createElement( + $StreamNotifierProviderElement $createElement( ProviderContainer container) => $StreamNotifierProviderElement(this, container); } @@ -804,7 +810,7 @@ final class CountNotifier2Provider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -856,7 +862,7 @@ final class CountNotifier2Family extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -874,7 +880,7 @@ final class CountNotifier2Family extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -955,7 +961,7 @@ final class CountAsyncNotifier2Provider @$internal @override - $AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); @@ -1008,7 +1014,7 @@ final class CountAsyncNotifier2Family extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1028,7 +1034,7 @@ final class CountAsyncNotifier2Family extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1110,7 +1116,7 @@ final class CountStreamNotifier2Provider @$internal @override - $StreamNotifierProviderElement createElement( + $StreamNotifierProviderElement $createElement( ProviderContainer container) => $StreamNotifierProviderElement(this, container); @@ -1163,7 +1169,7 @@ final class CountStreamNotifier2Family extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1183,7 +1189,7 @@ final class CountStreamNotifier2Family extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 7469289d2..34bdee5d6 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -200,7 +200,7 @@ Override overrideWithBuild($runNotifierBuildType build,) { buffer.writeln(''' final argument = provider.argument$_argumentCast; - return provider.\$copyWithBuild((ref, notifier) => build(ref, notifier, argument)).createElement(container); + return provider.\$copyWithBuild((ref, notifier) => build(ref, notifier, argument)).\$createElement(container); '''); case (hasParameters: false, hasGenerics: true): diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 3df6e5865..1699b0d41 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -55,8 +55,9 @@ final class FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -134,7 +135,7 @@ final class FunctionalFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -189,8 +190,9 @@ final class FamilyProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -268,7 +270,7 @@ final class FamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -311,8 +313,9 @@ final class NotCopiedFunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -380,8 +383,9 @@ final class NotCopiedFamilyProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -459,7 +463,7 @@ final class NotCopiedFamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -536,7 +540,7 @@ final class ClassBasedProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -588,7 +592,7 @@ final class ClassBasedFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -606,7 +610,7 @@ final class ClassBasedFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -682,7 +686,7 @@ final class NotCopiedClassBasedProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 57769b683..afdd063cf 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -51,8 +51,9 @@ final class GenericProvider extends $FunctionalProvider< '()'; } + @$internal @override - $FutureProviderElement> createElement(ProviderContainer container) => + $FutureProviderElement> $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -111,7 +112,7 @@ final class GenericFamily extends Family { createElement: (container, provider) { provider as GenericProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -146,8 +147,9 @@ final class PublicProvider @override String debugGetCreateSourceHash() => _$publicHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -197,8 +199,9 @@ final class _PrivateProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$privateHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -257,8 +260,9 @@ final class FamilyOrProvider extends $FunctionalProvider, '($argument)'; } + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -336,7 +340,7 @@ final class FamilyOrFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -395,8 +399,9 @@ final class FamilyProvider '$argument'; } + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -516,7 +521,7 @@ final class FamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -596,7 +601,7 @@ final class GenericClassProvider @$internal @override - $AsyncNotifierProviderElement, List> createElement( + $AsyncNotifierProviderElement, List> $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); @@ -642,7 +647,7 @@ final class GenericClassFamily extends Family { createElement: (container, provider) { provider as GenericClassProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -658,7 +663,7 @@ final class GenericClassFamily extends Family { createElement: (container, provider) { provider as GenericClassProvider; - return provider._copyWithBuild(build).createElement(container); + return provider._copyWithBuild(build).$createElement(container); }, ); } @@ -718,7 +723,7 @@ final class PublicClassProvider @$internal @override - $AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } @@ -779,7 +784,7 @@ final class _PrivateClassProvider @$internal @override - $AsyncNotifierProviderElement<_PrivateClass, String> createElement( + $AsyncNotifierProviderElement<_PrivateClass, String> $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } @@ -854,7 +859,7 @@ final class FamilyOrClassProvider @$internal @override - $AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); @@ -906,7 +911,7 @@ final class FamilyOrClassFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -926,7 +931,7 @@ final class FamilyOrClassFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1027,7 +1032,7 @@ final class FamilyClassProvider @$internal @override - $AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); @@ -1101,7 +1106,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1135,7 +1140,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 86eb591f2..21c3070f8 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -43,8 +43,9 @@ final class KeepAliveProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -102,8 +103,9 @@ final class NotKeepAliveProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -161,8 +163,9 @@ final class DefaultKeepAliveProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -229,8 +232,9 @@ final class KeepAliveFamilyProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -308,7 +312,7 @@ final class KeepAliveFamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -360,8 +364,9 @@ final class NotKeepAliveFamilyProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -440,7 +445,7 @@ final class NotKeepAliveFamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -492,8 +497,9 @@ final class DefaultKeepAliveFamilyProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -573,7 +579,7 @@ final class DefaultKeepAliveFamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 4d740b514..ab354c7f9 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -42,8 +42,9 @@ final class DepProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -109,8 +110,9 @@ final class FamilyProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -188,7 +190,7 @@ final class FamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -245,8 +247,9 @@ final class ProviderProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -319,8 +322,9 @@ final class Provider2Provider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -394,8 +398,9 @@ final class TransitiveDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -467,8 +472,9 @@ final class SmallTransitiveDependencyCountProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -528,8 +534,9 @@ final class EmptyDependenciesFunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -597,8 +604,9 @@ final class ProviderWithDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -657,8 +665,9 @@ final class _PrivateDepProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -716,8 +725,9 @@ final class PublicDepProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -781,8 +791,9 @@ final class DuplicateDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -850,8 +861,9 @@ final class DuplicateDependencies2Provider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -932,8 +944,9 @@ final class TransitiveDuplicateDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -1009,7 +1022,7 @@ final class Dep2Provider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -1091,7 +1104,7 @@ final class Family2Provider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -1143,7 +1156,7 @@ final class Family2Family extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1161,7 +1174,7 @@ final class Family2Family extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1250,7 +1263,7 @@ final class Provider3Provider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -1337,7 +1350,7 @@ final class Provider4Provider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -1399,7 +1412,7 @@ final class Provider4Family extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1417,7 +1430,7 @@ final class Provider4Family extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1496,7 +1509,7 @@ final class EmptyDependenciesClassBasedProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index c535f3288..6530b6825 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -61,8 +61,9 @@ final class ProviderWithDependencies2Provider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -138,8 +139,9 @@ final class FamilyWithDependencies2Provider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -229,7 +231,7 @@ final class FamilyWithDependencies2Family extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -272,8 +274,9 @@ final class _Private2Provider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -330,8 +333,9 @@ final class Public2Provider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -427,7 +431,7 @@ final class NotifierWithDependenciesProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -521,7 +525,7 @@ final class NotifierFamilyWithDependenciesProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -585,7 +589,7 @@ final class NotifierFamilyWithDependenciesFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -605,7 +609,7 @@ final class NotifierFamilyWithDependenciesFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index 67ff42809..68f4d55f6 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -51,8 +51,9 @@ final class FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -127,8 +128,9 @@ final class FamilyProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -210,7 +212,7 @@ final class FamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -276,7 +278,7 @@ final class ClassBasedProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -365,7 +367,7 @@ final class ClassFamilyBasedProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -421,7 +423,7 @@ final class ClassFamilyBasedFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -440,7 +442,7 @@ final class ClassFamilyBasedFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index ff0301881..486fb8d4d 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -43,8 +43,9 @@ final class GeneratedProvider ); } + @$internal @override - $ProviderElement<_Test> createElement(ProviderContainer container) => + $ProviderElement<_Test> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -111,8 +112,9 @@ final class GeneratedFamilyProvider ); } + @$internal @override - $ProviderElement<_Test> createElement(ProviderContainer container) => + $ProviderElement<_Test> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -190,7 +192,7 @@ final class GeneratedFamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -233,8 +235,9 @@ final class $DynamicProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -301,8 +304,9 @@ final class $DynamicFamilyProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -380,7 +384,7 @@ final class $DynamicFamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -432,8 +436,9 @@ final class _DynamicProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -511,7 +516,7 @@ final class _DynamicFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -554,8 +559,9 @@ final class AliasProvider ); } + @$internal @override - $ProviderElement> createElement( + $ProviderElement> $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -624,8 +630,9 @@ final class AliasFamilyProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement> createElement( + $ProviderElement> $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -704,7 +711,7 @@ final class AliasFamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -765,7 +772,7 @@ final class GeneratedClassProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -848,7 +855,7 @@ final class GeneratedClassFamilyProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -901,7 +908,7 @@ final class GeneratedClassFamilyFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -921,7 +928,7 @@ final class GeneratedClassFamilyFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -997,7 +1004,7 @@ final class $DynamicClassProvider @$internal @override - $NotifierProviderElement<$DynamicClass, Object?> createElement( + $NotifierProviderElement<$DynamicClass, Object?> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -1080,7 +1087,7 @@ final class $DynamicClassFamilyProvider @$internal @override - $NotifierProviderElement<$DynamicClassFamily, Object?> createElement( + $NotifierProviderElement<$DynamicClassFamily, Object?> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -1133,7 +1140,7 @@ final class $DynamicClassFamilyFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1153,7 +1160,7 @@ final class $DynamicClassFamilyFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1229,7 +1236,7 @@ final class AliasClassProvider @$internal @override - $NotifierProviderElement> createElement( + $NotifierProviderElement> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -1312,7 +1319,7 @@ final class AliasClassFamilyProvider @$internal @override - $NotifierProviderElement> createElement( + $NotifierProviderElement> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -1364,7 +1371,7 @@ final class AliasClassFamilyFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1384,7 +1391,7 @@ final class AliasClassFamilyFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index 38eb71510..532cdf6cf 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -43,8 +43,9 @@ final class SimpleProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -102,8 +103,9 @@ final class Simple2Provider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -178,7 +180,7 @@ final class SimpleClassProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 27e9abed6..ef4d8e216 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -60,7 +60,7 @@ final class ScopedClassProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -143,7 +143,7 @@ final class ScopedClassFamilyProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -195,7 +195,7 @@ final class ScopedClassFamilyFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -213,7 +213,7 @@ final class ScopedClassFamilyFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index 7f00613a8..1070512c9 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -42,8 +42,9 @@ final class Counter2Provider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -100,8 +101,9 @@ final class CounterProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 908d63591..2ba7eb128 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -51,8 +51,9 @@ final class GenericProvider extends $FunctionalProvider< '()'; } + @$internal @override - $StreamProviderElement> createElement(ProviderContainer container) => + $StreamProviderElement> $createElement(ProviderContainer container) => $StreamProviderElement(this, container); @override @@ -111,7 +112,7 @@ final class GenericFamily extends Family { createElement: (container, provider) { provider as GenericProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -146,8 +147,9 @@ final class PublicProvider @override String debugGetCreateSourceHash() => _$publicHash(); + @$internal @override - $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement $createElement(ProviderContainer container) => $StreamProviderElement(this, container); @override @@ -197,8 +199,9 @@ final class _PrivateProvider @override String debugGetCreateSourceHash() => _$privateHash(); + @$internal @override - $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement $createElement(ProviderContainer container) => $StreamProviderElement(this, container); @override @@ -272,8 +275,9 @@ final class FamilyProvider '$argument'; } + @$internal @override - $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement $createElement(ProviderContainer container) => $StreamProviderElement(this, container); @override @@ -393,7 +397,7 @@ final class FamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -473,7 +477,7 @@ final class GenericClassProvider @$internal @override - $StreamNotifierProviderElement, List> createElement( + $StreamNotifierProviderElement, List> $createElement( ProviderContainer container) => $StreamNotifierProviderElement(this, container); @@ -519,7 +523,7 @@ final class GenericClassFamily extends Family { createElement: (container, provider) { provider as GenericClassProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -535,7 +539,7 @@ final class GenericClassFamily extends Family { createElement: (container, provider) { provider as GenericClassProvider; - return provider._copyWithBuild(build).createElement(container); + return provider._copyWithBuild(build).$createElement(container); }, ); } @@ -595,7 +599,7 @@ final class PublicClassProvider @$internal @override - $StreamNotifierProviderElement createElement( + $StreamNotifierProviderElement $createElement( ProviderContainer container) => $StreamNotifierProviderElement(this, container); } @@ -656,7 +660,7 @@ final class _PrivateClassProvider @$internal @override - $StreamNotifierProviderElement<_PrivateClass, String> createElement( + $StreamNotifierProviderElement<_PrivateClass, String> $createElement( ProviderContainer container) => $StreamNotifierProviderElement(this, container); } @@ -750,7 +754,7 @@ final class FamilyClassProvider @$internal @override - $StreamNotifierProviderElement createElement( + $StreamNotifierProviderElement $createElement( ProviderContainer container) => $StreamNotifierProviderElement(this, container); @@ -824,7 +828,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -858,7 +862,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 6a517afd0..5bbb7ffeb 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -59,8 +59,9 @@ final class GenericProvider ); } + @$internal @override - $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -119,7 +120,7 @@ final class GenericFamily extends Family { createElement: (container, provider) { provider as GenericProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -193,8 +194,9 @@ final class ComplexGenericProvider ); } + @$internal @override - $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -294,7 +296,7 @@ final class ComplexGenericFamily extends Family { param: param, otherParam: otherParam, )); - }).createElement(container); + }).$createElement(container); }, ); } @@ -338,8 +340,9 @@ final class RawFutureProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement>> createElement( + $ProviderElement>> $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -399,8 +402,9 @@ final class RawStreamProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement>> createElement( + $ProviderElement>> $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -468,8 +472,9 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement>> createElement( + $ProviderElement>> $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -548,7 +553,7 @@ final class RawFamilyFutureFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -600,8 +605,9 @@ final class RawFamilyStreamProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement>> createElement( + $ProviderElement>> $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -680,7 +686,7 @@ final class RawFamilyStreamFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -727,8 +733,9 @@ final class PublicProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -786,8 +793,9 @@ final class Supports$inNamesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -873,8 +881,9 @@ final class FamilyProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -996,7 +1005,7 @@ final class FamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1039,8 +1048,9 @@ final class _PrivateProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -1114,8 +1124,9 @@ final class Supports$InFnNameProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -1176,7 +1187,7 @@ final class Supports$InFnNameFamily extends Family { createElement: (container, provider) { provider as Supports$InFnNameProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -1256,8 +1267,9 @@ final class Supports$InFnNameFamilyProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -1367,7 +1379,7 @@ final class Supports$InFnNameFamilyFamily extends Family { named$arg: named$arg, defaultArg: defaultArg, )); - }).createElement(container); + }).$createElement(container); }, ); } @@ -1410,8 +1422,9 @@ final class GeneratedProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -1478,8 +1491,9 @@ final class UnnecessaryCastProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -1557,7 +1571,7 @@ final class UnnecessaryCastFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1645,7 +1659,7 @@ final class GenericClassProvider @$internal @override - $NotifierProviderElement, List> createElement( + $NotifierProviderElement, List> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -1691,7 +1705,7 @@ final class GenericClassFamily extends Family { createElement: (container, provider) { provider as GenericClassProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -1706,7 +1720,7 @@ final class GenericClassFamily extends Family { createElement: (container, provider) { provider as GenericClassProvider; - return provider._copyWithBuild(build).createElement(container); + return provider._copyWithBuild(build).$createElement(container); }, ); } @@ -1774,7 +1788,7 @@ final class RawFutureClassProvider @$internal @override - $NotifierProviderElement>> createElement( + $NotifierProviderElement>> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -1843,7 +1857,7 @@ final class RawStreamClassProvider @$internal @override - $NotifierProviderElement>> createElement( + $NotifierProviderElement>> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -1927,7 +1941,7 @@ final class RawFamilyFutureClassProvider @$internal @override $NotifierProviderElement>> - createElement(ProviderContainer container) => + $createElement(ProviderContainer container) => $NotifierProviderElement(this, container); @override @@ -1979,7 +1993,7 @@ final class RawFamilyFutureClassFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1999,7 +2013,7 @@ final class RawFamilyFutureClassFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -2089,7 +2103,7 @@ final class RawFamilyStreamClassProvider @$internal @override $NotifierProviderElement>> - createElement(ProviderContainer container) => + $createElement(ProviderContainer container) => $NotifierProviderElement(this, container); @override @@ -2141,7 +2155,7 @@ final class RawFamilyStreamClassFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -2161,7 +2175,7 @@ final class RawFamilyStreamClassFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -2238,7 +2252,7 @@ final class PublicClassProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -2307,7 +2321,7 @@ final class _PrivateClassProvider @$internal @override - $NotifierProviderElement<_PrivateClass, String> createElement( + $NotifierProviderElement<_PrivateClass, String> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -2411,7 +2425,7 @@ final class FamilyClassProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -2487,7 +2501,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -2521,7 +2535,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -2644,9 +2658,9 @@ final class Supports$InClassNameProvider @$internal @override - $NotifierProviderElement, String> createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $NotifierProviderElement, String> + $createElement(ProviderContainer container) => + $NotifierProviderElement(this, container); @override bool operator ==(Object other) { @@ -2691,7 +2705,7 @@ final class Supports$InClassNameFamily extends Family { createElement: (container, provider) { provider as Supports$InClassNameProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -2707,7 +2721,7 @@ final class Supports$InClassNameFamily extends Family { createElement: (container, provider) { provider as Supports$InClassNameProvider; - return provider._copyWithBuild(build).createElement(container); + return provider._copyWithBuild(build).$createElement(container); }, ); } @@ -2833,7 +2847,7 @@ final class Supports$InClassFamilyNameProvider @$internal @override $NotifierProviderElement, String> - createElement(ProviderContainer container) => + $createElement(ProviderContainer container) => $NotifierProviderElement(this, container); @override @@ -2901,7 +2915,7 @@ final class Supports$InClassFamilyNameFamily extends Family { }); return create(argument); - }).createElement(container); + }).$createElement(container); }, ); } @@ -2931,7 +2945,7 @@ final class Supports$InClassFamilyNameFamily extends Family { }); return build(ref, notifier, argument); - }).createElement(container); + }).$createElement(container); }, ); } @@ -3030,7 +3044,7 @@ final class UnnecessaryCastClassProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -3083,7 +3097,7 @@ final class UnnecessaryCastClassFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -3103,7 +3117,7 @@ final class UnnecessaryCastClassFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 34a2636b8..fb40a7ab6 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -47,8 +47,9 @@ final class PublicProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -110,8 +111,9 @@ final class Supports$inNamesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -197,8 +199,9 @@ final class FamilyProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -320,7 +323,7 @@ final class FamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -363,8 +366,9 @@ final class _PrivateProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -442,7 +446,7 @@ final class PublicClassProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -511,7 +515,7 @@ final class _PrivateClassProvider @$internal @override - $NotifierProviderElement<_PrivateClass, String> createElement( + $NotifierProviderElement<_PrivateClass, String> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -615,7 +619,7 @@ final class FamilyClassProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -691,7 +695,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -725,7 +729,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -821,7 +825,7 @@ final class Supports$InClassNameProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index d42db52f3..9a96ac1cc 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -63,7 +63,7 @@ final class ExampleProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -159,7 +159,7 @@ final class ExampleFamilyProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -223,7 +223,7 @@ final class ExampleFamilyFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -251,7 +251,7 @@ final class ExampleFamilyFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -359,7 +359,7 @@ final class GenericProvider @$internal @override - $NotifierProviderElement, int> createElement( + $NotifierProviderElement, int> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -404,7 +404,7 @@ final class GenericFamily extends Family { createElement: (container, provider) { provider as GenericProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -418,7 +418,7 @@ final class GenericFamily extends Family { createElement: (container, provider) { provider as GenericProvider; - return provider._copyWithBuild(build).createElement(container); + return provider._copyWithBuild(build).$createElement(container); }, ); } diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index 6835004da..6ee68ecb0 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -46,8 +46,9 @@ final class ExampleProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -124,8 +125,9 @@ final class ExampleFamilyProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -223,7 +225,7 @@ final class ExampleFamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/another.g.dart b/packages/riverpod_lint_flutter_test/test/lints/another.g.dart index 88968f6a9..a10fa84a7 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/another.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/another.g.dart @@ -42,8 +42,9 @@ final class BProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index c397dd31c..9356f1186 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -57,8 +57,9 @@ final class FnProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -154,7 +155,7 @@ final class FnFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -238,7 +239,7 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -300,7 +301,7 @@ final class MyNotifierFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -328,7 +329,7 @@ final class MyNotifierFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -411,7 +412,7 @@ final class Regresion2959Provider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index a416e4830..1e5c10f85 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -75,7 +75,7 @@ final class GeneratedNotifierProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -127,7 +127,7 @@ final class GeneratedNotifierFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -145,7 +145,7 @@ final class GeneratedNotifierFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart index 5e5982dc4..2d61eccc9 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart @@ -42,8 +42,9 @@ final class DepProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -101,8 +102,9 @@ final class GeneratedScopedProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -160,8 +162,9 @@ final class GeneratedRootProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -220,8 +223,9 @@ final class WatchScopedButNoDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -283,8 +287,9 @@ final class WatchGeneratedScopedButNoDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -344,8 +349,9 @@ final class WatchRootButNoDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -407,8 +413,9 @@ final class WatchGeneratedRootButNoDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -468,8 +475,9 @@ final class WatchScopedButEmptyDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -531,8 +539,9 @@ final class WatchGeneratedScopedButEmptyDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -592,8 +601,9 @@ final class WatchRootButEmptyDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -655,8 +665,9 @@ final class WatchGeneratedRootButEmptyDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -722,8 +733,9 @@ final class WatchScopedButMissingDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -790,8 +802,9 @@ final class WatchGeneratedScopedButMissingDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -855,8 +868,9 @@ final class WatchRootButMissingDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -923,8 +937,9 @@ final class WatchGeneratedRootButMissingDependenciesProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -991,8 +1006,9 @@ final class WatchGeneratedScopedAndContainsDependencyProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -1059,8 +1075,9 @@ final class WatchGeneratedRootAndContainsDependencyProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -1129,8 +1146,9 @@ final class SpecifiedDependencyButNeverUsedProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -1193,8 +1211,9 @@ final class Regression2348Provider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -1263,8 +1282,9 @@ final class FamilyDepProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -1344,7 +1364,7 @@ final class FamilyDepFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1400,8 +1420,9 @@ final class FamilyDep2Provider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -1482,7 +1503,7 @@ final class FamilyDep2Family extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1524,8 +1545,9 @@ final class AliasProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -1609,7 +1631,7 @@ final class ClassWatchGeneratedRootButMissingDependenciesProvider @$internal @override $NotifierProviderElement - createElement(ProviderContainer container) => + $createElement(ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -1687,7 +1709,7 @@ final class ClassWatchGeneratedScopedButMissingDependenciesProvider @$internal @override $NotifierProviderElement - createElement(ProviderContainer container) => + $createElement(ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -1761,7 +1783,7 @@ final class Regression2417Provider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -1829,7 +1851,7 @@ final class AliasClassProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 087a255a4..ab14a931f 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -42,8 +42,9 @@ final class NamelessProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -100,8 +101,9 @@ final class ScopedProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -175,8 +177,9 @@ final class GenericsProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -237,7 +240,7 @@ final class GenericsFamily extends Family { createElement: (container, provider) { provider as GenericsProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -296,8 +299,9 @@ final class NoGenericsProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -358,7 +362,7 @@ final class NoGenericsFamily extends Family { createElement: (container, provider) { provider as NoGenericsProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -417,8 +421,9 @@ final class MissingGenericsProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -479,7 +484,7 @@ final class MissingGenericsFamily extends Family { createElement: (container, provider) { provider as MissingGenericsProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -538,8 +543,9 @@ final class WrongOrderProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -600,7 +606,7 @@ final class WrongOrderFamily extends Family { createElement: (container, provider) { provider as WrongOrderProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart index 9b09de53f..1b499dbc7 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart @@ -60,7 +60,7 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -128,7 +128,7 @@ final class NoExtendsProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -196,7 +196,7 @@ final class WrongExtendsProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -265,7 +265,7 @@ final class _PrivateClassProvider @$internal @override - $NotifierProviderElement<_PrivateClass, String> createElement( + $NotifierProviderElement<_PrivateClass, String> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -361,7 +361,7 @@ final class GenericsProvider @$internal @override - $NotifierProviderElement, int> createElement( + $NotifierProviderElement, int> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -407,7 +407,7 @@ final class GenericsFamily extends Family { createElement: (container, provider) { provider as GenericsProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -421,7 +421,7 @@ final class GenericsFamily extends Family { createElement: (container, provider) { provider as GenericsProvider; - return provider._copyWithBuild(build).createElement(container); + return provider._copyWithBuild(build).$createElement(container); }, ); } @@ -516,7 +516,7 @@ final class NoGenericsProvider @$internal @override - $NotifierProviderElement, int> createElement( + $NotifierProviderElement, int> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -562,7 +562,7 @@ final class NoGenericsFamily extends Family { createElement: (container, provider) { provider as NoGenericsProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -577,7 +577,7 @@ final class NoGenericsFamily extends Family { createElement: (container, provider) { provider as NoGenericsProvider; - return provider._copyWithBuild(build).createElement(container); + return provider._copyWithBuild(build).$createElement(container); }, ); } @@ -674,7 +674,7 @@ final class MissingGenericsProvider @$internal @override - $NotifierProviderElement, int> createElement( + $NotifierProviderElement, int> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -720,7 +720,7 @@ final class MissingGenericsFamily extends Family { createElement: (container, provider) { provider as MissingGenericsProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -734,7 +734,7 @@ final class MissingGenericsFamily extends Family { createElement: (container, provider) { provider as MissingGenericsProvider; - return provider._copyWithBuild(build).createElement(container); + return provider._copyWithBuild(build).$createElement(container); }, ); } @@ -829,7 +829,7 @@ final class WrongOrderProvider @$internal @override - $NotifierProviderElement, int> createElement( + $NotifierProviderElement, int> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -875,7 +875,7 @@ final class WrongOrderFamily extends Family { createElement: (container, provider) { provider as WrongOrderProvider; - return provider._copyWithCreate(create).createElement(container); + return provider._copyWithCreate(create).$createElement(container); }, ); } @@ -889,7 +889,7 @@ final class WrongOrderFamily extends Family { createElement: (container, provider) { provider as WrongOrderProvider; - return provider._copyWithBuild(build).createElement(container); + return provider._copyWithBuild(build).$createElement(container); }, ); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index 49350f93c..91deb5a6a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -59,7 +59,8 @@ final class AProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement(ProviderContainer container) => + $NotifierProviderElement $createElement( + ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -125,7 +126,7 @@ final class A2Provider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -205,7 +206,7 @@ final class A3Provider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -257,7 +258,7 @@ final class A3Family extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -275,7 +276,7 @@ final class A3Family extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -361,7 +362,7 @@ final class A4Provider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -413,7 +414,7 @@ final class A4Family extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -431,7 +432,7 @@ final class A4Family extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -509,7 +510,7 @@ final class A5Provider extends $AsyncNotifierProvider { @$internal @override - $AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); @@ -561,7 +562,7 @@ final class A5Family extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -580,7 +581,7 @@ final class A5Family extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -659,7 +660,7 @@ final class A6Provider extends $AsyncNotifierProvider { @$internal @override - $AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); @@ -711,7 +712,7 @@ final class A6Family extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -730,7 +731,7 @@ final class A6Family extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -809,7 +810,7 @@ final class A7Provider extends $StreamNotifierProvider { @$internal @override - $StreamNotifierProviderElement createElement( + $StreamNotifierProviderElement $createElement( ProviderContainer container) => $StreamNotifierProviderElement(this, container); @@ -861,7 +862,7 @@ final class A7Family extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -880,7 +881,7 @@ final class A7Family extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -959,7 +960,7 @@ final class A8Provider extends $StreamNotifierProvider { @$internal @override - $StreamNotifierProviderElement createElement( + $StreamNotifierProviderElement $createElement( ProviderContainer container) => $StreamNotifierProviderElement(this, container); @@ -1011,7 +1012,7 @@ final class A8Family extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1030,7 +1031,7 @@ final class A8Family extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -1104,7 +1105,8 @@ final class BProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement(ProviderContainer container) => + $NotifierProviderElement $createElement( + ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -1170,7 +1172,7 @@ final class B2Provider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart index 98cb70621..252dd83a6 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart @@ -42,8 +42,9 @@ final class DepProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -100,8 +101,9 @@ final class Dep2Provider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -167,8 +169,9 @@ final class PlainAnnotationProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -226,8 +229,9 @@ final class CustomAnnotationProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -287,8 +291,9 @@ final class CustomAnnotationWithTrailingCommaProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -347,8 +352,9 @@ final class ExistingDepProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -406,8 +412,9 @@ final class MultipleDepsProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -470,8 +477,9 @@ final class ExtraDepProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -532,8 +540,9 @@ final class NoDepProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -596,8 +605,9 @@ final class DependenciesFirstThenKeepAliveProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -660,8 +670,9 @@ final class NoDepNoParamProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -723,8 +734,9 @@ final class NoDepWithoutCommaProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index f327620e0..7752bdbee 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -52,8 +52,9 @@ final class GeneratorProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -131,7 +132,7 @@ final class GeneratorFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart index cf6a92a00..3cf23ea4e 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart @@ -42,8 +42,9 @@ final class ScopedProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -101,8 +102,9 @@ final class UnimplementedScopedProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -160,8 +162,9 @@ final class RootProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart index 638a9b5e4..a8f8da5e2 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart @@ -42,8 +42,9 @@ final class IntegerProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -102,8 +103,9 @@ final class StateNotifierProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement createElement( + $ProviderElement $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -158,8 +160,9 @@ final class AsyncStateNotifierProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$asyncStateNotifierHash(); + @$internal @override - $FutureProviderElement createElement( + $FutureProviderElement $createElement( ProviderContainer container) => $FutureProviderElement(this, container); @@ -215,8 +218,9 @@ final class StateNotifierAsyncProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$stateNotifierAsyncHash(); + @$internal @override - $FutureProviderElement createElement( + $FutureProviderElement $createElement( ProviderContainer container) => $FutureProviderElement(this, container); @@ -277,8 +281,9 @@ final class ChangeNotifierProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement createElement( + $ProviderElement $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -337,8 +342,9 @@ final class NotifierProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -396,8 +402,9 @@ final class AutoDisposeNotifierProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement createElement( + $ProviderElement $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -458,8 +465,9 @@ final class AsyncNotifierProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement createElement( + $ProviderElement $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -519,8 +527,9 @@ final class RawNotifierProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement> createElement( + $ProviderElement> $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -581,8 +590,9 @@ final class RawFutureNotifierProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement>> createElement( + $ProviderElement>> $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -643,8 +653,9 @@ final class RawStreamNotifierProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement>> createElement( + $ProviderElement>> $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -699,8 +710,9 @@ final class FutureRawNotifierProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$futureRawNotifierHash(); + @$internal @override - $FutureProviderElement> createElement( + $FutureProviderElement> $createElement( ProviderContainer container) => $FutureProviderElement(this, container); @@ -755,8 +767,9 @@ final class StreamRawNotifierProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$streamRawNotifierHash(); + @$internal @override - $StreamProviderElement> createElement( + $StreamProviderElement> $createElement( ProviderContainer container) => $StreamProviderElement(this, container); @@ -833,7 +846,7 @@ final class StateNotifierClassProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -895,7 +908,7 @@ final class SelfNotifierProvider @$internal @override - $AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } @@ -964,7 +977,7 @@ final class SyncSelfNotifierProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -1026,7 +1039,7 @@ final class StreamSelfNotifierProvider @$internal @override $StreamNotifierProviderElement - createElement(ProviderContainer container) => + $createElement(ProviderContainer container) => $StreamNotifierProviderElement(this, container); } @@ -1091,7 +1104,7 @@ final class StateNotifierClassAsyncProvider @$internal @override $AsyncNotifierProviderElement - createElement(ProviderContainer container) => + $createElement(ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } @@ -1161,9 +1174,9 @@ final class ChangeNotifierClassProvider @$internal @override - $NotifierProviderElement createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $NotifierProviderElement + $createElement(ProviderContainer container) => + $NotifierProviderElement(this, container); } String _$changeNotifierClassHash() => @@ -1231,7 +1244,7 @@ final class NotifierClassProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } @@ -1300,7 +1313,7 @@ final class AsyncNotifierClassProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/advanced/select/select/codegen.g.dart b/website/docs/advanced/select/select/codegen.g.dart index 3014d78df..069263edb 100644 --- a/website/docs/advanced/select/select/codegen.g.dart +++ b/website/docs/advanced/select/select/codegen.g.dart @@ -44,8 +44,9 @@ final class ExampleProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/advanced/select/select_async/codegen.g.dart b/website/docs/advanced/select/select_async/codegen.g.dart index 6711018e4..2ce06d1ae 100644 --- a/website/docs/advanced/select/select_async/codegen.g.dart +++ b/website/docs/advanced/select/select_async/codegen.g.dart @@ -37,8 +37,9 @@ final class UserProvider @override String debugGetCreateSourceHash() => _$userHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -96,8 +97,9 @@ final class ExampleProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart index 0c36b2053..aec2ffe13 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart @@ -57,8 +57,10 @@ final class ActivityProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$activityHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement( + ProviderContainer container) => $FutureProviderElement(this, container); @override diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart index 44faaf40b..66634724c 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -37,8 +37,10 @@ final class ActivityProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$activityHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement( + ProviderContainer container) => $FutureProviderElement(this, container); @override diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart index 61417d472..7131a0db7 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -37,8 +37,10 @@ final class ActivityProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$activityHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement( + ProviderContainer container) => $FutureProviderElement(this, container); @override diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart index f4ff64ea1..128d538bf 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -37,8 +37,10 @@ final class ActivityProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$activityHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement( + ProviderContainer container) => $FutureProviderElement(this, container); @override diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart index 30843751f..92c2fb027 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -37,8 +37,10 @@ final class ActivityProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$activityHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement( + ProviderContainer container) => $FutureProviderElement(this, container); @override diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart index 0c36b2053..aec2ffe13 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -57,8 +57,10 @@ final class ActivityProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$activityHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement( + ProviderContainer container) => $FutureProviderElement(this, container); @override diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 646d4ba60..41f67d339 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -46,8 +46,9 @@ final class FetchUserProvider '($argument)'; } + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -125,7 +126,7 @@ final class FetchUserFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart index 35fb4c701..1172a8ca6 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart @@ -54,7 +54,7 @@ final class ExampleProvider extends $AsyncNotifierProvider { @$internal @override - $AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart index f10c14ef9..de860bb63 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart @@ -54,7 +54,7 @@ final class ExampleProvider extends $StreamNotifierProvider { @$internal @override - $StreamNotifierProviderElement createElement( + $StreamNotifierProviderElement $createElement( ProviderContainer container) => $StreamNotifierProviderElement(this, container); } diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart index b94f5401e..15a20ea77 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -37,8 +37,9 @@ final class ExampleProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$exampleHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart index cbda18ab2..163bb593f 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -37,8 +37,9 @@ final class ExampleProvider @override String debugGetCreateSourceHash() => _$exampleHash(); + @$internal @override - $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement $createElement(ProviderContainer container) => $StreamProviderElement(this, container); @override diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart index 3d647a07d..a52691df6 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -45,8 +45,9 @@ final class Example1Provider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -104,8 +105,9 @@ final class Example2Provider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index a529e472e..016068466 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -54,8 +54,9 @@ final class ExampleProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -133,7 +134,7 @@ final class ExampleFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index d20abc8e9..9205ef62a 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -86,7 +86,7 @@ final class ExampleProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); @@ -148,7 +148,7 @@ final class ExampleFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -176,7 +176,7 @@ final class ExampleFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index 8a03656f1..a1a795b7c 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -60,8 +60,9 @@ final class ExampleProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -157,7 +158,7 @@ final class ExampleFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart index 02a235091..adc2e93df 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart @@ -62,7 +62,7 @@ final class ExampleProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart index 4cea95277..9a6ccdf70 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -45,8 +45,9 @@ final class ExampleProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart index 7bbd14b6c..76d999f2a 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -45,8 +45,9 @@ final class SearchProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -98,8 +99,9 @@ final class ConfigsProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$configsHash(); + @$internal @override - $StreamProviderElement createElement( + $StreamProviderElement $createElement( ProviderContainer container) => $StreamProviderElement(this, container); @@ -152,8 +154,9 @@ final class CharactersProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$charactersHash(); + @$internal @override - $FutureProviderElement> createElement( + $FutureProviderElement> $createElement( ProviderContainer container) => $FutureProviderElement(this, container); diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart index d17ff088f..f7b66e8c3 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -44,8 +44,9 @@ final class CityProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart index 1995572f6..08edda5a5 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -45,8 +45,9 @@ final class FilterProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -104,8 +105,9 @@ final class FilteredTodoListProvider ); } + @$internal @override - $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart index 6245253cc..124d73ed8 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -45,8 +45,9 @@ final class AnotherProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -103,8 +104,9 @@ final class MyProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart index ce2291f66..83a4d5829 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -39,8 +39,9 @@ final class ConfigProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$configHash(); + @$internal @override - $StreamProviderElement createElement( + $StreamProviderElement $createElement( ProviderContainer container) => $StreamProviderElement(this, container); @@ -93,8 +94,9 @@ final class ProductsProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$productsHash(); + @$internal @override - $FutureProviderElement> createElement( + $FutureProviderElement> $createElement( ProviderContainer container) => $FutureProviderElement(this, container); diff --git a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart index 40969f405..767e99cc6 100644 --- a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart @@ -62,7 +62,7 @@ final class TodoListProvider extends $NotifierProvider> { @$internal @override - $NotifierProviderElement> createElement( + $NotifierProviderElement> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart index b7bb28b9b..e0cb3b238 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -44,8 +44,9 @@ final class CityProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -95,8 +96,9 @@ final class WeatherProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$weatherHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart index a9317e8b9..c21282853 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -39,8 +39,9 @@ final class ConfigProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$configHash(); + @$internal @override - $StreamProviderElement createElement( + $StreamProviderElement $createElement( ProviderContainer container) => $StreamProviderElement(this, container); @@ -93,8 +94,9 @@ final class ProductsProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$productsHash(); + @$internal @override - $FutureProviderElement> createElement( + $FutureProviderElement> $createElement( ProviderContainer container) => $FutureProviderElement(this, container); diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart index ee97df1b7..19c4e564b 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart @@ -37,8 +37,9 @@ final class ExampleProvider @override String debugGetCreateSourceHash() => _$exampleHash(); + @$internal @override - $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement $createElement(ProviderContainer container) => $StreamProviderElement(this, container); @override diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart index 57eef91e0..bb1efdb5f 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart @@ -44,8 +44,9 @@ final class MyProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart index 73887db79..8b589ad1e 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart @@ -44,8 +44,9 @@ final class CityProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -103,8 +104,9 @@ final class CountryProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/concepts/reading/counter/codegen.g.dart b/website/docs/concepts/reading/counter/codegen.g.dart index 94660bb89..be9934548 100644 --- a/website/docs/concepts/reading/counter/codegen.g.dart +++ b/website/docs/concepts/reading/counter/codegen.g.dart @@ -45,8 +45,9 @@ final class RepositoryProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -121,7 +122,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/concepts/reading/listen/codegen.g.dart b/website/docs/concepts/reading/listen/codegen.g.dart index f67a22f9e..4a50c5ca5 100644 --- a/website/docs/concepts/reading/listen/codegen.g.dart +++ b/website/docs/concepts/reading/listen/codegen.g.dart @@ -44,8 +44,9 @@ final class AnotherProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/concepts/reading/listen_build/codegen.g.dart b/website/docs/concepts/reading/listen_build/codegen.g.dart index cdc8bea0e..105a6133f 100644 --- a/website/docs/concepts/reading/listen_build/codegen.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen.g.dart @@ -62,7 +62,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart index 33dd3b590..a6d55dcde 100644 --- a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart @@ -62,7 +62,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/concepts/reading/provider/codegen.g.dart b/website/docs/concepts/reading/provider/codegen.g.dart index 0d25dbdcc..d27f8eaca 100644 --- a/website/docs/concepts/reading/provider/codegen.g.dart +++ b/website/docs/concepts/reading/provider/codegen.g.dart @@ -45,8 +45,9 @@ final class RepositoryProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -103,8 +104,9 @@ final class ValueProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/concepts/reading/read/codegen.g.dart b/website/docs/concepts/reading/read/codegen.g.dart index dc0a6828f..9b6f2d253 100644 --- a/website/docs/concepts/reading/read/codegen.g.dart +++ b/website/docs/concepts/reading/read/codegen.g.dart @@ -62,7 +62,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/concepts/reading/read/codegen_hooks.g.dart b/website/docs/concepts/reading/read/codegen_hooks.g.dart index 235643163..681ff8533 100644 --- a/website/docs/concepts/reading/read/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/read/codegen_hooks.g.dart @@ -62,7 +62,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/concepts/reading/read_build/codegen.g.dart b/website/docs/concepts/reading/read_build/codegen.g.dart index dc0a6828f..9b6f2d253 100644 --- a/website/docs/concepts/reading/read_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_build/codegen.g.dart @@ -62,7 +62,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart index dc0a6828f..9b6f2d253 100644 --- a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart @@ -62,7 +62,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/concepts/reading/watch/codegen.g.dart b/website/docs/concepts/reading/watch/codegen.g.dart index 585133263..5188a21eb 100644 --- a/website/docs/concepts/reading/watch/codegen.g.dart +++ b/website/docs/concepts/reading/watch/codegen.g.dart @@ -45,8 +45,9 @@ final class FilterTypeProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -104,8 +105,9 @@ final class FilteredTodoListProvider ); } + @$internal @override - $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -180,7 +182,7 @@ final class TodosProvider extends $NotifierProvider> { @$internal @override - $NotifierProviderElement> createElement( + $NotifierProviderElement> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/concepts/reading/watch_build/codegen.g.dart b/website/docs/concepts/reading/watch_build/codegen.g.dart index 571be96d3..a977df7b6 100644 --- a/website/docs/concepts/reading/watch_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen.g.dart @@ -44,8 +44,9 @@ final class CounterProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -120,7 +121,7 @@ final class TodoListProvider extends $NotifierProvider> { @$internal @override - $NotifierProviderElement> createElement( + $NotifierProviderElement> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart index 7bd663d14..172d4ee49 100644 --- a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart @@ -44,8 +44,9 @@ final class CounterProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -120,7 +121,7 @@ final class TodoListProvider extends $NotifierProvider> { @$internal @override - $NotifierProviderElement> createElement( + $NotifierProviderElement> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart index dc0a6828f..9b6f2d253 100644 --- a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart @@ -62,7 +62,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/concepts/why_immutability/codegen.g.dart b/website/docs/concepts/why_immutability/codegen.g.dart index c1859edee..88eac19dc 100644 --- a/website/docs/concepts/why_immutability/codegen.g.dart +++ b/website/docs/concepts/why_immutability/codegen.g.dart @@ -63,7 +63,7 @@ final class ThemeNotifierProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart index 2b0c0fde5..423d550c9 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -37,8 +37,9 @@ final class ExampleProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$exampleHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart index f388f08f3..6565fc05b 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -44,8 +44,9 @@ final class ExampleProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index f7fe3e526..faf2b4033 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -53,8 +53,9 @@ final class LabelProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -132,7 +133,7 @@ final class LabelFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart index 76513b615..51ab6e0c5 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -37,8 +37,9 @@ final class ExampleProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$exampleHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart index f8ee2895c..e5b67e8f7 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -44,8 +44,9 @@ final class OtherProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -95,8 +96,9 @@ final class ExampleProvider @override String debugGetCreateSourceHash() => _$exampleHash(); + @$internal @override - $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement $createElement(ProviderContainer container) => $StreamProviderElement(this, container); @override diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart index 2d2aa51b4..e1926f3be 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart @@ -44,8 +44,9 @@ final class OtherProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -102,8 +103,9 @@ final class ExampleProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart index 03ea8dc9b..e86f55591 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart @@ -44,8 +44,9 @@ final class OtherProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -102,8 +103,9 @@ final class ExampleProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart index 3373f4a7a..6be34301f 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -44,8 +44,9 @@ final class OtherProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -120,7 +121,7 @@ final class ExampleProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/essentials/combining_requests/read_example/codegen.g.dart b/website/docs/essentials/combining_requests/read_example/codegen.g.dart index 07b21821f..9c59854c2 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.g.dart @@ -44,8 +44,9 @@ final class OtherProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -120,7 +121,7 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart index 4ab444d4f..1d47b1279 100644 --- a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart @@ -41,8 +41,9 @@ final class LocationProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$locationHash(); + @$internal @override - $StreamProviderElement<({double longitude, double latitude})> createElement( + $StreamProviderElement<({double longitude, double latitude})> $createElement( ProviderContainer container) => $StreamProviderElement(this, container); @@ -95,8 +96,9 @@ final class RestaurantsNearMeProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$restaurantsNearMeHash(); + @$internal @override - $FutureProviderElement> createElement( + $FutureProviderElement> $createElement( ProviderContainer container) => $FutureProviderElement(this, container); diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart index 8362725da..0ecf40b5b 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart @@ -44,8 +44,9 @@ final class OtherProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -102,8 +103,9 @@ final class ExampleProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -178,7 +180,7 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart index 7ced3b8b4..fa3e37948 100644 --- a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart +++ b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart @@ -37,8 +37,9 @@ final class ExampleProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$exampleHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override diff --git a/website/docs/essentials/first_request/codegen/provider.g.dart b/website/docs/essentials/first_request/codegen/provider.g.dart index f8ec4b80b..d808de3c3 100644 --- a/website/docs/essentials/first_request/codegen/provider.g.dart +++ b/website/docs/essentials/first_request/codegen/provider.g.dart @@ -45,8 +45,10 @@ final class ActivityProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$activityHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement( + ProviderContainer container) => $FutureProviderElement(this, container); @override diff --git a/website/docs/essentials/passing_args/codegen/family.g.dart b/website/docs/essentials/passing_args/codegen/family.g.dart index 6068e640d..b63a6db32 100644 --- a/website/docs/essentials/passing_args/codegen/family.g.dart +++ b/website/docs/essentials/passing_args/codegen/family.g.dart @@ -46,8 +46,10 @@ final class ActivityProvider extends $FunctionalProvider, '($argument)'; } + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement( + ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -125,7 +127,7 @@ final class ActivityFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/website/docs/essentials/passing_args/codegen/provider.g.dart b/website/docs/essentials/passing_args/codegen/provider.g.dart index 38fa644b5..04b627967 100644 --- a/website/docs/essentials/passing_args/codegen/provider.g.dart +++ b/website/docs/essentials/passing_args/codegen/provider.g.dart @@ -37,8 +37,10 @@ final class ActivityProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$activityHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement( + ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -120,7 +122,7 @@ final class ActivityNotifier2Provider @$internal @override - $AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); @@ -172,7 +174,7 @@ final class ActivityNotifier2Family extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -192,7 +194,7 @@ final class ActivityNotifier2Family extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart index 8bff9688e..81218695d 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -70,7 +70,7 @@ final class TodoListProvider @$internal @override - $AsyncNotifierProviderElement> createElement( + $AsyncNotifierProviderElement> $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart index dd6531193..19c5471ad 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -55,7 +55,7 @@ final class TodoListProvider @$internal @override - $AsyncNotifierProviderElement> createElement( + $AsyncNotifierProviderElement> $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart index cd63468c9..c890d03c6 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -37,8 +37,9 @@ final class TodoListProvider extends $FunctionalProvider>, @override String debugGetCreateSourceHash() => _$todoListHash(); + @$internal @override - $FutureProviderElement> createElement( + $FutureProviderElement> $createElement( ProviderContainer container) => $FutureProviderElement(this, container); diff --git a/website/docs/essentials/testing/notifier_mock/codegen.g.dart b/website/docs/essentials/testing/notifier_mock/codegen.g.dart index c35d5f4e0..df3894527 100644 --- a/website/docs/essentials/testing/notifier_mock/codegen.g.dart +++ b/website/docs/essentials/testing/notifier_mock/codegen.g.dart @@ -62,7 +62,7 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart index 7ced3b8b4..fa3e37948 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart @@ -37,8 +37,9 @@ final class ExampleProvider extends $FunctionalProvider, @override String debugGetCreateSourceHash() => _$exampleHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart index 0e7e7e269..8f0d894c9 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -54,8 +54,9 @@ final class MyListenableProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement>> createElement( + $ProviderElement>> $createElement( ProviderContainer container) => $ProviderElement(this, container); diff --git a/website/docs/essentials/websockets_sync/raw_usage.g.dart b/website/docs/essentials/websockets_sync/raw_usage.g.dart index 280caca0a..60959986e 100644 --- a/website/docs/essentials/websockets_sync/raw_usage.g.dart +++ b/website/docs/essentials/websockets_sync/raw_usage.g.dart @@ -46,8 +46,9 @@ final class RawStreamProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement>> createElement( + $ProviderElement>> $createElement( ProviderContainer container) => $ProviderElement(this, container); diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart index 789d750c9..ebffc98b1 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -46,8 +46,9 @@ final class MyListenableProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement>> createElement( + $ProviderElement>> $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -106,8 +107,9 @@ final class AnotherListenableProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement>> createElement( + $ProviderElement>> $createElement( ProviderContainer container) => $ProviderElement(this, container); diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart index 9f8f57d4c..eabd579e0 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -37,8 +37,9 @@ final class StreamExampleProvider @override String debugGetCreateSourceHash() => _$streamExampleHash(); + @$internal @override - $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement $createElement(ProviderContainer container) => $StreamProviderElement(this, container); @override diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart index 9529882fd..ffc21fd38 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -45,8 +45,9 @@ final class SynchronousExampleProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index 3950f7105..f53a38413 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -59,8 +59,9 @@ final class RandomProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -156,7 +157,7 @@ final class RandomFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/website/docs/from_provider/motivation/async_values/async_values.g.dart b/website/docs/from_provider/motivation/async_values/async_values.g.dart index c439c28d3..ae3227615 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.g.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.g.dart @@ -37,8 +37,9 @@ final class ItemsApiProvider extends $FunctionalProvider>, @override String debugGetCreateSourceHash() => _$itemsApiHash(); + @$internal @override - $FutureProviderElement> createElement( + $FutureProviderElement> $createElement( ProviderContainer container) => $FutureProviderElement(this, container); @@ -97,8 +98,9 @@ final class EvenItemsProvider ); } + @$internal @override - $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart index 8d5d68959..4baf88906 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -44,8 +44,9 @@ final class DiceRollProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -103,8 +104,9 @@ final class CachedDiceRollProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/from_provider/motivation/combine/combine.g.dart b/website/docs/from_provider/motivation/combine/combine.g.dart index a4e9e2790..ef5a1884c 100644 --- a/website/docs/from_provider/motivation/combine/combine.g.dart +++ b/website/docs/from_provider/motivation/combine/combine.g.dart @@ -44,8 +44,9 @@ final class NumberProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -102,8 +103,9 @@ final class DoubledProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/from_provider/motivation/same_type/same_type.g.dart b/website/docs/from_provider/motivation/same_type/same_type.g.dart index 4e5a7d2c4..510d91a68 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.g.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.g.dart @@ -45,8 +45,9 @@ final class ItemsProvider ); } + @$internal @override - $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -104,8 +105,9 @@ final class EvenItemsProvider ); } + @$internal @override - $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart index 4870ba625..b5f0b20f9 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart @@ -45,8 +45,9 @@ final class HelloWorldProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart index 4870ba625..b5f0b20f9 100644 --- a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -45,8 +45,9 @@ final class HelloWorldProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/introduction/getting_started/hello_world/main.g.dart b/website/docs/introduction/getting_started/hello_world/main.g.dart index 4870ba625..b5f0b20f9 100644 --- a/website/docs/introduction/getting_started/hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/main.g.dart @@ -45,8 +45,9 @@ final class HelloWorldProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index a98af4f5d..f0e4abbd9 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -54,8 +54,9 @@ final class FetchPackagesProvider extends $FunctionalProvider< '$argument'; } + @$internal @override - $FutureProviderElement> createElement( + $FutureProviderElement> $createElement( ProviderContainer container) => $FutureProviderElement(this, container); @@ -152,7 +153,7 @@ final class FetchPackagesFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart index ef339d618..e28ccbd61 100644 --- a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart +++ b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart @@ -55,7 +55,7 @@ final class MyNotifierProvider @$internal @override - $AsyncNotifierProviderElement> createElement( + $AsyncNotifierProviderElement> $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } diff --git a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart index c1562595c..032f36218 100644 --- a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart +++ b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart @@ -55,7 +55,7 @@ final class MyNotifierProvider @$internal @override - $AsyncNotifierProviderElement> createElement( + $AsyncNotifierProviderElement> $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } diff --git a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart index e69a58188..a70189d52 100644 --- a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart +++ b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart @@ -55,7 +55,7 @@ final class MyNotifierProvider @$internal @override - $AsyncNotifierProviderElement> createElement( + $AsyncNotifierProviderElement> $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } diff --git a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart index 42e402af9..9f4c200ed 100644 --- a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart +++ b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -62,7 +62,7 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart index 60a2d5a08..0fd4946cb 100644 --- a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart +++ b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -55,7 +55,7 @@ final class AsyncTodosNotifierProvider @$internal @override - $AsyncNotifierProviderElement> createElement( + $AsyncNotifierProviderElement> $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } diff --git a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart index 2642321bd..c180fbb60 100644 --- a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart +++ b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart @@ -63,7 +63,7 @@ final class CounterNotifierProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index f88efca58..f1106863a 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -46,8 +46,9 @@ final class TaskTrackerProvider extends $FunctionalProvider< ); } + @$internal @override - $ProviderElement createElement( + $ProviderElement $createElement( ProviderContainer container) => $ProviderElement(this, container); @@ -131,7 +132,7 @@ final class BugsEncounteredNotifierProvider @$internal @override - $AsyncNotifierProviderElement createElement( + $AsyncNotifierProviderElement $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); @@ -185,7 +186,7 @@ final class BugsEncounteredNotifierFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .createElement(container); + .$createElement(container); }, ); } @@ -205,7 +206,7 @@ final class BugsEncounteredNotifierFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart index 250bb687e..94f793831 100644 --- a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart +++ b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -63,7 +63,7 @@ final class CounterNotifierProvider @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart index 4a704ffd3..fd429962e 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -62,7 +62,7 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart index 5ea0b669f..2434e3160 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -45,8 +45,9 @@ final class DurationProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -104,8 +105,9 @@ final class RepositoryProvider ); } + @$internal @override - $ProviderElement<_MyRepo> createElement(ProviderContainer container) => + $ProviderElement<_MyRepo> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -180,7 +182,7 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/providers/future_provider/config_provider/codegen.g.dart b/website/docs/providers/future_provider/config_provider/codegen.g.dart index 93f719767..f89247e93 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.g.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.g.dart @@ -41,8 +41,9 @@ final class FetchConfigurationProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$fetchConfigurationHash(); + @$internal @override - $FutureProviderElement createElement( + $FutureProviderElement $createElement( ProviderContainer container) => $FutureProviderElement(this, container); diff --git a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart index a60fc353e..2b454f4a4 100644 --- a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart @@ -72,7 +72,7 @@ final class AsyncTodosProvider @$internal @override - $AsyncNotifierProviderElement> createElement( + $AsyncNotifierProviderElement> $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } diff --git a/website/docs/providers/notifier_provider/todos/codegen.g.dart b/website/docs/providers/notifier_provider/todos/codegen.g.dart index 39133c828..5ce1c142a 100644 --- a/website/docs/providers/notifier_provider/todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/todos/codegen.g.dart @@ -62,7 +62,7 @@ final class TodosProvider extends $NotifierProvider> { @$internal @override - $NotifierProviderElement> createElement( + $NotifierProviderElement> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/providers/provider/completed_todos/completed_todos.g.dart b/website/docs/providers/provider/completed_todos/completed_todos.g.dart index 20298ab4d..bf4ddc691 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.g.dart @@ -45,8 +45,9 @@ final class CompletedTodosProvider ); } + @$internal @override - $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index 9ce4d750a..17a4c444f 100644 --- a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -45,8 +45,9 @@ final class CanGoToPreviousPageProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -122,7 +123,7 @@ final class PageIndexProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/providers/provider/todo/todo.g.dart b/website/docs/providers/provider/todo/todo.g.dart index 9d32d9ce3..7a6997e3e 100644 --- a/website/docs/providers/provider/todo/todo.g.dart +++ b/website/docs/providers/provider/todo/todo.g.dart @@ -62,7 +62,7 @@ final class TodosProvider extends $NotifierProvider> { @$internal @override - $NotifierProviderElement> createElement( + $NotifierProviderElement> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart index ce25f1881..1ce41d761 100644 --- a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart +++ b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -62,7 +62,7 @@ final class PageIndexProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart index a8417e609..2ceb077d7 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -37,8 +37,9 @@ final class ChatProvider extends $FunctionalProvider>, @override String debugGetCreateSourceHash() => _$chatHash(); + @$internal @override - $StreamProviderElement> createElement( + $StreamProviderElement> $createElement( ProviderContainer container) => $StreamProviderElement(this, container); diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 646d4ba60..41f67d339 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -46,8 +46,9 @@ final class FetchUserProvider '($argument)'; } + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -125,7 +126,7 @@ final class FetchUserFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index 4870ba625..b5f0b20f9 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -45,8 +45,9 @@ final class HelloWorldProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index 4870ba625..b5f0b20f9 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -45,8 +45,9 @@ final class HelloWorldProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart index a60fc353e..2b454f4a4 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart @@ -72,7 +72,7 @@ final class AsyncTodosProvider @$internal @override - $AsyncNotifierProviderElement> createElement( + $AsyncNotifierProviderElement> $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart index 39133c828..5ce1c142a 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart @@ -62,7 +62,7 @@ final class TodosProvider extends $NotifierProvider> { @$internal @override - $NotifierProviderElement> createElement( + $NotifierProviderElement> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 646d4ba60..41f67d339 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -46,8 +46,9 @@ final class FetchUserProvider '($argument)'; } + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -125,7 +126,7 @@ final class FetchUserFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index 4870ba625..b5f0b20f9 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -45,8 +45,9 @@ final class HelloWorldProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index 4870ba625..b5f0b20f9 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -45,8 +45,9 @@ final class HelloWorldProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 646d4ba60..41f67d339 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -46,8 +46,9 @@ final class FetchUserProvider '($argument)'; } + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -125,7 +126,7 @@ final class FetchUserFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index 4870ba625..b5f0b20f9 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -45,8 +45,9 @@ final class HelloWorldProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index 4870ba625..b5f0b20f9 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -45,8 +45,9 @@ final class HelloWorldProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart index 93f719767..f89247e93 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart @@ -41,8 +41,9 @@ final class FetchConfigurationProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$fetchConfigurationHash(); + @$internal @override - $FutureProviderElement createElement( + $FutureProviderElement $createElement( ProviderContainer container) => $FutureProviderElement(this, container); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart index 646d4ba60..41f67d339 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart @@ -46,8 +46,9 @@ final class FetchUserProvider '($argument)'; } + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override @@ -125,7 +126,7 @@ final class FetchUserFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .createElement(container); + .$createElement(container); }, ); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart index ee97df1b7..19c4e564b 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart @@ -37,8 +37,9 @@ final class ExampleProvider @override String debugGetCreateSourceHash() => _$exampleHash(); + @$internal @override - $StreamProviderElement createElement(ProviderContainer container) => + $StreamProviderElement $createElement(ProviderContainer container) => $StreamProviderElement(this, container); @override diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart index 94660bb89..be9934548 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart @@ -45,8 +45,9 @@ final class RepositoryProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -121,7 +122,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart index f67a22f9e..4a50c5ca5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart @@ -44,8 +44,9 @@ final class AnotherProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart index cdc8bea0e..105a6133f 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart @@ -62,7 +62,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart index 0d25dbdcc..d27f8eaca 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart @@ -45,8 +45,9 @@ final class RepositoryProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -103,8 +104,9 @@ final class ValueProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart index dc0a6828f..9b6f2d253 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart @@ -62,7 +62,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart index dc0a6828f..9b6f2d253 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart @@ -62,7 +62,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart index dc0a6828f..9b6f2d253 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart @@ -62,7 +62,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart index 585133263..5188a21eb 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart @@ -45,8 +45,9 @@ final class FilterTypeProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -104,8 +105,9 @@ final class FilteredTodoListProvider ); } + @$internal @override - $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -180,7 +182,7 @@ final class TodosProvider extends $NotifierProvider> { @$internal @override - $NotifierProviderElement> createElement( + $NotifierProviderElement> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart index 571be96d3..a977df7b6 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart @@ -44,8 +44,9 @@ final class CounterProvider extends $FunctionalProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -120,7 +121,7 @@ final class TodoListProvider extends $NotifierProvider> { @$internal @override - $NotifierProviderElement> createElement( + $NotifierProviderElement> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart index dc0a6828f..9b6f2d253 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart @@ -62,7 +62,7 @@ final class CounterProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart index 4870ba625..b5f0b20f9 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart @@ -45,8 +45,9 @@ final class HelloWorldProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart index 4870ba625..b5f0b20f9 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart @@ -45,8 +45,9 @@ final class HelloWorldProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart index de3607b66..8d9c21ac5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart @@ -45,8 +45,9 @@ final class HelloWorldProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart index 93f719767..f89247e93 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart @@ -41,8 +41,9 @@ final class FetchConfigurationProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$fetchConfigurationHash(); + @$internal @override - $FutureProviderElement createElement( + $FutureProviderElement $createElement( ProviderContainer container) => $FutureProviderElement(this, container); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart index a60fc353e..2b454f4a4 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart @@ -72,7 +72,7 @@ final class AsyncTodosProvider @$internal @override - $AsyncNotifierProviderElement> createElement( + $AsyncNotifierProviderElement> $createElement( ProviderContainer container) => $AsyncNotifierProviderElement(this, container); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart index 39133c828..5ce1c142a 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart @@ -62,7 +62,7 @@ final class TodosProvider extends $NotifierProvider> { @$internal @override - $NotifierProviderElement> createElement( + $NotifierProviderElement> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart index 20298ab4d..bf4ddc691 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart @@ -45,8 +45,9 @@ final class CompletedTodosProvider ); } + @$internal @override - $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index 9ce4d750a..17a4c444f 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -45,8 +45,9 @@ final class CanGoToPreviousPageProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -122,7 +123,7 @@ final class PageIndexProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart index 9d32d9ce3..7a6997e3e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart @@ -62,7 +62,7 @@ final class TodosProvider extends $NotifierProvider> { @$internal @override - $NotifierProviderElement> createElement( + $NotifierProviderElement> $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart index ce25f1881..1ce41d761 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -62,7 +62,7 @@ final class PageIndexProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } diff --git a/website/static/snippets/async.g.dart b/website/static/snippets/async.g.dart index f0124f872..4032370b4 100644 --- a/website/static/snippets/async.g.dart +++ b/website/static/snippets/async.g.dart @@ -39,8 +39,9 @@ final class ConfigurationsProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$configurationsHash(); + @$internal @override - $FutureProviderElement createElement( + $FutureProviderElement $createElement( ProviderContainer container) => $FutureProviderElement(this, container); diff --git a/website/static/snippets/combine.g.dart b/website/static/snippets/combine.g.dart index 63e0d6350..da4574208 100644 --- a/website/static/snippets/combine.g.dart +++ b/website/static/snippets/combine.g.dart @@ -45,8 +45,9 @@ final class TodosProvider ); } + @$internal @override - $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -104,8 +105,9 @@ final class FilterProvider ); } + @$internal @override - $ProviderElement createElement(ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override @@ -163,8 +165,9 @@ final class FilteredTodosProvider ); } + @$internal @override - $ProviderElement> createElement(ProviderContainer container) => + $ProviderElement> $createElement(ProviderContainer container) => $ProviderElement(this, container); @override diff --git a/website/static/snippets/create.g.dart b/website/static/snippets/create.g.dart index d58210c28..5b8136d21 100644 --- a/website/static/snippets/create.g.dart +++ b/website/static/snippets/create.g.dart @@ -37,8 +37,9 @@ final class BoredSuggestionProvider extends $FunctionalProvider< @override String debugGetCreateSourceHash() => _$boredSuggestionHash(); + @$internal @override - $FutureProviderElement createElement(ProviderContainer container) => + $FutureProviderElement $createElement(ProviderContainer container) => $FutureProviderElement(this, container); @override diff --git a/website/static/snippets/declare.g.dart b/website/static/snippets/declare.g.dart index 5cc275e32..55408db8d 100644 --- a/website/static/snippets/declare.g.dart +++ b/website/static/snippets/declare.g.dart @@ -62,7 +62,7 @@ final class CountProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } From 963016aea77ff02546cb96996ab2e90f8e7b39b3 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 15:17:27 +0100 Subject: [PATCH 200/387] Document private APIs --- packages/riverpod/lib/src/core/override.dart | 2 +- packages/riverpod/lib/src/core/override_with_value.dart | 2 ++ .../riverpod/lib/src/core/provider/functional_provider.dart | 3 +++ .../riverpod/lib/src/core/provider/notifier_provider.dart | 1 + packages/riverpod/lib/src/core/provider_container.dart | 5 ++++- .../riverpod/lib/src/providers/legacy/state_provider.dart | 3 +++ 6 files changed, 14 insertions(+), 2 deletions(-) diff --git a/packages/riverpod/lib/src/core/override.dart b/packages/riverpod/lib/src/core/override.dart index 883fcc28a..f5db29119 100644 --- a/packages/riverpod/lib/src/core/override.dart +++ b/packages/riverpod/lib/src/core/override.dart @@ -106,7 +106,7 @@ abstract class $FamilyOverride implements _FamilyOverride { /// The family that was overridden. Family get from; - /// The overridden [ProviderBase.createElement]. + /// The overridden [ProviderBase.$createElement]. ProviderElementBase createElement( ProviderContainer container, ProviderBase provider, diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index c9629aa88..e7e2c186d 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -24,7 +24,9 @@ final class $ValueProvider extends ProviderBase @override Set? get allTransitiveDependencies => null; + @internal @override + // ignore: library_private_types_in_public_api, not public API _ValueProviderElement $createElement(ProviderContainer container) { return _ValueProviderElement(this, container); } diff --git a/packages/riverpod/lib/src/core/provider/functional_provider.dart b/packages/riverpod/lib/src/core/provider/functional_provider.dart index 7eec88140..4564dc36e 100644 --- a/packages/riverpod/lib/src/core/provider/functional_provider.dart +++ b/packages/riverpod/lib/src/core/provider/functional_provider.dart @@ -18,6 +18,9 @@ abstract base class $FunctionalProvider< // required super.isAutoDispose, }); + /// Clone a provider with a different initialization method. + /// + /// This is an implementation detail of Riverpod and should not be used. @visibleForOverriding $FunctionalProvider $copyWithCreate( Create create, diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index 4f453dff7..f30cce02a 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -22,6 +22,7 @@ This means that you tried to either: to abort any pending logic that could try to use `ref/state`. '''; +/// The prototype of `Notifier.build` overrides. @internal typedef RunNotifierBuild< // NotifierT, diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 17372ae44..a60876fe5 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -30,6 +30,7 @@ class ProviderPointer implements _PointerBase { /// If non-null, this pointer should **never** be removed. /// /// This override may be implicitly created by [ProviderOrFamily.allTransitiveDependencies]. + // ignore: library_private_types_in_public_api, not public API _ProviderOverride? providerOverride; ProviderElementBase? element; @override @@ -108,12 +109,14 @@ class ProviderDirectory implements _PointerBase { /// If non-null, this pointer should **never** be removed. /// /// This override may be implicitly created by [ProviderOrFamily.allTransitiveDependencies]. + // ignore: library_private_types_in_public_api, not public API _FamilyOverride? familyOverride; final HashMap, ProviderPointer> pointers; @override ProviderContainer targetContainer; void addProviderOverride( + // ignore: library_private_types_in_public_api, not public API _ProviderOverride override, { required ProviderContainer targetContainer, }) { @@ -129,7 +132,7 @@ class ProviderDirectory implements _PointerBase { ProviderBase provider, { required ProviderContainer currentContainer, }) { - // TODO changelog that provider which don't specify depencies can't be scoped + // TODO changelog that provider which don't specify dependencies can't be scoped // TODO throw if a provider is overridden but does not specify dependencies return pointers._upsert( diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 77d78a05f..93bcee12c 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -24,6 +24,7 @@ abstract class StateProviderRef implements Ref { StateController get controller; } +/// {@template riverpod.state_provider} /// A provider that exposes a value that can be modified from outside. /// /// It can be useful for very simple states, like a filter or the currently @@ -55,9 +56,11 @@ abstract class StateProviderRef implements Ref { /// ); /// } /// ``` +/// {@endtemplate} final class StateProvider extends $FunctionalProvider> with LegacyProviderMixin { + /// {@macro riverpod.state_provider} StateProvider( this._createFn, { super.name, From dfef923dc58256c7a795a38e1ad11750239d7e16 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 15:21:55 +0100 Subject: [PATCH 201/387] Add some lints --- all_lint_rules.yaml | 2 ++ analysis_options.yaml | 6 ------ packages/riverpod/analysis_options.yaml | 5 +++++ 3 files changed, 7 insertions(+), 6 deletions(-) create mode 100644 packages/riverpod/analysis_options.yaml diff --git a/all_lint_rules.yaml b/all_lint_rules.yaml index fb224fcbd..49d1bb67f 100644 --- a/all_lint_rules.yaml +++ b/all_lint_rules.yaml @@ -7,6 +7,7 @@ linter: - always_specify_types - always_use_package_imports - annotate_overrides + - annotate_redeclares - avoid_annotating_with_dynamic - avoid_bool_literals_in_conditional_expressions - avoid_catches_without_on_clauses @@ -44,6 +45,7 @@ linter: - avoid_types_as_parameter_names - avoid_types_on_closure_parameters - avoid_unnecessary_containers + - avoid_unstable_final_fields - avoid_unused_constructor_parameters - avoid_void_async - avoid_web_libraries_in_flutter diff --git a/analysis_options.yaml b/analysis_options.yaml index c24ef9e35..60d9c6488 100644 --- a/analysis_options.yaml +++ b/analysis_options.yaml @@ -22,9 +22,6 @@ linter: # Low value and lacks a quick fix combinators_ordering: false - - # Low value and high cost to change on all files - eol_at_end_of_file: false # Conflicts with unused variables no_leading_underscores_for_local_identifiers: false @@ -84,6 +81,3 @@ linter: # conflicts with `prefer_relative_imports` always_use_package_imports: false - - # Disabled for now until we have NNBD as it otherwise conflicts with `missing_return` - no_default_cases: false diff --git a/packages/riverpod/analysis_options.yaml b/packages/riverpod/analysis_options.yaml new file mode 100644 index 000000000..f82ccf8e2 --- /dev/null +++ b/packages/riverpod/analysis_options.yaml @@ -0,0 +1,5 @@ +include: ../../analysis_options.yaml +linter: + rules: + ## temporary disable the public_member_api_docs rule + public_member_api_docs: false \ No newline at end of file From 4acf48d0c6894bf2ecdde4df58512ebb0bfdc50c Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 15:27:16 +0100 Subject: [PATCH 202/387] Add some newlines --- .../lib/flutter_riverpod.dart | 2 +- .../select_async_provider/raw.dart | 5 ++-- .../lifecycle_on_dispose/codegen.dart | 1 - .../declaring_many_providers/codegen.dart | 1 - .../declaring_many_providers/raw.dart | 2 +- website/docs/cookbooks/testing_full.dart | 30 ++++++++++--------- .../async_consumer_example.dart | 1 - .../consumer_example.dart | 1 - .../side_effects/raw/render_add_todo.dart | 2 +- .../raw/render_add_todo_hooks.dart | 2 +- .../stream_provider/codegen.dart | 2 +- .../websockets_sync/stream_provider/raw.dart | 2 +- .../sync_definition/codegen.dart | 2 +- .../websockets_sync/sync_definition/raw.dart | 2 +- .../todos_consumer.dart | 5 ++-- .../sorted_product_provider.dart | 2 +- .../sorted_product_provider.dart | 2 +- .../sorted_product_provider.dart | 2 +- .../sorted_product_provider.dart | 2 +- .../state_provider/update_read_once.dart | 2 +- .../reading_consumer_hook_widget.dart | 2 +- .../reading_consumer_stateful_widget.dart | 2 +- .../current/concepts/reading_listen.dart | 2 +- .../concepts/reading_listen_build.dart | 4 +-- .../current/concepts/reading_read.dart | 2 +- .../current/concepts/reading_read_build.dart | 2 +- .../concepts/reading_read_notifier_build.dart | 2 +- ...reading_stateful_hook_consumer_widget.dart | 2 +- .../current/concepts/reading_watch.dart | 7 +++-- .../current/concepts/reading_watch_build.dart | 4 +-- .../provider/optimized_previous_button.dart | 2 +- .../provider/unoptimized_previous_button.dart | 2 +- .../state_notifier_provider/todos.dart | 30 +++++++++++-------- .../todos_consumer.dart | 5 ++-- .../sorted_product_provider.dart | 2 +- .../state_provider/update_read_once.dart | 2 +- .../state_provider/update_read_twice.dart | 7 +++-- .../current/concepts/reading_listen.dart | 2 +- .../concepts/reading_listen_build.dart | 4 +-- .../concepts/reading_read_notifier_build.dart | 2 +- .../concepts/reading_consumer_hook.dart | 27 ++++++++--------- .../reading_consumer_hook_widget.dart | 2 +- .../reading_consumer_stateful_widget.dart | 2 +- .../current/concepts/reading_listen.dart | 2 +- .../concepts/reading_listen_build.dart | 4 +-- .../current/concepts/reading_read.dart | 2 +- .../current/concepts/reading_read_build.dart | 2 +- .../concepts/reading_read_notifier_build.dart | 2 +- .../current/concepts/reading_watch.dart | 7 +++-- .../current/concepts/reading_watch_build.dart | 4 +-- .../current/cookbooks/testing_full.dart | 30 ++++++++++--------- .../state_notifier_provider/todos.dart | 12 +++++--- .../todos_consumer.dart | 5 ++-- .../sorted_product_provider.dart | 2 +- .../state_provider/update_read_once.dart | 2 +- .../state_provider/update_read_twice.dart | 5 ++-- .../current/concepts/reading_listen.dart | 2 +- .../concepts/reading_listen_build.dart | 4 +-- .../concepts/reading_read_notifier_build.dart | 2 +- .../config_consumer/hooks_codegen.dart | 19 ++++++------ .../state_notifier_provider/todos.dart | 10 +++++-- .../todos_consumer.dart | 5 ++-- .../sorted_product_provider.dart | 2 +- .../state_provider/update_read_once.dart | 2 +- .../state_provider/update_read_twice.dart | 5 ++-- .../concepts/reading_consumer_hook.dart | 27 ++++++++--------- .../reading_consumer_hook_widget.dart | 2 +- .../reading_consumer_stateful_widget.dart | 4 +-- .../current/concepts/reading_listen.dart | 2 +- .../concepts/reading_listen_build.dart | 4 +-- .../current/concepts/reading_read.dart | 2 +- .../current/concepts/reading_read_build.dart | 2 +- .../concepts/reading_read_notifier_build.dart | 2 +- .../current/concepts/reading_watch.dart | 7 +++-- .../current/concepts/reading_watch_build.dart | 4 +-- .../current/cookbooks/testing_full.dart | 30 ++++++++++--------- .../provider/optimized_previous_button.dart | 4 +-- .../provider/unoptimized_previous_button.dart | 2 +- .../state_notifier_provider/todos.dart | 10 +++++-- .../todos_consumer.dart | 5 ++-- .../sorted_product_provider.dart | 2 +- .../state_provider/update_read_once.dart | 2 +- .../state_provider/update_read_twice.dart | 5 ++-- .../lifecycle_on_dispose/codegen.dart | 1 - .../config_consumer/hooks_codegen.dart | 19 ++++++------ .../state_notifier_provider/todos.dart | 10 +++++-- .../todos_consumer.dart | 5 ++-- .../sorted_product_provider.dart | 2 +- .../state_provider/update_read_once.dart | 2 +- .../state_provider/update_read_twice.dart | 5 ++-- 90 files changed, 255 insertions(+), 223 deletions(-) diff --git a/packages/flutter_riverpod/lib/flutter_riverpod.dart b/packages/flutter_riverpod/lib/flutter_riverpod.dart index 9f3929c79..956e6d2dc 100644 --- a/packages/flutter_riverpod/lib/flutter_riverpod.dart +++ b/packages/flutter_riverpod/lib/flutter_riverpod.dart @@ -2,4 +2,4 @@ export 'package:riverpod/riverpod.dart'; export 'src/core.dart' hide ProviderScopeState; // TODO changelog breaking: StateNotifier & co are no-longer exported from pkg:riverpod/riverpod.dart -// Use pkg:riverpod/legacy.dart \ No newline at end of file +// Use pkg:riverpod/legacy.dart diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/raw.dart b/website/docs/concepts/combining_provider_states/select_async_provider/raw.dart index ae35300b0..a5208e4e7 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/raw.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/raw.dart @@ -13,8 +13,9 @@ final configProvider = final productsProvider = FutureProvider>((ref) async { // Listens only to the host. If something else in the configurations // changes, this will not pointlessly re-evaluate our provider. - final host = await ref.watch(configProvider.selectAsync((config) => config.host)); + final host = + await ref.watch(configProvider.selectAsync((config) => config.host)); final result = await dio.get>>('$host/products'); return result.data!.map(Product.fromJson).toList(); -}); \ No newline at end of file +}); diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.dart index 0977a8087..b881d7bf9 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.dart @@ -18,4 +18,3 @@ Stream example(ExampleRef ref) { return streamController.stream; } - diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.dart index a9472e02a..474fe004b 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.dart @@ -8,4 +8,3 @@ part 'codegen.g.dart'; String city(CityRef ref) => 'London'; @riverpod String country(CountryRef ref) => 'England'; - diff --git a/website/docs/concepts/providers/declaring_many_providers/raw.dart b/website/docs/concepts/providers/declaring_many_providers/raw.dart index 60a3d4786..09d8a659f 100644 --- a/website/docs/concepts/providers/declaring_many_providers/raw.dart +++ b/website/docs/concepts/providers/declaring_many_providers/raw.dart @@ -3,4 +3,4 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; /* SNIPPET START */ final cityProvider = Provider((ref) => 'London'); -final countryProvider = Provider((ref) => 'England'); \ No newline at end of file +final countryProvider = Provider((ref) => 'England'); diff --git a/website/docs/cookbooks/testing_full.dart b/website/docs/cookbooks/testing_full.dart index 62e7bb2ef..e75b5747f 100644 --- a/website/docs/cookbooks/testing_full.dart +++ b/website/docs/cookbooks/testing_full.dart @@ -1,4 +1,3 @@ - import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_test/flutter_test.dart'; @@ -62,18 +61,21 @@ void main() { // You may extract this into a MyApp widget child: MaterialApp( home: Scaffold( - body: Consumer(builder: (context, ref, _) { - final todos = ref.watch(todoListProvider); - // The list of todos is loading or in error - if (todos.asData == null) { - return const CircularProgressIndicator(); - } - return ListView( - children: [ - for (final todo in todos.asData!.value) TodoItem(todo: todo), - ], - ); - },), + body: Consumer( + builder: (context, ref, _) { + final todos = ref.watch(todoListProvider); + // The list of todos is loading or in error + if (todos.asData == null) { + return const CircularProgressIndicator(); + } + return ListView( + children: [ + for (final todo in todos.asData!.value) + TodoItem(todo: todo), + ], + ); + }, + ), ), ), ), @@ -96,4 +98,4 @@ void main() { .having((s) => s.todo.completed, 'todo.completed', false), ]); }); -} \ No newline at end of file +} diff --git a/website/docs/essentials/eager_initialization/async_consumer_example.dart b/website/docs/essentials/eager_initialization/async_consumer_example.dart index cb634f993..38bec6826 100644 --- a/website/docs/essentials/eager_initialization/async_consumer_example.dart +++ b/website/docs/essentials/eager_initialization/async_consumer_example.dart @@ -25,4 +25,3 @@ class _EagerInitialization extends ConsumerWidget { } } /* SNIPPET END */ - diff --git a/website/docs/essentials/eager_initialization/consumer_example.dart b/website/docs/essentials/eager_initialization/consumer_example.dart index 107b6a619..718c966d3 100644 --- a/website/docs/essentials/eager_initialization/consumer_example.dart +++ b/website/docs/essentials/eager_initialization/consumer_example.dart @@ -33,4 +33,3 @@ class _EagerInitialization extends ConsumerWidget { } } /* SNIPPET END */ - diff --git a/website/docs/essentials/side_effects/raw/render_add_todo.dart b/website/docs/essentials/side_effects/raw/render_add_todo.dart index 4dafb6147..1063eaee9 100644 --- a/website/docs/essentials/side_effects/raw/render_add_todo.dart +++ b/website/docs/essentials/side_effects/raw/render_add_todo.dart @@ -75,4 +75,4 @@ class _ExampleState extends ConsumerState { ); } } -/* SNIPPET END */ \ No newline at end of file +/* SNIPPET END */ diff --git a/website/docs/essentials/side_effects/raw/render_add_todo_hooks.dart b/website/docs/essentials/side_effects/raw/render_add_todo_hooks.dart index c80e95dc2..01c6ad115 100644 --- a/website/docs/essentials/side_effects/raw/render_add_todo_hooks.dart +++ b/website/docs/essentials/side_effects/raw/render_add_todo_hooks.dart @@ -65,4 +65,4 @@ class Example extends HookConsumerWidget { ); } } -/* SNIPPET END */ \ No newline at end of file +/* SNIPPET END */ diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.dart index cb57ca0a1..214276260 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.dart @@ -31,4 +31,4 @@ class Consumer extends ConsumerWidget { }; } } -/* SNIPPET END */ \ No newline at end of file +/* SNIPPET END */ diff --git a/website/docs/essentials/websockets_sync/stream_provider/raw.dart b/website/docs/essentials/websockets_sync/stream_provider/raw.dart index c4beebb71..f3dcda2fe 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/raw.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/raw.dart @@ -27,4 +27,4 @@ class Consumer extends ConsumerWidget { }; } } -/* SNIPPET END */ \ No newline at end of file +/* SNIPPET END */ diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.dart index b18b8f76e..dbccd14aa 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.dart @@ -7,4 +7,4 @@ part 'codegen.g.dart'; int synchronousExample(SynchronousExampleRef ref) { return 0; } -/* SNIPPET END */ \ No newline at end of file +/* SNIPPET END */ diff --git a/website/docs/essentials/websockets_sync/sync_definition/raw.dart b/website/docs/essentials/websockets_sync/sync_definition/raw.dart index 9c64294a0..193c5eeff 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/raw.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/raw.dart @@ -4,4 +4,4 @@ import 'package:riverpod/riverpod.dart'; final synchronousExampleProvider = Provider.autoDispose((ref) { return 0; }); -/* SNIPPET END */ \ No newline at end of file +/* SNIPPET END */ diff --git a/website/docs/providers/state_notifier_provider/todos_consumer.dart b/website/docs/providers/state_notifier_provider/todos_consumer.dart index 8722a542f..0b60d4eaf 100644 --- a/website/docs/providers/state_notifier_provider/todos_consumer.dart +++ b/website/docs/providers/state_notifier_provider/todos_consumer.dart @@ -22,10 +22,11 @@ class TodoListView extends ConsumerWidget { CheckboxListTile( value: todo.completed, // When tapping on the todo, change its completed status - onChanged: (value) => ref.read(todosProvider.notifier).toggle(todo.id), + onChanged: (value) => + ref.read(todosProvider.notifier).toggle(todo.id), title: Text(todo.description), ), ], ); } -} \ No newline at end of file +} diff --git a/website/docs/providers/state_provider/sorted_product_provider.dart b/website/docs/providers/state_provider/sorted_product_provider.dart index 6725d0282..b74c3adf8 100644 --- a/website/docs/providers/state_provider/sorted_product_provider.dart +++ b/website/docs/providers/state_provider/sorted_product_provider.dart @@ -21,4 +21,4 @@ final productsProvider = Provider>((ref) { case ProductSortType.price: return _products.sorted((a, b) => a.price.compareTo(b.price)); } -}); \ No newline at end of file +}); diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart index 6725d0282..b74c3adf8 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart @@ -21,4 +21,4 @@ final productsProvider = Provider>((ref) { case ProductSortType.price: return _products.sorted((a, b) => a.price.compareTo(b.price)); } -}); \ No newline at end of file +}); diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart index 6725d0282..b74c3adf8 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart @@ -21,4 +21,4 @@ final productsProvider = Provider>((ref) { case ProductSortType.price: return _products.sorted((a, b) => a.price.compareTo(b.price)); } -}); \ No newline at end of file +}); diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart index 6725d0282..b74c3adf8 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart @@ -21,4 +21,4 @@ final productsProvider = Provider>((ref) { case ProductSortType.price: return _products.sorted((a, b) => a.price.compareTo(b.price)); } -}); \ No newline at end of file +}); diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index dbab3d32e..3cd8e6878 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -21,4 +21,4 @@ class HomeView extends ConsumerWidget { ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart index 194bec8dc..600c980a7 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart @@ -19,4 +19,4 @@ class HomeView extends HookConsumerWidget { final counter = ref.watch(counterProvider); return Text('$counter'); } -} \ No newline at end of file +} diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart index a685b7bac..09a1de9c6 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart @@ -25,4 +25,4 @@ class HomeViewState extends ConsumerState { final counter = ref.watch(counterProvider); return Text('$counter'); } -} \ No newline at end of file +} diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index b06e75410..4f6829a9e 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -13,4 +13,4 @@ final anotherProvider = Provider((ref) { print('The counter changed $newCount'); }); // ... -}); \ No newline at end of file +}); diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 51a41e2c6..0d94f0d08 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -18,7 +18,7 @@ class HomeView extends ConsumerWidget { ref.listen(counterProvider, (int? previousCount, int newCount) { print('The counter changed $newCount'); }); - + return Container(); } -} \ No newline at end of file +} diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index 5282ba004..7b30e6e71 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -24,4 +24,4 @@ class HomeView extends ConsumerWidget { ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart index 7b896f699..11e5fd3e3 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart @@ -15,4 +15,4 @@ Widget build(BuildContext context, WidgetRef ref) { onPressed: () => counter.state++, child: const Text('button'), ); -} \ No newline at end of file +} diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart index 39d5b6e70..95bdab6c5 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart @@ -14,4 +14,4 @@ Widget build(BuildContext context, WidgetRef ref) { onPressed: () => counter.state++, child: const Text('button'), ); -} \ No newline at end of file +} diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart index 18193caee..f57624be5 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_stateful_hook_consumer_widget.dart @@ -31,4 +31,4 @@ class HomeViewState extends ConsumerState { final counter = ref.watch(counterProvider); return Text('$counter'); } -} \ No newline at end of file +} diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart index 89140b230..cc43d617e 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart @@ -13,13 +13,14 @@ abstract class Todo { } class TodoList extends StateNotifier> { - TodoList(): super([]); + TodoList() : super([]); } /* SNIPPET START */ final filterTypeProvider = StateProvider((ref) => FilterType.none); -final todosProvider = StateNotifierProvider>((ref) => TodoList()); +final todosProvider = + StateNotifierProvider>((ref) => TodoList()); final filteredTodoListProvider = Provider((ref) { // récupère à la fois le filtre et la liste des todos @@ -34,4 +35,4 @@ final filteredTodoListProvider = Provider((ref) { // renvoie la liste non filtrée des todos return todos; } -}); \ No newline at end of file +}); diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index a4d8dfb54..894c3a364 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -14,7 +14,7 @@ abstract class Todo { } class TodoList extends StateNotifier> { - TodoList(): super([]); + TodoList() : super([]); } /* SNIPPET START */ @@ -31,4 +31,4 @@ class HomeView extends ConsumerWidget { return Text('$counter'); } -} \ No newline at end of file +} diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index 496a6a5e7..38ee03d5b 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -36,4 +36,4 @@ class PreviousButton extends ConsumerWidget { child: const Text('previous'), ); } -} \ No newline at end of file +} diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index 3ed04fbbf..d3a68541f 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -24,4 +24,4 @@ class PreviousButton extends ConsumerWidget { child: const Text('previous'), ); } -} \ No newline at end of file +} diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index dbc3246f9..744882fa8 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -8,14 +8,18 @@ import 'package:flutter_riverpod/legacy.dart'; // On peut aussi utiliser des packages comme Freezed pour aider à la mise en œuvre. @immutable class Todo { - const Todo({required this.id, required this.description, required this.completed}); + const Todo({ + required this.id, + required this.description, + required this.completed, + }); // Toutes les propriétés doivent être `finales` sur notre classe. final String id; final String description; final bool completed; - // Puisque Todo est immuable, on implémente une méthode qui permet de cloner le Todo + // Puisque Todo est immuable, on implémente une méthode qui permet de cloner le Todo // avec un contenu légèrement différent. Todo copyWith({String? id, String? description, bool? completed}) { return Todo( @@ -26,29 +30,29 @@ class Todo { } } -// La classe StateNotifier qui sera transmise à notre StateNotifierProvider. -// Cette classe ne doit pas exposer d'état (state) en dehors de sa propriété "state", +// La classe StateNotifier qui sera transmise à notre StateNotifierProvider. +// Cette classe ne doit pas exposer d'état (state) en dehors de sa propriété "state", // ce qui signifie que pas de public getteurs/properietés! -// Les méthodes publiques de cette classe seront celles qui permettront à l'interface +// Les méthodes publiques de cette classe seront celles qui permettront à l'interface // utilisateur de modifier l'état (state). class TodosNotifier extends StateNotifier> { // On initialise la liste des todos à une liste vide. - TodosNotifier(): super([]); + TodosNotifier() : super([]); // Permettre à l'interface utilisateur d'ajouter des todos. void addTodo(Todo todo) { // Comme notre état est immuable, nous n'avons pas le droit de faire `state.add(todo)`. - // Au lieu de cela, on doit créer une nouvelle liste de tâches qui contient + // Au lieu de cela, on doit créer une nouvelle liste de tâches qui contient // les éléments précédents et le nouveau. // L'utilisation de spread de Dart est utile ici ! state = [...state, todo]; - // Il n'est pas nécessaire d'appeler "notifyListeners" ou quelque chose de similaire. + // Il n'est pas nécessaire d'appeler "notifyListeners" ou quelque chose de similaire. // L'appel à "state =" reconstruira automatiquement l'interface utilisateur si nécessaire. } // Autorisation de supprimer les todos void removeTodo(String todoId) { - // Encore une fois, notre état est immuable. + // Encore une fois, notre état est immuable. // Donc on crée une nouvelle liste au lieu de changer la liste existante. state = [ for (final todo in state) @@ -62,8 +66,8 @@ class TodosNotifier extends StateNotifier> { for (final todo in state) // on marque seulement le todo correspondant comme terminé if (todo.id == todoId) - // Encore une fois, puisque notre état est immuable, - // nous devons faire une copie du todo. Nous utilisons la méthode `copyWith` + // Encore une fois, puisque notre état est immuable, + // nous devons faire une copie du todo. Nous utilisons la méthode `copyWith` // implémentée précédemment pour y parvenir. todo.copyWith(completed: !todo.completed) else @@ -73,8 +77,8 @@ class TodosNotifier extends StateNotifier> { } } -// Enfin, on utilise le StateNotifierProvider pour permettre à l'interface utilisateur +// Enfin, on utilise le StateNotifierProvider pour permettre à l'interface utilisateur // d'interagir avec notre classe TodosNotifier. final todosProvider = StateNotifierProvider>((ref) { return TodosNotifier(); -}); \ No newline at end of file +}); diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index 016ba782b..c3c0d8fd3 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -22,10 +22,11 @@ class TodoListView extends ConsumerWidget { CheckboxListTile( value: todo.completed, // En appuyant sur le todo, on modifie son état d'achèvement. - onChanged: (value) => ref.read(todosProvider.notifier).toggle(todo.id), + onChanged: (value) => + ref.read(todosProvider.notifier).toggle(todo.id), title: Text(todo.description), ), ], ); } -} \ No newline at end of file +} diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart index 6725d0282..b74c3adf8 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart @@ -21,4 +21,4 @@ final productsProvider = Provider>((ref) { case ProductSortType.price: return _products.sorted((a, b) => a.price.compareTo(b.price)); } -}); \ No newline at end of file +}); diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index dbab3d32e..3cd8e6878 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -21,4 +21,4 @@ class HomeView extends ConsumerWidget { ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index 4a039a7ef..246eec6c3 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -14,11 +14,12 @@ class HomeView extends ConsumerWidget { return Scaffold( floatingActionButton: FloatingActionButton( onPressed: () { - // On et à jour l'état à partir de la valeur précédente, + // On et à jour l'état à partir de la valeur précédente, // on fini par lire le provider deux fois ! - ref.read(counterProvider.notifier).state = ref.read(counterProvider.notifier).state + 1; + ref.read(counterProvider.notifier).state = + ref.read(counterProvider.notifier).state + 1; }, ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index b06e75410..4f6829a9e 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -13,4 +13,4 @@ final anotherProvider = Provider((ref) { print('The counter changed $newCount'); }); // ... -}); \ No newline at end of file +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 51a41e2c6..0d94f0d08 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -18,7 +18,7 @@ class HomeView extends ConsumerWidget { ref.listen(counterProvider, (int? previousCount, int newCount) { print('The counter changed $newCount'); }); - + return Container(); } -} \ No newline at end of file +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart index 39d5b6e70..95bdab6c5 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart @@ -14,4 +14,4 @@ Widget build(BuildContext context, WidgetRef ref) { onPressed: () => counter.state++, child: const Text('button'), ); -} \ No newline at end of file +} diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart index fe3d6ac4f..6cfa75273 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart @@ -5,26 +5,25 @@ import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'reading_counter.dart'; - class HomeView extends HookConsumerWidget { const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { -return + return /* SNIPPET START */ -Scaffold( - body: HookConsumer( - builder: (context, ref, child) { - // HookConsumerWidget と同様にフックが使えます。 - final state = useState(0); + Scaffold( + body: HookConsumer( + builder: (context, ref, child) { + // HookConsumerWidget と同様にフックが使えます。 + final state = useState(0); - // `ref` オブジェクトを使ってプロバイダを監視することもできます。 - final counter = ref.watch(counterProvider); - return Text('$counter'); - }, - ), -); + // `ref` オブジェクトを使ってプロバイダを監視することもできます。 + final counter = ref.watch(counterProvider); + return Text('$counter'); + }, + ), + ); /* SNIPPET END */ } -} \ No newline at end of file +} diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart index 0668b2510..8fd206890 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart @@ -19,4 +19,4 @@ class HomeView extends HookConsumerWidget { final counter = ref.watch(counterProvider); return Text('$counter'); } -} \ No newline at end of file +} diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart index 8fd00f4d8..ab7d1bad4 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart @@ -25,4 +25,4 @@ class HomeViewState extends ConsumerState { final counter = ref.watch(counterProvider); return Text('$counter'); } -} \ No newline at end of file +} diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index b06e75410..4f6829a9e 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -13,4 +13,4 @@ final anotherProvider = Provider((ref) { print('The counter changed $newCount'); }); // ... -}); \ No newline at end of file +}); diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 51a41e2c6..0d94f0d08 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -18,7 +18,7 @@ class HomeView extends ConsumerWidget { ref.listen(counterProvider, (int? previousCount, int newCount) { print('The counter changed $newCount'); }); - + return Container(); } -} \ No newline at end of file +} diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index 946a555e1..9f9e05797 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -24,4 +24,4 @@ class HomeView extends ConsumerWidget { ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart index 0b00ae81b..3bbcdb884 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart @@ -15,4 +15,4 @@ Widget build(BuildContext context, WidgetRef ref) { onPressed: () => counter.state++, child: const Text('button'), ); -} \ No newline at end of file +} diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart index 39d5b6e70..95bdab6c5 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart @@ -14,4 +14,4 @@ Widget build(BuildContext context, WidgetRef ref) { onPressed: () => counter.state++, child: const Text('button'), ); -} \ No newline at end of file +} diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart index c5f778f4f..d436ec8db 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart @@ -13,13 +13,14 @@ abstract class Todo { } class TodoList extends StateNotifier> { - TodoList(): super([]); + TodoList() : super([]); } /* SNIPPET START */ final filterTypeProvider = StateProvider((ref) => FilterType.none); -final todosProvider = StateNotifierProvider>((ref) => TodoList()); +final todosProvider = + StateNotifierProvider>((ref) => TodoList()); final filteredTodoListProvider = Provider((ref) { // フィルタの種類と Todo リストを取得、監視する @@ -34,4 +35,4 @@ final filteredTodoListProvider = Provider((ref) { // フィルタ未適用の Todo リストをそのまま返す return todos; } -}); \ No newline at end of file +}); diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index b72c8defb..85c00dafc 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -14,7 +14,7 @@ abstract class Todo { } class TodoList extends StateNotifier> { - TodoList(): super([]); + TodoList() : super([]); } /* SNIPPET START */ @@ -31,4 +31,4 @@ class HomeView extends ConsumerWidget { return Text('$counter'); } -} \ No newline at end of file +} diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index 4c1dd783c..31fd81da5 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -1,4 +1,3 @@ - import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_test/flutter_test.dart'; @@ -62,18 +61,21 @@ void main() { // 以下を抽出して MyApp ウィジェットとしても可 child: MaterialApp( home: Scaffold( - body: Consumer(builder: (context, ref, _) { - final todos = ref.watch(todoListProvider); - // Todo リストのステートが loading か error の場合 - if (todos.asData == null) { - return const CircularProgressIndicator(); - } - return ListView( - children: [ - for (final todo in todos.asData!.value) TodoItem(todo: todo), - ], - ); - },), + body: Consumer( + builder: (context, ref, _) { + final todos = ref.watch(todoListProvider); + // Todo リストのステートが loading か error の場合 + if (todos.asData == null) { + return const CircularProgressIndicator(); + } + return ListView( + children: [ + for (final todo in todos.asData!.value) + TodoItem(todo: todo), + ], + ); + }, + ), ), ), ), @@ -96,4 +98,4 @@ void main() { .having((s) => s.todo.completed, 'todo.completed', false), ]); }); -} \ No newline at end of file +} diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 1bc97b848..991bc53d1 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -8,7 +8,11 @@ import 'package:flutter_riverpod/legacy.dart'; // ここは Freezed のようなパッケージを利用してイミュータブルにしても OK です。 @immutable class Todo { - const Todo({required this.id, required this.description, required this.completed}); + const Todo({ + required this.id, + required this.description, + required this.completed, + }); // イミュータブルなクラスのプロパティはすべて `final` にする必要があります。 final String id; @@ -32,7 +36,7 @@ class Todo { // public メソッドを通じて UI 側にステートの操作を許可します。 class TodosNotifier extends StateNotifier> { // Todo リストを空のリストとして初期化します。 - TodosNotifier(): super([]); + TodosNotifier() : super([]); // Todo の追加 void addTodo(Todo todo) { @@ -47,7 +51,7 @@ class TodosNotifier extends StateNotifier> { // Todo の削除 void removeTodo(String todoId) { - // しつこいですが、ステートはイミュータブルです。 + // しつこいですが、ステートはイミュータブルです。 // そのため既存リストを変更するのではなく、新しくリストを作成する必要があります。 state = [ for (final todo in state) @@ -76,4 +80,4 @@ class TodosNotifier extends StateNotifier> { // UI 側から Todo リストを操作することを可能にします。 final todosProvider = StateNotifierProvider>((ref) { return TodosNotifier(); -}); \ No newline at end of file +}); diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index f1e5a74a0..89a74e8a3 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -22,10 +22,11 @@ class TodoListView extends ConsumerWidget { CheckboxListTile( value: todo.completed, // 各 Todo をタップすると、完了ステータスを変更できる - onChanged: (value) => ref.read(todosProvider.notifier).toggle(todo.id), + onChanged: (value) => + ref.read(todosProvider.notifier).toggle(todo.id), title: Text(todo.description), ), ], ); } -} \ No newline at end of file +} diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart index 6725d0282..b74c3adf8 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart @@ -21,4 +21,4 @@ final productsProvider = Provider>((ref) { case ProductSortType.price: return _products.sorted((a, b) => a.price.compareTo(b.price)); } -}); \ No newline at end of file +}); diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index dbab3d32e..3cd8e6878 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -21,4 +21,4 @@ class HomeView extends ConsumerWidget { ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index c652e490d..de9e5a7a8 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -16,9 +16,10 @@ class HomeView extends ConsumerWidget { onPressed: () { // 直近のステートから新たなステートを算出しようとすると、 // このようにプロバイダを2回利用してしまいがち。 - ref.read(counterProvider.notifier).state = ref.read(counterProvider.notifier).state + 1; + ref.read(counterProvider.notifier).state = + ref.read(counterProvider.notifier).state + 1; }, ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index b06e75410..4f6829a9e 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -13,4 +13,4 @@ final anotherProvider = Provider((ref) { print('The counter changed $newCount'); }); // ... -}); \ No newline at end of file +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 51a41e2c6..0d94f0d08 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -18,7 +18,7 @@ class HomeView extends ConsumerWidget { ref.listen(counterProvider, (int? previousCount, int newCount) { print('The counter changed $newCount'); }); - + return Container(); } -} \ No newline at end of file +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart index 39d5b6e70..95bdab6c5 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart @@ -14,4 +14,4 @@ Widget build(BuildContext context, WidgetRef ref) { onPressed: () => counter.state++, child: const Text('button'), ); -} \ No newline at end of file +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart index 6b2cccbd6..9190e55be 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart @@ -3,11 +3,9 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import '../config_provider/codegen.dart'; - - /* SNIPPET START */ -class MyConfiguration extends HookConsumerWidget { +class MyConfiguration extends HookConsumerWidget { const MyConfiguration({super.key}); @override @@ -15,11 +13,12 @@ class MyConfiguration extends HookConsumerWidget { final config = ref.watch(fetchConfigurationProvider); return Scaffold( body: config.when( - loading: () => const Center(child: CircularProgressIndicator()), - error: (err, stack) => Center(child: Text('Error: $err')), - data: (config) { - return Center(child: Text(config.host)); - }, - ),); + loading: () => const Center(child: CircularProgressIndicator()), + error: (err, stack) => Center(child: Text('Error: $err')), + data: (config) { + return Center(child: Text(config.host)); + }, + ), + ); } -} \ No newline at end of file +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 13049bd42..f9484516e 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -8,7 +8,11 @@ import 'package:flutter_riverpod/legacy.dart'; // We could also use packages like Freezed to help with the implementation. @immutable class Todo { - const Todo({required this.id, required this.description, required this.completed}); + const Todo({ + required this.id, + required this.description, + required this.completed, + }); // All properties should be `final` on our class. final String id; @@ -32,7 +36,7 @@ class Todo { // The public methods on this class will be what allow the UI to modify the state. class TodosNotifier extends StateNotifier> { // We initialize the list of todos to an empty list - TodosNotifier(): super([]); + TodosNotifier() : super([]); // Let's allow the UI to add todos. void addTodo(Todo todo) { @@ -76,4 +80,4 @@ class TodosNotifier extends StateNotifier> { // our TodosNotifier class. final todosProvider = StateNotifierProvider>((ref) { return TodosNotifier(); -}); \ No newline at end of file +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index 8722a542f..0b60d4eaf 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -22,10 +22,11 @@ class TodoListView extends ConsumerWidget { CheckboxListTile( value: todo.completed, // When tapping on the todo, change its completed status - onChanged: (value) => ref.read(todosProvider.notifier).toggle(todo.id), + onChanged: (value) => + ref.read(todosProvider.notifier).toggle(todo.id), title: Text(todo.description), ), ], ); } -} \ No newline at end of file +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart index 6725d0282..b74c3adf8 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart @@ -21,4 +21,4 @@ final productsProvider = Provider>((ref) { case ProductSortType.price: return _products.sorted((a, b) => a.price.compareTo(b.price)); } -}); \ No newline at end of file +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index dbab3d32e..3cd8e6878 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -21,4 +21,4 @@ class HomeView extends ConsumerWidget { ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index 172721f1a..58f866fc9 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -16,9 +16,10 @@ class HomeView extends ConsumerWidget { onPressed: () { // We're updating the state from the previous value, we ended-up reading // the provider twice! - ref.read(counterProvider.notifier).state = ref.read(counterProvider.notifier).state + 1; + ref.read(counterProvider.notifier).state = + ref.read(counterProvider.notifier).state + 1; }, ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart index ac6d3ef63..f5ae7e0de 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart @@ -5,26 +5,25 @@ import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'reading_counter.dart'; - class HomeView extends HookConsumerWidget { const HomeView({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { -return + return /* SNIPPET START */ -Scaffold( - body: HookConsumer( - builder: (context, ref, child) { - // Мы можем использовать хуки внутри builder, как и в HookConsumerWidget - final state = useState(0); + Scaffold( + body: HookConsumer( + builder: (context, ref, child) { + // Мы можем использовать хуки внутри builder, как и в HookConsumerWidget + final state = useState(0); - // Также мы можем использовать ref для прослушивания провайдеров. - final counter = ref.watch(counterProvider); - return Text('$counter'); - }, - ), -); + // Также мы можем использовать ref для прослушивания провайдеров. + final counter = ref.watch(counterProvider); + return Text('$counter'); + }, + ), + ); /* SNIPPET END */ } -} \ No newline at end of file +} diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart index 69b5c71ce..7e4065128 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart @@ -19,4 +19,4 @@ class HomeView extends HookConsumerWidget { final counter = ref.watch(counterProvider); return Text('$counter'); } -} \ No newline at end of file +} diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart index d176a287a..9f202a8c3 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart @@ -21,9 +21,9 @@ class HomeViewState extends ConsumerState { @override Widget build(BuildContext context) { - // Также мы можем использовать ref внутри метода build + // Также мы можем использовать ref внутри метода build // для прослушивания провайдеров. final counter = ref.watch(counterProvider); return Text('$counter'); } -} \ No newline at end of file +} diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart index b06e75410..4f6829a9e 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart @@ -13,4 +13,4 @@ final anotherProvider = Provider((ref) { print('The counter changed $newCount'); }); // ... -}); \ No newline at end of file +}); diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart index 51a41e2c6..0d94f0d08 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart @@ -18,7 +18,7 @@ class HomeView extends ConsumerWidget { ref.listen(counterProvider, (int? previousCount, int newCount) { print('The counter changed $newCount'); }); - + return Container(); } -} \ No newline at end of file +} diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read.dart index 5b5adfc31..1c7ed0bd2 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read.dart @@ -24,4 +24,4 @@ class HomeView extends ConsumerWidget { ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart index 1aaa8e8ea..0211d4bb3 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart @@ -16,4 +16,4 @@ Widget build(BuildContext context, WidgetRef ref) { onPressed: () => counter.state++, child: const Text('button'), ); -} \ No newline at end of file +} diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart index 39d5b6e70..95bdab6c5 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart @@ -14,4 +14,4 @@ Widget build(BuildContext context, WidgetRef ref) { onPressed: () => counter.state++, child: const Text('button'), ); -} \ No newline at end of file +} diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart index 46065cbaa..16ced4bfc 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart @@ -13,13 +13,14 @@ abstract class Todo { } class TodoList extends StateNotifier> { - TodoList(): super([]); + TodoList() : super([]); } /* SNIPPET START */ final filterTypeProvider = StateProvider((ref) => FilterType.none); -final todosProvider = StateNotifierProvider>((ref) => TodoList()); +final todosProvider = + StateNotifierProvider>((ref) => TodoList()); final filteredTodoListProvider = Provider((ref) { // получение фильтра и полного списка задач @@ -34,4 +35,4 @@ final filteredTodoListProvider = Provider((ref) { // возвращает полный список всех задач return todos; } -}); \ No newline at end of file +}); diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart index 9c56970ad..39cc348d8 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart @@ -14,7 +14,7 @@ abstract class Todo { } class TodoList extends StateNotifier> { - TodoList(): super([]); + TodoList() : super([]); } /* SNIPPET START */ @@ -31,4 +31,4 @@ class HomeView extends ConsumerWidget { return Text('$counter'); } -} \ No newline at end of file +} diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index eaeffe953..2b0985c9d 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -1,4 +1,3 @@ - import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_test/flutter_test.dart'; @@ -63,18 +62,21 @@ void main() { // Вы можете вынести это в отдельный MyApp виджет child: MaterialApp( home: Scaffold( - body: Consumer(builder: (context, ref, _) { - final todos = ref.watch(todoListProvider); - // Список задач загружается, либо случилась ошибка - if (todos.asData == null) { - return const CircularProgressIndicator(); - } - return ListView( - children: [ - for (final todo in todos.asData!.value) TodoItem(todo: todo), - ], - ); - },), + body: Consumer( + builder: (context, ref, _) { + final todos = ref.watch(todoListProvider); + // Список задач загружается, либо случилась ошибка + if (todos.asData == null) { + return const CircularProgressIndicator(); + } + return ListView( + children: [ + for (final todo in todos.asData!.value) + TodoItem(todo: todo), + ], + ); + }, + ), ), ), ), @@ -97,4 +99,4 @@ void main() { .having((s) => s.todo.completed, 'todo.completed', false), ]); }); -} \ No newline at end of file +} diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart index f52da7f12..a6977481d 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart @@ -21,7 +21,7 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { // Наблюдаем за нашим провайдером - // Наш виджет больше не определяет, можно ли вернуться на + // Наш виджет больше не определяет, можно ли вернуться на // предыдущую страницу или нет /* highlight-start */ final canGoToPreviousPage = ref.watch(canGoToPreviousPageProvider); @@ -36,4 +36,4 @@ class PreviousButton extends ConsumerWidget { child: const Text('previous'), ); } -} \ No newline at end of file +} diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart index ecaab8cec..56dd68fd9 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart @@ -25,4 +25,4 @@ class PreviousButton extends ConsumerWidget { child: const Text('previous'), ); } -} \ No newline at end of file +} diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 51dff035d..e10ef0d43 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -8,7 +8,11 @@ import 'package:flutter_riverpod/legacy.dart'; // Для реализации этого мы можем воспользоваться пакетами как Freezed @immutable class Todo { - const Todo({required this.id, required this.description, required this.completed}); + const Todo({ + required this.id, + required this.description, + required this.completed, + }); // В классе все поля должны быть `final`. final String id; @@ -33,7 +37,7 @@ class Todo { // Публичные методы описывают то, как UI может изменять состояние. class TodosNotifier extends StateNotifier> { // Инициализируем список задач пустым списком - TodosNotifier(): super([]); + TodosNotifier() : super([]); // Добавление задач void addTodo(Todo todo) { @@ -77,4 +81,4 @@ class TodosNotifier extends StateNotifier> { // Используем StateNotifierProvider для взаимодействия с TodosNotifier final todosProvider = StateNotifierProvider>((ref) { return TodosNotifier(); -}); \ No newline at end of file +}); diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index bc1163af4..6e39a113f 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -23,10 +23,11 @@ class TodoListView extends ConsumerWidget { value: todo.completed, // По клику меняем статус задачи // выполнена/не выполнена - onChanged: (value) => ref.read(todosProvider.notifier).toggle(todo.id), + onChanged: (value) => + ref.read(todosProvider.notifier).toggle(todo.id), title: Text(todo.description), ), ], ); } -} \ No newline at end of file +} diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart index 6725d0282..b74c3adf8 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart @@ -21,4 +21,4 @@ final productsProvider = Provider>((ref) { case ProductSortType.price: return _products.sorted((a, b) => a.price.compareTo(b.price)); } -}); \ No newline at end of file +}); diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index dbab3d32e..3cd8e6878 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -21,4 +21,4 @@ class HomeView extends ConsumerWidget { ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index 9f884228b..9ab1e6388 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -16,9 +16,10 @@ class HomeView extends ConsumerWidget { onPressed: () { // Обновляем состояние провайдера, основываясь на предыдущем состоянии // И в итоге, мы дважды читаем значение провайдера! - ref.read(counterProvider.notifier).state = ref.read(counterProvider.notifier).state + 1; + ref.read(counterProvider.notifier).state = + ref.read(counterProvider.notifier).state + 1; }, ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.dart index 0977a8087..b881d7bf9 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.dart @@ -18,4 +18,3 @@ Stream example(ExampleRef ref) { return streamController.stream; } - diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart index 6b2cccbd6..9190e55be 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart @@ -3,11 +3,9 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import '../config_provider/codegen.dart'; - - /* SNIPPET START */ -class MyConfiguration extends HookConsumerWidget { +class MyConfiguration extends HookConsumerWidget { const MyConfiguration({super.key}); @override @@ -15,11 +13,12 @@ class MyConfiguration extends HookConsumerWidget { final config = ref.watch(fetchConfigurationProvider); return Scaffold( body: config.when( - loading: () => const Center(child: CircularProgressIndicator()), - error: (err, stack) => Center(child: Text('Error: $err')), - data: (config) { - return Center(child: Text(config.host)); - }, - ),); + loading: () => const Center(child: CircularProgressIndicator()), + error: (err, stack) => Center(child: Text('Error: $err')), + data: (config) { + return Center(child: Text(config.host)); + }, + ), + ); } -} \ No newline at end of file +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 13049bd42..f9484516e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -8,7 +8,11 @@ import 'package:flutter_riverpod/legacy.dart'; // We could also use packages like Freezed to help with the implementation. @immutable class Todo { - const Todo({required this.id, required this.description, required this.completed}); + const Todo({ + required this.id, + required this.description, + required this.completed, + }); // All properties should be `final` on our class. final String id; @@ -32,7 +36,7 @@ class Todo { // The public methods on this class will be what allow the UI to modify the state. class TodosNotifier extends StateNotifier> { // We initialize the list of todos to an empty list - TodosNotifier(): super([]); + TodosNotifier() : super([]); // Let's allow the UI to add todos. void addTodo(Todo todo) { @@ -76,4 +80,4 @@ class TodosNotifier extends StateNotifier> { // our TodosNotifier class. final todosProvider = StateNotifierProvider>((ref) { return TodosNotifier(); -}); \ No newline at end of file +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index 8722a542f..0b60d4eaf 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -22,10 +22,11 @@ class TodoListView extends ConsumerWidget { CheckboxListTile( value: todo.completed, // When tapping on the todo, change its completed status - onChanged: (value) => ref.read(todosProvider.notifier).toggle(todo.id), + onChanged: (value) => + ref.read(todosProvider.notifier).toggle(todo.id), title: Text(todo.description), ), ], ); } -} \ No newline at end of file +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart index 6725d0282..b74c3adf8 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart @@ -21,4 +21,4 @@ final productsProvider = Provider>((ref) { case ProductSortType.price: return _products.sorted((a, b) => a.price.compareTo(b.price)); } -}); \ No newline at end of file +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart index dbab3d32e..3cd8e6878 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -21,4 +21,4 @@ class HomeView extends ConsumerWidget { ), ); } -} \ No newline at end of file +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index 172721f1a..58f866fc9 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -16,9 +16,10 @@ class HomeView extends ConsumerWidget { onPressed: () { // We're updating the state from the previous value, we ended-up reading // the provider twice! - ref.read(counterProvider.notifier).state = ref.read(counterProvider.notifier).state + 1; + ref.read(counterProvider.notifier).state = + ref.read(counterProvider.notifier).state + 1; }, ), ); } -} \ No newline at end of file +} From e87d40f902d961c49e5b71a8849f126095bb0d46 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 16:06:36 +0100 Subject: [PATCH 203/387] Fix test --- examples/todos/lib/main.dart | 5 +- examples/todos/test/initial_state.png | Bin 24795 -> 26007 bytes examples/todos/test/widget_test.dart | 67 ++++++++++++-------------- 3 files changed, 36 insertions(+), 36 deletions(-) diff --git a/examples/todos/lib/main.dart b/examples/todos/lib/main.dart index e4c71cacd..e8ab7c046 100644 --- a/examples/todos/lib/main.dart +++ b/examples/todos/lib/main.dart @@ -224,7 +224,10 @@ class Title extends StatelessWidget { /// /// This ensures that when we add/remove/edit todos, only what the /// impacted widgets rebuilds, instead of the entire list of items. -final _currentTodo = Provider((ref) => throw UnimplementedError()); +final _currentTodo = Provider( + dependencies: const [], + (ref) => throw UnimplementedError(), +); /// The widget that that displays the components of an individual Todo Item class TodoItem extends HookConsumerWidget { diff --git a/examples/todos/test/initial_state.png b/examples/todos/test/initial_state.png index ec2108be1673269142f76c5ee8d2f71069ac65b0..953956c3fc0ecf36a179517eba6cb1ea761177d4 100644 GIT binary patch literal 26007 zcmeHQcU%)&_8*^xV8e(4DuRMyLlhBdLQp|OL~i$AV3H`zX=j%_-ps=y1PDq$v^pI=ALuzJ?DGMJ$D8IE}U0cw|eVp z007pho>9^Q08TRi;6NZ&fmd=HrdEJo%N(>+P6BDQ{QcmM6%Hp=wGrUQ198P40CoVX zN++~kBL~|%G3~VNRaE+oy9Zi=IrCG?c|=Y>bQPDqzJ>E;t-ulVIjUCS@ae+);>VN& zpJx!Xp9P}kHsoZq`(|y+^e?DSzUt%Tw)643ebV|;M&Xghef{C#g1v=xAw%g^T_Rsk zeJV_|zju7n!=RlIYy-|?{-gLN(i^k8L&53DW$VYX@zk_N=3TU)%W z#k=pq%rLF7tMAQ&`tb0453#bOV=&Iz&kz{K(^EI;YYvr1JIk%Ft*eT{;e=AcH$eO^ z>G>t(qXzR_UG=Dtl1We{5Q0Bg35)!Qw1FTsXi#6DL(YHav zqd|CyaDwJ<2+Z#jNh-cN#=nTN7Hj$J?}!83Ouk8~5MS~pBzoPqt18gdgX%}h!WHbV z^vyFl2xEfTh$N2P6Q=rHOgz1Dp4lmgEHzl7j8vhg_nTI{P+8I{NF4;Jy9i7qRVM_I zJOklp@rXEP&LV zMBrH~z5cfoLMcbS@rBI!UVm0epQESe?EGr0VbhK$Z$fW>5`il?A1$iGROWsTXzIZ^ zI=&6K^tguocFna)`V|76|CAA2EQeHPHw6TF9E_ikO4yX2Dsmgkb7${y&K}X<3{$&3lWF`l(+n$va^s=lx|Sce+QGc zGXNhBp#TuxQD!Lu87Igek$el%*5Q*vDc2y2m->UmkevZ@kQfHaAk|00De-&G`{SqH zlhUjmaRRKc0XSvn7j9y>Vs_t+mew45_^Zd%+%z>pMIeAOHP!tRV;dGQZF1{ii#wes zH|2O6WDN6Tt(W|5-@dC7H1Q;8fyVV7eHSg8 zcRp0f3Z-m?En!6fo}>&3;1(%M;)2${Nzqq_3$ol^P#sf{Ixg%$>JlJx#F`1EkTx!& zPmyy;Bmj2rEK3rASU&`L8NhfQ0f`|qDRKtjlc4Yf?A~3r9|a?Rf=F(I5!(x;jKCzX z1YH|)Vqo*mvi*V(u{J2#Xg*cc3op9as}!+A6?b0N+@$w^$VhA#b35Ou;5k$@L3_<* zD_b!BI4pPQQDa<@i|vWz5tv}jh3wyVKjH>E+xJHp5AlzTKQB zSpuFvZ>~K#7?CIWSkSvrs}4y)IqofHyp@Qsp(K$Ud?6h_$AbgU2@aI!byXeMjNTp@ zldkN$8*-08Fib&_6p-9ew*NQC$d)I4C2zr)A(6x@FbiE%(tiN+)2$oP>Tu$-zLH)r zVsRwV6-L~nq~8T2UbO)o><3BS3QBf^h_7!z60gIE(MtO9aN>>VV3_2spycC_g^oT! zV5DKZq>;KXAa6kLCgfwbwP$!UE0g)p1x}_NJ`dVEns|tVp%k>9nAe!*%$HXj@dd?R zlY=dW*S-|%nc&7dip-~tAW8T)q!FzddYK?`j-MwCDh8$ z+Vmj&yzee+Wtj%MYU;y?y@#vwK8k{;?08nIa$Pf#8@Oh(c`+^l z4+voJ<*gM9Jyu5AQ%s_+*vaB_SQ9kz69r;`Lsdv9MW*b;mt+LA-V4|xr}cd*^^lM{ zV|QE)#2=yR_(I0ndtr-Eij~J^sNw=v>t6AdJh$Z1*;s!BrfFjTNeB`T%XbN6SFm7(;CUERN@EL?jD|NYkz5t#c+X7)TbRVYOjWQI(ow48Ri z9K+l>%zqA_T=3YpZ4MeK#~Cw9T}yO*6TD5WRkIKh;Wt%wy}f}&_dFMLF%Nogi1Img z^_iC|7b|nc?#-LwP&U{r1V2XuKfz01jovgX&9(B`HgYTcno|yLT-i z77h}IOAZz%!HJJn?}Zb;myTab9K1wwu%s2-CAL~WS;EWY7+jK)82pz9`aOKC-JKI~ z=PlKl3Whl^VA!_@PHbhK11HA&L@gl}%f`WpJ)8E!iO2d$h-Bko0hZ0MXT!*%N=oH& zhoYd$16XSbx_4?5Hxn5-ed4UafKFCo-(sNz=s>9tI0Fk!yP&8A+=p-vs6x((-39rs zBCMj^0V@rD-vtHAe}}zR0XXLizFerm%4f7VJz$Vx*lAVKi6ZgHFE`U8zwl2t?F`gV zpvtY;Tar$ho*5_+<0)7kD=5|WKG55XWP3?bvh8SlU^YW>`Flm1?=z?W@RHf=LCF4( z;KtTHTle1r<_{JJ*}!B2lMPH(KN$F4({h6HvH`z|F@9FD-@YGqpD zwJkye9%*&yF}3HN zU_@sHUv0(O!OH@a=eGvCjS9VH?fKXH5maQthO!*&RNk2%a`|XdTfyfn?o-sJ$ut~( zr3J5<=iJQILT?5ga%}05O`^e9&Bw3Fps7gWqn<=f?@u`kMCFnd6J6 zNq}M2Y>DjhZvp@yMTxy7Vd>)kd+p6GDWQ^5j41Fa!*gc1u4VConNk~L#`r*s@bRS4 zHF$;9i_c_zvXIFEY7QV4_i%A9-G3p{Xty>yvyfF<=b%p!cueqPT>zSd(swW)CY}HM za0TqQX|an|cG0?kP zb{w}Y+mcMOl0G^&&wTQ`r)ecqE0mOZhP-#Z`eEm3)JIL8RLw!YXU8f7E%%hKUiC-0 zv80@0s>E8?>Nc_c>HIfD>e|AFWL!+ryG2je4Hxwqi5JT7B4EAHldz8F@35vPtS`zQ zj%90x4Fc@@D+9|8kYD<(ZyZh3$cfH~^`Uo~GR6iaQY}QQLk<}|pB9{WK$PI=9)4Qa zAW=7GKCorY6k**q%erX!qFbrOGb1%LTv!Q7` zZmhqUM38m!%uhEd9PT1Yfbsft&sVM-C=GrM2ZmW8}?Gc;+3Oa%9ZCDk;&Fa~ZS( zuXGfs)Vb5I)2{Yb25%eiPMdQX*pl3mv<838!opBP|6%c9N|GDBox+Igm2Y$(K7CP# zx#Et(Rp5PhWR|whySHOqGs#m<#fOrX#&#CEX_%%>>rRdIeh9_HYtV-xq-?XJ z@q0aQ1&{X+7P*Azno=}8-G&786kwZic1-(D(f(-j;>$;eWf?Q6y`%<*bS6R>QX;t5;Oy~N@2-N?O-gfdQTALV5p)s9R_mMw4pc5dD!l=fKUAE5v+MN0zBT#1 z(PV-XhF(`fVx%V*_kHkez&MRfIhum!pTbxKp_hxE6`ire0_EnJN14tXEu!1B zY+2jeGd)aqTqy7WY;C{SID+--z2;AnkI2z{!qi8z9BBxZLyQKl4q?Ds3e*lzAleezV*xEYk7aUW&Kb(W>03r z_i+U#SoMu-J?QSVmb{_HXSmRT>PN|`y`t5R4@L~66%3`gqw)$8=wxeojs@?;u4hIn zzf={`N;Au&TmxIzyHmUFMq%{Q8}wqNHBqvRYXke#G94Q4x{YP{4UDVjmk8Vu9a6?R4bv}O`IQ1iv|(MD-&Eb7rLo&wdlA zdml)SU!gxsi~4YgD0M#4Qr`S;cTx5!3QlJEv>=^c!Sf#R(QYI#wyW7s?y+r%5}Yg| zN<98L8iO*K=Rb{N#3v*q7}V(>X;hX9s&V=(n*aKeV^wY;c$^4+O3xZtFMG_WewQgX zU7bhdK22#5p9xz~6fn`iiPv`y6*IAsM}PGi|BwS_)rC*&auGu=vzd2qjTp~Nz31-O zrVrnL`)WB?@eoEY&Bz+h>O^7Fs4JkJ2YUzeA1*fjCwppUMhq%ZkC190BsX@@X+9hR zR`_d2kJ)y7bYnRVu>BLKzG#7Ut5-73_uh0=XFCygZ%66n=2_~i<*9pu+G6IK!S9r_ z1C8lmQhh@_mvV#om2QgSu@L85YoNgwa8r6sqq2)Mj$+5tE-p62JCDiI5x85YHrX}d z1YHI_s2PVECIyR|neI7PF8DEYjzXQ^)XWpf-q2>ey0zfV$Cu$YQ~S)TFuiH+pvPoJ z6*zy)@Z-vfX5~Re71v*Q4v^leF?4%ti*-W}&HgRTD6hq>HqL62cF?J@UGRlFDr0H1 ziT$A4$_;zZqxA17*+7lThDF8v={kS|`|BOnvj9*JiJeitQ%3odiu_hBG0P(sN&r6Y zXxI_h_sMgAa#r7Ic(|3k*|T+iuZi5OxNl~)Zj}#_Tle7}=v}}+jbJuve-eEBP}l~+ zif!nA>r$eZ9yRS{obQ^)3eL@$d6fL=+I;$h0*qT{2ho9r=Dy!w+1YqCxs_jDn{av* zpY|Egi=s5;InxY0X#w1{_))N*letUIh5TGa&^_0t)6sokAB#5XDBs%CBc8uGj0#UG z)Tm=C0$smObkT@+aH$qS<#(f62M%a><$+aNKdrIzxx}HU8}h>0HtqSc_G5NYZc}0T zw??lG$Yk_;e$dgWja!~TS8uFB&1Hb)o0XSW@p-S&{*D;sM+0$dB9&coRh+7Fjd;1X z%NcNU$4|QNoS#GuhOkm!;r8!W>0o(ySKUKL$7#;bmWVqP`9fp+6C3%f4KmZ!&9b*f zz}B4FNPpdowI>;4YAbK9N=!30)ae$LH6ynW%#l)U`A!(o+PG?``juey*%qH~Zj^?5 zt+IZhn&{hAQgp33%Cp;OfK!-G;+s3i(!mUA1(?*;cn{@7AGSwL_k(>6)~)x;m@|`- zaF`ACnw{h=E-F(y!ohWXqBz|+&z|sVBWqlKCHLaFC-9v*Lw~Ur+gwPIoPO|tY^k(Y z+CjCqV)sXWIiYH4yH#zSk~8nBfWX)dU;NJeQK=fdPO|LMli!tZoI3L~aGKwkaP)<; zk50sGALCOPxh&7+s>z#z@CgH7v>w`0-sTlg%|3p~SNu7){-k%*n*Uyme)^&Xd=>=j zmG96ykm+QeJRa2a_U*aJH}0r3`EL)2^hqYr$=fFY#XD$LBcWe z-zkp%acT)qlE=|E(>>l`|cfaK|c793`g!VT!x{(>(g;xV$sAO zC&`>Fv^rt|T!y=+XDai~Byk&I4?nmgj2-vAw;knN2!5?wwcMf}=_&1}b@oPh0(fCE zuW!9Y{dUl=rtEnscQ(8R=Iac|CFSw)HUqA+2(PHbw{Nl#X=y_{}vI zrUx1o@(tWs?|LilA<#4kAdzl|MOz!TLdmE(*N7+73P`z!&!)H8>D@Srm>fngz>Xf2AO+=lM!~ zffI|}yZ=pX^_{AiA1X`z_a>8I$@L^F;fCeno*i&2TlbIskC()^Im z0!0l+)ybUP-K*H$2I$TApRwEUm+K*2ByiYeSQ$N%S!OXBpOI)o@eu`X^1Tai76TiU^XUQ1SKSXxXOd=U9kVSLPiN*j z=7UK181==Sj=S=}v)<(e;5JaGi%xjP5Fe z1;45b#ltw;#;PG284(t?Z^+y3sS#sFs+-zXMd&Tp)zv$@ui}zpX*KEWEn0)%$7u0P zA0MC0$$`2kWsb3K(X-U;4J$oma4{w`vHWs9Z^-lVhmH9OK#eeBO95(TuBM}0@7Y89 zAu(oLl+5h@HKVooRx+4^XY>4GSh*QHbRJvLB=0f&oOxqZkdd^wBgd{E zMx3mqwAwOeQKpP`-jXP=Svl1*nP}45+?)#QRo-0AKHvDc_x0D4#(^nYXPfLnGDV&? z1%hBTrbS#z%FunWA-Db0D$zF;1{2$0rjk7Q=y-A>-5WHq`ZQ&&qe}^v{()3a+_&v;PrTIA=41 zK%wK)@wKeMvS5xs_mLQ!UY$yA?XG`qTU}dgLzeM7!kF=pxkc)>?-{hebV**%efOV literal 24795 zcmeHQd010d+P{iQpnya~6i^YXSa3lU7cc}7L==b>fmGH2LKQ(kKp=r+YFrR-8LI37 z#|34lC?H!>WKj{2QWl92meR1th>#$Jd^bRHFW)osJe_%JXKa%{BKPE+_q^v_e(&#| zdlJKsTAIpAD@y|aAZvEW_!t04IRk(s0aDQx<<2>fTkxnrhAKvtbpz1*#BE>SKDHy(AnSuIqKmHEkS-{PAY z_ThHEOe5oqS1{ps*RMNNq137MQ02(()u~3ZcM5abW388WKR});?u)LDY&1cg+87s? zIEr4%32o;v^YoP@M;Kpl{T!0Qs8l4V#?0&J4yF3!>zLayu08a#=@gxOy4;#b)B42l z_IB?ktJoX|>!rf3q|8@aHdkEOR=PaN&ihfw%hqZ38xJ;}Nr@QKvQ49ulcjQmT_0{i zt_aYeEu6bfX*S0G90z)YRkiYeTw8<{UM@dCHfcwQWNkY90@*yw zVNm-E5a|TiC@U9o0Q1fP_VZ#^Rc>!@-%v;Bm_6Bg*Mb#7NhX?Kl^2b^zSEavu)4UY zy_H(H(iB5kj?*PWy13ku$2q7t$zI8cKR{YMH`1_SKo#euIMccxYGn_s#0@VOw7!Hb z4mq$KC#x{ix)ECP_5pcZ)Uuh@4N&XXX^}ZP>?RT--5gqpa_UutXCn8sA=!EjqZRPa>Tc%qjO8n|CE=#DK8pb_d~{`iwADm@uz+WV2dX(XQ{~mm_Uf zL1x|Au~R+cRF$oSdd5cuNSJhVWR5#hpyz-Ev{FxV_44?W1YNcAv~7?|nL3taYm=E) z4OnY*curcRK*_Q7&`NI|49^*mpOI?1yvwLEc{o=jf)X zXCB}3KYkqKj`duxuKM_~DGwIb7i;3{Wku2UuJlI>tZf-@SD9Adl1FxDsiRe#H}>O4nvVl z+8&X)%L4r1VXV&BZGrsR0s4_TcTR&b`TglGzxLfRjxmYvs z405OTNpMk9Zn$;R+&X=ecJkO={0LjM%K|dB^O9fjrLA~IsEL8;rt&rlWGi>KvX+R@ zBS+LTmcUjZ6P^GrToFv{Z~ z(;Zb%&v*~%nR0Mm)*IG>sIyL#UnJ#axLYt^>TW1cLqlr)49?U66MYU$dMIEF7l66? zB_zuTOnzAKEk@#+j{LtATUmRtsj09ef5p=5jEXGpf`PpUCh5%NYDtX2)BZE8xAv-N z{H`MW`0>Y@7${aQ7UdKv^PdK7mqYXXo2(ALkHMg$nv@({{V&))Lf+Ou2;H4>RNyve z@2z2+sZkS@X^;TeYg!!X{^x8T)gz@v)gZ+g>^Nk1;_6aN;wH`VHfmw(6$C6gFDl@y zVM~z(0qhdwVPzw-E*^5gxAMs5Gf>q^!5L%oAP6HZS%#~H4?axR4TTNXMmGDy26q`_ z8)1W2$m1+7Lo=TMXAXu9Mk1TtV1rK@W251Nm*Fg6GoJuwHh`S_I2Pf#4<>6b(gqgA z^0*BFA9>SNKT}2cxV)=;;IzG?U4#=@2pjrm&~a)YJ%}H!;o=&~8+g<4^y!|k@iYFM zp}4m5?U4WMbql2iF|5*puiVp$*LL`ts-l8*^oq|rp%N-Bu#gJQ(G!l_0^0*@GfJoY zeCv^QdgV~G0lQ;aW8JAsQOl{sUPWZH92A$d+s4@4P$>oSH| z)(%2g-~bZWeh5-l#)A9=Hh5(?VvrA;>bWtN51AM^W(?O~#_M_xtS`1r6$g2Tl>0;% zz8-~!DtO45o72@dL*CK;+UqJ@R>hMI@WECMm*x$&Xj~5;Y<&SSxKvBa8nf!fbY*2M zaVXcqqs0`i>Hr8|T(-p03e&|Py!Adk=i9~OoZUm+RX*@xk{2bNFU%=mi$4gVTeCAO zpJ{33rqeS+>hjC>o!@E@GS<|Jbz+R83p()GP>9B67MWt7RoF^^emyb#)BQB18Ny*W zA*cEKWz)MF_h9&EuC5S}IN^5ZIBfTCc)IDa>n9eyCoqyu0iwRG9$X?KKF`W%I?~{07XO ztJ&(1`wVN%ca+Dw&71P{x5~)odp+q0$WceFKi=k9mWm!NlaNev1Pl`#unti*o}TPc(>3AOZEf6@olK1VJwECR9YKt)c6yc}X0lQv;9N zopl-TpnrV`YAy^!&k5 zD)7{`QPF@ak{J^PQxmuu0l#9X%u927*YDx;`Xu4tnMzx6DI7kSUib|eBKknW zP;PZ@%%3;afmThpS~C3~5rb8xQlivtZ6;(ZA(6zeNiQg1X%CkmZD#6n$znkBT>r7A z**mHff~4H>QUFNHOCJzP0Pe#O_)7@PfWJd-0?eRjAbkldPB0XQTU z4*+80fG8u590Amd(+V_#7!*Jwh(Q4~f*2G)BZxskU<5HJfJP950%(N)Iw(xVlgdz73Hw|(FP1)bKcH*L*NZR*YUI=#Y8U>nIG-lhDzW;Q<_Tr#_}EK}U*D{|7|xAb zl^UzFEU06m_t}s2jjzMrqnM^eAuNz_8^icBY$rkHaAufSONO&HsTv1+*R zK4*G<&71XtbeehD{GuY-5(9ppDL$$GV&S42Gq_v-)MoMDgQo@Pq0wuz9ZTa;>x&Bu zSGq>}GV79F98sQR;y?5?6yiA}L#x6k^<#MFGRufE^~rIG$xjoLClZr`ZP4iP`X?W! zw>O7P&xAbjRg`p&0fDRSSVq{3KNuJmW>B@VrtEK?d;({r-7b*&8^uH>s|lXS&bpuslKZjXX*RAnMx_0fFJBDi&#>EXg)=f{?lu2lvUF*slb>-Wqv(~x}>zBMA z-=3KK#-_vI(&!HQOL{eyKh=tE8JGnBkdqJumF@W)FM98g=m|TZb%MYC{%pK~@6phv z=RDx;pjFSdGjI)Wde0|uLa+2G{PEVFsD_tIopsJeNI8Spk6yW@u%z0_ArT| z6x0PN3cshB+ke(GtZZs%=*&I>*JoU&GrlBv)IE_xsiWKsa%{KPO0;7tjOUhzI=ukz z((=6$P+c!=T8ql7z==vq5>Z`;hu*em>Q`fXwr1w|Mh48x^>P*XklPte&(2fQu6dcw zOT{FE>?5n;<@vDQ;i<`$I67+qVUuUhY&?scfBFU0`UKj(q7wX8wtt`?g(bRyv1L9%5a{)UtJTAY>#YB#f-et#!AW(fK;T9vS7PGy9C zijNPNV0h8#>)EtnF{mvd!988-*plr;En=2D_t(n=|7s=}uqeX5G!^Zkz~WHO6*L>9 zWEbo`sB0^)3%@o6+}$bjY=2fBeOS&f$#oRQ#>BDwSp+BCP5wWjI-kfsdkw{DkVYbO z(sCZ2eQs<5tUK@8#wSBLqUUTu1($Grly_-=mKDOQ&FAJFvF>n6-ggfVuo#VvR_z@f z%^{^(weF25rpbfGQ?>4S@%7Arz`$mdRTQ!ltW(1WV3Uv8di`F?sLkHNAppZ&A5r-aSeg1>0XkA5rao$)mK1{c z4|*pkA&fumK;-kz^Cnr;b}Mx>aXN!RCAK&bc}=KU3KCQ;Ko}Z-j6vi#q4`r*(J$`d z5C1YT@igu5T)|Mig^?Fh2;dXlNK`+;ZY~mS4$va@ED-S$wO<)X5(5egC?7M7Kk z_QLI_k}q9})QE_Ph9!$!iDBte)A~`oi6>M>Y_ih~v2s==z|OP4>B7XKbzWInSw$LC zH{n|mq}?y!TM_>Q8^crAOZ5+WsY<78(u})7da+Bjpu<$H=7o!_<0XfO?BiDEN?F4b zU;EW9tcdPBAG2*{+2EV_@D8-2^c$YX!odf&z4(vR1_^Gd0UB)z9l1&@2OUo%L1H)pm?xqU6zLR}b^Mk$Vb?#Mg)3$gYGsK~C zP{=}Qnzf^Z80O|0zZmAecqfRRiVrnGv>Aq6>Q=ON6Bt*X$ zWe9`u&+Kschn*ob+buOZA;KI4Xy~`F9Yq-Oh`%s0dut6M+3){VoqvJ$Vw;O?K36%# zVE+e!y|};%xf<}F(^N5ViGfQDTr(CBCy|I-erDwO^QHA-%|$g#T#5d7D-j7j+?Ffw z6itmdxOZslwHdFG%tSvj3dF(=--(-NgIa8pSv!d1WY!MiB$=~=I3R=pQCmtA{Msr` f@P7n+N(5aPnV0AtIW=uBnApt3(m2b=`MduEc^M(q diff --git a/examples/todos/test/widget_test.dart b/examples/todos/test/widget_test.dart index 28de16a3e..a11c66891 100644 --- a/examples/todos/test/widget_test.dart +++ b/examples/todos/test/widget_test.dart @@ -36,43 +36,40 @@ void main() { matching: find.byType(Checkbox), ); - testWidgets( - 'Render the default todos', - (tester) async { - await tester.pumpWidget(const ProviderScope(child: MyApp())); + testWidgets('Render the default todos', skip: !Platform.isMacOS, + (tester) async { + await tester.pumpWidget(const ProviderScope(child: MyApp())); - expect( - find.descendant(of: firstItem, matching: find.text(firstItemText)), - findsOneWidget, - ); - expect( - tester.widget(firstCheckbox), - isA().having((s) => s.value, 'value', false), - ); - expect( - find.descendant(of: secondItem, matching: find.text(secondItemText)), - findsOneWidget, - ); - expect( - tester.widget(secondCheckbox), - isA().having((s) => s.value, 'value', false), - ); - expect( - find.descendant(of: thirdItem, matching: find.text(thirdItemText)), - findsOneWidget, - ); - expect( - tester.widget(thirdCheckbox), - isA().having((s) => s.value, 'value', false), - ); + expect( + find.descendant(of: firstItem, matching: find.text(firstItemText)), + findsOneWidget, + ); + expect( + tester.widget(firstCheckbox), + isA().having((s) => s.value, 'value', false), + ); + expect( + find.descendant(of: secondItem, matching: find.text(secondItemText)), + findsOneWidget, + ); + expect( + tester.widget(secondCheckbox), + isA().having((s) => s.value, 'value', false), + ); + expect( + find.descendant(of: thirdItem, matching: find.text(thirdItemText)), + findsOneWidget, + ); + expect( + tester.widget(thirdCheckbox), + isA().having((s) => s.value, 'value', false), + ); - await expectLater( - find.byType(MyApp), - matchesGoldenFile('initial_state.png'), - ); - }, - skip: !Platform.isMacOS, - ); + await expectLater( + find.byType(MyApp), + matchesGoldenFile('initial_state.png'), + ); + }); testWidgets('Clicking on checkbox toggles the todo', (tester) async { await tester.pumpWidget(const ProviderScope(child: MyApp())); From 14379a6dbf6ec06a43add049da7b21d700135054 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 16:07:25 +0100 Subject: [PATCH 204/387] Update goldens --- examples/todos/test/new_todo.png | Bin 25221 -> 26593 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/examples/todos/test/new_todo.png b/examples/todos/test/new_todo.png index 85f04e3747d150765edbf1a9417c7503d1f7514f..9db8893973c826c43a7ace83fe397a557485c198 100644 GIT binary patch literal 26593 zcmeHQc|4Ts+n(Wc3XHWU?QOA=vFk<%jC_brtykzF$kr&MHXQ4)sgIBFP18at!0 z6~`84gh|M5#%}E1hZ@i0kN5L=fA3rG*=GJQ%`?w+UH5&h-}}1nX9_%jPJP4L?Q3B$ z*oITTsA|JtoR%=y8aRA4a3!;TY9;Wt!c|-SI4rqxXAkgUrR(uix^Up-4Zj!wgYANy zQaz^Y72Qv3v8Rpkl@2j&Lq!`yIJ5CZJo`?Ddr8S(*~Xbx$$!Y|?2vZu;K|$vQb*M8 zzDy+X5_RG=%jDr_L7w0+-~ z6Q6UFUG6JRdK=S-A&$T}7GEmwqkZl7eo}Hjbm1z#d;f_hS+sgHy0hbnT}BX=96;ZX zV%-UIxOCZ3DWCa82SGK}84Z7CW;$y<)0-MwJQaUNP1CAqr6KFq@W=3=*W8vXzI{G# zCn#2S)^F9fk19QZ1QF2{JgmDP?IJ%928nfV1H=fBc)wmK!7-DbuF(=iz-fY9I&`JT zjlSLIX9mZp?cMJm);xWh?JYsZ9f5GxjfdOMKRe;fTqjwC^-$PYSydVn6eO7RbQ8$m zNH2hp9GrquH5}Vr@YAzVx|#+s~M{5!ZP_X1zsDUdJyXN1*;uUFNx%%wzHJM<%g%tjU##c0+JacT3K@R;MZqM&_C$V! z{v@2hn(39_jtM3m`pOqHXSLz1s^OZ>&eMytErSgE1^s6$z9&&ZIp?rqdJD=tum&7@ zNQRz&eNf8t`UBTKR;n5n+q+YbWUGa-WceMEo2Q)4_36F1Q_fqCfnsDm?;54I2>9-F zQXEuqqf#Yf=}~z?4CIK*Sz^;Fi9}`DB?lU8AoKr=PmfCphfg;?$o z6!Q>Taxp)?0766Hk{7`|c9SnCfW+N5;X!ziI8IYgEO{SDydr>*`2Zwd?RJzbkI6lP zpu|@xiC!~u=UlSGE-N5xe-CrF$Du+8JgI5JQ|Y_|zkzq!+^H z0ti#py~$VIg7{f!1LmHdo%{2=m;K&QtenimI>si}@Md#A|2Y4hvi zjc6uMW|CqvXbkHkO-2Due^itTnEMd50pt3PRA7agZ-MICXPKV1$s&h7ep*RggxrXQ zd~*@_rnXdGFljqv3M&H%y=tHU?tNq&7dZc)Rs8k1K+A~$>X-u6aefyG&QdU` zck`0>sc0DQXerFzCP_#Z-%2ZYX7<#kCeS2M=US9}2J$Ax z3b~x*bH*P>W)3`}KF{-XI+i#L5v-M1e#Uud#-eTTMHmnA(k@>#lP1S3;*N40#M$|G za2{s~c=_^U}he5XsvC$%>$b z4nKk0%RzX_A@m`Ryvb@WG24CzE!B4cnJm7}b1vASwco|f+*=ArrGWJ$Fr!*CZEx4S z$jQe{_BWbbZp$|?4;ufJXFY8SN+P`P9oC*~zb~-mJQ?3SH z&h5{VP_Qp8=GH{nsK!uJ0v6Zo>hCEb;dr;CWOnB>PzMta7K}_9xiZ7(Nl-IX0R0(e zve}A$4vaI0GyX(r$S{NulyT6l3X)X~O~8r;^FdhoM1o?vqu}-s;)8&y=RsBb{TfJ6 z5?*o`n6|1Rs7gz?Mi>Di=={^2RuIx>GBRW^j$lGHMQ})R3_e>cCc5FOjwNF6-_MD_^qC*9d_~d^4QN%@{u2Z)1+4Qk+Mcqbf~lK0#G0`W+VG9 zJ8oIZOR$GTAo=oEN<6N}y|LSOnuJ`B+;b9GvfYze6Vt zZ*vmZGuS--djM#1zW3s(O>55vP-Aq0^s%y69FeeF&?N1NnC$jWxIH9;i3gmFyXAV81|8(;hHu!5)Bq z4?6`0r{5khc2yvVau);|+}i^t%Kr;{?Hpjt=l!{q`%B`-o*TgW873_b#VyLcJV*{p z1Ny6g6pNO-no2_o>qJN?jOm#^k_1lH;n-ukI{eg6f1$2vv*>%18mB=32n&_8S%k1h&4i653IAp~tpa(S_k9X`Wn)-7$C zvNHv^YxQr>6gBmqI26k}09JFu|cjLwe#{=v4Xgfc@p|DA}U4QJkUVM6a z=NjeU;0xu>JX(*`?9`pF+(>Pje-`@sO2~y$5u%j7uEK8pgZK6^a35FL#aI>Sbb4rA z@AyUfdS|6~Rn`bf+(rs@djQ#Wx3wZ`Hv|_zm#&a@r$3}4%D#OQTQh7Y*!0u^X&LV` zUfqhC8||S;^SBMpP4~rOeSRMcR+}8Uwa$H>!}kNKeaiRR^ zmt(=Jt~L;!T}BO}aX8!tfeDogQ_?3?$qkSG2Cc5DSSMgmJ|DB3+e>gbR9B4Wc1fd# z+7?A4^^JVC0GqiP$@%BlX^Jb}M(m{|^<*rgMR|fLYu6PT16+BBW_Dj6;K%3pH)lFq z&sNpXJ0h+1Ox#yc`uiRFID8zk|^TbQ0)F{Q|F&QYJ9Ds_dMm@}08%J`*k$R5{rdOByrHLowXaqvUF^8T$^?6Okcqeg6ok=s0b!@(ZymXA&oR*jFNS~WDn4Nd8 z=k>`>LE%HqV;PBn4%#oy^V!=qpo#?l;7Z)L8gC$W&LW*bvexM1j7j%xnL`Z^#9jeH zZe(OcMye)kUP#&3K7Sv@&9|?vPPd|>f(VQ%zu%OE@zK+(sH{9<{+cj5J)VKBwvC+~ zwdu{zLj#H7yhZW`=0MGK^&L#w_)IGn(Davn^%O~}kA+7*^OJ_c&DLgbfjR6(mQkvY z(yG8`GvrT0(A3|#k}V|Q)YUr1OGhgW#c#Wg;DyER;y77T-vwDkz#*Hn#~};gdyp;O zztruAKcWgw@7Q<;FU*=wLBsa-tMS4~BAVb4%D>&T{!%(-59T|C0^qE$#PY}iOp3Vz zb2i&;$i*zng*X@0*beu4e7KpE3}ft zG^e`Kdx=xM+`_%;T`dmCOQ$>-jap$!wJ|7OlMP!L7kxrq_3Mst@}-j)Dbk z8G1KV+J|4qYf`l}kWV3lYJi<_>D!k0p)ZA`Wn(U1i#q8*%XWAF(%mXQHY)AD01;d- z)K34Nh(r1EaPcV^b92wm?=h#U$p)9Zw~A%IHF7JJ%d=P%Sa5o?rF%Fmk(BQ`RXkM^ zsDrl&t{YMhtxwo^7N{h>GlhXpbvl|cKyE)JG5-ahJt9P+qDmfk&yAEW@^_l=@~s1M zeBZV+o!Q;DowFpO)jZ{b7+WKlUpI&hPbG>M3|nLwdDvJSrJ~61^5kzTbF*ekl3&47 z&iGJVju#GYuEI=t09Ezd%dOyI--=*TWMm&{w6BUZNZ(@q;HcN;*`ve_k6HIs z%V7T@dH?TRvwrN@fr{uilwmvad$z||<8(e|u;AtfN^nVMMU=57%Mao>6juaY%DCF( zM8qC+A&ulTLBCsRD3+tFxbJ`i z?75i0*7wp`0Cs8i`wmJ4jQ&4S|b5ZG0j!sC{G0M1yt8c#jCBN#LBW6#FO%^A?5D~W1H}_NawbZfT`wgkC zXrGSvk^o9OkT*BA!@V-uXe#T-I(>3L3LnXH%Epx$xfP7&_e@Qc zDpLUXR#8<&eea}1n@)S_V&?X1TK7igO8~Oh%+N%I-ULhW=*T27|u+G);Tcj-N`0y5885`_H!RxHpkNyP~tIDO=>X zt-lG5tG#3z6W>_wch@Sq^)i5rA9K&to~eyHoDP3PxskqQjBk(8{&36Ad_QxEAz7Q@ zXzZl-vzy`}tNmLXb$vQgdxA7VWk97uN@I0LpkDj=Ht8r;H)D2s~W6f+%?P%mSW|D)dsMv$| z0YFOU6l%(|_XOT{tY2OETxjar#`y3Lhc$o;BY7;8I_1LSGr?SRdOwWa?I@GNMxpc< zA8XHv9@+VcS0KallRP@VITPrt1?%rroN+rkKc3aNggfP5;gxZGj*i4(rS{I%Vje}2 zX$j?RzY5z`ZT;Bx>ukrDSKLIKuNs8Gsu7L_7u4~lQ^}@AdB%+9IbsqXPsOH*k8o8+ znBmMya`nw%hgRMqw z-M7F3EIsPK;~#=bb%<;F0aR*;W)%_GsDABXqHwa;YHNBuUwla;^af7|BhxWPWGA@s7Q zLWKKo}e}35z;oAkJelkcnN`|Pk*=V@Byj|KDR29 zlhA;0!YUbHCMWgj+wcvf39swSSx>vFC%;gWXASiw@O4;3RAl7-lswFH)0r=|E=&fk z(e=U^^@!8^ivdLXp(cJ9=q^&QQm^rNyi2QctX$B>?sB8>Hd)*{prAQLd*}5xcD$!A zj(kw_tg&AQ!atZ6Vc|`Sn!tr?JDQS=^5^X06?1ZR(Pc$OdAY_CrkRH5l3&a*9r44h zcLeIOQV)81dbCeF^Y9%+B56V0T?3?f4<5dnh%}L6Ctcpr4zY8&Y|VL@nbGN8wb}jD!?~LPlqhP!}12(Mu@^^e|u|r9!-AdG0talY&zW z(qbW0&?iMV@?)~2eWy+7+gN@XQ%4byrB%E6=1_Q%KCOG59{jg1g;s zPUWnC{1(-l%O8Fc3){6c>;FjyjNN+pYxVdR;nDB5c1vCjLy;j5IR2fZ{MoBU4v)rb za!E_;H5e+<_Gu%xNBBPl+_IaE|CD^9QO{p+(P*->$z`mJt79CmaOvvRyz%I(k+HF& zXeLsBBhr;1#)s5KgYC!<>t!=;6V)Bm(-LCJvu_tpx3!N~mQ0y47SxW*lY@3B zXOb=JfPFpSUxm!)3INFb8V+&d%=!5})z=dvQtGhP*#qc_NLGQI=vrwQOap+mo#qwV z0BKeWTov+tUVx*qzH?*B7V|TSRUSYKvSD}#ZEj*>l0snBIKO0Pj(>Xx@;_bG{Mh~E z@6UaqFFEDp;h64_u@?+P{mencjpAPT=>w5s!fSwoX#X0!>y0&O;G}gB_U3w1u~WTjhd6ftAq$?mI3zb&V&Vmj)c=D0I^GoG^D& zx2RkU(>U>pYp(W&=pv89=tkS(Z_#aHQx&m;>O{fT+`V}xR-&s#$p8&*PZP)1RDKI; z0GWo$xsJOTDGsXAw+Wdj5=haC?$5`Up0tw(s(k;;M`v0di6$D9$25^111p?H*Yrzs zZzo@Sw!G-5ZoPS_r~7`RD=T*7uYPbWfM^>Z`36=l1ZRQ6zxUqdzqF9j$SxOw|4qPV z;r|E#PaS;61Bnw(3ZB<~+O=urv3obmm938XOh3eA?$Se?g;jj>t3Tz(5^AvggG3@_ zl$F+DpM@3w5s&$zQ3WPc=W`&M_ZozpsDd0WW&gwtYi}0De$W;?odNB&u)T#<`q;mL k@Q+B2kRtzQ`1$i4ld-sigbznPE%?~@E0DGdL|G$Bs>mYBB7wlvxFDOBD##La z)T%53MUhRw$f6>kMb;F;QbpDX8L|LL<|UB4%m15x-}FCr9NWCl4|p&4o_p>&zq8zP z?~4&%*;*}_r!o(Mpapw&TYLjSbKM|F8ikqzKgn+xn+5-pI{A&2Ids2PwHLmbb<%v# zeiVF#pblSvAT?-@#g6?!$pdXRktuJNRSom^#N5i!ZaoxzNa51GuEYCgs3geze0clp z%Nb4)jwgD|EzVxRMBH4pa(B6Mht}PtdySUeF<)>aKf5i#Zc*2d=%YpNe5!#=S+7qX7rjvUbPe+K>$Irsjl&J$sB~*&CMtI>qCAt?$IM7} z%Ms?I^{Y|+Lr>3F#bnK~z#c)nNlh{L3Y&W&d&neY^VRl{lj=fZssJ&sM0BHCNul8n ziHp$oOAxW@x9h8C9IbSish%;WfDoG(7nSXS7Vz0;gUr;^TAh-3B*Z|ClBR>Ol)2HC zWM?USstG)ei^xuk5->Ts3YqDZT@l%R@$iG4MpX zyLl=68U9=T*jPV%v^%z{a%`+27l8HI>cqMQVzhmD{KN+9P{K7V(Rx4Uo}*8xaSVCu zTaAo)$nYI1C+E-4;j@R?A1ah1FJ?1WZ0XuU0UKJ&eaL@bfU&;j=EwFgg<_wB;g@LpA|8e*<1HFGSVYKdo=wD$cmFYq>PWSaE58ze63fwx(h@7k{$|k2zc2 z_Y_g5?h$xW6NhmtdFKP*lpVxOyvwE`{*z2qm+gG^CLfjQVmj-JnX{HEUZ{U&I0n#U7qelQ^CI#E- zYJ`?KZ2SQDW}|Tpd;gD#Ev`A+(2!r8rzDq^QGVb1QQwxGo^N+F5<$%=Pbn4fStc28H56zbFt*#uGUg9Mc4c7WCvv^{`g zdE6TRF)pw2O{v&FF6yN89dmMVjC6$q;p<+Zcbw=;58_8?9&!)m_O-MZ6l^9kkDp=< zTx$(%L-gllkUzH{Lx22eokv>HiuMy$s>Y``ZY>IQHBPFq!6GcU#c^D80^0l?G9FL( zov1_CZlxe-gNzdBqg{98j2D%Ly;Vdv$|ATdyJ~?oLP9B&w}#S+Wo$?ffzFE~Q2l&hsAm>fJ|bf18w-$s8L!xEpe?pl6^CdiJm;YS zI3I=Al_2D-t*Po85bfxG?R62PRsL`d*m>XUbJIH8)UN_N+nqu6%V}xZVU|4SRa7K| z4dmG1o2)=q`(XFQ9-b*zZZ#WrZ*L1up6KMVd^VRFQu_We&W)azC$cH%i&L-*)y~SS zc&eq9lTOVHuFWgi9;j^+JlfEVb)_*)AGH&*5QrvZ7FuDSmOIRZ^?Gpd=i6z@!i2+& zBddBhSPEK`=1DU6GDH!b&W8R%7`JQq$UfB67x zI~TLm5%rnXSZ|^v9-cPjv2Rt-jkmhfQHY|x+6SjTKcc6PnPfpS$YifKM_~2lm(A!# z{pmf!tw{!h(^@S$^aILMX&Ps1pTQm?qifob39u{I}$|Z)m zd$`UFPb@ffuWvFH{iXl zAa3<*GeFS4+70KVfCk)cwt=9JHmsS}x&6Vk&hzT0b@sHLHge|1=V0dtwYR2q{xWWQ z=jf%N>Dn*V1R2SUj|SL;E=PiQw58L`+{yh1a9rOM9B8R!O6MZL&eZ$^BqY&?nxELB zuOhb9p^-OjsGZI0LAGRi$58#1R&&Ls+uRtErHn?05y!m{z?R*egSHpO<>J}U`jfri zG)%6ju7^m=?tctHX}RfrVhYf0zyq&FoEh{zq9$k$f`;(b$UtV_Bb=-4K}_Kik~2WN zCFCJUA{^MuNRT6NwGy*}g&=VXun;6p0TzP9DZoOII0b|le@y6pSCf>BUp+*3V%9wzbMA8)ZH4}xE!=;TjEdaolzu)O?w~~!JF4@}JdSKXlOU8~3y43PG_9Zj5d{($~8SZ?ibovVS z!EMDOOugjP7W;OSbBs;Y7t|^&UxZV>tPrOTfe*Z>ZwJI%?2y(${;J!Pc!Ph&AyrQZ z;7~TH*B$l^!m|KozcV&`UUCMbnuK!^Er~z9Df`c!@tL$RPO!1)%3An|ZnV|hk#3B*Pl)3!nBe5hxOd$dK zy^i)y<70Jv;!@Lz2_jQQBWQx|+3iZp``FmP(odwD=WHrQ4I-{E1B8;XQSPt zPMkiy1-@%8$g&HF$*FWci0fY5Upy2rcd_=a4nCFVual3lObv%&XUPFddU%dz< zz8#z}&?;tX9VaQ~?;StLSfwtKG?Xg!|F4-ya4Zs|8oam>{hdG`?ylWYWhkofxJY zrE-df(+5<$W1EO}cs#zl^XYkbrf(`LDmHK3IyOL4{^_J^zz}_4;5d`?l5q_FySg^C zWfHGU{=U?kH@&FZ_*l{8A?)Q;HE}BY@09BP_hI*XctFa*-_LI&L3~EcSB;uiL-t)$ zA|*Pe{W%t@!f7oA+=XpzRM1f=KId}^T03kmBuIE zlRtWiyv1;tZn6e{4sQn|fqgL8dH&kvx6@RE7>bk1m*3jE{6i~qJd`EYf6$|IxcB4_ zX~{tK6-ZY|KqYsj*rp&eu(l#;E|HA<#|OdtTLg$stFPbJ*52M2{P=#2N4;^6<&X78 zYdmrj>w5eH0ve5_r<_{2hizHc`>WMQGVRk}S2@_(CDr_BpKkX>eD%;ek>4wp60{i_ z8YmjH`(xOvA}jumI5eLh6p$6AIpC8o0Xr-}p$!G3x02>+ zpM_*J+h(%!l_D(x|BTjj6Q6-2!CpFwa(H7e`GfjX-BXyL%Q^Hc6_&C7yFt6|(y##- ztXYC5{B4VbPz@TNg;j0q?LF%Ch&r@H+CMnB)wuI1hdJoTWe?vZ%z5C;7gl&7sMy(L z$FtX=oRQlE$`jbYhUQK;8#wEBNi_*g8x3|YC35@74E6fn2PH)AK?bLoAb3+uc=?oN zQwN!Ct9a!-b*XZGDO}=R zWp*Ms?MU&Rfs{l+fA;Ys!yii>jyq+ZR646oL4@3nHkETX2$XccKgkULSouk)|M!yS z8*xKY#bFo>#-BiN>>n+J(->B=@-^E#21zx?Oj4U#S`M&OMKDg>A{BYlQ9J(O!OUGN zTkV{B!YY_ps8)$jH~cnbdzpqCt~v%qbL3S8;m<+Hz-8{Vd`sJ z@%vwpB=rgZW0OMI|HInp@EYTe2XeVA+9>ygdV12YVCK$ju;^bKXK<<)t%Wo{v zB4D;RTvbKF}mCZ7#=&$8-ZD;p2&iMIn zZnN(_RsY6p{qEW3t-ecjQ7sZfxgk*P?as!T<$9e~w*{ z-+8DB2tL5Mz5ifu?7c4&YQLY9l+=POoh`wQg)LI^v1hxxyIbH)>%dj`XE~44I3bg9 zdYqrZF@k?B?hhjlruq!lP3q;t*xc;qqPV!Y;faaugi70#rAMa!n} zGRC&}Qq#%C1MwL7p90|xvRuu9U*NN}14s#LhHcp)I$WWxdh+B+erf3nc)^t0Q~a#A zw>LjOf3bsuLoTucnztdT#$y|yJQdztYklsYN41-9nnDSLy?x|BfL{t+AB*cBNW#dA zH=F+0qw+xE1@zA!U4MTW;<9)-HudU}YsTWrD%)!FXT482g;2Gv$;KT%@S+jn7 zfC;bq;kYy*bniZqP~>B{^d*QY3krCjvBf)qCZ#-nrgX^%ln#Iq4 z+5rE&z&)86%3s`1Jl9kl8Z}BYodj>j_!1WeQ?D_M-)u^2O%+DBjzM|1oIp)Y&2A3o zG&3q?>y|Coj5})zii=g{B=|3rL;(xHPrdN? zI5HRJPL5ZPFvW+XI#zT7b>fdR%BP6h@WL$I^kK_!56o2V06}b1V87(g;YR-)DEt)o z_D@n6ny@jRPigx?1^hvQg>3p@b_TwP#+6Nj8dmOP$9i9{xo yf{*~>GY7=GSIV9cG-JNt{|JzPS^{cFclJ+T9P8;Ad3sJDj6IgN7Wd8FzWXQCrU%mi From 1212fb00302a1511d2939a52e270defec8d3bdb9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 16:14:21 +0100 Subject: [PATCH 205/387] Update custom_lint --- examples/counter/pubspec.yaml | 2 +- packages/riverpod_analyzer_utils/pubspec.yaml | 2 +- packages/riverpod_lint/pubspec.yaml | 2 +- packages/riverpod_lint_flutter_test/pubspec.yaml | 2 +- website/pubspec.yaml | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/examples/counter/pubspec.yaml b/examples/counter/pubspec.yaml index 1fbc08ec0..270a678a0 100644 --- a/examples/counter/pubspec.yaml +++ b/examples/counter/pubspec.yaml @@ -24,7 +24,7 @@ dependencies: dev_dependencies: build_runner: ^2.3.3 - custom_lint: ^0.5.2 + custom_lint: ^0.6.0 flutter_test: sdk: flutter freezed: ^2.3.2 diff --git a/packages/riverpod_analyzer_utils/pubspec.yaml b/packages/riverpod_analyzer_utils/pubspec.yaml index 254146a86..680ba9200 100644 --- a/packages/riverpod_analyzer_utils/pubspec.yaml +++ b/packages/riverpod_analyzer_utils/pubspec.yaml @@ -13,7 +13,7 @@ dependencies: analyzer: ">=5.12.0 <7.0.0" collection: ^1.16.0 crypto: ^3.0.2 - custom_lint_core: ^0.5.2 + custom_lint_core: ^0.6.0 freezed_annotation: ^2.2.0 meta: ^1.7.0 path: ^1.8.0 diff --git a/packages/riverpod_lint/pubspec.yaml b/packages/riverpod_lint/pubspec.yaml index 97d81cdfd..dfc3e1390 100644 --- a/packages/riverpod_lint/pubspec.yaml +++ b/packages/riverpod_lint/pubspec.yaml @@ -14,7 +14,7 @@ dependencies: analyzer: ">=6.0.0 <7.0.0" analyzer_plugin: ^0.11.2 collection: ^1.16.0 - custom_lint_builder: ^0.5.2 + custom_lint_builder: ^0.6.0 meta: ^1.7.0 path: ^1.8.1 riverpod: ^3.0.0-dev.3 diff --git a/packages/riverpod_lint_flutter_test/pubspec.yaml b/packages/riverpod_lint_flutter_test/pubspec.yaml index ee7b99ace..23783399d 100644 --- a/packages/riverpod_lint_flutter_test/pubspec.yaml +++ b/packages/riverpod_lint_flutter_test/pubspec.yaml @@ -15,7 +15,7 @@ dependencies: dev_dependencies: build_runner: ^2.4.6 - custom_lint: ^0.5.2 + custom_lint: ^0.6.0 freezed: ^2.3.2 json_serializable: ^6.6.1 riverpod_lint: diff --git a/website/pubspec.yaml b/website/pubspec.yaml index 9c8e77974..d1dd58a9c 100644 --- a/website/pubspec.yaml +++ b/website/pubspec.yaml @@ -25,7 +25,7 @@ dependencies: dev_dependencies: build_runner: - custom_lint: ^0.5.11 + custom_lint: ^0.6.0 flutter_test: sdk: flutter freezed: ^2.2.0 From 0cf51e53b55e0166b64025300c49d391446f42fa Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 16:15:22 +0100 Subject: [PATCH 206/387] Fix command failure --- packages/riverpod_lint_flutter_test/pubspec_overrides.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml b/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml index 7bf01aa5b..41a9f29fa 100644 --- a/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml +++ b/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml @@ -14,5 +14,6 @@ dependency_overrides: path: ../riverpod_annotation riverpod_lint: path: ../riverpod_lint - test_api: ^0.6.1 + + # hotreloader stuff vm_service: ^14.0.0 \ No newline at end of file From b2ad2d15d85778271ea2df5728e644401b273a43 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 16:52:31 +0100 Subject: [PATCH 207/387] Sync dev with master (#3332) --- .github/PULL_REQUEST_TEMPLATE.md | 34 + CONTRIBUTING.md | 4 +- all_lint_rules.yaml | 2 + examples/counter/README.md | 2 +- examples/counter/pubspec.yaml | 2 +- .../marvel/lib/src/configuration.freezed.dart | 4 +- examples/marvel/lib/src/marvel.freezed.dart | 12 +- examples/marvel/lib/src/result.freezed.dart | 6 +- examples/marvel/lib/src/screens/home.dart | 7 +- .../marvel/lib/src/screens/home.freezed.dart | 6 +- examples/marvel/pubspec.yaml | 2 +- examples/pub/lib/pub_repository.freezed.dart | 20 +- .../stackoverflow/lib/question.freezed.dart | 8 +- examples/stackoverflow/lib/tag.freezed.dart | 4 +- examples/stackoverflow/lib/user.freezed.dart | 6 +- packages/flutter_riverpod/CHANGELOG.md | 5 + .../flutter_riverpod/lib/src/consumer.dart | 3 - .../flutter_riverpod/lib/src/framework.dart | 2 +- packages/flutter_riverpod/pubspec.yaml | 4 +- packages/hooks_riverpod/CHANGELOG.md | 5 + packages/hooks_riverpod/pubspec.yaml | 4 +- packages/riverpod/CHANGELOG.md | 625 +++++++++------- .../riverpod/example/lib/models.freezed.dart | 10 +- packages/riverpod/lib/src/common.dart | 25 +- .../lib/src/framework/foundation.dart | 5 + packages/riverpod/lib/src/result.dart | 4 +- packages/riverpod/pubspec.yaml | 4 +- .../test/framework/async_value_test.dart | 38 + .../test/framework/select_async_test.dart | 1 - packages/riverpod_analyzer_utils/CHANGELOG.md | 6 +- packages/riverpod_analyzer_utils/pubspec.yaml | 2 +- .../generator_provider_declaration_test.dart | 2 +- packages/riverpod_annotation/CHANGELOG.md | 4 + .../lib/src/riverpod_annotation.dart | 71 +- packages/riverpod_generator/CHANGELOG.md | 11 + .../src/templates/class_based_provider.dart | 4 + .../lib/src/templates/family.dart | 3 + .../lib/src/validation.dart | 31 + .../riverpod_generator/test/error_test.dart | 147 ++++ .../test/integration/generated.freezed.dart | 4 +- packages/riverpod_lint/CHANGELOG.md | 11 + .../convert_to_stateful_base_widget.dart | 124 ++++ .../convert_to_stateless_base_widget.dart | 270 +++++-- .../src/assists/convert_to_widget_utils.dart | 30 + .../lints/async_value_nullable_pattern.dart | 10 +- packages/riverpod_lint/pubspec.yaml | 2 +- .../riverpod_lint_flutter_test/pubspec.yaml | 3 +- .../pubspec_overrides.yaml | 4 +- ...rt_class_based_provider_to_functional.diff | 78 ++ ...rt_class_based_provider_to_functional.json | 1 - ...ass_based_provider_to_functional_test.dart | 16 +- ...rt_functional_provider_to_class_based.diff | 33 + ...rt_functional_provider_to_class_based.json | 1 - ...nctional_provider_to_class_based_test.dart | 16 +- .../convert_to_consumer_stateful_widget.diff | 308 ++++++++ .../convert_to_consumer_stateful_widget.json | 1 - .../convert_to_consumer_widget.diff | 330 +++++++++ .../convert_to_consumer_widget.json | 1 - .../convert_to_hook_consumer_widget.diff | 318 +++++++++ .../convert_to_hook_consumer_widget.json | 1 - .../convert_to_hook_widget.diff | 314 ++++++++ .../convert_to_hook_widget.json | 1 - ...vert_to_stateful_hook_consumer_widget.diff | 320 +++++++++ ...vert_to_stateful_hook_consumer_widget.json | 1 - .../convert_to_stateful_hook_widget.diff | 346 +++++++++ .../convert_to_stateful_hook_widget.json | 1 - .../convert_to_stateful_widget.diff | 245 +++++++ .../convert_to_stateful_widget.json | 1 - .../convert_to_stateless_widget.diff | 240 +++++++ .../convert_to_stateless_widget.json | 1 - .../convert_to_widget/convert_to_widget.dart | 85 +++ .../convert_to_widget_test.dart | 76 +- .../test/assists/empty.diff | 0 .../test/assists/empty.json | 1 - .../assists/wrap_widget/wrap_widget_test.dart | 22 +- .../wrap_widget/wrap_with_consumer.diff | 28 + .../wrap_widget/wrap_with_consumer.json | 1 - .../wrap_widget/wrap_with_provider_scope.diff | 28 + .../wrap_widget/wrap_with_provider_scope.json | 1 - .../test/golden.dart | 45 +- .../async_value_nullable_pattern.dart | 23 + .../fix/async_value_nullable_pattern.diff | 24 + .../fix/async_value_nullable_pattern.json | 1 - .../async_value_nullable_pattern_test.dart | 16 +- .../lints/functional_ref/functional_ref.diff | 46 ++ .../lints/functional_ref/functional_ref.json | 1 - .../functional_ref/functional_ref_test.dart | 14 +- .../notifier_build/fix/notifier_build.diff | 16 + .../notifier_build/fix/notifier_build.json | 1 - .../fix/notifier_build_test.dart | 15 +- .../notifier_extends/notifier_extends.diff | 60 ++ .../notifier_extends/notifier_extends.json | 1 - .../notifier_extends_test.dart | 15 +- .../provider_dependencies.diff | 137 ++++ .../provider_dependencies.json | 1 - .../provider_dependencies_test.dart | 15 +- .../lints/provider_parameters.freezed.dart | 4 +- website/docs/case_studies/cancel.mdx | 2 +- .../cancel/detail_screen/codegen.freezed.dart | 4 +- .../activity/codegen.freezed.dart | 4 +- .../full_app/codegen.freezed.dart | 4 +- .../todo_list_provider/codegen.freezed.dart | 4 +- .../why_immutability/codegen.freezed.dart | 4 +- .../docs/essentials/combining_requests.mdx | 22 +- website/docs/essentials/faq.mdx | 2 +- website/docs/essentials/first_request.mdx | 2 +- .../codegen/activity.freezed.dart | 4 +- website/docs/essentials/side_effects.mdx | 2 +- .../codegen/todo_list_notifier.freezed.dart | 4 +- .../codegen/todo_list_provider.freezed.dart | 4 +- website/docs/essentials/testing.mdx | 2 +- .../from_provider/helpers/item.freezed.dart | 4 +- website/docs/from_provider/quickstart.mdx | 5 +- .../remote_todos/codegen.freezed.dart | 4 +- .../todos/codegen.freezed.dart | 4 +- .../current.json | 6 +- .../current/cookbooks/refresh.mdx | 10 + .../current/cookbooks/search_as_we_type.mdx | 133 ++++ .../current/cookbooks/testing_dart.dart | 51 ++ .../current/cookbooks/testing_flutter.dart | 39 + .../current/cookbooks/testing_full.dart | 98 +++ .../cookbooks/testing_original_test_dart.dart | 64 ++ .../testing_original_test_flutter.dart | 56 ++ .../cookbooks/testing_override_info.dart | 42 ++ .../current/cookbooks/testing_repository.dart | 22 + .../remote_todos/codegen.freezed.dart | 4 +- .../todos/codegen.freezed.dart | 4 +- .../current.json | 20 + .../current/advanced/select.mdx | 65 ++ .../advanced/select/select/codegen.dart | 30 + .../advanced/select/select/codegen.g.dart | 26 + .../current/advanced/select/select/index.ts | 4 + .../current/advanced/select/select/raw.dart | 29 + .../advanced/select/select_async/codegen.dart | 26 + .../select/select_async/codegen.g.dart | 26 + .../advanced/select/select_async/index.ts | 4 + .../advanced/select/select_async/raw.dart | 23 + .../current/case_studies/cancel.mdx | 139 ++++ .../cancel/detail_screen/codegen.dart | 61 ++ .../cancel/detail_screen/codegen.freezed.dart | 209 ++++++ .../cancel/detail_screen/codegen.g.dart | 46 ++ .../cancel/detail_screen/index.ts | 4 + .../cancel/detail_screen/raw.dart | 65 ++ .../cancel/detail_screen_cancel/codegen.dart | 28 + .../detail_screen_cancel/codegen.g.dart | 26 + .../cancel/detail_screen_cancel/index.ts | 4 + .../cancel/detail_screen_cancel/raw.dart | 25 + .../detail_screen_debounce/codegen.dart | 38 + .../detail_screen_debounce/codegen.g.dart | 26 + .../cancel/detail_screen_debounce/index.ts | 4 + .../cancel/detail_screen_debounce/raw.dart | 35 + .../case_studies/cancel/extension.dart | 32 + .../case_studies/cancel/home_screen.dart | 39 + .../provider_with_extension/codegen.dart | 26 + .../provider_with_extension/codegen.g.dart | 26 + .../cancel/provider_with_extension/index.ts | 4 + .../cancel/provider_with_extension/raw.dart | 23 + .../current/case_studies/pull_to_refresh.mdx | 127 ++++ .../pull_to_refresh/activity/codegen.dart | 19 + .../activity/codegen.freezed.dart | 209 ++++++ .../pull_to_refresh/activity/codegen.g.dart | 25 + .../pull_to_refresh/activity/index.ts | 4 + .../pull_to_refresh/activity/raw.dart | 24 + .../pull_to_refresh/display_activity.dart | 22 + .../pull_to_refresh/display_activity2.dart | 28 + .../pull_to_refresh/display_activity3.dart | 31 + .../pull_to_refresh/display_activity4.dart | 35 + .../fetch_activity/codegen.dart | 20 + .../fetch_activity/codegen.g.dart | 26 + .../pull_to_refresh/fetch_activity/index.ts | 4 + .../pull_to_refresh/fetch_activity/raw.dart | 17 + .../pull_to_refresh/full_app/codegen.dart | 69 ++ .../full_app/codegen.freezed.dart | 209 ++++++ .../pull_to_refresh/full_app/codegen.g.dart | 46 ++ .../pull_to_refresh/full_app/index.ts | 4 + .../pull_to_refresh/full_app/raw.dart | 73 ++ .../concepts/about_code_generation.mdx | 372 ++++++++++ .../current/concepts}/about_codegen/main.dart | 0 .../concepts}/about_codegen/main.g.dart | 0 .../provider_type/async_class_future.dart | 14 + .../provider_type/async_class_future.g.dart | 27 + .../provider_type/async_class_stream.dart | 14 + .../provider_type/async_class_stream.g.dart | 27 + .../provider_type/async_fn_future.dart | 9 + .../provider_type/async_fn_future.g.dart | 26 + .../provider_type/async_fn_stream.dart | 9 + .../provider_type/async_fn_stream.g.dart | 26 + .../provider_type/auto_dispose.dart | 12 + .../provider_type/auto_dispose.g.dart | 40 ++ .../about_codegen/provider_type/family.dart | 7 + .../about_codegen/provider_type/family.g.dart | 200 ++++++ .../provider_type/family_class.dart | 17 + .../provider_type/family_class.g.dart | 245 +++++++ .../provider_type/family_fn.dart | 13 + .../provider_type/family_fn.g.dart | 224 ++++++ .../non_code_gen/async_notifier_provider.dart | 15 + .../non_code_gen/auto_dispose.dart | 12 + .../provider_type/non_code_gen/family.dart | 6 + .../non_code_gen/future_provider.dart | 7 + .../non_code_gen/notifier_provider.dart | 15 + .../provider_type/non_code_gen/provider.dart | 8 + .../stream_notifier_provider.dart | 15 + .../non_code_gen/stream_provider.dart | 7 + .../provider_type/sync_class.dart | 14 + .../provider_type/sync_class.g.dart | 26 + .../about_codegen/provider_type/sync_fn.dart | 9 + .../provider_type/sync_fn.g.dart | 26 + .../current/concepts}/about_codegen/raw.dart | 2 +- .../current/concepts/about_hooks.mdx | 317 +++++++++ .../about_hooks/hook_and_consumer.dart | 28 + .../concepts/about_hooks/hook_consumer.dart | 26 + .../about_hooks/hook_consumer_widget.dart | 23 + .../concepts/async_initialization.dart | 58 ++ .../characters_provider/codegen.dart | 29 + .../characters_provider/codegen.g.dart | 40 ++ .../characters_provider/index.tsx | 9 + .../characters_provider/models.dart | 17 + .../characters_provider/raw.dart | 25 + .../city_provider/codegen.dart | 7 + .../city_provider/codegen.g.dart | 26 + .../city_provider/index.tsx | 9 + .../city_provider/raw.dart | 4 + .../filtered_todo_list_provider/codegen.dart | 31 + .../codegen.g.dart | 27 + .../filtered_todo_list_provider/index.tsx | 9 + .../filtered_todo_list_provider/raw.dart | 26 + .../read_in_provider/codegen.dart | 17 + .../read_in_provider/codegen.g.dart | 40 ++ .../read_in_provider/index.tsx | 9 + .../read_in_provider/raw.dart | 13 + .../select_async_provider/codegen.dart | 25 + .../select_async_provider/codegen.g.dart | 40 ++ .../select_async_provider/index.tsx | 9 + .../select_async_provider/models.dart | 21 + .../select_async_provider/raw.dart | 20 + .../todo_list_provider/codegen.dart | 24 + .../todo_list_provider/codegen.freezed.dart | 166 +++++ .../todo_list_provider/codegen.g.dart | 27 + .../todo_list_provider/index.tsx | 9 + .../todo_list_provider/raw.dart | 36 + .../weather_provider/codegen.dart | 20 + .../weather_provider/codegen.g.dart | 40 ++ .../weather_provider/index.tsx | 9 + .../weather_provider/raw.dart | 18 + .../whole_object_provider/codegen.dart | 24 + .../whole_object_provider/codegen.g.dart | 40 ++ .../whole_object_provider/index.tsx | 9 + .../whole_object_provider/models.dart | 16 + .../whole_object_provider/raw.dart | 20 + .../current/concepts/combining_providers.mdx | 278 +++----- .../current/concepts/dialog_scope.dart | 58 ++ .../lifecycle_on_dispose/codegen.dart | 21 + .../lifecycle_on_dispose/codegen.g.dart | 26 + .../concepts/lifecycle_on_dispose/index.tsx | 9 + .../concepts/lifecycle_on_dispose/raw.dart} | 2 +- .../concepts/modifiers/auto_dispose.mdx | 101 +-- .../current/concepts/modifiers/family.mdx | 93 +-- .../current/concepts/provider_lifecycles.mdx | 107 +++ .../current/concepts/provider_observer.mdx | 37 +- .../concepts/provider_observer_logger.dart | 5 +- .../current/concepts/providers.mdx | 199 +++--- .../creating_a_provider/codegen.dart | 12 + .../creating_a_provider/codegen.g.dart | 26 + .../providers/creating_a_provider/index.tsx | 9 + .../providers/creating_a_provider/raw.dart | 9 + .../declaring_many_providers/codegen.dart | 11 + .../declaring_many_providers/codegen.g.dart | 40 ++ .../declaring_many_providers/index.tsx | 9 + .../declaring_many_providers/raw.dart | 6 + .../current/concepts/reading.mdx | 472 +++++++------ .../consumer_hook.dart} | 7 +- .../consumer_stateful_widget/hooks.dart} | 11 +- .../consumer_stateful_widget/index.tsx | 9 + .../consumer_stateful_widget/raw.dart} | 7 +- .../consumer_widget/hooks.dart} | 7 +- .../reading/consumer_widget/index.tsx | 9 + .../consumer_widget/raw.dart} | 4 +- .../concepts/reading/counter/codegen.dart | 23 + .../concepts/reading/counter/codegen.g.dart | 26 + .../concepts/reading/counter/index.tsx | 9 + .../counter/raw.dart} | 2 +- .../concepts/reading/listen/codegen.dart | 16 + .../concepts/reading/listen/codegen.g.dart | 26 + .../current/concepts/reading/listen/index.tsx | 9 + .../current/concepts/reading/listen/raw.dart} | 6 +- .../reading/listen_build/codegen.dart | 28 + .../reading/listen_build/codegen.g.dart | 26 + .../reading/listen_build/codegen_hooks.dart | 34 + .../reading/listen_build/codegen_hooks.g.dart | 26 + .../concepts/reading/listen_build/index.tsx | 11 + .../listen_build/raw.dart} | 9 +- .../reading/listen_build/raw_hooks.dart | 29 + .../concepts/reading/provider/codegen.dart | 20 + .../concepts/reading/provider/codegen.g.dart | 40 ++ .../concepts/reading/provider/index.tsx | 9 + .../concepts/reading/provider/raw.dart | 19 + .../concepts/reading/read/codegen.dart | 32 + .../concepts/reading/read/codegen.g.dart | 26 + .../concepts/reading/read/codegen_hooks.dart | 36 + .../reading/read/codegen_hooks.g.dart | 26 + .../current/concepts/reading/read/index.tsx | 11 + .../read/raw.dart} | 6 +- .../concepts/reading/read/raw_hooks.dart | 31 + .../concepts/reading/read_build/codegen.dart | 25 + .../reading/read_build/codegen.g.dart | 26 + .../concepts/reading/read_build/index.tsx | 9 + .../read_build/raw.dart} | 2 +- .../reading/read_notifier_build/codegen.dart | 24 + .../read_notifier_build/codegen.g.dart | 26 + .../reading/read_notifier_build/index.tsx | 9 + .../reading/read_notifier_build/raw.dart} | 2 +- .../concepts/reading/watch/codegen.dart | 45 ++ .../concepts/reading/watch/codegen.g.dart | 55 ++ .../current/concepts/reading/watch/index.tsx | 9 + .../watch/raw.dart} | 6 +- .../concepts/reading/watch_build/codegen.dart | 39 + .../reading/watch_build/codegen.g.dart | 41 ++ .../reading/watch_build/codegen_hooks.dart | 43 ++ .../reading/watch_build/codegen_hooks.g.dart | 41 ++ .../concepts/reading/watch_build/index.tsx | 11 + .../watch_build/raw.dart} | 2 +- .../reading/watch_build/raw_hooks.dart | 37 + .../reading/watch_notifier_build/codegen.dart | 24 + .../watch_notifier_build/codegen.g.dart | 26 + .../reading/watch_notifier_build/index.tsx | 9 + .../watch_notifier_build/raw.dart} | 0 .../current/concepts/scopes.mdx | 180 +++++ .../current/concepts/subtree_scope.dart | 78 ++ .../current/concepts/theme_scope.dart | 68 ++ .../current/concepts/why_immutability.mdx | 92 +++ .../concepts/why_immutability/codegen.dart | 58 ++ .../why_immutability/codegen.freezed.dart | 151 ++++ .../concepts/why_immutability/codegen.g.dart | 28 + .../concepts/why_immutability/index.tsx | 9 + .../concepts/why_immutability/raw.dart | 67 ++ .../current/cookbooks/search_as_we_type.mdx | 69 +- .../current/cookbooks/testing.mdx | 130 ++-- .../current/cookbooks/testing_dart.dart | 60 +- .../current/cookbooks/testing_flutter.dart | 32 +- .../current/cookbooks/testing_full.dart | 38 +- .../cookbooks/testing_original_test_dart.dart | 26 +- .../testing_original_test_flutter.dart | 16 +- .../cookbooks/testing_override_info.dart | 2 +- .../current/cookbooks/testing_repository.dart | 10 +- .../current/essentials/auto_dispose.mdx | 166 +++++ .../auto_dispose/cache_for_extension.dart | 18 + .../auto_dispose/cache_for_usage/codegen.dart | 17 + .../cache_for_usage/codegen.g.dart | 26 + .../auto_dispose/cache_for_usage/index.ts | 4 + .../auto_dispose/cache_for_usage/raw.dart | 15 + .../auto_dispose/codegen_keep_alive.dart | 11 + .../auto_dispose/codegen_keep_alive.g.dart | 26 + .../auto_dispose/invalidate_example.dart | 23 + .../invalidate_family_example/codegen.dart | 24 + .../invalidate_family_example/codegen.g.dart | 200 ++++++ .../invalidate_family_example/index.ts | 4 + .../invalidate_family_example/raw.dart | 20 + .../auto_dispose/keep_alive/codegen.dart | 21 + .../auto_dispose/keep_alive/codegen.g.dart | 26 + .../auto_dispose/keep_alive/index.ts | 4 + .../auto_dispose/keep_alive/raw.dart | 19 + .../on_dispose_example/codegen.dart | 23 + .../on_dispose_example/codegen.g.dart | 40 ++ .../auto_dispose/on_dispose_example/index.ts | 4 + .../auto_dispose/on_dispose_example/raw.dart | 17 + .../auto_dispose/raw_auto_dispose.dart | 7 + .../current/essentials/combining_requests.mdx | 140 ++++ .../functional_ref/codegen.dart | 18 + .../functional_ref/codegen.g.dart | 40 ++ .../functional_ref/index.ts | 4 + .../functional_ref/raw.dart | 14 + .../listen_example/codegen.dart | 17 + .../listen_example/codegen.g.dart | 26 + .../listen_example/index.ts | 4 + .../listen_example/raw.dart | 13 + .../notifier_ref/codegen.dart | 21 + .../notifier_ref/codegen.g.dart | 40 ++ .../combining_requests/notifier_ref/index.ts | 4 + .../combining_requests/notifier_ref/raw.dart | 19 + .../read_example/codegen.dart | 23 + .../read_example/codegen.g.dart | 27 + .../combining_requests/read_example/index.ts | 4 + .../combining_requests/read_example/raw.dart | 22 + .../watch_example/codegen.dart | 44 ++ .../watch_example/codegen.g.dart | 44 ++ .../combining_requests/watch_example/index.ts | 4 + .../combining_requests/watch_example/raw.dart | 40 ++ .../watch_placement/codegen.dart | 37 + .../watch_placement/codegen.g.dart | 41 ++ .../watch_placement/index.ts | 4 + .../watch_placement/raw.dart | 35 + .../current/essentials/do_dont.mdx | 151 ++++ .../essentials/eager_initialization.mdx | 64 ++ .../async_consumer_example.dart | 28 + .../consumer_example.dart | 36 + .../require_value/codegen.dart | 24 + .../require_value/codegen.g.dart | 26 + .../require_value/index.ts | 4 + .../require_value/raw.dart | 20 + .../current/essentials/faq.mdx | 183 +++++ .../current/essentials/first_request.mdx | 333 +++++++++ .../essentials/first_request/activity.ts | 9 + .../first_request/codegen/activity.dart | 24 + .../codegen/activity.freezed.dart | 237 +++++++ .../first_request/codegen/activity.g.dart | 27 + .../first_request/codegen/provider.dart | 23 + .../first_request/codegen/provider.g.dart | 29 + .../essentials/first_request/consumer.ts | 8 + .../first_request/consumer_stateful_widget.ts | 8 + .../first_request/consumer_widget.ts | 8 + .../first_request/hook_consumer_widget.ts | 8 + .../first_request/legend/DocuCode.scss | 18 + .../first_request/legend/legend.tsx | 88 +++ .../essentials/first_request/provider.ts | 9 + .../first_request/raw/activity.dart | 30 + .../first_request/raw/consumer.dart | 42 ++ .../raw/consumer_stateful_widget.dart | 43 ++ .../first_request/raw/consumer_widget.dart | 25 + .../raw/hook_consumer_widget.dart | 28 + .../first_request/raw/provider.dart | 17 + .../current/essentials/passing_args.mdx | 155 ++++ .../passing_args/codegen/family.dart | 31 + .../passing_args/codegen/family.g.dart | 200 ++++++ .../passing_args/codegen/provider.dart | 33 + .../passing_args/codegen/provider.g.dart | 232 ++++++ .../passing_args/no_arg_provider.ts | 9 + .../passing_args/raw/consumer_family.dart | 24 + .../raw/consumer_list_family.dart | 23 + .../passing_args/raw/consumer_provider.dart | 20 + .../raw/consumer_tuple_family.dart | 24 + .../essentials/passing_args/raw/family.dart | 41 ++ .../raw/multiple_consumer_family.dart | 37 + .../essentials/passing_args/raw/provider.dart | 28 + .../passing_args/raw/tuple_family.dart | 33 + .../current/essentials/provider_observer.mdx | 49 ++ .../provider_observer/provider_observer.dart | 43 ++ .../current/essentials/side_effects.mdx | 426 +++++++++++ .../codegen/todo_list_notifier.dart | 28 + .../codegen/todo_list_notifier.freezed.dart | 166 +++++ .../codegen/todo_list_notifier.g.dart | 42 ++ .../codegen/todo_list_notifier_add_todo.dart | 26 + .../todo_list_notifier_add_todo.g.dart | 27 + .../codegen/todo_list_provider.dart | 23 + .../codegen/todo_list_provider.freezed.dart | 148 ++++ .../codegen/todo_list_provider.g.dart | 26 + .../raw/consumer_add_todo_call.dart | 23 + .../raw/invalidate_self_add_todo.dart | 37 + .../side_effects/raw/manual_add_todo.dart | 40 ++ .../raw/mutable_manual_add_todo.dart | 34 + .../side_effects/raw/render_add_todo.dart | 77 ++ .../raw/render_add_todo_hooks.dart | 68 ++ .../side_effects/raw/rest_add_todo.dart | 38 + .../side_effects/raw/todo_list_notifier.dart | 43 ++ .../raw/todo_list_notifier_add_todo.dart | 27 + .../side_effects/raw/todo_list_provider.dart | 27 + .../side_effects/render_add_todo.ts | 9 + .../side_effects/todo_list_notifier.ts | 9 + .../todo_list_notifier_add_todo.ts | 9 + .../side_effects/todo_list_provider.ts | 7 + .../current/essentials/testing.mdx | 160 +++++ .../testing/auto_dispose_listen.dart | 24 + .../essentials/testing/await_future.dart | 30 + .../essentials/testing/create_container.dart | 22 + .../essentials/testing/full_widget_test.dart | 33 + .../essentials/testing/listen_provider.dart | 22 + .../essentials/testing/mock_provider.dart | 45 ++ .../testing/notifier_mock/codegen.dart | 17 + .../testing/notifier_mock/codegen.g.dart | 27 + .../essentials/testing/notifier_mock/index.ts | 4 + .../essentials/testing/notifier_mock/raw.dart | 14 + .../testing/provider_to_mock/codegen.dart | 9 + .../testing/provider_to_mock/codegen.g.dart | 26 + .../testing/provider_to_mock/index.ts | 4 + .../testing/provider_to_mock/raw.dart | 6 + .../current/essentials/testing/unit_test.dart | 23 + .../testing/widget_container_of.dart | 15 + .../essentials/testing/widget_test.dart | 22 + .../current/essentials/websockets_sync.mdx | 108 +++ .../change_notifier_provider.dart | 11 + .../websockets_sync/pipe_change_notifier.dart | 22 + .../pipe_change_notifier.g.dart | 29 + .../essentials/websockets_sync/raw_usage.dart | 30 + .../websockets_sync/raw_usage.g.dart | 26 + .../shared_pipe_change_notifier.dart | 29 + .../shared_pipe_change_notifier.g.dart | 42 ++ .../stream_provider/codegen.dart | 34 + .../stream_provider/codegen.g.dart | 27 + .../websockets_sync/stream_provider/index.ts | 4 + .../websockets_sync/stream_provider/raw.dart | 30 + .../websockets_sync/sync_consumer.dart | 19 + .../sync_definition/codegen.dart | 10 + .../sync_definition/codegen.g.dart | 28 + .../websockets_sync/sync_definition/index.ts | 4 + .../websockets_sync/sync_definition/raw.dart | 7 + .../current/from_provider/family/family.dart | 11 + .../from_provider/family/family.g.dart | 222 ++++++ .../current/from_provider/family/index.tsx | 9 + .../current/from_provider/family/raw.dart | 27 + .../current/from_provider/helpers/item.dart | 12 + .../from_provider/helpers/item.freezed.dart | 146 ++++ .../current/from_provider/helpers/item.g.dart | 18 + .../current/from_provider/helpers/json.dart | 1 + .../motivation/async_values/async_values.dart | 29 + .../async_values/async_values.g.dart | 40 ++ .../motivation/async_values/index.tsx | 9 + .../motivation/async_values/raw.dart | 25 + .../motivation/auto_dispose/auto_dispose.dart | 28 + .../auto_dispose/auto_dispose.g.dart | 41 ++ .../motivation/auto_dispose/index.tsx | 9 + .../motivation/auto_dispose/raw.dart | 23 + .../motivation/combine/combine.dart | 19 + .../motivation/combine/combine.g.dart | 40 ++ .../motivation/combine/index.tsx | 9 + .../from_provider/motivation/combine/raw.dart | 15 + .../from_provider/motivation/motivation.mdx | 189 +++++ .../motivation/override/index.tsx | 9 + .../motivation/override/override.dart | 16 + .../motivation/override/raw.dart | 16 + .../motivation/same_type/index.tsx | 9 + .../motivation/same_type/raw.dart | 15 + .../motivation/same_type/same_type.dart | 19 + .../motivation/same_type/same_type.g.dart | 40 ++ .../motivation/side_effects/index.tsx | 9 + .../motivation/side_effects/raw.dart | 24 + .../motivation/side_effects/side_effects.dart | 24 + .../from_provider/provider_vs_riverpod.mdx | 401 +++++++++++ .../current/from_provider/quickstart.mdx | 197 ++++++ .../current/getting_started.mdx | 237 ------- .../current/getting_started_hello_world.dart | 20 - .../getting_started_hello_world_hooks.dart | 38 - .../current/introduction/getting_started.mdx | 195 +++++ .../dart_hello_world/index.tsx | 0 .../dart_hello_world/main.dart | 8 +- .../dart_hello_world/main.g.dart | 0 .../getting_started/dart_hello_world/raw.dart | 0 .../getting_started/dart_pub_add.tsx | 32 + .../getting_started/dart_pubspec.tsx | 12 +- .../hello_world/hooks_codegen/main.dart | 46 ++ .../hello_world/hooks_codegen}/main.g.dart | 0 .../getting_started/hello_world/index.tsx | 4 +- .../getting_started/hello_world/main.dart | 16 +- .../getting_started/hello_world}/main.g.dart | 0 .../getting_started/hello_world/raw.dart} | 16 +- .../hello_world/raw_hooks.dart | 40 ++ .../introduction/getting_started/pub_add.tsx | 39 + .../introduction/getting_started/pubspec.tsx | 51 ++ .../current/introduction/why_riverpod.mdx | 60 ++ .../introduction/why_riverpod/codegen.dart | 31 + .../introduction/why_riverpod/codegen.g.dart | 227 ++++++ .../introduction/why_riverpod/index.tsx | 9 + .../introduction/why_riverpod/raw.dart | 27 + .../current/migration/0.13.0_to_0.14.0.mdx | 62 +- .../current/migration/0.14.0_to_1.0.0.mdx | 113 +-- .../migration/from_change_notifier.mdx | 132 ++++ .../declaration/declaration.dart | 33 + .../declaration/declaration.g.dart | 27 + .../declaration/index.tsx | 9 + .../from_change_notifier/declaration/raw.dart | 33 + .../initialization/index.tsx | 9 + .../initialization/initialization.dart | 29 + .../initialization/initialization.g.dart | 27 + .../initialization/raw.dart | 29 + .../from_change_notifier/migrated/index.tsx | 9 + .../migrated/migrated.dart | 37 + .../migrated/migrated.g.dart | 27 + .../from_change_notifier/migrated/raw.dart | 37 + .../migration/from_change_notifier/old.dart | 60 ++ .../current/migration/from_state_notifier.mdx | 264 +++++++ .../add_listener/add_listener.dart | 18 + .../add_listener/add_listener.g.dart | 27 + .../add_listener/index.tsx | 9 + .../from_state_notifier/add_listener/raw.dart | 17 + .../from_state_notifier/add_listener_old.dart | 24 + .../async_notifier/async_notifier.dart | 28 + .../async_notifier/async_notifier.g.dart | 29 + .../async_notifier/index.tsx | 9 + .../async_notifier/raw.dart | 29 + .../async_notifier_old.dart | 30 + .../build_init/build_init.dart | 15 + .../build_init/build_init.g.dart | 28 + .../from_state_notifier/build_init/index.tsx | 9 + .../from_state_notifier/build_init/raw.dart | 15 + .../from_state_notifier/build_init_old.dart | 13 + .../consumers_dont_change.dart | 36 + .../family_and_dispose.dart | 24 + .../family_and_dispose.g.dart | 219 ++++++ .../family_and_dispose/index.tsx | 9 + .../family_and_dispose/raw.dart | 27 + .../family_and_dispose_old.dart | 30 + .../from_state_provider.dart | 14 + .../from_state_provider.g.dart | 28 + .../from_state_provider/index.tsx | 9 + .../from_state_provider/raw.dart | 13 + .../from_state_provider_old.dart | 6 + .../obtain_notifier_on_tests.dart | 33 + .../old_lifecycles/index.tsx | 9 + .../old_lifecycles/old_lifecycles.dart | 36 + .../old_lifecycles/old_lifecycles.g.dart | 27 + .../old_lifecycles/raw.dart | 35 + .../old_lifecycles_final/index.tsx | 9 + .../old_lifecycles_final.dart | 38 + .../old_lifecycles_final.g.dart | 27 + .../old_lifecycles_final/raw.dart | 36 + .../old_lifecycles_old.dart | 42 ++ .../current/migration/utils.dart | 23 + .../providers/change_notifier_provider.mdx | 55 ++ .../change_notifier_provider/todos.dart | 45 ++ .../todos_consumer.dart | 32 + .../current/providers/future_provider.mdx | 65 +- .../config_consumer/codegen.dart | 16 + .../config_consumer/hooks.dart | 21 + .../config_consumer/hooks_codegen.dart | 22 + .../future_provider/config_consumer/index.tsx | 11 + .../future_provider/config_consumer/raw.dart | 18 + .../config_provider/codegen.dart | 22 + .../config_provider/codegen.g.dart | 29 + .../future_provider/config_provider/index.tsx | 9 + .../future_provider/config_provider/raw.dart | 22 + .../current/providers/notifier_provider.mdx | 55 ++ .../remote_todos/codegen.dart | 82 +++ .../remote_todos/codegen.freezed.dart | 184 +++++ .../remote_todos/codegen.g.dart | 44 ++ .../notifier_provider/remote_todos/index.tsx | 9 + .../notifier_provider/remote_todos/raw.dart | 101 +++ .../remote_todos/todos_consumer.dart | 37 + .../notifier_provider/todos/codegen.dart | 68 ++ .../todos/codegen.freezed.dart | 166 +++++ .../notifier_provider/todos/codegen.g.dart | 26 + .../notifier_provider/todos/index.tsx | 9 + .../notifier_provider/todos/raw.dart | 85 +++ .../todos/todos_consumer.dart | 32 + .../current/providers/provider.mdx | 130 ++-- .../completed_todos/completed_todos.dart | 15 + .../completed_todos/completed_todos.g.dart | 27 + .../provider/completed_todos/index.tsx | 9 + .../raw.dart} | 6 +- .../optimized_previous_button/index.tsx | 9 + .../optimized_previous_button.dart | 50 ++ .../optimized_previous_button.g.dart | 42 ++ .../optimized_previous_button/raw.dart} | 4 +- .../current/providers/provider/todo/index.tsx | 9 + .../provider/{todo.dart => todo/raw.dart} | 11 +- .../current/providers/provider/todo/todo.dart | 25 + .../providers/provider/todo/todo.g.dart | 26 + .../providers/provider/todos_consumer.dart | 14 +- .../unoptimized_previous_button/index.tsx | 9 + .../raw.dart} | 6 +- .../unoptimized_previous_button.dart | 39 + .../unoptimized_previous_button.g.dart | 26 + .../providers/state_notifier_provider.mdx | 40 +- .../state_notifier_provider/todos.dart | 68 +- .../todos_consumer.dart | 7 +- .../current/providers/state_provider.mdx | 131 ++-- .../state_provider/connected_dropdown.dart | 21 +- .../providers/state_provider/dropdown.dart | 2 +- .../providers/state_provider/full.dart | 12 +- .../providers/state_provider/product.dart | 20 + .../state_provider/product_list_view.dart | 22 + .../state_provider/sort_provider.dart | 2 +- .../sorted_product_provider.dart | 24 + .../state_provider/update_read_once.dart | 23 + .../state_provider/update_read_twice.dart | 4 +- .../current/providers/stream_provider.mdx | 61 +- .../live_stream_chat_consumer.dart | 25 + .../live_stream_chat_provider.dart | 18 + .../live_stream_chat_provider/codegen.dart | 23 + .../live_stream_chat_provider/codegen.g.dart | 26 + .../live_stream_chat_provider/index.tsx | 9 + .../live_stream_chat_provider/raw.dart | 18 + website/i18n/ko/NOTE.md | 22 + website/i18n/ko/code.json | 462 ++++++++---- .../options.json | 2 +- .../current.json | 120 ++-- .../current/about_code_generation.mdx | 67 -- .../current/about_hooks.mdx | 283 -------- .../current/advanced/select.mdx | 59 ++ .../advanced/select/select/codegen.dart | 30 + .../advanced/select/select/codegen.g.dart | 26 + .../current/advanced/select/select/index.ts | 4 + .../current/advanced/select/select/raw.dart | 29 + .../advanced/select/select_async/codegen.dart | 26 + .../select/select_async/codegen.g.dart | 26 + .../advanced/select/select_async/index.ts | 4 + .../advanced/select/select_async/raw.dart | 23 + .../current/case_studies/cancel.mdx | 118 ++++ .../cancel/detail_screen/codegen.dart | 61 ++ .../cancel/detail_screen/codegen.freezed.dart | 209 ++++++ .../cancel/detail_screen/codegen.g.dart | 46 ++ .../cancel/detail_screen/index.ts | 4 + .../cancel/detail_screen/raw.dart | 65 ++ .../cancel/detail_screen_cancel/codegen.dart | 28 + .../detail_screen_cancel/codegen.g.dart | 26 + .../cancel/detail_screen_cancel/index.ts | 4 + .../cancel/detail_screen_cancel/raw.dart | 25 + .../detail_screen_debounce/codegen.dart | 39 + .../detail_screen_debounce/codegen.g.dart | 26 + .../cancel/detail_screen_debounce/index.ts | 4 + .../cancel/detail_screen_debounce/raw.dart | 35 + .../case_studies/cancel/extension.dart | 31 + .../case_studies/cancel/home_screen.dart | 39 + .../provider_with_extension/codegen.dart | 25 + .../provider_with_extension/codegen.g.dart | 26 + .../cancel/provider_with_extension/index.ts | 4 + .../cancel/provider_with_extension/raw.dart | 23 + .../current/case_studies/pull_to_refresh.mdx | 119 ++++ .../pull_to_refresh/activity/codegen.dart | 19 + .../activity/codegen.freezed.dart | 209 ++++++ .../pull_to_refresh/activity/codegen.g.dart | 25 + .../pull_to_refresh/activity/index.ts | 4 + .../pull_to_refresh/activity/raw.dart | 24 + .../pull_to_refresh/display_activity.dart | 22 + .../pull_to_refresh/display_activity2.dart | 28 + .../pull_to_refresh/display_activity3.dart | 31 + .../pull_to_refresh/display_activity4.dart | 35 + .../fetch_activity/codegen.dart | 20 + .../fetch_activity/codegen.g.dart | 26 + .../pull_to_refresh/fetch_activity/index.ts | 4 + .../pull_to_refresh/fetch_activity/raw.dart | 17 + .../pull_to_refresh/full_app/codegen.dart | 69 ++ .../full_app/codegen.freezed.dart | 209 ++++++ .../pull_to_refresh/full_app/codegen.g.dart | 46 ++ .../pull_to_refresh/full_app/index.ts | 4 + .../pull_to_refresh/full_app/raw.dart | 73 ++ .../concepts/about_code_generation.mdx | 355 ++++++++++ .../current/concepts}/about_codegen/main.dart | 0 .../concepts}/about_codegen/main.g.dart | 0 .../provider_type/async_class_future.dart | 14 + .../provider_type/async_class_future.g.dart | 27 + .../provider_type/async_class_stream.dart | 14 + .../provider_type/async_class_stream.g.dart | 27 + .../provider_type/async_fn_future.dart | 9 + .../provider_type/async_fn_future.g.dart | 26 + .../provider_type/async_fn_stream.dart | 9 + .../provider_type/async_fn_stream.g.dart | 26 + .../provider_type/auto_dispose.dart | 12 + .../provider_type/auto_dispose.g.dart | 40 ++ .../about_codegen/provider_type/family.dart | 7 + .../about_codegen/provider_type/family.g.dart | 200 ++++++ .../provider_type/family_class.dart | 17 + .../provider_type/family_class.g.dart | 245 +++++++ .../provider_type/family_fn.dart | 13 + .../provider_type/family_fn.g.dart | 224 ++++++ .../non_code_gen/async_notifier_provider.dart | 15 + .../non_code_gen/auto_dispose.dart | 12 + .../provider_type/non_code_gen/family.dart | 6 + .../non_code_gen/future_provider.dart | 7 + .../non_code_gen/notifier_provider.dart | 15 + .../provider_type/non_code_gen/provider.dart | 8 + .../stream_notifier_provider.dart | 15 + .../non_code_gen/stream_provider.dart | 6 + .../provider_type/sync_class.dart | 14 + .../provider_type/sync_class.g.dart | 26 + .../about_codegen/provider_type/sync_fn.dart | 9 + .../provider_type/sync_fn.g.dart | 26 + .../current/concepts}/about_codegen/raw.dart | 2 +- .../current/concepts/about_hooks.mdx | 310 ++++++++ .../about_hooks/hook_and_consumer.dart | 28 + .../concepts/about_hooks/hook_consumer.dart | 26 + .../about_hooks/hook_consumer_widget.dart | 23 + .../concepts/async_initialization.dart | 58 ++ .../characters_provider/codegen.dart | 29 + .../characters_provider/codegen.g.dart | 40 ++ .../characters_provider/index.tsx | 9 + .../characters_provider/models.dart | 17 + .../characters_provider/raw.dart | 25 + .../city_provider/codegen.dart | 7 + .../city_provider/codegen.g.dart | 26 + .../city_provider/index.tsx | 9 + .../city_provider/raw.dart | 4 + .../filtered_todo_list_provider/codegen.dart | 31 + .../codegen.g.dart | 27 + .../filtered_todo_list_provider/index.tsx | 9 + .../filtered_todo_list_provider/raw.dart | 26 + .../read_in_provider/codegen.dart | 17 + .../read_in_provider/codegen.g.dart | 40 ++ .../read_in_provider/index.tsx | 9 + .../read_in_provider/raw.dart | 13 + .../select_async_provider/codegen.dart | 25 + .../select_async_provider/codegen.g.dart | 40 ++ .../select_async_provider/index.tsx | 9 + .../select_async_provider/models.dart | 21 + .../select_async_provider/raw.dart | 20 + .../todo_list_provider/codegen.dart | 24 + .../todo_list_provider/codegen.freezed.dart | 166 +++++ .../todo_list_provider/codegen.g.dart | 27 + .../todo_list_provider/index.tsx | 9 + .../todo_list_provider/raw.dart | 36 + .../weather_provider/codegen.dart | 20 + .../weather_provider/codegen.g.dart | 40 ++ .../weather_provider/index.tsx | 9 + .../weather_provider/raw.dart | 18 + .../whole_object_provider/codegen.dart | 24 + .../whole_object_provider/codegen.g.dart | 40 ++ .../whole_object_provider/index.tsx | 9 + .../whole_object_provider/models.dart | 16 + .../whole_object_provider/raw.dart | 20 + .../current/concepts/combining_providers.mdx | 267 +++---- .../current/concepts/dialog_scope.dart | 58 ++ .../lifecycle_on_dispose/codegen.dart | 21 + .../lifecycle_on_dispose/codegen.g.dart | 26 + .../concepts/lifecycle_on_dispose/index.tsx | 9 + .../concepts/lifecycle_on_dispose/raw.dart | 17 + .../concepts/modifiers/auto_dispose.mdx | 103 +-- .../current/concepts/modifiers/family.mdx | 91 +-- .../current/concepts/provider_lifecycles.mdx | 108 +++ .../current/concepts/provider_observer.mdx | 36 +- .../concepts/provider_observer_logger.dart | 6 +- .../current/concepts/providers.mdx | 203 +++--- .../creating_a_provider/codegen.dart | 12 + .../creating_a_provider/codegen.g.dart | 26 + .../providers/creating_a_provider/index.tsx | 9 + .../providers/creating_a_provider/raw.dart | 9 + .../declaring_many_providers/codegen.dart | 11 + .../declaring_many_providers/codegen.g.dart | 40 ++ .../declaring_many_providers/index.tsx | 9 + .../declaring_many_providers/raw.dart | 6 + .../current/concepts/reading.mdx | 436 +++++++----- .../consumer_hook.dart} | 6 +- .../consumer_stateful_widget/hooks.dart | 34 + .../consumer_stateful_widget/index.tsx | 9 + .../consumer_stateful_widget/raw.dart} | 6 +- .../consumer_widget/hooks.dart} | 6 +- .../reading/consumer_widget/index.tsx | 9 + .../consumer_widget/raw.dart} | 4 +- .../concepts/reading/counter/codegen.dart | 23 + .../concepts/reading/counter/codegen.g.dart | 26 + .../concepts/reading/counter/index.tsx | 9 + .../counter/raw.dart} | 2 +- .../concepts/reading/listen/codegen.dart | 16 + .../concepts/reading/listen/codegen.g.dart | 26 + .../current/concepts/reading/listen/index.tsx | 9 + .../current/concepts/reading/listen/raw.dart} | 6 +- .../reading/listen_build/codegen.dart | 28 + .../reading/listen_build/codegen.g.dart | 26 + .../reading/listen_build/codegen_hooks.dart | 34 + .../reading/listen_build/codegen_hooks.g.dart | 26 + .../concepts/reading/listen_build/index.tsx | 11 + .../listen_build/raw.dart} | 9 +- .../reading/listen_build/raw_hooks.dart | 29 + .../concepts/reading/provider/codegen.dart | 20 + .../concepts/reading/provider/codegen.g.dart | 40 ++ .../concepts/reading/provider/index.tsx | 9 + .../concepts/reading/provider/raw.dart | 19 + .../concepts/reading/read/codegen.dart | 32 + .../concepts/reading/read/codegen.g.dart | 26 + .../concepts/reading/read/codegen_hooks.dart | 36 + .../reading/read/codegen_hooks.g.dart | 26 + .../current/concepts/reading/read/index.tsx | 11 + .../read/raw.dart} | 7 +- .../concepts/reading/read/raw_hooks.dart | 31 + .../concepts/reading/read_build/codegen.dart | 25 + .../reading/read_build/codegen.g.dart | 26 + .../concepts/reading/read_build/index.tsx | 9 + .../read_build/raw.dart} | 2 +- .../reading/read_notifier_build/codegen.dart | 24 + .../read_notifier_build/codegen.g.dart | 26 + .../reading/read_notifier_build/index.tsx | 9 + .../reading/read_notifier_build/raw.dart} | 2 +- .../concepts/reading/watch/codegen.dart | 45 ++ .../concepts/reading/watch/codegen.g.dart | 55 ++ .../current/concepts/reading/watch/index.tsx | 9 + .../watch/raw.dart} | 6 +- .../concepts/reading/watch_build/codegen.dart | 39 + .../reading/watch_build/codegen.g.dart | 41 ++ .../reading/watch_build/codegen_hooks.dart | 43 ++ .../reading/watch_build/codegen_hooks.g.dart | 41 ++ .../concepts/reading/watch_build/index.tsx | 11 + .../watch_build/raw.dart} | 2 +- .../reading/watch_build/raw_hooks.dart | 37 + .../reading/watch_notifier_build/codegen.dart | 24 + .../watch_notifier_build/codegen.g.dart | 26 + .../reading/watch_notifier_build/index.tsx | 9 + .../watch_notifier_build/raw.dart} | 0 .../current/concepts/scopes.mdx | 180 +++++ .../current/concepts/subtree_scope.dart | 78 ++ .../current/concepts/theme_scope.dart | 68 ++ .../current/concepts/why_immutability.mdx | 140 ++-- .../concepts/why_immutability/codegen.dart | 58 ++ .../why_immutability/codegen.freezed.dart | 151 ++++ .../concepts/why_immutability/codegen.g.dart | 28 + .../concepts/why_immutability/index.tsx | 9 + .../concepts/why_immutability/raw.dart | 67 ++ .../current/cookbooks/refresh.mdx | 10 - .../current/cookbooks/search_as_we_type.mdx | 30 +- .../current/cookbooks/testing.mdx | 112 +-- .../current/cookbooks/testing_dart.dart | 60 +- .../current/cookbooks/testing_flutter.dart | 32 +- .../current/cookbooks/testing_full.dart | 34 +- .../cookbooks/testing_original_test_dart.dart | 26 +- .../testing_original_test_flutter.dart | 19 +- .../cookbooks/testing_override_info.dart | 2 +- .../current/cookbooks/testing_repository.dart | 10 +- .../current/essentials/auto_dispose.mdx | 153 ++++ .../auto_dispose/cache_for_extension.dart | 17 + .../auto_dispose/cache_for_usage/codegen.dart | 17 + .../cache_for_usage/codegen.g.dart | 26 + .../auto_dispose/cache_for_usage/index.ts | 4 + .../auto_dispose/cache_for_usage/raw.dart | 15 + .../auto_dispose/codegen_keep_alive.dart | 11 + .../auto_dispose/codegen_keep_alive.g.dart | 26 + .../auto_dispose/invalidate_example.dart | 23 + .../invalidate_family_example/codegen.dart | 24 + .../invalidate_family_example/codegen.g.dart | 200 ++++++ .../invalidate_family_example/index.ts | 4 + .../invalidate_family_example/raw.dart | 20 + .../auto_dispose/keep_alive/codegen.dart | 20 + .../auto_dispose/keep_alive/codegen.g.dart | 26 + .../auto_dispose/keep_alive/index.ts | 4 + .../auto_dispose/keep_alive/raw.dart | 19 + .../on_dispose_example/codegen.dart | 23 + .../on_dispose_example/codegen.g.dart | 40 ++ .../auto_dispose/on_dispose_example/index.ts | 4 + .../auto_dispose/on_dispose_example/raw.dart | 17 + .../auto_dispose/raw_auto_dispose.dart | 7 + .../current/essentials/combining_requests.mdx | 126 ++++ .../functional_ref/codegen.dart | 18 + .../functional_ref/codegen.g.dart | 40 ++ .../functional_ref/index.ts | 4 + .../functional_ref/raw.dart | 14 + .../listen_example/codegen.dart | 17 + .../listen_example/codegen.g.dart | 26 + .../listen_example/index.ts | 4 + .../listen_example/raw.dart | 13 + .../notifier_ref/codegen.dart | 21 + .../notifier_ref/codegen.g.dart | 40 ++ .../combining_requests/notifier_ref/index.ts | 4 + .../combining_requests/notifier_ref/raw.dart | 19 + .../read_example/codegen.dart | 23 + .../read_example/codegen.g.dart | 27 + .../combining_requests/read_example/index.ts | 4 + .../combining_requests/read_example/raw.dart | 22 + .../watch_example/codegen.dart | 43 ++ .../watch_example/codegen.g.dart | 44 ++ .../combining_requests/watch_example/index.ts | 4 + .../combining_requests/watch_example/raw.dart | 41 ++ .../watch_placement/codegen.dart | 37 + .../watch_placement/codegen.g.dart | 41 ++ .../watch_placement/index.ts | 4 + .../watch_placement/raw.dart | 35 + .../current/essentials/do_dont.mdx | 142 ++++ .../essentials/eager_initialization.mdx | 58 ++ .../async_consumer_example.dart | 28 + .../consumer_example.dart | 36 + .../require_value/codegen.dart | 24 + .../require_value/codegen.g.dart | 26 + .../require_value/index.ts | 4 + .../require_value/raw.dart | 20 + .../current/essentials/faq.mdx | 157 ++++ .../current/essentials/first_request.mdx | 320 +++++++++ .../essentials/first_request/activity.ts | 9 + .../first_request/codegen/activity.dart | 24 + .../codegen/activity.freezed.dart | 237 +++++++ .../first_request/codegen/activity.g.dart | 27 + .../first_request/codegen/provider.dart | 21 + .../first_request/codegen/provider.g.dart | 29 + .../essentials/first_request/consumer.ts | 8 + .../first_request/consumer_stateful_widget.ts | 8 + .../first_request/consumer_widget.ts | 8 + .../first_request/hook_consumer_widget.ts | 8 + .../first_request/legend/DocuCode.scss | 18 + .../first_request/legend/legend.tsx | 88 +++ .../essentials/first_request/provider.ts | 9 + .../first_request/raw/activity.dart | 30 + .../first_request/raw/consumer.dart | 41 ++ .../raw/consumer_stateful_widget.dart | 43 ++ .../first_request/raw/consumer_widget.dart | 25 + .../raw/hook_consumer_widget.dart | 28 + .../first_request/raw/provider.dart | 15 + .../current/essentials/passing_args.mdx | 137 ++++ .../passing_args/codegen/family.dart | 29 + .../passing_args/codegen/family.g.dart | 200 ++++++ .../passing_args/codegen/provider.dart | 32 + .../passing_args/codegen/provider.g.dart | 232 ++++++ .../passing_args/no_arg_provider.ts | 9 + .../passing_args/raw/consumer_family.dart | 24 + .../raw/consumer_list_family.dart | 23 + .../passing_args/raw/consumer_provider.dart | 20 + .../raw/consumer_tuple_family.dart | 23 + .../essentials/passing_args/raw/family.dart | 40 ++ .../raw/multiple_consumer_family.dart | 37 + .../essentials/passing_args/raw/provider.dart | 26 + .../passing_args/raw/tuple_family.dart | 34 + .../current/essentials/provider_observer.mdx | 48 ++ .../provider_observer/provider_observer.dart | 43 ++ .../current/essentials/side_effects.mdx | 407 +++++++++++ .../codegen/todo_list_notifier.dart | 28 + .../codegen/todo_list_notifier.freezed.dart | 166 +++++ .../codegen/todo_list_notifier.g.dart | 42 ++ .../codegen/todo_list_notifier_add_todo.dart | 26 + .../todo_list_notifier_add_todo.g.dart | 27 + .../codegen/todo_list_provider.dart | 23 + .../codegen/todo_list_provider.freezed.dart | 148 ++++ .../codegen/todo_list_provider.g.dart | 26 + .../raw/consumer_add_todo_call.dart | 25 + .../raw/invalidate_self_add_todo.dart | 38 + .../side_effects/raw/manual_add_todo.dart | 39 + .../raw/mutable_manual_add_todo.dart | 34 + .../side_effects/raw/render_add_todo.dart | 75 ++ .../raw/render_add_todo_hooks.dart | 68 ++ .../side_effects/raw/rest_add_todo.dart | 39 + .../side_effects/raw/todo_list_notifier.dart | 44 ++ .../raw/todo_list_notifier_add_todo.dart | 28 + .../side_effects/raw/todo_list_provider.dart | 27 + .../side_effects/render_add_todo.ts | 9 + .../side_effects/todo_list_notifier.ts | 9 + .../todo_list_notifier_add_todo.ts | 9 + .../side_effects/todo_list_provider.ts | 7 + .../current/essentials/testing.mdx | 148 ++++ .../testing/auto_dispose_listen.dart | 24 + .../essentials/testing/await_future.dart | 29 + .../essentials/testing/create_container.dart | 22 + .../essentials/testing/full_widget_test.dart | 33 + .../essentials/testing/listen_provider.dart | 22 + .../essentials/testing/mock_provider.dart | 45 ++ .../testing/notifier_mock/codegen.dart | 17 + .../testing/notifier_mock/codegen.g.dart | 27 + .../essentials/testing/notifier_mock/index.ts | 4 + .../essentials/testing/notifier_mock/raw.dart | 15 + .../testing/provider_to_mock/codegen.dart | 9 + .../testing/provider_to_mock/codegen.g.dart | 26 + .../testing/provider_to_mock/index.ts | 4 + .../testing/provider_to_mock/raw.dart | 6 + .../current/essentials/testing/unit_test.dart | 23 + .../testing/widget_container_of.dart | 15 + .../essentials/testing/widget_test.dart | 22 + .../current/essentials/websockets_sync.mdx | 100 +++ .../change_notifier_provider.dart | 11 + .../websockets_sync/pipe_change_notifier.dart | 21 + .../pipe_change_notifier.g.dart | 28 + .../essentials/websockets_sync/raw_usage.dart | 28 + .../websockets_sync/raw_usage.g.dart | 26 + .../shared_pipe_change_notifier.dart | 29 + .../shared_pipe_change_notifier.g.dart | 42 ++ .../stream_provider/codegen.dart | 34 + .../stream_provider/codegen.g.dart | 27 + .../websockets_sync/stream_provider/index.ts | 4 + .../websockets_sync/stream_provider/raw.dart | 30 + .../websockets_sync/sync_consumer.dart | 19 + .../sync_definition/codegen.dart | 10 + .../sync_definition/codegen.g.dart | 28 + .../websockets_sync/sync_definition/index.ts | 4 + .../websockets_sync/sync_definition/raw.dart | 7 + .../current/from_provider/family/family.dart | 11 + .../from_provider/family/family.g.dart | 222 ++++++ .../current/from_provider/family/index.tsx | 9 + .../current/from_provider/family/raw.dart | 27 + .../current/from_provider/helpers/item.dart | 12 + .../from_provider/helpers/item.freezed.dart | 146 ++++ .../current/from_provider/helpers/item.g.dart | 18 + .../current/from_provider/helpers/json.dart | 1 + .../motivation/async_values/async_values.dart | 29 + .../async_values/async_values.g.dart | 40 ++ .../motivation/async_values/index.tsx | 9 + .../motivation/async_values/raw.dart | 25 + .../motivation/auto_dispose/auto_dispose.dart | 29 + .../auto_dispose/auto_dispose.g.dart | 41 ++ .../motivation/auto_dispose/index.tsx | 9 + .../motivation/auto_dispose/raw.dart | 24 + .../motivation/combine/combine.dart | 19 + .../motivation/combine/combine.g.dart | 40 ++ .../motivation/combine/index.tsx | 9 + .../from_provider/motivation/combine/raw.dart | 15 + .../from_provider/motivation/motivation.mdx | 192 +++++ .../motivation/override/index.tsx | 9 + .../motivation/override/override.dart | 16 + .../motivation/override/raw.dart | 16 + .../motivation/same_type/index.tsx | 9 + .../motivation/same_type/raw.dart | 15 + .../motivation/same_type/same_type.dart | 19 + .../motivation/same_type/same_type.g.dart | 40 ++ .../motivation/side_effects/index.tsx | 9 + .../motivation/side_effects/raw.dart | 24 + .../motivation/side_effects/side_effects.dart | 24 + .../from_provider/provider_vs_riverpod.mdx | 419 +++++++++++ .../current/from_provider/quickstart.mdx | 190 +++++ .../current/getting_started.mdx | 154 ---- .../getting_started/dart_hello_world/raw.dart | 19 - .../getting_started/dart_pubspec/codegen.yaml | 11 - .../getting_started/dart_pubspec/index.tsx | 9 - .../getting_started/dart_pubspec/raw.yaml | 6 - .../getting_started/pubspec/codegen.yaml | 14 - .../getting_started/pubspec/hooks.yaml | 10 - .../pubspec/hooks_codegen.yaml | 15 - .../current/getting_started/pubspec/index.tsx | 11 - .../current/getting_started/pubspec/raw.yaml | 9 - .../current/introduction.mdx | 76 -- .../current/introduction/getting_started.mdx | 191 +++++ .../dart_hello_world}/index.tsx | 0 .../dart_hello_world/main.dart | 25 + .../dart_hello_world}/main.g.dart | 0 .../dart_hello_world/raw.dart} | 8 +- .../getting_started/dart_pub_add.tsx | 32 + .../getting_started/dart_pubspec.tsx | 40 ++ .../hello_world/hooks_codegen/main.dart} | 16 +- .../hello_world/hooks_codegen/main.g.dart} | 2 +- .../getting_started/hello_world/index.tsx | 11 + .../getting_started/hello_world/main.dart | 12 +- .../getting_started/hello_world/main.g.dart | 26 + .../getting_started/hello_world/raw.dart | 0 .../hello_world/raw_hooks.dart | 0 .../introduction/getting_started/pub_add.tsx | 39 + .../introduction/getting_started/pubspec.tsx | 51 ++ .../current/introduction/why_riverpod.mdx | 56 ++ .../introduction/why_riverpod/codegen.dart | 31 + .../introduction/why_riverpod/codegen.g.dart | 227 ++++++ .../introduction/why_riverpod/index.tsx | 9 + .../introduction/why_riverpod/raw.dart | 27 + .../current/migration/0.13.0_to_0.14.0.mdx | 59 +- .../current/migration/0.14.0_to_1.0.0.mdx | 102 +-- .../migration/from_change_notifier.mdx | 117 +++ .../declaration/declaration.dart | 33 + .../declaration/declaration.g.dart | 27 + .../declaration/index.tsx | 9 + .../from_change_notifier/declaration/raw.dart | 33 + .../initialization/index.tsx | 9 + .../initialization/initialization.dart | 29 + .../initialization/initialization.g.dart | 27 + .../initialization/raw.dart | 29 + .../from_change_notifier/migrated/index.tsx | 9 + .../migrated/migrated.dart | 37 + .../migrated/migrated.g.dart | 27 + .../from_change_notifier/migrated/raw.dart | 37 + .../migration/from_change_notifier/old.dart | 60 ++ .../current/migration/from_state_notifier.mdx | 243 +++++++ .../add_listener/add_listener.dart | 18 + .../add_listener/add_listener.g.dart | 27 + .../add_listener/index.tsx | 9 + .../from_state_notifier/add_listener/raw.dart | 17 + .../from_state_notifier/add_listener_old.dart | 24 + .../async_notifier/async_notifier.dart | 28 + .../async_notifier/async_notifier.g.dart | 29 + .../async_notifier/index.tsx | 9 + .../async_notifier/raw.dart | 29 + .../async_notifier_old.dart | 30 + .../build_init/build_init.dart | 15 + .../build_init/build_init.g.dart | 28 + .../from_state_notifier/build_init/index.tsx | 9 + .../from_state_notifier/build_init/raw.dart | 15 + .../from_state_notifier/build_init_old.dart | 13 + .../consumers_dont_change.dart | 36 + .../family_and_dispose.dart | 24 + .../family_and_dispose.g.dart | 219 ++++++ .../family_and_dispose/index.tsx | 9 + .../family_and_dispose/raw.dart | 27 + .../family_and_dispose_old.dart | 30 + .../from_state_provider.dart | 14 + .../from_state_provider.g.dart | 28 + .../from_state_provider/index.tsx | 9 + .../from_state_provider/raw.dart | 13 + .../from_state_provider_old.dart | 6 + .../obtain_notifier_on_tests.dart | 33 + .../old_lifecycles/index.tsx | 9 + .../old_lifecycles/old_lifecycles.dart | 36 + .../old_lifecycles/old_lifecycles.g.dart | 27 + .../old_lifecycles/raw.dart | 35 + .../old_lifecycles_final/index.tsx | 9 + .../old_lifecycles_final.dart | 38 + .../old_lifecycles_final.g.dart | 27 + .../old_lifecycles_final/raw.dart | 36 + .../old_lifecycles_old.dart | 42 ++ .../current/migration/utils.dart | 23 + .../providers/change_notifier_provider.mdx | 13 +- .../change_notifier_provider/todos.dart | 11 +- .../current/providers/future_provider.mdx | 20 +- .../config_consumer/codegen.dart | 13 +- .../config_consumer/hooks.dart | 11 +- .../config_consumer/hooks_codegen.dart | 17 +- .../future_provider/config_consumer/raw.dart | 12 +- .../current/providers/notifier_provider.mdx | 55 ++ .../remote_todos/codegen.dart | 82 +++ .../remote_todos/codegen.freezed.dart | 184 +++++ .../remote_todos/codegen.g.dart | 44 ++ .../notifier_provider/remote_todos/index.tsx | 9 + .../notifier_provider/remote_todos/raw.dart | 101 +++ .../remote_todos/todos_consumer.dart | 37 + .../notifier_provider/todos/codegen.dart | 68 ++ .../todos/codegen.freezed.dart | 166 +++++ .../notifier_provider/todos/codegen.g.dart | 26 + .../notifier_provider/todos/index.tsx | 9 + .../notifier_provider/todos/raw.dart | 85 +++ .../todos/todos_consumer.dart | 32 + .../current/providers/provider.mdx | 32 +- .../completed_todos/completed_todos.dart | 15 + .../completed_todos/completed_todos.g.dart | 27 + .../provider/completed_todos/index.tsx | 9 + .../raw.dart} | 6 +- .../optimized_previous_button/index.tsx | 9 + .../optimized_previous_button.dart | 50 ++ .../optimized_previous_button.g.dart | 42 ++ .../optimized_previous_button/raw.dart} | 15 +- .../current/providers/provider/todo/index.tsx | 9 + .../provider/{todo.dart => todo/raw.dart} | 11 +- .../current/providers/provider/todo/todo.dart | 25 + .../providers/provider/todo/todo.g.dart | 26 + .../providers/provider/todos_consumer.dart | 14 +- .../unoptimized_previous_button/index.tsx | 9 + .../raw.dart} | 6 +- .../unoptimized_previous_button.dart | 39 + .../unoptimized_previous_button.g.dart | 26 + .../providers/state_notifier_provider.mdx | 16 +- .../current/providers/state_provider.mdx | 20 +- .../current/providers/stream_provider.mdx | 27 +- .../live_stream_chat_consumer.dart | 25 + .../live_stream_chat_provider.dart | 18 + .../live_stream_chat_provider/codegen.dart | 23 + .../live_stream_chat_provider/codegen.g.dart | 26 + .../live_stream_chat_provider/index.tsx | 9 + .../live_stream_chat_provider/raw.dart | 18 + .../current/riverpod_for_provider_users.mdx | 401 ----------- .../ko/docusaurus-theme-classic/footer.json | 34 +- .../ko/docusaurus-theme-classic/navbar.json | 6 +- website/i18n/zh-Hans/code.json | 119 ++-- .../current.json | 80 ++- .../current/about_code_generation.mdx | 58 -- .../current/about_hooks.mdx | 272 ------- .../current/advanced/select.mdx | 129 ++++ .../advanced/select/select/codegen.dart | 30 + .../advanced/select/select/codegen.g.dart | 26 + .../current/advanced/select/select/index.ts | 4 + .../current/advanced/select/select/raw.dart | 29 + .../advanced/select/select_async/codegen.dart | 26 + .../select/select_async/codegen.g.dart | 26 + .../advanced/select/select_async/index.ts | 4 + .../advanced/select/select_async/raw.dart | 23 + .../current/case_studies/cancel.mdx | 278 ++++++++ .../cancel/detail_screen/codegen.dart | 61 ++ .../cancel/detail_screen/codegen.freezed.dart | 209 ++++++ .../cancel/detail_screen/codegen.g.dart | 46 ++ .../cancel/detail_screen/index.ts | 4 + .../cancel/detail_screen/raw.dart | 65 ++ .../cancel/detail_screen_cancel/codegen.dart | 28 + .../detail_screen_cancel/codegen.g.dart | 26 + .../cancel/detail_screen_cancel/index.ts | 4 + .../cancel/detail_screen_cancel/raw.dart | 25 + .../detail_screen_debounce/codegen.dart | 38 + .../detail_screen_debounce/codegen.g.dart | 26 + .../cancel/detail_screen_debounce/index.ts | 4 + .../cancel/detail_screen_debounce/raw.dart | 35 + .../case_studies/cancel/extension.dart | 32 + .../case_studies/cancel/home_screen.dart | 39 + .../provider_with_extension/codegen.dart | 25 + .../provider_with_extension/codegen.g.dart | 26 + .../cancel/provider_with_extension/index.ts | 4 + .../cancel/provider_with_extension/raw.dart | 22 + .../current/case_studies/pull_to_refresh.mdx | 253 +++++++ .../pull_to_refresh/activity/codegen.dart | 19 + .../activity/codegen.freezed.dart | 209 ++++++ .../pull_to_refresh/activity/codegen.g.dart | 25 + .../pull_to_refresh/activity/index.ts | 4 + .../pull_to_refresh/activity/raw.dart | 24 + .../pull_to_refresh/display_activity.dart | 22 + .../pull_to_refresh/display_activity2.dart | 28 + .../pull_to_refresh/display_activity3.dart | 30 + .../pull_to_refresh/display_activity4.dart | 36 + .../fetch_activity/codegen.dart | 20 + .../fetch_activity/codegen.g.dart | 26 + .../pull_to_refresh/fetch_activity/index.ts | 4 + .../pull_to_refresh/fetch_activity/raw.dart | 17 + .../pull_to_refresh/full_app/codegen.dart | 69 ++ .../full_app/codegen.freezed.dart | 209 ++++++ .../pull_to_refresh/full_app/codegen.g.dart | 46 ++ .../pull_to_refresh/full_app/index.ts | 4 + .../pull_to_refresh/full_app/raw.dart | 73 ++ .../concepts/about_code_generation.mdx | 488 +++++++++++++ .../current/concepts/about_codegen/main.dart | 22 + .../concepts/about_codegen/main.g.dart | 202 ++++++ .../provider_type/async_class_future.dart | 14 + .../provider_type/async_class_future.g.dart | 27 + .../provider_type/async_class_stream.dart | 14 + .../provider_type/async_class_stream.g.dart | 27 + .../provider_type/async_fn_future.dart | 9 + .../provider_type/async_fn_future.g.dart | 26 + .../provider_type/async_fn_stream.dart | 9 + .../provider_type/async_fn_stream.g.dart | 26 + .../provider_type/auto_dispose.dart | 12 + .../provider_type/auto_dispose.g.dart | 40 ++ .../about_codegen/provider_type/family.dart | 7 + .../about_codegen/provider_type/family.g.dart | 200 ++++++ .../provider_type/family_class.dart | 17 + .../provider_type/family_class.g.dart | 245 +++++++ .../provider_type/family_fn.dart | 13 + .../provider_type/family_fn.g.dart | 224 ++++++ .../non_code_gen/async_notifier_provider.dart | 16 + .../non_code_gen/auto_dispose.dart | 12 + .../provider_type/non_code_gen/family.dart | 6 + .../non_code_gen/future_provider.dart | 7 + .../non_code_gen/notifier_provider.dart | 15 + .../provider_type/non_code_gen/provider.dart | 8 + .../stream_notifier_provider.dart | 16 + .../non_code_gen/stream_provider.dart | 7 + .../provider_type/sync_class.dart | 14 + .../provider_type/sync_class.g.dart | 26 + .../about_codegen/provider_type/sync_fn.dart | 9 + .../provider_type/sync_fn.g.dart | 26 + .../current/concepts/about_codegen/raw.dart | 19 + .../current/concepts/about_hooks.mdx | 570 +++++++++++++++ .../about_hooks/hook_and_consumer.dart | 28 + .../concepts/about_hooks/hook_consumer.dart | 26 + .../about_hooks/hook_consumer_widget.dart | 23 + .../concepts/async_initialization.dart | 58 ++ .../characters_provider/codegen.dart | 29 + .../characters_provider/codegen.g.dart | 40 ++ .../characters_provider/index.tsx | 9 + .../characters_provider/models.dart | 17 + .../characters_provider/raw.dart | 25 + .../city_provider/codegen.dart | 7 + .../city_provider/codegen.g.dart | 26 + .../city_provider/index.tsx | 9 + .../city_provider/raw.dart | 4 + .../filtered_todo_list_provider/codegen.dart | 31 + .../codegen.g.dart | 27 + .../filtered_todo_list_provider/index.tsx | 9 + .../filtered_todo_list_provider/raw.dart | 26 + .../read_in_provider/codegen.dart | 17 + .../read_in_provider/codegen.g.dart | 40 ++ .../read_in_provider/index.tsx | 9 + .../read_in_provider/raw.dart | 13 + .../select_async_provider/codegen.dart | 25 + .../select_async_provider/codegen.g.dart | 40 ++ .../select_async_provider/index.tsx | 9 + .../select_async_provider/models.dart | 21 + .../select_async_provider/raw.dart | 20 + .../todo_list_provider/codegen.dart | 24 + .../todo_list_provider/codegen.freezed.dart | 166 +++++ .../todo_list_provider/codegen.g.dart | 27 + .../todo_list_provider/index.tsx | 9 + .../todo_list_provider/raw.dart | 36 + .../weather_provider/codegen.dart | 20 + .../weather_provider/codegen.g.dart | 40 ++ .../weather_provider/index.tsx | 9 + .../weather_provider/raw.dart | 18 + .../whole_object_provider/codegen.dart | 24 + .../whole_object_provider/codegen.g.dart | 40 ++ .../whole_object_provider/index.tsx | 9 + .../whole_object_provider/models.dart | 16 + .../whole_object_provider/raw.dart | 20 + .../current/concepts/combining_providers.mdx | 229 +++--- .../current/concepts/dialog_scope.dart | 58 ++ .../concepts/modifiers/auto_dispose.mdx | 88 ++- .../current/concepts/modifiers/family.mdx | 75 +- .../current/concepts/provider_lifecycles.mdx | 109 +-- .../current/concepts/provider_observer.mdx | 37 +- .../concepts/provider_observer_logger.dart | 61 ++ .../current/concepts/providers.mdx | 178 +++-- .../creating_a_provider/codegen.dart | 12 + .../creating_a_provider/codegen.g.dart | 26 + .../providers/creating_a_provider/index.tsx | 9 + .../providers/creating_a_provider/raw.dart | 9 + .../declaring_many_providers/codegen.dart | 11 + .../declaring_many_providers/codegen.g.dart | 40 ++ .../declaring_many_providers/index.tsx | 9 + .../declaring_many_providers/raw.dart | 6 + .../current/concepts/reading.mdx | 339 +++++---- .../consumer_stateful_widget/hooks.dart | 6 +- .../reading/consumer_stateful_widget/raw.dart | 4 +- .../reading/consumer_widget/hooks.dart | 4 +- .../concepts/reading/consumer_widget/raw.dart | 2 +- .../concepts/reading/counter/codegen.dart | 2 +- .../current/concepts/reading/counter/raw.dart | 2 +- .../reading/listen_build/codegen_hooks.dart | 34 + .../reading/listen_build/codegen_hooks.g.dart | 26 + .../concepts/reading/listen_build/index.tsx | 6 +- .../reading/listen_build/raw_hooks.dart | 29 + .../concepts/reading/provider/codegen.dart | 2 +- .../concepts/reading/provider/raw.dart | 2 +- .../concepts/reading/read/codegen.dart | 2 +- .../concepts/reading/read/codegen_hooks.dart | 36 + .../reading/read/codegen_hooks.g.dart | 26 + .../current/concepts/reading/read/index.tsx | 6 +- .../current/concepts/reading/read/raw.dart | 5 +- .../concepts/reading/read/raw_hooks.dart | 31 + .../concepts/reading/read_build/codegen.dart | 2 +- .../concepts/reading/read_build/raw.dart | 2 +- .../concepts/reading/watch/codegen.dart | 6 +- .../current/concepts/reading/watch/raw.dart | 6 +- .../concepts/reading/watch_build/codegen.dart | 2 +- .../reading/watch_build/codegen_hooks.dart | 43 ++ .../reading/watch_build/codegen_hooks.g.dart | 41 ++ .../concepts/reading/watch_build/index.tsx | 6 +- .../concepts/reading/watch_build/raw.dart | 2 +- .../reading/watch_build/raw_hooks.dart | 37 + .../current/concepts/scopes.mdx | 183 ++--- .../current/concepts/subtree_scope.dart | 78 ++ .../current/concepts/theme_scope.dart | 68 ++ .../current/concepts/why_immutability.mdx | 144 ++-- .../concepts/why_immutability/codegen.dart | 58 ++ .../why_immutability/codegen.freezed.dart | 151 ++++ .../concepts/why_immutability/codegen.g.dart | 28 + .../concepts/why_immutability/index.tsx | 9 + .../concepts/why_immutability/raw.dart | 67 ++ .../current/cookbooks/search_as_we_type.mdx | 148 ++++ .../current/cookbooks/testing.mdx | 106 +-- .../current/cookbooks/testing_dart.dart | 51 ++ .../current/cookbooks/testing_flutter.dart | 40 ++ .../current/cookbooks/testing_full.dart | 99 +++ .../cookbooks/testing_original_test_dart.dart | 63 ++ .../testing_original_test_flutter.dart | 56 ++ .../cookbooks/testing_override_info.dart | 43 ++ .../current/cookbooks/testing_repository.dart | 22 + .../current/essentials/auto_dispose.mdx | 306 ++++++++ .../auto_dispose/cache_for_extension.dart | 18 + .../auto_dispose/cache_for_usage/codegen.dart | 17 + .../cache_for_usage/codegen.g.dart | 26 + .../auto_dispose/cache_for_usage/index.ts | 4 + .../auto_dispose/cache_for_usage/raw.dart | 15 + .../auto_dispose/codegen_keep_alive.dart | 10 + .../auto_dispose/codegen_keep_alive.g.dart | 26 + .../auto_dispose/invalidate_example.dart | 23 + .../invalidate_family_example/codegen.dart | 24 + .../invalidate_family_example/codegen.g.dart | 200 ++++++ .../invalidate_family_example/index.ts | 4 + .../invalidate_family_example/raw.dart | 20 + .../auto_dispose/keep_alive/codegen.dart | 21 + .../auto_dispose/keep_alive/codegen.g.dart | 26 + .../auto_dispose/keep_alive/index.ts | 4 + .../auto_dispose/keep_alive/raw.dart | 19 + .../on_dispose_example/codegen.dart | 23 + .../on_dispose_example/codegen.g.dart | 40 ++ .../auto_dispose/on_dispose_example/index.ts | 4 + .../auto_dispose/on_dispose_example/raw.dart | 17 + .../auto_dispose/raw_auto_dispose.dart | 7 + .../current/essentials/combining_requests.mdx | 275 +++++++ .../functional_ref/codegen.dart | 18 + .../functional_ref/codegen.g.dart | 40 ++ .../functional_ref/index.ts | 4 + .../functional_ref/raw.dart | 14 + .../listen_example/codegen.dart | 17 + .../listen_example/codegen.g.dart | 26 + .../listen_example/index.ts | 4 + .../listen_example/raw.dart | 13 + .../notifier_ref/codegen.dart | 21 + .../notifier_ref/codegen.g.dart | 40 ++ .../combining_requests/notifier_ref/index.ts | 4 + .../combining_requests/notifier_ref/raw.dart | 19 + .../read_example/codegen.dart | 23 + .../read_example/codegen.g.dart | 27 + .../combining_requests/read_example/index.ts | 4 + .../combining_requests/read_example/raw.dart | 22 + .../watch_example/codegen.dart | 44 ++ .../watch_example/codegen.g.dart | 44 ++ .../combining_requests/watch_example/index.ts | 4 + .../combining_requests/watch_example/raw.dart | 41 ++ .../watch_placement/codegen.dart | 37 + .../watch_placement/codegen.g.dart | 41 ++ .../watch_placement/index.ts | 4 + .../watch_placement/raw.dart | 35 + .../current/essentials/do_dont.mdx | 260 +++++++ .../essentials/eager_initialization.mdx | 117 +++ .../async_consumer_example.dart | 28 + .../consumer_example.dart | 36 + .../require_value/codegen.dart | 24 + .../require_value/codegen.g.dart | 26 + .../require_value/index.ts | 4 + .../require_value/raw.dart | 20 + .../current/essentials/faq.mdx | 355 ++++++++++ .../current/essentials/first_request.mdx | 580 +++++++++++++++ .../essentials/first_request/activity.ts | 9 + .../first_request/codegen/activity.dart | 23 + .../codegen/activity.freezed.dart | 237 +++++++ .../first_request/codegen/activity.g.dart | 27 + .../first_request/codegen/provider.dart | 19 + .../first_request/codegen/provider.g.dart | 29 + .../essentials/first_request/consumer.ts | 8 + .../first_request/consumer_stateful_widget.ts | 8 + .../first_request/consumer_widget.ts | 8 + .../first_request/hook_consumer_widget.ts | 8 + .../first_request/legend/DocuCode.scss | 18 + .../first_request/legend/legend.tsx | 88 +++ .../essentials/first_request/provider.ts | 9 + .../first_request/raw/activity.dart | 28 + .../first_request/raw/consumer.dart | 39 + .../raw/consumer_stateful_widget.dart | 42 ++ .../first_request/raw/consumer_widget.dart | 23 + .../raw/hook_consumer_widget.dart | 26 + .../first_request/raw/provider.dart | 13 + .../current/essentials/passing_args.mdx | 265 +++++++ .../passing_args/codegen/family.dart | 29 + .../passing_args/codegen/family.g.dart | 200 ++++++ .../passing_args/codegen/provider.dart | 32 + .../passing_args/codegen/provider.g.dart | 232 ++++++ .../passing_args/no_arg_provider.ts | 9 + .../passing_args/raw/consumer_family.dart | 24 + .../raw/consumer_list_family.dart | 23 + .../passing_args/raw/consumer_provider.dart | 20 + .../raw/consumer_tuple_family.dart | 23 + .../essentials/passing_args/raw/family.dart | 42 ++ .../raw/multiple_consumer_family.dart | 37 + .../essentials/passing_args/raw/provider.dart | 26 + .../passing_args/raw/tuple_family.dart | 32 + .../current/essentials/provider_observer.mdx | 79 +++ .../provider_observer/provider_observer.dart | 43 ++ .../current/essentials/side_effects.mdx | 668 ++++++++++++++++++ .../codegen/todo_list_notifier.dart | 28 + .../codegen/todo_list_notifier.freezed.dart | 166 +++++ .../codegen/todo_list_notifier.g.dart | 42 ++ .../codegen/todo_list_notifier_add_todo.dart | 26 + .../todo_list_notifier_add_todo.g.dart | 27 + .../codegen/todo_list_provider.dart | 23 + .../codegen/todo_list_provider.freezed.dart | 148 ++++ .../codegen/todo_list_provider.g.dart | 26 + .../raw/consumer_add_todo_call.dart | 25 + .../raw/invalidate_self_add_todo.dart | 38 + .../side_effects/raw/manual_add_todo.dart | 39 + .../raw/mutable_manual_add_todo.dart | 35 + .../side_effects/raw/render_add_todo.dart | 78 ++ .../raw/render_add_todo_hooks.dart | 68 ++ .../side_effects/raw/rest_add_todo.dart | 39 + .../side_effects/raw/todo_list_notifier.dart | 44 ++ .../raw/todo_list_notifier_add_todo.dart | 28 + .../side_effects/raw/todo_list_provider.dart | 27 + .../side_effects/render_add_todo.ts | 9 + .../side_effects/todo_list_notifier.ts | 9 + .../todo_list_notifier_add_todo.ts | 9 + .../side_effects/todo_list_provider.ts | 7 + .../current/essentials/testing.mdx | 303 ++++++++ .../testing/auto_dispose_listen.dart | 24 + .../essentials/testing/await_future.dart | 32 + .../essentials/testing/create_container.dart | 22 + .../essentials/testing/full_widget_test.dart | 33 + .../essentials/testing/listen_provider.dart | 22 + .../essentials/testing/mock_provider.dart | 45 ++ .../testing/notifier_mock/codegen.dart | 17 + .../testing/notifier_mock/codegen.g.dart | 27 + .../essentials/testing/notifier_mock/index.ts | 4 + .../essentials/testing/notifier_mock/raw.dart | 14 + .../testing/provider_to_mock/codegen.dart | 9 + .../testing/provider_to_mock/codegen.g.dart | 26 + .../testing/provider_to_mock/index.ts | 4 + .../testing/provider_to_mock/raw.dart | 6 + .../current/essentials/testing/unit_test.dart | 23 + .../testing/widget_container_of.dart | 15 + .../essentials/testing/widget_test.dart | 22 + .../current/essentials/websockets_sync.mdx | 197 ++++++ .../change_notifier_provider.dart | 11 + .../websockets_sync/pipe_change_notifier.dart | 21 + .../pipe_change_notifier.g.dart | 28 + .../essentials/websockets_sync/raw_usage.dart | 30 + .../websockets_sync/raw_usage.g.dart | 26 + .../shared_pipe_change_notifier.dart | 29 + .../shared_pipe_change_notifier.g.dart | 42 ++ .../stream_provider/codegen.dart | 34 + .../stream_provider/codegen.g.dart | 27 + .../websockets_sync/stream_provider/index.ts | 4 + .../websockets_sync/stream_provider/raw.dart | 30 + .../websockets_sync/sync_consumer.dart | 19 + .../sync_definition/codegen.dart | 10 + .../sync_definition/codegen.g.dart | 28 + .../websockets_sync/sync_definition/index.ts | 4 + .../websockets_sync/sync_definition/raw.dart | 7 + .../current/from_provider/family/family.dart | 11 + .../from_provider/family/family.g.dart | 222 ++++++ .../current/from_provider/family/index.tsx | 9 + .../current/from_provider/family/raw.dart | 27 + .../current/from_provider/helpers/item.dart | 12 + .../from_provider/helpers/item.freezed.dart | 146 ++++ .../current/from_provider/helpers/item.g.dart | 18 + .../current/from_provider/helpers/json.dart | 1 + .../motivation/async_values/async_values.dart | 29 + .../async_values/async_values.g.dart | 40 ++ .../motivation/async_values/index.tsx | 9 + .../motivation/async_values/raw.dart | 25 + .../motivation/auto_dispose/auto_dispose.dart | 24 + .../auto_dispose/auto_dispose.g.dart | 41 ++ .../motivation/auto_dispose/index.tsx | 9 + .../motivation/auto_dispose/raw.dart | 20 + .../motivation/combine/combine.dart | 19 + .../motivation/combine/combine.g.dart | 40 ++ .../motivation/combine/index.tsx | 9 + .../from_provider/motivation/combine/raw.dart | 15 + .../from_provider/motivation/motivation.mdx | 434 ++++++++++++ .../motivation/override/index.tsx | 9 + .../motivation/override/override.dart | 16 + .../motivation/override/raw.dart | 15 + .../motivation/same_type/index.tsx | 9 + .../motivation/same_type/raw.dart | 15 + .../motivation/same_type/same_type.dart | 19 + .../motivation/same_type/same_type.g.dart | 40 ++ .../motivation/side_effects/index.tsx | 9 + .../motivation/side_effects/raw.dart | 24 + .../motivation/side_effects/side_effects.dart | 24 + .../from_provider/provider_vs_riverpod.mdx | 653 +++++++++++++++++ .../current/from_provider/quickstart.mdx | 399 +++++++++++ .../current/getting_started.mdx | 189 ----- .../current/getting_started/dart_pub_add.tsx | 10 - .../current/getting_started/pub_add.tsx | 14 - .../current/introduction.mdx | 65 -- .../current/introduction/getting_started.mdx | 296 ++++++++ .../dart_hello_world/index.tsx | 0 .../dart_hello_world/main.dart | 25 + .../dart_hello_world/main.g.dart | 26 + .../getting_started/dart_hello_world/raw.dart | 19 + .../getting_started/dart_pub_add.tsx | 32 + .../getting_started/dart_pubspec.tsx | 40 ++ .../hello_world/hooks_codegen/main.dart | 46 ++ .../hello_world/hooks_codegen/main.g.dart | 26 + .../getting_started/hello_world/index.tsx | 11 + .../getting_started/hello_world/main.dart | 42 ++ .../getting_started/hello_world/main.g.dart | 26 + .../getting_started/hello_world/raw.dart | 16 +- .../hello_world/raw_hooks.dart | 40 ++ .../introduction/getting_started/pub_add.tsx | 39 + .../getting_started/pubspec.tsx | 16 +- .../current/introduction/why_riverpod.mdx | 125 ++++ .../introduction/why_riverpod/codegen.dart | 29 + .../introduction/why_riverpod/codegen.g.dart | 227 ++++++ .../introduction/why_riverpod/index.tsx | 9 + .../introduction/why_riverpod/raw.dart | 25 + .../current/migration/0.13.0_to_0.14.0.mdx | 120 ++++ .../current/migration/0.14.0_to_1.0.0.mdx | 226 ++++++ .../migration/from_change_notifier.mdx | 259 +++++++ .../declaration/declaration.dart | 33 + .../declaration/declaration.g.dart | 27 + .../declaration/index.tsx | 9 + .../from_change_notifier/declaration/raw.dart | 33 + .../initialization/index.tsx | 9 + .../initialization/initialization.dart | 29 + .../initialization/initialization.g.dart | 27 + .../initialization/raw.dart | 29 + .../from_change_notifier/migrated/index.tsx | 9 + .../migrated/migrated.dart | 37 + .../migrated/migrated.g.dart | 27 + .../from_change_notifier/migrated/raw.dart | 37 + .../migration/from_change_notifier/old.dart | 60 ++ .../current/migration/from_state_notifier.mdx | 547 ++++++++++++++ .../add_listener/add_listener.dart | 18 + .../add_listener/add_listener.g.dart | 27 + .../add_listener/index.tsx | 9 + .../from_state_notifier/add_listener/raw.dart | 17 + .../from_state_notifier/add_listener_old.dart | 24 + .../async_notifier/async_notifier.dart | 28 + .../async_notifier/async_notifier.g.dart | 29 + .../async_notifier/index.tsx | 9 + .../async_notifier/raw.dart | 29 + .../async_notifier_old.dart | 30 + .../build_init/build_init.dart | 15 + .../build_init/build_init.g.dart | 28 + .../from_state_notifier/build_init/index.tsx | 9 + .../from_state_notifier/build_init/raw.dart | 15 + .../from_state_notifier/build_init_old.dart | 13 + .../consumers_dont_change.dart | 36 + .../family_and_dispose.dart | 24 + .../family_and_dispose.g.dart | 219 ++++++ .../family_and_dispose/index.tsx | 9 + .../family_and_dispose/raw.dart | 27 + .../family_and_dispose_old.dart | 30 + .../from_state_provider.dart | 14 + .../from_state_provider.g.dart | 28 + .../from_state_provider/index.tsx | 9 + .../from_state_provider/raw.dart | 13 + .../from_state_provider_old.dart | 6 + .../obtain_notifier_on_tests.dart | 35 + .../old_lifecycles/index.tsx | 9 + .../old_lifecycles/old_lifecycles.dart | 36 + .../old_lifecycles/old_lifecycles.g.dart | 27 + .../old_lifecycles/raw.dart | 35 + .../old_lifecycles_final/index.tsx | 9 + .../old_lifecycles_final.dart | 38 + .../old_lifecycles_final.g.dart | 27 + .../old_lifecycles_final/raw.dart | 37 + .../old_lifecycles_old.dart | 42 ++ .../current/migration/utils.dart | 23 + .../providers/change_notifier_provider.mdx | 53 +- .../change_notifier_provider/todos.dart | 11 +- .../current/providers/future_provider.mdx | 58 +- .../config_consumer/codegen.dart | 13 +- .../config_consumer/hooks.dart | 11 +- .../config_consumer/hooks_codegen.dart | 17 +- .../future_provider/config_consumer/raw.dart | 12 +- .../current/providers/notifier_provider.mdx | 55 +- .../remote_todos/codegen.dart | 22 +- .../remote_todos/codegen.freezed.dart | 4 +- .../notifier_provider/remote_todos/raw.dart | 26 +- .../remote_todos/todos_consumer.dart | 35 +- .../notifier_provider/todos/codegen.dart | 42 +- .../todos/codegen.freezed.dart | 4 +- .../notifier_provider/todos/raw.dart | 51 +- .../todos/todos_consumer.dart | 6 +- .../current/providers/provider.mdx | 98 ++- .../completed_todos/completed_todos.dart | 2 +- .../provider/completed_todos/raw.dart | 4 +- .../optimized_previous_button.dart | 6 +- .../optimized_previous_button/raw.dart | 6 +- .../current/providers/provider/todo/raw.dart | 11 +- .../current/providers/provider/todo/todo.dart | 1 + .../providers/provider/todos_consumer.dart | 2 +- .../unoptimized_previous_button/raw.dart | 2 +- .../unoptimized_previous_button.dart | 2 +- .../providers/state_notifier_provider.mdx | 35 +- .../current/providers/state_provider.mdx | 118 ++-- .../current/providers/stream_provider.mdx | 67 +- .../live_stream_chat_consumer.dart | 21 +- .../live_stream_chat_provider/codegen.dart | 23 + .../live_stream_chat_provider/codegen.g.dart | 26 + .../live_stream_chat_provider/index.tsx | 9 + .../live_stream_chat_provider/raw.dart | 18 + .../current/riverpod_for_provider_users.mdx | 367 ---------- .../docusaurus-theme-classic/footer.json | 30 +- .../docusaurus-theme-classic/navbar.json | 4 + website/src/documents_meta.js | 207 +++--- website/static/snippets/combine.dart | 2 +- website/yarn.lock | 6 +- 1701 files changed, 68126 insertions(+), 6653 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 packages/riverpod_generator/lib/src/validation.dart create mode 100644 packages/riverpod_generator/test/error_test.dart create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/empty.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/empty.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.json create mode 100644 packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.json create mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.json create mode 100644 packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.json create mode 100644 packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.json create mode 100644 packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.json create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx rename website/i18n/{ko/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/concepts}/about_codegen/main.dart (100%) rename website/i18n/{ko/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/concepts}/about_codegen/main.g.dart (100%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart rename website/i18n/{ko/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/concepts}/about_codegen/raw.dart (93%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/index.tsx rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose.dart => it/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/raw.dart} (85%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/provider_lifecycles.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_hook.dart => reading/consumer_hook.dart} (74%) rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_stateful_hook_consumer_widget.dart => reading/consumer_stateful_widget/hooks.dart} (69%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_stateful_widget.dart => reading/consumer_stateful_widget/raw.dart} (72%) rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_hook_widget.dart => reading/consumer_widget/hooks.dart} (70%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_widget.dart => reading/consumer_widget/raw.dart} (80%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/counter/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_counter.dart => reading/counter/raw.dart} (89%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen/index.tsx rename website/i18n/{ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart => it/docusaurus-plugin-content-docs/current/concepts/reading/listen/raw.dart} (75%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_listen_build.dart => reading/listen_build/raw.dart} (82%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_read.dart => reading/read/raw.dart} (76%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read_build/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_read_build.dart => reading/read_build/raw.dart} (87%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/index.tsx rename website/i18n/{ko/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart => it/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/raw.dart} (99%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_watch.dart => reading/watch/raw.dart} (84%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_watch_build.dart => reading/watch_build/raw.dart} (93%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_watch_notifier_build.dart => reading/watch_notifier_build/raw.dart} (100%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/scopes.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/faq.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx delete mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/getting_started.mdx delete mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world.dart delete mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx rename website/i18n/{ko/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/introduction}/getting_started/dart_hello_world/index.tsx (100%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/introduction}/getting_started/dart_hello_world/main.dart (56%) rename website/i18n/{ko/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/introduction}/getting_started/dart_hello_world/main.g.dart (100%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/introduction}/getting_started/dart_hello_world/raw.dart (100%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/introduction}/getting_started/dart_pubspec.tsx (78%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart rename website/i18n/{ko/docusaurus-plugin-content-docs/current/getting_started/hello_world => it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen}/main.g.dart (100%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/introduction}/getting_started/hello_world/index.tsx (67%) rename website/i18n/{ko/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/introduction}/getting_started/hello_world/main.dart (57%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world => it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world}/main.g.dart (100%) rename website/i18n/it/docusaurus-plugin-content-docs/current/{getting_started_hello_world_flutter.dart => introduction/getting_started/hello_world/raw.dart} (54%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/{completed_todos.dart => completed_todos/raw.dart} (65%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart rename website/i18n/{ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart => it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart} (87%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/{todo.dart => todo/raw.dart} (59%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/{unoptimized_previous_button.dart => unoptimized_previous_button/raw.dart} (76%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product_list_view.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart create mode 100644 website/i18n/ko/NOTE.md delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/about_code_generation.mdx delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/about_hooks.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => ko/docusaurus-plugin-content-docs/current/concepts}/about_codegen/main.dart (100%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => ko/docusaurus-plugin-content-docs/current/concepts}/about_codegen/main.g.dart (100%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => ko/docusaurus-plugin-content-docs/current/concepts}/about_codegen/raw.dart (93%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_lifecycles.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_hook.dart => reading/consumer_hook.dart} (71%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_stateful_widget.dart => reading/consumer_stateful_widget/raw.dart} (69%) rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_hook_widget.dart => reading/consumer_widget/hooks.dart} (66%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_widget.dart => reading/consumer_widget/raw.dart} (78%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_counter.dart => reading/counter/raw.dart} (82%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/index.tsx rename website/i18n/{it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart => ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/raw.dart} (75%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_listen_build.dart => reading/listen_build/raw.dart} (82%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_read.dart => reading/read/raw.dart} (72%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_read_build.dart => reading/read_build/raw.dart} (84%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/index.tsx rename website/i18n/{it/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart => ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/raw.dart} (99%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_watch.dart => reading/watch/raw.dart} (80%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_watch_build.dart => reading/watch_build/raw.dart} (91%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_watch_notifier_build.dart => reading/watch_notifier_build/raw.dart} (100%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/scopes.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/faq.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started.mdx delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/raw.dart delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/codegen.yaml delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/index.tsx delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/raw.yaml delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/codegen.yaml delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks.yaml delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks_codegen.yaml delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/index.tsx delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/raw.yaml delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx rename website/i18n/ko/docusaurus-plugin-content-docs/current/{getting_started/hello_world => introduction/getting_started/dart_hello_world}/index.tsx (100%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world => ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world}/main.g.dart (100%) rename website/i18n/ko/docusaurus-plugin-content-docs/current/{getting_started/dart_hello_world/main.dart => introduction/getting_started/dart_hello_world/raw.dart} (76%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.dart => ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart} (59%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart => ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart} (97%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => ko/docusaurus-plugin-content-docs/current/introduction}/getting_started/hello_world/main.dart (60%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => ko/docusaurus-plugin-content-docs/current/introduction}/getting_started/hello_world/raw.dart (100%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => ko/docusaurus-plugin-content-docs/current/introduction}/getting_started/hello_world/raw_hooks.dart (100%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/{completed_todos.dart => completed_todos/raw.dart} (60%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart rename website/i18n/{it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart => ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart} (67%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/{todo.dart => todo/raw.dart} (59%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/{unoptimized_previous_button.dart => unoptimized_previous_button/raw.dart} (74%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx delete mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_code_generation.mdx delete mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_hooks.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/faq.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx delete mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started.mdx delete mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_pub_add.tsx delete mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/pub_add.tsx delete mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx rename website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/{ => introduction}/getting_started/dart_hello_world/index.tsx (100%) create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart rename website/i18n/{ko/docusaurus-plugin-content-docs/current => zh-Hans/docusaurus-plugin-content-docs/current/introduction}/getting_started/hello_world/raw.dart (52%) create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx rename website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/{ => introduction}/getting_started/pubspec.tsx (79%) create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart delete mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..9d1e2066e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,34 @@ +## Related Issues + +fixes #your-issue-number + + + +## Checklist + +Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (`[x]`). + +- [ ] I have updated the `CHANGELOG.md` of the relevant packages. + Changelog files must be edited under the form: + + ```md + ## Unreleased fix/major/minor + + - Description of your change. (thanks to @yourGithubId) + ``` + +- [ ] If this contains new features or behavior changes, + I have updated the documentation to match those changes. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee9fb65fc..5cb0bcbfa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,7 +68,7 @@ Finally, head to `localhost:3000` ### Adding new language Riverpod supports multiple languages. -To add new languages, it is recommended to follow the [i18n](https://docusaurus.io/fr/docs/i18n/introduction) +To add new languages, it is recommended to follow the [i18n](https://docusaurus.io/docs/i18n/introduction) documentation of Docusaurus. The English documentation is hosted in [`/website/docs`](https://github.com/rrousselGit/riverpod/tree/master/website/docs). @@ -119,4 +119,4 @@ your code snippets should support those. This is done by having a separate `.dart` file for each possible scenario. Again, look at the [Getting Started] for an example. -[Getting Started]: https://github.com/rrousselGit/riverpod/blob/rework-flow/website/docs/introduction/getting_started.mdx +[Getting Started]: https://github.com/rrousselGit/riverpod/blob/master/website/docs/introduction/getting_started.mdx diff --git a/all_lint_rules.yaml b/all_lint_rules.yaml index fb224fcbd..49d1bb67f 100644 --- a/all_lint_rules.yaml +++ b/all_lint_rules.yaml @@ -7,6 +7,7 @@ linter: - always_specify_types - always_use_package_imports - annotate_overrides + - annotate_redeclares - avoid_annotating_with_dynamic - avoid_bool_literals_in_conditional_expressions - avoid_catches_without_on_clauses @@ -44,6 +45,7 @@ linter: - avoid_types_as_parameter_names - avoid_types_on_closure_parameters - avoid_unnecessary_containers + - avoid_unstable_final_fields - avoid_unused_constructor_parameters - avoid_void_async - avoid_web_libraries_in_flutter diff --git a/examples/counter/README.md b/examples/counter/README.md index 7895be08b..7837608b0 100644 --- a/examples/counter/README.md +++ b/examples/counter/README.md @@ -1,6 +1,6 @@ The standard Flutter Counter example built with [Riverpod] -This uses `ProvidedScope`. +This uses `ProviderScope`. [riverpod]: https://github.com/rrousselGit/riverpod diff --git a/examples/counter/pubspec.yaml b/examples/counter/pubspec.yaml index 1fbc08ec0..270a678a0 100644 --- a/examples/counter/pubspec.yaml +++ b/examples/counter/pubspec.yaml @@ -24,7 +24,7 @@ dependencies: dev_dependencies: build_runner: ^2.3.3 - custom_lint: ^0.5.2 + custom_lint: ^0.6.0 flutter_test: sdk: flutter freezed: ^2.3.2 diff --git a/examples/marvel/lib/src/configuration.freezed.dart b/examples/marvel/lib/src/configuration.freezed.dart index ea54df0fb..3bc79273e 100644 --- a/examples/marvel/lib/src/configuration.freezed.dart +++ b/examples/marvel/lib/src/configuration.freezed.dart @@ -12,7 +12,7 @@ part of 'configuration.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Configuration _$ConfigurationFromJson(Map json) { return _Configuration.fromJson(json); @@ -125,7 +125,7 @@ class _$ConfigurationImpl implements _Configuration { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ConfigurationImpl && diff --git a/examples/marvel/lib/src/marvel.freezed.dart b/examples/marvel/lib/src/marvel.freezed.dart index 698d3ff9e..c3950b0c2 100644 --- a/examples/marvel/lib/src/marvel.freezed.dart +++ b/examples/marvel/lib/src/marvel.freezed.dart @@ -12,7 +12,7 @@ part of 'marvel.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$MarvelListCharactersResponse { @@ -130,7 +130,7 @@ class _$MarvelListCharactersResponseImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$MarvelListCharactersResponseImpl && @@ -307,7 +307,7 @@ class _$CharacterImpl implements _Character { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$CharacterImpl && @@ -465,7 +465,7 @@ class _$ThumbnailImpl extends _Thumbnail { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ThumbnailImpl && @@ -621,7 +621,7 @@ class _$MarvelResponseImpl implements _MarvelResponse { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$MarvelResponseImpl && @@ -778,7 +778,7 @@ class _$MarvelDataImpl implements _MarvelData { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$MarvelDataImpl && diff --git a/examples/marvel/lib/src/result.freezed.dart b/examples/marvel/lib/src/result.freezed.dart index 1b853ca34..ea52cc1de 100644 --- a/examples/marvel/lib/src/result.freezed.dart +++ b/examples/marvel/lib/src/result.freezed.dart @@ -12,7 +12,7 @@ part of 'result.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$Result { @@ -118,7 +118,7 @@ class _$ResultDataImpl extends _ResultData { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ResultDataImpl && @@ -257,7 +257,7 @@ class _$ResultErrorImpl extends _ResultError { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ResultErrorImpl && diff --git a/examples/marvel/lib/src/screens/home.dart b/examples/marvel/lib/src/screens/home.dart index 78c864e32..a5bfc3fa8 100644 --- a/examples/marvel/lib/src/screens/home.dart +++ b/examples/marvel/lib/src/screens/home.dart @@ -92,7 +92,12 @@ class Home extends HookConsumerWidget { return Scaffold( appBar: AppBar(title: const Text('Error')), body: Center( - child: Text('$err'), + child: Text( + switch (err) { + DioException() => err.message ?? '$err', + _ => '$err', + }, + ), ), ); }, diff --git a/examples/marvel/lib/src/screens/home.freezed.dart b/examples/marvel/lib/src/screens/home.freezed.dart index b59d28598..93450e7ed 100644 --- a/examples/marvel/lib/src/screens/home.freezed.dart +++ b/examples/marvel/lib/src/screens/home.freezed.dart @@ -12,7 +12,7 @@ part of 'home.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$CharacterPagination { @@ -116,7 +116,7 @@ class _$CharacterPaginationImpl implements _CharacterPagination { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$CharacterPaginationImpl && @@ -252,7 +252,7 @@ class _$CharacterOffsetImpl implements _CharacterOffset { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$CharacterOffsetImpl && diff --git a/examples/marvel/pubspec.yaml b/examples/marvel/pubspec.yaml index 6d141bdfe..978c51ce7 100644 --- a/examples/marvel/pubspec.yaml +++ b/examples/marvel/pubspec.yaml @@ -3,7 +3,7 @@ description: A new Flutter project. publish_to: "none" environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0 <4.0.0" flutter: ">=1.17.0" dependencies: diff --git a/examples/pub/lib/pub_repository.freezed.dart b/examples/pub/lib/pub_repository.freezed.dart index 526229bc9..b86c3f5d8 100644 --- a/examples/pub/lib/pub_repository.freezed.dart +++ b/examples/pub/lib/pub_repository.freezed.dart @@ -12,7 +12,7 @@ part of 'pub_repository.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); PackageMetricsScore _$PackageMetricsScoreFromJson(Map json) { return _PackageMetricsScore.fromJson(json); @@ -198,7 +198,7 @@ class _$PackageMetricsScoreImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$PackageMetricsScoreImpl && @@ -385,7 +385,7 @@ class _$PackageMetricsResponseImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$PackageMetricsResponseImpl && @@ -547,7 +547,7 @@ class _$PackageDetailsImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$PackageDetailsImpl && @@ -721,7 +721,7 @@ class _$PackageImpl with DiagnosticableTreeMixin implements _Package { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$PackageImpl && @@ -883,7 +883,7 @@ class _$LikedPackageImpl with DiagnosticableTreeMixin implements _LikedPackage { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$LikedPackageImpl && @@ -1044,7 +1044,7 @@ class _$LikesPackagesResponseImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$LikesPackagesResponseImpl && @@ -1201,7 +1201,7 @@ class _$PubPackagesResponseImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$PubPackagesResponseImpl && @@ -1350,7 +1350,7 @@ class _$SearchPackageImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$SearchPackageImpl && @@ -1502,7 +1502,7 @@ class _$PubSearchResponseImpl } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$PubSearchResponseImpl && diff --git a/examples/stackoverflow/lib/question.freezed.dart b/examples/stackoverflow/lib/question.freezed.dart index 16fca8a77..5d31e4eff 100644 --- a/examples/stackoverflow/lib/question.freezed.dart +++ b/examples/stackoverflow/lib/question.freezed.dart @@ -12,7 +12,7 @@ part of 'question.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); QuestionsResponse _$QuestionsResponseFromJson(Map json) { return _QuestionsResponse.fromJson(json); @@ -132,7 +132,7 @@ class _$QuestionsResponseImpl implements _QuestionsResponse { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$QuestionsResponseImpl && @@ -476,7 +476,7 @@ class _$QuestionImpl implements _Question { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$QuestionImpl && @@ -683,7 +683,7 @@ class _$QuestionThemeImpl implements _QuestionTheme { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$QuestionThemeImpl && diff --git a/examples/stackoverflow/lib/tag.freezed.dart b/examples/stackoverflow/lib/tag.freezed.dart index 77c51997b..b96ae82e2 100644 --- a/examples/stackoverflow/lib/tag.freezed.dart +++ b/examples/stackoverflow/lib/tag.freezed.dart @@ -12,7 +12,7 @@ part of 'tag.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$TagTheme { @@ -153,7 +153,7 @@ class _$TagThemeImpl implements _TagTheme { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TagThemeImpl && diff --git a/examples/stackoverflow/lib/user.freezed.dart b/examples/stackoverflow/lib/user.freezed.dart index efc55d2ad..f276b487d 100644 --- a/examples/stackoverflow/lib/user.freezed.dart +++ b/examples/stackoverflow/lib/user.freezed.dart @@ -12,7 +12,7 @@ part of 'user.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); User _$UserFromJson(Map json) { return _User.fromJson(json); @@ -208,7 +208,7 @@ class _$UserImpl implements _User { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$UserImpl && @@ -396,7 +396,7 @@ class _$BadgeCountImpl implements _BadgeCount { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$BadgeCountImpl && diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md index bcfc27ae2..2a43f4f76 100644 --- a/packages/flutter_riverpod/CHANGELOG.md +++ b/packages/flutter_riverpod/CHANGELOG.md @@ -27,6 +27,11 @@ Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. - **Breaking**: Removed everything marked as "deprecated" - Bumped minimum Dart SDK to >= 3.0.0-dev +## 2.4.10 - 2024-02-03 + +- Fix out of date `pub.dev` description +- Add `test` argument to `AsyncValue.guard` method. (thanks to @utamori) + ## 2.4.9 - 2023-11-27 - Fix "pending timer" issue inside tests when using `ref.keepAlive()`. diff --git a/packages/flutter_riverpod/lib/src/consumer.dart b/packages/flutter_riverpod/lib/src/consumer.dart index 665a6e596..53b06afab 100644 --- a/packages/flutter_riverpod/lib/src/consumer.dart +++ b/packages/flutter_riverpod/lib/src/consumer.dart @@ -471,9 +471,6 @@ abstract class ConsumerWidget extends ConsumerStatefulWidget { } class _ConsumerState extends ConsumerState { - @override - WidgetRef get ref => context as WidgetRef; - @override Widget build(BuildContext context) { return widget.build(context, ref); diff --git a/packages/flutter_riverpod/lib/src/framework.dart b/packages/flutter_riverpod/lib/src/framework.dart index 99f76ba1c..c6e592ea1 100644 --- a/packages/flutter_riverpod/lib/src/framework.dart +++ b/packages/flutter_riverpod/lib/src/framework.dart @@ -25,7 +25,7 @@ import 'internals.dart'; /// } /// ``` /// -/// It optionally possible to specify `overrides` to change the behavior of +/// It's optionally possible to specify `overrides` to change the behavior of /// some providers. This can be useful for testing purposes: /// /// ```dart diff --git a/packages/flutter_riverpod/pubspec.yaml b/packages/flutter_riverpod/pubspec.yaml index c84922abe..313841192 100644 --- a/packages/flutter_riverpod/pubspec.yaml +++ b/packages/flutter_riverpod/pubspec.yaml @@ -1,7 +1,7 @@ name: flutter_riverpod description: > - A simple way to access state from anywhere in your application - while robust and testable. + A reactive caching and data-binding framework. + Riverpod makes working with asynchronous code a breeze. version: 3.0.0-dev.3 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod diff --git a/packages/hooks_riverpod/CHANGELOG.md b/packages/hooks_riverpod/CHANGELOG.md index 83ded1fb5..51319b528 100644 --- a/packages/hooks_riverpod/CHANGELOG.md +++ b/packages/hooks_riverpod/CHANGELOG.md @@ -27,6 +27,11 @@ Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. - **Breaking**: Removed everything marked as "deprecated" - Bumped minimum Dart SDK to >= 3.0.0-dev +## 2.4.10 - 2024-02-03 + +- Fix out of date `pub.dev` description +- Add `test` argument to `AsyncValue.guard` method. (thanks to @utamori) + ## 2.4.9 - 2023-11-27 - Fix "pending timer" issue inside tests when using `ref.keepAlive()`. diff --git a/packages/hooks_riverpod/pubspec.yaml b/packages/hooks_riverpod/pubspec.yaml index b1d897f5d..eb4d45f5b 100644 --- a/packages/hooks_riverpod/pubspec.yaml +++ b/packages/hooks_riverpod/pubspec.yaml @@ -1,7 +1,7 @@ name: hooks_riverpod description: > - A simple way to access state from anywhere in your application - while robust and testable. + A reactive caching and data-binding framework. + Riverpod makes working with asynchronous code a breeze. version: 3.0.0-dev.3 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 6361af5a8..c78e10224 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -27,11 +27,16 @@ Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. - **Breaking**: Removed everything marked as "deprecated" - Bumped minimum Dart SDK to >= 3.0.0-dev +## 2.5.0 - 2024-02-03 + +- Add `test` argument to `AsyncValue.guard` method. (thanks to @utamori) + ## 2.4.9 - 2023-11-27 - Fix "pending timer" issue inside tests when using `ref.keepAlive()`. - Fix `Ref.invalidate`/`Ref.refresh` not throwing on circular dependency. -- Fix an infinite loop caused by `ref.keepAlive` if the `KeepAliveLink` is immediately closed. +- Fix an infinite loop caused by `ref.keepAlive` if the `KeepAliveLink` is + immediately closed. - Fix `container.exists(provider)` on nested containers not checking their parent containers. @@ -46,13 +51,14 @@ Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. ## 2.4.6 - 2023-11-13 -- Exceptions in asynchronous providers are now correctly received - by `ProviderObserver.providerDidFail`. +- Exceptions in asynchronous providers are now correctly received by + `ProviderObserver.providerDidFail`. - Fix exception when a `ProviderScope` is rebuilt with a different `key`. ## 2.4.4 - 2023-10-15 -- Update the documentation of `provider.argument` to match the behavior of generated providers. +- Update the documentation of `provider.argument` to match the behavior of + generated providers. ## 2.4.3 - 2023-10-06 @@ -64,9 +70,8 @@ Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. ## 2.4.0 - 2023-09-04 -- Added `Notifier.stateOrNull`. - This will return `null` if used when the notifier has yet to be initialized - or is in error state. +- Added `Notifier.stateOrNull`. This will return `null` if used when the + notifier has yet to be initialized or is in error state. ## 2.3.10 - 2023-08-28 @@ -98,26 +103,26 @@ Riverpod now requires package:meta >=1.9.0 ## 2.3.3 - 2023-04-06 -- The debugger no-longer pauses on uncaught exceptions inside providers. - This was voluntary, but too many people have complained that it often - is a false positive. +- The debugger no-longer pauses on uncaught exceptions inside providers. This + was voluntary, but too many people have complained that it often is a false + positive. - Removed unused dependency (thanks to @passsy) ## 2.3.2 - 2023-03-13 -- Deprecated the generic parameter of `Family`. - This will enable implementing generic providers in `riverpod_generator` once - it is removed. +- Deprecated the generic parameter of `Family`. This will enable implementing + generic providers in `riverpod_generator` once it is removed. - Updated documentation ## 2.3.1 - 2023-03-09 -- Updated `AsyncValue.value/valueOrNull` docs to cover the "previous value" cases (thanks to @AhmedLSayed9) +- Updated `AsyncValue.value/valueOrNull` docs to cover the "previous value" + cases (thanks to @AhmedLSayed9) ## 2.3.0 -- Added `StreamNotifier` + `StreamNotifierProvider`. - This is for building a `StreamProvider` while exposing ways to modify the stream. +- Added `StreamNotifier` + `StreamNotifierProvider`. This is for building a + `StreamProvider` while exposing ways to modify the stream. It is primarily meant to be used using code-generation via riverpod_generator, by writing: @@ -132,8 +137,7 @@ Riverpod now requires package:meta >=1.9.0 } ``` -- Deprecated `StreamProvider.stream` - Instead of: +- Deprecated `StreamProvider.stream` Instead of: ```dart ref.watch(provider.stream).listen(...) @@ -162,15 +166,17 @@ Riverpod now requires package:meta >=1.9.0 }) ``` -- Some restrictions on the `dependencies` parameter of providers have been lifted. - It is no-longer necessary to include providers which do not themselves specify `dependencies`. - All providers should specify `dependencies` if they are scoped at any point. +- Some restrictions on the `dependencies` parameter of providers have been + lifted. It is no-longer necessary to include providers which do not themselves + specify `dependencies`. All providers should specify `dependencies` if they + are scoped at any point. - Annotated `Notifier.state` setter as protected. ## 2.2.0 -- Improve type-inference when using `AsyncValue.whenOrNull` (thanks to @AhmedLSayed9) +- Improve type-inference when using `AsyncValue.whenOrNull` (thanks to + @AhmedLSayed9) - Fixed AsyncValue.asError incorrectly not preserving the generic type - Internal refactoring for riverpod_generator @@ -182,8 +188,10 @@ Fixes an issue with `FutureProvider` (#2028) - Update dependencies. - fixes an exception on newer Dart versions -- fixes an edge-case where `FutureProvider`/`AsyncNotifier` did not emit the new state when the created `Future` completed (#1997) -- fixes errors inside FutureProvider/AsyncNotifier/StreamProvider not preserving the previous state (if any). +- fixes an edge-case where `FutureProvider`/`AsyncNotifier` did not emit the new + state when the created `Future` completed (#1997) +- fixes errors inside FutureProvider/AsyncNotifier/StreamProvider not preserving + the previous state (if any). ## 2.1.1 @@ -195,38 +203,46 @@ A small release adding missing utilities and fixing some web related issues. - Added `provider.overrideWith((ref) => state`) - Added `FutureProviderRef.future`. -- Deprecated `StateProvider.state` - Instead, use either `ref.watch(stateProvider)` or `ref.read(stateProvider.notifier).state =` -- Deprecated `provider.overrideWithProvider`. Instead use `provider.overrideWith` -- Added `Ref.notifyListeners()` to forcibly notify dependents. - This can be useful for mutable state. +- Deprecated `StateProvider.state` Instead, use either + `ref.watch(stateProvider)` or `ref.read(stateProvider.notifier).state =` +- Deprecated `provider.overrideWithProvider`. Instead use + `provider.overrideWith` +- Added `Ref.notifyListeners()` to forcibly notify dependents. This can be + useful for mutable state. - Added `@useResult` to `Ref.refresh`/`WidgetRef.refresh` - Added `Ref.exists` to check whether a provider is initialized or not. -- `FutureProvider`, `StreamProvider` and `AsyncNotifierProvider` now preserve the - previous data/error when going back to loading. - This is done by allowing `AsyncLoading` to optionally contain a value/error. -- Added `AsyncValue.when(skipLoadingOnReload: bool, skipLoadingOnRefresh: bool, skipError: bool)` - flags to give fine control over whether the UI should show `loading` - or `data/error` cases. +- `FutureProvider`, `StreamProvider` and `AsyncNotifierProvider` now preserve + the previous data/error when going back to loading. This is done by allowing + `AsyncLoading` to optionally contain a value/error. +- Added + `AsyncValue.when(skipLoadingOnReload: bool, skipLoadingOnRefresh: bool, skipError: bool)` + flags to give fine control over whether the UI should show `loading` or + `data/error` cases. - Add `AsyncValue.requireValue`, to forcibly obtain the `value` and throw if in loading/error state -- Doing `ref.watch(futureProvider.future)` can no-longer return a `SynchronousFuture`. - That behavior could break various `Future` utilities, such as `Future.wait` +- Doing `ref.watch(futureProvider.future)` can no-longer return a + `SynchronousFuture`. That behavior could break various `Future` utilities, + such as `Future.wait` - Add `AsyncValue.copyWithPrevious(..., isRefresh: false)` to differentiate rebuilds from `ref.watch` vs rebuilds from `ref.refresh`. -- ProviderContainer no-longer throws when disposed if it has an undisposed child ProviderContainer. +- ProviderContainer no-longer throws when disposed if it has an undisposed child + ProviderContainer. - Fixes a stackoverflow on Web caused by Dart (thanks to @leehack) -- Fixes a bug when the root ProviderContainer is not associated with a ProviderScope. -- Fixes a case where a circular dependency between providers was incorrectly allowed (#1766) +- Fixes a bug when the root ProviderContainer is not associated with a + ProviderScope. +- Fixes a case where a circular dependency between providers was incorrectly + allowed (#1766) ## 2.0.2 -- **FIX**: Fixed an assert error if a `family` depends on itself while specifying `dependencies`. (#1721). +- **FIX**: Fixed an assert error if a `family` depends on itself while + specifying `dependencies`. (#1721). ## 2.0.2 -Fixed an assert error if a `family` depends on itself while specifying `dependencies`. +Fixed an assert error if a `family` depends on itself while specifying +`dependencies`. ## 2.0.1 @@ -234,81 +250,94 @@ Updated changelog (see 2.0.0) ## 2.0.0 -Here is the changelog for all the changes in the 2.0 version. -An article is in progress and will be linked here once available. +Here is the changelog for all the changes in the 2.0 version. An article is in +progress and will be linked here once available. **Breaking changes**: - `FutureProvider.stream` is removed. - Using `overrideWithProvider`, it is no-longer possible to override a provider - with a different type of provider (such as overriding `FutureProvider` with a `StreamProvider`). -- `AsyncError.stackTrace` is now a required positional parameter and non-nullable -- All `overrideWithValue` methods are removed, besides `Provider.overrideWithValue`. - This change is temporary, and these methods will be reintroduced in a later version. - In the meantime, you can use `overrideWithProvider`. -- Modifiers (`provider.future`, `provider.state`, ...) no-longer are providers, and therefore no-longer - appear inside `ProviderObserver`. + with a different type of provider (such as overriding `FutureProvider` with a + `StreamProvider`). +- `AsyncError.stackTrace` is now a required positional parameter and + non-nullable +- All `overrideWithValue` methods are removed, besides + `Provider.overrideWithValue`. This change is temporary, and these methods will + be reintroduced in a later version. In the meantime, you can use + `overrideWithProvider`. +- Modifiers (`provider.future`, `provider.state`, ...) no-longer are providers, + and therefore no-longer appear inside `ProviderObserver`. - The `Reader` typedef is removed. Use `Ref` instead. - `ProviderListener` is removed. Used `ref.listen` instead. - Removed the deprecated `ProviderReference`. -- Providers no-longer throw a `ProviderException` if an exception was thrown while building their value. - Instead, they will rethrow the thrown exception and its stacktrace. -- It is no longer possible to pass `provider.future/.notifier/...` to the parameter `dependencies` of provider. - Passing the provider directly is enough. +- Providers no-longer throw a `ProviderException` if an exception was thrown + while building their value. Instead, they will rethrow the thrown exception + and its stacktrace. +- It is no longer possible to pass `provider.future/.notifier/...` to the + parameter `dependencies` of provider. Passing the provider directly is enough. - The `Family` type now has a single generic parameter instead of 3. Non-breaking changes: - Upgrade minimum required Dart SDK version to 2.17.0 -- Added `provider.selectAsync`, which allows to both await an async value - while also filtering rebuilds. -- Added `ref.listenSelf`, for subscribing to changes of a provider within - that provider. - That can be useful for logging purposes or storing the state of a provider - in a DB. -- Added `container.invalidate(provider)`/`ref.invalidate(provider)` and `ref.invalidateSelf()`. - These are similar to `ref.refresh` methods, but do not immediately rebuild the provider. +- Added `provider.selectAsync`, which allows to both await an async value while + also filtering rebuilds. +- Added `ref.listenSelf`, for subscribing to changes of a provider within that + provider. That can be useful for logging purposes or storing the state of a + provider in a DB. +- Added `container.invalidate(provider)`/`ref.invalidate(provider)` and + `ref.invalidateSelf()`. These are similar to `ref.refresh` methods, but do not + immediately rebuild the provider. These methods are safer than `ref.refresh` as they can avoid a provider rebuilding twice in a quick succession. - Added `ref.onAddListener`, `ref.onRemoveListener`, `ref.onCancel` and - `ref.onResume`. All of which allow performing side-effects when providers - are listened or stop being listened. + `ref.onResume`. All of which allow performing side-effects when providers are + listened or stop being listened. - A new `AutoDisposeRef.keepAlive()` function is added. It is meant to replace - `AutoDisposeRef.maintainState` to make logic for preventing the disposal of a provider more reusable. -- feat; `AutoDisposeRef.maintainState` is deprecated. Use the new `AutoDisposeRef.keepAlive()` instead. + `AutoDisposeRef.maintainState` to make logic for preventing the disposal of a + provider more reusable. +- feat; `AutoDisposeRef.maintainState` is deprecated. Use the new + `AutoDisposeRef.keepAlive()` instead. - Add support for `ref.invalidate(family)` to recompute an entire family (#1517) -- Added `AsyncValue.valueOrNull` to obtain the value while ignoring potential errors. -- Added new functionalities to `AsyncValue`: `hasError`, `hasData`, `asError`, `isLoading` - , `copyWithPrevious` and `unwrapPrevious`. +- Added `AsyncValue.valueOrNull` to obtain the value while ignoring potential + errors. +- Added new functionalities to `AsyncValue`: `hasError`, `hasData`, `asError`, + `isLoading` , `copyWithPrevious` and `unwrapPrevious`. Fixes: -- fixed a bug where `AsyncValue.whenData` did not preserve `AsyncValue.isLoading/isRefreshing` +- fixed a bug where `AsyncValue.whenData` did not preserve + `AsyncValue.isLoading/isRefreshing` - `StateProvider` and `StateNotifierProvider` no longer notify their listeners on `ref.refresh` if the new result is identical to the old one. - fixed potential null exception when using `autoDispose` -- fixed a bug where unmounting a nested ProviderScope could cause an exception (#1400) -- Fixed an issue where providers were incorrectly allowed to depend on themselves, - breaking `autoDispose` in the process. +- fixed a bug where unmounting a nested ProviderScope could cause an exception + (#1400) +- Fixed an issue where providers were incorrectly allowed to depend on + themselves, breaking `autoDispose` in the process. - Fixed a memory leak when using `StateProvider.autoDispose`'s `.state` - Fix `ProviderObserver.didDisposeProvider` not executing on provider refresh. - Fixed an issue where `AsyncValue.value` did not throw if there is an error. -- Fixed a cast error when overriding a provider with a more specific provider type (#1100) +- Fixed a cast error when overriding a provider with a more specific provider + type (#1100) - Fixed a bug where `onDispose` listeners could be executed twice under certain conditions when using `autoDispose`. -- Fixed an issue where refreshing a `provider.future`/`provider.stream` did work properly +- Fixed an issue where refreshing a `provider.future`/`provider.stream` did work + properly - Fixed false positive with `ref.watch` asserts ## 2.0.0-dev.9 -Fix Timer leak when using `cacheTime`/`disposeDelay` and disposing a `ProviderContainer` +Fix Timer leak when using `cacheTime`/`disposeDelay` and disposing a +`ProviderContainer` ## 2.0.0-dev.8 -fix: a bug where unmounting a nested ProviderScope could cause an exception (#1400) +fix: a bug where unmounting a nested ProviderScope could cause an exception +(#1400) ## 2.0.0-dev.7 @@ -316,7 +345,8 @@ Upgrade minimum required Dart SDK version to 2.17.0 ## 2.0.0-dev.6 -- Added `AsyncValue.valueOrNull` to obtain the value while ignoring potential errors. +- Added `AsyncValue.valueOrNull` to obtain the value while ignoring potential + errors. - Fixed an issue where `AsyncValue.value` did not throw if there is an error. - Fix families not applying cacheTime/disposeDelay - Fixed a bug where an exception may be thrown asynchronously after a @@ -324,30 +354,31 @@ Upgrade minimum required Dart SDK version to 2.17.0 ## 2.0.0-dev.5 -- Fixed a bug where emitting an `AsyncData` after an `AsyncError` leads to `AsyncValue.hasError` to be true +- Fixed a bug where emitting an `AsyncData` after an `AsyncError` leads to + `AsyncValue.hasError` to be true ## 2.0.0-dev.4 -- Added `ref.listenSelf`, for subscribing to changes of a provider within - that provider. - That can be useful for logging purposes or storing the state of a provider - in a DB. -- Added `disposeDelay` to all `autoDispose` providers and to `ProviderContainer`/`ProviderScope`. - This configures the amount of time before a provider is disposed when it is - not listened. +- Added `ref.listenSelf`, for subscribing to changes of a provider within that + provider. That can be useful for logging purposes or storing the state of a + provider in a DB. +- Added `disposeDelay` to all `autoDispose` providers and to + `ProviderContainer`/`ProviderScope`. This configures the amount of time before + a provider is disposed when it is not listened. -- Added `container.invalidate(provider)`/`ref.invalidate(provider)` and `ref.invalidateSelf()`. - These are similar to `ref.refresh` methods, but do not immediately rebuild the provider. +- Added `container.invalidate(provider)`/`ref.invalidate(provider)` and + `ref.invalidateSelf()`. These are similar to `ref.refresh` methods, but do not + immediately rebuild the provider. These methods are safer than `ref.refresh` as they can avoid a provider rebuilding twice in a quick succession. -- The duration passed to `cacheTime` now represents the minimum amount of - time after the latest change of a provider, instead of the first time - a provider built. +- The duration passed to `cacheTime` now represents the minimum amount of time + after the latest change of a provider, instead of the first time a provider + built. -- Fixed an issue where providers were incorrectly allowed to depend on themselves, - breaking `autoDispose` in the process. +- Fixed an issue where providers were incorrectly allowed to depend on + themselves, breaking `autoDispose` in the process. - Fixed a memory leak when using `StateProvider.autoDispose`'s `.state` @@ -355,64 +386,69 @@ Upgrade minimum required Dart SDK version to 2.17.0 ## 2.0.0-dev.3 -When calling `ref.listen` on a provider, this provider will now properly -rebuild if one of its dependency had changed. +When calling `ref.listen` on a provider, this provider will now properly rebuild +if one of its dependency had changed. ## 2.0.0-dev.2 - Deprecated `ref.maintainState=` in favor of a newly added `ref.keepAlive()`. - This new `ref.keepAlive()` function is similar to `maintainState` but - better handles cases where we have multiple logics that want to - keep the state of a provider alive for some period of time. + This new `ref.keepAlive()` function is similar to `maintainState` but better + handles cases where we have multiple logics that want to keep the state of a + provider alive for some period of time. - Removed the deprecated `ProviderReference`. -- Added `ProviderContainer.cacheTime` and `MyProvider.autoDispose(..., cacheTime: duration)`. - `cacheTime` is used to keep an `autoDispose` provider alive for at least - a minimum amount of time before it gets disposed if not listened. +- Added `ProviderContainer.cacheTime` and + `MyProvider.autoDispose(..., cacheTime: duration)`. `cacheTime` is used to + keep an `autoDispose` provider alive for at least a minimum amount of time + before it gets disposed if not listened. - Added `ref.onAddListener`, `ref.onRemoveListener`, `ref.onCancel` and - `ref.onResume`. All of which allow performing side-effects when providers - are listened or stop being listened. + `ref.onResume`. All of which allow performing side-effects when providers are + listened or stop being listened. ## 2.0.0-dev.1 - Now requires Dart 2.16 -- **Breaking** Providers no-longer throw a `ProviderException` if an exception was thrown while building their value. - Instead, they will rethrow the thrown exception and its stacktrace. +- **Breaking** Providers no-longer throw a `ProviderException` if an exception + was thrown while building their value. Instead, they will rethrow the thrown + exception and its stacktrace. - Removed `AsyncValue`'s `isError`/`isData` -- Added new functionalities to `AsyncValue`: `hasError`, `hasData`, `copyWithPrevious` -- Added `provider.selectAsync`, which allows to both await an async value - while also filtering rebuilds. -- When a provider emits an `AsyncError` followed by an `AsyncData`, - the `AsyncData` emitted will now contain the latest error/stackTrace too. +- Added new functionalities to `AsyncValue`: `hasError`, `hasData`, + `copyWithPrevious` +- Added `provider.selectAsync`, which allows to both await an async value while + also filtering rebuilds. +- When a provider emits an `AsyncError` followed by an `AsyncData`, the + `AsyncData` emitted will now contain the latest error/stackTrace too. -- Fixed a cast error when overriding a provider with a more specific provider type (#1100) +- Fixed a cast error when overriding a provider with a more specific provider + type (#1100) - Fixed a bug where `onDispose` listeners could be executed twice under certain conditions when using `autoDispose`. ## 2.0.0-dev.0 -- **Breaking** After a provider has emitted an `AsyncValue.data` or `AsyncValue.error`, - that provider will no longer emit an `AsyncValue.loading`. +- **Breaking** After a provider has emitted an `AsyncValue.data` or + `AsyncValue.error`, that provider will no longer emit an `AsyncValue.loading`. Instead, it will re-emit the latest value, but with the property `AsyncValue.isRefreshing` to true. - This allows the UI to keep showing the previous data/error when a provider - is being refreshed. + This allows the UI to keep showing the previous data/error when a provider is + being refreshed. -- Adding `isLoading`, `isError`, `isData` and `asError` to `AsyncValue`. - Those getters allow interacting with `AsyncValue` without having to rely on - pattern matching. -- Fixed an issue where refreshing a `provider.future`/`provider.stream` did work properly +- Adding `isLoading`, `isError`, `isData` and `asError` to `AsyncValue`. Those + getters allow interacting with `AsyncValue` without having to rely on pattern + matching. +- Fixed an issue where refreshing a `provider.future`/`provider.stream` did work + properly - Fixed false positive with `ref.watch` asserts ## 1.0.3 -Removed an assert preventing from overriding the same provider/family -multiple times on a `ProviderScope`/`ProviderContainer`. +Removed an assert preventing from overriding the same provider/family multiple +times on a `ProviderScope`/`ProviderContainer`. ## 1.0.2 @@ -429,20 +465,31 @@ Riverpod is now stable! ### General changes -- **Breaking**: `ProviderContainer.debugProviderValues` and `ProviderContainer.debugProviderElements` are removed. - You can now instead use `ProviderContainer.getAllProviderElements`. +- **Breaking**: `ProviderContainer.debugProviderValues` and + `ProviderContainer.debugProviderElements` are removed. You can now instead use + `ProviderContainer.getAllProviderElements`. - Increased minimum SDK version to 2.14.0 + <<<<<<< HEAD - **Breaking** The return value when reading a `StateProvider` changed. Before, doing `ref.read(someStateProvider)` would return the `StateController` instance. Now, this will only return the state of the `StateController`. This new behavior matches `StateNotifierProvider`. + ======= +- **Breaking** The return value when reading a `StateProvider` changed. Before, + doing `ref.read(someStateProvider)` would return the `StateController` + instance. Now, this will only return the state of the `StateController`. This + new behaviour matches `StateNotifierProvider`. + + > > > > > > > 1f6e3c462bdb2f8e058be63ab309ca2eb01ed71e For a simple migration, the old behavior is available by writing `ref.read(someStateProvider.state)`. -- Added `ref.listen` for triggering actions inside providers/widgets when a provider changes. +- Added `ref.listen` for triggering actions inside providers/widgets when a + provider changes. - It can be used to listen to another provider without recreating the provider state: + It can be used to listen to another provider without recreating the provider + state: ```dart final counterProvider = StateNotifierProvider(...); @@ -469,8 +516,9 @@ Riverpod is now stable! } ``` -- It is now possible to "await" all providers that emit an `AsyncValue` (previously limited to `FutureProvider`/`StreamProvider`). - This includes cases where a `StateNotifierProvider` exposes an `AsyncValue`: +- It is now possible to "await" all providers that emit an `AsyncValue` + (previously limited to `FutureProvider`/`StreamProvider`). This includes cases + where a `StateNotifierProvider` exposes an `AsyncValue`: ```dart class MyAsyncStateNotifier extends StateNotifier> { @@ -490,30 +538,34 @@ Riverpod is now stable! - Deprecated `StreamProvider.last` in favor of `StreamProvider.future`. -- `StreamProvider.future`, `StreamProvider.stream` and `FutureProvider.future` now - expose a future/stream that is independent from how many times the associated provider "rebuilt": +- `StreamProvider.future`, `StreamProvider.stream` and `FutureProvider.future` + now expose a future/stream that is independent from how many times the + associated provider "rebuilt": - if a `StreamProvider` rebuild before its stream emitted any value, - `StreamProvider.future` will resolve with the first value of the new stream instead. + `StreamProvider.future` will resolve with the first value of the new stream + instead. - if a `FutureProvider` rebuild before its future completes, - `FutureProvider.future` will resolve with the result of the new future instead. -- You can now override any provider with any other provider, as long as the value - that they expose matches. For example, it is possible to override a `StreamProvider` - with a `Provider>`. -- `ref.onDispose` now calls the dispose function as soon as one of the provider's - dependencies is known to have changed + `FutureProvider.future` will resolve with the result of the new future + instead. +- You can now override any provider with any other provider, as long as the + value that they expose matches. For example, it is possible to override a + `StreamProvider` with a `Provider>`. +- `ref.onDispose` now calls the dispose function as soon as one of the + provider's dependencies is known to have changed - Providers can now call `ref.refresh` to refresh a provider, instead of having to do `ref.container.refresh`. - Providers no longer wait until their next read to recompute their state if one of their dependencies changed and they have listeners. - Added `ProviderContainer.pump`, a utility to easily "await" until providers notify their listeners or are disposed. -- fixed an issue when using both `family` and `autoDispose` that could lead to an inconsistent state +- fixed an issue when using both `family` and `autoDispose` that could lead to + an inconsistent state ### Unified the syntax for interacting with providers - `ProviderReference` is deprecated in favor of `Ref`. -- `ref.watch` now supports `myProvider.select((value) => ...)`. - This allows filtering rebuilds: +- `ref.watch` now supports `myProvider.select((value) => ...)`. This allows + filtering rebuilds: ```dart final userProvider = StateNotifierProvider(...); @@ -525,7 +577,8 @@ Riverpod is now stable! }); ``` -- **Breaking**: `ProviderObserver.didUpdateProvider` now receives both the previous and new value. +- **Breaking**: `ProviderObserver.didUpdateProvider` now receives both the + previous and new value. - **Breaking**: `ProviderObserver.mayHaveChanged` is removed. - **Breaking**: `Family.overrideWithProvider` now must create a provider: @@ -538,7 +591,8 @@ Riverpod is now stable! ); ``` -- All providers now receive a custom subclass of `ProviderRefBase` as a parameter: +- All providers now receive a custom subclass of `ProviderRefBase` as a + parameter: ```dart Provider((ProviderRef ref) {...}); @@ -546,10 +600,12 @@ Riverpod is now stable! StateProvider((StateProviderRef ref) {...}); ``` - That allows providers to implement features that is not shared with other providers. + That allows providers to implement features that is not shared with other + providers. - - `Provider`, `FutureProvider` and `StreamProvider`'s `ref` now have a `state` property, - which represents the currently exposed value. Modifying it will notify the listeners: + - `Provider`, `FutureProvider` and `StreamProvider`'s `ref` now have a `state` + property, which represents the currently exposed value. Modifying it will + notify the listeners: ```dart Provider((ref) { @@ -564,7 +620,8 @@ Riverpod is now stable! - `StateProvider`'s `ref` now has a `controller` property, which allows the provider to access the `StateController` exposed. -- **Breaking**: `ProviderReference.mounted` is removed. You can implement something similar using `onDispose`: +- **Breaking**: `ProviderReference.mounted` is removed. You can implement + something similar using `onDispose`: ```dart Provider((ref) { var mounted = true; @@ -574,12 +631,12 @@ Riverpod is now stable! ### All providers can now be scoped. -- **Breaking**: `ScopedProvider` is removed. - To migrate, change `ScopedProvider`s to `Provider`s. +- **Breaking**: `ScopedProvider` is removed. To migrate, change + `ScopedProvider`s to `Provider`s. - All providers now come with an extra named parameter called `dependencies`. - This parameter optionally allows defining the list of providers/families that this - new provider depends on: + This parameter optionally allows defining the list of providers/families that + this new provider depends on: ```dart final a = Provider(...); @@ -587,12 +644,14 @@ Riverpod is now stable! final b = Provider((ref) => ref.watch(a), dependencies: [a]); ``` - By doing so, this will tell Riverpod to automatically override `b` if `a` gets overridden. + By doing so, this will tell Riverpod to automatically override `b` if `a` gets + overridden. ### Updated `AsyncValue`: - **Breaking** `AsyncValue.copyWith` is removed -- **Breaking** `AsyncValue.error(..., stacktrace)` is now a named parameter instead of positional parameter. +- **Breaking** `AsyncValue.error(..., stacktrace)` is now a named parameter + instead of positional parameter. - Deprecated `AsyncValue.data` in favor of `AsyncValue.value` - Allowed `AsyncData`, `AsyncError` and `AsyncLoading` to be extended - Added `AsyncValue.whenOrNull`, similar to `whenOrElse` but instead of an @@ -601,7 +660,8 @@ Riverpod is now stable! loading/error states. - `AsyncError` can now be instantiated with `const`. -- Added `StateController.update`, to simplify updating the state from the previous state: +- Added `StateController.update`, to simplify updating the state from the + previous state: ```dart final provider = StateController((ref) => 0); ... @@ -613,15 +673,18 @@ Riverpod is now stable! provider.select((value) => ref.watch(something)); // KO, cannot use ref.watch inside selectors ``` -- FutureProvider now creates a `FutureOr` instead of a `Future`. - That allows bypassing the loading state in the event where a value was synchronously available. +- FutureProvider now creates a `FutureOr` instead of a `Future`. That + allows bypassing the loading state in the event where a value was + synchronously available. ### Bug fixes -- Fixed a bug where widgets were not rebuilding in release mode under certain conditions -- **FIX**: StreamProvider.last no longer throws a StateError when no value were emitted (#296). -- fixed an issue where when chaining providers, widgets may re-render - a frame late, potentially causing a flicker. (see #648) +- Fixed a bug where widgets were not rebuilding in release mode under certain + conditions +- **FIX**: StreamProvider.last no longer throws a StateError when no value were + emitted (#296). +- fixed an issue where when chaining providers, widgets may re-render a frame + late, potentially causing a flicker. (see #648) ## 1.0.0-dev.10 @@ -636,13 +699,13 @@ Fix an issue where `*Provider.autoDispose` were not able to specify the ### Future/StreamProvider -- FutureProvider now creates a `FutureOr` instead of a `Future` - That allows bypassing the loading state in the event where a value was synchronously available. +- FutureProvider now creates a `FutureOr` instead of a `Future` That + allows bypassing the loading state in the event where a value was + synchronously available. -- During loading and error states, `FutureProvider` and `StreamProvider` now expose the - latest value through `AsyncValue`. - That allows UI to show the previous data while some new data is loading, - instead of showing a spinner: +- During loading and error states, `FutureProvider` and `StreamProvider` now + expose the latest value through `AsyncValue`. That allows UI to show the + previous data while some new data is loading, instead of showing a spinner: ```dart final provider = FutureProvider((ref) async { @@ -671,9 +734,10 @@ Fix an issue where `*Provider.autoDispose` were not able to specify the ### AsyncValue - **Breaking** `AsyncValue.copyWith` is removed -- **Breaking** `AsyncValue.error(..., stacktrace)` is now a named parameter instead of positional parameter. -- **Breaking** `AsyncValue.when(loading: )` and `AsyncValue.when(error: )` (and `when` variants) - now receive an extra "previous" parameter. +- **Breaking** `AsyncValue.error(..., stacktrace)` is now a named parameter + instead of positional parameter. +- **Breaking** `AsyncValue.when(loading: )` and `AsyncValue.when(error: )` (and + `when` variants) now receive an extra "previous" parameter. - Deprecated `AsyncValue.data` in favor of `AsyncValue.value` - Allowed `AsyncData`, `AsyncError` and `AsyncLoading` to be extended - Added `AsyncValue.whenOrNull`, similar to `whenOrElse` but instead of an @@ -685,11 +749,11 @@ Fix an issue where `*Provider.autoDispose` were not able to specify the ### General -- **Breaking** All `overrideWithProvider` methods are removed. - To migrate, instead use `overrideWithValue`. +- **Breaking** All `overrideWithProvider` methods are removed. To migrate, + instead use `overrideWithValue`. - All providers now come with an extra named parameter called `dependencies`. - This parameter optionally allows defining the list of providers/families that this - new provider depends on: + This parameter optionally allows defining the list of providers/families that + this new provider depends on: ```dart final a = Provider(...); @@ -697,9 +761,11 @@ Fix an issue where `*Provider.autoDispose` were not able to specify the final b = Provider((ref) => ref.watch(a), dependencies: [a]); ``` - By doing so, this will tell Riverpod to automatically override `b` if `a` gets overridden. + By doing so, this will tell Riverpod to automatically override `b` if `a` gets + overridden. -- Added `StateController.update`, to simplify updating the state from the previous state: +- Added `StateController.update`, to simplify updating the state from the + previous state: ```dart final provider = StateController((ref) => 0); ... @@ -716,21 +782,24 @@ Fix an issue where `*Provider.autoDispose` were not able to specify the - fixed `ref.listen` now working when downcasing the value of a provider. - fixed a bug where disposing a scoped `ProviderContainer` could cause other `ProviderContainer`s to stop working. -- fixed an issue where conditionally depending on an "autoDispose" provider - may not properly dispose of it (see #712) -- fixed an issue where when chaining providers, widgets may re-render - a frame late, potentially causing a flicker. (see #648) +- fixed an issue where conditionally depending on an "autoDispose" provider may + not properly dispose of it (see #712) +- fixed an issue where when chaining providers, widgets may re-render a frame + late, potentially causing a flicker. (see #648) ## 1.0.0-dev.7 - Fixed `ProviderObserver` not working when modifying a `StateProvider`. - Fixed a bug where scoped provider were potentially not disposed -- Fixed a bug where widgets were not rebuilding in release mode under certain conditions +- Fixed a bug where widgets were not rebuilding in release mode under certain + conditions ## 1.0.0-dev.6 -- **FIX**: StreamProvider.last no longer throws a StateError when no value were emitted (#296). -- Re-enabled debug assertions that were temporarily disabled by previous dev versions. +- **FIX**: StreamProvider.last no longer throws a StateError when no value were + emitted (#296). +- Re-enabled debug assertions that were temporarily disabled by previous dev + versions. - Allows families to be scoped/overridden - Fixed bugs with `ref.refresh` not working on some providers - renamed `ProviderBase.recreateShouldNotify` to `updateShouldNotify` @@ -746,7 +815,8 @@ Fixed various issues related to scoped providers. ## 1.0.0-dev.2 - All providers can now be scoped. -- **breaking**: `ScopedProvider` is removed. To migrate, change `ScopedProvider`s to `Provider`s. +- **breaking**: `ScopedProvider` is removed. To migrate, change + `ScopedProvider`s to `Provider`s. ## 1.0.0-dev.1 @@ -754,8 +824,8 @@ Fixed various issues related to scoped providers. ## 1.0.0-dev.0 -- `ref.watch` now support `myProvider.select((value) => ...)`. - This allows filtering rebuilds: +- `ref.watch` now support `myProvider.select((value) => ...)`. This allows + filtering rebuilds: ```dart final userProvider = StateNotifierProvider(...); @@ -777,9 +847,11 @@ Fixed various issues related to scoped providers. ); ``` -- **Breaking**: `ProviderObserver.didUpdateProvider` now receives both the previous and new value. +- **Breaking**: `ProviderObserver.didUpdateProvider` now receives both the + previous and new value. - **Breaking**: `ProviderObserver.mayHaveChanged` is removed. -- Added `ref.listen`, used to listen to another provider without recreating the provider state: +- Added `ref.listen`, used to listen to another provider without recreating the + provider state: ```dart final counter = StateNotifierProvider(...); @@ -792,7 +864,8 @@ Fixed various issues related to scoped providers. ``` - `ProviderReference` is deprecated in favor of `ProviderRefBase`. -- All providers now receive a custom subclass of `ProviderRefBase` as a parameter: +- All providers now receive a custom subclass of `ProviderRefBase` as a + parameter: ```dart Provider((ProviderRef ref) {...}); @@ -800,10 +873,12 @@ Fixed various issues related to scoped providers. StateProvider((StateProviderRef ref) {...}); ``` - That allows providers to implement features that is not shared with other providers. + That allows providers to implement features that is not shared with other + providers. - - `Provider`, `FutureProvider` and `StreamProvider`'s `ref` now have a `state` property, - which represents the currently exposed value. Modifying it will notify the listeners: + - `Provider`, `FutureProvider` and `StreamProvider`'s `ref` now have a `state` + property, which represents the currently exposed value. Modifying it will + notify the listeners: ```dart Provider((ref) { @@ -818,46 +893,60 @@ Fixed various issues related to scoped providers. - `StateProvider`'s `ref` now has a `controller` property, which allows the provider to access the `StateController` exposed. -- **Breaking**: `ProviderReference.mounted` is removed. You can implement something similar using `onDispose`: +- **Breaking**: `ProviderReference.mounted` is removed. You can implement + something similar using `onDispose`: ```dart Provider((ref) { var mounted = true; ref.onDispose(() => mounted = false); }); ``` -- **Breaking**: `ProviderContainer.debugProviderValues` and `ProviderContainer.debugProviderElements` are removed. - You can now instead use `ProviderContainer.getAllProviderElements`. +- **Breaking**: `ProviderContainer.debugProviderValues` and + `ProviderContainer.debugProviderElements` are removed. You can now instead use + `ProviderContainer.getAllProviderElements`. - `StreamProvider.last`, `StreamProvider.stream` and `FutureProvider.future` now - expose a future/stream that is independent from how many times the associated provider "rebuilt": + expose a future/stream that is independent from how many times the associated + provider "rebuilt": - if a `StreamProvider` rebuild before its stream emitted any value, - `StreamProvider.last` will resolve with the first value of the new stream instead. + `StreamProvider.last` will resolve with the first value of the new stream + instead. - if a `FutureProvider` rebuild before its future completes, - `FutureProvider.future` will resolve with the result of the new future instead. -- You can now override any provider with any other provider, as long as the value - that they expose matches. For example, it is possible to override a `StreamProvider` - with a `Provider>`. -- `ref.onDispose` now calls the dispose function as soon as one of the provider's - dependency is known to have changed + `FutureProvider.future` will resolve with the result of the new future + instead. +- You can now override any provider with any other provider, as long as the + value that they expose matches. For example, it is possible to override a + `StreamProvider` with a `Provider>`. +- `ref.onDispose` now calls the dispose function as soon as one of the + provider's dependency is known to have changed - Providers can now call `ref.refresh` to refresh a provider, instead of having to do `ref.container.refresh`. - Providers no longer wait until their next read to recompute their state if one of their dependencies changed and they have listeners. - Added `ProviderContainer.pump`, a utility to easily "await" until providers notify their listeners or are disposed. -- fixed an issue when using both `family` and `autoDispose` that could lead to an inconsistent state +- fixed an issue when using both `family` and `autoDispose` that could lead to + an inconsistent state ## 0.14.0+3 -Removed an assert that could cause issues when an application is partially migrated to null safety. +Removed an assert that could cause issues when an application is partially +migrated to null safety. ## 0.14.0+1 -- Re-added `StateProvider.overrideWithValue`/`StateProvider.overrideWithProvider` that were involuntarily removed. +<<<<<<< HEAD + +- # Re-added `StateProvider.overrideWithValue`/`StateProvider.overrideWithProvider` that were involuntarily removed. +- Re-added + `StateProvider.overrideWithValue`/`StateProvider.overrideWithProvider` that + were unvoluntarily removed. + > > > > > > > 1f6e3c462bdb2f8e058be63ab309ca2eb01ed71e ## 0.14.0 -- **BREAKING CHANGE** The `Listener`/`LocatorMixin` typedefs are removed as the former could cause a name - conflict with the widget named `Listener` and the latter is not supported when using Riverpod. +- **BREAKING CHANGE** The `Listener`/`LocatorMixin` typedefs are removed as the + former could cause a name conflict with the widget named `Listener` and the + latter is not supported when using Riverpod. - **BREAKING CHANGE** The syntax for using `StateNotifierProvider` was updated. Before: @@ -887,18 +976,23 @@ Removed an assert that could cause issues when an application is partially migra } ``` - See also https://github.com/rrousselGit/riverpod/issues/341 for more information. + See also https://github.com/rrousselGit/riverpod/issues/341 for more + information. -- **BREAKING CHANGE** It is no longer possible to override `StreamProvider.stream/last` and `FutureProvider.future`. -- feat: Calling `ProviderContainer.dispose` multiple time no longer throws. - This simplifies the tear-off logic of tests. +- **BREAKING CHANGE** It is no longer possible to override + `StreamProvider.stream/last` and `FutureProvider.future`. +- feat: Calling `ProviderContainer.dispose` multiple time no longer throws. This + simplifies the tear-off logic of tests. - feat: Added `ChangeNotifierProvider.notifier` and `StateProvider.notifier` - They allow obtaining the notifier associated with the provider, without causing widgets/providers to rebuild when the state updates. -- fix: overriding a `StateNotifierProvider`/`ChangeNotifierProvider` with `overrideWithValue` now correctly listens to the notifier. + They allow obtaining the notifier associated with the provider, without + causing widgets/providers to rebuild when the state updates. +- fix: overriding a `StateNotifierProvider`/`ChangeNotifierProvider` with + `overrideWithValue` now correctly listens to the notifier. ## 0.13.1 -- Fixed a bug where overriding a `FutureProvider` with an error value could cause tests to fail (see https://github.com/rrousselGit/riverpod/issues/355) +- Fixed a bug where overriding a `FutureProvider` with an error value could + cause tests to fail (see https://github.com/rrousselGit/riverpod/issues/355) ## 0.13.0 @@ -906,16 +1000,20 @@ Removed an assert that could cause issues when an application is partially migra - `ProviderObserver` can now have a const constructor - Added the mechanism for state-inspection using the Flutter devtool - loosened the version constraints of `freezed_annotation` -- deprecated `import 'riverpod/all.dart'`. Now everything is available with `riverpod/riverpod.dart`. -- Fixed a but where listening to `StreamProvider.last` could result in a `StateError` (#217) +- deprecated `import 'riverpod/all.dart'`. Now everything is available with + `riverpod/riverpod.dart`. +- Fixed a but where listening to `StreamProvider.last` could result in a + `StateError` (#217) ## 0.13.0-nullsafety.3 -- deprecated `import 'riverpod/all.dart'`. Now everything is available with `riverpod/riverpod.dart`. +- deprecated `import 'riverpod/all.dart'`. Now everything is available with + `riverpod/riverpod.dart`. ## 0.13.0-nullsafety.1 -- Fixed a but where listening to `StreamProvider.last` could result in a `StateError` (#217) +- Fixed a but where listening to `StreamProvider.last` could result in a + `StateError` (#217) ## 0.13.0-nullsafety.0 @@ -927,17 +1025,20 @@ Migrated to null-safety ## 0.12.1 -- Fixed an remaining memory leak related to StreamProvider (see also https://github.com/rrousselGit/riverpod/issues/193) +- Fixed an remaining memory leak related to StreamProvider (see also + https://github.com/rrousselGit/riverpod/issues/193) ## 0.12.0 -- **Breaking** FutureProvider and StreamProvider no longer supports `null` as a valid value. -- Fixed a memory leak with StreamProvider (see also https://github.com/rrousselGit/riverpod/issues/193) +- **Breaking** FutureProvider and StreamProvider no longer supports `null` as a + valid value. +- Fixed a memory leak with StreamProvider (see also + https://github.com/rrousselGit/riverpod/issues/193) ## 0.11.2 -- Fixed a bug where providers (usually ScopedProviders) did not dispose correctly - (see also https://github.com/rrousselGit/riverpod/issues/154). +- Fixed a bug where providers (usually ScopedProviders) did not dispose + correctly (see also https://github.com/rrousselGit/riverpod/issues/154). ## 0.11.0 @@ -949,12 +1050,14 @@ Migrated to null-safety ## 0.10.0 -- Fixed a bug where the state of a provider may be disposed when it shouldn't be disposed. +- Fixed a bug where the state of a provider may be disposed when it shouldn't be + disposed. - Added a way to import the implementation class of providers with modifiers, such as `AutoDisposeProvider`. - This is useful if you want to use Riverpod with the lint `always_specify_types`: + This is useful if you want to use Riverpod with the lint + `always_specify_types`: ```dart import 'package:riverpod/all.dart'; @@ -969,7 +1072,8 @@ Migrated to null-safety ## 0.8.0 -- Renamed `ProviderContainer.debugProviderStates` to `ProviderContainer.debugProviderElements` +- Renamed `ProviderContainer.debugProviderStates` to + `ProviderContainer.debugProviderElements` - Fixed a bug where updating `ProviderScope.overrides` may cause an exception for no reason (see https://github.com/rrousselGit/riverpod/issues/107) @@ -978,7 +1082,8 @@ Migrated to null-safety - `ref.watch` on non ".autoDispose" providers can no longer read ".autoDispose" providers. - For more info, see http://riverpod.dev/docs/concepts/modifiers/auto_dispose#the-argument-type-autodisposeprovider-cant-be-assigned-to-the-parameter-type-alwaysaliveproviderbase + For more info, see + http://riverpod.dev/docs/concepts/modifiers/auto_dispose#the-argument-type-autodisposeprovider-cant-be-assigned-to-the-parameter-type-alwaysaliveproviderbase - `ScopedProvider` now accepts `null` as a function: @@ -997,14 +1102,14 @@ Migrated to null-safety ## 0.6.1 -- Fixed a bug where when disposing `ProviderContainer`, providers may be disposed - in an incorrect order. +- Fixed a bug where when disposing `ProviderContainer`, providers may be + disposed in an incorrect order. - Improved the performances of reading providers by 25% ## 0.6.0 -- Merged `Computed` and `Provider`. Now, all providers have the ability to rebuild - their state when one of the object they listen changed. +- Merged `Computed` and `Provider`. Now, all providers have the ability to + rebuild their state when one of the object they listen changed. To migrate, change: @@ -1026,9 +1131,9 @@ Migrated to null-safety }); ``` -- `Computed` (now `Provider`) no longer deeply compare collections to avoid rebuilds. - Comparing the content of lists is quite expensive and actually rarely useful. - Now, a simple `==` comparison is used. +- `Computed` (now `Provider`) no longer deeply compare collections to avoid + rebuilds. Comparing the content of lists is quite expensive and actually + rarely useful. Now, a simple `==` comparison is used. - Renamed `ProviderStateOwner` to `ProviderContainer` - Renamed `ProviderStateOwnerObserver` to `ProviderObserver` @@ -1036,19 +1141,19 @@ Migrated to null-safety - It is no longer possible to override a provider anywhere in the widget tree. Providers can only be overridden in the top-most `ProviderContainer`. -- Providers can now read values which may change over time using `ref.read` and `ref.watch`. - When using `ref.watch`, if the value obtained changes, this will cause the provider - to re-create its state. +- Providers can now read values which may change over time using `ref.read` and + `ref.watch`. When using `ref.watch`, if the value obtained changes, this will + cause the provider to re-create its state. -- It is no longer possible to add `ProviderObserver` anywhere in the widget tree. - They can be added only on the top-most `ProviderContainer`. +- It is no longer possible to add `ProviderObserver` anywhere in the widget + tree. They can be added only on the top-most `ProviderContainer`. -- Added `ProviderContainer.refresh(provider)`. - This method allows forcing the refresh of a provider, which can be useful - for things like "retry on error" or "pull to refresh". +- Added `ProviderContainer.refresh(provider)`. This method allows forcing the + refresh of a provider, which can be useful for things like "retry on error" or + "pull to refresh". -* `ref.read(StreamProvider)` no longer returns a `Stream` but an `AsyncValue` - Before: +* `ref.read(StreamProvider)` no longer returns a `Stream` but an + `AsyncValue` Before: ```dart final streamProvider = StreamProvider(...); @@ -1066,7 +1171,8 @@ Migrated to null-safety }); ``` -* `ref.read(FutureProvider)` no longer returns a `Future` but an `AsyncValue` +* `ref.read(FutureProvider)` no longer returns a `Future` but an + `AsyncValue` Before: @@ -1086,8 +1192,8 @@ Migrated to null-safety }); ``` -* Removed `ref.dependOn`. - You can now use `ref.read`/`ref.watch` to achieve the same effect. +* Removed `ref.dependOn`. You can now use `ref.read`/`ref.watch` to achieve the + same effect. Before: @@ -1107,7 +1213,8 @@ Migrated to null-safety }); ``` -* `Provider.readOwner(ProviderStateOwner)` is changed into `ProviderContainer.read(Provider)` +* `Provider.readOwner(ProviderStateOwner)` is changed into + `ProviderContainer.read(Provider)` * `Provider.watchOwner(ProviderStateOwner, (value) {})` is changed into: @@ -1124,12 +1231,11 @@ Migrated to null-safety subscription.close(); ``` -* `MyProvider.family.autoDispose` now correctly free both the arguments and the associated - providers from memory when the provider is no longer listened to. +* `MyProvider.family.autoDispose` now correctly free both the arguments and the + associated providers from memory when the provider is no longer listened to. - Added `ScopedProvider`, a new kind of provider that can be overridden anywhere - in the widget tree. - Normal providers cannot read a `ScopedProvider`. + in the widget tree. Normal providers cannot read a `ScopedProvider`. ## 0.5.1 @@ -1140,7 +1246,9 @@ Migrated to null-safety ## 0.5.0 - Changed `ComputedFamily` into `Computed.family` -- Added [AsyncValue.guard](https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue/guard.html to simplify transforming a Future into an AsyncValue. +- Added + [AsyncValue.guard](https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue/guard.html + to simplify transforming a Future into an AsyncValue. - Improved the documentation of the different providers ## 0.4.0 @@ -1168,22 +1276,23 @@ The behavior is the same. Only the syntax changed. ## 0.3.0 -- Added `AsyncValue.whenData`, syntax sugar for `AsyncValue.when` to handle - only the `data` case and do nothing for the error/loading cases. +- Added `AsyncValue.whenData`, syntax sugar for `AsyncValue.when` to handle only + the `data` case and do nothing for the error/loading cases. - Fixed a bug that caused [Computed] to crash if it stopped being listened to then was listened to again. ## 0.2.1 -- `Computed` now correctly unsubscribe to a provider when their - function stops using a provider. +- `Computed` now correctly unsubscribe to a provider when their function stops + using a provider. ## 0.2.0 - `ref.read` is renamed as `ref.dependOn` -- Deprecated `ref.dependOn(streamProvider).stream` and `ref.dependOn(futureProvider).future` - in favor of a universal `ref.dependOn(provider).value`. +- Deprecated `ref.dependOn(streamProvider).stream` and + `ref.dependOn(futureProvider).future` in favor of a universal + `ref.dependOn(provider).value`. - added `ref.read(provider)`, syntax sugar for `ref.dependOn(provider).value`. ## 0.1.0 diff --git a/packages/riverpod/example/lib/models.freezed.dart b/packages/riverpod/example/lib/models.freezed.dart index dcea04b78..64e8bd61f 100644 --- a/packages/riverpod/example/lib/models.freezed.dart +++ b/packages/riverpod/example/lib/models.freezed.dart @@ -12,7 +12,7 @@ part of 'models.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Configuration _$ConfigurationFromJson(Map json) { return _Configuration.fromJson(json); @@ -125,7 +125,7 @@ class _$ConfigurationImpl implements _Configuration { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ConfigurationImpl && @@ -281,7 +281,7 @@ class _$MarvelResponseImpl implements _MarvelResponse { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$MarvelResponseImpl && @@ -424,7 +424,7 @@ class _$MarvelDataImpl implements _MarvelData { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$MarvelDataImpl && @@ -572,7 +572,7 @@ class _$ComicImpl implements _Comic { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ComicImpl && diff --git a/packages/riverpod/lib/src/common.dart b/packages/riverpod/lib/src/common.dart index 1138940ae..94966f907 100644 --- a/packages/riverpod/lib/src/common.dart +++ b/packages/riverpod/lib/src/common.dart @@ -157,12 +157,33 @@ sealed class AsyncValue { /// }); /// } /// } + /// + /// An optional callback can be specified to catch errors only under a certain condition. + /// In the following example, we catch all exceptions beside FormatExceptions. + /// + /// ```dart + /// AsyncValue.guard( + /// () async { /* ... */ }, + /// // Catch all errors beside [FormatException]s. + /// (err) => err is! FormatException, + /// ); + /// } /// ``` - static Future> guard(Future Function() future) async { + static Future> guard( + Future Function() future, [ + bool Function(Object)? test, + ]) async { try { return AsyncValue.data(await future()); } catch (err, stack) { - return AsyncValue.error(err, stack); + if (test == null) { + return AsyncValue.error(err, stack); + } + if (test(err)) { + return AsyncValue.error(err, stack); + } + + Error.throwWithStackTrace(err, stack); } } diff --git a/packages/riverpod/lib/src/framework/foundation.dart b/packages/riverpod/lib/src/framework/foundation.dart index cf6190e68..d15697e0f 100644 --- a/packages/riverpod/lib/src/framework/foundation.dart +++ b/packages/riverpod/lib/src/framework/foundation.dart @@ -75,6 +75,11 @@ abstract class ProviderOrFamily implements ProviderListenableOrFamily { /// /// In that scenario, the `dependencies` parameter is required and it must /// include `scopedProvider`. + /// + /// See also: + /// - [provider_dependencies](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint#provider_dependencies-riverpod_generator-only) + /// and [scoped_providers_should_specify_dependencies](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint#scoped_providers_should_specify_dependencies-generator-only).\ + /// These are lint rules that will warn about incorrect `dependencies` usages. final Iterable? dependencies; /// All the dependencies of a provider and their dependencies too. diff --git a/packages/riverpod/lib/src/result.dart b/packages/riverpod/lib/src/result.dart index 807117ac1..fba7523f4 100644 --- a/packages/riverpod/lib/src/result.dart +++ b/packages/riverpod/lib/src/result.dart @@ -83,7 +83,7 @@ class ResultData implements Result { } @override - bool operator ==(Object? other) => + bool operator ==(Object other) => other is ResultData && other.runtimeType == runtimeType && other.state == state; @@ -130,7 +130,7 @@ class ResultError implements Result { } @override - bool operator ==(Object? other) => + bool operator ==(Object other) => other is ResultError && other.runtimeType == runtimeType && other.stackTrace == stackTrace && diff --git a/packages/riverpod/pubspec.yaml b/packages/riverpod/pubspec.yaml index e8cad4e8e..ad07fe65e 100644 --- a/packages/riverpod/pubspec.yaml +++ b/packages/riverpod/pubspec.yaml @@ -1,7 +1,7 @@ name: riverpod description: > - A simple way to access state from anywhere in your application while robust - and testable. + A reactive caching and data-binding framework. + Riverpod makes working with asynchronous code a breeze. version: 3.0.0-dev.3 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod diff --git a/packages/riverpod/test/framework/async_value_test.dart b/packages/riverpod/test/framework/async_value_test.dart index 4710bfb9a..4bdbb0963 100644 --- a/packages/riverpod/test/framework/async_value_test.dart +++ b/packages/riverpod/test/framework/async_value_test.dart @@ -1559,4 +1559,42 @@ void main() { completion(AsyncError(42, stack)), ); }); + + test( + 'AsyncValue.guard emits the error when the created future fails and predicate is null', + () async { + final stack = StackTrace.current; + + await expectLater( + AsyncValue.guard(() => Future.error(42, stack)), + completion(AsyncError(42, stack)), + ); + }); + + test( + 'AsyncValue.guard emits the error when the created future fails and predicate is true', + () async { + final stack = StackTrace.current; + bool isInt(Object error) => error is int; + + await expectLater( + AsyncValue.guard( + () => Future.error(42, stack), + isInt, + ), + completion(AsyncError(42, stack)), + ); + }); + + test('AsyncValue.guard rethrows exception if predicate is false,', () async { + bool isInt(Object error) => error is int; + + await expectLater( + AsyncValue.guard( + () => throw const FormatException(), + isInt, + ), + throwsA(isA()), + ); + }); } diff --git a/packages/riverpod/test/framework/select_async_test.dart b/packages/riverpod/test/framework/select_async_test.dart index b51b78b8e..3c42c142c 100644 --- a/packages/riverpod/test/framework/select_async_test.dart +++ b/packages/riverpod/test/framework/select_async_test.dart @@ -138,7 +138,6 @@ void main() { container.listen( provider.selectAsync((data) => data.isEven), listener.call, - fireImmediately: false, ); verifyZeroInteractions(listener); diff --git a/packages/riverpod_analyzer_utils/CHANGELOG.md b/packages/riverpod_analyzer_utils/CHANGELOG.md index e1f565942..a127ba0d2 100644 --- a/packages/riverpod_analyzer_utils/CHANGELOG.md +++ b/packages/riverpod_analyzer_utils/CHANGELOG.md @@ -7,11 +7,15 @@ - Added `GeneratorProviderDeclarationElement.isFamily` +## 0.5.1 - 2024-02-04 + +- Bumped `custom_lint` version + ## 0.5.0 - 2023-11-20 - **Breaking** `LegacyProviderDeclarationElement.providerType` is now nullable. - Fix crash when parsing classes with a `ProviderBase` field. - + ## 0.4.3 - 2023-10-28 - Added `GeneratorProviderDeclarationElement.isFamily` diff --git a/packages/riverpod_analyzer_utils/pubspec.yaml b/packages/riverpod_analyzer_utils/pubspec.yaml index 254146a86..680ba9200 100644 --- a/packages/riverpod_analyzer_utils/pubspec.yaml +++ b/packages/riverpod_analyzer_utils/pubspec.yaml @@ -13,7 +13,7 @@ dependencies: analyzer: ">=5.12.0 <7.0.0" collection: ^1.16.0 crypto: ^3.0.2 - custom_lint_core: ^0.5.2 + custom_lint_core: ^0.6.0 freezed_annotation: ^2.2.0 meta: ^1.7.0 path: ^1.8.0 diff --git a/packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart b/packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart index 40ab0a738..c3513773a 100644 --- a/packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart @@ -214,7 +214,7 @@ int sixth(SixthRef ref) => 0; expect( errors[5].message, - 'Failed to parse dependency Type (int*)', + 'Failed to parse dependency Type (int)', ); expect(errors[5].targetElement?.toString(), 'int sixth(InvalidType ref)'); }); diff --git a/packages/riverpod_annotation/CHANGELOG.md b/packages/riverpod_annotation/CHANGELOG.md index e6c7f2efb..7d1e9f47b 100644 --- a/packages/riverpod_annotation/CHANGELOG.md +++ b/packages/riverpod_annotation/CHANGELOG.md @@ -14,6 +14,10 @@ - `riverpod` upgraded to `3.0.0-dev.0` +## 2.3.4 - 2024-02-03 + +- Improved `@Riverpod(dependencies: [...])` documentation. + ## 2.3.3 - 2023-11-27 - `riverpod` upgraded to `2.4.9` diff --git a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart index 4086d1242..6d94a6938 100644 --- a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart @@ -29,10 +29,75 @@ class Riverpod { /// Defaults to false. final bool keepAlive; - /// The list of dependencies of a provider. + /// The list of providers that this provider potentially depends on. /// - /// Values passed to the list of dependency should be the classes/functions - /// annotated with `@riverpod`; not the provider. + /// This list must contains the classes/functions annotated with `@riverpod`, + /// not the generated providers themselves. + /// + /// Specifying this list is strictly equivalent to saying "This provider may + /// be scoped". If a provider is scoped, it should specify [dependencies]. + /// If it is never scoped, it should not specify [dependencies]. + /// + /// The content of [dependencies] should be a list of all the providers that + /// this provider may depend on which can be scoped. + /// + /// For example, consider the following providers: + /// ```dart + /// // By not specifying "dependencies", we are saying that this provider is never scoped + /// @riverpod + /// Foo root(RootRef ref) => Foo(); + /// // By specifying "dependencies" (even if the list is empty), + /// // we are saying that this provider is potentially scoped + /// @Riverpod(dependencies: []) + /// Foo scoped(ScopedRef ref) => Foo(); + /// ``` + /// + /// Then if we were to depend on `rootProvider` in a scoped provider, we + /// could write any of: + /// + /// ```dart + /// @riverpod + /// Object? dependent(DependentRef ref) { + /// ref.watch(rootProvider); + /// // This provider does not depend on any scoped provider, + /// // as such "dependencies" is optional + /// } + /// + /// @Riverpod(dependencies: []) + /// Object? dependent(DependentRef ref) { + /// ref.watch(rootProvider); + /// // This provider decided to specify "dependencies" anyway, marking + /// // "dependentProvider" as possibly scoped. + /// // Since "rootProvider" is never scoped, it doesn't need to be included + /// // in "dependencies". + /// } + /// + /// @Riverpod(dependencies: [root]) + /// Object? dependent(DependentRef ref) { + /// ref.watch(rootProvider); + /// // Including "rootProvider" in "dependencies" is fine too, even though + /// // it is not required. It is a no-op. + /// } + /// ``` + /// + /// However, if we were to depend on `scopedProvider` then our only choice is: + /// + /// ```dart + /// @Riverpod(dependencies: [scoped]) + /// Object? dependent(DependentRef ref) { + /// ref.watch(scopedProvider); + /// // Since "scopedProvider" specifies "dependencies", any provider that + /// // depends on it must also specify "dependencies" and include "scopedProvider". + /// } + /// ``` + /// + /// In that scenario, the `dependencies` parameter is required and it must + /// include `scopedProvider`. + /// + /// See also: + /// - [provider_dependencies](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint#provider_dependencies-riverpod_generator-only) + /// and [scoped_providers_should_specify_dependencies](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint#scoped_providers_should_specify_dependencies-generator-only).\ + /// These are lint rules that will warn about incorrect `dependencies` usages. final List? dependencies; } diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 19db2a2da..c4e1e8484 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -81,6 +81,17 @@ This comes with a few minor restrictions: - **Breaking**: Arguments of the form `fn(void myParameter())` are no-longer supported. Instead use `fn(void Function() myParameter)`. +## 2.3.11 - 2024-02-04 + +- `riverpod_analyzer_utils` upgraded to `0.5.1` + +## 2.3.10 - 2024-02-03 + +- Improved error handling if: + - a Notifier has no default constructor + - a Notifier has has a default constructor but with required parameters + - a Notifier is abstract + ## 2.3.9 - 2023-11-27 - `riverpod_annotation` upgraded to `2.3.3` diff --git a/packages/riverpod_generator/lib/src/templates/class_based_provider.dart b/packages/riverpod_generator/lib/src/templates/class_based_provider.dart index 1dda0cf4d..0b788b073 100644 --- a/packages/riverpod_generator/lib/src/templates/class_based_provider.dart +++ b/packages/riverpod_generator/lib/src/templates/class_based_provider.dart @@ -1,6 +1,7 @@ import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import '../models.dart'; import '../riverpod_generator.dart'; +import '../validation.dart'; import 'template.dart'; String providerNameFor( @@ -81,7 +82,10 @@ class ClassBasedProviderTemplate extends Template { 'Expected a non-family provider', ); } + + validateClassBasedProvider(provider); } + final ClassBasedProviderDeclaration provider; final String notifierTypedefName; final String hashFn; diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 34f97ddae..7d99d5d24 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -4,6 +4,7 @@ import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import '../models.dart'; import '../riverpod_generator.dart'; +import '../validation.dart'; import 'class_based_provider.dart'; import 'parameters.dart'; import 'template.dart'; @@ -151,6 +152,8 @@ ${parameters.map((e) => ' ${e.name}: ${e.name},\n').join()} required String hashFn, required BuildYamlOptions options, }) { + validateClassBasedProvider(provider); + var leading = ''; if (!provider.annotation.element.keepAlive) { leading = 'AutoDispose'; diff --git a/packages/riverpod_generator/lib/src/validation.dart b/packages/riverpod_generator/lib/src/validation.dart new file mode 100644 index 000000000..a3c4287dc --- /dev/null +++ b/packages/riverpod_generator/lib/src/validation.dart @@ -0,0 +1,31 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import 'package:source_gen/source_gen.dart'; + +void validateClassBasedProvider(ClassBasedProviderDeclaration provider) { + // Assert that the class is not abstract + if (provider.node.abstractKeyword != null) { + throw InvalidGenerationSourceError( + '`@riverpod` can only be used on concrete classes.', + element: provider.node.declaredElement, + ); + } + + // Assert that the provider has a default constructor + final constructor = provider.node.declaredElement!.constructors + .firstWhereOrNull((e) => e.isDefaultConstructor); + if (constructor == null) { + throw InvalidGenerationSourceError( + 'The class ${provider.node.name} must have a default constructor.', + element: provider.node.declaredElement, + ); + } + + // Assert that the default constructor can be called with no parameter + if (constructor.parameters.any((e) => e.isRequired)) { + throw InvalidGenerationSourceError( + 'The default constructor of ${provider.node.name} must have not have required parameters.', + element: constructor, + ); + } +} diff --git a/packages/riverpod_generator/test/error_test.dart b/packages/riverpod_generator/test/error_test.dart new file mode 100644 index 000000000..f1df3cfbe --- /dev/null +++ b/packages/riverpod_generator/test/error_test.dart @@ -0,0 +1,147 @@ +import 'dart:convert'; +import 'dart:io'; + +import 'package:analyzer/dart/analysis/results.dart'; +import 'package:analyzer/dart/analysis/utilities.dart'; +import 'package:path/path.dart' as path; +import 'package:riverpod_generator/src/riverpod_generator.dart'; +import 'package:source_gen/source_gen.dart'; +import 'package:test/test.dart'; + +void main() { + group('Notifiers', () { + group('with arguments', () { + test('should throw if the class is abstract', () async { + const source = r''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@riverpod +abstract class MyNotifier extends _$MyNotifier { + @override + int build(int a) => 0; +} +'''; + + await expectLater( + () => compile(source), + throwsA(isA()), + ); + }); + + test('should throw if there is no default constructor', () async { + const source = r''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@riverpod +class MyNotifier extends _$MyNotifier { + MyNotifier._(); + + @override + int build(int a) => 0; +} +'''; + + await expectLater( + () => compile(source), + throwsA(isA()), + ); + }); + + test('should throw if the default constructor has required parameters', + () async { + const source = r''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@riverpod +class MyNotifier extends _$MyNotifier { + MyNotifier(int a); + + @override + int build(int a) => 0; +} +'''; + + await expectLater( + () => compile(source), + throwsA(isA()), + ); + }); + }); + + group('without arguments', () { + test('should throw if the class is abstract', () async { + const source = r''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@riverpod +abstract class MyNotifier extends _$MyNotifier { + @override + int build() => 0; +} +'''; + + await expectLater( + () => compile(source), + throwsA(isA()), + ); + }); + }); + }); +} + +void tearDownTmp() { + addTearDown(() { + final tmp = Directory('.dart_tool/test'); + if (tmp.existsSync()) { + tmp.deleteSync(recursive: true); + } + }); +} + +File createTmpFile(String filePath) { + tearDownTmp(); + + final file = File(path.join('.dart_tool', 'test', filePath)); + file.createSync(recursive: true); + + return file; +} + +Future compile(String source) async { + final generator = RiverpodGenerator(const {}); + + final main = createTmpFile('lib/main.dart')..writeAsStringSync(source); + final pubspec = createTmpFile('pubspec.yaml')..writeAsStringSync(''' +name: test_app + +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + riverpod_annotation: ^2.3.3 +'''); + + await runPubGet(pubspec.parent); + + final result = await resolveFile2(path: main.absolute.path); + + result as ResolvedUnitResult; + + return generator.generateForUnit([result.unit]); +} + +Future runPubGet(Directory parent) async { + final process = await Process.start( + 'dart', + ['pub', 'get'], + workingDirectory: parent.path, + ); + + final exitCode = await process.exitCode; + if (exitCode != 0) { + throw Exception( + 'flutter pub get failed with exit code $exitCode\n' + '${await process.stdout.transform(utf8.decoder).join()}', + ); + } +} diff --git a/packages/riverpod_generator/test/integration/generated.freezed.dart b/packages/riverpod_generator/test/integration/generated.freezed.dart index b7df1ae69..d175170d4 100644 --- a/packages/riverpod_generator/test/integration/generated.freezed.dart +++ b/packages/riverpod_generator/test/integration/generated.freezed.dart @@ -12,7 +12,7 @@ part of 'generated.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$Test {} @@ -60,7 +60,7 @@ class _$TestImpl implements _Test { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TestImpl); } diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index 30a352a82..973b13e5d 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -18,6 +18,17 @@ - `riverpod` upgraded to `3.0.0-dev.0` +## 2.3.9 - 2024-02-04 + +- Bumped `custom_lint` version + +## 2.3.8 - 2024-02-03 + +- Fix `async_value_nullable_pattern` false positive when used with generics + that have non-nullable type constrains. +- Add migration widget field when convert Stateless-based and + Stateful-based to each other (thanks to @Kurogoma4D) + ## 2.3.7 - 2023-11-27 - `riverpod` upgraded to `2.4.9` diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart index 784349bbd..4d6149a24 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart @@ -1,7 +1,11 @@ import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/ast/token.dart'; +import 'package:analyzer/dart/ast/visitor.dart'; +import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/source/source_range.dart'; // ignore: implementation_imports, somehow not exported by analyzer import 'package:analyzer/src/generated/source.dart' show Source; +import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart'; import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; @@ -83,6 +87,51 @@ class ConvertToStatefulBaseWidget extends RiverpodAssist { final widgetClass = node.thisOrAncestorOfType(); if (widgetClass == null) return; + final nodesToMove = {}; + final elementsToMove = {}; + final visitor = _FieldFinder(); + for (final member in widgetClass.members) { + if (member is ConstructorDeclaration) { + member.accept(visitor); + } + } + final fieldsAssignedInConstructors = visitor.fieldsAssignedInConstructors; + + for (final member in widgetClass.members) { + if (member is FieldDeclaration && !member.isStatic) { + for (final fieldNode in member.fields.variables) { + final fieldElement = fieldNode.declaredElement as FieldElement?; + if (fieldElement == null) continue; + if (!fieldsAssignedInConstructors.contains(fieldElement)) { + nodesToMove.add(member); + elementsToMove.add(fieldElement); + + final getter = fieldElement.getter; + if (getter != null) { + elementsToMove.add(getter); + } + + final setter = fieldElement.setter; + if (setter != null) { + elementsToMove.add(setter); + } + } + } + } else if (member is MethodDeclaration && !member.isStatic) { + nodesToMove.add(member); + elementsToMove.add(member.declaredElement!); + } + } + + for (final node in nodesToMove) { + final visitor = _ReplacementEditBuilder( + widgetClass.declaredElement!, + elementsToMove, + builder, + ); + node.accept(visitor); + } + final buildMethod = node .thisOrAncestorOfType() ?.members @@ -182,3 +231,78 @@ class $createdStateClassName extends $baseStateName<${widgetClass.name}> { }); } } + +// Original implemenation in +// package:analysis_server/lib/src/services/correction/dart/flutter_convert_to_stateful_widget.dart +class _FieldFinder extends RecursiveAstVisitor { + Set fieldsAssignedInConstructors = {}; + + @override + void visitFieldFormalParameter(FieldFormalParameter node) { + final element = node.declaredElement; + if (element is FieldFormalParameterElement) { + final field = element.field; + if (field != null) { + fieldsAssignedInConstructors.add(field); + } + } + + super.visitFieldFormalParameter(node); + } + + @override + void visitSimpleIdentifier(SimpleIdentifier node) { + if (node.parent is ConstructorFieldInitializer) { + final element = node.staticElement; + if (element is FieldElement) { + fieldsAssignedInConstructors.add(element); + } + } + if (node.inSetterContext()) { + final element = node.writeOrReadElement; + if (element is PropertyAccessorElement) { + final field = element.variable; + if (field is FieldElement) { + fieldsAssignedInConstructors.add(field); + } + } + } + } +} + +class _ReplacementEditBuilder extends RecursiveAstVisitor { + _ReplacementEditBuilder( + this.widgetClassElement, + this.elementsToMove, + this.builder, + ); + + final ClassElement widgetClassElement; + final Set elementsToMove; + final DartFileEditBuilder builder; + + @override + void visitSimpleIdentifier(SimpleIdentifier node) { + if (node.inDeclarationContext()) { + return; + } + final element = node.staticElement; + if (element is ExecutableElement && + element.enclosingElement == widgetClassElement && + !elementsToMove.contains(element)) { + final offset = node.offset; + final qualifier = + element.isStatic ? widgetClassElement.displayName : 'widget'; + + final parent = node.parent; + if (parent is InterpolationExpression && + parent.leftBracket.type == + TokenType.STRING_INTERPOLATION_IDENTIFIER) { + builder.addSimpleInsertion(offset, '{$qualifier.'); + builder.addSimpleInsertion(offset + node.length, '}'); + } else { + builder.addSimpleInsertion(offset, '$qualifier.'); + } + } + } +} diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart index 24555fa7f..859f168ef 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart @@ -1,4 +1,7 @@ import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/ast/token.dart'; +import 'package:analyzer/dart/ast/visitor.dart'; +import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/source/source_range.dart'; // ignore: implementation_imports, somehow not exported by analyzer import 'package:analyzer/src/generated/source.dart' show Source; @@ -145,87 +148,250 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist { .whereType() .firstWhereOrNull((element) => element.name.lexeme == 'createState'); if (createStateMethod != null) { - builder.addDeletion(createStateMethod.sourceRange); + builder.addDeletion(createStateMethod.sourceRange.getExpanded(1)); } // Search for the associated State class final stateClass = findStateClass(widgetClass); if (stateClass == null) return; + final fieldFinder = _FieldFinder(); + + for (final member in stateClass.members) { + if (member is ConstructorDeclaration) { + member.accept(fieldFinder); + } + } + + final fieldsAssignedInConstructors = + fieldFinder.fieldsAssignedInConstructors; + + // Prepare nodes to move. + final nodesToMove = []; + final elementsToMove = {}; + for (final member in stateClass.members) { + if (member is FieldDeclaration) { + if (member.isStatic) { + return; + } + for (final fieldNode in member.fields.variables) { + final fieldElement = fieldNode.declaredElement as FieldElement?; + if (fieldElement == null) continue; + if (!fieldsAssignedInConstructors.contains(fieldElement)) { + nodesToMove.add(member); + elementsToMove.add(fieldElement); + + final getter = fieldElement.getter; + if (getter != null) { + elementsToMove.add(getter); + } + + final setter = fieldElement.setter; + if (setter != null) { + elementsToMove.add(setter); + } + } + } + } else if (member is MethodDeclaration) { + if (member.isStatic) { + return; + } + if (!_isDefaultOverride(member)) { + nodesToMove.add(member); + elementsToMove.add(member.declaredElement!); + } + } + } + + final deleteRanges = []; + for (final node in nodesToMove) { + final visitor = _ReplacementEditBuilder( + widgetClass.declaredElement!, + elementsToMove, + ); + node.accept(visitor); + deleteRanges.addAll(visitor.deleteRanges); + } + // Move the build method to the widget class final buildMethod = stateClass.members .whereType() .firstWhereOrNull((element) => element.name.lexeme == 'build'); if (buildMethod == null) return; - final String? newBuildMethod; + final outsideRange = SourceRange( + widgetClass.sourceRange.end, + stateClass.sourceRange.offset - widgetClass.sourceRange.end, + ); + final outsideLines = source.contents.data.substring( + outsideRange.offset, + outsideRange.end, + ); + if (outsideLines.trim().isNotEmpty) { + builder.addSimpleInsertion( + stateClass.sourceRange.end, + '${outsideLines.trimRight()}\n', + ); + } + + // ignore: prefer_foreach + for (final range in deleteRanges) { + builder.addDeletion(range); + } + + builder.addDeletion( + SourceRange( + widgetClass.rightBracket.offset, + stateClass.leftBracket.end - widgetClass.rightBracket.offset, + ), + ); + + final parameterRange = _generateBuildMethodParameterRange(buildMethod); + if (parameterRange == SourceRange.EMPTY) { + return; + } switch (targetWidget) { case StatelessBaseWidgetType.consumerWidget: case StatelessBaseWidgetType.hookConsumerWidget: - newBuildMethod = _buildMethodWithRef(buildMethod, source); + builder.addSimpleReplacement( + parameterRange, + 'BuildContext context, WidgetRef ref', + ); case StatelessBaseWidgetType.hookWidget: case StatelessBaseWidgetType.statelessWidget: - newBuildMethod = _buildMethodWithoutRef(buildMethod, source); + builder.addSimpleReplacement( + parameterRange, + 'BuildContext context', + ); } - - if (newBuildMethod == null) return; - builder.addSimpleInsertion( - widgetClass.rightBracket.offset, - newBuildMethod, - ); - - // Delete the state class - builder.addDeletion(stateClass.sourceRange); }); } - String? _buildMethodWithRef(MethodDeclaration buildMethod, Source source) { - final parameters = buildMethod.parameters; - if (parameters == null) return null; + SourceRange _generateBuildMethodParameterRange( + MethodDeclaration buildMethod, + ) { + final offset = buildMethod.parameters?.leftParenthesis.end ?? 0; + final end = buildMethod.parameters?.rightParenthesis.offset ?? 0; + return SourceRange(offset, end - offset); + } +} + +// Original implemenation in +// package:analysis_server/lib/src/services/correction/dart/flutter_convert_to_stateless_widget.dart +class _FieldFinder extends RecursiveAstVisitor { + final fieldsAssignedInConstructors = {}; - if (parameters.parameters.length == 2) { - // The build method already has a ref parameter, nothing to change - return '${source.contents.data.substring(buildMethod.offset, buildMethod.end)}\n'; + @override + void visitSimpleIdentifier(SimpleIdentifier node) { + if (node.parent is FieldFormalParameter) { + final element = node.staticElement; + if (element is FieldFormalParameterElement) { + final field = element.field; + if (field != null) { + fieldsAssignedInConstructors.add(field); + } + } } - final buffer = StringBuffer(); - final refParamStartOffset = parameters.parameters.firstOrNull?.end ?? - parameters.leftParenthesis.offset + 1; - - buffer - ..write( - source.contents.data.substring(buildMethod.offset, refParamStartOffset), - ) - ..write(', WidgetRef ref') - ..writeln( - source.contents.data.substring(refParamStartOffset, buildMethod.end), - ); + if (node.parent is ConstructorFieldInitializer) { + final element = node.staticElement; + if (element is FieldElement) { + fieldsAssignedInConstructors.add(element); + } + } - return buffer.toString(); + if (node.inSetterContext()) { + final element = node.writeOrReadElement; + if (element is PropertyAccessorElement) { + final field = element.variable; + if (field is FieldElement) { + fieldsAssignedInConstructors.add(field); + } + } + } } +} + +class _ReplacementEditBuilder extends RecursiveAstVisitor { + _ReplacementEditBuilder( + this.widgetClassElement, + this.elementsToMove, + ); - String? _buildMethodWithoutRef(MethodDeclaration buildMethod, Source source) { - final parameters = buildMethod.parameters; - if (parameters == null) return null; + final ClassElement widgetClassElement; + final Set elementsToMove; - if (parameters.parameters.length == 1) { - // The build method already has not a ref parameter, nothing to change - return '${source.contents.data.substring(buildMethod.offset, buildMethod.end)}\n'; - } + List deleteRanges = []; - final buffer = StringBuffer(); - final contextEndOffset = parameters.parameters.firstOrNull?.end ?? - parameters.leftParenthesis.offset + 1; - final refParamStartOffset = parameters.parameters.last.offset; - - buffer - ..write( - source.contents.data.substring(buildMethod.offset, contextEndOffset), - ) - ..writeln( - source.contents.data.substring(refParamStartOffset, buildMethod.end), - ); + @override + void visitSimpleIdentifier(SimpleIdentifier node) { + if (node.inDeclarationContext()) { + return; + } + final element = node.staticElement; + if (element is ExecutableElement && + element.enclosingElement == widgetClassElement && + !elementsToMove.contains(element)) { + final parent = node.parent; + if (parent is PrefixedIdentifier) { + final grandParent = parent.parent; + + if (!node.name.contains(r'$') && + grandParent is InterpolationExpression && + grandParent.leftBracket.type == + TokenType.STRING_INTERPOLATION_EXPRESSION) { + final offset = grandParent.rightBracket?.offset; + + if (offset != null) { + deleteRanges.add(SourceRange(offset, 1)); + } + deleteRanges.add(SourceRange(grandParent.leftBracket.end - 1, 1)); + } + final offset = parent.prefix.offset; + final length = parent.period.end - offset; + deleteRanges.add(SourceRange(offset, length)); + } else if (parent is MethodInvocation) { + final target = parent.target; + final operator = parent.operator; + if (target != null && operator != null) { + final offset = target.offset; + final length = operator.end - offset; + deleteRanges.add(SourceRange(offset, length)); + } + } else if (parent is PropertyAccess) { + final target = parent.target; + final operator = parent.operator; + if (target != null) { + final offset = target.offset; + final length = operator.end - offset; + deleteRanges.add(SourceRange(offset, length)); + } + } + } + } +} - return buffer.toString(); +bool _isDefaultOverride(MethodDeclaration? methodDeclaration) { + final body = methodDeclaration?.body; + if (body != null) { + Expression expression; + if (body is BlockFunctionBody) { + final statements = body.block.statements; + if (statements.isEmpty) return true; + if (statements.length > 1) return false; + final first = statements.first; + if (first is! ExpressionStatement) return false; + expression = first.expression; + } else if (body is ExpressionFunctionBody) { + expression = body.expression; + } else { + return false; + } + if (expression is MethodInvocation && + expression.target is SuperExpression && + methodDeclaration!.name.lexeme == expression.methodName.name) { + return true; + } } + return false; } diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart b/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart index ed5c43299..9f0093eb5 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart @@ -1,4 +1,5 @@ import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/element/element.dart'; // ignore: implementation_imports, somehow not exported by analyzer import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; @@ -149,3 +150,32 @@ ClassDeclaration? findStateClass(ClassDeclaration widgetClass) { return checker.isExactlyType(stateWidgetType); }); } + +// Original implemenation in package:analyzer/lib/src/dart/ast/extensions.dart +extension IdentifierExtension on Identifier { + Element? get writeOrReadElement { + return _writeElement(this) ?? staticElement; + } +} + +Element? _writeElement(AstNode node) { + final parent = node.parent; + + if (parent is AssignmentExpression && parent.leftHandSide == node) { + return parent.writeElement; + } + if (parent is PostfixExpression && parent.operand == node) { + return parent.writeElement; + } + if (parent is PrefixExpression && parent.operand == node) { + return parent.writeElement; + } + + if (parent is PrefixedIdentifier && parent.identifier == node) { + return _writeElement(parent); + } + if (parent is PropertyAccess && parent.propertyName == node) { + return _writeElement(parent); + } + return null; +} diff --git a/packages/riverpod_lint/lib/src/lints/async_value_nullable_pattern.dart b/packages/riverpod_lint/lib/src/lints/async_value_nullable_pattern.dart index f3a64ca53..1d1dfbc51 100644 --- a/packages/riverpod_lint/lib/src/lints/async_value_nullable_pattern.dart +++ b/packages/riverpod_lint/lib/src/lints/async_value_nullable_pattern.dart @@ -53,7 +53,15 @@ class AsyncValueNullablePattern extends RiverpodLintRule { } grandParentType as InterfaceType; - final genericType = grandParentType.typeArguments.first; + var genericType = grandParentType.typeArguments.first; + + // If the AsyncValue's type is a generic type, we check the generic's constraint + if (genericType is TypeParameterType) { + final unit = node.thisOrAncestorOfType()!; + + genericType = genericType.element.bound ?? + unit.declaredElement!.library.typeProvider.dynamicType; + } if (genericType is! DynamicType && genericType.nullabilitySuffix != NullabilitySuffix.question) { diff --git a/packages/riverpod_lint/pubspec.yaml b/packages/riverpod_lint/pubspec.yaml index 97d81cdfd..dfc3e1390 100644 --- a/packages/riverpod_lint/pubspec.yaml +++ b/packages/riverpod_lint/pubspec.yaml @@ -14,7 +14,7 @@ dependencies: analyzer: ">=6.0.0 <7.0.0" analyzer_plugin: ^0.11.2 collection: ^1.16.0 - custom_lint_builder: ^0.5.2 + custom_lint_builder: ^0.6.0 meta: ^1.7.0 path: ^1.8.1 riverpod: ^3.0.0-dev.3 diff --git a/packages/riverpod_lint_flutter_test/pubspec.yaml b/packages/riverpod_lint_flutter_test/pubspec.yaml index ee7b99ace..e3d37c6fb 100644 --- a/packages/riverpod_lint_flutter_test/pubspec.yaml +++ b/packages/riverpod_lint_flutter_test/pubspec.yaml @@ -15,7 +15,8 @@ dependencies: dev_dependencies: build_runner: ^2.4.6 - custom_lint: ^0.5.2 + custom_lint: ^0.6.0 + custom_lint_core: ^0.6.0 freezed: ^2.3.2 json_serializable: ^6.6.1 riverpod_lint: diff --git a/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml b/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml index aef4942a3..4f0b94b08 100644 --- a/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml +++ b/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml @@ -14,4 +14,6 @@ dependency_overrides: path: ../riverpod_annotation riverpod_lint: path: ../riverpod_lint - test_api: ^0.6.1 + + # hotreloader is out of date + vm_service: ^14.0.0 diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff new file mode 100644 index 000000000..d32463fb6 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff @@ -0,0 +1,78 @@ +Message: `Convert to functional provider` +Priority: 100 +Diff for file `test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.dart:7`: +``` +/// Some comment +@riverpod +- class Example extends _$Example { +- @override +- int build() => 0; +- } ++ int example(ExampleRef ref) => 0; + +/// Some comment +``` +--- +Message: `Convert to functional provider` +Priority: 100 +Diff for file `test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.dart:7`: +``` +/// Some comment +@riverpod +- class Example extends _$Example { +- @override +- int build() => 0; +- } ++ int example(ExampleRef ref) => 0; + +/// Some comment +``` +--- +Message: `Convert to functional provider` +Priority: 100 +Diff for file `test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.dart:7`: +``` +/// Some comment +@riverpod +- class Example extends _$Example { +- @override +- int build() => 0; +- } ++ int example(ExampleRef ref) => 0; + +/// Some comment +``` +--- +Message: `Convert to functional provider` +Priority: 100 +Diff for file `test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.dart:14`: +``` +/// Some comment +@riverpod +- class ExampleFamily extends _$ExampleFamily { +- @override +- int build({required int a, String b = '42'}) { +- // Hello world +- return 0; +- } ++ int exampleFamily(ExampleFamilyRef ref, {required int a, String b = '42'}) { ++ // Hello world ++ return 0; ++ } + +@riverpod +``` +--- +Message: `Convert to functional provider` +Priority: 100 +Diff for file `test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.dart:23`: +``` + +@riverpod +- class Generic extends _$Generic { +- @override +- int build() => 0; +- } ++ int generic(GenericRef ref) => 0; +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.json b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.json deleted file mode 100644 index 437d0dda2..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":215,"length":2,"replacement":""},{"offset":208,"length":0,"replacement":"ExampleRef ref"},{"offset":202,"length":5,"replacement":"example"},{"offset":150,"length":48,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":215,"length":2,"replacement":""},{"offset":208,"length":0,"replacement":"ExampleRef ref"},{"offset":202,"length":5,"replacement":"example"},{"offset":150,"length":48,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":215,"length":2,"replacement":""},{"offset":208,"length":0,"replacement":"ExampleRef ref"},{"offset":202,"length":5,"replacement":"example"},{"offset":150,"length":48,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":389,"length":2,"replacement":""},{"offset":316,"length":0,"replacement":"ExampleFamilyRef ref, "},{"offset":310,"length":5,"replacement":"exampleFamily"},{"offset":246,"length":60,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":494,"length":2,"replacement":""},{"offset":487,"length":0,"replacement":"GenericRef ref"},{"offset":486,"length":0,"replacement":""},{"offset":481,"length":5,"replacement":"generic"},{"offset":403,"length":74,"replacement":""}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart index 707b65113..97154ba21 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart @@ -1,24 +1,16 @@ -import 'dart:io'; - import 'package:riverpod_lint/src/assists/class_based_to_functional_provider.dart'; import 'package:analyzer/source/source_range.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import '../../golden.dart'; void main() { testGolden( 'Convert plain class provider to functional provider', - 'assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.json', - () async { - final assist = ClassBasedToFunctionalProvider(); - final file = File( + 'assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff', + sourcePath: 'test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.dart', - ).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; + (result) async { + final assist = ClassBasedToFunctionalProvider(); return [ ...await assist.testRun(result, const SourceRange(145, 0)), diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff new file mode 100644 index 000000000..47aeb2dbf --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff @@ -0,0 +1,33 @@ +Message: `Convert to class-based provider` +Priority: 100 +Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:7`: +``` +/// Some comment +@riverpod +- int example(ExampleRef ref) => 0; ++ class Example extends _$Example { ++ @override ++ int build() => 0; ++ } + +/// Some comment +``` +--- +Message: `Convert to class-based provider` +Priority: 100 +Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:11`: +``` +/// Some comment +@riverpod +- int exampleFamily(ExampleFamilyRef ref, {required int a, String b = '42'}) { +- // Hello world +- return 0; ++ class ExampleFamily extends _$ExampleFamily { ++ @override ++ int build({required int a, String b = '42'}) { ++ // Hello world ++ return 0; ++ } +} +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.json b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.json deleted file mode 100644 index 1d84c5034..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":100,"change":{"message":"Convert to class-based provider","edits":[{"fileStamp":0,"edits":[{"offset":183,"length":0,"replacement":"\n}"},{"offset":162,"length":14,"replacement":""},{"offset":154,"length":7,"replacement":"build"},{"offset":150,"length":0,"replacement":"class Example extends _$Example {\n @override\n "}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to class-based provider","edits":[{"fileStamp":0,"edits":[{"offset":319,"length":0,"replacement":"\n}"},{"offset":230,"length":22,"replacement":""},{"offset":216,"length":13,"replacement":"build"},{"offset":212,"length":0,"replacement":"class ExampleFamily extends _$ExampleFamily {\n @override\n "}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart index ad29e9122..6f15d46df 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart @@ -1,24 +1,16 @@ -import 'dart:io'; - import 'package:riverpod_lint/src/assists/functional_to_class_based_provider.dart'; import 'package:analyzer/source/source_range.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import '../../golden.dart'; void main() { testGolden( 'Convert functional providers to class-based providers', - 'assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.json', - () async { - final assist = FunctionalToClassBasedProvider(); - final file = File( + 'assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff', + sourcePath: 'test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart', - ).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; + (result) async { + final assist = FunctionalToClassBasedProvider(); return [ ...await assist.testRun(result, const SourceRange(145, 0)), diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.diff new file mode 100644 index 000000000..08a54981b --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.diff @@ -0,0 +1,308 @@ +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:5`: +``` +import 'package:flutter_hooks/flutter_hooks.dart'; + +- class Stateless extends StatelessWidget { +- const Stateless({super.key}); +- +- @override ++ class Stateless extends ConsumerStatefulWidget { ++ const Stateless({super.key}); ++ ++ @override ++ ConsumerState createState() => _StatelessState(); ++ } ++ ++ class _StatelessState extends ConsumerState { +@override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:14`: +``` +} + +- class StatelessWithComma extends StatelessWidget { +- const StatelessWithComma({super.key}); +- +- @override ++ class StatelessWithComma extends ConsumerStatefulWidget { ++ const StatelessWithComma({super.key}); ++ ++ @override ++ ConsumerState createState() => _StatelessWithCommaState(); ++ } ++ ++ class _StatelessWithCommaState extends ConsumerState { +@override + Widget build( +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:25`: +``` +} + +- class Hook extends HookWidget { +- const Hook({super.key}); +- +- @override ++ class Hook extends ConsumerStatefulWidget { ++ const Hook({super.key}); ++ ++ @override ++ ConsumerState createState() => _HookState(); ++ } ++ ++ class _HookState extends ConsumerState { +@override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:34`: +``` +} + +- class HookConsumer extends HookConsumerWidget { +- const HookConsumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumer extends ConsumerStatefulWidget { ++ const HookConsumer({super.key}); ++ ++ @override ++ ConsumerState createState() => _HookConsumerState(); ++ } ++ ++ class _HookConsumerState extends ConsumerState { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 27 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:46`: +``` +} + +- class Stateful extends StatefulWidget { +- const Stateful({super.key}); +- +- @override +- State createState() => _StatefulState(); +- } +- +- class _StatefulState extends State { ++ class Stateful extends ConsumerStatefulWidget { ++ const Stateful({super.key}); ++ ++ @override ++ ConsumerState createState() => _StatefulState(); ++ } ++ ++ class _StatefulState extends ConsumerState { + /// Hello world + @override +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 27 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:62`: +``` +} + +- class ExplicitCreateState extends StatefulWidget { +- const ExplicitCreateState({super.key}); +- +- @override +- ExplicitCreateStateState createState() => ExplicitCreateStateState(); +- } +- +- class ExplicitCreateStateState extends State { ++ class ExplicitCreateState extends ConsumerStatefulWidget { ++ const ExplicitCreateState({super.key}); ++ ++ @override ++ ExplicitCreateStateState createState() => ExplicitCreateStateState(); ++ } ++ ++ class ExplicitCreateStateState extends ConsumerState { + @override + Widget build( +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:78`: +``` +} + +- class HookStateful extends StatefulHookWidget { +- const HookStateful({super.key}); +- +- @override +- State createState() => HookStatefulState(); +- } +- +- class HookStatefulState extends State { ++ class HookStateful extends ConsumerStatefulWidget { ++ const HookStateful({super.key}); ++ ++ @override ++ ConsumerState createState() => HookStatefulState(); ++ } ++ ++ class HookStatefulState extends ConsumerState { + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:106`: +``` +} + +- class HookConsumerStateful extends StatefulHookConsumerWidget { ++ class HookConsumerStateful extends ConsumerStatefulWidget { + const HookConsumerStateful({super.key}); + +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:121`: +``` +} + +- class Consumer extends ConsumerWidget { +- const Consumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class Consumer extends ConsumerStatefulWidget { ++ const Consumer({super.key}); ++ ++ @override ++ ConsumerState createState() => _ConsumerState(); ++ } ++ ++ class _ConsumerState extends ConsumerState { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:133`: +``` +} + +- class StatelessWithField extends StatelessWidget { +- const StatelessWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build(BuildContext context) { +- return Column( +- children: [ +- Text('$field'), +- Text('$staticField'), ++ class StatelessWithField extends ConsumerStatefulWidget { ++ const StatelessWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ ConsumerState createState() => _StatelessWithFieldState(); ++ } ++ ++ class _StatelessWithFieldState extends ConsumerState { ++ @override ++ Widget build(BuildContext context) { ++ return Column( ++ children: [ ++ Text('${widget.field}'), ++ Text('${StatelessWithField.staticField}'), + ], + ); +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:153`: +``` +} + +- class HookConsumerWithField extends HookConsumerWidget { +- const HookConsumerWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { +- return Column( +- children: [ +- Text('$field'), +- Text('$staticField'), ++ class HookConsumerWithField extends ConsumerStatefulWidget { ++ const HookConsumerWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ ConsumerState createState() => _HookConsumerWithFieldState(); ++ } ++ ++ class _HookConsumerWithFieldState extends ConsumerState { ++ @override ++ Widget build( ++ BuildContext context) { ++ return Column( ++ children: [ ++ Text('${widget.field}'), ++ Text('${HookConsumerWithField.staticField}'), + ], + ); +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.json deleted file mode 100644 index e019d34fb..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":31,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":221,"length":0,"replacement":"@override\n ConsumerState createState() => _StatelessState();\n}\n\nclass _StatelessState extends ConsumerState {\n"},{"offset":168,"length":15,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":404,"length":0,"replacement":"@override\n ConsumerState createState() => _StatelessWithCommaState();\n}\n\nclass _StatelessWithCommaState extends ConsumerState {\n"},{"offset":342,"length":15,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":563,"length":0,"replacement":"@override\n ConsumerState createState() => _HookState();\n}\n\nclass _HookState extends ConsumerState {\n"},{"offset":520,"length":10,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":787,"length":23,"replacement":""},{"offset":737,"length":0,"replacement":"@override\n ConsumerState createState() => _HookConsumerState();\n}\n\nclass _HookConsumerState extends ConsumerState {\n"},{"offset":678,"length":18,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":27,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":1022,"length":15,"replacement":"ConsumerState"},{"offset":939,"length":15,"replacement":"ConsumerState"},{"offset":876,"length":14,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":27,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":1389,"length":26,"replacement":"ConsumerState"},{"offset":1203,"length":14,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":1708,"length":19,"replacement":"ConsumerState"},{"offset":1615,"length":19,"replacement":"ConsumerState"},{"offset":1544,"length":18,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":2424,"length":35,"replacement":"ConsumerState"},{"offset":2291,"length":35,"replacement":"ConsumerState"},{"offset":2204,"length":26,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":2676,"length":23,"replacement":""},{"offset":2626,"length":0,"replacement":"@override\n ConsumerState createState() => _ConsumerState();\n}\n\nclass _ConsumerState extends ConsumerState {\n"},{"offset":2575,"length":14,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.diff new file mode 100644 index 000000000..ac6453b08 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.diff @@ -0,0 +1,330 @@ +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:5`: +``` +import 'package:flutter_hooks/flutter_hooks.dart'; + +- class Stateless extends StatelessWidget { +- const Stateless({super.key}); +- +- @override +- Widget build(BuildContext context) { ++ class Stateless extends ConsumerWidget { ++ const Stateless({super.key}); ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:14`: +``` +} + +- class StatelessWithComma extends StatelessWidget { +- const StatelessWithComma({super.key}); +- +- @override +- Widget build( +- BuildContext context, ++ class StatelessWithComma extends ConsumerWidget { ++ const StatelessWithComma({super.key}); ++ ++ @override ++ Widget build( ++ BuildContext context, WidgetRef ref, + ) { + return const Placeholder(); +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:25`: +``` +} + +- class Hook extends HookWidget { +- const Hook({super.key}); +- +- @override +- Widget build(BuildContext context) { ++ class Hook extends ConsumerWidget { ++ const Hook({super.key}); ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:34`: +``` +} + +- class HookConsumer extends HookConsumerWidget { ++ class HookConsumer extends ConsumerWidget { + const HookConsumer({super.key}); + +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:46`: +``` +} + +- class Stateful extends StatefulWidget { +- const Stateful({super.key}); +- +- @override +- State createState() => _StatefulState(); +- } +- +- class _StatefulState extends State { +- /// Hello world +- @override +- Widget build(BuildContext context) { ++ class Stateful extends ConsumerWidget { ++ const Stateful({super.key}); ++ ++ ++ /// Hello world ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + // Some comments + return const Placeholder(); +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:62`: +``` +} + +- class ExplicitCreateState extends StatefulWidget { +- const ExplicitCreateState({super.key}); +- +- @override +- ExplicitCreateStateState createState() => ExplicitCreateStateState(); +- } +- +- class ExplicitCreateStateState extends State { +- @override +- Widget build( +- BuildContext context, +- ) { ++ class ExplicitCreateState extends ConsumerWidget { ++ const ExplicitCreateState({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:78`: +``` +} + +- class HookStateful extends StatefulHookWidget { +- const HookStateful({super.key}); +- +- @override +- State createState() => HookStatefulState(); +- } +- +- class HookStatefulState extends State { +- @override +- Widget build(BuildContext context) { ++ class HookStateful extends ConsumerWidget { ++ const HookStateful({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:92`: +``` +} + +- class ConsumerStateful extends ConsumerStatefulWidget { +- const ConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => _ConsumerStatefulState(); +- } +- +- class _ConsumerStatefulState extends ConsumerState { +- @override +- Widget build(BuildContext context) { ++ class ConsumerStateful extends ConsumerWidget { ++ const ConsumerStateful({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:106`: +``` +} + +- class HookConsumerStateful extends StatefulHookConsumerWidget { +- const HookConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => +- _HookConsumerStatefulState(); +- } +- +- class _HookConsumerStatefulState extends ConsumerState { +- @override +- Widget build(BuildContext context) { ++ class HookConsumerStateful extends ConsumerWidget { ++ const HookConsumerStateful({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:133`: +``` +} + +- class StatelessWithField extends StatelessWidget { +- const StatelessWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build(BuildContext context) { ++ class StatelessWithField extends ConsumerWidget { ++ const StatelessWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return Column( + children: [ +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:153`: +``` +} + +- class HookConsumerWithField extends HookConsumerWidget { ++ class HookConsumerWithField extends ConsumerWidget { + const HookConsumerWithField({ + super.key, +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:180`: +``` +} + +- class ConsumerStatefulWithField extends ConsumerStatefulWidget { +- const ConsumerStatefulWithField({ +- super.key, +- required this.field, +- required this.foo, +- }); +- +- final int field; +- final FooClass foo; +- static final int staticField = _constantNumber; +- +- @override +- ConsumerState createState() => +- _ConsumerStatefulWithFieldState(); +- } +- +- const _constantNumber = 42; +- +- class _ConsumerStatefulWithFieldState +- extends ConsumerState { +- void printFoo() { +- print(widget.foo); +- } +- +- @override +- Widget build(BuildContext context) { +- print(widget.field); +- printFoo(); +- return Column( +- children: [ +- Text('${widget.field}'), +- Text('${widget.foo.bar}'), +- Text('${ConsumerStatefulWithField.staticField}'), +- ], +- ); +- } +- } ++ class ConsumerStatefulWithField extends ConsumerWidget { ++ const ConsumerStatefulWithField({ ++ super.key, ++ required this.field, ++ required this.foo, ++ }); ++ ++ final int field; ++ final FooClass foo; ++ static final int staticField = _constantNumber; ++ ++ ++ void printFoo() { ++ print(foo); ++ } ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { ++ print(field); ++ printFoo(); ++ return Column( ++ children: [ ++ Text('$field'), ++ Text('${foo.bar}'), ++ Text('$staticField'), ++ ], ++ ); ++ } ++ } ++ ++ const _constantNumber = 42; + +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.json deleted file mode 100644 index 8e975d16f..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":35,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":266,"length":0,"replacement":", WidgetRef ref"},{"offset":168,"length":15,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":35,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":454,"length":0,"replacement":", WidgetRef ref"},{"offset":342,"length":15,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":35,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":608,"length":0,"replacement":", WidgetRef ref"},{"offset":520,"length":10,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":35,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":678,"length":18,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":993,"length":174,"replacement":""},{"offset":990,"length":0,"replacement":"/// Hello world\n @override\n Widget build(BuildContext context, WidgetRef ref) {\n // Some comments\n return const Placeholder();\n }\n"},{"offset":927,"length":62,"replacement":""},{"offset":876,"length":14,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":1350,"length":165,"replacement":""},{"offset":1347,"length":0,"replacement":"@override\n Widget build(\n BuildContext context, WidgetRef ref,\n ) {\n return const Placeholder();\n }\n"},{"offset":1265,"length":81,"replacement":""},{"offset":1203,"length":14,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":35,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":1676,"length":142,"replacement":""},{"offset":1673,"length":0,"replacement":"@override\n Widget build(BuildContext context, WidgetRef ref) {\n return const Placeholder();\n }\n"},{"offset":1603,"length":69,"replacement":""},{"offset":1544,"length":18,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":35,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":2008,"length":159,"replacement":""},{"offset":2005,"length":0,"replacement":"@override\n Widget build(BuildContext context, WidgetRef ref) {\n return const Placeholder();\n }\n"},{"offset":1918,"length":86,"replacement":""},{"offset":1851,"length":22,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":35,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":2383,"length":167,"replacement":""},{"offset":2380,"length":0,"replacement":"@override\n Widget build(BuildContext context, WidgetRef ref) {\n return const Placeholder();\n }\n"},{"offset":2279,"length":100,"replacement":""},{"offset":2204,"length":26,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.diff new file mode 100644 index 000000000..b694c875c --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.diff @@ -0,0 +1,318 @@ +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:5`: +``` +import 'package:flutter_hooks/flutter_hooks.dart'; + +- class Stateless extends StatelessWidget { +- const Stateless({super.key}); +- +- @override +- Widget build(BuildContext context) { ++ class Stateless extends HookConsumerWidget { ++ const Stateless({super.key}); ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:14`: +``` +} + +- class StatelessWithComma extends StatelessWidget { +- const StatelessWithComma({super.key}); +- +- @override +- Widget build( +- BuildContext context, ++ class StatelessWithComma extends HookConsumerWidget { ++ const StatelessWithComma({super.key}); ++ ++ @override ++ Widget build( ++ BuildContext context, WidgetRef ref, + ) { + return const Placeholder(); +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:25`: +``` +} + +- class Hook extends HookWidget { +- const Hook({super.key}); +- +- @override +- Widget build(BuildContext context) { ++ class Hook extends HookConsumerWidget { ++ const Hook({super.key}); ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:46`: +``` +} + +- class Stateful extends StatefulWidget { +- const Stateful({super.key}); +- +- @override +- State createState() => _StatefulState(); +- } +- +- class _StatefulState extends State { +- /// Hello world +- @override +- Widget build(BuildContext context) { ++ class Stateful extends HookConsumerWidget { ++ const Stateful({super.key}); ++ ++ ++ /// Hello world ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + // Some comments + return const Placeholder(); +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:62`: +``` +} + +- class ExplicitCreateState extends StatefulWidget { +- const ExplicitCreateState({super.key}); +- +- @override +- ExplicitCreateStateState createState() => ExplicitCreateStateState(); +- } +- +- class ExplicitCreateStateState extends State { +- @override +- Widget build( +- BuildContext context, +- ) { ++ class ExplicitCreateState extends HookConsumerWidget { ++ const ExplicitCreateState({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:78`: +``` +} + +- class HookStateful extends StatefulHookWidget { +- const HookStateful({super.key}); +- +- @override +- State createState() => HookStatefulState(); +- } +- +- class HookStatefulState extends State { +- @override +- Widget build(BuildContext context) { ++ class HookStateful extends HookConsumerWidget { ++ const HookStateful({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:92`: +``` +} + +- class ConsumerStateful extends ConsumerStatefulWidget { +- const ConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => _ConsumerStatefulState(); +- } +- +- class _ConsumerStatefulState extends ConsumerState { +- @override +- Widget build(BuildContext context) { ++ class ConsumerStateful extends HookConsumerWidget { ++ const ConsumerStateful({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:106`: +``` +} + +- class HookConsumerStateful extends StatefulHookConsumerWidget { +- const HookConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => +- _HookConsumerStatefulState(); +- } +- +- class _HookConsumerStatefulState extends ConsumerState { +- @override +- Widget build(BuildContext context) { ++ class HookConsumerStateful extends HookConsumerWidget { ++ const HookConsumerStateful({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:121`: +``` +} + +- class Consumer extends ConsumerWidget { ++ class Consumer extends HookConsumerWidget { + const Consumer({super.key}); + +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:133`: +``` +} + +- class StatelessWithField extends StatelessWidget { +- const StatelessWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build(BuildContext context) { ++ class StatelessWithField extends HookConsumerWidget { ++ const StatelessWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return Column( + children: [ +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:180`: +``` +} + +- class ConsumerStatefulWithField extends ConsumerStatefulWidget { +- const ConsumerStatefulWithField({ +- super.key, +- required this.field, +- required this.foo, +- }); +- +- final int field; +- final FooClass foo; +- static final int staticField = _constantNumber; +- +- @override +- ConsumerState createState() => +- _ConsumerStatefulWithFieldState(); +- } +- +- const _constantNumber = 42; +- +- class _ConsumerStatefulWithFieldState +- extends ConsumerState { +- void printFoo() { +- print(widget.foo); +- } +- +- @override +- Widget build(BuildContext context) { +- print(widget.field); +- printFoo(); +- return Column( +- children: [ +- Text('${widget.field}'), +- Text('${widget.foo.bar}'), +- Text('${ConsumerStatefulWithField.staticField}'), +- ], +- ); +- } +- } ++ class ConsumerStatefulWithField extends HookConsumerWidget { ++ const ConsumerStatefulWithField({ ++ super.key, ++ required this.field, ++ required this.foo, ++ }); ++ ++ final int field; ++ final FooClass foo; ++ static final int staticField = _constantNumber; ++ ++ ++ void printFoo() { ++ print(foo); ++ } ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { ++ print(field); ++ printFoo(); ++ return Column( ++ children: [ ++ Text('$field'), ++ Text('${foo.bar}'), ++ Text('$staticField'), ++ ], ++ ); ++ } ++ } ++ ++ const _constantNumber = 42; + +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.json deleted file mode 100644 index 449c635fc..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":37,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":266,"length":0,"replacement":", WidgetRef ref"},{"offset":168,"length":15,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":37,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":454,"length":0,"replacement":", WidgetRef ref"},{"offset":342,"length":15,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":37,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":608,"length":0,"replacement":", WidgetRef ref"},{"offset":520,"length":10,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":993,"length":174,"replacement":""},{"offset":990,"length":0,"replacement":"/// Hello world\n @override\n Widget build(BuildContext context, WidgetRef ref) {\n // Some comments\n return const Placeholder();\n }\n"},{"offset":927,"length":62,"replacement":""},{"offset":876,"length":14,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":1350,"length":165,"replacement":""},{"offset":1347,"length":0,"replacement":"@override\n Widget build(\n BuildContext context, WidgetRef ref,\n ) {\n return const Placeholder();\n }\n"},{"offset":1265,"length":81,"replacement":""},{"offset":1203,"length":14,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":37,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":1676,"length":142,"replacement":""},{"offset":1673,"length":0,"replacement":"@override\n Widget build(BuildContext context, WidgetRef ref) {\n return const Placeholder();\n }\n"},{"offset":1603,"length":69,"replacement":""},{"offset":1544,"length":18,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":37,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":2008,"length":159,"replacement":""},{"offset":2005,"length":0,"replacement":"@override\n Widget build(BuildContext context, WidgetRef ref) {\n return const Placeholder();\n }\n"},{"offset":1918,"length":86,"replacement":""},{"offset":1851,"length":22,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":37,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":2383,"length":167,"replacement":""},{"offset":2380,"length":0,"replacement":"@override\n Widget build(BuildContext context, WidgetRef ref) {\n return const Placeholder();\n }\n"},{"offset":2279,"length":100,"replacement":""},{"offset":2204,"length":26,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":37,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":2575,"length":14,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.diff new file mode 100644 index 000000000..0d1a73ee1 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.diff @@ -0,0 +1,314 @@ +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:5`: +``` +import 'package:flutter_hooks/flutter_hooks.dart'; + +- class Stateless extends StatelessWidget { ++ class Stateless extends HookWidget { + const Stateless({super.key}); + +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:14`: +``` +} + +- class StatelessWithComma extends StatelessWidget { ++ class StatelessWithComma extends HookWidget { + const StatelessWithComma({super.key}); + +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:34`: +``` +} + +- class HookConsumer extends HookConsumerWidget { +- const HookConsumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumer extends HookWidget { ++ const HookConsumer({super.key}); ++ ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:46`: +``` +} + +- class Stateful extends StatefulWidget { +- const Stateful({super.key}); +- +- @override +- State createState() => _StatefulState(); +- } +- +- class _StatefulState extends State { ++ class Stateful extends HookWidget { ++ const Stateful({super.key}); ++ ++ + /// Hello world + @override +``` +--- +Message: `Convert to HookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:62`: +``` +} + +- class ExplicitCreateState extends StatefulWidget { +- const ExplicitCreateState({super.key}); +- +- @override +- ExplicitCreateStateState createState() => ExplicitCreateStateState(); +- } +- +- class ExplicitCreateStateState extends State { +- @override +- Widget build( +- BuildContext context, +- ) { ++ class ExplicitCreateState extends HookWidget { ++ const ExplicitCreateState({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:78`: +``` +} + +- class HookStateful extends StatefulHookWidget { +- const HookStateful({super.key}); +- +- @override +- State createState() => HookStatefulState(); +- } +- +- class HookStatefulState extends State { ++ class HookStateful extends HookWidget { ++ const HookStateful({super.key}); ++ ++ + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:92`: +``` +} + +- class ConsumerStateful extends ConsumerStatefulWidget { +- const ConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => _ConsumerStatefulState(); +- } +- +- class _ConsumerStatefulState extends ConsumerState { ++ class ConsumerStateful extends HookWidget { ++ const ConsumerStateful({super.key}); ++ ++ + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:106`: +``` +} + +- class HookConsumerStateful extends StatefulHookConsumerWidget { +- const HookConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => +- _HookConsumerStatefulState(); +- } +- +- class _HookConsumerStatefulState extends ConsumerState { ++ class HookConsumerStateful extends HookWidget { ++ const HookConsumerStateful({super.key}); ++ ++ + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:121`: +``` +} + +- class Consumer extends ConsumerWidget { +- const Consumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class Consumer extends HookWidget { ++ const Consumer({super.key}); ++ ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:133`: +``` +} + +- class StatelessWithField extends StatelessWidget { ++ class StatelessWithField extends HookWidget { + const StatelessWithField({ + super.key, +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:153`: +``` +} + +- class HookConsumerWithField extends HookConsumerWidget { +- const HookConsumerWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumerWithField extends HookWidget { ++ const HookConsumerWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ Widget build( ++ BuildContext context) { + return Column( + children: [ +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:180`: +``` +} + +- class ConsumerStatefulWithField extends ConsumerStatefulWidget { +- const ConsumerStatefulWithField({ +- super.key, +- required this.field, +- required this.foo, +- }); +- +- final int field; +- final FooClass foo; +- static final int staticField = _constantNumber; +- +- @override +- ConsumerState createState() => +- _ConsumerStatefulWithFieldState(); +- } +- +- const _constantNumber = 42; +- +- class _ConsumerStatefulWithFieldState +- extends ConsumerState { +- void printFoo() { +- print(widget.foo); +- } +- +- @override +- Widget build(BuildContext context) { +- print(widget.field); +- printFoo(); +- return Column( +- children: [ +- Text('${widget.field}'), +- Text('${widget.foo.bar}'), +- Text('${ConsumerStatefulWithField.staticField}'), +- ], +- ); +- } +- } ++ class ConsumerStatefulWithField extends HookWidget { ++ const ConsumerStatefulWithField({ ++ super.key, ++ required this.field, ++ required this.foo, ++ }); ++ ++ final int field; ++ final FooClass foo; ++ static final int staticField = _constantNumber; ++ ++ ++ void printFoo() { ++ print(foo); ++ } ++ ++ @override ++ Widget build(BuildContext context) { ++ print(field); ++ printFoo(); ++ return Column( ++ children: [ ++ Text('$field'), ++ Text('${foo.bar}'), ++ Text('$staticField'), ++ ], ++ ); ++ } ++ } ++ ++ const _constantNumber = 42; + +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.json deleted file mode 100644 index 2698c3ded..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":36,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":168,"length":15,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":36,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":342,"length":15,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":36,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":787,"length":23,"replacement":""},{"offset":678,"length":18,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":993,"length":174,"replacement":""},{"offset":990,"length":0,"replacement":"/// Hello world\n @override\n Widget build(BuildContext context) {\n // Some comments\n return const Placeholder();\n }\n"},{"offset":927,"length":62,"replacement":""},{"offset":876,"length":14,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":1350,"length":165,"replacement":""},{"offset":1347,"length":0,"replacement":"@override\n Widget build(\n BuildContext context,\n ) {\n return const Placeholder();\n }\n"},{"offset":1265,"length":81,"replacement":""},{"offset":1203,"length":14,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":36,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":1676,"length":142,"replacement":""},{"offset":1673,"length":0,"replacement":"@override\n Widget build(BuildContext context) {\n return const Placeholder();\n }\n"},{"offset":1603,"length":69,"replacement":""},{"offset":1544,"length":18,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":36,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":2008,"length":159,"replacement":""},{"offset":2005,"length":0,"replacement":"@override\n Widget build(BuildContext context) {\n return const Placeholder();\n }\n"},{"offset":1918,"length":86,"replacement":""},{"offset":1851,"length":22,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":36,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":2383,"length":167,"replacement":""},{"offset":2380,"length":0,"replacement":"@override\n Widget build(BuildContext context) {\n return const Placeholder();\n }\n"},{"offset":2279,"length":100,"replacement":""},{"offset":2204,"length":26,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":36,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":2676,"length":23,"replacement":""},{"offset":2575,"length":14,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.diff new file mode 100644 index 000000000..103fb34a1 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.diff @@ -0,0 +1,320 @@ +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:5`: +``` +import 'package:flutter_hooks/flutter_hooks.dart'; + +- class Stateless extends StatelessWidget { +- const Stateless({super.key}); +- +- @override ++ class Stateless extends StatefulHookConsumerWidget { ++ const Stateless({super.key}); ++ ++ @override ++ ConsumerState createState() => _StatelessState(); ++ } ++ ++ class _StatelessState extends ConsumerState { +@override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:14`: +``` +} + +- class StatelessWithComma extends StatelessWidget { +- const StatelessWithComma({super.key}); +- +- @override ++ class StatelessWithComma extends StatefulHookConsumerWidget { ++ const StatelessWithComma({super.key}); ++ ++ @override ++ ConsumerState createState() => _StatelessWithCommaState(); ++ } ++ ++ class _StatelessWithCommaState extends ConsumerState { +@override + Widget build( +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:25`: +``` +} + +- class Hook extends HookWidget { +- const Hook({super.key}); +- +- @override ++ class Hook extends StatefulHookConsumerWidget { ++ const Hook({super.key}); ++ ++ @override ++ ConsumerState createState() => _HookState(); ++ } ++ ++ class _HookState extends ConsumerState { +@override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:34`: +``` +} + +- class HookConsumer extends HookConsumerWidget { +- const HookConsumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumer extends StatefulHookConsumerWidget { ++ const HookConsumer({super.key}); ++ ++ @override ++ ConsumerState createState() => _HookConsumerState(); ++ } ++ ++ class _HookConsumerState extends ConsumerState { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 29 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:46`: +``` +} + +- class Stateful extends StatefulWidget { +- const Stateful({super.key}); +- +- @override +- State createState() => _StatefulState(); +- } +- +- class _StatefulState extends State { ++ class Stateful extends StatefulHookConsumerWidget { ++ const Stateful({super.key}); ++ ++ @override ++ ConsumerState createState() => _StatefulState(); ++ } ++ ++ class _StatefulState extends ConsumerState { + /// Hello world + @override +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 29 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:62`: +``` +} + +- class ExplicitCreateState extends StatefulWidget { +- const ExplicitCreateState({super.key}); +- +- @override +- ExplicitCreateStateState createState() => ExplicitCreateStateState(); +- } +- +- class ExplicitCreateStateState extends State { ++ class ExplicitCreateState extends StatefulHookConsumerWidget { ++ const ExplicitCreateState({super.key}); ++ ++ @override ++ ExplicitCreateStateState createState() => ExplicitCreateStateState(); ++ } ++ ++ class ExplicitCreateStateState extends ConsumerState { + @override + Widget build( +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:78`: +``` +} + +- class HookStateful extends StatefulHookWidget { +- const HookStateful({super.key}); +- +- @override +- State createState() => HookStatefulState(); +- } +- +- class HookStatefulState extends State { ++ class HookStateful extends StatefulHookConsumerWidget { ++ const HookStateful({super.key}); ++ ++ @override ++ ConsumerState createState() => HookStatefulState(); ++ } ++ ++ class HookStatefulState extends ConsumerState { + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:92`: +``` +} + +- class ConsumerStateful extends ConsumerStatefulWidget { ++ class ConsumerStateful extends StatefulHookConsumerWidget { + const ConsumerStateful({super.key}); + +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:121`: +``` +} + +- class Consumer extends ConsumerWidget { +- const Consumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class Consumer extends StatefulHookConsumerWidget { ++ const Consumer({super.key}); ++ ++ @override ++ ConsumerState createState() => _ConsumerState(); ++ } ++ ++ class _ConsumerState extends ConsumerState { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:133`: +``` +} + +- class StatelessWithField extends StatelessWidget { +- const StatelessWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build(BuildContext context) { +- return Column( +- children: [ +- Text('$field'), +- Text('$staticField'), ++ class StatelessWithField extends StatefulHookConsumerWidget { ++ const StatelessWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ ConsumerState createState() => _StatelessWithFieldState(); ++ } ++ ++ class _StatelessWithFieldState extends ConsumerState { ++ @override ++ Widget build(BuildContext context) { ++ return Column( ++ children: [ ++ Text('${widget.field}'), ++ Text('${StatelessWithField.staticField}'), + ], + ); +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:153`: +``` +} + +- class HookConsumerWithField extends HookConsumerWidget { +- const HookConsumerWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { +- return Column( +- children: [ +- Text('$field'), +- Text('$staticField'), ++ class HookConsumerWithField extends StatefulHookConsumerWidget { ++ const HookConsumerWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ ConsumerState createState() => _HookConsumerWithFieldState(); ++ } ++ ++ class _HookConsumerWithFieldState extends ConsumerState { ++ @override ++ Widget build( ++ BuildContext context) { ++ return Column( ++ children: [ ++ Text('${widget.field}'), ++ Text('${HookConsumerWithField.staticField}'), + ], + ); +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:180`: +``` +} + +- class ConsumerStatefulWithField extends ConsumerStatefulWidget { ++ class ConsumerStatefulWithField extends StatefulHookConsumerWidget { + const ConsumerStatefulWithField({ + super.key, +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.json deleted file mode 100644 index de88392fa..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":33,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":221,"length":0,"replacement":"@override\n ConsumerState createState() => _StatelessState();\n}\n\nclass _StatelessState extends ConsumerState {\n"},{"offset":168,"length":15,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":404,"length":0,"replacement":"@override\n ConsumerState createState() => _StatelessWithCommaState();\n}\n\nclass _StatelessWithCommaState extends ConsumerState {\n"},{"offset":342,"length":15,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":563,"length":0,"replacement":"@override\n ConsumerState createState() => _HookState();\n}\n\nclass _HookState extends ConsumerState {\n"},{"offset":520,"length":10,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":787,"length":23,"replacement":""},{"offset":737,"length":0,"replacement":"@override\n ConsumerState createState() => _HookConsumerState();\n}\n\nclass _HookConsumerState extends ConsumerState {\n"},{"offset":678,"length":18,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":29,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":1022,"length":15,"replacement":"ConsumerState"},{"offset":939,"length":15,"replacement":"ConsumerState"},{"offset":876,"length":14,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":29,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":1389,"length":26,"replacement":"ConsumerState"},{"offset":1203,"length":14,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":1708,"length":19,"replacement":"ConsumerState"},{"offset":1615,"length":19,"replacement":"ConsumerState"},{"offset":1544,"length":18,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":2045,"length":31,"replacement":"ConsumerState"},{"offset":1930,"length":31,"replacement":"ConsumerState"},{"offset":1851,"length":22,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":2676,"length":23,"replacement":""},{"offset":2626,"length":0,"replacement":"@override\n ConsumerState createState() => _ConsumerState();\n}\n\nclass _ConsumerState extends ConsumerState {\n"},{"offset":2575,"length":14,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.diff new file mode 100644 index 000000000..b45a2a93b --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.diff @@ -0,0 +1,346 @@ +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:5`: +``` +import 'package:flutter_hooks/flutter_hooks.dart'; + +- class Stateless extends StatelessWidget { +- const Stateless({super.key}); +- +- @override ++ class Stateless extends StatefulHookWidget { ++ const Stateless({super.key}); ++ ++ @override ++ State createState() => _StatelessState(); ++ } ++ ++ class _StatelessState extends State { +@override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:14`: +``` +} + +- class StatelessWithComma extends StatelessWidget { +- const StatelessWithComma({super.key}); +- +- @override ++ class StatelessWithComma extends StatefulHookWidget { ++ const StatelessWithComma({super.key}); ++ ++ @override ++ State createState() => _StatelessWithCommaState(); ++ } ++ ++ class _StatelessWithCommaState extends State { +@override + Widget build( +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:25`: +``` +} + +- class Hook extends HookWidget { +- const Hook({super.key}); +- +- @override ++ class Hook extends StatefulHookWidget { ++ const Hook({super.key}); ++ ++ @override ++ State createState() => _HookState(); ++ } ++ ++ class _HookState extends State { +@override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:34`: +``` +} + +- class HookConsumer extends HookConsumerWidget { +- const HookConsumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumer extends StatefulHookWidget { ++ const HookConsumer({super.key}); ++ ++ @override ++ State createState() => _HookConsumerState(); ++ } ++ ++ class _HookConsumerState extends State { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 28 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:46`: +``` +} + +- class Stateful extends StatefulWidget { ++ class Stateful extends StatefulHookWidget { + const Stateful({super.key}); + +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 28 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:62`: +``` +} + +- class ExplicitCreateState extends StatefulWidget { ++ class ExplicitCreateState extends StatefulHookWidget { + const ExplicitCreateState({super.key}); + +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:92`: +``` +} + +- class ConsumerStateful extends ConsumerStatefulWidget { +- const ConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => _ConsumerStatefulState(); +- } +- +- class _ConsumerStatefulState extends ConsumerState { ++ class ConsumerStateful extends StatefulHookWidget { ++ const ConsumerStateful({super.key}); ++ ++ @override ++ State createState() => _ConsumerStatefulState(); ++ } ++ ++ class _ConsumerStatefulState extends State { + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:106`: +``` +} + +- class HookConsumerStateful extends StatefulHookConsumerWidget { +- const HookConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => +- _HookConsumerStatefulState(); +- } +- +- class _HookConsumerStatefulState extends ConsumerState { ++ class HookConsumerStateful extends StatefulHookWidget { ++ const HookConsumerStateful({super.key}); ++ ++ @override ++ State createState() => ++ _HookConsumerStatefulState(); ++ } ++ ++ class _HookConsumerStatefulState extends State { + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:121`: +``` +} + +- class Consumer extends ConsumerWidget { +- const Consumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class Consumer extends StatefulHookWidget { ++ const Consumer({super.key}); ++ ++ @override ++ State createState() => _ConsumerState(); ++ } ++ ++ class _ConsumerState extends State { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:133`: +``` +} + +- class StatelessWithField extends StatelessWidget { +- const StatelessWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build(BuildContext context) { +- return Column( +- children: [ +- Text('$field'), +- Text('$staticField'), ++ class StatelessWithField extends StatefulHookWidget { ++ const StatelessWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ State createState() => _StatelessWithFieldState(); ++ } ++ ++ class _StatelessWithFieldState extends State { ++ @override ++ Widget build(BuildContext context) { ++ return Column( ++ children: [ ++ Text('${widget.field}'), ++ Text('${StatelessWithField.staticField}'), + ], + ); +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:153`: +``` +} + +- class HookConsumerWithField extends HookConsumerWidget { +- const HookConsumerWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { +- return Column( +- children: [ +- Text('$field'), +- Text('$staticField'), ++ class HookConsumerWithField extends StatefulHookWidget { ++ const HookConsumerWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ State createState() => _HookConsumerWithFieldState(); ++ } ++ ++ class _HookConsumerWithFieldState extends State { ++ @override ++ Widget build( ++ BuildContext context) { ++ return Column( ++ children: [ ++ Text('${widget.field}'), ++ Text('${HookConsumerWithField.staticField}'), + ], + ); +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:180`: +``` +} + +- class ConsumerStatefulWithField extends ConsumerStatefulWidget { +- const ConsumerStatefulWithField({ +- super.key, +- required this.field, +- required this.foo, +- }); +- +- final int field; +- final FooClass foo; +- static final int staticField = _constantNumber; +- +- @override +- ConsumerState createState() => +- _ConsumerStatefulWithFieldState(); +- } +- +- const _constantNumber = 42; +- +- class _ConsumerStatefulWithFieldState +- extends ConsumerState { ++ class ConsumerStatefulWithField extends StatefulHookWidget { ++ const ConsumerStatefulWithField({ ++ super.key, ++ required this.field, ++ required this.foo, ++ }); ++ ++ final int field; ++ final FooClass foo; ++ static final int staticField = _constantNumber; ++ ++ @override ++ State createState() => ++ _ConsumerStatefulWithFieldState(); ++ } ++ ++ const _constantNumber = 42; ++ ++ class _ConsumerStatefulWithFieldState ++ extends State { + void printFoo() { + print(widget.foo); +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.json deleted file mode 100644 index 8190dcdbc..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":32,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":221,"length":0,"replacement":"@override\n State createState() => _StatelessState();\n}\n\nclass _StatelessState extends State {\n"},{"offset":168,"length":15,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":404,"length":0,"replacement":"@override\n State createState() => _StatelessWithCommaState();\n}\n\nclass _StatelessWithCommaState extends State {\n"},{"offset":342,"length":15,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":563,"length":0,"replacement":"@override\n State createState() => _HookState();\n}\n\nclass _HookState extends State {\n"},{"offset":520,"length":10,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":787,"length":23,"replacement":""},{"offset":737,"length":0,"replacement":"@override\n State createState() => _HookConsumerState();\n}\n\nclass _HookConsumerState extends State {\n"},{"offset":678,"length":18,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":28,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":1022,"length":15,"replacement":"State"},{"offset":939,"length":15,"replacement":"State"},{"offset":876,"length":14,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":28,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":1389,"length":26,"replacement":"State"},{"offset":1203,"length":14,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":2045,"length":31,"replacement":"State"},{"offset":1930,"length":31,"replacement":"State"},{"offset":1851,"length":22,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":2424,"length":35,"replacement":"State"},{"offset":2291,"length":35,"replacement":"State"},{"offset":2204,"length":26,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":2676,"length":23,"replacement":""},{"offset":2626,"length":0,"replacement":"@override\n State createState() => _ConsumerState();\n}\n\nclass _ConsumerState extends State {\n"},{"offset":2575,"length":14,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.diff new file mode 100644 index 000000000..86ce03af7 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.diff @@ -0,0 +1,245 @@ +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:25`: +``` +} + +- class Hook extends HookWidget { +- const Hook({super.key}); +- +- @override ++ class Hook extends StatefulWidget { ++ const Hook({super.key}); ++ ++ @override ++ State createState() => _HookState(); ++ } ++ ++ class _HookState extends State { +@override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:34`: +``` +} + +- class HookConsumer extends HookConsumerWidget { +- const HookConsumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumer extends StatefulWidget { ++ const HookConsumer({super.key}); ++ ++ @override ++ State createState() => _HookConsumerState(); ++ } ++ ++ class _HookConsumerState extends State { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:78`: +``` +} + +- class HookStateful extends StatefulHookWidget { ++ class HookStateful extends StatefulWidget { + const HookStateful({super.key}); + +``` +--- +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:92`: +``` +} + +- class ConsumerStateful extends ConsumerStatefulWidget { +- const ConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => _ConsumerStatefulState(); +- } +- +- class _ConsumerStatefulState extends ConsumerState { ++ class ConsumerStateful extends StatefulWidget { ++ const ConsumerStateful({super.key}); ++ ++ @override ++ State createState() => _ConsumerStatefulState(); ++ } ++ ++ class _ConsumerStatefulState extends State { + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:106`: +``` +} + +- class HookConsumerStateful extends StatefulHookConsumerWidget { +- const HookConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => +- _HookConsumerStatefulState(); +- } +- +- class _HookConsumerStatefulState extends ConsumerState { ++ class HookConsumerStateful extends StatefulWidget { ++ const HookConsumerStateful({super.key}); ++ ++ @override ++ State createState() => ++ _HookConsumerStatefulState(); ++ } ++ ++ class _HookConsumerStatefulState extends State { + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:121`: +``` +} + +- class Consumer extends ConsumerWidget { +- const Consumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class Consumer extends StatefulWidget { ++ const Consumer({super.key}); ++ ++ @override ++ State createState() => _ConsumerState(); ++ } ++ ++ class _ConsumerState extends State { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:153`: +``` +} + +- class HookConsumerWithField extends HookConsumerWidget { +- const HookConsumerWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { +- return Column( +- children: [ +- Text('$field'), +- Text('$staticField'), ++ class HookConsumerWithField extends StatefulWidget { ++ const HookConsumerWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ State createState() => _HookConsumerWithFieldState(); ++ } ++ ++ class _HookConsumerWithFieldState extends State { ++ @override ++ Widget build( ++ BuildContext context) { ++ return Column( ++ children: [ ++ Text('${widget.field}'), ++ Text('${HookConsumerWithField.staticField}'), + ], + ); +``` +--- +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:180`: +``` +} + +- class ConsumerStatefulWithField extends ConsumerStatefulWidget { +- const ConsumerStatefulWithField({ +- super.key, +- required this.field, +- required this.foo, +- }); +- +- final int field; +- final FooClass foo; +- static final int staticField = _constantNumber; +- +- @override +- ConsumerState createState() => +- _ConsumerStatefulWithFieldState(); +- } +- +- const _constantNumber = 42; +- +- class _ConsumerStatefulWithFieldState +- extends ConsumerState { ++ class ConsumerStatefulWithField extends StatefulWidget { ++ const ConsumerStatefulWithField({ ++ super.key, ++ required this.field, ++ required this.foo, ++ }); ++ ++ final int field; ++ final FooClass foo; ++ static final int staticField = _constantNumber; ++ ++ @override ++ State createState() => ++ _ConsumerStatefulWithFieldState(); ++ } ++ ++ const _constantNumber = 42; ++ ++ class _ConsumerStatefulWithFieldState ++ extends State { + void printFoo() { + print(widget.foo); +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.json deleted file mode 100644 index 1b18dc0fd..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":30,"change":{"message":"Convert to StatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":563,"length":0,"replacement":"@override\n State createState() => _HookState();\n}\n\nclass _HookState extends State {\n"},{"offset":520,"length":10,"replacement":"StatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":30,"change":{"message":"Convert to StatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":787,"length":23,"replacement":""},{"offset":737,"length":0,"replacement":"@override\n State createState() => _HookConsumerState();\n}\n\nclass _HookConsumerState extends State {\n"},{"offset":678,"length":18,"replacement":"StatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":30,"change":{"message":"Convert to StatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":1708,"length":19,"replacement":"State"},{"offset":1615,"length":19,"replacement":"State"},{"offset":1544,"length":18,"replacement":"StatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":30,"change":{"message":"Convert to StatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":2045,"length":31,"replacement":"State"},{"offset":1930,"length":31,"replacement":"State"},{"offset":1851,"length":22,"replacement":"StatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":30,"change":{"message":"Convert to StatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":2424,"length":35,"replacement":"State"},{"offset":2291,"length":35,"replacement":"State"},{"offset":2204,"length":26,"replacement":"StatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":30,"change":{"message":"Convert to StatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":2676,"length":23,"replacement":""},{"offset":2626,"length":0,"replacement":"@override\n State createState() => _ConsumerState();\n}\n\nclass _ConsumerState extends State {\n"},{"offset":2575,"length":14,"replacement":"StatefulWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.diff new file mode 100644 index 000000000..fbf3ac38e --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.diff @@ -0,0 +1,240 @@ +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:25`: +``` +} + +- class Hook extends HookWidget { ++ class Hook extends StatelessWidget { + const Hook({super.key}); + +``` +--- +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:34`: +``` +} + +- class HookConsumer extends HookConsumerWidget { +- const HookConsumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumer extends StatelessWidget { ++ const HookConsumer({super.key}); ++ ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:78`: +``` +} + +- class HookStateful extends StatefulHookWidget { +- const HookStateful({super.key}); +- +- @override +- State createState() => HookStatefulState(); +- } +- +- class HookStatefulState extends State { ++ class HookStateful extends StatelessWidget { ++ const HookStateful({super.key}); ++ ++ + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:92`: +``` +} + +- class ConsumerStateful extends ConsumerStatefulWidget { +- const ConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => _ConsumerStatefulState(); +- } +- +- class _ConsumerStatefulState extends ConsumerState { ++ class ConsumerStateful extends StatelessWidget { ++ const ConsumerStateful({super.key}); ++ ++ + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:106`: +``` +} + +- class HookConsumerStateful extends StatefulHookConsumerWidget { +- const HookConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => +- _HookConsumerStatefulState(); +- } +- +- class _HookConsumerStatefulState extends ConsumerState { ++ class HookConsumerStateful extends StatelessWidget { ++ const HookConsumerStateful({super.key}); ++ ++ + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:121`: +``` +} + +- class Consumer extends ConsumerWidget { +- const Consumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class Consumer extends StatelessWidget { ++ const Consumer({super.key}); ++ ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:153`: +``` +} + +- class HookConsumerWithField extends HookConsumerWidget { +- const HookConsumerWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumerWithField extends StatelessWidget { ++ const HookConsumerWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ Widget build( ++ BuildContext context) { + return Column( + children: [ +``` +--- +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:180`: +``` +} + +- class ConsumerStatefulWithField extends ConsumerStatefulWidget { +- const ConsumerStatefulWithField({ +- super.key, +- required this.field, +- required this.foo, +- }); +- +- final int field; +- final FooClass foo; +- static final int staticField = _constantNumber; +- +- @override +- ConsumerState createState() => +- _ConsumerStatefulWithFieldState(); +- } +- +- const _constantNumber = 42; +- +- class _ConsumerStatefulWithFieldState +- extends ConsumerState { +- void printFoo() { +- print(widget.foo); +- } +- +- @override +- Widget build(BuildContext context) { +- print(widget.field); +- printFoo(); +- return Column( +- children: [ +- Text('${widget.field}'), +- Text('${widget.foo.bar}'), +- Text('${ConsumerStatefulWithField.staticField}'), +- ], +- ); +- } +- } ++ class ConsumerStatefulWithField extends StatelessWidget { ++ const ConsumerStatefulWithField({ ++ super.key, ++ required this.field, ++ required this.foo, ++ }); ++ ++ final int field; ++ final FooClass foo; ++ static final int staticField = _constantNumber; ++ ++ ++ void printFoo() { ++ print(foo); ++ } ++ ++ @override ++ Widget build(BuildContext context) { ++ print(field); ++ printFoo(); ++ return Column( ++ children: [ ++ Text('$field'), ++ Text('${foo.bar}'), ++ Text('$staticField'), ++ ], ++ ); ++ } ++ } ++ ++ const _constantNumber = 42; + +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.json deleted file mode 100644 index 71d0987a6..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":34,"change":{"message":"Convert to StatelessWidget","edits":[{"fileStamp":0,"edits":[{"offset":520,"length":10,"replacement":"StatelessWidget"}]}],"linkedEditGroups":[]}},{"priority":34,"change":{"message":"Convert to StatelessWidget","edits":[{"fileStamp":0,"edits":[{"offset":787,"length":23,"replacement":""},{"offset":678,"length":18,"replacement":"StatelessWidget"}]}],"linkedEditGroups":[]}},{"priority":34,"change":{"message":"Convert to StatelessWidget","edits":[{"fileStamp":0,"edits":[{"offset":1676,"length":142,"replacement":""},{"offset":1673,"length":0,"replacement":"@override\n Widget build(BuildContext context) {\n return const Placeholder();\n }\n"},{"offset":1603,"length":69,"replacement":""},{"offset":1544,"length":18,"replacement":"StatelessWidget"}]}],"linkedEditGroups":[]}},{"priority":34,"change":{"message":"Convert to StatelessWidget","edits":[{"fileStamp":0,"edits":[{"offset":2008,"length":159,"replacement":""},{"offset":2005,"length":0,"replacement":"@override\n Widget build(BuildContext context) {\n return const Placeholder();\n }\n"},{"offset":1918,"length":86,"replacement":""},{"offset":1851,"length":22,"replacement":"StatelessWidget"}]}],"linkedEditGroups":[]}},{"priority":34,"change":{"message":"Convert to StatelessWidget","edits":[{"fileStamp":0,"edits":[{"offset":2383,"length":167,"replacement":""},{"offset":2380,"length":0,"replacement":"@override\n Widget build(BuildContext context) {\n return const Placeholder();\n }\n"},{"offset":2279,"length":100,"replacement":""},{"offset":2204,"length":26,"replacement":"StatelessWidget"}]}],"linkedEditGroups":[]}},{"priority":34,"change":{"message":"Convert to StatelessWidget","edits":[{"fileStamp":0,"edits":[{"offset":2676,"length":23,"replacement":""},{"offset":2575,"length":14,"replacement":"StatelessWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget.dart index 04120bfc3..35ffffa14 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget.dart @@ -129,3 +129,88 @@ class Consumer extends ConsumerWidget { return const Placeholder(); } } + +class StatelessWithField extends StatelessWidget { + const StatelessWithField({ + super.key, + required this.field, + }); + + final int field; + static final int staticField = 42; + + @override + Widget build(BuildContext context) { + return Column( + children: [ + Text('$field'), + Text('$staticField'), + ], + ); + } +} + +class HookConsumerWithField extends HookConsumerWidget { + const HookConsumerWithField({ + super.key, + required this.field, + }); + + final int field; + static final int staticField = 42; + + @override + Widget build( + BuildContext context, + WidgetRef ref, + ) { + return Column( + children: [ + Text('$field'), + Text('$staticField'), + ], + ); + } +} + +class FooClass { + final bar = 42; +} + +class ConsumerStatefulWithField extends ConsumerStatefulWidget { + const ConsumerStatefulWithField({ + super.key, + required this.field, + required this.foo, + }); + + final int field; + final FooClass foo; + static final int staticField = _constantNumber; + + @override + ConsumerState createState() => + _ConsumerStatefulWithFieldState(); +} + +const _constantNumber = 42; + +class _ConsumerStatefulWithFieldState + extends ConsumerState { + void printFoo() { + print(widget.foo); + } + + @override + Widget build(BuildContext context) { + print(widget.field); + printFoo(); + return Column( + children: [ + Text('${widget.field}'), + Text('${widget.foo.bar}'), + Text('${ConsumerStatefulWithField.staticField}'), + ], + ); + } +} diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart index b3b2eb9a8..664c6e71e 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart @@ -1,7 +1,3 @@ -import 'dart:io'; - -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import 'package:analyzer/source/source_range.dart'; import 'package:pubspec_parse/pubspec_parse.dart'; import 'package:riverpod_lint/src/assists/convert_to_stateful_base_widget.dart'; @@ -23,28 +19,54 @@ void main() { StatelessBaseWidgetType.values.forEach( (targetWidget) { + final int expectedChangeCount; + switch (targetWidget) { + case StatelessBaseWidgetType.hookConsumerWidget: + expectedChangeCount = 11; + break; + case StatelessBaseWidgetType.hookWidget: + case StatelessBaseWidgetType.consumerWidget: + expectedChangeCount = 12; + break; + case StatelessBaseWidgetType.statelessWidget: + expectedChangeCount = 8; + break; + } _runGoldenTest( ConvertToStatelessBaseWidget( targetWidget: targetWidget, ), 'Convert widgets to ${targetWidget.name}s with hooks_riverpod and flutter_hooks dependency', - 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.json', + 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff', pubspecWithDependencies, - targetWidget == StatelessBaseWidgetType.statelessWidget ? 6 : 9, + expectedChangeCount, ); }, ); StatefulBaseWidgetType.values.forEach( (targetWidget) { + final int expectedChangeCount; + switch (targetWidget) { + case StatefulBaseWidgetType.statefulHookConsumerWidget: + case StatefulBaseWidgetType.statefulHookWidget: + expectedChangeCount = 12; + break; + case StatefulBaseWidgetType.consumerStatefulWidget: + expectedChangeCount = 11; + break; + case StatefulBaseWidgetType.statefulWidget: + expectedChangeCount = 8; + break; + } _runGoldenTest( ConvertToStatefulBaseWidget( targetWidget: targetWidget, ), 'Convert widgets to ${targetWidget.name}s with hooks_riverpod and flutter_hooks dependency', - 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.json', + 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff', pubspecWithDependencies, - targetWidget == StatefulBaseWidgetType.statefulWidget ? 6 : 9, + expectedChangeCount, ); }, ); @@ -58,26 +80,26 @@ void main() { final int expectedChangeCount; switch (targetWidget) { case StatelessBaseWidgetType.consumerWidget: - expectedChangeCount = 9; + expectedChangeCount = 12; break; case StatelessBaseWidgetType.hookWidget: case StatelessBaseWidgetType.hookConsumerWidget: expectedChangeCount = 0; break; case StatelessBaseWidgetType.statelessWidget: - expectedChangeCount = 6; + expectedChangeCount = 8; break; } final String goldenFilePath; switch (targetWidget) { case StatelessBaseWidgetType.hookWidget: case StatelessBaseWidgetType.hookConsumerWidget: - goldenFilePath = 'assists/empty.json'; + goldenFilePath = 'assists/empty.diff'; break; case StatelessBaseWidgetType.consumerWidget: case StatelessBaseWidgetType.statelessWidget: goldenFilePath = - 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.json'; + 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff'; break; } @@ -98,26 +120,26 @@ void main() { final int expectedChangeCount; switch (targetWidget) { case StatefulBaseWidgetType.consumerStatefulWidget: - expectedChangeCount = 9; + expectedChangeCount = 11; break; case StatefulBaseWidgetType.statefulHookWidget: case StatefulBaseWidgetType.statefulHookConsumerWidget: expectedChangeCount = 0; break; case StatefulBaseWidgetType.statefulWidget: - expectedChangeCount = 6; + expectedChangeCount = 8; break; } final String goldenFilePath; switch (targetWidget) { case StatefulBaseWidgetType.statefulHookWidget: case StatefulBaseWidgetType.statefulHookConsumerWidget: - goldenFilePath = 'assists/empty.json'; + goldenFilePath = 'assists/empty.diff'; break; case StatefulBaseWidgetType.consumerStatefulWidget: case StatefulBaseWidgetType.statefulWidget: goldenFilePath = - 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.json'; + 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff'; break; } @@ -153,14 +175,8 @@ void _runGoldenTest( testGolden( description, goldenFilePath, - () async { - final file = File( - 'test/assists/convert_to_widget/convert_to_widget.dart', - ).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; - + sourcePath: 'test/assists/convert_to_widget/convert_to_widget.dart', + (result) async { final changes = [ // Stateless ...await assist.testRun(result, const SourceRange(163, 0), @@ -205,6 +221,18 @@ void _runGoldenTest( // ConsumerWidget ...await assist.testRun(result, const SourceRange(2582, 0), pubspec: pubspec), + + // StatelessWithField + ...await assist.testRun(result, const SourceRange(2784, 0), + pubspec: pubspec), + + // HookConsumerWithField + ...await assist.testRun(result, const SourceRange(3139, 0), + pubspec: pubspec), + + // ConsumerStatefulWithField + ...await assist.testRun(result, const SourceRange(3571, 0), + pubspec: pubspec), ]; expect(changes, hasLength(expectedChangeCount)); diff --git a/packages/riverpod_lint_flutter_test/test/assists/empty.diff b/packages/riverpod_lint_flutter_test/test/assists/empty.diff new file mode 100644 index 000000000..e69de29bb diff --git a/packages/riverpod_lint_flutter_test/test/assists/empty.json b/packages/riverpod_lint_flutter_test/test/assists/empty.json deleted file mode 100644 index 0637a088a..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/empty.json +++ /dev/null @@ -1 +0,0 @@ -[] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart index b1d9a00c4..e45b6cc7b 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart @@ -1,24 +1,17 @@ -import 'dart:io'; - import 'package:test/test.dart'; import 'package:riverpod_lint/src/assists/wrap_with_consumer.dart'; import 'package:riverpod_lint/src/assists/wrap_with_provider_scope.dart'; import 'package:analyzer/source/source_range.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import '../../golden.dart'; void main() { testGolden( 'Wrap with consumer', - 'assists/wrap_widget/wrap_with_consumer.json', - () async { + 'assists/wrap_widget/wrap_with_consumer.diff', + sourcePath: 'test/assists/wrap_widget/wrap_widget.dart', + (result) async { final assist = WrapWithConsumer(); - final file = File('test/assists/wrap_widget/wrap_widget.dart').absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; var changes = [ // Map @@ -42,13 +35,10 @@ void main() { testGolden( 'Wrap with ProviderScope', - 'assists/wrap_widget/wrap_with_provider_scope.json', - () async { + 'assists/wrap_widget/wrap_with_provider_scope.diff', + sourcePath: 'test/assists/wrap_widget/wrap_widget.dart', + (result) async { final assist = WrapWithProviderScope(); - final file = File('test/assists/wrap_widget/wrap_widget.dart').absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; final changes = [ // Map diff --git a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.diff b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.diff new file mode 100644 index 000000000..acf024446 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.diff @@ -0,0 +1,28 @@ +Message: `Wrap with Consumer` +Priority: 28 +Diff for file `test/assists/wrap_widget/wrap_widget.dart:11`: +``` + Map(); + +- return Scaffold( +- body: Container(), +- ); ++ return Consumer(builder: (context, ref, child) { return Scaffold( ++ body: Container(), ++ ); },); + } +} +``` +--- +Message: `Wrap with Consumer` +Priority: 28 +Diff for file `test/assists/wrap_widget/wrap_widget.dart:12`: +``` + + return Scaffold( +- body: Container(), ++ body: Consumer(builder: (context, ref, child) { return Container(); },), + ); + } +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.json b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.json deleted file mode 100644 index 7fdca8789..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":28,"change":{"message":"Wrap with Consumer","edits":[{"fileStamp":0,"edits":[{"offset":281,"length":0,"replacement":"; },)"},{"offset":241,"length":0,"replacement":"Consumer(builder: (context, ref, child) { return "}]}],"linkedEditGroups":[]}},{"priority":28,"change":{"message":"Wrap with Consumer","edits":[{"fileStamp":0,"edits":[{"offset":274,"length":0,"replacement":"; },)"},{"offset":263,"length":0,"replacement":"Consumer(builder: (context, ref, child) { return "}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.diff b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.diff new file mode 100644 index 000000000..96714d099 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.diff @@ -0,0 +1,28 @@ +Message: `Wrap with ProviderScope` +Priority: 27 +Diff for file `test/assists/wrap_widget/wrap_widget.dart:11`: +``` + Map(); + +- return Scaffold( +- body: Container(), +- ); ++ return ProviderScope(child: Scaffold( ++ body: Container(), ++ ),); + } +} +``` +--- +Message: `Wrap with ProviderScope` +Priority: 27 +Diff for file `test/assists/wrap_widget/wrap_widget.dart:12`: +``` + + return Scaffold( +- body: Container(), ++ body: ProviderScope(child: Container(),), + ); + } +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.json b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.json deleted file mode 100644 index 6170c06a6..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":27,"change":{"message":"Wrap with ProviderScope","edits":[{"fileStamp":0,"edits":[{"offset":281,"length":0,"replacement":",)"},{"offset":241,"length":0,"replacement":"ProviderScope(child: "}]}],"linkedEditGroups":[]}},{"priority":27,"change":{"message":"Wrap with ProviderScope","edits":[{"fileStamp":0,"edits":[{"offset":274,"length":0,"replacement":",)"},{"offset":263,"length":0,"replacement":"ProviderScope(child: "}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/golden.dart b/packages/riverpod_lint_flutter_test/test/golden.dart index 646a103f8..54158a692 100644 --- a/packages/riverpod_lint_flutter_test/test/golden.dart +++ b/packages/riverpod_lint_flutter_test/test/golden.dart @@ -1,4 +1,3 @@ -import 'dart:convert'; import 'dart:io'; import 'package:freezed_annotation/freezed_annotation.dart'; @@ -6,6 +5,8 @@ import 'package:test/test.dart'; import 'package:path/path.dart'; import 'package:custom_lint_core/custom_lint_core.dart'; import 'package:analyzer_plugin/protocol/protocol_generated.dart'; +import 'package:analyzer/dart/analysis/results.dart'; +import 'package:analyzer/dart/analysis/utilities.dart'; @Deprecated('Do not commit') var goldenWrite = false; @@ -25,35 +26,43 @@ File writeToTemporaryFile(String content) { void testGolden( String description, String fileName, - Future> Function() body, -) { + Future> Function(ResolvedUnitResult unit) + body, { + required String sourcePath, +}) { test(description, () async { - final changes = await body().then((value) => value.toList()); + final file = File(sourcePath).absolute; + + final result = await resolveFile2(path: file.path); + result as ResolvedUnitResult; + + final changes = await body(result).then((value) => value.toList()); + final source = file.readAsStringSync(); try { expect( changes, - matcherNormalizedPrioritizedSourceChangeSnapshot(fileName), + matcherNormalizedPrioritizedSourceChangeSnapshot( + fileName, + sources: {'**': source}, + relativePath: Directory.current.path, + ), ); } on TestFailure { // ignore: deprecated_member_use_from_same_package if (!goldenWrite) rethrow; - final file = File('test/$fileName'); - - final changesJson = changes.map((e) => e.toJson()).toList(); - // Remove all "file" references from the json. - for (final change in changesJson) { - final changeMap = change['change']! as Map; - final edits = changeMap['edits']! as List; - for (final edit in edits.cast>()) { - edit.remove('file'); - } - } + final source = File(sourcePath).readAsStringSync(); + final result = encodePrioritizedSourceChanges( + changes, + sources: {'**': source}, + relativePath: Directory.current.path, + ); - file + final golden = File('test/$fileName'); + golden ..createSync(recursive: true) - ..writeAsStringSync(jsonEncode(changesJson)); + ..writeAsStringSync(result); return; } }); diff --git a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/async_value_nullable_pattern.dart b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/async_value_nullable_pattern.dart index 875b15fbe..5980e8489 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/async_value_nullable_pattern.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/async_value_nullable_pattern.dart @@ -55,3 +55,26 @@ void main() { print(value); } } + +void fn(T obj) { + switch (obj) { + // expect_lint: async_value_nullable_pattern + case AsyncValue(:final value?): + print(value); + } +} + +void fn2(T obj) { + switch (obj) { + case AsyncValue(:final value?): + print(value); + } +} + +void fn3(T obj) { + switch (obj) { + // expect_lint: async_value_nullable_pattern + case AsyncValue(:final value?): + print(value); + } +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff new file mode 100644 index 000000000..77c08f60a --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff @@ -0,0 +1,24 @@ +Message: `Use "hasValue: true" instead` +Priority: 100 +Diff for file `test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart:8`: +``` + case AsyncValue( + // expect_lint: async_value_nullable_pattern +- :final value?, ++ :final value, hasValue: true, + ): + print(value); +``` +--- +Message: `Use "hasValue: true" instead` +Priority: 100 +Diff for file `test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart:17`: +``` + case AsyncValue( + // expect_lint: async_value_nullable_pattern +- :final value? ++ :final value, hasValue: true + ): + print(value); +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.json b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.json deleted file mode 100644 index 93bdc91dd..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":100,"change":{"message":"Use \"hasValue: true\" instead","edits":[{"fileStamp":0,"edits":[{"offset":257,"length":0,"replacement":", hasValue: true"},{"offset":256,"length":1,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Use \"hasValue: true\" instead","edits":[{"fileStamp":0,"edits":[{"offset":472,"length":0,"replacement":", hasValue: true"},{"offset":471,"length":1,"replacement":""}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern_test.dart b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern_test.dart index 3883c5e86..04739c72a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern_test.dart @@ -1,25 +1,17 @@ -import 'dart:io'; - import 'package:collection/collection.dart'; import 'package:riverpod_lint/src/lints/async_value_nullable_pattern.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import '../../../golden.dart'; void main() { testGolden( 'Verify that @riverpod classes has the build method', - 'lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.json', - () async { + 'lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff', + sourcePath: + 'test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart', + (result) async { const lint = AsyncValueNullablePattern(); final fix = lint.getFixes().single; - final file = File( - 'test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart', - ).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; final errors = await lint.testRun(result); diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.diff b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.diff new file mode 100644 index 000000000..f45973703 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.diff @@ -0,0 +1,46 @@ +Message: `Type as NamelessRef` +Priority: 90 +Diff for file `test/lints/functional_ref/functional_ref.dart:8`: +``` +int nameless( + // expect_lint: functional_ref +- ref, ++ NamelessRef ref, +) { + return 0; +``` +--- +Message: `Type as NoGenericsRef` +Priority: 90 +Diff for file `test/lints/functional_ref/functional_ref.dart:21`: +``` +@riverpod +// expect_lint: functional_ref +- int noGenerics(NoGenericsRef ref) => 0; ++ int noGenerics(NoGenericsRef ref) => 0; + +@riverpod +``` +--- +Message: `Type as MissingGenericsRef` +Priority: 90 +Diff for file `test/lints/functional_ref/functional_ref.dart:25`: +``` +@riverpod +// expect_lint: functional_ref +- int missingGenerics(MissingGenericsRef ref) => 0; ++ int missingGenerics(MissingGenericsRef ref) => 0; + +@riverpod +``` +--- +Message: `Type as WrongOrderRef` +Priority: 90 +Diff for file `test/lints/functional_ref/functional_ref.dart:29`: +``` +@riverpod +// expect_lint: functional_ref +- int wrongOrder(WrongOrderRef ref) => 0; ++ int wrongOrder(WrongOrderRef ref) => 0; +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.json b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.json deleted file mode 100644 index 4def516b2..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":90,"change":{"message":"Type as NamelessRef","edits":[{"fileStamp":0,"edits":[{"offset":154,"length":0,"replacement":"NamelessRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as NoGenericsRef","edits":[{"fileStamp":0,"edits":[{"offset":357,"length":14,"replacement":"NoGenericsRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as MissingGenericsRef","edits":[{"fileStamp":0,"edits":[{"offset":450,"length":19,"replacement":"MissingGenericsRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as WrongOrderRef","edits":[{"fileStamp":0,"edits":[{"offset":543,"length":14,"replacement":"WrongOrderRef "}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart index ecfaac102..ba343372d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart @@ -1,10 +1,6 @@ -import 'dart:io'; - import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:collection/collection.dart'; import 'package:riverpod_lint/src/lints/functional_ref.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import 'package:test/test.dart'; import '../../golden.dart'; @@ -12,15 +8,11 @@ import '../../golden.dart'; void main() { testGolden( 'Verify that @riverpod classes extend the generated typedef', - 'lints/functional_ref/functional_ref.json', - () async { + 'lints/functional_ref/functional_ref.diff', + sourcePath: 'test/lints/functional_ref/functional_ref.dart', + (result) async { final lint = FunctionalRef(); final fix = lint.getFixes().single as DartFix; - final file = - File('test/lints/functional_ref/functional_ref.dart').absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; final errors = await lint.testRun(result); expect(errors, hasLength(4)); diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.diff b/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.diff new file mode 100644 index 000000000..6e6005b7a --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.diff @@ -0,0 +1,16 @@ +Message: `Add build method` +Priority: 80 +Diff for file `test/lints/notifier_build/fix/notifier_build.dart:8`: +``` +@riverpod +// expect_lint: notifier_build +- class ExampleProvider1 extends _$ExampleProvider1 {} ++ class ExampleProvider1 extends _$ExampleProvider1 { ++ @override ++ dynamic build() { ++ // TODO: implement build ++ throw UnimplementedError(); ++ } ++ } +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.json b/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.json deleted file mode 100644 index 978f6cc17..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":80,"change":{"message":"Add build method","edits":[{"fileStamp":0,"edits":[{"offset":212,"length":0,"replacement":"\n @override\n dynamic build() {\n // TODO: implement build\n throw UnimplementedError();\n }\n"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build_test.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build_test.dart index 40bf330c7..c0ddf8731 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build_test.dart @@ -1,25 +1,16 @@ -import 'dart:io'; - import 'package:collection/collection.dart'; import 'package:riverpod_lint/src/lints/notifier_build.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import '../../../golden.dart'; void main() { testGolden( 'Verify that @riverpod classes has the build method', - 'lints/notifier_build/fix/notifier_build.json', - () async { + 'lints/notifier_build/fix/notifier_build.diff', + sourcePath: 'test/lints/notifier_build/fix/notifier_build.dart', + (result) async { const lint = NotifierBuild(); final fix = lint.getFixes().single; - final file = File( - 'test/lints/notifier_build/fix/notifier_build.dart', - ).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; final errors = await lint.testRun(result); diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.diff b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.diff new file mode 100644 index 000000000..c0eea862c --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.diff @@ -0,0 +1,60 @@ +Message: `Extend _$NoExtends` +Priority: 90 +Diff for file `test/lints/notifier_extends/notifier_extends.dart:14`: +``` +@riverpod +// expect_lint: notifier_extends +- class NoExtends { ++ class NoExtends extends _$NoExtends { + int build() => 0; +} +``` +--- +Message: `Extend _$WrongExtends` +Priority: 90 +Diff for file `test/lints/notifier_extends/notifier_extends.dart:20`: +``` +@riverpod +// expect_lint: notifier_extends +- class WrongExtends extends AsyncNotifier { ++ class WrongExtends extends _$WrongExtends { + int build() => 0; +} +``` +--- +Message: `Extend _$NoGenerics` +Priority: 90 +Diff for file `test/lints/notifier_extends/notifier_extends.dart:38`: +``` +@riverpod +// expect_lint: notifier_extends +- class NoGenerics extends _$NoGenerics { ++ class NoGenerics extends _$NoGenerics { + int build() => 0; +} +``` +--- +Message: `Extend _$MissingGenerics` +Priority: 90 +Diff for file `test/lints/notifier_extends/notifier_extends.dart:44`: +``` +@riverpod +// expect_lint: notifier_extends +- class MissingGenerics extends _$MissingGenerics { ++ class MissingGenerics extends _$MissingGenerics { + int build() => 0; +} +``` +--- +Message: `Extend _$WrongOrder` +Priority: 90 +Diff for file `test/lints/notifier_extends/notifier_extends.dart:50`: +``` +@riverpod +// expect_lint: notifier_extends +- class WrongOrder extends _$WrongOrder { ++ class WrongOrder extends _$WrongOrder { + int build() => 0; +} +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.json b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.json deleted file mode 100644 index e76303fd3..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":90,"change":{"message":"Extend _$NoExtends","edits":[{"fileStamp":0,"edits":[{"offset":280,"length":0,"replacement":" extends _$NoExtends"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$WrongExtends","edits":[{"fileStamp":0,"edits":[{"offset":376,"length":18,"replacement":"_$WrongExtends"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$NoGenerics","edits":[{"fileStamp":0,"edits":[{"offset":780,"length":12,"replacement":"_$NoGenerics"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$MissingGenerics","edits":[{"fileStamp":0,"edits":[{"offset":897,"length":20,"replacement":"_$MissingGenerics"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$WrongOrder","edits":[{"fileStamp":0,"edits":[{"offset":1017,"length":18,"replacement":"_$WrongOrder"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart index 41e55a5ce..aa435bd7f 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart @@ -1,10 +1,6 @@ -import 'dart:io'; - import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:collection/collection.dart'; import 'package:riverpod_lint/src/lints/notifier_extends.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import 'package:test/test.dart'; import '../../golden.dart'; @@ -12,16 +8,11 @@ import '../../golden.dart'; void main() { testGolden( 'Verify that @riverpod classes extend the generated typedef', - 'lints/notifier_extends/notifier_extends.json', - () async { + 'lints/notifier_extends/notifier_extends.diff', + sourcePath: 'test/lints/notifier_extends/notifier_extends.dart', + (result) async { final lint = NotifierExtends(); final fix = lint.getFixes().single as DartFix; - final file = File( - 'test/lints/notifier_extends/notifier_extends.dart', - ).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; final errors = await lint.testRun(result); expect(errors, hasLength(5)); diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.diff b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.diff new file mode 100644 index 000000000..fddcc1f43 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.diff @@ -0,0 +1,137 @@ +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:14`: +``` + +// expect_lint: provider_dependencies +- @riverpod ++ @Riverpod(dependencies: [dep]) +int plainAnnotation(PlainAnnotationRef ref) { + ref.watch(depProvider); +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:21`: +``` + +// expect_lint: provider_dependencies +- @Riverpod(keepAlive: false) ++ @Riverpod(keepAlive: false, dependencies: [dep]) +int customAnnotation(CustomAnnotationRef ref) { + ref.watch(depProvider); +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:29`: +``` +// expect_lint: provider_dependencies +@Riverpod( +- keepAlive: false, ++ keepAlive: false, dependencies: [dep], +) +int customAnnotationWithTrailingComma( +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:41`: +``` + keepAlive: false, + // expect_lint: provider_dependencies +- dependencies: [], ++ dependencies: [dep], +) +int existingDep(ExistingDepRef ref) { +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:51`: +``` + keepAlive: false, + // expect_lint: provider_dependencies +- dependencies: [], ++ dependencies: [dep, dep2], +) +int multipleDeps(MultipleDepsRef ref) { +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:61`: +``` +@Riverpod( + keepAlive: false, +- dependencies: [ +- // expect_lint: provider_dependencies +- dep, +- dep2, +- ], ++ dependencies: [dep2], +) +int extraDep(ExtraDepRef ref) { +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:74`: +``` +@Riverpod( + keepAlive: false, +- dependencies: [ +- // expect_lint: provider_dependencies +- dep, +- ], +- ) ++ ) +int noDep(NoDepRef ref) { + return 0; +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:84`: +``` + +@Riverpod( +- dependencies: [ +- // expect_lint: provider_dependencies +- dep, +- ], +- keepAlive: false, ++ keepAlive: false, +) +int dependenciesFirstThenKeepAlive(DependenciesFirstThenKeepAliveRef ref) { +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:94`: +``` +} + +- @Riverpod( +- dependencies: [ +- // expect_lint: provider_dependencies +- dep, +- ], +- ) ++ @riverpod +int noDepNoParam(NoDepNoParamRef ref) { + return 0; +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:105`: +``` + +// expect_lint: provider_dependencies +- @Riverpod(keepAlive: false, dependencies: [dep]) ++ @Riverpod(keepAlive: false,) +int noDepWithoutComma(NoDepWithoutCommaRef ref) { + return 0; +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.json b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.json deleted file mode 100644 index 90d167dd6..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":100,"change":{"message":"Specify \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":266,"length":9,"replacement":"@Riverpod(dependencies: [dep])"}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Specify \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":427,"length":0,"replacement":", dependencies: [dep]"}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Specify \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":585,"length":0,"replacement":", dependencies: [dep]"}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Update \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":804,"length":2,"replacement":"[dep]"}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Update \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":976,"length":2,"replacement":"[dep, dep2]"}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Update \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":1137,"length":66,"replacement":"[dep2]"}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Remove \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":1311,"length":74,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Remove \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":1439,"length":74,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Remove \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":1627,"length":86,"replacement":"@riverpod"}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Remove \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":1834,"length":20,"replacement":""}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies_test.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies_test.dart index b9228ffe1..b12d6a212 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies_test.dart @@ -1,9 +1,5 @@ -import 'dart:io'; - import 'package:collection/collection.dart'; import 'package:riverpod_lint/src/lints/provider_dependencies.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import 'package:test/test.dart'; import '../../golden.dart'; @@ -11,16 +7,11 @@ import '../../golden.dart'; void main() { testGolden( 'Verify that @riverpod classes extend the generated typedef', - 'lints/provider_dependencies/provider_dependencies.json', - () async { + 'lints/provider_dependencies/provider_dependencies.diff', + sourcePath: 'test/lints/provider_dependencies/provider_dependencies.dart', + (result) async { const lint = ProviderDependencies(); final fix = lint.getFixes().single; - final file = File( - 'test/lints/provider_dependencies/provider_dependencies.dart', - ).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; final errors = await lint.testRun(result); expect(errors, hasLength(10)); diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.freezed.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.freezed.dart index 803df2d6d..d3b95eea0 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.freezed.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.freezed.dart @@ -12,7 +12,7 @@ part of 'provider_parameters.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$FreezedExample {} @@ -62,7 +62,7 @@ class _$FreezedExampleImpl implements _FreezedExample { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$FreezedExampleImpl); } diff --git a/website/docs/case_studies/cancel.mdx b/website/docs/case_studies/cancel.mdx index ffd5f71f5..182265a5e 100644 --- a/website/docs/case_studies/cancel.mdx +++ b/website/docs/case_studies/cancel.mdx @@ -31,7 +31,7 @@ use: navigates away from the page before the request completes. This ensures that you don't waste time processing a response that the user will never see. -In Riverpod, both of these techniques are can be implemented in a similar way. +In Riverpod, both of these techniques can be implemented in a similar way. The key is to use `ref.onDispose` combined with "automatic disposal" or `ref.watch` to achieve the desired behavior. diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.freezed.dart b/website/docs/case_studies/cancel/detail_screen/codegen.freezed.dart index f4f9398ea..1020def96 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.freezed.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Activity _$ActivityFromJson(Map json) { return _Activity.fromJson(json); @@ -153,7 +153,7 @@ class _$ActivityImpl implements _Activity { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ActivityImpl && diff --git a/website/docs/case_studies/pull_to_refresh/activity/codegen.freezed.dart b/website/docs/case_studies/pull_to_refresh/activity/codegen.freezed.dart index f4f9398ea..1020def96 100644 --- a/website/docs/case_studies/pull_to_refresh/activity/codegen.freezed.dart +++ b/website/docs/case_studies/pull_to_refresh/activity/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Activity _$ActivityFromJson(Map json) { return _Activity.fromJson(json); @@ -153,7 +153,7 @@ class _$ActivityImpl implements _Activity { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ActivityImpl && diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.freezed.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.freezed.dart index f4f9398ea..1020def96 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.freezed.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Activity _$ActivityFromJson(Map json) { return _Activity.fromJson(json); @@ -153,7 +153,7 @@ class _$ActivityImpl implements _Activity { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ActivityImpl && diff --git a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart index a04416833..0b73d3548 100644 --- a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart +++ b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$Todo { @@ -126,7 +126,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/docs/concepts/why_immutability/codegen.freezed.dart b/website/docs/concepts/why_immutability/codegen.freezed.dart index acb6d0e7f..6e8c8082b 100644 --- a/website/docs/concepts/why_immutability/codegen.freezed.dart +++ b/website/docs/concepts/why_immutability/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$ThemeSettings { @@ -116,7 +116,7 @@ class _$ThemeSettingsImpl implements _ThemeSettings { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ThemeSettingsImpl && diff --git a/website/docs/essentials/combining_requests.mdx b/website/docs/essentials/combining_requests.mdx index 7acf31d05..d887f68dc 100644 --- a/website/docs/essentials/combining_requests.mdx +++ b/website/docs/essentials/combining_requests.mdx @@ -12,20 +12,20 @@ import watchPlacement from "./combining_requests/watch_placement"; import listenExample from "./combining_requests/listen_example"; import readExample from './combining_requests/read_example' -Up till now, we've only seens cases were requests are independent from each +Up till now, we've only seen cases where requests are independent from each other. But a common use-case is to have to trigger a request based on the result of another request. We _could_ be using the mechanism to -do that, by passing the result of a provider as parameter to another a provider. +do that, by passing the result of a provider as a parameter to another provider. But this approach has a few downsides: - This leaks implementation details. Now, your UI needs to know about all the providers that are used - your other provider. -- Whenever the parameter change, a brand new state will be made. - By passing parameters, there are no way to keep the previous state + by your other provider. +- Whenever the parameter changes, a brand new state will be made. + By passing parameters, there is no way to keep the previous state when the parameter changes. - It makes combining requests harder. - This makes tooling less useful. A devtool wouldn't @@ -38,13 +38,13 @@ To improve this, Riverpod offers a different approach to combine requests. All possible ways of combining requests have one thing in common: They are all based on the `Ref` object. -The `Ref` object is an object which all providers have access to. +The `Ref` object is an object to which all providers have access. It grants them access to various life-cycle listeners, but also various methods to combine providers. The place where `Ref` can be obtained depends on the type of provider. -In functional providers, the `Ref` is passed as parameter to the +In functional providers, the `Ref` is passed as a parameter to the provider's function: @@ -77,12 +77,12 @@ Then, we could use this location to fetch the list of restaurants near the user. :::info -When the listened provider changes and our request recomputes, the previous -state is kept until the new request completes. +When the listened to provider changes and our request recomputes, the previous +state is kept until the new request is completed. At the same time, while the request is pending, the "isLoading" and "isReloading" flags will be set. -This enables UI to either show the previous state, or a loading indicator, +This enables UI to either show the previous state or a loading indicator, or even both. ::: @@ -93,7 +93,7 @@ await for an initial value to be available. If we omit that `.future`, we would receive an `AsyncValue`, which is a snapshot of the current state of the `locationProvider`. But if no location is available yet, -we wouldn't be able to do anything. +we won't be able to do anything. ::: :::caution diff --git a/website/docs/essentials/faq.mdx b/website/docs/essentials/faq.mdx index 1ddad482a..29f584183 100644 --- a/website/docs/essentials/faq.mdx +++ b/website/docs/essentials/faq.mdx @@ -48,7 +48,7 @@ This is done on purpose to avoid writing code which conditionally depends on one or the other. One issue is that `Ref` and `WidgetRef`, although similar looking, -have suble differences. +have subtle differences. Code relying on both would be unreliable in ways that are difficult to spot. At the same time, relying on `WidgetRef` is equivalent to relying on `BuildContext`. diff --git a/website/docs/essentials/first_request.mdx b/website/docs/essentials/first_request.mdx index 22902b9e1..620a3be52 100644 --- a/website/docs/essentials/first_request.mdx +++ b/website/docs/essentials/first_request.mdx @@ -243,7 +243,7 @@ Using the syntax defined previously, we can therefore define our provider as fol In this snippet, we've defined a provider named `activityProvider` which -our UI will be able to use to obtain a random activity. It is worth nothing +our UI will be able to use to obtain a random activity. It is worth noting that: - The network request will not be executed until the UI reads the provider diff --git a/website/docs/essentials/first_request/codegen/activity.freezed.dart b/website/docs/essentials/first_request/codegen/activity.freezed.dart index c10bc4253..6ffa343c1 100644 --- a/website/docs/essentials/first_request/codegen/activity.freezed.dart +++ b/website/docs/essentials/first_request/codegen/activity.freezed.dart @@ -12,7 +12,7 @@ part of 'activity.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Activity _$ActivityFromJson(Map json) { return _Activity.fromJson(json); @@ -177,7 +177,7 @@ class _$ActivityImpl implements _Activity { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ActivityImpl && diff --git a/website/docs/essentials/side_effects.mdx b/website/docs/essentials/side_effects.mdx index 61059b609..9172ebbc3 100644 --- a/website/docs/essentials/side_effects.mdx +++ b/website/docs/essentials/side_effects.mdx @@ -427,7 +427,7 @@ performed, nor any information if failed. One way to do so is to store the Future returned by `addTodo` in the local widget state, and then listen to that future to show -a snipper or error message. +a spinner or error message. This is one scenario where [flutter_hooks](https://pub.dev/packages/flutter_hooks) comes in handy. But of course, you can also use a `StatefulWidget` instead. diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier.freezed.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier.freezed.dart index 319351f78..3326f9ffa 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier.freezed.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier.freezed.dart @@ -12,7 +12,7 @@ part of 'todo_list_notifier.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Todo _$TodoFromJson(Map json) { return _Todo.fromJson(json); @@ -121,7 +121,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.freezed.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.freezed.dart index 95e5e1d15..26a2d640c 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.freezed.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.freezed.dart @@ -12,7 +12,7 @@ part of 'todo_list_provider.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$Todo { @@ -113,7 +113,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/docs/essentials/testing.mdx b/website/docs/essentials/testing.mdx index 61b068f91..bb52e0906 100644 --- a/website/docs/essentials/testing.mdx +++ b/website/docs/essentials/testing.mdx @@ -45,7 +45,7 @@ The main difference with any other test is that we will want to create a `ProviderContainer` object. This object will enable our test to interact with providers. -It encouraged to make a testing utility for both creating and disposing +It is encouraged to make a testing utility for both creating and disposing of a `ProviderContainer` object: diff --git a/website/docs/from_provider/helpers/item.freezed.dart b/website/docs/from_provider/helpers/item.freezed.dart index 959fe13d2..e578c8154 100644 --- a/website/docs/from_provider/helpers/item.freezed.dart +++ b/website/docs/from_provider/helpers/item.freezed.dart @@ -12,7 +12,7 @@ part of 'item.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Item _$ItemFromJson(Map json) { return _Item.fromJson(json); @@ -107,7 +107,7 @@ class _$ItemImpl implements _Item { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$ItemImpl && diff --git a/website/docs/from_provider/quickstart.mdx b/website/docs/from_provider/quickstart.mdx index 316f27084..6ed213073 100644 --- a/website/docs/from_provider/quickstart.mdx +++ b/website/docs/from_provider/quickstart.mdx @@ -64,7 +64,7 @@ This should boost and simplify the migration process, while also minimizing / tr ## Riverpod and Provider can coexist *Keep in mind that it is entirely possible to use both Provider and Riverpod at the same time.* -Indeed, using import aliases, it is possible to use the two APIs altogheter. +Indeed, using import aliases, it is possible to use the two APIs altogether. This is also great for readibilty and it removes any ambiguous API usage. If you plan on doing this, consider using import aliases for each Provider import in your codebase. @@ -204,4 +204,5 @@ Following this guide, you *can* migrate towards codegen as a further step forwar [are composable by default]: /docs/from_provider/motivation#combining-providers-is-hard-and-error-prone [as mentioned above]: /docs/from_provider/quickstart#start-with-changenotifierprovider [Riverpod's `Consumer` APIs]: /docs/concepts/reading -[lazy by default]: /docs/concepts/provider_lifecycles \ No newline at end of file +[lazy by default]: /docs/concepts/provider_lifecycles +[is available here]: /docs/essentials/eager_initialization diff --git a/website/docs/providers/notifier_provider/remote_todos/codegen.freezed.dart b/website/docs/providers/notifier_provider/remote_todos/codegen.freezed.dart index 315bc924e..d1b8a01d5 100644 --- a/website/docs/providers/notifier_provider/remote_todos/codegen.freezed.dart +++ b/website/docs/providers/notifier_provider/remote_todos/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Todo _$TodoFromJson(Map json) { return _Todo.fromJson(json); @@ -134,7 +134,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/docs/providers/notifier_provider/todos/codegen.freezed.dart b/website/docs/providers/notifier_provider/todos/codegen.freezed.dart index a04416833..0b73d3548 100644 --- a/website/docs/providers/notifier_provider/todos/codegen.freezed.dart +++ b/website/docs/providers/notifier_provider/todos/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$Todo { @@ -126,7 +126,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current.json b/website/i18n/fr/docusaurus-plugin-content-docs/current.json index 994ac7a22..0669be5a8 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current.json +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current.json @@ -91,9 +91,9 @@ "message": "Application Todo avec fonction de sauvegarde et de restauration", "description": "The label for link Todo App with Backup and Restore feature in sidebar Sidebar, linking to https://github.com/TheAlphaApp/flutter_riverpod_todo_app" }, - "sidebar.Sidebar.link.Integrating Hive database with Riverpod (simple example)": { - "message": "Integration d'une base de donnée Hive avec Riverpod (exemple simple)", - "description": "The label for link Integrating Hive database with Riverpod (simple example) in sidebar Sidebar, linking to https://github.com/GitGud31/theme_riverpod_hive" + "sidebar.Sidebar.link.Integrating Hive database with Riverpod": { + "message": "Integration d'une base de donnée Hive avec Riverpod", + "description": "The label for link Integrating Hive database with Riverpod in sidebar Sidebar, linking to https://github.com/GitGud31/flutter_theme_riverpod_hive" }, "sidebar.Sidebar.link.Browser App with Riverpod": { "message": "Application navigateur avec Riverpod", diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx b/website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx new file mode 100644 index 000000000..58a015b59 --- /dev/null +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx @@ -0,0 +1,10 @@ +--- +title: Pull-to-refresh / Retry-on-error +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +Dans ce guide, nous verrons comment les Providers peuvent être utilisés pour mettre +en œuvre facilement une fonction de "pull-to-refresh" ou de "retry-on-error" +(tentative de réessai en cas d'erreur). \ No newline at end of file diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx b/website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx new file mode 100644 index 000000000..027aa921a --- /dev/null +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx @@ -0,0 +1,133 @@ +--- +titre : Recherche au fur et à mesure de la frappe +--- +Un exemple concret pourrait être l'utilisation de `FutureProvider` pour implémenter une barre de recherche. + +## Exemple d'utilisation : Barre de recherche "Search as we type" (recherche au fur et à mesure de la frappe) + +La mise en œuvre d'une "recherche au fil de la frappe" peut sembler décourageante au début si l'on utilise des moyens conventionnels. +Il y a beaucoup d'éléments en jeu, tels que + +- le traitement des erreurs. +- le débouclage (debouncing) de l'entrée de l'utilisateur afin d'éviter de faire des demandes de réseau à chaque frappe. +- l'annulation des demandes de réseau en attente lorsque le champ de recherche change. + +Mais la combinaison de `FutureProvider` et de la puissance de [ref.watch] peut considérablement simplifier cette tâche. + +Un schéma courant pour effectuer des requêtes asynchrones est de la diviser en plusieurs providers : + +- un [StateNotifierProvider] ou `StateProvider` pour les paramètres de votre requête (ou alternativement utiliser [family]) +- un `FutureProvider`, qui effectuera la requête en lisant les paramètres des autres providers/[family]. + +La première étape consiste à stocker l'entrée de l'utilisateur quelque part. Pour cet exemple, nous utiliserons `StateProvider` (puisque l'état de la recherche n'est qu'une simple `chaîne`) : + +```dart +final searchInputProvider = StateProvider((ref) => ''); +``` + +Nous pouvons ensuite connecter ce provider à un [TextField] en faisant : + +```dart +Consumer( + builder: (context, ref, child) { + return TextField( + onChanged: (value) => ref.read(searchInputProvider.notifier).state = value, + ); + }, +) +``` + +Ensuite, nous pouvons créer notre `FutureProvider` qui s'occupera de la requête : + +```dart +final searchProvider = FutureProvider< + + + + + + + } + + +}`} + annotations={[ + { + offset: 0, + length: 9, + label: "L'annotazione", + description: <> + +Tutti i provider devono essere annotati con `@riverpod` o `@Riverpod()`. +Questa annotazione può essere posta su funzioni globali o classi. +Attraverso questa annotazione, è possibile configurare il provider. + +Per esempio, possiamo disabilitare "auto-dispose" (che vedremo più avanti) scrivendo `@Riverpod(keepAlive: true)`. + + + }, + { + offset: 10, + length: 16, + label: "Il Notifier", + description: <> + +Quando un'annotazione `@riverpod` è posta su una classe, quella classe viene chiamata "Notifier". +La classe deve estendere `_$NotifierName`, dove `NotifierName` è il nome della classe. + +I Notifiers sono responsabili di esporre modalità per modificare lo stato del provider. +I metodi pubblici di questa classe sono accessibili ai consumer usando `ref.read(yourProvider.notifier).tuoMetodo()`. + +:::note +I Notifiers non dovrebbero avere proprietà pubbliche oltre alla proprietà built-in `state`, poiché l'interfaccia utente +non avrebbe modo di sapere che lo stato è cambiato. +::: + + + }, + { + offset: 52, + length: 54, + label: "Il metodo build", + description: <> + +Tutti i notifiers devono sovrascrivere il metodo `build`. +Questo metodo è equivalente al punto in cui normalmente inseriresti la tua +logica in un provider non-notifier. + +Questo metodo non dovrebbe essere chiamato direttamente. + + + }, +]} +/> + + +Per ulteriori informazioni, potresti voler consultare +per confrontare questa nuova sintassi con quella vista in precedenza. + +:::info +Un Notifier senza metodi al di fuori di `build` è identico all'utilizzo della sintassi vista in precedenza. +La sintassi mostrata in può essere considerata +come una scorciatoia per i notifiers senza possibilità di essere modificati dall'interfaccia utente. +::: + +Ora che abbiamo visto la sintassi, vediamo come convertire il nostro provider precedentemente definito in un notifier: + + + +Notiamo che il modo di leggere il provider all'interno dei widget non è cambiato. +Puoi ancora usare `ref.watch(todoListProvider)` come nella sintassi precedente. + +:::caution +Non inserire la logica nel costruttore del tuo notifier. +I notifiers non dovrebbero avere un costruttore, poiché `ref` e altre proprietà +non sono ancora disponibili in quel momento. Invece, inserisci la tua logica nel metodo `build`. + +```dart +class MyNotifier extends ... { + MyNotifier() { + // ❌ Non fare questo + // Causerà un'eccezione + state = AsyncValue.data(42); + } + + @override + Result build() { + // ✅ Fare questo invece + state = AsyncValue.data(42); + } +} +``` + +::: + +## Esporre un metodo per effettuare una richiesta _POST_ + +Ora che abbiamo un Notifier, possiamo iniziare ad aggiungere metodi per abilitare i side-effects. +Un side-effect del genere potrebbe essere quello di far eseguire al client una richiesta _POST_ +per aggiungere un nuovo elemento todo. +Possiamo farlo aggiungendo un metodo `addTodo` al nostro notifier: + + + +:::info +Nota come stiamo usando `ref.read` invece di `ref.watch` per invocare il nostro metodo. +Anche se `ref.watch` potrebbe funzionare tecnicamente, si consiglia di utilizzare `ref.read` +quando si esegue la logica negli event handlers come "onPressed". +::: + +Abbiamo ora un pulsante che effettua una richiesta _POST_ quando premuto. +Tuttavia, al momento, la nostra interfaccia utente non si aggiorna per riflettere la nuova to-do list. +Vogliamo che la nostra cache locale corrisponda allo stato del server. + +Esistono diversi modi per farlo, ognuno con i suoi vantaggi e svantaggi. + +### Aggiornare la cache locale per riflettere la risposta dell'API + +Una pratica comune lato server è fare sì che la richiesta _POST_ restituisca il nuovo stato della risorsa. +In particolare, la nostra API restituirebbe la nuova lista to-do dopo l'aggiunta di un nuovo to-do. +Un modo per farlo è scrivere `state = AsyncData(response)`: + + + +:::tip pro + +- L'interfaccia utente avrà lo stato più aggiornato possibile. + Se un altro utente ha aggiunto un to-do, la vedremo anche noi. +- Il server è la fonte di verità. Con questo approccio, + il client non ha bisogno di sapere dove il nuovo to-do deve essere inserito nella list to-do. +- È necessaria solo una singola richiesta di rete. + +::: + +:::danger contro + +- Questo approccio funzionerà solo se il server è implementato in un modo specifico. + Se il server non restituisce il nuovo stato, questo approccio non funzionerà. +- Potrebbe ancora non essere fattibile se la richiesta _GET_ associata è più complessa, + ad esempio se ha filtri/ordinamenti. + +::: + +### Usare `ref.invalidateSelf()` per ricaricare il provider. + +Un'opzione è far eseguire nuovamente la richiesta _GET_ al nostro provider. +Questo può essere fatto chiamando `ref.invalidateSelf()` dopo la richiesta _POST_: + + + +:::tip pro + +- L'interfaccia utente avrà lo stato più aggiornato possibile. + Se un altro utente ha aggiunto un nuovo to-do, lo vedremo anche noi. +- Il server è la fonte di verità. + Con questo approccio, il client non ha bisogno di sapere dove inserire il nuovo to-do + nella lista dei to-do. +- Questo approccio dovrebbe funzionare indipendentemente dall'implementazione del server. + Può essere particolarmente utile se la tua richiesta _GET_ è più complessa, + ad esempio se ha filtri/ordinamenti. + +::: + +:::danger contro + +- Questo approccio eseguirà una richiesta _GET_ aggiuntiva, il che potrebbe + essere inefficiente. + +::: + +### Aggiornare la cache locale manualmente + +Un'altra opzione è quella di aggiornare manualmente la cache locale. +Ciò implicherebbe cercare di imitare il comportamento del backend. +Ad esempio, dovremmo sapere se il backend inserisce nuovi elementi +all'inizio o alla fine. + + + +:::info +Questo esempio utilizza uno stato immutabile. Non è obbligatorio, ma consigliato. +Consulta per ulteriori dettagli. +Se desideri utilizzare uno stato mutabile, puoi fare in alternativa: + + + +::: + +:::tip pro + +- Questo approccio dovrebbe funzionare indipendentemente dall'implementazione del server. +- È necessaria solo una singola richiesta di rete. + +::: + +:::danger contro + +- La cache locale potrebbe non corrispondere allo stato del server. + Se un altro utente ha aggiunto un to-do, non lo vedremo. +- Questo approccio potrebbe essere più complesso da implementare ed in realtà + duplicare la logica del backend. + +::: + +## Andando oltre: Mostrare uno spinner e gestione dell'errore + +Con tutto ciò che abbiamo visto finora, abbiamo un pulsante che effettua una richiesta _POST_ +quando viene premuto; e quando la richiesta è completata, l'interfaccia utente si aggiorna per riflettere +le modifiche. Ma al momento, non c'è alcuna indicazione che la richiesta stia avvenendo, +né alcuna informazione in caso di fallimento. + +Un modo per farlo è memorizzare il Future restituito da `addTodo` +nello stato locale del widget e quindi ascoltare quel future per mostrare +un indicatore di caricamento o un messaggio di errore. Questo è uno scenario in cui +[flutter_hooks](https://pub.dev/packages/flutter_hooks) risulta utile. Ma naturalmente, +è possibile utilizzare anche un `StatefulWidget` al suo posto. + +Il seguente snippet mostra un indicatore di avanzamento mentre +un'operazione è in corso. Se fallisce, rende il pulsante di colore rosso: + +![Un bottone che diventa rosso quando l'operazione fallisce](/img/essentials/side_effects/spinner.gif) + + \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart new file mode 100644 index 000000000..23a30cb03 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart @@ -0,0 +1,28 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo_list_notifier.freezed.dart'; +part 'todo_list_notifier.g.dart'; + +@freezed +class Todo with _$Todo { + factory Todo({ + required String description, + @Default(false) bool completed, + }) = _Todo; + + factory Todo.fromJson(Map json) => _$TodoFromJson(json); +} + +/* SNIPPET START */ +@riverpod +class TodoList extends _$TodoList { + @override + Future> build() async { + // La logica che precedentemente avevamo nel nostro FutureProvider è ora nel metodo 'build'. + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart new file mode 100644 index 000000000..3326f9ffa --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart @@ -0,0 +1,166 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'todo_list_notifier.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Todo _$TodoFromJson(Map json) { + return _Todo.fromJson(json); +} + +/// @nodoc +mixin _$Todo { + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$TodoImpl implements _Todo { + _$TodoImpl({required this.description, this.completed = false}); + + factory _$TodoImpl.fromJson(Map json) => + _$$TodoImplFromJson(json); + + @override + final String description; + @override + @JsonKey() + final bool completed; + + @override + String toString() { + return 'Todo(description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); + + @override + Map toJson() { + return _$$TodoImplToJson( + this, + ); + } +} + +abstract class _Todo implements Todo { + factory _Todo({required final String description, final bool completed}) = + _$TodoImpl; + + factory _Todo.fromJson(Map json) = _$TodoImpl.fromJson; + + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart new file mode 100644 index 000000000..4e6801ff7 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -0,0 +1,42 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_notifier.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$TodoImpl _$$TodoImplFromJson(Map json) => _$TodoImpl( + description: json['description'] as String, + completed: json['completed'] as bool? ?? false, + ); + +Map _$$TodoImplToJson(_$TodoImpl instance) => + { + 'description': instance.description, + 'completed': instance.completed, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todoListHash() => r'c939d438b07da6065dbbcfab86c27ef363bdb76c'; + +/// See also [TodoList]. +@ProviderFor(TodoList) +final todoListProvider = + AutoDisposeAsyncNotifierProvider>.internal( + TodoList.new, + name: r'todoListProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$TodoList = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart new file mode 100644 index 000000000..1b3803279 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart @@ -0,0 +1,26 @@ +// ignore_for_file: avoid_print + +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'todo_list_notifier.dart'; + +part 'todo_list_notifier_add_todo.g.dart'; + +/* SNIPPET START */ +@riverpod +class TodoList extends _$TodoList { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + await http.post( + Uri.https('your_api.com', '/todos'), + // Serializziamo il nostro oggetto Todo e lo salviamo tramite POST sul server. + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart new file mode 100644 index 000000000..8d2e07c04 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_notifier_add_todo.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todoListHash() => r'4008395aaca8f55312f668c0b2a32e7599f82349'; + +/// See also [TodoList]. +@ProviderFor(TodoList) +final todoListProvider = + AutoDisposeAsyncNotifierProvider>.internal( + TodoList.new, + name: r'todoListProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$TodoList = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart new file mode 100644 index 000000000..76ab146fd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart @@ -0,0 +1,23 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo_list_provider.freezed.dart'; +part 'todo_list_provider.g.dart'; + +@freezed +class Todo with _$Todo { + factory Todo({ + required String description, + @Default(false) bool completed, + }) = _Todo; +} + +/* SNIPPET START */ +@riverpod +Future> todoList(TodoListRef ref) async { + // Simula una richiesta di rete. Normalmente il risultato dovrebbe venire da una API reale + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart new file mode 100644 index 000000000..26a2d640c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart @@ -0,0 +1,148 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'todo_list_provider.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$Todo { + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc + +class _$TodoImpl implements _Todo { + _$TodoImpl({required this.description, this.completed = false}); + + @override + final String description; + @override + @JsonKey() + final bool completed; + + @override + String toString() { + return 'Todo(description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @override + int get hashCode => Object.hash(runtimeType, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); +} + +abstract class _Todo implements Todo { + factory _Todo({required final String description, final bool completed}) = + _$TodoImpl; + + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart new file mode 100644 index 000000000..caa526bca --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todoListHash() => r'26b30307668c8feefa7cbe3c400b73e6edccbc39'; + +/// See also [todoList]. +@ProviderFor(todoList) +final todoListProvider = AutoDisposeFutureProvider>.internal( + todoList, + name: r'todoListProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef TodoListRef = AutoDisposeFutureProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart new file mode 100644 index 000000000..b65d27945 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart @@ -0,0 +1,23 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../raw/todo_list_notifier.dart' show Todo; +import '../raw/todo_list_notifier_add_todo.dart'; + +/* SNIPPET START */ +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return ElevatedButton( + onPressed: () { + // Usando "ref.read" combinato con "myProvider.notifier" possiamo + // ottenere l'istanza della classe del nostro notifier. Ciò ci permette di + // chiamare il metodo "addTodo". + ref.read(todoListProvider.notifier).addTodo(Todo(description: 'Questo è un nuovo todo')); + }, + child: const Text('Aggiungi todo'), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart new file mode 100644 index 000000000..9487699de --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart @@ -0,0 +1,37 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // Non ci importa della risposta dell'API + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // Una volta che la richiesta è terminata, possiamo marcare la cache locale come sporca. + // Facendo ciò, il metodo "build" sul nostro notifier verrà chiamato asincronamente di nuovo, + // notificando i suoi listener. + ref.invalidateSelf(); + + // (Opzionale) Possiamo quindi aspettare che il nuovo stato venga computato. + // Questo assicura che "addTodo" non venga completato finchè il nuovo stato non è disponibile. + await future; + } +/* SNIPPET END */ +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart new file mode 100644 index 000000000..e99cff69d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart @@ -0,0 +1,40 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // Non ci importa della risposta dell'API + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // Possiamo quindi aggiornare manualmente la cache locale. Per fare ciò, avremo bisogno + // di ottenere lo stato precedente. + // Attenzione: lo stato precedente potrebbe essere anche in stato di loading o di errore. + // Un modo elegante di gestirlo sarebbe leggere `this.future` invece + // di `this.state`, il che consentirebbe di attendere lo stato di loading e + // generare un errore se lo stato è in uno stato di errore. + final previousState = await future; + + // Possiamo quindi aggiornare lo stato, creando un nuovo oggetto di stato. + // Ciò notificherà i suoi listener. + state = AsyncData([...previousState, todo]); + } +/* SNIPPET END */ +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart new file mode 100644 index 000000000..58e615287 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart @@ -0,0 +1,34 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + // Non ci importa della risposta dell'API + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + /* SNIPPET START */ + final previousState = await future; + // Modifica la lista dei todo in modo mutabile. + previousState.add(todo); + // Notifica manualmente i listener. + ref.notifyListeners(); + /* SNIPPET END */ + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart new file mode 100644 index 000000000..720077e54 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart @@ -0,0 +1,77 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'rest_add_todo.dart'; +import 'todo_list_notifier.dart' show Todo; + +void main() { + runApp( + const ProviderScope(child: MyApp()), + ); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return const MaterialApp(home: Example()); + } +} + +/* SNIPPET START */ +class Example extends ConsumerStatefulWidget { + const Example({super.key}); + + @override + ConsumerState createState() => _ExampleState(); +} + +class _ExampleState extends ConsumerState { + // L'operazione addTodo in sospeso. O null se nessuna è in attesa. + Future? _pendingAddTodo; + + @override + Widget build(BuildContext context) { + return FutureBuilder( + // Ascoltiamo l'operazione in sospeso per aggiornare l'interfaccia utente di conseguenza. + future: _pendingAddTodo, + builder: (context, snapshot) { + // Calcoliamo se c'è uno stato di errore o meno. + // Controlliamo qui lo stato di ConnectionState per gestire quando l'operazione viene ripetuta. + final isErrored = snapshot.hasError && snapshot.connectionState != ConnectionState.waiting; + + return Row( + children: [ + ElevatedButton( + style: ButtonStyle( + // Se c'è stato un errore mostriamo il bottone in rosso + backgroundColor: MaterialStateProperty.all( + isErrored ? Colors.red : null, + ), + ), + onPressed: () { + // Assegniamo il future ritornato da 'addTodo' in una variabile + final future = ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + + // Immagazziniamo il future nello stato locale + setState(() { + _pendingAddTodo = future; + }); + }, + child: const Text('Add todo'), + ), + // L'operazione è in sospeso, mostriamo un indicatore di progresso + if (snapshot.connectionState == ConnectionState.waiting) ...[ + const SizedBox(width: 8), + const CircularProgressIndicator(), + ] + ], + ); + }, + ); + } +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart new file mode 100644 index 000000000..0f4522d09 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart @@ -0,0 +1,68 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'rest_add_todo.dart'; +import 'todo_list_notifier.dart' show Todo; + +void main() { + runApp( + const ProviderScope(child: MyApp()), + ); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return const MaterialApp(home: Example()); + } +} + +/* SNIPPET START */ +class Example extends HookConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // L'operazione addTodo in sospeso. O null se nessuna è in attesa. + final pendingAddTodo = useState?>(null); + + // Ascoltiamo l'operazione in sospeso per aggiornare l'interfaccia utente di conseguenza. + final snapshot = useFuture(pendingAddTodo.value); + + // Calcoliamo se c'è uno stato di errore o meno. + // Controlliamo qui lo stato di ConnectionState per gestire quando l'operazione viene ripetuta. + final isErrored = snapshot.hasError && snapshot.connectionState != ConnectionState.waiting; + + return Row( + children: [ + ElevatedButton( + style: ButtonStyle( + // Se c'è stato un errore mostriamo il bottone in rosso + backgroundColor: MaterialStateProperty.all( + isErrored ? Colors.red : null, + ), + ), + onPressed: () async { + // Assegniamo il future ritornato da 'addTodo' in una variabile + final future = ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + + // Immagazziniamo il future nello stato locale + pendingAddTodo.value = future; + }, + child: const Text('Add todo'), + ), + // L'operazione è in sospeso, mostriamo un indicatore di progresso + if (snapshot.connectionState == ConnectionState.waiting) ...[ + const SizedBox(width: 8), + const CircularProgressIndicator(), + ] + ], + ); + } +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart new file mode 100644 index 000000000..2a70ea672 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart @@ -0,0 +1,38 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // La richiesta POST restituirà una List corrispondente al nuovo stato dell'applicazione + final response = await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // Decodifichiamo la risposta API e la convertiamo in una List + List newTodos = (jsonDecode(response.body) as List) + .cast>() + .map(Todo.fromJson) + .toList(); + + // Aggiorniamo la cache locale per riflettere il nuovo stato. + // Questo notificherà tutti i suoi ascoltatori. + state = AsyncData(newTodos); + } +/* SNIPPET END */ +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart new file mode 100644 index 000000000..d02e936d0 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart @@ -0,0 +1,43 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Todo { + Todo({ + required this.description, + this.completed = false, + }); + + factory Todo.fromJson(Map json) { + return Todo( + description: json['description']! as String, + completed: json['completed']! as bool, + ); + } + + final String description; + final bool completed; + + Map toJson() => { + 'description': description, + 'completed': completed, + }; +} + +/* SNIPPET START */ +// Ora usiamo AsyncNotifierProvider invece di FutureProvider +final todoListProvider = AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +// Usiamo un AsyncNotifier perché la nostra logica è asincrona. +// Più nello specifico, avremo di AutoDisposeAsyncNotifier +// per fruire del modificatore "autoDispose". +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async { + // La logica che in precedenza avevamo nel nostro FutureProvider ora è nel metodo di build. + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart new file mode 100644 index 000000000..581c9fc81 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart @@ -0,0 +1,27 @@ +// ignore_for_file: avoid_print + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +/* SNIPPET START */ +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + await http.post( + Uri.https('your_api.com', '/todos'), + // Serializziamo il nostro oggetto Todo e lo inviamo al server. + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart new file mode 100644 index 000000000..327cc8918 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart @@ -0,0 +1,27 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class Todo { + Todo({ + required this.description, + this.completed = false, + }); + + factory Todo.fromJson(Map json) { + return Todo( + description: json['description'] as String, + completed: json['completed'] as bool, + ); + } + + final String description; + final bool completed; +} + +final todoListProvider = FutureProvider.autoDispose>((ref) async { + // Simula una richiesta di rete. Normalmente il risultato dovrebbe venire da una API reale + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts new file mode 100644 index 000000000..798feb107 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/render_add_todo.dart"; +import hooks from "!!raw-loader!./raw/render_add_todo_hooks.dart"; + +export default { + raw: raw, + hooks: hooks, + codegen: raw, + hooksCodegen: hooks, +}; \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts new file mode 100644 index 000000000..b32ae3b9b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/todo_list_notifier.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_notifier.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts new file mode 100644 index 000000000..62fb0e0fc --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/todo_list_notifier_add_todo.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_notifier_add_todo.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts new file mode 100644 index 000000000..de7789c0b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts @@ -0,0 +1,7 @@ +import raw from "!!raw-loader!./raw/todo_list_provider.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_provider.dart"; + +export default { + raw: raw, + codegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing.mdx new file mode 100644 index 000000000..569e751a7 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing.mdx @@ -0,0 +1,160 @@ +--- +title: Testare i tuoi provider +--- + +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import createContainer from "!!raw-loader!./testing/create_container.dart"; +import unitTest from "!!raw-loader!./testing/unit_test.dart"; +import widgetTest from "!!raw-loader!./testing/widget_test.dart"; +import fullWidgetTest from "!!raw-loader!./testing/full_widget_test.dart"; +import widgetContainerOf from "!!raw-loader!./testing/widget_container_of.dart"; +import providerToMock from "./testing/provider_to_mock"; +import mockProvider from "!!raw-loader!./testing/mock_provider.dart"; +import autoDisposeListen from "!!raw-loader!./testing/auto_dispose_listen.dart"; +import listenProvider from "!!raw-loader!./testing/listen_provider.dart"; +import awaitFuture from "!!raw-loader!./testing/await_future.dart"; +import notifierMock from "./testing/notifier_mock"; + +Una parte fondamentale delle API di Riverpod è l'abilità di testare i tuoi provider in modo isolato. + +Per una suite di test adeguata, ci sono alcune sfide da superare: + +- I test non dovrebbero condividere lo stato. Ciò significa che nuovi test + non dovrebbero essere influenzati dai test precedenti. +- I test dovrebbero darci l'abilità di emulare certe funzionalità + per ottenere lo stato desiderato. +- L'ambiente di test dovrebbe essere il più vicino possibile all'ambiente reale. + +Fortunatamente, Riverpod semplifica il raggiungimento di tutti questi obiettivi. + +## Impostare un test + +Quando si definisce un test con Riverpod, ci sono due scenari principali: + +- Test unitari, di solito senza dipendenze di Flutter. + Possono essere utili per testare il comportamento di un provider isolamente. +- Test di widget, di solito con dipendenze di Flutter. + Possono essere utili per testare il comportamento di un widget che utilizza un provider. + +### Test unitari + +I test unitari sono definit usando la funzione `test` da [package:test](https://pub.dev/packages/test) + +La differenza principale con qualsiasi altro test è che creeremo un oggetto +`ProviderContainer`. Questo oggetto permetterà al nostro test di interagire con i provider + +Si consiglia di creare un'utilità di test sia per la creazione che per l'eliminazione +di un oggetto `ProviderContainer`: + + + +Successivamente, possiamo definire un `test` utilizzando questa utilità: + + + +Ora che abbiamo un ProviderContainer possiamo utilizzarlo per leggere i provider usando: + +- `container.read`, per leggere il valore corrente di un provider. +- `container.listen`, per restare in ascolto di un provider ed essere notificato dei suoi cambiamenti. + +:::caution +Fai attenzione quando usi `container.read` quando i provider sono distrutti automaticamente. +Se il tuo provider non è ascoltato, ci sono chances che il suo stato verrà distrutto nel mezzo +del nostro test. + +In quel caso, considera utilizzare `container.listen`. +Il suo valore di ritorno permette comunque di leggere il valore corrente del provider, +ma si assicurerà anche che il provider non venga distrutto nel mezzo del tuo test: + + +::: + +### Test di widget + +I test dei widget sono definiti usando la funzione `testWidgets` da [package:flutter_test](https://pub.dev/packages/flutter_test). + +In questo caso, la differenza principale con i normali test di widget è che dobbiamo +aggiungere un widget `ProviderScope` alla radice di `tester.pumpWidget`. + + + +Questo è simile a quello che facciamo quando abilitiamo Riverpod nella nostra app Flutter. + +Successivamente, possiamo usare `tester` per interagire col nostro widget. +In alternativa, se vuoi interagire coi tuoi provider, puoi ottenere +un `ProviderContainer`. +Un oggetto `ProviderContainer` può essere ottenuto usando `ProviderScope.containerOf(buildContext)`. +Usando `tester` possiamo quindi scrivere quanto segue: + + + +Possiamo quindi usarlo per leggere i provider. Di seguito un esempio completo: + + + +## Mock/Imitare provider + +Fino ad ora abbiamo visto come impostare un test ed interagire in modo semplice con i provider. +Tuttavia, in alcuni casi, potremmo voler imitare un provider. + +La parte interessante: tutti i provider possono essere imitati di default, senza nessun impostazione aggiuntiva. +Questo è possibile specificando il parametro `overrides` su `ProviderScope` o `ProviderContainer`. + +Consideriamo il provider seguente: + + + +Possiamo imitarlo usando: + + + +## Spiare i cambiamenti in un provider + +Dato che abbiamo ottenuto un `ProviderContainer` nei nostri test, è possibile +usarlo per "ascoltare" un provider: + + + +Puoi combinare questo con pacchetti come [mockito](https://pub.dev/packages/mockito) o +[mocktail](https://pub.dev/packages/mocktail) per usare la loro API `verify`. +O più semplicemente, puoi aggiungere tutti i cambiamenti in una lista e controllarli tramite 'assert'. + +## Aspettare provider asincroni + +In Riverpod è molto comune per i provider restituire un Future/Stream. +In questo caso, ci sono chances che i nostri test abbiano bisogno di aspettare che +quelle operazioni asincrone siano completate. + +Un modo per farlo è leggere il `.future` di un provider: + + + +## Imitare i Notifier + +È generalmente sconsigliato imitare i Notifier. +Invece, dovresti probabilmente introdurre un livello di astrazione nella logica del tuo +Notifier, in modo tale da poter imitare tale astrazione. +Per esempio, al posto di imitare un Notifier, potresti imitare un "repository" +che il Notifier usa per ottenere i dati. + +Se vuoi insistere nell'imitare un Notifier, esiste una considerazione speciale +per creare un mock di questo tipo: il tuo mock deve essere una subclass della classe +base del Notifier: non puoi implementare (via "implements") un Notifier, poichè +romperebbe l'interfaccia. + +Pertanto, quando si imita un Notifier, invece di scrivere il codice mockito seguente: + +```dart +class MyNotifierMock with Mock implements MyNotifier {} +``` + +Dovresti invece scrivere: + + + + + +Per far sì che funzioni, il tuo mock deve essere posto nello stesso file del Notifier +che stai imitando. Altrimenti, non avresti accesso alla classe `_$MyNotifier`. + + diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart new file mode 100644 index 000000000..6d901503b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 'Hello world'); + +void main() { + test('Some description', () { + final container = createContainer(); + /* SNIPPET START */ + final subscription = container.listen(provider, (_, __) {}); + + expect( + // Equivalente di `container.read(provider)` + // Ma il provider non verrà distrutto a meno che "subscription" non venga distrutta. + subscription.read(), + 'Some value', + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart new file mode 100644 index 000000000..060f4c592 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart @@ -0,0 +1,30 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = FutureProvider((_) async => 42); + +void main() { + test('Some description', () async { + // Crea un ProviderContainer per questo test. + // NON condivedere i ProviderContainer tra i vari test. + final container = createContainer(); + + /* SNIPPET START */ + // TODO: usa il container per testare la tua applicazione. + // Il valore atteso è asincrono, quindi dovremmo usare "expectLater" + await expectLater( + // Leggiamo "provider.future" invece di "provider". + // Questo è possibile su provider asincroni e restituisce un future + // che si risolverà con il valore del provider. + container.read(provider.future), + // Possiamo verificare che quel future si risolva con il valore atteso. + // In alternativa possiamo usare "throwsA" per gli errori. + completion('some value'), + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart new file mode 100644 index 000000000..e9441d3b8 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart @@ -0,0 +1,22 @@ +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +/// Un'utilità di test che crea un [ProviderContainer] e lo distrugge automaticamente +/// alla fine del test +ProviderContainer createContainer({ + ProviderContainer? parent, + List overrides = const [], + List? observers, +}) { + // Crea un ProviderContainer, permettendo di specificare dei parametri. + final container = ProviderContainer( + parent: parent, + overrides: overrides, + observers: observers, + ); + + // Alla fine del test, distrugge il container + addTearDown(container.dispose); + + return container; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart new file mode 100644 index 000000000..5b2ee2d94 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart @@ -0,0 +1,33 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +final provider = Provider((_) => 'some value'); + +class YourWidgetYouWantToTest extends StatelessWidget { + const YourWidgetYouWantToTest({super.key}); + + @override + Widget build(BuildContext context) => const Placeholder(); +} + +/* SNIPPET START */ +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + + final element = tester.element(find.byType(YourWidgetYouWantToTest)); + final container = ProviderScope.containerOf(element); + + // TODO interagire con i tuoi provider + expect( + container.read(provider), + 'some value', + ); + }); +} +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart new file mode 100644 index 000000000..d2e840d9b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 'Hello world'); + +void main() { + test('Some description', () { + final container = createContainer(); + /* SNIPPET START */ + container.listen( + provider, + (previous, next) { + print('The provider changed from $previous to $next'); + }, + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart new file mode 100644 index 000000000..0e5b266d2 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart @@ -0,0 +1,45 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +import 'create_container.dart'; +import 'full_widget_test.dart'; +import 'provider_to_mock/raw.dart'; + +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + /* SNIPPET START */ + // Nei test unitari, riutilizzando la nostra precedente utilità "createContainer". + final container = createContainer( + // Possiamo specificare una lista di provider da emulare: + overrides: [ + // In questo caso, stiamo imitando "exampleProvider". + exampleProvider.overrideWith((ref) { + // Questa funzione è la tipica funzione di inizializzazione di un provider. + // Qui è dove normalmente chiamaresti "ref.watch" e restituiresti lo stato iniziale. + + // Sostituiamo il valore di default "Hello world" con un valore custom. + // Infine, quando interagiremo con `exampleProvider`, ci ritornerà questo valore. + return 'Hello from tests'; + }), + ], + ); + + // Possiamo anche fare lo stesso nei test di widget usando ProviderScope: + await tester.pumpWidget( + ProviderScope( + // I ProviderScope hanno lo stesso esatto parametro "overrides" + overrides: [ + // Uguale a prima + exampleProvider.overrideWith((ref) => 'Hello from tests'), + ], + child: const YourWidgetYouWantToTest(), + ), + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart new file mode 100644 index 000000000..84f0fff0b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart @@ -0,0 +1,17 @@ +// ignore_for_file: prefer_mixin + +import 'package:mockito/mockito.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() => throw UnimplementedError(); +} + +// Il tuo mock necessita di subclassare la classe base del Notifier +class MyNotifierMock extends _$MyNotifier with Mock implements MyNotifier {} +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart new file mode 100644 index 000000000..b2d7b9dac --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'912fa35c2296626fc0825bcbcfc6b6c85958be02'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart new file mode 100644 index 000000000..d21cc3d0e --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart @@ -0,0 +1,14 @@ +// ignore_for_file: prefer_mixin + +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:mockito/mockito.dart'; + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() => throw UnimplementedError(); +} + +// Il tuo mock necessita di subclassare la classe base del Notifier +class MyNotifierMock extends Notifier with Mock implements MyNotifier {} +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart new file mode 100644 index 000000000..c03802466 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +// Un provider inizializzato anticipatamente +@riverpod +Future example(ExampleRef ref) async => 'Hello world'; +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart new file mode 100644 index 000000000..dd85f62f9 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeFutureProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart new file mode 100644 index 000000000..b4eb3aaf0 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart @@ -0,0 +1,6 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +// Un provider inizializzato anticipatamente +final exampleProvider = FutureProvider((ref) async => 'Hello world'); +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart new file mode 100644 index 000000000..162c30a72 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 42); + +/* SNIPPET START */ +void main() { + test('Some description', () { + // Crea un ProviderContainer per questo test. + // NON condividere dei ProviderContainer tra i test. + final container = createContainer(); + + // TODO: usare il container per testare la tua applicazione. + expect( + container.read(provider), + equals('some value'), + ); + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart new file mode 100644 index 000000000..61b2ca36b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart @@ -0,0 +1,15 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +import 'widget_test.dart'; + +void main() { + testWidgets('Some description', (tester) async { + /* SNIPPET START */ + final element = tester.element(find.byType(YourWidgetYouWantToTest)); + final container = ProviderScope.containerOf(element); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart new file mode 100644 index 000000000..b4afc835c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +class YourWidgetYouWantToTest extends StatelessWidget { + const YourWidgetYouWantToTest({super.key}); + + @override + Widget build(BuildContext context) => const Placeholder(); +} + +/* SNIPPET START */ +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + }); +} +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx new file mode 100644 index 000000000..9083ed859 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx @@ -0,0 +1,108 @@ +--- +title: Websocket ed esecuzione sincrona +--- + +import { + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; +import syncDefinition from "./websockets_sync/sync_definition"; +import streamProvider from "./websockets_sync/stream_provider"; +import syncConsumer from "!!raw-loader!./websockets_sync/sync_consumer.dart"; +import rawUsage from "!!raw-loader!./websockets_sync/raw_usage.dart"; +import pipeChangeNotifier from "!!raw-loader!./websockets_sync/pipe_change_notifier.dart"; +import sharedPipeChangeNotifier from "!!raw-loader!./websockets_sync/shared_pipe_change_notifier.dart"; +import changeNotifierProvider from "!!raw-loader!./websockets_sync/change_notifier_provider.dart"; + +Fino ad ora abbiamo solo coperto come creare un `Future`. +Abbiamo fatto ciò apposta, dato che i `Future`s sono una parte fondamentale di come +le applicazioni che usano Riverpod dovrebbero essere costruite. +_Ma_, Riverpod supporta anche altri formati se necessario. + +In particolare, invece di un `Future`, i provider sono liberi di: + +- Ritornare in modo sincrono un oggetto, come creare un "Repository". +- Ritornare uno `Stream`, come ascoltare i websocket. + +Restituire un `Future` e restituire uno `Stream` o un oggetto è abbastanza simile nel complesso. +Considera questa pagina come una spiegazione delle sottili differenze e de vari +suggerimenti per questi casi d'uso. + +## Restituire un oggetto in modo sincrono + +Per creare un oggetto in modo sincrono, assicurati che il tuo provider non ritorni un Future: + + + +Quando un provider crea un oggetto in modo sincrono, questo impatta come quell'oggetto verrà consumato. +In particolare, i valori sincroni non sono contenuti in un "AsyncValue": + + + +La conseguenza di questa differenza è che se il tuo provider lancia un'eccezione, +provare a leggere il valore ricauserà l'errore. +In alternativa, quando si usa `ref.listen`, la callback "onError" sarà invocata. + +### Considerazioni sugli oggetti "Listenable" + + + +Gli oggetti Listenable come `ChangeNotifier` or `StateNotifier` non sono supportati. +Se, per motivi di compatibilità, è necessario interagire con uno di questi oggetti, +un workaround consiste nel collegare il loro meccanismo di notifica a Riverpod. + + + +:::info +Nel caso in cui tu abbia bisogno di questa logica molte volte, è importante notare che +la logica è condivisa! L'oggetto "ref" è progettato per essere componibile. +Ciò consente di estrarre la logica di dispose/ascolto dal provider: + + +::: + + + + + +Quando non si utilizza la generazione di codice, Riverpod offre provider "legacy" +per supportare `ChangeNotifier` e `StateNotifier` direttamente: `ChangeNotifierProvider` and `StateNotifierProvider`. +Usarli è simile ad usare altri tipi di provider. La differenza principale è +che entrambi ascolteranno e smaltiranno automaticamente dell'oggetto restituito. + +Questi provider non sono consigliati per nuova logica di business. +Ma possono essere d'aiuto quando si interagisce con codice vecchio, come +durante una migrazione da `pkg:provider` a Riverpod. + + + + + +## Ascoltare uno Stream + +Un caso d'uso comune delle moderne applicazioni è interagire con websockets, +come Firbase o GraphQL subscriptions. +Interagire con queste API è spesso fatto ascoltando uno `Stream`. + +Per aiutarci in tale scopo, Riverpod supporta di natura gli oggetti `Stream`. +Come con i `Future`, l'oggetto verrà convertito in un `AsyncValue`: + + + +:::info +Riverpod non è consapevole delle implementazioni personalizzate di `Stream`, +come ad esempio `BehaviorSubject` di RX. +Pertanto, restituire un `BehaviorSubject` non esporrà il valore +in modo sincrono ai widget, anche se è già disponibile alla creazione. +::: + +Di default, Riverpod convertirà `Stream` e `Future` in `AsyncValue`. +Anche se raramente necessario, è possibile disattivare questo comportamento +wrappando il tipo del valore di ritorno in un typedef `Raw`. + +:::caution +È generalmente sconsigliato disabilitare la conversione in `AsyncValue`. +Fallo solo se sai quello che stai facendo. +::: + + diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart new file mode 100644 index 000000000..ea3859a27 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart @@ -0,0 +1,11 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final myProvider = ChangeNotifierProvider>((ref) { + // Ascolterà ed eliminerà ValueNotifier + // I widget possono quindi "ref.watch" questo provider per ascoltarne gli aggiornamenti. + return ValueNotifier(0); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart new file mode 100644 index 000000000..b030b5dd9 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart @@ -0,0 +1,22 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'pipe_change_notifier.g.dart'; + +/* SNIPPET START */ +/// A provider which creates a ValueNotifier and update its listeners +/// whenever the value changes. +@riverpod +ValueNotifier myListenable(MyListenableRef ref) { + final notifier = ValueNotifier(0); + + // Smaltiamo il notifier quando il provider viene distrutto + ref.onDispose(notifier.dispose); + + // Notifica i listener di questo provider ogni volta che il ValueNotifier si aggiorna. + notifier.addListener(ref.notifyListeners); + + return notifier; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart new file mode 100644 index 000000000..f64dd3222 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -0,0 +1,29 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'pipe_change_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myListenableHash() => r'4cc07df2f47050c4aa761e5467f341ab6c312d09'; + +/// A provider which creates a ValueNotifier and update its listeners +/// whenever the value changes. +/// +/// Copied from [myListenable]. +@ProviderFor(myListenable) +final myListenableProvider = AutoDisposeProvider>.internal( + myListenable, + name: r'myListenableProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myListenableHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef MyListenableRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart new file mode 100644 index 000000000..6a25e47a5 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart @@ -0,0 +1,30 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'raw_usage.g.dart'; + +/* SNIPPET START */ +@riverpod +Raw> rawStream(RawStreamRef ref) { + // "Raw" è un typedef. Non c'è bisogno di wrappare + // il valore di ritorno in un costruttore "Raw". + return const Stream.empty(); +} + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // Il valore non è più convertito in AsyncValue + // e lo stream creato è ritornato come tale. + Stream stream = ref.watch(rawStreamProvider); + return StreamBuilder( + stream: stream, + builder: (context, snapshot) { + return Text('${snapshot.data}'); + }, + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart new file mode 100644 index 000000000..bd06ba4bc --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'raw_usage.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$rawStreamHash() => r'7e7c2e8f4f08d33a4d86d60449e143c419ca4822'; + +/// See also [rawStream]. +@ProviderFor(rawStream) +final rawStreamProvider = AutoDisposeProvider>>.internal( + rawStream, + name: r'rawStreamProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$rawStreamHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef RawStreamRef = AutoDisposeProviderRef>>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart new file mode 100644 index 000000000..fa41ad22e --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart @@ -0,0 +1,29 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'shared_pipe_change_notifier.g.dart'; + +/* SNIPPET START */ +extension on Ref { + // Possiamo spostare la logica precedente in una estensione Ref. + // Questo abilita il riutilizzo della logica + T disposeAndListenChangeNotifier(T notifier) { + onDispose(notifier.dispose); + notifier.addListener(notifyListeners); + // Restituiamo il notifier per facilitarne di un poco l'utilizzo + return notifier; + } +} + +@riverpod +ValueNotifier myListenable(MyListenableRef ref) { + return ref.disposeAndListenChangeNotifier(ValueNotifier(0)); +} + +@riverpod +ValueNotifier anotherListenable(AnotherListenableRef ref) { + return ref.disposeAndListenChangeNotifier(ValueNotifier(42)); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart new file mode 100644 index 000000000..fbc40c61b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -0,0 +1,42 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'shared_pipe_change_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myListenableHash() => r'7096094cd24ed50dbabb9fb9ab64b340176c04bf'; + +/// See also [myListenable]. +@ProviderFor(myListenable) +final myListenableProvider = AutoDisposeProvider>.internal( + myListenable, + name: r'myListenableProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myListenableHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef MyListenableRef = AutoDisposeProviderRef>; +String _$anotherListenableHash() => r'38bfe5dbf5f148819b3671ad69d15c8e05264c23'; + +/// See also [anotherListenable]. +@ProviderFor(anotherListenable) +final anotherListenableProvider = + AutoDisposeProvider>.internal( + anotherListenable, + name: r'anotherListenableProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$anotherListenableHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef AnotherListenableRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart new file mode 100644 index 000000000..0a1030247 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart @@ -0,0 +1,34 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Stream streamExample(StreamExampleRef ref) async* { + // Ogni secondo ritorna un numero da 0 a 41. + // Questo può essere sostituito con uno Stream da Firestore o GraphQL o altro. + for (var i = 0; i < 42; i++) { + yield i; + await Future.delayed(const Duration(seconds: 1)); + } +} + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // Lo stream è ascoltato e convertito in un AsyncValue + AsyncValue value = ref.watch(streamExampleProvider); + + // Possiamo usare l'AsyncValue per gestire i stati di caricamento/errore e mostrare il dato. + return switch (value) { + AsyncValue(:final error?) => Text('Error: $error'), + AsyncValue(:final valueOrNull?) => Text('$valueOrNull'), + _ => const CircularProgressIndicator(), + }; + } +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart new file mode 100644 index 000000000..b8ef976c4 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$streamExampleHash() => r'ca9993b22f6d587b20c041133cacd28d01933074'; + +/// See also [streamExample]. +@ProviderFor(streamExample) +final streamExampleProvider = AutoDisposeStreamProvider.internal( + streamExample, + name: r'streamExampleProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$streamExampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef StreamExampleRef = AutoDisposeStreamProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts new file mode 100644 index 000000000..4ee159de8 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts @@ -0,0 +1,4 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { raw, codegen }; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart new file mode 100644 index 000000000..07ee676d2 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart @@ -0,0 +1,30 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final streamExampleProvider = StreamProvider.autoDispose((ref) async* { + // Ogni secondo ritorna un numero da 0 a 41. + // Questo può essere sostituito con uno Stream da Firestore o GraphQL o altro. + for (var i = 0; i < 42; i++) { + yield i; + await Future.delayed(const Duration(seconds: 1)); + } +}); + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // Lo stream è ascoltato e convertito in un AsyncValue + AsyncValue value = ref.watch(streamExampleProvider); + + // Possiamo usare l'AsyncValue per gestire i stati di caricamento/errore e mostrare il dato. + return switch (value) { + AsyncValue(:final error?) => Text('Error: $error'), + AsyncValue(:final valueOrNull?) => Text('$valueOrNull'), + _ => const CircularProgressIndicator(), + }; + } +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart new file mode 100644 index 000000000..bf4aa03f7 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart @@ -0,0 +1,19 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'sync_definition/raw.dart'; + +void main() { +/* SNIPPET START */ + Consumer( + builder: (context, ref, child) { + // Il valore non è contenuto in un "AsyncValue" + int value = ref.watch(synchronousExampleProvider); + + return Text('$value'); + }, + ); +/* SNIPPET END */ +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart new file mode 100644 index 000000000..b18b8f76e --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart @@ -0,0 +1,10 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +int synchronousExample(SynchronousExampleRef ref) { + return 0; +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart new file mode 100644 index 000000000..ef1015d6e --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -0,0 +1,28 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$synchronousExampleHash() => + r'98df96e07d554683041f668c06b36f183ff534c1'; + +/// See also [synchronousExample]. +@ProviderFor(synchronousExample) +final synchronousExampleProvider = AutoDisposeProvider.internal( + synchronousExample, + name: r'synchronousExampleProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$synchronousExampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef SynchronousExampleRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts new file mode 100644 index 000000000..4ee159de8 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts @@ -0,0 +1,4 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { raw, codegen }; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart new file mode 100644 index 000000000..9c64294a0 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart @@ -0,0 +1,7 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +final synchronousExampleProvider = Provider.autoDispose((ref) { + return 0; +}); +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.dart new file mode 100644 index 000000000..4d49c552a --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.dart @@ -0,0 +1,11 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family.g.dart'; +/* SNIPPET START */ + +@riverpod +int random(RandomRef ref, {required int seed, required int max}) { + return Random(seed).nextInt(max); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart new file mode 100644 index 000000000..3e39394a5 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart @@ -0,0 +1,222 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$randomHash() => r'517b12aad4df7b31f8872b89af74e7880377b2ea'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [random]. +@ProviderFor(random) +const randomProvider = RandomFamily(); + +/// See also [random]. +class RandomFamily extends Family { + /// See also [random]. + const RandomFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'randomProvider'; + + /// See also [random]. + RandomProvider call({ + required int seed, + required int max, + }) { + return RandomProvider( + seed: seed, + max: max, + ); + } + + @visibleForOverriding + @override + RandomProvider getProviderOverride( + covariant RandomProvider provider, + ) { + return call( + seed: provider.seed, + max: provider.max, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(int Function(RandomRef ref) create) { + return _$RandomFamilyOverride(this, create); + } +} + +class _$RandomFamilyOverride implements FamilyOverride { + _$RandomFamilyOverride(this.overriddenFamily, this.create); + + final int Function(RandomRef ref) create; + + @override + final RandomFamily overriddenFamily; + + @override + RandomProvider getProviderOverride( + covariant RandomProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [random]. +class RandomProvider extends AutoDisposeProvider { + /// See also [random]. + RandomProvider({ + required int seed, + required int max, + }) : this._internal( + (ref) => random( + ref as RandomRef, + seed: seed, + max: max, + ), + from: randomProvider, + name: r'randomProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$randomHash, + dependencies: RandomFamily._dependencies, + allTransitiveDependencies: RandomFamily._allTransitiveDependencies, + seed: seed, + max: max, + ); + + RandomProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.seed, + required this.max, + }) : super.internal(); + + final int seed; + final int max; + + @override + Override overrideWith( + int Function(RandomRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: RandomProvider._internal( + (ref) => create(ref as RandomRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + seed: seed, + max: max, + ), + ); + } + + @override + ({ + int seed, + int max, + }) get argument { + return ( + seed: seed, + max: max, + ); + } + + @override + AutoDisposeProviderElement createElement() { + return _RandomProviderElement(this); + } + + RandomProvider _copyWith( + int Function(RandomRef ref) create, + ) { + return RandomProvider._internal( + (ref) => create(ref as RandomRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + seed: seed, + max: max, + ); + } + + @override + bool operator ==(Object other) { + return other is RandomProvider && other.seed == seed && other.max == max; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, seed.hashCode); + hash = _SystemHash.combine(hash, max.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin RandomRef on AutoDisposeProviderRef { + /// The parameter `seed` of this provider. + int get seed; + + /// The parameter `max` of this provider. + int get max; +} + +class _RandomProviderElement extends AutoDisposeProviderElement + with RandomRef { + _RandomProviderElement(super.provider); + + @override + int get seed => (origin as RandomProvider).seed; + @override + int get max => (origin as RandomProvider).max; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx new file mode 100644 index 000000000..fa391f61a --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./family.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart new file mode 100644 index 000000000..68b84d40d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart @@ -0,0 +1,27 @@ +import 'dart:math'; + +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@immutable +abstract class Equatable { + const Equatable(); + + List get props; +} + +/* SNIPPET START */ +class ParamsType extends Equatable { + const ParamsType({required this.seed, required this.max}); + + final int seed; + final int max; + + @override + List get props => [seed, max]; +} + +final randomProvider = + Provider.family.autoDispose((ref, params) { + return Random(params.seed).nextInt(params.max); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart new file mode 100644 index 000000000..1082ef6f3 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart @@ -0,0 +1,12 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; + +import 'json.dart'; + +part 'item.freezed.dart'; +part 'item.g.dart'; + +@freezed +class Item with _$Item { + const factory Item({required int id}) = _Item; + factory Item.fromJson(Json json) => _$ItemFromJson(json); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart new file mode 100644 index 000000000..e578c8154 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart @@ -0,0 +1,146 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'item.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Item _$ItemFromJson(Map json) { + return _Item.fromJson(json); +} + +/// @nodoc +mixin _$Item { + int get id => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ItemCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ItemCopyWith<$Res> { + factory $ItemCopyWith(Item value, $Res Function(Item) then) = + _$ItemCopyWithImpl<$Res, Item>; + @useResult + $Res call({int id}); +} + +/// @nodoc +class _$ItemCopyWithImpl<$Res, $Val extends Item> + implements $ItemCopyWith<$Res> { + _$ItemCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as int, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ItemImplCopyWith<$Res> implements $ItemCopyWith<$Res> { + factory _$$ItemImplCopyWith( + _$ItemImpl value, $Res Function(_$ItemImpl) then) = + __$$ItemImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({int id}); +} + +/// @nodoc +class __$$ItemImplCopyWithImpl<$Res> + extends _$ItemCopyWithImpl<$Res, _$ItemImpl> + implements _$$ItemImplCopyWith<$Res> { + __$$ItemImplCopyWithImpl(_$ItemImpl _value, $Res Function(_$ItemImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + }) { + return _then(_$ItemImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as int, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ItemImpl implements _Item { + const _$ItemImpl({required this.id}); + + factory _$ItemImpl.fromJson(Map json) => + _$$ItemImplFromJson(json); + + @override + final int id; + + @override + String toString() { + return 'Item(id: $id)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ItemImpl && + (identical(other.id, id) || other.id == id)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, id); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ItemImplCopyWith<_$ItemImpl> get copyWith => + __$$ItemImplCopyWithImpl<_$ItemImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ItemImplToJson( + this, + ); + } +} + +abstract class _Item implements Item { + const factory _Item({required final int id}) = _$ItemImpl; + + factory _Item.fromJson(Map json) = _$ItemImpl.fromJson; + + @override + int get id; + @override + @JsonKey(ignore: true) + _$$ItemImplCopyWith<_$ItemImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart new file mode 100644 index 000000000..3c653e18c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart @@ -0,0 +1,18 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'item.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ItemImpl _$$ItemImplFromJson(Map json) => _$ItemImpl( + id: json['id'] as int, + ); + +Map _$$ItemImplToJson(_$ItemImpl instance) => + { + 'id': instance.id, + }; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart new file mode 100644 index 000000000..17cfb1c01 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart @@ -0,0 +1 @@ +typedef Json = Map; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart new file mode 100644 index 000000000..802a23150 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart @@ -0,0 +1,29 @@ +import 'package:collection/collection.dart'; +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; +import '../../helpers/json.dart'; + +part 'async_values.g.dart'; + +/* SNIPPET START */ + +@riverpod +Future> itemsApi(ItemsApiRef ref) async { + final client = Dio(); + final result = await client.get>('your-favorite-api'); + final parsed = [...result.data!.map((e) => Item.fromJson(e as Json))]; + return parsed; +} + +@riverpod +List evenItems(EvenItemsRef ref) { + final asyncValue = ref.watch(itemsApiProvider); + if (asyncValue.isReloading) return []; + if (asyncValue.hasError) return const [Item(id: -1)]; + + final items = asyncValue.requireValue; + + return [...items.whereIndexed((index, element) => index.isEven)]; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart new file mode 100644 index 000000000..0765d3a65 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_values.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$itemsApiHash() => r'b32ccb7b85305e361d8ed752cbe11d9524c96190'; + +/// See also [itemsApi]. +@ProviderFor(itemsApi) +final itemsApiProvider = AutoDisposeFutureProvider>.internal( + itemsApi, + name: r'itemsApiProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$itemsApiHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ItemsApiRef = AutoDisposeFutureProviderRef>; +String _$evenItemsHash() => r'55ae98f9b6108203dfc4a139f1ade9fbd8ba8ddd'; + +/// See also [evenItems]. +@ProviderFor(evenItems) +final evenItemsProvider = AutoDisposeProvider>.internal( + evenItems, + name: r'evenItemsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$evenItemsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef EvenItemsRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx new file mode 100644 index 000000000..526f2dffe --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./async_values.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart new file mode 100644 index 000000000..1ca8987ef --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart @@ -0,0 +1,25 @@ +import 'package:collection/collection.dart'; +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; +import '../../helpers/json.dart'; + +/* SNIPPET START */ + +final itemsApiProvider = FutureProvider.autoDispose((ref) async { + final client = Dio(); + final result = await client.get>('your-favorite-api'); + final parsed = [...result.data!.map((e) => Item.fromJson(e as Json))]; + return parsed; +}); + +final evenItemsProvider = Provider.autoDispose((ref) { + final asyncValue = ref.watch(itemsApiProvider); + if (asyncValue.isLoading) return []; + if (asyncValue.hasError) return const [Item(id: -1)]; + + final items = asyncValue.requireValue; + + return [...items.whereIndexed((index, element) => index.isEven)]; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart new file mode 100644 index 000000000..079e29de2 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart @@ -0,0 +1,28 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'auto_dispose.g.dart'; + +/* SNIPPET START */ + +// Con la generazione di codice, un provider è .autoDispose di default +@riverpod +int diceRoll(DiceRollRef ref) { + // Poiché questo provider è .autoDispose, smettere di ascoltarlo ne disporrà lo stato esposto attuale. + // Quindi, ogni volta che questo provider viene ascoltato di nuovo, + // verrà tirato un nuovo dado e lo stato verrà esposto di nuovo. + final dice = Random().nextInt(10); + return dice; +} + +@riverpod +int cachedDiceRoll(CachedDiceRollRef ref) { + final coin = Random().nextInt(10); + if (coin > 5) throw Exception('Way too large.'); + // La condizione sopra potrebbe fallire; + // Se non lo fa, l'istruzione seguente dice al Provider + // di mantenere il suo stato in cache, *anche quando nessuno lo ascolta più*. + ref.keepAlive(); + return coin; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart new file mode 100644 index 000000000..9397a920f --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -0,0 +1,41 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'auto_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$diceRollHash() => r'dfd5ac8b74351a0076da9d131c10277f53ff11b9'; + +/// See also [diceRoll]. +@ProviderFor(diceRoll) +final diceRollProvider = AutoDisposeProvider.internal( + diceRoll, + name: r'diceRollProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$diceRollHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef DiceRollRef = AutoDisposeProviderRef; +String _$cachedDiceRollHash() => r'fc31fcb804f10360d75362e56329976343ee7abb'; + +/// See also [cachedDiceRoll]. +@ProviderFor(cachedDiceRoll) +final cachedDiceRollProvider = AutoDisposeProvider.internal( + cachedDiceRoll, + name: r'cachedDiceRollProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$cachedDiceRollHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CachedDiceRollRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx new file mode 100644 index 000000000..6c57cfffd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./auto_dispose.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart new file mode 100644 index 000000000..4847d18d4 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart @@ -0,0 +1,23 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ + +final diceRollProvider = Provider.autoDispose((ref) { + // Poiché questo provider è .autoDispose, smettere di ascoltarlo ne disporrà lo stato esposto attuale. + // Quindi, ogni volta che questo provider viene ascoltato di nuovo, + // verrà tirato un nuovo dado e lo stato verrà esposto di nuovo. + final dice = Random().nextInt(10); + return dice.isEven; +}); + +final cachedDiceRollProvider = Provider.autoDispose((ref) { + final coin = Random().nextInt(10); + if (coin > 5) throw Exception('Way too large.'); + // La condizione sopra potrebbe fallire; + // Se non lo fa, l'istruzione seguente dice al Provider + // di mantenere il suo stato in cache, *anche quando nessuno lo ascolta più*. + ref.keepAlive(); + return coin.isEven; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart new file mode 100644 index 000000000..ecd1915da --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart @@ -0,0 +1,19 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'combine.g.dart'; + +/* SNIPPET START */ + +@riverpod +int number(NumberRef ref) { + return Random().nextInt(10); +} + +@riverpod +int doubled(DoubledRef ref) { + final number = ref.watch(numberProvider); + + return number * 2; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart new file mode 100644 index 000000000..501f580ef --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'combine.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$numberHash() => r'725e25be57b9cc2bd914752f156e26a214596b63'; + +/// See also [number]. +@ProviderFor(number) +final numberProvider = AutoDisposeProvider.internal( + number, + name: r'numberProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$numberHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef NumberRef = AutoDisposeProviderRef; +String _$doubledHash() => r'ddc640c876bdbe49fe72fe1632b5ff48687c9279'; + +/// See also [doubled]. +@ProviderFor(doubled) +final doubledProvider = AutoDisposeProvider.internal( + doubled, + name: r'doubledProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$doubledHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef DoubledRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx new file mode 100644 index 000000000..2ff7dfbaa --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./combine.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart new file mode 100644 index 000000000..ad33636e7 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart @@ -0,0 +1,15 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ + +final numberProvider = Provider.autoDispose((ref) { + return Random().nextInt(10); +}); + +final doubledProvider = Provider.autoDispose((ref) { + final number = ref.watch(numberProvider); + + return number * 2; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx new file mode 100644 index 000000000..aadb58d49 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx @@ -0,0 +1,189 @@ +--- +title: Motivazione +--- + +import sameType from "./same_type"; +import combine from "./combine"; +import asyncValues from "./async_values"; +import autoDispose from "./auto_dispose"; +import override from "./override"; +import sideEffects from "./side_effects"; +import { + AutoSnippet, +} from "../../../../../../src/components/CodeSnippet"; + +Questo articolo dettagliato è pensato per spiegare perché Riverpod esiste. + +In particolare, questa sezione dovrebbe rispondere alle seguenti domande: +- Dato che Provider è ampiamente popolare, perché si dovrebbe migrare a Riverpod? +- Quali vantaggi concreti si ottengono? +- Come posso migrare a Riverpod? +- Posso migrare in modo incrementale? +- ecc. + +Alla fine di questa sezione dovresti essere convinto che Riverpod è da preferire rispetto a Provider. + +**Riverpod è davvero un approccio più moderno, raccomandato e affidabile rispetto a Provider**. + +Riverpod offre migliori capacità di gestione dello stato, migliori strategie di caching e un modello di reattività semplificato. +Mentre Provider attualmente presenta molte carenze senza una via d'uscita. + +## Limitazioni di Provider +Provider ha problemi fondamentali dovuti alla restrizione dell'API di InheritedWidget. +Intrinsecamente, Provider è un "`InheritedWidget` più semplice"; +Provider è solo un wrapper di InheritedWidget, ed è quindi limitato da esso. + +Ecco un elenco di problemi noti di Provider. + +### Provider non può gestire due (o più) provider dello stesso "tipo". +Dichiarare due `Provider` porterà a un comportamento non affidabile: l'API di `InheritedWidget` +otterrà solo *uno dei due*: l'antenato `Provider` più vicino. +Sebbene [un workaround] sia spiegato nella documentazione di Provider, Riverpod semplicemente non presenta questo problema. + +Eliminando questa limitazione, possiamo suddividere liberamente la logica in piccole parti, come segue: + + + +### I provider emettono ragionevolmente solo un valore alla volta +Quando si legge un'API esterna RESTful, è abbastanza comune mostrare l'ultimo valore letto +mentre una nuova chiamata carica il successivo. +Riverpod consente questo comportamento emettendo due valori contemporaneamente (ossia un valore di dati precedenti +e un nuovo valore di caricamento in arrivo) tramite le API di `AsyncValue`: + + + +Nello snippet precedente, osservando `evenItemsProvider` si avranno i seguenti effetti: +1. Inizialmente, viene effettuata la richiesta. Otteniamo una lista vuota; +2. Poi, diciamo che si verifica un errore. Otteniamo `[Item(id: -1)]`; +3. Quindi, riproviamo la richiesta con una logica di pull-to-refresh (ad esempio tramite `ref.invalidate`); +4. Mentre ricarichiamo il primo provider, il secondo continua a esporre `[Item(id: -1)]`; +5. Questa volta, alcuni dati processati vengono ricevuti correttamente: i nostri elementi pari vengono restituiti correttamente. + +Con Provider, le caratteristiche sopra menzionate non sono lontanamente realizzabili, e ancor meno facili da aggirare. + +### Combinare i provider è difficile e soggetto a errori +Con Provider potremmo essere tentati di utilizzare `context.watch` all'interno del metodo `create` del provider. +Questo sarebbe inaffidabile, poiché `didChangeDependencies` potrebbe essere attivato anche se nessuna dipendenza +è cambiata (ad esempio quando è coinvolta una GlobalKey nell'albero dei widget). + +Tuttavia, Provider ha una soluzione ad hoc chiamata ProxyProvider, ma è considerata tediosa e soggetta a errori. + +La combinazione dello stato è un meccanismo fondamentale di Riverpod, poiché possiamo combinare e memorizzare +valori reattivamente senza alcun overhead con utilità semplici ma potenti come [ref.watch] e [ref.listen]: + + + +La combinazione dei valori viene naturale con Riverpod: le dipendenze sono leggibili e le API rimangono le stesse. + +### Mancanza di sicurezza +Con Provider, è comune trovarsi con un'eccezione in fase di esecuzione come `ProviderNotFoundException` durante +ristrutturazioni e/o durante modifiche importanti. +Questa eccezione in fase di esecuzione *era* una delle principali ragioni per cui Riverpod è stato creato in primo luogo. + +Anche se Riverpod offre molte altre funzionalità, semplicemente non può generare questa eccezione. + +### La distruzione dello stato è difficile +`InheritedWidget` [non può reagire quando un consumatore smette di ascoltarlo]. +Questo impedisce a Provider di distruggere automaticamente lo stato dei suoi provider quando non vengono più utilizzati. +Con Provider, [dobbiamo] fare affidamento sulla creazione di provider per eliminare lo stato quando +smette di essere utilizzato. +Ma questo non è facile, soprattutto quando lo stato è condiviso tra le pagine. + +Riverpod risolve questo problema con API facili da capire come [autodispose] e [keepAlive]. +Queste due API consentono strategie di caching flessibili e creative (ad esempio, caching basato sul tempo): + + + +Sfortunatamente, non c'è modo di implementare questo con un `InheritedWidget` grezzo e quindi con Provider. + +### Mancanza di un meccanismo di parametrizzazione affidabile +Riverpod consente all'utente di dichiarare provider "parametrizzati" con il [modificatore .family]. +Infatti, `.family` è una delle caratteristiche più potenti di Riverpod ed è fondamentale per le sue innovazioni, +ad esempio consente un'enorme [semplificazione della logica]. + +Se volessimo implementare qualcosa di simile utilizzando Provider, +dovremmo rinunciare alla facilità d'uso *e* alla sicurezza dei tipi su tali parametri. + +Inoltre, non poter implementare un meccanismo simile a `.autoDispose` con Provider +impedisce intrinsecamente la possibilità di una implementazione equivalente di `.family`, [poiché queste due funzionalità vanno di pari passo]. + +Infine, come mostrato in precedenza, [risulta che] i widget *non smettono mai* di ascoltare un `InheritedWidget`. +Ciò comporta gravi perdite di memoria se lo stato di alcuni provider viene "montato dinamicamente", +ossia quando si utilizzano parametri per creare un Provider, che è esattamente ciò che fa `.family`. +Pertanto, ottenere un equivalente di `.family` per Provider è fondamentalmente impossibile al momento. + +### Testare è tedioso +Per poter scrivere un test, *è necessario* ridefinire i provider all'interno di ogni test. + +Con Riverpod, i provider sono pronti per essere utilizzati all'interno dei test di default. +Inoltre, Riverpod espone una pratica collezione di utilità di "sovrascrittura" che sono cruciali quando si simulano i provider. + +Testare il codice dello stato combinato sarebbe semplice come segue: + + + +Per più informazioni riguardo ai test, vedere [Testing]. + +### Attivare effetti collaterali non è immediato +Poiché `InheritedWidget` non ha un callback `onChange`, Provider non può averne uno. +Questo è problematico per la navigazione, ad esempio per le snack bar, le modali, ecc. + +Invece, Riverpod offre semplicemente `ref.listen`, che [si integra bene con Flutter]. + + + +## Verso Riverpod +Dal punto di vista concettuale, Riverpod e Provider sono abbastanza simili. +Entrambi i pacchetti svolgono un ruolo simile. Entrambi cercano di: + +- memorizzare nella cache e smaltire oggetti con dello stato; +- offrire un modo per emulare tali oggetti durante i test; +- offrire un modo per i widget di ascoltare tali oggetti in modo semplice. + +Puoi pensare a Riverpod come a ciò che Provider avrebbe potuto diventare se fosse continuato a maturare per alcuni anni. + +### Perché un package separato? +Originariamente, era previsto un importante aggiornamento di Provider come soluzione ai problemi sopra menzionati. +Tuttavia, in seguito si è deciso di non farlo, poiché sarebbe stato "troppo incisivo" e persino controverso, +a causa della nuova API `ConsumerWidget`. +Poiché Provider è ancora uno dei pacchetti Flutter più utilizzati, è stato invece deciso +di creare un package separato, e così è nato Riverpod. + +La creazione di un package separato ha permesso: + - Una facilità di migrazione per chiunque voglia farlo, consentendo anche l'uso temporaneo di entrambi gli approcci, *nello stesso momento*; + - Di permettere alle persone di rimanere fedeli a Provider se non gradiscono Riverpod in principio o se non lo trovano ancora affidabile; + - Sperimentazione, consentendo a Riverpod di cercare soluzioni production-ready alle varie limitazioni tecniche di Provider. + +Infatti, Riverpod è progettato per essere il successore spirituale di Provider. Da qui il nome "Riverpod" (che è un anagramma di "Provider"). + +### La breaking change +L'unico vero svantaggio di Riverpod è che richiede la modifica del tipo di widget per funzionare: + +- Invece di estendere `StatelessWidget`, con Riverpod dovresti estendere `ConsumerWidget`. +- Invece di estendere `StatefulWidget`, con Riverpod dovresti estendere `ConsumerStatefulWidget`. + +Ma questa inconvenienza è piuttosto minore nel quadro generale. E questa richiesta potrebbe, un giorno, scomparire. + +### Scegliere la liberia giusta +Probabilmente ti stai chiedendo: +*"Quindi, come utente di Provider, dovrei usare Provider o Riverpod?"*. + +Vogliamo rispondere a questa domanda in modo molto chiaro: + + Probabilmente dovresti utilizzare Riverpod + +Riverpod è globalmente meglio progettato e potrebbe portare a semplificazioni drastiche della tua logica. + +[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider +[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[autodispose]: /docs/concepts/modifiers/auto_dispose +[workaround]: https://pub.dev/packages/provider#can-i-obtain-two-different-providers-using-the-same-type +[modifier .family]: /docs/concepts/modifiers/family +[keepAlive]: /docs/concepts/modifiers/auto_dispose#refkeepalive +[poiché queste due funzionalità vanno di pari passo]: /docs/concepts/modifiers/family#prefer-using-autodispose-when-the-parameter-is-not-constant +[semplificazione della logica]: /docs/concepts/modifiers/family#usage +[dobbiamo]: https://github.com/flutter/flutter/issues/128432 +[risulta che]: https://github.com/flutter/flutter/issues/106549 +[non può reagire quando un consumatore smette di ascoltarlo]: https://github.com/flutter/flutter/issues/106546 +[Testing]: /docs/cookbooks/testing +[si integra bene con Flutter]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx new file mode 100644 index 000000000..43ec56b51 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./override.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart new file mode 100644 index 000000000..860020903 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart @@ -0,0 +1,16 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../combine/combine.dart'; + +/* SNIPPET START */ + +void main() { + test('it doubles the value correctly', () async { + final container = ProviderContainer( + overrides: [numberProvider.overrideWith((ref) => 9)], + ); + final doubled = container.read(doubledProvider); + expect(doubled, 9 * 2); + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart new file mode 100644 index 000000000..860020903 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart @@ -0,0 +1,16 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../combine/combine.dart'; + +/* SNIPPET START */ + +void main() { + test('it doubles the value correctly', () async { + final container = ProviderContainer( + overrides: [numberProvider.overrideWith((ref) => 9)], + ); + final doubled = container.read(doubledProvider); + expect(doubled, 9 * 2); + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx new file mode 100644 index 000000000..8569e8316 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./same_type.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart new file mode 100644 index 000000000..dacfe9b9d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart @@ -0,0 +1,15 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; + +/* SNIPPET START */ + +final itemsProvider = Provider.autoDispose( + (ref) => [], // ... +); + +final evenItemsProvider = Provider.autoDispose((ref) { + final items = ref.watch(itemsProvider); + return [...items.whereIndexed((index, element) => index.isEven)]; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart new file mode 100644 index 000000000..94a4ab086 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart @@ -0,0 +1,19 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; + +part 'same_type.g.dart'; + +/* SNIPPET START */ + +@riverpod +List items(ItemsRef ref) { + return []; // ... +} + +@riverpod +List evenItems(EvenItemsRef ref) { + final items = ref.watch(itemsProvider); + return [...items.whereIndexed((index, element) => index.isEven)]; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart new file mode 100644 index 000000000..e421d5b6d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'same_type.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$itemsHash() => r'f0a8fa6874f4868db9ead31e82c75d976f9d2033'; + +/// See also [items]. +@ProviderFor(items) +final itemsProvider = AutoDisposeProvider>.internal( + items, + name: r'itemsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$itemsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ItemsRef = AutoDisposeProviderRef>; +String _$evenItemsHash() => r'82b4525e91604745f2b4664531b32d4aff5717d4'; + +/// See also [evenItems]. +@ProviderFor(evenItems) +final evenItemsProvider = AutoDisposeProvider>.internal( + evenItems, + name: r'evenItemsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$evenItemsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef EvenItemsRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx new file mode 100644 index 000000000..f4797a94f --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./side_effects.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart new file mode 100644 index 000000000..61f016870 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart @@ -0,0 +1,24 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../auto_dispose/auto_dispose.dart'; + +/* SNIPPET START */ + +class DiceRollWidget extends ConsumerWidget { + const DiceRollWidget({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(diceRollProvider, (previous, next) { + ScaffoldMessenger.of(context).showSnackBar( + SnackBar(content: Text('Dice roll! We got: $next')), + ); + }); + return TextButton.icon( + onPressed: () => ref.invalidate(diceRollProvider), + icon: const Icon(Icons.casino), + label: const Text('Roll a dice'), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart new file mode 100644 index 000000000..61f016870 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart @@ -0,0 +1,24 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../auto_dispose/auto_dispose.dart'; + +/* SNIPPET START */ + +class DiceRollWidget extends ConsumerWidget { + const DiceRollWidget({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(diceRollProvider, (previous, next) { + ScaffoldMessenger.of(context).showSnackBar( + SnackBar(content: Text('Dice roll! We got: $next')), + ); + }); + return TextButton.icon( + onPressed: () => ref.invalidate(diceRollProvider), + icon: const Icon(Icons.casino), + label: const Text('Roll a dice'), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx new file mode 100644 index 000000000..dff3aaa22 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx @@ -0,0 +1,401 @@ +--- +title: Provider vs Riverpod +--- + +import family from "./family"; +import { + AutoSnippet, +} from "../../../../../src/components/CodeSnippet"; + +Questo articolo riepiloga le differenze e le somiglianze tra Provider e Riverpod. + +## Definire i provider +La differenza principale tra entrambi i package riguarda come vengono definiti i "provider". + +Con [Provider], i provider sono widget e, come tali, vengono inseriti all'interno dell'albero dei widget, +di solito all'interno di un `MultiProvider`: + +```dart +class Counter extends ChangeNotifier { + ... +} + +void main() { + runApp( + MultiProvider( + providers: [ + ChangeNotifierProvider(create: (context) => Counter()), + ], + child: MyApp(), + ) + ); +} +``` + +Con Riverpod, i provider **non** sono widget. Invece, sono semplici oggetti Dart. +Allo stesso modo, i provider sono definiti al di fuori dell'albero dei widget e +vengono dichiarati come variabili finali globali. + +Inoltre, affinché Riverpod funzioni, è necessario aggiungere un widget `ProviderScope` sopra l'intera applicazione. +Di conseguenza, l'equivalente dell'esempio con Provider utilizzando Riverpod sarebbe: + +```dart +// I provider sono ora variabili top-level +final counterProvider = ChangeNotifierProvider((ref) => Counter()); + +void main() { + runApp( + // Questo widget attiva Riverpod sull'intero progetto + ProviderScope( + child: MyApp(), + ), + ); +} +``` + +Nota come la definizione del provider si sia semplicemente spostata di alcune righe. + +:::info +Poiché con Riverpod i provider sono semplici oggetti Dart, è possibile utilizzare Riverpod senza Flutter. +Ad esempio, Riverpod può essere utilizzato per scrivere applicazioni a riga di comando. +::: + +## Leggere i provider: BuildContext +Con Provider, un modo per leggere i provider è utilizzare il `BuildContext` di un widget. + +Ad esempio, se un provider è definito come: + +```dart +Provider(...); +``` + +il modo per leggerlo con [Provider] sarà scritto come + +```dart +class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + Model model = context.watch(); + + } +} +``` + +L'equivalente in Riverpod sarebbe: + +```dart +final modelProvider = Provider(...); + +class Example extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + Model model = ref.watch(modelProvider); + + } +} +``` + +Nota come: + +- Lo snippet di Riverpod estende `ConsumerWidget` invece di `StatelessWidget`. + Questo tipo di widget aggiunge un parametro in più alla nostra funzione `build`: `WidgetRef`. + +- Invece di `BuildContext.watch`, in Riverpod scriveremo `WidgetRef.watch`, utilizzando il `WidgetRef` + che abbiamo ottenuto da `ConsumerWidget`. + +- Riverpod non si basa sui tipi generici. Si basa invece sulla variabile creata utilizzando la definizione del provider. + +Nota anche quanto simile sia la terminologia. Sia Provider che Riverpod utilizzano la parola chiave "watch" +per descrivere "questo widget dovrebbe essere ricostruito quando il valore cambia". + +:::info +Riverpod utilizza la stessa terminologia di Provider per la lettura dei provider. + +- `BuildContext.watch` -> `WidgetRef.watch` +- `BuildContext.read` -> `WidgetRef.read` +- `BuildContext.select` -> `WidgetRef.watch(myProvider.select)` + +Le regole per "context.watch" vs "context.read" si applicano anche a Riverpod: +All'interno del metodo `build`, utilizza "watch". Nei gestori di eventi come gli eventi di clic, utilizza "read". +Quando hai bisogno di filtrare i valori e ricreare, utilizza "select". +::: + +## Leggere i provider: Consumer +Provider include opzionalmente un widget chiamato `Consumer` (e varianti come `Consumer2`) per leggere i provider. + +`Consumer` è utile per l'ottimizzazione delle prestazioni, consentendo ricostruzioni più granulari dell'albero dei widget e +aggiornando solo i widget rilevanti quando lo stato cambia. + +Pertanto, se un provider è definito come: + +```dart +Provider(...); +``` + +Provider ci permette di leggere quel provider usando `Consumer` in questo modo: + +```dart +Consumer( + builder: (BuildContext context, Model model, Widget? child) { + + } +) +``` + +Riverpod segue lo stesso principio. Anch'esso, ha un widget chiamato `Consumer` con lo stesso scopo. + +Se definiamo un provider come: + +```dart +final modelProvider = Provider(...); +``` + +Possiamo poi utilizzare `Consumer` in questo modo: + +```dart +Consumer( + builder: (BuildContext context, WidgetRef ref, Widget? child) { + Model model = ref.watch(modelProvider); + + } +) +``` + +Nota come `Consumer` ci fornisce un oggetto `WidgetRef`. Si tratta dello stesso oggetto +che abbiamo visto nella parte precedente relativa a `ConsumerWidget`. + +### Non c'è nessun `ConsumerN` equivalente in Riverpod +Nota come `Consumer2`, `Consumer3` e simili di pkg:Provider non sono necessari in Riverpod. + +Con Riverpod, se desideri leggere valori da più provider, puoi semplicemente scrivere più istruzioni `ref.watch`, come segue: + +```dart +Consumer( + builder: (context, ref, child) { + Model1 model = ref.watch(model1Provider); + Model2 model = ref.watch(model2Provider); + Model3 model = ref.watch(model3Provider); + // ... + } +) +``` + +Rispetto alle API `ConsumerN` di pkg:Provider, la soluzione sopra sembra molto meno complessa ed è probabilmente più facile da comprendere. + +## Combinare provider: ProxyProvider con oggetti stateless +Quando si utilizza Provider, il modo ufficiale di combinare i provider è utilizzare il widget `ProxyProvider` +(o varianti come `ProxyProvider2`). + +Ad esempio, potremmo definire: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +ChangeNotifierProvider(create: (context) => UserIdNotifier()), +``` + +Da qui abbiamo due opzioni. Possiamo combinare `UserIdNotifier` per creare un nuovo provider +"senza stato" (tipicamente un valore immutabile che eventualmente sovrascrive ==). +Ad esempio: + +```dart +ProxyProvider( + update: (context, userIdNotifier, _) { + return 'The user ID of the the user is ${userIdNotifier.userId}'; + } +) +``` + +Questo provider restituirebbe automaticamente una nuova `String` ogni volta che `UserIdNotifier.userId` cambia. + +Possiamo fare qualcosa di simile in Riverpod, ma la sintassi è diversa. +Innanzitutto, in Riverpod, la definizione del nostro `UserIdNotifier` sarebbe: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +final userIdNotifierProvider = ChangeNotifierProvider( + (ref) => UserIdNotifier(), +); +``` + +Da qui, per generare la nostra `String` basata su `userId` potremmo fare: + +```dart +final labelProvider = Provider((ref) { + UserIdNotifier userIdNotifier = ref.watch(userIdNotifierProvider); + return 'The user ID of the the user is ${userIdNotifier.userId}'; +}); +``` + +Notare la riga che usa `ref.watch(userIdNotifierProvider)`. + +Questa riga di codice dice a Riverpod di ottenere il contenuto di `userIdNotifierProvider` e che +ogni volta che quel valore cambia, `labelProvider` verrà ricomputato. +Di conseguenza, la `String` emessa da `labelProvider` si aggiornerà automaticamente ogni volta che cambia `userId`. + +Questo schema è stato illustrato in precedenza spiegando [come leggere i provider all'interno dei widget](#lettura-dei-provider-buildcontext). +Infatti, i provider sono ora in grado di ascoltare altri provider allo stesso modo in cui lo fanno i widget. + +## Combinare provider: ProxyProvider con oggetti stateful +Quando si combinano i provider, un'altra possibile situazione è esporre oggetti con stato, +come un'istanza di `ChangeNotifier`. + +Per questo scopo, potremmo utilizzare `ChangeNotifierProxyProvider` (o varianti come `ChangeNotifierProxyProvider2`). +Ad esempio, potremmo definire: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +ChangeNotifierProvider(create: (context) => UserIdNotifier()), +``` + +Successivamente, possiamo definire un nuovo `ChangeNotifier` che è basato su `UserIdNotifier.userId`. +Per esempio, potremmo fare: + +```dart +class UserNotifier extends ChangeNotifier { + String? _userId; + + void setUserId(String? userId) { + if (userId != _userId) { + print('The user ID changed from $_userId to $userId'); + _userId = userId; + } + } +} + +// ... + +ChangeNotifierProxyProvider( + create: (context) => UserNotifier(), + update: (context, userIdNotifier, userNotifier) { + return userNotifier! + ..setUserId(userIdNotifier.userId); + }, +); +``` + +Questo nuovo provider crea un'unica istanza di `UserNotifier` (che non viene mai ricostruita) +e stampa una stringa ogni volta che l'ID dell'utente cambia. + +Per fare la stessa cosa in Riverpod si procede in modo diverso. +Innanzitutto, in Riverpod, la definizione del nostro `UserIdNotifier` sarebbe: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +final userIdNotifierProvider = ChangeNotifierProvider( + (ref) => UserIdNotifier(), +), +``` + +Da qui, l'equivalente del precedente `ChangeNotifierProxyProvider` sarebbe: + +```dart +class UserNotifier extends ChangeNotifier { + String? _userId; + + void setUserId(String? userId) { + if (userId != _userId) { + print('The user ID changed from $_userId to $userId'); + _userId = userId; + } + } +} + +// ... + +final userNotifierProvider = ChangeNotifierProvider((ref) { + final userNotifier = UserNotifier(); + ref.listen( + userIdNotifierProvider, + (previous, next) { + if (previous?.userId != next.userId) { + userNotifier.setUserId(next.userId); + } + }, + ); + + return userNotifier; +}); +``` + +La parte cruciale di questo snippet è la riga `ref.listen`. +Questa funzione `ref.listen` è un'utilità che consente di ascoltare un provider e +ogni qualvolta che il provider cambia, esegue una funzione. + +I parametri `previous` e `next` di quella funzione corrispondono all'ultimo valore prima che +il provider sia cambiato e al nuovo valore dopo il cambio. + +## Ambito (Scoping) dei provider vs `.family` + `.autoDispose` + +In pkg:Provider, lo scope veniva utilizzato per due scopi: +- distruggere lo stato quando si lascia una pagina +- avere uno stato personalizzato per pagina + +Utilizzare lo scoping solo per distruggere lo stato non è ideale. +Il problema è che lo scoping non funziona bene in applicazioni di grandi dimensioni. +Ad esempio, lo stato spesso viene creato in una pagina, ma distrutto in seguito in una pagina diversa dopo la navigazione. +Questo non consente di avere più cache attive su pagine diverse. + +Allo stesso modo, l'approccio "stato personalizzato per pagina" diventa rapidamente difficile da gestire +se lo stato deve essere condiviso con un'altra parte dell'albero dei widget, +come potrebbe essere necessario con modali o con un form a più passaggi. + +Riverpod adotta un approccio diverso: innanzitutto, lo scoping dei provider è in un certo senso scoraggiato; +in secondo luogo, `.family` e `.autoDispose` sono una soluzione di sostituzione completa per questo. + +All'interno di Riverpod, i provider contrassegnati come `.autoDispose` distruggono automaticamente il proprio stato quando non vengono più utilizzati. +Quando l'ultimo widget che rimuove un provider viene smontato, Riverpod lo rileverà e distruggerà il provider. +Prova a utilizzare questi due metodi del ciclo di vita in un provider per testare questo comportamento: + +```dart +ref.onCancel((){ + print("Nessuno sta più in ascolto di me!"); +}); +ref.onDispose((){ + print("Se sono stato definito come `.autoDispose`, sono stato appena distrutto!"); +}); +``` + +Ciò risolve intrinsecamente il problema della "distruzione dello stato". + +Inoltre, è possibile contrassegnare un Provider come `.family` (e, contemporaneamente, come `.autoDispose`). +Questo consente di passare parametri ai provider, il che fa sì che vengano creati e tracciati internamente più provider. +In altre parole, quando si passano parametri, *viene creato uno stato unico per ogni parametro univoco*. + + + +Ciò risolve il problema dello "stato personalizzato per pagina". +In realtà, c'è un altro vantaggio: uno stato del genere non è più vincolato a una pagina specifica. +Invece, se una diversa pagina cerca di accedere allo stesso stato, potrà farlo semplicemente riutilizzando i parametri. + +In molti modi, il passaggio di parametri ai provider è equivalente ad una Map key. +Se la chiave è la stessa, si otterrà lo stesso valore. Se si tratta di una chiave diversa, si otterrà uno stato diverso. + +[provider]: https://pub.dev/packages/provider +[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider +[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[autodispose]: /docs/concepts/modifiers/auto_dispose +[workaround]: https://pub.dev/packages/provider#can-i-obtain-two-different-providers-using-the-same-type +[.family modifier]: /docs/concepts/modifiers/family +[keepAlive]: /docs/concepts/modifiers/auto_dispose#refkeepalive +[ChangeNotifierProvider]: /docs/providers/change_notifier_provider +[combining Providers]: /docs/concepts/combining_providers diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx new file mode 100644 index 000000000..d47e57bde --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx @@ -0,0 +1,197 @@ +--- +title: Quickstart +--- + +Questa sezione è progettata per le persone che hanno familiarità con il pacchetto [Provider] e +che desiderano imparare Riverpod. + +Prima di tutto, leggi il breve articolo [getting started] e prova il piccolo esempio [sandbox] +per testare le funzionalità di Riverpod. Se ti piace ciò che vedi in quell'esempio, +dovresti sicuramente considerare una migrazione. + +Infatti, la migrazione da Provider a Riverpod può essere molto semplice e diretta. + +La migrazione consiste principalmente in alcuni passaggi che possono essere eseguiti in modo *incrementale*. + +## Inizia con `ChangeNotifierProvider` +Durante la transizione verso Riverpod puoi benissimo continuare ad utilizzare `ChangeNotifier`. + +Quanto segue è perfettamente accettabile per iniziare: + +```dart +// Se hai questo... +class MyNotifier extends ChangeNotifier { + int state = 0; + + void increment() { + state++; + notifyListeners(); + } +} + +// ... basta che aggiungi questo! +final myNotifierProvider = ChangeNotifierProvider((ref) { + return MyNotifier(); +}); +``` +Come puoi vedere, Riverpod espone una classe [ChangeNotifierProvider], +che è lì appositamente per supportare le migrazioni da pkg:Provider. + +Tieni presente che questo provider non è raccomandato quando si scrive nuovo codice +e non è il modo migliore per utilizzare Riverpod, ma è un modo semplice e delicato per iniziare la tua migrazione. + +:::tip +Non c'è bisogno di cambiare immediatamente i tuoi `ChangeNotifier` nei [provider più moderni di Riverpod]. +Alcuni richiedono un certo cambio di paradigma, quindi potrebbe essere difficile farlo inizialmente. + +Prenditi il tuo tempo, poiché è importante prendere familiarità con Riverpod prima; +scoprirai rapidamente che *quasi* tutti i provider di pkg:provider hanno un equivalente stretto in pkg:riverpod. +::: + +## Inizia con le *foglie (leaves)* + +Inizia con i provider che non dipendono da nessun altro provider, cioè inizia con le *foglie* nel tuo albero delle dipendenze. +Una volta che hai migrato tutte le foglie, puoi passare ai provider che dipendono dalle foglie. + +In altre parole, evita di migrare ProxyProvider all'inizio; affrontali una volta che tutte le loro dipendenze sono state migrate. + +Questo dovrebbe accelerare e semplificare il processo di migrazione, mentre allo stesso tempo ridurre al minimo e tracciare eventuali errori. + +## Riverpod e Provider possono coesistere +*Tieni presente che è del tutto possibile utilizzare contemporaneamente sia Provider che Riverpod.* + +Infatti, utilizzando alias di importazione, è possibile utilizzare entrambe le API insieme. +Questo è anche ottimo per la leggibilità e rimuove qualsiasi uso ambiguo dell'API. + +Se hai intenzione di farlo, considera l'uso di alias di importazione per ciascuna importazione di Provider nel tuo codice. + +:::info +Una guida completa su come implementare efficacemente alias di importazione sarà presto disponibile. +::: + +## Non è *necessario* utilizzare `Consumer` immediatamente. +È importante tenere a mente che non c'è bisogno di utilizzare *immediatamente* le API di [Consumer di Riverpod]. +Se hai appena iniziato la migrazione, [come già menzionato], probabilmente dovresti iniziare con `ChangeNotifierProvider`. + +Considera `myNotifierProvider`, definito precedentemente. + +Dato che il tuo codice interno probabilmente dipende dalle API di pkg:Provider, usa quanto segue per iniziare a consumare `ChangeNotifier` con pkg:Riverpod. + +```dart +MultiProvider( + providers: [ + ChangeNotifierProvider.value(value: ref.watch(myNotifierProvider.notifier)), + ] +) +``` + +In questo modo, solo il Widget radice deve essere inizialmente convertito in un `ConsumerWidget`. +Ciò dovrebbe semplificare ulteriormente la migrazione verso pkg:Riverpod. + +## Migrare un Provider alla volta +Se hai già un'applicazione esistente, non cercare di migrare tutti i tuoi provider contemporaneamente! + +Anche se dovresti lavorare per spostare gradualmente tutta la tua applicazione su Riverpod nel lungo termine, **non esagerare**. +Fallo un provider alla volta. + +Prendi l'esempio precedente. Migrare completamente quel `myNotifierProvider` a Riverpod significa scrivere quanto segue: + +```dart +class MyNotifier extends Notifier { + @override + int build() => 0; + + void increment() => state++; +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); +``` + +.. ed è _anche_ necessario cambiare in che modo quel provider viene consumato, ovvero scrivere `ref.watch` al posto di `context.watch` per questo provider. + +Questa operazione potrebbe richiedere del tempo e potrebbe causare alcuni errori, quindi non affrettarti a farlo tutto in una volta. + +## Migrare i `ProxyProvider` +In pkg:Provider, `ProxyProvider` viene utilizzato per combinare i valori di altri Provider; +la sua costruzione dipende dal valore di altri provider in modo reattivo. + +Con Riverpod, invece, i provider [sono componibili di default]; pertanto, quando migri un `ProxyProvider`, +dovrai semplicemente scrivere `ref.watch` se desideri dichiarare una dipendenza diretta da un Provider ad un altro. + +Al contempo, combinare valori con Riverpod dovrebbe risultare più semplice e diretto; +di conseguenza, la migrazione dovrebbe semplificare notevolmente il tuo codice. + +Inoltre, non ci sono trucchi per combinare più di due provider insieme: +aggiungi semplicemente un altro `ref.watch` e sarai pronto a procedere. + +## Inizializzazione anticipata +Poiché i provider di Riverpod sono variabili globali *final*, sono [lazy di default]. + +Se hai bisogno di inizializzare alcuni dati o un servizio di utilità in fase di avvio, +il modo migliore per farlo è leggere il tuo provider nel punto in cui di solito inserivi `MultiProvider`. + +In altre parole, poiché Riverpod non può essere forzato a essere inizializzato anticipatamente, i provider +possono essere letti e memorizzati nella tua fase di avvio, in modo che siano pronti e caricati quando necessario nel resto della tua applicazione. + +Una guida completa sull'inizializzazione anticipata dei provider di Riverpod è [disponibile qui]. + +## Generazione di codice +La [generazione di codice] è consigliata per utilizzare Riverpod in modo *future-proof*. +A tal proposito, è probabile che quando la metaprogrammazione diventerà una cosa comune, la generazione di codice sarà predefinita per Riverpod. + +Sfortunatamente, `@riverpod` non può generare codice per `ChangeNotifierProvider`. +Per superare questo problema, puoi utilizzare il seguente metodo di estensione di utilità: +```dart +extension ChangeNotifierWithCodeGenExtension on Ref { + T listenAndDisposeChangeNotifier(T notifier) { + notifier.addListener(notifyListeners); + onDispose(() => notifier.removeListener(notifyListeners)); + onDispose(notifier.dispose); + return notifier; + } +} +``` + +Successivamente, puoi esporre il tuo `ChangeNotifier` con la seguente sintassi codegen: +```dart +// ignore_for_file: unsupported_provider_value +@riverpod +MyNotifier example(ExampleRef ref) { + return ref.listenAndDisposeChangeNotifier(MyNotifier()); +} +``` + +Una volta completata la migrazione "base", puoi cambiare il tuo `ChangeNotifier` in `Notifier`, +eliminando così la necessità di estensioni temporanee. +Riprendendo gli esempi precedenti, un `Notifier` "completamente migrato" diventa: + +```dart +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() => 0; + + void increment() => state++; +} +``` + +Una volta fatto ciò, e sei sicuro che non ci siano più `ChangeNotifierProvider` nel tuo codice, +puoi eliminare definitivamente l'estensione temporanea. + +Tieni presente che, sebbene sia consigliato, la generazione di codice non è *obbligatoria*. +È importante ragionare sulle migrazioni in modo incrementale: +quindi, è normale sentire che sia troppo pesante implementare sia la migrazione che la transizione alla sintassi di codice generato. + +Seguendo questa guida, potrai migrare alla generazione di codice come ulteriore passo avanti in seguito. + +[getting started]: /docs/introduction/getting_started +[sandbox]: https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2 +[provider]: https://pub.dev/packages/provider +[ChangeNotifierProvider]: /docs/providers/change_notifier_provider +[generazione di codice]: /docs/concepts/about_code_generation +[provider più moderni di Riverpod]: /docs/providers/notifier_provider +[sono componibili di default]: /docs/from_provider/motivation#combinare-i-provider-è-difficile-e-soggetto-a-errori +[come già menzionato]: /docs/from_provider/quickstart#start-with-changenotifierprovider +[Consumer di Riverpod]: /docs/concepts/reading +[lazy di default]: /docs/concepts/provider_lifecycles +[disponibile qui]: /docs/essentials/eager_initialization \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started.mdx deleted file mode 100644 index d9c2a8524..000000000 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started.mdx +++ /dev/null @@ -1,237 +0,0 @@ ---- -title: Introduzione ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -Prima di addentrarci nei meccanismi interni di [Riverpod], iniziamo con le basi, ovvero -installare [Riverpod] e di seguito creare il classico "Hello World". - -## Quale pacchetto installare - -Prima di tutto, devi sapere che [Riverpod] è diviso in diversi pacchetti, ognuno per una propria esigenza. -La variante di [Riverpod] che vorrai installare dipenderà dal tipo di App che hai intenzione di creare. - -Fai riferimento alla seguente tabella per decidere quale pacchetto installare: - -| tipo app | nome pacchetto | descrizione | -| ------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| Flutter + [flutter_hooks] | [hooks_riverpod] | Permette l'utilizzo di entrambi [flutter_hooks] e [Riverpod] insieme. | -| Solo Flutter | [flutter_riverpod] | Per utilizzare [Riverpod] per App Flutter | -| Solo Dart (No Flutter) | [riverpod](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod) | Versione di [Riverpod] con tutte le classi collegate a Flutter rimosse | - -## Installare il pacchetto - -Una volta che sai quale pacchetto installare, procedi aggiungendo la versione dalla seguente tabella al file `pubspec.yaml`: - - - - -```yaml title="pubspec.yaml" -environment: - sdk: ">=2.12.0 <3.0.0" - flutter: ">=2.0.0" - -dependencies: - flutter: - sdk: flutter - flutter_hooks: ^0.18.0 - hooks_riverpod: ^2.1.3 -``` - -Dopodichè esegui `flutter pub get`. - - - - -```yaml title="pubspec.yaml" -environment: - sdk: ">=2.12.0 <3.0.0" - flutter: ">=2.0.0" - -dependencies: - flutter: - sdk: flutter - flutter_riverpod: ^2.1.3 -``` - -Dopodichè esegui `flutter pub get`. - - - - -```yaml title="pubspec.yaml" -environment: - sdk: ">=2.12.0-0 <3.0.0" - -dependencies: - riverpod: ^2.1.3 -``` - -Dopodichè esegui `dart pub get`. - - - - -Ottimo! Hai appena aggiunto [Riverpod] alla tua app! - -## Esempio di utilizzo: Hello world - -Ora che hai installato [Riverpod], possiamo iniziare ad utilizzarlo. - -I seguenti snippet mostrano come utilizzare la nostra nuova dipendenza per creare un "Hello world": - - - - -```dart title="lib/main.dart" -import 'package:flutter/material.dart'; -import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:flutter_hooks/flutter_hooks.dart'; - -// Creiamo un "provider", che salverà un valore (Nel nostro caso "Hello world") -// Utilizzare un provider ci permetterà di imitare/sovrascrivere il valore esposto. -final helloWorldProvider = Provider((_) => 'Hello world'); - -void main() { - runApp( - // Per fare in modo che i widget leggano i provider, dobbiamo avvolgere - // l'intera applicazione in un widget "ProviderScope". - // Qui è dove sarà salvato lo stato dei nostri provider. - ProviderScope( - child: MyApp(), - ), - ); -} - -// Nota: MyApp è un HookConsumerWidget, da hooks_riverpod -class MyApp extends HookConsumerWidget { - @override - Widget build(BuildContext context, WidgetRef ref) { - final String value = ref.watch(helloWorldProvider); - - return MaterialApp( - home: Scaffold( - appBar: AppBar(title: Text('Example')), - body: Center( - child: Text(value), - ), - ), - ); - } -} -``` - -Puoi eseguire l'app con `flutter run`. -Questo mostrerà "Hello world" nel tuo device. - - - - -```dart title="lib/main.dart" -import 'package:flutter/material.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; - -// Creiamo un "provider", che salverà un valore (Nel nostro caso "Hello world") -// Utilizzando provider ci permetterà di mock/override il valore esposto. -final helloWorldProvider = Provider((_) => 'Hello world'); - -void main() { - runApp( - // Per i widget, per avere la possibilità di leggere i provider, dobbiamo avvolgere - // l'intera applicazione con il Widget "ProviderScope". - // Qui è dove sarà salvato lo stato dei nostri provider. - ProviderScope( - child: MyApp(), - ), - ); -} - -// Estende ConsumerWidget (esposto da Riverpod) invece che StatelessWidget -class MyApp extends ConsumerWidget { - @override - Widget build(BuildContext context, WidgetRef ref) { - final String value = ref.watch(helloWorldProvider); - - return MaterialApp( - home: Scaffold( - appBar: AppBar(title: Text('Example')), - body: Center( - child: Text(value), - ), - ), - ); - } -} -``` - -Puoi eseguire con `flutter run`. -Questo mostrerà "Hello world" nel tuo device. - - - - -```dart title="lib/main.dart" -import 'package:riverpod/riverpod.dart'; - -// Creiamo un "provider", che salverà un valore(Nel nostro caso "Hello world") -// Utilizzando provider ci permetterà di mock/override il valore esposto. -final helloWorldProvider = Provider((_) => 'Hello world'); - -void main() { - - // In questo oggetto sarà salvato lo stato dei nostri provider. - final container = ProviderContainer(); - - // Grazie a "container", possiamo leggere il nostro provider. - final value = container.read(helloWorldProvider); - - print(value); // Hello world -} -``` - -Puoi eseguire con `dart lib/main.dart`. -Questo mostrerà "Hello world" nella console - - - - -## Andando oltre: Installare snippet - -Se stai utilizzando `Flutter` e `VS Code`, considera l'utilizzo di [Flutter Riverpod Snippets](https://marketplace.visualstudio.com/items?itemName=robert-brunhage.flutter-riverpod-snippets) - -Se stai utilizzando `Flutter` e `Android Studio` o `IntelliJ`, considera l'utilizzo di [Flutter Riverpod Snippets](https://plugins.jetbrains.com/plugin/14641-flutter-riverpod-snippets) - -![img](/img/snippets/greetingProvider.gif) - -## Scegli il prossimo passo - -Apprendi i concetti base: - -- [Impara di più riguardo i providers](/docs/concepts/providers) - -Segui un cookbook: - -- [Come testare i provider](/docs/cookbooks/testing) - -[riverpod]: https://github.com/rrousselgit/riverpod -[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod -[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod -[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world.dart deleted file mode 100644 index a52fcebae..000000000 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world.dart +++ /dev/null @@ -1,20 +0,0 @@ -// ignore_for_file: avoid_print - -/* SNIPPET START */ - -import 'package:riverpod/riverpod.dart'; - -// Creiamo un "provider", il quale immagazzinerà un valore (qui "Hello world"). -// Usare un provider ci permetterà di simulare/sovrascrivere il valore esposto. - -final helloWorldProvider = Provider((_) => 'Hello world'); - -void main() { - // Questo è l'oggetto dove lo stato dei nostri provider sarà salvato. - final container = ProviderContainer(); - - // Grazie a "container", possiamo leggere il nostro provider. - final value = container.read(helloWorldProvider); - - print(value); // Hello world -} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world_hooks.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world_hooks.dart deleted file mode 100644 index c56c2929b..000000000 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world_hooks.dart +++ /dev/null @@ -1,38 +0,0 @@ -// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types - -/* SNIPPET START */ - -import 'package:flutter/material.dart'; -import 'package:hooks_riverpod/hooks_riverpod.dart'; - -// Creiamo un "provider", il quale immagazzinerà un valore (qui "Hello world"). -// Usare un provider ci permetterà di simulare/sovrascrivere il valore esposto. -final helloWorldProvider = Provider((_) => 'Hello world'); - -void main() { - runApp( - // Per fare in modo che i widget leggano i provider, dobbiamo incapsulare - // l'intera applicazione in un widget "ProviderScope" - // Qui è dove lo stato dei nostri provider sarà salvato. - ProviderScope( - child: MyApp(), - ), - ); -} - -// Nota: MyApp è un HookConsumerWidget, da hooks_riverpod. -class MyApp extends HookConsumerWidget { - @override - Widget build(BuildContext context, WidgetRef ref) { - final String value = ref.watch(helloWorldProvider); - - return MaterialApp( - home: Scaffold( - appBar: AppBar(title: const Text('Example')), - body: Center( - child: Text(value), - ), - ), - ); - } -} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx new file mode 100644 index 000000000..941063d06 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx @@ -0,0 +1,195 @@ +--- +title: Introduzione +pagination_next: essentials/first_request +version: 4 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import pubspec from "./getting_started/pubspec"; +import dartHelloWorld from "./getting_started/dart_hello_world"; +import pubadd from "./getting_started/pub_add"; +import helloWorld from "./getting_started/hello_world"; +import dartPubspec from "./getting_started/dart_pubspec"; +import dartPubadd from "./getting_started/dart_pub_add"; +import { + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; +import { Link } from "../../../../../src/components/Link"; + +## Prova Riverpod online + +Per farti un'idea di Riverpod, prova a utilizzarlo online su [Dartpad](https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2) +o su [Zapp](https://zapp.run/new): + + + +## Installazione del package + +Una volta che sai quale pacchetto desideri installare, procedi ad aggiungere la dipendenza alla tua app tramite riga di comando: + + + + + + + + + + + + + + + + +In alternativa, puoi aggiungere manualmente la dipendenza alla tua app all'interno del tuo file `pubspec.yaml`: + + + + + + +Infine, installa i package con `flutter pub get`. + + + Ora puoi eseguire il code-generator con{" "} + flutter pub run build_runner watch. + + + + + + + +Infine, installa i package con `dart pub get`. + + + Ora puoi eseguire il code-generator con{" "} + dart run build_runner watch. + + + + + +Ecco fatto. Hai aggiunto [Riverpod] alla tua app! + +## Abilitare riverpod_lint/custom_lint + +Riverpod include un pacchetto opzionale chiamato [riverpod_lint] +che fornisce regole di lint per aiutarti a scrivere codice migliore +e offre opzioni di refactoring personalizzate. + +Il pacchetto dovrebbe già essere installato se hai seguito i passaggi precedenti, +ma è necessario un passaggio separato per abilitarlo. + +Per abilitare [riverpod_lint], è necessario aggiungere un file `analysis_options.yaml` +posizionato sullo stesso livello del tuo `pubspec.yaml` e includere quanto segue: + + + {`analyzer: + plugins: + - custom_lint`} + + +Ora dovresti vedere dei warning nel tuo ambiente di sviluppo (IDE) se hai commesso errori +nell'utilizzo di Riverpod nel tuo codice. + +Per vedere l'elenco completo dei possibili warning e refactoring, vai alla pagina di [riverpod_lint]. + +:::note +Quei warning non verranno visualizzati nel comando `dart analyze`. +Se desideri verificare tali warning in CI/terminale, puoi eseguire quanto segue: + +```sh +dart run custom_lint +``` + +::: + +## Esempio di utilizzo: Hello world + +Ora che abbiamo installato [Riverpod], possiamo iniziare ad usarlo. + +Gli snippet seguenti mostrano come utilizzare la nostra nuova dipendenza per creare un "Hello world": + + + + + + +Successivamente, avvia l'applicazione con `flutter run`. +Questo renderizzerà "Hello world" sul tuo dispositivo. + + + + + + +Successivamente, avvia l'applicazione con `dart lib/main.dart`. +Vedrai stampato "Hello world" nella console. + + + + +## Andando oltre: Installazione di snippet di codice + +Se stai utilizzando `Flutter` e `VS Code`, considera l'utilizzo di [Flutter Riverpod Snippets](https://marketplace.visualstudio.com/items?itemName=robert-brunhage.flutter-riverpod-snippets) + +Se stai utilizzando `Flutter` e `Android Studio` o `IntelliJ`, considera l'utilizzo di [Flutter Riverpod Snippets](https://plugins.jetbrains.com/plugin/14641-flutter-riverpod-snippets) + +![img](/img/snippets/greetingProvider.gif) + +## Scegli il prossimo passo + +Apprendi i concetti base: + +- + +Segui un cookbook: + +- + +[riverpod]: https://github.com/rrousselgit/riverpod +[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod +[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod +[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks +[riverpod_lint]: https://pub.dev/packages/riverpod_lint diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/index.tsx similarity index 100% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/index.tsx rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/index.tsx diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart similarity index 56% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart index 2b5fc5131..4394668b2 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart @@ -7,18 +7,18 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; -// 我们创建一个 “provider”，它将用于保存一个值（这里是 “Hello world”）。 -// 通过使用一个 provider，我们能够模拟或覆盖被暴露的值。 +// Creiamo un "provider", che conterrà un valore (qui "Hello, world"). +// Utilizzando un provider, ciò ci consente di simulare/sostituire il valore esposto. @riverpod String helloWorld(HelloWorldRef ref) { return 'Hello world'; } void main() { - // 我们的 provider 将借这个对象存储状态。 + // Questo oggetto è dove lo stato dei nostri provider sarà salvato. final container = ProviderContainer(); - // 我们可以借助这个 “container” 对象读取 provider。 + // Grazie a "container", possiamo leggere il nostro provider. final value = container.read(helloWorldProvider); print(value); // Hello world diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart similarity index 100% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/raw.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx new file mode 100644 index 000000000..07c03cf6b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx @@ -0,0 +1,32 @@ +export function buildDeps({ + deps = [], + devDeps = [], +}: { + deps?: string[]; + devDeps?: string[]; +}) { + var result = ""; + for (const dep of deps) { + result += `dart pub add ${dep}\n`; + } + + for (const dep of [...devDeps, "custom_lint", "riverpod_lint"]) { + result += `dart pub add dev:${dep}\n`; + } + + return result; +} + +const raw = buildDeps({ deps: ["riverpod"] }); + +const codegen = buildDeps({ + deps: ["riverpod", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx similarity index 78% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec.tsx rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx index 598ab76e8..d44367c30 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec.tsx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx @@ -3,12 +3,11 @@ import { riverpodAnnotationVersion, riverpodGeneratorVersion, riverpodLintVersion, -} from "../../../../../src/versions"; +} from "../../../../../../src/versions"; -const codegen = ` -name: my_app_name +const codegen = `name: my_app_name environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0 <4.0.0" dependencies: riverpod: ^${riverpodVersion} @@ -21,10 +20,9 @@ dev_dependencies: riverpod_lint: ^${riverpodLintVersion} `; -const raw = ` -name: my_app_name +const raw = `name: my_app_name environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0 <4.0.0" dependencies: riverpod: ^${riverpodVersion} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart new file mode 100644 index 000000000..d2929e44b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart @@ -0,0 +1,46 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +/* SNIPPET START */ import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'main.g.dart'; + +// Creiamo un "provider", che conterrà un valore (qui "Hello, world"). +// Utilizzando un provider, ciò ci consente di simulare/sostituire il valore esposto. +@riverpod +String helloWorld(HelloWorldRef ref) { + return 'Hello world'; +} + +void main() { + runApp( + // Per consentire ai widget di leggere i provider, è necessario incapsulare l'intera + // applicazione in un widget "ProviderScope". + // Questo è il luogo in cui verrà memorizzato lo stato dei nostri provider. + ProviderScope( + child: MyApp(), + ), + ); +} + +// Estendiamo HookConsumerWidget invece di StatelessWidget, il quale è esposto da Riverpod +class MyApp extends HookConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // Possiamo usare gli hooks all'interno di un HookConsumerWidget + final counter = useState(0); + + final String value = ref.watch(helloWorldProvider); + + return MaterialApp( + home: Scaffold( + appBar: AppBar(title: const Text('Example')), + body: Center( + child: Text('$value ${counter.value}'), + ), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart similarity index 100% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx similarity index 67% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/index.tsx rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx index 9535552ac..3f10c2a94 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/index.tsx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx @@ -1,11 +1,11 @@ import raw from "!!raw-loader!./raw.dart"; import raw_hooks from "!!raw-loader!./raw_hooks.dart"; import codegen from "!!raw-loader!./main.dart"; -import codegen_hooks from "!!raw-loader!./main_hooks.dart"; +import hooksCodegen from "!!raw-loader!./hooks_codegen/main.dart"; export default { raw, hooks: raw_hooks, codegen, - hooksCodegen: codegen_hooks, + hooksCodegen: hooksCodegen, }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart similarity index 57% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart index da5ffb095..535266fa1 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart @@ -1,15 +1,13 @@ // ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types -/* SNIPPET START */ - -import 'package:flutter/material.dart'; +/* SNIPPET START */ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; -// We create a "provider", which will store a value (here "Hello world"). -// By using a provider, this allows us to mock/override the value exposed. +// Creiamo un "provider", che conterrà un valore (qui "Hello, world"). +// Utilizzando un provider, ciò ci consente di simulare/sostituire il valore esposto. @riverpod String helloWorld(HelloWorldRef ref) { return 'Hello world'; @@ -17,16 +15,16 @@ String helloWorld(HelloWorldRef ref) { void main() { runApp( - // For widgets to be able to read providers, we need to wrap the entire - // application in a "ProviderScope" widget. - // This is where the state of our providers will be stored. + // Per consentire ai widget di leggere i provider, è necessario incapsulare l'intera + // applicazione in un widget "ProviderScope". + // Questo è il luogo in cui verrà memorizzato lo stato dei nostri provider. ProviderScope( child: MyApp(), ), ); } -// Extend ConsumerWidget instead of StatelessWidget, which is exposed by Riverpod +// Estendiamo ConsumerWidget invece di StatelessWidget, il quale è esposto da Riverpod class MyApp extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world_flutter.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart similarity index 54% rename from website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world_flutter.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart index ae21ba688..7cbad6012 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world_flutter.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart @@ -1,26 +1,24 @@ // ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types -/* SNIPPET START */ - -import 'package:flutter/material.dart'; +/* SNIPPET START */ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -// Creiamo un "provider", il quale immagazzinerà un valore (qui "Hello world"). -// Usare un provider ci permetterà di simulare/sovrascrivere il valore esposto. +// Creiamo un "provider", che conterrà un valore (qui "Hello, world"). +// Utilizzando un provider, ciò ci consente di simulare/sostituire il valore esposto. final helloWorldProvider = Provider((_) => 'Hello world'); void main() { runApp( - // Per fare in modo che i widget leggano i provider, dobbiamo incapsulare - // l'intera applicazione in un widget "ProviderScope" - // Qui è dove lo stato dei nostri provider sarà salvato. + // Per consentire ai widget di leggere i provider, è necessario incapsulare l'intera + // applicazione in un widget "ProviderScope". + // Questo è il luogo in cui verrà memorizzato lo stato dei nostri provider. ProviderScope( child: MyApp(), ), ); } -// Estendere ConsumerWidget (esposto da Riverpod) invece di StatelessWidget +// Estendiamo ConsumerWidget invece di StatelessWidget, il quale è esposto da Riverpod class MyApp extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart new file mode 100644 index 000000000..57ddda404 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart @@ -0,0 +1,40 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +/* SNIPPET START */ import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +// Creiamo un "provider", che conterrà un valore (qui "Hello, world"). +// Utilizzando un provider, ciò ci consente di simulare/sostituire il valore esposto. +final helloWorldProvider = Provider((_) => 'Hello world'); + +void main() { + runApp( + // Per consentire ai widget di leggere i provider, è necessario incapsulare l'intera + // applicazione in un widget "ProviderScope". + // Questo è il luogo in cui verrà memorizzato lo stato dei nostri provider. + ProviderScope( + child: MyApp(), + ), + ); +} + +// Estendiamo HookConsumerWidget invece di StatelessWidget, il quale è esposto da Riverpod +class MyApp extends HookConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // Possiamo usare gli hooks all'interno di un HookConsumerWidget + final counter = useState(0); + + final String value = ref.watch(helloWorldProvider); + + return MaterialApp( + home: Scaffold( + appBar: AppBar(title: const Text('Example')), + body: Center( + child: Text('$value ${counter.value}'), + ), + ), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx new file mode 100644 index 000000000..65c7be1bd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx @@ -0,0 +1,39 @@ +export function buildDeps({ + deps = [], + devDeps = [], +}: { + deps?: string[]; + devDeps?: string[]; +}) { + var result = ''; + for (const dep of deps) { + result += `flutter pub add ${dep}\n`; + } + + for (const dep of [...devDeps, "custom_lint", "riverpod_lint"]) { + result += `flutter pub add dev:${dep}\n`; + } + + return result; +} + +const raw = buildDeps({ deps: ["flutter_riverpod"] }); + +const codegen = buildDeps({ + deps: ["flutter_riverpod", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +const hooks = buildDeps({ deps: ["hooks_riverpod", "flutter_hooks"] }); + +const hooksCodegen = buildDeps({ + deps: ["hooks_riverpod", "flutter_hooks", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +export default { + raw: raw, + hooks: hooks, + codegen: codegen, + hooksCodegen: hooksCodegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx new file mode 100644 index 000000000..da974c2a1 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx @@ -0,0 +1,51 @@ +import { + flutterRiverpodVersion, + hooksRiverpodVersion, + riverpodAnnotationVersion, + riverpodGeneratorVersion, + riverpodLintVersion, +} from "../../../../../../src/versions"; + +function plain(riverpod: string) { + return `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.0.0" + +dependencies: + flutter: + sdk: flutter + ${riverpod} + +dev_dependencies: + custom_lint: + riverpod_lint: ^${riverpodLintVersion} +`; +} + +function codegen(riverpod: string) { + return `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.0.0" + +dependencies: + flutter: + sdk: flutter + ${riverpod} + riverpod_annotation: ^${riverpodAnnotationVersion} + +dev_dependencies: + build_runner: + custom_lint: + riverpod_generator: ^${riverpodGeneratorVersion} + riverpod_lint: ^${riverpodLintVersion} +`; +} + +export default { + raw: plain(`flutter_riverpod: ^${flutterRiverpodVersion}`), + hooks: plain(`hooks_riverpod: ^${hooksRiverpodVersion}\n flutter_hooks:`), + codegen: codegen(`flutter_riverpod: ^${flutterRiverpodVersion}`), + hooksCodegen: codegen(`hooks_riverpod: ^${hooksRiverpodVersion}\n flutter_hooks:`), +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx new file mode 100644 index 000000000..c556de7cd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx @@ -0,0 +1,60 @@ +--- +title: Perché Riverpod? +version: 1 +--- + +import whyRiverpod from "./why_riverpod"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +## Che cos'è Riverpod? + +Riverpod (un anagramma di [Provider](https://pub.dev/packages/provider)) è un framework reattivo con cache per Flutter/Dart. + +Utilizzando la programmazione dichiarativa e reattiva, Riverpod è in grado di gestire +una grande parte della logica della tua applicazione per te. +Può effettuare richieste di rete con gestione degli errori e caching integrati, mentre ri-scarica automaticamente i dati quando necessario. + +## Motivazione + +Le applicazioni moderne raramente dispongono subito di tutte le informazioni necessarie per renderizzare la loro interfaccia utente. +Al contrario, i dati vengono spesso recuperati in modo asincrono da un server. + +Il problema è che lavorare con il codice asincrono è complesso. Anche se Flutter fornisce alcuni modi +per creare variabili di stato e aggiornare l'interfaccia utente in caso di modifiche, +le possibilità rimangono limitate. Alcune sfide rimangono irrisolte: + +- Le richieste asincrone devono essere memorizzate in cache localmente, +poiché sarebbe irragionevole eseguirle nuovamente ogni volta che l'interfaccia utente viene aggiornata. +- Dato che disponiamo di una cache, la nostra cache potrebbe diventare obsoleta se non siamo attenti. +- È inoltre necessario gestire errori e stati di caricamento. + +Affrontare tali problemi su larga scala può essere complicato e possono essere influenzati da numerose caratteristiche, come ad esempio: + +- aggiornamento con trascinamento verso il basso (pull to refresh) +- liste infinite / recupero dati man mano che si scorre (infinite lists / fetch as we scroll) +- ricerca in tempo reale mentre si digita (search as we type) +- ritardo nella richiesta asincrona (debouncing asynchronous requests) +- annullamento delle richieste asincrone quando non sono più necessarie +- UI ottimistica +- modalità offline +- ... + +Queste funzionalità possono essere complesse da implementare, ma sono cruciali per una buona esperienza utente. +Tuttavia, pochi package cercano di affrontare direttamente questi problemi, e gran parte del lavoro +deve essere svolto manualmente. + +Ecco dove entra in gioco Riverpod. +Riverpod cerca di risolvere questi problemi offrendo un nuovo e unico modo di scrivere la business logic, +ispirato ai widget di Flutter. +In molti modi, Riverpod è paragonabile ai widget, ma per lo stato. + +Utilizzando questo nuovo approccio, queste funzionalità complesse sono per lo più gestite già di default. +Tutto ciò che rimane è concentrarsi sulla tua interfaccia utente. + +Se sei scettico, ecco un esempio. Il seguente snippet è una semplificazione dell'applicazione client +[Pub.dev](https://github.com/rrousselGit/riverpod/tree/master/examples/pub) implementata con Riverpod. + + + +Questo snippet contiene tutta la business logic necessaria per una funzionalità di "ricerca in tempo reale" + +"aggiornamento con trascinamento verso il basso" + "lista infinita", gestendo anche gli stati di errore e caricamento. diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart new file mode 100644 index 000000000..3e2022906 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart @@ -0,0 +1,31 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class Package { + static Package fromJson(dynamic json) { + throw UnimplementedError(); + } +} + +/* SNIPPET START */ + +// Recupera l'elenco dei package da pub.dev +@riverpod +Future> fetchPackages( + FetchPackagesRef ref, { + required int page, + String search = '', +}) async { + final dio = Dio(); + // Effettua una richiesta API. Qui stiamo utilizzando il package 'dio', ma potremmo usare qualsiasi altro package. + final response = await dio.get>( + 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', + ); + + // Decodifica la risposta JSON in una classe Dart. + return response.data?.map(Package.fromJson).toList() ?? const []; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart new file mode 100644 index 000000000..8f63ec36f --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart @@ -0,0 +1,227 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$fetchPackagesHash() => r'eebf7d838a57f493fffebfd2c8d8ab76d3233165'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [fetchPackages]. +@ProviderFor(fetchPackages) +const fetchPackagesProvider = FetchPackagesFamily(); + +/// See also [fetchPackages]. +class FetchPackagesFamily extends Family { + /// See also [fetchPackages]. + const FetchPackagesFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'fetchPackagesProvider'; + + /// See also [fetchPackages]. + FetchPackagesProvider call({ + required int page, + String search = '', + }) { + return FetchPackagesProvider( + page: page, + search: search, + ); + } + + @visibleForOverriding + @override + FetchPackagesProvider getProviderOverride( + covariant FetchPackagesProvider provider, + ) { + return call( + page: provider.page, + search: provider.search, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith( + FutureOr> Function(FetchPackagesRef ref) create) { + return _$FetchPackagesFamilyOverride(this, create); + } +} + +class _$FetchPackagesFamilyOverride implements FamilyOverride { + _$FetchPackagesFamilyOverride(this.overriddenFamily, this.create); + + final FutureOr> Function(FetchPackagesRef ref) create; + + @override + final FetchPackagesFamily overriddenFamily; + + @override + FetchPackagesProvider getProviderOverride( + covariant FetchPackagesProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [fetchPackages]. +class FetchPackagesProvider extends AutoDisposeFutureProvider> { + /// See also [fetchPackages]. + FetchPackagesProvider({ + required int page, + String search = '', + }) : this._internal( + (ref) => fetchPackages( + ref as FetchPackagesRef, + page: page, + search: search, + ), + from: fetchPackagesProvider, + name: r'fetchPackagesProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$fetchPackagesHash, + dependencies: FetchPackagesFamily._dependencies, + allTransitiveDependencies: + FetchPackagesFamily._allTransitiveDependencies, + page: page, + search: search, + ); + + FetchPackagesProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.page, + required this.search, + }) : super.internal(); + + final int page; + final String search; + + @override + Override overrideWith( + FutureOr> Function(FetchPackagesRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: FetchPackagesProvider._internal( + (ref) => create(ref as FetchPackagesRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + page: page, + search: search, + ), + ); + } + + @override + ({ + int page, + String search, + }) get argument { + return ( + page: page, + search: search, + ); + } + + @override + AutoDisposeFutureProviderElement> createElement() { + return _FetchPackagesProviderElement(this); + } + + FetchPackagesProvider _copyWith( + FutureOr> Function(FetchPackagesRef ref) create, + ) { + return FetchPackagesProvider._internal( + (ref) => create(ref as FetchPackagesRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + page: page, + search: search, + ); + } + + @override + bool operator ==(Object other) { + return other is FetchPackagesProvider && + other.page == page && + other.search == search; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, page.hashCode); + hash = _SystemHash.combine(hash, search.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin FetchPackagesRef on AutoDisposeFutureProviderRef> { + /// The parameter `page` of this provider. + int get page; + + /// The parameter `search` of this provider. + String get search; +} + +class _FetchPackagesProviderElement + extends AutoDisposeFutureProviderElement> + with FetchPackagesRef { + _FetchPackagesProviderElement(super.provider); + + @override + int get page => (origin as FetchPackagesProvider).page; + @override + String get search => (origin as FetchPackagesProvider).search; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart new file mode 100644 index 000000000..b79a3debd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart @@ -0,0 +1,27 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Package { + static Package fromJson(dynamic json) { + throw UnimplementedError(); + } +} + +/* SNIPPET START */ + +// Recupera l'elenco dei package da pub.dev +final fetchPackagesProvider = FutureProvider.autoDispose + .family, ({int page, String? search})>((ref, params) async { + final page = params.page; + final search = params.search ?? ''; + final dio = Dio(); + // Effettua una richiesta API. Qui stiamo utilizzando il package 'dio', ma potremmo usare qualsiasi altro package. + final response = await dio.get>( + 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', + ); + + // Decodifica la risposta JSON in una classe Dart. + return response.data?.map(Package.fromJson).toList() ?? const []; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx index aa8ba56f4..e577300ff 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx @@ -1,11 +1,11 @@ --- -title: da ^0.13.0 a ^0.14.0 +title: ^0.13.0 to ^0.14.0 --- -Con il rilascio della versione `0.14.0` di Riverpod, la sintassi per usare [StateNotifierProvider] è cambiata. -(vedere https://github.com/rrousselGit/riverpod/issues/341 per la spiegazione). +With the release of version `0.14.0` of Riverpod, the syntax for using [StateNotifierProvider] changed +(see https://github.com/rrousselGit/riverpod/issues/341 for the explanation). -Per l'intero articolo, considera leggere [StateNotifier]: +For the entire article, consider the following [StateNotifier]: ```dart class MyModel {} @@ -15,12 +15,12 @@ class MyStateNotifier extends StateNotifier { } ``` -## Cambiamenti +## The changes -- [StateNotifierProvider] accetta un generico parametro extra, che dovrebbe essere il tipo -dello stato del tuo [StateNotifier]. +- [StateNotifierProvider] takes an extra generic parameter, which should be + the type of the state of your [StateNotifier]. - Prima: + Before: ```dart final provider = StateNotifierProvider((ref) { @@ -28,7 +28,7 @@ dello stato del tuo [StateNotifier]. }); ``` - Dopo: + After: ```dart final provider = StateNotifierProvider((ref) { @@ -36,9 +36,9 @@ dello stato del tuo [StateNotifier]. }); ``` -- per ottenere lo [StateNotifier], ora dovresti leggere `myProvider.notifier` invece di solo `myProvider` : +- to obtain the [StateNotifier], you should now read `myProvider.notifier` instead of just `myProvider`: - Prima: + Before: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -46,7 +46,7 @@ dello stato del tuo [StateNotifier]. } ``` - Dopo: + After: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -54,9 +54,9 @@ dello stato del tuo [StateNotifier]. } ``` -- per stare in ascolto di un [StateNotifier], ora dovresti leggere `myProvider` invece di `myProvider.state` : +- to listen to the state of the [StateNotifier], you should now read `myProvider` instead of `myProvider.state`: - Prima: + Before: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -64,7 +64,7 @@ dello stato del tuo [StateNotifier]. } ``` - Dopo: + After: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -72,38 +72,39 @@ dello stato del tuo [StateNotifier]. } ``` -## Utilizzo dello strumento di migrazione per aggiornare i tuoi progetti alla nuova sintassi +## Using the migration tool to automatically upgrade your projects to the new syntax -Con la versione 0.14.0, viene introdotto uno strumento da riga di comando per Riverpod, il quale può aiutarti a migrare i progetti. +With version 0.14.0 came the release of a command line tool for Riverpod, +which can help you migrate your projects. -### Installazione dello strumento +### Installing the command line -Per installare lo strumento di migrazione, eseguire: +To install the migration tool, run: ```sh dart pub global activate riverpod_cli ``` -Dovresti poter eseguire ora: +You should now be able to run: ```sh riverpod --help ``` -### Uso +### Usage -Ora che lo strumento è installato, possiamo iniziare ad utilizzarlo. +Now that the command line is installed, we can start using it. -- Per prima cosa, apri il progetto che vuoi migrare nel tuo terminale. -- **NON** aggiornare Riverpod. - Lo strumento di migrazione aggiornerà la versione di Riverpod per te. -- Assicurati che il tuo progetto non contenga errori. -- Eseguire: +- First, open the project you want to migrate in your terminal. +- **Do not** upgrade Riverpod. + The migration tool will upgrade the version of Riverpod for you. +- Make sure that your project does not contain errors. +- Execute: ```sh riverpod migrate ``` -Lo strumento analizzerà il tuo progetto e ti suggerirà le modifiche. Per esempio potresti vedere: +The tool will then analyze your project and suggest changes. For example you may see: ```diff Widget build(BuildContext context, ScopedReader watch) { @@ -114,7 +115,8 @@ Widget build(BuildContext context, ScopedReader watch) { Accept change (y = yes, n = no [default], A = yes to all, q = quit)? ``` -Per accettare la modifica, premi semplicemente y. In caso contrario, premi n. +To accept the change, simply press y. Otherwise to reject it, press n. -[statenotifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/StateNotifierProvider-class.html + +[statenotifierprovider]: ../providers/state_notifier_provider [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx index 0bd679c83..91fcf0386 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx @@ -1,52 +1,54 @@ --- -title: da ^0.14.0 a ^1.0.0 +title: ^0.14.0 to ^1.0.0 --- -Dopo una lunga attesa, la prima versione stabile di Riverpod è stata finalmente rilasciata 👏 -Per vedere tutta la lista dei cambiamenti, consulta il [Changelog](https://pub.dev/packages/flutter_riverpod/changelog#100). -In questa pagina ci concentreremo su come migrare una applicazione Riverpod esistente -dalla versione 0.14.x alla versione 1.0.0. +After a long wait, the first stable version of Riverpod is finally released 👏 -## Utilizzo dello strumento di migrazione per aggiornare i tuoi progetti alla nuova sintassi +To see the full list of changes, consult the [Changelog](https://pub.dev/packages/flutter_riverpod/changelog#100). +In this page, we will focus on how to migrate an existing Riverpod application +from version 0.14.x to version 1.0.0. -Prima di spiegare i vari cambiamenti, vale la pena far notare che Riverpod ha -uno strumento da riga di comando per migrare automaticamente il tuo progetto. +## Using the migration tool to automatically upgrade your project to the new syntax -### Installazione dello strumento +Before explaining the various changes, it is worth noting that Riverpod comes with +a command-line tool to automatically migrate your project for you. -Per installare lo strumento di migrazione, eseguire: +### Installing the command line tool + +To install the migration tool, run: ```sh dart pub global activate riverpod_cli ``` -Dovresti poter eseguire ora: +You should now be able to run: ```sh riverpod --help ``` -### Uso +### Usage + +Now that the command line is installed, we can start using it. -Ora che lo strumento è installato, possiamo iniziare ad utilizzarlo. +- First, open the project you want to migrate in your terminal. +- **Do not** upgrade Riverpod. + The migration tool will upgrade the version of Riverpod for you. -- Per prima cosa, apri il progetto che vuoi migrare nel tuo terminale. -- **NON** aggiornare Riverpod. - Lo strumento di migrazione aggiornerà la versione di Riverpod per te. - :::danger PERICOLO - Non aggiornare Riverpod è importante. - Lo strumento non si eseguirà correttamente se hai già installato la versione 1.0.0. - Pertanto, assicurati di utilizzare correttamente una versione precedente prima di avviare lo strumento. + :::danger + Not upgrading Riverpod is important. + The tool will not execute properly if you have already installed version 1.0.0. + As such, make sure that you are properly using an older version before starting the tool. ::: -- Assicurati che il tuo progetto non contenga errori. -- Eseguire: +- Make sure that your project does not contain errors. +- Execute: ```sh riverpod migrate ``` -Lo strumento analizzerà il tuo progetto e ti suggerirà le modifiche. Per esempio potresti vedere: +The tool will then analyze your project and suggest changes. For example you may see: ```diff -Widget build(BuildContext context, ScopedReader watch) { @@ -58,25 +60,27 @@ Lo strumento analizzerà il tuo progetto e ti suggerirà le modifiche. Per esemp Accept change (y = yes, n = no [default], A = yes to all, q = quit)? ``` -Per accettare la modifica, premi semplicemente y. In caso contrario, premi n. +To accept the change, simply press y. Otherwise to reject it, press n. -## I cambiamenti +## The changes -Ora che abbiamo visto come utilizzare il terminale per aggiornare il nostro progetto, -vediamo nel dettaglio queste modifiche. +Now that we've seen how to use the CLI to automatically upgrade your project, +let's see in detail the changes necessary. -### Unificazione della sintassi +### Syntax unification -La versione 1.0.0 di Riverpod si concentra sull'unificazione della sintassi -per interagire con i provider. -Prima, Riverpod aveva molte sintassi simili ma diverse per leggere un provider, -come `ref.watch(provider)` vs `useProvider(provider)` vs `watch(provider)`. -Con la versione 1.0.0, rimane solo una sintassi: `ref.watch(provider)`. Le altre sono state rimosse. +Version 1.0.0 of Riverpod focused on the unification of the syntax for +interacting with providers. +Before, Riverpod had many similar yet different syntaxes for reading a provider, +such as `ref.watch(provider)` vs `useProvider(provider)` vs `watch(provider)`. +With version 1.0.0, only one syntax remains: `ref.watch(provider)`. The +others were removed. -Il che significa che: +As such: -- `useProvider` è stato rimosso in favore di `HookConsumerWidget`. - Prima: +- `useProvider` is removed in favor of `HookConsumerWidget`. + + Before: ```dart class Example extends HookWidget { @@ -89,7 +93,7 @@ Il che significa che: } ``` - Dopo: + After: ```dart class Example extends HookConsumerWidget { @@ -102,9 +106,9 @@ Il che significa che: } ``` -- Il prototipo del metodo `build` di `ConsumerWidget` e `Consumer` è stato cambiato. - - Prima: +- The prototype of `ConsumerWidget`'s `build` and `Consumer`'s `builder` changed. + + Before: ```dart class Example extends ConsumerWidget { @@ -123,7 +127,7 @@ Il che significa che: ) ``` - Dopo: + After: ```dart class Example extends ConsumerWidget { @@ -142,9 +146,9 @@ Il che significa che: ) ``` -- `context.read` è sostituito da `ref.read`. +- `context.read` is removed in favor of `ref.read`. - Prima: + Before: ```dart class Example extends StatelessWidget { @@ -157,7 +161,7 @@ Il che significa che: } ``` - Dopo: + After: ```dart class Example extends ConsumerWidget { @@ -170,15 +174,15 @@ Il che significa che: } ``` -### StateProvider +### StateProvider update -[StateProvider] è stato allineato con [StateNotifierProvider]. +[StateProvider] was updated to match [StateNotifierProvider]. -In precedenza, scrivere `ref.watch(StateProvider)` restituiva un'istanza `StateController`. -Ora restituisce solo lo stato di `StateController`. +Before, doing `ref.watch(StateProvider)` returned a `StateController` instance. +Now it only returns the state of the `StateController`. -Per migrare hai alcune soluzioni. -Se il tuo codice otteneva lo stato senza modificarlo, puoi cambiare da: +To migrate you have a few solutions. +If your code only obtained the state without modifying it, you can change from: ```dart final provider = StateProvider(...); @@ -192,7 +196,7 @@ Consumer( ) ``` -a: +to: ```dart final provider = StateProvider(...); @@ -206,8 +210,7 @@ Consumer( ) ``` -Alternativemente, puoi usare il nuovo `StateProvider.state` per mantenere -il vecchio comportamento. +Alternatively you can use the new `StateProvider.state` to keep the old behavior. ```dart final provider = StateProvider(...); @@ -221,6 +224,6 @@ Consumer( ) ``` -[statenotifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/StateNotifierProvider-class.html -[stateprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/StateProvider-class.html +[statenotifierprovider]: ../providers/state_notifier_provider +[stateprovider]: ../providers/state_provider [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx new file mode 100644 index 000000000..69d0f8ab0 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx @@ -0,0 +1,132 @@ +--- +title: Da `ChangeNotifier` +--- + +import old from "!!raw-loader!./from_change_notifier/old.dart"; +import declaration from "./from_change_notifier/declaration"; +import initialization from "./from_change_notifier/initialization"; +import migrated from "./from_change_notifier/migrated"; + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +All'interno di Riverpod, `ChangeNotifierProvider` deve essere utilizzato per offrire una transizione +graduale da pkg:provider. + +Se hai appena iniziato una migrazione verso Riverpod, assicurati di leggere la guida dedicata +(consulta ). +Questo articolo è pensata per chi è già transizionato su Riverpod ma vuole distaccarsi dall'usare +`ChangeNotifier` in modo definitivo. + +Nel complesso, la migrazione da `ChangeNotifier` a `AsyncNotifer` richiede un cambio di paradigma, +ma comporta una grande semplificazione con il codice migrato risultante. +Consulta anche . + +Prendiamo in considerazione questo esempio (difettoso): + + +Questa implementazione mostra diverse lacune di progettazione come: +- L'utilizzo di `isLoading` e `hasError` per gestire differenti casi asincroni +- La necessita di gestire attentamente le richieste attraverso le espressioni `try`/`catch`/`finally` +- La necessita di invocare `notifyListeners` nei momenti giusti per far sì che questa implementazione funzioni +- La presenza di stato incoerenti o possibilmente indesiderabile, ad esempio l'inizializzazione con una lista vuota + +Si noti come questo esempio è stato realizzato per mostrare come `ChangeNotifier` possa portare a scelte +di design difettose per sviluppatori alle prime armi; inoltre, un'altra conclusione è che lo stato mutabile +potrebbe essere molto più difficile di quanto promesso inizialmente. + +`Notifier`/`AsyncNotifer`, in combinazione con lo stato immutabile, può portare a scelte di design migliori +e meno errori. + +Vediamo come migrare lo snippet precedente, un passo alla volta, verso le API più recenti + +## Inizia la tua migrazione + +Per prima cosa, dovremmo dichiarare il nuovo provider / notifier: questo richiede ci richiede una riflessione +su cosa dobbiamo fare che dipende dalla tua unica business logic. + +Riassumiamo le richieste: +- Lo stato è rappresentato con una `List`, che è ottenuta da una chiamata di rete, con nessun parametro +- Lo stato dovrebbe *anche* esporre informazioni sui suoi stati di `loading`, `error` e `data` +- Lo stato può essere mutato attraverso dei metodi esposti, quindi una funzione non è sufficiente + +:::tip +La riflessione appena fatta si riduce alla risposta alle seguenti domande: +1. Sono richiesti dei side effects? + - `y`: Utilizza le API di Riverpod basate su classi + - `n`: Utilizza le API di Riverpod basate sulle funzioni +2. Lo stato necessita di essere caricato in modo asincrono? + - `y`: Permettiamo a `build` di restituire `Future` + - `n`: Permettiamo a `build` di restituire semplicemente `T` +1. Sono richiesti dei parametri? + - `y`: Permettiamo a `build` (o alla tua funzione) di accettarli + - `n`: Non permettiamo a `build` (o alla tua funzione) di accettare parametri extra +::: + +:::info +Se stai utilizzando la generazione di codice, la riflessione precedente è abbastanza. +Non è necessario pensare ai nomi corretti delle classi e alle loro API *specifiche*. +`@riverpod` ti chiede solamente di scrivere una classe con il suo tipo da restituire, e questo basta. +::: + +Tecnicamente, la mossa migliore qui è definire un `AutoDisposeAsyncNotifier>`, +che coprirà tutti i requisiti richiesti. Scriviamo per prima del pseudocodice. + + + +:::tip +Ricorda: utilizza gli snippet nel tuo IDE per avere una sorta di guida, oppure per velocizzare la scrittura del codice. +Consulta . +::: + +Rispetto all'implementazione di `ChangeNotifier`, non abbiamo più bisogno di dichiarare `todos`; +tale variabile è contenuta in `state`, che è implicitamente caricato con `build`. + +Infatti, i notifier di Riverpod possono esporre *una* entità alla volta. + +:::tip +Le API di Riverpod sono pensate per essere granulari, tuttavia, durante la migrazione, puoi comunque definire +un'entità personalizzata per contenere più valori. Inizialmente, valuta l'utilizzo dei +[record di Dart 3](https://dart.dev/language/records) per semplificare la migrazione. +::: + +### Inizializzazione + +Inizializzare un notifier è facile: basta scrivere la logica di inizializzazione dentro il metodo `build`. +Possiamo ora sbarazzarci della vecchia funzione `_init`. + + + +Rispetto alla vecchia funzone `_init`, al nuovo metodo `build` non manca nulla: non c'è più bisogno di +inizializzare variabili come `isLoading` o `hasError`. + +Riverpod tradurrà automaticamente qualsiasi provider asincrono esponendo un `AsyncValue>` e +gestirà le complessità dello stato asincrono in modo decisamente migliore rispetto a quello che possono fare +due semplici variabili booleane. + +Infatti, qualsiasi `AsyncNotifier` rende effettivamente la scrittura aggiuntiva di `try`/`catch`/`finally` +un anti-pattern per la gestione dello stato asincrono. + +### Mutazioni e Side effects + +Proprio come l'inizializzazione, quando si eseguono dei side effects non c'è la necessità di manipolare +variabili booleani come `hasError`, o di scrivere blocchi `try`/`catch`/`finally` aggiuntivi. + +Di seguito, abbiamo tagliato tutto il codice boilerplate e migrato con successo l'esempio di sopra: + + +:::tip +La sintassi e le scelte di progettazione possono variare, ma alla fine, quello di cui abbiamo bisogno +è scrivere le nostre richieste ed aggiornare lo stato in seguito. +Consulta . +::: + +## Riassunto del processo di migrazione + +Rivediamo l'intero processo di migrazione applicato in questa pagina, da un punto di vista operazionale. + +1. Abbiamo spostato l'inizializzazione, da un metodo personalizzato invocato in un costruttore, al metodo `build` +2. Abbiamo rimosso le proprietà `todos`, `isLoading` e `hasError`: la proprietà interna `state` sarà sufficiente +3. Abbiamo rimosso qualsiasi tipo blocco `try`-`catch`-`finally`, restituire il future è sufficiente +4. Abbiamo applicato la stessa simplificazione sui side effects (`addTodo`) +5. Abbiamo applicato le mutazioni, semplicemente riassegnando `state` diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart new file mode 100644 index 000000000..b3ca06ef2 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart @@ -0,0 +1,33 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'declaration.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() { + // TODO ... + return []; + } + + Future addTodo(Todo todo) async { + // TODO + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart new file mode 100644 index 000000000..317354e31 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'declaration.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'fc9a07f8ef9f792da2ac660d76ea0a809335ba18'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeAsyncNotifierProvider>.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx new file mode 100644 index 000000000..1ad659c31 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./declaration.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart new file mode 100644 index 000000000..c7485bbba --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart @@ -0,0 +1,33 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends AutoDisposeAsyncNotifier> { + @override + FutureOr> build() { + // TODO ... + return []; + } + + Future addTodo(Todo todo) async { + // TODO + } +} + +final myNotifierProvider = AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx new file mode 100644 index 000000000..3b3fbd2cb --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./initialization.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart new file mode 100644 index 000000000..4da805e13 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart @@ -0,0 +1,29 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'initialization.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + return [...json.map(Todo.fromJson)]; + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart new file mode 100644 index 000000000..376ce998f --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'initialization.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'1c67c12443102cf8c43efbf6c630d3028d9847c3'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeAsyncNotifierProvider>.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart new file mode 100644 index 000000000..24ab265f7 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart @@ -0,0 +1,29 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends AutoDisposeAsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + return [...json.map(Todo.fromJson)]; + } +} + +final myNotifierProvider = AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx new file mode 100644 index 000000000..075bfbdf5 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./migrated.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart new file mode 100644 index 000000000..b8f4ba829 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart @@ -0,0 +1,37 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'migrated.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + Future addTodo(Todo todo) async { + // optional: state = const AsyncLoading(); + final json = await http.post('api/todos'); + final newTodos = [...json.map(Todo.fromJson)]; + state = AsyncData(newTodos); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart new file mode 100644 index 000000000..8eaddcfd9 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'migrated.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'bde95c56aa12eff7c8c01ede57ae4ad2b616c225'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeAsyncNotifierProvider>.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart new file mode 100644 index 000000000..8572db71d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart @@ -0,0 +1,37 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends AutoDisposeAsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + Future addTodo(Todo todo) async { + // optional: state = const AsyncLoading(); + final json = await http.post('api/todos'); + final newTodos = [...json.map(Todo.fromJson)]; + state = AsyncData(newTodos); + } +} + +final myNotifierProvider = AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart new file mode 100644 index 000000000..4e65e823d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart @@ -0,0 +1,60 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyChangeNotifier extends ChangeNotifier { + MyChangeNotifier() { + _init(); + } + List todos = []; + bool isLoading = true; + bool hasError = false; + + Future _init() async { + try { + final json = await http.get('api/todos'); + todos = [...json.map(Todo.fromJson)]; + } on Exception { + hasError = true; + } finally { + isLoading = false; + notifyListeners(); + } + } + + Future addTodo(int id) async { + isLoading = true; + notifyListeners(); + + try { + final json = await http.post('api/todos'); + todos = [...json.map(Todo.fromJson)]; + hasError = false; + } on Exception { + hasError = true; + } finally { + isLoading = false; + notifyListeners(); + } + } +} + +final myChangeProvider = ChangeNotifierProvider((ref) { + return MyChangeNotifier(); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx new file mode 100644 index 000000000..23f96416f --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx @@ -0,0 +1,264 @@ +--- +title: Da `StateNotifier` +--- + +import buildInit from "./from_state_notifier/build_init"; +import buildInitOld from "!!raw-loader!./from_state_notifier/build_init_old.dart"; +import consumersDontChange from "!!raw-loader!./from_state_notifier/consumers_dont_change.dart"; +import familyAndDispose from "./from_state_notifier/family_and_dispose"; +import familyAndDisposeOld from "!!raw-loader!./from_state_notifier/family_and_dispose_old.dart"; +import asyncNotifier from "./from_state_notifier/async_notifier"; +import asyncNotifierOld from "!!raw-loader!./from_state_notifier/async_notifier_old.dart"; +import addListener from "./from_state_notifier/add_listener"; +import addListenerOld from "!!raw-loader!./from_state_notifier/add_listener_old.dart"; +import fromStateProvider from "./from_state_notifier/from_state_provider"; +import fromStateProviderOld from "!!raw-loader!./from_state_notifier/from_state_provider_old.dart"; +import oldLifecycles from "./from_state_notifier/old_lifecycles"; +import oldLifecyclesOld from "!!raw-loader!./from_state_notifier/old_lifecycles_old.dart"; +import oldLifecyclesFinal from "./from_state_notifier/old_lifecycles_final"; +import obtainNotifierOnTests from "!!raw-loader!./from_state_notifier/obtain_notifier_on_tests.dart"; + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +Con [Riverpod 2.0](https://pub.dev/packages/flutter_riverpod/changelog#200), nuovi classi +sono state introdotte: `Notifier` / `AsyncNotifer`. +`StateNotifier` è ora sconsigliato a favore di queste nuove API. + +Questa pagina mostra come migrare dal deprecato `StateNotifier` a queste nuove API. + +Il beneficio principale introdotto da `AsyncNotifier` è un migliore supporto per operazioni `async`; +infatti, `AsyncNotifier` può essere pensato come un `FutureProvider` che espone dei modi per essere modificato dall'UI. + +Inoltre, il nuovo `(Async)Notifier`: + +- Espone un'oggetto `Ref` dentro la sua classe +- Offre una sintassi simile tra gli approcci con o senza generazione di codice +- Offre una sintassi simile tra le sue versioni sync e async. +- Sposta la logica dai Provider e la centralizza dentro gli stessi Notifier + +Vediamo come definire un `Notifier`, le differenze con `StateNotifier` e come migrare al nuovo +`AsyncNotifier` per lo stato asincrono. + +## Confronto della nuova sintassi + +Assicurati di sapere come definire un `Notifier` prima di tuffarti in questo confronto. +Consulta . + +Scriviamo un esempio, utilizzando la vecchia sintassi di `StateNotifier`: + + +Di seguito lo stesso esempio, costruito con le nuove API `Notifier` che si traduce approssimativamente in: + + +Confrontando `Notifier` e `StateNotifier`, si possono osservare queste differenze principali: + +- Le dipendenze reattive di `StateNotifier` sono dichiarate nel suo provider, mentre `Notifier` + centralizza questa logica nel suo metodo `build` +- L'intero processo di inizializzazione di `StateNotifier` è diviso tra il suo provider e il suo costruttore, + mentre `Notifier` riserva un unico posto in cui collocare tale logica +- Si noti come, a differenza di `StateNotifier`, nessuna logica viene mai scritta nel costruttore di un `Notifier` + +Conclusioni simili possono essere fatte con `AsyncNotifer`, ovvero l'equivalente `Notifier` per operazioni asincrone. + +## Migrare `StateNotifier` asincroni + +L'aspetto più interessante della nuova sintassi API è una DX migliorata sui dati asincroni. +Prendiamo il seguente esempio: + + + +Di seguito l'esempio precedente riscritto con le nuove API `AsyncNotifier`: + + + +`AsyncNotifier`, proprio come `Notifier`, introduce una più semplice ed uniforme API. +Qui è facile osservare come `AsyncNotifer` sia un `FutureProvider` con dei metodi. + +`AsyncNotifer` viene fornito con una serie di utilità e getters che `StateNotifier` non possiede, come +[`future`](https://pub.dev/documentation/riverpod/latest/riverpod/AutoDisposeAsyncNotifier/future.html) e +[`update`](https://pub.dev/documentation/riverpod/latest/riverpod/AutoDisposeAsyncNotifier/update.html). +Ciò ci permette di scrivere della logica più semplice quando gestiamo mutazioni asincrone e side-effects. +Vedere anche . + +:::tip +Migrare da `StateNotifier>` a `AsyncNotifer` si riduce a: + +- Mettere la logica di inizializzazione dentro `build` +- Rimuovere qualsiasi blocco `catch`/`try` in inizializzazione o nei metodi di side-effects +- Rimuovere qualsiasi `AsyncValue.guard` da `build`, poiché converte `Future` in `AsyncValue` +::: + +### Vantaggi + +Dopo questi esempi, evidenziamo ora i principali vantaggi di `Notifier` e `AsyncNotifier`: +- La nuova sintassi dovrebbe sembrare più semplice e più leggibile, specialmente per lo stato asincrono +- È probabile che le nuove API abbiano meno codice boilerplate in generale +- La sintassi ora è unificata, abilitando la generazione di codice; non importa la tipologia di provider che stai scrivendo +(consulta ) + +Addentriamoci ed evidenziamo più differenze e somiglianze. + +## Modifiche esplicite a `.family` e `.autoDispose` + +Un'altra importante differenza è come sono gestite le family e la funzionalità di auto dispose con le nuove API. + +`Notifier` ha le sue personali controparti di `.family` e `.autoDispose`, come `FamilyNotifier` +e `AutoDisposeNotifier`. +Come sempre, queste modifiche possono essere combinate (aka `AutoDisposeFamilyNotifier`). +`AsyncNotifer` ha le sue controparti asincrone equivalenti, (`AutoDisposeFamilyAsyncNotifier`). + +Questi modificatori sono esplicitamente dichiarati dentro la classe; qualsiasi parametro è iniettato direttamente +nel metodo `build` in modo tale da essere disponibile alla logica di inizializzazione. +Tutto questo dovrebbe portare una maggiore leggibilità, concisione e in generale meno errori. + +Prendiamo l'esempio seguente, dove un `StateNotifierProvider.family` viene definito. + + +`BugsEncounteredNotifier` sembra... pesante / difficile da leggere. +Diamo un'occhiata alla sua controparte `AsyncNotifier` migrata: + + + +La sua controparte migrata dovrebbe fornire una maggiore facilità di lettura. + +:::info +I parametri `.family` di `(Async)Notifier` sono disponibili tramite `this.arg` +(oppure tramite `this.paramName` quando si utilizza la generazione di codice) +::: + +## I cicli di vita hanno un comportamento differente + +I cicli di vita tra `Notifier`/`AsyncNotifier` e `StateNotifier` differiscono in modo sostanziale. + +Questo esempio mostra - di nuovo - come le vecchie API abbiano la logica sparsa: + + + +Qui, se `durationProvider` si aggiorna, `MyNotifier` _elimina_: la sua istanza è poi re-istanziata +e il suo stato interno è quindi re-inizializzato. +Inoltre, a differenza di tutti gli altri provider, la callback `dispose` deve essere definita +separatamente nella classe. +Infine, è ancora possibile scrivere `ref.onDispose` nel suo provider, mostrando ancora una volta come +possa essere sparsa la logica con quest'API; potenzialmente, lo sviluppatore potrebbe dover guardare otto (8!) +posti differenti per capire il comportamento di questo Notifier! + +Queste ambiguità sono risolte con `Riverpod 2.0`. + +### Vecchio `dispose` vs `ref.onDispose` +Il metodo `dispose` di `StateNotifier` si riferisce all'evento di distruzione del notificatore stesso, +ovvero è una callback che viena chiamata *prima di sbarazzarsi di se stesso*. + +Gli `(Async)Notifier` non hanno questa proprietà, dato che *non vengono distrutti durante la ricostruzione*; +solo il suo *stato interno* lo è. +Nei nuovi notifier, i cicli di vita di eliminazione sono gestiti in _un_ solo posto, tramite `ref.onDispose` +(e altri), proprio come qualsiasi altro provider. +Questo semplifica l'API, e, si spera la developer experience, in modo che ci sia solo _un_ posto a cui guardare +per comprendere gli effetti collaterali del ciclo di vita: il suo metodo `build`. + +In breve: per registrare una callback che si attiva prima che il suo *stato interno* venga ricostruito, possiamo usare +`ref.onDispose` come ogni altro provider. + +Puoi migrare lo snippet sopra in questo modo: + + + +In questo ultimo snippet abbiamo sicuramente introdotto della semplificazione, ma rimane ancora un problema: non +possiamo capire se i nostri notifier sono ancora attivi o no mentre eseguiamo `update`. +Ciò potrebbe verificare uno `StateError` indesiderato. + +### Non più `mounted` + +Questo accade perché `(Async)Notifier` manca della proprietà `mounted`, che era disponibile con `StateNotifier`. +Considerando la loro differenza nel ciclo di vita, questo ha perfettamente senso; seppur possibile, una +proprietà `mounted` sarebbe fuorviante sui nuovi notifier: `mounted` sarebbe *quasi sempre* `true`. + +Anche se sarebbe possibile creare una [soluzione alternativa personalizzata](https://github.com/rrousselGit/riverpod/issues/1879#issuecomment-1303189191), +si consiglia di aggirare questo problema annullando l'operazione asincrona. + +Annullare un'operazione può essere fatto con un [Completer](https://api.flutter.dev/flutter/dart-async/Completer-class.html) personalizzato, +o qualsiasi derivato personalizzato. + +Per esempio, se stai utilizzando `Dio` per eseguire richieste di rete, considera l'utilizzo di un [cancel token](https://pub.dev/documentation/dio/latest/dio/CancelToken-class.html) +(consulta anche ). + +Pertanto, l'esempio precedente viene migrato nel seguente: + + +## Le API di mutazione sono le stesse di prima + +Finora abbiamo mostrato le differenze tra `StateNotifier` e le nuove API. +Una cosa che invece `Notifier`, `AsyncNotifer` e `StateNotifier` condividono è il modo in cui i loro stati +possono essere consumati e mutati. + +I consumer possono ottenere dati da questi tre provider con la stessa sintassi, il che è ottimo nel caso +tu stai migrando da `StateNotifier`; questo si applica anche ai metodi dei notifier. + + + +## Altre migrazioni + +Esploriamo ora le differenze meno impattanti tra `StateNotifier` e `Notifier` (o `AsyncNotifier`) + +### Da `.addListener` e `.stream` + +`.addListener` e `.stream` di `StateNotifier` possono essere utilizzati per ascoltare i cambiamenti di stato. +Queste due API sono ormai da considerarsi superate. + +Ciò è intenzionale a causa del desiderio di raggiungere la completa uniformità dell'API con `Notifier`, `AsyncNotifier` e altri provider. +Infatti, l'utilizzo di un `Notifier` o di un `AsyncNotifier` non dovrebbe essere diverso da qualsiasi altro provider. + +Pertanto questo: + + +Diviene questo: + + +In poche parole: se vuoi ascoltare un `Notifier`/`AsyncNotifer`, usa semplicemente `ref.listen`. +Consulta . + +### Da `.debugState` nei test + +`StateNotifier` espone `.debugState`: questa proprietà è usata per gli utenti di [state_notifier](https://pub.dev/packages/state_notifier) +per abilitare l'accesso allo stato da fuori la classe quando si è in dev mode, per scopi di testing. + +Se stai utilizzando `.debugState` per accedere allo stato nei test, ci sono probabilità che tu debba abbandonare +questo approccio. + +`Notifier` / `AsyncNotifer` non hanno una prorpietà `.debugState`; invece, espongono direttamente `.state`, +che è `@visibleForTesting`. + +:::danger +EVITA di accedere a `.state` dai test; se devi farlo, fallo _solo e solo se_ hai già un +a `Notifier` / `AsyncNotifer` correttamente istanziato; solo dopo, puoi accedere a `.state` +all'interno dei test liberamente. + +Infatti, `Notifier` / `AsyncNotifier` _non dovrebbero_ essere istanziati a mano; al contrario, dovrebbero +essere interagiti utilizzando il relativo provider: non farlo *romperà* il notifier, a causa della mancata +inizializzazione di 'ref' e dei parametri family. +::: + +Non hai un'istanza `Notifier`? +Nessun problema, puoi ottenerne una con `ref.read`, proprio come leggeresti il suo stato esposto: + + + +Impara di più sui test nella loro guida dedicata. Consulta . + +### Da `StateProvider` + +`StateProvider` è stato esposto da Riverpod fin dalla sua release, ed era stato fatto per ridurre le +linee di codice per le versioni semplificate di `StateNotifierProvider`. +Dato che `StateNotifierProvider` è deprecato, anche `StateProvider` va evitato. +Inoltre, ad oggi, non c'è nessun equivalente di `StateProvider` per le nuove API. + +Ciò nonostante, migrare da `StateProvider` a `Notifier` è semplice. + +Questo: + + +Diventa: + + +Anche se ci costa qualche LoC in più, la migrazione da `StateProvider` +ci consente di archiviare definitivamente `StateNotifier`. diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart new file mode 100644 index 000000000..ead1c72d8 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart @@ -0,0 +1,18 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'add_listener.g.dart'; + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + ref.listenSelf((_, next) => debugPrint('$next')); + return 0; + } + + void add() => state++; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart new file mode 100644 index 000000000..161b3bba0 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'add_listener.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'9acd382ed579c545ace755687b155e28eba01d22'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx new file mode 100644 index 000000000..6d7ac6d37 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./add_listener.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart new file mode 100644 index 000000000..e25b4a181 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart @@ -0,0 +1,17 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + ref.listenSelf((_, next) => debugPrint('$next')); + return 0; + } + + void add() => state++; +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart new file mode 100644 index 000000000..1f020617c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart @@ -0,0 +1,24 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class MyNotifier extends StateNotifier { + MyNotifier() : super(0); + + void add() => state++; +} + +final myNotifierProvider = StateNotifierProvider((ref) { + final notifier = MyNotifier(); + + final cleanup = notifier.addListener((state) => debugPrint('$state')); + ref.onDispose(cleanup); + + // O in modo equivalente: + // final listener = notifier.stream.listen((event) => debugPrint('$event')); + // ref.onDispose(listener.cancel); + + return notifier; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart new file mode 100644 index 000000000..5ead76378 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_notifier.g.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class AsyncTodosNotifier extends _$AsyncTodosNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + // ... +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart new file mode 100644 index 000000000..25bcda60d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -0,0 +1,29 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$asyncTodosNotifierHash() => + r'10207327c7dee180e9da8beece5bfffedcf86e98'; + +/// See also [AsyncTodosNotifier]. +@ProviderFor(AsyncTodosNotifier) +final asyncTodosNotifierProvider = + AutoDisposeAsyncNotifierProvider>.internal( + AsyncTodosNotifier.new, + name: r'asyncTodosNotifierProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$asyncTodosNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$AsyncTodosNotifier = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx new file mode 100644 index 000000000..a0ff513c3 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./async_notifier.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart new file mode 100644 index 000000000..52da61d76 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart @@ -0,0 +1,29 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class AsyncTodosNotifier extends AsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + // ... +} + +final asyncTodosNotifier = AsyncNotifierProvider>( + AsyncTodosNotifier.new, +); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart new file mode 100644 index 000000000..50d7f4aed --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart @@ -0,0 +1,30 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class AsyncTodosNotifier extends StateNotifier>> { + AsyncTodosNotifier() : super(const AsyncLoading()) { + _postInit(); + } + + Future _postInit() async { + state = await AsyncValue.guard(() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + }); + } + + // ... +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart new file mode 100644 index 000000000..3e2303b7a --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart @@ -0,0 +1,15 @@ +// ignore_for_file: avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'build_init.g.dart'; + +/* SNIPPET START */ +@riverpod +class CounterNotifier extends _$CounterNotifier { + @override + int build() => 0; + + void increment() => state++; + void decrement() => state++; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart new file mode 100644 index 000000000..6b4621ecb --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart @@ -0,0 +1,28 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'build_init.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterNotifierHash() => r'8d4e4011da15a0ef79af9622336839a0c9e406ab'; + +/// See also [CounterNotifier]. +@ProviderFor(CounterNotifier) +final counterNotifierProvider = + AutoDisposeNotifierProvider.internal( + CounterNotifier.new, + name: r'counterNotifierProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$counterNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$CounterNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx new file mode 100644 index 000000000..276a143ac --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./build_init.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart new file mode 100644 index 000000000..0ba8eebed --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart @@ -0,0 +1,15 @@ +// ignore_for_file: avoid_print + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +class CounterNotifier extends Notifier { + @override + int build() => 0; + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = NotifierProvider(CounterNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart new file mode 100644 index 000000000..82a8c54bd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart @@ -0,0 +1,13 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +class CounterNotifier extends StateNotifier { + CounterNotifier() : super(0); + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = StateNotifierProvider((ref) { + return CounterNotifier(); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart new file mode 100644 index 000000000..6a964a5a6 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart @@ -0,0 +1,36 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class CounterNotifier extends StateNotifier { + CounterNotifier() : super(0); + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = StateNotifierProvider((ref) { + return CounterNotifier(); +}); + +/* SNIPPET START */ +class SomeConsumer extends ConsumerWidget { + const SomeConsumer({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + /* highlight-start */ + final counter = ref.watch(counterNotifierProvider); + /* highlight-end */ + return Column( + children: [ + Text("You've counted up until $counter, good job!"), + TextButton( + /* highlight-start */ + onPressed: ref.read(counterNotifierProvider.notifier).increment, + /* highlight-end */ + child: const Text('Count even more!'), + ) + ], + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart new file mode 100644 index 000000000..9a695614c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'family_and_dispose.g.dart'; + +/* SNIPPET START */ +@riverpod +class BugsEncounteredNotifier extends _$BugsEncounteredNotifier { + @override + FutureOr build(String featureId) { + return 99; + } + + Future fix(int amount) async { + final old = await future; + final result = await ref.read(taskTrackerProvider).fix(id: this.featureId, fixed: amount); + state = AsyncData(max(old - result, 0)); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart new file mode 100644 index 000000000..cbcfb779b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -0,0 +1,219 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family_and_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$bugsEncounteredNotifierHash() => + r'c76e924f84db91c57d226896b062d9f4e8ab79e5'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +abstract class _$BugsEncounteredNotifier + extends BuildlessAutoDisposeAsyncNotifier { + late final String featureId; + + FutureOr build( + String featureId, + ); +} + +/// See also [BugsEncounteredNotifier]. +@ProviderFor(BugsEncounteredNotifier) +const bugsEncounteredNotifierProvider = BugsEncounteredNotifierFamily(); + +/// See also [BugsEncounteredNotifier]. +class BugsEncounteredNotifierFamily extends Family { + /// See also [BugsEncounteredNotifier]. + const BugsEncounteredNotifierFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'bugsEncounteredNotifierProvider'; + + /// See also [BugsEncounteredNotifier]. + BugsEncounteredNotifierProvider call( + String featureId, + ) { + return BugsEncounteredNotifierProvider( + featureId, + ); + } + + @visibleForOverriding + @override + BugsEncounteredNotifierProvider getProviderOverride( + covariant BugsEncounteredNotifierProvider provider, + ) { + return call( + provider.featureId, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(BugsEncounteredNotifier Function() create) { + return _$BugsEncounteredNotifierFamilyOverride(this, create); + } +} + +class _$BugsEncounteredNotifierFamilyOverride implements FamilyOverride { + _$BugsEncounteredNotifierFamilyOverride(this.overriddenFamily, this.create); + + final BugsEncounteredNotifier Function() create; + + @override + final BugsEncounteredNotifierFamily overriddenFamily; + + @override + BugsEncounteredNotifierProvider getProviderOverride( + covariant BugsEncounteredNotifierProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [BugsEncounteredNotifier]. +class BugsEncounteredNotifierProvider + extends AutoDisposeAsyncNotifierProviderImpl { + /// See also [BugsEncounteredNotifier]. + BugsEncounteredNotifierProvider( + String featureId, + ) : this._internal( + () => BugsEncounteredNotifier()..featureId = featureId, + from: bugsEncounteredNotifierProvider, + name: r'bugsEncounteredNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$bugsEncounteredNotifierHash, + dependencies: BugsEncounteredNotifierFamily._dependencies, + allTransitiveDependencies: + BugsEncounteredNotifierFamily._allTransitiveDependencies, + featureId: featureId, + ); + + BugsEncounteredNotifierProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.featureId, + }) : super.internal(); + + final String featureId; + + @override + FutureOr runNotifierBuild( + covariant BugsEncounteredNotifier notifier, + ) { + return notifier.build( + featureId, + ); + } + + @override + Override overrideWith(BugsEncounteredNotifier Function() create) { + return ProviderOverride( + origin: this, + override: BugsEncounteredNotifierProvider._internal( + () => create()..featureId = featureId, + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + featureId: featureId, + ), + ); + } + + @override + (String,) get argument { + return (featureId,); + } + + @override + AutoDisposeAsyncNotifierProviderElement + createElement() { + return _BugsEncounteredNotifierProviderElement(this); + } + + BugsEncounteredNotifierProvider _copyWith( + BugsEncounteredNotifier Function() create, + ) { + return BugsEncounteredNotifierProvider._internal( + () => create()..featureId = featureId, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + featureId: featureId, + ); + } + + @override + bool operator ==(Object other) { + return other is BugsEncounteredNotifierProvider && + other.featureId == featureId; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, featureId.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin BugsEncounteredNotifierRef on AutoDisposeAsyncNotifierProviderRef { + /// The parameter `featureId` of this provider. + String get featureId; +} + +class _BugsEncounteredNotifierProviderElement + extends AutoDisposeAsyncNotifierProviderElement with BugsEncounteredNotifierRef { + _BugsEncounteredNotifierProviderElement(super.provider); + + @override + String get featureId => (origin as BugsEncounteredNotifierProvider).featureId; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx new file mode 100644 index 000000000..0780f2135 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./family_and_dispose.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart new file mode 100644 index 000000000..8dfce9447 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart @@ -0,0 +1,27 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +/* SNIPPET START */ +class BugsEncounteredNotifier extends AutoDisposeFamilyAsyncNotifier { + @override + FutureOr build(String featureId) { + return 99; + } + + Future fix(int amount) async { + final old = await future; + final result = await ref.read(taskTrackerProvider).fix(id: this.arg, fixed: amount); + state = AsyncData(max(old - result, 0)); + } +} + +final bugsEncounteredNotifierProvider = + AsyncNotifierProvider.family.autoDispose( + BugsEncounteredNotifier.new, +); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart new file mode 100644 index 000000000..28f93a65c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart @@ -0,0 +1,30 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../utils.dart'; + +/* SNIPPET START */ +class BugsEncounteredNotifier extends StateNotifier> { + BugsEncounteredNotifier({ + required this.ref, + required this.featureId, + }) : super(const AsyncData(99)); + final String featureId; + final Ref ref; + + Future fix(int amount) async { + state = await AsyncValue.guard(() async { + final old = state.requireValue; + final result = await ref.read(taskTrackerProvider).fix(id: featureId, fixed: amount); + return max(old - result, 0); + }); + } +} + +final bugsEncounteredNotifierProvider = + StateNotifierProvider.family.autoDispose((ref, id) { + return BugsEncounteredNotifier(ref: ref, featureId: id); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart new file mode 100644 index 000000000..2c71d6144 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'from_state_provider.g.dart'; + +/* SNIPPET START */ +@riverpod +class CounterNotifier extends _$CounterNotifier { + @override + int build() => 0; + + @override + set state(int newState) => super.state = newState; + int update(int Function(int state) cb) => state = cb(state); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart new file mode 100644 index 000000000..9a3edeebc --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -0,0 +1,28 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'from_state_provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterNotifierHash() => r'b32033040f0fff627f1a6dfd9cfb4e93a842390b'; + +/// See also [CounterNotifier]. +@ProviderFor(CounterNotifier) +final counterNotifierProvider = + AutoDisposeNotifierProvider.internal( + CounterNotifier.new, + name: r'counterNotifierProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$counterNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$CounterNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx new file mode 100644 index 000000000..f59794999 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./from_state_provider.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart new file mode 100644 index 000000000..97e4564f3 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart @@ -0,0 +1,13 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +class CounterNotifier extends Notifier { + @override + int build() => 0; + + @override + set state(int newState) => super.state = newState; + int update(int Function(int state) cb) => state = cb(state); +} + +final counterNotifierProvider = NotifierProvider(CounterNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart new file mode 100644 index 000000000..246f44a0c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart @@ -0,0 +1,6 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +final counterProvider = StateProvider((ref) { + return 0; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart new file mode 100644 index 000000000..4a0d4e07c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart @@ -0,0 +1,33 @@ +// ignore_for_file: unused_local_variable,omit_local_variable_types + +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class MyNotifier extends AutoDisposeNotifier { + @override + int build() { + return 0; + } +} + +final myNotifierProvider = NotifierProvider.autoDispose(MyNotifier.new); + +/* SNIPPET START */ +void main(List args) { + test('my test', () { + final container = ProviderContainer(); + addTearDown(container.dispose); + + // Ottenendo un notifier + /* highlight-start */ + final AutoDisposeNotifier notifier = container.read(myNotifierProvider.notifier); + /* highlight-end */ + + // Ottenendo il suo stato esposto + /* highlight-start */ + final int state = container.read(myNotifierProvider); + /* highlight-end */ + + // TODO scrivi i tuoi test + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx new file mode 100644 index 000000000..9b77f551a --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./old_lifecycles.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart new file mode 100644 index 000000000..7da7d4adc --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart @@ -0,0 +1,36 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'old_lifecycles.g.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // Basta leggere/scrivere il codice qui, in un posto + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); + // `mounted` non è più necessario! + state++; // This might throw. + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart new file mode 100644 index 000000000..d28e242a3 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'old_lifecycles.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'0495c52ce893ee0304d4d5ac5648c634ed4a241e'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart new file mode 100644 index 000000000..691d71af9 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart @@ -0,0 +1,35 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + // Just read/write the code here, in one place + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); + // `mounted` is no more! + state++; // This might throw. + } +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx new file mode 100644 index 000000000..9823b1564 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./old_lifecycles_final.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart new file mode 100644 index 000000000..e343cdaa7 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart @@ -0,0 +1,38 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'old_lifecycles_final.g.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // Legge/scrive il codice solamente qui, in un posto unico + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + final cancelToken = CancelToken(); + ref.onDispose(cancelToken.cancel); + await ref.read(repositoryProvider).update(state + 1, token: cancelToken); + // Quando `cancelToken.cancel` è invocato, una Exception personalizzata viene generata + state++; + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart new file mode 100644 index 000000000..7c55609e1 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'old_lifecycles_final.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'8ea2586ea29d12306efd4b8b847142136dd20338'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart new file mode 100644 index 000000000..09aa16913 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart @@ -0,0 +1,36 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + // Legge/scrive il codice solamente qui, in un posto unico + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + final cancelToken = CancelToken(); + ref.onDispose(cancelToken.cancel); + await ref.read(repositoryProvider).update(state + 1, token: cancelToken); + state++; + } +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart new file mode 100644 index 000000000..8f6eaa485 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart @@ -0,0 +1,42 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends StateNotifier { + MyNotifier(this.ref, this.period) : super(0) { + // 1 init logic + _timer = Timer.periodic(period, (t) => update()); // 2 side effect on init + } + final Duration period; + final Ref ref; + late final Timer _timer; + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); // 3 mutation + if (mounted) state++; // 4 check for mounted props + } + + @override + void dispose() { + _timer.cancel(); // 5 custom dispose logic + super.dispose(); + } +} + +final myNotifierProvider = StateNotifierProvider((ref) { + // 6 provider definition + final period = ref.watch(durationProvider); // 7 reactive dependency logic + return MyNotifier(ref, period); // 8 pipe down `ref` +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.dart new file mode 100644 index 000000000..e515b6f94 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.dart @@ -0,0 +1,23 @@ +import 'dart:math' as math; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +final randomProvider = Provider((ref) { + return math.Random().nextInt(6); +}); + +final taskTrackerProvider = Provider((ref) { + return TaskTrackerRepo(); +}); + +class TaskTrackerRepo { + Future fix({required String id, required int fixed}) async => 0; +} + +final durationProvider = Provider((ref) { + return Duration.zero; +}); + +final availableWaterProvider = Provider((ref) { + return 40; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx new file mode 100644 index 000000000..5143f6f51 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx @@ -0,0 +1,55 @@ +--- +title: ChangeNotifierProvider +--- + +import CodeBlock from "@theme/CodeBlock"; +import todos from "!!raw-loader!/docs/providers/change_notifier_provider/todos.dart"; +import todosConsumer from "!!raw-loader!/docs/providers/change_notifier_provider/todos_consumer.dart"; +import { trimSnippet } from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + +`ChangeNotifierProvider` (flutter_riverpod/hooks_riverpod only) is a provider that +is used to listen to and expose a [ChangeNotifier] from Flutter itself. + +Using `ChangeNotifierProvider` is discouraged by Riverpod and exists primarily for: + +- an easy transition from `package:provider` when using its `ChangeNotifierProvider` +- supporting mutable state, even though immutable state is preferred + +:::info +Prefer using [NotifierProvider] instead. +Consider using `ChangeNotifierProvider` only if you are absolutely certain +that you want mutable state. +::: + +Using mutable state instead of immutable state can sometimes be more efficient. +The downside is, it can be harder to maintain and may break various features. +For example, using `provider.select` to optimize rebuilds of your widgets +may not work if your state is mutable, as `select` will think that the value +hasn't changed. +As such, using immutable data structures can sometimes be faster. Therefore +it is important to make benchmarks specific to your use-case, to make sure +that you are truly gaining performance by using `ChangeNotifierProvider`. + +As a usage example, we could use `ChangeNotifierProvider` to implement a todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: + +{trimSnippet(todos)} + +Now that we have defined a `ChangeNotifierProvider`, we can use it to interact +with the list of todos in our UI: + +{trimSnippet(todosConsumer)} + +[state_notifier]: https://pub.dev/packages/state_notifier +[statenotifierprovider]: ./state_notifier_provider +[notifierprovider]: ./notifier_provider +[changenotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html +[provider]: ./provider +[futureprovider]: ./future_provider diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart new file mode 100644 index 000000000..d766920b1 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart @@ -0,0 +1,45 @@ +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +class Todo { + Todo({ + required this.id, + required this.description, + required this.completed, + }); + + String id; + String description; + bool completed; +} + +class TodosNotifier extends ChangeNotifier { + final todos = []; + + // Let's allow the UI to add todos. + void addTodo(Todo todo) { + todos.add(todo); + notifyListeners(); + } + + // Let's allow removing todos + void removeTodo(String todoId) { + todos.remove(todos.firstWhere((element) => element.id == todoId)); + notifyListeners(); + } + + // Let's mark a todo as completed + void toggle(String todoId) { + final todo = todos.firstWhere((todo) => todo.id == todoId); + todo.completed = !todo.completed; + notifyListeners(); + } +} + +// Finally, we are using ChangeNotifierProvider to allow the UI to interact with +// our TodosNotifier class. +final todosProvider = ChangeNotifierProvider((ref) { + return TodosNotifier(); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart new file mode 100644 index 000000000..beac13f4e --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart @@ -0,0 +1,32 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'todos.dart'; + +/* SNIPPET START */ + +class TodoListView extends ConsumerWidget { + const TodoListView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // rebuild the widget when the todo list changes + List todos = ref.watch(todosProvider).todos; + + // Let's render the todos in a scrollable list view + return ListView( + children: [ + for (final todo in todos) + CheckboxListTile( + value: todo.completed, + // When tapping on the todo, change its completed status + onChanged: (value) => + ref.read(todosProvider.notifier).toggle(todo.id), + title: Text(todo.description), + ), + ], + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider.mdx index ebe81b41f..6f114320a 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider.mdx @@ -3,53 +3,60 @@ title: FutureProvider version: 1 --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import configProvider from "/docs/providers/future_provider/config_provider"; -import configConsumer from "/docs/providers/future_provider/config_consumer"; -import { trimSnippet,AutoSnippet} from "../../../../../src/components/CodeSnippet"; +import configProvider from "./future_provider/config_provider"; +import configConsumer from "./future_provider/config_consumer"; +import { AutoSnippet} from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -`FutureProvider` è l'equivalente di [Provider] ma per il codice asincrono. +`FutureProvider` is the equivalent of [Provider] but for asynchronous code. -`FutureProvider` è tipicamente usato per: +`FutureProvider` is typically used for: -- eseguire e memorizzare nella cache operazioni asincrone (come le richieste di rete) -- gestire ottimamente gli stati di errore/caricamento delle operazioni asincrone -- combinare più valori asincroni in un altro valore +- performing and caching asynchronous operations (such as network requests) +- nicely handling error/loading states of asynchronous operations +- combining multiple asynchronous values into another value -`FutureProvider` è ottimo quando combinato con [ref.watch]. Tale combinazione consente il ri-ottenimento automatico -dei dati al variare di alcune variabili, assicurando che si abbia sempre il valore più aggiornato. +`FutureProvider` gains a lot when combined with [ref.watch]. This combination +allows automatic re-fetching of some data when some variables change, +ensuring that we always have the most up-to-date value. :::info -`FutureProvider` non offre un modo per modificare direttamente il calcolo (o computazione) dopo un'interazione dell'utente. -È invece progettato per risolvere semplici casi d'uso. -Per scenari più avanzati, considera usare [StateNotifierProvider]. +`FutureProvider` does not offer a way of directly modifying the computation after +a user interaction. It is designed to solve simple use-cases. +For more advanced scenarios, consider using [AsyncNotifierProvider]. ::: -## Esempio d'uso: leggere un file di configurazione +## Usage example: reading a configuration file -`FutureProvider` può essere utile per esporre un oggetto `Configuration` -creato leggendo un file JSON. +`FutureProvider` can be a convenient way to expose a `Configuration` object +created by reading a JSON file. -La creazione della configurazione verrebbe eseguita con la tipica sintassi async/await, ma all'interno del provider. -Usando gli asset di Flutter, sarebbe quindi: +Creating the configuration would be done with your typical async/await +syntax, but inside the provider. +Using Flutter's asset system, this would be: -Successivamente, la UI può stare in ascolto delle configurazioni in questo modo: + +Then, the UI can listen to configurations like so: -Ciò ricostruirà automaticamente l'interfaccia quando il [Future] finisce. -Allo stesso tempo, se più widget vogliono accedere alle configurazioni, l'asset verrà decodificato solo una volta. +This will automatically rebuild the UI when the [Future] completes. +At the same time, if multiple widgets want the configurations, +the asset will be decoded only once. -Come puoi vedere, ascoltare un `FutureProvider` dentro un widget restituisce un [AsyncValue], -il che permette di gestire gli stati di errore/caricamento. +As you can see, listening to a `FutureProvider` inside a widget returns +an [AsyncValue] – which allows handling the error/loading states. -[ref.watch]: ../concepts/reading#usare-ref.watch-per-osservare-un-provider -[statenotifierprovider]: ./state_notifier_provider +[ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider +[asyncnotifierprovider]: ./notifier_provider [provider]: ./provider [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html [future]: https://api.dart.dev/dart-async/Future-class.html -[family]: ../concepts/modifiers/family \ No newline at end of file +[family]: ../concepts/modifiers/family diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart new file mode 100644 index 000000000..a96f35e72 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart @@ -0,0 +1,16 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../config_provider/codegen.dart'; + +/* SNIPPET START */ + +Widget build(BuildContext context, WidgetRef ref) { + final config = ref.watch(fetchConfigurationProvider); + + return switch (config) { + AsyncError(:final error) => Text('Error: $error'), + AsyncData(:final value) => Text(value.host), + _ => const CircularProgressIndicator(), + }; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart new file mode 100644 index 000000000..44d9b4df9 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart @@ -0,0 +1,21 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import '../config_provider/raw.dart'; + +/* SNIPPET START */ + +class MyConfiguration extends HookConsumerWidget { + const MyConfiguration({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final config = ref.watch(configProvider); + return Scaffold( + body: switch (config) { + AsyncError(:final error) => Center(child: Text('Error: $error')), + AsyncData(:final value) => Center(child: Text(value.host)), + _ => const Center(child: CircularProgressIndicator()), + }, + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart new file mode 100644 index 000000000..ade0628fd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart @@ -0,0 +1,22 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../config_provider/codegen.dart'; + +/* SNIPPET START */ + +class MyConfiguration extends HookConsumerWidget { + const MyConfiguration({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final config = ref.watch(fetchConfigurationProvider); + return Scaffold( + body: switch (config) { + AsyncError(:final error) => Center(child: Text('Error: $error')), + AsyncData(:final value) => Center(child: Text(value.host)), + _ => const Center(child: CircularProgressIndicator()), + }, + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/index.tsx new file mode 100644 index 000000000..8e7b2a443 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/index.tsx @@ -0,0 +1,11 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; +import hooks from "!!raw-loader!./hooks.dart"; +import hooksCodegen from "!!raw-loader!./hooks_codegen.dart" + +export default { + raw, + hooks, + codegen, + hooksCodegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart new file mode 100644 index 000000000..9d39f3bcd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart @@ -0,0 +1,18 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../config_provider/raw.dart'; + +/* SNIPPET START */ + +Widget build(BuildContext context, WidgetRef ref) { + AsyncValue config = ref.watch(configProvider); + + return switch (config) { + AsyncData(:final value) => Text(value.host), + AsyncError(:final error) => Text('Error: $error'), + _ => const CircularProgressIndicator(), + }; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.dart new file mode 100644 index 000000000..2aa87a29e --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.dart @@ -0,0 +1,22 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +import 'dart:convert'; + +import 'package:flutter/services.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +part 'codegen.g.dart'; +class Configuration { + Configuration.fromJson(Map json); + final String host = ''; +} + +/* SNIPPET START */ + +@riverpod +Future fetchConfiguration(FetchConfigurationRef ref) async { + final content = json.decode( + await rootBundle.loadString('assets/configurations.json'), + ) as Map; + + return Configuration.fromJson(content); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart new file mode 100644 index 000000000..ce4740543 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart @@ -0,0 +1,29 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$fetchConfigurationHash() => + r'6c0f062e6f20baf883c4282856f1197fbe633d89'; + +/// See also [fetchConfiguration]. +@ProviderFor(fetchConfiguration) +final fetchConfigurationProvider = + AutoDisposeFutureProvider.internal( + fetchConfiguration, + name: r'fetchConfigurationProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$fetchConfigurationHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef FetchConfigurationRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/raw.dart new file mode 100644 index 000000000..62d7926ca --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/raw.dart @@ -0,0 +1,22 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +import 'dart:convert'; + +import 'package:flutter/services.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Configuration { + Configuration.fromJson(Map json); + + final String host = ''; +} + +/* SNIPPET START */ + +final configProvider = FutureProvider((ref) async { + final content = json.decode( + await rootBundle.loadString('assets/configurations.json'), + ) as Map; + + return Configuration.fromJson(content); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx new file mode 100644 index 000000000..4432f874f --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx @@ -0,0 +1,55 @@ +--- +title: (Async)NotifierProvider +--- + +import CodeBlock from "@theme/CodeBlock"; +import todos from "./notifier_provider/todos"; +import todosConsumer from "!!raw-loader!/docs/providers/notifier_provider/todos/todos_consumer.dart"; +import remoteTodos from "./notifier_provider/remote_todos"; +import remoteTodosConsumer from "!!raw-loader!/docs/providers/notifier_provider/remote_todos/todos_consumer.dart"; +import { trimSnippet, AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + +[NotifierProvider] is a provider that is used to listen to and expose a [Notifier]. +[AsyncNotifierProvider] is a provider that is used to listen to and expose an [AsyncNotifier]. +[AsyncNotifier] is a [Notifier] that can be asynchronously initialized. +`(Async)NotifierProvider` along with `(Async)Notifier` is Riverpod's recommended solution +for managing state which may change in reaction to a user interaction. + +It is typically used for: + +- exposing a state which can change over time after reacting to custom events. +- centralizing the logic for modifying some state (aka "business logic") in a + single place, improving maintainability over time. + +As a usage example, we could use [NotifierProvider] to implement a todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: + + + +Now that we have defined a [NotifierProvider], we can use it to interact +with the list of todos in our UI: + +{trimSnippet(todosConsumer)} + +As a usage example, we could use [AsyncNotifierProvider] to implement a remote todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: + + + +Now that we have defined a [AsyncNotifierProvider], we can use it to interact +with the list of todos in our UI: + +{trimSnippet(remoteTodosConsumer)} + +[notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html +[notifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/NotifierProvider.html +[asyncnotifier]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifier-class.html +[asyncnotifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifierProvider.html diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart new file mode 100644 index 000000000..e02195f87 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart @@ -0,0 +1,82 @@ +import 'dart:convert'; + +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +class Http { + Future get(String str) async => str; + Future delete(String str) async => str; + Future post(String str, Map body) async => str; + Future patch(String str, Map body) async => str; +} + +final http = Http(); + +/* SNIPPET START */ + +@freezed +class Todo with _$Todo { + factory Todo({ + required String id, + required String description, + required bool completed, + }) = _Todo; + + factory Todo.fromJson(Map json) => _$TodoFromJson(json); +} + +// This will generates a AsyncNotifier and AsyncNotifierProvider. +// The AsyncNotifier class that will be passed to our AsyncNotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +// Finally, we are using asyncTodosProvider(AsyncNotifierProvider) to allow the UI to +// interact with our Todos class. +@riverpod +class AsyncTodos extends _$AsyncTodos { + Future> _fetchTodo() async { + final json = await http.get('api/todos'); + final todos = jsonDecode(json) as List>; + return todos.map(Todo.fromJson).toList(); + } + + @override + FutureOr> build() async { + // Load initial todo list from the remote repository + return _fetchTodo(); + } + + Future addTodo(Todo todo) async { + // Set the state to loading + state = const AsyncValue.loading(); + // Add the new todo and reload the todo list from the remote repository + state = await AsyncValue.guard(() async { + await http.post('api/todos', todo.toJson()); + return _fetchTodo(); + }); + } + + // Let's allow removing todos + Future removeTodo(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.delete('api/todos/$todoId'); + return _fetchTodo(); + }); + } + + // Let's mark a todo as completed + Future toggle(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.patch( + 'api/todos/$todoId', + {'completed': true}, + ); + return _fetchTodo(); + }); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart new file mode 100644 index 000000000..d1b8a01d5 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart @@ -0,0 +1,184 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Todo _$TodoFromJson(Map json) { + return _Todo.fromJson(json); +} + +/// @nodoc +mixin _$Todo { + String get id => throw _privateConstructorUsedError; + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$TodoImpl implements _Todo { + _$TodoImpl( + {required this.id, required this.description, required this.completed}); + + factory _$TodoImpl.fromJson(Map json) => + _$$TodoImplFromJson(json); + + @override + final String id; + @override + final String description; + @override + final bool completed; + + @override + String toString() { + return 'Todo(id: $id, description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.id, id) || other.id == id) && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, id, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); + + @override + Map toJson() { + return _$$TodoImplToJson( + this, + ); + } +} + +abstract class _Todo implements Todo { + factory _Todo( + {required final String id, + required final String description, + required final bool completed}) = _$TodoImpl; + + factory _Todo.fromJson(Map json) = _$TodoImpl.fromJson; + + @override + String get id; + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart new file mode 100644 index 000000000..8783f8ed4 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart @@ -0,0 +1,44 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$TodoImpl _$$TodoImplFromJson(Map json) => _$TodoImpl( + id: json['id'] as String, + description: json['description'] as String, + completed: json['completed'] as bool, + ); + +Map _$$TodoImplToJson(_$TodoImpl instance) => + { + 'id': instance.id, + 'description': instance.description, + 'completed': instance.completed, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$asyncTodosHash() => r'fd0d7502a1c17b7cedd2350519649dd680fc48cd'; + +/// See also [AsyncTodos]. +@ProviderFor(AsyncTodos) +final asyncTodosProvider = + AutoDisposeAsyncNotifierProvider>.internal( + AsyncTodos.new, + name: r'asyncTodosProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$asyncTodosHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$AsyncTodos = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart new file mode 100644 index 000000000..f4455a338 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart @@ -0,0 +1,101 @@ +import 'dart:convert'; + +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Http { + Future get(String str) async => str; + Future delete(String str) async => str; + Future post(String str, Map body) async => str; + Future patch(String str, Map body) async => str; +} + +final http = Http(); + +/* SNIPPET START */ + +// An immutable state is preferred. +// We could also use packages like Freezed to help with the implementation. +@immutable +class Todo { + const Todo({ + required this.id, + required this.description, + required this.completed, + }); + + factory Todo.fromJson(Map map) { + return Todo( + id: map['id'] as String, + description: map['description'] as String, + completed: map['completed'] as bool, + ); + } + + // All properties should be `final` on our class. + final String id; + final String description; + final bool completed; + + Map toJson() => { + 'id': id, + 'description': description, + 'completed': completed, + }; +} + +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +class AsyncTodosNotifier extends AsyncNotifier> { + Future> _fetchTodo() async { + final json = await http.get('api/todos'); + final todos = jsonDecode(json) as List>; + return todos.map(Todo.fromJson).toList(); + } + + @override + Future> build() async { + // Load initial todo list from the remote repository + return _fetchTodo(); + } + + Future addTodo(Todo todo) async { + // Set the state to loading + state = const AsyncValue.loading(); + // Add the new todo and reload the todo list from the remote repository + state = await AsyncValue.guard(() async { + await http.post('api/todos', todo.toJson()); + return _fetchTodo(); + }); + } + + // Let's allow removing todos + Future removeTodo(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.delete('api/todos/$todoId'); + return _fetchTodo(); + }); + } + + // Let's mark a todo as completed + Future toggle(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.patch( + 'api/todos/$todoId', + {'completed': true}, + ); + return _fetchTodo(); + }); + } +} + +// Finally, we are using NotifierProvider to allow the UI to interact with +// our TodosNotifier class. +final asyncTodosProvider = + AsyncNotifierProvider>(() { + return AsyncTodosNotifier(); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart new file mode 100644 index 000000000..5d00d05d9 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart @@ -0,0 +1,37 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'codegen.dart'; + +/* SNIPPET START */ + +class TodoListView extends ConsumerWidget { + const TodoListView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // rebuild the widget when the todo list changes + final asyncTodos = ref.watch(asyncTodosProvider); + + // Let's render the todos in a scrollable list view + return switch (asyncTodos) { + AsyncData(:final value) => ListView( + children: [ + for (final todo in value) + CheckboxListTile( + value: todo.completed, + // When tapping on the todo, change its completed status + onChanged: (value) { + ref.read(asyncTodosProvider.notifier).toggle(todo.id); + }, + title: Text(todo.description), + ), + ], + ), + AsyncError(:final error) => Text('Error: $error'), + _ => const Center(child: CircularProgressIndicator()), + }; + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart new file mode 100644 index 000000000..866ed37bb --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart @@ -0,0 +1,68 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@freezed +class Todo with _$Todo { + factory Todo({ + required String id, + required String description, + required bool completed, + }) = _Todo; +} + +// This will generates a Notifier and NotifierProvider. +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +// Finally, we are using todosProvider(NotifierProvider) to allow the UI to +// interact with our Todos class. +@riverpod +class Todos extends _$Todos { + @override + List build() { + return []; + } + + // Let's allow the UI to add todos. + void addTodo(Todo todo) { + // Since our state is immutable, we are not allowed to do `state.add(todo)`. + // Instead, we should create a new list of todos which contains the previous + // items and the new one. + // Using Dart's spread operator here is helpful! + state = [...state, todo]; + // No need to call "notifyListeners" or anything similar. Calling "state =" + // will automatically rebuild the UI when necessary. + } + + // Let's allow removing todos + void removeTodo(String todoId) { + // Again, our state is immutable. So we're making a new list instead of + // changing the existing list. + state = [ + for (final todo in state) + if (todo.id != todoId) todo, + ]; + } + + // Let's mark a todo as completed + void toggle(String todoId) { + state = [ + for (final todo in state) + // we're marking only the matching todo as completed + if (todo.id == todoId) + // Once more, since our state is immutable, we need to make a copy + // of the todo. We're using our `copyWith` method implemented before + // to help with that. + todo.copyWith(completed: !todo.completed) + else + // other todos are not modified + todo, + ]; + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart new file mode 100644 index 000000000..0b73d3548 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart @@ -0,0 +1,166 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$Todo { + String get id => throw _privateConstructorUsedError; + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc + +class _$TodoImpl implements _Todo { + _$TodoImpl( + {required this.id, required this.description, required this.completed}); + + @override + final String id; + @override + final String description; + @override + final bool completed; + + @override + String toString() { + return 'Todo(id: $id, description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.id, id) || other.id == id) && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @override + int get hashCode => Object.hash(runtimeType, id, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); +} + +abstract class _Todo implements Todo { + factory _Todo( + {required final String id, + required final String description, + required final bool completed}) = _$TodoImpl; + + @override + String get id; + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart new file mode 100644 index 000000000..0abb46e3f --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todosHash() => r'3485c14ec4db07efe5fe52243258a66e6f99b2b4'; + +/// See also [Todos]. +@ProviderFor(Todos) +final todosProvider = AutoDisposeNotifierProvider>.internal( + Todos.new, + name: r'todosProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todosHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Todos = AutoDisposeNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart new file mode 100644 index 000000000..ec3e50308 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart @@ -0,0 +1,85 @@ +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +// An immutable state is preferred. +// We could also use packages like Freezed to help with the implementation. +@immutable +class Todo { + const Todo({ + required this.id, + required this.description, + required this.completed, + }); + + // All properties should be `final` on our class. + final String id; + final String description; + final bool completed; + + // Since Todo is immutable, we implement a method that allows cloning the + // Todo with slightly different content. + Todo copyWith({String? id, String? description, bool? completed}) { + return Todo( + id: id ?? this.id, + description: description ?? this.description, + completed: completed ?? this.completed, + ); + } +} + +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +class TodosNotifier extends Notifier> { + // We initialize the list of todos to an empty list + @override + List build() { + return []; + } + + // Let's allow the UI to add todos. + void addTodo(Todo todo) { + // Since our state is immutable, we are not allowed to do `state.add(todo)`. + // Instead, we should create a new list of todos which contains the previous + // items and the new one. + // Using Dart's spread operator here is helpful! + state = [...state, todo]; + // No need to call "notifyListeners" or anything similar. Calling "state =" + // will automatically rebuild the UI when necessary. + } + + // Let's allow removing todos + void removeTodo(String todoId) { + // Again, our state is immutable. So we're making a new list instead of + // changing the existing list. + state = [ + for (final todo in state) + if (todo.id != todoId) todo, + ]; + } + + // Let's mark a todo as completed + void toggle(String todoId) { + state = [ + for (final todo in state) + // we're marking only the matching todo as completed + if (todo.id == todoId) + // Once more, since our state is immutable, we need to make a copy + // of the todo. We're using our `copyWith` method implemented before + // to help with that. + todo.copyWith(completed: !todo.completed) + else + // other todos are not modified + todo, + ]; + } +} + +// Finally, we are using NotifierProvider to allow the UI to interact with +// our TodosNotifier class. +final todosProvider = NotifierProvider>(() { + return TodosNotifier(); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart new file mode 100644 index 000000000..192cb9f66 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart @@ -0,0 +1,32 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'codegen.dart'; + +/* SNIPPET START */ + +class TodoListView extends ConsumerWidget { + const TodoListView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // rebuild the widget when the todo list changes + List todos = ref.watch(todosProvider); + + // Let's render the todos in a scrollable list view + return ListView( + children: [ + for (final todo in todos) + CheckboxListTile( + value: todo.completed, + // When tapping on the todo, change its completed status + onChanged: (value) => + ref.read(todosProvider.notifier).toggle(todo.id), + title: Text(todo.description), + ), + ], + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider.mdx index 4058bc3cc..136c8edbc 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider.mdx @@ -2,96 +2,104 @@ title: Provider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import todo from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo.dart"; -import completedTodos from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart"; -import todosConsumer from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart"; -import unoptimizedPreviousButton from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart"; -import optimizedPreviousButton from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import todo from "./provider/todo"; +import completedTodos from "./provider/completed_todos"; +import todosConsumer from "!!raw-loader!/docs/providers/provider/todos_consumer.dart"; +import unoptimizedPreviousButton from "./provider/unoptimized_previous_button"; +import optimizedPreviousButton from "./provider/optimized_previous_button"; +import { trimSnippet, AutoSnippet } from "../../../../../src/components/CodeSnippet"; -`Provider` è il provider più basico tra tutti. Crea un valore... e questo è tutto. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -`Provider` è utilizzato tipicamente per: +`Provider` is the most basic of all providers. It creates a value... And that's about it. -- calcoli per memorizzazione in cache -- esporre un valore ad altri provider (come `Repository`/`HttpClient`). -- offrire un modo per test o widget di sovrascrivere un valore. -- ridurre il numero di rebuilds dei provider/widget senza dover usare `select`. +`Provider` is typically used for: -## Usare `Provider` per memorizzare calcoli/computazioni +- caching computations +- exposing a value to other providers (such as a `Repository`/`HttpClient`). +- offering a way for tests or widgets to override a value. +- reducing rebuilds of providers/widgets without having to use `select`. -`Provider` è un potente strumento per memorizzare operazioni sincrone -quando combinato con [ref.watch]. +## Using `Provider` to cache computations -Un esempio potrebbe essere filtrare una lista di todo. Dato che filtrare una lista -potrebbe risultare leggermente costoso, idealmente non vogliamo filtrare la nostra lista -di todo ogni volta che la nostra applicazione si renderizza. -In questa situazione possiamo usare `Provider` per fare filtrare al posto nostro. +`Provider` is a powerful tool for caching synchronous operations when combined +with [ref.watch]. -Per fare ciò, assumiamo che la nostra applicazione abbia un esistente [StateNotifierProvider] -che manipola una lista di todo: +An example would be filtering a list of todos. +Since filtering a list could be slightly expensive, we ideally do not want to +filter our list of todos whenever our application re-renders. +In this situation, we could use `Provider` to do the filtering for us. -{trimSnippet(todo)} +For that, assume that our application has an existing [NotifierProvider] +which manipulates a list of todos: -Da qui, possiamo usare `Provider` per esporre la lista dei todo filtrata, -mostrando solo i todo completati: + -{trimSnippet(completedTodos)} +From there, we can use `Provider` to expose the filtered list of todos, showing +only the completed todos: -Con questo codice, la nostra UI è ora in grado di mostrare la lista dei todo -completati stando in ascolto di `completedTodosProvider`: + + +With this code, our UI is now able to show the list of the completed todos +by listening to `completedTodosProvider`: {trimSnippet(todosConsumer)} -La parte interessante è che la lista filtrata ora è memorizzata in cache. +The interesting part is, the list filtering is now cached. -Ciò significa che la lista dei todo completati non sarà ricalcolata fino a quando -i todo verranno aggiunti/rimossi/aggiornati, anche se stiamo leggendo la lista dei todo completati più volte. +Meaning that the list of completed todos will not be recomputed until +todos are added/removed/updated, even if we are reading the list of completed +todos multiple times. -Tieni presente che non è necessario invalidare manualmente la cache quando la lista dei todo cambia. -`Provider` sà in modo autonomo quando il risultato deve essere ricalcolato grazie a [ref.watch]. +Note how we do not need to manually invalidate the cache when the list of todos +changes. `Provider` is automatically able to know when the result must be recomputed +thanks to [ref.watch]. -## Ridurre il numero di rebuilds dei provider/widget attraverso `Provider` +## Reducing provider/widget rebuilds by using `Provider` -Un aspetto unico di `Provider` è che anche quando `Provider` viene ricalcolato -(in genere quando si usa [ref.watch]), non aggiornerà i widget/provider che lo ascoltano -a meno che il valore non cambi. +A unique aspect of `Provider` is that even when `Provider` is recomputed +(typically when using [ref.watch]), it will not update the widgets/providers +that listen to it unless the value changed. -Un esempio reale potrebbe essere per abilitare/disabilitare i tasti previous/next -di una vista paginata: +A real world example would be for enabling/disabling previous/next buttons +of a paginated view: -![Tasto "Precedente/Successivo"](https://user-images.githubusercontent.com/134939/47580830-31263a00-d950-11e8-9b61-0eaddab2709e.png) +![stepper example](https://user-images.githubusercontent.com/134939/47580830-31263a00-d950-11e8-9b61-0eaddab2709e.png) -Nel nostro caso ci concentreremo specificamente sul tasto "Precedente" ("Previous"). -Un'implementazione ingenua di tale pulsante sarebbe un widget che ottiene l'indice della pagina corrente, -e se quell'indice è uguale a 0, disabiliteremmo il pulsante. +In our case, we will focus specifically on the "previous" button. +A naive implementation of such button would be a widget which obtains the +current page index, and if that index is equal to 0, we would disable the button. -Tale codice potrebbe essere: +This code could be: -{trimSnippet(unoptimizedPreviousButton)} + -Il problema con questo codice è che ogni volta che cambiamo la pagina corrente, il pulsante "Previous" verrà ricostruito. -Come funzionamento ideale, vorremmo che il pulsante si ricostruisse solo quando passa da attivato a disattivato. +The issue with this code is that whenever we change the current page, the "previous" +button will rebuild. +In the ideal world, we would want the button to rebuild only when changing between +activated and deactivated. -La radice del problema è che stiamo ricalcolando se l'utente è autorizzato ad andare -alla pagina precedente direttamente all'interno del pulsante "previous". +The root of the issue here is that we are computing whether the user is +allowed to go to the previous page directly within the "previous" button. -Un modo per risolvere questo problema è estrarre la logica al di fuori del widget -in un `Provider`: +A way to solve this is to extract this logic outside of the widget and into a `Provider`: -{trimSnippet(optimizedPreviousButton)} + -Facendo questa piccola modifica, il nostro widget `PreviousButton` non verrà più ricostruito -quando l'indice della pagina cambia grazie a `Provider`. +By doing this small refactoring, our `PreviousButton` widget will no longer +rebuild when the page index changes thanks to `Provider`. -D'ora in poi, quando l'indice della pagina cambierà, il provider `canGoToPreviousPageProvider` -sarà ricalcolato. Ma se il valore esposto dal provider non cambia, allora `PreviousButton` non verrà ricostruito. +From now on when the page index changes, our `canGoToPreviousPageProvider` provider +will be recomputed. But if the value exposed by the provider does not change, +then `PreviousButton` will not rebuild. -Questa modifica ha migliorato la performance del nostro bottone, e ha avuto -l'interessante beneficio di estrarre la logica al di fuori del nostro widget. +This change both improved the performance of our button and had the interesting +benefit of extracting the logic outside of our widget. -[ref.watch]: ../concepts/reading#usare-ref.watch-per-osservare-un-provider -[statenotifierprovider]: ./state_notifier_provider \ No newline at end of file +[ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider +[notifierprovider]: ./notifier_provider diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart new file mode 100644 index 000000000..1a29d96f5 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart @@ -0,0 +1,15 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../todo/todo.dart'; + +part 'completed_todos.g.dart'; + +/* SNIPPET START */ + +@riverpod +List completedTodos(CompletedTodosRef ref) { + final todos = ref.watch(todosProvider); + + // we return only the completed todos + return todos.where((todo) => todo.isCompleted).toList(); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart new file mode 100644 index 000000000..be2ec7731 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'completed_todos.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$completedTodosHash() => r'855706c09268f428696b3b382ae1605818361b83'; + +/// See also [completedTodos]. +@ProviderFor(completedTodos) +final completedTodosProvider = AutoDisposeProvider>.internal( + completedTodos, + name: r'completedTodosProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$completedTodosHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CompletedTodosRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx new file mode 100644 index 000000000..11451aa1c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./completed_todos.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart similarity index 65% rename from website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart index 3783ddf9d..e24c48bd5 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart @@ -1,13 +1,13 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'todo.dart'; +import '../todo/raw.dart'; /* SNIPPET START */ final completedTodosProvider = Provider>((ref) { - // Otteniamo la lista di tutti i todo da todosProvider + // We obtain the list of all todos from the todosProvider final todos = ref.watch(todosProvider); - // restituiamo solo i todo completati + // we return only the completed todos return todos.where((todo) => todo.isCompleted).toList(); }); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx new file mode 100644 index 000000000..fb83c92f1 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./optimized_previous_button.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart new file mode 100644 index 000000000..7d3b8a332 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart @@ -0,0 +1,50 @@ +// A provider that controls the current page +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'optimized_previous_button.g.dart'; + +/* SNIPPET START */ + +@riverpod +class PageIndex extends _$PageIndex { + @override + int build() { + return 0; + } + + void goToPreviousPage() { + state = state - 1; + } +} + +// A provider which computes whether the user is allowed to go to the previous page +@riverpod +/* highlight-start */ +bool canGoToPreviousPage(CanGoToPreviousPageRef ref) { +/* highlight-end */ + return ref.watch(pageIndexProvider) != 0; +} + +class PreviousButton extends ConsumerWidget { + const PreviousButton({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // We are now watching our new Provider + // Our widget is no longer calculating whether we can go to the previous page. +/* highlight-start */ + final canGoToPreviousPage = ref.watch(canGoToPreviousPageProvider); +/* highlight-end */ + + void goToPreviousPage() { + ref.read(pageIndexProvider.notifier).goToPreviousPage(); + } + + return ElevatedButton( + onPressed: canGoToPreviousPage ? goToPreviousPage : null, + child: const Text('previous'), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart new file mode 100644 index 000000000..096a056f2 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -0,0 +1,42 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'optimized_previous_button.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$canGoToPreviousPageHash() => + r'801fe8182a37cd21ae83bdfccbe36c125b4d14fb'; + +/// See also [canGoToPreviousPage]. +@ProviderFor(canGoToPreviousPage) +final canGoToPreviousPageProvider = AutoDisposeProvider.internal( + canGoToPreviousPage, + name: r'canGoToPreviousPageProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$canGoToPreviousPageHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CanGoToPreviousPageRef = AutoDisposeProviderRef; +String _$pageIndexHash() => r'59307ecf23b5b2432833da5ad6b312bf36435d0e'; + +/// See also [PageIndex]. +@ProviderFor(PageIndex) +final pageIndexProvider = AutoDisposeNotifierProvider.internal( + PageIndex.new, + name: r'pageIndexProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$pageIndexHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$PageIndex = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart similarity index 87% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart index b7c497a43..30b1cc673 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart @@ -6,11 +6,11 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final pageIndexProvider = StateProvider((ref) => 0); -// 사용자(the user)가 이전 페이지로 돌아가는지 계산하기 위한 프로바이더 +// A provider which computes whether the user is allowed to go to the previous page /* highlight-start */ final canGoToPreviousPageProvider = Provider((ref) { /* highlight-end */ - return ref.watch(pageIndexProvider) == 0; + return ref.watch(pageIndexProvider) != 0; }); class PreviousButton extends ConsumerWidget { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx new file mode 100644 index 000000000..91d9cc4aa --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./todo.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart similarity index 59% rename from website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart index 04fecf970..11e62bc3a 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart @@ -10,15 +10,18 @@ class Todo { final String description; } -class TodosNotifier extends StateNotifier> { - TodosNotifier() : super([]); +class TodosNotifier extends Notifier> { + @override + List build() { + return []; + } void addTodo(Todo todo) { state = [...state, todo]; } - // TODO aggiungere altri metodi, come "removeTodo", ... + // TODO add other methods, such as "removeTodo", ... } -final todosProvider = StateNotifierProvider>((ref) { +final todosProvider = NotifierProvider>(() { return TodosNotifier(); }); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart new file mode 100644 index 000000000..7089bc962 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart @@ -0,0 +1,25 @@ +// ignore_for_file: avoid_positional_boolean_parameters +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo.g.dart'; + +/* SNIPPET START */ + +class Todo { + Todo(this.description, this.isCompleted); + final bool isCompleted; + final String description; +} + +@riverpod +class Todos extends _$Todos { + @override + List build() { + return []; + } + + void addTodo(Todo todo) { + state = [...state, todo]; + } + // TODO add other methods, such as "removeTodo", ... +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart new file mode 100644 index 000000000..0b4a0a56d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todosHash() => r'4bd25c3c15bfff56ad6e733bd17ecb7284c4ceb2'; + +/// See also [Todos]. +@ProviderFor(Todos) +final todosProvider = AutoDisposeNotifierProvider>.internal( + Todos.new, + name: r'todosProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todosHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Todos = AutoDisposeNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart index 96801bb7c..9b93e9185 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart @@ -3,16 +3,16 @@ import 'package:flutter/widgets.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'completed_todos.dart'; +import 'completed_todos/completed_todos.dart'; Widget build() { return /* SNIPPET START */ - Consumer(builder: (context, ref, child) { - final completedTodos = ref.watch(completedTodosProvider); - // TODO mostrare i todo usando ListView/GridView/.../* SKIP */ - return Container(); - /* SKIP END */ - }); +Consumer(builder: (context, ref, child) { + final completedTodos = ref.watch(completedTodosProvider); + // TODO show the todos using a ListView/GridView/.../* SKIP */ + return Container(); + /* SKIP END */ +}); /* SNIPPET END */ } diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx new file mode 100644 index 000000000..d345d4f5d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./unoptimized_previous_button.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart similarity index 76% rename from website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart index f8a4596df..828d382d5 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart @@ -1,4 +1,4 @@ -// Un provider che controlla la pagina corrente +// A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; @@ -11,8 +11,8 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // se non è la prima pagina, il pulsante "previous" è attivo - final canGoToPreviousPage = ref.watch(pageIndexProvider) == 0; + // if not on first page, the previous button is active + final canGoToPreviousPage = ref.watch(pageIndexProvider) != 0; void goToPreviousPage() { ref.read(pageIndexProvider.notifier).update((state) => state - 1); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart new file mode 100644 index 000000000..f77de56c3 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart @@ -0,0 +1,39 @@ +// A provider that controls the current page +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'unoptimized_previous_button.g.dart'; + +/* SNIPPET START */ + +@riverpod +class PageIndex extends _$PageIndex { + @override + int build() { + return 0; + } + + void goToPreviousPage() { + state = state - 1; + } +} + +class PreviousButton extends ConsumerWidget { + const PreviousButton({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // if not on first page, the previous button is active + final canGoToPreviousPage = ref.watch(pageIndexProvider) != 0; + + void goToPreviousPage() { + ref.read(pageIndexProvider.notifier).goToPreviousPage(); + } + + return ElevatedButton( + onPressed: canGoToPreviousPage ? goToPreviousPage : null, + child: const Text('previous'), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart new file mode 100644 index 000000000..e02ece976 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'unoptimized_previous_button.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$pageIndexHash() => r'59307ecf23b5b2432833da5ad6b312bf36435d0e'; + +/// See also [PageIndex]. +@ProviderFor(PageIndex) +final pageIndexProvider = AutoDisposeNotifierProvider.internal( + PageIndex.new, + name: r'pageIndexProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$pageIndexHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$PageIndex = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx index 8ea2992b0..ad8b55960 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx @@ -2,30 +2,39 @@ title: StateNotifierProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import todos from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart"; -import todosConsumer from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart"; +import todos from "!!raw-loader!/docs/providers/state_notifier_provider/todos.dart"; +import todosConsumer from "!!raw-loader!/docs/providers/state_notifier_provider/todos_consumer.dart"; import { trimSnippet } from "../../../../../src/components/CodeSnippet"; -`StateNotifierProvider` è un provider usato per ascoltare ed esporre uno [StateNotifier] (dal package [state_notifier], che Riverpod ri-esporta). -`StateNotifierProvider` unito con [StateNotifier] è la soluzione consigliata da Riverpod per gestire lo stato in reazione all'interazione dell'utente. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -Viene usato in genere per: +`StateNotifierProvider` is a provider that is used to listen to and expose a +[StateNotifier] (from the package [state_notifier], which Riverpod re-exports). -- esporre uno stato **immutabile** che può cambiare nel tempo dopo aver reagito ad eventi personalizzabili. -- centralizzare la logica per modificare lo stato (aka "business logic") in un singolo posto, - migliorando la mantenibilità nel tempo. +It is typically used for: -Come esempio d'uso, potremmo usare `StateNotifierProvider` per implementare una todo-list (lista di todo). -Fare ciò ci permette di esporre dei metodi come `addTodo` per lasciare che l'UI modifichi -la todo-list in base alle interazioni dell'utente: +- exposing an **immutable** state which can change over time after reacting to + custom events. +- centralizing the logic for modifying some state (aka "business logic") in a + single place, improving maintainability over time. + +:::info +Prefer using [NotifierProvider] instead. +::: + +As a usage example, we could use `StateNotifierProvider` to implement a todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: {trimSnippet(todos)} -Ora che abbiamo definito uno `StateNotifierProvider`, -possiamo usarlo per interagire con la todo-list nella nostra interfaccia grafica: +Now that we have defined a `StateNotifierProvider`, we can use it to interact +with the list of todos in our UI: {trimSnippet(todosConsumer)} @@ -33,3 +42,4 @@ possiamo usarlo per interagire con la todo-list nella nostra interfaccia grafica [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html [provider]: ./provider [futureprovider]: ./future_provider +[notifierprovider]: ./notifier_provider diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 997d9d5f5..1318bbcbf 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -3,21 +3,19 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; /* SNIPPET START */ -// Lo stato del nostro StateNotifier dovrebbe essere immutabile. -// Potremmo usare anche packages come Freezed per aiutarci con l'implementazione. - +// The state of our StateNotifier should be immutable. +// We could also use packages like Freezed to help with the implementation. @immutable class Todo { const Todo({required this.id, required this.description, required this.completed}); - // Tutte le proprietà dovrebbero essere `final` nella nostra classe. + // All properties should be `final` on our class. final String id; final String description; final bool completed; - // Dato che Todo è immutabile, implementiamo un metodo che ci permette di - // clonare l'oggetto Todo con un contenuto leggermente diverso. - + // Since Todo is immutable, we implement a method that allows cloning the + // Todo with slightly different content. Todo copyWith({String? id, String? description, bool? completed}) { return Todo( id: id ?? this.id, @@ -27,60 +25,54 @@ class Todo { } } -// La classe StateNotifier sarà passata al nostro StateNotifierProvider. -// Questa classe non dovrebbe esporre lo stato al di fuori della sua proprietà "state" -// il che significa nessuna proprietà o getter pubblico! - -// I metodi pubblici di questa classe sono quelli che consentiranno alla UI di modificare lo stato. - +// The StateNotifier class that will be passed to our StateNotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. class TodosNotifier extends StateNotifier> { - // Inizializzamo la lista dei todo con una lista vuota - - TodosNotifier() : super([]); + // We initialize the list of todos to an empty list + TodosNotifier(): super([]); - // Consentiamo alla UI di aggiungere i todo + // Let's allow the UI to add todos. void addTodo(Todo todo) { - // Poichè il nostro stato è immutabile, non siamo autorizzati a fare `state.add(todo)`. - // Dovremmo invece creare una nuova lista di todo contenente - // gli elementi precedenti e il nuovo - - // Usare lo spread operator di Dart qui è d'aiuto! - + // Since our state is immutable, we are not allowed to do `state.add(todo)`. + // Instead, we should create a new list of todos which contains the previous + // items and the new one. + // Using Dart's spread operator here is helpful! state = [...state, todo]; - // Non c'è bisogno di chiamare "notifiyListeners" o qualcosa di simile. - // Chiamare "state =" ricostruirà automaticamente la UI quando necessario. + // No need to call "notifyListeners" or anything similar. Calling "state =" + // will automatically rebuild the UI when necessary. } - // Consentiamo di rimuovere i todo + // Let's allow removing todos void removeTodo(String todoId) { - // Di nuovo, il nostro stato è immutabile. Quindi facciamo una nuova lista - // invece di modificare la lista esistente. - + // Again, our state is immutable. So we're making a new list instead of + // changing the existing list. state = [ for (final todo in state) if (todo.id != todoId) todo, ]; } - // Contrassegniamo il todo come completato + // Let's mark a todo as completed void toggle(String todoId) { state = [ for (final todo in state) - // contrassegniamo solo il todo corrispondente come completato + // we're marking only the matching todo as completed if (todo.id == todoId) - // Usiamo il metodo `copyWith` implementato prima per aiutarci nel - // modificare lo stato - + // Once more, since our state is immutable, we need to make a copy + // of the todo. We're using our `copyWith` method implemented before + // to help with that. todo.copyWith(completed: !todo.completed) else - // gli altri todo non sono modificati + // other todos are not modified todo, ]; } } -// Infine, usiamo StateNotifierProvider per consentire all'UI di interagire con -// la classe TodosNotifier +// Finally, we are using StateNotifierProvider to allow the UI to interact with +// our TodosNotifier class. final todosProvider = StateNotifierProvider>((ref) { return TodosNotifier(); -}); +}); \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index 10628cc8b..8722a542f 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -12,11 +12,10 @@ class TodoListView extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // ricostruisce il widget quando la todo-list cambia - + // rebuild the widget when the todo list changes List todos = ref.watch(todosProvider); - // Renderizziamo i todo in una list view scrollabile + // Let's render the todos in a scrollable list view return ListView( children: [ for (final todo in todos) @@ -29,4 +28,4 @@ class TodoListView extends ConsumerWidget { ], ); } -} +} \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider.mdx index 3522af5c1..bb65359db 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider.mdx @@ -2,125 +2,130 @@ title: StateProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import product from "!!raw-loader!/docs/providers/state_provider/product.dart"; import productListView from "!!raw-loader!/docs/providers/state_provider/product_list_view.dart"; -import dropdown from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/dropdown.dart"; -import sortProvider from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart"; -import connectedDropdown from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart"; +import dropdown from "!!raw-loader!/docs/providers/state_provider/dropdown.dart"; +import sortProvider from "!!raw-loader!/docs/providers/state_provider/sort_provider.dart"; +import connectedDropdown from "!!raw-loader!/docs/providers/state_provider/connected_dropdown.dart"; import sortedProductProvider from "!!raw-loader!/docs/providers/state_provider/sorted_product_provider.dart"; -import updateReadTwice from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart"; +import updateReadTwice from "!!raw-loader!/docs/providers/state_provider/update_read_twice.dart"; import updateReadOnce from "!!raw-loader!/docs/providers/state_provider/update_read_once.dart"; import { trimSnippet } from "../../../../../src/components/CodeSnippet"; -`StateProvider` è un provider che espone un modo per modificare il suo stato. -É una semplificazione di [StateNotifierProvider] e progettato per evitare di -dover scrivere una classe [StateNotifier] per casi d'uso molto semplici. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -`StateProvider` esiste principalmente per consentire la modifica di variabili **semplici** -da parte dell'interfaccia utente. -Lo stato di uno `StateProvider` è generalmente: +`StateProvider` is a provider that exposes a way to modify its state. +It is a simplification of [NotifierProvider], designed to avoid +having to write a [Notifier] class for very simple use-cases. -- un enum, come può essere un tipo di filtro -- una String, tipicamente il contenuto grezzo di un campo di testo -- un booleano, per le checkbox -- un numero, per impaginazione e campi d'età +`StateProvider` exists primarily to allow the modification of +**simple** variables by the User Interface. +The state of a `StateProvider` is typically one of: -Non dovresti usare `StateProvider` se: +- an enum, such as a filter type +- a String, typically the raw content of a text field +- a boolean, for checkboxes +- a number, for pagination or age form fields -- il tuo stato necessita di logica di validazione -- il tuo stato è un oggetto complesso (come una classe personalizzata, una lista/map ecc) -- la logica per modificare il tuo stato è più avanzata di un semplice `count++`. +You should not use `StateProvider` if: -Per casi più avanzati, considera usare [StateNotifierProvider] e creare una classe [StateNotifier]. -Anche se il codice boilerplate inizialmente sarà più grande, avere una classe [StateNotifier] -personalizzata è fondamentale per la mantenibilità a lungo termine del tuo progetto - -poichè centralizza la logica del tuo stato in un'unica posizione. +- your state needs validation logic +- your state is a complex object (such as a custom class, a list/map, ...) +- the logic for modifying your state is more advanced than a simple `count++`. -## Esempio d'uso: cambiare il tipo di filtro usando una dropdown +For more advanced cases, consider using [NotifierProvider] instead and +create a [Notifier] class. +While the initial boilerplate will be a bit larger, having a custom +[Notifier] class is critical for the long-term maintainability of your +project – as it centralizes the business logic of your state in a single place. -Un caso d'uso reale di `StateProvider` sarebbe quello di gestire lo stato di -semplici componenti di form come dropdowns/campi di testo/checkboxes. +## Usage example: Changing the filter type using a dropdown -In particolare, vedremo come usare `StateProvider` per implementare una dropdown -che permetta di cambiare come una lista di prodotti è ordinata. +A real-world use-case of `StateProvider` would be to manage the state of +simple form components like dropdowns/text fields/checkboxes. +In particular, we will see how to use `StateProvider` to implement a dropdown +that allows changing how a list of products is sorted. -Per semplificare le cose, la lista dei prodotti che otterremo sarà costruita direttamente -nell'applicazione e sarà come di seguito: +For the sake of simplicity, the list of products that we will obtain +will be built directly in the application and will be as follows: {trimSnippet(product)} -In un'applicazione reale, questa lista sarebbe stata generalmente ottenuta -usando [FutureProvider] facendo una richiesta di rete. +In a real-world application, this list would typically be obtained using +[FutureProvider] by making a network request. -L'interfaccia utente può mostrare quindi la lista dei prodotti scrivendo: +The User Interface could then show the list of products by doing: {trimSnippet(productListView)} -Ora che abbiamo finito con la base, possiamo aggiungere una dropdown, la quale ci permetterà di filtrare i nostri prodotti sia per prezzo che per nome. -Per questo, useremo [DropDownButton](https://api.flutter.dev/flutter/material/DropdownButton-class.html). +Now that we're done with the base, we can add a dropdown, which will +allow filtering our products either by price or by name. +For that, we will use [DropDownButton](https://api.flutter.dev/flutter/material/DropdownButton-class.html). {trimSnippet(dropdown)} -Ora che abbiamo una dropdown, creiamo uno `StateProvider` e -sincronizziamo lo stato della dropdown con il nostro provider. +Now that we have a dropdown, let's create a `StateProvider` and +synchronize the state of the dropdown with our provider. -Per prima cosa, creiamo il provider con `StateProvider`: +First, let's create the `StateProvider`: {trimSnippet(sortProvider)} -Successivamente possiamo connettere questo provider con la nostra dropdown -scrivendo: +Then, we can connect this provider with our dropdown by doing: {trimSnippet(connectedDropdown)} -Con questo, ora dovremmo essere in grado di cambiare il tipo di ordinamento. -Tuttavia, non ha ancora alcun impatto sulla lista dei prodotti! É ora della parte finale: -aggiornare `productsProvider` per ordinare la lista dei prodotti. +With this, we should now be able to change the sort type. +It has no impact on the list of products yet though! It's now time for the +final part: Updating our `productsProvider` to sort the list of products. -Una compenente chiave di tale implementazione è di usare [ref.watch], per far sì che `productsProvider` -ottenga il tipo di ordinamento e ricalcoli la lista dei prodotti ogni volta -che il tipo di ordinamento cambia. +A key component of implementing this is to use [ref.watch], to have +our `productsProvider` obtain the sort type and recompute the list of +products whenever the sort type changes. -L'implementazione sarà: +The implementation would be: {trimSnippet(sortedProductProvider)} -Questo è quanto! Questa modifica basta per fare in modo che l'interfaccia utente -ri-renderizzi automaticamente la lista dei prodotti quando il tipo di ordinamento cambia. +That's all! This change is enough for the User Interface to automatically +re-render the list of products when the sort type changes. -Di seguito l'esempio completo su Dartpad: +Here is the complete example on Dartpad: -## Come aggiornare lo stato basandosi sul valore precedente senza leggere il provider due volte +## How to update the state based on the previous value without reading the provider twice -Delle volte, potresti voler aggiornare lo stato di uno `StateProvider` basandosi sul valore precedente. -Naturalmente, potresti finire per scrivere: +Sometimes, you want to update the state of a `StateProvider` based on the previous value. +Naturally, you may end-up writing: {trimSnippet(updateReadTwice)} -Anche se non c'è niente di particolarmente sbagliato in questo codice, -la sintassi è un po' scomoda. +While there's nothing particularly wrong with this snippet, the syntax is a bit inconvenient. -Per migliorare la sintassi, possiamo usare la funzione `update`. Tale funzione -prenderà una funzione callback che riceverà lo stato corrente e dovrebbe -restituire il nuovo stato. -Possiamo usarla per riscrivere il nostro codice precedente in: +To make the syntax a bit better, we can use the `update` function. +This function will take a callback that will receive the current state and is expected +to return the new state. +We can use it to refactor our previous code to: {trimSnippet(updateReadOnce)} -Questa modifica ottiene lo stesso effetto ma migliora leggermente la sintassi. +This change achieves the same effect while making the syntax a bit better. -[ref.watch]: ../concepts/reading#usare-ref.watch-per-osservare-un-provider -[ref.read]: ../concepts/reading#usare-refread-per-ottenere-lo-stato-di-un-provider +[ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider +[ref.read]: ../concepts/reading#using-refread-to-obtain-the-state-of-a-provider-once [statenotifierprovider]: ./state_notifier_provider +[notifierprovider]: ./notifier_provider [futureprovider]: ./future_provider +[notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html [provider]: ./provider [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart index 163008a66..189ff3c6a 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart @@ -9,16 +9,17 @@ import 'sort_provider.dart'; Widget build(BuildContext context, WidgetRef ref) { return AppBar(actions: [ /* SNIPPET START */ - DropdownButton( - // Quando il tipo di ordinamento cambia, ricostruirà la dropdown - // per aggiornare l'icona mostrata. - value: ref.watch(productSortTypeProvider), - // Quando l'utente interagisce con la dropdown aggiorniamo lo stato del provider. - onChanged: (value) => ref.read(productSortTypeProvider.notifier).state = value!, - items: [ - // ... - ], - ), +DropdownButton( + // When the sort type changes, this will rebuild the dropdown + // to update the icon shown. + value: ref.watch(productSortTypeProvider), + // When the user interacts with the dropdown, we update the provider state. + onChanged: (value) => + ref.read(productSortTypeProvider.notifier).state = value!, + items: [ + // ... + ], +), /* SNIPPET END */ ]); } diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/dropdown.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/dropdown.dart index 13c37b5a2..18cc6b211 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/dropdown.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/dropdown.dart @@ -7,7 +7,7 @@ import 'full.dart'; /* SNIPPET START */ -// Un enum rappresentante il tipo di filtro +// An enum representing the filter type enum ProductSortType { name, price, diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 966f4dec3..4c598055f 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -41,7 +41,7 @@ enum ProductSortType { } final productSortTypeProvider = StateProvider( - // Restituiamo il tipo di ordinamento di default, in questo caso 'name'. + // We return the default sort type, here name. (ref) => ProductSortType.name, ); @@ -66,12 +66,12 @@ class MyHomePage extends ConsumerWidget { title: const Text('Products'), actions: [ DropdownButton( - // Quando il tipo di ordinamento cambia, ricostruirà la dropdown - // per aggiornare l'icona mostrata. - + // When the sort type changes, this will rebuild the dropdown + // to update the icon shown. value: ref.watch(productSortTypeProvider), - // Quando l'utente interagisce con la dropdown aggiorniamo lo stato del provider. - onChanged: (value) => ref.read(productSortTypeProvider.notifier).state = value!, + // When the user interacts with the dropdown, we update the provider state. + onChanged: (value) => + ref.read(productSortTypeProvider.notifier).state = value!, items: const [ DropdownMenuItem( value: ProductSortType.name, diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product.dart new file mode 100644 index 000000000..078def200 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product.dart @@ -0,0 +1,20 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ + +class Product { + Product({required this.name, required this.price}); + + final String name; + final double price; +} + +final _products = [ + Product(name: 'iPhone', price: 999), + Product(name: 'cookie', price: 2), + Product(name: 'ps5', price: 500), +]; + +final productsProvider = Provider>((ref) { + return _products; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product_list_view.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product_list_view.dart new file mode 100644 index 000000000..17765aea8 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product_list_view.dart @@ -0,0 +1,22 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'product.dart'; + +/* SNIPPET START */ + +Widget build(BuildContext context, WidgetRef ref) { + final products = ref.watch(productsProvider); + return Scaffold( + body: ListView.builder( + itemCount: products.length, + itemBuilder: (context, index) { + final product = products[index]; + return ListTile( + title: Text(product.name), + subtitle: Text('${product.price} \$'), + ); + }, + ), + ); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart index 259a89b1c..60a5f60c1 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart @@ -5,6 +5,6 @@ import 'dropdown.dart'; /* SNIPPET START */ final productSortTypeProvider = StateProvider( - // Restituiamo il tipo di ordinamento di default, in questo caso 'name'. + // We return the default sort type, here name. (ref) => ProductSortType.name, ); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart new file mode 100644 index 000000000..6725d0282 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart @@ -0,0 +1,24 @@ +import 'package:collection/collection.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'dropdown.dart'; +import 'product.dart'; +import 'sort_provider.dart'; + +final _products = [ + Product(name: 'iPhone', price: 999), + Product(name: 'cookie', price: 2), + Product(name: 'ps5', price: 500), +]; + +/* SNIPPET START */ + +final productsProvider = Provider>((ref) { + final sortType = ref.watch(productSortTypeProvider); + switch (sortType) { + case ProductSortType.name: + return _products.sorted((a, b) => a.name.compareTo(b.name)); + case ProductSortType.price: + return _products.sorted((a, b) => a.price.compareTo(b.price)); + } +}); \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart new file mode 100644 index 000000000..825df6d0f --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -0,0 +1,23 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +final counterProvider = StateProvider((ref) => 0); + +class HomeView extends ConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + floatingActionButton: FloatingActionButton( + onPressed: () { + /* highlight-start */ + ref.read(counterProvider.notifier).update((state) => state + 1); + /* highlight-end */ + }, + ), + ); + } +} \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index e3896c225..c029e0730 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -15,11 +15,9 @@ class HomeView extends ConsumerWidget { onPressed: () { // We're updating the state from the previous value, we ended-up reading // the provider twice! - // Stiamo aggiornando lo stato dal valore precedente, siamo finiti per - // leggere il provider due volte! ref.read(counterProvider.notifier).state = ref.read(counterProvider.notifier).state + 1; }, ), ); } -} +} \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx index 8c39a2d30..bd40cfc5f 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx @@ -2,35 +2,52 @@ title: StreamProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet,AutoSnippet } from "../../../../../src/components/CodeSnippet"; +import streamProvider from "./stream_provider/live_stream_chat_provider"; +import streamConsumer from "!!raw-loader!/docs/providers/stream_provider/live_stream_chat_consumer.dart"; -`StreamProvider` è simile a [FutureProvider] ma finalizzato per gli [Stream]s -invece che per i [Future]s. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -`StreamProvider` è solitamente usato per: +`StreamProvider` is similar to [FutureProvider] but for [Stream]s instead of +[Future]s. -- stare in ascolto di Firebase o web-sockets -- ricostruire un altro provider ogni pochi secondi +`StreamProvider` is usually used for: -Dato che gli [Stream]s espongono naturalmente un modo per stare in ascolto degli aggiornamenti, -alcuni potrebbero pensare che l'utilizzo di `StreamProvider` abbia poco valore. -In particolare, potresti credere che [StreamBuilder] di Flutter funzioni altrettanto bene per ascoltare uno [Stream], ma questo è un errore +- listening to Firebase or web-sockets +- rebuilding another provider every few seconds -Usare `StreamProvider` al posto di [StreamBuilder] ha numerosi vantaggi: +Since [Stream]s naturally expose a way for listening to updates, some may think +that using `StreamProvider` has a low value. In particular, you may believe that +Flutter's [StreamBuilder] would work just as well for listening to a [Stream], but +this is a mistake. -- permette ad altri provider di stare in ascolto dello stream usando [ref.watch]. -- assicura una corretta gestione dei casi di caricamento/errore, grazie ad [AsyncValue]. -- rimuove la necessità di differenziare gli streams di trasmissione (broadcast streams) - con gli stream normali. -- memorizza l'ultimo valore emesso dallo stream, assicurandosi che se un - listener viene aggiunto dopo l'emissione di un evento, il listener avrà comunque - accesso immediato all'evento più recente/aggiornato. -- facilita la finzione dello stream durante i test sovrascrivendo lo `StreamProvider`. +Using `StreamProvider` over [StreamBuilder] has numerous benefits: -[ref.watch]: ../concepts/reading#usare-refwatch-per-osservare-un-provider +- it allows other providers to listen to the stream using [ref.watch]. +- it ensures that loading and error cases are properly handled, thanks to [AsyncValue]. +- it removes the need for having to differentiate broadcast streams vs normal streams. +- it caches the latest value emitted by the stream, ensuring that if a + listener is added after an event is emitted, the listener will still have + immediate access to the most up-to-date event. +- it allows easily mocking the stream during tests by overriding the `StreamProvider`. + +## Usage example: live chat using sockets + +`StreamProvider` is used in when we handle stream of asynchronous data +such as Video Streaming, Weather broadcasting Apis or Live chat as follows: + + + +Then, the UI can listen to live streaming chats like so: + +{trimSnippet(streamConsumer)} + +[ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider [statenotifierprovider]: ./state_notifier_provider [provider]: ./provider [futureprovider]: ./future_provider @@ -39,4 +56,4 @@ Usare `StreamProvider` al posto di [StreamBuilder] ha numerosi vantaggi: [stream]: https://api.dart.dev/dart-async/Stream-class.html [stream.periodic]: https://api.dart.dev/stable/2.15.1/dart-async/Stream/Stream.periodic.html [family]: ../concepts/modifiers/family -[streambuilder]: https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html +[streambuilder]: https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart new file mode 100644 index 000000000..383def216 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart @@ -0,0 +1,25 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'live_stream_chat_provider.dart'; + +/* SNIPPET START */ +Widget build(BuildContext context, WidgetRef ref) { + final liveChats = ref.watch(chatProvider); + + // Like FutureProvider, it is possible to handle loading/error states using AsyncValue.when + return switch (liveChats) { + // Display all the messages in a scrollable list view. + AsyncData(:final value) => ListView.builder( + // Show messages from bottom to top + reverse: true, + itemCount: value.length, + itemBuilder: (context, index) { + final message = value[index]; + return Text(message); + }, + ), + AsyncError(:final error) => Text(error.toString()), + _ => const CircularProgressIndicator(), + }; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart new file mode 100644 index 000000000..d2bb3ad2a --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart @@ -0,0 +1,18 @@ +import 'dart:convert'; +import 'dart:io'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final chatProvider = StreamProvider>((ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart new file mode 100644 index 000000000..e2e34878c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart @@ -0,0 +1,23 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +import 'dart:convert'; +import 'dart:io'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +Stream> chat(ChatRef ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart new file mode 100644 index 000000000..ed660f3fa --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$chatHash() => r'db1302132f90e854fe2f5da9d97d89c9a3c8b858'; + +/// See also [chat]. +@ProviderFor(chat) +final chatProvider = AutoDisposeStreamProvider>.internal( + chat, + name: r'chatProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$chatHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ChatRef = AutoDisposeStreamProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart new file mode 100644 index 000000000..beb2bcd05 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart @@ -0,0 +1,18 @@ +import 'dart:convert'; +import 'dart:io'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final chatProvider = StreamProvider>((ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +}); diff --git a/website/i18n/ko/NOTE.md b/website/i18n/ko/NOTE.md new file mode 100644 index 000000000..c5348e2f5 --- /dev/null +++ b/website/i18n/ko/NOTE.md @@ -0,0 +1,22 @@ +# 한국어 번역작업 (Korean Translation) + +## 작업하기 + +- [Initialize the i18n folder](https://docusaurus.io/docs/i18n/git#initialize-the-i18n-folder) + +```shell +# 처음에 한국어 i18n 생성하기 (docusaurus) +yarn run write-translations --locale ko + +# website/i18n/ko/ 폴더에서 문서수정 +# 한국어 문서 실행하고, 최초실행시 import 폴더 구조가 안맞는 것 맞추기 +yarn run dev --locale ko + +# 빌드 +yarn run build --locale ko +# 빌드된 파일 확인 +yarn run serve + +# 작업후 문서의 생성코드 업데이트 +dart run build_runner watch --delete-conflicting-outputs +``` diff --git a/website/i18n/ko/code.json b/website/i18n/ko/code.json index f161a7b30..aff98ff4c 100644 --- a/website/i18n/ko/code.json +++ b/website/i18n/ko/code.json @@ -1,165 +1,227 @@ { "home.shared_state_title": { - "message": "어디에서나 공유할 상태를 선언하세요." + "message": "어디서나 공유 상태 선언하기" }, "home.shared_state_body": { - "message": "{main}파일과 UI 파일간 이동할 필요가 없습니다.\n{br}\n테스트 가능성을 잃지 않고 공유 상태의 코드를 그것이 속한 곳에 별도의 패키지에 있거나 그것을 필요로 하는 위젯 바로 옆에 배치하십시오.", + "message": "더 이상 {main}과 UI 파일 사이를 오갈 필요가 없습니다.{br}\n공유 상태의 코드를 별도의 패키지에 넣든, 필요한 위젯 바로 옆에 넣든, 테스트 가능성을 잃지 않고 적절한 위치에 배치하세요.", "description": "The homepage input placeholder" }, "home.recompute_title": { - "message": "상태를 다시 계산하거나 필요할 때만 UI를 다시 빌드합니다." + "message": "필요할 때만 상태 재계산/UI 재빌드" }, "home.recompute_body": { - "message": "더 이상 {build} 메서드 내에서 목록을 정렬/필터링하거나 고급 캐시 메커니즘에 의존할 필요가 없습니다. {br} {br}\n{Provider} 및 {families}를 사용하여 목록을 정렬하거나 필요할 때만 HTTP\n요청을 수행하세요." + "message": "더 이상 {build} 메서드 내에서 목록을 정렬/필터링하거나 고급 캐시 메커니즘에 의존할 필요가 없습니다.{br} {br}\n{Provider}와 {families}를 사용하여 목록을 정렬하거나 {truly} 필요한 경우에만 HTTP 요청을 수행하세요." + }, + "home.refactors_title": { + "message": "리팩터로 일상적인 작업을 간소화하세요." + }, + "home.refactors_body": { + "message": "Riverpod은 \"Consumer로 위젯 감싸기\"등 다양한 리팩터(refactors)를 제공합니다..\n{warnings}를 살펴보세요." + }, + "home.refactors_list_link": { + "message": "리팩터링 목록" + }, + "home.lint_title": { + "message": "린트 규칙으로 코드의 유지보수성 유지" + }, + "home.lint_body": { + "message": "Riverpod에 특화된 새로운 린트 규칙이 구현되고 더 많은 규칙이 지속적으로 추가됩니다.\n 이렇게 하면 코드가 최상의 상태를 유지할 수 있습니다. {warnings}를 살펴보세요." + }, + "home.lint_rules_list_link": { + "message": "린트 규칙 목록" }, "home.safe_read_title": { - "message": "안전하게 Provider 읽기" + "message": "안전하게 provider 읽기" }, "home.safe_read_body": { - "message": "Provider를 읽는 중 더 이상 bad state가 되지 않습니다. 만약\nProvider를 읽기 위한 필요한 코드를 작성하면, 당신은 유효한 값을 얻을 수 있습니다.\n {br} {br}\n Provider는 비동기적으로 로드된 값에도 적용됩니다. 제공자와는 대조적으로 Riverpod는 로드/오류 사례를 깔끔하게 처리할 수 있습니다." + "message": "provider를 읽었을때 절대로 나쁜 상태(bad state)의 결과가 되지 않습니다. 공급자를 읽는 데 필요한 코드를 작성할 수 있다면 유효한 값(valid value)을 얻을 수 있습니다. {br} {br}이는 비동기적으로 로드된 값에도 적용됩니다. Provider와 달리 Riverpod를 사용하면 로딩/오류 사례를 깔끔하게 처리할 수 있습니다." }, "home.devtool_title": { - "message": "Devtool에서 상태를 관찰하세요." + "message": "개발 도구에서 상태 조사하기" }, "home.devtool_body": { - "message": "Riverpod을 사용하면 Flutter의 devtool 내부에서 상자 밖에서 상태를 확인할 수 있습니다. {br}\n 게다가, 진행 상태를 감시할 수 있습니다." + "message": "Riverpod을 사용하면 Flutter의 개발 도구에서 상태를 바로 확인할 수 있습니다. {br}또한, 완전한 상태 인스펙터(state-inspector)가 개발 중입니다." }, - "homepage.compile_safe_title": { - "message": "안전한 컴파일" + "homepage.declarative_title": { + "message": "선언적 프로그래밍" }, - "homepage.compile_safe_body": { - "message": "더 이상 {ProviderNotFound} 예외가 발생하지 않고, 로딩 상태를 처리하는 것을 걱정하지 않아도 됩니다. Riverpod를 사용하면 코드가 컴파일되어 작동합니다." + "homepage.declarative_body": { + "message": "Stateless 위젯과 유사한 방식으로 비즈니스 로직을 작성하세요.{br}필요할 때 네트워크 요청이 자동으로 재계산되도록 하고 로직을 쉽게 reusable/composable/maintainable 하게 만드세요." }, - "homepage.unlimited_provider_title": { - "message": "제한없는 Provider" + "homepage.common_ui_patterns_title": { + "message": "일반적인 UI 패턴을 쉽게 구현" }, - "homepage.unlimited_provider_body": { - "message": "Riverpod는 Provider에서 영감을 얻었지만 동일한 유형의 여러 Provider를 지원하는 것과 같은 주요 문제 중 일부를 해결합니다. 비동기 Provider를 기다리고 있습니다. 어디에서나 Provider를 추가하세요." + "homepage.common_ui_patterns_body": { + "message": "Riverpod을 사용하면,\"당겨서 새로고침\"/ \"타이핑하는대로 검색\"/등 일반적이지만 복잡한 UI 패턴을 몇 줄의 코드만으로 처리할 수 있습니다." }, - "homepage.no_flutter_dependency_title": { - "message": "Flutter에 의존하지 않습니다." + "homepage.tooling_ready_title": { + "message": "준비된 도구" }, - "homepage.no_flutter_dependency_body": { - "message": "Flutter에 의존하지 않고 Provider를 생성/공유/테스트합니다. 여기에는 {BuildContext} 없이 Provider를 수신할 수 있는 기능이 포함됩니다." + "homepage.tooling_ready_body": { + "message": "Riverpod은 일반적인 실수를 컴파일 에러로 처리하여 컴파일러를 향상시킵니다. 또한 사용자 정의 린트 규칙과 리팩터링 옵션도 제공합니다. 문서 생성을 위한 명령줄도 있습니다." + }, + "homepage.features_title": { + "message": "기능" }, "home.tagline": { - "message": "리엑티브 캐싱, 데이터바인딩 프레임워크" + "message": "리액티브 캐싱 및 데이터 바인딩 프레임워크" }, "home.get_started": { "message": "시작하기" }, "home.create_provider": { - "message": "Provider 생성하기" + "message": "네트워크 요청 만들기" }, "home.consume_provider": { - "message": "Provider 사용하기" + "message": "UI에서 네트워크 요청 수신" + }, + "theme.docs.versions.unreleasedVersionLabel": { + "message": "{siteTitle} {versionLabel}버전에 대한 미공개 문서입니다.", + "description": "The label used to tell the user that he's browsing an unreleased doc version" + }, + "theme.docs.versions.unmaintainedVersionLabel": { + "message": "이 문서는 더 이상 활발하게 유지 관리되지 않는 {siteTitle} {versionLabel}에 대한 문서입니다.", + "description": "The label used to tell the user that he's browsing an unmaintained doc version" + }, + "theme.docs.versions.latestVersionSuggestionLabel": { + "message": "최신 문서는 {latestVersionLink} ({versionLabel})를 참고하세요.", + "description": "The label used to tell the user to check the latest version" + }, + "theme.docs.versions.latestVersionLinkLabel": { + "message": "최신 버전", + "description": "The label used for the latest version suggestion link label" + }, + "custom.outdatedTranslations": { + "message": "이 페이지의 콘텐츠가 오래되었을 수 있습니다. 대신 {englishLink}를 확인해 보세요.", + "description": "The label used inside the outdated translation banner" + }, + "custom.outdatedTranslationLink": { + "message": "english version", + "description": "The link that redirects to the equivalent English doc" + }, + "Code generation": { + "message": "코드생성(code generation)" + }, + "About code generation": { + "message": "코드생성(code generation)에 대한 정보" + }, + "About hooks": { + "message": "훅(Hook)에 대한 정보" }, "theme.ErrorPageContent.title": { - "message": "이 문서가 깨졌습니다.", + "message": "이 페이지가 충돌했습니다.", "description": "The title of the fallback page when the page crashed" }, - "theme.ErrorPageContent.tryAgain": { - "message": "다시 시도해 보세요", - "description": "The label of the button to try again when the page crashed" - }, "theme.NotFound.title": { - "message": "페이지를 찾을 수 없습니다.", + "message": "페이지를 찾을 수 없음", "description": "The title of the 404 page" }, "theme.NotFound.p1": { - "message": "원하는 페이지를 찾을 수 없습니다.", + "message": "원하는 항목을 찾을 수 없습니다.", "description": "The first paragraph of the 404 page" }, "theme.NotFound.p2": { - "message": "사이트 관리자에게 링크가 깨진 것을 알려주세요.", + "message": "원래 URL로 연결한 사이트의 소유자에게 연락하여 링크가 끊어졌다는 사실을 알려주세요.", "description": "The 2nd paragraph of the 404 page" }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "닫기", - "description": "The ARIA label for close button of announcement bar" + "theme.admonition.note": { + "message": "노트", + "description": "The default label used for the Note admonition (:::note)" + }, + "theme.admonition.tip": { + "message": "팁", + "description": "The default label used for the Tip admonition (:::tip)" + }, + "theme.admonition.danger": { + "message": "위험", + "description": "The default label used for the Danger admonition (:::danger)" + }, + "theme.admonition.info": { + "message": "정보", + "description": "The default label used for the Info admonition (:::info)" + }, + "theme.admonition.caution": { + "message": "주의", + "description": "The default label used for the Caution admonition (:::caution)" }, "theme.BackToTopButton.buttonAriaLabel": { - "message": "맨 위로 스크롤하기", + "message": "맨 위로 스크롤", "description": "The ARIA label for the back to top button" }, "theme.blog.archive.title": { - "message": "게시물 목록", + "message": "아카이브", "description": "The page & hero title of the blog archive page" }, "theme.blog.archive.description": { - "message": "게시물 목록", + "message": "아카이브", "description": "The page & hero description of the blog archive page" }, "theme.blog.paginator.navAriaLabel": { - "message": "블로그 게시물 목록 탐색", + "message": "블로그 목록 페이지 탐색", "description": "The ARIA label for the blog pagination" }, "theme.blog.paginator.newerEntries": { - "message": "이전 페이지", + "message": "신규 항목", "description": "The label used to navigate to the newer blog posts page (previous page)" }, "theme.blog.paginator.olderEntries": { - "message": "다음 페이지", + "message": "이전 항목", "description": "The label used to navigate to the older blog posts page (next page)" }, - "theme.blog.post.readingTime.plurals": { - "message": "약 {readingTime}분", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.post.readMore": { - "message": "자세히 보기", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, "theme.blog.post.paginator.navAriaLabel": { - "message": "블로그 게시물 탐색", + "message": "블로그 포스트 페이지 탐색", "description": "The ARIA label for the blog posts pagination" }, "theme.blog.post.paginator.newerPost": { - "message": "이전 게시물", + "message": "신규 포스트", "description": "The blog post button label to navigate to the newer/previous post" }, "theme.blog.post.paginator.olderPost": { - "message": "다음 게시물", + "message": "이전 포스트", "description": "The blog post button label to navigate to the older/next post" }, - "theme.blog.sidebar.navAriaLabel": { - "message": "최근 블로그 문서 둘러보기", - "description": "The ARIA label for recent posts in the blog sidebar" - }, "theme.blog.post.plurals": { - "message": "{count}개 게시물", + "message": "포스트 1개|{count}개 포스트", "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" }, "theme.blog.tagTitle": { - "message": "\"{tagName}\" 태그로 연결된 {nPosts}개의 게시물이 있습니다.", + "message": "\"{tagName}\"으로 태그된 {nPosts}", "description": "The title of the page for a blog tag" }, "theme.tags.tagsPageLink": { "message": "모든 태그 보기", "description": "The label of the link targeting the tag list page" }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "클립보드에 코드 복사", - "description": "The ARIA label for copy code blocks button" + "theme.colorToggle.ariaLabel": { + "message": "어두운 모드와 밝은 모드 간 전환 (현재 {mode})", + "description": "The ARIA label for the navbar color mode toggle" }, - "theme.CodeBlock.copied": { - "message": "복사했습니다", - "description": "The copied button label on code blocks" + "theme.colorToggle.ariaLabel.mode.dark": { + "message": "다크 모드", + "description": "The name for the dark color mode" }, - "theme.CodeBlock.copy": { - "message": "복사", - "description": "The copy button label on code blocks" + "theme.colorToggle.ariaLabel.mode.light": { + "message": "라이트 모드", + "description": "The name for the light color mode" }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "사이드바 열기", - "description": "The ARIA label and title attribute for expand button of doc sidebar" + "theme.docs.breadcrumbs.navAriaLabel": { + "message": "경로", + "description": "The ARIA label for the breadcrumbs" }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "사이드바 열기", - "description": "The ARIA label and title attribute for expand button of doc sidebar" + "theme.docs.DocCard.categoryDescription": { + "message": "{count}개 아이템", + "description": "The default description for a category card in the generated index about how many items this category includes" + }, + "theme.docs.tagDocListPageTitle.nDocsTagged": { + "message": "태그가 지정된 문서 1개|태그가 지정된 문서 {count}개", + "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" + }, + "theme.docs.tagDocListPageTitle": { + "message": "{nDocsTagged} with \"{tagName}\"", + "description": "The title of the page for a docs tag" }, "theme.docs.paginator.navAriaLabel": { - "message": "문서 탐색", + "message": "문서 페이지", "description": "The ARIA label for the docs pagination" }, "theme.docs.paginator.previous": { @@ -170,96 +232,142 @@ "message": "다음", "description": "The label used to navigate to the next doc" }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "사이드바 숨기기", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "사이드바 숨기기", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { - "message": "접을 수 있는 사이드바 분류 '{label}' 접기(펼치기)", - "description": "The ARIA label to toggle the collapsible sidebar category" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "{count} 개 문서가", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged} \"{tagName}\" 태그에 분류되었습니다", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "{siteTitle} {versionLabel} 문서는 아직 정식 공개되지 않았습니다.", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "{siteTitle} {versionLabel} 문서는 더 이상 업데이트되지 않습니다.", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "최신 문서는 {latestVersionLink} ({versionLabel})을 확인하세요.", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "최신 버전", - "description": "The label used for the latest version suggestion link label" + "theme.docs.versionBadge.label": { + "message": "버전: {versionLabel}" }, "theme.common.editThisPage": { - "message": "페이지 편집", + "message": "이 페이지 수정하기", "description": "The link label to edit the current page" }, "theme.common.headingLinkTitle": { - "message": "제목으로 바로 가기", + "message": "{heading}으로 직접 링크", "description": "Title for link to heading" }, "theme.lastUpdated.atDate": { - "message": "갱신일: {date}", + "message": " on {date}", "description": "The words used to describe on which date a page has been last updated" }, "theme.lastUpdated.byUser": { - "message": "갱신자: {user}", + "message": " by {user}", "description": "The words used to describe by who the page has been last updated" }, "theme.lastUpdated.lastUpdatedAtBy": { - "message": "{atDate} {byUser} 마지막으로 업데이트했습니다.", + "message": "최근 업데이트{atDate}{byUser}", "description": "The sentence used to display when a page has been last updated, and by who" }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "← 메인 메뉴로 돌아가기", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, "theme.navbar.mobileVersionsDropdown.label": { "message": "버전", "description": "The label for the navbar versions dropdown on mobile view" }, - "theme.common.skipToMainContent": { - "message": "본문으로 건너뛰기", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, "theme.tags.tagsListLabel": { "message": "태그:", "description": "The label alongside a tag list" }, + "theme.AnnouncementBar.closeButtonAriaLabel": { + "message": "닫기", + "description": "The ARIA label for close button of announcement bar" + }, + "theme.blog.sidebar.navAriaLabel": { + "message": "블로그 최근 게시물 탐색", + "description": "The ARIA label for recent posts in the blog sidebar" + }, + "theme.CodeBlock.copied": { + "message": "복사됨", + "description": "The copied button label on code blocks" + }, + "theme.CodeBlock.copyButtonAriaLabel": { + "message": "코드를 클립보드로 복사", + "description": "The ARIA label for copy code blocks button" + }, + "theme.CodeBlock.copy": { + "message": "복사", + "description": "The copy button label on code blocks" + }, + "theme.CodeBlock.wordWrapToggle": { + "message": "단어 줄바꿈 토글", + "description": "The title attribute for toggle word wrapping button of code block lines" + }, + "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { + "message": "접을 수 있는 사이드바 카테고리 '{label}' 토글", + "description": "The ARIA label to toggle the collapsible sidebar category" + }, + "theme.NavBar.navAriaLabel": { + "message": "Main", + "description": "The ARIA label for the main navigation" + }, + "theme.navbar.mobileLanguageDropdown.label": { + "message": "Languages", + "description": "The label for the mobile language switcher dropdown" + }, "theme.TOCCollapsible.toggleButtonLabel": { "message": "이 페이지에서", "description": "The label used by the button on the collapsible TOC component" }, + "theme.blog.post.readMore": { + "message": "자세히 보기", + "description": "The label used in blog post item excerpts to link to full blog posts" + }, + "theme.blog.post.readMoreLabel": { + "message": "{title}에 대해 자세히 알아보기", + "description": "The ARIA label for the link to full blog posts from excerpts" + }, + "theme.blog.post.readingTime.plurals": { + "message": "1분 읽기|{readingTime}분 읽기", + "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" + }, + "theme.docs.breadcrumbs.home": { + "message": "홈페이지", + "description": "The ARIA label for the home page in the breadcrumbs" + }, + "theme.docs.sidebar.collapseButtonTitle": { + "message": "사이드바 접기", + "description": "The title attribute for collapse button of doc sidebar" + }, + "theme.docs.sidebar.collapseButtonAriaLabel": { + "message": "사이드바 접기", + "description": "The title attribute for collapse button of doc sidebar" + }, + "theme.docs.sidebar.navAriaLabel": { + "message": "문서 사이드바", + "description": "The ARIA label for the sidebar navigation" + }, + "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { + "message": "← 메인 메뉴로 돌아가기", + "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" + }, + "theme.docs.sidebar.closeSidebarButtonAriaLabel": { + "message": "네비게이션바 닫기", + "description": "The ARIA label for close button of mobile sidebar" + }, + "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { + "message": "네비게이션바 토글", + "description": "The ARIA label for hamburger menu button of mobile navigation" + }, + "theme.docs.sidebar.expandButtonTitle": { + "message": "사이드바 확장", + "description": "The ARIA label and title attribute for expand button of doc sidebar" + }, + "theme.docs.sidebar.expandButtonAriaLabel": { + "message": "사이드바 확장", + "description": "The ARIA label and title attribute for expand button of doc sidebar" + }, + "theme.SearchBar.seeAll": { + "message": "{count}개 결과 모두 보기" + }, "theme.SearchPage.documentsFound.plurals": { - "message": "{count}개 문서를 찾았습니다.", + "message": "문서 1개 발견|{count}개 문서 발견", "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" }, "theme.SearchPage.existingResultsTitle": { - "message": "\"{query}\"개 검색 결과가 있습니다.", + "message": "\"{query}\"에 대한 검색 결과", "description": "The search page title for non-empty query" }, "theme.SearchPage.emptyResultsTitle": { - "message": "문서를 검색합니다.", + "message": "문서 검색", "description": "The search page title for empty query" }, "theme.SearchPage.inputPlaceholder": { - "message": "여기에 검색할 키워드를 입력하세요.", + "message": "여기에 검색어를 입력하세요", "description": "The placeholder for search page input" }, "theme.SearchPage.inputLabel": { @@ -271,17 +379,117 @@ "description": "The ARIA label for Algolia mention" }, "theme.SearchPage.noResultsText": { - "message": "검색 결과가 없습니다.", + "message": "검색 결과 없음", "description": "The paragraph for empty search result" }, "theme.SearchPage.fetchingNewResults": { - "message": "새로운 검색 결과를 얻을 수 있습니다...", + "message": "새로운 결과 가져오기...", "description": "The paragraph for fetching new search results" }, "theme.SearchBar.label": { "message": "검색", "description": "The ARIA label and placeholder for search button" }, + "theme.SearchModal.searchBox.resetButtonTitle": { + "message": "검색어 지우기", + "description": "The label and ARIA label for search box reset button" + }, + "theme.SearchModal.searchBox.cancelButtonText": { + "message": "취소", + "description": "The label and ARIA label for search box cancel button" + }, + "theme.SearchModal.startScreen.recentSearchesTitle": { + "message": "최근 검색", + "description": "The title for recent searches" + }, + "theme.SearchModal.startScreen.noRecentSearchesText": { + "message": "최근 검색어 없음", + "description": "The text when no recent searches" + }, + "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": { + "message": "이 검색 저장", + "description": "The label for save recent search button" + }, + "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": { + "message": "검색 기록에서 이 검색어 삭제", + "description": "The label for remove recent search button" + }, + "theme.SearchModal.startScreen.favoriteSearchesTitle": { + "message": "즐겨찾기", + "description": "The title for favorite searches" + }, + "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": { + "message": "즐겨찾기에서 이 검색어 제거하기", + "description": "The label for remove favorite search button" + }, + "theme.SearchModal.errorScreen.titleText": { + "message": "결과를 가져올 수 없습니다.", + "description": "The title for error screen of search modal" + }, + "theme.SearchModal.errorScreen.helpText": { + "message": "네트워크 연결을 확인해 보세요.", + "description": "The help text for error screen of search modal" + }, + "theme.SearchModal.footer.selectText": { + "message": "선택", + "description": "The explanatory text of the action for the enter key" + }, + "theme.SearchModal.footer.selectKeyAriaLabel": { + "message": "Enter key", + "description": "The ARIA label for the Enter key button that makes the selection" + }, + "theme.SearchModal.footer.navigateText": { + "message": "탐색", + "description": "The explanatory text of the action for the Arrow up and Arrow down key" + }, + "theme.SearchModal.footer.navigateUpKeyAriaLabel": { + "message": "위 화살표", + "description": "The ARIA label for the Arrow up key button that makes the navigation" + }, + "theme.SearchModal.footer.navigateDownKeyAriaLabel": { + "message": "아래 화살표", + "description": "The ARIA label for the Arrow down key button that makes the navigation" + }, + "theme.SearchModal.footer.closeText": { + "message": "닫기", + "description": "The explanatory text of the action for Escape key" + }, + "theme.SearchModal.footer.closeKeyAriaLabel": { + "message": "나가기 키", + "description": "The ARIA label for the Escape key button that close the modal" + }, + "theme.SearchModal.footer.searchByText": { + "message": "Search by", + "description": "The text explain that the search is making by Algolia" + }, + "theme.SearchModal.noResultsScreen.noResultsText": { + "message": "결과가 없습니다", + "description": "The text explains that there are no results for the following search" + }, + "theme.SearchModal.noResultsScreen.suggestedQueryText": { + "message": "검색해보세요", + "description": "The text for the suggested query when no results are found for the following search" + }, + "theme.SearchModal.noResultsScreen.reportMissingResultsText": { + "message": "이 검색어가 결과를 반환해야 한다고 생각하시나요?", + "description": "The text for the question where the user thinks there are missing results" + }, + "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": { + "message": "저희에게 알려주세요.", + "description": "The text for the link to report missing results" + }, + "theme.SearchModal.placeholder": { + "message": "문서 검색", + "description": "The placeholder of the input of the DocSearch pop-up modal" + }, + "theme.ErrorPageContent.tryAgain": { + "message": "다시 시도", + "description": "The label of the button to try again rendering when the React error boundary captures an error" + }, + "theme.common.skipToMainContent": { + "message": "주요 콘텐츠로 건너뛰기", + "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" + }, "theme.tags.tagsPageTitle": { "message": "태그", "description": "The title of the tag list page" diff --git a/website/i18n/ko/docusaurus-plugin-content-blog/options.json b/website/i18n/ko/docusaurus-plugin-content-blog/options.json index bdb16439e..9239ff706 100644 --- a/website/i18n/ko/docusaurus-plugin-content-blog/options.json +++ b/website/i18n/ko/docusaurus-plugin-content-blog/options.json @@ -11,4 +11,4 @@ "message": "Recent posts", "description": "The label for the left sidebar" } -} \ No newline at end of file +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current.json b/website/i18n/ko/docusaurus-plugin-content-docs/current.json index 6e09ba821..ca339c131 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current.json +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current.json @@ -3,33 +3,57 @@ "message": "다음", "description": "The label for version current" }, - "sidebar.Sidebar.category.Guides": { - "message": "가이드", - "description": "The label for category Guides in sidebar Sidebar" + "sidebar.Sidebar.category.Introduction": { + "message": "소개(Introduction)", + "description": "The label for category Introduction in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Riverpod for Provider Users": { + "message": "Provider 사용자를 위한 Riverpod", + "description": "The label for category Riverpod for Provider Users in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Essentials": { + "message": "필수사항(Essentials)", + "description": "The label for category Essentials in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Case studies": { + "message": "사례 연구(Case studies)", + "description": "The label for category Case studies in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Advanced topics": { + "message": "고급 주제(Advanced topics)", + "description": "The label for category Advanced topics in sidebar Sidebar" }, "sidebar.Sidebar.category.Concepts": { - "message": "컨셉", + "message": "기본 개념(Concepts)", "description": "The label for category Concepts in sidebar Sidebar" }, - "sidebar.Sidebar.category.Modifiers": { - "message": "수식어", - "description": "The label for category Modifiers in sidebar Sidebar" - }, - "sidebar.Sidebar.category.Migration": { - "message": "마이그레이션", - "description": "The label for category Migration in sidebar Sidebar" + "sidebar.Sidebar.category.Migration guides": { + "message": "마이그레이션 가이드", + "description": "The label for category Migration guides in sidebar Sidebar" }, "sidebar.Sidebar.category.Official examples": { - "message": "사용예제(공식)", + "message": "공식 사용예제", "description": "The label for category Official examples in sidebar Sidebar" }, "sidebar.Sidebar.category.Third party examples": { - "message": "사용예제(서드파티)", + "message": "서드파티 사용예제", "description": "The label for category Third party examples in sidebar Sidebar" }, - "sidebar.Sidebar.category.Api references": { - "message": "Api 레퍼런스", - "description": "The label for category Api references in sidebar Sidebar" + "sidebar.Sidebar.category.Concepts 🚧": { + "message": "기본 개념(Concepts) 🚧", + "description": "The label for category Concepts 🚧 in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Modifiers": { + "message": "수식어(Modifiers)", + "description": "The label for category Modifiers in sidebar Sidebar" + }, + "sidebar.Sidebar.category.All Providers 🚧": { + "message": "전체 Providers 🚧", + "description": "The label for category All Providers 🚧 in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Guides 🚧": { + "message": "가이드 🚧", + "description": "The label for category Guides 🚧 in sidebar Sidebar" }, "sidebar.Sidebar.link.Counter": { "message": "카운터 앱", @@ -39,12 +63,16 @@ "message": "Todo 앱", "description": "The label for link Todo list in sidebar Sidebar, linking to https://github.com/rrousselGit/riverpod/tree/master/examples/todos" }, + "sidebar.Sidebar.link.Pub.dev client": { + "message": "Pub.dev 클라이언트", + "description": "The label for link Pub.dev client in sidebar Sidebar, linking to https://github.com/rrousselGit/riverpod/tree/master/examples/pub" + }, "sidebar.Sidebar.link.Marvel API": { "message": "Marvel API", "description": "The label for link Marvel API in sidebar Sidebar, linking to https://github.com/rrousselGit/riverpod/tree/master/examples/marvel" }, "sidebar.Sidebar.link.Android Launcher": { - "message": "Android Launcher", + "message": "안드로이드 Launcher", "description": "The label for link Android Launcher in sidebar Sidebar, linking to https://github.com/lohanidamodar/fl_live_launcher" }, "sidebar.Sidebar.link.Worldtime Clock": { @@ -55,32 +83,28 @@ "message": "사전 앱", "description": "The label for link Dictionary App in sidebar Sidebar, linking to https://github.com/lohanidamodar/fl_dictio" }, - "sidebar.Sidebar.link.Firebase Starter": { - "message": "Firebase 스타터", - "description": "The label for link Firebase Starter in sidebar Sidebar, linking to https://github.com/lohanidamodar/flutter_firebase_starter/tree/feature/riverpod" - }, "sidebar.Sidebar.link.Time Tracking App (with Firebase)": { "message": "시간관리 앱 (with Firebase)", "description": "The label for link Time Tracking App (with Firebase) in sidebar Sidebar, linking to https://github.com/bizz84/starter_architecture_flutter_firebase" }, "sidebar.Sidebar.link.Firebase Phone Authentication with Riverpod": { - "message": "전화번호 인증 (with Firebase)", + "message": "Riverpod을 사용한 Firebase 전화번호 인증", "description": "The label for link Firebase Phone Authentication with Riverpod in sidebar Sidebar, linking to https://github.com/julienlebren/flutter_firebase_phone_auth_riverpod" }, "sidebar.Sidebar.link.ListView paging with search": { - "message": "검색기능을 포함한 리스트 페이징", + "message": "검색지원 리스트 페이징", "description": "The label for link ListView paging with search in sidebar Sidebar, linking to https://github.com/tbm98/flutter_loadmore_search" }, - "sidebar.Sidebar.link.Resocoder's Weather Bloc to Weather Riverpod": { - "message": "날씨 앱 (Resocoder's)", - "description": "The label for link Resocoder's Weather Bloc to Weather Riverpod in sidebar Sidebar, linking to https://github.com/campanagerald/flutter-bloc-library-v1-tutorial" + "sidebar.Sidebar.link.Resocoder's Weather Bloc to Weather Riverpod V2": { + "message": "Resocoder의 날씨 Bloc to 날씨 Riverpod V2", + "description": "The label for link Resocoder's Weather Bloc to Weather Riverpod V2 in sidebar Sidebar, linking to https://github.com/coyksdev/flutter-bloc-library-v1-tutorial" }, "sidebar.Sidebar.link.Blood Pressure Tracker App": { - "message": "혈압관리 앱", + "message": "혈압 트래커 앱", "description": "The label for link Blood Pressure Tracker App in sidebar Sidebar, linking to https://github.com/UrosTodosijevic/blood_pressure_tracker" }, "sidebar.Sidebar.link.Firebase Authentication with Riverpod Following Flutter DDD Architecture Pattern": { - "message": "Riverpod와 DDD 아키텍처 패던을 적용한 Firebase 인증(Authentication)", + "message": "Flutter DDD 아키텍처 패턴을 따르는 Riverpod을 사용한 Firebase 인증", "description": "The label for link Firebase Authentication with Riverpod Following Flutter DDD Architecture Pattern in sidebar Sidebar, linking to https://github.com/pythonhubpy/firebase_authentication_flutter_DDD" }, "sidebar.Sidebar.link.Todo App with Backup and Restore feature": { @@ -88,35 +112,39 @@ "description": "The label for link Todo App with Backup and Restore feature in sidebar Sidebar, linking to https://github.com/TheAlphaApp/flutter_riverpod_todo_app" }, "sidebar.Sidebar.link.Integrating Hive database with Riverpod (simple example)": { - "message": "Hive 데이터베이스", + "message": "Hive 데이터베이스와 Riverpod 통합하기(간단한 예제)", "description": "The label for link Integrating Hive database with Riverpod (simple example) in sidebar Sidebar, linking to https://github.com/GitGud31/theme_riverpod_hive" }, "sidebar.Sidebar.link.Browser App with Riverpod": { - "message": "브라우저 앱", - "description": "The label for link Browser App with Riverpod, linking to https://github.com/MarioCroSite/simple_browser_app" + "message": "Riverpod을 사용한 브라우저 앱", + "description": "The label for link Browser App with Riverpod in sidebar Sidebar, linking to https://github.com/MarioCroSite/simple_browser_app" }, "sidebar.Sidebar.link.GoRouter with Riverpod": { - "message": "GoRouter", - "description": "The label for link GoRouter with Riverpod, linking to https://github.com/lucavenir/go_router_riverpod" + "message": "Riverpod을 사용한 Go라우터", + "description": "The label for link GoRouter with Riverpod in sidebar Sidebar, linking to https://github.com/lucavenir/go_router_riverpod" }, "sidebar.Sidebar.link.Piano Chords Test": { "message": "피아노 화음 테스트", - "description": "The label for link Piano Chords Test, linking to https://github.com/akvus/piano_fun" + "description": "The label for link Piano Chords Test in sidebar Sidebar, linking to https://github.com/akvus/piano_fun" + }, + "sidebar.Sidebar.link.Movies API App with Caching & Pagination": { + "message": "캐싱 및 페이징이 있는 동영상 API 앱", + "description": "The label for link Movies API App with Caching & Pagination in sidebar Sidebar, linking to https://github.com/Roaa94/movies_app" }, - "sidebar.Sidebar.category.All Providers": { - "message": "프로바이더", - "description": "The label for category All Providers in sidebar Sidebar" + "sidebar.Sidebar.link.AWS Amplify Storage Gallery App with Riverpod & Freezed": { + "message": "Riverpod과 Freezed를 사용한 AWS Amplify 저장소 갤러리 앱", + "description": "The label for link AWS Amplify Storage Gallery App with Riverpod & Freezed in sidebar Sidebar, linking to https://github.com/offlineprogrammer/amplify_storage_app" }, - "sidebar.Sidebar.link.riverpod": { - "message": "riverpod", - "description": "The label for link riverpod in sidebar Sidebar, linking to https://pub.dev/documentation/riverpod/latest/riverpod/riverpod-library.html" + "sidebar.Sidebar.link.Clean Architecture demonstration with Riverpod": { + "message": "Riverpod을 사용한 클린 아키텍처 데모", + "description": "The label for link Clean Architecture demonstration with Riverpod in sidebar Sidebar, linking to https://github.com/Uuttssaavv/flutter-clean-architecture-riverpod" }, - "sidebar.Sidebar.link.flutter_riverpod": { - "message": "flutter_riverpod", - "description": "The label for link flutter_riverpod in sidebar Sidebar, linking to https://pub.dev/documentation//flutter_riverpod/latest/flutter_riverpod/flutter_riverpod-library.html" + "sidebar.Sidebar.link.Delivery App with Google Maps and Live Tracking": { + "message": "Google 지도 및 실시간 추적 기능을 갖춘 배달 앱", + "description": "The label for link Delivery App with Google Maps and Live Tracking in sidebar Sidebar, linking to https://github.com/AhmedLSayed9/deliverzler" }, - "sidebar.Sidebar.link.hooks_riverpod": { - "message": "hooks_riverpod", - "description": "The label for link hooks_riverpod in sidebar Sidebar, linking to https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/hooks_riverpod-library.html" + "sidebar.Sidebar.link.API reference": { + "message": "API 참조", + "description": "The label for link API reference in sidebar Sidebar, linking to https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/hooks_riverpod-library.html" } } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_code_generation.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_code_generation.mdx deleted file mode 100644 index 3875144bc..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_code_generation.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Code Generation 알아보기 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import fetchUser from "!!raw-loader!./about_codegen/main.dart"; -import rawFetchUser from "!!raw-loader!./about_codegen/raw.dart"; -import { - trimSnippet, - CodeSnippet, -} from "../../../../src/components/CodeSnippet"; - -Code generation is the idea of using a tool to generate code for us. -In Dart, it comes with the downside of requiring an extra step to "compile" -an application. Although this problem may be solved in the near future, as the -Dart team is working on a potential solution to this problem. - -In the context of Riverpod, code generation is about slightly changing the syntax -for defining a "provider". For example, instead of: - -{trimSnippet(rawFetchUser)} - -Using code generation, we would write: - -{trimSnippet(fetchUser)} - -When using Riverpod, code generation is completely optional. It is entirely possible -to use Riverpod without. -At the same time, Riverpod embraces code generation and recommends using it. - -For information on how to install and use Riverpod's code generator, refer to -the [getting started](./getting_started) page. Make sure to enable code generation -in the documentation's sidebar. - -## Why use code generation with Riverpod? - -You may be wondering: "If code generation is optional in Riverpod, why use it?" - -As always with packages: To make your life easier. -This includes but is not limited to: - -- better syntax, more readable/flexible and with reduced learning curve. - - - No need to worry about `FutureProvider` vs `Provider` vs etc. Write your logic, - and Riverpod will pick the most suitable provider for you. - - Passing parameters to providers is now unrestricted. Instead of being limited to - using [family](./concepts/modifiers/family) and passing a single positional parameter, - you can now pass any form of parameter. This includes named parametes, optional ones, - and even default values. - -- **stateful hot-reload** of the code written in Riverpod. -- better debugging, through the generation of extra metadata that the debugger then picks-up. -- some Riverpod features will be available only with code generation. - -At the same time, many applications already use code generation with packages such -as [Freezed](https://pub.dev/packages/freezed) or [json_serializable](https://pub.dev/packages/json_serializable). -In that case, your project probably is already setup for code generation, and -using for Riverpod should be simple. - -[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html -[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html -[riverpod]: https://github.com/rrousselgit/riverpod -[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod -[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod -[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_hooks.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_hooks.mdx deleted file mode 100644 index 229757933..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_hooks.mdx +++ /dev/null @@ -1,283 +0,0 @@ ---- -title: hooks 알아보기 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import pubspec from "./getting_started/pubspec"; -import dartHelloWorld from "./getting_started/dart_hello_world"; -import helloWorld from "./getting_started/hello_world"; -import dartPubspec from "./getting_started/dart_pubspec"; -import { - trimSnippet, - AutoSnippet, - When, -} from "../../../../src/components/CodeSnippet"; - -This page explains what are hooks and how they are related to Riverpod. - -"Hooks" are utilities common from a separate package, independent from Riverpod: -[flutter_hooks]. -Although [flutter_hooks] is a completely separate package and does not have anything -to do with Riverpod (at least directly), it is common to pair Riverpod -and [flutter_hooks] together. After-all, Riverpod and [flutter_hooks] are -maintained by the same team. - -Hooks are completely optional. You do not have to use hooks, especially if you -are starting Flutter. They are powerful tools, but not very "Flutter-like". -As such, it may make sense to start first with plain Flutter/Riverpod, and come back -to hooks once you have a bit more experience. - -## What are hooks? - -Hooks are functions used inside widgets. They are designed as an alternative -to [StatefulWidget]s, to make logic more reusable and composable. - -Hooks are a concept coming from [React](https://reactjs.org/), and [flutter_hooks] -is merely a port of the React implementation to Flutter. -As such, yes, hooks may feel a bit out of place in Flutter. Ideally, -in the future we would have a solution to the problem that hooks solves, -designed specifically for Flutter. - -If Riverpod's providers are for "global" application state, hooks are for -local widget state. Hooks are typically used for dealing with stateful UI objects, -such as [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html), -[AnimationController](https://api.flutter.dev/flutter/animation/AnimationController-class.html). -They can also serve as a replacement to the "builder" pattern, replacing widgets -such as [FutureBuilder](https://api.flutter.dev/flutter/widgets/FutureBuilder-class.html)/[TweenAnimatedBuilder](https://api.flutter.dev/flutter/widgets/TweenAnimationBuilder-class.html) -by an alterative that does not invole "nesting" – drastically improving readability. - -In general, hooks are helpful for: - -- forms -- animations -- reacting to user events -- ... - -As an example, we could use hooks to manually implement a fade-in animation, -where a widget starts invisible and slowly appears. - -If we were to use [StatefulWidget], the code would look like this: - -```dart -class FadeIn extends StatefulWidget { - const FadeIn({Key? key, required this.child}) : super(key: key); - - final Widget child; - - @override - State createState() => _FadeInState(); -} - -class _FadeInState extends State with SingleTickerProviderStateMixin { - late final AnimationController animationController = AnimationController( - vsync: this, - duration: const Duration(seconds: 2), - ); - - @override - void initState() { - super.initState(); - animationController.forward(); - } - - @override - void dispose() { - animationController.dispose(); - super.dispose(); - } - - @override - Widget build(BuildContext context) { - return AnimatedBuilder( - animation: animationController, - builder: (context, child) { - return Opacity( - opacity: animationController.value, - child: widget.child, - ); - }, - ); - } -} -``` - -Using hooks, the equivalent would be: - -```dart -class FadeIn extends HookWidget { - const FadeIn({Key? key, required this.child}) : super(key: key); - - final Widget child; - - @override - Widget build(BuildContext context) { - // Create an AnimationController. The controller will automatically be - // disposed when the widget is unmounted. - final animationController = useAnimationController( - duration: const Duration(seconds: 2), - ); - - // useEffect is the equivalent of initState + didUpdateWidget + dispose. - // The callback passed to useEffect is executed the first time the hook is - // invoked, and then whenever the list passed as second parameter changes. - // Since we pass an empty const list here, that's strictly equivalent to `initState`. - useEffect(() { - // start the animation when the widget is first rendered. - animationController.forward(); - // We could optionally return some "dispose" logic here - return null; - }, const []); - - // Tell Flutter to rebuild this widget when the animation updates. - // This is equivalent to AnimatedBuilder - useAnimation(animationController); - - return Opacity( - opacity: animationController.value, - child: child, - ); - } -} -``` - -There are a few interesting things to note in this code: - -- There is no memory leak. This code does not recreate a new `AnimationController` whenever the - widget rebuild, and the controller is correctly released when the widget is unmounted. - -- It is possible to use hooks as many time as we want within the same widget. - As such, we can create multiple `AnimationController` if we want: - - ```dart - @override - Widget build(BuildContext context) { - final animationController = useAnimationController( - duration: const Duration(seconds: 2), - ); - final anotherController = useAnimationController( - duration: const Duration(seconds: 2), - ); - - ... - } - ``` - - This creates two controllers, without any sort of negative consequence. - -- If we wanted, we could refactor this logic into a separate reusable function: - - ```dart - double useFadeIn() { - final animationController = useAnimationController( - duration: const Duration(seconds: 2), - ); - useEffect(() { - animationController.forward(); - return null; - }, const []); - useAnimation(animationController); - return animationController.value; - } - ``` - - We could then use this function inside our widgets, as long as that widget is a [HookWidget]: - - ```dart - class FadeIn extends HookWidget { - const FadeIn({Key? key, required this.child}) : super(key: key); - - final Widget child; - - @override - Widget build(BuildContext context) { - final fade = useFadeIn(); - - return Opacity(opacity: fade, child: child); - } - } - ``` - - Note how our `useFadeIn` function is completely independent from our - `FadeIn` widget. - If we wanted, we could use that `useFadeIn` function in a completely different - widget, and it would still work! - -## How to use hooks - -Hooks comes with unique constraints: - -- They can only be used within the `build` method of a widget that extends [HookWidget]: - - **Good**: - - ```dart - class Example extends HookWidget { - @override - Widget build(BuildContext context) { - final controller = useAnimationController(); - ... - } - } - ``` - - **Bad**: - - ```dart - // Not a HookWidget - class Example extends StatelessWidget { - @override - Widget build(BuildContext context) { - final controller = useAnimationController(); - ... - } - } - ``` - - **Bad**: - - ```dart - class Example extends HookWidget { - @override - Widget build(BuildContext context) { - return ElevatedButton( - onPressed: () { - // Not _actually_ inside the "build" method, but instead inside - // a user interaction lifecycle (here "on pressed"). - final controller = useAnimationController(); - }, - child: Text('click me'), - ); - } - } - ``` - -- They cannot be used conditionally or in a loop. - - **Bad**: - - ```dart - class Example extends HookWidget { - const Example({required this.condition, super.key}); - final bool condition; - @override - Widget build(BuildContext context) { - if (condition) { - // Hooks should not be used inside "if"s/"for"s, ... - final controller = useAnimationController(); - } - ... - } - } - ``` - - -For more information about hooks, see [flutter_hooks]. - -[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html -[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html -[riverpod]: https://github.com/rrousselgit/riverpod -[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod -[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod -[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx new file mode 100644 index 000000000..600fcc1ea --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx @@ -0,0 +1,59 @@ +--- +title: 성능 최적화하기 +--- + +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; +import select from "./select/select"; + +import selectAsync from "./select/select_async"; + +지금까지 살펴본 내용을 통해 이미 모든 기능을 갖춘 애플리케이션을 구축할 수 있습니다. +하지만 성능과 관련하여 궁금한 점이 있을 수 있습니다. + +이 페이지에서는 코드를 최적화할 수 있는 몇 가지 팁과 요령을 다룰 것입니다. + +:::caution +최적화를 수행하기 전에 애플리케이션을 벤치마킹(benchmark)해야 합니다. +최적화로 인한 복잡성 증가는 소소한 이득에 비해 가치가 없을 수 있습니다. +::: + +## "select"을 사용하여 위젯/provider 다시 빌드하는 것을 필터링합니다. + +기본적으로 `ref.watch`를 사용하면 객체의 _어떠한(any)_ 프로퍼티라도 변경될때마다, consumers/providers가 다시 빌드하는 것을 보셨을 것입니다. +예를 들어, `User`를 watch하고 "name"만 사용해도 'age'가 변경되면 Consumer는 여전히 다시 빌드됩니다. + +그러나 일부 속성만 사용하는 consumer가 있는 경우, 다른 속성이 변경될 때 위젯을 다시 빌드하지 않고 싶을 수 있습니다. + +이는 provider의 `select` 기능을 사용하여 수행할 수 있습니다. +이렇게 하면 `ref.watch`는 더 이상 전체 객체를 반환하지 않고 선택된 프로퍼티만 반환합니다. +그리고 consumer/provider는 이제 선택된 프로퍼티가 변경되는 경우에만 다시 빌드됩니다. + + + +:::info +`select`는 원하는 횟수만큼 호출할 수 있습니다. +원하는 속성당 한 번씩 자유롭게 호출할 수 있습니다. +::: + +:::caution +선택된 프로퍼티는 변경되지 않을 것으로 예상됩니다. +`List`를 반환한 다음 해당 리스트를 변경해도 리빌드가 트리거되지 않습니다. +::: + +:::caution +`select`을 사용하면 무효(invididual) 읽기 작업 속도가 약간 느려지고, 코드의 복잡성이 약간 증가합니다. +이러한 "다른 속성"이 거의 변경되지 않는 경우에는 사용할 가치가 없을 수 있습니다. +::: + +### Selecting asynchronous properties + +다른 provider를 수신하는 provider를 최적화하려는 경우 다른 provider가 비동기식일 가능성이 있습니다. + +일반적으로는 `ref.watch(anotherProvider.future)`를 사용해 값을 가져옵니다. +문제는 `select`이 `AsyncValue`에 적용된다는 것인데, 이는 기다릴 수 있는(await) 상황이 아닙니다. + +이를 위해 `selectAsync`를 대신 사용할 수 있습니다. +이 함수는 비동기 코드에 고유하며, 공급자가 방출한 데이터에 대해 `select` 연산을 수행할 수 있게 해줍니다. +사용법은 `select`와 비슷하지만 대신 `Future`를 반환합니다: + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart new file mode 100644 index 000000000..f875f67e2 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart @@ -0,0 +1,30 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +class User { + late String firstName, lastName; +} + +@riverpod +User example(ExampleRef ref) => User() + ..firstName = 'John' + ..lastName = 'Doe'; + +class ConsumerExample extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 이렇게 작성하는 대신: + // String name = ref.watch(provider).firstName!; + // 이렇게 작성할수 있습니다: + String name = ref.watch(exampleProvider.select((it) => it.firstName)); + // 이렇게 하면 위젯이 "firstName"의 변경 사항만 수신합니다. + + return Text('Hello $name'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart new file mode 100644 index 000000000..9e44ffe6d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'72881c6147d44adb957180debefe7696d93107f0'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart new file mode 100644 index 000000000..46524af88 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart @@ -0,0 +1,29 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class User { + late String firstName, lastName; +} + +final provider = Provider( + (ref) => User() + ..firstName = 'John' + ..lastName = 'Doe', +); + +class ConsumerExample extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // Instead of writing: + // String name = ref.watch(provider).firstName!; + // We can write: + String name = ref.watch(provider.select((it) => it.firstName)); + // This will cause the widget to only listen to changes on "firstName". + + return Text('Hello $name'); + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart new file mode 100644 index 000000000..dba161bdf --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart @@ -0,0 +1,26 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors, body_might_complete_normally_nullable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class User { + late String firstName, lastName; +} + +final userProvider = FutureProvider( + (ref) => User() + ..firstName = 'John' + ..lastName = 'Doe', +); +/* SNIPPET START */ +@riverpod +Object? example(ExampleRef ref) async { + // user를 사용할 수 있을 때까지 기다렸다가 "firstName" 속성만 수신합니다. + final firstName = await ref.watch( + userProvider.selectAsync((it) => it.firstName), + ); + + // TODO use "firstName" to fetch something else +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart new file mode 100644 index 000000000..1f422ec8a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'1fccbdbec0e3585bc9d3a5709ac88a8919dd78fa'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart new file mode 100644 index 000000000..6f3c7ddf9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class User { + late String firstName, lastName; +} + +final userProvider = FutureProvider( + (ref) => User() + ..firstName = 'John' + ..lastName = 'Doe', +); +/* SNIPPET START */ +final provider = FutureProvider((ref) async { + // Wait for a user to be available, and listen to only the "firstName" property + final firstName = await ref.watch( + userProvider.selectAsync((it) => it.firstName), + ); + + // TODO use "firstName" to fetch something else +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx new file mode 100644 index 000000000..27fcea046 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx @@ -0,0 +1,118 @@ +--- +title: 네트워크요청 디바운싱/취소 (Debouncing/Cancelling) +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import homeScreen from "!raw-loader!./cancel/home_screen.dart"; +import extension from "!raw-loader!./cancel/extension.dart"; +import detailScreen from "./cancel/detail_screen"; +import detailScreenCancel from "./cancel/detail_screen_cancel"; +import detailScreenDebounce from "./cancel/detail_screen_debounce"; +import providerWithExtension from "./cancel/provider_with_extension"; + +애플리케이션이 복잡해짐에 따라 동시에 여러 개의 네트워크 요청이 발생하는 것이 일반적입니다. +예를 들어, 사용자가 검색창에 입력할 때마다 새로운 요청이 트리거될 수 있습니다. +사용자가 빠르게 입력하는 경우 애플리케이션에 동시에 많은 요청이 전송될 수 있습니다. + +또는 사용자가 요청을 트리거한 후 요청이 완료되기 전에 다른 페이지로 이동할 수도 있습니다. +이 경우 애플리케이션에 더 이상 필요하지 않은 요청이 전송 중일 수 있습니다. + +이러한 상황에서 성능을 최적화하기 위해 사용할 수 있는 몇 가지 기술이 있습니다: + +- 요청 '디바운스'. + 즉, 사용자가 일정 시간 동안 입력을 멈출 때까지 기다렸다가 요청을 전송하는 방식입니다. + 이렇게 하면 사용자가 빠르게 입력하더라도 주어진 입력에 대해 한 번의 요청만 전송할 수 있습니다. +- 요청 '취소'. + 즉, 요청이 완료되기 전에 사용자가 페이지에서 다른 곳으로 이동하는 경우 요청을 취소합니다. + 이렇게 하면 사용자가 볼 수 없는 응답을 처리하느라 시간을 낭비하지 않아도 됩니다. + +Riverpod에서는 이 두 가지 기술을 비슷한 방식으로 구현할 수 있습니다. +핵심은 `ref.onDispose`를 "자동 폐기(automatic disposal)" 또는 `ref.watch`와 함께 사용하여 원하는 동작을 달성하는 것입니다. + +이를 보여주기 위해 두 페이지로 구성된 간단한 애플리케이션을 만들어 보겠습니다: + +- 새 페이지를 여는 버튼이 있는 홈 화면 +- [Bored API](https://www.boredapi.com/)에서 임의의 액티비티를 표시하는 상세 페이지로, 액티비티를 새로 고칠 수 있는 기능이 있습니다. + 당겨서 새로고침(pull to refresh)를 구현하는 방법에 대한 자세한 내용은 를 참조하세요. + +그런 다음 다음 동작을 구현합니다: + +- 사용자가 세부 정보 페이지를 열었다가 즉시 다시 이동하면 액티비티에 대한 요청을 취소(cancel)합니다. +- 사용자가 연속으로 여러 번 액티비티을 새로 고치면 요청을 디바운스(debounce)하여 사용자가 새로 고침을 중지한 후 한 번만 요청을 보내도록 합니다. + +## 어플리케이션 + +Gif showcasing the application, opening the detail page and refreshing the activity. + +먼저, 디바운스나 취소 없이 애플리케이션을 만들어 봅시다. +여기서는 멋진 것을 사용하지 않고, 세부 정보 페이지를 여는 `Navigator.push`가 있는 평범한 `FloatingActionButton`을 사용하겠습니다. + +먼저 홈 화면을 정의하는 것부터 시작하겠습니다. +평소와 마찬가지로 애플리케이션의 루트에 `ProviderScope`를 지정하는 것을 잊지 마세요. + + + +그런 다음 세부 정보 페이지를 정의해 보겠습니다. +활동을 가져오고 당겨서 새로고침(pull to refresh)를 구현하려면 사례 연구를 참조하세요. + + + +## 요청 취소하기 + +이제 애플리케이션이 작동하므로 취소(cancellation) 로직을 구현해 보겠습니다. + +이를 위해 사용자가 페이지에서 다른 곳으로 이동할 때 `ref.onDispose`를 사용하여 요청을 취소할 것입니다. +이 기능이 작동하려면 provider의 자동 폐기(automatic disposal)가 활성화되어 있어야 합니다. + +요청을 취소하는 데 필요한 정확한 코드는 HTTP 클라이언트에 따라 다릅니다. +이 예에서는 `package:http`를 사용하지만 다른 클라이언트에도 동일한 원칙이 적용됩니다. + +여기서 중요한 점은 사용자가 다른 곳으로 이동할 때 `ref.onDispose`가 호출된다는 것입니다. +이는 provider가 더 이상 사용되지 않으므로 자동 폐기를 통해 폐기되기 때문입니다. +따라서 이 콜백을 사용하여 요청을 취소할 수 있습니다. +`package:http`를 사용하는 경우 HTTP 클라이언트를 닫으면 이 작업을 수행할 수 있습니다. + + + +## 요청 디바운싱(Debouncing) + +이제 취소를 구현했으니 이제 디바운싱을 구현해 보겠습니다. +현재로서는 사용자가 활동을 연속으로 여러 번 새로 고치면 새로 고칠 때마다 요청을 보내게 됩니다. + +기술적으로는 취소를 구현했으므로 문제가 되지 않습니다. +사용자가 활동을 연속으로 여러 번 새로 고치면 새 요청이 이루어질 때 이전 요청이 취소됩니다. + +하지만 이는 이상적이지 않습니다. 여전히 여러 요청을 전송하고 대역폭과 서버 리소스를 낭비하게 됩니다. +대신 사용자가 일정 시간 동안 활동 새로 고침을 중지할 때까지 요청을 지연시키는 방법을 사용할 수 있습니다. + +여기서 로직은 취소 로직과 매우 유사합니다. 다시 `ref.onDispose`를 사용합니다. +하지만 여기서는 HTTP 클라이언트를 닫는 대신 `onDispose`에 의존하여 요청이 시작되기 전에 중단한다는 점이 다릅니다. +그런 다음 요청을 보내기 전에 임의로 500ms를 기다립니다. +그런 다음 사용자가 500ms가 경과하기 전에 활동을 다시 새로고침하면 `onDispose`가 호출되어 요청이 중단됩니다. + +:::info +요청을 중단하려면 자발적으로 던지는(throw) 것이 일반적입니다. +provider가 폐기된(disposed) 후에는 공급자 내부에 던지는(throw) 것이 안전합니다. +예외는 당연히 Riverpod에 의해 잡히고 무시됩니다. +::: + + + +## 더 나아가기: 두 가지를 한 번에 수행하기 + +이제 요청을 디바운스하고 취소하는 방법을 알았습니다. +하지만 현재 다른 요청을 수행하려면 동일한 로직을 여러 곳에 복사하여 붙여넣어야 합니다. 이것은 이상적이지 않습니다. + +하지만 여기서 더 나아가 재사용 가능한 유틸리티를 구현하여 두 가지 작업을 한 번에 수행할 수 있습니다. + +여기서는 단일 메서드에서 취소와 디바운싱을 모두 처리하는 확장 메서드(extension method)를 `Ref`에 구현하는 것이 아이디어입니다. + + + +그런 다음 다음과 같이 공급자에서 이 확장 메서드를 사용할 수 있습니다: + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart new file mode 100644 index 000000000..e3bf193a2 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart @@ -0,0 +1,61 @@ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +/* SNIPPET START */ +@freezed +class Activity with _$Activity { + factory Activity({ + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + factory Activity.fromJson(Map json) => + _$ActivityFromJson(json); +} + +@riverpod +Future activity(ActivityRef ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} + +class DetailPageView extends ConsumerWidget { + const DetailPageView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar( + title: const Text('Detail page'), + ), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const Center(child: CircularProgressIndicator()), + }, + ], + ), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart new file mode 100644 index 000000000..1020def96 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart @@ -0,0 +1,209 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart new file mode 100644 index 000000000..4d688e552 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart @@ -0,0 +1,46 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +/// See also [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart new file mode 100644 index 000000000..b3ad1faaf --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart @@ -0,0 +1,65 @@ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +/* SNIPPET START */ +class Activity { + Activity({ + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + factory Activity.fromJson(Map json) { + return Activity( + activity: json['activity']! as String, + type: json['type']! as String, + participants: json['participants']! as int, + price: json['price']! as double, + ); + } + + final String activity; + final String type; + final int participants; + final double price; +} + +final activityProvider = FutureProvider.autoDispose((ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); + +class DetailPageView extends ConsumerWidget { + const DetailPageView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar( + title: const Text('Detail page'), + ), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const Center(child: CircularProgressIndicator()), + }, + ], + ), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart new file mode 100644 index 000000000..3d5dff27d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart @@ -0,0 +1,28 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../detail_screen/codegen.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + // package:http를 사용하여 HTTP 클라이언트를 생성합니다. + final client = http.Client(); + // dispose 시 클라이언트를 닫습니다. + // 그러면 클라이언트에 있을 수 있는 모든 보류 중인 요청이 취소됩니다. + ref.onDispose(client.close); + + // 이제 "get" 함수 대신 클라이언트를 사용하여 요청을 수행합니다. + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + // 나머지 코드는 이전과 동일합니다. + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart new file mode 100644 index 000000000..67a5099bf --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'304864a6b8051925061a2bba397574ec45b94d08'; + +/// See also [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart new file mode 100644 index 000000000..2bf5a4d5e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart @@ -0,0 +1,25 @@ +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import '../detail_screen/codegen.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + // We create an HTTP client using package:http + final client = http.Client(); + // On dispose, we close the client. + // This will cancel any pending request that the client might have. + ref.onDispose(client.close); + + // We now use the client to make the request instead of the "get" function. + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + // The rest of the code is the same as before + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart new file mode 100644 index 000000000..1dacaaeca --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart @@ -0,0 +1,39 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../detail_screen/codegen.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + // provider가 현재 폐기(disposed)되었는지 여부를 캡처합니다. + var didDispose = false; + ref.onDispose(() => didDispose = true); + + // 사용자가 새로 고침(refreshing)을 중단할 때까지 기다리기 위해 + // 요청을 500밀리초 지연합니다. + await Future.delayed(const Duration(milliseconds: 500)); + + // 지연 중에 provider가 폐기(disposed)되었다면 사용자가 다시 새로고침했다는 의미입니다. + // 예외를 던져 요청을 취소합니다. + // Riverpod에 의해 잡히므로 여기서 예외를 사용하는 것이 안전합니다. + if (didDispose) { + throw Exception('Cancelled'); + } + + // 다음 코드는 이전 스니펫에서 변경되지 않았습니다. + final client = http.Client(); + ref.onDispose(client.close); + + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart new file mode 100644 index 000000000..2f62270bc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'ef908e3b46693862f082769663b14d5369d6e155'; + +/// See also [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart new file mode 100644 index 000000000..624842ecf --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart @@ -0,0 +1,35 @@ +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import '../detail_screen/codegen.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + // We capture whether the provider is currently disposed or not. + var didDispose = false; + ref.onDispose(() => didDispose = true); + + // We delay the request by 500ms, to wait for the user to stop refreshing. + await Future.delayed(const Duration(milliseconds: 500)); + + // If the provider was disposed during the delay, it means that the user + // refreshed again. We throw an exception to cancel the request. + // It is safe to use an exception here, as it will be caught by Riverpod. + if (didDispose) { + throw Exception('Cancelled'); + } + + // The following code is unchanged from the previous snippet + final client = http.Client(); + ref.onDispose(client.close); + + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart new file mode 100644 index 000000000..02f04dcc3 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart @@ -0,0 +1,31 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +/* SNIPPET START */ +extension DebounceAndCancelExtension on Ref { + /// [duration] (기본값은 500ms) 동안 기다린 다음 요청에 사용할 수 있는 [http.Client]를 반환합니다. + /// + /// 해당 클라이언트는 provider가 폐기되면 자동으로 닫힙니다. + Future getDebouncedHttpClient([Duration? duration]) async { + // 먼저 디바운싱을 처리합니다. + var didDispose = false; + onDispose(() => didDispose = true); + + // 사용자가 새로 고침을 중단할 때까지 기다리기 위해 요청을 500밀리초 지연합니다. + await Future.delayed(duration ?? const Duration(milliseconds: 500)); + + // 지연 중에 provider가 폐기(disposed)되었다면 사용자가 다시 새로고침했다는 의미입니다. + // 예외를 던져 요청을 취소합니다. + // 리버포드에 의해 포착되므로 여기서 예외를 사용하는 것이 안전합니다. + if (didDispose) { + throw Exception('Cancelled'); + } + + // 이제 클라이언트를 생성하고 provider가 폐기되면 클라이언트를 닫습니다. + final client = http.Client(); + onDispose(client.close); + + // 마지막으로 클라이언트를 반환하여 provider가 요청을 할 수 있도록 합니다. + return client; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart new file mode 100644 index 000000000..28f0c50cf --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart @@ -0,0 +1,39 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'detail_screen/codegen.dart'; + +/* SNIPPET START */ +void main() => runApp(const ProviderScope(child: MyApp())); + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return MaterialApp( + routes: { + '/detail-page': (_) => const DetailPageView(), + }, + home: const ActivityView(), + ); + } +} + +class ActivityView extends ConsumerWidget { + const ActivityView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + appBar: AppBar(title: const Text('Home screen')), + body: const Center( + child: Text('Click the button to open the detail page'), + ), + floatingActionButton: FloatingActionButton( + onPressed: () => Navigator.of(context).pushNamed('/detail-page'), + child: const Icon(Icons.add), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart new file mode 100644 index 000000000..2868bf735 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart @@ -0,0 +1,25 @@ +import 'dart:convert'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../detail_screen/codegen.dart'; +import '../extension.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + // 앞서 만든 확장자를 사용하여 HTTP 클라이언트를 가져옵니다. + final client = await ref.getDebouncedHttpClient(); + + // 이제 "get" 함수 대신 클라이언트를 사용하여 요청을 수행합니다. + // 사용자가 페이지를 떠나면 요청은 자연스럽게 디바운스(debounced)되고 취소(cancelled)됩니다. + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart new file mode 100644 index 000000000..7c8195c7b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'f045dd6e89fde6bbe12a89f243290d289a3e692d'; + +/// See also [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart new file mode 100644 index 000000000..36ef098f7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart @@ -0,0 +1,23 @@ +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../detail_screen/codegen.dart'; +import '../extension.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + // We obtain an HTTP client using the extension we created earlier. + final client = await ref.getDebouncedHttpClient(); + + // We now use the client to make the request instead of the "get" function. + // Our request will naturally be debounced and be cancelled if the user + // leaves the page. + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx new file mode 100644 index 000000000..8add0ebe9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx @@ -0,0 +1,119 @@ +--- +title: 당겨서 새로고침(Pull to refresh) +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import activity from "./pull_to_refresh/activity"; +import fetchActivity from "./pull_to_refresh/fetch_activity"; +import displayActivity from "!!raw-loader!./pull_to_refresh/display_activity.dart"; +import displayActivity2 from "!!raw-loader!./pull_to_refresh/display_activity2.dart"; +import displayActivity3 from "!!raw-loader!./pull_to_refresh/display_activity3.dart"; +import displayActivity4 from "!!raw-loader!./pull_to_refresh/display_activity4.dart"; +import fullApp from "./pull_to_refresh/full_app"; + +Riverpod은 선언적 성격 덕분에 당겨서 새로고침(pull-to-refresh)를 기본적으로 지원합니다. + +일반적으로 당겨서 새로고침(pull-to-refresh)는 해결해야 할 문제가 많기 때문에 복잡할 수 있습니다: + +- 페이지에 처음 들어갔을 때 스피너(spinner)를 표시하고 싶습니다. + 하지만 새로 고침 중에는 대신 갱신표시기(refresh indicator)를 표시하고 싶습니다. + 갱신표시기(refresh indicator)_와_ 스피너(spinner)를 모두 표시해서는 안 됩니다. +- 새로 고침이 보류 중인 동안 이전 데이터/오류를 표시하고 싶습니다. +- 새로 고침이 진행되는 동안 갱신표시기(refresh indicator)를 표시해야 합니다. + +Riverpod를 사용하여 이 문제를 해결하는 방법을 살펴봅시다. +이를 위해 사용자에게 임의의 액티비티를 추천하는 간단한 예제를 만들어 보겠습니다. +그리고 당겨서 새로고침(pull-to-refresh)를 수행하면 새로운 제안이 트리거됩니다: + +A gif of the previously described application working + +## 기본(bare-bones) 애플리케이션 만들기 + +당겨서 새로고침(pull-to-refresh) 기능을 구현하기 전에 먼저 새로고침할 무언가가 필요합니다. +[Bored API](https://www.boredapi.com/)를 사용하여 사용자에게 임의의 액티비티를 제안하는 간단한 애플리케이션을 만들 수 있습니다. + +먼저 `Activity` 클래스를 정의하겠습니다: + + + +이 클래스는 제안된 액티비티를 타입에 안전한(type-safe) 방식으로 표현하고 JSON 인코딩/디코딩을 처리합니다. +Freezed/json_serializable을 반드시 사용해야 하는 것은 아니지만 권장합니다. + +이제 단일 액티비티를 가져오기 위해 HTTP GET 요청을 하는 provider를 정의하겠습니다: + + + +이제 이 provider를 사용하여 임의의 액티비티를 표시할 수 있습니다. +지금은 로딩/오류 상태를 처리하지 않고 사용 가능한 경우 액티비티만 표시합니다: + + + +## `RefreshIndicator` 추가 + +이제 간단한 애플리케이션을 만들었으니 여기에 `RefreshIndicator`를 추가하면 됩니다. +이 위젯은 사용자가 화면을 아래로 내릴 때 새로고침 표시기(refresh indicator)를 표시하는 공식 머티리얼(Material) 위젯입니다. + +`RefreshIndicator`를 사용하려면 스크롤 가능한 표면(surface)이 필요합니다. +하지만 지금까지는 하나도 없습니다. +`ListView`/`GridView`/`SingleChildScrollView`/등을 사용하면 이 문제를 해결할 수 있습니다: + + + +이제 사용자가 화면을 아래로 내릴 수 있습니다. 하지만 데이터는 아직 새로 고쳐지지 않았습니다. + +## 새로 고침 로직 추가 + +사용자가 화면을 아래로 내리면 `RefreshIndicator`가 `onRefresh` 콜백을 호출합니다. +이 콜백을 사용해 데이터를 새로 고칠 수 있습니다. +여기서 `ref.refresh`를 사용하여 선택한 공급자를 새로 고칠 수 있습니다. + +**참고**: `onRefresh`는 `Future`를 반환할 것으로 예상됩니다. +그리고 새로 고침이 완료될 때 그 future가 완료되는 것이 중요합니다. + +이러한 future를 얻으려면 공급자의 '.future' 속성을 읽으면 됩니다. +그러면 공급자가 해결(resolved)될 때 완료되는 future가 반환됩니다. + +따라서 `RefreshIndicator`를 다음과 같이 업데이트할 수 있습니다: + + + +## 초기 로드 및 오류 처리 중에만 스피너를 표시합니다. + +현재 저희 UI는 오류/로딩 상태를 처리하지 않습니다. +대신 로딩/새로 고침이 완료되면 데이터가 마술처럼 나타납니다. + +이러한 상태를 우아하게 처리하여 이를 변경해 보겠습니다. 두 가지 경우가 있습니다: + +- 초기 로드 중에는 전체 화면 스피너를 표시하고 싶습니다. +- 새로 고침 중에는 새로 고침 표시기와 이전 데이터/오류를 표시하고 싶습니다. + +다행히도 Riverpod에서 비동기 프로바이더를 수신할 때, Riverpod는 필요한 모든 것을 제공하는 `AsyncValue`를 제공합니다. + +이 `AsyncValue`는 다음과 같이 Dart 3.0의 패턴 일치(pattern matching)와 사용할 수 있습니다: + + + +:::caution +여기서는 현재와 같이 `valueOrNull`을 사용하여 에러/로딩 상태인 경우 `value`를 사용합니다. + +Riverpod 3.0에서는 `value`가 `valueOrNull`처럼 동작하도록 변경될 예정입니다. +하지만 지금은 `valueOrNull`을 고수하겠습니다. +::: + +:::tip +패턴 매칭에서 `:final valueOrNull?` 구문이 사용된 것을 주목하세요. +이 구문은 `activityProvider`가 널이 아닌 `Activity`를 반환할 때만 사용할 수 있습니다. + +데이터가 `null`일 수 있는 경우, 대신 `AsyncValue(hasData: true, :final valueOrNull)`를 사용할 수 있습니다. +이렇게 하면 몇 개의 문자가 추가되는 대신 데이터가 `null`인 경우를 올바르게 처리할 수 있습니다. +::: + +## 마무리: 전체 애플리케이션 + +지금까지 다룬 모든 내용을 정리한 소스는 다음과 같습니다: + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart new file mode 100644 index 000000000..ac3e1b17d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart @@ -0,0 +1,19 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; + +part 'codegen.g.dart'; +part 'codegen.freezed.dart'; + +/* SNIPPET START */ +@freezed +class Activity with _$Activity { + factory Activity({ + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + factory Activity.fromJson(Map json) => + _$ActivityFromJson(json); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart new file mode 100644 index 000000000..1020def96 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart @@ -0,0 +1,209 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart new file mode 100644 index 000000000..79ae3cd00 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart @@ -0,0 +1,25 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart new file mode 100644 index 000000000..42365b7bb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart @@ -0,0 +1,24 @@ +/* SNIPPET START */ +class Activity { + Activity({ + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + factory Activity.fromJson(Map json) { + return Activity( + activity: json['activity']! as String, + type: json['type']! as String, + participants: json['participants']! as int, + price: json['price']! as double, + ); + } + + final String activity; + final String type; + final int participants; + final double price; +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart new file mode 100644 index 000000000..8313781ca --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart @@ -0,0 +1,22 @@ +// ignore_for_file: use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: Center( + // 액티비티가 있으면 표시하고, 그렇지 않으면 대기합니다. + child: Text(activity.valueOrNull?.activity ?? ''), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart new file mode 100644 index 000000000..7394ea664 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + /* highlight-start */ + body: RefreshIndicator( + onRefresh: () async => print('refresh'), + child: ListView( + children: [ + /* highlight-end */ + Text(activity.valueOrNull?.activity ?? ''), + ], + ), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart new file mode 100644 index 000000000..17e661a0c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart @@ -0,0 +1,31 @@ +// ignore_for_file: avoid_print, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + // "activityProvider.future"를 새로 고침으로, 해당 결과를 반환하면, + // 새 액티비티를 가져올 때까지 + // 새로 고침 표시기(refresh indicator)가 계속 표시됩니다. + /* highlight-start */ + onRefresh: () => ref.refresh(activityProvider.future), + /* highlight-end */ + child: ListView( + children: [ + Text(activity.valueOrNull?.activity ?? ''), + ], + ), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart new file mode 100644 index 000000000..54564c4c0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart @@ -0,0 +1,35 @@ +// ignore_for_file: avoid_print, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity/codegen.dart'; +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + // 일부 데이터를 사용할 수 있는 경우 해당 데이터를 표시합니다. + // 새로 고침 중에도 데이터를 계속 사용할 수 있습니다. + AsyncValue(:final valueOrNull?) => Text(valueOrNull.activity), + // 오류를 사용할 수 있으므로 렌더링합니다. + AsyncValue(:final error?) => Text('Error: $error'), + // 데이터/오류가 없으므로 로딩 상태입니다. + _ => const CircularProgressIndicator(), + }, + ], + ), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart new file mode 100644 index 000000000..0cec67cba --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart @@ -0,0 +1,20 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../activity/codegen.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart new file mode 100644 index 000000000..fa23157e9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +/// See also [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart new file mode 100644 index 000000000..1cec3b128 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart @@ -0,0 +1,17 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../activity/raw.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart new file mode 100644 index 000000000..b7d53c744 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart @@ -0,0 +1,69 @@ +// ignore_for_file: use_key_in_widget_constructors, unreachable_from_main + +/* SNIPPET START */ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; +part 'codegen.freezed.dart'; + +void main() => runApp(ProviderScope(child: MyApp())); + +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return MaterialApp(home: ActivityView()); + } +} + +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => + Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const CircularProgressIndicator(), + }, + ], + ), + ), + ); + } +} + +@riverpod +Future activity(ActivityRef ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} + +@freezed +class Activity with _$Activity { + factory Activity({ + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + factory Activity.fromJson(Map json) => + _$ActivityFromJson(json); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart new file mode 100644 index 000000000..1020def96 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart @@ -0,0 +1,209 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart new file mode 100644 index 000000000..4d688e552 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -0,0 +1,46 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +/// See also [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart new file mode 100644 index 000000000..c4186fb31 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart @@ -0,0 +1,73 @@ +// ignore_for_file: use_key_in_widget_constructors, unreachable_from_main + +/* SNIPPET START */ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +void main() => runApp(ProviderScope(child: MyApp())); + +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return MaterialApp(home: ActivityView()); + } +} + +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => + Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const CircularProgressIndicator(), + }, + ], + ), + ), + ); + } +} + +final activityProvider = FutureProvider.autoDispose((ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); + +class Activity { + Activity({ + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + factory Activity.fromJson(Map json) { + return Activity( + activity: json['activity']! as String, + type: json['type']! as String, + participants: json['participants']! as int, + price: json['price']! as double, + ); + } + + final String activity; + final String type; + final int participants; + final double price; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx new file mode 100644 index 000000000..6d3046125 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx @@ -0,0 +1,355 @@ +--- +title: 코드 생성(Code generation)에 대한 정보 +version: 1 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import fetchUser from "!!raw-loader!./about_codegen/main.dart"; +import rawFetchUser from "!!raw-loader!./about_codegen/raw.dart"; +import { Link } from "../../../../../src/components/Link"; +import { trimSnippet, CodeSnippet } from "../../../../../src/components/CodeSnippet"; +import syncFn from "!!raw-loader!./about_codegen/provider_type/sync_fn.dart"; +import syncClass from "!!raw-loader!./about_codegen/provider_type/sync_class.dart"; +import asyncFnFuture from "!!raw-loader!./about_codegen/provider_type/async_fn_future.dart"; +import asyncClassFuture from "!!raw-loader!./about_codegen/provider_type/async_class_future.dart"; +import asyncFnStream from "!!raw-loader!./about_codegen/provider_type/async_fn_stream.dart"; +import asyncClassStream from "!!raw-loader!./about_codegen/provider_type/async_class_stream.dart"; +import familyFn from "!!raw-loader!./about_codegen/provider_type/family_fn.dart"; +import familyClass from "!!raw-loader!./about_codegen/provider_type/family_class.dart"; +import provider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/provider.dart"; +import notifierProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/notifier_provider.dart"; +import futureProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/future_provider.dart"; +import asyncNotifierProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/async_notifier_provider.dart"; +import streamProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/stream_provider.dart"; +import streamNotifierProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart"; +import autoDisposeCodeGen from "!!raw-loader!./about_codegen/provider_type/auto_dispose.dart"; +import autoDisposeNonCodeGen from "!!raw-loader!./about_codegen/provider_type/non_code_gen/auto_dispose.dart"; +import familyCodeGen from "!!raw-loader!./about_codegen/provider_type/family.dart"; +import familyNonCodeGen from "!!raw-loader!./about_codegen/provider_type/non_code_gen/family.dart"; +const TRANSPARENT_STYLE = { backgroundColor: "transparent" }; +const RED_STYLE = { color: "indianred", fontWeight: "700" }; +const BLUE_STYLE = { color: "rgb(103, 134, 196)", fontWeight: "700" }; +const FONT_16_STYLE = { + fontSize: "16px", + fontWeight: "700", +}; +const BLUE_20_STYLE = { + color: "rgb(103, 134, 196)", + fontSize: "20px", + fontWeight: "700", +}; +const PROVIDER_STYLE = { + textAlign: "center", + fontWeight: "600", + maxWidth: "210px", +}; +const BEFORE_STYLE = { + minWidth: "120px", + textAlign: "center", + fontWeight: "600", + color: "crimson", +}; +const AFTER_STYLE = { + minWidth: "120px", + textAlign: "center", + fontWeight: "600", + color: "rgb(40,180,40)", +}; + +코드 생성은 도구를 사용하여 코드를 생성하는 것을 말합니다. +Dart에서는 애플리케이션을 'Compile'하는 데 추가 단계가 필요하다는 단점이 있습니다. +이 문제는 Dart 팀이 이 문제를 해결하려는 잠재적인 해결방안을 연구하고 있기 때문에 곧 해결될 수도 있습니다. + +Riverpod 환경(Context)에서의 코드 생성은 "provider"를 선언하는 문법을 약간 변경하는 것을 의미합니다: + +{trimSnippet(rawFetchUser)} + +코드 생성을 사용하면 다음과 같이 작성할 수 있습니다: + +{trimSnippet(fetchUser)} + +Riverpod 사용 시 코드 생성은 완전히 선택 사항입니다. +코드 생성을 하지 않고도 Riverpod을 사용할 수 있습니다. 동시에 Riverpod은 코드 생성을 수용하며 사용을 권장합니다. + +Riverpod의 코드 생성을 사용하려면, 페이지를 참조하십시오. +문서의 사이드바에서 코드 생성(Code Generation)을 활성화해야 합니다. + +## 코드 생성을 사용해야 하나요? + +코드 생성은 Riverpod에서 선택 사항입니다. +이를 염두에 두고, 코드 생성을 사용해야 할지 말지 궁금할 수 있습니다. + +답변은 **대부분의 경우 예** 입니다. +코드 생성을 사용하는 것이 Riverpod을 사용하는 권장 방법입니다. +이는 보다 미래 지향적인 접근방식(future-proof approach)이며, Riverpod의 잠재력을 최대한 활용할 수 있게 해줍니다. +동시에 많은 애플리케이션에서 이미 [Freezed](https://pub.dev/packages/freezed)나 [json_serializable](https://pub.dev/packages/json_serializable)와 같은 패키지를 사용하여 코드 생성을 사용하고 있습니다. +이 경우, 프로젝트가 이미 코드 생성을 위해 설정되어 있으며, Riverpod을 사용하는 것은 간단합니다. + +현재 코드 생성은 `build_runner`를 많은 사람이 싫어하기 때문에 선택 사항입니다. +하지만, [Static Metaprogramming](https://github.com/dart-lang/language/issues/1482)이 Dart에서 사용 가능해지면, +`build_runner`는 더 이상 문제가 되지 않을 것입니다. +그 때부터는 Riverpod에 코드 생성 문법만 유일한 문법이 될 것입니다. + +`build_runner`를 사용하는 것이 거부감이 든다면, 코드 생성을 사용하지 않는 것을 고려할 수 있습니다. +하지만, 이 경우에는 일부 기능을 사용할 수 없으며, 미래에 코드 생성으로 마이그레이션해야 합니다. +이 때 Riverpod은 마이그레이션을 가능한 한 원활하게 진행할 수 있도록 마이그레이션 도구를 제공할 것입니다. + +## 코드 생성을 사용하면 어떤 이점이 있나요? + +아마 궁금하실 겁니다: "Riverpod에서 코드 생성은 선택 사항이면, 왜 사용해야 하지?" + +패키지는 언제나 그렇듯: 사용자의 삶을 더 쉽게 만들기 위한 것입니다. 이는 다음 내용이 포함되지많 여기에만 국한되지는 않습니다: + +- 더 나은 문법, 더 읽기 쉽고 유연하며, 학습 곡선이 낮습니다. + - provider의 타입을 직접 지정할 필요가 없습니다. 로직을 작성하고, Riverpod이 가장 적합한 provider를 선택합니다. + - 문법이 "더러운 전역 변수(dirty global variable)"를 정의하는 것처럼 보이지 않습니다. 대신, 사용자 정의 함수/클래스를 정의합니다. + - provider에 매개변수를 전달하는 것이 더 이상 제한되지 않습니다. + 를 사용하여 단일 위치 매개변수(single positional parameter)를 전달하는 것이 아니라, + 모든 매개변수를 전달할 수 있습니다. 이는 명명된 매개변수(named parameters), 선택적(optional) 매개변수, 기본값(default values)도 포함합니다. +- Riverpod에서 작성한 코드는 **상태를 가지는 핫 리로드(stateful hot-reload)**를 지원합니다. +- 더 나은 디버깅을 위해 추가 메타데이터를 생성하고 디버거가 수집합니다. +- 일부 Riverpod 기능은 코드 생성을 통해서만 사용할 수 있습니다. + +## 문법 + +### provider 정의하기: + +코드 생성을 사용하여 provider를 정의할 때 아래 사항을 알아 두면 도움이 됩니다: + +- provider는 어노테이션 function 또는 어노테이션 class로 정의할 수 있습니다. + 둘은 거의 동일하지만 class 기반 provider는 외부 객체가 provider의 상태를 수정할 수 있는 공용 메서드(Public Method)를 포함할 수 있다는 장점이 있습니다(부수적인 효과). + 함수형 provider는 빌드 메서드만으로 클래스 기반 provider를 작성하기 위한 달콤한 문법(Sugar syntax)이며, 따라서 UI에서 수정할 수 없습니다. +- 모든 Dart async primitives(Future, FutureOr, Stream)가 지원됩니다. +- 함수가 async로 표시되면, provider는 오류(errors)/로딩(loading) 상태를 자동으로 처리하고 AsyncValue를 노출합니다. + + + + + + + + + + + + + + + + + + + + + + + +
+ Functional +
+ (공개(Public) 메소드로 +
+ 부가작업(Side-Effects)을 처리할 수 없습니다) + 		+ Class-Based +
+ (공개(Public) 메소드로 +
+ 부가작업(Side-Effects)을 처리할 수 있습니다) +
+ + Sync + + + {trimSnippet(syncFn)} + + {trimSnippet(syncClass)} +
+ + Async - Future + + + {trimSnippet(asyncFnFuture)} + + {trimSnippet(asyncClassFuture)} +
+ + Async - Stream + + + {trimSnippet(asyncFnStream)} + + {trimSnippet(asyncClassStream)} +
+ +### 자동폐기(autoDispose) 활성화/비활성화: + +코드 생성을 사용할때, provider는 기본적으로 autoDispose가 활성화됩니다. +코드 생성을 사용할 때 공급자는 기본적으로 자동 폐기됩니다. +즉, 연결(ref.watch/ref.listen)된 리스너가 없을 때 자동으로 폐기됩니다. +이 기본 설정은 Riverpod의 철학에 더 잘 부합합니다. +코드 생성하지 않는 버전을 사용하면, `package:provider`에서 마이그레이션하는 사용자를 위해 자동폐기(autoDispose) 기능이 기본적으로 꺼져 있었습니다. + +자동폐기(autoDispose)를 비활성화하려면, `autoDispose: false`를 어노테이션에 전달하면 됩니다. + +{trimSnippet(autoDisposeCodeGen)} + +### provider에 매개변수 전달하기 (family): + +코드 생성을 사용할 때, provider에 매개변수를 전달하기위해 더 이상 `family` 수정자(modifier)를 사용할 필요가 없습니다. +대신 provider의 메인 함수(main function)는 명명된 매개변수(named parameters), 선택적 매개변수(optional parameters), 기본값(default values)을 포함하여 모든 매개변수를 받을 수 있습니다. +그러나 이 매개변수들은 여전히 일관된 ==를 가져야 한다는 점에 유의하세요. +즉, 값이 캐시되거나 매개변수가 ==를 재정의해야 한다는 의미입니다. + + + + + + + + + + + + + + +
+ Functional + + Class-Based +
+ {trimSnippet(familyFn)} + + {trimSnippet(familyClass)} +
+ +## 코드 생성을 사용하지 않는 방식(non-code-generation variant)에서 마이그레이션하기: + +코드 생성 방식을 사용하지 않는 경우에는 provider의 타입을 직접 결정해야 합니다. +다음은 코드 생성 방식으로 전환하기 위한 해당 옵션입니다: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Provider +
Before + {trimSnippet(provider)} +
After + {trimSnippet(syncFn)} +
+ NotifierProvider +
Before + {trimSnippet(notifierProvider)} +
After + {trimSnippet(syncClass)} +
+ FutureProvider +
Before + {trimSnippet(futureProvider)} +
After + {trimSnippet(asyncFnFuture)} +
+ StreamProvider +
Before + {trimSnippet(streamProvider)} +
After + {trimSnippet(asyncFnStream)} +
+ AsyncNotifierProvider +
Before + + {trimSnippet(asyncNotifierProvider)} + +
After + {trimSnippet(asyncClassFuture)} +
+ StreamNotifierProvider +
Before + + {trimSnippet(streamNotifierProvider)} + +
After + {trimSnippet(asyncClassStream)} +
+ +[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html +[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html +[riverpod]: https://github.com/rrousselgit/riverpod +[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod +[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod +[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks +[build]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier/build.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.dart similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.dart diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.g.dart similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.g.dart diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart new file mode 100644 index 000000000..1988ec140 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_class_future.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + Future build() async { + return Future.value('foo'); + } + + // 상태(State) 변경(Mutation)을 위한 메서드 추가 +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart new file mode 100644 index 000000000..0fe4488e1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_class_future.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'8a906741b8ea4b9b0d3f0b924779704b3e1773a1'; + +/// See also [Example]. +@ProviderFor(Example) +final exampleProvider = + AutoDisposeAsyncNotifierProvider.internal( + Example.new, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Example = AutoDisposeAsyncNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart new file mode 100644 index 000000000..fdde7f0ef --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_class_stream.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + Stream build() async* { + yield 'foo'; + } + + // 상태(State) 변경(Mutation)을 위한 메서드 추가 +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart new file mode 100644 index 000000000..e44bf1860 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_class_stream.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'4bca936132b77a9a804549f086f33571724b4804'; + +/// See also [Example]. +@ProviderFor(Example) +final exampleProvider = + AutoDisposeStreamNotifierProvider.internal( + Example.new, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Example = AutoDisposeStreamNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart new file mode 100644 index 000000000..95fdd909c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_fn_future.g.dart'; + +/* SNIPPET START */ +@riverpod +Future example(ExampleRef ref) async { + return Future.value('foo'); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart new file mode 100644 index 000000000..f22d58704 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_fn_future.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'e620af6b870a76eea4228989433de0666957d813'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeFutureProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart new file mode 100644 index 000000000..74da790ad --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_fn_stream.g.dart'; + +/* SNIPPET START */ +@riverpod +Stream example(ExampleRef ref) async* { + yield 'foo'; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart new file mode 100644 index 000000000..56ff2877e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_fn_stream.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'8a2b19776fb9bbb1631f898bd6446b57b102dd9d'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeStreamProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeStreamProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart new file mode 100644 index 000000000..587576695 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart @@ -0,0 +1,12 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'auto_dispose.g.dart'; + +/* SNIPPET START */ +// 자동폐기(AutoDispose) provider (keepAlive는 기본적으로 false) +@riverpod +String example1(Example1Ref ref) => 'foo'; + +// 비자동폐기(Non autoDispose) provider +@Riverpod(keepAlive: true) +String example2(Example2Ref ref) => 'foo'; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart new file mode 100644 index 000000000..98e4139ea --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'auto_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$example1Hash() => r'8a5f0865f758792cc8e4f2ca67db334196df6e88'; + +/// See also [example1]. +@ProviderFor(example1) +final example1Provider = AutoDisposeProvider.internal( + example1, + name: r'example1Provider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$example1Hash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef Example1Ref = AutoDisposeProviderRef; +String _$example2Hash() => r'bc25731d759be185125d12d995d0b89b07d1e271'; + +/// See also [example2]. +@ProviderFor(example2) +final example2Provider = Provider.internal( + example2, + name: r'example2Provider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$example2Hash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef Example2Ref = ProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart new file mode 100644 index 000000000..e1ee685fb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart @@ -0,0 +1,7 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family.g.dart'; + +/* SNIPPET START */ +@riverpod +String example(ExampleRef ref, int param) => 'Hello $param'; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart new file mode 100644 index 000000000..fe7456f0d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart @@ -0,0 +1,200 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'c4f5a651a55bcf34b0c92d98d77436844cbdc097'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [example]. +@ProviderFor(example) +const exampleProvider = ExampleFamily(); + +/// See also [example]. +class ExampleFamily extends Family { + /// See also [example]. + const ExampleFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'exampleProvider'; + + /// See also [example]. + ExampleProvider call( + int param, + ) { + return ExampleProvider( + param, + ); + } + + @visibleForOverriding + @override + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return call( + provider.param, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(String Function(ExampleRef ref) create) { + return _$ExampleFamilyOverride(this, create); + } +} + +class _$ExampleFamilyOverride implements FamilyOverride { + _$ExampleFamilyOverride(this.overriddenFamily, this.create); + + final String Function(ExampleRef ref) create; + + @override + final ExampleFamily overriddenFamily; + + @override + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [example]. +class ExampleProvider extends AutoDisposeProvider { + /// See also [example]. + ExampleProvider( + int param, + ) : this._internal( + (ref) => example( + ref as ExampleRef, + param, + ), + from: exampleProvider, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$exampleHash, + dependencies: ExampleFamily._dependencies, + allTransitiveDependencies: ExampleFamily._allTransitiveDependencies, + param: param, + ); + + ExampleProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.param, + }) : super.internal(); + + final int param; + + @override + Override overrideWith( + String Function(ExampleRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: ExampleProvider._internal( + (ref) => create(ref as ExampleRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + param: param, + ), + ); + } + + @override + (int,) get argument { + return (param,); + } + + @override + AutoDisposeProviderElement createElement() { + return _ExampleProviderElement(this); + } + + ExampleProvider _copyWith( + String Function(ExampleRef ref) create, + ) { + return ExampleProvider._internal( + (ref) => create(ref as ExampleRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param: param, + ); + } + + @override + bool operator ==(Object other) { + return other is ExampleProvider && other.param == param; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, param.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin ExampleRef on AutoDisposeProviderRef { + /// The parameter `param` of this provider. + int get param; +} + +class _ExampleProviderElement extends AutoDisposeProviderElement + with ExampleRef { + _ExampleProviderElement(super.provider); + + @override + int get param => (origin as ExampleProvider).param; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart new file mode 100644 index 000000000..f071d44f6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart @@ -0,0 +1,17 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family_class.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + String build( + int param1, { + String param2 = 'foo', + }) { + return 'Hello $param1 & param2'; + } + + // 상태(State) 변경(Mutation)을 위한 메서드 추가 +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart new file mode 100644 index 000000000..1108d93c1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart @@ -0,0 +1,245 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family_class.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'c81e9d94e763b25403ab6b7fa03f092003570142'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +abstract class _$Example extends BuildlessAutoDisposeNotifier { + late final int param1; + late final String param2; + + String build( + int param1, { + String param2 = 'foo', + }); +} + +/// See also [Example]. +@ProviderFor(Example) +const exampleProvider = ExampleFamily(); + +/// See also [Example]. +class ExampleFamily extends Family { + /// See also [Example]. + const ExampleFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'exampleProvider'; + + /// See also [Example]. + ExampleProvider call( + int param1, { + String param2 = 'foo', + }) { + return ExampleProvider( + param1, + param2: param2, + ); + } + + @visibleForOverriding + @override + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return call( + provider.param1, + param2: provider.param2, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(Example Function() create) { + return _$ExampleFamilyOverride(this, create); + } +} + +class _$ExampleFamilyOverride implements FamilyOverride { + _$ExampleFamilyOverride(this.overriddenFamily, this.create); + + final Example Function() create; + + @override + final ExampleFamily overriddenFamily; + + @override + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [Example]. +class ExampleProvider extends AutoDisposeNotifierProviderImpl { + /// See also [Example]. + ExampleProvider( + int param1, { + String param2 = 'foo', + }) : this._internal( + () => Example() + ..param1 = param1 + ..param2 = param2, + from: exampleProvider, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$exampleHash, + dependencies: ExampleFamily._dependencies, + allTransitiveDependencies: ExampleFamily._allTransitiveDependencies, + param1: param1, + param2: param2, + ); + + ExampleProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.param1, + required this.param2, + }) : super.internal(); + + final int param1; + final String param2; + + @override + String runNotifierBuild( + covariant Example notifier, + ) { + return notifier.build( + param1, + param2: param2, + ); + } + + @override + Override overrideWith(Example Function() create) { + return ProviderOverride( + origin: this, + override: ExampleProvider._internal( + () => create() + ..param1 = param1 + ..param2 = param2, + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + param1: param1, + param2: param2, + ), + ); + } + + @override + ( + int, { + String param2, + }) get argument { + return ( + param1, + param2: param2, + ); + } + + @override + AutoDisposeNotifierProviderElement createElement() { + return _ExampleProviderElement(this); + } + + ExampleProvider _copyWith( + Example Function() create, + ) { + return ExampleProvider._internal( + () => create() + ..param1 = param1 + ..param2 = param2, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param1: param1, + param2: param2, + ); + } + + @override + bool operator ==(Object other) { + return other is ExampleProvider && + other.param1 == param1 && + other.param2 == param2; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, param1.hashCode); + hash = _SystemHash.combine(hash, param2.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin ExampleRef on AutoDisposeNotifierProviderRef { + /// The parameter `param1` of this provider. + int get param1; + + /// The parameter `param2` of this provider. + String get param2; +} + +class _ExampleProviderElement + extends AutoDisposeNotifierProviderElement + with ExampleRef { + _ExampleProviderElement(super.provider); + + @override + int get param1 => (origin as ExampleProvider).param1; + @override + String get param2 => (origin as ExampleProvider).param2; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart new file mode 100644 index 000000000..863df6f40 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart @@ -0,0 +1,13 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family_fn.g.dart'; + +/* SNIPPET START */ +@riverpod +String example( + ExampleRef ref, + int param1, { + String param2 = 'foo', +}) { + return 'Hello $param1 & param2'; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart new file mode 100644 index 000000000..a72fa27de --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart @@ -0,0 +1,224 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family_fn.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'99b3ed3d53932bd1354259200ebf08493af9ada2'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [example]. +@ProviderFor(example) +const exampleProvider = ExampleFamily(); + +/// See also [example]. +class ExampleFamily extends Family { + /// See also [example]. + const ExampleFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'exampleProvider'; + + /// See also [example]. + ExampleProvider call( + int param1, { + String param2 = 'foo', + }) { + return ExampleProvider( + param1, + param2: param2, + ); + } + + @visibleForOverriding + @override + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return call( + provider.param1, + param2: provider.param2, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(String Function(ExampleRef ref) create) { + return _$ExampleFamilyOverride(this, create); + } +} + +class _$ExampleFamilyOverride implements FamilyOverride { + _$ExampleFamilyOverride(this.overriddenFamily, this.create); + + final String Function(ExampleRef ref) create; + + @override + final ExampleFamily overriddenFamily; + + @override + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [example]. +class ExampleProvider extends AutoDisposeProvider { + /// See also [example]. + ExampleProvider( + int param1, { + String param2 = 'foo', + }) : this._internal( + (ref) => example( + ref as ExampleRef, + param1, + param2: param2, + ), + from: exampleProvider, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$exampleHash, + dependencies: ExampleFamily._dependencies, + allTransitiveDependencies: ExampleFamily._allTransitiveDependencies, + param1: param1, + param2: param2, + ); + + ExampleProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.param1, + required this.param2, + }) : super.internal(); + + final int param1; + final String param2; + + @override + Override overrideWith( + String Function(ExampleRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: ExampleProvider._internal( + (ref) => create(ref as ExampleRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + param1: param1, + param2: param2, + ), + ); + } + + @override + ( + int, { + String param2, + }) get argument { + return ( + param1, + param2: param2, + ); + } + + @override + AutoDisposeProviderElement createElement() { + return _ExampleProviderElement(this); + } + + ExampleProvider _copyWith( + String Function(ExampleRef ref) create, + ) { + return ExampleProvider._internal( + (ref) => create(ref as ExampleRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param1: param1, + param2: param2, + ); + } + + @override + bool operator ==(Object other) { + return other is ExampleProvider && + other.param1 == param1 && + other.param2 == param2; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, param1.hashCode); + hash = _SystemHash.combine(hash, param2.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin ExampleRef on AutoDisposeProviderRef { + /// The parameter `param1` of this provider. + int get param1; + + /// The parameter `param2` of this provider. + String get param2; +} + +class _ExampleProviderElement extends AutoDisposeProviderElement + with ExampleRef { + _ExampleProviderElement(super.provider); + + @override + int get param1 => (origin as ExampleProvider).param1; + @override + String get param2 => (origin as ExampleProvider).param2; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart new file mode 100644 index 000000000..05afdc3ef --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart @@ -0,0 +1,15 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = AsyncNotifierProvider.autoDispose( + ExampleNotifier.new, +); + +class ExampleNotifier extends AutoDisposeAsyncNotifier { + @override + Future build() async { + return Future.value('foo'); + } + + // 상태(State) 변경(Mutation)을 위한 메서드 추가 +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart new file mode 100644 index 000000000..6bfb8babd --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart @@ -0,0 +1,12 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +// 자동폐기(autodispose) 프로바이더 +final example1Provider = Provider.autoDispose((ref) { + return 'foo'; +}); + +// 비동기 자동폐기(autodispose) 프로바이더 +final example2Provider = Provider((ref) { + return 'foo'; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart new file mode 100644 index 000000000..a9e59d48d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart @@ -0,0 +1,6 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = Provider.family((ref, param) { + return 'Hello $param'; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart new file mode 100644 index 000000000..6306a76fb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart @@ -0,0 +1,7 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = + FutureProvider.autoDispose((ref) async { + return Future.value('foo'); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart new file mode 100644 index 000000000..852beb863 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart @@ -0,0 +1,15 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = NotifierProvider.autoDispose( + ExampleNotifier.new, +); + +class ExampleNotifier extends AutoDisposeNotifier { + @override + String build() { + return 'foo'; + } + + // 상태(State) 변경(Mutation)을 위한 메서드 추가 +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart new file mode 100644 index 000000000..1f541352a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart @@ -0,0 +1,8 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = Provider.autoDispose( + (ref) { + return 'foo'; + }, +); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart new file mode 100644 index 000000000..2ba322eb1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart @@ -0,0 +1,15 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = StreamNotifierProvider.autoDispose(() { + return ExampleNotifier(); +}); + +class ExampleNotifier extends AutoDisposeStreamNotifier { + @override + Stream build() async* { + yield 'foo'; + } + + // 상태(State) 변경(Mutation)을 위한 메서드 추가 +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart new file mode 100644 index 000000000..60d227f8f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart @@ -0,0 +1,6 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = StreamProvider.autoDispose((ref) async* { + yield 'foo'; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart new file mode 100644 index 000000000..dbe0773f9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'sync_class.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + String build() { + return 'foo'; + } + + // 상태(State) 변경(Mutation)을 위한 메서드 추가 +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart new file mode 100644 index 000000000..d4c658779 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'sync_class.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'c237193ab6d57674973aaa02eb73db6f6822eb26'; + +/// See also [Example]. +@ProviderFor(Example) +final exampleProvider = AutoDisposeNotifierProvider.internal( + Example.new, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Example = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart new file mode 100644 index 000000000..0d4922734 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'sync_fn.g.dart'; + +/* SNIPPET START */ +@riverpod +String example(ExampleRef ref) { + return 'foo'; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart new file mode 100644 index 000000000..daabcdd71 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'sync_fn.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'dd4e9043c704a42a3fc025e7fef9515f659fc78a'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/raw.dart similarity index 93% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/raw.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/raw.dart index 6e2543d77..4630c27ff 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/raw.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/raw.dart @@ -13,7 +13,7 @@ class Http { final http = Http(); /* SNIPPET START */ -final fetchUserProvider = FutureProvider.autoDispose.family((ref, userId) async { +final fetchUserProvider = FutureProvider.autoDispose.family((ref, userId) async { final json = await http.get('api/user/$userId'); return User.fromJson(json); }); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx new file mode 100644 index 000000000..5dcf7354d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx @@ -0,0 +1,310 @@ +--- +title: 훅(hooks)에 대한 정보 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import hookAndConsumer from "!!raw-loader!./about_hooks/hook_and_consumer.dart"; +import hookConsumer from "!!raw-loader!./about_hooks/hook_consumer.dart"; +import hookConsumerWidget from "!!raw-loader!./about_hooks/hook_consumer_widget.dart"; +import { CodeSnippet } from "../../../../../src/components/CodeSnippet"; +import { Link } from "../../../../../src/components/Link"; + +이 페이지는 훅(hooks)이 무엇이고 Riverpod과 어떻게 관련되어 있는지 설명합니다. + +"훅(hooks)"은 Riverpod과는 독립적으로 별도의 패키지에서 제공되는 공통 유틸리티입니다: [flutter_hooks]. +[flutter_hooks]는 완전히 별개의 패키지로 Riverpod과 (적어도 직접적으로는) 관련이 없지만, Riverpod과 [flutter_hooks]를 함께 사용하는 것이 일반적입니다. + +## 훅(hooks)을 사용해야 할까요? + +훅(hooks)은 강력한 도구이지만 모든 사람에게 적합한 것은 아닙니다. +Riverpod에 처음 사용하는 분이라면, 훅(hooks) 사용을 피하는 것이 좋습니다. + +훅(hooks)은 유용하지만 Riverpod에 필수적인 것은 아닙니다. +Riverpod 때문에 훅(hooks)을 사용해서는 안됩니다. 오히려 훅(hooks)을 사용하고 싶어서 훅(hooks)을 사용해야 합니다. + +훅(hooks)사용은 장단점(tradeoff)가 있습니다. +훅(hooks)은 강력(robust)하고 재사용(reusable) 가능한 코드를 생성하는데 유용하지만, 배워야하는 새로운 개념이기 때문에 처음에는 혼란스러울 수 있습니다. +훅(hooks)은 Flutter의 핵심 개념이 아닙니다. 따라서 Flutter/Dart에서는 어색하게 느껴질 수 있습니다. + +## 훅(hooks)이란 무엇인가? + +훅(hooks)은 위젯 내부에서 사용되는 함수입니다. +[StatefulWidget]의 대안으로 설계되었으며, 로직을 더 재사용(reusable) 가능하고 조합(composable) 가능하게 만듭니다. + +훅(hooks)은 [React](https://reactjs.org/)에서 온 개념이며, [flutter_hooks]는 단지 React 구현을 Flutter로 포팅한 것입니다. +따라서 훅(hooks)은 Flutter에서 약간 어색할 수 있습니다. +이상적으로 향후에 Flutter를 위해 특별히 설계된 훅(hooks)이 해결하는 문제에 대한 솔루션이 있을 것입니다. + +Riverpod의 provider가 "전역(Global)" 애플리케이션 상태(State)를 위한 것이라면, 훅(Hooks)은 로컬 위젯 상태를 위한 것입니다. +훅(Hooks)dms 일반적으로 상태 저장형 UI 객체를 처리하는 데 사용됩니다, +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html), +[AnimationController](https://api.flutter.dev/flutter/animation/AnimationController-class.html). +또한 "빌더(Builder)" 패턴을 대체하는 역할도 수행할 수 있는데, +[FutureBuilder](https://api.flutter.dev/flutter/widgets/FutureBuilder-class.html)/[TweenAnimatedBuilder](https://api.flutter.dev/flutter/widgets/TweenAnimationBuilder-class.html)와 같은 위젯을 "중첩(nesting)"을 포함하지 않는 대안 유발하지 않는 방식으로 변경으로 가독성을 크게 향상시킬 수 있습니다. + +일반적으로, 훅(hooks)은 다음과 같은 경우에 유용합니다: + +- 폼(forms) +- 애니메이션(animations) +- 사용자 이벤트에 반응하기(reacting to user events) +- ... + +예를 들어, 훅(Hooks)를 위젯이 보이지 않다가 서서히 나타나는 페이드인(Fade-in) 애니메이션을 직접 구현하는데 사용할 수 있습니다. + +만약 [StatefulWidget]을 사용한다면, 코드는 다음과 같을 것입니다: + +```dart +class FadeIn extends StatefulWidget { + const FadeIn({Key? key, required this.child}) : super(key: key); + + final Widget child; + + @override + State createState() => _FadeInState(); +} + +class _FadeInState extends State with SingleTickerProviderStateMixin { + late final AnimationController animationController = AnimationController( + vsync: this, + duration: const Duration(seconds: 2), + ); + + @override + void initState() { + super.initState(); + animationController.forward(); + } + + @override + void dispose() { + animationController.dispose(); + super.dispose(); + } + + @override + Widget build(BuildContext context) { + return AnimatedBuilder( + animation: animationController, + builder: (context, child) { + return Opacity( + opacity: animationController.value, + child: widget.child, + ); + }, + ); + } +} +``` + +훅(hooks)을 사용하면, 동일한 코드는 다음과 같을 것입니다: + +```dart +class FadeIn extends HookWidget { + const FadeIn({Key? key, required this.child}) : super(key: key); + + final Widget child; + + @override + Widget build(BuildContext context) { + // AnimationController 생성. + // 위젯인 마운트해제(unmounted)되면 컨트롤러는 자동으로 폐기(disposed)됩니다. + final animationController = useAnimationController( + duration: const Duration(seconds: 2), + ); + + // useEffect는 initState + didUpdateWidget + dispose와 동일합니다 + // useEffect에 잔달된 콜백(callback)은 훅(hook)이 처음 호출될 때 실행되고, + // 두 번째 매개변수로 전달된 목록이 변경될 때마다 실행됩니다. + // 여기서는 빈 const list를 전달하므로, 이는 엄밀히 말해 `initState`와 동일합니다. + useEffect(() { + // 위젯이 처음 렌더링될 때 애니메이션이 시작 + animationController.forward(); + // 여기서 선택적으로 "Dispose"로직을 반환할 수 있습니다. + return null; + }, const []); + + // 애니메이션이 업데이트될 때 이 위젯을 다시 빌드하도록 Flutter에 알립니다. + // 이는 AnimatedBuilder와 동일합니다 + useAnimation(animationController); + + return Opacity( + opacity: animationController.value, + child: child, + ); + } +} +``` + +이 코드에서 주목해야 할 몇 가지 흥미로운 사항이 있습니다: + +- 메모리 누수가 없습니다. 이 코드는 위젯이 리빌드될 때마다 새로운 `AnimationController`를 다시 생성하지 않으며, + 위젯이 마운트해제(unmounted)될 때 컨트롤러가 올바르게 해제(released)됩니다. + +- 동일한 위젯 내에서 원하는 만큼 많이 훅(Hooks)을 사용할 수 있습니다. + 따라서 원한다면 여러 `AnimationController`를 생성할 수 있습니다: + + ```dart + @override + Widget build(BuildContext context) { + final animationController = useAnimationController( + duration: const Duration(seconds: 2), + ); + final anotherController = useAnimationController( + duration: const Duration(seconds: 2), + ); + + ... + } + ``` + + 이렇게 하면 어떤 부정적인 결과도 없이 두 개의 컨트롤러가 생성됩니다. + +- 원한다면 이 로직을 재사용 가능한 별도의 함수로 리팩터링할 수 있습니다: + + ```dart + double useFadeIn() { + final animationController = useAnimationController( + duration: const Duration(seconds: 2), + ); + useEffect(() { + animationController.forward(); + return null; + }, const []); + useAnimation(animationController); + return animationController.value; + } + ``` + + 그런 다음 위젯이 [HookWidget]이라면 위젯 내에서 이 함수를 사용할 수 있습니다: + + ```dart + class FadeIn extends HookWidget { + const FadeIn({Key? key, required this.child}) : super(key: key); + + final Widget child; + + @override + Widget build(BuildContext context) { + final fade = useFadeIn(); + + return Opacity(opacity: fade, child: child); + } + } + ``` + + `useFadeIn` 함수가 `FadeIn` 위젯과 완전히 독립적이라는 점에 주목하세요. + 원한다면 완전히 다른 위젯에서 `useFadeIn` 함수를 사용할 수 있고, 여전히 동작할 것입니다! + +## 훅(Hooks) 규칙 + +훅(Hooks)은 고유한 제약 조건이 있습니다: + +- [HookWidget]을 확장(extends)하는 위젯의 `build` 메서드 내에서만 사용할 수 있습니다: + + **Good**: + + ```dart + class Example extends HookWidget { + @override + Widget build(BuildContext context) { + final controller = useAnimationController(); + ... + } + } + ``` + + **Bad**: + + ```dart + // Not a HookWidget + class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + final controller = useAnimationController(); + ... + } + } + ``` + + **Bad**: + + ```dart + class Example extends HookWidget { + @override + Widget build(BuildContext context) { + return ElevatedButton( + onPressed: () { + // _실제로_ 'build' 메서드 내부가 아니라 사용자 상호작용 라이프사이클 내부 (여기서는 'onPressed'). + final controller = useAnimationController(); + }, + child: Text('click me'), + ); + } + } + ``` + +- 조건부 또는 루프 안에서 사용할 수 없습니다. + + **Bad**: + + ```dart + class Example extends HookWidget { + const Example({required this.condition, super.key}); + final bool condition; + @override + Widget build(BuildContext context) { + if (condition) { + // 훅(Hooks)은 "if"/"for", ... 안에서 사용할 수 없습니다. + final controller = useAnimationController(); + } + ... + } + } + ``` + +훅(Hook)에 대한 자세한 내용은 [flutter_hooks]를 참조하세요. + +## 훅(Hooks)과 Riverpod + +### 설치 +훅(Hook)은 Riverpod과는 별개이므로 별도로 훅(Hook)를 설치해야 합니다. +훅(Hook)를 사용하려면 [hooks_riverpod]를 설치하는 것만으로는 충분하지 않습니다. +여전히 종속성에 [flutter_hooks]를 추가해야 합니다. +자세한 내용은 를 참조하세요. + +### 사용법 + +경우에 따라서는 훅(Hook)과 Riverpod을 모두 사용하는 위젯을 작성하고 싶을 수도 있습니다. +하지만 이미 알고 계실 수도 있겠지만, 훅(Hook)과 Riverpod 모두 +고유한 사용자 정의 위젯 기본유형을 제공합니다.: [HookWidget] 및 [ConsumerWidget] +하지만 클래스는 한 번에 하나의 수퍼클래스만 확장(extend)할 수 있습니다. + +이 문제를 해결하기 위해 [hooks_riverpod] 패키지를 사용할 수 있습니다. +이 패키지는 [HookWidget]과 [ConsumerWidget]을 단일 유형으로 결합하는 [HookConsumerWidget] 클래스를 제공합니다. +따라서 [HookWidget] 대신 [HookConsumerWidget]을 서브클래싱할 수 있습니다: + + + +또는, 두 패키지 모두에서 제공하는 "Builder"를 사용할 수도 있습니다. +예를 들어, `StatelessWidget`을 계속 사용하고 `HookBuilder`와 `Consumer`를 모두 사용할 수 있습니다. + + + +:::note +이 접근 방식은 [hooks_riverpod]를 사용하지 않고도 작동합니다. [flutter_riverpod] 만 만 필요합니다. +::: + +이 접근 방식이 마음에 들면, 두 빌더를 하나로 결합한 [HookConsumer]를 제공하여 간소화할 수 있습니다: + + + +[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html +[hookconsumer]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/HookConsumer-class.html +[hookconsumerwidget]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/HookConsumerWidget-class.html +[consumerwidget]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ConsumerWidget-class.html +[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html +[riverpod]: https://github.com/rrousselgit/riverpod +[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod +[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod +[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart new file mode 100644 index 000000000..b8d4be89e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart @@ -0,0 +1,28 @@ +// ignore_for_file: use_key_in_widget_constructors, unused_local_variable + +import 'package:flutter/widgets.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../providers/creating_a_provider/codegen.dart'; + +class MyValue {} + +/* SNIPPET START */ + +class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + // 두 패키지 모두에서 제공하는 빌더를 사용할 수 있습니다. + return Consumer( + builder: (context, ref, child) { + return HookBuilder(builder: (context) { + final counter = useState(0); + final value = ref.watch(myProvider); + + return Text('Hello $counter $value'); + }); + }, + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart new file mode 100644 index 000000000..5d23c0d0a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart @@ -0,0 +1,26 @@ +// ignore_for_file: use_key_in_widget_constructors, unused_local_variable + +import 'package:flutter/widgets.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../providers/creating_a_provider/codegen.dart'; + +class MyValue {} + +/* SNIPPET START */ + +class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + // Consumer와 HookBuilder 모두 사용하는 것과 동일합니다. + return HookConsumer( + builder: (context, ref, child) { + final counter = useState(0); + final value = ref.watch(myProvider); + + return Text('Hello $counter $value'); + }, + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart new file mode 100644 index 000000000..9d857d887 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart @@ -0,0 +1,23 @@ +// ignore_for_file: use_key_in_widget_constructors, unused_local_variable + +import 'package:flutter/widgets.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../providers/creating_a_provider/codegen.dart'; + +class MyValue {} + +/* SNIPPET START */ + +// HookWidget 대신 HookConsumerWidget을 확장합니다. +class Example extends HookConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 여기서는 hooks과 providers를 모두 사용할 수 있습니다. + final counter = useState(0); + final value = ref.watch(myProvider); + + return Text('Hello $counter $value'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart new file mode 100644 index 000000000..18817b776 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart @@ -0,0 +1,58 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:shared_preferences/shared_preferences.dart'; + +class LoadingScreen extends StatelessWidget { + const LoadingScreen({super.key}); + + @override + Widget build(BuildContext context) { + return const CircularProgressIndicator(); + } +} + +/* SNIPPET START */ +// We'd like to obtain an instance of shared preferences synchronously in a provider +final countProvider = StateProvider((ref) { + final preferences = ref.watch(sharedPreferencesProvider); + final currentValue = preferences.getInt('count') ?? 0; + ref.listenSelf((prev, curr) { + preferences.setInt('count', curr); + }); + return currentValue; +}); + +// We don't have an actual instance of SharedPreferences, and we can't get one except asynchronously +final sharedPreferencesProvider = + Provider((ref) => throw UnimplementedError()); + +Future main() async { + // Show a loading indicator before running the full app (optional) + // The platform's loading screen will be used while awaiting if you omit this. + runApp(const LoadingScreen()); + + // Get the instance of shared preferences + final prefs = await SharedPreferences.getInstance(); + return runApp( + ProviderScope( + overrides: [ + // Override the unimplemented provider with the value gotten from the plugin + sharedPreferencesProvider.overrideWithValue(prefs), + ], + child: const MyApp(), + ), + ); +} + +class MyApp extends ConsumerWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // Use the provider without dealing with async issues + final count = ref.watch(countProvider); + return Text('$count'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart new file mode 100644 index 000000000..b544b3778 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart @@ -0,0 +1,29 @@ +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'models.dart'; + +part 'codegen.g.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +// The current search filter +final searchProvider = StateProvider((ref) => ''); + +@riverpod +Stream configs(ConfigsRef ref) { + return Stream.value(Configuration()); +} + +@riverpod +Future> characters(CharactersRef ref) async { + final search = ref.watch(searchProvider); + final configs = await ref.watch(configsProvider.future); + final response = await dio.get>>( + '${configs.host}/characters?search=$search'); + + return response.data!.map(Character.fromJson).toList(); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart new file mode 100644 index 000000000..710947519 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$configsHash() => r'166cbe95e6b49ed7bc78c96041fb14abddbf6911'; + +/// See also [configs]. +@ProviderFor(configs) +final configsProvider = AutoDisposeStreamProvider.internal( + configs, + name: r'configsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$configsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ConfigsRef = AutoDisposeStreamProviderRef; +String _$charactersHash() => r'b1e8e15bbeab60d92fe959d9e1dd4ceba6a31446'; + +/// See also [characters]. +@ProviderFor(characters) +final charactersProvider = AutoDisposeFutureProvider>.internal( + characters, + name: r'charactersProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$charactersHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CharactersRef = AutoDisposeFutureProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart new file mode 100644 index 000000000..e21e1d7c6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart @@ -0,0 +1,17 @@ + +class Character { + Character(); + + // ignore: avoid_unused_constructor_parameters + factory Character.fromJson(Map json) { + return Character(); + } +} + +class Configuration { + Configuration({ + this.host = '', + }); + + final String host; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart new file mode 100644 index 000000000..948148bd0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart @@ -0,0 +1,25 @@ +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'models.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +// The current search filter +final searchProvider = StateProvider((ref) => ''); + +/// Configurations which can change over time +final configsProvider = StreamProvider( + (ref) => Stream.value(Configuration()), +); + +final charactersProvider = FutureProvider>((ref) async { + final search = ref.watch(searchProvider); + final configs = await ref.watch(configsProvider.future); + final response = await dio.get>>( + '${configs.host}/characters?search=$search'); + + return response.data!.map(Character.fromJson).toList(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart new file mode 100644 index 000000000..8b8f234b9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart @@ -0,0 +1,7 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +String city(CityRef ref) => 'London'; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart new file mode 100644 index 000000000..ac0b5a099 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +/// See also [city]. +@ProviderFor(city) +final cityProvider = AutoDisposeProvider.internal( + city, + name: r'cityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$cityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CityRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart new file mode 100644 index 000000000..d8093431c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart @@ -0,0 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final cityProvider = Provider((ref) => 'London'); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart new file mode 100644 index 000000000..0d2e49b28 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart @@ -0,0 +1,31 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../todo_list_provider/raw.dart'; + +part 'codegen.g.dart'; + +enum Filter { + none, + completed, + uncompleted, +} + +final filterProvider = StateProvider((ref) => Filter.none); + +/* SNIPPET START */ + +@riverpod +List filteredTodoList(FilteredTodoListRef ref) { + final filter = ref.watch(filterProvider); + final todos = ref.watch(todoListProvider); + + switch (filter) { + case Filter.none: + return todos; + case Filter.completed: + return todos.where((todo) => todo.completed).toList(); + case Filter.uncompleted: + return todos.where((todo) => !todo.completed).toList(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart new file mode 100644 index 000000000..c26fbd6ba --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$filteredTodoListHash() => r'1c35eb0fce8fc7c7cda86413b02f606f8c8ae2b4'; + +/// See also [filteredTodoList]. +@ProviderFor(filteredTodoList) +final filteredTodoListProvider = AutoDisposeProvider>.internal( + filteredTodoList, + name: r'filteredTodoListProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$filteredTodoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef FilteredTodoListRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart new file mode 100644 index 000000000..85885e800 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart @@ -0,0 +1,26 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import '../todo_list_provider/raw.dart'; + +enum Filter { + none, + completed, + uncompleted, +} + +final filterProvider = StateProvider((ref) => Filter.none); + +/* SNIPPET START */ + +final filteredTodoListProvider = Provider>((ref) { + final filter = ref.watch(filterProvider); + final todos = ref.watch(todoListProvider); + + switch (filter) { + case Filter.none: + return todos; + case Filter.completed: + return todos.where((todo) => todo.completed).toList(); + case Filter.uncompleted: + return todos.where((todo) => !todo.completed).toList(); + } +}); \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart new file mode 100644 index 000000000..b1cb3dbe3 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart @@ -0,0 +1,17 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +MyValue another(AnotherRef ref) => MyValue(); + +class MyValue {} + +/* SNIPPET START */ + +@riverpod +MyValue my(MyRef ref) { + // Bad practice to call `read` here + final value = ref.read(anotherProvider); + return value; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart new file mode 100644 index 000000000..50ab2adaf --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$anotherHash() => r'bb412edc55657c14eace37792cd18e5254604a36'; + +/// See also [another]. +@ProviderFor(another) +final anotherProvider = AutoDisposeProvider.internal( + another, + name: r'anotherProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$anotherHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef AnotherRef = AutoDisposeProviderRef; +String _$myHash() => r'2712c772be4dbaabd4c99fd803f927a7e9938b21'; + +/// See also [my]. +@ProviderFor(my) +final myProvider = AutoDisposeProvider.internal( + my, + name: r'myProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef MyRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart new file mode 100644 index 000000000..76bae4653 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart @@ -0,0 +1,13 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +final anotherProvider = Provider((ref) => MyValue()); + +class MyValue {} + +/* SNIPPET START */ + +final myProvider = Provider((ref) { + // Bad practice to call `read` here + final value = ref.read(anotherProvider); + return value; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart new file mode 100644 index 000000000..e44e202bc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart @@ -0,0 +1,25 @@ + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'models.dart'; + +part 'codegen.g.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +@riverpod +Stream config(ConfigRef ref) => Stream.value(Configuration()); + +@riverpod +Future> products(ProductsRef ref) async { + // Listens only to the host. If something else in the configurations + // changes, this will not pointlessly re-evaluate our provider. + final host = await ref.watch(configProvider.selectAsync((config) => config.host)); + + final result = await dio.get>>('$host/products'); + + return result.data!.map(Product.fromJson).toList(); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart new file mode 100644 index 000000000..cc039edb4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$configHash() => r'3021d1a8aac384e99d5d22714ffe6e868954888b'; + +/// See also [config]. +@ProviderFor(config) +final configProvider = AutoDisposeStreamProvider.internal( + config, + name: r'configProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$configHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ConfigRef = AutoDisposeStreamProviderRef; +String _$productsHash() => r'd1f4523880408cf8ee0e68969c40cf87d5c78557'; + +/// See also [products]. +@ProviderFor(products) +final productsProvider = AutoDisposeFutureProvider>.internal( + products, + name: r'productsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$productsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ProductsRef = AutoDisposeFutureProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart new file mode 100644 index 000000000..3a711b4b6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart @@ -0,0 +1,21 @@ +// ignore_for_file: sort_constructors_first + +class Product { + const Product({this.title = ''}); + + final String title; + + factory Product.fromJson(Map map) { + return Product( + title: map['title'] as String, + ); + } +} + +class Configuration { + Configuration({ + this.host = '', + }); + + final String host; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart new file mode 100644 index 000000000..ae35300b0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart @@ -0,0 +1,20 @@ +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'models.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +final configProvider = + StreamProvider((ref) => Stream.value(Configuration())); + +final productsProvider = FutureProvider>((ref) async { + // Listens only to the host. If something else in the configurations + // changes, this will not pointlessly re-evaluate our provider. + final host = await ref.watch(configProvider.selectAsync((config) => config.host)); + final result = await dio.get>>('$host/products'); + + return result.data!.map(Product.fromJson).toList(); +}); \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart new file mode 100644 index 000000000..a1942dbd4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart @@ -0,0 +1,24 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +@freezed +class Todo with _$Todo { + factory Todo({ + required String id, + required String description, + required bool completed, + }) = _Todo; +} + +/* SNIPPET START */ + +@riverpod +class TodoList extends _$TodoList { + @override + List build() { + return []; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart new file mode 100644 index 000000000..0b73d3548 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart @@ -0,0 +1,166 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$Todo { + String get id => throw _privateConstructorUsedError; + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc + +class _$TodoImpl implements _Todo { + _$TodoImpl( + {required this.id, required this.description, required this.completed}); + + @override + final String id; + @override + final String description; + @override + final bool completed; + + @override + String toString() { + return 'Todo(id: $id, description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.id, id) || other.id == id) && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @override + int get hashCode => Object.hash(runtimeType, id, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); +} + +abstract class _Todo implements Todo { + factory _Todo( + {required final String id, + required final String description, + required final bool completed}) = _$TodoImpl; + + @override + String get id; + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart new file mode 100644 index 000000000..f7076044d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todoListHash() => r'6c965beb867ffeee119133f0ae2e6ebeb68e6f7e'; + +/// See also [TodoList]. +@ProviderFor(TodoList) +final todoListProvider = + AutoDisposeNotifierProvider>.internal( + TodoList.new, + name: r'todoListProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$TodoList = AutoDisposeNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart new file mode 100644 index 000000000..a341b7f5b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart @@ -0,0 +1,36 @@ +// ignore_for_file: public_member_api_docs, sort_constructors_first +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Todo { + const Todo({ + required this.id, + required this.description, + required this.completed, + }); + + // All properties should be `final` on our class. + final String id; + final String description; + final bool completed; + + // Since Todo is immutable, we implement a method that allows cloning the + // Todo with slightly different content. + Todo copyWith({String? id, String? description, bool? completed}) { + return Todo( + id: id ?? this.id, + description: description ?? this.description, + completed: completed ?? this.completed, + ); + } +} + +/* SNIPPET START */ + +class TodoList extends Notifier> { + @override + List build() { + return []; + } +} + +final todoListProvider = NotifierProvider>(TodoList.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart new file mode 100644 index 000000000..8f7af2644 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart @@ -0,0 +1,20 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +String city(CityRef ref) => 'London'; + +class Weather {} + +Future fetchWeather({required String city}) async => Weather(); +/* SNIPPET START */ +@riverpod +Future weather(WeatherRef ref) { + // We use `ref.watch` to listen to another provider, and we pass it the provider + // that we want to consume. Here: cityProvider + final city = ref.watch(cityProvider); + + // We can then use the result to do something based on the value of `cityProvider`. + return fetchWeather(city: city); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart new file mode 100644 index 000000000..a259eb12b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +/// See also [city]. +@ProviderFor(city) +final cityProvider = AutoDisposeProvider.internal( + city, + name: r'cityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$cityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CityRef = AutoDisposeProviderRef; +String _$weatherHash() => r'9a79d0269032630918eef9d3f562ff35b5860061'; + +/// See also [weather]. +@ProviderFor(weather) +final weatherProvider = AutoDisposeFutureProvider.internal( + weather, + name: r'weatherProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$weatherHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef WeatherRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart new file mode 100644 index 000000000..d25ec4ffc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart @@ -0,0 +1,18 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +final cityProvider = Provider((ref) => 'London'); + +class Weather {} + +Future fetchWeather({required String city}) async => Weather(); + +/* SNIPPET START */ + +final weatherProvider = FutureProvider((ref) async { + // We use `ref.watch` to listen to another provider, and we pass it the provider + // that we want to consume. Here: cityProvider + final city = ref.watch(cityProvider); + + // We can then use the result to do something based on the value of `cityProvider`. + return fetchWeather(city: city); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart new file mode 100644 index 000000000..1a90008ed --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart @@ -0,0 +1,24 @@ +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'models.dart'; + +part 'codegen.g.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +@riverpod +Stream config(ConfigRef ref) => Stream.value(Configuration()); + +@riverpod +Future> products(ProductsRef ref) async { + // Will cause productsProvider to re-fetch the products if anything in the + // configurations changes + final configs = await ref.watch(configProvider.future); + + final result = + await dio.get>>('${configs.host}/products'); + return result.data!.map(Product.fromJson).toList(); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart new file mode 100644 index 000000000..25c5a7ded --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$configHash() => r'3021d1a8aac384e99d5d22714ffe6e868954888b'; + +/// See also [config]. +@ProviderFor(config) +final configProvider = AutoDisposeStreamProvider.internal( + config, + name: r'configProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$configHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ConfigRef = AutoDisposeStreamProviderRef; +String _$productsHash() => r'637254615fa398af0d36e212f09e5d3d8ff866aa'; + +/// See also [products]. +@ProviderFor(products) +final productsProvider = AutoDisposeFutureProvider>.internal( + products, + name: r'productsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$productsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ProductsRef = AutoDisposeFutureProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart new file mode 100644 index 000000000..8009c2fd8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart @@ -0,0 +1,16 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +class Product { + Product(); + factory Product.fromJson(Map json) { + return Product(); + } +} + +class Configuration { + Configuration({ + this.host = '', + }); + + final String host; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart new file mode 100644 index 000000000..be2be903c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart @@ -0,0 +1,20 @@ +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'models.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +final configProvider = + StreamProvider((ref) => Stream.value(Configuration())); + +final productsProvider = FutureProvider>((ref) async { + // Will cause productsProvider to re-fetch the products if anything in the + // configurations changes + final configs = await ref.watch(configProvider.future); + + final result = await dio.get>>('${configs.host}/products'); + return result.data!.map(Product.fromJson).toList(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index d71f1d0d9..5f5d33c9e 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -1,65 +1,73 @@ --- -title: 프로바이더 결합하기 +title: Combining Provider States --- -들어가기 앞서 먼저 [프로바이더란](/docs/concepts/providers)문서를 먼저 읽어주세요. -이 가이드는 복수의 프로바이더들(providers) 결합하는 방법에 대해서 알아볼 예정입니다. +import charactersProvider from "./combining_provider_states/characters_provider"; +import cityProvider from "./combining_provider_states/city_provider"; +import filteredTodoListProvider from "./combining_provider_states/filtered_todo_list_provider"; +import readInProvider from "./combining_provider_states/read_in_provider"; +import selectAsyncProvider from "./combining_provider_states/select_async_provider"; +import todoListProvider from "./combining_provider_states/todo_list_provider"; +import weatherProvider from "./combining_provider_states/weather_provider"; +import wholeObjectProvider from "./combining_provider_states/whole_object_provider"; +import { Link } from "../../../../../src/components/Link"; +import { + trimSnippet, + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -## 프로바이더 결합하기 +Make sure to read first. +In this guide, we will learn about combining provider states. -이전에 간단한 프로바이더를 생성하는 방법을 알아보았습니다. 그런데 현실에서는 -수많은 상황 중에서 하나의 프로바이더가 다른 프로바이더의 상태를 읽어 사용하는 경우가 많이 있습니다. +## Combining provider states -여러 프로바이더를 결합하기 위해서 [ref] 객체를 사용하여 콜백을 전달하거나 [watch] 메소드를 사용할 수 있습니다. +We've previously seen how to create a simple provider. But the reality is, +in many situations a provider will want to read the state of another provider. -예를 들어, 아래와 같은 프로바이더가 있다고 고려해 보겠습니다. +To do that, we can use the [ref] object passed to the callback of our provider, +and use its [watch] method. -```dart -final cityProvider = Provider((ref) => 'London'); -``` +As an example, consider the following provider: -이제 `cityProvider`를 사용하고 싶은 다른 프로바이더를 만들어 보려고 합니다. + -```dart -final weatherProvider = FutureProvider((ref) async { - // `ref.watch`를 사용해 다른 프로바이더를 읽어올 수 있습니다. - // 그리고 프로바이더를 넘겨줄 수 있습니다. (여기서는 cityProvider가 되겠습니다.) - final city = ref.watch(cityProvider); +We can now create another provider that will consume our `cityProvider`: - // `cityProvider` 값을 기반으로한 무언가의 결과를 반환할 수 있습니다. - return fetchWeather(city: city); -}); -``` + -이상입니다. 여기서 우리는 다른 프로바이더에 의존하는 한개의 프로바이더를 만드는 방법을 알아보았습니다. +That's it. We've created a provider that depends on another provider. ## FAQ -### 구독중인 값이 시간이 지남에 따라 변경되면 어떻게 되나요? +### What if the value being listened to changes over time? -관찰하거나 구독하고 있는 프로바이더에 의존하여 값이 매번 갱신이 될때 마다 새로운 상태값을 -얻게 됩니다. 예를 들어, [StateNotifierProvider]를 구독하고 있거나 [ProviderContainer.refresh]/[ref.refresh] -에 의해 강제적으로 갱신이 되었다면 물론 구독중인 상태값은 갱신되어 전달될 것입니다. +Depending on the provider that you are listening to, the value obtained may +change over time. +For example, you may be listening to a [NotifierProvider], or the provider +being listened to may have been forced to refresh through the use of +[ProviderContainer.refresh]/[ref.refresh]. -[watch]를 사용할 때, Riverpod은 상태값의 변화를 검출하고 _자동적_ 으로 프로바이더를 필요할 때 재 실행합니다. +When using [watch], Riverpod is able to detect that the value being listened to changed +and will _automatically_ re-execute the provider's creation callback when needed. -이것은 상태들을 계산하기 유용할 수 있습니다. -예를 들어 [StateNotifierProvider]가 할일 목록(a todo-list)의 값을 가진다고 생각해 봅시다. +This can be useful for computed states. +For example, consider a that exposes a todo-list: -```dart -class TodoList extends StateNotifier> { - TodoList(): super(const []); -} - -final todoListProvider = StateNotifierProvider((ref) => TodoList()); -``` + +A common use-case would be to have the UI filter the list of todos to show +only the completed/uncompleted todos. -일반적인 사용방법으로 완료된/완료되지 않은 할일만 표시하도록 UI가 할일 목록을 필터링하도록 하는 것입니다. +An easy way to implement such a scenario would be to: -이러한 시나리오를 구현하는 쉬운 방법은 다음과 같습니다. - -- [StateProvider]를 생성합니다. `filterProvider`는 현재 어떤 필터를 선택하고 있는지에 대한 상태 값을 가집니다. +- create a [StateProvider], which exposes the currently selected filter method: ```dart enum Filter { @@ -71,88 +79,58 @@ final todoListProvider = StateNotifierProvider((ref) => TodoList()); final filterProvider = StateProvider((ref) => Filter.none); ``` -- 필터 메소드(`filterProvider`)와 할일 목록(`todoListProvider`)을 결합하여 필터링된 할일 목록 값을 제공하는 별도의 프로바이더(`filteredTodoListProvider`)를 만듭니다. +- make a separate provider which combines the filter method and the todo-list + to expose the filtered todo-list: - ```dart - final filteredTodoListProvider = Provider>((ref) { - final filter = ref.watch(filterProvider); - final todos = ref.watch(todoListProvider); - - switch (filter) { - case Filter.none: - return todos; - case Filter.completed: - return todos.where((todo) => todo.completed).toList(); - case Filter.uncompleted: - return todos.where((todo) => !todo.completed).toList(); - } - }); - ``` + -그리고, UI에서 `filteredTodoListProvider`를 구독하여 필터링된 할일 목록을 받아 올 수 있습니다. -필터와 할일 목록이 각각 갱신(변경)될때 마다 자동적으로 UI 업데이트가 이루어 집니다. +Then, our UI can listen to `filteredTodoListProvider` to listen to the filtered todo-list. +Using such an approach, the UI will automatically update when either the filter +or the todo-list changes. -이러한 방법으로 접근한 애플리케이션 샘플은 [Todo List -example](https://github.com/rrousselGit/riverpod/tree/master/examples/todos)에서 확인해 볼 수 있습니다. +To see this approach in action, you can look at the source code of the [Todo List +example](https://github.com/rrousselGit/riverpod/tree/master/examples/todos). :::info -이 행위는 [Provider]에 국한되지 않습니다. 그리고 모든 프로바이더에 적용하여 사용 가능합니다. - -예를 들어, 실시간적으로 값이 변하는 것을 지원하는 검색 기능을 구현하기 위해 [FutureProvider]와 함께 [watch]를 결합하여 사용할 수 있습니다. +This behavior is not specific to [Provider], and works with all providers. For example, you could combine [watch] with [FutureProvider] to implement a search feature that supports live-configuration changes: -```dart -// 현재 검색 필터 값 입니다. ('') -final searchProvider = StateProvider((ref) => ''); - -/// 매 시간마다 변경될 수 있는 구성(Configurations) -final configsProvider = StreamProvider(...); - -final charactersProvider = FutureProvider>((ref) async { - final search = ref.watch(searchProvider); - final configs = await ref.watch(configsProvider.future); - final response = await dio.get('${configs.host}/characters?search=$search'); - - return response.data.map((json) => Character.fromJson(json)).toList(); -}); -``` - -이 코드는 `characters` 목록을 서비스로 부터 가져옵니다. 그리고 구성(configurations)이 변하거나 검색 쿼리가 변경되면 -자동적으로 다시 `characters` 목록을 가져옵니다. + +This code will fetch a list of characters from the service, and automatically +re-fetch the list whenever the configurations change or when the search query changes. ::: -### 구독없이 프로바이더를 읽을 수 있나요? +### Can I read a provider without listening to it? -때때로 우린 값이 변경되어도 다시 생성되는 작업 없이 프로바이더의 컨텐츠를 읽기 원합니다. Sometimes, we want to read the content of a provider, but without re-creating the value exposed when the value obtained changes. -예를 들어 인증을 위한 사용자 토큰을 다른 프로바이더로 부터 읽어오는 `Repository` 프로바이더가 있다고 생각해 봅시다. -여기서 우리는 [watch]를 사용하고 사용자 토큰이 변경될 때마다 새로운 `Repository`를 생성할 수 있지만 그렇게 하는 것은 거의 소용이 없습니다. - -이 경우에는, [watch]와 유사한 기능을 가지는 [read]를 사용할 수 있습니다. -그러나, 상태 값이 변경될 때 프로바이더가 노출하는 값을 다시 생성하지 않습니다. +An example would be a `Repository`, which reads from another provider the user token +for authentication. +We could use [watch] and create a new `Repository` whenever the user token changes, +but there is little to no use in doing that. -이 경우 일반적으로 생성된 객체에 'ref.read'를 전달합니다. -생성된 객체는 원할 때마다 프로바이더를 읽을 수 있습니다. +In this situation, we can use [read], which is similar to [watch], but will not +cause the provider to recreate the value it exposes when the value obtained changes. +In that case, a common practice is to pass the provider's `Ref` to the object created. +The object created will then be able to read providers whenever it wants. ```dart final userTokenProvider = StateProvider((ref) => null); -final repositoryProvider = Provider((ref) => Repository(ref.read)); +final repositoryProvider = Provider(Repository.new); class Repository { - Repository(this.read); + Repository(this.ref); - /// `ref.read` 함수입니다. - final Reader read; + final Ref ref; Future fetchCatalog() async { - String token = read(userTokenProvider); + String token = ref.read(userTokenProvider); final response = await dio.get('/path', queryParameters: { 'token': token, @@ -163,50 +141,24 @@ class Repository { } ``` -:::note +:::danger **DON'T** call [read] inside the body of a provider -`ref.read`대신에 `ref` 를 객체에 전달해서 사용하도록 합니다. - -```dart -final repositoryProvider = Provider((ref) => Repository(ref)); - -class Repository { - Repository(this.ref); - - final Ref ref; -} -``` - -그러나 `ref.read`를 전달하면 코드가 약간 덜 장황해지고 객체가 `ref.watch`를 사용하지 않을 것입니다. -다시 말해, `ref`대신 `ref.read`를 전달하면 `ref.watch`는 사용할 수 없다는 말과 동일합니다. - -::: - -:::위험 **DON'T** : [read]를 프로바이더 내부에서 호출하지 마세요. - -```dart -final myProvider = Provider((ref) { - // 여기서 'read'를 호출하는 것은 좋지 않습니다. - final value = ref.read(anotherProvider); -}); -``` - -만약 객체의 원치 않는 재빌드을 방지하기 위해 [read]를 사용한 경우, -[프로바이더 갱신이 너무 자주일어나는데 어떻게 개선하면 좋을까요?](#프로바이더-갱신이-너무-자주일어나는데-어떻게-개선하면-좋을까요) -항목을 참고해 주세요. + +If you used [read] as an attempt to avoid unwanted rebuilds of your object, +refer to [My provider updates too often, what can I do?](#my-provider-updates-too-often-what-can-i-do) ::: -### 생성자의 매개변수로 [read]를 전달 받는 객체는 어떻게 테스트 하면 좋은가요? +### How to test an object that receives [ref] as a parameter of its constructor? -만약 [구독없이 프로바이더를 읽을 수 있나요?](#구독없이-프로바이더를-읽을-수-있나요)에서 사용한 패턴을 사용한다면, -어떻게 객체를 테스트할지 의문이 들 수 있습니다. +If you are using the pattern described in [Can I read a provider without listening to it?](#can-i-read-a-provider-without-listening-to-it), +you may be wondering how to write tests for your object. -이 시나리오에서는 raw 객체 대신에 프로바이더를 직접 테스트 하는 것이 좋습니다. -[ProviderContainer] 클래스를 사용하여 테스트를 진행할 수 있습니다. +In this scenario, consider testing the provider directly instead of the raw object. +You can do so by using the [ProviderContainer] class: ```dart -final repositoryProvider = Provider((ref) => Repository(ref.read)); +final repositoryProvider = Provider((ref) => Repository(ref)); test('fetches catalog', () async { final container = ProviderContainer(); @@ -221,57 +173,38 @@ test('fetches catalog', () async { }); ``` -### 프로바이더 갱신이 너무 자주일어나는데 어떻게 개선하면 좋을까요? - - -객체가 너무 자주 다시 생성되는 경우 프로바이더가 갱신에 무관계한 요소를 수신하고 있는 것입니다. - -에들 들어, `Configuration` 객체 뿐만 아니라 `host` 속성을 구독하고 있다고 있다고 가정해 봅시다. -`host`의 속성만 변경되었지만 본래 필요없는 값까지 모두 재평가(계산)하여 전반적인 프로바이더의 갱신을 가져올 것 입니다. - -해결 방법으로는 분리된 프로바이더를 만드는 것입니다. 즉, 프로바이더를 속성별로 분리하는 것입니다. -다시 말해, `Configuration`(즉 `host`)에서 필요한 것만 노출하는 별도의 프로바이더를 만드는 것입니다. - - -**AVOID** 객체 전반적인 관찰: +### My provider updates too often, what can I do? -```dart -final configsProvider = StreamProvider(...); +If your object is re-created too often your provider is likely listening +to objects that it doesn't care about. -final productsProvider = FutureProvider>((ref) async { - // 어떤 구성이 변경되었다고 한다면 productsProvider는 products를 다시 가져옵니다. - final configs = await ref.watch(configsProvider.future); +For example, you may be listening to a `Configuration` object, but only use the `host` +property. +By listening to the entire `Configuration` object, if a property other than `host` +changes, this still causes your provider to be re-evaluated – which may be +undesired. - return dio.get('${configs.host}/products'); -}); -``` +The solution to this problem is to create a separate provider that exposes _only_ +what you need in `Configuration` (so `host`): -**PREFER** 실제 사용하는 속성만 관찰: +**AVOID** listening to the entire object: -```dart -final configsProvider = StreamProvider(...); + -/// 현재 host값만 노출하는 프로바이더 -final _hostProvider = FutureProvider((ref) async { - final config = await ref.watch(configsProvider.future); - return config.host; -}); +**PREFER** using select when you only need a single property of an object: -final productsProvider = FutureProvider>((ref) async { - /// 호스트(the host)만 구독. - /// 만약 구성들의 변화가 발생한다면, 무의미하게 재평가하지 않습니다. - final host = await ref.watch(_hostProvider.future); + - return dio.get('$host/products'); -}); -``` +This will only rebuild the `productsProvider` when the `host` changes. [provider]: ../providers/provider [stateprovider]: ../providers/state_provider [futureprovider]: ../providers/future_provider [statenotifierprovider]: ../providers/state_notifier_provider +[notifierProvider]: ../providers/notifier_provider [ref]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref-class.html [watch]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/watch.html [read]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/read.html [providercontainer.refresh]: https://pub.dev/documentation/riverpod/latest/riverpod/ProviderContainer/refresh.html [ref.refresh]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/WidgetRef/refresh.html +[providercontainer]: https://pub.dev/documentation/riverpod/latest/riverpod/ProviderContainer-class.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart new file mode 100644 index 000000000..4ee7792f9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart @@ -0,0 +1,58 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +// Have a counter that is being incremented by the FloatingActionButton +final counterProvider = StateProvider((ref) => 0); + +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // We want to show a dialog with the count on a button press + return Scaffold( + body: Column( + children: [ + ElevatedButton( + onPressed: () { + showDialog( + context: context, + builder: (c) { + // We wrap the dialog with a ProviderScope widget, providing the + // parent container to ensure the dialog can access the same providers + // that are accessible by the Home widget. + return ProviderScope( + parent: ProviderScope.containerOf(context), + child: const AlertDialog( + content: CounterDisplay(), + ), + ); + }, + ); + }, + child: const Text('Show Dialog'), + ), + ], + ), + floatingActionButton: FloatingActionButton( + child: const Icon(Icons.add), + onPressed: () { + ref.read(counterProvider.notifier).state++; + }, + )); + } +} + +class CounterDisplay extends ConsumerWidget { + const CounterDisplay({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final count = ref.watch(counterProvider); + return Text('$count'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.dart new file mode 100644 index 000000000..0977a8087 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.dart @@ -0,0 +1,21 @@ +// ignore_for_file: unnecessary_lambdas + +import 'dart:async'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Stream example(ExampleRef ref) { + final streamController = StreamController(); + + ref.onDispose(() { + // Closes the StreamController when the state of this provider is destroyed. + streamController.close(); + }); + + return streamController.stream; +} + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart new file mode 100644 index 000000000..29ee85fa1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'e2c4eb8a7cf06c7a0e5d07ee2bd51db254033fa6'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeStreamProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeStreamProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/raw.dart new file mode 100644 index 000000000..a9b5741d8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/raw.dart @@ -0,0 +1,17 @@ +// ignore_for_file: unnecessary_lambdas + +import 'dart:async'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +final example = StreamProvider.autoDispose((ref) { + final streamController = StreamController(); + + ref.onDispose(() { + // Closes the StreamController when the state of this provider is destroyed. + streamController.close(); + }); + + return streamController.stream; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx index 0eb1a7f8e..eaece8112 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx @@ -2,24 +2,27 @@ title: .autoDispose --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -통상적으로 프로바이더를 사용할때, 프로바이더를 더이상 사용하지 않는다면 -시스템 메모리상에서 해제(destroy)하고 싶은 경우가 있습니다. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -destroy하고 싶은 경우는 다양한 이유가 있지만 아래의 경우를 생각해볼 수 있습니다. +A common use case is to destroy the state of a provider +when it is no-longer used. -- 파이어베이스(Firebase)를 사용할떄 불필요한 코스트 발생을 피하기 위해 연결을 끊는 경우 -- 사용자가 화면상에서 떠나고 재진입했을때 상태를 초기화 해줘야 하는 경우 +There are multiple reasons for doing so, such as: -위의 경우등을 대응할 수 있도록 프로바이더는 빌트인으로 `.autoDispose` 수식어를 지원합니다. +- When using Firebase, to close the connection and avoid unnecessary cost. +- To reset the state when the user leaves a screen and re-enters it. -## 사용방법 +Providers come with built-in support for this use case, through the `.autoDispose` +modifier. -Riverpod에 더이상 사용하지 않는 프로바이더의 상태를 소멸(destroy)하기위해 -`.autoDispose` 수식어를 프로바이더에 붙이기만 하면 됩니다. +## Usage +To tell Riverpod to destroy the state of a provider when it is no longer used, +simply append `.autoDispose` to your provider: ```dart final userProvider = StreamProvider.autoDispose((ref) { @@ -27,14 +30,14 @@ final userProvider = StreamProvider.autoDispose((ref) { }); ``` -이것으로 `userProvider`가 더 이상 사용되지 않을때 자동으로 해제 작업을 처리합니다. +That's it. Now, the state of `userProvider` will automatically be destroyed +when it is no longer used. -제네릭 파라미터가 `autoDispose`전에 붙는게 아닌 `autoDispose`뒤에 붙는 것으로 -알 수 있듯이 `autoDispose`는 a named constructor가 아닙니다. +Note how the generic parameters are passed after `autoDispose` instead of before – +`autoDispose` is not a named constructor. :::note -`.autoDispose`와 다른 수식어를 결합할 수 있습니다. - +You can combine `.autoDispose` with other modifiers if you need to: ```dart final userProvider = StreamProvider.autoDispose.family((ref, id) { @@ -46,12 +49,13 @@ final userProvider = StreamProvider.autoDispose.family((ref, id) { ### ref.keepAlive -프로바이더에 `autoDispose` 수식어를 붙이면 `ref`객체에 `keepAlive` 메소드를 사용할 수 있습니다. +Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. -`keepAlive` 메소드를 실행하는 것으로, 프로바이더가 참조되지 않게 되었을 때에도 -상태를 유지하도록 Riverpod 에 전할 수가 있습니다. +The `keepAlive` function is used to tell Riverpod that the state of the provider +should be preserved even if no longer listened to. -좀 더 이해를 돕기위해서 HTTP 요청이 완료되면 플레그를 `true`로 설정하는 예시 코드입니다. +A use-case would be to set this flag to `true` after an HTTP request has +completed: ```dart final myProvider = FutureProvider.autoDispose((ref) async { @@ -61,67 +65,70 @@ final myProvider = FutureProvider.autoDispose((ref) async { }); ``` -위의 방식을 사용하면, 만약에 요청이 실패하고 사용자가 화면상에서 떠나고 다시 들어온 경우 -요청을 재 실행할 수 있도록 합니다. 그러나, 만약 요청이 성공적으로 처리된다면, 상태가 유지될 것입니다. -그리고 화면에 재 진입해도 새로운 요청을 위한 트리거링이 발생하지 않습니다. +This way, if the request fails and the user leaves the screen then re-enters +it, then the request will be performed again. +But if the request completed successfully, the state will be preserved +and re-entering the screen will not trigger a new request. +:::info +In version 1.0.x, the equivalent of `keepAlive` is the property called `maintainState`. +::: -## 사용예: 더 이상 프로바이더를 사용하지 않을 때, HTTP 요청 취소하기 +## Example: Canceling HTTP requests when no longer used -`autoDispose` 수식어는 [FutureProvider]와 `ref.onDispose`에 결합 할 수 있습니다. -프로바이더를 더 이상 사용하지 않을 때 쉽게 HTTP 요청을 취소할 수 있습니다. +The `autoDispose` modifier could be combined with [FutureProvider] and `ref.onDispose` +to easily cancel HTTP requests when they are no longer needed. -이번 예시의 목표는 다음과 같습니다. +The goal is: -- 사용자가 화면에 들어왔을 때 HTTP 요청을 시작합니다. -- 만약 요청이 완료되기 전에 사용자가 화면을 떠났다면, HTTP을 취소합니다. -- 만약 요청이 성공했다면, 화면을 떠나거나 재 진입했을때 새로운 요청을 시작하지 않습니다. +- Start an HTTP request when the user enters a screen +- if the user leaves the screen before the request completed, cancel the HTTP request +- if the request succeeded, leaving and re-entering the screen does not start a new request -코드로 구현해 본다면 아래와 같습니다. +In code, this would be: ```dart final myProvider = FutureProvider.autoDispose((ref) async { - // http 요청을 취소하기 위한 package:dio 객체 + // An object from package:dio that allows cancelling http requests final cancelToken = CancelToken(); - // 프로바이더가 해제(destroyed)될 때, http 요청을 취소합니다. + // When the provider is destroyed, cancel the http request ref.onDispose(() => cancelToken.cancel()); - // 데이터를 가져오고 취소하기 위한 `cancelToken`을 파라미터로 념겨줍니다. + // Fetch our data and pass our `cancelToken` for cancellation to work final response = await dio.get('path', cancelToken: cancelToken); - // 만약 요청이 성곡적으로 완료되었다면, 현재 상태를 유지합니다. + // If the request completed successfully, keep the state ref.keepAlive(); return response; }); ``` -## 'AutoDisposeProvider'인수 타입은 'AlwaysAliveProviderBase' 매개변수에 할당할 수 없습니다. +## The argument type 'AutoDisposeProvider' can't be assigned to the parameter type 'AlwaysAliveProviderBase' -`.autoDispose`를 사용할 때, 아래와 같은 에러가 발생하면서 컴파일이 되지 않는 경우를 -만나볼 수 있습니다. +When using `.autoDispose`, you may find yourself in a situation where your +application does not compile with an error similar to: > The argument type 'AutoDisposeProvider' can't be assigned to the parameter > type 'AlwaysAliveProviderBase' -걱정 하지 마세요! 이 에러는 자발적으로 발생하는 오류입니다. -버그가 발생할 가능성이 높기 때문에 발생하는 오류입니다. - -`.autoDispose`의 수식어를 붙이지 않은 프로바이더에서 `.autoDispose` 수식어를 사용한 -프로바이더를 사용할 경우 발생할 수 있습니다. +Don't worry! This error is voluntary. It happens because you most likely +have a bug: +You tried to listen to a provider marked with `.autoDispose` in a provider that +is **not** marked with `.autoDispose`, such as: ```dart final firstProvider = Provider.autoDispose((ref) => 0); final secondProvider = Provider((ref) { - // 'AutoDisposeProvider'인자 값을 - // 'AlwaysAliveProviderBase' 파라미터 타입으로 할당할 수 없습니다. + // The argument type 'AutoDisposeProvider' can't be assigned to the + // parameter type 'AlwaysAliveProviderBase' ref.watch(firstProvider); }); ``` -위의 코드의 경우 `firstProvider`가 절대 disposed 처리 않음으로 사용상 바람직하지 않습니다. +This is undesired, as it would cause `firstProvider` to never be disposed. -이를 수정하기 위해 `secondProvider`에 `.autoDispose`를 추가할 필요가 있습니다. +To fix this, consider marking `secondProvider` with `.autoDispose` too: ```dart final firstProvider = Provider.autoDispose((ref) => 0); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx index 483296ae4..1b6346231 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx @@ -4,47 +4,49 @@ title: .family import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; +import { Link } from "../../../../../../src/components/Link"; -본 문서를 읽기 전에 [프로바이더란](/docs/concepts/providers)와 [프로바이더 읽기](/docs/concepts/reading)문서를 -먼저 읽고 오면 좋습니다. - -여기서는 `.family` 수식어에 대해 상세하게 알아보도록 하겠습니다. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -`.family` 수식어(modifier)의 하나의 목적을 가집니다. -외부 값을 이용하여 프로바이더를 생성할때 사용합니다. +Before reading this, consider reading about and . +In this part, we will talk in detail about the `.family` provider modifier. -통상적인 `family` 사용예는 다음과 같습니다. +The `.family` modifier has one purpose: Getting a unique provider based on external parameters. Some common use-cases for `family` would be: -- [FutureProvider]를 `.family`와 결합하여 ID에서 `Message`를 가져오는 경우. -- 번역을 다루기 위해 현재 `Locale` 값을 프로바이더로 전달하는 경우. +- Combining [FutureProvider] with `.family` to fetch a `Message` from its ID +- Passing the current `Locale` to a provider, so that we can handle translations -## 사용방법 +## Usage -프로바이더에 `.family` 수식어를 결합하면 파라미터가 추가됩니다. -이 파라미터를 프로바이더가 어떠한 특정 상태를 생성하기 위해 사용됩니다. +The way families works is by adding an extra parameter to the provider. +This parameter can then be freely used in our provider to create some state. -예를 들어, `family` 수식어를 [FutureProvider]에 결합하여 `Message`의 ID를 통해 -`Message`를 가져오는 경우를 확인해 보겠습니다. (위의 1번 예시) +For example, we can combine `family` with [FutureProvider] to fetch +a `Message` from its ID: ```dart final messagesFamily = FutureProvider.family((ref, id) async { return dio.get('http://my_api.dev/messages/$id'); }); ``` -그리고 `messagesFamily` 프로바이더를 사용할때 사용 구문(the syntax)에는 다소 차이가 있습니다. -일반적인 구문은 컴파일 상에서 에러를 발생시킵니다. + +When using our `messagesFamily` provider, the syntax is slightly different. +The usual syntax will not work anymore: ```dart Widget build(BuildContext context, WidgetRef ref) { - // Error – messagesFamily is not a provider - // 에러 - messagesFamily는 프로바이더가 아닙니다. + // Error – messagesFamily is not a provider final response = ref.watch(messagesFamily); } ``` -아래와 같이, `messagesFamily`에 파라미터를 넘겨줄 필요가 있습니다. +Instead, we need to pass a parameter to `messagesFamily`: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -53,10 +55,9 @@ Widget build(BuildContext context, WidgetRef ref) { ``` :::info - - `family` 를 사용하는 프로바이더에 다른 파라미터를 동시에 전달하는 것도 가능합니다. - 예를 들어, `titleFamily` 프로바이더에 프랑스어(French)와 영어(English)의 값을 얻기 위해 - 동시에 각기 다른 Locale 변수를 파라미터로 전달하고 있는 것을 확인할 수 있습니다. +It is possible to use a family with different parameters simultaneously. +For example, we could use a `titleFamily` to read both the French and English +translations at the same time: ```dart @override @@ -70,24 +71,22 @@ Widget build(BuildContext context, WidgetRef ref) { ::: -## 파라미터 제한하기 +## Parameter restrictions -`family`를 정상적으로 올바르게 작동시키기 위해서는 전달하는 파라미터에 대한 -`hashCode` and `==`의 등가성이 정의되어야할 필요가 있습니다. +For families to work correctly, it is critical for the parameter passed to +a provider to have a consistent `hashCode` and `==`. -이상적으로, 매개변수는 primitive자료형(bool/int/double/String), 정수(providers) 또는 -`==` 와 `hashCode`를 오버라이드 할 수 았는 불변(immutable) 객체 이어야 합니다. +Ideally, the parameter should either be a primitive (bool/int/double/String), +a constant (providers), or an immutable object that overrides `==` and `hashCode`. -- primitive 자료형: 컴퓨터 프로그램을 만드는 데 사용되는 기초적인 언어 구성. +### _PREFER_ using `autoDispose` when the parameter is not constant: +You may want to use families to pass the input of a search field to your provider. +But that value can change often and never be reused. +This could cause memory leaks as, by default, a provider is never destroyed even +if no longer used. -### _PREFER_ 파라미터가 정수가 아닐때는 `autoDispose`를 사용하세요. - -`family`를 사용해서 검색창에 입력된 값을 프로바이더의 매개변수로 전달하고 싶을 때가 있습니다. -그러나, 값은 종종 변경될 수 있고 결코 그 값은 재사용되지 않습니다. -이것은 심지어 더 이상 사용되지 않을때, 기본적으로 프로바이더는 절대 해제되지 않기 떄문에 메모리 누수를 야기할 수 있습니다. - -`.family` 와 `.autoDispose`를 함께 사용함으로써 메모리 누수 문제를 개선할 수 있습니다. +Using both `.family` and `.autoDispose` fixes that memory leak: ```dart final characters = FutureProvider.autoDispose.family, String>((ref, filter) async { @@ -95,19 +94,20 @@ final characters = FutureProvider.autoDispose.family, String>((r }); ``` -## 복수의 파라미터 전달하기 +## Passing multiple parameters to a family -`family` 수식어는 프로바이더로 복수의 파라미터를 전달하는것이 불가능합니다. +Families have no built-in support for passing multiple values to a provider. -반면에, 앞에서 설명한 제한 사항을 충족하는 한 모든 객체를 전달할 수 있습니다. +On the other hand, that value could be _anything_ (as long as it matches with +the restrictions mentioned previously). -아래의 패키지들을 이용하면 가능합니다. +This includes: - A tuple from [tuple](http://pub.dev/packages/tuple) - Objects generated with [Freezed] or [built_value](https://pub.dev/packages/built_value) - Objects using [equatable](https://pub.dev/packages/equatable) -여기 [Freezed] 와 [equatable]를 사용한 예시가 있습니다. +Here's an example of using [Freezed] or [equatable] for multiple parameters: ((ref, myParameter) { print(myParameter.userId); print(myParameter.locale); - // userId/locale를 사용하여 무언가를 처리 + // Do something with userId/locale }); @override Widget build(BuildContext context, WidgetRef ref) { - int userId; // userId를 어디선가 읽어 옴. + int userId; // Read the user ID from somewhere final locale = Localizations.localeOf(context); final something = ref.watch( @@ -168,12 +168,12 @@ class MyParameter extends Equatable { final exampleProvider = Provider.family((ref, myParameter) { print(myParameter.userId); print(myParameter.locale); - // userId/locale를 사용하여 무언가를 처리 + // Do something with userId/locale }); @override Widget build(BuildContext context, WidgetRef ref) { - int userId; // userId를 어디선가 읽어 옴. + int userId; // Read the user ID from somewhere final locale = Localizations.localeOf(context); final something = ref.watch( @@ -183,6 +183,7 @@ Widget build(BuildContext context, WidgetRef ref) { ... } ``` + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_lifecycles.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_lifecycles.mdx new file mode 100644 index 000000000..971ae56ef --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_lifecycles.mdx @@ -0,0 +1,108 @@ +--- +title: Provider Lifecycles +--- + +import CodeBlock from "@theme/CodeBlock"; +import onDispose from "./lifecycle_on_dispose"; +import { trimSnippet, When, AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + +## When does my Provider get created and disposed? + +The states that all different types of providers can go through are the same: + +- Uninitialized +- Alive +- Paused +- Disposed + +### Disposed / Uninitialized + +An **Uninitialized** or **Disposed** provider does not take up any memory since its state is not initialized. +Essentially it is just a definition of how to create the provider's state when you need it. +It will stay that way until an **Alive** provider or a [WidgetRef] from the UI reads, watches, or listens to it. + +### Creating -> Alive + +When an **Uninitialized** provider is read, listened to or watched it's state will be created. + +During creation your provider's build function will be run. +Any providers that you read or watch using the `ref` exposed by the callback will be created as needed and their state will be retrieved. + +If there are any circular dependencies during this creation process Riverpod will throw an error. +The best way to fix this error is to redesign your dependencies to have a uni-directional dataflow. + +The provider's state is stored in a [ProviderContainer]. In a Flutter app this container is in a [ProviderScope] widget. + +As such, even though the definition of how to create the state (the provider) is global, the state is actually local, +and can be different in different portions of your UI using nested [ProviderScope] widgets and overrides. + +This is very similar to how flutter widgets work. You only pay for the definition once, but can reuse the state in different parts of the tree as needed. + +### Alive + +When your provider is **Alive**, changes to its state will cause dependent providers and/or the dependent UI to rebuild. + +From the other perspective, as a reactive framework, you can watch other providers to have the provider recreate itself whenever one of it's dependencies changes. + +If you need to have some long-lived state that depends on other state you can use Ref's [listen] method to subscribe for changes on another provider without causing a rebuild of the provider. + +If you need to use the state from another provider in a side-effect, you can use Ref's [read] method to obtain the current state from another provider. + +Typically when constructing a [StateNotifier] or [ChangeNotifier] class you should pass in the `ref` to allow the Notifier to obtain the current value of dependencies as needed. By using the new [Notifier] and [AsyncNotifier] classes from Riverpod 2.0, the ref is already available as an instance member of the class. + +### Alive -> Paused +When an **Alive** provider is no longer listened to by other providers or the UI, it goes into a **Paused** state. +This means that it no longer will react to changes on providers it is listening to. +This is an optimization, as if you are not listening to the provider, there is no need to keep it alive. +Every provider not being used will be returned to a **Paused** state, reducing the computational burden of your app. + +If you need to keep a provider alive for side-effects, make sure to listen to it in an appropriate place in the UI where it should be kept alive. + +If you need to perform some action when a provider is paused use the ref's [onCancel] method to register callbacks. + +If you need to perform some action when a provider resumes to an Alive state from a paused state, use the ref's [onResume] method to register callbacks. + +If you want the state to be disposed, so that in addition to taking no computational resources, it also disposes of the memory of the state, use the `.autoDispose` modifier on your provider definition. +This will cause it to transition to a **Disposed** state instead of **Paused** when it is no longer being used. + +### Alive -> Disposing + +There are a few reasons for a provider to be disposed. + +- When defined using the `.autoDispose` modifier and no longer being watched by the UI or another provider +- When the provider is being manually refreshed or invalidated +- When the provider is being recreated due to one of it's watched dependencies changing + +Refreshing causes the provider to immediately go through the creation process again, whereas invalidating causes the next read / watch of the provider to cause the provider to be rebuilt. + +## Performing actions before the state destruction +If you need to perform some action when a provider is disposed, use the ref's [onDispose] method to register callbacks. + +The following example uses onDispose to close a StreamController: + + + +:::note +Depending on the provider used, it may already take care of the clean-up process. +For example, [StateNotifierProvider] will call the `dispose` method of the returned [StateNotifier]. +::: + +[onDispose]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/onDispose.html +[listen]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/listen.html +[onCancel]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/onCancel.html +[onResume]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/onResume.html +[ProviderContainer]: https://pub.dev/documentation/riverpod/latest/riverpod/ProviderContainer-class.html +[Notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html +[AsyncNotifier]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifier-class.html +[ProviderScope]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ProviderScope-class.html +[WidgetRef]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/WidgetRef-class.html +[StateNotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html +[StateNotifierProvider]: https://pub.dev/documentation/riverpod/latest/riverpod/StateNotifierProvider-class.html +[StreamController]: https://api.dart.dev/stable/2.15.1/dart-async/StreamController-class.html +[ChangeNotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx index 2fbae4b78..a611d07d6 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx @@ -3,27 +3,32 @@ title: ProviderObserver --- import CodeBlock from "@theme/CodeBlock"; -import logger from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart"; +import logger from "!!raw-loader!/docs/concepts/provider_observer_logger.dart"; import { trimSnippet } from "../../../../../src/components/CodeSnippet"; -[ProviderObserver]는 ProviderContainer의 변화를 관찰합니다. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -[ProviderObserver]를 사용하기 위해서, 사용하고자 하는 클래스에 `ProviderObserver`를 상속하고 -메소드를 오버라이드(override)하여 사용할 수 있습니다. +[ProviderObserver] listens to the changes of a ProviderContainer. -[ProviderObserver]는 3개의 메소드를 가집니다. +To use it, extend the class ProviderObserver and override the method you want to use. -- `didAddProvider`: 프로바이더(provider)가 초기화 될때 마다 호출됩니다. 노출되는 값은 `값(value)`입니다. -- `didDisposeProvider`: 프로바이더(provider)가 `disposed`될 때마다 호출됩니다. -- `didUpdateProvider`: 프로바이더(provider)값이 변경(when they emit a notification)될 때 마다 호출됩니다. +[ProviderObserver] has three methods : -### 사용법: +- `didAddProvider` is called every time a provider was initialized, and the value exposed is `value`. +- `didDisposeProvider` is called every time a provider was disposed. +- `didUpdateProvider` is called every time by providers when they emit a notification. -[ProviderObserver]는 `didUpdateProvider`를 오버라이딩 하여 프로바이더들(providers)의 변화를 로깅할 수 있습니다. +### Usage : + +A simple use case for [ProviderObserver] is to log the changes in providers by overriding the `didUpdateProvider` method. {trimSnippet(logger)} -이제 프로바이더 상태 값이 갱신될때 마다 로거에 기록으로 출력될 것입니다. +Now, every time the value of our provider is updated, the logger will log it: ``` I/flutter (16783): { @@ -32,4 +37,13 @@ I/flutter (16783): "newValue": "1" I/flutter (16783): } ``` +:::note: +For states that are mutable such as [StateController] (the state of [StateProvider.state]) and +[ChangeNotifier] the previousValue and newValue will be the same +::: +since they reference the same `StateController` / `ChangeNotifier`. + [providerobserver]: https://pub.dev/documentation/riverpod/latest/riverpod/ProviderObserver-class.html +[statecontroller]: https://pub.dev/documentation/riverpod/latest/riverpod/StateController-class.html +[stateprovider.state]: https://pub.dev/documentation/riverpod/latest/riverpod/StateProvider/state.html +[changenotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index 1574317f9..40f8120e6 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -5,7 +5,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; /* SNIPPET START */ -// riverpod과 Logger를 사용한 카운터 앱 예제 +// A Counter example implemented with riverpod with Logger class Logger extends ProviderObserver { @override @@ -25,8 +25,8 @@ class Logger extends ProviderObserver { void main() { runApp( - // ProviderScope를 추가하여 프로젝트 전반적으로 Riverpod을 사용가능하도록 합니다. - // observers 리스트(목록)에 위에서 정의한 Logger 클래스를 추가합니다. + // Adding ProviderScope enables Riverpod for the entire project + // Adding our Logger to the list of observers ProviderScope(observers: [Logger()], child: const MyApp()), ); } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers.mdx index 066e4eed1..2bdf5467d 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers.mdx @@ -1,95 +1,99 @@ --- -title: 프로바이더란? +title: Providers --- -[Riverpod] 설치를 완료했다면 이제 "providers"(프로바이더)에 대해 알아보도록 하겠습니다. +import creatingProvider from "./providers/creating_a_provider"; +import declaringManyProviders from "./providers/declaring_many_providers"; +import { + AutoSnippet, +} from "../../../../../src/components/CodeSnippet"; +import { Link } from "../../../../../src/components/Link"; -프로바이더는 [Riverpod] 애플리케이션의 가장 중요한 파트 입니다. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -프로바이더는 하나의 상태조각의 압축(encapsulates)된 객체이자 -상태의 변화를 감시하는 역할을 가지고 있습니다. +Now that we have installed [Riverpod], let's talk about "providers". -## 왜 프로바이더를 사용하나요? +Providers are the most important part of a [Riverpod] application. +A provider is an object that encapsulates a piece of state and allows listening +to that state. -상태를 프로바이더로 감싸게 되면 아래의 서술된 내용들이 가능합니다. +## Why use providers? -- 코드상 다양한 위치에서 상태를 쉽게 접근할 수 있습니다. - 프로바이더는 Singletons, Service Locators, Dependency Injection 또는 InheritedWidgets - 과 같은 디자인 패턴들을 완벽하게 대체할 수 있습니다. +Wrapping a piece of state in a provider: -- 다른 프로바이더 상태와 간편하게 결합하여 사용할 수 있습니다. - 혹시 여러 객체들을 하나로 병합하는데 어려움을 격은적이 있나요? - 프로바이더를 사용하면 프로바이더의 간단한 문법을 사용하여 구현할 수 있습니다. +- Allows easily accessing that state in multiple locations. + Providers are a complete replacement for patterns like Singletons, + Service Locators, Dependency Injection or InheritedWidgets. -- 퍼포먼스 최적화가 가능합니다. - 위젯을 다시 빌드하는것을 필터링 하거나 비용이 높은 상태 계산을 캐싱하거나 - 프로바이더는 상태 변경의 영향을 받는 항목만 다시 계산합니다. +- Simplifies combining this state with others. + Ever struggled to merge multiple objects into one? This scenario is built + directly inside providers. -- 애플리케이션의 태스트 용이성이 높아집니다. - 프로바이더와 함께라면, 복잡한 `setUp`/`tearDown` 단계가 불필요 합니다. - 게다가 어떠한 프로바이더이든지 테스트 중의 프로바이더 행위를 오버라이드 할 수 있습니다. - 매우 특정한 행위(동작)을 테스트 하기 쉽습니다. +- Enables performance optimizations. + Whether for filtering widget rebuilds or for caching expensive state computations; + providers ensure that only what is impacted by a state change is recomputed. -- 고급 기능들과 함께 손 쉬운 통합이 가능합니다. 예를들어 로깅(logging) 또는 pull-to-refresh가 있습니다. +- Increases the testability of your application. + With providers, you do not need complex `setUp`/`tearDown` steps. Furthermore, + any provider can be overridden to behave differently during a test, which + allows easily testing a very specific behavior. -## 프로바이더 생성하기 +- Allows easy integration with advanced features, such as logging or + pull-to-refresh. -다양한 프로바이더들이 있지만, 기본적으로 모두 동일한 방식으로 동작합니다. +## Creating a provider -가장 보편적으로 사용하는 방법으로 전역 변수(global constants)로 선언하여 사용하는 방법이 있습니다. +Providers come in many variants, but they all work the same way. +The most common usage is to declare them as global constants like so: -```dart -final myProvider = Provider((ref) { - return MyValue(); -}); -``` + :::note -프로바이더를 글로벌하게 전역변수로 선언하여 사용하는것을 두려워하지 마세요. -프로바이더는 완전 immutable 특성을 가집니다. 프로바이더를 선언하는 것은 함수를 선언하는것과 -다르지 않습니다. 그리고 프로바이더들은 테스트할 수 있고 유지보수 할 수 있습니다. +Do not be frightened by the global aspect of providers. +Providers are fully immutable. Declaring a provider is no different from declaring +a function, and providers are testable and maintainable. ::: -위 코드 정보는 3개의 컴포넌트를 구성하고 있습니다. +This snippet consists of three components: -- `final myProvider`, 변수 선언입니다. - 이 변수는 항상 불변(immutable) 특성을 가질 것 입니다. - 그리고 추후 프로바이더의 상태를 읽기위해 사용하게 됩니다. +- `final myProvider`, the declaration of a variable. + This variable is what we will use in the future to read the state of our provider. + Providers should always be `final`. -- `Provider`, 우리가 코드에서 사용하기 위해 결정한 프로바이더 입니다. - [Provider]는 모든 프로바이더 종류들 중 가장 기본이 되는 친구입니다. 이 객체는 위에서 설명한 것 처럼 - 변하지 않는 불변의 특성을 가지게 됩니다. 우리는 여기서 어떻게 상태(값)과 상호 작용하는지에 따라서 - [Provider]를 다른 종류의 프로바이더로 바꿔 사용할 수 있습니다. - 예를 들어 [StreamProvider] 또는 [StateNotifierProvider] 가 있습니다. +- `Provider`, the provider that we decided to use. + [Provider] is the most basic of all providers. It exposes an object that never + changes. + We could replace [Provider] with other providers like [StreamProvider] or + [NotifierProvider], to change how the value is interacted with. -- 공유 상태를 생성하는 함수입니다. - 이 함수는 `ref` 객체를 파라미터로 받습니다. 이 객체는 다른 프로바이더들을 읽기 위해서 사용하거나 - 프로바이더의 상태가 소멸될 때 일부 작업을 수행할 수 있도록 합니다. +- A function that creates the shared state. + That function will always receive an object called `ref` as a parameter. This object + allows us to read other providers, perform some operations when the state + of our provider will be destroyed, and much more. -프로바이더 내부에서 생성되는 객체의 형태는 사용하는 프로바이더의 종류에 따라 다르게 생성됩니다. -예를 들어 [Provider]의 함수는 어떤 객체든 생성가능합니다. 반면에 [StreamProvider]는 [Stream] 객체를 -생성할 필요가 있습니다. 여기서 생성이라고 함은 [StreamProvider]에서 [Stream]을 반환해야합니다. +The type of the object returned by the function passed to a provider depends on +the provider used. +For example, the function of a [Provider] can create any object. +On the other hand, [StreamProvider]'s callback will be expected to return a [Stream]. :::info -어떠한 제한 없이 원하는데로 수 많은 종류의 프로바이더들을 선언할 수 있습니다. -`package:provider`를 사용할때와 반대로, [Riverpod]에서는 같은 "type"의 상태를 노출하는 -2개의 프로바이더를 가지게 됩니다. +You can declare as many providers as you want without limitations. +As opposed to when using `package:provider`, [Riverpod] allows creating multiple +providers exposing a state of the same "type": + -```dart -final cityProvider = Provider((ref) => 'London'); -final countryProvider = Provider((ref) => 'England'); -``` - -사실 위의 예에서는 2개의 프로바이더가 `String` 값을 생성하는 것은 -어떠한 문제의 원인이 되지 않습니다. -(역자: '2개의 프로바이더가 `String`값을 생성하는데 문제될 것이 없다'라는 의미로 -받아들이면 좋겠습니다.) +The fact that both providers create a `String` does not cause any problem. ::: :::caution -프로바이더가 동작하기 위해서 [ProviderScope]를 Flutter 앱의 가장 최상위(root) 부모 위젯으로 감싸줘야 합니다. +For providers to work, you must add [ProviderScope] at the root of your +Flutter applications: ```dart void main() { @@ -99,52 +103,52 @@ void main() { ::: -## 상태가 소멸되기 전에 액션 취하기 +## Different Types of Providers -일부 케이스에서, 프로바이더의 상태는 소멸(파괴)되거나 재 생성될 수 있습니다. -통상적인 경우 이러한 상황들은 프로바이더 소멸 상태 전에 초기화를 진행하는 경우 입니다. -예를 들어 `StreamController`를 닫아주는 경우가 있습니다. +There are multiple types of providers for multiple different use cases. -이것은 프로바이더 내부에서 사용하는 `ref` 객체의 [onDispose] 메소드를 사용할 수 있습니다. +With all of these providers available, it is sometimes difficult to understand when to use one provider type over another. +Use the table below to choose a provider that fits what you want to provide to the widget tree. -다음 사용예시에서 [onDispose]를 사용하여 `StreamController`를 닫는 과정을 알아봅시다. +| Provider Type | Provider Create Function | Example Use Case | +| ------------------------ | ------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| [Provider] | Returns any type | A service class / computed property (filtered list) | +| [StateProvider] | Returns any type | A filter condition / simple state object | +| [FutureProvider] | Returns a Future of any type | A result from an API call | +| [StreamProvider] | Returns a Stream of any type | A stream of results from an API | +| [NotifierProvider] | Returns a subclass of (Async)Notifier | A complex state object that is immutable except through an interface | +| [StateNotifierProvider] | Returns a subclass of StateNotifier | A complex state object that is immutable except through an interface. Prefer using a notifierProvider | +| [ChangeNotifierProvider] | Returns a subclass of ChangeNotifier | A complex state object that requires mutability | +:::caution +While all providers have their purpose, [ChangeNotifierProvider]s are not recommended for scalable applications. See . It exists in the +`flutter_riverpod` package to provide an easy migration path from +`package:provider`, and allows for some flutter specific use-cases such as +integration with some Navigator 2 packages. ::: -```dart -final example = StreamProvider.autoDispose((ref) { - final streamController = StreamController(); - - ref.onDispose(() { - // 프로바이더의 상태가 소멸되기 전 StreamController를 닫습니다(close). - streamController.close(); - }); +## Provider Modifiers - return streamController.stream; -}); -``` +All Providers have a built-in way to add extra functionalities to your different providers. -:::note -사용하는 프로바이더에 따라서, 이러한 리소스 해제 처리 작업을 내부에서 자동으로 진행하는 경우도 있습니다. -예를 들어 [StateNotifierProvider]는 `StateNotifier`의 `dispose`메소드를 호출합니다. -::: - -## 프로바이더 수식자(Modifiers) - -모든 프로바이더들은 다른 프로바이더와 추가적인 기능을 추가하기 위한 방법이 기본적으로 내장되어 있습니다. -`ref` object에 새로운 특징을 추가하거나 프로바이더가 어떻게 상태를 소모(사용)하는지를 변경할 수 있습니다. -Modifiers는 모든 프로바이더에서 사용할 수 있습니다. 이는 named constructor(생성자) 문법과 유사합니다. +They may add new features to the `ref` object or change slightly how the provider +is consumed. +Modifiers can be used on all providers, with a syntax similar to named constructor: ```dart final myAutoDisposeProvider = StateProvider.autoDispose((ref) => 0); final myFamilyProvider = Provider.family((ref, id) => '$id'); ``` -지금은 2개의 사용가능한 수식어가 있습니다. -- [`.autoDispose`](/docs/concepts/modifiers/auto_dispose) 는 더 이상 상태를 구독하지 않을때 자동으로 프로바이터를 소멸되도록 합니다. -- [`.family`](/docs/concepts/modifiers/family) 외부 파라미터로부터 프로바이더를 생성할 때 사용합니다. +At the moment, there are two modifiers available: + +- , which will make the + provider automatically destroy its state when it is no longer being listened + to. +- , which allows creating a + provider from external parameters. :::note -프로바이더는 복수의 수식어(modifiers)를 한번에 사용할 수 있습니다. +A provider can use multiple modifiers at once: ```dart final userProvider = FutureProvider.autoDispose.family((ref, userId) async { @@ -154,11 +158,10 @@ final userProvider = FutureProvider.autoDispose.family((ref, userId) ::: -프로바이더에 대한 설명은 여기까지 입니다! - -[프로바이더 읽기](/docs/concepts/reading) 문서에서 계속됩니다. -또는 [프로바이더 결합하기](/docs/concepts/combining_providers)문서도 확인할 수 있습니다. +That's it for this guide! +You can continue with . +Alternatively, you can see . [get_it]: http://pub.dev/packages/get_it [inheritedwidget]: https://api.flutter.dev/flutter/widgets/InheritedWidget-class.html @@ -168,7 +171,11 @@ final userProvider = FutureProvider.autoDispose.family((ref, userId) [hooks_riverpod]: https://pub.dev/packages/hooks_riverpod [flutter_riverpod]: https://pub.dev/packages/flutter_riverpod [flutter_hooks]: https://github.com/rrousselGit/flutter_hooks -[provider]: ../providers/provider -[streamprovider]: ../providers/stream_provider -[statenotifierprovider]: ../providers/state_notifier_provider +[provider]: /docs/providers/provider +[streamprovider]: /docs/providers/stream_provider +[futureprovider]: /docs/providers/future_provider +[stateprovider]: /docs/providers/state_provider +[statenotifierprovider]: /docs/providers/state_notifier_provider +[notifierProvider]: /docs/providers/notifier_provider +[changenotifierprovider]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ChangeNotifierProvider-class.html [providerscope]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ProviderScope-class.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart new file mode 100644 index 000000000..8dc6c5e12 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart @@ -0,0 +1,12 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class MyValue {} + +/* SNIPPET START */ + +@riverpod +MyValue my(MyRef ref) { + return MyValue(); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart new file mode 100644 index 000000000..71bf0484e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myHash() => r'0810ee24cae78c131d00773ac20d254c83eefab7'; + +/// See also [my]. +@ProviderFor(my) +final myProvider = AutoDisposeProvider.internal( + my, + name: r'myProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef MyRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart new file mode 100644 index 000000000..d63faf94b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart @@ -0,0 +1,9 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class MyValue {} + +/* SNIPPET START */ + +final myProvider = Provider((ref) { + return MyValue(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart new file mode 100644 index 000000000..a9472e02a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart @@ -0,0 +1,11 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +String city(CityRef ref) => 'London'; +@riverpod +String country(CountryRef ref) => 'England'; + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart new file mode 100644 index 000000000..84913df77 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +/// See also [city]. +@ProviderFor(city) +final cityProvider = AutoDisposeProvider.internal( + city, + name: r'cityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$cityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CityRef = AutoDisposeProviderRef; +String _$countryHash() => r'd1513349c3bc0c99763cb4fb29eb012f2351bc4c'; + +/// See also [country]. +@ProviderFor(country) +final countryProvider = AutoDisposeProvider.internal( + country, + name: r'countryProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$countryHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CountryRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart new file mode 100644 index 000000000..60a3d4786 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart @@ -0,0 +1,6 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +final cityProvider = Provider((ref) => 'London'); +final countryProvider = Provider((ref) => 'England'); \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading.mdx index ce68a31a4..78345456a 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading.mdx @@ -1,245 +1,267 @@ --- -title: 프로바이더 읽기 +title: Reading a Provider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import counter from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart"; -import consumerWidget from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart"; -import consumerStatefulWidget from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart"; -import consumerHookWidget from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart"; -import consumerHook from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart"; -import watch from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart"; -import watchBuild from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart"; -import listen from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart"; -import listenBuild from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart"; -import read from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart"; -import readBuild from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart"; -import readNotifierBuild from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart"; -import watchNotifierBuild from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import counter from "./reading/counter"; +import consumerWidget from "./reading/consumer_widget"; +import consumerStatefulWidget from "./reading/consumer_stateful_widget"; +import consumerHook from "!!raw-loader!/docs/concepts/reading/consumer_hook.dart"; +import watch from "./reading/watch"; +import watchBuild from "./reading/watch_build"; +import listen from "./reading/listen"; +import listenBuild from "./reading/listen_build"; +import read from "./reading/read"; +import readBuild from "./reading/read_build"; +import readNotifierBuild from "./reading/read_notifier_build"; +import watchNotifierBuild from "./reading/watch_notifier_build"; +import provider from "./reading/provider"; +import { + trimSnippet, + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; +import { Link } from "../../../../../src/components/Link"; -본 가이드를 읽기전에 [프로바이더란](/docs/concepts/providers)에 대해서 먼저 알아보는 것을 추천합니다. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -이 가이드 문서는 프로바이더를 어떻게 사용/소비(consume)하는지에 대해 알아봅니다. +Before reading this guide, make sure to first. -## "ref" 객체 얻기 +In this guide, we will see how to consume a provider. -프로바이더를 읽기전 맨 처음 "ref" 라는 객체를 얻을 필요가 있습니다. +## Obtaining a "ref" object -이 객체('ref')는 프로바이더간 상호작용을 도와주고 위젯이나 다른 프로바이더에서 얻을 수 있습니다. +First and foremost, before reading a provider, we need to obtain a "ref" object. -### 프로바이더로 부터 "ref" 객체 얻기 +This object is what allows us to interact with providers, be it from a widget +or another provider. -모든 프로바이더들은 "ref"객체를 파라미터로서 받게 됩니다. +### Obtaining a "ref" from a provider -```dart -final provider = Provider((ref) { - // 다른 프로바이더 객체를 얻기위해 ref를 사용합니다. - // 여기서 repositoryProvider 프로바이더를 Provider 에서 읽는 것을 확인합니다. - final repository = ref.watch(repositoryProvider); +All providers receive a "ref" as a parameter: - return SomeValue(repository); -}) -``` + + +This parameter is safe to pass to the value exposed by the provider. + + + +A common use-case is to pass the provider's "ref" to a `StateNotifier` -이 매개변수는 프로바이더가 노출한 값으로 전달하는 것이 안전합니다. + -예를 들어, 통상적으로 프로바이더의 "ref"를 [StateNotifier]로 전달합니다. + -{trimSnippet(counter)} +Doing so allows our `Counter` class to read providers. -[StateNotifier]를 상속 받은 `Counter` 클래스는 `ref` 객체를 통해 -다른 프로바이더를 사용하거나 읽을 수 있게 되었습니다. +### Obtaining a "ref" from a widget -### 위젯에서 "ref" 객체 얻기 +Widgets naturally do not have a ref parameter. But [Riverpod] offers multiple +solutions to obtain one from widgets. -위젯들(Widgets)은 "ref" 파라미터를 가지고 있지 않습니다. -그러나, [Riverpod]에서는 위젯에서 "ref" 객체를 얻기위한 다양한 솔루션을 제공합니다. + -#### StatelessWidget 대신 ConsumerWidget으로 상속받기 +#### Extending ConsumerWidget instead of StatelessWidget -가장 일반적인 해결방법은 [StatelessWidget]를 [ConsumerWidget]의로 바꿔서 위젯을 생성하는 것입니다. -(여기서 말하고자하는 해결방법이란 위에서 언급한 위젯에서 "ref" 객체를 얻는 방법입니다.) +The most common way to obtain a ref in the widget tree is +to replace [StatelessWidget] with [ConsumerWidget]. -[ConsumerWidget]은 [StatelessWidget]와 기본적으로 동일합니다. -차이점은 build 메소드에서 추가적으로 "ref" 객체를 받는 것입니다. +[ConsumerWidget] is identical in use to [StatelessWidget], with the only +difference being that it has an extra parameter on its build method: the "ref" object. -전형적인 [ConsumerWidget] 사용방법은 아래 예시 코드와 같습니다. +A typical [ConsumerWidget] looks like: -{trimSnippet(consumerWidget)} + -#### StatefulWidget+State 대신에 ConsumerStatefulWidget+ConsumerState 상속받기 +#### Extending ConsumerStatefulWidget+ConsumerState instead of StatefulWidget+State -[ConsumerWidget]과 유사하게, [ConsumerStatefulWidget]과 [ConsumerState]는 [StatefulWidget]과 [State]와 동일합니다. -차이점은 "ref" 객체를 상태로 가진다는 점 입니다. +Similar to [ConsumerWidget], [ConsumerStatefulWidget] and [ConsumerState] are the equivalent of a +[StatefulWidget] with its [State], with the difference that the state has a "ref" object. -이번에는 "ref"객체는 build 메소드의 파라미터로서 전달되지 않습니다. -"ref" 객체는 [ConsumerState]객체의 속성이 됩니다. +This time, the "ref" isn't passed as parameter of the build method, but is +a property of the [ConsumerState] object: -아래의 예시 코드를 확인해 봅시다. + -{trimSnippet(consumerStatefulWidget)} + -#### HookWidget 대신 HookConsumerWidget 상속받기 + -이 방법은 [flutter_hooks]를 사용하는 사용자에게 한정됩니다. -[flutter_hooks]은 [HookWidget]을 상속받는게 필요하기 때문에 hooks을 사용하기위해 위젯에서 -[ConsumerWidget]을 상속하는것은 불가능합니다. +#### Extending HookConsumerWidget instead of HookWidget -하나의 해결 방안으로 [hooks_riverpod] 패키지를 사용하면 됩니다. -이 패키지는 [HookWidget]를 [HookConsumerWidget]으로 대체할 수 있는 해결방안을 제공합니다. +This option is for [flutter_hooks] users. Since [flutter_hooks] requires +extending [HookWidget] to work, widgets that use hooks are unable to extend +[ConsumerWidget]. -[HookConsumerWidget]은 [ConsumerWidget]과 [HookWidget]의 기능을 포함하고 있습니다. -즉, 프로바이더를 구독하는것과 hooks을 사용하는 것이 모두 가능합니다. +The package [hooks_riverpod] exposes a new widget called [HookConsumerWidget]. +[HookConsumerWidget] acts as both a [ConsumerWidget] and a [HookWidget]. This +allows a widget to both listen to providers and use hooks. -예제를 확인해 봅시다. +An example would be: -{trimSnippet(consumerHookWidget)} + -#### Consumer 와 HookConsumer 위젯 +#### Extending StatefulHookConsumerWidget instead of HookWidget -위젯(widgets)안에서 "ref" 객체를 얻기 위한 마지막 방안으로 -[Consumer]/[HookConsumer] 위젯을 사용하는 것이 있습니다. +This option is for [flutter_hooks] users, who need to use [StatefulWidget] lifecycle methods in addition to hooks. -이 클래스들은([Consumer]/[HookConsumer]) "ref"를 얻기위해 사용하는 위젯들입니다. -[ConsumerWidget]/[HookConsumerWidget]로서 동일한 속성을 가집니다. +An example would be: -이 위젯들은 "ref"를 얻기위해 별도의 class를 정의할 필요가 없습니다. -아래의 예시 코드를 통해 확인해 봅시다. + + +#### Consumer and HookConsumer widgets + +A final way to obtain a "ref" inside widgets is to rely on [Consumer]/ +[HookConsumer]. + +These classes are widgets that can be used to obtain a "ref" in a builder callback, with the same +properties as [ConsumerWidget]/[HookConsumerWidget]. + +As such, these widgets are a way to obtain a "ref" without having to define a class. +An example would be: {trimSnippet(consumerHook)} -## `ref`를 사용해서 프로바이더와 상호작용하기 + -이제 "ref" 겍체와 사용방법에 대해 알아봅시다. -"ref"는 3개지 주요한 용도가 있습니다. +## Using ref to interact with providers -- `ref.watch` = 프로바이더의 값을 취득하고 변화를 구독합니다. 값의 변경이 발생하면, - 위젯(widget)을 다시 빌드하거나 값을 구독(subscribed)하고 있는 위치에 상태 값을 전달 및 제공합니다. +Now that we have a "ref", we can start using it. -- `ref.listen` = 프로바이더의 상태 값을 구독하거나 상태값이 변했을때 어떠한 행위를 취해야할 경우 사용합니다. +There are three primary usages for "ref": -- `ref.read` = 프로바이더의 상태값을 취득합니다. 이벤트 콜백함수에 사용하기 유용한데 예를들어 버튼의 `onPressed` - 콜백 함수에서 프로바이더의 필요한 상태값을 얻기위해서 사용할 수 있습니다. +- obtaining the value of a provider and listening to changes, such that when + this value changes, this will rebuild the widget or provider that subscribed + to the value. + This is done using `ref.watch` +- adding a listener on a provider, to execute an action such as navigating to a new + page or showing a modal whenever that provider changes. + This is done using `ref.listen`. +- obtaining the value of a provider while ignoring changes. + This is useful when we need the value of a provider in an event + such as "on click". + This is done using `ref.read`. :::note -기능을 구현할때는 가급적 `ref.read` 또는 `ref.listen` 보다 `ref.watch` 사용을 권장합니다. - -`ref.watch`을 사용하게되면 reactive(리엑티브)와 declarative(선언형)에 가까워 지고 -애플리케이션을 더 유지보수 하기 편리하게 만들어 줍니다. +Whenever possible, prefer using `ref.watch` over `ref.read` or `ref.listen` to +implement a feature. +By relying on `ref.watch`, your application becomes both reactive +and declarative, which makes it more maintainable. ::: -### `ref.watch`를 사용해서 프로바이더 관찰하기 - -위젯의 `build` 메소드 내부 또는 프로바이더 내부에서 `ref.watch`를 사용함으로서 -프로바이더의 상태 값을 구독(listen)할 수 있습니다. +### Using ref.watch to observe a provider -예를 들어, 프로바이더에서 `ref.watch`를 사용하여 복수의 프로바이더와 결합해 새로운 값을 -생성 할 수도 있습니다. +`ref.watch` is used inside the `build` method of a widget or +inside the body of a provider to have the widget/provider listen to a provider: -할일 목록(a todo-list)에서 필터링하는 방법의 한가지 예시 입니다. -여기서 2개의 프로바이더를 사용했습니다. +For example, a provider could use `ref.watch` to combine multiple providers +into a new value. An example would be filtering a todo-list. - We could have two providers: -- `filterTypeProvider`: 현재 설정한 필터타입(none, show only completed tasks, ...)에대한 상태를 나타내는 프로바이더입니다. - -- `todosProvider`: 할일(tasks)에 대한 목록 전체 값을 가지는 프로바이더 입니다. +- `filterTypeProvider`, a provider that exposes the current type of filter + (none, show only completed tasks, ...) +- `todosProvider`, a provider that exposes the entire list of tasks -그리고 `ref.watch`를 사용하여 두개의 프로바이더를 결합해 필터링된 작업 목록 생성하는 세 번째 프로바이더를 만들 수 있습니다. +And by using `ref.watch`, we could make a third provider that combines both providers to +create a filtered list of tasks: -{trimSnippet(watch)} + -위의 코드에서 확인할 수 있듯이 `filteredTodoListProvider` 프로바이더는 필터링된 할일 목록을 가집니다. +With this code, `filteredTodoListProvider` now exposes the filtered list of tasks. -필터링된 목록은 할일 목록이 변경되거나 필터 상태값이 변경되면 자동적으로 갱신될 것 입니다. -그러나, 필터 상태가 동일하거나 할일 목록이 동일하다면 다시 계산되거나 갱신되지 않습니다. +The filtered list will also automatically update if either the filter or the list of tasks +changed. At the same time, the filtered list will not be recomputed if +neither the filter nor the list of tasks changed. -이와 유사하게 위젯에 `ref.watch`를 사용하는 경우 프로바이더상에 의존하는 사용자 인터페이스를 -표시할 수 있습니다. +Similarly, a widget can use `ref.watch` to show +the content from a provider and update the user interface whenever that content changes: -{trimSnippet(watchBuild)} + -이 예시코드는 카운터 상태값을 저장하고 있는 프로바이더를 구독하고 있는 위젯을 보여줍니다. -그리고 만약 카운터 값이 변경되면 위젯을 다시 빌드되고 UI에 새로 갠신된 값을 표기할 것 입니다. +This snippet shows a widget that listens to a provider which stores a `count`. +And if that `count` changes, the widget will rebuild and the UI will update +to show the new value. :::caution -`watch`메소드는 비동기처리(asynchronously)에 호출하지 마세요. -예를 들어 [ElevatedButton]의 `onPressed` 콜백 함수 안이나 `initState` 그리고 다른 [State]의 생명주기 안에서는 -`watch`메소드를 호출하면 안됩니다. +The `watch` method should not be called asynchronously, +like inside an `onPressed` of an [ElevatedButton]. Nor should it be used +inside `initState` and other [State] life-cycles. -이때는 `ref.watch`대신 `ref.read`메소드를 사용하는 것을 권장합니다. +In those cases, consider using `ref.read` instead. ::: -### `ref.listen`을 사용하여 프로바이더 변화에 대응하기 +### Using ref.listen to react to a provider change -`ref.watch`와 유사하게 프로바이더를 관찰하기 위해 `ref.listen`을 사용할 수 있습니다. -`ref.watch`와 `ref.listen`의 주요한 차이점은 `ref.watch`는 프로바이더 상태값이 변경이되면 widget/provider을 다시 빌드하지만 -`ref.listen`은 함수를 호출한다는 점입니다. 함수는 커스텀된 함수이며 사용자에 따라 다르게 정의해서 사용할 수 있습니다. +Similarly to `ref.watch`, it is possible to use `ref.listen` to observe a provider. -예를 들어 에러가 발생할때 스낵바(snackbar)를 표시하거나 어떠한 반응의 변화에 대응해야 할때 -유용하게 사용할 수 있습니다. +The main difference between them is that, rather than rebuilding the widget/provider +if the listened to provider changes, using `ref.listen` will instead call a custom function. -`ref.listen` 메소드는 2개의 위치인자(positional arguments)가 필요합니다. -첫번째는 프로바이더이고 두번쨰는 콜백함수 입니다. 콜백함수는 상태변화에 대응하여 수행할 함수 입니다. -콜백함수로 2개의 값이 전달됩니다. 하나는 이전 상태 값이고 나머지 하는 갱신된 상태 값입니다. +That can be useful for performing actions when a certain change happens, such +as showing a snackbar when an error happens. -`ref.listen` 메소드는 프로바이더 내부에서도 사용할 수 있습니다. -아래의 코드를 확인해 볼 수 있습니다. +The `ref.listen` method needs 2 positional arguments, the first one is the Provider and the second one is the callback function that we want to execute when the state changes. +The callback function when called will be passed 2 values, the value of the previous State and the value of the new State. -{trimSnippet(listen)} +The `ref.listen` method can be used inside the body of a provider: -또는 `build` 메소드 안에서 사용할 수 있습니다. + -{trimSnippet(listenBuild)} +or inside the `build` method of a widget: + + :::caution -[ElevatedButton]의 `onPressed` 콜백함수 내부, `initState` 내부 그리고 다른 상태주기의 [State]상에서와 같이 -`listen`메소드 또한 비동기(asynchronously)로 호출 가능한 곳에서는 사용을 피해야합니다. +The `listen` method should not be called asynchronously, +like inside an `onPressed` of an [ElevatedButton]. Nor should it be used +inside `initState` and other [State] life-cycles. ::: -### `ref.read`을 사용하여 프로바이더의 상태를 한번 취득하기 +### Using ref.read to obtain the state of a provider -`ref.read` 메소드는 어떠한 부가적인 효과 없이 프로바이더의 상태를 얻기위한 방법을 제공합니다. +The `ref.read` method is a way to obtain the state of a provider without listening to it. -`ref.read`는 일반적으로 사용자 상호작용으로 발생가능한 트리거 함수내부에서 주로 사용합니다. -예를들어 버튼을 눌렀을떄 카운터의 값이 증가시키고 싶을때 `ref.read`메소드를 사용할 수 있습니다. +It is commonly used inside functions triggered by user interactions. +For example, we can use `ref.read` to increment a counter when a user clicks a button: -{trimSnippet(read)} + :::note -가능한 `ref.read`사용을 피해주세요. +Using `ref.read` should be avoided as much as possible because it is not reactive. -`ref.read`메소드는 `watch` 또는 `listen`이 어려운곳에서 사용할 수 있는 대응책으로 사용하되, -가능한 `watch`/`listen`를 사용해주세요. 여기서 더 추천하는 메소드는 `watch` 메소드입니다. +It exists for cases where using `watch` or `listen` would cause issues. +If you can, it is almost always better to use `watch`/`listen`, especially `watch`. ::: -#### [**DONT'T**] `ref.read`를 `build` 메소드 안에서 **사용하지 마세요.** +#### **DON'T** use `ref.read` inside the build method -위젯의 성능 최적화를 위해 아래의 예시처럼 `ref.read`를 사용하고 있을 수 있습니다. +You might be tempted to use `ref.read` to optimize the performance of a widget +by doing: -{trimSnippet(readBuild)} + -그러나, 위의 예시는 나쁜 예시를 나타내고 있습니다. 그리고 이렇게 사용할 경우 -다루기 어려운 버그들을 유발수 있습니다. +But this is a very bad practice and can cause bugs that are difficult to track. -`ref.read`를 사용하기위해 이 방법은 일반적으로 다음과 같이 생각해서 발생할 수 있습니다. -"프로바이더의 상태값이 변경되지 않으니까 'ref.read'를 사용하는것이 안전하겠다." -그러나, 오늘은 비록 상태 값이 갱신되지 않더라도 내일 상태 값이 같을 것이라고 보장할 수 없기 때문입니다. +Using `ref.read` this way is commonly associated with the thought "The value +exposed by a provider never changes so using 'ref.read' is safe". The problem +with this assumption is that, while today that provider may indeed never update +its value, there is no guarantee that tomorrow will be the same. -소프트웨어는 수 없는 변화가 일어나는 경향이 있습니다. -그리고 미래에는 현재의 절대 바뀌지 않을 값이 변경될 가능성이 있습니다. -그러나, 만약 값의 변화가 시작될때, `ref.read`를 사용하게 되면 모든 `ref.read`메소드를 -전반적으로 `ref.watch`로 변경해야합니다. (이 작업에서 수많은 에러가 발생할 수 있고 특정 케이스에 -대한 변경 처리를 까먹을 수 도 있습니다.) +Software tends to change a lot, and it is likely that in the future, a value +that previously never changed will need to change. +If you use `ref.read`, when that value needs to change, you have +to go through your entire codebase to change `ref.read` into `ref.watch` – +which is error prone and you are likely to forget some cases. -반면 만약 `ref.watch` 를 사용하게되면 어떠한 문제도 걱정도 할 필요없을 것입니다. +If you use `ref.watch` to begin with, you will have fewer problems when refactoring. -**_그래도 난 위젯이 다시 빌드되는걸 줄이고 싶고 처음부터 `ref.read`를 사용하고 싶어!_** +**_But I wanted to use `ref.read` to reduce the number of times my widget rebuilds_** While the goal is commendable, it is important to note that you can achieve the exact same effect (reducing the number of builds) using `ref.watch` instead. @@ -247,53 +269,73 @@ exact same effect (reducing the number of builds) using `ref.watch` instead. Providers offer various ways to obtain a value while reducing the number of rebuilds, which you could use instead. -예를 들어 +For example instead of -{trimSnippet(readNotifierBuild)} + -위의 코드 대신에 아래의 예시코드처럼 사용하는게 좋습니다. +we could do: -{trimSnippet(watchNotifierBuild)} + -두 코드의 효과는 동일합니다. 카운트 숫자 값이 변경되어도 버튼 위젯은 다시 빌드되지 않을 것입니다. +Both snippets achieve the same effect: our button will not rebuild when the +counter increments. -반면, 후자의 접근 방법은 카운터 값이 초기화되어도 대응이 가능합니다. -예를 들어, 애플리케이션의 다른 파트에서 아래의 메소드가 호출되면 +On the other hand, the second approach supports cases where the counter is reset. +For example, another part of the application could call: ```dart ref.refresh(counterProvider); ``` -`ref.refresh`가 호출됨으로 `StateController` 객체를 재생성할 것입니다. + + +which would recreate the `StateController` object. + +If we used `ref.read` here, our button would still use the previous +`StateController` instance, which was disposed and should no-longer be used. +Whereas using `ref.watch` correctly rebuilds the button to use the new +`StateController`. + + + + + +which would recreate the `Counter` object. -만약, 여기서 `ref.read`를 사용한다면 버튼은 여전이 이전 상태의 `StateController`인스턴스를 사용할 것입니다(disposed되었거나 더이상 사용하지 않는). -`ref.watch`를 사용하면 새로운 `StateController`가 가능한 상태로 버튼이 재빌드 됩니다. +If we used `ref.read` here, our button would still use the previous `Counter` +instance, which was disposed and should no-longer be used. Whereas using +`ref.watch` correctly rebuilds the button to use the new `Counter`. -## 무엇을 읽을지 결정하기 + -사용하는 프로바이더에 따라서, 취득 가능한 값의 종류가 다양해 질 수 있습니다. -예를 들어 [StreamProvider]를 사용한다고 생각해 봅시다. +## Deciding what to read + +Depending on the provider you want to listen to, you may have multiple possible +values that you can listen to. + +As an example, consider the following [StreamProvider]: ```dart final userProvider = StreamProvider(...); ``` -`userProvider`를 읽으려고 할때 아래와 같이 사용할 수 있습니다. -- `userProvider`자체를 구독하는 것으로 동기된(synchronously) 현재 상태 값을 읽을 수 있습니다. +When reading this `userProvider`, you can: + +- synchronously read the current state by listening to `userProvider` itself: ```dart Widget build(BuildContext context, WidgetRef ref) { AsyncValue user = ref.watch(userProvider); - return user.when( - loading: () => const CircularProgressIndicator(), - error: (error, stack) => const Text('Oops'), - data: (user) => Text(user.name), - ); + return switch (user) { + AsyncData(:final value) => Text(value.name), + AsyncError(:final error) => const Text('Oops $error'), + _ => const CircularProgressIndicator(), + }; } ``` -- `userProvider.stream`을 사용하여 연결된 [Stream]을 얻을 수 있습니다. +- obtain the associated [Stream], by listening to `userProvider.stream`: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -301,7 +343,7 @@ final userProvider = StreamProvider(...); } ``` -- `userProvider.future`를 사용해 가장 최근 상태값을 가진 [Future]를 얻을 수 있습니다. +- obtain a [Future] that resolves with the latest value emitted, by listening to `userProvider.future`: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -309,21 +351,21 @@ final userProvider = StreamProvider(...); } ``` -다른 프로바이더들은 또 다른 대안 값들(alternative values)을 제공할 수 있습니다. -더 자세한 정보를 원한다면 [API reference](https://pub.dev/documentation/riverpod/latest/riverpod/riverpod-library.html) -에 설명되어 있는 각각의 프로바이더에대한 상세한 정보를 참고하세요. +Other providers may offer different alternative values. +For more information, refer to the documentation of each provider by +consulting the [API reference](https://pub.dev/documentation/riverpod/latest/riverpod/riverpod-library.html). +## Using "select" to filter rebuilds -## "select"를 사용하여 재빌드 필터링하기 +One final feature to mention related to reading providers is the ability to +reduce the number of times a widget/provider rebuilds from `ref.watch`, or how often `ref.listen` +executes a function. -마지막 특징으로 a widget/provider의 재빌드를 수를 감소하거나 -제한하는 방법을 안내합니다. (얼마나 자주 `ref.listen` 실행하는지를 포함하여) +This is important to keep in mind as, by default, listening to a provider +listens to the entire object state. But sometimes, a widget/provider may only +care about changes to some properties instead of the whole object. - -프로바이더를 감시하는 것은, 그 프로바이더가 공개하는 객체의 모든 속성을 감시하는 것입니다. -그러나 특정 경우에서 구독 범위를 좁히고 특정 속성만 모니터링 대상으로 만들 수 있습니다. - -예를 들어, 프로바이더는 `User` 상태값을 가진다고 가정해 봅시다. +For example, a provider may expose a `User`: ```dart abstract class User { @@ -332,7 +374,7 @@ abstract class User { } ``` -그런데 위젯에서는 단순히 `User`의 `name`값만 사용하고 있습니다. +But a widget may only use the user name: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -341,13 +383,13 @@ Widget build(BuildContext context, WidgetRef ref) { } ``` -만약 `ref.watch`를 사용하면 `User`의 `age` 속성이 변경되면 위젯이 재빌드 될것입니다. - -여기서 해결방법은 `select`를 사용하는 것입니다. -`select`는 [Riverpod]에서 `User`의 특정 속성만 구독/관찰하고 싶을때 사용합니다. +If we naively used `ref.watch`, this would rebuild the widget when the user's +`age` changes. +The solution is to use `select` to explicitly tell Riverpod that we only +want to listen to the name property of the `User`. -코드를 다음과 같이 개선해 볼 수 있습니다. +The updated code would be: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -356,15 +398,17 @@ Widget build(BuildContext context, WidgetRef ref) { } ``` -`select`를 통해 관찰하고 싶은 상태값을 선택하여 -선택한 속성 값의 변화가 발생했을때 사용할 수 있습니다. +By using `select`, we are able to specify a function +that returns the property that we care about. -그리고 `User` 값이 변하면, [Riverpod]은 이 함수를 호출하여 이전 값과 새로운 값을 비교합니다. -만약 상태값이 다르다면(예를 들어 `name`이 변경되었다면), [Riverpod]은 위젯을 다시 빌드하는 작업을 처리할 겁니다. -그러나 만약 값이 같다면 (예를 들어 `age`만 변경되었다면), [Riverpod]은 위젯을 재빌드 하지 않을 겁니다. +Whenever the `User` changes, Riverpod will call this function and +compare the previous and new result. If they are different (such as when the name +changed), Riverpod will rebuild the widget. +However, if they are equal (such as when the age changed), Riverpod will not +rebuild the widget. :::info -`select`는 `ref.listen`과 함께 사용할 수 있습니다. +It is also possible to use `select` with `ref.listen`: ```dart ref.listen( @@ -374,13 +418,13 @@ ref.listen( } ); ``` -`name`이 변경되었을 때 호출되어 사용할 수 있는 구조를 가지게 됩니다. +Doing so will call the listener only when the name changes. ::: :::tip -`select`를 사용하는 경우 반환하는 값이 반드시 객체일 필요는 없습니다. -`==`연자자의 오버라이드(overrides)로 객체가 동일하다고 정의된다면 반환 값으로 무엇이 오든 상관없습니다. +You don't have to return a property of the object. Any value that +overrides == will work. For example you could do: ```dart final label = ref.watch(userProvider.select((user) => 'Mr ${user.name}')); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_hook.dart similarity index 71% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_hook.dart index 2d38c4cfc..5f296f2fb 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_hook.dart @@ -3,7 +3,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'reading_counter.dart'; +import 'counter/raw.dart'; class HomeView extends HookConsumerWidget { const HomeView({super.key}); @@ -15,10 +15,10 @@ class HomeView extends HookConsumerWidget { Scaffold( body: HookConsumer( builder: (context, ref, child) { - // HookConsumerWidget과 같이, builder안에서 hooks을 사용할 수 있습니다. + // Like HookConsumerWidget, we can use hooks inside the builder final state = useState(0); - // 프로바이더를 사용/구독(listen)하기 위해서 ref 매개변수도 사용할 수 있습니다. + // We can also use the ref parameter to listen to providers. final counter = ref.watch(counterProvider); return Text('$counter'); }, diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart new file mode 100644 index 000000000..7b9118cbc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart @@ -0,0 +1,34 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import '../counter/raw.dart'; + +/* SNIPPET START */ + +class HomeView extends StatefulHookConsumerWidget { + const HomeView({super.key}); + + @override + HomeViewState createState() => HomeViewState(); +} + +class HomeViewState extends ConsumerState { + @override + void initState() { + super.initState(); + // "ref" can be used in all life-cycles of a StatefulWidget. + ref.read(counterProvider); + } + + @override + Widget build(BuildContext context) { + // Like HookConsumerWidget, we can use hooks inside the builder + final state = useState(0); + + // We can also use "ref" to listen to a provider inside the build method + final counter = ref.watch(counterProvider); + return Text('$counter'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/index.tsx new file mode 100644 index 000000000..9c0ae43de --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import hooks from "!!raw-loader!./hooks.dart"; + +export default { + raw, + hooks: hooks, + codegen: raw, + hooksCodegen: hooks, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/raw.dart similarity index 69% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/raw.dart index c545e9b17..98d7f3403 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/raw.dart @@ -1,6 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'reading_counter.dart'; +import '../counter/raw.dart'; /* SNIPPET START */ @@ -15,13 +15,13 @@ class HomeViewState extends ConsumerState { @override void initState() { super.initState(); - // "ref"는 StatefulWidget의 모든 생명주기 상에서 사용할 수 있습니다. + // "ref" can be used in all life-cycles of a StatefulWidget. ref.read(counterProvider); } @override Widget build(BuildContext context) { - // "ref"는 build 메소드 안에서 프로바이더를 구독(listen)하기위해 사용할 수 있습니다. + // We can also use "ref" to listen to a provider inside the build method final counter = ref.watch(counterProvider); return Text('$counter'); } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/hooks.dart similarity index 66% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/hooks.dart index 27db84a16..1c5547428 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/hooks.dart @@ -3,7 +3,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'reading_counter.dart'; +import '../counter/raw.dart'; /* SNIPPET START */ @@ -12,10 +12,10 @@ class HomeView extends HookConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // HookConsumerWidget은 build 메소드 안에서 hooks을 사용할 수 있도록 도와줍니다. + // HookConsumerWidget allows using hooks inside the build method final state = useState(0); - // 프로바이더를 사용/구독하기 위해서 ref 매개변수도 사용할 수 있습니다. + // We can also use the ref parameter to listen to providers. final counter = ref.watch(counterProvider); return Text('$counter'); } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/index.tsx new file mode 100644 index 000000000..9c0ae43de --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import hooks from "!!raw-loader!./hooks.dart"; + +export default { + raw, + hooks: hooks, + codegen: raw, + hooksCodegen: hooks, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/raw.dart similarity index 78% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/raw.dart index ffa37a065..d2df7c5a7 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/raw.dart @@ -1,6 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'reading_counter.dart'; +import '../counter/raw.dart'; /* SNIPPET START */ @@ -9,7 +9,7 @@ class HomeView extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // ref를 사용해 프로바이더 구독(listen)하기 + // use ref to listen to a provider final counter = ref.watch(counterProvider); return Text('$counter'); } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart new file mode 100644 index 000000000..ca1edf42e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart @@ -0,0 +1,23 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +final repositoryProvider = Provider((ref) => Repository()); + +class Repository { + Future post(String url) async {} +} + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; + + void increment() { + // Counter can use the "ref" to read other providers + final repository = ref.read(repositoryProvider); + repository.post('...'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart new file mode 100644 index 000000000..d892e8ba8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterHash() => r'6bd7806869af024b3288645da03c077af9478083'; + +/// See also [Counter]. +@ProviderFor(Counter) +final counterProvider = AutoDisposeNotifierProvider.internal( + Counter.new, + name: r'counterProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Counter = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart similarity index 82% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart index d593c044e..b97c93b00 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart @@ -18,7 +18,7 @@ class Counter extends StateNotifier { final Ref ref; void increment() { - // Counter 클래스는 다른 프로바이더를 읽기 위해 "ref"를 사용할 수 있습니다. + // Counter can use the "ref" to read other providers final repository = ref.read(repositoryProvider); repository.post('...'); } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.dart new file mode 100644 index 000000000..154e25e27 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.dart @@ -0,0 +1,16 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import '../counter/raw.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +void another(AnotherRef ref) { + ref.listen(counterProvider, (int? previousCount, int newCount) { + print('The counter changed $newCount'); + }); + // ... +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart new file mode 100644 index 000000000..60b68adf7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$anotherHash() => r'2208f9221f3d898305609874d4f43c28bdfff2b4'; + +/// See also [another]. +@ProviderFor(another) +final anotherProvider = AutoDisposeProvider.internal( + another, + name: r'anotherProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$anotherHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef AnotherRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/raw.dart similarity index 75% rename from website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/raw.dart index 4ed90e7af..ab229db6e 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/raw.dart @@ -1,15 +1,13 @@ // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print import 'package:riverpod/riverpod.dart'; -import 'reading_counter.dart'; +import '../counter/raw.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider(Counter.new); - final anotherProvider = Provider((ref) { ref.listen(counterProvider, (int? previousCount, int newCount) { print('The counter changed $newCount'); }); // ... -}); \ No newline at end of file +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.dart new file mode 100644 index 000000000..e22f4b169 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.dart @@ -0,0 +1,28 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; +} + +class HomeView extends ConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(counterProvider, (int? previousCount, int newCount) { + print('The counter changed $newCount'); + }); + + return Container(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart new file mode 100644 index 000000000..1e834cdbe --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterHash() => r'4320f811608c7a6e7342b83e3031965a34f7cb8e'; + +/// See also [Counter]. +@ProviderFor(Counter) +final counterProvider = AutoDisposeNotifierProvider.internal( + Counter.new, + name: r'counterProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Counter = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart new file mode 100644 index 000000000..5b1147d28 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart @@ -0,0 +1,34 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_hooks.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; +} + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(counterProvider, (int? previousCount, int newCount) { + print('The counter changed $newCount'); + }); + + final greeting = useState('Hello'); + + return Container( + alignment: Alignment.center, + child: Text(greeting.value), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart new file mode 100644 index 000000000..9affdaea0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_hooks.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterHash() => r'4320f811608c7a6e7342b83e3031965a34f7cb8e'; + +/// See also [Counter]. +@ProviderFor(Counter) +final counterProvider = AutoDisposeNotifierProvider.internal( + Counter.new, + name: r'counterProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Counter = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx new file mode 100644 index 000000000..a856c4980 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx @@ -0,0 +1,11 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; +import codegen_hooks from "!!raw-loader!./codegen_hooks.dart"; + +export default { + raw, + hooks: raw_hooks, + codegen, + hooksCodegen: codegen_hooks, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw.dart similarity index 82% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw.dart index 066565b67..e59ddaf57 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw.dart @@ -2,11 +2,12 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'reading_counter.dart'; +import '../counter/raw.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider(Counter.new); +final counterProvider = + StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { const HomeView({super.key}); @@ -16,7 +17,7 @@ class HomeView extends ConsumerWidget { ref.listen(counterProvider, (int? previousCount, int newCount) { print('The counter changed $newCount'); }); - + return Container(); } -} \ No newline at end of file +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart new file mode 100644 index 000000000..9f86fc19f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart @@ -0,0 +1,29 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import '../counter/raw.dart'; + +/* SNIPPET START */ + +final counterProvider = + StateNotifierProvider(Counter.new); + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(counterProvider, (int? previousCount, int newCount) { + print('The counter changed $newCount'); + }); + + final greeting = useState('Hello'); + + return Container( + alignment: Alignment.center, + child: Text(greeting.value), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart new file mode 100644 index 000000000..201c92f91 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart @@ -0,0 +1,20 @@ +// ignore_for_file: avoid_positional_boolean_parameters +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class Repository { + String get() => ''; +} + +@riverpod +Repository repository(RepositoryRef ref) => Repository(); + +/* SNIPPET START */ + +@riverpod +String value(ValueRef ref) { + // use ref to obtain other providers + final repository = ref.watch(repositoryProvider); + return repository.get(); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart new file mode 100644 index 000000000..0e7d74954 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$repositoryHash() => r'c6dc3b5b727028966b5b850b27ffc7294b485273'; + +/// See also [repository]. +@ProviderFor(repository) +final repositoryProvider = AutoDisposeProvider.internal( + repository, + name: r'repositoryProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$repositoryHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef RepositoryRef = AutoDisposeProviderRef; +String _$valueHash() => r'8c26f7aaa911af815cff9e513a18e4d8dcc6d1df'; + +/// See also [value]. +@ProviderFor(value) +final valueProvider = AutoDisposeProvider.internal( + value, + name: r'valueProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$valueHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ValueRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart new file mode 100644 index 000000000..28fdfed97 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart @@ -0,0 +1,19 @@ +// ignore_for_file: avoid_positional_boolean_parameters + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Repository { + void get() {} +} + +final repositoryProvider = Provider((ref) { + return Repository(); +}); + +/* SNIPPET START */ + +final valueProvider = Provider((ref) { + // use ref to obtain other providers + final repository = ref.watch(repositoryProvider); + return repository.get(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart new file mode 100644 index 000000000..0742ed5e5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart @@ -0,0 +1,32 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; + void increment() => state = state + 1; +} + +class HomeView extends ConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + floatingActionButton: FloatingActionButton( + onPressed: () { + // Call `increment()` on the `Counter` class + ref.read(counterProvider.notifier).increment(); + }, + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart new file mode 100644 index 000000000..041865b99 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; + +/// See also [Counter]. +@ProviderFor(Counter) +final counterProvider = AutoDisposeNotifierProvider.internal( + Counter.new, + name: r'counterProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Counter = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart new file mode 100644 index 000000000..341087cde --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart @@ -0,0 +1,36 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_hooks.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; + void increment() => state = state + 1; +} + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final greeting = useState('Hello'); + + return Scaffold( + body: Center(child: Text(greeting.value)), + floatingActionButton: FloatingActionButton( + onPressed: () { + // Call `increment()` on the `Counter` class + ref.read(counterProvider.notifier).increment(); + }, + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart new file mode 100644 index 000000000..5fd373b49 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_hooks.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; + +/// See also [Counter]. +@ProviderFor(Counter) +final counterProvider = AutoDisposeNotifierProvider.internal( + Counter.new, + name: r'counterProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Counter = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx new file mode 100644 index 000000000..d0caf89aa --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx @@ -0,0 +1,11 @@ +import raw from "!!raw-loader!./raw.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; +import codegen from "!!raw-loader!./codegen.dart"; +import codegen_hooks from "!!raw-loader!./codegen_hooks.dart"; + +export default { + raw, + hooks: raw_hooks, + codegen, + hooksCodegen: codegen_hooks, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart similarity index 72% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart index b3573a256..7d8685155 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart @@ -3,12 +3,11 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'reading_counter.dart'; +import '../counter/raw.dart'; /* SNIPPET START */ -final counterProvider = - StateNotifierProvider(Counter.new); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { const HomeView({super.key}); @@ -18,7 +17,7 @@ class HomeView extends ConsumerWidget { return Scaffold( floatingActionButton: FloatingActionButton( onPressed: () { - // `Counter`클래스의 increment() 메소드를 호출합니다. + // Call `increment()` on the `Counter` class ref.read(counterProvider.notifier).increment(); }, ), diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart new file mode 100644 index 000000000..acc6ba980 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart @@ -0,0 +1,31 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../counter/raw.dart'; + +/* SNIPPET START */ + +final counterProvider = + StateNotifierProvider(Counter.new); + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final greeting = useState('Hello'); + + return Scaffold( + body: Center(child: Text(greeting.value)), + floatingActionButton: FloatingActionButton( + onPressed: () { + // Call `increment()` on the `Counter` class + ref.read(counterProvider.notifier).increment(); + }, + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart new file mode 100644 index 000000000..9a4347159 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart @@ -0,0 +1,25 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; + void increment() => state = state + 1; +} + +Widget build(BuildContext context, WidgetRef ref) { + // use "read" to ignore updates on a provider + final counter = ref.read(counterProvider.notifier); + return ElevatedButton( + onPressed: counter.increment, + child: const Text('button'), + ); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart new file mode 100644 index 000000000..041865b99 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; + +/// See also [Counter]. +@ProviderFor(Counter) +final counterProvider = AutoDisposeNotifierProvider.internal( + Counter.new, + name: r'counterProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Counter = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart similarity index 84% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart index 8f2ba0bd6..266e00224 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart @@ -8,7 +8,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); Widget build(BuildContext context, WidgetRef ref) { - // 프로바이더 상태 값 갱신을 무시하기위해서 "read" 사용 + // use "read" to ignore updates on a provider final counter = ref.read(counterProvider.notifier); return ElevatedButton( onPressed: () => counter.state++, diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.dart new file mode 100644 index 000000000..6bf061abf --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; + void increment() => state = state + 1; +} + +Widget build(BuildContext context, WidgetRef ref) { + Counter counter = ref.read(counterProvider.notifier); + return ElevatedButton( + onPressed: () => counter.increment(), + child: const Text('button'), + ); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart new file mode 100644 index 000000000..041865b99 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; + +/// See also [Counter]. +@ProviderFor(Counter) +final counterProvider = AutoDisposeNotifierProvider.internal( + Counter.new, + name: r'counterProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Counter = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/raw.dart similarity index 99% rename from website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/raw.dart index 34104aead..0ec5b5958 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/raw.dart @@ -13,4 +13,4 @@ Widget build(BuildContext context, WidgetRef ref) { onPressed: () => counter.state++, child: const Text('button'), ); -} \ No newline at end of file +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart new file mode 100644 index 000000000..31de6da74 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart @@ -0,0 +1,45 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +enum FilterType { + none, + completed, +} + +abstract class Todo { + bool get isCompleted; +} + +/* SNIPPET START */ + +@riverpod +FilterType filterType(FilterTypeRef ref) { + return FilterType.none; +} + +@riverpod +class Todos extends _$Todos { + @override + List build() { + return []; + } +} + +@riverpod +List filteredTodoList(FilteredTodoListRef ref) { + // obtains both the filter and the list of todos + final FilterType filter = ref.watch(filterTypeProvider); + final List todos = ref.watch(todosProvider); + + switch (filter) { + case FilterType.completed: + // return the completed list of todos + return todos.where((todo) => todo.isCompleted).toList(); + case FilterType.none: + // returns the unfiltered list of todos + return todos; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart new file mode 100644 index 000000000..8221391a4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart @@ -0,0 +1,55 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$filterTypeHash() => r'42b68b163daecff7a0b9b069b16025a89910b4fb'; + +/// See also [filterType]. +@ProviderFor(filterType) +final filterTypeProvider = AutoDisposeProvider.internal( + filterType, + name: r'filterTypeProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$filterTypeHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef FilterTypeRef = AutoDisposeProviderRef; +String _$filteredTodoListHash() => r'34f1e929a9e7850946ea8634d9f3e8f38ae5687d'; + +/// See also [filteredTodoList]. +@ProviderFor(filteredTodoList) +final filteredTodoListProvider = AutoDisposeProvider>.internal( + filteredTodoList, + name: r'filteredTodoListProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$filteredTodoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef FilteredTodoListRef = AutoDisposeProviderRef>; +String _$todosHash() => r'b66ac2b1e5cf7ac7957d25864cfdffad1af233a6'; + +/// See also [Todos]. +@ProviderFor(Todos) +final todosProvider = AutoDisposeNotifierProvider>.internal( + Todos.new, + name: r'todosProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todosHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Todos = AutoDisposeNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart similarity index 80% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart index 9fef0a435..625c0fe9a 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart @@ -22,16 +22,16 @@ final todosProvider = StateNotifierProvider>((ref) => TodoList()); final filteredTodoListProvider = Provider((ref) { - // 할일(todos)목록과 필터(filter)상태 값을 취득합니다. + // obtains both the filter and the list of todos final FilterType filter = ref.watch(filterTypeProvider); final List todos = ref.watch(todosProvider); switch (filter) { case FilterType.completed: - // 완료된(completed) 할일 목록을 반환합니다. + // return the completed list of todos return todos.where((todo) => todo.isCompleted).toList(); case FilterType.none: - // 필터링되지 않은 목록을 반환합니다. + // returns the unfiltered list of todos return todos; } }); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart new file mode 100644 index 000000000..80b63d216 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart @@ -0,0 +1,39 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +enum FilterType { + none, + completed, +} + +abstract class Todo { + bool get isCompleted; +} + +@riverpod +class TodoList extends _$TodoList { + @override + List build() => []; +} + +/* SNIPPET START */ + +@riverpod +int counter(CounterRef ref) => 0; + +class HomeView extends ConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // use ref to listen to a provider + final counter = ref.watch(counterProvider); + + return Text('$counter'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart new file mode 100644 index 000000000..347684842 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart @@ -0,0 +1,41 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; + +/// See also [counter]. +@ProviderFor(counter) +final counterProvider = AutoDisposeProvider.internal( + counter, + name: r'counterProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CounterRef = AutoDisposeProviderRef; +String _$todoListHash() => r'77f007cd4f5105330a4c2ab8555ea0d1716945c1'; + +/// See also [TodoList]. +@ProviderFor(TodoList) +final todoListProvider = + AutoDisposeNotifierProvider>.internal( + TodoList.new, + name: r'todoListProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$TodoList = AutoDisposeNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart new file mode 100644 index 000000000..c82698304 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart @@ -0,0 +1,43 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_hooks.g.dart'; + +enum FilterType { + none, + completed, +} + +abstract class Todo { + bool get isCompleted; +} + +@riverpod +class TodoList extends _$TodoList { + @override + List build() => []; +} + +/* SNIPPET START */ + +@riverpod +int counter(CounterRef ref) => 0; + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // You can use hooks inside a HookConsumerWidget + final greeting = useState('Hello'); + + // use ref to listen to a provider + final counter = ref.watch(counterProvider); + + return Text('${greeting.value} $counter'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart new file mode 100644 index 000000000..f5b4cfea1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart @@ -0,0 +1,41 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_hooks.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; + +/// See also [counter]. +@ProviderFor(counter) +final counterProvider = AutoDisposeProvider.internal( + counter, + name: r'counterProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CounterRef = AutoDisposeProviderRef; +String _$todoListHash() => r'77f007cd4f5105330a4c2ab8555ea0d1716945c1'; + +/// See also [TodoList]. +@ProviderFor(TodoList) +final todoListProvider = + AutoDisposeNotifierProvider>.internal( + TodoList.new, + name: r'todoListProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$TodoList = AutoDisposeNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx new file mode 100644 index 000000000..a856c4980 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx @@ -0,0 +1,11 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; +import codegen_hooks from "!!raw-loader!./codegen_hooks.dart"; + +export default { + raw, + hooks: raw_hooks, + codegen, + hooksCodegen: codegen_hooks, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart similarity index 91% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart index 6ace027ca..8d5d430eb 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart @@ -25,7 +25,7 @@ class HomeView extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // ref를 사용하여 프로바이더 구독하기. + // use ref to listen to a provider final counter = ref.watch(counterProvider); return Text('$counter'); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart new file mode 100644 index 000000000..5f297850a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart @@ -0,0 +1,37 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +enum FilterType { + none, + completed, +} + +abstract class Todo { + bool get isCompleted; +} + +class TodoList extends StateNotifier> { + TodoList() : super([]); +} + +/* SNIPPET START */ + +final counterProvider = StateProvider((ref) => 0); + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // You can use hooks inside a HookConsumerWidget + final greeting = useState('Hello'); + + // use ref to listen to a provider + final counter = ref.watch(counterProvider); + + return Text('${greeting.value} $counter'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.dart new file mode 100644 index 000000000..6b76d0219 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; + void increment() => state = state + 1; +} + +Widget build(BuildContext context, WidgetRef ref) { + Counter counter = ref.watch(counterProvider.notifier); + return ElevatedButton( + onPressed: () => counter.increment(), + child: const Text('button'), + ); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart new file mode 100644 index 000000000..041865b99 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; + +/// See also [Counter]. +@ProviderFor(Counter) +final counterProvider = AutoDisposeNotifierProvider.internal( + Counter.new, + name: r'counterProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Counter = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/raw.dart similarity index 100% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/raw.dart diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/scopes.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/scopes.mdx new file mode 100644 index 000000000..f53d8315d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/scopes.mdx @@ -0,0 +1,180 @@ +--- +title: Scopes +--- + +import CodeBlock from "@theme/CodeBlock"; +import asyncInitialization from "!!raw-loader!/docs/concepts/async_initialization.dart"; +import dialogScope from "!!raw-loader!/docs/concepts/dialog_scope.dart"; +import themeScope from "!!raw-loader!/docs/concepts/theme_scope.dart"; +import subtreeScope from "!!raw-loader!/docs/concepts/subtree_scope.dart"; +import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import { Link } from "../../../../../src/components/Link"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + +Scoping in Riverpod is a very powerful feature, but like all powerful features, it should be used wisely and intentionally. + +A few of the things that scoping enables are: + +- Override the state of providers for a specific subtree (similar to how theming and `InheritedWidgets` work in flutter) [(see example)](#subtree-scope) +- Creating synchronous providers for normally async APIs [(see example)](#initialization-of-synchronous-provider-for-async-apis) +- Allowing `Dialog`s and `Overlay`s to inherit the state of providers from the widget subtree that cause them to be shown [(see example)](#showing-dialogs) +- Optimizing rebuilds of widgets by removing parameters from Widget constructors allowing you to make them `const` + +If you are wanting to use scope for the first point, chances are you can use families instead. +Families have the advantages of allowing you to access each of those instances of the state from anywhere in the widget tree rather than just the state scoped to the specific subtree that you are in. + +Using scope to create multiple instances of a provider's state is similar to how `package:provider` works. + +However, using scope to accomplish that task, is more restrictive, as you cannot decide to access other instances from that scope. + +As such, before scoping every provider you use, consider carefully why you want to scope the provider. + +## ProviderScope and ProviderContainer + +A scope is introduced by a [ProviderContainer]. This container holds the current state of all of your providers. +It manages the lookup and subscriptions between providers. + +In Flutter you should use the [ProviderScope] widget, which contains a [ProviderContainer] +internally, and provides a way to access that container to the rest of the widget tree. + +```dart +final valueProvider = StateProvider((ref) => 0); + +// DO this +void main() { + runApp(ProviderScope(child: MyApp())); +} + +//DON'T do this: +final myProviderContainer = ProviderContainer(); +void main(){ + runApp(MyApp()); +} +``` + +:::warning +Do not use multiple [ProviderContainer]s, without an understanding of how they work. +Each will have it's own separate thread of states, which will not be able to access each other. +Tests are an example of when you might want to use separate [ProviderContainer]s +in order to make each test's state independent of the others. +::: + +Only create a [ProviderContainer] without a [ProviderScope] for testing and dart-only usage. + +## How Riverpod Finds a Provider + +When a widget or provider requests the value of a provider, Riverpod looks up the state of that provider in the nearest +[ProviderScope] widget. If neither the provider nor one of it's explicitly listed dependencies is overridden in that scope Riverpod continues it's lookup up the widget tree. +If the provider has not been overridden in any Widget subtrees the lookup defaults to the [ProviderContainer] in the root [ProviderScope]. + +Once this process locates the scope in which the provider should reside it determines if the provider has been created yet. +If so, it will return the state of the provider. +However, if the provider has been invalidated or is not currently initialized it will create the state using the provider's build method. + +## Initialization of Synchronous Provider for Async APIs + +Often you might have some async initialization of a dependency such as `SharedPreferences` or `FirebaseApp`. +Many other providers might rely on this, and dealing with the error / loading states in each of those providers is redundant. + +You might be able to guarantee that those providers will not have errors and will load quickly when the app is started. + +So how do you makes these sorts of provider states available synchronously? + +Here is an example that shows how scoping allows you override a dummy provider when your asynchronous API is ready. + +{trimSnippet(asyncInitialization)} + +## Showing Dialogs + +When you show a `Dialog` or `OverlayEntry`, flutter creates a new `Route` or adds to an `Overlay` that has a different build scope, +so that it can escape the layout of it's parent, and can be shown above other `Routes`. +This presents a problem for `InheritedWidget`s in general, and since [ProviderScope] is an `InheritedWidget`, it is also affected. + +To solve this problem, Riverpod allows you to create a `ProviderScope` that can access the state of all providers in a `parent` scope. + +The following example shows how to use this, to allow a `Dialog` to access the state of a counter from the context that caused the `Dialog` to be shown. + +{trimSnippet(dialogScope)} + +## Subtree Scoping + +Scoping allows you to override the state of a provider for a specific subtree of your widget tree. +In this way it can provide a similar mechanism to `InheritedWidget` from flutter, or the providers from `package:provider`. + +For example, in flutter you can override the `Theme` for a particular subtree of your widget tree, by wrapping it in a `Theme` widget. + +{trimSnippet(themeScope)} + +Under the hood, `Theme` is an `InheritedWidget` and when widgets look up the `Theme` they get the `Theme` from the nearest `Theme` widget above it in the widget tree. + +Riverpod works differently, since all of the state of your application is typically stored in a root [ProviderScope] widget. +Don't worry, this doesn't cause your whole application to rebuild when the state changes, it just allows you to access the state from anywhere in your widget tree. + +What if you want different providers depending on which page you are in? + +The first thing that you should consider is whether the provided behavior will differ in any way. + +If so -> just create a new provider with a different name and use it in that page + +If not -> Consider using a . + +Often you start by thinking that you only need a provider on a particular page, but end up wanting to use it in another page later on. +Families protect you against this eventuality, and are a major difference in how you should adjust your thinking if you are coming from `package:provider`. + +If families really do not fit your use case, the following example shows you how to override a provider for a particular subtree. + +{trimSnippet(subtreeScope)} + +## When to choose Scoped Providers or Families + +While scopes are important to understand, it is easy to get carried away when using scopes. + +If you want a different instance of a provider's state depending on where it is in the widget tree you have a few alternatives available to you: `Scoping`, `Families`, or a combination. +The appropriate choice depends on your use case. + +Families: + +- Pro: You can show multiple of the states no matter which subtree you are in +- Pro: This makes it a more flexible and scalable solution for many use cases + +Scoping: + +- Con: You end up with more nesting of [ProviderScope] widgets in your widget tree +- Con: You can only access the one override in your section of the widget tree +- Con: You end up having to explicitly list the dependencies of most of your providers +- Pro: You can reduce the number of parameters in your widget constructors +- Pro: You get a slight performance advantage, and can potentially make some of your widget constructors `const` + +Using a combination of the two approaches, you can get the pros of both approaches, but you still have to deal with the cons of scoping. + +:::warning +Remember that scopes introduce a new instance of the state of every provider that is overridden or has listed a dependency on a provider that was overridden. +If you override with the same parameter in a different subtree of the app, it will **not** be the same instance of the provider's state. +Families are more flexible in general, and with the upcoming code generation feature it is easy to use multiple parameters for a family. +Often a good combination is to use both families and scoping. Use a family to provide general access to a piece of state anywhere in your app, and then use scoping to +provide a specific instance of the family's state depending on where you are in the widget tree. +::: + +### Less common usages of Scopes + +Sometimes you may want to override a whole set of providers in a specific subtree of your app. +By listing a common provider in the dependencies list of each of those providers, you can easily create new states for all of them at once, by overriding the common one. + +Note that if you try to use families for this, you will end up with many families that all have the same parameter, and you could end up passing that parameter all over the widget tree. +In this case it is also acceptable to use scopes. + +:::warning +Once you start using scope, make sure to always list your dependencies and keep them up to date, to prevent runtime exceptions. +To help with this we have created [riverpod_lint] which will warn you if there is a missing dependency. +Additionally with [riverpod_generator] the code generator automatically generates the dependency list. +::: + +[ProviderContainer]: https://pub.dev/documentation/riverpod/latest/riverpod/ProviderContainer-class.html +[ProviderScope]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ProviderScope-class.html +[riverpod_lint]: https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint +[riverpod_generator]: https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_generator diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart new file mode 100644 index 000000000..9aa1903e5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart @@ -0,0 +1,78 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +/// A counter that is being incremented by each [CounterDisplay]'s ElevatedButton +final counterProvider = StateProvider( + (ref) => 0, +); + +final adjustedCountProvider = Provider( + (ref) => ref.watch(counterProvider) * 2, + // Note that if a provider depends on a provider that is overridden for a subtree, + // you must explicitly list that provider in your dependencies list. + dependencies: [counterProvider], +); + +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + body: Column( + children: [ + ProviderScope( + /// Just specify which provider you want to have a copy of in the subtree + /// + /// Note that dependant providers such as [adjustedCountProvider] will + /// also be copied for this subtree. If that is not the behavior you want, + /// consider using families instead + overrides: [counterProvider], + child: const CounterDisplay(), + ), + ProviderScope( + // You can change the provider's behavior in a particular subtree + overrides: [counterProvider.overrideWith((ref) => 1)], + child: const CounterDisplay(), + ), + ProviderScope( + overrides: [ + counterProvider, + // You can also change dependent provider's behaviors + adjustedCountProvider.overrideWith( + (ref) => ref.watch(counterProvider) * 3, + ), + ], + child: const CounterDisplay(), + ), + // This particular display will use the provider state from the root ProviderScope + const CounterDisplay(), + ], + )); + } +} + +class CounterDisplay extends ConsumerWidget { + const CounterDisplay({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final count = ref.watch(counterProvider); + return Column( + mainAxisSize: MainAxisSize.min, + children: [ + Text('$count'), + ElevatedButton( + onPressed: () { + ref.read(counterProvider.notifier).state++; + }, + child: const Text('Increment Count'), + ), + ], + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart new file mode 100644 index 000000000..d17f15f02 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart @@ -0,0 +1,68 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +void main() { + runApp( + ProviderScope( + child: MaterialApp( + theme: ThemeData(primaryColor: Colors.blue), + home: const Home(), + ), + ), + ); +} + +// Have a counter that is being incremented +final counterProvider = StateProvider( + (ref) => 0, +); + +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + body: Column( + children: [ + // This counter will have a primary color of green + Theme( + data: Theme.of(context).copyWith(primaryColor: Colors.green), + child: const CounterDisplay(), + ), + // This counter will have a primary color of blue + const CounterDisplay(), + ElevatedButton( + onPressed: () { + ref.read(counterProvider.notifier).state++; + }, + child: const Text('Increment Count'), + ), + ], + )); + } +} + +class CounterDisplay extends ConsumerWidget { + const CounterDisplay({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final count = ref.watch(counterProvider); + final theme = Theme.of(context); + return Column( + mainAxisSize: MainAxisSize.min, + children: [ + Text( + '$count', + style: theme.textTheme.displayMedium + ?.copyWith(color: theme.primaryColor), + ), + ], + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx index bb4ecd124..4e23da9fc 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx @@ -1,124 +1,94 @@ --- -title: 불변성(Immutability)의 중요성 +title: Why Immutability --- import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; +import whyImmutability from "./why_immutability" +import { + trimSnippet, + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -## 불변성(Immutability)이란? +## What is Immutability? -불변성은 객체의 모든 필드가 final 또는 late final인 경우를 의미합니다. -이러한 필드들은 생성 시에만 설정되며, 이후에는 변경할 수 없습니다. +Immutability is when all fields of an `Object` are final or late final. +They are set exactly once upon construction. -불변성은 여러 가지 이유에서 유용합니다. +Immutability is desireable for many different reasons -- reference equality(레퍼런스 동등성)이 아닌 value equality(값의 동등성)을 가져옵니다. -- 코드의 지역적인 이해가 용이해집니다. - - 다른 곳에 있는 코드가 레퍼런스에 접근하여 객체를 변경하는 것을 방지할 수 있습니다 -- 비동기 및 병렬 작업에 대해 이해하기 쉬워집니다. - - 작업 사이에 다른 코드가 객체를 변경할 수 없습니다. -- API의 안전성이 보장됩니다. - - 메서드에 전달한 객체는 호출자 또는 피호출자에 의해 변경될 수 없습니다. +- Value equality rather than reference equality +- Local reasoning about a piece of code + - A far distant piece of code can't obtain a reference and change the object from underneath you +- Easier to reason about for asynchronous and parallel tasks + - Other code can't mutate your object in between operations +- Safety of APIs + - What you pass into a method cannot be changed by the callee / caller -copyWith 메서드는 기존 객체에서 몇 가지 속성만 변경된 새로운 객체를 생성할 때, 코드의 복잡도를 줄이는 데 도움이 될 수 있습니다. +A copyWith method helps with reducing verbosity when creating a new object with just a few things changed. -복사 작업은 예상보다 더 효율적입니다. 왜냐하면 Dart는 변경되지 않은 하위 객체에 대한 참조를 재사용할 수 있기 때문입니다. +Copying is more efficient than you might think, since dart can reuse any references to sub-objects that have not changed. :::warning -객체가 깊은 불변성(deeply immutable)을 가지고 있는지 확인하십시오. 그렇지 않으면 당신은 깊은 복사 메커니즘을 구현해야 할 수 있습니다. +Make sure your objects are deeply immutable, otherwise you'll have to implement some sort of deep copy mechanism. ::: -## 최적의 방법 +## Best Practices -불변 상태를 만들기 위해 다양한 패키지를 이용할 수 있습니다. +You can use any package you want to create immutable state. -immutable한 객체의 경우 +For immutable objects: - [package:freezed](https://pub.dev/packages/freezed) - [package:built_value](https://pub.dev/packages/built_value) -immutable한 컬렉션의 경우 (Map, Set, List) +For immutable collections (Map, Set, List): - [package:fast_immutable_collections](https://pub.dev/packages/fast_immutable_collections) - [package:built_collection](https://pub.dev/packages/built_collection) - [package:kt_dart](https://pub.dev/packages/kt_dart) - [package:dartz](https://pub.dev/packages/dartz) -[freezed] 사용을 높이 권장합니다. -이 패키지에는 불변의 객체를 만드는 것 이외에도 몇 가지 멋진 추가 기능들이 있습니다. +It is highly recommended to use [freezed], +since it has several nice additions beyond just making immutable objects including: -- copyWith 메서드 -- 깊은 복사 (중첩된 freezed 객체의 copyWith) -- Union 타입 -- Union 매핑 함수 +- A generated copyWith method +- Deep copy (copyWith on nested freezed objects) +- Union types +- Union mapping functions -불변 상태를 다루기 위해 code generation을 사용해야 할 필요는 없지만, 이를 사용하면 작업이 더 쉬워집니다. +You do not need to use code generation to work with immutable state, but it makes it much easier. :::warning -빌트인 컬렉션을 사용하려면, 업데이트할 때 컬렉션을 복사하는 규칙을 강제해야 합니다. -컬렉션을 복사하지 않으면 riverpod는 객체에 대한 레퍼런스가 변경되었는지를 기반으로 새 상태를 전달할지 결정합니다. -객체를 변경하는 메서드를 단순히 호출한다면, 레퍼런스는 이전과 동일하기 때문에 객체가 변경되지 않을 수 있습니다. +If you want to use the built-in collections, make sure to enforce a discipline of making copies of collections when updating them. +The issue with not copying a collection is that riverpod determines whether to emit a new state based on whether the reference to the object has changed. +If you just call a method that mutates an object, the reference is the same. ::: -### 불변 상태 사용하기 - -불변 상태는 [StateNotifier]와 [StateNotifierProvider]를 결합하여 사용하는 것이 가장 적합합니다. -[StateNotifier]를 사용하면 상태를 '변경'할 수 있는 인터페이스를 노출할 수 있습니다. -[StateNotifier]를 확장하는 클래스 밖에서는 상태를 변경할 수 없으므로, 역할 분리를 강제하고 비즈니스 로직을 UI 바깥에 유지할 수 있습니다. - -다음은 앱 테마를 변경하는 불변 상태의 설정 클래스 예제입니다. - -```dart -final themeProvider = StateNotifierProvider((ref) => ThemeNotifier()); - -class ThemeNotifier extends StateNotifier { - ThemeNotifier(): super( - ThemeSettings( - mode: ThemeMode.system, - primaryColor: Colors.blue, - )); - - void toggle() { - state = state.copyWith(mode: state.mode.toggle); - } - void setDarkTheme() { - state = state.copyWith(mode: ThemeMode.dark); - } - void setLightTheme() { - state = state.copyWith(mode: ThemeMode.light); - } - void setSystemTheme() { - state = state.copyWith(mode: ThemeMode.system); - } - void setPrimaryColor(Color color) { - state = state.copyWith(primaryColor: color); - } - -} - -@freezed -class ThemeSettings with _$ThemeSettings { - const factory ThemeSettings({ThemeMode mode, Color primaryColor}) = _ThemeSettings; -} - -extension ToggleTheme on ThemeMode { - ThemeMode get toggle { - switch (this){ - case ThemeMode.dark: - return ThemeMode.light; - case ThemeMode.light: - return ThemeMode.dark; - case ThemeMode.system: - return ThemeMode.system; - } - } -} -``` -이 코드를 적용하려면, 'freezed_annotation'을 import하고 part 지시문을 추가한 후, [build_runner]를 실행하여 freezed 클래스를 생성해야 하는 것을 기억하세요! +### Using immutable state + +Immutable state is best fit for using a [Notifier] in combination with [NotifierProvider] . +A [Notifier] allows you to expose an interface through which you can 'mutate' the state. +You cannot mutate the state from outside the class you define that extends [Notifier]. +This enforces a separation of concerns and keeps business logic outside of your UI. + +Here is an example of a simple immutable settings class for changing an app theme. + + + +To use this code, remember to import `freezed_annotation`, add the part directive and run [build_runner] to generate the freezed classes! [changenotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html [statenotifier]: https://pub.dev/documentation/riverpod/latest/riverpod/StateNotifier-class.html [statenotifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/StateNotifierProvider-class.html +[notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html +[notifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/NotifierProvider.html [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html [freezed]: https://pub.dev/packages/freezed [build_runner]: https://pub.dev/packages/build_runner - diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart new file mode 100644 index 000000000..fd286a36c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart @@ -0,0 +1,58 @@ +import 'package:flutter/material.dart'; +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +class ThemeNotifier extends _$ThemeNotifier { + @override + ThemeSettings build() => const ThemeSettings( + mode: ThemeMode.light, + primaryColor: Colors.blue, + ); + + void toggle() { + state = state.copyWith(mode: state.mode.toggle); + } + + void setDarkTheme() { + state = state.copyWith(mode: ThemeMode.dark); + } + + void setLightTheme() { + state = state.copyWith(mode: ThemeMode.light); + } + + void setSystemTheme() { + state = state.copyWith(mode: ThemeMode.system); + } + + void setPrimaryColor(Color color) { + state = state.copyWith(primaryColor: color); + } +} + +@freezed +class ThemeSettings with _$ThemeSettings { + const factory ThemeSettings({ + required ThemeMode mode, + required Color primaryColor, + }) = _ThemeSettings; +} + +extension ToggleTheme on ThemeMode { + ThemeMode get toggle { + switch (this) { + case ThemeMode.dark: + return ThemeMode.light; + case ThemeMode.light: + return ThemeMode.dark; + case ThemeMode.system: + return ThemeMode.system; + } + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart new file mode 100644 index 000000000..6e8c8082b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart @@ -0,0 +1,151 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$ThemeSettings { + ThemeMode get mode => throw _privateConstructorUsedError; + Color get primaryColor => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $ThemeSettingsCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ThemeSettingsCopyWith<$Res> { + factory $ThemeSettingsCopyWith( + ThemeSettings value, $Res Function(ThemeSettings) then) = + _$ThemeSettingsCopyWithImpl<$Res, ThemeSettings>; + @useResult + $Res call({ThemeMode mode, Color primaryColor}); +} + +/// @nodoc +class _$ThemeSettingsCopyWithImpl<$Res, $Val extends ThemeSettings> + implements $ThemeSettingsCopyWith<$Res> { + _$ThemeSettingsCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? mode = null, + Object? primaryColor = null, + }) { + return _then(_value.copyWith( + mode: null == mode + ? _value.mode + : mode // ignore: cast_nullable_to_non_nullable + as ThemeMode, + primaryColor: null == primaryColor + ? _value.primaryColor + : primaryColor // ignore: cast_nullable_to_non_nullable + as Color, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ThemeSettingsImplCopyWith<$Res> + implements $ThemeSettingsCopyWith<$Res> { + factory _$$ThemeSettingsImplCopyWith( + _$ThemeSettingsImpl value, $Res Function(_$ThemeSettingsImpl) then) = + __$$ThemeSettingsImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({ThemeMode mode, Color primaryColor}); +} + +/// @nodoc +class __$$ThemeSettingsImplCopyWithImpl<$Res> + extends _$ThemeSettingsCopyWithImpl<$Res, _$ThemeSettingsImpl> + implements _$$ThemeSettingsImplCopyWith<$Res> { + __$$ThemeSettingsImplCopyWithImpl( + _$ThemeSettingsImpl _value, $Res Function(_$ThemeSettingsImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? mode = null, + Object? primaryColor = null, + }) { + return _then(_$ThemeSettingsImpl( + mode: null == mode + ? _value.mode + : mode // ignore: cast_nullable_to_non_nullable + as ThemeMode, + primaryColor: null == primaryColor + ? _value.primaryColor + : primaryColor // ignore: cast_nullable_to_non_nullable + as Color, + )); + } +} + +/// @nodoc + +class _$ThemeSettingsImpl implements _ThemeSettings { + const _$ThemeSettingsImpl({required this.mode, required this.primaryColor}); + + @override + final ThemeMode mode; + @override + final Color primaryColor; + + @override + String toString() { + return 'ThemeSettings(mode: $mode, primaryColor: $primaryColor)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ThemeSettingsImpl && + (identical(other.mode, mode) || other.mode == mode) && + (identical(other.primaryColor, primaryColor) || + other.primaryColor == primaryColor)); + } + + @override + int get hashCode => Object.hash(runtimeType, mode, primaryColor); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ThemeSettingsImplCopyWith<_$ThemeSettingsImpl> get copyWith => + __$$ThemeSettingsImplCopyWithImpl<_$ThemeSettingsImpl>(this, _$identity); +} + +abstract class _ThemeSettings implements ThemeSettings { + const factory _ThemeSettings( + {required final ThemeMode mode, + required final Color primaryColor}) = _$ThemeSettingsImpl; + + @override + ThemeMode get mode; + @override + Color get primaryColor; + @override + @JsonKey(ignore: true) + _$$ThemeSettingsImplCopyWith<_$ThemeSettingsImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart new file mode 100644 index 000000000..44ea6ef85 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart @@ -0,0 +1,28 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$themeNotifierHash() => r'e119d56d9bf8b8d7c19624997f99d116098b45e9'; + +/// See also [ThemeNotifier]. +@ProviderFor(ThemeNotifier) +final themeNotifierProvider = + AutoDisposeNotifierProvider.internal( + ThemeNotifier.new, + name: r'themeNotifierProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$themeNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$ThemeNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart new file mode 100644 index 000000000..1e34c694c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart @@ -0,0 +1,67 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +final themeProvider = + NotifierProvider(ThemeNotifier.new); + +class ThemeNotifier extends Notifier { + @override + ThemeSettings build() { + return ThemeSettings(mode: ThemeMode.system, primaryColor: Colors.blue); + } + + void toggle() { + state = state.copyWith(mode: state.mode.toggle); + } + + void setDarkTheme() { + state = state.copyWith(mode: ThemeMode.dark); + } + + void setLightTheme() { + state = state.copyWith(mode: ThemeMode.light); + } + + void setSystemTheme() { + state = state.copyWith(mode: ThemeMode.system); + } + + void setPrimaryColor(Color color) { + state = state.copyWith(primaryColor: color); + } +} + +class ThemeSettings { + ThemeSettings({ + required this.mode, + required this.primaryColor, + }); + + final ThemeMode mode; + final Color primaryColor; + + ThemeSettings copyWith({ + ThemeMode? mode, + Color? primaryColor, + }) { + return ThemeSettings( + mode: mode ?? this.mode, + primaryColor: primaryColor ?? this.primaryColor, + ); + } +} + +extension ToggleTheme on ThemeMode { + ThemeMode get toggle { + switch (this) { + case ThemeMode.dark: + return ThemeMode.light; + case ThemeMode.light: + return ThemeMode.dark; + case ThemeMode.system: + return ThemeMode.system; + } + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx deleted file mode 100644 index edf6ab805..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Pull-to-refresh / Retry-on-error ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -In this guide, we will see how Providers can be used to easily implement -a pull-to-refresh or retry-on-error feature. - diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx index b89da0ca2..bbb1a477f 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx @@ -2,11 +2,17 @@ title: Search as we type --- +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + A real world example could be to use `FutureProvider` to implement a searchbar. ## Usage example: "Search as we type" searchbar -Implementing a "seach as we type" can seem daunting at first when using +Implementing a "search as we type" can seem daunting at first when using conventional means. There are lots of moving parts, such as: @@ -26,10 +32,10 @@ is to split it into multiple providers: the other providers/[family]. The first step would be to store the user input somewhere. For this example, -we will use `StateProvider` (as the seach state is only a single `String`): +we will use `StateProvider` (as the search state is only a single `String`): ```dart -final seachInputProvider = StateProvider((ref) => ''); +final searchInputProvider = StateProvider((ref) => ''); ``` We can then connect this provider to a [TextField] by doing: @@ -113,14 +119,11 @@ class MyHomePage extends ConsumerWidget { ref.read(searchFieldProvider.notifier).state = value, ), Expanded( - child: questions.when( - loading: () => const Center(child: CircularProgressIndicator()), - error: (error, stack) => Center(child: Text('Error $error')), - data: (questions) { - return ListView.builder( - itemCount: questions.length, + child: switch (questions) { + AsyncData(:final value) => ListView.builder( + itemCount: value.length, itemBuilder: (context, index) { - final question = questions[index]; + final question = value[index]; return ListTile( title: Text( @@ -128,9 +131,10 @@ class MyHomePage extends ConsumerWidget { ), ); }, - ); - }, - ), + );, + AsyncError(:final error) => Center(child: Text('Error $error')), + _ => const Center(child: CircularProgressIndicator()), + }, ), ], ), diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing.mdx index 2ca4f4dba..3e91042c9 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing.mdx @@ -1,46 +1,57 @@ --- -title: 테스트 +title: Testing --- import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import testingOriginalTestFlutter from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart"; -import testingOriginalTestDart from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart"; -import repositorySnippet from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart"; -import testFlutter from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart"; -import testDart from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart"; -import testFull from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart"; -import testOverrideInfo from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart"; +import testingOriginalTestFlutter from "!!raw-loader!/docs/cookbooks/testing_original_test_flutter.dart"; +import testingOriginalTestDart from "!!raw-loader!/docs/cookbooks/testing_original_test_dart.dart"; +import repositorySnippet from "!!raw-loader!/docs/cookbooks/testing_repository.dart"; +import testFlutter from "!!raw-loader!/docs/cookbooks/testing_flutter.dart"; +import testDart from "!!raw-loader!/docs/cookbooks/testing_dart.dart"; +import testFull from "!!raw-loader!/docs/cookbooks/testing_full.dart"; +import testOverrideInfo from "!!raw-loader!/docs/cookbooks/testing_override_info.dart"; import { trimSnippet } from "../../../../../src/components/CodeSnippet"; -중, 대규모 애플리케이션에서 테스트는 중요한 작업입니다. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + +For any medium to large-scale applications, it is critical to test the application. -우리의 앱을 성공적으로 테스트하기 위해서 아래의 몇가지 포인트를 생각해 보아야합니다. +To successfully test our application, we will want the following things: -- `test`/`testWidgets`간 상태를 공유하지 않습니다. - 이것은 글로벌 상태를 가지지 않은 앱 또는 모든 글로벌 상태들이 테스트 후에 초기화됨을 의미합니다. +- No state should be preserved between `test`/`testWidgets`. + That means no global state in the application, or all global states should reset after each test. -- 프로바이더에 특정한 상태를 가질 수 있도록 할 수 있는데, mocking 또는 조작을 통해 원하는 상태로 만들어 줄 수 있습니다. +- Being able to force our providers to have a specific state, either through + mocking or by manipulating them until we reach the desired state. -[Riverpod]의 기능을 어떻게 활용할 수 있는지 하나씩 확인해봅시다. +Let's see one by one how [Riverpod] helps you with these. -## `test`와`testWidgets`간 상태를 공유(보존)하지 않음. +## No state should be preserved between `test`/`testWidgets`. -당신은 프로바이더가 전역(글로벌)변수로서 선언되어 사용되기 때문에 이 부분을 걱정할 수 도 있습니다. -어쨋든, 전역 상태를 만들어 테스팅하는것은 `setUp`/`tearDown`이 많이 요구되기 때문에 매우 까다롭습니다. +Since providers are usually declared as global variables, you might worry about +that one. +After all, global state makes testing very difficult, because it can require +lengthy `setUp`/`tearDown`. -그러나 실제로는 프로바이더가 전역(상태변수)로서 선언되는 동안 프로바이더의 상태는 전역이**아닙니다**. +But the reality is: While providers are declared as globals, the state of a provider +is **not** global. -대신에, 상태들은 [ProviderContainer]의 객체 이름을 가지고 저장됩니다. -Dart만 사용하는 경우(dart-only)의 샘플 코드에서 [ProviderContainer]객체를 보셨을 수 있습니다. -만약 모르고 있었다면 [ProviderContainer] 객체는 암묵적으로 우리의 프로젝트에서 [Riverpod]을 사용하기위해 -사용하는 위젯 [ProviderScope]에 의해 생성됩니다. +Instead, it is stored in an object named [ProviderContainer], which you may have +seen if you looked at the dart-only examples. +If you haven't, know that this [ProviderContainer] object is implicitly created +by [ProviderScope], the widget that enables [Riverpod] on our project. -구체적으로, 상태가 글로벌(전역)이 아니라는 것은 프로바이더를 사용하는 2개의 `testWidgets` 간 상태는 공유되지 않습니다. -엄밀히 말해서 `setUp`/`tearDown`을 모두 필요로 하지 않습니다. +Concretely what this means is, two `testWidgets` using providers do not share +any state. +As such, there is no need for any `setUp`/`tearDown` at all. -길게 설정하는것보다 예제로 확인해보도록 합시다. +But an example is better than lengthy explanations: -보았듯이 `counterProvider`가 전역상태번수로 선언되어 있음에도 테스트 간 상태는 공유되지 않습니다. -그래서 우리는 각각의 테스트가 독립된 환경에서 실행되지 때문에 실행순서에 따라 테스트 결과가 달라지는 것을 걱정하지 않아도 됩니다. - -## 테스트 하는동안 프로바이더의 동작을 오버라이딩 하는 경우. +As you can see, while `counterProvider` was declared as a global, no state was +shared between tests. +As such, we do not have to worry about our tests potentially behaving differently +if executed in a different order, since they are running in complete isolation. -통상적인 현실세계의 애플리케이션은 아래와 같은 객체를 가지고 있다고 생각합니다. +## Overriding the behavior of a provider during tests. A common real-world application may have the following objects: -- 타입세이프(a type-safe)와 HTTP 요청 수행 기능을 제공하는 `Repository` 클래스를 가지고 있습니다. +- It will have a `Repository` class, which provides a type-safe and simple API + to perform HTTP requests. -- 앱 상태를 관리하고 `Repository`를 사용해 다양한 조건을 기반으로 한 HTTP 요청을 수행하는 객체를 가지고 있습니다. 이것은 아마도 `ChangeNotifier`, `Bloc` 또는 프로바이더 일것입니다. +- An object that manages the application state, and may use `Repository` to perform + HTTP requests based on different factors. + This may be a `ChangeNotifier`, `Bloc`, or even a provider. -[Riverpod]을 사용하면 아래와 같이 표현 할 수 있습니다. +Using [Riverpod], this may be represented as follows: {trimSnippet(repositorySnippet)} -이 상황에서는 a unit/widget test를 만들때, `Repository` 인스턴스를 실제 HTTP요청 대신에 사전 정의된 응답을 반환하는 fake 구현 레포지토리로 대체합니다. -`todoListProvider` 또는 `Repository`의 구현된 mock과 동등한 객체를 사용합니다. +In this situation, when making a unit/widget test, we will typically want to +replace our `Repository` instance with a fake implementation that returns +a pre-defined response instead of making a real HTTP request. -이를 달성하기위해서, `repositoryProvider`의 행위를 오버라이드 하기위해 [ProviderScope]/[ProviderContainer]의 `overrides` 파라미터를 사용할 수 있습니다. +We will then want our `todoListProvider` or equivalent to use the mocked implementation +of `Repository`. + +To achieve this, we can use the `overrides` parameter of [ProviderScope]/[ProviderContainer] +to override the behavior of `repositoryProvider`: -하이라이트된 코드를 확인해보면, [ProviderScope]/[ProviderContainer]는 다른 동작을 하는 프로바이더의 구현체로 교체할 수 있는것을 허용합니다. - +As you can see by the highlighted code, [ProviderScope]/[ProviderContainer] +allows replacing the implementation of a provider with a different behavior. :::info -프로바이더에 따라 프로바이더가 가지는 동작을 오버라이드하기 위해 간단한 방법을 노출합니다. -예를 들어 [FutureProvider]는 `AsyncValue`와 함께 프로바이더를 오버라이딩 할 수 있습니다. +Some providers expose simplified ways to override their behavior. +For example, [FutureProvider] allows overriding the provider with an `AsyncValue`: {trimSnippet(testOverrideInfo)} +**Note**: As part of the 2.0.0 release, `overrideWithValue` methods are temporarily +removed. They will be added back in later versions. + ::: :::info -프로바이더를 오버라이딩하기 위해 사용하는 `family` 수식자와 구문이 조금 차이가 있습니다. +The syntax for overriding a provider with the `family` modifier is slightly different. -만약 아래와 같이 프로바이더를 사용한다면 +If you used a provider like this: ```dart final response = ref.watch(myProvider('12345')); ``` -아래와 같이 프로바이더를 오버라이드할 수 있습니다. +You could override the provider as: ```dart myProvider('12345').overrideWithValue(...)); @@ -130,9 +152,9 @@ myProvider('12345').overrideWithValue(...)); ::: -## 모든 위젯 테스트 예제 Full widget test example +## Full widget test example -마지막으로 위의 내용을 정리한 모든 테스트 코드를 확인해봅시다. +Wrapping up, here is the entire full code for our Flutter test. {trimSnippet(testFull)} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart index ec0c951cf..2d25bb8e8 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart @@ -16,36 +16,36 @@ final todoListProvider = FutureProvider>((ref) => []); void main() { /* SNIPPET START */ - test('override repositoryProvider', () async { - final container = ProviderContainer( - overrides: [ - // repositoryProvider의 행위를 오버라이드하여 - // Repository 대신 FakeRepository를 반환합니다. - /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) - /* highlight-end */ - // 오버라이드된 repositoryProvider를 자동적으로 사용하기 때문에 - // `todoListProvider`를 override하지 않아도 됩니다. - ], - ); - - // 처음 상태가 로딩중임을 확인합니다. - expect( - container.read(todoListProvider), - const AsyncValue>.loading(), - ); - - /// 요청이 종료될때까지 대기합니다. - await container.read(todoListProvider.future); - - // 취득된 데이터를 노출시킵니다. - expect(container.read(todoListProvider).value, [ - isA() - .having((s) => s.id, 'id', '42') - .having((s) => s.label, 'label', 'Hello world') - .having((s) => s.completed, 'completed', false), - ]); - }); +test('override repositoryProvider', () async { + final container = ProviderContainer( + overrides: [ + // Override the behavior of repositoryProvider to return + // FakeRepository instead of Repository. + /* highlight-start */ + repositoryProvider.overrideWithValue(FakeRepository()) + /* highlight-end */ + // We do not have to override `todoListProvider`, it will automatically + // use the overridden repositoryProvider + ], + ); + + // The first read if the loading state + expect( + container.read(todoListProvider), + const AsyncValue>.loading(), + ); + + /// Wait for the request to finish + await container.read(todoListProvider.future); + + // Exposes the data fetched + expect(container.read(todoListProvider).value, [ + isA() + .having((s) => s.id, 'id', '42') + .having((s) => s.label, 'label', 'Hello world') + .having((s) => s.completed, 'completed', false), + ]); +}); /* SNIPPET END */ } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart index eb475ff23..6685a1bdb 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -19,22 +19,22 @@ class FakeRepository {} void main() { /* SNIPPET START */ - testWidgets('override repositoryProvider', (tester) async { - await tester.pumpWidget( - ProviderScope( - overrides: [ - // repositoryProvider의 행위를 오버라이드하여 - // Repository 대신 FakeRepository를 반환합니다. - /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()) - /* highlight-end */ - // 오버라이드된 repositoryProvider를 자동적으로 사용하기 때문에 - // `todoListProvider`를 override하지 않아도 됩니다. - ], - child: MyApp(), - ), - ); - }); +testWidgets('override repositoryProvider', (tester) async { + await tester.pumpWidget( + ProviderScope( + overrides: [ + // Override the behavior of repositoryProvider to return + // FakeRepository instead of Repository. + /* highlight-start */ + repositoryProvider.overrideWithValue(FakeRepository()) + /* highlight-end */ + // We do not have to override `todoListProvider`, it will automatically + // use the overridden repositoryProvider + ], + child: MyApp(), + ), + ); +}); /* SNIPPET END */ } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index 8b290d56d..0f79b4ee8 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -1,3 +1,4 @@ + import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_test/flutter_test.dart'; @@ -18,20 +19,20 @@ class Todo { final bool completed; } -// Repository를 사용하는 프로바이더 인스턴스 +// We expose our instance of Repository in a provider final repositoryProvider = Provider((ref) => Repository()); -/// 할일(Todo) 목록 -/// [Repository]를 사용하여 서버로부터 값을 취득하는 FutureProvider 인스턴스 +/// The list of todos. Here, we are simply fetching them from the server using +/// [Repository] and doing nothing else. final todoListProvider = FutureProvider((ref) async { - // Repository 인스턴스를 취득합니다. + // Obtains the Repository instance final repository = ref.read(repositoryProvider); - // Todo 목록을 가져오고 이를 UI에 노출시킵니다. + // Fetch the todos and expose them to the UI. return repository.fetchTodos(); }); -/// 레포지토리의 Mock 구현: 사전 정의된 할일 목록을 반환하는 역할 +/// A mocked implementation of Repository that returns a pre-defined list of todos class FakeRepository implements Repository { @override Future> fetchTodos() async { @@ -54,14 +55,16 @@ void main() { testWidgets('override repositoryProvider', (tester) async { await tester.pumpWidget( ProviderScope( - overrides: [repositoryProvider.overrideWithValue(FakeRepository())], - // todoListProvider로부터 상태 값을 읽어 todo 목록을 표시하는 앱 - // MyApp 위젯으로도 가능. + overrides: [ + repositoryProvider.overrideWithValue(FakeRepository()) + ], + // Our application, which will read from todoListProvider to display the todo-list. + // You may extract this into a MyApp widget child: MaterialApp( home: Scaffold( body: Consumer(builder: (context, ref, _) { final todos = ref.watch(todoListProvider); - // 할일 목록이 로딩 중이거나 에러가 발생했을 때의 대응 + // The list of todos is loading or in error if (todos.asData == null) { return const CircularProgressIndicator(); } @@ -76,17 +79,16 @@ void main() { ), ); - // 처음 프레임 상태가 로딩중임을 확인. + // The first frame is a loading state. expect(find.byType(CircularProgressIndicator), findsOneWidget); - // 재 렌더링을 수행 - // (TodoListProvider가 할일 목록을 가져오기를 끝냈을 것이라 예상) + // Re-render. TodoListProvider should have finished fetching the todos by now await tester.pump(); - // CircularProgressIndicator을 찾아 loading 상태인지 확인 . + // No longer loading expect(find.byType(CircularProgressIndicator), findsNothing); - // FakeRepository가 반환한 값이 1개의 TodoItem으로 렌더링되었는지 확인. + // Rendered one TodoItem with the data returned by FakeRepository expect(tester.widgetList(find.byType(TodoItem)), [ isA() .having((s) => s.todo.id, 'todo.id', '42') @@ -94,4 +96,4 @@ void main() { .having((s) => s.todo.completed, 'todo.completed', false), ]); }); -} +} \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart index 215bb7951..6995de9b8 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart @@ -4,48 +4,48 @@ import 'package:riverpod/riverpod.dart'; /* SNIPPET START */ -// Dart만을 사용하여 구현된 카운터 앱을 테스트해봅시다. (플러터에 의존하지 않은 앱) +// A Counter implemented and tested with Dart only (no dependency on Flutter) -// provider를 전역변수로 선언하합니다. 그리고 만약 테스트간 상태가 `0`으로 초기화 되는것을 -// 확인하기 위한 2개의 테스트를 실행해볼겁니다. +// We declared a provider globally, and we will use it in two tests, to see +// if the state correctly resets to `0` between tests. final counterProvider = StateProvider((ref) => 0); -// mockito를 사용하여 프로바이더가 notify할 때의 값을 추적하기 위한 listeners 객체를 생성합니다. +// Using mockito to keep track of when a provider notify its listeners class Listener extends Mock { void call(int? previous, int value); } void main() { test('defaults to 0 and notify listeners when value changes', () { - // 프로바이더를 사용하기위한 객체 - // 테스트간 공유되지 않습니다. + // An object that will allow us to read providers + // Do not share this between tests. final container = ProviderContainer(); addTearDown(container.dispose); final listener = Listener(); - // 프로바이더를 관찰하고 값 변화를 검출합니다. + // Observe a provider and spy the changes. container.listen( counterProvider, listener.call, fireImmediately: true, ); - // 리스너는 0을 기본값으로 호출됩니다. + // the listener is called immediately with 0, the default value verify(listener(null, 0)).called(1); verifyNoMoreInteractions(listener); - // 여기서 상태 값을 증가시켜 봅니다. + // We increment the value container.read(counterProvider.notifier).state++; - // 리스터는 다시 호출되고 상태 값은 1을 가집니다. + // The listener was called again, but with 1 this time verify(listener(0, 1)).called(1); verifyNoMoreInteractions(listener); }); test('the counter state is not shared between tests', () { - // 프로바이더를 사용하기 위해 다른 ProviderContainer를 사용합니다. - // 이걸로 테스트간 상태를 재사용하지 않는것을 확인할 수 있습니다. + // We use a different ProviderContainer to read our provider. + // This ensure that no state is reused between tests final container = ProviderContainer(); addTearDown(container.dispose); final listener = Listener(); @@ -56,7 +56,7 @@ void main() { fireImmediately: true, ); - // 새로운 테스트는 기본 값을 0으로 가진 상태를 출력하는 것을 확인할 수 있습니다. + // The new test correctly uses the default value: 0 verify(listener(null, 0)).called(1); verifyNoMoreInteractions(listener); }); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart index 60b545a5d..f76abe181 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -6,13 +6,14 @@ import 'package:flutter_test/flutter_test.dart'; /* SNIPPET START */ -// 플러터를 사용해 구현된 카운터 앱 테스트 하기 +// A Counter implemented and tested using Flutter + +// We declared a provider globally, and we will use it in two tests, to see +// if the state correctly resets to `0` between tests. -// provider를 전역변수로 선언하합니다. 그리고 만약 테스트간 상태가 `0`으로 초기화 되는것을 -// 확인하기 위한 2개의 테스트를 실행해볼겁니다. final counterProvider = StateProvider((ref) => 0); -// 현재의 상태값과 버튼을 누르면 상태가 값이 증가하는 기능을 가지는 화면을 생성합니다. +// Renders the current state and a button that allows incrementing the state class MyApp extends StatelessWidget { @override Widget build(BuildContext context) { @@ -32,16 +33,15 @@ void main() { testWidgets('update the UI when incrementing the state', (tester) async { await tester.pumpWidget(ProviderScope(child: MyApp())); - // 프로바이더에서 선언한 그대로 기본값은 `0`입니다. + // The default value is `0`, as declared in our provider expect(find.text('0'), findsOneWidget); expect(find.text('1'), findsNothing); - // ElevatedButton를 찾아 탭을 수행하여 상태를 증가시킵니다. - // 그리고 다시 랜더링을 실행합니다. + // Increment the state and re-render await tester.tap(find.byType(ElevatedButton)); await tester.pump(); - // 상태가 적절하게 증가되어 있는지 확인합니다. + // The state have properly incremented expect(find.text('1'), findsOneWidget); expect(find.text('0'), findsNothing); }); @@ -49,8 +49,7 @@ void main() { testWidgets('the counter state is not shared between tests', (tester) async { await tester.pumpWidget(ProviderScope(child: MyApp())); - // 상태가 공유되어있지 않기떄문에 다시 `0`값을 가집니다. - // tearDown/setUp 작업이 필요없습니다. + // The state is `0` once again, with no tearDown/setUp needed expect(find.text('0'), findsOneWidget); expect(find.text('1'), findsNothing); }); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart index 8ad1eca93..d71ae3c69 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart @@ -34,7 +34,7 @@ final foo = /* SKIP END */ ProviderScope( overrides: [ - /// 고정된 값을 반환하기 위해 FutureProvider를 오버라이딩 합니다. + /// Allows overriding a FutureProvider to return a fixed value todoListProvider.overrideWithValue( AsyncValue.data([Todo(id: '42', label: 'Hello', completed: true)]), ), diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart index 820147057..c499279fc 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart @@ -8,15 +8,15 @@ class Repository { Future> fetchTodos() async => []; } -// 프로바이더안에 레포지토리의 인스턴스를 노출합니다. +// We expose our instance of Repository in a provider final repositoryProvider = Provider((ref) => Repository()); -/// Todo의 목록 -/// 여기 [Repository]를 사용하여 서버로부터 값을 가져오고 있습니다. +/// The list of todos. Here, we are simply fetching them from the server using +/// [Repository] and doing nothing else. final todoListProvider = FutureProvider((ref) async { - // Repository 인스턴스를 생성합니다. + // Obtains the Repository instance final repository = ref.watch(repositoryProvider); - // Todo 목록을 취득하고 UI에 노출시킵니다. + // Fetch the todos and expose them to the UI. return repository.fetchTodos(); }); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx new file mode 100644 index 000000000..e3f1407da --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx @@ -0,0 +1,153 @@ +--- +title: "캐시 지우기 및 상태 폐기(disposal)에 반응하기" +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import onDisposeExample from "./auto_dispose/on_dispose_example"; +import codegenKeepAlive from "!!raw-loader!./auto_dispose/codegen_keep_alive.dart"; +import rawAutoDispose from "!!raw-loader!./auto_dispose/raw_auto_dispose.dart"; +import invalidateExample from "!!raw-loader!./auto_dispose/invalidate_example.dart"; +import keepAlive from "./auto_dispose/keep_alive"; +import cacheForExtension from "!!raw-loader!./auto_dispose/cache_for_extension.dart"; +import cacheForUsage from "./auto_dispose/cache_for_usage"; +import invalidateFamilyExample from './auto_dispose/invalidate_family_example' + +지금까지 일부 상태(state)를 생성하거나 업데이트하는 방법을 살펴보았습니다. +하지만 언제 상태가 소멸(destruction)되는지에 대해서는 아직 이야기하지 않았습니다. + +Riverpod은 상태 폐기(disposal)와 상호작용할 수 있는 다양한 방법을 제공합니다. +여기에는 상태 폐기를 지연(delaying)시키는 것부터 소멸에 반응하는 것까지 다양합니다. + +## 상태는 언제 파괴되며, 그 것을 어떻게 변경하나요? + + + +코드 생성(code-generation)을 사용할 때 기본적으로 provider가 수신이 중지되면 상태가 파괴됩니다. +이는 리스너에 전체 프레임에 대한 활성 리스너가 없을 때 발생합니다. 이 경우 상태가 소멸됩니다. + +이 동작은 `keepAlive: true`를 사용하여 해제(opted out)할 수 있습니다. +이렇게 하면 모든 리스너가 제거될 때 상태가 소멸되는 것을 방지할 수 있습니다. + + + + + + + +코드 생성을 사용하지 않는 경우 기본적으로 provider의 수신이 중단되어도 상태는 파괴되지 않습니다. + +선택적으로 이 동작을 변경하여 자동 폐기를 사용할 수 있습니다. +그렇게 하면, Riverpod은 provider에 리스너가 있는지 여부를 추적합니다. +그런 다음 provider에 전체 프레임에 대한 리스너가 없는 경우 상태가 삭제됩니다. + +자동 폐기를 활성화하려면 provider 타입 옆에 `.autoDispose`를 사용하면 됩니다: + + + + + +:::note +자동 폐기를 활성화/비활성화해도 provider가 다시 계산될 때 상태가 소멸되는지 여부에는 영향을 미치지 않습니다. +provider가 다시 계산될 때 상태는 항상 소멸(destroyed)됩니다. +::: + +:::caution +provider가 매개변수를 받을 때 자동 폐기를 활성화하는 것이 좋습니다. +그렇지 않으면 매개변수 조합당 하나의 상태가 생성되어 메모리 누수가 발생할 수 있기 때문입니다. +::: + +## 상태 폐기(disposal)에 대한 반응 + +Riverpod에는 상태를 파기하는 몇 가지 기본 제공 방법이 있습니다: + +- provider가 더 이상 사용되지 않고 "auto dispose" 모드에 있는 경우(자세한 내용은 나중에 설명). + 이 경우 provider와 관련된 모든 상태가 소멸됩니다. +- `ref.watch`와 같이 provider가 다시 계산됩니다. + 이 경우 이전 상태가 폐기되고 새 상태가 생성됩니다. + +두 경우 모두. 이 경우 몇 가지 로직을 실행하고 싶을 수 있습니다. +이는 `ref.onDispose`로 가능합니다. 이 메서드를 사용하면 상태가 소멸될 때마다 리스너를 등록할 수 있습니다. + +예를 들어, 이 메서드를 사용해 활성화된 `StreamController`를 닫을 수 있습니다: + + + +:::caution +`ref.onDispose`의 콜백은 부작용을 유발하지 않아야 합니다. +`onDispose` 내에서 프로바이더를 수정하면 예기치 않은 동작이 발생할 수 있습니다. +::: + +:::info +다음과 같은 다른 유용한 수명 주기(life-cycles)가 있습니다: + +- provider의 마지막 리스너가 제거될 때 호출되는 `ref.onCancel`. +- `onCancel`이 호출된 후 새 리스너가 추가될 때 호출되는 `ref.onResume`. + +::: + +:::info +`ref.onDispose`는 원하는 횟수만큼 호출할 수 있습니다. +provider의 Disposable 객체당 한 번씩 호출해도 됩니다. +이렇게 하면 물건을 버리는 것(dispose of something)을 잊어버렸을 때 쉽게 알아차릴 수 있습니다. +::: + +## `ref.invalidate`를 사용하여 provider를 수동으로 강제 삭제하기 + +때로는 provider를 강제로 파괴하고 싶을 때가 있습니다. +다른 provider나 위젯에서 호출할 수 있는 `ref.invalidate`를 사용하면 이 작업을 수행할 수 있습니다. + +`ref.invalidate`를 사용하면 현재 provider 상태가 파괴됩니다. +그러면 두 가지 결과가 발생할 수 있습니다: + +- provider가 청취되고 있으면 새 상태가 생성됩니다. +- provider를 청취되고 있지 않으면 provider가 완전히 소멸됩니다. + + + +:::info +provider가 `ref.invalidateSelf`를 사용하여 스스로 무효화할 수 있습니다. +이 경우 항상 새로운 상태가 생성됩니다. +::: + +:::tip +매개변수를 수신하는 provider를 무효화하려고 할 때, +특정 매개변수 조합 하나를 무효화하거나 모든 매개변수 조합을 한 번에 무효화할 수 있습니다: + + +::: + +## `ref.keepAlive`를 사용하여 폐기(disposal)를 조정하기 + +위에서 언급했듯이 자동 폐기를 사용하도록 설정하면 provider에 전체 프레임에 대한 리스너가 없는 경우 상태가 삭제됩니다. + +하지만 이 동작을 보다 세밀하게 제어하고 싶을 수도 있습니다. +예를 들어, 성공한 네트워크 요청의 상태는 유지하되 실패한 요청은 캐시하지 않으려 할 수 있습니다. + +이는 자동 폐기를 활성화한 후 `ref.keepAlive`를 사용하면 가능합니다. +이 함수를 사용하면 상태의 자동 폐기를 중지하는 _시점_을 결정할 수 있습니다. + + + +:::note +provider가 다시 계산되면 자동 폐기가 다시 활성화됩니다. + +`ref.keepAlive`의 반환 값을 사용하여 자동 폐기로 되돌릴 수도 있습니다. +::: + +## 예: 특정 시간 동안 상태를 살아있게 유지하기 + +현재 Riverpod은 특정 시간 동안 상태를 유지하는 내장된 방법을 제공하지 않습니다. +하지만 지금까지 살펴본 도구를 사용하면 이러한 기능을 쉽게 구현하고 재사용할 수 있습니다. + +`Timer` + `ref.keepAlive`를 사용하면 특정 시간 동안 상태를 유지할 수 있습니다. +이 로직을 재사용할 수 있게 하려면 확장 메서드(extension method)로 구현하면 됩니다: + + + +그러면 이렇게 사용할 수 있습니다: + + + +이 로직은 필요에 맞게 조정할 수 있습니다. +예를 들어 `ref.onCancel`/`ref.onResume`을 사용하여 특정 시간 동안 공급자가 수신 대기하지 않은 경우에만 상태를 삭제할 수 있습니다. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart new file mode 100644 index 000000000..6ea5d7fef --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart @@ -0,0 +1,17 @@ +import 'dart:async'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +extension CacheForExtension on AutoDisposeRef { + /// [duration]동안 공급자를 살아있게 유지합니다. + void cacheFor(Duration duration) { + // 상태가 파괴되는 것을 즉시 방지합니다. + final link = keepAlive(); + // 기간이 경과하면 자동 폐기를 다시 활성화합니다. + final timer = Timer(duration, link.close); + + // 선택 사항: provider가 다시 계산되면(예: ref.watch 사용) 보류 중인 타이머를 취소합니다. + onDispose(timer.cancel); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart new file mode 100644 index 000000000..db007483d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart @@ -0,0 +1,17 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../cache_for_extension.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future example(ExampleRef ref) async { + /// 5분 동안 상태를 유지합니다. + ref.cacheFor(const Duration(minutes: 5)); + + return http.get(Uri.https('example.com')); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart new file mode 100644 index 000000000..98fd6ea63 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'3ff29b1cd8fa864286a2a04e39adf1c8589b4275'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeFutureProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart new file mode 100644 index 000000000..2a2cf358a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart @@ -0,0 +1,15 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../cache_for_extension.dart'; + +/* SNIPPET START */ +final provider = FutureProvider.autoDispose((ref) async { + /// Keeps the state alive for 5 minutes + ref.cacheFor(const Duration(minutes: 5)); + + return http.get(Uri.https('example.com')); +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart new file mode 100644 index 000000000..d3a3536c4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart @@ -0,0 +1,11 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_keep_alive.g.dart'; + +/* SNIPPET START */ +// 어노테이션에 "keepAlive"를 지정하여 +// 자동 상태 소멸을 비활성화할 수 있습니다. +@Riverpod(keepAlive: true) +int example(ExampleRef ref) { + return 0; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart new file mode 100644 index 000000000..854d2df27 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_keep_alive.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'78f9426f6cbda80564387a9db8cd02368d890a85'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = Provider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = ProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart new file mode 100644 index 000000000..09390ff9e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart @@ -0,0 +1,23 @@ +// ignore_for_file: use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +// 자동 상태 소멸을 활성화하려면 autoDispose를 지정할 수 있습니다. +final someProvider = Provider.autoDispose((ref) { + return 0; +}); + +/* SNIPPET START */ +class MyWidget extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return ElevatedButton( + onPressed: () { + // 클릭 시 공급자를 삭제합니다. + ref.invalidate(someProvider); + }, + child: const Text('dispose a provider'), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart new file mode 100644 index 000000000..9ce0d96b8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +late WidgetRef ref; + +/* SNIPPET START */ +@riverpod +String label(LabelRef ref, String userName) { + return 'Hello $userName'; +} + +// ... + +void onTap() { + // 이 provider의 가능한 모든 매개변수 조합을 무효화합니다. + ref.invalidate(labelProvider); + // 특정 조합만 무효화 + ref.invalidate(labelProvider('John')); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart new file mode 100644 index 000000000..410c48677 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -0,0 +1,200 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$labelHash() => r'20aa8ce0231205540f466f91259732bd86953c64'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [label]. +@ProviderFor(label) +const labelProvider = LabelFamily(); + +/// See also [label]. +class LabelFamily extends Family { + /// See also [label]. + const LabelFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'labelProvider'; + + /// See also [label]. + LabelProvider call( + String userName, + ) { + return LabelProvider( + userName, + ); + } + + @visibleForOverriding + @override + LabelProvider getProviderOverride( + covariant LabelProvider provider, + ) { + return call( + provider.userName, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(String Function(LabelRef ref) create) { + return _$LabelFamilyOverride(this, create); + } +} + +class _$LabelFamilyOverride implements FamilyOverride { + _$LabelFamilyOverride(this.overriddenFamily, this.create); + + final String Function(LabelRef ref) create; + + @override + final LabelFamily overriddenFamily; + + @override + LabelProvider getProviderOverride( + covariant LabelProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [label]. +class LabelProvider extends AutoDisposeProvider { + /// See also [label]. + LabelProvider( + String userName, + ) : this._internal( + (ref) => label( + ref as LabelRef, + userName, + ), + from: labelProvider, + name: r'labelProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$labelHash, + dependencies: LabelFamily._dependencies, + allTransitiveDependencies: LabelFamily._allTransitiveDependencies, + userName: userName, + ); + + LabelProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.userName, + }) : super.internal(); + + final String userName; + + @override + Override overrideWith( + String Function(LabelRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: LabelProvider._internal( + (ref) => create(ref as LabelRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + userName: userName, + ), + ); + } + + @override + (String,) get argument { + return (userName,); + } + + @override + AutoDisposeProviderElement createElement() { + return _LabelProviderElement(this); + } + + LabelProvider _copyWith( + String Function(LabelRef ref) create, + ) { + return LabelProvider._internal( + (ref) => create(ref as LabelRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + userName: userName, + ); + } + + @override + bool operator ==(Object other) { + return other is LabelProvider && other.userName == userName; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, userName.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin LabelRef on AutoDisposeProviderRef { + /// The parameter `userName` of this provider. + String get userName; +} + +class _LabelProviderElement extends AutoDisposeProviderElement + with LabelRef { + _LabelProviderElement(super.provider); + + @override + String get userName => (origin as LabelProvider).userName; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart new file mode 100644 index 000000000..1f3164bfb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart @@ -0,0 +1,20 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +late WidgetRef ref; + +/* SNIPPET START */ +final provider = Provider.autoDispose.family((ref, name) { + return 'Hello $name'; +}); + +// ... + +void onTap() { + // Invalidate all possible parameter combinations of this provider. + ref.invalidate(provider); + // Invalidate a specific combination only + ref.invalidate(provider('John')); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart new file mode 100644 index 000000000..1828451dc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart @@ -0,0 +1,20 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future example(ExampleRef ref) async { + final response = await http.get(Uri.parse('https://example.com')); + // 요청이 성공적으로 완료된 후에만 프로바이더를 살아있게 유지합니다. + // 요청이 실패한 경우(그리고 throw된 경우), 공급자에 청취를 중단하면 상태가 소멸됩니다. + ref.keepAlive(); + + // `link`를 사용하여 자동 폐기 동작을 복원할 수 있습니다: + // link.close(); + + return response.body; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart new file mode 100644 index 000000000..bf38010f2 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'4fa856c55e84da9525dcecfab1c897e61456325b'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeFutureProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart new file mode 100644 index 000000000..f0fc6a3ba --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart @@ -0,0 +1,19 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +final provider = FutureProvider.autoDispose((ref) async { + final response = await http.get(Uri.parse('https://example.com')); + // We keep the provider alive only after the request has successfully completed. + // If the request failed (and threw an exception), then when the provider stops being + // listened to, the state will be destroyed. + final link = ref.keepAlive(); + + // We can use the `link` to restore the auto-dispose behavior with: + // link.close(); + + return response.body; +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart new file mode 100644 index 000000000..013988467 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable + +import 'dart:async'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +Stream example(ExampleRef ref) { + final controller = StreamController(); + + // 상태가 소멸되면 StreamController를 닫습니다. + ref.onDispose(controller.close); + + // TO-DO: StreamController의 값들을 푸시합니다. + return controller.stream; +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart new file mode 100644 index 000000000..448c6784e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +/// See also [other]. +@ProviderFor(other) +final otherProvider = AutoDisposeProvider.internal( + other, + name: r'otherProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$otherHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef OtherRef = AutoDisposeProviderRef; +String _$exampleHash() => r'29f92958e0d0e3f13ac033e92cd2e4072339c7db'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeStreamProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeStreamProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart new file mode 100644 index 000000000..4e4940777 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart @@ -0,0 +1,17 @@ +// ignore_for_file: unused_local_variable + +import 'dart:async'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +final provider = StreamProvider((ref) { + final controller = StreamController(); + + // When the state is destroyed, we close the StreamController. + ref.onDispose(controller.close); + + // TO-DO: Push some values in the StreamController + return controller.stream; +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart new file mode 100644 index 000000000..e6746e2a0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart @@ -0,0 +1,7 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +// 자동 상태 소멸을 활성화하려면 autoDispose를 지정할 수 있습니다. +final provider = Provider.autoDispose((ref) { + return 0; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx new file mode 100644 index 000000000..ede4c45d0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx @@ -0,0 +1,126 @@ +--- +title: 요청 결합하기 +version: 1 +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; +import functionalRef from "./combining_requests/functional_ref"; +import notifierRef from "./combining_requests/notifier_ref"; +import watchExample from "./combining_requests/watch_example"; +import watchPlacement from "./combining_requests/watch_placement"; +import listenExample from "./combining_requests/listen_example"; +import readExample from './combining_requests/read_example' + +지금까지는 요청이 서로 독립적인 경우만 보았습니다. +하지만 일반적인 사용 사례는 다른 요청의 결과에 따라 요청을 트리거해야 하는 경우입니다. + +이를 위해 provider의 결과를 다른 provider에게 매개변수(parameter)로 전달하여 메커니즘을 _사용할 수_ 있습니다. + +하지만 이 접근 방식에는 몇 가지 단점이 있습니다: + +- 구현 세부 정보가 유출(leaks)됩니다. + 이제 UI는 다른 provider가 사용하는 모든 providers에 대해 알아야 합니다. +- 매개변수(parameter)가 변경될 때마다 완전히 새로운 상태가 만들어집니다. + 매개변수를 전달하면 매개변수가 변경될 때 이전 상태를 유지할 수 있는 방법이 없습니다. +- 요청을 결합(combining requests)하기가 더 어려워집니다. +- 따라서 툴링의 유용성이 떨어집니다. 개발 도구는 providers 간의 관계에 대해 알 수 없습니다. + +이를 개선하기 위해 Riverpod은 요청을 결합하는 다른 접근 방식을 제공합니다. + +## 기본 사항: "ref" 획득하기 + +요청을 결합하는 모든 방법에는 한 가지 공통점이 있습니다. 모두 `Ref` 객체를 기반으로 한다는 점입니다. + +`Ref` 객체는 모든 providers가 접근할 수 있는 객체입니다. +이 객체는 다양한 라이프사이클 리스너에 대한 액세스 권한을 부여할 뿐만 아니라, providers를 결합하는 다양한 메서드도 제공합니다. + +`Ref`를 얻을 수 있는 위치는 provider 타입에 따라 다릅니다. + +함수형 provider의 경우, `Ref`는 provider의 함수에 매개변수로 전달됩니다: + + + +클래스 변형에서 `Ref`는 Notifier 클래스의 속성입니다: + + + +## ref를 사용하여 provider를 읽습니다. + +## `ref.watch` 메소드 + +이제 `Ref`를 얻었으므로 이를 사용하여 요청을 결합할 수 있습니다. +이를 수행하는 주된 방법은 `ref.watch`를 사용하는 것입니다. +일반적으로 유지 관리가 더 쉽기 때문에 일반적으로 다른 옵션보다 `ref.watch`를 사용할 수 있도록 코드를 설계하는 것이 좋습니다. + + +`ref.watch` 메서드는 provider를 받아 현재 상태를 반환합니다. +그러면 리스닝된 provider가 변경될 때마다 provider가 무효화(invalidated)되고 다음 프레임 또는 다음 읽기(read) 시 다시 빌드됩니다. + +`ref.watch`를 사용하면 로직이 "reactive"이면서 "declarative"이게 됩니다. +즉, 필요할 때 로직이 자동으로 다시 계산(recompute)된다는 뜻입니다. +그리고 업데이트 메커니즘이 'on change'와 같은 부작용(side-effects)에 의존하지 않습니다. +이는 StatelessWidgets의 작동 방식과 유사합니다. + +예를 들어 사용자의 위치를 수신하는 provider를 정의할 수 있습니다. +그런 다음 이 위치를 사용하여 사용자 근처의 레스토랑 목록을 가져올 수 있습니다. + + + +:::info +수신 중인 provider가 변경되어 요청이 다시 계산되면 새 요청이 완료될 때까지 이전 상태가 유지됩니다. +동시에 요청이 보류(pending)되는 동안 "isLoading" 및 "isReloading" 플래그가 설정됩니다. + +이를 통해 UI에 이전 상태 또는 로딩 표시기를 표시하거나 둘 다 표시할 수 있습니다. +::: + +:::info +`ref.watch(locationProvider)` 대신 `ref.watch(locationProvider.future)`를 사용한 것을 주목하세요. +`locationProvider`가 비동기적이기 때문입니다. 따라서 초기 값을 사용할 수 있을 때까지 기다려야 합니다. + +이 `.future`를 생략하면 `locationProvider`의 현재 상태에 대한 스냅샷인 `AsyncValue`를 받게 됩니다. +하지만 아직 사용할 수 있는 위치가 없다면 아무 것도 할 수 없습니다. +::: + +:::caution +"명령형 문법(imperatively)"으로 실행되는 코드 내에서 `ref.watch`를 호출하는 것은 나쁜 습관으로 간주됩니다. +이는 provider의 빌드 단계에서 실행되지 않을 가능성이 있는 모든 코드를 의미합니다. +여기에는 "listener" 콜백(callbacks)이나 Notifier의 메서드가 포함됩니다: + + +::: + +## `ref.listen`/`listenSelf` 메소드 + +`ref.listen` 메서드는 `ref.watch`의 대안입니다. +이 메서드는 기존의 "listen"/"addListener" 메서드와 유사합니다. +이 메서드는 provider와 callback을 받으며, provider의 콘텐츠가 변경될 때마다 해당 callback을 호출합니다. + +`ref.listen` 대신 `ref.watch`를 사용할 수 있도록 코드를 리팩토링하는 것이 일반적으로 권장되는데, +전자는 명령형으로 인해 오류가 발생하기 쉽기 때문입니다. +하지만 `ref.listen`는 큰 리팩토링을 하지 않고도 빠른 로직을 추가하는 데 유용할 수 있습니다. + +`ref.watch` 예제를 다시 작성하여 `ref.listen`을 대신 사용할 수 있습니다. + + + +:::info +provider의 빌드 단계에서 `ref.listen`을 사용하는 것은 전적으로 안전합니다. +provider가 어떻게든 다시 계산되면 이전 리스너가 제거됩니다. + +또는 `ref.listen`의 반환 값을 사용하여 원할 때 리스너를 수동으로 제거할 수 있습니다. +::: + +## `ref.read` 메소드 + +마지막으로 사용할 수 있는 옵션은 `ref.read`입니다. +이 옵션은 provider의 현재 상태를 반환한다는 점에서 `ref.watch`와 유사합니다. +하지만 `ref.watch`와 달리 공급자를 수신(listen)하지 않습니다. + +따라서 `ref.read`는 Notifier의 메서드 내부와 같이 `ref.watch`를 사용할 수 없는 곳에서만 사용해야 합니다. + + + +:::caution +provider에서 `ref.read`를 사용할 때는 주의하세요. provider를 수신(listen)하지 않으므로, 해당 provider가 수신(listen)하지 않으면 상태(state)를 파괴(destroy할 수 있습니다. +::: diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart new file mode 100644 index 000000000..2d6aa1460 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart @@ -0,0 +1,18 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +int example(ExampleRef ref) { + // 다른 provider를 읽으려면 여기에서 "Ref"를 사용할 수 있습니다. + final otherValue = ref.watch(otherProvider); + + return 0; +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart new file mode 100644 index 000000000..8df442e58 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +/// See also [other]. +@ProviderFor(other) +final otherProvider = AutoDisposeProvider.internal( + other, + name: r'otherProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$otherHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef OtherRef = AutoDisposeProviderRef; +String _$exampleHash() => r'4429d7d3bb2b31fea4cc42c2f2af02d3f3d10693'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart new file mode 100644 index 000000000..19962d9cd --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart @@ -0,0 +1,14 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = Provider((ref) { + // "Ref" can be used here to read other providers + final otherValue = ref.watch(otherProvider); + + return 0; +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart new file mode 100644 index 000000000..25c6a2f37 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart @@ -0,0 +1,17 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +@riverpod +int example(ExampleRef ref) { + ref.listen(otherProvider, (previous, next) { + print('Changed from: $previous, next: $next'); + }); + + return 0; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart new file mode 100644 index 000000000..eb3006429 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'd614303f372e06e6ab96035affc4c07a53b28741'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart new file mode 100644 index 000000000..12b578dd0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart @@ -0,0 +1,13 @@ +// ignore_for_file: unused_local_variable, avoid_print +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = Provider((ref) { + ref.listen(otherProvider, (previous, next) { + print('Changed from: $previous, next: $next'); + }); + + return 0; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart new file mode 100644 index 000000000..1454617d1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart @@ -0,0 +1,21 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + int build() { + // 다른 provider를 읽으려면 여기에서 "Ref"를 사용할 수 있습니다. + final otherValue = ref.watch(otherProvider); + + return 0; + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart new file mode 100644 index 000000000..8109b649d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +/// See also [other]. +@ProviderFor(other) +final otherProvider = AutoDisposeProvider.internal( + other, + name: r'otherProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$otherHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef OtherRef = AutoDisposeProviderRef; +String _$exampleHash() => r'893db991b377b8e314e60c429043e5e81f1fd526'; + +/// See also [Example]. +@ProviderFor(Example) +final exampleProvider = AutoDisposeNotifierProvider.internal( + Example.new, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Example = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart new file mode 100644 index 000000000..d292fea5e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart @@ -0,0 +1,19 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = NotifierProvider(MyNotifier.new); + +class MyNotifier extends Notifier { + @override + int build() { + // "Ref" can be used here to read other providers + final otherValue = ref.watch(otherProvider); + + return 0; + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart new file mode 100644 index 000000000..fc46f5927 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // Bad! 여기서는 reactive가 아니므로 'read'를 사용하지 마세요. + ref.read(otherProvider); + + return 0; + } + + void increment() { + ref.read(otherProvider); // 여기서 'read'를 사용해도 괜찮습니다. + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart new file mode 100644 index 000000000..4bac3c78b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'353efe22dd5a91b2d036286211ac9e60c9de5f6d'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart new file mode 100644 index 000000000..e269310eb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final notifierProvider = NotifierProvider(MyNotifier.new); + +class MyNotifier extends Notifier { + @override + int build() { + // Bad! Do not use "read" here as it is not reactive + ref.read(otherProvider); + + return 0; + } + + void increment() { + ref.read(otherProvider); // Using "read" here is fine + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart new file mode 100644 index 000000000..2521721cb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart @@ -0,0 +1,43 @@ +// ignore_for_file: unused_local_variable + +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +final otherProvider = Provider((ref) => 0); + +const someStream = Stream<({double longitude, double latitude})>.empty(); + +/* SNIPPET START */ +@riverpod +Stream<({double longitude, double latitude})> location(LocationRef ref) { + // TO-DO: 현재 위치를 가져오는 Stream을 반환합니다. + return someStream; +} + +@riverpod +Future> restaurantsNearMe(RestaurantsNearMeRef ref) async { + // "ref.watch"를 사용하여 최신 위치를 가져옵니다. + // 공급자 뒤에 ".future"를 지정하면 코드가 적어도 하나의 위치를 사용할 수 있을 때까지 기다립니다. + final location = await ref.watch(locationProvider.future); + + // 이제 해당 위치를 기반으로 네트워크 요청을 할 수 있습니다. + // 예를 들어 Google 지도 API를 사용할 수 있습니다: + // https://developers.google.com/maps/documentation/places/web-service/search-nearby + final response = await http.get( + Uri.https('maps.googleapis.com', 'maps/api/place/nearbysearch/json', { + 'location': '${location.latitude},${location.longitude}', + 'radius': '1500', + 'type': 'restaurant', + 'key': '', + }), + ); + // JSON에서 레스토랑 이름 가져오기 + final json = jsonDecode(response.body) as Map; + final results = (json['results'] as List).cast>(); + return results.map((e) => e['name']! as String).toList(); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart new file mode 100644 index 000000000..2bf4a34f4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart @@ -0,0 +1,44 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$locationHash() => r'22e666f1e1ce04ce03d8f8d5652e25b54c1d1af3'; + +/// See also [location]. +@ProviderFor(location) +final locationProvider = + AutoDisposeStreamProvider<({double longitude, double latitude})>.internal( + location, + name: r'locationProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$locationHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef LocationRef + = AutoDisposeStreamProviderRef<({double longitude, double latitude})>; +String _$restaurantsNearMeHash() => r'dd49cc1e6f16abb34dd15286d171e322c06b93b8'; + +/// See also [restaurantsNearMe]. +@ProviderFor(restaurantsNearMe) +final restaurantsNearMeProvider = + AutoDisposeFutureProvider>.internal( + restaurantsNearMe, + name: r'restaurantsNearMeProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$restaurantsNearMeHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef RestaurantsNearMeRef = AutoDisposeFutureProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart new file mode 100644 index 000000000..f4e85466e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart @@ -0,0 +1,41 @@ +// ignore_for_file: unused_local_variable + +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +final otherProvider = Provider((ref) => 0); + +const someStream = Stream<({double longitude, double latitude})>.empty(); + +/* SNIPPET START */ +final locationProvider = + StreamProvider<({double longitude, double latitude})>((ref) { + // TO-DO: Return a stream which obtains the current location + return someStream; +}); + +final restaurantsNearMeProvider = FutureProvider>((ref) async { + // We use "ref.watch" to obtain the latest location. + // By specifying that ".future" after the provider, our code will wait + // for at least one location to be available. + final location = await ref.watch(locationProvider.future); + + // We can now make a network request based on that location. + // For example, we could use the Google Map API: + // https://developers.google.com/maps/documentation/places/web-service/search-nearby + final response = await http.get( + Uri.https('maps.googleapis.com', 'maps/api/place/nearbysearch/json', { + 'location': '${location.latitude},${location.longitude}', + 'radius': '1500', + 'type': 'restaurant', + 'key': '', + }), + ); + // Obtain the restaurant names from the JSON + final json = jsonDecode(response.body) as Map; + final results = (json['results'] as List).cast>(); + return results.map((e) => e['name']! as String).toList(); +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart new file mode 100644 index 000000000..736d1ecc7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart @@ -0,0 +1,37 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/foundation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +@riverpod +int example(ExampleRef ref) { + ref.watch(otherProvider); // Good! + ref.onDispose(() => ref.watch(otherProvider)); // Bad! + + final someListenable = ValueNotifier(0); + someListenable.addListener(() { + ref.watch(otherProvider); // Bad! + }); + + return 0; +} + +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + ref.watch(otherProvider); // Good! + ref.onDispose(() => ref.watch(otherProvider)); // Bad! + + return 0; + } + + void increment() { + ref.watch(otherProvider); // Bad! + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart new file mode 100644 index 000000000..c845e281b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart @@ -0,0 +1,41 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'd4d63f5cf1aaec5b7c6a19e6fee18ddf070147ec'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeProviderRef; +String _$myNotifierHash() => r'ad79fdb5b0e72a800fa03efc1e7157f0d1524844'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart new file mode 100644 index 000000000..34fa8f6c9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart @@ -0,0 +1,35 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/foundation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = Provider((ref) { + ref.watch(otherProvider); // Good! + ref.onDispose(() => ref.watch(otherProvider)); // Bad! + + final someListenable = ValueNotifier(0); + someListenable.addListener(() { + ref.watch(otherProvider); // Bad! + }); + + return 0; +}); + +final notifierProvider = NotifierProvider(MyNotifier.new); + +class MyNotifier extends Notifier { + @override + int build() { + ref.watch(otherProvider); // Good! + ref.onDispose(() => ref.watch(otherProvider)); // Bad! + + return 0; + } + + void increment() { + ref.watch(otherProvider); // Bad! + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx new file mode 100644 index 000000000..acabeda84 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx @@ -0,0 +1,142 @@ +--- +title: 권장사항(DO/DON'T) +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; + +코드의 유지보수성을 높이기 위해 Riverpod를 사용할 때 따라야 할 모범 사례 목록은 다음과 같습니다. + +이 목록은 전체 목록이 아니며 변경될 수 있습니다. +제안 사항이 있으면 언제든지 [이슈를 열어주세요](https://github.com/rrousselGit/riverpod/issues/new?assignees=rrousselGit&labels=documentation%2C+needs+triage&projects=&template=example_request.md&title=). + +이 목록의 항목은 특별한 순서가 정해져 있지 않습니다. + +이러한 권장 사항의 상당 부분은 [riverpod_lint](https://pub.dev/packages/riverpod_lint)로 적용할 수 있습니다. +설치 지침은 를 참조하세요. + +## AVOID 위젯에서 provider를 초기화하지 마세요 + +Providers는 스스로 초기화해야 합니다. +위젯과 같은 외부 요소에 의해 초기화되어서는 안 됩니다. + +그렇게 하지 않으면 경합 상태(race conditions) 및 예기치 않은 동작(unexpected behaviors)이 발생할 수 있습니다. + +**DON'T** + +```dart +class WidgetState extends State { + @override + void initState() { + super.initState(); + // Bad: provider가 자체적으로 초기화해야 합니다. + ref.read(provider).init(); + } +} +``` + +**CONSIDER** + +이 문제에 대한 "모든 것에 맞는" 해결책은 없습니다. +초기화 로직이 provider 외부의 요인에 따라 달라지는 경우 이러한 로직을 배치하는 올바른 위치는 탐색(navigation)을 트리거하는 버튼의 `onPressed` 메서드에 있는 경우가 많습니다: + +```dart +ElevatedButton( + onPressed: () { + ref.read(provider).init(); + Navigator.of(context).push(...); + }, + child: Text('Navigate'), +) +``` + +## AVOID 로컬 위젯 상태에 provider를 사용하지 마세요. + +Provider는 공유 비즈니스 상태(shared business state)용으로 설계되었습니다. +로컬 위젯 상태와 같은 용도로는 사용하기에 적합하지 않습니다: + +- 양식(form) 상태 저장 +- 현재 선택된 항목 +- 애니메이션 +- 일반적으로 Flutter가 "controller"(예: `TextEditingController`)로 처리하는 모든 것 + +로컬 위젯 상태를 처리하는 방법을 찾고 있다면 대신 [flutter_hooks](https://pub.dev/packages/flutter_hooks)를 사용하는 것이 좋습니다. + +이를 권장하지 않는 이유 중 하나는 이러한 상태가 경로로 범위가 지정(scoped to a route)되는 경우가 많기 때문입니다. +그렇게 하지 않으면 새 페이지가 이전 페이지의 상태를 재정의하기 때문에 앱의 뒤로 가기 버튼이 손상될 수 있습니다. + +## DON'T provider를 초기화하는 동안 부가작업(side effects)을 수행하지 마세요. + +provider는 일반적으로 "read" 작업을 나타내는 데 사용해야 합니다. +양식 제출과 같은 "write" 작업에는 사용하지 않아야 합니다. + +이러한 작업에 provider를 사용하면, 이전에 수행된 부가작업을 건너뛰는 등 예기치 않은 동작이 발생할 수 있습니다. + +부가작업의 로딩/오류 상태를 처리하는 방법을 알아보려면 을 참조하세요. + +**DON'T**: + +```dart +final submitProvider = FutureProvider((ref) async { + final formState = ref.watch(formState); + + // Bad: 공급자는 'write' 작업에 사용해서는 안 됩니다. + return http.post('https://my-api.com', body: formState.toJson()); +}); +``` + +## PREFER 정적으로 알려진 providers를 사용하여 ref.watch/read/listen (및 유사한 API)를 호출하세요. + +Riverpod은 린트 규칙을 활성화할 것을 강력히 권장합니다(`riverpod_lint`를 통해). +하지만 린트를 효과적으로 사용하려면 코드를 정적으로 분석할 수 있는 방식으로 작성해야 합니다. + +그렇게 하지 않으면 버그를 발견하기가 더 어려워지거나 린트로 오탐이 발생할 수 있습니다. + +**Do**: + +```dart +final provider = Provider((ref) => 42); + +... + +// OK provider가 정적으로 알려져 있으므로 확인 가능 +ref.watch(provider); +``` + +**Don't**: + +```dart +class Example extends ConsumerWidget { + Example({required this.provider}); + final Provider provider; + + @override + Widget build(context, ref) { + // Bad 정적 분석이 `provider`가 무엇인지 알 수 없으므로 나쁨 + ref.watch(provider); + } +} +``` + +## AVOID 동적으로 providers 생성하지 않기 + +공급자는 최상위 레벨(top-level)의 final 변수만 사용해야 합니다. + +**Do**: + +```dart +final provider = Provider((ref) => 'Hello world'); +``` + +**Don't**: + +```dart +class Example { + // 지원되지 않는 작업입니다. 메모리 누수 및 예기치 않은 동작이 발생할 수 있습니다. + final provider = Provider((ref) => 'Hello world'); +} +``` + +:::info +provider를 static final 변수로 생성하는 것은 허용되지만, 코드 생성기에서는 지원되지 않습니다. +::: diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx new file mode 100644 index 000000000..c934ddb60 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx @@ -0,0 +1,58 @@ +--- +title: Providers의 빠른 초기화(Eager initialization) +version: 1 +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; +import consumerExample from "!!raw-loader!./eager_initialization/consumer_example.dart"; +import asyncConsumerExample from "!!raw-loader!./eager_initialization/async_consumer_example.dart"; +import requireValue from "./eager_initialization/require_value"; + +모든 providers는 기본적으로 느리게(Lazy) 초기화됩니다. +즉, provider는 처음 사용될 때만 초기화됩니다. +이는 애플리케이션의 특정 부분에서만 사용되는 provider에 유용합니다. + +안타깝게도 Dart의 작동 방식(tree shaking 목적)으로 인해 provider를 이른 초기화(eagerly initialized)해야 하는 것으로 플래그를 지정할 수 있는 방법은 없습니다. +그러나 한 가지 해결책은 애플리케이션의 루트에서 초기화하려는 공급자를 강제로 읽는(read) 것입니다. + +권장되는 접근 방식은 `ProviderScope` 바로 아래에 배치된 소비자(Consumer)에서 provider를 단순히 "watch"하는 것입니다: + + + +:::note +초기화 소비자(initialization consumer)를 "MyApp" 또는 공개 위젯에 넣는 것을 고려해 보세요. +이렇게 하면 메인(main)에서 로직을 제거하여 테스트에서 동일한 동작을 사용할 수 있습니다. +::: + +### FAQ + +#### provider가 변경되면 전체 애플리케이션이 다시 빌드되지 않나요? + +아니요, 그렇지 않습니다. +위의 샘플에서 열심히 초기화를 담당하는 Consumer는 별도의 위젯으로, `child`을 반환하는 것 외에는 아무것도 하지 않습니다. + +핵심은 `MaterialApp` 자체를 인스턴스화하는 것이 아니라 `child`을 반환한다는 것입니다. +즉, `_EagerInitialization`이 리빌드되더라도 `child` 변수는 변경되지 않습니다. +그리고 위젯이 변경되지 않으면 Flutter는 위젯을 다시 빌드하지 않습니다. + +따라서 다른 위젯이 해당 provider를 수신하고 있지 않는 한 `_EagerInitialization`만 리빌드됩니다. + +#### 이 접근 방식을 사용하면 로딩 및 오류 상태를 어떻게 처리할 수 있나요? + +`Consumer`에서 일반적으로 처리하는 것처럼 로딩/오류 상태를 처리할 수 있습니다. +`_EagerInitialization`은 프로바이더가 "loading" 상태인지 확인하고, 만약 그렇다면 `child` 대신 `CircularProgressIndicator`를 반환할 수 있습니다: + + + +#### 로딩/오류 상태를 처리했지만 다른 Consumer는 여전히 AsyncValue를 받습니다! 모든 위젯에서 로딩/에러 상태를 처리하지 않아도 되는 방법이 있나요? + +provider가 `AsyncValue`를 노출하지 않도록 하는 대신 위젯이 `AsyncValue.requireValue`를 사용하도록 할 수 있습니다. +이렇게 하면 패턴 매칭을 수행하지 않고도 데이터를 읽을 수 있습니다. 그리고 버그가 발생하면 명확한 메시지와 함께 예외를 던집니다. + + + +:::note +이러한 경우 로딩/오류 상태를 노출하지 않는 방법(스코핑(scoping)에 의존)이 있지만 일반적으로 그렇게 하지 않는 것이 좋습니다. +두 개의 providers를 만들고 오버라이드를 사용하는 복잡성을 감수할 가치가 없습니다. +::: diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart new file mode 100644 index 000000000..17bc6de79 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart @@ -0,0 +1,28 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors, unused_element + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +final myProvider = FutureProvider((ref) => 0); + +/* SNIPPET START */ +class _EagerInitialization extends ConsumerWidget { + const _EagerInitialization({required this.child}); + final Widget child; + + @override + Widget build(BuildContext context, WidgetRef ref) { + final result = ref.watch(myProvider); + + // 오류 상태 및 로딩 상태 처리 + if (result.isLoading) { + return const CircularProgressIndicator(); + } else if (result.hasError) { + return const Text('Oopsy!'); + } + + return child; + } +} +/* SNIPPET END */ + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart new file mode 100644 index 000000000..e9df84f4b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart @@ -0,0 +1,36 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +final myProvider = Provider((ref) => 0); + +/* SNIPPET START */ +void main() { + runApp(ProviderScope(child: MyApp())); +} + +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return const _EagerInitialization( + // TODO: 여기에서 앱 렌더링 + child: MaterialApp(), + ); + } +} + +class _EagerInitialization extends ConsumerWidget { + const _EagerInitialization({required this.child}); + final Widget child; + + @override + Widget build(BuildContext context, WidgetRef ref) { + // providers를 감시하여 이른 초기화(Eagerly initialize)합니다. + // "watch"를 사용하면 provider가 폐기(disposed)되지 않고 계속 살아 있습니다. + ref.watch(myProvider); + return child; + } +} +/* SNIPPET END */ + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart new file mode 100644 index 000000000..7025bd12d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +// 이른 초기화된 provider +@riverpod +Future example(ExampleRef ref) async => 'Hello world'; + +class MyConsumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final result = ref.watch(exampleProvider); + + /// provider가 올바르게 초기화되었다면, + /// "requireValue"로 데이터를 직접 읽을 수 있습니다. + return Text(result.requireValue); + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart new file mode 100644 index 000000000..dd85f62f9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeFutureProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart new file mode 100644 index 000000000..0a7b0580b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart @@ -0,0 +1,20 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +// An eagerly initialized provider. +final exampleProvider = FutureProvider((ref) async => 'Hello world'); + +class MyConsumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final result = ref.watch(exampleProvider); + + /// If the provider was correctly eagerly initialized, then we can + /// directly read the data with "requireValue". + return Text(result.requireValue); + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/faq.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/faq.mdx new file mode 100644 index 000000000..a7c0a8d25 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/faq.mdx @@ -0,0 +1,157 @@ +--- +title: 자주 묻는 질문(FAQ) +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; + +다음은 커뮤니티에서 자주 묻는 질문입니다: + +## `ref.refresh`와 `ref.invalidate`의 차이점은 무엇인가요? + +`ref`에는 provider가 강제로 재계산(recompute)하도록 하는 두 가지 메서드가 있다는 것을 알고 어떻게 다른지 궁금하셨을 것입니다. + +생각보다 간단합니다. `ref.refresh`는 `invalidate` + `read`를 위한 구문 설탕일 뿐입니다: + +```dart +T refresh(provider) { + invalidate(provider); + return read(provider); +} +``` + +provider를 다시 계산한 후 새 값을 신경 쓰지 않는다면 `invalidate`를 사용면 됩니다. +그 경우 대신 `refresh`를 사용하십시오. + +:::info +이 로직은 린트 규칙을 통해 자동으로 적용됩니다. +반환된 값을 사용하지 않고 `ref.refresh`를 사용하려고 하면 경고가 표시됩니다. +::: + +동작의 주요 차이점은 무효화(invalidating) 직후에 공급자를 읽으면 공급자가 **즉시(immediately)** 재계산(recomputes)한다는 것입니다. +반면, `invalidate`를 호출하고 바로 읽지 않으면 업데이트가 _나중에(later)_ 트리거됩니다. + +이 "나중에(later)" 업데이트는 일반적으로 다음 프레임이 시작될 때 이루어집니다. +그러나 현재 수신 중(listened)이 아닌 provider가 무효화되면, 다시 수신(listen)할 때까지 업데이트되지 않습니다. + +## Ref와 WidgetRef 사이에 공유 인터페이스가 없는 이유는 무엇인가요? + +Riverpod은 `Ref`와 `WidgetRef`를 자발적으로 분리합니다. +이는 조건부로 둘 중 하나에 의존하는 코드를 작성하지 않기 위해 의도적으로 수행됩니다. + +한 가지 문제는 `Ref`와 `WidgetRef`가 비슷해 보이지만 미묘한 차이가 있다는 것입니다. +둘 다에 의존하는 코드는 발견하기 어려운 방식으로 불안정할 수 있습니다. + +동시에 `WidgetRef`에 의존하는 것은 `BuildContext`에 의존하는 것과 같습니다. +이는 사실상 UI 레이어에 로직을 넣는 것이므로 권장하지 않습니다. + +--- + +이러한 코드는 항상 `Ref`를 사용하도록 리팩터링해야 합니다. + +이 문제에 대한 해결책은 일반적으로 로직을 `Notifier`로 옮긴 다음( 참조), 로직을 해당 `Notifier`의 메서드가 되도록 하는 것입니다. + +이렇게 하면 위젯이 이 로직을 호출하고자 할 때 다음과 같은 내용을 작성할 수 있습니다: + +```dart +ref.read(yourNotifierProvider.notifier).yourMethod(); +``` + +`yourMethod`는 다른 제공자와 상호작용하기 위해 `Notifier`의 `Ref`를 사용합니다. + +## 원시(raw) StatelessWidget을 사용하는 대신 ConsumerWidget을 확장(extend)해야 하는 이유는 무엇인가요? + +이는 `InheritedWidget` API의 안타까운 제한 때문입니다. + +몇 가지 문제가 있습니다: + +- `InheritedWidget`으로 "on change" 리스너를 구현할 수 없습니다. + 즉, `ref.listen`과 같은 것을 `BuildContext`와 함께 사용할 수 없습니다. + + `State.didChangeDependencies`가 가장 비슷하지만 신뢰할 수 없습니다. + 한 가지 문제는 특히 위젯 트리가 GlobalKey를 사용하는 경우(일부 Flutter 위젯은 이미 내부적으로 그렇게 하고 있습니다) 종속성이 변경되지 않더라도 수명 주기가 트리거될 수 있다는 것입니다. + +- `InheritedWidget`을 수신하는 위젯은 수신이 중단되지 않습니다. + 이는 일반적으로 "테마" 또는 "미디어 쿼리"와 같은 순수한 메타데이터의 경우 괜찮습니다. + + 비즈니스 로직의 경우 이는 문제가 됩니다. + 페이지가 지정된 API를 표현하기 위해 provider를 사용한다고 가정해 봅시다. + 페이지 오프셋이 변경되면 위젯이 이전에 표시된 페이지를 계속 수신하고 싶지 않을 것입니다. + +- `InheritedWidget`은 위젯이 언제 청취(listening)를 중단하는지 추적할 수 있는 방법이 없습니다. + Riverpod은 때때로 공급자가 수신 대기 중인지 여부를 추적하는 데 의존합니다. + +이 기능은 자동 폐기 메커니즘(auto dispose mechanism)과 provider에게 인수를 전달하는 기능 모두에 매우 중요합니다. +이러한 기능들이 Riverpod를 강력하게 만드는 원동력입니다. + +먼 미래에는 이러한 문제가 해결될 수도 있습니다. 이 경우 Riverpod는 `Ref` 대신 `BuildContext`를 사용하도록 마이그레이션할 것입니다. +이렇게 되면 `ConsumerWidget` 대신 `StatelessWidget`을 사용할 수 있게 됩니다. +하지만 그건 다음 기회에! + +## hooks_riverpod이 flutter_hooks을 export하지 않는 이유는? + +이는 올바른 버전 관리 관행을 존중하기 위한 것입니다. + +`hooks_riverpod`은 `flutter_hooks` 없이 사용할 수 없지만, 두 패키지는 독립적으로 버전이 관리됩니다. +한 쪽에서는 변경 사항이 발생해도 다른 쪽에서는 발생하지 않을 수 있습니다. + +## Riverpod이 업데이트를 필터링할 때 `==` 대신 `identical`을 사용하는 이유는 무엇인가요? + +Notifiers는 `==` 대신 `identical`을 사용하여 업데이트를 필터링합니다. + +이는 riverpod 사용자들이 copyWith 구현을 위해 Freezed/built_value와 같은 코드 생성기를 사용하는 것이 일반적이기 때문입니다. +이러한 패키지는 `==`를 재정의하여 객체를 심층적으로 비교합니다. +객체 심층 비교는 상당히 많은 비용이 듭니다. +"비즈니스 로직" 모델에는 많은 프로퍼티가 있는 경향이 있습니다. +더 나쁜 것은 목록, 지도 등과 같은 컬렉션도 있다는 것입니다. + +동시에 복잡한 "비즈니스" 객체를 사용할 때 대부분의 `state = newState` 호출은 항상 알림(notification)을 발생시킵니다.(그렇지 않으면 setter를 호출할 필요가 없습니다) +일반적으로 현재 상태와 새 상태가 같을 때 `state = newState`를 호출하는 주된 경우는 원시 객체(primitive objects)(lists/classes/...가 아닌 ints, enums, strings)에 대한 것입니다. +이러한 객체는 "기본적으로 표준화(canonicalized by default)"됩니다. 이러한 객체가 같으면 일반적으로 "동일(identical)"합니다. + +따라서 riverpod은 `identical`을 사용하여 업데이트를 필터링하는 것은 두 가지 모두에 좋은 기본값을 갖기 위한 시도입니다. +객체 필터링에 크게 신경 쓰지 않고 코드 생성기가 기본적으로 `==` 오버라이드를 생성하기 때문에 `==`가 비쌀 수 있는 복잡한 객체의 경우, `identical`을 사용하면 리스너에게 효율적으로 알림을 제공할 수 있습니다. +동시에 단순한 객체의 경우 `identical`은 중복 알림을 올바르게 필터링합니다. + +Last but not least, you can change this behavior by overriding the method `updateShouldNotify` on Notifiers. +마지막으로, Notifiers에서 `updateShouldNotify` 메서드를 재정의하여 이 동작을 변경할 수 있습니다. + +## 모든 providers를 한 번에 재설정(reset)하는 방법이 있나요? + +아니요, 모든 providers를 한 번에 재설정할 수 있는 방법은 없습니다. + +이는 안티 패턴으로 간주되기 때문에 일부러 그렇게 한 것입니다. +모든 공급업체를 한 번에 재설정하면 재설정하지 않으려던 공급업체도 재설정되는 경우가 많습니다. + +이는 사용자가 로그아웃할 때 애플리케이션의 상태를 초기화하려는 사용자가 주로 요청하는 기능입니다. +이 기능을 원하는 경우, 대신 사용자의 상태에 따라 달라지는 모든 것을 "user" provider를 `ref.watch`로 설정해야 합니다. + +그러면 사용자가 로그아웃하면 그에 따라 모든 providers가 자동으로 재설정되지만 다른 모든 것은 그대로 유지됩니다. + +## "Cannot use "ref" after the widget was disposed"라는 오류가 발생했는데 무엇이 문제인가요? + +"Bad state: No ProviderScope found"이라는 동일한 문제의 이전 오류 메시지가 표시될 수도 있습니다. + +이 오류는 더 이상 마운트되지 않은 위젯에서 `ref`를 사용하려고 할 때 발생합니다. +이 오류는 일반적으로 `await` 이후에 발생합니다: + +```dart +ElevatedButton( + onPressed: () async { + await future; + ref.read(...); // May throw "Cannot use "ref" after the widget was disposed" + } +) +``` + +해결책은 `BuildContext`와 마찬가지로 `ref`를 사용하기 전에 `mounted`를 확인하는 것입니다: + +```dart +ElevatedButton( + onPressed: () async { + await future; + if (!context.mounted) return; + ref.read(...); // No longer throws + } +) +``` diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request.mdx new file mode 100644 index 000000000..cd73f81cb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request.mdx @@ -0,0 +1,320 @@ +--- +title: 첫 번째 provider/네트워크 요청 만들기 +pagination_prev: introduction/getting_started +version: 1 +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import activity from "./first_request/activity"; +import provider from "./first_request/provider"; +import consumer from "./first_request/consumer"; +import consumerWidget from "./first_request/consumer_widget"; +import consumerStatefulWidget from "./first_request/consumer_stateful_widget"; +import hookConsumerWidget from "./first_request/hook_consumer_widget"; +import Legend from "./first_request/legend/legend"; + +네트워크 요청은 모든 애플리케이션의 핵심입니다. +하지만 네트워크 요청을 할 때는 고려해야 할 사항이 많습니다: + +- 요청이 이루어지는 동안 UI는 로딩 상태를 렌더링해야 합니다. +- 오류는 정상적으로 처리되어야 합니다. +- 요청은 가능하면 캐시되어야 합니다. + +이 섹션에서는 Riverpod이 이 모든 것을 자연스럽게 처리하는 데 어떻게 도움이 되는지 살펴보겠습니다. + +## `ProviderScope` 설정하기 + +네트워크 요청을 시작하기 전에 애플리케이션의 루트에 `ProviderScope`가 추가되었는지 확인하세요. + +```dart +void main() { + runApp( + // Riverpod을 설치하려면 다른 모든 위젯 위에 이 위젯을 추가해야 합니다. + // 이 위젯은 "MyApp" 내부가 아니라 "runApp"에 직접 파라미터로 추가해야 합니다. + ProviderScope( + child: MyApp(), + ), + ); +} +``` + +이렇게 하면 전체 애플리케이션에 대해 Riverpod이 활성화됩니다. + +:::note +[riverpod_lint](https://pub.dev/packages/riverpod_lint) 설치와 같은 전체 설치 단계는 를 확인하세요 +::: + +## "provider"에서 네트워크 요청 수행하기 + +네트워크 요청을 수행하는 것을 보통 "비즈니스 로직"이라고 부릅니다. +Riverpod에서 비즈니스 로직은 "providers" 내부에 배치됩니다. +프로바이더는 초강력(super-powered) 함수입니다. +일반 함수처럼 동작하지만 다음과 같은 이점이 추가됩니다: + +- 캐시됩니다. +- 기본적인 오류/로딩 처리를 제공합니다. +- 리스너를 추가할 수 있습니다. +- 데이터가 변경될 때 자동으로 다시 실행됩니다. + +따라서 공급자는 _GET_ 네트워크 요청에 가장 적합합니다. (_POST/etc_ 요청의 경우, 참조) + +예를 들어, 지루할 때 할 수 있는 무작위 활동을 제안하는 간단한 애플리케이션을 만들어 보겠습니다. +이를 위해 [Bored API](https://boredapi.com/)를 사용하겠습니다. +특히 `/api/activity` 엔드포인트에서 _GET_ 요청을 수행하겠습니다. +그러면 JSON 객체가 반환되며, 이 객체를 Dart 클래스 인스턴스로 파싱합니다. +다음 단계는 이 활동을 UI에 표시하는 것입니다. +또한 요청이 이루어지는 동안 로딩 상태를 렌더링하고 오류를 정상적으로 처리해야 합니다. + +멋지게 들리나요? 시작해보세요! + +### 모델 정의하기 + +시작하기 전에 API에서 수신할 데이터의 모델을 정의해야 합니다. +이 모델에는 JSON 객체를 Dart 클래스 인스턴스로 파싱하는 방법도 필요합니다. + +일반적으로 JSON 디코딩을 처리할 때는 [Freezed](https://pub.dev/packages/freezed) 또는 [json_serializable](https://pub.dev/packages/json_serializable)과 같은 코드 생성기를 사용하는 것이 좋습니다. +물론 수작업으로 처리하는 것도 가능합니다. + +어쨌든, 여기 우리의 모델이 있습니다: + + + +### 공급자 만들기 + +이제 모델이 생겼으니 API 쿼리를 시작할 수 있습니다. +그러기 위해서는 첫 번째 공급자를 만들어야 합니다. + +공급자를 정의하는 구문은 다음과 같습니다: + + +((ref) { + +}); +`} + annotations={[ + { + offset: 6, + length: 4, + label: "provider 변수", + description: <> + +이 변수는 공급자와 상호 작용하는 데 사용되는 변수입니다. +변수는 final이여야하고, "top-level" (global)에 선언되어야 합니다. + + + }, + { + offset: 13, + length: 12, + label: "provider 타입", + description: <> + +일반적으로 `Provider`, `FutureProvider` 또는 `StreamProvider`중 하나입니다. +사용되는 provider 타입은은 함수의 반환값에 따라 달라집니다. +예를 들어, `Future`를 만들려면 `FutureProvider`가 필요할 것입니다. + +`FutureProvider`가 가장 많이 사용될 것입니다. + +:::tip +"어떤 provider를 선택해야 하나"라는 관점에서 생각하지 마세요. +대신 "내가 무엇을 반환하고 싶은가"라는 관점에서 생각하세요. +공급자 유형은 자연스럽게 따라올 것입니다. +::: + + + }, + { + offset: 25, + length: 13, + label: "수정자(Modifiers) (optional)", + description: <> + +종종 provider 타입 뒤에 "수정자(Modifiers)"가 표시될 수 있습니다. +수정자(Modifiers)는 선택 사항이며, 타입에 안전한 방식으로 공급자의 동작을 조정하는 데 사용됩니다. + +현재 두 가지 수정자를 사용할 수 있습니다: + +- 공급자가 더 이상 사용되지 않을 때 캐시를 자동으로 지우는 `autoDispose`. + 도 참조하세요. +- provider에 인수를 전달할 수 있는 `family`. + 도 참조하세요. + + + }, + { + offset: 48, + length: 3, + label: "Ref", + description: <> + +다른 provider와 상호작용하는 데 사용되는 객체입니다. +모든 providers는 provider 함수의 매개변수(parameter) 또는 Notifier의 속성(property)으로 하나씩 가지고 있습니다. + + + }, + { + offset: 57, + length: 17, + label: "provider 함수", + description: <> + +여기에 프로바이더의 로직을 배치합니다. +이 함수는 공급자를 처음 읽을 때 호출됩니다. +이후 읽기는 이 함수를 다시 호출하지 않고 대신 캐시된 값을 반환합니다. + + + }, +]} +/> + + + + +} +`} + annotations={[ + { + offset: 0, + length: 9, + label: "어노테이션(annotation)", + description: <> + +모든 프로바이더는 `@riverpod` 또는 `@Riverpod()`로 어노테이션해야 합니다. +이 어노테이션은 전역 함수나 클래스에 배치할 수 있습니다. +이 어노테이션을 통해 프로바이더를 구성할 수 있습니다. + +예를 들어, `@Riverpod(keepAlive: true)`를 작성하여 "auto-dispose"(나중에 살펴보겠습니다)를 비활성화할 수 있습니다. + + + }, + { + offset: 17, + length: 10, + label: "어노테이션된 함수(annotated function)", + description: <> + +어노테이션된 함수의 이름에 따라 provider와 상호작용하는 방식이 결정됩니다. +주어진 함수 `myFunction`에 대해 생성된 `myFunctionProvider` 변수가 생성됩니다. + +어노테이션된 함수는 첫 번째 매개변수로 "ref"를 지정해야 합니다. +그 외에도 함수는 제네릭을 포함하여 여러 개의 매개변수를 가질 수 있습니다. +이 함수는 원할 경우 `Future`/`Stream`을 반환할 수도 있습니다. + +이 함수는 공급자를 처음 읽을 때 호출됩니다. +이후 읽기는 함수를 다시 호출하지 않고 대신 캐시된 값을 반환합니다. + + + }, + { + offset: 28, + length: 17, + label: "Ref", + description: <> + +다른 providers와 상호작용하는 데 사용되는 객체입니다. +모든 providers에는 provider 함수의 매개변수(parameter) 또는 Notifier의 속성(property)으로 하나씩 가지고 있습니다. +이 객체의 타입은 함수/클래스의 이름에 의해 결정됩니다. + + + }, +]} +/> + + +여기서는 API에서 Activity를 _GET_하고자 합니다. +_GET_은 비동기 연산이므로 `Future`를 생성해야 합니다. + +따라서 앞서 정의한 구문을 사용하여 다음과 같이 공급자를 정의할 수 있습니다: + + + +이 코드조각에서는 UI가 임의의 액티비티를 가져오는 데 사용할 수 있는 `activityProvider`라는 이름의 공급자를 정의했습니다. +다음과 같은 것은 주목할 가치가 있습니다: + +- 네트워크 요청은 UI가 provider를 한 번 이상 읽을 때까지 실행되지 않습니다. +- 이후 읽기는 네트워크 요청을 다시 실행하지 않고 이전에 가져온 활동을 반환합니다. +- UI가 이 공급자의 사용을 중단하면 캐시가 삭제됩니다. + 그런 다음 UI가 이 공급자를 다시 사용하면 새로운 네트워크 요청이 이루어집니다. +- 오류는 catch되지 않았습니다. 이는 공급자가 기본적으로 오류를 처리하기 때문에 자발적인 조치입니다. + 네트워크 요청이나 JSON 파싱에서 에러가 발생하면 riverpod에서 에러를 catch합니다. + 그러면 UI에 오류 페이지를 렌더링하는 데 필요한 정보가 자동으로 표시됩니다. + +:::info +Provider는 "지연(lazy)"입니다. 공급자를 정의해도 네트워크 요청이 실행되지 않습니다. +대신 공급자를 처음 읽을 때 네트워크 요청이 실행됩니다. +::: + +### UI에서 네트워크 요청의 응답 렌더링하기 + +Now that we have defined a provider, we can start using it inside our UI to display the activity. + +provider와 상호 작용하려면 "ref"라는 객체가 필요합니다. +provider는 당연히 "ref" 객체에 액세스할 수 있으므로 이전에 provider 정의에서 이 객체를 보셨을 것입니다. +하지만 여기서는 provider가 아니라 위젯에 있습니다. 그렇다면 "ref"는 어떻게 얻을 수 있을까요? + +해결책은 `Consumer`라는 커스텀 위젯을 사용하는 것입니다. +`Consumer`는 `Builder`와 비슷한 위젲이지만, "ref"를 제공한다는 추가적인 이점이 있습니다. +이를 통해 UI가 공급자를 읽을 수 있습니다. +다음 예제는 `Consumer`를 사용하는 방법을 보여줍니다: + + + +이 코드 조각에서는 `Consumer`를 사용하여 `activityProvider`를 읽고 Activity를 표시했습니다. +또한 로딩/오류 상태도 우아하게 처리했습니다. +provider에서 특별한 작업을 하지 않고도 UI가 어떻게 로딩/오류 상태를 처리할 수 있었는지 주목하세요. +동시에 위젯이 다시 빌드될 경우 네트워크 요청이 올바르게 다시 실행되지 않습니다. +다른 위젯도 네트워크 요청을 다시 실행하지 않고도 동일한 provider에 액세스할 수 있습니다. + +:::info +위젯은 원하는 만큼 많은 providers를 수신(listen)할 수 있습니다. 그렇게 하려면 `ref.watch` 호출을 더 추가하기만 하면 됩니다. +::: + +:::tip +linter를 설치하세요. +그러면 IDE에서 자동으로 `Consumer`를 추가하거나 `StatelessWidget`을 `ConsumerWidget`으로 변환하는 리팩터링 옵션을 이용할 수 있습니다. + +설치 단계는 를 참고하세요. +::: + +## 더 살펴보기: `Consumer` 대신 `ConsumerWidget`을 사용하여 코드 들여쓰기 제거하기. + +이전 예제에서는 `Consumer`를 사용하여 provider를 읽었습니다. +이 접근 방식에 문제가 있는 것은 아니지만, 들여쓰기가 추가되면 코드를 읽기 어렵게 만들 수 있습니다. + +Riverpod은 동일한 결과를 얻을 수 있는 다른 방법을 제공합니다: +`StatelessWidget`/`StatefulWidget`이 `Consumer`를 반환하는 코드를 작성하는 대신 `ConsumerWidget`/`ConsumerStatefulWidget`을 정의할 수 있습니다. +`ConsumerWidget`과 `ConsumerStatefulWidget`은 사실상 `StatelessWidget`/`StatefulWidget`과 `Consumer`를 결합한 것입니다. +이들은 원래의 짝과 동일하게 동작하지만 "ref"를 제공한다는 추가적인 이점이 있습니다. + +이전 예제를 다음과 같이 `ConsumerWidget`을 사용하도록 다시 작성할 수 있습니다: + + + +`ConsumerStatefulWidget`의 경우 대신 다음과 같이 작성합니다: + + + +### Flutter_hooks 고려 사항: `HookWidget`과 `ConsumerWidget`의 결합 + +:::caution +"훅(Hooks)"에 대해 들어본 적이 없다면 이 섹션을 건너뛰셔도 됩니다. +[Flutter_hooks](https://pub.dev/packages/flutter_hooks)는 Riverpod과는 별개의 패키지이지만 Riverpod과 함께 사용되는 경우가 많습니다. +Riverpod을 처음 사용하는 경우 "훅(Hooks)" 사용을 권장하지 않습니다. 자세한 내용은 에서 확인하세요. +::: + +`flutter_hooks`를 사용하는 경우 `HookWidget`과 `ConsumerWidget`을 결합하는 방법이 궁금할 수 있습니다. +결국 둘 다 확장된(extended) 위젯 클래스를 변경해야 합니다. + +Riverpod는 이 문제에 대한 해결책으로 `HookConsumerWidget`과 `StatefulHookConsumerWidget`을 제공합니다. +`ConsumerWidget`과 `ConsumerStatefulWidget`이 `Consumer`와 `StatelessWidget`/`StatefulWidget`의 결합인 것과 유사하게, +`HookConsumerWidget`과 `StatefulHookConsumerWidget`은 `Consumer`와 `HookWidget`/`HookStatefulWidget`의 결합입니다. +따라서 동일한 위젯에서 훅(Hooks)와 providers를 모두 사용할 수 있습니다. + +이를 보여주기 위해 이전 예제를 다시 한 번 다시 작성해 보겠습니다: + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts new file mode 100644 index 000000000..5cea035c7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/activity.dart"; +import codegen from "!!raw-loader!./codegen/activity.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart new file mode 100644 index 000000000..5a810a08f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart @@ -0,0 +1,24 @@ +/* SNIPPET START */ + +import 'package:freezed_annotation/freezed_annotation.dart'; + +part 'activity.freezed.dart'; +part 'activity.g.dart'; + +/// `GET /api/activity` 엔드포인트의 응답 +/// +/// `freezed`와 `json_serializable`을 사용하여 정의됩니다. +@freezed +class Activity with _$Activity { + factory Activity({ + required String key, + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + /// JSON 객체를 [Activity] 인스턴스로 변환합니다. + /// 이렇게 하면 API 응답을 형안정(Type-safe)하게 읽을 수 있습니다. + factory Activity.fromJson(Map json) => _$ActivityFromJson(json); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart new file mode 100644 index 000000000..6ffa343c1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart @@ -0,0 +1,237 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'activity.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get key => throw _privateConstructorUsedError; + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call( + {String key, + String activity, + String type, + int participants, + double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? key = null, + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + key: null == key + ? _value.key + : key // ignore: cast_nullable_to_non_nullable + as String, + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call( + {String key, + String activity, + String type, + int participants, + double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? key = null, + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + key: null == key + ? _value.key + : key // ignore: cast_nullable_to_non_nullable + as String, + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.key, + required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String key; + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(key: $key, activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.key, key) || other.key == key) && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, key, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String key, + required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get key; + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart new file mode 100644 index 000000000..55a7a5383 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'activity.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + key: json['key'] as String, + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'key': instance.key, + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart new file mode 100644 index 000000000..19901c6c4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart @@ -0,0 +1,21 @@ +/* SNIPPET START */ + +import 'dart:convert'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'activity.dart'; + +// 코드 생성이 작동하는 데 필요합니다. +part 'provider.g.dart'; + +/// 그러면 `activityProvider`라는 이름의 provider가 생성됩니다. +/// 이 함수의 결과를 캐시하는 공급자를 생성합니다. +@riverpod +Future activity(ActivityRef ref) async { + // package:http를 사용하여 Bored API에서 임의의 Activity를 가져옵니다. + final response = await http.get(Uri.https('boredapi.com', '/api/activity')); + // 그런 다음 dart:convert를 사용하여 JSON 페이로드를 맵 데이터 구조로 디코딩합니다. + final json = jsonDecode(response.body) as Map; + // 마지막으로 맵을 Activity 인스턴스로 변환합니다. + return Activity.fromJson(json); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart new file mode 100644 index 000000000..bcae44b2a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart @@ -0,0 +1,29 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'636cd5510e09cbfc46f31b74a70d9e98c89e95a4'; + +/// 그러면 `activityProvider`라는 이름의 provider가 생성됩니다. +/// 이 함수의 결과를 캐시하는 공급자를 생성합니다. +/// +/// Copied from [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts new file mode 100644 index 000000000..a625b7073 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/consumer.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts new file mode 100644 index 000000000..5e6ac973a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/consumer_stateful_widget.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts new file mode 100644 index 000000000..56cb2331d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/consumer_widget.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts new file mode 100644 index 000000000..300ec6596 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/hook_consumer_widget.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss new file mode 100644 index 000000000..bda077971 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss @@ -0,0 +1,18 @@ +.legend { + table, + td, + tr { + background: none !important; + border: none; + + vertical-align: top; + } + + td:first-child { + text-align: end; + } + + tr + tr { + border-top: solid 0.5px; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx new file mode 100644 index 000000000..048817ec0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx @@ -0,0 +1,88 @@ +import React from "react"; +import PropTypes from "prop-types"; +import CodeBlock from "@theme/CodeBlock"; +import "./DocuCode.scss"; + +type AnnotatedCode = { + color?: string; + code: string; +}; + +export const colors = [ + "#2196f3", + "#4caf50", + "#f44336", + "#ff9800", + "#009688", + "#e91e63", + "#00bcd4", + "#8bc34a", +]; + +const Legend = ({ annotations, code }) => { + const fullAnnotations = new Array(); + + let annotationOffset = 0; + for (var codeOffset = 0; codeOffset < code.length; ) { + if (annotationOffset >= annotations.length) { + // Out of annotations, just add the rest of the code + fullAnnotations.push({ code: code.substring(codeOffset) }); + break; + } + + const annotation = annotations[annotationOffset]; + if (codeOffset < annotation.offset) { + /// There is an unannotated gap between the last annotation and this one. + const codeLength = annotation.offset - codeOffset; + fullAnnotations.push({ + code: code.substring(codeOffset, codeOffset + codeLength), + }); + codeOffset += codeLength; + } + + if (annotation.offset >= code.length) { + throw new Error("Annotation offset out of bounds"); + } + + annotationOffset++; + codeOffset = annotation.offset + annotation.length; + fullAnnotations.push({ + color: colors[annotationOffset - 1], + code: code.substring( + annotation.offset, + annotation.offset + annotation.length + ), + }); + } + + return ( +
+ 
+        {fullAnnotations.map(({ code, color }) => {
+          let underlineClass = color ? `underline` : "";
+          let style = color ? { color: color } : undefined;
+
+          return (
+            
+              {code}
+            
+          );
+        })}
+
+ + + {annotations.map((annotation, index) => ( + + + + + ))} + +
+ {annotation.label} + {annotation.description}
+
+ ); +}; + +export default Legend; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts new file mode 100644 index 000000000..42ce35bff --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/provider.dart"; +import codegen from "!!raw-loader!./codegen/provider.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart new file mode 100644 index 000000000..794d36782 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart @@ -0,0 +1,30 @@ +/* SNIPPET START */ + +/// The response of the `GET /api/activity` endpoint. +class Activity { + Activity({ + required this.key, + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + /// Convert a JSON object into an [Activity] instance. + /// This enables type-safe reading of the API response. + factory Activity.fromJson(Map json) { + return Activity( + key: json['key'] as String, + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: json['price'] as double, + ); + } + + final String key; + final String activity; + final String type; + final int participants; + final double price; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart new file mode 100644 index 000000000..718aa25e8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart @@ -0,0 +1,41 @@ +// ignore_for_file: omit_local_variable_types + +/* SNIPPET START */ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/// The homepage of our application +class Home extends StatelessWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context) { + return Consumer( + builder: (context, ref, child) { + // Read the activityProvider. This will start the network request + // if it wasn't already started. + // By using ref.watch, this widget will rebuild whenever the + // the activityProvider updates. This can happen when: + // - The response goes from "loading" to "data/error" + // - The request was refreshed + // - The result was modified locally (such as when performing side-effects) + // ... + final AsyncValue activity = ref.watch(activityProvider); + + return Center( + /// Since network-requests are asynchronous and can fail, we need to + /// handle both error and loading states. We can use pattern matching for this. + /// We could alternatively use `if (activity.isLoading) { ... } else if (...)` + child: switch (activity) { + AsyncData(:final value) => Text('Activity: ${value.activity}'), + AsyncError() => const Text('Oops, something unexpected happened'), + _ => const CircularProgressIndicator(), + }, + ); + }, + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart new file mode 100644 index 000000000..2ba511a07 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart @@ -0,0 +1,43 @@ +// ignore_for_file: omit_local_variable_types, prefer_const_constructors, unused_local_variable, todo + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/* SNIPPET START */ + +// We extend ConsumerStatefulWidget. +// This is the equivalent of "Consumer" + "StatefulWidget". +class Home extends ConsumerStatefulWidget { + const Home({super.key}); + + @override + ConsumerState createState() => _HomeState(); +} + +// Notice how instead of "State", we are extending "ConsumerState". +// This uses the same principle as "ConsumerWidget" vs "StatelessWidget". +class _HomeState extends ConsumerState { + @override + void initState() { + super.initState(); + + // State life-cycles have access to "ref" too. + // This enables things such as adding a listener on a specific provider + // to show dialogs/snackbars. + ref.listenManual(activityProvider, (previous, next) { + // TODO show a snackbar/dialog + }); + } + + @override + Widget build(BuildContext context) { + // "ref" is not passed as parameter anymore, but is instead a property of "ConsumerState". + // We can therefore keep using "ref.watch" inside "build". + final AsyncValue activity = ref.watch(activityProvider); + + return Center(/* ... */); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart new file mode 100644 index 000000000..1f01fa38a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart @@ -0,0 +1,25 @@ +// ignore_for_file: omit_local_variable_types, prefer_const_constructors, unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/* SNIPPET START */ + +/// We subclassed "ConsumerWidget" instead of "StatelessWidget". +/// This is equivalent to making a "StatelessWidget" and retuning "Consumer". +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + // Notice how "build" now receives an extra parameter: "ref" + Widget build(BuildContext context, WidgetRef ref) { + // We can use "ref.watch" inside our widget like we did using "Consumer" + final AsyncValue activity = ref.watch(activityProvider); + + // The rendering logic stays the same + return Center(/* ... */); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart new file mode 100644 index 000000000..1fc7306dc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart @@ -0,0 +1,28 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_const_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/* SNIPPET START */ + +/// "HookConsumerWidget"을 서브클래스화했습니다. +/// 이것은 "StatelessWidget" + "Consumer" + "HookWidget"을 함께 결합합니다. +class Home extends HookConsumerWidget { + const Home({super.key}); + + @override + // 이제 "build"가 추가 매개 변수 "ref"를 받는 것에 주목하세요. + Widget build(BuildContext context, WidgetRef ref) { + // 위젯 내부에서 "useState"와 같은 훅을 사용할 수 있습니다. + final counter = useState(0); + + // providers도 읽을 수 있습니다. + final AsyncValue activity = ref.watch(activityProvider); + + return Center(/* ... */); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart new file mode 100644 index 000000000..f1395604f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart @@ -0,0 +1,15 @@ +/* SNIPPET START */ + +import 'dart:convert'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; +import 'activity.dart'; + +final activityProvider = FutureProvider.autoDispose((ref) async { + // Using package:http, we fetch a random activity from the Bored API. + final response = await http.get(Uri.https('boredapi.com', '/api/activity')); + // Using dart:convert, we then decode the JSON payload into a Map data structure. + final json = jsonDecode(response.body) as Map; + // Finally, we convert the Map into an Activity instance. + return Activity.fromJson(json); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx new file mode 100644 index 000000000..5bf4dc7c0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx @@ -0,0 +1,137 @@ +--- +title: 요청에 인자 전달하기 +version: 1 +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import noArgProvider from "./passing_args/no_arg_provider"; +import family from "!!raw-loader!./passing_args/raw/family.dart"; +import codegenFamily from "!!raw-loader!./passing_args/codegen/family.dart"; +import consumerProvider from "!!raw-loader!./passing_args/raw/consumer_provider.dart"; +import consumerFamily from "!!raw-loader!./passing_args/raw/consumer_family.dart"; +import consumerListFamily from "!!raw-loader!./passing_args/raw/consumer_list_family.dart"; +import multipleConsumerFamily from "!!raw-loader!./passing_args/raw/multiple_consumer_family.dart"; +import tupleFamily from "!!raw-loader!./passing_args/raw/tuple_family.dart"; +import consumerTupleFamily from "!!raw-loader!./passing_args/raw/consumer_tuple_family.dart"; + +이전 글에서 "provider"를 정의하여 간단한 _GET_ HTTP 요청을 만드는 방법을 살펴봤습니다. +하지만 HTTP 요청은 외부 매개변수(external parameters)에 의존하는 경우가 많습니다. + +예를 들어, 이전에는 사용자에게 무작위 액티비티를 제안하기 위해 [Bored API](https://boredapi.com/)를 사용했습니다. +하지만 사용자가 원하는 액티비티 타입을 필터링하거나 가격 요구 사항 등을 원할 수도 있습니다. +이러한 매개변수는 미리 알 수 없습니다. +따라서 이러한 매개변수를 UI에서 providers에 전달할 방법이 필요합니다. + +## 인수를 허용하도록 providers 업데이트 + +참고로 이전에는 다음과 같이 provider를 정의했습니다: + + + + + +코드 생성(code-generation)에 의존하지 않을 때는 인자 전달(passing arguments)을 지원하기 위해 provider 정의 구문을 약간 조정해야 합니다. +이는 "family"라는 "수정자(modifier)"에 의존하여 수행됩니다. + +간단히 말해, provider 타입 뒤에 `.family`를 추가하고 인수 타입(argument type)에 해당하는 추가 타입 매개 변수를 추가해야 합니다. +예를 들어, 원하는 액티비티 타입에 해당하는 `String` 인수를 받도록 provider를 업데이트할 수 있습니다: + + + + + + + +provider에게 매개변수(parameters)를 전달하려면 어노테이션이 달린 함수 자체에 매개변수(parameters)를 추가하기만 하면 됩니다. +예를 들어, 원하는 액티비티 타입에 해당하는 `String` 인수를 받도록 provider를 업데이트할 수 있습니다: + + + + + +:::caution +provider에게 인수(arguments)를 전달할 때는 provider에서 "autoDispose"를 활성화하는 것이 좋습니다. +그렇지 않으면 메모리 누수(memory leaks)가 발생할 수 있습니다. +자세한 내용은 를 참조하세요. +::: + +## 인수(arguments)를 전달하도록 UI 업데이트 + +이전에는 위젯이 다음과 같이 provider를 소비(consume)했습니다: + + + +하지만 이제 provider가 인수(arguments)를 받으므로 인수를 사용하는 구문이 약간 달라졌습니다. +이제 provider는 요청된 매개 변수를 사용하여 호출해야 하는 함수입니다. +이와 같이 하드코딩된 타입의 액티비티을 전달하도록 UI를 업데이트할 수 있습니다: + + + + + +provider에게 전달된 매개변수(parameters)는 어노테이션이 달린 함수의 매개변수에서 "ref" 매개변수를 뺀 값에 해당합니다. + + + +:::info +서로 다른 인수(arguments)를 가진 동일한 provider를 동시에 수신(listen)하는 것은 전적으로 가능합니다. +예를 들어, 우리의 UI는 "오락" 액티비티와 "요리" 액티비티을 모두 렌더링할 수 있습니다: + + + + + +이것이 수정자(modifier)를 "family"라고 부르는 이유입니다: +provider에게 매개 변수를 전달하면, 내부적으로 동일한 로직을 가진 상태 그룹(group of states)으로 공급자를 효과적으로 변환할 수 있기 때문입니다. + + +::: + +## Caching considerations and parameter restrictions + +매개변수(parameters)를 providers에게 전달할 때 계산은 여전히 캐시됩니다. +차이점은 이제 계산이 인수별로 캐시(cached per-argument)된다는 점입니다. + +즉, 두 개의 위젯이 동일한 매개변수로 동일한 provider를 사용하는 경우 네트워크 요청은 한 번만 이루어집니다. +그러나 두 위젯이 서로 다른 매개변수를 가진 동일한 provider를 사용하는 경우 두 번의 네트워크 요청이 이루어집니다. + +이를 위해 Riverpod은 매개변수의 `==` 연산자에 의존합니다. +따라서 provider에게 전달되는 매개변수가 일관된 동일성(consistent equality)을 갖는 것이 중요합니다. + +:::caution +흔히 저지르는 실수는 새 객체가 `==`를 재정의하지 않는데도 새 객체를 프로바이더의 매개변수로 직접 인스턴스화하는 것입니다. +예를 들어, `List`를 이렇게 전달하고 싶은 유혹을 받을 수 있습니다: + + + +이 코드의 문제점은 `['recreational', 'cooking'] == ['recreational', 'cooking']`가 `false`라는 것입니다. +따라서 Riverpod은 두 매개변수가 다르다고 판단하고 새로운 네트워크 요청을 시도합니다. +이렇게 되면 네트워크 요청이 무한 반복되어 사용자에게 진행률 표시기가 영구적으로 표시됩니다. + +이 문제를 해결하려면 `const` 목록(`const ['레크리에이션', '요리']`)을 사용하거나 `==`를 재정의하는 사용자 정의 목록 구현을 사용할 수 있습니다. + +이 실수를 발견하는 데 도움이 되려면 [riverpod_lint](https://pub.dev/packages/riverpod_lint)를 사용하여 +[provider_parameters](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint#provider_parameters) 린트 규칙을 활성화하는 것이 좋습니다. +그러면 위와 같은 스니펫에 경고가 표시됩니다. +설치 단계는 를 참조하세요. +::: + + + +이를 염두에 두고 provider에 여러 매개 변수(multiple parameters)를 전달하는 방법이 궁금할 수 있습니다. +권장되는 해결책은 다음과 같습니다: + +- 코드 생성(code-generation)으로 전환하여 원하는 수의 매개변수를 전달할 수 있습니다. +- Dart 3의 레코드(records) 사용 + +다트 3의 레코드(records)가 유용한 이유는 `==`를 자연스럽게 재정의하고 편리한 구문을 가지고 있기 때문입니다. +예를 들어, 액티비티 타입과 최대 가격을 모두 허용하도록 공급자를 업데이트할 수 있습니다: + + + +그런 다음 이 provider를 다음과 같이 소비(consume)할 수 있습니다: + + + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart new file mode 100644 index 000000000..4c9d1e874 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart @@ -0,0 +1,29 @@ +import 'dart:convert'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import '../../first_request/codegen/activity.dart'; + +part 'family.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity( + ActivityRef ref, + // provider에 인수를 추가할 수 있습니다. + // 매개변수 타입은 원하는 대로 지정할 수 있습니다. + String activityType, +) async { + // "activityType" 인수를 사용하여 URL을 작성할 수 있습니다. + // "https://boredapi.com/api/activity?type="을 가리키게 됩니다. + final response = await http.get( + Uri( + scheme: 'https', + host: 'boredapi.com', + path: '/api/activity', + // 쿼리 매개변수를 수동으로 인코딩할 필요 없이 "Uri" 클래스가 자동으로 인코딩합니다. + queryParameters: {'type': activityType}, + ), + ); + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart new file mode 100644 index 000000000..c88a2122c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart @@ -0,0 +1,200 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'cb76e67cd45f1823d3ed497a235be53819ce2eaf'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [activity]. +@ProviderFor(activity) +const activityProvider = ActivityFamily(); + +/// See also [activity]. +class ActivityFamily extends Family { + /// See also [activity]. + const ActivityFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'activityProvider'; + + /// See also [activity]. + ActivityProvider call( + String activityType, + ) { + return ActivityProvider( + activityType, + ); + } + + @visibleForOverriding + @override + ActivityProvider getProviderOverride( + covariant ActivityProvider provider, + ) { + return call( + provider.activityType, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FutureOr Function(ActivityRef ref) create) { + return _$ActivityFamilyOverride(this, create); + } +} + +class _$ActivityFamilyOverride implements FamilyOverride { + _$ActivityFamilyOverride(this.overriddenFamily, this.create); + + final FutureOr Function(ActivityRef ref) create; + + @override + final ActivityFamily overriddenFamily; + + @override + ActivityProvider getProviderOverride( + covariant ActivityProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [activity]. +class ActivityProvider extends AutoDisposeFutureProvider { + /// See also [activity]. + ActivityProvider( + String activityType, + ) : this._internal( + (ref) => activity( + ref as ActivityRef, + activityType, + ), + from: activityProvider, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$activityHash, + dependencies: ActivityFamily._dependencies, + allTransitiveDependencies: ActivityFamily._allTransitiveDependencies, + activityType: activityType, + ); + + ActivityProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.activityType, + }) : super.internal(); + + final String activityType; + + @override + Override overrideWith( + FutureOr Function(ActivityRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: ActivityProvider._internal( + (ref) => create(ref as ActivityRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + activityType: activityType, + ), + ); + } + + @override + (String,) get argument { + return (activityType,); + } + + @override + AutoDisposeFutureProviderElement createElement() { + return _ActivityProviderElement(this); + } + + ActivityProvider _copyWith( + FutureOr Function(ActivityRef ref) create, + ) { + return ActivityProvider._internal( + (ref) => create(ref as ActivityRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + activityType: activityType, + ); + } + + @override + bool operator ==(Object other) { + return other is ActivityProvider && other.activityType == activityType; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, activityType.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin ActivityRef on AutoDisposeFutureProviderRef { + /// The parameter `activityType` of this provider. + String get activityType; +} + +class _ActivityProviderElement + extends AutoDisposeFutureProviderElement with ActivityRef { + _ActivityProviderElement(super.provider); + + @override + String get activityType => (origin as ActivityProvider).activityType; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart new file mode 100644 index 000000000..1454fb399 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart @@ -0,0 +1,32 @@ +// ignore_for_file: avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import '../../first_request/codegen/activity.dart'; + +// Necessary for code-generation to work +part 'provider.g.dart'; + +FutureOr fetchActivity() => throw UnimplementedError(); + +/* SNIPPET START */ +// "함수형" provider +@riverpod +Future activity(ActivityRef ref) async { + // TODO: 네트워크 요청을 수행하여 액티비티를 가져옵니다 + return fetchActivity(); +} + +// 또는, "notifier" +@riverpod +class ActivityNotifier2 extends _$ActivityNotifier2 { + /// Notifier 인자(arguments)는 빌드 메서드에 지정됩니다. + /// 원하는 개수만큼 지정할 수 있고, 이름도 지정할 수 있으며, 선택적/명명할 수도 있습니다. + @override + Future build(String activityType) async { + // 인수는 "this."으로도 사용할 수 있습니다. + print(this.activityType); + + // TODO: 네트워크 요청을 수행하여 액티비티를 가져옵니다 + return fetchActivity(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart new file mode 100644 index 000000000..7b8a4fd90 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart @@ -0,0 +1,232 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'2f9496c5d70de9314c67e5c48ac44d8b149bc471'; + +/// See also [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +String _$activityNotifier2Hash() => r'9e67c655d53a9f98c3b012a0534421385dde0339'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +abstract class _$ActivityNotifier2 + extends BuildlessAutoDisposeAsyncNotifier { + late final String activityType; + + FutureOr build( + String activityType, + ); +} + +/// See also [ActivityNotifier2]. +@ProviderFor(ActivityNotifier2) +const activityNotifier2Provider = ActivityNotifier2Family(); + +/// See also [ActivityNotifier2]. +class ActivityNotifier2Family extends Family { + /// See also [ActivityNotifier2]. + const ActivityNotifier2Family(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'activityNotifier2Provider'; + + /// See also [ActivityNotifier2]. + ActivityNotifier2Provider call( + String activityType, + ) { + return ActivityNotifier2Provider( + activityType, + ); + } + + @visibleForOverriding + @override + ActivityNotifier2Provider getProviderOverride( + covariant ActivityNotifier2Provider provider, + ) { + return call( + provider.activityType, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(ActivityNotifier2 Function() create) { + return _$ActivityNotifier2FamilyOverride(this, create); + } +} + +class _$ActivityNotifier2FamilyOverride implements FamilyOverride { + _$ActivityNotifier2FamilyOverride(this.overriddenFamily, this.create); + + final ActivityNotifier2 Function() create; + + @override + final ActivityNotifier2Family overriddenFamily; + + @override + ActivityNotifier2Provider getProviderOverride( + covariant ActivityNotifier2Provider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [ActivityNotifier2]. +class ActivityNotifier2Provider + extends AutoDisposeAsyncNotifierProviderImpl { + /// See also [ActivityNotifier2]. + ActivityNotifier2Provider( + String activityType, + ) : this._internal( + () => ActivityNotifier2()..activityType = activityType, + from: activityNotifier2Provider, + name: r'activityNotifier2Provider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$activityNotifier2Hash, + dependencies: ActivityNotifier2Family._dependencies, + allTransitiveDependencies: + ActivityNotifier2Family._allTransitiveDependencies, + activityType: activityType, + ); + + ActivityNotifier2Provider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.activityType, + }) : super.internal(); + + final String activityType; + + @override + FutureOr runNotifierBuild( + covariant ActivityNotifier2 notifier, + ) { + return notifier.build( + activityType, + ); + } + + @override + Override overrideWith(ActivityNotifier2 Function() create) { + return ProviderOverride( + origin: this, + override: ActivityNotifier2Provider._internal( + () => create()..activityType = activityType, + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + activityType: activityType, + ), + ); + } + + @override + (String,) get argument { + return (activityType,); + } + + @override + AutoDisposeAsyncNotifierProviderElement + createElement() { + return _ActivityNotifier2ProviderElement(this); + } + + ActivityNotifier2Provider _copyWith( + ActivityNotifier2 Function() create, + ) { + return ActivityNotifier2Provider._internal( + () => create()..activityType = activityType, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + activityType: activityType, + ); + } + + @override + bool operator ==(Object other) { + return other is ActivityNotifier2Provider && + other.activityType == activityType; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, activityType.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin ActivityNotifier2Ref on AutoDisposeAsyncNotifierProviderRef { + /// The parameter `activityType` of this provider. + String get activityType; +} + +class _ActivityNotifier2ProviderElement + extends AutoDisposeAsyncNotifierProviderElement + with ActivityNotifier2Ref { + _ActivityNotifier2ProviderElement(super.provider); + + @override + String get activityType => (origin as ActivityNotifier2Provider).activityType; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts new file mode 100644 index 000000000..42ce35bff --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/provider.dart"; +import codegen from "!!raw-loader!./codegen/provider.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart new file mode 100644 index 000000000..ed154e255 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart @@ -0,0 +1,24 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../../first_request/raw/activity.dart'; +import 'family.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + AsyncValue activity = ref.watch( + // 이제 provider는 액티비티 타입을 기대하는 함수입니다. + // 단순화를 위해 지금은 상수 문자열을 전달하겠습니다. + activityProvider('recreational'), + ); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart new file mode 100644 index 000000000..3bd3fdf27 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart @@ -0,0 +1,23 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +final activityProvider = Provider.family((ref, id) { + throw UnimplementedError(); +}); + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + // 대신 문자열 목록을 허용하도록 activityProvider를 업데이트할 수 있습니다. + // 그런 다음 watch를 호출하여 해당 목록을 직접 만들 수 있습니다. + ref.watch(activityProvider(['recreational', 'cooking'])); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart new file mode 100644 index 000000000..337eab2d1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart @@ -0,0 +1,20 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../../first_request/raw/activity.dart'; +import 'provider.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + AsyncValue activity = ref.watch(activityProvider); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart new file mode 100644 index 000000000..e9ce32d48 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart @@ -0,0 +1,23 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'tuple_family.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + ref.watch( + // Record를 사용하여 매개 변수를 전달할 수 있습니다. + // Record가 ==를 재정의하므로 watch 호출에서 직접 Record를 생성해도 괜찮습니다. + activityProvider((type: 'recreational', maxPrice: 40)), + ); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart new file mode 100644 index 000000000..b8229619a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart @@ -0,0 +1,40 @@ +// ignore_for_file: unnecessary_this, avoid_print + +import 'dart:async'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import '../../first_request/raw/activity.dart'; + +FutureOr fetchActivity(String activityType) => throw UnimplementedError(); + +/* SNIPPET START */ +// "함수형" provider +final activityProvider = FutureProvider.autoDispose + // ".family" 수정자(modifier)를 사용합니다. + // "String" 제네릭 타입은 인수 타입에 해당합니다. + // 이제 provider는 "ref" 외에 액티비티 타입이라는 추가 인수를 받습니다. + .family((ref, activityType) async { + // TODO: "activityType"을 사용하여 액티비티를 가져오기 위한 네트워크 요청을 수행합니다. + return fetchActivity(activityType); +}); + +// "notifier" provider +final activityProvider2 = AsyncNotifierProvider.autoDispose + // 여기서도 ".family" 수정자를 사용하고 인수를 "String" 유형으로 지정합니다. + .family( + ActivityNotifier.new, +); + +// notifiers에 '.family'를 사용할 때는 notifier 서브클래스를 변경해야 합니다: +// AsyncNotifier -> FamilyAsyncNotifier +// AutoDisposeAsyncNotifier -> AutoDisposeFamilyAsyncNotifier +class ActivityNotifier extends AutoDisposeFamilyAsyncNotifier { + /// Family 인자는 빌드 메서드에 전달되며 this.arg로 액세스할 수 있습니다. + @override + Future build(String activityType) async { + // 인수는 "this.arg"로도 사용할 수 있습니다. + print(this.arg); + + // TODO: 액티비티를 가져오기 위한 네트워크 요청을 수행합니다. + return fetchActivity(activityType); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart new file mode 100644 index 000000000..3a8160027 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart @@ -0,0 +1,37 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../../first_request/raw/activity.dart'; +import 'family.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + AsyncValue activity = ref.watch( + // 이제 provider는 액티비티 타입을 기대하는 함수입니다. + // 단순화를 위해 지금은 상수 문자열을 전달하겠습니다. + activityProvider('recreational'), + ); + /* SNIPPET START */ + return Consumer( + builder: (context, ref, child) { + final recreational = ref.watch(activityProvider('recreational')); + final cooking = ref.watch(activityProvider('cooking')); + + // 그러면 두 활동을 모두 렌더링할 수 있습니다. + // 두 요청이 모두 병렬로 발생하고 올바르게 캐시됩니다. + return Column( + children: [ + Text(recreational.valueOrNull?.activity ?? ''), + Text(cooking.valueOrNull?.activity ?? ''), + ], + ); + }, + ); + /* SNIPPET END */ + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart new file mode 100644 index 000000000..b1c7e862b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart @@ -0,0 +1,26 @@ +import 'dart:async'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import '../../first_request/raw/activity.dart'; + +/* SNIPPET START */ + +FutureOr fetchActivity() => throw UnimplementedError(); + +// "함수형" provider +final activityProvider = FutureProvider.autoDispose((ref) async { + // TODO: 액티비티를 가져오기 위한 네트워크 요청을 수행합니다. + return fetchActivity(); +}); + +// 또는, "notifier" +final activityProvider2 = AsyncNotifierProvider( + ActivityNotifier.new, +); + +class ActivityNotifier extends AsyncNotifier { + @override + Future build() async { + // TODO: 액티비티를 가져오기 위한 네트워크 요청을 수행합니다. + return fetchActivity(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart new file mode 100644 index 000000000..d0a6edaf6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart @@ -0,0 +1,34 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import '../../first_request/raw/activity.dart'; + +/* SNIPPET START */ + +// provider에게 전달할 매개변수를 나타내는 record를 정의합니다. +// typedef는 선택 사항이지만 코드를 더 읽기 쉽게 만들 수 있습니다. + +typedef ActivityParameters = ({String type, int maxPrice}); + +final activityProvider = FutureProvider.autoDispose + // 이제 새로 정의된 record를 인수 유형으로 사용합니다. + .family((ref, arguments) async { + final response = await http.get( + Uri( + scheme: 'https', + host: 'boredapi.com', + path: '/api/activity', + queryParameters: { + // 마지막으로 인수를 사용하여 쿼리 매개변수를 업데이트할 수 있습니다. + 'type': arguments.type, + 'price': arguments.maxPrice, + }, + ), + ); + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx new file mode 100644 index 000000000..419ff377a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx @@ -0,0 +1,48 @@ +--- +title: 로깅 및 오류 보고 +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import providerObserver from "!!raw-loader!./provider_observer/provider_observer.dart"; + +Riverpod은 기본적으로 provider 트리에서 발생하는 모든 이벤트를 수신하는 방법을 제공합니다. +이 기능은 모든 이벤트를 기록하거나 원격 서비스에 오류를 보고하는 데 사용할 수 있습니다. + +이는 `ProviderObserver` 클래스를 사용하고 이를 `ProviderScope`/`ProviderContainer`에 전달하면 됩니다. + +## ProviderObserver 정의하기 + +`ProviderObserver`는 확장(extend)해야 하는 클래스입니다. +이벤트를 수신하기 위해 재정의할 수 있는 다양한 메서드를 제공합니다: + +- `didAddProvider`, provider가 트리에 추가(added)될때 호출 +- `didUpdateProvider`, provider가 갱신(updated)될때 호출 +- `didDisposeProvider`, provider가 폐기(disposed)될때 호출 +- `providerDidFail`, synchronous provider가 에러를 던질때 호출 + + + +## ProviderObserver 사용하기 + +이제 옵저버(observer)를 정의했으니 이를 사용해야 합니다. +그러기 위해서는 `ProviderScope` 또는 `ProviderContainer`에 전달해야 합니다: + +```dart +runApp( + ProviderScope( + observers: [ + MyObserver(), + ], + child: MyApp(), + ) +); +``` + +```dart +final container = ProviderContainer( + observers: [ + MyObserver(), + ], +); +``` diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart new file mode 100644 index 000000000..dd75afb01 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart @@ -0,0 +1,43 @@ +// ignore_for_file: avoid_print + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class MyObserver extends ProviderObserver { + @override + void didAddProvider( + ProviderBase provider, + Object? value, + ProviderContainer container, + ) { + print('Provider $provider was initialized with $value'); + } + + @override + void didDisposeProvider( + ProviderBase provider, + ProviderContainer container, + ) { + print('Provider $provider was disposed'); + } + + @override + void didUpdateProvider( + ProviderBase provider, + Object? previousValue, + Object? newValue, + ProviderContainer container, + ) { + print('Provider $provider updated from $previousValue to $newValue'); + } + + @override + void providerDidFail( + ProviderBase provider, + Object error, + StackTrace stackTrace, + ProviderContainer container, + ) { + print('Provider $provider threw $error at $stackTrace'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx new file mode 100644 index 000000000..7526dd86a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx @@ -0,0 +1,407 @@ +--- +title: 부가 작업 수행(Performing side effects) +version: 1 +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import Legend, { colors } from "./first_request/legend/legend"; +import todoListProvider from "./side_effects/todo_list_provider"; +import todoListNotifier from "./side_effects/todo_list_notifier"; +import todoListNotifierAddTodo from "./side_effects/todo_list_notifier_add_todo"; +import consumerAddTodoCall from "!!raw-loader!./side_effects/raw/consumer_add_todo_call.dart"; +import restAddTodo from "!!raw-loader!./side_effects/raw/rest_add_todo.dart"; +import invalidateSelfAddTodo from "!!raw-loader!./side_effects/raw/invalidate_self_add_todo.dart"; +import manualAddTodo from "!!raw-loader!./side_effects/raw/manual_add_todo.dart"; +import mutableManualAddTodo from "!!raw-loader!./side_effects/raw/mutable_manual_add_todo.dart"; +import renderAddTodo from "./side_effects/render_add_todo"; + +지금까지는 데이터를 가져오는 방법(일명 _GET_ HTTP 요청 수행)만 살펴봤습니다. +하지만 _POST_ 요청과 같은 부수적 효과(side-effect)는 어떨까요? + +애플리케이션은 종종 CRUD(생성, 읽기, 업데이트, 삭제) API를 구현합니다. +이 경우 일반적으로 업데이트 요청(일반적으로 _POST_)은 로컬 캐시를 업데이트해야 합니다. +로컬 캐시도 업데이트하여 UI에 새 상태가 반영되도록 하는 것이 일반적입니다. + +문제는 consumer 내에서 provider의 상태를 어떻게 업데이트할 수 있느냐는 것입니다. +당연히 providers는 자신의 상태(state)를 수정할 수 있는 방법을 노출하지 않습니다. +이는 상태가 통제된 방식으로만 수정되도록 하고 관심사 분리(separation of concerns)를 보장하기 위한 설계입니다. +대신 providers는 자신의 상태를 수정할 수 있는 방법을 명시적으로 노출해야 합니다. + +이를 위해 새로운 개념을 사용할 것입니다: Notifiers. +이 새로운 개념을 보여드리기 위해 좀 더 발전된 예를 사용하겠습니다: 할일 목록(to-do list)입니다. + +## Notifier 정의하기 + +이 시점에서 우리가 이미 알고 있는 것부터 시작하겠습니다: 간단한 _GET_ 요청입니다. +앞서 에서 보았듯이, 글쓰기를 통해 할일 목록을 가져올 수 있습니다: + + + +이제 할 일 목록을 가져왔으니 새 할 일을 추가하는 방법을 살펴봅시다. +이를 위해서는 상태(state) 수정을 위한 공개 API를 노출하도록 provider를 수정해야 합니다. +이 작업은 provider를 "notifier"라고 부르는 것으로 변환하여 수행합니다. + +Notifiers는 providers의 "상태저장 위젯(stateful widget)"입니다. +provider를 정의하는 문법을 약간 수정해야 합니다. +이 새로운 문법은 다음과 같습니다: + + +(MyNotifier.new); + +class MyNotifier extends SomeNotifier { + @override + Result build() { + + } + + +}`} + annotations={[ + { + offset: 6, + length: 4, + label: "provider 변수(variable)", + description: <> + +이 변수는 provider와 상호 작용하는 데 사용됩니다. +변수는 final이고 "top-level"(global)이어야 합니다. + + + }, + { + offset: 13, + length: 20, + label: "provider 타입(type)", + description: <> + +일반적으로 `NotifierProvider`, `AsyncNotifierProvider` 또는 `StreamNotifierProvider` 중 하나입니다. +사용되는 provider 유형은 함수의 반환값(return value)에 따라 달라집니다. +예를 들어, `Future`를 만들려면 `AsyncNotifierProvider`가 필요할 것입니다. + +가장 많이 사용하는 provider는 `AsyncNotifierProvider`입니다. + +:::tip +"어떤 provider를 선택해야 하나"라는 관점에서 생각하지 마세요. +대신 "내가 무엇을 반환하고 싶은가"라는 관점에서 생각하세요. +provider 타입은 자연스럽게 따라올 것입니다. +::: + + + }, + { + offset: 33, + length: 13, + label: "수정자(Modifiers) (옵션)", + description: <> + +종종 provider 유형 뒤에 "수정자(modifier)"가 표시될 수 있습니다. +수정자(modifier)는 선택 사항이며, 타입에 안전한(type-safe) 방식으로 provider의 동작을 조정하는 데 사용됩니다. + +현재 두 가지 수정자(modifier)를 사용할 수 있습니다: + +- `autoDispose`를 설정하면 provider가 더 이상 사용되지 않을 때 자동으로 캐시를 지웁니다. + 도 참조하세요. +- provider에게 인자(arguments)를 전달할 수 있는 `family`. + 도 참조하세요. + + + }, + { + offset: 67, + length: 14, + label: "Notifier의 생성자 (Constructor)", + description: <> + +"notifier providers"의 매개변수는 "notifier"를 인스턴스화할 것으로 예상되는 함수입니다. +일반적으로 "생성자 분리(constructor tear-off)"형식이여야 합니다. + + + }, + { + offset: 86, + length: 16, + label: "Notifier", + description: <> + +`NotifierProvider`가 "StatefulWidget" 클래스인 경우, 이 부분은 `State` 클래스입니다. + +이 클래스는 provider의 상태(state)를 수정하는 방법을 노출하는 역할을 담당합니다. +이 클래스의 공개 메서드는 `ref.read(yourProvider.notifier).yourMethod()`를 사용하여 소비자(consumers)가 액세스할 수 있습니다. + +:::note +UI에서 상태(state)가 변경되었음을 알 수 없기 때문에, Notifiers에는 내장된 `state` 외에 다른 공용 프로퍼티가 없어야 합니다. +::: + + + }, + { + offset: 111, + length: 12, + label: "Notifier 타입(type)", + description: <> + +Notifier가 확장(extend)하는 기반(base) 클래스는 provider + modifiers의 클래스와 일치해야 합니다. +몇 가지 예를 들면 다음과 같습니다: + +- NotifierProvider -> Notifier +- AsyncNotifierProvider -> AsyncNotifier +- AsyncNotifierProvider. + autoDispose -> + AutoDispose + + AsyncNotifier +- AsyncNotifierProvider. + autoDispose. + family + -> AutoDispose + Family + AsyncNotifier + +이 작업을 더 간단하게 하려면 올바른 유형을 자동으로 추론하는 코드 생성기(code generator)를 사용하는 것이 좋습니다. + + + }, + { + offset: 136, + length: 54, + label: "build 메소드(method)", + description: <> + +모든 notifiers는 `build` 메서드를 재정의(override)해야 합니다. +이 메서드는 일반적으로 notifier가 아닌 provider(non-notifier provider)에서 로직을 넣는 위치에 해당합니다. + +이 메서드는 직접 호출해서는 안 됩니다. + + + }, +]} +/> + + + + + + + } + + +}`} + annotations={[ + { + offset: 0, + length: 9, + label: "어노테이션(annotation)", + description: <> + +모든 providers는 `@riverpod` 또는 `@Riverpod()`로 어노테이션해야 합니다. +이 어노테이션은 전역 함수나 클래스에 배치할 수 있습니다. +이 어노테이션을 통해 프로바이더를 구성할 수 있습니다. + +예를 들어, `@Riverpod(keepAlive: true)`를 작성하여 "auto-dispose"(나중에 살펴볼 것임)를 비활성화할 수 있습니다. + + + }, + { + offset: 10, + length: 16, + label: "Notifier", + description: <> + +`@riverpod` 어노테이션이 클래스에 배치되면 해당 클래스를 "Notifier"라고 부릅니다. +클래스는 `_$NotifierName`을 확장해야 하며, 여기서 `NotifierName`은 클래스 이름입니다. + +Notifiers는 provider의 상태(state)를 수정하는 메서드를 노출할 책임이 있습니다. +이 클래스의 공개 메서드는 `ref.read(yourProvider.notifier).yourMethod()`를 사용하여 consumer가 액세스할 수 있습니다. + +:::note +UI에서 상태가 변경되었음을 알 수 있는 수단이 없기 때문에, Notifiers에는 기본 제공 'state' 외에 공개 속성이 없어야 합니다. +::: + + + }, + { + offset: 52, + length: 54, + label: "The build method", + description: <> + +모든 notifiers는 `build` 메서드를 재정의(override)해야 합니다. +이 메서드는 일반적으로 notifier가 아닌 provider(non-notifier provider)에서 로직을 넣는 위치에 해당합니다. + +이 메서드는 직접 호출해서는 안 됩니다. + + + }, +]} +/> + + +참고로, 이 새로운 문법을 이전에 보았던 문법과 비교하려면 를 확인하면 됩니다. + +:::info +`bbuild` 이외의 메서드가 없는 Notifier는 앞서 본 문법을 사용하는 것과 동일합니다. +에 표시된 문법은 UI에서 수정할 방법이 없는 notifiers에 대한 간략한 표현이라고 볼 수 있습니다. +::: + +이제 문법을 살펴봤으니 이전에 정의한 provider를 notifier으로 변환하는 방법을 살펴보겠습니다: +Now that we've seen the syntax, let's see how to convert our previously defined provider to a notifier: + + + +위젯 내에서 provider를 읽는 방법은 변경되지 않았습니다. +이전 구문과 마찬가지로 `ref.watch(todoListProvider)`를 계속 사용할 수 있습니다. + +:::caution +notifier의 생성자에 로직을 넣지 마세요. +`ref` 및 기타 프로퍼티는 아직 사용할 수 없으므로 Notifier에는 생성자가 없어야 합니다. +대신 `build` 메서드에 로직을 넣으세요. + +```dart +class MyNotifier extends ... { + MyNotifier() { + // ❌ 이렇게 하지 마세요. + // 이 경우 예외가 발생합니다. + state = AsyncValue.data(42); + } + + @override + Result build() { + // ✅ 대신 이렇게 하세요. + state = AsyncValue.data(42); + } +} +``` + +::: + +## _POST_ 요청을 수행하는 메서드 노출하기 + +이제 Notifier가 생겼으니 부가 작업(side-effect)을 수행할 수 있는 메서드를 추가할 수 있습니다. +그러한 부가 작업 중 하나는 클라이언트가 새 할 일을 _POST_하도록 하는 것입니다. +notifier에 `addTodo` 메서드를 추가하면 그렇게 할 수 있습니다: + + + +그런 다음 에서 보았던 것과 동일한 `Consumer`/`ConsumerWidget`을 사용하여 UI에서 이 메서드를 호출할 수 있습니다: + + + +:::info +메서드를 호출할 때 `ref.watch` 대신 `ref.read`를 사용하고 있는 것을 주목하세요. +`ref.watch`도 기술적으로는 작동할 수 있지만, "onPressed"와 같은 이벤트 핸들러에서 로직이 수행될 때는 `ref.read`를 사용하는 것이 좋습니다. +::: + +이제 버튼을 누르면 _POST_ 요청을 하는 버튼이 생겼습니다. +그러나 현재로서는 새 할 일 목록을 반영하도록 UI가 업데이트되지 않습니다. +로컬 캐시가 서버의 상태와 일치하기를 원할 것입니다. + +장단점이 있는 몇 가지 방법이 있습니다. + +### API 응답에 맞춰 로컬 캐시 업데이트하기 + +일반적인 백엔드 관행은 _POST_ 요청이 리소스의 새 상태를 반환하도록 하는 것입니다. +특히, 저희 API는 새 할 일을 추가한 후 새 할 일 목록을 반환합니다. +이를 수행하는 한 가지 방법은 `state = AsyncData(response)`를 작성하는 것입니다: + + + +:::tip 장점 + +- UI는 가능한 가장 최신 상태로 유지됩니다. + 다른 사용자가 할 일을 추가하면 우리도 볼 수 있습니다. +- 서버가 진실의 원천입니다. + 이 접근 방식을 사용하면 클라이언트는 할 일 목록에서 새 할 일을 어디에 삽입해야 하는지 알 필요가 없습니다. +- 단 한 번의 네트워크 요청만 필요합니다. + +::: + +:::danger 단점 + +- 이 접근 방식은 서버가 특정 방식으로 구현된 경우에만 작동합니다. + 서버가 새 상태를 반환하지 않으면 이 접근 방식은 작동하지 않습니다. +- 필터/소팅이 있는 경우와 같이 연결된 _GET_ 요청이 더 복잡한 경우에는 여전히 작동하지 않을 수 있습니다. + +::: + +### ref.invalidateSelf()`를 사용하여 provider를 새로고침 + +한 가지 옵션은 provider가 _GET_ 요청을 다시 실행하도록 하는 것입니다. +이는 _POST_ 요청 뒤에 `ref.invalidateSelf()`를 호출하여 수행할 수 있습니다: + + + +:::tip 장점 + +- UI는 가능한 가장 최신 상태로 유지됩니다. + 다른 사용자가 할 일을 추가하면 우리도 볼 수 있습니다. +- 서버가 진실의 원천입니다. + 이 접근 방식을 사용하면 클라이언트는 할 일 목록에서 새 할 일을 어디에 삽입해야 하는지 알 필요가 없습니다. +- 이 접근 방식은 서버 구현에 관계없이 작동합니다. + 필터/소팅이 포함된 경우와 같이 _GET_ 요청이 더 복잡한 경우에 특히 유용할 수 있습니다. + +::: + +:::danger 단점 + +- 이 접근 방식은 비효율적일 수 있는 추가 _GET_ 요청을 수행합니다. + +::: + +### 로컬 캐시 수동 업데이트 + +또 다른 옵션은 로컬 캐시를 수동으로 업데이트하는 것입니다. +여기에는 백엔드의 동작을 모방하는 작업이 포함됩니다. +예를 들어, 백엔드가 새 항목을 처음에 삽입하는지 아니면 마지막에 삽입하는지 알아야 합니다. + + + +:::info +이 예제에서는 불변(immutable) 상태를 사용합니다. 이는 필수는 아니지만 권장 사항입니다. +자세한 내용은 를 참조하세요. +대신 변경 가능한 상태를 사용하려는 경우 다른 방법을 사용할 수 있습니다: + + + +::: + +:::tip 장점 + +- 이 접근 방식은 서버 구현에 관계없이 작동합니다. +- 네트워크 요청은 단 한 번만 필요합니다. + +::: + +:::danger 단점 + +- 로컬 캐시가 서버의 상태와 일치하지 않을 수 있습니다. + 다른 사용자가 할 일을 추가한 경우 이를 볼 수 없습니다. +- 이 접근 방식은 백엔드의 로직을 효과적으로 복제하고 구현하기가 더 복잡할 수 있습니다. + +::: + +## 더 알아보기: 스피너(spinner) 표시 및 오류 처리(error handling) + +지금까지 살펴본 바에 따르면 버튼을 누르면 _POST_ 요청을 하고 요청이 완료되면 변경 사항을 반영하여 UI가 업데이트되는 버튼이 있습니다. +하지만 현재로서는 요청이 수행되고 있다는 표시도 없고, 요청이 실패할 경우 어떤 정보도 표시되지 않습니다. + +한 가지 방법은 로컬 위젯 상태에 `addTodo`가 반환한 Future를 저장한 다음 해당 Future를 수신하여 스피너 또는 오류 메시지를 표시하는 것입니다. +이 시나리오에서는 [flutter_hooks](https://pub.dev/packages/flutter_hooks)가 유용합니다. +물론 `StatefulWidget`을 대신 사용할 수도 있습니다. + +다음 스니펫은 작업이 보류 중인 동안 진행률 표시기를 보여줍니다. +그리고 실패하면 버튼을 빨간색으로 렌더링합니다: + +![A button which turns red when the operation failed](/img/essentials/side_effects/spinner.gif) + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart new file mode 100644 index 000000000..2f3d450ed --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart @@ -0,0 +1,28 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo_list_notifier.freezed.dart'; +part 'todo_list_notifier.g.dart'; + +@freezed +class Todo with _$Todo { + factory Todo({ + required String description, + @Default(false) bool completed, + }) = _Todo; + + factory Todo.fromJson(Map json) => _$TodoFromJson(json); +} + +/* SNIPPET START */ +@riverpod +class TodoList extends _$TodoList { + @override + Future> build() async { + // 이전에 FutureProvider에 있던 로직이 이제 빌드 메서드에 있습니다. + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart new file mode 100644 index 000000000..3326f9ffa --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart @@ -0,0 +1,166 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'todo_list_notifier.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Todo _$TodoFromJson(Map json) { + return _Todo.fromJson(json); +} + +/// @nodoc +mixin _$Todo { + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$TodoImpl implements _Todo { + _$TodoImpl({required this.description, this.completed = false}); + + factory _$TodoImpl.fromJson(Map json) => + _$$TodoImplFromJson(json); + + @override + final String description; + @override + @JsonKey() + final bool completed; + + @override + String toString() { + return 'Todo(description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); + + @override + Map toJson() { + return _$$TodoImplToJson( + this, + ); + } +} + +abstract class _Todo implements Todo { + factory _Todo({required final String description, final bool completed}) = + _$TodoImpl; + + factory _Todo.fromJson(Map json) = _$TodoImpl.fromJson; + + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart new file mode 100644 index 000000000..4e6801ff7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -0,0 +1,42 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_notifier.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$TodoImpl _$$TodoImplFromJson(Map json) => _$TodoImpl( + description: json['description'] as String, + completed: json['completed'] as bool? ?? false, + ); + +Map _$$TodoImplToJson(_$TodoImpl instance) => + { + 'description': instance.description, + 'completed': instance.completed, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todoListHash() => r'c939d438b07da6065dbbcfab86c27ef363bdb76c'; + +/// See also [TodoList]. +@ProviderFor(TodoList) +final todoListProvider = + AutoDisposeAsyncNotifierProvider>.internal( + TodoList.new, + name: r'todoListProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$TodoList = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart new file mode 100644 index 000000000..589d4b64e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart @@ -0,0 +1,26 @@ +// ignore_for_file: avoid_print + +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'todo_list_notifier.dart'; + +part 'todo_list_notifier_add_todo.g.dart'; + +/* SNIPPET START */ +@riverpod +class TodoList extends _$TodoList { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + await http.post( + Uri.https('your_api.com', '/todos'), + // 할 일 개체를 직렬화하여 서버에 POST합니다. + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart new file mode 100644 index 000000000..8d2e07c04 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_notifier_add_todo.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todoListHash() => r'4008395aaca8f55312f668c0b2a32e7599f82349'; + +/// See also [TodoList]. +@ProviderFor(TodoList) +final todoListProvider = + AutoDisposeAsyncNotifierProvider>.internal( + TodoList.new, + name: r'todoListProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$TodoList = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart new file mode 100644 index 000000000..dd8082be4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart @@ -0,0 +1,23 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo_list_provider.freezed.dart'; +part 'todo_list_provider.g.dart'; + +@freezed +class Todo with _$Todo { + factory Todo({ + required String description, + @Default(false) bool completed, + }) = _Todo; +} + +/* SNIPPET START */ +@riverpod +Future> todoList(TodoListRef ref) async { + // 네트워크 요청을 시뮬레이션합니다. 이는 일반적으로 실제 API로부터 수신됩니다. + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart new file mode 100644 index 000000000..26a2d640c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart @@ -0,0 +1,148 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'todo_list_provider.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$Todo { + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc + +class _$TodoImpl implements _Todo { + _$TodoImpl({required this.description, this.completed = false}); + + @override + final String description; + @override + @JsonKey() + final bool completed; + + @override + String toString() { + return 'Todo(description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @override + int get hashCode => Object.hash(runtimeType, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); +} + +abstract class _Todo implements Todo { + factory _Todo({required final String description, final bool completed}) = + _$TodoImpl; + + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart new file mode 100644 index 000000000..caa526bca --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todoListHash() => r'26b30307668c8feefa7cbe3c400b73e6edccbc39'; + +/// See also [todoList]. +@ProviderFor(todoList) +final todoListProvider = AutoDisposeFutureProvider>.internal( + todoList, + name: r'todoListProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef TodoListRef = AutoDisposeFutureProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart new file mode 100644 index 000000000..f869a1175 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart @@ -0,0 +1,25 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../raw/todo_list_notifier.dart' show Todo; +import '../raw/todo_list_notifier_add_todo.dart'; + +/* SNIPPET START */ +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return ElevatedButton( + onPressed: () { + // "ref.read"를 "myProvider.notifier"와 사용하면 + // notifier의 클래스 인스턴스를 얻을 수 있습니다. + // 이를 통해 "addTodo" 메서드를 호출할 수 있습니다. + ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + }, + child: const Text('Add todo'), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart new file mode 100644 index 000000000..e83b3708f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart @@ -0,0 +1,38 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // API 응답은 신경 쓰지 않습니다. + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // 포스트 요청이 완료되면 로컬 캐시를 더티(dirty)로 표시할 수 있습니다. + // 이렇게 하면 notifier의 "build"가 비동기적으로 다시 호출되고, 이 때 리스너(listener)에게 알림이 전송됩니다. + + ref.invalidateSelf(); + + // (선택 사항) 그런 다음 새 상태가 계산될 때까지 기다릴 수 있습니다. + // 이렇게 하면 새 상태를 사용할 수 있을 때까지 "addTodo"가 완료되지 않습니다. + await future; + } +/* SNIPPET END */ +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart new file mode 100644 index 000000000..54e454954 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart @@ -0,0 +1,39 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // API 응답은 신경 쓰지 않습니다. + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // 그런 다음 로컬 캐시를 수동으로 업데이트할 수 있습니다. 이를 위해서는 이전 상태를 가져와야 합니다. + // 주의: 이전 상태가 여전히 로딩 중이거나 오류 상태일 수 있습니다. + // 이 문제를 우아하게 처리하는 방법은 `this.state` 대신 `this.future`를 읽어서 로딩 상태를 기다리게 하고 + // 상태가 오류 상태인 경우 오류를 발생시키는 것입니다. + final previousState = await future; + + // 그런 다음 새 상태 객체를 생성하여 상태를 업데이트할 수 있습니다. + // 그러면 모든 리스너에게 알림이 전송됩니다. + state = AsyncData([...previousState, todo]); + } +/* SNIPPET END */ +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart new file mode 100644 index 000000000..aece4d511 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart @@ -0,0 +1,34 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + // API 응답은 신경 쓰지 않습니다. + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + /* SNIPPET START */ + final previousState = await future; + // 이전 할 일 목록을 변경합니다. (Mutable) + previousState.add(todo); + // 리스너에게 수동으로 알림을 전송합니다. + ref.notifyListeners(); +/* SNIPPET END */ + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart new file mode 100644 index 000000000..9e97a21a1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart @@ -0,0 +1,75 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'rest_add_todo.dart'; +import 'todo_list_notifier.dart' show Todo; + +void main() { + runApp( + const ProviderScope(child: MyApp()), + ); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return const MaterialApp(home: Example()); + } +} + +/* SNIPPET START */ +class Example extends ConsumerStatefulWidget { + const Example({super.key}); + + @override + ConsumerState createState() => _ExampleState(); +} + +class _ExampleState extends ConsumerState { + // pending중인 addTodo 작업입니다. 또는 pending중인 작업이 없으면 null입니다. + Future? _pendingAddTodo; + + @override + Widget build(BuildContext context) { + return FutureBuilder( + // pending중인 작업을 수신하여 그에 따라 UI를 업데이트합니다. + future: _pendingAddTodo, + builder: (context, snapshot) { + // 오류 상태가 있는지 여부를 계산합니다. + // 연결 상태(connectionState) 확인은 연산을 다시 시도할 때 처리합니다. + final isErrored = snapshot.hasError && snapshot.connectionState != ConnectionState.waiting; + + return Row( + children: [ + ElevatedButton( + style: ButtonStyle( + // 오류가 있는 경우 버튼이 빨간색으로 표시됩니다. + backgroundColor: MaterialStateProperty.all( + isErrored ? Colors.red : null, + ), + ), + onPressed: () { + // addTodo가 반환한 future를 변수에 보관합니다. + final future = ref.read(todoListProvider.notifier).addTodo(Todo(description: 'This is a new todo')); + + // 해당 future를 로컬 상태에 저장합니다. + setState(() { + _pendingAddTodo = future; + }); + }, + child: const Text('Add todo'), + ), + // 작업이 pending중이므로 진행률 표시기(progress indicator)를 표시합니다. + if (snapshot.connectionState == ConnectionState.waiting) ...[ + const SizedBox(width: 8), + const CircularProgressIndicator(), + ] + ], + ); + }, + ); + } +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart new file mode 100644 index 000000000..e5412a8cd --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart @@ -0,0 +1,68 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'rest_add_todo.dart'; +import 'todo_list_notifier.dart' show Todo; + +void main() { + runApp( + const ProviderScope(child: MyApp()), + ); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return const MaterialApp(home: Example()); + } +} + +/* SNIPPET START */ +class Example extends HookConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // pending중인 addTodo 작업입니다. 또는 pending중인 작업이 없으면 null입니다. + final pendingAddTodo = useState?>(null); + // pending인 작업을 수신하여 그에 따라 UI를 업데이트합니다. + final snapshot = useFuture(pendingAddTodo.value); + + // 오류 상태가 있는지 여부를 계산합니다. + // 연결 상태(connectionState) 확인은 작업이 다시 시도될 때 처리하기 위해 여기에 있습니다. + final isErrored = snapshot.hasError && + snapshot.connectionState != ConnectionState.waiting; + + return Row( + children: [ + ElevatedButton( + style: ButtonStyle( + // 오류가 있는 경우 버튼을 빨간색으로 표시합니다. + backgroundColor: MaterialStateProperty.all( + isErrored ? Colors.red : null, + ), + ), + onPressed: () async { + // addTodo가 반환한 future를 변수에 보관합니다. + final future = ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + + // 해당 미래를 로컬 상태에 저장합니다. + pendingAddTodo.value = future; + }, + child: const Text('Add todo'), + ), + // 작업이 pending중이므로 진행률 표시기(progress indicator)를 표시하겠습니다. + if (snapshot.connectionState == ConnectionState.waiting) ...[ + const SizedBox(width: 8), + const CircularProgressIndicator(), + ] + ], + ); + } +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart new file mode 100644 index 000000000..392756b3d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart @@ -0,0 +1,39 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // POST 요청은 새 애플리케이션 상태와 일치하는 List를 반환합니다. + final response = await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // API 응답을 디코딩하여 List로 변환합니다. + List newTodos = (jsonDecode(response.body) as List) + .cast>() + .map(Todo.fromJson) + .toList(); + + // 로컬 캐시를 새 상태와 일치하도록 업데이트합니다. + // 그러면 모든 리스너에게 알림이 전송됩니다. + state = AsyncData(newTodos); + } +/* SNIPPET END */ +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart new file mode 100644 index 000000000..9a6d5f2e5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart @@ -0,0 +1,44 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Todo { + Todo({ + required this.description, + this.completed = false, + }); + + factory Todo.fromJson(Map json) { + return Todo( + description: json['description']! as String, + completed: json['completed']! as bool, + ); + } + + final String description; + final bool completed; + + Map toJson() => { + 'description': description, + 'completed': completed, + }; +} + +/* SNIPPET START */ +// We now use AsyncNotifierProvider instead of FutureProvider +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +// We use an AsyncNotifier because our logic is asynchronous. +// More specifically, we'll need AutoDisposeAsyncNotifier because +// of the "autoDispose" modifier. +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async { + // The logic we previously had in our FutureProvider is now in the build method. + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart new file mode 100644 index 000000000..2023bdc99 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +/* SNIPPET START */ +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + await http.post( + Uri.https('your_api.com', '/todos'), + // We serialize our Todo object and POST it to the server. + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart new file mode 100644 index 000000000..51c621c40 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart @@ -0,0 +1,27 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class Todo { + Todo({ + required this.description, + this.completed = false, + }); + + factory Todo.fromJson(Map json) { + return Todo( + description: json['description'] as String, + completed: json['completed'] as bool, + ); + } + + final String description; + final bool completed; +} + +final todoListProvider = FutureProvider.autoDispose>((ref) async { + // Simulate a network request. This would normally come from a real API + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts new file mode 100644 index 000000000..798feb107 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/render_add_todo.dart"; +import hooks from "!!raw-loader!./raw/render_add_todo_hooks.dart"; + +export default { + raw: raw, + hooks: hooks, + codegen: raw, + hooksCodegen: hooks, +}; \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts new file mode 100644 index 000000000..b32ae3b9b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/todo_list_notifier.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_notifier.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts new file mode 100644 index 000000000..62fb0e0fc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/todo_list_notifier_add_todo.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_notifier_add_todo.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts new file mode 100644 index 000000000..de7789c0b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts @@ -0,0 +1,7 @@ +import raw from "!!raw-loader!./raw/todo_list_provider.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_provider.dart"; + +export default { + raw: raw, + codegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing.mdx new file mode 100644 index 000000000..fe268049e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing.mdx @@ -0,0 +1,148 @@ +--- +title: providers 테스트하기 +--- + +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import createContainer from "!!raw-loader!./testing/create_container.dart"; +import unitTest from "!!raw-loader!./testing/unit_test.dart"; +import widgetTest from "!!raw-loader!./testing/widget_test.dart"; +import fullWidgetTest from "!!raw-loader!./testing/full_widget_test.dart"; +import widgetContainerOf from "!!raw-loader!./testing/widget_container_of.dart"; +import providerToMock from "./testing/provider_to_mock"; +import mockProvider from "!!raw-loader!./testing/mock_provider.dart"; +import autoDisposeListen from "!!raw-loader!./testing/auto_dispose_listen.dart"; +import listenProvider from "!!raw-loader!./testing/listen_provider.dart"; +import awaitFuture from "!!raw-loader!./testing/await_future.dart"; +import notifierMock from "./testing/notifier_mock"; + +Riverpod API의 핵심은 provider를 개별적으로 테스트할 수 있는 기능입니다. + +적절한 테스트 스위트를 위해서는 몇 가지 극복해야 할 과제가 있습니다: + +- 테스트는 상태를 공유해서는 안 됩니다. 즉, 새 테스트가 이전 테스트의 영향을 받지 않아야 합니다. +- 테스트는 원하는 상태를 얻기 위해 특정 기능을 모의할 수 있는 기능을 제공해야 합니다. +- 테스트 환경은 가능한 한 실제 환경과 유사해야 합니다. + +다행히도 Riverpod를 사용하면 이러한 목표를 모두 쉽게 달성할 수 있습니다. + +## 테스트 설정하기 + +Riverpod로 테스트를 정의할 때는 크게 두 가지 시나리오가 있습니다: + +- 일반적으로 Flutter 종속성이 없는 단위 테스트. + 이는 provider의 동작을 단독으로 테스트할 때 유용할 수 있습니다. +- 위젯 테스트: 일반적으로 Flutter 종속성이 있는 위젯 테스트. + 공급자를 사용하는 위젯의 동작을 테스트하는 데 유용할 수 있습니다. + +### 단위 테스트 + +단위 테스트는 [package:test](https://pub.dev/packages/test)의 `test` 함수를 사용하여 정의합니다. + +다른 테스트와 가장 큰 차이점은 `ProviderContainer` 객체를 생성한다는 점입니다. +이 객체를 사용하면 테스트가 provider와 상호 작용할 수 있습니다. + +`ProviderContainer` 객체를 생성하고 폐기하기 위한 테스트 유틸리티를 만드는 것이 좋습니다: + + + +그런 다음 이 유틸리티를 사용하여 `test`를 정의할 수 있습니다: + + + +이제 ProviderContainer가 생겼으니 이를 사용하여 provider를 읽을 수 있습니다: + +- provider의 현재 값을 읽기위해 `container.read` 사용. +- provider를 청취하고, 변경을 통지받기 위해 `container.listen` 사용. + +:::caution +provider가 자동으로 폐기될 때 `container.read`를 사용할 때는 주의하세요. +provider가 리스닝되지 않으면 테스트 도중에 provider의 상태가 파괴될 가능성이 있습니다. + +이 경우 `container.listen`을 사용하는 것을 고려해 보세요. +이 반환값은 어쨌든 provider의 현재 값을 읽을 수 있게 해주지만, +테스트 도중에 provider가 폐기되지 않도록 보장합니다: + + +::: + +### 위젯 테스트 + +위젯 테스트는 [package:flutter_test](https://pub.dev/packages/flutter_test)의 `testWidgets` 함수를 사용하여 정의합니다. + +이 경우 일반적인 위젯 테스트와 가장 큰 차이점은 `tester.pumpWidget`의 루트에 `ProviderScope` 위젯을 추가해야 한다는 점입니다: + + + +이는 Flutter 앱에서 Riverpod을 활성화할 때 하는 작업과 유사합니다. + +그런 다음 `tester`를 사용하여 위젯과 상호 작용할 수 있습니다. +또는 provider와 상호 작용하고 싶다면 `ProviderContainer`를 얻을 수 있습니다. +이는 `ProviderScope.containerOf(buildContext)`를 사용하여 얻을 수 있습니다. +따라서 `tester`를 사용하면 다음과 같이 작성할 수 있습니다: + + + +그런 다음 이를 사용하여 provider를 읽을 수 있습니다. 다음은 전체 예제입니다: + + + +## provider 모킹하기(Mocking) + +지금까지 테스트를 설정하는 방법과 provider와의 기본적인 상호 작용에 대해 살펴보았습니다. +하지만 경우에 따라서는 provider를 모킹(mock)하고 싶을 수도 있습니다. + +멋진 부분: 추가 설정 없이 모든 공급자를 기본적으로 모킹할 수 있습니다. +이는 `ProviderScope` 또는 `ProviderContainer`에 `overrides` 매개변수를 지정하면 가능합니다. + +다음 provider를 살펴봅시다: + + + +다음을 사용하여 모킹해 볼 수 있습니다: + + + +## provider 변경 사항 감시(Spying) + +테스트에서 `ProviderContainer`를 얻었으므로 이를 사용하여 provider를 "listen"할 수 있습니다: + + + +그런 다음 이를 [mockito](https://pub.dev/packages/mockito) 또는 [mocktail](https://pub.dev/packages/mocktail)과 같은 패키지와 결합하여 해당 패키지의 `verify` API를 사용할 수 있습니다. +또는 더 간단하게는 목록에 모든 변경 사항을 추가하고 어설트(assert)할 수 있습니다. + +## 비동기 provider를 기다리기 + +Riverpod에서는 provider가 Future/Stream을 반환하는 경우가 매우 흔합니다. +이 경우 테스트에서 해당 비동기 연산이 완료될 때까지 기다려야 할 가능성이 있습니다. + +이를 위한 한 가지 방법은 프로바이더의 '.future'를 읽는 것입니다: + + + +## Notifiers 모킹하기 + +일반적으로 Notifiers를 모의하는 것은 권장하지 않습니다. +그 대신에, Notifier의 로직에 어느 정도 추상화 수준을 도입하여 그 추상화를 모킹할 수 있도록 해야 합니다. +예를 들어, Notifier을 모킹하는 대신 Notifier가 데이터를 가져오는 데 사용하는 "repository"를 모킹할 수 있습니다. + +Notifier를 모킹하려는 경우, 모킹을 만들 때 특별히 고려해야 할 사항이 있습니다: +모의 클래스는 반드시 원래 Notifier 베이스 클래스를 서브 클래싱해야 합니다: +인터페이스를 손상시킬 수 있으므로 Notifier를 "implement"할 수 없습니다. + +따라서 Notifier를 모킹할 때는 다음과 같은 mockito 코드를 작성하지 마세요: + +```dart +class MyNotifierMock with Mock implements MyNotifier {} +``` + +대신 다음과 같이 작성하세요: + + + + + +이 기능을 사용하려면 목(Mock)을 모킹하려는 Notifier와 동일한 파일에 배치해야 합니다. +그렇지 않으면 `_$MyNotifier` 클래스에 액세스할 수 없습니다. + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart new file mode 100644 index 000000000..f16a2d6c8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 'Hello world'); + +void main() { + test('Some description', () { + final container = createContainer(); + /* SNIPPET START */ + final subscription = container.listen(provider, (_, __) {}); + + expect( + // `container.read(provider)`와 동일합니다. + // 그러나 "subscription"이 disposed되지 않는 한 provider는 disposed되지 않습니다. + subscription.read(), + 'Some value', + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart new file mode 100644 index 000000000..10bc7e238 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart @@ -0,0 +1,29 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = FutureProvider((_) async => 42); + +void main() { + test('Some description', () async { + // 이 테스트에 대한 ProviderContainer를 생성합니다. + // DO NOT: 테스트 간에 ProviderContainer를 공유하지 마세요. + final container = createContainer(); + + /* SNIPPET START */ + // TODO: 컨테이너를 사용하여 애플리케이션을 테스트합니다. + // 기대는 비동기적이므로 "expectLater"를 사용해야 합니다. + await expectLater( + // "provider"대신 "provider.future"를 읽습니다. + // 이는 비동기 provider에서 가능하며, provider의 value로 resolve되는 future를 반환합니다. + container.read(provider.future), + // future가 예상 값으로 resolve되는지 확인할 수 있습니다. + // 또는 오류에 "throwsA"를 사용할 수 있습니다. + completion('some value'), + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart new file mode 100644 index 000000000..c0aab45e6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart @@ -0,0 +1,22 @@ +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +/// [ProviderContainer]를 생성하고 +/// 테스트가 끝나면 자동으로 폐기하는 테스트 유틸리티입니다. +ProviderContainer createContainer({ + ProviderContainer? parent, + List overrides = const [], + List? observers, +}) { + // ProviderContainer를 생성하고 선택적으로 매개변수 지정을 허용합니다. + final container = ProviderContainer( + parent: parent, + overrides: overrides, + observers: observers, + ); + + // 테스트가 끝나면 container를 폐기합니다. + addTearDown(container.dispose); + + return container; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart new file mode 100644 index 000000000..325292aa7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart @@ -0,0 +1,33 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +final provider = Provider((_) => 'some value'); + +class YourWidgetYouWantToTest extends StatelessWidget { + const YourWidgetYouWantToTest({super.key}); + + @override + Widget build(BuildContext context) => const Placeholder(); +} + +/* SNIPPET START */ +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + + final element = tester.element(find.byType(YourWidgetYouWantToTest)); + final container = ProviderScope.containerOf(element); + + // TODO providers와 상호작용합니다. + expect( + container.read(provider), + 'some value', + ); + }); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart new file mode 100644 index 000000000..d2e840d9b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 'Hello world'); + +void main() { + test('Some description', () { + final container = createContainer(); + /* SNIPPET START */ + container.listen( + provider, + (previous, next) { + print('The provider changed from $previous to $next'); + }, + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart new file mode 100644 index 000000000..d939aa2e7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart @@ -0,0 +1,45 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +import 'create_container.dart'; +import 'full_widget_test.dart'; +import 'provider_to_mock/raw.dart'; + +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + /* SNIPPET START */ + // 단위 테스트에서는 이전의 "createContainer" 유틸리티를 재사용합니다. + final container = createContainer( + // 모킹할 provider 목록을 지정할 수 있습니다: + overrides: [ + // 이 경우 "exampleProvider"를 모킹하고 있습니다. + exampleProvider.overrideWith((ref) { + // 이 함수는 provider의 일반적인 초기화 함수입니다. + // 일반적으로 "ref.watch"를 호출하여 초기 상태를 반환하는 곳입니다. + + // 기본값인 "Hello world"를 사용자 정의 값으로 바꾸어 보겠습니다. + // 그러면 `exampleProvider`와 상호 작용하면 이 값이 반환됩니다. + return 'Hello from tests'; + }), + ], + ); + + // ProviderScope를 사용하여 위젯 테스트에서도 동일한 작업을 수행할 수 있습니다: + await tester.pumpWidget( + ProviderScope( + // ProviderScopes에는 정확히 동일한 "overrides" 매개변수가 있습니다. + overrides: [ + // 이전과 동일 + exampleProvider.overrideWith((ref) => 'Hello from tests'), + ], + child: const YourWidgetYouWantToTest(), + ), + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart new file mode 100644 index 000000000..ccb009f3f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart @@ -0,0 +1,17 @@ +// ignore_for_file: prefer_mixin + +import 'package:mockito/mockito.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() => throw UnimplementedError(); +} + +// Mock 클래스는 notifier가 사용하는 것에 해당하는 Notifier base-class를 서브클래싱해야 합니다. +class MyNotifierMock extends _$MyNotifier with Mock implements MyNotifier {} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart new file mode 100644 index 000000000..b2d7b9dac --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'912fa35c2296626fc0825bcbcfc6b6c85958be02'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart new file mode 100644 index 000000000..e7b1c6f0e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart @@ -0,0 +1,15 @@ +// ignore_for_file: prefer_mixin + +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:mockito/mockito.dart'; + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() => throw UnimplementedError(); +} + +// Your mock needs to subclass the Notifier base-class corresponding +// to whatever your notifier uses +class MyNotifierMock extends Notifier with Mock implements MyNotifier {} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart new file mode 100644 index 000000000..2aea771eb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +// 이른 초기화된 provider. +@riverpod +Future example(ExampleRef ref) async => 'Hello world'; +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart new file mode 100644 index 000000000..dd85f62f9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeFutureProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart new file mode 100644 index 000000000..aad01febe --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart @@ -0,0 +1,6 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +// An eagerly initialized provider. +final exampleProvider = FutureProvider((ref) async => 'Hello world'); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart new file mode 100644 index 000000000..06caf0b96 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 42); + +/* SNIPPET START */ +void main() { + test('Some description', () { + // 이 테스트에 대한 ProviderContainer를 생성합니다. + // DO NOT 테스트 간에 ProviderContainer를 공유하지 마세요. + final container = createContainer(); + + // TODO: use the container to test your application. + expect( + container.read(provider), + equals('some value'), + ); + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart new file mode 100644 index 000000000..61b2ca36b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart @@ -0,0 +1,15 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +import 'widget_test.dart'; + +void main() { + testWidgets('Some description', (tester) async { + /* SNIPPET START */ + final element = tester.element(find.byType(YourWidgetYouWantToTest)); + final container = ProviderScope.containerOf(element); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart new file mode 100644 index 000000000..b4afc835c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +class YourWidgetYouWantToTest extends StatelessWidget { + const YourWidgetYouWantToTest({super.key}); + + @override + Widget build(BuildContext context) => const Placeholder(); +} + +/* SNIPPET START */ +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + }); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx new file mode 100644 index 000000000..39db8dcfe --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx @@ -0,0 +1,100 @@ +--- +title: 웹소켓 및 동기 실행 +--- + +import { + trimSnippet, + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; +import syncDefinition from "./websockets_sync/sync_definition"; +import streamProvider from "./websockets_sync/stream_provider"; +import syncConsumer from "!!raw-loader!./websockets_sync/sync_consumer.dart"; +import rawUsage from "!!raw-loader!./websockets_sync/raw_usage.dart"; +import pipeChangeNotifier from "!!raw-loader!./websockets_sync/pipe_change_notifier.dart"; +import sharedPipeChangeNotifier from "!!raw-loader!./websockets_sync/shared_pipe_change_notifier.dart"; +import changeNotifierProvider from "!!raw-loader!./websockets_sync/change_notifier_provider.dart"; + +지금까지는 `Future`를 생성하는 방법만 다루었습니다. +이는 의도적으로 `Future`가 Riverpod 애플리케이션을 빌드하는 방법의 핵심이기 때문입니다. +_하지만_ Riverpod는 필요한 경우 다른 형식도 지원합니다. + +특히 providers는 `Future` 대신 자유롭게 객체를 반환할 수 있습니다: + +- 'Repository' 생성 등 객체를 동기적으로 반환할 수 있습니다. +- 웹소켓을 수신하기 위해 `Stream`을 반환합니다. + +`Future`를 반환하는 것과 `Stream` 또는 객체를 반환하는 것은 전반적으로 매우 유사합니다. +이 페이지는 이러한 사용 사례에 대한 미묘한 차이점과 다양한 팁을 설명하는 페이지라고 생각하시면 됩니다. + +## 동기적으로 객체 반환하기 + +객체를 동기적으로 생성하려면 provice가 Future를 반환하지 않는지 확인하세요: + + + +provider가 객체를 동기적으로 생성하면 객체가 소비되는 방식에 영향을 미칩니다. +특히 동기식 값은 "AsyncValue"로 래핑되지 않습니다: + + + +이 차이로 인해 provice가 에러를 발생시키면 값을 읽으려고(read) 하면 에러가 다시 발생(rethrow)합니다. +또는 `ref.listen`을 사용할 경우 "onError" 콜백이 호출됩니다. + +### 수신 가능(Listenable) 객체 고려 사항 + + + +`ChangeNotifier` 또는 `StateNotifier`과 같은 수신가능 객체는 지원되지 않습니다. +호환성상의 이유로 이러한 객체 중 하나와 상호 작용해야 하는 경우, 한 가지 우회 방법은 해당 알림 메커니즘(notification mechanism)을 Riverpod로 연결(pipe)하는 것입니다. + + + +:::info +이러한 로직이 여러 번 필요한 경우, 공유된 로직에 주목할 가치가 있습니다! "ref" 객체는 컴포저블(composable)하게 설계되었습니다. +이를 통해 공급자에서 dispose/listening 로직을 추출할 수 있습니다: + + +::: + + + + + +코드 생성(code-generation)을 사용하지 않을 경우, +Riverpod은 `ChangeNotifier`와 `StateNotifier`를 즉시 지원하는 "legacy" 프로바이더를 제공합니다: `ChangeNotifierProvider` and `StateNotifierProvider`. +이들을 사용하는 것은 다른 종류의 provider를 사용하는 것과 비슷합니다. 가장 큰 차이점은 둘 다 반환된 객체를 자동으로 수신(listen)하고 폐기(dispose)한다는 점입니다. + +이러한 providers는 새로운 비즈니스 로직에는 권장되지 않습니다. +그러나 `pkg:provider`에서 Riverpod로 마이그레이션할 때와 같이 레거시 코드와 상호 작용할 때는 유용할 수 있습니다. + + + + + +## 스트림 수신하기(Listening) + +최신 애플리케이션의 일반적인 사용 사례는 websocket과 상호 작용하는 것입니다(예: Firebase 또는 GraphQL 구독). +이러한 API와의 상호 작용은 종종 `Stream`을 수신하여 수행됩니다. + +이를 돕기 위해 Riverpod은 `Stream` 객체를 자연스럽게 지원합니다. +`Future` 객체와 마찬가지로 이 객체는 `AsyncValue`로 변환됩니다: + + + +:::info +Riverpod은 RX의 `BehaviorSubject`와 같은 같은 커스텀 `Stream` 구현을 인식하지 못합니다. +따라서 생성시 이미 사용 가능하더라도 `BehaviorSubject`를 반환하면 `value`가 위젯에 동기적으로 노출되지 않습니다. +::: + +## `Stream`/`Future`를 `AsyncValue`로 변환하지 않기 + +기본적으로 Riverpod는 `Stream`과 `Future`를 `AsyncValue`로 변환합니다. +거의 필요하지 않지만, 반환 유형을 `Raw` typedef로 감싸서 이 동작을 비활성화할 수 있습니다. + +:::caution +일반적으로 `AsyncValue` 변환을 비활성화하는 것은 권장하지 않습니다. +자신이 무엇을 하고 있는지 알고 있는 경우에만 그렇게 하세요. +::: + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart new file mode 100644 index 000000000..b285c78d0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart @@ -0,0 +1,11 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final myProvider = ChangeNotifierProvider>((ref) { + // ValueNotifier를 수신하고 처리합니다. + // 그러면 위젯은 이 provider를 "ref.watch"하여 업데이트를 수신할 수 있습니다. + return ValueNotifier(0); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart new file mode 100644 index 000000000..63c17b4f7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart @@ -0,0 +1,21 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'pipe_change_notifier.g.dart'; + +/* SNIPPET START */ +/// 값이 변경될 때마다 ValueNotifier를 생성하고 리스너를 업데이트하는 provider입니다. +@riverpod +ValueNotifier myListenable(MyListenableRef ref) { + final notifier = ValueNotifier(0); + + // provider가 dispose되면 notifier를 dispose합니다. + ref.onDispose(notifier.dispose); + + // ValueNotifier가 업데이트될 때마다 이 provider의 리스너에게 알립니다. + notifier.addListener(ref.notifyListeners); + + return notifier; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart new file mode 100644 index 000000000..f003822e9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -0,0 +1,28 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'pipe_change_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myListenableHash() => r'4cc07df2f47050c4aa761e5467f341ab6c312d09'; + +/// 값이 변경될 때마다 ValueNotifier를 생성하고 리스너를 업데이트하는 provider입니다. +/// +/// Copied from [myListenable]. +@ProviderFor(myListenable) +final myListenableProvider = AutoDisposeProvider>.internal( + myListenable, + name: r'myListenableProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myListenableHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef MyListenableRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart new file mode 100644 index 000000000..f5b829c33 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart @@ -0,0 +1,28 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'raw_usage.g.dart'; + +/* SNIPPET START */ +@riverpod +Raw> rawStream(RawStreamRef ref) { + // "Raw"는 typedef입니다. "Raw" 생성자로 반환값을 Wrap할 필요가 없습니다. + return const Stream.empty(); +} + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 값이 더 이상 AsyncValue로 변환되지 않고, 생성된 스트림이 그대로 반환됩니다. + Stream stream = ref.watch(rawStreamProvider); + return StreamBuilder( + stream: stream, + builder: (context, snapshot) { + return Text('${snapshot.data}'); + }, + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart new file mode 100644 index 000000000..bd06ba4bc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'raw_usage.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$rawStreamHash() => r'7e7c2e8f4f08d33a4d86d60449e143c419ca4822'; + +/// See also [rawStream]. +@ProviderFor(rawStream) +final rawStreamProvider = AutoDisposeProvider>>.internal( + rawStream, + name: r'rawStreamProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$rawStreamHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef RawStreamRef = AutoDisposeProviderRef>>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart new file mode 100644 index 000000000..f22edc35e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart @@ -0,0 +1,29 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'shared_pipe_change_notifier.g.dart'; + +/* SNIPPET START */ +extension on Ref { + // 이전 로직을 Ref 확장(extension)으로 옮길 수 있습니다. + // 이렇게 하면 provider 간에 로직을 재사용할 수 있습니다. + T disposeAndListenChangeNotifier(T notifier) { + onDispose(notifier.dispose); + notifier.addListener(notifyListeners); + // 사용 편의성을 높이기 위해 Notifier을 반환합니다. + return notifier; + } +} + +@riverpod +ValueNotifier myListenable(MyListenableRef ref) { + return ref.disposeAndListenChangeNotifier(ValueNotifier(0)); +} + +@riverpod +ValueNotifier anotherListenable(AnotherListenableRef ref) { + return ref.disposeAndListenChangeNotifier(ValueNotifier(42)); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart new file mode 100644 index 000000000..fbc40c61b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -0,0 +1,42 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'shared_pipe_change_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myListenableHash() => r'7096094cd24ed50dbabb9fb9ab64b340176c04bf'; + +/// See also [myListenable]. +@ProviderFor(myListenable) +final myListenableProvider = AutoDisposeProvider>.internal( + myListenable, + name: r'myListenableProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myListenableHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef MyListenableRef = AutoDisposeProviderRef>; +String _$anotherListenableHash() => r'38bfe5dbf5f148819b3671ad69d15c8e05264c23'; + +/// See also [anotherListenable]. +@ProviderFor(anotherListenable) +final anotherListenableProvider = + AutoDisposeProvider>.internal( + anotherListenable, + name: r'anotherListenableProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$anotherListenableHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef AnotherListenableRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart new file mode 100644 index 000000000..ca81a540e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart @@ -0,0 +1,34 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Stream streamExample(StreamExampleRef ref) async* { + // 1초마다 0에서 41 사이의 숫자를 yield합니다. + // 이 값은 Firestore나 GraphQL 등의 스트림으로 대체할 수 있습니다. + for (var i = 0; i < 42; i++) { + yield i; + await Future.delayed(const Duration(seconds: 1)); + } +} + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 스트림을 수신하고 AsyncValue로 변환합니다. + AsyncValue value = ref.watch(streamExampleProvider); + + // 로딩/오류 상태를 처리하고 데이터를 표시하는 데 AsyncValue를 사용할 수 있습니다. + return switch (value) { + AsyncValue(:final error?) => Text('Error: $error'), + AsyncValue(:final valueOrNull?) => Text('$valueOrNull'), + _ => const CircularProgressIndicator(), + }; + } +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart new file mode 100644 index 000000000..b8ef976c4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$streamExampleHash() => r'ca9993b22f6d587b20c041133cacd28d01933074'; + +/// See also [streamExample]. +@ProviderFor(streamExample) +final streamExampleProvider = AutoDisposeStreamProvider.internal( + streamExample, + name: r'streamExampleProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$streamExampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef StreamExampleRef = AutoDisposeStreamProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts new file mode 100644 index 000000000..4ee159de8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts @@ -0,0 +1,4 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart new file mode 100644 index 000000000..c4beebb71 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart @@ -0,0 +1,30 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final streamExampleProvider = StreamProvider.autoDispose((ref) async* { + // Every 1 second, yield a number from 0 to 41. + // This could be replaced with a Stream from Firestore or GraphQL or anything else. + for (var i = 0; i < 42; i++) { + yield i; + await Future.delayed(const Duration(seconds: 1)); + } +}); + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // The stream is listened to and converted to an AsyncValue. + AsyncValue value = ref.watch(streamExampleProvider); + + // We can use the AsyncValue to handle loading/error states and show the data. + return switch (value) { + AsyncValue(:final error?) => Text('Error: $error'), + AsyncValue(:final valueOrNull?) => Text('$valueOrNull'), + _ => const CircularProgressIndicator(), + }; + } +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart new file mode 100644 index 000000000..4864c30da --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart @@ -0,0 +1,19 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'sync_definition/raw.dart'; + +void main() { +/* SNIPPET START */ + Consumer( + builder: (context, ref, child) { + // 값은 "AsyncValue"로 래핑되지 않습니다. + int value = ref.watch(synchronousExampleProvider); + + return Text('$value'); + }, + ); +/* SNIPPET END */ +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart new file mode 100644 index 000000000..b18b8f76e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart @@ -0,0 +1,10 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +int synchronousExample(SynchronousExampleRef ref) { + return 0; +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart new file mode 100644 index 000000000..ef1015d6e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -0,0 +1,28 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$synchronousExampleHash() => + r'98df96e07d554683041f668c06b36f183ff534c1'; + +/// See also [synchronousExample]. +@ProviderFor(synchronousExample) +final synchronousExampleProvider = AutoDisposeProvider.internal( + synchronousExample, + name: r'synchronousExampleProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$synchronousExampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef SynchronousExampleRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts new file mode 100644 index 000000000..4ee159de8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts @@ -0,0 +1,4 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart new file mode 100644 index 000000000..9c64294a0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart @@ -0,0 +1,7 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +final synchronousExampleProvider = Provider.autoDispose((ref) { + return 0; +}); +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.dart new file mode 100644 index 000000000..4d49c552a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.dart @@ -0,0 +1,11 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family.g.dart'; +/* SNIPPET START */ + +@riverpod +int random(RandomRef ref, {required int seed, required int max}) { + return Random(seed).nextInt(max); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart new file mode 100644 index 000000000..3e39394a5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart @@ -0,0 +1,222 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$randomHash() => r'517b12aad4df7b31f8872b89af74e7880377b2ea'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [random]. +@ProviderFor(random) +const randomProvider = RandomFamily(); + +/// See also [random]. +class RandomFamily extends Family { + /// See also [random]. + const RandomFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'randomProvider'; + + /// See also [random]. + RandomProvider call({ + required int seed, + required int max, + }) { + return RandomProvider( + seed: seed, + max: max, + ); + } + + @visibleForOverriding + @override + RandomProvider getProviderOverride( + covariant RandomProvider provider, + ) { + return call( + seed: provider.seed, + max: provider.max, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(int Function(RandomRef ref) create) { + return _$RandomFamilyOverride(this, create); + } +} + +class _$RandomFamilyOverride implements FamilyOverride { + _$RandomFamilyOverride(this.overriddenFamily, this.create); + + final int Function(RandomRef ref) create; + + @override + final RandomFamily overriddenFamily; + + @override + RandomProvider getProviderOverride( + covariant RandomProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [random]. +class RandomProvider extends AutoDisposeProvider { + /// See also [random]. + RandomProvider({ + required int seed, + required int max, + }) : this._internal( + (ref) => random( + ref as RandomRef, + seed: seed, + max: max, + ), + from: randomProvider, + name: r'randomProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$randomHash, + dependencies: RandomFamily._dependencies, + allTransitiveDependencies: RandomFamily._allTransitiveDependencies, + seed: seed, + max: max, + ); + + RandomProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.seed, + required this.max, + }) : super.internal(); + + final int seed; + final int max; + + @override + Override overrideWith( + int Function(RandomRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: RandomProvider._internal( + (ref) => create(ref as RandomRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + seed: seed, + max: max, + ), + ); + } + + @override + ({ + int seed, + int max, + }) get argument { + return ( + seed: seed, + max: max, + ); + } + + @override + AutoDisposeProviderElement createElement() { + return _RandomProviderElement(this); + } + + RandomProvider _copyWith( + int Function(RandomRef ref) create, + ) { + return RandomProvider._internal( + (ref) => create(ref as RandomRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + seed: seed, + max: max, + ); + } + + @override + bool operator ==(Object other) { + return other is RandomProvider && other.seed == seed && other.max == max; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, seed.hashCode); + hash = _SystemHash.combine(hash, max.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin RandomRef on AutoDisposeProviderRef { + /// The parameter `seed` of this provider. + int get seed; + + /// The parameter `max` of this provider. + int get max; +} + +class _RandomProviderElement extends AutoDisposeProviderElement + with RandomRef { + _RandomProviderElement(super.provider); + + @override + int get seed => (origin as RandomProvider).seed; + @override + int get max => (origin as RandomProvider).max; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx new file mode 100644 index 000000000..fa391f61a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./family.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart new file mode 100644 index 000000000..68b84d40d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart @@ -0,0 +1,27 @@ +import 'dart:math'; + +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@immutable +abstract class Equatable { + const Equatable(); + + List get props; +} + +/* SNIPPET START */ +class ParamsType extends Equatable { + const ParamsType({required this.seed, required this.max}); + + final int seed; + final int max; + + @override + List get props => [seed, max]; +} + +final randomProvider = + Provider.family.autoDispose((ref, params) { + return Random(params.seed).nextInt(params.max); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart new file mode 100644 index 000000000..1082ef6f3 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart @@ -0,0 +1,12 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; + +import 'json.dart'; + +part 'item.freezed.dart'; +part 'item.g.dart'; + +@freezed +class Item with _$Item { + const factory Item({required int id}) = _Item; + factory Item.fromJson(Json json) => _$ItemFromJson(json); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart new file mode 100644 index 000000000..e578c8154 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart @@ -0,0 +1,146 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'item.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Item _$ItemFromJson(Map json) { + return _Item.fromJson(json); +} + +/// @nodoc +mixin _$Item { + int get id => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ItemCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ItemCopyWith<$Res> { + factory $ItemCopyWith(Item value, $Res Function(Item) then) = + _$ItemCopyWithImpl<$Res, Item>; + @useResult + $Res call({int id}); +} + +/// @nodoc +class _$ItemCopyWithImpl<$Res, $Val extends Item> + implements $ItemCopyWith<$Res> { + _$ItemCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as int, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ItemImplCopyWith<$Res> implements $ItemCopyWith<$Res> { + factory _$$ItemImplCopyWith( + _$ItemImpl value, $Res Function(_$ItemImpl) then) = + __$$ItemImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({int id}); +} + +/// @nodoc +class __$$ItemImplCopyWithImpl<$Res> + extends _$ItemCopyWithImpl<$Res, _$ItemImpl> + implements _$$ItemImplCopyWith<$Res> { + __$$ItemImplCopyWithImpl(_$ItemImpl _value, $Res Function(_$ItemImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + }) { + return _then(_$ItemImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as int, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ItemImpl implements _Item { + const _$ItemImpl({required this.id}); + + factory _$ItemImpl.fromJson(Map json) => + _$$ItemImplFromJson(json); + + @override + final int id; + + @override + String toString() { + return 'Item(id: $id)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ItemImpl && + (identical(other.id, id) || other.id == id)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, id); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ItemImplCopyWith<_$ItemImpl> get copyWith => + __$$ItemImplCopyWithImpl<_$ItemImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ItemImplToJson( + this, + ); + } +} + +abstract class _Item implements Item { + const factory _Item({required final int id}) = _$ItemImpl; + + factory _Item.fromJson(Map json) = _$ItemImpl.fromJson; + + @override + int get id; + @override + @JsonKey(ignore: true) + _$$ItemImplCopyWith<_$ItemImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart new file mode 100644 index 000000000..3c653e18c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart @@ -0,0 +1,18 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'item.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ItemImpl _$$ItemImplFromJson(Map json) => _$ItemImpl( + id: json['id'] as int, + ); + +Map _$$ItemImplToJson(_$ItemImpl instance) => + { + 'id': instance.id, + }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart new file mode 100644 index 000000000..17cfb1c01 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart @@ -0,0 +1 @@ +typedef Json = Map; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart new file mode 100644 index 000000000..802a23150 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart @@ -0,0 +1,29 @@ +import 'package:collection/collection.dart'; +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; +import '../../helpers/json.dart'; + +part 'async_values.g.dart'; + +/* SNIPPET START */ + +@riverpod +Future> itemsApi(ItemsApiRef ref) async { + final client = Dio(); + final result = await client.get>('your-favorite-api'); + final parsed = [...result.data!.map((e) => Item.fromJson(e as Json))]; + return parsed; +} + +@riverpod +List evenItems(EvenItemsRef ref) { + final asyncValue = ref.watch(itemsApiProvider); + if (asyncValue.isReloading) return []; + if (asyncValue.hasError) return const [Item(id: -1)]; + + final items = asyncValue.requireValue; + + return [...items.whereIndexed((index, element) => index.isEven)]; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart new file mode 100644 index 000000000..0765d3a65 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_values.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$itemsApiHash() => r'b32ccb7b85305e361d8ed752cbe11d9524c96190'; + +/// See also [itemsApi]. +@ProviderFor(itemsApi) +final itemsApiProvider = AutoDisposeFutureProvider>.internal( + itemsApi, + name: r'itemsApiProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$itemsApiHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ItemsApiRef = AutoDisposeFutureProviderRef>; +String _$evenItemsHash() => r'55ae98f9b6108203dfc4a139f1ade9fbd8ba8ddd'; + +/// See also [evenItems]. +@ProviderFor(evenItems) +final evenItemsProvider = AutoDisposeProvider>.internal( + evenItems, + name: r'evenItemsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$evenItemsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef EvenItemsRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx new file mode 100644 index 000000000..526f2dffe --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./async_values.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart new file mode 100644 index 000000000..1ca8987ef --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart @@ -0,0 +1,25 @@ +import 'package:collection/collection.dart'; +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; +import '../../helpers/json.dart'; + +/* SNIPPET START */ + +final itemsApiProvider = FutureProvider.autoDispose((ref) async { + final client = Dio(); + final result = await client.get>('your-favorite-api'); + final parsed = [...result.data!.map((e) => Item.fromJson(e as Json))]; + return parsed; +}); + +final evenItemsProvider = Provider.autoDispose((ref) { + final asyncValue = ref.watch(itemsApiProvider); + if (asyncValue.isLoading) return []; + if (asyncValue.hasError) return const [Item(id: -1)]; + + final items = asyncValue.requireValue; + + return [...items.whereIndexed((index, element) => index.isEven)]; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart new file mode 100644 index 000000000..9d739eb38 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart @@ -0,0 +1,29 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'auto_dispose.g.dart'; + +/* SNIPPET START */ + +// 코드 생성 시 .autoDispose가 기본값 +@riverpod +int diceRoll(DiceRollRef ref) { + // 이 provider는 .autoDispose이므로 + // 리스닝을 해제하면 현재 노출된 상태가 폐기됩니다. + // 그런 다음 이 provider를 다시 수신할 때마다 + // 새로운 주사위를 굴려서 다시 노출합니다. + final dice = Random().nextInt(10); + return dice; +} + +@riverpod +int cachedDiceRoll(CachedDiceRollRef ref) { + final coin = Random().nextInt(10); + if (coin > 5) throw Exception('Way too large.'); + // 위의 조건은 실패할 수 있습니다; + // 그렇지 않은 경우, 다음 명령어는 아무도 더 이상 수신하지 않더라도 + // 캐시된 상태를 유지하도록 provider에게 지시합니다. + ref.keepAlive(); + return coin; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart new file mode 100644 index 000000000..9397a920f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -0,0 +1,41 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'auto_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$diceRollHash() => r'dfd5ac8b74351a0076da9d131c10277f53ff11b9'; + +/// See also [diceRoll]. +@ProviderFor(diceRoll) +final diceRollProvider = AutoDisposeProvider.internal( + diceRoll, + name: r'diceRollProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$diceRollHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef DiceRollRef = AutoDisposeProviderRef; +String _$cachedDiceRollHash() => r'fc31fcb804f10360d75362e56329976343ee7abb'; + +/// See also [cachedDiceRoll]. +@ProviderFor(cachedDiceRoll) +final cachedDiceRollProvider = AutoDisposeProvider.internal( + cachedDiceRoll, + name: r'cachedDiceRollProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$cachedDiceRollHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CachedDiceRollRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx new file mode 100644 index 000000000..6c57cfffd --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./auto_dispose.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart new file mode 100644 index 000000000..d5961ad90 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart @@ -0,0 +1,24 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ + +final diceRollProvider = Provider.autoDispose((ref) { + // Since this provider is .autoDispose, un-listening to it will dispose + // its current exposed state. + // Then, whenever this provider is listened to again, + // a new dice will be rolled and exposed again. + final dice = Random().nextInt(10); + return dice.isEven; +}); + +final cachedDiceRollProvider = Provider.autoDispose((ref) { + final coin = Random().nextInt(10); + if (coin > 5) throw Exception('Way too large.'); + // The above condition might fail; + // If it doesn't, the following instruction tells the Provider + // to keep its cached state, *even when no one listens to it anymore*. + ref.keepAlive(); + return coin.isEven; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart new file mode 100644 index 000000000..ecd1915da --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart @@ -0,0 +1,19 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'combine.g.dart'; + +/* SNIPPET START */ + +@riverpod +int number(NumberRef ref) { + return Random().nextInt(10); +} + +@riverpod +int doubled(DoubledRef ref) { + final number = ref.watch(numberProvider); + + return number * 2; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart new file mode 100644 index 000000000..501f580ef --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'combine.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$numberHash() => r'725e25be57b9cc2bd914752f156e26a214596b63'; + +/// See also [number]. +@ProviderFor(number) +final numberProvider = AutoDisposeProvider.internal( + number, + name: r'numberProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$numberHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef NumberRef = AutoDisposeProviderRef; +String _$doubledHash() => r'ddc640c876bdbe49fe72fe1632b5ff48687c9279'; + +/// See also [doubled]. +@ProviderFor(doubled) +final doubledProvider = AutoDisposeProvider.internal( + doubled, + name: r'doubledProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$doubledHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef DoubledRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx new file mode 100644 index 000000000..2ff7dfbaa --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./combine.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart new file mode 100644 index 000000000..ad33636e7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart @@ -0,0 +1,15 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ + +final numberProvider = Provider.autoDispose((ref) { + return Random().nextInt(10); +}); + +final doubledProvider = Provider.autoDispose((ref) { + final number = ref.watch(numberProvider); + + return number * 2; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx new file mode 100644 index 000000000..a8e75cd4f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx @@ -0,0 +1,192 @@ +--- +title: 동기부여(Motivation) +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import sameType from "./same_type"; +import combine from "./combine"; +import asyncValues from "./async_values"; +import autoDispose from "./auto_dispose"; +import override from "./override"; +import sideEffects from "./side_effects"; +import { + trimSnippet, + AutoSnippet, + When, +} from "../../../../../../src/components/CodeSnippet"; + +이 심층 글은 Riverpod의 존재 이유를 보여주기 위해 작성되었습니다. + +특히 이 섹션에서는 아래에 답해야 합니다: + - Provider가 널리 사용되는데 왜 Riverpod로 마이그레이션해야 하나요? + - 어떤 구체적인 이점을 얻을 수 있나요? + - 어떻게 Riverpod로 마이그레이션할 수 있나요? + - 점진적으로 마이그레이션할 수 있나요? + - 기타 등등 + +이 섹션이 끝날 때쯤이면 Provider보다 Riverpod을 선호해야 한다는 확신이 들 것입니다. + +**Riverpod은 실제로 Provider와 비교할 때 더 현대적이고 권장되며 신뢰할 수 있는 접근 방식입니다.** + +Riverpod은 더 나은 상태 관리 기능, 더 나은 캐싱 전략, 간소화된 리액티비티 모델을 제공합니다. +반면, Provider는 현재 많은 부분에서 부족하고 앞으로 나아갈 방법이 없습니다. + +## Provider의 제약사항 + +Provider는 InheritedWidget API의 제약을 받기 때문에 근본적인 문제가 있습니다. +본질적으로 Provider는 "더 단순한 `InheritedWidget`"입니다; +Provider는 단지 InheritedWidget 래퍼일 뿐이므로 이에 의해 제한을 받습니다. + +### Provider는 동일한 "타입"의 providers를 두 개(또는 그 이상) 보유할 수 었습니다. + +두 개의 `Provider`를 선언하면 불안정한 동작이 발생합니다.: +`InheritedWidget`API는 *둘 중 하나*만 가져옵니다: 가장 가까운 `Provider` 조상(ancestor) + +[해결방법]은 Provider의 문서에 설명되어 있지만, Riverpod은 이 문제가 없습니다. + +이 제약을 제거하면 다음과 같이 로직을 작은 조각으로 자유롭게 분할할 수 있습니다: + + + +### Providers는 한 번에 하나의 값만 합리적으로 반환합니다 + +외부 RESTful API를 읽을 때, 새 호출이 다음 값을 로드하는 동안 마지막으로 읽은 값을 표시하는 것은 매우 일반적입니다. +Riverpod은 `AsyncValue`의 API를 통해 한 번에 두 개의 값(즉, 이전 데이터 값과 새로 들어오는 새 로딩 값)을 전송함으로써 이러한 동작을 허용합니다: + + + +이전 코드 조각에서 `evenItemsProvider`를 보면 다음과 같은 효과가 나타납니다: +1. 처음에, 요청이 이루어지고 빈 목록을 얻습니다; +2. 그런 다음 오류가 발생한다고 가정합니다. `[Item(id: -1)]`을 얻습니다; +3. 그런 다음 pull-to-refresh 로직으로 요청을 다시 시도합니다(예: `ref.invalidate`를 통해); +4. 첫 번째 공급자를 다시 로드하는 동안 두 번째 공급자는 여전히 `[Item(id: -1)]`을 노출합니다; +5. 이번에는 일부 파싱된 데이터가 올바르게 수신됩니다: 짝수 항목이 올바르게 반환됩니다. + +프로바이더를 사용하면 위의 기능을 원격으로 구현할 수 없으며 해결 방법도 쉽지 않습니다. + +### providers를 결합하는 것은 어렵고 에러가 발생하기 쉽습니다 + +Provider를 사용하면 provider의 `create`안에서 `context.watch`를 사용하고 싶을 수 있습니다. +이는 종속성이 변경되지 않은 경우(예: 위젯 트리에 GlobalKey가 포함되어 있는 경우)에도 `didChangeDependencies`가 트리거될 수 있기 때문에 신뢰할 수 없습니다. + +그럼에도 불구하고, Provider는 `ProxyProvider`라는 Ad-hoc 솔루션을 가지고 있지만, 이는 지루하고 오류가 발생하기 쉽다고 여겨집니다. + +상태 결합은 [ref.watch] 및 [ref.listen]와 같은 간단하지만 강력한 유틸리티를 사용하여 오버헤드 없이 반응형으로 값을 결합하고 캐시할 수 있기 때문에 Riverpod의 핵심 메커니즘입니다. + + + +Riverpod에서는 종속성을 읽을 수 있고 API가 동일하게 유지되므로 값을 결합하는 것이 자연스럽게 느껴집니다. + +### 안정성 부족 +Provider를 상요하면, 리팩토링 또는 대규모 변경 중에 `ProviderNotFoundException`을 종종 마주치게 됩니다. +사실, 이 런타임 예외는 Riverpod이 처음 만들어진 주요 이유 중 하나였습니다. + +이보다 훨씬 더 많은 유틸리티를 제공하지만, Riverpod은 이 예외를 던질 수 없습니다. + +### 상태를 폐기(Disposing)하는 것은 어렵습니다 + +`InheritedWidget`은 [Comsumer가 더이상 Listen하지 않을때 반응(React)할 수 없습니다]. +이로 인해 더 이상 사용되지 않을때 Provider의 상태를 자동으로 파기(Dispose)할 수 없습니다. +프로파이더를 사용하면 우리는 범위 제한(Scoping) provider에 의존하여 상태가 더 이상 사용되지 않을 때 상태를 파기(Dispose)해야 합니다. +하지만 페이지 간에 상태가 공유되는 경우 까다로워지기 때문에 이것이 쉽지 않습니다. + +Riverpod은 [autodispose]와 [keepAlive]와 같은 쉽게 이해할 수 있는 API로 이 문제를 해결합니다. +이 두 API는 유연하고 창의적인 캐싱 전략(예: 시간 기반 캐싱)을 가능하게 합니다: + + + +안타깝께도 원시 `InheritedWidget`으로는 이를 구현할 방법이 없으므로 Provider로 구현할 수 없습니다. + +### 신뢰할 수 있는 매개변수화 매커니즘 부족 +Riverpod은 사용자가 [.family 수정자(modifier)]를 사용하여 "매개변수화된(parameterized)" 공급자를 선언할 수 있습니다. +실제로 `.family`는 Riverpod의 가장 강력한 기능 중 하나이며, Riverpod의 혁신의 핵심입니다. +예를 들어, 엄청한 [로직의 단순화]을 가능하게 합니다. + +Provider를 사용해 비슷한 기능을 구현하려면, 이러한 매개변수에 대한 사용 편의성*과* 유형 안전성을 포기해야 합니다. + +또한, [이 두 기능은 서로 밀접하게 연관되어 있기 때문]에 Provider로 유사한 '.autoDispose' 메커니즘을 구현할 수 없다는 것은 본질적으로 '.family'의 동등한 구현을 막는 것입니다. + +마지막으로, 앞에서 살펴본 것처럼 위젯이 `InheritedWidget`을 수신(listen)하기 위해 *절대로* 멈추지 않는다는 것을 알 수 있습니다. +이는 일부 provider 상태가 "동적으로 마운트(dynamically mounted)"된 경우, 예를 들어 빌드에 매개변수를 사용하여 provider를 빌드할 때 심각한 메모리 누수가 발생한다는 것을 의미합니다, 이것이 바로 '.family'가 하는 일입니다. +따라서 현재로서는 Provider에 해당하는 `.family`를 얻는 것은 근본적으로 불가능합니다. + +### 지루한 테스트 +테스트를 작성하려면 각 테스트 내에서 providers를 *다시 정의해야만* 합니다. + +Riverpod을 사용하면 기본적으로 테스트 내부에서 providers를 사용할 수 있습니다. +또한, Riverpod은 providers를 모킹(mocking)할 때 중요한 "재정의(overriding)" 유틸리티 모음을 편리하게 제공합니다. + +위의 결합된 상태 스니펫을 테스트하는 것은 다음과 같이 간단합니다: + + + +테스트에 대한 자세한 내용은 [테스팅]을 참조하세요. + + +### 부수 기능 트리거(Triggering side effects)는 간단하지 않습니다. + +`InheritedWidget`에는 `onChange`콜백이 없으므로, provider는 콜백을 가질 수 없습니다. +리는 snackbars, modals 등과 같은 네비게이션에 문제가 있습니다. + +대신 Riverpod은 간단한 `ref.listen`을 제공합니다. 이는 [Flutter와 잘 통합]됩니다. + + + +## Riverpod을 향해 + +개념적으로 Riverpod과 Provider는 상당히 유사합니다. +두 패키지 모두 비슷한 역할을 수행합니다. 둘 다 시도합니다: + +- 일부 상태 저장 객체를 캐시하고 폐기합니다; +- 테스트 중에 해당 객체를 모킹하는 방법을 제공합니다; +- 위젯이 이러한 객체를 간단한 방법으로 수신할 수 있는 방법을 제공합니다. + +Riverpod을 Provider가 몇 년 동안 계속 발전했다면 어땠을지로 생각해 볼 수 있습니다. + +### 왜 별도의 패키지인가요? + +원래는 앞서 언급한 문제를 해결하기 위한 방법으로 'Provider'의 주요 버전이 출시될 예정이었습니다. +그러나 새로운 `ConsumerWidget` API로 인해 "너무 많은 것을 깨뜨리고" 심지어 논란의 여지가 있었기 때문에 이를 포기하기로 결정했습니다. +Provider는 여전히 가장 많이 사용되는 Flutter 패키지 중 하나이기 때문에 별도의 패키지를 만들기로 결정했고, 그렇게 해서 Riverpod이 탄생했습니다. + +별도의 패키지 생성 활성화: + - 두 가지 접근 방식을 *동시에* 임시로 사용할 수 있도록 하여 원하는 사람은 누구나 쉽게 마이그레이션할 수 있습니다; + - 원칙적으로 Riverpod이 마음에 들지 않거나 아직 신뢰할 수 없다고 판단되는 경우 Provider를 계속 사용할 수 있도록 허용; + - Provider의 다양한 기술적 한계에 대한 생산적인 솔루션을 찾기 위해 Riverpod이 실험할 수 있도록 합니다. + +실제로 Riverpod은 Provider의 정신적 후계자 역할을 하도록 설계되었습니다. 따라서 'Riverpod'라는 이름은 'Riverpod'의 아나그램입니다. + +### 획기적인 변화 +Riverpod의 유일한 단점은 작동하려면 위젯 유형을 변경해야 한다는 것입니다: + +- Riverpod을 사용하면 `StatelessWidget` 대신 `ConsumerWidget`을 확장(extend)해야 합니다. +- Riverpod을 사용하면 `StatefulWidget` 대신 `ConsumerStatefulWidget`을 확장(extend)해야 합니다. + +그러나 이러한 불편함은 큰 틀에서 보면 상당히 사소한 것입니다. 그리고 언젠가는 이 요구 사항이 사라질 수도 있습니다. + +### 적합한 라이브러리 선택 +아마 스스로에게 물어보셨을 것입니다: +*"그렇다면 Provider 사용자로서 Provider를 사용해야 하나요, 아니면 Riverpod을 사용해야 하나요?"*. + +저희는 이 질문에 명확하게 답해드리고자 합니다: + + 아마도 Riverpod을 사용해야 할 것입니다. + +Riverpod이 전반적으로 더 잘 설계되어 있으며 로직을 대폭 간소화할 수 있습니다. + + +[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider +[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[autodispose]: /docs/concepts/modifiers/auto_dispose +[해결방법]: https://pub.dev/packages/provider#can-i-obtain-two-different-providers-using-the-same-type +[.family 수정자(modifier)]: /docs/concepts/modifiers/family +[keepAlive]: /docs/concepts/modifiers/auto_dispose#refkeepalive +[이 두 기능은 서로 밀접하게 연관되어 있기 때문]: /docs/concepts/modifiers/family#prefer-using-autodispose-when-the-parameter-is-not-constant +[로직의 단순화]: /docs/concepts/modifiers/family#usage +[we have to]: https://github.com/flutter/flutter/issues/128432 +[it turns out]: https://github.com/flutter/flutter/issues/106549 +[Comsumer가 더이상 Listen하지 않을때 반응(React)할 수 없습니다]: https://github.com/flutter/flutter/issues/106546 +[테스팅]: /docs/cookbooks/testing +[Flutter와 잘 통합]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx new file mode 100644 index 000000000..43ec56b51 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./override.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart new file mode 100644 index 000000000..860020903 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart @@ -0,0 +1,16 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../combine/combine.dart'; + +/* SNIPPET START */ + +void main() { + test('it doubles the value correctly', () async { + final container = ProviderContainer( + overrides: [numberProvider.overrideWith((ref) => 9)], + ); + final doubled = container.read(doubledProvider); + expect(doubled, 9 * 2); + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart new file mode 100644 index 000000000..860020903 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart @@ -0,0 +1,16 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../combine/combine.dart'; + +/* SNIPPET START */ + +void main() { + test('it doubles the value correctly', () async { + final container = ProviderContainer( + overrides: [numberProvider.overrideWith((ref) => 9)], + ); + final doubled = container.read(doubledProvider); + expect(doubled, 9 * 2); + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx new file mode 100644 index 000000000..8569e8316 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./same_type.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart new file mode 100644 index 000000000..dacfe9b9d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart @@ -0,0 +1,15 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; + +/* SNIPPET START */ + +final itemsProvider = Provider.autoDispose( + (ref) => [], // ... +); + +final evenItemsProvider = Provider.autoDispose((ref) { + final items = ref.watch(itemsProvider); + return [...items.whereIndexed((index, element) => index.isEven)]; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart new file mode 100644 index 000000000..94a4ab086 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart @@ -0,0 +1,19 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; + +part 'same_type.g.dart'; + +/* SNIPPET START */ + +@riverpod +List items(ItemsRef ref) { + return []; // ... +} + +@riverpod +List evenItems(EvenItemsRef ref) { + final items = ref.watch(itemsProvider); + return [...items.whereIndexed((index, element) => index.isEven)]; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart new file mode 100644 index 000000000..e421d5b6d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'same_type.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$itemsHash() => r'f0a8fa6874f4868db9ead31e82c75d976f9d2033'; + +/// See also [items]. +@ProviderFor(items) +final itemsProvider = AutoDisposeProvider>.internal( + items, + name: r'itemsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$itemsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ItemsRef = AutoDisposeProviderRef>; +String _$evenItemsHash() => r'82b4525e91604745f2b4664531b32d4aff5717d4'; + +/// See also [evenItems]. +@ProviderFor(evenItems) +final evenItemsProvider = AutoDisposeProvider>.internal( + evenItems, + name: r'evenItemsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$evenItemsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef EvenItemsRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx new file mode 100644 index 000000000..f4797a94f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./side_effects.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart new file mode 100644 index 000000000..61f016870 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart @@ -0,0 +1,24 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../auto_dispose/auto_dispose.dart'; + +/* SNIPPET START */ + +class DiceRollWidget extends ConsumerWidget { + const DiceRollWidget({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(diceRollProvider, (previous, next) { + ScaffoldMessenger.of(context).showSnackBar( + SnackBar(content: Text('Dice roll! We got: $next')), + ); + }); + return TextButton.icon( + onPressed: () => ref.invalidate(diceRollProvider), + icon: const Icon(Icons.casino), + label: const Text('Roll a dice'), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart new file mode 100644 index 000000000..61f016870 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart @@ -0,0 +1,24 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../auto_dispose/auto_dispose.dart'; + +/* SNIPPET START */ + +class DiceRollWidget extends ConsumerWidget { + const DiceRollWidget({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(diceRollProvider, (previous, next) { + ScaffoldMessenger.of(context).showSnackBar( + SnackBar(content: Text('Dice roll! We got: $next')), + ); + }); + return TextButton.icon( + onPressed: () => ref.invalidate(diceRollProvider), + icon: const Icon(Icons.casino), + label: const Text('Roll a dice'), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx new file mode 100644 index 000000000..16380ac37 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx @@ -0,0 +1,419 @@ +--- +title: Provider vs Riverpod +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import family from "./family"; +import { + trimSnippet, + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; + + +이 문서에서는 Provider와 Riverpod의 차이점과 유사점을 요약하여 설명합니다. + +:::info +한글에는 영어 대/소문자가 없어서 "Provider"와 "provider"를 "프로바이더", "공급자"등으로 번역시 구분할 수 없습니다. +이 문서에서는 pkg:Provider를 "Provider"로 표기하고, +pkg:Provider나 pkg:Riverpod에서 제공되는 provider들을 "provider"로 표기합니다. +::: + +## 공급자(Provider) 정의하기 + +두 패키지의 가장 큰 차이점은 "providers"를 정의하는 방식입니다. + +[Provider]를 사용하면 providers는 위젯이므로 위젯 트리 안에 배치됩니다, +일반적으로 `MultiProvider` 안에 배치됩니다: + +```dart +class Counter extends ChangeNotifier { + ... +} + +void main() { + runApp( + MultiProvider( + providers: [ + ChangeNotifierProvider(create: (context) => Counter()), + ], + child: MyApp(), + ) + ); +} +``` + +Riverpod에서 providers는 위젯이 **아닙니다**. 대신 일반 Dart 객체입니다. +마찬가지로 providers는 위젯 트리 외부에서 정의되며, 대신 전역 최종(global final) 변수로 선언됩니다. + +또한 Riverpod이 작동하려면 전체 애플리케이션 위에 `ProviderScope` 위젯을 추가해야 합니다. +따라서 Riverpod을 사용하는 것은 Provider 예시와 동일합니다: + +```dart +// Provider는 이제 최상위 변수 +final counterProvider = ChangeNotifierProvider((ref) => Counter()); + +void main() { + runApp( + // 이 위젯은 전체 프로젝트에서 Riverpod을 사용할 수 있게 합니다 + ProviderScope( + child: MyApp(), + ), + ); +} +``` + +provider 정의가 단순히 몇 줄 위로 올라간 것을 주목하세요. + +:::info +Riverpod providers는 일반 다트 객체이므로 Flutter 없이 Riverpod을 사용할 수 있습니다. +예를 들어, 명령줄 애플리케이션을 작성하는 데 Riverpod을 사용할 수 있습니다. +::: + +## providers 읽기: BuildContext + +Provider에서 providers를 읽는 한 가지 방법은 위젯의 'BuildContext'를 사용하는 것입니다. + +예를 들어, provider가 다음과 같이 정의된 경우: + +```dart +Provider(...); +``` + +그런 다음 Provider를 사용하여 읽는 것은 다음과 같습니다: + +```dart +class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + Model model = context.watch(); + + } +} +``` + +이것은 Riverpod에서 동일합니다. Riverpod의 스니펫은 다음과 같습니다: + +```dart +final modelProvider = Provider(...); + +class Example extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + Model model = ref.watch(modelProvider); + + } +} +``` + +방법을 확인하세요: + +- Riverpod의 스니펫은 `StatelessWidget` 대신 `ConsumerWidget`을 확장(extend)합니다. + 이 다른 위젯 유형은 `build` 함수에 하나의 추가 매개변수인 `WidgetRef`를 추가합니다. + +- Riverpod에서는 `BuildContext.watch` 대신 `ConsumerWidget`에서 가져온 `WidgetRef`를 사용하여 `WidgetRef.watch`를 수행합니다. + +- Riverpod은 제네릭 타입에 의존하지 않습니다. 대신 공급자 정의(provider definition)를 통해 생성된 변수(variable)에 의존합니다. + +문구가 얼마나 유사한지도 주목하세요. Provider와 Riverpod은 모두 "watch" 키워드를 사용하여 "이 위젯은 값이 변경되면 다시 빌드되어야 합니다"라고 설명합니다. + +:::info +Riverpod은 provider 읽기에 대해 Provider와 동일한 용어를 사용합니다. + +- `BuildContext.watch` -> `WidgetRef.watch` +- `BuildContext.read` -> `WidgetRef.read` +- `BuildContext.select` -> `WidgetRef.watch(myProvider.select)` + +`context.watch`와 `context.read`에 대한 규칙은 Riverpod에도 적용됩니다: +`build` 메서드 내부에서는 "watch"를 사용합니다. +클릭 핸들러 및 기타 이벤트 내부에서는 "read"를 사용합니다. +값을 필터링하고 다시 빌드해야 하는 경우 "select"를 사용합니다. +::: + +## providers 읽기: Consumer + +Provider는 선택적으로 `Consumer`라는 위젯(및 `Consumer2`와 같은 변형)을 제공합니다. + +`Consumer`는 위젯 트리 보다 세분화하여 재빌드할 수 있으므로, 성능최적화에 도음이 됩니다. - 상태가 변경될 때 관련 위젯만 업데이트합니다: + +따라서 provider가 다음과 같이 정의된 경우: + +```dart +Provider(...); +``` + +Provider는 `Consumer`를 사용하여 provider를 읽을 수 있게합니다: + +```dart + +Provider allows reading that provider using `Consumer` with: + +```dart +Consumer( + builder: (BuildContext context, Model model, Widget? child) { + + } +) +``` + +Riverpod도 같은 원리를 가지고 있습니다. Riverpod에도 똑같은 용도의 'Consumer'라는 위젯이 있습니다. + +provider를 다음과 같이 정의했다면: + +```dart +final modelProvider = Provider(...); +``` + +`Consumer`를 사용하여 provider를 읽을 수 있습니다: + +```dart +Consumer( + builder: (BuildContext context, WidgetRef ref, Widget? child) { + Model model = ref.watch(modelProvider); + + } +) +``` + +`Consumer`가 어떻게 `WidgetRef` 객체를 제공하는지 주목해주세요. 이것은 이전 파트에서 `ConsumerWidget`과 관련된 것과 동일한 객체입니다. + +### Riverpod에는 `ConsumerN`에 해당하는 객체가 없음 + +Riverpod에서는 pkg:Provider의 `Consumer2`, `Consumer3` 등이 필요하지 않고, 누락된 것을 확인할 수 있습니다. (not needed nor missed) + +Riverpod을 사용하면, 여러 provider로 부터 값을 읽으려면 다음과 같이 여러 개의 `ref.watch` 문을 작성하면 됩니다.: + +```dart +Consumer( + builder: (context, ref, child) { + Model1 model = ref.watch(model1Provider); + Model2 model = ref.watch(model2Provider); + Model3 model = ref.watch(model3Provider); + // ... + } +) +``` + +위의 솔루션은 pkg:Provider의 `ConsumerN` API와 비교할 때 훨씬 덜 무겁게 느껴지고 이해하기 쉬울 것입니다. + +## providers 결합하기: ProxyProvider 와 stateless objects + +Provider를 사용할 때, providers를 결합하는 공식적인 방법은 `ProxyProvider` 위젯(또는 `ProxyProvider2`와 같은 변형)을 사용하는 것입니다. + +예를 들어 다음과 같이 정의할 수 있습니다: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +ChangeNotifierProvider(create: (context) => UserIdNotifier()), +``` + +이제 두가지 옵션이 있습니다. +`UserIdNotifier`를 결합하여 새로운 "stateless" provider(일반적으로 ==를 재정의할 수 있는 불변값)를 만들 수 있습니다. +다음과 같은: + +```dart +ProxyProvider( + update: (context, userIdNotifier, _) { + return 'The user ID of the the user is ${userIdNotifier.userId}'; + } +) +``` + +이 프로바이더는 `UserIdNotifier.userId`가 변경될 때마다 자동으로 새 `String`을 반환합니다. + +Riverpod에서도 비슷한 작업을 수행할 수 있지만 구문이 다릅니다. +먼저, Riverpod에서 `UserIdNotifier`의 정의는 다음과 같습니다: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +final userIdNotifierProvider = ChangeNotifierProvider( + (ref) => UserIdNotifier(), +); +``` + +거기에서, 'userId'를 기반으로 'String'을 생성하면 됩니다: + +```dart +final labelProvider = Provider((ref) { + UserIdNotifier userIdNotifier = ref.watch(userIdNotifierProvider); + return 'The user ID of the the user is ${userIdNotifier.userId}'; +}); +``` + +`ref.watch(userIdNotifierProvider)`를 수행하는 줄을 주목하세요. + +이 코드 줄은 Riverpod에게 `userIdNotifierProvider`의 내용을 가져오고, 그 값이 변경될 때마다 `labelProvider`도 다시 계산하도록 지시합니다. +따라서 `labelProvider`가 내보내는 `String`은 `userId`가 변경될 때마다 자동으로 업데이트됩니다. + +이 `ref.watch` 줄도 비슷하게 느껴질 것입니다. 이 패턴은 이전에 [위젯 내부에서 provider를 읽는 방법](#reading-providers-buildcontext)을 설명할 때 다뤘던 내용입니다. +실제로 providers는 이제 위젯과 같은 방식으로 다른 providers를 수신할 수 있습니다. + +## providers 결합하기: ProxyProvider 와 stateful objects + +providers를 결합할 때 또 다른 대안적인 사용 사례는 `ChangeNotifier` 인스턴스와 같은 상태 저장 객체를 노출하는 것입니다. + +이를 위해 `ChangeNotifierProxyProvider`(또는 `ChangeNotifierProxyProvider2`와 같은 변형)를 사용할 수 있습니다. +예를 들어 다음과 같이 정의할 수 있습니다: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +ChangeNotifierProvider(create: (context) => UserIdNotifier()), +``` + +그런 다음 `UserIdNotifier.userId`를 기반으로 하는 새로운 `ChangeNotifier`를 정의할 수 있습니다. +예를 들어 다음과 같이 할 수 있습니다: + +```dart +class UserNotifier extends ChangeNotifier { + String? _userId; + + void setUserId(String? userId) { + if (userId != _userId) { + print('The user ID changed from $_userId to $userId'); + _userId = userId; + } + } +} + +// ... + +ChangeNotifierProxyProvider( + create: (context) => UserNotifier(), + update: (context, userIdNotifier, userNotifier) { + return userNotifier! + ..setUserId(userIdNotifier.userId); + }, +); +``` + +이 새 provider는 (재구성되지 않는) `UserNotifier`의 단일 인스턴스를 생성하고 사용자 ID가 변경될 때마다 문자열을 인쇄합니다. + +provider에서 동일한 작업을 수행하는 방식은 다릅니다. +먼저, Riverpod에서는 `UserIdNotifier`의 정의가 다음과 같습니다: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +final userIdNotifierProvider = ChangeNotifierProvider( + (ref) => UserIdNotifier(), +), +``` + +이전의 `ChangeNotifierProxyProvider`에 해당하는 코드는 다음과 같습니다: + +```dart +class UserNotifier extends ChangeNotifier { + String? _userId; + + void setUserId(String? userId) { + if (userId != _userId) { + print('The user ID changed from $_userId to $userId'); + _userId = userId; + } + } +} + +// ... + +final userNotifierProvider = ChangeNotifierProvider((ref) { + final userNotifier = UserNotifier(); + ref.listen( + userIdNotifierProvider, + (previous, next) { + if (previous?.userId != next.userId) { + userNotifier.setUserId(next.userId); + } + }, + ); + + return userNotifier; +}); +``` + +이 스니펫의 핵심은 `ref.listen` 줄입니다. +이 `ref.listen` 함수는 provider를 수신 대기하고, provider가 변경될 때마다 함수를 실행하는 유틸리티입니다. + +해당 함수의 `previous` 및 `next` 매개 변수는 공급자가 변경되기 전의 마지막 값과 변경된 후의 새 값에 해당합니다. + +## 범위 지정 공급자(Scoping Providers) vs `.family` + `.autoDispose` +pkg:Provider에서 범위 지정은 두 가지 용도로 사용되었습니다: + - 페이지 이탈 시 상태 소멸(destroying state) + - 페이지당 커스텀 상태 보유 + +상태를 파괴(Destroy)하기 위해 스코핑(Scoping)을 사용하는 것은 이상적이지 않습니다. +문제는 범위 지정(Scoping)이 대규모 애플리케이션에서 제대로 작동하지 않는다는 것입니다. +예를 들어, 상태는 한 페이지에서 생성되지만 탐색 후 다른 페이지에서 나중에 소멸되는 경우가 많습니다. +이렇게 하면 여러 페이지에서 여러 개의 캐시를 활성화할 수 없습니다. + +마찬가지로 모달이나 다단계 양식과 같이 해당 상태를 위젯 트리의 다른 부분과 공유해야 하는 경우 '페이지별 사용자 지정 상태(custom state per page)' 접근 방식은 처리하기 어려워집니다. + +Riverpod은 다른 접근 방식을 취합니다: 첫째, 범위 지정(Scoping) providers는 권장하지 않으며, 둘째, `.family` 및 `.autoDispose`는 이를 완전히 대체하는 솔루션 입니다. + +Riverpod 내에서 '.autoDispose'로 표시된 공급자는 더 이상 사용되지 않을 때 자동으로 상태를 소멸(destroy)합니다. +공급자를 제거하는 마지막 위젯이 마운트 해제되면 Riverpod은 이를 감지하고 공급자를 파기(destroy)합니다. +이 동작을 테스트하려면 제공자에서 이 두 가지 수명 주기 메서드를 사용해 보세요: + + +```dart +ref.onCancel((){ + print("더 이상 어떤 것도 나를 Listen하지 않음!"); +}); +ref.onDispose((){ + print("`.autoDispose`로 정의된 경우, 방금 폐기되었음!"); +}); +``` + +이는 본질적으로 "상태 소멸(destroying state)" 문제를 해결합니다. + +또한 Provider를 `.family`로 표시할 수 있습니다. (동시에 `.autoDispose`로 표시할 수도 있습니다.) +이렇게 하면 providers에게 매개변수를 전달하여 내부적으로 여러 providers를 생성하고 추적할 수 있습니다. +즉, 매개변수를 전달할 때 *고유한 매개변수당 고유한 상태가 생성됩니다*. + + + +이렇게 하면 "페이지별 맞춤 상태(custom state per page)" 문제가 해결됩니다. +사실, 또 다른 이점이 있습니다. 이러한 상태는 더 이상 특정 페이지에 묶여 있지 않습니다. +대신 다른 페이지에서 동일한 상태에 액세스하려고 시도하는 경우 해당 페이지에서 매개변수를 재사용하기만 하면 액세스할 수 있습니다. + +여러 가지 면에서 providers에게 매개변수를 전달하는 것은 맵 키와 동일합니다. +키가 같으면 얻어지는 값도 동일합니다. 키가 다르면 다른 상태가 얻어집니다. + +[provider]: https://pub.dev/packages/provider +[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider +[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[autodispose]: /docs/concepts/modifiers/auto_dispose +[workaround]: https://pub.dev/packages/provider#can-i-obtain-two-different-providers-using-the-same-type +[.family modifier]: /docs/concepts/modifiers/family +[keepAlive]: /docs/concepts/modifiers/auto_dispose#refkeepalive +[as these two features go hand-in-hand]: /docs/concepts/modifiers/family#prefer-using-autodispose-when-the-parameter-is-not-constant +[simplification of logic]: /docs/concepts/modifiers/family#usage +[we have to]: https://github.com/flutter/flutter/issues/128432 +[it turns out]: https://github.com/flutter/flutter/issues/106549 +[*can't* react when a consumer stops listening to them]: https://github.com/flutter/flutter/issues/106546 +[integrates well with Flutter]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[ChangeNotifierProvider]: /docs/providers/change_notifier_provider +[Code generation]: /docs/about_code_generation +[AsyncNotifiers]: /docs/providers/notifier_provider +[combining Providers]: /docs/concepts/combining_providers +[global final variable]: /docs/concepts/providers#creating-a-provider diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx new file mode 100644 index 000000000..67577692e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx @@ -0,0 +1,190 @@ +--- +title: 빠른 시작 +--- + +이 섹션은 [Provider] 패키지에 익숙한 분들 중 Riverpod에 대해 자세히 알고 싶은 분들을 위해 만들어졌습니다. + +무엇보다도 먼저 짧은 [시작하기] 글을 읽고 작은 [sandbox] 예제를 통해 Riverpod의 기능을 테스트해 보세요. +그 결과 마음에 든다면 마이그레이션을 확실히 고려해야 합니다. + +실제로 Provider에서 Riverpod로 마이그레이션하는 것은 매우 간단합니다. + +마이그레이션은 기본적으로 *증분* 방식으로 수행할 수 있는 몇 가지 단계로 구성됩니다. + +## `ChangeNotifierProvider`로 시작하기 + +Riverpod로 전환하는 동안 'ChangeNotifier'를 계속 사용하고, 최신의 멋진 기능을 최대한 빨리 사용하지 않는 것도 상관없습니다. + +실제로 다음과 같이 시작해도 좋습니다: + +```dart +// 아래와 같은 코드를 가지고 있다면 +class MyNotifier extends ChangeNotifier { + int state = 0; + + void increment() { + state++; + notifyListeners(); + } +} + +// ... 이것만 추가하세요! +final myNotifierProvider = ChangeNotifierProvider((ref) { + return MyNotifier(); +}); +``` + +보시다시피 Riverpod은 pkg:Provider에서 마이그레이션을 지원하기 위해 제공되는 [ChangeNotifierProvider] 클래스를 노출합니다. + +이 Provider는 새 코드를 작성할 때 권장되지 않으며, Riverpod을 사용하는 가장 좋은 방법은 아니지만 +마이그레이션을 시작하는 부드럽고 매우 쉬운 방법이라는 점에 유의하세요. + +:::tip +'ChangeNotifier'를 더 최신의 [Riverpod의 provider들]로 '즉시' 변경하려고 서두를 필요는 없습니다. +일부는 약간의 패러다임 전환이 필요하기 때문에 처음에는 어려울 수 있습니다. + +먼저 Riverpod에 익숙해지는 것이 중요하므로 천천히 하세요; +pkg:provider의 *거의* 모든 Provider가 pkg:riverpod에 엄격하게 대응한다는 것을 금방 알 수 있습니다. +::: + +## *잎사귀(leaves)*부터 시작 + +다른 것에 의존하지 않는 Provider, 즉 종속성 트리의 *잎사귀(leaves)*부터 시작하세요. +모든 잎사귀를 마이그레이션한 후에는 잎사귀에 의존하는 Provider로 이동할 수 있습니다. + +다시 말해, 처음부터 `ProxyProvider`를 마이그레이션하지 말고, 모든 종속성을 마이그레이션한 후에 처리하세요. + +이렇게 하면 마이그레이션 프로세스가 향상되고 간소화되는 동시에 오류를 최소화/추적할 수 있습니다. + + +## Riverpod과 Provider가 공존할 수 있습니다. +*Provider와 Riverpod을 동시에 사용할 수 있다는 것을 기억하세요.* + +실제로 import alias를 사용하면 두 API를 모두 사용할 수 있습니다. +이는 가독성 면에서도 좋으며 모호한 API 사용을 제거합니다. + +이렇게 하려면, 코드베이스에서 각 Provider 가져오기에 대해 가져오기 별칭(alias)을 사용하는 것을 고려해 보세요. + +:::info +가져오기 별칭을 효과적으로 구현하는 방법에 대한 전체 가이드가 곧 제공될 예정입니다. +::: + +## `Consumer`를 바로 사용할 *필요*는 없습니다 + +명심해야 할 것은 [Riverpod의 `Consumer` API]를 `즉시` 사용할 필요는 없다는 점입니다. +마이그레이션을 막 시작한 경우, [위에서 언급한 대로] `ChangeNotifierProvider`로 시작하는 것이 좋습니다. + +위에서 정의한 `myNotifierProvider`를 고려해 보세요. + +내부 코드가 pkg:Provider의 API에 의존하고 있을 가능성이 높으므로, 다음을 사용하여 pkg:Riverpod로 `ChangeNotifier`를 사용하기 시작하세요. +```dart +MultiProvider( + providers: [ + ChangeNotifierProvider.value(value: ref.watch(myNotifierProvider.notifier)), + ] +) +``` +이렇게 하면 처음에 루트 위젯만 `ConsumerWidget`으로 변환하면 됩니다. +이렇게 하면 pkg:Riverpod로 마이그레이션하는 것이 훨씬 쉬워집니다. + +## 한번에 하나씩 Provider를 마이그레이션하세요 + +기존 앱이 있는 경우, 모든 Provider를 한꺼번에 마이그레이션하지 마세요! + +장기적으로 모든 애플리케이션을 Riverpod로 이동하려고 노력해야 하지만, **자신을 지치게(burn) 하지 마세요**. +한번에 하나의 Provider씩 처리하세요. + +위의 예를 들어보겠습니다. `myNotifierProvider`를 Riverpod으로 **완전히** 마이그레이션한다는 것은 다음과 같이 작성하는 것을 의미합니다: + +```dart +class MyNotifier extends Notifier { + @override + int build() => 0; + + void increment() => state++; +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); +``` + +.. 그리고 _또한_ 해당 공급자가 소비되는 방식을 변경해야 합니다, +예를 들어 이 공급자에 대한 각 `context.watch`를 `ref.watch`로 변경해야 합니다. + +이 작업은 시간이 다소 걸리고 오류가 발생할 수 있으므로, 한 번에 끝내려고 서두르지 마세요. + +## `ProxyProvider` 마이그레이션 +pkg:Provider 내에서 `ProxyProvider`는 다른 프로바이더의 값을 결합하는 데 사용됩니다; +빌드는 다른 프로바이더의 값에 따라 반응적(reactively)으로 달라집니다. + +Riverpod에서는 대신 프로바이더는 [기본적으로 컴포저블이 가능]하므로, +`ProxyProvider`를 마이그레이션할 때 한 프로바이더에서 다른 프로바이더로 직접 종속성을 선언하려면 `ref.watch`를 작성하기만 하면 됩니다. + +오히려 Riverpod에서 값을 결합하는 것이 더 간단하고 직관적으로 느껴질 것이므로 마이그레이션을 통해 코드를 크게 간소화할 수 있습니다. + +또한 두 개 이상의 공급자를 결합할 때, 복잡한 과정을 거칠 필요 없이 `ref.watch`를 하나 더 추가하기만 하면 바로 사용할 수 있습니다. + +## 빠른(Eager) 초기화 + +Riverpod의 프로바이더는 최종 전역(global) 변수이기 때문에 [기본적으로 지연(Lazy)] 초기화 됩니다. + +시작 시 일부 워밍업 데이터나 유용한 서비스를 초기화해야 하는 경우, 가장 좋은 방법은 `MultiProvider`를 넣었던 위치에서 프로바이더를 먼저 읽는 것입니다. + +즉, Riverpod은 강제로 초기화할 수 없기 때문에, 시작 단계에서 읽고 캐시하여, 나머지 애플리케이션 내에서 필요할 때 바로 사용할 수 있도록(warm and ready) 할 수 있습니다. + +pkg:Riverpod의 Provider들의 초기화에 대한 전체 가이드는 [여기에서 확인할 수 있습니다]. + +## 코드 생성 +Riverpod을 *미래에 대비한* 방식으로 사용하려면 [코드 생성]을 권장합니다. +참고로, 메타프로그래밍(metaprogramming)이 보편화되면, 코드 생성 기능이 Riverpod의 기본값이 될 가능성이 높습니다. + +안타깝게도 `@riverpod`는 `ChangeNotifierProvider`에 대한 코드를 생성할 수 없습니다. +이 문제를 해결하기 위해 다음 유틸리티 확장 메소드(extesion method)를 사용할 수 있습니다: + +```dart +extension ChangeNotifierWithCodeGenExtension on Ref { + T listenAndDisposeChangeNotifier(T notifier) { + notifier.addListener(notifyListeners); + onDispose(() => notifier.removeListener(notifyListeners)); + onDispose(notifier.dispose); + return notifier; + } +} +``` + +그런 다음 다음 코드 생성 구문을 사용하여 `ChangeNotifier`를 노출할 수 있습니다: +```dart +// ignore_for_file: unsupported_provider_value +@riverpod +MyNotifier example(ExampleRef ref) { + return ref.listenAndDisposeChangeNotifier(MyNotifier()); +} +``` + +"기본" 마이그레이션이 완료되면 `ChangeNotifier`를 `Notifier`로 변경할 수 있으므로 임시 확장이 필요하지 않습니다. +앞의 사례를 예로 들면, "완전히 마이그레이션된" `Notifier`가 됩니다: + +```dart +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() => 0; + + void increment() => state++; +} +``` + +이 작업이 완료되고 코드베이스에 더 이상 `ChangeNotifierProvider`가 없다는 것이 확실해지면 임시 확장자를 완전히 제거할 수 있습니다. + +코드 생성은 권장 사항이지만 *필수 사항*은 아니라는 점을 명심하세요. +마이그레이션에 대해 점진적으로 생각하는 것이 좋습니다: +한 번에 코드 생성 구문으로 *전환하면서* 마이그레이션을 구현하는 것이 과하다고 생각되면 점진적으로 마이그레이션을 고려하는 것이 *좋습니다*. + +이 가이드에 따라 나중에 한 단계 더 나아가 코드생성으로 마이그레이션할 수 있습니다. + +[코드 생성]: /docs/concepts/about_code_generation +[Riverpod의 provider들]: /docs/providers/notifier_provider +[기본적으로 컴포저블이 가능]: /docs/from_provider/motivation#combining-providers-is-hard-and-error-prone +[위에서 언급한 대로]: /docs/from_provider/quickstart#start-with-changenotifierprovider +[Riverpod의 `Consumer` API]: /docs/concepts/reading +[기본적으로 지연(Lazy)]: /docs/concepts/provider_lifecycles +[여기에서 확인할 수 있습니다]: /docs/essentials/eager_initialization diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started.mdx deleted file mode 100644 index 1542ee01a..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: 시작하기 -version: 1 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; - -import pubspec from "../../../../i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec"; -import dartHelloWorld from "../../../../i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world"; -import helloWorld from "../../../../i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world"; -import dartPubspec from "../../../../i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec"; - -import { - trimSnippet, - AutoSnippet, - When } from "../../../../src/components/CodeSnippet"; - ---- - -## Try Riverpod online - -To get a feel of Riverpod, try it online on [Dartpad](https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2). - -[Riverpod]의 내부 메커니즘에 들어가기 앞서, 우선 [Riverpod]을 설치하는 방법과 -"Hello world"를 표시하는 방법부터 함께 시작해봅시다. - -## 어떤 패키지를 설치해야하나요? - -[Riverpod]은 여러 종류의 패키지가 있습니다. 각각 다른 사용 목적을 가지고 있으며 개별마다 상이한 특징을 가지고 있습니다. -어떤 [Riverpod] 패키지를 설치할지는 만드는 앱의 형태에 따라 다릅니다. - -다음 아래의 표를 참조하여 사용할 패키지를 결정할 수 있습니다. - -| 앱의 형태 | 패키지명 | 설정 | -| ------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| Flutter + [flutter_hooks] | [hooks_riverpod] | [flutter_hooks] 과 [Riverpod]을 함께 병용한 패키지 | -| Flutter | [flutter_riverpod] | Flutter 앱에 [Riverpod] 을 사용할 경우의 기본 패키지 | -| Dart(Flutter 사용안함） | [riverpod](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod) | Flutter 에 관련된 모든 클래스가 완전제거된 [Riverpod] 패키지 | - -## 패키지 설치 방법 - -설치할 패키지의 종류가 결정되었다면, `pubspec.yaml`에 아래의 방법으로 패키지를 추가합니다. - - - - - - -패키지 추가 후 `flutter pub get` 를 실행해주세요. - - - 마지막으로, {" "}를 실행하여 코드를 생성합니다. - flutter pub run build_runner watch - - - - - - - -패키지 추가 후 `dart pub get`를 실행해주세요. - - - 마지막으로, {" "}를 실행하여 코드를 생성합니다. - flutter pub run build_runner watch - - - - - -이걸로 [Riverpod]이 앱에 추가되었습니다. - -## 사용예시: Hello world - -[Riverpod]설치를 완료하였다면 이제 사용을 시작해봅시다. -아래의 예제코드를 실행하면 Hello world가 화면에 표시됩니다. - -export const foo = 42; - - - - - - -`flutter run` 명령어를 실행합니다. -디바이스 화면에 Hello world가 표시됩니다. - - - - - - -`dart lib/main.dart` 명령어를 실행합니다. -콘솔창에 Hellow world가 출력됩니다. - - - - -## 더 나아가기: Code Snippets 설치하기 - -`Flutter`를 `VS Code` 에서 사용하는 경우, 확장에서 -[Flutter Riverpod Snippets](https://marketplace.visualstudio.com/items?itemName=robert-brunhage.flutter-riverpod-snippets) -패키지를 검색하여 [Riverpod] 전용 Code Snippets을 설치하여 사용할 수 있습니다. - -`Flutter`를 `Android Studio` 또는 `IntelliJ` 에서 사용하는 경우, -[Flutter Riverpod Snippets](https://plugins.jetbrains.com/plugin/14641-flutter-riverpod-snippets) -를 설치하여 사용할 수 있습니다. - -![img](/img/snippets/greetingProvider.gif) - - -## 다음 단계 선택하기 - -기본 컨셉에대해 확인하기: - -- [Learn more about providers](/docs/concepts/providers) - -cookbook 따라가기: - -- [How to test providers](/docs/cookbooks/testing) - - -[riverpod]: https://github.com/rrousselgit/riverpod -[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod -[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod -[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/raw.dart deleted file mode 100644 index 9c83c5a61..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/raw.dart +++ /dev/null @@ -1,19 +0,0 @@ -// ignore_for_file: avoid_print - -/* SNIPPET START */ - -import 'package:riverpod/riverpod.dart'; - -// 우리는 값을 저장할 "provider"를 만들겁니다(여기서 값은 "Hello world"를 의미합니다). -// 프로바이더를 사용하는 것으로 값의 mock/override가 가능하게 됩니다. -final helloWorldProvider = Provider((_) => 'Hello world'); - -void main() { - // 이 객체는 프로바이더 상태를 저장하게 됩니다. - final container = ProviderContainer(); - - // "container" 덕분에, 여기서 우리의 프로바이더 값을 읽을 수 있습니다. - final value = container.read(helloWorldProvider); - - print(value); // Hello world -} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/codegen.yaml b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/codegen.yaml deleted file mode 100644 index 138dd42d7..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/codegen.yaml +++ /dev/null @@ -1,11 +0,0 @@ -name: my_app_name -environment: - sdk: ">=2.17.0 <3.0.0" - -dependencies: - riverpod: ^2.0.2 - riverpod_annotation: ^1.0.4 - -dev_dependencies: - build_runner: - riverpod_generator: ^1.0.4 \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/index.tsx deleted file mode 100644 index d0c456dcc..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/index.tsx +++ /dev/null @@ -1,9 +0,0 @@ -import raw from "!!raw-loader!./raw.yaml"; -import codegen from "!!raw-loader!./codegen.yaml"; - -export default { - raw, - hooks: raw, - codegen, - hooksCodegen: codegen, -}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/raw.yaml b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/raw.yaml deleted file mode 100644 index f9797b9c7..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/raw.yaml +++ /dev/null @@ -1,6 +0,0 @@ -name: my_app_name -environment: - sdk: ">=2.17.0 <3.0.0" - -dependencies: - riverpod: ^2.0.2 \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/codegen.yaml b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/codegen.yaml deleted file mode 100644 index 5b7a9b2d3..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/codegen.yaml +++ /dev/null @@ -1,14 +0,0 @@ -name: my_app_name -environment: - sdk: ">=2.17.0 <3.0.0" - flutter: ">=3.0.0" - -dependencies: - flutter: - sdk: flutter - flutter_riverpod: ^2.0.2 - riverpod_annotation: ^1.0.4 - -dev_dependencies: - build_runner: - riverpod_generator: ^1.0.4 \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks.yaml b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks.yaml deleted file mode 100644 index 5a1995205..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks.yaml +++ /dev/null @@ -1,10 +0,0 @@ -name: my_app_name -environment: - sdk: ">=2.17.0 <3.0.0" - flutter: ">=3.0.0" - -dependencies: - flutter: - sdk: flutter - flutter_hooks: ^0.18.0 - hooks_riverpod: ^2.0.2 \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks_codegen.yaml b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks_codegen.yaml deleted file mode 100644 index 807ea6729..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks_codegen.yaml +++ /dev/null @@ -1,15 +0,0 @@ -name: my_app_name -environment: - sdk: ">=2.17.0 <3.0.0" - flutter: ">=3.0.0" - -dependencies: - flutter: - sdk: flutter - flutter_hooks: ^0.18.0 - hooks_riverpod: ^2.0.2 - riverpod_annotation: ^1.0.4 - -dev_dependencies: - build_runner: - riverpod_generator: ^1.0.4 \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/index.tsx deleted file mode 100644 index d7e1ee500..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/index.tsx +++ /dev/null @@ -1,11 +0,0 @@ -import raw from "!!raw-loader!./raw.yaml"; -import hooks from "!!raw-loader!./hooks.yaml"; -import codegen from "!!raw-loader!./codegen.yaml"; -import hooksCodegen from "!!raw-loader!./hooks_codegen.yaml"; - -export default { - raw, - hooks, - codegen, - hooksCodegen, -}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/raw.yaml b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/raw.yaml deleted file mode 100644 index 605be5f5e..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/raw.yaml +++ /dev/null @@ -1,9 +0,0 @@ -name: my_app_name -environment: - sdk: ">=2.17.0 <3.0.0" - flutter: ">=3.0.0" - -dependencies: - flutter: - sdk: flutter - flutter_riverpod: ^2.0.2 \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction.mdx deleted file mode 100644 index 4b19a3950..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction.mdx +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: 소개 ---- - ---- - -## What is Riverpod? - -Riverpod (anagram of [Provider](https://pub.dev/packages/provider)) is a reactive -caching framework for Flutter/Dart. It can automatically fetch, cache, combine and -recompute network requests, while also taking care of errors for you. - -## Motivation - -Modern applications rarely come with all the information necessary to render -their User Interface. Instead, the data is often fetched asynchronously -from a server. - -The problem is, working with asynchronous code is hard. Although Flutter comes -with some way to store state, it doesn't do much besides that. Thus, a number -of challenges remain unsolved: - -- Asynchronous requests need to be cached locally, as it would be unreasonable - to re-execute them whenever the UI refreshes. -- Since we have a cache, our cache could get out of date if we're not careful. -- We also need to handle errors and loading states - -Nailing those problems at scale can be difficult, and they are impacted by a large -amount of features, such as: - -- pull to refresh -- infinite lists / fetch as we scroll -- search as we type -- debouncing asynchronous requests -- cancelling asynchronous requests when no-longer used -- optimistic UIs -- offline mode -- ... - -These features can be tricky to implement, but are crucial for a good user experience. -Yet few packages try to tackle those problems directly, and a lot of the work -has to be done manually. - -That's where Riverpod comes in. -Riverpod tries to solve those problems, by offering a new unique -way of writing business logic, inspired by Flutter widgets. In -many ways Riverpod is comparable to widgets, but for state. - -Using this new approach, these complex features are mostly done by default. All -that's left is to focus on your UI. - -Skeptical? Here's an example. The following snippet is a simplification of the [Pub.dev](https://github.com/rrousselGit/riverpod/tree/master/examples/pub) -client application implemented using Riverpod. - -```dart -// Fetches the list of packages from pub.dev -@riverpod -Future> fetchPackages( - FetchPackagesRef ref, { - required int page, - String search = '', -}) async { - final dio = Dio(); - // Fetch an API. Here we're using package:dio, but we could use anything else. - final response = await dio.get( - 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', - ); - - // Decode the JSON response into a Dart class. - final json = response.data as List; - return json.map(Package.fromJson).toList(); -} -``` - -This snippet is all the business logic you need for a "search as we type" -+ "pull to refresh" + "infinite list", while handling error/loading states. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx new file mode 100644 index 000000000..68ba4fe88 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx @@ -0,0 +1,191 @@ +--- +title: 시작하기 +pagination_next: essentials/first_request +version: 4 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import pubspec from "./getting_started/pubspec"; +import dartHelloWorld from "./getting_started/dart_hello_world"; +import pubadd from "./getting_started/pub_add"; +import helloWorld from "./getting_started/hello_world"; +import dartPubspec from "./getting_started/dart_pubspec"; +import dartPubadd from "./getting_started/dart_pub_add"; +import { + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; +import { Link } from "../../../../../src/components/Link"; + +## Riverpod 온라인으로 경험해보기 + +Riverpod을 경험해보려면 [Dartpad](https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2)나 [Zapp](https://zapp.run/new)에서 온라인으로 시도해보세요: + + + +## 패키지 설치하기 + +설치하려는 패키지가 결정되면, 아래와 같이 한 줄로 앱에 종속성을 추가합니다: + + + + + + + + + + + + + + + + +대안으로, `pubspec.yaml`에 종속성을 직접 추가할 수도 있습니다: + + + + + + +그리고, `flutter pub get`으로 패키지를 설치합니다. + + + 이제 코드 생성기를 실행할 수 있습니다.{" "} + flutter run build_runner watch. + + + + + + + +그리고, `dart pub get`으로 패키지를 설치합니다. + + + 이제 코드 생성기를 실행할 수 있습니다.{" "} + dart pub run build_runner watch. + + + + + +이게 다입니다. 당신의 앱에 [Riverpod]을 추가했습니다! + +## riverpod_lint/custom_lint 활성화하기 + +Riverpod은 선택사항으로 [riverpod_lint] 패키지를 제공합니다. +이 패키지는 더 좋은 코드를 작성하는데 도움이 되는 린트 규칙과 사용자 정의 리팩토링 옵션을 제공합니다. + +이전 단계를 따라왔다면 이 패키지는 이미 설치되어 있을 것입니다. +하지만 활성화하기 위해서는 별도의 단계가 필요합니다. + +[riverpod_lint]를 활성화하려면, 당신의 `pubspec.yaml`옆에 `analysis_options.yaml`을 추가하고 다음을 포함해야 합니다: + + + {`analyzer: + plugins: + - custom_lint`} + + +이제 코드베이스에서 Riverpod을 사용할 때 당신이 실수한 경우, IDE에서 경고가 보이게 됩니다. + +전체 경고와 리팩토링 목록을 보려면 [riverpod_lint] 페이지를 참고하세요. + +:::note +이 경고는 `dart analyze` 명령에서는 표시되지 않습니다. +CI/터미널에서 이 경고를 확인하려면 다음을 실행하세요: + +```sh +dart run custom_lint +``` + +::: + +## 사용 예시: Hello world + +이제 [Riverpod]를 설치했으니 사용해볼 수 있습니다. + +다음 스니펫은 새로운 종속성을 사용하여 "Hello world"를 만드는 방법을 보여줍니다: + + + + + + +이제 `flutter run`으로 앱을 시작할 수 있습니다. +이렇게 하면 기기에 "Hello world"가 표시됩니다. + + + + + + +이제 `dart lib/main.dart`으로 앱을 시작할 수 있습니다. +이렇게 하면 콘솔에 "Hello world"가 표시됩니다. + + + + +## 더 나아가기: 코드 스니펫 설치하기 + +`Flutter`와 `VS Code`를 사용하고 있다면 [Flutter Riverpod Snippets](https://marketplace.visualstudio.com/items?itemName=robert-brunhage.flutter-riverpod-snippets)를 사용해보세요. + +`Flutter`와 `Android Studio` 또는 `IntelliJ`를 사용하고 있다면 [Flutter Riverpod Snippets](https://plugins.jetbrains.com/plugin/14641-flutter-riverpod-snippets)를 사용해보세요. + +![img](/img/snippets/greetingProvider.gif) + +## 다음 단계 선택 + +몇 가지 기본 개념 알아보기: + +- + +쿡북(Cookbook) 따라하기: + +- + +[riverpod]: https://github.com/rrousselgit/riverpod +[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod +[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod +[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks +[riverpod_lint]: https://pub.dev/packages/riverpod_lint diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/index.tsx similarity index 100% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/index.tsx rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/index.tsx diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart new file mode 100644 index 000000000..89bbd92dc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart @@ -0,0 +1,25 @@ +// ignore_for_file: avoid_print + +/* SNIPPET START */ + +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'main.g.dart'; + +// 값(여기서는 "Hello world")을 저장할 "provider"를 생성합니다. +// provider를 이용하면, 노출된 값을 모의(Mock)하거나 오버라이드(override)할 수 있습니다. +@riverpod +String helloWorld(HelloWorldRef ref) { + return 'Hello world'; +} + +void main() { + // 이 객체는 providers의 상태가 저장되는 곳입니다. + final container = ProviderContainer(); + + // "container" 덕분에 provider를 읽을 수 있습니다. + final value = container.read(helloWorldProvider); + + print(value); // Hello world +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart similarity index 76% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart index cb53853fb..445bc0a9c 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart @@ -3,16 +3,10 @@ /* SNIPPET START */ import 'package:riverpod/riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -part 'main.g.dart'; // We create a "provider", which will store a value (here "Hello world"). // By using a provider, this allows us to mock/override the value exposed. -@riverpod -String helloWorld(HelloWorldRef ref) { - return 'Hello world'; -} +final helloWorldProvider = Provider((_) => 'Hello world'); void main() { // This object is where the state of our providers will be stored. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx new file mode 100644 index 000000000..07c03cf6b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx @@ -0,0 +1,32 @@ +export function buildDeps({ + deps = [], + devDeps = [], +}: { + deps?: string[]; + devDeps?: string[]; +}) { + var result = ""; + for (const dep of deps) { + result += `dart pub add ${dep}\n`; + } + + for (const dep of [...devDeps, "custom_lint", "riverpod_lint"]) { + result += `dart pub add dev:${dep}\n`; + } + + return result; +} + +const raw = buildDeps({ deps: ["riverpod"] }); + +const codegen = buildDeps({ + deps: ["riverpod", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx new file mode 100644 index 000000000..d44367c30 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx @@ -0,0 +1,40 @@ +import { + riverpodVersion, + riverpodAnnotationVersion, + riverpodGeneratorVersion, + riverpodLintVersion, +} from "../../../../../../src/versions"; + +const codegen = `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + riverpod: ^${riverpodVersion} + riverpod_annotation: ^${riverpodAnnotationVersion} + +dev_dependencies: + build_runner: + custom_lint: + riverpod_generator: ^${riverpodGeneratorVersion} + riverpod_lint: ^${riverpodLintVersion} +`; + +const raw = `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + riverpod: ^${riverpodVersion} + +dev_dependencies: + custom_lint: + riverpod_lint: ^${riverpodLintVersion} +`; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart similarity index 59% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart index c08110c6b..cd94bb4ad 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart @@ -7,10 +7,10 @@ import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; -part 'main_hooks.g.dart'; +part 'main.g.dart'; -// 我们创建一个 “provider”，它将用于保存一个值（这里是 “Hello world”）。 -// 通过使用一个 provider，我们能够模拟或覆盖被暴露的值。 +// 값을 저장할 “provider"를 생성합니다(여기서는 "Hello world"). +// 프로바이더를 사용하면, 노출된 값을 모의(Mock)하거나 재정의(Override)할 수 있습니다. @riverpod String helloWorld(HelloWorldRef ref) { return 'Hello world'; @@ -18,20 +18,20 @@ String helloWorld(HelloWorldRef ref) { void main() { runApp( - // 为了能让组件读取 provider，我们需要将整个 - // 应用都包裹在 “ProviderScope” 组件内。 - // 这里也就是存储我们所有 provider 状态的地方。 + // 위젯이 프로바이더를 읽을 수 있도록 하려면, + // 전체 애플리케이션을 "ProviderScope" 위젯으로 감싸야 합니다. + // 여기에 프로바이더의 상태가 저장됩니다. ProviderScope( child: MyApp(), ), ); } -// 扩展来自 Riverpod 的 HookConsumerWidget 而不是 HookWidget +// HookWidget 대신 Riverpod에서 제공되는 HookConsumerWidget을 확장합니다. class MyApp extends HookConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // We can use hooks inside HookConsumerWidget + // HookConsumerWidget 내부에서 Hook을 사용할 수 있습니다. final counter = useState(0); final String value = ref.watch(helloWorldProvider); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart similarity index 97% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart index e44b1758b..a7cc420dc 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -2,7 +2,7 @@ // ignore_for_file: non_constant_identifier_names -part of 'main_hooks.dart'; +part of 'main.dart'; // ************************************************************************** // RiverpodGenerator diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx new file mode 100644 index 000000000..3f10c2a94 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx @@ -0,0 +1,11 @@ +import raw from "!!raw-loader!./raw.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; +import codegen from "!!raw-loader!./main.dart"; +import hooksCodegen from "!!raw-loader!./hooks_codegen/main.dart"; + +export default { + raw, + hooks: raw_hooks, + codegen, + hooksCodegen: hooksCodegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart similarity index 60% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart index 1ea9ff208..77de400be 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart @@ -8,8 +8,8 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; -// 我们创建一个 “provider”，它将用于保存一个值（这里是 “Hello world”）。 -// 通过使用一个 provider，我们能够模拟或覆盖被暴露的值。 +// 값을 저장할 “provider"를 생성합니다(여기서는 "Hello world"). +// 프로바이더를 사용하면, 노출된 값을 모의(Mock)하거나 재정의(Override)할 수 있습니다. @riverpod String helloWorld(HelloWorldRef ref) { return 'Hello world'; @@ -17,16 +17,16 @@ String helloWorld(HelloWorldRef ref) { void main() { runApp( - // 为了能让组件读取 provider，我们需要将整个 - // 应用都包裹在 “ProviderScope” 组件内。 - // 这里也就是存储我们所有 provider 状态的地方。 + // 위젯이 프로바이더를 읽을 수 있도록 하려면, + // 전체 애플리케이션을 "ProviderScope" 위젯으로 감싸야 합니다. + // 여기에 프로바이더의 상태가 저장됩니다. ProviderScope( child: MyApp(), ), ); } -// 扩展来自 Riverpod 的 HookConsumerWidget 而不是 HookWidget +// StatelessWidget 대신 Riverpod에서 제공되는 ConsumerWidget을 확장합니다. class MyApp extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart new file mode 100644 index 000000000..a7cc420dc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'main.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +/// See also [helloWorld]. +@ProviderFor(helloWorld) +final helloWorldProvider = AutoDisposeProvider.internal( + helloWorld, + name: r'helloWorldProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef HelloWorldRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/raw.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/raw_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/raw_hooks.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx new file mode 100644 index 000000000..65c7be1bd --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx @@ -0,0 +1,39 @@ +export function buildDeps({ + deps = [], + devDeps = [], +}: { + deps?: string[]; + devDeps?: string[]; +}) { + var result = ''; + for (const dep of deps) { + result += `flutter pub add ${dep}\n`; + } + + for (const dep of [...devDeps, "custom_lint", "riverpod_lint"]) { + result += `flutter pub add dev:${dep}\n`; + } + + return result; +} + +const raw = buildDeps({ deps: ["flutter_riverpod"] }); + +const codegen = buildDeps({ + deps: ["flutter_riverpod", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +const hooks = buildDeps({ deps: ["hooks_riverpod", "flutter_hooks"] }); + +const hooksCodegen = buildDeps({ + deps: ["hooks_riverpod", "flutter_hooks", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +export default { + raw: raw, + hooks: hooks, + codegen: codegen, + hooksCodegen: hooksCodegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx new file mode 100644 index 000000000..da974c2a1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx @@ -0,0 +1,51 @@ +import { + flutterRiverpodVersion, + hooksRiverpodVersion, + riverpodAnnotationVersion, + riverpodGeneratorVersion, + riverpodLintVersion, +} from "../../../../../../src/versions"; + +function plain(riverpod: string) { + return `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.0.0" + +dependencies: + flutter: + sdk: flutter + ${riverpod} + +dev_dependencies: + custom_lint: + riverpod_lint: ^${riverpodLintVersion} +`; +} + +function codegen(riverpod: string) { + return `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.0.0" + +dependencies: + flutter: + sdk: flutter + ${riverpod} + riverpod_annotation: ^${riverpodAnnotationVersion} + +dev_dependencies: + build_runner: + custom_lint: + riverpod_generator: ^${riverpodGeneratorVersion} + riverpod_lint: ^${riverpodLintVersion} +`; +} + +export default { + raw: plain(`flutter_riverpod: ^${flutterRiverpodVersion}`), + hooks: plain(`hooks_riverpod: ^${hooksRiverpodVersion}\n flutter_hooks:`), + codegen: codegen(`flutter_riverpod: ^${flutterRiverpodVersion}`), + hooksCodegen: codegen(`hooks_riverpod: ^${hooksRiverpodVersion}\n flutter_hooks:`), +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx new file mode 100644 index 000000000..cfd6b051e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx @@ -0,0 +1,56 @@ +--- +title: 왜 Riverpod인가? +version: 1 +--- + +import whyRiverpod from "./why_riverpod"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +## Riverpod 이란? + +Riverpod ([Provider](https://pub.dev/packages/provider)의 애너그램-철자를 바꾼 말)는 +Flutter/Dart를 위한 반응형 캐싱 프레임워크(Reactive caching framework)입니다. + +선언적 프로그래밍과 반응형 프로그래밍을 사용하여, Riverpod은 당신을 위해 애플리케이션의 상단 부분을 처리합니다. +내장된 오류 처리 및 캐싱을 통해 네트워크 요청을 수행할 수 있으며, +필요한 경우 데이터를 자동으로 데이터를 자동으로 다시 가져올 수 있습니다. + +## Motivation + +현대 애플리케이션은 UI를 렌더링하는 데 필요한 모든 정보를 제공하지 않습니다. +대신, 서버에서 비동기적으로 데이터를 가져오는 경우가 많습니다. + +문제는 비동기 코드를 사용하는 것이 어렵다는 것입니다. +Flutter는 상태 변수를 생성하고, 변경시 UI를 갱신하는 몇 가지 방법을 제공하지만, 아직은 상당히 제한적입니다. + +- 비동기 요청은 UI가 업데이트될 때마다 다시 실행하는 것은 불합리하므로 로컬에 캐시해야 할 필요가 있습니다. +- 캐시가 있기 때문에 우리가 조심하지 않으면 오래된 상태가 될 수 있습니다. +- 또한 오류 및 로딩 상태를 처리해야 합니다. + +이러한 문제를 대규모로 해결하는 것은 어려울 수 있으며, 다음과 같은 많은 기능에 영향을 받습니다: + +- 당겨서 새로 고침 +- 무한 목록 / 스크롤할 때 가져오기 +- 타이핑하는 동안 검색 +- 비동기 요청의 디바운싱(Debouncing) +- 더 이상 사용되지 않을 때 비동기 요청 취소 +- 낙관적(Optimistic) UI +- 오프라인 모드 +- ... + +이러한 기능은 구현하기 어려울 수 있지만, 좋은 사용자 경험을 위해 중요합니다. +아직까지 이러한 문제를 직접 해결하려는 패키지는 몇 개 없으며, 직접처리하려면 많은 작업이 필요합니다. + +그래서 Riverpod이 등장했습니다. +Riverpod은 Flutter 위젯에서 영감을 받아, 비즈니스 로직을 작성하는 새롭고 독특한 방식을 제공하여 이러한 문제를 해결하려고 합니다. +여러 가지 면에서 Riverpod은 위젯과 비슷하지만, 상태를 처리하기 위한 것입니다. + +이 새로운 접근 방식을 사용하면, 복잡한 기능을 대부분 기본적으로 처리할 수 있습니다. +남은 것은 UI에 집중하는 것입니다. + +회의적인가요? 여기 예제가 있습니다. +다음 스니펫은 Riverpod을 사용하여 구현된 [Pub.dev](https://github.com/rrousselGit/riverpod/tree/master/examples/pub) 클라이언트 어플리케이션의 단순화 버전입니다. + + + +이 스니펫은 당신이 에러/로딩 상태를 다루면서, "타이핑하는 동안 검색" + "당겨서 새로 고침" + "무한 목록"을 구현하는 데 필요한 모든 비즈니스 로직을 담고 있습니다. \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart new file mode 100644 index 000000000..83e1ff5b6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart @@ -0,0 +1,31 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class Package { + static Package fromJson(dynamic json) { + throw UnimplementedError(); + } +} + +/* SNIPPET START */ + +// Fetches the list of packages from pub.dev +@riverpod +Future> fetchPackages( + FetchPackagesRef ref, { + required int page, + String search = '', +}) async { + final dio = Dio(); + // Fetch an API. Here we're using package:dio, but we could use anything else. + final response = await dio.get>( + 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', + ); + + // Decode the JSON response into a Dart class. + return response.data?.map(Package.fromJson).toList() ?? const []; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart new file mode 100644 index 000000000..8f63ec36f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart @@ -0,0 +1,227 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$fetchPackagesHash() => r'eebf7d838a57f493fffebfd2c8d8ab76d3233165'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [fetchPackages]. +@ProviderFor(fetchPackages) +const fetchPackagesProvider = FetchPackagesFamily(); + +/// See also [fetchPackages]. +class FetchPackagesFamily extends Family { + /// See also [fetchPackages]. + const FetchPackagesFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'fetchPackagesProvider'; + + /// See also [fetchPackages]. + FetchPackagesProvider call({ + required int page, + String search = '', + }) { + return FetchPackagesProvider( + page: page, + search: search, + ); + } + + @visibleForOverriding + @override + FetchPackagesProvider getProviderOverride( + covariant FetchPackagesProvider provider, + ) { + return call( + page: provider.page, + search: provider.search, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith( + FutureOr> Function(FetchPackagesRef ref) create) { + return _$FetchPackagesFamilyOverride(this, create); + } +} + +class _$FetchPackagesFamilyOverride implements FamilyOverride { + _$FetchPackagesFamilyOverride(this.overriddenFamily, this.create); + + final FutureOr> Function(FetchPackagesRef ref) create; + + @override + final FetchPackagesFamily overriddenFamily; + + @override + FetchPackagesProvider getProviderOverride( + covariant FetchPackagesProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [fetchPackages]. +class FetchPackagesProvider extends AutoDisposeFutureProvider> { + /// See also [fetchPackages]. + FetchPackagesProvider({ + required int page, + String search = '', + }) : this._internal( + (ref) => fetchPackages( + ref as FetchPackagesRef, + page: page, + search: search, + ), + from: fetchPackagesProvider, + name: r'fetchPackagesProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$fetchPackagesHash, + dependencies: FetchPackagesFamily._dependencies, + allTransitiveDependencies: + FetchPackagesFamily._allTransitiveDependencies, + page: page, + search: search, + ); + + FetchPackagesProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.page, + required this.search, + }) : super.internal(); + + final int page; + final String search; + + @override + Override overrideWith( + FutureOr> Function(FetchPackagesRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: FetchPackagesProvider._internal( + (ref) => create(ref as FetchPackagesRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + page: page, + search: search, + ), + ); + } + + @override + ({ + int page, + String search, + }) get argument { + return ( + page: page, + search: search, + ); + } + + @override + AutoDisposeFutureProviderElement> createElement() { + return _FetchPackagesProviderElement(this); + } + + FetchPackagesProvider _copyWith( + FutureOr> Function(FetchPackagesRef ref) create, + ) { + return FetchPackagesProvider._internal( + (ref) => create(ref as FetchPackagesRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + page: page, + search: search, + ); + } + + @override + bool operator ==(Object other) { + return other is FetchPackagesProvider && + other.page == page && + other.search == search; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, page.hashCode); + hash = _SystemHash.combine(hash, search.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin FetchPackagesRef on AutoDisposeFutureProviderRef> { + /// The parameter `page` of this provider. + int get page; + + /// The parameter `search` of this provider. + String get search; +} + +class _FetchPackagesProviderElement + extends AutoDisposeFutureProviderElement> + with FetchPackagesRef { + _FetchPackagesProviderElement(super.provider); + + @override + int get page => (origin as FetchPackagesProvider).page; + @override + String get search => (origin as FetchPackagesProvider).search; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart new file mode 100644 index 000000000..131981f7b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart @@ -0,0 +1,27 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Package { + static Package fromJson(dynamic json) { + throw UnimplementedError(); + } +} + +/* SNIPPET START */ + +// Fetches the list of packages from pub.dev +final fetchPackagesProvider = FutureProvider.autoDispose + .family, ({int page, String? search})>((ref, params) async { + final page = params.page; + final search = params.search ?? ''; + final dio = Dio(); + // Fetch an API. Here we're using package:dio, but we could use anything else. + final response = await dio.get>( + 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', + ); + + // Decode the JSON response into a Dart class. + return response.data?.map(Package.fromJson).toList() ?? const []; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx index e577300ff..9bb15695c 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx @@ -1,11 +1,11 @@ --- -title: ^0.13.0 to ^0.14.0 +title: ^0.13.0에서 ^0.14.0 --- -With the release of version `0.14.0` of Riverpod, the syntax for using [StateNotifierProvider] changed -(see https://github.com/rrousselGit/riverpod/issues/341 for the explanation). +리버팟 `0.14.0` 버전이 출시되면서, [StateNotifierProvider] 사용 구문이 변경되었습니다. +(자세한 설명은 https://github.com/rrousselGit/riverpod/issues/341 참조) -For the entire article, consider the following [StateNotifier]: +전체 문서에 대해서는 다음 [StateNotifier]를 참조하세요: ```dart class MyModel {} @@ -15,12 +15,11 @@ class MyStateNotifier extends StateNotifier { } ``` -## The changes +## 변경사항 -- [StateNotifierProvider] takes an extra generic parameter, which should be - the type of the state of your [StateNotifier]. +- [StateNotifierProvider]는 추가 제네릭 매개변수(extra generic parameter)를 받는데, 이 매개변수는 [StateNotifier]의 상태 타입이어야 합니다. - Before: + 이전: ```dart final provider = StateNotifierProvider((ref) { @@ -28,7 +27,7 @@ class MyStateNotifier extends StateNotifier { }); ``` - After: + 변경후: ```dart final provider = StateNotifierProvider((ref) { @@ -36,9 +35,9 @@ class MyStateNotifier extends StateNotifier { }); ``` -- to obtain the [StateNotifier], you should now read `myProvider.notifier` instead of just `myProvider`: +- [StateNotifier]를 얻으려면, 이제 `myProvider`가 아닌 `myProvider.notifier`를 읽어야 합니다: - Before: + 이전: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -46,7 +45,7 @@ class MyStateNotifier extends StateNotifier { } ``` - After: + 변경후: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -54,9 +53,9 @@ class MyStateNotifier extends StateNotifier { } ``` -- to listen to the state of the [StateNotifier], you should now read `myProvider` instead of `myProvider.state`: +- [StateNotifier]의 상태를 수신(listen)하려면, 이제 `myProvider.state` 대신 `myProvider`를 읽어야 합니다: - Before: + 이전: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -64,7 +63,7 @@ class MyStateNotifier extends StateNotifier { } ``` - After: + 변경후: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -72,39 +71,38 @@ class MyStateNotifier extends StateNotifier { } ``` -## Using the migration tool to automatically upgrade your projects to the new syntax +## 마이그레이션 도구를 사용하여 프로젝트를 새 구문으로 자동 업그레이드하기 -With version 0.14.0 came the release of a command line tool for Riverpod, -which can help you migrate your projects. +버전 0.14.0에서는 프로젝트를 마이그레이션하는 데 도움이 되는 리버포드용 명령줄 도구가 출시되었습니다. -### Installing the command line +### 명령줄 설치하기 -To install the migration tool, run: +마이그레이션 도구를 설치하려면 다음을 실행합니다: ```sh dart pub global activate riverpod_cli ``` -You should now be able to run: +이제 실행할 수 있을 것입니다: ```sh riverpod --help ``` -### Usage +### 사용법 -Now that the command line is installed, we can start using it. +이제 명령줄이 설치되었으므로 사용을 시작할 수 있습니다. -- First, open the project you want to migrate in your terminal. -- **Do not** upgrade Riverpod. - The migration tool will upgrade the version of Riverpod for you. -- Make sure that your project does not contain errors. -- Execute: +- 먼저 터미널에서 마이그레이션하려는 프로젝트를 엽니다. +- **Do not** Riverpod을 업그레이드하지 마세요. + 마이그레이션 도구가 Riverpod의 버전을 업그레이드해 줍니다. +- 프로젝트에 오류가 없는지 확인합니다. +- 실행: ```sh riverpod migrate ``` -The tool will then analyze your project and suggest changes. For example you may see: +그러면 도구가 프로젝트를 분석하고 변경 사항을 제안합니다. 예를 들면 다음과 같습니다: ```diff Widget build(BuildContext context, ScopedReader watch) { @@ -115,8 +113,7 @@ Widget build(BuildContext context, ScopedReader watch) { Accept change (y = yes, n = no [default], A = yes to all, q = quit)? ``` -To accept the change, simply press y. Otherwise to reject it, press n. - +변경을 수락하려면 Y를 누르면 됩니다. 변경을 거부하려면 n을 누르세요. [statenotifierprovider]: ../providers/state_notifier_provider [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx index 480775da1..afe8533ef 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx @@ -1,53 +1,54 @@ --- -title: ^0.14.0 to ^1.0.0 +title: ^0.14.0에서 ^1.0.0 --- -After a long wait, the first stable version of Riverpod is finally released 👏 +import { Link } from "../../../../../src/components/Link"; -To see the full list of changes, consult the [Changelog](https://pub.dev/packages/flutter_riverpod/changelog#100). -In this page, we will focus on how to migrate an existing Riverpod application -from version 0.14.x to version 1.0.0. -## Using the migration tool to automatically upgrade your project to the new syntax +오랜 기다림 끝에 드디어 리버팟의 첫 번째 안정 버전이 출시되었습니다 👏. -Before explaining the various changes, it is worth noting that Riverpod comes with -a command-line tool to automatically migrate your project for you. +전체 변경 목록을 보려면 [변경 로그](https://pub.dev/packages/flutter_riverpod/changelog#100)를 참조하세요. +이 페이지에서는 기존 리버Riverpod드 애플리케이션을 버전 0.14.x에서 버전 1.0.0으로 마이그레이션하는 방법에 대해 중점적으로 설명합니다. -### Installing the command line tool +## 마이그레이션 도구를 사용하여 프로젝트를 새 구문으로 자동 업그레이드하기 -To install the migration tool, run: +다양한 변경 사항을 설명하기 전에, Riverpod에는 프로젝트를 자동으로 마이그레이션할 수 있는 명령줄 도구가 함께 제공된다는 점을 알아둘 필요가 있습니다. + +### 명령줄 도구 설치하기 + +마이그레이션 도구를 설치하려면 다음을 실행합니다: ```sh dart pub global activate riverpod_cli ``` -You should now be able to run: +이제 실행할 수 있을 것입니다: ```sh riverpod --help ``` -### Usage +### 사용법 -Now that the command line is installed, we can start using it. +이제 명령줄이 설치되었으므로 사용을 시작할 수 있습니다. -- First, open the project you want to migrate in your terminal. -- **Do not** upgrade Riverpod. - The migration tool will upgrade the version of Riverpod for you. +- 먼저 터미널에서 마이그레이션하려는 프로젝트를 엽니다. +- **Do not** Riverpod을 업그레이드하지 마세요. + 마이그레이션 도구가 Riverpod의 버전을 업그레이드해 줍니다. :::danger - Not upgrading Riverpod is important. - The tool will not execute properly if you have already installed version 1.0.0. - As such, make sure that you are properly using an older version before starting the tool. + Riverpod을 업그레이드하지 않는 것이 중요합니다. + 이미 버전 1.0.0을 설치한 경우 도구가 제대로 실행되지 않습니다. + 따라서 도구를 시작하기 전에 이전 버전을 제대로 사용하고 있는지 확인하세요. ::: -- Make sure that your project does not contain errors. -- Execute: +- 프로젝트에 오류가 없는지 확인합니다. +- 실행: ```sh riverpod migrate ``` -The tool will then analyze your project and suggest changes. For example you may see: +그러면 도구가 프로젝트를 분석하고 변경 사항을 제안합니다. 예를 들면 다음과 같습니다: ```diff -Widget build(BuildContext context, ScopedReader watch) { @@ -59,26 +60,23 @@ The tool will then analyze your project and suggest changes. For example you may Accept change (y = yes, n = no [default], A = yes to all, q = quit)? ``` -To accept the change, simply press y. Otherwise to reject it, press n. +변경을 수락하려면 Y를 누르면 됩니다. 변경을 거부하려면 n을 누르세요. -## The changes +## 변경사항 -Now that we've seen how to use the CLI to automatically upgrade your project, -let's see in detail the changes necessary. +이제 CLI를 사용하여 프로젝트를 자동으로 업그레이드하는 방법을 살펴봤으니 필요한 변경 사항을 자세히 살펴봅시다. -### Syntax unification +### 구문(Syntax) 통합 -Version 1.0.0 of Riverpod focused on the unification of the syntax for -interacting with providers. -Before, Riverpod had many similar yet different syntaxes for reading a provider, -such as `ref.watch(provider)` vs `useProvider(provider)` vs `watch(provider)`. -With version 1.0.0, only one syntax remains: `ref.watch(provider)`. The -others were removed. +리버포드 버전 1.0.0은 providers와 상호작용하기 위한 구문을 통합하는 데 중점을 두었습니다. +이전에는 `ref.watch(provider)` 대 `useProvider(provider)` 대 `watch(provider)`와 같이 provider를 읽는 구문이 비슷하지만 서로 다른 구문이 많았습니다. +버전 1.0.0에서는 구문이 하나만 남았습니다: ref.watch(provider)`. 나머지는 제거되었습니다. -As such: +따라서: -- `useProvider` is removed in favor of `HookConsumerWidget`. - Before: +- `useProvider`가 제거되고 `HookConsumerWidget`이 대신 사용됩니다. + + 이전: ```dart class Example extends HookWidget { @@ -91,7 +89,7 @@ As such: } ``` - After: + 변경후: ```dart class Example extends HookConsumerWidget { @@ -104,8 +102,9 @@ As such: } ``` -- The prototype of `ConsumerWidget`'s `build` and `Consumer`'s `builder` changed. - Before: +- `ConsumerWidget`의 `build` 와 `Consumer`의 `builder`의 프로토타입이 변경되었습니다. + + 이전: ```dart class Example extends ConsumerWidget { @@ -124,7 +123,7 @@ As such: ) ``` - After: + 변경후: ```dart class Example extends ConsumerWidget { @@ -143,8 +142,9 @@ As such: ) ``` -- `context.read` is removed in favor of `ref.read`. - Before: +- `context.read`가 `ref.read`로 대체되어 제거됩니다. + + 이전: ```dart class Example extends StatelessWidget { @@ -157,7 +157,7 @@ As such: } ``` - After: + 변경후: ```dart class Example extends ConsumerWidget { @@ -170,15 +170,15 @@ As such: } ``` -### StateProvider update +### StateProvider 업데이트 -[StateProvider] was updated to match [StateNotifierProvider]. +[StateProvider]가 [StateNotifierProvider]와 일치하도록 업데이트 되었습니다. -Before, doing `ref.watch(StateProvider)` returned a `StateController` instance. -Now it only returns the state of the `StateController`. +이전에는 `ref.watch(StateProvider)`를 실행하면 `StateController` 인스턴스가 반환되었습니다. +이제 `StateController`의 상태만 반환합니다. -To migrate you have a few solutions. -If your code only obtained the state without modifying it, you can change from: +마이그레이션을 위한 몇 가지 솔루션이 있습니다. +코드를 수정하지 않고 상태만 가져온 경우 다음에서 변경할 수 있습니다: ```dart final provider = StateProvider(...); @@ -192,7 +192,7 @@ Consumer( ) ``` -to: +에서 다음과 같이: ```dart final provider = StateProvider(...); @@ -206,7 +206,7 @@ Consumer( ) ``` -Alternatively you can use the new `StateProvider.state` to keep the old behavior. +또는 새로운 `StateProvider.state`를 사용하여 이전 동작을 유지할 수 있습니다. ```dart final provider = StateProvider(...); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx new file mode 100644 index 000000000..cc6683e73 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx @@ -0,0 +1,117 @@ +--- +title: "`ChangeNotifier`에서" +--- + +import old from "!!raw-loader!./from_change_notifier/old.dart"; +import declaration from "./from_change_notifier/declaration"; +import initialization from "./from_change_notifier/initialization"; +import migrated from "./from_change_notifier/migrated"; + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +Riverpod 내에서 `ChangeNotifierProvider`는 pkg:provider에서 원활한 전환을 제공하는 데 사용됩니다. + +이제 막 pkg:riverpod로 마이그레이션을 시작한 경우 전용 가이드를 읽어보세요( 참조). +이 글은 이미 Riverpod로 마이그레이션했지만 `ChangeNotifier`에서 완전히 벗어나고 싶은 분들을 위한 글입니다. + +대체로 `ChangeNotifier`에서 `AsyncNotifer`로 마이그레이션하려면 패러다임의 전환이 필요하지만, 마이그레이션된 코드를 통해 크게 간소화할 수 있습니다. +도 참조하세요. + +이 (잘못된) 예를 들어보겠습니다: + + +이 구현은 다음과 같은 몇 가지 잘못된 디자인 선택을 보여줍니다: +- 다양한 비동기 케이스를 처리하기 위해 `isLoading`과 `hasError`를 사용함. +- 지루한 `try`/`catch`/`finally` 표현식으로 요청을 신중하게 처리해야 합니다. +- 이 구현이 작동하도록 하기 위해 적시에 `notifyListeners`를 삽입해야 할 필요성 +- 일관성이 없거나 바람직하지 않은 상태(예: 빈 리스트로 초기화)가 존재할 수 있습니다. + +이 예제는 `ChangeNotifier`가 초보 개발자에게 어떻게 잘못된 디자인 선택으로 이어질 수 있는지 보여주기 위해 만들어졌습니다; +또한 변경 가능한 상태가 처음에 약속한 것보다 훨씬 더 어려울 수 있다는 점도 알아두세요. + +`Notifier`/`AsyncNotifer`를 불변 상태(immutable state)와 함께 사용하면 더 나은 디자인 선택과 오류 감소로 이어질 수 있습니다. + +위의 스니펫을 한 번에 한 단계씩 최신 API로 마이그레이션하는 방법을 살펴보겠습니다. + +## 마이그레이셔 시작 +먼저 새 provider / notifier를 선언해야 합니다. 여기에는 고유한 비즈니스 로직에 따라 몇 가지 사고 과정이 필요합니다. + +위의 요구 사항을 요약해 보겠습니다: +- 상태(state)는 매개 변수(parameters) 없이 네트워크 호출을 통해 얻은 `List`로 표현됩니다. +- 상태는 `loading`, `error` 및 `data` 상태에 대한 정보를 *또한* 노출해야 합니다. +- State는 노출된 일부 메서드를 통해 변경될 수 있으므로 함수만으로는 충분하지 않습니다. + +:::tip +위의 사고 과정은 다음 질문에 답하는 것으로 요약됩니다: +1. 부가작업(side effects)이 필요한가? + - `y`: Riverpod의 클래스 기반 API 사용 + - `n`: Riverpod의 함수 기반 API 사용 +2. 상태를 비동기적으로 로드해야 하나요? + - `y`: `build`가 `Future`를 반환하도록 합니다. + - `n`: `build`가 단순히 `T`를 반환하도록 합니다. +3. 몇 가지 매개변수가 필요한가요? + - `y`: `build`(또는 함수)가 매개 변수를 받아들이도록 합니다. + - `n`: `build`(또는 함수)가 추가 매개변수를 받지 않도록 합니다. +::: + +:::info +코드생성을 사용한다면 위의 생각 과정만으로도 충분합니다. +올바른 클래스 이름과 해당 클래스의 *특정* API에 대해 생각할 필요가 없습니다. +`@riverpod`는 반환 유형이 있는 클래스를 작성하기만 하면 됩니다. +::: + +기술적으로 가장 적합한 방법은 위의 모든 요구 사항을 충족하는 `AutoDisposeAsyncNotifier>`를 정의하는 것입니다. +먼저 의사 코드를 작성해 봅시다. + + + +:::tip +기억하세요: IDE에서 스니펫을 사용하여 지침을 얻거나 코드 작성 속도를 높이세요. +를 참조하세요. +::: + +`ChangeNotifier`의 구현과 관련해서는 더 이상 `todos`를 선언할 필요가 없습니다; +이러한 변수는 `state`이며, `build`와 함께 암시적으로 로드됩니다. + +실제로 Riverpod의 노티파이어는 한 번에 *하나의* 엔티티를 노출할 수 있습니다. + +:::tip +Riverpod의 API는 세분화되어 있지만, 마이그레이션할 때 여러 값을 보유하도록 사용자 정의 엔티티를 정의할 수 있습니다. +처음에는 마이그레이션을 원활하게 하기 위해 [Dart 3's records](https://dart.dev/language/records)를 사용하는 것이 좋습니다. +::: + + +### 초기화 +`build` 안에 초기화 로직을 작성하기만 하면 notifier를 쉽게 초기화할 수 있습니다. +이제 이전 `_init` 함수를 제거할 수 있습니다. + + + +기존 `_init`과 관련하여, 새로운 `build`에서는 더 이상 `isLoading` 또는 `hasError`와 같은 변수를 초기화할 필요가 없습니다. + +Riverpod `AsyncValue>` 노출을 통해 모든 비동기 provider를 자동으로 변환하며, +두 개의 단순한 boolean 플래그가 할 수 있는 것보다 비동기 상태의 복잡성을 훨씬 더 잘 처리합니다. + +실제로 `AsyncNotifier`를 사용하면 비동기 상태를 처리하기 위해 추가 `try`/`catch`/`finally`를 작성하는 것이 사실상 안티 패턴이 됩니다. + +### 변이 및 부가작업(Mutations and Side Effects) +초기화와 마찬가지로 부가작업을 수행할 때 `hasError`와 같은 boolean 플래그를 조작하거나 `try`/`catch`/`finally` 블록을 추가로 작성할 필요가 없습니다. + +아래에서는 모든 상용구를 줄이고 위의 예제를 성공적으로 완전히 마이그레이션했습니다: + + +:::tip +구문과 디자인 선택은 다를 수 있지만 결국에는 요청을 작성하고 나중에 상태를 업데이트하기만 하면 됩니다. +를 참조하세요. +::: + +## 마이그레이션 프로세스 요약 + +위에서 적용한 전체 마이그레이션 프로세스를 운영 관점에서 검토해 보겠습니다. + +1. 초기화를 생성자에서 호출되는 사용자 정의 메서드에서 `build`로 옮겼습니다. +2. `todos`, `isLoading`, `hasError` 프로퍼티를 제거했습니다: 내부 `state`로 충분합니다. +3. `try`-`catch`-`finally` 블록을 제거했습니다: futures를 반환하는 것으로 충분합니다. +4. 부가작업(`addTodo`)에도 동일한 단순화를 적용했습니다. +5. 단순히 `state` 재할당을 통해 변형을 적용했습니다. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart new file mode 100644 index 000000000..b3ca06ef2 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart @@ -0,0 +1,33 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'declaration.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() { + // TODO ... + return []; + } + + Future addTodo(Todo todo) async { + // TODO + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart new file mode 100644 index 000000000..317354e31 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'declaration.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'fc9a07f8ef9f792da2ac660d76ea0a809335ba18'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeAsyncNotifierProvider>.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx new file mode 100644 index 000000000..1ad659c31 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./declaration.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart new file mode 100644 index 000000000..c7485bbba --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart @@ -0,0 +1,33 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends AutoDisposeAsyncNotifier> { + @override + FutureOr> build() { + // TODO ... + return []; + } + + Future addTodo(Todo todo) async { + // TODO + } +} + +final myNotifierProvider = AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx new file mode 100644 index 000000000..3b3fbd2cb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./initialization.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart new file mode 100644 index 000000000..4da805e13 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart @@ -0,0 +1,29 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'initialization.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + return [...json.map(Todo.fromJson)]; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart new file mode 100644 index 000000000..376ce998f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'initialization.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'1c67c12443102cf8c43efbf6c630d3028d9847c3'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeAsyncNotifierProvider>.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart new file mode 100644 index 000000000..24ab265f7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart @@ -0,0 +1,29 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends AutoDisposeAsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + return [...json.map(Todo.fromJson)]; + } +} + +final myNotifierProvider = AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx new file mode 100644 index 000000000..075bfbdf5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./migrated.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart new file mode 100644 index 000000000..b8f4ba829 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart @@ -0,0 +1,37 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'migrated.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + Future addTodo(Todo todo) async { + // optional: state = const AsyncLoading(); + final json = await http.post('api/todos'); + final newTodos = [...json.map(Todo.fromJson)]; + state = AsyncData(newTodos); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart new file mode 100644 index 000000000..8eaddcfd9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'migrated.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'bde95c56aa12eff7c8c01ede57ae4ad2b616c225'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeAsyncNotifierProvider>.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart new file mode 100644 index 000000000..8572db71d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart @@ -0,0 +1,37 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends AutoDisposeAsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + Future addTodo(Todo todo) async { + // optional: state = const AsyncLoading(); + final json = await http.post('api/todos'); + final newTodos = [...json.map(Todo.fromJson)]; + state = AsyncData(newTodos); + } +} + +final myNotifierProvider = AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart new file mode 100644 index 000000000..4e65e823d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart @@ -0,0 +1,60 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyChangeNotifier extends ChangeNotifier { + MyChangeNotifier() { + _init(); + } + List todos = []; + bool isLoading = true; + bool hasError = false; + + Future _init() async { + try { + final json = await http.get('api/todos'); + todos = [...json.map(Todo.fromJson)]; + } on Exception { + hasError = true; + } finally { + isLoading = false; + notifyListeners(); + } + } + + Future addTodo(int id) async { + isLoading = true; + notifyListeners(); + + try { + final json = await http.post('api/todos'); + todos = [...json.map(Todo.fromJson)]; + hasError = false; + } on Exception { + hasError = true; + } finally { + isLoading = false; + notifyListeners(); + } + } +} + +final myChangeProvider = ChangeNotifierProvider((ref) { + return MyChangeNotifier(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx new file mode 100644 index 000000000..881d10bb4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx @@ -0,0 +1,243 @@ +--- +title: "`StateNotifier`에서" +--- + +import buildInit from "./from_state_notifier/build_init"; +import buildInitOld from "!!raw-loader!./from_state_notifier/build_init_old.dart"; +import consumersDontChange from "!!raw-loader!./from_state_notifier/consumers_dont_change.dart"; +import familyAndDispose from "./from_state_notifier/family_and_dispose"; +import familyAndDisposeOld from "!!raw-loader!./from_state_notifier/family_and_dispose_old.dart"; +import asyncNotifier from "./from_state_notifier/async_notifier"; +import asyncNotifierOld from "!!raw-loader!./from_state_notifier/async_notifier_old.dart"; +import addListener from "./from_state_notifier/add_listener"; +import addListenerOld from "!!raw-loader!./from_state_notifier/add_listener_old.dart"; +import fromStateProvider from "./from_state_notifier/from_state_provider"; +import fromStateProviderOld from "!!raw-loader!./from_state_notifier/from_state_provider_old.dart"; +import oldLifecycles from "./from_state_notifier/old_lifecycles"; +import oldLifecyclesOld from "!!raw-loader!./from_state_notifier/old_lifecycles_old.dart"; +import oldLifecyclesFinal from "./from_state_notifier/old_lifecycles_final"; +import obtainNotifierOnTests from "!!raw-loader!./from_state_notifier/obtain_notifier_on_tests.dart"; + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +[Riverpod 2.0](https://pub.dev/packages/flutter_riverpod/changelog#200)과 함께 새로운 클래스가 도입되었습니다: `Notifier` / `AsyncNotifer`. +이제 이러한 새로운 API를 위해 `StateNotifier`는 더 이상 사용되지 않습니다. + +이 페이지는 더 이상 사용되지 않는 `StateNotifier`에서 새로운 API로 마이그레이션하는 방법을 보여줍니다. + +`AsyncNotifier`가 도입한 주요 이점은 더 나은 `async` 지원입니다, +실제로 `AsyncNotifier`는 UI에서 수정할 수 있는 방법을 노출하는 `FutureProvider`로 생각할 수 있습니다. + +또한, 새로운 `(Async)Notifier`가 추가되었습니다: + +- 클래스 내부에 `Ref` 객체 노출하기 +- 코드 생성 방식(codegen)과 비코드 생성 방식(non-codegen) 간에 유사한 문법 제공 +- 동기화 버전과 비동기 버전 간에 유사한 문법 제공 +- 로직을 provider에서 벗어나 Notifiers 자체로 중앙 집중화하기 + +`Notifier`를 정의하는 방법, `StateNotifier`와 비교하는 방법, 비동기 상태를 위해 새로운 `AsyncNotifier`를 마이그레이션하는 방법을 살펴봅시다. + +## 새로운 문법 비교 + +이 비교를 시작하기 전에 `Notifier`을 정의하는 방법을 알아두세요. +를 참고하세요. + +이전 `StateNotifier` 문법을 사용하여 예제를 작성해 보겠습니다: + + +다음은 새로운 `Notifier` API로 작성된 동일한 예시이며, 대략 다음과 같이 변환됩니다: + + +`Notifier`와 `StateNotifier`를 비교하면 다음과 같은 주요 차이점을 확인할 수 있습니다: + +- `StateNotifier`의 반응형 종속성(reactive dependencies)은 provider에서 선언되는 반면, `Notifier`는 이 로직을 `build` 메서드에서 중앙 집중화합니다. +- `StateNotifier`의 전체 초기화 프로세스는 provider와 생성자 사이에 분할되어 있는 반면, `Notifier`는 이러한 로직을 배치할 수 있는 단일 위치를 예약합니다. +- `StateNotifier`와는 반대로, `Notifier`의 생성자에는 어떠한 로직도 작성되지 않는 것을 주목하세요. + +`Notifier`의 비동기 대응 클래스인 `AsyncNotifer`에서도 비슷한 점을 발견할 수 있습니다. + +## 비동기 `StateNotifier` 마이그레이션하기 + +새로운 API 구문의 가장 큰 장점은 비동기 데이터에 대한 향상된 DX입니다. +다음 예시를 살펴보겠습니다: + + + +다음은 새로운 `AsyncNotifier` API를 사용하여 재작성된 위의 예시입니다: + + + +`AsyncNotifier`는 `Notifier`와 마찬가지로 더 간단하고 통일된 API를 제공합니다. +여기서 `AsyncNotifier`는 메서드가 있는 `FutureProvider`로 쉽게 볼 수 있습니다. + +`AsyncNotifer`에는 `StateNotifier`에는 없는 유틸리티와 게터가 함께 제공됩니다, +예를 들어 [`future`](https://pub.dev/documentation/riverpod/latest/riverpod/AutoDisposeAsyncNotifier/future.html) +및 [`update`](https://pub.dev/documentation/riverpod/latest/riverpod/AutoDisposeAsyncNotifier/update.html). +이를 통해 비동기 변이(mutations)와 부수작업(side-effects)을 처리할 때 훨씬 더 간단한 로직을 작성할 수 있습니다. +를 참고하세요. + +:::tip +`StateNotifier>`에서 `AsyncNotifer`로 마이그레이션하는 방법은 다음과 같습니다: + +- 초기화 로직을 `build`에 넣기 +- 초기화 또는 부수작업 메서드에서 `catch`/`try` 블록을 제거합니다. +- `build`에서 `AsyncValue.guard`를 제거합니다. `Future`를 `AsyncValue`로 변환하기 때문입니다. +::: + +### 장점 + +이 몇 가지 예시를 살펴본 후, 이제 `Notifier` 와 `AsyncNotifer`의 주요 장점을 살펴보겠습니다: +- 새로운 구문은 특히 비동기 상태의 경우 훨씬 더 간단하고 가독성이 높아질 것입니다. +- 새로운 API에는 일반적으로 상용구 코드가 줄어들 가능성이 높습니다. +- 이제 작성하는 provider 타입에 관계없이 구문이 통합되어 코드 생성이 가능해졌습니다. +( 참조). + +더 자세히 살펴보고 더 많은 차이점과 유사점을 강조해 보겠습니다. + +## 명시적인 `.family` 및 `.autoDispose` 수정사항 + +또 다른 중요한 차이점은 새로운 API로 패밀리 및 자동폐기가 처리되는 방식입니다. + +`Notifier`에는 `FamilyNotifier` 및 `AutoDisposeNotifier`와 같은 자체 `.family` 및 `.autoDispose` 대응 항목이 있습니다. +항상 그렇듯이, 이러한 수정 사항을 결합할 수 있습니다 (일명 `AutoDisposeFamilyNotifier`). +`AsyncNotifer`에는 비동기 버전도 있습니다(예: `AutoDisposeFamilyAsyncNotifier`). + +수정 사항(Modifications)은 클래스 내부에 명시적으로 지정(stated)됩니다; +모든 매개변수는 `build` 메서드에 직접 주입되어 초기화 로직에서 사용할 수 있습니다. +이렇게 하면 가독성이 향상되고 간결해지며 전반적으로 실수가 줄어듭니다. + +다음 예제에서는 `StateNotifierProvider.family`를 정의하고 있습니다. + + +`BugsEncounteredNotifier`은 무겁거나 읽기 어려운 느낌입니다. +마이그레이션 된 `AsyncNotifier`를 살펴 보겠습니다: + + + +마이그레이션된 버전은 가볍게 읽을 수 있는 수준입니다. + +:::info +`(Async)Notifier`의 `.family` 매개변수는 `this.arg`(또는 코드생성을 사용하는 경우 `this.paramName`)를 통해 사용할 수 있습니다. +::: + +## 라이프사이클에 따라 동작 방식이 다릅니다. + +`Notifier`/`AsyncNotifier`와 `StateNotifier`의 수명 주기는 크게 다릅니다. + +이 예시는 이전 API의 로직이 얼마나 부족한지(sparse)를 다시 한 번 보여줍니다: + + + +여기서 `durationProvider`가 업데이트되면 `MyNotifier`를 _페기(dispose)_: 인스턴스가 다시 인스턴스화되고 내부 상태가 다시 초기화됩니다. +또한 다른 모든 provider와 달리 `dispose` 콜백은 클래스에서 별도로 정의해야 합니다. +마지막으로, _provider_에 `ref.onDispose`를 작성하는 것이 여전히 가능하기 때문에, 이 API의 로직이 얼마나 부족한지(sparse)를 다시 한 번 알 수 있습니다; +잠재적으로 개발자는 이 Notifier 동작을 이해하기 위해 여덟 곳(8개!)을 살펴봐야 할 수도 있습니다! + +이러한 모호함은 `Riverpod 2.0`을 통해 해결되었습니다. + +### 이전의 `dispose` vs `ref.onDispose` +`StateNotifier`의 `dispose` 메서드는 notifier 자체의 폐기(dispose) 이벤트를 참조하며, 일명 *자신을 처분하기 전에(before disposing of itself)* 호출되는 콜백입니다. + +`(Async)Notifier`은 이 속성을 갖지 않는데, *리빌드 시 폐기되지 않고* *내부 상태만 폐기*되기 때문입니다. +새로운 notifiers에서 폐기 수명주기는 다른 provider와 마찬가지로 `ref.onDispose`(및 기타)를 통해 _한_ 곳에서만 처리됩니다. +이렇게 하면 API와 DX가 단순화되어 라이프사이클 부작용을 이해하기 위해 살펴봐야 할 곳이 `build` 메서드 하나만 남게 됩니다. + +간단히 말해서, *내부 상태(internal state)*가 다시 빌드되기 전에 실행되는 콜백을 등록하려면 다른 모든 provider와 마찬가지로 `ref.onDispose`를 사용하면 됩니다. + +위의 스니펫을 다음과 같이 마이그레이션할 수 있습니다: + + + +이 마지막 스니펫에는 확실히 약간의 단순화가 있지만 여전히 열려 있는 문제가 있습니다: +이제 `update`를 수행하는 동안 notifiers가 아직 살아(alive)있는지 여부를 파악할 수 없습니다. +이로 인해 원치 않는 `StateError`가 발생할 수 있습니다. + +### 더 이상 `마운트되지(mounted)` 않음 +이는 `(Async)Notifier`에 `StateNotifier`에서 사용할 수 있는 `mounted` 프로퍼티가 없기 때문에 발생합니다. +수명 주기의 차이를 고려하면 이것은 완벽하게 이해가 됩니다; +가능하긴 하지만, 새로운 notifiers에서 `mounted` 프로퍼티는 오해의 소지가 있습니다: `mounted`는 거의 항상 `true`이 될 것입니다. + +[커스텀 해결방법](https://github.com/rrousselGit/riverpod/issues/1879#issuecomment-1303189191)을 만들 수는 있지만, +비동기 작업을 취소하여 이 문제를 해결하는 것이 좋습니다. + +작업 취소는 커스텀 [Completer](https://api.flutter.dev/flutter/dart-async/Completer-class.html) 또는 커스텀 파생어(derivative)를 사용하여 수행할 수 있습니다. + +예를 들어 `Dio`를 사용하여 네트워크 요청을 수행하는 경우 [cancel token](https://pub.dev/documentation/dio/latest/dio/CancelToken-class.html)을 사용하는 것이 좋습니다. +( 참고) + +따라서 위의 예는 다음과 같이 마이그레이션됩니다: + + +## 변이(Mutations) API는 이전과 동일합니다 + +지금까지 `StateNotifier`와 새로운 API의 차이점을 살펴보았습니다. +대신, `Notifier`, `AsyncNotifer`, `StateNotifier`가 공유하는 한 가지는 상태를 소비하고 변경할 수 있다는 점입니다. + +Consumers는 동일한 구문으로 이 세 공급자로부터 데이터를 얻을 수 있습니다, +이는 `StateNotifier`에서 마이그레이션하는 경우에 유용하며, 이는 notifiers 메서드에도 적용됩니다. + + + +## 기타 마이그레이션 + +`StateNotifier`와 `Notifier`(또는 `AsyncNotifier`)의 영향력이 크지 않은 차이점을 살펴봅시다. + +### `.addListener` 및 `.stream`에서 + +`StateNotifier`의 `.addListener`와 `.stream`은 상태 변경을 수신하는 데 사용할 수 있습니다. +이 두 API는 이제 오래된 것으로 간주됩니다. + +이는 `Notifier`, `AsyncNotifier` 및 기타 proviers와 완전한 API 통일성을 달성하기 위한 의도적인 것입니다. +실제로 `Notifier`나 `AsyncNotifier`를 사용하는 것은 다른 provier와 다르지 않아야 합니다. + +따라서 이 것이: + + +이렇게 됩니다: + + +간단히 말해, `Notifier`/`AsyncNotifer`를 수신하려면 `ref.listen`를 사용하면 됩니다. +를 참고하세요 + +### 테스트의 `.debugState`에서 + +`StateNotifier`는 `.debugState`를 노출합니다: +이 프로퍼티는 개발 모드에서 테스트 목적으로 클래스 외부에서 상태 액세스를 활성화하기 위해 pkg:state_notifier 사용자가 사용할 수 있습니다. + +테스트에서 상태에 액세스하기 위해 `.debugState`를 사용하는 경우 이 접근 방식을 중단해야 합니다. + +`Notifier` / `AsyncNotifer`에는 `.debugState`가 없으며, 대신 `.state`, 즉 `@visibleForTesting`을 직접 노출합니다. + +:::danger +AVOID 테스트에서 `.state`에 접근하지 마시고, 꼭 접근해야 한다면 `Notifier` / `AsyncNotifer`가 이미 제대로 인스턴스화된 경우에만 접근하세요; +그러면 테스트 내부에서 `.state`에 자유롭게 접근할 수 있습니다. + +실제로 `Notifier` / `AsyncNotifier`는 직접 인스턴스화해서는 안 됩니다; +대신 해당 provider를 사용해 상호작용해야 합니다: +그렇게 하지 않으면 notifier가 *중단(break)*됩니다, +ref와 family 인자가 초기화되지 않기 때문입니다. +::: + +`Notifier` 인스턴스가 없으신가요? +문제없습니다. 노출된 상태를 읽을 때와 마찬가지로 `ref.read`로 인스턴스를 가져올 수 있습니다: + + + +전용 가이드에서 테스트에 대해 자세히 알아보세요. 를 참고하세요. + +### `StateProvider`에서 + +`StateProvider`는 Riverpod에서 출시 이후 노출된 것으로, `StateNotifierProvider`의 간소화된 버전을 위해 몇 가지 LoC를 절약하기 위해 만들어졌습니다. +`StateNotifierProvider`는 더 이상 사용되지 않으므로 `StateProvider`도 피해야 합니다. +또한 현재는 새로운 API에 상응하는 `StateProvider`가 없습니다. + +그럼에도 불구하고 `StateProvider`에서 `Notifier`로 마이그레이션하는 것은 간단합니다. + +이 코드는: + + +이렇게 됩니다: + + +LoC가 몇 개 더 들더라도 `StateProvider`에서 마이그레이션하면 `StateNotifier`를 확실하게 보존(archive)할 수 있습니다. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart new file mode 100644 index 000000000..ead1c72d8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart @@ -0,0 +1,18 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'add_listener.g.dart'; + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + ref.listenSelf((_, next) => debugPrint('$next')); + return 0; + } + + void add() => state++; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart new file mode 100644 index 000000000..161b3bba0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'add_listener.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'9acd382ed579c545ace755687b155e28eba01d22'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx new file mode 100644 index 000000000..6d7ac6d37 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./add_listener.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart new file mode 100644 index 000000000..e25b4a181 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart @@ -0,0 +1,17 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + ref.listenSelf((_, next) => debugPrint('$next')); + return 0; + } + + void add() => state++; +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart new file mode 100644 index 000000000..4950216c6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart @@ -0,0 +1,24 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class MyNotifier extends StateNotifier { + MyNotifier() : super(0); + + void add() => state++; +} + +final myNotifierProvider = StateNotifierProvider((ref) { + final notifier = MyNotifier(); + + final cleanup = notifier.addListener((state) => debugPrint('$state')); + ref.onDispose(cleanup); + + // 또는, 이와 동일하게: + // final listener = notifier.stream.listen((event) => debugPrint('$event')); + // ref.onDispose(listener.cancel); + + return notifier; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart new file mode 100644 index 000000000..5ead76378 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_notifier.g.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class AsyncTodosNotifier extends _$AsyncTodosNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + // ... +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart new file mode 100644 index 000000000..25bcda60d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -0,0 +1,29 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$asyncTodosNotifierHash() => + r'10207327c7dee180e9da8beece5bfffedcf86e98'; + +/// See also [AsyncTodosNotifier]. +@ProviderFor(AsyncTodosNotifier) +final asyncTodosNotifierProvider = + AutoDisposeAsyncNotifierProvider>.internal( + AsyncTodosNotifier.new, + name: r'asyncTodosNotifierProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$asyncTodosNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$AsyncTodosNotifier = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx new file mode 100644 index 000000000..a0ff513c3 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./async_notifier.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart new file mode 100644 index 000000000..52da61d76 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart @@ -0,0 +1,29 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class AsyncTodosNotifier extends AsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + // ... +} + +final asyncTodosNotifier = AsyncNotifierProvider>( + AsyncTodosNotifier.new, +); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart new file mode 100644 index 000000000..50d7f4aed --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart @@ -0,0 +1,30 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class AsyncTodosNotifier extends StateNotifier>> { + AsyncTodosNotifier() : super(const AsyncLoading()) { + _postInit(); + } + + Future _postInit() async { + state = await AsyncValue.guard(() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + }); + } + + // ... +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart new file mode 100644 index 000000000..3e2303b7a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart @@ -0,0 +1,15 @@ +// ignore_for_file: avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'build_init.g.dart'; + +/* SNIPPET START */ +@riverpod +class CounterNotifier extends _$CounterNotifier { + @override + int build() => 0; + + void increment() => state++; + void decrement() => state++; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart new file mode 100644 index 000000000..6b4621ecb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart @@ -0,0 +1,28 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'build_init.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterNotifierHash() => r'8d4e4011da15a0ef79af9622336839a0c9e406ab'; + +/// See also [CounterNotifier]. +@ProviderFor(CounterNotifier) +final counterNotifierProvider = + AutoDisposeNotifierProvider.internal( + CounterNotifier.new, + name: r'counterNotifierProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$counterNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$CounterNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx new file mode 100644 index 000000000..276a143ac --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./build_init.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart new file mode 100644 index 000000000..0ba8eebed --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart @@ -0,0 +1,15 @@ +// ignore_for_file: avoid_print + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +class CounterNotifier extends Notifier { + @override + int build() => 0; + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = NotifierProvider(CounterNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart new file mode 100644 index 000000000..82a8c54bd --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart @@ -0,0 +1,13 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +class CounterNotifier extends StateNotifier { + CounterNotifier() : super(0); + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = StateNotifierProvider((ref) { + return CounterNotifier(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart new file mode 100644 index 000000000..6a964a5a6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart @@ -0,0 +1,36 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class CounterNotifier extends StateNotifier { + CounterNotifier() : super(0); + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = StateNotifierProvider((ref) { + return CounterNotifier(); +}); + +/* SNIPPET START */ +class SomeConsumer extends ConsumerWidget { + const SomeConsumer({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + /* highlight-start */ + final counter = ref.watch(counterNotifierProvider); + /* highlight-end */ + return Column( + children: [ + Text("You've counted up until $counter, good job!"), + TextButton( + /* highlight-start */ + onPressed: ref.read(counterNotifierProvider.notifier).increment, + /* highlight-end */ + child: const Text('Count even more!'), + ) + ], + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart new file mode 100644 index 000000000..9a695614c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'family_and_dispose.g.dart'; + +/* SNIPPET START */ +@riverpod +class BugsEncounteredNotifier extends _$BugsEncounteredNotifier { + @override + FutureOr build(String featureId) { + return 99; + } + + Future fix(int amount) async { + final old = await future; + final result = await ref.read(taskTrackerProvider).fix(id: this.featureId, fixed: amount); + state = AsyncData(max(old - result, 0)); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart new file mode 100644 index 000000000..cbcfb779b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -0,0 +1,219 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family_and_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$bugsEncounteredNotifierHash() => + r'c76e924f84db91c57d226896b062d9f4e8ab79e5'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +abstract class _$BugsEncounteredNotifier + extends BuildlessAutoDisposeAsyncNotifier { + late final String featureId; + + FutureOr build( + String featureId, + ); +} + +/// See also [BugsEncounteredNotifier]. +@ProviderFor(BugsEncounteredNotifier) +const bugsEncounteredNotifierProvider = BugsEncounteredNotifierFamily(); + +/// See also [BugsEncounteredNotifier]. +class BugsEncounteredNotifierFamily extends Family { + /// See also [BugsEncounteredNotifier]. + const BugsEncounteredNotifierFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'bugsEncounteredNotifierProvider'; + + /// See also [BugsEncounteredNotifier]. + BugsEncounteredNotifierProvider call( + String featureId, + ) { + return BugsEncounteredNotifierProvider( + featureId, + ); + } + + @visibleForOverriding + @override + BugsEncounteredNotifierProvider getProviderOverride( + covariant BugsEncounteredNotifierProvider provider, + ) { + return call( + provider.featureId, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(BugsEncounteredNotifier Function() create) { + return _$BugsEncounteredNotifierFamilyOverride(this, create); + } +} + +class _$BugsEncounteredNotifierFamilyOverride implements FamilyOverride { + _$BugsEncounteredNotifierFamilyOverride(this.overriddenFamily, this.create); + + final BugsEncounteredNotifier Function() create; + + @override + final BugsEncounteredNotifierFamily overriddenFamily; + + @override + BugsEncounteredNotifierProvider getProviderOverride( + covariant BugsEncounteredNotifierProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [BugsEncounteredNotifier]. +class BugsEncounteredNotifierProvider + extends AutoDisposeAsyncNotifierProviderImpl { + /// See also [BugsEncounteredNotifier]. + BugsEncounteredNotifierProvider( + String featureId, + ) : this._internal( + () => BugsEncounteredNotifier()..featureId = featureId, + from: bugsEncounteredNotifierProvider, + name: r'bugsEncounteredNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$bugsEncounteredNotifierHash, + dependencies: BugsEncounteredNotifierFamily._dependencies, + allTransitiveDependencies: + BugsEncounteredNotifierFamily._allTransitiveDependencies, + featureId: featureId, + ); + + BugsEncounteredNotifierProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.featureId, + }) : super.internal(); + + final String featureId; + + @override + FutureOr runNotifierBuild( + covariant BugsEncounteredNotifier notifier, + ) { + return notifier.build( + featureId, + ); + } + + @override + Override overrideWith(BugsEncounteredNotifier Function() create) { + return ProviderOverride( + origin: this, + override: BugsEncounteredNotifierProvider._internal( + () => create()..featureId = featureId, + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + featureId: featureId, + ), + ); + } + + @override + (String,) get argument { + return (featureId,); + } + + @override + AutoDisposeAsyncNotifierProviderElement + createElement() { + return _BugsEncounteredNotifierProviderElement(this); + } + + BugsEncounteredNotifierProvider _copyWith( + BugsEncounteredNotifier Function() create, + ) { + return BugsEncounteredNotifierProvider._internal( + () => create()..featureId = featureId, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + featureId: featureId, + ); + } + + @override + bool operator ==(Object other) { + return other is BugsEncounteredNotifierProvider && + other.featureId == featureId; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, featureId.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin BugsEncounteredNotifierRef on AutoDisposeAsyncNotifierProviderRef { + /// The parameter `featureId` of this provider. + String get featureId; +} + +class _BugsEncounteredNotifierProviderElement + extends AutoDisposeAsyncNotifierProviderElement with BugsEncounteredNotifierRef { + _BugsEncounteredNotifierProviderElement(super.provider); + + @override + String get featureId => (origin as BugsEncounteredNotifierProvider).featureId; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx new file mode 100644 index 000000000..0780f2135 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./family_and_dispose.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart new file mode 100644 index 000000000..8dfce9447 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart @@ -0,0 +1,27 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +/* SNIPPET START */ +class BugsEncounteredNotifier extends AutoDisposeFamilyAsyncNotifier { + @override + FutureOr build(String featureId) { + return 99; + } + + Future fix(int amount) async { + final old = await future; + final result = await ref.read(taskTrackerProvider).fix(id: this.arg, fixed: amount); + state = AsyncData(max(old - result, 0)); + } +} + +final bugsEncounteredNotifierProvider = + AsyncNotifierProvider.family.autoDispose( + BugsEncounteredNotifier.new, +); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart new file mode 100644 index 000000000..28f93a65c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart @@ -0,0 +1,30 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../utils.dart'; + +/* SNIPPET START */ +class BugsEncounteredNotifier extends StateNotifier> { + BugsEncounteredNotifier({ + required this.ref, + required this.featureId, + }) : super(const AsyncData(99)); + final String featureId; + final Ref ref; + + Future fix(int amount) async { + state = await AsyncValue.guard(() async { + final old = state.requireValue; + final result = await ref.read(taskTrackerProvider).fix(id: featureId, fixed: amount); + return max(old - result, 0); + }); + } +} + +final bugsEncounteredNotifierProvider = + StateNotifierProvider.family.autoDispose((ref, id) { + return BugsEncounteredNotifier(ref: ref, featureId: id); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart new file mode 100644 index 000000000..2c71d6144 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'from_state_provider.g.dart'; + +/* SNIPPET START */ +@riverpod +class CounterNotifier extends _$CounterNotifier { + @override + int build() => 0; + + @override + set state(int newState) => super.state = newState; + int update(int Function(int state) cb) => state = cb(state); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart new file mode 100644 index 000000000..9a3edeebc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -0,0 +1,28 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'from_state_provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterNotifierHash() => r'b32033040f0fff627f1a6dfd9cfb4e93a842390b'; + +/// See also [CounterNotifier]. +@ProviderFor(CounterNotifier) +final counterNotifierProvider = + AutoDisposeNotifierProvider.internal( + CounterNotifier.new, + name: r'counterNotifierProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$counterNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$CounterNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx new file mode 100644 index 000000000..f59794999 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./from_state_provider.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart new file mode 100644 index 000000000..97e4564f3 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart @@ -0,0 +1,13 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +class CounterNotifier extends Notifier { + @override + int build() => 0; + + @override + set state(int newState) => super.state = newState; + int update(int Function(int state) cb) => state = cb(state); +} + +final counterNotifierProvider = NotifierProvider(CounterNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart new file mode 100644 index 000000000..246f44a0c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart @@ -0,0 +1,6 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +final counterProvider = StateProvider((ref) { + return 0; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart new file mode 100644 index 000000000..1627be9e7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart @@ -0,0 +1,33 @@ +// ignore_for_file: unused_local_variable,omit_local_variable_types + +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class MyNotifier extends AutoDisposeNotifier { + @override + int build() { + return 0; + } +} + +final myNotifierProvider = NotifierProvider.autoDispose(MyNotifier.new); + +/* SNIPPET START */ +void main(List args) { + test('my test', () { + final container = ProviderContainer(); + addTearDown(container.dispose); + + // notifier 획득 + /* highlight-start */ + final AutoDisposeNotifier notifier = container.read(myNotifierProvider.notifier); + /* highlight-end */ + + // 거기서 노출되는 상태 획득 + /* highlight-start */ + final int state = container.read(myNotifierProvider); + /* highlight-end */ + + // TODO write your tests + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx new file mode 100644 index 000000000..9b77f551a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./old_lifecycles.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart new file mode 100644 index 000000000..ffeed1c3e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart @@ -0,0 +1,36 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'old_lifecycles.g.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // 한 곳에서 코드를 읽고 쓰면 됩니다. + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); + // `mounted`는 더 이상 없습니다! + state++; //throw 될 수 있습니다 + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart new file mode 100644 index 000000000..d28e242a3 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'old_lifecycles.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'0495c52ce893ee0304d4d5ac5648c634ed4a241e'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart new file mode 100644 index 000000000..691d71af9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart @@ -0,0 +1,35 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + // Just read/write the code here, in one place + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); + // `mounted` is no more! + state++; // This might throw. + } +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx new file mode 100644 index 000000000..9823b1564 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./old_lifecycles_final.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart new file mode 100644 index 000000000..798fce7d8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart @@ -0,0 +1,38 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'old_lifecycles_final.g.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // 한 곳에서 코드를 읽고 쓰면 됩니다. + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + final cancelToken = CancelToken(); + ref.onDispose(cancelToken.cancel); + await ref.read(repositoryProvider).update(state + 1, token: cancelToken); + // `cancelToken.cancel`이 호출되면 커스텀 예외가 발생합니다. + state++; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart new file mode 100644 index 000000000..7c55609e1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'old_lifecycles_final.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'8ea2586ea29d12306efd4b8b847142136dd20338'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart new file mode 100644 index 000000000..94814a191 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart @@ -0,0 +1,36 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + // Just read/write the code here, in one place + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + final cancelToken = CancelToken(); + ref.onDispose(cancelToken.cancel); + await ref.read(repositoryProvider).update(state + 1, token: cancelToken); + state++; + } +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart new file mode 100644 index 000000000..717637c81 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart @@ -0,0 +1,42 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends StateNotifier { + MyNotifier(this.ref, this.period) : super(0) { + // 1 초기화로직 + _timer = Timer.periodic(period, (t) => update()); // 2 초기화시 부가작업 + } + final Duration period; + final Ref ref; + late final Timer _timer; + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); // 3 변이(mutation) + if (mounted) state++; // 4 마운트된 속성 확인 + } + + @override + void dispose() { + _timer.cancel(); // 5 커스텀 폐기(dispose) 로직 + super.dispose(); + } +} + +final myNotifierProvider = StateNotifierProvider((ref) { + // 6 provider 정의 + final period = ref.watch(durationProvider); // 7 리액티브 종속성 로직 + return MyNotifier(ref, period); // 8 `ref`로 연결(pipe down) +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.dart new file mode 100644 index 000000000..e515b6f94 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.dart @@ -0,0 +1,23 @@ +import 'dart:math' as math; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +final randomProvider = Provider((ref) { + return math.Random().nextInt(6); +}); + +final taskTrackerProvider = Provider((ref) { + return TaskTrackerRepo(); +}); + +class TaskTrackerRepo { + Future fix({required String id, required int fixed}) async => 0; +} + +final durationProvider = Provider((ref) { + return Duration.zero; +}); + +final availableWaterProvider = Provider((ref) { + return 40; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx index bedca4e7f..5143f6f51 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx @@ -2,13 +2,17 @@ title: ChangeNotifierProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import todos from "!!raw-loader!/docs/providers/change_notifier_provider/todos.dart"; import todosConsumer from "!!raw-loader!/docs/providers/change_notifier_provider/todos_consumer.dart"; import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + `ChangeNotifierProvider` (flutter_riverpod/hooks_riverpod only) is a provider that is used to listen to and expose a [ChangeNotifier] from Flutter itself. @@ -18,7 +22,7 @@ Using `ChangeNotifierProvider` is discouraged by Riverpod and exists primarily f - supporting mutable state, even though immutable state is preferred :::info -Prefer using [StateNotifierProvider] instead. +Prefer using [NotifierProvider] instead. Consider using `ChangeNotifierProvider` only if you are absolutely certain that you want mutable state. ::: @@ -45,6 +49,7 @@ with the list of todos in our UI: [state_notifier]: https://pub.dev/packages/state_notifier [statenotifierprovider]: ./state_notifier_provider -[changenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/ChangeNotifier-class.html +[notifierprovider]: ./notifier_provider +[changenotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html [provider]: ./provider [futureprovider]: ./future_provider diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart index c181f8fd7..d766920b1 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart @@ -32,16 +32,13 @@ class TodosNotifier extends ChangeNotifier { // Let's mark a todo as completed void toggle(String todoId) { - for (final todo in todos) { - if (todo.id == todoId) { - todo.completed = !todo.completed; - notifyListeners(); - } - } + final todo = todos.firstWhere((todo) => todo.id == todoId); + todo.completed = !todo.completed; + notifyListeners(); } } -// Finally, we are using StateNotifierProvider to allow the UI to interact with +// Finally, we are using ChangeNotifierProvider to allow the UI to interact with // our TodosNotifier class. final todosProvider = ChangeNotifierProvider((ref) { return TodosNotifier(); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider.mdx index 934452c51..6f114320a 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider.mdx @@ -3,12 +3,15 @@ title: FutureProvider version: 1 --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import configProvider from "/docs/providers/future_provider/config_provider"; -import configConsumer from "/docs/providers/future_provider/config_consumer"; -import { trimSnippet,AutoSnippet } from "../../../../../src/components/CodeSnippet"; +import configProvider from "./future_provider/config_provider"; +import configConsumer from "./future_provider/config_consumer"; +import { AutoSnippet} from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: `FutureProvider` is the equivalent of [Provider] but for asynchronous code. @@ -25,7 +28,7 @@ ensuring that we always have the most up-to-date value. :::info `FutureProvider` does not offer a way of directly modifying the computation after a user interaction. It is designed to solve simple use-cases. -For more advanced scenarios, consider using [StateNotifierProvider]. +For more advanced scenarios, consider using [AsyncNotifierProvider]. ::: ## Usage example: reading a configuration file @@ -39,6 +42,7 @@ Using Flutter's asset system, this would be: + Then, the UI can listen to configurations like so: @@ -51,7 +55,7 @@ As you can see, listening to a `FutureProvider` inside a widget returns an [AsyncValue] – which allows handling the error/loading states. [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider -[statenotifierprovider]: ./state_notifier_provider +[asyncnotifierprovider]: ./notifier_provider [provider]: ./provider [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html [future]: https://api.dart.dev/dart-async/Future-class.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart index 7f8e854f2..a96f35e72 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart @@ -3,17 +3,14 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import '../config_provider/codegen.dart'; - /* SNIPPET START */ Widget build(BuildContext context, WidgetRef ref) { final config = ref.watch(fetchConfigurationProvider); - return config.when( - loading: () => const CircularProgressIndicator(), - error: (err, stack) => Text('Error: $err'), - data: (config) { - return Text(config.host); - }, - ); + return switch (config) { + AsyncError(:final error) => Text('Error: $error'), + AsyncData(:final value) => Text(value.host), + _ => const CircularProgressIndicator(), + }; } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart index 3f9e2231c..44d9b4df9 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart @@ -11,12 +11,11 @@ class MyConfiguration extends HookConsumerWidget { Widget build(BuildContext context, WidgetRef ref) { final config = ref.watch(configProvider); return Scaffold( - body: config.when( - loading: () => const Center(child: CircularProgressIndicator()), - error: (err, stack) => Center(child: Text('Error: $err')), - data: (config) { - return Center(child: Text(config.host)); + body: switch (config) { + AsyncError(:final error) => Center(child: Text('Error: $error')), + AsyncData(:final value) => Center(child: Text(value.host)), + _ => const Center(child: CircularProgressIndicator()), }, - )); + ); } } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart index ece077f72..ade0628fd 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart @@ -3,23 +3,20 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import '../config_provider/codegen.dart'; - - /* SNIPPET START */ -class MyConfiguration extends HookConsumerWidget { +class MyConfiguration extends HookConsumerWidget { const MyConfiguration({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { final config = ref.watch(fetchConfigurationProvider); return Scaffold( - body: config.when( - loading: () => const Center(child: CircularProgressIndicator()), - error: (err, stack) => Center(child: Text('Error: $err')), - data: (config) { - return Center(child: Text(config.host)); + body: switch (config) { + AsyncError(:final error) => Center(child: Text('Error: $error')), + AsyncData(:final value) => Center(child: Text(value.host)), + _ => const Center(child: CircularProgressIndicator()), }, - )); + ); } -} \ No newline at end of file +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart index 4176a3866..9d39f3bcd 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart @@ -10,11 +10,9 @@ import '../config_provider/raw.dart'; Widget build(BuildContext context, WidgetRef ref) { AsyncValue config = ref.watch(configProvider); - return config.when( - loading: () => const CircularProgressIndicator(), - error: (err, stack) => Text('Error: $err'), - data: (config) { - return Text(config.host); - }, - ); + return switch (config) { + AsyncData(:final value) => Text(value.host), + AsyncError(:final error) => Text('Error: $error'), + _ => const CircularProgressIndicator(), + }; } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx new file mode 100644 index 000000000..4432f874f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx @@ -0,0 +1,55 @@ +--- +title: (Async)NotifierProvider +--- + +import CodeBlock from "@theme/CodeBlock"; +import todos from "./notifier_provider/todos"; +import todosConsumer from "!!raw-loader!/docs/providers/notifier_provider/todos/todos_consumer.dart"; +import remoteTodos from "./notifier_provider/remote_todos"; +import remoteTodosConsumer from "!!raw-loader!/docs/providers/notifier_provider/remote_todos/todos_consumer.dart"; +import { trimSnippet, AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + +[NotifierProvider] is a provider that is used to listen to and expose a [Notifier]. +[AsyncNotifierProvider] is a provider that is used to listen to and expose an [AsyncNotifier]. +[AsyncNotifier] is a [Notifier] that can be asynchronously initialized. +`(Async)NotifierProvider` along with `(Async)Notifier` is Riverpod's recommended solution +for managing state which may change in reaction to a user interaction. + +It is typically used for: + +- exposing a state which can change over time after reacting to custom events. +- centralizing the logic for modifying some state (aka "business logic") in a + single place, improving maintainability over time. + +As a usage example, we could use [NotifierProvider] to implement a todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: + + + +Now that we have defined a [NotifierProvider], we can use it to interact +with the list of todos in our UI: + +{trimSnippet(todosConsumer)} + +As a usage example, we could use [AsyncNotifierProvider] to implement a remote todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: + + + +Now that we have defined a [AsyncNotifierProvider], we can use it to interact +with the list of todos in our UI: + +{trimSnippet(remoteTodosConsumer)} + +[notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html +[notifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/NotifierProvider.html +[asyncnotifier]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifier-class.html +[asyncnotifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifierProvider.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart new file mode 100644 index 000000000..e02195f87 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart @@ -0,0 +1,82 @@ +import 'dart:convert'; + +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +class Http { + Future get(String str) async => str; + Future delete(String str) async => str; + Future post(String str, Map body) async => str; + Future patch(String str, Map body) async => str; +} + +final http = Http(); + +/* SNIPPET START */ + +@freezed +class Todo with _$Todo { + factory Todo({ + required String id, + required String description, + required bool completed, + }) = _Todo; + + factory Todo.fromJson(Map json) => _$TodoFromJson(json); +} + +// This will generates a AsyncNotifier and AsyncNotifierProvider. +// The AsyncNotifier class that will be passed to our AsyncNotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +// Finally, we are using asyncTodosProvider(AsyncNotifierProvider) to allow the UI to +// interact with our Todos class. +@riverpod +class AsyncTodos extends _$AsyncTodos { + Future> _fetchTodo() async { + final json = await http.get('api/todos'); + final todos = jsonDecode(json) as List>; + return todos.map(Todo.fromJson).toList(); + } + + @override + FutureOr> build() async { + // Load initial todo list from the remote repository + return _fetchTodo(); + } + + Future addTodo(Todo todo) async { + // Set the state to loading + state = const AsyncValue.loading(); + // Add the new todo and reload the todo list from the remote repository + state = await AsyncValue.guard(() async { + await http.post('api/todos', todo.toJson()); + return _fetchTodo(); + }); + } + + // Let's allow removing todos + Future removeTodo(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.delete('api/todos/$todoId'); + return _fetchTodo(); + }); + } + + // Let's mark a todo as completed + Future toggle(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.patch( + 'api/todos/$todoId', + {'completed': true}, + ); + return _fetchTodo(); + }); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart new file mode 100644 index 000000000..d1b8a01d5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart @@ -0,0 +1,184 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Todo _$TodoFromJson(Map json) { + return _Todo.fromJson(json); +} + +/// @nodoc +mixin _$Todo { + String get id => throw _privateConstructorUsedError; + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$TodoImpl implements _Todo { + _$TodoImpl( + {required this.id, required this.description, required this.completed}); + + factory _$TodoImpl.fromJson(Map json) => + _$$TodoImplFromJson(json); + + @override + final String id; + @override + final String description; + @override + final bool completed; + + @override + String toString() { + return 'Todo(id: $id, description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.id, id) || other.id == id) && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, id, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); + + @override + Map toJson() { + return _$$TodoImplToJson( + this, + ); + } +} + +abstract class _Todo implements Todo { + factory _Todo( + {required final String id, + required final String description, + required final bool completed}) = _$TodoImpl; + + factory _Todo.fromJson(Map json) = _$TodoImpl.fromJson; + + @override + String get id; + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart new file mode 100644 index 000000000..8783f8ed4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart @@ -0,0 +1,44 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$TodoImpl _$$TodoImplFromJson(Map json) => _$TodoImpl( + id: json['id'] as String, + description: json['description'] as String, + completed: json['completed'] as bool, + ); + +Map _$$TodoImplToJson(_$TodoImpl instance) => + { + 'id': instance.id, + 'description': instance.description, + 'completed': instance.completed, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$asyncTodosHash() => r'fd0d7502a1c17b7cedd2350519649dd680fc48cd'; + +/// See also [AsyncTodos]. +@ProviderFor(AsyncTodos) +final asyncTodosProvider = + AutoDisposeAsyncNotifierProvider>.internal( + AsyncTodos.new, + name: r'asyncTodosProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$asyncTodosHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$AsyncTodos = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart new file mode 100644 index 000000000..f4455a338 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart @@ -0,0 +1,101 @@ +import 'dart:convert'; + +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Http { + Future get(String str) async => str; + Future delete(String str) async => str; + Future post(String str, Map body) async => str; + Future patch(String str, Map body) async => str; +} + +final http = Http(); + +/* SNIPPET START */ + +// An immutable state is preferred. +// We could also use packages like Freezed to help with the implementation. +@immutable +class Todo { + const Todo({ + required this.id, + required this.description, + required this.completed, + }); + + factory Todo.fromJson(Map map) { + return Todo( + id: map['id'] as String, + description: map['description'] as String, + completed: map['completed'] as bool, + ); + } + + // All properties should be `final` on our class. + final String id; + final String description; + final bool completed; + + Map toJson() => { + 'id': id, + 'description': description, + 'completed': completed, + }; +} + +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +class AsyncTodosNotifier extends AsyncNotifier> { + Future> _fetchTodo() async { + final json = await http.get('api/todos'); + final todos = jsonDecode(json) as List>; + return todos.map(Todo.fromJson).toList(); + } + + @override + Future> build() async { + // Load initial todo list from the remote repository + return _fetchTodo(); + } + + Future addTodo(Todo todo) async { + // Set the state to loading + state = const AsyncValue.loading(); + // Add the new todo and reload the todo list from the remote repository + state = await AsyncValue.guard(() async { + await http.post('api/todos', todo.toJson()); + return _fetchTodo(); + }); + } + + // Let's allow removing todos + Future removeTodo(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.delete('api/todos/$todoId'); + return _fetchTodo(); + }); + } + + // Let's mark a todo as completed + Future toggle(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.patch( + 'api/todos/$todoId', + {'completed': true}, + ); + return _fetchTodo(); + }); + } +} + +// Finally, we are using NotifierProvider to allow the UI to interact with +// our TodosNotifier class. +final asyncTodosProvider = + AsyncNotifierProvider>(() { + return AsyncTodosNotifier(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart new file mode 100644 index 000000000..5d00d05d9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart @@ -0,0 +1,37 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'codegen.dart'; + +/* SNIPPET START */ + +class TodoListView extends ConsumerWidget { + const TodoListView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // rebuild the widget when the todo list changes + final asyncTodos = ref.watch(asyncTodosProvider); + + // Let's render the todos in a scrollable list view + return switch (asyncTodos) { + AsyncData(:final value) => ListView( + children: [ + for (final todo in value) + CheckboxListTile( + value: todo.completed, + // When tapping on the todo, change its completed status + onChanged: (value) { + ref.read(asyncTodosProvider.notifier).toggle(todo.id); + }, + title: Text(todo.description), + ), + ], + ), + AsyncError(:final error) => Text('Error: $error'), + _ => const Center(child: CircularProgressIndicator()), + }; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart new file mode 100644 index 000000000..866ed37bb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart @@ -0,0 +1,68 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@freezed +class Todo with _$Todo { + factory Todo({ + required String id, + required String description, + required bool completed, + }) = _Todo; +} + +// This will generates a Notifier and NotifierProvider. +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +// Finally, we are using todosProvider(NotifierProvider) to allow the UI to +// interact with our Todos class. +@riverpod +class Todos extends _$Todos { + @override + List build() { + return []; + } + + // Let's allow the UI to add todos. + void addTodo(Todo todo) { + // Since our state is immutable, we are not allowed to do `state.add(todo)`. + // Instead, we should create a new list of todos which contains the previous + // items and the new one. + // Using Dart's spread operator here is helpful! + state = [...state, todo]; + // No need to call "notifyListeners" or anything similar. Calling "state =" + // will automatically rebuild the UI when necessary. + } + + // Let's allow removing todos + void removeTodo(String todoId) { + // Again, our state is immutable. So we're making a new list instead of + // changing the existing list. + state = [ + for (final todo in state) + if (todo.id != todoId) todo, + ]; + } + + // Let's mark a todo as completed + void toggle(String todoId) { + state = [ + for (final todo in state) + // we're marking only the matching todo as completed + if (todo.id == todoId) + // Once more, since our state is immutable, we need to make a copy + // of the todo. We're using our `copyWith` method implemented before + // to help with that. + todo.copyWith(completed: !todo.completed) + else + // other todos are not modified + todo, + ]; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart new file mode 100644 index 000000000..0b73d3548 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart @@ -0,0 +1,166 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$Todo { + String get id => throw _privateConstructorUsedError; + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc + +class _$TodoImpl implements _Todo { + _$TodoImpl( + {required this.id, required this.description, required this.completed}); + + @override + final String id; + @override + final String description; + @override + final bool completed; + + @override + String toString() { + return 'Todo(id: $id, description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.id, id) || other.id == id) && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @override + int get hashCode => Object.hash(runtimeType, id, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); +} + +abstract class _Todo implements Todo { + factory _Todo( + {required final String id, + required final String description, + required final bool completed}) = _$TodoImpl; + + @override + String get id; + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart new file mode 100644 index 000000000..0abb46e3f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todosHash() => r'3485c14ec4db07efe5fe52243258a66e6f99b2b4'; + +/// See also [Todos]. +@ProviderFor(Todos) +final todosProvider = AutoDisposeNotifierProvider>.internal( + Todos.new, + name: r'todosProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todosHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Todos = AutoDisposeNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart new file mode 100644 index 000000000..ec3e50308 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart @@ -0,0 +1,85 @@ +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +// An immutable state is preferred. +// We could also use packages like Freezed to help with the implementation. +@immutable +class Todo { + const Todo({ + required this.id, + required this.description, + required this.completed, + }); + + // All properties should be `final` on our class. + final String id; + final String description; + final bool completed; + + // Since Todo is immutable, we implement a method that allows cloning the + // Todo with slightly different content. + Todo copyWith({String? id, String? description, bool? completed}) { + return Todo( + id: id ?? this.id, + description: description ?? this.description, + completed: completed ?? this.completed, + ); + } +} + +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +class TodosNotifier extends Notifier> { + // We initialize the list of todos to an empty list + @override + List build() { + return []; + } + + // Let's allow the UI to add todos. + void addTodo(Todo todo) { + // Since our state is immutable, we are not allowed to do `state.add(todo)`. + // Instead, we should create a new list of todos which contains the previous + // items and the new one. + // Using Dart's spread operator here is helpful! + state = [...state, todo]; + // No need to call "notifyListeners" or anything similar. Calling "state =" + // will automatically rebuild the UI when necessary. + } + + // Let's allow removing todos + void removeTodo(String todoId) { + // Again, our state is immutable. So we're making a new list instead of + // changing the existing list. + state = [ + for (final todo in state) + if (todo.id != todoId) todo, + ]; + } + + // Let's mark a todo as completed + void toggle(String todoId) { + state = [ + for (final todo in state) + // we're marking only the matching todo as completed + if (todo.id == todoId) + // Once more, since our state is immutable, we need to make a copy + // of the todo. We're using our `copyWith` method implemented before + // to help with that. + todo.copyWith(completed: !todo.completed) + else + // other todos are not modified + todo, + ]; + } +} + +// Finally, we are using NotifierProvider to allow the UI to interact with +// our TodosNotifier class. +final todosProvider = NotifierProvider>(() { + return TodosNotifier(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart new file mode 100644 index 000000000..192cb9f66 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart @@ -0,0 +1,32 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'codegen.dart'; + +/* SNIPPET START */ + +class TodoListView extends ConsumerWidget { + const TodoListView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // rebuild the widget when the todo list changes + List todos = ref.watch(todosProvider); + + // Let's render the todos in a scrollable list view + return ListView( + children: [ + for (final todo in todos) + CheckboxListTile( + value: todo.completed, + // When tapping on the todo, change its completed status + onChanged: (value) => + ref.read(todosProvider.notifier).toggle(todo.id), + title: Text(todo.description), + ), + ], + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider.mdx index abda9ed16..136c8edbc 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider.mdx @@ -2,15 +2,19 @@ title: Provider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import todo from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo.dart"; -import completedTodos from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart"; -import todosConsumer from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart"; -import unoptimizedPreviousButton from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart"; -import optimizedPreviousButton from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import todo from "./provider/todo"; +import completedTodos from "./provider/completed_todos"; +import todosConsumer from "!!raw-loader!/docs/providers/provider/todos_consumer.dart"; +import unoptimizedPreviousButton from "./provider/unoptimized_previous_button"; +import optimizedPreviousButton from "./provider/optimized_previous_button"; +import { trimSnippet, AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: `Provider` is the most basic of all providers. It creates a value... And that's about it. @@ -31,15 +35,15 @@ Since filtering a list could be slightly expensive, we ideally do not want to filter our list of todos whenever our application re-renders. In this situation, we could use `Provider` to do the filtering for us. -For that, assume that our application has an existing [StateNotifierProvider] +For that, assume that our application has an existing [NotifierProvider] which manipulates a list of todos: -{trimSnippet(todo)} + From there, we can use `Provider` to expose the filtered list of todos, showing only the completed todos: -{trimSnippet(completedTodos)} + With this code, our UI is now able to show the list of the completed todos by listening to `completedTodosProvider`: @@ -73,7 +77,7 @@ current page index, and if that index is equal to 0, we would disable the button This code could be: -{trimSnippet(unoptimizedPreviousButton)} + The issue with this code is that whenever we change the current page, the "previous" button will rebuild. @@ -85,7 +89,7 @@ allowed to go to the previous page directly within the "previous" button. A way to solve this is to extract this logic outside of the widget and into a `Provider`: -{trimSnippet(optimizedPreviousButton)} + By doing this small refactoring, our `PreviousButton` widget will no longer rebuild when the page index changes thanks to `Provider`. @@ -98,4 +102,4 @@ This change both improved the performance of our button and had the interesting benefit of extracting the logic outside of our widget. [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider -[statenotifierprovider]: ./state_notifier_provider +[notifierprovider]: ./notifier_provider diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart new file mode 100644 index 000000000..1a29d96f5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart @@ -0,0 +1,15 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../todo/todo.dart'; + +part 'completed_todos.g.dart'; + +/* SNIPPET START */ + +@riverpod +List completedTodos(CompletedTodosRef ref) { + final todos = ref.watch(todosProvider); + + // we return only the completed todos + return todos.where((todo) => todo.isCompleted).toList(); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart new file mode 100644 index 000000000..be2ec7731 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'completed_todos.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$completedTodosHash() => r'855706c09268f428696b3b382ae1605818361b83'; + +/// See also [completedTodos]. +@ProviderFor(completedTodos) +final completedTodosProvider = AutoDisposeProvider>.internal( + completedTodos, + name: r'completedTodosProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$completedTodosHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CompletedTodosRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx new file mode 100644 index 000000000..11451aa1c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./completed_todos.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart similarity index 60% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart index 9d486731a..e24c48bd5 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart @@ -1,13 +1,13 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'todo.dart'; +import '../todo/raw.dart'; /* SNIPPET START */ final completedTodosProvider = Provider>((ref) { - // todosProvider로부터 모든 할일(todos)목록을 가져옵니다. + // We obtain the list of all todos from the todosProvider final todos = ref.watch(todosProvider); - // 완료된(completed) 할일(todos)들만 반환합니다. + // we return only the completed todos return todos.where((todo) => todo.isCompleted).toList(); }); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx new file mode 100644 index 000000000..fb83c92f1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./optimized_previous_button.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart new file mode 100644 index 000000000..7d3b8a332 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart @@ -0,0 +1,50 @@ +// A provider that controls the current page +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'optimized_previous_button.g.dart'; + +/* SNIPPET START */ + +@riverpod +class PageIndex extends _$PageIndex { + @override + int build() { + return 0; + } + + void goToPreviousPage() { + state = state - 1; + } +} + +// A provider which computes whether the user is allowed to go to the previous page +@riverpod +/* highlight-start */ +bool canGoToPreviousPage(CanGoToPreviousPageRef ref) { +/* highlight-end */ + return ref.watch(pageIndexProvider) != 0; +} + +class PreviousButton extends ConsumerWidget { + const PreviousButton({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // We are now watching our new Provider + // Our widget is no longer calculating whether we can go to the previous page. +/* highlight-start */ + final canGoToPreviousPage = ref.watch(canGoToPreviousPageProvider); +/* highlight-end */ + + void goToPreviousPage() { + ref.read(pageIndexProvider.notifier).goToPreviousPage(); + } + + return ElevatedButton( + onPressed: canGoToPreviousPage ? goToPreviousPage : null, + child: const Text('previous'), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart new file mode 100644 index 000000000..096a056f2 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -0,0 +1,42 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'optimized_previous_button.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$canGoToPreviousPageHash() => + r'801fe8182a37cd21ae83bdfccbe36c125b4d14fb'; + +/// See also [canGoToPreviousPage]. +@ProviderFor(canGoToPreviousPage) +final canGoToPreviousPageProvider = AutoDisposeProvider.internal( + canGoToPreviousPage, + name: r'canGoToPreviousPageProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$canGoToPreviousPageHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CanGoToPreviousPageRef = AutoDisposeProviderRef; +String _$pageIndexHash() => r'59307ecf23b5b2432833da5ad6b312bf36435d0e'; + +/// See also [PageIndex]. +@ProviderFor(PageIndex) +final pageIndexProvider = AutoDisposeNotifierProvider.internal( + PageIndex.new, + name: r'pageIndexProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$pageIndexHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$PageIndex = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart similarity index 67% rename from website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart index a9a7d2469..30b1cc673 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart @@ -1,4 +1,4 @@ -// Un provider che controlla la pagina corrente +// A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; @@ -6,12 +6,11 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final pageIndexProvider = StateProvider((ref) => 0); -// Un provider che calcola se l'utente è abilitato ad andare alla pagina precedente - +// A provider which computes whether the user is allowed to go to the previous page /* highlight-start */ final canGoToPreviousPageProvider = Provider((ref) { /* highlight-end */ - return ref.watch(pageIndexProvider) == 0; + return ref.watch(pageIndexProvider) != 0; }); class PreviousButton extends ConsumerWidget { @@ -19,11 +18,11 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // Ora osserviamo il nostro nuovo Provider - // Il nostro widget non calcolerà più se possiamo andare alla pagina precedente. - /* highlight-start */ + // We are now watching our new Provider + // Our widget is no longer calculating whether we can go to the previous page. +/* highlight-start */ final canGoToPreviousPage = ref.watch(canGoToPreviousPageProvider); - /* highlight-end */ +/* highlight-end */ void goToPreviousPage() { ref.read(pageIndexProvider.notifier).update((state) => state - 1); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx new file mode 100644 index 000000000..91d9cc4aa --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./todo.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart similarity index 59% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart index 74a2e6609..11e62bc3a 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart @@ -10,15 +10,18 @@ class Todo { final String description; } -class TodosNotifier extends StateNotifier> { - TodosNotifier() : super([]); +class TodosNotifier extends Notifier> { + @override + List build() { + return []; + } void addTodo(Todo todo) { state = [...state, todo]; } - // TODO "removeTodo"와 같은 다른 메소드들을 추가하기 + // TODO add other methods, such as "removeTodo", ... } -final todosProvider = StateNotifierProvider>((ref) { +final todosProvider = NotifierProvider>(() { return TodosNotifier(); }); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart new file mode 100644 index 000000000..7089bc962 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart @@ -0,0 +1,25 @@ +// ignore_for_file: avoid_positional_boolean_parameters +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo.g.dart'; + +/* SNIPPET START */ + +class Todo { + Todo(this.description, this.isCompleted); + final bool isCompleted; + final String description; +} + +@riverpod +class Todos extends _$Todos { + @override + List build() { + return []; + } + + void addTodo(Todo todo) { + state = [...state, todo]; + } + // TODO add other methods, such as "removeTodo", ... +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart new file mode 100644 index 000000000..0b4a0a56d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todosHash() => r'4bd25c3c15bfff56ad6e733bd17ecb7284c4ceb2'; + +/// See also [Todos]. +@ProviderFor(Todos) +final todosProvider = AutoDisposeNotifierProvider>.internal( + Todos.new, + name: r'todosProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todosHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Todos = AutoDisposeNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart index d3c19dfde..9b93e9185 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart @@ -3,16 +3,16 @@ import 'package:flutter/widgets.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'completed_todos.dart'; +import 'completed_todos/completed_todos.dart'; Widget build() { return /* SNIPPET START */ - Consumer(builder: (context, ref, child) { - final completedTodos = ref.watch(completedTodosProvider); - // TODO a ListView/GridView/...등을 사용하여 todos를 표시하기/* SKIP */ - return Container(); - /* SKIP END */ - }); +Consumer(builder: (context, ref, child) { + final completedTodos = ref.watch(completedTodosProvider); + // TODO show the todos using a ListView/GridView/.../* SKIP */ + return Container(); + /* SKIP END */ +}); /* SNIPPET END */ } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx new file mode 100644 index 000000000..d345d4f5d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./unoptimized_previous_button.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart similarity index 74% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart index e5f56b568..828d382d5 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart @@ -1,4 +1,4 @@ -// 현재 페이지를 제어하는 프로바이더 +// A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; @@ -11,8 +11,8 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 만약 첫페이지가 아니라면 이전 버튼이 활성화 됩니다. - final canGoToPreviousPage = ref.watch(pageIndexProvider) == 0; + // if not on first page, the previous button is active + final canGoToPreviousPage = ref.watch(pageIndexProvider) != 0; void goToPreviousPage() { ref.read(pageIndexProvider.notifier).update((state) => state - 1); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart new file mode 100644 index 000000000..f77de56c3 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart @@ -0,0 +1,39 @@ +// A provider that controls the current page +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'unoptimized_previous_button.g.dart'; + +/* SNIPPET START */ + +@riverpod +class PageIndex extends _$PageIndex { + @override + int build() { + return 0; + } + + void goToPreviousPage() { + state = state - 1; + } +} + +class PreviousButton extends ConsumerWidget { + const PreviousButton({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // if not on first page, the previous button is active + final canGoToPreviousPage = ref.watch(pageIndexProvider) != 0; + + void goToPreviousPage() { + ref.read(pageIndexProvider.notifier).goToPreviousPage(); + } + + return ElevatedButton( + onPressed: canGoToPreviousPage ? goToPreviousPage : null, + child: const Text('previous'), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart new file mode 100644 index 000000000..e02ece976 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'unoptimized_previous_button.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$pageIndexHash() => r'59307ecf23b5b2432833da5ad6b312bf36435d0e'; + +/// See also [PageIndex]. +@ProviderFor(PageIndex) +final pageIndexProvider = AutoDisposeNotifierProvider.internal( + PageIndex.new, + name: r'pageIndexProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$pageIndexHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$PageIndex = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx index a3cab49e6..ad8b55960 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx @@ -2,17 +2,19 @@ title: StateNotifierProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import todos from "!!raw-loader!/docs/providers/state_notifier_provider/todos.dart"; import todosConsumer from "!!raw-loader!/docs/providers/state_notifier_provider/todos_consumer.dart"; import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + `StateNotifierProvider` is a provider that is used to listen to and expose a -[StateNotifier] (from the package [state_notifier], which Riverpod re-exports). -`StateNotifierProvider` along with [StateNotifier] is Riverpod's recommended solution -for managing state which may change in reaction to a user interaction. +[StateNotifier] (from the package [state_notifier], which Riverpod re-exports). It is typically used for: @@ -21,6 +23,9 @@ It is typically used for: - centralizing the logic for modifying some state (aka "business logic") in a single place, improving maintainability over time. +:::info +Prefer using [NotifierProvider] instead. +::: As a usage example, we could use `StateNotifierProvider` to implement a todo-list. Doing so would allow us to expose methods such as `addTodo` to let the UI @@ -37,3 +42,4 @@ with the list of todos in our UI: [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html [provider]: ./provider [futureprovider]: ./future_provider +[notifierprovider]: ./notifier_provider diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider.mdx index 88340c713..bb65359db 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider.mdx @@ -2,8 +2,6 @@ title: StateProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import product from "!!raw-loader!/docs/providers/state_provider/product.dart"; import productListView from "!!raw-loader!/docs/providers/state_provider/product_list_view.dart"; @@ -15,9 +13,15 @@ import updateReadTwice from "!!raw-loader!/docs/providers/state_provider/update_ import updateReadOnce from "!!raw-loader!/docs/providers/state_provider/update_read_once.dart"; import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + `StateProvider` is a provider that exposes a way to modify its state. -It is a simplification of [StateNotifierProvider], designed to avoid -having to write a [StateNotifier] class for very simple use-cases. +It is a simplification of [NotifierProvider], designed to avoid +having to write a [Notifier] class for very simple use-cases. `StateProvider` exists primarily to allow the modification of **simple** variables by the User Interface. @@ -34,10 +38,10 @@ You should not use `StateProvider` if: - your state is a complex object (such as a custom class, a list/map, ...) - the logic for modifying your state is more advanced than a simple `count++`. -For more advanced cases, consider using [StateNotifierProvider] instead and -create a [StateNotifier] class. +For more advanced cases, consider using [NotifierProvider] instead and +create a [Notifier] class. While the initial boilerplate will be a bit larger, having a custom -[StateNotifier] class is critical for the long-term maintainability of your +[Notifier] class is critical for the long-term maintainability of your project – as it centralizes the business logic of your state in a single place. ## Usage example: Changing the filter type using a dropdown @@ -119,7 +123,9 @@ This change achieves the same effect while making the syntax a bit better. [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider [ref.read]: ../concepts/reading#using-refread-to-obtain-the-state-of-a-provider-once [statenotifierprovider]: ./state_notifier_provider +[notifierprovider]: ./notifier_provider [futureprovider]: ./future_provider +[notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html [provider]: ./provider [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx index 5497e32ba..bd40cfc5f 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx @@ -2,12 +2,16 @@ title: StreamProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import configProvider from "/docs/providers/future_provider/config_provider"; -import configConsumer from "/docs/providers/future_provider/config_consumer"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet,AutoSnippet } from "../../../../../src/components/CodeSnippet"; +import streamProvider from "./stream_provider/live_stream_chat_provider"; +import streamConsumer from "!!raw-loader!/docs/providers/stream_provider/live_stream_chat_consumer.dart"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: `StreamProvider` is similar to [FutureProvider] but for [Stream]s instead of [Future]s. @@ -32,6 +36,17 @@ Using `StreamProvider` over [StreamBuilder] has numerous benefits: immediate access to the most up-to-date event. - it allows easily mocking the stream during tests by overriding the `StreamProvider`. +## Usage example: live chat using sockets + +`StreamProvider` is used in when we handle stream of asynchronous data +such as Video Streaming, Weather broadcasting Apis or Live chat as follows: + + + +Then, the UI can listen to live streaming chats like so: + +{trimSnippet(streamConsumer)} + [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider [statenotifierprovider]: ./state_notifier_provider [provider]: ./provider @@ -41,4 +56,4 @@ Using `StreamProvider` over [StreamBuilder] has numerous benefits: [stream]: https://api.dart.dev/dart-async/Stream-class.html [stream.periodic]: https://api.dart.dev/stable/2.15.1/dart-async/Stream/Stream.periodic.html [family]: ../concepts/modifiers/family -[streambuilder]: https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html +[streambuilder]: https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart new file mode 100644 index 000000000..383def216 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart @@ -0,0 +1,25 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'live_stream_chat_provider.dart'; + +/* SNIPPET START */ +Widget build(BuildContext context, WidgetRef ref) { + final liveChats = ref.watch(chatProvider); + + // Like FutureProvider, it is possible to handle loading/error states using AsyncValue.when + return switch (liveChats) { + // Display all the messages in a scrollable list view. + AsyncData(:final value) => ListView.builder( + // Show messages from bottom to top + reverse: true, + itemCount: value.length, + itemBuilder: (context, index) { + final message = value[index]; + return Text(message); + }, + ), + AsyncError(:final error) => Text(error.toString()), + _ => const CircularProgressIndicator(), + }; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart new file mode 100644 index 000000000..d2bb3ad2a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart @@ -0,0 +1,18 @@ +import 'dart:convert'; +import 'dart:io'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final chatProvider = StreamProvider>((ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart new file mode 100644 index 000000000..e2e34878c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart @@ -0,0 +1,23 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +import 'dart:convert'; +import 'dart:io'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +Stream> chat(ChatRef ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart new file mode 100644 index 000000000..ed660f3fa --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$chatHash() => r'db1302132f90e854fe2f5da9d97d89c9a3c8b858'; + +/// See also [chat]. +@ProviderFor(chat) +final chatProvider = AutoDisposeStreamProvider>.internal( + chat, + name: r'chatProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$chatHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ChatRef = AutoDisposeStreamProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart new file mode 100644 index 000000000..beb2bcd05 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart @@ -0,0 +1,18 @@ +import 'dart:convert'; +import 'dart:io'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final chatProvider = StreamProvider>((ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx deleted file mode 100644 index b725a5b27..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx +++ /dev/null @@ -1,401 +0,0 @@ ---- -title: Provider사용자를 위한 Riverpod 가이드 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import pubspec from "./getting_started/pubspec"; -import dartHelloWorld from "./getting_started/dart_hello_world"; -import helloWorld from "./getting_started/hello_world"; -import dartPubspec from "./getting_started/dart_pubspec"; -import { - trimSnippet, - AutoSnippet, - When, -} from "../../../../src/components/CodeSnippet"; - -This article is designed for people familiar with the [Provider] package who -wants to learn about Riverpod. - -## The relationship between Riverpod and Provider - -Riverpod is designed to be the spiritual successor of Provider. Hence the -name "Riverpod", which is an anagram of "Provider". - -Riverpod was born while searching for solutions to the various technical -limitations that Provider face. Originally, Riverpod was supposed to be a -major version of Provider as a way to solve this problem. But it was -decided against as this would be a decently big breaking change, and -Provider is one of the most used Flutter packages. - -Still, conceptually, Riverpod and Provider are fairly similar. -Both packages fill a similar role. Both try to: - -- cache and dispose some stateful objects -- offer a way to mock those objects during tests -- offer a way for Widgets to listen to those objects in a simple way. - -At the same time, think of Riverpod as what Provider could've been if -it continued to mature for a few years. - -Riverpod fixes various fundamental problems with Provider, such as but not limited to: - -- Significantly simplifying the combination of "providers". - Instead of the tedious and error-prone `ProxyProvider`, Riverpod exposes - simple yet powerful utilites such as [ref.watch] and [ref.listen]. -- Allowing multiple "provider" to expose a value of the same type. - This removes the need for defining custom classes when exposing a - plain `int` or `String` would work just as well. -- Removing the need to re-define providers inside tests. - With Riverpod, providers are ready to use inside tests by default. -- Reducing the over-reliance on "scoping" to dispose objects by offering - alternate ways to dispose objects ([autoDispose]) - While powerful, scoping a provider is fairly advanced and hard to get right. - -... And a lot more. - -The only true downside of Riverpod is that it requires changing the widget type -to work: - -- Instead of extending `StatelessWidget`, with Riverpod you should extend - `ConsumerWidget`. -- Instead of extending `StatefulWidget`, with Riverpod you should extend - `ConsumerStatefulWidget`. - -But this inconvenience is fairly minor in the grand scheme of things. And this -requirement might one day disappear. - -So to answer the question you're probably asking yourself: -**Should I use Provider or Riverpod?** - -You probably should be using Riverpod. -Riverpod is overhaul better designed and could lead to drastic simplifications -of your logic. - -## The difference between Provider and Riverpod - -### Defining providers - -The primary difference between both packages is how "providers" are defined. - -With [Provider], providers are widgets and as such placed inside the widget tree, -typically inside a `MultiProvider`: - -```dart -class Counter extends ChangeNotifier { - ... -} - -void main() { - runApp( - MultiProvider( - providers: [ - ChangeNotifierProvider(create: (context) => Counter()), - ], - child: MyApp(), - ) - ); -} -``` - -With Riverpod, providers are **not** widgets. Instead they are plain Dart objects. -Similarly, providers are defined outside of the widget tree, and instead are declared -as global final variables. - -Also, for Riverpod to work, it is necessary to add a `ProviderScope` widget above the -entire application. As such, the equivalent of the Provider example using Riverpod -would be: - -```dart -// Providers are now top-level variables -final counterProvider = ChangeNotifierProvider((ref) => Counter()); - -void main() { - runApp( - // This widget enables Riverpod for the entire project - ProviderScope( - child: MyApp(), - ), - ); -} -``` - -Notice how the provider definition simply moved up a few lines. - -:::info -Since with Riverpod providers are plain Dart objects, it is possible to use -Riverpod without Flutter. -For example, Riverpod can be used to write command line applications. -::: - -### Reading providers: BuildContext - -With Provider, one way of reading providers is to use a Widget's `BuildContext`. - -For example, if a provider was defined as: - -```dart -Provider(...); -``` - -then reading it using [Provider] is done with: - -```dart -class Example extends StatelessWidget { - @override - Widget build(BuildContext context) { - Model model = context.watch(); - - } -} -``` - -The equivalent in Riverpod would be: - -```dart -final modelProvider = Provider(...); - -class Example extends ConsumerWidget { - @override - Widget build(BuildContext context, WidgetRef ref) { - Model model = ref.watch(modelProvider); - - } -} -``` - -Notice how: - -- Riverpod's snippet extends `ConsumerWidget` instead of `StatelessWidget`. - That different widget type adds one extra parameter to our `build` function: - `WidgetRef`. - -- Instead of `BuildContext.watch`, in Riverpod we do `WidgetRef.watch`, using - the `WidgetRef` which we obtained from `ConsumerWidget`. - -- Riverpod does not rely on generic types. Instead it relies on the variable - created using provider definition. - -Notice too how similar the wording is. Both Provider and Riverpod use the keyword -"watch" to describe "this widget should rebuild when the value changes". - -:::info -Riverpod uses the same terminology as Provider for reading providers. - -- `BuildContext.watch` -> `WidgetRef.watch` -- `BuildContext.read` -> `WidgetRef.read` - -The rules for `context.watch` vs `context.read` applies to Riverpod too: -Inside the `build` method, use "watch". Inside click handlers and other events, -use "read". -::: - -### Reading providers: Consumer - -Provider optionally comes with a widget named `Consumer` (and variants such as `Consumer2`) -for reading providers. - -`Consumer` is helpful as a performance optimization, by allowing more granular rebuilds -of the widget tree – updating only the revelant widgets when the state changes: - -As such, if a provider was defined as: - -```dart -Provider(...); -``` - -Provider allows reading that provider using `Consumer` with: - -```dart -Consumer( - builder: (BuildContext context, Model model, Widget? child) { - - } -) -``` - -Riverpod has the same principle. Riverpod, too, has a widget named `Consumer` -for the exact same purpose. - -If we defined a provider as: - -```dart -final modelProvider = Provider(...); -``` - -Then using `Consumer` we could do: - -```dart -Consumer( - builder: (BuildContext context, WidgetRef ref, Widget? child) { - Model model = ref.watch(modelProvider); - - } -) -``` - -Notice how `Consumer` gives us a `WidgetRef` object. This is the same object -as we saw in the previous part related to `ConsumerWidget`. - -### Combining providers: ProxyProvider with stateless objects - -When using Provider, the official way of combining providers is using the -`ProxyProvider` widget (or variants such as `ProxyProvider2`). - -For example we may define: - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -ChangeNotifierProvider(create: (context) => UserIdNotifier()), -``` - -From there we have two options. We may combine `UserIdNotifier` to create a new -"stateless" provider (typically an immutable value that possibly override ==). -Such as: - -```dart -ProxyProvider( - update: (context, userIdNotifier, _) { - return 'The user ID of the the user is ${userIdNotifier.userId}'; - } -) -``` - -This provider would automatically return a new `String` whenever -`UserIdNotifier.userId` changes. - -We can do something similar in Riverpod, but the syntax is different. -First, in Riverpod, the definition of our `UserIdNotifier` would be: - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -final userIdNotifierProvider = ChangeNotifierProvider( - (ref) => UserIdNotifier(), -), -``` - -From there, to generate our `String` based on the `userId`, we could do: - -```dart -final labelProvider = Provider((ref) { - UserIdNotifier userIdNotifier = ref.watch(userIdNotifierProvider); - return 'The user ID of the the user is ${userIdNotifier.userId}'; -}); -``` - -Notice the line doing `ref.watch(userIdNotifierProvider)`. - -This line of code tells Riverpod to obtain the content of the `userIdNotifierProvider` -and that whenever that value changes, `labelProvider` will be recomputed too. -As such, the `String` emitted by our `labelProvider` will automatically update -whenever the `userId` changes. - -This `ref.watch` line should feel similar. This pattern was covered previously -when explaining [how to read providers inside widgets](#reading-providers-buildcontext). -Indeed, providers are now able to listen to other providers in the same way -that widgets do. - -### Combining providers: ProxyProvider with stateful objects - -When combining providers, another alternative use-case is to expose -stateful objects, such as a `ChangeNotifier` instance. - -For that, we could use `ChangeNotifierProxyProvider` (or variants such as `ChangeNotifierProxyProvider2`). -For example we may define: - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -ChangeNotifierProvider(create: (context) => UserIdNotifier()), -``` - -Then, we can define a new `ChangeNotifier` that is based on `UserIdNotifier.userId`. -For example we could do: - -```dart -class UserNotifier extends ChangeNotifier { - String? _userId; - - void setUserId(String? userId) { - if (userId != _userId) { - print('The user ID changed from $_userId to $userId'); - _userId = userId; - } - } -} - -// ... - -ChangeNotifierProxyProvider( - create: (context) => UserNotifier(), - update: (context, userIdNotifier, userNotifier) { - return userNotifier! - ..setUserId(userIdNotifier.userId); - }, -); -``` - -This new provider creates a single instance of `UserNotifier` (which is never re-constructed) -and prints a string whenever the user ID changes. - -Doing the same thing in provider is achieved differently. -First, in Riverpod, the definition of our `UserIdNotifier` would be: - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -final userIdNotifierProvider = ChangeNotifierProvider( - (ref) => UserIdNotifier(), -), -``` - -From there, the equivalent to the previous `ChangeNotifierProxyProvider` would be: - -```dart -class UserNotifier extends ChangeNotifier {} - -final userNotfierProvider = ChangeNotifierProvider((ref) { - final userNotifier = UserNotifier(); - ref.listen( - userIdNotifierProvider, - (previous, next) { - if (previous?.userId != next.userId) { - print('The user ID changed from ${previous?.userId} to ${next.userId}'); - } - }, - ); - - return userNotifier; -}); -``` - -The core of this snippet is the `ref.listen` line. -This `ref.listen` function is a utility that allows listening to a provider, -and whenever the provider changes, executes a function. - -The `previous` and `next` parameters of that function correspond to the -last value before the provider changed and the new value after it changed. - -[provider]: https://pub.dev/packages/provider -[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider -[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change -[autodispose]: /docs/concepts/modifiers/auto_dispose diff --git a/website/i18n/ko/docusaurus-theme-classic/footer.json b/website/i18n/ko/docusaurus-theme-classic/footer.json index 7c75e9ad7..989954b61 100644 --- a/website/i18n/ko/docusaurus-theme-classic/footer.json +++ b/website/i18n/ko/docusaurus-theme-classic/footer.json @@ -7,9 +7,25 @@ "message": "커뮤니티", "description": "The title of the footer links column with title=Community in the footer" }, + "link.title.Sponsors": { + "message": "스폰서", + "description": "The title of the footer links column with title=Sponsors in the footer" + }, + "link.item.label.Why Riverpod?": { + "message": "왜 Riverpod인가?", + "description": "The label of footer link with label=Why Riverpod? linking to docs/introduction/why_riverpod" + }, "link.item.label.Getting started": { "message": "시작하기", - "description": "The label of footer link with label=Getting started linking to docs/getting_started" + "description": "The label of footer link with label=Getting started linking to docs/introduction/getting_started" + }, + "link.item.label.Discord": { + "message": "Discord", + "description": "The label of footer link with label=Discord linking to https://discord.gg/Bbumvej" + }, + "link.item.label.GitHub": { + "message": "GitHub", + "description": "The label of footer link with label=GitHub linking to https://github.com/rrousselgit/riverpod" }, "link.item.label.Stack Overflow": { "message": "Stack Overflow", @@ -19,12 +35,20 @@ "message": "Twitter", "description": "The label of footer link with label=Twitter linking to https://twitter.com/remi_rousselet" }, - "link.item.label.GitHub": { - "message": "GitHub", - "description": "The label of footer link with label=GitHub linking to https://github.com/rrousselgit/riverpod" + "link.item.label.Code of conduct": { + "message": "행동 강령", + "description": "The label of footer link with label=Code of conduct linking to https://github.com/rrousselGit/riverpod/blob/master/CODE_OF_CONDUCT.md" + }, + "link.item.label.Contributing guide": { + "message": "기여 가이드", + "description": "The label of footer link with label=Contributing guide linking to https://github.com/rrousselGit/riverpod/blob/rework-flow/CONTRIBUTING.md" }, "copyright": { - "message": "Copyright © 2022 Remi Rousselet.
Built with Docusaurus.", + "message": "Copyright © 2024 Remi Rousselet.
Built with Docusaurus.", "description": "The footer copyright" + }, + "logo.alt": { + "message": "Riverpod", + "description": "The alt text of footer logo" } } diff --git a/website/i18n/ko/docusaurus-theme-classic/navbar.json b/website/i18n/ko/docusaurus-theme-classic/navbar.json index ec37a15b5..a016241eb 100644 --- a/website/i18n/ko/docusaurus-theme-classic/navbar.json +++ b/website/i18n/ko/docusaurus-theme-classic/navbar.json @@ -3,6 +3,10 @@ "message": "Riverpod", "description": "The title in the navbar" }, + "logo.alt": { + "message": "Riverpod", + "description": "The alt text of navbar logo" + }, "item.label.Docs": { "message": "문서", "description": "Navbar item with label Docs" @@ -11,4 +15,4 @@ "message": "GitHub", "description": "Navbar item with label GitHub" } -} \ No newline at end of file +} diff --git a/website/i18n/zh-Hans/code.json b/website/i18n/zh-Hans/code.json index 15ced48b9..48b627308 100644 --- a/website/i18n/zh-Hans/code.json +++ b/website/i18n/zh-Hans/code.json @@ -1,46 +1,67 @@ { "home.shared_state_title": { - "message": "任意位置声明共享状态" + "message": "随处声明共享状态" }, "home.shared_state_body": { - "message": "不再需要在你的 {main} 和UI文件之间来回跳转。 {br} 将共享状态的代码放在它所属的位置上，无论是放在独立的package中还是放在需要它的Widget旁边，都不会丢失它的可测试性。", + "message": "无需在 {main} 和 UI 文件之间来回切换。 {br}{br} 只要将共享状态的代码放在它所属位置上，无论是放在独立的 package 中，还是需要它的 widget 旁，都不会丢失可测试性。", "description": "The homepage input placeholder" }, "home.recompute_title": { - "message": "最小粒度更新UI和重新计算状态" + "message": "按需更新状态和重绘 UI" }, "home.recompute_body": { - "message": "我们无需在 {build} 中对列表进行排序或过滤，也不必依赖高级的缓存机制。 {br}{br} 使用 {Provider} 和 {families} 修饰符，那么它只会在你真正需要的时候才发起HTTP请求或整理你的列表。" + "message": "不必在 {build} 方法中执行列表排序或过滤，也不必依赖高级的缓存机制。{br} {br} 使用组合提供者 {Provider} 和 {families} 方法，在你真正需要的时候才去发起 HTTP 请求或者排序列表。" + }, + "home.refactors_title": { + "message": "通过重构简化日常工作" + }, + "home.refactors_body": { + "message": "Riverpod 提供了多种重构提示, 例如 \"Wrap widget in a Consumer\" 等等。 请参阅 {warnings}." + }, + "home.refactors_list_link": { + "message": "重构提示列表" + }, + "home.lint_title": { + "message": "使用 lint 规则保持代码可维护" + }, + "home.lint_body": { + "message": "实现了 Riverpod 定制的 lint 新规则，并且还会不断添加更多规则。这可确保您的代码保持最佳状态。请参阅 {warnings}。" + }, + "home.lint_rules_list_link": { + "message": "lint 规则列表" }, "home.safe_read_title": { - "message": "安全使用Provider" + "message": "安全的读取 providers" }, "home.safe_read_body": { - "message": "使用provider不再导致错误的状态。恰当地使用provider，你可以始终获得一个可靠的结果。 {br}{br} 这在异步操作中也是如此，Riverpod可以让你简洁地处理loading/error状态。" + "message": "读取 provider 永远不会导致异常的状态。如果你编写了读取一个 provider 所需的代码，你将得到一个符合预期的值。 {br} {br}这甚至适用于异步加载的值。与 provider 相反，Riverpod 允许简洁地处理 loading/error 状态。" }, "home.devtool_title": { - "message": "在DevTools中检查状态" + "message": "在 DevTools 中检查你的状态" }, "home.devtool_body": { - "message": "你可以在Flutter的开发工具中一目了然地看到Riverpod的各种状态。 {br} 此外，一款功能更全面的状态检查工具正在开发中。" + "message": "使用了 Riverpod，你的状态将可以在 Flutter 自带的 DevTools 中一目了然。 {br} {br} 此外，一款全面的状态检查工具正在开发中……" + }, + "homepage.declarative_title": { + "message": "声明式编程" }, - "homepage.compile_safe_title": { - "message": "编译安全" + "homepage.declarative_body": { + "message": "以类似于无状态小部件的方式编写业务逻辑。{br} 让您的网络请求在必要时自动重新计算，并使您的逻辑易于重用、组合、维护。" }, - "homepage.compile_safe_body": { - "message": "不再需要关心{ProviderNotFound}或忘记处理加载中的状态。使用Riverpod，你的代码如果能够通过编译，那么就可以使用。" + "homepage.common_ui_patterns_title": { + "message": "轻松实现常见的 UI 模式" }, - "homepage.unlimited_provider_title": { - "message": "没有限制的Provider" + "homepage.common_ui_patterns_body": { + "message": "使用 Riverpod，只需几行代码即可实现常见但复杂的 UI 模式，例如“下拉刷新”、“实时搜索”等。" }, - "homepage.unlimited_provider_body": { - "message": "Riverpod的灵感来自于Provider，且解决一些关键的问题：比如支持多个同类型的provider、异步的provider、在任意地方添加各种provider……" + "homepage.tooling_ready_title": { + "message": "工具准备就绪" }, - "homepage.no_flutter_dependency_title": { - "message": "不依赖于Flutter" + "homepage.tooling_ready_body": { + "message": "Riverpod 通过将常见错误作为编译错误来增强编译器。 它还提供自定义 lint 规则和重构选项。 它甚至有一个用于生成文档的命令行。" }, - "homepage.no_flutter_dependency_body": { - "message": "Riverpod可以在不依赖Flutter的情况下创建、共享和测试Provider。你不需要{BuildContext}就能监听Provider。" + "homepage.features_title": { + "message": "特性" }, "home.tagline": { "message": "响应式缓存和数据绑定框架" @@ -91,10 +112,6 @@ "message": "页面已崩溃。", "description": "The title of the fallback page when the page crashed" }, - "theme.ErrorPageContent.tryAgain": { - "message": "重试", - "description": "The label of the button to try again when the page crashed" - }, "theme.NotFound.title": { "message": "找不到页面", "description": "The title of the 404 page" @@ -187,10 +204,6 @@ "message": "浅色模式", "description": "The name for the light color mode" }, - "theme.docs.breadcrumbs.home": { - "message": "主页面", - "description": "The ARIA label for the home page in the breadcrumbs" - }, "theme.docs.breadcrumbs.navAriaLabel": { "message": "页面路径", "description": "The ARIA label for the breadcrumbs" @@ -216,7 +229,7 @@ "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" }, "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged}「{tagName}」", + "message": "{nDocsTagged} 带 “{tagName}”", "description": "The title of the page for a docs tag" }, "theme.docs.versionBadge.label": { @@ -227,19 +240,19 @@ "description": "The link label to edit the current page" }, "theme.common.headingLinkTitle": { - "message": "标题的直接链接", + "message": "跳转到 {heading}", "description": "Title for link to heading" }, "theme.lastUpdated.atDate": { - "message": "于 {date} ", + "message": "于 {date}", "description": "The words used to describe on which date a page has been last updated" }, "theme.lastUpdated.byUser": { - "message": "由 {user} ", + "message": "由 {user}", "description": "The words used to describe by who the page has been last updated" }, "theme.lastUpdated.lastUpdatedAtBy": { - "message": "最后{byUser}{atDate}更新", + "message": "最后由 {byUser} 在 {atDate} 更新", "description": "The sentence used to display when a page has been last updated, and by who" }, "theme.navbar.mobileVersionsDropdown.label": { @@ -255,7 +268,7 @@ "description": "The ARIA label for close button of announcement bar" }, "theme.blog.sidebar.navAriaLabel": { - "message": "最近博文导航", + "message": "博客最近帖子的导航", "description": "The ARIA label for recent posts in the blog sidebar" }, "theme.CodeBlock.copied": { @@ -275,21 +288,21 @@ "description": "The title attribute for toggle word wrapping button of code block lines" }, "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { - "message": "打开/收起侧边栏菜单「{label}」", + "message": "打开/关闭侧边栏菜单“{label}”", "description": "The ARIA label to toggle the collapsible sidebar category" }, + "theme.NavBar.navAriaLabel": { + "message": "主导航", + "description": "The ARIA label for the main navigation" + }, "theme.navbar.mobileLanguageDropdown.label": { "message": "选择语言", "description": "The label for the mobile language switcher dropdown" }, "theme.TOCCollapsible.toggleButtonLabel": { - "message": "本页总览", + "message": "目录", "description": "The label used by the button on the collapsible TOC component" }, - "theme.blog.post.readingTime.plurals": { - "message": "阅读需 {readingTime} 分钟", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, "theme.blog.post.readMore": { "message": "阅读更多", "description": "The label used in blog post item excerpts to link to full blog posts" @@ -298,6 +311,14 @@ "message": "阅读 {title} 的全文", "description": "The ARIA label for the link to full blog posts from excerpts" }, + "theme.blog.post.readingTime.plurals": { + "message": "阅读至少需要 {readingTime} 分钟", + "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" + }, + "theme.docs.breadcrumbs.home": { + "message": "主页", + "description": "The ARIA label for the home page in the breadcrumbs" + }, "theme.docs.sidebar.collapseButtonTitle": { "message": "收起侧边栏", "description": "The title attribute for collapse button of doc sidebar" @@ -306,6 +327,10 @@ "message": "收起侧边栏", "description": "The title attribute for collapse button of doc sidebar" }, + "theme.docs.sidebar.navAriaLabel": { + "message": "文档侧边栏", + "description": "The ARIA label for the sidebar navigation" + }, "theme.docs.sidebar.closeSidebarButtonAriaLabel": { "message": "关闭导航栏", "description": "The ARIA label for close button of mobile sidebar" @@ -326,6 +351,9 @@ "message": "展开侧边栏", "description": "The ARIA label and title attribute for expand button of doc sidebar" }, + "theme.SearchBar.seeAll": { + "message": "查看所有 {count} 条结果" + }, "theme.SearchBar.label": { "message": "搜索", "description": "The ARIA label and placeholder for search button" @@ -379,7 +407,7 @@ "description": "The ARIA label for the Enter key button that makes the selection" }, "theme.SearchModal.footer.navigateText": { - "message": "导航", + "message": "选择", "description": "The explanatory text of the action for the Arrow up and Arrow down key" }, "theme.SearchModal.footer.navigateUpKeyAriaLabel": { @@ -427,7 +455,7 @@ "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" }, "theme.SearchPage.existingResultsTitle": { - "message": "「{query}」的搜索结果", + "message": "“{query}”的搜索结果", "description": "The search page title for non-empty query" }, "theme.SearchPage.emptyResultsTitle": { @@ -454,8 +482,9 @@ "message": "正在获取新的搜索结果...", "description": "The paragraph for fetching new search results" }, - "theme.SearchBar.seeAll": { - "message": "查看全部 {count} 个结果" + "theme.ErrorPageContent.tryAgain": { + "message": "再试一次", + "description": "The label of the button to try again rendering when the React error boundary captures an error" }, "theme.common.skipToMainContent": { "message": "跳到主要内容", @@ -465,4 +494,4 @@ "message": "标签", "description": "The title of the tag list page" } -} \ No newline at end of file +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json index 80cbbdfe0..5943108db 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json @@ -3,25 +3,33 @@ "message": "Next", "description": "The label for version current" }, - "sidebar.Sidebar.category.All Providers": { - "message": "Provider类型", - "description": "The label for category All Providers in sidebar Sidebar" + "sidebar.Sidebar.category.Introduction": { + "message": "介绍", + "description": "The label for category Introduction in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Riverpod for Provider Users": { + "message": "给 Provider 开发者的 Riverpod 指南", + "description": "The label for category Riverpod for Provider Users in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Essentials": { + "message": "要点", + "description": "The label for category Essentials in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Case studies": { + "message": "应用案例", + "description": "The label for category Case studies in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Advanced topics": { + "message": "进阶内容", + "description": "The label for category Advanced topics in sidebar Sidebar" }, "sidebar.Sidebar.category.Concepts": { "message": "概念", "description": "The label for category Concepts in sidebar Sidebar" }, - "sidebar.Sidebar.category.Modifiers": { - "message": "修饰符", - "description": "The label for category Modifiers in sidebar Sidebar" - }, - "sidebar.Sidebar.category.Guides": { - "message": "指南", - "description": "The label for category Guides in sidebar Sidebar" - }, - "sidebar.Sidebar.category.Migration": { + "sidebar.Sidebar.category.Migration guides": { "message": "迁移指南", - "description": "The label for category Migration in sidebar Sidebar" + "description": "The label for category Migration guides in sidebar Sidebar" }, "sidebar.Sidebar.category.Official examples": { "message": "官方示例", @@ -31,6 +39,22 @@ "message": "第三方示例", "description": "The label for category Third party examples in sidebar Sidebar" }, + "sidebar.Sidebar.category.Concepts (old)": { + "message": "概念（旧）", + "description": "The label for category Concepts (old) in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Modifiers": { + "message": "修饰符", + "description": "The label for category Modifiers in sidebar Sidebar" + }, + "sidebar.Sidebar.category.All Providers (old)": { + "message": "提供者程序类型（旧）", + "description": "The label for category All Providers (old) in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Guides (old)": { + "message": "指南（旧）", + "description": "The label for category Guides (old) in sidebar Sidebar" + }, "sidebar.Sidebar.link.Counter": { "message": "计数器", "description": "The label for link Counter in sidebar Sidebar, linking to https://github.com/rrousselGit/riverpod/tree/master/examples/counter" @@ -60,27 +84,27 @@ "description": "The label for link Dictionary App in sidebar Sidebar, linking to https://github.com/lohanidamodar/fl_dictio" }, "sidebar.Sidebar.link.Time Tracking App (with Firebase)": { - "message": "时间追踪应用 (使用Firebase)", + "message": "时间追踪应用（使用 Firebase）", "description": "The label for link Time Tracking App (with Firebase) in sidebar Sidebar, linking to https://github.com/bizz84/starter_architecture_flutter_firebase" }, "sidebar.Sidebar.link.Firebase Phone Authentication with Riverpod": { - "message": "Firebase Phone Authentication with Riverpod", + "message": "使用 Riverpod 的 Firebase 手机号验证", "description": "The label for link Firebase Phone Authentication with Riverpod in sidebar Sidebar, linking to https://github.com/julienlebren/flutter_firebase_phone_auth_riverpod" }, "sidebar.Sidebar.link.ListView paging with search": { "message": "带搜索栏的列表分页", "description": "The label for link ListView paging with search in sidebar Sidebar, linking to https://github.com/tbm98/flutter_loadmore_search" }, - "sidebar.Sidebar.link.Resocoder's Weather Bloc to Weather Riverpod": { - "message": "Resocoder's Weather Bloc to Weather Riverpod", - "description": "The label for link Resocoder's Weather Bloc to Weather Riverpod in sidebar Sidebar, linking to https://github.com/campanagerald/flutter-bloc-library-v1-tutorial" + "sidebar.Sidebar.link.Resocoder's Weather Bloc to Weather Riverpod V2": { + "message": "Resocoder 的天气应用迁移从 Bloc 到 Riverpod V2", + "description": "The label for link Resocoder's Weather Bloc to Weather Riverpod V2 in sidebar Sidebar, linking to https://github.com/coyksdev/flutter-bloc-library-v1-tutorial" }, "sidebar.Sidebar.link.Blood Pressure Tracker App": { "message": "血压记录应用", "description": "The label for link Blood Pressure Tracker App in sidebar Sidebar, linking to https://github.com/UrosTodosijevic/blood_pressure_tracker" }, "sidebar.Sidebar.link.Firebase Authentication with Riverpod Following Flutter DDD Architecture Pattern": { - "message": "Firebase Authentication with Riverpod Following Flutter DDD Architecture Pattern", + "message": "使用 Riverpod 并遵循领域驱动开发（DDD）架构模式的 Firebase 验证", "description": "The label for link Firebase Authentication with Riverpod Following Flutter DDD Architecture Pattern in sidebar Sidebar, linking to https://github.com/pythonhubpy/firebase_authentication_flutter_DDD" }, "sidebar.Sidebar.link.Todo App with Backup and Restore feature": { @@ -88,15 +112,15 @@ "description": "The label for link Todo App with Backup and Restore feature in sidebar Sidebar, linking to https://github.com/TheAlphaApp/flutter_riverpod_todo_app" }, "sidebar.Sidebar.link.Integrating Hive database with Riverpod (simple example)": { - "message": "将Hive数据库与Riverpod集成 (简单示例)", + "message": "将 Hive 数据库与 Riverpod 集成（简单示例）", "description": "The label for link Integrating Hive database with Riverpod (simple example) in sidebar Sidebar, linking to https://github.com/GitGud31/theme_riverpod_hive" }, "sidebar.Sidebar.link.Browser App with Riverpod": { - "message": "使用Riverpod的浏览器应用", + "message": "使用 Riverpod 的浏览器应用", "description": "The label for link Browser App with Riverpod in sidebar Sidebar, linking to https://github.com/MarioCroSite/simple_browser_app" }, "sidebar.Sidebar.link.GoRouter with Riverpod": { - "message": "将GoRouter与Riverpod集成", + "message": "将 GoRouter 与 Riverpod 集成", "description": "The label for link GoRouter with Riverpod in sidebar Sidebar, linking to https://github.com/lucavenir/go_router_riverpod" }, "sidebar.Sidebar.link.Piano Chords Test": { @@ -104,13 +128,21 @@ "description": "The label for link Piano Chords Test in sidebar Sidebar, linking to https://github.com/akvus/piano_fun" }, "sidebar.Sidebar.link.Movies API App with Caching & Pagination": { - "message": "带缓存和分页功能的电影应用", + "message": "带缓存和分页功能的电影 API 应用", "description": "The label for link Movies API App with Caching & Pagination in sidebar Sidebar, linking to https://github.com/Roaa94/movies_app" }, "sidebar.Sidebar.link.AWS Amplify Storage Gallery App with Riverpod & Freezed": { - "message": "AWS Amplify Storage Gallery App with Riverpod & Freezed", + "message": "使用 Riverpod 和 Freezed 的 AWS Amplify 存储图片应用", "description": "The label for link AWS Amplify Storage Gallery App with Riverpod & Freezed in sidebar Sidebar, linking to https://github.com/offlineprogrammer/amplify_storage_app" }, + "sidebar.Sidebar.link.Clean Architecture demonstration with Riverpod": { + "message": "Riverpod 实现 Clean 架构的示范", + "description": "The label for link Clean Architecture demonstration with Riverpod in sidebar Sidebar, linking to https://github.com/Uuttssaavv/flutter-clean-architecture-riverpod" + }, + "sidebar.Sidebar.link.Delivery App with Google Maps and Live Tracking": { + "message": "具备谷歌地图和在线追踪功能的送货应用", + "description": "The label for link Delivery App with Google Maps and Live Tracking in sidebar Sidebar, linking to https://github.com/AhmedLSayed9/deliverzler" + }, "sidebar.Sidebar.link.API reference": { "message": "API 参考", "description": "The label for link API reference in sidebar Sidebar, linking to https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/hooks_riverpod-library.html" diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_code_generation.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_code_generation.mdx deleted file mode 100644 index 737a92e49..000000000 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_code_generation.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: 关于代码生成 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import fetchUser from "!!raw-loader!./about_codegen/main.dart"; -import rawFetchUser from "!!raw-loader!./about_codegen/raw.dart"; -import { - trimSnippet, - CodeSnippet, -} from "../../../../src/components/CodeSnippet"; - -代码生成是指使用工具为我们生成代码。 -在Dart中，它的缺点是需要额外的步骤来“编译”应用。 -尽管这个问题可能会在不久的将来得到解决， -但Dart团队正在研究并解决这个问题的潜在方案。 - -在Riverpod的上下文中，代码生成就是稍微改变定义“provider”的语法。打个比方，原本我们这样写： - -{trimSnippet(rawFetchUser)} - -使用代码生成，我们会写： - -{trimSnippet(fetchUser)} - -使用Riverpod时，代码生成是完全可选的。 当然你也完全可以不使用。 -与此同时，Riverpod支持代码生成，且推荐你使用它。 - -有关如何安装和使用Riverpod的代码生成器的信息， -请参阅[开始上手](./getting_started)页面。确保在文档的侧边栏中启用代码生成。 - -## 为什么在Riverpod中使用代码生成？ - -你可能在想：“如果在Riverpod中代码生成是可选的，为什么要使用？” - -让你的代码生活更简单。 -这包括但不限于： - -- 更好的语法, 更可读且更灵活，而且还能减少学习曲线。 - - 不需要担心`FutureProvider`、`Provider` 还是其他 provider。仅需写下你的逻辑， - Riverpod将为你选择最合适的provider。 - - 向provider传递参数现在不受限制。不再局限于使用 [family](./concepts/modifiers/family) 和传递单个参数， - 现在可以传递任何形式的参数。这包括命名参数、可选参数甚至默认值。 -- 在Riverpod中编写的代码支持 **有状态热重载**。 -- 更好地调试，通过生成额外的元数据然后用调试器调试。 -- Riverpod的一些功能将只支持代码生成。 - -与此同时，许多应用程序中已经使用了代码生成比如 [Freezed](https://pub.dev/packages/freezed) 或 [json_serializable](https://pub.dev/packages/json_serializable)。 -在这种情况下，你的项目可能已经为代码生成配置好了，使用Riverpod应该很简单。 - -[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html -[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html -[riverpod]: https://github.com/rrousselgit/riverpod -[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod -[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod -[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_hooks.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_hooks.mdx deleted file mode 100644 index 718985c60..000000000 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_hooks.mdx +++ /dev/null @@ -1,272 +0,0 @@ ---- -title: 关于钩子 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import pubspec from "./getting_started/pubspec"; -import dartHelloWorld from "./getting_started/dart_hello_world"; -import helloWorld from "./getting_started/hello_world"; -import dartPubspec from "./getting_started/dart_pubspec"; -import { - trimSnippet, - AutoSnippet, - When, -} from "../../../../src/components/CodeSnippet"; - -本页解释了什么是钩子，以及它们如何与Riverpod相关。 - -“Hooks”是独立于Riverpod: [flutter_hooks] 的package中的常用工具。 -尽管 [flutter_hooks] 是一个完全独立的package，与Riverpod没有任何关系(至少没有直接关系)， -但将Riverpod和 [flutter_hooks] 放在一起很常见。 -毕竟，Riverpod和 [flutter_hooks] 是由同一个团队维护的。 - -钩子是完全可选的。特别是如果你刚开始使用Flutter，那么你不必使用钩子。 -虽然它们是很强大的工具，但没有Flutter的那个“味”。 -所以，入门选择使用Flutter和Riverpod这样的搭配。当你有更多相关的经验时，那么你可以回来尝试一下钩子。 - -## 什么是钩子？ - -钩子是在widget中使用的函数。它们被设计为 [StatefulWidget] 的替代品，以使逻辑更具可重用性和可组合性。 - -Hooks是一个来自 [React](https://reactjs.org/) 的概念， -而 [flutter_hooks] 仅仅是Flutter的一个React实现。 -所以是的，在Flutter中钩子可能感觉有点不合适。 -理想情况下，将来我们会有专门为Flutter设计的用钩子解决问题的解决方案。 - -如果说Riverpod的provider是针对“全局”应用状态的，钩子则是针对本地widget的状态。 -钩子通常用于处理有状态的UI对象，如 [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html), -[AnimationController](https://api.flutter.dev/flutter/animation/AnimationController-class.html)。 -它们也可以作为“构建器(builder)”模式的替代品， -用不涉及“嵌套”的替代品来替换 [FutureBuilder](https://api.flutter.dev/flutter/widgets/FutureBuilder-class.html)/[TweenAnimatedBuilder](https://api.flutter.dev/flutter/widgets/TweenAnimationBuilder-class.html) 之类的widget——极大地提高了可读性。 - -一般来说，钩子有助于： - -- 表单 -- 动画 -- 响应用户事件 -- …… - -例如，我们可以使用钩子手动实现淡入动画，其中widget开始时不可见，然后慢慢出现。 - -如果我们使用 [StatefulWidget],，代码看起来会像这样： - -```dart -class FadeIn extends StatefulWidget { - const FadeIn({Key? key, required this.child}) : super(key: key); - - final Widget child; - - @override - State createState() => _FadeInState(); -} - -class _FadeInState extends State with SingleTickerProviderStateMixin { - late final AnimationController animationController = AnimationController( - vsync: this, - duration: const Duration(seconds: 2), - ); - - @override - void initState() { - super.initState(); - animationController.forward(); - } - - @override - void dispose() { - animationController.dispose(); - super.dispose(); - } - - @override - Widget build(BuildContext context) { - return AnimatedBuilder( - animation: animationController, - builder: (context, child) { - return Opacity( - opacity: animationController.value, - child: widget.child, - ); - }, - ); - } -} -``` - -使用钩子会是： - -```dart -class FadeIn extends HookWidget { - const FadeIn({Key? key, required this.child}) : super(key: key); - - final Widget child; - - @override - Widget build(BuildContext context) { - // Create an AnimationController. The controller will automatically be - // disposed when the widget is unmounted. - final animationController = useAnimationController( - duration: const Duration(seconds: 2), - ); - - // useEffect is the equivalent of initState + didUpdateWidget + dispose. - // The callback passed to useEffect is executed the first time the hook is - // invoked, and then whenever the list passed as second parameter changes. - // Since we pass an empty const list here, that's strictly equivalent to `initState`. - useEffect(() { - // start the animation when the widget is first rendered. - animationController.forward(); - // We could optionally return some "dispose" logic here - return null; - }, const []); - - // Tell Flutter to rebuild this widget when the animation updates. - // This is equivalent to AnimatedBuilder - useAnimation(animationController); - - return Opacity( - opacity: animationController.value, - child: child, - ); - } -} -``` - -在这段代码中有一些有趣的事情需要注意： - -- 不存在内存泄漏。这段代码不会在widget重新构建时重新创建一个新的 `AnimationController`， - 并且它在widget销毁时正确地释放控制器。 - -- 在同一个小部件中，可以任意多次地使用钩子。 - 因此，如果我们想要我们可以创建多个 `AnimationController`： - - ```dart - @override - Widget build(BuildContext context) { - final animationController = useAnimationController( - duration: const Duration(seconds: 2), - ); - final anotherController = useAnimationController( - duration: const Duration(seconds: 2), - ); - - ... - } - ``` - - 这创建了两个控制器，但没有任何负面效果。 - -- 如果我们愿意，我们可以将这个逻辑重构为一个单独的可重用函数： - - ```dart - double useFadeIn() { - final animationController = useAnimationController( - duration: const Duration(seconds: 2), - ); - useEffect(() { - animationController.forward(); - return null; - }, const []); - useAnimation(animationController); - return animationController.value; - } - ``` - - 然后我们可以在widget中使用这个函数，只要那个widget是[HookWidget]： - - ```dart - class FadeIn extends HookWidget { - const FadeIn({Key? key, required this.child}) : super(key: key); - - final Widget child; - - @override - Widget build(BuildContext context) { - final fade = useFadeIn(); - - return Opacity(opacity: fade, child: child); - } - } - ``` - - 注意我们的 `useFadeIn` 函数是如何完全独立于我们的 `FadeIn` widget的。 - 如果我们愿意，我们可以在一个完全不同的widget中使用 `useFadeIn` 函数，它仍然也可以工作! - -## 如何使用钩子 - -钩子有独特的约束条件： - -- 它们只能在扩展了 [HookWidget] 的widget的 `build` 方法中使用： - - **正确**: - - ```dart - class Example extends HookWidget { - @override - Widget build(BuildContext context) { - final controller = useAnimationController(); - ... - } - } - ``` - - **错误**: - - ```dart - // 不是一个HookWidget - class Example extends StatelessWidget { - @override - Widget build(BuildContext context) { - final controller = useAnimationController(); - ... - } - } - ``` - - **错误**: - - ```dart - class Example extends HookWidget { - @override - Widget build(BuildContext context) { - return ElevatedButton( - onPressed: () { - // Not _actually_ inside the "build" method, but instead inside - // a user interaction lifecycle (here "on pressed"). - final controller = useAnimationController(); - }, - child: Text('click me'), - ); - } - } - ``` - -- 它们不能在条件语句或循环语句内使用。 - - **错误**: - - ```dart - class Example extends HookWidget { - const Example({required this.condition, super.key}); - final bool condition; - @override - Widget build(BuildContext context) { - if (condition) { - // Hooks should not be used inside "if"s/"for"s, ... - final controller = useAnimationController(); - } - ... - } - } - ``` - -有关钩子的更多信息，请参见 [flutter_hooks]。 - -[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html -[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html -[riverpod]: https://github.com/rrousselgit/riverpod -[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod -[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod -[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select.mdx new file mode 100644 index 000000000..d020b217b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select.mdx @@ -0,0 +1,129 @@ +--- +title: 性能优化 +--- + +import { AutoSnippet } from "@site/src/components/CodeSnippet"; +import select from "./select/select"; + +import selectAsync from "./select/select_async"; + + +通过到目前为止我们所看到的一切，我们已经可以构建一个功能齐全的应用程序。 +但是，您可能对性能有疑问。 + + +在本页中，我们将介绍一些可能优化代码的提示和技巧。 + +:::caution + +在进行任何优化之前，请确保对您的应用程序进行基准测试。 +优化所增加的复杂性可能不值得微小的收益。 +::: + + +## 使用 "select" 过滤小部件或提供者程序的重建。 + + +您已经注意到，默认情况下，只要对象的任何属性发生更改， +使用 `ref.watch` 都会导致消费者程序或提供者程序进行重建。 +例如，观察 `User` 并仅使用其 "name"， +如果 "age" 发生变化，仍然会导致消费者程序重建。 + + +但如果您的使用者仅使用属性的子集， +您希望避免在其他属性更改时重建小部件。 + + +这可以通过使用提供者程序的 `select` 功能来实现。 +这样做时，`ref.watch` 将不再返回完整对象， +而是返回选定的属性。 +现在，仅当这些选定的属性发生变化时， +您的消费者程序或提供者程序才会重建。 + + + +:::info + +您可以根据需要多次调用 `select`。 +您可以为您想要的每个属性自由调用一次。 +::: + +:::caution + +所选属性希望是不可变的对象。 +返回 `List` 然后改变该列表不会触发重建。 +::: + +:::caution + +使用 `select` 会稍微减慢单个读取操作的速度， +并稍微增加代码的复杂性。 +如果那些“其他属性”很少改变，那么可能不值得使用它。 +::: + + +### 选择异步属性​ + + +考虑一种情况，如果您尝试优化一个监听其他提供者程序的提供者程序， +其他提供者程序很可能是异步的。 + + +通常，您可以使用 `ref.watch(anotherProvider.future)` 来获取该值。 +问题是，`select` 将应用于 `AsyncValue` - 这不是您可以等待的事情。 + + +为此，您可以使用 `selectAsync`。它是异步代码所独有的， +并且允许对提供者程序发出的数据执行 `select` 操作。 +它的用法与 `select` 类似，但返回一个 `Future` 类型： + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart new file mode 100644 index 000000000..f0d79bff2 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart @@ -0,0 +1,30 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +class User { + late String firstName, lastName; +} + +@riverpod +User example(ExampleRef ref) => User() + ..firstName = 'John' + ..lastName = 'Doe'; + +class ConsumerExample extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 替代这种写法: + // String name = ref.watch(provider).firstName!; + // 我们可以写： + String name = ref.watch(exampleProvider.select((it) => it.firstName)); + // 这将导致 widget 只监听 "firstName" 上的更改。 + + return Text('Hello $name'); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart new file mode 100644 index 000000000..9e44ffe6d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'72881c6147d44adb957180debefe7696d93107f0'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart new file mode 100644 index 000000000..c39bc426d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart @@ -0,0 +1,29 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class User { + late String firstName, lastName; +} + +final provider = Provider( + (ref) => User() + ..firstName = 'John' + ..lastName = 'Doe', +); + +class ConsumerExample extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 替代这种写法： + // String name = ref.watch(provider).firstName!; + // 我们可以写： + String name = ref.watch(provider.select((it) => it.firstName)); + // 这将导致 widget 只监听 "firstName" 上的更改。 + + return Text('Hello $name'); + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart new file mode 100644 index 000000000..fe57e77d3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart @@ -0,0 +1,26 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors, body_might_complete_normally_nullable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class User { + late String firstName, lastName; +} + +final userProvider = FutureProvider( + (ref) => User() + ..firstName = 'John' + ..lastName = 'Doe', +); +/* SNIPPET START */ +@riverpod +Object? example(ExampleRef ref) async { + // 等待 user 可用，并只监听 "firstName" 属性 + final firstName = await ref.watch( + userProvider.selectAsync((it) => it.firstName), + ); + + // TODO 使用 "firstName" 获取其他信息 +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart new file mode 100644 index 000000000..1f422ec8a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'1fccbdbec0e3585bc9d3a5709ac88a8919dd78fa'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart new file mode 100644 index 000000000..719f2cf2d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class User { + late String firstName, lastName; +} + +final userProvider = FutureProvider( + (ref) => User() + ..firstName = 'John' + ..lastName = 'Doe', +); +/* SNIPPET START */ +final provider = FutureProvider((ref) async { + // 等待 user 可用，并只监听 "firstName" 属性 + final firstName = await ref.watch( + userProvider.selectAsync((it) => it.firstName), + ); + + // TODO 使用 "firstName" 获取其他信息 +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx new file mode 100644 index 000000000..b5a31fb6c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx @@ -0,0 +1,278 @@ +--- +title: 网络请求的去抖动或取消 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import homeScreen from "!raw-loader!./cancel/home_screen.dart"; +import extension from "!raw-loader!./cancel/extension.dart"; +import detailScreen from "./cancel/detail_screen"; +import detailScreenCancel from "./cancel/detail_screen_cancel"; +import detailScreenDebounce from "./cancel/detail_screen_debounce"; +import providerWithExtension from "./cancel/provider_with_extension"; + + +随着应用程序变得越来越复杂，同时处理多个网络请求是很常见的。 +例如，用户可能在搜索框中键入内容并为每次击键触发新的请求。 +如果用户打字速度很快，应用程序可能会同时处理许多请求。 + + +或者，用户可能会触发请求，然后在请求完成之前导航到不同的页面。 +在这种情况下，应用程序可能有一个不再需要的正在运行的请求。 + + +要在这些情况下优化性能，您可以使用以下几种技术： + + +- “去抖动”请求。这意味着您要等到用户停止输入一段时间后再发送请求。 + 这可确保即使用户键入速度很快，您也只会针对给定输入发送一个请求。 +- “取消”请求。这意味着如果用户在请求完成之前离开页面，您将取消请求。 + 这可确保您不会浪费时间处理用户永远不会看到的响应。 + + +在 Riverpod 中，这两种技术都可以以类似的方式实现。 +关键是使用 `ref.onDispose` 方法与“自动处置”或 `ref.watch` +结合来实现所需的行为。 + + +为了展示这一点，我们将制作一个包含两个页面的简单应用程序： + + +- 主屏幕，带有打开新页面的按钮 +- 详细信息页面，显示来自 [Bored API](https://www.boredapi.com/) + 的随机活动，并且能够刷新活动。 + 有关如何实现下拉刷新的信息， + 请参阅。 + + +然后我们将实现以下行为： + + +- 如果用户打开详细信息页面然后立即导航回来， + 我们将取消该活动的请求。 +- 如果用户连续多次刷新活动，我们将对请求进行去抖动， + 以便在用户停止刷新后仅发送一个请求。 + + +## 应用​ + + +展示应用程序、打开详细页面和刷新活动的 Gif。 + + +首先，让我们创建应用程序，不进行任何去抖动或取消操作。 +我们不会在这里使用任何花哨的东西，而是坚持使用普通的 `FloatingActionButton` +和 `Navigator.push` 来打开详细信息页面。 + + +首先，让我们从定义主屏幕开始。像往常一样， +我们不要忘记在应用程序的根组件上指定 `ProviderScope` 。 + + + + +然后，让我们定义我们的详细信息页面。 +要获取活动并实施下拉刷新， +请参阅应用案例。 + + + + +## 取消请求 + + +现在我们有了一个可以运行的应用程序，让我们实现取消逻辑。 + + +为此，我们将在用户离开页面时使用 `ref.onDispose` 取消请求。 +为了使其运作，启用提供者程序的自动处置非常重要。 + + +取消请求所需的确切代码取决于 HTTP 客户端。 +在此示例中，我们将使用 `package:http` ， +但相同的原则也适用于其他客户端。 + + +这里的关键点是当用户离开时将调用 `ref.onDispose`。 +这是因为我们的提供者程序不再使用，因此通过自动处置进行了处置。 +因此，我们可以使用此回调来取消请求。 +当使用 `package:http` 时，可以通过关闭 HTTP 客户端来完成。 + + + + +## 请求​去抖 + + +现在我们已经实现了取消，让我们实现去抖动。 +目前，如果用户连续多次刷新活动， +我们将为每次刷新发送一个请求。 + + +从技术上来说，既然我们已经实行了取消，这就不成问题了。 +如果用户连续多次刷新活动， +则当发出新请求时，先前的请求将被取消。 + + +然而，这并不理想。我们仍然发送多个请求， +浪费带宽和服务器资源。 +相反，我们可以做的是延迟我们的请求， +直到用户在固定的时间内停止刷新活动。 + + +这里的逻辑和取消逻辑非常相似。 +我们将再次使用 `ref.onDispose`。然而，这里的想法是， +我们将依靠 `onDispose` 在请求开始之前中止请求， +而不是关闭 HTTP 客户端。 +然后我们会任意等待 500ms，然后再发送请求。 +然后，如果用户在 500 毫秒过去之前再次刷新活动， +将调用 `onDispose` 并中止请求。 + +:::info + +要中止请求，常见的做法是主动抛出。 +在提供者程序被处置后，将提供者程序内部抛出异常是安全的。 +该异常自然会被 Riverpod 捕获并被忽略。 +::: + + + + +## 更进一步：同时做这两件事​ + + +我们现在知道如何取消和取消请求。 +但目前，如果我们想做另一个请求， +我们需要将相同的逻辑复制粘贴到多个位置。这并不理想。 + + +然而，我们可以更进一步，实现一个可重用的实用程序来同时完成这两个任务。 + + +这里的想法是在 `Ref` 上实现一个扩展方法， +该方法将在单个方法中处理取消和去抖。 + + + + +然后我们可以在我们的提供者程序中使用此扩展方法，如下所示： + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart new file mode 100644 index 000000000..e3bf193a2 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart @@ -0,0 +1,61 @@ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +/* SNIPPET START */ +@freezed +class Activity with _$Activity { + factory Activity({ + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + factory Activity.fromJson(Map json) => + _$ActivityFromJson(json); +} + +@riverpod +Future activity(ActivityRef ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} + +class DetailPageView extends ConsumerWidget { + const DetailPageView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar( + title: const Text('Detail page'), + ), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const Center(child: CircularProgressIndicator()), + }, + ], + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart new file mode 100644 index 000000000..1020def96 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart @@ -0,0 +1,209 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart new file mode 100644 index 000000000..4d688e552 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart @@ -0,0 +1,46 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +/// See also [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart new file mode 100644 index 000000000..b3ad1faaf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart @@ -0,0 +1,65 @@ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +/* SNIPPET START */ +class Activity { + Activity({ + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + factory Activity.fromJson(Map json) { + return Activity( + activity: json['activity']! as String, + type: json['type']! as String, + participants: json['participants']! as int, + price: json['price']! as double, + ); + } + + final String activity; + final String type; + final int participants; + final double price; +} + +final activityProvider = FutureProvider.autoDispose((ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); + +class DetailPageView extends ConsumerWidget { + const DetailPageView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar( + title: const Text('Detail page'), + ), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const Center(child: CircularProgressIndicator()), + }, + ], + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart new file mode 100644 index 000000000..004f47430 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart @@ -0,0 +1,28 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../detail_screen/codegen.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + // 我们使用 package:http 创建一个 HTTP 客户端 + final client = http.Client(); + // 处置时，我们会关闭客户端。 + // 这将取消客户端可能有的任何待处理请求。 + ref.onDispose(client.close); + + // 现在，我们使用客户端提出请求，而不是使用 "get "函数。 + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + // 其余代码与之前的相同 + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart new file mode 100644 index 000000000..67a5099bf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'304864a6b8051925061a2bba397574ec45b94d08'; + +/// See also [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart new file mode 100644 index 000000000..86d8f9390 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart @@ -0,0 +1,25 @@ +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import '../detail_screen/codegen.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + // 我们使用 package:http 创建一个 HTTP 客户端 + final client = http.Client(); + // 处置时，我们会关闭客户端。 + // 这将取消客户端可能有的任何待处理请求。 + ref.onDispose(client.close); + + // 现在，我们使用客户端提出请求，而不是使用 "get "函数。 + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + // 其余代码与之前的相同 + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart new file mode 100644 index 000000000..69844a261 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart @@ -0,0 +1,38 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../detail_screen/codegen.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + // 我们会捕捉提供者程序目前是否已被处置。 + var didDispose = false; + ref.onDispose(() => didDispose = true); + + // 我们将请求延迟 500 毫秒，以等待用户停止刷新。 + await Future.delayed(const Duration(milliseconds: 500)); + + // 如果在延迟期间处理了提供者程序，则意味着用户再次刷新了请求。 + // 我们会抛出一个异常来取消请求。 + // 在这里使用异常是安全的，因为它会被 Riverpod 捕捉到。 + if (didDispose) { + throw Exception('Cancelled'); + } + + // 以下代码与之前的代码片段保持不变 + final client = http.Client(); + ref.onDispose(client.close); + + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart new file mode 100644 index 000000000..2f62270bc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'ef908e3b46693862f082769663b14d5369d6e155'; + +/// See also [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart new file mode 100644 index 000000000..a8f7b76ae --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart @@ -0,0 +1,35 @@ +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import '../detail_screen/codegen.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + // 我们会捕捉提供者程序目前是否已被处置。 + var didDispose = false; + ref.onDispose(() => didDispose = true); + + // 我们将请求延迟 500 毫秒，以等待用户停止刷新。 + await Future.delayed(const Duration(milliseconds: 500)); + + // 如果在延迟期间处理了提供者程序，则意味着用户再次刷新了请求。 + // 我们会抛出一个异常来取消请求。 + // 在这里使用异常是安全的，因为它会被 Riverpod 捕捉到。 + if (didDispose) { + throw Exception('Cancelled'); + } + + // 以下代码与之前的代码片段保持不变 + final client = http.Client(); + ref.onDispose(client.close); + + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart new file mode 100644 index 000000000..8a06acb22 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart @@ -0,0 +1,32 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +/* SNIPPET START */ +extension DebounceAndCancelExtension on Ref { + /// 等待 [duration]（默认为 500ms）， + /// 然后返回一个 [http.Client]，用于发出请求。 + /// + /// 当提供者程序被处置时，该客户端将自动关闭。 + Future getDebouncedHttpClient([Duration? duration]) async { + // 首先，我们要处理去抖问题。 + var didDispose = false; + onDispose(() => didDispose = true); + + // 我们将请求延迟 500 毫秒，以等待用户停止刷新。 + await Future.delayed(duration ?? const Duration(milliseconds: 500)); + + // 如果在延迟期间处理了提供者程序，则意味着用户再次刷新了请求。 + // 我们会抛出一个异常来取消请求。 + // 在这里使用异常是安全的，因为它会被 Riverpod 捕捉到。 + if (didDispose) { + throw Exception('Cancelled'); + } + + // 现在我们创建客户端，并在处理提供者程序时关闭客户端。 + final client = http.Client(); + onDispose(client.close); + + // 最后，我们返回客户端，让我们的提供者程序提出请求。 + return client; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart new file mode 100644 index 000000000..28f0c50cf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart @@ -0,0 +1,39 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'detail_screen/codegen.dart'; + +/* SNIPPET START */ +void main() => runApp(const ProviderScope(child: MyApp())); + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return MaterialApp( + routes: { + '/detail-page': (_) => const DetailPageView(), + }, + home: const ActivityView(), + ); + } +} + +class ActivityView extends ConsumerWidget { + const ActivityView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + appBar: AppBar(title: const Text('Home screen')), + body: const Center( + child: Text('Click the button to open the detail page'), + ), + floatingActionButton: FloatingActionButton( + onPressed: () => Navigator.of(context).pushNamed('/detail-page'), + child: const Icon(Icons.add), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart new file mode 100644 index 000000000..4adab910f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart @@ -0,0 +1,25 @@ +import 'dart:convert'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../detail_screen/codegen.dart'; +import '../extension.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + // 我们使用之前创建的扩展来获取 HTTP 客户端。 + final client = await ref.getDebouncedHttpClient(); + + // 现在，我们使用客户端而不是 "get "函数来发出请求。 + // 如果用户离开页面，我们的请求自然会被取消。 + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart new file mode 100644 index 000000000..7c8195c7b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'f045dd6e89fde6bbe12a89f243290d289a3e692d'; + +/// See also [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart new file mode 100644 index 000000000..7e445b37b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart @@ -0,0 +1,22 @@ +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../detail_screen/codegen.dart'; +import '../extension.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + // 我们使用之前创建的扩展来获取 HTTP 客户端。 + final client = await ref.getDebouncedHttpClient(); + + // 现在，我们使用客户端而不是 "get "函数来发出请求。 + // 如果用户离开页面，我们的请求自然会被取消。 + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx new file mode 100644 index 000000000..c308e42de --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx @@ -0,0 +1,253 @@ +--- +title: 下拉刷新 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import activity from "./pull_to_refresh/activity"; +import fetchActivity from "./pull_to_refresh/fetch_activity"; +import displayActivity from "!!raw-loader!./pull_to_refresh/display_activity.dart"; +import displayActivity2 from "!!raw-loader!./pull_to_refresh/display_activity2.dart"; +import displayActivity3 from "!!raw-loader!./pull_to_refresh/display_activity3.dart"; +import displayActivity4 from "!!raw-loader!./pull_to_refresh/display_activity4.dart"; +import fullApp from "./pull_to_refresh/full_app"; + + +由于其声明性，Riverpod 本身就支持拉动刷新。 + + +一般来说，拉动刷新可能很复杂，因为有多个问题需要解决： + + +- 第一次进入页面时，我们想要显示一个微调器（spinner）。 + 但在重刷新期间，我们希望显示刷新指示器。 + 我们不应该同时显示刷新指示器_和_微调器。 +- 当刷新挂起时，我们希望显示以前的数据/错误。 +- 只要重刷新发生，我们就需要显示刷新指示器。 + + +让我们看看如何使用 Riverpod 解决这个问题。 +为此，我们将制作一个简单的示例，向用户推荐随机活动。 +并且进行下拉刷新将触发新的建议： + + +上面描述的应用软件工作时的 gif + + +## 制作一个简单的应用程序。​ + + +在实现下拉刷新之前，我们首先需要刷新一些东西。 +我们可以制作一个简单的应用程序，使用 [Bored API](https://www.boredapi.com/) +向用户建议随机活动。 + + +首先，我们定义一个 `Activity` 类： + + + + +该类将负责以类型安全的方式表示建议的活动，并处理 JSON 编码/解码。 +使用 Freezed/json_serialized 不是必需的，但建议使用。 + + +现在，我们要定义一个提供者程序发出 HTTP GET 请求来获取单个活动： + + + + +我们现在可以使用此提供者程序来显示随机活动。 +目前，我们不会处理加载/错误状态，而只是在可用时显示活动： + + + + +## 添加 `RefreshIndicator` + + +现在我们有了一个简单的应用程序，我们可以向它添加一个 `RefreshIndicator`。 +该小部件是一个官方的 Material 小部件，负责在用户下拉屏幕时显示刷新指示器。 + + +使用 `RefreshIndicator` 需要一个可滚动的表面。但到目前为止，我们还没有。 +我们可以通过使用 `ListView`/`GridView`/`SingleChildScrollView` 等等来解决这个问题： + + + + +用户现在可以下拉屏幕。但我们的数据还没有刷新。 + + +## 添加刷新逻辑​ + + +当用户下拉屏幕时，`RefreshIndicator` 将调用 +`onRefresh` 回调。我们可以使用该回调来刷新我们的数据。 +在那里，我们可以使用 `ref.refresh` 刷新我们选择的提供者程序。 + + +**注意**：`onRefresh` 期望返回一个 `Future`。 +刷新完成后，future 的完成非常重要。 + + +为了获得这样的 future，我们可以读取提供者程序的 `.future` 属性。 +这将返回一个 future，该 future 在我们的提供者程序解决后完成。 + + +因此，我们可以将 `RefreshIndicator` 更新为如下所示： + + + + +## 仅在初始加载和处理错误期间显示微调器。 + + +目前，我们的 UI 不处理错误/加载状态。 +相反，当加载/刷新完成时，数据会神奇地弹出。 + + +让我们通过优雅地处理这些状态来改变这一点。有两种情况： + + +- 在初始加载期间，我们希望显示全屏微调器。 +- 在刷新期间，我们希望显示刷新指示器和之前的数据/错误。 + + +幸运的是，当在 Riverpod 中监听异步提供者程序时， +Riverpod 为我们提供了一个 `AsyncValue` ，它提供了我们需要的一切。 + + +然后可以将 `AsyncValue` 与 Dart 3.0 的模式匹配结合起来，如下所示： + + + +:::caution + +我们在这里使用 `valueOrNull`，就像目前一样， +如果处于错误/加载状态，则使用 `value` 会抛出异常。 + + +Riverpod 3.0 将对此进行更改，使 `value` 的行为类似于 `valueOrNull`。 +但现在，让我们坚持使用 `valueOrNull`。 +::: + +:::tip + +请注意我们的模式匹配中 `:final valueOrNull?` 语法的使用。 +只能使用此语法，因为 `activityProvider` 返回不可为 null 的 `Activity`。 + + +如果您的数据可以是 `null`，则可以使用 `AsyncValue(hasData: true, :final valueOrNull)`。 +这将正确处理数据为 `null` 的情况，但需要一些额外的字符。 +::: + + +## 总结：完整的应用 + + +以下是组合了我们迄今为止所涵盖的所有内容的源码： + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart new file mode 100644 index 000000000..ac3e1b17d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart @@ -0,0 +1,19 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; + +part 'codegen.g.dart'; +part 'codegen.freezed.dart'; + +/* SNIPPET START */ +@freezed +class Activity with _$Activity { + factory Activity({ + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + factory Activity.fromJson(Map json) => + _$ActivityFromJson(json); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart new file mode 100644 index 000000000..1020def96 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart @@ -0,0 +1,209 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart new file mode 100644 index 000000000..79ae3cd00 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart @@ -0,0 +1,25 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart new file mode 100644 index 000000000..42365b7bb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart @@ -0,0 +1,24 @@ +/* SNIPPET START */ +class Activity { + Activity({ + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + factory Activity.fromJson(Map json) { + return Activity( + activity: json['activity']! as String, + type: json['type']! as String, + participants: json['participants']! as int, + price: json['price']! as double, + ); + } + + final String activity; + final String type; + final int participants; + final double price; +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart new file mode 100644 index 000000000..4e4d03305 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart @@ -0,0 +1,22 @@ +// ignore_for_file: use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: Center( + // 如果有活动，则显示，否则等待 + child: Text(activity.valueOrNull?.activity ?? ''), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart new file mode 100644 index 000000000..7394ea664 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + /* highlight-start */ + body: RefreshIndicator( + onRefresh: () async => print('refresh'), + child: ListView( + children: [ + /* highlight-end */ + Text(activity.valueOrNull?.activity ?? ''), + ], + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart new file mode 100644 index 000000000..bc41065fe --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart @@ -0,0 +1,30 @@ +// ignore_for_file: avoid_print, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + // 通过重刷新调用 "activityProvider.future" 并返回结果， + // 刷新指示器将一直显示，直到获取到新的活动。 + /* highlight-start */ + onRefresh: () => ref.refresh(activityProvider.future), + /* highlight-end */ + child: ListView( + children: [ + Text(activity.valueOrNull?.activity ?? ''), + ], + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart new file mode 100644 index 000000000..42bb2fef4 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart @@ -0,0 +1,36 @@ +// ignore_for_file: avoid_print, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity/codegen.dart'; +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + // 如果有数据可用，我们就显示它。 + // 请注意，数据在重刷新时仍然可用。 + AsyncValue(:final valueOrNull?) => + Text(valueOrNull.activity), + // 有一个错误，因此我们将其呈现出来。 + AsyncValue(:final error?) => Text('Error: $error'), + // 无数据/错误，因此我们处于加载状态。 + _ => const CircularProgressIndicator(), + }, + ], + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart new file mode 100644 index 000000000..0cec67cba --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart @@ -0,0 +1,20 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../activity/codegen.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart new file mode 100644 index 000000000..fa23157e9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +/// See also [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart new file mode 100644 index 000000000..1cec3b128 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart @@ -0,0 +1,17 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../activity/raw.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart new file mode 100644 index 000000000..b7d53c744 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart @@ -0,0 +1,69 @@ +// ignore_for_file: use_key_in_widget_constructors, unreachable_from_main + +/* SNIPPET START */ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; +part 'codegen.freezed.dart'; + +void main() => runApp(ProviderScope(child: MyApp())); + +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return MaterialApp(home: ActivityView()); + } +} + +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => + Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const CircularProgressIndicator(), + }, + ], + ), + ), + ); + } +} + +@riverpod +Future activity(ActivityRef ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} + +@freezed +class Activity with _$Activity { + factory Activity({ + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + factory Activity.fromJson(Map json) => + _$ActivityFromJson(json); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart new file mode 100644 index 000000000..1020def96 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart @@ -0,0 +1,209 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart new file mode 100644 index 000000000..4d688e552 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -0,0 +1,46 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +/// See also [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart new file mode 100644 index 000000000..c4186fb31 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart @@ -0,0 +1,73 @@ +// ignore_for_file: use_key_in_widget_constructors, unreachable_from_main + +/* SNIPPET START */ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +void main() => runApp(ProviderScope(child: MyApp())); + +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return MaterialApp(home: ActivityView()); + } +} + +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => + Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const CircularProgressIndicator(), + }, + ], + ), + ), + ); + } +} + +final activityProvider = FutureProvider.autoDispose((ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); + +class Activity { + Activity({ + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + factory Activity.fromJson(Map json) { + return Activity( + activity: json['activity']! as String, + type: json['type']! as String, + participants: json['participants']! as int, + price: json['price']! as double, + ); + } + + final String activity; + final String type; + final int participants; + final double price; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx new file mode 100644 index 000000000..17215217c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx @@ -0,0 +1,488 @@ +--- +title: 关于代码生成 +version: 1 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import fetchUser from "!!raw-loader!./about_codegen/main.dart"; +import rawFetchUser from "!!raw-loader!./about_codegen/raw.dart"; +import { Link } from "@site/src/components/Link"; +import { trimSnippet, CodeSnippet } from "@site/src/components/CodeSnippet"; +import syncFn from "!!raw-loader!./about_codegen/provider_type/sync_fn.dart"; +import syncClass from "!!raw-loader!./about_codegen/provider_type/sync_class.dart"; +import asyncFnFuture from "!!raw-loader!./about_codegen/provider_type/async_fn_future.dart"; +import asyncClassFuture from "!!raw-loader!./about_codegen/provider_type/async_class_future.dart"; +import asyncFnStream from "!!raw-loader!./about_codegen/provider_type/async_fn_stream.dart"; +import asyncClassStream from "!!raw-loader!./about_codegen/provider_type/async_class_stream.dart"; +import familyFn from "!!raw-loader!./about_codegen/provider_type/family_fn.dart"; +import familyClass from "!!raw-loader!./about_codegen/provider_type/family_class.dart"; +import provider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/provider.dart"; +import notifierProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/notifier_provider.dart"; +import futureProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/future_provider.dart"; +import asyncNotifierProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/async_notifier_provider.dart"; +import streamProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/stream_provider.dart"; +import streamNotifierProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart"; +import autoDisposeCodeGen from "!!raw-loader!./about_codegen/provider_type/auto_dispose.dart"; +import autoDisposeNonCodeGen from "!!raw-loader!./about_codegen/provider_type/non_code_gen/auto_dispose.dart"; +import familyCodeGen from "!!raw-loader!./about_codegen/provider_type/family.dart"; +import familyNonCodeGen from "!!raw-loader!./about_codegen/provider_type/non_code_gen/family.dart"; +const TRANSPARENT_STYLE = { backgroundColor: "transparent" }; +const RED_STYLE = { color: "indianred", fontWeight: "700" }; +const BLUE_STYLE = { color: "rgb(103, 134, 196)", fontWeight: "700" }; +const FONT_16_STYLE = { + fontSize: "16px", + fontWeight: "700", +}; +const BLUE_20_STYLE = { + color: "rgb(103, 134, 196)", + fontSize: "20px", + fontWeight: "700", +}; +const PROVIDER_STYLE = { + textAlign: "center", + fontWeight: "600", + maxWidth: "210px", +}; +const BEFORE_STYLE = { + minWidth: "60px", + textAlign: "center", + fontWeight: "600", + color: "crimson", +}; +const AFTER_STYLE = { + minWidth: "60px", + textAlign: "center", + fontWeight: "600", + color: "rgb(40,180,40)", +}; + + +代码生成是使用工具为我们生成代码的想法。 +在 Dart 中，它的缺点是需要额外的步骤来“编译”应用程序。 +尽管这个问题可能在不久的将来得到解决， +但 Dart 团队正在研究这个问题的潜在解决方案。 + + +在 Riverpod 的上下文中，代码生成是稍微改变定义 "provider" 的语法。例如，代替： + +{trimSnippet(rawFetchUser)} + + +使用代码生成，我们可以编写： + +{trimSnippet(fetchUser)} + + +使用 Riverpod 时，代码生成是完全可选的。 +没有的话完全可以使用 Riverpod。 +同时，Riverpod 支持代码生成并推荐使用它。 + + +有关如何安装和使用 Riverpod 代码生成器的信息， +请参阅页面。 +确保在文档的侧栏中启用代码生成。 + + +## 我应该使用代码生成吗？​ + + +Riverpod 中的代码生成是可选的。 +考虑到这一点，您可能会想是否应该使用它。 + + +答案是：**很可能是的**。 +使用代码生成是使用 Riverpod 的推荐方式。 +这是一种更面向未来的方法，可以让您充分发挥 Riverpod 的潜力。 +与此同时，许多应用程序已经使用 +[Freezed](https://pub.dev/packages/freezed) 或 [json_serializable](https://pub.dev/packages/json_serializable) +等包来生成代码。在这种情况下，您的项目可能已经设置为代码生成， +并且使用 Riverpod 应该很简单。 + + +目前，代码生成是可选的，因为许多人不喜欢 `build_runner`。 +但是，一旦 Dart 中提供了[静态元编程](https://github.com/dart-lang/language/issues/1482)， +`build_runner` 将不再是问题。 +届时，代码生成语法将是 Riverpod 中唯一可用的语法。 + + +如果使用 `build_runner` 对您来说是一个破坏性的事情， +那么只有那时您才应该考虑不使用代码生成。 +但请记住，您将错过一些功能，并且将来您将不得不迁移到代码生成。 +尽管如此，当这种情况发生时， +Riverpod 将提供一个迁移工具，以使过渡尽可能顺利。 + + +## 使用代码生成有什么好处？​ + + +您可能想知道：“如果 Riverpod 中代码生成是可选的，为什么要使用它？” + + +这和其他包的目的一样：让您的生活更轻松。这包括但不限于： + + +- 更好的语法，更具可读性/灵活性，并且学习曲线更短。 + - 无需担心提供者程序的类型。写下您的逻辑，Riverpod 将为您选择最合适的提供者程序。 + - 语法看起来不再像我们定义了“肮脏的全局变量”。相反，我们定义了一个自定义函数/类。 + - 向提供者程序传递参数现在不受限制。 + 您现在可以传递任何参数，而不是仅限于使用 `.family` 并传递单个位置参数。 + 这包括命名参数、可选参数，甚至默认值。 +- 用 Riverpod 编写的代码的**有状态热重载**。 +- 通过生成调试器随后拾取的额外元数据来更好地进行调试。 +- 某些 Riverpod 功能仅在代码生成时可用。 + + +## 语法​ + + +### 定义提供者程序：​ + + +使用代码生成定义提供者程序时，记住以下几点会很有帮助： + + +- 提供者程序可以定义为带注释的函数或 + 带注释的类。它们几乎相同， + 但基于类的提供者程序的优点是包含公共方法，使 + 外部对象能够修改提供者程序的状态（副作用）。 + 函数提供者程序是用于编写基于类的提供者程序的语法糖，只有 `build` 方法， + 因此不能由 UI 修改。 +- 支持所有 Dart 异步原语（Future、FutureOr 和 Stream）。 +- 当函数被标记为async时， + 提供者程序会自动处理错误/加载状态并公开 AsyncValue。 + + + + + + + + + + + + + + + + + + + + + + + +
+ 函数式的 +
+ （不能使用公共方法执行副作用） + 		+ 基于类的 +
+ （可以使用公共方法执行副作用） +
+ + 同步的 + + + {trimSnippet(syncFn)} + + {trimSnippet(syncClass)} +
+ + 异步的 - Future + + + {trimSnippet(asyncFnFuture)} + + {trimSnippet(asyncClassFuture)} +
+ + 异步的 - Stream + + + {trimSnippet(asyncFnStream)} + + {trimSnippet(asyncClassStream)} +
+ + +### 启用/禁用自动处置 autoDispose：​ + + +使用代码生成时，提供者程序默认为 autoDispose。 +这意味着当没有监听器附加到它们（ref.watch/ref.listen）时，它们会自动处理掉自己。 +此默认设置更符合 Riverpod 的理念。 +最初没有使用代码生成变体时，默认情况下 autoDispose 处于关闭状态， +以适应从 `package:provider` 迁移的用户。 + + +如果您想禁用 autoDispose，可以通过将 `keepAlive: true` 传递给注释来实现。 + +{trimSnippet(autoDisposeCodeGen)} + + +### 将参数传递给提供者程序（family）：​ + + +使用代码生成时，我们不再需要依赖 `family` 修饰符将参数传递给提供者程序。 +相反，我们的提供者程序的主函数可以接受任意数量的参数，包括命名、可选或默认值。 +但请注意，这些参数应该仍然具有 == 的一致性。 +这意味着要么应该缓存值，要么应该覆盖 == 参数。 + + + + + + + + + + + + + + +
+ 函数式的 + + 基于类的 +
+ {trimSnippet(familyFn)} + + {trimSnippet(familyClass)} +
+ + +## 从非代码生成变体迁移：​ + + +使用非代码生成变体时，需要手动确定提供者程序的类型。 +以下是转换为代码生成变体的相应选项： + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Provider +
之前 + {trimSnippet(provider)} +
之后 + {trimSnippet(syncFn)} +
+ NotifierProvider +
之前 + {trimSnippet(notifierProvider)} +
之后 + {trimSnippet(syncClass)} +
+ FutureProvider +
之前 + {trimSnippet(futureProvider)} +
之后 + {trimSnippet(asyncFnFuture)} +
+ StreamProvider +
之前 + {trimSnippet(streamProvider)} +
之后 + {trimSnippet(asyncFnStream)} +
+ AsyncNotifierProvider +
之前 + + {trimSnippet(asyncNotifierProvider)} + +
之后 + {trimSnippet(asyncClassFuture)} +
+ StreamNotifierProvider +
之前 + + {trimSnippet(streamNotifierProvider)} + +
之后 + {trimSnippet(asyncClassStream)} +
+ +[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html +[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html +[riverpod]: https://github.com/rrousselgit/riverpod +[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod +[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod +[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks +[build]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier/build.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.dart new file mode 100644 index 000000000..1ccb42807 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.dart @@ -0,0 +1,22 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'main.g.dart'; + +class User { + User.fromJson(Object obj); +} + +class Http { + Future get(String str) async => str; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +Future fetchUser(FetchUserRef ref, {required int userId}) async { + final json = await http.get('api/user/$userId'); + return User.fromJson(json); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.g.dart new file mode 100644 index 000000000..370c04d0a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.g.dart @@ -0,0 +1,202 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'main.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$fetchUserHash() => r'ff427bbb4130a8a6994fa623ae70997f7b0f6bdb'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [fetchUser]. +@ProviderFor(fetchUser) +const fetchUserProvider = FetchUserFamily(); + +/// See also [fetchUser]. +class FetchUserFamily extends Family { + /// See also [fetchUser]. + const FetchUserFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'fetchUserProvider'; + + /// See also [fetchUser]. + FetchUserProvider call({ + required int userId, + }) { + return FetchUserProvider( + userId: userId, + ); + } + + @visibleForOverriding + @override + FetchUserProvider getProviderOverride( + covariant FetchUserProvider provider, + ) { + return call( + userId: provider.userId, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FutureOr Function(FetchUserRef ref) create) { + return _$FetchUserFamilyOverride(this, create); + } +} + +class _$FetchUserFamilyOverride implements FamilyOverride { + _$FetchUserFamilyOverride(this.overriddenFamily, this.create); + + final FutureOr Function(FetchUserRef ref) create; + + @override + final FetchUserFamily overriddenFamily; + + @override + FetchUserProvider getProviderOverride( + covariant FetchUserProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [fetchUser]. +class FetchUserProvider extends AutoDisposeFutureProvider { + /// See also [fetchUser]. + FetchUserProvider({ + required int userId, + }) : this._internal( + (ref) => fetchUser( + ref as FetchUserRef, + userId: userId, + ), + from: fetchUserProvider, + name: r'fetchUserProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$fetchUserHash, + dependencies: FetchUserFamily._dependencies, + allTransitiveDependencies: FetchUserFamily._allTransitiveDependencies, + userId: userId, + ); + + FetchUserProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.userId, + }) : super.internal(); + + final int userId; + + @override + Override overrideWith( + FutureOr Function(FetchUserRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: FetchUserProvider._internal( + (ref) => create(ref as FetchUserRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + userId: userId, + ), + ); + } + + @override + ({ + int userId, + }) get argument { + return (userId: userId,); + } + + @override + AutoDisposeFutureProviderElement createElement() { + return _FetchUserProviderElement(this); + } + + FetchUserProvider _copyWith( + FutureOr Function(FetchUserRef ref) create, + ) { + return FetchUserProvider._internal( + (ref) => create(ref as FetchUserRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + userId: userId, + ); + } + + @override + bool operator ==(Object other) { + return other is FetchUserProvider && other.userId == userId; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, userId.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin FetchUserRef on AutoDisposeFutureProviderRef { + /// The parameter `userId` of this provider. + int get userId; +} + +class _FetchUserProviderElement extends AutoDisposeFutureProviderElement + with FetchUserRef { + _FetchUserProviderElement(super.provider); + + @override + int get userId => (origin as FetchUserProvider).userId; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart new file mode 100644 index 000000000..2c7affffc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_class_future.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + Future build() async { + return Future.value('foo'); + } + + // 添加改变状态的方法 +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart new file mode 100644 index 000000000..0fe4488e1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_class_future.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'8a906741b8ea4b9b0d3f0b924779704b3e1773a1'; + +/// See also [Example]. +@ProviderFor(Example) +final exampleProvider = + AutoDisposeAsyncNotifierProvider.internal( + Example.new, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Example = AutoDisposeAsyncNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart new file mode 100644 index 000000000..d76d9fd67 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_class_stream.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + Stream build() async* { + yield 'foo'; + } + + // 添加改变状态的方法 +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart new file mode 100644 index 000000000..e44bf1860 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_class_stream.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'4bca936132b77a9a804549f086f33571724b4804'; + +/// See also [Example]. +@ProviderFor(Example) +final exampleProvider = + AutoDisposeStreamNotifierProvider.internal( + Example.new, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Example = AutoDisposeStreamNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart new file mode 100644 index 000000000..95fdd909c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_fn_future.g.dart'; + +/* SNIPPET START */ +@riverpod +Future example(ExampleRef ref) async { + return Future.value('foo'); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart new file mode 100644 index 000000000..f22d58704 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_fn_future.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'e620af6b870a76eea4228989433de0666957d813'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeFutureProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart new file mode 100644 index 000000000..74da790ad --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_fn_stream.g.dart'; + +/* SNIPPET START */ +@riverpod +Stream example(ExampleRef ref) async* { + yield 'foo'; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart new file mode 100644 index 000000000..56ff2877e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_fn_stream.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'8a2b19776fb9bbb1631f898bd6446b57b102dd9d'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeStreamProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeStreamProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart new file mode 100644 index 000000000..7716e905c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart @@ -0,0 +1,12 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'auto_dispose.g.dart'; + +/* SNIPPET START */ +// AutoDispose provider (keepAlive 默认为 false) +@riverpod +String example1(Example1Ref ref) => 'foo'; + +// Non autoDispose provider +@Riverpod(keepAlive: true) +String example2(Example2Ref ref) => 'foo'; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart new file mode 100644 index 000000000..98e4139ea --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'auto_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$example1Hash() => r'8a5f0865f758792cc8e4f2ca67db334196df6e88'; + +/// See also [example1]. +@ProviderFor(example1) +final example1Provider = AutoDisposeProvider.internal( + example1, + name: r'example1Provider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$example1Hash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef Example1Ref = AutoDisposeProviderRef; +String _$example2Hash() => r'bc25731d759be185125d12d995d0b89b07d1e271'; + +/// See also [example2]. +@ProviderFor(example2) +final example2Provider = Provider.internal( + example2, + name: r'example2Provider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$example2Hash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef Example2Ref = ProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart new file mode 100644 index 000000000..e1ee685fb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart @@ -0,0 +1,7 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family.g.dart'; + +/* SNIPPET START */ +@riverpod +String example(ExampleRef ref, int param) => 'Hello $param'; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart new file mode 100644 index 000000000..fe7456f0d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart @@ -0,0 +1,200 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'c4f5a651a55bcf34b0c92d98d77436844cbdc097'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [example]. +@ProviderFor(example) +const exampleProvider = ExampleFamily(); + +/// See also [example]. +class ExampleFamily extends Family { + /// See also [example]. + const ExampleFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'exampleProvider'; + + /// See also [example]. + ExampleProvider call( + int param, + ) { + return ExampleProvider( + param, + ); + } + + @visibleForOverriding + @override + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return call( + provider.param, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(String Function(ExampleRef ref) create) { + return _$ExampleFamilyOverride(this, create); + } +} + +class _$ExampleFamilyOverride implements FamilyOverride { + _$ExampleFamilyOverride(this.overriddenFamily, this.create); + + final String Function(ExampleRef ref) create; + + @override + final ExampleFamily overriddenFamily; + + @override + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [example]. +class ExampleProvider extends AutoDisposeProvider { + /// See also [example]. + ExampleProvider( + int param, + ) : this._internal( + (ref) => example( + ref as ExampleRef, + param, + ), + from: exampleProvider, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$exampleHash, + dependencies: ExampleFamily._dependencies, + allTransitiveDependencies: ExampleFamily._allTransitiveDependencies, + param: param, + ); + + ExampleProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.param, + }) : super.internal(); + + final int param; + + @override + Override overrideWith( + String Function(ExampleRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: ExampleProvider._internal( + (ref) => create(ref as ExampleRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + param: param, + ), + ); + } + + @override + (int,) get argument { + return (param,); + } + + @override + AutoDisposeProviderElement createElement() { + return _ExampleProviderElement(this); + } + + ExampleProvider _copyWith( + String Function(ExampleRef ref) create, + ) { + return ExampleProvider._internal( + (ref) => create(ref as ExampleRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param: param, + ); + } + + @override + bool operator ==(Object other) { + return other is ExampleProvider && other.param == param; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, param.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin ExampleRef on AutoDisposeProviderRef { + /// The parameter `param` of this provider. + int get param; +} + +class _ExampleProviderElement extends AutoDisposeProviderElement + with ExampleRef { + _ExampleProviderElement(super.provider); + + @override + int get param => (origin as ExampleProvider).param; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart new file mode 100644 index 000000000..bc012e266 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart @@ -0,0 +1,17 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family_class.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + String build( + int param1, { + String param2 = 'foo', + }) { + return 'Hello $param1 & param2'; + } + + // 添加改变状态的方法 +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart new file mode 100644 index 000000000..1108d93c1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart @@ -0,0 +1,245 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family_class.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'c81e9d94e763b25403ab6b7fa03f092003570142'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +abstract class _$Example extends BuildlessAutoDisposeNotifier { + late final int param1; + late final String param2; + + String build( + int param1, { + String param2 = 'foo', + }); +} + +/// See also [Example]. +@ProviderFor(Example) +const exampleProvider = ExampleFamily(); + +/// See also [Example]. +class ExampleFamily extends Family { + /// See also [Example]. + const ExampleFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'exampleProvider'; + + /// See also [Example]. + ExampleProvider call( + int param1, { + String param2 = 'foo', + }) { + return ExampleProvider( + param1, + param2: param2, + ); + } + + @visibleForOverriding + @override + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return call( + provider.param1, + param2: provider.param2, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(Example Function() create) { + return _$ExampleFamilyOverride(this, create); + } +} + +class _$ExampleFamilyOverride implements FamilyOverride { + _$ExampleFamilyOverride(this.overriddenFamily, this.create); + + final Example Function() create; + + @override + final ExampleFamily overriddenFamily; + + @override + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [Example]. +class ExampleProvider extends AutoDisposeNotifierProviderImpl { + /// See also [Example]. + ExampleProvider( + int param1, { + String param2 = 'foo', + }) : this._internal( + () => Example() + ..param1 = param1 + ..param2 = param2, + from: exampleProvider, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$exampleHash, + dependencies: ExampleFamily._dependencies, + allTransitiveDependencies: ExampleFamily._allTransitiveDependencies, + param1: param1, + param2: param2, + ); + + ExampleProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.param1, + required this.param2, + }) : super.internal(); + + final int param1; + final String param2; + + @override + String runNotifierBuild( + covariant Example notifier, + ) { + return notifier.build( + param1, + param2: param2, + ); + } + + @override + Override overrideWith(Example Function() create) { + return ProviderOverride( + origin: this, + override: ExampleProvider._internal( + () => create() + ..param1 = param1 + ..param2 = param2, + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + param1: param1, + param2: param2, + ), + ); + } + + @override + ( + int, { + String param2, + }) get argument { + return ( + param1, + param2: param2, + ); + } + + @override + AutoDisposeNotifierProviderElement createElement() { + return _ExampleProviderElement(this); + } + + ExampleProvider _copyWith( + Example Function() create, + ) { + return ExampleProvider._internal( + () => create() + ..param1 = param1 + ..param2 = param2, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param1: param1, + param2: param2, + ); + } + + @override + bool operator ==(Object other) { + return other is ExampleProvider && + other.param1 == param1 && + other.param2 == param2; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, param1.hashCode); + hash = _SystemHash.combine(hash, param2.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin ExampleRef on AutoDisposeNotifierProviderRef { + /// The parameter `param1` of this provider. + int get param1; + + /// The parameter `param2` of this provider. + String get param2; +} + +class _ExampleProviderElement + extends AutoDisposeNotifierProviderElement + with ExampleRef { + _ExampleProviderElement(super.provider); + + @override + int get param1 => (origin as ExampleProvider).param1; + @override + String get param2 => (origin as ExampleProvider).param2; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart new file mode 100644 index 000000000..863df6f40 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart @@ -0,0 +1,13 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family_fn.g.dart'; + +/* SNIPPET START */ +@riverpod +String example( + ExampleRef ref, + int param1, { + String param2 = 'foo', +}) { + return 'Hello $param1 & param2'; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart new file mode 100644 index 000000000..a72fa27de --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart @@ -0,0 +1,224 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family_fn.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'99b3ed3d53932bd1354259200ebf08493af9ada2'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [example]. +@ProviderFor(example) +const exampleProvider = ExampleFamily(); + +/// See also [example]. +class ExampleFamily extends Family { + /// See also [example]. + const ExampleFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'exampleProvider'; + + /// See also [example]. + ExampleProvider call( + int param1, { + String param2 = 'foo', + }) { + return ExampleProvider( + param1, + param2: param2, + ); + } + + @visibleForOverriding + @override + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return call( + provider.param1, + param2: provider.param2, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(String Function(ExampleRef ref) create) { + return _$ExampleFamilyOverride(this, create); + } +} + +class _$ExampleFamilyOverride implements FamilyOverride { + _$ExampleFamilyOverride(this.overriddenFamily, this.create); + + final String Function(ExampleRef ref) create; + + @override + final ExampleFamily overriddenFamily; + + @override + ExampleProvider getProviderOverride( + covariant ExampleProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [example]. +class ExampleProvider extends AutoDisposeProvider { + /// See also [example]. + ExampleProvider( + int param1, { + String param2 = 'foo', + }) : this._internal( + (ref) => example( + ref as ExampleRef, + param1, + param2: param2, + ), + from: exampleProvider, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$exampleHash, + dependencies: ExampleFamily._dependencies, + allTransitiveDependencies: ExampleFamily._allTransitiveDependencies, + param1: param1, + param2: param2, + ); + + ExampleProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.param1, + required this.param2, + }) : super.internal(); + + final int param1; + final String param2; + + @override + Override overrideWith( + String Function(ExampleRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: ExampleProvider._internal( + (ref) => create(ref as ExampleRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + param1: param1, + param2: param2, + ), + ); + } + + @override + ( + int, { + String param2, + }) get argument { + return ( + param1, + param2: param2, + ); + } + + @override + AutoDisposeProviderElement createElement() { + return _ExampleProviderElement(this); + } + + ExampleProvider _copyWith( + String Function(ExampleRef ref) create, + ) { + return ExampleProvider._internal( + (ref) => create(ref as ExampleRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + param1: param1, + param2: param2, + ); + } + + @override + bool operator ==(Object other) { + return other is ExampleProvider && + other.param1 == param1 && + other.param2 == param2; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, param1.hashCode); + hash = _SystemHash.combine(hash, param2.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin ExampleRef on AutoDisposeProviderRef { + /// The parameter `param1` of this provider. + int get param1; + + /// The parameter `param2` of this provider. + String get param2; +} + +class _ExampleProviderElement extends AutoDisposeProviderElement + with ExampleRef { + _ExampleProviderElement(super.provider); + + @override + int get param1 => (origin as ExampleProvider).param1; + @override + String get param2 => (origin as ExampleProvider).param2; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart new file mode 100644 index 000000000..7316f1b0b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart @@ -0,0 +1,16 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = + AsyncNotifierProvider.autoDispose( + ExampleNotifier.new, +); + +class ExampleNotifier extends AutoDisposeAsyncNotifier { + @override + Future build() async { + return Future.value('foo'); + } + + // 添加改变状态的方法 +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart new file mode 100644 index 000000000..3a1b26fb5 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart @@ -0,0 +1,12 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +// autoDispose provider +final example1Provider = Provider.autoDispose((ref) { + return 'foo'; +}); + +// non autoDispose provider +final example2Provider = Provider((ref) { + return 'foo'; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart new file mode 100644 index 000000000..a9e59d48d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart @@ -0,0 +1,6 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = Provider.family((ref, param) { + return 'Hello $param'; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart new file mode 100644 index 000000000..6306a76fb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart @@ -0,0 +1,7 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = + FutureProvider.autoDispose((ref) async { + return Future.value('foo'); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart new file mode 100644 index 000000000..1c220578e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart @@ -0,0 +1,15 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = NotifierProvider.autoDispose( + ExampleNotifier.new, +); + +class ExampleNotifier extends AutoDisposeNotifier { + @override + String build() { + return 'foo'; + } + + // 添加改变状态的方法 +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart new file mode 100644 index 000000000..1f541352a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart @@ -0,0 +1,8 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = Provider.autoDispose( + (ref) { + return 'foo'; + }, +); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart new file mode 100644 index 000000000..2951f2f00 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart @@ -0,0 +1,16 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = + StreamNotifierProvider.autoDispose(() { + return ExampleNotifier(); +}); + +class ExampleNotifier extends AutoDisposeStreamNotifier { + @override + Stream build() async* { + yield 'foo'; + } + + // 添加改变状态的方法 +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart new file mode 100644 index 000000000..5e7f8463a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart @@ -0,0 +1,7 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = + StreamProvider.autoDispose((ref) async* { + yield 'foo'; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart new file mode 100644 index 000000000..7974e175a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'sync_class.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + String build() { + return 'foo'; + } + + // 添加改变状态的方法 +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart new file mode 100644 index 000000000..d4c658779 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'sync_class.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'c237193ab6d57674973aaa02eb73db6f6822eb26'; + +/// See also [Example]. +@ProviderFor(Example) +final exampleProvider = AutoDisposeNotifierProvider.internal( + Example.new, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Example = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart new file mode 100644 index 000000000..0d4922734 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'sync_fn.g.dart'; + +/* SNIPPET START */ +@riverpod +String example(ExampleRef ref) { + return 'foo'; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart new file mode 100644 index 000000000..daabcdd71 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'sync_fn.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'dd4e9043c704a42a3fc025e7fef9515f659fc78a'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/raw.dart new file mode 100644 index 000000000..4630c27ff --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/raw.dart @@ -0,0 +1,19 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, avoid_unused_constructor_parameters + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class User { + User.fromJson(Object obj); +} + +class Http { + Future get(String str) async => str; +} + +final http = Http(); + +/* SNIPPET START */ +final fetchUserProvider = FutureProvider.autoDispose.family((ref, userId) async { + final json = await http.get('api/user/$userId'); + return User.fromJson(json); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx new file mode 100644 index 000000000..6eadaa2cf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx @@ -0,0 +1,570 @@ +--- +title: 关于 Hooks（钩子） +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import hookAndConsumer from "!!raw-loader!./about_hooks/hook_and_consumer.dart"; +import hookConsumer from "!!raw-loader!./about_hooks/hook_consumer.dart"; +import hookConsumerWidget from "!!raw-loader!./about_hooks/hook_consumer_widget.dart"; +import { CodeSnippet } from "@site/src/components/CodeSnippet"; +import { Link } from "@site/src/components/Link"; + + +本页介绍了什么是 Hooks 以及它们与 Riverpod 的关系。 + + +"Hooks" 是独立于 Riverpod 的单独包中常见的实用程序：[flutter_hooks]。 +虽然 [flutter_hooks] 是一个完全独立的包， +并且与 Riverpod 没有任何关系（至少没有直接关系）， +但通常将 Riverpod 和 [flutter_hooks] 配对在一起。 + + +## 你应该使用 hooks 吗？​ + + +Hooks 是一个强大的工具，但并不适合所有人。 +如果您是 Riverpod 的新手，您可能应该避免使用 hooks。 + + +虽然 hooks 很有用，但对于 Riverpod 来说并不是必需的。 +您不应该为了 Riverpod 开始使用 hooks。 +相反，您开始使用 hooks，是因为您想使用 hooks。 + + +使用 hooks 是一种权衡。它们非常适合生成健壮且可重用的代码， +但它们也是一个需要学习的新概念，一开始可能会令人困惑。 +Hooks 不是 Flutter 的核心概念。因此，它们在 Flutter/Dart 中会感觉格格不入。 + + +## 什么是 Hooks？​ + + +Hooks 是小部件内部使用的函数。它们被设计为 [StatefulWidget] 的替代品， +以使逻辑更加可重用和可组合。 + + +Hooks 是来自 [React](https://reactjs.org/) 的一个概念，[flutter_hooks] +只是 React 实现到 Flutter 的一个端口。 +因此，是的，hooks 在 Flutter 中可能感觉有点不合适。理想情况下， +未来我们会有一个专门为 Flutter 设计的 Hooks 解决问题的解决方案。 + + +如果 Riverpod 的提供者程序用于“全局”应用程序状态，则 Hooks 用于本地小部件状态。 +Hooks 通常用于处理有状态的 UI 对象，例如 [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html)、 +[AnimationController](https://api.flutter.dev/flutter/animation/AnimationController-class.html)。 +它们还可以作为“构建器”模式的替代品，用不涉及“嵌套”的替代方案替换诸如 +[FutureBuilder](https://api.flutter.dev/flutter/widgets/FutureBuilder-class.html)/[TweenAnimatedBuilder](https://api.flutter.dev/flutter/widgets/TweenAnimationBuilder-class.html) +之类的小部件，从而大大提高可读性。 + + +一般来说，钩子有助于： + + +- 表单 +- 动画 +- 对用户事件做出反应 +- …… + + +例如，我们可以使用钩子手动实现淡入动画，其中小部件开始不可见并慢慢出现。 + + +如果我们使用 [StatefulWidget]，代码将如下所示： + +```dart +class FadeIn extends StatefulWidget { + const FadeIn({Key? key, required this.child}) : super(key: key); + + final Widget child; + + @override + State createState() => _FadeInState(); +} + +class _FadeInState extends State with SingleTickerProviderStateMixin { + late final AnimationController animationController = AnimationController( + vsync: this, + duration: const Duration(seconds: 2), + ); + + @override + void initState() { + super.initState(); + animationController.forward(); + } + + @override + void dispose() { + animationController.dispose(); + super.dispose(); + } + + @override + Widget build(BuildContext context) { + return AnimatedBuilder( + animation: animationController, + builder: (context, child) { + return Opacity( + opacity: animationController.value, + child: widget.child, + ); + }, + ); + } +} +``` + + +使用 hooks，相当于： + +```dart +class FadeIn extends HookWidget { + const FadeIn({Key? key, required this.child}) : super(key: key); + + final Widget child; + + @override + Widget build(BuildContext context) { + // 创建一个 AnimationController。 + // 卸载 widget 时，控制器将自动处置。 + final animationController = useAnimationController( + duration: const Duration(seconds: 2), + ); + + // useEffect 相当于 initState + didUpdateWidget + dispose。 + // 传给 useEffect 的回调会在第一次调用钩子时执行， + // 然后每当作为第二个参数传递的列表发生变化时也会执行。 + // 由于我们在这里传递的是一个空的常量列表， + // 因此严格意义上等同于 `initState`。 + useEffect(() { + // 在首次呈现 widget 时启动动画。 + animationController.forward(); + // 我们可以选择在这里返回一些“处置”逻辑 + return null; + }, const []); + + // 告诉 Flutter 在动画更新时重建此部件。 + // 这相当于 AnimatedBuilder + useAnimation(animationController); + + return Opacity( + opacity: animationController.value, + child: child, + ); + } +} +``` + + +这段代码中有一些有趣的事情需要注意： + + +- 不存在内存泄漏。每当小部件重建时，此代码都不会重新创建新的 `AnimationController`， + 并且在卸载小部件时正确处置控制器。 + + +- 在同一个小部件中可以根据需要多次使用钩子。 + 因此，如果我们愿意，我们可以创建多个 `AnimationController`： + + ```dart + @override + Widget build(BuildContext context) { + final animationController = useAnimationController( + duration: const Duration(seconds: 2), + ); + final anotherController = useAnimationController( + duration: const Duration(seconds: 2), + ); + + ... + } + ``` + + 这会创建两个控制器，不会产生任何负面后果。 + + +- 如果我们愿意，我们可以将此逻辑重构为一个单独的可重用函数： + + ```dart + double useFadeIn() { + final animationController = useAnimationController( + duration: const Duration(seconds: 2), + ); + useEffect(() { + animationController.forward(); + return null; + }, const []); + useAnimation(animationController); + return animationController.value; + } + ``` + + 然后我们可以在我们的小部件中使用这个函数，只要该小部件是 [HookWidget]： + + ```dart + class FadeIn extends HookWidget { + const FadeIn({Key? key, required this.child}) : super(key: key); + + final Widget child; + + @override + Widget build(BuildContext context) { + final fade = useFadeIn(); + + return Opacity(opacity: fade, child: child); + } + } + ``` + + 请注意我们的 `useFadeIn` 函数是如何完全独立于我们的 `FadeIn` 小部件的。 + 如果我们愿意，我们可以在完全不同的小部件中使用该 `useFadeIn` 函数，并且它仍然可以工作！ + + +## hooks 的规则​ + + +Hooks 具有独特的约束： + + +- 它们只能在扩展 [HookWidget] 的小部件的 `build` 方法中使用： + + **好**: + + ```dart + class Example extends HookWidget { + @override + Widget build(BuildContext context) { + final controller = useAnimationController(); + ... + } + } + ``` + + **坏**: + + ```dart + // 不是 HookWidget + class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + final controller = useAnimationController(); + ... + } + } + ``` + + **坏**: + + ```dart + class Example extends HookWidget { + @override + Widget build(BuildContext context) { + return ElevatedButton( + onPressed: () { + // _实际上_不是在 "build" 方法中， + // 而是在用户交互生命周期中（这里是 "按下时"）。 + final controller = useAnimationController(); + }, + child: Text('click me'), + ); + } + } + ``` + + +- 它们不能在条件语句或在循环语句中使用。 + + **坏**: + + ```dart + class Example extends HookWidget { + const Example({required this.condition, super.key}); + final bool condition; + @override + Widget build(BuildContext context) { + if (condition) { + // 不应该在 "if"/"for"/... 中使用 Hooks + final controller = useAnimationController(); + } + ... + } + } + ``` + + +有关钩子的更多信息，请参阅 [flutter_hooks]。 + + +## Hooks 和 Riverpod + + +### 安装 + + +由于 Hooks 与 Riverpod 是独立的，因此需要单独安装 Hooks。 +如果你想使用它们，安装 [hooks_riverpod] 是不够的。 +您仍然需要将 [flutter_hooks] 添加到您的依赖项中。 +请参阅 了解更多信息。 + + +### 用途​ + + +在某些情况下，您可能想要编写一个同时使用 hooks 和 Riverpod 的 Widget。 +但您可能已经注意到，Hooks 和 Riverpod 都提供了自己的 +自定义小部件基本类型：[HookWidget] 和 [ConsumerWidget]。 +但类一次只能扩展一个父类。 + + +为了解决这个问题，你可以使用 [hooks_riverpod] 包。 +该包提供了一个 [HookConsumerWidget] 类， +它将 [HookWidget] 和 [ConsumerWidget] 组合成一个类型。 +因此，您可以继承 [HookConsumerWidget] 而不是 [HookWidget]： + + + + +或者，您可以使用两个包提供的“构建器 builder”。 +例如，我们可以坚持使用 `StatelessWidget`， +并同时使用 `HookBuilder` 和 `Consumer`。 + + + +:::note + +这种方法无需使用 `hooks_riverpod` 即可工作。只需要 `flutter_riverpod`。 +::: + + +如果您喜欢这种方法，[hooks_riverpod] 通过提供 [HookConsumer] 来简化它， +它是两个构建器的组合： + + + +[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html +[hookconsumer]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/HookConsumer-class.html +[hookconsumerwidget]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/HookConsumerWidget-class.html +[consumerwidget]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ConsumerWidget-class.html +[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html +[riverpod]: https://github.com/rrousselgit/riverpod +[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod +[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod +[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart new file mode 100644 index 000000000..fc5e96628 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart @@ -0,0 +1,28 @@ +// ignore_for_file: use_key_in_widget_constructors, unused_local_variable + +import 'package:flutter/widgets.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../providers/creating_a_provider/codegen.dart'; + +class MyValue {} + +/* SNIPPET START */ + +class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + // 我们可以使用这两个软件包提供的构建器 + return Consumer( + builder: (context, ref, child) { + return HookBuilder(builder: (context) { + final counter = useState(0); + final value = ref.watch(myProvider); + + return Text('Hello $counter $value'); + }); + }, + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart new file mode 100644 index 000000000..1ada8fe2a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart @@ -0,0 +1,26 @@ +// ignore_for_file: use_key_in_widget_constructors, unused_local_variable + +import 'package:flutter/widgets.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../providers/creating_a_provider/codegen.dart'; + +class MyValue {} + +/* SNIPPET START */ + +class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + // 相当于同时使用 Consumer 和 HookBuilder。 + return HookConsumer( + builder: (context, ref, child) { + final counter = useState(0); + final value = ref.watch(myProvider); + + return Text('Hello $counter $value'); + }, + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart new file mode 100644 index 000000000..ecb222750 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart @@ -0,0 +1,23 @@ +// ignore_for_file: use_key_in_widget_constructors, unused_local_variable + +import 'package:flutter/widgets.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../providers/creating_a_provider/codegen.dart'; + +class MyValue {} + +/* SNIPPET START */ + +// 我们扩展了 HookConsumerWidget，而不是 HookWidget +class Example extends HookConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 我们可以在这里同时使用钩子和提供者程序 + final counter = useState(0); + final value = ref.watch(myProvider); + + return Text('Hello $counter $value'); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart new file mode 100644 index 000000000..18817b776 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart @@ -0,0 +1,58 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:shared_preferences/shared_preferences.dart'; + +class LoadingScreen extends StatelessWidget { + const LoadingScreen({super.key}); + + @override + Widget build(BuildContext context) { + return const CircularProgressIndicator(); + } +} + +/* SNIPPET START */ +// We'd like to obtain an instance of shared preferences synchronously in a provider +final countProvider = StateProvider((ref) { + final preferences = ref.watch(sharedPreferencesProvider); + final currentValue = preferences.getInt('count') ?? 0; + ref.listenSelf((prev, curr) { + preferences.setInt('count', curr); + }); + return currentValue; +}); + +// We don't have an actual instance of SharedPreferences, and we can't get one except asynchronously +final sharedPreferencesProvider = + Provider((ref) => throw UnimplementedError()); + +Future main() async { + // Show a loading indicator before running the full app (optional) + // The platform's loading screen will be used while awaiting if you omit this. + runApp(const LoadingScreen()); + + // Get the instance of shared preferences + final prefs = await SharedPreferences.getInstance(); + return runApp( + ProviderScope( + overrides: [ + // Override the unimplemented provider with the value gotten from the plugin + sharedPreferencesProvider.overrideWithValue(prefs), + ], + child: const MyApp(), + ), + ); +} + +class MyApp extends ConsumerWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // Use the provider without dealing with async issues + final count = ref.watch(countProvider); + return Text('$count'); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart new file mode 100644 index 000000000..b544b3778 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart @@ -0,0 +1,29 @@ +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'models.dart'; + +part 'codegen.g.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +// The current search filter +final searchProvider = StateProvider((ref) => ''); + +@riverpod +Stream configs(ConfigsRef ref) { + return Stream.value(Configuration()); +} + +@riverpod +Future> characters(CharactersRef ref) async { + final search = ref.watch(searchProvider); + final configs = await ref.watch(configsProvider.future); + final response = await dio.get>>( + '${configs.host}/characters?search=$search'); + + return response.data!.map(Character.fromJson).toList(); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart new file mode 100644 index 000000000..710947519 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$configsHash() => r'166cbe95e6b49ed7bc78c96041fb14abddbf6911'; + +/// See also [configs]. +@ProviderFor(configs) +final configsProvider = AutoDisposeStreamProvider.internal( + configs, + name: r'configsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$configsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ConfigsRef = AutoDisposeStreamProviderRef; +String _$charactersHash() => r'b1e8e15bbeab60d92fe959d9e1dd4ceba6a31446'; + +/// See also [characters]. +@ProviderFor(characters) +final charactersProvider = AutoDisposeFutureProvider>.internal( + characters, + name: r'charactersProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$charactersHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CharactersRef = AutoDisposeFutureProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart new file mode 100644 index 000000000..e21e1d7c6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart @@ -0,0 +1,17 @@ + +class Character { + Character(); + + // ignore: avoid_unused_constructor_parameters + factory Character.fromJson(Map json) { + return Character(); + } +} + +class Configuration { + Configuration({ + this.host = '', + }); + + final String host; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart new file mode 100644 index 000000000..948148bd0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart @@ -0,0 +1,25 @@ +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'models.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +// The current search filter +final searchProvider = StateProvider((ref) => ''); + +/// Configurations which can change over time +final configsProvider = StreamProvider( + (ref) => Stream.value(Configuration()), +); + +final charactersProvider = FutureProvider>((ref) async { + final search = ref.watch(searchProvider); + final configs = await ref.watch(configsProvider.future); + final response = await dio.get>>( + '${configs.host}/characters?search=$search'); + + return response.data!.map(Character.fromJson).toList(); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart new file mode 100644 index 000000000..8b8f234b9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart @@ -0,0 +1,7 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +String city(CityRef ref) => 'London'; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart new file mode 100644 index 000000000..ac0b5a099 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +/// See also [city]. +@ProviderFor(city) +final cityProvider = AutoDisposeProvider.internal( + city, + name: r'cityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$cityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CityRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart new file mode 100644 index 000000000..d8093431c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart @@ -0,0 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final cityProvider = Provider((ref) => 'London'); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart new file mode 100644 index 000000000..0d2e49b28 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart @@ -0,0 +1,31 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../todo_list_provider/raw.dart'; + +part 'codegen.g.dart'; + +enum Filter { + none, + completed, + uncompleted, +} + +final filterProvider = StateProvider((ref) => Filter.none); + +/* SNIPPET START */ + +@riverpod +List filteredTodoList(FilteredTodoListRef ref) { + final filter = ref.watch(filterProvider); + final todos = ref.watch(todoListProvider); + + switch (filter) { + case Filter.none: + return todos; + case Filter.completed: + return todos.where((todo) => todo.completed).toList(); + case Filter.uncompleted: + return todos.where((todo) => !todo.completed).toList(); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart new file mode 100644 index 000000000..c26fbd6ba --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$filteredTodoListHash() => r'1c35eb0fce8fc7c7cda86413b02f606f8c8ae2b4'; + +/// See also [filteredTodoList]. +@ProviderFor(filteredTodoList) +final filteredTodoListProvider = AutoDisposeProvider>.internal( + filteredTodoList, + name: r'filteredTodoListProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$filteredTodoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef FilteredTodoListRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart new file mode 100644 index 000000000..85885e800 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart @@ -0,0 +1,26 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import '../todo_list_provider/raw.dart'; + +enum Filter { + none, + completed, + uncompleted, +} + +final filterProvider = StateProvider((ref) => Filter.none); + +/* SNIPPET START */ + +final filteredTodoListProvider = Provider>((ref) { + final filter = ref.watch(filterProvider); + final todos = ref.watch(todoListProvider); + + switch (filter) { + case Filter.none: + return todos; + case Filter.completed: + return todos.where((todo) => todo.completed).toList(); + case Filter.uncompleted: + return todos.where((todo) => !todo.completed).toList(); + } +}); \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart new file mode 100644 index 000000000..b1cb3dbe3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart @@ -0,0 +1,17 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +MyValue another(AnotherRef ref) => MyValue(); + +class MyValue {} + +/* SNIPPET START */ + +@riverpod +MyValue my(MyRef ref) { + // Bad practice to call `read` here + final value = ref.read(anotherProvider); + return value; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart new file mode 100644 index 000000000..50ab2adaf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$anotherHash() => r'bb412edc55657c14eace37792cd18e5254604a36'; + +/// See also [another]. +@ProviderFor(another) +final anotherProvider = AutoDisposeProvider.internal( + another, + name: r'anotherProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$anotherHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef AnotherRef = AutoDisposeProviderRef; +String _$myHash() => r'2712c772be4dbaabd4c99fd803f927a7e9938b21'; + +/// See also [my]. +@ProviderFor(my) +final myProvider = AutoDisposeProvider.internal( + my, + name: r'myProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef MyRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart new file mode 100644 index 000000000..76bae4653 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart @@ -0,0 +1,13 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +final anotherProvider = Provider((ref) => MyValue()); + +class MyValue {} + +/* SNIPPET START */ + +final myProvider = Provider((ref) { + // Bad practice to call `read` here + final value = ref.read(anotherProvider); + return value; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart new file mode 100644 index 000000000..e44e202bc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart @@ -0,0 +1,25 @@ + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'models.dart'; + +part 'codegen.g.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +@riverpod +Stream config(ConfigRef ref) => Stream.value(Configuration()); + +@riverpod +Future> products(ProductsRef ref) async { + // Listens only to the host. If something else in the configurations + // changes, this will not pointlessly re-evaluate our provider. + final host = await ref.watch(configProvider.selectAsync((config) => config.host)); + + final result = await dio.get>>('$host/products'); + + return result.data!.map(Product.fromJson).toList(); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart new file mode 100644 index 000000000..cc039edb4 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$configHash() => r'3021d1a8aac384e99d5d22714ffe6e868954888b'; + +/// See also [config]. +@ProviderFor(config) +final configProvider = AutoDisposeStreamProvider.internal( + config, + name: r'configProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$configHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ConfigRef = AutoDisposeStreamProviderRef; +String _$productsHash() => r'd1f4523880408cf8ee0e68969c40cf87d5c78557'; + +/// See also [products]. +@ProviderFor(products) +final productsProvider = AutoDisposeFutureProvider>.internal( + products, + name: r'productsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$productsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ProductsRef = AutoDisposeFutureProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart new file mode 100644 index 000000000..3a711b4b6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart @@ -0,0 +1,21 @@ +// ignore_for_file: sort_constructors_first + +class Product { + const Product({this.title = ''}); + + final String title; + + factory Product.fromJson(Map map) { + return Product( + title: map['title'] as String, + ); + } +} + +class Configuration { + Configuration({ + this.host = '', + }); + + final String host; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart new file mode 100644 index 000000000..ae35300b0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart @@ -0,0 +1,20 @@ +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'models.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +final configProvider = + StreamProvider((ref) => Stream.value(Configuration())); + +final productsProvider = FutureProvider>((ref) async { + // Listens only to the host. If something else in the configurations + // changes, this will not pointlessly re-evaluate our provider. + final host = await ref.watch(configProvider.selectAsync((config) => config.host)); + final result = await dio.get>>('$host/products'); + + return result.data!.map(Product.fromJson).toList(); +}); \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart new file mode 100644 index 000000000..a1942dbd4 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart @@ -0,0 +1,24 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +@freezed +class Todo with _$Todo { + factory Todo({ + required String id, + required String description, + required bool completed, + }) = _Todo; +} + +/* SNIPPET START */ + +@riverpod +class TodoList extends _$TodoList { + @override + List build() { + return []; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart new file mode 100644 index 000000000..0b73d3548 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart @@ -0,0 +1,166 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$Todo { + String get id => throw _privateConstructorUsedError; + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc + +class _$TodoImpl implements _Todo { + _$TodoImpl( + {required this.id, required this.description, required this.completed}); + + @override + final String id; + @override + final String description; + @override + final bool completed; + + @override + String toString() { + return 'Todo(id: $id, description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.id, id) || other.id == id) && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @override + int get hashCode => Object.hash(runtimeType, id, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); +} + +abstract class _Todo implements Todo { + factory _Todo( + {required final String id, + required final String description, + required final bool completed}) = _$TodoImpl; + + @override + String get id; + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart new file mode 100644 index 000000000..f7076044d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todoListHash() => r'6c965beb867ffeee119133f0ae2e6ebeb68e6f7e'; + +/// See also [TodoList]. +@ProviderFor(TodoList) +final todoListProvider = + AutoDisposeNotifierProvider>.internal( + TodoList.new, + name: r'todoListProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$TodoList = AutoDisposeNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart new file mode 100644 index 000000000..a341b7f5b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart @@ -0,0 +1,36 @@ +// ignore_for_file: public_member_api_docs, sort_constructors_first +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Todo { + const Todo({ + required this.id, + required this.description, + required this.completed, + }); + + // All properties should be `final` on our class. + final String id; + final String description; + final bool completed; + + // Since Todo is immutable, we implement a method that allows cloning the + // Todo with slightly different content. + Todo copyWith({String? id, String? description, bool? completed}) { + return Todo( + id: id ?? this.id, + description: description ?? this.description, + completed: completed ?? this.completed, + ); + } +} + +/* SNIPPET START */ + +class TodoList extends Notifier> { + @override + List build() { + return []; + } +} + +final todoListProvider = NotifierProvider>(TodoList.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart new file mode 100644 index 000000000..8f7af2644 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart @@ -0,0 +1,20 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +String city(CityRef ref) => 'London'; + +class Weather {} + +Future fetchWeather({required String city}) async => Weather(); +/* SNIPPET START */ +@riverpod +Future weather(WeatherRef ref) { + // We use `ref.watch` to listen to another provider, and we pass it the provider + // that we want to consume. Here: cityProvider + final city = ref.watch(cityProvider); + + // We can then use the result to do something based on the value of `cityProvider`. + return fetchWeather(city: city); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart new file mode 100644 index 000000000..a259eb12b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +/// See also [city]. +@ProviderFor(city) +final cityProvider = AutoDisposeProvider.internal( + city, + name: r'cityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$cityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CityRef = AutoDisposeProviderRef; +String _$weatherHash() => r'9a79d0269032630918eef9d3f562ff35b5860061'; + +/// See also [weather]. +@ProviderFor(weather) +final weatherProvider = AutoDisposeFutureProvider.internal( + weather, + name: r'weatherProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$weatherHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef WeatherRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart new file mode 100644 index 000000000..d25ec4ffc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart @@ -0,0 +1,18 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +final cityProvider = Provider((ref) => 'London'); + +class Weather {} + +Future fetchWeather({required String city}) async => Weather(); + +/* SNIPPET START */ + +final weatherProvider = FutureProvider((ref) async { + // We use `ref.watch` to listen to another provider, and we pass it the provider + // that we want to consume. Here: cityProvider + final city = ref.watch(cityProvider); + + // We can then use the result to do something based on the value of `cityProvider`. + return fetchWeather(city: city); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart new file mode 100644 index 000000000..1a90008ed --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart @@ -0,0 +1,24 @@ +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'models.dart'; + +part 'codegen.g.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +@riverpod +Stream config(ConfigRef ref) => Stream.value(Configuration()); + +@riverpod +Future> products(ProductsRef ref) async { + // Will cause productsProvider to re-fetch the products if anything in the + // configurations changes + final configs = await ref.watch(configProvider.future); + + final result = + await dio.get>>('${configs.host}/products'); + return result.data!.map(Product.fromJson).toList(); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart new file mode 100644 index 000000000..25c5a7ded --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$configHash() => r'3021d1a8aac384e99d5d22714ffe6e868954888b'; + +/// See also [config]. +@ProviderFor(config) +final configProvider = AutoDisposeStreamProvider.internal( + config, + name: r'configProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$configHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ConfigRef = AutoDisposeStreamProviderRef; +String _$productsHash() => r'637254615fa398af0d36e212f09e5d3d8ff866aa'; + +/// See also [products]. +@ProviderFor(products) +final productsProvider = AutoDisposeFutureProvider>.internal( + products, + name: r'productsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$productsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ProductsRef = AutoDisposeFutureProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart new file mode 100644 index 000000000..8009c2fd8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart @@ -0,0 +1,16 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +class Product { + Product(); + factory Product.fromJson(Map json) { + return Product(); + } +} + +class Configuration { + Configuration({ + this.host = '', + }); + + final String host; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart new file mode 100644 index 000000000..be2be903c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart @@ -0,0 +1,20 @@ +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'models.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +final configProvider = + StreamProvider((ref) => Stream.value(Configuration())); + +final productsProvider = FutureProvider>((ref) async { + // Will cause productsProvider to re-fetch the products if anything in the + // configurations changes + final configs = await ref.watch(configProvider.future); + + final result = await dio.get>>('${configs.host}/products'); + return result.data!.map(Product.fromJson).toList(); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index d6282f10d..5834dd0c2 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -1,65 +1,77 @@ --- -title: 组合 Provider 状态 +title: Combining Provider States --- -请确保先阅读有关 [Providers](/docs/concepts/providers) 的内容。 -在本指南中，我们将学习如何组合provider的状态。 +import charactersProvider from "./combining_provider_states/characters_provider"; +import cityProvider from "./combining_provider_states/city_provider"; +import filteredTodoListProvider from "./combining_provider_states/filtered_todo_list_provider"; +import readInProvider from "./combining_provider_states/read_in_provider"; +import selectAsyncProvider from "./combining_provider_states/select_async_provider"; +import todoListProvider from "./combining_provider_states/todo_list_provider"; +import weatherProvider from "./combining_provider_states/weather_provider"; +import wholeObjectProvider from "./combining_provider_states/whole_object_provider"; +import { Link } from "@site/src/components/Link"; +import { + trimSnippet, + AutoSnippet, + When, +} from "@site/src/components/CodeSnippet"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -## 组合 Provider 状态 +Make sure to read first. +In this guide, we will learn about combining provider states. -我们之前已经了解了如何创建简单的provider。 -但实际在许多情况下，provider想要读取另一个provider的状态。 +## Combining provider states -为此，我们可以使用传递给provider回调函数的e [ref] 对象，并使用它的 [watch] 方法。 +We've previously seen how to create a simple provider. But the reality is, +in many situations a provider will want to read the state of another provider. -例如，思考一下下面的provider： +To do that, we can use the [ref] object passed to the callback of our provider, +and use its [watch] method. -```dart -final cityProvider = Provider((ref) => 'London'); -``` +As an example, consider the following provider: + + We can now create another provider that will consume our `cityProvider`: -现在我们可以创建另一个provider来使用我们的 `cityProvider`： -```dart -final weatherProvider = FutureProvider((ref) async { - // 我们使用 `ref. watch` 来监听另一个provider， - // 我们将使用的cityProvider传递给它。 - final city = ref.watch(cityProvider); + - // 然后，我们可以根据 `cityProvider` 的值来做一些事情。 - return fetchWeather(city: city); -}); -``` +That's it. We've created a provider that depends on another provider. -这样。我们创建了一个依赖于另一个provider的provider。 +## FAQ -## 常见问题解答 +### What if the value being listened to changes over time? -### 如果被监听的值随着时间的推移而改变怎么办? +Depending on the provider that you are listening to, the value obtained may +change over time. +For example, you may be listening to a [NotifierProvider], or the provider +being listened to may have been forced to refresh through the use of +[ProviderContainer.refresh]/[ref.refresh]. -例如，你可能正在监听的 [StateNotifierProvider] 或 -已经强制刷新([ProviderContainer.refresh] / [ref.refresh])过的provider被监听时。 +When using [watch], Riverpod is able to detect that the value being listened to changed +and will _automatically_ re-execute the provider's creation callback when needed. -当使用 [watch] 时，Riverpod能够检测到被监听的值发生了变化 -并且在需要时将_自动_重新执行provider的回调函数。 +This can be useful for computed states. +For example, consider a that exposes a todo-list: -这在计算状态时很有用。 -例如一个 [StateNotifierProvider] 暴露了一个待办清单： + -```dart -class TodoList extends StateNotifier> { - TodoList(): super(const []); -} +A common use-case would be to have the UI filter the list of todos to show +only the completed/uncompleted todos. -final todoListProvider = StateNotifierProvider((ref) => TodoList()); -``` - -一个常见的用例是让UI过滤待办清单列表，只显示完成/未完成的待办事项。 +An easy way to implement such a scenario would be to: -实现这种场景的一个简单方法是： - -- 创建一个 [StateProvider]并暴露当前选择的筛选方法： +- create a [StateProvider], which exposes the currently selected filter method: ```dart enum Filter { @@ -71,70 +83,45 @@ final todoListProvider = StateNotifierProvider((ref) => TodoList()); final filterProvider = StateProvider((ref) => Filter.none); ``` -- 创建一个单独的，结合了筛选器方法和待办清单列表的provider，以暴露经过筛选的待办清单列表： +- make a separate provider which combines the filter method and the todo-list + to expose the filtered todo-list: - ```dart - final filteredTodoListProvider = Provider>((ref) { - final filter = ref.watch(filterProvider); - final todos = ref.watch(todoListProvider); - - switch (filter) { - case Filter.none: - return todos; - case Filter.completed: - return todos.where((todo) => todo.completed).toList(); - case Filter.uncompleted: - return todos.where((todo) => !todo.completed).toList(); - } - }); - ``` + -然后，我们的UI可以监听 `filteredTodoListProvider` 来监听过滤后的待办清单。 -使用这种方法，当过滤器或待办清单列表发生变化时，UI将自动更新。 +Then, our UI can listen to `filteredTodoListProvider` to listen to the filtered todo-list. +Using such an approach, the UI will automatically update when either the filter +or the todo-list changes. -要查看这种方法的详细内容，你可以查看 -[待办清单示例](https://github.com/rrousselGit/riverpod/tree/master/examples/todos)的源代码。 +To see this approach in action, you can look at the source code of the [Todo List +example](https://github.com/rrousselGit/riverpod/tree/master/examples/todos). :::info -这种行为不只针对 [Provider]，它适用于所有的provider。 +This behavior is not specific to [Provider], and works with all providers. For example, you could combine [watch] with [FutureProvider] to implement a search feature that supports live-configuration changes: -例如，你可以将 [watch] 与 [FutureProvider] 结合来实现一个支持实时配置更改的搜索功能： - -```dart -// 当前的搜索条件 -final searchProvider = StateProvider((ref) => ''); - -/// 可随时间变化的配置 -final configsProvider = StreamProvider(...); -final charactersProvider = FutureProvider>((ref) async { - final search = ref.watch(searchProvider); - final configs = await ref.watch(configsProvider.future); - final response = await dio.get('${configs.host}/characters?search=$search'); + - return response.data.map((json) => Character.fromJson(json)).toList(); -}); -``` - -这段代码将从服务中获取一个字符列表，并在配置更改或搜索查询更改时自动重新获取该列表。 +This code will fetch a list of characters from the service, and automatically +re-fetch the list whenever the configurations change or when the search query changes. ::: -### 我可以在不监听的情况下读取provider吗？ +### Can I read a provider without listening to it? -有时，我们希望读取provider的内容，但不需要在那个值发生变化时重新创建暴露的值。 +Sometimes, we want to read the content of a provider, but without re-creating +the value exposed when the value obtained changes. -一个例子就是`Repository`，它从另一个provider读取用户令牌进行身份验证。 -我们可以在用户令牌更改时使用 [watch] 并创建一个新的 `Repository` ，但这样做几乎没有任何用处。 +An example would be a `Repository`, which reads from another provider the user token +for authentication. +We could use [watch] and create a new `Repository` whenever the user token changes, +but there is little to no use in doing that. -在这种情况下，我们可以使用 [read]，它类似于 [watch]， -但是当获取的值发生变化时，它不会导致provider重新创建它所暴露的值。 +In this situation, we can use [read], which is similar to [watch], but will not +cause the provider to recreate the value it exposes when the value obtained changes. In that case, a common practice is to pass the provider's `Ref` to the object created. The object created will then be able to read providers whenever it wants. -所以在这种情况，常见的做法是将provider的 `Ref` 传递给创建的对象。 -创建的对象将能够在任何需要的时候读取提供程序。 ```dart final userTokenProvider = StateProvider((ref) => null); @@ -158,25 +145,21 @@ class Repository { } ``` -:::danger **不要**在provider的里面调用 [read] 方法 +:::danger **DON'T** call [read] inside the body of a provider -```dart -final myProvider = Provider((ref) { - // 在此处调用“read”的错误做法 - final value = ref.read(anotherProvider); -}); -``` + -如果你使用 [read] 来避免不必要的对象重建， -请参考[我的provider更新过于频繁我该怎么办](#我的provider更新过于频繁我该怎么办) +If you used [read] as an attempt to avoid unwanted rebuilds of your object, +refer to [My provider updates too often, what can I do?](#my-provider-updates-too-often-what-can-i-do) ::: -### 如何测试一个接收 [ref] 作为其构造函数参数的对象？ +### How to test an object that receives [ref] as a parameter of its constructor? -如果你正在使用[我可以在不监听的情况下读取provider吗？](#我可以在不监听的情况下读取provider吗)中描述的模式， -你可能想知道如何为对象编写测试。 +If you are using the pattern described in [Can I read a provider without listening to it?](#can-i-read-a-provider-without-listening-to-it), +you may be wondering how to write tests for your object. -在这个场景中，考虑直接测试provider而不是原始对象。你可以通过使用 [ProviderContainer] 类来实现: +In this scenario, consider testing the provider directly instead of the raw object. +You can do so by using the [ProviderContainer] class: ```dart final repositoryProvider = Provider((ref) => Repository(ref)); @@ -194,49 +177,35 @@ test('fetches catalog', () async { }); ``` -### 我的provider更新过于频繁，我该怎么办？ +### My provider updates too often, what can I do? -如果你的对象被频繁地重新创建，你的provider可能会监听它并不关心的对象。 +If your object is re-created too often your provider is likely listening +to objects that it doesn't care about. -例如，你可能正在监听一个 `Configuration` 对象，但只使用 `host` 属性。 -通过监听整个 `Configuration` 对象，如果 `host` 以外的某个属性发生了变化， -仍然会导致重新评估你的provider——这可能是我们不希望所发生的。 +For example, you may be listening to a `Configuration` object, but only use the `host` +property. +By listening to the entire `Configuration` object, if a property other than `host` +changes, this still causes your provider to be re-evaluated – which may be +undesired. -这个问题的解决方案是创建一个单独的provider，_只_在 `Configuration` 中暴露你需要的内容(所以是 `host`): +The solution to this problem is to create a separate provider that exposes _only_ +what you need in `Configuration` (so `host`): -**避免**听整个对象： +**AVOID** listening to the entire object: -```dart -final configProvider = StreamProvider(...); + -final productsProvider = FutureProvider>((ref) async { - // 如果配置(configurations)发生变化，将导致productsProvider重新获取产品 - final configs = await ref.watch(configProvider.future); +**PREFER** using select when you only need a single property of an object: - return dio.get('${configs.host}/products'); -}); -``` - - -当你只需要一个对象的单个属性时，**最好**使用select： - -```dart -final configProvider = StreamProvider(...); - -final productsProvider = FutureProvider>((ref) async { - // 只监听host。如果配置(configurations)中的其他内容发生了更改，这将重新评估我们的provider。 - final host = await ref.watch(configProvider.selectAsync((config) => config.host)); - - return dio.get('$host/products'); -}); -``` + -这将只在 `host` 更改时重新构建productsProvider。 +This will only rebuild the `productsProvider` when the `host` changes. [provider]: ../providers/provider [stateprovider]: ../providers/state_provider [futureprovider]: ../providers/future_provider [statenotifierprovider]: ../providers/state_notifier_provider +[notifierProvider]: ../providers/notifier_provider [ref]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref-class.html [watch]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/watch.html [read]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/read.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart new file mode 100644 index 000000000..4ee7792f9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart @@ -0,0 +1,58 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +// Have a counter that is being incremented by the FloatingActionButton +final counterProvider = StateProvider((ref) => 0); + +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // We want to show a dialog with the count on a button press + return Scaffold( + body: Column( + children: [ + ElevatedButton( + onPressed: () { + showDialog( + context: context, + builder: (c) { + // We wrap the dialog with a ProviderScope widget, providing the + // parent container to ensure the dialog can access the same providers + // that are accessible by the Home widget. + return ProviderScope( + parent: ProviderScope.containerOf(context), + child: const AlertDialog( + content: CounterDisplay(), + ), + ); + }, + ); + }, + child: const Text('Show Dialog'), + ), + ], + ), + floatingActionButton: FloatingActionButton( + child: const Icon(Icons.add), + onPressed: () { + ref.read(counterProvider.notifier).state++; + }, + )); + } +} + +class CounterDisplay extends ConsumerWidget { + const CounterDisplay({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final count = ref.watch(counterProvider); + return Text('$count'); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx index eaf3e5bf7..eaece8112 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx @@ -2,22 +2,27 @@ title: .autoDispose --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -一个常见的用例是当不再使用provider时销毁它的状态。 +A common use case is to destroy the state of a provider +when it is no-longer used. -这么做有很多原因，比如： +There are multiple reasons for doing so, such as: -- 使用Firebase时，关闭连接，避免不必要的开销。 -- 当用户离开页面并重新进入时重置状态。 +- When using Firebase, to close the connection and avoid unnecessary cost. +- To reset the state when the user leaves a screen and re-enters it. -Provider内置了 `.autoDispose` 修饰符来支持这些功能。 +Providers come with built-in support for this use case, through the `.autoDispose` +modifier. -## 用法 +## Usage -要告诉Riverpod在provider不再使用时销毁它的状态， -只需将 `.autoDispose` 附加到你的provider上： +To tell Riverpod to destroy the state of a provider when it is no longer used, +simply append `.autoDispose` to your provider: ```dart final userProvider = StreamProvider.autoDispose((ref) { @@ -25,12 +30,14 @@ final userProvider = StreamProvider.autoDispose((ref) { }); ``` -就是这样。当不再使用 `userProvider` 时，它的状态将自动被销毁。 +That's it. Now, the state of `userProvider` will automatically be destroyed +when it is no longer used. -注意泛型参数是在`autoDispose`之后而不是之前传递的 —— `autoDispose` 不是一个命名构造器。 +Note how the generic parameters are passed after `autoDispose` instead of before – +`autoDispose` is not a named constructor. :::note -如果你想，你也可以结合 `.autoDispose` 和其他修饰符： +You can combine `.autoDispose` with other modifiers if you need to: ```dart final userProvider = StreamProvider.autoDispose.family((ref, id) { @@ -42,11 +49,13 @@ final userProvider = StreamProvider.autoDispose.family((ref, id) { ### ref.keepAlive -使用 `autoDispose` 的 provider还会添加一个额外的方法到 `ref` 上： `keepAlive`。 +Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. -`keepAlive` 函数用于告诉Riverpod即使不再监听provider的状态也应该保留。 +The `keepAlive` function is used to tell Riverpod that the state of the provider +should be preserved even if no longer listened to. -一个用例是在HTTP请求完成后将此标志设置为 `true`： +A use-case would be to set this flag to `true` after an HTTP request has +completed: ```dart final myProvider = FutureProvider.autoDispose((ref) async { @@ -56,51 +65,56 @@ final myProvider = FutureProvider.autoDispose((ref) async { }); ``` -这样，如果请求失败，用户离开页面，然后重新进入，那么请求将再次执行。 -但是如果请求成功完成，状态将被保留，重新进入就不会触发新的请求。 +This way, if the request fails and the user leaves the screen then re-enters +it, then the request will be performed again. +But if the request completed successfully, the state will be preserved +and re-entering the screen will not trigger a new request. :::info -在1.0.x的版本中， `maintainState` 属性等价于 `keepAlive`。 +In version 1.0.x, the equivalent of `keepAlive` is the property called `maintainState`. ::: -## 示例:取消不再使用的HTTP请求 +## Example: Canceling HTTP requests when no longer used -`autoDispose` 修饰符可以与 [FutureProvider] 和 `ref.onDispose` 结合使用， -以便在不再需要HTTP请求时轻松取消它们。 +The `autoDispose` modifier could be combined with [FutureProvider] and `ref.onDispose` +to easily cancel HTTP requests when they are no longer needed. -目标: +The goal is: -- 当用户进入一个页面时启动一个HTTP请求 -- 如果用户在请求完成前离开页面，则取消HTTP请求 -- 如果请求成功，离开并重新进入页面则不会开始新的请求 +- Start an HTTP request when the user enters a screen +- if the user leaves the screen before the request completed, cancel the HTTP request +- if the request succeeded, leaving and re-entering the screen does not start a new request -下面是代码示例： +In code, this would be: ```dart final myProvider = FutureProvider.autoDispose((ref) async { - // 来自package:dio的一个对象，允许取消http请求 + // An object from package:dio that allows cancelling http requests final cancelToken = CancelToken(); - // 当provider被销毁时，取消http请求 + // When the provider is destroyed, cancel the http request ref.onDispose(() => cancelToken.cancel()); - // 获取我们的数据并传递“cancelToken”来取消工作 + // Fetch our data and pass our `cancelToken` for cancellation to work final response = await dio.get('path', cancelToken: cancelToken); - // 如果请求成功完成，则保持该状态 + // If the request completed successfully, keep the state ref.keepAlive(); return response; }); ``` -## 参数类型 'AutoDisposeProvider' 不能被赋值给参数类型 'AlwaysAliveProviderBase' +## The argument type 'AutoDisposeProvider' can't be assigned to the parameter type 'AlwaysAliveProviderBase' -当使用 `.autoDispose` 时，你可能会发现你的应用在编译时出现类似错误： +When using `.autoDispose`, you may find yourself in a situation where your +application does not compile with an error similar to: > The argument type 'AutoDisposeProvider' can't be assigned to the parameter > type 'AlwaysAliveProviderBase' -不要担心！这个错误是正常的。发生这种情况是因为你很可能编写了一个bug： +Don't worry! This error is voluntary. It happens because you most likely +have a bug: -你试图在未标记 `.autoDispose` 的provider中监听标记了 `.autoDispose` 的provider，例如： +You tried to listen to a provider marked with `.autoDispose` in a provider that +is **not** marked with `.autoDispose`, such as: ```dart final firstProvider = Provider.autoDispose((ref) => 0); @@ -112,9 +126,9 @@ final secondProvider = Provider((ref) { }); ``` -我们不希望这样，因为它将导致 `firstProvider` 永远不会被销毁。 +This is undesired, as it would cause `firstProvider` to never be disposed. -要解决这个问题，可以考虑用 `.autoDispose` 标记 `secondProvider`: +To fix this, consider marking `secondProvider` with `.autoDispose` too: ```dart final firstProvider = Provider.autoDispose((ref) => 0); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx index ae2018282..9c64ba95c 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx @@ -4,23 +4,31 @@ title: .family import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; +import { Link } from "@site/src/components/Link"; -在阅读本文之前，请考虑阅读有关 [providers](/docs/concepts/providers) 的内容以及 [如何读取provider](/docs/concepts/reading)。 -在本部分中，我们将详细讨论`.family`修饰符。 +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + +Before reading this, consider reading about and . +In this part, we will talk in detail about the `.family` provider modifier. -`.family` 修饰符有一个目的：根据外部参数获取唯一的provider。 +The `.family` modifier has one purpose: Getting a unique provider based on external parameters. -比如`family`的一些常用的使用场景： +Some common use-cases for `family` would be: -- 结合 [FutureProvider] 和 `.family` 通过它的ID来获取一条 `消息`。 -- 将当前 `区域` 传递给provider，以便让我们可以处理翻译相关的内容。 +- Combining [FutureProvider] with `.family` to fetch a `Message` from its ID +- Passing the current `Locale` to a provider, so that we can handle translations -## 用法 +## Usage -family的工作方式是向provider添加一个额外的参数。 -然后可以在我们的provider中自由地使用这个参数来创建一些状态。 +The way families works is by adding an extra parameter to the provider. +This parameter can then be freely used in our provider to create some state. -比如说，我们可以组合 `family` 和 [FutureProvider] 通过它的ID来获取一条 `消息` ： +For example, we can combine `family` with [FutureProvider] to fetch +a `Message` from its ID: ```dart final messagesFamily = FutureProvider.family((ref, id) async { @@ -28,8 +36,8 @@ final messagesFamily = FutureProvider.family((ref, id) async { }); ``` -在使用 `messagesFamily` provider时，语法略有不同。 -通常的语法将不能使用： +When using our `messagesFamily` provider, the syntax is slightly different. +The usual syntax will not work anymore: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -38,7 +46,7 @@ Widget build(BuildContext context, WidgetRef ref) { } ``` -相反，我们需要将一个参数传递给 `messagesFamily`： +Instead, we need to pass a parameter to `messagesFamily`: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -47,8 +55,9 @@ Widget build(BuildContext context, WidgetRef ref) { ``` :::info -可以同时使用具有不同参数的 family。 -比如，我们可以使用`titleFamily`同时读取法语和英语的翻译： +It is possible to use a family with different parameters simultaneously. +For example, we could use a `titleFamily` to read both the French and English +translations at the same time: ```dart @override @@ -62,20 +71,22 @@ Widget build(BuildContext context, WidgetRef ref) { ::: -## 参数限制 +## Parameter restrictions -为了让family正常工作，传递给provider的参数必须具有一致的 `hashCode` 和 `==`。 +For families to work correctly, it is critical for the parameter passed to +a provider to have a consistent `hashCode` and `==`. +Ideally, the parameter should either be a primitive (bool/int/double/String), +a constant (providers), or an immutable object that overrides `==` and `hashCode`. -理想情况下，参数应该是基础类型(bool/int/double/String)、常量(providers)或重载 `==` 和 `hashCode` 的不可变对象。 +### _PREFER_ using `autoDispose` when the parameter is not constant: -### 当参数不是常量时_最好_使用`autoDispose`: +You may want to use families to pass the input of a search field to your provider. +But that value can change often and never be reused. +This could cause memory leaks as, by default, a provider is never destroyed even +if no longer used. -你可能希望使用family将搜索内容传递给你的provider。 -但是这个值经常会改变，并且永远不会被重用。 -这可能会导致内存泄漏，因为默认情况下，即使不再使用provider也不会销毁。 - -同时使用 `.family` 和 `.autoDispose` 可以解决内存泄漏的问题： +Using both `.family` and `.autoDispose` fixes that memory leak: ```dart final characters = FutureProvider.autoDispose.family, String>((ref, filter) async { @@ -83,21 +94,21 @@ final characters = FutureProvider.autoDispose.family, String>((r }); ``` -## 将多个参数传递给family +## Passing multiple parameters to a family -family不支持将多个值传递给provider。 +Families have no built-in support for passing multiple values to a provider. On the other hand, that value could be _anything_ (as long as it matches with the restrictions mentioned previously). -另一方面，该值可以是任何东西(只要它在前面提到的限制当中)。 -这包括： +This includes: + +- A tuple from [tuple](http://pub.dev/packages/tuple) +- Objects generated with [Freezed] or [built_value](https://pub.dev/packages/built_value) +- Objects using [equatable](https://pub.dev/packages/equatable) -- 一个元组 [tuple](http://pub.dev/packages/tuple) -- 使用[Freezed] 或 [built_value](https://pub.dev/packages/built_value) 生成的对象 -- 使用 [equatable](https://pub.dev/packages/equatable) 的对象 +Here's an example of using [Freezed] or [equatable] for multiple parameters: -下面是使用 [Freezed] 或 [equatable] 来传递多个参数的示例： +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -## 什么时候创建并销毁我的Provider？ +## When does my Provider get created and disposed? -所有不同类型的provider经历的状态是相同的： +The states that all different types of providers can go through are the same: -- 未初始化 -- 活动中 -- 暂停 -- 已销毁 +- Uninitialized +- Alive +- Paused +- Disposed -### 已销毁 / 未初始化 +### Disposed / Uninitialized -**未初始化**或**已销毁**的provider不占用任何内存，因为它的状态没有初始化。 -从本质上来说，它只是定义了在你需要时如何创建provider的状态。 -它将一直保持这种状态，直到**活动中**provider被创建或由于UI中的[WidgetRef] 读取、观察或监听它。 +An **Uninitialized** or **Disposed** provider does not take up any memory since its state is not initialized. +Essentially it is just a definition of how to create the provider's state when you need it. +It will stay that way until an **Alive** provider or a [WidgetRef] from the UI reads, watches, or listens to it. -### 创建中 -> 活动中 +### Creating -> Alive -当读取、监听或观察**未初始化**的provider时，将创建其状态。 +When an **Uninitialized** provider is read, listened to or watched it's state will be created. -在创建期间，你的provider的构建函数将会运行。 -使用回调函数所暴露的 `ref` 读取(read)或观察(watch)的任何provider将根据需要创建，并且将检索它们的状态。 +During creation your provider's build function will be run. +Any providers that you read or watch using the `ref` exposed by the callback will be created as needed and their state will be retrieved. -如果在创建过程中存在任何循环依赖关系，Riverpod将抛出一个错误。 -修复此错误的最佳方式是重新设计依赖项，使其具有单向数据流。 +If there are any circular dependencies during this creation process Riverpod will throw an error. +The best way to fix this error is to redesign your dependencies to have a uni-directional dataflow. -provider的状态存储在 [ProviderContainer] 中。在Flutter应用中，此容器位于[ProviderScope] widget中。 +The provider's state is stored in a [ProviderContainer]. In a Flutter app this container is in a [ProviderScope] widget. -因此，尽管如何创建状态(provider)的定义是全局的，但状态实际上是本地的， -并且使用嵌套的[ProviderScope] widget和覆盖在UI的不同部分中有所不同。 +As such, even though the definition of how to create the state (the provider) is global, the state is actually local, +and can be different in different portions of your UI using nested [ProviderScope] widgets and overrides. -这与flutter widget的工作方式非常相似。你只需为其定义一次， -但是可以根据需要在树的不同部分重用状态。 +This is very similar to how flutter widgets work. You only pay for the definition once, but can reuse the state in different parts of the tree as needed. -### 活动中 +### Alive -当你的provider为**活动中**时，对其状态的更改将导致依赖的provider和/或依赖的UI重新构建。 +When your provider is **Alive**, changes to its state will cause dependent providers and/or the dependent UI to rebuild. -从另一个角度来看，作为响应式框架，你可以观察其他provider，以便在它的某个依赖项发生变化时重建自己。 +From the other perspective, as a reactive framework, you can watch other providers to have the provider recreate itself whenever one of it's dependencies changes. -如果你需要一些依赖于其他状态的长期状态，你可以使用Ref的 [listen] 方法来订阅另一个provider上的更改，而不会导致重新构建该provider。 +If you need to have some long-lived state that depends on other state you can use Ref's [listen] method to subscribe for changes on another provider without causing a rebuild of the provider. -如果你需要使用来自另一个可能有副作用的provider的状态，你可以使用Ref的[read]方法从另一个provider获取当前状态。 +If you need to use the state from another provider in a side-effect, you can use Ref's [read] method to obtain the current state from another provider. -通常，在构造 [StateNotifier] 或 [ChangeNotifier] 类时，应该传入引用， -以允许Notifier根据需要获取依赖项的当前值。 -通过使用来自Riverpod 2.0的新[Notifier] 和 [AsyncNotifier]类，ref已经作为类的实例成员可用。 +Typically when constructing a [StateNotifier] or [ChangeNotifier] class you should pass in the `ref` to allow the Notifier to obtain the current value of dependencies as needed. By using the new [Notifier] and [AsyncNotifier] classes from Riverpod 2.0, the ref is already available as an instance member of the class. -### 活动中 -> 暂停 -当其他provider或UI不再监听**活动的** provider时，它将进入**暂停**状态。这意味着它将不再对正在监听的provider的更改做出反应。 -这是一种优化，如果你没有监听的provider，就没有必要让它保持活动状态。每个未被使用的provider都将返回到**暂停**状态，从而减少你的应用的计算负担。 +### Alive -> Paused +When an **Alive** provider is no longer listened to by other providers or the UI, it goes into a **Paused** state. +This means that it no longer will react to changes on providers it is listening to. +This is an optimization, as if you are not listening to the provider, there is no need to keep it alive. +Every provider not being used will be returned to a **Paused** state, reducing the computational burden of your app. -如果你需要让provider保持活动状态以防止副作用发生，请确保在UI中应该保持活动状态的适当位置监听它。 +If you need to keep a provider alive for side-effects, make sure to listen to it in an appropriate place in the UI where it should be kept alive. -如果你需要在provider暂停时执行一些操作，请使用ref的 [onCancel] 方法来注册回调函数。 +If you need to perform some action when a provider is paused use the ref's [onCancel] method to register callbacks. -当provider从暂停状态恢复到活动状态时，如果你需要执行一些操作，请使用ref的[onResume]方法来注册回调。 +If you need to perform some action when a provider resumes to an Alive state from a paused state, use the ref's [onResume] method to register callbacks. -如果你想销毁状态，那么除了不占用计算资源外，还可以销毁状态的内存，请在provider上使用`.autoDispose`修饰符。 -这将导致它在不再被使用时转换到**已销毁**状态，而不是**暂停**状态。 +If you want the state to be disposed, so that in addition to taking no computational resources, it also disposes of the memory of the state, use the `.autoDispose` modifier on your provider definition. +This will cause it to transition to a **Disposed** state instead of **Paused** when it is no longer being used. -### 活动中 -> 销毁中 +### Alive -> Disposing -销毁provider有几个原因。 +There are a few reasons for a provider to be disposed. -- 当使用`.autoDispose`修饰符定义并不再被UI或其他providerg观察时 -- 当手动刷新或provider失效时 -- 当provider由于被监视的依赖项之一发生变化而被重新创建时 +- When defined using the `.autoDispose` modifier and no longer being watched by the UI or another provider +- When the provider is being manually refreshed or invalidated +- When the provider is being recreated due to one of it's watched dependencies changing -刷新会导致provider立即再次执行创建过程，而无效则会导致provider的下一次读取/观察导致重新构建provider。 +Refreshing causes the provider to immediately go through the creation process again, whereas invalidating causes the next read / watch of the provider to cause the provider to be rebuilt. -## 在状态被销毁前执行操作 -如果你需要在销毁provider时执行一些操作，使用ref的 [onDispose] 方法来注册回调函数。 +## Performing actions before the state destruction +If you need to perform some action when a provider is disposed, use the ref's [onDispose] method to register callbacks. -下面的例子使用onDispose关闭StreamController： +The following example uses onDispose to close a StreamController: :::note -根据所使用的provider，它可能已经处理了清理过程。 -例如，[StateNotifierProvider] 将调用返回的 [StateNotifier] 的`dispose`方法。 +Depending on the provider used, it may already take care of the clean-up process. +For example, [StateNotifierProvider] will call the `dispose` method of the returned [StateNotifier]. ::: [onDispose]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/onDispose.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx index e7584160c..88bec051e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx @@ -4,25 +4,35 @@ title: ProviderObserver import CodeBlock from "@theme/CodeBlock"; import logger from "!!raw-loader!/docs/concepts/provider_observer_logger.dart"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet } from "@site/src/components/CodeSnippet"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -[ProviderObserver] 可以监听ProviderContainer的变更。 +[ProviderObserver] listens to the changes of a ProviderContainer. -要使用它，请扩展ProviderObserver类并重写要使用的方法。 +To use it, extend the class ProviderObserver and override the method you want to use. -[ProviderObserver] 有三种方法： +[ProviderObserver] has three methods : -- 每次初始化provider时都会调用 `didAddProvider`，并且将值暴露为 `value`。 -- 每次销毁provider时都会调用 `didDisposeProvider`。 -- 每当provider发出通知时，都会调用 `didUpdateProvider`。 +- `didAddProvider` is called every time a provider was initialized, and the value exposed is `value`. +- `didDisposeProvider` is called every time a provider was disposed. +- `didUpdateProvider` is called every time by providers when they emit a notification. -### 用法 +### Usage : -[ProviderObserver] 的一个简单用例是通过重写 `didUpdateProvider` 方法来记录provider中的更改。 +A simple use case for [ProviderObserver] is to log the changes in providers by overriding the `didUpdateProvider` method. {trimSnippet(logger)} -现在，每当我们的provider的值被更新时，记录器都会记录它： +Now, every time the value of our provider is updated, the logger will log it: ``` I/flutter (16783): { @@ -31,12 +41,11 @@ I/flutter (16783): "newValue": "1" I/flutter (16783): } ``` -:::note -对于可变的状态，例如 [StateController] ([StateProvider.state] 的状态)和[ChangeNotifier]， -新旧值将会是相同的。 +:::note: +For states that are mutable such as [StateController] (the state of [StateProvider.state]) and +[ChangeNotifier] the previousValue and newValue will be the same ::: since they reference the same `StateController` / `ChangeNotifier`. -由于他们引用了相同的`StateController` / `ChangeNotifier`。 [providerobserver]: https://pub.dev/documentation/riverpod/latest/riverpod/ProviderObserver-class.html [statecontroller]: https://pub.dev/documentation/riverpod/latest/riverpod/StateController-class.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart new file mode 100644 index 000000000..40f8120e6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -0,0 +1,61 @@ +// ignore_for_file: use_key_in_widget_constructors, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +// A Counter example implemented with riverpod with Logger + +class Logger extends ProviderObserver { + @override + void didUpdateProvider( + ProviderBase provider, + Object? previousValue, + Object? newValue, + ProviderContainer container, + ) { + print(''' +{ + "provider": "${provider.name ?? provider.runtimeType}", + "newValue": "$newValue" +}'''); + } +} + +void main() { + runApp( + // Adding ProviderScope enables Riverpod for the entire project + // Adding our Logger to the list of observers + ProviderScope(observers: [Logger()], child: const MyApp()), + ); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return MaterialApp(home: Home()); + } +} + +final counterProvider = StateProvider((ref) => 0, name: 'counter'); + +class Home extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final count = ref.watch(counterProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Counter example')), + body: Center( + child: Text('$count'), + ), + floatingActionButton: FloatingActionButton( + onPressed: () => ref.read(counterProvider.notifier).state++, + child: const Icon(Icons.add), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers.mdx index ff5a7ac2f..e3831587e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers.mdx @@ -2,80 +2,102 @@ title: Providers --- -现在我们安装了 [Riverpod], 接下来我们讲一下 "providers" 相关的概念。 +import creatingProvider from "./providers/creating_a_provider"; +import declaringManyProviders from "./providers/declaring_many_providers"; +import { + AutoSnippet, +} from "@site/src/components/CodeSnippet"; +import { Link } from "@site/src/components/Link"; -Providers 是 [Riverpod] 应用重要的组成部分。 -provider是一个封装了一部分状态的对象，并且能够监听其中的状态。 +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -## 为什么要使用providers? +Now that we have installed [Riverpod], let's talk about "providers". -将一部分状态包裹在provider中: +Providers are the most important part of a [Riverpod] application. +A provider is an object that encapsulates a piece of state and allows listening +to that state. -- 允许在各种地方简单地访问所需的状态。 Provider可以完全取代各种编程模式，比如： - 单例模式、服务定位器模式、依赖注入或 InheritedWidgets。 +## Why use providers? -- 与其他状态组合很容易。 - 想要将多个对象合并成一个对象而感到苦恼? Provider自带了这个功能。 +Wrapping a piece of state in a provider: -- 性能优化。 - 无论是筛选功能的widget还是缓存一个计算量比较大的状态， - provider能够确保只有受状态变化影响的部分才会被重新计算。 +- Allows easily accessing that state in multiple locations. + Providers are a complete replacement for patterns like Singletons, + Service Locators, Dependency Injection or InheritedWidgets. -- 提高你的应用程序的可测试性。 - 使用 provider， 你不需要复杂的 `setUp`/`tearDown` (配置/销毁) 的过程。 - 除此之外，在测试中，任何provider都可以覆盖不同的行为，这能够轻松地测试非常特殊的行为。 +- Simplifies combining this state with others. + Ever struggled to merge multiple objects into one? This scenario is built + directly inside providers. -- 能够方便地集成一些高级的功能, 比如登录或下拉刷新. +- Enables performance optimizations. + Whether for filtering widget rebuilds or for caching expensive state computations; + providers ensure that only what is impacted by a state change is recomputed. -## 创建一个provider +- Increases the testability of your application. + With providers, you do not need complex `setUp`/`tearDown` steps. Furthermore, + any provider can be overridden to behave differently during a test, which + allows easily testing a very specific behavior. -Provider有许多变体，但它们的工作方式都是一样的。 +- Allows easy integration with advanced features, such as logging or + pull-to-refresh. -如下所示，最常见的使用方法是将它们声明为全局常量： +## Creating a provider -```dart -final myProvider = Provider((ref) { - return MyValue(); -}); -``` +Providers come in many variants, but they all work the same way. + +The most common usage is to declare them as global constants like so: + + :::note -不要因为provider的功能全面而感到害怕。Provider是完全不可变的。 -定义一个provider和定义一个函数一样简单，而且provider是可测试和可维护的。 +Do not be frightened by the global aspect of providers. +Providers are fully immutable. Declaring a provider is no different from declaring +a function, and providers are testable and maintainable. ::: -这段代码由三部分组成: +This snippet consists of three components: -- `final myProvider`, 声明myProvider这个变量。 - 这个变量我们将会用来读取其中的状态。 Provider应当一直是 `final`的。 +- `final myProvider`, the declaration of a variable. + This variable is what we will use in the future to read the state of our provider. + Providers should always be `final`. -- `Provider`, 我们决定使用的provider类型。 - [Provider] 大多数provider类型的基础。 它暴露了一个永远不会改变的常量。 - 我们可以吧 [Provider] 换成 其他provider 比如：[StreamProvider] 或 [StateNotifierProvider] - 来改变其中状态的类型。 +- `Provider`, the provider that we decided to use. + [Provider] is the most basic of all providers. It exposes an object that never + changes. + We could replace [Provider] with other providers like [StreamProvider] or + [NotifierProvider], to change how the value is interacted with. -- 一个创建共享状态的函数。 - 那个函数会接收一个叫`ref`的对象作为参数。这个`ref`对象能够让我们在函数中读取其他的provider， - 当provider中的状态需要销毁时执行一些操作等等。 +- A function that creates the shared state. + That function will always receive an object called `ref` as a parameter. This object + allows us to read other providers, perform some operations when the state + of our provider will be destroyed, and much more. -provider中的函数返回的对象类型取决于使用provider类型。 -比如一个 [Provider] 的函数中可以返回任意的对象。 -再比如说[StreamProvider]中的函数的返回值类型只能是[Stream]。 +The type of the object returned by the function passed to a provider depends on +the provider used. +For example, the function of a [Provider] can create any object. +On the other hand, [StreamProvider]'s callback will be expected to return a [Stream]. :::info -你可以没有限制地声明各种provider。 -与使用 `package:provider` 相反, [Riverpod] 允许创建多个相同类型且暴露不同状态的provider： +You can declare as many providers as you want without limitations. +As opposed to when using `package:provider`, [Riverpod] allows creating multiple +providers exposing a state of the same "type": -```dart -final cityProvider = Provider((ref) => 'London'); -final countryProvider = Provider((ref) => 'England'); -``` + -创建都是`String`类型的provider不会有任何问题。 +The fact that both providers create a `String` does not cause any problem. ::: :::caution -在Flutter平台上，为了让provider正常工作，你必须用 [ProviderScope] 包裹你的Flutter应用： +For providers to work, you must add [ProviderScope] at the root of your +Flutter applications: ```dart void main() { @@ -85,48 +107,52 @@ void main() { ::: -## 不同类型的Provider +## Different Types of Providers -有很多类型的provider可供在不同的情况下使用。 +There are multiple types of providers for multiple different use cases. -由于这些不同类型provider都可使用，有的时候很难理解什么时候应该使用这种provider而不是另外一种provider。 -选择下面表格中的provider添加到你的应用中。 +With all of these providers available, it is sometimes difficult to understand when to use one provider type over another. +Use the table below to choose a provider that fits what you want to provide to the widget tree. -| Provider 类型 | 创建Provider的函数 | 使用场景 | -| ------------------------ | -------------------------- | -------------------------------------------------- | -| [Provider] | 返回任意类型 | 服务类 / 计算属性 (过滤的列表) | -| [StateProvider] | 返回任意类型 | 过滤条件/简单状态对象 | -| [FutureProvider] | 返回任意类型的Future | API调用的结果 | -| [StreamProvider] | 返回任意类型的Stream | API返回的Stream | -| [StateNotifierProvider] | 返回StateNotifier的子类 | 一种复杂的状态对象，除了通过接口之外，它是不可变的 | -| [ChangeNotifierProvider] | 返回ChangeNotifier的子类 | 需要可变的复杂状态对象 | +| Provider Type | Provider Create Function | Example Use Case | +| ------------------------ | ------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| [Provider] | Returns any type | A service class / computed property (filtered list) | +| [StateProvider] | Returns any type | A filter condition / simple state object | +| [FutureProvider] | Returns a Future of any type | A result from an API call | +| [StreamProvider] | Returns a Stream of any type | A stream of results from an API | +| [NotifierProvider] | Returns a subclass of (Async)Notifier | A complex state object that is immutable except through an interface | +| [StateNotifierProvider] | Returns a subclass of StateNotifier | A complex state object that is immutable except through an interface. Prefer using a notifierProvider | +| [ChangeNotifierProvider] | Returns a subclass of ChangeNotifier | A complex state object that requires mutability | :::caution -尽管所有的provider都有它的使用目的，由于 [不可变状态相关的问题](/docs/concepts/why_immutability) 的原因， -我们不推荐在较大型的应用程序中使用 [ChangeNotifierProvider] 。 -`flutter_riverpod` 中的 [ChangeNotifierProvider] 提供了一个简单的方式来让你从 `package:provider` 迁移到 [riverpod] ， -这允许一些 flutter 上一些特定的用法比如与Navigator 2 package 集成。 -::: +While all providers have their purpose, [ChangeNotifierProvider]s are not recommended for scalable applications. See . It exists in the +`flutter_riverpod` package to provide an easy migration path from +`package:provider`, and allows for some flutter specific use-cases such as +integration with some Navigator 2 packages. ::: -## Provider 修饰符 +## Provider Modifiers -所有的Provider都有一个内置的方式为不同的provider添加额外的功能。 +All Providers have a built-in way to add extra functionalities to your different providers. -它们可能会向`ref`对象添加额外的功能或改变provider的使用方式。 -修饰符可以在所有provider上通过简单的命名构造器使用： +They may add new features to the `ref` object or change slightly how the provider +is consumed. +Modifiers can be used on all providers, with a syntax similar to named constructor: ```dart final myAutoDisposeProvider = StateProvider.autoDispose((ref) => 0); final myFamilyProvider = Provider.family((ref, id) => '$id'); ``` -目前有两个修饰符可用: +At the moment, there are two modifiers available: -- [`.autoDispose`](/docs/concepts/modifiers/auto_dispose)可以在状态不在被监听的情况下让provider自动销毁。 -- [`.family`](/docs/concepts/modifiers/family)可以创建有外部参数的provider。 +- , which will make the + provider automatically destroy its state when it is no longer being listened + to. +- , which allows creating a + provider from external parameters. :::note -provider能一次使用多个修饰符: +A provider can use multiple modifiers at once: ```dart final userProvider = FutureProvider.autoDispose.family((ref, userId) async { @@ -136,10 +162,10 @@ final userProvider = FutureProvider.autoDispose.family((ref, userId) ::: -着就是本指南的内容! +That's it for this guide! -继续阅读 [如何读取provider](/docs/concepts/reading) -或者学习 [如何组合provider](/docs/concepts/combining_providers)。 +You can continue with . +Alternatively, you can see . [get_it]: http://pub.dev/packages/get_it [inheritedwidget]: https://api.flutter.dev/flutter/widgets/InheritedWidget-class.html @@ -154,6 +180,6 @@ final userProvider = FutureProvider.autoDispose.family((ref, userId) [futureprovider]: /docs/providers/future_provider [stateprovider]: /docs/providers/state_provider [statenotifierprovider]: /docs/providers/state_notifier_provider +[notifierProvider]: /docs/providers/notifier_provider [changenotifierprovider]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ChangeNotifierProvider-class.html - [providerscope]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ProviderScope-class.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart new file mode 100644 index 000000000..8dc6c5e12 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart @@ -0,0 +1,12 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class MyValue {} + +/* SNIPPET START */ + +@riverpod +MyValue my(MyRef ref) { + return MyValue(); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart new file mode 100644 index 000000000..71bf0484e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myHash() => r'0810ee24cae78c131d00773ac20d254c83eefab7'; + +/// See also [my]. +@ProviderFor(my) +final myProvider = AutoDisposeProvider.internal( + my, + name: r'myProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef MyRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart new file mode 100644 index 000000000..d63faf94b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart @@ -0,0 +1,9 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class MyValue {} + +/* SNIPPET START */ + +final myProvider = Provider((ref) { + return MyValue(); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart new file mode 100644 index 000000000..a9472e02a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart @@ -0,0 +1,11 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +String city(CityRef ref) => 'London'; +@riverpod +String country(CountryRef ref) => 'England'; + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart new file mode 100644 index 000000000..84913df77 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +/// See also [city]. +@ProviderFor(city) +final cityProvider = AutoDisposeProvider.internal( + city, + name: r'cityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$cityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CityRef = AutoDisposeProviderRef; +String _$countryHash() => r'd1513349c3bc0c99763cb4fb29eb012f2351bc4c'; + +/// See also [country]. +@ProviderFor(country) +final countryProvider = AutoDisposeProvider.internal( + country, + name: r'countryProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$countryHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CountryRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart new file mode 100644 index 000000000..60a3d4786 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart @@ -0,0 +1,6 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +final cityProvider = Provider((ref) => 'London'); +final countryProvider = Provider((ref) => 'England'); \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading.mdx index 3f6c19154..fffa27013 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading.mdx @@ -1,9 +1,7 @@ --- -title: 读取 Provider +title: Reading a Provider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import counter from "./reading/counter"; import consumerWidget from "./reading/consumer_widget"; @@ -22,58 +20,74 @@ import { trimSnippet, AutoSnippet, When, -} from "../../../../../src/components/CodeSnippet"; +} from "@site/src/components/CodeSnippet"; +import { Link } from "@site/src/components/Link"; -在阅读本指南之前，请确保先阅读有关[Providers](/docs/concepts/providers)的内容。 +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: + +Before reading this guide, make sure to first. -在本指南中，我们将了解如何使用provider。 +In this guide, we will see how to consume a provider. -## 获取一个“ref”对象 +## Obtaining a "ref" object -首先，也是最重要的，在读取provider之前，我们需要获取一个“ref”对象。 +First and foremost, before reading a provider, we need to obtain a "ref" object. -这个对象能够让我们与provider交互，不管是来自widget还是其他provider。 +This object is what allows us to interact with providers, be it from a widget +or another provider. -### 从provider获取“ref” +### Obtaining a "ref" from a provider -所有provider都接收一个“ref”作为参数： +All providers receive a "ref" as a parameter: -将此参数传递给provider暴露的值是安全的。 +This parameter is safe to pass to the value exposed by the provider. -一个常见的用例是将provider的“ref”传递给`StateNotifier` +A common use-case is to pass the provider's "ref" to a `StateNotifier` -这样做允许`Counter`类读取provider。 +Doing so allows our `Counter` class to read providers. -### 从widget获取“ref” +### Obtaining a "ref" from a widget -Widget自然没有ref参数。但是 [Riverpod] 提供了多种从widget中获取ref的解决方案。 +Widgets naturally do not have a ref parameter. But [Riverpod] offers multiple +solutions to obtain one from widgets. -#### 扩展ConsumerWidget而不是StatelessWidget +#### Extending ConsumerWidget instead of StatelessWidget -在widget树中获取ref的最常用方法是将 [StatelessWidget] 替换为 [ConsumerWidget] 。 +The most common way to obtain a ref in the widget tree is +to replace [StatelessWidget] with [ConsumerWidget]. -[ConsumerWidget] 在用法上与 [StatelessWidget] 相同，唯一的区别是它在构建方法上有一个额外的参数:“ref”对象。 +[ConsumerWidget] is identical in use to [StatelessWidget], with the only +difference being that it has an extra parameter on its build method: the "ref" object. -一个典型的 [ConsumerWidget] 如下所示: +A typical [ConsumerWidget] looks like: -#### 扩展ConsumerStatefulWidget+ConsumerState而不是StatefulWidget+State +#### Extending ConsumerStatefulWidget+ConsumerState instead of StatefulWidget+State -与 [ConsumerWidget] 类似， [ConsumerStatefulWidget] 和 [ConsumerState] -等价于带有状态的StatefulWidget，区别在于状态中有一个“ref”对象。 +Similar to [ConsumerWidget], [ConsumerStatefulWidget] and [ConsumerState] are the equivalent of a +[StatefulWidget] with its [State], with the difference that the state has a "ref" object. -这一次，“ref”没有作为构建方法的参数传递，而是作为 [ConsumerState] 对象的属性传递： +This time, the "ref" isn't passed as parameter of the build method, but is +a property of the [ConsumerState] object: @@ -81,226 +95,251 @@ Widget自然没有ref参数。但是 [Riverpod] 提供了多种从widget中获 -#### 扩展HookConsumerWidget类而不是HookWidget类 +#### Extending HookConsumerWidget instead of HookWidget -此选项适用于使用 [flutter_hooks] 的用户。由于 [flutter_hooks] 需要扩展 [HookWidget] 才能工作， -使用钩子的widget无法扩展 [ConsumerWidget]。 +This option is for [flutter_hooks] users. Since [flutter_hooks] requires +extending [HookWidget] to work, widgets that use hooks are unable to extend +[ConsumerWidget]. -[hooks_riverpod] package 暴露了一个名为 [HookConsumerWidget] 的widget。 -[HookConsumerWidget] 同时充当 [ConsumerWidget] 和 [HookWidget]。 -这允许widget既监听provider又使用钩子。 +The package [hooks_riverpod] exposes a new widget called [HookConsumerWidget]. +[HookConsumerWidget] acts as both a [ConsumerWidget] and a [HookWidget]. This +allows a widget to both listen to providers and use hooks. -比如说： +An example would be: -#### 扩展 StatefulHookConsumerWidget 而不是 HookWidget +#### Extending StatefulHookConsumerWidget instead of HookWidget -此选项适用于 [flutter_hooks] 用户，他们需要使用 [StatefulWidget] 生命周期方法还有钩子。 +This option is for [flutter_hooks] users, who need to use [StatefulWidget] lifecycle methods in addition to hooks. + +An example would be: -举个例子： -#### Consumer 和 HookConsumer widgets +#### Consumer and HookConsumer widgets -获得widget内部的“ref”的最后一种方法是依赖 [Consumer]/[HookConsumer]。 +A final way to obtain a "ref" inside widgets is to rely on [Consumer]/ +[HookConsumer]. -这些类是可用于在build回调中获取“ref”的widget，具有与 [ConsumerWidget]/[HookConsumerWidget] 相同的属性。 +These classes are widgets that can be used to obtain a "ref" in a builder callback, with the same +properties as [ConsumerWidget]/[HookConsumerWidget]. -因此，这些widget是一种不需要定义类就能获得“ref”的方法。比如： +As such, these widgets are a way to obtain a "ref" without having to define a class. +An example would be: {trimSnippet(consumerHook)} -## 使用ref与provider交互 +## Using ref to interact with providers -现在我们有了一个“ref”，我们可以开始使用它了。 +Now that we have a "ref", we can start using it. -“ref”有三种主要用法： +There are three primary usages for "ref": -- 获取provider的值并监听更改，这样当该值发生更改时， - 将重新构建订阅该值的widget或provider。 - 这是使用 `ref.watch` 完成的 -- 在provider上添加监听器，以执行诸如导航到新页面或每当provider更改时显示模态框等操作。 - 这是使用 `ref.listen` 完成的。 -- 在忽略更改的情况下获取provider的值。 - 当我们在诸如“on click”之类的事件中需要provider的值时很有用。 - 这是使用 `ref.read` 完成的。 +- obtaining the value of a provider and listening to changes, such that when + this value changes, this will rebuild the widget or provider that subscribed + to the value. + This is done using `ref.watch` +- adding a listener on a provider, to execute an action such as navigating to a new + page or showing a modal whenever that provider changes. + This is done using `ref.listen`. +- obtaining the value of a provider while ignoring changes. + This is useful when we need the value of a provider in an event + such as "on click". + This is done using `ref.read`. :::note -尽可能使用 `ref.watch` 而不是 `ref.read` 或 `ref.listen` 来实现你的功能。 -通过依赖 `ref.watch` ，你的应用变得既具有响应性又具有声明性，这使得项目会更易于维护。 +Whenever possible, prefer using `ref.watch` over `ref.read` or `ref.listen` to +implement a feature. +By relying on `ref.watch`, your application becomes both reactive +and declarative, which makes it more maintainable. ::: ### Using ref.watch to observe a provider -### 使用 ref.watch 观察provider -Ref.watch在widget的`build`方法中或在provider的主体中使用，以使widget/provider监听provider： +`ref.watch` is used inside the `build` method of a widget or +inside the body of a provider to have the widget/provider listen to a provider: -例如，一个provider可以使用 `ref.watch` 将多个provider组合成一个新值。 +For example, a provider could use `ref.watch` to combine multiple providers +into a new value. -筛选待办清单就是一个例子。我们可以有两个provider： +An example would be filtering a todo-list. +We could have two providers: -- `filterTypeProvider`，一个能够暴露当前过滤器类型(不显示，只显示完成的内容等等)的provider。 - -- `todosProvider`，暴露整个待办清单列表的provider。 +- `filterTypeProvider`, a provider that exposes the current type of filter + (none, show only completed tasks, ...) +- `todosProvider`, a provider that exposes the entire list of tasks -通过 `ref.watch`，我们可以创建第三个provider， -它结合了这两个provider来创建一个过滤过的待办清单列表： +And by using `ref.watch`, we could make a third provider that combines both providers to +create a filtered list of tasks: -有了这段代码，`filteredTodoListProvider` 现在暴露了过滤后的清单列表。 +With this code, `filteredTodoListProvider` now exposes the filtered list of tasks. -如果筛选器或待办清单列表发生变化，筛选后的列表也会自动更新。 -同时，如果过滤器和待办清单列表都没有改变，则不会重新计算那个列表。 +The filtered list will also automatically update if either the filter or the list of tasks +changed. At the same time, the filtered list will not be recomputed if +neither the filter nor the list of tasks changed. -类似地，widget可以使用ref.watch显示来自provider的内容， -并在内容发生变化时更新用户界面： +Similarly, a widget can use `ref.watch` to show +the content from a provider and update the user interface whenever that content changes: -这个代码段显示了一个widget，它监听了存储`count`的provider。 -如果该`count`发生变化，widget将重新构建，UI将更新以显示新的值。 +This snippet shows a widget that listens to a provider which stores a `count`. +And if that `count` changes, the widget will rebuild and the UI will update +to show the new value. :::caution -像在 [ElevatedButton] 的 `onPressed` 中那样，`watch` 方法不应该被异步调用。 -它也不应该在 `initState` 和其他 [State] 的生命周期中使用。 +The `watch` method should not be called asynchronously, +like inside an `onPressed` of an [ElevatedButton]. Nor should it be used +inside `initState` and other [State] life-cycles. -在这种情况下，请考虑使用 `ref.read`。 +In those cases, consider using `ref.read` instead. ::: -### 使用ref.listen来响应provider的变化 +### Using ref.listen to react to a provider change -与 `ref.watch` 类似，也可以使用ref.listen来观察一个provider。 +Similarly to `ref.watch`, it is possible to use `ref.listen` to observe a provider. The main difference between them is that, rather than rebuilding the widget/provider if the listened to provider changes, using `ref.listen` will instead call a custom function. -它们之间的主要区别是，如果监听的provider发生更改， -使用 `ref.listen` 将调用自定义的函数，而不是重新构建widget/provider。 -这对于在发生特定变化时执行操作很有用，例如在发生错误时显示snackbar。 +That can be useful for performing actions when a certain change happens, such +as showing a snackbar when an error happens. -`ref.listen` 方法需要两个位置参数，第一个是Provider，第二个是当状态改变时我们想要执行的回调函数。 -当调用回调函数时将传递前一个状态的值和新状态的值。 +The `ref.listen` method needs 2 positional arguments, the first one is the Provider and the second one is the callback function that we want to execute when the state changes. +The callback function when called will be passed 2 values, the value of the previous State and the value of the new State. -`ref.listen` 方法可以在provider内部使用： +The `ref.listen` method can be used inside the body of a provider: -或者在widget的 `build` 方法中： +or inside the `build` method of a widget: :::caution -像在 [ElevatedButton] 的 `onPressed` 中那样，`listen` 方法不应该被异步调用。 -它也不应该在 `initState` 和其他 [State] 的生命周期中使用。 +The `listen` method should not be called asynchronously, +like inside an `onPressed` of an [ElevatedButton]. Nor should it be used +inside `initState` and other [State] life-cycles. ::: -### 使用ref.read获取一个provider的状态 +### Using ref.read to obtain the state of a provider -`ref.read` 是一种不监听provider状态的方法。 +The `ref.read` method is a way to obtain the state of a provider without listening to it. -它通常在用户交互触发的函数中使用。 -例如，我们可以使用 `ref.read` 在用户单击按钮时将计数器数值加1： +It is commonly used inside functions triggered by user interactions. +For example, we can use `ref.read` to increment a counter when a user clicks a button: :::note -你应该尽量避免使用 `ref.read` ，因为它不是响应式的。 +Using `ref.read` should be avoided as much as possible because it is not reactive. -它的存在是由于使用 `watch` 或 `listen` 会导致问题。如果可以，使用 `watch`/`listen` 更好，尤其是 `watch`。 +It exists for cases where using `watch` or `listen` would cause issues. +If you can, it is almost always better to use `watch`/`listen`, especially `watch`. ::: -#### **不要**在build方法中使用 `ref.read` +#### **DON'T** use `ref.read` inside the build method -你可能会想使用 `ref.read` 来优化widget的性能： +You might be tempted to use `ref.read` to optimize the performance of a widget +by doing: -但这样做是非常糟糕的，它可能会导致预料之外的bug。 +But this is a very bad practice and can cause bugs that are difficult to track. -以这种方式使用 `ref.read` 通常会让人觉得“provider暴露的值永远不会改变， -所以使用 `ref.read` 是安全的”。但问题是， -虽然现在的provider可能确实永远不会更新它的值，但你无法保证以后的值还是一样的。 +Using `ref.read` this way is commonly associated with the thought "The value +exposed by a provider never changes so using 'ref.read' is safe". The problem +with this assumption is that, while today that provider may indeed never update +its value, there is no guarantee that tomorrow will be the same. -应用往往会发生很多变更，假设在未来，以前从未改变的一个值将需要改变。 -如果你使用 `ref.read`，当该值需要更改时，你必须遍历整个代码库将 `ref.read` 更改为 `ref.watch`， -这很容易出错，而且你很可能会忘记某些情况。 +Software tends to change a lot, and it is likely that in the future, a value +that previously never changed will need to change. +If you use `ref.read`, when that value needs to change, you have +to go through your entire codebase to change `ref.read` into `ref.watch` – +which is error prone and you are likely to forget some cases. -但如果一开始就使用 `ref.watch`，当你重构时遇到的问题就会更少。 +If you use `ref.watch` to begin with, you will have fewer problems when refactoring. -**_但是我想要用 `ref.read` 来减少小部件重新构建的次数_** +**_But I wanted to use `ref.read` to reduce the number of times my widget rebuilds_** -这个想法很好，但需要注意的是，使用 `ref.watch` 也可以达到完全相同的效果(减少重新构建的次数)。 +While the goal is commendable, it is important to note that you can achieve the +exact same effect (reducing the number of builds) using `ref.watch` instead. -provider提供了许多获取值的方法，同时也减少了重新构建的次数，你可以使用这些方法。 +Providers offer various ways to obtain a value while reducing the number of +rebuilds, which you could use instead. -比如，不应该这样： +For example instead of -我们应该: +we could do: -这两段代码实现了相同的效果：当计数器增加时，我们的按钮也不会重新构建。 +Both snippets achieve the same effect: our button will not rebuild when the +counter increments. -另一方面，第二种方法支持重置计数器。例如，应用的另一部分可以调用： +On the other hand, the second approach supports cases where the counter is reset. +For example, another part of the application could call: ```dart ref.refresh(counterProvider); ``` + +which would recreate the `StateController` object. - -来重新创建 `Counter` 对象。 - -如果我们在这里使用 `ref.read`，我们的按钮仍将使用之前的 `StateController` 实例， -但实际上该实例已被丢弃，不应该再使用。 -当我们正确使用 `ref.watch` 将重新构建按钮以使用新的 `Counter`实例 +If we used `ref.read` here, our button would still use the previous +`StateController` instance, which was disposed and should no-longer be used. +Whereas using `ref.watch` correctly rebuilds the button to use the new +`StateController`. -来重新创建 `Counter` 对象。 +which would recreate the `Counter` object. -如果我们在这里使用 `ref.read`，我们的按钮仍将使用之前的 `Counter` 实例， -但实际上该实例已被丢弃，不应该再使用。 -而正确使用 `ref.watch` 将重新构建按钮以使用新的 `Counter`实例。 +If we used `ref.read` here, our button would still use the previous `Counter` +instance, which was disposed and should no-longer be used. Whereas using +`ref.watch` correctly rebuilds the button to use the new `Counter`. -## 选择读取的方式 +## Deciding what to read -根据你想要监听的provider，你可能有多个可以监听的值。 +Depending on the provider you want to listen to, you may have multiple possible +values that you can listen to. -比如，考虑以下 [StreamProvider]： +As an example, consider the following [StreamProvider]: ```dart final userProvider = StreamProvider(...); ``` -当读取这个 `userProvider` 时，你可以： +When reading this `userProvider`, you can: -- 通过监听 `userProvider` 本身 同步读取当前状态： +- synchronously read the current state by listening to `userProvider` itself: ```dart Widget build(BuildContext context, WidgetRef ref) { AsyncValue user = ref.watch(userProvider); - return user.when( - loading: () => const CircularProgressIndicator(), - error: (error, stack) => const Text('Oops'), - data: (user) => Text(user.name), - ); + return switch (user) { + AsyncData(:final value) => Text(value.name), + AsyncError(:final error) => const Text('Oops $error'), + _ => const CircularProgressIndicator(), + }; } ``` -- 通过监听 `userProvider.stream` 获取关联的 [Stream]： +- obtain the associated [Stream], by listening to `userProvider.stream`: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -308,7 +347,7 @@ final userProvider = StreamProvider(...); } ``` -- 通过监听 `userProvider.future`，获得一个解析最新值的 [Future] ： +- obtain a [Future] that resolves with the latest value emitted, by listening to `userProvider.future`: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -316,18 +355,21 @@ final userProvider = StreamProvider(...); } ``` -不同的provider可能提供用法。 -要了解更多信息，请阅读[API 参考](https://pub.dev/documentation/riverpod/latest/riverpod/riverpod-library.html)来获取每个provider的文档。 +Other providers may offer different alternative values. +For more information, refer to the documentation of each provider by +consulting the [API reference](https://pub.dev/documentation/riverpod/latest/riverpod/riverpod-library.html). -## 使用“select”来过滤重建内容 +## Using "select" to filter rebuilds -与读取provider相关的最后一个特性是能够减少widget/provider从 `ref.watch` 重新构建的次数， -或者减少 `ref.listen` 执行函数的频率。 +One final feature to mention related to reading providers is the ability to +reduce the number of times a widget/provider rebuilds from `ref.watch`, or how often `ref.listen` +executes a function. -记住，这一点很重要，因为默认情况下，监听provider将监听整个对象状态。 -但有时widget/provider可能只关心某些属性的更改，而不是整个对象。 +This is important to keep in mind as, by default, listening to a provider +listens to the entire object state. But sometimes, a widget/provider may only +care about changes to some properties instead of the whole object. -比如说，一个provider可能暴露一个 `User` 对象： +For example, a provider may expose a `User`: ```dart abstract class User { @@ -336,7 +378,7 @@ abstract class User { } ``` -但是widget可能只使用用户名： +But a widget may only use the user name: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -345,11 +387,13 @@ Widget build(BuildContext context, WidgetRef ref) { } ``` -如果我们简单地使用 `ref.watch`，这将在用户年龄(`age`)发生变化时重新构建widget。 +If we naively used `ref.watch`, this would rebuild the widget when the user's +`age` changes. -解决方案是使用 `select` 显式地告诉Riverpod我们只想监听 `User` 的 `name` 属性。 +The solution is to use `select` to explicitly tell Riverpod that we only +want to listen to the name property of the `User`. -更新后的代码如下: +The updated code would be: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -358,15 +402,17 @@ Widget build(BuildContext context, WidgetRef ref) { } ``` -通过使用 `select`，我们可以指定一个返回我们所关心的属性的函数。 - -每当 `User` 发生变化时，Riverpod将调用该函数并比较以前和新的结果。 -如果它们是不同的(例如当名称更改时)，Riverpod将重新构建widget。 +By using `select`, we are able to specify a function +that returns the property that we care about. -当然了，如果它们相等(例如当年龄改变时)，Riverpod将不会重建widget。 +Whenever the `User` changes, Riverpod will call this function and +compare the previous and new result. If they are different (such as when the name +changed), Riverpod will rebuild the widget. +However, if they are equal (such as when the age changed), Riverpod will not +rebuild the widget. :::info -也可以 `select` 和 `ref.listen` 结合使用： +It is also possible to use `select` with `ref.listen`: ```dart ref.listen( @@ -377,11 +423,12 @@ ref.listen( ); ``` -这样做只会在名称更改时调用监听器。 +Doing so will call the listener only when the name changes. ::: :::tip -你不需要返回对象的属性。任何可以使用==的值都可以工作。举个例子： +You don't have to return a property of the object. Any value that +overrides == will work. For example you could do: ```dart final label = ref.watch(userProvider.select((user) => 'Mr ${user.name}')); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart index 518561f7e..7b9118cbc 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart @@ -18,16 +18,16 @@ class HomeViewState extends ConsumerState { @override void initState() { super.initState(); - // “ref” 可以在 StatefulWidget 的所有的生命周期内使用。 + // "ref" can be used in all life-cycles of a StatefulWidget. ref.read(counterProvider); } @override Widget build(BuildContext context) { - // 我们可以在builder中使用钩子如同HookConsumerWidget使用的那样 + // Like HookConsumerWidget, we can use hooks inside the builder final state = useState(0); - // 我们也可以在build函数中使用“ref”监听provider + // We can also use "ref" to listen to a provider inside the build method final counter = ref.watch(counterProvider); return Text('$counter'); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/raw.dart index 0219623b1..98d7f3403 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/raw.dart @@ -15,13 +15,13 @@ class HomeViewState extends ConsumerState { @override void initState() { super.initState(); - // “ref” 可以在 StatefulWidget 的所有的生命周期内使用。 + // "ref" can be used in all life-cycles of a StatefulWidget. ref.read(counterProvider); } @override Widget build(BuildContext context) { - // 我们也可以在build函数中使用“ref”监听provider + // We can also use "ref" to listen to a provider inside the build method final counter = ref.watch(counterProvider); return Text('$counter'); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/hooks.dart index 8dd75334f..1c5547428 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/hooks.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/hooks.dart @@ -12,10 +12,10 @@ class HomeView extends HookConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // HookConsumerWidget允许在build方法中使用钩子 + // HookConsumerWidget allows using hooks inside the build method final state = useState(0); - // 我们也可以使用ref参数来监听provider。 + // We can also use the ref parameter to listen to providers. final counter = ref.watch(counterProvider); return Text('$counter'); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/raw.dart index a450ed37b..d2df7c5a7 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/raw.dart @@ -9,7 +9,7 @@ class HomeView extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 使用ref监听provider + // use ref to listen to a provider final counter = ref.watch(counterProvider); return Text('$counter'); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart index 75543d461..ca1edf42e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart @@ -16,7 +16,7 @@ class Counter extends _$Counter { int build() => 0; void increment() { - // Counter可以使用“ref”读取其他provider + // Counter can use the "ref" to read other providers final repository = ref.read(repositoryProvider); repository.post('...'); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart index b0a11f77f..b97c93b00 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart @@ -18,7 +18,7 @@ class Counter extends StateNotifier { final Ref ref; void increment() { - // Counter可以使用“ref”读取其他provider + // Counter can use the "ref" to read other providers final repository = ref.read(repositoryProvider); repository.post('...'); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart new file mode 100644 index 000000000..5b1147d28 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart @@ -0,0 +1,34 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_hooks.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; +} + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(counterProvider, (int? previousCount, int newCount) { + print('The counter changed $newCount'); + }); + + final greeting = useState('Hello'); + + return Container( + alignment: Alignment.center, + child: Text(greeting.value), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart new file mode 100644 index 000000000..9affdaea0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_hooks.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterHash() => r'4320f811608c7a6e7342b83e3031965a34f7cb8e'; + +/// See also [Counter]. +@ProviderFor(Counter) +final counterProvider = AutoDisposeNotifierProvider.internal( + Counter.new, + name: r'counterProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Counter = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx index 339b89a56..a856c4980 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx @@ -1,9 +1,11 @@ import raw from "!!raw-loader!./raw.dart"; import codegen from "!!raw-loader!./codegen.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; +import codegen_hooks from "!!raw-loader!./codegen_hooks.dart"; export default { raw, - hooks: raw, + hooks: raw_hooks, codegen, - hooksCodegen: codegen, + hooksCodegen: codegen_hooks, }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart new file mode 100644 index 000000000..9f86fc19f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart @@ -0,0 +1,29 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import '../counter/raw.dart'; + +/* SNIPPET START */ + +final counterProvider = + StateNotifierProvider(Counter.new); + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(counterProvider, (int? previousCount, int newCount) { + print('The counter changed $newCount'); + }); + + final greeting = useState('Hello'); + + return Container( + alignment: Alignment.center, + child: Text(greeting.value), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart index a3401479c..201c92f91 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart @@ -14,7 +14,7 @@ Repository repository(RepositoryRef ref) => Repository(); @riverpod String value(ValueRef ref) { - // 使用ref获取其他provider + // use ref to obtain other providers final repository = ref.watch(repositoryProvider); return repository.get(); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart index 27baf53bd..28fdfed97 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart @@ -13,7 +13,7 @@ final repositoryProvider = Provider((ref) { /* SNIPPET START */ final valueProvider = Provider((ref) { - // 使用ref获取其他provider + // use ref to obtain other providers final repository = ref.watch(repositoryProvider); return repository.get(); }); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart index 4e7f1e139..0742ed5e5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart @@ -23,7 +23,7 @@ class HomeView extends ConsumerWidget { return Scaffold( floatingActionButton: FloatingActionButton( onPressed: () { - // 对“Counter”类调用“increment()”方法 + // Call `increment()` on the `Counter` class ref.read(counterProvider.notifier).increment(); }, ), diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart new file mode 100644 index 000000000..341087cde --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart @@ -0,0 +1,36 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_hooks.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; + void increment() => state = state + 1; +} + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final greeting = useState('Hello'); + + return Scaffold( + body: Center(child: Text(greeting.value)), + floatingActionButton: FloatingActionButton( + onPressed: () { + // Call `increment()` on the `Counter` class + ref.read(counterProvider.notifier).increment(); + }, + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart new file mode 100644 index 000000000..5fd373b49 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_hooks.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; + +/// See also [Counter]. +@ProviderFor(Counter) +final counterProvider = AutoDisposeNotifierProvider.internal( + Counter.new, + name: r'counterProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Counter = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx index 339b89a56..d0caf89aa 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx @@ -1,9 +1,11 @@ import raw from "!!raw-loader!./raw.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; import codegen from "!!raw-loader!./codegen.dart"; +import codegen_hooks from "!!raw-loader!./codegen_hooks.dart"; export default { raw, - hooks: raw, + hooks: raw_hooks, codegen, - hooksCodegen: codegen, + hooksCodegen: codegen_hooks, }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart index f191278b0..7d8685155 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart @@ -7,8 +7,7 @@ import '../counter/raw.dart'; /* SNIPPET START */ -final counterProvider = - StateNotifierProvider(Counter.new); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { const HomeView({super.key}); @@ -18,7 +17,7 @@ class HomeView extends ConsumerWidget { return Scaffold( floatingActionButton: FloatingActionButton( onPressed: () { - // 对“Counter”类调用“increment()”方法 + // Call `increment()` on the `Counter` class ref.read(counterProvider.notifier).increment(); }, ), diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart new file mode 100644 index 000000000..acc6ba980 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart @@ -0,0 +1,31 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../counter/raw.dart'; + +/* SNIPPET START */ + +final counterProvider = + StateNotifierProvider(Counter.new); + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final greeting = useState('Hello'); + + return Scaffold( + body: Center(child: Text(greeting.value)), + floatingActionButton: FloatingActionButton( + onPressed: () { + // Call `increment()` on the `Counter` class + ref.read(counterProvider.notifier).increment(); + }, + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart index 14915ab30..9a4347159 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart @@ -16,7 +16,7 @@ class Counter extends _$Counter { } Widget build(BuildContext context, WidgetRef ref) { - // 使用 “read” 忽略provider的更新 + // use "read" to ignore updates on a provider final counter = ref.read(counterProvider.notifier); return ElevatedButton( onPressed: counter.increment, diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart index 51a2a7ca3..266e00224 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart @@ -8,7 +8,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final counterProvider = StateProvider((ref) => 0); Widget build(BuildContext context, WidgetRef ref) { - // 使用 “read” 忽略provider的更新 + // use "read" to ignore updates on a provider final counter = ref.read(counterProvider.notifier); return ElevatedButton( onPressed: () => counter.state++, diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart index 0398da316..31de6da74 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart @@ -30,16 +30,16 @@ class Todos extends _$Todos { @riverpod List filteredTodoList(FilteredTodoListRef ref) { - // 获取筛选器和待办清单列表 + // obtains both the filter and the list of todos final FilterType filter = ref.watch(filterTypeProvider); final List todos = ref.watch(todosProvider); switch (filter) { case FilterType.completed: - // 返回完成的待办清单 + // return the completed list of todos return todos.where((todo) => todo.isCompleted).toList(); case FilterType.none: - // 返回所有的待办清单 + // returns the unfiltered list of todos return todos; } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart index 17b249eb2..625c0fe9a 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart @@ -22,16 +22,16 @@ final todosProvider = StateNotifierProvider>((ref) => TodoList()); final filteredTodoListProvider = Provider((ref) { - // 获取筛选器和待办清单列表 + // obtains both the filter and the list of todos final FilterType filter = ref.watch(filterTypeProvider); final List todos = ref.watch(todosProvider); switch (filter) { case FilterType.completed: - // 返回完成的待办清单 + // return the completed list of todos return todos.where((todo) => todo.isCompleted).toList(); case FilterType.none: - // 返回所有的待办清单 + // returns the unfiltered list of todos return todos; } }); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart index 5649470d1..80b63d216 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart @@ -31,7 +31,7 @@ class HomeView extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 使用ref监听provider + // use ref to listen to a provider final counter = ref.watch(counterProvider); return Text('$counter'); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart new file mode 100644 index 000000000..c82698304 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart @@ -0,0 +1,43 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_hooks.g.dart'; + +enum FilterType { + none, + completed, +} + +abstract class Todo { + bool get isCompleted; +} + +@riverpod +class TodoList extends _$TodoList { + @override + List build() => []; +} + +/* SNIPPET START */ + +@riverpod +int counter(CounterRef ref) => 0; + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // You can use hooks inside a HookConsumerWidget + final greeting = useState('Hello'); + + // use ref to listen to a provider + final counter = ref.watch(counterProvider); + + return Text('${greeting.value} $counter'); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart new file mode 100644 index 000000000..f5b4cfea1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart @@ -0,0 +1,41 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_hooks.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; + +/// See also [counter]. +@ProviderFor(counter) +final counterProvider = AutoDisposeProvider.internal( + counter, + name: r'counterProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$counterHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CounterRef = AutoDisposeProviderRef; +String _$todoListHash() => r'77f007cd4f5105330a4c2ab8555ea0d1716945c1'; + +/// See also [TodoList]. +@ProviderFor(TodoList) +final todoListProvider = + AutoDisposeNotifierProvider>.internal( + TodoList.new, + name: r'todoListProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$TodoList = AutoDisposeNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx index 339b89a56..a856c4980 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx @@ -1,9 +1,11 @@ import raw from "!!raw-loader!./raw.dart"; import codegen from "!!raw-loader!./codegen.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; +import codegen_hooks from "!!raw-loader!./codegen_hooks.dart"; export default { raw, - hooks: raw, + hooks: raw_hooks, codegen, - hooksCodegen: codegen, + hooksCodegen: codegen_hooks, }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart index 71886bdae..8d5d430eb 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart @@ -25,7 +25,7 @@ class HomeView extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 使用ref监听provider + // use ref to listen to a provider final counter = ref.watch(counterProvider); return Text('$counter'); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart new file mode 100644 index 000000000..5f297850a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart @@ -0,0 +1,37 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +enum FilterType { + none, + completed, +} + +abstract class Todo { + bool get isCompleted; +} + +class TodoList extends StateNotifier> { + TodoList() : super([]); +} + +/* SNIPPET START */ + +final counterProvider = StateProvider((ref) => 0); + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // You can use hooks inside a HookConsumerWidget + final greeting = useState('Hello'); + + // use ref to listen to a provider + final counter = ref.watch(counterProvider); + + return Text('${greeting.value} $counter'); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/scopes.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/scopes.mdx index b4472bdec..9c8812bcf 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/scopes.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/scopes.mdx @@ -1,49 +1,60 @@ --- -title: 作用域 +title: Scopes --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import asyncInitialization from "!!raw-loader!/docs/concepts/async_initialization.dart"; import dialogScope from "!!raw-loader!/docs/concepts/dialog_scope.dart"; import themeScope from "!!raw-loader!/docs/concepts/theme_scope.dart"; import subtreeScope from "!!raw-loader!/docs/concepts/subtree_scope.dart"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet } from "@site/src/components/CodeSnippet"; +import { Link } from "@site/src/components/Link"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: + +Scoping in Riverpod is a very powerful feature, but like all powerful features, it should be used wisely and intentionally. -Riverpod中的作用域是一个非常强大的功能，但像其他强大的功能一样，应该理智地使用它。 +A few of the things that scoping enables are: -作用域支持： -- 覆盖特定子树的provider状态(类似于主题和 `InheritedWidgets` 在flutter中的工作方式) [(查看示例)](#子树作用域) -- 为一般异步API创建同步provider [(查看示例)](#异步api的同步provider初始化) -- 允许 `对话框(Dialog)` 和 `覆盖层(Overlay)`从widget子树继承provider的状态以显示它们[(查看示例)](#展示对话框) -- 通过从widget的构造函数中删除参数来优化widget的重建，从而允许你将它们设置为`const` +- Override the state of providers for a specific subtree (similar to how theming and `InheritedWidgets` work in flutter) [(see example)](#subtree-scope) +- Creating synchronous providers for normally async APIs [(see example)](#initialization-of-synchronous-provider-for-async-apis) +- Allowing `Dialog`s and `Overlay`s to inherit the state of providers from the widget subtree that cause them to be shown [(see example)](#showing-dialogs) +- Optimizing rebuilds of widgets by removing parameters from Widget constructors allowing you to make them `const` -如果你想用作用域来表示上面的第一点，你也可以用family来代替。 -family的优点是允许你从widget树中的任何位置访问状态的每个实例，而不仅仅是从你所在的特定子树的状态范围访问。 +If you are wanting to use scope for the first point, chances are you can use families instead. +Families have the advantages of allowing you to access each of those instances of the state from anywhere in the widget tree rather than just the state scoped to the specific subtree that you are in. -使用作用域创建provider状态的多个实例与 `package:provider` 的工作方式类似。 +Using scope to create multiple instances of a provider's state is similar to how `package:provider` works. -但是，使用作用域来完成该任务的限制更大，因为你不能决定从该作用域访问其他实例。 +However, using scope to accomplish that task, is more restrictive, as you cannot decide to access other instances from that scope. -因此，在确定所使用的每个provider的作用域之前，请仔细考虑为什么要确定provider的作用域。 +As such, before scoping every provider you use, consider carefully why you want to scope the provider. -## ProviderScope 和 ProviderContainer +## ProviderScope and ProviderContainer -作用域由 [ProviderContainer] 引入。这个容器保存了所有provider的当前状态。它管理provider之间的查找和订阅功能。 +A scope is introduced by a [ProviderContainer]. This container holds the current state of all of your providers. +It manages the lookup and subscriptions between providers. -在Flutter中，你应该使用 [ProviderScope] widget， -它内部包含一个 [ProviderContainer]，并提供了一种访问该容器到widget树其余部分的方法。 +In Flutter you should use the [ProviderScope] widget, which contains a [ProviderContainer] +internally, and provides a way to access that container to the rest of the widget tree. ```dart final valueProvider = StateProvider((ref) => 0); -// 这样做： +// DO this void main() { runApp(ProviderScope(child: MyApp())); } -// 不要这样做： +//DON'T do this: final myProviderContainer = ProviderContainer(); void main(){ runApp(MyApp()); @@ -51,118 +62,120 @@ void main(){ ``` :::warning -在了解它们的工作原理之前，不要使用多个 [ProviderContainer]。 -每个线程都有自己独立的状态线程，这些状态线程不能相互访问。 -拿测试举例，你可能希望使用单独的 [ProviderContainer]，以便使每个测试的状态独立于其他测试。 +Do not use multiple [ProviderContainer]s, without an understanding of how they work. +Each will have it's own separate thread of states, which will not be able to access each other. +Tests are an example of when you might want to use separate [ProviderContainer]s +in order to make each test's state independent of the others. ::: -仅在纯Dart项目中和测试中创建并使用 [ProviderContainer] 且不需要 [ProviderScope]。 +Only create a [ProviderContainer] without a [ProviderScope] for testing and dart-only usage. -## How Riverpod如何找到一个Provider +## How Riverpod Finds a Provider -当一个widget或provider请求一个provider的值时，Riverpod在最近的ProviderScope widget中查找该provider的状态。 -如果provider和它显式列出的依赖项都没有在该范围内被覆盖到，Riverpod将继续查找widget树。 -如果provider没有在任何widget子树中被覆盖到，则默认查找到根 [ProviderScope] 中的 [ProviderContainer]。 +When a widget or provider requests the value of a provider, Riverpod looks up the state of that provider in the nearest +[ProviderScope] widget. If neither the provider nor one of it's explicitly listed dependencies is overridden in that scope Riverpod continues it's lookup up the widget tree. +If the provider has not been overridden in any Widget subtrees the lookup defaults to the [ProviderContainer] in the root [ProviderScope]. -一旦该进程定位了provider应该驻留的作用域，它就会确定provider是否已经创建。 -如果是，它将返回provider的状态。但是，如果provider已经失效或未初始化，它将使用provider的构建方法创建状态。 +Once this process locates the scope in which the provider should reside it determines if the provider has been created yet. +If so, it will return the state of the provider. +However, if the provider has been invalidated or is not currently initialized it will create the state using the provider's build method. -## 异步API的同步provider初始化 +## Initialization of Synchronous Provider for Async APIs -通常，你可能会对依赖项(如 `SharedPreferences` 或 `FirebaseApp`)进行一些异步初始化。 -许多其他provider可能依赖于此，在每个provider中处理错误/加载中状态是多余的。 +Often you might have some async initialization of a dependency such as `SharedPreferences` or `FirebaseApp`. +Many other providers might rely on this, and dealing with the error / loading states in each of those providers is redundant. -你可以保证这些provider不会有错误，并且在应用启动时可以快速加载。 +You might be able to guarantee that those providers will not have errors and will load quickly when the app is started. -那么，如何让这些provider状态同步可用呢? +So how do you makes these sorts of provider states available synchronously? -下面是一个示例，它展示了当异步API准备好时，作用域如何允许你覆盖一个形式上的provider。 +Here is an example that shows how scoping allows you override a dummy provider when your asynchronous API is ready. {trimSnippet(asyncInitialization)} -## 展示对话框 +## Showing Dialogs -当你显示一个`对话框(Dialog)` 或 `OverlayEntry`时，flutter会创建一个新的 `路由(Route)` 或添加到具有不同构建范围的 `Overlay` 中， -这样它就可以摆脱它的父布局，并可以显示在其他 `路由(Routes)` 之上。 -但这通常会给 `InheritedWidget` 带来一个问题，因为 [ProviderScope] 也是一个 `InheritedWidget`，所以它也会受到影响。 +When you show a `Dialog` or `OverlayEntry`, flutter creates a new `Route` or adds to an `Overlay` that has a different build scope, +so that it can escape the layout of it's parent, and can be shown above other `Routes`. +This presents a problem for `InheritedWidget`s in general, and since [ProviderScope] is an `InheritedWidget`, it is also affected. -为了解决这个问题，Riverpod允许你创建一个 `ProviderScope` ，它可以访问父作用域中所有provider的状态。 +To solve this problem, Riverpod allows you to create a `ProviderScope` that can access the state of all providers in a `parent` scope. -下面的示例展示了如何使用这个功能，它允许打开的`Dialog`从上下文(context)中访问计数器的状态。 +The following example shows how to use this, to allow a `Dialog` to access the state of a counter from the context that caused the `Dialog` to be shown. {trimSnippet(dialogScope)} -## 子树作用域 +## Subtree Scoping -作用域允许你覆盖widget树的特定子树的provider状态。 -通过这种方式，它可以提供类似于flutter中的 `InheritedWidget` 或 `package:provider` 中的provider机制。 +Scoping allows you to override the state of a provider for a specific subtree of your widget tree. +In this way it can provide a similar mechanism to `InheritedWidget` from flutter, or the providers from `package:provider`. For example, in flutter you can override the `Theme` for a particular subtree of your widget tree, by wrapping it in a `Theme` widget. -比如，在flutter中，通过将widget树的特定子树包装在Theme widget中，可以覆盖widget树的Theme。 {trimSnippet(themeScope)} -在底层，`Theme` 是一个 `InheritedWidget` ，当widget查找 `Theme` 时，它们从widget树中找到最近的 `Theme` widget 来获得主题。 +Under the hood, `Theme` is an `InheritedWidget` and when widgets look up the `Theme` they get the `Theme` from the nearest `Theme` widget above it in the widget tree. -Riverpod的工作方式不太一样，因为应用的所有状态通常存储在根 [ProviderScope] widget中。 -不要担心，当状态改变时，这不会导致整个应用程序重新构建，它只是允许你从widget树中的任何位置去访问状态。 +Riverpod works differently, since all of the state of your application is typically stored in a root [ProviderScope] widget. +Don't worry, this doesn't cause your whole application to rebuild when the state changes, it just allows you to access the state from anywhere in your widget tree. -如果根据所处的页面需要不同的provider该怎么办? +What if you want different providers depending on which page you are in? -你应该考虑的第一件事是它所提供的行为是否会以某种方式有所不同。 +The first thing that you should consider is whether the provided behavior will differ in any way. -如果不同 -> 只需创建一个不同名称的新的provider，并在该页面中使用它 +If so -> just create a new provider with a different name and use it in that page -如果相同 -> 考虑使用family[在这里了解更多关于family的内容](/docs/concepts/modifiers/family)。 +If not -> Consider using a . -通常，你开始时认为只需要在特定页面上使用provider，但最后却希望在稍后的另一个页面上也使用它。 -family可以让你不受这种可能性的影响，如果你是来自 `package:provider` 的开发者，你应该使用family来调整思维。 +Often you start by thinking that you only need a provider on a particular page, but end up wanting to use it in another page later on. +Families protect you against this eventuality, and are a major difference in how you should adjust your thinking if you are coming from `package:provider`. -但如果family确实不适合你的用例，下面的示例向你展示了如何覆盖特定子树的provider： +If families really do not fit your use case, the following example shows you how to override a provider for a particular subtree. {trimSnippet(subtreeScope)} -## 什么时候选择有作用域的Provider还是Family +## When to choose Scoped Providers or Families + +While scopes are important to understand, it is easy to get carried away when using scopes. + +If you want a different instance of a provider's state depending on where it is in the widget tree you have a few alternatives available to you: `Scoping`, `Families`, or a combination. +The appropriate choice depends on your use case. -虽然理解作用域很重要，但在使用作用域时很容易失去控制。 +Families: -如果你想要一个provider状态的不同实例，取决于它在widget树中的位置，你有几个可供选择的选项: `Scoping`, `Families`，或组合它们。 -请根据你的情况选择合适方案。 +- Pro: You can show multiple of the states no matter which subtree you are in +- Pro: This makes it a more flexible and scalable solution for many use cases -Family: -- 优点：无论你在哪个子树中，你都可以显示多个状态 -- 优点：这使得它成为许多用例的更灵活和可扩展的解决方案 +Scoping: -作用域: -- 缺点：你最终会在你的widget树中嵌套更多的[ProviderScope] widget -- 缺点：你只能访问一个覆盖住你部分的widget树 -- 缺点：你最终不得不显式地列出大多数provider的依赖关系 -- 优点：可以减少widget构造函数中的参数数量 -- 优点：你可以获得轻微的性能优势，并且可以潜在地使你的一些widget的构造函数为const +- Con: You end up with more nesting of [ProviderScope] widgets in your widget tree +- Con: You can only access the one override in your section of the widget tree +- Con: You end up having to explicitly list the dependencies of most of your providers +- Pro: You can reduce the number of parameters in your widget constructors +- Pro: You get a slight performance advantage, and can potentially make some of your widget constructors `const` -组合使用这两种方法，你可以同时获得这两种方法的优点，但你仍然必须解决作用域的缺点。 +Using a combination of the two approaches, you can get the pros of both approaches, but you still have to deal with the cons of scoping. :::warning -请记住，作用域为每个被覆盖的provider或列出了对被覆盖的provider的依赖项的provider引入了一个新的状态实例。 -如果你在应用程序的不同子树中覆盖相同的参数，它将**不会是**provider状态的相同实例。 -一般来说，family更加灵活，并且通过即将到来的代码生成特性，可以很容易地为一个family使用多个参数。 -一个很好的组合通常是同时使用family和作用域。使用一个family来提供对应用中任何地方的状态块的访问， -取决于你在widget树中的位置，然后使用作用域来提供一个特定的family状态实例。 +Remember that scopes introduce a new instance of the state of every provider that is overridden or has listed a dependency on a provider that was overridden. +If you override with the same parameter in a different subtree of the app, it will **not** be the same instance of the provider's state. +Families are more flexible in general, and with the upcoming code generation feature it is easy to use multiple parameters for a family. +Often a good combination is to use both families and scoping. Use a family to provide general access to a piece of state anywhere in your app, and then use scoping to +provide a specific instance of the family's state depending on where you are in the widget tree. ::: -### 作用域的不常见用法 +### Less common usages of Scopes -有时你可能想要覆盖应用特定子树中的所有provider。 -通过在每个provider的依赖项列表中列出一个公共provider， -你可以通过覆盖公共provider，轻松地一次性为所有这些provider创建新状态。 +Sometimes you may want to override a whole set of providers in a specific subtree of your app. +By listing a common provider in the dependencies list of each of those providers, you can easily create new states for all of them at once, by overriding the common one. -请注意，如果你尝试使用family来实现此功能，那么你将得到许多具有相同参数的family， -并且你可能会在整个widget树中传递该参数。在这种情况下，也可以使用作用域。 +Note that if you try to use families for this, you will end up with many families that all have the same parameter, and you could end up passing that parameter all over the widget tree. +In this case it is also acceptable to use scopes. :::warning -一旦开始使用作用域，请确保始终列出依赖项并保持最新状态，以防止运行时异常。 -为了解决这个问题，我们创建了 [riverpod_lint]，它会在缺少依赖时警告你。 -另外，使用 [riverpod_generator] 这个代码生成器会自动为你生成依赖项列表。 +Once you start using scope, make sure to always list your dependencies and keep them up to date, to prevent runtime exceptions. +To help with this we have created [riverpod_lint] which will warn you if there is a missing dependency. +Additionally with [riverpod_generator] the code generator automatically generates the dependency list. ::: [ProviderContainer]: https://pub.dev/documentation/riverpod/latest/riverpod/ProviderContainer-class.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart new file mode 100644 index 000000000..9aa1903e5 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart @@ -0,0 +1,78 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +/// A counter that is being incremented by each [CounterDisplay]'s ElevatedButton +final counterProvider = StateProvider( + (ref) => 0, +); + +final adjustedCountProvider = Provider( + (ref) => ref.watch(counterProvider) * 2, + // Note that if a provider depends on a provider that is overridden for a subtree, + // you must explicitly list that provider in your dependencies list. + dependencies: [counterProvider], +); + +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + body: Column( + children: [ + ProviderScope( + /// Just specify which provider you want to have a copy of in the subtree + /// + /// Note that dependant providers such as [adjustedCountProvider] will + /// also be copied for this subtree. If that is not the behavior you want, + /// consider using families instead + overrides: [counterProvider], + child: const CounterDisplay(), + ), + ProviderScope( + // You can change the provider's behavior in a particular subtree + overrides: [counterProvider.overrideWith((ref) => 1)], + child: const CounterDisplay(), + ), + ProviderScope( + overrides: [ + counterProvider, + // You can also change dependent provider's behaviors + adjustedCountProvider.overrideWith( + (ref) => ref.watch(counterProvider) * 3, + ), + ], + child: const CounterDisplay(), + ), + // This particular display will use the provider state from the root ProviderScope + const CounterDisplay(), + ], + )); + } +} + +class CounterDisplay extends ConsumerWidget { + const CounterDisplay({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final count = ref.watch(counterProvider); + return Column( + mainAxisSize: MainAxisSize.min, + children: [ + Text('$count'), + ElevatedButton( + onPressed: () { + ref.read(counterProvider.notifier).state++; + }, + child: const Text('Increment Count'), + ), + ], + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart new file mode 100644 index 000000000..d17f15f02 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart @@ -0,0 +1,68 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +void main() { + runApp( + ProviderScope( + child: MaterialApp( + theme: ThemeData(primaryColor: Colors.blue), + home: const Home(), + ), + ), + ); +} + +// Have a counter that is being incremented +final counterProvider = StateProvider( + (ref) => 0, +); + +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + body: Column( + children: [ + // This counter will have a primary color of green + Theme( + data: Theme.of(context).copyWith(primaryColor: Colors.green), + child: const CounterDisplay(), + ), + // This counter will have a primary color of blue + const CounterDisplay(), + ElevatedButton( + onPressed: () { + ref.read(counterProvider.notifier).state++; + }, + child: const Text('Increment Count'), + ), + ], + )); + } +} + +class CounterDisplay extends ConsumerWidget { + const CounterDisplay({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final count = ref.watch(counterProvider); + final theme = Theme.of(context); + return Column( + mainAxisSize: MainAxisSize.min, + children: [ + Text( + '$count', + style: theme.textTheme.displayMedium + ?.copyWith(color: theme.primaryColor), + ), + ], + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx index 864abc633..3dfbe3741 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx @@ -1,124 +1,98 @@ --- -title: 为何需要不可变性 +title: Why Immutability --- import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; +import whyImmutability from "./why_immutability" +import { + trimSnippet, + AutoSnippet, + When, +} from "@site/src/components/CodeSnippet"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -## 什么是不可变性? +## What is Immutability? -不可变性指当一个`对象`中的所有域(属性)是final或late final的。 -它们只能通过构造器赋值一次。 +Immutability is when all fields of an `Object` are final or late final. +They are set exactly once upon construction. -出于许多原因，不可变性是比较理想的方式： +Immutability is desireable for many different reasons -- 值相等而不是引用相等 -- 关于代码的局部推理 - - 远处的一段代码不能从你的下面获得引用并改变对象 -- 对于异步和并行任务更容易推理 - - 其他代码不能在操作中改变对象 -- API安全 - - 你传递给方法的东西不会被访问者或被访问者改变 +- Value equality rather than reference equality +- Local reasoning about a piece of code + - A far distant piece of code can't obtain a reference and change the object from underneath you +- Easier to reason about for asynchronous and parallel tasks + - Other code can't mutate your object in between operations +- Safety of APIs + - What you pass into a method cannot be changed by the callee / caller -当创建了一个只改变几处的新对象时，copyWith方法可以帮助你减少冗余 +A copyWith method helps with reducing verbosity when creating a new object with just a few things changed. -拷贝的效率比你想的更高，dart可以重用对未更改的字对象的引用。 +Copying is more efficient than you might think, since dart can reuse any references to sub-objects that have not changed. :::warning -确保你的对象是深度不可变的，否则你必须实现某种深拷贝机制。 +Make sure your objects are deeply immutable, otherwise you'll have to implement some sort of deep copy mechanism. ::: -## 最佳实践 +## Best Practices -你可以用任何package来创建你想要的不可变状态。 +You can use any package you want to create immutable state. -对于不可变对象: +For immutable objects: - [package:freezed](https://pub.dev/packages/freezed) - [package:built_value](https://pub.dev/packages/built_value) -对于不可变集合 (Map, Set, List): +For immutable collections (Map, Set, List): - [package:fast_immutable_collections](https://pub.dev/packages/fast_immutable_collections) - [package:built_collection](https://pub.dev/packages/built_collection) - [package:kt_dart](https://pub.dev/packages/kt_dart) - [package:dartz](https://pub.dev/packages/dartz) -非常推荐[freezed]这个package,它除了创建不可变对象外，还提供了一些不错的附加功能，包括： +It is highly recommended to use [freezed], +since it has several nice additions beyond just making immutable objects including: -- 生成copyWith方法 -- 深拷贝 (在嵌套的freezed对象的copyWith方法) -- 联合类型 -- 联合映射函数 +- A generated copyWith method +- Deep copy (copyWith on nested freezed objects) +- Union types +- Union mapping functions -使用不可变状态不一定需要代码生成，但它能让这一过程变得更简单。 +You do not need to use code generation to work with immutable state, but it makes it much easier. :::warning -如果你想使用内置的集合，请确保实现更新集合时执行复制集合的规则。 -不复制集合的问题在于，riverpod会根据对对象的引用是否更改来确定是否发出新的状态。 -如果仅调用一个改变对象的方法，那么使用引用也是可行的。 +If you want to use the built-in collections, make sure to enforce a discipline of making copies of collections when updating them. +The issue with not copying a collection is that riverpod determines whether to emit a new state based on whether the reference to the object has changed. +If you just call a method that mutates an object, the reference is the same. ::: -### 使用不可变状态 - -不可变状态最适合 [StateNotifier] 和 [StateNotifierProvider] 结合使用。 -[StateNotifier]允许你暴露一个可以“改变”状态的接口。 -你不能从你定义的继承自 [StateNotifier] 的对象外面改变他的状态。 -这分离了你的关注点，并将业务逻辑保留在UI之外。 - -下面是一个例子，通过一个简单的不可变设置类来改变应用主题。 - -```dart -final themeProvider = StateNotifierProvider((ref) => ThemeNotifier()); - -class ThemeNotifier extends StateNotifier { - ThemeNotifier(): super( - ThemeSettings( - mode: ThemeMode.system, - primaryColor: Colors.blue, - )); - - void toggle() { - state = state.copyWith(mode: state.mode.toggle); - } - void setDarkTheme() { - state = state.copyWith(mode: ThemeMode.dark); - } - void setLightTheme() { - state = state.copyWith(mode: ThemeMode.light); - } - void setSystemTheme() { - state = state.copyWith(mode: ThemeMode.system); - } - void setPrimaryColor(Color color) { - state = state.copyWith(primaryColor: color); - } - -} - -@freezed -class ThemeSettings with _$ThemeSettings { - const factory ThemeSettings({ThemeMode mode, Color primaryColor}) = _ThemeSettings; -} - -extension ToggleTheme on ThemeMode { - ThemeMode get toggle { - switch (this){ - case ThemeMode.dark: - return ThemeMode.light; - case ThemeMode.light: - return ThemeMode.dark; - case ThemeMode.system: - return ThemeMode.system; - } - } -} -``` - -要使用这段代码，记住你需要引入 `freezed_annotation`这个package，并运行 [build_runner] 来构建freezed生成的类。 +### Using immutable state + +Immutable state is best fit for using a [Notifier] in combination with [NotifierProvider] . +A [Notifier] allows you to expose an interface through which you can 'mutate' the state. +You cannot mutate the state from outside the class you define that extends [Notifier]. +This enforces a separation of concerns and keeps business logic outside of your UI. + +Here is an example of a simple immutable settings class for changing an app theme. + + + +To use this code, remember to import `freezed_annotation`, add the part directive and run [build_runner] to generate the freezed classes! [changenotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html [statenotifier]: https://pub.dev/documentation/riverpod/latest/riverpod/StateNotifier-class.html [statenotifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/StateNotifierProvider-class.html +[notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html +[notifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/NotifierProvider.html [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html [freezed]: https://pub.dev/packages/freezed [build_runner]: https://pub.dev/packages/build_runner diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart new file mode 100644 index 000000000..fd286a36c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart @@ -0,0 +1,58 @@ +import 'package:flutter/material.dart'; +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +class ThemeNotifier extends _$ThemeNotifier { + @override + ThemeSettings build() => const ThemeSettings( + mode: ThemeMode.light, + primaryColor: Colors.blue, + ); + + void toggle() { + state = state.copyWith(mode: state.mode.toggle); + } + + void setDarkTheme() { + state = state.copyWith(mode: ThemeMode.dark); + } + + void setLightTheme() { + state = state.copyWith(mode: ThemeMode.light); + } + + void setSystemTheme() { + state = state.copyWith(mode: ThemeMode.system); + } + + void setPrimaryColor(Color color) { + state = state.copyWith(primaryColor: color); + } +} + +@freezed +class ThemeSettings with _$ThemeSettings { + const factory ThemeSettings({ + required ThemeMode mode, + required Color primaryColor, + }) = _ThemeSettings; +} + +extension ToggleTheme on ThemeMode { + ThemeMode get toggle { + switch (this) { + case ThemeMode.dark: + return ThemeMode.light; + case ThemeMode.light: + return ThemeMode.dark; + case ThemeMode.system: + return ThemeMode.system; + } + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart new file mode 100644 index 000000000..6e8c8082b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart @@ -0,0 +1,151 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$ThemeSettings { + ThemeMode get mode => throw _privateConstructorUsedError; + Color get primaryColor => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $ThemeSettingsCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ThemeSettingsCopyWith<$Res> { + factory $ThemeSettingsCopyWith( + ThemeSettings value, $Res Function(ThemeSettings) then) = + _$ThemeSettingsCopyWithImpl<$Res, ThemeSettings>; + @useResult + $Res call({ThemeMode mode, Color primaryColor}); +} + +/// @nodoc +class _$ThemeSettingsCopyWithImpl<$Res, $Val extends ThemeSettings> + implements $ThemeSettingsCopyWith<$Res> { + _$ThemeSettingsCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? mode = null, + Object? primaryColor = null, + }) { + return _then(_value.copyWith( + mode: null == mode + ? _value.mode + : mode // ignore: cast_nullable_to_non_nullable + as ThemeMode, + primaryColor: null == primaryColor + ? _value.primaryColor + : primaryColor // ignore: cast_nullable_to_non_nullable + as Color, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ThemeSettingsImplCopyWith<$Res> + implements $ThemeSettingsCopyWith<$Res> { + factory _$$ThemeSettingsImplCopyWith( + _$ThemeSettingsImpl value, $Res Function(_$ThemeSettingsImpl) then) = + __$$ThemeSettingsImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({ThemeMode mode, Color primaryColor}); +} + +/// @nodoc +class __$$ThemeSettingsImplCopyWithImpl<$Res> + extends _$ThemeSettingsCopyWithImpl<$Res, _$ThemeSettingsImpl> + implements _$$ThemeSettingsImplCopyWith<$Res> { + __$$ThemeSettingsImplCopyWithImpl( + _$ThemeSettingsImpl _value, $Res Function(_$ThemeSettingsImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? mode = null, + Object? primaryColor = null, + }) { + return _then(_$ThemeSettingsImpl( + mode: null == mode + ? _value.mode + : mode // ignore: cast_nullable_to_non_nullable + as ThemeMode, + primaryColor: null == primaryColor + ? _value.primaryColor + : primaryColor // ignore: cast_nullable_to_non_nullable + as Color, + )); + } +} + +/// @nodoc + +class _$ThemeSettingsImpl implements _ThemeSettings { + const _$ThemeSettingsImpl({required this.mode, required this.primaryColor}); + + @override + final ThemeMode mode; + @override + final Color primaryColor; + + @override + String toString() { + return 'ThemeSettings(mode: $mode, primaryColor: $primaryColor)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ThemeSettingsImpl && + (identical(other.mode, mode) || other.mode == mode) && + (identical(other.primaryColor, primaryColor) || + other.primaryColor == primaryColor)); + } + + @override + int get hashCode => Object.hash(runtimeType, mode, primaryColor); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ThemeSettingsImplCopyWith<_$ThemeSettingsImpl> get copyWith => + __$$ThemeSettingsImplCopyWithImpl<_$ThemeSettingsImpl>(this, _$identity); +} + +abstract class _ThemeSettings implements ThemeSettings { + const factory _ThemeSettings( + {required final ThemeMode mode, + required final Color primaryColor}) = _$ThemeSettingsImpl; + + @override + ThemeMode get mode; + @override + Color get primaryColor; + @override + @JsonKey(ignore: true) + _$$ThemeSettingsImplCopyWith<_$ThemeSettingsImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart new file mode 100644 index 000000000..44ea6ef85 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart @@ -0,0 +1,28 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$themeNotifierHash() => r'e119d56d9bf8b8d7c19624997f99d116098b45e9'; + +/// See also [ThemeNotifier]. +@ProviderFor(ThemeNotifier) +final themeNotifierProvider = + AutoDisposeNotifierProvider.internal( + ThemeNotifier.new, + name: r'themeNotifierProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$themeNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$ThemeNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart new file mode 100644 index 000000000..1e34c694c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart @@ -0,0 +1,67 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +final themeProvider = + NotifierProvider(ThemeNotifier.new); + +class ThemeNotifier extends Notifier { + @override + ThemeSettings build() { + return ThemeSettings(mode: ThemeMode.system, primaryColor: Colors.blue); + } + + void toggle() { + state = state.copyWith(mode: state.mode.toggle); + } + + void setDarkTheme() { + state = state.copyWith(mode: ThemeMode.dark); + } + + void setLightTheme() { + state = state.copyWith(mode: ThemeMode.light); + } + + void setSystemTheme() { + state = state.copyWith(mode: ThemeMode.system); + } + + void setPrimaryColor(Color color) { + state = state.copyWith(primaryColor: color); + } +} + +class ThemeSettings { + ThemeSettings({ + required this.mode, + required this.primaryColor, + }); + + final ThemeMode mode; + final Color primaryColor; + + ThemeSettings copyWith({ + ThemeMode? mode, + Color? primaryColor, + }) { + return ThemeSettings( + mode: mode ?? this.mode, + primaryColor: primaryColor ?? this.primaryColor, + ); + } +} + +extension ToggleTheme on ThemeMode { + ThemeMode get toggle { + switch (this) { + case ThemeMode.dark: + return ThemeMode.light; + case ThemeMode.light: + return ThemeMode.dark; + case ThemeMode.system: + return ThemeMode.system; + } + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx new file mode 100644 index 000000000..404f6a883 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx @@ -0,0 +1,148 @@ +--- +title: Search as we type +--- + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: + +A real world example could be to use `FutureProvider` to implement a searchbar. + +## Usage example: "Search as we type" searchbar + +Implementing a "search as we type" can seem daunting at first when using +conventional means. +There are lots of moving parts, such as: + +- handling errors. +- debouncing the user input to avoid making network requests on every keystroke. +- cancelling previously pending network requests when the search field changes. + +But the combination of `FutureProvider` and the power of [ref.watch] can +significantly simplify this task. + +A common pattern wanting to perform an asynchronous requests +is to split it into multiple providers: + +- a [StateNotifierProvider] or `StateProvider` for the parameters of your request + (or alternatively use [family]) +- a `FutureProvider`, which will do the request by reading the parameters from + the other providers/[family]. + +The first step would be to store the user input somewhere. For this example, +we will use `StateProvider` (as the search state is only a single `String`): + +```dart +final searchInputProvider = StateProvider((ref) => ''); +``` + +We can then connect this provider to a [TextField] by doing: + +```dart +Consumer( + builder: (context, ref, child) { + return TextField( + onChanged: (value) => ref.read(searchInputProvider.notifier).state = value, + ); + }, +) +``` + +Then, we can create our `FutureProvider` which will take care of the request: + +```dart +final searchProvider = FutureProvider< + + + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -对任何中型到大型应用，测试应用都是至关重要的。 +For any medium to large-scale applications, it is critical to test the application. -为了成功地测试我们的应用，我们需要以下东西： +To successfully test our application, we will want the following things: -- `test` 和`testWidgets` 之间不应该保留任何状态。 - 这意味着应用中没有全局状态，或者所有的全局状态都应该在每次测试后重置。 +- No state should be preserved between `test`/`testWidgets`. + That means no global state in the application, or all global states should reset after each test. -- 能够强制我们的provider具有特定的状态，无论是通过模拟还是通过操纵它们直到我们达到所需的状态。 +- Being able to force our providers to have a specific state, either through + mocking or by manipulating them until we reach the desired state. -让我们来逐个看看 [Riverpod] 是如何帮助你处理这些问题的。 +Let's see one by one how [Riverpod] helps you with these. -## `test` 和`testWidgets` 之间不应该保留任何状态。 +## No state should be preserved between `test`/`testWidgets`. -由于provider通常声明为全局变量，你可能会担心这一点。 -毕竟，全局状态使得测试非常困难，因为它可能需要漫长的 `配置(setUp)` 和 `销毁(tearDown)`。 +Since providers are usually declared as global variables, you might worry about +that one. +After all, global state makes testing very difficult, because it can require +lengthy `setUp`/`tearDown`. -但实际情况是虽然provider声明为全局的，但provider的状态却**不是**全局的。 +But the reality is: While providers are declared as globals, the state of a provider +is **not** global. -相反，它存储在一个名为 [ProviderContainer] 的对象中， -如果你查看Dart的示例，你可能已经看到了这个对象。 -如果你还没有看，请了解这个 [ProviderContainer] 对象是由 [ProviderScope] 隐式创建的， -这个widget可以让我们在Flutter项目中启用 [Riverpod]。 +Instead, it is stored in an object named [ProviderContainer], which you may have +seen if you looked at the dart-only examples. +If you haven't, know that this [ProviderContainer] object is implicitly created +by [ProviderScope], the widget that enables [Riverpod] on our project. -具体来说，这意味着两个使用provider的 `testWidgets` 不共享任何状态。 -因此，根本不需要任何 `配置(setUp)` 和 `销毁(tearDown)`。 +Concretely what this means is, two `testWidgets` using providers do not share +any state. +As such, there is no need for any `setUp`/`tearDown` at all. -解释这么多不如来一个例子： +But an example is better than lengthy explanations: -可以看到，虽然 `counterProvider` 被声明为全局变量，但测试间没有共享任何状态。 -因此，如果以不同的顺序执行，我们不必担心我们的测试可能表现不同，因为它们是在完全隔离的情况下运行的。 +As you can see, while `counterProvider` was declared as a global, no state was +shared between tests. +As such, we do not have to worry about our tests potentially behaving differently +if executed in a different order, since they are running in complete isolation. + +## Overriding the behavior of a provider during tests. -## 在测试期间重写provider的行为 +A common real-world application may have the following objects: -现实中，一个常见的应用可能有以下对象： +- It will have a `Repository` class, which provides a type-safe and simple API + to perform HTTP requests. -- 它将有一个 `Repository` 类，该类提供类型安全且简单的API来执行HTTP请求。 -- 一个管理应用程序状态的对象，可以使用 `Repository` 根据不同的因素来执行HTTP请求。 - 这可能是一个 `ChangeNotifier`， `Bloc`，甚至是一个provider。 +- An object that manages the application state, and may use `Repository` to perform + HTTP requests based on different factors. + This may be a `ChangeNotifier`, `Bloc`, or even a provider. -使用 [Riverpod]，可以这样表示： +Using [Riverpod], this may be represented as follows: {trimSnippet(repositorySnippet)} -在这种情况下，当进行单元测试或widget测试时， -我们一般希望用一个返回预定义响应的伪实现来替换 `Repository` 实例，而不是发出真正的HTTP请求。 +In this situation, when making a unit/widget test, we will typically want to +replace our `Repository` instance with a fake implementation that returns +a pre-defined response instead of making a real HTTP request. -然后，我们希望我们的 `todoListProvider` 或类似的组件使用 `Repository` 的模拟实现。 +We will then want our `todoListProvider` or equivalent to use the mocked implementation +of `Repository`. -为了实现这一点，我们可以使用[ProviderScope] 或 [ProviderContainer]的 `overrides` 参数来覆盖 `repositoryProvider` 的行为： +To achieve this, we can use the `overrides` parameter of [ProviderScope]/[ProviderContainer] +to override the behavior of `repositoryProvider`: -正如您可以从高亮的代码中看到的，[ProviderScope]/[ProviderContainer] 允许用不同的行为替换provider的实现。 +As you can see by the highlighted code, [ProviderScope]/[ProviderContainer] +allows replacing the implementation of a provider with a different behavior. :::info -一些provider暴露了重写其行为的简化方法。 -例如，[FutureProvider] 允许使用 `AsyncValue` 重写provider： +Some providers expose simplified ways to override their behavior. +For example, [FutureProvider] allows overriding the provider with an `AsyncValue`: {trimSnippet(testOverrideInfo)} -**注意**：作为2.0.0版本的一部分， `overrideWithValue` 方法被暂时移除。 -它们将在未来的版本中重新添加。 +**Note**: As part of the 2.0.0 release, `overrideWithValue` methods are temporarily +removed. They will be added back in later versions. ::: :::info -使用 `family` 修饰符覆盖provider的语法略有不同。 +The syntax for overriding a provider with the `family` modifier is slightly different. -如果你像这样使用provider： +If you used a provider like this: ```dart final response = ref.watch(myProvider('12345')); ``` -你可以这样覆盖provider： +You could override the provider as: ```dart myProvider('12345').overrideWithValue(...)); @@ -132,9 +156,9 @@ myProvider('12345').overrideWithValue(...)); ::: -## 完整的widget测试用例 +## Full widget test example -最后，这里是我们Flutter测试的完整代码。 +Wrapping up, here is the entire full code for our Flutter test. {trimSnippet(testFull)} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart new file mode 100644 index 000000000..2d25bb8e8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart @@ -0,0 +1,51 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +class FakeRepository {} + +final repositoryProvider = Provider((ref) => FakeRepository()); + +abstract class Todo { + String get id; + String get label; + bool get completed; +} + +final todoListProvider = FutureProvider>((ref) => []); + +void main() { +/* SNIPPET START */ + +test('override repositoryProvider', () async { + final container = ProviderContainer( + overrides: [ + // Override the behavior of repositoryProvider to return + // FakeRepository instead of Repository. + /* highlight-start */ + repositoryProvider.overrideWithValue(FakeRepository()) + /* highlight-end */ + // We do not have to override `todoListProvider`, it will automatically + // use the overridden repositoryProvider + ], + ); + + // The first read if the loading state + expect( + container.read(todoListProvider), + const AsyncValue>.loading(), + ); + + /// Wait for the request to finish + await container.read(todoListProvider.future); + + // Exposes the data fetched + expect(container.read(todoListProvider).value, [ + isA() + .having((s) => s.id, 'id', '42') + .having((s) => s.label, 'label', 'Hello world') + .having((s) => s.completed, 'completed', false), + ]); +}); + +/* SNIPPET END */ +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart new file mode 100644 index 000000000..6685a1bdb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -0,0 +1,40 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +class MyApp extends StatelessWidget { + // ignore: prefer_const_constructors_in_immutables + MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return Container(); + } +} + +final repositoryProvider = Provider((ref) => FakeRepository()); + +class FakeRepository {} + +void main() { +/* SNIPPET START */ + +testWidgets('override repositoryProvider', (tester) async { + await tester.pumpWidget( + ProviderScope( + overrides: [ + // Override the behavior of repositoryProvider to return + // FakeRepository instead of Repository. + /* highlight-start */ + repositoryProvider.overrideWithValue(FakeRepository()) + /* highlight-end */ + // We do not have to override `todoListProvider`, it will automatically + // use the overridden repositoryProvider + ], + child: MyApp(), + ), + ); +}); + +/* SNIPPET END */ +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart new file mode 100644 index 000000000..0f79b4ee8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -0,0 +1,99 @@ + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +class Repository { + Future> fetchTodos() async => []; +} + +class Todo { + Todo({ + required this.id, + required this.label, + required this.completed, + }); + + final String id; + final String label; + final bool completed; +} + +// We expose our instance of Repository in a provider +final repositoryProvider = Provider((ref) => Repository()); + +/// The list of todos. Here, we are simply fetching them from the server using +/// [Repository] and doing nothing else. +final todoListProvider = FutureProvider((ref) async { + // Obtains the Repository instance + final repository = ref.read(repositoryProvider); + + // Fetch the todos and expose them to the UI. + return repository.fetchTodos(); +}); + +/// A mocked implementation of Repository that returns a pre-defined list of todos +class FakeRepository implements Repository { + @override + Future> fetchTodos() async { + return [ + Todo(id: '42', label: 'Hello world', completed: false), + ]; + } +} + +class TodoItem extends StatelessWidget { + const TodoItem({super.key, required this.todo}); + final Todo todo; + @override + Widget build(BuildContext context) { + return Text(todo.label); + } +} + +void main() { + testWidgets('override repositoryProvider', (tester) async { + await tester.pumpWidget( + ProviderScope( + overrides: [ + repositoryProvider.overrideWithValue(FakeRepository()) + ], + // Our application, which will read from todoListProvider to display the todo-list. + // You may extract this into a MyApp widget + child: MaterialApp( + home: Scaffold( + body: Consumer(builder: (context, ref, _) { + final todos = ref.watch(todoListProvider); + // The list of todos is loading or in error + if (todos.asData == null) { + return const CircularProgressIndicator(); + } + return ListView( + children: [ + for (final todo in todos.asData!.value) TodoItem(todo: todo) + ], + ); + }), + ), + ), + ), + ); + + // The first frame is a loading state. + expect(find.byType(CircularProgressIndicator), findsOneWidget); + + // Re-render. TodoListProvider should have finished fetching the todos by now + await tester.pump(); + + // No longer loading + expect(find.byType(CircularProgressIndicator), findsNothing); + + // Rendered one TodoItem with the data returned by FakeRepository + expect(tester.widgetList(find.byType(TodoItem)), [ + isA() + .having((s) => s.todo.id, 'todo.id', '42') + .having((s) => s.todo.label, 'todo.label', 'Hello world') + .having((s) => s.todo.completed, 'todo.completed', false), + ]); + }); +} \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart new file mode 100644 index 000000000..6995de9b8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart @@ -0,0 +1,63 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:mockito/mockito.dart'; +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ + +// A Counter implemented and tested with Dart only (no dependency on Flutter) + +// We declared a provider globally, and we will use it in two tests, to see +// if the state correctly resets to `0` between tests. + +final counterProvider = StateProvider((ref) => 0); + +// Using mockito to keep track of when a provider notify its listeners +class Listener extends Mock { + void call(int? previous, int value); +} + +void main() { + test('defaults to 0 and notify listeners when value changes', () { + // An object that will allow us to read providers + // Do not share this between tests. + final container = ProviderContainer(); + addTearDown(container.dispose); + final listener = Listener(); + + // Observe a provider and spy the changes. + container.listen( + counterProvider, + listener.call, + fireImmediately: true, + ); + + // the listener is called immediately with 0, the default value + verify(listener(null, 0)).called(1); + verifyNoMoreInteractions(listener); + + // We increment the value + container.read(counterProvider.notifier).state++; + + // The listener was called again, but with 1 this time + verify(listener(0, 1)).called(1); + verifyNoMoreInteractions(listener); + }); + + test('the counter state is not shared between tests', () { + // We use a different ProviderContainer to read our provider. + // This ensure that no state is reused between tests + final container = ProviderContainer(); + addTearDown(container.dispose); + final listener = Listener(); + + container.listen( + counterProvider, + listener.call, + fireImmediately: true, + ); + + // The new test correctly uses the default value: 0 + verify(listener(null, 0)).called(1); + verifyNoMoreInteractions(listener); + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart new file mode 100644 index 000000000..f76abe181 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -0,0 +1,56 @@ +// ignore_for_file: use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +/* SNIPPET START */ + +// A Counter implemented and tested using Flutter + +// We declared a provider globally, and we will use it in two tests, to see +// if the state correctly resets to `0` between tests. + +final counterProvider = StateProvider((ref) => 0); + +// Renders the current state and a button that allows incrementing the state +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return MaterialApp( + home: Consumer(builder: (context, ref, _) { + final counter = ref.watch(counterProvider); + return ElevatedButton( + onPressed: () => ref.read(counterProvider.notifier).state++, + child: Text('$counter'), + ); + }), + ); + } +} + +void main() { + testWidgets('update the UI when incrementing the state', (tester) async { + await tester.pumpWidget(ProviderScope(child: MyApp())); + + // The default value is `0`, as declared in our provider + expect(find.text('0'), findsOneWidget); + expect(find.text('1'), findsNothing); + + // Increment the state and re-render + await tester.tap(find.byType(ElevatedButton)); + await tester.pump(); + + // The state have properly incremented + expect(find.text('1'), findsOneWidget); + expect(find.text('0'), findsNothing); + }); + + testWidgets('the counter state is not shared between tests', (tester) async { + await tester.pumpWidget(ProviderScope(child: MyApp())); + + // The state is `0` once again, with no tearDown/setUp needed + expect(find.text('0'), findsOneWidget); + expect(find.text('1'), findsNothing); + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart new file mode 100644 index 000000000..d71ae3c69 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart @@ -0,0 +1,43 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +extension on ProviderBase { + // ignore: unused_element + Override overrideWithValue(Object? value) => throw UnimplementedError(); +} + +class Todo { + Todo({ + required String id, + required String label, + required bool completed, + }); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return Container(); + } +} + +/* SNIPPET START */ + +final todoListProvider = FutureProvider((ref) async => []); +// ... +/* SKIP */ +final foo = +/* SKIP END */ + ProviderScope( + overrides: [ + /// Allows overriding a FutureProvider to return a fixed value + todoListProvider.overrideWithValue( + AsyncValue.data([Todo(id: '42', label: 'Hello', completed: true)]), + ), + ], + child: const MyApp(), +); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart new file mode 100644 index 000000000..c499279fc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart @@ -0,0 +1,22 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class Todo {} + +/* SNIPPET START */ + +class Repository { + Future> fetchTodos() async => []; +} + +// We expose our instance of Repository in a provider +final repositoryProvider = Provider((ref) => Repository()); + +/// The list of todos. Here, we are simply fetching them from the server using +/// [Repository] and doing nothing else. +final todoListProvider = FutureProvider((ref) async { + // Obtains the Repository instance + final repository = ref.watch(repositoryProvider); + + // Fetch the todos and expose them to the UI. + return repository.fetchTodos(); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx new file mode 100644 index 000000000..579ec40c4 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx @@ -0,0 +1,306 @@ +--- +title: 清除缓存并对状态处置做出反应 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import onDisposeExample from "./auto_dispose/on_dispose_example"; +import codegenKeepAlive from "!!raw-loader!./auto_dispose/codegen_keep_alive.dart"; +import rawAutoDispose from "!!raw-loader!./auto_dispose/raw_auto_dispose.dart"; +import invalidateExample from "!!raw-loader!./auto_dispose/invalidate_example.dart"; +import keepAlive from "./auto_dispose/keep_alive"; +import cacheForExtension from "!!raw-loader!./auto_dispose/cache_for_extension.dart"; +import cacheForUsage from "./auto_dispose/cache_for_usage"; +import invalidateFamilyExample from './auto_dispose/invalidate_family_example' + + +到目前为止，我们已经了解了如何创建/更新某些状态。 +但我们还没有谈论状态处置何时发生。 + + +Riverpod 提供了多种与状态处置进行交互的方法。 +这包括从延迟处置状态到对处置做出反应。 + + +## 何时状态被处置，如何改变这一点？ + + + + +使用代码生成时，默认情况下，当提供者程序停止被监听时，状态将被处置。 +当监听器在整个帧中没有活动的监听器时，会发生这种情况。 +当这种情况发生时，状态将被处置。 + + +可以使用 `keepAlive: true` 选择禁用此行为。 +这样做可以防止在删除所有监听器时状态被处置。 + + + + + + + + +不使用代码生成时，默认情况下，当提供者程序停止监听时，状态不会被处置。 + + +您可以选择更改此行为并使用自动处置。 +执行此操作时，Riverpod 将跟踪提供者程序是否有监听器。 +然后，如果一帧的时间内提供者程序没有监听器，则状态将被处置。 + + +若要启用自动处置，可以在提供者程序类型旁边使用 `.autoDispose`： + + + + + +:::note + +启用/禁用自动处置在重新计算提供者程序时，对于是否处置状态没有影响。 +重新计算提供者程序时，状态将始终被处置。 +::: + +:::caution + +当提供者程序收到参数时，建议启用自动处置。 +这是因为否则，将为每个参数组合创建一个状态，这可能会导致内存泄漏。 +::: + + +## 对状态处置做出反应 + + +在 Riverpod 中，有几种内置的处置状态的方法： + + +- 提供者程序不再使用，并且处于“自动处置”模式（稍后会详细介绍）。 + 在这种情况下，与提供者程序的所有关联状态都将被处置。 +- 提供者程序将重新计算，例如 `ref.watch`。 + 在这种情况下，将处置以前的状态，并创建一个新状态。 + + +在这两种情况下。发生这种情况时，您可能希望执行一些逻辑。 +这可以通过 `ref.onDispose` 实现。 +此方法允许注册监听器，当状态被处置时回调。 + + +例如，您可能希望使用它来关闭任何活动 `StreamController`： + + + +:::caution + +不得触发副作用的 `ref.onDispose` 回调。 +修改提供者程序内部的 `onDispose` 可能会导致意外行为。 +::: + +:::info + +还有其他有用的生命周期，例如： + + +- `ref.onCancel` 当删除提供者程序的最后一个监听器时调用。 +- `ref.onResume` 当 `onCancel` 调用之后添加新的监听器时调用。 + +::: + +:::info + +您可以根据需要多次调用 `ref.onDispose`。 +在提供者程序中，每个可处置的对象可随意调用一次。 +这种做法使我们更容易发现我们何时忘记处置某些东西。 +::: + + +## 手动强制处置提供者程序，使用 `ref.invalidate` + + +有时，您可能希望强制处置提供者程序。 +这可以通过使用 `ref.invalidate` 来完成， +它可以从另一个提供者程序或小部件调用。 + + +使用 `ref.invalidate` 将处置当前提供者程序状态。 +然后有两种可能的结果： + + +- 如果监听提供者程序，则将创建一个新状态。 +- 如果提供者程序未被监听，则提供者程序将被完全处置。 + + + +:::info + +提供者程序可以使用 `ref.invalidateSelf` 使自己失效。 +尽管在这种情况下，这始终会导致创建新状态。 +::: + +:::tip + +当尝试使接收参数的提供者程序失效时， +可能会使一个特定的参数组合失效， +也可以同时使所有参数组合失效： + + +::: + + +## 使用 `ref.keepAlive` 微调处置 + + +如上所述，当自动处置启用时，如果在完整的一帧时间里提供者程序没有监听器，状态将被处置。 + + +但您可能希望对此行为有更多的控制权。例如， +您可能希望保留成功网络请求的状态，但不缓存失败的请求。 + + +这可以在启用自动处置后，使用通过 `ref.keepAlive` 来实现。 +使用它，您可以决定_何时_停止自动处置状态。 + + + +:::note + +如果重新计算提供者程序，将重新启用自动处置。 + + +也可以使用 `ref.keepAlive` 的返回值使其恢复到自动处置状态。 +::: + + +## 示例：在一段特定时间内保持状态 + + +目前，Riverpod 不提供在特定时间内保持状态的内置方法。 +但是，使用我们目前看到的工具，实现这样的功能很容易且可重用。 + + +通过使用 `Timer` + `ref.keepAlive`，我们可以在特定的时间内保持状态。 +为了使这个逻辑可重用，我们可以在扩展方法中实现它： + + + + +然后，我们可以这样使用它： + + + + +可以调整此逻辑以满足您的需求。 +例如，仅当提供者程序在特定时间内未被监听时， +才可以使用 `ref.onCancel`/`ref.onResume` 处置状态。 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart new file mode 100644 index 000000000..cb7d14fe9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart @@ -0,0 +1,18 @@ +import 'dart:async'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +extension CacheForExtension on AutoDisposeRef { + /// 使提供者程序在 [duration] 内存活。 + void cacheFor(Duration duration) { + // 立即防止状态遭到破坏。 + final link = keepAlive(); + // 持续时间结束后，我们将重新启用自动处置功能。 + final timer = Timer(duration, link.close); + + // 可选项：重新计算提供者程序时（如使用 ref.watch） + // 我们取消待定计时器 + onDispose(timer.cancel); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart new file mode 100644 index 000000000..b63cf3a46 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart @@ -0,0 +1,17 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../cache_for_extension.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future example(ExampleRef ref) async { + /// 保持状态 5 分钟 + ref.cacheFor(const Duration(minutes: 5)); + + return http.get(Uri.https('example.com')); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart new file mode 100644 index 000000000..98fd6ea63 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'3ff29b1cd8fa864286a2a04e39adf1c8589b4275'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeFutureProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart new file mode 100644 index 000000000..a9c396eb7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart @@ -0,0 +1,15 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../cache_for_extension.dart'; + +/* SNIPPET START */ +final provider = FutureProvider.autoDispose((ref) async { + /// 保持状态 5 分钟 + ref.cacheFor(const Duration(minutes: 5)); + + return http.get(Uri.https('example.com')); +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart new file mode 100644 index 000000000..6a576d932 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart @@ -0,0 +1,10 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_keep_alive.g.dart'; + +/* SNIPPET START */ +// 我们可以在注解中指定 "keepAlive" 来禁用状态自动处置功能 +@Riverpod(keepAlive: true) +int example(ExampleRef ref) { + return 0; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart new file mode 100644 index 000000000..854d2df27 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_keep_alive.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'78f9426f6cbda80564387a9db8cd02368d890a85'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = Provider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = ProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart new file mode 100644 index 000000000..db72c7279 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart @@ -0,0 +1,23 @@ +// ignore_for_file: use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +// We can specify autoDispose to enable automatic state destruction. +final someProvider = Provider.autoDispose((ref) { + return 0; +}); + +/* SNIPPET START */ +class MyWidget extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return ElevatedButton( + onPressed: () { + // 点击后，处置提供者程序。 + ref.invalidate(someProvider); + }, + child: const Text('dispose a provider'), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart new file mode 100644 index 000000000..4a93c3283 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +late WidgetRef ref; + +/* SNIPPET START */ +@riverpod +String label(LabelRef ref, String userName) { + return 'Hello $userName'; +} + +// ... + +void onTap() { + // 使该提供者程序所有可能的参数组合无效。 + ref.invalidate(labelProvider); + // 仅使特定组合无效 + ref.invalidate(labelProvider('John')); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart new file mode 100644 index 000000000..410c48677 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -0,0 +1,200 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$labelHash() => r'20aa8ce0231205540f466f91259732bd86953c64'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [label]. +@ProviderFor(label) +const labelProvider = LabelFamily(); + +/// See also [label]. +class LabelFamily extends Family { + /// See also [label]. + const LabelFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'labelProvider'; + + /// See also [label]. + LabelProvider call( + String userName, + ) { + return LabelProvider( + userName, + ); + } + + @visibleForOverriding + @override + LabelProvider getProviderOverride( + covariant LabelProvider provider, + ) { + return call( + provider.userName, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(String Function(LabelRef ref) create) { + return _$LabelFamilyOverride(this, create); + } +} + +class _$LabelFamilyOverride implements FamilyOverride { + _$LabelFamilyOverride(this.overriddenFamily, this.create); + + final String Function(LabelRef ref) create; + + @override + final LabelFamily overriddenFamily; + + @override + LabelProvider getProviderOverride( + covariant LabelProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [label]. +class LabelProvider extends AutoDisposeProvider { + /// See also [label]. + LabelProvider( + String userName, + ) : this._internal( + (ref) => label( + ref as LabelRef, + userName, + ), + from: labelProvider, + name: r'labelProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$labelHash, + dependencies: LabelFamily._dependencies, + allTransitiveDependencies: LabelFamily._allTransitiveDependencies, + userName: userName, + ); + + LabelProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.userName, + }) : super.internal(); + + final String userName; + + @override + Override overrideWith( + String Function(LabelRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: LabelProvider._internal( + (ref) => create(ref as LabelRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + userName: userName, + ), + ); + } + + @override + (String,) get argument { + return (userName,); + } + + @override + AutoDisposeProviderElement createElement() { + return _LabelProviderElement(this); + } + + LabelProvider _copyWith( + String Function(LabelRef ref) create, + ) { + return LabelProvider._internal( + (ref) => create(ref as LabelRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + userName: userName, + ); + } + + @override + bool operator ==(Object other) { + return other is LabelProvider && other.userName == userName; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, userName.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin LabelRef on AutoDisposeProviderRef { + /// The parameter `userName` of this provider. + String get userName; +} + +class _LabelProviderElement extends AutoDisposeProviderElement + with LabelRef { + _LabelProviderElement(super.provider); + + @override + String get userName => (origin as LabelProvider).userName; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart new file mode 100644 index 000000000..6df871dbb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart @@ -0,0 +1,20 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +late WidgetRef ref; + +/* SNIPPET START */ +final provider = Provider.autoDispose.family((ref, name) { + return 'Hello $name'; +}); + +// ... + +void onTap() { + // 使该提供者程序所有可能的参数组合无效。 + ref.invalidate(provider); + // 仅使特定组合无效 + ref.invalidate(provider('John')); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart new file mode 100644 index 000000000..8f6bf9032 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart @@ -0,0 +1,21 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future example(ExampleRef ref) async { + final response = await http.get(Uri.parse('https://example.com')); + // 只有在请求成功完成后，我们才会让提供者程序存活。 + // 如果请求失败（并抛出异常），那么当提供者程序停止被监听时， + // 状态就会被处置。 + ref.keepAlive(); + + // 我们可以使用 `link` 恢复自动处置行为： + // link.close(); + + return response.body; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart new file mode 100644 index 000000000..bf38010f2 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'4fa856c55e84da9525dcecfab1c897e61456325b'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeFutureProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart new file mode 100644 index 000000000..375b52b6f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart @@ -0,0 +1,19 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +final provider = FutureProvider.autoDispose((ref) async { + final response = await http.get(Uri.parse('https://example.com')); + // 只有在请求成功完成后，我们才会让提供者程序存活。 + // 如果请求失败（并抛出异常），那么当提供者程序停止被监听时， + // 状态就会被处置。 + final link = ref.keepAlive(); + + // 我们可以使用 `link` 恢复自动处置行为： + // link.close(); + + return response.body; +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart new file mode 100644 index 000000000..d9ada052f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable + +import 'dart:async'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +Stream example(ExampleRef ref) { + final controller = StreamController(); + + // 当状态被处置时，我们关闭 StreamController。 + ref.onDispose(controller.close); + + // TO-DO: 在 StreamController 中推送一些值 + return controller.stream; +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart new file mode 100644 index 000000000..448c6784e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +/// See also [other]. +@ProviderFor(other) +final otherProvider = AutoDisposeProvider.internal( + other, + name: r'otherProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$otherHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef OtherRef = AutoDisposeProviderRef; +String _$exampleHash() => r'29f92958e0d0e3f13ac033e92cd2e4072339c7db'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeStreamProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeStreamProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart new file mode 100644 index 000000000..aa1a4e59d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart @@ -0,0 +1,17 @@ +// ignore_for_file: unused_local_variable + +import 'dart:async'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +final provider = StreamProvider((ref) { + final controller = StreamController(); + + // 当状态被处置时，我们关闭 StreamController。 + ref.onDispose(controller.close); + + // TO-DO: 在 StreamController 中推送一些值 + return controller.stream; +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart new file mode 100644 index 000000000..155623207 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart @@ -0,0 +1,7 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +// 我们可以指定 autoDispose 来启用状态自动处置功能。 +final provider = Provider.autoDispose((ref) { + return 0; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx new file mode 100644 index 000000000..ab0a6a7f5 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx @@ -0,0 +1,275 @@ +--- +title: 组合请求 +version: 1 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet } from "@site/src/components/CodeSnippet"; +import functionalRef from "./combining_requests/functional_ref"; +import notifierRef from "./combining_requests/notifier_ref"; +import watchExample from "./combining_requests/watch_example"; +import watchPlacement from "./combining_requests/watch_placement"; +import listenExample from "./combining_requests/listen_example"; +import readExample from './combining_requests/read_example' + + +到目前为止，我们只看到请求彼此独立的案例。 +但一个常见的用例是必须根据另一个请求的结果触发请求。 + + +我们可以使用机制来做到这一点， +方法是将一个提供者程序的结果作为参数传递给另一个提供者程序。 + + +但这种方法有一些缺点： + + +- 这泄露了实现细节。 + 现在，UI 需要了解所有被其他提供者程序使用的提供者程序。 +- 每当参数发生变化时，都会产生一个全新的状态。 + 通过传递参数，当参数更改时，无法保持以前的状态。 +- 它使合并请求变得更加困难。 +- 这使得开发工具的用处降低。devtool 不会知道提供者程序之间的关系。 + + +为了改善这一点，Riverpod 提供了一种不同的方法来合并请求。 + + +## 基础知识：获取 "ref" + + +组合请求的所有可能方法都有一个共同点：它们都基于 `Ref` 对象。 + + +该 `Ref` 对象是所有提供者程序都有权访问的对象。 +它允许他们访问各种生命周期监听器， +还可以使用各种方法来组合提供者程序。 + + +可以获取的位置 `Ref` 取决于提供者程序的类型。 + + +在函数提供者程序中，将 `Ref` 作为参数传递给提供者程序的函数： + + + + +在类变体中，`Ref` 是通知者程序类的一个属性： + + + + +## 使用 ref 读取提供者程序。 + + +### `ref.watch` 方法。 + + +现在我们已经获得了一个 `Ref`，我们可以用它来组合请求。 +执行此操作的主要方法是使用 `ref.watch`。 +通常建议对代码进行架构设计， +以便可以使用 `ref.watch` 的其他选项，因为它通常更易于维护。 + + +该 `ref.watch` 方法采用提供者程序，并返回其当前状态。 +然后，每当监听的提供者程序发生更改时，我们的提供者程序将在 +下一帧或下一次读取时失效并重新生成。 + + +通过使用 `ref.watch`，您的逻辑变得既是“反应式”又是“声明式”。 +这意味着您的逻辑将在需要时自动重新计算。 +并且更新机制不依赖于副作用，例如“更改”。 +这类似于 StatelessWidgets 的行为方式。 + + +例如，我们可以定义一个监听用户位置的提供者程序。 +然后，我们可以使用这个位置来获取用户附近的餐馆列表。 + + + +:::info + +当监听的提供者程序发生更改并且我们的请求重新计算时，将保留以前的状态，直到新请求完成。 +同时，当请求处于挂起状态时，将设置 "isLoading" 和 "isReloading" 标志。 + + +这使 UI 能够显示以前的状态或加载指示器，甚至两者兼而有之。 +::: + +:::info + +请注意我们如何使用 `ref.watch(locationProvider.future)` 来替代 `ref.watch(locationProvider)`。 +那是因为我们 `locationProvider` 是异步的。因此，我们希望等待初始值可用。 + + +如果我们省略了这一点 `.future`，我们将收到一个 `AsyncValue`， +它是 `locationProvider` 当前状态的快照。但是，如果还没有可用的位置， +我们将无能为力。 +::: + +:::caution + +调用 `ref.watch` “命令式”执行的内部代码被认为是不好的做法。 +这意味着在提供者程序的构建阶段可能未执行的任何代码。 +这包括通告程序上的“监听器”回调或方法： + + +::: + + +### `ref.listen`/`listenSelf` 方法。 + + +该 `ref.listen` 方法是 `ref.watch` 的替代方法。 +它类似于传统的 "listen"/"addListener" 方法。 +它接受一个提供者程序和一个回调， +并在提供者程序的内容发生更改时调用该回调。 + + +通常建议重构代码，您可以使用 `ref.watch` 替代 `ref.listen`， +因为后者由于其命令性质而更容易出错。 +但是 `ref.listen` 可以有助于添加一些快速逻辑而不必进行重大重构。 + + +我们可以重写 `ref.watch` 示例并使用 `ref.listen` 代替 + + + +:::info + +在提供者程序的构建阶段使用 `ref.listen` 是完全安全的。 +如果以某种方式重新计算提供者程序，则以前的监听器将被删除。 + + +或者，您可以根据需要使用 `ref.listen` 的返回值手动删除监听器。 +::: + + +### `ref.read` 方法 + + +最后一个可用选项是 `ref.read`。 +它类似于 `ref.watch` 返回提供者程序的当前状态。 +但与 `ref.watch` 不同的是，它不监听提供者程序。 + + +因此，`ref.read` 应该只被用在你不能使用 `ref.watch` 的地方， +比如通告程序的内部方法。 + + + +:::caution + +`ref.read` 在提供者程序上使用时要小心，因为它不监听提供者程序， +因此如果不监听提供者程序，则该提供者程序可能会决定处置其状态。 +::: diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart new file mode 100644 index 000000000..815283fa1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart @@ -0,0 +1,18 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +int example(ExampleRef ref) { + // "Ref" 可以在这里用来阅读其他提供者程序 + final otherValue = ref.watch(otherProvider); + + return 0; +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart new file mode 100644 index 000000000..8df442e58 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +/// See also [other]. +@ProviderFor(other) +final otherProvider = AutoDisposeProvider.internal( + other, + name: r'otherProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$otherHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef OtherRef = AutoDisposeProviderRef; +String _$exampleHash() => r'4429d7d3bb2b31fea4cc42c2f2af02d3f3d10693'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart new file mode 100644 index 000000000..c4586d9f2 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart @@ -0,0 +1,14 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = Provider((ref) { + // "Ref" 可以在这里用来阅读其他提供者程序 + final otherValue = ref.watch(otherProvider); + + return 0; +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart new file mode 100644 index 000000000..25c6a2f37 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart @@ -0,0 +1,17 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +@riverpod +int example(ExampleRef ref) { + ref.listen(otherProvider, (previous, next) { + print('Changed from: $previous, next: $next'); + }); + + return 0; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart new file mode 100644 index 000000000..eb3006429 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'd614303f372e06e6ab96035affc4c07a53b28741'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart new file mode 100644 index 000000000..12b578dd0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart @@ -0,0 +1,13 @@ +// ignore_for_file: unused_local_variable, avoid_print +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = Provider((ref) { + ref.listen(otherProvider, (previous, next) { + print('Changed from: $previous, next: $next'); + }); + + return 0; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart new file mode 100644 index 000000000..1d2139dbf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart @@ -0,0 +1,21 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + int build() { + // "Ref" 可以在这里用来阅读其他提供者程序 + final otherValue = ref.watch(otherProvider); + + return 0; + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart new file mode 100644 index 000000000..8109b649d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +/// See also [other]. +@ProviderFor(other) +final otherProvider = AutoDisposeProvider.internal( + other, + name: r'otherProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$otherHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef OtherRef = AutoDisposeProviderRef; +String _$exampleHash() => r'893db991b377b8e314e60c429043e5e81f1fd526'; + +/// See also [Example]. +@ProviderFor(Example) +final exampleProvider = AutoDisposeNotifierProvider.internal( + Example.new, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$Example = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart new file mode 100644 index 000000000..b68379fdc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart @@ -0,0 +1,19 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = NotifierProvider(MyNotifier.new); + +class MyNotifier extends Notifier { + @override + int build() { + // "Ref" 可以在这里用来阅读其他提供者程序 + final otherValue = ref.watch(otherProvider); + + return 0; + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart new file mode 100644 index 000000000..1469d1629 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // 糟糕的！不要在这里使用 "read"，因为它不是反应性的 + ref.read(otherProvider); + + return 0; + } + + void increment() { + ref.read(otherProvider); // 这里使用 "read" 就可以了 + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart new file mode 100644 index 000000000..4bac3c78b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'353efe22dd5a91b2d036286211ac9e60c9de5f6d'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart new file mode 100644 index 000000000..8c173f806 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final notifierProvider = NotifierProvider(MyNotifier.new); + +class MyNotifier extends Notifier { + @override + int build() { + // 糟糕的！不要在这里使用 "read"，因为它不是反应性的 + ref.read(otherProvider); + + return 0; + } + + void increment() { + ref.read(otherProvider); // 这里使用 "read" 就可以了 + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart new file mode 100644 index 000000000..afacd67bc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart @@ -0,0 +1,44 @@ +// ignore_for_file: unused_local_variable + +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +final otherProvider = Provider((ref) => 0); + +const someStream = Stream<({double longitude, double latitude})>.empty(); + +/* SNIPPET START */ +@riverpod +Stream<({double longitude, double latitude})> location(LocationRef ref) { + // TO-DO: 返回获取当前位置的流 + return someStream; +} + +@riverpod +Future> restaurantsNearMe(RestaurantsNearMeRef ref) async { + // 我们使用 "ref.watch" 来获取最新位置。 + // 通过在提供者程序之后指定 ".future"， + // 我们的代码将在等待到至少一个位置信息后可用。 + final location = await ref.watch(locationProvider.future); + + // 我们现在可以根据该位置发出网络请求。 + // 例如，我们可以使用 Google Map API： + // https://developers.google.com/maps/documentation/places/web-service/search-nearby + final response = await http.get( + Uri.https('maps.googleapis.com', 'maps/api/place/nearbysearch/json', { + 'location': '${location.latitude},${location.longitude}', + 'radius': '1500', + 'type': 'restaurant', + 'key': '', + }), + ); + // 从 JSON 中获取餐厅名称 + final json = jsonDecode(response.body) as Map; + final results = (json['results'] as List).cast>(); + return results.map((e) => e['name']! as String).toList(); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart new file mode 100644 index 000000000..2bf4a34f4 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart @@ -0,0 +1,44 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$locationHash() => r'22e666f1e1ce04ce03d8f8d5652e25b54c1d1af3'; + +/// See also [location]. +@ProviderFor(location) +final locationProvider = + AutoDisposeStreamProvider<({double longitude, double latitude})>.internal( + location, + name: r'locationProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$locationHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef LocationRef + = AutoDisposeStreamProviderRef<({double longitude, double latitude})>; +String _$restaurantsNearMeHash() => r'dd49cc1e6f16abb34dd15286d171e322c06b93b8'; + +/// See also [restaurantsNearMe]. +@ProviderFor(restaurantsNearMe) +final restaurantsNearMeProvider = + AutoDisposeFutureProvider>.internal( + restaurantsNearMe, + name: r'restaurantsNearMeProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$restaurantsNearMeHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef RestaurantsNearMeRef = AutoDisposeFutureProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart new file mode 100644 index 000000000..8852726ff --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart @@ -0,0 +1,41 @@ +// ignore_for_file: unused_local_variable + +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +final otherProvider = Provider((ref) => 0); + +const someStream = Stream<({double longitude, double latitude})>.empty(); + +/* SNIPPET START */ +final locationProvider = + StreamProvider<({double longitude, double latitude})>((ref) { + // TO-DO: 返回获取当前位置的流 + return someStream; +}); + +final restaurantsNearMeProvider = FutureProvider>((ref) async { + // 我们使用 "ref.watch" 来获取最新位置。 + // 通过在提供者程序之后指定 ".future"， + // 我们的代码将在等待到至少一个位置信息后可用。 + final location = await ref.watch(locationProvider.future); + + // 我们现在可以根据该位置发出网络请求。 + // 例如，我们可以使用 Google Map API： + // https://developers.google.com/maps/documentation/places/web-service/search-nearby + final response = await http.get( + Uri.https('maps.googleapis.com', 'maps/api/place/nearbysearch/json', { + 'location': '${location.latitude},${location.longitude}', + 'radius': '1500', + 'type': 'restaurant', + 'key': '', + }), + ); + // 从 JSON 中获取餐厅名称 + final json = jsonDecode(response.body) as Map; + final results = (json['results'] as List).cast>(); + return results.map((e) => e['name']! as String).toList(); +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart new file mode 100644 index 000000000..b5da254f6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart @@ -0,0 +1,37 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/foundation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +@riverpod +int example(ExampleRef ref) { + ref.watch(otherProvider); // 好！ + ref.onDispose(() => ref.watch(otherProvider)); // 糟糕！ + + final someListenable = ValueNotifier(0); + someListenable.addListener(() { + ref.watch(otherProvider); // 糟糕！ + }); + + return 0; +} + +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + ref.watch(otherProvider); // 好！ + ref.onDispose(() => ref.watch(otherProvider)); // 糟糕！ + + return 0; + } + + void increment() { + ref.watch(otherProvider); // 糟糕！ + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart new file mode 100644 index 000000000..c845e281b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart @@ -0,0 +1,41 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'd4d63f5cf1aaec5b7c6a19e6fee18ddf070147ec'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeProviderRef; +String _$myNotifierHash() => r'ad79fdb5b0e72a800fa03efc1e7157f0d1524844'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart new file mode 100644 index 000000000..1eb02eea0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart @@ -0,0 +1,35 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/foundation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = Provider((ref) { + ref.watch(otherProvider); // 好！ + ref.onDispose(() => ref.watch(otherProvider)); // 糟糕！ + + final someListenable = ValueNotifier(0); + someListenable.addListener(() { + ref.watch(otherProvider); // 糟糕！ + }); + + return 0; +}); + +final notifierProvider = NotifierProvider(MyNotifier.new); + +class MyNotifier extends Notifier { + @override + int build() { + ref.watch(otherProvider); // 好！ + ref.onDispose(() => ref.watch(otherProvider)); // 糟糕！ + + return 0; + } + + void increment() { + ref.watch(otherProvider); // 糟糕！ + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx new file mode 100644 index 000000000..d1b4fe452 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx @@ -0,0 +1,260 @@ +--- +title: 最佳实践 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; + + +为了确保代码具有良好的可维护性， +这里列出了您在使用 Riverpod 时应遵循的良好实践。 + + +此列表并不详尽，并且可能会发生变化。 +如果您有任何建议，请随时[提出问题](https://github.com/rrousselGit/riverpod/issues/new?assignees=rrousselGit&labels=documentation%2C+needs+triage&projects=&template=example_request.md&title=)。 + + +此列表中的项目没有任何特定的顺序。 + + +这些建议的很大一部分可以通过 [riverpod_lint](https://pub.dev/packages/riverpod_lint) 来执行。 +请参阅了解安装说明。 + + +## 避免！在小部件中初始化提供者程序​ + + +提供者程序应自行初始化。 +它们不应由外部元素（例如小部件）初始化。 + + +如果不这样做可能会导致可能的竞争条件和意外行为。 + + +**不要** + +```dart +class WidgetState extends State { + @override + void initState() { + super.initState(); + // 坏的：提供者程序应该自己初始化自己 + ref.read(provider).init(); + } +} +``` + + +**考虑** + + +对于这个问题，没有“一刀切”的解决方案。 +如果您的初始化逻辑取决于提供者程序的外部因素， +则放置此类逻辑的正确位置通常是触发导航的按钮的 `onPressed` 方法中： + +```dart +ElevatedButton( + onPressed: () { + ref.read(provider).init(); + Navigator.of(context).push(...); + }, + child: Text('Navigate'), +) +``` + + +## 避免！使用本地小部件状态的提供者程序。 + + +提供者程序被设计为共享业务状态。 +它们不适合用于本地小部件状态，例如： + + +- 存储表单状态 +- 当前选择的项目 +- 动画 +- Flutter 处理常见的 "controller" 相关的所有内容（例如 `TextEditingController` ） + + +如果您正在寻找一种处理本地小部件状态的方法，请考虑使用 +[flutter_hooks](https://pub.dev/packages/flutter_hooks) 代替。 + + +不鼓励这样做的一个原因是这种状态通常仅限于一条路由。 +如果不这样做，可能会破坏应用程序的后退按钮，因为新页面会覆盖上一页的状态。 + + +## 不要！在提供者程序初始化期间执行副作用​ + + +提供者程序通常应用于表示“读”操作。 +您不应该将它们用于“写”操作，例如提交表单。 + + +使用提供者程序进行此类操作可能会产生意外行为，例如 +如果执行了前一个操作，则跳过副作用。 + + +如果您正在寻找一种处理副作用的加载/错误状态的方法， +请参阅。 + + +**不要**： + +```dart +final submitProvider = FutureProvider((ref) async { + final formState = ref.watch(formState); + + // 坏的：提供者程序不应用于“写”操作。 + return http.post('https://my-api.com', body: formState.toJson()); +}); +``` + + +## 首选！ref.watch/read/listen（和类似的 API）以及静态已知的提供者程序​ + + +Riverpod 强烈建议启用 lint 规则（通过 riverpod_lint）。 +但为了使 lint 发挥作用，您的代码应该以可静态分析的方式编写。 + + +如果不这样做，可能会更难发现错误或导致 lints 误报。 + + +**应该**： + +```dart +final provider = Provider((ref) => 42); + +... + +// 好的，因为提供者程序是静态已知的 +ref.watch(provider); +``` + + +**不要**： + +```dart +class Example extends ConsumerWidget { + Example({required this.provider}); + final Provider provider; + + @override + Widget build(context, ref) { + // 不好，因为静态分析无法知道 `provider` 是什么 + ref.watch(provider); + } +} +``` + + +## 避免！动态创建提供者程序​ + + +提供者程序应该专门是顶级 final 变量。 + + +**应该**： + +```dart +final provider = Provider((ref) => 'Hello world'); +``` + + +**不要**： + +```dart +class Example { + // 不支持的操作。可能导致内存泄漏和意外行为。 + final provider = Provider((ref) => 'Hello world'); +} +``` + +:::info + +允许将提供者程序创建为 static final 变量， +但代码生成器不支持。 +::: diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx new file mode 100644 index 000000000..35c85ad4b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx @@ -0,0 +1,117 @@ +--- +title: 急切的初始化提供者程序 +version: 1 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet } from "@site/src/components/CodeSnippet"; +import consumerExample from "!!raw-loader!./eager_initialization/consumer_example.dart"; +import asyncConsumerExample from "!!raw-loader!./eager_initialization/async_consumer_example.dart"; +import requireValue from "./eager_initialization/require_value"; + + +默认情况下，所有提供者程序都以延迟方式初始化。 +这意味着提供者程序仅在首次使用时进行初始化。 +这对于仅在应用程序的某些部分使用的提供者程序很有用。 + + +不幸的是，由于 Dart 的工作方式（出于摇树目的），没有办法将提供者程序标记为需要急切初始化。 +但是，一种解决方案是在应用程序的根组件下强制读取要急切初始化的提供者程序。 + + +推荐的方法是简单地 "watch" 位于 `ProviderScope` 下方的 Consumer 中的提供者程序： + + + +:::note + +请考虑将初始化使用者放在 "MyApp" 或公共小部件中。 +这使你的测试能够使用相同的行为，方法是从你的主数据中删除逻辑。 +::: + + +### 常见疑问 + + +#### 当提供者程序更改时，这不会重建我们的整个应用程序吗？ + + +不，事实并非如此。 +在上面给出的示例中，负责急切初始化的消费者程序是一个单独的小部件，它只返回一个 `child` . + + +关键部分是它返回一个 `child` ，而不是实例化 `MaterialApp` 自身。 +这意味着，如果重新生成 `_EagerInitialization`，`child` 变量将不会更改。 +当一个小部件没有改变时，Flutter 不会重建它。 + + +因此，除非另一个小部件也在监听该提供者程序，否则只会 `_EagerInitialization` 重新构建。 + + +#### 使用此方法，如何处理加载和错误状态？ + + +您可以像往常一样在 `Consumer` 中处理加载/错误状态。 +您可以 `_EagerInitialization` 检查提供者程序是否处于 "loading" 状态， +如果是则返回 `CircularProgressIndicator` 否则返回 `child`： + + + + +#### 我已经处理了加载/错误状态，但其他消费者程序仍然收到 AsyncValue！有没有办法不必处理每个小部件中的加载/错误状态？ + + +与其试图让你的提供者程序不公开一个 `AsyncValue` ，不如让你的小部件使用 `AsyncValue.requireValue`。 +这将读取数据，而无需进行模式匹配。如果一个错误溜走了，它会抛出一个异常，并带有明确的信息。 + + + +:::note + +尽管有一些方法可以在这些情况下不公开加载/错误状态（依赖于范围），但通常不建议这样做。 +创建两个提供者程序并使用覆盖所增加的复杂性不值得麻烦。 +::: diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart new file mode 100644 index 000000000..9a64181b0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart @@ -0,0 +1,28 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors, unused_element + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +final myProvider = FutureProvider((ref) => 0); + +/* SNIPPET START */ +class _EagerInitialization extends ConsumerWidget { + const _EagerInitialization({required this.child}); + final Widget child; + + @override + Widget build(BuildContext context, WidgetRef ref) { + final result = ref.watch(myProvider); + + // 处理错误状态和加载状态 + if (result.isLoading) { + return const CircularProgressIndicator(); + } else if (result.hasError) { + return const Text('Oopsy!'); + } + + return child; + } +} +/* SNIPPET END */ + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart new file mode 100644 index 000000000..944e6e420 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart @@ -0,0 +1,36 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +final myProvider = Provider((ref) => 0); + +/* SNIPPET START */ +void main() { + runApp(ProviderScope(child: MyApp())); +} + +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return const _EagerInitialization( + // TODO: 在这里渲染你的 APP + child: MaterialApp(), + ); + } +} + +class _EagerInitialization extends ConsumerWidget { + const _EagerInitialization({required this.child}); + final Widget child; + + @override + Widget build(BuildContext context, WidgetRef ref) { + // 通过观察提供者程序，来初始化提供者程序。 + // 通过使用 "watch"，提供者程序将保持存活，不会被处置。 + ref.watch(myProvider); + return child; + } +} +/* SNIPPET END */ + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart new file mode 100644 index 000000000..a13c16b90 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +// 一个急切需要初始化的 provider +@riverpod +Future example(ExampleRef ref) async => 'Hello world'; + +class MyConsumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final result = ref.watch(exampleProvider); + + /// 如果提供者程序被正确的急切初始化了， + /// 那么我们可以使用 "requireValue" 直接读取数据。 + return Text(result.requireValue); + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart new file mode 100644 index 000000000..dd85f62f9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeFutureProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart new file mode 100644 index 000000000..807db346a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart @@ -0,0 +1,20 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +// 一个急切需要初始化的 provider +final exampleProvider = FutureProvider((ref) async => 'Hello world'); + +class MyConsumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final result = ref.watch(exampleProvider); + + /// 如果提供者程序被正确的急切初始化了， + /// 那么我们可以使用 "requireValue" 直接读取数据。 + return Text(result.requireValue); + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/faq.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/faq.mdx new file mode 100644 index 000000000..4c6e25e26 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/faq.mdx @@ -0,0 +1,355 @@ +--- +title: FAQ 常见问题 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; + + +以下是社区中的一些常见问题： + + +## `ref.refresh` 和 `ref.invalidate` 之间有什么不同？ + + +您可能已经注意到 `ref` 有两种方法可以强制提供者程序重新计算，并且想知道它们有何不同。 + + +它比你想象的要简单： `ref.refresh` 只是 `invalidate` + `read` 的语法糖： + +```dart +T refresh(provider) { + invalidate(provider); + return read(provider); +} +``` + + +如果您在重新计算后不关心提供者程序的新值， +那么 `invalidate` 就是正确的选择。 +如果这样做，请改用 `refresh`。 + +:::info + +该逻辑通过 lint 规则自动执行。 +如果您尝试使用 `ref.refresh` 而不使用返回值，您将收到警告。 +::: + + +行为上的主要区别在于，通过在使提供者程序失效后， +提供者程序会**立即**重新计算。 +然而，如果我们调用 `invalidate` 但没有立即读取它， +那么更新将稍后触发。 + + +“稍后”更新通常是在下一帧开始时。 +然而，如果当前被未监听的提供者程序失效， +则它在再次被监听之前都不会被更新。 + + +## 为什么 Ref 和 WidgetRef 之间没有共享接口？​ + + +Riverpod 自愿分离 `Ref` 和 `WidgetRef`。 +这样做的目的是为了避免编写有条件依赖其中之一的代码。 + + +一个问题是 `Ref` 和 `WidgetRef` 虽然看起来相似，但存在细微的差异。 +依赖于两者的代码将变得不可靠，并且难以发现。 + + +同时，依赖 `WidgetRef` 就相当于依赖 `BuildContext`。 +它实际上将您的逻辑放在 UI 层中，但不建议这样做。 + +--- + + +此类代码应重构为**始终**使用 `Ref`。 + + +此问题的解决方案通常是将您的逻辑移至 `Notifier` 中 +（请参阅 ）， +然后让您的逻辑成为该 `Notifier` 的方法。 + + +这样，当您的小部件想要调用此逻辑时，它们可以编写如下内容： + +```dart +ref.read(yourNotifierProvider.notifier).yourMethod(); +``` + + +`yourMethod` 将使用 `Notifier` 的 `Ref` 与其他提供者程序交互。 + + +## 为什么我们需要扩展 ConsumerWidget 而不是使用原始的 StatelessWidget？ + + +这是由于 `InheritedWidget` API 中的一个不幸的限制造成的。 + + +有几个问题： + + +- 无法使用 `InheritedWidget` 实现监听器的“当更改时”。 + 这意味着诸如 `ref.listen` 之类的内容不能与 `BuildContext` 一起使用。 + + `State.didChangeDependencies` 是最接近它的东西，但它并不可靠。 + 一个问题是，即使没有改变依赖关系，生命周期也可能被触发， + 特别是如果你的 widget 树使用 GlobalKeys（并且一些 Flutter widget 已经在内部这样做了）。 + + + +- 监听 `InheritedWidget` 的小部件永远不会停止监听它。 + 这通常适用于纯元数据，例如 "theme" 或 "media query"。 + + 对于业务逻辑来说，这是一个问题。 + 假设您使用提供者程序来表示分页 API。 + 当页面偏移量发生变化时，您不希望小部件继续监听先前可见的页面。 + + +- `InheritedWidget` 无法跟踪小部件何时停止监听它们。 + Riverpod 有时依赖于跟踪提供者程序是否被监听。 + + +此功能对于自动处置机制和将参数传递给提供者程序的能力至关重要。 +这些功能使 Riverpod 如此强大。 + + +也许在遥远的将来，这些问题将会得到解决。在这种情况下， +Riverpod 将迁移到使用 `BuildContext` 而不是 `Ref`。 +这将允许使用 `StatelessWidget` 而不是 `ConsumerWidget` 。 +但那是以后再说了！ + + +## 为什么 hooks_riverpod 不导出 flutter_hooks？ + + +这是为了尊重良好的版本控制实践。 + + +虽然您不能在没有 `flutter_hooks` 的情况下使用 `hooks_riverpod`， +但这两个包都是独立版本控制的。 +当其中一个可能会发生重大变化时，不会影响另一个。 + + +## 为什么 Riverpod 在某些情况下使用 `identical` 而不是 `==` 来过滤更新？​ + + +通知者程序使用 `identical` 而不是 `==` 来过滤更新。 + + +这是因为 Riverpod 用户为了实现 copyWith +而使用 Freezed/built_value 等代码生成器是很常见的。 +这些包重写 `==` 以深入比较对象。深度对象比较的成本相当高。 +“业务逻辑”模型往往具有很多属性。更糟糕的是，他们还有列表、地图等集合。 + + +同时，当使用复杂的“业务”对象时，大多数 `state = newState` 调用 +总是会产生通知（否则调用 setter 没有意义）。一般来说， +当当前状态和新状态相等时，我们调用 `state = newState` 的主要情况 +是对于原始对象（整数、枚举、字符串，但不是列表/类/...）。 +这些对象“默认被规范化”。如果这些对象是相等的， +那么它们通常也是“相同的（identical）”。 + + +因此，Riverpod 使用 `identical` 来过滤更新是一个两全其美的默认值尝试。 +对于复杂对象，我们并不真正关心过滤对象， +并且由于代码生成器默认生成 `==` 覆盖，因此 `==` 可能会很昂贵， +使用 `identical` 提供了一种通知监听器的有效方式。 +同时，对于简单对象，`identical` 确实正确过滤了冗余通知。 + + +最后且同样重要的一点是，您可以通过重写通知者程序上的方法 `updateShouldNotify` 来更改此行为。 + + +## 有没有办法一次性重置所有提供者程序 + + +不，没有办法立即重置所有提供者程序。 + + +这是故意的，因为它被认为是反模式。 +立即重置所有提供者程序通常会重置您不打算重置的提供者程序。 + + +当用户注销时想要重置应用程序状态的用户通常会询问此问题。 +如果这就是您所希望的，那么您应该将所有内容都 +通过 `ref.watch` 依赖于 "user" 提供者程序的用户状态。 + + +然后，当用户注销时，依赖于它的所有提供者程序将自动重置，但其他所有内容都将保持不变。 + + +## 我收到错误“在处理小部件后无法使用‘ref’”，这是怎么回事？​ + + +您可能还会看到 "Bad state: No ProviderScope found"，这是同一问题的较旧错误消息。 + + +当您尝试在不再安装的小部件中使用 `ref` 时，会发生此错误。这通常发生在 `await` 之后： + +```dart +ElevatedButton( + onPressed: () async { + await future; + ref.read(...); // 可能抛出 "Cannot use "ref" after the widget was disposed" + } +) +``` + + +解决方案是，与 `BuildContext` 一样，在使用 `ref` 之前检查 `mounted`： + +```dart +ElevatedButton( + onPressed: () async { + await future; + if (!context.mounted) return; + ref.read(...); // 不再抛出 + } +) +``` diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request.mdx new file mode 100644 index 000000000..490a98fbf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request.mdx @@ -0,0 +1,580 @@ +--- +title: 开始你的第一次 provider/network 请求 +pagination_prev: introduction/getting_started +version: 1 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import activity from "./first_request/activity"; +import provider from "./first_request/provider"; +import consumer from "./first_request/consumer"; +import consumerWidget from "./first_request/consumer_widget"; +import consumerStatefulWidget from "./first_request/consumer_stateful_widget"; +import hookConsumerWidget from "./first_request/hook_consumer_widget"; +import Legend from "./first_request/legend/legend"; + + +网络请求是任何应用程序的核心。但是，在发出网络请求时，需要考虑很多事项： + + +- UI 应在发出请求时呈现加载状态 +- 应妥善处理错误 +- 如果可能，应缓存请求 + + +在本节中，我们将看到 Riverpod 如何帮助我们自然地处理所有这些问题。 + + +## 配置 `ProviderScope` + + +在开始发出网络请求之前，请确保将其 `ProviderScope` 添加到应用程序的根目录。 + +```dart +void main() { + runApp( + // To install Riverpod, we need to add this widget above everything else. + // This should not be inside "MyApp" but as direct parameter to "runApp". + // 为了安装 Riverpod，我们需要将这个小组件添加到所有的小组件之上。 + // 它不应该在 “MyApp” 内部，而是作为 “runApp” 的直接参数。 + ProviderScope( + child: MyApp(), + ), + ); +} +``` + + +这样就可以为整个应用程序启用 Riverpod。 + +:::note + +有关完整的安装步骤（例如安装 [riverpod_lint](https://pub.dev/packages/riverpod_lint) +和运行代码生成器），请查看。 +::: + + +## 在 “provider” 中执行网络请求 + + +执行网络请求通常就是我们所说的“业务逻辑”。在 Riverpod 中，业务逻辑位于“providers”中。 +provider 是一种具有超能力的函数。它们的行为与正常函数类似，并具有以下额外好处： + + +- 保持缓存 +- 提供默认错误/加载处理 +- 可以被监听 +- 当某些数据发生变化时自动重新执行 + + +这使得 provider 非常适合 _GET_ 网络请求（与 _POST/etc_ 请求一样，请参阅）。 + + +举个例子，让我们做一个简单的应用程序，建议在无聊时做一个随机的活动。 +为此，我们将使用 [Bored API](https://boredapi.com/)。具体而言， +我们将在 `/api/activity` 端点上执行 _GET_ 请求。端点返回一个 JSON 对象，我们将把它解析为 Dart 类实例。 +然后，下一步是在 UI 中显示此活动。我们还将确保在发出请求时呈现加载状态，并优雅地处理错误。 + + +听起来不错？让我们开始吧！ + + +### 定义数据模型 + + +在开始之前，我们需要定义从 API 接收的数据模型。 +该模型还需要一种方法将 JSON 对象解析为 Dart 类实例。 + + +通常，建议使用 [Freezed](https://pub.dev/packages/freezed) +或 [json_serializable](https://pub.dev/packages/json_serializable) 等代码生成器来处理 JSON 解码。 +虽然但是，也可以手动完成。 + + +无论如何，这是我们的模型： + + + + +### 创建 provider + + +现在我们有了模型，可以开始创建查询 API。 +为此，我们需要创建我们的第一个 provider。 + + +定义 provider 的语法如下： + + +((ref) { + <你的逻辑写这里> +}); +`} + annotations={[ + { + offset: 6, + length: 4, + label: "provider 的变量", + description: <> + + +此变量将用于与我们的提供者程序进行交互。 +变量必须是 final 和“顶级”（global）。 + + + }, + { + offset: 13, + length: 12, + label: "provider 的类型", + description: <> + + +通常为 `Provider`、`FutureProvider` 或 `StreamProvider`。 +使用提供者程序的类型取决于函数的返回值。 +例如，要创建一个 `Future`，您需要一个 `FutureProvider`。 + + +`FutureProvider` 是你最想用的那个。 + +:::tip + +不要从“我应该选择哪个提供者程序”的角度来思考。 +相反，从“我想返回什么”的角度来思考。 +提供者程序的类型将自然而然地遵循。 +::: + + + }, + { + offset: 25, + length: 13, + label: "修饰符（可选的）", + description: <> + + +通常，在提供者程序的类型之后，您可能会看到一个“修饰符”。 +修饰符是可选的，用于以类型安全的方式调整提供者程序的行为。 + + +目前有两种修饰符可用： + + +- `autoDispose`，这将在提供者程序停止使用时自动清除缓存。 + 另请参阅 +- `family`，这可以将参数传递给提供者程序。 + 另请参阅。 + + + }, + { + offset: 48, + length: 3, + label: "Ref 引用", + description: <> + + +用于与其他 provider 交互的对象。 +所有提供者程序都有一个 `Ref`；要么作为 `provider` 函数的参数，要么作为 `Notifier` 的属性。 + + + }, + { + offset: 57, + length: 17, + label: "provider 函数", + description: <> + + +这就是我们放置提供者程序逻辑的地方。首次读取提供者程序时将调用此函数。 +后续读取不会再次调用该函数，而是返回缓存的值。 + + + }, +]} +/> + + + + +} +`} + annotations={[ + { + offset: 0, + length: 9, + label: "注解", + description: <> + + +所有提供者程序都必须使用 `@riverpod` 或 `@Riverpod()` 进行注释。 +此注释可以放置在全局函数或类上。 +通过此注释，可以配置提供者程序。 + + +例如，我们可以通过编写 `@Riverpod(keepAlive: true)` 来禁用“自动处置”（我们将在后面看到）。 + + + }, + { + offset: 17, + length: 10, + label: "带注解的函数", + description: <> + + +带批注的函数的名称决定了如何与提供者程序进行交互。 +对于给定的函数 `myFunction` ，将生成一个生成的 `myFunctionProvider` 变量。 + + +带注释的函数**必须**指定“ref”作为第一个参数。 +除此之外，该函数可以具有任意数量的参数，包括泛型。 +如果愿意，该函数也可以自由返回 `Future`/`Stream`。 + + +首次读取提供者程序时将调用此函数。 +后续读取不会再次调用该函数，而是返回缓存的值。 + + + }, + { + offset: 28, + length: 17, + label: "Ref", + description: <> + + +用于与其他提供者程序交互的对象。 +所有提供者程序都有一个 `Ref`；要么作为 `provider` 函数的参数，要么作为 `Notifier` 的属性。 +此对象的类型由函数/类的名称确定。 + + + }, +]} +/> + + + +在我们的例子中，我们希望从 API 中 _GET_ 一个活动。 +由于 _GET_ 是异步操作，这意味着我们需要创建一个 `Future`。 + + +因此，使用前面定义的语法，我们可以按如下方式定义提供者程序： + + + + +在此代码片段中，我们定义了一个名为 `activityProvider` 的提供者程序， +我们的 UI 将能够使用该提供者程序来获取随机活动。值得一提的是： + + +- 在 UI 读取提供者程序至少一次之前，不会执行网络请求。 +- 后续读取不会重新执行网络请求，而是返回之前提取的活动。 +- 如果 UI 停止使用此提供者程序，则缓存将被处置。 + 然后，如果 UI 再次使用提供者程序，则会发出新的网络请求。 +- 我们没有捕获错误。这是自动的，因为提供者程序本身会处理错误。 + 如果网络请求或 JSON 解析抛出错误，则 Riverpod 将捕获该错误。 + 然后，UI 将自动包含呈现错误页面所需的信息。 + +:::info + +提供者程序是“懒惰的”。定义提供者程序不会执行网络请求。 +相反，网络请求将在首次读取提供者程序时执行。 +::: + + +### 在 UI 中呈现网络请求的响应 + + +现在我们已经定义了一个提供者程序，我们可以开始在 UI 中使用它来显示活动。 + + +为了与提供者程序交互，我们需要一个名为“ref”的对象。 +您之前可能在提供者程序定义中看到过它，因为提供者程序自然可以访问“ref”对象。 +但在我们的例子中，我们不是提供者程序，而是小部件。那么我们如何获得“ref”呢？ + + +解决方案是使用名为 `Consumer` 的自定义小部件。 +`Consumer` 是一个类似于 `Builder` 的小部件，但还有一个额外的好处，那就是为我们提供了一个“ref”。 +这使我们的 UI 能够读取提供者程序。以下示例展示了如何使用 `Consumer`： + + + + +在该代码段中，我们使用了 `Consumer` 来读取和 `activityProvider` 显示活动。 +我们还优雅地处理了加载/错误状态。 +请注意 UI 如何能够处理加载/错误状态，而无需在提供者程序中执行任何特殊操作。 +同时，如果小部件要重建，则不会正确地重新执行网络请求。 +其他小部件也可以访问同一提供者程序，而无需重新执行网络请求。 + +:::info + +小部件可以根据需要，监听任意数量的提供者程序。为此，只需添加更多 ref.watch 调用即可。 +::: + +:::tip + +确保安装 linter。这将使您的 IDE 能够提供重构选项， +以自动添加 `Consumer` 或将 `StatelessWidget` 重构为 `ConsumerWidget`。 + + +有关安装步骤，请参阅。 +::: + + +## 更进一步：使用 `ConsumerWidget` 替代 `Consumer` 删除代码缩进。 + + +在前面的示例中，我们使用 `Consumer` 来读取提供者程序。 +尽管这种方法没有错，但添加的缩进会使代码更难阅读。 + + +Riverpod 提供了另一种实现相同结果的方法： +我们可以定义 `ConsumerWidget` / `ConsumerStatefulWidget` 来代替在 +`StatelessWidget` / `StatefulWidget` 返回 `Consumer` 小组件。 +`ConsumerWidget` 和 `ConsumerStatefulWidget` 实际上是 `StatelessWidget` / `StatefulWidget` 和 `Consumer` 的融合。 +它们的行为与原来的 couterpart 相同，但具有提供“ref”的额外好处。 + + +我们可以使用 `ConsumerWidget` 重写前面的例子，如下所示： + + + + +至于 `ConsumerStatefulWidget`，我们会这样写： + + + + +### Flutter_hooks 注意事项：结合 `HookWidget` 和 `ConsumerWidget` + +:::caution + +如果您以前从未听说过“钩子（hooks）”，请随时跳过本节。 +[Flutter_hooks](https://pub.dev/packages/flutter_hooks) 是一个独立于 Riverpod 的软件包， +但经常与 Riverpod 一起使用。如果您不熟悉 Riverpod，不建议使用“钩子”。 +有关详细信息，请参阅。 +::: + + +如果您正在使用 `flutter_hooks`，您可能想知道如何将 `ConsumerWidget` +和 `HookWidget` 组合在一起。毕竟，两者都涉及更改扩展的小部件类。 + + +Riverpod 为此问题提供了解决方案：`HookConsumerWidget` 和 `StatefulHookConsumerWidget`。 +类似于 `ConsumerWidget` 和 `ConsumerStatefulWidget` 是 `StatelessWidget` / `StatefulWidget` 和 `Consumer` 融合， +`HookConsumerWidget` 和 `StatefulHookConsumerWidget` 是 `HookWidget` / `HookStatefulWidget` 和 `Consumer` 的融合。 +因此，它们允许在同一个小部件中同时使用钩子和提供者程序。 + + +为了展示这一点，我们可以再次重写前面的例子： + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts new file mode 100644 index 000000000..5cea035c7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/activity.dart"; +import codegen from "!!raw-loader!./codegen/activity.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart new file mode 100644 index 000000000..01cdb97f0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart @@ -0,0 +1,23 @@ +/* SNIPPET START */ import 'package:freezed_annotation/freezed_annotation.dart'; + +part 'activity.freezed.dart'; +part 'activity.g.dart'; + +/// `GET /api/activity` 请求的响应。 +/// +/// 这个定义使用了 `freezed` 和 `json_serializable`。 +@freezed +class Activity with _$Activity { + factory Activity({ + required String key, + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + /// 将 JSON 对象转换为 [Activity] 实例。 + /// 这可以实现 API 响应的类型安全读取。 + factory Activity.fromJson(Map json) => + _$ActivityFromJson(json); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart new file mode 100644 index 000000000..6ffa343c1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart @@ -0,0 +1,237 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'activity.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get key => throw _privateConstructorUsedError; + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call( + {String key, + String activity, + String type, + int participants, + double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? key = null, + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + key: null == key + ? _value.key + : key // ignore: cast_nullable_to_non_nullable + as String, + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call( + {String key, + String activity, + String type, + int participants, + double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? key = null, + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + key: null == key + ? _value.key + : key // ignore: cast_nullable_to_non_nullable + as String, + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.key, + required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String key; + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(key: $key, activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.key, key) || other.key == key) && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, key, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String key, + required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get key; + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart new file mode 100644 index 000000000..55a7a5383 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'activity.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + key: json['key'] as String, + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'key': instance.key, + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart new file mode 100644 index 000000000..0f70b54f6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart @@ -0,0 +1,19 @@ +/* SNIPPET START */ import 'dart:convert'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'activity.dart'; + +// 代码生成正常工作的必要条件 +part 'provider.g.dart'; + +/// 这将创建一个名为 `activityProvider` 的提供者程序 +/// 它可以缓存函数执行的结果 +@riverpod +Future activity(ActivityRef ref) async { + // 使用 package:http, 我们可以从 Bored API 获取一个随机的活动。 + final response = await http.get(Uri.https('boredapi.com', '/api/activity')); + // 使用 dart:convert, 然后我们将 JSON 有效负载解码为 Map 数据结构。 + final json = jsonDecode(response.body) as Map; + // 最后，我们将 Map 转换为 Activity 实例。 + return Activity.fromJson(json); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart new file mode 100644 index 000000000..0bbaaf4ae --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart @@ -0,0 +1,29 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'636cd5510e09cbfc46f31b74a70d9e98c89e95a4'; + +/// 这将创建一个名为 `activityProvider` 的提供者程序 +/// 它可以缓存函数执行的结果 +/// +/// Copied from [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts new file mode 100644 index 000000000..a625b7073 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/consumer.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts new file mode 100644 index 000000000..5e6ac973a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/consumer_stateful_widget.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts new file mode 100644 index 000000000..56cb2331d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/consumer_widget.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts new file mode 100644 index 000000000..300ec6596 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/hook_consumer_widget.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss new file mode 100644 index 000000000..bda077971 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss @@ -0,0 +1,18 @@ +.legend { + table, + td, + tr { + background: none !important; + border: none; + + vertical-align: top; + } + + td:first-child { + text-align: end; + } + + tr + tr { + border-top: solid 0.5px; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx new file mode 100644 index 000000000..048817ec0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx @@ -0,0 +1,88 @@ +import React from "react"; +import PropTypes from "prop-types"; +import CodeBlock from "@theme/CodeBlock"; +import "./DocuCode.scss"; + +type AnnotatedCode = { + color?: string; + code: string; +}; + +export const colors = [ + "#2196f3", + "#4caf50", + "#f44336", + "#ff9800", + "#009688", + "#e91e63", + "#00bcd4", + "#8bc34a", +]; + +const Legend = ({ annotations, code }) => { + const fullAnnotations = new Array(); + + let annotationOffset = 0; + for (var codeOffset = 0; codeOffset < code.length; ) { + if (annotationOffset >= annotations.length) { + // Out of annotations, just add the rest of the code + fullAnnotations.push({ code: code.substring(codeOffset) }); + break; + } + + const annotation = annotations[annotationOffset]; + if (codeOffset < annotation.offset) { + /// There is an unannotated gap between the last annotation and this one. + const codeLength = annotation.offset - codeOffset; + fullAnnotations.push({ + code: code.substring(codeOffset, codeOffset + codeLength), + }); + codeOffset += codeLength; + } + + if (annotation.offset >= code.length) { + throw new Error("Annotation offset out of bounds"); + } + + annotationOffset++; + codeOffset = annotation.offset + annotation.length; + fullAnnotations.push({ + color: colors[annotationOffset - 1], + code: code.substring( + annotation.offset, + annotation.offset + annotation.length + ), + }); + } + + return ( +
+ 
+        {fullAnnotations.map(({ code, color }) => {
+          let underlineClass = color ? `underline` : "";
+          let style = color ? { color: color } : undefined;
+
+          return (
+            
+              {code}
+            
+          );
+        })}
+
+ + + {annotations.map((annotation, index) => ( + + + + + ))} + +
+ {annotation.label} + {annotation.description}
+
+ ); +}; + +export default Legend; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts new file mode 100644 index 000000000..42ce35bff --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/provider.dart"; +import codegen from "!!raw-loader!./codegen/provider.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart new file mode 100644 index 000000000..c37aa2051 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart @@ -0,0 +1,28 @@ +/* SNIPPET START */ /// `GET /api/activity` 请求的响应。 +class Activity { + Activity({ + required this.key, + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + /// 将 JSON 对象转换为 [Activity] 实例。 + /// 这可以实现 API 响应的类型安全读取。 + factory Activity.fromJson(Map json) { + return Activity( + key: json['key'] as String, + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: json['price'] as double, + ); + } + + final String key; + final String activity; + final String type; + final int participants; + final double price; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart new file mode 100644 index 000000000..97a06178b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart @@ -0,0 +1,39 @@ +// ignore_for_file: omit_local_variable_types + +/* SNIPPET START */ import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/// 我们应用程序主页 +class Home extends StatelessWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context) { + return Consumer( + builder: (context, ref, child) { + // 读取 activityProvider。如果没有准备开始，这将会开始一个网络请求。 + // 通过使用 ref.watch，小组件将会在 activityProvider 更新时重建。 + // 当下面的事情发生时，会更新小组件： + // - 响应从“正在加载”变为“数据/错误” + // - 请求重刷新 + // - 结果被本地修改（例如执行副作用时） + // ... + final AsyncValue activity = ref.watch(activityProvider); + + return Center( + /// 由于网络请求是异步的并且可能会失败，我们需要处理错误和加载的状态。 + /// 我们可以为此使用模式匹配。 + /// 我们也可以使用 `if (activity.isLoading) { ... } else if (...)` + child: switch (activity) { + AsyncData(:final value) => Text('Activity: ${value.activity}'), + AsyncError() => const Text('Oops, something unexpected happened'), + _ => const CircularProgressIndicator(), + }, + ); + }, + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart new file mode 100644 index 000000000..ee427a42a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart @@ -0,0 +1,42 @@ +// ignore_for_file: omit_local_variable_types, prefer_const_constructors, unused_local_variable, todo + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/* SNIPPET START */ // 我们扩展了 ConsumerStatefulWidget。 +// 这等效于 "Consumer" + "StatefulWidget". +class Home extends ConsumerStatefulWidget { + const Home({super.key}); + + @override + ConsumerState createState() => _HomeState(); +} + +// 请注意，我们如何扩展“ConsumerState”而不是“State”。 +// 这和 "ConsumerWidget" 与 "StatelessWidget" 是相同的原理。 +class _HomeState extends ConsumerState { + @override + void initState() { + super.initState(); + + // 状态生命周期也可以访问“ref”。 + // 这使得在特定提供者程序上添加监听器，以便实现显示对话框/信息栏等功能。 + ref.listenManual(activityProvider, (previous, next) { + // TODO 显示一个 snackbar/dialog + }); + } + + @override + Widget build(BuildContext context) { + // "ref" is not passed as parameter anymore, but is instead a property of "ConsumerState". + // We can therefore keep using "ref.watch" inside "build". + // “ref”不再作为参数传递，而是作为“ConsumerState”的属性。 + // 因此，我们可以继续在“build”中使用“ref.watch”。 + final AsyncValue activity = ref.watch(activityProvider); + + return Center(/* ... */); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart new file mode 100644 index 000000000..30d5a232e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart @@ -0,0 +1,23 @@ +// ignore_for_file: omit_local_variable_types, prefer_const_constructors, unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/* SNIPPET START */ /// 我们将“ConsumerWidget”替代“StatelessWidget”进行子类化。 +/// 这相当于使用“StatelessWidget”并返回“Consumer”小组件。 +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + // 请注意“build”现在如何接收一个额外的参数：“ref” + Widget build(BuildContext context, WidgetRef ref) { + // 我们可以像使用“Consumer”一样，在小部件中使用“ref.watch” + final AsyncValue activity = ref.watch(activityProvider); + + // 渲染逻辑保持不变 + return Center(/* ... */); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart new file mode 100644 index 000000000..8f5a8473e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart @@ -0,0 +1,26 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_const_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/* SNIPPET START */ /// 我们子类化了 "HookConsumerWidget"。 +/// 这同时组合了 "StatelessWidget"、"Consumer"、"HookWidget"。 +class Home extends HookConsumerWidget { + const Home({super.key}); + + @override + // 请注意“build”现在如何接收一个额外的参数：“ref” + Widget build(BuildContext context, WidgetRef ref) { + // 可以在我们的小部件中使用诸如“useState”之类的钩子 + final counter = useState(0); + + // 我们还可以使用读取提供者程序 + final AsyncValue activity = ref.watch(activityProvider); + + return Center(/* ... */); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart new file mode 100644 index 000000000..f417a5860 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart @@ -0,0 +1,13 @@ +/* SNIPPET START */ import 'dart:convert'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; +import 'activity.dart'; + +final activityProvider = FutureProvider.autoDispose((ref) async { + // 使用 package:http, 我们可以从 Bored API 获取一个随机的活动。 + final response = await http.get(Uri.https('boredapi.com', '/api/activity')); + // 使用 dart:convert, 然后我们将 JSON 有效负载解码为 Map 数据结构。 + final json = jsonDecode(response.body) as Map; + // 最后，我们将 Map 转换为 Activity 实例。 + return Activity.fromJson(json); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx new file mode 100644 index 000000000..0f21cdd8e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx @@ -0,0 +1,265 @@ +--- +title: 将参数传递给您的请求 +version: 1 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import noArgProvider from "./passing_args/no_arg_provider"; +import family from "!!raw-loader!./passing_args/raw/family.dart"; +import codegenFamily from "!!raw-loader!./passing_args/codegen/family.dart"; +import consumerProvider from "!!raw-loader!./passing_args/raw/consumer_provider.dart"; +import consumerFamily from "!!raw-loader!./passing_args/raw/consumer_family.dart"; +import consumerListFamily from "!!raw-loader!./passing_args/raw/consumer_list_family.dart"; +import multipleConsumerFamily from "!!raw-loader!./passing_args/raw/multiple_consumer_family.dart"; +import tupleFamily from "!!raw-loader!./passing_args/raw/tuple_family.dart"; +import consumerTupleFamily from "!!raw-loader!./passing_args/raw/consumer_tuple_family.dart"; + + +在上一篇文章中，我们看到了如何定义一个“provider”来发出一个简单的 _GET_ HTTP 请求。 +但通常，HTTP 请求依赖于外部参数。 + + +例如，以前我们使用 [Bored API](https://boredapi.com/) 向用户推荐随机活动。 +但也许用户想要过滤他们想做的活动类型，或者有价格要求，等等…… +这些参数事先是未知的。因此，我们需要一种方法将这些参数 +从我们的 UI 传递到我们的提供者程序。 + + +## 更新我们的提供者程序以接受参数 + + +提醒一下，以前我们是这样定义我们的提供者程序的： + + + + + + +当不依赖于代码生成时，我们需要稍微调整定义提供者程序的语法，以支持传递参数。 +这是通过依靠称为“family”的“修饰符”来完成的。 + + +简而言之，我们需要在提供者程序的类型之后添加 `.family` 一个额外的类型参数， +以及与参数类型相对应的类型参数。 +例如，我们可以更新提供者程序以接受与所需活动类型相对应的 String 参数： + + + + + + + + +要将参数传递给我们的提供者程序，我们只需在带注解的函数本身上添加参数即可。 +例如，我们可以更新提供者程序以接受与所需活动类型相对应的 `String` 参数： + + + + + +:::caution + +将参数传递给提供者程序时，强烈建议在提供者程序上启用“autoDispose”。 +否则可能会导致内存泄漏。 +有关详细信息，请参阅。 +::: + + +## 更新我们的 UI 以传递参数 + + +以前，小部件是这样消费我们的提供者程序的： + + + + +但是现在我们的提供者程序收到参数，使用它的语法略有不同。 +提供者程序现在是一个函数，需要使用请求的参数来调用它。 +我们可以更新我们的 UI 以传递硬编码类型的活动，如下所示： + + + + + + +传递给提供者程序的参数对应于带注解的函数的参数，减去“ref”参数。 + + + +:::info + +完全可以同时监听具有不同参数的同一提供者程序。 +例如，我们的 UI 可以同时呈现“娱乐（recreational）”_和_“烹饪（cooking）”活动： + + + + + + +这就是修饰符被称为“family”的原因： +因为把参数传递给提供者程序（译者注：作为不同状态的区分的 key 值）， +可以有效地将提供者程序转换为一组具有相同逻辑的状态。 + + +::: + + +## 缓存注意事项和参数限制 + + +将参数传递给提供者程序时，仍会缓存计算。 +不同之处在于，计算现在是按参数缓存的。 + + +这意味着，如果两个小部件使用具有相同参数的同一提供者程序，则只会发出单个网络请求。 +但是，如果两个小部件使用具有不同参数的同一提供者程序，则将发出两个网络请求。 + + +为此，Riverpod 依赖于参数的 `==` 运算符。 +因此，传递给提供者程序的参数必须具有一致的相等性，这一点很重要。 + +:::caution + +一个常见的错误是直接实例化一个新对象作为提供者程序的参数，但该对象没有重写 `==`。 +例如，您可能很想去这样使用 `List`： + + + + +此代码的问题在于 `['recreational', 'cooking'] == ['recreational', 'cooking']` 的结果是 `false`。 +因此，Riverpod 将认为这两个参数不同，并尝试发出新的网络请求。 +这将导致网络请求的无限循环，一直向用户显示进度指示器。 + + +要解决此问题，您可以使用 `const` 列表 (`const ['recreational', 'cooking']`) +或使用重写了 `==` 的自定义列表实现。 + + +为了帮助发现此错误，建议使用 [riverpod_lint](https://pub.dev/packages/riverpod_lint) +并启用 [provider_parameters](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint#provider_parameters) +的 lint 规则。这样做之后，上面的代码片段将显示警告。 +有关安装步骤，请参阅。 +::: + + + + +考虑到这一点，您可能想知道如何将多个参数传递给提供者程序。 +建议的解决方案是： + + +- 切换到代码生成，这样可以传递任意数量的参数 +- 使用 Dart 3 的记录 (record) 语法 + + +Dart 3 的记录之所以派上用场，是因为它们自然覆盖 `==` 并具有方便的语法。 +例如，我们可以更新我们的提供者程序，以同时接受一种活动类型和最高价格： + + + + +然后，我们可以像这样消费这个提供者程序： + + + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart new file mode 100644 index 000000000..7d5c4c260 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart @@ -0,0 +1,29 @@ +import 'dart:convert'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import '../../first_request/codegen/activity.dart'; + +part 'family.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity( + ActivityRef ref, + // 我们可以向提供者程序添加参数。 + // 参数的类型可以是您想要的任何类型。 + String activityType, +) async { + // 我们可以使用“activityType”参数来构建 URL。 + // 这将指向 "https://boredapi.com/api/activity?type=" + final response = await http.get( + Uri( + scheme: 'https', + host: 'boredapi.com', + path: '/api/activity', + // 无需手动编码查询参数，“Uri”类为我们完成了这一工作。 + queryParameters: {'type': activityType}, + ), + ); + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart new file mode 100644 index 000000000..c88a2122c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart @@ -0,0 +1,200 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'cb76e67cd45f1823d3ed497a235be53819ce2eaf'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [activity]. +@ProviderFor(activity) +const activityProvider = ActivityFamily(); + +/// See also [activity]. +class ActivityFamily extends Family { + /// See also [activity]. + const ActivityFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'activityProvider'; + + /// See also [activity]. + ActivityProvider call( + String activityType, + ) { + return ActivityProvider( + activityType, + ); + } + + @visibleForOverriding + @override + ActivityProvider getProviderOverride( + covariant ActivityProvider provider, + ) { + return call( + provider.activityType, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(FutureOr Function(ActivityRef ref) create) { + return _$ActivityFamilyOverride(this, create); + } +} + +class _$ActivityFamilyOverride implements FamilyOverride { + _$ActivityFamilyOverride(this.overriddenFamily, this.create); + + final FutureOr Function(ActivityRef ref) create; + + @override + final ActivityFamily overriddenFamily; + + @override + ActivityProvider getProviderOverride( + covariant ActivityProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [activity]. +class ActivityProvider extends AutoDisposeFutureProvider { + /// See also [activity]. + ActivityProvider( + String activityType, + ) : this._internal( + (ref) => activity( + ref as ActivityRef, + activityType, + ), + from: activityProvider, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$activityHash, + dependencies: ActivityFamily._dependencies, + allTransitiveDependencies: ActivityFamily._allTransitiveDependencies, + activityType: activityType, + ); + + ActivityProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.activityType, + }) : super.internal(); + + final String activityType; + + @override + Override overrideWith( + FutureOr Function(ActivityRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: ActivityProvider._internal( + (ref) => create(ref as ActivityRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + activityType: activityType, + ), + ); + } + + @override + (String,) get argument { + return (activityType,); + } + + @override + AutoDisposeFutureProviderElement createElement() { + return _ActivityProviderElement(this); + } + + ActivityProvider _copyWith( + FutureOr Function(ActivityRef ref) create, + ) { + return ActivityProvider._internal( + (ref) => create(ref as ActivityRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + activityType: activityType, + ); + } + + @override + bool operator ==(Object other) { + return other is ActivityProvider && other.activityType == activityType; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, activityType.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin ActivityRef on AutoDisposeFutureProviderRef { + /// The parameter `activityType` of this provider. + String get activityType; +} + +class _ActivityProviderElement + extends AutoDisposeFutureProviderElement with ActivityRef { + _ActivityProviderElement(super.provider); + + @override + String get activityType => (origin as ActivityProvider).activityType; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart new file mode 100644 index 000000000..d2cd2b635 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart @@ -0,0 +1,32 @@ +// ignore_for_file: avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import '../../first_request/codegen/activity.dart'; + +// Necessary for code-generation to work +part 'provider.g.dart'; + +FutureOr fetchActivity() => throw UnimplementedError(); + +/* SNIPPET START */ +// “函数型”提供者程序 +@riverpod +Future activity(ActivityRef ref) async { + // TODO: 执行网络请求以获取活动 + return fetchActivity(); +} + +// 或者替代方案，“通知者程序” +@riverpod +class ActivityNotifier2 extends _$ActivityNotifier2 { + /// 通知者程序参数在构建方法上指定。 + /// 可以有任意数量的通知者程序参数，可以是任意的变量名称，甚至可以是可选/命名的参数。 + @override + Future build(String activityType) async { + // 参数也可通过 "this." 使用 + print(this.activityType); + + // TODO: 执行网络请求以获取活动 + return fetchActivity(); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart new file mode 100644 index 000000000..7b8a4fd90 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart @@ -0,0 +1,232 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$activityHash() => r'2f9496c5d70de9314c67e5c48ac44d8b149bc471'; + +/// See also [activity]. +@ProviderFor(activity) +final activityProvider = AutoDisposeFutureProvider.internal( + activity, + name: r'activityProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$activityHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ActivityRef = AutoDisposeFutureProviderRef; +String _$activityNotifier2Hash() => r'9e67c655d53a9f98c3b012a0534421385dde0339'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +abstract class _$ActivityNotifier2 + extends BuildlessAutoDisposeAsyncNotifier { + late final String activityType; + + FutureOr build( + String activityType, + ); +} + +/// See also [ActivityNotifier2]. +@ProviderFor(ActivityNotifier2) +const activityNotifier2Provider = ActivityNotifier2Family(); + +/// See also [ActivityNotifier2]. +class ActivityNotifier2Family extends Family { + /// See also [ActivityNotifier2]. + const ActivityNotifier2Family(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'activityNotifier2Provider'; + + /// See also [ActivityNotifier2]. + ActivityNotifier2Provider call( + String activityType, + ) { + return ActivityNotifier2Provider( + activityType, + ); + } + + @visibleForOverriding + @override + ActivityNotifier2Provider getProviderOverride( + covariant ActivityNotifier2Provider provider, + ) { + return call( + provider.activityType, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(ActivityNotifier2 Function() create) { + return _$ActivityNotifier2FamilyOverride(this, create); + } +} + +class _$ActivityNotifier2FamilyOverride implements FamilyOverride { + _$ActivityNotifier2FamilyOverride(this.overriddenFamily, this.create); + + final ActivityNotifier2 Function() create; + + @override + final ActivityNotifier2Family overriddenFamily; + + @override + ActivityNotifier2Provider getProviderOverride( + covariant ActivityNotifier2Provider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [ActivityNotifier2]. +class ActivityNotifier2Provider + extends AutoDisposeAsyncNotifierProviderImpl { + /// See also [ActivityNotifier2]. + ActivityNotifier2Provider( + String activityType, + ) : this._internal( + () => ActivityNotifier2()..activityType = activityType, + from: activityNotifier2Provider, + name: r'activityNotifier2Provider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$activityNotifier2Hash, + dependencies: ActivityNotifier2Family._dependencies, + allTransitiveDependencies: + ActivityNotifier2Family._allTransitiveDependencies, + activityType: activityType, + ); + + ActivityNotifier2Provider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.activityType, + }) : super.internal(); + + final String activityType; + + @override + FutureOr runNotifierBuild( + covariant ActivityNotifier2 notifier, + ) { + return notifier.build( + activityType, + ); + } + + @override + Override overrideWith(ActivityNotifier2 Function() create) { + return ProviderOverride( + origin: this, + override: ActivityNotifier2Provider._internal( + () => create()..activityType = activityType, + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + activityType: activityType, + ), + ); + } + + @override + (String,) get argument { + return (activityType,); + } + + @override + AutoDisposeAsyncNotifierProviderElement + createElement() { + return _ActivityNotifier2ProviderElement(this); + } + + ActivityNotifier2Provider _copyWith( + ActivityNotifier2 Function() create, + ) { + return ActivityNotifier2Provider._internal( + () => create()..activityType = activityType, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + activityType: activityType, + ); + } + + @override + bool operator ==(Object other) { + return other is ActivityNotifier2Provider && + other.activityType == activityType; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, activityType.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin ActivityNotifier2Ref on AutoDisposeAsyncNotifierProviderRef { + /// The parameter `activityType` of this provider. + String get activityType; +} + +class _ActivityNotifier2ProviderElement + extends AutoDisposeAsyncNotifierProviderElement + with ActivityNotifier2Ref { + _ActivityNotifier2ProviderElement(super.provider); + + @override + String get activityType => (origin as ActivityNotifier2Provider).activityType; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts new file mode 100644 index 000000000..42ce35bff --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/provider.dart"; +import codegen from "!!raw-loader!./codegen/provider.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart new file mode 100644 index 000000000..96c6fcec7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart @@ -0,0 +1,24 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../../first_request/raw/activity.dart'; +import 'family.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + AsyncValue activity = ref.watch( + // 提供者程序现在是一个需要活动类型的函数。 + // 为了简单起见，我们现在传递一个常量字符串。 + activityProvider('recreational'), + ); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart new file mode 100644 index 000000000..64433d625 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart @@ -0,0 +1,23 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +final activityProvider = Provider.family((ref, id) { + throw UnimplementedError(); +}); + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + // 我们可以更新 ActivityProvider 接受字符串列表以替换之前的代码。 + // 然后尝试直接在 watch 调用中创建该列表。 + ref.watch(activityProvider(['recreational', 'cooking'])); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart new file mode 100644 index 000000000..337eab2d1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart @@ -0,0 +1,20 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../../first_request/raw/activity.dart'; +import 'provider.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + AsyncValue activity = ref.watch(activityProvider); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart new file mode 100644 index 000000000..b63149bde --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart @@ -0,0 +1,23 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'tuple_family.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + ref.watch( + // 使用记录，我们可以传递参数。 + // 在 watch 调用中，可以实现直接创建带有覆盖 == 功能的记录。 + activityProvider((type: 'recreational', maxPrice: 40)), + ); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart new file mode 100644 index 000000000..7eb1af657 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart @@ -0,0 +1,42 @@ +// ignore_for_file: unnecessary_this, avoid_print + +import 'dart:async'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import '../../first_request/raw/activity.dart'; + +FutureOr fetchActivity(String activityType) => + throw UnimplementedError(); + +/* SNIPPET START */ +// “函数型”提供者 +final activityProvider = FutureProvider.autoDispose + // 我们使用 ".family" 修饰符。 + // 泛型类型 "String" 对应于参数的类型。 + // 我们的提供者程序现在在 "ref" 上收到一个额外的参数：activity 的类型。 + .family((ref, activityType) async { + // TODO: 使用 "activityType" 执行网络请求以获取活动 + return fetchActivity(activityType); +}); + +// “通知者程序”的提供者 +final activityProvider2 = AsyncNotifierProvider.autoDispose + // 再次，我们使用 ".family" 修饰符，并将参数指定为 "String" 类型。 + .family( + ActivityNotifier.new, +); + +// 当将 ".family" 与通知者程序一起使用时，我们需要更改通知者程序子类： +// AsyncNotifier -> FamilyAsyncNotifier +// AutoDisposeAsyncNotifier -> AutoDisposeFamilyAsyncNotifier +class ActivityNotifier + extends AutoDisposeFamilyAsyncNotifier { + /// Family 参数传递给构建方法并可通过 this.arg 访问 + @override + Future build(String activityType) async { + // 参数也可通过 "this.arg" 使用 + print(this.arg); + + // TODO: 执行网络请求以获取活动 + return fetchActivity(activityType); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart new file mode 100644 index 000000000..68c9620db --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart @@ -0,0 +1,37 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../../first_request/raw/activity.dart'; +import 'family.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + AsyncValue activity = ref.watch( + // The provider is now a function expecting the activity type. + // Let's pass a constant string for now, for the sake of simplicity. + activityProvider('recreational'), + ); + /* SNIPPET START */ + return Consumer( + builder: (context, ref, child) { + final recreational = ref.watch(activityProvider('recreational')); + final cooking = ref.watch(activityProvider('cooking')); + + // 然后我们可以同时渲染这两个活动。 + // 两个请求将并行发生并正确缓存。 + return Column( + children: [ + Text(recreational.valueOrNull?.activity ?? ''), + Text(cooking.valueOrNull?.activity ?? ''), + ], + ); + }, + ); + /* SNIPPET END */ + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart new file mode 100644 index 000000000..0c4806b47 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart @@ -0,0 +1,26 @@ +import 'dart:async'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import '../../first_request/raw/activity.dart'; + +/* SNIPPET START */ + +FutureOr fetchActivity() => throw UnimplementedError(); + +// “函数型”提供者程序 +final activityProvider = FutureProvider.autoDispose((ref) async { + // TODO: 执行网络请求以获取活动 + return fetchActivity(); +}); + +// 或者替代方案，“通知者程序” +final activityProvider2 = AsyncNotifierProvider( + ActivityNotifier.new, +); + +class ActivityNotifier extends AsyncNotifier { + @override + Future build() async { + // TODO: 执行网络请求以获取活动 + return fetchActivity(); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart new file mode 100644 index 000000000..aa9b4476a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart @@ -0,0 +1,32 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import '../../first_request/raw/activity.dart'; + +/* SNIPPET START */ +// 我们定义一条记录，表示我们想要传递给提供者程序的参数。 +// 创建 typedef 是可选的，但可以使代码更具可读性。 +typedef ActivityParameters = ({String type, int maxPrice}); + +final activityProvider = FutureProvider.autoDispose + // 我们现在使用新定义的记录作为参数类型。 + .family((ref, arguments) async { + final response = await http.get( + Uri( + scheme: 'https', + host: 'boredapi.com', + path: '/api/activity', + queryParameters: { + // 最后，我们可以使用参数来更新请求的查询参数。 + 'type': arguments.type, + 'price': arguments.maxPrice, + }, + ), + ); + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx new file mode 100644 index 000000000..ff240d37f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx @@ -0,0 +1,79 @@ +--- +title: 日志和错误报告 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import providerObserver from "!!raw-loader!./provider_observer/provider_observer.dart"; + + +Riverpod 本身提供了一种监听提供者程序树中发生的所有事件的方法。 +这可用于记录所有事件，或向远程服务报告错误。 + + +这是通过使用 `ProviderObserver` 类并将其传递给 +`ProviderScope`/`ProviderContainer` 来实现的。 + + +## 定义 ProviderObserver ​ + + +ProviderObserver 是一个应该被扩展的类。 +它提供了各种可以重写的方法来监听事件： + + +- `didAddProvider`，当提供者程序被添加到组件树时调用 +- `didUpdateProvider`，当提供者程序更新时调用 +- `didDisposeProvider`，当提供者程序被处置时调用 +- `providerDidFail`，当同步的提供者程序抛出错误时 + + + + +## 使用 ProviderObserver​ + + +现在我们已经定义了观察者，我们需要使用它。 +为此，我们应该将其传递给 `ProviderScope` 或 `ProviderContainer` ： + +```dart +runApp( + ProviderScope( + observers: [ + MyObserver(), + ], + child: MyApp(), + ) +); +``` + +```dart +final container = ProviderContainer( + observers: [ + MyObserver(), + ], +); +``` diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart new file mode 100644 index 000000000..dd75afb01 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart @@ -0,0 +1,43 @@ +// ignore_for_file: avoid_print + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class MyObserver extends ProviderObserver { + @override + void didAddProvider( + ProviderBase provider, + Object? value, + ProviderContainer container, + ) { + print('Provider $provider was initialized with $value'); + } + + @override + void didDisposeProvider( + ProviderBase provider, + ProviderContainer container, + ) { + print('Provider $provider was disposed'); + } + + @override + void didUpdateProvider( + ProviderBase provider, + Object? previousValue, + Object? newValue, + ProviderContainer container, + ) { + print('Provider $provider updated from $previousValue to $newValue'); + } + + @override + void providerDidFail( + ProviderBase provider, + Object error, + StackTrace stackTrace, + ProviderContainer container, + ) { + print('Provider $provider threw $error at $stackTrace'); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx new file mode 100644 index 000000000..9f76dcae9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx @@ -0,0 +1,668 @@ +--- +title: 执行副作用 +version: 1 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import Legend, { colors } from "./first_request/legend/legend"; +import todoListProvider from "./side_effects/todo_list_provider"; +import todoListNotifier from "./side_effects/todo_list_notifier"; +import todoListNotifierAddTodo from "./side_effects/todo_list_notifier_add_todo"; +import consumerAddTodoCall from "!!raw-loader!./side_effects/raw/consumer_add_todo_call.dart"; +import restAddTodo from "!!raw-loader!./side_effects/raw/rest_add_todo.dart"; +import invalidateSelfAddTodo from "!!raw-loader!./side_effects/raw/invalidate_self_add_todo.dart"; +import manualAddTodo from "!!raw-loader!./side_effects/raw/manual_add_todo.dart"; +import mutableManualAddTodo from "!!raw-loader!./side_effects/raw/mutable_manual_add_todo.dart"; +import renderAddTodo from "./side_effects/render_add_todo"; + + +到目前为止，我们只看到了如何获取数据（也就是执行 _GET_ HTTP 请求）。 +但是副作用（例如 _POST_ 请求）呢？ + + +应用程序通常实现 CRUD（创建、读取、更新、删除）API。 +执行此操作时，更新请求（通常是 _POST_）通常还应更新本地缓存，以使 UI 反映新状态。 + + +问题是，我们如何从消费者程序内部更新提供者程序的状态？ +理所当然的，提供者程序不会公开修改其状态的方法。 +这是设计使然，以确保仅以受控方式修改状态并促进关注点分离。 +相反，提供者程序必须显式公开修改其状态的方法。 + + +为此，我们将使用一个新概念：通知者程序（Notifiers）。 +为了展示这个新概念，让我们使用一个更高级的例子：待办事项列表。 + + +## 定义通知者程序 + + +让我们从此时我们已经知道的内容开始：一个简单的 GET 请求。 +正如之前在中看到的那样， +我们可以通过编写以下内容来获取待办事项列表： + + + + +现在我们已经获取了待办事项列表，让我们看看如何添加新的待办事项。 +为此，我们需要修改我们的提供者程序，以便它们公开一个公共 API 来修改其状态。 +这是通过将我们的提供者程序转换为我们所说的“通知者程序”来完成的。 + + +通知者程序是提供者程序的“有状态小部件”。它们需要对定义提供者程序的语法稍作调整。 +此新语法如下： + + +(MyNotifier.new); + +class MyNotifier extends SomeNotifier { + @override + Result build() { + <你的业务逻辑在这里> + } + + <你的方法在这里> +}`} + annotations={[ + { + offset: 6, + length: 4, + label: "提供者程序变量", + description: <> + + +此变量将用于与我们的提供者程序进行交互。 +变量必须是 final 和“顶级”（全局）。 + + + }, + { + offset: 13, + length: 20, + label: "提供者程序类型", + description: <> + + +通常为 `NotifierProvider`、`AsyncNotifierProvider` 和 `StreamNotifierProvider`。 +使用的提供者程序类型取决于函数的返回值。 +例如，要创建一个 `Future` ，您需要一个 `AsyncNotifierProvider`。 + + +`AsyncNotifierProvider` 是你最想用的那个。 + +:::tip + +不要从“我应该选择哪个提供者程序”的角度来思考。 +相反，从“我想返回什么”的角度来思考。提供者程序类型将自然而然地遵循。 +::: + + + }, + { + offset: 33, + length: 13, + label: "修饰符（可选的）", + description: <> + + +通常，在提供者程序的类型之后，您可能会看到一个“修饰符”。 +修饰符是可选的，用于以类型安全的方式调整提供者程序的行为。 + + +目前有两种修饰符可用： + + +- `autoDispose`，这将在提供者程序停止使用时自动清除缓存。 + 另请参阅 +- `family`，这样就可以将参数传递给提供者程序。 + 另请参阅 + + + }, + { + offset: 67, + length: 14, + label: "通知者程序的构造函数", + description: <> + + +“notifier providers”的参数是一个函数，它应该实例化“notifier”。 +它通常应该是“构造函数撕裂”。 + + + }, + { + offset: 86, + length: 16, + label: "通知者程序", + description: <> + + +如果 `NotifierProvider` 是 “StatefulWidget” 类，则此部分就是该 `State` 类。 + + +此类负责公开修改提供者程序状态的方法。 +使用者可以使用 `ref.read(yourProvider.notifier).yourMethod()` 此类上的公共方法。 + +:::note + +除了内置的 `state` 之外，通知者程序不应具有公共属性，因为 UI 无法知道状态已更改。 +::: + + + }, + { + offset: 111, + length: 12, + label: "通知者程序类型", + description: <> + + +通知者程序扩展的基类应与提供者程序 + 修饰符的基类匹配。一些例子是： + +- NotifierProvider -> Notifier +- AsyncNotifierProvider -> AsyncNotifier +- AsyncNotifierProvider. + autoDispose -> + AutoDispose + + AsyncNotifier +- AsyncNotifierProvider. + autoDispose. + family + -> AutoDispose + Family + AsyncNotifier + + +为了简化此操作，建议使用代码生成器，因为它会自动推断正确的类型。 + + + }, + { + offset: 136, + length: 54, + label: "build 方法", + description: <> + + +所有通知者程序都必须重写该 `build` 方法。 +此方法等效于通常将逻辑放在非通知者程序提供者程序中的位置。 + + +不应直接调用此方法。 + + + }, +]} +/> + + + + + + + } + + <你的方法在这里> +}`} + annotations={[ + { + offset: 0, + length: 9, + label: "注解", + description: <> + + +所有提供者程序都必须使用 `@riverpod` 或 `@Riverpod()` 进行注解。 +此注解可以放置在全局函数或类上。 +通过此注解，可以配置提供者程序。 + + +例如，我们可以通过编写 `@Riverpod(keepAlive: true)` 来禁用“自动处置”（我们将在后面看到）。 + + + }, + { + offset: 10, + length: 16, + label: "通知者程序", + description: <> + + +当 `@riverpod` 注解被放置在一个类上时，该类被称为“通知者程序”。 +类必须扩展 `_$NotifierName` ，其中 `NotifierName` 是类名。 + + +通知者程序负责公开修改提供者程序状态的方法。 +使用者可以使用 `ref.read(yourProvider.notifier).yourMethod()` 此类上的公共方法。 + +:::note + +除了内置的 `state` 之外，通知者程序不应具有公共属性，因为 UI 无法知道状态已更改。 +::: + + + }, + { + offset: 52, + length: 54, + label: "build 方法", + description: <> + + +所有通知者程序都必须重写该 `build` 方法。 +此方法等效于通常将逻辑放在非通知者程序提供者程序中的位置。 + + +不应直接调用此方法。 + + + }, +]} +/> + + + +作为参考，您可能需要查看，将这里的新语法与之前看到的语法进行比较。 + +:::info + +除了 `build` 以外，没有其他方法的通知者程序与使用前面看到的语法相同。 +中显示的语法可以被视为通知者程序的简写，无法从 UI 进行修改。 +::: + + +现在我们已经了解了语法，让我们看看如何将之前定义的提供者程序转换为通知者程序： + + + + +请注意，在小部件中读取提供者程序的方式保持不变。 +您仍然可以像以前的语法一样使用 `ref.watch(todoListProvider)`。 + +:::caution + +不要将逻辑放在通知者程序的构造函数中。 +通知者程序不应具有构造函数，因为 `ref` 此时其他属性尚不可用。 +相反，将您的逻辑放在方法中 `build`。 + +```dart +class MyNotifier extends ... { + MyNotifier() { + // ❌ 别这样做 + // 这将会抛出一个异常 + state = AsyncValue.data(42); + } + + @override + Result build() { + // ✅ 应该这样做 + state = AsyncValue.data(42); + } +} +``` + +::: + + +## 公开用于执行 _POST_ 请求的方法 + + +现在我们有了通知者程序，我们可以开始添加方法来执行副作用。 +其中一个副作用是让客户端 _POST_ 一个新的待办事项。 +我们可以通过在通知者程序上添加一个 `addTodo` 方法来做到这一点： + + + + +然后，我们可以在 UI 中使用我们在中看到的相同 `Consumer`/`ConsumerWidget` 调用此方法： + + + +:::info + +请注意我们如何使用 `ref.read` 而不是调用 `ref.watch` 的方法。 +虽然在技术上可以工作，但 `ref.watch` 建议在事件处理（如“onPressed”）中执行逻辑时使用 `ref.read`。 +::: + + +我们现在有一个按钮，按下时会发出 _POST_ 请求。 +但是，目前，我们的 UI 不会更新以返回新的待办事项列表。 +我们希望本地缓存与服务器的状态相匹配。 + + +有几种方法可以做到这一点，下面说说优点和缺点。 + + +### 更新本地缓存以匹配 API 响应 + + +一种常见的后端做法是让 _POST_ 请求返回资源的新状态。 +特别是，我们的 API 将在添加新的待办事项后返回新的待办事项列表。 +一种方法是编写 `state = AsyncData(response)`： + + + +:::tip 优点 + + +- UI 将尽可能具有最新状态。如果其他用户添加了待办事项，我们也会看到它。 +- 服务器是事实的来源。使用这种方法，客户端不需要知道需要在列表的哪个位置插入新的待办事项。 +- 只需要一个网络请求。 + +::: + +:::danger 缺点 + + +- 仅当服务器以特定方式实现时，此方法才有效。如果服务器不返回新状态，则此方法将不起作用。 +- 如果关联的 _GET_ 请求更复杂，例如如果它具有过滤/排序的功能，则可能仍然不可行。 + +::: + + +### 使用 `ref.invalidateSelf()` 刷新提供者程序。 + + +一种选择是让我们的提供者程序重新执行 _GET_ 请求。 +这可以通过在 _POST_ 请求之后调用 `ref.invalidateSelf()` 来完成： + + + +:::tip 优点 + + +- UI 将尽可能具有最新状态。如果其他用户添加了待办事项，我们也会看到它。 +- 服务器是事实的来源。使用这种方法，客户端不需要知道需要在列表的哪个位置插入新的待办事项。 +- 无论服务器实现如何，此方法都应该有效。如果您的 _GET_ 请求更复杂，例如它具有过滤器/排序，则它可能特别有用。 + +::: + +:::danger 缺点 + + +- 此方法将执行额外的 _GET_ 请求，这可能效率低下。 + +::: + + +### 手动更新本地缓存 + + +另一种选择是手动更新本地缓存。 +这将涉及尝试模仿后端的行为。例如，我们需要知道后端是在开头还是结尾插入新项目。 + + + +:::info + +此示例使用不可变状态。这不是必需的，但建议这样做。 +有关更多详细信息，请参阅。 +如果要改用可变状态，也可以执行以下操作： + + + +::: + +:::tip 优点 + + +- 无论服务器实现如何，此方法都应该有效。 +- 只需要一个网络请求。 + +::: + +:::danger 缺点 + + +- 本地缓存可能与服务器的状态不匹配。如果其他用户添加了待办事项，我们将看不到它。 +- 这种方法的实现和有效地复制后端的逻辑可能更复杂。 + +::: + + +## 更进一步：显示下拉加载器和错误处理 + + +到目前为止我们所看到的一切，我们有一个按钮，当按下时会发出 _POST_ 请求; +请求完成后，UI 会更新以反映更改。 +但目前，没有迹象表明请求正在执行，如果失败，也没有任何信息。 + + +一种方法是将返回 `addTodo` 的异步结果存储在本地小部件状态中， +然后监听该异步状态以显示下拉加载器或错误消息。 +这时[flutter_hooks](https://pub.dev/packages/flutter_hooks)派上用场的一种情况。 +但是，当然，您也可以使用 `StatefulWidget` 代替。 + + +以下代码片段显示了当处于加载状态时，进度指示器和操作处于挂起状态。 +如果失败，则将按钮呈现为红色： + +![A button which turns red when the operation failed](/img/essentials/side_effects/spinner.gif) + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart new file mode 100644 index 000000000..901cd926e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart @@ -0,0 +1,28 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo_list_notifier.freezed.dart'; +part 'todo_list_notifier.g.dart'; + +@freezed +class Todo with _$Todo { + factory Todo({ + required String description, + @Default(false) bool completed, + }) = _Todo; + + factory Todo.fromJson(Map json) => _$TodoFromJson(json); +} + +/* SNIPPET START */ +@riverpod +class TodoList extends _$TodoList { + @override + Future> build() async { + // 我们之前在 FutureProvider 中的业务逻辑现在位于 build 方法中。 + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart new file mode 100644 index 000000000..3326f9ffa --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart @@ -0,0 +1,166 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'todo_list_notifier.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Todo _$TodoFromJson(Map json) { + return _Todo.fromJson(json); +} + +/// @nodoc +mixin _$Todo { + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$TodoImpl implements _Todo { + _$TodoImpl({required this.description, this.completed = false}); + + factory _$TodoImpl.fromJson(Map json) => + _$$TodoImplFromJson(json); + + @override + final String description; + @override + @JsonKey() + final bool completed; + + @override + String toString() { + return 'Todo(description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); + + @override + Map toJson() { + return _$$TodoImplToJson( + this, + ); + } +} + +abstract class _Todo implements Todo { + factory _Todo({required final String description, final bool completed}) = + _$TodoImpl; + + factory _Todo.fromJson(Map json) = _$TodoImpl.fromJson; + + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart new file mode 100644 index 000000000..4e6801ff7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -0,0 +1,42 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_notifier.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$TodoImpl _$$TodoImplFromJson(Map json) => _$TodoImpl( + description: json['description'] as String, + completed: json['completed'] as bool? ?? false, + ); + +Map _$$TodoImplToJson(_$TodoImpl instance) => + { + 'description': instance.description, + 'completed': instance.completed, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todoListHash() => r'c939d438b07da6065dbbcfab86c27ef363bdb76c'; + +/// See also [TodoList]. +@ProviderFor(TodoList) +final todoListProvider = + AutoDisposeAsyncNotifierProvider>.internal( + TodoList.new, + name: r'todoListProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$TodoList = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart new file mode 100644 index 000000000..0d6a9a7bd --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart @@ -0,0 +1,26 @@ +// ignore_for_file: avoid_print + +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'todo_list_notifier.dart'; + +part 'todo_list_notifier_add_todo.g.dart'; + +/* SNIPPET START */ +@riverpod +class TodoList extends _$TodoList { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + await http.post( + Uri.https('your_api.com', '/todos'), + // 我们序列化 Todo 对象并将其 POST 到服务器。 + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart new file mode 100644 index 000000000..8d2e07c04 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_notifier_add_todo.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todoListHash() => r'4008395aaca8f55312f668c0b2a32e7599f82349'; + +/// See also [TodoList]. +@ProviderFor(TodoList) +final todoListProvider = + AutoDisposeAsyncNotifierProvider>.internal( + TodoList.new, + name: r'todoListProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$TodoList = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart new file mode 100644 index 000000000..88eb06c0e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart @@ -0,0 +1,23 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo_list_provider.freezed.dart'; +part 'todo_list_provider.g.dart'; + +/* SNIPPET START */ +@freezed +class Todo with _$Todo { + factory Todo({ + required String description, + @Default(false) bool completed, + }) = _Todo; +} + +@riverpod +Future> todoList(TodoListRef ref) async { + // 模拟一个网络请求。这通常来自真实的 API + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart new file mode 100644 index 000000000..26a2d640c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart @@ -0,0 +1,148 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'todo_list_provider.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$Todo { + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc + +class _$TodoImpl implements _Todo { + _$TodoImpl({required this.description, this.completed = false}); + + @override + final String description; + @override + @JsonKey() + final bool completed; + + @override + String toString() { + return 'Todo(description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @override + int get hashCode => Object.hash(runtimeType, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); +} + +abstract class _Todo implements Todo { + factory _Todo({required final String description, final bool completed}) = + _$TodoImpl; + + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart new file mode 100644 index 000000000..caa526bca --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$todoListHash() => r'26b30307668c8feefa7cbe3c400b73e6edccbc39'; + +/// See also [todoList]. +@ProviderFor(todoList) +final todoListProvider = AutoDisposeFutureProvider>.internal( + todoList, + name: r'todoListProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$todoListHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef TodoListRef = AutoDisposeFutureProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart new file mode 100644 index 000000000..133545651 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart @@ -0,0 +1,25 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../raw/todo_list_notifier.dart' show Todo; +import '../raw/todo_list_notifier_add_todo.dart'; + +/* SNIPPET START */ +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return ElevatedButton( + onPressed: () { + // 使用“ref.read”与“myProvider.notifier”结合， + // 我们可以获得通知者程序的类实例。 + // 这使我们能够调用“addTodo”方法。 + ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + }, + child: const Text('Add todo'), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart new file mode 100644 index 000000000..af28999d4 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart @@ -0,0 +1,38 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // 我们不关心 API 响应 + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // 一旦post请求完成，我们就可以将本地缓存标记为脏。 + // 这将导致我们的通知者程序上的“build”再次异步调用， + // 并在执行此操作时通知监听者。 + ref.invalidateSelf(); + + // （可选）然后我们可以等待新状态的计算。 + // 这确保了“addTodo”在新状态可用之前不会完成。 + await future; + } +/* SNIPPET END */ +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart new file mode 100644 index 000000000..30c168a4f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart @@ -0,0 +1,39 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // 我们不关心 API 响应 + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // 然后我们可以手动更新本地缓存。为此，我们需要获取之前的状态。 + // 注意：之前的状态可能仍在加载或处于错误状态。 + // 处理此问题的一种优雅方法是读取“this.future”而不是“this.state”， + // 这将允许等待加载状态，并在状态处于错误状态时抛出错误。 + final previousState = await future; + + // 然后我们可以通过创建一个新的状态对象来更新状态。 + // 这将通知所有监听者。 + state = AsyncData([...previousState, todo]); + } +/* SNIPPET END */ +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart new file mode 100644 index 000000000..ad40ed42a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart @@ -0,0 +1,35 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + // We don't care about the API response + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + /* SNIPPET START */ + final previousState = await future; + // 改变之前的待办事项列表。 + previousState.add(todo); + // 手动通知监听者。 + ref.notifyListeners(); +/* SNIPPET END */ + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart new file mode 100644 index 000000000..2d1bd4521 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart @@ -0,0 +1,78 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'rest_add_todo.dart'; +import 'todo_list_notifier.dart' show Todo; + +void main() { + runApp( + const ProviderScope(child: MyApp()), + ); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return const MaterialApp(home: Example()); + } +} + +/* SNIPPET START */ +class Example extends ConsumerStatefulWidget { + const Example({super.key}); + + @override + ConsumerState createState() => _ExampleState(); +} + +class _ExampleState extends ConsumerState { + // 待处理的 addTodo 操作。如果没有待处理的，则为 null。 + Future? _pendingAddTodo; + + @override + Widget build(BuildContext context) { + return FutureBuilder( + // 我们监听待处理的操作，以相应地更新 UI。 + future: _pendingAddTodo, + builder: (context, snapshot) { + // 计算是否存在错误状态。 + // 检查 connectionState 用于在重试操作时进行处理。 + final isErrored = snapshot.hasError && + snapshot.connectionState != ConnectionState.waiting; + + return Row( + children: [ + ElevatedButton( + style: ButtonStyle( + // 如果出现错误，我们会将该按钮显示为红色 + backgroundColor: MaterialStateProperty.all( + isErrored ? Colors.red : null, + ), + ), + onPressed: () { + // 我们将 addTodo 返回的 future 保存在变量中 + final future = ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + + // 我们将这个 future 存储在本地的状态中 + setState(() { + _pendingAddTodo = future; + }); + }, + child: const Text('Add todo'), + ), + // 操作正在等待，让我们显示一个进度指示器 + if (snapshot.connectionState == ConnectionState.waiting) ...[ + const SizedBox(width: 8), + const CircularProgressIndicator(), + ] + ], + ); + }, + ); + } +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart new file mode 100644 index 000000000..959000261 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart @@ -0,0 +1,68 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'rest_add_todo.dart'; +import 'todo_list_notifier.dart' show Todo; + +void main() { + runApp( + const ProviderScope(child: MyApp()), + ); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return const MaterialApp(home: Example()); + } +} + +/* SNIPPET START */ +class Example extends HookConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // 待处理的 addTodo 操作。如果没有待处理的，则为 null。 + final pendingAddTodo = useState?>(null); + // 我们监听待处理的操作，以相应地更新 UI。 + final snapshot = useFuture(pendingAddTodo.value); + + // 计算是否存在错误状态。 + // 检查 connectionState 用于在重试操作时进行处理。 + final isErrored = snapshot.hasError && + snapshot.connectionState != ConnectionState.waiting; + + return Row( + children: [ + ElevatedButton( + style: ButtonStyle( + // 如果出现错误，我们会将该按钮显示为红色 + backgroundColor: MaterialStateProperty.all( + isErrored ? Colors.red : null, + ), + ), + onPressed: () async { + // 我们将 addTodo 返回的 future 保存在变量中 + final future = ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + + // 我们将这个 future 存储在本地的状态中 + pendingAddTodo.value = future; + }, + child: const Text('Add todo'), + ), + // 操作正在等待，让我们显示一个进度指示器 + if (snapshot.connectionState == ConnectionState.waiting) ...[ + const SizedBox(width: 8), + const CircularProgressIndicator(), + ] + ], + ); + } +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart new file mode 100644 index 000000000..8136265cd --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart @@ -0,0 +1,39 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // POST 请求将返回与新应用程序状态匹配的 List + final response = await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // 我们解码 API 响应并将其转换为 List + List newTodos = (jsonDecode(response.body) as List) + .cast>() + .map(Todo.fromJson) + .toList(); + + // 我们更新本地缓存以匹配新状态。 + // 这将通知所有的监听程序。 + state = AsyncData(newTodos); + } +/* SNIPPET END */ +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart new file mode 100644 index 000000000..c3f0aff34 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart @@ -0,0 +1,44 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Todo { + Todo({ + required this.description, + this.completed = false, + }); + + factory Todo.fromJson(Map json) { + return Todo( + description: json['description']! as String, + completed: json['completed']! as bool, + ); + } + + final String description; + final bool completed; + + Map toJson() => { + 'description': description, + 'completed': completed, + }; +} + +/* SNIPPET START */ +// 我们现在使用 AsyncNotifierProvider 替代 FutureProvider +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +// 因为我们的逻辑是异步的，所以我们需要使用 AsyncNotifier。 +// 特别的，由于使用“autoDispose”修饰符， +// 我们需要 AutoDisposeAsyncNotifier。 +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async { + // 我们之前在 FutureProvider 中的业务逻辑现在位于 build 方法中。 + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart new file mode 100644 index 000000000..81e32048f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +/* SNIPPET START */ +class TodoList extends AutoDisposeAsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + await http.post( + Uri.https('your_api.com', '/todos'), + // 我们序列化 Todo 对象并将其 POST 到服务器。 + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart new file mode 100644 index 000000000..a01c4195c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart @@ -0,0 +1,27 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class Todo { + Todo({ + required this.description, + this.completed = false, + }); + + factory Todo.fromJson(Map json) { + return Todo( + description: json['description'] as String, + completed: json['completed'] as bool, + ); + } + + final String description; + final bool completed; +} + +final todoListProvider = FutureProvider.autoDispose>((ref) async { + // 模拟一个网络请求。这通常来自真实的 API + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts new file mode 100644 index 000000000..798feb107 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/render_add_todo.dart"; +import hooks from "!!raw-loader!./raw/render_add_todo_hooks.dart"; + +export default { + raw: raw, + hooks: hooks, + codegen: raw, + hooksCodegen: hooks, +}; \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts new file mode 100644 index 000000000..b32ae3b9b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/todo_list_notifier.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_notifier.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts new file mode 100644 index 000000000..62fb0e0fc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/todo_list_notifier_add_todo.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_notifier_add_todo.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts new file mode 100644 index 000000000..de7789c0b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts @@ -0,0 +1,7 @@ +import raw from "!!raw-loader!./raw/todo_list_provider.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_provider.dart"; + +export default { + raw: raw, + codegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing.mdx new file mode 100644 index 000000000..65e4c1945 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing.mdx @@ -0,0 +1,303 @@ +--- +title: 测试你的提供者程序 +--- + +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import createContainer from "!!raw-loader!./testing/create_container.dart"; +import unitTest from "!!raw-loader!./testing/unit_test.dart"; +import widgetTest from "!!raw-loader!./testing/widget_test.dart"; +import fullWidgetTest from "!!raw-loader!./testing/full_widget_test.dart"; +import widgetContainerOf from "!!raw-loader!./testing/widget_container_of.dart"; +import providerToMock from "./testing/provider_to_mock"; +import mockProvider from "!!raw-loader!./testing/mock_provider.dart"; +import autoDisposeListen from "!!raw-loader!./testing/auto_dispose_listen.dart"; +import listenProvider from "!!raw-loader!./testing/listen_provider.dart"; +import awaitFuture from "!!raw-loader!./testing/await_future.dart"; +import notifierMock from "./testing/notifier_mock"; + + +Riverpod API 的核心部分是能够单独测试提供者程序。 + + +对于一个合适的测试套件，有几个挑战需要克服： + + +- 测试不应共享状态。这意味着新测试不应受到先前测试的影响。 +- 测试应该使我们能够模拟某些功能以达到所需的状态。 +- 测试环境应尽可能接近真实环境。 + + +幸运的是，Riverpod 可以轻松实现所有这些目标。 + + +## 设置测试 + + +使用 Riverpod 定义测试时，主要有两种情况： + + +- 单元测试，通常没有 Flutter 依赖。 + 这对于单独测试提供者程序的行为非常有用。 +- Widget 测试，通常带有 Flutter 依赖项。 + 这对于测试使用提供者程序的小部件的行为非常有用。 + + +### 单元测试 + + +单元测试是使用 [package:test](https://pub.dev/packages/test) 中的 `test` 函数定义的。 + + +与任何其他测试的主要区别在于，我们想要创建一个 `ProviderContainer` 对象。 +此对象将使我们的测试能够与提供者程序进行交互。 + + +建议创建一个测试实用程序来创建和处置对象 `ProviderContainer`： + + + + +然后，我们可以使用此实用程序定义一个 `test`： + + + + +现在我们有了 ProviderContainer，我们可以使用它来读取提供者程序，使用： + + +- `container.read`，以读取提供者程序的当前值。 +- `container.listen`，以监听提供者程序并接收更改的通知。 + +:::caution + +在自动处置提供者程序时使用 `container.read` 时要小心。 +如果您的提供者程序没有被监听，其状态可能会在测试过程中被破坏。 + + +在这种情况下，请考虑使用 `container.listen`。 +无论如何，它的返回值都能读取提供者程序的当前值， +同时还能确保提供者程序不会在测试过程中被弃置： + + +::: + + +### 小部件测试 + + +小部件测试是使用 [package:flutter_test](https://pub.dev/packages/flutter_test) 中的 `testWidgets` 函数定义的。 + + +在这种情况下，与通常的 Widget 测试的主要区别在于， +我们必须添加一个 `ProviderScope` 在 `tester.pumpWidget` 的根组件上： + + + + +这类似于我们在 Flutter 应用程序中启用 Riverpod 时所做的。 + + +然后，我们可以用 `tester` 来与我们的小部件进行交互。 +或者，如果要与提供者程序交互，可以获取 `ProviderContainer`。 +也可以使用 `ProviderScope.containerOf(buildContext)` 获得一个。 +因此，通过使用 `tester` ，我们可以编写以下内容： + + + + +然后，我们可以使用它来读取提供者程序。下面是一个完整的示例： + + + + +## 模拟提供者程序 + + +到目前为止，我们已经了解了如何设置测试以及与提供者程序的基本交互。 +但是，在某些情况下，我们可能想要模拟一个提供者程序。 + + +很酷的部分：默认情况下可以模拟所有提供者程序，无需任何额外设置。 +这可以通过在 `ProviderScope` 或 `ProviderContainer` 上指定 `overrides` 参数来实现。 + + +请考虑以下提供者程序： + + + + +我们可以模拟它通过以下方式： + + + + +## 监视提供者程序中的更改 + + +由于我们在测试中获得了一个 `ProviderContainer`，因此可以使用它来“监听”提供者程序： + + + + +然后，您可以将其与 [mockito](https://pub.dev/packages/mockito) +或 [mocktail](https://pub.dev/packages/mocktail) 等包结合使用，以使用它们的 `verify` API。 +或者更简单地说，您可以在列表中添加所有更改并对其进行断言。 + + +## 等待异步提供者程序 + + +在 Riverpod 中，提供者程序返回 Future/Stream 是很常见的。 +在这种情况下，我们的测试可能需要等待异步操作完成。 + + +一种方法是读取提供者程序的 `.future`： + + + + +## 模拟通知者程序 + + +通常不鼓励嘲笑通知者程序。 +相反，您可能应该在通告程序的逻辑中引入一个抽象级别，以便您可以模拟该抽象。 +例如，与其模拟通告程序，不如模拟通告程序用来从中获取数据的“存储库”。 + + +如果您坚持要模拟通告程序，那么创建这样的通告程序需要特别注意： +您的模拟必须对原始通告程序基类进行子类化： +您不能“实现”通告程序，因为这会破坏接口。 + + +因此，在模拟通告程序时，不要编写以下模拟代码： + +```dart +class MyNotifierMock with Mock implements MyNotifier {} +``` + + +你应该改写： + + + + + + +为此，您的模拟必须与您模拟的通知者程序放在同一个文件中。 +否则，您将无法访问该 `_$MyNotifier` 类。 + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart new file mode 100644 index 000000000..4c1582c91 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 'Hello world'); + +void main() { + test('Some description', () { + final container = createContainer(); + /* SNIPPET START */ + final subscription = container.listen(provider, (_, __) {}); + + expect( + // 等同于 `container.read(provider)` + // 但除非处置了 "subscription"，否则不会处置提供者程序。 + subscription.read(), + 'Some value', + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart new file mode 100644 index 000000000..0d5fd8438 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart @@ -0,0 +1,32 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = FutureProvider((_) async => 42); + +void main() { + test('Some description', () async { + // 为该测试创建一个 ProviderContainer。 + // 切勿！在测试之间共享 ProviderContainer。 + final container = createContainer(); + + /* SNIPPET START */ + // TODO: 使用容器来测试您的应用程序。 + // 我们的期望是异步的，所以应该使用 "expectLater"（期望稍后）。 + await expectLater( + // 我们读取的是 "provider.future"，而不是 "provider"。 + // 这在异步提供者程序上是可能发生的， + // 并返回一个携带了提供者程序的值的 Future。 + container.read(provider.future), + // We can verify that the future resolves with the expected value. + // Alternatively we can use "throwsA" for errors. + // 我们可以验证 Future 是否按预期值解析。 + // 或者，我们可以使用 "throwsA" 来处理错误。 + completion('some value'), + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart new file mode 100644 index 000000000..1d4faf8f1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart @@ -0,0 +1,22 @@ +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +/// 一种测试工具，用于创建一个 [ProviderContainer]， +/// 并在测试结束时自动将其处置。 +ProviderContainer createContainer({ + ProviderContainer? parent, + List overrides = const [], + List? observers, +}) { + // 创建一个 ProviderContainer，并可选的允许指定参数。 + final container = ProviderContainer( + parent: parent, + overrides: overrides, + observers: observers, + ); + + // 测试结束后，处置容器。 + addTearDown(container.dispose); + + return container; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart new file mode 100644 index 000000000..ce0766bc3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart @@ -0,0 +1,33 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +final provider = Provider((_) => 'some value'); + +class YourWidgetYouWantToTest extends StatelessWidget { + const YourWidgetYouWantToTest({super.key}); + + @override + Widget build(BuildContext context) => const Placeholder(); +} + +/* SNIPPET START */ +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + + final element = tester.element(find.byType(YourWidgetYouWantToTest)); + final container = ProviderScope.containerOf(element); + + // TODO 与你的提供者程序交互 + expect( + container.read(provider), + 'some value', + ); + }); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart new file mode 100644 index 000000000..d2e840d9b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 'Hello world'); + +void main() { + test('Some description', () { + final container = createContainer(); + /* SNIPPET START */ + container.listen( + provider, + (previous, next) { + print('The provider changed from $previous to $next'); + }, + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart new file mode 100644 index 000000000..284094b48 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart @@ -0,0 +1,45 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +import 'create_container.dart'; +import 'full_widget_test.dart'; +import 'provider_to_mock/raw.dart'; + +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + /* SNIPPET START */ + // 在单元测试中，重用我们之前的 "createContainer "工具。 + final container = createContainer( + // 我们可以指定要模拟的提供者程序列表： + overrides: [ + // 在本例中，我们模拟的是 "exampleProvider"。 + exampleProvider.overrideWith((ref) { + // 该函数是典型的提供者程序初始化函数。 + // 通常在此调用 "ref.watch "并返回初始状态。 + + // 让我们用自定义值替换默认的 "Hello world"。 + // 然后，与 `exampleProvider` 交互时将返回此值。 + return 'Hello from tests'; + }), + ], + ); + + // 我们还可以使用 ProviderScope 在 widget 测试中做同样的事情： + await tester.pumpWidget( + ProviderScope( + // ProviderScopes 具有完全相同的 "overrides" 参数 + overrides: [ + // 和之前一样 + exampleProvider.overrideWith((ref) => 'Hello from tests'), + ], + child: const YourWidgetYouWantToTest(), + ), + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart new file mode 100644 index 000000000..53e71e99e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart @@ -0,0 +1,17 @@ +// ignore_for_file: prefer_mixin + +import 'package:mockito/mockito.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() => throw UnimplementedError(); +} + +// 您的模拟类需要作为 Notifier 的子类，与您的通知者程序使用的基类相对应 +class MyNotifierMock extends _$MyNotifier with Mock implements MyNotifier {} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart new file mode 100644 index 000000000..b2d7b9dac --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'912fa35c2296626fc0825bcbcfc6b6c85958be02'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart new file mode 100644 index 000000000..404e67734 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart @@ -0,0 +1,14 @@ +// ignore_for_file: prefer_mixin + +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:mockito/mockito.dart'; + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() => throw UnimplementedError(); +} + +// 您的模拟类需要作为 Notifier 的子类，与您的通知者程序使用的基类相对应 +class MyNotifierMock extends Notifier with Mock implements MyNotifier {} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart new file mode 100644 index 000000000..1a5fd4543 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +// 一个急于初始化的提供者程序。 +@riverpod +Future example(ExampleRef ref) async => 'Hello world'; +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart new file mode 100644 index 000000000..dd85f62f9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; + +/// See also [example]. +@ProviderFor(example) +final exampleProvider = AutoDisposeFutureProvider.internal( + example, + name: r'exampleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$exampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ExampleRef = AutoDisposeFutureProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart new file mode 100644 index 000000000..1491a0b60 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart @@ -0,0 +1,6 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +// 一个急于初始化的提供者程序。 +final exampleProvider = FutureProvider((ref) async => 'Hello world'); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart new file mode 100644 index 000000000..40261e13e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 42); + +/* SNIPPET START */ +void main() { + test('Some description', () { + // 为该测试创建一个 ProviderContainer。 + // 切勿！在测试之间共享 ProviderContainer。 + final container = createContainer(); + + // TODO: 使用容器测试你的应用程序。 + expect( + container.read(provider), + equals('some value'), + ); + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart new file mode 100644 index 000000000..61b2ca36b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart @@ -0,0 +1,15 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +import 'widget_test.dart'; + +void main() { + testWidgets('Some description', (tester) async { + /* SNIPPET START */ + final element = tester.element(find.byType(YourWidgetYouWantToTest)); + final container = ProviderScope.containerOf(element); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart new file mode 100644 index 000000000..b4afc835c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +class YourWidgetYouWantToTest extends StatelessWidget { + const YourWidgetYouWantToTest({super.key}); + + @override + Widget build(BuildContext context) => const Placeholder(); +} + +/* SNIPPET START */ +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + }); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx new file mode 100644 index 000000000..7fe276f71 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx @@ -0,0 +1,197 @@ +--- +title: Websocket 和同步执行 +--- + +import { + trimSnippet, + AutoSnippet, + When, +} from "@site/src/components/CodeSnippet"; +import syncDefinition from "./websockets_sync/sync_definition"; +import streamProvider from "./websockets_sync/stream_provider"; +import syncConsumer from "!!raw-loader!./websockets_sync/sync_consumer.dart"; +import rawUsage from "!!raw-loader!./websockets_sync/raw_usage.dart"; +import pipeChangeNotifier from "!!raw-loader!./websockets_sync/pipe_change_notifier.dart"; +import sharedPipeChangeNotifier from "!!raw-loader!./websockets_sync/shared_pipe_change_notifier.dart"; +import changeNotifierProvider from "!!raw-loader!./websockets_sync/change_notifier_provider.dart"; + + +到目前为止，我们只介绍了如何创建一个 `Future`。 +这是有意为之的，因为 `Future` 是 Riverpod 应用程序构建方式的核心。 +_但是_，如有必要，Riverpod 还支持其他格式。 + + +特别是，除了 `Future` 类型的提供者程序，还存在灵活的类型： + + +- 同步返回一个对象，例如创建“存储库”。 +- 返回一个 `Stream`，例如监听 websockets。 + + +返回 `Future` 和返回 `Stream` 或 object 总体上非常相似。 +本页将解释这些用例的细微差别和各种提示。 + + +## 同步返回对象 + + +若要同步创建对象，请确保提供者程序不返回 Future： + + + + +当提供者程序同步创建对象时，这会影响对象的使用方式。 +具体而言，同步值不会被包装在“AsyncValue”中： + + + + +这种差异的后果是，如果提供者程序抛出异常，尝试读取该值会重新抛出错误。 +或者，当使用 `ref.listen` 时，将调用 “onError” 回调。 + + +### 可监听对象的注意事项 + + + + +可监听对象，例如 `ChangeNotifier` 或 `StateNotifier` 是不受支持的。 +如果出于兼容性原因，您需要与其中一个对象进行交互， +一种解决方法是将其通知机制通过管道传递给 Riverpod。 + + + +:::info + +如果你多次需要这样的逻辑，值得注意的是， +逻辑是共享的！"ref" 对象被设计为可组合的。 +这样就可以从提供者程序中提取处置/监听逻辑： + + +::: + + + + + + +当不使用代码生成时，Riverpod 提供了“传统”的提供者程序来支持 +`ChangeNotifier` 和 `StateNotifier` 开箱即用： +`ChangeNotifierProvider` 和 `StateNotifierProvider`。 +使用它们就像使用其他类型的提供者程序一样。 +主要区别在于它们将自动监听和处置返回的对象。 + + +不建议将这些提供者程序用于新的业务逻辑。 +但是，在与旧代码混合编写时（例如从 `pkg:provider` 迁移到 Riverpod 时）， +它们可能会有所帮助。 + + + + + + +## 监听一个流 + + +现代应用程序的一个常见用例是与 Websocket 交互， +例如与 Firebase 或 GraphQL 订阅进行交互。 +与这些 API 的交互通常是通过监听一个 `Stream`。 + + +为了帮助实现这一点，Riverpod 自然地支持 `Stream` 对象。 +与 `Future` 一样，该对象将转换为 `AsyncValue`： + + + +:::info + +Riverpod 不知道自定义 `Stream` 实现，例如 RX 的 `BehaviorSubject`。 +因此，返回 `BehaviorSubject` 不会同步向小部件公开，`value` 即使在创建时已经可用。 +::: + + +## 禁用从 `Stream` / `Future` 转换到 `AsyncValue` + + +默认情况下，Riverpod 会将 `Stream` 和 `Future` 转换为 `AsyncValue`。 +尽管很少需要，但可以通过将返回类型包装在 `Raw` 泛型中来禁用此行为。 + +:::caution + +通常不建议禁用转换 `AsyncValue`。 +只有当您知道自己在做什么时才这样做。 +::: + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart new file mode 100644 index 000000000..58d56d96c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart @@ -0,0 +1,11 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final myProvider = ChangeNotifierProvider>((ref) { + // 将监听并处置 ValueNotifier。 + // 然后，小部件可以使用 "ref.watch" 对提供者程序监听更新。 + return ValueNotifier(0); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart new file mode 100644 index 000000000..1506310fb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart @@ -0,0 +1,21 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'pipe_change_notifier.g.dart'; + +/* SNIPPET START */ +/// 一个提供者程序，它创建 ValueNotifier 并在值更改时更新其监听器。 +@riverpod +ValueNotifier myListenable(MyListenableRef ref) { + final notifier = ValueNotifier(0); + + // 当提供者程序被处置时处置通知者程序 + ref.onDispose(notifier.dispose); + + // 每当 ValueNotifier 更新时通知此提供者程序的监听器。 + notifier.addListener(ref.notifyListeners); + + return notifier; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart new file mode 100644 index 000000000..cd32c5e84 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -0,0 +1,28 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'pipe_change_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myListenableHash() => r'4cc07df2f47050c4aa761e5467f341ab6c312d09'; + +/// 一个提供者程序，它创建 ValueNotifier 并在值更改时更新其监听器。 +/// +/// Copied from [myListenable]. +@ProviderFor(myListenable) +final myListenableProvider = AutoDisposeProvider>.internal( + myListenable, + name: r'myListenableProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myListenableHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef MyListenableRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart new file mode 100644 index 000000000..496408e74 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart @@ -0,0 +1,30 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'raw_usage.g.dart'; + +/* SNIPPET START */ +@riverpod +Raw> rawStream(RawStreamRef ref) { + // “Raw”是一个 typedef。 + // 无需包装返回值的“原始”构造函数中的值。 + return const Stream.empty(); +} + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 该值不再转换为 AsyncValue， + // 并且按原样返回创建的流。 + Stream stream = ref.watch(rawStreamProvider); + return StreamBuilder( + stream: stream, + builder: (context, snapshot) { + return Text('${snapshot.data}'); + }, + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart new file mode 100644 index 000000000..bd06ba4bc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'raw_usage.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$rawStreamHash() => r'7e7c2e8f4f08d33a4d86d60449e143c419ca4822'; + +/// See also [rawStream]. +@ProviderFor(rawStream) +final rawStreamProvider = AutoDisposeProvider>>.internal( + rawStream, + name: r'rawStreamProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$rawStreamHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef RawStreamRef = AutoDisposeProviderRef>>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart new file mode 100644 index 000000000..faa8fb018 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart @@ -0,0 +1,29 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'shared_pipe_change_notifier.g.dart'; + +/* SNIPPET START */ +extension on Ref { + // 我们可以将之前的逻辑移至 Ref 扩展。 + // 这使得能够重用提供者程序之间的逻辑 + T disposeAndListenChangeNotifier(T notifier) { + onDispose(notifier.dispose); + notifier.addListener(notifyListeners); + // 我们返回通知者程序以稍微简化使用 + return notifier; + } +} + +@riverpod +ValueNotifier myListenable(MyListenableRef ref) { + return ref.disposeAndListenChangeNotifier(ValueNotifier(0)); +} + +@riverpod +ValueNotifier anotherListenable(AnotherListenableRef ref) { + return ref.disposeAndListenChangeNotifier(ValueNotifier(42)); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart new file mode 100644 index 000000000..fbc40c61b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -0,0 +1,42 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'shared_pipe_change_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myListenableHash() => r'7096094cd24ed50dbabb9fb9ab64b340176c04bf'; + +/// See also [myListenable]. +@ProviderFor(myListenable) +final myListenableProvider = AutoDisposeProvider>.internal( + myListenable, + name: r'myListenableProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myListenableHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef MyListenableRef = AutoDisposeProviderRef>; +String _$anotherListenableHash() => r'38bfe5dbf5f148819b3671ad69d15c8e05264c23'; + +/// See also [anotherListenable]. +@ProviderFor(anotherListenable) +final anotherListenableProvider = + AutoDisposeProvider>.internal( + anotherListenable, + name: r'anotherListenableProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$anotherListenableHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef AnotherListenableRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart new file mode 100644 index 000000000..7fdf1c3a2 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart @@ -0,0 +1,34 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Stream streamExample(StreamExampleRef ref) async* { + // 每 1 秒产生一个 0 到 41 之间的数字。 + // 这可以替换为来自 Firestore 或 GraphQL 或其他任何东西的 Stream。 + for (var i = 0; i < 42; i++) { + yield i; + await Future.delayed(const Duration(seconds: 1)); + } +} + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 该流被监听并转换为 AsyncValue。 + AsyncValue value = ref.watch(streamExampleProvider); + + // 我们可以使用 AsyncValue 来处理加载/错误状态并显示数据。 + return switch (value) { + AsyncValue(:final error?) => Text('Error: $error'), + AsyncValue(:final valueOrNull?) => Text('$valueOrNull'), + _ => const CircularProgressIndicator(), + }; + } +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart new file mode 100644 index 000000000..b8ef976c4 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$streamExampleHash() => r'ca9993b22f6d587b20c041133cacd28d01933074'; + +/// See also [streamExample]. +@ProviderFor(streamExample) +final streamExampleProvider = AutoDisposeStreamProvider.internal( + streamExample, + name: r'streamExampleProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$streamExampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef StreamExampleRef = AutoDisposeStreamProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts new file mode 100644 index 000000000..4ee159de8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts @@ -0,0 +1,4 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart new file mode 100644 index 000000000..bdec702f7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart @@ -0,0 +1,30 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final streamExampleProvider = StreamProvider.autoDispose((ref) async* { + // 每 1 秒产生一个 0 到 41 之间的数字。 + // 这可以替换为来自 Firestore 或 GraphQL 或其他任何东西的 Stream。 + for (var i = 0; i < 42; i++) { + yield i; + await Future.delayed(const Duration(seconds: 1)); + } +}); + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 该流被监听并转换为 AsyncValue。 + AsyncValue value = ref.watch(streamExampleProvider); + + // 我们可以使用 AsyncValue 来处理加载/错误状态并显示数据。 + return switch (value) { + AsyncValue(:final error?) => Text('Error: $error'), + AsyncValue(:final valueOrNull?) => Text('$valueOrNull'), + _ => const CircularProgressIndicator(), + }; + } +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart new file mode 100644 index 000000000..83bc56e66 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart @@ -0,0 +1,19 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'sync_definition/raw.dart'; + +void main() { +/* SNIPPET START */ + Consumer( + builder: (context, ref, child) { + // value 没有使用 "AsyncValue "包装 + int value = ref.watch(synchronousExampleProvider); + + return Text('$value'); + }, + ); +/* SNIPPET END */ +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart new file mode 100644 index 000000000..b18b8f76e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart @@ -0,0 +1,10 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +int synchronousExample(SynchronousExampleRef ref) { + return 0; +} +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart new file mode 100644 index 000000000..ef1015d6e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -0,0 +1,28 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$synchronousExampleHash() => + r'98df96e07d554683041f668c06b36f183ff534c1'; + +/// See also [synchronousExample]. +@ProviderFor(synchronousExample) +final synchronousExampleProvider = AutoDisposeProvider.internal( + synchronousExample, + name: r'synchronousExampleProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$synchronousExampleHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef SynchronousExampleRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts new file mode 100644 index 000000000..4ee159de8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts @@ -0,0 +1,4 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart new file mode 100644 index 000000000..9c64294a0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart @@ -0,0 +1,7 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +final synchronousExampleProvider = Provider.autoDispose((ref) { + return 0; +}); +/* SNIPPET END */ \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.dart new file mode 100644 index 000000000..4d49c552a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.dart @@ -0,0 +1,11 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family.g.dart'; +/* SNIPPET START */ + +@riverpod +int random(RandomRef ref, {required int seed, required int max}) { + return Random(seed).nextInt(max); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart new file mode 100644 index 000000000..3e39394a5 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart @@ -0,0 +1,222 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$randomHash() => r'517b12aad4df7b31f8872b89af74e7880377b2ea'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [random]. +@ProviderFor(random) +const randomProvider = RandomFamily(); + +/// See also [random]. +class RandomFamily extends Family { + /// See also [random]. + const RandomFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'randomProvider'; + + /// See also [random]. + RandomProvider call({ + required int seed, + required int max, + }) { + return RandomProvider( + seed: seed, + max: max, + ); + } + + @visibleForOverriding + @override + RandomProvider getProviderOverride( + covariant RandomProvider provider, + ) { + return call( + seed: provider.seed, + max: provider.max, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(int Function(RandomRef ref) create) { + return _$RandomFamilyOverride(this, create); + } +} + +class _$RandomFamilyOverride implements FamilyOverride { + _$RandomFamilyOverride(this.overriddenFamily, this.create); + + final int Function(RandomRef ref) create; + + @override + final RandomFamily overriddenFamily; + + @override + RandomProvider getProviderOverride( + covariant RandomProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [random]. +class RandomProvider extends AutoDisposeProvider { + /// See also [random]. + RandomProvider({ + required int seed, + required int max, + }) : this._internal( + (ref) => random( + ref as RandomRef, + seed: seed, + max: max, + ), + from: randomProvider, + name: r'randomProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$randomHash, + dependencies: RandomFamily._dependencies, + allTransitiveDependencies: RandomFamily._allTransitiveDependencies, + seed: seed, + max: max, + ); + + RandomProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.seed, + required this.max, + }) : super.internal(); + + final int seed; + final int max; + + @override + Override overrideWith( + int Function(RandomRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: RandomProvider._internal( + (ref) => create(ref as RandomRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + seed: seed, + max: max, + ), + ); + } + + @override + ({ + int seed, + int max, + }) get argument { + return ( + seed: seed, + max: max, + ); + } + + @override + AutoDisposeProviderElement createElement() { + return _RandomProviderElement(this); + } + + RandomProvider _copyWith( + int Function(RandomRef ref) create, + ) { + return RandomProvider._internal( + (ref) => create(ref as RandomRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + seed: seed, + max: max, + ); + } + + @override + bool operator ==(Object other) { + return other is RandomProvider && other.seed == seed && other.max == max; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, seed.hashCode); + hash = _SystemHash.combine(hash, max.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin RandomRef on AutoDisposeProviderRef { + /// The parameter `seed` of this provider. + int get seed; + + /// The parameter `max` of this provider. + int get max; +} + +class _RandomProviderElement extends AutoDisposeProviderElement + with RandomRef { + _RandomProviderElement(super.provider); + + @override + int get seed => (origin as RandomProvider).seed; + @override + int get max => (origin as RandomProvider).max; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx new file mode 100644 index 000000000..fa391f61a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./family.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart new file mode 100644 index 000000000..68b84d40d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart @@ -0,0 +1,27 @@ +import 'dart:math'; + +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@immutable +abstract class Equatable { + const Equatable(); + + List get props; +} + +/* SNIPPET START */ +class ParamsType extends Equatable { + const ParamsType({required this.seed, required this.max}); + + final int seed; + final int max; + + @override + List get props => [seed, max]; +} + +final randomProvider = + Provider.family.autoDispose((ref, params) { + return Random(params.seed).nextInt(params.max); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart new file mode 100644 index 000000000..1082ef6f3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart @@ -0,0 +1,12 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; + +import 'json.dart'; + +part 'item.freezed.dart'; +part 'item.g.dart'; + +@freezed +class Item with _$Item { + const factory Item({required int id}) = _Item; + factory Item.fromJson(Json json) => _$ItemFromJson(json); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart new file mode 100644 index 000000000..e578c8154 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart @@ -0,0 +1,146 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'item.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Item _$ItemFromJson(Map json) { + return _Item.fromJson(json); +} + +/// @nodoc +mixin _$Item { + int get id => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ItemCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ItemCopyWith<$Res> { + factory $ItemCopyWith(Item value, $Res Function(Item) then) = + _$ItemCopyWithImpl<$Res, Item>; + @useResult + $Res call({int id}); +} + +/// @nodoc +class _$ItemCopyWithImpl<$Res, $Val extends Item> + implements $ItemCopyWith<$Res> { + _$ItemCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as int, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ItemImplCopyWith<$Res> implements $ItemCopyWith<$Res> { + factory _$$ItemImplCopyWith( + _$ItemImpl value, $Res Function(_$ItemImpl) then) = + __$$ItemImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({int id}); +} + +/// @nodoc +class __$$ItemImplCopyWithImpl<$Res> + extends _$ItemCopyWithImpl<$Res, _$ItemImpl> + implements _$$ItemImplCopyWith<$Res> { + __$$ItemImplCopyWithImpl(_$ItemImpl _value, $Res Function(_$ItemImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + }) { + return _then(_$ItemImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as int, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ItemImpl implements _Item { + const _$ItemImpl({required this.id}); + + factory _$ItemImpl.fromJson(Map json) => + _$$ItemImplFromJson(json); + + @override + final int id; + + @override + String toString() { + return 'Item(id: $id)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ItemImpl && + (identical(other.id, id) || other.id == id)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, id); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ItemImplCopyWith<_$ItemImpl> get copyWith => + __$$ItemImplCopyWithImpl<_$ItemImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ItemImplToJson( + this, + ); + } +} + +abstract class _Item implements Item { + const factory _Item({required final int id}) = _$ItemImpl; + + factory _Item.fromJson(Map json) = _$ItemImpl.fromJson; + + @override + int get id; + @override + @JsonKey(ignore: true) + _$$ItemImplCopyWith<_$ItemImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart new file mode 100644 index 000000000..3c653e18c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart @@ -0,0 +1,18 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'item.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ItemImpl _$$ItemImplFromJson(Map json) => _$ItemImpl( + id: json['id'] as int, + ); + +Map _$$ItemImplToJson(_$ItemImpl instance) => + { + 'id': instance.id, + }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart new file mode 100644 index 000000000..17cfb1c01 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart @@ -0,0 +1 @@ +typedef Json = Map; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart new file mode 100644 index 000000000..802a23150 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart @@ -0,0 +1,29 @@ +import 'package:collection/collection.dart'; +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; +import '../../helpers/json.dart'; + +part 'async_values.g.dart'; + +/* SNIPPET START */ + +@riverpod +Future> itemsApi(ItemsApiRef ref) async { + final client = Dio(); + final result = await client.get>('your-favorite-api'); + final parsed = [...result.data!.map((e) => Item.fromJson(e as Json))]; + return parsed; +} + +@riverpod +List evenItems(EvenItemsRef ref) { + final asyncValue = ref.watch(itemsApiProvider); + if (asyncValue.isReloading) return []; + if (asyncValue.hasError) return const [Item(id: -1)]; + + final items = asyncValue.requireValue; + + return [...items.whereIndexed((index, element) => index.isEven)]; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart new file mode 100644 index 000000000..0765d3a65 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_values.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$itemsApiHash() => r'b32ccb7b85305e361d8ed752cbe11d9524c96190'; + +/// See also [itemsApi]. +@ProviderFor(itemsApi) +final itemsApiProvider = AutoDisposeFutureProvider>.internal( + itemsApi, + name: r'itemsApiProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$itemsApiHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ItemsApiRef = AutoDisposeFutureProviderRef>; +String _$evenItemsHash() => r'55ae98f9b6108203dfc4a139f1ade9fbd8ba8ddd'; + +/// See also [evenItems]. +@ProviderFor(evenItems) +final evenItemsProvider = AutoDisposeProvider>.internal( + evenItems, + name: r'evenItemsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$evenItemsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef EvenItemsRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx new file mode 100644 index 000000000..526f2dffe --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./async_values.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart new file mode 100644 index 000000000..1ca8987ef --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart @@ -0,0 +1,25 @@ +import 'package:collection/collection.dart'; +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; +import '../../helpers/json.dart'; + +/* SNIPPET START */ + +final itemsApiProvider = FutureProvider.autoDispose((ref) async { + final client = Dio(); + final result = await client.get>('your-favorite-api'); + final parsed = [...result.data!.map((e) => Item.fromJson(e as Json))]; + return parsed; +}); + +final evenItemsProvider = Provider.autoDispose((ref) { + final asyncValue = ref.watch(itemsApiProvider); + if (asyncValue.isLoading) return []; + if (asyncValue.hasError) return const [Item(id: -1)]; + + final items = asyncValue.requireValue; + + return [...items.whereIndexed((index, element) => index.isEven)]; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart new file mode 100644 index 000000000..9510dc2b8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart @@ -0,0 +1,24 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'auto_dispose.g.dart'; + +/* SNIPPET START */ // 对于代码生成，.autoDispose 是默认值 +@riverpod +int diceRoll(DiceRollRef ref) { + // 由于此提供者程序是 .autoDispose，因此取消监听将处置其当前公开的状态。 + // 然后，每当再次监听该提供者程序时，就会掷出新的骰子并再次暴露。 + final dice = Random().nextInt(10); + return dice; +} + +@riverpod +int cachedDiceRoll(CachedDiceRollRef ref) { + final coin = Random().nextInt(10); + if (coin > 5) throw Exception('Way too large.'); + // 上述条件可能会失败； + // 如果没有，以下指令会告诉提供者程序保持其缓存状态，即使没有人再监听它。 + ref.keepAlive(); + return coin; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart new file mode 100644 index 000000000..9397a920f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -0,0 +1,41 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'auto_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$diceRollHash() => r'dfd5ac8b74351a0076da9d131c10277f53ff11b9'; + +/// See also [diceRoll]. +@ProviderFor(diceRoll) +final diceRollProvider = AutoDisposeProvider.internal( + diceRoll, + name: r'diceRollProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$diceRollHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef DiceRollRef = AutoDisposeProviderRef; +String _$cachedDiceRollHash() => r'fc31fcb804f10360d75362e56329976343ee7abb'; + +/// See also [cachedDiceRoll]. +@ProviderFor(cachedDiceRoll) +final cachedDiceRollProvider = AutoDisposeProvider.internal( + cachedDiceRoll, + name: r'cachedDiceRollProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$cachedDiceRollHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef CachedDiceRollRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx new file mode 100644 index 000000000..6c57cfffd --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./auto_dispose.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart new file mode 100644 index 000000000..f7230ee09 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart @@ -0,0 +1,20 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +final diceRollProvider = Provider.autoDispose((ref) { + // 由于此提供者程序是 .autoDispose，因此取消监听将处置其当前公开的状态。 + // 然后，每当再次监听该提供者程序时，就会掷出新的骰子并再次暴露。 + final dice = Random().nextInt(10); + return dice.isEven; +}); + +final cachedDiceRollProvider = Provider.autoDispose((ref) { + final coin = Random().nextInt(10); + if (coin > 5) throw Exception('Way too large.'); + // 上述条件可能会失败； + // 如果没有，以下指令会告诉提供者程序保持其缓存状态，即使没有人再监听它。 + ref.keepAlive(); + return coin.isEven; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart new file mode 100644 index 000000000..ecd1915da --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart @@ -0,0 +1,19 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'combine.g.dart'; + +/* SNIPPET START */ + +@riverpod +int number(NumberRef ref) { + return Random().nextInt(10); +} + +@riverpod +int doubled(DoubledRef ref) { + final number = ref.watch(numberProvider); + + return number * 2; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart new file mode 100644 index 000000000..501f580ef --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'combine.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$numberHash() => r'725e25be57b9cc2bd914752f156e26a214596b63'; + +/// See also [number]. +@ProviderFor(number) +final numberProvider = AutoDisposeProvider.internal( + number, + name: r'numberProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$numberHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef NumberRef = AutoDisposeProviderRef; +String _$doubledHash() => r'ddc640c876bdbe49fe72fe1632b5ff48687c9279'; + +/// See also [doubled]. +@ProviderFor(doubled) +final doubledProvider = AutoDisposeProvider.internal( + doubled, + name: r'doubledProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$doubledHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef DoubledRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx new file mode 100644 index 000000000..2ff7dfbaa --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./combine.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart new file mode 100644 index 000000000..ad33636e7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart @@ -0,0 +1,15 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ + +final numberProvider = Provider.autoDispose((ref) { + return Random().nextInt(10); +}); + +final doubledProvider = Provider.autoDispose((ref) { + final number = ref.watch(numberProvider); + + return number * 2; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx new file mode 100644 index 000000000..4951f9b1a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx @@ -0,0 +1,434 @@ +--- +title: 动机 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import sameType from "./same_type"; +import combine from "./combine"; +import asyncValues from "./async_values"; +import autoDispose from "./auto_dispose"; +import override from "./override"; +import sideEffects from "./side_effects"; +import { + trimSnippet, + AutoSnippet, + When, +} from "@site/src/components/CodeSnippet"; + + +这篇深入的文章旨在说明为什么需要 Riverpod 的动机。 + + +特别是，本节应回答以下问题： + - 既然 Provider 广受欢迎，为什么要迁移到 Riverpod？ + - 我能获得哪些具体优势？ + - 如何迁移到 Riverpod？ + - 我可以增量迁移吗？ + - 等等…… + + +在本节结束时，您应该确信 Riverpod 优先于 Provider。 + + +**与 Provider 相比，Riverpod 确实是一种更现代、更推荐和更可靠的方法。** + + +Riverpod 提供更好的状态管理功能、更好的缓存策略和简化的响应式模型。 +然而，Provider 目前在许多领域都缺乏，没有前进的道路。 + + +## Provider 的局限性 + + +Provider 存在根本问题是由于受到 InheritedWidget API 的限制。 +从本质上讲，Provider 是一个“更简单的 `InheritedWidget`”; +Provider 只是一个 InheritedWidget 包装器，因此它受到它的限制。 + + +下面是已知的提供者程序问题列表。 + + +### 提供者程序不能保留两个（或多个）相同“类型”的提供者程序 + + +声明两个 `Provider` 将导致不可靠的行为： +`InheritedWidget` 的 API 只能获取*两者中的一个*：即最接近 `Provider` 的祖先。 +虽然 Provider 的文档中解释了[解决方法]，但 Riverpod 根本没有这个问题。 + + +通过消除这个限制，我们可以自由地将逻辑拆分为小块，如下所示： + + + + + +### 提供者程序一次合理地只发出一个值 + + +读取外部 RESTful API 时，通常会显示上次读取值，而新调用会加载下一个读取值。 +Riverpod 通过其 `AsyncValue` 的 API 一次发出两个值（即一个前一个数据值和一个传入的新加载值）来允许这种行为： + + + + +在前面的代码片段中，观察 `evenItemsProvider` 将产生以下效果： +1. 最初，正在发出请求。我们得到一个空列表； +1. 然后，假设发生错误。我们获得 `[Item(id: -1)]`； +1. 然后，我们使用拉取刷新逻辑重试请求（例如，通过 `ref.invalidate`）； +1. 当我们重新加载第一个提供者程序时，第二个提供者程序仍然公开 `[Item(id: -1)]`； +1. 这一次，一些解析后的数据被正确接收：我们的偶数项被正确返回。 + + +使用 Provider，上述功能无法远程实现，甚至更难解决。 + + +### 合并提供者程序很困难且容易出错 + + +对于 Provider，我们可能很想在 provider 的 `create` 中使用 `context.watch`。 +这将是不可靠的，因为即使没有依赖项发生更改（例如，当小部件树中涉及 GlobalKey 时）， +`didChangeDependencies` 也可能被触发。 + + +尽管如此，Provider 有一个名为 `ProxyProvider` 的临时解决方案，但它被认为是乏味且容易出错的。 + + +合并状态是 Riverpod 的核心机制，因为我们可以使用简单而强大的方法（如 [ref.watch] 和 [ref.listen]）以零开销组合和缓存值： + + + + +使用 Riverpod 组合值感觉很自然：依赖项是可读的，并且 API 保持不变。 + + + +### 缺乏安全性 + + +使用 Provider，在重构和/或大型更改期间以 `ProviderNotFoundException` 结束是很常见的。 +事实上，这个运行时异常*是*最初创建 Riverpod 的主要原因之一。 + + +尽管它带来了比这更多的实用性，但 Riverpod 根本无法抛出此异常。 + + +### 处置状态很困难 + + +`InheritedWidget` [无法对消费者程序停止监听他们的情况做出反应]。 +这可以防止提供者程序在不再使用时自动处置其提供者程序的状态。 +在使用 Provider 的情况下，[我们必须]依靠作用域提供者程序在停止使用状态时对其进行处置。 +但这并不容易，因为当在页面之间共享状态时，它会变得棘手。 + + +Riverpod 通过易于理解的 API（如 [autodispose] 和 [keepAlive]）解决了这个问题。 +这两个 API 支持灵活且创造性的缓存策略（例如基于时间的缓存）： + + + + + +不幸的是，没有办法用原始 `InheritedWidget` 的来实现这一点，因此没有办法用 Provider 来实现。 + + +### 缺乏可靠的参数化机制 + + +Riverpod 允许其用户使用 [`.family` 修饰符]声明“参数化”提供者程序。 +事实上，这是 Riverpod 最强大的功能之一，也是其创新的核心， +例如，`.family` 它能够极大地[简化逻辑]。 + + +如果我们想使用 Provider 实现类似的东西， +我们将不得不放弃这些参数的易用性*和*类型安全性。 + + +此外，无法使用 Provider 实现类似的 `.autoDispose` 机制 +本身就阻止了 `.family` 的任何等效实现，[因为这两个功能是齐头并进的]。 + + +最后，如前所述，[事实证明]，小部件*永远*不会停止收听 `InheritedWidget`。 +这意味着如果某些提供者程序状态是“动态挂载”的， +即当使用参数构建提供者程序时，则会出现严重的内存泄漏，而这正是 `.family` 这样做的。 +因此，目前从根本上不可能获得 Provider 的 `.family` 等价物。 + + +### 测试很乏味 + + +为了能够编写测试，您*必须*在每个测试中重新定义提供者程序。 + + +默认情况下，借助 Riverpod，提供者程序已准备好在内部测试中使用。 +此外，Riverpod 还公开了一组方便的“覆盖”的工具，这些实用程序在模拟提供者程序时至关重要。 + + +测试上面的组合状态代码段非常简单，如下所示： + + + + +有关测试的详细信息，请参阅[测试]。 + + + +### 引发副作用并不简单 + + +由于 `InheritedWidget` 没有 `onChange` 回调，因此 Provider 也没有回调。 +这对于导航来说是有问题的，例如小吃栏、模态等。 + + +相反，Riverpod 只是提供 `ref.listen`，它[与 Flutter 很好地集成在一起]。 + + + + +## 转向 Riverpod + + +从概念上讲，Riverpod 和 Provider 非常相似。 +这两个包都扮演着类似的角色。两者都尝试： + + +- 缓存和处置一些有状态对象； +- 提供一种在测试期间模拟这些对象的方法； +- 为 Widget 提供了一种以简单的方式监听这些对象的方法。 + + +你可以把 Riverpod 想象成 Provider 在几年内继续成熟时的样子。 + + +### 为什么要单独建包？ + + +最初，计划发布 Provider 的主要版本，以解决上述问题。 +但随后决定反对它，因为由于新的 `ConsumerWidget` API，这将“太麻烦”甚至有争议。 +由于 Provider 仍然是最常用的 Flutter 包之一，因此决定创建一个单独的包，因此创建了 Riverpod。 + + +启用创建单独的包： + - 通过*同时*临时使用这两种方法，为任何想要迁移的人提供便利； + - 如果人们原则上不喜欢 Riverpod，或者他们觉得它还不可靠，请允许他们坚持使用 Provider； + - 实验，允许 Riverpod 搜索生产就绪的解决方案，以应对各种提供者程序的技术限制。 + + +事实上，Riverpod 旨在成为 Provider 的精神继承者。因此得名“Riverpod”（它是“Provider”的字谜，异位词）。 + + +### 破坏性变化 + + +Riverpod 唯一真正的缺点是它需要更改小部件类型才能工作： + + +- 使用 Riverpod，您应该扩展 `ConsumerWidget`，而不是扩展 `StatelessWidget`。 +- 使用 Riverpod，您应该扩展 `ConsumerStatefulWidget`，而不是扩展 `StatefulWidget`。 + + +但这种不便在宏伟的计划中是相当小的。有朝一日，这种要求可能会消失。 + + +### 选择正确的库 + + +您可能会问自己：*“那么，作为 Provider 用户，我应该使用 Provider 还是 Riverpod？”* + + +我们想非常清楚地回答这个问题： + + + 您可能应该使用 Riverpod + + +Riverpod 总体上设计得更好，可以大大简化您的逻辑。 + +[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider +[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[autodispose]: /docs/concepts/modifiers/auto_dispose +[workaround]: https://pub.dev/packages/provider#can-i-obtain-two-different-providers-using-the-same-type +[.family modifier]: /docs/concepts/modifiers/family +[keepAlive]: /docs/concepts/modifiers/auto_dispose#refkeepalive +[as these two features go hand-in-hand]: /docs/concepts/modifiers/family#prefer-using-autodispose-when-the-parameter-is-not-constant +[simplification of logic]: /docs/concepts/modifiers/family#usage +[we have to]: https://github.com/flutter/flutter/issues/128432 +[it turns out]: https://github.com/flutter/flutter/issues/106549 +[can't react when a consumer stops listening to them]: https://github.com/flutter/flutter/issues/106546 +[Testing]: /docs/cookbooks/testing +[integrates well with Flutter]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change + +[解决方法]: https://pub.dev/packages/provider#can-i-obtain-two-different-providers-using-the-same-type +[无法对消费者程序停止监听他们的情况做出反应]: https://github.com/flutter/flutter/issues/106546 +[我们必须]: https://github.com/flutter/flutter/issues/128432 +[简化逻辑]: /docs/concepts/modifiers/family#usage +[`.family` 修饰符]: /docs/concepts/modifiers/family +[因为这两个功能是齐头并进的]: /docs/concepts/modifiers/family#prefer-using-autodispose-when-the-parameter-is-not-constant +[事实证明]: https://github.com/flutter/flutter/issues/106549 +[测试]: /docs/cookbooks/testing +[与 Flutter 很好地集成在一起]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx new file mode 100644 index 000000000..43ec56b51 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./override.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart new file mode 100644 index 000000000..860020903 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart @@ -0,0 +1,16 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../combine/combine.dart'; + +/* SNIPPET START */ + +void main() { + test('it doubles the value correctly', () async { + final container = ProviderContainer( + overrides: [numberProvider.overrideWith((ref) => 9)], + ); + final doubled = container.read(doubledProvider); + expect(doubled, 9 * 2); + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart new file mode 100644 index 000000000..4a7e2062f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart @@ -0,0 +1,15 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../combine/combine.dart'; + +/* SNIPPET START */ +void main() { + test('这个值将正确的翻倍', () async { + final container = ProviderContainer( + overrides: [numberProvider.overrideWith((ref) => 9)], + ); + final doubled = container.read(doubledProvider); + expect(doubled, 9 * 2); + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx new file mode 100644 index 000000000..8569e8316 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./same_type.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart new file mode 100644 index 000000000..dacfe9b9d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart @@ -0,0 +1,15 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; + +/* SNIPPET START */ + +final itemsProvider = Provider.autoDispose( + (ref) => [], // ... +); + +final evenItemsProvider = Provider.autoDispose((ref) { + final items = ref.watch(itemsProvider); + return [...items.whereIndexed((index, element) => index.isEven)]; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart new file mode 100644 index 000000000..94a4ab086 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart @@ -0,0 +1,19 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; + +part 'same_type.g.dart'; + +/* SNIPPET START */ + +@riverpod +List items(ItemsRef ref) { + return []; // ... +} + +@riverpod +List evenItems(EvenItemsRef ref) { + final items = ref.watch(itemsProvider); + return [...items.whereIndexed((index, element) => index.isEven)]; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart new file mode 100644 index 000000000..e421d5b6d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart @@ -0,0 +1,40 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'same_type.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$itemsHash() => r'f0a8fa6874f4868db9ead31e82c75d976f9d2033'; + +/// See also [items]. +@ProviderFor(items) +final itemsProvider = AutoDisposeProvider>.internal( + items, + name: r'itemsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$itemsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ItemsRef = AutoDisposeProviderRef>; +String _$evenItemsHash() => r'82b4525e91604745f2b4664531b32d4aff5717d4'; + +/// See also [evenItems]. +@ProviderFor(evenItems) +final evenItemsProvider = AutoDisposeProvider>.internal( + evenItems, + name: r'evenItemsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$evenItemsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef EvenItemsRef = AutoDisposeProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx new file mode 100644 index 000000000..f4797a94f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./side_effects.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart new file mode 100644 index 000000000..61f016870 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart @@ -0,0 +1,24 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../auto_dispose/auto_dispose.dart'; + +/* SNIPPET START */ + +class DiceRollWidget extends ConsumerWidget { + const DiceRollWidget({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(diceRollProvider, (previous, next) { + ScaffoldMessenger.of(context).showSnackBar( + SnackBar(content: Text('Dice roll! We got: $next')), + ); + }); + return TextButton.icon( + onPressed: () => ref.invalidate(diceRollProvider), + icon: const Icon(Icons.casino), + label: const Text('Roll a dice'), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart new file mode 100644 index 000000000..61f016870 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart @@ -0,0 +1,24 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../auto_dispose/auto_dispose.dart'; + +/* SNIPPET START */ + +class DiceRollWidget extends ConsumerWidget { + const DiceRollWidget({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(diceRollProvider, (previous, next) { + ScaffoldMessenger.of(context).showSnackBar( + SnackBar(content: Text('Dice roll! We got: $next')), + ); + }); + return TextButton.icon( + onPressed: () => ref.invalidate(diceRollProvider), + icon: const Icon(Icons.casino), + label: const Text('Roll a dice'), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx new file mode 100644 index 000000000..5b940ff80 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx @@ -0,0 +1,653 @@ +--- +title: Provider 对比 Riverpod +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import family from "./family"; +import { + trimSnippet, + AutoSnippet, + When, +} from "@site/src/components/CodeSnippet"; + + + +本文将介绍 Provider 和 Riverpod 之间的差异和相似之处。 + + +## 定义提供者程序 + + +这两个包之间的主要区别在于如何定义“提供者程序”。 + + +对于 [Provider]，提供者程序是小部件，因此放置在小部件树中，通常位于 `MultiProvider`： + +```dart +class Counter extends ChangeNotifier { + ... +} + +void main() { + runApp( + MultiProvider( + providers: [ + ChangeNotifierProvider(create: (context) => Counter()), + ], + child: MyApp(), + ) + ); +} +``` + + +使用 Riverpod，提供者程序**不是**小部件。相反，它们是普通的 Dart 对象。 +同样，提供者程序在小部件树之外定义，而且声明为全局 final 变量。 + + +此外，要使 Riverpod 正常工作，必须在整个应用程序上方添加一个小 `ProviderScope` 部件。 +因此，使用 Riverpod 和 Provider 示例等效的版本为： + +```dart +// provider 现在是顶级变量 +final counterProvider = ChangeNotifierProvider((ref) => Counter()); + +void main() { + runApp( + // 该小部件为整个项目启用了 Riverpod + ProviderScope( + child: MyApp(), + ), + ); +} +``` + + +请注意，这个 ChangeNotifierProvider 的定义只是向上移动了几行。 + +:::info + +由于 Riverpod 的提供者程序是普通的 Dart 对象，因此可以在没有 Flutter 的情况下使用 Riverpod。 +例如，Riverpod 可用于编写命令行应用程序。 +::: + + +## 读取提供者程序：使用 BuildContext + + +使用 Provider 库，读取提供者程序的一种方法是使用 Widget 的 `BuildContext`。 + + +例如，如果 provider 定义为： + +```dart +Provider(...); +``` + + +然后使用 [Provider] 读取它就可以这样做： + +```dart +class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + Model model = context.watch(); + + } +} +``` + + +在 Riverpod 中的等效代码是： + +```dart +final modelProvider = Provider(...); + +class Example extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + Model model = ref.watch(modelProvider); + + } +} +``` + + +请注意： + + +- Riverpod 的代码片段是扩展 `ConsumerWidget` 的，而不是 `StatelessWidget`。 + 不同的小部件类型为我们的 `build` 函数添加了一个额外的参数：`WidgetRef`。 + + +- 在 Riverpod 中我们使用 `WidgetRef.watch` 代替 `BuildContext.watch`， + `WidgetRef` 是我们从 `ConsumerWidget` 拿到的。 + + +- Riverpod 不依赖于泛型类型。相反，它依赖于使用提供者程序定义创建的变量。 + + +还要注意措辞的相似程度。Provider 和 Riverpod 都使用关键字“watch”来描述“当值更改时，这里的小部件应重新生成”。 + +:::info + +Riverpod 使用与 Provider 相同的术语来读取提供者程序。 + +- `BuildContext.watch` -> `WidgetRef.watch` +- `BuildContext.read` -> `WidgetRef.read` +- `BuildContext.select` -> `WidgetRef.watch(myProvider.select)` + + +`context.watch` 相对于 `context.read` 的规则也适用于 Riverpod： +在 `build` 方法中，使用 “watch”。在单击处理程序和其他事件中，使用 “read”。 +当需要过滤掉值并重新生成时，请使用 “select”。 +::: + + +## 读取提供者程序：使用 Consumer + + +Provider 可以选择附带一个名为 `Consumer`（以及名为 `Consumer2` 的变体）的小部件，用于读取提供者程序。 + + +`Consumer` 作为性能优化很有帮助，它允许对小部件树进行更精细的重建 - 在状态更改时仅更新相关的小部件： + + +因此，如果一个 provider 被定义为： + +```dart +Provider(...); +``` + + +Provider 允许使用 `Consumer` 读取这个 provider： + +```dart +Consumer( + builder: (BuildContext context, Model model, Widget? child) { + + } +) +``` + + +Riverpod 也有同样的原理。Riverpod 也有一个以完全相同功能的 `Consumer` 小部件。 + + +如果我们将一个 provider 定义为： + +```dart +final modelProvider = Provider(...); +``` + + +然后我们可以使用 `Consumer` 实现： + +```dart +Consumer( + builder: (BuildContext context, WidgetRef ref, Widget? child) { + Model model = ref.watch(modelProvider); + + } +) +``` + + +注意 `Consumer` 是如何给我们一个 `WidgetRef` 对象。这与我们在上一部分中看到的 `ConsumerWidget` 与相关的对象相同。 + + +### Riverpod 中没有 `ConsumerN` 等效的类 + + +请注意，在 Riverpod 中不需要 pkg:Provider 的 `Consumer2`、`Consumer3` 等，也不要遗漏重构它们。 + + +使用 Riverpod，如果要从多个提供者程序读取值，只需编写多个 ref.watch 语句即可，如下所示： + +```dart +Consumer( + builder: (context, ref, child) { + Model1 model = ref.watch(model1Provider); + Model2 model = ref.watch(model2Provider); + Model3 model = ref.watch(model3Provider); + // ... + } +) +``` + + +与 pkg:Provider 的 `ConsumerN` API 相比，上述解决方案感觉不那么沉重，应该更容易理解。 + + +## 组合提供者程序：ProxyProvider 与无状态对象 + + +使用 Provider 时，组合提供者程序的官方方法是使用 `ProxyProvider` widget（或变体，例如 `ProxyProvider2`）。 + + +例如，我们可以定义： + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +ChangeNotifierProvider(create: (context) => UserIdNotifier()), +``` + + +在这里我们有两个选择。我们可以组合 `UserIdNotifier` 创建一个新的“无状态”提供者程序 +（通常是一个可能覆盖 == 的不可变值）。如： + +```dart +ProxyProvider( + update: (context, userIdNotifier, _) { + return 'The user ID of the the user is ${userIdNotifier.userId}'; + } +) +``` + + +每当 `UserIdNotifier.userId` 发生更改时，这个提供者程序都会自动返回新的 `String` 值。 + + +我们可以在 Riverpod 中做类似的事情，但语法不同。 +首先，在 Riverpod 中，我们的 `UserIdNotifier` 定义是： + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +final userIdNotifierProvider = ChangeNotifierProvider( + (ref) => UserIdNotifier(), +); +``` + + +那样的话，要基于 `userId` 生成 `String`，我们可以这样做： + +```dart +final labelProvider = Provider((ref) { + UserIdNotifier userIdNotifier = ref.watch(userIdNotifierProvider); + return 'The user ID of the the user is ${userIdNotifier.userId}'; +}); +``` + + +请注意这行 ref.watch(userIdNotifierProvider) 做的事。 + + +这行代码告诉 Riverpod 获取 `userIdNotifierProvider` 的内容， +并且每当该值发生变化时， `labelProvider` 也会重新计算。 +因此，每当 `userId` 更改时， +我们 `labelProvider` 发出的 `String` 都会自动更新。 + + +这行 `ref.watch` 应该感觉很熟悉。 +之前在解释[如何在小部件中读取提供者程序](#读取-providersbuildcontext)时已经介绍了这个模式。 +事实上，提供者程序现在能够与小部件以相同的方式监听其他提供者程序的改变。 + + +## 组合提供者程序：ProxyProvider 与有状态对象 + + +组合提供者程序时，另一个替代用例是公开有状态对象，例如 `ChangeNotifier` 实例。 + + +为此，我们可以使用 `ChangeNotifierProxyProvider`（或变体，例如 `ChangeNotifierProxyProvider2`）。 +例如，我们可以定义： + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +ChangeNotifierProvider(create: (context) => UserIdNotifier()), +``` + + +然后，我们可以定义基于 `UserIdNotifier.userId` 的一个 `ChangeNotifier`。 +例如，我们可以这样做： + +```dart +class UserNotifier extends ChangeNotifier { + String? _userId; + + void setUserId(String? userId) { + if (userId != _userId) { + print('The user ID changed from $_userId to $userId'); + _userId = userId; + } + } +} + +// ... + +ChangeNotifierProxyProvider( + create: (context) => UserNotifier(), + update: (context, userIdNotifier, userNotifier) { + return userNotifier! + ..setUserId(userIdNotifier.userId); + }, +); +``` + + +这个新提供者程序会创建一个 `UserNotifier` 实例（它永远不会重新构造）， +并在用户 ID 更改时打印一个字符串。 + + +在提供者程序中执行相同的操作是以不同的方式实现的。 +首先，在 Riverpod 中，我们的 `UserIdNotifier` 是这样定义的： + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +final userIdNotifierProvider = ChangeNotifierProvider( + (ref) => UserIdNotifier(), +), +``` + + +相比于上面 `ChangeNotifierProxyProvider` 的等价代码将是： + +```dart +class UserNotifier extends ChangeNotifier { + String? _userId; + + void setUserId(String? userId) { + if (userId != _userId) { + print('The user ID changed from $_userId to $userId'); + _userId = userId; + } + } +} + +// ... + +final userNotifierProvider = ChangeNotifierProvider((ref) { + final userNotifier = UserNotifier(); + ref.listen( + userIdNotifierProvider, + (previous, next) { + if (previous?.userId != next.userId) { + userNotifier.setUserId(next.userId); + } + }, + ); + + return userNotifier; +}); +``` + + +这个片段的核心是 `ref.listen` 这行代码。 +这里的 `ref.listen` 函数是一个实用程序，它允许监听一个提供者程序， +并在提供者程序更改时执行函数。 + + +该函数的 `previous` 和 `next` 参数对应于提供者程序更改前的最后一个值和更改后的新值。 + + +## 作用域提供者程序与 `.family` + `.autoDispose` + + +在 pkg:Provider 中，作用域用于两件事： + - 离开页面时处置状态 + - 每页具有自定义状态 + + +仅使用作用域来破坏状态并不理想。 +问题在于，作用域在大型应用程序上效果不佳。 +例如，状态通常在一个页面中创建，但在导航后稍后在另一个页面中处置。 +这不允许多个缓存在不同的页面上处于活动状态。 + + +同样，如果需要与小部件树的另一部分共享状态， +“自定义每个页面状态”的方法很快就会变得难以处理， +就像你需要模态或多步骤表单一样。 + + +Riverpod 采取了不同的方法：首先，不鼓励使用作用域提供者； +其次， `.family` 和 `.autoDispose` 是完整的替代解决方案。 + + +在 Riverpod 中，当一个提供者程序标记为 `.autoDispose` 在不再使用时会自动处置的状态。 +当卸载最后一个删除提供者程序的小部件时，Riverpod 将检测到卸载并处置提供者程序。 +尝试在提供者程序中使用以下两种生命周期方法来测试此行为： + +```dart +ref.onCancel((){ + print("我一个监听程序都没有了！"); +}); +ref.onDispose((){ + print("如果我已经被定义为 `.autoDispose`，我将被处置！"); +}); +``` + + +这从本质上解决了“破坏状态”问题。 + + +此外，还可以将提供者程序标记为 `.family`（同时，也可以标记为 `.autoDispose`）。 +这样就可以将参数传递给提供者程序，从而在内部生成和跟踪多个提供者程序。 +换句话说，在传递参数时，*会为每个唯一参数创建一个唯一状态*。 + + + + + +这解决了“每页自定义状态”问题。实际上，还有另一个优点：这种状态不再绑定到一个特定的页面。 +相反，如果不同的页面尝试访问相同的状态，则该页面只需重用参数即可实现。 + + +在许多方面，将参数传递给提供者程序等同于 Map 的键。 +如果键相同，则获取的值相同。如果是不同的键，则将获得不同的状态。 + +[provider]: https://pub.dev/packages/provider +[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider +[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[autodispose]: /docs/concepts/modifiers/auto_dispose +[workaround]: https://pub.dev/packages/provider#can-i-obtain-two-different-providers-using-the-same-type +[.family modifier]: /docs/concepts/modifiers/family +[keepAlive]: /docs/concepts/modifiers/auto_dispose#refkeepalive +[as these two features go hand-in-hand]: /docs/concepts/modifiers/family#prefer-using-autodispose-when-the-parameter-is-not-constant +[simplification of logic]: /docs/concepts/modifiers/family#usage +[we have to]: https://github.com/flutter/flutter/issues/128432 +[it turns out]: https://github.com/flutter/flutter/issues/106549 +[*can't* react when a consumer stops listening to them]: https://github.com/flutter/flutter/issues/106546 +[integrates well with Flutter]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[ChangeNotifierProvider]: /docs/providers/change_notifier_provider +[Code generation]: /docs/about_code_generation +[AsyncNotifiers]: /docs/providers/notifier_provider +[combining Providers]: /docs/concepts/combining_providers +[global final variable]: /docs/concepts/providers#creating-a-provider diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx new file mode 100644 index 000000000..d98512916 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx @@ -0,0 +1,399 @@ +--- +title: 快速开始 +--- + +:::info +译者注：在此章节中，由于 Provider 库，Provider 类，Provider 及其相关的提供者程序类容易造成混淆，一般的，我们约定： +- Provider 库 -> `pkg:Provider` / `Provider`，和 Riverpod 一样首字母大写。 +- Provider 类 -> `provider`，小写，特指单纯的提供者程序类 Provider。 +- Provider 泛指 -> `提供者程序`，表示各种不同的提供者程序类都适用。 + +其他地方的代指某个 provider，会被具体翻译，避免不必要的误解，请放心阅读。 +如有翻译错误还请 pr 指正。 +::: + + +本部分专为熟悉 [Provider] 包并希望了解 Riverpod 的人员而设计。 + + +首先，请阅读简短的[入门指南]文章，并尝试使用小型[沙盒]示例来测试 Riverpod 的功能。 +如果您喜欢那里看到的内容，那么您应该明确考虑迁移。 + + +事实上，从 Provider 迁移到 Riverpod 可以非常简单。 + + +迁移基本上包括几个步骤，这些步骤可以以*增量*方式完成。 + + +## 从 `ChangeNotifierProvider` 开始 + + +在过渡到 Riverpod 时是可以的继续使用，而不是尽快使用 `ChangeNotifier` 其最新的花哨功能。 + + +事实上，可以从以下几点着手开始： + +```dart +// 如果你有这个…… +class MyNotifier extends ChangeNotifier { + int state = 0; + + void increment() { + state++; + notifyListeners(); + } +} + +// ……只需要加上这个！ +final myNotifierProvider = ChangeNotifierProvider((ref) { + return MyNotifier(); +}); +``` + + +正如你所看到的，Riverpod 公开了一个 [ChangeNotifierProvider] 类， +该类正是为了支持从 pkg:Provider 迁移。 + + +请记住，在编写新代码时不建议使用 `ChangeNotifierProvider`，因为它不是使用 Riverpod 的最佳方式， +但它是开始迁移的一种温和且非常简单的方法。 + +:::tip + +不要急于*立即*尝试将您的 `ChangeNotifier` 迁移到更现代的 [Riverpod 的提供者程序]。 +有些地方会进行一些泛型的转变，因此最初可能很难做到。 + + +慢慢来，因为首先熟悉 Riverpod 很重要； +你很快就会发现，几乎所有来自 pkg:provider 的提供者程序在 pkg:riverpod 中都有严格等价的代码。 +::: + + +## 从*叶子*开始 + + +从不依赖于其他任何内容的提供者程序开始，即从依赖项树中的*叶子*开始。 +迁移完所有叶子后，可以转到依赖于叶子的提供者程序。 + + +换言之，首先要避免迁移 `ProxyProvider`；当迁移了它们的所有依赖项，就可以开始处理它们了。 + + +这应该促进和简化迁移过程，同时还可以最大限度地减少/跟踪任何错误。 + + + +## Riverpod 和 Provider 可以共存 + + + +*请记住，完全可以同时使用 Provider 和 Riverpod。* + + +事实上，使用导入别名，可以同时使用两个 API 了。 +这也非常有助于提高可用性，并消除了任何模棱两可的 API 用法。 + + +如果计划执行此操作，请考虑对代码库中的每个提供者程序导入使用导入别名。 + +:::info + +关于如何有效实现导入别名的完整指南即将发布。 +::: + + + +## 您*不必*立即使用 `Consumer` + + +请务必记住，无需*立即*使用 [Riverpod 的 `Consumer` API]。 +如果您刚刚开始迁移，[如上所述]，您可能应该从 `ChangeNotifierProvider` 开始。 + + +考虑上面定义的 `myNotifierProvider`。 + + +由于您的内部代码可能依赖于 pkg:Provider 的 API，因此请使用以下代码开始使用 pkg:Riverpod 的 `ChangeNotifier`。 + +```dart +MultiProvider( + providers: [ + ChangeNotifierProvider.value(value: ref.watch(myNotifierProvider.notifier)), + ] +) +``` + + +这样，最初只需将根 Widget 转换为 `ConsumerWidget`。 +这应该会进一步简化向 pkg:Riverpod 的迁移。 + + + +## 一次迁移一个提供者程序 + + +如果您已有应用，请不要尝试一次迁移所有的提供者程序！ + + +虽然从长远来看，您应该努力将所有应用程序迁移到 Riverpod，**但不要让自己筋疲力尽**。 +一次只迁移一个提供者程序。 + + +以上面的例子为例。将其 `myNotifierProvider` **完全**迁移到 Riverpod 意味着需要编写以下内容： + +```dart +class MyNotifier extends Notifier { + @override + int build() => 0; + + void increment() => state++; +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); +``` + + +……并且_还_需要更改这个 `myNotifierProvider` 的使用方式，即每个 `context.watch` 的位置替换为 `ref.watch`。 + + +此操作可能需要一些时间，并可能导致一些错误，因此不要急于一次完成所有操作。 + + +## 迁移 `ProxyProvider` + + +在 pkg:Provider 中，`ProxyProvider` 用于组合来自其他提供者程序的值； +它的构建被动地取决于其他提供者程序的价值。 + + +相反，在 Riverpod 中，提供者程序[默认是可组合的]； +因此，在迁移 `ProxyProvider` 时，如果要声明从一个提供者程序到另一个提供者程序的直接依赖项，则只需编写 `ref.watch` 即可。 + + +如果有的话，将值与 Riverpod 相结合应该感觉更简单明了；因此，迁移应该大大简化代码。 + + +此外，将两个以上的提供者程序组合在一起没有任何障碍：只需添加另一个 `ref.watch`，就可以了。 + + +## 预先初始化 + + +由于 Riverpod 的提供者程序是全局 final 变量，因此它们[默认是懒加载的]。 + + +如果您需要在启动时初始化一些预热数据或有用的服务， +最好的做法是首次读取提供者程序的时候，您手动去设置 `MultiProvider`。 + + +换句话说，由于 Riverpod 不能被强制预先初始化，因此可以在启动阶段读取和缓存它们， +以便在应用程序的其余部分需要时它们完成了初始化并准备就绪。 + + +有关 pkg:Riverpod 提供者程序的快速初始化的完整指南 [可在此处获得]。 + + +## 代码生成 + + +建议使用[代码生成]，以便以*面向未来*的方式使用 Riverpod。 +顺便说一句，当元编程成为现实的时候，代码生成很可能是 Riverpod 的默认代码。 + + +不幸的是， `@riverpod` 无法为 `ChangeNotifierProvider` 生成代码。 +要解决此问题，您可以使用以下实用程序扩展方法： + +```dart +extension ChangeNotifierWithCodeGenExtension on Ref { + T listenAndDisposeChangeNotifier(T notifier) { + notifier.addListener(notifyListeners); + onDispose(() => notifier.removeListener(notifyListeners)); + onDispose(notifier.dispose); + return notifier; + } +} +``` + + +然后，您可以使用以下代码生成语法公开您的 `ChangeNotifier`： + +```dart +// ignore_for_file: unsupported_provider_value +@riverpod +MyNotifier example(ExampleRef ref) { + return ref.listenAndDisposeChangeNotifier(MyNotifier()); +} +``` + + +完成“基本”迁移后，您可以将 `ChangeNotifier` 更改为 `Notifier`，从而消除了临时扩展的需要。 +以前面的示例为例，“完全迁移” `Notifier` 变为： + +```dart +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() => 0; + + void increment() => state++; +} +``` + + +一旦完成此操作，并且您确信代码库中不再有 `ChangeNotifierProvider`，您就可以彻底摆脱临时扩展。 + + +请记住，虽然是推荐的，但代码生成不是*强制性的*。 +以增量方式进行迁移是个好的选择： +如果您觉得在一次转换到代码生成语法的*同时*实现此迁移可能太麻烦了，*别勉强*。 + + +按照本指南，您*可以*稍后做进一步的迁移到代码生成。 + +[getting started]: /docs/introduction/getting_started +[sandbox]: https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2 +[provider]: https://pub.dev/packages/provider +[ChangeNotifierProvider]: /docs/providers/change_notifier_provider +[Code generation]: /docs/concepts/about_code_generation +[Riverpod's providers]: /docs/providers/notifier_provider +[are composable by default]: /docs/from_provider/motivation#combining-providers-is-hard-and-error-prone +[as mentioned above]: /docs/from_provider/quickstart#start-with-changenotifierprovider +[Riverpod's `Consumer` APIs]: /docs/concepts/reading +[lazy by default]: /docs/concepts/provider_lifecycles + +[入门指南]: /docs/introduction/getting_started +[沙盒]: https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2 + +[默认是可组合的]: /docs/from_provider/motivation#combining-providers-is-hard-and-error-prone +[如上所述]: /docs/from_provider/quickstart#从-changenotifierprovider-开始 +[Riverpod 的 `Consumer` API]: /docs/concepts/reading +[默认是懒加载的]: /docs/concepts/provider_lifecycles +[代码生成]: /docs/concepts/about_code_generation +[Riverpod 的提供者程序]: /docs/providers/notifier_provider \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started.mdx deleted file mode 100644 index 9287f10af..000000000 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started.mdx +++ /dev/null @@ -1,189 +0,0 @@ ---- -title: 开始上手 -version: 3 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import pubspec from "./getting_started/pubspec"; -import dartHelloWorld from "./getting_started/dart_hello_world"; -import pubadd from "./getting_started/pub_add"; -import helloWorld from "./getting_started/hello_world"; -import dartPubspec from "./getting_started/dart_pubspec"; -import dartPubadd from "./getting_started/dart_pub_add"; -import { - trimSnippet, - AutoSnippet, - When, -} from "../../../../src/components/CodeSnippet"; - ---- - -## 在线尝试 Riverpod - -在 [Dartpad](https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2) 上感受 Riverpod 的魅力。 - -## 安装包文件 - -当你确定好你想要安装的包文件后，像这样继续将依赖添加到你的应用中： - - - - - - - - - - - - - - - - -当然，你也可以手动将依赖添加到应用中的`pubspec.yaml`： - - - - - - -然后使用 `flutter pub get` 命令来安装包文件。 - - - 最后，运行代码生成器 {" "} - flutter pub run build_runner watch - - - - - - - -然后使用 `dart pub get` 命令来安装包文件。 - - - 最后，运行代码生成器 {" "} - flutter pub run build_runner watch - - - - - -就是这样，你已成功将 [Riverpod] 添加到你的应用当中! - -## 启用 riverpod_lint/custom_lint - -Riverpod 附带一个可选的 [riverpod_lint] 包， -它提供了lint规则来帮助你编写更好的代码且提供了一些自定义重构选项。 - -如果遵循了上一步骤，那你应该已经安装好这个包了，但需要额外的步骤来启用它。 - -为了开启 [riverpod_lint]，你需要向你的 `pubspc.yaml` 旁边新建一个 `analysis_options.yaml` 配置 -并包含下面的内容： - - - {`analyzer: - plugins: - - custom_lint`} - - -如果你使用riverpod并在代码中写错了，那么就会在IDE中看到一些警告信息。 - -前往 [riverpod_lint] 页面查看更多关于警告信息和重构的内容。 - -:::note -用 `dart analyze` 命令这些警告不会显示。 -如果你想在CI或者终端中检查这些警告信息，你可以运行： - -```sh -dart run custom_lint -``` - -::: - -## 使用示例: Hello world - -安装完 [Riverpod]，我们就可以使用了。 - -下面的代码片段展示了如何使用我们的新依赖来创建一个 "Hello world"： - -export const foo = 42; - - - - - - -你可以使用 `flutter run` 命令来运行。 -这会在你的设备上渲染 "Hello world" 的文字。 - - - - - - -你可以使用 `dart lib/main.dart` 命令来运行。 -这会在你的控制台打印 "Hello world" 的字样。 - - - - -## 更进一步：安装代码片段插件 - -如果你使用 `Flutter` 和 `VS Code`，推荐使用 [Flutter Riverpod Snippets](https://marketplace.visualstudio.com/items?itemName=robert-brunhage.flutter-riverpod-snippets) - -如果你使用 `Flutter` 和 `Android Studio` 或 `IntelliJ`，推荐使用 [Flutter Riverpod Snippets](https://plugins.jetbrains.com/plugin/14641-flutter-riverpod-snippets) - -![img](/img/snippets/greetingProvider.gif) - -## 选择你的下一步 - -学习一些基础的概念: - -- [了解更多关于 provider 的内容](/docs/concepts/providers) - -遵循专题手册： - -- [如何测试 provider](/docs/cookbooks/testing) - -[riverpod]: https://github.com/rrousselgit/riverpod -[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod -[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod -[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks -[riverpod_lint]: https://pub.dev/packages/riverpod_lint diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_pub_add.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_pub_add.tsx deleted file mode 100644 index 73bf922c8..000000000 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_pub_add.tsx +++ /dev/null @@ -1,10 +0,0 @@ -const raw = "dart pub add riverpod dev:custom_lint dev:riverpod_lint"; - -const codegen = "dart pub add riverpod dev:custom_lint dev:riverpod_lint riverpod_annotation dev:build_runner dev:riverpod_generator"; - -export default { - raw, - hooks: raw, - codegen, - hooksCodegen: codegen, -}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/pub_add.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/pub_add.tsx deleted file mode 100644 index e72171523..000000000 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/pub_add.tsx +++ /dev/null @@ -1,14 +0,0 @@ -const raw = "flutter pub add flutter_riverpod dev:custom_lint dev:riverpod_lint"; - -const codegen = "flutter pub add flutter_riverpod dev:custom_lint dev:riverpod_lint riverpod_annotation dev:build_runner dev:riverpod_generator"; - -const hooks = "flutter pub add hooks_riverpod dev:custom_lint dev:riverpod_lint"; - -const hooksCodegen = "flutter pub add hooks_riverpod dev:custom_lint dev:riverpod_lint riverpod_annotation dev:build_runner dev:riverpod_generator"; - -export default { - raw: raw, - hooks: hooks, - codegen: codegen, - hooksCodegen: hooksCodegen -}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction.mdx deleted file mode 100644 index c0d1c81dd..000000000 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: 介绍 ---- - ---- - -## 什么是 Riverpod? - -Riverpod ([Provider](https://pub.dev/packages/provider) 的回文) 是 Flutter / Dart 平台的一个响应式缓存框架。它能自动获取、缓存、合并和计算网络请求，同时还会为你处理错误。 - -## 动机 - -现代的应用程序很少带有用户界面所需要的所有信息。一般来说，那些数据会从服务器异步获取。 - -但问题是，处理异步代码是比较困难的。虽然说 Flutter 本身提供了一些存储状态的方法，但除此之外， -它并没有其他额外的功能。因此，有许多问题仍然没有解决方案： - -- 异步请求需要在本地缓存，因为只要 UI 刷新就重新执行请求的做法是不合理的。 -- 由于缓存的存在，如果我们不小心可能会导致缓存过期。 -- 我们也需要处理错误和加载中的各种状态。 - -大规模解决问题会比较困难，而且它们受到了许多功能的影响，比如： - -- 下拉刷新 -- 列表滚动加载 -- 在键入时搜索 -- 异步请求防抖 -- 当不再需要时取消异步请求 -- 积极的界面更新 -- 离线模式 -- ... - -虽然实现这些功能很棘手，但这对一个良好的用户体验至关重要。 -然而很少有其他包文件试图直接解决这些问题，而且大量的样板代码需要手工完成。 - -这就是 Riverpod 的由来。 -受 Flutter 组件的启发，Riverpod 尝试通过一种独特的方式来写业务逻辑，进而来解决这些问题。 -对于状态来说，在许多方面 Riverpod 都可以类比于组件。 - -采用这种新的方式，上述复杂的功能大多都已默认被实现。你要做的只不过是关注 UI 实现。 - -不信？这里有一个例子。下面的代码片段是使用 Riverpod 的一个简化的 [Pub.dev](https://github.com/rrousselGit/riverpod/tree/master/examples/pub) -客户端应用。 - -```dart -// 从 pub.dev 获取包文件列表 -@riverpod -Future> fetchPackages( - FetchPackagesRef ref, { - required int page, - String search = '', -}) async { - final dio = Dio(); - // 请求 API。这里我们用了 dio，当然你也可以使用任何其他的网络请求库。 - final response = await dio.get( - 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', - ); - - // 将返回的 JSON 解码到 Dart 的对象。 - final json = response.data as List; - return json.map(Package.fromJson).toList(); -} -``` - -这段代码就是你要实现 “在键入时搜索” + “下拉刷新” + “无限列表” 功能所需的全部业务逻辑，同时还可以处理错误及加载中的状态。 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx new file mode 100644 index 000000000..42aadaa34 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx @@ -0,0 +1,296 @@ +--- +title: 入门指南 +pagination_next: essentials/first_request +version: 4 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import pubspec from "./getting_started/pubspec"; +import dartHelloWorld from "./getting_started/dart_hello_world"; +import pubadd from "./getting_started/pub_add"; +import helloWorld from "./getting_started/hello_world"; +import dartPubspec from "./getting_started/dart_pubspec"; +import dartPubadd from "./getting_started/dart_pub_add"; +import { + AutoSnippet, + When, +} from "@site/src/components/CodeSnippet"; +import { Link } from "@site/src/components/Link"; + + +## 在线尝试 Riverpod + + +要尝试 Riverpod，请在 [Dartpad](https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2) +或 [Zapp](https://zapp.run/new) 上在线试用： + + + + +## 安装包 + + +知道要安装哪个包后，请继续在一行中将依赖项添加到应用，如下所示： + + + + + + + + + + + + + + + + + +或者，您可以从以下 pubspec.yaml 位置手动将依赖项添加到您的应用： + + + + + + + +然后，使用 `flutter pub get` 安装包。 + + + + 现在你可以运行代码生成工具 {" "} + dart run build_runner watch. + + + + + + + + +然后，使用 `dart pub get` 安装包。 + + + + 现在你可以运行代码生成工具 {" "} + dart run build_runner watch. + + + + + + +就是这样。你已将 [Riverpod] 添加到你的应用中！ + + +## 启用 riverpod_lint/custom_lint + + +Riverpod 附带一个可选的 riverpod_lint 包， +该包提供 lint 规则以帮助您编写更好的代码， +并提供自定义重构选项。 + + +如果按照前面的步骤操作，则应该已经安装了该包， +但需要单独的步骤才能启用它。 + + +要启用riverpod_lint，您需要在 `pubspec.yaml` 文件的旁边添加一个 +`analysis_options.yaml` 文件，并包含以下内容： + + + {`analyzer: + plugins: + - custom_lint`} + + + +现在，如果在代码库中使用 Riverpod 时出错，您应该会在 IDE 中看到警告。 + + +要查看警告和重构的完整列表，请前往 [riverpod_lint] 页面。 + + +:::note +这些警告不会显示在 `dart analyze` 命令的结果中。 +如果要在 CI 或终端中检查这些警告，可以运行以下命令： + +```sh +dart run custom_lint +``` + +::: + + +## 使用示例：Hello world + + +现在我们已经安装了 [Riverpod]，我们可以开始使用它了。 + + +以下代码片段展示了如何使用我们的新依赖项来创建 “Hello world”： + +export const foo = 42; + + + + + + + +然后，使用 `flutter run` 启动应用程序。 +这将在您的设备上呈现 “Hello world”。 + + + + + + + +然后，使用 `dart lib/main.dart` 启动应用程序。 +这将在控制台中打印 “Hello world”。 + + + + + +## 更进一步：安装代码片段 + + +如果你使用的 `Flutter` 是 `VS Code` ，请考虑使用 [Flutter Riverpod Snippets](https://marketplace.visualstudio.com/items?itemName=robert-brunhage.flutter-riverpod-snippets) + + +如果您使用的 `Flutter` 是 `Android Studio` 或 `IntelliJ` ，请考虑使用 [Flutter Riverpod Snippets](https://plugins.jetbrains.com/plugin/14641-flutter-riverpod-snippets) + +![img](/img/snippets/greetingProvider.gif) + + +## 选择你的下一步 + + +了解一些基本概念： + +- + + +跟着教程走： + +- + +[riverpod]: https://github.com/rrousselgit/riverpod +[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod +[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod +[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks +[riverpod_lint]: https://pub.dev/packages/riverpod_lint diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/index.tsx similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/index.tsx rename to website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/index.tsx diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart new file mode 100644 index 000000000..87b2e0cd8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart @@ -0,0 +1,25 @@ +// ignore_for_file: avoid_print + +/* SNIPPET START */ + +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'main.g.dart'; + +// 我们创建了一个 "provider"，它可以存储一个值（这里是 "Hello world"）。 +// 通过使用提供者程序，这可以允许我们模拟或者覆盖一个暴露的值。 +@riverpod +String helloWorld(HelloWorldRef ref) { + return 'Hello world'; +} + +void main() { + // 这个对象是我们的提供者程序的状态将被存储的地方。 + final container = ProviderContainer(); + + // 多亏有了 "container"，我们可以读取我们的提供者程序。 + final value = container.read(helloWorldProvider); + + print(value); // Hello world +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart new file mode 100644 index 000000000..a7cc420dc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'main.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +/// See also [helloWorld]. +@ProviderFor(helloWorld) +final helloWorldProvider = AutoDisposeProvider.internal( + helloWorld, + name: r'helloWorldProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef HelloWorldRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart new file mode 100644 index 000000000..4efa17abd --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart @@ -0,0 +1,19 @@ +// ignore_for_file: avoid_print + +/* SNIPPET START */ + +import 'package:riverpod/riverpod.dart'; + +// 我们创建了一个 "provider"，它可以存储一个值（这里是 "Hello world"）。 +// 通过使用提供者程序，这可以允许我们模拟或者覆盖一个暴露的值。 +final helloWorldProvider = Provider((_) => 'Hello world'); + +void main() { + // 这个对象是我们的提供者程序的状态将被存储的地方。 + final container = ProviderContainer(); + + // 多亏有了 "container"，我们可以读取我们的提供者程序。 + final value = container.read(helloWorldProvider); + + print(value); // Hello world +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx new file mode 100644 index 000000000..07c03cf6b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx @@ -0,0 +1,32 @@ +export function buildDeps({ + deps = [], + devDeps = [], +}: { + deps?: string[]; + devDeps?: string[]; +}) { + var result = ""; + for (const dep of deps) { + result += `dart pub add ${dep}\n`; + } + + for (const dep of [...devDeps, "custom_lint", "riverpod_lint"]) { + result += `dart pub add dev:${dep}\n`; + } + + return result; +} + +const raw = buildDeps({ deps: ["riverpod"] }); + +const codegen = buildDeps({ + deps: ["riverpod", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx new file mode 100644 index 000000000..7860548a1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx @@ -0,0 +1,40 @@ +import { + riverpodVersion, + riverpodAnnotationVersion, + riverpodGeneratorVersion, + riverpodLintVersion, +} from "@site/src/versions"; + +const codegen = `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + riverpod: ^${riverpodVersion} + riverpod_annotation: ^${riverpodAnnotationVersion} + +dev_dependencies: + build_runner: + custom_lint: + riverpod_generator: ^${riverpodGeneratorVersion} + riverpod_lint: ^${riverpodLintVersion} +`; + +const raw = `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + riverpod: ^${riverpodVersion} + +dev_dependencies: + custom_lint: + riverpod_lint: ^${riverpodLintVersion} +`; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart new file mode 100644 index 000000000..d605ea202 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart @@ -0,0 +1,46 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +/* SNIPPET START */ import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'main.g.dart'; + +// 我们创建了一个 "provider"，它可以存储一个值（这里是 "Hello world"）。 +// 通过使用提供者程序，这可以允许我们模拟或者覆盖一个暴露的值。 +@riverpod +String helloWorld(HelloWorldRef ref) { + return 'Hello world'; +} + +void main() { + runApp( + // 为了使小组件可以读取提供者程序， + // 我们需要将整个应用程序包装在“ProviderScope”小部件中。 + // 这是我们的提供者程序的状态将被存储的地方。 + ProviderScope( + child: MyApp(), + ), + ); +} + +// 继承父类使用 HookConsumerWidget 替代 HookWidget，这样可以获取到提供者程序的引用 +class MyApp extends HookConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 我们可以在 HookConsumerWidget 中使用钩子函数 + final counter = useState(0); + + final String value = ref.watch(helloWorldProvider); + + return MaterialApp( + home: Scaffold( + appBar: AppBar(title: const Text('Example')), + body: Center( + child: Text('$value ${counter.value}'), + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart new file mode 100644 index 000000000..a7cc420dc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'main.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +/// See also [helloWorld]. +@ProviderFor(helloWorld) +final helloWorldProvider = AutoDisposeProvider.internal( + helloWorld, + name: r'helloWorldProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef HelloWorldRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx new file mode 100644 index 000000000..3f10c2a94 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx @@ -0,0 +1,11 @@ +import raw from "!!raw-loader!./raw.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; +import codegen from "!!raw-loader!./main.dart"; +import hooksCodegen from "!!raw-loader!./hooks_codegen/main.dart"; + +export default { + raw, + hooks: raw_hooks, + codegen, + hooksCodegen: hooksCodegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart new file mode 100644 index 000000000..6ee5a4bdf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart @@ -0,0 +1,42 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +/* SNIPPET START */ import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'main.g.dart'; + +// 我们创建了一个 "provider"，它可以存储一个值（这里是 "Hello world"）。 +// 通过使用提供者程序，这可以允许我们模拟或者覆盖一个暴露的值。 +@riverpod +String helloWorld(HelloWorldRef ref) { + return 'Hello world'; +} + +void main() { + runApp( + // 为了使小组件可以读取提供者程序， + // 我们需要将整个应用程序包装在“ProviderScope”小部件中。 + // 这是我们的提供者程序的状态将被存储的地方。 + ProviderScope( + child: MyApp(), + ), + ); +} + +// 继承父类使用 ConsumerWidget 替代 StatelessWidget，这样可以获取到提供者程序的引用 +class MyApp extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final String value = ref.watch(helloWorldProvider); + + return MaterialApp( + home: Scaffold( + appBar: AppBar(title: const Text('Example')), + body: Center( + child: Text(value), + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart new file mode 100644 index 000000000..a7cc420dc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'main.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +/// See also [helloWorld]. +@ProviderFor(helloWorld) +final helloWorldProvider = AutoDisposeProvider.internal( + helloWorld, + name: r'helloWorldProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$helloWorldHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef HelloWorldRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart similarity index 52% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/raw.dart rename to website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart index 307a104e5..7ad09874f 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart @@ -1,26 +1,24 @@ // ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types -/* SNIPPET START */ - -import 'package:flutter/material.dart'; +/* SNIPPET START */ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -// 우리는 값을 저장할 "provider"를 만들겁니다(여기서 값은 "Hello world"를 의미합니다). -// 프로바이더를 사용하는 것으로 값의 mock/override가 가능하게 됩니다. +// 我们创建了一个 "provider"，它可以存储一个值（这里是 "Hello world"）。 +// 通过使用提供者程序，这可以允许我们模拟或者覆盖一个暴露的值。 final helloWorldProvider = Provider((_) => 'Hello world'); void main() { runApp( - // 위젯에서 프로바이더를 사용하고 읽기위해 - // 앱 전체적으로 "ProviderScope" 위젯을 감싸줘야 합니다. - // 여기에 프로바이더의 상태가 저장됩니다. + // 为了使小组件可以读取提供者程序， + // 我们需要将整个应用程序包装在“ProviderScope”小部件中。 + // 这是我们的提供者程序的状态将被存储的地方。 ProviderScope( child: MyApp(), ), ); } -// StatelessWidget 대신에 Riverpod의 ConsumerWidget을 상속받아 사용합니다. +// 继承父类使用 ConsumerWidget 替代 StatelessWidget，这样可以获取到提供者程序的引用 class MyApp extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart new file mode 100644 index 000000000..d2d085319 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart @@ -0,0 +1,40 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +/* SNIPPET START */ import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +// 我们创建了一个 "provider"，它可以存储一个值（这里是 "Hello world"）。 +// 通过使用提供者程序，这可以允许我们模拟或者覆盖一个暴露的值。 +final helloWorldProvider = Provider((_) => 'Hello world'); + +void main() { + runApp( + // 为了使小组件可以读取提供者程序， + // 我们需要将整个应用程序包装在“ProviderScope”小部件中。 + // 这是我们的提供者程序的状态将被存储的地方。 + ProviderScope( + child: MyApp(), + ), + ); +} + +// 继承父类使用 HookConsumerWidget 替代 HookWidget，这样可以获取到提供者程序的引用 +class MyApp extends HookConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 我们可以在 HookConsumerWidget 中使用钩子函数 + final counter = useState(0); + + final String value = ref.watch(helloWorldProvider); + + return MaterialApp( + home: Scaffold( + appBar: AppBar(title: const Text('Example')), + body: Center( + child: Text('$value ${counter.value}'), + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx new file mode 100644 index 000000000..65c7be1bd --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx @@ -0,0 +1,39 @@ +export function buildDeps({ + deps = [], + devDeps = [], +}: { + deps?: string[]; + devDeps?: string[]; +}) { + var result = ''; + for (const dep of deps) { + result += `flutter pub add ${dep}\n`; + } + + for (const dep of [...devDeps, "custom_lint", "riverpod_lint"]) { + result += `flutter pub add dev:${dep}\n`; + } + + return result; +} + +const raw = buildDeps({ deps: ["flutter_riverpod"] }); + +const codegen = buildDeps({ + deps: ["flutter_riverpod", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +const hooks = buildDeps({ deps: ["hooks_riverpod", "flutter_hooks"] }); + +const hooksCodegen = buildDeps({ + deps: ["hooks_riverpod", "flutter_hooks", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +export default { + raw: raw, + hooks: hooks, + codegen: codegen, + hooksCodegen: hooksCodegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/pubspec.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx similarity index 79% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/pubspec.tsx rename to website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx index 0f182e500..151a203a6 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/pubspec.tsx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx @@ -4,13 +4,12 @@ import { riverpodAnnotationVersion, riverpodGeneratorVersion, riverpodLintVersion, -} from "../../../../../src/versions"; +} from "@site/src/versions"; function plain(riverpod: string) { - return ` -name: my_app_name + return `name: my_app_name environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0 <4.0.0" flutter: ">=3.0.0" dependencies: @@ -25,10 +24,9 @@ dev_dependencies: } function codegen(riverpod: string) { - return ` -name: my_app_name + return `name: my_app_name environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0 <4.0.0" flutter: ">=3.0.0" dependencies: @@ -47,7 +45,7 @@ dev_dependencies: export default { raw: plain(`flutter_riverpod: ^${flutterRiverpodVersion}`), - hooks: plain(`hooks_riverpod: ^${hooksRiverpodVersion}`), + hooks: plain(`hooks_riverpod: ^${hooksRiverpodVersion}\n flutter_hooks:`), codegen: codegen(`flutter_riverpod: ^${flutterRiverpodVersion}`), - hooksCodegen: codegen(`hooks_riverpod: ^${hooksRiverpodVersion}`), + hooksCodegen: codegen(`hooks_riverpod: ^${hooksRiverpodVersion}\n flutter_hooks:`), }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx new file mode 100644 index 000000000..942359f25 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx @@ -0,0 +1,125 @@ +--- +title: 为什么选择 Riverpod？ +version: 1 +--- + +import whyRiverpod from "./why_riverpod"; +import { AutoSnippet } from "@site/src/components/CodeSnippet"; + + +## 什么是 Riverpod？ + + +Riverpod（[Provider](https://pub.dev/packages/provider) 的异序词）是 Flutter/Dart 的反应式缓存框架。 + + +Riverpod 使用声明式和反应式编程，为您处理应用程序的大部分逻辑。 +它可以通过内置的错误处理和缓存来执行网络请求，同时在必要时自动重新获取数据。 + + +## 动机 + + +现代应用程序很少提供呈现其用户界面所需的所有信息。 +相反，数据通常是从服务器异步获取的。 + + +问题是，使用异步代码很困难。 +尽管 Flutter 提供了一些创建状态变量并在更改时刷新 UI 的方法，但它仍然相当有限。 +许多挑战仍未解决： + + +- 异步请求需要在本地缓存，因为每当 UI 更新时就重新执行异步请求是不合理的。 +- 由于我们有一个缓存，如果我们不关心的话，我们的缓存可能会过时。 +- 我们还需要处理错误和加载状态。 + + +大规模解决这些问题可能很困难，并且它们会受到大量功能的影响，例如： + + +- 下拉刷新 +- 无限列表/上划加载 +- 键入时搜索 +- 对异步请求进行去抖动 +- 不再使用异步请求时取消异步请求 +- 乐观 UI （注：主动积极的更新 UI 以实现良好的用户体验） +- 离线模式 +- …… + + +这些功能可能很难实现，但对于良好的用户体验至关重要。 +然而，很少有软件包尝试直接解决这些问题，而且很多工作必须手动完成。 + + +这就是 Riverpod 的用武之地。 +Riverpod 试图通过提供一种新的、独特的业务逻辑编写方式来解决这些问题， +这种方式的灵感来自 Flutter 小部件。 +在许多方面，Riverpod 可以与小部件相媲美，但仅限于状态管理。 + + +使用这种新方法，这些复杂的功能大多是默认完成的。 +剩下的就是专注于你的 UI。 + + +不信？举个例子。 +以下代码片段是使用 Riverpod 实现的 Pub.dev 客户端应用程序的简化版本。 + + + + +此代码片段是在处理错误/加载状态时，“键入时搜索”+“下拉刷新”+“无限列表”所需的所有业务逻辑。 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart new file mode 100644 index 000000000..0e0853f30 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart @@ -0,0 +1,29 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class Package { + static Package fromJson(dynamic json) { + throw UnimplementedError(); + } +} + +/* SNIPPET START */ // 从 pub.dev 获取包列表 +@riverpod +Future> fetchPackages( + FetchPackagesRef ref, { + required int page, + String search = '', +}) async { + final dio = Dio(); + // 获取 API。 这里我们使用 package:dio，但我们可以使用其他任何东西。 + final response = await dio.get>( + 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', + ); + + // 将 JSON 响应解码为 Dart 类。 + return response.data?.map(Package.fromJson).toList() ?? const []; +}/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart new file mode 100644 index 000000000..8f63ec36f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart @@ -0,0 +1,227 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$fetchPackagesHash() => r'eebf7d838a57f493fffebfd2c8d8ab76d3233165'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// See also [fetchPackages]. +@ProviderFor(fetchPackages) +const fetchPackagesProvider = FetchPackagesFamily(); + +/// See also [fetchPackages]. +class FetchPackagesFamily extends Family { + /// See also [fetchPackages]. + const FetchPackagesFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'fetchPackagesProvider'; + + /// See also [fetchPackages]. + FetchPackagesProvider call({ + required int page, + String search = '', + }) { + return FetchPackagesProvider( + page: page, + search: search, + ); + } + + @visibleForOverriding + @override + FetchPackagesProvider getProviderOverride( + covariant FetchPackagesProvider provider, + ) { + return call( + page: provider.page, + search: provider.search, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith( + FutureOr> Function(FetchPackagesRef ref) create) { + return _$FetchPackagesFamilyOverride(this, create); + } +} + +class _$FetchPackagesFamilyOverride implements FamilyOverride { + _$FetchPackagesFamilyOverride(this.overriddenFamily, this.create); + + final FutureOr> Function(FetchPackagesRef ref) create; + + @override + final FetchPackagesFamily overriddenFamily; + + @override + FetchPackagesProvider getProviderOverride( + covariant FetchPackagesProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [fetchPackages]. +class FetchPackagesProvider extends AutoDisposeFutureProvider> { + /// See also [fetchPackages]. + FetchPackagesProvider({ + required int page, + String search = '', + }) : this._internal( + (ref) => fetchPackages( + ref as FetchPackagesRef, + page: page, + search: search, + ), + from: fetchPackagesProvider, + name: r'fetchPackagesProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$fetchPackagesHash, + dependencies: FetchPackagesFamily._dependencies, + allTransitiveDependencies: + FetchPackagesFamily._allTransitiveDependencies, + page: page, + search: search, + ); + + FetchPackagesProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.page, + required this.search, + }) : super.internal(); + + final int page; + final String search; + + @override + Override overrideWith( + FutureOr> Function(FetchPackagesRef ref) create, + ) { + return ProviderOverride( + origin: this, + override: FetchPackagesProvider._internal( + (ref) => create(ref as FetchPackagesRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + page: page, + search: search, + ), + ); + } + + @override + ({ + int page, + String search, + }) get argument { + return ( + page: page, + search: search, + ); + } + + @override + AutoDisposeFutureProviderElement> createElement() { + return _FetchPackagesProviderElement(this); + } + + FetchPackagesProvider _copyWith( + FutureOr> Function(FetchPackagesRef ref) create, + ) { + return FetchPackagesProvider._internal( + (ref) => create(ref as FetchPackagesRef), + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + page: page, + search: search, + ); + } + + @override + bool operator ==(Object other) { + return other is FetchPackagesProvider && + other.page == page && + other.search == search; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, page.hashCode); + hash = _SystemHash.combine(hash, search.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin FetchPackagesRef on AutoDisposeFutureProviderRef> { + /// The parameter `page` of this provider. + int get page; + + /// The parameter `search` of this provider. + String get search; +} + +class _FetchPackagesProviderElement + extends AutoDisposeFutureProviderElement> + with FetchPackagesRef { + _FetchPackagesProviderElement(super.provider); + + @override + int get page => (origin as FetchPackagesProvider).page; + @override + String get search => (origin as FetchPackagesProvider).search; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart new file mode 100644 index 000000000..a6e6df4aa --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart @@ -0,0 +1,25 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Package { + static Package fromJson(dynamic json) { + throw UnimplementedError(); + } +} + +/* SNIPPET START */ // 从 pub.dev 获取包列表 +final fetchPackagesProvider = FutureProvider.autoDispose + .family, ({int page, String? search})>((ref, params) async { + final page = params.page; + final search = params.search ?? ''; + final dio = Dio(); + // 获取 API。 这里我们使用 package:dio，但我们可以使用其他任何东西。 + final response = await dio.get>( + 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', + ); + + // 将 JSON 响应解码为 Dart 类。 + return response.data?.map(Package.fromJson).toList() ?? const []; +});/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx new file mode 100644 index 000000000..132db7d1b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx @@ -0,0 +1,120 @@ +--- +title: ^0.13.0 到 ^0.14.0 +--- + +随着 Riverpod 版本 0.14.0 的发布，使用 [StateNotifierProvider] 的语法发生了变化 +（请参阅 https://github.com/rrousselGit/riverpod/issues/341 了解详细解释）。 + +在整篇文章中，请考虑以下的 [StateNotifier]: + +```dart +class MyModel {} + +class MyStateNotifier extends StateNotifier { + MyStateNotifier(): super(MyModel()); +} +``` + +## The changes + +- [StateNotifierProvider] 添加了一个额外的泛型参数，该参数应该是您的 [StateNotifier]状态的类型。 + + 之前: + + ```dart + final provider = StateNotifierProvider((ref) { + return MyStateNotifier(); + }); + ``` + + 之后: + + ```dart + final provider = StateNotifierProvider((ref) { + return MyStateNotifier(); + }); + ``` + +- 为了获取 [StateNotifier] ，您现在应该使用 `myProvider.notifier` 而不是仅仅使用 `myProvider`： + + 之前: + + ```dart + Widget build(BuildContext context, ScopedReader watch) { + MyStateNotifier notifier = watch(provider); + } + ``` + + 之后: + + ```dart + Widget build(BuildContext context, ScopedReader watch) { + MyStateNotifier notifier = watch(provider.notifier); + } + ``` + +- 为了监听 [StateNotifier] 的状态，您现在应该使用 `myProvider` 而不是 `myProvider.state`： + + Before: + + ```dart + Widget build(BuildContext context, ScopedReader watch) { + MyModel state = watch(provider.state); + } + ``` + + After: + + ```dart + Widget build(BuildContext context, ScopedReader watch) { + MyModel state = watch(provider); + } + ``` + +## 使用迁移工具自动升级项目到新的语法 + +随着 0.14.0 版本的发布，Riverpod 推出了一个命令行工具，可以帮助您迁移项目。 + +### 安装命令行工具 + +要安装迁移工具，请运行： + +```sh +dart pub global activate riverpod_cli +``` + +现在您应该能够运行： + +```sh +riverpod --help +``` + +### 使用说明 + +既然命令行工具已经安装，我们可以开始使用它了。 + +- 首先，在终端中打开您想要迁移的项目。 +- **不要** 升级 Riverpod. + 迁移工具会为您升级 Riverpod 的版本。 +- 确保您的项目不包含错误。 +- 执行： + ```sh + riverpod migrate + ``` + +然后，该工具将分析您的项目并提出更改建议。例如，您可能会看到： + +```diff +Widget build(BuildContext context, ScopedReader watch) { +- MyModel state = watch(provider.state); ++ MyModel state = watch(provider); +} + +Accept change (y = yes, n = no [default], A = yes to all, q = quit)? +``` + +要接受更改，只需按 y 键。否则，要拒绝更改，按 n 键。 + + +[statenotifierprovider]: ../providers/state_notifier_provider +[statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx new file mode 100644 index 000000000..30f078a19 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx @@ -0,0 +1,226 @@ +--- +title: ^0.14.0 到 ^1.0.0 +--- + +import { Link } from "@site/src/components/Link"; + + +经过漫长的等待，Riverpod 迎来了首个稳定版本的发布 👏 + +要查看完整的变更列表，请参阅 [Changelog](https://pub.dev/packages/flutter_riverpod/changelog#100). +在本页面中，我们将重点介绍如何将现有的 Riverpod 应用程序从版本 0.14.x 迁移到版本 1.0.0。 + +## 使用迁移工具自动升级项目到新的语法 + +在解释各种变更之前，值得注意的是，Riverpod 提供了一个命令行工具，可以自动为您的项目进行迁移。 + +### 安装命令行工具 + +要安装迁移工具，请运行： + +```sh +dart pub global activate riverpod_cli +``` + +现在您应该能够运行： + +```sh +riverpod --help +``` + +### 使用说明 + +既然命令行工具已经安装，我们可以开始使用它了。 + +- 首先，在终端中打开您想要迁移的项目。 +- **不用** 升级 Riverpod. + 迁移工具将会为您升级 Riverpod 的版本。 + + :::danger + 不升级 Riverpod 非常重要。 + 如果您已经安装了版本 1.0.0，该工具将无法正常执行。因此，请确保在启动工具之前正确使用较旧的版本。 + ::: + +- 确保您的项目不包含错误。 +- 执行 + ```sh + riverpod migrate + ``` + +然后，该工具将分析您的项目并提出更改建议。例如，您可能会看到： + +```diff +-Widget build(BuildContext context, ScopedReader watch) { ++Widget build(BuildContext context, Widget ref) { +- MyModel state = watch(provider); ++ MyModel state = ref.watch(provider); +} + +Accept change (y = yes, n = no [default], A = yes to all, q = quit)? +``` + +要接受更改，只需按 y 键。否则，要拒绝更改，按 n 键. + +## 变更内容 + +现在我们已经了解了如何使用命令行工具自动升级项目，让我们详细看看所需的更改。 + + +### 语法统一 + +Riverpod 1.0.0 版本主要关注与提供程序交互的语法统一。 +在此之前，Riverpod 对于读取提供程序有许多类似但不同的语法， +例如 `ref.watch(provider)` 与 `useProvider(provider)` 与 `watch(provider)`。 +在版本 1.0.0 中，只剩下一种语法： `ref.watch(provider)`。其他的语法已经被移除。 + +例如： + +- `useProvider` 已被移除，而推荐使用 `HookConsumerWidget`。 + + 之前: + + ```dart + class Example extends HookWidget { + @override + Widget build(BuildContext context) { + useState(...); + int count = useProvider(counterProvider); + ... + } + } + ``` + + 之后: + + ```dart + class Example extends HookConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + useState(...); + int count = ref.watch(counterProvider); + ... + } + } + ``` + +- 在 `ConsumerWidget` 的 `build` 方法和 `Consumer` 的 `builder` 方法原型发生了变化. + + 之前: + + ```dart + class Example extends ConsumerWidget { + @override + Widget build(BuildContext context, ScopedReader watch) { + int count = watch(counterProvider); + ... + } + } + + Consumer( + builder: (context, watch, child) { + int count = watch(counterProvider); + ... + } + ) + ``` + + 之后: + + ```dart + class Example extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + int count = ref.watch(counterProvider); + ... + } + } + + Consumer( + builder: (context, ref, child) { + int count = ref.watch(counterProvider); + ... + } + ) + ``` + +- `context.read` 被移除，取而代之的是 `ref.read` 。 + + 之前: + + ```dart + class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + SomeButton( + onPressed: () => context.read(provider.notifier).doSomething(), + ); + } + } + ``` + + 之后: + + ```dart + class Example extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + SomeButton( + onPressed: () => ref.read(provider.notifier).doSomething(), + ); + } + } + ``` + +### StateProvider 更新 + +[StateProvider] 已更新以匹配 [StateNotifierProvider]。 + +在更新之前，使用 `ref.watch(StateProvider)` 会返回一个 `StateController` 实例。 +现在它只返回 `StateController` 的状态。 + +要进行迁移，有几种解决方案。 +如果您的代码仅获取状态而不修改它，可以从： + +```dart +final provider = StateProvider(...); + +Consumer( + builder: (context, ref, child) { + StateController count = ref.watch(provider); + + return Text('${count.state}'); + } +) +``` + +变到: + +```dart +final provider = StateProvider(...); + +Consumer( + builder: (context, ref, child) { + int count = ref.watch(provider); + + return Text('${count}'); + } +) +``` + +或者，您可以使用新的 `StateProvider.state` 来保持旧的行为。 + +```dart +final provider = StateProvider(...); + +Consumer( + builder: (context, ref, child) { + StateController count = ref.watch(provider.state); + + return Text('${count.state}'); + } +) +``` + +[statenotifierprovider]: ../providers/state_notifier_provider +[stateprovider]: ../providers/state_provider +[statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx new file mode 100644 index 000000000..ba586aa46 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx @@ -0,0 +1,259 @@ +--- +title: 从 `ChangeNotifier` 迁移 +--- + +import old from "!!raw-loader!./from_change_notifier/old.dart"; +import declaration from "./from_change_notifier/declaration"; +import initialization from "./from_change_notifier/initialization"; +import migrated from "./from_change_notifier/migrated"; + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet } from "@site/src/components/CodeSnippet"; + + + +在 Riverpod 中，`ChangeNotifierProvider` 用于提供从 pkg:provider 的平滑过渡。 + + +如果您刚刚开始迁移到 pkg:riverpod，请务必阅读专用指南 +（请参阅）。 +本文适用于已经过渡到 Riverpod，但想要彻底放弃 `ChangeNotifier` 的人们。 + + +总而言之，从 `ChangeNotifier` 迁移到 `AsyncNotifer` 需要范式转换， +但它极大地简化了迁移后的代码。 +另请参阅。 + + +以这个（错误的）例子为例： + + + +该实现显示了几个薄弱的设计选择，例如： +- 使用 `isLoading` 和 `hasError` 处理不同的异步情况 +- 需要仔细处理带有繁琐的 `try`/`catch`/`finally` 表达式的请求 +- 需要在正确的时间调用 `notifyListeners` 才能使此实现发挥作用 +- 存在不一致或可能不需要的状态，例如使用空列表进行初始化 + + +请注意这个示例是如何精心设计的，以向新手开发人员展示 `ChangeNotifier` +如何导致错误的设计方案；此外，另一个要点是可变状态可能比最初承诺的要困难得多。 + + +`Notifier`/`AsyncNotifer` 与不可变状态相结合， +可以带来更好的设计方案和更少的错误。 + + +让我们看看如何将上述代码片段一步一步迁移到最新的 API。 + + + +## 开始迁移​ + +首先，我们应该声明新的提供者程序/通知者程序：这需要一些思维过程，这取决于您独特的业务逻辑。 + + +我们总结一下上面的要求： +- 状态用 `List` 表示，通过网络调用获得，不带参数 +- 状态还应该公开有关其 `loading`、`error` 和 `data` 状态的信息 +- 状态可以通过一些公开的方法进行改变，因此一个函数是不够的 + +:::tip + +上述思考过程归结为回答以下问题： +1. 是否需要一些副作用？ + - `y`：使用 Riverpod 的基于类的 API + - `n`：使用 Riverpod 的基于函数的 API +1. State 需要异步加载吗？ + - `y`：让 `build` 返回 `Future` + - `n`：让 `build` 简单地返回 `T` +1. 是否需要一些参数？ + - `y`：让 `build` （或你的函数）接受它们 + - `n`：让 `build` （或你的函数）不接受额外的参数 +::: + +:::info + +如果您使用的是 codegen，上述思考过程就足够了。 +无需考虑正确的类名及其*特定*的 API。 +`@riverpod` 仅要求您编写一个具有返回类型的类，然后就可以开始了。 +::: + + +从技术上讲，这里最合适的是定义一个 `AutoDisposeAsyncNotifier>`， +它满足上述所有要求。让我们先写一些伪代码。 + + + +:::tip + +请记住：在 IDE 中使用代码片段可以获得一些指导，或者只是为了加快代码编写速度。 +请参阅。 +::: + + +考虑到 `ChangeNotifier` 的实现，我们不再需要声明 `todos`； +这样的变量是 `state`，它是用 `build` 隐式加载的。 + + +事实上，Riverpod 的通知者程序一次可以暴露*一个*实体。 + +:::tip + +Riverpod 的 API 是细粒度的；尽管如此，在迁移时， +您仍然可以定义自定义实体来保存多个值。首先考虑使用 [Dart 3 的记录](https://dart.dev/language/records) +来平滑迁移。 +::: + + + +### 初始化​ + +初始化通知者程序很简单：只需在 `build` 内编写初始化逻辑即可。 +我们现在可以摆脱旧的 `_init` 函数。 + + + + +相对于旧的 `_init` ，新的 `build` 没有丢失任何内容： +不需要初始化 `isLoading` 或 `hasError` + + +Riverpod 将通过公开 `AsyncValue>` 自动转换任何异步提供者程序， +并比两个简单的布尔标志更好地处理异步状态的复杂性。 + + +事实上，任何 `AsyncNotifier` 都会有效地使编写额外的 `try`/`catch`/`finally` 成为处理异步状态的反模式。 + + + +### 突变和副作用​ + +就像初始化一样，执行副作用时，无需操作布尔标志， +例如 `hasError`，或编写额外的 `try`/`catch`/`finally` + + +下面，我们删除了所有样板文件并成功完全迁移了上面的示例： + + +:::tip + +语法和设计方案可能会有所不同，但最终我们只需要编写我们的请求并随后更新状态。 +请参阅。 +::: + + +## 迁移过程总结 + + +让我们从操作的角度回顾一下上面应用的整个迁移过程。 + + +1. 我们已将初始化从构造函数中调用的自定义方法移至 `build` +1. 我们删除了 `todos`、`isLoading` 和 `hasError` 属性：内部 `state` 就足够了 +1. 我们已经删除了所有 `try`-`catch`-`finally` 块：返回 Future 就足够了 +1. 我们对副作用应用了相同的简化（`addTodo`） +1. 我们已经通过简单地重新分配 `state` 应用了突变 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart new file mode 100644 index 000000000..b3ca06ef2 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart @@ -0,0 +1,33 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'declaration.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() { + // TODO ... + return []; + } + + Future addTodo(Todo todo) async { + // TODO + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart new file mode 100644 index 000000000..317354e31 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'declaration.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'fc9a07f8ef9f792da2ac660d76ea0a809335ba18'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeAsyncNotifierProvider>.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx new file mode 100644 index 000000000..1ad659c31 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./declaration.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart new file mode 100644 index 000000000..c7485bbba --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart @@ -0,0 +1,33 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends AutoDisposeAsyncNotifier> { + @override + FutureOr> build() { + // TODO ... + return []; + } + + Future addTodo(Todo todo) async { + // TODO + } +} + +final myNotifierProvider = AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx new file mode 100644 index 000000000..3b3fbd2cb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./initialization.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart new file mode 100644 index 000000000..4da805e13 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart @@ -0,0 +1,29 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'initialization.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + return [...json.map(Todo.fromJson)]; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart new file mode 100644 index 000000000..376ce998f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'initialization.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'1c67c12443102cf8c43efbf6c630d3028d9847c3'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeAsyncNotifierProvider>.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart new file mode 100644 index 000000000..24ab265f7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart @@ -0,0 +1,29 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends AutoDisposeAsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + return [...json.map(Todo.fromJson)]; + } +} + +final myNotifierProvider = AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx new file mode 100644 index 000000000..075bfbdf5 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./migrated.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart new file mode 100644 index 000000000..a90cee0fa --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart @@ -0,0 +1,37 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'migrated.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + Future addTodo(Todo todo) async { + // 可选的: state = const AsyncLoading(); + final json = await http.post('api/todos'); + final newTodos = [...json.map(Todo.fromJson)]; + state = AsyncData(newTodos); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart new file mode 100644 index 000000000..8eaddcfd9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'migrated.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'bde95c56aa12eff7c8c01ede57ae4ad2b616c225'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeAsyncNotifierProvider>.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart new file mode 100644 index 000000000..3bea206b7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart @@ -0,0 +1,37 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends AutoDisposeAsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + Future addTodo(Todo todo) async { + // 可选的: state = const AsyncLoading(); + final json = await http.post('api/todos'); + final newTodos = [...json.map(Todo.fromJson)]; + state = AsyncData(newTodos); + } +} + +final myNotifierProvider = AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart new file mode 100644 index 000000000..4e65e823d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart @@ -0,0 +1,60 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyChangeNotifier extends ChangeNotifier { + MyChangeNotifier() { + _init(); + } + List todos = []; + bool isLoading = true; + bool hasError = false; + + Future _init() async { + try { + final json = await http.get('api/todos'); + todos = [...json.map(Todo.fromJson)]; + } on Exception { + hasError = true; + } finally { + isLoading = false; + notifyListeners(); + } + } + + Future addTodo(int id) async { + isLoading = true; + notifyListeners(); + + try { + final json = await http.post('api/todos'); + todos = [...json.map(Todo.fromJson)]; + hasError = false; + } on Exception { + hasError = true; + } finally { + isLoading = false; + notifyListeners(); + } + } +} + +final myChangeProvider = ChangeNotifierProvider((ref) { + return MyChangeNotifier(); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx new file mode 100644 index 000000000..15e22eace --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx @@ -0,0 +1,547 @@ +--- +title: 从 `StateNotifier` 迁移 +--- + +import buildInit from "./from_state_notifier/build_init"; +import buildInitOld from "!!raw-loader!./from_state_notifier/build_init_old.dart"; +import consumersDontChange from "!!raw-loader!./from_state_notifier/consumers_dont_change.dart"; +import familyAndDispose from "./from_state_notifier/family_and_dispose"; +import familyAndDisposeOld from "!!raw-loader!./from_state_notifier/family_and_dispose_old.dart"; +import asyncNotifier from "./from_state_notifier/async_notifier"; +import asyncNotifierOld from "!!raw-loader!./from_state_notifier/async_notifier_old.dart"; +import addListener from "./from_state_notifier/add_listener"; +import addListenerOld from "!!raw-loader!./from_state_notifier/add_listener_old.dart"; +import fromStateProvider from "./from_state_notifier/from_state_provider"; +import fromStateProviderOld from "!!raw-loader!./from_state_notifier/from_state_provider_old.dart"; +import oldLifecycles from "./from_state_notifier/old_lifecycles"; +import oldLifecyclesOld from "!!raw-loader!./from_state_notifier/old_lifecycles_old.dart"; +import oldLifecyclesFinal from "./from_state_notifier/old_lifecycles_final"; +import obtainNotifierOnTests from "!!raw-loader!./from_state_notifier/obtain_notifier_on_tests.dart"; + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet } from "@site/src/components/CodeSnippet"; + + +与 [Riverpod 2.0](https://pub.dev/packages/flutter_riverpod/changelog#200) +一起引入了新类： `Notifier`/`AsyncNotifer`。 +现在不鼓励使用 `StateNotifier`，转而使用这些新 API。 + + +本页展示如何从已弃用的 `StateNotifier` 迁移到新的 API。 + + +`AsyncNotifier` 带来的主要好处是更好的 `async` 支持；事实上， +`AsyncNotifier` 可以被认为是 `FutureProvider` ，并且具备从 UI 修改的公开方法。 + + +此外，新的 (Async)Notifier： + + +- 在其类中公开 `Ref` 对象 +- 在代码生成和非代码生成方法之间提供类似的语法 +- 在同步和异步版本之间提供类似的语法 +- 将逻辑从提供者程序中移开，并将其集中到通知者程序本身中 + + +让我们看看如何定义 `Notifier`、它与 `StateNotifier` 的比较以及如何迁移新的 +`AsyncNotifier` 以获得异步状态。 + + +## 新语法比较​ + + +在进行比较之前，请务必了解如何定义 `Notifier`。 +请参阅。 + + +让我们使用旧的 `StateNotifier` 语法编写一个示例： + + + +这是使用新的 `Notifier` API 构建的相同示例，大致可翻译为： + + + +比较 `Notifier` 与 `StateNotifier`，可以观察到以下主要区别： + + +- `StateNotifier` 的反应式依赖项在其提供者程序中声明，而 `Notifier` + 将此逻辑集中在其 `build` 方法中 +- `StateNotifier` 的整个初始化过程分为其提供者程序和构造函数， + 而 `Notifier` 保留一个位置来放置此类逻辑 +- 请注意，与 `StateNotifier` 不同，没有任何逻辑被写入 `Notifier` 的构造函数中 + + +使用 `AsyncNotifer`、`Notifier` 的异步等效项可以得出类似的结论。 + + +## 迁移异步 `StateNotifier` + + +新 API 语法的主要吸引力在于改进了异步数据的开发体验。 +举个例子： + + + + +下面是用新的 `AsyncNotifier` API 重写的上面的示例： + + + + +`AsyncNotifer` 与 `Notifier` 一样，带来了更简单、更统一的 API。 +在这里，很容易将 `AsyncNotifer` 视为带有方法的 `FutureProvider`。 + + +`AsyncNotifer` 附带了一组 `StateNotifier` 没有的实用程序和 getter，例如 +[`future`](https://pub.dev/documentation/riverpod/latest/riverpod/AutoDisposeAsyncNotifier/future.html) +和 [`update`](https://pub.dev/documentation/riverpod/latest/riverpod/AutoDisposeAsyncNotifier/update.html)。 +这使我们能够在处理异步突变和副作用时编写更简单的逻辑。 +另请参阅。 +:::tip + +从 `StateNotifier>` 迁移到 `AsyncNotifer` 归结为： + +- 将初始化逻辑放入 `build` +- 删除初始化或副作用方法中的任何 `catch`/`try` 块 +- 从 `build` 中删除任何 `AsyncValue.guard` ，因为它将 `Future` 转换为 `AsyncValue` +::: + + + +## 优点​ + + +在这几个示例之后，现在让我们重点介绍 `Notifier` 和 `AsyncNotifer` 的主要优点： +- 新语法应该感觉更简单、更具可读性，特别是对于异步状态 +- 一般来说，新 API 的样板代码可能会更少 +- 无论您正在编写哪种类型的提供者程序，语法现在都是统一的，从而支持代码生成 + （请参阅） + + +让我们进一步深入并强调更多的差异和相似之处。 + + +## 显式 `.family` 和 `.autoDispose` 修改​ + + +另一个重要的区别是新 API 处理系列和自动处置的方式。 + + +`Notifier`，有其自己的 `.family` 和 `.autoDispose` 对应项， +例如 `FamilyNotifier` 和 `AutoDisposeNotifier`。 +与往常一样，此类修改可以组合使用（又名 `AutoDisposeFamilyNotifier`）。 +`AsyncNotifer` 也有其异步等效项（例如 `AutoDisposeFamilyAsyncNotifier`）。 + + +修改在类中明确说明；所有参数都直接注入 `build` 方法中，以便初始化逻辑可以使用它们。 +这应该会带来更好的可读性、更简洁、总体上更少的错误。 + + +以下面的示例为例，其中定义了 `StateNotifierProvider.family`。 + + + +`BugsEncounteredNotifier` 感觉...沉重/难以阅读。 +让我们看一下它的迁移后的 `AsyncNotifier` 对应部分： + + + + +其迁移后的版本应该是一本轻松的读物。 + +:::info + +`(Async)Notifier` 的 `.family` 参数可通过 `this.arg` 获取（或使用代码生成时的 `this.paramName`） +::: + + +## 生命周期有不同的行为​ + + +`Notifier`/`AsyncNotifier` 和 `StateNotifier` 之间的生命周期有很大不同。 + + +这个例子再次展示了旧 API 如何具有稀疏逻辑： + + + + +在这里，如果 `durationProvider` 更新，`MyNotifier` 会进行处置： +然后重新实例化其实例，然后重新初始化其内部状态。 +此外，与其他提供者程序不同的是，`dispose` 回调将在类中单独定义。 +最后，仍然可以在其 _provider_ 中编写 `ref.onDispose`， +再次显示此 API 的逻辑是多么稀疏；潜在地，开发人员可能必须研究八 (8!) +个不同的地方才能理解此通知者程序行为！ + + +这些歧义可以通过 `Riverpod 2.0` 解决。 + + +### 旧 `dispose` 与 `ref.onDispose` + +`StateNotifier` 的 `dispose` 方法指的是通知者程序本身的 dispose 事件， +也就是*在自行处置之前*调用的回调。 + + +`(Async)Notifier` 没有此属性，因为*它们在重建时不会被处置*；只有他们的内部状态是。 +在新的通知者程序中，处置生命周期仅在_一个_地方处理，通过 `ref.onDispose` +（和其他），就像任何其他提供者程序一样。 +这简化了 API，希望也提高了开发体验，这样只需查看_一个_地方 +即可了解生命周期的副作用：它的 `build` 方法。 + + +简而言之：要注册在*内部状态*重建之前触发的回调， +我们可以像其他提供者程序一样使用 `ref.onDispose`。 + + +您可以像这样迁移上面的代码片段： + + + + +在最后一个片段中，肯定有一些简化，但仍然存在一个未解决的问题： +我们现在无法了解我们的通知者程序在执行 `update` 时是否仍然存在。 +这可能会出现不需要的 `StateError`。 + + +### 不再 `mounted` + +发生这种情况是因为 `(Async)Notifier` 缺少 `mounted` 属性， +而该属性在 `StateNotifier` 上可用。 +考虑到它们生命周期的差异，这是完全有道理的；尽管只是可能，`mounted` +属性可能会误导新通知者程序：`mounted` *几乎总是* `true` 。 + + +虽然可以制定[自定义解决方法](https://github.com/rrousselGit/riverpod/issues/1879#issuecomment-1303189191)， +但建议通过取消异步操作来解决此问题。 + + +可以使用自定义[完成器](https://api.flutter.dev/flutter/dart-async/Completer-class.html) +或任何自定义派生程序来取消操作。 + + +例如，如果您使用 `Dio` 执行网络请求，请考虑使用[取消令牌](https://pub.dev/documentation/dio/latest/dio/CancelToken-class.html) +（另请参阅）。 + + +因此，上面的示例迁移到以下内容： + + + + +## 突变 API 与之前相同​ + + +到目前为止，我们已经展示了 `StateNotifier` 和新 API 之间的差异。 +相反， `Notifier`、`AsyncNotifer` 和 `StateNotifier` 共享的一件事是 +如何使用和改变它们的状态。 + + +消费者程序可以使用相同的语法从这三个提供者程序获取数据， +这在您从 `StateNotifier` 迁移时非常有用；这也适用于通知者程序方法。 + + + + +## 其他迁移​ + + +让我们探讨一下 `StateNotifier` 和 `Notifier`（或 `AsyncNotifier`）之间影响较小的差异 + + +### 从 `.addListener` 和 `.stream` 迁移​ + + +`StateNotifier` 的 `.addListener` 和 `.stream` 可用于监听状态更改。 +这两个 API 现在被认为已经过时了。 + + +这是有意为之，因为我们希望与 `Notifier`、`AsyncNotifier` 和其他提供者程序实现完全的 API 统一。 +事实上，使用 `Notifier` 或 `AsyncNotifier` 应该与任何其他提供者程序没有任何不同。 + + +因此： + + + +就变成这样了： + + + +简而言之：如果你想监听 `Notifier`/`AsyncNotifer`，只需使用 `ref.listen`。 +请参阅。 + + +### 从测试中的 `.debugState` 迁移​ + + +`StateNotifier` 公开 `.debugState`：此属性供 pkg:state_notifier +用户在开发模式下启用从类外部进行状态访问，以用于测试目的。 + + +如果您在测试中使用 `.debugState` 访问状态，则您很可能需要放弃这种方法。 + + +`Notifier`/`AsyncNotifer` 没有 `.debugState`；相反，它们直接公开 `.state`， +即 `@visibleForTesting` 。 + +:::danger + +避免！从测试中访问 `.state`；如果必须的话，_当且仅当_您已经正确实例化了 +`Notifier`/`AsyncNotifer` 时才执行此操作； +然后，您可以在测试中自由访问 `.state`。 + + +事实上，`Notifier`/`AsyncNotifier` _不应该_手动实例化；相反， +它们应该通过使用其提供者程序进行交互：如果不这样做将会*破坏*通知者程序， +因为 ref 和 family 参数没有被初始化。 +::: + + +没有 `Notifier` 实例？ +没问题，您可以使用 `ref.read` 获取一个，就像您读取其暴露状态一样： + + + + +在其专用指南中了解有关测试的更多信息。请参阅。 + + +### 从 `StateProvider` 迁移​ + + +`StateProvider` 自发布以来就被 Riverpod 暴露出来， +它是为了节省一些代码行数（LoC）来简化 `StateNotifierProvider` 的版本。 +由于 `StateNotifierProvider` 已被弃用，因此 `StateProvider` 也应避免使用。 +此外，到目前为止，新 API 还没有等效的 `StateProvider`。 + + +尽管如此，从 `StateProvider` 迁移到 `Notifier` 很简单。 + + +这样： + + + +变成： + + + +尽管它花费了我们更多的代码行数（LoC），但从 `StateProvider` +迁移使我们能够明确地归档 `StateNotifier` 。 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart new file mode 100644 index 000000000..ead1c72d8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart @@ -0,0 +1,18 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'add_listener.g.dart'; + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + ref.listenSelf((_, next) => debugPrint('$next')); + return 0; + } + + void add() => state++; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart new file mode 100644 index 000000000..161b3bba0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'add_listener.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'9acd382ed579c545ace755687b155e28eba01d22'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx new file mode 100644 index 000000000..6d7ac6d37 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./add_listener.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart new file mode 100644 index 000000000..e25b4a181 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart @@ -0,0 +1,17 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + ref.listenSelf((_, next) => debugPrint('$next')); + return 0; + } + + void add() => state++; +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart new file mode 100644 index 000000000..f9177df65 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart @@ -0,0 +1,24 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class MyNotifier extends StateNotifier { + MyNotifier() : super(0); + + void add() => state++; +} + +final myNotifierProvider = StateNotifierProvider((ref) { + final notifier = MyNotifier(); + + final cleanup = notifier.addListener((state) => debugPrint('$state')); + ref.onDispose(cleanup); + + // 或者，等效为： + // final listener = notifier.stream.listen((event) => debugPrint('$event')); + // ref.onDispose(listener.cancel); + + return notifier; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart new file mode 100644 index 000000000..5ead76378 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_notifier.g.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class AsyncTodosNotifier extends _$AsyncTodosNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + // ... +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart new file mode 100644 index 000000000..25bcda60d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -0,0 +1,29 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$asyncTodosNotifierHash() => + r'10207327c7dee180e9da8beece5bfffedcf86e98'; + +/// See also [AsyncTodosNotifier]. +@ProviderFor(AsyncTodosNotifier) +final asyncTodosNotifierProvider = + AutoDisposeAsyncNotifierProvider>.internal( + AsyncTodosNotifier.new, + name: r'asyncTodosNotifierProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$asyncTodosNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$AsyncTodosNotifier = AutoDisposeAsyncNotifier>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx new file mode 100644 index 000000000..a0ff513c3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./async_notifier.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart new file mode 100644 index 000000000..52da61d76 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart @@ -0,0 +1,29 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class AsyncTodosNotifier extends AsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + // ... +} + +final asyncTodosNotifier = AsyncNotifierProvider>( + AsyncTodosNotifier.new, +); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart new file mode 100644 index 000000000..50d7f4aed --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart @@ -0,0 +1,30 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class AsyncTodosNotifier extends StateNotifier>> { + AsyncTodosNotifier() : super(const AsyncLoading()) { + _postInit(); + } + + Future _postInit() async { + state = await AsyncValue.guard(() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + }); + } + + // ... +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart new file mode 100644 index 000000000..3e2303b7a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart @@ -0,0 +1,15 @@ +// ignore_for_file: avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'build_init.g.dart'; + +/* SNIPPET START */ +@riverpod +class CounterNotifier extends _$CounterNotifier { + @override + int build() => 0; + + void increment() => state++; + void decrement() => state++; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart new file mode 100644 index 000000000..6b4621ecb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart @@ -0,0 +1,28 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'build_init.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterNotifierHash() => r'8d4e4011da15a0ef79af9622336839a0c9e406ab'; + +/// See also [CounterNotifier]. +@ProviderFor(CounterNotifier) +final counterNotifierProvider = + AutoDisposeNotifierProvider.internal( + CounterNotifier.new, + name: r'counterNotifierProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$counterNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$CounterNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx new file mode 100644 index 000000000..276a143ac --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./build_init.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart new file mode 100644 index 000000000..0ba8eebed --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart @@ -0,0 +1,15 @@ +// ignore_for_file: avoid_print + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +class CounterNotifier extends Notifier { + @override + int build() => 0; + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = NotifierProvider(CounterNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart new file mode 100644 index 000000000..82a8c54bd --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart @@ -0,0 +1,13 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +class CounterNotifier extends StateNotifier { + CounterNotifier() : super(0); + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = StateNotifierProvider((ref) { + return CounterNotifier(); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart new file mode 100644 index 000000000..6a964a5a6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart @@ -0,0 +1,36 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class CounterNotifier extends StateNotifier { + CounterNotifier() : super(0); + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = StateNotifierProvider((ref) { + return CounterNotifier(); +}); + +/* SNIPPET START */ +class SomeConsumer extends ConsumerWidget { + const SomeConsumer({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + /* highlight-start */ + final counter = ref.watch(counterNotifierProvider); + /* highlight-end */ + return Column( + children: [ + Text("You've counted up until $counter, good job!"), + TextButton( + /* highlight-start */ + onPressed: ref.read(counterNotifierProvider.notifier).increment, + /* highlight-end */ + child: const Text('Count even more!'), + ) + ], + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart new file mode 100644 index 000000000..9a695614c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'family_and_dispose.g.dart'; + +/* SNIPPET START */ +@riverpod +class BugsEncounteredNotifier extends _$BugsEncounteredNotifier { + @override + FutureOr build(String featureId) { + return 99; + } + + Future fix(int amount) async { + final old = await future; + final result = await ref.read(taskTrackerProvider).fix(id: this.featureId, fixed: amount); + state = AsyncData(max(old - result, 0)); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart new file mode 100644 index 000000000..cbcfb779b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -0,0 +1,219 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family_and_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$bugsEncounteredNotifierHash() => + r'c76e924f84db91c57d226896b062d9f4e8ab79e5'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +abstract class _$BugsEncounteredNotifier + extends BuildlessAutoDisposeAsyncNotifier { + late final String featureId; + + FutureOr build( + String featureId, + ); +} + +/// See also [BugsEncounteredNotifier]. +@ProviderFor(BugsEncounteredNotifier) +const bugsEncounteredNotifierProvider = BugsEncounteredNotifierFamily(); + +/// See also [BugsEncounteredNotifier]. +class BugsEncounteredNotifierFamily extends Family { + /// See also [BugsEncounteredNotifier]. + const BugsEncounteredNotifierFamily(); + + static const Iterable? _dependencies = null; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'bugsEncounteredNotifierProvider'; + + /// See also [BugsEncounteredNotifier]. + BugsEncounteredNotifierProvider call( + String featureId, + ) { + return BugsEncounteredNotifierProvider( + featureId, + ); + } + + @visibleForOverriding + @override + BugsEncounteredNotifierProvider getProviderOverride( + covariant BugsEncounteredNotifierProvider provider, + ) { + return call( + provider.featureId, + ); + } + + /// Enables overriding the behavior of this provider, no matter the parameters. + Override overrideWith(BugsEncounteredNotifier Function() create) { + return _$BugsEncounteredNotifierFamilyOverride(this, create); + } +} + +class _$BugsEncounteredNotifierFamilyOverride implements FamilyOverride { + _$BugsEncounteredNotifierFamilyOverride(this.overriddenFamily, this.create); + + final BugsEncounteredNotifier Function() create; + + @override + final BugsEncounteredNotifierFamily overriddenFamily; + + @override + BugsEncounteredNotifierProvider getProviderOverride( + covariant BugsEncounteredNotifierProvider provider, + ) { + return provider._copyWith(create); + } +} + +/// See also [BugsEncounteredNotifier]. +class BugsEncounteredNotifierProvider + extends AutoDisposeAsyncNotifierProviderImpl { + /// See also [BugsEncounteredNotifier]. + BugsEncounteredNotifierProvider( + String featureId, + ) : this._internal( + () => BugsEncounteredNotifier()..featureId = featureId, + from: bugsEncounteredNotifierProvider, + name: r'bugsEncounteredNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$bugsEncounteredNotifierHash, + dependencies: BugsEncounteredNotifierFamily._dependencies, + allTransitiveDependencies: + BugsEncounteredNotifierFamily._allTransitiveDependencies, + featureId: featureId, + ); + + BugsEncounteredNotifierProvider._internal( + super.create, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.featureId, + }) : super.internal(); + + final String featureId; + + @override + FutureOr runNotifierBuild( + covariant BugsEncounteredNotifier notifier, + ) { + return notifier.build( + featureId, + ); + } + + @override + Override overrideWith(BugsEncounteredNotifier Function() create) { + return ProviderOverride( + origin: this, + override: BugsEncounteredNotifierProvider._internal( + () => create()..featureId = featureId, + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + featureId: featureId, + ), + ); + } + + @override + (String,) get argument { + return (featureId,); + } + + @override + AutoDisposeAsyncNotifierProviderElement + createElement() { + return _BugsEncounteredNotifierProviderElement(this); + } + + BugsEncounteredNotifierProvider _copyWith( + BugsEncounteredNotifier Function() create, + ) { + return BugsEncounteredNotifierProvider._internal( + () => create()..featureId = featureId, + name: name, + dependencies: dependencies, + allTransitiveDependencies: allTransitiveDependencies, + debugGetCreateSourceHash: debugGetCreateSourceHash, + from: from, + featureId: featureId, + ); + } + + @override + bool operator ==(Object other) { + return other is BugsEncounteredNotifierProvider && + other.featureId == featureId; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, featureId.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin BugsEncounteredNotifierRef on AutoDisposeAsyncNotifierProviderRef { + /// The parameter `featureId` of this provider. + String get featureId; +} + +class _BugsEncounteredNotifierProviderElement + extends AutoDisposeAsyncNotifierProviderElement with BugsEncounteredNotifierRef { + _BugsEncounteredNotifierProviderElement(super.provider); + + @override + String get featureId => (origin as BugsEncounteredNotifierProvider).featureId; +} +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx new file mode 100644 index 000000000..0780f2135 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./family_and_dispose.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart new file mode 100644 index 000000000..8dfce9447 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart @@ -0,0 +1,27 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +/* SNIPPET START */ +class BugsEncounteredNotifier extends AutoDisposeFamilyAsyncNotifier { + @override + FutureOr build(String featureId) { + return 99; + } + + Future fix(int amount) async { + final old = await future; + final result = await ref.read(taskTrackerProvider).fix(id: this.arg, fixed: amount); + state = AsyncData(max(old - result, 0)); + } +} + +final bugsEncounteredNotifierProvider = + AsyncNotifierProvider.family.autoDispose( + BugsEncounteredNotifier.new, +); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart new file mode 100644 index 000000000..28f93a65c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart @@ -0,0 +1,30 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../utils.dart'; + +/* SNIPPET START */ +class BugsEncounteredNotifier extends StateNotifier> { + BugsEncounteredNotifier({ + required this.ref, + required this.featureId, + }) : super(const AsyncData(99)); + final String featureId; + final Ref ref; + + Future fix(int amount) async { + state = await AsyncValue.guard(() async { + final old = state.requireValue; + final result = await ref.read(taskTrackerProvider).fix(id: featureId, fixed: amount); + return max(old - result, 0); + }); + } +} + +final bugsEncounteredNotifierProvider = + StateNotifierProvider.family.autoDispose((ref, id) { + return BugsEncounteredNotifier(ref: ref, featureId: id); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart new file mode 100644 index 000000000..2c71d6144 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'from_state_provider.g.dart'; + +/* SNIPPET START */ +@riverpod +class CounterNotifier extends _$CounterNotifier { + @override + int build() => 0; + + @override + set state(int newState) => super.state = newState; + int update(int Function(int state) cb) => state = cb(state); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart new file mode 100644 index 000000000..9a3edeebc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -0,0 +1,28 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'from_state_provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$counterNotifierHash() => r'b32033040f0fff627f1a6dfd9cfb4e93a842390b'; + +/// See also [CounterNotifier]. +@ProviderFor(CounterNotifier) +final counterNotifierProvider = + AutoDisposeNotifierProvider.internal( + CounterNotifier.new, + name: r'counterNotifierProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$counterNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$CounterNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx new file mode 100644 index 000000000..f59794999 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./from_state_provider.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart new file mode 100644 index 000000000..97e4564f3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart @@ -0,0 +1,13 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/* SNIPPET START */ +class CounterNotifier extends Notifier { + @override + int build() => 0; + + @override + set state(int newState) => super.state = newState; + int update(int Function(int state) cb) => state = cb(state); +} + +final counterNotifierProvider = NotifierProvider(CounterNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart new file mode 100644 index 000000000..246f44a0c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart @@ -0,0 +1,6 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +final counterProvider = StateProvider((ref) { + return 0; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart new file mode 100644 index 000000000..53f142d5d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart @@ -0,0 +1,35 @@ +// ignore_for_file: unused_local_variable,omit_local_variable_types + +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class MyNotifier extends AutoDisposeNotifier { + @override + int build() { + return 0; + } +} + +final myNotifierProvider = + NotifierProvider.autoDispose(MyNotifier.new); + +/* SNIPPET START */ +void main(List args) { + test('my test', () { + final container = ProviderContainer(); + addTearDown(container.dispose); + + // 获取通知者程序 + /* highlight-start */ + final AutoDisposeNotifier notifier = + container.read(myNotifierProvider.notifier); + /* highlight-end */ + + // 获取其暴露状态 + /* highlight-start */ + final int state = container.read(myNotifierProvider); + /* highlight-end */ + + // TODO 编写您的测试 + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx new file mode 100644 index 000000000..9b77f551a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./old_lifecycles.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart new file mode 100644 index 000000000..deceee786 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart @@ -0,0 +1,36 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'old_lifecycles.g.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // 只需在此处读取/写入代码，一目了然 + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); + // `mounted` 已不复存在！ + state++; // 这可能会抛出。 + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart new file mode 100644 index 000000000..d28e242a3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'old_lifecycles.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'0495c52ce893ee0304d4d5ac5648c634ed4a241e'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart new file mode 100644 index 000000000..2e0718348 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart @@ -0,0 +1,35 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + // 只需在此处读取/写入代码，一目了然 + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); + // `mounted` 已不复存在！ + state++; // 这可能会抛出。 + } +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx new file mode 100644 index 000000000..9823b1564 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./old_lifecycles_final.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart new file mode 100644 index 000000000..64a7481f3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart @@ -0,0 +1,38 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'old_lifecycles_final.g.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // 只需在此处读取/写入代码，一目了然 + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + final cancelToken = CancelToken(); + ref.onDispose(cancelToken.cancel); + await ref.read(repositoryProvider).update(state + 1, token: cancelToken); + // 调用 `cancelToken.cancel` 时，会抛出一个自定义异常 + state++; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart new file mode 100644 index 000000000..7c55609e1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'old_lifecycles_final.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$myNotifierHash() => r'8ea2586ea29d12306efd4b8b847142136dd20338'; + +/// See also [MyNotifier]. +@ProviderFor(MyNotifier) +final myNotifierProvider = + AutoDisposeNotifierProvider.internal( + MyNotifier.new, + name: r'myNotifierProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$myNotifierHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef _$MyNotifier = AutoDisposeNotifier; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart new file mode 100644 index 000000000..5a9e6329c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart @@ -0,0 +1,37 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + // 只需在此处读取/写入代码，一目了然 + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + final cancelToken = CancelToken(); + ref.onDispose(cancelToken.cancel); + await ref.read(repositoryProvider).update(state + 1, token: cancelToken); + // 调用 `cancelToken.cancel` 时，会抛出一个自定义异常 + state++; + } +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart new file mode 100644 index 000000000..4d5251b5b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart @@ -0,0 +1,42 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends StateNotifier { + MyNotifier(this.ref, this.period) : super(0) { + // 1 初始化逻辑 + _timer = Timer.periodic(period, (t) => update()); // 2 初始化副作用 + } + final Duration period; + final Ref ref; + late final Timer _timer; + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); // 3 发生突变 + if (mounted) state++; // 4 检测挂载属性 + } + + @override + void dispose() { + _timer.cancel(); // 5 自定义处置逻辑 + super.dispose(); + } +} + +final myNotifierProvider = StateNotifierProvider((ref) { + // 6 提供者程序定义 + final period = ref.watch(durationProvider); // 7 反应式依赖逻辑 + return MyNotifier(ref, period); // 8 传递 `ref` +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.dart new file mode 100644 index 000000000..e515b6f94 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.dart @@ -0,0 +1,23 @@ +import 'dart:math' as math; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +final randomProvider = Provider((ref) { + return math.Random().nextInt(6); +}); + +final taskTrackerProvider = Provider((ref) { + return TaskTrackerRepo(); +}); + +class TaskTrackerRepo { + Future fix({required String id, required int fixed}) async => 0; +} + +final durationProvider = Provider((ref) { + return Duration.zero; +}); + +final availableWaterProvider = Provider((ref) { + return 40; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx index 86f9f374f..9d8f62db8 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx @@ -2,47 +2,58 @@ title: ChangeNotifierProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import todos from "!!raw-loader!/docs/providers/change_notifier_provider/todos.dart"; import todosConsumer from "!!raw-loader!/docs/providers/change_notifier_provider/todos_consumer.dart"; -import { trimSnippet, Foo } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet } from "@site/src/components/CodeSnippet"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -`ChangeNotifierProvider` (来自 flutter_riverpod/hooks_riverpod) -是一个用于监听和暴露Flutter本身的 [ChangeNotifier] 的provider。 +`ChangeNotifierProvider` (flutter_riverpod/hooks_riverpod only) is a provider that +is used to listen to and expose a [ChangeNotifier] from Flutter itself. -Riverpod不鼓励使用 `ChangeNotifierProvider` ，它的存在主要是为了： +Using `ChangeNotifierProvider` is discouraged by Riverpod and exists primarily for: - an easy transition from `package:provider` when using its `ChangeNotifierProvider` -- 当使用它的 `ChangeNotifierProvider` 时，简单地从 `package:provider` 迁移。 -- 支持可变状态，即使不可变的状态更好。 +- supporting mutable state, even though immutable state is preferred :::info -更倾向于使用 [StateNotifierProvider]。 -只有在绝对需要可变状态时才考虑使用 `ChangeNotifierProvider`。 +Prefer using [NotifierProvider] instead. +Consider using `ChangeNotifierProvider` only if you are absolutely certain +that you want mutable state. ::: -使用可变状态而不是不可变状态有时会更高效。 -但缺点是它可能更难维护，并可能破坏各种功能。 -比如说如果状态是可变的， -用于优化widget重新构建的 `provider.select` 可能不起作用， -因为Select会认为值没有改变。 -因此，使用不可变的数据结构有时会更快。 -制定特定用例的基准测试非常重要，以确保通过使用 `ChangeNotifierProvider` 时能真正获得性能。 +Using mutable state instead of immutable state can sometimes be more efficient. +The downside is, it can be harder to maintain and may break various features. +For example, using `provider.select` to optimize rebuilds of your widgets +may not work if your state is mutable, as `select` will think that the value +hasn't changed. +As such, using immutable data structures can sometimes be faster. Therefore +it is important to make benchmarks specific to your use-case, to make sure +that you are truly gaining performance by using `ChangeNotifierProvider`. -下面是用法示例，我们可以使用 `ChangeNotifierProvider` 来实现待办清单。 -这样做将允许我们公开 `addTodo` 等方法，让UI修改用户交互中的待办清单： +As a usage example, we could use `ChangeNotifierProvider` to implement a todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: {trimSnippet(todos)} -现在我们已经定义了一个 `ChangeNotifierProvider`， -我们可以用它来与UI中的待办清单交互： +Now that we have defined a `ChangeNotifierProvider`, we can use it to interact +with the list of todos in our UI: {trimSnippet(todosConsumer)} [state_notifier]: https://pub.dev/packages/state_notifier [statenotifierprovider]: ./state_notifier_provider +[notifierprovider]: ./notifier_provider [changenotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html [provider]: ./provider [futureprovider]: ./future_provider diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart index c181f8fd7..d766920b1 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart @@ -32,16 +32,13 @@ class TodosNotifier extends ChangeNotifier { // Let's mark a todo as completed void toggle(String todoId) { - for (final todo in todos) { - if (todo.id == todoId) { - todo.completed = !todo.completed; - notifyListeners(); - } - } + final todo = todos.firstWhere((todo) => todo.id == todoId); + todo.completed = !todo.completed; + notifyListeners(); } } -// Finally, we are using StateNotifierProvider to allow the UI to interact with +// Finally, we are using ChangeNotifierProvider to allow the UI to interact with // our TodosNotifier class. final todosProvider = ChangeNotifierProvider((ref) { return TodosNotifier(); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider.mdx index 34af86f85..6feb07d83 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider.mdx @@ -3,51 +3,63 @@ title: FutureProvider version: 1 --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; import configProvider from "./future_provider/config_provider"; import configConsumer from "./future_provider/config_consumer"; -import { trimSnippet,AutoSnippet} from "../../../../../src/components/CodeSnippet"; +import { AutoSnippet} from "@site/src/components/CodeSnippet"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -`FutureProvider` 与 [Provider] 类似，但用在异步代码中。 +`FutureProvider` is the equivalent of [Provider] but for asynchronous code. -`FutureProvider` 一般用于： +`FutureProvider` is typically used for: -- 执行和缓存异步操作 (比如网络请求) -- 能很好地处理异步操作中的错误/加载中的状态 -- 将多个异步的值组合为另一个异步的值 +- performing and caching asynchronous operations (such as network requests) +- nicely handling error/loading states of asynchronous operations +- combining multiple asynchronous values into another value -`FutureProvider` 与 [ref.watch] 结合使用有很多好处。 -这种组合允许在某些变量改变时自动重新获取一些数据，确保我们总是拥有最新的值。 +`FutureProvider` gains a lot when combined with [ref.watch]. This combination +allows automatic re-fetching of some data when some variables change, +ensuring that we always have the most up-to-date value. :::info -`FutureProvider` 不提供给用户交互后直接修改计算结果的方法。它被设计用来解决简单的用例。 -对于更高级的场景请考虑使用 [StateNotifierProvider] 。 +`FutureProvider` does not offer a way of directly modifying the computation after +a user interaction. It is designed to solve simple use-cases. +For more advanced scenarios, consider using [AsyncNotifierProvider]. ::: -## 用法示例：读取配置文件 +## Usage example: reading a configuration file -`FutureProvider` 可以是一种通过读取JSON文件创建的 `Configuration` 对象的便捷方法。 +`FutureProvider` can be a convenient way to expose a `Configuration` object +created by reading a JSON file. -在provider内部使用的async/await语法创建配置。 -再加上使用Flutter的资产系统，举个例子： +Creating the configuration would be done with your typical async/await +syntax, but inside the provider. +Using Flutter's asset system, this would be: -接着，UI可以像这样监听配置： +Then, the UI can listen to configurations like so: -这将在 [Future] 完成时自动重新构建UI。 -同时，如果多个widget需要配置，Flutter资产将只载入一次。 +This will automatically rebuild the UI when the [Future] completes. +At the same time, if multiple widgets want the configurations, +the asset will be decoded only once. -如你所见，在widget中监听 `FutureProvider` 会返回一个 [AsyncValue] ， -它允许你处理错误/加载中的状态。 +As you can see, listening to a `FutureProvider` inside a widget returns +an [AsyncValue] – which allows handling the error/loading states. [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider -[statenotifierprovider]: ./state_notifier_provider +[asyncnotifierprovider]: ./notifier_provider [provider]: ./provider [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html [future]: https://api.dart.dev/dart-async/Future-class.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart index 7f8e854f2..a96f35e72 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart @@ -3,17 +3,14 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import '../config_provider/codegen.dart'; - /* SNIPPET START */ Widget build(BuildContext context, WidgetRef ref) { final config = ref.watch(fetchConfigurationProvider); - return config.when( - loading: () => const CircularProgressIndicator(), - error: (err, stack) => Text('Error: $err'), - data: (config) { - return Text(config.host); - }, - ); + return switch (config) { + AsyncError(:final error) => Text('Error: $error'), + AsyncData(:final value) => Text(value.host), + _ => const CircularProgressIndicator(), + }; } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart index 3f9e2231c..44d9b4df9 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart @@ -11,12 +11,11 @@ class MyConfiguration extends HookConsumerWidget { Widget build(BuildContext context, WidgetRef ref) { final config = ref.watch(configProvider); return Scaffold( - body: config.when( - loading: () => const Center(child: CircularProgressIndicator()), - error: (err, stack) => Center(child: Text('Error: $err')), - data: (config) { - return Center(child: Text(config.host)); + body: switch (config) { + AsyncError(:final error) => Center(child: Text('Error: $error')), + AsyncData(:final value) => Center(child: Text(value.host)), + _ => const Center(child: CircularProgressIndicator()), }, - )); + ); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart index ece077f72..ade0628fd 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart @@ -3,23 +3,20 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import '../config_provider/codegen.dart'; - - /* SNIPPET START */ -class MyConfiguration extends HookConsumerWidget { +class MyConfiguration extends HookConsumerWidget { const MyConfiguration({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { final config = ref.watch(fetchConfigurationProvider); return Scaffold( - body: config.when( - loading: () => const Center(child: CircularProgressIndicator()), - error: (err, stack) => Center(child: Text('Error: $err')), - data: (config) { - return Center(child: Text(config.host)); + body: switch (config) { + AsyncError(:final error) => Center(child: Text('Error: $error')), + AsyncData(:final value) => Center(child: Text(value.host)), + _ => const Center(child: CircularProgressIndicator()), }, - )); + ); } -} \ No newline at end of file +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart index 4176a3866..9d39f3bcd 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart @@ -10,11 +10,9 @@ import '../config_provider/raw.dart'; Widget build(BuildContext context, WidgetRef ref) { AsyncValue config = ref.watch(configProvider); - return config.when( - loading: () => const CircularProgressIndicator(), - error: (err, stack) => Text('Error: $err'), - data: (config) { - return Text(config.host); - }, - ); + return switch (config) { + AsyncData(:final value) => Text(value.host), + AsyncError(:final error) => Text('Error: $error'), + _ => const CircularProgressIndicator(), + }; } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx index 54468b905..601f06da1 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx @@ -2,41 +2,54 @@ title: (Async)NotifierProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import todos from "./notifier_provider/todos"; import todosConsumer from "!!raw-loader!/docs/providers/notifier_provider/todos/todos_consumer.dart"; import remoteTodos from "./notifier_provider/remote_todos"; import remoteTodosConsumer from "!!raw-loader!/docs/providers/notifier_provider/remote_todos/todos_consumer.dart"; -import { trimSnippet, AutoSnippet } from "../../../../../src/components/CodeSnippet"; - -[NotifierProvider] 是一个监听和暴露 [Notifier] 的provider。 -[AsyncNotifier] 是一个可以异步初始化的 [Notifier]。 -[AsyncNotifierProvider] 是一个用于监听和公开 [AsyncNotifier] 的provider。 -`(Async)NotifierProvider` 和 `(Async)Notifier` 是Riverpod推荐的管理状态的方案， -这些状态可能会因用户交互而发生变化。 - -它一般用于： - -- 暴露在对自定义事件做出反应后可以随时间推移变化的状态。 -- 修改某些状态的逻辑(又名“业务逻辑”)集中在一个地方，随着时间的推移也能提高可维护性。 - -作为使用示例，我们使用 [NotifierProvider] 来实现一个待办清单。 -这样做将允许我们公开 `addTodo` 等方法，让UI在用户交互时修改待办清单的列表： +import { trimSnippet, AutoSnippet } from "@site/src/components/CodeSnippet"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: + +[NotifierProvider] is a provider that is used to listen to and expose a [Notifier]. +[AsyncNotifierProvider] is a provider that is used to listen to and expose an [AsyncNotifier]. +[AsyncNotifier] is a [Notifier] that can be asynchronously initialized. +`(Async)NotifierProvider` along with `(Async)Notifier` is Riverpod's recommended solution +for managing state which may change in reaction to a user interaction. + +It is typically used for: + +- exposing a state which can change over time after reacting to custom events. +- centralizing the logic for modifying some state (aka "business logic") in a + single place, improving maintainability over time. + +As a usage example, we could use [NotifierProvider] to implement a todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: -现在我们定义了一个 [NotifierProvider] ，我们可以使用它来与UI中的待办清单列表交互： +Now that we have defined a [NotifierProvider], we can use it to interact +with the list of todos in our UI: {trimSnippet(todosConsumer)} -下面的使用示例，我们可以使用 [AsyncNotifierProvider] 来实现一个远程待办清单列表。 -这样做将允许我们暴露 `addTodo` 等方法，让UI在用户交互时修改待办清单列表： +As a usage example, we could use [AsyncNotifierProvider] to implement a remote todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: -现在我们已经定义了一个 [AsyncNotifierProvider] ，我们可以使用它来与UI中的待办清单交互： +Now that we have defined a [AsyncNotifierProvider], we can use it to interact +with the list of todos in our UI: {trimSnippet(remoteTodosConsumer)} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart index 8e3e06122..e02195f87 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart @@ -28,11 +28,13 @@ class Todo with _$Todo { factory Todo.fromJson(Map json) => _$TodoFromJson(json); } -// 这会生成一个 AsyncNotifier 和 AsyncNotifierProvider。 -// Notifier类将会被传递给我们的 AsyncNotifierProvider。 -// 这个类不应该在其“state”属性之外暴露状态，也就是说没有公共的获取属性的方法！ -// 这个类上的公共方法将允许UI修改它的状态。 -// 最后我们使用asyncTodosProvider(AsyncNotifierProvider)来允许UI与我们的Todos类进行交互。 +// This will generates a AsyncNotifier and AsyncNotifierProvider. +// The AsyncNotifier class that will be passed to our AsyncNotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +// Finally, we are using asyncTodosProvider(AsyncNotifierProvider) to allow the UI to +// interact with our Todos class. @riverpod class AsyncTodos extends _$AsyncTodos { Future> _fetchTodo() async { @@ -43,21 +45,21 @@ class AsyncTodos extends _$AsyncTodos { @override FutureOr> build() async { - // 从远程仓库获取初始的待办清单 + // Load initial todo list from the remote repository return _fetchTodo(); } Future addTodo(Todo todo) async { - // 将当前状态设置为加载中 + // Set the state to loading state = const AsyncValue.loading(); - // 将新的待办清单添加到远程仓库 + // Add the new todo and reload the todo list from the remote repository state = await AsyncValue.guard(() async { await http.post('api/todos', todo.toJson()); return _fetchTodo(); }); } - // 让我们允许删除待办清单 + // Let's allow removing todos Future removeTodo(String todoId) async { state = const AsyncValue.loading(); state = await AsyncValue.guard(() async { @@ -66,7 +68,7 @@ class AsyncTodos extends _$AsyncTodos { }); } - // 让我们把待办清单标记为已完成 + // Let's mark a todo as completed Future toggle(String todoId) async { state = const AsyncValue.loading(); state = await AsyncValue.guard(() async { diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart index 315bc924e..d1b8a01d5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); Todo _$TodoFromJson(Map json) { return _Todo.fromJson(json); @@ -134,7 +134,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart index e91f812e1..f4455a338 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart @@ -14,8 +14,8 @@ final http = Http(); /* SNIPPET START */ -// 最好使用不可变状态。 -// 我们还可以使用像 freezed 这样的package来帮助实现不可变。 +// An immutable state is preferred. +// We could also use packages like Freezed to help with the implementation. @immutable class Todo { const Todo({ @@ -32,7 +32,7 @@ class Todo { ); } - // 在我们的类中所有的属性都应该是 `final` 的。 + // All properties should be `final` on our class. final String id; final String description; final bool completed; @@ -44,9 +44,10 @@ class Todo { }; } -// Notifier类将会被传递给我们的NotifierProvider。 -// 这个类不应该在其“state”属性之外暴露状态，也就是说没有公共的获取属性的方法！ -// 这个类上的公共方法将允许UI修改它的状态。 +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. class AsyncTodosNotifier extends AsyncNotifier> { Future> _fetchTodo() async { final json = await http.get('api/todos'); @@ -56,21 +57,21 @@ class AsyncTodosNotifier extends AsyncNotifier> { @override Future> build() async { - // 从远程仓库获取初始的待办清单 + // Load initial todo list from the remote repository return _fetchTodo(); } Future addTodo(Todo todo) async { - // 将当前状态设置为加载中 + // Set the state to loading state = const AsyncValue.loading(); - // 将新的待办清单添加到远程仓库 + // Add the new todo and reload the todo list from the remote repository state = await AsyncValue.guard(() async { await http.post('api/todos', todo.toJson()); return _fetchTodo(); }); } - // 让我们允许删除待办清单 + // Let's allow removing todos Future removeTodo(String todoId) async { state = const AsyncValue.loading(); state = await AsyncValue.guard(() async { @@ -79,7 +80,7 @@ class AsyncTodosNotifier extends AsyncNotifier> { }); } - // 让我们把待办清单标记为已完成 + // Let's mark a todo as completed Future toggle(String todoId) async { state = const AsyncValue.loading(); state = await AsyncValue.guard(() async { @@ -92,7 +93,8 @@ class AsyncTodosNotifier extends AsyncNotifier> { } } -// 最后，我们使用NotifierProvider来允许UI与我们的TodosNotifier类交互。 +// Finally, we are using NotifierProvider to allow the UI to interact with +// our TodosNotifier class. final asyncTodosProvider = AsyncNotifierProvider>(() { return AsyncTodosNotifier(); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart index ae829eee4..5d00d05d9 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart @@ -16,23 +16,22 @@ class TodoListView extends ConsumerWidget { final asyncTodos = ref.watch(asyncTodosProvider); // Let's render the todos in a scrollable list view - return asyncTodos.when( - data: (todos) => ListView( - children: [ - for (final todo in todos) - CheckboxListTile( - value: todo.completed, - // When tapping on the todo, change its completed status - onChanged: (value) => - ref.read(asyncTodosProvider.notifier).toggle(todo.id), - title: Text(todo.description), - ), - ], - ), - loading: () => const Center( - child: CircularProgressIndicator(), - ), - error: (err, stack) => Text('Error: $err'), - ); + return switch (asyncTodos) { + AsyncData(:final value) => ListView( + children: [ + for (final todo in value) + CheckboxListTile( + value: todo.completed, + // When tapping on the todo, change its completed status + onChanged: (value) { + ref.read(asyncTodosProvider.notifier).toggle(todo.id); + }, + title: Text(todo.description), + ), + ], + ), + AsyncError(:final error) => Text('Error: $error'), + _ => const Center(child: CircularProgressIndicator()), + }; } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart index b1999c2ea..866ed37bb 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart @@ -15,11 +15,13 @@ class Todo with _$Todo { }) = _Todo; } -// 这会生成一个Notifier 和 NotifierProvider。 -// Notifier类将会被传递给我们的NotifierProvider。 -// 这个类不应该在其“state”属性之外暴露状态，也就是说没有公共的获取属性的方法！ -// 这个类上的公共方法将允许UI修改它的状态。 -// 最后我们使用todosProvider(NotifierProvider)来允许UI与我们的Todos类进行交互。 +// This will generates a Notifier and NotifierProvider. +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +// Finally, we are using todosProvider(NotifierProvider) to allow the UI to +// interact with our Todos class. @riverpod class Todos extends _$Todos { @override @@ -27,37 +29,39 @@ class Todos extends _$Todos { return []; } - // 让我们添加UI添加待办清单 + // Let's allow the UI to add todos. void addTodo(Todo todo) { - // 由于状态是不可变的，因此不允许执行 `state.add(todo)`。 - // 相反，我们应该创建一个包含以前的项目和新的项目的待办清单列表。 - // 在这里使用Dart的扩展运算符很有用！ + // Since our state is immutable, we are not allowed to do `state.add(todo)`. + // Instead, we should create a new list of todos which contains the previous + // items and the new one. + // Using Dart's spread operator here is helpful! state = [...state, todo]; - // 不需要调用“notifyListeners”或其他类似的方法。 - // 直接 “state =” 就能自动在需要时重新构建UI。 + // No need to call "notifyListeners" or anything similar. Calling "state =" + // will automatically rebuild the UI when necessary. } - // 让我们允许删除待办清单 + // Let's allow removing todos void removeTodo(String todoId) { - // 同样我们的状态是不可变的。 - // 所以我们创建了一个新的列表，而不是改变现存的列表。 + // Again, our state is immutable. So we're making a new list instead of + // changing the existing list. state = [ for (final todo in state) if (todo.id != todoId) todo, ]; } - // 让我们把待办清单标记为已完成 + // Let's mark a todo as completed void toggle(String todoId) { state = [ for (final todo in state) - // 我们只标记完成的待办清单 + // we're marking only the matching todo as completed if (todo.id == todoId) - // 再一次因为我们的状态是不可变的，所以我们需要创建待办清单的副本， - // 我们使用之前实现的copyWith方法来实现。 + // Once more, since our state is immutable, we need to make a copy + // of the todo. We're using our `copyWith` method implemented before + // to help with that. todo.copyWith(completed: !todo.completed) else - // 其他未修改的待办清单 + // other todos are not modified todo, ]; } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart index a04416833..0b73d3548 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart @@ -12,7 +12,7 @@ part of 'codegen.dart'; T _$identity(T value) => value; final _privateConstructorUsedError = UnsupportedError( - 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods'); + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); /// @nodoc mixin _$Todo { @@ -126,7 +126,7 @@ class _$TodoImpl implements _Todo { } @override - bool operator ==(dynamic other) { + bool operator ==(Object other) { return identical(this, other) || (other.runtimeType == runtimeType && other is _$TodoImpl && diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart index 05a3c7174..ec3e50308 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart @@ -3,8 +3,8 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; /* SNIPPET START */ -// 最好使用不可变状态。 -// 我们还可以使用像 freezed 这样的package来帮助实现不可变。 +// An immutable state is preferred. +// We could also use packages like Freezed to help with the implementation. @immutable class Todo { const Todo({ @@ -13,12 +13,13 @@ class Todo { required this.completed, }); - // 在我们的类中所有的属性都应该是 `final` 的。 + // All properties should be `final` on our class. final String id; final String description; final bool completed; - // 由于Todo是不可变的，我们实现了一种方法允许克隆内容略有不同的Todo。 + // Since Todo is immutable, we implement a method that allows cloning the + // Todo with slightly different content. Todo copyWith({String? id, String? description, bool? completed}) { return Todo( id: id ?? this.id, @@ -28,53 +29,57 @@ class Todo { } } -// Notifier类将会被传递给我们的NotifierProvider。 -// 这个类不应该在其“state”属性之外暴露状态，也就是说没有公共的获取属性的方法！ -// 这个类上的公共方法将允许UI修改它的状态。 +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. class TodosNotifier extends Notifier> { - // 我们将待办清单的列表初始化 + // We initialize the list of todos to an empty list @override List build() { return []; } - // 让我们添加UI添加待办清单 + // Let's allow the UI to add todos. void addTodo(Todo todo) { - // 由于状态是不可变的，因此不允许执行 `state.add(todo)`。 - // 相反，我们应该创建一个包含以前的项目和新的项目的待办清单列表。 - // 在这里使用Dart的扩展运算符很有用！ + // Since our state is immutable, we are not allowed to do `state.add(todo)`. + // Instead, we should create a new list of todos which contains the previous + // items and the new one. + // Using Dart's spread operator here is helpful! state = [...state, todo]; - // 不需要调用“notifyListeners”或其他类似的方法。 - // 直接 “state =” 就能自动在需要时重新构建UI。 + // No need to call "notifyListeners" or anything similar. Calling "state =" + // will automatically rebuild the UI when necessary. } - // 让我们允许删除待办清单 + // Let's allow removing todos void removeTodo(String todoId) { - // 同样我们的状态是不可变的。 - // 所以我们创建了一个新的列表，而不是改变现存的列表。 + // Again, our state is immutable. So we're making a new list instead of + // changing the existing list. state = [ for (final todo in state) if (todo.id != todoId) todo, ]; } - // 让我们把待办清单标记为已完成 + // Let's mark a todo as completed void toggle(String todoId) { state = [ for (final todo in state) - // 我们只标记完成的待办清单 + // we're marking only the matching todo as completed if (todo.id == todoId) - // 再一次因为我们的状态是不可变的，所以我们需要创建待办清单的副本， - // 我们使用之前实现的copyWith方法来实现。 + // Once more, since our state is immutable, we need to make a copy + // of the todo. We're using our `copyWith` method implemented before + // to help with that. todo.copyWith(completed: !todo.completed) else - // 其他未修改的待办清单 + // other todos are not modified todo, ]; } } -// 最后，我们使用NotifierProvider来允许UI与我们的TodosNotifier类交互。 +// Finally, we are using NotifierProvider to allow the UI to interact with +// our TodosNotifier class. final todosProvider = NotifierProvider>(() { return TodosNotifier(); }); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart index 23430ced6..192cb9f66 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart @@ -12,16 +12,16 @@ class TodoListView extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 当待办事项列表变更时重新构建widget + // rebuild the widget when the todo list changes List todos = ref.watch(todosProvider); - // 让我们在一个可滚动的列表视图中呈现待办清单 + // Let's render the todos in a scrollable list view return ListView( children: [ for (final todo in todos) CheckboxListTile( value: todo.completed, - // 当在清单上点击时更改它的完成状态。 + // When tapping on the todo, change its completed status onChanged: (value) => ref.read(todosProvider.notifier).toggle(todo.id), title: Text(todo.description), diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider.mdx index a0e1f05f7..d0ed99725 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider.mdx @@ -2,86 +2,108 @@ title: Provider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import todo from "./provider/todo"; import completedTodos from "./provider/completed_todos"; import todosConsumer from "!!raw-loader!/docs/providers/provider/todos_consumer.dart"; import unoptimizedPreviousButton from "./provider/unoptimized_previous_button"; import optimizedPreviousButton from "./provider/optimized_previous_button"; -import { trimSnippet, AutoSnippet } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet, AutoSnippet } from "@site/src/components/CodeSnippet"; -在所有的provider中 `Provider` 是最基础的。它创造了一个值……差不多就是这样。 +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -`Provider` 一般用在： +`Provider` is the most basic of all providers. It creates a value... And that's about it. -- 缓存计算。 -- 向其他provider(比如`Repository`/`HttpClient`)暴露一个值。 -- 为测试或widget提供重写值的方法。 -- 减少 provider/widget 的重新构建，不必使用 `select`。 +`Provider` is typically used for: -## 使用 `Provider` 缓存计算 +- caching computations +- exposing a value to other providers (such as a `Repository`/`HttpClient`). +- offering a way for tests or widgets to override a value. +- reducing rebuilds of providers/widgets without having to use `select`. -`Provider` 是与 [ref.watch] 结合使用时用于缓存同步操作的强大的工具。 +## Using `Provider` to cache computations -例如筛选待办清单。 -由于筛选列表的性能开销可能略高，所以理想情况下，当应用重新渲染时我们不希望再筛选一遍待办列表。 -在这种情况，我们可以使用 `Provider` 为我们进行筛选。 +`Provider` is a powerful tool for caching synchronous operations when combined +with [ref.watch]. -为此，假设我们的应用程序有一个 [StateNotifierProvider] ，它操作待办清单的列表： +An example would be filtering a list of todos. +Since filtering a list could be slightly expensive, we ideally do not want to +filter our list of todos whenever our application re-renders. +In this situation, we could use `Provider` to do the filtering for us. + +For that, assume that our application has an existing [NotifierProvider] +which manipulates a list of todos: -接着，我们可以使用 `Provider` 暴露经过筛选的待办清单列表，只显示完成的待办事项： +From there, we can use `Provider` to expose the filtered list of todos, showing +only the completed todos: -使用这段代码，我们的UI现在可以通过监听 `completedTodosProvider` 来显示完成的待办清单列表： +With this code, our UI is now able to show the list of the completed todos +by listening to `completedTodosProvider`: {trimSnippet(todosConsumer)} -有趣的是，这个筛选列表现在被缓存起来了。 +The interesting part is, the list filtering is now cached. -这也就意味着不管我们阅读多少次已经完成的待办清单，只要在添加/删除/更新待办清单之前， -这个筛选的列表也不会被重新计算。 +Meaning that the list of completed todos will not be recomputed until +todos are added/removed/updated, even if we are reading the list of completed +todos multiple times. -注意，当待办清单列表发生更改时我们不需要手动使缓存失效。多亏了 [ref.watch] ， -`Provider`能够自动知道什么时候应该重新计算结果。 +Note how we do not need to manually invalidate the cache when the list of todos +changes. `Provider` is automatically able to know when the result must be recomputed +thanks to [ref.watch]. -## 使用`Provider` 减少provider/widget的重新构建 +## Reducing provider/widget rebuilds by using `Provider` -`Provider` 独特的地方在于，就算在重新计算 `Provider` 时(通常在使用[ref.watch]时)， -它也不会更新监听它的widget/provider，除非当中的值发生了变化。 +A unique aspect of `Provider` is that even when `Provider` is recomputed +(typically when using [ref.watch]), it will not update the widgets/providers +that listen to it unless the value changed. -一个真实的例子是启用/禁用分页视图中的上一个/下一个按钮： +A real world example would be for enabling/disabling previous/next buttons +of a paginated view: ![stepper example](https://user-images.githubusercontent.com/134939/47580830-31263a00-d950-11e8-9b61-0eaddab2709e.png) -在这个例子中，我们特别关注在这个“previous”按钮。 -这个按钮将用widget实现，它获取当前页面的索引，如果索引为0时，我们将禁用这个按钮。 +In our case, we will focus specifically on the "previous" button. +A naive implementation of such button would be a widget which obtains the +current page index, and if that index is equal to 0, we would disable the button. -这段代码可以是： +This code could be: -这段代码的问题是，每当我们更改当前页面时，“previous”按钮将重新构建。 -在理想情况下，我们希望按钮仅在激活和停用之间更改时重新构建。 +The issue with this code is that whenever we change the current page, the "previous" +button will rebuild. +In the ideal world, we would want the button to rebuild only when changing between +activated and deactivated. -但问题的根源在于我们在build函数内计算是否允许用户在“previous”按钮内直接转到上一页。 +The root of the issue here is that we are computing whether the user is +allowed to go to the previous page directly within the "previous" button. -为了解决这个问题，我们将这个逻辑从widget中提取出来放到provider里面： +A way to solve this is to extract this logic outside of the widget and into a `Provider`: -通过这样的小重构，多亏了 `Provider` 我们的 `PreviousButton` widget 当页面索引变化时将不再重新构建。 +By doing this small refactoring, our `PreviousButton` widget will no longer +rebuild when the page index changes thanks to `Provider`. -从现在开始，当页面索引改变时，我们的 `canGoToPreviousPageProvider` 将被重新计算。 -但是如果provider暴露的值没有改变，那么 `PreviousButton` 将不会重新构建。 +From now on when the page index changes, our `canGoToPreviousPageProvider` provider +will be recomputed. But if the value exposed by the provider does not change, +then `PreviousButton` will not rebuild. This change both improved the performance of our button and had the interesting benefit of extracting the logic outside of our widget. -这一更改提高了按钮的性能，还有一个有趣的好处，就是将逻辑抽离到widget之外。 [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider -[statenotifierprovider]: ./state_notifier_provider +[notifierprovider]: ./notifier_provider diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart index 3529f403e..1a29d96f5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart @@ -10,6 +10,6 @@ part 'completed_todos.g.dart'; List completedTodos(CompletedTodosRef ref) { final todos = ref.watch(todosProvider); - // 我们只返回完成的待办事项 + // we return only the completed todos return todos.where((todo) => todo.isCompleted).toList(); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart index 568f13865..e24c48bd5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart @@ -5,9 +5,9 @@ import '../todo/raw.dart'; /* SNIPPET START */ final completedTodosProvider = Provider>((ref) { - // 我们从todosProvider获取所有待办清单 + // We obtain the list of all todos from the todosProvider final todos = ref.watch(todosProvider); - // // 我们只返回完成的待办事项 + // we return only the completed todos return todos.where((todo) => todo.isCompleted).toList(); }); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart index 4c4d99d7f..7d3b8a332 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart @@ -19,7 +19,7 @@ class PageIndex extends _$PageIndex { } } -// 一个计算是否允许用户跳转到上一页的provider +// A provider which computes whether the user is allowed to go to the previous page @riverpod /* highlight-start */ bool canGoToPreviousPage(CanGoToPreviousPageRef ref) { @@ -32,8 +32,8 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 现在我们观察我们新的provider， - // 当我们跳转到前一页时我们的widget不再需要计算。 + // We are now watching our new Provider + // Our widget is no longer calculating whether we can go to the previous page. /* highlight-start */ final canGoToPreviousPage = ref.watch(canGoToPreviousPageProvider); /* highlight-end */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart index 01727215d..30b1cc673 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; final pageIndexProvider = StateProvider((ref) => 0); -// 一个计算是否允许用户跳转到上一页的provider +// A provider which computes whether the user is allowed to go to the previous page /* highlight-start */ final canGoToPreviousPageProvider = Provider((ref) { /* highlight-end */ @@ -18,8 +18,8 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 现在我们观察我们新的provider， - // 当我们跳转到前一页时我们的widget不再需要计算。 + // We are now watching our new Provider + // Our widget is no longer calculating whether we can go to the previous page. /* highlight-start */ final canGoToPreviousPage = ref.watch(canGoToPreviousPageProvider); /* highlight-end */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart index f8722a998..11e62bc3a 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart @@ -10,15 +10,18 @@ class Todo { final String description; } -class TodosNotifier extends StateNotifier> { - TodosNotifier() : super([]); +class TodosNotifier extends Notifier> { + @override + List build() { + return []; + } void addTodo(Todo todo) { state = [...state, todo]; } - // TODO 添加其他方法，比如 “删除待办” …… + // TODO add other methods, such as "removeTodo", ... } -final todosProvider = StateNotifierProvider>((ref) { +final todosProvider = NotifierProvider>(() { return TodosNotifier(); }); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart index 34c3d432c..7089bc962 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart @@ -21,4 +21,5 @@ class Todos extends _$Todos { void addTodo(Todo todo) { state = [...state, todo]; } + // TODO add other methods, such as "removeTodo", ... } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart index aa99c4541..9b93e9185 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart @@ -10,7 +10,7 @@ Widget build() { /* SNIPPET START */ Consumer(builder: (context, ref, child) { final completedTodos = ref.watch(completedTodosProvider); - // TODO 使用ListView/GridView/……展示待办清单列表 /* SKIP */ + // TODO show the todos using a ListView/GridView/.../* SKIP */ return Container(); /* SKIP END */ }); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart index 9948a72fd..828d382d5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart @@ -11,7 +11,7 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 如果不是第一页，那么前一页按钮可用 + // if not on first page, the previous button is active final canGoToPreviousPage = ref.watch(pageIndexProvider) != 0; void goToPreviousPage() { diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart index 350d12563..f77de56c3 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart @@ -24,7 +24,7 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 如果不是第一页，那么前一页按钮可用 + // if not on first page, the previous button is active final canGoToPreviousPage = ref.watch(pageIndexProvider) != 0; void goToPreviousPage() { diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx index 9d0e1f475..1c237a279 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx @@ -2,30 +2,43 @@ title: StateNotifierProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import todos from "!!raw-loader!/docs/providers/state_notifier_provider/todos.dart"; import todosConsumer from "!!raw-loader!/docs/providers/state_notifier_provider/todos_consumer.dart"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet } from "@site/src/components/CodeSnippet"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -`StateNotifierProvider` 是一个用于监听和公开StateNotifier的provider(来自 [state_notifier] package，由Riverpod重新分发)。 +`StateNotifierProvider` is a provider that is used to listen to and expose a +[StateNotifier] (from the package [state_notifier], which Riverpod re-exports). -它一般用于： +It is typically used for: -- 暴露一个 **不可变** 的状态，在对自定义事件做出反应后可以随时间改变。 -- 修改某些状态的逻辑(又名“业务逻辑”)集中在一个地方，随着时间的推移也能提高可维护性。 +- exposing an **immutable** state which can change over time after reacting to + custom events. +- centralizing the logic for modifying some state (aka "business logic") in a + single place, improving maintainability over time. :::info -首选 [NotifierProvider] 。 +Prefer using [NotifierProvider] instead. ::: -我们可以使用 `StateNotifierProvider` 来实现一个待办清单列表。 -这样做将允许我们公开 `addTodo` 等方法，让UI在用户交互时修改todo列表，下面是示例： +As a usage example, we could use `StateNotifierProvider` to implement a todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: {trimSnippet(todos)} -现在我们已经定义了 `StateNotifierProvider` ，我们可以使用它来与UI中的待办清单列表交互： +Now that we have defined a `StateNotifierProvider`, we can use it to interact +with the list of todos in our UI: {trimSnippet(todosConsumer)} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider.mdx index 5aa4aa926..c65a571dd 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider.mdx @@ -2,8 +2,6 @@ title: StateProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import product from "!!raw-loader!/docs/providers/state_provider/product.dart"; import productListView from "!!raw-loader!/docs/providers/state_provider/product_list_view.dart"; @@ -13,105 +11,125 @@ import connectedDropdown from "!!raw-loader!/docs/providers/state_provider/conne import sortedProductProvider from "!!raw-loader!/docs/providers/state_provider/sorted_product_provider.dart"; import updateReadTwice from "!!raw-loader!/docs/providers/state_provider/update_read_twice.dart"; import updateReadOnce from "!!raw-loader!/docs/providers/state_provider/update_read_once.dart"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet } from "@site/src/components/CodeSnippet"; -StateProvider是一个公开了一种修改其状态的方法的provider。 -它是 [StateNotifierProvider] 的简化版，旨在避免为非常简单的用例编写 [StateNotifier] 类。 +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -`StateProvider` 的存在主要是为了允许用户界面对**简单**的变量进行修改。 -所以`StateProvider` 的状态通常为： +`StateProvider` is a provider that exposes a way to modify its state. +It is a simplification of [NotifierProvider], designed to avoid +having to write a [Notifier] class for very simple use-cases. -- 枚举类型，例如筛选器类型 -- 一段字符串(String)，通常是输入框的原始内容 -- 用于复选框的布尔类型 -- 用于分页或年龄表单字段的数字 +`StateProvider` exists primarily to allow the modification of +**simple** variables by the User Interface. +The state of a `StateProvider` is typically one of: -你不应该使用 `StateProvider` 如果： +- an enum, such as a filter type +- a String, typically the raw content of a text field +- a boolean, for checkboxes +- a number, for pagination or age form fields -- 你的状态需要验证逻辑 -- 你的状态是一个复杂的对象 (比如自定义的类, 集合……) -- 修改状态的逻辑比简单的 `count++` 更复杂 +You should not use `StateProvider` if: -对于更复杂的情况，可以考虑使用 [StateNotifierProvider] ，并创建一个 [StateNotifier] 类。 -虽然最初的样板文件会有点大， -但有一个自定义的 [StateNotifier] 类对于项目的长期可维护性是至关重要的， -因为它将状态的业务逻辑集中在了一个地方。 +- your state needs validation logic +- your state is a complex object (such as a custom class, a list/map, ...) +- the logic for modifying your state is more advanced than a simple `count++`. -## 使用示例：使用下拉菜单更改筛选类型 +For more advanced cases, consider using [NotifierProvider] instead and +create a [Notifier] class. +While the initial boilerplate will be a bit larger, having a custom +[Notifier] class is critical for the long-term maintainability of your +project – as it centralizes the business logic of your state in a single place. -`StateProvider` 的一个真实的用例是管理简单表单组件的状态，比如下拉菜单/输入框/复选框。 -特别来说，我们将看到如何使用 `StateProvider` 实现一个下拉菜单， -该下拉菜单允许更改产品列表的排序方式。 +## Usage example: Changing the filter type using a dropdown -为了简单起见，我们将在应用中直接构建将获得的产品列表，如下所示： +A real-world use-case of `StateProvider` would be to manage the state of +simple form components like dropdowns/text fields/checkboxes. +In particular, we will see how to use `StateProvider` to implement a dropdown +that allows changing how a list of products is sorted. + +For the sake of simplicity, the list of products that we will obtain +will be built directly in the application and will be as follows: {trimSnippet(product)} -在真实的应用程序中，我们通常会使用 [FutureProvider] 通过网络请求来获得该列表。 +In a real-world application, this list would typically be obtained using +[FutureProvider] by making a network request. -然后，可以在用户界面上通过下面的操作来显示产品列表： +The User Interface could then show the list of products by doing: {trimSnippet(productListView)} -现在我们已经完成了基础，我们可以添加一个下拉菜单， -它将按价格或名称过滤我们的产品。 -为此，我们将使用[DropDownButton](https://api.flutter.dev/flutter/material/DropdownButton-class.html)。 +Now that we're done with the base, we can add a dropdown, which will +allow filtering our products either by price or by name. +For that, we will use [DropDownButton](https://api.flutter.dev/flutter/material/DropdownButton-class.html). {trimSnippet(dropdown)} -现在我们有了一个下拉列表， -让我们创建一个 `StateProvider` 并将下拉菜单的状态与我们的provider同步。 +Now that we have a dropdown, let's create a `StateProvider` and +synchronize the state of the dropdown with our provider. -首先，让我们创建一个 `StateProvider`： +First, let's create the `StateProvider`: {trimSnippet(sortProvider)} -然后，我们可以通过下面的操作将这个provider与我们的下拉菜单连接起来： +Then, we can connect this provider with our dropdown by doing: {trimSnippet(connectedDropdown)} -有了这些，我们现在应该能够更改筛选的类型。 -不过它对产品列表没有影响！ -现在是最后一部分：更新我们的 `productsProvider` 以对产品列表进行排序。 +With this, we should now be able to change the sort type. +It has no impact on the list of products yet though! It's now time for the +final part: Updating our `productsProvider` to sort the list of products. -实现这一点的关键是使用 [ref.watch]， -让我们的 `productsProvider` 获得排序类型， -并在排序类型更改时重新计算产品列表。 +A key component of implementing this is to use [ref.watch], to have +our `productsProvider` obtain the sort type and recompute the list of +products whenever the sort type changes. -代码实现会是： +The implementation would be: {trimSnippet(sortedProductProvider)} -就是这样！这个变改足以让用户界面在排序类型更改时自动重绘产品列表。 +That's all! This change is enough for the User Interface to automatically +re-render the list of products when the sort type changes. -下面是在Dartpad上完整的例子： +Here is the complete example on Dartpad: -## 如何在不读取provider两次的情况下根据之前的值更新状态 +## How to update the state based on the previous value without reading the provider twice -有时你希望根据之前的值更新 `StateProvider` 的状态。 -自然而然，你可能会这样写： +Sometimes, you want to update the state of a `StateProvider` based on the previous value. +Naturally, you may end-up writing: {trimSnippet(updateReadTwice)} -虽然这段代码没有什么特别的错误，但是语法上着实有点不太方便。 +While there's nothing particularly wrong with this snippet, the syntax is a bit inconvenient. -为了更方便地使用，我们可以使用 `update` 函数。 -这个函数将接受一个回调函数，该回调函数将接收当前状态并返回新状态。 -我们可以使用它来重构之前的代码： +To make the syntax a bit better, we can use the `update` function. +This function will take a callback that will receive the current state and is expected +to return the new state. +We can use it to refactor our previous code to: {trimSnippet(updateReadOnce)} -这样就实现了相同的效果，而且使语法更好一些。 +This change achieves the same effect while making the syntax a bit better. [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider [ref.read]: ../concepts/reading#using-refread-to-obtain-the-state-of-a-provider-once [statenotifierprovider]: ./state_notifier_provider +[notifierprovider]: ./notifier_provider [futureprovider]: ./future_provider +[notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html [provider]: ./provider [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx index 5f6ff9be1..752b64aff 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx @@ -2,33 +2,54 @@ title: StreamProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; -import streamProvider from "!!raw-loader!/docs/providers/stream_provider/live_stream_chat_provider.dart"; +import { trimSnippet,AutoSnippet } from "@site/src/components/CodeSnippet"; +import streamProvider from "./stream_provider/live_stream_chat_provider"; import streamConsumer from "!!raw-loader!/docs/providers/stream_provider/live_stream_chat_consumer.dart"; +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: + `StreamProvider` is similar to [FutureProvider] but for [Stream]s instead of [Future]s. -`FutureProvider` 与 [Provider] 类似，但用在 [Stream] 中而不是 [Future]。 -`StreamProvider` 一般用于： +`StreamProvider` is usually used for: + +- listening to Firebase or web-sockets +- rebuilding another provider every few seconds + +Since [Stream]s naturally expose a way for listening to updates, some may think +that using `StreamProvider` has a low value. In particular, you may believe that +Flutter's [StreamBuilder] would work just as well for listening to a [Stream], but +this is a mistake. + +Using `StreamProvider` over [StreamBuilder] has numerous benefits: -- 监听Firebase或web-sockets -- 每隔几秒重建另一个provider +- it allows other providers to listen to the stream using [ref.watch]. +- it ensures that loading and error cases are properly handled, thanks to [AsyncValue]. +- it removes the need for having to differentiate broadcast streams vs normal streams. +- it caches the latest value emitted by the stream, ensuring that if a + listener is added after an event is emitted, the listener will still have + immediate access to the most up-to-date event. +- it allows easily mocking the stream during tests by overriding the `StreamProvider`. -由于 [Stream] 自然地公开了一种监听更新的方式，一些人可能认为使用 `StreamProvider` 没什么用。 -特别是，你可能认为Flutter的 [StreamBuilder] 可以很好地用于监听流，但这是错误的。 +## Usage example: live chat using sockets -在 [StreamBuilder] 上使用 `StreamProvider` 有很多好处： +`StreamProvider` is used in when we handle stream of asynchronous data +such as Video Streaming, Weather broadcasting Apis or Live chat as follows: -- 它允许其他provider使用 [ref.watch] 监听流。 -- 多亏了 [AsyncValue] ，它能确保加载和错误情况得到正确处理。 -- 它消除了必须区分广播流和普通流的需要。 -- 它缓存由流发出的最新值，确保如果在事件发出后添加监听器， - 监听器仍然可以立即访问最新的事件。 -- 它允许在测试期间通过覆盖 `StreamProvider` 轻松地模拟流。 + + +Then, the UI can listen to live streaming chats like so: + +{trimSnippet(streamConsumer)} [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider [statenotifierprovider]: ./state_notifier_provider @@ -39,14 +60,4 @@ import streamConsumer from "!!raw-loader!/docs/providers/stream_provider/live_st [stream]: https://api.dart.dev/dart-async/Stream-class.html [stream.periodic]: https://api.dart.dev/stable/2.15.1/dart-async/Stream/Stream.periodic.html [family]: ../concepts/modifiers/family -[streambuilder]: https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html - -## 用法示例：使用套接字的实时聊天 - -`StreamProvider` 用于处理异步数据流，如视频流、天气广播Api。 - -{trimSnippet(streamProvider)} - -然后，UI就可以像这样聊天了： - -{trimSnippet(streamConsumer)} +[streambuilder]: https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart index 79c186f7a..383def216 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart @@ -6,21 +6,20 @@ import 'live_stream_chat_provider.dart'; /* SNIPPET START */ Widget build(BuildContext context, WidgetRef ref) { final liveChats = ref.watch(chatProvider); + // Like FutureProvider, it is possible to handle loading/error states using AsyncValue.when - return liveChats.when( - loading: () => const CircularProgressIndicator(), - error: (error, stackTrace) => Text(error.toString()), - data: (messages) { - // Display all the messages in a scrollable list view. - return ListView.builder( + return switch (liveChats) { + // Display all the messages in a scrollable list view. + AsyncData(:final value) => ListView.builder( // Show messages from bottom to top reverse: true, - itemCount: messages.length, + itemCount: value.length, itemBuilder: (context, index) { - final message = messages[index]; + final message = value[index]; return Text(message); }, - ); - }, - ); + ), + AsyncError(:final error) => Text(error.toString()), + _ => const CircularProgressIndicator(), + }; } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart new file mode 100644 index 000000000..e2e34878c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart @@ -0,0 +1,23 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +import 'dart:convert'; +import 'dart:io'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +Stream> chat(ChatRef ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart new file mode 100644 index 000000000..ed660f3fa --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -0,0 +1,26 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$chatHash() => r'db1302132f90e854fe2f5da9d97d89c9a3c8b858'; + +/// See also [chat]. +@ProviderFor(chat) +final chatProvider = AutoDisposeStreamProvider>.internal( + chat, + name: r'chatProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$chatHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef ChatRef = AutoDisposeStreamProviderRef>; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, inference_failure_on_uninitialized_variable, inference_failure_on_function_return_type, inference_failure_on_untyped_parameter, deprecated_member_use_from_same_package diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart new file mode 100644 index 000000000..beb2bcd05 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart @@ -0,0 +1,18 @@ +import 'dart:convert'; +import 'dart:io'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final chatProvider = StreamProvider>((ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx deleted file mode 100644 index 3277c77da..000000000 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx +++ /dev/null @@ -1,367 +0,0 @@ ---- -title: 给Provider开发者的Riverpod指南 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import pubspec from "./getting_started/pubspec"; -import dartHelloWorld from "./getting_started/dart_hello_world"; -import helloWorld from "./getting_started/hello_world"; -import dartPubspec from "./getting_started/dart_pubspec"; -import { - trimSnippet, - AutoSnippet, - When, -} from "../../../../src/components/CodeSnippet"; - -本文是为熟悉 [Provider] 并希望了解Riverpod的开发者所设计的。 - -## Riverpod 和 [Provider] 之间的关系 - -Riverpod可以说是Provider的“精神”继承者。而且“Riverpod”这个名字就是“Provider”的变位词。 - -Riverpod是在寻找解决Provider所面临的技术限制的方案中诞生的。 -一开始Riverpod被认为是解决这一问题的Provider的下一个大版本。 -但最后并没有这么做，因为这样会是一个相当大的突破性变更， -而Provider是现如今最常用的Flutter package 之一。 - -当然了，Riverpod和Provider从概念上来说还是差不多的。 -两个package都扮演着类似的角色。两者都试图： - -- 缓存和小会一些有状态的对象 -- 在测试时提供一个模拟这些对象的方法 -- 在flutter widget中提供了一个简单的方式来监听这些对象的变化 - -与此同时，如果Riverpod继续成熟下去，它也可能会成为Provider。 - -Riverpod修复了Provider的许多基本问题，例如但不限于： - -- 显著简化了与“provider”的组合。 - Riverpod提供了简单强大的工具比如 [ref.watch] 和 [ref.listen] ， - 而不是冗长且容易出错的 `ProxyProvider`。 -- 允许多个“Provider”公开相同类型的值。 - 当你暴露一个int类型或String类型的provider时不需要自定义一个类也能完美地使用。 -- 不需要在测试中重新定义provider。 - 在Riverpod中默认情况下provider可以直接使用。 -- 通过提供一种替代的方法来销毁对象([autoDispose])，减少对“作用域”的过度依赖。 - 虽然很强大，但确定一个provider的作用域相当复杂而且很难做对。 - -还有更多…… - -Riverpod唯一的缺点就是他需要变更Widget继承的类型才能使用： - -- 在Riverpod中你应该扩展 `ConsumerWidget` 类，而不是 `StatelessWidget` 类。 -- 在Riverpod中你应该扩展 `ConsumerStatefulWidget` 类，而不是 `StatefulWidget` 类。 - -但从大局上来看这种不便利的影响还是比较小的。而且这个限制在未来可能被移除。 - -所以要回答这个问题，你可能会问自己： -**我要使用Provider 还是 Riverpod ？** - -你大概率会选择 Riverpod。 -Riverpod设计得更好还能急剧简化你的逻辑。 - -## Provider和Riverpod的差异 - -### 定义 providers - -两个package最主要的区别在于如何定于“provider”。 - -对 [Provider] 来说，provider是widget，因此被放在widget树中，一般位于 `MultiProvider` 中： - -```dart -class Counter extends ChangeNotifier { - ... -} - -void main() { - runApp( - MultiProvider( - providers: [ - ChangeNotifierProvider(create: (context) => Counter()), - ], - child: MyApp(), - ) - ); -} -``` - -对于Riverpod来说， provider **不是** widget 而是普通的Dart对象。 -类似地，provider定义在widget树之外，并声明为全局final变量。 - -另外，为了让Riverpod工作，应当在整个应用上方添加一个 `ProviderScope` widget。 -下面是Riverpod的provider示例： - -```dart -// Providers 现在是顶级变量 -final counterProvider = ChangeNotifierProvider((ref) => Counter()); - -void main() { - runApp( - // 这个 widget 可以让Riverpod在整个Flutter 项目中使用。 - ProviderScope( - child: MyApp(), - ), - ); -} -``` - -provider的定义只是向上移动了几行。 - -:::info -由于Riverpod的provider是普通的Dart对象，因此可以同时在Dart和Flutter使用Riverpod。 -例如Riverpod也可以编写命令行应用。 -::: - -### 读取provider: BuildContext - -当使用Provider时，读取provider的一种方法是使用widget的 `BuildContext`. - -例如，如果provider被定义为： - -```dart -Provider(...); -``` - -然后使用 [Provider] 读取它： - -```dart -class Example extends StatelessWidget { - @override - Widget build(BuildContext context) { - Model model = context.watch(); - - } -} -``` - -Riverpod 的情况也一样： - -```dart -final modelProvider = Provider(...); - -class Example extends ConsumerWidget { - @override - Widget build(BuildContext context, WidgetRef ref) { - Model model = ref.watch(modelProvider); - - } -} -``` - -注意: - -- Riverpod的代码段展示了其扩展自 `ConsumerWidget` 类而不是 `StatelessWidget` 类。 - 它在build函数中添加了一个额外的参数： `WidgetRef`。 - -- 不同于 `BuildContext.watch` ，我们在Riverpod中使用来自`ConsumerWidget` 的 `WidgetRef` 来调用 `WidgetRef.watch`。 - -- Riverpod不依赖泛型类型。相反，它依赖于使用的provider定义创建的变量。 - -它们的使用关键词很相似。Provider和Riverpod都适用关键字“watch”来描述“当值发生变化时，这个widget应该重新构建”。 - -:::info -Riverpod使用和Provider相同的术语来读取provider。 - -- `BuildContext.watch` -> `WidgetRef.watch` -- `BuildContext.read` -> `WidgetRef.read` - -`context.watch` 和 `context.read` 的规则也适用于Riverpod： -在 `build` 方法中使用 “watch”。在点击或其他事件中使用 “read”。 -::: - -### 读取 provider: Consumer - -Provider附带了一个名为 `Consumer` (以及 `Consumer2` 之类的变体) 的widget用来读取provider。 - -`Consumer` 对性能优化很有帮助，它允许更细粒度的widget树重新构建，在状态变更时只更新相关的widget： - -因此，如果provider被定义为： - -```dart -Provider(...); -``` - -Provider允许你通过 `Consumer` 读取provider： - -```dart -Consumer( - builder: (BuildContext context, Model model, Widget? child) { - - } -) -``` - -Riverpod也有这样的原则。Riverpod也有一个名为 `Consumer` 的相同目的的widget。 - -如果我们定义provider为： - -```dart -final modelProvider = Provider(...); -``` - -然后使用 `Consumer` 我们可以这样： - -```dart -Consumer( - builder: (BuildContext context, WidgetRef ref, Widget? child) { - Model model = ref.watch(modelProvider); - - } -) -``` - -请注意这个 `Consumer` 是如何提供给我们 `WidgetRef` 对象的。 -这和我们在前面与 `ConsumerWidget` 相关的内容中看到的对象相同。 - -### 组合 provider: 带有无状态对象的 ProxyProvider - -当使用Provider，当组合不同的provider时官方的方法是使用 `ProxyProvider` widget (或者使用比如 `ProxyProvider2` 的变体)。 - -比如说，我们定义了: - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -ChangeNotifierProvider(create: (context) => UserIdNotifier()), -``` - -接下来我们有两个选择： -我们可能结合 `UserIdNotifier` 来创建一个新的 “无状态(stateless)” 的provider(通常是一个重载了==方法的不可变的值)， 比如： - -```dart -ProxyProvider( - update: (context, userIdNotifier, _) { - return 'The user ID of the the user is ${userIdNotifier.userId}'; - } -) -``` - -每当 `UserIdNotifier.userId` 出现变化时provider会自动返回一个新的 `String` 的值。 - -我们可以在Riverpod中做类似的事，但是语法不同。 -首先，在Riverpod中 `UserIdNotifier` 的定义是： - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -final userIdNotifierProvider = ChangeNotifierProvider( - (ref) => UserIdNotifier(), -), -``` - -然后我们就可以根据 `userId` 生成我们的 `String` ： - -```dart -final labelProvider = Provider((ref) { - UserIdNotifier userIdNotifier = ref.watch(userIdNotifierProvider); - return 'The user ID of the the user is ${userIdNotifier.userId}'; -}); -``` - -注意 `ref.watch(userIdNotifierProvider)` 这一行。 - - -这行代码告诉Riverpod获取 `userIdNotifierProvider` 的内容， -并当值发生变化时， `labelProvider` 也将被重新计算。 -因此，当 `userId` 发生变化时，我们的 `labelProvider` 将自动更新 `String`。 - -`ref.watch` 这一行你应该感觉类似。 -这种模式在前面的[如何在widget中读取provider](#读取provider-buildcontext)已经解释过了。 -实际上，provider现在可以像widget一样监听其他provider。 - -### 组合provider: 带有有状态对象的ProxyProvider - -在组合provider时，另一个可选的替代的用法是暴露一个有状态的对象，比如 `ChangeNotifier` 实例。 - -为此我们可以使用 `ChangeNotifierProxyProvider`(如 `ChangeNotifierProxyProvider2` 等变体)。 -比如我们可能定义： - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -ChangeNotifierProvider(create: (context) => UserIdNotifier()), -``` - -然后，我们可以定义一个基于`UserIdNotifier.userId`的新 `ChangeNotifier`。举个例子： - -```dart -class UserNotifier extends ChangeNotifier { - String? _userId; - - void setUserId(String? userId) { - if (userId != _userId) { - print('The user ID changed from $_userId to $userId'); - _userId = userId; - } - } -} - -// ... - -ChangeNotifierProxyProvider( - create: (context) => UserNotifier(), - update: (context, userIdNotifier, userNotifier) { - return userNotifier! - ..setUserId(userIdNotifier.userId); - }, -); -``` - -这个新的provider创建一个 `UserNotifier` 实例(并且永远不会重新构造)，并在用户ID更改时打印一个字符串。 -在Riverpod中，这个功能的实现方式不同于provider。首先，我们的 `UserIdNotifier` 定义为： - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -final userIdNotifierProvider = ChangeNotifierProvider( - (ref) => UserIdNotifier(), -), -``` - -接着，与前面的 `ChangeNotifierProxyProvider` 等价的是： - -```dart -class UserNotifier extends ChangeNotifier {} - -final userNotfierProvider = ChangeNotifierProvider((ref) { - final userNotifier = UserNotifier(); - ref.listen( - userIdNotifierProvider, - (previous, next) { - if (previous?.userId != next.userId) { - print('The user ID changed from ${previous?.userId} to ${next.userId}'); - } - }, - ); - - return userNotifier; -}); -``` - -这段代码的核心是 `ref.listen` 这一行。 -`ref.listen` 方法是一个允许你监听其他provider和当provider变更时执行函数的工具。 - -该函数的 `previous` 和 `next` 参数对应provider 更改前的最后一个值和更改后的新值。 - -[provider]: https://pub.dev/packages/provider -[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider -[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change -[autodispose]: /docs/concepts/modifiers/auto_dispose diff --git a/website/i18n/zh-Hans/docusaurus-theme-classic/footer.json b/website/i18n/zh-Hans/docusaurus-theme-classic/footer.json index 6560363ca..795de1dab 100644 --- a/website/i18n/zh-Hans/docusaurus-theme-classic/footer.json +++ b/website/i18n/zh-Hans/docusaurus-theme-classic/footer.json @@ -11,9 +11,21 @@ "message": "赞助", "description": "The title of the footer links column with title=Sponsors in the footer" }, + "link.item.label.Why Riverpod?": { + "message": "为什么选择 Riverpod？", + "description": "The label of footer link with label=Why Riverpod? linking to docs/introduction/why_riverpod" + }, "link.item.label.Getting started": { "message": "开始上手", - "description": "The label of footer link with label=Getting started linking to docs/getting_started" + "description": "The label of footer link with label=Getting started linking to docs/introduction/getting_started" + }, + "link.item.label.Discord": { + "message": "Discord", + "description": "The label of footer link with label=Discord linking to https://discord.gg/Bbumvej" + }, + "link.item.label.GitHub": { + "message": "GitHub", + "description": "The label of footer link with label=GitHub linking to https://github.com/rrousselgit/riverpod" }, "link.item.label.Stack Overflow": { "message": "Stack Overflow", @@ -23,16 +35,20 @@ "message": "Twitter", "description": "The label of footer link with label=Twitter linking to https://twitter.com/remi_rousselet" }, - "link.item.label.GitHub": { - "message": "GitHub", - "description": "The label of footer link with label=GitHub linking to https://github.com/rrousselgit/riverpod" - }, "link.item.label.Code of conduct": { "message": "行为准则", "description": "The label of footer link with label=Code of conduct linking to https://github.com/rrousselGit/riverpod/blob/master/CODE_OF_CONDUCT.md" }, + "link.item.label.Contributing guide": { + "message": "贡献指南", + "description": "The label of footer link with label=Contributing guide linking to https://github.com/rrousselGit/riverpod/blob/rework-flow/CONTRIBUTING.md" + }, "copyright": { - "message": "Copyright © 2023 Remi Rousselet.
使用Docusaurus构建。", + "message": "Copyright © 2023 Remi Rousselet.
使用 Docusaurus 构建。", "description": "The footer copyright" + }, + "logo.alt": { + "message": "Riverpod", + "description": "The alt text of footer logo" } -} \ No newline at end of file +} diff --git a/website/i18n/zh-Hans/docusaurus-theme-classic/navbar.json b/website/i18n/zh-Hans/docusaurus-theme-classic/navbar.json index 128196bc1..ade90e773 100644 --- a/website/i18n/zh-Hans/docusaurus-theme-classic/navbar.json +++ b/website/i18n/zh-Hans/docusaurus-theme-classic/navbar.json @@ -3,6 +3,10 @@ "message": "Riverpod", "description": "The title in the navbar" }, + "logo.alt": { + "message": "Riverpod", + "description": "The alt text of navbar logo" + }, "item.label.Docs": { "message": "文档", "description": "Navbar item with label Docs" diff --git a/website/src/documents_meta.js b/website/src/documents_meta.js index e3899daf9..272478fb4 100644 --- a/website/src/documents_meta.js +++ b/website/src/documents_meta.js @@ -32,9 +32,9 @@ export const documentTitles = { "concepts/why_immutability": "Why Immutability", "concepts/scopes": "Scopes", "concepts/reading": "Reading a Provider", - "concepts/providers": "Providers", "concepts/provider_observer": "ProviderObserver", "concepts/provider_lifecycles": "Provider Lifecycles", + "concepts/providers": "Providers", "concepts/combining_providers": "Combining Provider States", "concepts/about_hooks": "About hooks", "concepts/about_code_generation": "About code generation", @@ -45,11 +45,6 @@ export const documentTitles = { "advanced/select": "Optimizing performance", }, 'zh-Hans': { - "riverpod_for_provider_users": "给Provider开发者的Riverpod指南", - "introduction": "介绍", - "getting_started": "开始上手", - "about_hooks": "关于钩子", - "about_code_generation": "关于代码生成", "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", @@ -57,181 +52,207 @@ export const documentTitles = { "providers/notifier_provider": "(Async)NotifierProvider", "providers/future_provider": "FutureProvider", "providers/change_notifier_provider": "ChangeNotifierProvider", - "cookbooks/testing": "测试", - "concepts/why_immutability": "为何需要不可变性", - "concepts/scopes": "作用域", - "concepts/reading": "读取 Provider", - "concepts/providers": "Providers", + "migration/from_state_notifier": "从 `StateNotifier` 迁移", + "migration/from_change_notifier": "从 `ChangeNotifier` 迁移", + "migration/0.14.0_to_1.0.0": "^0.14.0 to ^1.0.0", + "migration/0.13.0_to_0.14.0": "^0.13.0 to ^0.14.0", + "introduction/why_riverpod": "为什么选择 Riverpod？", + "introduction/getting_started": "入门指南", + "from_provider/quickstart": "快速开始", + "from_provider/provider_vs_riverpod": "Provider 对比 Riverpod", + "from_provider/motivation/motivation": "动机", + "essentials/websockets_sync": "Websocket 和同步执行", + "essentials/testing": "测试你的提供者程序", + "essentials/side_effects": "执行副作用", + "essentials/provider_observer": "日志和错误报告", + "essentials/passing_args": "将参数传递给您的请求", + "essentials/first_request": "开始你的第一次 provider/network 请求", + "essentials/faq": "FAQ 常见问题", + "essentials/eager_initialization": "急切的初始化提供者程序", + "essentials/do_dont": "最佳实践", + "essentials/combining_requests": "组合请求", + "essentials/auto_dispose": "清除缓存并对状态处置做出反应", + "cookbooks/testing": "Testing", + "cookbooks/search_as_we_type": "Search as we type", + "concepts/why_immutability": "Why Immutability", + "concepts/scopes": "Scopes", + "concepts/reading": "Reading a Provider", "concepts/provider_observer": "ProviderObserver", - "concepts/provider_lifecycles": "Provider生命周期", - "concepts/combining_providers": "组合 Provider 状态", + "concepts/provider_lifecycles": "Provider Lifecycles", + "concepts/providers": "Providers", + "concepts/combining_providers": "Combining Provider States", + "concepts/about_hooks": "关于 Hooks（钩子）", + "concepts/about_code_generation": "关于代码生成", "concepts/modifiers/family": ".family", "concepts/modifiers/auto_dispose": ".autoDispose", + "case_studies/pull_to_refresh": "下拉刷新", + "case_studies/cancel": "网络请求的去抖动或取消", + "advanced/select": "性能优化", }, - 'ko': { - "riverpod_for_provider_users": "Provider사용자를 위한 Riverpod 가이드", - "introduction": "소개", - "getting_started": "시작하기", - "about_hooks": "hooks 알아보기", - "about_code_generation": "Code Generation 알아보기", + 'ru': { "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", "providers/future_provider": "FutureProvider", "providers/change_notifier_provider": "ChangeNotifierProvider", - "cookbooks/testing": "테스트", - "concepts/why_immutability": "불변성(Immutability)의 중요성", - "concepts/reading": "프로바이더 읽기", - "concepts/providers": "프로바이더란?", + "migration/0.14.0_to_1.0.0": "С ^0.14.0 на ^1.0.0", + "migration/0.13.0_to_0.14.0": "С ^0.13.0 на ^0.14.0", + "cookbooks/testing": "Тестирование", + "cookbooks/search_as_we_type": "Поиск во мере ввода", + "concepts/reading": "Чтение провайдера", "concepts/provider_observer": "ProviderObserver", - "concepts/combining_providers": "프로바이더 결합하기", + "concepts/providers": "Провайдеры", + "concepts/combining_providers": "Объединение состояний провайдеров", "concepts/modifiers/family": ".family", "concepts/modifiers/auto_dispose": ".autoDispose", - "migration/0.14.0_to_1.0.0": "^0.14.0 to ^1.0.0", - "migration/0.13.0_to_0.14.0": "^0.13.0 to ^0.14.0", - "cookbooks/search_as_we_type": "Search as we type", + "getting_started": "Введение", "cookbooks/refresh": "Pull-to-refresh / Retry-on-error", }, - 'fr': { - "riverpod_for_provider_users": "Riverpod pour les utilisateurs de Provider", - "introduction": "Introduction", - "getting_started": "Débuter", - "about_hooks": "À propos des hooks", - "about_code_generation": "À propos de la génération de code", + 'ko': { "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", - "providers/notifier_provider": "(Async)NotifierProvider", "providers/future_provider": "FutureProvider", "providers/change_notifier_provider": "ChangeNotifierProvider", - "cookbooks/testing": "Tests", - "concepts/why_immutability": "Pourquoi l'Immuabilité", - "concepts/scopes": "Scopes", - "concepts/reading": "Lire un Provider", - "concepts/providers": "Providers", + "migration/0.14.0_to_1.0.0": "^0.14.0 to ^1.0.0", + "migration/0.13.0_to_0.14.0": "^0.13.0 to ^0.14.0", + "cookbooks/testing": "테스트", + "cookbooks/search_as_we_type": "Search as we type", + "concepts/why_immutability": "불변성(Immutability)의 중요성", + "concepts/reading": "프로바이더 읽기", "concepts/provider_observer": "ProviderObserver", - "concepts/provider_lifecycles": "Cycles de vie des Provider", - "concepts/combining_providers": "Combiner des providers", + "concepts/providers": "프로바이더란?", + "concepts/combining_providers": "프로바이더 결합하기", "concepts/modifiers/family": ".family", "concepts/modifiers/auto_dispose": ".autoDispose", - "migration/0.14.0_to_1.0.0": "^0.14.0 vers ^1.0.0", - "migration/0.13.0_to_0.14.0": "^0.13.0 vers ^0.14.0", + "getting_started": "시작하기", + "cookbooks/refresh": "Pull-to-refresh / Retry-on-error", + "riverpod_for_provider_users": "Provider사용자를 위한 Riverpod 가이드", + "introduction": "소개", + "about_hooks": "hooks 알아보기", + "about_code_generation": "Code Generation 알아보기", }, 'ja': { - "introduction": "イントロダクション", - "getting_started": "はじめに", - "about_code_generation": "コードジェネレーション", "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", "providers/future_provider": "FutureProvider", "providers/change_notifier_provider": "ChangeNotifierProvider", + "migration/0.14.0_to_1.0.0": "^0.14.0 → ^1.0.0", + "migration/0.13.0_to_0.14.0": "^0.13.0 → ^0.14.0", "cookbooks/testing": "テスト", "concepts/reading": "プロバイダの利用方法", - "concepts/providers": "プロバイダとは", "concepts/provider_observer": "ProviderObserver", + "concepts/providers": "プロバイダとは", "concepts/combining_providers": "プロバイダのステートを組み合わせる", "concepts/modifiers/family": ".family", "concepts/modifiers/auto_dispose": ".autoDispose", - "migration/0.14.0_to_1.0.0": "^0.14.0 → ^1.0.0", - "migration/0.13.0_to_0.14.0": "^0.13.0 → ^0.14.0", + "getting_started": "はじめに", + "introduction": "イントロダクション", + "about_code_generation": "コードジェネレーション", }, - 'ru': { - "getting_started": "Введение", + 'it': { "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", "providers/future_provider": "FutureProvider", - "providers/change_notifier_provider": "ChangeNotifierProvider", - "cookbooks/testing": "Тестирование", - "concepts/reading": "Чтение провайдера", - "concepts/providers": "Провайдеры", + "migration/0.14.0_to_1.0.0": "da ^0.14.0 a ^1.0.0", + "migration/0.13.0_to_0.14.0": "da ^0.13.0 a ^0.14.0", + "cookbooks/testing": "Testing", + "cookbooks/search_as_we_type": "Search as we type", + "concepts/reading": "Leggere un provider", "concepts/provider_observer": "ProviderObserver", - "concepts/combining_providers": "Объединение состояний провайдеров", + "concepts/providers": "I Provider", + "concepts/combining_providers": "Combinare stati di provider", "concepts/modifiers/family": ".family", "concepts/modifiers/auto_dispose": ".autoDispose", - "migration/0.14.0_to_1.0.0": "С ^0.14.0 на ^1.0.0", - "migration/0.13.0_to_0.14.0": "С ^0.13.0 на ^0.14.0", - "cookbooks/search_as_we_type": "Поиск во мере ввода", - "cookbooks/refresh": "Pull-to-refresh / Retry-on-error", - }, - 'it': { "getting_started": "Introduzione", + }, + 'fr': { "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", + "providers/notifier_provider": "(Async)NotifierProvider", "providers/future_provider": "FutureProvider", - "cookbooks/testing": "Testing", - "concepts/reading": "Leggere un provider", - "concepts/providers": "I Provider", + "providers/change_notifier_provider": "ChangeNotifierProvider", + "migration/0.14.0_to_1.0.0": "^0.14.0 vers ^1.0.0", + "migration/0.13.0_to_0.14.0": "^0.13.0 vers ^0.14.0", + "cookbooks/testing": "Tests", + "concepts/why_immutability": "Pourquoi l'Immuabilité", + "concepts/scopes": "Scopes", + "concepts/reading": "Lire un Provider", "concepts/provider_observer": "ProviderObserver", - "concepts/combining_providers": "Combinare stati di provider", + "concepts/provider_lifecycles": "Cycles de vie des Provider", + "concepts/providers": "Providers", + "concepts/combining_providers": "Combiner des providers", "concepts/modifiers/family": ".family", "concepts/modifiers/auto_dispose": ".autoDispose", - "migration/0.14.0_to_1.0.0": "da ^0.14.0 a ^1.0.0", - "migration/0.13.0_to_0.14.0": "da ^0.13.0 a ^0.14.0", - "cookbooks/search_as_we_type": "Search as we type", + "getting_started": "Débuter", + "riverpod_for_provider_users": "Riverpod pour les utilisateurs de Provider", + "introduction": "Introduction", + "about_hooks": "À propos des hooks", + "about_code_generation": "À propos de la génération de code", }, 'es': { - "getting_started": "Empezando", "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", "providers/future_provider": "FutureProvider", + "migration/0.14.0_to_1.0.0": "^0.14.0 a ^1.0.0", + "migration/0.13.0_to_0.14.0": "^0.13.0 a ^0.14.0", "cookbooks/testing": "Testing", "concepts/reading": "Leyendo un Provider", - "concepts/providers": "Providers", "concepts/provider_observer": "ProviderObserver", + "concepts/providers": "Providers", "concepts/combining_providers": "Combinando providers", "concepts/modifiers/family": ".family", "concepts/modifiers/auto_dispose": ".autoDispose", - "migration/0.14.0_to_1.0.0": "^0.14.0 a ^1.0.0", - "migration/0.13.0_to_0.14.0": "^0.13.0 a ^0.14.0", + "getting_started": "Empezando", }, - 'de': { - "getting_started": "Getting started", + 'bn': { + "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", "providers/future_provider": "FutureProvider", - "cookbooks/testing": "Testing", - "concepts/reading": "Reading a provider", - "concepts/providers": "Providers", - "concepts/provider_observer": "ProviderObserver", - "concepts/combining_providers": "Combining providers", - "concepts/modifiers/family": ".family", - "concepts/modifiers/auto_dispose": ".autoDispose", "migration/0.14.0_to_1.0.0": "^0.14.0 to ^1.0.0", "migration/0.13.0_to_0.14.0": "^0.13.0 to ^0.14.0", + "cookbooks/testing": "টেস্টিং", "cookbooks/search_as_we_type": "Search as we type", + "concepts/reading": "প্রভাইডার রিড করা", + "concepts/provider_observer": "প্রভাইডার অবসার্বার", + "concepts/providers": "প্রভাইডাররা", + "concepts/combining_providers": "প্রভাইডার যুক্ত করা", + "concepts/modifiers/family": ".family", + "concepts/modifiers/auto_dispose": ".autoDispose", + "getting_started": "Getting started", "cookbooks/refresh": "Pull-to-refresh / Retry-on-error", }, - 'bn': { - "getting_started": "Getting started", - "providers/stream_provider": "StreamProvider", + 'de': { "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", "providers/future_provider": "FutureProvider", - "cookbooks/testing": "টেস্টিং", - "concepts/reading": "প্রভাইডার রিড করা", - "concepts/providers": "প্রভাইডাররা", - "concepts/provider_observer": "প্রভাইডার অবসার্বার", - "concepts/combining_providers": "প্রভাইডার যুক্ত করা", - "concepts/modifiers/family": ".family", - "concepts/modifiers/auto_dispose": ".autoDispose", "migration/0.14.0_to_1.0.0": "^0.14.0 to ^1.0.0", "migration/0.13.0_to_0.14.0": "^0.13.0 to ^0.14.0", + "cookbooks/testing": "Testing", "cookbooks/search_as_we_type": "Search as we type", + "concepts/reading": "Reading a provider", + "concepts/provider_observer": "ProviderObserver", + "concepts/providers": "Providers", + "concepts/combining_providers": "Combining providers", + "concepts/modifiers/family": ".family", + "concepts/modifiers/auto_dispose": ".autoDispose", + "getting_started": "Getting started", "cookbooks/refresh": "Pull-to-refresh / Retry-on-error", }, }; export const outdatedTranslations = [ -{"countryCode":"ru","id":"providers/future_provider","englishPath":"/docs/providers/future_provider"}, +{"countryCode":"ru","id":"providers/future_provider","englishPath":"/docs\\providers/future_provider"}, ]; diff --git a/website/static/snippets/combine.dart b/website/static/snippets/combine.dart index 051941774..48797b3ad 100644 --- a/website/static/snippets/combine.dart +++ b/website/static/snippets/combine.dart @@ -22,7 +22,7 @@ final filterProvider = StateProvider((ref) => Filter.all); @riverpod List filteredTodos(FilteredTodosRef ref) { - // Providers can consumer other providers using the "ref" object. + // Providers can consume other providers using the "ref" object. // With ref.watch, providers will automatically update if the watched values changes. final List todos = ref.watch(todosProvider); final Filter filter = ref.watch(filterProvider); diff --git a/website/yarn.lock b/website/yarn.lock index 88e64c06c..6d1d69816 100644 --- a/website/yarn.lock +++ b/website/yarn.lock @@ -4022,9 +4022,9 @@ flux@^4.0.1: fbjs "^3.0.1" follow-redirects@^1.0.0, follow-redirects@^1.14.7: - version "1.15.3" - resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.3.tgz#fe2f3ef2690afce7e82ed0b44db08165b207123a" - integrity sha512-1VzOtuEM8pC9SFU1E+8KfTjZyMztRsgEfwQl44z8A25uy13jSzTj6dyK2Df52iV0vgHCfBwLhDWevLn95w5v6Q== + version "1.15.4" + resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.4.tgz#cdc7d308bf6493126b17ea2191ea0ccf3e535adf" + integrity sha512-Cr4D/5wlrb0z9dgERpUL3LrmPKVDsETIJhaCMeDfuFYcqa5bldGV6wBsAN6X/vxlXQtFBMrXdXxdL8CbDTGniw== foreground-child@^3.1.0: version "3.1.1" From ac39b7e861c7f8c4e4b7da29551195567a39e00e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 17:55:51 +0100 Subject: [PATCH 208/387] Sync rewrite with dev (#3333) --- .github/PULL_REQUEST_TEMPLATE.md | 34 + CONTRIBUTING.md | 4 +- examples/counter/README.md | 2 +- examples/marvel/lib/src/screens/home.dart | 7 +- examples/marvel/pubspec.yaml | 2 +- packages/flutter_riverpod/CHANGELOG.md | 5 + .../lib/src/core/consumer.dart | 3 - .../lib/src/core/provider_scope.dart | 2 +- packages/flutter_riverpod/pubspec.yaml | 4 +- packages/hooks_riverpod/CHANGELOG.md | 5 + packages/hooks_riverpod/pubspec.yaml | 4 +- packages/riverpod/CHANGELOG.md | 625 +++++++++------- .../riverpod/lib/src/core/async_value.dart | 25 +- .../riverpod/lib/src/core/foundation.dart | 5 + packages/riverpod/pubspec.yaml | 4 +- .../test/new/core/async_value_test.dart | 38 + .../test/new/core/select_async_test.dart | 1 - packages/riverpod_analyzer_utils/CHANGELOG.md | 6 +- .../generator_provider_declaration_test.dart | 2 +- packages/riverpod_annotation/CHANGELOG.md | 4 + .../lib/src/riverpod_annotation.dart | 71 +- packages/riverpod_generator/CHANGELOG.md | 11 + .../lib/src/validation.dart | 31 + .../riverpod_generator/test/error_test.dart | 147 ++++ packages/riverpod_lint/CHANGELOG.md | 11 + .../convert_to_stateful_base_widget.dart | 124 ++++ .../convert_to_stateless_base_widget.dart | 270 +++++-- .../src/assists/convert_to_widget_utils.dart | 30 + .../lints/async_value_nullable_pattern.dart | 10 +- .../riverpod_lint_flutter_test/pubspec.yaml | 1 + .../pubspec_overrides.yaml | 6 +- ...rt_class_based_provider_to_functional.diff | 78 ++ ...rt_class_based_provider_to_functional.json | 1 - ...ass_based_provider_to_functional_test.dart | 16 +- ...rt_functional_provider_to_class_based.diff | 33 + ...rt_functional_provider_to_class_based.json | 1 - ...nctional_provider_to_class_based_test.dart | 16 +- .../convert_to_consumer_stateful_widget.diff | 308 ++++++++ .../convert_to_consumer_stateful_widget.json | 1 - .../convert_to_consumer_widget.diff | 330 +++++++++ .../convert_to_consumer_widget.json | 1 - .../convert_to_hook_consumer_widget.diff | 318 +++++++++ .../convert_to_hook_consumer_widget.json | 1 - .../convert_to_hook_widget.diff | 314 ++++++++ .../convert_to_hook_widget.json | 1 - ...vert_to_stateful_hook_consumer_widget.diff | 320 +++++++++ ...vert_to_stateful_hook_consumer_widget.json | 1 - .../convert_to_stateful_hook_widget.diff | 346 +++++++++ .../convert_to_stateful_hook_widget.json | 1 - .../convert_to_stateful_widget.diff | 245 +++++++ .../convert_to_stateful_widget.json | 1 - .../convert_to_stateless_widget.diff | 240 +++++++ .../convert_to_stateless_widget.json | 1 - .../convert_to_widget/convert_to_widget.dart | 85 +++ .../convert_to_widget_test.dart | 76 +- .../test/assists/empty.diff | 0 .../test/assists/empty.json | 1 - .../assists/wrap_widget/wrap_widget_test.dart | 22 +- .../wrap_widget/wrap_with_consumer.diff | 28 + .../wrap_widget/wrap_with_consumer.json | 1 - .../wrap_widget/wrap_with_provider_scope.diff | 28 + .../wrap_widget/wrap_with_provider_scope.json | 1 - .../test/golden.dart | 45 +- .../async_value_nullable_pattern.dart | 23 + .../fix/async_value_nullable_pattern.diff | 24 + .../fix/async_value_nullable_pattern.json | 1 - .../async_value_nullable_pattern_test.dart | 16 +- .../lints/functional_ref/functional_ref.diff | 46 ++ .../lints/functional_ref/functional_ref.json | 1 - .../functional_ref/functional_ref_test.dart | 14 +- .../notifier_build/fix/notifier_build.diff | 16 + .../notifier_build/fix/notifier_build.json | 1 - .../fix/notifier_build_test.dart | 15 +- .../notifier_extends/notifier_extends.diff | 60 ++ .../notifier_extends/notifier_extends.json | 1 - .../notifier_extends_test.dart | 15 +- .../provider_dependencies.diff | 137 ++++ .../provider_dependencies.json | 1 - .../provider_dependencies_test.dart | 15 +- website/docs/case_studies/cancel.mdx | 2 +- .../docs/essentials/combining_requests.mdx | 22 +- website/docs/essentials/faq.mdx | 2 +- website/docs/essentials/first_request.mdx | 2 +- website/docs/essentials/side_effects.mdx | 2 +- website/docs/essentials/testing.mdx | 2 +- website/docs/from_provider/quickstart.mdx | 5 +- .../current.json | 6 +- .../current/cookbooks/refresh.mdx | 10 + .../current/cookbooks/search_as_we_type.mdx | 133 ++++ .../current/cookbooks/testing_dart.dart | 51 ++ .../current/cookbooks/testing_flutter.dart | 39 + .../current/cookbooks/testing_full.dart | 98 +++ .../cookbooks/testing_original_test_dart.dart | 65 ++ .../testing_original_test_flutter.dart | 57 ++ .../cookbooks/testing_override_info.dart | 42 ++ .../current/cookbooks/testing_repository.dart | 22 + .../current.json | 20 + .../current/advanced/select.mdx | 65 ++ .../advanced/select/select/codegen.dart | 30 + .../advanced/select/select/codegen.g.dart | 72 ++ .../current/advanced/select/select/index.ts | 4 + .../current/advanced/select/select/raw.dart | 29 + .../advanced/select/select_async/codegen.dart | 26 + .../select/select_async/codegen.g.dart | 125 ++++ .../advanced/select/select_async/index.ts | 4 + .../advanced/select/select_async/raw.dart | 23 + .../current/case_studies/cancel.mdx | 139 ++++ .../cancel/detail_screen/codegen.dart | 61 ++ .../cancel/detail_screen/codegen.freezed.dart | 209 ++++++ .../cancel/detail_screen/codegen.g.dart | 86 +++ .../cancel/detail_screen/index.ts | 4 + .../cancel/detail_screen/raw.dart | 65 ++ .../cancel/detail_screen_cancel/codegen.dart | 28 + .../detail_screen_cancel/codegen.g.dart | 66 ++ .../cancel/detail_screen_cancel/index.ts | 4 + .../cancel/detail_screen_cancel/raw.dart | 25 + .../detail_screen_debounce/codegen.dart | 38 + .../detail_screen_debounce/codegen.g.dart | 66 ++ .../cancel/detail_screen_debounce/index.ts | 4 + .../cancel/detail_screen_debounce/raw.dart | 35 + .../case_studies/cancel/extension.dart | 32 + .../case_studies/cancel/home_screen.dart | 39 + .../provider_with_extension/codegen.dart | 26 + .../provider_with_extension/codegen.g.dart | 66 ++ .../cancel/provider_with_extension/index.ts | 4 + .../cancel/provider_with_extension/raw.dart | 23 + .../current/case_studies/pull_to_refresh.mdx | 127 ++++ .../pull_to_refresh/activity/codegen.dart | 19 + .../activity/codegen.freezed.dart | 209 ++++++ .../pull_to_refresh/activity/codegen.g.dart | 25 + .../pull_to_refresh/activity/index.ts | 4 + .../pull_to_refresh/activity/raw.dart | 24 + .../pull_to_refresh/display_activity.dart | 22 + .../pull_to_refresh/display_activity2.dart | 28 + .../pull_to_refresh/display_activity3.dart | 31 + .../pull_to_refresh/display_activity4.dart | 35 + .../fetch_activity/codegen.dart | 20 + .../fetch_activity/codegen.g.dart | 66 ++ .../pull_to_refresh/fetch_activity/index.ts | 4 + .../pull_to_refresh/fetch_activity/raw.dart | 17 + .../pull_to_refresh/full_app/codegen.dart | 69 ++ .../full_app/codegen.freezed.dart | 209 ++++++ .../pull_to_refresh/full_app/codegen.g.dart | 86 +++ .../pull_to_refresh/full_app/index.ts | 4 + .../pull_to_refresh/full_app/raw.dart | 73 ++ .../concepts/about_code_generation.mdx | 372 ++++++++++ .../current/concepts}/about_codegen/main.dart | 0 .../concepts}/about_codegen/main.g.dart | 0 .../provider_type/async_class_future.dart | 14 + .../provider_type/async_class_future.g.dart | 73 ++ .../provider_type/async_class_stream.dart | 14 + .../provider_type/async_class_stream.g.dart | 73 ++ .../provider_type/async_fn_future.dart | 9 + .../provider_type/async_fn_future.g.dart | 65 ++ .../provider_type/async_fn_stream.dart | 9 + .../provider_type/async_fn_stream.g.dart | 65 ++ .../provider_type/auto_dispose.dart | 12 + .../provider_type/auto_dispose.g.dart | 133 ++++ .../about_codegen/provider_type/family.dart | 7 + .../about_codegen/provider_type/family.g.dart | 145 ++++ .../provider_type/family_class.dart | 17 + .../provider_type/family_class.g.dart | 207 ++++++ .../provider_type/family_fn.dart | 13 + .../provider_type/family_fn.g.dart | 169 +++++ .../non_code_gen/async_notifier_provider.dart | 16 + .../non_code_gen/auto_dispose.dart | 12 + .../provider_type/non_code_gen/family.dart | 6 + .../non_code_gen/future_provider.dart | 7 + .../non_code_gen/notifier_provider.dart | 15 + .../provider_type/non_code_gen/provider.dart | 8 + .../stream_notifier_provider.dart | 16 + .../non_code_gen/stream_provider.dart | 7 + .../provider_type/sync_class.dart | 14 + .../provider_type/sync_class.g.dart | 81 +++ .../about_codegen/provider_type/sync_fn.dart | 9 + .../provider_type/sync_fn.g.dart | 73 ++ .../current/concepts}/about_codegen/raw.dart | 2 +- .../current/concepts/about_hooks.mdx | 317 +++++++++ .../about_hooks/hook_and_consumer.dart | 28 + .../concepts/about_hooks/hook_consumer.dart | 26 + .../about_hooks/hook_consumer_widget.dart | 23 + .../concepts/async_initialization.dart | 59 ++ .../characters_provider/codegen.dart | 31 + .../characters_provider/codegen.g.dart | 123 ++++ .../characters_provider/index.tsx | 9 + .../characters_provider/models.dart | 17 + .../characters_provider/raw.dart | 26 + .../city_provider/codegen.dart | 7 + .../city_provider/codegen.g.dart | 72 ++ .../city_provider/index.tsx | 9 + .../city_provider/raw.dart | 4 + .../filtered_todo_list_provider/codegen.dart | 33 + .../codegen.g.dart | 133 ++++ .../filtered_todo_list_provider/index.tsx | 9 + .../filtered_todo_list_provider/raw.dart | 27 + .../read_in_provider/codegen.dart | 17 + .../read_in_provider/codegen.g.dart | 132 ++++ .../read_in_provider/index.tsx | 9 + .../read_in_provider/raw.dart | 13 + .../select_async_provider/codegen.dart | 25 + .../select_async_provider/codegen.g.dart | 123 ++++ .../select_async_provider/index.tsx | 9 + .../select_async_provider/models.dart | 21 + .../select_async_provider/raw.dart | 21 + .../todo_list_provider/codegen.dart | 24 + .../todo_list_provider/codegen.freezed.dart | 166 +++++ .../todo_list_provider/codegen.g.dart | 81 +++ .../todo_list_provider/index.tsx | 9 + .../todo_list_provider/raw.dart | 36 + .../weather_provider/codegen.dart | 20 + .../weather_provider/codegen.g.dart | 124 ++++ .../weather_provider/index.tsx | 9 + .../weather_provider/raw.dart | 18 + .../whole_object_provider/codegen.dart | 24 + .../whole_object_provider/codegen.g.dart | 123 ++++ .../whole_object_provider/index.tsx | 9 + .../whole_object_provider/models.dart | 16 + .../whole_object_provider/raw.dart | 20 + .../current/concepts/combining_providers.mdx | 255 +++---- .../current/concepts/dialog_scope.dart | 59 ++ .../lifecycle_on_dispose/codegen.dart | 20 + .../lifecycle_on_dispose/codegen.g.dart | 65 ++ .../concepts/lifecycle_on_dispose/index.tsx | 9 + .../concepts/lifecycle_on_dispose/raw.dart} | 2 +- .../concepts/modifiers/auto_dispose.mdx | 101 +-- .../current/concepts/modifiers/family.mdx | 93 +-- .../current/concepts/provider_lifecycles.mdx | 107 +++ .../current/concepts/provider_observer.mdx | 37 +- .../concepts/provider_observer_logger.dart | 5 +- .../current/concepts/providers.mdx | 199 +++--- .../creating_a_provider/codegen.dart | 12 + .../creating_a_provider/codegen.g.dart | 72 ++ .../providers/creating_a_provider/index.tsx | 9 + .../providers/creating_a_provider/raw.dart | 9 + .../declaring_many_providers/codegen.dart | 10 + .../declaring_many_providers/codegen.g.dart | 132 ++++ .../declaring_many_providers/index.tsx | 9 + .../declaring_many_providers/raw.dart | 6 + .../current/concepts/reading.mdx | 472 +++++++------ .../consumer_hook.dart} | 7 +- .../consumer_stateful_widget/hooks.dart} | 11 +- .../consumer_stateful_widget/index.tsx | 9 + .../consumer_stateful_widget/raw.dart} | 7 +- .../consumer_widget/hooks.dart} | 7 +- .../reading/consumer_widget/index.tsx | 9 + .../consumer_widget/raw.dart} | 4 +- .../concepts/reading/counter/codegen.dart | 26 + .../concepts/reading/counter/codegen.g.dart | 141 ++++ .../concepts/reading/counter/index.tsx | 9 + .../counter/raw.dart} | 2 +- .../concepts/reading/listen/codegen.dart | 16 + .../concepts/reading/listen/codegen.g.dart | 72 ++ .../current/concepts/reading/listen/index.tsx | 9 + .../current/concepts/reading/listen/raw.dart} | 5 +- .../reading/listen_build/codegen.dart | 28 + .../reading/listen_build/codegen.g.dart | 81 +++ .../reading/listen_build/codegen_hooks.dart | 34 + .../reading/listen_build/codegen_hooks.g.dart | 81 +++ .../concepts/reading/listen_build/index.tsx | 11 + .../concepts/reading/listen_build/raw.dart} | 3 +- .../reading/listen_build/raw_hooks.dart | 29 + .../concepts/reading/provider/codegen.dart | 20 + .../concepts/reading/provider/codegen.g.dart | 132 ++++ .../concepts/reading/provider/index.tsx | 9 + .../concepts/reading/provider/raw.dart | 19 + .../concepts/reading/read/codegen.dart | 32 + .../concepts/reading/read/codegen.g.dart | 81 +++ .../concepts/reading/read/codegen_hooks.dart | 36 + .../reading/read/codegen_hooks.g.dart | 81 +++ .../current/concepts/reading/read/index.tsx | 11 + .../read/raw.dart} | 6 +- .../concepts/reading/read/raw_hooks.dart | 31 + .../concepts/reading/read_build/codegen.dart | 25 + .../reading/read_build/codegen.g.dart | 81 +++ .../concepts/reading/read_build/index.tsx | 9 + .../read_build/raw.dart} | 2 +- .../reading/read_notifier_build/codegen.dart | 24 + .../read_notifier_build/codegen.g.dart | 81 +++ .../reading/read_notifier_build/index.tsx | 9 + .../read_notifier_build/raw.dart} | 0 .../concepts/reading/watch/codegen.dart | 45 ++ .../concepts/reading/watch/codegen.g.dart | 201 ++++++ .../current/concepts/reading/watch/index.tsx | 9 + .../watch/raw.dart} | 6 +- .../concepts/reading/watch_build/codegen.dart | 39 + .../reading/watch_build/codegen.g.dart | 140 ++++ .../reading/watch_build/codegen_hooks.dart | 43 ++ .../reading/watch_build/codegen_hooks.g.dart | 140 ++++ .../concepts/reading/watch_build/index.tsx | 11 + .../watch_build/raw.dart} | 2 +- .../reading/watch_build/raw_hooks.dart | 38 + .../reading/watch_notifier_build/codegen.dart | 24 + .../watch_notifier_build/codegen.g.dart | 81 +++ .../reading/watch_notifier_build/index.tsx | 9 + .../watch_notifier_build/raw.dart} | 0 .../current/concepts/scopes.mdx | 180 +++++ .../current/concepts/subtree_scope.dart | 79 +++ .../current/concepts/theme_scope.dart | 69 ++ .../current/concepts/why_immutability.mdx | 92 +++ .../concepts/why_immutability/codegen.dart | 58 ++ .../why_immutability/codegen.freezed.dart | 151 ++++ .../concepts/why_immutability/codegen.g.dart | 82 +++ .../concepts/why_immutability/index.tsx | 9 + .../concepts/why_immutability/raw.dart | 67 ++ .../current/cookbooks/search_as_we_type.mdx | 69 +- .../current/cookbooks/testing.mdx | 130 ++-- .../current/cookbooks/testing_dart.dart | 60 +- .../current/cookbooks/testing_flutter.dart | 2 - .../current/cookbooks/testing_full.dart | 54 +- .../cookbooks/testing_original_test_dart.dart | 26 +- .../testing_original_test_flutter.dart | 16 +- .../cookbooks/testing_override_info.dart | 2 +- .../current/cookbooks/testing_repository.dart | 10 +- .../current/essentials/auto_dispose.mdx | 166 +++++ .../auto_dispose/cache_for_extension.dart | 18 + .../auto_dispose/cache_for_usage/codegen.dart | 17 + .../cache_for_usage/codegen.g.dart | 65 ++ .../auto_dispose/cache_for_usage/index.ts | 4 + .../auto_dispose/cache_for_usage/raw.dart | 15 + .../auto_dispose/codegen_keep_alive.dart | 11 + .../auto_dispose/codegen_keep_alive.g.dart | 72 ++ .../auto_dispose/invalidate_example.dart | 23 + .../invalidate_family_example/codegen.dart | 24 + .../invalidate_family_example/codegen.g.dart | 144 ++++ .../invalidate_family_example/index.ts | 4 + .../invalidate_family_example/raw.dart | 20 + .../auto_dispose/keep_alive/codegen.dart | 21 + .../auto_dispose/keep_alive/codegen.g.dart | 65 ++ .../auto_dispose/keep_alive/index.ts | 4 + .../auto_dispose/keep_alive/raw.dart | 19 + .../on_dispose_example/codegen.dart | 23 + .../on_dispose_example/codegen.g.dart | 124 ++++ .../auto_dispose/on_dispose_example/index.ts | 4 + .../auto_dispose/on_dispose_example/raw.dart | 17 + .../auto_dispose/raw_auto_dispose.dart | 7 + .../current/essentials/combining_requests.mdx | 140 ++++ .../functional_ref/codegen.dart | 18 + .../functional_ref/codegen.g.dart | 131 ++++ .../functional_ref/index.ts | 4 + .../functional_ref/raw.dart | 14 + .../listen_example/codegen.dart | 20 + .../listen_example/codegen.g.dart | 131 ++++ .../listen_example/index.ts | 4 + .../listen_example/raw.dart | 13 + .../notifier_ref/codegen.dart | 21 + .../notifier_ref/codegen.g.dart | 140 ++++ .../combining_requests/notifier_ref/index.ts | 4 + .../combining_requests/notifier_ref/raw.dart | 19 + .../read_example/codegen.dart | 26 + .../read_example/codegen.g.dart | 140 ++++ .../combining_requests/read_example/index.ts | 4 + .../combining_requests/read_example/raw.dart | 22 + .../watch_example/codegen.dart | 45 ++ .../watch_example/codegen.g.dart | 125 ++++ .../combining_requests/watch_example/index.ts | 4 + .../combining_requests/watch_example/raw.dart | 41 ++ .../watch_placement/codegen.dart | 40 ++ .../watch_placement/codegen.g.dart | 199 ++++++ .../watch_placement/index.ts | 4 + .../watch_placement/raw.dart | 35 + .../current/essentials/do_dont.mdx | 151 ++++ .../essentials/eager_initialization.mdx | 64 ++ .../async_consumer_example.dart | 27 + .../consumer_example.dart | 35 + .../require_value/codegen.dart | 24 + .../require_value/codegen.g.dart | 65 ++ .../require_value/index.ts | 4 + .../require_value/raw.dart | 20 + .../current/essentials/faq.mdx | 183 +++++ .../current/essentials/first_request.mdx | 333 +++++++++ .../essentials/first_request/activity.ts | 9 + .../first_request/codegen/activity.dart | 24 + .../codegen/activity.freezed.dart | 237 +++++++ .../first_request/codegen/activity.g.dart | 27 + .../first_request/codegen/provider.dart | 23 + .../first_request/codegen/provider.g.dart | 74 ++ .../essentials/first_request/consumer.ts | 8 + .../first_request/consumer_stateful_widget.ts | 8 + .../first_request/consumer_widget.ts | 8 + .../first_request/hook_consumer_widget.ts | 8 + .../first_request/legend/DocuCode.scss | 18 + .../first_request/legend/legend.tsx | 88 +++ .../essentials/first_request/provider.ts | 9 + .../first_request/raw/activity.dart | 30 + .../first_request/raw/consumer.dart | 42 ++ .../raw/consumer_stateful_widget.dart | 43 ++ .../first_request/raw/consumer_widget.dart | 25 + .../raw/hook_consumer_widget.dart | 28 + .../first_request/raw/provider.dart | 17 + .../current/essentials/passing_args.mdx | 155 ++++ .../passing_args/codegen/family.dart | 31 + .../passing_args/codegen/family.g.dart | 138 ++++ .../passing_args/codegen/provider.dart | 33 + .../passing_args/codegen/provider.g.dart | 220 ++++++ .../passing_args/no_arg_provider.ts | 9 + .../passing_args/raw/consumer_family.dart | 24 + .../raw/consumer_list_family.dart | 23 + .../passing_args/raw/consumer_provider.dart | 20 + .../raw/consumer_tuple_family.dart | 24 + .../essentials/passing_args/raw/family.dart | 42 ++ .../raw/multiple_consumer_family.dart | 37 + .../essentials/passing_args/raw/provider.dart | 28 + .../passing_args/raw/tuple_family.dart | 33 + .../current/essentials/provider_observer.mdx | 49 ++ .../provider_observer/provider_observer.dart | 43 ++ .../current/essentials/side_effects.mdx | 426 +++++++++++ .../codegen/todo_list_notifier.dart | 28 + .../codegen/todo_list_notifier.freezed.dart | 166 +++++ .../codegen/todo_list_notifier.g.dart | 89 +++ .../codegen/todo_list_notifier_add_todo.dart | 26 + .../todo_list_notifier_add_todo.g.dart | 74 ++ .../codegen/todo_list_provider.dart | 23 + .../codegen/todo_list_provider.freezed.dart | 148 ++++ .../codegen/todo_list_provider.g.dart | 66 ++ .../raw/consumer_add_todo_call.dart | 23 + .../raw/invalidate_self_add_todo.dart | 38 + .../side_effects/raw/manual_add_todo.dart | 41 ++ .../raw/mutable_manual_add_todo.dart | 35 + .../side_effects/raw/render_add_todo.dart | 78 ++ .../raw/render_add_todo_hooks.dart | 69 ++ .../side_effects/raw/rest_add_todo.dart | 39 + .../side_effects/raw/todo_list_notifier.dart | 44 ++ .../raw/todo_list_notifier_add_todo.dart | 28 + .../side_effects/raw/todo_list_provider.dart | 27 + .../side_effects/render_add_todo.ts | 9 + .../side_effects/todo_list_notifier.ts | 9 + .../todo_list_notifier_add_todo.ts | 9 + .../side_effects/todo_list_provider.ts | 7 + .../current/essentials/testing.mdx | 160 +++++ .../testing/auto_dispose_listen.dart | 24 + .../essentials/testing/await_future.dart | 30 + .../essentials/testing/create_container.dart | 22 + .../essentials/testing/full_widget_test.dart | 33 + .../essentials/testing/listen_provider.dart | 22 + .../essentials/testing/mock_provider.dart | 45 ++ .../testing/notifier_mock/codegen.dart | 17 + .../testing/notifier_mock/codegen.g.dart | 81 +++ .../essentials/testing/notifier_mock/index.ts | 4 + .../essentials/testing/notifier_mock/raw.dart | 14 + .../testing/provider_to_mock/codegen.dart | 9 + .../testing/provider_to_mock/codegen.g.dart | 65 ++ .../testing/provider_to_mock/index.ts | 4 + .../testing/provider_to_mock/raw.dart | 6 + .../current/essentials/testing/unit_test.dart | 23 + .../testing/widget_container_of.dart | 15 + .../essentials/testing/widget_test.dart | 22 + .../current/essentials/websockets_sync.mdx | 108 +++ .../change_notifier_provider.dart | 11 + .../websockets_sync/pipe_change_notifier.dart | 22 + .../pipe_change_notifier.g.dart | 83 +++ .../essentials/websockets_sync/raw_usage.dart | 30 + .../websockets_sync/raw_usage.g.dart | 75 ++ .../shared_pipe_change_notifier.dart | 28 + .../shared_pipe_change_notifier.g.dart | 136 ++++ .../stream_provider/codegen.dart | 34 + .../stream_provider/codegen.g.dart | 65 ++ .../websockets_sync/stream_provider/index.ts | 4 + .../websockets_sync/stream_provider/raw.dart | 30 + .../websockets_sync/sync_consumer.dart | 19 + .../sync_definition/codegen.dart | 10 + .../sync_definition/codegen.g.dart | 74 ++ .../websockets_sync/sync_definition/index.ts | 4 + .../websockets_sync/sync_definition/raw.dart | 7 + .../current/from_provider/family/family.dart | 11 + .../from_provider/family/family.g.dart | 168 +++++ .../current/from_provider/family/index.tsx | 9 + .../current/from_provider/family/raw.dart | 27 + .../current/from_provider/helpers/item.dart | 12 + .../from_provider/helpers/item.freezed.dart | 146 ++++ .../current/from_provider/helpers/item.g.dart | 18 + .../current/from_provider/helpers/json.dart | 1 + .../motivation/async_values/async_values.dart | 29 + .../async_values/async_values.g.dart | 126 ++++ .../motivation/async_values/index.tsx | 9 + .../motivation/async_values/raw.dart | 25 + .../motivation/auto_dispose/auto_dispose.dart | 28 + .../auto_dispose/auto_dispose.g.dart | 132 ++++ .../motivation/auto_dispose/index.tsx | 9 + .../motivation/auto_dispose/raw.dart | 23 + .../motivation/combine/combine.dart | 19 + .../motivation/combine/combine.g.dart | 131 ++++ .../motivation/combine/index.tsx | 9 + .../from_provider/motivation/combine/raw.dart | 15 + .../from_provider/motivation/motivation.mdx | 189 +++++ .../motivation/override/index.tsx | 9 + .../motivation/override/override.dart | 16 + .../motivation/override/raw.dart | 16 + .../motivation/same_type/index.tsx | 9 + .../motivation/same_type/raw.dart | 15 + .../motivation/same_type/same_type.dart | 19 + .../motivation/same_type/same_type.g.dart | 133 ++++ .../motivation/side_effects/index.tsx | 9 + .../motivation/side_effects/raw.dart | 24 + .../motivation/side_effects/side_effects.dart | 24 + .../from_provider/provider_vs_riverpod.mdx | 401 +++++++++++ .../current/from_provider/quickstart.mdx | 197 ++++++ .../current/getting_started.mdx | 237 ------- .../current/getting_started_hello_world.dart | 20 - .../getting_started_hello_world_hooks.dart | 38 - .../current/introduction/getting_started.mdx | 195 +++++ .../dart_hello_world/index.tsx | 0 .../dart_hello_world/main.dart | 8 +- .../dart_hello_world/main.g.dart | 0 .../getting_started/dart_hello_world/raw.dart | 0 .../getting_started/dart_pub_add.tsx | 32 + .../getting_started/dart_pubspec.tsx | 12 +- .../hello_world/hooks_codegen/main.dart | 46 ++ .../hello_world/hooks_codegen}/main.g.dart | 0 .../getting_started/hello_world/index.tsx | 4 +- .../getting_started/hello_world/main.dart | 16 +- .../getting_started/hello_world}/main.g.dart | 0 .../getting_started/hello_world/raw.dart} | 16 +- .../hello_world/raw_hooks.dart | 40 ++ .../introduction/getting_started/pub_add.tsx | 39 + .../introduction/getting_started/pubspec.tsx | 51 ++ .../current/introduction/why_riverpod.mdx | 60 ++ .../introduction/why_riverpod/codegen.dart | 31 + .../introduction/why_riverpod/codegen.g.dart | 164 +++++ .../introduction/why_riverpod/index.tsx | 9 + .../introduction/why_riverpod/raw.dart | 27 + .../current/migration/0.13.0_to_0.14.0.mdx | 62 +- .../current/migration/0.14.0_to_1.0.0.mdx | 113 +-- .../migration/from_change_notifier.mdx | 132 ++++ .../declaration/declaration.dart | 33 + .../declaration/declaration.g.dart | 74 ++ .../declaration/index.tsx | 9 + .../from_change_notifier/declaration/raw.dart | 34 + .../initialization/index.tsx | 9 + .../initialization/initialization.dart | 29 + .../initialization/initialization.g.dart | 74 ++ .../initialization/raw.dart | 30 + .../from_change_notifier/migrated/index.tsx | 9 + .../migrated/migrated.dart | 37 + .../migrated/migrated.g.dart | 74 ++ .../from_change_notifier/migrated/raw.dart | 38 + .../migration/from_change_notifier/old.dart | 60 ++ .../current/migration/from_state_notifier.mdx | 264 +++++++ .../add_listener/add_listener.dart | 18 + .../add_listener/add_listener.g.dart | 81 +++ .../add_listener/index.tsx | 9 + .../from_state_notifier/add_listener/raw.dart | 17 + .../from_state_notifier/add_listener_old.dart | 25 + .../async_notifier/async_notifier.dart | 28 + .../async_notifier/async_notifier.g.dart | 75 ++ .../async_notifier/index.tsx | 9 + .../async_notifier/raw.dart | 31 + .../async_notifier_old.dart | 30 + .../build_init/build_init.dart | 15 + .../build_init/build_init.g.dart | 82 +++ .../from_state_notifier/build_init/index.tsx | 9 + .../from_state_notifier/build_init/raw.dart | 14 + .../from_state_notifier/build_init_old.dart | 15 + .../consumers_dont_change.dart | 38 + .../family_and_dispose.dart | 24 + .../family_and_dispose.g.dart | 170 +++++ .../family_and_dispose/index.tsx | 9 + .../family_and_dispose/raw.dart | 28 + .../family_and_dispose_old.dart | 32 + .../from_state_provider.dart | 14 + .../from_state_provider.g.dart | 82 +++ .../from_state_provider/index.tsx | 9 + .../from_state_provider/raw.dart | 14 + .../from_state_provider_old.dart | 6 + .../obtain_notifier_on_tests.dart | 34 + .../old_lifecycles/index.tsx | 9 + .../old_lifecycles/old_lifecycles.dart | 39 + .../old_lifecycles/old_lifecycles.g.dart | 141 ++++ .../old_lifecycles/raw.dart | 35 + .../old_lifecycles_final/index.tsx | 9 + .../old_lifecycles_final.dart | 41 ++ .../old_lifecycles_final.g.dart | 141 ++++ .../old_lifecycles_final/raw.dart | 36 + .../old_lifecycles_old.dart | 43 ++ .../current/migration/utils.dart | 23 + .../current/migration/utils.g.dart | 254 +++++++ .../providers/change_notifier_provider.mdx | 55 ++ .../change_notifier_provider/todos.dart | 45 ++ .../todos_consumer.dart | 32 + .../current/providers/future_provider.mdx | 65 +- .../config_consumer/codegen.dart | 16 + .../config_consumer/hooks.dart | 21 + .../config_consumer/hooks_codegen.dart | 22 + .../future_provider/config_consumer/index.tsx | 11 + .../future_provider/config_consumer/raw.dart | 18 + .../config_provider/codegen.dart | 22 + .../config_provider/codegen.g.dart | 71 ++ .../future_provider/config_provider/index.tsx | 9 + .../future_provider/config_provider/raw.dart | 22 + .../current/providers/notifier_provider.mdx | 55 ++ .../remote_todos/codegen.dart | 82 +++ .../remote_todos/codegen.freezed.dart | 184 +++++ .../remote_todos/codegen.g.dart | 91 +++ .../notifier_provider/remote_todos/index.tsx | 9 + .../notifier_provider/remote_todos/raw.dart | 101 +++ .../remote_todos/todos_consumer.dart | 37 + .../notifier_provider/todos/codegen.dart | 68 ++ .../todos/codegen.freezed.dart | 166 +++++ .../notifier_provider/todos/codegen.g.dart | 81 +++ .../notifier_provider/todos/index.tsx | 9 + .../notifier_provider/todos/raw.dart | 85 +++ .../todos/todos_consumer.dart | 32 + .../current/providers/provider.mdx | 130 ++-- .../completed_todos/completed_todos.dart | 15 + .../completed_todos/completed_todos.g.dart | 73 ++ .../provider/completed_todos/index.tsx | 9 + .../raw.dart} | 6 +- .../optimized_previous_button/index.tsx | 9 + .../optimized_previous_button.dart | 50 ++ .../optimized_previous_button.g.dart | 142 ++++ .../optimized_previous_button/raw.dart} | 4 +- .../current/providers/provider/todo/index.tsx | 9 + .../provider/{todo.dart => todo/raw.dart} | 12 +- .../current/providers/provider/todo/todo.dart | 25 + .../providers/provider/todo/todo.g.dart | 81 +++ .../providers/provider/todos_consumer.dart | 16 +- .../unoptimized_previous_button/index.tsx | 9 + .../raw.dart} | 6 +- .../unoptimized_previous_button.dart | 39 + .../unoptimized_previous_button.g.dart | 81 +++ .../providers/state_notifier_provider.mdx | 40 +- .../state_notifier_provider/todos.dart | 70 +- .../todos_consumer.dart | 8 +- .../current/providers/state_provider.mdx | 131 ++-- .../state_provider/connected_dropdown.dart | 21 +- .../providers/state_provider/dropdown.dart | 2 +- .../providers/state_provider/full.dart | 12 +- .../providers/state_provider/product.dart | 20 + .../state_provider/product_list_view.dart | 22 + .../state_provider/sort_provider.dart | 2 +- .../sorted_product_provider.dart | 24 + .../state_provider/update_read_once.dart | 24 + .../state_provider/update_read_twice.dart | 5 +- .../current/providers/stream_provider.mdx | 61 +- .../live_stream_chat_consumer.dart | 25 + .../live_stream_chat_provider.dart | 18 + .../live_stream_chat_provider/codegen.dart | 23 + .../live_stream_chat_provider/codegen.g.dart | 66 ++ .../live_stream_chat_provider/index.tsx | 9 + .../live_stream_chat_provider/raw.dart | 18 + website/i18n/ko/NOTE.md | 22 + website/i18n/ko/code.json | 462 ++++++++---- .../options.json | 2 +- .../current.json | 120 ++-- .../current/about_code_generation.mdx | 67 -- .../current/about_hooks.mdx | 283 -------- .../current/advanced/select.mdx | 59 ++ .../advanced/select/select/codegen.dart | 30 + .../advanced/select/select/codegen.g.dart | 72 ++ .../current/advanced/select/select/index.ts | 4 + .../current/advanced/select/select/raw.dart | 29 + .../advanced/select/select_async/codegen.dart | 24 + .../select/select_async/codegen.g.dart | 125 ++++ .../advanced/select/select_async/index.ts | 4 + .../advanced/select/select_async/raw.dart | 23 + .../current/case_studies/cancel.mdx | 118 ++++ .../cancel/detail_screen/codegen.dart | 61 ++ .../cancel/detail_screen/codegen.freezed.dart | 209 ++++++ .../cancel/detail_screen/codegen.g.dart | 86 +++ .../cancel/detail_screen/index.ts | 4 + .../cancel/detail_screen/raw.dart | 65 ++ .../cancel/detail_screen_cancel/codegen.dart | 28 + .../detail_screen_cancel/codegen.g.dart | 66 ++ .../cancel/detail_screen_cancel/index.ts | 4 + .../cancel/detail_screen_cancel/raw.dart | 25 + .../detail_screen_debounce/codegen.dart | 39 + .../detail_screen_debounce/codegen.g.dart | 66 ++ .../cancel/detail_screen_debounce/index.ts | 4 + .../cancel/detail_screen_debounce/raw.dart | 35 + .../case_studies/cancel/extension.dart | 31 + .../case_studies/cancel/home_screen.dart | 39 + .../provider_with_extension/codegen.dart | 25 + .../provider_with_extension/codegen.g.dart | 66 ++ .../cancel/provider_with_extension/index.ts | 4 + .../cancel/provider_with_extension/raw.dart | 23 + .../current/case_studies/pull_to_refresh.mdx | 119 ++++ .../pull_to_refresh/activity/codegen.dart | 19 + .../activity/codegen.freezed.dart | 209 ++++++ .../pull_to_refresh/activity/codegen.g.dart | 25 + .../pull_to_refresh/activity/index.ts | 4 + .../pull_to_refresh/activity/raw.dart | 24 + .../pull_to_refresh/display_activity.dart | 22 + .../pull_to_refresh/display_activity2.dart | 28 + .../pull_to_refresh/display_activity3.dart | 31 + .../pull_to_refresh/display_activity4.dart | 35 + .../fetch_activity/codegen.dart | 20 + .../fetch_activity/codegen.g.dart | 66 ++ .../pull_to_refresh/fetch_activity/index.ts | 4 + .../pull_to_refresh/fetch_activity/raw.dart | 17 + .../pull_to_refresh/full_app/codegen.dart | 69 ++ .../full_app/codegen.freezed.dart | 209 ++++++ .../pull_to_refresh/full_app/codegen.g.dart | 86 +++ .../pull_to_refresh/full_app/index.ts | 4 + .../pull_to_refresh/full_app/raw.dart | 73 ++ .../concepts/about_code_generation.mdx | 355 ++++++++++ .../current/concepts}/about_codegen/main.dart | 0 .../concepts}/about_codegen/main.g.dart | 0 .../provider_type/async_class_future.dart | 14 + .../provider_type/async_class_future.g.dart | 73 ++ .../provider_type/async_class_stream.dart | 14 + .../provider_type/async_class_stream.g.dart | 73 ++ .../provider_type/async_fn_future.dart | 9 + .../provider_type/async_fn_future.g.dart | 65 ++ .../provider_type/async_fn_stream.dart | 9 + .../provider_type/async_fn_stream.g.dart | 65 ++ .../provider_type/auto_dispose.dart | 12 + .../provider_type/auto_dispose.g.dart | 133 ++++ .../about_codegen/provider_type/family.dart | 7 + .../about_codegen/provider_type/family.g.dart | 145 ++++ .../provider_type/family_class.dart | 17 + .../provider_type/family_class.g.dart | 207 ++++++ .../provider_type/family_fn.dart | 13 + .../provider_type/family_fn.g.dart | 169 +++++ .../non_code_gen/async_notifier_provider.dart | 16 + .../non_code_gen/auto_dispose.dart | 12 + .../provider_type/non_code_gen/family.dart | 6 + .../non_code_gen/future_provider.dart | 7 + .../non_code_gen/notifier_provider.dart | 15 + .../provider_type/non_code_gen/provider.dart | 8 + .../stream_notifier_provider.dart | 16 + .../non_code_gen/stream_provider.dart | 6 + .../provider_type/sync_class.dart | 14 + .../provider_type/sync_class.g.dart | 81 +++ .../about_codegen/provider_type/sync_fn.dart | 9 + .../provider_type/sync_fn.g.dart | 73 ++ .../current/concepts}/about_codegen/raw.dart | 2 +- .../current/concepts/about_hooks.mdx | 310 ++++++++ .../about_hooks/hook_and_consumer.dart | 28 + .../concepts/about_hooks/hook_consumer.dart | 26 + .../about_hooks/hook_consumer_widget.dart | 23 + .../concepts/async_initialization.dart | 59 ++ .../characters_provider/codegen.dart | 31 + .../characters_provider/codegen.g.dart | 123 ++++ .../characters_provider/index.tsx | 9 + .../characters_provider/models.dart | 17 + .../characters_provider/raw.dart | 26 + .../city_provider/codegen.dart | 7 + .../city_provider/codegen.g.dart | 72 ++ .../city_provider/index.tsx | 9 + .../city_provider/raw.dart | 4 + .../filtered_todo_list_provider/codegen.dart | 33 + .../codegen.g.dart | 133 ++++ .../filtered_todo_list_provider/index.tsx | 9 + .../filtered_todo_list_provider/raw.dart | 27 + .../read_in_provider/codegen.dart | 17 + .../read_in_provider/codegen.g.dart | 132 ++++ .../read_in_provider/index.tsx | 9 + .../read_in_provider/raw.dart | 13 + .../select_async_provider/codegen.dart | 25 + .../select_async_provider/codegen.g.dart | 123 ++++ .../select_async_provider/index.tsx | 9 + .../select_async_provider/models.dart | 21 + .../select_async_provider/raw.dart | 21 + .../todo_list_provider/codegen.dart | 24 + .../todo_list_provider/codegen.freezed.dart | 166 +++++ .../todo_list_provider/codegen.g.dart | 81 +++ .../todo_list_provider/index.tsx | 9 + .../todo_list_provider/raw.dart | 36 + .../weather_provider/codegen.dart | 20 + .../weather_provider/codegen.g.dart | 124 ++++ .../weather_provider/index.tsx | 9 + .../weather_provider/raw.dart | 18 + .../whole_object_provider/codegen.dart | 24 + .../whole_object_provider/codegen.g.dart | 123 ++++ .../whole_object_provider/index.tsx | 9 + .../whole_object_provider/models.dart | 16 + .../whole_object_provider/raw.dart | 20 + .../current/concepts/combining_providers.mdx | 237 +++---- .../current/concepts/dialog_scope.dart | 59 ++ .../lifecycle_on_dispose/codegen.dart | 20 + .../lifecycle_on_dispose/codegen.g.dart | 65 ++ .../concepts/lifecycle_on_dispose/index.tsx | 9 + .../concepts/lifecycle_on_dispose/raw.dart | 17 + .../concepts/modifiers/auto_dispose.mdx | 103 +-- .../current/concepts/modifiers/family.mdx | 91 +-- .../current/concepts/provider_lifecycles.mdx | 108 +++ .../current/concepts/provider_observer.mdx | 36 +- .../concepts/provider_observer_logger.dart | 6 +- .../current/concepts/providers.mdx | 203 +++--- .../creating_a_provider/codegen.dart | 12 + .../creating_a_provider/codegen.g.dart | 72 ++ .../providers/creating_a_provider/index.tsx | 9 + .../providers/creating_a_provider/raw.dart | 9 + .../declaring_many_providers/codegen.dart | 10 + .../declaring_many_providers/codegen.g.dart | 132 ++++ .../declaring_many_providers/index.tsx | 9 + .../declaring_many_providers/raw.dart | 6 + .../current/concepts/reading.mdx | 436 +++++++----- .../consumer_hook.dart} | 6 +- .../consumer_stateful_widget/hooks.dart | 34 + .../consumer_stateful_widget/index.tsx | 9 + .../consumer_stateful_widget/raw.dart} | 6 +- .../consumer_widget/hooks.dart} | 6 +- .../reading/consumer_widget/index.tsx | 9 + .../consumer_widget/raw.dart} | 4 +- .../concepts/reading/counter/codegen.dart | 24 + .../concepts/reading/counter/codegen.g.dart | 141 ++++ .../concepts/reading/counter/index.tsx | 9 + .../counter/raw.dart} | 2 +- .../concepts/reading/listen/codegen.dart | 18 + .../concepts/reading/listen/codegen.g.dart | 131 ++++ .../current/concepts/reading/listen/index.tsx | 9 + .../current/concepts/reading/listen/raw.dart} | 5 +- .../reading/listen_build/codegen.dart | 28 + .../reading/listen_build/codegen.g.dart | 81 +++ .../reading/listen_build/codegen_hooks.dart | 34 + .../reading/listen_build/codegen_hooks.g.dart | 81 +++ .../concepts/reading/listen_build/index.tsx | 11 + .../concepts/reading/listen_build/raw.dart} | 2 +- .../reading/listen_build/raw_hooks.dart | 29 + .../concepts/reading/provider/codegen.dart | 20 + .../concepts/reading/provider/codegen.g.dart | 132 ++++ .../concepts/reading/provider/index.tsx | 9 + .../concepts/reading/provider/raw.dart | 19 + .../concepts/reading/read/codegen.dart | 32 + .../concepts/reading/read/codegen.g.dart | 81 +++ .../concepts/reading/read/codegen_hooks.dart | 36 + .../reading/read/codegen_hooks.g.dart | 81 +++ .../current/concepts/reading/read/index.tsx | 11 + .../read/raw.dart} | 7 +- .../concepts/reading/read/raw_hooks.dart | 31 + .../concepts/reading/read_build/codegen.dart | 25 + .../reading/read_build/codegen.g.dart | 81 +++ .../concepts/reading/read_build/index.tsx | 9 + .../read_build/raw.dart} | 2 +- .../reading/read_notifier_build/codegen.dart | 24 + .../read_notifier_build/codegen.g.dart | 81 +++ .../reading/read_notifier_build/index.tsx | 9 + .../read_notifier_build/raw.dart} | 0 .../concepts/reading/watch/codegen.dart | 45 ++ .../concepts/reading/watch/codegen.g.dart | 201 ++++++ .../current/concepts/reading/watch/index.tsx | 9 + .../watch/raw.dart} | 6 +- .../concepts/reading/watch_build/codegen.dart | 39 + .../reading/watch_build/codegen.g.dart | 140 ++++ .../reading/watch_build/codegen_hooks.dart | 43 ++ .../reading/watch_build/codegen_hooks.g.dart | 140 ++++ .../concepts/reading/watch_build/index.tsx | 11 + .../watch_build/raw.dart} | 2 +- .../reading/watch_build/raw_hooks.dart | 38 + .../reading/watch_notifier_build/codegen.dart | 24 + .../watch_notifier_build/codegen.g.dart | 81 +++ .../reading/watch_notifier_build/index.tsx | 9 + .../watch_notifier_build/raw.dart} | 0 .../current/concepts/scopes.mdx | 180 +++++ .../current/concepts/subtree_scope.dart | 79 +++ .../current/concepts/theme_scope.dart | 69 ++ .../current/concepts/why_immutability.mdx | 140 ++-- .../concepts/why_immutability/codegen.dart | 58 ++ .../why_immutability/codegen.freezed.dart | 151 ++++ .../concepts/why_immutability/codegen.g.dart | 82 +++ .../concepts/why_immutability/index.tsx | 9 + .../concepts/why_immutability/raw.dart | 67 ++ .../current/cookbooks/refresh.mdx | 10 - .../current/cookbooks/search_as_we_type.mdx | 30 +- .../current/cookbooks/testing.mdx | 112 +-- .../current/cookbooks/testing_dart.dart | 60 +- .../current/cookbooks/testing_flutter.dart | 32 +- .../current/cookbooks/testing_full.dart | 56 +- .../cookbooks/testing_original_test_dart.dart | 26 +- .../testing_original_test_flutter.dart | 19 +- .../cookbooks/testing_override_info.dart | 2 +- .../current/cookbooks/testing_repository.dart | 10 +- .../current/essentials/auto_dispose.mdx | 153 ++++ .../auto_dispose/cache_for_extension.dart | 17 + .../auto_dispose/cache_for_usage/codegen.dart | 17 + .../cache_for_usage/codegen.g.dart | 65 ++ .../auto_dispose/cache_for_usage/index.ts | 4 + .../auto_dispose/cache_for_usage/raw.dart | 15 + .../auto_dispose/codegen_keep_alive.dart | 11 + .../auto_dispose/codegen_keep_alive.g.dart | 72 ++ .../auto_dispose/invalidate_example.dart | 23 + .../invalidate_family_example/codegen.dart | 24 + .../invalidate_family_example/codegen.g.dart | 144 ++++ .../invalidate_family_example/index.ts | 4 + .../invalidate_family_example/raw.dart | 20 + .../auto_dispose/keep_alive/codegen.dart | 20 + .../auto_dispose/keep_alive/codegen.g.dart | 65 ++ .../auto_dispose/keep_alive/index.ts | 4 + .../auto_dispose/keep_alive/raw.dart | 19 + .../on_dispose_example/codegen.dart | 23 + .../on_dispose_example/codegen.g.dart | 124 ++++ .../auto_dispose/on_dispose_example/index.ts | 4 + .../auto_dispose/on_dispose_example/raw.dart | 17 + .../auto_dispose/raw_auto_dispose.dart | 7 + .../current/essentials/combining_requests.mdx | 126 ++++ .../functional_ref/codegen.dart | 18 + .../functional_ref/codegen.g.dart | 131 ++++ .../functional_ref/index.ts | 4 + .../functional_ref/raw.dart | 14 + .../listen_example/codegen.dart | 18 + .../listen_example/codegen.g.dart | 131 ++++ .../listen_example/index.ts | 4 + .../listen_example/raw.dart | 13 + .../notifier_ref/codegen.dart | 21 + .../notifier_ref/codegen.g.dart | 140 ++++ .../combining_requests/notifier_ref/index.ts | 4 + .../combining_requests/notifier_ref/raw.dart | 19 + .../read_example/codegen.dart | 23 + .../read_example/codegen.g.dart | 140 ++++ .../combining_requests/read_example/index.ts | 4 + .../combining_requests/read_example/raw.dart | 22 + .../watch_example/codegen.dart | 44 ++ .../watch_example/codegen.g.dart | 125 ++++ .../combining_requests/watch_example/index.ts | 4 + .../combining_requests/watch_example/raw.dart | 41 ++ .../watch_placement/codegen.dart | 38 + .../watch_placement/codegen.g.dart | 199 ++++++ .../watch_placement/index.ts | 4 + .../watch_placement/raw.dart | 35 + .../current/essentials/do_dont.mdx | 142 ++++ .../essentials/eager_initialization.mdx | 58 ++ .../async_consumer_example.dart | 27 + .../consumer_example.dart | 35 + .../require_value/codegen.dart | 24 + .../require_value/codegen.g.dart | 65 ++ .../require_value/index.ts | 4 + .../require_value/raw.dart | 20 + .../current/essentials/faq.mdx | 157 ++++ .../current/essentials/first_request.mdx | 320 +++++++++ .../essentials/first_request/activity.ts | 9 + .../first_request/codegen/activity.dart | 24 + .../codegen/activity.freezed.dart | 237 +++++++ .../first_request/codegen/activity.g.dart | 27 + .../first_request/codegen/provider.dart | 21 + .../first_request/codegen/provider.g.dart | 74 ++ .../essentials/first_request/consumer.ts | 8 + .../first_request/consumer_stateful_widget.ts | 8 + .../first_request/consumer_widget.ts | 8 + .../first_request/hook_consumer_widget.ts | 8 + .../first_request/legend/DocuCode.scss | 18 + .../first_request/legend/legend.tsx | 88 +++ .../essentials/first_request/provider.ts | 9 + .../first_request/raw/activity.dart | 30 + .../first_request/raw/consumer.dart | 41 ++ .../raw/consumer_stateful_widget.dart | 43 ++ .../first_request/raw/consumer_widget.dart | 25 + .../raw/hook_consumer_widget.dart | 28 + .../first_request/raw/provider.dart | 15 + .../current/essentials/passing_args.mdx | 137 ++++ .../passing_args/codegen/family.dart | 29 + .../passing_args/codegen/family.g.dart | 138 ++++ .../passing_args/codegen/provider.dart | 32 + .../passing_args/codegen/provider.g.dart | 220 ++++++ .../passing_args/no_arg_provider.ts | 9 + .../passing_args/raw/consumer_family.dart | 24 + .../raw/consumer_list_family.dart | 23 + .../passing_args/raw/consumer_provider.dart | 20 + .../raw/consumer_tuple_family.dart | 23 + .../essentials/passing_args/raw/family.dart | 41 ++ .../raw/multiple_consumer_family.dart | 37 + .../essentials/passing_args/raw/provider.dart | 26 + .../passing_args/raw/tuple_family.dart | 34 + .../current/essentials/provider_observer.mdx | 48 ++ .../provider_observer/provider_observer.dart | 43 ++ .../current/essentials/side_effects.mdx | 407 +++++++++++ .../codegen/todo_list_notifier.dart | 28 + .../codegen/todo_list_notifier.freezed.dart | 166 +++++ .../codegen/todo_list_notifier.g.dart | 89 +++ .../codegen/todo_list_notifier_add_todo.dart | 26 + .../todo_list_notifier_add_todo.g.dart | 74 ++ .../codegen/todo_list_provider.dart | 23 + .../codegen/todo_list_provider.freezed.dart | 148 ++++ .../codegen/todo_list_provider.g.dart | 66 ++ .../raw/consumer_add_todo_call.dart | 25 + .../raw/invalidate_self_add_todo.dart | 38 + .../side_effects/raw/manual_add_todo.dart | 39 + .../raw/mutable_manual_add_todo.dart | 35 + .../side_effects/raw/render_add_todo.dart | 78 ++ .../raw/render_add_todo_hooks.dart | 68 ++ .../side_effects/raw/rest_add_todo.dart | 39 + .../side_effects/raw/todo_list_notifier.dart | 44 ++ .../raw/todo_list_notifier_add_todo.dart | 28 + .../side_effects/raw/todo_list_provider.dart | 27 + .../side_effects/render_add_todo.ts | 9 + .../side_effects/todo_list_notifier.ts | 9 + .../todo_list_notifier_add_todo.ts | 9 + .../side_effects/todo_list_provider.ts | 7 + .../current/essentials/testing.mdx | 148 ++++ .../testing/auto_dispose_listen.dart | 24 + .../essentials/testing/await_future.dart | 29 + .../essentials/testing/create_container.dart | 22 + .../essentials/testing/full_widget_test.dart | 33 + .../essentials/testing/listen_provider.dart | 22 + .../essentials/testing/mock_provider.dart | 45 ++ .../testing/notifier_mock/codegen.dart | 17 + .../testing/notifier_mock/codegen.g.dart | 81 +++ .../essentials/testing/notifier_mock/index.ts | 4 + .../essentials/testing/notifier_mock/raw.dart | 15 + .../testing/provider_to_mock/codegen.dart | 9 + .../testing/provider_to_mock/codegen.g.dart | 65 ++ .../testing/provider_to_mock/index.ts | 4 + .../testing/provider_to_mock/raw.dart | 6 + .../current/essentials/testing/unit_test.dart | 23 + .../testing/widget_container_of.dart | 15 + .../essentials/testing/widget_test.dart | 22 + .../current/essentials/websockets_sync.mdx | 100 +++ .../change_notifier_provider.dart | 11 + .../websockets_sync/pipe_change_notifier.dart | 21 + .../pipe_change_notifier.g.dart | 79 +++ .../essentials/websockets_sync/raw_usage.dart | 28 + .../websockets_sync/raw_usage.g.dart | 75 ++ .../shared_pipe_change_notifier.dart | 28 + .../shared_pipe_change_notifier.g.dart | 136 ++++ .../stream_provider/codegen.dart | 34 + .../stream_provider/codegen.g.dart | 65 ++ .../websockets_sync/stream_provider/index.ts | 4 + .../websockets_sync/stream_provider/raw.dart | 30 + .../websockets_sync/sync_consumer.dart | 19 + .../sync_definition/codegen.dart | 10 + .../sync_definition/codegen.g.dart | 74 ++ .../websockets_sync/sync_definition/index.ts | 4 + .../websockets_sync/sync_definition/raw.dart | 7 + .../current/from_provider/family/family.dart | 11 + .../from_provider/family/family.g.dart | 168 +++++ .../current/from_provider/family/index.tsx | 9 + .../current/from_provider/family/raw.dart | 27 + .../current/from_provider/helpers/item.dart | 12 + .../from_provider/helpers/item.freezed.dart | 146 ++++ .../current/from_provider/helpers/item.g.dart | 18 + .../current/from_provider/helpers/json.dart | 1 + .../motivation/async_values/async_values.dart | 29 + .../async_values/async_values.g.dart | 126 ++++ .../motivation/async_values/index.tsx | 9 + .../motivation/async_values/raw.dart | 25 + .../motivation/auto_dispose/auto_dispose.dart | 29 + .../auto_dispose/auto_dispose.g.dart | 132 ++++ .../motivation/auto_dispose/index.tsx | 9 + .../motivation/auto_dispose/raw.dart | 24 + .../motivation/combine/combine.dart | 19 + .../motivation/combine/combine.g.dart | 131 ++++ .../motivation/combine/index.tsx | 9 + .../from_provider/motivation/combine/raw.dart | 15 + .../from_provider/motivation/motivation.mdx | 192 +++++ .../motivation/override/index.tsx | 9 + .../motivation/override/override.dart | 16 + .../motivation/override/raw.dart | 16 + .../motivation/same_type/index.tsx | 9 + .../motivation/same_type/raw.dart | 15 + .../motivation/same_type/same_type.dart | 19 + .../motivation/same_type/same_type.g.dart | 133 ++++ .../motivation/side_effects/index.tsx | 9 + .../motivation/side_effects/raw.dart | 24 + .../motivation/side_effects/side_effects.dart | 24 + .../from_provider/provider_vs_riverpod.mdx | 419 +++++++++++ .../current/from_provider/quickstart.mdx | 190 +++++ .../current/getting_started.mdx | 154 ---- .../getting_started/dart_hello_world/raw.dart | 19 - .../getting_started/dart_pubspec/codegen.yaml | 11 - .../getting_started/dart_pubspec/index.tsx | 9 - .../getting_started/dart_pubspec/raw.yaml | 6 - .../getting_started/pubspec/codegen.yaml | 14 - .../getting_started/pubspec/hooks.yaml | 10 - .../pubspec/hooks_codegen.yaml | 15 - .../current/getting_started/pubspec/index.tsx | 11 - .../current/getting_started/pubspec/raw.yaml | 9 - .../current/introduction.mdx | 76 -- .../current/introduction/getting_started.mdx | 191 +++++ .../dart_hello_world}/index.tsx | 0 .../dart_hello_world/main.dart | 24 + .../dart_hello_world}/main.g.dart | 0 .../dart_hello_world/raw.dart} | 10 +- .../getting_started/dart_pub_add.tsx | 32 + .../getting_started/dart_pubspec.tsx | 40 ++ .../hello_world/hooks_codegen/main.dart} | 16 +- .../hello_world/hooks_codegen/main.g.dart} | 2 +- .../getting_started/hello_world/index.tsx | 11 + .../getting_started/hello_world/main.dart | 12 +- .../getting_started/hello_world/main.g.dart | 73 ++ .../getting_started/hello_world/raw.dart | 0 .../hello_world/raw_hooks.dart | 0 .../introduction/getting_started/pub_add.tsx | 39 + .../introduction/getting_started/pubspec.tsx | 51 ++ .../current/introduction/why_riverpod.mdx | 56 ++ .../introduction/why_riverpod/codegen.dart | 31 + .../introduction/why_riverpod/codegen.g.dart | 164 +++++ .../introduction/why_riverpod/index.tsx | 9 + .../introduction/why_riverpod/raw.dart | 27 + .../current/migration/0.13.0_to_0.14.0.mdx | 59 +- .../current/migration/0.14.0_to_1.0.0.mdx | 102 +-- .../migration/from_change_notifier.mdx | 117 +++ .../declaration/declaration.dart | 33 + .../declaration/declaration.g.dart | 74 ++ .../declaration/index.tsx | 9 + .../from_change_notifier/declaration/raw.dart | 34 + .../initialization/index.tsx | 9 + .../initialization/initialization.dart | 29 + .../initialization/initialization.g.dart | 74 ++ .../initialization/raw.dart | 30 + .../from_change_notifier/migrated/index.tsx | 9 + .../migrated/migrated.dart | 37 + .../migrated/migrated.g.dart | 74 ++ .../from_change_notifier/migrated/raw.dart | 38 + .../migration/from_change_notifier/old.dart | 60 ++ .../current/migration/from_state_notifier.mdx | 243 +++++++ .../add_listener/add_listener.dart | 18 + .../add_listener/add_listener.g.dart | 81 +++ .../add_listener/index.tsx | 9 + .../from_state_notifier/add_listener/raw.dart | 17 + .../from_state_notifier/add_listener_old.dart | 25 + .../async_notifier/async_notifier.dart | 28 + .../async_notifier/async_notifier.g.dart | 75 ++ .../async_notifier/index.tsx | 9 + .../async_notifier/raw.dart | 31 + .../async_notifier_old.dart | 30 + .../build_init/build_init.dart | 15 + .../build_init/build_init.g.dart | 82 +++ .../from_state_notifier/build_init/index.tsx | 9 + .../from_state_notifier/build_init/raw.dart | 14 + .../from_state_notifier/build_init_old.dart | 15 + .../consumers_dont_change.dart | 38 + .../family_and_dispose.dart | 24 + .../family_and_dispose.g.dart | 170 +++++ .../family_and_dispose/index.tsx | 9 + .../family_and_dispose/raw.dart | 28 + .../family_and_dispose_old.dart | 32 + .../from_state_provider.dart | 14 + .../from_state_provider.g.dart | 82 +++ .../from_state_provider/index.tsx | 9 + .../from_state_provider/raw.dart | 14 + .../from_state_provider_old.dart | 6 + .../obtain_notifier_on_tests.dart | 34 + .../old_lifecycles/index.tsx | 9 + .../old_lifecycles/old_lifecycles.dart | 39 + .../old_lifecycles/old_lifecycles.g.dart | 141 ++++ .../old_lifecycles/raw.dart | 35 + .../old_lifecycles_final/index.tsx | 9 + .../old_lifecycles_final.dart | 41 ++ .../old_lifecycles_final.g.dart | 141 ++++ .../old_lifecycles_final/raw.dart | 36 + .../old_lifecycles_old.dart | 43 ++ .../current/migration/utils.dart | 23 + .../current/migration/utils.g.dart | 254 +++++++ .../providers/change_notifier_provider.mdx | 13 +- .../change_notifier_provider/todos.dart | 11 +- .../current/providers/future_provider.mdx | 20 +- .../config_consumer/codegen.dart | 13 +- .../config_consumer/hooks.dart | 11 +- .../config_consumer/hooks_codegen.dart | 12 +- .../future_provider/config_consumer/raw.dart | 12 +- .../current/providers/notifier_provider.mdx | 55 ++ .../remote_todos/codegen.dart | 82 +++ .../remote_todos/codegen.freezed.dart | 184 +++++ .../remote_todos/codegen.g.dart | 91 +++ .../notifier_provider/remote_todos/index.tsx | 9 + .../notifier_provider/remote_todos/raw.dart | 101 +++ .../remote_todos/todos_consumer.dart | 37 + .../notifier_provider/todos/codegen.dart | 68 ++ .../todos/codegen.freezed.dart | 166 +++++ .../notifier_provider/todos/codegen.g.dart | 81 +++ .../notifier_provider/todos/index.tsx | 9 + .../notifier_provider/todos/raw.dart | 85 +++ .../todos/todos_consumer.dart | 32 + .../current/providers/provider.mdx | 32 +- .../completed_todos/completed_todos.dart | 15 + .../completed_todos/completed_todos.g.dart | 73 ++ .../provider/completed_todos/index.tsx | 9 + .../raw.dart} | 6 +- .../optimized_previous_button/index.tsx | 9 + .../optimized_previous_button.dart | 50 ++ .../optimized_previous_button.g.dart | 142 ++++ .../optimized_previous_button/raw.dart} | 15 +- .../current/providers/provider/todo/index.tsx | 9 + .../provider/{todo.dart => todo/raw.dart} | 12 +- .../current/providers/provider/todo/todo.dart | 25 + .../providers/provider/todo/todo.g.dart | 81 +++ .../providers/provider/todos_consumer.dart | 4 +- .../unoptimized_previous_button/index.tsx | 9 + .../raw.dart} | 6 +- .../unoptimized_previous_button.dart | 39 + .../unoptimized_previous_button.g.dart | 81 +++ .../providers/state_notifier_provider.mdx | 16 +- .../current/providers/state_provider.mdx | 20 +- .../current/providers/stream_provider.mdx | 27 +- .../live_stream_chat_consumer.dart | 25 + .../live_stream_chat_provider.dart | 18 + .../live_stream_chat_provider/codegen.dart | 23 + .../live_stream_chat_provider/codegen.g.dart | 66 ++ .../live_stream_chat_provider/index.tsx | 9 + .../live_stream_chat_provider/raw.dart | 18 + .../current/riverpod_for_provider_users.mdx | 401 ----------- .../ko/docusaurus-theme-classic/footer.json | 34 +- .../ko/docusaurus-theme-classic/navbar.json | 6 +- website/i18n/zh-Hans/code.json | 119 ++-- .../current.json | 80 ++- .../current/about_code_generation.mdx | 58 -- .../current/about_hooks.mdx | 272 ------- .../current/advanced/select.mdx | 129 ++++ .../advanced/select/select/codegen.dart | 30 + .../advanced/select/select/codegen.g.dart | 72 ++ .../current/advanced/select/select/index.ts | 4 + .../current/advanced/select/select/raw.dart | 29 + .../advanced/select/select_async/codegen.dart | 28 + .../select/select_async/codegen.g.dart | 125 ++++ .../advanced/select/select_async/index.ts | 4 + .../advanced/select/select_async/raw.dart | 23 + .../current/case_studies/cancel.mdx | 278 ++++++++ .../cancel/detail_screen/codegen.dart | 61 ++ .../cancel/detail_screen/codegen.freezed.dart | 209 ++++++ .../cancel/detail_screen/codegen.g.dart | 86 +++ .../cancel/detail_screen/index.ts | 4 + .../cancel/detail_screen/raw.dart | 65 ++ .../cancel/detail_screen_cancel/codegen.dart | 28 + .../detail_screen_cancel/codegen.g.dart | 66 ++ .../cancel/detail_screen_cancel/index.ts | 4 + .../cancel/detail_screen_cancel/raw.dart | 25 + .../detail_screen_debounce/codegen.dart | 38 + .../detail_screen_debounce/codegen.g.dart | 66 ++ .../cancel/detail_screen_debounce/index.ts | 4 + .../cancel/detail_screen_debounce/raw.dart | 35 + .../case_studies/cancel/extension.dart | 32 + .../case_studies/cancel/home_screen.dart | 39 + .../provider_with_extension/codegen.dart | 25 + .../provider_with_extension/codegen.g.dart | 66 ++ .../cancel/provider_with_extension/index.ts | 4 + .../cancel/provider_with_extension/raw.dart | 22 + .../current/case_studies/pull_to_refresh.mdx | 253 +++++++ .../pull_to_refresh/activity/codegen.dart | 19 + .../activity/codegen.freezed.dart | 209 ++++++ .../pull_to_refresh/activity/codegen.g.dart | 25 + .../pull_to_refresh/activity/index.ts | 4 + .../pull_to_refresh/activity/raw.dart | 24 + .../pull_to_refresh/display_activity.dart | 22 + .../pull_to_refresh/display_activity2.dart | 28 + .../pull_to_refresh/display_activity3.dart | 30 + .../pull_to_refresh/display_activity4.dart | 36 + .../fetch_activity/codegen.dart | 20 + .../fetch_activity/codegen.g.dart | 66 ++ .../pull_to_refresh/fetch_activity/index.ts | 4 + .../pull_to_refresh/fetch_activity/raw.dart | 17 + .../pull_to_refresh/full_app/codegen.dart | 69 ++ .../full_app/codegen.freezed.dart | 209 ++++++ .../pull_to_refresh/full_app/codegen.g.dart | 86 +++ .../pull_to_refresh/full_app/index.ts | 4 + .../pull_to_refresh/full_app/raw.dart | 73 ++ .../concepts/about_code_generation.mdx | 488 +++++++++++++ .../current/concepts/about_codegen/main.dart | 22 + .../concepts/about_codegen/main.g.dart | 137 ++++ .../provider_type/async_class_future.dart | 14 + .../provider_type/async_class_future.g.dart | 73 ++ .../provider_type/async_class_stream.dart | 14 + .../provider_type/async_class_stream.g.dart | 73 ++ .../provider_type/async_fn_future.dart | 9 + .../provider_type/async_fn_future.g.dart | 65 ++ .../provider_type/async_fn_stream.dart | 9 + .../provider_type/async_fn_stream.g.dart | 65 ++ .../provider_type/auto_dispose.dart | 12 + .../provider_type/auto_dispose.g.dart | 133 ++++ .../about_codegen/provider_type/family.dart | 7 + .../about_codegen/provider_type/family.g.dart | 145 ++++ .../provider_type/family_class.dart | 17 + .../provider_type/family_class.g.dart | 207 ++++++ .../provider_type/family_fn.dart | 13 + .../provider_type/family_fn.g.dart | 169 +++++ .../non_code_gen/async_notifier_provider.dart | 16 + .../non_code_gen/auto_dispose.dart | 12 + .../provider_type/non_code_gen/family.dart | 6 + .../non_code_gen/future_provider.dart | 7 + .../non_code_gen/notifier_provider.dart | 15 + .../provider_type/non_code_gen/provider.dart | 8 + .../stream_notifier_provider.dart | 16 + .../non_code_gen/stream_provider.dart | 7 + .../provider_type/sync_class.dart | 14 + .../provider_type/sync_class.g.dart | 81 +++ .../about_codegen/provider_type/sync_fn.dart | 9 + .../provider_type/sync_fn.g.dart | 73 ++ .../current/concepts/about_codegen/raw.dart | 19 + .../current/concepts/about_hooks.mdx | 570 +++++++++++++++ .../about_hooks/hook_and_consumer.dart | 28 + .../concepts/about_hooks/hook_consumer.dart | 26 + .../about_hooks/hook_consumer_widget.dart | 23 + .../concepts/async_initialization.dart | 59 ++ .../characters_provider/codegen.dart | 31 + .../characters_provider/codegen.g.dart | 123 ++++ .../characters_provider/index.tsx | 9 + .../characters_provider/models.dart | 17 + .../characters_provider/raw.dart | 26 + .../city_provider/codegen.dart | 7 + .../city_provider/codegen.g.dart | 72 ++ .../city_provider/index.tsx | 9 + .../city_provider/raw.dart | 4 + .../filtered_todo_list_provider/codegen.dart | 33 + .../codegen.g.dart | 133 ++++ .../filtered_todo_list_provider/index.tsx | 9 + .../filtered_todo_list_provider/raw.dart | 27 + .../read_in_provider/codegen.dart | 17 + .../read_in_provider/codegen.g.dart | 132 ++++ .../read_in_provider/index.tsx | 9 + .../read_in_provider/raw.dart | 13 + .../select_async_provider/codegen.dart | 25 + .../select_async_provider/codegen.g.dart | 123 ++++ .../select_async_provider/index.tsx | 9 + .../select_async_provider/models.dart | 21 + .../select_async_provider/raw.dart | 21 + .../todo_list_provider/codegen.dart | 24 + .../todo_list_provider/codegen.freezed.dart | 166 +++++ .../todo_list_provider/codegen.g.dart | 81 +++ .../todo_list_provider/index.tsx | 9 + .../todo_list_provider/raw.dart | 36 + .../weather_provider/codegen.dart | 20 + .../weather_provider/codegen.g.dart | 124 ++++ .../weather_provider/index.tsx | 9 + .../weather_provider/raw.dart | 18 + .../whole_object_provider/codegen.dart | 24 + .../whole_object_provider/codegen.g.dart | 123 ++++ .../whole_object_provider/index.tsx | 9 + .../whole_object_provider/models.dart | 16 + .../whole_object_provider/raw.dart | 20 + .../current/concepts/combining_providers.mdx | 229 +++--- .../current/concepts/dialog_scope.dart | 59 ++ .../concepts/modifiers/auto_dispose.mdx | 88 ++- .../current/concepts/modifiers/family.mdx | 75 +- .../current/concepts/provider_lifecycles.mdx | 109 +-- .../current/concepts/provider_observer.mdx | 37 +- .../concepts/provider_observer_logger.dart | 62 ++ .../current/concepts/providers.mdx | 178 +++-- .../creating_a_provider/codegen.dart | 12 + .../creating_a_provider/codegen.g.dart | 72 ++ .../providers/creating_a_provider/index.tsx | 9 + .../providers/creating_a_provider/raw.dart | 9 + .../declaring_many_providers/codegen.dart | 10 + .../declaring_many_providers/codegen.g.dart | 132 ++++ .../declaring_many_providers/index.tsx | 9 + .../declaring_many_providers/raw.dart | 6 + .../current/concepts/reading.mdx | 339 +++++---- .../consumer_stateful_widget/hooks.dart | 6 +- .../reading/consumer_stateful_widget/raw.dart | 4 +- .../reading/consumer_widget/hooks.dart | 4 +- .../concepts/reading/consumer_widget/raw.dart | 2 +- .../concepts/reading/counter/codegen.dart | 2 +- .../current/concepts/reading/counter/raw.dart | 2 +- .../reading/listen_build/codegen_hooks.dart | 34 + .../reading/listen_build/codegen_hooks.g.dart | 81 +++ .../concepts/reading/listen_build/index.tsx | 6 +- .../reading/listen_build/raw_hooks.dart | 29 + .../concepts/reading/provider/codegen.dart | 2 +- .../concepts/reading/provider/raw.dart | 2 +- .../concepts/reading/read/codegen.dart | 2 +- .../concepts/reading/read/codegen_hooks.dart | 36 + .../reading/read/codegen_hooks.g.dart | 81 +++ .../current/concepts/reading/read/index.tsx | 6 +- .../current/concepts/reading/read/raw.dart | 5 +- .../concepts/reading/read/raw_hooks.dart | 31 + .../concepts/reading/read_build/codegen.dart | 2 +- .../concepts/reading/read_build/raw.dart | 2 +- .../concepts/reading/watch/codegen.dart | 6 +- .../current/concepts/reading/watch/raw.dart | 6 +- .../concepts/reading/watch_build/codegen.dart | 2 +- .../reading/watch_build/codegen_hooks.dart | 43 ++ .../reading/watch_build/codegen_hooks.g.dart | 140 ++++ .../concepts/reading/watch_build/index.tsx | 6 +- .../concepts/reading/watch_build/raw.dart | 2 +- .../reading/watch_build/raw_hooks.dart | 38 + .../current/concepts/scopes.mdx | 183 ++--- .../current/concepts/subtree_scope.dart | 79 +++ .../current/concepts/theme_scope.dart | 69 ++ .../current/concepts/why_immutability.mdx | 144 ++-- .../concepts/why_immutability/codegen.dart | 58 ++ .../why_immutability/codegen.freezed.dart | 151 ++++ .../concepts/why_immutability/codegen.g.dart | 82 +++ .../concepts/why_immutability/index.tsx | 9 + .../concepts/why_immutability/raw.dart | 67 ++ .../current/cookbooks/search_as_we_type.mdx | 148 ++++ .../current/cookbooks/testing.mdx | 106 +-- .../current/cookbooks/testing_dart.dart | 51 ++ .../current/cookbooks/testing_flutter.dart | 40 ++ .../current/cookbooks/testing_full.dart | 101 +++ .../cookbooks/testing_original_test_dart.dart | 64 ++ .../testing_original_test_flutter.dart | 57 ++ .../cookbooks/testing_override_info.dart | 43 ++ .../current/cookbooks/testing_repository.dart | 22 + .../current/essentials/auto_dispose.mdx | 306 ++++++++ .../auto_dispose/cache_for_extension.dart | 18 + .../auto_dispose/cache_for_usage/codegen.dart | 17 + .../cache_for_usage/codegen.g.dart | 65 ++ .../auto_dispose/cache_for_usage/index.ts | 4 + .../auto_dispose/cache_for_usage/raw.dart | 15 + .../auto_dispose/codegen_keep_alive.dart | 10 + .../auto_dispose/codegen_keep_alive.g.dart | 72 ++ .../auto_dispose/invalidate_example.dart | 23 + .../invalidate_family_example/codegen.dart | 24 + .../invalidate_family_example/codegen.g.dart | 144 ++++ .../invalidate_family_example/index.ts | 4 + .../invalidate_family_example/raw.dart | 20 + .../auto_dispose/keep_alive/codegen.dart | 21 + .../auto_dispose/keep_alive/codegen.g.dart | 65 ++ .../auto_dispose/keep_alive/index.ts | 4 + .../auto_dispose/keep_alive/raw.dart | 19 + .../on_dispose_example/codegen.dart | 23 + .../on_dispose_example/codegen.g.dart | 124 ++++ .../auto_dispose/on_dispose_example/index.ts | 4 + .../auto_dispose/on_dispose_example/raw.dart | 17 + .../auto_dispose/raw_auto_dispose.dart | 7 + .../current/essentials/combining_requests.mdx | 275 +++++++ .../functional_ref/codegen.dart | 18 + .../functional_ref/codegen.g.dart | 131 ++++ .../functional_ref/index.ts | 4 + .../functional_ref/raw.dart | 14 + .../listen_example/codegen.dart | 20 + .../listen_example/codegen.g.dart | 131 ++++ .../listen_example/index.ts | 4 + .../listen_example/raw.dart | 13 + .../notifier_ref/codegen.dart | 21 + .../notifier_ref/codegen.g.dart | 140 ++++ .../combining_requests/notifier_ref/index.ts | 4 + .../combining_requests/notifier_ref/raw.dart | 19 + .../read_example/codegen.dart | 26 + .../read_example/codegen.g.dart | 140 ++++ .../combining_requests/read_example/index.ts | 4 + .../combining_requests/read_example/raw.dart | 22 + .../watch_example/codegen.dart | 45 ++ .../watch_example/codegen.g.dart | 125 ++++ .../combining_requests/watch_example/index.ts | 4 + .../combining_requests/watch_example/raw.dart | 41 ++ .../watch_placement/codegen.dart | 40 ++ .../watch_placement/codegen.g.dart | 199 ++++++ .../watch_placement/index.ts | 4 + .../watch_placement/raw.dart | 35 + .../current/essentials/do_dont.mdx | 260 +++++++ .../essentials/eager_initialization.mdx | 117 +++ .../async_consumer_example.dart | 27 + .../consumer_example.dart | 35 + .../require_value/codegen.dart | 24 + .../require_value/codegen.g.dart | 65 ++ .../require_value/index.ts | 4 + .../require_value/raw.dart | 20 + .../current/essentials/faq.mdx | 355 ++++++++++ .../current/essentials/first_request.mdx | 580 +++++++++++++++ .../essentials/first_request/activity.ts | 9 + .../first_request/codegen/activity.dart | 23 + .../codegen/activity.freezed.dart | 237 +++++++ .../first_request/codegen/activity.g.dart | 27 + .../first_request/codegen/provider.dart | 19 + .../first_request/codegen/provider.g.dart | 74 ++ .../essentials/first_request/consumer.ts | 8 + .../first_request/consumer_stateful_widget.ts | 8 + .../first_request/consumer_widget.ts | 8 + .../first_request/hook_consumer_widget.ts | 8 + .../first_request/legend/DocuCode.scss | 18 + .../first_request/legend/legend.tsx | 88 +++ .../essentials/first_request/provider.ts | 9 + .../first_request/raw/activity.dart | 28 + .../first_request/raw/consumer.dart | 39 + .../raw/consumer_stateful_widget.dart | 42 ++ .../first_request/raw/consumer_widget.dart | 23 + .../raw/hook_consumer_widget.dart | 26 + .../first_request/raw/provider.dart | 13 + .../current/essentials/passing_args.mdx | 265 +++++++ .../passing_args/codegen/family.dart | 29 + .../passing_args/codegen/family.g.dart | 138 ++++ .../passing_args/codegen/provider.dart | 32 + .../passing_args/codegen/provider.g.dart | 220 ++++++ .../passing_args/no_arg_provider.ts | 9 + .../passing_args/raw/consumer_family.dart | 24 + .../raw/consumer_list_family.dart | 23 + .../passing_args/raw/consumer_provider.dart | 20 + .../raw/consumer_tuple_family.dart | 23 + .../essentials/passing_args/raw/family.dart | 41 ++ .../raw/multiple_consumer_family.dart | 37 + .../essentials/passing_args/raw/provider.dart | 26 + .../passing_args/raw/tuple_family.dart | 32 + .../current/essentials/provider_observer.mdx | 79 +++ .../provider_observer/provider_observer.dart | 43 ++ .../current/essentials/side_effects.mdx | 668 ++++++++++++++++++ .../codegen/todo_list_notifier.dart | 28 + .../codegen/todo_list_notifier.freezed.dart | 166 +++++ .../codegen/todo_list_notifier.g.dart | 89 +++ .../codegen/todo_list_notifier_add_todo.dart | 26 + .../todo_list_notifier_add_todo.g.dart | 74 ++ .../codegen/todo_list_provider.dart | 23 + .../codegen/todo_list_provider.freezed.dart | 148 ++++ .../codegen/todo_list_provider.g.dart | 66 ++ .../raw/consumer_add_todo_call.dart | 25 + .../raw/invalidate_self_add_todo.dart | 38 + .../side_effects/raw/manual_add_todo.dart | 39 + .../raw/mutable_manual_add_todo.dart | 35 + .../side_effects/raw/render_add_todo.dart | 78 ++ .../raw/render_add_todo_hooks.dart | 68 ++ .../side_effects/raw/rest_add_todo.dart | 39 + .../side_effects/raw/todo_list_notifier.dart | 44 ++ .../raw/todo_list_notifier_add_todo.dart | 28 + .../side_effects/raw/todo_list_provider.dart | 27 + .../side_effects/render_add_todo.ts | 9 + .../side_effects/todo_list_notifier.ts | 9 + .../todo_list_notifier_add_todo.ts | 9 + .../side_effects/todo_list_provider.ts | 7 + .../current/essentials/testing.mdx | 303 ++++++++ .../testing/auto_dispose_listen.dart | 24 + .../essentials/testing/await_future.dart | 32 + .../essentials/testing/create_container.dart | 22 + .../essentials/testing/full_widget_test.dart | 33 + .../essentials/testing/listen_provider.dart | 22 + .../essentials/testing/mock_provider.dart | 45 ++ .../testing/notifier_mock/codegen.dart | 17 + .../testing/notifier_mock/codegen.g.dart | 81 +++ .../essentials/testing/notifier_mock/index.ts | 4 + .../essentials/testing/notifier_mock/raw.dart | 14 + .../testing/provider_to_mock/codegen.dart | 9 + .../testing/provider_to_mock/codegen.g.dart | 65 ++ .../testing/provider_to_mock/index.ts | 4 + .../testing/provider_to_mock/raw.dart | 6 + .../current/essentials/testing/unit_test.dart | 23 + .../testing/widget_container_of.dart | 15 + .../essentials/testing/widget_test.dart | 22 + .../current/essentials/websockets_sync.mdx | 197 ++++++ .../change_notifier_provider.dart | 11 + .../websockets_sync/pipe_change_notifier.dart | 21 + .../pipe_change_notifier.g.dart | 79 +++ .../essentials/websockets_sync/raw_usage.dart | 30 + .../websockets_sync/raw_usage.g.dart | 75 ++ .../shared_pipe_change_notifier.dart | 28 + .../shared_pipe_change_notifier.g.dart | 136 ++++ .../stream_provider/codegen.dart | 34 + .../stream_provider/codegen.g.dart | 65 ++ .../websockets_sync/stream_provider/index.ts | 4 + .../websockets_sync/stream_provider/raw.dart | 30 + .../websockets_sync/sync_consumer.dart | 19 + .../sync_definition/codegen.dart | 10 + .../sync_definition/codegen.g.dart | 74 ++ .../websockets_sync/sync_definition/index.ts | 4 + .../websockets_sync/sync_definition/raw.dart | 7 + .../current/from_provider/family/family.dart | 11 + .../from_provider/family/family.g.dart | 168 +++++ .../current/from_provider/family/index.tsx | 9 + .../current/from_provider/family/raw.dart | 27 + .../current/from_provider/helpers/item.dart | 12 + .../from_provider/helpers/item.freezed.dart | 146 ++++ .../current/from_provider/helpers/item.g.dart | 18 + .../current/from_provider/helpers/json.dart | 1 + .../motivation/async_values/async_values.dart | 29 + .../async_values/async_values.g.dart | 126 ++++ .../motivation/async_values/index.tsx | 9 + .../motivation/async_values/raw.dart | 25 + .../motivation/auto_dispose/auto_dispose.dart | 24 + .../auto_dispose/auto_dispose.g.dart | 132 ++++ .../motivation/auto_dispose/index.tsx | 9 + .../motivation/auto_dispose/raw.dart | 20 + .../motivation/combine/combine.dart | 19 + .../motivation/combine/combine.g.dart | 131 ++++ .../motivation/combine/index.tsx | 9 + .../from_provider/motivation/combine/raw.dart | 15 + .../from_provider/motivation/motivation.mdx | 434 ++++++++++++ .../motivation/override/index.tsx | 9 + .../motivation/override/override.dart | 16 + .../motivation/override/raw.dart | 15 + .../motivation/same_type/index.tsx | 9 + .../motivation/same_type/raw.dart | 15 + .../motivation/same_type/same_type.dart | 19 + .../motivation/same_type/same_type.g.dart | 133 ++++ .../motivation/side_effects/index.tsx | 9 + .../motivation/side_effects/raw.dart | 24 + .../motivation/side_effects/side_effects.dart | 24 + .../from_provider/provider_vs_riverpod.mdx | 653 +++++++++++++++++ .../current/from_provider/quickstart.mdx | 399 +++++++++++ .../current/getting_started.mdx | 189 ----- .../current/getting_started/dart_pub_add.tsx | 10 - .../current/getting_started/pub_add.tsx | 14 - .../current/introduction.mdx | 65 -- .../current/introduction/getting_started.mdx | 296 ++++++++ .../dart_hello_world/index.tsx | 0 .../dart_hello_world/main.dart | 24 + .../dart_hello_world/main.g.dart | 73 ++ .../getting_started/dart_hello_world/raw.dart | 19 + .../getting_started/dart_pub_add.tsx | 32 + .../getting_started/dart_pubspec.tsx | 40 ++ .../hello_world/hooks_codegen/main.dart | 46 ++ .../hello_world/hooks_codegen/main.g.dart | 73 ++ .../getting_started/hello_world/index.tsx | 11 + .../getting_started/hello_world/main.dart | 42 ++ .../getting_started/hello_world/main.g.dart | 73 ++ .../getting_started/hello_world/raw.dart | 16 +- .../hello_world/raw_hooks.dart | 40 ++ .../introduction/getting_started/pub_add.tsx | 39 + .../getting_started/pubspec.tsx | 16 +- .../current/introduction/why_riverpod.mdx | 125 ++++ .../introduction/why_riverpod/codegen.dart | 29 + .../introduction/why_riverpod/codegen.g.dart | 164 +++++ .../introduction/why_riverpod/index.tsx | 9 + .../introduction/why_riverpod/raw.dart | 25 + .../current/migration/0.13.0_to_0.14.0.mdx | 120 ++++ .../current/migration/0.14.0_to_1.0.0.mdx | 226 ++++++ .../migration/from_change_notifier.mdx | 259 +++++++ .../declaration/declaration.dart | 33 + .../declaration/declaration.g.dart | 74 ++ .../declaration/index.tsx | 9 + .../from_change_notifier/declaration/raw.dart | 34 + .../initialization/index.tsx | 9 + .../initialization/initialization.dart | 29 + .../initialization/initialization.g.dart | 74 ++ .../initialization/raw.dart | 30 + .../from_change_notifier/migrated/index.tsx | 9 + .../migrated/migrated.dart | 37 + .../migrated/migrated.g.dart | 74 ++ .../from_change_notifier/migrated/raw.dart | 38 + .../migration/from_change_notifier/old.dart | 60 ++ .../current/migration/from_state_notifier.mdx | 547 ++++++++++++++ .../add_listener/add_listener.dart | 18 + .../add_listener/add_listener.g.dart | 81 +++ .../add_listener/index.tsx | 9 + .../from_state_notifier/add_listener/raw.dart | 17 + .../from_state_notifier/add_listener_old.dart | 25 + .../async_notifier/async_notifier.dart | 28 + .../async_notifier/async_notifier.g.dart | 75 ++ .../async_notifier/index.tsx | 9 + .../async_notifier/raw.dart | 31 + .../async_notifier_old.dart | 30 + .../build_init/build_init.dart | 15 + .../build_init/build_init.g.dart | 82 +++ .../from_state_notifier/build_init/index.tsx | 9 + .../from_state_notifier/build_init/raw.dart | 15 + .../from_state_notifier/build_init_old.dart | 15 + .../consumers_dont_change.dart | 38 + .../family_and_dispose.dart | 24 + .../family_and_dispose.g.dart | 170 +++++ .../family_and_dispose/index.tsx | 9 + .../family_and_dispose/raw.dart | 28 + .../family_and_dispose_old.dart | 32 + .../from_state_provider.dart | 14 + .../from_state_provider.g.dart | 82 +++ .../from_state_provider/index.tsx | 9 + .../from_state_provider/raw.dart | 14 + .../from_state_provider_old.dart | 6 + .../obtain_notifier_on_tests.dart | 34 + .../old_lifecycles/index.tsx | 9 + .../old_lifecycles/old_lifecycles.dart | 39 + .../old_lifecycles/old_lifecycles.g.dart | 141 ++++ .../old_lifecycles/raw.dart | 35 + .../old_lifecycles_final/index.tsx | 9 + .../old_lifecycles_final.dart | 41 ++ .../old_lifecycles_final.g.dart | 141 ++++ .../old_lifecycles_final/raw.dart | 37 + .../old_lifecycles_old.dart | 43 ++ .../current/migration/utils.dart | 23 + .../current/migration/utils.g.dart | 254 +++++++ .../providers/change_notifier_provider.mdx | 53 +- .../change_notifier_provider/todos.dart | 11 +- .../current/providers/future_provider.mdx | 58 +- .../config_consumer/codegen.dart | 13 +- .../config_consumer/hooks.dart | 11 +- .../config_consumer/hooks_codegen.dart | 12 +- .../future_provider/config_consumer/raw.dart | 12 +- .../current/providers/notifier_provider.mdx | 55 +- .../remote_todos/codegen.dart | 22 +- .../notifier_provider/remote_todos/raw.dart | 26 +- .../remote_todos/todos_consumer.dart | 35 +- .../notifier_provider/todos/codegen.dart | 42 +- .../notifier_provider/todos/raw.dart | 51 +- .../todos/todos_consumer.dart | 6 +- .../current/providers/provider.mdx | 98 ++- .../completed_todos/completed_todos.dart | 2 +- .../provider/completed_todos/raw.dart | 4 +- .../optimized_previous_button.dart | 6 +- .../optimized_previous_button/raw.dart | 6 +- .../current/providers/provider/todo/raw.dart | 12 +- .../current/providers/provider/todo/todo.dart | 1 + .../providers/provider/todos_consumer.dart | 2 +- .../unoptimized_previous_button/raw.dart | 2 +- .../unoptimized_previous_button.dart | 2 +- .../providers/state_notifier_provider.mdx | 35 +- .../current/providers/state_provider.mdx | 118 ++-- .../current/providers/stream_provider.mdx | 67 +- .../live_stream_chat_consumer.dart | 21 +- .../live_stream_chat_provider/codegen.dart | 23 + .../live_stream_chat_provider/codegen.g.dart | 66 ++ .../live_stream_chat_provider/index.tsx | 9 + .../live_stream_chat_provider/raw.dart | 18 + .../current/riverpod_for_provider_users.mdx | 367 ---------- .../docusaurus-theme-classic/footer.json | 30 +- .../docusaurus-theme-classic/navbar.json | 4 + website/src/documents_meta.js | 207 +++--- website/static/snippets/combine.dart | 2 +- website/yarn.lock | 6 +- 1671 files changed, 82789 insertions(+), 6503 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 packages/riverpod_generator/lib/src/validation.dart create mode 100644 packages/riverpod_generator/test/error_test.dart create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/empty.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/empty.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.json create mode 100644 packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.json create mode 100644 packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.json create mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.json create mode 100644 packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.json create mode 100644 packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.json create mode 100644 packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.json create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart create mode 100644 website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx rename website/i18n/{ko/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/concepts}/about_codegen/main.dart (100%) rename website/i18n/{ko/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/concepts}/about_codegen/main.g.dart (100%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart rename website/i18n/{ko/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/concepts}/about_codegen/raw.dart (93%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/index.tsx rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose.dart => it/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/raw.dart} (85%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/provider_lifecycles.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_hook.dart => reading/consumer_hook.dart} (74%) rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_stateful_hook_consumer_widget.dart => reading/consumer_stateful_widget/hooks.dart} (69%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_stateful_widget.dart => reading/consumer_stateful_widget/raw.dart} (72%) rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_hook_widget.dart => reading/consumer_widget/hooks.dart} (70%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_widget.dart => reading/consumer_widget/raw.dart} (80%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/counter/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_counter.dart => reading/counter/raw.dart} (90%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen/index.tsx rename website/i18n/{ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart => it/docusaurus-plugin-content-docs/current/concepts/reading/listen/raw.dart} (68%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx rename website/i18n/{ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart => it/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw.dart} (95%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_read.dart => reading/read/raw.dart} (78%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read_build/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_read_build.dart => reading/read_build/raw.dart} (88%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_read_notifier_build.dart => reading/read_notifier_build/raw.dart} (100%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_watch.dart => reading/watch/raw.dart} (84%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_watch_build.dart => reading/watch_build/raw.dart} (94%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/concepts/{reading_watch_notifier_build.dart => reading/watch_notifier_build/raw.dart} (100%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/scopes.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/faq.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx delete mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/getting_started.mdx delete mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world.dart delete mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx rename website/i18n/{ko/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/introduction}/getting_started/dart_hello_world/index.tsx (100%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/introduction}/getting_started/dart_hello_world/main.dart (54%) rename website/i18n/{ko/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/introduction}/getting_started/dart_hello_world/main.g.dart (100%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/introduction}/getting_started/dart_hello_world/raw.dart (100%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/introduction}/getting_started/dart_pubspec.tsx (78%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart rename website/i18n/{ko/docusaurus-plugin-content-docs/current/getting_started/hello_world => it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen}/main.g.dart (100%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/introduction}/getting_started/hello_world/index.tsx (67%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => it/docusaurus-plugin-content-docs/current/introduction}/getting_started/hello_world/main.dart (58%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world => it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world}/main.g.dart (100%) rename website/i18n/it/docusaurus-plugin-content-docs/current/{getting_started_hello_world_flutter.dart => introduction/getting_started/hello_world/raw.dart} (54%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/{completed_todos.dart => completed_todos/raw.dart} (65%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart rename website/i18n/{ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart => it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart} (87%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/{todo.dart => todo/raw.dart} (56%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx rename website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/{unoptimized_previous_button.dart => unoptimized_previous_button/raw.dart} (77%) create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product_list_view.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx create mode 100644 website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart create mode 100644 website/i18n/ko/NOTE.md delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/about_code_generation.mdx delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/about_hooks.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => ko/docusaurus-plugin-content-docs/current/concepts}/about_codegen/main.dart (100%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => ko/docusaurus-plugin-content-docs/current/concepts}/about_codegen/main.g.dart (100%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => ko/docusaurus-plugin-content-docs/current/concepts}/about_codegen/raw.dart (93%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_lifecycles.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_hook.dart => reading/consumer_hook.dart} (71%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_stateful_widget.dart => reading/consumer_stateful_widget/raw.dart} (69%) rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_hook_widget.dart => reading/consumer_widget/hooks.dart} (66%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_consumer_widget.dart => reading/consumer_widget/raw.dart} (78%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_counter.dart => reading/counter/raw.dart} (83%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/index.tsx rename website/i18n/{it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart => ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/raw.dart} (68%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx rename website/i18n/{it/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart => ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw.dart} (95%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_read.dart => reading/read/raw.dart} (74%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_read_build.dart => reading/read_build/raw.dart} (85%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_read_notifier_build.dart => reading/read_notifier_build/raw.dart} (100%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_watch.dart => reading/watch/raw.dart} (81%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_watch_build.dart => reading/watch_build/raw.dart} (92%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/{reading_watch_notifier_build.dart => reading/watch_notifier_build/raw.dart} (100%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/scopes.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/faq.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started.mdx delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/raw.dart delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/codegen.yaml delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/index.tsx delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/raw.yaml delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/codegen.yaml delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks.yaml delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks_codegen.yaml delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/index.tsx delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/raw.yaml delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx rename website/i18n/ko/docusaurus-plugin-content-docs/current/{getting_started/hello_world => introduction/getting_started/dart_hello_world}/index.tsx (100%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world => ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world}/main.g.dart (100%) rename website/i18n/ko/docusaurus-plugin-content-docs/current/{getting_started/dart_hello_world/main.dart => introduction/getting_started/dart_hello_world/raw.dart} (75%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.dart => ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart} (59%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart => ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart} (98%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/{ => introduction}/getting_started/hello_world/main.dart (61%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => ko/docusaurus-plugin-content-docs/current/introduction}/getting_started/hello_world/raw.dart (100%) rename website/i18n/{zh-Hans/docusaurus-plugin-content-docs/current => ko/docusaurus-plugin-content-docs/current/introduction}/getting_started/hello_world/raw_hooks.dart (100%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/{completed_todos.dart => completed_todos/raw.dart} (60%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart rename website/i18n/{it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart => ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart} (68%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/{todo.dart => todo/raw.dart} (55%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx rename website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/{unoptimized_previous_button.dart => unoptimized_previous_button/raw.dart} (76%) create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx create mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx delete mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_code_generation.mdx delete mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_hooks.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/faq.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx delete mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started.mdx delete mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_pub_add.tsx delete mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/pub_add.tsx delete mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx rename website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/{ => introduction}/getting_started/dart_hello_world/index.tsx (100%) create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart rename website/i18n/{ko/docusaurus-plugin-content-docs/current => zh-Hans/docusaurus-plugin-content-docs/current/introduction}/getting_started/hello_world/raw.dart (52%) create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx rename website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/{ => introduction}/getting_started/pubspec.tsx (79%) create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx create mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart delete mode 100644 website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..9d1e2066e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,34 @@ +## Related Issues + +fixes #your-issue-number + + + +## Checklist + +Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (`[x]`). + +- [ ] I have updated the `CHANGELOG.md` of the relevant packages. + Changelog files must be edited under the form: + + ```md + ## Unreleased fix/major/minor + + - Description of your change. (thanks to @yourGithubId) + ``` + +- [ ] If this contains new features or behavior changes, + I have updated the documentation to match those changes. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee9fb65fc..5cb0bcbfa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,7 +68,7 @@ Finally, head to `localhost:3000` ### Adding new language Riverpod supports multiple languages. -To add new languages, it is recommended to follow the [i18n](https://docusaurus.io/fr/docs/i18n/introduction) +To add new languages, it is recommended to follow the [i18n](https://docusaurus.io/docs/i18n/introduction) documentation of Docusaurus. The English documentation is hosted in [`/website/docs`](https://github.com/rrousselGit/riverpod/tree/master/website/docs). @@ -119,4 +119,4 @@ your code snippets should support those. This is done by having a separate `.dart` file for each possible scenario. Again, look at the [Getting Started] for an example. -[Getting Started]: https://github.com/rrousselGit/riverpod/blob/rework-flow/website/docs/introduction/getting_started.mdx +[Getting Started]: https://github.com/rrousselGit/riverpod/blob/master/website/docs/introduction/getting_started.mdx diff --git a/examples/counter/README.md b/examples/counter/README.md index 7895be08b..7837608b0 100644 --- a/examples/counter/README.md +++ b/examples/counter/README.md @@ -1,6 +1,6 @@ The standard Flutter Counter example built with [Riverpod] -This uses `ProvidedScope`. +This uses `ProviderScope`. [riverpod]: https://github.com/rrousselGit/riverpod diff --git a/examples/marvel/lib/src/screens/home.dart b/examples/marvel/lib/src/screens/home.dart index 78c864e32..a5bfc3fa8 100644 --- a/examples/marvel/lib/src/screens/home.dart +++ b/examples/marvel/lib/src/screens/home.dart @@ -92,7 +92,12 @@ class Home extends HookConsumerWidget { return Scaffold( appBar: AppBar(title: const Text('Error')), body: Center( - child: Text('$err'), + child: Text( + switch (err) { + DioException() => err.message ?? '$err', + _ => '$err', + }, + ), ), ); }, diff --git a/examples/marvel/pubspec.yaml b/examples/marvel/pubspec.yaml index 6d141bdfe..978c51ce7 100644 --- a/examples/marvel/pubspec.yaml +++ b/examples/marvel/pubspec.yaml @@ -3,7 +3,7 @@ description: A new Flutter project. publish_to: "none" environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0 <4.0.0" flutter: ">=1.17.0" dependencies: diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md index bcfc27ae2..2a43f4f76 100644 --- a/packages/flutter_riverpod/CHANGELOG.md +++ b/packages/flutter_riverpod/CHANGELOG.md @@ -27,6 +27,11 @@ Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. - **Breaking**: Removed everything marked as "deprecated" - Bumped minimum Dart SDK to >= 3.0.0-dev +## 2.4.10 - 2024-02-03 + +- Fix out of date `pub.dev` description +- Add `test` argument to `AsyncValue.guard` method. (thanks to @utamori) + ## 2.4.9 - 2023-11-27 - Fix "pending timer" issue inside tests when using `ref.keepAlive()`. diff --git a/packages/flutter_riverpod/lib/src/core/consumer.dart b/packages/flutter_riverpod/lib/src/core/consumer.dart index 6e50c5e99..dcf8e2085 100644 --- a/packages/flutter_riverpod/lib/src/core/consumer.dart +++ b/packages/flutter_riverpod/lib/src/core/consumer.dart @@ -236,9 +236,6 @@ abstract class ConsumerWidget extends ConsumerStatefulWidget { } class _ConsumerState extends ConsumerState { - @override - WidgetRef get ref => context as WidgetRef; - @override Widget build(BuildContext context) { return widget.build(context, ref); diff --git a/packages/flutter_riverpod/lib/src/core/provider_scope.dart b/packages/flutter_riverpod/lib/src/core/provider_scope.dart index 6b74ea797..86278b768 100644 --- a/packages/flutter_riverpod/lib/src/core/provider_scope.dart +++ b/packages/flutter_riverpod/lib/src/core/provider_scope.dart @@ -18,7 +18,7 @@ part of '../core.dart'; /// } /// ``` /// -/// It optionally possible to specify `overrides` to change the behavior of +/// It's optionally possible to specify `overrides` to change the behavior of /// some providers. This can be useful for testing purposes: /// /// ```dart diff --git a/packages/flutter_riverpod/pubspec.yaml b/packages/flutter_riverpod/pubspec.yaml index c84922abe..313841192 100644 --- a/packages/flutter_riverpod/pubspec.yaml +++ b/packages/flutter_riverpod/pubspec.yaml @@ -1,7 +1,7 @@ name: flutter_riverpod description: > - A simple way to access state from anywhere in your application - while robust and testable. + A reactive caching and data-binding framework. + Riverpod makes working with asynchronous code a breeze. version: 3.0.0-dev.3 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod diff --git a/packages/hooks_riverpod/CHANGELOG.md b/packages/hooks_riverpod/CHANGELOG.md index 83ded1fb5..51319b528 100644 --- a/packages/hooks_riverpod/CHANGELOG.md +++ b/packages/hooks_riverpod/CHANGELOG.md @@ -27,6 +27,11 @@ Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. - **Breaking**: Removed everything marked as "deprecated" - Bumped minimum Dart SDK to >= 3.0.0-dev +## 2.4.10 - 2024-02-03 + +- Fix out of date `pub.dev` description +- Add `test` argument to `AsyncValue.guard` method. (thanks to @utamori) + ## 2.4.9 - 2023-11-27 - Fix "pending timer" issue inside tests when using `ref.keepAlive()`. diff --git a/packages/hooks_riverpod/pubspec.yaml b/packages/hooks_riverpod/pubspec.yaml index b1d897f5d..eb4d45f5b 100644 --- a/packages/hooks_riverpod/pubspec.yaml +++ b/packages/hooks_riverpod/pubspec.yaml @@ -1,7 +1,7 @@ name: hooks_riverpod description: > - A simple way to access state from anywhere in your application - while robust and testable. + A reactive caching and data-binding framework. + Riverpod makes working with asynchronous code a breeze. version: 3.0.0-dev.3 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 6361af5a8..c78e10224 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -27,11 +27,16 @@ Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. - **Breaking**: Removed everything marked as "deprecated" - Bumped minimum Dart SDK to >= 3.0.0-dev +## 2.5.0 - 2024-02-03 + +- Add `test` argument to `AsyncValue.guard` method. (thanks to @utamori) + ## 2.4.9 - 2023-11-27 - Fix "pending timer" issue inside tests when using `ref.keepAlive()`. - Fix `Ref.invalidate`/`Ref.refresh` not throwing on circular dependency. -- Fix an infinite loop caused by `ref.keepAlive` if the `KeepAliveLink` is immediately closed. +- Fix an infinite loop caused by `ref.keepAlive` if the `KeepAliveLink` is + immediately closed. - Fix `container.exists(provider)` on nested containers not checking their parent containers. @@ -46,13 +51,14 @@ Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. ## 2.4.6 - 2023-11-13 -- Exceptions in asynchronous providers are now correctly received - by `ProviderObserver.providerDidFail`. +- Exceptions in asynchronous providers are now correctly received by + `ProviderObserver.providerDidFail`. - Fix exception when a `ProviderScope` is rebuilt with a different `key`. ## 2.4.4 - 2023-10-15 -- Update the documentation of `provider.argument` to match the behavior of generated providers. +- Update the documentation of `provider.argument` to match the behavior of + generated providers. ## 2.4.3 - 2023-10-06 @@ -64,9 +70,8 @@ Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. ## 2.4.0 - 2023-09-04 -- Added `Notifier.stateOrNull`. - This will return `null` if used when the notifier has yet to be initialized - or is in error state. +- Added `Notifier.stateOrNull`. This will return `null` if used when the + notifier has yet to be initialized or is in error state. ## 2.3.10 - 2023-08-28 @@ -98,26 +103,26 @@ Riverpod now requires package:meta >=1.9.0 ## 2.3.3 - 2023-04-06 -- The debugger no-longer pauses on uncaught exceptions inside providers. - This was voluntary, but too many people have complained that it often - is a false positive. +- The debugger no-longer pauses on uncaught exceptions inside providers. This + was voluntary, but too many people have complained that it often is a false + positive. - Removed unused dependency (thanks to @passsy) ## 2.3.2 - 2023-03-13 -- Deprecated the generic parameter of `Family`. - This will enable implementing generic providers in `riverpod_generator` once - it is removed. +- Deprecated the generic parameter of `Family`. This will enable implementing + generic providers in `riverpod_generator` once it is removed. - Updated documentation ## 2.3.1 - 2023-03-09 -- Updated `AsyncValue.value/valueOrNull` docs to cover the "previous value" cases (thanks to @AhmedLSayed9) +- Updated `AsyncValue.value/valueOrNull` docs to cover the "previous value" + cases (thanks to @AhmedLSayed9) ## 2.3.0 -- Added `StreamNotifier` + `StreamNotifierProvider`. - This is for building a `StreamProvider` while exposing ways to modify the stream. +- Added `StreamNotifier` + `StreamNotifierProvider`. This is for building a + `StreamProvider` while exposing ways to modify the stream. It is primarily meant to be used using code-generation via riverpod_generator, by writing: @@ -132,8 +137,7 @@ Riverpod now requires package:meta >=1.9.0 } ``` -- Deprecated `StreamProvider.stream` - Instead of: +- Deprecated `StreamProvider.stream` Instead of: ```dart ref.watch(provider.stream).listen(...) @@ -162,15 +166,17 @@ Riverpod now requires package:meta >=1.9.0 }) ``` -- Some restrictions on the `dependencies` parameter of providers have been lifted. - It is no-longer necessary to include providers which do not themselves specify `dependencies`. - All providers should specify `dependencies` if they are scoped at any point. +- Some restrictions on the `dependencies` parameter of providers have been + lifted. It is no-longer necessary to include providers which do not themselves + specify `dependencies`. All providers should specify `dependencies` if they + are scoped at any point. - Annotated `Notifier.state` setter as protected. ## 2.2.0 -- Improve type-inference when using `AsyncValue.whenOrNull` (thanks to @AhmedLSayed9) +- Improve type-inference when using `AsyncValue.whenOrNull` (thanks to + @AhmedLSayed9) - Fixed AsyncValue.asError incorrectly not preserving the generic type - Internal refactoring for riverpod_generator @@ -182,8 +188,10 @@ Fixes an issue with `FutureProvider` (#2028) - Update dependencies. - fixes an exception on newer Dart versions -- fixes an edge-case where `FutureProvider`/`AsyncNotifier` did not emit the new state when the created `Future` completed (#1997) -- fixes errors inside FutureProvider/AsyncNotifier/StreamProvider not preserving the previous state (if any). +- fixes an edge-case where `FutureProvider`/`AsyncNotifier` did not emit the new + state when the created `Future` completed (#1997) +- fixes errors inside FutureProvider/AsyncNotifier/StreamProvider not preserving + the previous state (if any). ## 2.1.1 @@ -195,38 +203,46 @@ A small release adding missing utilities and fixing some web related issues. - Added `provider.overrideWith((ref) => state`) - Added `FutureProviderRef.future`. -- Deprecated `StateProvider.state` - Instead, use either `ref.watch(stateProvider)` or `ref.read(stateProvider.notifier).state =` -- Deprecated `provider.overrideWithProvider`. Instead use `provider.overrideWith` -- Added `Ref.notifyListeners()` to forcibly notify dependents. - This can be useful for mutable state. +- Deprecated `StateProvider.state` Instead, use either + `ref.watch(stateProvider)` or `ref.read(stateProvider.notifier).state =` +- Deprecated `provider.overrideWithProvider`. Instead use + `provider.overrideWith` +- Added `Ref.notifyListeners()` to forcibly notify dependents. This can be + useful for mutable state. - Added `@useResult` to `Ref.refresh`/`WidgetRef.refresh` - Added `Ref.exists` to check whether a provider is initialized or not. -- `FutureProvider`, `StreamProvider` and `AsyncNotifierProvider` now preserve the - previous data/error when going back to loading. - This is done by allowing `AsyncLoading` to optionally contain a value/error. -- Added `AsyncValue.when(skipLoadingOnReload: bool, skipLoadingOnRefresh: bool, skipError: bool)` - flags to give fine control over whether the UI should show `loading` - or `data/error` cases. +- `FutureProvider`, `StreamProvider` and `AsyncNotifierProvider` now preserve + the previous data/error when going back to loading. This is done by allowing + `AsyncLoading` to optionally contain a value/error. +- Added + `AsyncValue.when(skipLoadingOnReload: bool, skipLoadingOnRefresh: bool, skipError: bool)` + flags to give fine control over whether the UI should show `loading` or + `data/error` cases. - Add `AsyncValue.requireValue`, to forcibly obtain the `value` and throw if in loading/error state -- Doing `ref.watch(futureProvider.future)` can no-longer return a `SynchronousFuture`. - That behavior could break various `Future` utilities, such as `Future.wait` +- Doing `ref.watch(futureProvider.future)` can no-longer return a + `SynchronousFuture`. That behavior could break various `Future` utilities, + such as `Future.wait` - Add `AsyncValue.copyWithPrevious(..., isRefresh: false)` to differentiate rebuilds from `ref.watch` vs rebuilds from `ref.refresh`. -- ProviderContainer no-longer throws when disposed if it has an undisposed child ProviderContainer. +- ProviderContainer no-longer throws when disposed if it has an undisposed child + ProviderContainer. - Fixes a stackoverflow on Web caused by Dart (thanks to @leehack) -- Fixes a bug when the root ProviderContainer is not associated with a ProviderScope. -- Fixes a case where a circular dependency between providers was incorrectly allowed (#1766) +- Fixes a bug when the root ProviderContainer is not associated with a + ProviderScope. +- Fixes a case where a circular dependency between providers was incorrectly + allowed (#1766) ## 2.0.2 -- **FIX**: Fixed an assert error if a `family` depends on itself while specifying `dependencies`. (#1721). +- **FIX**: Fixed an assert error if a `family` depends on itself while + specifying `dependencies`. (#1721). ## 2.0.2 -Fixed an assert error if a `family` depends on itself while specifying `dependencies`. +Fixed an assert error if a `family` depends on itself while specifying +`dependencies`. ## 2.0.1 @@ -234,81 +250,94 @@ Updated changelog (see 2.0.0) ## 2.0.0 -Here is the changelog for all the changes in the 2.0 version. -An article is in progress and will be linked here once available. +Here is the changelog for all the changes in the 2.0 version. An article is in +progress and will be linked here once available. **Breaking changes**: - `FutureProvider.stream` is removed. - Using `overrideWithProvider`, it is no-longer possible to override a provider - with a different type of provider (such as overriding `FutureProvider` with a `StreamProvider`). -- `AsyncError.stackTrace` is now a required positional parameter and non-nullable -- All `overrideWithValue` methods are removed, besides `Provider.overrideWithValue`. - This change is temporary, and these methods will be reintroduced in a later version. - In the meantime, you can use `overrideWithProvider`. -- Modifiers (`provider.future`, `provider.state`, ...) no-longer are providers, and therefore no-longer - appear inside `ProviderObserver`. + with a different type of provider (such as overriding `FutureProvider` with a + `StreamProvider`). +- `AsyncError.stackTrace` is now a required positional parameter and + non-nullable +- All `overrideWithValue` methods are removed, besides + `Provider.overrideWithValue`. This change is temporary, and these methods will + be reintroduced in a later version. In the meantime, you can use + `overrideWithProvider`. +- Modifiers (`provider.future`, `provider.state`, ...) no-longer are providers, + and therefore no-longer appear inside `ProviderObserver`. - The `Reader` typedef is removed. Use `Ref` instead. - `ProviderListener` is removed. Used `ref.listen` instead. - Removed the deprecated `ProviderReference`. -- Providers no-longer throw a `ProviderException` if an exception was thrown while building their value. - Instead, they will rethrow the thrown exception and its stacktrace. -- It is no longer possible to pass `provider.future/.notifier/...` to the parameter `dependencies` of provider. - Passing the provider directly is enough. +- Providers no-longer throw a `ProviderException` if an exception was thrown + while building their value. Instead, they will rethrow the thrown exception + and its stacktrace. +- It is no longer possible to pass `provider.future/.notifier/...` to the + parameter `dependencies` of provider. Passing the provider directly is enough. - The `Family` type now has a single generic parameter instead of 3. Non-breaking changes: - Upgrade minimum required Dart SDK version to 2.17.0 -- Added `provider.selectAsync`, which allows to both await an async value - while also filtering rebuilds. -- Added `ref.listenSelf`, for subscribing to changes of a provider within - that provider. - That can be useful for logging purposes or storing the state of a provider - in a DB. -- Added `container.invalidate(provider)`/`ref.invalidate(provider)` and `ref.invalidateSelf()`. - These are similar to `ref.refresh` methods, but do not immediately rebuild the provider. +- Added `provider.selectAsync`, which allows to both await an async value while + also filtering rebuilds. +- Added `ref.listenSelf`, for subscribing to changes of a provider within that + provider. That can be useful for logging purposes or storing the state of a + provider in a DB. +- Added `container.invalidate(provider)`/`ref.invalidate(provider)` and + `ref.invalidateSelf()`. These are similar to `ref.refresh` methods, but do not + immediately rebuild the provider. These methods are safer than `ref.refresh` as they can avoid a provider rebuilding twice in a quick succession. - Added `ref.onAddListener`, `ref.onRemoveListener`, `ref.onCancel` and - `ref.onResume`. All of which allow performing side-effects when providers - are listened or stop being listened. + `ref.onResume`. All of which allow performing side-effects when providers are + listened or stop being listened. - A new `AutoDisposeRef.keepAlive()` function is added. It is meant to replace - `AutoDisposeRef.maintainState` to make logic for preventing the disposal of a provider more reusable. -- feat; `AutoDisposeRef.maintainState` is deprecated. Use the new `AutoDisposeRef.keepAlive()` instead. + `AutoDisposeRef.maintainState` to make logic for preventing the disposal of a + provider more reusable. +- feat; `AutoDisposeRef.maintainState` is deprecated. Use the new + `AutoDisposeRef.keepAlive()` instead. - Add support for `ref.invalidate(family)` to recompute an entire family (#1517) -- Added `AsyncValue.valueOrNull` to obtain the value while ignoring potential errors. -- Added new functionalities to `AsyncValue`: `hasError`, `hasData`, `asError`, `isLoading` - , `copyWithPrevious` and `unwrapPrevious`. +- Added `AsyncValue.valueOrNull` to obtain the value while ignoring potential + errors. +- Added new functionalities to `AsyncValue`: `hasError`, `hasData`, `asError`, + `isLoading` , `copyWithPrevious` and `unwrapPrevious`. Fixes: -- fixed a bug where `AsyncValue.whenData` did not preserve `AsyncValue.isLoading/isRefreshing` +- fixed a bug where `AsyncValue.whenData` did not preserve + `AsyncValue.isLoading/isRefreshing` - `StateProvider` and `StateNotifierProvider` no longer notify their listeners on `ref.refresh` if the new result is identical to the old one. - fixed potential null exception when using `autoDispose` -- fixed a bug where unmounting a nested ProviderScope could cause an exception (#1400) -- Fixed an issue where providers were incorrectly allowed to depend on themselves, - breaking `autoDispose` in the process. +- fixed a bug where unmounting a nested ProviderScope could cause an exception + (#1400) +- Fixed an issue where providers were incorrectly allowed to depend on + themselves, breaking `autoDispose` in the process. - Fixed a memory leak when using `StateProvider.autoDispose`'s `.state` - Fix `ProviderObserver.didDisposeProvider` not executing on provider refresh. - Fixed an issue where `AsyncValue.value` did not throw if there is an error. -- Fixed a cast error when overriding a provider with a more specific provider type (#1100) +- Fixed a cast error when overriding a provider with a more specific provider + type (#1100) - Fixed a bug where `onDispose` listeners could be executed twice under certain conditions when using `autoDispose`. -- Fixed an issue where refreshing a `provider.future`/`provider.stream` did work properly +- Fixed an issue where refreshing a `provider.future`/`provider.stream` did work + properly - Fixed false positive with `ref.watch` asserts ## 2.0.0-dev.9 -Fix Timer leak when using `cacheTime`/`disposeDelay` and disposing a `ProviderContainer` +Fix Timer leak when using `cacheTime`/`disposeDelay` and disposing a +`ProviderContainer` ## 2.0.0-dev.8 -fix: a bug where unmounting a nested ProviderScope could cause an exception (#1400) +fix: a bug where unmounting a nested ProviderScope could cause an exception +(#1400) ## 2.0.0-dev.7 @@ -316,7 +345,8 @@ Upgrade minimum required Dart SDK version to 2.17.0 ## 2.0.0-dev.6 -- Added `AsyncValue.valueOrNull` to obtain the value while ignoring potential errors. +- Added `AsyncValue.valueOrNull` to obtain the value while ignoring potential + errors. - Fixed an issue where `AsyncValue.value` did not throw if there is an error. - Fix families not applying cacheTime/disposeDelay - Fixed a bug where an exception may be thrown asynchronously after a @@ -324,30 +354,31 @@ Upgrade minimum required Dart SDK version to 2.17.0 ## 2.0.0-dev.5 -- Fixed a bug where emitting an `AsyncData` after an `AsyncError` leads to `AsyncValue.hasError` to be true +- Fixed a bug where emitting an `AsyncData` after an `AsyncError` leads to + `AsyncValue.hasError` to be true ## 2.0.0-dev.4 -- Added `ref.listenSelf`, for subscribing to changes of a provider within - that provider. - That can be useful for logging purposes or storing the state of a provider - in a DB. -- Added `disposeDelay` to all `autoDispose` providers and to `ProviderContainer`/`ProviderScope`. - This configures the amount of time before a provider is disposed when it is - not listened. +- Added `ref.listenSelf`, for subscribing to changes of a provider within that + provider. That can be useful for logging purposes or storing the state of a + provider in a DB. +- Added `disposeDelay` to all `autoDispose` providers and to + `ProviderContainer`/`ProviderScope`. This configures the amount of time before + a provider is disposed when it is not listened. -- Added `container.invalidate(provider)`/`ref.invalidate(provider)` and `ref.invalidateSelf()`. - These are similar to `ref.refresh` methods, but do not immediately rebuild the provider. +- Added `container.invalidate(provider)`/`ref.invalidate(provider)` and + `ref.invalidateSelf()`. These are similar to `ref.refresh` methods, but do not + immediately rebuild the provider. These methods are safer than `ref.refresh` as they can avoid a provider rebuilding twice in a quick succession. -- The duration passed to `cacheTime` now represents the minimum amount of - time after the latest change of a provider, instead of the first time - a provider built. +- The duration passed to `cacheTime` now represents the minimum amount of time + after the latest change of a provider, instead of the first time a provider + built. -- Fixed an issue where providers were incorrectly allowed to depend on themselves, - breaking `autoDispose` in the process. +- Fixed an issue where providers were incorrectly allowed to depend on + themselves, breaking `autoDispose` in the process. - Fixed a memory leak when using `StateProvider.autoDispose`'s `.state` @@ -355,64 +386,69 @@ Upgrade minimum required Dart SDK version to 2.17.0 ## 2.0.0-dev.3 -When calling `ref.listen` on a provider, this provider will now properly -rebuild if one of its dependency had changed. +When calling `ref.listen` on a provider, this provider will now properly rebuild +if one of its dependency had changed. ## 2.0.0-dev.2 - Deprecated `ref.maintainState=` in favor of a newly added `ref.keepAlive()`. - This new `ref.keepAlive()` function is similar to `maintainState` but - better handles cases where we have multiple logics that want to - keep the state of a provider alive for some period of time. + This new `ref.keepAlive()` function is similar to `maintainState` but better + handles cases where we have multiple logics that want to keep the state of a + provider alive for some period of time. - Removed the deprecated `ProviderReference`. -- Added `ProviderContainer.cacheTime` and `MyProvider.autoDispose(..., cacheTime: duration)`. - `cacheTime` is used to keep an `autoDispose` provider alive for at least - a minimum amount of time before it gets disposed if not listened. +- Added `ProviderContainer.cacheTime` and + `MyProvider.autoDispose(..., cacheTime: duration)`. `cacheTime` is used to + keep an `autoDispose` provider alive for at least a minimum amount of time + before it gets disposed if not listened. - Added `ref.onAddListener`, `ref.onRemoveListener`, `ref.onCancel` and - `ref.onResume`. All of which allow performing side-effects when providers - are listened or stop being listened. + `ref.onResume`. All of which allow performing side-effects when providers are + listened or stop being listened. ## 2.0.0-dev.1 - Now requires Dart 2.16 -- **Breaking** Providers no-longer throw a `ProviderException` if an exception was thrown while building their value. - Instead, they will rethrow the thrown exception and its stacktrace. +- **Breaking** Providers no-longer throw a `ProviderException` if an exception + was thrown while building their value. Instead, they will rethrow the thrown + exception and its stacktrace. - Removed `AsyncValue`'s `isError`/`isData` -- Added new functionalities to `AsyncValue`: `hasError`, `hasData`, `copyWithPrevious` -- Added `provider.selectAsync`, which allows to both await an async value - while also filtering rebuilds. -- When a provider emits an `AsyncError` followed by an `AsyncData`, - the `AsyncData` emitted will now contain the latest error/stackTrace too. +- Added new functionalities to `AsyncValue`: `hasError`, `hasData`, + `copyWithPrevious` +- Added `provider.selectAsync`, which allows to both await an async value while + also filtering rebuilds. +- When a provider emits an `AsyncError` followed by an `AsyncData`, the + `AsyncData` emitted will now contain the latest error/stackTrace too. -- Fixed a cast error when overriding a provider with a more specific provider type (#1100) +- Fixed a cast error when overriding a provider with a more specific provider + type (#1100) - Fixed a bug where `onDispose` listeners could be executed twice under certain conditions when using `autoDispose`. ## 2.0.0-dev.0 -- **Breaking** After a provider has emitted an `AsyncValue.data` or `AsyncValue.error`, - that provider will no longer emit an `AsyncValue.loading`. +- **Breaking** After a provider has emitted an `AsyncValue.data` or + `AsyncValue.error`, that provider will no longer emit an `AsyncValue.loading`. Instead, it will re-emit the latest value, but with the property `AsyncValue.isRefreshing` to true. - This allows the UI to keep showing the previous data/error when a provider - is being refreshed. + This allows the UI to keep showing the previous data/error when a provider is + being refreshed. -- Adding `isLoading`, `isError`, `isData` and `asError` to `AsyncValue`. - Those getters allow interacting with `AsyncValue` without having to rely on - pattern matching. -- Fixed an issue where refreshing a `provider.future`/`provider.stream` did work properly +- Adding `isLoading`, `isError`, `isData` and `asError` to `AsyncValue`. Those + getters allow interacting with `AsyncValue` without having to rely on pattern + matching. +- Fixed an issue where refreshing a `provider.future`/`provider.stream` did work + properly - Fixed false positive with `ref.watch` asserts ## 1.0.3 -Removed an assert preventing from overriding the same provider/family -multiple times on a `ProviderScope`/`ProviderContainer`. +Removed an assert preventing from overriding the same provider/family multiple +times on a `ProviderScope`/`ProviderContainer`. ## 1.0.2 @@ -429,20 +465,31 @@ Riverpod is now stable! ### General changes -- **Breaking**: `ProviderContainer.debugProviderValues` and `ProviderContainer.debugProviderElements` are removed. - You can now instead use `ProviderContainer.getAllProviderElements`. +- **Breaking**: `ProviderContainer.debugProviderValues` and + `ProviderContainer.debugProviderElements` are removed. You can now instead use + `ProviderContainer.getAllProviderElements`. - Increased minimum SDK version to 2.14.0 + <<<<<<< HEAD - **Breaking** The return value when reading a `StateProvider` changed. Before, doing `ref.read(someStateProvider)` would return the `StateController` instance. Now, this will only return the state of the `StateController`. This new behavior matches `StateNotifierProvider`. + ======= +- **Breaking** The return value when reading a `StateProvider` changed. Before, + doing `ref.read(someStateProvider)` would return the `StateController` + instance. Now, this will only return the state of the `StateController`. This + new behaviour matches `StateNotifierProvider`. + + > > > > > > > 1f6e3c462bdb2f8e058be63ab309ca2eb01ed71e For a simple migration, the old behavior is available by writing `ref.read(someStateProvider.state)`. -- Added `ref.listen` for triggering actions inside providers/widgets when a provider changes. +- Added `ref.listen` for triggering actions inside providers/widgets when a + provider changes. - It can be used to listen to another provider without recreating the provider state: + It can be used to listen to another provider without recreating the provider + state: ```dart final counterProvider = StateNotifierProvider(...); @@ -469,8 +516,9 @@ Riverpod is now stable! } ``` -- It is now possible to "await" all providers that emit an `AsyncValue` (previously limited to `FutureProvider`/`StreamProvider`). - This includes cases where a `StateNotifierProvider` exposes an `AsyncValue`: +- It is now possible to "await" all providers that emit an `AsyncValue` + (previously limited to `FutureProvider`/`StreamProvider`). This includes cases + where a `StateNotifierProvider` exposes an `AsyncValue`: ```dart class MyAsyncStateNotifier extends StateNotifier> { @@ -490,30 +538,34 @@ Riverpod is now stable! - Deprecated `StreamProvider.last` in favor of `StreamProvider.future`. -- `StreamProvider.future`, `StreamProvider.stream` and `FutureProvider.future` now - expose a future/stream that is independent from how many times the associated provider "rebuilt": +- `StreamProvider.future`, `StreamProvider.stream` and `FutureProvider.future` + now expose a future/stream that is independent from how many times the + associated provider "rebuilt": - if a `StreamProvider` rebuild before its stream emitted any value, - `StreamProvider.future` will resolve with the first value of the new stream instead. + `StreamProvider.future` will resolve with the first value of the new stream + instead. - if a `FutureProvider` rebuild before its future completes, - `FutureProvider.future` will resolve with the result of the new future instead. -- You can now override any provider with any other provider, as long as the value - that they expose matches. For example, it is possible to override a `StreamProvider` - with a `Provider>`. -- `ref.onDispose` now calls the dispose function as soon as one of the provider's - dependencies is known to have changed + `FutureProvider.future` will resolve with the result of the new future + instead. +- You can now override any provider with any other provider, as long as the + value that they expose matches. For example, it is possible to override a + `StreamProvider` with a `Provider>`. +- `ref.onDispose` now calls the dispose function as soon as one of the + provider's dependencies is known to have changed - Providers can now call `ref.refresh` to refresh a provider, instead of having to do `ref.container.refresh`. - Providers no longer wait until their next read to recompute their state if one of their dependencies changed and they have listeners. - Added `ProviderContainer.pump`, a utility to easily "await" until providers notify their listeners or are disposed. -- fixed an issue when using both `family` and `autoDispose` that could lead to an inconsistent state +- fixed an issue when using both `family` and `autoDispose` that could lead to + an inconsistent state ### Unified the syntax for interacting with providers - `ProviderReference` is deprecated in favor of `Ref`. -- `ref.watch` now supports `myProvider.select((value) => ...)`. - This allows filtering rebuilds: +- `ref.watch` now supports `myProvider.select((value) => ...)`. This allows + filtering rebuilds: ```dart final userProvider = StateNotifierProvider(...); @@ -525,7 +577,8 @@ Riverpod is now stable! }); ``` -- **Breaking**: `ProviderObserver.didUpdateProvider` now receives both the previous and new value. +- **Breaking**: `ProviderObserver.didUpdateProvider` now receives both the + previous and new value. - **Breaking**: `ProviderObserver.mayHaveChanged` is removed. - **Breaking**: `Family.overrideWithProvider` now must create a provider: @@ -538,7 +591,8 @@ Riverpod is now stable! ); ``` -- All providers now receive a custom subclass of `ProviderRefBase` as a parameter: +- All providers now receive a custom subclass of `ProviderRefBase` as a + parameter: ```dart Provider((ProviderRef ref) {...}); @@ -546,10 +600,12 @@ Riverpod is now stable! StateProvider((StateProviderRef ref) {...}); ``` - That allows providers to implement features that is not shared with other providers. + That allows providers to implement features that is not shared with other + providers. - - `Provider`, `FutureProvider` and `StreamProvider`'s `ref` now have a `state` property, - which represents the currently exposed value. Modifying it will notify the listeners: + - `Provider`, `FutureProvider` and `StreamProvider`'s `ref` now have a `state` + property, which represents the currently exposed value. Modifying it will + notify the listeners: ```dart Provider((ref) { @@ -564,7 +620,8 @@ Riverpod is now stable! - `StateProvider`'s `ref` now has a `controller` property, which allows the provider to access the `StateController` exposed. -- **Breaking**: `ProviderReference.mounted` is removed. You can implement something similar using `onDispose`: +- **Breaking**: `ProviderReference.mounted` is removed. You can implement + something similar using `onDispose`: ```dart Provider((ref) { var mounted = true; @@ -574,12 +631,12 @@ Riverpod is now stable! ### All providers can now be scoped. -- **Breaking**: `ScopedProvider` is removed. - To migrate, change `ScopedProvider`s to `Provider`s. +- **Breaking**: `ScopedProvider` is removed. To migrate, change + `ScopedProvider`s to `Provider`s. - All providers now come with an extra named parameter called `dependencies`. - This parameter optionally allows defining the list of providers/families that this - new provider depends on: + This parameter optionally allows defining the list of providers/families that + this new provider depends on: ```dart final a = Provider(...); @@ -587,12 +644,14 @@ Riverpod is now stable! final b = Provider((ref) => ref.watch(a), dependencies: [a]); ``` - By doing so, this will tell Riverpod to automatically override `b` if `a` gets overridden. + By doing so, this will tell Riverpod to automatically override `b` if `a` gets + overridden. ### Updated `AsyncValue`: - **Breaking** `AsyncValue.copyWith` is removed -- **Breaking** `AsyncValue.error(..., stacktrace)` is now a named parameter instead of positional parameter. +- **Breaking** `AsyncValue.error(..., stacktrace)` is now a named parameter + instead of positional parameter. - Deprecated `AsyncValue.data` in favor of `AsyncValue.value` - Allowed `AsyncData`, `AsyncError` and `AsyncLoading` to be extended - Added `AsyncValue.whenOrNull`, similar to `whenOrElse` but instead of an @@ -601,7 +660,8 @@ Riverpod is now stable! loading/error states. - `AsyncError` can now be instantiated with `const`. -- Added `StateController.update`, to simplify updating the state from the previous state: +- Added `StateController.update`, to simplify updating the state from the + previous state: ```dart final provider = StateController((ref) => 0); ... @@ -613,15 +673,18 @@ Riverpod is now stable! provider.select((value) => ref.watch(something)); // KO, cannot use ref.watch inside selectors ``` -- FutureProvider now creates a `FutureOr` instead of a `Future`. - That allows bypassing the loading state in the event where a value was synchronously available. +- FutureProvider now creates a `FutureOr` instead of a `Future`. That + allows bypassing the loading state in the event where a value was + synchronously available. ### Bug fixes -- Fixed a bug where widgets were not rebuilding in release mode under certain conditions -- **FIX**: StreamProvider.last no longer throws a StateError when no value were emitted (#296). -- fixed an issue where when chaining providers, widgets may re-render - a frame late, potentially causing a flicker. (see #648) +- Fixed a bug where widgets were not rebuilding in release mode under certain + conditions +- **FIX**: StreamProvider.last no longer throws a StateError when no value were + emitted (#296). +- fixed an issue where when chaining providers, widgets may re-render a frame + late, potentially causing a flicker. (see #648) ## 1.0.0-dev.10 @@ -636,13 +699,13 @@ Fix an issue where `*Provider.autoDispose` were not able to specify the ### Future/StreamProvider -- FutureProvider now creates a `FutureOr` instead of a `Future` - That allows bypassing the loading state in the event where a value was synchronously available. +- FutureProvider now creates a `FutureOr` instead of a `Future` That + allows bypassing the loading state in the event where a value was + synchronously available. -- During loading and error states, `FutureProvider` and `StreamProvider` now expose the - latest value through `AsyncValue`. - That allows UI to show the previous data while some new data is loading, - instead of showing a spinner: +- During loading and error states, `FutureProvider` and `StreamProvider` now + expose the latest value through `AsyncValue`. That allows UI to show the + previous data while some new data is loading, instead of showing a spinner: ```dart final provider = FutureProvider((ref) async { @@ -671,9 +734,10 @@ Fix an issue where `*Provider.autoDispose` were not able to specify the ### AsyncValue - **Breaking** `AsyncValue.copyWith` is removed -- **Breaking** `AsyncValue.error(..., stacktrace)` is now a named parameter instead of positional parameter. -- **Breaking** `AsyncValue.when(loading: )` and `AsyncValue.when(error: )` (and `when` variants) - now receive an extra "previous" parameter. +- **Breaking** `AsyncValue.error(..., stacktrace)` is now a named parameter + instead of positional parameter. +- **Breaking** `AsyncValue.when(loading: )` and `AsyncValue.when(error: )` (and + `when` variants) now receive an extra "previous" parameter. - Deprecated `AsyncValue.data` in favor of `AsyncValue.value` - Allowed `AsyncData`, `AsyncError` and `AsyncLoading` to be extended - Added `AsyncValue.whenOrNull`, similar to `whenOrElse` but instead of an @@ -685,11 +749,11 @@ Fix an issue where `*Provider.autoDispose` were not able to specify the ### General -- **Breaking** All `overrideWithProvider` methods are removed. - To migrate, instead use `overrideWithValue`. +- **Breaking** All `overrideWithProvider` methods are removed. To migrate, + instead use `overrideWithValue`. - All providers now come with an extra named parameter called `dependencies`. - This parameter optionally allows defining the list of providers/families that this - new provider depends on: + This parameter optionally allows defining the list of providers/families that + this new provider depends on: ```dart final a = Provider(...); @@ -697,9 +761,11 @@ Fix an issue where `*Provider.autoDispose` were not able to specify the final b = Provider((ref) => ref.watch(a), dependencies: [a]); ``` - By doing so, this will tell Riverpod to automatically override `b` if `a` gets overridden. + By doing so, this will tell Riverpod to automatically override `b` if `a` gets + overridden. -- Added `StateController.update`, to simplify updating the state from the previous state: +- Added `StateController.update`, to simplify updating the state from the + previous state: ```dart final provider = StateController((ref) => 0); ... @@ -716,21 +782,24 @@ Fix an issue where `*Provider.autoDispose` were not able to specify the - fixed `ref.listen` now working when downcasing the value of a provider. - fixed a bug where disposing a scoped `ProviderContainer` could cause other `ProviderContainer`s to stop working. -- fixed an issue where conditionally depending on an "autoDispose" provider - may not properly dispose of it (see #712) -- fixed an issue where when chaining providers, widgets may re-render - a frame late, potentially causing a flicker. (see #648) +- fixed an issue where conditionally depending on an "autoDispose" provider may + not properly dispose of it (see #712) +- fixed an issue where when chaining providers, widgets may re-render a frame + late, potentially causing a flicker. (see #648) ## 1.0.0-dev.7 - Fixed `ProviderObserver` not working when modifying a `StateProvider`. - Fixed a bug where scoped provider were potentially not disposed -- Fixed a bug where widgets were not rebuilding in release mode under certain conditions +- Fixed a bug where widgets were not rebuilding in release mode under certain + conditions ## 1.0.0-dev.6 -- **FIX**: StreamProvider.last no longer throws a StateError when no value were emitted (#296). -- Re-enabled debug assertions that were temporarily disabled by previous dev versions. +- **FIX**: StreamProvider.last no longer throws a StateError when no value were + emitted (#296). +- Re-enabled debug assertions that were temporarily disabled by previous dev + versions. - Allows families to be scoped/overridden - Fixed bugs with `ref.refresh` not working on some providers - renamed `ProviderBase.recreateShouldNotify` to `updateShouldNotify` @@ -746,7 +815,8 @@ Fixed various issues related to scoped providers. ## 1.0.0-dev.2 - All providers can now be scoped. -- **breaking**: `ScopedProvider` is removed. To migrate, change `ScopedProvider`s to `Provider`s. +- **breaking**: `ScopedProvider` is removed. To migrate, change + `ScopedProvider`s to `Provider`s. ## 1.0.0-dev.1 @@ -754,8 +824,8 @@ Fixed various issues related to scoped providers. ## 1.0.0-dev.0 -- `ref.watch` now support `myProvider.select((value) => ...)`. - This allows filtering rebuilds: +- `ref.watch` now support `myProvider.select((value) => ...)`. This allows + filtering rebuilds: ```dart final userProvider = StateNotifierProvider(...); @@ -777,9 +847,11 @@ Fixed various issues related to scoped providers. ); ``` -- **Breaking**: `ProviderObserver.didUpdateProvider` now receives both the previous and new value. +- **Breaking**: `ProviderObserver.didUpdateProvider` now receives both the + previous and new value. - **Breaking**: `ProviderObserver.mayHaveChanged` is removed. -- Added `ref.listen`, used to listen to another provider without recreating the provider state: +- Added `ref.listen`, used to listen to another provider without recreating the + provider state: ```dart final counter = StateNotifierProvider(...); @@ -792,7 +864,8 @@ Fixed various issues related to scoped providers. ``` - `ProviderReference` is deprecated in favor of `ProviderRefBase`. -- All providers now receive a custom subclass of `ProviderRefBase` as a parameter: +- All providers now receive a custom subclass of `ProviderRefBase` as a + parameter: ```dart Provider((ProviderRef ref) {...}); @@ -800,10 +873,12 @@ Fixed various issues related to scoped providers. StateProvider((StateProviderRef ref) {...}); ``` - That allows providers to implement features that is not shared with other providers. + That allows providers to implement features that is not shared with other + providers. - - `Provider`, `FutureProvider` and `StreamProvider`'s `ref` now have a `state` property, - which represents the currently exposed value. Modifying it will notify the listeners: + - `Provider`, `FutureProvider` and `StreamProvider`'s `ref` now have a `state` + property, which represents the currently exposed value. Modifying it will + notify the listeners: ```dart Provider((ref) { @@ -818,46 +893,60 @@ Fixed various issues related to scoped providers. - `StateProvider`'s `ref` now has a `controller` property, which allows the provider to access the `StateController` exposed. -- **Breaking**: `ProviderReference.mounted` is removed. You can implement something similar using `onDispose`: +- **Breaking**: `ProviderReference.mounted` is removed. You can implement + something similar using `onDispose`: ```dart Provider((ref) { var mounted = true; ref.onDispose(() => mounted = false); }); ``` -- **Breaking**: `ProviderContainer.debugProviderValues` and `ProviderContainer.debugProviderElements` are removed. - You can now instead use `ProviderContainer.getAllProviderElements`. +- **Breaking**: `ProviderContainer.debugProviderValues` and + `ProviderContainer.debugProviderElements` are removed. You can now instead use + `ProviderContainer.getAllProviderElements`. - `StreamProvider.last`, `StreamProvider.stream` and `FutureProvider.future` now - expose a future/stream that is independent from how many times the associated provider "rebuilt": + expose a future/stream that is independent from how many times the associated + provider "rebuilt": - if a `StreamProvider` rebuild before its stream emitted any value, - `StreamProvider.last` will resolve with the first value of the new stream instead. + `StreamProvider.last` will resolve with the first value of the new stream + instead. - if a `FutureProvider` rebuild before its future completes, - `FutureProvider.future` will resolve with the result of the new future instead. -- You can now override any provider with any other provider, as long as the value - that they expose matches. For example, it is possible to override a `StreamProvider` - with a `Provider>`. -- `ref.onDispose` now calls the dispose function as soon as one of the provider's - dependency is known to have changed + `FutureProvider.future` will resolve with the result of the new future + instead. +- You can now override any provider with any other provider, as long as the + value that they expose matches. For example, it is possible to override a + `StreamProvider` with a `Provider>`. +- `ref.onDispose` now calls the dispose function as soon as one of the + provider's dependency is known to have changed - Providers can now call `ref.refresh` to refresh a provider, instead of having to do `ref.container.refresh`. - Providers no longer wait until their next read to recompute their state if one of their dependencies changed and they have listeners. - Added `ProviderContainer.pump`, a utility to easily "await" until providers notify their listeners or are disposed. -- fixed an issue when using both `family` and `autoDispose` that could lead to an inconsistent state +- fixed an issue when using both `family` and `autoDispose` that could lead to + an inconsistent state ## 0.14.0+3 -Removed an assert that could cause issues when an application is partially migrated to null safety. +Removed an assert that could cause issues when an application is partially +migrated to null safety. ## 0.14.0+1 -- Re-added `StateProvider.overrideWithValue`/`StateProvider.overrideWithProvider` that were involuntarily removed. +<<<<<<< HEAD + +- # Re-added `StateProvider.overrideWithValue`/`StateProvider.overrideWithProvider` that were involuntarily removed. +- Re-added + `StateProvider.overrideWithValue`/`StateProvider.overrideWithProvider` that + were unvoluntarily removed. + > > > > > > > 1f6e3c462bdb2f8e058be63ab309ca2eb01ed71e ## 0.14.0 -- **BREAKING CHANGE** The `Listener`/`LocatorMixin` typedefs are removed as the former could cause a name - conflict with the widget named `Listener` and the latter is not supported when using Riverpod. +- **BREAKING CHANGE** The `Listener`/`LocatorMixin` typedefs are removed as the + former could cause a name conflict with the widget named `Listener` and the + latter is not supported when using Riverpod. - **BREAKING CHANGE** The syntax for using `StateNotifierProvider` was updated. Before: @@ -887,18 +976,23 @@ Removed an assert that could cause issues when an application is partially migra } ``` - See also https://github.com/rrousselGit/riverpod/issues/341 for more information. + See also https://github.com/rrousselGit/riverpod/issues/341 for more + information. -- **BREAKING CHANGE** It is no longer possible to override `StreamProvider.stream/last` and `FutureProvider.future`. -- feat: Calling `ProviderContainer.dispose` multiple time no longer throws. - This simplifies the tear-off logic of tests. +- **BREAKING CHANGE** It is no longer possible to override + `StreamProvider.stream/last` and `FutureProvider.future`. +- feat: Calling `ProviderContainer.dispose` multiple time no longer throws. This + simplifies the tear-off logic of tests. - feat: Added `ChangeNotifierProvider.notifier` and `StateProvider.notifier` - They allow obtaining the notifier associated with the provider, without causing widgets/providers to rebuild when the state updates. -- fix: overriding a `StateNotifierProvider`/`ChangeNotifierProvider` with `overrideWithValue` now correctly listens to the notifier. + They allow obtaining the notifier associated with the provider, without + causing widgets/providers to rebuild when the state updates. +- fix: overriding a `StateNotifierProvider`/`ChangeNotifierProvider` with + `overrideWithValue` now correctly listens to the notifier. ## 0.13.1 -- Fixed a bug where overriding a `FutureProvider` with an error value could cause tests to fail (see https://github.com/rrousselGit/riverpod/issues/355) +- Fixed a bug where overriding a `FutureProvider` with an error value could + cause tests to fail (see https://github.com/rrousselGit/riverpod/issues/355) ## 0.13.0 @@ -906,16 +1000,20 @@ Removed an assert that could cause issues when an application is partially migra - `ProviderObserver` can now have a const constructor - Added the mechanism for state-inspection using the Flutter devtool - loosened the version constraints of `freezed_annotation` -- deprecated `import 'riverpod/all.dart'`. Now everything is available with `riverpod/riverpod.dart`. -- Fixed a but where listening to `StreamProvider.last` could result in a `StateError` (#217) +- deprecated `import 'riverpod/all.dart'`. Now everything is available with + `riverpod/riverpod.dart`. +- Fixed a but where listening to `StreamProvider.last` could result in a + `StateError` (#217) ## 0.13.0-nullsafety.3 -- deprecated `import 'riverpod/all.dart'`. Now everything is available with `riverpod/riverpod.dart`. +- deprecated `import 'riverpod/all.dart'`. Now everything is available with + `riverpod/riverpod.dart`. ## 0.13.0-nullsafety.1 -- Fixed a but where listening to `StreamProvider.last` could result in a `StateError` (#217) +- Fixed a but where listening to `StreamProvider.last` could result in a + `StateError` (#217) ## 0.13.0-nullsafety.0 @@ -927,17 +1025,20 @@ Migrated to null-safety ## 0.12.1 -- Fixed an remaining memory leak related to StreamProvider (see also https://github.com/rrousselGit/riverpod/issues/193) +- Fixed an remaining memory leak related to StreamProvider (see also + https://github.com/rrousselGit/riverpod/issues/193) ## 0.12.0 -- **Breaking** FutureProvider and StreamProvider no longer supports `null` as a valid value. -- Fixed a memory leak with StreamProvider (see also https://github.com/rrousselGit/riverpod/issues/193) +- **Breaking** FutureProvider and StreamProvider no longer supports `null` as a + valid value. +- Fixed a memory leak with StreamProvider (see also + https://github.com/rrousselGit/riverpod/issues/193) ## 0.11.2 -- Fixed a bug where providers (usually ScopedProviders) did not dispose correctly - (see also https://github.com/rrousselGit/riverpod/issues/154). +- Fixed a bug where providers (usually ScopedProviders) did not dispose + correctly (see also https://github.com/rrousselGit/riverpod/issues/154). ## 0.11.0 @@ -949,12 +1050,14 @@ Migrated to null-safety ## 0.10.0 -- Fixed a bug where the state of a provider may be disposed when it shouldn't be disposed. +- Fixed a bug where the state of a provider may be disposed when it shouldn't be + disposed. - Added a way to import the implementation class of providers with modifiers, such as `AutoDisposeProvider`. - This is useful if you want to use Riverpod with the lint `always_specify_types`: + This is useful if you want to use Riverpod with the lint + `always_specify_types`: ```dart import 'package:riverpod/all.dart'; @@ -969,7 +1072,8 @@ Migrated to null-safety ## 0.8.0 -- Renamed `ProviderContainer.debugProviderStates` to `ProviderContainer.debugProviderElements` +- Renamed `ProviderContainer.debugProviderStates` to + `ProviderContainer.debugProviderElements` - Fixed a bug where updating `ProviderScope.overrides` may cause an exception for no reason (see https://github.com/rrousselGit/riverpod/issues/107) @@ -978,7 +1082,8 @@ Migrated to null-safety - `ref.watch` on non ".autoDispose" providers can no longer read ".autoDispose" providers. - For more info, see http://riverpod.dev/docs/concepts/modifiers/auto_dispose#the-argument-type-autodisposeprovider-cant-be-assigned-to-the-parameter-type-alwaysaliveproviderbase + For more info, see + http://riverpod.dev/docs/concepts/modifiers/auto_dispose#the-argument-type-autodisposeprovider-cant-be-assigned-to-the-parameter-type-alwaysaliveproviderbase - `ScopedProvider` now accepts `null` as a function: @@ -997,14 +1102,14 @@ Migrated to null-safety ## 0.6.1 -- Fixed a bug where when disposing `ProviderContainer`, providers may be disposed - in an incorrect order. +- Fixed a bug where when disposing `ProviderContainer`, providers may be + disposed in an incorrect order. - Improved the performances of reading providers by 25% ## 0.6.0 -- Merged `Computed` and `Provider`. Now, all providers have the ability to rebuild - their state when one of the object they listen changed. +- Merged `Computed` and `Provider`. Now, all providers have the ability to + rebuild their state when one of the object they listen changed. To migrate, change: @@ -1026,9 +1131,9 @@ Migrated to null-safety }); ``` -- `Computed` (now `Provider`) no longer deeply compare collections to avoid rebuilds. - Comparing the content of lists is quite expensive and actually rarely useful. - Now, a simple `==` comparison is used. +- `Computed` (now `Provider`) no longer deeply compare collections to avoid + rebuilds. Comparing the content of lists is quite expensive and actually + rarely useful. Now, a simple `==` comparison is used. - Renamed `ProviderStateOwner` to `ProviderContainer` - Renamed `ProviderStateOwnerObserver` to `ProviderObserver` @@ -1036,19 +1141,19 @@ Migrated to null-safety - It is no longer possible to override a provider anywhere in the widget tree. Providers can only be overridden in the top-most `ProviderContainer`. -- Providers can now read values which may change over time using `ref.read` and `ref.watch`. - When using `ref.watch`, if the value obtained changes, this will cause the provider - to re-create its state. +- Providers can now read values which may change over time using `ref.read` and + `ref.watch`. When using `ref.watch`, if the value obtained changes, this will + cause the provider to re-create its state. -- It is no longer possible to add `ProviderObserver` anywhere in the widget tree. - They can be added only on the top-most `ProviderContainer`. +- It is no longer possible to add `ProviderObserver` anywhere in the widget + tree. They can be added only on the top-most `ProviderContainer`. -- Added `ProviderContainer.refresh(provider)`. - This method allows forcing the refresh of a provider, which can be useful - for things like "retry on error" or "pull to refresh". +- Added `ProviderContainer.refresh(provider)`. This method allows forcing the + refresh of a provider, which can be useful for things like "retry on error" or + "pull to refresh". -* `ref.read(StreamProvider)` no longer returns a `Stream` but an `AsyncValue` - Before: +* `ref.read(StreamProvider)` no longer returns a `Stream` but an + `AsyncValue` Before: ```dart final streamProvider = StreamProvider(...); @@ -1066,7 +1171,8 @@ Migrated to null-safety }); ``` -* `ref.read(FutureProvider)` no longer returns a `Future` but an `AsyncValue` +* `ref.read(FutureProvider)` no longer returns a `Future` but an + `AsyncValue` Before: @@ -1086,8 +1192,8 @@ Migrated to null-safety }); ``` -* Removed `ref.dependOn`. - You can now use `ref.read`/`ref.watch` to achieve the same effect. +* Removed `ref.dependOn`. You can now use `ref.read`/`ref.watch` to achieve the + same effect. Before: @@ -1107,7 +1213,8 @@ Migrated to null-safety }); ``` -* `Provider.readOwner(ProviderStateOwner)` is changed into `ProviderContainer.read(Provider)` +* `Provider.readOwner(ProviderStateOwner)` is changed into + `ProviderContainer.read(Provider)` * `Provider.watchOwner(ProviderStateOwner, (value) {})` is changed into: @@ -1124,12 +1231,11 @@ Migrated to null-safety subscription.close(); ``` -* `MyProvider.family.autoDispose` now correctly free both the arguments and the associated - providers from memory when the provider is no longer listened to. +* `MyProvider.family.autoDispose` now correctly free both the arguments and the + associated providers from memory when the provider is no longer listened to. - Added `ScopedProvider`, a new kind of provider that can be overridden anywhere - in the widget tree. - Normal providers cannot read a `ScopedProvider`. + in the widget tree. Normal providers cannot read a `ScopedProvider`. ## 0.5.1 @@ -1140,7 +1246,9 @@ Migrated to null-safety ## 0.5.0 - Changed `ComputedFamily` into `Computed.family` -- Added [AsyncValue.guard](https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue/guard.html to simplify transforming a Future into an AsyncValue. +- Added + [AsyncValue.guard](https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue/guard.html + to simplify transforming a Future into an AsyncValue. - Improved the documentation of the different providers ## 0.4.0 @@ -1168,22 +1276,23 @@ The behavior is the same. Only the syntax changed. ## 0.3.0 -- Added `AsyncValue.whenData`, syntax sugar for `AsyncValue.when` to handle - only the `data` case and do nothing for the error/loading cases. +- Added `AsyncValue.whenData`, syntax sugar for `AsyncValue.when` to handle only + the `data` case and do nothing for the error/loading cases. - Fixed a bug that caused [Computed] to crash if it stopped being listened to then was listened to again. ## 0.2.1 -- `Computed` now correctly unsubscribe to a provider when their - function stops using a provider. +- `Computed` now correctly unsubscribe to a provider when their function stops + using a provider. ## 0.2.0 - `ref.read` is renamed as `ref.dependOn` -- Deprecated `ref.dependOn(streamProvider).stream` and `ref.dependOn(futureProvider).future` - in favor of a universal `ref.dependOn(provider).value`. +- Deprecated `ref.dependOn(streamProvider).stream` and + `ref.dependOn(futureProvider).future` in favor of a universal + `ref.dependOn(provider).value`. - added `ref.read(provider)`, syntax sugar for `ref.dependOn(provider).value`. ## 0.1.0 diff --git a/packages/riverpod/lib/src/core/async_value.dart b/packages/riverpod/lib/src/core/async_value.dart index 70ae1eea2..a712224c1 100644 --- a/packages/riverpod/lib/src/core/async_value.dart +++ b/packages/riverpod/lib/src/core/async_value.dart @@ -160,12 +160,33 @@ sealed class AsyncValue { /// }); /// } /// } + /// + /// An optional callback can be specified to catch errors only under a certain condition. + /// In the following example, we catch all exceptions beside FormatExceptions. + /// + /// ```dart + /// AsyncValue.guard( + /// () async { /* ... */ }, + /// // Catch all errors beside [FormatException]s. + /// (err) => err is! FormatException, + /// ); + /// } /// ``` - static Future> guard(Future Function() future) async { + static Future> guard( + Future Function() future, [ + bool Function(Object)? test, + ]) async { try { return AsyncValue.data(await future()); } catch (err, stack) { - return AsyncValue.error(err, stack); + if (test == null) { + return AsyncValue.error(err, stack); + } + if (test(err)) { + return AsyncValue.error(err, stack); + } + + Error.throwWithStackTrace(err, stack); } } diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index 60ce69acc..119cdd5e7 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -78,6 +78,11 @@ sealed class ProviderOrFamily implements ProviderListenableOrFamily { /// /// In that scenario, the `dependencies` parameter is required and it must /// include `scopedProvider`. + /// + /// See also: + /// - [provider_dependencies](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint#provider_dependencies-riverpod_generator-only) + /// and [scoped_providers_should_specify_dependencies](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint#scoped_providers_should_specify_dependencies-generator-only).\ + /// These are lint rules that will warn about incorrect `dependencies` usages. final Iterable? dependencies; /// All the dependencies of a provider and their dependencies too. diff --git a/packages/riverpod/pubspec.yaml b/packages/riverpod/pubspec.yaml index 6632f1b55..1219bf994 100644 --- a/packages/riverpod/pubspec.yaml +++ b/packages/riverpod/pubspec.yaml @@ -1,7 +1,7 @@ name: riverpod description: > - A simple way to access state from anywhere in your application while robust - and testable. + A reactive caching and data-binding framework. + Riverpod makes working with asynchronous code a breeze. version: 3.0.0-dev.3 homepage: https://riverpod.dev repository: https://github.com/rrousselGit/riverpod diff --git a/packages/riverpod/test/new/core/async_value_test.dart b/packages/riverpod/test/new/core/async_value_test.dart index edb7c9d32..cc11baf79 100644 --- a/packages/riverpod/test/new/core/async_value_test.dart +++ b/packages/riverpod/test/new/core/async_value_test.dart @@ -1559,4 +1559,42 @@ void main() { completion(AsyncError(42, stack)), ); }); + + test( + 'AsyncValue.guard emits the error when the created future fails and predicate is null', + () async { + final stack = StackTrace.current; + + await expectLater( + AsyncValue.guard(() => Future.error(42, stack)), + completion(AsyncError(42, stack)), + ); + }); + + test( + 'AsyncValue.guard emits the error when the created future fails and predicate is true', + () async { + final stack = StackTrace.current; + bool isInt(Object error) => error is int; + + await expectLater( + AsyncValue.guard( + () => Future.error(42, stack), + isInt, + ), + completion(AsyncError(42, stack)), + ); + }); + + test('AsyncValue.guard rethrows exception if predicate is false,', () async { + bool isInt(Object error) => error is int; + + await expectLater( + AsyncValue.guard( + () => throw const FormatException(), + isInt, + ), + throwsA(isA()), + ); + }); } diff --git a/packages/riverpod/test/new/core/select_async_test.dart b/packages/riverpod/test/new/core/select_async_test.dart index 31b3451e8..fc7c91070 100644 --- a/packages/riverpod/test/new/core/select_async_test.dart +++ b/packages/riverpod/test/new/core/select_async_test.dart @@ -139,7 +139,6 @@ void main() { container.listen( provider.selectAsync((data) => data.isEven), listener.call, - fireImmediately: false, ); verifyZeroInteractions(listener); diff --git a/packages/riverpod_analyzer_utils/CHANGELOG.md b/packages/riverpod_analyzer_utils/CHANGELOG.md index e1f565942..a127ba0d2 100644 --- a/packages/riverpod_analyzer_utils/CHANGELOG.md +++ b/packages/riverpod_analyzer_utils/CHANGELOG.md @@ -7,11 +7,15 @@ - Added `GeneratorProviderDeclarationElement.isFamily` +## 0.5.1 - 2024-02-04 + +- Bumped `custom_lint` version + ## 0.5.0 - 2023-11-20 - **Breaking** `LegacyProviderDeclarationElement.providerType` is now nullable. - Fix crash when parsing classes with a `ProviderBase` field. - + ## 0.4.3 - 2023-10-28 - Added `GeneratorProviderDeclarationElement.isFamily` diff --git a/packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart b/packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart index 40ab0a738..c3513773a 100644 --- a/packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart @@ -214,7 +214,7 @@ int sixth(SixthRef ref) => 0; expect( errors[5].message, - 'Failed to parse dependency Type (int*)', + 'Failed to parse dependency Type (int)', ); expect(errors[5].targetElement?.toString(), 'int sixth(InvalidType ref)'); }); diff --git a/packages/riverpod_annotation/CHANGELOG.md b/packages/riverpod_annotation/CHANGELOG.md index e6c7f2efb..7d1e9f47b 100644 --- a/packages/riverpod_annotation/CHANGELOG.md +++ b/packages/riverpod_annotation/CHANGELOG.md @@ -14,6 +14,10 @@ - `riverpod` upgraded to `3.0.0-dev.0` +## 2.3.4 - 2024-02-03 + +- Improved `@Riverpod(dependencies: [...])` documentation. + ## 2.3.3 - 2023-11-27 - `riverpod` upgraded to `2.4.9` diff --git a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart index eb3ccce64..00c2046fc 100644 --- a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart @@ -30,10 +30,75 @@ class Riverpod { /// Defaults to false. final bool keepAlive; - /// The list of dependencies of a provider. + /// The list of providers that this provider potentially depends on. /// - /// Values passed to the list of dependency should be the classes/functions - /// annotated with `@riverpod`; not the provider. + /// This list must contains the classes/functions annotated with `@riverpod`, + /// not the generated providers themselves. + /// + /// Specifying this list is strictly equivalent to saying "This provider may + /// be scoped". If a provider is scoped, it should specify [dependencies]. + /// If it is never scoped, it should not specify [dependencies]. + /// + /// The content of [dependencies] should be a list of all the providers that + /// this provider may depend on which can be scoped. + /// + /// For example, consider the following providers: + /// ```dart + /// // By not specifying "dependencies", we are saying that this provider is never scoped + /// @riverpod + /// Foo root(RootRef ref) => Foo(); + /// // By specifying "dependencies" (even if the list is empty), + /// // we are saying that this provider is potentially scoped + /// @Riverpod(dependencies: []) + /// Foo scoped(ScopedRef ref) => Foo(); + /// ``` + /// + /// Then if we were to depend on `rootProvider` in a scoped provider, we + /// could write any of: + /// + /// ```dart + /// @riverpod + /// Object? dependent(DependentRef ref) { + /// ref.watch(rootProvider); + /// // This provider does not depend on any scoped provider, + /// // as such "dependencies" is optional + /// } + /// + /// @Riverpod(dependencies: []) + /// Object? dependent(DependentRef ref) { + /// ref.watch(rootProvider); + /// // This provider decided to specify "dependencies" anyway, marking + /// // "dependentProvider" as possibly scoped. + /// // Since "rootProvider" is never scoped, it doesn't need to be included + /// // in "dependencies". + /// } + /// + /// @Riverpod(dependencies: [root]) + /// Object? dependent(DependentRef ref) { + /// ref.watch(rootProvider); + /// // Including "rootProvider" in "dependencies" is fine too, even though + /// // it is not required. It is a no-op. + /// } + /// ``` + /// + /// However, if we were to depend on `scopedProvider` then our only choice is: + /// + /// ```dart + /// @Riverpod(dependencies: [scoped]) + /// Object? dependent(DependentRef ref) { + /// ref.watch(scopedProvider); + /// // Since "scopedProvider" specifies "dependencies", any provider that + /// // depends on it must also specify "dependencies" and include "scopedProvider". + /// } + /// ``` + /// + /// In that scenario, the `dependencies` parameter is required and it must + /// include `scopedProvider`. + /// + /// See also: + /// - [provider_dependencies](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint#provider_dependencies-riverpod_generator-only) + /// and [scoped_providers_should_specify_dependencies](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint#scoped_providers_should_specify_dependencies-generator-only).\ + /// These are lint rules that will warn about incorrect `dependencies` usages. final List? dependencies; } diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 5265ab2aa..0b235425e 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -98,6 +98,17 @@ This comes with a few minor restrictions: - **Breaking**: Arguments of the form `fn(void myParameter())` are no-longer supported. Instead use `fn(void Function() myParameter)`. +## 2.3.11 - 2024-02-04 + +- `riverpod_analyzer_utils` upgraded to `0.5.1` + +## 2.3.10 - 2024-02-03 + +- Improved error handling if: + - a Notifier has no default constructor + - a Notifier has has a default constructor but with required parameters + - a Notifier is abstract + ## 2.3.9 - 2023-11-27 - `riverpod_annotation` upgraded to `2.3.3` diff --git a/packages/riverpod_generator/lib/src/validation.dart b/packages/riverpod_generator/lib/src/validation.dart new file mode 100644 index 000000000..a3c4287dc --- /dev/null +++ b/packages/riverpod_generator/lib/src/validation.dart @@ -0,0 +1,31 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import 'package:source_gen/source_gen.dart'; + +void validateClassBasedProvider(ClassBasedProviderDeclaration provider) { + // Assert that the class is not abstract + if (provider.node.abstractKeyword != null) { + throw InvalidGenerationSourceError( + '`@riverpod` can only be used on concrete classes.', + element: provider.node.declaredElement, + ); + } + + // Assert that the provider has a default constructor + final constructor = provider.node.declaredElement!.constructors + .firstWhereOrNull((e) => e.isDefaultConstructor); + if (constructor == null) { + throw InvalidGenerationSourceError( + 'The class ${provider.node.name} must have a default constructor.', + element: provider.node.declaredElement, + ); + } + + // Assert that the default constructor can be called with no parameter + if (constructor.parameters.any((e) => e.isRequired)) { + throw InvalidGenerationSourceError( + 'The default constructor of ${provider.node.name} must have not have required parameters.', + element: constructor, + ); + } +} diff --git a/packages/riverpod_generator/test/error_test.dart b/packages/riverpod_generator/test/error_test.dart new file mode 100644 index 000000000..f1df3cfbe --- /dev/null +++ b/packages/riverpod_generator/test/error_test.dart @@ -0,0 +1,147 @@ +import 'dart:convert'; +import 'dart:io'; + +import 'package:analyzer/dart/analysis/results.dart'; +import 'package:analyzer/dart/analysis/utilities.dart'; +import 'package:path/path.dart' as path; +import 'package:riverpod_generator/src/riverpod_generator.dart'; +import 'package:source_gen/source_gen.dart'; +import 'package:test/test.dart'; + +void main() { + group('Notifiers', () { + group('with arguments', () { + test('should throw if the class is abstract', () async { + const source = r''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@riverpod +abstract class MyNotifier extends _$MyNotifier { + @override + int build(int a) => 0; +} +'''; + + await expectLater( + () => compile(source), + throwsA(isA()), + ); + }); + + test('should throw if there is no default constructor', () async { + const source = r''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@riverpod +class MyNotifier extends _$MyNotifier { + MyNotifier._(); + + @override + int build(int a) => 0; +} +'''; + + await expectLater( + () => compile(source), + throwsA(isA()), + ); + }); + + test('should throw if the default constructor has required parameters', + () async { + const source = r''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@riverpod +class MyNotifier extends _$MyNotifier { + MyNotifier(int a); + + @override + int build(int a) => 0; +} +'''; + + await expectLater( + () => compile(source), + throwsA(isA()), + ); + }); + }); + + group('without arguments', () { + test('should throw if the class is abstract', () async { + const source = r''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@riverpod +abstract class MyNotifier extends _$MyNotifier { + @override + int build() => 0; +} +'''; + + await expectLater( + () => compile(source), + throwsA(isA()), + ); + }); + }); + }); +} + +void tearDownTmp() { + addTearDown(() { + final tmp = Directory('.dart_tool/test'); + if (tmp.existsSync()) { + tmp.deleteSync(recursive: true); + } + }); +} + +File createTmpFile(String filePath) { + tearDownTmp(); + + final file = File(path.join('.dart_tool', 'test', filePath)); + file.createSync(recursive: true); + + return file; +} + +Future compile(String source) async { + final generator = RiverpodGenerator(const {}); + + final main = createTmpFile('lib/main.dart')..writeAsStringSync(source); + final pubspec = createTmpFile('pubspec.yaml')..writeAsStringSync(''' +name: test_app + +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + riverpod_annotation: ^2.3.3 +'''); + + await runPubGet(pubspec.parent); + + final result = await resolveFile2(path: main.absolute.path); + + result as ResolvedUnitResult; + + return generator.generateForUnit([result.unit]); +} + +Future runPubGet(Directory parent) async { + final process = await Process.start( + 'dart', + ['pub', 'get'], + workingDirectory: parent.path, + ); + + final exitCode = await process.exitCode; + if (exitCode != 0) { + throw Exception( + 'flutter pub get failed with exit code $exitCode\n' + '${await process.stdout.transform(utf8.decoder).join()}', + ); + } +} diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index 30a352a82..973b13e5d 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -18,6 +18,17 @@ - `riverpod` upgraded to `3.0.0-dev.0` +## 2.3.9 - 2024-02-04 + +- Bumped `custom_lint` version + +## 2.3.8 - 2024-02-03 + +- Fix `async_value_nullable_pattern` false positive when used with generics + that have non-nullable type constrains. +- Add migration widget field when convert Stateless-based and + Stateful-based to each other (thanks to @Kurogoma4D) + ## 2.3.7 - 2023-11-27 - `riverpod` upgraded to `2.4.9` diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart index 782cc41df..0cd2605e9 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart @@ -1,7 +1,11 @@ import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/ast/token.dart'; +import 'package:analyzer/dart/ast/visitor.dart'; +import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/source/source_range.dart'; // ignore: implementation_imports, https://github.com/dart-lang/sdk/issues/54480 import 'package:analyzer/src/generated/source.dart' show Source; +import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart'; import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; @@ -83,6 +87,51 @@ class ConvertToStatefulBaseWidget extends RiverpodAssist { final widgetClass = node.thisOrAncestorOfType(); if (widgetClass == null) return; + final nodesToMove = {}; + final elementsToMove = {}; + final visitor = _FieldFinder(); + for (final member in widgetClass.members) { + if (member is ConstructorDeclaration) { + member.accept(visitor); + } + } + final fieldsAssignedInConstructors = visitor.fieldsAssignedInConstructors; + + for (final member in widgetClass.members) { + if (member is FieldDeclaration && !member.isStatic) { + for (final fieldNode in member.fields.variables) { + final fieldElement = fieldNode.declaredElement as FieldElement?; + if (fieldElement == null) continue; + if (!fieldsAssignedInConstructors.contains(fieldElement)) { + nodesToMove.add(member); + elementsToMove.add(fieldElement); + + final getter = fieldElement.getter; + if (getter != null) { + elementsToMove.add(getter); + } + + final setter = fieldElement.setter; + if (setter != null) { + elementsToMove.add(setter); + } + } + } + } else if (member is MethodDeclaration && !member.isStatic) { + nodesToMove.add(member); + elementsToMove.add(member.declaredElement!); + } + } + + for (final node in nodesToMove) { + final visitor = _ReplacementEditBuilder( + widgetClass.declaredElement!, + elementsToMove, + builder, + ); + node.accept(visitor); + } + final buildMethod = node .thisOrAncestorOfType() ?.members @@ -182,3 +231,78 @@ class $createdStateClassName extends $baseStateName<${widgetClass.name}> { }); } } + +// Original implemenation in +// package:analysis_server/lib/src/services/correction/dart/flutter_convert_to_stateful_widget.dart +class _FieldFinder extends RecursiveAstVisitor { + Set fieldsAssignedInConstructors = {}; + + @override + void visitFieldFormalParameter(FieldFormalParameter node) { + final element = node.declaredElement; + if (element is FieldFormalParameterElement) { + final field = element.field; + if (field != null) { + fieldsAssignedInConstructors.add(field); + } + } + + super.visitFieldFormalParameter(node); + } + + @override + void visitSimpleIdentifier(SimpleIdentifier node) { + if (node.parent is ConstructorFieldInitializer) { + final element = node.staticElement; + if (element is FieldElement) { + fieldsAssignedInConstructors.add(element); + } + } + if (node.inSetterContext()) { + final element = node.writeOrReadElement; + if (element is PropertyAccessorElement) { + final field = element.variable; + if (field is FieldElement) { + fieldsAssignedInConstructors.add(field); + } + } + } + } +} + +class _ReplacementEditBuilder extends RecursiveAstVisitor { + _ReplacementEditBuilder( + this.widgetClassElement, + this.elementsToMove, + this.builder, + ); + + final ClassElement widgetClassElement; + final Set elementsToMove; + final DartFileEditBuilder builder; + + @override + void visitSimpleIdentifier(SimpleIdentifier node) { + if (node.inDeclarationContext()) { + return; + } + final element = node.staticElement; + if (element is ExecutableElement && + element.enclosingElement == widgetClassElement && + !elementsToMove.contains(element)) { + final offset = node.offset; + final qualifier = + element.isStatic ? widgetClassElement.displayName : 'widget'; + + final parent = node.parent; + if (parent is InterpolationExpression && + parent.leftBracket.type == + TokenType.STRING_INTERPOLATION_IDENTIFIER) { + builder.addSimpleInsertion(offset, '{$qualifier.'); + builder.addSimpleInsertion(offset + node.length, '}'); + } else { + builder.addSimpleInsertion(offset, '$qualifier.'); + } + } + } +} diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart index 245f39a9a..2d70b9701 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart @@ -1,4 +1,7 @@ import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/ast/token.dart'; +import 'package:analyzer/dart/ast/visitor.dart'; +import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/source/source_range.dart'; // ignore: implementation_imports, blocked by https://github.com/dart-lang/sdk/issues/54480 import 'package:analyzer/src/generated/source.dart' show Source; @@ -145,87 +148,250 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist { .whereType() .firstWhereOrNull((element) => element.name.lexeme == 'createState'); if (createStateMethod != null) { - builder.addDeletion(createStateMethod.sourceRange); + builder.addDeletion(createStateMethod.sourceRange.getExpanded(1)); } // Search for the associated State class final stateClass = findStateClass(widgetClass); if (stateClass == null) return; + final fieldFinder = _FieldFinder(); + + for (final member in stateClass.members) { + if (member is ConstructorDeclaration) { + member.accept(fieldFinder); + } + } + + final fieldsAssignedInConstructors = + fieldFinder.fieldsAssignedInConstructors; + + // Prepare nodes to move. + final nodesToMove = []; + final elementsToMove = {}; + for (final member in stateClass.members) { + if (member is FieldDeclaration) { + if (member.isStatic) { + return; + } + for (final fieldNode in member.fields.variables) { + final fieldElement = fieldNode.declaredElement as FieldElement?; + if (fieldElement == null) continue; + if (!fieldsAssignedInConstructors.contains(fieldElement)) { + nodesToMove.add(member); + elementsToMove.add(fieldElement); + + final getter = fieldElement.getter; + if (getter != null) { + elementsToMove.add(getter); + } + + final setter = fieldElement.setter; + if (setter != null) { + elementsToMove.add(setter); + } + } + } + } else if (member is MethodDeclaration) { + if (member.isStatic) { + return; + } + if (!_isDefaultOverride(member)) { + nodesToMove.add(member); + elementsToMove.add(member.declaredElement!); + } + } + } + + final deleteRanges = []; + for (final node in nodesToMove) { + final visitor = _ReplacementEditBuilder( + widgetClass.declaredElement!, + elementsToMove, + ); + node.accept(visitor); + deleteRanges.addAll(visitor.deleteRanges); + } + // Move the build method to the widget class final buildMethod = stateClass.members .whereType() .firstWhereOrNull((element) => element.name.lexeme == 'build'); if (buildMethod == null) return; - final String? newBuildMethod; + final outsideRange = SourceRange( + widgetClass.sourceRange.end, + stateClass.sourceRange.offset - widgetClass.sourceRange.end, + ); + final outsideLines = source.contents.data.substring( + outsideRange.offset, + outsideRange.end, + ); + if (outsideLines.trim().isNotEmpty) { + builder.addSimpleInsertion( + stateClass.sourceRange.end, + '${outsideLines.trimRight()}\n', + ); + } + + // ignore: prefer_foreach + for (final range in deleteRanges) { + builder.addDeletion(range); + } + + builder.addDeletion( + SourceRange( + widgetClass.rightBracket.offset, + stateClass.leftBracket.end - widgetClass.rightBracket.offset, + ), + ); + + final parameterRange = _generateBuildMethodParameterRange(buildMethod); + if (parameterRange == SourceRange.EMPTY) { + return; + } switch (targetWidget) { case StatelessBaseWidgetType.consumerWidget: case StatelessBaseWidgetType.hookConsumerWidget: - newBuildMethod = _buildMethodWithRef(buildMethod, source); + builder.addSimpleReplacement( + parameterRange, + 'BuildContext context, WidgetRef ref', + ); case StatelessBaseWidgetType.hookWidget: case StatelessBaseWidgetType.statelessWidget: - newBuildMethod = _buildMethodWithoutRef(buildMethod, source); + builder.addSimpleReplacement( + parameterRange, + 'BuildContext context', + ); } - - if (newBuildMethod == null) return; - builder.addSimpleInsertion( - widgetClass.rightBracket.offset, - newBuildMethod, - ); - - // Delete the state class - builder.addDeletion(stateClass.sourceRange); }); } - String? _buildMethodWithRef(MethodDeclaration buildMethod, Source source) { - final parameters = buildMethod.parameters; - if (parameters == null) return null; + SourceRange _generateBuildMethodParameterRange( + MethodDeclaration buildMethod, + ) { + final offset = buildMethod.parameters?.leftParenthesis.end ?? 0; + final end = buildMethod.parameters?.rightParenthesis.offset ?? 0; + return SourceRange(offset, end - offset); + } +} + +// Original implemenation in +// package:analysis_server/lib/src/services/correction/dart/flutter_convert_to_stateless_widget.dart +class _FieldFinder extends RecursiveAstVisitor { + final fieldsAssignedInConstructors = {}; - if (parameters.parameters.length == 2) { - // The build method already has a ref parameter, nothing to change - return '${source.contents.data.substring(buildMethod.offset, buildMethod.end)}\n'; + @override + void visitSimpleIdentifier(SimpleIdentifier node) { + if (node.parent is FieldFormalParameter) { + final element = node.staticElement; + if (element is FieldFormalParameterElement) { + final field = element.field; + if (field != null) { + fieldsAssignedInConstructors.add(field); + } + } } - final buffer = StringBuffer(); - final refParamStartOffset = parameters.parameters.firstOrNull?.end ?? - parameters.leftParenthesis.offset + 1; - - buffer - ..write( - source.contents.data.substring(buildMethod.offset, refParamStartOffset), - ) - ..write(', WidgetRef ref') - ..writeln( - source.contents.data.substring(refParamStartOffset, buildMethod.end), - ); + if (node.parent is ConstructorFieldInitializer) { + final element = node.staticElement; + if (element is FieldElement) { + fieldsAssignedInConstructors.add(element); + } + } - return buffer.toString(); + if (node.inSetterContext()) { + final element = node.writeOrReadElement; + if (element is PropertyAccessorElement) { + final field = element.variable; + if (field is FieldElement) { + fieldsAssignedInConstructors.add(field); + } + } + } } +} + +class _ReplacementEditBuilder extends RecursiveAstVisitor { + _ReplacementEditBuilder( + this.widgetClassElement, + this.elementsToMove, + ); - String? _buildMethodWithoutRef(MethodDeclaration buildMethod, Source source) { - final parameters = buildMethod.parameters; - if (parameters == null) return null; + final ClassElement widgetClassElement; + final Set elementsToMove; - if (parameters.parameters.length == 1) { - // The build method already has not a ref parameter, nothing to change - return '${source.contents.data.substring(buildMethod.offset, buildMethod.end)}\n'; - } + List deleteRanges = []; - final buffer = StringBuffer(); - final contextEndOffset = parameters.parameters.firstOrNull?.end ?? - parameters.leftParenthesis.offset + 1; - final refParamStartOffset = parameters.parameters.last.offset; - - buffer - ..write( - source.contents.data.substring(buildMethod.offset, contextEndOffset), - ) - ..writeln( - source.contents.data.substring(refParamStartOffset, buildMethod.end), - ); + @override + void visitSimpleIdentifier(SimpleIdentifier node) { + if (node.inDeclarationContext()) { + return; + } + final element = node.staticElement; + if (element is ExecutableElement && + element.enclosingElement == widgetClassElement && + !elementsToMove.contains(element)) { + final parent = node.parent; + if (parent is PrefixedIdentifier) { + final grandParent = parent.parent; + + if (!node.name.contains(r'$') && + grandParent is InterpolationExpression && + grandParent.leftBracket.type == + TokenType.STRING_INTERPOLATION_EXPRESSION) { + final offset = grandParent.rightBracket?.offset; + + if (offset != null) { + deleteRanges.add(SourceRange(offset, 1)); + } + deleteRanges.add(SourceRange(grandParent.leftBracket.end - 1, 1)); + } + final offset = parent.prefix.offset; + final length = parent.period.end - offset; + deleteRanges.add(SourceRange(offset, length)); + } else if (parent is MethodInvocation) { + final target = parent.target; + final operator = parent.operator; + if (target != null && operator != null) { + final offset = target.offset; + final length = operator.end - offset; + deleteRanges.add(SourceRange(offset, length)); + } + } else if (parent is PropertyAccess) { + final target = parent.target; + final operator = parent.operator; + if (target != null) { + final offset = target.offset; + final length = operator.end - offset; + deleteRanges.add(SourceRange(offset, length)); + } + } + } + } +} - return buffer.toString(); +bool _isDefaultOverride(MethodDeclaration? methodDeclaration) { + final body = methodDeclaration?.body; + if (body != null) { + Expression expression; + if (body is BlockFunctionBody) { + final statements = body.block.statements; + if (statements.isEmpty) return true; + if (statements.length > 1) return false; + final first = statements.first; + if (first is! ExpressionStatement) return false; + expression = first.expression; + } else if (body is ExpressionFunctionBody) { + expression = body.expression; + } else { + return false; + } + if (expression is MethodInvocation && + expression.target is SuperExpression && + methodDeclaration!.name.lexeme == expression.methodName.name) { + return true; + } } + return false; } diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart b/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart index 5f53d52d8..11026c5fc 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart @@ -1,4 +1,5 @@ import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/element/element.dart'; import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; @@ -148,3 +149,32 @@ ClassDeclaration? findStateClass(ClassDeclaration widgetClass) { return checker.isExactlyType(stateWidgetType); }); } + +// Original implemenation in package:analyzer/lib/src/dart/ast/extensions.dart +extension IdentifierExtension on Identifier { + Element? get writeOrReadElement { + return _writeElement(this) ?? staticElement; + } +} + +Element? _writeElement(AstNode node) { + final parent = node.parent; + + if (parent is AssignmentExpression && parent.leftHandSide == node) { + return parent.writeElement; + } + if (parent is PostfixExpression && parent.operand == node) { + return parent.writeElement; + } + if (parent is PrefixExpression && parent.operand == node) { + return parent.writeElement; + } + + if (parent is PrefixedIdentifier && parent.identifier == node) { + return _writeElement(parent); + } + if (parent is PropertyAccess && parent.propertyName == node) { + return _writeElement(parent); + } + return null; +} diff --git a/packages/riverpod_lint/lib/src/lints/async_value_nullable_pattern.dart b/packages/riverpod_lint/lib/src/lints/async_value_nullable_pattern.dart index f3a64ca53..1d1dfbc51 100644 --- a/packages/riverpod_lint/lib/src/lints/async_value_nullable_pattern.dart +++ b/packages/riverpod_lint/lib/src/lints/async_value_nullable_pattern.dart @@ -53,7 +53,15 @@ class AsyncValueNullablePattern extends RiverpodLintRule { } grandParentType as InterfaceType; - final genericType = grandParentType.typeArguments.first; + var genericType = grandParentType.typeArguments.first; + + // If the AsyncValue's type is a generic type, we check the generic's constraint + if (genericType is TypeParameterType) { + final unit = node.thisOrAncestorOfType()!; + + genericType = genericType.element.bound ?? + unit.declaredElement!.library.typeProvider.dynamicType; + } if (genericType is! DynamicType && genericType.nullabilitySuffix != NullabilitySuffix.question) { diff --git a/packages/riverpod_lint_flutter_test/pubspec.yaml b/packages/riverpod_lint_flutter_test/pubspec.yaml index 23783399d..e3d37c6fb 100644 --- a/packages/riverpod_lint_flutter_test/pubspec.yaml +++ b/packages/riverpod_lint_flutter_test/pubspec.yaml @@ -16,6 +16,7 @@ dependencies: dev_dependencies: build_runner: ^2.4.6 custom_lint: ^0.6.0 + custom_lint_core: ^0.6.0 freezed: ^2.3.2 json_serializable: ^6.6.1 riverpod_lint: diff --git a/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml b/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml index 41a9f29fa..4f0b94b08 100644 --- a/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml +++ b/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml @@ -14,6 +14,6 @@ dependency_overrides: path: ../riverpod_annotation riverpod_lint: path: ../riverpod_lint - - # hotreloader stuff - vm_service: ^14.0.0 \ No newline at end of file + + # hotreloader is out of date + vm_service: ^14.0.0 diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff new file mode 100644 index 000000000..d32463fb6 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff @@ -0,0 +1,78 @@ +Message: `Convert to functional provider` +Priority: 100 +Diff for file `test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.dart:7`: +``` +/// Some comment +@riverpod +- class Example extends _$Example { +- @override +- int build() => 0; +- } ++ int example(ExampleRef ref) => 0; + +/// Some comment +``` +--- +Message: `Convert to functional provider` +Priority: 100 +Diff for file `test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.dart:7`: +``` +/// Some comment +@riverpod +- class Example extends _$Example { +- @override +- int build() => 0; +- } ++ int example(ExampleRef ref) => 0; + +/// Some comment +``` +--- +Message: `Convert to functional provider` +Priority: 100 +Diff for file `test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.dart:7`: +``` +/// Some comment +@riverpod +- class Example extends _$Example { +- @override +- int build() => 0; +- } ++ int example(ExampleRef ref) => 0; + +/// Some comment +``` +--- +Message: `Convert to functional provider` +Priority: 100 +Diff for file `test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.dart:14`: +``` +/// Some comment +@riverpod +- class ExampleFamily extends _$ExampleFamily { +- @override +- int build({required int a, String b = '42'}) { +- // Hello world +- return 0; +- } ++ int exampleFamily(ExampleFamilyRef ref, {required int a, String b = '42'}) { ++ // Hello world ++ return 0; ++ } + +@riverpod +``` +--- +Message: `Convert to functional provider` +Priority: 100 +Diff for file `test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.dart:23`: +``` + +@riverpod +- class Generic extends _$Generic { +- @override +- int build() => 0; +- } ++ int generic(GenericRef ref) => 0; +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.json b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.json deleted file mode 100644 index 437d0dda2..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":215,"length":2,"replacement":""},{"offset":208,"length":0,"replacement":"ExampleRef ref"},{"offset":202,"length":5,"replacement":"example"},{"offset":150,"length":48,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":215,"length":2,"replacement":""},{"offset":208,"length":0,"replacement":"ExampleRef ref"},{"offset":202,"length":5,"replacement":"example"},{"offset":150,"length":48,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":215,"length":2,"replacement":""},{"offset":208,"length":0,"replacement":"ExampleRef ref"},{"offset":202,"length":5,"replacement":"example"},{"offset":150,"length":48,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":389,"length":2,"replacement":""},{"offset":316,"length":0,"replacement":"ExampleFamilyRef ref, "},{"offset":310,"length":5,"replacement":"exampleFamily"},{"offset":246,"length":60,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to functional provider","edits":[{"fileStamp":0,"edits":[{"offset":494,"length":2,"replacement":""},{"offset":487,"length":0,"replacement":"GenericRef ref"},{"offset":486,"length":0,"replacement":""},{"offset":481,"length":5,"replacement":"generic"},{"offset":403,"length":74,"replacement":""}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart index 707b65113..97154ba21 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart @@ -1,24 +1,16 @@ -import 'dart:io'; - import 'package:riverpod_lint/src/assists/class_based_to_functional_provider.dart'; import 'package:analyzer/source/source_range.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import '../../golden.dart'; void main() { testGolden( 'Convert plain class provider to functional provider', - 'assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.json', - () async { - final assist = ClassBasedToFunctionalProvider(); - final file = File( + 'assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff', + sourcePath: 'test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.dart', - ).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; + (result) async { + final assist = ClassBasedToFunctionalProvider(); return [ ...await assist.testRun(result, const SourceRange(145, 0)), diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff new file mode 100644 index 000000000..47aeb2dbf --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff @@ -0,0 +1,33 @@ +Message: `Convert to class-based provider` +Priority: 100 +Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:7`: +``` +/// Some comment +@riverpod +- int example(ExampleRef ref) => 0; ++ class Example extends _$Example { ++ @override ++ int build() => 0; ++ } + +/// Some comment +``` +--- +Message: `Convert to class-based provider` +Priority: 100 +Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:11`: +``` +/// Some comment +@riverpod +- int exampleFamily(ExampleFamilyRef ref, {required int a, String b = '42'}) { +- // Hello world +- return 0; ++ class ExampleFamily extends _$ExampleFamily { ++ @override ++ int build({required int a, String b = '42'}) { ++ // Hello world ++ return 0; ++ } +} +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.json b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.json deleted file mode 100644 index 1d84c5034..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":100,"change":{"message":"Convert to class-based provider","edits":[{"fileStamp":0,"edits":[{"offset":183,"length":0,"replacement":"\n}"},{"offset":162,"length":14,"replacement":""},{"offset":154,"length":7,"replacement":"build"},{"offset":150,"length":0,"replacement":"class Example extends _$Example {\n @override\n "}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Convert to class-based provider","edits":[{"fileStamp":0,"edits":[{"offset":319,"length":0,"replacement":"\n}"},{"offset":230,"length":22,"replacement":""},{"offset":216,"length":13,"replacement":"build"},{"offset":212,"length":0,"replacement":"class ExampleFamily extends _$ExampleFamily {\n @override\n "}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart index ad29e9122..6f15d46df 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart @@ -1,24 +1,16 @@ -import 'dart:io'; - import 'package:riverpod_lint/src/assists/functional_to_class_based_provider.dart'; import 'package:analyzer/source/source_range.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import '../../golden.dart'; void main() { testGolden( 'Convert functional providers to class-based providers', - 'assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.json', - () async { - final assist = FunctionalToClassBasedProvider(); - final file = File( + 'assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff', + sourcePath: 'test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart', - ).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; + (result) async { + final assist = FunctionalToClassBasedProvider(); return [ ...await assist.testRun(result, const SourceRange(145, 0)), diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.diff new file mode 100644 index 000000000..08a54981b --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.diff @@ -0,0 +1,308 @@ +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:5`: +``` +import 'package:flutter_hooks/flutter_hooks.dart'; + +- class Stateless extends StatelessWidget { +- const Stateless({super.key}); +- +- @override ++ class Stateless extends ConsumerStatefulWidget { ++ const Stateless({super.key}); ++ ++ @override ++ ConsumerState createState() => _StatelessState(); ++ } ++ ++ class _StatelessState extends ConsumerState { +@override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:14`: +``` +} + +- class StatelessWithComma extends StatelessWidget { +- const StatelessWithComma({super.key}); +- +- @override ++ class StatelessWithComma extends ConsumerStatefulWidget { ++ const StatelessWithComma({super.key}); ++ ++ @override ++ ConsumerState createState() => _StatelessWithCommaState(); ++ } ++ ++ class _StatelessWithCommaState extends ConsumerState { +@override + Widget build( +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:25`: +``` +} + +- class Hook extends HookWidget { +- const Hook({super.key}); +- +- @override ++ class Hook extends ConsumerStatefulWidget { ++ const Hook({super.key}); ++ ++ @override ++ ConsumerState createState() => _HookState(); ++ } ++ ++ class _HookState extends ConsumerState { +@override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:34`: +``` +} + +- class HookConsumer extends HookConsumerWidget { +- const HookConsumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumer extends ConsumerStatefulWidget { ++ const HookConsumer({super.key}); ++ ++ @override ++ ConsumerState createState() => _HookConsumerState(); ++ } ++ ++ class _HookConsumerState extends ConsumerState { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 27 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:46`: +``` +} + +- class Stateful extends StatefulWidget { +- const Stateful({super.key}); +- +- @override +- State createState() => _StatefulState(); +- } +- +- class _StatefulState extends State { ++ class Stateful extends ConsumerStatefulWidget { ++ const Stateful({super.key}); ++ ++ @override ++ ConsumerState createState() => _StatefulState(); ++ } ++ ++ class _StatefulState extends ConsumerState { + /// Hello world + @override +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 27 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:62`: +``` +} + +- class ExplicitCreateState extends StatefulWidget { +- const ExplicitCreateState({super.key}); +- +- @override +- ExplicitCreateStateState createState() => ExplicitCreateStateState(); +- } +- +- class ExplicitCreateStateState extends State { ++ class ExplicitCreateState extends ConsumerStatefulWidget { ++ const ExplicitCreateState({super.key}); ++ ++ @override ++ ExplicitCreateStateState createState() => ExplicitCreateStateState(); ++ } ++ ++ class ExplicitCreateStateState extends ConsumerState { + @override + Widget build( +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:78`: +``` +} + +- class HookStateful extends StatefulHookWidget { +- const HookStateful({super.key}); +- +- @override +- State createState() => HookStatefulState(); +- } +- +- class HookStatefulState extends State { ++ class HookStateful extends ConsumerStatefulWidget { ++ const HookStateful({super.key}); ++ ++ @override ++ ConsumerState createState() => HookStatefulState(); ++ } ++ ++ class HookStatefulState extends ConsumerState { + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:106`: +``` +} + +- class HookConsumerStateful extends StatefulHookConsumerWidget { ++ class HookConsumerStateful extends ConsumerStatefulWidget { + const HookConsumerStateful({super.key}); + +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:121`: +``` +} + +- class Consumer extends ConsumerWidget { +- const Consumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class Consumer extends ConsumerStatefulWidget { ++ const Consumer({super.key}); ++ ++ @override ++ ConsumerState createState() => _ConsumerState(); ++ } ++ ++ class _ConsumerState extends ConsumerState { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:133`: +``` +} + +- class StatelessWithField extends StatelessWidget { +- const StatelessWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build(BuildContext context) { +- return Column( +- children: [ +- Text('$field'), +- Text('$staticField'), ++ class StatelessWithField extends ConsumerStatefulWidget { ++ const StatelessWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ ConsumerState createState() => _StatelessWithFieldState(); ++ } ++ ++ class _StatelessWithFieldState extends ConsumerState { ++ @override ++ Widget build(BuildContext context) { ++ return Column( ++ children: [ ++ Text('${widget.field}'), ++ Text('${StatelessWithField.staticField}'), + ], + ); +``` +--- +Message: `Convert to ConsumerStatefulWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:153`: +``` +} + +- class HookConsumerWithField extends HookConsumerWidget { +- const HookConsumerWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { +- return Column( +- children: [ +- Text('$field'), +- Text('$staticField'), ++ class HookConsumerWithField extends ConsumerStatefulWidget { ++ const HookConsumerWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ ConsumerState createState() => _HookConsumerWithFieldState(); ++ } ++ ++ class _HookConsumerWithFieldState extends ConsumerState { ++ @override ++ Widget build( ++ BuildContext context) { ++ return Column( ++ children: [ ++ Text('${widget.field}'), ++ Text('${HookConsumerWithField.staticField}'), + ], + ); +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.json deleted file mode 100644 index e019d34fb..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":31,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":221,"length":0,"replacement":"@override\n ConsumerState createState() => _StatelessState();\n}\n\nclass _StatelessState extends ConsumerState {\n"},{"offset":168,"length":15,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":404,"length":0,"replacement":"@override\n ConsumerState createState() => _StatelessWithCommaState();\n}\n\nclass _StatelessWithCommaState extends ConsumerState {\n"},{"offset":342,"length":15,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":563,"length":0,"replacement":"@override\n ConsumerState createState() => _HookState();\n}\n\nclass _HookState extends ConsumerState {\n"},{"offset":520,"length":10,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":787,"length":23,"replacement":""},{"offset":737,"length":0,"replacement":"@override\n ConsumerState createState() => _HookConsumerState();\n}\n\nclass _HookConsumerState extends ConsumerState {\n"},{"offset":678,"length":18,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":27,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":1022,"length":15,"replacement":"ConsumerState"},{"offset":939,"length":15,"replacement":"ConsumerState"},{"offset":876,"length":14,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":27,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":1389,"length":26,"replacement":"ConsumerState"},{"offset":1203,"length":14,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":1708,"length":19,"replacement":"ConsumerState"},{"offset":1615,"length":19,"replacement":"ConsumerState"},{"offset":1544,"length":18,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":2424,"length":35,"replacement":"ConsumerState"},{"offset":2291,"length":35,"replacement":"ConsumerState"},{"offset":2204,"length":26,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerStatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":2676,"length":23,"replacement":""},{"offset":2626,"length":0,"replacement":"@override\n ConsumerState createState() => _ConsumerState();\n}\n\nclass _ConsumerState extends ConsumerState {\n"},{"offset":2575,"length":14,"replacement":"ConsumerStatefulWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.diff new file mode 100644 index 000000000..ac6453b08 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.diff @@ -0,0 +1,330 @@ +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:5`: +``` +import 'package:flutter_hooks/flutter_hooks.dart'; + +- class Stateless extends StatelessWidget { +- const Stateless({super.key}); +- +- @override +- Widget build(BuildContext context) { ++ class Stateless extends ConsumerWidget { ++ const Stateless({super.key}); ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:14`: +``` +} + +- class StatelessWithComma extends StatelessWidget { +- const StatelessWithComma({super.key}); +- +- @override +- Widget build( +- BuildContext context, ++ class StatelessWithComma extends ConsumerWidget { ++ const StatelessWithComma({super.key}); ++ ++ @override ++ Widget build( ++ BuildContext context, WidgetRef ref, + ) { + return const Placeholder(); +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:25`: +``` +} + +- class Hook extends HookWidget { +- const Hook({super.key}); +- +- @override +- Widget build(BuildContext context) { ++ class Hook extends ConsumerWidget { ++ const Hook({super.key}); ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:34`: +``` +} + +- class HookConsumer extends HookConsumerWidget { ++ class HookConsumer extends ConsumerWidget { + const HookConsumer({super.key}); + +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:46`: +``` +} + +- class Stateful extends StatefulWidget { +- const Stateful({super.key}); +- +- @override +- State createState() => _StatefulState(); +- } +- +- class _StatefulState extends State { +- /// Hello world +- @override +- Widget build(BuildContext context) { ++ class Stateful extends ConsumerWidget { ++ const Stateful({super.key}); ++ ++ ++ /// Hello world ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + // Some comments + return const Placeholder(); +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 31 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:62`: +``` +} + +- class ExplicitCreateState extends StatefulWidget { +- const ExplicitCreateState({super.key}); +- +- @override +- ExplicitCreateStateState createState() => ExplicitCreateStateState(); +- } +- +- class ExplicitCreateStateState extends State { +- @override +- Widget build( +- BuildContext context, +- ) { ++ class ExplicitCreateState extends ConsumerWidget { ++ const ExplicitCreateState({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:78`: +``` +} + +- class HookStateful extends StatefulHookWidget { +- const HookStateful({super.key}); +- +- @override +- State createState() => HookStatefulState(); +- } +- +- class HookStatefulState extends State { +- @override +- Widget build(BuildContext context) { ++ class HookStateful extends ConsumerWidget { ++ const HookStateful({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:92`: +``` +} + +- class ConsumerStateful extends ConsumerStatefulWidget { +- const ConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => _ConsumerStatefulState(); +- } +- +- class _ConsumerStatefulState extends ConsumerState { +- @override +- Widget build(BuildContext context) { ++ class ConsumerStateful extends ConsumerWidget { ++ const ConsumerStateful({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:106`: +``` +} + +- class HookConsumerStateful extends StatefulHookConsumerWidget { +- const HookConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => +- _HookConsumerStatefulState(); +- } +- +- class _HookConsumerStatefulState extends ConsumerState { +- @override +- Widget build(BuildContext context) { ++ class HookConsumerStateful extends ConsumerWidget { ++ const HookConsumerStateful({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:133`: +``` +} + +- class StatelessWithField extends StatelessWidget { +- const StatelessWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build(BuildContext context) { ++ class StatelessWithField extends ConsumerWidget { ++ const StatelessWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return Column( + children: [ +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:153`: +``` +} + +- class HookConsumerWithField extends HookConsumerWidget { ++ class HookConsumerWithField extends ConsumerWidget { + const HookConsumerWithField({ + super.key, +``` +--- +Message: `Convert to ConsumerWidget` +Priority: 35 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:180`: +``` +} + +- class ConsumerStatefulWithField extends ConsumerStatefulWidget { +- const ConsumerStatefulWithField({ +- super.key, +- required this.field, +- required this.foo, +- }); +- +- final int field; +- final FooClass foo; +- static final int staticField = _constantNumber; +- +- @override +- ConsumerState createState() => +- _ConsumerStatefulWithFieldState(); +- } +- +- const _constantNumber = 42; +- +- class _ConsumerStatefulWithFieldState +- extends ConsumerState { +- void printFoo() { +- print(widget.foo); +- } +- +- @override +- Widget build(BuildContext context) { +- print(widget.field); +- printFoo(); +- return Column( +- children: [ +- Text('${widget.field}'), +- Text('${widget.foo.bar}'), +- Text('${ConsumerStatefulWithField.staticField}'), +- ], +- ); +- } +- } ++ class ConsumerStatefulWithField extends ConsumerWidget { ++ const ConsumerStatefulWithField({ ++ super.key, ++ required this.field, ++ required this.foo, ++ }); ++ ++ final int field; ++ final FooClass foo; ++ static final int staticField = _constantNumber; ++ ++ ++ void printFoo() { ++ print(foo); ++ } ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { ++ print(field); ++ printFoo(); ++ return Column( ++ children: [ ++ Text('$field'), ++ Text('${foo.bar}'), ++ Text('$staticField'), ++ ], ++ ); ++ } ++ } ++ ++ const _constantNumber = 42; + +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.json deleted file mode 100644 index 8e975d16f..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":35,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":266,"length":0,"replacement":", WidgetRef ref"},{"offset":168,"length":15,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":35,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":454,"length":0,"replacement":", WidgetRef ref"},{"offset":342,"length":15,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":35,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":608,"length":0,"replacement":", WidgetRef ref"},{"offset":520,"length":10,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":35,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":678,"length":18,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":993,"length":174,"replacement":""},{"offset":990,"length":0,"replacement":"/// Hello world\n @override\n Widget build(BuildContext context, WidgetRef ref) {\n // Some comments\n return const Placeholder();\n }\n"},{"offset":927,"length":62,"replacement":""},{"offset":876,"length":14,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":31,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":1350,"length":165,"replacement":""},{"offset":1347,"length":0,"replacement":"@override\n Widget build(\n BuildContext context, WidgetRef ref,\n ) {\n return const Placeholder();\n }\n"},{"offset":1265,"length":81,"replacement":""},{"offset":1203,"length":14,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":35,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":1676,"length":142,"replacement":""},{"offset":1673,"length":0,"replacement":"@override\n Widget build(BuildContext context, WidgetRef ref) {\n return const Placeholder();\n }\n"},{"offset":1603,"length":69,"replacement":""},{"offset":1544,"length":18,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":35,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":2008,"length":159,"replacement":""},{"offset":2005,"length":0,"replacement":"@override\n Widget build(BuildContext context, WidgetRef ref) {\n return const Placeholder();\n }\n"},{"offset":1918,"length":86,"replacement":""},{"offset":1851,"length":22,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":35,"change":{"message":"Convert to ConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":2383,"length":167,"replacement":""},{"offset":2380,"length":0,"replacement":"@override\n Widget build(BuildContext context, WidgetRef ref) {\n return const Placeholder();\n }\n"},{"offset":2279,"length":100,"replacement":""},{"offset":2204,"length":26,"replacement":"ConsumerWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.diff new file mode 100644 index 000000000..b694c875c --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.diff @@ -0,0 +1,318 @@ +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:5`: +``` +import 'package:flutter_hooks/flutter_hooks.dart'; + +- class Stateless extends StatelessWidget { +- const Stateless({super.key}); +- +- @override +- Widget build(BuildContext context) { ++ class Stateless extends HookConsumerWidget { ++ const Stateless({super.key}); ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:14`: +``` +} + +- class StatelessWithComma extends StatelessWidget { +- const StatelessWithComma({super.key}); +- +- @override +- Widget build( +- BuildContext context, ++ class StatelessWithComma extends HookConsumerWidget { ++ const StatelessWithComma({super.key}); ++ ++ @override ++ Widget build( ++ BuildContext context, WidgetRef ref, + ) { + return const Placeholder(); +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:25`: +``` +} + +- class Hook extends HookWidget { +- const Hook({super.key}); +- +- @override +- Widget build(BuildContext context) { ++ class Hook extends HookConsumerWidget { ++ const Hook({super.key}); ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:46`: +``` +} + +- class Stateful extends StatefulWidget { +- const Stateful({super.key}); +- +- @override +- State createState() => _StatefulState(); +- } +- +- class _StatefulState extends State { +- /// Hello world +- @override +- Widget build(BuildContext context) { ++ class Stateful extends HookConsumerWidget { ++ const Stateful({super.key}); ++ ++ ++ /// Hello world ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + // Some comments + return const Placeholder(); +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:62`: +``` +} + +- class ExplicitCreateState extends StatefulWidget { +- const ExplicitCreateState({super.key}); +- +- @override +- ExplicitCreateStateState createState() => ExplicitCreateStateState(); +- } +- +- class ExplicitCreateStateState extends State { +- @override +- Widget build( +- BuildContext context, +- ) { ++ class ExplicitCreateState extends HookConsumerWidget { ++ const ExplicitCreateState({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:78`: +``` +} + +- class HookStateful extends StatefulHookWidget { +- const HookStateful({super.key}); +- +- @override +- State createState() => HookStatefulState(); +- } +- +- class HookStatefulState extends State { +- @override +- Widget build(BuildContext context) { ++ class HookStateful extends HookConsumerWidget { ++ const HookStateful({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:92`: +``` +} + +- class ConsumerStateful extends ConsumerStatefulWidget { +- const ConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => _ConsumerStatefulState(); +- } +- +- class _ConsumerStatefulState extends ConsumerState { +- @override +- Widget build(BuildContext context) { ++ class ConsumerStateful extends HookConsumerWidget { ++ const ConsumerStateful({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:106`: +``` +} + +- class HookConsumerStateful extends StatefulHookConsumerWidget { +- const HookConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => +- _HookConsumerStatefulState(); +- } +- +- class _HookConsumerStatefulState extends ConsumerState { +- @override +- Widget build(BuildContext context) { ++ class HookConsumerStateful extends HookConsumerWidget { ++ const HookConsumerStateful({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:121`: +``` +} + +- class Consumer extends ConsumerWidget { ++ class Consumer extends HookConsumerWidget { + const Consumer({super.key}); + +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:133`: +``` +} + +- class StatelessWithField extends StatelessWidget { +- const StatelessWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build(BuildContext context) { ++ class StatelessWithField extends HookConsumerWidget { ++ const StatelessWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { + return Column( + children: [ +``` +--- +Message: `Convert to HookConsumerWidget` +Priority: 37 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:180`: +``` +} + +- class ConsumerStatefulWithField extends ConsumerStatefulWidget { +- const ConsumerStatefulWithField({ +- super.key, +- required this.field, +- required this.foo, +- }); +- +- final int field; +- final FooClass foo; +- static final int staticField = _constantNumber; +- +- @override +- ConsumerState createState() => +- _ConsumerStatefulWithFieldState(); +- } +- +- const _constantNumber = 42; +- +- class _ConsumerStatefulWithFieldState +- extends ConsumerState { +- void printFoo() { +- print(widget.foo); +- } +- +- @override +- Widget build(BuildContext context) { +- print(widget.field); +- printFoo(); +- return Column( +- children: [ +- Text('${widget.field}'), +- Text('${widget.foo.bar}'), +- Text('${ConsumerStatefulWithField.staticField}'), +- ], +- ); +- } +- } ++ class ConsumerStatefulWithField extends HookConsumerWidget { ++ const ConsumerStatefulWithField({ ++ super.key, ++ required this.field, ++ required this.foo, ++ }); ++ ++ final int field; ++ final FooClass foo; ++ static final int staticField = _constantNumber; ++ ++ ++ void printFoo() { ++ print(foo); ++ } ++ ++ @override ++ Widget build(BuildContext context, WidgetRef ref) { ++ print(field); ++ printFoo(); ++ return Column( ++ children: [ ++ Text('$field'), ++ Text('${foo.bar}'), ++ Text('$staticField'), ++ ], ++ ); ++ } ++ } ++ ++ const _constantNumber = 42; + +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.json deleted file mode 100644 index 449c635fc..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":37,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":266,"length":0,"replacement":", WidgetRef ref"},{"offset":168,"length":15,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":37,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":454,"length":0,"replacement":", WidgetRef ref"},{"offset":342,"length":15,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":37,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":608,"length":0,"replacement":", WidgetRef ref"},{"offset":520,"length":10,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":993,"length":174,"replacement":""},{"offset":990,"length":0,"replacement":"/// Hello world\n @override\n Widget build(BuildContext context, WidgetRef ref) {\n // Some comments\n return const Placeholder();\n }\n"},{"offset":927,"length":62,"replacement":""},{"offset":876,"length":14,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":1350,"length":165,"replacement":""},{"offset":1347,"length":0,"replacement":"@override\n Widget build(\n BuildContext context, WidgetRef ref,\n ) {\n return const Placeholder();\n }\n"},{"offset":1265,"length":81,"replacement":""},{"offset":1203,"length":14,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":37,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":1676,"length":142,"replacement":""},{"offset":1673,"length":0,"replacement":"@override\n Widget build(BuildContext context, WidgetRef ref) {\n return const Placeholder();\n }\n"},{"offset":1603,"length":69,"replacement":""},{"offset":1544,"length":18,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":37,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":2008,"length":159,"replacement":""},{"offset":2005,"length":0,"replacement":"@override\n Widget build(BuildContext context, WidgetRef ref) {\n return const Placeholder();\n }\n"},{"offset":1918,"length":86,"replacement":""},{"offset":1851,"length":22,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":37,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":2383,"length":167,"replacement":""},{"offset":2380,"length":0,"replacement":"@override\n Widget build(BuildContext context, WidgetRef ref) {\n return const Placeholder();\n }\n"},{"offset":2279,"length":100,"replacement":""},{"offset":2204,"length":26,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":37,"change":{"message":"Convert to HookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":2575,"length":14,"replacement":"HookConsumerWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.diff new file mode 100644 index 000000000..0d1a73ee1 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.diff @@ -0,0 +1,314 @@ +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:5`: +``` +import 'package:flutter_hooks/flutter_hooks.dart'; + +- class Stateless extends StatelessWidget { ++ class Stateless extends HookWidget { + const Stateless({super.key}); + +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:14`: +``` +} + +- class StatelessWithComma extends StatelessWidget { ++ class StatelessWithComma extends HookWidget { + const StatelessWithComma({super.key}); + +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:34`: +``` +} + +- class HookConsumer extends HookConsumerWidget { +- const HookConsumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumer extends HookWidget { ++ const HookConsumer({super.key}); ++ ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:46`: +``` +} + +- class Stateful extends StatefulWidget { +- const Stateful({super.key}); +- +- @override +- State createState() => _StatefulState(); +- } +- +- class _StatefulState extends State { ++ class Stateful extends HookWidget { ++ const Stateful({super.key}); ++ ++ + /// Hello world + @override +``` +--- +Message: `Convert to HookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:62`: +``` +} + +- class ExplicitCreateState extends StatefulWidget { +- const ExplicitCreateState({super.key}); +- +- @override +- ExplicitCreateStateState createState() => ExplicitCreateStateState(); +- } +- +- class ExplicitCreateStateState extends State { +- @override +- Widget build( +- BuildContext context, +- ) { ++ class ExplicitCreateState extends HookWidget { ++ const ExplicitCreateState({super.key}); ++ ++ ++ @override ++ Widget build(BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:78`: +``` +} + +- class HookStateful extends StatefulHookWidget { +- const HookStateful({super.key}); +- +- @override +- State createState() => HookStatefulState(); +- } +- +- class HookStatefulState extends State { ++ class HookStateful extends HookWidget { ++ const HookStateful({super.key}); ++ ++ + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:92`: +``` +} + +- class ConsumerStateful extends ConsumerStatefulWidget { +- const ConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => _ConsumerStatefulState(); +- } +- +- class _ConsumerStatefulState extends ConsumerState { ++ class ConsumerStateful extends HookWidget { ++ const ConsumerStateful({super.key}); ++ ++ + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:106`: +``` +} + +- class HookConsumerStateful extends StatefulHookConsumerWidget { +- const HookConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => +- _HookConsumerStatefulState(); +- } +- +- class _HookConsumerStatefulState extends ConsumerState { ++ class HookConsumerStateful extends HookWidget { ++ const HookConsumerStateful({super.key}); ++ ++ + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:121`: +``` +} + +- class Consumer extends ConsumerWidget { +- const Consumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class Consumer extends HookWidget { ++ const Consumer({super.key}); ++ ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:133`: +``` +} + +- class StatelessWithField extends StatelessWidget { ++ class StatelessWithField extends HookWidget { + const StatelessWithField({ + super.key, +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:153`: +``` +} + +- class HookConsumerWithField extends HookConsumerWidget { +- const HookConsumerWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumerWithField extends HookWidget { ++ const HookConsumerWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ Widget build( ++ BuildContext context) { + return Column( + children: [ +``` +--- +Message: `Convert to HookWidget` +Priority: 36 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:180`: +``` +} + +- class ConsumerStatefulWithField extends ConsumerStatefulWidget { +- const ConsumerStatefulWithField({ +- super.key, +- required this.field, +- required this.foo, +- }); +- +- final int field; +- final FooClass foo; +- static final int staticField = _constantNumber; +- +- @override +- ConsumerState createState() => +- _ConsumerStatefulWithFieldState(); +- } +- +- const _constantNumber = 42; +- +- class _ConsumerStatefulWithFieldState +- extends ConsumerState { +- void printFoo() { +- print(widget.foo); +- } +- +- @override +- Widget build(BuildContext context) { +- print(widget.field); +- printFoo(); +- return Column( +- children: [ +- Text('${widget.field}'), +- Text('${widget.foo.bar}'), +- Text('${ConsumerStatefulWithField.staticField}'), +- ], +- ); +- } +- } ++ class ConsumerStatefulWithField extends HookWidget { ++ const ConsumerStatefulWithField({ ++ super.key, ++ required this.field, ++ required this.foo, ++ }); ++ ++ final int field; ++ final FooClass foo; ++ static final int staticField = _constantNumber; ++ ++ ++ void printFoo() { ++ print(foo); ++ } ++ ++ @override ++ Widget build(BuildContext context) { ++ print(field); ++ printFoo(); ++ return Column( ++ children: [ ++ Text('$field'), ++ Text('${foo.bar}'), ++ Text('$staticField'), ++ ], ++ ); ++ } ++ } ++ ++ const _constantNumber = 42; + +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.json deleted file mode 100644 index 2698c3ded..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":36,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":168,"length":15,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":36,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":342,"length":15,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":36,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":787,"length":23,"replacement":""},{"offset":678,"length":18,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":993,"length":174,"replacement":""},{"offset":990,"length":0,"replacement":"/// Hello world\n @override\n Widget build(BuildContext context) {\n // Some comments\n return const Placeholder();\n }\n"},{"offset":927,"length":62,"replacement":""},{"offset":876,"length":14,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":1350,"length":165,"replacement":""},{"offset":1347,"length":0,"replacement":"@override\n Widget build(\n BuildContext context,\n ) {\n return const Placeholder();\n }\n"},{"offset":1265,"length":81,"replacement":""},{"offset":1203,"length":14,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":36,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":1676,"length":142,"replacement":""},{"offset":1673,"length":0,"replacement":"@override\n Widget build(BuildContext context) {\n return const Placeholder();\n }\n"},{"offset":1603,"length":69,"replacement":""},{"offset":1544,"length":18,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":36,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":2008,"length":159,"replacement":""},{"offset":2005,"length":0,"replacement":"@override\n Widget build(BuildContext context) {\n return const Placeholder();\n }\n"},{"offset":1918,"length":86,"replacement":""},{"offset":1851,"length":22,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":36,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":2383,"length":167,"replacement":""},{"offset":2380,"length":0,"replacement":"@override\n Widget build(BuildContext context) {\n return const Placeholder();\n }\n"},{"offset":2279,"length":100,"replacement":""},{"offset":2204,"length":26,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}},{"priority":36,"change":{"message":"Convert to HookWidget","edits":[{"fileStamp":0,"edits":[{"offset":2676,"length":23,"replacement":""},{"offset":2575,"length":14,"replacement":"HookWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.diff new file mode 100644 index 000000000..103fb34a1 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.diff @@ -0,0 +1,320 @@ +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:5`: +``` +import 'package:flutter_hooks/flutter_hooks.dart'; + +- class Stateless extends StatelessWidget { +- const Stateless({super.key}); +- +- @override ++ class Stateless extends StatefulHookConsumerWidget { ++ const Stateless({super.key}); ++ ++ @override ++ ConsumerState createState() => _StatelessState(); ++ } ++ ++ class _StatelessState extends ConsumerState { +@override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:14`: +``` +} + +- class StatelessWithComma extends StatelessWidget { +- const StatelessWithComma({super.key}); +- +- @override ++ class StatelessWithComma extends StatefulHookConsumerWidget { ++ const StatelessWithComma({super.key}); ++ ++ @override ++ ConsumerState createState() => _StatelessWithCommaState(); ++ } ++ ++ class _StatelessWithCommaState extends ConsumerState { +@override + Widget build( +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:25`: +``` +} + +- class Hook extends HookWidget { +- const Hook({super.key}); +- +- @override ++ class Hook extends StatefulHookConsumerWidget { ++ const Hook({super.key}); ++ ++ @override ++ ConsumerState createState() => _HookState(); ++ } ++ ++ class _HookState extends ConsumerState { +@override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:34`: +``` +} + +- class HookConsumer extends HookConsumerWidget { +- const HookConsumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumer extends StatefulHookConsumerWidget { ++ const HookConsumer({super.key}); ++ ++ @override ++ ConsumerState createState() => _HookConsumerState(); ++ } ++ ++ class _HookConsumerState extends ConsumerState { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 29 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:46`: +``` +} + +- class Stateful extends StatefulWidget { +- const Stateful({super.key}); +- +- @override +- State createState() => _StatefulState(); +- } +- +- class _StatefulState extends State { ++ class Stateful extends StatefulHookConsumerWidget { ++ const Stateful({super.key}); ++ ++ @override ++ ConsumerState createState() => _StatefulState(); ++ } ++ ++ class _StatefulState extends ConsumerState { + /// Hello world + @override +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 29 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:62`: +``` +} + +- class ExplicitCreateState extends StatefulWidget { +- const ExplicitCreateState({super.key}); +- +- @override +- ExplicitCreateStateState createState() => ExplicitCreateStateState(); +- } +- +- class ExplicitCreateStateState extends State { ++ class ExplicitCreateState extends StatefulHookConsumerWidget { ++ const ExplicitCreateState({super.key}); ++ ++ @override ++ ExplicitCreateStateState createState() => ExplicitCreateStateState(); ++ } ++ ++ class ExplicitCreateStateState extends ConsumerState { + @override + Widget build( +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:78`: +``` +} + +- class HookStateful extends StatefulHookWidget { +- const HookStateful({super.key}); +- +- @override +- State createState() => HookStatefulState(); +- } +- +- class HookStatefulState extends State { ++ class HookStateful extends StatefulHookConsumerWidget { ++ const HookStateful({super.key}); ++ ++ @override ++ ConsumerState createState() => HookStatefulState(); ++ } ++ ++ class HookStatefulState extends ConsumerState { + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:92`: +``` +} + +- class ConsumerStateful extends ConsumerStatefulWidget { ++ class ConsumerStateful extends StatefulHookConsumerWidget { + const ConsumerStateful({super.key}); + +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:121`: +``` +} + +- class Consumer extends ConsumerWidget { +- const Consumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class Consumer extends StatefulHookConsumerWidget { ++ const Consumer({super.key}); ++ ++ @override ++ ConsumerState createState() => _ConsumerState(); ++ } ++ ++ class _ConsumerState extends ConsumerState { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:133`: +``` +} + +- class StatelessWithField extends StatelessWidget { +- const StatelessWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build(BuildContext context) { +- return Column( +- children: [ +- Text('$field'), +- Text('$staticField'), ++ class StatelessWithField extends StatefulHookConsumerWidget { ++ const StatelessWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ ConsumerState createState() => _StatelessWithFieldState(); ++ } ++ ++ class _StatelessWithFieldState extends ConsumerState { ++ @override ++ Widget build(BuildContext context) { ++ return Column( ++ children: [ ++ Text('${widget.field}'), ++ Text('${StatelessWithField.staticField}'), + ], + ); +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:153`: +``` +} + +- class HookConsumerWithField extends HookConsumerWidget { +- const HookConsumerWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { +- return Column( +- children: [ +- Text('$field'), +- Text('$staticField'), ++ class HookConsumerWithField extends StatefulHookConsumerWidget { ++ const HookConsumerWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ ConsumerState createState() => _HookConsumerWithFieldState(); ++ } ++ ++ class _HookConsumerWithFieldState extends ConsumerState { ++ @override ++ Widget build( ++ BuildContext context) { ++ return Column( ++ children: [ ++ Text('${widget.field}'), ++ Text('${HookConsumerWithField.staticField}'), + ], + ); +``` +--- +Message: `Convert to StatefulHookConsumerWidget` +Priority: 33 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:180`: +``` +} + +- class ConsumerStatefulWithField extends ConsumerStatefulWidget { ++ class ConsumerStatefulWithField extends StatefulHookConsumerWidget { + const ConsumerStatefulWithField({ + super.key, +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.json deleted file mode 100644 index de88392fa..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":33,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":221,"length":0,"replacement":"@override\n ConsumerState createState() => _StatelessState();\n}\n\nclass _StatelessState extends ConsumerState {\n"},{"offset":168,"length":15,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":404,"length":0,"replacement":"@override\n ConsumerState createState() => _StatelessWithCommaState();\n}\n\nclass _StatelessWithCommaState extends ConsumerState {\n"},{"offset":342,"length":15,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":563,"length":0,"replacement":"@override\n ConsumerState createState() => _HookState();\n}\n\nclass _HookState extends ConsumerState {\n"},{"offset":520,"length":10,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":787,"length":23,"replacement":""},{"offset":737,"length":0,"replacement":"@override\n ConsumerState createState() => _HookConsumerState();\n}\n\nclass _HookConsumerState extends ConsumerState {\n"},{"offset":678,"length":18,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":29,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":1022,"length":15,"replacement":"ConsumerState"},{"offset":939,"length":15,"replacement":"ConsumerState"},{"offset":876,"length":14,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":29,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":1389,"length":26,"replacement":"ConsumerState"},{"offset":1203,"length":14,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":1708,"length":19,"replacement":"ConsumerState"},{"offset":1615,"length":19,"replacement":"ConsumerState"},{"offset":1544,"length":18,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":2045,"length":31,"replacement":"ConsumerState"},{"offset":1930,"length":31,"replacement":"ConsumerState"},{"offset":1851,"length":22,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}},{"priority":33,"change":{"message":"Convert to StatefulHookConsumerWidget","edits":[{"fileStamp":0,"edits":[{"offset":2676,"length":23,"replacement":""},{"offset":2626,"length":0,"replacement":"@override\n ConsumerState createState() => _ConsumerState();\n}\n\nclass _ConsumerState extends ConsumerState {\n"},{"offset":2575,"length":14,"replacement":"StatefulHookConsumerWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.diff new file mode 100644 index 000000000..b45a2a93b --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.diff @@ -0,0 +1,346 @@ +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:5`: +``` +import 'package:flutter_hooks/flutter_hooks.dart'; + +- class Stateless extends StatelessWidget { +- const Stateless({super.key}); +- +- @override ++ class Stateless extends StatefulHookWidget { ++ const Stateless({super.key}); ++ ++ @override ++ State createState() => _StatelessState(); ++ } ++ ++ class _StatelessState extends State { +@override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:14`: +``` +} + +- class StatelessWithComma extends StatelessWidget { +- const StatelessWithComma({super.key}); +- +- @override ++ class StatelessWithComma extends StatefulHookWidget { ++ const StatelessWithComma({super.key}); ++ ++ @override ++ State createState() => _StatelessWithCommaState(); ++ } ++ ++ class _StatelessWithCommaState extends State { +@override + Widget build( +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:25`: +``` +} + +- class Hook extends HookWidget { +- const Hook({super.key}); +- +- @override ++ class Hook extends StatefulHookWidget { ++ const Hook({super.key}); ++ ++ @override ++ State createState() => _HookState(); ++ } ++ ++ class _HookState extends State { +@override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:34`: +``` +} + +- class HookConsumer extends HookConsumerWidget { +- const HookConsumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumer extends StatefulHookWidget { ++ const HookConsumer({super.key}); ++ ++ @override ++ State createState() => _HookConsumerState(); ++ } ++ ++ class _HookConsumerState extends State { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 28 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:46`: +``` +} + +- class Stateful extends StatefulWidget { ++ class Stateful extends StatefulHookWidget { + const Stateful({super.key}); + +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 28 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:62`: +``` +} + +- class ExplicitCreateState extends StatefulWidget { ++ class ExplicitCreateState extends StatefulHookWidget { + const ExplicitCreateState({super.key}); + +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:92`: +``` +} + +- class ConsumerStateful extends ConsumerStatefulWidget { +- const ConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => _ConsumerStatefulState(); +- } +- +- class _ConsumerStatefulState extends ConsumerState { ++ class ConsumerStateful extends StatefulHookWidget { ++ const ConsumerStateful({super.key}); ++ ++ @override ++ State createState() => _ConsumerStatefulState(); ++ } ++ ++ class _ConsumerStatefulState extends State { + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:106`: +``` +} + +- class HookConsumerStateful extends StatefulHookConsumerWidget { +- const HookConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => +- _HookConsumerStatefulState(); +- } +- +- class _HookConsumerStatefulState extends ConsumerState { ++ class HookConsumerStateful extends StatefulHookWidget { ++ const HookConsumerStateful({super.key}); ++ ++ @override ++ State createState() => ++ _HookConsumerStatefulState(); ++ } ++ ++ class _HookConsumerStatefulState extends State { + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:121`: +``` +} + +- class Consumer extends ConsumerWidget { +- const Consumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class Consumer extends StatefulHookWidget { ++ const Consumer({super.key}); ++ ++ @override ++ State createState() => _ConsumerState(); ++ } ++ ++ class _ConsumerState extends State { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:133`: +``` +} + +- class StatelessWithField extends StatelessWidget { +- const StatelessWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build(BuildContext context) { +- return Column( +- children: [ +- Text('$field'), +- Text('$staticField'), ++ class StatelessWithField extends StatefulHookWidget { ++ const StatelessWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ State createState() => _StatelessWithFieldState(); ++ } ++ ++ class _StatelessWithFieldState extends State { ++ @override ++ Widget build(BuildContext context) { ++ return Column( ++ children: [ ++ Text('${widget.field}'), ++ Text('${StatelessWithField.staticField}'), + ], + ); +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:153`: +``` +} + +- class HookConsumerWithField extends HookConsumerWidget { +- const HookConsumerWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { +- return Column( +- children: [ +- Text('$field'), +- Text('$staticField'), ++ class HookConsumerWithField extends StatefulHookWidget { ++ const HookConsumerWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ State createState() => _HookConsumerWithFieldState(); ++ } ++ ++ class _HookConsumerWithFieldState extends State { ++ @override ++ Widget build( ++ BuildContext context) { ++ return Column( ++ children: [ ++ Text('${widget.field}'), ++ Text('${HookConsumerWithField.staticField}'), + ], + ); +``` +--- +Message: `Convert to StatefulHookWidget` +Priority: 32 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:180`: +``` +} + +- class ConsumerStatefulWithField extends ConsumerStatefulWidget { +- const ConsumerStatefulWithField({ +- super.key, +- required this.field, +- required this.foo, +- }); +- +- final int field; +- final FooClass foo; +- static final int staticField = _constantNumber; +- +- @override +- ConsumerState createState() => +- _ConsumerStatefulWithFieldState(); +- } +- +- const _constantNumber = 42; +- +- class _ConsumerStatefulWithFieldState +- extends ConsumerState { ++ class ConsumerStatefulWithField extends StatefulHookWidget { ++ const ConsumerStatefulWithField({ ++ super.key, ++ required this.field, ++ required this.foo, ++ }); ++ ++ final int field; ++ final FooClass foo; ++ static final int staticField = _constantNumber; ++ ++ @override ++ State createState() => ++ _ConsumerStatefulWithFieldState(); ++ } ++ ++ const _constantNumber = 42; ++ ++ class _ConsumerStatefulWithFieldState ++ extends State { + void printFoo() { + print(widget.foo); +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.json deleted file mode 100644 index 8190dcdbc..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":32,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":221,"length":0,"replacement":"@override\n State createState() => _StatelessState();\n}\n\nclass _StatelessState extends State {\n"},{"offset":168,"length":15,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":404,"length":0,"replacement":"@override\n State createState() => _StatelessWithCommaState();\n}\n\nclass _StatelessWithCommaState extends State {\n"},{"offset":342,"length":15,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":563,"length":0,"replacement":"@override\n State createState() => _HookState();\n}\n\nclass _HookState extends State {\n"},{"offset":520,"length":10,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":787,"length":23,"replacement":""},{"offset":737,"length":0,"replacement":"@override\n State createState() => _HookConsumerState();\n}\n\nclass _HookConsumerState extends State {\n"},{"offset":678,"length":18,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":28,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":1022,"length":15,"replacement":"State"},{"offset":939,"length":15,"replacement":"State"},{"offset":876,"length":14,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":28,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":1389,"length":26,"replacement":"State"},{"offset":1203,"length":14,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":2045,"length":31,"replacement":"State"},{"offset":1930,"length":31,"replacement":"State"},{"offset":1851,"length":22,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":2424,"length":35,"replacement":"State"},{"offset":2291,"length":35,"replacement":"State"},{"offset":2204,"length":26,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}},{"priority":32,"change":{"message":"Convert to StatefulHookWidget","edits":[{"fileStamp":0,"edits":[{"offset":2676,"length":23,"replacement":""},{"offset":2626,"length":0,"replacement":"@override\n State createState() => _ConsumerState();\n}\n\nclass _ConsumerState extends State {\n"},{"offset":2575,"length":14,"replacement":"StatefulHookWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.diff new file mode 100644 index 000000000..86ce03af7 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.diff @@ -0,0 +1,245 @@ +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:25`: +``` +} + +- class Hook extends HookWidget { +- const Hook({super.key}); +- +- @override ++ class Hook extends StatefulWidget { ++ const Hook({super.key}); ++ ++ @override ++ State createState() => _HookState(); ++ } ++ ++ class _HookState extends State { +@override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:34`: +``` +} + +- class HookConsumer extends HookConsumerWidget { +- const HookConsumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumer extends StatefulWidget { ++ const HookConsumer({super.key}); ++ ++ @override ++ State createState() => _HookConsumerState(); ++ } ++ ++ class _HookConsumerState extends State { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:78`: +``` +} + +- class HookStateful extends StatefulHookWidget { ++ class HookStateful extends StatefulWidget { + const HookStateful({super.key}); + +``` +--- +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:92`: +``` +} + +- class ConsumerStateful extends ConsumerStatefulWidget { +- const ConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => _ConsumerStatefulState(); +- } +- +- class _ConsumerStatefulState extends ConsumerState { ++ class ConsumerStateful extends StatefulWidget { ++ const ConsumerStateful({super.key}); ++ ++ @override ++ State createState() => _ConsumerStatefulState(); ++ } ++ ++ class _ConsumerStatefulState extends State { + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:106`: +``` +} + +- class HookConsumerStateful extends StatefulHookConsumerWidget { +- const HookConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => +- _HookConsumerStatefulState(); +- } +- +- class _HookConsumerStatefulState extends ConsumerState { ++ class HookConsumerStateful extends StatefulWidget { ++ const HookConsumerStateful({super.key}); ++ ++ @override ++ State createState() => ++ _HookConsumerStatefulState(); ++ } ++ ++ class _HookConsumerStatefulState extends State { + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:121`: +``` +} + +- class Consumer extends ConsumerWidget { +- const Consumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class Consumer extends StatefulWidget { ++ const Consumer({super.key}); ++ ++ @override ++ State createState() => _ConsumerState(); ++ } ++ ++ class _ConsumerState extends State { ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:153`: +``` +} + +- class HookConsumerWithField extends HookConsumerWidget { +- const HookConsumerWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { +- return Column( +- children: [ +- Text('$field'), +- Text('$staticField'), ++ class HookConsumerWithField extends StatefulWidget { ++ const HookConsumerWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ State createState() => _HookConsumerWithFieldState(); ++ } ++ ++ class _HookConsumerWithFieldState extends State { ++ @override ++ Widget build( ++ BuildContext context) { ++ return Column( ++ children: [ ++ Text('${widget.field}'), ++ Text('${HookConsumerWithField.staticField}'), + ], + ); +``` +--- +Message: `Convert to StatefulWidget` +Priority: 30 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:180`: +``` +} + +- class ConsumerStatefulWithField extends ConsumerStatefulWidget { +- const ConsumerStatefulWithField({ +- super.key, +- required this.field, +- required this.foo, +- }); +- +- final int field; +- final FooClass foo; +- static final int staticField = _constantNumber; +- +- @override +- ConsumerState createState() => +- _ConsumerStatefulWithFieldState(); +- } +- +- const _constantNumber = 42; +- +- class _ConsumerStatefulWithFieldState +- extends ConsumerState { ++ class ConsumerStatefulWithField extends StatefulWidget { ++ const ConsumerStatefulWithField({ ++ super.key, ++ required this.field, ++ required this.foo, ++ }); ++ ++ final int field; ++ final FooClass foo; ++ static final int staticField = _constantNumber; ++ ++ @override ++ State createState() => ++ _ConsumerStatefulWithFieldState(); ++ } ++ ++ const _constantNumber = 42; ++ ++ class _ConsumerStatefulWithFieldState ++ extends State { + void printFoo() { + print(widget.foo); +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.json deleted file mode 100644 index 1b18dc0fd..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":30,"change":{"message":"Convert to StatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":563,"length":0,"replacement":"@override\n State createState() => _HookState();\n}\n\nclass _HookState extends State {\n"},{"offset":520,"length":10,"replacement":"StatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":30,"change":{"message":"Convert to StatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":787,"length":23,"replacement":""},{"offset":737,"length":0,"replacement":"@override\n State createState() => _HookConsumerState();\n}\n\nclass _HookConsumerState extends State {\n"},{"offset":678,"length":18,"replacement":"StatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":30,"change":{"message":"Convert to StatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":1708,"length":19,"replacement":"State"},{"offset":1615,"length":19,"replacement":"State"},{"offset":1544,"length":18,"replacement":"StatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":30,"change":{"message":"Convert to StatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":2045,"length":31,"replacement":"State"},{"offset":1930,"length":31,"replacement":"State"},{"offset":1851,"length":22,"replacement":"StatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":30,"change":{"message":"Convert to StatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":2424,"length":35,"replacement":"State"},{"offset":2291,"length":35,"replacement":"State"},{"offset":2204,"length":26,"replacement":"StatefulWidget"}]}],"linkedEditGroups":[]}},{"priority":30,"change":{"message":"Convert to StatefulWidget","edits":[{"fileStamp":0,"edits":[{"offset":2676,"length":23,"replacement":""},{"offset":2626,"length":0,"replacement":"@override\n State createState() => _ConsumerState();\n}\n\nclass _ConsumerState extends State {\n"},{"offset":2575,"length":14,"replacement":"StatefulWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.diff new file mode 100644 index 000000000..fbf3ac38e --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.diff @@ -0,0 +1,240 @@ +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:25`: +``` +} + +- class Hook extends HookWidget { ++ class Hook extends StatelessWidget { + const Hook({super.key}); + +``` +--- +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:34`: +``` +} + +- class HookConsumer extends HookConsumerWidget { +- const HookConsumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumer extends StatelessWidget { ++ const HookConsumer({super.key}); ++ ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:78`: +``` +} + +- class HookStateful extends StatefulHookWidget { +- const HookStateful({super.key}); +- +- @override +- State createState() => HookStatefulState(); +- } +- +- class HookStatefulState extends State { ++ class HookStateful extends StatelessWidget { ++ const HookStateful({super.key}); ++ ++ + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:92`: +``` +} + +- class ConsumerStateful extends ConsumerStatefulWidget { +- const ConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => _ConsumerStatefulState(); +- } +- +- class _ConsumerStatefulState extends ConsumerState { ++ class ConsumerStateful extends StatelessWidget { ++ const ConsumerStateful({super.key}); ++ ++ + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:106`: +``` +} + +- class HookConsumerStateful extends StatefulHookConsumerWidget { +- const HookConsumerStateful({super.key}); +- +- @override +- ConsumerState createState() => +- _HookConsumerStatefulState(); +- } +- +- class _HookConsumerStatefulState extends ConsumerState { ++ class HookConsumerStateful extends StatelessWidget { ++ const HookConsumerStateful({super.key}); ++ ++ + @override + Widget build(BuildContext context) { +``` +--- +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:121`: +``` +} + +- class Consumer extends ConsumerWidget { +- const Consumer({super.key}); +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class Consumer extends StatelessWidget { ++ const Consumer({super.key}); ++ ++ @override ++ Widget build( ++ BuildContext context) { + return const Placeholder(); + } +``` +--- +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:153`: +``` +} + +- class HookConsumerWithField extends HookConsumerWidget { +- const HookConsumerWithField({ +- super.key, +- required this.field, +- }); +- +- final int field; +- static final int staticField = 42; +- +- @override +- Widget build( +- BuildContext context, +- WidgetRef ref, +- ) { ++ class HookConsumerWithField extends StatelessWidget { ++ const HookConsumerWithField({ ++ super.key, ++ required this.field, ++ }); ++ ++ final int field; ++ static final int staticField = 42; ++ ++ @override ++ Widget build( ++ BuildContext context) { + return Column( + children: [ +``` +--- +Message: `Convert to StatelessWidget` +Priority: 34 +Diff for file `test/assists/convert_to_widget/convert_to_widget.dart:180`: +``` +} + +- class ConsumerStatefulWithField extends ConsumerStatefulWidget { +- const ConsumerStatefulWithField({ +- super.key, +- required this.field, +- required this.foo, +- }); +- +- final int field; +- final FooClass foo; +- static final int staticField = _constantNumber; +- +- @override +- ConsumerState createState() => +- _ConsumerStatefulWithFieldState(); +- } +- +- const _constantNumber = 42; +- +- class _ConsumerStatefulWithFieldState +- extends ConsumerState { +- void printFoo() { +- print(widget.foo); +- } +- +- @override +- Widget build(BuildContext context) { +- print(widget.field); +- printFoo(); +- return Column( +- children: [ +- Text('${widget.field}'), +- Text('${widget.foo.bar}'), +- Text('${ConsumerStatefulWithField.staticField}'), +- ], +- ); +- } +- } ++ class ConsumerStatefulWithField extends StatelessWidget { ++ const ConsumerStatefulWithField({ ++ super.key, ++ required this.field, ++ required this.foo, ++ }); ++ ++ final int field; ++ final FooClass foo; ++ static final int staticField = _constantNumber; ++ ++ ++ void printFoo() { ++ print(foo); ++ } ++ ++ @override ++ Widget build(BuildContext context) { ++ print(field); ++ printFoo(); ++ return Column( ++ children: [ ++ Text('$field'), ++ Text('${foo.bar}'), ++ Text('$staticField'), ++ ], ++ ); ++ } ++ } ++ ++ const _constantNumber = 42; + +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.json b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.json deleted file mode 100644 index 71d0987a6..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":34,"change":{"message":"Convert to StatelessWidget","edits":[{"fileStamp":0,"edits":[{"offset":520,"length":10,"replacement":"StatelessWidget"}]}],"linkedEditGroups":[]}},{"priority":34,"change":{"message":"Convert to StatelessWidget","edits":[{"fileStamp":0,"edits":[{"offset":787,"length":23,"replacement":""},{"offset":678,"length":18,"replacement":"StatelessWidget"}]}],"linkedEditGroups":[]}},{"priority":34,"change":{"message":"Convert to StatelessWidget","edits":[{"fileStamp":0,"edits":[{"offset":1676,"length":142,"replacement":""},{"offset":1673,"length":0,"replacement":"@override\n Widget build(BuildContext context) {\n return const Placeholder();\n }\n"},{"offset":1603,"length":69,"replacement":""},{"offset":1544,"length":18,"replacement":"StatelessWidget"}]}],"linkedEditGroups":[]}},{"priority":34,"change":{"message":"Convert to StatelessWidget","edits":[{"fileStamp":0,"edits":[{"offset":2008,"length":159,"replacement":""},{"offset":2005,"length":0,"replacement":"@override\n Widget build(BuildContext context) {\n return const Placeholder();\n }\n"},{"offset":1918,"length":86,"replacement":""},{"offset":1851,"length":22,"replacement":"StatelessWidget"}]}],"linkedEditGroups":[]}},{"priority":34,"change":{"message":"Convert to StatelessWidget","edits":[{"fileStamp":0,"edits":[{"offset":2383,"length":167,"replacement":""},{"offset":2380,"length":0,"replacement":"@override\n Widget build(BuildContext context) {\n return const Placeholder();\n }\n"},{"offset":2279,"length":100,"replacement":""},{"offset":2204,"length":26,"replacement":"StatelessWidget"}]}],"linkedEditGroups":[]}},{"priority":34,"change":{"message":"Convert to StatelessWidget","edits":[{"fileStamp":0,"edits":[{"offset":2676,"length":23,"replacement":""},{"offset":2575,"length":14,"replacement":"StatelessWidget"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget.dart index 04120bfc3..35ffffa14 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget.dart @@ -129,3 +129,88 @@ class Consumer extends ConsumerWidget { return const Placeholder(); } } + +class StatelessWithField extends StatelessWidget { + const StatelessWithField({ + super.key, + required this.field, + }); + + final int field; + static final int staticField = 42; + + @override + Widget build(BuildContext context) { + return Column( + children: [ + Text('$field'), + Text('$staticField'), + ], + ); + } +} + +class HookConsumerWithField extends HookConsumerWidget { + const HookConsumerWithField({ + super.key, + required this.field, + }); + + final int field; + static final int staticField = 42; + + @override + Widget build( + BuildContext context, + WidgetRef ref, + ) { + return Column( + children: [ + Text('$field'), + Text('$staticField'), + ], + ); + } +} + +class FooClass { + final bar = 42; +} + +class ConsumerStatefulWithField extends ConsumerStatefulWidget { + const ConsumerStatefulWithField({ + super.key, + required this.field, + required this.foo, + }); + + final int field; + final FooClass foo; + static final int staticField = _constantNumber; + + @override + ConsumerState createState() => + _ConsumerStatefulWithFieldState(); +} + +const _constantNumber = 42; + +class _ConsumerStatefulWithFieldState + extends ConsumerState { + void printFoo() { + print(widget.foo); + } + + @override + Widget build(BuildContext context) { + print(widget.field); + printFoo(); + return Column( + children: [ + Text('${widget.field}'), + Text('${widget.foo.bar}'), + Text('${ConsumerStatefulWithField.staticField}'), + ], + ); + } +} diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart index b3b2eb9a8..664c6e71e 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart @@ -1,7 +1,3 @@ -import 'dart:io'; - -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import 'package:analyzer/source/source_range.dart'; import 'package:pubspec_parse/pubspec_parse.dart'; import 'package:riverpod_lint/src/assists/convert_to_stateful_base_widget.dart'; @@ -23,28 +19,54 @@ void main() { StatelessBaseWidgetType.values.forEach( (targetWidget) { + final int expectedChangeCount; + switch (targetWidget) { + case StatelessBaseWidgetType.hookConsumerWidget: + expectedChangeCount = 11; + break; + case StatelessBaseWidgetType.hookWidget: + case StatelessBaseWidgetType.consumerWidget: + expectedChangeCount = 12; + break; + case StatelessBaseWidgetType.statelessWidget: + expectedChangeCount = 8; + break; + } _runGoldenTest( ConvertToStatelessBaseWidget( targetWidget: targetWidget, ), 'Convert widgets to ${targetWidget.name}s with hooks_riverpod and flutter_hooks dependency', - 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.json', + 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff', pubspecWithDependencies, - targetWidget == StatelessBaseWidgetType.statelessWidget ? 6 : 9, + expectedChangeCount, ); }, ); StatefulBaseWidgetType.values.forEach( (targetWidget) { + final int expectedChangeCount; + switch (targetWidget) { + case StatefulBaseWidgetType.statefulHookConsumerWidget: + case StatefulBaseWidgetType.statefulHookWidget: + expectedChangeCount = 12; + break; + case StatefulBaseWidgetType.consumerStatefulWidget: + expectedChangeCount = 11; + break; + case StatefulBaseWidgetType.statefulWidget: + expectedChangeCount = 8; + break; + } _runGoldenTest( ConvertToStatefulBaseWidget( targetWidget: targetWidget, ), 'Convert widgets to ${targetWidget.name}s with hooks_riverpod and flutter_hooks dependency', - 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.json', + 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff', pubspecWithDependencies, - targetWidget == StatefulBaseWidgetType.statefulWidget ? 6 : 9, + expectedChangeCount, ); }, ); @@ -58,26 +80,26 @@ void main() { final int expectedChangeCount; switch (targetWidget) { case StatelessBaseWidgetType.consumerWidget: - expectedChangeCount = 9; + expectedChangeCount = 12; break; case StatelessBaseWidgetType.hookWidget: case StatelessBaseWidgetType.hookConsumerWidget: expectedChangeCount = 0; break; case StatelessBaseWidgetType.statelessWidget: - expectedChangeCount = 6; + expectedChangeCount = 8; break; } final String goldenFilePath; switch (targetWidget) { case StatelessBaseWidgetType.hookWidget: case StatelessBaseWidgetType.hookConsumerWidget: - goldenFilePath = 'assists/empty.json'; + goldenFilePath = 'assists/empty.diff'; break; case StatelessBaseWidgetType.consumerWidget: case StatelessBaseWidgetType.statelessWidget: goldenFilePath = - 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.json'; + 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff'; break; } @@ -98,26 +120,26 @@ void main() { final int expectedChangeCount; switch (targetWidget) { case StatefulBaseWidgetType.consumerStatefulWidget: - expectedChangeCount = 9; + expectedChangeCount = 11; break; case StatefulBaseWidgetType.statefulHookWidget: case StatefulBaseWidgetType.statefulHookConsumerWidget: expectedChangeCount = 0; break; case StatefulBaseWidgetType.statefulWidget: - expectedChangeCount = 6; + expectedChangeCount = 8; break; } final String goldenFilePath; switch (targetWidget) { case StatefulBaseWidgetType.statefulHookWidget: case StatefulBaseWidgetType.statefulHookConsumerWidget: - goldenFilePath = 'assists/empty.json'; + goldenFilePath = 'assists/empty.diff'; break; case StatefulBaseWidgetType.consumerStatefulWidget: case StatefulBaseWidgetType.statefulWidget: goldenFilePath = - 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.json'; + 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff'; break; } @@ -153,14 +175,8 @@ void _runGoldenTest( testGolden( description, goldenFilePath, - () async { - final file = File( - 'test/assists/convert_to_widget/convert_to_widget.dart', - ).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; - + sourcePath: 'test/assists/convert_to_widget/convert_to_widget.dart', + (result) async { final changes = [ // Stateless ...await assist.testRun(result, const SourceRange(163, 0), @@ -205,6 +221,18 @@ void _runGoldenTest( // ConsumerWidget ...await assist.testRun(result, const SourceRange(2582, 0), pubspec: pubspec), + + // StatelessWithField + ...await assist.testRun(result, const SourceRange(2784, 0), + pubspec: pubspec), + + // HookConsumerWithField + ...await assist.testRun(result, const SourceRange(3139, 0), + pubspec: pubspec), + + // ConsumerStatefulWithField + ...await assist.testRun(result, const SourceRange(3571, 0), + pubspec: pubspec), ]; expect(changes, hasLength(expectedChangeCount)); diff --git a/packages/riverpod_lint_flutter_test/test/assists/empty.diff b/packages/riverpod_lint_flutter_test/test/assists/empty.diff new file mode 100644 index 000000000..e69de29bb diff --git a/packages/riverpod_lint_flutter_test/test/assists/empty.json b/packages/riverpod_lint_flutter_test/test/assists/empty.json deleted file mode 100644 index 0637a088a..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/empty.json +++ /dev/null @@ -1 +0,0 @@ -[] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart index b1d9a00c4..e45b6cc7b 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart @@ -1,24 +1,17 @@ -import 'dart:io'; - import 'package:test/test.dart'; import 'package:riverpod_lint/src/assists/wrap_with_consumer.dart'; import 'package:riverpod_lint/src/assists/wrap_with_provider_scope.dart'; import 'package:analyzer/source/source_range.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import '../../golden.dart'; void main() { testGolden( 'Wrap with consumer', - 'assists/wrap_widget/wrap_with_consumer.json', - () async { + 'assists/wrap_widget/wrap_with_consumer.diff', + sourcePath: 'test/assists/wrap_widget/wrap_widget.dart', + (result) async { final assist = WrapWithConsumer(); - final file = File('test/assists/wrap_widget/wrap_widget.dart').absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; var changes = [ // Map @@ -42,13 +35,10 @@ void main() { testGolden( 'Wrap with ProviderScope', - 'assists/wrap_widget/wrap_with_provider_scope.json', - () async { + 'assists/wrap_widget/wrap_with_provider_scope.diff', + sourcePath: 'test/assists/wrap_widget/wrap_widget.dart', + (result) async { final assist = WrapWithProviderScope(); - final file = File('test/assists/wrap_widget/wrap_widget.dart').absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; final changes = [ // Map diff --git a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.diff b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.diff new file mode 100644 index 000000000..acf024446 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.diff @@ -0,0 +1,28 @@ +Message: `Wrap with Consumer` +Priority: 28 +Diff for file `test/assists/wrap_widget/wrap_widget.dart:11`: +``` + Map(); + +- return Scaffold( +- body: Container(), +- ); ++ return Consumer(builder: (context, ref, child) { return Scaffold( ++ body: Container(), ++ ); },); + } +} +``` +--- +Message: `Wrap with Consumer` +Priority: 28 +Diff for file `test/assists/wrap_widget/wrap_widget.dart:12`: +``` + + return Scaffold( +- body: Container(), ++ body: Consumer(builder: (context, ref, child) { return Container(); },), + ); + } +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.json b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.json deleted file mode 100644 index 7fdca8789..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":28,"change":{"message":"Wrap with Consumer","edits":[{"fileStamp":0,"edits":[{"offset":281,"length":0,"replacement":"; },)"},{"offset":241,"length":0,"replacement":"Consumer(builder: (context, ref, child) { return "}]}],"linkedEditGroups":[]}},{"priority":28,"change":{"message":"Wrap with Consumer","edits":[{"fileStamp":0,"edits":[{"offset":274,"length":0,"replacement":"; },)"},{"offset":263,"length":0,"replacement":"Consumer(builder: (context, ref, child) { return "}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.diff b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.diff new file mode 100644 index 000000000..96714d099 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.diff @@ -0,0 +1,28 @@ +Message: `Wrap with ProviderScope` +Priority: 27 +Diff for file `test/assists/wrap_widget/wrap_widget.dart:11`: +``` + Map(); + +- return Scaffold( +- body: Container(), +- ); ++ return ProviderScope(child: Scaffold( ++ body: Container(), ++ ),); + } +} +``` +--- +Message: `Wrap with ProviderScope` +Priority: 27 +Diff for file `test/assists/wrap_widget/wrap_widget.dart:12`: +``` + + return Scaffold( +- body: Container(), ++ body: ProviderScope(child: Container(),), + ); + } +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.json b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.json deleted file mode 100644 index 6170c06a6..000000000 --- a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":27,"change":{"message":"Wrap with ProviderScope","edits":[{"fileStamp":0,"edits":[{"offset":281,"length":0,"replacement":",)"},{"offset":241,"length":0,"replacement":"ProviderScope(child: "}]}],"linkedEditGroups":[]}},{"priority":27,"change":{"message":"Wrap with ProviderScope","edits":[{"fileStamp":0,"edits":[{"offset":274,"length":0,"replacement":",)"},{"offset":263,"length":0,"replacement":"ProviderScope(child: "}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/golden.dart b/packages/riverpod_lint_flutter_test/test/golden.dart index 94d5fe242..8bce6e76d 100644 --- a/packages/riverpod_lint_flutter_test/test/golden.dart +++ b/packages/riverpod_lint_flutter_test/test/golden.dart @@ -1,4 +1,3 @@ -import 'dart:convert'; import 'dart:io'; import 'package:freezed_annotation/freezed_annotation.dart'; @@ -6,6 +5,8 @@ import 'package:test/test.dart'; import 'package:path/path.dart'; import 'package:custom_lint_core/custom_lint_core.dart'; import 'package:analyzer_plugin/protocol/protocol_generated.dart'; +import 'package:analyzer/dart/analysis/results.dart'; +import 'package:analyzer/dart/analysis/utilities.dart'; @Deprecated('Do not commit') var goldenWrite = false; @@ -25,35 +26,43 @@ File writeToTemporaryFile(String content) { void testGolden( String description, String fileName, - Future> Function() body, -) { + Future> Function(ResolvedUnitResult unit) + body, { + required String sourcePath, +}) { test(description, () async { - final changes = await body().then((value) => value.toList()); + final file = File(sourcePath).absolute; + + final result = await resolveFile2(path: file.path); + result as ResolvedUnitResult; + + final changes = await body(result).then((value) => value.toList()); + final source = file.readAsStringSync(); try { expect( changes, - matcherNormalizedPrioritizedSourceChangeSnapshot(fileName), + matcherNormalizedPrioritizedSourceChangeSnapshot( + fileName, + sources: {'**': source}, + relativePath: Directory.current.path, + ), ); } on TestFailure { // ignore: deprecated_member_use_from_same_package, deprecated only to avoid commit if (!goldenWrite) rethrow; - final file = File('test/$fileName'); - - final changesJson = changes.map((e) => e.toJson()).toList(); - // Remove all "file" references from the json. - for (final change in changesJson) { - final changeMap = change['change']! as Map; - final edits = changeMap['edits']! as List; - for (final edit in edits.cast>()) { - edit.remove('file'); - } - } + final source = File(sourcePath).readAsStringSync(); + final result = encodePrioritizedSourceChanges( + changes, + sources: {'**': source}, + relativePath: Directory.current.path, + ); - file + final golden = File('test/$fileName'); + golden ..createSync(recursive: true) - ..writeAsStringSync(jsonEncode(changesJson)); + ..writeAsStringSync(result); return; } }); diff --git a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/async_value_nullable_pattern.dart b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/async_value_nullable_pattern.dart index 875b15fbe..5980e8489 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/async_value_nullable_pattern.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/async_value_nullable_pattern.dart @@ -55,3 +55,26 @@ void main() { print(value); } } + +void fn(T obj) { + switch (obj) { + // expect_lint: async_value_nullable_pattern + case AsyncValue(:final value?): + print(value); + } +} + +void fn2(T obj) { + switch (obj) { + case AsyncValue(:final value?): + print(value); + } +} + +void fn3(T obj) { + switch (obj) { + // expect_lint: async_value_nullable_pattern + case AsyncValue(:final value?): + print(value); + } +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff new file mode 100644 index 000000000..77c08f60a --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff @@ -0,0 +1,24 @@ +Message: `Use "hasValue: true" instead` +Priority: 100 +Diff for file `test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart:8`: +``` + case AsyncValue( + // expect_lint: async_value_nullable_pattern +- :final value?, ++ :final value, hasValue: true, + ): + print(value); +``` +--- +Message: `Use "hasValue: true" instead` +Priority: 100 +Diff for file `test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart:17`: +``` + case AsyncValue( + // expect_lint: async_value_nullable_pattern +- :final value? ++ :final value, hasValue: true + ): + print(value); +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.json b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.json deleted file mode 100644 index 93bdc91dd..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":100,"change":{"message":"Use \"hasValue: true\" instead","edits":[{"fileStamp":0,"edits":[{"offset":257,"length":0,"replacement":", hasValue: true"},{"offset":256,"length":1,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Use \"hasValue: true\" instead","edits":[{"fileStamp":0,"edits":[{"offset":472,"length":0,"replacement":", hasValue: true"},{"offset":471,"length":1,"replacement":""}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern_test.dart b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern_test.dart index 3883c5e86..04739c72a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern_test.dart @@ -1,25 +1,17 @@ -import 'dart:io'; - import 'package:collection/collection.dart'; import 'package:riverpod_lint/src/lints/async_value_nullable_pattern.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import '../../../golden.dart'; void main() { testGolden( 'Verify that @riverpod classes has the build method', - 'lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.json', - () async { + 'lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff', + sourcePath: + 'test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart', + (result) async { const lint = AsyncValueNullablePattern(); final fix = lint.getFixes().single; - final file = File( - 'test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart', - ).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; final errors = await lint.testRun(result); diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.diff b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.diff new file mode 100644 index 000000000..f45973703 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.diff @@ -0,0 +1,46 @@ +Message: `Type as NamelessRef` +Priority: 90 +Diff for file `test/lints/functional_ref/functional_ref.dart:8`: +``` +int nameless( + // expect_lint: functional_ref +- ref, ++ NamelessRef ref, +) { + return 0; +``` +--- +Message: `Type as NoGenericsRef` +Priority: 90 +Diff for file `test/lints/functional_ref/functional_ref.dart:21`: +``` +@riverpod +// expect_lint: functional_ref +- int noGenerics(NoGenericsRef ref) => 0; ++ int noGenerics(NoGenericsRef ref) => 0; + +@riverpod +``` +--- +Message: `Type as MissingGenericsRef` +Priority: 90 +Diff for file `test/lints/functional_ref/functional_ref.dart:25`: +``` +@riverpod +// expect_lint: functional_ref +- int missingGenerics(MissingGenericsRef ref) => 0; ++ int missingGenerics(MissingGenericsRef ref) => 0; + +@riverpod +``` +--- +Message: `Type as WrongOrderRef` +Priority: 90 +Diff for file `test/lints/functional_ref/functional_ref.dart:29`: +``` +@riverpod +// expect_lint: functional_ref +- int wrongOrder(WrongOrderRef ref) => 0; ++ int wrongOrder(WrongOrderRef ref) => 0; +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.json b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.json deleted file mode 100644 index 4def516b2..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":90,"change":{"message":"Type as NamelessRef","edits":[{"fileStamp":0,"edits":[{"offset":154,"length":0,"replacement":"NamelessRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as NoGenericsRef","edits":[{"fileStamp":0,"edits":[{"offset":357,"length":14,"replacement":"NoGenericsRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as MissingGenericsRef","edits":[{"fileStamp":0,"edits":[{"offset":450,"length":19,"replacement":"MissingGenericsRef "}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Type as WrongOrderRef","edits":[{"fileStamp":0,"edits":[{"offset":543,"length":14,"replacement":"WrongOrderRef "}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart index ecfaac102..ba343372d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart @@ -1,10 +1,6 @@ -import 'dart:io'; - import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:collection/collection.dart'; import 'package:riverpod_lint/src/lints/functional_ref.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import 'package:test/test.dart'; import '../../golden.dart'; @@ -12,15 +8,11 @@ import '../../golden.dart'; void main() { testGolden( 'Verify that @riverpod classes extend the generated typedef', - 'lints/functional_ref/functional_ref.json', - () async { + 'lints/functional_ref/functional_ref.diff', + sourcePath: 'test/lints/functional_ref/functional_ref.dart', + (result) async { final lint = FunctionalRef(); final fix = lint.getFixes().single as DartFix; - final file = - File('test/lints/functional_ref/functional_ref.dart').absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; final errors = await lint.testRun(result); expect(errors, hasLength(4)); diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.diff b/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.diff new file mode 100644 index 000000000..6e6005b7a --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.diff @@ -0,0 +1,16 @@ +Message: `Add build method` +Priority: 80 +Diff for file `test/lints/notifier_build/fix/notifier_build.dart:8`: +``` +@riverpod +// expect_lint: notifier_build +- class ExampleProvider1 extends _$ExampleProvider1 {} ++ class ExampleProvider1 extends _$ExampleProvider1 { ++ @override ++ dynamic build() { ++ // TODO: implement build ++ throw UnimplementedError(); ++ } ++ } +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.json b/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.json deleted file mode 100644 index 978f6cc17..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":80,"change":{"message":"Add build method","edits":[{"fileStamp":0,"edits":[{"offset":212,"length":0,"replacement":"\n @override\n dynamic build() {\n // TODO: implement build\n throw UnimplementedError();\n }\n"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build_test.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build_test.dart index 40bf330c7..c0ddf8731 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build_test.dart @@ -1,25 +1,16 @@ -import 'dart:io'; - import 'package:collection/collection.dart'; import 'package:riverpod_lint/src/lints/notifier_build.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import '../../../golden.dart'; void main() { testGolden( 'Verify that @riverpod classes has the build method', - 'lints/notifier_build/fix/notifier_build.json', - () async { + 'lints/notifier_build/fix/notifier_build.diff', + sourcePath: 'test/lints/notifier_build/fix/notifier_build.dart', + (result) async { const lint = NotifierBuild(); final fix = lint.getFixes().single; - final file = File( - 'test/lints/notifier_build/fix/notifier_build.dart', - ).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; final errors = await lint.testRun(result); diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.diff b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.diff new file mode 100644 index 000000000..57bc1d9a7 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.diff @@ -0,0 +1,60 @@ +Message: `Extend _$NoExtends` +Priority: 90 +Diff for file `test/lints/notifier_extends/notifier_extends.dart:15`: +``` +@riverpod +// expect_lint: notifier_extends +- class NoExtends { ++ class NoExtends extends _$NoExtends { + int build() => 0; +} +``` +--- +Message: `Extend _$WrongExtends` +Priority: 90 +Diff for file `test/lints/notifier_extends/notifier_extends.dart:21`: +``` +@riverpod +// expect_lint: notifier_extends +- class WrongExtends extends AsyncNotifier { ++ class WrongExtends extends _$WrongExtends { + int build() => 0; +} +``` +--- +Message: `Extend _$NoGenerics` +Priority: 90 +Diff for file `test/lints/notifier_extends/notifier_extends.dart:39`: +``` +@riverpod +// expect_lint: notifier_extends +- class NoGenerics extends _$NoGenerics { ++ class NoGenerics extends _$NoGenerics { + int build() => 0; +} +``` +--- +Message: `Extend _$MissingGenerics` +Priority: 90 +Diff for file `test/lints/notifier_extends/notifier_extends.dart:45`: +``` +@riverpod +// expect_lint: notifier_extends +- class MissingGenerics extends _$MissingGenerics { ++ class MissingGenerics extends _$MissingGenerics { + int build() => 0; +} +``` +--- +Message: `Extend _$WrongOrder` +Priority: 90 +Diff for file `test/lints/notifier_extends/notifier_extends.dart:51`: +``` +@riverpod +// expect_lint: notifier_extends +- class WrongOrder extends _$WrongOrder { ++ class WrongOrder extends _$WrongOrder { + int build() => 0; +} +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.json b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.json deleted file mode 100644 index e76303fd3..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":90,"change":{"message":"Extend _$NoExtends","edits":[{"fileStamp":0,"edits":[{"offset":280,"length":0,"replacement":" extends _$NoExtends"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$WrongExtends","edits":[{"fileStamp":0,"edits":[{"offset":376,"length":18,"replacement":"_$WrongExtends"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$NoGenerics","edits":[{"fileStamp":0,"edits":[{"offset":780,"length":12,"replacement":"_$NoGenerics"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$MissingGenerics","edits":[{"fileStamp":0,"edits":[{"offset":897,"length":20,"replacement":"_$MissingGenerics"}]}],"linkedEditGroups":[]}},{"priority":90,"change":{"message":"Extend _$WrongOrder","edits":[{"fileStamp":0,"edits":[{"offset":1017,"length":18,"replacement":"_$WrongOrder"}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart index 41e55a5ce..aa435bd7f 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart @@ -1,10 +1,6 @@ -import 'dart:io'; - import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:collection/collection.dart'; import 'package:riverpod_lint/src/lints/notifier_extends.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import 'package:test/test.dart'; import '../../golden.dart'; @@ -12,16 +8,11 @@ import '../../golden.dart'; void main() { testGolden( 'Verify that @riverpod classes extend the generated typedef', - 'lints/notifier_extends/notifier_extends.json', - () async { + 'lints/notifier_extends/notifier_extends.diff', + sourcePath: 'test/lints/notifier_extends/notifier_extends.dart', + (result) async { final lint = NotifierExtends(); final fix = lint.getFixes().single as DartFix; - final file = File( - 'test/lints/notifier_extends/notifier_extends.dart', - ).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; final errors = await lint.testRun(result); expect(errors, hasLength(5)); diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.diff b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.diff new file mode 100644 index 000000000..fddcc1f43 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.diff @@ -0,0 +1,137 @@ +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:14`: +``` + +// expect_lint: provider_dependencies +- @riverpod ++ @Riverpod(dependencies: [dep]) +int plainAnnotation(PlainAnnotationRef ref) { + ref.watch(depProvider); +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:21`: +``` + +// expect_lint: provider_dependencies +- @Riverpod(keepAlive: false) ++ @Riverpod(keepAlive: false, dependencies: [dep]) +int customAnnotation(CustomAnnotationRef ref) { + ref.watch(depProvider); +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:29`: +``` +// expect_lint: provider_dependencies +@Riverpod( +- keepAlive: false, ++ keepAlive: false, dependencies: [dep], +) +int customAnnotationWithTrailingComma( +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:41`: +``` + keepAlive: false, + // expect_lint: provider_dependencies +- dependencies: [], ++ dependencies: [dep], +) +int existingDep(ExistingDepRef ref) { +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:51`: +``` + keepAlive: false, + // expect_lint: provider_dependencies +- dependencies: [], ++ dependencies: [dep, dep2], +) +int multipleDeps(MultipleDepsRef ref) { +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:61`: +``` +@Riverpod( + keepAlive: false, +- dependencies: [ +- // expect_lint: provider_dependencies +- dep, +- dep2, +- ], ++ dependencies: [dep2], +) +int extraDep(ExtraDepRef ref) { +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:74`: +``` +@Riverpod( + keepAlive: false, +- dependencies: [ +- // expect_lint: provider_dependencies +- dep, +- ], +- ) ++ ) +int noDep(NoDepRef ref) { + return 0; +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:84`: +``` + +@Riverpod( +- dependencies: [ +- // expect_lint: provider_dependencies +- dep, +- ], +- keepAlive: false, ++ keepAlive: false, +) +int dependenciesFirstThenKeepAlive(DependenciesFirstThenKeepAliveRef ref) { +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:94`: +``` +} + +- @Riverpod( +- dependencies: [ +- // expect_lint: provider_dependencies +- dep, +- ], +- ) ++ @riverpod +int noDepNoParam(NoDepNoParamRef ref) { + return 0; +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:105`: +``` + +// expect_lint: provider_dependencies +- @Riverpod(keepAlive: false, dependencies: [dep]) ++ @Riverpod(keepAlive: false,) +int noDepWithoutComma(NoDepWithoutCommaRef ref) { + return 0; +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.json b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.json deleted file mode 100644 index 90d167dd6..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.json +++ /dev/null @@ -1 +0,0 @@ -[{"priority":100,"change":{"message":"Specify \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":266,"length":9,"replacement":"@Riverpod(dependencies: [dep])"}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Specify \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":427,"length":0,"replacement":", dependencies: [dep]"}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Specify \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":585,"length":0,"replacement":", dependencies: [dep]"}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Update \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":804,"length":2,"replacement":"[dep]"}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Update \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":976,"length":2,"replacement":"[dep, dep2]"}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Update \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":1137,"length":66,"replacement":"[dep2]"}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Remove \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":1311,"length":74,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Remove \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":1439,"length":74,"replacement":""}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Remove \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":1627,"length":86,"replacement":"@riverpod"}]}],"linkedEditGroups":[]}},{"priority":100,"change":{"message":"Remove \"dependencies\"","edits":[{"fileStamp":0,"edits":[{"offset":1834,"length":20,"replacement":""}]}],"linkedEditGroups":[]}}] \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies_test.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies_test.dart index b9228ffe1..b12d6a212 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies_test.dart @@ -1,9 +1,5 @@ -import 'dart:io'; - import 'package:collection/collection.dart'; import 'package:riverpod_lint/src/lints/provider_dependencies.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; import 'package:test/test.dart'; import '../../golden.dart'; @@ -11,16 +7,11 @@ import '../../golden.dart'; void main() { testGolden( 'Verify that @riverpod classes extend the generated typedef', - 'lints/provider_dependencies/provider_dependencies.json', - () async { + 'lints/provider_dependencies/provider_dependencies.diff', + sourcePath: 'test/lints/provider_dependencies/provider_dependencies.dart', + (result) async { const lint = ProviderDependencies(); final fix = lint.getFixes().single; - final file = File( - 'test/lints/provider_dependencies/provider_dependencies.dart', - ).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; final errors = await lint.testRun(result); expect(errors, hasLength(10)); diff --git a/website/docs/case_studies/cancel.mdx b/website/docs/case_studies/cancel.mdx index ffd5f71f5..182265a5e 100644 --- a/website/docs/case_studies/cancel.mdx +++ b/website/docs/case_studies/cancel.mdx @@ -31,7 +31,7 @@ use: navigates away from the page before the request completes. This ensures that you don't waste time processing a response that the user will never see. -In Riverpod, both of these techniques are can be implemented in a similar way. +In Riverpod, both of these techniques can be implemented in a similar way. The key is to use `ref.onDispose` combined with "automatic disposal" or `ref.watch` to achieve the desired behavior. diff --git a/website/docs/essentials/combining_requests.mdx b/website/docs/essentials/combining_requests.mdx index 7acf31d05..d887f68dc 100644 --- a/website/docs/essentials/combining_requests.mdx +++ b/website/docs/essentials/combining_requests.mdx @@ -12,20 +12,20 @@ import watchPlacement from "./combining_requests/watch_placement"; import listenExample from "./combining_requests/listen_example"; import readExample from './combining_requests/read_example' -Up till now, we've only seens cases were requests are independent from each +Up till now, we've only seen cases where requests are independent from each other. But a common use-case is to have to trigger a request based on the result of another request. We _could_ be using the mechanism to -do that, by passing the result of a provider as parameter to another a provider. +do that, by passing the result of a provider as a parameter to another provider. But this approach has a few downsides: - This leaks implementation details. Now, your UI needs to know about all the providers that are used - your other provider. -- Whenever the parameter change, a brand new state will be made. - By passing parameters, there are no way to keep the previous state + by your other provider. +- Whenever the parameter changes, a brand new state will be made. + By passing parameters, there is no way to keep the previous state when the parameter changes. - It makes combining requests harder. - This makes tooling less useful. A devtool wouldn't @@ -38,13 +38,13 @@ To improve this, Riverpod offers a different approach to combine requests. All possible ways of combining requests have one thing in common: They are all based on the `Ref` object. -The `Ref` object is an object which all providers have access to. +The `Ref` object is an object to which all providers have access. It grants them access to various life-cycle listeners, but also various methods to combine providers. The place where `Ref` can be obtained depends on the type of provider. -In functional providers, the `Ref` is passed as parameter to the +In functional providers, the `Ref` is passed as a parameter to the provider's function: @@ -77,12 +77,12 @@ Then, we could use this location to fetch the list of restaurants near the user. :::info -When the listened provider changes and our request recomputes, the previous -state is kept until the new request completes. +When the listened to provider changes and our request recomputes, the previous +state is kept until the new request is completed. At the same time, while the request is pending, the "isLoading" and "isReloading" flags will be set. -This enables UI to either show the previous state, or a loading indicator, +This enables UI to either show the previous state or a loading indicator, or even both. ::: @@ -93,7 +93,7 @@ await for an initial value to be available. If we omit that `.future`, we would receive an `AsyncValue`, which is a snapshot of the current state of the `locationProvider`. But if no location is available yet, -we wouldn't be able to do anything. +we won't be able to do anything. ::: :::caution diff --git a/website/docs/essentials/faq.mdx b/website/docs/essentials/faq.mdx index 1ddad482a..29f584183 100644 --- a/website/docs/essentials/faq.mdx +++ b/website/docs/essentials/faq.mdx @@ -48,7 +48,7 @@ This is done on purpose to avoid writing code which conditionally depends on one or the other. One issue is that `Ref` and `WidgetRef`, although similar looking, -have suble differences. +have subtle differences. Code relying on both would be unreliable in ways that are difficult to spot. At the same time, relying on `WidgetRef` is equivalent to relying on `BuildContext`. diff --git a/website/docs/essentials/first_request.mdx b/website/docs/essentials/first_request.mdx index 22902b9e1..620a3be52 100644 --- a/website/docs/essentials/first_request.mdx +++ b/website/docs/essentials/first_request.mdx @@ -243,7 +243,7 @@ Using the syntax defined previously, we can therefore define our provider as fol In this snippet, we've defined a provider named `activityProvider` which -our UI will be able to use to obtain a random activity. It is worth nothing +our UI will be able to use to obtain a random activity. It is worth noting that: - The network request will not be executed until the UI reads the provider diff --git a/website/docs/essentials/side_effects.mdx b/website/docs/essentials/side_effects.mdx index 61059b609..9172ebbc3 100644 --- a/website/docs/essentials/side_effects.mdx +++ b/website/docs/essentials/side_effects.mdx @@ -427,7 +427,7 @@ performed, nor any information if failed. One way to do so is to store the Future returned by `addTodo` in the local widget state, and then listen to that future to show -a snipper or error message. +a spinner or error message. This is one scenario where [flutter_hooks](https://pub.dev/packages/flutter_hooks) comes in handy. But of course, you can also use a `StatefulWidget` instead. diff --git a/website/docs/essentials/testing.mdx b/website/docs/essentials/testing.mdx index 61b068f91..bb52e0906 100644 --- a/website/docs/essentials/testing.mdx +++ b/website/docs/essentials/testing.mdx @@ -45,7 +45,7 @@ The main difference with any other test is that we will want to create a `ProviderContainer` object. This object will enable our test to interact with providers. -It encouraged to make a testing utility for both creating and disposing +It is encouraged to make a testing utility for both creating and disposing of a `ProviderContainer` object: diff --git a/website/docs/from_provider/quickstart.mdx b/website/docs/from_provider/quickstart.mdx index 316f27084..6ed213073 100644 --- a/website/docs/from_provider/quickstart.mdx +++ b/website/docs/from_provider/quickstart.mdx @@ -64,7 +64,7 @@ This should boost and simplify the migration process, while also minimizing / tr ## Riverpod and Provider can coexist *Keep in mind that it is entirely possible to use both Provider and Riverpod at the same time.* -Indeed, using import aliases, it is possible to use the two APIs altogheter. +Indeed, using import aliases, it is possible to use the two APIs altogether. This is also great for readibilty and it removes any ambiguous API usage. If you plan on doing this, consider using import aliases for each Provider import in your codebase. @@ -204,4 +204,5 @@ Following this guide, you *can* migrate towards codegen as a further step forwar [are composable by default]: /docs/from_provider/motivation#combining-providers-is-hard-and-error-prone [as mentioned above]: /docs/from_provider/quickstart#start-with-changenotifierprovider [Riverpod's `Consumer` APIs]: /docs/concepts/reading -[lazy by default]: /docs/concepts/provider_lifecycles \ No newline at end of file +[lazy by default]: /docs/concepts/provider_lifecycles +[is available here]: /docs/essentials/eager_initialization diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current.json b/website/i18n/fr/docusaurus-plugin-content-docs/current.json index 994ac7a22..0669be5a8 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current.json +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current.json @@ -91,9 +91,9 @@ "message": "Application Todo avec fonction de sauvegarde et de restauration", "description": "The label for link Todo App with Backup and Restore feature in sidebar Sidebar, linking to https://github.com/TheAlphaApp/flutter_riverpod_todo_app" }, - "sidebar.Sidebar.link.Integrating Hive database with Riverpod (simple example)": { - "message": "Integration d'une base de donnée Hive avec Riverpod (exemple simple)", - "description": "The label for link Integrating Hive database with Riverpod (simple example) in sidebar Sidebar, linking to https://github.com/GitGud31/theme_riverpod_hive" + "sidebar.Sidebar.link.Integrating Hive database with Riverpod": { + "message": "Integration d'une base de donnée Hive avec Riverpod", + "description": "The label for link Integrating Hive database with Riverpod in sidebar Sidebar, linking to https://github.com/GitGud31/flutter_theme_riverpod_hive" }, "sidebar.Sidebar.link.Browser App with Riverpod": { "message": "Application navigateur avec Riverpod", diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx b/website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx new file mode 100644 index 000000000..58a015b59 --- /dev/null +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx @@ -0,0 +1,10 @@ +--- +title: Pull-to-refresh / Retry-on-error +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +Dans ce guide, nous verrons comment les Providers peuvent être utilisés pour mettre +en œuvre facilement une fonction de "pull-to-refresh" ou de "retry-on-error" +(tentative de réessai en cas d'erreur). \ No newline at end of file diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx b/website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx new file mode 100644 index 000000000..027aa921a --- /dev/null +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx @@ -0,0 +1,133 @@ +--- +titre : Recherche au fur et à mesure de la frappe +--- +Un exemple concret pourrait être l'utilisation de `FutureProvider` pour implémenter une barre de recherche. + +## Exemple d'utilisation : Barre de recherche "Search as we type" (recherche au fur et à mesure de la frappe) + +La mise en œuvre d'une "recherche au fil de la frappe" peut sembler décourageante au début si l'on utilise des moyens conventionnels. +Il y a beaucoup d'éléments en jeu, tels que + +- le traitement des erreurs. +- le débouclage (debouncing) de l'entrée de l'utilisateur afin d'éviter de faire des demandes de réseau à chaque frappe. +- l'annulation des demandes de réseau en attente lorsque le champ de recherche change. + +Mais la combinaison de `FutureProvider` et de la puissance de [ref.watch] peut considérablement simplifier cette tâche. + +Un schéma courant pour effectuer des requêtes asynchrones est de la diviser en plusieurs providers : + +- un [StateNotifierProvider] ou `StateProvider` pour les paramètres de votre requête (ou alternativement utiliser [family]) +- un `FutureProvider`, qui effectuera la requête en lisant les paramètres des autres providers/[family]. + +La première étape consiste à stocker l'entrée de l'utilisateur quelque part. Pour cet exemple, nous utiliserons `StateProvider` (puisque l'état de la recherche n'est qu'une simple `chaîne`) : + +```dart +final searchInputProvider = StateProvider((ref) => ''); +``` + +Nous pouvons ensuite connecter ce provider à un [TextField] en faisant : + +```dart +Consumer( + builder: (context, ref, child) { + return TextField( + onChanged: (value) => ref.read(searchInputProvider.notifier).state = value, + ); + }, +) +``` + +Ensuite, nous pouvons créer notre `FutureProvider` qui s'occupera de la requête : + +```dart +final searchProvider = FutureProvider< + + + + + + + } + + +}`} + annotations={[ + { + offset: 0, + length: 9, + label: "L'annotazione", + description: <> + +Tutti i provider devono essere annotati con `@riverpod` o `@Riverpod()`. +Questa annotazione può essere posta su funzioni globali o classi. +Attraverso questa annotazione, è possibile configurare il provider. + +Per esempio, possiamo disabilitare "auto-dispose" (che vedremo più avanti) scrivendo `@Riverpod(keepAlive: true)`. + + + }, + { + offset: 10, + length: 16, + label: "Il Notifier", + description: <> + +Quando un'annotazione `@riverpod` è posta su una classe, quella classe viene chiamata "Notifier". +La classe deve estendere `_$NotifierName`, dove `NotifierName` è il nome della classe. + +I Notifiers sono responsabili di esporre modalità per modificare lo stato del provider. +I metodi pubblici di questa classe sono accessibili ai consumer usando `ref.read(yourProvider.notifier).tuoMetodo()`. + +:::note +I Notifiers non dovrebbero avere proprietà pubbliche oltre alla proprietà built-in `state`, poiché l'interfaccia utente +non avrebbe modo di sapere che lo stato è cambiato. +::: + + + }, + { + offset: 52, + length: 54, + label: "Il metodo build", + description: <> + +Tutti i notifiers devono sovrascrivere il metodo `build`. +Questo metodo è equivalente al punto in cui normalmente inseriresti la tua +logica in un provider non-notifier. + +Questo metodo non dovrebbe essere chiamato direttamente. + + + }, +]} +/> + + +Per ulteriori informazioni, potresti voler consultare +per confrontare questa nuova sintassi con quella vista in precedenza. + +:::info +Un Notifier senza metodi al di fuori di `build` è identico all'utilizzo della sintassi vista in precedenza. +La sintassi mostrata in può essere considerata +come una scorciatoia per i notifiers senza possibilità di essere modificati dall'interfaccia utente. +::: + +Ora che abbiamo visto la sintassi, vediamo come convertire il nostro provider precedentemente definito in un notifier: + + + +Notiamo che il modo di leggere il provider all'interno dei widget non è cambiato. +Puoi ancora usare `ref.watch(todoListProvider)` come nella sintassi precedente. + +:::caution +Non inserire la logica nel costruttore del tuo notifier. +I notifiers non dovrebbero avere un costruttore, poiché `ref` e altre proprietà +non sono ancora disponibili in quel momento. Invece, inserisci la tua logica nel metodo `build`. + +```dart +class MyNotifier extends ... { + MyNotifier() { + // ❌ Non fare questo + // Causerà un'eccezione + state = AsyncValue.data(42); + } + + @override + Result build() { + // ✅ Fare questo invece + state = AsyncValue.data(42); + } +} +``` + +::: + +## Esporre un metodo per effettuare una richiesta _POST_ + +Ora che abbiamo un Notifier, possiamo iniziare ad aggiungere metodi per abilitare i side-effects. +Un side-effect del genere potrebbe essere quello di far eseguire al client una richiesta _POST_ +per aggiungere un nuovo elemento todo. +Possiamo farlo aggiungendo un metodo `addTodo` al nostro notifier: + + + +:::info +Nota come stiamo usando `ref.read` invece di `ref.watch` per invocare il nostro metodo. +Anche se `ref.watch` potrebbe funzionare tecnicamente, si consiglia di utilizzare `ref.read` +quando si esegue la logica negli event handlers come "onPressed". +::: + +Abbiamo ora un pulsante che effettua una richiesta _POST_ quando premuto. +Tuttavia, al momento, la nostra interfaccia utente non si aggiorna per riflettere la nuova to-do list. +Vogliamo che la nostra cache locale corrisponda allo stato del server. + +Esistono diversi modi per farlo, ognuno con i suoi vantaggi e svantaggi. + +### Aggiornare la cache locale per riflettere la risposta dell'API + +Una pratica comune lato server è fare sì che la richiesta _POST_ restituisca il nuovo stato della risorsa. +In particolare, la nostra API restituirebbe la nuova lista to-do dopo l'aggiunta di un nuovo to-do. +Un modo per farlo è scrivere `state = AsyncData(response)`: + + + +:::tip pro + +- L'interfaccia utente avrà lo stato più aggiornato possibile. + Se un altro utente ha aggiunto un to-do, la vedremo anche noi. +- Il server è la fonte di verità. Con questo approccio, + il client non ha bisogno di sapere dove il nuovo to-do deve essere inserito nella list to-do. +- È necessaria solo una singola richiesta di rete. + +::: + +:::danger contro + +- Questo approccio funzionerà solo se il server è implementato in un modo specifico. + Se il server non restituisce il nuovo stato, questo approccio non funzionerà. +- Potrebbe ancora non essere fattibile se la richiesta _GET_ associata è più complessa, + ad esempio se ha filtri/ordinamenti. + +::: + +### Usare `ref.invalidateSelf()` per ricaricare il provider. + +Un'opzione è far eseguire nuovamente la richiesta _GET_ al nostro provider. +Questo può essere fatto chiamando `ref.invalidateSelf()` dopo la richiesta _POST_: + + + +:::tip pro + +- L'interfaccia utente avrà lo stato più aggiornato possibile. + Se un altro utente ha aggiunto un nuovo to-do, lo vedremo anche noi. +- Il server è la fonte di verità. + Con questo approccio, il client non ha bisogno di sapere dove inserire il nuovo to-do + nella lista dei to-do. +- Questo approccio dovrebbe funzionare indipendentemente dall'implementazione del server. + Può essere particolarmente utile se la tua richiesta _GET_ è più complessa, + ad esempio se ha filtri/ordinamenti. + +::: + +:::danger contro + +- Questo approccio eseguirà una richiesta _GET_ aggiuntiva, il che potrebbe + essere inefficiente. + +::: + +### Aggiornare la cache locale manualmente + +Un'altra opzione è quella di aggiornare manualmente la cache locale. +Ciò implicherebbe cercare di imitare il comportamento del backend. +Ad esempio, dovremmo sapere se il backend inserisce nuovi elementi +all'inizio o alla fine. + + + +:::info +Questo esempio utilizza uno stato immutabile. Non è obbligatorio, ma consigliato. +Consulta per ulteriori dettagli. +Se desideri utilizzare uno stato mutabile, puoi fare in alternativa: + + + +::: + +:::tip pro + +- Questo approccio dovrebbe funzionare indipendentemente dall'implementazione del server. +- È necessaria solo una singola richiesta di rete. + +::: + +:::danger contro + +- La cache locale potrebbe non corrispondere allo stato del server. + Se un altro utente ha aggiunto un to-do, non lo vedremo. +- Questo approccio potrebbe essere più complesso da implementare ed in realtà + duplicare la logica del backend. + +::: + +## Andando oltre: Mostrare uno spinner e gestione dell'errore + +Con tutto ciò che abbiamo visto finora, abbiamo un pulsante che effettua una richiesta _POST_ +quando viene premuto; e quando la richiesta è completata, l'interfaccia utente si aggiorna per riflettere +le modifiche. Ma al momento, non c'è alcuna indicazione che la richiesta stia avvenendo, +né alcuna informazione in caso di fallimento. + +Un modo per farlo è memorizzare il Future restituito da `addTodo` +nello stato locale del widget e quindi ascoltare quel future per mostrare +un indicatore di caricamento o un messaggio di errore. Questo è uno scenario in cui +[flutter_hooks](https://pub.dev/packages/flutter_hooks) risulta utile. Ma naturalmente, +è possibile utilizzare anche un `StatefulWidget` al suo posto. + +Il seguente snippet mostra un indicatore di avanzamento mentre +un'operazione è in corso. Se fallisce, rende il pulsante di colore rosso: + +![Un bottone che diventa rosso quando l'operazione fallisce](/img/essentials/side_effects/spinner.gif) + + \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart new file mode 100644 index 000000000..23a30cb03 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart @@ -0,0 +1,28 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo_list_notifier.freezed.dart'; +part 'todo_list_notifier.g.dart'; + +@freezed +class Todo with _$Todo { + factory Todo({ + required String description, + @Default(false) bool completed, + }) = _Todo; + + factory Todo.fromJson(Map json) => _$TodoFromJson(json); +} + +/* SNIPPET START */ +@riverpod +class TodoList extends _$TodoList { + @override + Future> build() async { + // La logica che precedentemente avevamo nel nostro FutureProvider è ora nel metodo 'build'. + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart new file mode 100644 index 000000000..3326f9ffa --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart @@ -0,0 +1,166 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'todo_list_notifier.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Todo _$TodoFromJson(Map json) { + return _Todo.fromJson(json); +} + +/// @nodoc +mixin _$Todo { + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$TodoImpl implements _Todo { + _$TodoImpl({required this.description, this.completed = false}); + + factory _$TodoImpl.fromJson(Map json) => + _$$TodoImplFromJson(json); + + @override + final String description; + @override + @JsonKey() + final bool completed; + + @override + String toString() { + return 'Todo(description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); + + @override + Map toJson() { + return _$$TodoImplToJson( + this, + ); + } +} + +abstract class _Todo implements Todo { + factory _Todo({required final String description, final bool completed}) = + _$TodoImpl; + + factory _Todo.fromJson(Map json) = _$TodoImpl.fromJson; + + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart new file mode 100644 index 000000000..81218695d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -0,0 +1,89 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_notifier.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$TodoImpl _$$TodoImplFromJson(Map json) => _$TodoImpl( + description: json['description'] as String, + completed: json['completed'] as bool? ?? false, + ); + +Map _$$TodoImplToJson(_$TodoImpl instance) => + { + 'description': instance.description, + 'completed': instance.completed, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(TodoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider + extends $AsyncNotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$todoListHash() => r'c939d438b07da6065dbbcfab86c27ef363bdb76c'; + +abstract class _$TodoList extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart new file mode 100644 index 000000000..1b3803279 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart @@ -0,0 +1,26 @@ +// ignore_for_file: avoid_print + +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'todo_list_notifier.dart'; + +part 'todo_list_notifier_add_todo.g.dart'; + +/* SNIPPET START */ +@riverpod +class TodoList extends _$TodoList { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + await http.post( + Uri.https('your_api.com', '/todos'), + // Serializziamo il nostro oggetto Todo e lo salviamo tramite POST sul server. + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart new file mode 100644 index 000000000..19c5471ad --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_notifier_add_todo.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(TodoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider + extends $AsyncNotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$todoListHash() => r'4008395aaca8f55312f668c0b2a32e7599f82349'; + +abstract class _$TodoList extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart new file mode 100644 index 000000000..76ab146fd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart @@ -0,0 +1,23 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo_list_provider.freezed.dart'; +part 'todo_list_provider.g.dart'; + +@freezed +class Todo with _$Todo { + factory Todo({ + required String description, + @Default(false) bool completed, + }) = _Todo; +} + +/* SNIPPET START */ +@riverpod +Future> todoList(TodoListRef ref) async { + // Simula una richiesta di rete. Normalmente il risultato dovrebbe venire da una API reale + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart new file mode 100644 index 000000000..26a2d640c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart @@ -0,0 +1,148 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'todo_list_provider.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$Todo { + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc + +class _$TodoImpl implements _Todo { + _$TodoImpl({required this.description, this.completed = false}); + + @override + final String description; + @override + @JsonKey() + final bool completed; + + @override + String toString() { + return 'Todo(description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @override + int get hashCode => Object.hash(runtimeType, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); +} + +abstract class _Todo implements Todo { + factory _Todo({required final String description, final bool completed}) = + _$TodoImpl; + + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart new file mode 100644 index 000000000..c890d03c6 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -0,0 +1,66 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef TodoListRef = Ref>>; + +@ProviderFor(todoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider extends $FunctionalProvider>, + FutureOr>, TodoListRef> + with $FutureModifier>, $FutureProvider, TodoListRef> { + const TodoListProvider._( + {FutureOr> Function( + TodoListRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + TodoListRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + TodoListProvider $copyWithCreate( + FutureOr> Function( + TodoListRef ref, + ) create, + ) { + return TodoListProvider._(create: create); + } + + @override + FutureOr> create(TodoListRef ref) { + final _$cb = _createCb ?? todoList; + return _$cb(ref); + } +} + +String _$todoListHash() => r'26b30307668c8feefa7cbe3c400b73e6edccbc39'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart new file mode 100644 index 000000000..b65d27945 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart @@ -0,0 +1,23 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../raw/todo_list_notifier.dart' show Todo; +import '../raw/todo_list_notifier_add_todo.dart'; + +/* SNIPPET START */ +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return ElevatedButton( + onPressed: () { + // Usando "ref.read" combinato con "myProvider.notifier" possiamo + // ottenere l'istanza della classe del nostro notifier. Ciò ci permette di + // chiamare il metodo "addTodo". + ref.read(todoListProvider.notifier).addTodo(Todo(description: 'Questo è un nuovo todo')); + }, + child: const Text('Aggiungi todo'), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart new file mode 100644 index 000000000..e9faed615 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart @@ -0,0 +1,38 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // Non ci importa della risposta dell'API + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // Una volta che la richiesta è terminata, possiamo marcare la cache locale come sporca. + // Facendo ciò, il metodo "build" sul nostro notifier verrà chiamato asincronamente di nuovo, + // notificando i suoi listener. + ref.invalidateSelf(); + + // (Opzionale) Possiamo quindi aspettare che il nuovo stato venga computato. + // Questo assicura che "addTodo" non venga completato finchè il nuovo stato non è disponibile. + await future; + } +/* SNIPPET END */ +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart new file mode 100644 index 000000000..6267f1158 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart @@ -0,0 +1,41 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // Non ci importa della risposta dell'API + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // Possiamo quindi aggiornare manualmente la cache locale. Per fare ciò, avremo bisogno + // di ottenere lo stato precedente. + // Attenzione: lo stato precedente potrebbe essere anche in stato di loading o di errore. + // Un modo elegante di gestirlo sarebbe leggere `this.future` invece + // di `this.state`, il che consentirebbe di attendere lo stato di loading e + // generare un errore se lo stato è in uno stato di errore. + final previousState = await future; + + // Possiamo quindi aggiornare lo stato, creando un nuovo oggetto di stato. + // Ciò notificherà i suoi listener. + state = AsyncData([...previousState, todo]); + } +/* SNIPPET END */ +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart new file mode 100644 index 000000000..8c7fe85b4 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart @@ -0,0 +1,35 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + // Non ci importa della risposta dell'API + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + /* SNIPPET START */ + final previousState = await future; + // Modifica la lista dei todo in modo mutabile. + previousState.add(todo); + // Notifica manualmente i listener. + ref.notifyListeners(); + /* SNIPPET END */ + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart new file mode 100644 index 000000000..65bad622d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart @@ -0,0 +1,78 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'rest_add_todo.dart'; +import 'todo_list_notifier.dart' show Todo; + +void main() { + runApp( + const ProviderScope(child: MyApp()), + ); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return const MaterialApp(home: Example()); + } +} + +/* SNIPPET START */ +class Example extends ConsumerStatefulWidget { + const Example({super.key}); + + @override + ConsumerState createState() => _ExampleState(); +} + +class _ExampleState extends ConsumerState { + // L'operazione addTodo in sospeso. O null se nessuna è in attesa. + Future? _pendingAddTodo; + + @override + Widget build(BuildContext context) { + return FutureBuilder( + // Ascoltiamo l'operazione in sospeso per aggiornare l'interfaccia utente di conseguenza. + future: _pendingAddTodo, + builder: (context, snapshot) { + // Calcoliamo se c'è uno stato di errore o meno. + // Controlliamo qui lo stato di ConnectionState per gestire quando l'operazione viene ripetuta. + final isErrored = snapshot.hasError && + snapshot.connectionState != ConnectionState.waiting; + + return Row( + children: [ + ElevatedButton( + style: ButtonStyle( + // Se c'è stato un errore mostriamo il bottone in rosso + backgroundColor: MaterialStateProperty.all( + isErrored ? Colors.red : null, + ), + ), + onPressed: () { + // Assegniamo il future ritornato da 'addTodo' in una variabile + final future = ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + + // Immagazziniamo il future nello stato locale + setState(() { + _pendingAddTodo = future; + }); + }, + child: const Text('Add todo'), + ), + // L'operazione è in sospeso, mostriamo un indicatore di progresso + if (snapshot.connectionState == ConnectionState.waiting) ...[ + const SizedBox(width: 8), + const CircularProgressIndicator(), + ], + ], + ); + }, + ); + } +} +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart new file mode 100644 index 000000000..9c0ea059f --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart @@ -0,0 +1,69 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'rest_add_todo.dart'; +import 'todo_list_notifier.dart' show Todo; + +void main() { + runApp( + const ProviderScope(child: MyApp()), + ); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return const MaterialApp(home: Example()); + } +} + +/* SNIPPET START */ +class Example extends HookConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // L'operazione addTodo in sospeso. O null se nessuna è in attesa. + final pendingAddTodo = useState?>(null); + + // Ascoltiamo l'operazione in sospeso per aggiornare l'interfaccia utente di conseguenza. + final snapshot = useFuture(pendingAddTodo.value); + + // Calcoliamo se c'è uno stato di errore o meno. + // Controlliamo qui lo stato di ConnectionState per gestire quando l'operazione viene ripetuta. + final isErrored = snapshot.hasError && + snapshot.connectionState != ConnectionState.waiting; + + return Row( + children: [ + ElevatedButton( + style: ButtonStyle( + // Se c'è stato un errore mostriamo il bottone in rosso + backgroundColor: MaterialStateProperty.all( + isErrored ? Colors.red : null, + ), + ), + onPressed: () async { + // Assegniamo il future ritornato da 'addTodo' in una variabile + final future = ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + + // Immagazziniamo il future nello stato locale + pendingAddTodo.value = future; + }, + child: const Text('Add todo'), + ), + // L'operazione è in sospeso, mostriamo un indicatore di progresso + if (snapshot.connectionState == ConnectionState.waiting) ...[ + const SizedBox(width: 8), + const CircularProgressIndicator(), + ], + ], + ); + } +} +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart new file mode 100644 index 000000000..5f95a2961 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart @@ -0,0 +1,39 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // La richiesta POST restituirà una List corrispondente al nuovo stato dell'applicazione + final response = await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // Decodifichiamo la risposta API e la convertiamo in una List + List newTodos = (jsonDecode(response.body) as List) + .cast>() + .map(Todo.fromJson) + .toList(); + + // Aggiorniamo la cache locale per riflettere il nuovo stato. + // Questo notificherà tutti i suoi ascoltatori. + state = AsyncData(newTodos); + } +/* SNIPPET END */ +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart new file mode 100644 index 000000000..51561cec5 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart @@ -0,0 +1,44 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Todo { + Todo({ + required this.description, + this.completed = false, + }); + + factory Todo.fromJson(Map json) { + return Todo( + description: json['description']! as String, + completed: json['completed']! as bool, + ); + } + + final String description; + final bool completed; + + Map toJson() => { + 'description': description, + 'completed': completed, + }; +} + +/* SNIPPET START */ +// Ora usiamo AsyncNotifierProvider invece di FutureProvider +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +// Usiamo un AsyncNotifier perché la nostra logica è asincrona. +// Più nello specifico, avremo di AsyncNotifier +// per fruire del modificatore "autoDispose". +class TodoList extends AsyncNotifier> { + @override + Future> build() async { + // La logica che in precedenza avevamo nel nostro FutureProvider ora è nel metodo di build. + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart new file mode 100644 index 000000000..b2ddf3a1f --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +/* SNIPPET START */ +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + await http.post( + Uri.https('your_api.com', '/todos'), + // Serializziamo il nostro oggetto Todo e lo inviamo al server. + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart new file mode 100644 index 000000000..327cc8918 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart @@ -0,0 +1,27 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class Todo { + Todo({ + required this.description, + this.completed = false, + }); + + factory Todo.fromJson(Map json) { + return Todo( + description: json['description'] as String, + completed: json['completed'] as bool, + ); + } + + final String description; + final bool completed; +} + +final todoListProvider = FutureProvider.autoDispose>((ref) async { + // Simula una richiesta di rete. Normalmente il risultato dovrebbe venire da una API reale + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts new file mode 100644 index 000000000..798feb107 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/render_add_todo.dart"; +import hooks from "!!raw-loader!./raw/render_add_todo_hooks.dart"; + +export default { + raw: raw, + hooks: hooks, + codegen: raw, + hooksCodegen: hooks, +}; \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts new file mode 100644 index 000000000..b32ae3b9b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/todo_list_notifier.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_notifier.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts new file mode 100644 index 000000000..62fb0e0fc --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/todo_list_notifier_add_todo.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_notifier_add_todo.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts new file mode 100644 index 000000000..de7789c0b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts @@ -0,0 +1,7 @@ +import raw from "!!raw-loader!./raw/todo_list_provider.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_provider.dart"; + +export default { + raw: raw, + codegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing.mdx new file mode 100644 index 000000000..569e751a7 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing.mdx @@ -0,0 +1,160 @@ +--- +title: Testare i tuoi provider +--- + +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import createContainer from "!!raw-loader!./testing/create_container.dart"; +import unitTest from "!!raw-loader!./testing/unit_test.dart"; +import widgetTest from "!!raw-loader!./testing/widget_test.dart"; +import fullWidgetTest from "!!raw-loader!./testing/full_widget_test.dart"; +import widgetContainerOf from "!!raw-loader!./testing/widget_container_of.dart"; +import providerToMock from "./testing/provider_to_mock"; +import mockProvider from "!!raw-loader!./testing/mock_provider.dart"; +import autoDisposeListen from "!!raw-loader!./testing/auto_dispose_listen.dart"; +import listenProvider from "!!raw-loader!./testing/listen_provider.dart"; +import awaitFuture from "!!raw-loader!./testing/await_future.dart"; +import notifierMock from "./testing/notifier_mock"; + +Una parte fondamentale delle API di Riverpod è l'abilità di testare i tuoi provider in modo isolato. + +Per una suite di test adeguata, ci sono alcune sfide da superare: + +- I test non dovrebbero condividere lo stato. Ciò significa che nuovi test + non dovrebbero essere influenzati dai test precedenti. +- I test dovrebbero darci l'abilità di emulare certe funzionalità + per ottenere lo stato desiderato. +- L'ambiente di test dovrebbe essere il più vicino possibile all'ambiente reale. + +Fortunatamente, Riverpod semplifica il raggiungimento di tutti questi obiettivi. + +## Impostare un test + +Quando si definisce un test con Riverpod, ci sono due scenari principali: + +- Test unitari, di solito senza dipendenze di Flutter. + Possono essere utili per testare il comportamento di un provider isolamente. +- Test di widget, di solito con dipendenze di Flutter. + Possono essere utili per testare il comportamento di un widget che utilizza un provider. + +### Test unitari + +I test unitari sono definit usando la funzione `test` da [package:test](https://pub.dev/packages/test) + +La differenza principale con qualsiasi altro test è che creeremo un oggetto +`ProviderContainer`. Questo oggetto permetterà al nostro test di interagire con i provider + +Si consiglia di creare un'utilità di test sia per la creazione che per l'eliminazione +di un oggetto `ProviderContainer`: + + + +Successivamente, possiamo definire un `test` utilizzando questa utilità: + + + +Ora che abbiamo un ProviderContainer possiamo utilizzarlo per leggere i provider usando: + +- `container.read`, per leggere il valore corrente di un provider. +- `container.listen`, per restare in ascolto di un provider ed essere notificato dei suoi cambiamenti. + +:::caution +Fai attenzione quando usi `container.read` quando i provider sono distrutti automaticamente. +Se il tuo provider non è ascoltato, ci sono chances che il suo stato verrà distrutto nel mezzo +del nostro test. + +In quel caso, considera utilizzare `container.listen`. +Il suo valore di ritorno permette comunque di leggere il valore corrente del provider, +ma si assicurerà anche che il provider non venga distrutto nel mezzo del tuo test: + + +::: + +### Test di widget + +I test dei widget sono definiti usando la funzione `testWidgets` da [package:flutter_test](https://pub.dev/packages/flutter_test). + +In questo caso, la differenza principale con i normali test di widget è che dobbiamo +aggiungere un widget `ProviderScope` alla radice di `tester.pumpWidget`. + + + +Questo è simile a quello che facciamo quando abilitiamo Riverpod nella nostra app Flutter. + +Successivamente, possiamo usare `tester` per interagire col nostro widget. +In alternativa, se vuoi interagire coi tuoi provider, puoi ottenere +un `ProviderContainer`. +Un oggetto `ProviderContainer` può essere ottenuto usando `ProviderScope.containerOf(buildContext)`. +Usando `tester` possiamo quindi scrivere quanto segue: + + + +Possiamo quindi usarlo per leggere i provider. Di seguito un esempio completo: + + + +## Mock/Imitare provider + +Fino ad ora abbiamo visto come impostare un test ed interagire in modo semplice con i provider. +Tuttavia, in alcuni casi, potremmo voler imitare un provider. + +La parte interessante: tutti i provider possono essere imitati di default, senza nessun impostazione aggiuntiva. +Questo è possibile specificando il parametro `overrides` su `ProviderScope` o `ProviderContainer`. + +Consideriamo il provider seguente: + + + +Possiamo imitarlo usando: + + + +## Spiare i cambiamenti in un provider + +Dato che abbiamo ottenuto un `ProviderContainer` nei nostri test, è possibile +usarlo per "ascoltare" un provider: + + + +Puoi combinare questo con pacchetti come [mockito](https://pub.dev/packages/mockito) o +[mocktail](https://pub.dev/packages/mocktail) per usare la loro API `verify`. +O più semplicemente, puoi aggiungere tutti i cambiamenti in una lista e controllarli tramite 'assert'. + +## Aspettare provider asincroni + +In Riverpod è molto comune per i provider restituire un Future/Stream. +In questo caso, ci sono chances che i nostri test abbiano bisogno di aspettare che +quelle operazioni asincrone siano completate. + +Un modo per farlo è leggere il `.future` di un provider: + + + +## Imitare i Notifier + +È generalmente sconsigliato imitare i Notifier. +Invece, dovresti probabilmente introdurre un livello di astrazione nella logica del tuo +Notifier, in modo tale da poter imitare tale astrazione. +Per esempio, al posto di imitare un Notifier, potresti imitare un "repository" +che il Notifier usa per ottenere i dati. + +Se vuoi insistere nell'imitare un Notifier, esiste una considerazione speciale +per creare un mock di questo tipo: il tuo mock deve essere una subclass della classe +base del Notifier: non puoi implementare (via "implements") un Notifier, poichè +romperebbe l'interfaccia. + +Pertanto, quando si imita un Notifier, invece di scrivere il codice mockito seguente: + +```dart +class MyNotifierMock with Mock implements MyNotifier {} +``` + +Dovresti invece scrivere: + + + + + +Per far sì che funzioni, il tuo mock deve essere posto nello stesso file del Notifier +che stai imitando. Altrimenti, non avresti accesso alla classe `_$MyNotifier`. + + diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart new file mode 100644 index 000000000..6d901503b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 'Hello world'); + +void main() { + test('Some description', () { + final container = createContainer(); + /* SNIPPET START */ + final subscription = container.listen(provider, (_, __) {}); + + expect( + // Equivalente di `container.read(provider)` + // Ma il provider non verrà distrutto a meno che "subscription" non venga distrutta. + subscription.read(), + 'Some value', + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart new file mode 100644 index 000000000..060f4c592 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart @@ -0,0 +1,30 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = FutureProvider((_) async => 42); + +void main() { + test('Some description', () async { + // Crea un ProviderContainer per questo test. + // NON condivedere i ProviderContainer tra i vari test. + final container = createContainer(); + + /* SNIPPET START */ + // TODO: usa il container per testare la tua applicazione. + // Il valore atteso è asincrono, quindi dovremmo usare "expectLater" + await expectLater( + // Leggiamo "provider.future" invece di "provider". + // Questo è possibile su provider asincroni e restituisce un future + // che si risolverà con il valore del provider. + container.read(provider.future), + // Possiamo verificare che quel future si risolva con il valore atteso. + // In alternativa possiamo usare "throwsA" per gli errori. + completion('some value'), + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart new file mode 100644 index 000000000..e9441d3b8 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart @@ -0,0 +1,22 @@ +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +/// Un'utilità di test che crea un [ProviderContainer] e lo distrugge automaticamente +/// alla fine del test +ProviderContainer createContainer({ + ProviderContainer? parent, + List overrides = const [], + List? observers, +}) { + // Crea un ProviderContainer, permettendo di specificare dei parametri. + final container = ProviderContainer( + parent: parent, + overrides: overrides, + observers: observers, + ); + + // Alla fine del test, distrugge il container + addTearDown(container.dispose); + + return container; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart new file mode 100644 index 000000000..5b2ee2d94 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart @@ -0,0 +1,33 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +final provider = Provider((_) => 'some value'); + +class YourWidgetYouWantToTest extends StatelessWidget { + const YourWidgetYouWantToTest({super.key}); + + @override + Widget build(BuildContext context) => const Placeholder(); +} + +/* SNIPPET START */ +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + + final element = tester.element(find.byType(YourWidgetYouWantToTest)); + final container = ProviderScope.containerOf(element); + + // TODO interagire con i tuoi provider + expect( + container.read(provider), + 'some value', + ); + }); +} +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart new file mode 100644 index 000000000..d2e840d9b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 'Hello world'); + +void main() { + test('Some description', () { + final container = createContainer(); + /* SNIPPET START */ + container.listen( + provider, + (previous, next) { + print('The provider changed from $previous to $next'); + }, + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart new file mode 100644 index 000000000..0e5b266d2 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart @@ -0,0 +1,45 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +import 'create_container.dart'; +import 'full_widget_test.dart'; +import 'provider_to_mock/raw.dart'; + +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + /* SNIPPET START */ + // Nei test unitari, riutilizzando la nostra precedente utilità "createContainer". + final container = createContainer( + // Possiamo specificare una lista di provider da emulare: + overrides: [ + // In questo caso, stiamo imitando "exampleProvider". + exampleProvider.overrideWith((ref) { + // Questa funzione è la tipica funzione di inizializzazione di un provider. + // Qui è dove normalmente chiamaresti "ref.watch" e restituiresti lo stato iniziale. + + // Sostituiamo il valore di default "Hello world" con un valore custom. + // Infine, quando interagiremo con `exampleProvider`, ci ritornerà questo valore. + return 'Hello from tests'; + }), + ], + ); + + // Possiamo anche fare lo stesso nei test di widget usando ProviderScope: + await tester.pumpWidget( + ProviderScope( + // I ProviderScope hanno lo stesso esatto parametro "overrides" + overrides: [ + // Uguale a prima + exampleProvider.overrideWith((ref) => 'Hello from tests'), + ], + child: const YourWidgetYouWantToTest(), + ), + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart new file mode 100644 index 000000000..84f0fff0b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart @@ -0,0 +1,17 @@ +// ignore_for_file: prefer_mixin + +import 'package:mockito/mockito.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() => throw UnimplementedError(); +} + +// Il tuo mock necessita di subclassare la classe base del Notifier +class MyNotifierMock extends _$MyNotifier with Mock implements MyNotifier {} +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart new file mode 100644 index 000000000..df3894527 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'912fa35c2296626fc0825bcbcfc6b6c85958be02'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart new file mode 100644 index 000000000..d21cc3d0e --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart @@ -0,0 +1,14 @@ +// ignore_for_file: prefer_mixin + +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:mockito/mockito.dart'; + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() => throw UnimplementedError(); +} + +// Il tuo mock necessita di subclassare la classe base del Notifier +class MyNotifierMock extends Notifier with Mock implements MyNotifier {} +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart new file mode 100644 index 000000000..c03802466 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +// Un provider inizializzato anticipatamente +@riverpod +Future example(ExampleRef ref) async => 'Hello world'; +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart new file mode 100644 index 000000000..fa3e37948 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart new file mode 100644 index 000000000..b4eb3aaf0 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart @@ -0,0 +1,6 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +// Un provider inizializzato anticipatamente +final exampleProvider = FutureProvider((ref) async => 'Hello world'); +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart new file mode 100644 index 000000000..162c30a72 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 42); + +/* SNIPPET START */ +void main() { + test('Some description', () { + // Crea un ProviderContainer per questo test. + // NON condividere dei ProviderContainer tra i test. + final container = createContainer(); + + // TODO: usare il container per testare la tua applicazione. + expect( + container.read(provider), + equals('some value'), + ); + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart new file mode 100644 index 000000000..61b2ca36b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart @@ -0,0 +1,15 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +import 'widget_test.dart'; + +void main() { + testWidgets('Some description', (tester) async { + /* SNIPPET START */ + final element = tester.element(find.byType(YourWidgetYouWantToTest)); + final container = ProviderScope.containerOf(element); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart new file mode 100644 index 000000000..b4afc835c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +class YourWidgetYouWantToTest extends StatelessWidget { + const YourWidgetYouWantToTest({super.key}); + + @override + Widget build(BuildContext context) => const Placeholder(); +} + +/* SNIPPET START */ +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + }); +} +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx new file mode 100644 index 000000000..9083ed859 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx @@ -0,0 +1,108 @@ +--- +title: Websocket ed esecuzione sincrona +--- + +import { + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; +import syncDefinition from "./websockets_sync/sync_definition"; +import streamProvider from "./websockets_sync/stream_provider"; +import syncConsumer from "!!raw-loader!./websockets_sync/sync_consumer.dart"; +import rawUsage from "!!raw-loader!./websockets_sync/raw_usage.dart"; +import pipeChangeNotifier from "!!raw-loader!./websockets_sync/pipe_change_notifier.dart"; +import sharedPipeChangeNotifier from "!!raw-loader!./websockets_sync/shared_pipe_change_notifier.dart"; +import changeNotifierProvider from "!!raw-loader!./websockets_sync/change_notifier_provider.dart"; + +Fino ad ora abbiamo solo coperto come creare un `Future`. +Abbiamo fatto ciò apposta, dato che i `Future`s sono una parte fondamentale di come +le applicazioni che usano Riverpod dovrebbero essere costruite. +_Ma_, Riverpod supporta anche altri formati se necessario. + +In particolare, invece di un `Future`, i provider sono liberi di: + +- Ritornare in modo sincrono un oggetto, come creare un "Repository". +- Ritornare uno `Stream`, come ascoltare i websocket. + +Restituire un `Future` e restituire uno `Stream` o un oggetto è abbastanza simile nel complesso. +Considera questa pagina come una spiegazione delle sottili differenze e de vari +suggerimenti per questi casi d'uso. + +## Restituire un oggetto in modo sincrono + +Per creare un oggetto in modo sincrono, assicurati che il tuo provider non ritorni un Future: + + + +Quando un provider crea un oggetto in modo sincrono, questo impatta come quell'oggetto verrà consumato. +In particolare, i valori sincroni non sono contenuti in un "AsyncValue": + + + +La conseguenza di questa differenza è che se il tuo provider lancia un'eccezione, +provare a leggere il valore ricauserà l'errore. +In alternativa, quando si usa `ref.listen`, la callback "onError" sarà invocata. + +### Considerazioni sugli oggetti "Listenable" + + + +Gli oggetti Listenable come `ChangeNotifier` or `StateNotifier` non sono supportati. +Se, per motivi di compatibilità, è necessario interagire con uno di questi oggetti, +un workaround consiste nel collegare il loro meccanismo di notifica a Riverpod. + + + +:::info +Nel caso in cui tu abbia bisogno di questa logica molte volte, è importante notare che +la logica è condivisa! L'oggetto "ref" è progettato per essere componibile. +Ciò consente di estrarre la logica di dispose/ascolto dal provider: + + +::: + + + + + +Quando non si utilizza la generazione di codice, Riverpod offre provider "legacy" +per supportare `ChangeNotifier` e `StateNotifier` direttamente: `ChangeNotifierProvider` and `StateNotifierProvider`. +Usarli è simile ad usare altri tipi di provider. La differenza principale è +che entrambi ascolteranno e smaltiranno automaticamente dell'oggetto restituito. + +Questi provider non sono consigliati per nuova logica di business. +Ma possono essere d'aiuto quando si interagisce con codice vecchio, come +durante una migrazione da `pkg:provider` a Riverpod. + + + + + +## Ascoltare uno Stream + +Un caso d'uso comune delle moderne applicazioni è interagire con websockets, +come Firbase o GraphQL subscriptions. +Interagire con queste API è spesso fatto ascoltando uno `Stream`. + +Per aiutarci in tale scopo, Riverpod supporta di natura gli oggetti `Stream`. +Come con i `Future`, l'oggetto verrà convertito in un `AsyncValue`: + + + +:::info +Riverpod non è consapevole delle implementazioni personalizzate di `Stream`, +come ad esempio `BehaviorSubject` di RX. +Pertanto, restituire un `BehaviorSubject` non esporrà il valore +in modo sincrono ai widget, anche se è già disponibile alla creazione. +::: + +Di default, Riverpod convertirà `Stream` e `Future` in `AsyncValue`. +Anche se raramente necessario, è possibile disattivare questo comportamento +wrappando il tipo del valore di ritorno in un typedef `Raw`. + +:::caution +È generalmente sconsigliato disabilitare la conversione in `AsyncValue`. +Fallo solo se sai quello che stai facendo. +::: + + diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart new file mode 100644 index 000000000..64a191f69 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart @@ -0,0 +1,11 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ +final myProvider = ChangeNotifierProvider>((ref) { + // Ascolterà ed eliminerà ValueNotifier + // I widget possono quindi "ref.watch" questo provider per ascoltarne gli aggiornamenti. + return ValueNotifier(0); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart new file mode 100644 index 000000000..7f3a0ea76 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart @@ -0,0 +1,22 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'pipe_change_notifier.g.dart'; + +/* SNIPPET START */ +/// A provider which creates a ValueNotifier and update its listeners +/// whenever the value changes. +@riverpod +Raw> myListenable(MyListenableRef ref) { + final notifier = ValueNotifier(0); + + // Smaltiamo il notifier quando il provider viene distrutto + ref.onDispose(notifier.dispose); + + // Notifica i listener di questo provider ogni volta che il ValueNotifier si aggiorna. + notifier.addListener(ref.notifyListeners); + + return notifier; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart new file mode 100644 index 000000000..8f0d894c9 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -0,0 +1,83 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'pipe_change_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +/// A provider which creates a ValueNotifier and update its listeners +/// whenever the value changes. +typedef MyListenableRef = Ref>>; + +/// A provider which creates a ValueNotifier and update its listeners +/// whenever the value changes. +@ProviderFor(myListenable) +const myListenableProvider = MyListenableProvider._(); + +/// A provider which creates a ValueNotifier and update its listeners +/// whenever the value changes. +final class MyListenableProvider extends $FunctionalProvider< + Raw>, + Raw>, + MyListenableRef> with $Provider>, MyListenableRef> { + /// A provider which creates a ValueNotifier and update its listeners + /// whenever the value changes. + const MyListenableProvider._( + {Raw> Function( + MyListenableRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myListenableProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + MyListenableRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$myListenableHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @$internal + @override + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + MyListenableProvider $copyWithCreate( + Raw> Function( + MyListenableRef ref, + ) create, + ) { + return MyListenableProvider._(create: create); + } + + @override + Raw> create(MyListenableRef ref) { + final _$cb = _createCb ?? myListenable; + return _$cb(ref); + } +} + +String _$myListenableHash() => r'c80799a0224092668fca44187b98ccfcd2b33ae1'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart new file mode 100644 index 000000000..6a25e47a5 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart @@ -0,0 +1,30 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'raw_usage.g.dart'; + +/* SNIPPET START */ +@riverpod +Raw> rawStream(RawStreamRef ref) { + // "Raw" è un typedef. Non c'è bisogno di wrappare + // il valore di ritorno in un costruttore "Raw". + return const Stream.empty(); +} + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // Il valore non è più convertito in AsyncValue + // e lo stream creato è ritornato come tale. + Stream stream = ref.watch(rawStreamProvider); + return StreamBuilder( + stream: stream, + builder: (context, snapshot) { + return Text('${snapshot.data}'); + }, + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart new file mode 100644 index 000000000..60959986e --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart @@ -0,0 +1,75 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'raw_usage.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RawStreamRef = Ref>>; + +@ProviderFor(rawStream) +const rawStreamProvider = RawStreamProvider._(); + +final class RawStreamProvider extends $FunctionalProvider< + Raw>, + Raw>, + RawStreamRef> with $Provider>, RawStreamRef> { + const RawStreamProvider._( + {Raw> Function( + RawStreamRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'rawStreamProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + RawStreamRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$rawStreamHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @$internal + @override + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + RawStreamProvider $copyWithCreate( + Raw> Function( + RawStreamRef ref, + ) create, + ) { + return RawStreamProvider._(create: create); + } + + @override + Raw> create(RawStreamRef ref) { + final _$cb = _createCb ?? rawStream; + return _$cb(ref); + } +} + +String _$rawStreamHash() => r'7e7c2e8f4f08d33a4d86d60449e143c419ca4822'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart new file mode 100644 index 000000000..915f5a03c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart @@ -0,0 +1,28 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'shared_pipe_change_notifier.g.dart'; + +/* SNIPPET START */ +extension on Ref { + // Possiamo spostare la logica precedente in una estensione Ref. + // Questo abilita il riutilizzo della logica + T disposeAndListenChangeNotifier(T notifier) { + onDispose(notifier.dispose); + notifier.addListener(notifyListeners); + // Restituiamo il notifier per facilitarne di un poco l'utilizzo + return notifier; + } +} + +@riverpod +Raw> myListenable(MyListenableRef ref) { + return ref.disposeAndListenChangeNotifier(ValueNotifier(0)); +} + +@riverpod +Raw> anotherListenable(AnotherListenableRef ref) { + return ref.disposeAndListenChangeNotifier(ValueNotifier(42)); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart new file mode 100644 index 000000000..ebffc98b1 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -0,0 +1,136 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'shared_pipe_change_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef MyListenableRef = Ref>>; + +@ProviderFor(myListenable) +const myListenableProvider = MyListenableProvider._(); + +final class MyListenableProvider extends $FunctionalProvider< + Raw>, + Raw>, + MyListenableRef> with $Provider>, MyListenableRef> { + const MyListenableProvider._( + {Raw> Function( + MyListenableRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myListenableProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + MyListenableRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$myListenableHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @$internal + @override + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + MyListenableProvider $copyWithCreate( + Raw> Function( + MyListenableRef ref, + ) create, + ) { + return MyListenableProvider._(create: create); + } + + @override + Raw> create(MyListenableRef ref) { + final _$cb = _createCb ?? myListenable; + return _$cb(ref); + } +} + +String _$myListenableHash() => r'90f4227ef5442f978d742115663e5f0869622a27'; + +typedef AnotherListenableRef = Ref>>; + +@ProviderFor(anotherListenable) +const anotherListenableProvider = AnotherListenableProvider._(); + +final class AnotherListenableProvider extends $FunctionalProvider< + Raw>, Raw>, AnotherListenableRef> + with $Provider>, AnotherListenableRef> { + const AnotherListenableProvider._( + {Raw> Function( + AnotherListenableRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'anotherListenableProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + AnotherListenableRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$anotherListenableHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @$internal + @override + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + AnotherListenableProvider $copyWithCreate( + Raw> Function( + AnotherListenableRef ref, + ) create, + ) { + return AnotherListenableProvider._(create: create); + } + + @override + Raw> create(AnotherListenableRef ref) { + final _$cb = _createCb ?? anotherListenable; + return _$cb(ref); + } +} + +String _$anotherListenableHash() => r'50dd36b21e07c50818944ec49f9e68d21fcae876'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart new file mode 100644 index 000000000..9c77a0f3d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart @@ -0,0 +1,34 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Stream streamExample(StreamExampleRef ref) async* { + // Ogni secondo ritorna un numero da 0 a 41. + // Questo può essere sostituito con uno Stream da Firestore o GraphQL o altro. + for (var i = 0; i < 42; i++) { + yield i; + await Future.delayed(const Duration(seconds: 1)); + } +} + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // Lo stream è ascoltato e convertito in un AsyncValue + AsyncValue value = ref.watch(streamExampleProvider); + + // Possiamo usare l'AsyncValue per gestire i stati di caricamento/errore e mostrare il dato. + return switch (value) { + AsyncValue(:final error?) => Text('Error: $error'), + AsyncValue(:final valueOrNull?) => Text('$valueOrNull'), + _ => const CircularProgressIndicator(), + }; + } +} +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart new file mode 100644 index 000000000..eabd579e0 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef StreamExampleRef = Ref>; + +@ProviderFor(streamExample) +const streamExampleProvider = StreamExampleProvider._(); + +final class StreamExampleProvider + extends $FunctionalProvider, Stream, StreamExampleRef> + with $FutureModifier, $StreamProvider { + const StreamExampleProvider._( + {Stream Function( + StreamExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'streamExampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + StreamExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$streamExampleHash(); + + @$internal + @override + $StreamProviderElement $createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + StreamExampleProvider $copyWithCreate( + Stream Function( + StreamExampleRef ref, + ) create, + ) { + return StreamExampleProvider._(create: create); + } + + @override + Stream create(StreamExampleRef ref) { + final _$cb = _createCb ?? streamExample; + return _$cb(ref); + } +} + +String _$streamExampleHash() => r'ca9993b22f6d587b20c041133cacd28d01933074'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts new file mode 100644 index 000000000..4ee159de8 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts @@ -0,0 +1,4 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { raw, codegen }; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart new file mode 100644 index 000000000..f77435546 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart @@ -0,0 +1,30 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final streamExampleProvider = StreamProvider.autoDispose((ref) async* { + // Ogni secondo ritorna un numero da 0 a 41. + // Questo può essere sostituito con uno Stream da Firestore o GraphQL o altro. + for (var i = 0; i < 42; i++) { + yield i; + await Future.delayed(const Duration(seconds: 1)); + } +}); + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // Lo stream è ascoltato e convertito in un AsyncValue + AsyncValue value = ref.watch(streamExampleProvider); + + // Possiamo usare l'AsyncValue per gestire i stati di caricamento/errore e mostrare il dato. + return switch (value) { + AsyncValue(:final error?) => Text('Error: $error'), + AsyncValue(:final valueOrNull?) => Text('$valueOrNull'), + _ => const CircularProgressIndicator(), + }; + } +} +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart new file mode 100644 index 000000000..bf4aa03f7 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart @@ -0,0 +1,19 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'sync_definition/raw.dart'; + +void main() { +/* SNIPPET START */ + Consumer( + builder: (context, ref, child) { + // Il valore non è contenuto in un "AsyncValue" + int value = ref.watch(synchronousExampleProvider); + + return Text('$value'); + }, + ); +/* SNIPPET END */ +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart new file mode 100644 index 000000000..dbccd14aa --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart @@ -0,0 +1,10 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +int synchronousExample(SynchronousExampleRef ref) { + return 0; +} +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart new file mode 100644 index 000000000..ffc21fd38 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef SynchronousExampleRef = Ref; + +@ProviderFor(synchronousExample) +const synchronousExampleProvider = SynchronousExampleProvider._(); + +final class SynchronousExampleProvider + extends $FunctionalProvider + with $Provider { + const SynchronousExampleProvider._( + {int Function( + SynchronousExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'synchronousExampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + SynchronousExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$synchronousExampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + SynchronousExampleProvider $copyWithCreate( + int Function( + SynchronousExampleRef ref, + ) create, + ) { + return SynchronousExampleProvider._(create: create); + } + + @override + int create(SynchronousExampleRef ref) { + final _$cb = _createCb ?? synchronousExample; + return _$cb(ref); + } +} + +String _$synchronousExampleHash() => + r'98df96e07d554683041f668c06b36f183ff534c1'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts new file mode 100644 index 000000000..4ee159de8 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts @@ -0,0 +1,4 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { raw, codegen }; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart new file mode 100644 index 000000000..193c5eeff --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart @@ -0,0 +1,7 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +final synchronousExampleProvider = Provider.autoDispose((ref) { + return 0; +}); +/* SNIPPET END */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.dart new file mode 100644 index 000000000..4d49c552a --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.dart @@ -0,0 +1,11 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family.g.dart'; +/* SNIPPET START */ + +@riverpod +int random(RandomRef ref, {required int seed, required int max}) { + return Random(seed).nextInt(max); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart new file mode 100644 index 000000000..f53a38413 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart @@ -0,0 +1,168 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RandomRef = Ref; + +@ProviderFor(random) +const randomProvider = RandomFamily._(); + +final class RandomProvider extends $FunctionalProvider + with $Provider { + const RandomProvider._( + {required RandomFamily super.from, + required ({ + int seed, + int max, + }) + super.argument, + int Function( + RandomRef ref, { + required int seed, + required int max, + })? create}) + : _createCb = create, + super( + name: r'randomProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + RandomRef ref, { + required int seed, + required int max, + })? _createCb; + + @override + String debugGetCreateSourceHash() => _$randomHash(); + + @override + String toString() { + return r'randomProvider' + '' + '$argument'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RandomProvider $copyWithCreate( + int Function( + RandomRef ref, + ) create, + ) { + return RandomProvider._( + argument: argument as ({ + int seed, + int max, + }), + from: from! as RandomFamily, + create: ( + ref, { + required int seed, + required int max, + }) => + create(ref)); + } + + @override + int create(RandomRef ref) { + final _$cb = _createCb ?? random; + final argument = this.argument as ({ + int seed, + int max, + }); + return _$cb( + ref, + seed: argument.seed, + max: argument.max, + ); + } + + @override + bool operator ==(Object other) { + return other is RandomProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$randomHash() => r'517b12aad4df7b31f8872b89af74e7880377b2ea'; + +final class RandomFamily extends Family { + const RandomFamily._() + : super( + name: r'randomProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + RandomProvider call({ + required int seed, + required int max, + }) => + RandomProvider._(argument: ( + seed: seed, + max: max, + ), from: this); + + @override + String debugGetCreateSourceHash() => _$randomHash(); + + @override + String toString() => r'randomProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + int Function( + RandomRef ref, + ({ + int seed, + int max, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as RandomProvider; + + final argument = provider.argument as ({ + int seed, + int max, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx new file mode 100644 index 000000000..fa391f61a --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./family.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart new file mode 100644 index 000000000..e1977b568 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart @@ -0,0 +1,27 @@ +import 'dart:math'; + +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod/riverpod.dart'; + +@immutable +abstract class Equatable { + const Equatable(); + + List get props; +} + +/* SNIPPET START */ +class ParamsType extends Equatable { + const ParamsType({required this.seed, required this.max}); + + final int seed; + final int max; + + @override + List get props => [seed, max]; +} + +final randomProvider = + Provider.family.autoDispose((ref, params) { + return Random(params.seed).nextInt(params.max); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart new file mode 100644 index 000000000..1082ef6f3 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart @@ -0,0 +1,12 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; + +import 'json.dart'; + +part 'item.freezed.dart'; +part 'item.g.dart'; + +@freezed +class Item with _$Item { + const factory Item({required int id}) = _Item; + factory Item.fromJson(Json json) => _$ItemFromJson(json); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart new file mode 100644 index 000000000..e578c8154 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart @@ -0,0 +1,146 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'item.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Item _$ItemFromJson(Map json) { + return _Item.fromJson(json); +} + +/// @nodoc +mixin _$Item { + int get id => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ItemCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ItemCopyWith<$Res> { + factory $ItemCopyWith(Item value, $Res Function(Item) then) = + _$ItemCopyWithImpl<$Res, Item>; + @useResult + $Res call({int id}); +} + +/// @nodoc +class _$ItemCopyWithImpl<$Res, $Val extends Item> + implements $ItemCopyWith<$Res> { + _$ItemCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as int, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ItemImplCopyWith<$Res> implements $ItemCopyWith<$Res> { + factory _$$ItemImplCopyWith( + _$ItemImpl value, $Res Function(_$ItemImpl) then) = + __$$ItemImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({int id}); +} + +/// @nodoc +class __$$ItemImplCopyWithImpl<$Res> + extends _$ItemCopyWithImpl<$Res, _$ItemImpl> + implements _$$ItemImplCopyWith<$Res> { + __$$ItemImplCopyWithImpl(_$ItemImpl _value, $Res Function(_$ItemImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + }) { + return _then(_$ItemImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as int, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ItemImpl implements _Item { + const _$ItemImpl({required this.id}); + + factory _$ItemImpl.fromJson(Map json) => + _$$ItemImplFromJson(json); + + @override + final int id; + + @override + String toString() { + return 'Item(id: $id)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ItemImpl && + (identical(other.id, id) || other.id == id)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, id); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ItemImplCopyWith<_$ItemImpl> get copyWith => + __$$ItemImplCopyWithImpl<_$ItemImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ItemImplToJson( + this, + ); + } +} + +abstract class _Item implements Item { + const factory _Item({required final int id}) = _$ItemImpl; + + factory _Item.fromJson(Map json) = _$ItemImpl.fromJson; + + @override + int get id; + @override + @JsonKey(ignore: true) + _$$ItemImplCopyWith<_$ItemImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart new file mode 100644 index 000000000..3c653e18c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart @@ -0,0 +1,18 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'item.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ItemImpl _$$ItemImplFromJson(Map json) => _$ItemImpl( + id: json['id'] as int, + ); + +Map _$$ItemImplToJson(_$ItemImpl instance) => + { + 'id': instance.id, + }; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart new file mode 100644 index 000000000..17cfb1c01 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart @@ -0,0 +1 @@ +typedef Json = Map; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart new file mode 100644 index 000000000..802a23150 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart @@ -0,0 +1,29 @@ +import 'package:collection/collection.dart'; +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; +import '../../helpers/json.dart'; + +part 'async_values.g.dart'; + +/* SNIPPET START */ + +@riverpod +Future> itemsApi(ItemsApiRef ref) async { + final client = Dio(); + final result = await client.get>('your-favorite-api'); + final parsed = [...result.data!.map((e) => Item.fromJson(e as Json))]; + return parsed; +} + +@riverpod +List evenItems(EvenItemsRef ref) { + final asyncValue = ref.watch(itemsApiProvider); + if (asyncValue.isReloading) return []; + if (asyncValue.hasError) return const [Item(id: -1)]; + + final items = asyncValue.requireValue; + + return [...items.whereIndexed((index, element) => index.isEven)]; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart new file mode 100644 index 000000000..ae3227615 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart @@ -0,0 +1,126 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_values.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ItemsApiRef = Ref>>; + +@ProviderFor(itemsApi) +const itemsApiProvider = ItemsApiProvider._(); + +final class ItemsApiProvider extends $FunctionalProvider>, + FutureOr>, ItemsApiRef> + with $FutureModifier>, $FutureProvider, ItemsApiRef> { + const ItemsApiProvider._( + {FutureOr> Function( + ItemsApiRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'itemsApiProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + ItemsApiRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$itemsApiHash(); + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ItemsApiProvider $copyWithCreate( + FutureOr> Function( + ItemsApiRef ref, + ) create, + ) { + return ItemsApiProvider._(create: create); + } + + @override + FutureOr> create(ItemsApiRef ref) { + final _$cb = _createCb ?? itemsApi; + return _$cb(ref); + } +} + +String _$itemsApiHash() => r'b32ccb7b85305e361d8ed752cbe11d9524c96190'; + +typedef EvenItemsRef = Ref>; + +@ProviderFor(evenItems) +const evenItemsProvider = EvenItemsProvider._(); + +final class EvenItemsProvider + extends $FunctionalProvider, List, EvenItemsRef> + with $Provider, EvenItemsRef> { + const EvenItemsProvider._( + {List Function( + EvenItemsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'evenItemsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + EvenItemsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$evenItemsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + EvenItemsProvider $copyWithCreate( + List Function( + EvenItemsRef ref, + ) create, + ) { + return EvenItemsProvider._(create: create); + } + + @override + List create(EvenItemsRef ref) { + final _$cb = _createCb ?? evenItems; + return _$cb(ref); + } +} + +String _$evenItemsHash() => r'55ae98f9b6108203dfc4a139f1ade9fbd8ba8ddd'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx new file mode 100644 index 000000000..526f2dffe --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./async_values.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart new file mode 100644 index 000000000..f21a954e5 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart @@ -0,0 +1,25 @@ +import 'package:collection/collection.dart'; +import 'package:dio/dio.dart'; +import 'package:riverpod/riverpod.dart'; + +import '../../helpers/item.dart'; +import '../../helpers/json.dart'; + +/* SNIPPET START */ + +final itemsApiProvider = FutureProvider.autoDispose((ref) async { + final client = Dio(); + final result = await client.get>('your-favorite-api'); + final parsed = [...result.data!.map((e) => Item.fromJson(e as Json))]; + return parsed; +}); + +final evenItemsProvider = Provider.autoDispose((ref) { + final asyncValue = ref.watch(itemsApiProvider); + if (asyncValue.isLoading) return []; + if (asyncValue.hasError) return const [Item(id: -1)]; + + final items = asyncValue.requireValue; + + return [...items.whereIndexed((index, element) => index.isEven)]; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart new file mode 100644 index 000000000..079e29de2 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart @@ -0,0 +1,28 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'auto_dispose.g.dart'; + +/* SNIPPET START */ + +// Con la generazione di codice, un provider è .autoDispose di default +@riverpod +int diceRoll(DiceRollRef ref) { + // Poiché questo provider è .autoDispose, smettere di ascoltarlo ne disporrà lo stato esposto attuale. + // Quindi, ogni volta che questo provider viene ascoltato di nuovo, + // verrà tirato un nuovo dado e lo stato verrà esposto di nuovo. + final dice = Random().nextInt(10); + return dice; +} + +@riverpod +int cachedDiceRoll(CachedDiceRollRef ref) { + final coin = Random().nextInt(10); + if (coin > 5) throw Exception('Way too large.'); + // La condizione sopra potrebbe fallire; + // Se non lo fa, l'istruzione seguente dice al Provider + // di mantenere il suo stato in cache, *anche quando nessuno lo ascolta più*. + ref.keepAlive(); + return coin; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart new file mode 100644 index 000000000..4baf88906 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -0,0 +1,132 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'auto_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef DiceRollRef = Ref; + +@ProviderFor(diceRoll) +const diceRollProvider = DiceRollProvider._(); + +final class DiceRollProvider extends $FunctionalProvider + with $Provider { + const DiceRollProvider._( + {int Function( + DiceRollRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'diceRollProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + DiceRollRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$diceRollHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DiceRollProvider $copyWithCreate( + int Function( + DiceRollRef ref, + ) create, + ) { + return DiceRollProvider._(create: create); + } + + @override + int create(DiceRollRef ref) { + final _$cb = _createCb ?? diceRoll; + return _$cb(ref); + } +} + +String _$diceRollHash() => r'dfd5ac8b74351a0076da9d131c10277f53ff11b9'; + +typedef CachedDiceRollRef = Ref; + +@ProviderFor(cachedDiceRoll) +const cachedDiceRollProvider = CachedDiceRollProvider._(); + +final class CachedDiceRollProvider + extends $FunctionalProvider + with $Provider { + const CachedDiceRollProvider._( + {int Function( + CachedDiceRollRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'cachedDiceRollProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CachedDiceRollRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$cachedDiceRollHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CachedDiceRollProvider $copyWithCreate( + int Function( + CachedDiceRollRef ref, + ) create, + ) { + return CachedDiceRollProvider._(create: create); + } + + @override + int create(CachedDiceRollRef ref) { + final _$cb = _createCb ?? cachedDiceRoll; + return _$cb(ref); + } +} + +String _$cachedDiceRollHash() => r'fc31fcb804f10360d75362e56329976343ee7abb'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx new file mode 100644 index 000000000..6c57cfffd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./auto_dispose.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart new file mode 100644 index 000000000..b1498e2dc --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart @@ -0,0 +1,23 @@ +import 'dart:math'; + +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ + +final diceRollProvider = Provider.autoDispose((ref) { + // Poiché questo provider è .autoDispose, smettere di ascoltarlo ne disporrà lo stato esposto attuale. + // Quindi, ogni volta che questo provider viene ascoltato di nuovo, + // verrà tirato un nuovo dado e lo stato verrà esposto di nuovo. + final dice = Random().nextInt(10); + return dice.isEven; +}); + +final cachedDiceRollProvider = Provider.autoDispose((ref) { + final coin = Random().nextInt(10); + if (coin > 5) throw Exception('Way too large.'); + // La condizione sopra potrebbe fallire; + // Se non lo fa, l'istruzione seguente dice al Provider + // di mantenere il suo stato in cache, *anche quando nessuno lo ascolta più*. + ref.keepAlive(); + return coin.isEven; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart new file mode 100644 index 000000000..ecd1915da --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart @@ -0,0 +1,19 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'combine.g.dart'; + +/* SNIPPET START */ + +@riverpod +int number(NumberRef ref) { + return Random().nextInt(10); +} + +@riverpod +int doubled(DoubledRef ref) { + final number = ref.watch(numberProvider); + + return number * 2; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart new file mode 100644 index 000000000..ef5a1884c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart @@ -0,0 +1,131 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'combine.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef NumberRef = Ref; + +@ProviderFor(number) +const numberProvider = NumberProvider._(); + +final class NumberProvider extends $FunctionalProvider + with $Provider { + const NumberProvider._( + {int Function( + NumberRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'numberProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + NumberRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$numberHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + NumberProvider $copyWithCreate( + int Function( + NumberRef ref, + ) create, + ) { + return NumberProvider._(create: create); + } + + @override + int create(NumberRef ref) { + final _$cb = _createCb ?? number; + return _$cb(ref); + } +} + +String _$numberHash() => r'725e25be57b9cc2bd914752f156e26a214596b63'; + +typedef DoubledRef = Ref; + +@ProviderFor(doubled) +const doubledProvider = DoubledProvider._(); + +final class DoubledProvider extends $FunctionalProvider + with $Provider { + const DoubledProvider._( + {int Function( + DoubledRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'doubledProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + DoubledRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$doubledHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DoubledProvider $copyWithCreate( + int Function( + DoubledRef ref, + ) create, + ) { + return DoubledProvider._(create: create); + } + + @override + int create(DoubledRef ref) { + final _$cb = _createCb ?? doubled; + return _$cb(ref); + } +} + +String _$doubledHash() => r'ddc640c876bdbe49fe72fe1632b5ff48687c9279'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx new file mode 100644 index 000000000..2ff7dfbaa --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./combine.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart new file mode 100644 index 000000000..1b8412dd0 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart @@ -0,0 +1,15 @@ +import 'dart:math'; + +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ + +final numberProvider = Provider.autoDispose((ref) { + return Random().nextInt(10); +}); + +final doubledProvider = Provider.autoDispose((ref) { + final number = ref.watch(numberProvider); + + return number * 2; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx new file mode 100644 index 000000000..aadb58d49 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx @@ -0,0 +1,189 @@ +--- +title: Motivazione +--- + +import sameType from "./same_type"; +import combine from "./combine"; +import asyncValues from "./async_values"; +import autoDispose from "./auto_dispose"; +import override from "./override"; +import sideEffects from "./side_effects"; +import { + AutoSnippet, +} from "../../../../../../src/components/CodeSnippet"; + +Questo articolo dettagliato è pensato per spiegare perché Riverpod esiste. + +In particolare, questa sezione dovrebbe rispondere alle seguenti domande: +- Dato che Provider è ampiamente popolare, perché si dovrebbe migrare a Riverpod? +- Quali vantaggi concreti si ottengono? +- Come posso migrare a Riverpod? +- Posso migrare in modo incrementale? +- ecc. + +Alla fine di questa sezione dovresti essere convinto che Riverpod è da preferire rispetto a Provider. + +**Riverpod è davvero un approccio più moderno, raccomandato e affidabile rispetto a Provider**. + +Riverpod offre migliori capacità di gestione dello stato, migliori strategie di caching e un modello di reattività semplificato. +Mentre Provider attualmente presenta molte carenze senza una via d'uscita. + +## Limitazioni di Provider +Provider ha problemi fondamentali dovuti alla restrizione dell'API di InheritedWidget. +Intrinsecamente, Provider è un "`InheritedWidget` più semplice"; +Provider è solo un wrapper di InheritedWidget, ed è quindi limitato da esso. + +Ecco un elenco di problemi noti di Provider. + +### Provider non può gestire due (o più) provider dello stesso "tipo". +Dichiarare due `Provider` porterà a un comportamento non affidabile: l'API di `InheritedWidget` +otterrà solo *uno dei due*: l'antenato `Provider` più vicino. +Sebbene [un workaround] sia spiegato nella documentazione di Provider, Riverpod semplicemente non presenta questo problema. + +Eliminando questa limitazione, possiamo suddividere liberamente la logica in piccole parti, come segue: + + + +### I provider emettono ragionevolmente solo un valore alla volta +Quando si legge un'API esterna RESTful, è abbastanza comune mostrare l'ultimo valore letto +mentre una nuova chiamata carica il successivo. +Riverpod consente questo comportamento emettendo due valori contemporaneamente (ossia un valore di dati precedenti +e un nuovo valore di caricamento in arrivo) tramite le API di `AsyncValue`: + + + +Nello snippet precedente, osservando `evenItemsProvider` si avranno i seguenti effetti: +1. Inizialmente, viene effettuata la richiesta. Otteniamo una lista vuota; +2. Poi, diciamo che si verifica un errore. Otteniamo `[Item(id: -1)]`; +3. Quindi, riproviamo la richiesta con una logica di pull-to-refresh (ad esempio tramite `ref.invalidate`); +4. Mentre ricarichiamo il primo provider, il secondo continua a esporre `[Item(id: -1)]`; +5. Questa volta, alcuni dati processati vengono ricevuti correttamente: i nostri elementi pari vengono restituiti correttamente. + +Con Provider, le caratteristiche sopra menzionate non sono lontanamente realizzabili, e ancor meno facili da aggirare. + +### Combinare i provider è difficile e soggetto a errori +Con Provider potremmo essere tentati di utilizzare `context.watch` all'interno del metodo `create` del provider. +Questo sarebbe inaffidabile, poiché `didChangeDependencies` potrebbe essere attivato anche se nessuna dipendenza +è cambiata (ad esempio quando è coinvolta una GlobalKey nell'albero dei widget). + +Tuttavia, Provider ha una soluzione ad hoc chiamata ProxyProvider, ma è considerata tediosa e soggetta a errori. + +La combinazione dello stato è un meccanismo fondamentale di Riverpod, poiché possiamo combinare e memorizzare +valori reattivamente senza alcun overhead con utilità semplici ma potenti come [ref.watch] e [ref.listen]: + + + +La combinazione dei valori viene naturale con Riverpod: le dipendenze sono leggibili e le API rimangono le stesse. + +### Mancanza di sicurezza +Con Provider, è comune trovarsi con un'eccezione in fase di esecuzione come `ProviderNotFoundException` durante +ristrutturazioni e/o durante modifiche importanti. +Questa eccezione in fase di esecuzione *era* una delle principali ragioni per cui Riverpod è stato creato in primo luogo. + +Anche se Riverpod offre molte altre funzionalità, semplicemente non può generare questa eccezione. + +### La distruzione dello stato è difficile +`InheritedWidget` [non può reagire quando un consumatore smette di ascoltarlo]. +Questo impedisce a Provider di distruggere automaticamente lo stato dei suoi provider quando non vengono più utilizzati. +Con Provider, [dobbiamo] fare affidamento sulla creazione di provider per eliminare lo stato quando +smette di essere utilizzato. +Ma questo non è facile, soprattutto quando lo stato è condiviso tra le pagine. + +Riverpod risolve questo problema con API facili da capire come [autodispose] e [keepAlive]. +Queste due API consentono strategie di caching flessibili e creative (ad esempio, caching basato sul tempo): + + + +Sfortunatamente, non c'è modo di implementare questo con un `InheritedWidget` grezzo e quindi con Provider. + +### Mancanza di un meccanismo di parametrizzazione affidabile +Riverpod consente all'utente di dichiarare provider "parametrizzati" con il [modificatore .family]. +Infatti, `.family` è una delle caratteristiche più potenti di Riverpod ed è fondamentale per le sue innovazioni, +ad esempio consente un'enorme [semplificazione della logica]. + +Se volessimo implementare qualcosa di simile utilizzando Provider, +dovremmo rinunciare alla facilità d'uso *e* alla sicurezza dei tipi su tali parametri. + +Inoltre, non poter implementare un meccanismo simile a `.autoDispose` con Provider +impedisce intrinsecamente la possibilità di una implementazione equivalente di `.family`, [poiché queste due funzionalità vanno di pari passo]. + +Infine, come mostrato in precedenza, [risulta che] i widget *non smettono mai* di ascoltare un `InheritedWidget`. +Ciò comporta gravi perdite di memoria se lo stato di alcuni provider viene "montato dinamicamente", +ossia quando si utilizzano parametri per creare un Provider, che è esattamente ciò che fa `.family`. +Pertanto, ottenere un equivalente di `.family` per Provider è fondamentalmente impossibile al momento. + +### Testare è tedioso +Per poter scrivere un test, *è necessario* ridefinire i provider all'interno di ogni test. + +Con Riverpod, i provider sono pronti per essere utilizzati all'interno dei test di default. +Inoltre, Riverpod espone una pratica collezione di utilità di "sovrascrittura" che sono cruciali quando si simulano i provider. + +Testare il codice dello stato combinato sarebbe semplice come segue: + + + +Per più informazioni riguardo ai test, vedere [Testing]. + +### Attivare effetti collaterali non è immediato +Poiché `InheritedWidget` non ha un callback `onChange`, Provider non può averne uno. +Questo è problematico per la navigazione, ad esempio per le snack bar, le modali, ecc. + +Invece, Riverpod offre semplicemente `ref.listen`, che [si integra bene con Flutter]. + + + +## Verso Riverpod +Dal punto di vista concettuale, Riverpod e Provider sono abbastanza simili. +Entrambi i pacchetti svolgono un ruolo simile. Entrambi cercano di: + +- memorizzare nella cache e smaltire oggetti con dello stato; +- offrire un modo per emulare tali oggetti durante i test; +- offrire un modo per i widget di ascoltare tali oggetti in modo semplice. + +Puoi pensare a Riverpod come a ciò che Provider avrebbe potuto diventare se fosse continuato a maturare per alcuni anni. + +### Perché un package separato? +Originariamente, era previsto un importante aggiornamento di Provider come soluzione ai problemi sopra menzionati. +Tuttavia, in seguito si è deciso di non farlo, poiché sarebbe stato "troppo incisivo" e persino controverso, +a causa della nuova API `ConsumerWidget`. +Poiché Provider è ancora uno dei pacchetti Flutter più utilizzati, è stato invece deciso +di creare un package separato, e così è nato Riverpod. + +La creazione di un package separato ha permesso: + - Una facilità di migrazione per chiunque voglia farlo, consentendo anche l'uso temporaneo di entrambi gli approcci, *nello stesso momento*; + - Di permettere alle persone di rimanere fedeli a Provider se non gradiscono Riverpod in principio o se non lo trovano ancora affidabile; + - Sperimentazione, consentendo a Riverpod di cercare soluzioni production-ready alle varie limitazioni tecniche di Provider. + +Infatti, Riverpod è progettato per essere il successore spirituale di Provider. Da qui il nome "Riverpod" (che è un anagramma di "Provider"). + +### La breaking change +L'unico vero svantaggio di Riverpod è che richiede la modifica del tipo di widget per funzionare: + +- Invece di estendere `StatelessWidget`, con Riverpod dovresti estendere `ConsumerWidget`. +- Invece di estendere `StatefulWidget`, con Riverpod dovresti estendere `ConsumerStatefulWidget`. + +Ma questa inconvenienza è piuttosto minore nel quadro generale. E questa richiesta potrebbe, un giorno, scomparire. + +### Scegliere la liberia giusta +Probabilmente ti stai chiedendo: +*"Quindi, come utente di Provider, dovrei usare Provider o Riverpod?"*. + +Vogliamo rispondere a questa domanda in modo molto chiaro: + + Probabilmente dovresti utilizzare Riverpod + +Riverpod è globalmente meglio progettato e potrebbe portare a semplificazioni drastiche della tua logica. + +[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider +[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[autodispose]: /docs/concepts/modifiers/auto_dispose +[workaround]: https://pub.dev/packages/provider#can-i-obtain-two-different-providers-using-the-same-type +[modifier .family]: /docs/concepts/modifiers/family +[keepAlive]: /docs/concepts/modifiers/auto_dispose#refkeepalive +[poiché queste due funzionalità vanno di pari passo]: /docs/concepts/modifiers/family#prefer-using-autodispose-when-the-parameter-is-not-constant +[semplificazione della logica]: /docs/concepts/modifiers/family#usage +[dobbiamo]: https://github.com/flutter/flutter/issues/128432 +[risulta che]: https://github.com/flutter/flutter/issues/106549 +[non può reagire quando un consumatore smette di ascoltarlo]: https://github.com/flutter/flutter/issues/106546 +[Testing]: /docs/cookbooks/testing +[si integra bene con Flutter]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx new file mode 100644 index 000000000..43ec56b51 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./override.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart new file mode 100644 index 000000000..860020903 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart @@ -0,0 +1,16 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../combine/combine.dart'; + +/* SNIPPET START */ + +void main() { + test('it doubles the value correctly', () async { + final container = ProviderContainer( + overrides: [numberProvider.overrideWith((ref) => 9)], + ); + final doubled = container.read(doubledProvider); + expect(doubled, 9 * 2); + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart new file mode 100644 index 000000000..860020903 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart @@ -0,0 +1,16 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../combine/combine.dart'; + +/* SNIPPET START */ + +void main() { + test('it doubles the value correctly', () async { + final container = ProviderContainer( + overrides: [numberProvider.overrideWith((ref) => 9)], + ); + final doubled = container.read(doubledProvider); + expect(doubled, 9 * 2); + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx new file mode 100644 index 000000000..8569e8316 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./same_type.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart new file mode 100644 index 000000000..1a2456978 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart @@ -0,0 +1,15 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod/riverpod.dart'; + +import '../../helpers/item.dart'; + +/* SNIPPET START */ + +final itemsProvider = Provider.autoDispose( + (ref) => [], // ... +); + +final evenItemsProvider = Provider.autoDispose((ref) { + final items = ref.watch(itemsProvider); + return [...items.whereIndexed((index, element) => index.isEven)]; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart new file mode 100644 index 000000000..94a4ab086 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart @@ -0,0 +1,19 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; + +part 'same_type.g.dart'; + +/* SNIPPET START */ + +@riverpod +List items(ItemsRef ref) { + return []; // ... +} + +@riverpod +List evenItems(EvenItemsRef ref) { + final items = ref.watch(itemsProvider); + return [...items.whereIndexed((index, element) => index.isEven)]; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart new file mode 100644 index 000000000..510d91a68 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart @@ -0,0 +1,133 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'same_type.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ItemsRef = Ref>; + +@ProviderFor(items) +const itemsProvider = ItemsProvider._(); + +final class ItemsProvider + extends $FunctionalProvider, List, ItemsRef> + with $Provider, ItemsRef> { + const ItemsProvider._( + {List Function( + ItemsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'itemsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + ItemsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$itemsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ItemsProvider $copyWithCreate( + List Function( + ItemsRef ref, + ) create, + ) { + return ItemsProvider._(create: create); + } + + @override + List create(ItemsRef ref) { + final _$cb = _createCb ?? items; + return _$cb(ref); + } +} + +String _$itemsHash() => r'f0a8fa6874f4868db9ead31e82c75d976f9d2033'; + +typedef EvenItemsRef = Ref>; + +@ProviderFor(evenItems) +const evenItemsProvider = EvenItemsProvider._(); + +final class EvenItemsProvider + extends $FunctionalProvider, List, EvenItemsRef> + with $Provider, EvenItemsRef> { + const EvenItemsProvider._( + {List Function( + EvenItemsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'evenItemsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + EvenItemsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$evenItemsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + EvenItemsProvider $copyWithCreate( + List Function( + EvenItemsRef ref, + ) create, + ) { + return EvenItemsProvider._(create: create); + } + + @override + List create(EvenItemsRef ref) { + final _$cb = _createCb ?? evenItems; + return _$cb(ref); + } +} + +String _$evenItemsHash() => r'82b4525e91604745f2b4664531b32d4aff5717d4'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx new file mode 100644 index 000000000..f4797a94f --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./side_effects.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart new file mode 100644 index 000000000..61f016870 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart @@ -0,0 +1,24 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../auto_dispose/auto_dispose.dart'; + +/* SNIPPET START */ + +class DiceRollWidget extends ConsumerWidget { + const DiceRollWidget({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(diceRollProvider, (previous, next) { + ScaffoldMessenger.of(context).showSnackBar( + SnackBar(content: Text('Dice roll! We got: $next')), + ); + }); + return TextButton.icon( + onPressed: () => ref.invalidate(diceRollProvider), + icon: const Icon(Icons.casino), + label: const Text('Roll a dice'), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart new file mode 100644 index 000000000..61f016870 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart @@ -0,0 +1,24 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../auto_dispose/auto_dispose.dart'; + +/* SNIPPET START */ + +class DiceRollWidget extends ConsumerWidget { + const DiceRollWidget({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(diceRollProvider, (previous, next) { + ScaffoldMessenger.of(context).showSnackBar( + SnackBar(content: Text('Dice roll! We got: $next')), + ); + }); + return TextButton.icon( + onPressed: () => ref.invalidate(diceRollProvider), + icon: const Icon(Icons.casino), + label: const Text('Roll a dice'), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx new file mode 100644 index 000000000..dff3aaa22 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx @@ -0,0 +1,401 @@ +--- +title: Provider vs Riverpod +--- + +import family from "./family"; +import { + AutoSnippet, +} from "../../../../../src/components/CodeSnippet"; + +Questo articolo riepiloga le differenze e le somiglianze tra Provider e Riverpod. + +## Definire i provider +La differenza principale tra entrambi i package riguarda come vengono definiti i "provider". + +Con [Provider], i provider sono widget e, come tali, vengono inseriti all'interno dell'albero dei widget, +di solito all'interno di un `MultiProvider`: + +```dart +class Counter extends ChangeNotifier { + ... +} + +void main() { + runApp( + MultiProvider( + providers: [ + ChangeNotifierProvider(create: (context) => Counter()), + ], + child: MyApp(), + ) + ); +} +``` + +Con Riverpod, i provider **non** sono widget. Invece, sono semplici oggetti Dart. +Allo stesso modo, i provider sono definiti al di fuori dell'albero dei widget e +vengono dichiarati come variabili finali globali. + +Inoltre, affinché Riverpod funzioni, è necessario aggiungere un widget `ProviderScope` sopra l'intera applicazione. +Di conseguenza, l'equivalente dell'esempio con Provider utilizzando Riverpod sarebbe: + +```dart +// I provider sono ora variabili top-level +final counterProvider = ChangeNotifierProvider((ref) => Counter()); + +void main() { + runApp( + // Questo widget attiva Riverpod sull'intero progetto + ProviderScope( + child: MyApp(), + ), + ); +} +``` + +Nota come la definizione del provider si sia semplicemente spostata di alcune righe. + +:::info +Poiché con Riverpod i provider sono semplici oggetti Dart, è possibile utilizzare Riverpod senza Flutter. +Ad esempio, Riverpod può essere utilizzato per scrivere applicazioni a riga di comando. +::: + +## Leggere i provider: BuildContext +Con Provider, un modo per leggere i provider è utilizzare il `BuildContext` di un widget. + +Ad esempio, se un provider è definito come: + +```dart +Provider(...); +``` + +il modo per leggerlo con [Provider] sarà scritto come + +```dart +class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + Model model = context.watch(); + + } +} +``` + +L'equivalente in Riverpod sarebbe: + +```dart +final modelProvider = Provider(...); + +class Example extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + Model model = ref.watch(modelProvider); + + } +} +``` + +Nota come: + +- Lo snippet di Riverpod estende `ConsumerWidget` invece di `StatelessWidget`. + Questo tipo di widget aggiunge un parametro in più alla nostra funzione `build`: `WidgetRef`. + +- Invece di `BuildContext.watch`, in Riverpod scriveremo `WidgetRef.watch`, utilizzando il `WidgetRef` + che abbiamo ottenuto da `ConsumerWidget`. + +- Riverpod non si basa sui tipi generici. Si basa invece sulla variabile creata utilizzando la definizione del provider. + +Nota anche quanto simile sia la terminologia. Sia Provider che Riverpod utilizzano la parola chiave "watch" +per descrivere "questo widget dovrebbe essere ricostruito quando il valore cambia". + +:::info +Riverpod utilizza la stessa terminologia di Provider per la lettura dei provider. + +- `BuildContext.watch` -> `WidgetRef.watch` +- `BuildContext.read` -> `WidgetRef.read` +- `BuildContext.select` -> `WidgetRef.watch(myProvider.select)` + +Le regole per "context.watch" vs "context.read" si applicano anche a Riverpod: +All'interno del metodo `build`, utilizza "watch". Nei gestori di eventi come gli eventi di clic, utilizza "read". +Quando hai bisogno di filtrare i valori e ricreare, utilizza "select". +::: + +## Leggere i provider: Consumer +Provider include opzionalmente un widget chiamato `Consumer` (e varianti come `Consumer2`) per leggere i provider. + +`Consumer` è utile per l'ottimizzazione delle prestazioni, consentendo ricostruzioni più granulari dell'albero dei widget e +aggiornando solo i widget rilevanti quando lo stato cambia. + +Pertanto, se un provider è definito come: + +```dart +Provider(...); +``` + +Provider ci permette di leggere quel provider usando `Consumer` in questo modo: + +```dart +Consumer( + builder: (BuildContext context, Model model, Widget? child) { + + } +) +``` + +Riverpod segue lo stesso principio. Anch'esso, ha un widget chiamato `Consumer` con lo stesso scopo. + +Se definiamo un provider come: + +```dart +final modelProvider = Provider(...); +``` + +Possiamo poi utilizzare `Consumer` in questo modo: + +```dart +Consumer( + builder: (BuildContext context, WidgetRef ref, Widget? child) { + Model model = ref.watch(modelProvider); + + } +) +``` + +Nota come `Consumer` ci fornisce un oggetto `WidgetRef`. Si tratta dello stesso oggetto +che abbiamo visto nella parte precedente relativa a `ConsumerWidget`. + +### Non c'è nessun `ConsumerN` equivalente in Riverpod +Nota come `Consumer2`, `Consumer3` e simili di pkg:Provider non sono necessari in Riverpod. + +Con Riverpod, se desideri leggere valori da più provider, puoi semplicemente scrivere più istruzioni `ref.watch`, come segue: + +```dart +Consumer( + builder: (context, ref, child) { + Model1 model = ref.watch(model1Provider); + Model2 model = ref.watch(model2Provider); + Model3 model = ref.watch(model3Provider); + // ... + } +) +``` + +Rispetto alle API `ConsumerN` di pkg:Provider, la soluzione sopra sembra molto meno complessa ed è probabilmente più facile da comprendere. + +## Combinare provider: ProxyProvider con oggetti stateless +Quando si utilizza Provider, il modo ufficiale di combinare i provider è utilizzare il widget `ProxyProvider` +(o varianti come `ProxyProvider2`). + +Ad esempio, potremmo definire: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +ChangeNotifierProvider(create: (context) => UserIdNotifier()), +``` + +Da qui abbiamo due opzioni. Possiamo combinare `UserIdNotifier` per creare un nuovo provider +"senza stato" (tipicamente un valore immutabile che eventualmente sovrascrive ==). +Ad esempio: + +```dart +ProxyProvider( + update: (context, userIdNotifier, _) { + return 'The user ID of the the user is ${userIdNotifier.userId}'; + } +) +``` + +Questo provider restituirebbe automaticamente una nuova `String` ogni volta che `UserIdNotifier.userId` cambia. + +Possiamo fare qualcosa di simile in Riverpod, ma la sintassi è diversa. +Innanzitutto, in Riverpod, la definizione del nostro `UserIdNotifier` sarebbe: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +final userIdNotifierProvider = ChangeNotifierProvider( + (ref) => UserIdNotifier(), +); +``` + +Da qui, per generare la nostra `String` basata su `userId` potremmo fare: + +```dart +final labelProvider = Provider((ref) { + UserIdNotifier userIdNotifier = ref.watch(userIdNotifierProvider); + return 'The user ID of the the user is ${userIdNotifier.userId}'; +}); +``` + +Notare la riga che usa `ref.watch(userIdNotifierProvider)`. + +Questa riga di codice dice a Riverpod di ottenere il contenuto di `userIdNotifierProvider` e che +ogni volta che quel valore cambia, `labelProvider` verrà ricomputato. +Di conseguenza, la `String` emessa da `labelProvider` si aggiornerà automaticamente ogni volta che cambia `userId`. + +Questo schema è stato illustrato in precedenza spiegando [come leggere i provider all'interno dei widget](#lettura-dei-provider-buildcontext). +Infatti, i provider sono ora in grado di ascoltare altri provider allo stesso modo in cui lo fanno i widget. + +## Combinare provider: ProxyProvider con oggetti stateful +Quando si combinano i provider, un'altra possibile situazione è esporre oggetti con stato, +come un'istanza di `ChangeNotifier`. + +Per questo scopo, potremmo utilizzare `ChangeNotifierProxyProvider` (o varianti come `ChangeNotifierProxyProvider2`). +Ad esempio, potremmo definire: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +ChangeNotifierProvider(create: (context) => UserIdNotifier()), +``` + +Successivamente, possiamo definire un nuovo `ChangeNotifier` che è basato su `UserIdNotifier.userId`. +Per esempio, potremmo fare: + +```dart +class UserNotifier extends ChangeNotifier { + String? _userId; + + void setUserId(String? userId) { + if (userId != _userId) { + print('The user ID changed from $_userId to $userId'); + _userId = userId; + } + } +} + +// ... + +ChangeNotifierProxyProvider( + create: (context) => UserNotifier(), + update: (context, userIdNotifier, userNotifier) { + return userNotifier! + ..setUserId(userIdNotifier.userId); + }, +); +``` + +Questo nuovo provider crea un'unica istanza di `UserNotifier` (che non viene mai ricostruita) +e stampa una stringa ogni volta che l'ID dell'utente cambia. + +Per fare la stessa cosa in Riverpod si procede in modo diverso. +Innanzitutto, in Riverpod, la definizione del nostro `UserIdNotifier` sarebbe: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +final userIdNotifierProvider = ChangeNotifierProvider( + (ref) => UserIdNotifier(), +), +``` + +Da qui, l'equivalente del precedente `ChangeNotifierProxyProvider` sarebbe: + +```dart +class UserNotifier extends ChangeNotifier { + String? _userId; + + void setUserId(String? userId) { + if (userId != _userId) { + print('The user ID changed from $_userId to $userId'); + _userId = userId; + } + } +} + +// ... + +final userNotifierProvider = ChangeNotifierProvider((ref) { + final userNotifier = UserNotifier(); + ref.listen( + userIdNotifierProvider, + (previous, next) { + if (previous?.userId != next.userId) { + userNotifier.setUserId(next.userId); + } + }, + ); + + return userNotifier; +}); +``` + +La parte cruciale di questo snippet è la riga `ref.listen`. +Questa funzione `ref.listen` è un'utilità che consente di ascoltare un provider e +ogni qualvolta che il provider cambia, esegue una funzione. + +I parametri `previous` e `next` di quella funzione corrispondono all'ultimo valore prima che +il provider sia cambiato e al nuovo valore dopo il cambio. + +## Ambito (Scoping) dei provider vs `.family` + `.autoDispose` + +In pkg:Provider, lo scope veniva utilizzato per due scopi: +- distruggere lo stato quando si lascia una pagina +- avere uno stato personalizzato per pagina + +Utilizzare lo scoping solo per distruggere lo stato non è ideale. +Il problema è che lo scoping non funziona bene in applicazioni di grandi dimensioni. +Ad esempio, lo stato spesso viene creato in una pagina, ma distrutto in seguito in una pagina diversa dopo la navigazione. +Questo non consente di avere più cache attive su pagine diverse. + +Allo stesso modo, l'approccio "stato personalizzato per pagina" diventa rapidamente difficile da gestire +se lo stato deve essere condiviso con un'altra parte dell'albero dei widget, +come potrebbe essere necessario con modali o con un form a più passaggi. + +Riverpod adotta un approccio diverso: innanzitutto, lo scoping dei provider è in un certo senso scoraggiato; +in secondo luogo, `.family` e `.autoDispose` sono una soluzione di sostituzione completa per questo. + +All'interno di Riverpod, i provider contrassegnati come `.autoDispose` distruggono automaticamente il proprio stato quando non vengono più utilizzati. +Quando l'ultimo widget che rimuove un provider viene smontato, Riverpod lo rileverà e distruggerà il provider. +Prova a utilizzare questi due metodi del ciclo di vita in un provider per testare questo comportamento: + +```dart +ref.onCancel((){ + print("Nessuno sta più in ascolto di me!"); +}); +ref.onDispose((){ + print("Se sono stato definito come `.autoDispose`, sono stato appena distrutto!"); +}); +``` + +Ciò risolve intrinsecamente il problema della "distruzione dello stato". + +Inoltre, è possibile contrassegnare un Provider come `.family` (e, contemporaneamente, come `.autoDispose`). +Questo consente di passare parametri ai provider, il che fa sì che vengano creati e tracciati internamente più provider. +In altre parole, quando si passano parametri, *viene creato uno stato unico per ogni parametro univoco*. + + + +Ciò risolve il problema dello "stato personalizzato per pagina". +In realtà, c'è un altro vantaggio: uno stato del genere non è più vincolato a una pagina specifica. +Invece, se una diversa pagina cerca di accedere allo stesso stato, potrà farlo semplicemente riutilizzando i parametri. + +In molti modi, il passaggio di parametri ai provider è equivalente ad una Map key. +Se la chiave è la stessa, si otterrà lo stesso valore. Se si tratta di una chiave diversa, si otterrà uno stato diverso. + +[provider]: https://pub.dev/packages/provider +[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider +[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[autodispose]: /docs/concepts/modifiers/auto_dispose +[workaround]: https://pub.dev/packages/provider#can-i-obtain-two-different-providers-using-the-same-type +[.family modifier]: /docs/concepts/modifiers/family +[keepAlive]: /docs/concepts/modifiers/auto_dispose#refkeepalive +[ChangeNotifierProvider]: /docs/providers/change_notifier_provider +[combining Providers]: /docs/concepts/combining_providers diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx new file mode 100644 index 000000000..d47e57bde --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx @@ -0,0 +1,197 @@ +--- +title: Quickstart +--- + +Questa sezione è progettata per le persone che hanno familiarità con il pacchetto [Provider] e +che desiderano imparare Riverpod. + +Prima di tutto, leggi il breve articolo [getting started] e prova il piccolo esempio [sandbox] +per testare le funzionalità di Riverpod. Se ti piace ciò che vedi in quell'esempio, +dovresti sicuramente considerare una migrazione. + +Infatti, la migrazione da Provider a Riverpod può essere molto semplice e diretta. + +La migrazione consiste principalmente in alcuni passaggi che possono essere eseguiti in modo *incrementale*. + +## Inizia con `ChangeNotifierProvider` +Durante la transizione verso Riverpod puoi benissimo continuare ad utilizzare `ChangeNotifier`. + +Quanto segue è perfettamente accettabile per iniziare: + +```dart +// Se hai questo... +class MyNotifier extends ChangeNotifier { + int state = 0; + + void increment() { + state++; + notifyListeners(); + } +} + +// ... basta che aggiungi questo! +final myNotifierProvider = ChangeNotifierProvider((ref) { + return MyNotifier(); +}); +``` +Come puoi vedere, Riverpod espone una classe [ChangeNotifierProvider], +che è lì appositamente per supportare le migrazioni da pkg:Provider. + +Tieni presente che questo provider non è raccomandato quando si scrive nuovo codice +e non è il modo migliore per utilizzare Riverpod, ma è un modo semplice e delicato per iniziare la tua migrazione. + +:::tip +Non c'è bisogno di cambiare immediatamente i tuoi `ChangeNotifier` nei [provider più moderni di Riverpod]. +Alcuni richiedono un certo cambio di paradigma, quindi potrebbe essere difficile farlo inizialmente. + +Prenditi il tuo tempo, poiché è importante prendere familiarità con Riverpod prima; +scoprirai rapidamente che *quasi* tutti i provider di pkg:provider hanno un equivalente stretto in pkg:riverpod. +::: + +## Inizia con le *foglie (leaves)* + +Inizia con i provider che non dipendono da nessun altro provider, cioè inizia con le *foglie* nel tuo albero delle dipendenze. +Una volta che hai migrato tutte le foglie, puoi passare ai provider che dipendono dalle foglie. + +In altre parole, evita di migrare ProxyProvider all'inizio; affrontali una volta che tutte le loro dipendenze sono state migrate. + +Questo dovrebbe accelerare e semplificare il processo di migrazione, mentre allo stesso tempo ridurre al minimo e tracciare eventuali errori. + +## Riverpod e Provider possono coesistere +*Tieni presente che è del tutto possibile utilizzare contemporaneamente sia Provider che Riverpod.* + +Infatti, utilizzando alias di importazione, è possibile utilizzare entrambe le API insieme. +Questo è anche ottimo per la leggibilità e rimuove qualsiasi uso ambiguo dell'API. + +Se hai intenzione di farlo, considera l'uso di alias di importazione per ciascuna importazione di Provider nel tuo codice. + +:::info +Una guida completa su come implementare efficacemente alias di importazione sarà presto disponibile. +::: + +## Non è *necessario* utilizzare `Consumer` immediatamente. +È importante tenere a mente che non c'è bisogno di utilizzare *immediatamente* le API di [Consumer di Riverpod]. +Se hai appena iniziato la migrazione, [come già menzionato], probabilmente dovresti iniziare con `ChangeNotifierProvider`. + +Considera `myNotifierProvider`, definito precedentemente. + +Dato che il tuo codice interno probabilmente dipende dalle API di pkg:Provider, usa quanto segue per iniziare a consumare `ChangeNotifier` con pkg:Riverpod. + +```dart +MultiProvider( + providers: [ + ChangeNotifierProvider.value(value: ref.watch(myNotifierProvider.notifier)), + ] +) +``` + +In questo modo, solo il Widget radice deve essere inizialmente convertito in un `ConsumerWidget`. +Ciò dovrebbe semplificare ulteriormente la migrazione verso pkg:Riverpod. + +## Migrare un Provider alla volta +Se hai già un'applicazione esistente, non cercare di migrare tutti i tuoi provider contemporaneamente! + +Anche se dovresti lavorare per spostare gradualmente tutta la tua applicazione su Riverpod nel lungo termine, **non esagerare**. +Fallo un provider alla volta. + +Prendi l'esempio precedente. Migrare completamente quel `myNotifierProvider` a Riverpod significa scrivere quanto segue: + +```dart +class MyNotifier extends Notifier { + @override + int build() => 0; + + void increment() => state++; +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); +``` + +.. ed è _anche_ necessario cambiare in che modo quel provider viene consumato, ovvero scrivere `ref.watch` al posto di `context.watch` per questo provider. + +Questa operazione potrebbe richiedere del tempo e potrebbe causare alcuni errori, quindi non affrettarti a farlo tutto in una volta. + +## Migrare i `ProxyProvider` +In pkg:Provider, `ProxyProvider` viene utilizzato per combinare i valori di altri Provider; +la sua costruzione dipende dal valore di altri provider in modo reattivo. + +Con Riverpod, invece, i provider [sono componibili di default]; pertanto, quando migri un `ProxyProvider`, +dovrai semplicemente scrivere `ref.watch` se desideri dichiarare una dipendenza diretta da un Provider ad un altro. + +Al contempo, combinare valori con Riverpod dovrebbe risultare più semplice e diretto; +di conseguenza, la migrazione dovrebbe semplificare notevolmente il tuo codice. + +Inoltre, non ci sono trucchi per combinare più di due provider insieme: +aggiungi semplicemente un altro `ref.watch` e sarai pronto a procedere. + +## Inizializzazione anticipata +Poiché i provider di Riverpod sono variabili globali *final*, sono [lazy di default]. + +Se hai bisogno di inizializzare alcuni dati o un servizio di utilità in fase di avvio, +il modo migliore per farlo è leggere il tuo provider nel punto in cui di solito inserivi `MultiProvider`. + +In altre parole, poiché Riverpod non può essere forzato a essere inizializzato anticipatamente, i provider +possono essere letti e memorizzati nella tua fase di avvio, in modo che siano pronti e caricati quando necessario nel resto della tua applicazione. + +Una guida completa sull'inizializzazione anticipata dei provider di Riverpod è [disponibile qui]. + +## Generazione di codice +La [generazione di codice] è consigliata per utilizzare Riverpod in modo *future-proof*. +A tal proposito, è probabile che quando la metaprogrammazione diventerà una cosa comune, la generazione di codice sarà predefinita per Riverpod. + +Sfortunatamente, `@riverpod` non può generare codice per `ChangeNotifierProvider`. +Per superare questo problema, puoi utilizzare il seguente metodo di estensione di utilità: +```dart +extension ChangeNotifierWithCodeGenExtension on Ref { + T listenAndDisposeChangeNotifier(T notifier) { + notifier.addListener(notifyListeners); + onDispose(() => notifier.removeListener(notifyListeners)); + onDispose(notifier.dispose); + return notifier; + } +} +``` + +Successivamente, puoi esporre il tuo `ChangeNotifier` con la seguente sintassi codegen: +```dart +// ignore_for_file: unsupported_provider_value +@riverpod +MyNotifier example(ExampleRef ref) { + return ref.listenAndDisposeChangeNotifier(MyNotifier()); +} +``` + +Una volta completata la migrazione "base", puoi cambiare il tuo `ChangeNotifier` in `Notifier`, +eliminando così la necessità di estensioni temporanee. +Riprendendo gli esempi precedenti, un `Notifier` "completamente migrato" diventa: + +```dart +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() => 0; + + void increment() => state++; +} +``` + +Una volta fatto ciò, e sei sicuro che non ci siano più `ChangeNotifierProvider` nel tuo codice, +puoi eliminare definitivamente l'estensione temporanea. + +Tieni presente che, sebbene sia consigliato, la generazione di codice non è *obbligatoria*. +È importante ragionare sulle migrazioni in modo incrementale: +quindi, è normale sentire che sia troppo pesante implementare sia la migrazione che la transizione alla sintassi di codice generato. + +Seguendo questa guida, potrai migrare alla generazione di codice come ulteriore passo avanti in seguito. + +[getting started]: /docs/introduction/getting_started +[sandbox]: https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2 +[provider]: https://pub.dev/packages/provider +[ChangeNotifierProvider]: /docs/providers/change_notifier_provider +[generazione di codice]: /docs/concepts/about_code_generation +[provider più moderni di Riverpod]: /docs/providers/notifier_provider +[sono componibili di default]: /docs/from_provider/motivation#combinare-i-provider-è-difficile-e-soggetto-a-errori +[come già menzionato]: /docs/from_provider/quickstart#start-with-changenotifierprovider +[Consumer di Riverpod]: /docs/concepts/reading +[lazy di default]: /docs/concepts/provider_lifecycles +[disponibile qui]: /docs/essentials/eager_initialization \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started.mdx deleted file mode 100644 index d9c2a8524..000000000 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started.mdx +++ /dev/null @@ -1,237 +0,0 @@ ---- -title: Introduzione ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -Prima di addentrarci nei meccanismi interni di [Riverpod], iniziamo con le basi, ovvero -installare [Riverpod] e di seguito creare il classico "Hello World". - -## Quale pacchetto installare - -Prima di tutto, devi sapere che [Riverpod] è diviso in diversi pacchetti, ognuno per una propria esigenza. -La variante di [Riverpod] che vorrai installare dipenderà dal tipo di App che hai intenzione di creare. - -Fai riferimento alla seguente tabella per decidere quale pacchetto installare: - -| tipo app | nome pacchetto | descrizione | -| ------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| Flutter + [flutter_hooks] | [hooks_riverpod] | Permette l'utilizzo di entrambi [flutter_hooks] e [Riverpod] insieme. | -| Solo Flutter | [flutter_riverpod] | Per utilizzare [Riverpod] per App Flutter | -| Solo Dart (No Flutter) | [riverpod](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod) | Versione di [Riverpod] con tutte le classi collegate a Flutter rimosse | - -## Installare il pacchetto - -Una volta che sai quale pacchetto installare, procedi aggiungendo la versione dalla seguente tabella al file `pubspec.yaml`: - - - - -```yaml title="pubspec.yaml" -environment: - sdk: ">=2.12.0 <3.0.0" - flutter: ">=2.0.0" - -dependencies: - flutter: - sdk: flutter - flutter_hooks: ^0.18.0 - hooks_riverpod: ^2.1.3 -``` - -Dopodichè esegui `flutter pub get`. - - - - -```yaml title="pubspec.yaml" -environment: - sdk: ">=2.12.0 <3.0.0" - flutter: ">=2.0.0" - -dependencies: - flutter: - sdk: flutter - flutter_riverpod: ^2.1.3 -``` - -Dopodichè esegui `flutter pub get`. - - - - -```yaml title="pubspec.yaml" -environment: - sdk: ">=2.12.0-0 <3.0.0" - -dependencies: - riverpod: ^2.1.3 -``` - -Dopodichè esegui `dart pub get`. - - - - -Ottimo! Hai appena aggiunto [Riverpod] alla tua app! - -## Esempio di utilizzo: Hello world - -Ora che hai installato [Riverpod], possiamo iniziare ad utilizzarlo. - -I seguenti snippet mostrano come utilizzare la nostra nuova dipendenza per creare un "Hello world": - - - - -```dart title="lib/main.dart" -import 'package:flutter/material.dart'; -import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:flutter_hooks/flutter_hooks.dart'; - -// Creiamo un "provider", che salverà un valore (Nel nostro caso "Hello world") -// Utilizzare un provider ci permetterà di imitare/sovrascrivere il valore esposto. -final helloWorldProvider = Provider((_) => 'Hello world'); - -void main() { - runApp( - // Per fare in modo che i widget leggano i provider, dobbiamo avvolgere - // l'intera applicazione in un widget "ProviderScope". - // Qui è dove sarà salvato lo stato dei nostri provider. - ProviderScope( - child: MyApp(), - ), - ); -} - -// Nota: MyApp è un HookConsumerWidget, da hooks_riverpod -class MyApp extends HookConsumerWidget { - @override - Widget build(BuildContext context, WidgetRef ref) { - final String value = ref.watch(helloWorldProvider); - - return MaterialApp( - home: Scaffold( - appBar: AppBar(title: Text('Example')), - body: Center( - child: Text(value), - ), - ), - ); - } -} -``` - -Puoi eseguire l'app con `flutter run`. -Questo mostrerà "Hello world" nel tuo device. - - - - -```dart title="lib/main.dart" -import 'package:flutter/material.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; - -// Creiamo un "provider", che salverà un valore (Nel nostro caso "Hello world") -// Utilizzando provider ci permetterà di mock/override il valore esposto. -final helloWorldProvider = Provider((_) => 'Hello world'); - -void main() { - runApp( - // Per i widget, per avere la possibilità di leggere i provider, dobbiamo avvolgere - // l'intera applicazione con il Widget "ProviderScope". - // Qui è dove sarà salvato lo stato dei nostri provider. - ProviderScope( - child: MyApp(), - ), - ); -} - -// Estende ConsumerWidget (esposto da Riverpod) invece che StatelessWidget -class MyApp extends ConsumerWidget { - @override - Widget build(BuildContext context, WidgetRef ref) { - final String value = ref.watch(helloWorldProvider); - - return MaterialApp( - home: Scaffold( - appBar: AppBar(title: Text('Example')), - body: Center( - child: Text(value), - ), - ), - ); - } -} -``` - -Puoi eseguire con `flutter run`. -Questo mostrerà "Hello world" nel tuo device. - - - - -```dart title="lib/main.dart" -import 'package:riverpod/riverpod.dart'; - -// Creiamo un "provider", che salverà un valore(Nel nostro caso "Hello world") -// Utilizzando provider ci permetterà di mock/override il valore esposto. -final helloWorldProvider = Provider((_) => 'Hello world'); - -void main() { - - // In questo oggetto sarà salvato lo stato dei nostri provider. - final container = ProviderContainer(); - - // Grazie a "container", possiamo leggere il nostro provider. - final value = container.read(helloWorldProvider); - - print(value); // Hello world -} -``` - -Puoi eseguire con `dart lib/main.dart`. -Questo mostrerà "Hello world" nella console - - - - -## Andando oltre: Installare snippet - -Se stai utilizzando `Flutter` e `VS Code`, considera l'utilizzo di [Flutter Riverpod Snippets](https://marketplace.visualstudio.com/items?itemName=robert-brunhage.flutter-riverpod-snippets) - -Se stai utilizzando `Flutter` e `Android Studio` o `IntelliJ`, considera l'utilizzo di [Flutter Riverpod Snippets](https://plugins.jetbrains.com/plugin/14641-flutter-riverpod-snippets) - -![img](/img/snippets/greetingProvider.gif) - -## Scegli il prossimo passo - -Apprendi i concetti base: - -- [Impara di più riguardo i providers](/docs/concepts/providers) - -Segui un cookbook: - -- [Come testare i provider](/docs/cookbooks/testing) - -[riverpod]: https://github.com/rrousselgit/riverpod -[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod -[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod -[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world.dart deleted file mode 100644 index a52fcebae..000000000 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world.dart +++ /dev/null @@ -1,20 +0,0 @@ -// ignore_for_file: avoid_print - -/* SNIPPET START */ - -import 'package:riverpod/riverpod.dart'; - -// Creiamo un "provider", il quale immagazzinerà un valore (qui "Hello world"). -// Usare un provider ci permetterà di simulare/sovrascrivere il valore esposto. - -final helloWorldProvider = Provider((_) => 'Hello world'); - -void main() { - // Questo è l'oggetto dove lo stato dei nostri provider sarà salvato. - final container = ProviderContainer(); - - // Grazie a "container", possiamo leggere il nostro provider. - final value = container.read(helloWorldProvider); - - print(value); // Hello world -} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world_hooks.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world_hooks.dart deleted file mode 100644 index c56c2929b..000000000 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world_hooks.dart +++ /dev/null @@ -1,38 +0,0 @@ -// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types - -/* SNIPPET START */ - -import 'package:flutter/material.dart'; -import 'package:hooks_riverpod/hooks_riverpod.dart'; - -// Creiamo un "provider", il quale immagazzinerà un valore (qui "Hello world"). -// Usare un provider ci permetterà di simulare/sovrascrivere il valore esposto. -final helloWorldProvider = Provider((_) => 'Hello world'); - -void main() { - runApp( - // Per fare in modo che i widget leggano i provider, dobbiamo incapsulare - // l'intera applicazione in un widget "ProviderScope" - // Qui è dove lo stato dei nostri provider sarà salvato. - ProviderScope( - child: MyApp(), - ), - ); -} - -// Nota: MyApp è un HookConsumerWidget, da hooks_riverpod. -class MyApp extends HookConsumerWidget { - @override - Widget build(BuildContext context, WidgetRef ref) { - final String value = ref.watch(helloWorldProvider); - - return MaterialApp( - home: Scaffold( - appBar: AppBar(title: const Text('Example')), - body: Center( - child: Text(value), - ), - ), - ); - } -} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx new file mode 100644 index 000000000..941063d06 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx @@ -0,0 +1,195 @@ +--- +title: Introduzione +pagination_next: essentials/first_request +version: 4 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import pubspec from "./getting_started/pubspec"; +import dartHelloWorld from "./getting_started/dart_hello_world"; +import pubadd from "./getting_started/pub_add"; +import helloWorld from "./getting_started/hello_world"; +import dartPubspec from "./getting_started/dart_pubspec"; +import dartPubadd from "./getting_started/dart_pub_add"; +import { + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; +import { Link } from "../../../../../src/components/Link"; + +## Prova Riverpod online + +Per farti un'idea di Riverpod, prova a utilizzarlo online su [Dartpad](https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2) +o su [Zapp](https://zapp.run/new): + + + +## Installazione del package + +Una volta che sai quale pacchetto desideri installare, procedi ad aggiungere la dipendenza alla tua app tramite riga di comando: + + + + + + + + + + + + + + + + +In alternativa, puoi aggiungere manualmente la dipendenza alla tua app all'interno del tuo file `pubspec.yaml`: + + + + + + +Infine, installa i package con `flutter pub get`. + + + Ora puoi eseguire il code-generator con{" "} + flutter pub run build_runner watch. + + + + + + + +Infine, installa i package con `dart pub get`. + + + Ora puoi eseguire il code-generator con{" "} + dart run build_runner watch. + + + + + +Ecco fatto. Hai aggiunto [Riverpod] alla tua app! + +## Abilitare riverpod_lint/custom_lint + +Riverpod include un pacchetto opzionale chiamato [riverpod_lint] +che fornisce regole di lint per aiutarti a scrivere codice migliore +e offre opzioni di refactoring personalizzate. + +Il pacchetto dovrebbe già essere installato se hai seguito i passaggi precedenti, +ma è necessario un passaggio separato per abilitarlo. + +Per abilitare [riverpod_lint], è necessario aggiungere un file `analysis_options.yaml` +posizionato sullo stesso livello del tuo `pubspec.yaml` e includere quanto segue: + + + {`analyzer: + plugins: + - custom_lint`} + + +Ora dovresti vedere dei warning nel tuo ambiente di sviluppo (IDE) se hai commesso errori +nell'utilizzo di Riverpod nel tuo codice. + +Per vedere l'elenco completo dei possibili warning e refactoring, vai alla pagina di [riverpod_lint]. + +:::note +Quei warning non verranno visualizzati nel comando `dart analyze`. +Se desideri verificare tali warning in CI/terminale, puoi eseguire quanto segue: + +```sh +dart run custom_lint +``` + +::: + +## Esempio di utilizzo: Hello world + +Ora che abbiamo installato [Riverpod], possiamo iniziare ad usarlo. + +Gli snippet seguenti mostrano come utilizzare la nostra nuova dipendenza per creare un "Hello world": + + + + + + +Successivamente, avvia l'applicazione con `flutter run`. +Questo renderizzerà "Hello world" sul tuo dispositivo. + + + + + + +Successivamente, avvia l'applicazione con `dart lib/main.dart`. +Vedrai stampato "Hello world" nella console. + + + + +## Andando oltre: Installazione di snippet di codice + +Se stai utilizzando `Flutter` e `VS Code`, considera l'utilizzo di [Flutter Riverpod Snippets](https://marketplace.visualstudio.com/items?itemName=robert-brunhage.flutter-riverpod-snippets) + +Se stai utilizzando `Flutter` e `Android Studio` o `IntelliJ`, considera l'utilizzo di [Flutter Riverpod Snippets](https://plugins.jetbrains.com/plugin/14641-flutter-riverpod-snippets) + +![img](/img/snippets/greetingProvider.gif) + +## Scegli il prossimo passo + +Apprendi i concetti base: + +- + +Segui un cookbook: + +- + +[riverpod]: https://github.com/rrousselgit/riverpod +[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod +[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod +[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks +[riverpod_lint]: https://pub.dev/packages/riverpod_lint diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/index.tsx similarity index 100% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/index.tsx rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/index.tsx diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart similarity index 54% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart index 529b61e53..9ee7aa68a 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart @@ -6,18 +6,18 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; -// 我们创建一个 “provider”，它将用于保存一个值（这里是 “Hello world”）。 -// 通过使用一个 provider，我们能够模拟或覆盖被暴露的值。 +// Creiamo un "provider", che conterrà un valore (qui "Hello, world"). +// Utilizzando un provider, ciò ci consente di simulare/sostituire il valore esposto. @riverpod String helloWorld(HelloWorldRef ref) { return 'Hello world'; } void main() { - // 我们的 provider 将借这个对象存储状态。 + // Questo oggetto è dove lo stato dei nostri provider sarà salvato. final container = ProviderContainer(); - // 我们可以借助这个 “container” 对象读取 provider。 + // Grazie a "container", possiamo leggere il nostro provider. final value = container.read(helloWorldProvider); print(value); // Hello world diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart similarity index 100% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/raw.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx new file mode 100644 index 000000000..07c03cf6b --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx @@ -0,0 +1,32 @@ +export function buildDeps({ + deps = [], + devDeps = [], +}: { + deps?: string[]; + devDeps?: string[]; +}) { + var result = ""; + for (const dep of deps) { + result += `dart pub add ${dep}\n`; + } + + for (const dep of [...devDeps, "custom_lint", "riverpod_lint"]) { + result += `dart pub add dev:${dep}\n`; + } + + return result; +} + +const raw = buildDeps({ deps: ["riverpod"] }); + +const codegen = buildDeps({ + deps: ["riverpod", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx similarity index 78% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec.tsx rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx index 598ab76e8..d44367c30 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec.tsx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx @@ -3,12 +3,11 @@ import { riverpodAnnotationVersion, riverpodGeneratorVersion, riverpodLintVersion, -} from "../../../../../src/versions"; +} from "../../../../../../src/versions"; -const codegen = ` -name: my_app_name +const codegen = `name: my_app_name environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0 <4.0.0" dependencies: riverpod: ^${riverpodVersion} @@ -21,10 +20,9 @@ dev_dependencies: riverpod_lint: ^${riverpodLintVersion} `; -const raw = ` -name: my_app_name +const raw = `name: my_app_name environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0 <4.0.0" dependencies: riverpod: ^${riverpodVersion} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart new file mode 100644 index 000000000..c85c3f7af --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart @@ -0,0 +1,46 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, unreachable_from_main + +/* SNIPPET START */ import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'main.g.dart'; + +// Creiamo un "provider", che conterrà un valore (qui "Hello, world"). +// Utilizzando un provider, ciò ci consente di simulare/sostituire il valore esposto. +@riverpod +String helloWorld(HelloWorldRef ref) { + return 'Hello world'; +} + +void main() { + runApp( + // Per consentire ai widget di leggere i provider, è necessario incapsulare l'intera + // applicazione in un widget "ProviderScope". + // Questo è il luogo in cui verrà memorizzato lo stato dei nostri provider. + ProviderScope( + child: MyApp(), + ), + ); +} + +// Estendiamo HookConsumerWidget invece di StatelessWidget, il quale è esposto da Riverpod +class MyApp extends HookConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // Possiamo usare gli hooks all'interno di un HookConsumerWidget + final counter = useState(0); + + final String value = ref.watch(helloWorldProvider); + + return MaterialApp( + home: Scaffold( + appBar: AppBar(title: const Text('Example')), + body: Center( + child: Text('$value ${counter.value}'), + ), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart similarity index 100% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx similarity index 67% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/index.tsx rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx index 9535552ac..3f10c2a94 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/index.tsx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx @@ -1,11 +1,11 @@ import raw from "!!raw-loader!./raw.dart"; import raw_hooks from "!!raw-loader!./raw_hooks.dart"; import codegen from "!!raw-loader!./main.dart"; -import codegen_hooks from "!!raw-loader!./main_hooks.dart"; +import hooksCodegen from "!!raw-loader!./hooks_codegen/main.dart"; export default { raw, hooks: raw_hooks, codegen, - hooksCodegen: codegen_hooks, + hooksCodegen: hooksCodegen, }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart similarity index 58% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart index 291b3365f..57985309c 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart @@ -1,15 +1,13 @@ // ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, unreachable_from_main -/* SNIPPET START */ - -import 'package:flutter/material.dart'; +/* SNIPPET START */ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; -// 我们创建一个 “provider”，它将用于保存一个值（这里是 “Hello world”）。 -// 通过使用一个 provider，我们能够模拟或覆盖被暴露的值。 +// Creiamo un "provider", che conterrà un valore (qui "Hello, world"). +// Utilizzando un provider, ciò ci consente di simulare/sostituire il valore esposto. @riverpod String helloWorld(HelloWorldRef ref) { return 'Hello world'; @@ -17,16 +15,16 @@ String helloWorld(HelloWorldRef ref) { void main() { runApp( - // 为了能让组件读取 provider，我们需要将整个 - // 应用都包裹在 “ProviderScope” 组件内。 - // 这里也就是存储我们所有 provider 状态的地方。 + // Per consentire ai widget di leggere i provider, è necessario incapsulare l'intera + // applicazione in un widget "ProviderScope". + // Questo è il luogo in cui verrà memorizzato lo stato dei nostri provider. ProviderScope( child: MyApp(), ), ); } -// 扩展来自 Riverpod 的 HookConsumerWidget 而不是 HookWidget +// Estendiamo ConsumerWidget invece di StatelessWidget, il quale è esposto da Riverpod class MyApp extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.g.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world_flutter.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart similarity index 54% rename from website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world_flutter.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart index ae21ba688..7cbad6012 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/getting_started_hello_world_flutter.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart @@ -1,26 +1,24 @@ // ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types -/* SNIPPET START */ - -import 'package:flutter/material.dart'; +/* SNIPPET START */ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -// Creiamo un "provider", il quale immagazzinerà un valore (qui "Hello world"). -// Usare un provider ci permetterà di simulare/sovrascrivere il valore esposto. +// Creiamo un "provider", che conterrà un valore (qui "Hello, world"). +// Utilizzando un provider, ciò ci consente di simulare/sostituire il valore esposto. final helloWorldProvider = Provider((_) => 'Hello world'); void main() { runApp( - // Per fare in modo che i widget leggano i provider, dobbiamo incapsulare - // l'intera applicazione in un widget "ProviderScope" - // Qui è dove lo stato dei nostri provider sarà salvato. + // Per consentire ai widget di leggere i provider, è necessario incapsulare l'intera + // applicazione in un widget "ProviderScope". + // Questo è il luogo in cui verrà memorizzato lo stato dei nostri provider. ProviderScope( child: MyApp(), ), ); } -// Estendere ConsumerWidget (esposto da Riverpod) invece di StatelessWidget +// Estendiamo ConsumerWidget invece di StatelessWidget, il quale è esposto da Riverpod class MyApp extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart new file mode 100644 index 000000000..57ddda404 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart @@ -0,0 +1,40 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +/* SNIPPET START */ import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +// Creiamo un "provider", che conterrà un valore (qui "Hello, world"). +// Utilizzando un provider, ciò ci consente di simulare/sostituire il valore esposto. +final helloWorldProvider = Provider((_) => 'Hello world'); + +void main() { + runApp( + // Per consentire ai widget di leggere i provider, è necessario incapsulare l'intera + // applicazione in un widget "ProviderScope". + // Questo è il luogo in cui verrà memorizzato lo stato dei nostri provider. + ProviderScope( + child: MyApp(), + ), + ); +} + +// Estendiamo HookConsumerWidget invece di StatelessWidget, il quale è esposto da Riverpod +class MyApp extends HookConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // Possiamo usare gli hooks all'interno di un HookConsumerWidget + final counter = useState(0); + + final String value = ref.watch(helloWorldProvider); + + return MaterialApp( + home: Scaffold( + appBar: AppBar(title: const Text('Example')), + body: Center( + child: Text('$value ${counter.value}'), + ), + ), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx new file mode 100644 index 000000000..65c7be1bd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx @@ -0,0 +1,39 @@ +export function buildDeps({ + deps = [], + devDeps = [], +}: { + deps?: string[]; + devDeps?: string[]; +}) { + var result = ''; + for (const dep of deps) { + result += `flutter pub add ${dep}\n`; + } + + for (const dep of [...devDeps, "custom_lint", "riverpod_lint"]) { + result += `flutter pub add dev:${dep}\n`; + } + + return result; +} + +const raw = buildDeps({ deps: ["flutter_riverpod"] }); + +const codegen = buildDeps({ + deps: ["flutter_riverpod", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +const hooks = buildDeps({ deps: ["hooks_riverpod", "flutter_hooks"] }); + +const hooksCodegen = buildDeps({ + deps: ["hooks_riverpod", "flutter_hooks", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +export default { + raw: raw, + hooks: hooks, + codegen: codegen, + hooksCodegen: hooksCodegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx new file mode 100644 index 000000000..da974c2a1 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx @@ -0,0 +1,51 @@ +import { + flutterRiverpodVersion, + hooksRiverpodVersion, + riverpodAnnotationVersion, + riverpodGeneratorVersion, + riverpodLintVersion, +} from "../../../../../../src/versions"; + +function plain(riverpod: string) { + return `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.0.0" + +dependencies: + flutter: + sdk: flutter + ${riverpod} + +dev_dependencies: + custom_lint: + riverpod_lint: ^${riverpodLintVersion} +`; +} + +function codegen(riverpod: string) { + return `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.0.0" + +dependencies: + flutter: + sdk: flutter + ${riverpod} + riverpod_annotation: ^${riverpodAnnotationVersion} + +dev_dependencies: + build_runner: + custom_lint: + riverpod_generator: ^${riverpodGeneratorVersion} + riverpod_lint: ^${riverpodLintVersion} +`; +} + +export default { + raw: plain(`flutter_riverpod: ^${flutterRiverpodVersion}`), + hooks: plain(`hooks_riverpod: ^${hooksRiverpodVersion}\n flutter_hooks:`), + codegen: codegen(`flutter_riverpod: ^${flutterRiverpodVersion}`), + hooksCodegen: codegen(`hooks_riverpod: ^${hooksRiverpodVersion}\n flutter_hooks:`), +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx new file mode 100644 index 000000000..c556de7cd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx @@ -0,0 +1,60 @@ +--- +title: Perché Riverpod? +version: 1 +--- + +import whyRiverpod from "./why_riverpod"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +## Che cos'è Riverpod? + +Riverpod (un anagramma di [Provider](https://pub.dev/packages/provider)) è un framework reattivo con cache per Flutter/Dart. + +Utilizzando la programmazione dichiarativa e reattiva, Riverpod è in grado di gestire +una grande parte della logica della tua applicazione per te. +Può effettuare richieste di rete con gestione degli errori e caching integrati, mentre ri-scarica automaticamente i dati quando necessario. + +## Motivazione + +Le applicazioni moderne raramente dispongono subito di tutte le informazioni necessarie per renderizzare la loro interfaccia utente. +Al contrario, i dati vengono spesso recuperati in modo asincrono da un server. + +Il problema è che lavorare con il codice asincrono è complesso. Anche se Flutter fornisce alcuni modi +per creare variabili di stato e aggiornare l'interfaccia utente in caso di modifiche, +le possibilità rimangono limitate. Alcune sfide rimangono irrisolte: + +- Le richieste asincrone devono essere memorizzate in cache localmente, +poiché sarebbe irragionevole eseguirle nuovamente ogni volta che l'interfaccia utente viene aggiornata. +- Dato che disponiamo di una cache, la nostra cache potrebbe diventare obsoleta se non siamo attenti. +- È inoltre necessario gestire errori e stati di caricamento. + +Affrontare tali problemi su larga scala può essere complicato e possono essere influenzati da numerose caratteristiche, come ad esempio: + +- aggiornamento con trascinamento verso il basso (pull to refresh) +- liste infinite / recupero dati man mano che si scorre (infinite lists / fetch as we scroll) +- ricerca in tempo reale mentre si digita (search as we type) +- ritardo nella richiesta asincrona (debouncing asynchronous requests) +- annullamento delle richieste asincrone quando non sono più necessarie +- UI ottimistica +- modalità offline +- ... + +Queste funzionalità possono essere complesse da implementare, ma sono cruciali per una buona esperienza utente. +Tuttavia, pochi package cercano di affrontare direttamente questi problemi, e gran parte del lavoro +deve essere svolto manualmente. + +Ecco dove entra in gioco Riverpod. +Riverpod cerca di risolvere questi problemi offrendo un nuovo e unico modo di scrivere la business logic, +ispirato ai widget di Flutter. +In molti modi, Riverpod è paragonabile ai widget, ma per lo stato. + +Utilizzando questo nuovo approccio, queste funzionalità complesse sono per lo più gestite già di default. +Tutto ciò che rimane è concentrarsi sulla tua interfaccia utente. + +Se sei scettico, ecco un esempio. Il seguente snippet è una semplificazione dell'applicazione client +[Pub.dev](https://github.com/rrousselGit/riverpod/tree/master/examples/pub) implementata con Riverpod. + + + +Questo snippet contiene tutta la business logic necessaria per una funzionalità di "ricerca in tempo reale" + +"aggiornamento con trascinamento verso il basso" + "lista infinita", gestendo anche gli stati di errore e caricamento. diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart new file mode 100644 index 000000000..3e2022906 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart @@ -0,0 +1,31 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class Package { + static Package fromJson(dynamic json) { + throw UnimplementedError(); + } +} + +/* SNIPPET START */ + +// Recupera l'elenco dei package da pub.dev +@riverpod +Future> fetchPackages( + FetchPackagesRef ref, { + required int page, + String search = '', +}) async { + final dio = Dio(); + // Effettua una richiesta API. Qui stiamo utilizzando il package 'dio', ma potremmo usare qualsiasi altro package. + final response = await dio.get>( + 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', + ); + + // Decodifica la risposta JSON in una classe Dart. + return response.data?.map(Package.fromJson).toList() ?? const []; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart new file mode 100644 index 000000000..f0e4abbd9 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart @@ -0,0 +1,164 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef FetchPackagesRef = Ref>>; + +@ProviderFor(fetchPackages) +const fetchPackagesProvider = FetchPackagesFamily._(); + +final class FetchPackagesProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, FetchPackagesRef> + with + $FutureModifier>, + $FutureProvider, FetchPackagesRef> { + const FetchPackagesProvider._( + {required FetchPackagesFamily super.from, + required ({ + int page, + String search, + }) + super.argument, + FutureOr> Function( + FetchPackagesRef ref, { + required int page, + String search, + })? create}) + : _createCb = create, + super( + name: r'fetchPackagesProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + FetchPackagesRef ref, { + required int page, + String search, + })? _createCb; + + @override + String debugGetCreateSourceHash() => _$fetchPackagesHash(); + + @override + String toString() { + return r'fetchPackagesProvider' + '' + '$argument'; + } + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + FetchPackagesProvider $copyWithCreate( + FutureOr> Function( + FetchPackagesRef ref, + ) create, + ) { + return FetchPackagesProvider._( + argument: argument as ({ + int page, + String search, + }), + from: from! as FetchPackagesFamily, + create: ( + ref, { + required int page, + String search = '', + }) => + create(ref)); + } + + @override + FutureOr> create(FetchPackagesRef ref) { + final _$cb = _createCb ?? fetchPackages; + final argument = this.argument as ({ + int page, + String search, + }); + return _$cb( + ref, + page: argument.page, + search: argument.search, + ); + } + + @override + bool operator ==(Object other) { + return other is FetchPackagesProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$fetchPackagesHash() => r'eebf7d838a57f493fffebfd2c8d8ab76d3233165'; + +final class FetchPackagesFamily extends Family { + const FetchPackagesFamily._() + : super( + name: r'fetchPackagesProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + FetchPackagesProvider call({ + required int page, + String search = '', + }) => + FetchPackagesProvider._(argument: ( + page: page, + search: search, + ), from: this); + + @override + String debugGetCreateSourceHash() => _$fetchPackagesHash(); + + @override + String toString() => r'fetchPackagesProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr> Function( + FetchPackagesRef ref, + ({ + int page, + String search, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FetchPackagesProvider; + + final argument = provider.argument as ({ + int page, + String search, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart new file mode 100644 index 000000000..b79a3debd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart @@ -0,0 +1,27 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Package { + static Package fromJson(dynamic json) { + throw UnimplementedError(); + } +} + +/* SNIPPET START */ + +// Recupera l'elenco dei package da pub.dev +final fetchPackagesProvider = FutureProvider.autoDispose + .family, ({int page, String? search})>((ref, params) async { + final page = params.page; + final search = params.search ?? ''; + final dio = Dio(); + // Effettua una richiesta API. Qui stiamo utilizzando il package 'dio', ma potremmo usare qualsiasi altro package. + final response = await dio.get>( + 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', + ); + + // Decodifica la risposta JSON in una classe Dart. + return response.data?.map(Package.fromJson).toList() ?? const []; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx index aa8ba56f4..e577300ff 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx @@ -1,11 +1,11 @@ --- -title: da ^0.13.0 a ^0.14.0 +title: ^0.13.0 to ^0.14.0 --- -Con il rilascio della versione `0.14.0` di Riverpod, la sintassi per usare [StateNotifierProvider] è cambiata. -(vedere https://github.com/rrousselGit/riverpod/issues/341 per la spiegazione). +With the release of version `0.14.0` of Riverpod, the syntax for using [StateNotifierProvider] changed +(see https://github.com/rrousselGit/riverpod/issues/341 for the explanation). -Per l'intero articolo, considera leggere [StateNotifier]: +For the entire article, consider the following [StateNotifier]: ```dart class MyModel {} @@ -15,12 +15,12 @@ class MyStateNotifier extends StateNotifier { } ``` -## Cambiamenti +## The changes -- [StateNotifierProvider] accetta un generico parametro extra, che dovrebbe essere il tipo -dello stato del tuo [StateNotifier]. +- [StateNotifierProvider] takes an extra generic parameter, which should be + the type of the state of your [StateNotifier]. - Prima: + Before: ```dart final provider = StateNotifierProvider((ref) { @@ -28,7 +28,7 @@ dello stato del tuo [StateNotifier]. }); ``` - Dopo: + After: ```dart final provider = StateNotifierProvider((ref) { @@ -36,9 +36,9 @@ dello stato del tuo [StateNotifier]. }); ``` -- per ottenere lo [StateNotifier], ora dovresti leggere `myProvider.notifier` invece di solo `myProvider` : +- to obtain the [StateNotifier], you should now read `myProvider.notifier` instead of just `myProvider`: - Prima: + Before: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -46,7 +46,7 @@ dello stato del tuo [StateNotifier]. } ``` - Dopo: + After: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -54,9 +54,9 @@ dello stato del tuo [StateNotifier]. } ``` -- per stare in ascolto di un [StateNotifier], ora dovresti leggere `myProvider` invece di `myProvider.state` : +- to listen to the state of the [StateNotifier], you should now read `myProvider` instead of `myProvider.state`: - Prima: + Before: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -64,7 +64,7 @@ dello stato del tuo [StateNotifier]. } ``` - Dopo: + After: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -72,38 +72,39 @@ dello stato del tuo [StateNotifier]. } ``` -## Utilizzo dello strumento di migrazione per aggiornare i tuoi progetti alla nuova sintassi +## Using the migration tool to automatically upgrade your projects to the new syntax -Con la versione 0.14.0, viene introdotto uno strumento da riga di comando per Riverpod, il quale può aiutarti a migrare i progetti. +With version 0.14.0 came the release of a command line tool for Riverpod, +which can help you migrate your projects. -### Installazione dello strumento +### Installing the command line -Per installare lo strumento di migrazione, eseguire: +To install the migration tool, run: ```sh dart pub global activate riverpod_cli ``` -Dovresti poter eseguire ora: +You should now be able to run: ```sh riverpod --help ``` -### Uso +### Usage -Ora che lo strumento è installato, possiamo iniziare ad utilizzarlo. +Now that the command line is installed, we can start using it. -- Per prima cosa, apri il progetto che vuoi migrare nel tuo terminale. -- **NON** aggiornare Riverpod. - Lo strumento di migrazione aggiornerà la versione di Riverpod per te. -- Assicurati che il tuo progetto non contenga errori. -- Eseguire: +- First, open the project you want to migrate in your terminal. +- **Do not** upgrade Riverpod. + The migration tool will upgrade the version of Riverpod for you. +- Make sure that your project does not contain errors. +- Execute: ```sh riverpod migrate ``` -Lo strumento analizzerà il tuo progetto e ti suggerirà le modifiche. Per esempio potresti vedere: +The tool will then analyze your project and suggest changes. For example you may see: ```diff Widget build(BuildContext context, ScopedReader watch) { @@ -114,7 +115,8 @@ Widget build(BuildContext context, ScopedReader watch) { Accept change (y = yes, n = no [default], A = yes to all, q = quit)? ``` -Per accettare la modifica, premi semplicemente y. In caso contrario, premi n. +To accept the change, simply press y. Otherwise to reject it, press n. -[statenotifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/StateNotifierProvider-class.html + +[statenotifierprovider]: ../providers/state_notifier_provider [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx index 0bd679c83..91fcf0386 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx @@ -1,52 +1,54 @@ --- -title: da ^0.14.0 a ^1.0.0 +title: ^0.14.0 to ^1.0.0 --- -Dopo una lunga attesa, la prima versione stabile di Riverpod è stata finalmente rilasciata 👏 -Per vedere tutta la lista dei cambiamenti, consulta il [Changelog](https://pub.dev/packages/flutter_riverpod/changelog#100). -In questa pagina ci concentreremo su come migrare una applicazione Riverpod esistente -dalla versione 0.14.x alla versione 1.0.0. +After a long wait, the first stable version of Riverpod is finally released 👏 -## Utilizzo dello strumento di migrazione per aggiornare i tuoi progetti alla nuova sintassi +To see the full list of changes, consult the [Changelog](https://pub.dev/packages/flutter_riverpod/changelog#100). +In this page, we will focus on how to migrate an existing Riverpod application +from version 0.14.x to version 1.0.0. -Prima di spiegare i vari cambiamenti, vale la pena far notare che Riverpod ha -uno strumento da riga di comando per migrare automaticamente il tuo progetto. +## Using the migration tool to automatically upgrade your project to the new syntax -### Installazione dello strumento +Before explaining the various changes, it is worth noting that Riverpod comes with +a command-line tool to automatically migrate your project for you. -Per installare lo strumento di migrazione, eseguire: +### Installing the command line tool + +To install the migration tool, run: ```sh dart pub global activate riverpod_cli ``` -Dovresti poter eseguire ora: +You should now be able to run: ```sh riverpod --help ``` -### Uso +### Usage + +Now that the command line is installed, we can start using it. -Ora che lo strumento è installato, possiamo iniziare ad utilizzarlo. +- First, open the project you want to migrate in your terminal. +- **Do not** upgrade Riverpod. + The migration tool will upgrade the version of Riverpod for you. -- Per prima cosa, apri il progetto che vuoi migrare nel tuo terminale. -- **NON** aggiornare Riverpod. - Lo strumento di migrazione aggiornerà la versione di Riverpod per te. - :::danger PERICOLO - Non aggiornare Riverpod è importante. - Lo strumento non si eseguirà correttamente se hai già installato la versione 1.0.0. - Pertanto, assicurati di utilizzare correttamente una versione precedente prima di avviare lo strumento. + :::danger + Not upgrading Riverpod is important. + The tool will not execute properly if you have already installed version 1.0.0. + As such, make sure that you are properly using an older version before starting the tool. ::: -- Assicurati che il tuo progetto non contenga errori. -- Eseguire: +- Make sure that your project does not contain errors. +- Execute: ```sh riverpod migrate ``` -Lo strumento analizzerà il tuo progetto e ti suggerirà le modifiche. Per esempio potresti vedere: +The tool will then analyze your project and suggest changes. For example you may see: ```diff -Widget build(BuildContext context, ScopedReader watch) { @@ -58,25 +60,27 @@ Lo strumento analizzerà il tuo progetto e ti suggerirà le modifiche. Per esemp Accept change (y = yes, n = no [default], A = yes to all, q = quit)? ``` -Per accettare la modifica, premi semplicemente y. In caso contrario, premi n. +To accept the change, simply press y. Otherwise to reject it, press n. -## I cambiamenti +## The changes -Ora che abbiamo visto come utilizzare il terminale per aggiornare il nostro progetto, -vediamo nel dettaglio queste modifiche. +Now that we've seen how to use the CLI to automatically upgrade your project, +let's see in detail the changes necessary. -### Unificazione della sintassi +### Syntax unification -La versione 1.0.0 di Riverpod si concentra sull'unificazione della sintassi -per interagire con i provider. -Prima, Riverpod aveva molte sintassi simili ma diverse per leggere un provider, -come `ref.watch(provider)` vs `useProvider(provider)` vs `watch(provider)`. -Con la versione 1.0.0, rimane solo una sintassi: `ref.watch(provider)`. Le altre sono state rimosse. +Version 1.0.0 of Riverpod focused on the unification of the syntax for +interacting with providers. +Before, Riverpod had many similar yet different syntaxes for reading a provider, +such as `ref.watch(provider)` vs `useProvider(provider)` vs `watch(provider)`. +With version 1.0.0, only one syntax remains: `ref.watch(provider)`. The +others were removed. -Il che significa che: +As such: -- `useProvider` è stato rimosso in favore di `HookConsumerWidget`. - Prima: +- `useProvider` is removed in favor of `HookConsumerWidget`. + + Before: ```dart class Example extends HookWidget { @@ -89,7 +93,7 @@ Il che significa che: } ``` - Dopo: + After: ```dart class Example extends HookConsumerWidget { @@ -102,9 +106,9 @@ Il che significa che: } ``` -- Il prototipo del metodo `build` di `ConsumerWidget` e `Consumer` è stato cambiato. - - Prima: +- The prototype of `ConsumerWidget`'s `build` and `Consumer`'s `builder` changed. + + Before: ```dart class Example extends ConsumerWidget { @@ -123,7 +127,7 @@ Il che significa che: ) ``` - Dopo: + After: ```dart class Example extends ConsumerWidget { @@ -142,9 +146,9 @@ Il che significa che: ) ``` -- `context.read` è sostituito da `ref.read`. +- `context.read` is removed in favor of `ref.read`. - Prima: + Before: ```dart class Example extends StatelessWidget { @@ -157,7 +161,7 @@ Il che significa che: } ``` - Dopo: + After: ```dart class Example extends ConsumerWidget { @@ -170,15 +174,15 @@ Il che significa che: } ``` -### StateProvider +### StateProvider update -[StateProvider] è stato allineato con [StateNotifierProvider]. +[StateProvider] was updated to match [StateNotifierProvider]. -In precedenza, scrivere `ref.watch(StateProvider)` restituiva un'istanza `StateController`. -Ora restituisce solo lo stato di `StateController`. +Before, doing `ref.watch(StateProvider)` returned a `StateController` instance. +Now it only returns the state of the `StateController`. -Per migrare hai alcune soluzioni. -Se il tuo codice otteneva lo stato senza modificarlo, puoi cambiare da: +To migrate you have a few solutions. +If your code only obtained the state without modifying it, you can change from: ```dart final provider = StateProvider(...); @@ -192,7 +196,7 @@ Consumer( ) ``` -a: +to: ```dart final provider = StateProvider(...); @@ -206,8 +210,7 @@ Consumer( ) ``` -Alternativemente, puoi usare il nuovo `StateProvider.state` per mantenere -il vecchio comportamento. +Alternatively you can use the new `StateProvider.state` to keep the old behavior. ```dart final provider = StateProvider(...); @@ -221,6 +224,6 @@ Consumer( ) ``` -[statenotifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/StateNotifierProvider-class.html -[stateprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/StateProvider-class.html +[statenotifierprovider]: ../providers/state_notifier_provider +[stateprovider]: ../providers/state_provider [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx new file mode 100644 index 000000000..285136820 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx @@ -0,0 +1,132 @@ +--- +title: Da `ChangeNotifier` +--- + +import old from "!!raw-loader!./from_change_notifier/old.dart"; +import declaration from "./from_change_notifier/declaration"; +import initialization from "./from_change_notifier/initialization"; +import migrated from "./from_change_notifier/migrated"; + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +All'interno di Riverpod, `ChangeNotifierProvider` deve essere utilizzato per offrire una transizione +graduale da pkg:provider. + +Se hai appena iniziato una migrazione verso Riverpod, assicurati di leggere la guida dedicata +(consulta ). +Questo articolo è pensata per chi è già transizionato su Riverpod ma vuole distaccarsi dall'usare +`ChangeNotifier` in modo definitivo. + +Nel complesso, la migrazione da `ChangeNotifier` a `AsyncNotifer` richiede un cambio di paradigma, +ma comporta una grande semplificazione con il codice migrato risultante. +Consulta anche . + +Prendiamo in considerazione questo esempio (difettoso): + + +Questa implementazione mostra diverse lacune di progettazione come: +- L'utilizzo di `isLoading` e `hasError` per gestire differenti casi asincroni +- La necessita di gestire attentamente le richieste attraverso le espressioni `try`/`catch`/`finally` +- La necessita di invocare `notifyListeners` nei momenti giusti per far sì che questa implementazione funzioni +- La presenza di stato incoerenti o possibilmente indesiderabile, ad esempio l'inizializzazione con una lista vuota + +Si noti come questo esempio è stato realizzato per mostrare come `ChangeNotifier` possa portare a scelte +di design difettose per sviluppatori alle prime armi; inoltre, un'altra conclusione è che lo stato mutabile +potrebbe essere molto più difficile di quanto promesso inizialmente. + +`Notifier`/`AsyncNotifer`, in combinazione con lo stato immutabile, può portare a scelte di design migliori +e meno errori. + +Vediamo come migrare lo snippet precedente, un passo alla volta, verso le API più recenti + +## Inizia la tua migrazione + +Per prima cosa, dovremmo dichiarare il nuovo provider / notifier: questo richiede ci richiede una riflessione +su cosa dobbiamo fare che dipende dalla tua unica business logic. + +Riassumiamo le richieste: +- Lo stato è rappresentato con una `List`, che è ottenuta da una chiamata di rete, con nessun parametro +- Lo stato dovrebbe *anche* esporre informazioni sui suoi stati di `loading`, `error` e `data` +- Lo stato può essere mutato attraverso dei metodi esposti, quindi una funzione non è sufficiente + +:::tip +La riflessione appena fatta si riduce alla risposta alle seguenti domande: +1. Sono richiesti dei side effects? + - `y`: Utilizza le API di Riverpod basate su classi + - `n`: Utilizza le API di Riverpod basate sulle funzioni +2. Lo stato necessita di essere caricato in modo asincrono? + - `y`: Permettiamo a `build` di restituire `Future` + - `n`: Permettiamo a `build` di restituire semplicemente `T` +1. Sono richiesti dei parametri? + - `y`: Permettiamo a `build` (o alla tua funzione) di accettarli + - `n`: Non permettiamo a `build` (o alla tua funzione) di accettare parametri extra +::: + +:::info +Se stai utilizzando la generazione di codice, la riflessione precedente è abbastanza. +Non è necessario pensare ai nomi corretti delle classi e alle loro API *specifiche*. +`@riverpod` ti chiede solamente di scrivere una classe con il suo tipo da restituire, e questo basta. +::: + +Tecnicamente, la mossa migliore qui è definire un `AsyncNotifier>`, +che coprirà tutti i requisiti richiesti. Scriviamo per prima del pseudocodice. + + + +:::tip +Ricorda: utilizza gli snippet nel tuo IDE per avere una sorta di guida, oppure per velocizzare la scrittura del codice. +Consulta . +::: + +Rispetto all'implementazione di `ChangeNotifier`, non abbiamo più bisogno di dichiarare `todos`; +tale variabile è contenuta in `state`, che è implicitamente caricato con `build`. + +Infatti, i notifier di Riverpod possono esporre *una* entità alla volta. + +:::tip +Le API di Riverpod sono pensate per essere granulari, tuttavia, durante la migrazione, puoi comunque definire +un'entità personalizzata per contenere più valori. Inizialmente, valuta l'utilizzo dei +[record di Dart 3](https://dart.dev/language/records) per semplificare la migrazione. +::: + +### Inizializzazione + +Inizializzare un notifier è facile: basta scrivere la logica di inizializzazione dentro il metodo `build`. +Possiamo ora sbarazzarci della vecchia funzione `_init`. + + + +Rispetto alla vecchia funzone `_init`, al nuovo metodo `build` non manca nulla: non c'è più bisogno di +inizializzare variabili come `isLoading` o `hasError`. + +Riverpod tradurrà automaticamente qualsiasi provider asincrono esponendo un `AsyncValue>` e +gestirà le complessità dello stato asincrono in modo decisamente migliore rispetto a quello che possono fare +due semplici variabili booleane. + +Infatti, qualsiasi `AsyncNotifier` rende effettivamente la scrittura aggiuntiva di `try`/`catch`/`finally` +un anti-pattern per la gestione dello stato asincrono. + +### Mutazioni e Side effects + +Proprio come l'inizializzazione, quando si eseguono dei side effects non c'è la necessità di manipolare +variabili booleani come `hasError`, o di scrivere blocchi `try`/`catch`/`finally` aggiuntivi. + +Di seguito, abbiamo tagliato tutto il codice boilerplate e migrato con successo l'esempio di sopra: + + +:::tip +La sintassi e le scelte di progettazione possono variare, ma alla fine, quello di cui abbiamo bisogno +è scrivere le nostre richieste ed aggiornare lo stato in seguito. +Consulta . +::: + +## Riassunto del processo di migrazione + +Rivediamo l'intero processo di migrazione applicato in questa pagina, da un punto di vista operazionale. + +1. Abbiamo spostato l'inizializzazione, da un metodo personalizzato invocato in un costruttore, al metodo `build` +2. Abbiamo rimosso le proprietà `todos`, `isLoading` e `hasError`: la proprietà interna `state` sarà sufficiente +3. Abbiamo rimosso qualsiasi tipo blocco `try`-`catch`-`finally`, restituire il future è sufficiente +4. Abbiamo applicato la stessa simplificazione sui side effects (`addTodo`) +5. Abbiamo applicato le mutazioni, semplicemente riassegnando `state` diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart new file mode 100644 index 000000000..b3ca06ef2 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart @@ -0,0 +1,33 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'declaration.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() { + // TODO ... + return []; + } + + Future addTodo(Todo todo) async { + // TODO + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart new file mode 100644 index 000000000..e28ccbd61 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'declaration.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider + extends $AsyncNotifierProvider> { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'fc9a07f8ef9f792da2ac660d76ea0a809335ba18'; + +abstract class _$MyNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx new file mode 100644 index 000000000..1ad659c31 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./declaration.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart new file mode 100644 index 000000000..0c723f63c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart @@ -0,0 +1,34 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyNotifier extends AsyncNotifier> { + @override + FutureOr> build() { + // TODO ... + return []; + } + + Future addTodo(Todo todo) async { + // TODO + } +} + +final myNotifierProvider = + AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx new file mode 100644 index 000000000..3b3fbd2cb --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./initialization.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart new file mode 100644 index 000000000..4da805e13 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart @@ -0,0 +1,29 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'initialization.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + return [...json.map(Todo.fromJson)]; + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart new file mode 100644 index 000000000..032f36218 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'initialization.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider + extends $AsyncNotifierProvider> { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'1c67c12443102cf8c43efbf6c630d3028d9847c3'; + +abstract class _$MyNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart new file mode 100644 index 000000000..5ef9e85c1 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart @@ -0,0 +1,30 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyNotifier extends AsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + return [...json.map(Todo.fromJson)]; + } +} + +final myNotifierProvider = + AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx new file mode 100644 index 000000000..075bfbdf5 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./migrated.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart new file mode 100644 index 000000000..b8f4ba829 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart @@ -0,0 +1,37 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'migrated.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + Future addTodo(Todo todo) async { + // optional: state = const AsyncLoading(); + final json = await http.post('api/todos'); + final newTodos = [...json.map(Todo.fromJson)]; + state = AsyncData(newTodos); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart new file mode 100644 index 000000000..a70189d52 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'migrated.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider + extends $AsyncNotifierProvider> { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'bde95c56aa12eff7c8c01ede57ae4ad2b616c225'; + +abstract class _$MyNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart new file mode 100644 index 000000000..6927bd057 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart @@ -0,0 +1,38 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyNotifier extends AsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + Future addTodo(Todo todo) async { + // optional: state = const AsyncLoading(); + final json = await http.post('api/todos'); + final newTodos = [...json.map(Todo.fromJson)]; + state = AsyncData(newTodos); + } +} + +final myNotifierProvider = + AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart new file mode 100644 index 000000000..932804174 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart @@ -0,0 +1,60 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyChangeNotifier extends ChangeNotifier { + MyChangeNotifier() { + _init(); + } + List todos = []; + bool isLoading = true; + bool hasError = false; + + Future _init() async { + try { + final json = await http.get('api/todos'); + todos = [...json.map(Todo.fromJson)]; + } on Exception { + hasError = true; + } finally { + isLoading = false; + notifyListeners(); + } + } + + Future addTodo(int id) async { + isLoading = true; + notifyListeners(); + + try { + final json = await http.post('api/todos'); + todos = [...json.map(Todo.fromJson)]; + hasError = false; + } on Exception { + hasError = true; + } finally { + isLoading = false; + notifyListeners(); + } + } +} + +final myChangeProvider = ChangeNotifierProvider((ref) { + return MyChangeNotifier(); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx new file mode 100644 index 000000000..2c3e8f909 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx @@ -0,0 +1,264 @@ +--- +title: Da `StateNotifier` +--- + +import buildInit from "./from_state_notifier/build_init"; +import buildInitOld from "!!raw-loader!./from_state_notifier/build_init_old.dart"; +import consumersDontChange from "!!raw-loader!./from_state_notifier/consumers_dont_change.dart"; +import familyAndDispose from "./from_state_notifier/family_and_dispose"; +import familyAndDisposeOld from "!!raw-loader!./from_state_notifier/family_and_dispose_old.dart"; +import asyncNotifier from "./from_state_notifier/async_notifier"; +import asyncNotifierOld from "!!raw-loader!./from_state_notifier/async_notifier_old.dart"; +import addListener from "./from_state_notifier/add_listener"; +import addListenerOld from "!!raw-loader!./from_state_notifier/add_listener_old.dart"; +import fromStateProvider from "./from_state_notifier/from_state_provider"; +import fromStateProviderOld from "!!raw-loader!./from_state_notifier/from_state_provider_old.dart"; +import oldLifecycles from "./from_state_notifier/old_lifecycles"; +import oldLifecyclesOld from "!!raw-loader!./from_state_notifier/old_lifecycles_old.dart"; +import oldLifecyclesFinal from "./from_state_notifier/old_lifecycles_final"; +import obtainNotifierOnTests from "!!raw-loader!./from_state_notifier/obtain_notifier_on_tests.dart"; + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +Con [Riverpod 2.0](https://pub.dev/packages/flutter_riverpod/changelog#200), nuovi classi +sono state introdotte: `Notifier` / `AsyncNotifer`. +`StateNotifier` è ora sconsigliato a favore di queste nuove API. + +Questa pagina mostra come migrare dal deprecato `StateNotifier` a queste nuove API. + +Il beneficio principale introdotto da `AsyncNotifier` è un migliore supporto per operazioni `async`; +infatti, `AsyncNotifier` può essere pensato come un `FutureProvider` che espone dei modi per essere modificato dall'UI. + +Inoltre, il nuovo `(Async)Notifier`: + +- Espone un'oggetto `Ref` dentro la sua classe +- Offre una sintassi simile tra gli approcci con o senza generazione di codice +- Offre una sintassi simile tra le sue versioni sync e async. +- Sposta la logica dai Provider e la centralizza dentro gli stessi Notifier + +Vediamo come definire un `Notifier`, le differenze con `StateNotifier` e come migrare al nuovo +`AsyncNotifier` per lo stato asincrono. + +## Confronto della nuova sintassi + +Assicurati di sapere come definire un `Notifier` prima di tuffarti in questo confronto. +Consulta . + +Scriviamo un esempio, utilizzando la vecchia sintassi di `StateNotifier`: + + +Di seguito lo stesso esempio, costruito con le nuove API `Notifier` che si traduce approssimativamente in: + + +Confrontando `Notifier` e `StateNotifier`, si possono osservare queste differenze principali: + +- Le dipendenze reattive di `StateNotifier` sono dichiarate nel suo provider, mentre `Notifier` + centralizza questa logica nel suo metodo `build` +- L'intero processo di inizializzazione di `StateNotifier` è diviso tra il suo provider e il suo costruttore, + mentre `Notifier` riserva un unico posto in cui collocare tale logica +- Si noti come, a differenza di `StateNotifier`, nessuna logica viene mai scritta nel costruttore di un `Notifier` + +Conclusioni simili possono essere fatte con `AsyncNotifer`, ovvero l'equivalente `Notifier` per operazioni asincrone. + +## Migrare `StateNotifier` asincroni + +L'aspetto più interessante della nuova sintassi API è una DX migliorata sui dati asincroni. +Prendiamo il seguente esempio: + + + +Di seguito l'esempio precedente riscritto con le nuove API `AsyncNotifier`: + + + +`AsyncNotifier`, proprio come `Notifier`, introduce una più semplice ed uniforme API. +Qui è facile osservare come `AsyncNotifer` sia un `FutureProvider` con dei metodi. + +`AsyncNotifer` viene fornito con una serie di utilità e getters che `StateNotifier` non possiede, come +[`future`](https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifier/future.html) e +[`update`](https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifier/update.html). +Ciò ci permette di scrivere della logica più semplice quando gestiamo mutazioni asincrone e side-effects. +Vedere anche . + +:::tip +Migrare da `StateNotifier>` a `AsyncNotifer` si riduce a: + +- Mettere la logica di inizializzazione dentro `build` +- Rimuovere qualsiasi blocco `catch`/`try` in inizializzazione o nei metodi di side-effects +- Rimuovere qualsiasi `AsyncValue.guard` da `build`, poiché converte `Future` in `AsyncValue` +::: + +### Vantaggi + +Dopo questi esempi, evidenziamo ora i principali vantaggi di `Notifier` e `AsyncNotifier`: +- La nuova sintassi dovrebbe sembrare più semplice e più leggibile, specialmente per lo stato asincrono +- È probabile che le nuove API abbiano meno codice boilerplate in generale +- La sintassi ora è unificata, abilitando la generazione di codice; non importa la tipologia di provider che stai scrivendo +(consulta ) + +Addentriamoci ed evidenziamo più differenze e somiglianze. + +## Modifiche esplicite a `.family` e `.autoDispose` + +Un'altra importante differenza è come sono gestite le family e la funzionalità di auto dispose con le nuove API. + +`Notifier` ha le sue personali controparti di `.family` e `.autoDispose`, come `FamilyNotifier` +e `Notifier`. +Come sempre, queste modifiche possono essere combinate (aka `AutoDisposeFamilyNotifier`). +`AsyncNotifer` ha le sue controparti asincrone equivalenti, (`FamilyAsyncNotifier`). + +Questi modificatori sono esplicitamente dichiarati dentro la classe; qualsiasi parametro è iniettato direttamente +nel metodo `build` in modo tale da essere disponibile alla logica di inizializzazione. +Tutto questo dovrebbe portare una maggiore leggibilità, concisione e in generale meno errori. + +Prendiamo l'esempio seguente, dove un `StateNotifierProvider.family` viene definito. + + +`BugsEncounteredNotifier` sembra... pesante / difficile da leggere. +Diamo un'occhiata alla sua controparte `AsyncNotifier` migrata: + + + +La sua controparte migrata dovrebbe fornire una maggiore facilità di lettura. + +:::info +I parametri `.family` di `(Async)Notifier` sono disponibili tramite `this.arg` +(oppure tramite `this.paramName` quando si utilizza la generazione di codice) +::: + +## I cicli di vita hanno un comportamento differente + +I cicli di vita tra `Notifier`/`AsyncNotifier` e `StateNotifier` differiscono in modo sostanziale. + +Questo esempio mostra - di nuovo - come le vecchie API abbiano la logica sparsa: + + + +Qui, se `durationProvider` si aggiorna, `MyNotifier` _elimina_: la sua istanza è poi re-istanziata +e il suo stato interno è quindi re-inizializzato. +Inoltre, a differenza di tutti gli altri provider, la callback `dispose` deve essere definita +separatamente nella classe. +Infine, è ancora possibile scrivere `ref.onDispose` nel suo provider, mostrando ancora una volta come +possa essere sparsa la logica con quest'API; potenzialmente, lo sviluppatore potrebbe dover guardare otto (8!) +posti differenti per capire il comportamento di questo Notifier! + +Queste ambiguità sono risolte con `Riverpod 2.0`. + +### Vecchio `dispose` vs `ref.onDispose` +Il metodo `dispose` di `StateNotifier` si riferisce all'evento di distruzione del notificatore stesso, +ovvero è una callback che viena chiamata *prima di sbarazzarsi di se stesso*. + +Gli `(Async)Notifier` non hanno questa proprietà, dato che *non vengono distrutti durante la ricostruzione*; +solo il suo *stato interno* lo è. +Nei nuovi notifier, i cicli di vita di eliminazione sono gestiti in _un_ solo posto, tramite `ref.onDispose` +(e altri), proprio come qualsiasi altro provider. +Questo semplifica l'API, e, si spera la developer experience, in modo che ci sia solo _un_ posto a cui guardare +per comprendere gli effetti collaterali del ciclo di vita: il suo metodo `build`. + +In breve: per registrare una callback che si attiva prima che il suo *stato interno* venga ricostruito, possiamo usare +`ref.onDispose` come ogni altro provider. + +Puoi migrare lo snippet sopra in questo modo: + + + +In questo ultimo snippet abbiamo sicuramente introdotto della semplificazione, ma rimane ancora un problema: non +possiamo capire se i nostri notifier sono ancora attivi o no mentre eseguiamo `update`. +Ciò potrebbe verificare uno `StateError` indesiderato. + +### Non più `mounted` + +Questo accade perché `(Async)Notifier` manca della proprietà `mounted`, che era disponibile con `StateNotifier`. +Considerando la loro differenza nel ciclo di vita, questo ha perfettamente senso; seppur possibile, una +proprietà `mounted` sarebbe fuorviante sui nuovi notifier: `mounted` sarebbe *quasi sempre* `true`. + +Anche se sarebbe possibile creare una [soluzione alternativa personalizzata](https://github.com/rrousselGit/riverpod/issues/1879#issuecomment-1303189191), +si consiglia di aggirare questo problema annullando l'operazione asincrona. + +Annullare un'operazione può essere fatto con un [Completer](https://api.flutter.dev/flutter/dart-async/Completer-class.html) personalizzato, +o qualsiasi derivato personalizzato. + +Per esempio, se stai utilizzando `Dio` per eseguire richieste di rete, considera l'utilizzo di un [cancel token](https://pub.dev/documentation/dio/latest/dio/CancelToken-class.html) +(consulta anche ). + +Pertanto, l'esempio precedente viene migrato nel seguente: + + +## Le API di mutazione sono le stesse di prima + +Finora abbiamo mostrato le differenze tra `StateNotifier` e le nuove API. +Una cosa che invece `Notifier`, `AsyncNotifer` e `StateNotifier` condividono è il modo in cui i loro stati +possono essere consumati e mutati. + +I consumer possono ottenere dati da questi tre provider con la stessa sintassi, il che è ottimo nel caso +tu stai migrando da `StateNotifier`; questo si applica anche ai metodi dei notifier. + + + +## Altre migrazioni + +Esploriamo ora le differenze meno impattanti tra `StateNotifier` e `Notifier` (o `AsyncNotifier`) + +### Da `.addListener` e `.stream` + +`.addListener` e `.stream` di `StateNotifier` possono essere utilizzati per ascoltare i cambiamenti di stato. +Queste due API sono ormai da considerarsi superate. + +Ciò è intenzionale a causa del desiderio di raggiungere la completa uniformità dell'API con `Notifier`, `AsyncNotifier` e altri provider. +Infatti, l'utilizzo di un `Notifier` o di un `AsyncNotifier` non dovrebbe essere diverso da qualsiasi altro provider. + +Pertanto questo: + + +Diviene questo: + + +In poche parole: se vuoi ascoltare un `Notifier`/`AsyncNotifer`, usa semplicemente `ref.listen`. +Consulta . + +### Da `.debugState` nei test + +`StateNotifier` espone `.debugState`: questa proprietà è usata per gli utenti di [state_notifier](https://pub.dev/packages/state_notifier) +per abilitare l'accesso allo stato da fuori la classe quando si è in dev mode, per scopi di testing. + +Se stai utilizzando `.debugState` per accedere allo stato nei test, ci sono probabilità che tu debba abbandonare +questo approccio. + +`Notifier` / `AsyncNotifer` non hanno una prorpietà `.debugState`; invece, espongono direttamente `.state`, +che è `@visibleForTesting`. + +:::danger +EVITA di accedere a `.state` dai test; se devi farlo, fallo _solo e solo se_ hai già un +a `Notifier` / `AsyncNotifer` correttamente istanziato; solo dopo, puoi accedere a `.state` +all'interno dei test liberamente. + +Infatti, `Notifier` / `AsyncNotifier` _non dovrebbero_ essere istanziati a mano; al contrario, dovrebbero +essere interagiti utilizzando il relativo provider: non farlo *romperà* il notifier, a causa della mancata +inizializzazione di 'ref' e dei parametri family. +::: + +Non hai un'istanza `Notifier`? +Nessun problema, puoi ottenerne una con `ref.read`, proprio come leggeresti il suo stato esposto: + + + +Impara di più sui test nella loro guida dedicata. Consulta . + +### Da `StateProvider` + +`StateProvider` è stato esposto da Riverpod fin dalla sua release, ed era stato fatto per ridurre le +linee di codice per le versioni semplificate di `StateNotifierProvider`. +Dato che `StateNotifierProvider` è deprecato, anche `StateProvider` va evitato. +Inoltre, ad oggi, non c'è nessun equivalente di `StateProvider` per le nuove API. + +Ciò nonostante, migrare da `StateProvider` a `Notifier` è semplice. + +Questo: + + +Diventa: + + +Anche se ci costa qualche LoC in più, la migrazione da `StateProvider` +ci consente di archiviare definitivamente `StateNotifier`. diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart new file mode 100644 index 000000000..ead1c72d8 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart @@ -0,0 +1,18 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'add_listener.g.dart'; + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + ref.listenSelf((_, next) => debugPrint('$next')); + return 0; + } + + void add() => state++; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart new file mode 100644 index 000000000..9f4c200ed --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'add_listener.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'9acd382ed579c545ace755687b155e28eba01d22'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx new file mode 100644 index 000000000..6d7ac6d37 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./add_listener.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart new file mode 100644 index 000000000..d032a4c2d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart @@ -0,0 +1,17 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + ref.listenSelf((_, next) => debugPrint('$next')); + return 0; + } + + void add() => state++; +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart new file mode 100644 index 000000000..4ed97aa79 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart @@ -0,0 +1,25 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ +class MyNotifier extends StateNotifier { + MyNotifier() : super(0); + + void add() => state++; +} + +final myNotifierProvider = StateNotifierProvider((ref) { + final notifier = MyNotifier(); + + final cleanup = notifier.addListener((state) => debugPrint('$state')); + ref.onDispose(cleanup); + + // O in modo equivalente: + // final listener = notifier.stream.listen((event) => debugPrint('$event')); + // ref.onDispose(listener.cancel); + + return notifier; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart new file mode 100644 index 000000000..5ead76378 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_notifier.g.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class AsyncTodosNotifier extends _$AsyncTodosNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + // ... +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart new file mode 100644 index 000000000..0fd4946cb --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -0,0 +1,75 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(AsyncTodosNotifier) +const asyncTodosNotifierProvider = AsyncTodosNotifierProvider._(); + +final class AsyncTodosNotifierProvider + extends $AsyncNotifierProvider> { + const AsyncTodosNotifierProvider._( + {super.runNotifierBuildOverride, AsyncTodosNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'asyncTodosNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final AsyncTodosNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$asyncTodosNotifierHash(); + + @$internal + @override + AsyncTodosNotifier create() => _createCb?.call() ?? AsyncTodosNotifier(); + + @$internal + @override + AsyncTodosNotifierProvider $copyWithCreate( + AsyncTodosNotifier Function() create, + ) { + return AsyncTodosNotifierProvider._(create: create); + } + + @$internal + @override + AsyncTodosNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + AsyncTodosNotifier, + ) build, + ) { + return AsyncTodosNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$asyncTodosNotifierHash() => + r'10207327c7dee180e9da8beece5bfffedcf86e98'; + +abstract class _$AsyncTodosNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx new file mode 100644 index 000000000..a0ff513c3 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./async_notifier.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart new file mode 100644 index 000000000..ac91d2f88 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart @@ -0,0 +1,31 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class AsyncTodosNotifier extends AsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + // ... +} + +final asyncTodosNotifier = + AsyncNotifierProvider>( + AsyncTodosNotifier.new, +); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart new file mode 100644 index 000000000..50d7f4aed --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart @@ -0,0 +1,30 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class AsyncTodosNotifier extends StateNotifier>> { + AsyncTodosNotifier() : super(const AsyncLoading()) { + _postInit(); + } + + Future _postInit() async { + state = await AsyncValue.guard(() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + }); + } + + // ... +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart new file mode 100644 index 000000000..3e2303b7a --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart @@ -0,0 +1,15 @@ +// ignore_for_file: avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'build_init.g.dart'; + +/* SNIPPET START */ +@riverpod +class CounterNotifier extends _$CounterNotifier { + @override + int build() => 0; + + void increment() => state++; + void decrement() => state++; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart new file mode 100644 index 000000000..c180fbb60 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart @@ -0,0 +1,82 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'build_init.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(CounterNotifier) +const counterNotifierProvider = CounterNotifierProvider._(); + +final class CounterNotifierProvider + extends $NotifierProvider { + const CounterNotifierProvider._( + {super.runNotifierBuildOverride, CounterNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CounterNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + CounterNotifier create() => _createCb?.call() ?? CounterNotifier(); + + @$internal + @override + CounterNotifierProvider $copyWithCreate( + CounterNotifier Function() create, + ) { + return CounterNotifierProvider._(create: create); + } + + @$internal + @override + CounterNotifierProvider $copyWithBuild( + int Function( + Ref, + CounterNotifier, + ) build, + ) { + return CounterNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterNotifierHash() => r'8d4e4011da15a0ef79af9622336839a0c9e406ab'; + +abstract class _$CounterNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx new file mode 100644 index 000000000..276a143ac --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./build_init.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart new file mode 100644 index 000000000..9456a84da --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart @@ -0,0 +1,14 @@ +// ignore_for_file: avoid_print + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class CounterNotifier extends Notifier { + @override + int build() => 0; + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = NotifierProvider(CounterNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart new file mode 100644 index 000000000..034b059ec --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart @@ -0,0 +1,15 @@ +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +class CounterNotifier extends StateNotifier { + CounterNotifier() : super(0); + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = + StateNotifierProvider((ref) { + return CounterNotifier(); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart new file mode 100644 index 000000000..e358a2e54 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart @@ -0,0 +1,38 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class CounterNotifier extends StateNotifier { + CounterNotifier() : super(0); + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = + StateNotifierProvider((ref) { + return CounterNotifier(); +}); + +/* SNIPPET START */ +class SomeConsumer extends ConsumerWidget { + const SomeConsumer({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + /* highlight-start */ + final counter = ref.watch(counterNotifierProvider); + /* highlight-end */ + return Column( + children: [ + Text("You've counted up until $counter, good job!"), + TextButton( + /* highlight-start */ + onPressed: ref.read(counterNotifierProvider.notifier).increment, + /* highlight-end */ + child: const Text('Count even more!'), + ), + ], + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart new file mode 100644 index 000000000..9a695614c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'family_and_dispose.g.dart'; + +/* SNIPPET START */ +@riverpod +class BugsEncounteredNotifier extends _$BugsEncounteredNotifier { + @override + FutureOr build(String featureId) { + return 99; + } + + Future fix(int amount) async { + final old = await future; + final result = await ref.read(taskTrackerProvider).fix(id: this.featureId, fixed: amount); + state = AsyncData(max(old - result, 0)); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart new file mode 100644 index 000000000..4c6b1cb46 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -0,0 +1,170 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family_and_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(BugsEncounteredNotifier) +const bugsEncounteredNotifierProvider = BugsEncounteredNotifierFamily._(); + +final class BugsEncounteredNotifierProvider + extends $AsyncNotifierProvider { + const BugsEncounteredNotifierProvider._( + {required BugsEncounteredNotifierFamily super.from, + required String super.argument, + super.runNotifierBuildOverride, + BugsEncounteredNotifier Function()? create}) + : _createCb = create, + super( + name: r'bugsEncounteredNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final BugsEncounteredNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$bugsEncounteredNotifierHash(); + + @override + String toString() { + return r'bugsEncounteredNotifierProvider' + '' + '($argument)'; + } + + @$internal + @override + BugsEncounteredNotifier create() => + _createCb?.call() ?? BugsEncounteredNotifier(); + + @$internal + @override + BugsEncounteredNotifierProvider $copyWithCreate( + BugsEncounteredNotifier Function() create, + ) { + return BugsEncounteredNotifierProvider._( + argument: argument as String, + from: from! as BugsEncounteredNotifierFamily, + create: create); + } + + @$internal + @override + BugsEncounteredNotifierProvider $copyWithBuild( + FutureOr Function( + Ref>, + BugsEncounteredNotifier, + ) build, + ) { + return BugsEncounteredNotifierProvider._( + argument: argument as String, + from: from! as BugsEncounteredNotifierFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is BugsEncounteredNotifierProvider && + other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$bugsEncounteredNotifierHash() => + r'c76e924f84db91c57d226896b062d9f4e8ab79e5'; + +final class BugsEncounteredNotifierFamily extends Family { + const BugsEncounteredNotifierFamily._() + : super( + name: r'bugsEncounteredNotifierProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + BugsEncounteredNotifierProvider call( + String featureId, + ) => + BugsEncounteredNotifierProvider._(argument: featureId, from: this); + + @override + String debugGetCreateSourceHash() => _$bugsEncounteredNotifierHash(); + + @override + String toString() => r'bugsEncounteredNotifierProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + BugsEncounteredNotifier Function( + String args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as BugsEncounteredNotifierProvider; + + final argument = provider.argument as String; + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + FutureOr Function(Ref> ref, + BugsEncounteredNotifier notifier, String argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as BugsEncounteredNotifierProvider; + + final argument = provider.argument as String; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(container); + }, + ); + } +} + +abstract class _$BugsEncounteredNotifier extends $AsyncNotifier { + late final _$args = + (ref as $AsyncNotifierProviderElement).origin.argument as String; + String get featureId => _$args; + + FutureOr build( + String featureId, + ); + @$internal + @override + FutureOr runBuild() => build( + _$args, + ); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx new file mode 100644 index 000000000..0780f2135 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./family_and_dispose.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart new file mode 100644 index 000000000..b7068013a --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart @@ -0,0 +1,28 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +/* SNIPPET START */ +class BugsEncounteredNotifier extends FamilyAsyncNotifier { + @override + FutureOr build(String featureId) { + return 99; + } + + Future fix(int amount) async { + final old = await future; + final result = + await ref.read(taskTrackerProvider).fix(id: this.arg, fixed: amount); + state = AsyncData(max(old - result, 0)); + } +} + +final bugsEncounteredNotifierProvider = AsyncNotifierProvider.family + .autoDispose( + BugsEncounteredNotifier.new, +); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart new file mode 100644 index 000000000..f01455cf7 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart @@ -0,0 +1,32 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../utils.dart'; + +/* SNIPPET START */ +class BugsEncounteredNotifier extends StateNotifier> { + BugsEncounteredNotifier({ + required this.ref, + required this.featureId, + }) : super(const AsyncData(99)); + final String featureId; + final Ref> ref; + + Future fix(int amount) async { + state = await AsyncValue.guard(() async { + final old = state.requireValue; + final result = + await ref.read(taskTrackerProvider).fix(id: featureId, fixed: amount); + return max(old - result, 0); + }); + } +} + +final bugsEncounteredNotifierProvider = StateNotifierProvider.family + .autoDispose, String>((ref, id) { + return BugsEncounteredNotifier(ref: ref, featureId: id); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart new file mode 100644 index 000000000..2c71d6144 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'from_state_provider.g.dart'; + +/* SNIPPET START */ +@riverpod +class CounterNotifier extends _$CounterNotifier { + @override + int build() => 0; + + @override + set state(int newState) => super.state = newState; + int update(int Function(int state) cb) => state = cb(state); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart new file mode 100644 index 000000000..94f793831 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -0,0 +1,82 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'from_state_provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(CounterNotifier) +const counterNotifierProvider = CounterNotifierProvider._(); + +final class CounterNotifierProvider + extends $NotifierProvider { + const CounterNotifierProvider._( + {super.runNotifierBuildOverride, CounterNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CounterNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + CounterNotifier create() => _createCb?.call() ?? CounterNotifier(); + + @$internal + @override + CounterNotifierProvider $copyWithCreate( + CounterNotifier Function() create, + ) { + return CounterNotifierProvider._(create: create); + } + + @$internal + @override + CounterNotifierProvider $copyWithBuild( + int Function( + Ref, + CounterNotifier, + ) build, + ) { + return CounterNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterNotifierHash() => r'b32033040f0fff627f1a6dfd9cfb4e93a842390b'; + +abstract class _$CounterNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx new file mode 100644 index 000000000..f59794999 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./from_state_provider.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart new file mode 100644 index 000000000..ee7eb761e --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart @@ -0,0 +1,14 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +class CounterNotifier extends Notifier { + @override + int build() => 0; + + @override + set state(int newState) => super.state = newState; + int update(int Function(int state) cb) => state = cb(state); +} + +final counterNotifierProvider = + NotifierProvider(CounterNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart new file mode 100644 index 000000000..4b4ec6aa4 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart @@ -0,0 +1,6 @@ +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ +final counterProvider = StateProvider((ref) { + return 0; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart new file mode 100644 index 000000000..8b4a15dcb --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart @@ -0,0 +1,34 @@ +// ignore_for_file: unused_local_variable,omit_local_variable_types + +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class MyNotifier extends Notifier { + @override + int build() { + return 0; + } +} + +final myNotifierProvider = + NotifierProvider.autoDispose(MyNotifier.new); + +/* SNIPPET START */ +void main(List args) { + test('my test', () { + final container = ProviderContainer(); + addTearDown(container.dispose); + + // Ottenendo un notifier + /* highlight-start */ + final Notifier notifier = container.read(myNotifierProvider.notifier); + /* highlight-end */ + + // Ottenendo il suo stato esposto + /* highlight-start */ + final int state = container.read(myNotifierProvider); + /* highlight-end */ + + // TODO scrivi i tuoi test + }); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx new file mode 100644 index 000000000..9b77f551a --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./old_lifecycles.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart new file mode 100644 index 000000000..c52960017 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart @@ -0,0 +1,39 @@ +// ignore_for_file: library_private_types_in_public_api + +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'old_lifecycles.g.dart'; + +@riverpod +_MyRepo repository(RepositoryRef ref) { + return _MyRepo(); +} + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // Basta leggere/scrivere il codice qui, in un posto + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); + // `mounted` non è più necessario! + state++; // This might throw. + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart new file mode 100644 index 000000000..deac12aa7 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -0,0 +1,141 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'old_lifecycles.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RepositoryRef = Ref<_MyRepo>; + +@ProviderFor(repository) +const repositoryProvider = RepositoryProvider._(); + +final class RepositoryProvider + extends $FunctionalProvider<_MyRepo, _MyRepo, RepositoryRef> + with $Provider<_MyRepo, RepositoryRef> { + const RepositoryProvider._( + {_MyRepo Function( + RepositoryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'repositoryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final _MyRepo Function( + RepositoryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$repositoryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(_MyRepo value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider<_MyRepo>(value), + ); + } + + @$internal + @override + $ProviderElement<_MyRepo> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RepositoryProvider $copyWithCreate( + _MyRepo Function( + RepositoryRef ref, + ) create, + ) { + return RepositoryProvider._(create: create); + } + + @override + _MyRepo create(RepositoryRef ref) { + final _$cb = _createCb ?? repository; + return _$cb(ref); + } +} + +String _$repositoryHash() => r'e271c7e2cb18076d5eb6d2cd4e47b96a97a35e6f'; + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'0495c52ce893ee0304d4d5ac5648c634ed4a241e'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart new file mode 100644 index 000000000..92e6b49f2 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart @@ -0,0 +1,35 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod/riverpod.dart'; + +import '../../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + // Just read/write the code here, in one place + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); + // `mounted` is no more! + state++; // This might throw. + } +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx new file mode 100644 index 000000000..9823b1564 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./old_lifecycles_final.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart new file mode 100644 index 000000000..0d74bb1f2 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart @@ -0,0 +1,41 @@ +// ignore_for_file: library_private_types_in_public_api + +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'old_lifecycles_final.g.dart'; + +@riverpod +_MyRepo repository(RepositoryRef ref) { + return _MyRepo(); +} + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // Legge/scrive il codice solamente qui, in un posto unico + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + final cancelToken = CancelToken(); + ref.onDispose(cancelToken.cancel); + await ref.read(repositoryProvider).update(state + 1, token: cancelToken); + // Quando `cancelToken.cancel` è invocato, una Exception personalizzata viene generata + state++; + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart new file mode 100644 index 000000000..76fd303d0 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -0,0 +1,141 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'old_lifecycles_final.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RepositoryRef = Ref<_MyRepo>; + +@ProviderFor(repository) +const repositoryProvider = RepositoryProvider._(); + +final class RepositoryProvider + extends $FunctionalProvider<_MyRepo, _MyRepo, RepositoryRef> + with $Provider<_MyRepo, RepositoryRef> { + const RepositoryProvider._( + {_MyRepo Function( + RepositoryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'repositoryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final _MyRepo Function( + RepositoryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$repositoryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(_MyRepo value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider<_MyRepo>(value), + ); + } + + @$internal + @override + $ProviderElement<_MyRepo> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RepositoryProvider $copyWithCreate( + _MyRepo Function( + RepositoryRef ref, + ) create, + ) { + return RepositoryProvider._(create: create); + } + + @override + _MyRepo create(RepositoryRef ref) { + final _$cb = _createCb ?? repository; + return _$cb(ref); + } +} + +String _$repositoryHash() => r'e271c7e2cb18076d5eb6d2cd4e47b96a97a35e6f'; + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'8ea2586ea29d12306efd4b8b847142136dd20338'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart new file mode 100644 index 000000000..3f013b2b0 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart @@ -0,0 +1,36 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod/riverpod.dart'; + +import '../../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + // Legge/scrive il codice solamente qui, in un posto unico + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + final cancelToken = CancelToken(); + ref.onDispose(cancelToken.cancel); + await ref.read(repositoryProvider).update(state + 1, token: cancelToken); + state++; + } +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart new file mode 100644 index 000000000..880fcee10 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart @@ -0,0 +1,43 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +import '../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends StateNotifier { + MyNotifier(this.ref, this.period) : super(0) { + // 1 init logic + _timer = Timer.periodic(period, (t) => update()); // 2 side effect on init + } + final Duration period; + final Ref ref; + late final Timer _timer; + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); // 3 mutation + if (mounted) state++; // 4 check for mounted props + } + + @override + void dispose() { + _timer.cancel(); // 5 custom dispose logic + super.dispose(); + } +} + +final myNotifierProvider = StateNotifierProvider((ref) { + // 6 provider definition + final period = ref.watch(durationProvider); // 7 reactive dependency logic + return MyNotifier(ref, period); // 8 pipe down `ref` +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.dart new file mode 100644 index 000000000..ad922b1e3 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.dart @@ -0,0 +1,23 @@ +import 'dart:math' as math; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'utils.g.dart'; + +@riverpod +int random(RandomRef ref) { + return math.Random().nextInt(6); +} + +@riverpod +TaskTrackerRepo taskTracker(TaskTrackerRef ref) => TaskTrackerRepo(); + +class TaskTrackerRepo { + Future fix({required String id, required int fixed}) async => 0; +} + +@riverpod +Duration duration(DurationRef ref) => Duration.zero; + +@riverpod +int availableWater(AvailableWaterRef ref) => 40; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.g.dart new file mode 100644 index 000000000..72f425f1d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.g.dart @@ -0,0 +1,254 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'utils.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RandomRef = Ref; + +@ProviderFor(random) +const randomProvider = RandomProvider._(); + +final class RandomProvider extends $FunctionalProvider + with $Provider { + const RandomProvider._( + {int Function( + RandomRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'randomProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + RandomRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$randomHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RandomProvider $copyWithCreate( + int Function( + RandomRef ref, + ) create, + ) { + return RandomProvider._(create: create); + } + + @override + int create(RandomRef ref) { + final _$cb = _createCb ?? random; + return _$cb(ref); + } +} + +String _$randomHash() => r'789ed69452c1cde06c8a48f69eae2c242e7764ab'; + +typedef TaskTrackerRef = Ref; + +@ProviderFor(taskTracker) +const taskTrackerProvider = TaskTrackerProvider._(); + +final class TaskTrackerProvider extends $FunctionalProvider< + TaskTrackerRepo, + TaskTrackerRepo, + TaskTrackerRef> with $Provider { + const TaskTrackerProvider._( + {TaskTrackerRepo Function( + TaskTrackerRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'taskTrackerProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TaskTrackerRepo Function( + TaskTrackerRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$taskTrackerHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(TaskTrackerRepo value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + TaskTrackerProvider $copyWithCreate( + TaskTrackerRepo Function( + TaskTrackerRef ref, + ) create, + ) { + return TaskTrackerProvider._(create: create); + } + + @override + TaskTrackerRepo create(TaskTrackerRef ref) { + final _$cb = _createCb ?? taskTracker; + return _$cb(ref); + } +} + +String _$taskTrackerHash() => r'd78149146c3a07b78e7dc1d03fa60ed1941c3702'; + +typedef DurationRef = Ref; + +@ProviderFor(duration) +const durationProvider = DurationProvider._(); + +final class DurationProvider + extends $FunctionalProvider + with $Provider { + const DurationProvider._( + {Duration Function( + DurationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'durationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Duration Function( + DurationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$durationHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Duration value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DurationProvider $copyWithCreate( + Duration Function( + DurationRef ref, + ) create, + ) { + return DurationProvider._(create: create); + } + + @override + Duration create(DurationRef ref) { + final _$cb = _createCb ?? duration; + return _$cb(ref); + } +} + +String _$durationHash() => r'00e8192d47835ec451b18bc2cfc1e8610aa5f5c2'; + +typedef AvailableWaterRef = Ref; + +@ProviderFor(availableWater) +const availableWaterProvider = AvailableWaterProvider._(); + +final class AvailableWaterProvider + extends $FunctionalProvider + with $Provider { + const AvailableWaterProvider._( + {int Function( + AvailableWaterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'availableWaterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + AvailableWaterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$availableWaterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + AvailableWaterProvider $copyWithCreate( + int Function( + AvailableWaterRef ref, + ) create, + ) { + return AvailableWaterProvider._(create: create); + } + + @override + int create(AvailableWaterRef ref) { + final _$cb = _createCb ?? availableWater; + return _$cb(ref); + } +} + +String _$availableWaterHash() => r'7d4e8fb0dd7ff52a78eb569b39c4e472c364aac7'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx new file mode 100644 index 000000000..5143f6f51 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx @@ -0,0 +1,55 @@ +--- +title: ChangeNotifierProvider +--- + +import CodeBlock from "@theme/CodeBlock"; +import todos from "!!raw-loader!/docs/providers/change_notifier_provider/todos.dart"; +import todosConsumer from "!!raw-loader!/docs/providers/change_notifier_provider/todos_consumer.dart"; +import { trimSnippet } from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + +`ChangeNotifierProvider` (flutter_riverpod/hooks_riverpod only) is a provider that +is used to listen to and expose a [ChangeNotifier] from Flutter itself. + +Using `ChangeNotifierProvider` is discouraged by Riverpod and exists primarily for: + +- an easy transition from `package:provider` when using its `ChangeNotifierProvider` +- supporting mutable state, even though immutable state is preferred + +:::info +Prefer using [NotifierProvider] instead. +Consider using `ChangeNotifierProvider` only if you are absolutely certain +that you want mutable state. +::: + +Using mutable state instead of immutable state can sometimes be more efficient. +The downside is, it can be harder to maintain and may break various features. +For example, using `provider.select` to optimize rebuilds of your widgets +may not work if your state is mutable, as `select` will think that the value +hasn't changed. +As such, using immutable data structures can sometimes be faster. Therefore +it is important to make benchmarks specific to your use-case, to make sure +that you are truly gaining performance by using `ChangeNotifierProvider`. + +As a usage example, we could use `ChangeNotifierProvider` to implement a todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: + +{trimSnippet(todos)} + +Now that we have defined a `ChangeNotifierProvider`, we can use it to interact +with the list of todos in our UI: + +{trimSnippet(todosConsumer)} + +[state_notifier]: https://pub.dev/packages/state_notifier +[statenotifierprovider]: ./state_notifier_provider +[notifierprovider]: ./notifier_provider +[changenotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html +[provider]: ./provider +[futureprovider]: ./future_provider diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart new file mode 100644 index 000000000..a88c25c71 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart @@ -0,0 +1,45 @@ +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ + +class Todo { + Todo({ + required this.id, + required this.description, + required this.completed, + }); + + String id; + String description; + bool completed; +} + +class TodosNotifier extends ChangeNotifier { + final todos = []; + + // Let's allow the UI to add todos. + void addTodo(Todo todo) { + todos.add(todo); + notifyListeners(); + } + + // Let's allow removing todos + void removeTodo(String todoId) { + todos.remove(todos.firstWhere((element) => element.id == todoId)); + notifyListeners(); + } + + // Let's mark a todo as completed + void toggle(String todoId) { + final todo = todos.firstWhere((todo) => todo.id == todoId); + todo.completed = !todo.completed; + notifyListeners(); + } +} + +// Finally, we are using ChangeNotifierProvider to allow the UI to interact with +// our TodosNotifier class. +final todosProvider = ChangeNotifierProvider((ref) { + return TodosNotifier(); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart new file mode 100644 index 000000000..beac13f4e --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos_consumer.dart @@ -0,0 +1,32 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'todos.dart'; + +/* SNIPPET START */ + +class TodoListView extends ConsumerWidget { + const TodoListView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // rebuild the widget when the todo list changes + List todos = ref.watch(todosProvider).todos; + + // Let's render the todos in a scrollable list view + return ListView( + children: [ + for (final todo in todos) + CheckboxListTile( + value: todo.completed, + // When tapping on the todo, change its completed status + onChanged: (value) => + ref.read(todosProvider.notifier).toggle(todo.id), + title: Text(todo.description), + ), + ], + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider.mdx index ebe81b41f..6f114320a 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider.mdx @@ -3,53 +3,60 @@ title: FutureProvider version: 1 --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import configProvider from "/docs/providers/future_provider/config_provider"; -import configConsumer from "/docs/providers/future_provider/config_consumer"; -import { trimSnippet,AutoSnippet} from "../../../../../src/components/CodeSnippet"; +import configProvider from "./future_provider/config_provider"; +import configConsumer from "./future_provider/config_consumer"; +import { AutoSnippet} from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -`FutureProvider` è l'equivalente di [Provider] ma per il codice asincrono. +`FutureProvider` is the equivalent of [Provider] but for asynchronous code. -`FutureProvider` è tipicamente usato per: +`FutureProvider` is typically used for: -- eseguire e memorizzare nella cache operazioni asincrone (come le richieste di rete) -- gestire ottimamente gli stati di errore/caricamento delle operazioni asincrone -- combinare più valori asincroni in un altro valore +- performing and caching asynchronous operations (such as network requests) +- nicely handling error/loading states of asynchronous operations +- combining multiple asynchronous values into another value -`FutureProvider` è ottimo quando combinato con [ref.watch]. Tale combinazione consente il ri-ottenimento automatico -dei dati al variare di alcune variabili, assicurando che si abbia sempre il valore più aggiornato. +`FutureProvider` gains a lot when combined with [ref.watch]. This combination +allows automatic re-fetching of some data when some variables change, +ensuring that we always have the most up-to-date value. :::info -`FutureProvider` non offre un modo per modificare direttamente il calcolo (o computazione) dopo un'interazione dell'utente. -È invece progettato per risolvere semplici casi d'uso. -Per scenari più avanzati, considera usare [StateNotifierProvider]. +`FutureProvider` does not offer a way of directly modifying the computation after +a user interaction. It is designed to solve simple use-cases. +For more advanced scenarios, consider using [AsyncNotifierProvider]. ::: -## Esempio d'uso: leggere un file di configurazione +## Usage example: reading a configuration file -`FutureProvider` può essere utile per esporre un oggetto `Configuration` -creato leggendo un file JSON. +`FutureProvider` can be a convenient way to expose a `Configuration` object +created by reading a JSON file. -La creazione della configurazione verrebbe eseguita con la tipica sintassi async/await, ma all'interno del provider. -Usando gli asset di Flutter, sarebbe quindi: +Creating the configuration would be done with your typical async/await +syntax, but inside the provider. +Using Flutter's asset system, this would be: -Successivamente, la UI può stare in ascolto delle configurazioni in questo modo: + +Then, the UI can listen to configurations like so: -Ciò ricostruirà automaticamente l'interfaccia quando il [Future] finisce. -Allo stesso tempo, se più widget vogliono accedere alle configurazioni, l'asset verrà decodificato solo una volta. +This will automatically rebuild the UI when the [Future] completes. +At the same time, if multiple widgets want the configurations, +the asset will be decoded only once. -Come puoi vedere, ascoltare un `FutureProvider` dentro un widget restituisce un [AsyncValue], -il che permette di gestire gli stati di errore/caricamento. +As you can see, listening to a `FutureProvider` inside a widget returns +an [AsyncValue] – which allows handling the error/loading states. -[ref.watch]: ../concepts/reading#usare-ref.watch-per-osservare-un-provider -[statenotifierprovider]: ./state_notifier_provider +[ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider +[asyncnotifierprovider]: ./notifier_provider [provider]: ./provider [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html [future]: https://api.dart.dev/dart-async/Future-class.html -[family]: ../concepts/modifiers/family \ No newline at end of file +[family]: ../concepts/modifiers/family diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart new file mode 100644 index 000000000..a96f35e72 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart @@ -0,0 +1,16 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../config_provider/codegen.dart'; + +/* SNIPPET START */ + +Widget build(BuildContext context, WidgetRef ref) { + final config = ref.watch(fetchConfigurationProvider); + + return switch (config) { + AsyncError(:final error) => Text('Error: $error'), + AsyncData(:final value) => Text(value.host), + _ => const CircularProgressIndicator(), + }; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart new file mode 100644 index 000000000..44d9b4df9 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart @@ -0,0 +1,21 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import '../config_provider/raw.dart'; + +/* SNIPPET START */ + +class MyConfiguration extends HookConsumerWidget { + const MyConfiguration({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final config = ref.watch(configProvider); + return Scaffold( + body: switch (config) { + AsyncError(:final error) => Center(child: Text('Error: $error')), + AsyncData(:final value) => Center(child: Text(value.host)), + _ => const Center(child: CircularProgressIndicator()), + }, + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart new file mode 100644 index 000000000..ade0628fd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart @@ -0,0 +1,22 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../config_provider/codegen.dart'; + +/* SNIPPET START */ + +class MyConfiguration extends HookConsumerWidget { + const MyConfiguration({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final config = ref.watch(fetchConfigurationProvider); + return Scaffold( + body: switch (config) { + AsyncError(:final error) => Center(child: Text('Error: $error')), + AsyncData(:final value) => Center(child: Text(value.host)), + _ => const Center(child: CircularProgressIndicator()), + }, + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/index.tsx new file mode 100644 index 000000000..8e7b2a443 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/index.tsx @@ -0,0 +1,11 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; +import hooks from "!!raw-loader!./hooks.dart"; +import hooksCodegen from "!!raw-loader!./hooks_codegen.dart" + +export default { + raw, + hooks, + codegen, + hooksCodegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart new file mode 100644 index 000000000..9d39f3bcd --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart @@ -0,0 +1,18 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../config_provider/raw.dart'; + +/* SNIPPET START */ + +Widget build(BuildContext context, WidgetRef ref) { + AsyncValue config = ref.watch(configProvider); + + return switch (config) { + AsyncData(:final value) => Text(value.host), + AsyncError(:final error) => Text('Error: $error'), + _ => const CircularProgressIndicator(), + }; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.dart new file mode 100644 index 000000000..2aa87a29e --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.dart @@ -0,0 +1,22 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +import 'dart:convert'; + +import 'package:flutter/services.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +part 'codegen.g.dart'; +class Configuration { + Configuration.fromJson(Map json); + final String host = ''; +} + +/* SNIPPET START */ + +@riverpod +Future fetchConfiguration(FetchConfigurationRef ref) async { + final content = json.decode( + await rootBundle.loadString('assets/configurations.json'), + ) as Map; + + return Configuration.fromJson(content); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart new file mode 100644 index 000000000..f89247e93 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/codegen.g.dart @@ -0,0 +1,71 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef FetchConfigurationRef = Ref>; + +@ProviderFor(fetchConfiguration) +const fetchConfigurationProvider = FetchConfigurationProvider._(); + +final class FetchConfigurationProvider extends $FunctionalProvider< + AsyncValue, + FutureOr, + FetchConfigurationRef> + with + $FutureModifier, + $FutureProvider { + const FetchConfigurationProvider._( + {FutureOr Function( + FetchConfigurationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'fetchConfigurationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + FetchConfigurationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$fetchConfigurationHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + FetchConfigurationProvider $copyWithCreate( + FutureOr Function( + FetchConfigurationRef ref, + ) create, + ) { + return FetchConfigurationProvider._(create: create); + } + + @override + FutureOr create(FetchConfigurationRef ref) { + final _$cb = _createCb ?? fetchConfiguration; + return _$cb(ref); + } +} + +String _$fetchConfigurationHash() => + r'6c0f062e6f20baf883c4282856f1197fbe633d89'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/raw.dart new file mode 100644 index 000000000..62d7926ca --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/future_provider/config_provider/raw.dart @@ -0,0 +1,22 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +import 'dart:convert'; + +import 'package:flutter/services.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Configuration { + Configuration.fromJson(Map json); + + final String host = ''; +} + +/* SNIPPET START */ + +final configProvider = FutureProvider((ref) async { + final content = json.decode( + await rootBundle.loadString('assets/configurations.json'), + ) as Map; + + return Configuration.fromJson(content); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx new file mode 100644 index 000000000..4432f874f --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx @@ -0,0 +1,55 @@ +--- +title: (Async)NotifierProvider +--- + +import CodeBlock from "@theme/CodeBlock"; +import todos from "./notifier_provider/todos"; +import todosConsumer from "!!raw-loader!/docs/providers/notifier_provider/todos/todos_consumer.dart"; +import remoteTodos from "./notifier_provider/remote_todos"; +import remoteTodosConsumer from "!!raw-loader!/docs/providers/notifier_provider/remote_todos/todos_consumer.dart"; +import { trimSnippet, AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + +[NotifierProvider] is a provider that is used to listen to and expose a [Notifier]. +[AsyncNotifierProvider] is a provider that is used to listen to and expose an [AsyncNotifier]. +[AsyncNotifier] is a [Notifier] that can be asynchronously initialized. +`(Async)NotifierProvider` along with `(Async)Notifier` is Riverpod's recommended solution +for managing state which may change in reaction to a user interaction. + +It is typically used for: + +- exposing a state which can change over time after reacting to custom events. +- centralizing the logic for modifying some state (aka "business logic") in a + single place, improving maintainability over time. + +As a usage example, we could use [NotifierProvider] to implement a todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: + + + +Now that we have defined a [NotifierProvider], we can use it to interact +with the list of todos in our UI: + +{trimSnippet(todosConsumer)} + +As a usage example, we could use [AsyncNotifierProvider] to implement a remote todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: + + + +Now that we have defined a [AsyncNotifierProvider], we can use it to interact +with the list of todos in our UI: + +{trimSnippet(remoteTodosConsumer)} + +[notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html +[notifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/NotifierProvider.html +[asyncnotifier]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifier-class.html +[asyncnotifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifierProvider.html diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart new file mode 100644 index 000000000..e02195f87 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart @@ -0,0 +1,82 @@ +import 'dart:convert'; + +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +class Http { + Future get(String str) async => str; + Future delete(String str) async => str; + Future post(String str, Map body) async => str; + Future patch(String str, Map body) async => str; +} + +final http = Http(); + +/* SNIPPET START */ + +@freezed +class Todo with _$Todo { + factory Todo({ + required String id, + required String description, + required bool completed, + }) = _Todo; + + factory Todo.fromJson(Map json) => _$TodoFromJson(json); +} + +// This will generates a AsyncNotifier and AsyncNotifierProvider. +// The AsyncNotifier class that will be passed to our AsyncNotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +// Finally, we are using asyncTodosProvider(AsyncNotifierProvider) to allow the UI to +// interact with our Todos class. +@riverpod +class AsyncTodos extends _$AsyncTodos { + Future> _fetchTodo() async { + final json = await http.get('api/todos'); + final todos = jsonDecode(json) as List>; + return todos.map(Todo.fromJson).toList(); + } + + @override + FutureOr> build() async { + // Load initial todo list from the remote repository + return _fetchTodo(); + } + + Future addTodo(Todo todo) async { + // Set the state to loading + state = const AsyncValue.loading(); + // Add the new todo and reload the todo list from the remote repository + state = await AsyncValue.guard(() async { + await http.post('api/todos', todo.toJson()); + return _fetchTodo(); + }); + } + + // Let's allow removing todos + Future removeTodo(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.delete('api/todos/$todoId'); + return _fetchTodo(); + }); + } + + // Let's mark a todo as completed + Future toggle(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.patch( + 'api/todos/$todoId', + {'completed': true}, + ); + return _fetchTodo(); + }); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart new file mode 100644 index 000000000..d1b8a01d5 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart @@ -0,0 +1,184 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Todo _$TodoFromJson(Map json) { + return _Todo.fromJson(json); +} + +/// @nodoc +mixin _$Todo { + String get id => throw _privateConstructorUsedError; + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$TodoImpl implements _Todo { + _$TodoImpl( + {required this.id, required this.description, required this.completed}); + + factory _$TodoImpl.fromJson(Map json) => + _$$TodoImplFromJson(json); + + @override + final String id; + @override + final String description; + @override + final bool completed; + + @override + String toString() { + return 'Todo(id: $id, description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.id, id) || other.id == id) && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, id, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); + + @override + Map toJson() { + return _$$TodoImplToJson( + this, + ); + } +} + +abstract class _Todo implements Todo { + factory _Todo( + {required final String id, + required final String description, + required final bool completed}) = _$TodoImpl; + + factory _Todo.fromJson(Map json) = _$TodoImpl.fromJson; + + @override + String get id; + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart new file mode 100644 index 000000000..2b454f4a4 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart @@ -0,0 +1,91 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$TodoImpl _$$TodoImplFromJson(Map json) => _$TodoImpl( + id: json['id'] as String, + description: json['description'] as String, + completed: json['completed'] as bool, + ); + +Map _$$TodoImplToJson(_$TodoImpl instance) => + { + 'id': instance.id, + 'description': instance.description, + 'completed': instance.completed, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(AsyncTodos) +const asyncTodosProvider = AsyncTodosProvider._(); + +final class AsyncTodosProvider + extends $AsyncNotifierProvider> { + const AsyncTodosProvider._( + {super.runNotifierBuildOverride, AsyncTodos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'asyncTodosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final AsyncTodos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$asyncTodosHash(); + + @$internal + @override + AsyncTodos create() => _createCb?.call() ?? AsyncTodos(); + + @$internal + @override + AsyncTodosProvider $copyWithCreate( + AsyncTodos Function() create, + ) { + return AsyncTodosProvider._(create: create); + } + + @$internal + @override + AsyncTodosProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + AsyncTodos, + ) build, + ) { + return AsyncTodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$asyncTodosHash() => r'fd0d7502a1c17b7cedd2350519649dd680fc48cd'; + +abstract class _$AsyncTodos extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart new file mode 100644 index 000000000..f4455a338 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart @@ -0,0 +1,101 @@ +import 'dart:convert'; + +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Http { + Future get(String str) async => str; + Future delete(String str) async => str; + Future post(String str, Map body) async => str; + Future patch(String str, Map body) async => str; +} + +final http = Http(); + +/* SNIPPET START */ + +// An immutable state is preferred. +// We could also use packages like Freezed to help with the implementation. +@immutable +class Todo { + const Todo({ + required this.id, + required this.description, + required this.completed, + }); + + factory Todo.fromJson(Map map) { + return Todo( + id: map['id'] as String, + description: map['description'] as String, + completed: map['completed'] as bool, + ); + } + + // All properties should be `final` on our class. + final String id; + final String description; + final bool completed; + + Map toJson() => { + 'id': id, + 'description': description, + 'completed': completed, + }; +} + +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +class AsyncTodosNotifier extends AsyncNotifier> { + Future> _fetchTodo() async { + final json = await http.get('api/todos'); + final todos = jsonDecode(json) as List>; + return todos.map(Todo.fromJson).toList(); + } + + @override + Future> build() async { + // Load initial todo list from the remote repository + return _fetchTodo(); + } + + Future addTodo(Todo todo) async { + // Set the state to loading + state = const AsyncValue.loading(); + // Add the new todo and reload the todo list from the remote repository + state = await AsyncValue.guard(() async { + await http.post('api/todos', todo.toJson()); + return _fetchTodo(); + }); + } + + // Let's allow removing todos + Future removeTodo(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.delete('api/todos/$todoId'); + return _fetchTodo(); + }); + } + + // Let's mark a todo as completed + Future toggle(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.patch( + 'api/todos/$todoId', + {'completed': true}, + ); + return _fetchTodo(); + }); + } +} + +// Finally, we are using NotifierProvider to allow the UI to interact with +// our TodosNotifier class. +final asyncTodosProvider = + AsyncNotifierProvider>(() { + return AsyncTodosNotifier(); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart new file mode 100644 index 000000000..5d00d05d9 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart @@ -0,0 +1,37 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'codegen.dart'; + +/* SNIPPET START */ + +class TodoListView extends ConsumerWidget { + const TodoListView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // rebuild the widget when the todo list changes + final asyncTodos = ref.watch(asyncTodosProvider); + + // Let's render the todos in a scrollable list view + return switch (asyncTodos) { + AsyncData(:final value) => ListView( + children: [ + for (final todo in value) + CheckboxListTile( + value: todo.completed, + // When tapping on the todo, change its completed status + onChanged: (value) { + ref.read(asyncTodosProvider.notifier).toggle(todo.id); + }, + title: Text(todo.description), + ), + ], + ), + AsyncError(:final error) => Text('Error: $error'), + _ => const Center(child: CircularProgressIndicator()), + }; + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart new file mode 100644 index 000000000..866ed37bb --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart @@ -0,0 +1,68 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@freezed +class Todo with _$Todo { + factory Todo({ + required String id, + required String description, + required bool completed, + }) = _Todo; +} + +// This will generates a Notifier and NotifierProvider. +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +// Finally, we are using todosProvider(NotifierProvider) to allow the UI to +// interact with our Todos class. +@riverpod +class Todos extends _$Todos { + @override + List build() { + return []; + } + + // Let's allow the UI to add todos. + void addTodo(Todo todo) { + // Since our state is immutable, we are not allowed to do `state.add(todo)`. + // Instead, we should create a new list of todos which contains the previous + // items and the new one. + // Using Dart's spread operator here is helpful! + state = [...state, todo]; + // No need to call "notifyListeners" or anything similar. Calling "state =" + // will automatically rebuild the UI when necessary. + } + + // Let's allow removing todos + void removeTodo(String todoId) { + // Again, our state is immutable. So we're making a new list instead of + // changing the existing list. + state = [ + for (final todo in state) + if (todo.id != todoId) todo, + ]; + } + + // Let's mark a todo as completed + void toggle(String todoId) { + state = [ + for (final todo in state) + // we're marking only the matching todo as completed + if (todo.id == todoId) + // Once more, since our state is immutable, we need to make a copy + // of the todo. We're using our `copyWith` method implemented before + // to help with that. + todo.copyWith(completed: !todo.completed) + else + // other todos are not modified + todo, + ]; + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart new file mode 100644 index 000000000..0b73d3548 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart @@ -0,0 +1,166 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$Todo { + String get id => throw _privateConstructorUsedError; + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc + +class _$TodoImpl implements _Todo { + _$TodoImpl( + {required this.id, required this.description, required this.completed}); + + @override + final String id; + @override + final String description; + @override + final bool completed; + + @override + String toString() { + return 'Todo(id: $id, description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.id, id) || other.id == id) && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @override + int get hashCode => Object.hash(runtimeType, id, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); +} + +abstract class _Todo implements Todo { + factory _Todo( + {required final String id, + required final String description, + required final bool completed}) = _$TodoImpl; + + @override + String get id; + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart new file mode 100644 index 000000000..5ce1c142a --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Todos) +const todosProvider = TodosProvider._(); + +final class TodosProvider extends $NotifierProvider> { + const TodosProvider._( + {super.runNotifierBuildOverride, Todos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Todos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + Todos create() => _createCb?.call() ?? Todos(); + + @$internal + @override + TodosProvider $copyWithCreate( + Todos Function() create, + ) { + return TodosProvider._(create: create); + } + + @$internal + @override + TodosProvider $copyWithBuild( + List Function( + Ref>, + Todos, + ) build, + ) { + return TodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todosHash() => r'3485c14ec4db07efe5fe52243258a66e6f99b2b4'; + +abstract class _$Todos extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart new file mode 100644 index 000000000..ec3e50308 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart @@ -0,0 +1,85 @@ +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +// An immutable state is preferred. +// We could also use packages like Freezed to help with the implementation. +@immutable +class Todo { + const Todo({ + required this.id, + required this.description, + required this.completed, + }); + + // All properties should be `final` on our class. + final String id; + final String description; + final bool completed; + + // Since Todo is immutable, we implement a method that allows cloning the + // Todo with slightly different content. + Todo copyWith({String? id, String? description, bool? completed}) { + return Todo( + id: id ?? this.id, + description: description ?? this.description, + completed: completed ?? this.completed, + ); + } +} + +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +class TodosNotifier extends Notifier> { + // We initialize the list of todos to an empty list + @override + List build() { + return []; + } + + // Let's allow the UI to add todos. + void addTodo(Todo todo) { + // Since our state is immutable, we are not allowed to do `state.add(todo)`. + // Instead, we should create a new list of todos which contains the previous + // items and the new one. + // Using Dart's spread operator here is helpful! + state = [...state, todo]; + // No need to call "notifyListeners" or anything similar. Calling "state =" + // will automatically rebuild the UI when necessary. + } + + // Let's allow removing todos + void removeTodo(String todoId) { + // Again, our state is immutable. So we're making a new list instead of + // changing the existing list. + state = [ + for (final todo in state) + if (todo.id != todoId) todo, + ]; + } + + // Let's mark a todo as completed + void toggle(String todoId) { + state = [ + for (final todo in state) + // we're marking only the matching todo as completed + if (todo.id == todoId) + // Once more, since our state is immutable, we need to make a copy + // of the todo. We're using our `copyWith` method implemented before + // to help with that. + todo.copyWith(completed: !todo.completed) + else + // other todos are not modified + todo, + ]; + } +} + +// Finally, we are using NotifierProvider to allow the UI to interact with +// our TodosNotifier class. +final todosProvider = NotifierProvider>(() { + return TodosNotifier(); +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart new file mode 100644 index 000000000..192cb9f66 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart @@ -0,0 +1,32 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'codegen.dart'; + +/* SNIPPET START */ + +class TodoListView extends ConsumerWidget { + const TodoListView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // rebuild the widget when the todo list changes + List todos = ref.watch(todosProvider); + + // Let's render the todos in a scrollable list view + return ListView( + children: [ + for (final todo in todos) + CheckboxListTile( + value: todo.completed, + // When tapping on the todo, change its completed status + onChanged: (value) => + ref.read(todosProvider.notifier).toggle(todo.id), + title: Text(todo.description), + ), + ], + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider.mdx index 4058bc3cc..136c8edbc 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider.mdx @@ -2,96 +2,104 @@ title: Provider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import todo from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo.dart"; -import completedTodos from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart"; -import todosConsumer from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart"; -import unoptimizedPreviousButton from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart"; -import optimizedPreviousButton from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import todo from "./provider/todo"; +import completedTodos from "./provider/completed_todos"; +import todosConsumer from "!!raw-loader!/docs/providers/provider/todos_consumer.dart"; +import unoptimizedPreviousButton from "./provider/unoptimized_previous_button"; +import optimizedPreviousButton from "./provider/optimized_previous_button"; +import { trimSnippet, AutoSnippet } from "../../../../../src/components/CodeSnippet"; -`Provider` è il provider più basico tra tutti. Crea un valore... e questo è tutto. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -`Provider` è utilizzato tipicamente per: +`Provider` is the most basic of all providers. It creates a value... And that's about it. -- calcoli per memorizzazione in cache -- esporre un valore ad altri provider (come `Repository`/`HttpClient`). -- offrire un modo per test o widget di sovrascrivere un valore. -- ridurre il numero di rebuilds dei provider/widget senza dover usare `select`. +`Provider` is typically used for: -## Usare `Provider` per memorizzare calcoli/computazioni +- caching computations +- exposing a value to other providers (such as a `Repository`/`HttpClient`). +- offering a way for tests or widgets to override a value. +- reducing rebuilds of providers/widgets without having to use `select`. -`Provider` è un potente strumento per memorizzare operazioni sincrone -quando combinato con [ref.watch]. +## Using `Provider` to cache computations -Un esempio potrebbe essere filtrare una lista di todo. Dato che filtrare una lista -potrebbe risultare leggermente costoso, idealmente non vogliamo filtrare la nostra lista -di todo ogni volta che la nostra applicazione si renderizza. -In questa situazione possiamo usare `Provider` per fare filtrare al posto nostro. +`Provider` is a powerful tool for caching synchronous operations when combined +with [ref.watch]. -Per fare ciò, assumiamo che la nostra applicazione abbia un esistente [StateNotifierProvider] -che manipola una lista di todo: +An example would be filtering a list of todos. +Since filtering a list could be slightly expensive, we ideally do not want to +filter our list of todos whenever our application re-renders. +In this situation, we could use `Provider` to do the filtering for us. -{trimSnippet(todo)} +For that, assume that our application has an existing [NotifierProvider] +which manipulates a list of todos: -Da qui, possiamo usare `Provider` per esporre la lista dei todo filtrata, -mostrando solo i todo completati: + -{trimSnippet(completedTodos)} +From there, we can use `Provider` to expose the filtered list of todos, showing +only the completed todos: -Con questo codice, la nostra UI è ora in grado di mostrare la lista dei todo -completati stando in ascolto di `completedTodosProvider`: + + +With this code, our UI is now able to show the list of the completed todos +by listening to `completedTodosProvider`: {trimSnippet(todosConsumer)} -La parte interessante è che la lista filtrata ora è memorizzata in cache. +The interesting part is, the list filtering is now cached. -Ciò significa che la lista dei todo completati non sarà ricalcolata fino a quando -i todo verranno aggiunti/rimossi/aggiornati, anche se stiamo leggendo la lista dei todo completati più volte. +Meaning that the list of completed todos will not be recomputed until +todos are added/removed/updated, even if we are reading the list of completed +todos multiple times. -Tieni presente che non è necessario invalidare manualmente la cache quando la lista dei todo cambia. -`Provider` sà in modo autonomo quando il risultato deve essere ricalcolato grazie a [ref.watch]. +Note how we do not need to manually invalidate the cache when the list of todos +changes. `Provider` is automatically able to know when the result must be recomputed +thanks to [ref.watch]. -## Ridurre il numero di rebuilds dei provider/widget attraverso `Provider` +## Reducing provider/widget rebuilds by using `Provider` -Un aspetto unico di `Provider` è che anche quando `Provider` viene ricalcolato -(in genere quando si usa [ref.watch]), non aggiornerà i widget/provider che lo ascoltano -a meno che il valore non cambi. +A unique aspect of `Provider` is that even when `Provider` is recomputed +(typically when using [ref.watch]), it will not update the widgets/providers +that listen to it unless the value changed. -Un esempio reale potrebbe essere per abilitare/disabilitare i tasti previous/next -di una vista paginata: +A real world example would be for enabling/disabling previous/next buttons +of a paginated view: -![Tasto "Precedente/Successivo"](https://user-images.githubusercontent.com/134939/47580830-31263a00-d950-11e8-9b61-0eaddab2709e.png) +![stepper example](https://user-images.githubusercontent.com/134939/47580830-31263a00-d950-11e8-9b61-0eaddab2709e.png) -Nel nostro caso ci concentreremo specificamente sul tasto "Precedente" ("Previous"). -Un'implementazione ingenua di tale pulsante sarebbe un widget che ottiene l'indice della pagina corrente, -e se quell'indice è uguale a 0, disabiliteremmo il pulsante. +In our case, we will focus specifically on the "previous" button. +A naive implementation of such button would be a widget which obtains the +current page index, and if that index is equal to 0, we would disable the button. -Tale codice potrebbe essere: +This code could be: -{trimSnippet(unoptimizedPreviousButton)} + -Il problema con questo codice è che ogni volta che cambiamo la pagina corrente, il pulsante "Previous" verrà ricostruito. -Come funzionamento ideale, vorremmo che il pulsante si ricostruisse solo quando passa da attivato a disattivato. +The issue with this code is that whenever we change the current page, the "previous" +button will rebuild. +In the ideal world, we would want the button to rebuild only when changing between +activated and deactivated. -La radice del problema è che stiamo ricalcolando se l'utente è autorizzato ad andare -alla pagina precedente direttamente all'interno del pulsante "previous". +The root of the issue here is that we are computing whether the user is +allowed to go to the previous page directly within the "previous" button. -Un modo per risolvere questo problema è estrarre la logica al di fuori del widget -in un `Provider`: +A way to solve this is to extract this logic outside of the widget and into a `Provider`: -{trimSnippet(optimizedPreviousButton)} + -Facendo questa piccola modifica, il nostro widget `PreviousButton` non verrà più ricostruito -quando l'indice della pagina cambia grazie a `Provider`. +By doing this small refactoring, our `PreviousButton` widget will no longer +rebuild when the page index changes thanks to `Provider`. -D'ora in poi, quando l'indice della pagina cambierà, il provider `canGoToPreviousPageProvider` -sarà ricalcolato. Ma se il valore esposto dal provider non cambia, allora `PreviousButton` non verrà ricostruito. +From now on when the page index changes, our `canGoToPreviousPageProvider` provider +will be recomputed. But if the value exposed by the provider does not change, +then `PreviousButton` will not rebuild. -Questa modifica ha migliorato la performance del nostro bottone, e ha avuto -l'interessante beneficio di estrarre la logica al di fuori del nostro widget. +This change both improved the performance of our button and had the interesting +benefit of extracting the logic outside of our widget. -[ref.watch]: ../concepts/reading#usare-ref.watch-per-osservare-un-provider -[statenotifierprovider]: ./state_notifier_provider \ No newline at end of file +[ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider +[notifierprovider]: ./notifier_provider diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart new file mode 100644 index 000000000..1a29d96f5 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart @@ -0,0 +1,15 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../todo/todo.dart'; + +part 'completed_todos.g.dart'; + +/* SNIPPET START */ + +@riverpod +List completedTodos(CompletedTodosRef ref) { + final todos = ref.watch(todosProvider); + + // we return only the completed todos + return todos.where((todo) => todo.isCompleted).toList(); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart new file mode 100644 index 000000000..bf4ddc691 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart @@ -0,0 +1,73 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'completed_todos.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CompletedTodosRef = Ref>; + +@ProviderFor(completedTodos) +const completedTodosProvider = CompletedTodosProvider._(); + +final class CompletedTodosProvider + extends $FunctionalProvider, List, CompletedTodosRef> + with $Provider, CompletedTodosRef> { + const CompletedTodosProvider._( + {List Function( + CompletedTodosRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'completedTodosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + CompletedTodosRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$completedTodosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CompletedTodosProvider $copyWithCreate( + List Function( + CompletedTodosRef ref, + ) create, + ) { + return CompletedTodosProvider._(create: create); + } + + @override + List create(CompletedTodosRef ref) { + final _$cb = _createCb ?? completedTodos; + return _$cb(ref); + } +} + +String _$completedTodosHash() => r'855706c09268f428696b3b382ae1605818361b83'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx new file mode 100644 index 000000000..11451aa1c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./completed_todos.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart similarity index 65% rename from website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart index 3783ddf9d..e24c48bd5 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart @@ -1,13 +1,13 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'todo.dart'; +import '../todo/raw.dart'; /* SNIPPET START */ final completedTodosProvider = Provider>((ref) { - // Otteniamo la lista di tutti i todo da todosProvider + // We obtain the list of all todos from the todosProvider final todos = ref.watch(todosProvider); - // restituiamo solo i todo completati + // we return only the completed todos return todos.where((todo) => todo.isCompleted).toList(); }); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx new file mode 100644 index 000000000..fb83c92f1 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./optimized_previous_button.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart new file mode 100644 index 000000000..7d3b8a332 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart @@ -0,0 +1,50 @@ +// A provider that controls the current page +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'optimized_previous_button.g.dart'; + +/* SNIPPET START */ + +@riverpod +class PageIndex extends _$PageIndex { + @override + int build() { + return 0; + } + + void goToPreviousPage() { + state = state - 1; + } +} + +// A provider which computes whether the user is allowed to go to the previous page +@riverpod +/* highlight-start */ +bool canGoToPreviousPage(CanGoToPreviousPageRef ref) { +/* highlight-end */ + return ref.watch(pageIndexProvider) != 0; +} + +class PreviousButton extends ConsumerWidget { + const PreviousButton({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // We are now watching our new Provider + // Our widget is no longer calculating whether we can go to the previous page. +/* highlight-start */ + final canGoToPreviousPage = ref.watch(canGoToPreviousPageProvider); +/* highlight-end */ + + void goToPreviousPage() { + ref.read(pageIndexProvider.notifier).goToPreviousPage(); + } + + return ElevatedButton( + onPressed: canGoToPreviousPage ? goToPreviousPage : null, + child: const Text('previous'), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart new file mode 100644 index 000000000..17a4c444f --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -0,0 +1,142 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'optimized_previous_button.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CanGoToPreviousPageRef = Ref; + +@ProviderFor(canGoToPreviousPage) +const canGoToPreviousPageProvider = CanGoToPreviousPageProvider._(); + +final class CanGoToPreviousPageProvider + extends $FunctionalProvider + with $Provider { + const CanGoToPreviousPageProvider._( + {bool Function( + CanGoToPreviousPageRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'canGoToPreviousPageProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final bool Function( + CanGoToPreviousPageRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$canGoToPreviousPageHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(bool value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CanGoToPreviousPageProvider $copyWithCreate( + bool Function( + CanGoToPreviousPageRef ref, + ) create, + ) { + return CanGoToPreviousPageProvider._(create: create); + } + + @override + bool create(CanGoToPreviousPageRef ref) { + final _$cb = _createCb ?? canGoToPreviousPage; + return _$cb(ref); + } +} + +String _$canGoToPreviousPageHash() => + r'801fe8182a37cd21ae83bdfccbe36c125b4d14fb'; + +@ProviderFor(PageIndex) +const pageIndexProvider = PageIndexProvider._(); + +final class PageIndexProvider extends $NotifierProvider { + const PageIndexProvider._( + {super.runNotifierBuildOverride, PageIndex Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'pageIndexProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final PageIndex Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$pageIndexHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + PageIndex create() => _createCb?.call() ?? PageIndex(); + + @$internal + @override + PageIndexProvider $copyWithCreate( + PageIndex Function() create, + ) { + return PageIndexProvider._(create: create); + } + + @$internal + @override + PageIndexProvider $copyWithBuild( + int Function( + Ref, + PageIndex, + ) build, + ) { + return PageIndexProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$pageIndexHash() => r'59307ecf23b5b2432833da5ad6b312bf36435d0e'; + +abstract class _$PageIndex extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart similarity index 87% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart index 3582930ca..a4d3cb4b9 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart @@ -7,11 +7,11 @@ import 'package:flutter_riverpod/legacy.dart'; final pageIndexProvider = StateProvider((ref) => 0); -// 사용자(the user)가 이전 페이지로 돌아가는지 계산하기 위한 프로바이더 +// A provider which computes whether the user is allowed to go to the previous page /* highlight-start */ final canGoToPreviousPageProvider = Provider((ref) { /* highlight-end */ - return ref.watch(pageIndexProvider) == 0; + return ref.watch(pageIndexProvider) != 0; }); class PreviousButton extends ConsumerWidget { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx new file mode 100644 index 000000000..91d9cc4aa --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./todo.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart similarity index 56% rename from website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart index c686eb47d..11e62bc3a 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart @@ -1,7 +1,6 @@ // ignore_for_file: avoid_positional_boolean_parameters import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ @@ -11,15 +10,18 @@ class Todo { final String description; } -class TodosNotifier extends StateNotifier> { - TodosNotifier() : super([]); +class TodosNotifier extends Notifier> { + @override + List build() { + return []; + } void addTodo(Todo todo) { state = [...state, todo]; } - // TODO aggiungere altri metodi, come "removeTodo", ... + // TODO add other methods, such as "removeTodo", ... } -final todosProvider = StateNotifierProvider>((ref) { +final todosProvider = NotifierProvider>(() { return TodosNotifier(); }); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart new file mode 100644 index 000000000..7089bc962 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart @@ -0,0 +1,25 @@ +// ignore_for_file: avoid_positional_boolean_parameters +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo.g.dart'; + +/* SNIPPET START */ + +class Todo { + Todo(this.description, this.isCompleted); + final bool isCompleted; + final String description; +} + +@riverpod +class Todos extends _$Todos { + @override + List build() { + return []; + } + + void addTodo(Todo todo) { + state = [...state, todo]; + } + // TODO add other methods, such as "removeTodo", ... +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart new file mode 100644 index 000000000..7a6997e3e --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Todos) +const todosProvider = TodosProvider._(); + +final class TodosProvider extends $NotifierProvider> { + const TodosProvider._( + {super.runNotifierBuildOverride, Todos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Todos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + Todos create() => _createCb?.call() ?? Todos(); + + @$internal + @override + TodosProvider $copyWithCreate( + Todos Function() create, + ) { + return TodosProvider._(create: create); + } + + @$internal + @override + TodosProvider $copyWithBuild( + List Function( + Ref>, + Todos, + ) build, + ) { + return TodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todosHash() => r'4bd25c3c15bfff56ad6e733bd17ecb7284c4ceb2'; + +abstract class _$Todos extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart index 0f5c1d5f7..5a3226b62 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart @@ -3,16 +3,18 @@ import 'package:flutter/widgets.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'completed_todos.dart'; +import 'completed_todos/completed_todos.dart'; Widget build() { return /* SNIPPET START */ - Consumer(builder: (context, ref, child) { - final completedTodos = ref.watch(completedTodosProvider); - // TODO mostrare i todo usando ListView/GridView/.../* SKIP */ - return Container(); - /* SKIP END */ - },); + Consumer( + builder: (context, ref, child) { + final completedTodos = ref.watch(completedTodosProvider); + // TODO mostrare i todo usando ListView/GridView/.../* SKIP */ + return Container(); + /* SKIP END */ + }, + ); /* SNIPPET END */ } diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx new file mode 100644 index 000000000..d345d4f5d --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./unoptimized_previous_button.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart similarity index 77% rename from website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart rename to website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart index af740d653..b670eaae3 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart @@ -1,4 +1,4 @@ -// Un provider che controlla la pagina corrente +// A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; @@ -12,8 +12,8 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // se non è la prima pagina, il pulsante "previous" è attivo - final canGoToPreviousPage = ref.watch(pageIndexProvider) == 0; + // if not on first page, the previous button is active + final canGoToPreviousPage = ref.watch(pageIndexProvider) != 0; void goToPreviousPage() { ref.read(pageIndexProvider.notifier).update((state) => state - 1); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart new file mode 100644 index 000000000..f77de56c3 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart @@ -0,0 +1,39 @@ +// A provider that controls the current page +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'unoptimized_previous_button.g.dart'; + +/* SNIPPET START */ + +@riverpod +class PageIndex extends _$PageIndex { + @override + int build() { + return 0; + } + + void goToPreviousPage() { + state = state - 1; + } +} + +class PreviousButton extends ConsumerWidget { + const PreviousButton({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // if not on first page, the previous button is active + final canGoToPreviousPage = ref.watch(pageIndexProvider) != 0; + + void goToPreviousPage() { + ref.read(pageIndexProvider.notifier).goToPreviousPage(); + } + + return ElevatedButton( + onPressed: canGoToPreviousPage ? goToPreviousPage : null, + child: const Text('previous'), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart new file mode 100644 index 000000000..1ce41d761 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'unoptimized_previous_button.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(PageIndex) +const pageIndexProvider = PageIndexProvider._(); + +final class PageIndexProvider extends $NotifierProvider { + const PageIndexProvider._( + {super.runNotifierBuildOverride, PageIndex Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'pageIndexProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final PageIndex Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$pageIndexHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + PageIndex create() => _createCb?.call() ?? PageIndex(); + + @$internal + @override + PageIndexProvider $copyWithCreate( + PageIndex Function() create, + ) { + return PageIndexProvider._(create: create); + } + + @$internal + @override + PageIndexProvider $copyWithBuild( + int Function( + Ref, + PageIndex, + ) build, + ) { + return PageIndexProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$pageIndexHash() => r'59307ecf23b5b2432833da5ad6b312bf36435d0e'; + +abstract class _$PageIndex extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx index 8ea2992b0..ad8b55960 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx @@ -2,30 +2,39 @@ title: StateNotifierProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import todos from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart"; -import todosConsumer from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart"; +import todos from "!!raw-loader!/docs/providers/state_notifier_provider/todos.dart"; +import todosConsumer from "!!raw-loader!/docs/providers/state_notifier_provider/todos_consumer.dart"; import { trimSnippet } from "../../../../../src/components/CodeSnippet"; -`StateNotifierProvider` è un provider usato per ascoltare ed esporre uno [StateNotifier] (dal package [state_notifier], che Riverpod ri-esporta). -`StateNotifierProvider` unito con [StateNotifier] è la soluzione consigliata da Riverpod per gestire lo stato in reazione all'interazione dell'utente. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -Viene usato in genere per: +`StateNotifierProvider` is a provider that is used to listen to and expose a +[StateNotifier] (from the package [state_notifier], which Riverpod re-exports). -- esporre uno stato **immutabile** che può cambiare nel tempo dopo aver reagito ad eventi personalizzabili. -- centralizzare la logica per modificare lo stato (aka "business logic") in un singolo posto, - migliorando la mantenibilità nel tempo. +It is typically used for: -Come esempio d'uso, potremmo usare `StateNotifierProvider` per implementare una todo-list (lista di todo). -Fare ciò ci permette di esporre dei metodi come `addTodo` per lasciare che l'UI modifichi -la todo-list in base alle interazioni dell'utente: +- exposing an **immutable** state which can change over time after reacting to + custom events. +- centralizing the logic for modifying some state (aka "business logic") in a + single place, improving maintainability over time. + +:::info +Prefer using [NotifierProvider] instead. +::: + +As a usage example, we could use `StateNotifierProvider` to implement a todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: {trimSnippet(todos)} -Ora che abbiamo definito uno `StateNotifierProvider`, -possiamo usarlo per interagire con la todo-list nella nostra interfaccia grafica: +Now that we have defined a `StateNotifierProvider`, we can use it to interact +with the list of todos in our UI: {trimSnippet(todosConsumer)} @@ -33,3 +42,4 @@ possiamo usarlo per interagire con la todo-list nella nostra interfaccia grafica [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html [provider]: ./provider [futureprovider]: ./future_provider +[notifierprovider]: ./notifier_provider diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 5f9a8f35a..f9484516e 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -4,21 +4,23 @@ import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ -// Lo stato del nostro StateNotifier dovrebbe essere immutabile. -// Potremmo usare anche packages come Freezed per aiutarci con l'implementazione. - +// The state of our StateNotifier should be immutable. +// We could also use packages like Freezed to help with the implementation. @immutable class Todo { - const Todo({required this.id, required this.description, required this.completed}); + const Todo({ + required this.id, + required this.description, + required this.completed, + }); - // Tutte le proprietà dovrebbero essere `final` nella nostra classe. + // All properties should be `final` on our class. final String id; final String description; final bool completed; - // Dato che Todo è immutabile, implementiamo un metodo che ci permette di - // clonare l'oggetto Todo con un contenuto leggermente diverso. - + // Since Todo is immutable, we implement a method that allows cloning the + // Todo with slightly different content. Todo copyWith({String? id, String? description, bool? completed}) { return Todo( id: id ?? this.id, @@ -28,60 +30,54 @@ class Todo { } } -// La classe StateNotifier sarà passata al nostro StateNotifierProvider. -// Questa classe non dovrebbe esporre lo stato al di fuori della sua proprietà "state" -// il che significa nessuna proprietà o getter pubblico! - -// I metodi pubblici di questa classe sono quelli che consentiranno alla UI di modificare lo stato. - +// The StateNotifier class that will be passed to our StateNotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. class TodosNotifier extends StateNotifier> { - // Inizializzamo la lista dei todo con una lista vuota - + // We initialize the list of todos to an empty list TodosNotifier() : super([]); - // Consentiamo alla UI di aggiungere i todo + // Let's allow the UI to add todos. void addTodo(Todo todo) { - // Poichè il nostro stato è immutabile, non siamo autorizzati a fare `state.add(todo)`. - // Dovremmo invece creare una nuova lista di todo contenente - // gli elementi precedenti e il nuovo - - // Usare lo spread operator di Dart qui è d'aiuto! - + // Since our state is immutable, we are not allowed to do `state.add(todo)`. + // Instead, we should create a new list of todos which contains the previous + // items and the new one. + // Using Dart's spread operator here is helpful! state = [...state, todo]; - // Non c'è bisogno di chiamare "notifiyListeners" o qualcosa di simile. - // Chiamare "state =" ricostruirà automaticamente la UI quando necessario. + // No need to call "notifyListeners" or anything similar. Calling "state =" + // will automatically rebuild the UI when necessary. } - // Consentiamo di rimuovere i todo + // Let's allow removing todos void removeTodo(String todoId) { - // Di nuovo, il nostro stato è immutabile. Quindi facciamo una nuova lista - // invece di modificare la lista esistente. - + // Again, our state is immutable. So we're making a new list instead of + // changing the existing list. state = [ for (final todo in state) if (todo.id != todoId) todo, ]; } - // Contrassegniamo il todo come completato + // Let's mark a todo as completed void toggle(String todoId) { state = [ for (final todo in state) - // contrassegniamo solo il todo corrispondente come completato + // we're marking only the matching todo as completed if (todo.id == todoId) - // Usiamo il metodo `copyWith` implementato prima per aiutarci nel - // modificare lo stato - + // Once more, since our state is immutable, we need to make a copy + // of the todo. We're using our `copyWith` method implemented before + // to help with that. todo.copyWith(completed: !todo.completed) else - // gli altri todo non sono modificati + // other todos are not modified todo, ]; } } -// Infine, usiamo StateNotifierProvider per consentire all'UI di interagire con -// la classe TodosNotifier +// Finally, we are using StateNotifierProvider to allow the UI to interact with +// our TodosNotifier class. final todosProvider = StateNotifierProvider>((ref) { return TodosNotifier(); }); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart index 10628cc8b..0b60d4eaf 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos_consumer.dart @@ -12,18 +12,18 @@ class TodoListView extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // ricostruisce il widget quando la todo-list cambia - + // rebuild the widget when the todo list changes List todos = ref.watch(todosProvider); - // Renderizziamo i todo in una list view scrollabile + // Let's render the todos in a scrollable list view return ListView( children: [ for (final todo in todos) CheckboxListTile( value: todo.completed, // When tapping on the todo, change its completed status - onChanged: (value) => ref.read(todosProvider.notifier).toggle(todo.id), + onChanged: (value) => + ref.read(todosProvider.notifier).toggle(todo.id), title: Text(todo.description), ), ], diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider.mdx index 3522af5c1..bb65359db 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider.mdx @@ -2,125 +2,130 @@ title: StateProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import product from "!!raw-loader!/docs/providers/state_provider/product.dart"; import productListView from "!!raw-loader!/docs/providers/state_provider/product_list_view.dart"; -import dropdown from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/dropdown.dart"; -import sortProvider from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart"; -import connectedDropdown from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart"; +import dropdown from "!!raw-loader!/docs/providers/state_provider/dropdown.dart"; +import sortProvider from "!!raw-loader!/docs/providers/state_provider/sort_provider.dart"; +import connectedDropdown from "!!raw-loader!/docs/providers/state_provider/connected_dropdown.dart"; import sortedProductProvider from "!!raw-loader!/docs/providers/state_provider/sorted_product_provider.dart"; -import updateReadTwice from "!!raw-loader!/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart"; +import updateReadTwice from "!!raw-loader!/docs/providers/state_provider/update_read_twice.dart"; import updateReadOnce from "!!raw-loader!/docs/providers/state_provider/update_read_once.dart"; import { trimSnippet } from "../../../../../src/components/CodeSnippet"; -`StateProvider` è un provider che espone un modo per modificare il suo stato. -É una semplificazione di [StateNotifierProvider] e progettato per evitare di -dover scrivere una classe [StateNotifier] per casi d'uso molto semplici. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -`StateProvider` esiste principalmente per consentire la modifica di variabili **semplici** -da parte dell'interfaccia utente. -Lo stato di uno `StateProvider` è generalmente: +`StateProvider` is a provider that exposes a way to modify its state. +It is a simplification of [NotifierProvider], designed to avoid +having to write a [Notifier] class for very simple use-cases. -- un enum, come può essere un tipo di filtro -- una String, tipicamente il contenuto grezzo di un campo di testo -- un booleano, per le checkbox -- un numero, per impaginazione e campi d'età +`StateProvider` exists primarily to allow the modification of +**simple** variables by the User Interface. +The state of a `StateProvider` is typically one of: -Non dovresti usare `StateProvider` se: +- an enum, such as a filter type +- a String, typically the raw content of a text field +- a boolean, for checkboxes +- a number, for pagination or age form fields -- il tuo stato necessita di logica di validazione -- il tuo stato è un oggetto complesso (come una classe personalizzata, una lista/map ecc) -- la logica per modificare il tuo stato è più avanzata di un semplice `count++`. +You should not use `StateProvider` if: -Per casi più avanzati, considera usare [StateNotifierProvider] e creare una classe [StateNotifier]. -Anche se il codice boilerplate inizialmente sarà più grande, avere una classe [StateNotifier] -personalizzata è fondamentale per la mantenibilità a lungo termine del tuo progetto - -poichè centralizza la logica del tuo stato in un'unica posizione. +- your state needs validation logic +- your state is a complex object (such as a custom class, a list/map, ...) +- the logic for modifying your state is more advanced than a simple `count++`. -## Esempio d'uso: cambiare il tipo di filtro usando una dropdown +For more advanced cases, consider using [NotifierProvider] instead and +create a [Notifier] class. +While the initial boilerplate will be a bit larger, having a custom +[Notifier] class is critical for the long-term maintainability of your +project – as it centralizes the business logic of your state in a single place. -Un caso d'uso reale di `StateProvider` sarebbe quello di gestire lo stato di -semplici componenti di form come dropdowns/campi di testo/checkboxes. +## Usage example: Changing the filter type using a dropdown -In particolare, vedremo come usare `StateProvider` per implementare una dropdown -che permetta di cambiare come una lista di prodotti è ordinata. +A real-world use-case of `StateProvider` would be to manage the state of +simple form components like dropdowns/text fields/checkboxes. +In particular, we will see how to use `StateProvider` to implement a dropdown +that allows changing how a list of products is sorted. -Per semplificare le cose, la lista dei prodotti che otterremo sarà costruita direttamente -nell'applicazione e sarà come di seguito: +For the sake of simplicity, the list of products that we will obtain +will be built directly in the application and will be as follows: {trimSnippet(product)} -In un'applicazione reale, questa lista sarebbe stata generalmente ottenuta -usando [FutureProvider] facendo una richiesta di rete. +In a real-world application, this list would typically be obtained using +[FutureProvider] by making a network request. -L'interfaccia utente può mostrare quindi la lista dei prodotti scrivendo: +The User Interface could then show the list of products by doing: {trimSnippet(productListView)} -Ora che abbiamo finito con la base, possiamo aggiungere una dropdown, la quale ci permetterà di filtrare i nostri prodotti sia per prezzo che per nome. -Per questo, useremo [DropDownButton](https://api.flutter.dev/flutter/material/DropdownButton-class.html). +Now that we're done with the base, we can add a dropdown, which will +allow filtering our products either by price or by name. +For that, we will use [DropDownButton](https://api.flutter.dev/flutter/material/DropdownButton-class.html). {trimSnippet(dropdown)} -Ora che abbiamo una dropdown, creiamo uno `StateProvider` e -sincronizziamo lo stato della dropdown con il nostro provider. +Now that we have a dropdown, let's create a `StateProvider` and +synchronize the state of the dropdown with our provider. -Per prima cosa, creiamo il provider con `StateProvider`: +First, let's create the `StateProvider`: {trimSnippet(sortProvider)} -Successivamente possiamo connettere questo provider con la nostra dropdown -scrivendo: +Then, we can connect this provider with our dropdown by doing: {trimSnippet(connectedDropdown)} -Con questo, ora dovremmo essere in grado di cambiare il tipo di ordinamento. -Tuttavia, non ha ancora alcun impatto sulla lista dei prodotti! É ora della parte finale: -aggiornare `productsProvider` per ordinare la lista dei prodotti. +With this, we should now be able to change the sort type. +It has no impact on the list of products yet though! It's now time for the +final part: Updating our `productsProvider` to sort the list of products. -Una compenente chiave di tale implementazione è di usare [ref.watch], per far sì che `productsProvider` -ottenga il tipo di ordinamento e ricalcoli la lista dei prodotti ogni volta -che il tipo di ordinamento cambia. +A key component of implementing this is to use [ref.watch], to have +our `productsProvider` obtain the sort type and recompute the list of +products whenever the sort type changes. -L'implementazione sarà: +The implementation would be: {trimSnippet(sortedProductProvider)} -Questo è quanto! Questa modifica basta per fare in modo che l'interfaccia utente -ri-renderizzi automaticamente la lista dei prodotti quando il tipo di ordinamento cambia. +That's all! This change is enough for the User Interface to automatically +re-render the list of products when the sort type changes. -Di seguito l'esempio completo su Dartpad: +Here is the complete example on Dartpad: -## Come aggiornare lo stato basandosi sul valore precedente senza leggere il provider due volte +## How to update the state based on the previous value without reading the provider twice -Delle volte, potresti voler aggiornare lo stato di uno `StateProvider` basandosi sul valore precedente. -Naturalmente, potresti finire per scrivere: +Sometimes, you want to update the state of a `StateProvider` based on the previous value. +Naturally, you may end-up writing: {trimSnippet(updateReadTwice)} -Anche se non c'è niente di particolarmente sbagliato in questo codice, -la sintassi è un po' scomoda. +While there's nothing particularly wrong with this snippet, the syntax is a bit inconvenient. -Per migliorare la sintassi, possiamo usare la funzione `update`. Tale funzione -prenderà una funzione callback che riceverà lo stato corrente e dovrebbe -restituire il nuovo stato. -Possiamo usarla per riscrivere il nostro codice precedente in: +To make the syntax a bit better, we can use the `update` function. +This function will take a callback that will receive the current state and is expected +to return the new state. +We can use it to refactor our previous code to: {trimSnippet(updateReadOnce)} -Questa modifica ottiene lo stesso effetto ma migliora leggermente la sintassi. +This change achieves the same effect while making the syntax a bit better. -[ref.watch]: ../concepts/reading#usare-ref.watch-per-osservare-un-provider -[ref.read]: ../concepts/reading#usare-refread-per-ottenere-lo-stato-di-un-provider +[ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider +[ref.read]: ../concepts/reading#using-refread-to-obtain-the-state-of-a-provider-once [statenotifierprovider]: ./state_notifier_provider +[notifierprovider]: ./notifier_provider [futureprovider]: ./future_provider +[notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html [provider]: ./provider [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart index 04728f4aa..31566a52a 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/connected_dropdown.dart @@ -9,16 +9,17 @@ import 'sort_provider.dart'; Widget build(BuildContext context, WidgetRef ref) { return AppBar(actions: [ /* SNIPPET START */ - DropdownButton( - // Quando il tipo di ordinamento cambia, ricostruirà la dropdown - // per aggiornare l'icona mostrata. - value: ref.watch(productSortTypeProvider), - // Quando l'utente interagisce con la dropdown aggiorniamo lo stato del provider. - onChanged: (value) => ref.read(productSortTypeProvider.notifier).state = value!, - items: [ - // ... - ], - ), +DropdownButton( + // When the sort type changes, this will rebuild the dropdown + // to update the icon shown. + value: ref.watch(productSortTypeProvider), + // When the user interacts with the dropdown, we update the provider state. + onChanged: (value) => + ref.read(productSortTypeProvider.notifier).state = value!, + items: [ + // ... + ], +), /* SNIPPET END */ ],); } diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/dropdown.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/dropdown.dart index 13c37b5a2..18cc6b211 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/dropdown.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/dropdown.dart @@ -7,7 +7,7 @@ import 'full.dart'; /* SNIPPET START */ -// Un enum rappresentante il tipo di filtro +// An enum representing the filter type enum ProductSortType { name, price, diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart index 837bcf153..28eb1f863 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/full.dart @@ -42,7 +42,7 @@ enum ProductSortType { } final productSortTypeProvider = StateProvider( - // Restituiamo il tipo di ordinamento di default, in questo caso 'name'. + // We return the default sort type, here name. (ref) => ProductSortType.name, ); @@ -67,12 +67,12 @@ class MyHomePage extends ConsumerWidget { title: const Text('Products'), actions: [ DropdownButton( - // Quando il tipo di ordinamento cambia, ricostruirà la dropdown - // per aggiornare l'icona mostrata. - + // When the sort type changes, this will rebuild the dropdown + // to update the icon shown. value: ref.watch(productSortTypeProvider), - // Quando l'utente interagisce con la dropdown aggiorniamo lo stato del provider. - onChanged: (value) => ref.read(productSortTypeProvider.notifier).state = value!, + // When the user interacts with the dropdown, we update the provider state. + onChanged: (value) => + ref.read(productSortTypeProvider.notifier).state = value!, items: const [ DropdownMenuItem( value: ProductSortType.name, diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product.dart new file mode 100644 index 000000000..078def200 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product.dart @@ -0,0 +1,20 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ + +class Product { + Product({required this.name, required this.price}); + + final String name; + final double price; +} + +final _products = [ + Product(name: 'iPhone', price: 999), + Product(name: 'cookie', price: 2), + Product(name: 'ps5', price: 500), +]; + +final productsProvider = Provider>((ref) { + return _products; +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product_list_view.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product_list_view.dart new file mode 100644 index 000000000..17765aea8 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/product_list_view.dart @@ -0,0 +1,22 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'product.dart'; + +/* SNIPPET START */ + +Widget build(BuildContext context, WidgetRef ref) { + final products = ref.watch(productsProvider); + return Scaffold( + body: ListView.builder( + itemCount: products.length, + itemBuilder: (context, index) { + final product = products[index]; + return ListTile( + title: Text(product.name), + subtitle: Text('${product.price} \$'), + ); + }, + ), + ); +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart index 3a777ba11..d42eb8cc5 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sort_provider.dart @@ -5,6 +5,6 @@ import 'dropdown.dart'; /* SNIPPET START */ final productSortTypeProvider = StateProvider( - // Restituiamo il tipo di ordinamento di default, in questo caso 'name'. + // We return the default sort type, here name. (ref) => ProductSortType.name, ); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart new file mode 100644 index 000000000..b74c3adf8 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/sorted_product_provider.dart @@ -0,0 +1,24 @@ +import 'package:collection/collection.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'dropdown.dart'; +import 'product.dart'; +import 'sort_provider.dart'; + +final _products = [ + Product(name: 'iPhone', price: 999), + Product(name: 'cookie', price: 2), + Product(name: 'ps5', price: 500), +]; + +/* SNIPPET START */ + +final productsProvider = Provider>((ref) { + final sortType = ref.watch(productSortTypeProvider); + switch (sortType) { + case ProductSortType.name: + return _products.sorted((a, b) => a.name.compareTo(b.name)); + case ProductSortType.price: + return _products.sorted((a, b) => a.price.compareTo(b.price)); + } +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart new file mode 100644 index 000000000..3cd8e6878 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_once.dart @@ -0,0 +1,24 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ + +final counterProvider = StateProvider((ref) => 0); + +class HomeView extends ConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + floatingActionButton: FloatingActionButton( + onPressed: () { + /* highlight-start */ + ref.read(counterProvider.notifier).update((state) => state + 1); + /* highlight-end */ + }, + ), + ); + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart index 66cf7ccda..58f866fc9 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_provider/update_read_twice.dart @@ -16,9 +16,8 @@ class HomeView extends ConsumerWidget { onPressed: () { // We're updating the state from the previous value, we ended-up reading // the provider twice! - // Stiamo aggiornando lo stato dal valore precedente, siamo finiti per - // leggere il provider due volte! - ref.read(counterProvider.notifier).state = ref.read(counterProvider.notifier).state + 1; + ref.read(counterProvider.notifier).state = + ref.read(counterProvider.notifier).state + 1; }, ), ); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx index 8c39a2d30..bd40cfc5f 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx @@ -2,35 +2,52 @@ title: StreamProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet,AutoSnippet } from "../../../../../src/components/CodeSnippet"; +import streamProvider from "./stream_provider/live_stream_chat_provider"; +import streamConsumer from "!!raw-loader!/docs/providers/stream_provider/live_stream_chat_consumer.dart"; -`StreamProvider` è simile a [FutureProvider] ma finalizzato per gli [Stream]s -invece che per i [Future]s. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -`StreamProvider` è solitamente usato per: +`StreamProvider` is similar to [FutureProvider] but for [Stream]s instead of +[Future]s. -- stare in ascolto di Firebase o web-sockets -- ricostruire un altro provider ogni pochi secondi +`StreamProvider` is usually used for: -Dato che gli [Stream]s espongono naturalmente un modo per stare in ascolto degli aggiornamenti, -alcuni potrebbero pensare che l'utilizzo di `StreamProvider` abbia poco valore. -In particolare, potresti credere che [StreamBuilder] di Flutter funzioni altrettanto bene per ascoltare uno [Stream], ma questo è un errore +- listening to Firebase or web-sockets +- rebuilding another provider every few seconds -Usare `StreamProvider` al posto di [StreamBuilder] ha numerosi vantaggi: +Since [Stream]s naturally expose a way for listening to updates, some may think +that using `StreamProvider` has a low value. In particular, you may believe that +Flutter's [StreamBuilder] would work just as well for listening to a [Stream], but +this is a mistake. -- permette ad altri provider di stare in ascolto dello stream usando [ref.watch]. -- assicura una corretta gestione dei casi di caricamento/errore, grazie ad [AsyncValue]. -- rimuove la necessità di differenziare gli streams di trasmissione (broadcast streams) - con gli stream normali. -- memorizza l'ultimo valore emesso dallo stream, assicurandosi che se un - listener viene aggiunto dopo l'emissione di un evento, il listener avrà comunque - accesso immediato all'evento più recente/aggiornato. -- facilita la finzione dello stream durante i test sovrascrivendo lo `StreamProvider`. +Using `StreamProvider` over [StreamBuilder] has numerous benefits: -[ref.watch]: ../concepts/reading#usare-refwatch-per-osservare-un-provider +- it allows other providers to listen to the stream using [ref.watch]. +- it ensures that loading and error cases are properly handled, thanks to [AsyncValue]. +- it removes the need for having to differentiate broadcast streams vs normal streams. +- it caches the latest value emitted by the stream, ensuring that if a + listener is added after an event is emitted, the listener will still have + immediate access to the most up-to-date event. +- it allows easily mocking the stream during tests by overriding the `StreamProvider`. + +## Usage example: live chat using sockets + +`StreamProvider` is used in when we handle stream of asynchronous data +such as Video Streaming, Weather broadcasting Apis or Live chat as follows: + + + +Then, the UI can listen to live streaming chats like so: + +{trimSnippet(streamConsumer)} + +[ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider [statenotifierprovider]: ./state_notifier_provider [provider]: ./provider [futureprovider]: ./future_provider @@ -39,4 +56,4 @@ Usare `StreamProvider` al posto di [StreamBuilder] ha numerosi vantaggi: [stream]: https://api.dart.dev/dart-async/Stream-class.html [stream.periodic]: https://api.dart.dev/stable/2.15.1/dart-async/Stream/Stream.periodic.html [family]: ../concepts/modifiers/family -[streambuilder]: https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html +[streambuilder]: https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html \ No newline at end of file diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart new file mode 100644 index 000000000..383def216 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart @@ -0,0 +1,25 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'live_stream_chat_provider.dart'; + +/* SNIPPET START */ +Widget build(BuildContext context, WidgetRef ref) { + final liveChats = ref.watch(chatProvider); + + // Like FutureProvider, it is possible to handle loading/error states using AsyncValue.when + return switch (liveChats) { + // Display all the messages in a scrollable list view. + AsyncData(:final value) => ListView.builder( + // Show messages from bottom to top + reverse: true, + itemCount: value.length, + itemBuilder: (context, index) { + final message = value[index]; + return Text(message); + }, + ), + AsyncError(:final error) => Text(error.toString()), + _ => const CircularProgressIndicator(), + }; +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart new file mode 100644 index 000000000..d2bb3ad2a --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart @@ -0,0 +1,18 @@ +import 'dart:convert'; +import 'dart:io'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final chatProvider = StreamProvider>((ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +}); diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart new file mode 100644 index 000000000..e2e34878c --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart @@ -0,0 +1,23 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +import 'dart:convert'; +import 'dart:io'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +Stream> chat(ChatRef ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +} diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart new file mode 100644 index 000000000..2ceb077d7 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -0,0 +1,66 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ChatRef = Ref>>; + +@ProviderFor(chat) +const chatProvider = ChatProvider._(); + +final class ChatProvider extends $FunctionalProvider>, + Stream>, ChatRef> + with $FutureModifier>, $StreamProvider, ChatRef> { + const ChatProvider._( + {Stream> Function( + ChatRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'chatProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream> Function( + ChatRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$chatHash(); + + @$internal + @override + $StreamProviderElement> $createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ChatProvider $copyWithCreate( + Stream> Function( + ChatRef ref, + ) create, + ) { + return ChatProvider._(create: create); + } + + @override + Stream> create(ChatRef ref) { + final _$cb = _createCb ?? chat; + return _$cb(ref); + } +} + +String _$chatHash() => r'db1302132f90e854fe2f5da9d97d89c9a3c8b858'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart new file mode 100644 index 000000000..beb2bcd05 --- /dev/null +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart @@ -0,0 +1,18 @@ +import 'dart:convert'; +import 'dart:io'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final chatProvider = StreamProvider>((ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +}); diff --git a/website/i18n/ko/NOTE.md b/website/i18n/ko/NOTE.md new file mode 100644 index 000000000..c5348e2f5 --- /dev/null +++ b/website/i18n/ko/NOTE.md @@ -0,0 +1,22 @@ +# 한국어 번역작업 (Korean Translation) + +## 작업하기 + +- [Initialize the i18n folder](https://docusaurus.io/docs/i18n/git#initialize-the-i18n-folder) + +```shell +# 처음에 한국어 i18n 생성하기 (docusaurus) +yarn run write-translations --locale ko + +# website/i18n/ko/ 폴더에서 문서수정 +# 한국어 문서 실행하고, 최초실행시 import 폴더 구조가 안맞는 것 맞추기 +yarn run dev --locale ko + +# 빌드 +yarn run build --locale ko +# 빌드된 파일 확인 +yarn run serve + +# 작업후 문서의 생성코드 업데이트 +dart run build_runner watch --delete-conflicting-outputs +``` diff --git a/website/i18n/ko/code.json b/website/i18n/ko/code.json index f161a7b30..aff98ff4c 100644 --- a/website/i18n/ko/code.json +++ b/website/i18n/ko/code.json @@ -1,165 +1,227 @@ { "home.shared_state_title": { - "message": "어디에서나 공유할 상태를 선언하세요." + "message": "어디서나 공유 상태 선언하기" }, "home.shared_state_body": { - "message": "{main}파일과 UI 파일간 이동할 필요가 없습니다.\n{br}\n테스트 가능성을 잃지 않고 공유 상태의 코드를 그것이 속한 곳에 별도의 패키지에 있거나 그것을 필요로 하는 위젯 바로 옆에 배치하십시오.", + "message": "더 이상 {main}과 UI 파일 사이를 오갈 필요가 없습니다.{br}\n공유 상태의 코드를 별도의 패키지에 넣든, 필요한 위젯 바로 옆에 넣든, 테스트 가능성을 잃지 않고 적절한 위치에 배치하세요.", "description": "The homepage input placeholder" }, "home.recompute_title": { - "message": "상태를 다시 계산하거나 필요할 때만 UI를 다시 빌드합니다." + "message": "필요할 때만 상태 재계산/UI 재빌드" }, "home.recompute_body": { - "message": "더 이상 {build} 메서드 내에서 목록을 정렬/필터링하거나 고급 캐시 메커니즘에 의존할 필요가 없습니다. {br} {br}\n{Provider} 및 {families}를 사용하여 목록을 정렬하거나 필요할 때만 HTTP\n요청을 수행하세요." + "message": "더 이상 {build} 메서드 내에서 목록을 정렬/필터링하거나 고급 캐시 메커니즘에 의존할 필요가 없습니다.{br} {br}\n{Provider}와 {families}를 사용하여 목록을 정렬하거나 {truly} 필요한 경우에만 HTTP 요청을 수행하세요." + }, + "home.refactors_title": { + "message": "리팩터로 일상적인 작업을 간소화하세요." + }, + "home.refactors_body": { + "message": "Riverpod은 \"Consumer로 위젯 감싸기\"등 다양한 리팩터(refactors)를 제공합니다..\n{warnings}를 살펴보세요." + }, + "home.refactors_list_link": { + "message": "리팩터링 목록" + }, + "home.lint_title": { + "message": "린트 규칙으로 코드의 유지보수성 유지" + }, + "home.lint_body": { + "message": "Riverpod에 특화된 새로운 린트 규칙이 구현되고 더 많은 규칙이 지속적으로 추가됩니다.\n 이렇게 하면 코드가 최상의 상태를 유지할 수 있습니다. {warnings}를 살펴보세요." + }, + "home.lint_rules_list_link": { + "message": "린트 규칙 목록" }, "home.safe_read_title": { - "message": "안전하게 Provider 읽기" + "message": "안전하게 provider 읽기" }, "home.safe_read_body": { - "message": "Provider를 읽는 중 더 이상 bad state가 되지 않습니다. 만약\nProvider를 읽기 위한 필요한 코드를 작성하면, 당신은 유효한 값을 얻을 수 있습니다.\n {br} {br}\n Provider는 비동기적으로 로드된 값에도 적용됩니다. 제공자와는 대조적으로 Riverpod는 로드/오류 사례를 깔끔하게 처리할 수 있습니다." + "message": "provider를 읽었을때 절대로 나쁜 상태(bad state)의 결과가 되지 않습니다. 공급자를 읽는 데 필요한 코드를 작성할 수 있다면 유효한 값(valid value)을 얻을 수 있습니다. {br} {br}이는 비동기적으로 로드된 값에도 적용됩니다. Provider와 달리 Riverpod를 사용하면 로딩/오류 사례를 깔끔하게 처리할 수 있습니다." }, "home.devtool_title": { - "message": "Devtool에서 상태를 관찰하세요." + "message": "개발 도구에서 상태 조사하기" }, "home.devtool_body": { - "message": "Riverpod을 사용하면 Flutter의 devtool 내부에서 상자 밖에서 상태를 확인할 수 있습니다. {br}\n 게다가, 진행 상태를 감시할 수 있습니다." + "message": "Riverpod을 사용하면 Flutter의 개발 도구에서 상태를 바로 확인할 수 있습니다. {br}또한, 완전한 상태 인스펙터(state-inspector)가 개발 중입니다." }, - "homepage.compile_safe_title": { - "message": "안전한 컴파일" + "homepage.declarative_title": { + "message": "선언적 프로그래밍" }, - "homepage.compile_safe_body": { - "message": "더 이상 {ProviderNotFound} 예외가 발생하지 않고, 로딩 상태를 처리하는 것을 걱정하지 않아도 됩니다. Riverpod를 사용하면 코드가 컴파일되어 작동합니다." + "homepage.declarative_body": { + "message": "Stateless 위젯과 유사한 방식으로 비즈니스 로직을 작성하세요.{br}필요할 때 네트워크 요청이 자동으로 재계산되도록 하고 로직을 쉽게 reusable/composable/maintainable 하게 만드세요." }, - "homepage.unlimited_provider_title": { - "message": "제한없는 Provider" + "homepage.common_ui_patterns_title": { + "message": "일반적인 UI 패턴을 쉽게 구현" }, - "homepage.unlimited_provider_body": { - "message": "Riverpod는 Provider에서 영감을 얻었지만 동일한 유형의 여러 Provider를 지원하는 것과 같은 주요 문제 중 일부를 해결합니다. 비동기 Provider를 기다리고 있습니다. 어디에서나 Provider를 추가하세요." + "homepage.common_ui_patterns_body": { + "message": "Riverpod을 사용하면,\"당겨서 새로고침\"/ \"타이핑하는대로 검색\"/등 일반적이지만 복잡한 UI 패턴을 몇 줄의 코드만으로 처리할 수 있습니다." }, - "homepage.no_flutter_dependency_title": { - "message": "Flutter에 의존하지 않습니다." + "homepage.tooling_ready_title": { + "message": "준비된 도구" }, - "homepage.no_flutter_dependency_body": { - "message": "Flutter에 의존하지 않고 Provider를 생성/공유/테스트합니다. 여기에는 {BuildContext} 없이 Provider를 수신할 수 있는 기능이 포함됩니다." + "homepage.tooling_ready_body": { + "message": "Riverpod은 일반적인 실수를 컴파일 에러로 처리하여 컴파일러를 향상시킵니다. 또한 사용자 정의 린트 규칙과 리팩터링 옵션도 제공합니다. 문서 생성을 위한 명령줄도 있습니다." + }, + "homepage.features_title": { + "message": "기능" }, "home.tagline": { - "message": "리엑티브 캐싱, 데이터바인딩 프레임워크" + "message": "리액티브 캐싱 및 데이터 바인딩 프레임워크" }, "home.get_started": { "message": "시작하기" }, "home.create_provider": { - "message": "Provider 생성하기" + "message": "네트워크 요청 만들기" }, "home.consume_provider": { - "message": "Provider 사용하기" + "message": "UI에서 네트워크 요청 수신" + }, + "theme.docs.versions.unreleasedVersionLabel": { + "message": "{siteTitle} {versionLabel}버전에 대한 미공개 문서입니다.", + "description": "The label used to tell the user that he's browsing an unreleased doc version" + }, + "theme.docs.versions.unmaintainedVersionLabel": { + "message": "이 문서는 더 이상 활발하게 유지 관리되지 않는 {siteTitle} {versionLabel}에 대한 문서입니다.", + "description": "The label used to tell the user that he's browsing an unmaintained doc version" + }, + "theme.docs.versions.latestVersionSuggestionLabel": { + "message": "최신 문서는 {latestVersionLink} ({versionLabel})를 참고하세요.", + "description": "The label used to tell the user to check the latest version" + }, + "theme.docs.versions.latestVersionLinkLabel": { + "message": "최신 버전", + "description": "The label used for the latest version suggestion link label" + }, + "custom.outdatedTranslations": { + "message": "이 페이지의 콘텐츠가 오래되었을 수 있습니다. 대신 {englishLink}를 확인해 보세요.", + "description": "The label used inside the outdated translation banner" + }, + "custom.outdatedTranslationLink": { + "message": "english version", + "description": "The link that redirects to the equivalent English doc" + }, + "Code generation": { + "message": "코드생성(code generation)" + }, + "About code generation": { + "message": "코드생성(code generation)에 대한 정보" + }, + "About hooks": { + "message": "훅(Hook)에 대한 정보" }, "theme.ErrorPageContent.title": { - "message": "이 문서가 깨졌습니다.", + "message": "이 페이지가 충돌했습니다.", "description": "The title of the fallback page when the page crashed" }, - "theme.ErrorPageContent.tryAgain": { - "message": "다시 시도해 보세요", - "description": "The label of the button to try again when the page crashed" - }, "theme.NotFound.title": { - "message": "페이지를 찾을 수 없습니다.", + "message": "페이지를 찾을 수 없음", "description": "The title of the 404 page" }, "theme.NotFound.p1": { - "message": "원하는 페이지를 찾을 수 없습니다.", + "message": "원하는 항목을 찾을 수 없습니다.", "description": "The first paragraph of the 404 page" }, "theme.NotFound.p2": { - "message": "사이트 관리자에게 링크가 깨진 것을 알려주세요.", + "message": "원래 URL로 연결한 사이트의 소유자에게 연락하여 링크가 끊어졌다는 사실을 알려주세요.", "description": "The 2nd paragraph of the 404 page" }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "닫기", - "description": "The ARIA label for close button of announcement bar" + "theme.admonition.note": { + "message": "노트", + "description": "The default label used for the Note admonition (:::note)" + }, + "theme.admonition.tip": { + "message": "팁", + "description": "The default label used for the Tip admonition (:::tip)" + }, + "theme.admonition.danger": { + "message": "위험", + "description": "The default label used for the Danger admonition (:::danger)" + }, + "theme.admonition.info": { + "message": "정보", + "description": "The default label used for the Info admonition (:::info)" + }, + "theme.admonition.caution": { + "message": "주의", + "description": "The default label used for the Caution admonition (:::caution)" }, "theme.BackToTopButton.buttonAriaLabel": { - "message": "맨 위로 스크롤하기", + "message": "맨 위로 스크롤", "description": "The ARIA label for the back to top button" }, "theme.blog.archive.title": { - "message": "게시물 목록", + "message": "아카이브", "description": "The page & hero title of the blog archive page" }, "theme.blog.archive.description": { - "message": "게시물 목록", + "message": "아카이브", "description": "The page & hero description of the blog archive page" }, "theme.blog.paginator.navAriaLabel": { - "message": "블로그 게시물 목록 탐색", + "message": "블로그 목록 페이지 탐색", "description": "The ARIA label for the blog pagination" }, "theme.blog.paginator.newerEntries": { - "message": "이전 페이지", + "message": "신규 항목", "description": "The label used to navigate to the newer blog posts page (previous page)" }, "theme.blog.paginator.olderEntries": { - "message": "다음 페이지", + "message": "이전 항목", "description": "The label used to navigate to the older blog posts page (next page)" }, - "theme.blog.post.readingTime.plurals": { - "message": "약 {readingTime}분", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.post.readMore": { - "message": "자세히 보기", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, "theme.blog.post.paginator.navAriaLabel": { - "message": "블로그 게시물 탐색", + "message": "블로그 포스트 페이지 탐색", "description": "The ARIA label for the blog posts pagination" }, "theme.blog.post.paginator.newerPost": { - "message": "이전 게시물", + "message": "신규 포스트", "description": "The blog post button label to navigate to the newer/previous post" }, "theme.blog.post.paginator.olderPost": { - "message": "다음 게시물", + "message": "이전 포스트", "description": "The blog post button label to navigate to the older/next post" }, - "theme.blog.sidebar.navAriaLabel": { - "message": "최근 블로그 문서 둘러보기", - "description": "The ARIA label for recent posts in the blog sidebar" - }, "theme.blog.post.plurals": { - "message": "{count}개 게시물", + "message": "포스트 1개|{count}개 포스트", "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" }, "theme.blog.tagTitle": { - "message": "\"{tagName}\" 태그로 연결된 {nPosts}개의 게시물이 있습니다.", + "message": "\"{tagName}\"으로 태그된 {nPosts}", "description": "The title of the page for a blog tag" }, "theme.tags.tagsPageLink": { "message": "모든 태그 보기", "description": "The label of the link targeting the tag list page" }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "클립보드에 코드 복사", - "description": "The ARIA label for copy code blocks button" + "theme.colorToggle.ariaLabel": { + "message": "어두운 모드와 밝은 모드 간 전환 (현재 {mode})", + "description": "The ARIA label for the navbar color mode toggle" }, - "theme.CodeBlock.copied": { - "message": "복사했습니다", - "description": "The copied button label on code blocks" + "theme.colorToggle.ariaLabel.mode.dark": { + "message": "다크 모드", + "description": "The name for the dark color mode" }, - "theme.CodeBlock.copy": { - "message": "복사", - "description": "The copy button label on code blocks" + "theme.colorToggle.ariaLabel.mode.light": { + "message": "라이트 모드", + "description": "The name for the light color mode" }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "사이드바 열기", - "description": "The ARIA label and title attribute for expand button of doc sidebar" + "theme.docs.breadcrumbs.navAriaLabel": { + "message": "경로", + "description": "The ARIA label for the breadcrumbs" }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "사이드바 열기", - "description": "The ARIA label and title attribute for expand button of doc sidebar" + "theme.docs.DocCard.categoryDescription": { + "message": "{count}개 아이템", + "description": "The default description for a category card in the generated index about how many items this category includes" + }, + "theme.docs.tagDocListPageTitle.nDocsTagged": { + "message": "태그가 지정된 문서 1개|태그가 지정된 문서 {count}개", + "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" + }, + "theme.docs.tagDocListPageTitle": { + "message": "{nDocsTagged} with \"{tagName}\"", + "description": "The title of the page for a docs tag" }, "theme.docs.paginator.navAriaLabel": { - "message": "문서 탐색", + "message": "문서 페이지", "description": "The ARIA label for the docs pagination" }, "theme.docs.paginator.previous": { @@ -170,96 +232,142 @@ "message": "다음", "description": "The label used to navigate to the next doc" }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "사이드바 숨기기", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "사이드바 숨기기", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { - "message": "접을 수 있는 사이드바 분류 '{label}' 접기(펼치기)", - "description": "The ARIA label to toggle the collapsible sidebar category" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "{count} 개 문서가", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged} \"{tagName}\" 태그에 분류되었습니다", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "{siteTitle} {versionLabel} 문서는 아직 정식 공개되지 않았습니다.", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "{siteTitle} {versionLabel} 문서는 더 이상 업데이트되지 않습니다.", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "최신 문서는 {latestVersionLink} ({versionLabel})을 확인하세요.", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "최신 버전", - "description": "The label used for the latest version suggestion link label" + "theme.docs.versionBadge.label": { + "message": "버전: {versionLabel}" }, "theme.common.editThisPage": { - "message": "페이지 편집", + "message": "이 페이지 수정하기", "description": "The link label to edit the current page" }, "theme.common.headingLinkTitle": { - "message": "제목으로 바로 가기", + "message": "{heading}으로 직접 링크", "description": "Title for link to heading" }, "theme.lastUpdated.atDate": { - "message": "갱신일: {date}", + "message": " on {date}", "description": "The words used to describe on which date a page has been last updated" }, "theme.lastUpdated.byUser": { - "message": "갱신자: {user}", + "message": " by {user}", "description": "The words used to describe by who the page has been last updated" }, "theme.lastUpdated.lastUpdatedAtBy": { - "message": "{atDate} {byUser} 마지막으로 업데이트했습니다.", + "message": "최근 업데이트{atDate}{byUser}", "description": "The sentence used to display when a page has been last updated, and by who" }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "← 메인 메뉴로 돌아가기", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, "theme.navbar.mobileVersionsDropdown.label": { "message": "버전", "description": "The label for the navbar versions dropdown on mobile view" }, - "theme.common.skipToMainContent": { - "message": "본문으로 건너뛰기", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, "theme.tags.tagsListLabel": { "message": "태그:", "description": "The label alongside a tag list" }, + "theme.AnnouncementBar.closeButtonAriaLabel": { + "message": "닫기", + "description": "The ARIA label for close button of announcement bar" + }, + "theme.blog.sidebar.navAriaLabel": { + "message": "블로그 최근 게시물 탐색", + "description": "The ARIA label for recent posts in the blog sidebar" + }, + "theme.CodeBlock.copied": { + "message": "복사됨", + "description": "The copied button label on code blocks" + }, + "theme.CodeBlock.copyButtonAriaLabel": { + "message": "코드를 클립보드로 복사", + "description": "The ARIA label for copy code blocks button" + }, + "theme.CodeBlock.copy": { + "message": "복사", + "description": "The copy button label on code blocks" + }, + "theme.CodeBlock.wordWrapToggle": { + "message": "단어 줄바꿈 토글", + "description": "The title attribute for toggle word wrapping button of code block lines" + }, + "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { + "message": "접을 수 있는 사이드바 카테고리 '{label}' 토글", + "description": "The ARIA label to toggle the collapsible sidebar category" + }, + "theme.NavBar.navAriaLabel": { + "message": "Main", + "description": "The ARIA label for the main navigation" + }, + "theme.navbar.mobileLanguageDropdown.label": { + "message": "Languages", + "description": "The label for the mobile language switcher dropdown" + }, "theme.TOCCollapsible.toggleButtonLabel": { "message": "이 페이지에서", "description": "The label used by the button on the collapsible TOC component" }, + "theme.blog.post.readMore": { + "message": "자세히 보기", + "description": "The label used in blog post item excerpts to link to full blog posts" + }, + "theme.blog.post.readMoreLabel": { + "message": "{title}에 대해 자세히 알아보기", + "description": "The ARIA label for the link to full blog posts from excerpts" + }, + "theme.blog.post.readingTime.plurals": { + "message": "1분 읽기|{readingTime}분 읽기", + "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" + }, + "theme.docs.breadcrumbs.home": { + "message": "홈페이지", + "description": "The ARIA label for the home page in the breadcrumbs" + }, + "theme.docs.sidebar.collapseButtonTitle": { + "message": "사이드바 접기", + "description": "The title attribute for collapse button of doc sidebar" + }, + "theme.docs.sidebar.collapseButtonAriaLabel": { + "message": "사이드바 접기", + "description": "The title attribute for collapse button of doc sidebar" + }, + "theme.docs.sidebar.navAriaLabel": { + "message": "문서 사이드바", + "description": "The ARIA label for the sidebar navigation" + }, + "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { + "message": "← 메인 메뉴로 돌아가기", + "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" + }, + "theme.docs.sidebar.closeSidebarButtonAriaLabel": { + "message": "네비게이션바 닫기", + "description": "The ARIA label for close button of mobile sidebar" + }, + "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { + "message": "네비게이션바 토글", + "description": "The ARIA label for hamburger menu button of mobile navigation" + }, + "theme.docs.sidebar.expandButtonTitle": { + "message": "사이드바 확장", + "description": "The ARIA label and title attribute for expand button of doc sidebar" + }, + "theme.docs.sidebar.expandButtonAriaLabel": { + "message": "사이드바 확장", + "description": "The ARIA label and title attribute for expand button of doc sidebar" + }, + "theme.SearchBar.seeAll": { + "message": "{count}개 결과 모두 보기" + }, "theme.SearchPage.documentsFound.plurals": { - "message": "{count}개 문서를 찾았습니다.", + "message": "문서 1개 발견|{count}개 문서 발견", "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" }, "theme.SearchPage.existingResultsTitle": { - "message": "\"{query}\"개 검색 결과가 있습니다.", + "message": "\"{query}\"에 대한 검색 결과", "description": "The search page title for non-empty query" }, "theme.SearchPage.emptyResultsTitle": { - "message": "문서를 검색합니다.", + "message": "문서 검색", "description": "The search page title for empty query" }, "theme.SearchPage.inputPlaceholder": { - "message": "여기에 검색할 키워드를 입력하세요.", + "message": "여기에 검색어를 입력하세요", "description": "The placeholder for search page input" }, "theme.SearchPage.inputLabel": { @@ -271,17 +379,117 @@ "description": "The ARIA label for Algolia mention" }, "theme.SearchPage.noResultsText": { - "message": "검색 결과가 없습니다.", + "message": "검색 결과 없음", "description": "The paragraph for empty search result" }, "theme.SearchPage.fetchingNewResults": { - "message": "새로운 검색 결과를 얻을 수 있습니다...", + "message": "새로운 결과 가져오기...", "description": "The paragraph for fetching new search results" }, "theme.SearchBar.label": { "message": "검색", "description": "The ARIA label and placeholder for search button" }, + "theme.SearchModal.searchBox.resetButtonTitle": { + "message": "검색어 지우기", + "description": "The label and ARIA label for search box reset button" + }, + "theme.SearchModal.searchBox.cancelButtonText": { + "message": "취소", + "description": "The label and ARIA label for search box cancel button" + }, + "theme.SearchModal.startScreen.recentSearchesTitle": { + "message": "최근 검색", + "description": "The title for recent searches" + }, + "theme.SearchModal.startScreen.noRecentSearchesText": { + "message": "최근 검색어 없음", + "description": "The text when no recent searches" + }, + "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": { + "message": "이 검색 저장", + "description": "The label for save recent search button" + }, + "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": { + "message": "검색 기록에서 이 검색어 삭제", + "description": "The label for remove recent search button" + }, + "theme.SearchModal.startScreen.favoriteSearchesTitle": { + "message": "즐겨찾기", + "description": "The title for favorite searches" + }, + "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": { + "message": "즐겨찾기에서 이 검색어 제거하기", + "description": "The label for remove favorite search button" + }, + "theme.SearchModal.errorScreen.titleText": { + "message": "결과를 가져올 수 없습니다.", + "description": "The title for error screen of search modal" + }, + "theme.SearchModal.errorScreen.helpText": { + "message": "네트워크 연결을 확인해 보세요.", + "description": "The help text for error screen of search modal" + }, + "theme.SearchModal.footer.selectText": { + "message": "선택", + "description": "The explanatory text of the action for the enter key" + }, + "theme.SearchModal.footer.selectKeyAriaLabel": { + "message": "Enter key", + "description": "The ARIA label for the Enter key button that makes the selection" + }, + "theme.SearchModal.footer.navigateText": { + "message": "탐색", + "description": "The explanatory text of the action for the Arrow up and Arrow down key" + }, + "theme.SearchModal.footer.navigateUpKeyAriaLabel": { + "message": "위 화살표", + "description": "The ARIA label for the Arrow up key button that makes the navigation" + }, + "theme.SearchModal.footer.navigateDownKeyAriaLabel": { + "message": "아래 화살표", + "description": "The ARIA label for the Arrow down key button that makes the navigation" + }, + "theme.SearchModal.footer.closeText": { + "message": "닫기", + "description": "The explanatory text of the action for Escape key" + }, + "theme.SearchModal.footer.closeKeyAriaLabel": { + "message": "나가기 키", + "description": "The ARIA label for the Escape key button that close the modal" + }, + "theme.SearchModal.footer.searchByText": { + "message": "Search by", + "description": "The text explain that the search is making by Algolia" + }, + "theme.SearchModal.noResultsScreen.noResultsText": { + "message": "결과가 없습니다", + "description": "The text explains that there are no results for the following search" + }, + "theme.SearchModal.noResultsScreen.suggestedQueryText": { + "message": "검색해보세요", + "description": "The text for the suggested query when no results are found for the following search" + }, + "theme.SearchModal.noResultsScreen.reportMissingResultsText": { + "message": "이 검색어가 결과를 반환해야 한다고 생각하시나요?", + "description": "The text for the question where the user thinks there are missing results" + }, + "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": { + "message": "저희에게 알려주세요.", + "description": "The text for the link to report missing results" + }, + "theme.SearchModal.placeholder": { + "message": "문서 검색", + "description": "The placeholder of the input of the DocSearch pop-up modal" + }, + "theme.ErrorPageContent.tryAgain": { + "message": "다시 시도", + "description": "The label of the button to try again rendering when the React error boundary captures an error" + }, + "theme.common.skipToMainContent": { + "message": "주요 콘텐츠로 건너뛰기", + "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" + }, "theme.tags.tagsPageTitle": { "message": "태그", "description": "The title of the tag list page" diff --git a/website/i18n/ko/docusaurus-plugin-content-blog/options.json b/website/i18n/ko/docusaurus-plugin-content-blog/options.json index bdb16439e..9239ff706 100644 --- a/website/i18n/ko/docusaurus-plugin-content-blog/options.json +++ b/website/i18n/ko/docusaurus-plugin-content-blog/options.json @@ -11,4 +11,4 @@ "message": "Recent posts", "description": "The label for the left sidebar" } -} \ No newline at end of file +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current.json b/website/i18n/ko/docusaurus-plugin-content-docs/current.json index 6e09ba821..ca339c131 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current.json +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current.json @@ -3,33 +3,57 @@ "message": "다음", "description": "The label for version current" }, - "sidebar.Sidebar.category.Guides": { - "message": "가이드", - "description": "The label for category Guides in sidebar Sidebar" + "sidebar.Sidebar.category.Introduction": { + "message": "소개(Introduction)", + "description": "The label for category Introduction in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Riverpod for Provider Users": { + "message": "Provider 사용자를 위한 Riverpod", + "description": "The label for category Riverpod for Provider Users in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Essentials": { + "message": "필수사항(Essentials)", + "description": "The label for category Essentials in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Case studies": { + "message": "사례 연구(Case studies)", + "description": "The label for category Case studies in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Advanced topics": { + "message": "고급 주제(Advanced topics)", + "description": "The label for category Advanced topics in sidebar Sidebar" }, "sidebar.Sidebar.category.Concepts": { - "message": "컨셉", + "message": "기본 개념(Concepts)", "description": "The label for category Concepts in sidebar Sidebar" }, - "sidebar.Sidebar.category.Modifiers": { - "message": "수식어", - "description": "The label for category Modifiers in sidebar Sidebar" - }, - "sidebar.Sidebar.category.Migration": { - "message": "마이그레이션", - "description": "The label for category Migration in sidebar Sidebar" + "sidebar.Sidebar.category.Migration guides": { + "message": "마이그레이션 가이드", + "description": "The label for category Migration guides in sidebar Sidebar" }, "sidebar.Sidebar.category.Official examples": { - "message": "사용예제(공식)", + "message": "공식 사용예제", "description": "The label for category Official examples in sidebar Sidebar" }, "sidebar.Sidebar.category.Third party examples": { - "message": "사용예제(서드파티)", + "message": "서드파티 사용예제", "description": "The label for category Third party examples in sidebar Sidebar" }, - "sidebar.Sidebar.category.Api references": { - "message": "Api 레퍼런스", - "description": "The label for category Api references in sidebar Sidebar" + "sidebar.Sidebar.category.Concepts 🚧": { + "message": "기본 개념(Concepts) 🚧", + "description": "The label for category Concepts 🚧 in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Modifiers": { + "message": "수식어(Modifiers)", + "description": "The label for category Modifiers in sidebar Sidebar" + }, + "sidebar.Sidebar.category.All Providers 🚧": { + "message": "전체 Providers 🚧", + "description": "The label for category All Providers 🚧 in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Guides 🚧": { + "message": "가이드 🚧", + "description": "The label for category Guides 🚧 in sidebar Sidebar" }, "sidebar.Sidebar.link.Counter": { "message": "카운터 앱", @@ -39,12 +63,16 @@ "message": "Todo 앱", "description": "The label for link Todo list in sidebar Sidebar, linking to https://github.com/rrousselGit/riverpod/tree/master/examples/todos" }, + "sidebar.Sidebar.link.Pub.dev client": { + "message": "Pub.dev 클라이언트", + "description": "The label for link Pub.dev client in sidebar Sidebar, linking to https://github.com/rrousselGit/riverpod/tree/master/examples/pub" + }, "sidebar.Sidebar.link.Marvel API": { "message": "Marvel API", "description": "The label for link Marvel API in sidebar Sidebar, linking to https://github.com/rrousselGit/riverpod/tree/master/examples/marvel" }, "sidebar.Sidebar.link.Android Launcher": { - "message": "Android Launcher", + "message": "안드로이드 Launcher", "description": "The label for link Android Launcher in sidebar Sidebar, linking to https://github.com/lohanidamodar/fl_live_launcher" }, "sidebar.Sidebar.link.Worldtime Clock": { @@ -55,32 +83,28 @@ "message": "사전 앱", "description": "The label for link Dictionary App in sidebar Sidebar, linking to https://github.com/lohanidamodar/fl_dictio" }, - "sidebar.Sidebar.link.Firebase Starter": { - "message": "Firebase 스타터", - "description": "The label for link Firebase Starter in sidebar Sidebar, linking to https://github.com/lohanidamodar/flutter_firebase_starter/tree/feature/riverpod" - }, "sidebar.Sidebar.link.Time Tracking App (with Firebase)": { "message": "시간관리 앱 (with Firebase)", "description": "The label for link Time Tracking App (with Firebase) in sidebar Sidebar, linking to https://github.com/bizz84/starter_architecture_flutter_firebase" }, "sidebar.Sidebar.link.Firebase Phone Authentication with Riverpod": { - "message": "전화번호 인증 (with Firebase)", + "message": "Riverpod을 사용한 Firebase 전화번호 인증", "description": "The label for link Firebase Phone Authentication with Riverpod in sidebar Sidebar, linking to https://github.com/julienlebren/flutter_firebase_phone_auth_riverpod" }, "sidebar.Sidebar.link.ListView paging with search": { - "message": "검색기능을 포함한 리스트 페이징", + "message": "검색지원 리스트 페이징", "description": "The label for link ListView paging with search in sidebar Sidebar, linking to https://github.com/tbm98/flutter_loadmore_search" }, - "sidebar.Sidebar.link.Resocoder's Weather Bloc to Weather Riverpod": { - "message": "날씨 앱 (Resocoder's)", - "description": "The label for link Resocoder's Weather Bloc to Weather Riverpod in sidebar Sidebar, linking to https://github.com/campanagerald/flutter-bloc-library-v1-tutorial" + "sidebar.Sidebar.link.Resocoder's Weather Bloc to Weather Riverpod V2": { + "message": "Resocoder의 날씨 Bloc to 날씨 Riverpod V2", + "description": "The label for link Resocoder's Weather Bloc to Weather Riverpod V2 in sidebar Sidebar, linking to https://github.com/coyksdev/flutter-bloc-library-v1-tutorial" }, "sidebar.Sidebar.link.Blood Pressure Tracker App": { - "message": "혈압관리 앱", + "message": "혈압 트래커 앱", "description": "The label for link Blood Pressure Tracker App in sidebar Sidebar, linking to https://github.com/UrosTodosijevic/blood_pressure_tracker" }, "sidebar.Sidebar.link.Firebase Authentication with Riverpod Following Flutter DDD Architecture Pattern": { - "message": "Riverpod와 DDD 아키텍처 패던을 적용한 Firebase 인증(Authentication)", + "message": "Flutter DDD 아키텍처 패턴을 따르는 Riverpod을 사용한 Firebase 인증", "description": "The label for link Firebase Authentication with Riverpod Following Flutter DDD Architecture Pattern in sidebar Sidebar, linking to https://github.com/pythonhubpy/firebase_authentication_flutter_DDD" }, "sidebar.Sidebar.link.Todo App with Backup and Restore feature": { @@ -88,35 +112,39 @@ "description": "The label for link Todo App with Backup and Restore feature in sidebar Sidebar, linking to https://github.com/TheAlphaApp/flutter_riverpod_todo_app" }, "sidebar.Sidebar.link.Integrating Hive database with Riverpod (simple example)": { - "message": "Hive 데이터베이스", + "message": "Hive 데이터베이스와 Riverpod 통합하기(간단한 예제)", "description": "The label for link Integrating Hive database with Riverpod (simple example) in sidebar Sidebar, linking to https://github.com/GitGud31/theme_riverpod_hive" }, "sidebar.Sidebar.link.Browser App with Riverpod": { - "message": "브라우저 앱", - "description": "The label for link Browser App with Riverpod, linking to https://github.com/MarioCroSite/simple_browser_app" + "message": "Riverpod을 사용한 브라우저 앱", + "description": "The label for link Browser App with Riverpod in sidebar Sidebar, linking to https://github.com/MarioCroSite/simple_browser_app" }, "sidebar.Sidebar.link.GoRouter with Riverpod": { - "message": "GoRouter", - "description": "The label for link GoRouter with Riverpod, linking to https://github.com/lucavenir/go_router_riverpod" + "message": "Riverpod을 사용한 Go라우터", + "description": "The label for link GoRouter with Riverpod in sidebar Sidebar, linking to https://github.com/lucavenir/go_router_riverpod" }, "sidebar.Sidebar.link.Piano Chords Test": { "message": "피아노 화음 테스트", - "description": "The label for link Piano Chords Test, linking to https://github.com/akvus/piano_fun" + "description": "The label for link Piano Chords Test in sidebar Sidebar, linking to https://github.com/akvus/piano_fun" + }, + "sidebar.Sidebar.link.Movies API App with Caching & Pagination": { + "message": "캐싱 및 페이징이 있는 동영상 API 앱", + "description": "The label for link Movies API App with Caching & Pagination in sidebar Sidebar, linking to https://github.com/Roaa94/movies_app" }, - "sidebar.Sidebar.category.All Providers": { - "message": "프로바이더", - "description": "The label for category All Providers in sidebar Sidebar" + "sidebar.Sidebar.link.AWS Amplify Storage Gallery App with Riverpod & Freezed": { + "message": "Riverpod과 Freezed를 사용한 AWS Amplify 저장소 갤러리 앱", + "description": "The label for link AWS Amplify Storage Gallery App with Riverpod & Freezed in sidebar Sidebar, linking to https://github.com/offlineprogrammer/amplify_storage_app" }, - "sidebar.Sidebar.link.riverpod": { - "message": "riverpod", - "description": "The label for link riverpod in sidebar Sidebar, linking to https://pub.dev/documentation/riverpod/latest/riverpod/riverpod-library.html" + "sidebar.Sidebar.link.Clean Architecture demonstration with Riverpod": { + "message": "Riverpod을 사용한 클린 아키텍처 데모", + "description": "The label for link Clean Architecture demonstration with Riverpod in sidebar Sidebar, linking to https://github.com/Uuttssaavv/flutter-clean-architecture-riverpod" }, - "sidebar.Sidebar.link.flutter_riverpod": { - "message": "flutter_riverpod", - "description": "The label for link flutter_riverpod in sidebar Sidebar, linking to https://pub.dev/documentation//flutter_riverpod/latest/flutter_riverpod/flutter_riverpod-library.html" + "sidebar.Sidebar.link.Delivery App with Google Maps and Live Tracking": { + "message": "Google 지도 및 실시간 추적 기능을 갖춘 배달 앱", + "description": "The label for link Delivery App with Google Maps and Live Tracking in sidebar Sidebar, linking to https://github.com/AhmedLSayed9/deliverzler" }, - "sidebar.Sidebar.link.hooks_riverpod": { - "message": "hooks_riverpod", - "description": "The label for link hooks_riverpod in sidebar Sidebar, linking to https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/hooks_riverpod-library.html" + "sidebar.Sidebar.link.API reference": { + "message": "API 참조", + "description": "The label for link API reference in sidebar Sidebar, linking to https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/hooks_riverpod-library.html" } } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_code_generation.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_code_generation.mdx deleted file mode 100644 index 3875144bc..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_code_generation.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Code Generation 알아보기 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import fetchUser from "!!raw-loader!./about_codegen/main.dart"; -import rawFetchUser from "!!raw-loader!./about_codegen/raw.dart"; -import { - trimSnippet, - CodeSnippet, -} from "../../../../src/components/CodeSnippet"; - -Code generation is the idea of using a tool to generate code for us. -In Dart, it comes with the downside of requiring an extra step to "compile" -an application. Although this problem may be solved in the near future, as the -Dart team is working on a potential solution to this problem. - -In the context of Riverpod, code generation is about slightly changing the syntax -for defining a "provider". For example, instead of: - -{trimSnippet(rawFetchUser)} - -Using code generation, we would write: - -{trimSnippet(fetchUser)} - -When using Riverpod, code generation is completely optional. It is entirely possible -to use Riverpod without. -At the same time, Riverpod embraces code generation and recommends using it. - -For information on how to install and use Riverpod's code generator, refer to -the [getting started](./getting_started) page. Make sure to enable code generation -in the documentation's sidebar. - -## Why use code generation with Riverpod? - -You may be wondering: "If code generation is optional in Riverpod, why use it?" - -As always with packages: To make your life easier. -This includes but is not limited to: - -- better syntax, more readable/flexible and with reduced learning curve. - - - No need to worry about `FutureProvider` vs `Provider` vs etc. Write your logic, - and Riverpod will pick the most suitable provider for you. - - Passing parameters to providers is now unrestricted. Instead of being limited to - using [family](./concepts/modifiers/family) and passing a single positional parameter, - you can now pass any form of parameter. This includes named parametes, optional ones, - and even default values. - -- **stateful hot-reload** of the code written in Riverpod. -- better debugging, through the generation of extra metadata that the debugger then picks-up. -- some Riverpod features will be available only with code generation. - -At the same time, many applications already use code generation with packages such -as [Freezed](https://pub.dev/packages/freezed) or [json_serializable](https://pub.dev/packages/json_serializable). -In that case, your project probably is already setup for code generation, and -using for Riverpod should be simple. - -[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html -[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html -[riverpod]: https://github.com/rrousselgit/riverpod -[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod -[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod -[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_hooks.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/about_hooks.mdx deleted file mode 100644 index 229757933..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/about_hooks.mdx +++ /dev/null @@ -1,283 +0,0 @@ ---- -title: hooks 알아보기 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import pubspec from "./getting_started/pubspec"; -import dartHelloWorld from "./getting_started/dart_hello_world"; -import helloWorld from "./getting_started/hello_world"; -import dartPubspec from "./getting_started/dart_pubspec"; -import { - trimSnippet, - AutoSnippet, - When, -} from "../../../../src/components/CodeSnippet"; - -This page explains what are hooks and how they are related to Riverpod. - -"Hooks" are utilities common from a separate package, independent from Riverpod: -[flutter_hooks]. -Although [flutter_hooks] is a completely separate package and does not have anything -to do with Riverpod (at least directly), it is common to pair Riverpod -and [flutter_hooks] together. After-all, Riverpod and [flutter_hooks] are -maintained by the same team. - -Hooks are completely optional. You do not have to use hooks, especially if you -are starting Flutter. They are powerful tools, but not very "Flutter-like". -As such, it may make sense to start first with plain Flutter/Riverpod, and come back -to hooks once you have a bit more experience. - -## What are hooks? - -Hooks are functions used inside widgets. They are designed as an alternative -to [StatefulWidget]s, to make logic more reusable and composable. - -Hooks are a concept coming from [React](https://reactjs.org/), and [flutter_hooks] -is merely a port of the React implementation to Flutter. -As such, yes, hooks may feel a bit out of place in Flutter. Ideally, -in the future we would have a solution to the problem that hooks solves, -designed specifically for Flutter. - -If Riverpod's providers are for "global" application state, hooks are for -local widget state. Hooks are typically used for dealing with stateful UI objects, -such as [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html), -[AnimationController](https://api.flutter.dev/flutter/animation/AnimationController-class.html). -They can also serve as a replacement to the "builder" pattern, replacing widgets -such as [FutureBuilder](https://api.flutter.dev/flutter/widgets/FutureBuilder-class.html)/[TweenAnimatedBuilder](https://api.flutter.dev/flutter/widgets/TweenAnimationBuilder-class.html) -by an alterative that does not invole "nesting" – drastically improving readability. - -In general, hooks are helpful for: - -- forms -- animations -- reacting to user events -- ... - -As an example, we could use hooks to manually implement a fade-in animation, -where a widget starts invisible and slowly appears. - -If we were to use [StatefulWidget], the code would look like this: - -```dart -class FadeIn extends StatefulWidget { - const FadeIn({Key? key, required this.child}) : super(key: key); - - final Widget child; - - @override - State createState() => _FadeInState(); -} - -class _FadeInState extends State with SingleTickerProviderStateMixin { - late final AnimationController animationController = AnimationController( - vsync: this, - duration: const Duration(seconds: 2), - ); - - @override - void initState() { - super.initState(); - animationController.forward(); - } - - @override - void dispose() { - animationController.dispose(); - super.dispose(); - } - - @override - Widget build(BuildContext context) { - return AnimatedBuilder( - animation: animationController, - builder: (context, child) { - return Opacity( - opacity: animationController.value, - child: widget.child, - ); - }, - ); - } -} -``` - -Using hooks, the equivalent would be: - -```dart -class FadeIn extends HookWidget { - const FadeIn({Key? key, required this.child}) : super(key: key); - - final Widget child; - - @override - Widget build(BuildContext context) { - // Create an AnimationController. The controller will automatically be - // disposed when the widget is unmounted. - final animationController = useAnimationController( - duration: const Duration(seconds: 2), - ); - - // useEffect is the equivalent of initState + didUpdateWidget + dispose. - // The callback passed to useEffect is executed the first time the hook is - // invoked, and then whenever the list passed as second parameter changes. - // Since we pass an empty const list here, that's strictly equivalent to `initState`. - useEffect(() { - // start the animation when the widget is first rendered. - animationController.forward(); - // We could optionally return some "dispose" logic here - return null; - }, const []); - - // Tell Flutter to rebuild this widget when the animation updates. - // This is equivalent to AnimatedBuilder - useAnimation(animationController); - - return Opacity( - opacity: animationController.value, - child: child, - ); - } -} -``` - -There are a few interesting things to note in this code: - -- There is no memory leak. This code does not recreate a new `AnimationController` whenever the - widget rebuild, and the controller is correctly released when the widget is unmounted. - -- It is possible to use hooks as many time as we want within the same widget. - As such, we can create multiple `AnimationController` if we want: - - ```dart - @override - Widget build(BuildContext context) { - final animationController = useAnimationController( - duration: const Duration(seconds: 2), - ); - final anotherController = useAnimationController( - duration: const Duration(seconds: 2), - ); - - ... - } - ``` - - This creates two controllers, without any sort of negative consequence. - -- If we wanted, we could refactor this logic into a separate reusable function: - - ```dart - double useFadeIn() { - final animationController = useAnimationController( - duration: const Duration(seconds: 2), - ); - useEffect(() { - animationController.forward(); - return null; - }, const []); - useAnimation(animationController); - return animationController.value; - } - ``` - - We could then use this function inside our widgets, as long as that widget is a [HookWidget]: - - ```dart - class FadeIn extends HookWidget { - const FadeIn({Key? key, required this.child}) : super(key: key); - - final Widget child; - - @override - Widget build(BuildContext context) { - final fade = useFadeIn(); - - return Opacity(opacity: fade, child: child); - } - } - ``` - - Note how our `useFadeIn` function is completely independent from our - `FadeIn` widget. - If we wanted, we could use that `useFadeIn` function in a completely different - widget, and it would still work! - -## How to use hooks - -Hooks comes with unique constraints: - -- They can only be used within the `build` method of a widget that extends [HookWidget]: - - **Good**: - - ```dart - class Example extends HookWidget { - @override - Widget build(BuildContext context) { - final controller = useAnimationController(); - ... - } - } - ``` - - **Bad**: - - ```dart - // Not a HookWidget - class Example extends StatelessWidget { - @override - Widget build(BuildContext context) { - final controller = useAnimationController(); - ... - } - } - ``` - - **Bad**: - - ```dart - class Example extends HookWidget { - @override - Widget build(BuildContext context) { - return ElevatedButton( - onPressed: () { - // Not _actually_ inside the "build" method, but instead inside - // a user interaction lifecycle (here "on pressed"). - final controller = useAnimationController(); - }, - child: Text('click me'), - ); - } - } - ``` - -- They cannot be used conditionally or in a loop. - - **Bad**: - - ```dart - class Example extends HookWidget { - const Example({required this.condition, super.key}); - final bool condition; - @override - Widget build(BuildContext context) { - if (condition) { - // Hooks should not be used inside "if"s/"for"s, ... - final controller = useAnimationController(); - } - ... - } - } - ``` - - -For more information about hooks, see [flutter_hooks]. - -[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html -[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html -[riverpod]: https://github.com/rrousselgit/riverpod -[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod -[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod -[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx new file mode 100644 index 000000000..600fcc1ea --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx @@ -0,0 +1,59 @@ +--- +title: 성능 최적화하기 +--- + +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; +import select from "./select/select"; + +import selectAsync from "./select/select_async"; + +지금까지 살펴본 내용을 통해 이미 모든 기능을 갖춘 애플리케이션을 구축할 수 있습니다. +하지만 성능과 관련하여 궁금한 점이 있을 수 있습니다. + +이 페이지에서는 코드를 최적화할 수 있는 몇 가지 팁과 요령을 다룰 것입니다. + +:::caution +최적화를 수행하기 전에 애플리케이션을 벤치마킹(benchmark)해야 합니다. +최적화로 인한 복잡성 증가는 소소한 이득에 비해 가치가 없을 수 있습니다. +::: + +## "select"을 사용하여 위젯/provider 다시 빌드하는 것을 필터링합니다. + +기본적으로 `ref.watch`를 사용하면 객체의 _어떠한(any)_ 프로퍼티라도 변경될때마다, consumers/providers가 다시 빌드하는 것을 보셨을 것입니다. +예를 들어, `User`를 watch하고 "name"만 사용해도 'age'가 변경되면 Consumer는 여전히 다시 빌드됩니다. + +그러나 일부 속성만 사용하는 consumer가 있는 경우, 다른 속성이 변경될 때 위젯을 다시 빌드하지 않고 싶을 수 있습니다. + +이는 provider의 `select` 기능을 사용하여 수행할 수 있습니다. +이렇게 하면 `ref.watch`는 더 이상 전체 객체를 반환하지 않고 선택된 프로퍼티만 반환합니다. +그리고 consumer/provider는 이제 선택된 프로퍼티가 변경되는 경우에만 다시 빌드됩니다. + + + +:::info +`select`는 원하는 횟수만큼 호출할 수 있습니다. +원하는 속성당 한 번씩 자유롭게 호출할 수 있습니다. +::: + +:::caution +선택된 프로퍼티는 변경되지 않을 것으로 예상됩니다. +`List`를 반환한 다음 해당 리스트를 변경해도 리빌드가 트리거되지 않습니다. +::: + +:::caution +`select`을 사용하면 무효(invididual) 읽기 작업 속도가 약간 느려지고, 코드의 복잡성이 약간 증가합니다. +이러한 "다른 속성"이 거의 변경되지 않는 경우에는 사용할 가치가 없을 수 있습니다. +::: + +### Selecting asynchronous properties + +다른 provider를 수신하는 provider를 최적화하려는 경우 다른 provider가 비동기식일 가능성이 있습니다. + +일반적으로는 `ref.watch(anotherProvider.future)`를 사용해 값을 가져옵니다. +문제는 `select`이 `AsyncValue`에 적용된다는 것인데, 이는 기다릴 수 있는(await) 상황이 아닙니다. + +이를 위해 `selectAsync`를 대신 사용할 수 있습니다. +이 함수는 비동기 코드에 고유하며, 공급자가 방출한 데이터에 대해 `select` 연산을 수행할 수 있게 해줍니다. +사용법은 `select`와 비슷하지만 대신 `Future`를 반환합니다: + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart new file mode 100644 index 000000000..f875f67e2 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart @@ -0,0 +1,30 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +class User { + late String firstName, lastName; +} + +@riverpod +User example(ExampleRef ref) => User() + ..firstName = 'John' + ..lastName = 'Doe'; + +class ConsumerExample extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 이렇게 작성하는 대신: + // String name = ref.watch(provider).firstName!; + // 이렇게 작성할수 있습니다: + String name = ref.watch(exampleProvider.select((it) => it.firstName)); + // 이렇게 하면 위젯이 "firstName"의 변경 사항만 수신합니다. + + return Text('Hello $name'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart new file mode 100644 index 000000000..069263edb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart @@ -0,0 +1,72 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {User Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final User Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(User value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + User Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + User create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'72881c6147d44adb957180debefe7696d93107f0'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart new file mode 100644 index 000000000..46524af88 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart @@ -0,0 +1,29 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class User { + late String firstName, lastName; +} + +final provider = Provider( + (ref) => User() + ..firstName = 'John' + ..lastName = 'Doe', +); + +class ConsumerExample extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // Instead of writing: + // String name = ref.watch(provider).firstName!; + // We can write: + String name = ref.watch(provider.select((it) => it.firstName)); + // This will cause the widget to only listen to changes on "firstName". + + return Text('Hello $name'); + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart new file mode 100644 index 000000000..55b3a9596 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors, body_might_complete_normally_nullable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class User { + late String firstName, lastName; +} + +@riverpod +FutureOr user(UserRef ref) => User(); + +/* SNIPPET START */ +@riverpod +Object? example(ExampleRef ref) async { + // user를 사용할 수 있을 때까지 기다렸다가 "firstName" 속성만 수신합니다. + final firstName = await ref.watch( + userProvider.selectAsync((it) => it.firstName), + ); + + // TODO use "firstName" to fetch something else +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart new file mode 100644 index 000000000..e308da7fb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart @@ -0,0 +1,125 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef UserRef = Ref>; + +@ProviderFor(user) +const userProvider = UserProvider._(); + +final class UserProvider + extends $FunctionalProvider, FutureOr, UserRef> + with $FutureModifier, $FutureProvider { + const UserProvider._( + {FutureOr Function( + UserRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'userProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + UserRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$userHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + UserProvider $copyWithCreate( + FutureOr Function( + UserRef ref, + ) create, + ) { + return UserProvider._(create: create); + } + + @override + FutureOr create(UserRef ref) { + final _$cb = _createCb ?? user; + return _$cb(ref); + } +} + +String _$userHash() => r'a9a0cda339313a0586556808663c9ef9e0b0e561'; + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {Object? Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Object? Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Object? value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + Object? Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + Object? create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'1fccbdbec0e3585bc9d3a5709ac88a8919dd78fa'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart new file mode 100644 index 000000000..6f3c7ddf9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class User { + late String firstName, lastName; +} + +final userProvider = FutureProvider( + (ref) => User() + ..firstName = 'John' + ..lastName = 'Doe', +); +/* SNIPPET START */ +final provider = FutureProvider((ref) async { + // Wait for a user to be available, and listen to only the "firstName" property + final firstName = await ref.watch( + userProvider.selectAsync((it) => it.firstName), + ); + + // TODO use "firstName" to fetch something else +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx new file mode 100644 index 000000000..27fcea046 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx @@ -0,0 +1,118 @@ +--- +title: 네트워크요청 디바운싱/취소 (Debouncing/Cancelling) +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import homeScreen from "!raw-loader!./cancel/home_screen.dart"; +import extension from "!raw-loader!./cancel/extension.dart"; +import detailScreen from "./cancel/detail_screen"; +import detailScreenCancel from "./cancel/detail_screen_cancel"; +import detailScreenDebounce from "./cancel/detail_screen_debounce"; +import providerWithExtension from "./cancel/provider_with_extension"; + +애플리케이션이 복잡해짐에 따라 동시에 여러 개의 네트워크 요청이 발생하는 것이 일반적입니다. +예를 들어, 사용자가 검색창에 입력할 때마다 새로운 요청이 트리거될 수 있습니다. +사용자가 빠르게 입력하는 경우 애플리케이션에 동시에 많은 요청이 전송될 수 있습니다. + +또는 사용자가 요청을 트리거한 후 요청이 완료되기 전에 다른 페이지로 이동할 수도 있습니다. +이 경우 애플리케이션에 더 이상 필요하지 않은 요청이 전송 중일 수 있습니다. + +이러한 상황에서 성능을 최적화하기 위해 사용할 수 있는 몇 가지 기술이 있습니다: + +- 요청 '디바운스'. + 즉, 사용자가 일정 시간 동안 입력을 멈출 때까지 기다렸다가 요청을 전송하는 방식입니다. + 이렇게 하면 사용자가 빠르게 입력하더라도 주어진 입력에 대해 한 번의 요청만 전송할 수 있습니다. +- 요청 '취소'. + 즉, 요청이 완료되기 전에 사용자가 페이지에서 다른 곳으로 이동하는 경우 요청을 취소합니다. + 이렇게 하면 사용자가 볼 수 없는 응답을 처리하느라 시간을 낭비하지 않아도 됩니다. + +Riverpod에서는 이 두 가지 기술을 비슷한 방식으로 구현할 수 있습니다. +핵심은 `ref.onDispose`를 "자동 폐기(automatic disposal)" 또는 `ref.watch`와 함께 사용하여 원하는 동작을 달성하는 것입니다. + +이를 보여주기 위해 두 페이지로 구성된 간단한 애플리케이션을 만들어 보겠습니다: + +- 새 페이지를 여는 버튼이 있는 홈 화면 +- [Bored API](https://www.boredapi.com/)에서 임의의 액티비티를 표시하는 상세 페이지로, 액티비티를 새로 고칠 수 있는 기능이 있습니다. + 당겨서 새로고침(pull to refresh)를 구현하는 방법에 대한 자세한 내용은 를 참조하세요. + +그런 다음 다음 동작을 구현합니다: + +- 사용자가 세부 정보 페이지를 열었다가 즉시 다시 이동하면 액티비티에 대한 요청을 취소(cancel)합니다. +- 사용자가 연속으로 여러 번 액티비티을 새로 고치면 요청을 디바운스(debounce)하여 사용자가 새로 고침을 중지한 후 한 번만 요청을 보내도록 합니다. + +## 어플리케이션 + +Gif showcasing the application, opening the detail page and refreshing the activity. + +먼저, 디바운스나 취소 없이 애플리케이션을 만들어 봅시다. +여기서는 멋진 것을 사용하지 않고, 세부 정보 페이지를 여는 `Navigator.push`가 있는 평범한 `FloatingActionButton`을 사용하겠습니다. + +먼저 홈 화면을 정의하는 것부터 시작하겠습니다. +평소와 마찬가지로 애플리케이션의 루트에 `ProviderScope`를 지정하는 것을 잊지 마세요. + + + +그런 다음 세부 정보 페이지를 정의해 보겠습니다. +활동을 가져오고 당겨서 새로고침(pull to refresh)를 구현하려면 사례 연구를 참조하세요. + + + +## 요청 취소하기 + +이제 애플리케이션이 작동하므로 취소(cancellation) 로직을 구현해 보겠습니다. + +이를 위해 사용자가 페이지에서 다른 곳으로 이동할 때 `ref.onDispose`를 사용하여 요청을 취소할 것입니다. +이 기능이 작동하려면 provider의 자동 폐기(automatic disposal)가 활성화되어 있어야 합니다. + +요청을 취소하는 데 필요한 정확한 코드는 HTTP 클라이언트에 따라 다릅니다. +이 예에서는 `package:http`를 사용하지만 다른 클라이언트에도 동일한 원칙이 적용됩니다. + +여기서 중요한 점은 사용자가 다른 곳으로 이동할 때 `ref.onDispose`가 호출된다는 것입니다. +이는 provider가 더 이상 사용되지 않으므로 자동 폐기를 통해 폐기되기 때문입니다. +따라서 이 콜백을 사용하여 요청을 취소할 수 있습니다. +`package:http`를 사용하는 경우 HTTP 클라이언트를 닫으면 이 작업을 수행할 수 있습니다. + + + +## 요청 디바운싱(Debouncing) + +이제 취소를 구현했으니 이제 디바운싱을 구현해 보겠습니다. +현재로서는 사용자가 활동을 연속으로 여러 번 새로 고치면 새로 고칠 때마다 요청을 보내게 됩니다. + +기술적으로는 취소를 구현했으므로 문제가 되지 않습니다. +사용자가 활동을 연속으로 여러 번 새로 고치면 새 요청이 이루어질 때 이전 요청이 취소됩니다. + +하지만 이는 이상적이지 않습니다. 여전히 여러 요청을 전송하고 대역폭과 서버 리소스를 낭비하게 됩니다. +대신 사용자가 일정 시간 동안 활동 새로 고침을 중지할 때까지 요청을 지연시키는 방법을 사용할 수 있습니다. + +여기서 로직은 취소 로직과 매우 유사합니다. 다시 `ref.onDispose`를 사용합니다. +하지만 여기서는 HTTP 클라이언트를 닫는 대신 `onDispose`에 의존하여 요청이 시작되기 전에 중단한다는 점이 다릅니다. +그런 다음 요청을 보내기 전에 임의로 500ms를 기다립니다. +그런 다음 사용자가 500ms가 경과하기 전에 활동을 다시 새로고침하면 `onDispose`가 호출되어 요청이 중단됩니다. + +:::info +요청을 중단하려면 자발적으로 던지는(throw) 것이 일반적입니다. +provider가 폐기된(disposed) 후에는 공급자 내부에 던지는(throw) 것이 안전합니다. +예외는 당연히 Riverpod에 의해 잡히고 무시됩니다. +::: + + + +## 더 나아가기: 두 가지를 한 번에 수행하기 + +이제 요청을 디바운스하고 취소하는 방법을 알았습니다. +하지만 현재 다른 요청을 수행하려면 동일한 로직을 여러 곳에 복사하여 붙여넣어야 합니다. 이것은 이상적이지 않습니다. + +하지만 여기서 더 나아가 재사용 가능한 유틸리티를 구현하여 두 가지 작업을 한 번에 수행할 수 있습니다. + +여기서는 단일 메서드에서 취소와 디바운싱을 모두 처리하는 확장 메서드(extension method)를 `Ref`에 구현하는 것이 아이디어입니다. + + + +그런 다음 다음과 같이 공급자에서 이 확장 메서드를 사용할 수 있습니다: + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart new file mode 100644 index 000000000..e3bf193a2 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart @@ -0,0 +1,61 @@ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +/* SNIPPET START */ +@freezed +class Activity with _$Activity { + factory Activity({ + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + factory Activity.fromJson(Map json) => + _$ActivityFromJson(json); +} + +@riverpod +Future activity(ActivityRef ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} + +class DetailPageView extends ConsumerWidget { + const DetailPageView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar( + title: const Text('Detail page'), + ), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const Center(child: CircularProgressIndicator()), + }, + ], + ), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart new file mode 100644 index 000000000..1020def96 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart @@ -0,0 +1,209 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart new file mode 100644 index 000000000..aec2ffe13 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart @@ -0,0 +1,86 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart new file mode 100644 index 000000000..b3ad1faaf --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart @@ -0,0 +1,65 @@ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +/* SNIPPET START */ +class Activity { + Activity({ + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + factory Activity.fromJson(Map json) { + return Activity( + activity: json['activity']! as String, + type: json['type']! as String, + participants: json['participants']! as int, + price: json['price']! as double, + ); + } + + final String activity; + final String type; + final int participants; + final double price; +} + +final activityProvider = FutureProvider.autoDispose((ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); + +class DetailPageView extends ConsumerWidget { + const DetailPageView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar( + title: const Text('Detail page'), + ), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const Center(child: CircularProgressIndicator()), + }, + ], + ), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart new file mode 100644 index 000000000..3d5dff27d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart @@ -0,0 +1,28 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../detail_screen/codegen.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + // package:http를 사용하여 HTTP 클라이언트를 생성합니다. + final client = http.Client(); + // dispose 시 클라이언트를 닫습니다. + // 그러면 클라이언트에 있을 수 있는 모든 보류 중인 요청이 취소됩니다. + ref.onDispose(client.close); + + // 이제 "get" 함수 대신 클라이언트를 사용하여 요청을 수행합니다. + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + // 나머지 코드는 이전과 동일합니다. + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart new file mode 100644 index 000000000..66634724c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -0,0 +1,66 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'304864a6b8051925061a2bba397574ec45b94d08'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart new file mode 100644 index 000000000..2bf5a4d5e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart @@ -0,0 +1,25 @@ +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import '../detail_screen/codegen.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + // We create an HTTP client using package:http + final client = http.Client(); + // On dispose, we close the client. + // This will cancel any pending request that the client might have. + ref.onDispose(client.close); + + // We now use the client to make the request instead of the "get" function. + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + // The rest of the code is the same as before + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart new file mode 100644 index 000000000..1dacaaeca --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart @@ -0,0 +1,39 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../detail_screen/codegen.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + // provider가 현재 폐기(disposed)되었는지 여부를 캡처합니다. + var didDispose = false; + ref.onDispose(() => didDispose = true); + + // 사용자가 새로 고침(refreshing)을 중단할 때까지 기다리기 위해 + // 요청을 500밀리초 지연합니다. + await Future.delayed(const Duration(milliseconds: 500)); + + // 지연 중에 provider가 폐기(disposed)되었다면 사용자가 다시 새로고침했다는 의미입니다. + // 예외를 던져 요청을 취소합니다. + // Riverpod에 의해 잡히므로 여기서 예외를 사용하는 것이 안전합니다. + if (didDispose) { + throw Exception('Cancelled'); + } + + // 다음 코드는 이전 스니펫에서 변경되지 않았습니다. + final client = http.Client(); + ref.onDispose(client.close); + + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart new file mode 100644 index 000000000..7131a0db7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -0,0 +1,66 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'ef908e3b46693862f082769663b14d5369d6e155'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart new file mode 100644 index 000000000..624842ecf --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart @@ -0,0 +1,35 @@ +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import '../detail_screen/codegen.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + // We capture whether the provider is currently disposed or not. + var didDispose = false; + ref.onDispose(() => didDispose = true); + + // We delay the request by 500ms, to wait for the user to stop refreshing. + await Future.delayed(const Duration(milliseconds: 500)); + + // If the provider was disposed during the delay, it means that the user + // refreshed again. We throw an exception to cancel the request. + // It is safe to use an exception here, as it will be caught by Riverpod. + if (didDispose) { + throw Exception('Cancelled'); + } + + // The following code is unchanged from the previous snippet + final client = http.Client(); + ref.onDispose(client.close); + + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart new file mode 100644 index 000000000..ffe40d3f1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart @@ -0,0 +1,31 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +/* SNIPPET START */ +extension DebounceAndCancelExtension on Ref { + /// [duration] (기본값은 500ms) 동안 기다린 다음 요청에 사용할 수 있는 [http.Client]를 반환합니다. + /// + /// 해당 클라이언트는 provider가 폐기되면 자동으로 닫힙니다. + Future getDebouncedHttpClient([Duration? duration]) async { + // 먼저 디바운싱을 처리합니다. + var didDispose = false; + onDispose(() => didDispose = true); + + // 사용자가 새로 고침을 중단할 때까지 기다리기 위해 요청을 500밀리초 지연합니다. + await Future.delayed(duration ?? const Duration(milliseconds: 500)); + + // 지연 중에 provider가 폐기(disposed)되었다면 사용자가 다시 새로고침했다는 의미입니다. + // 예외를 던져 요청을 취소합니다. + // 리버포드에 의해 포착되므로 여기서 예외를 사용하는 것이 안전합니다. + if (didDispose) { + throw Exception('Cancelled'); + } + + // 이제 클라이언트를 생성하고 provider가 폐기되면 클라이언트를 닫습니다. + final client = http.Client(); + onDispose(client.close); + + // 마지막으로 클라이언트를 반환하여 provider가 요청을 할 수 있도록 합니다. + return client; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart new file mode 100644 index 000000000..28f0c50cf --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart @@ -0,0 +1,39 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'detail_screen/codegen.dart'; + +/* SNIPPET START */ +void main() => runApp(const ProviderScope(child: MyApp())); + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return MaterialApp( + routes: { + '/detail-page': (_) => const DetailPageView(), + }, + home: const ActivityView(), + ); + } +} + +class ActivityView extends ConsumerWidget { + const ActivityView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + appBar: AppBar(title: const Text('Home screen')), + body: const Center( + child: Text('Click the button to open the detail page'), + ), + floatingActionButton: FloatingActionButton( + onPressed: () => Navigator.of(context).pushNamed('/detail-page'), + child: const Icon(Icons.add), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart new file mode 100644 index 000000000..2868bf735 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart @@ -0,0 +1,25 @@ +import 'dart:convert'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../detail_screen/codegen.dart'; +import '../extension.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + // 앞서 만든 확장자를 사용하여 HTTP 클라이언트를 가져옵니다. + final client = await ref.getDebouncedHttpClient(); + + // 이제 "get" 함수 대신 클라이언트를 사용하여 요청을 수행합니다. + // 사용자가 페이지를 떠나면 요청은 자연스럽게 디바운스(debounced)되고 취소(cancelled)됩니다. + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart new file mode 100644 index 000000000..128d538bf --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -0,0 +1,66 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'f045dd6e89fde6bbe12a89f243290d289a3e692d'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart new file mode 100644 index 000000000..36ef098f7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart @@ -0,0 +1,23 @@ +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../detail_screen/codegen.dart'; +import '../extension.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + // We obtain an HTTP client using the extension we created earlier. + final client = await ref.getDebouncedHttpClient(); + + // We now use the client to make the request instead of the "get" function. + // Our request will naturally be debounced and be cancelled if the user + // leaves the page. + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx new file mode 100644 index 000000000..8add0ebe9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx @@ -0,0 +1,119 @@ +--- +title: 당겨서 새로고침(Pull to refresh) +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import activity from "./pull_to_refresh/activity"; +import fetchActivity from "./pull_to_refresh/fetch_activity"; +import displayActivity from "!!raw-loader!./pull_to_refresh/display_activity.dart"; +import displayActivity2 from "!!raw-loader!./pull_to_refresh/display_activity2.dart"; +import displayActivity3 from "!!raw-loader!./pull_to_refresh/display_activity3.dart"; +import displayActivity4 from "!!raw-loader!./pull_to_refresh/display_activity4.dart"; +import fullApp from "./pull_to_refresh/full_app"; + +Riverpod은 선언적 성격 덕분에 당겨서 새로고침(pull-to-refresh)를 기본적으로 지원합니다. + +일반적으로 당겨서 새로고침(pull-to-refresh)는 해결해야 할 문제가 많기 때문에 복잡할 수 있습니다: + +- 페이지에 처음 들어갔을 때 스피너(spinner)를 표시하고 싶습니다. + 하지만 새로 고침 중에는 대신 갱신표시기(refresh indicator)를 표시하고 싶습니다. + 갱신표시기(refresh indicator)_와_ 스피너(spinner)를 모두 표시해서는 안 됩니다. +- 새로 고침이 보류 중인 동안 이전 데이터/오류를 표시하고 싶습니다. +- 새로 고침이 진행되는 동안 갱신표시기(refresh indicator)를 표시해야 합니다. + +Riverpod를 사용하여 이 문제를 해결하는 방법을 살펴봅시다. +이를 위해 사용자에게 임의의 액티비티를 추천하는 간단한 예제를 만들어 보겠습니다. +그리고 당겨서 새로고침(pull-to-refresh)를 수행하면 새로운 제안이 트리거됩니다: + +A gif of the previously described application working + +## 기본(bare-bones) 애플리케이션 만들기 + +당겨서 새로고침(pull-to-refresh) 기능을 구현하기 전에 먼저 새로고침할 무언가가 필요합니다. +[Bored API](https://www.boredapi.com/)를 사용하여 사용자에게 임의의 액티비티를 제안하는 간단한 애플리케이션을 만들 수 있습니다. + +먼저 `Activity` 클래스를 정의하겠습니다: + + + +이 클래스는 제안된 액티비티를 타입에 안전한(type-safe) 방식으로 표현하고 JSON 인코딩/디코딩을 처리합니다. +Freezed/json_serializable을 반드시 사용해야 하는 것은 아니지만 권장합니다. + +이제 단일 액티비티를 가져오기 위해 HTTP GET 요청을 하는 provider를 정의하겠습니다: + + + +이제 이 provider를 사용하여 임의의 액티비티를 표시할 수 있습니다. +지금은 로딩/오류 상태를 처리하지 않고 사용 가능한 경우 액티비티만 표시합니다: + + + +## `RefreshIndicator` 추가 + +이제 간단한 애플리케이션을 만들었으니 여기에 `RefreshIndicator`를 추가하면 됩니다. +이 위젯은 사용자가 화면을 아래로 내릴 때 새로고침 표시기(refresh indicator)를 표시하는 공식 머티리얼(Material) 위젯입니다. + +`RefreshIndicator`를 사용하려면 스크롤 가능한 표면(surface)이 필요합니다. +하지만 지금까지는 하나도 없습니다. +`ListView`/`GridView`/`SingleChildScrollView`/등을 사용하면 이 문제를 해결할 수 있습니다: + + + +이제 사용자가 화면을 아래로 내릴 수 있습니다. 하지만 데이터는 아직 새로 고쳐지지 않았습니다. + +## 새로 고침 로직 추가 + +사용자가 화면을 아래로 내리면 `RefreshIndicator`가 `onRefresh` 콜백을 호출합니다. +이 콜백을 사용해 데이터를 새로 고칠 수 있습니다. +여기서 `ref.refresh`를 사용하여 선택한 공급자를 새로 고칠 수 있습니다. + +**참고**: `onRefresh`는 `Future`를 반환할 것으로 예상됩니다. +그리고 새로 고침이 완료될 때 그 future가 완료되는 것이 중요합니다. + +이러한 future를 얻으려면 공급자의 '.future' 속성을 읽으면 됩니다. +그러면 공급자가 해결(resolved)될 때 완료되는 future가 반환됩니다. + +따라서 `RefreshIndicator`를 다음과 같이 업데이트할 수 있습니다: + + + +## 초기 로드 및 오류 처리 중에만 스피너를 표시합니다. + +현재 저희 UI는 오류/로딩 상태를 처리하지 않습니다. +대신 로딩/새로 고침이 완료되면 데이터가 마술처럼 나타납니다. + +이러한 상태를 우아하게 처리하여 이를 변경해 보겠습니다. 두 가지 경우가 있습니다: + +- 초기 로드 중에는 전체 화면 스피너를 표시하고 싶습니다. +- 새로 고침 중에는 새로 고침 표시기와 이전 데이터/오류를 표시하고 싶습니다. + +다행히도 Riverpod에서 비동기 프로바이더를 수신할 때, Riverpod는 필요한 모든 것을 제공하는 `AsyncValue`를 제공합니다. + +이 `AsyncValue`는 다음과 같이 Dart 3.0의 패턴 일치(pattern matching)와 사용할 수 있습니다: + + + +:::caution +여기서는 현재와 같이 `valueOrNull`을 사용하여 에러/로딩 상태인 경우 `value`를 사용합니다. + +Riverpod 3.0에서는 `value`가 `valueOrNull`처럼 동작하도록 변경될 예정입니다. +하지만 지금은 `valueOrNull`을 고수하겠습니다. +::: + +:::tip +패턴 매칭에서 `:final valueOrNull?` 구문이 사용된 것을 주목하세요. +이 구문은 `activityProvider`가 널이 아닌 `Activity`를 반환할 때만 사용할 수 있습니다. + +데이터가 `null`일 수 있는 경우, 대신 `AsyncValue(hasData: true, :final valueOrNull)`를 사용할 수 있습니다. +이렇게 하면 몇 개의 문자가 추가되는 대신 데이터가 `null`인 경우를 올바르게 처리할 수 있습니다. +::: + +## 마무리: 전체 애플리케이션 + +지금까지 다룬 모든 내용을 정리한 소스는 다음과 같습니다: + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart new file mode 100644 index 000000000..ac3e1b17d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart @@ -0,0 +1,19 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; + +part 'codegen.g.dart'; +part 'codegen.freezed.dart'; + +/* SNIPPET START */ +@freezed +class Activity with _$Activity { + factory Activity({ + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + factory Activity.fromJson(Map json) => + _$ActivityFromJson(json); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart new file mode 100644 index 000000000..1020def96 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart @@ -0,0 +1,209 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart new file mode 100644 index 000000000..79ae3cd00 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart @@ -0,0 +1,25 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart new file mode 100644 index 000000000..42365b7bb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart @@ -0,0 +1,24 @@ +/* SNIPPET START */ +class Activity { + Activity({ + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + factory Activity.fromJson(Map json) { + return Activity( + activity: json['activity']! as String, + type: json['type']! as String, + participants: json['participants']! as int, + price: json['price']! as double, + ); + } + + final String activity; + final String type; + final int participants; + final double price; +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart new file mode 100644 index 000000000..8313781ca --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart @@ -0,0 +1,22 @@ +// ignore_for_file: use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: Center( + // 액티비티가 있으면 표시하고, 그렇지 않으면 대기합니다. + child: Text(activity.valueOrNull?.activity ?? ''), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart new file mode 100644 index 000000000..7394ea664 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + /* highlight-start */ + body: RefreshIndicator( + onRefresh: () async => print('refresh'), + child: ListView( + children: [ + /* highlight-end */ + Text(activity.valueOrNull?.activity ?? ''), + ], + ), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart new file mode 100644 index 000000000..17e661a0c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart @@ -0,0 +1,31 @@ +// ignore_for_file: avoid_print, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + // "activityProvider.future"를 새로 고침으로, 해당 결과를 반환하면, + // 새 액티비티를 가져올 때까지 + // 새로 고침 표시기(refresh indicator)가 계속 표시됩니다. + /* highlight-start */ + onRefresh: () => ref.refresh(activityProvider.future), + /* highlight-end */ + child: ListView( + children: [ + Text(activity.valueOrNull?.activity ?? ''), + ], + ), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart new file mode 100644 index 000000000..54564c4c0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart @@ -0,0 +1,35 @@ +// ignore_for_file: avoid_print, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity/codegen.dart'; +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + // 일부 데이터를 사용할 수 있는 경우 해당 데이터를 표시합니다. + // 새로 고침 중에도 데이터를 계속 사용할 수 있습니다. + AsyncValue(:final valueOrNull?) => Text(valueOrNull.activity), + // 오류를 사용할 수 있으므로 렌더링합니다. + AsyncValue(:final error?) => Text('Error: $error'), + // 데이터/오류가 없으므로 로딩 상태입니다. + _ => const CircularProgressIndicator(), + }, + ], + ), + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart new file mode 100644 index 000000000..0cec67cba --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart @@ -0,0 +1,20 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../activity/codegen.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart new file mode 100644 index 000000000..92c2fb027 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -0,0 +1,66 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart new file mode 100644 index 000000000..04de1232b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart @@ -0,0 +1,17 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; + +import '../activity/raw.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart new file mode 100644 index 000000000..b7d53c744 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart @@ -0,0 +1,69 @@ +// ignore_for_file: use_key_in_widget_constructors, unreachable_from_main + +/* SNIPPET START */ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; +part 'codegen.freezed.dart'; + +void main() => runApp(ProviderScope(child: MyApp())); + +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return MaterialApp(home: ActivityView()); + } +} + +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => + Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const CircularProgressIndicator(), + }, + ], + ), + ), + ); + } +} + +@riverpod +Future activity(ActivityRef ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} + +@freezed +class Activity with _$Activity { + factory Activity({ + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + factory Activity.fromJson(Map json) => + _$ActivityFromJson(json); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart new file mode 100644 index 000000000..1020def96 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart @@ -0,0 +1,209 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart new file mode 100644 index 000000000..aec2ffe13 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -0,0 +1,86 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart new file mode 100644 index 000000000..c4186fb31 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart @@ -0,0 +1,73 @@ +// ignore_for_file: use_key_in_widget_constructors, unreachable_from_main + +/* SNIPPET START */ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +void main() => runApp(ProviderScope(child: MyApp())); + +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return MaterialApp(home: ActivityView()); + } +} + +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => + Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const CircularProgressIndicator(), + }, + ], + ), + ), + ); + } +} + +final activityProvider = FutureProvider.autoDispose((ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); + +class Activity { + Activity({ + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + factory Activity.fromJson(Map json) { + return Activity( + activity: json['activity']! as String, + type: json['type']! as String, + participants: json['participants']! as int, + price: json['price']! as double, + ); + } + + final String activity; + final String type; + final int participants; + final double price; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx new file mode 100644 index 000000000..6d3046125 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx @@ -0,0 +1,355 @@ +--- +title: 코드 생성(Code generation)에 대한 정보 +version: 1 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import fetchUser from "!!raw-loader!./about_codegen/main.dart"; +import rawFetchUser from "!!raw-loader!./about_codegen/raw.dart"; +import { Link } from "../../../../../src/components/Link"; +import { trimSnippet, CodeSnippet } from "../../../../../src/components/CodeSnippet"; +import syncFn from "!!raw-loader!./about_codegen/provider_type/sync_fn.dart"; +import syncClass from "!!raw-loader!./about_codegen/provider_type/sync_class.dart"; +import asyncFnFuture from "!!raw-loader!./about_codegen/provider_type/async_fn_future.dart"; +import asyncClassFuture from "!!raw-loader!./about_codegen/provider_type/async_class_future.dart"; +import asyncFnStream from "!!raw-loader!./about_codegen/provider_type/async_fn_stream.dart"; +import asyncClassStream from "!!raw-loader!./about_codegen/provider_type/async_class_stream.dart"; +import familyFn from "!!raw-loader!./about_codegen/provider_type/family_fn.dart"; +import familyClass from "!!raw-loader!./about_codegen/provider_type/family_class.dart"; +import provider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/provider.dart"; +import notifierProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/notifier_provider.dart"; +import futureProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/future_provider.dart"; +import asyncNotifierProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/async_notifier_provider.dart"; +import streamProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/stream_provider.dart"; +import streamNotifierProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart"; +import autoDisposeCodeGen from "!!raw-loader!./about_codegen/provider_type/auto_dispose.dart"; +import autoDisposeNonCodeGen from "!!raw-loader!./about_codegen/provider_type/non_code_gen/auto_dispose.dart"; +import familyCodeGen from "!!raw-loader!./about_codegen/provider_type/family.dart"; +import familyNonCodeGen from "!!raw-loader!./about_codegen/provider_type/non_code_gen/family.dart"; +const TRANSPARENT_STYLE = { backgroundColor: "transparent" }; +const RED_STYLE = { color: "indianred", fontWeight: "700" }; +const BLUE_STYLE = { color: "rgb(103, 134, 196)", fontWeight: "700" }; +const FONT_16_STYLE = { + fontSize: "16px", + fontWeight: "700", +}; +const BLUE_20_STYLE = { + color: "rgb(103, 134, 196)", + fontSize: "20px", + fontWeight: "700", +}; +const PROVIDER_STYLE = { + textAlign: "center", + fontWeight: "600", + maxWidth: "210px", +}; +const BEFORE_STYLE = { + minWidth: "120px", + textAlign: "center", + fontWeight: "600", + color: "crimson", +}; +const AFTER_STYLE = { + minWidth: "120px", + textAlign: "center", + fontWeight: "600", + color: "rgb(40,180,40)", +}; + +코드 생성은 도구를 사용하여 코드를 생성하는 것을 말합니다. +Dart에서는 애플리케이션을 'Compile'하는 데 추가 단계가 필요하다는 단점이 있습니다. +이 문제는 Dart 팀이 이 문제를 해결하려는 잠재적인 해결방안을 연구하고 있기 때문에 곧 해결될 수도 있습니다. + +Riverpod 환경(Context)에서의 코드 생성은 "provider"를 선언하는 문법을 약간 변경하는 것을 의미합니다: + +{trimSnippet(rawFetchUser)} + +코드 생성을 사용하면 다음과 같이 작성할 수 있습니다: + +{trimSnippet(fetchUser)} + +Riverpod 사용 시 코드 생성은 완전히 선택 사항입니다. +코드 생성을 하지 않고도 Riverpod을 사용할 수 있습니다. 동시에 Riverpod은 코드 생성을 수용하며 사용을 권장합니다. + +Riverpod의 코드 생성을 사용하려면, 페이지를 참조하십시오. +문서의 사이드바에서 코드 생성(Code Generation)을 활성화해야 합니다. + +## 코드 생성을 사용해야 하나요? + +코드 생성은 Riverpod에서 선택 사항입니다. +이를 염두에 두고, 코드 생성을 사용해야 할지 말지 궁금할 수 있습니다. + +답변은 **대부분의 경우 예** 입니다. +코드 생성을 사용하는 것이 Riverpod을 사용하는 권장 방법입니다. +이는 보다 미래 지향적인 접근방식(future-proof approach)이며, Riverpod의 잠재력을 최대한 활용할 수 있게 해줍니다. +동시에 많은 애플리케이션에서 이미 [Freezed](https://pub.dev/packages/freezed)나 [json_serializable](https://pub.dev/packages/json_serializable)와 같은 패키지를 사용하여 코드 생성을 사용하고 있습니다. +이 경우, 프로젝트가 이미 코드 생성을 위해 설정되어 있으며, Riverpod을 사용하는 것은 간단합니다. + +현재 코드 생성은 `build_runner`를 많은 사람이 싫어하기 때문에 선택 사항입니다. +하지만, [Static Metaprogramming](https://github.com/dart-lang/language/issues/1482)이 Dart에서 사용 가능해지면, +`build_runner`는 더 이상 문제가 되지 않을 것입니다. +그 때부터는 Riverpod에 코드 생성 문법만 유일한 문법이 될 것입니다. + +`build_runner`를 사용하는 것이 거부감이 든다면, 코드 생성을 사용하지 않는 것을 고려할 수 있습니다. +하지만, 이 경우에는 일부 기능을 사용할 수 없으며, 미래에 코드 생성으로 마이그레이션해야 합니다. +이 때 Riverpod은 마이그레이션을 가능한 한 원활하게 진행할 수 있도록 마이그레이션 도구를 제공할 것입니다. + +## 코드 생성을 사용하면 어떤 이점이 있나요? + +아마 궁금하실 겁니다: "Riverpod에서 코드 생성은 선택 사항이면, 왜 사용해야 하지?" + +패키지는 언제나 그렇듯: 사용자의 삶을 더 쉽게 만들기 위한 것입니다. 이는 다음 내용이 포함되지많 여기에만 국한되지는 않습니다: + +- 더 나은 문법, 더 읽기 쉽고 유연하며, 학습 곡선이 낮습니다. + - provider의 타입을 직접 지정할 필요가 없습니다. 로직을 작성하고, Riverpod이 가장 적합한 provider를 선택합니다. + - 문법이 "더러운 전역 변수(dirty global variable)"를 정의하는 것처럼 보이지 않습니다. 대신, 사용자 정의 함수/클래스를 정의합니다. + - provider에 매개변수를 전달하는 것이 더 이상 제한되지 않습니다. + 를 사용하여 단일 위치 매개변수(single positional parameter)를 전달하는 것이 아니라, + 모든 매개변수를 전달할 수 있습니다. 이는 명명된 매개변수(named parameters), 선택적(optional) 매개변수, 기본값(default values)도 포함합니다. +- Riverpod에서 작성한 코드는 **상태를 가지는 핫 리로드(stateful hot-reload)**를 지원합니다. +- 더 나은 디버깅을 위해 추가 메타데이터를 생성하고 디버거가 수집합니다. +- 일부 Riverpod 기능은 코드 생성을 통해서만 사용할 수 있습니다. + +## 문법 + +### provider 정의하기: + +코드 생성을 사용하여 provider를 정의할 때 아래 사항을 알아 두면 도움이 됩니다: + +- provider는 어노테이션 function 또는 어노테이션 class로 정의할 수 있습니다. + 둘은 거의 동일하지만 class 기반 provider는 외부 객체가 provider의 상태를 수정할 수 있는 공용 메서드(Public Method)를 포함할 수 있다는 장점이 있습니다(부수적인 효과). + 함수형 provider는 빌드 메서드만으로 클래스 기반 provider를 작성하기 위한 달콤한 문법(Sugar syntax)이며, 따라서 UI에서 수정할 수 없습니다. +- 모든 Dart async primitives(Future, FutureOr, Stream)가 지원됩니다. +- 함수가 async로 표시되면, provider는 오류(errors)/로딩(loading) 상태를 자동으로 처리하고 AsyncValue를 노출합니다. + + + + + + + + + + + + + + + + + + + + + + + +
+ Functional +
+ (공개(Public) 메소드로 +
+ 부가작업(Side-Effects)을 처리할 수 없습니다) + 		+ Class-Based +
+ (공개(Public) 메소드로 +
+ 부가작업(Side-Effects)을 처리할 수 있습니다) +
+ + Sync + + + {trimSnippet(syncFn)} + + {trimSnippet(syncClass)} +
+ + Async - Future + + + {trimSnippet(asyncFnFuture)} + + {trimSnippet(asyncClassFuture)} +
+ + Async - Stream + + + {trimSnippet(asyncFnStream)} + + {trimSnippet(asyncClassStream)} +
+ +### 자동폐기(autoDispose) 활성화/비활성화: + +코드 생성을 사용할때, provider는 기본적으로 autoDispose가 활성화됩니다. +코드 생성을 사용할 때 공급자는 기본적으로 자동 폐기됩니다. +즉, 연결(ref.watch/ref.listen)된 리스너가 없을 때 자동으로 폐기됩니다. +이 기본 설정은 Riverpod의 철학에 더 잘 부합합니다. +코드 생성하지 않는 버전을 사용하면, `package:provider`에서 마이그레이션하는 사용자를 위해 자동폐기(autoDispose) 기능이 기본적으로 꺼져 있었습니다. + +자동폐기(autoDispose)를 비활성화하려면, `autoDispose: false`를 어노테이션에 전달하면 됩니다. + +{trimSnippet(autoDisposeCodeGen)} + +### provider에 매개변수 전달하기 (family): + +코드 생성을 사용할 때, provider에 매개변수를 전달하기위해 더 이상 `family` 수정자(modifier)를 사용할 필요가 없습니다. +대신 provider의 메인 함수(main function)는 명명된 매개변수(named parameters), 선택적 매개변수(optional parameters), 기본값(default values)을 포함하여 모든 매개변수를 받을 수 있습니다. +그러나 이 매개변수들은 여전히 일관된 ==를 가져야 한다는 점에 유의하세요. +즉, 값이 캐시되거나 매개변수가 ==를 재정의해야 한다는 의미입니다. + + + + + + + + + + + + + + +
+ Functional + + Class-Based +
+ {trimSnippet(familyFn)} + + {trimSnippet(familyClass)} +
+ +## 코드 생성을 사용하지 않는 방식(non-code-generation variant)에서 마이그레이션하기: + +코드 생성 방식을 사용하지 않는 경우에는 provider의 타입을 직접 결정해야 합니다. +다음은 코드 생성 방식으로 전환하기 위한 해당 옵션입니다: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Provider +
Before + {trimSnippet(provider)} +
After + {trimSnippet(syncFn)} +
+ NotifierProvider +
Before + {trimSnippet(notifierProvider)} +
After + {trimSnippet(syncClass)} +
+ FutureProvider +
Before + {trimSnippet(futureProvider)} +
After + {trimSnippet(asyncFnFuture)} +
+ StreamProvider +
Before + {trimSnippet(streamProvider)} +
After + {trimSnippet(asyncFnStream)} +
+ AsyncNotifierProvider +
Before + + {trimSnippet(asyncNotifierProvider)} + +
After + {trimSnippet(asyncClassFuture)} +
+ StreamNotifierProvider +
Before + + {trimSnippet(streamNotifierProvider)} + +
After + {trimSnippet(asyncClassStream)} +
+ +[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html +[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html +[riverpod]: https://github.com/rrousselgit/riverpod +[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod +[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod +[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks +[build]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier/build.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.dart similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.dart diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.g.dart similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/main.g.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.g.dart diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart new file mode 100644 index 000000000..1988ec140 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_class_future.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + Future build() async { + return Future.value('foo'); + } + + // 상태(State) 변경(Mutation)을 위한 메서드 추가 +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart new file mode 100644 index 000000000..1172a8ca6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart @@ -0,0 +1,73 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_class_future.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $AsyncNotifierProvider { + const ExampleProvider._( + {super.runNotifierBuildOverride, Example Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Example Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + Example create() => _createCb?.call() ?? Example(); + + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._(create: create); + } + + @$internal + @override + ExampleProvider $copyWithBuild( + FutureOr Function( + Ref>, + Example, + ) build, + ) { + return ExampleProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$exampleHash() => r'8a906741b8ea4b9b0d3f0b924779704b3e1773a1'; + +abstract class _$Example extends $AsyncNotifier { + FutureOr build(); + @$internal + @override + FutureOr runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart new file mode 100644 index 000000000..fdde7f0ef --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_class_stream.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + Stream build() async* { + yield 'foo'; + } + + // 상태(State) 변경(Mutation)을 위한 메서드 추가 +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart new file mode 100644 index 000000000..de860bb63 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart @@ -0,0 +1,73 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_class_stream.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $StreamNotifierProvider { + const ExampleProvider._( + {super.runNotifierBuildOverride, Example Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Example Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + Example create() => _createCb?.call() ?? Example(); + + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._(create: create); + } + + @$internal + @override + ExampleProvider $copyWithBuild( + Stream Function( + Ref>, + Example, + ) build, + ) { + return ExampleProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $StreamNotifierProviderElement $createElement( + ProviderContainer container) => + $StreamNotifierProviderElement(this, container); +} + +String _$exampleHash() => r'4bca936132b77a9a804549f086f33571724b4804'; + +abstract class _$Example extends $StreamNotifier { + Stream build(); + @$internal + @override + Stream runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart new file mode 100644 index 000000000..95fdd909c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_fn_future.g.dart'; + +/* SNIPPET START */ +@riverpod +Future example(ExampleRef ref) async { + return Future.value('foo'); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart new file mode 100644 index 000000000..15a20ea77 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_fn_future.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'e620af6b870a76eea4228989433de0666957d813'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart new file mode 100644 index 000000000..74da790ad --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_fn_stream.g.dart'; + +/* SNIPPET START */ +@riverpod +Stream example(ExampleRef ref) async* { + yield 'foo'; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart new file mode 100644 index 000000000..163bb593f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_fn_stream.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider, Stream, ExampleRef> + with $FutureModifier, $StreamProvider { + const ExampleProvider._( + {Stream Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $StreamProviderElement $createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + Stream Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + Stream create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'8a2b19776fb9bbb1631f898bd6446b57b102dd9d'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart new file mode 100644 index 000000000..587576695 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart @@ -0,0 +1,12 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'auto_dispose.g.dart'; + +/* SNIPPET START */ +// 자동폐기(AutoDispose) provider (keepAlive는 기본적으로 false) +@riverpod +String example1(Example1Ref ref) => 'foo'; + +// 비자동폐기(Non autoDispose) provider +@Riverpod(keepAlive: true) +String example2(Example2Ref ref) => 'foo'; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart new file mode 100644 index 000000000..a52691df6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -0,0 +1,133 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'auto_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef Example1Ref = Ref; + +@ProviderFor(example1) +const example1Provider = Example1Provider._(); + +final class Example1Provider + extends $FunctionalProvider + with $Provider { + const Example1Provider._( + {String Function( + Example1Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'example1Provider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + Example1Ref ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$example1Hash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Example1Provider $copyWithCreate( + String Function( + Example1Ref ref, + ) create, + ) { + return Example1Provider._(create: create); + } + + @override + String create(Example1Ref ref) { + final _$cb = _createCb ?? example1; + return _$cb(ref); + } +} + +String _$example1Hash() => r'8a5f0865f758792cc8e4f2ca67db334196df6e88'; + +typedef Example2Ref = Ref; + +@ProviderFor(example2) +const example2Provider = Example2Provider._(); + +final class Example2Provider + extends $FunctionalProvider + with $Provider { + const Example2Provider._( + {String Function( + Example2Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'example2Provider', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + Example2Ref ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$example2Hash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Example2Provider $copyWithCreate( + String Function( + Example2Ref ref, + ) create, + ) { + return Example2Provider._(create: create); + } + + @override + String create(Example2Ref ref) { + final _$cb = _createCb ?? example2; + return _$cb(ref); + } +} + +String _$example2Hash() => r'bc25731d759be185125d12d995d0b89b07d1e271'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart new file mode 100644 index 000000000..e1ee685fb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart @@ -0,0 +1,7 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family.g.dart'; + +/* SNIPPET START */ +@riverpod +String example(ExampleRef ref, int param) => 'Hello $param'; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart new file mode 100644 index 000000000..016068466 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart @@ -0,0 +1,145 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleFamily._(); + +final class ExampleProvider + extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {required ExampleFamily super.from, + required int super.argument, + String Function( + ExampleRef ref, + int param, + )? create}) + : _createCb = create, + super( + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + ExampleRef ref, + int param, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + String toString() { + return r'exampleProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + String Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._( + argument: argument as int, + from: from! as ExampleFamily, + create: ( + ref, + int param, + ) => + create(ref)); + } + + @override + String create(ExampleRef ref) { + final _$cb = _createCb ?? example; + final argument = this.argument as int; + return _$cb( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is ExampleProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$exampleHash() => r'c4f5a651a55bcf34b0c92d98d77436844cbdc097'; + +final class ExampleFamily extends Family { + const ExampleFamily._() + : super( + name: r'exampleProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + ExampleProvider call( + int param, + ) => + ExampleProvider._(argument: param, from: this); + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + String toString() => r'exampleProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + String Function( + ExampleRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart new file mode 100644 index 000000000..f071d44f6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart @@ -0,0 +1,17 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family_class.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + String build( + int param1, { + String param2 = 'foo', + }) { + return 'Hello $param1 & param2'; + } + + // 상태(State) 변경(Mutation)을 위한 메서드 추가 +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart new file mode 100644 index 000000000..9205ef62a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart @@ -0,0 +1,207 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family_class.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Example) +const exampleProvider = ExampleFamily._(); + +final class ExampleProvider extends $NotifierProvider { + const ExampleProvider._( + {required ExampleFamily super.from, + required ( + int, { + String param2, + }) + super.argument, + super.runNotifierBuildOverride, + Example Function()? create}) + : _createCb = create, + super( + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Example Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + String toString() { + return r'exampleProvider' + '' + '$argument'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Example create() => _createCb?.call() ?? Example(); + + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._( + argument: argument as ( + int, { + String param2, + }), + from: from! as ExampleFamily, + create: create); + } + + @$internal + @override + ExampleProvider $copyWithBuild( + String Function( + Ref, + Example, + ) build, + ) { + return ExampleProvider._( + argument: argument as ( + int, { + String param2, + }), + from: from! as ExampleFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is ExampleProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$exampleHash() => r'c81e9d94e763b25403ab6b7fa03f092003570142'; + +final class ExampleFamily extends Family { + const ExampleFamily._() + : super( + name: r'exampleProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + ExampleProvider call( + int param1, { + String param2 = 'foo', + }) => + ExampleProvider._(argument: ( + param1, + param2: param2, + ), from: this); + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + String toString() => r'exampleProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + Example Function( + ( + int, { + String param2, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleProvider; + + final argument = provider.argument as ( + int, { + String param2, + }); + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + String Function( + Ref ref, + Example notifier, + ( + int, { + String param2, + }) argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleProvider; + + final argument = provider.argument as ( + int, { + String param2, + }); + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(container); + }, + ); + } +} + +abstract class _$Example extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as ( + int, { + String param2, + }); + int get param1 => _$args.$1; + String get param2 => _$args.param2; + + String build( + int param1, { + String param2 = 'foo', + }); + @$internal + @override + String runBuild() => build( + _$args.$1, + param2: _$args.param2, + ); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart new file mode 100644 index 000000000..863df6f40 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart @@ -0,0 +1,13 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family_fn.g.dart'; + +/* SNIPPET START */ +@riverpod +String example( + ExampleRef ref, + int param1, { + String param2 = 'foo', +}) { + return 'Hello $param1 & param2'; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart new file mode 100644 index 000000000..a1a795b7c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart @@ -0,0 +1,169 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family_fn.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleFamily._(); + +final class ExampleProvider + extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {required ExampleFamily super.from, + required ( + int, { + String param2, + }) + super.argument, + String Function( + ExampleRef ref, + int param1, { + String param2, + })? create}) + : _createCb = create, + super( + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + ExampleRef ref, + int param1, { + String param2, + })? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + String toString() { + return r'exampleProvider' + '' + '$argument'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + String Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._( + argument: argument as ( + int, { + String param2, + }), + from: from! as ExampleFamily, + create: ( + ref, + int param1, { + String param2 = 'foo', + }) => + create(ref)); + } + + @override + String create(ExampleRef ref) { + final _$cb = _createCb ?? example; + final argument = this.argument as ( + int, { + String param2, + }); + return _$cb( + ref, + argument.$1, + param2: argument.param2, + ); + } + + @override + bool operator ==(Object other) { + return other is ExampleProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$exampleHash() => r'99b3ed3d53932bd1354259200ebf08493af9ada2'; + +final class ExampleFamily extends Family { + const ExampleFamily._() + : super( + name: r'exampleProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + ExampleProvider call( + int param1, { + String param2 = 'foo', + }) => + ExampleProvider._(argument: ( + param1, + param2: param2, + ), from: this); + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + String toString() => r'exampleProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + String Function( + ExampleRef ref, + ( + int, { + String param2, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleProvider; + + final argument = provider.argument as ( + int, { + String param2, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart new file mode 100644 index 000000000..3484fa515 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart @@ -0,0 +1,16 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = + AsyncNotifierProvider.autoDispose( + ExampleNotifier.new, +); + +class ExampleNotifier extends AsyncNotifier { + @override + Future build() async { + return Future.value('foo'); + } + + // 상태(State) 변경(Mutation)을 위한 메서드 추가 +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart new file mode 100644 index 000000000..6bfb8babd --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart @@ -0,0 +1,12 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +// 자동폐기(autodispose) 프로바이더 +final example1Provider = Provider.autoDispose((ref) { + return 'foo'; +}); + +// 비동기 자동폐기(autodispose) 프로바이더 +final example2Provider = Provider((ref) { + return 'foo'; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart new file mode 100644 index 000000000..a9e59d48d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart @@ -0,0 +1,6 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = Provider.family((ref, param) { + return 'Hello $param'; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart new file mode 100644 index 000000000..6306a76fb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart @@ -0,0 +1,7 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = + FutureProvider.autoDispose((ref) async { + return Future.value('foo'); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart new file mode 100644 index 000000000..3fe303726 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart @@ -0,0 +1,15 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = NotifierProvider.autoDispose( + ExampleNotifier.new, +); + +class ExampleNotifier extends Notifier { + @override + String build() { + return 'foo'; + } + + // 상태(State) 변경(Mutation)을 위한 메서드 추가 +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart new file mode 100644 index 000000000..1f541352a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart @@ -0,0 +1,8 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = Provider.autoDispose( + (ref) { + return 'foo'; + }, +); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart new file mode 100644 index 000000000..d2d6a3a0c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart @@ -0,0 +1,16 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = + StreamNotifierProvider.autoDispose(() { + return ExampleNotifier(); +}); + +class ExampleNotifier extends StreamNotifier { + @override + Stream build() async* { + yield 'foo'; + } + + // 상태(State) 변경(Mutation)을 위한 메서드 추가 +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart new file mode 100644 index 000000000..60d227f8f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart @@ -0,0 +1,6 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = StreamProvider.autoDispose((ref) async* { + yield 'foo'; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart new file mode 100644 index 000000000..dbe0773f9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'sync_class.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + String build() { + return 'foo'; + } + + // 상태(State) 변경(Mutation)을 위한 메서드 추가 +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart new file mode 100644 index 000000000..adc2e93df --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'sync_class.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $NotifierProvider { + const ExampleProvider._( + {super.runNotifierBuildOverride, Example Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Example Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Example create() => _createCb?.call() ?? Example(); + + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._(create: create); + } + + @$internal + @override + ExampleProvider $copyWithBuild( + String Function( + Ref, + Example, + ) build, + ) { + return ExampleProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$exampleHash() => r'c237193ab6d57674973aaa02eb73db6f6822eb26'; + +abstract class _$Example extends $Notifier { + String build(); + @$internal + @override + String runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart new file mode 100644 index 000000000..0d4922734 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'sync_fn.g.dart'; + +/* SNIPPET START */ +@riverpod +String example(ExampleRef ref) { + return 'foo'; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart new file mode 100644 index 000000000..9a6ccdf70 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -0,0 +1,73 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'sync_fn.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {String Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + String Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + String create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'dd4e9043c704a42a3fc025e7fef9515f659fc78a'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/raw.dart similarity index 93% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/raw.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/raw.dart index 6e2543d77..4630c27ff 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_codegen/raw.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_codegen/raw.dart @@ -13,7 +13,7 @@ class Http { final http = Http(); /* SNIPPET START */ -final fetchUserProvider = FutureProvider.autoDispose.family((ref, userId) async { +final fetchUserProvider = FutureProvider.autoDispose.family((ref, userId) async { final json = await http.get('api/user/$userId'); return User.fromJson(json); }); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx new file mode 100644 index 000000000..5dcf7354d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx @@ -0,0 +1,310 @@ +--- +title: 훅(hooks)에 대한 정보 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import hookAndConsumer from "!!raw-loader!./about_hooks/hook_and_consumer.dart"; +import hookConsumer from "!!raw-loader!./about_hooks/hook_consumer.dart"; +import hookConsumerWidget from "!!raw-loader!./about_hooks/hook_consumer_widget.dart"; +import { CodeSnippet } from "../../../../../src/components/CodeSnippet"; +import { Link } from "../../../../../src/components/Link"; + +이 페이지는 훅(hooks)이 무엇이고 Riverpod과 어떻게 관련되어 있는지 설명합니다. + +"훅(hooks)"은 Riverpod과는 독립적으로 별도의 패키지에서 제공되는 공통 유틸리티입니다: [flutter_hooks]. +[flutter_hooks]는 완전히 별개의 패키지로 Riverpod과 (적어도 직접적으로는) 관련이 없지만, Riverpod과 [flutter_hooks]를 함께 사용하는 것이 일반적입니다. + +## 훅(hooks)을 사용해야 할까요? + +훅(hooks)은 강력한 도구이지만 모든 사람에게 적합한 것은 아닙니다. +Riverpod에 처음 사용하는 분이라면, 훅(hooks) 사용을 피하는 것이 좋습니다. + +훅(hooks)은 유용하지만 Riverpod에 필수적인 것은 아닙니다. +Riverpod 때문에 훅(hooks)을 사용해서는 안됩니다. 오히려 훅(hooks)을 사용하고 싶어서 훅(hooks)을 사용해야 합니다. + +훅(hooks)사용은 장단점(tradeoff)가 있습니다. +훅(hooks)은 강력(robust)하고 재사용(reusable) 가능한 코드를 생성하는데 유용하지만, 배워야하는 새로운 개념이기 때문에 처음에는 혼란스러울 수 있습니다. +훅(hooks)은 Flutter의 핵심 개념이 아닙니다. 따라서 Flutter/Dart에서는 어색하게 느껴질 수 있습니다. + +## 훅(hooks)이란 무엇인가? + +훅(hooks)은 위젯 내부에서 사용되는 함수입니다. +[StatefulWidget]의 대안으로 설계되었으며, 로직을 더 재사용(reusable) 가능하고 조합(composable) 가능하게 만듭니다. + +훅(hooks)은 [React](https://reactjs.org/)에서 온 개념이며, [flutter_hooks]는 단지 React 구현을 Flutter로 포팅한 것입니다. +따라서 훅(hooks)은 Flutter에서 약간 어색할 수 있습니다. +이상적으로 향후에 Flutter를 위해 특별히 설계된 훅(hooks)이 해결하는 문제에 대한 솔루션이 있을 것입니다. + +Riverpod의 provider가 "전역(Global)" 애플리케이션 상태(State)를 위한 것이라면, 훅(Hooks)은 로컬 위젯 상태를 위한 것입니다. +훅(Hooks)dms 일반적으로 상태 저장형 UI 객체를 처리하는 데 사용됩니다, +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html), +[AnimationController](https://api.flutter.dev/flutter/animation/AnimationController-class.html). +또한 "빌더(Builder)" 패턴을 대체하는 역할도 수행할 수 있는데, +[FutureBuilder](https://api.flutter.dev/flutter/widgets/FutureBuilder-class.html)/[TweenAnimatedBuilder](https://api.flutter.dev/flutter/widgets/TweenAnimationBuilder-class.html)와 같은 위젯을 "중첩(nesting)"을 포함하지 않는 대안 유발하지 않는 방식으로 변경으로 가독성을 크게 향상시킬 수 있습니다. + +일반적으로, 훅(hooks)은 다음과 같은 경우에 유용합니다: + +- 폼(forms) +- 애니메이션(animations) +- 사용자 이벤트에 반응하기(reacting to user events) +- ... + +예를 들어, 훅(Hooks)를 위젯이 보이지 않다가 서서히 나타나는 페이드인(Fade-in) 애니메이션을 직접 구현하는데 사용할 수 있습니다. + +만약 [StatefulWidget]을 사용한다면, 코드는 다음과 같을 것입니다: + +```dart +class FadeIn extends StatefulWidget { + const FadeIn({Key? key, required this.child}) : super(key: key); + + final Widget child; + + @override + State createState() => _FadeInState(); +} + +class _FadeInState extends State with SingleTickerProviderStateMixin { + late final AnimationController animationController = AnimationController( + vsync: this, + duration: const Duration(seconds: 2), + ); + + @override + void initState() { + super.initState(); + animationController.forward(); + } + + @override + void dispose() { + animationController.dispose(); + super.dispose(); + } + + @override + Widget build(BuildContext context) { + return AnimatedBuilder( + animation: animationController, + builder: (context, child) { + return Opacity( + opacity: animationController.value, + child: widget.child, + ); + }, + ); + } +} +``` + +훅(hooks)을 사용하면, 동일한 코드는 다음과 같을 것입니다: + +```dart +class FadeIn extends HookWidget { + const FadeIn({Key? key, required this.child}) : super(key: key); + + final Widget child; + + @override + Widget build(BuildContext context) { + // AnimationController 생성. + // 위젯인 마운트해제(unmounted)되면 컨트롤러는 자동으로 폐기(disposed)됩니다. + final animationController = useAnimationController( + duration: const Duration(seconds: 2), + ); + + // useEffect는 initState + didUpdateWidget + dispose와 동일합니다 + // useEffect에 잔달된 콜백(callback)은 훅(hook)이 처음 호출될 때 실행되고, + // 두 번째 매개변수로 전달된 목록이 변경될 때마다 실행됩니다. + // 여기서는 빈 const list를 전달하므로, 이는 엄밀히 말해 `initState`와 동일합니다. + useEffect(() { + // 위젯이 처음 렌더링될 때 애니메이션이 시작 + animationController.forward(); + // 여기서 선택적으로 "Dispose"로직을 반환할 수 있습니다. + return null; + }, const []); + + // 애니메이션이 업데이트될 때 이 위젯을 다시 빌드하도록 Flutter에 알립니다. + // 이는 AnimatedBuilder와 동일합니다 + useAnimation(animationController); + + return Opacity( + opacity: animationController.value, + child: child, + ); + } +} +``` + +이 코드에서 주목해야 할 몇 가지 흥미로운 사항이 있습니다: + +- 메모리 누수가 없습니다. 이 코드는 위젯이 리빌드될 때마다 새로운 `AnimationController`를 다시 생성하지 않으며, + 위젯이 마운트해제(unmounted)될 때 컨트롤러가 올바르게 해제(released)됩니다. + +- 동일한 위젯 내에서 원하는 만큼 많이 훅(Hooks)을 사용할 수 있습니다. + 따라서 원한다면 여러 `AnimationController`를 생성할 수 있습니다: + + ```dart + @override + Widget build(BuildContext context) { + final animationController = useAnimationController( + duration: const Duration(seconds: 2), + ); + final anotherController = useAnimationController( + duration: const Duration(seconds: 2), + ); + + ... + } + ``` + + 이렇게 하면 어떤 부정적인 결과도 없이 두 개의 컨트롤러가 생성됩니다. + +- 원한다면 이 로직을 재사용 가능한 별도의 함수로 리팩터링할 수 있습니다: + + ```dart + double useFadeIn() { + final animationController = useAnimationController( + duration: const Duration(seconds: 2), + ); + useEffect(() { + animationController.forward(); + return null; + }, const []); + useAnimation(animationController); + return animationController.value; + } + ``` + + 그런 다음 위젯이 [HookWidget]이라면 위젯 내에서 이 함수를 사용할 수 있습니다: + + ```dart + class FadeIn extends HookWidget { + const FadeIn({Key? key, required this.child}) : super(key: key); + + final Widget child; + + @override + Widget build(BuildContext context) { + final fade = useFadeIn(); + + return Opacity(opacity: fade, child: child); + } + } + ``` + + `useFadeIn` 함수가 `FadeIn` 위젯과 완전히 독립적이라는 점에 주목하세요. + 원한다면 완전히 다른 위젯에서 `useFadeIn` 함수를 사용할 수 있고, 여전히 동작할 것입니다! + +## 훅(Hooks) 규칙 + +훅(Hooks)은 고유한 제약 조건이 있습니다: + +- [HookWidget]을 확장(extends)하는 위젯의 `build` 메서드 내에서만 사용할 수 있습니다: + + **Good**: + + ```dart + class Example extends HookWidget { + @override + Widget build(BuildContext context) { + final controller = useAnimationController(); + ... + } + } + ``` + + **Bad**: + + ```dart + // Not a HookWidget + class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + final controller = useAnimationController(); + ... + } + } + ``` + + **Bad**: + + ```dart + class Example extends HookWidget { + @override + Widget build(BuildContext context) { + return ElevatedButton( + onPressed: () { + // _실제로_ 'build' 메서드 내부가 아니라 사용자 상호작용 라이프사이클 내부 (여기서는 'onPressed'). + final controller = useAnimationController(); + }, + child: Text('click me'), + ); + } + } + ``` + +- 조건부 또는 루프 안에서 사용할 수 없습니다. + + **Bad**: + + ```dart + class Example extends HookWidget { + const Example({required this.condition, super.key}); + final bool condition; + @override + Widget build(BuildContext context) { + if (condition) { + // 훅(Hooks)은 "if"/"for", ... 안에서 사용할 수 없습니다. + final controller = useAnimationController(); + } + ... + } + } + ``` + +훅(Hook)에 대한 자세한 내용은 [flutter_hooks]를 참조하세요. + +## 훅(Hooks)과 Riverpod + +### 설치 +훅(Hook)은 Riverpod과는 별개이므로 별도로 훅(Hook)를 설치해야 합니다. +훅(Hook)를 사용하려면 [hooks_riverpod]를 설치하는 것만으로는 충분하지 않습니다. +여전히 종속성에 [flutter_hooks]를 추가해야 합니다. +자세한 내용은 를 참조하세요. + +### 사용법 + +경우에 따라서는 훅(Hook)과 Riverpod을 모두 사용하는 위젯을 작성하고 싶을 수도 있습니다. +하지만 이미 알고 계실 수도 있겠지만, 훅(Hook)과 Riverpod 모두 +고유한 사용자 정의 위젯 기본유형을 제공합니다.: [HookWidget] 및 [ConsumerWidget] +하지만 클래스는 한 번에 하나의 수퍼클래스만 확장(extend)할 수 있습니다. + +이 문제를 해결하기 위해 [hooks_riverpod] 패키지를 사용할 수 있습니다. +이 패키지는 [HookWidget]과 [ConsumerWidget]을 단일 유형으로 결합하는 [HookConsumerWidget] 클래스를 제공합니다. +따라서 [HookWidget] 대신 [HookConsumerWidget]을 서브클래싱할 수 있습니다: + + + +또는, 두 패키지 모두에서 제공하는 "Builder"를 사용할 수도 있습니다. +예를 들어, `StatelessWidget`을 계속 사용하고 `HookBuilder`와 `Consumer`를 모두 사용할 수 있습니다. + + + +:::note +이 접근 방식은 [hooks_riverpod]를 사용하지 않고도 작동합니다. [flutter_riverpod] 만 만 필요합니다. +::: + +이 접근 방식이 마음에 들면, 두 빌더를 하나로 결합한 [HookConsumer]를 제공하여 간소화할 수 있습니다: + + + +[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html +[hookconsumer]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/HookConsumer-class.html +[hookconsumerwidget]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/HookConsumerWidget-class.html +[consumerwidget]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ConsumerWidget-class.html +[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html +[riverpod]: https://github.com/rrousselgit/riverpod +[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod +[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod +[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart new file mode 100644 index 000000000..05ad693de --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart @@ -0,0 +1,28 @@ +// ignore_for_file: use_key_in_widget_constructors, unused_local_variable + +import 'package:flutter/widgets.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../providers/creating_a_provider/codegen.dart'; + +class MyValue {} + +/* SNIPPET START */ + +class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + // 두 패키지 모두에서 제공하는 빌더를 사용할 수 있습니다. + return Consumer( + builder: (context, ref, child) { + return HookBuilder(builder: (context) { + final counter = useState(0); + final value = ref.watch(myProvider); + + return Text('Hello $counter $value'); + },); + }, + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart new file mode 100644 index 000000000..5d23c0d0a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart @@ -0,0 +1,26 @@ +// ignore_for_file: use_key_in_widget_constructors, unused_local_variable + +import 'package:flutter/widgets.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../providers/creating_a_provider/codegen.dart'; + +class MyValue {} + +/* SNIPPET START */ + +class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + // Consumer와 HookBuilder 모두 사용하는 것과 동일합니다. + return HookConsumer( + builder: (context, ref, child) { + final counter = useState(0); + final value = ref.watch(myProvider); + + return Text('Hello $counter $value'); + }, + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart new file mode 100644 index 000000000..9d857d887 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart @@ -0,0 +1,23 @@ +// ignore_for_file: use_key_in_widget_constructors, unused_local_variable + +import 'package:flutter/widgets.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../providers/creating_a_provider/codegen.dart'; + +class MyValue {} + +/* SNIPPET START */ + +// HookWidget 대신 HookConsumerWidget을 확장합니다. +class Example extends HookConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 여기서는 hooks과 providers를 모두 사용할 수 있습니다. + final counter = useState(0); + final value = ref.watch(myProvider); + + return Text('Hello $counter $value'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart new file mode 100644 index 000000000..a006cf77d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart @@ -0,0 +1,59 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import 'package:shared_preferences/shared_preferences.dart'; + +class LoadingScreen extends StatelessWidget { + const LoadingScreen({super.key}); + + @override + Widget build(BuildContext context) { + return const CircularProgressIndicator(); + } +} + +/* SNIPPET START */ +// We'd like to obtain an instance of shared preferences synchronously in a provider +final countProvider = StateProvider((ref) { + final preferences = ref.watch(sharedPreferencesProvider); + final currentValue = preferences.getInt('count') ?? 0; + ref.listenSelf((prev, curr) { + preferences.setInt('count', curr); + }); + return currentValue; +}); + +// We don't have an actual instance of SharedPreferences, and we can't get one except asynchronously +final sharedPreferencesProvider = + Provider((ref) => throw UnimplementedError()); + +Future main() async { + // Show a loading indicator before running the full app (optional) + // The platform's loading screen will be used while awaiting if you omit this. + runApp(const ProviderScope(child: LoadingScreen())); + + // Get the instance of shared preferences + final prefs = await SharedPreferences.getInstance(); + return runApp( + ProviderScope( + overrides: [ + // Override the unimplemented provider with the value gotten from the plugin + sharedPreferencesProvider.overrideWithValue(prefs), + ], + child: const MyApp(), + ), + ); +} + +class MyApp extends ConsumerWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // Use the provider without dealing with async issues + final count = ref.watch(countProvider); + return Text('$count'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart new file mode 100644 index 000000000..81c0b9013 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart @@ -0,0 +1,31 @@ +// ignore_for_file: avoid_manual_providers_as_generated_provider_dependency +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'models.dart'; + +part 'codegen.g.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +// The current search filter +final searchProvider = StateProvider((ref) => ''); + +@riverpod +Stream configs(ConfigsRef ref) { + return Stream.value(Configuration()); +} + +@riverpod +Future> characters(CharactersRef ref) async { + final search = ref.watch(searchProvider); + final configs = await ref.watch(configsProvider.future); + final response = await dio.get>>( + '${configs.host}/characters?search=$search', + ); + + return response.data!.map(Character.fromJson).toList(); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart new file mode 100644 index 000000000..b96eb1df7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -0,0 +1,123 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ConfigsRef = Ref>; + +@ProviderFor(configs) +const configsProvider = ConfigsProvider._(); + +final class ConfigsProvider extends $FunctionalProvider< + AsyncValue, Stream, ConfigsRef> + with + $FutureModifier, + $StreamProvider { + const ConfigsProvider._( + {Stream Function( + ConfigsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'configsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ConfigsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$configsHash(); + + @$internal + @override + $StreamProviderElement $createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ConfigsProvider $copyWithCreate( + Stream Function( + ConfigsRef ref, + ) create, + ) { + return ConfigsProvider._(create: create); + } + + @override + Stream create(ConfigsRef ref) { + final _$cb = _createCb ?? configs; + return _$cb(ref); + } +} + +String _$configsHash() => r'166cbe95e6b49ed7bc78c96041fb14abddbf6911'; + +typedef CharactersRef = Ref>>; + +@ProviderFor(characters) +const charactersProvider = CharactersProvider._(); + +final class CharactersProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, CharactersRef> + with + $FutureModifier>, + $FutureProvider, CharactersRef> { + const CharactersProvider._( + {FutureOr> Function( + CharactersRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'charactersProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + CharactersRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$charactersHash(); + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + CharactersProvider $copyWithCreate( + FutureOr> Function( + CharactersRef ref, + ) create, + ) { + return CharactersProvider._(create: create); + } + + @override + FutureOr> create(CharactersRef ref) { + final _$cb = _createCb ?? characters; + return _$cb(ref); + } +} + +String _$charactersHash() => r'b1e8e15bbeab60d92fe959d9e1dd4ceba6a31446'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart new file mode 100644 index 000000000..e21e1d7c6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart @@ -0,0 +1,17 @@ + +class Character { + Character(); + + // ignore: avoid_unused_constructor_parameters + factory Character.fromJson(Map json) { + return Character(); + } +} + +class Configuration { + Configuration({ + this.host = '', + }); + + final String host; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart new file mode 100644 index 000000000..57c054dcd --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart @@ -0,0 +1,26 @@ +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +import 'models.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +// The current search filter +final searchProvider = StateProvider((ref) => ''); + +/// Configurations which can change over time +final configsProvider = StreamProvider( + (ref) => Stream.value(Configuration()), +); + +final charactersProvider = FutureProvider>((ref) async { + final search = ref.watch(searchProvider); + final configs = await ref.watch(configsProvider.future); + final response = await dio.get>>( + '${configs.host}/characters?search=$search',); + + return response.data!.map(Character.fromJson).toList(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart new file mode 100644 index 000000000..8b8f234b9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart @@ -0,0 +1,7 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +String city(CityRef ref) => 'London'; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart new file mode 100644 index 000000000..f7b66e8c3 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -0,0 +1,72 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CityRef = Ref; + +@ProviderFor(city) +const cityProvider = CityProvider._(); + +final class CityProvider extends $FunctionalProvider + with $Provider { + const CityProvider._( + {String Function( + CityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'cityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + CityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$cityHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CityProvider $copyWithCreate( + String Function( + CityRef ref, + ) create, + ) { + return CityProvider._(create: create); + } + + @override + String create(CityRef ref) { + final _$cb = _createCb ?? city; + return _$cb(ref); + } +} + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart new file mode 100644 index 000000000..d8093431c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart @@ -0,0 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final cityProvider = Provider((ref) => 'London'); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart new file mode 100644 index 000000000..3049dd743 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart @@ -0,0 +1,33 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../todo_list_provider/codegen.dart'; + +part 'codegen.g.dart'; + +enum Filter { + none, + completed, + uncompleted, +} + +@riverpod +Filter filter(FilterRef ref) { + return Filter.none; +} + +/* SNIPPET START */ + +@riverpod +List filteredTodoList(FilteredTodoListRef ref) { + final filter = ref.watch(filterProvider); + final todos = ref.watch(todoListProvider); + + switch (filter) { + case Filter.none: + return todos; + case Filter.completed: + return todos.where((todo) => todo.completed).toList(); + case Filter.uncompleted: + return todos.where((todo) => !todo.completed).toList(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart new file mode 100644 index 000000000..0576b684f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -0,0 +1,133 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef FilterRef = Ref; + +@ProviderFor(filter) +const filterProvider = FilterProvider._(); + +final class FilterProvider + extends $FunctionalProvider + with $Provider { + const FilterProvider._( + {Filter Function( + FilterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Filter Function( + FilterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Filter value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilterProvider $copyWithCreate( + Filter Function( + FilterRef ref, + ) create, + ) { + return FilterProvider._(create: create); + } + + @override + Filter create(FilterRef ref) { + final _$cb = _createCb ?? filter; + return _$cb(ref); + } +} + +String _$filterHash() => r'e75d75b728d7ce923734d925b42b3353eac446be'; + +typedef FilteredTodoListRef = Ref>; + +@ProviderFor(filteredTodoList) +const filteredTodoListProvider = FilteredTodoListProvider._(); + +final class FilteredTodoListProvider + extends $FunctionalProvider, List, FilteredTodoListRef> + with $Provider, FilteredTodoListRef> { + const FilteredTodoListProvider._( + {List Function( + FilteredTodoListRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filteredTodoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + FilteredTodoListRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filteredTodoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilteredTodoListProvider $copyWithCreate( + List Function( + FilteredTodoListRef ref, + ) create, + ) { + return FilteredTodoListProvider._(create: create); + } + + @override + List create(FilteredTodoListRef ref) { + final _$cb = _createCb ?? filteredTodoList; + return _$cb(ref); + } +} + +String _$filteredTodoListHash() => r'1c35eb0fce8fc7c7cda86413b02f606f8c8ae2b4'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart new file mode 100644 index 000000000..2c3d79b71 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart @@ -0,0 +1,27 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import '../todo_list_provider/raw.dart'; + +enum Filter { + none, + completed, + uncompleted, +} + +final filterProvider = StateProvider((ref) => Filter.none); + +/* SNIPPET START */ + +final filteredTodoListProvider = Provider>((ref) { + final filter = ref.watch(filterProvider); + final todos = ref.watch(todoListProvider); + + switch (filter) { + case Filter.none: + return todos; + case Filter.completed: + return todos.where((todo) => todo.completed).toList(); + case Filter.uncompleted: + return todos.where((todo) => !todo.completed).toList(); + } +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart new file mode 100644 index 000000000..b1cb3dbe3 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart @@ -0,0 +1,17 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +MyValue another(AnotherRef ref) => MyValue(); + +class MyValue {} + +/* SNIPPET START */ + +@riverpod +MyValue my(MyRef ref) { + // Bad practice to call `read` here + final value = ref.read(anotherProvider); + return value; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart new file mode 100644 index 000000000..124d73ed8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -0,0 +1,132 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef AnotherRef = Ref; + +@ProviderFor(another) +const anotherProvider = AnotherProvider._(); + +final class AnotherProvider + extends $FunctionalProvider + with $Provider { + const AnotherProvider._( + {MyValue Function( + AnotherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'anotherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyValue Function( + AnotherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$anotherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + AnotherProvider $copyWithCreate( + MyValue Function( + AnotherRef ref, + ) create, + ) { + return AnotherProvider._(create: create); + } + + @override + MyValue create(AnotherRef ref) { + final _$cb = _createCb ?? another; + return _$cb(ref); + } +} + +String _$anotherHash() => r'bb412edc55657c14eace37792cd18e5254604a36'; + +typedef MyRef = Ref; + +@ProviderFor(my) +const myProvider = MyProvider._(); + +final class MyProvider extends $FunctionalProvider + with $Provider { + const MyProvider._( + {MyValue Function( + MyRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyValue Function( + MyRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$myHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + MyProvider $copyWithCreate( + MyValue Function( + MyRef ref, + ) create, + ) { + return MyProvider._(create: create); + } + + @override + MyValue create(MyRef ref) { + final _$cb = _createCb ?? my; + return _$cb(ref); + } +} + +String _$myHash() => r'2712c772be4dbaabd4c99fd803f927a7e9938b21'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart new file mode 100644 index 000000000..76bae4653 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart @@ -0,0 +1,13 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +final anotherProvider = Provider((ref) => MyValue()); + +class MyValue {} + +/* SNIPPET START */ + +final myProvider = Provider((ref) { + // Bad practice to call `read` here + final value = ref.read(anotherProvider); + return value; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart new file mode 100644 index 000000000..e44e202bc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart @@ -0,0 +1,25 @@ + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'models.dart'; + +part 'codegen.g.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +@riverpod +Stream config(ConfigRef ref) => Stream.value(Configuration()); + +@riverpod +Future> products(ProductsRef ref) async { + // Listens only to the host. If something else in the configurations + // changes, this will not pointlessly re-evaluate our provider. + final host = await ref.watch(configProvider.selectAsync((config) => config.host)); + + final result = await dio.get>>('$host/products'); + + return result.data!.map(Product.fromJson).toList(); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart new file mode 100644 index 000000000..83a4d5829 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -0,0 +1,123 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ConfigRef = Ref>; + +@ProviderFor(config) +const configProvider = ConfigProvider._(); + +final class ConfigProvider extends $FunctionalProvider< + AsyncValue, Stream, ConfigRef> + with + $FutureModifier, + $StreamProvider { + const ConfigProvider._( + {Stream Function( + ConfigRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'configProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ConfigRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$configHash(); + + @$internal + @override + $StreamProviderElement $createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ConfigProvider $copyWithCreate( + Stream Function( + ConfigRef ref, + ) create, + ) { + return ConfigProvider._(create: create); + } + + @override + Stream create(ConfigRef ref) { + final _$cb = _createCb ?? config; + return _$cb(ref); + } +} + +String _$configHash() => r'3021d1a8aac384e99d5d22714ffe6e868954888b'; + +typedef ProductsRef = Ref>>; + +@ProviderFor(products) +const productsProvider = ProductsProvider._(); + +final class ProductsProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, ProductsRef> + with + $FutureModifier>, + $FutureProvider, ProductsRef> { + const ProductsProvider._( + {FutureOr> Function( + ProductsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'productsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + ProductsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$productsHash(); + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ProductsProvider $copyWithCreate( + FutureOr> Function( + ProductsRef ref, + ) create, + ) { + return ProductsProvider._(create: create); + } + + @override + FutureOr> create(ProductsRef ref) { + final _$cb = _createCb ?? products; + return _$cb(ref); + } +} + +String _$productsHash() => r'd1f4523880408cf8ee0e68969c40cf87d5c78557'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart new file mode 100644 index 000000000..3a711b4b6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart @@ -0,0 +1,21 @@ +// ignore_for_file: sort_constructors_first + +class Product { + const Product({this.title = ''}); + + final String title; + + factory Product.fromJson(Map map) { + return Product( + title: map['title'] as String, + ); + } +} + +class Configuration { + Configuration({ + this.host = '', + }); + + final String host; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart new file mode 100644 index 000000000..a5208e4e7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart @@ -0,0 +1,21 @@ +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'models.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +final configProvider = + StreamProvider((ref) => Stream.value(Configuration())); + +final productsProvider = FutureProvider>((ref) async { + // Listens only to the host. If something else in the configurations + // changes, this will not pointlessly re-evaluate our provider. + final host = + await ref.watch(configProvider.selectAsync((config) => config.host)); + final result = await dio.get>>('$host/products'); + + return result.data!.map(Product.fromJson).toList(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart new file mode 100644 index 000000000..a1942dbd4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart @@ -0,0 +1,24 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +@freezed +class Todo with _$Todo { + factory Todo({ + required String id, + required String description, + required bool completed, + }) = _Todo; +} + +/* SNIPPET START */ + +@riverpod +class TodoList extends _$TodoList { + @override + List build() { + return []; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart new file mode 100644 index 000000000..0b73d3548 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart @@ -0,0 +1,166 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$Todo { + String get id => throw _privateConstructorUsedError; + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc + +class _$TodoImpl implements _Todo { + _$TodoImpl( + {required this.id, required this.description, required this.completed}); + + @override + final String id; + @override + final String description; + @override + final bool completed; + + @override + String toString() { + return 'Todo(id: $id, description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.id, id) || other.id == id) && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @override + int get hashCode => Object.hash(runtimeType, id, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); +} + +abstract class _Todo implements Todo { + factory _Todo( + {required final String id, + required final String description, + required final bool completed}) = _$TodoImpl; + + @override + String get id; + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart new file mode 100644 index 000000000..767e99cc6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(TodoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider extends $NotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + List Function( + Ref>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todoListHash() => r'6c965beb867ffeee119133f0ae2e6ebeb68e6f7e'; + +abstract class _$TodoList extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart new file mode 100644 index 000000000..a341b7f5b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart @@ -0,0 +1,36 @@ +// ignore_for_file: public_member_api_docs, sort_constructors_first +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Todo { + const Todo({ + required this.id, + required this.description, + required this.completed, + }); + + // All properties should be `final` on our class. + final String id; + final String description; + final bool completed; + + // Since Todo is immutable, we implement a method that allows cloning the + // Todo with slightly different content. + Todo copyWith({String? id, String? description, bool? completed}) { + return Todo( + id: id ?? this.id, + description: description ?? this.description, + completed: completed ?? this.completed, + ); + } +} + +/* SNIPPET START */ + +class TodoList extends Notifier> { + @override + List build() { + return []; + } +} + +final todoListProvider = NotifierProvider>(TodoList.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart new file mode 100644 index 000000000..8f7af2644 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart @@ -0,0 +1,20 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +String city(CityRef ref) => 'London'; + +class Weather {} + +Future fetchWeather({required String city}) async => Weather(); +/* SNIPPET START */ +@riverpod +Future weather(WeatherRef ref) { + // We use `ref.watch` to listen to another provider, and we pass it the provider + // that we want to consume. Here: cityProvider + final city = ref.watch(cityProvider); + + // We can then use the result to do something based on the value of `cityProvider`. + return fetchWeather(city: city); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart new file mode 100644 index 000000000..e0cb3b238 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -0,0 +1,124 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CityRef = Ref; + +@ProviderFor(city) +const cityProvider = CityProvider._(); + +final class CityProvider extends $FunctionalProvider + with $Provider { + const CityProvider._( + {String Function( + CityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'cityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + CityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$cityHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CityProvider $copyWithCreate( + String Function( + CityRef ref, + ) create, + ) { + return CityProvider._(create: create); + } + + @override + String create(CityRef ref) { + final _$cb = _createCb ?? city; + return _$cb(ref); + } +} + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +typedef WeatherRef = Ref>; + +@ProviderFor(weather) +const weatherProvider = WeatherProvider._(); + +final class WeatherProvider extends $FunctionalProvider, + FutureOr, WeatherRef> + with $FutureModifier, $FutureProvider { + const WeatherProvider._( + {FutureOr Function( + WeatherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'weatherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + WeatherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$weatherHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + WeatherProvider $copyWithCreate( + FutureOr Function( + WeatherRef ref, + ) create, + ) { + return WeatherProvider._(create: create); + } + + @override + FutureOr create(WeatherRef ref) { + final _$cb = _createCb ?? weather; + return _$cb(ref); + } +} + +String _$weatherHash() => r'9a79d0269032630918eef9d3f562ff35b5860061'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart new file mode 100644 index 000000000..d25ec4ffc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart @@ -0,0 +1,18 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +final cityProvider = Provider((ref) => 'London'); + +class Weather {} + +Future fetchWeather({required String city}) async => Weather(); + +/* SNIPPET START */ + +final weatherProvider = FutureProvider((ref) async { + // We use `ref.watch` to listen to another provider, and we pass it the provider + // that we want to consume. Here: cityProvider + final city = ref.watch(cityProvider); + + // We can then use the result to do something based on the value of `cityProvider`. + return fetchWeather(city: city); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart new file mode 100644 index 000000000..1a90008ed --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart @@ -0,0 +1,24 @@ +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'models.dart'; + +part 'codegen.g.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +@riverpod +Stream config(ConfigRef ref) => Stream.value(Configuration()); + +@riverpod +Future> products(ProductsRef ref) async { + // Will cause productsProvider to re-fetch the products if anything in the + // configurations changes + final configs = await ref.watch(configProvider.future); + + final result = + await dio.get>>('${configs.host}/products'); + return result.data!.map(Product.fromJson).toList(); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart new file mode 100644 index 000000000..c21282853 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -0,0 +1,123 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ConfigRef = Ref>; + +@ProviderFor(config) +const configProvider = ConfigProvider._(); + +final class ConfigProvider extends $FunctionalProvider< + AsyncValue, Stream, ConfigRef> + with + $FutureModifier, + $StreamProvider { + const ConfigProvider._( + {Stream Function( + ConfigRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'configProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ConfigRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$configHash(); + + @$internal + @override + $StreamProviderElement $createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ConfigProvider $copyWithCreate( + Stream Function( + ConfigRef ref, + ) create, + ) { + return ConfigProvider._(create: create); + } + + @override + Stream create(ConfigRef ref) { + final _$cb = _createCb ?? config; + return _$cb(ref); + } +} + +String _$configHash() => r'3021d1a8aac384e99d5d22714ffe6e868954888b'; + +typedef ProductsRef = Ref>>; + +@ProviderFor(products) +const productsProvider = ProductsProvider._(); + +final class ProductsProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, ProductsRef> + with + $FutureModifier>, + $FutureProvider, ProductsRef> { + const ProductsProvider._( + {FutureOr> Function( + ProductsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'productsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + ProductsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$productsHash(); + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ProductsProvider $copyWithCreate( + FutureOr> Function( + ProductsRef ref, + ) create, + ) { + return ProductsProvider._(create: create); + } + + @override + FutureOr> create(ProductsRef ref) { + final _$cb = _createCb ?? products; + return _$cb(ref); + } +} + +String _$productsHash() => r'637254615fa398af0d36e212f09e5d3d8ff866aa'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart new file mode 100644 index 000000000..8009c2fd8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart @@ -0,0 +1,16 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +class Product { + Product(); + factory Product.fromJson(Map json) { + return Product(); + } +} + +class Configuration { + Configuration({ + this.host = '', + }); + + final String host; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart new file mode 100644 index 000000000..be2be903c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart @@ -0,0 +1,20 @@ +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'models.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +final configProvider = + StreamProvider((ref) => Stream.value(Configuration())); + +final productsProvider = FutureProvider>((ref) async { + // Will cause productsProvider to re-fetch the products if anything in the + // configurations changes + final configs = await ref.watch(configProvider.future); + + final result = await dio.get>>('${configs.host}/products'); + return result.data!.map(Product.fromJson).toList(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index 3f9be80e9..aac608d78 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -1,65 +1,73 @@ --- -title: 프로바이더 결합하기 +title: Combining Provider States --- -들어가기 앞서 먼저 [프로바이더란](/docs/concepts/providers)문서를 먼저 읽어주세요. -이 가이드는 복수의 프로바이더들(providers) 결합하는 방법에 대해서 알아볼 예정입니다. +import charactersProvider from "./combining_provider_states/characters_provider"; +import cityProvider from "./combining_provider_states/city_provider"; +import filteredTodoListProvider from "./combining_provider_states/filtered_todo_list_provider"; +import readInProvider from "./combining_provider_states/read_in_provider"; +import selectAsyncProvider from "./combining_provider_states/select_async_provider"; +import todoListProvider from "./combining_provider_states/todo_list_provider"; +import weatherProvider from "./combining_provider_states/weather_provider"; +import wholeObjectProvider from "./combining_provider_states/whole_object_provider"; +import { Link } from "../../../../../src/components/Link"; +import { + trimSnippet, + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -## 프로바이더 결합하기 +Make sure to read first. +In this guide, we will learn about combining provider states. -이전에 간단한 프로바이더를 생성하는 방법을 알아보았습니다. 그런데 현실에서는 -수많은 상황 중에서 하나의 프로바이더가 다른 프로바이더의 상태를 읽어 사용하는 경우가 많이 있습니다. +## Combining provider states -여러 프로바이더를 결합하기 위해서 [ref] 객체를 사용하여 콜백을 전달하거나 [watch] 메소드를 사용할 수 있습니다. +We've previously seen how to create a simple provider. But the reality is, +in many situations a provider will want to read the state of another provider. -예를 들어, 아래와 같은 프로바이더가 있다고 고려해 보겠습니다. +To do that, we can use the [ref] object passed to the callback of our provider, +and use its [watch] method. -```dart -final cityProvider = Provider((ref) => 'London'); -``` +As an example, consider the following provider: -이제 `cityProvider`를 사용하고 싶은 다른 프로바이더를 만들어 보려고 합니다. + -```dart -final weatherProvider = FutureProvider((ref) async { - // `ref.watch`를 사용해 다른 프로바이더를 읽어올 수 있습니다. - // 그리고 프로바이더를 넘겨줄 수 있습니다. (여기서는 cityProvider가 되겠습니다.) - final city = ref.watch(cityProvider); +We can now create another provider that will consume our `cityProvider`: - // `cityProvider` 값을 기반으로한 무언가의 결과를 반환할 수 있습니다. - return fetchWeather(city: city); -}); -``` + -이상입니다. 여기서 우리는 다른 프로바이더에 의존하는 한개의 프로바이더를 만드는 방법을 알아보았습니다. +That's it. We've created a provider that depends on another provider. ## FAQ -### 구독중인 값이 시간이 지남에 따라 변경되면 어떻게 되나요? +### What if the value being listened to changes over time? -관찰하거나 구독하고 있는 프로바이더에 의존하여 값이 매번 갱신이 될때 마다 새로운 상태값을 -얻게 됩니다. 예를 들어, [StateNotifierProvider]를 구독하고 있거나 [ProviderContainer.refresh]/[ref.refresh] -에 의해 강제적으로 갱신이 되었다면 물론 구독중인 상태값은 갱신되어 전달될 것입니다. +Depending on the provider that you are listening to, the value obtained may +change over time. +For example, you may be listening to a [NotifierProvider], or the provider +being listened to may have been forced to refresh through the use of +[ProviderContainer.refresh]/[ref.refresh]. -[watch]를 사용할 때, Riverpod은 상태값의 변화를 검출하고 _자동적_ 으로 프로바이더를 필요할 때 재 실행합니다. +When using [watch], Riverpod is able to detect that the value being listened to changed +and will _automatically_ re-execute the provider's creation callback when needed. -이것은 상태들을 계산하기 유용할 수 있습니다. -예를 들어 [StateNotifierProvider]가 할일 목록(a todo-list)의 값을 가진다고 생각해 봅시다. - -```dart -class TodoList extends StateNotifier> { - TodoList(): super(const []); -} - -final todoListProvider = StateNotifierProvider((ref) => TodoList()); -``` +This can be useful for computed states. +For example, consider a that exposes a todo-list: + -일반적인 사용방법으로 완료된/완료되지 않은 할일만 표시하도록 UI가 할일 목록을 필터링하도록 하는 것입니다. +A common use-case would be to have the UI filter the list of todos to show +only the completed/uncompleted todos. -이러한 시나리오를 구현하는 쉬운 방법은 다음과 같습니다. +An easy way to implement such a scenario would be to: -- [StateProvider]를 생성합니다. `filterProvider`는 현재 어떤 필터를 선택하고 있는지에 대한 상태 값을 가집니다. +- create a [StateProvider], which exposes the currently selected filter method: ```dart enum Filter { @@ -71,88 +79,58 @@ final todoListProvider = StateNotifierProvider((ref) => TodoList()); final filterProvider = StateProvider((ref) => Filter.none); ``` -- 필터 메소드(`filterProvider`)와 할일 목록(`todoListProvider`)을 결합하여 필터링된 할일 목록 값을 제공하는 별도의 프로바이더(`filteredTodoListProvider`)를 만듭니다. +- make a separate provider which combines the filter method and the todo-list + to expose the filtered todo-list: - ```dart - final filteredTodoListProvider = Provider>((ref) { - final filter = ref.watch(filterProvider); - final todos = ref.watch(todoListProvider); - - switch (filter) { - case Filter.none: - return todos; - case Filter.completed: - return todos.where((todo) => todo.completed).toList(); - case Filter.uncompleted: - return todos.where((todo) => !todo.completed).toList(); - } - }); - ``` + -그리고, UI에서 `filteredTodoListProvider`를 구독하여 필터링된 할일 목록을 받아 올 수 있습니다. -필터와 할일 목록이 각각 갱신(변경)될때 마다 자동적으로 UI 업데이트가 이루어 집니다. +Then, our UI can listen to `filteredTodoListProvider` to listen to the filtered todo-list. +Using such an approach, the UI will automatically update when either the filter +or the todo-list changes. -이러한 방법으로 접근한 애플리케이션 샘플은 [Todo List -example](https://github.com/rrousselGit/riverpod/tree/master/examples/todos)에서 확인해 볼 수 있습니다. +To see this approach in action, you can look at the source code of the [Todo List +example](https://github.com/rrousselGit/riverpod/tree/master/examples/todos). :::info -이 행위는 [Provider]에 국한되지 않습니다. 그리고 모든 프로바이더에 적용하여 사용 가능합니다. - -예를 들어, 실시간적으로 값이 변하는 것을 지원하는 검색 기능을 구현하기 위해 [FutureProvider]와 함께 [watch]를 결합하여 사용할 수 있습니다. +This behavior is not specific to [Provider], and works with all providers. For example, you could combine [watch] with [FutureProvider] to implement a search feature that supports live-configuration changes: -```dart -// 현재 검색 필터 값 입니다. ('') -final searchProvider = StateProvider((ref) => ''); - -/// 매 시간마다 변경될 수 있는 구성(Configurations) -final configsProvider = StreamProvider(...); - -final charactersProvider = FutureProvider>((ref) async { - final search = ref.watch(searchProvider); - final configs = await ref.watch(configsProvider.future); - final response = await dio.get('${configs.host}/characters?search=$search'); - - return response.data.map((json) => Character.fromJson(json)).toList(); -}); -``` - -이 코드는 `characters` 목록을 서비스로 부터 가져옵니다. 그리고 구성(configurations)이 변하거나 검색 쿼리가 변경되면 -자동적으로 다시 `characters` 목록을 가져옵니다. + +This code will fetch a list of characters from the service, and automatically +re-fetch the list whenever the configurations change or when the search query changes. ::: -### 구독없이 프로바이더를 읽을 수 있나요? +### Can I read a provider without listening to it? -때때로 우린 값이 변경되어도 다시 생성되는 작업 없이 프로바이더의 컨텐츠를 읽기 원합니다. Sometimes, we want to read the content of a provider, but without re-creating the value exposed when the value obtained changes. -예를 들어 인증을 위한 사용자 토큰을 다른 프로바이더로 부터 읽어오는 `Repository` 프로바이더가 있다고 생각해 봅시다. -여기서 우리는 [watch]를 사용하고 사용자 토큰이 변경될 때마다 새로운 `Repository`를 생성할 수 있지만 그렇게 하는 것은 거의 소용이 없습니다. +An example would be a `Repository`, which reads from another provider the user token +for authentication. +We could use [watch] and create a new `Repository` whenever the user token changes, +but there is little to no use in doing that. -이 경우에는, [watch]와 유사한 기능을 가지는 [read]를 사용할 수 있습니다. -그러나, 상태 값이 변경될 때 프로바이더가 노출하는 값을 다시 생성하지 않습니다. - -이 경우 일반적으로 생성된 객체에 'ref.read'를 전달합니다. -생성된 객체는 원할 때마다 프로바이더를 읽을 수 있습니다. +In this situation, we can use [read], which is similar to [watch], but will not +cause the provider to recreate the value it exposes when the value obtained changes. +In that case, a common practice is to pass the provider's `Ref` to the object created. +The object created will then be able to read providers whenever it wants. ```dart final userTokenProvider = StateProvider((ref) => null); -final repositoryProvider = Provider((ref) => Repository(ref.read)); +final repositoryProvider = Provider(Repository.new); class Repository { - Repository(this.read); + Repository(this.ref); - /// `ref.read` 함수입니다. - final Reader read; + final Ref ref; Future fetchCatalog() async { - String token = read(userTokenProvider); + String token = ref.read(userTokenProvider); final response = await dio.get('/path', queryParameters: { 'token': token, @@ -163,9 +141,21 @@ class Repository { } ``` -:::note +:::danger **DON'T** call [read] inside the body of a provider + + + +If you used [read] as an attempt to avoid unwanted rebuilds of your object, +refer to [My provider updates too often, what can I do?](#my-provider-updates-too-often-what-can-i-do) +::: -`ref.read`대신에 `ref` 를 객체에 전달해서 사용하도록 합니다. +### How to test an object that receives [ref] as a parameter of its constructor? + +If you are using the pattern described in [Can I read a provider without listening to it?](#can-i-read-a-provider-without-listening-to-it), +you may be wondering how to write tests for your object. + +In this scenario, consider testing the provider directly instead of the raw object. +You can do so by using the [ProviderContainer] class: ```dart final repositoryProvider = Provider((ref) => Repository(ref)); @@ -221,57 +211,38 @@ test('fetches catalog', () async { }); ``` -### 프로바이더 갱신이 너무 자주일어나는데 어떻게 개선하면 좋을까요? +### My provider updates too often, what can I do? +If your object is re-created too often your provider is likely listening +to objects that it doesn't care about. -객체가 너무 자주 다시 생성되는 경우 프로바이더가 갱신에 무관계한 요소를 수신하고 있는 것입니다. +For example, you may be listening to a `Configuration` object, but only use the `host` +property. +By listening to the entire `Configuration` object, if a property other than `host` +changes, this still causes your provider to be re-evaluated – which may be +undesired. -에들 들어, `Configuration` 객체 뿐만 아니라 `host` 속성을 구독하고 있다고 있다고 가정해 봅시다. -`host`의 속성만 변경되었지만 본래 필요없는 값까지 모두 재평가(계산)하여 전반적인 프로바이더의 갱신을 가져올 것 입니다. +The solution to this problem is to create a separate provider that exposes _only_ +what you need in `Configuration` (so `host`): -해결 방법으로는 분리된 프로바이더를 만드는 것입니다. 즉, 프로바이더를 속성별로 분리하는 것입니다. -다시 말해, `Configuration`(즉 `host`)에서 필요한 것만 노출하는 별도의 프로바이더를 만드는 것입니다. +**AVOID** listening to the entire object: + -**AVOID** 객체 전반적인 관찰: +**PREFER** using select when you only need a single property of an object: -```dart -final configsProvider = StreamProvider(...); + -final productsProvider = FutureProvider>((ref) async { - // 어떤 구성이 변경되었다고 한다면 productsProvider는 products를 다시 가져옵니다. - final configs = await ref.watch(configsProvider.future); - - return dio.get('${configs.host}/products'); -}); -``` - -**PREFER** 실제 사용하는 속성만 관찰: - -```dart -final configsProvider = StreamProvider(...); - -/// 현재 host값만 노출하는 프로바이더 -final _hostProvider = FutureProvider((ref) async { - final config = await ref.watch(configsProvider.future); - return config.host; -}); - -final productsProvider = FutureProvider>((ref) async { - /// 호스트(the host)만 구독. - /// 만약 구성들의 변화가 발생한다면, 무의미하게 재평가하지 않습니다. - final host = await ref.watch(_hostProvider.future); - - return dio.get('$host/products'); -}); -``` +This will only rebuild the `productsProvider` when the `host` changes. [provider]: ../providers/provider [stateprovider]: ../providers/state_provider [futureprovider]: ../providers/future_provider [statenotifierprovider]: ../providers/state_notifier_provider +[notifierProvider]: ../providers/notifier_provider [ref]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref-class.html [watch]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/watch.html [read]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/read.html [providercontainer.refresh]: https://pub.dev/documentation/riverpod/latest/riverpod/ProviderContainer/refresh.html [ref.refresh]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/WidgetRef/refresh.html +[providercontainer]: https://pub.dev/documentation/riverpod/latest/riverpod/ProviderContainer-class.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart new file mode 100644 index 000000000..7ecdfa8f1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart @@ -0,0 +1,59 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ + +// Have a counter that is being incremented by the FloatingActionButton +final counterProvider = StateProvider((ref) => 0); + +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // We want to show a dialog with the count on a button press + return Scaffold( + body: Column( + children: [ + ElevatedButton( + onPressed: () { + showDialog( + context: context, + builder: (c) { + // We wrap the dialog with a ProviderScope widget, providing the + // parent container to ensure the dialog can access the same providers + // that are accessible by the Home widget. + return ProviderScope( + parent: ProviderScope.containerOf(context), + child: const AlertDialog( + content: CounterDisplay(), + ), + ); + }, + ); + }, + child: const Text('Show Dialog'), + ), + ], + ), + floatingActionButton: FloatingActionButton( + child: const Icon(Icons.add), + onPressed: () { + ref.read(counterProvider.notifier).state++; + }, + ),); + } +} + +class CounterDisplay extends ConsumerWidget { + const CounterDisplay({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final count = ref.watch(counterProvider); + return Text('$count'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.dart new file mode 100644 index 000000000..b881d7bf9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.dart @@ -0,0 +1,20 @@ +// ignore_for_file: unnecessary_lambdas + +import 'dart:async'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Stream example(ExampleRef ref) { + final streamController = StreamController(); + + ref.onDispose(() { + // Closes the StreamController when the state of this provider is destroyed. + streamController.close(); + }); + + return streamController.stream; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart new file mode 100644 index 000000000..19c4e564b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/codegen.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider, Stream, ExampleRef> + with $FutureModifier, $StreamProvider { + const ExampleProvider._( + {Stream Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $StreamProviderElement $createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + Stream Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + Stream create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'e2c4eb8a7cf06c7a0e5d07ee2bd51db254033fa6'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/raw.dart new file mode 100644 index 000000000..a9b5741d8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/lifecycle_on_dispose/raw.dart @@ -0,0 +1,17 @@ +// ignore_for_file: unnecessary_lambdas + +import 'dart:async'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +final example = StreamProvider.autoDispose((ref) { + final streamController = StreamController(); + + ref.onDispose(() { + // Closes the StreamController when the state of this provider is destroyed. + streamController.close(); + }); + + return streamController.stream; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx index 0eb1a7f8e..eaece8112 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx @@ -2,24 +2,27 @@ title: .autoDispose --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -통상적으로 프로바이더를 사용할때, 프로바이더를 더이상 사용하지 않는다면 -시스템 메모리상에서 해제(destroy)하고 싶은 경우가 있습니다. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -destroy하고 싶은 경우는 다양한 이유가 있지만 아래의 경우를 생각해볼 수 있습니다. +A common use case is to destroy the state of a provider +when it is no-longer used. -- 파이어베이스(Firebase)를 사용할떄 불필요한 코스트 발생을 피하기 위해 연결을 끊는 경우 -- 사용자가 화면상에서 떠나고 재진입했을때 상태를 초기화 해줘야 하는 경우 +There are multiple reasons for doing so, such as: -위의 경우등을 대응할 수 있도록 프로바이더는 빌트인으로 `.autoDispose` 수식어를 지원합니다. +- When using Firebase, to close the connection and avoid unnecessary cost. +- To reset the state when the user leaves a screen and re-enters it. -## 사용방법 +Providers come with built-in support for this use case, through the `.autoDispose` +modifier. -Riverpod에 더이상 사용하지 않는 프로바이더의 상태를 소멸(destroy)하기위해 -`.autoDispose` 수식어를 프로바이더에 붙이기만 하면 됩니다. +## Usage +To tell Riverpod to destroy the state of a provider when it is no longer used, +simply append `.autoDispose` to your provider: ```dart final userProvider = StreamProvider.autoDispose((ref) { @@ -27,14 +30,14 @@ final userProvider = StreamProvider.autoDispose((ref) { }); ``` -이것으로 `userProvider`가 더 이상 사용되지 않을때 자동으로 해제 작업을 처리합니다. +That's it. Now, the state of `userProvider` will automatically be destroyed +when it is no longer used. -제네릭 파라미터가 `autoDispose`전에 붙는게 아닌 `autoDispose`뒤에 붙는 것으로 -알 수 있듯이 `autoDispose`는 a named constructor가 아닙니다. +Note how the generic parameters are passed after `autoDispose` instead of before – +`autoDispose` is not a named constructor. :::note -`.autoDispose`와 다른 수식어를 결합할 수 있습니다. - +You can combine `.autoDispose` with other modifiers if you need to: ```dart final userProvider = StreamProvider.autoDispose.family((ref, id) { @@ -46,12 +49,13 @@ final userProvider = StreamProvider.autoDispose.family((ref, id) { ### ref.keepAlive -프로바이더에 `autoDispose` 수식어를 붙이면 `ref`객체에 `keepAlive` 메소드를 사용할 수 있습니다. +Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. -`keepAlive` 메소드를 실행하는 것으로, 프로바이더가 참조되지 않게 되었을 때에도 -상태를 유지하도록 Riverpod 에 전할 수가 있습니다. +The `keepAlive` function is used to tell Riverpod that the state of the provider +should be preserved even if no longer listened to. -좀 더 이해를 돕기위해서 HTTP 요청이 완료되면 플레그를 `true`로 설정하는 예시 코드입니다. +A use-case would be to set this flag to `true` after an HTTP request has +completed: ```dart final myProvider = FutureProvider.autoDispose((ref) async { @@ -61,67 +65,70 @@ final myProvider = FutureProvider.autoDispose((ref) async { }); ``` -위의 방식을 사용하면, 만약에 요청이 실패하고 사용자가 화면상에서 떠나고 다시 들어온 경우 -요청을 재 실행할 수 있도록 합니다. 그러나, 만약 요청이 성공적으로 처리된다면, 상태가 유지될 것입니다. -그리고 화면에 재 진입해도 새로운 요청을 위한 트리거링이 발생하지 않습니다. +This way, if the request fails and the user leaves the screen then re-enters +it, then the request will be performed again. +But if the request completed successfully, the state will be preserved +and re-entering the screen will not trigger a new request. +:::info +In version 1.0.x, the equivalent of `keepAlive` is the property called `maintainState`. +::: -## 사용예: 더 이상 프로바이더를 사용하지 않을 때, HTTP 요청 취소하기 +## Example: Canceling HTTP requests when no longer used -`autoDispose` 수식어는 [FutureProvider]와 `ref.onDispose`에 결합 할 수 있습니다. -프로바이더를 더 이상 사용하지 않을 때 쉽게 HTTP 요청을 취소할 수 있습니다. +The `autoDispose` modifier could be combined with [FutureProvider] and `ref.onDispose` +to easily cancel HTTP requests when they are no longer needed. -이번 예시의 목표는 다음과 같습니다. +The goal is: -- 사용자가 화면에 들어왔을 때 HTTP 요청을 시작합니다. -- 만약 요청이 완료되기 전에 사용자가 화면을 떠났다면, HTTP을 취소합니다. -- 만약 요청이 성공했다면, 화면을 떠나거나 재 진입했을때 새로운 요청을 시작하지 않습니다. +- Start an HTTP request when the user enters a screen +- if the user leaves the screen before the request completed, cancel the HTTP request +- if the request succeeded, leaving and re-entering the screen does not start a new request -코드로 구현해 본다면 아래와 같습니다. +In code, this would be: ```dart final myProvider = FutureProvider.autoDispose((ref) async { - // http 요청을 취소하기 위한 package:dio 객체 + // An object from package:dio that allows cancelling http requests final cancelToken = CancelToken(); - // 프로바이더가 해제(destroyed)될 때, http 요청을 취소합니다. + // When the provider is destroyed, cancel the http request ref.onDispose(() => cancelToken.cancel()); - // 데이터를 가져오고 취소하기 위한 `cancelToken`을 파라미터로 념겨줍니다. + // Fetch our data and pass our `cancelToken` for cancellation to work final response = await dio.get('path', cancelToken: cancelToken); - // 만약 요청이 성곡적으로 완료되었다면, 현재 상태를 유지합니다. + // If the request completed successfully, keep the state ref.keepAlive(); return response; }); ``` -## 'AutoDisposeProvider'인수 타입은 'AlwaysAliveProviderBase' 매개변수에 할당할 수 없습니다. +## The argument type 'AutoDisposeProvider' can't be assigned to the parameter type 'AlwaysAliveProviderBase' -`.autoDispose`를 사용할 때, 아래와 같은 에러가 발생하면서 컴파일이 되지 않는 경우를 -만나볼 수 있습니다. +When using `.autoDispose`, you may find yourself in a situation where your +application does not compile with an error similar to: > The argument type 'AutoDisposeProvider' can't be assigned to the parameter > type 'AlwaysAliveProviderBase' -걱정 하지 마세요! 이 에러는 자발적으로 발생하는 오류입니다. -버그가 발생할 가능성이 높기 때문에 발생하는 오류입니다. - -`.autoDispose`의 수식어를 붙이지 않은 프로바이더에서 `.autoDispose` 수식어를 사용한 -프로바이더를 사용할 경우 발생할 수 있습니다. +Don't worry! This error is voluntary. It happens because you most likely +have a bug: +You tried to listen to a provider marked with `.autoDispose` in a provider that +is **not** marked with `.autoDispose`, such as: ```dart final firstProvider = Provider.autoDispose((ref) => 0); final secondProvider = Provider((ref) { - // 'AutoDisposeProvider'인자 값을 - // 'AlwaysAliveProviderBase' 파라미터 타입으로 할당할 수 없습니다. + // The argument type 'AutoDisposeProvider' can't be assigned to the + // parameter type 'AlwaysAliveProviderBase' ref.watch(firstProvider); }); ``` -위의 코드의 경우 `firstProvider`가 절대 disposed 처리 않음으로 사용상 바람직하지 않습니다. +This is undesired, as it would cause `firstProvider` to never be disposed. -이를 수정하기 위해 `secondProvider`에 `.autoDispose`를 추가할 필요가 있습니다. +To fix this, consider marking `secondProvider` with `.autoDispose` too: ```dart final firstProvider = Provider.autoDispose((ref) => 0); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx index 483296ae4..1b6346231 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx @@ -4,47 +4,49 @@ title: .family import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; +import { Link } from "../../../../../../src/components/Link"; -본 문서를 읽기 전에 [프로바이더란](/docs/concepts/providers)와 [프로바이더 읽기](/docs/concepts/reading)문서를 -먼저 읽고 오면 좋습니다. - -여기서는 `.family` 수식어에 대해 상세하게 알아보도록 하겠습니다. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -`.family` 수식어(modifier)의 하나의 목적을 가집니다. -외부 값을 이용하여 프로바이더를 생성할때 사용합니다. +Before reading this, consider reading about and . +In this part, we will talk in detail about the `.family` provider modifier. -통상적인 `family` 사용예는 다음과 같습니다. +The `.family` modifier has one purpose: Getting a unique provider based on external parameters. Some common use-cases for `family` would be: -- [FutureProvider]를 `.family`와 결합하여 ID에서 `Message`를 가져오는 경우. -- 번역을 다루기 위해 현재 `Locale` 값을 프로바이더로 전달하는 경우. +- Combining [FutureProvider] with `.family` to fetch a `Message` from its ID +- Passing the current `Locale` to a provider, so that we can handle translations -## 사용방법 +## Usage -프로바이더에 `.family` 수식어를 결합하면 파라미터가 추가됩니다. -이 파라미터를 프로바이더가 어떠한 특정 상태를 생성하기 위해 사용됩니다. +The way families works is by adding an extra parameter to the provider. +This parameter can then be freely used in our provider to create some state. -예를 들어, `family` 수식어를 [FutureProvider]에 결합하여 `Message`의 ID를 통해 -`Message`를 가져오는 경우를 확인해 보겠습니다. (위의 1번 예시) +For example, we can combine `family` with [FutureProvider] to fetch +a `Message` from its ID: ```dart final messagesFamily = FutureProvider.family((ref, id) async { return dio.get('http://my_api.dev/messages/$id'); }); ``` -그리고 `messagesFamily` 프로바이더를 사용할때 사용 구문(the syntax)에는 다소 차이가 있습니다. -일반적인 구문은 컴파일 상에서 에러를 발생시킵니다. + +When using our `messagesFamily` provider, the syntax is slightly different. +The usual syntax will not work anymore: ```dart Widget build(BuildContext context, WidgetRef ref) { - // Error – messagesFamily is not a provider - // 에러 - messagesFamily는 프로바이더가 아닙니다. + // Error – messagesFamily is not a provider final response = ref.watch(messagesFamily); } ``` -아래와 같이, `messagesFamily`에 파라미터를 넘겨줄 필요가 있습니다. +Instead, we need to pass a parameter to `messagesFamily`: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -53,10 +55,9 @@ Widget build(BuildContext context, WidgetRef ref) { ``` :::info - - `family` 를 사용하는 프로바이더에 다른 파라미터를 동시에 전달하는 것도 가능합니다. - 예를 들어, `titleFamily` 프로바이더에 프랑스어(French)와 영어(English)의 값을 얻기 위해 - 동시에 각기 다른 Locale 변수를 파라미터로 전달하고 있는 것을 확인할 수 있습니다. +It is possible to use a family with different parameters simultaneously. +For example, we could use a `titleFamily` to read both the French and English +translations at the same time: ```dart @override @@ -70,24 +71,22 @@ Widget build(BuildContext context, WidgetRef ref) { ::: -## 파라미터 제한하기 +## Parameter restrictions -`family`를 정상적으로 올바르게 작동시키기 위해서는 전달하는 파라미터에 대한 -`hashCode` and `==`의 등가성이 정의되어야할 필요가 있습니다. +For families to work correctly, it is critical for the parameter passed to +a provider to have a consistent `hashCode` and `==`. -이상적으로, 매개변수는 primitive자료형(bool/int/double/String), 정수(providers) 또는 -`==` 와 `hashCode`를 오버라이드 할 수 았는 불변(immutable) 객체 이어야 합니다. +Ideally, the parameter should either be a primitive (bool/int/double/String), +a constant (providers), or an immutable object that overrides `==` and `hashCode`. -- primitive 자료형: 컴퓨터 프로그램을 만드는 데 사용되는 기초적인 언어 구성. +### _PREFER_ using `autoDispose` when the parameter is not constant: +You may want to use families to pass the input of a search field to your provider. +But that value can change often and never be reused. +This could cause memory leaks as, by default, a provider is never destroyed even +if no longer used. -### _PREFER_ 파라미터가 정수가 아닐때는 `autoDispose`를 사용하세요. - -`family`를 사용해서 검색창에 입력된 값을 프로바이더의 매개변수로 전달하고 싶을 때가 있습니다. -그러나, 값은 종종 변경될 수 있고 결코 그 값은 재사용되지 않습니다. -이것은 심지어 더 이상 사용되지 않을때, 기본적으로 프로바이더는 절대 해제되지 않기 떄문에 메모리 누수를 야기할 수 있습니다. - -`.family` 와 `.autoDispose`를 함께 사용함으로써 메모리 누수 문제를 개선할 수 있습니다. +Using both `.family` and `.autoDispose` fixes that memory leak: ```dart final characters = FutureProvider.autoDispose.family, String>((ref, filter) async { @@ -95,19 +94,20 @@ final characters = FutureProvider.autoDispose.family, String>((r }); ``` -## 복수의 파라미터 전달하기 +## Passing multiple parameters to a family -`family` 수식어는 프로바이더로 복수의 파라미터를 전달하는것이 불가능합니다. +Families have no built-in support for passing multiple values to a provider. -반면에, 앞에서 설명한 제한 사항을 충족하는 한 모든 객체를 전달할 수 있습니다. +On the other hand, that value could be _anything_ (as long as it matches with +the restrictions mentioned previously). -아래의 패키지들을 이용하면 가능합니다. +This includes: - A tuple from [tuple](http://pub.dev/packages/tuple) - Objects generated with [Freezed] or [built_value](https://pub.dev/packages/built_value) - Objects using [equatable](https://pub.dev/packages/equatable) -여기 [Freezed] 와 [equatable]를 사용한 예시가 있습니다. +Here's an example of using [Freezed] or [equatable] for multiple parameters: ((ref, myParameter) { print(myParameter.userId); print(myParameter.locale); - // userId/locale를 사용하여 무언가를 처리 + // Do something with userId/locale }); @override Widget build(BuildContext context, WidgetRef ref) { - int userId; // userId를 어디선가 읽어 옴. + int userId; // Read the user ID from somewhere final locale = Localizations.localeOf(context); final something = ref.watch( @@ -168,12 +168,12 @@ class MyParameter extends Equatable { final exampleProvider = Provider.family((ref, myParameter) { print(myParameter.userId); print(myParameter.locale); - // userId/locale를 사용하여 무언가를 처리 + // Do something with userId/locale }); @override Widget build(BuildContext context, WidgetRef ref) { - int userId; // userId를 어디선가 읽어 옴. + int userId; // Read the user ID from somewhere final locale = Localizations.localeOf(context); final something = ref.watch( @@ -183,6 +183,7 @@ Widget build(BuildContext context, WidgetRef ref) { ... } ``` + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_lifecycles.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_lifecycles.mdx new file mode 100644 index 000000000..971ae56ef --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_lifecycles.mdx @@ -0,0 +1,108 @@ +--- +title: Provider Lifecycles +--- + +import CodeBlock from "@theme/CodeBlock"; +import onDispose from "./lifecycle_on_dispose"; +import { trimSnippet, When, AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + +## When does my Provider get created and disposed? + +The states that all different types of providers can go through are the same: + +- Uninitialized +- Alive +- Paused +- Disposed + +### Disposed / Uninitialized + +An **Uninitialized** or **Disposed** provider does not take up any memory since its state is not initialized. +Essentially it is just a definition of how to create the provider's state when you need it. +It will stay that way until an **Alive** provider or a [WidgetRef] from the UI reads, watches, or listens to it. + +### Creating -> Alive + +When an **Uninitialized** provider is read, listened to or watched it's state will be created. + +During creation your provider's build function will be run. +Any providers that you read or watch using the `ref` exposed by the callback will be created as needed and their state will be retrieved. + +If there are any circular dependencies during this creation process Riverpod will throw an error. +The best way to fix this error is to redesign your dependencies to have a uni-directional dataflow. + +The provider's state is stored in a [ProviderContainer]. In a Flutter app this container is in a [ProviderScope] widget. + +As such, even though the definition of how to create the state (the provider) is global, the state is actually local, +and can be different in different portions of your UI using nested [ProviderScope] widgets and overrides. + +This is very similar to how flutter widgets work. You only pay for the definition once, but can reuse the state in different parts of the tree as needed. + +### Alive + +When your provider is **Alive**, changes to its state will cause dependent providers and/or the dependent UI to rebuild. + +From the other perspective, as a reactive framework, you can watch other providers to have the provider recreate itself whenever one of it's dependencies changes. + +If you need to have some long-lived state that depends on other state you can use Ref's [listen] method to subscribe for changes on another provider without causing a rebuild of the provider. + +If you need to use the state from another provider in a side-effect, you can use Ref's [read] method to obtain the current state from another provider. + +Typically when constructing a [StateNotifier] or [ChangeNotifier] class you should pass in the `ref` to allow the Notifier to obtain the current value of dependencies as needed. By using the new [Notifier] and [AsyncNotifier] classes from Riverpod 2.0, the ref is already available as an instance member of the class. + +### Alive -> Paused +When an **Alive** provider is no longer listened to by other providers or the UI, it goes into a **Paused** state. +This means that it no longer will react to changes on providers it is listening to. +This is an optimization, as if you are not listening to the provider, there is no need to keep it alive. +Every provider not being used will be returned to a **Paused** state, reducing the computational burden of your app. + +If you need to keep a provider alive for side-effects, make sure to listen to it in an appropriate place in the UI where it should be kept alive. + +If you need to perform some action when a provider is paused use the ref's [onCancel] method to register callbacks. + +If you need to perform some action when a provider resumes to an Alive state from a paused state, use the ref's [onResume] method to register callbacks. + +If you want the state to be disposed, so that in addition to taking no computational resources, it also disposes of the memory of the state, use the `.autoDispose` modifier on your provider definition. +This will cause it to transition to a **Disposed** state instead of **Paused** when it is no longer being used. + +### Alive -> Disposing + +There are a few reasons for a provider to be disposed. + +- When defined using the `.autoDispose` modifier and no longer being watched by the UI or another provider +- When the provider is being manually refreshed or invalidated +- When the provider is being recreated due to one of it's watched dependencies changing + +Refreshing causes the provider to immediately go through the creation process again, whereas invalidating causes the next read / watch of the provider to cause the provider to be rebuilt. + +## Performing actions before the state destruction +If you need to perform some action when a provider is disposed, use the ref's [onDispose] method to register callbacks. + +The following example uses onDispose to close a StreamController: + + + +:::note +Depending on the provider used, it may already take care of the clean-up process. +For example, [StateNotifierProvider] will call the `dispose` method of the returned [StateNotifier]. +::: + +[onDispose]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/onDispose.html +[listen]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/listen.html +[onCancel]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/onCancel.html +[onResume]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/onResume.html +[ProviderContainer]: https://pub.dev/documentation/riverpod/latest/riverpod/ProviderContainer-class.html +[Notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html +[AsyncNotifier]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifier-class.html +[ProviderScope]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ProviderScope-class.html +[WidgetRef]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/WidgetRef-class.html +[StateNotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html +[StateNotifierProvider]: https://pub.dev/documentation/riverpod/latest/riverpod/StateNotifierProvider-class.html +[StreamController]: https://api.dart.dev/stable/2.15.1/dart-async/StreamController-class.html +[ChangeNotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx index 2fbae4b78..a611d07d6 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx @@ -3,27 +3,32 @@ title: ProviderObserver --- import CodeBlock from "@theme/CodeBlock"; -import logger from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart"; +import logger from "!!raw-loader!/docs/concepts/provider_observer_logger.dart"; import { trimSnippet } from "../../../../../src/components/CodeSnippet"; -[ProviderObserver]는 ProviderContainer의 변화를 관찰합니다. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -[ProviderObserver]를 사용하기 위해서, 사용하고자 하는 클래스에 `ProviderObserver`를 상속하고 -메소드를 오버라이드(override)하여 사용할 수 있습니다. +[ProviderObserver] listens to the changes of a ProviderContainer. -[ProviderObserver]는 3개의 메소드를 가집니다. +To use it, extend the class ProviderObserver and override the method you want to use. -- `didAddProvider`: 프로바이더(provider)가 초기화 될때 마다 호출됩니다. 노출되는 값은 `값(value)`입니다. -- `didDisposeProvider`: 프로바이더(provider)가 `disposed`될 때마다 호출됩니다. -- `didUpdateProvider`: 프로바이더(provider)값이 변경(when they emit a notification)될 때 마다 호출됩니다. +[ProviderObserver] has three methods : -### 사용법: +- `didAddProvider` is called every time a provider was initialized, and the value exposed is `value`. +- `didDisposeProvider` is called every time a provider was disposed. +- `didUpdateProvider` is called every time by providers when they emit a notification. -[ProviderObserver]는 `didUpdateProvider`를 오버라이딩 하여 프로바이더들(providers)의 변화를 로깅할 수 있습니다. +### Usage : + +A simple use case for [ProviderObserver] is to log the changes in providers by overriding the `didUpdateProvider` method. {trimSnippet(logger)} -이제 프로바이더 상태 값이 갱신될때 마다 로거에 기록으로 출력될 것입니다. +Now, every time the value of our provider is updated, the logger will log it: ``` I/flutter (16783): { @@ -32,4 +37,13 @@ I/flutter (16783): "newValue": "1" I/flutter (16783): } ``` +:::note: +For states that are mutable such as [StateController] (the state of [StateProvider.state]) and +[ChangeNotifier] the previousValue and newValue will be the same +::: +since they reference the same `StateController` / `ChangeNotifier`. + [providerobserver]: https://pub.dev/documentation/riverpod/latest/riverpod/ProviderObserver-class.html +[statecontroller]: https://pub.dev/documentation/riverpod/latest/riverpod/StateController-class.html +[stateprovider.state]: https://pub.dev/documentation/riverpod/latest/riverpod/StateProvider/state.html +[changenotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart index 0bed9e8cc..8ab5ecbae 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -6,7 +6,7 @@ import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ -// riverpod과 Logger를 사용한 카운터 앱 예제 +// A Counter example implemented with riverpod with Logger class Logger extends ProviderObserver { @override @@ -26,8 +26,8 @@ class Logger extends ProviderObserver { void main() { runApp( - // ProviderScope를 추가하여 프로젝트 전반적으로 Riverpod을 사용가능하도록 합니다. - // observers 리스트(목록)에 위에서 정의한 Logger 클래스를 추가합니다. + // Adding ProviderScope enables Riverpod for the entire project + // Adding our Logger to the list of observers ProviderScope(observers: [Logger()], child: const MyApp()), ); } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers.mdx index 066e4eed1..2bdf5467d 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers.mdx @@ -1,95 +1,99 @@ --- -title: 프로바이더란? +title: Providers --- -[Riverpod] 설치를 완료했다면 이제 "providers"(프로바이더)에 대해 알아보도록 하겠습니다. +import creatingProvider from "./providers/creating_a_provider"; +import declaringManyProviders from "./providers/declaring_many_providers"; +import { + AutoSnippet, +} from "../../../../../src/components/CodeSnippet"; +import { Link } from "../../../../../src/components/Link"; -프로바이더는 [Riverpod] 애플리케이션의 가장 중요한 파트 입니다. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -프로바이더는 하나의 상태조각의 압축(encapsulates)된 객체이자 -상태의 변화를 감시하는 역할을 가지고 있습니다. +Now that we have installed [Riverpod], let's talk about "providers". -## 왜 프로바이더를 사용하나요? +Providers are the most important part of a [Riverpod] application. +A provider is an object that encapsulates a piece of state and allows listening +to that state. -상태를 프로바이더로 감싸게 되면 아래의 서술된 내용들이 가능합니다. +## Why use providers? -- 코드상 다양한 위치에서 상태를 쉽게 접근할 수 있습니다. - 프로바이더는 Singletons, Service Locators, Dependency Injection 또는 InheritedWidgets - 과 같은 디자인 패턴들을 완벽하게 대체할 수 있습니다. +Wrapping a piece of state in a provider: -- 다른 프로바이더 상태와 간편하게 결합하여 사용할 수 있습니다. - 혹시 여러 객체들을 하나로 병합하는데 어려움을 격은적이 있나요? - 프로바이더를 사용하면 프로바이더의 간단한 문법을 사용하여 구현할 수 있습니다. +- Allows easily accessing that state in multiple locations. + Providers are a complete replacement for patterns like Singletons, + Service Locators, Dependency Injection or InheritedWidgets. -- 퍼포먼스 최적화가 가능합니다. - 위젯을 다시 빌드하는것을 필터링 하거나 비용이 높은 상태 계산을 캐싱하거나 - 프로바이더는 상태 변경의 영향을 받는 항목만 다시 계산합니다. +- Simplifies combining this state with others. + Ever struggled to merge multiple objects into one? This scenario is built + directly inside providers. -- 애플리케이션의 태스트 용이성이 높아집니다. - 프로바이더와 함께라면, 복잡한 `setUp`/`tearDown` 단계가 불필요 합니다. - 게다가 어떠한 프로바이더이든지 테스트 중의 프로바이더 행위를 오버라이드 할 수 있습니다. - 매우 특정한 행위(동작)을 테스트 하기 쉽습니다. +- Enables performance optimizations. + Whether for filtering widget rebuilds or for caching expensive state computations; + providers ensure that only what is impacted by a state change is recomputed. -- 고급 기능들과 함께 손 쉬운 통합이 가능합니다. 예를들어 로깅(logging) 또는 pull-to-refresh가 있습니다. +- Increases the testability of your application. + With providers, you do not need complex `setUp`/`tearDown` steps. Furthermore, + any provider can be overridden to behave differently during a test, which + allows easily testing a very specific behavior. -## 프로바이더 생성하기 +- Allows easy integration with advanced features, such as logging or + pull-to-refresh. -다양한 프로바이더들이 있지만, 기본적으로 모두 동일한 방식으로 동작합니다. +## Creating a provider -가장 보편적으로 사용하는 방법으로 전역 변수(global constants)로 선언하여 사용하는 방법이 있습니다. +Providers come in many variants, but they all work the same way. +The most common usage is to declare them as global constants like so: -```dart -final myProvider = Provider((ref) { - return MyValue(); -}); -``` + :::note -프로바이더를 글로벌하게 전역변수로 선언하여 사용하는것을 두려워하지 마세요. -프로바이더는 완전 immutable 특성을 가집니다. 프로바이더를 선언하는 것은 함수를 선언하는것과 -다르지 않습니다. 그리고 프로바이더들은 테스트할 수 있고 유지보수 할 수 있습니다. +Do not be frightened by the global aspect of providers. +Providers are fully immutable. Declaring a provider is no different from declaring +a function, and providers are testable and maintainable. ::: -위 코드 정보는 3개의 컴포넌트를 구성하고 있습니다. +This snippet consists of three components: -- `final myProvider`, 변수 선언입니다. - 이 변수는 항상 불변(immutable) 특성을 가질 것 입니다. - 그리고 추후 프로바이더의 상태를 읽기위해 사용하게 됩니다. +- `final myProvider`, the declaration of a variable. + This variable is what we will use in the future to read the state of our provider. + Providers should always be `final`. -- `Provider`, 우리가 코드에서 사용하기 위해 결정한 프로바이더 입니다. - [Provider]는 모든 프로바이더 종류들 중 가장 기본이 되는 친구입니다. 이 객체는 위에서 설명한 것 처럼 - 변하지 않는 불변의 특성을 가지게 됩니다. 우리는 여기서 어떻게 상태(값)과 상호 작용하는지에 따라서 - [Provider]를 다른 종류의 프로바이더로 바꿔 사용할 수 있습니다. - 예를 들어 [StreamProvider] 또는 [StateNotifierProvider] 가 있습니다. +- `Provider`, the provider that we decided to use. + [Provider] is the most basic of all providers. It exposes an object that never + changes. + We could replace [Provider] with other providers like [StreamProvider] or + [NotifierProvider], to change how the value is interacted with. -- 공유 상태를 생성하는 함수입니다. - 이 함수는 `ref` 객체를 파라미터로 받습니다. 이 객체는 다른 프로바이더들을 읽기 위해서 사용하거나 - 프로바이더의 상태가 소멸될 때 일부 작업을 수행할 수 있도록 합니다. +- A function that creates the shared state. + That function will always receive an object called `ref` as a parameter. This object + allows us to read other providers, perform some operations when the state + of our provider will be destroyed, and much more. -프로바이더 내부에서 생성되는 객체의 형태는 사용하는 프로바이더의 종류에 따라 다르게 생성됩니다. -예를 들어 [Provider]의 함수는 어떤 객체든 생성가능합니다. 반면에 [StreamProvider]는 [Stream] 객체를 -생성할 필요가 있습니다. 여기서 생성이라고 함은 [StreamProvider]에서 [Stream]을 반환해야합니다. +The type of the object returned by the function passed to a provider depends on +the provider used. +For example, the function of a [Provider] can create any object. +On the other hand, [StreamProvider]'s callback will be expected to return a [Stream]. :::info -어떠한 제한 없이 원하는데로 수 많은 종류의 프로바이더들을 선언할 수 있습니다. -`package:provider`를 사용할때와 반대로, [Riverpod]에서는 같은 "type"의 상태를 노출하는 -2개의 프로바이더를 가지게 됩니다. +You can declare as many providers as you want without limitations. +As opposed to when using `package:provider`, [Riverpod] allows creating multiple +providers exposing a state of the same "type": + -```dart -final cityProvider = Provider((ref) => 'London'); -final countryProvider = Provider((ref) => 'England'); -``` - -사실 위의 예에서는 2개의 프로바이더가 `String` 값을 생성하는 것은 -어떠한 문제의 원인이 되지 않습니다. -(역자: '2개의 프로바이더가 `String`값을 생성하는데 문제될 것이 없다'라는 의미로 -받아들이면 좋겠습니다.) +The fact that both providers create a `String` does not cause any problem. ::: :::caution -프로바이더가 동작하기 위해서 [ProviderScope]를 Flutter 앱의 가장 최상위(root) 부모 위젯으로 감싸줘야 합니다. +For providers to work, you must add [ProviderScope] at the root of your +Flutter applications: ```dart void main() { @@ -99,52 +103,52 @@ void main() { ::: -## 상태가 소멸되기 전에 액션 취하기 +## Different Types of Providers -일부 케이스에서, 프로바이더의 상태는 소멸(파괴)되거나 재 생성될 수 있습니다. -통상적인 경우 이러한 상황들은 프로바이더 소멸 상태 전에 초기화를 진행하는 경우 입니다. -예를 들어 `StreamController`를 닫아주는 경우가 있습니다. +There are multiple types of providers for multiple different use cases. -이것은 프로바이더 내부에서 사용하는 `ref` 객체의 [onDispose] 메소드를 사용할 수 있습니다. +With all of these providers available, it is sometimes difficult to understand when to use one provider type over another. +Use the table below to choose a provider that fits what you want to provide to the widget tree. -다음 사용예시에서 [onDispose]를 사용하여 `StreamController`를 닫는 과정을 알아봅시다. +| Provider Type | Provider Create Function | Example Use Case | +| ------------------------ | ------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| [Provider] | Returns any type | A service class / computed property (filtered list) | +| [StateProvider] | Returns any type | A filter condition / simple state object | +| [FutureProvider] | Returns a Future of any type | A result from an API call | +| [StreamProvider] | Returns a Stream of any type | A stream of results from an API | +| [NotifierProvider] | Returns a subclass of (Async)Notifier | A complex state object that is immutable except through an interface | +| [StateNotifierProvider] | Returns a subclass of StateNotifier | A complex state object that is immutable except through an interface. Prefer using a notifierProvider | +| [ChangeNotifierProvider] | Returns a subclass of ChangeNotifier | A complex state object that requires mutability | +:::caution +While all providers have their purpose, [ChangeNotifierProvider]s are not recommended for scalable applications. See . It exists in the +`flutter_riverpod` package to provide an easy migration path from +`package:provider`, and allows for some flutter specific use-cases such as +integration with some Navigator 2 packages. ::: -```dart -final example = StreamProvider.autoDispose((ref) { - final streamController = StreamController(); - - ref.onDispose(() { - // 프로바이더의 상태가 소멸되기 전 StreamController를 닫습니다(close). - streamController.close(); - }); +## Provider Modifiers - return streamController.stream; -}); -``` +All Providers have a built-in way to add extra functionalities to your different providers. -:::note -사용하는 프로바이더에 따라서, 이러한 리소스 해제 처리 작업을 내부에서 자동으로 진행하는 경우도 있습니다. -예를 들어 [StateNotifierProvider]는 `StateNotifier`의 `dispose`메소드를 호출합니다. -::: - -## 프로바이더 수식자(Modifiers) - -모든 프로바이더들은 다른 프로바이더와 추가적인 기능을 추가하기 위한 방법이 기본적으로 내장되어 있습니다. -`ref` object에 새로운 특징을 추가하거나 프로바이더가 어떻게 상태를 소모(사용)하는지를 변경할 수 있습니다. -Modifiers는 모든 프로바이더에서 사용할 수 있습니다. 이는 named constructor(생성자) 문법과 유사합니다. +They may add new features to the `ref` object or change slightly how the provider +is consumed. +Modifiers can be used on all providers, with a syntax similar to named constructor: ```dart final myAutoDisposeProvider = StateProvider.autoDispose((ref) => 0); final myFamilyProvider = Provider.family((ref, id) => '$id'); ``` -지금은 2개의 사용가능한 수식어가 있습니다. -- [`.autoDispose`](/docs/concepts/modifiers/auto_dispose) 는 더 이상 상태를 구독하지 않을때 자동으로 프로바이터를 소멸되도록 합니다. -- [`.family`](/docs/concepts/modifiers/family) 외부 파라미터로부터 프로바이더를 생성할 때 사용합니다. +At the moment, there are two modifiers available: + +- , which will make the + provider automatically destroy its state when it is no longer being listened + to. +- , which allows creating a + provider from external parameters. :::note -프로바이더는 복수의 수식어(modifiers)를 한번에 사용할 수 있습니다. +A provider can use multiple modifiers at once: ```dart final userProvider = FutureProvider.autoDispose.family((ref, userId) async { @@ -154,11 +158,10 @@ final userProvider = FutureProvider.autoDispose.family((ref, userId) ::: -프로바이더에 대한 설명은 여기까지 입니다! - -[프로바이더 읽기](/docs/concepts/reading) 문서에서 계속됩니다. -또는 [프로바이더 결합하기](/docs/concepts/combining_providers)문서도 확인할 수 있습니다. +That's it for this guide! +You can continue with . +Alternatively, you can see . [get_it]: http://pub.dev/packages/get_it [inheritedwidget]: https://api.flutter.dev/flutter/widgets/InheritedWidget-class.html @@ -168,7 +171,11 @@ final userProvider = FutureProvider.autoDispose.family((ref, userId) [hooks_riverpod]: https://pub.dev/packages/hooks_riverpod [flutter_riverpod]: https://pub.dev/packages/flutter_riverpod [flutter_hooks]: https://github.com/rrousselGit/flutter_hooks -[provider]: ../providers/provider -[streamprovider]: ../providers/stream_provider -[statenotifierprovider]: ../providers/state_notifier_provider +[provider]: /docs/providers/provider +[streamprovider]: /docs/providers/stream_provider +[futureprovider]: /docs/providers/future_provider +[stateprovider]: /docs/providers/state_provider +[statenotifierprovider]: /docs/providers/state_notifier_provider +[notifierProvider]: /docs/providers/notifier_provider +[changenotifierprovider]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ChangeNotifierProvider-class.html [providerscope]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ProviderScope-class.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart new file mode 100644 index 000000000..8dc6c5e12 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart @@ -0,0 +1,12 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class MyValue {} + +/* SNIPPET START */ + +@riverpod +MyValue my(MyRef ref) { + return MyValue(); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart new file mode 100644 index 000000000..bb1efdb5f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart @@ -0,0 +1,72 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef MyRef = Ref; + +@ProviderFor(my) +const myProvider = MyProvider._(); + +final class MyProvider extends $FunctionalProvider + with $Provider { + const MyProvider._( + {MyValue Function( + MyRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyValue Function( + MyRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$myHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + MyProvider $copyWithCreate( + MyValue Function( + MyRef ref, + ) create, + ) { + return MyProvider._(create: create); + } + + @override + MyValue create(MyRef ref) { + final _$cb = _createCb ?? my; + return _$cb(ref); + } +} + +String _$myHash() => r'0810ee24cae78c131d00773ac20d254c83eefab7'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart new file mode 100644 index 000000000..d63faf94b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart @@ -0,0 +1,9 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class MyValue {} + +/* SNIPPET START */ + +final myProvider = Provider((ref) { + return MyValue(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart new file mode 100644 index 000000000..474fe004b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart @@ -0,0 +1,10 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +String city(CityRef ref) => 'London'; +@riverpod +String country(CountryRef ref) => 'England'; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart new file mode 100644 index 000000000..8b589ad1e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart @@ -0,0 +1,132 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CityRef = Ref; + +@ProviderFor(city) +const cityProvider = CityProvider._(); + +final class CityProvider extends $FunctionalProvider + with $Provider { + const CityProvider._( + {String Function( + CityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'cityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + CityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$cityHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CityProvider $copyWithCreate( + String Function( + CityRef ref, + ) create, + ) { + return CityProvider._(create: create); + } + + @override + String create(CityRef ref) { + final _$cb = _createCb ?? city; + return _$cb(ref); + } +} + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +typedef CountryRef = Ref; + +@ProviderFor(country) +const countryProvider = CountryProvider._(); + +final class CountryProvider + extends $FunctionalProvider + with $Provider { + const CountryProvider._( + {String Function( + CountryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'countryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + CountryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$countryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CountryProvider $copyWithCreate( + String Function( + CountryRef ref, + ) create, + ) { + return CountryProvider._(create: create); + } + + @override + String create(CountryRef ref) { + final _$cb = _createCb ?? country; + return _$cb(ref); + } +} + +String _$countryHash() => r'd1513349c3bc0c99763cb4fb29eb012f2351bc4c'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart new file mode 100644 index 000000000..09d8a659f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart @@ -0,0 +1,6 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +final cityProvider = Provider((ref) => 'London'); +final countryProvider = Provider((ref) => 'England'); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading.mdx index ce68a31a4..78345456a 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading.mdx @@ -1,245 +1,267 @@ --- -title: 프로바이더 읽기 +title: Reading a Provider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import counter from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart"; -import consumerWidget from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart"; -import consumerStatefulWidget from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart"; -import consumerHookWidget from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart"; -import consumerHook from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart"; -import watch from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart"; -import watchBuild from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart"; -import listen from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart"; -import listenBuild from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart"; -import read from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart"; -import readBuild from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart"; -import readNotifierBuild from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart"; -import watchNotifierBuild from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import counter from "./reading/counter"; +import consumerWidget from "./reading/consumer_widget"; +import consumerStatefulWidget from "./reading/consumer_stateful_widget"; +import consumerHook from "!!raw-loader!/docs/concepts/reading/consumer_hook.dart"; +import watch from "./reading/watch"; +import watchBuild from "./reading/watch_build"; +import listen from "./reading/listen"; +import listenBuild from "./reading/listen_build"; +import read from "./reading/read"; +import readBuild from "./reading/read_build"; +import readNotifierBuild from "./reading/read_notifier_build"; +import watchNotifierBuild from "./reading/watch_notifier_build"; +import provider from "./reading/provider"; +import { + trimSnippet, + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; +import { Link } from "../../../../../src/components/Link"; -본 가이드를 읽기전에 [프로바이더란](/docs/concepts/providers)에 대해서 먼저 알아보는 것을 추천합니다. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -이 가이드 문서는 프로바이더를 어떻게 사용/소비(consume)하는지에 대해 알아봅니다. +Before reading this guide, make sure to first. -## "ref" 객체 얻기 +In this guide, we will see how to consume a provider. -프로바이더를 읽기전 맨 처음 "ref" 라는 객체를 얻을 필요가 있습니다. +## Obtaining a "ref" object -이 객체('ref')는 프로바이더간 상호작용을 도와주고 위젯이나 다른 프로바이더에서 얻을 수 있습니다. +First and foremost, before reading a provider, we need to obtain a "ref" object. -### 프로바이더로 부터 "ref" 객체 얻기 +This object is what allows us to interact with providers, be it from a widget +or another provider. -모든 프로바이더들은 "ref"객체를 파라미터로서 받게 됩니다. +### Obtaining a "ref" from a provider -```dart -final provider = Provider((ref) { - // 다른 프로바이더 객체를 얻기위해 ref를 사용합니다. - // 여기서 repositoryProvider 프로바이더를 Provider 에서 읽는 것을 확인합니다. - final repository = ref.watch(repositoryProvider); +All providers receive a "ref" as a parameter: - return SomeValue(repository); -}) -``` + + +This parameter is safe to pass to the value exposed by the provider. + + + +A common use-case is to pass the provider's "ref" to a `StateNotifier` -이 매개변수는 프로바이더가 노출한 값으로 전달하는 것이 안전합니다. + -예를 들어, 통상적으로 프로바이더의 "ref"를 [StateNotifier]로 전달합니다. + -{trimSnippet(counter)} +Doing so allows our `Counter` class to read providers. -[StateNotifier]를 상속 받은 `Counter` 클래스는 `ref` 객체를 통해 -다른 프로바이더를 사용하거나 읽을 수 있게 되었습니다. +### Obtaining a "ref" from a widget -### 위젯에서 "ref" 객체 얻기 +Widgets naturally do not have a ref parameter. But [Riverpod] offers multiple +solutions to obtain one from widgets. -위젯들(Widgets)은 "ref" 파라미터를 가지고 있지 않습니다. -그러나, [Riverpod]에서는 위젯에서 "ref" 객체를 얻기위한 다양한 솔루션을 제공합니다. + -#### StatelessWidget 대신 ConsumerWidget으로 상속받기 +#### Extending ConsumerWidget instead of StatelessWidget -가장 일반적인 해결방법은 [StatelessWidget]를 [ConsumerWidget]의로 바꿔서 위젯을 생성하는 것입니다. -(여기서 말하고자하는 해결방법이란 위에서 언급한 위젯에서 "ref" 객체를 얻는 방법입니다.) +The most common way to obtain a ref in the widget tree is +to replace [StatelessWidget] with [ConsumerWidget]. -[ConsumerWidget]은 [StatelessWidget]와 기본적으로 동일합니다. -차이점은 build 메소드에서 추가적으로 "ref" 객체를 받는 것입니다. +[ConsumerWidget] is identical in use to [StatelessWidget], with the only +difference being that it has an extra parameter on its build method: the "ref" object. -전형적인 [ConsumerWidget] 사용방법은 아래 예시 코드와 같습니다. +A typical [ConsumerWidget] looks like: -{trimSnippet(consumerWidget)} + -#### StatefulWidget+State 대신에 ConsumerStatefulWidget+ConsumerState 상속받기 +#### Extending ConsumerStatefulWidget+ConsumerState instead of StatefulWidget+State -[ConsumerWidget]과 유사하게, [ConsumerStatefulWidget]과 [ConsumerState]는 [StatefulWidget]과 [State]와 동일합니다. -차이점은 "ref" 객체를 상태로 가진다는 점 입니다. +Similar to [ConsumerWidget], [ConsumerStatefulWidget] and [ConsumerState] are the equivalent of a +[StatefulWidget] with its [State], with the difference that the state has a "ref" object. -이번에는 "ref"객체는 build 메소드의 파라미터로서 전달되지 않습니다. -"ref" 객체는 [ConsumerState]객체의 속성이 됩니다. +This time, the "ref" isn't passed as parameter of the build method, but is +a property of the [ConsumerState] object: -아래의 예시 코드를 확인해 봅시다. + -{trimSnippet(consumerStatefulWidget)} + -#### HookWidget 대신 HookConsumerWidget 상속받기 + -이 방법은 [flutter_hooks]를 사용하는 사용자에게 한정됩니다. -[flutter_hooks]은 [HookWidget]을 상속받는게 필요하기 때문에 hooks을 사용하기위해 위젯에서 -[ConsumerWidget]을 상속하는것은 불가능합니다. +#### Extending HookConsumerWidget instead of HookWidget -하나의 해결 방안으로 [hooks_riverpod] 패키지를 사용하면 됩니다. -이 패키지는 [HookWidget]를 [HookConsumerWidget]으로 대체할 수 있는 해결방안을 제공합니다. +This option is for [flutter_hooks] users. Since [flutter_hooks] requires +extending [HookWidget] to work, widgets that use hooks are unable to extend +[ConsumerWidget]. -[HookConsumerWidget]은 [ConsumerWidget]과 [HookWidget]의 기능을 포함하고 있습니다. -즉, 프로바이더를 구독하는것과 hooks을 사용하는 것이 모두 가능합니다. +The package [hooks_riverpod] exposes a new widget called [HookConsumerWidget]. +[HookConsumerWidget] acts as both a [ConsumerWidget] and a [HookWidget]. This +allows a widget to both listen to providers and use hooks. -예제를 확인해 봅시다. +An example would be: -{trimSnippet(consumerHookWidget)} + -#### Consumer 와 HookConsumer 위젯 +#### Extending StatefulHookConsumerWidget instead of HookWidget -위젯(widgets)안에서 "ref" 객체를 얻기 위한 마지막 방안으로 -[Consumer]/[HookConsumer] 위젯을 사용하는 것이 있습니다. +This option is for [flutter_hooks] users, who need to use [StatefulWidget] lifecycle methods in addition to hooks. -이 클래스들은([Consumer]/[HookConsumer]) "ref"를 얻기위해 사용하는 위젯들입니다. -[ConsumerWidget]/[HookConsumerWidget]로서 동일한 속성을 가집니다. +An example would be: -이 위젯들은 "ref"를 얻기위해 별도의 class를 정의할 필요가 없습니다. -아래의 예시 코드를 통해 확인해 봅시다. + + +#### Consumer and HookConsumer widgets + +A final way to obtain a "ref" inside widgets is to rely on [Consumer]/ +[HookConsumer]. + +These classes are widgets that can be used to obtain a "ref" in a builder callback, with the same +properties as [ConsumerWidget]/[HookConsumerWidget]. + +As such, these widgets are a way to obtain a "ref" without having to define a class. +An example would be: {trimSnippet(consumerHook)} -## `ref`를 사용해서 프로바이더와 상호작용하기 + -이제 "ref" 겍체와 사용방법에 대해 알아봅시다. -"ref"는 3개지 주요한 용도가 있습니다. +## Using ref to interact with providers -- `ref.watch` = 프로바이더의 값을 취득하고 변화를 구독합니다. 값의 변경이 발생하면, - 위젯(widget)을 다시 빌드하거나 값을 구독(subscribed)하고 있는 위치에 상태 값을 전달 및 제공합니다. +Now that we have a "ref", we can start using it. -- `ref.listen` = 프로바이더의 상태 값을 구독하거나 상태값이 변했을때 어떠한 행위를 취해야할 경우 사용합니다. +There are three primary usages for "ref": -- `ref.read` = 프로바이더의 상태값을 취득합니다. 이벤트 콜백함수에 사용하기 유용한데 예를들어 버튼의 `onPressed` - 콜백 함수에서 프로바이더의 필요한 상태값을 얻기위해서 사용할 수 있습니다. +- obtaining the value of a provider and listening to changes, such that when + this value changes, this will rebuild the widget or provider that subscribed + to the value. + This is done using `ref.watch` +- adding a listener on a provider, to execute an action such as navigating to a new + page or showing a modal whenever that provider changes. + This is done using `ref.listen`. +- obtaining the value of a provider while ignoring changes. + This is useful when we need the value of a provider in an event + such as "on click". + This is done using `ref.read`. :::note -기능을 구현할때는 가급적 `ref.read` 또는 `ref.listen` 보다 `ref.watch` 사용을 권장합니다. - -`ref.watch`을 사용하게되면 reactive(리엑티브)와 declarative(선언형)에 가까워 지고 -애플리케이션을 더 유지보수 하기 편리하게 만들어 줍니다. +Whenever possible, prefer using `ref.watch` over `ref.read` or `ref.listen` to +implement a feature. +By relying on `ref.watch`, your application becomes both reactive +and declarative, which makes it more maintainable. ::: -### `ref.watch`를 사용해서 프로바이더 관찰하기 - -위젯의 `build` 메소드 내부 또는 프로바이더 내부에서 `ref.watch`를 사용함으로서 -프로바이더의 상태 값을 구독(listen)할 수 있습니다. +### Using ref.watch to observe a provider -예를 들어, 프로바이더에서 `ref.watch`를 사용하여 복수의 프로바이더와 결합해 새로운 값을 -생성 할 수도 있습니다. +`ref.watch` is used inside the `build` method of a widget or +inside the body of a provider to have the widget/provider listen to a provider: -할일 목록(a todo-list)에서 필터링하는 방법의 한가지 예시 입니다. -여기서 2개의 프로바이더를 사용했습니다. +For example, a provider could use `ref.watch` to combine multiple providers +into a new value. An example would be filtering a todo-list. - We could have two providers: -- `filterTypeProvider`: 현재 설정한 필터타입(none, show only completed tasks, ...)에대한 상태를 나타내는 프로바이더입니다. - -- `todosProvider`: 할일(tasks)에 대한 목록 전체 값을 가지는 프로바이더 입니다. +- `filterTypeProvider`, a provider that exposes the current type of filter + (none, show only completed tasks, ...) +- `todosProvider`, a provider that exposes the entire list of tasks -그리고 `ref.watch`를 사용하여 두개의 프로바이더를 결합해 필터링된 작업 목록 생성하는 세 번째 프로바이더를 만들 수 있습니다. +And by using `ref.watch`, we could make a third provider that combines both providers to +create a filtered list of tasks: -{trimSnippet(watch)} + -위의 코드에서 확인할 수 있듯이 `filteredTodoListProvider` 프로바이더는 필터링된 할일 목록을 가집니다. +With this code, `filteredTodoListProvider` now exposes the filtered list of tasks. -필터링된 목록은 할일 목록이 변경되거나 필터 상태값이 변경되면 자동적으로 갱신될 것 입니다. -그러나, 필터 상태가 동일하거나 할일 목록이 동일하다면 다시 계산되거나 갱신되지 않습니다. +The filtered list will also automatically update if either the filter or the list of tasks +changed. At the same time, the filtered list will not be recomputed if +neither the filter nor the list of tasks changed. -이와 유사하게 위젯에 `ref.watch`를 사용하는 경우 프로바이더상에 의존하는 사용자 인터페이스를 -표시할 수 있습니다. +Similarly, a widget can use `ref.watch` to show +the content from a provider and update the user interface whenever that content changes: -{trimSnippet(watchBuild)} + -이 예시코드는 카운터 상태값을 저장하고 있는 프로바이더를 구독하고 있는 위젯을 보여줍니다. -그리고 만약 카운터 값이 변경되면 위젯을 다시 빌드되고 UI에 새로 갠신된 값을 표기할 것 입니다. +This snippet shows a widget that listens to a provider which stores a `count`. +And if that `count` changes, the widget will rebuild and the UI will update +to show the new value. :::caution -`watch`메소드는 비동기처리(asynchronously)에 호출하지 마세요. -예를 들어 [ElevatedButton]의 `onPressed` 콜백 함수 안이나 `initState` 그리고 다른 [State]의 생명주기 안에서는 -`watch`메소드를 호출하면 안됩니다. +The `watch` method should not be called asynchronously, +like inside an `onPressed` of an [ElevatedButton]. Nor should it be used +inside `initState` and other [State] life-cycles. -이때는 `ref.watch`대신 `ref.read`메소드를 사용하는 것을 권장합니다. +In those cases, consider using `ref.read` instead. ::: -### `ref.listen`을 사용하여 프로바이더 변화에 대응하기 +### Using ref.listen to react to a provider change -`ref.watch`와 유사하게 프로바이더를 관찰하기 위해 `ref.listen`을 사용할 수 있습니다. -`ref.watch`와 `ref.listen`의 주요한 차이점은 `ref.watch`는 프로바이더 상태값이 변경이되면 widget/provider을 다시 빌드하지만 -`ref.listen`은 함수를 호출한다는 점입니다. 함수는 커스텀된 함수이며 사용자에 따라 다르게 정의해서 사용할 수 있습니다. +Similarly to `ref.watch`, it is possible to use `ref.listen` to observe a provider. -예를 들어 에러가 발생할때 스낵바(snackbar)를 표시하거나 어떠한 반응의 변화에 대응해야 할때 -유용하게 사용할 수 있습니다. +The main difference between them is that, rather than rebuilding the widget/provider +if the listened to provider changes, using `ref.listen` will instead call a custom function. -`ref.listen` 메소드는 2개의 위치인자(positional arguments)가 필요합니다. -첫번째는 프로바이더이고 두번쨰는 콜백함수 입니다. 콜백함수는 상태변화에 대응하여 수행할 함수 입니다. -콜백함수로 2개의 값이 전달됩니다. 하나는 이전 상태 값이고 나머지 하는 갱신된 상태 값입니다. +That can be useful for performing actions when a certain change happens, such +as showing a snackbar when an error happens. -`ref.listen` 메소드는 프로바이더 내부에서도 사용할 수 있습니다. -아래의 코드를 확인해 볼 수 있습니다. +The `ref.listen` method needs 2 positional arguments, the first one is the Provider and the second one is the callback function that we want to execute when the state changes. +The callback function when called will be passed 2 values, the value of the previous State and the value of the new State. -{trimSnippet(listen)} +The `ref.listen` method can be used inside the body of a provider: -또는 `build` 메소드 안에서 사용할 수 있습니다. + -{trimSnippet(listenBuild)} +or inside the `build` method of a widget: + + :::caution -[ElevatedButton]의 `onPressed` 콜백함수 내부, `initState` 내부 그리고 다른 상태주기의 [State]상에서와 같이 -`listen`메소드 또한 비동기(asynchronously)로 호출 가능한 곳에서는 사용을 피해야합니다. +The `listen` method should not be called asynchronously, +like inside an `onPressed` of an [ElevatedButton]. Nor should it be used +inside `initState` and other [State] life-cycles. ::: -### `ref.read`을 사용하여 프로바이더의 상태를 한번 취득하기 +### Using ref.read to obtain the state of a provider -`ref.read` 메소드는 어떠한 부가적인 효과 없이 프로바이더의 상태를 얻기위한 방법을 제공합니다. +The `ref.read` method is a way to obtain the state of a provider without listening to it. -`ref.read`는 일반적으로 사용자 상호작용으로 발생가능한 트리거 함수내부에서 주로 사용합니다. -예를들어 버튼을 눌렀을떄 카운터의 값이 증가시키고 싶을때 `ref.read`메소드를 사용할 수 있습니다. +It is commonly used inside functions triggered by user interactions. +For example, we can use `ref.read` to increment a counter when a user clicks a button: -{trimSnippet(read)} + :::note -가능한 `ref.read`사용을 피해주세요. +Using `ref.read` should be avoided as much as possible because it is not reactive. -`ref.read`메소드는 `watch` 또는 `listen`이 어려운곳에서 사용할 수 있는 대응책으로 사용하되, -가능한 `watch`/`listen`를 사용해주세요. 여기서 더 추천하는 메소드는 `watch` 메소드입니다. +It exists for cases where using `watch` or `listen` would cause issues. +If you can, it is almost always better to use `watch`/`listen`, especially `watch`. ::: -#### [**DONT'T**] `ref.read`를 `build` 메소드 안에서 **사용하지 마세요.** +#### **DON'T** use `ref.read` inside the build method -위젯의 성능 최적화를 위해 아래의 예시처럼 `ref.read`를 사용하고 있을 수 있습니다. +You might be tempted to use `ref.read` to optimize the performance of a widget +by doing: -{trimSnippet(readBuild)} + -그러나, 위의 예시는 나쁜 예시를 나타내고 있습니다. 그리고 이렇게 사용할 경우 -다루기 어려운 버그들을 유발수 있습니다. +But this is a very bad practice and can cause bugs that are difficult to track. -`ref.read`를 사용하기위해 이 방법은 일반적으로 다음과 같이 생각해서 발생할 수 있습니다. -"프로바이더의 상태값이 변경되지 않으니까 'ref.read'를 사용하는것이 안전하겠다." -그러나, 오늘은 비록 상태 값이 갱신되지 않더라도 내일 상태 값이 같을 것이라고 보장할 수 없기 때문입니다. +Using `ref.read` this way is commonly associated with the thought "The value +exposed by a provider never changes so using 'ref.read' is safe". The problem +with this assumption is that, while today that provider may indeed never update +its value, there is no guarantee that tomorrow will be the same. -소프트웨어는 수 없는 변화가 일어나는 경향이 있습니다. -그리고 미래에는 현재의 절대 바뀌지 않을 값이 변경될 가능성이 있습니다. -그러나, 만약 값의 변화가 시작될때, `ref.read`를 사용하게 되면 모든 `ref.read`메소드를 -전반적으로 `ref.watch`로 변경해야합니다. (이 작업에서 수많은 에러가 발생할 수 있고 특정 케이스에 -대한 변경 처리를 까먹을 수 도 있습니다.) +Software tends to change a lot, and it is likely that in the future, a value +that previously never changed will need to change. +If you use `ref.read`, when that value needs to change, you have +to go through your entire codebase to change `ref.read` into `ref.watch` – +which is error prone and you are likely to forget some cases. -반면 만약 `ref.watch` 를 사용하게되면 어떠한 문제도 걱정도 할 필요없을 것입니다. +If you use `ref.watch` to begin with, you will have fewer problems when refactoring. -**_그래도 난 위젯이 다시 빌드되는걸 줄이고 싶고 처음부터 `ref.read`를 사용하고 싶어!_** +**_But I wanted to use `ref.read` to reduce the number of times my widget rebuilds_** While the goal is commendable, it is important to note that you can achieve the exact same effect (reducing the number of builds) using `ref.watch` instead. @@ -247,53 +269,73 @@ exact same effect (reducing the number of builds) using `ref.watch` instead. Providers offer various ways to obtain a value while reducing the number of rebuilds, which you could use instead. -예를 들어 +For example instead of -{trimSnippet(readNotifierBuild)} + -위의 코드 대신에 아래의 예시코드처럼 사용하는게 좋습니다. +we could do: -{trimSnippet(watchNotifierBuild)} + -두 코드의 효과는 동일합니다. 카운트 숫자 값이 변경되어도 버튼 위젯은 다시 빌드되지 않을 것입니다. +Both snippets achieve the same effect: our button will not rebuild when the +counter increments. -반면, 후자의 접근 방법은 카운터 값이 초기화되어도 대응이 가능합니다. -예를 들어, 애플리케이션의 다른 파트에서 아래의 메소드가 호출되면 +On the other hand, the second approach supports cases where the counter is reset. +For example, another part of the application could call: ```dart ref.refresh(counterProvider); ``` -`ref.refresh`가 호출됨으로 `StateController` 객체를 재생성할 것입니다. + + +which would recreate the `StateController` object. + +If we used `ref.read` here, our button would still use the previous +`StateController` instance, which was disposed and should no-longer be used. +Whereas using `ref.watch` correctly rebuilds the button to use the new +`StateController`. + + + + + +which would recreate the `Counter` object. -만약, 여기서 `ref.read`를 사용한다면 버튼은 여전이 이전 상태의 `StateController`인스턴스를 사용할 것입니다(disposed되었거나 더이상 사용하지 않는). -`ref.watch`를 사용하면 새로운 `StateController`가 가능한 상태로 버튼이 재빌드 됩니다. +If we used `ref.read` here, our button would still use the previous `Counter` +instance, which was disposed and should no-longer be used. Whereas using +`ref.watch` correctly rebuilds the button to use the new `Counter`. -## 무엇을 읽을지 결정하기 + -사용하는 프로바이더에 따라서, 취득 가능한 값의 종류가 다양해 질 수 있습니다. -예를 들어 [StreamProvider]를 사용한다고 생각해 봅시다. +## Deciding what to read + +Depending on the provider you want to listen to, you may have multiple possible +values that you can listen to. + +As an example, consider the following [StreamProvider]: ```dart final userProvider = StreamProvider(...); ``` -`userProvider`를 읽으려고 할때 아래와 같이 사용할 수 있습니다. -- `userProvider`자체를 구독하는 것으로 동기된(synchronously) 현재 상태 값을 읽을 수 있습니다. +When reading this `userProvider`, you can: + +- synchronously read the current state by listening to `userProvider` itself: ```dart Widget build(BuildContext context, WidgetRef ref) { AsyncValue user = ref.watch(userProvider); - return user.when( - loading: () => const CircularProgressIndicator(), - error: (error, stack) => const Text('Oops'), - data: (user) => Text(user.name), - ); + return switch (user) { + AsyncData(:final value) => Text(value.name), + AsyncError(:final error) => const Text('Oops $error'), + _ => const CircularProgressIndicator(), + }; } ``` -- `userProvider.stream`을 사용하여 연결된 [Stream]을 얻을 수 있습니다. +- obtain the associated [Stream], by listening to `userProvider.stream`: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -301,7 +343,7 @@ final userProvider = StreamProvider(...); } ``` -- `userProvider.future`를 사용해 가장 최근 상태값을 가진 [Future]를 얻을 수 있습니다. +- obtain a [Future] that resolves with the latest value emitted, by listening to `userProvider.future`: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -309,21 +351,21 @@ final userProvider = StreamProvider(...); } ``` -다른 프로바이더들은 또 다른 대안 값들(alternative values)을 제공할 수 있습니다. -더 자세한 정보를 원한다면 [API reference](https://pub.dev/documentation/riverpod/latest/riverpod/riverpod-library.html) -에 설명되어 있는 각각의 프로바이더에대한 상세한 정보를 참고하세요. +Other providers may offer different alternative values. +For more information, refer to the documentation of each provider by +consulting the [API reference](https://pub.dev/documentation/riverpod/latest/riverpod/riverpod-library.html). +## Using "select" to filter rebuilds -## "select"를 사용하여 재빌드 필터링하기 +One final feature to mention related to reading providers is the ability to +reduce the number of times a widget/provider rebuilds from `ref.watch`, or how often `ref.listen` +executes a function. -마지막 특징으로 a widget/provider의 재빌드를 수를 감소하거나 -제한하는 방법을 안내합니다. (얼마나 자주 `ref.listen` 실행하는지를 포함하여) +This is important to keep in mind as, by default, listening to a provider +listens to the entire object state. But sometimes, a widget/provider may only +care about changes to some properties instead of the whole object. - -프로바이더를 감시하는 것은, 그 프로바이더가 공개하는 객체의 모든 속성을 감시하는 것입니다. -그러나 특정 경우에서 구독 범위를 좁히고 특정 속성만 모니터링 대상으로 만들 수 있습니다. - -예를 들어, 프로바이더는 `User` 상태값을 가진다고 가정해 봅시다. +For example, a provider may expose a `User`: ```dart abstract class User { @@ -332,7 +374,7 @@ abstract class User { } ``` -그런데 위젯에서는 단순히 `User`의 `name`값만 사용하고 있습니다. +But a widget may only use the user name: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -341,13 +383,13 @@ Widget build(BuildContext context, WidgetRef ref) { } ``` -만약 `ref.watch`를 사용하면 `User`의 `age` 속성이 변경되면 위젯이 재빌드 될것입니다. - -여기서 해결방법은 `select`를 사용하는 것입니다. -`select`는 [Riverpod]에서 `User`의 특정 속성만 구독/관찰하고 싶을때 사용합니다. +If we naively used `ref.watch`, this would rebuild the widget when the user's +`age` changes. +The solution is to use `select` to explicitly tell Riverpod that we only +want to listen to the name property of the `User`. -코드를 다음과 같이 개선해 볼 수 있습니다. +The updated code would be: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -356,15 +398,17 @@ Widget build(BuildContext context, WidgetRef ref) { } ``` -`select`를 통해 관찰하고 싶은 상태값을 선택하여 -선택한 속성 값의 변화가 발생했을때 사용할 수 있습니다. +By using `select`, we are able to specify a function +that returns the property that we care about. -그리고 `User` 값이 변하면, [Riverpod]은 이 함수를 호출하여 이전 값과 새로운 값을 비교합니다. -만약 상태값이 다르다면(예를 들어 `name`이 변경되었다면), [Riverpod]은 위젯을 다시 빌드하는 작업을 처리할 겁니다. -그러나 만약 값이 같다면 (예를 들어 `age`만 변경되었다면), [Riverpod]은 위젯을 재빌드 하지 않을 겁니다. +Whenever the `User` changes, Riverpod will call this function and +compare the previous and new result. If they are different (such as when the name +changed), Riverpod will rebuild the widget. +However, if they are equal (such as when the age changed), Riverpod will not +rebuild the widget. :::info -`select`는 `ref.listen`과 함께 사용할 수 있습니다. +It is also possible to use `select` with `ref.listen`: ```dart ref.listen( @@ -374,13 +418,13 @@ ref.listen( } ); ``` -`name`이 변경되었을 때 호출되어 사용할 수 있는 구조를 가지게 됩니다. +Doing so will call the listener only when the name changes. ::: :::tip -`select`를 사용하는 경우 반환하는 값이 반드시 객체일 필요는 없습니다. -`==`연자자의 오버라이드(overrides)로 객체가 동일하다고 정의된다면 반환 값으로 무엇이 오든 상관없습니다. +You don't have to return a property of the object. Any value that +overrides == will work. For example you could do: ```dart final label = ref.watch(userProvider.select((user) => 'Mr ${user.name}')); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_hook.dart similarity index 71% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_hook.dart index 2d38c4cfc..5f296f2fb 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_hook.dart @@ -3,7 +3,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'reading_counter.dart'; +import 'counter/raw.dart'; class HomeView extends HookConsumerWidget { const HomeView({super.key}); @@ -15,10 +15,10 @@ class HomeView extends HookConsumerWidget { Scaffold( body: HookConsumer( builder: (context, ref, child) { - // HookConsumerWidget과 같이, builder안에서 hooks을 사용할 수 있습니다. + // Like HookConsumerWidget, we can use hooks inside the builder final state = useState(0); - // 프로바이더를 사용/구독(listen)하기 위해서 ref 매개변수도 사용할 수 있습니다. + // We can also use the ref parameter to listen to providers. final counter = ref.watch(counterProvider); return Text('$counter'); }, diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart new file mode 100644 index 000000000..7b9118cbc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart @@ -0,0 +1,34 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import '../counter/raw.dart'; + +/* SNIPPET START */ + +class HomeView extends StatefulHookConsumerWidget { + const HomeView({super.key}); + + @override + HomeViewState createState() => HomeViewState(); +} + +class HomeViewState extends ConsumerState { + @override + void initState() { + super.initState(); + // "ref" can be used in all life-cycles of a StatefulWidget. + ref.read(counterProvider); + } + + @override + Widget build(BuildContext context) { + // Like HookConsumerWidget, we can use hooks inside the builder + final state = useState(0); + + // We can also use "ref" to listen to a provider inside the build method + final counter = ref.watch(counterProvider); + return Text('$counter'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/index.tsx new file mode 100644 index 000000000..9c0ae43de --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import hooks from "!!raw-loader!./hooks.dart"; + +export default { + raw, + hooks: hooks, + codegen: raw, + hooksCodegen: hooks, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/raw.dart similarity index 69% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/raw.dart index c545e9b17..98d7f3403 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_stateful_widget.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/raw.dart @@ -1,6 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'reading_counter.dart'; +import '../counter/raw.dart'; /* SNIPPET START */ @@ -15,13 +15,13 @@ class HomeViewState extends ConsumerState { @override void initState() { super.initState(); - // "ref"는 StatefulWidget의 모든 생명주기 상에서 사용할 수 있습니다. + // "ref" can be used in all life-cycles of a StatefulWidget. ref.read(counterProvider); } @override Widget build(BuildContext context) { - // "ref"는 build 메소드 안에서 프로바이더를 구독(listen)하기위해 사용할 수 있습니다. + // We can also use "ref" to listen to a provider inside the build method final counter = ref.watch(counterProvider); return Text('$counter'); } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/hooks.dart similarity index 66% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/hooks.dart index 27db84a16..1c5547428 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_hook_widget.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/hooks.dart @@ -3,7 +3,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'reading_counter.dart'; +import '../counter/raw.dart'; /* SNIPPET START */ @@ -12,10 +12,10 @@ class HomeView extends HookConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // HookConsumerWidget은 build 메소드 안에서 hooks을 사용할 수 있도록 도와줍니다. + // HookConsumerWidget allows using hooks inside the build method final state = useState(0); - // 프로바이더를 사용/구독하기 위해서 ref 매개변수도 사용할 수 있습니다. + // We can also use the ref parameter to listen to providers. final counter = ref.watch(counterProvider); return Text('$counter'); } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/index.tsx new file mode 100644 index 000000000..9c0ae43de --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import hooks from "!!raw-loader!./hooks.dart"; + +export default { + raw, + hooks: hooks, + codegen: raw, + hooksCodegen: hooks, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/raw.dart similarity index 78% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/raw.dart index ffa37a065..d2df7c5a7 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_consumer_widget.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/raw.dart @@ -1,6 +1,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'reading_counter.dart'; +import '../counter/raw.dart'; /* SNIPPET START */ @@ -9,7 +9,7 @@ class HomeView extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // ref를 사용해 프로바이더 구독(listen)하기 + // use ref to listen to a provider final counter = ref.watch(counterProvider); return Text('$counter'); } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart new file mode 100644 index 000000000..a23405835 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart @@ -0,0 +1,24 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +Repository repository(RepositoryRef ref) => Repository(); + +class Repository { + Future post(String url) async {} +} + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; + + void increment() { + // Counter can use the "ref" to read other providers + final repository = ref.read(repositoryProvider); + repository.post('...'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart new file mode 100644 index 000000000..be9934548 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.g.dart @@ -0,0 +1,141 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RepositoryRef = Ref; + +@ProviderFor(repository) +const repositoryProvider = RepositoryProvider._(); + +final class RepositoryProvider + extends $FunctionalProvider + with $Provider { + const RepositoryProvider._( + {Repository Function( + RepositoryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'repositoryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Repository Function( + RepositoryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$repositoryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Repository value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RepositoryProvider $copyWithCreate( + Repository Function( + RepositoryRef ref, + ) create, + ) { + return RepositoryProvider._(create: create); + } + + @override + Repository create(RepositoryRef ref) { + final _$cb = _createCb ?? repository; + return _$cb(ref); + } +} + +String _$repositoryHash() => r'c6dc3b5b727028966b5b850b27ffc7294b485273'; + +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterHash() => r'6bd7806869af024b3288645da03c077af9478083'; + +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart similarity index 83% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart index 122acb3a0..5d248ab57 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart @@ -19,7 +19,7 @@ class Counter extends StateNotifier { final Ref ref; void increment() { - // Counter 클래스는 다른 프로바이더를 읽기 위해 "ref"를 사용할 수 있습니다. + // Counter can use the "ref" to read other providers final repository = ref.read(repositoryProvider); repository.post('...'); } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.dart new file mode 100644 index 000000000..ad031e82b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.dart @@ -0,0 +1,18 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int counter(CounterRef ref) => 0; + +/* SNIPPET START */ + +@riverpod +void another(AnotherRef ref) { + ref.listen(counterProvider, (int? previousCount, int newCount) { + print('The counter changed $newCount'); + }); + // ... +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart new file mode 100644 index 000000000..3fc6922f1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/codegen.g.dart @@ -0,0 +1,131 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CounterRef = Ref; + +@ProviderFor(counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $FunctionalProvider + with $Provider { + const CounterProvider._( + {int Function( + CounterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CounterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CounterProvider $copyWithCreate( + int Function( + CounterRef ref, + ) create, + ) { + return CounterProvider._(create: create); + } + + @override + int create(CounterRef ref) { + final _$cb = _createCb ?? counter; + return _$cb(ref); + } +} + +String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; + +typedef AnotherRef = Ref; + +@ProviderFor(another) +const anotherProvider = AnotherProvider._(); + +final class AnotherProvider extends $FunctionalProvider + with $Provider { + const AnotherProvider._( + {void Function( + AnotherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'anotherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final void Function( + AnotherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$anotherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(void value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + AnotherProvider $copyWithCreate( + void Function( + AnotherRef ref, + ) create, + ) { + return AnotherProvider._(create: create); + } + + @override + void create(AnotherRef ref) { + final _$cb = _createCb ?? another; + return _$cb(ref); + } +} + +String _$anotherHash() => r'2208f9221f3d898305609874d4f43c28bdfff2b4'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/raw.dart similarity index 68% rename from website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/raw.dart index 4f6829a9e..ab229db6e 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen/raw.dart @@ -1,13 +1,10 @@ -import 'package:flutter_riverpod/legacy.dart'; // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print import 'package:riverpod/riverpod.dart'; -import 'reading_counter.dart'; +import '../counter/raw.dart'; /* SNIPPET START */ -final counterProvider = StateNotifierProvider(Counter.new); - final anotherProvider = Provider((ref) { ref.listen(counterProvider, (int? previousCount, int newCount) { print('The counter changed $newCount'); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.dart new file mode 100644 index 000000000..e22f4b169 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.dart @@ -0,0 +1,28 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; +} + +class HomeView extends ConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(counterProvider, (int? previousCount, int newCount) { + print('The counter changed $newCount'); + }); + + return Container(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart new file mode 100644 index 000000000..105a6133f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterHash() => r'4320f811608c7a6e7342b83e3031965a34f7cb8e'; + +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart new file mode 100644 index 000000000..5b1147d28 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart @@ -0,0 +1,34 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_hooks.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; +} + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(counterProvider, (int? previousCount, int newCount) { + print('The counter changed $newCount'); + }); + + final greeting = useState('Hello'); + + return Container( + alignment: Alignment.center, + child: Text(greeting.value), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart new file mode 100644 index 000000000..a6d55dcde --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_hooks.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterHash() => r'4320f811608c7a6e7342b83e3031965a34f7cb8e'; + +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx new file mode 100644 index 000000000..a856c4980 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx @@ -0,0 +1,11 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; +import codegen_hooks from "!!raw-loader!./codegen_hooks.dart"; + +export default { + raw, + hooks: raw_hooks, + codegen, + hooksCodegen: codegen_hooks, +}; diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw.dart similarity index 95% rename from website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw.dart index 0d94f0d08..cb84d2b9b 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/reading_listen_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw.dart @@ -4,7 +4,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; -import 'reading_counter.dart'; +import '../counter/raw.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart new file mode 100644 index 000000000..ac38732a5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart @@ -0,0 +1,29 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import '../counter/raw.dart'; + +/* SNIPPET START */ + +final counterProvider = StateNotifierProvider(Counter.new); + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(counterProvider, (int? previousCount, int newCount) { + print('The counter changed $newCount'); + }); + + final greeting = useState('Hello'); + + return Container( + alignment: Alignment.center, + child: Text(greeting.value), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart new file mode 100644 index 000000000..201c92f91 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart @@ -0,0 +1,20 @@ +// ignore_for_file: avoid_positional_boolean_parameters +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class Repository { + String get() => ''; +} + +@riverpod +Repository repository(RepositoryRef ref) => Repository(); + +/* SNIPPET START */ + +@riverpod +String value(ValueRef ref) { + // use ref to obtain other providers + final repository = ref.watch(repositoryProvider); + return repository.get(); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart new file mode 100644 index 000000000..d27f8eaca --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.g.dart @@ -0,0 +1,132 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RepositoryRef = Ref; + +@ProviderFor(repository) +const repositoryProvider = RepositoryProvider._(); + +final class RepositoryProvider + extends $FunctionalProvider + with $Provider { + const RepositoryProvider._( + {Repository Function( + RepositoryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'repositoryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Repository Function( + RepositoryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$repositoryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Repository value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RepositoryProvider $copyWithCreate( + Repository Function( + RepositoryRef ref, + ) create, + ) { + return RepositoryProvider._(create: create); + } + + @override + Repository create(RepositoryRef ref) { + final _$cb = _createCb ?? repository; + return _$cb(ref); + } +} + +String _$repositoryHash() => r'c6dc3b5b727028966b5b850b27ffc7294b485273'; + +typedef ValueRef = Ref; + +@ProviderFor(value) +const valueProvider = ValueProvider._(); + +final class ValueProvider extends $FunctionalProvider + with $Provider { + const ValueProvider._( + {String Function( + ValueRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'valueProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + ValueRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$valueHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ValueProvider $copyWithCreate( + String Function( + ValueRef ref, + ) create, + ) { + return ValueProvider._(create: create); + } + + @override + String create(ValueRef ref) { + final _$cb = _createCb ?? value; + return _$cb(ref); + } +} + +String _$valueHash() => r'8c26f7aaa911af815cff9e513a18e4d8dcc6d1df'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart new file mode 100644 index 000000000..28fdfed97 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart @@ -0,0 +1,19 @@ +// ignore_for_file: avoid_positional_boolean_parameters + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Repository { + void get() {} +} + +final repositoryProvider = Provider((ref) { + return Repository(); +}); + +/* SNIPPET START */ + +final valueProvider = Provider((ref) { + // use ref to obtain other providers + final repository = ref.watch(repositoryProvider); + return repository.get(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart new file mode 100644 index 000000000..0742ed5e5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart @@ -0,0 +1,32 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; + void increment() => state = state + 1; +} + +class HomeView extends ConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + floatingActionButton: FloatingActionButton( + onPressed: () { + // Call `increment()` on the `Counter` class + ref.read(counterProvider.notifier).increment(); + }, + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart new file mode 100644 index 000000000..9b6f2d253 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; + +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart new file mode 100644 index 000000000..341087cde --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart @@ -0,0 +1,36 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_hooks.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; + void increment() => state = state + 1; +} + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final greeting = useState('Hello'); + + return Scaffold( + body: Center(child: Text(greeting.value)), + floatingActionButton: FloatingActionButton( + onPressed: () { + // Call `increment()` on the `Counter` class + ref.read(counterProvider.notifier).increment(); + }, + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart new file mode 100644 index 000000000..681ff8533 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_hooks.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; + +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx new file mode 100644 index 000000000..d0caf89aa --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx @@ -0,0 +1,11 @@ +import raw from "!!raw-loader!./raw.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; +import codegen from "!!raw-loader!./codegen.dart"; +import codegen_hooks from "!!raw-loader!./codegen_hooks.dart"; + +export default { + raw, + hooks: raw_hooks, + codegen, + hooksCodegen: codegen_hooks, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart similarity index 74% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart index acf5898e3..c30eeb5f2 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart @@ -4,12 +4,11 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; -import 'reading_counter.dart'; +import '../counter/raw.dart'; /* SNIPPET START */ -final counterProvider = - StateNotifierProvider(Counter.new); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { const HomeView({super.key}); @@ -19,7 +18,7 @@ class HomeView extends ConsumerWidget { return Scaffold( floatingActionButton: FloatingActionButton( onPressed: () { - // `Counter`클래스의 increment() 메소드를 호출합니다. + // Call `increment()` on the `Counter` class ref.read(counterProvider.notifier).increment(); }, ), diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart new file mode 100644 index 000000000..bde77d3a8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart @@ -0,0 +1,31 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../counter/raw.dart'; + +/* SNIPPET START */ + +final counterProvider = StateNotifierProvider(Counter.new); + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final greeting = useState('Hello'); + + return Scaffold( + body: Center(child: Text(greeting.value)), + floatingActionButton: FloatingActionButton( + onPressed: () { + // Call `increment()` on the `Counter` class + ref.read(counterProvider.notifier).increment(); + }, + ), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart new file mode 100644 index 000000000..9a4347159 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart @@ -0,0 +1,25 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; + void increment() => state = state + 1; +} + +Widget build(BuildContext context, WidgetRef ref) { + // use "read" to ignore updates on a provider + final counter = ref.read(counterProvider.notifier); + return ElevatedButton( + onPressed: counter.increment, + child: const Text('button'), + ); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart new file mode 100644 index 000000000..9b6f2d253 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; + +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart similarity index 85% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart index 52098b6fd..f90cd968f 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart @@ -9,7 +9,7 @@ import 'package:flutter_riverpod/legacy.dart'; final counterProvider = StateProvider((ref) => 0); Widget build(BuildContext context, WidgetRef ref) { - // 프로바이더 상태 값 갱신을 무시하기위해서 "read" 사용 + // use "read" to ignore updates on a provider final counter = ref.read(counterProvider.notifier); return ElevatedButton( onPressed: () => counter.state++, diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.dart new file mode 100644 index 000000000..6bf061abf --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; + void increment() => state = state + 1; +} + +Widget build(BuildContext context, WidgetRef ref) { + Counter counter = ref.read(counterProvider.notifier); + return ElevatedButton( + onPressed: () => counter.increment(), + child: const Text('button'), + ); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart new file mode 100644 index 000000000..9b6f2d253 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/codegen.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; + +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/raw.dart similarity index 100% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_read_notifier_build.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/read_notifier_build/raw.dart diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart new file mode 100644 index 000000000..31de6da74 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart @@ -0,0 +1,45 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +enum FilterType { + none, + completed, +} + +abstract class Todo { + bool get isCompleted; +} + +/* SNIPPET START */ + +@riverpod +FilterType filterType(FilterTypeRef ref) { + return FilterType.none; +} + +@riverpod +class Todos extends _$Todos { + @override + List build() { + return []; + } +} + +@riverpod +List filteredTodoList(FilteredTodoListRef ref) { + // obtains both the filter and the list of todos + final FilterType filter = ref.watch(filterTypeProvider); + final List todos = ref.watch(todosProvider); + + switch (filter) { + case FilterType.completed: + // return the completed list of todos + return todos.where((todo) => todo.isCompleted).toList(); + case FilterType.none: + // returns the unfiltered list of todos + return todos; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart new file mode 100644 index 000000000..5188a21eb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.g.dart @@ -0,0 +1,201 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef FilterTypeRef = Ref; + +@ProviderFor(filterType) +const filterTypeProvider = FilterTypeProvider._(); + +final class FilterTypeProvider + extends $FunctionalProvider + with $Provider { + const FilterTypeProvider._( + {FilterType Function( + FilterTypeRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filterTypeProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FilterType Function( + FilterTypeRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filterTypeHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(FilterType value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilterTypeProvider $copyWithCreate( + FilterType Function( + FilterTypeRef ref, + ) create, + ) { + return FilterTypeProvider._(create: create); + } + + @override + FilterType create(FilterTypeRef ref) { + final _$cb = _createCb ?? filterType; + return _$cb(ref); + } +} + +String _$filterTypeHash() => r'42b68b163daecff7a0b9b069b16025a89910b4fb'; + +typedef FilteredTodoListRef = Ref>; + +@ProviderFor(filteredTodoList) +const filteredTodoListProvider = FilteredTodoListProvider._(); + +final class FilteredTodoListProvider + extends $FunctionalProvider, List, FilteredTodoListRef> + with $Provider, FilteredTodoListRef> { + const FilteredTodoListProvider._( + {List Function( + FilteredTodoListRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filteredTodoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + FilteredTodoListRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filteredTodoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilteredTodoListProvider $copyWithCreate( + List Function( + FilteredTodoListRef ref, + ) create, + ) { + return FilteredTodoListProvider._(create: create); + } + + @override + List create(FilteredTodoListRef ref) { + final _$cb = _createCb ?? filteredTodoList; + return _$cb(ref); + } +} + +String _$filteredTodoListHash() => r'34f1e929a9e7850946ea8634d9f3e8f38ae5687d'; + +@ProviderFor(Todos) +const todosProvider = TodosProvider._(); + +final class TodosProvider extends $NotifierProvider> { + const TodosProvider._( + {super.runNotifierBuildOverride, Todos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Todos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + Todos create() => _createCb?.call() ?? Todos(); + + @$internal + @override + TodosProvider $copyWithCreate( + Todos Function() create, + ) { + return TodosProvider._(create: create); + } + + @$internal + @override + TodosProvider $copyWithBuild( + List Function( + Ref>, + Todos, + ) build, + ) { + return TodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todosHash() => r'b66ac2b1e5cf7ac7957d25864cfdffad1af233a6'; + +abstract class _$Todos extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart similarity index 81% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart index bf82e165d..bde11d2e4 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart @@ -23,16 +23,16 @@ final todosProvider = StateNotifierProvider>((ref) => TodoList()); final filteredTodoListProvider = Provider((ref) { - // 할일(todos)목록과 필터(filter)상태 값을 취득합니다. + // obtains both the filter and the list of todos final FilterType filter = ref.watch(filterTypeProvider); final List todos = ref.watch(todosProvider); switch (filter) { case FilterType.completed: - // 완료된(completed) 할일 목록을 반환합니다. + // return the completed list of todos return todos.where((todo) => todo.isCompleted).toList(); case FilterType.none: - // 필터링되지 않은 목록을 반환합니다. + // returns the unfiltered list of todos return todos; } }); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart new file mode 100644 index 000000000..80b63d216 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart @@ -0,0 +1,39 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +enum FilterType { + none, + completed, +} + +abstract class Todo { + bool get isCompleted; +} + +@riverpod +class TodoList extends _$TodoList { + @override + List build() => []; +} + +/* SNIPPET START */ + +@riverpod +int counter(CounterRef ref) => 0; + +class HomeView extends ConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // use ref to listen to a provider + final counter = ref.watch(counterProvider); + + return Text('$counter'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart new file mode 100644 index 000000000..a977df7b6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.g.dart @@ -0,0 +1,140 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CounterRef = Ref; + +@ProviderFor(counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $FunctionalProvider + with $Provider { + const CounterProvider._( + {int Function( + CounterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CounterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CounterProvider $copyWithCreate( + int Function( + CounterRef ref, + ) create, + ) { + return CounterProvider._(create: create); + } + + @override + int create(CounterRef ref) { + final _$cb = _createCb ?? counter; + return _$cb(ref); + } +} + +String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; + +@ProviderFor(TodoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider extends $NotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + List Function( + Ref>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todoListHash() => r'77f007cd4f5105330a4c2ab8555ea0d1716945c1'; + +abstract class _$TodoList extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart new file mode 100644 index 000000000..c82698304 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart @@ -0,0 +1,43 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_hooks.g.dart'; + +enum FilterType { + none, + completed, +} + +abstract class Todo { + bool get isCompleted; +} + +@riverpod +class TodoList extends _$TodoList { + @override + List build() => []; +} + +/* SNIPPET START */ + +@riverpod +int counter(CounterRef ref) => 0; + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // You can use hooks inside a HookConsumerWidget + final greeting = useState('Hello'); + + // use ref to listen to a provider + final counter = ref.watch(counterProvider); + + return Text('${greeting.value} $counter'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart new file mode 100644 index 000000000..172d4ee49 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart @@ -0,0 +1,140 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_hooks.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CounterRef = Ref; + +@ProviderFor(counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $FunctionalProvider + with $Provider { + const CounterProvider._( + {int Function( + CounterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CounterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CounterProvider $copyWithCreate( + int Function( + CounterRef ref, + ) create, + ) { + return CounterProvider._(create: create); + } + + @override + int create(CounterRef ref) { + final _$cb = _createCb ?? counter; + return _$cb(ref); + } +} + +String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; + +@ProviderFor(TodoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider extends $NotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + List Function( + Ref>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todoListHash() => r'77f007cd4f5105330a4c2ab8555ea0d1716945c1'; + +abstract class _$TodoList extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx new file mode 100644 index 000000000..a856c4980 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx @@ -0,0 +1,11 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; +import codegen_hooks from "!!raw-loader!./codegen_hooks.dart"; + +export default { + raw, + hooks: raw_hooks, + codegen, + hooksCodegen: codegen_hooks, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart similarity index 92% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart index 472b04626..90639ac8c 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_build.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart @@ -26,7 +26,7 @@ class HomeView extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // ref를 사용하여 프로바이더 구독하기. + // use ref to listen to a provider final counter = ref.watch(counterProvider); return Text('$counter'); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart new file mode 100644 index 000000000..f125f6553 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart @@ -0,0 +1,38 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +enum FilterType { + none, + completed, +} + +abstract class Todo { + bool get isCompleted; +} + +class TodoList extends StateNotifier> { + TodoList() : super([]); +} + +/* SNIPPET START */ + +final counterProvider = StateProvider((ref) => 0); + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // You can use hooks inside a HookConsumerWidget + final greeting = useState('Hello'); + + // use ref to listen to a provider + final counter = ref.watch(counterProvider); + + return Text('${greeting.value} $counter'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.dart new file mode 100644 index 000000000..6b76d0219 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; + void increment() => state = state + 1; +} + +Widget build(BuildContext context, WidgetRef ref) { + Counter counter = ref.watch(counterProvider.notifier); + return ElevatedButton( + onPressed: () => counter.increment(), + child: const Text('button'), + ); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart new file mode 100644 index 000000000..9b6f2d253 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/codegen.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; + +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/raw.dart similarity index 100% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading_watch_notifier_build.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/reading/watch_notifier_build/raw.dart diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/scopes.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/scopes.mdx new file mode 100644 index 000000000..f53d8315d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/scopes.mdx @@ -0,0 +1,180 @@ +--- +title: Scopes +--- + +import CodeBlock from "@theme/CodeBlock"; +import asyncInitialization from "!!raw-loader!/docs/concepts/async_initialization.dart"; +import dialogScope from "!!raw-loader!/docs/concepts/dialog_scope.dart"; +import themeScope from "!!raw-loader!/docs/concepts/theme_scope.dart"; +import subtreeScope from "!!raw-loader!/docs/concepts/subtree_scope.dart"; +import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import { Link } from "../../../../../src/components/Link"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + +Scoping in Riverpod is a very powerful feature, but like all powerful features, it should be used wisely and intentionally. + +A few of the things that scoping enables are: + +- Override the state of providers for a specific subtree (similar to how theming and `InheritedWidgets` work in flutter) [(see example)](#subtree-scope) +- Creating synchronous providers for normally async APIs [(see example)](#initialization-of-synchronous-provider-for-async-apis) +- Allowing `Dialog`s and `Overlay`s to inherit the state of providers from the widget subtree that cause them to be shown [(see example)](#showing-dialogs) +- Optimizing rebuilds of widgets by removing parameters from Widget constructors allowing you to make them `const` + +If you are wanting to use scope for the first point, chances are you can use families instead. +Families have the advantages of allowing you to access each of those instances of the state from anywhere in the widget tree rather than just the state scoped to the specific subtree that you are in. + +Using scope to create multiple instances of a provider's state is similar to how `package:provider` works. + +However, using scope to accomplish that task, is more restrictive, as you cannot decide to access other instances from that scope. + +As such, before scoping every provider you use, consider carefully why you want to scope the provider. + +## ProviderScope and ProviderContainer + +A scope is introduced by a [ProviderContainer]. This container holds the current state of all of your providers. +It manages the lookup and subscriptions between providers. + +In Flutter you should use the [ProviderScope] widget, which contains a [ProviderContainer] +internally, and provides a way to access that container to the rest of the widget tree. + +```dart +final valueProvider = StateProvider((ref) => 0); + +// DO this +void main() { + runApp(ProviderScope(child: MyApp())); +} + +//DON'T do this: +final myProviderContainer = ProviderContainer(); +void main(){ + runApp(MyApp()); +} +``` + +:::warning +Do not use multiple [ProviderContainer]s, without an understanding of how they work. +Each will have it's own separate thread of states, which will not be able to access each other. +Tests are an example of when you might want to use separate [ProviderContainer]s +in order to make each test's state independent of the others. +::: + +Only create a [ProviderContainer] without a [ProviderScope] for testing and dart-only usage. + +## How Riverpod Finds a Provider + +When a widget or provider requests the value of a provider, Riverpod looks up the state of that provider in the nearest +[ProviderScope] widget. If neither the provider nor one of it's explicitly listed dependencies is overridden in that scope Riverpod continues it's lookup up the widget tree. +If the provider has not been overridden in any Widget subtrees the lookup defaults to the [ProviderContainer] in the root [ProviderScope]. + +Once this process locates the scope in which the provider should reside it determines if the provider has been created yet. +If so, it will return the state of the provider. +However, if the provider has been invalidated or is not currently initialized it will create the state using the provider's build method. + +## Initialization of Synchronous Provider for Async APIs + +Often you might have some async initialization of a dependency such as `SharedPreferences` or `FirebaseApp`. +Many other providers might rely on this, and dealing with the error / loading states in each of those providers is redundant. + +You might be able to guarantee that those providers will not have errors and will load quickly when the app is started. + +So how do you makes these sorts of provider states available synchronously? + +Here is an example that shows how scoping allows you override a dummy provider when your asynchronous API is ready. + +{trimSnippet(asyncInitialization)} + +## Showing Dialogs + +When you show a `Dialog` or `OverlayEntry`, flutter creates a new `Route` or adds to an `Overlay` that has a different build scope, +so that it can escape the layout of it's parent, and can be shown above other `Routes`. +This presents a problem for `InheritedWidget`s in general, and since [ProviderScope] is an `InheritedWidget`, it is also affected. + +To solve this problem, Riverpod allows you to create a `ProviderScope` that can access the state of all providers in a `parent` scope. + +The following example shows how to use this, to allow a `Dialog` to access the state of a counter from the context that caused the `Dialog` to be shown. + +{trimSnippet(dialogScope)} + +## Subtree Scoping + +Scoping allows you to override the state of a provider for a specific subtree of your widget tree. +In this way it can provide a similar mechanism to `InheritedWidget` from flutter, or the providers from `package:provider`. + +For example, in flutter you can override the `Theme` for a particular subtree of your widget tree, by wrapping it in a `Theme` widget. + +{trimSnippet(themeScope)} + +Under the hood, `Theme` is an `InheritedWidget` and when widgets look up the `Theme` they get the `Theme` from the nearest `Theme` widget above it in the widget tree. + +Riverpod works differently, since all of the state of your application is typically stored in a root [ProviderScope] widget. +Don't worry, this doesn't cause your whole application to rebuild when the state changes, it just allows you to access the state from anywhere in your widget tree. + +What if you want different providers depending on which page you are in? + +The first thing that you should consider is whether the provided behavior will differ in any way. + +If so -> just create a new provider with a different name and use it in that page + +If not -> Consider using a . + +Often you start by thinking that you only need a provider on a particular page, but end up wanting to use it in another page later on. +Families protect you against this eventuality, and are a major difference in how you should adjust your thinking if you are coming from `package:provider`. + +If families really do not fit your use case, the following example shows you how to override a provider for a particular subtree. + +{trimSnippet(subtreeScope)} + +## When to choose Scoped Providers or Families + +While scopes are important to understand, it is easy to get carried away when using scopes. + +If you want a different instance of a provider's state depending on where it is in the widget tree you have a few alternatives available to you: `Scoping`, `Families`, or a combination. +The appropriate choice depends on your use case. + +Families: + +- Pro: You can show multiple of the states no matter which subtree you are in +- Pro: This makes it a more flexible and scalable solution for many use cases + +Scoping: + +- Con: You end up with more nesting of [ProviderScope] widgets in your widget tree +- Con: You can only access the one override in your section of the widget tree +- Con: You end up having to explicitly list the dependencies of most of your providers +- Pro: You can reduce the number of parameters in your widget constructors +- Pro: You get a slight performance advantage, and can potentially make some of your widget constructors `const` + +Using a combination of the two approaches, you can get the pros of both approaches, but you still have to deal with the cons of scoping. + +:::warning +Remember that scopes introduce a new instance of the state of every provider that is overridden or has listed a dependency on a provider that was overridden. +If you override with the same parameter in a different subtree of the app, it will **not** be the same instance of the provider's state. +Families are more flexible in general, and with the upcoming code generation feature it is easy to use multiple parameters for a family. +Often a good combination is to use both families and scoping. Use a family to provide general access to a piece of state anywhere in your app, and then use scoping to +provide a specific instance of the family's state depending on where you are in the widget tree. +::: + +### Less common usages of Scopes + +Sometimes you may want to override a whole set of providers in a specific subtree of your app. +By listing a common provider in the dependencies list of each of those providers, you can easily create new states for all of them at once, by overriding the common one. + +Note that if you try to use families for this, you will end up with many families that all have the same parameter, and you could end up passing that parameter all over the widget tree. +In this case it is also acceptable to use scopes. + +:::warning +Once you start using scope, make sure to always list your dependencies and keep them up to date, to prevent runtime exceptions. +To help with this we have created [riverpod_lint] which will warn you if there is a missing dependency. +Additionally with [riverpod_generator] the code generator automatically generates the dependency list. +::: + +[ProviderContainer]: https://pub.dev/documentation/riverpod/latest/riverpod/ProviderContainer-class.html +[ProviderScope]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ProviderScope-class.html +[riverpod_lint]: https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint +[riverpod_generator]: https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_generator diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart new file mode 100644 index 000000000..31d6bc5bd --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart @@ -0,0 +1,79 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ + +/// A counter that is being incremented by each [CounterDisplay]'s ElevatedButton +final counterProvider = StateProvider( + (ref) => 0, +); + +final adjustedCountProvider = Provider( + (ref) => ref.watch(counterProvider) * 2, + // Note that if a provider depends on a provider that is overridden for a subtree, + // you must explicitly list that provider in your dependencies list. + dependencies: [counterProvider], +); + +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + body: Column( + children: [ + ProviderScope( + /// Just specify which provider you want to have a copy of in the subtree + /// + /// Note that dependant providers such as [adjustedCountProvider] will + /// also be copied for this subtree. If that is not the behavior you want, + /// consider using families instead + overrides: [counterProvider], + child: const CounterDisplay(), + ), + ProviderScope( + // You can change the provider's behavior in a particular subtree + overrides: [counterProvider.overrideWith((ref) => 1)], + child: const CounterDisplay(), + ), + ProviderScope( + overrides: [ + counterProvider, + // You can also change dependent provider's behaviors + adjustedCountProvider.overrideWith( + (ref) => ref.watch(counterProvider) * 3, + ), + ], + child: const CounterDisplay(), + ), + // This particular display will use the provider state from the root ProviderScope + const CounterDisplay(), + ], + ),); + } +} + +class CounterDisplay extends ConsumerWidget { + const CounterDisplay({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final count = ref.watch(counterProvider); + return Column( + mainAxisSize: MainAxisSize.min, + children: [ + Text('$count'), + ElevatedButton( + onPressed: () { + ref.read(counterProvider.notifier).state++; + }, + child: const Text('Increment Count'), + ), + ], + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart new file mode 100644 index 000000000..ccd34647d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart @@ -0,0 +1,69 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ + +void main() { + runApp( + ProviderScope( + child: MaterialApp( + theme: ThemeData(primaryColor: Colors.blue), + home: const Home(), + ), + ), + ); +} + +// Have a counter that is being incremented +final counterProvider = StateProvider( + (ref) => 0, +); + +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + body: Column( + children: [ + // This counter will have a primary color of green + Theme( + data: Theme.of(context).copyWith(primaryColor: Colors.green), + child: const CounterDisplay(), + ), + // This counter will have a primary color of blue + const CounterDisplay(), + ElevatedButton( + onPressed: () { + ref.read(counterProvider.notifier).state++; + }, + child: const Text('Increment Count'), + ), + ], + ),); + } +} + +class CounterDisplay extends ConsumerWidget { + const CounterDisplay({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final count = ref.watch(counterProvider); + final theme = Theme.of(context); + return Column( + mainAxisSize: MainAxisSize.min, + children: [ + Text( + '$count', + style: theme.textTheme.displayMedium + ?.copyWith(color: theme.primaryColor), + ), + ], + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx index bb4ecd124..4e23da9fc 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx @@ -1,124 +1,94 @@ --- -title: 불변성(Immutability)의 중요성 +title: Why Immutability --- import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; +import whyImmutability from "./why_immutability" +import { + trimSnippet, + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -## 불변성(Immutability)이란? +## What is Immutability? -불변성은 객체의 모든 필드가 final 또는 late final인 경우를 의미합니다. -이러한 필드들은 생성 시에만 설정되며, 이후에는 변경할 수 없습니다. +Immutability is when all fields of an `Object` are final or late final. +They are set exactly once upon construction. -불변성은 여러 가지 이유에서 유용합니다. +Immutability is desireable for many different reasons -- reference equality(레퍼런스 동등성)이 아닌 value equality(값의 동등성)을 가져옵니다. -- 코드의 지역적인 이해가 용이해집니다. - - 다른 곳에 있는 코드가 레퍼런스에 접근하여 객체를 변경하는 것을 방지할 수 있습니다 -- 비동기 및 병렬 작업에 대해 이해하기 쉬워집니다. - - 작업 사이에 다른 코드가 객체를 변경할 수 없습니다. -- API의 안전성이 보장됩니다. - - 메서드에 전달한 객체는 호출자 또는 피호출자에 의해 변경될 수 없습니다. +- Value equality rather than reference equality +- Local reasoning about a piece of code + - A far distant piece of code can't obtain a reference and change the object from underneath you +- Easier to reason about for asynchronous and parallel tasks + - Other code can't mutate your object in between operations +- Safety of APIs + - What you pass into a method cannot be changed by the callee / caller -copyWith 메서드는 기존 객체에서 몇 가지 속성만 변경된 새로운 객체를 생성할 때, 코드의 복잡도를 줄이는 데 도움이 될 수 있습니다. +A copyWith method helps with reducing verbosity when creating a new object with just a few things changed. -복사 작업은 예상보다 더 효율적입니다. 왜냐하면 Dart는 변경되지 않은 하위 객체에 대한 참조를 재사용할 수 있기 때문입니다. +Copying is more efficient than you might think, since dart can reuse any references to sub-objects that have not changed. :::warning -객체가 깊은 불변성(deeply immutable)을 가지고 있는지 확인하십시오. 그렇지 않으면 당신은 깊은 복사 메커니즘을 구현해야 할 수 있습니다. +Make sure your objects are deeply immutable, otherwise you'll have to implement some sort of deep copy mechanism. ::: -## 최적의 방법 +## Best Practices -불변 상태를 만들기 위해 다양한 패키지를 이용할 수 있습니다. +You can use any package you want to create immutable state. -immutable한 객체의 경우 +For immutable objects: - [package:freezed](https://pub.dev/packages/freezed) - [package:built_value](https://pub.dev/packages/built_value) -immutable한 컬렉션의 경우 (Map, Set, List) +For immutable collections (Map, Set, List): - [package:fast_immutable_collections](https://pub.dev/packages/fast_immutable_collections) - [package:built_collection](https://pub.dev/packages/built_collection) - [package:kt_dart](https://pub.dev/packages/kt_dart) - [package:dartz](https://pub.dev/packages/dartz) -[freezed] 사용을 높이 권장합니다. -이 패키지에는 불변의 객체를 만드는 것 이외에도 몇 가지 멋진 추가 기능들이 있습니다. +It is highly recommended to use [freezed], +since it has several nice additions beyond just making immutable objects including: -- copyWith 메서드 -- 깊은 복사 (중첩된 freezed 객체의 copyWith) -- Union 타입 -- Union 매핑 함수 +- A generated copyWith method +- Deep copy (copyWith on nested freezed objects) +- Union types +- Union mapping functions -불변 상태를 다루기 위해 code generation을 사용해야 할 필요는 없지만, 이를 사용하면 작업이 더 쉬워집니다. +You do not need to use code generation to work with immutable state, but it makes it much easier. :::warning -빌트인 컬렉션을 사용하려면, 업데이트할 때 컬렉션을 복사하는 규칙을 강제해야 합니다. -컬렉션을 복사하지 않으면 riverpod는 객체에 대한 레퍼런스가 변경되었는지를 기반으로 새 상태를 전달할지 결정합니다. -객체를 변경하는 메서드를 단순히 호출한다면, 레퍼런스는 이전과 동일하기 때문에 객체가 변경되지 않을 수 있습니다. +If you want to use the built-in collections, make sure to enforce a discipline of making copies of collections when updating them. +The issue with not copying a collection is that riverpod determines whether to emit a new state based on whether the reference to the object has changed. +If you just call a method that mutates an object, the reference is the same. ::: -### 불변 상태 사용하기 - -불변 상태는 [StateNotifier]와 [StateNotifierProvider]를 결합하여 사용하는 것이 가장 적합합니다. -[StateNotifier]를 사용하면 상태를 '변경'할 수 있는 인터페이스를 노출할 수 있습니다. -[StateNotifier]를 확장하는 클래스 밖에서는 상태를 변경할 수 없으므로, 역할 분리를 강제하고 비즈니스 로직을 UI 바깥에 유지할 수 있습니다. - -다음은 앱 테마를 변경하는 불변 상태의 설정 클래스 예제입니다. - -```dart -final themeProvider = StateNotifierProvider((ref) => ThemeNotifier()); - -class ThemeNotifier extends StateNotifier { - ThemeNotifier(): super( - ThemeSettings( - mode: ThemeMode.system, - primaryColor: Colors.blue, - )); - - void toggle() { - state = state.copyWith(mode: state.mode.toggle); - } - void setDarkTheme() { - state = state.copyWith(mode: ThemeMode.dark); - } - void setLightTheme() { - state = state.copyWith(mode: ThemeMode.light); - } - void setSystemTheme() { - state = state.copyWith(mode: ThemeMode.system); - } - void setPrimaryColor(Color color) { - state = state.copyWith(primaryColor: color); - } - -} - -@freezed -class ThemeSettings with _$ThemeSettings { - const factory ThemeSettings({ThemeMode mode, Color primaryColor}) = _ThemeSettings; -} - -extension ToggleTheme on ThemeMode { - ThemeMode get toggle { - switch (this){ - case ThemeMode.dark: - return ThemeMode.light; - case ThemeMode.light: - return ThemeMode.dark; - case ThemeMode.system: - return ThemeMode.system; - } - } -} -``` -이 코드를 적용하려면, 'freezed_annotation'을 import하고 part 지시문을 추가한 후, [build_runner]를 실행하여 freezed 클래스를 생성해야 하는 것을 기억하세요! +### Using immutable state + +Immutable state is best fit for using a [Notifier] in combination with [NotifierProvider] . +A [Notifier] allows you to expose an interface through which you can 'mutate' the state. +You cannot mutate the state from outside the class you define that extends [Notifier]. +This enforces a separation of concerns and keeps business logic outside of your UI. + +Here is an example of a simple immutable settings class for changing an app theme. + + + +To use this code, remember to import `freezed_annotation`, add the part directive and run [build_runner] to generate the freezed classes! [changenotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html [statenotifier]: https://pub.dev/documentation/riverpod/latest/riverpod/StateNotifier-class.html [statenotifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/StateNotifierProvider-class.html +[notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html +[notifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/NotifierProvider.html [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html [freezed]: https://pub.dev/packages/freezed [build_runner]: https://pub.dev/packages/build_runner - diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart new file mode 100644 index 000000000..fd286a36c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart @@ -0,0 +1,58 @@ +import 'package:flutter/material.dart'; +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +class ThemeNotifier extends _$ThemeNotifier { + @override + ThemeSettings build() => const ThemeSettings( + mode: ThemeMode.light, + primaryColor: Colors.blue, + ); + + void toggle() { + state = state.copyWith(mode: state.mode.toggle); + } + + void setDarkTheme() { + state = state.copyWith(mode: ThemeMode.dark); + } + + void setLightTheme() { + state = state.copyWith(mode: ThemeMode.light); + } + + void setSystemTheme() { + state = state.copyWith(mode: ThemeMode.system); + } + + void setPrimaryColor(Color color) { + state = state.copyWith(primaryColor: color); + } +} + +@freezed +class ThemeSettings with _$ThemeSettings { + const factory ThemeSettings({ + required ThemeMode mode, + required Color primaryColor, + }) = _ThemeSettings; +} + +extension ToggleTheme on ThemeMode { + ThemeMode get toggle { + switch (this) { + case ThemeMode.dark: + return ThemeMode.light; + case ThemeMode.light: + return ThemeMode.dark; + case ThemeMode.system: + return ThemeMode.system; + } + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart new file mode 100644 index 000000000..6e8c8082b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart @@ -0,0 +1,151 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$ThemeSettings { + ThemeMode get mode => throw _privateConstructorUsedError; + Color get primaryColor => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $ThemeSettingsCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ThemeSettingsCopyWith<$Res> { + factory $ThemeSettingsCopyWith( + ThemeSettings value, $Res Function(ThemeSettings) then) = + _$ThemeSettingsCopyWithImpl<$Res, ThemeSettings>; + @useResult + $Res call({ThemeMode mode, Color primaryColor}); +} + +/// @nodoc +class _$ThemeSettingsCopyWithImpl<$Res, $Val extends ThemeSettings> + implements $ThemeSettingsCopyWith<$Res> { + _$ThemeSettingsCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? mode = null, + Object? primaryColor = null, + }) { + return _then(_value.copyWith( + mode: null == mode + ? _value.mode + : mode // ignore: cast_nullable_to_non_nullable + as ThemeMode, + primaryColor: null == primaryColor + ? _value.primaryColor + : primaryColor // ignore: cast_nullable_to_non_nullable + as Color, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ThemeSettingsImplCopyWith<$Res> + implements $ThemeSettingsCopyWith<$Res> { + factory _$$ThemeSettingsImplCopyWith( + _$ThemeSettingsImpl value, $Res Function(_$ThemeSettingsImpl) then) = + __$$ThemeSettingsImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({ThemeMode mode, Color primaryColor}); +} + +/// @nodoc +class __$$ThemeSettingsImplCopyWithImpl<$Res> + extends _$ThemeSettingsCopyWithImpl<$Res, _$ThemeSettingsImpl> + implements _$$ThemeSettingsImplCopyWith<$Res> { + __$$ThemeSettingsImplCopyWithImpl( + _$ThemeSettingsImpl _value, $Res Function(_$ThemeSettingsImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? mode = null, + Object? primaryColor = null, + }) { + return _then(_$ThemeSettingsImpl( + mode: null == mode + ? _value.mode + : mode // ignore: cast_nullable_to_non_nullable + as ThemeMode, + primaryColor: null == primaryColor + ? _value.primaryColor + : primaryColor // ignore: cast_nullable_to_non_nullable + as Color, + )); + } +} + +/// @nodoc + +class _$ThemeSettingsImpl implements _ThemeSettings { + const _$ThemeSettingsImpl({required this.mode, required this.primaryColor}); + + @override + final ThemeMode mode; + @override + final Color primaryColor; + + @override + String toString() { + return 'ThemeSettings(mode: $mode, primaryColor: $primaryColor)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ThemeSettingsImpl && + (identical(other.mode, mode) || other.mode == mode) && + (identical(other.primaryColor, primaryColor) || + other.primaryColor == primaryColor)); + } + + @override + int get hashCode => Object.hash(runtimeType, mode, primaryColor); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ThemeSettingsImplCopyWith<_$ThemeSettingsImpl> get copyWith => + __$$ThemeSettingsImplCopyWithImpl<_$ThemeSettingsImpl>(this, _$identity); +} + +abstract class _ThemeSettings implements ThemeSettings { + const factory _ThemeSettings( + {required final ThemeMode mode, + required final Color primaryColor}) = _$ThemeSettingsImpl; + + @override + ThemeMode get mode; + @override + Color get primaryColor; + @override + @JsonKey(ignore: true) + _$$ThemeSettingsImplCopyWith<_$ThemeSettingsImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart new file mode 100644 index 000000000..88eac19dc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart @@ -0,0 +1,82 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(ThemeNotifier) +const themeNotifierProvider = ThemeNotifierProvider._(); + +final class ThemeNotifierProvider + extends $NotifierProvider { + const ThemeNotifierProvider._( + {super.runNotifierBuildOverride, ThemeNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'themeNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ThemeNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$themeNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(ThemeSettings value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + ThemeNotifier create() => _createCb?.call() ?? ThemeNotifier(); + + @$internal + @override + ThemeNotifierProvider $copyWithCreate( + ThemeNotifier Function() create, + ) { + return ThemeNotifierProvider._(create: create); + } + + @$internal + @override + ThemeNotifierProvider $copyWithBuild( + ThemeSettings Function( + Ref, + ThemeNotifier, + ) build, + ) { + return ThemeNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$themeNotifierHash() => r'e119d56d9bf8b8d7c19624997f99d116098b45e9'; + +abstract class _$ThemeNotifier extends $Notifier { + ThemeSettings build(); + @$internal + @override + ThemeSettings runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart new file mode 100644 index 000000000..1e34c694c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart @@ -0,0 +1,67 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +final themeProvider = + NotifierProvider(ThemeNotifier.new); + +class ThemeNotifier extends Notifier { + @override + ThemeSettings build() { + return ThemeSettings(mode: ThemeMode.system, primaryColor: Colors.blue); + } + + void toggle() { + state = state.copyWith(mode: state.mode.toggle); + } + + void setDarkTheme() { + state = state.copyWith(mode: ThemeMode.dark); + } + + void setLightTheme() { + state = state.copyWith(mode: ThemeMode.light); + } + + void setSystemTheme() { + state = state.copyWith(mode: ThemeMode.system); + } + + void setPrimaryColor(Color color) { + state = state.copyWith(primaryColor: color); + } +} + +class ThemeSettings { + ThemeSettings({ + required this.mode, + required this.primaryColor, + }); + + final ThemeMode mode; + final Color primaryColor; + + ThemeSettings copyWith({ + ThemeMode? mode, + Color? primaryColor, + }) { + return ThemeSettings( + mode: mode ?? this.mode, + primaryColor: primaryColor ?? this.primaryColor, + ); + } +} + +extension ToggleTheme on ThemeMode { + ThemeMode get toggle { + switch (this) { + case ThemeMode.dark: + return ThemeMode.light; + case ThemeMode.light: + return ThemeMode.dark; + case ThemeMode.system: + return ThemeMode.system; + } + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx deleted file mode 100644 index edf6ab805..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/refresh.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Pull-to-refresh / Retry-on-error ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -In this guide, we will see how Providers can be used to easily implement -a pull-to-refresh or retry-on-error feature. - diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx index b89da0ca2..bbb1a477f 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx @@ -2,11 +2,17 @@ title: Search as we type --- +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + A real world example could be to use `FutureProvider` to implement a searchbar. ## Usage example: "Search as we type" searchbar -Implementing a "seach as we type" can seem daunting at first when using +Implementing a "search as we type" can seem daunting at first when using conventional means. There are lots of moving parts, such as: @@ -26,10 +32,10 @@ is to split it into multiple providers: the other providers/[family]. The first step would be to store the user input somewhere. For this example, -we will use `StateProvider` (as the seach state is only a single `String`): +we will use `StateProvider` (as the search state is only a single `String`): ```dart -final seachInputProvider = StateProvider((ref) => ''); +final searchInputProvider = StateProvider((ref) => ''); ``` We can then connect this provider to a [TextField] by doing: @@ -113,14 +119,11 @@ class MyHomePage extends ConsumerWidget { ref.read(searchFieldProvider.notifier).state = value, ), Expanded( - child: questions.when( - loading: () => const Center(child: CircularProgressIndicator()), - error: (error, stack) => Center(child: Text('Error $error')), - data: (questions) { - return ListView.builder( - itemCount: questions.length, + child: switch (questions) { + AsyncData(:final value) => ListView.builder( + itemCount: value.length, itemBuilder: (context, index) { - final question = questions[index]; + final question = value[index]; return ListTile( title: Text( @@ -128,9 +131,10 @@ class MyHomePage extends ConsumerWidget { ), ); }, - ); - }, - ), + );, + AsyncError(:final error) => Center(child: Text('Error $error')), + _ => const Center(child: CircularProgressIndicator()), + }, ), ], ), diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing.mdx index 2ca4f4dba..3e91042c9 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing.mdx @@ -1,46 +1,57 @@ --- -title: 테스트 +title: Testing --- import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import testingOriginalTestFlutter from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart"; -import testingOriginalTestDart from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart"; -import repositorySnippet from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart"; -import testFlutter from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart"; -import testDart from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart"; -import testFull from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart"; -import testOverrideInfo from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart"; +import testingOriginalTestFlutter from "!!raw-loader!/docs/cookbooks/testing_original_test_flutter.dart"; +import testingOriginalTestDart from "!!raw-loader!/docs/cookbooks/testing_original_test_dart.dart"; +import repositorySnippet from "!!raw-loader!/docs/cookbooks/testing_repository.dart"; +import testFlutter from "!!raw-loader!/docs/cookbooks/testing_flutter.dart"; +import testDart from "!!raw-loader!/docs/cookbooks/testing_dart.dart"; +import testFull from "!!raw-loader!/docs/cookbooks/testing_full.dart"; +import testOverrideInfo from "!!raw-loader!/docs/cookbooks/testing_override_info.dart"; import { trimSnippet } from "../../../../../src/components/CodeSnippet"; -중, 대규모 애플리케이션에서 테스트는 중요한 작업입니다. +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + +For any medium to large-scale applications, it is critical to test the application. -우리의 앱을 성공적으로 테스트하기 위해서 아래의 몇가지 포인트를 생각해 보아야합니다. +To successfully test our application, we will want the following things: -- `test`/`testWidgets`간 상태를 공유하지 않습니다. - 이것은 글로벌 상태를 가지지 않은 앱 또는 모든 글로벌 상태들이 테스트 후에 초기화됨을 의미합니다. +- No state should be preserved between `test`/`testWidgets`. + That means no global state in the application, or all global states should reset after each test. -- 프로바이더에 특정한 상태를 가질 수 있도록 할 수 있는데, mocking 또는 조작을 통해 원하는 상태로 만들어 줄 수 있습니다. +- Being able to force our providers to have a specific state, either through + mocking or by manipulating them until we reach the desired state. -[Riverpod]의 기능을 어떻게 활용할 수 있는지 하나씩 확인해봅시다. +Let's see one by one how [Riverpod] helps you with these. -## `test`와`testWidgets`간 상태를 공유(보존)하지 않음. +## No state should be preserved between `test`/`testWidgets`. -당신은 프로바이더가 전역(글로벌)변수로서 선언되어 사용되기 때문에 이 부분을 걱정할 수 도 있습니다. -어쨋든, 전역 상태를 만들어 테스팅하는것은 `setUp`/`tearDown`이 많이 요구되기 때문에 매우 까다롭습니다. +Since providers are usually declared as global variables, you might worry about +that one. +After all, global state makes testing very difficult, because it can require +lengthy `setUp`/`tearDown`. -그러나 실제로는 프로바이더가 전역(상태변수)로서 선언되는 동안 프로바이더의 상태는 전역이**아닙니다**. +But the reality is: While providers are declared as globals, the state of a provider +is **not** global. -대신에, 상태들은 [ProviderContainer]의 객체 이름을 가지고 저장됩니다. -Dart만 사용하는 경우(dart-only)의 샘플 코드에서 [ProviderContainer]객체를 보셨을 수 있습니다. -만약 모르고 있었다면 [ProviderContainer] 객체는 암묵적으로 우리의 프로젝트에서 [Riverpod]을 사용하기위해 -사용하는 위젯 [ProviderScope]에 의해 생성됩니다. +Instead, it is stored in an object named [ProviderContainer], which you may have +seen if you looked at the dart-only examples. +If you haven't, know that this [ProviderContainer] object is implicitly created +by [ProviderScope], the widget that enables [Riverpod] on our project. -구체적으로, 상태가 글로벌(전역)이 아니라는 것은 프로바이더를 사용하는 2개의 `testWidgets` 간 상태는 공유되지 않습니다. -엄밀히 말해서 `setUp`/`tearDown`을 모두 필요로 하지 않습니다. +Concretely what this means is, two `testWidgets` using providers do not share +any state. +As such, there is no need for any `setUp`/`tearDown` at all. -길게 설정하는것보다 예제로 확인해보도록 합시다. +But an example is better than lengthy explanations: -보았듯이 `counterProvider`가 전역상태번수로 선언되어 있음에도 테스트 간 상태는 공유되지 않습니다. -그래서 우리는 각각의 테스트가 독립된 환경에서 실행되지 때문에 실행순서에 따라 테스트 결과가 달라지는 것을 걱정하지 않아도 됩니다. - -## 테스트 하는동안 프로바이더의 동작을 오버라이딩 하는 경우. +As you can see, while `counterProvider` was declared as a global, no state was +shared between tests. +As such, we do not have to worry about our tests potentially behaving differently +if executed in a different order, since they are running in complete isolation. -통상적인 현실세계의 애플리케이션은 아래와 같은 객체를 가지고 있다고 생각합니다. +## Overriding the behavior of a provider during tests. A common real-world application may have the following objects: -- 타입세이프(a type-safe)와 HTTP 요청 수행 기능을 제공하는 `Repository` 클래스를 가지고 있습니다. +- It will have a `Repository` class, which provides a type-safe and simple API + to perform HTTP requests. -- 앱 상태를 관리하고 `Repository`를 사용해 다양한 조건을 기반으로 한 HTTP 요청을 수행하는 객체를 가지고 있습니다. 이것은 아마도 `ChangeNotifier`, `Bloc` 또는 프로바이더 일것입니다. +- An object that manages the application state, and may use `Repository` to perform + HTTP requests based on different factors. + This may be a `ChangeNotifier`, `Bloc`, or even a provider. -[Riverpod]을 사용하면 아래와 같이 표현 할 수 있습니다. +Using [Riverpod], this may be represented as follows: {trimSnippet(repositorySnippet)} -이 상황에서는 a unit/widget test를 만들때, `Repository` 인스턴스를 실제 HTTP요청 대신에 사전 정의된 응답을 반환하는 fake 구현 레포지토리로 대체합니다. -`todoListProvider` 또는 `Repository`의 구현된 mock과 동등한 객체를 사용합니다. +In this situation, when making a unit/widget test, we will typically want to +replace our `Repository` instance with a fake implementation that returns +a pre-defined response instead of making a real HTTP request. -이를 달성하기위해서, `repositoryProvider`의 행위를 오버라이드 하기위해 [ProviderScope]/[ProviderContainer]의 `overrides` 파라미터를 사용할 수 있습니다. +We will then want our `todoListProvider` or equivalent to use the mocked implementation +of `Repository`. + +To achieve this, we can use the `overrides` parameter of [ProviderScope]/[ProviderContainer] +to override the behavior of `repositoryProvider`: -하이라이트된 코드를 확인해보면, [ProviderScope]/[ProviderContainer]는 다른 동작을 하는 프로바이더의 구현체로 교체할 수 있는것을 허용합니다. - +As you can see by the highlighted code, [ProviderScope]/[ProviderContainer] +allows replacing the implementation of a provider with a different behavior. :::info -프로바이더에 따라 프로바이더가 가지는 동작을 오버라이드하기 위해 간단한 방법을 노출합니다. -예를 들어 [FutureProvider]는 `AsyncValue`와 함께 프로바이더를 오버라이딩 할 수 있습니다. +Some providers expose simplified ways to override their behavior. +For example, [FutureProvider] allows overriding the provider with an `AsyncValue`: {trimSnippet(testOverrideInfo)} +**Note**: As part of the 2.0.0 release, `overrideWithValue` methods are temporarily +removed. They will be added back in later versions. + ::: :::info -프로바이더를 오버라이딩하기 위해 사용하는 `family` 수식자와 구문이 조금 차이가 있습니다. +The syntax for overriding a provider with the `family` modifier is slightly different. -만약 아래와 같이 프로바이더를 사용한다면 +If you used a provider like this: ```dart final response = ref.watch(myProvider('12345')); ``` -아래와 같이 프로바이더를 오버라이드할 수 있습니다. +You could override the provider as: ```dart myProvider('12345').overrideWithValue(...)); @@ -130,9 +152,9 @@ myProvider('12345').overrideWithValue(...)); ::: -## 모든 위젯 테스트 예제 Full widget test example +## Full widget test example -마지막으로 위의 내용을 정리한 모든 테스트 코드를 확인해봅시다. +Wrapping up, here is the entire full code for our Flutter test. {trimSnippet(testFull)} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart index 7605a2f1c..8ae9e305c 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart @@ -16,36 +16,36 @@ final todoListProvider = FutureProvider>((ref) => []); void main() { /* SNIPPET START */ - test('override repositoryProvider', () async { - final container = ProviderContainer( - overrides: [ - // repositoryProvider의 행위를 오버라이드하여 - // Repository 대신 FakeRepository를 반환합니다. - /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()), - /* highlight-end */ - // 오버라이드된 repositoryProvider를 자동적으로 사용하기 때문에 - // `todoListProvider`를 override하지 않아도 됩니다. - ], - ); - - // 처음 상태가 로딩중임을 확인합니다. - expect( - container.read(todoListProvider), - const AsyncValue>.loading(), - ); - - /// 요청이 종료될때까지 대기합니다. - await container.read(todoListProvider.future); - - // 취득된 데이터를 노출시킵니다. - expect(container.read(todoListProvider).value, [ - isA() - .having((s) => s.id, 'id', '42') - .having((s) => s.label, 'label', 'Hello world') - .having((s) => s.completed, 'completed', false), - ]); - }); +test('override repositoryProvider', () async { + final container = ProviderContainer( + overrides: [ + // repositoryProvider의 행위를 오버라이드하여 + // Repository 대신 FakeRepository를 반환합니다. + /* highlight-start */ + repositoryProvider.overrideWithValue(FakeRepository()), + /* highlight-end */ + // 오버라이드된 repositoryProvider를 자동적으로 사용하기 때문에 + // `todoListProvider`를 override하지 않아도 됩니다. + ], + ); + + // The first read if the loading state + expect( + container.read(todoListProvider), + const AsyncValue>.loading(), + ); + + /// Wait for the request to finish + await container.read(todoListProvider.future); + + // Exposes the data fetched + expect(container.read(todoListProvider).value, [ + isA() + .having((s) => s.id, 'id', '42') + .having((s) => s.label, 'label', 'Hello world') + .having((s) => s.completed, 'completed', false), + ]); +}); /* SNIPPET END */ } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart index 9c1a90bf5..c9b95a032 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -19,22 +19,22 @@ class FakeRepository {} void main() { /* SNIPPET START */ - testWidgets('override repositoryProvider', (tester) async { - await tester.pumpWidget( - ProviderScope( - overrides: [ - // repositoryProvider의 행위를 오버라이드하여 - // Repository 대신 FakeRepository를 반환합니다. - /* highlight-start */ - repositoryProvider.overrideWithValue(FakeRepository()), - /* highlight-end */ - // 오버라이드된 repositoryProvider를 자동적으로 사용하기 때문에 - // `todoListProvider`를 override하지 않아도 됩니다. - ], - child: MyApp(), - ), - ); - }); +testWidgets('override repositoryProvider', (tester) async { + await tester.pumpWidget( + ProviderScope( + overrides: [ + // repositoryProvider의 행위를 오버라이드하여 + // Repository 대신 FakeRepository를 반환합니다. + /* highlight-start */ + repositoryProvider.overrideWithValue(FakeRepository()), + /* highlight-end */ + // 오버라이드된 repositoryProvider를 자동적으로 사용하기 때문에 + // `todoListProvider`를 override하지 않아도 됩니다. + ], + child: MyApp(), + ), + ); +}); /* SNIPPET END */ } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart index 3a740b01c..e75b5747f 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -18,20 +18,20 @@ class Todo { final bool completed; } -// Repository를 사용하는 프로바이더 인스턴스 +// We expose our instance of Repository in a provider final repositoryProvider = Provider((ref) => Repository()); -/// 할일(Todo) 목록 -/// [Repository]를 사용하여 서버로부터 값을 취득하는 FutureProvider 인스턴스 +/// The list of todos. Here, we are simply fetching them from the server using +/// [Repository] and doing nothing else. final todoListProvider = FutureProvider((ref) async { - // Repository 인스턴스를 취득합니다. + // Obtains the Repository instance final repository = ref.read(repositoryProvider); - // Todo 목록을 가져오고 이를 UI에 노출시킵니다. + // Fetch the todos and expose them to the UI. return repository.fetchTodos(); }); -/// 레포지토리의 Mock 구현: 사전 정의된 할일 목록을 반환하는 역할 +/// A mocked implementation of Repository that returns a pre-defined list of todos class FakeRepository implements Repository { @override Future> fetchTodos() async { @@ -54,39 +54,43 @@ void main() { testWidgets('override repositoryProvider', (tester) async { await tester.pumpWidget( ProviderScope( - overrides: [repositoryProvider.overrideWithValue(FakeRepository())], - // todoListProvider로부터 상태 값을 읽어 todo 목록을 표시하는 앱 - // MyApp 위젯으로도 가능. + overrides: [ + repositoryProvider.overrideWithValue(FakeRepository()), + ], + // Our application, which will read from todoListProvider to display the todo-list. + // You may extract this into a MyApp widget child: MaterialApp( home: Scaffold( - body: Consumer(builder: (context, ref, _) { - final todos = ref.watch(todoListProvider); - // 할일 목록이 로딩 중이거나 에러가 발생했을 때의 대응 - if (todos.asData == null) { - return const CircularProgressIndicator(); - } - return ListView( - children: [ - for (final todo in todos.asData!.value) TodoItem(todo: todo), - ], - ); - },), + body: Consumer( + builder: (context, ref, _) { + final todos = ref.watch(todoListProvider); + // The list of todos is loading or in error + if (todos.asData == null) { + return const CircularProgressIndicator(); + } + return ListView( + children: [ + for (final todo in todos.asData!.value) + TodoItem(todo: todo), + ], + ); + }, + ), ), ), ), ); - // 처음 프레임 상태가 로딩중임을 확인. + // The first frame is a loading state. expect(find.byType(CircularProgressIndicator), findsOneWidget); - // 재 렌더링을 수행 - // (TodoListProvider가 할일 목록을 가져오기를 끝냈을 것이라 예상) + // Re-render. TodoListProvider should have finished fetching the todos by now await tester.pump(); - // CircularProgressIndicator을 찾아 loading 상태인지 확인 . + // No longer loading expect(find.byType(CircularProgressIndicator), findsNothing); - // FakeRepository가 반환한 값이 1개의 TodoItem으로 렌더링되었는지 확인. + // Rendered one TodoItem with the data returned by FakeRepository expect(tester.widgetList(find.byType(TodoItem)), [ isA() .having((s) => s.todo.id, 'todo.id', '42') diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart index 2e85fdcd2..d78668653 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart @@ -5,48 +5,48 @@ import 'package:riverpod/riverpod.dart'; /* SNIPPET START */ -// Dart만을 사용하여 구현된 카운터 앱을 테스트해봅시다. (플러터에 의존하지 않은 앱) +// A Counter implemented and tested with Dart only (no dependency on Flutter) -// provider를 전역변수로 선언하합니다. 그리고 만약 테스트간 상태가 `0`으로 초기화 되는것을 -// 확인하기 위한 2개의 테스트를 실행해볼겁니다. +// We declared a provider globally, and we will use it in two tests, to see +// if the state correctly resets to `0` between tests. final counterProvider = StateProvider((ref) => 0); -// mockito를 사용하여 프로바이더가 notify할 때의 값을 추적하기 위한 listeners 객체를 생성합니다. +// Using mockito to keep track of when a provider notify its listeners class Listener extends Mock { void call(int? previous, int value); } void main() { test('defaults to 0 and notify listeners when value changes', () { - // 프로바이더를 사용하기위한 객체 - // 테스트간 공유되지 않습니다. + // An object that will allow us to read providers + // Do not share this between tests. final container = ProviderContainer(); addTearDown(container.dispose); final listener = Listener(); - // 프로바이더를 관찰하고 값 변화를 검출합니다. + // Observe a provider and spy the changes. container.listen( counterProvider, listener.call, fireImmediately: true, ); - // 리스너는 0을 기본값으로 호출됩니다. + // the listener is called immediately with 0, the default value verify(listener(null, 0)).called(1); verifyNoMoreInteractions(listener); - // 여기서 상태 값을 증가시켜 봅니다. + // We increment the value container.read(counterProvider.notifier).state++; - // 리스터는 다시 호출되고 상태 값은 1을 가집니다. + // The listener was called again, but with 1 this time verify(listener(0, 1)).called(1); verifyNoMoreInteractions(listener); }); test('the counter state is not shared between tests', () { - // 프로바이더를 사용하기 위해 다른 ProviderContainer를 사용합니다. - // 이걸로 테스트간 상태를 재사용하지 않는것을 확인할 수 있습니다. + // We use a different ProviderContainer to read our provider. + // This ensure that no state is reused between tests final container = ProviderContainer(); addTearDown(container.dispose); final listener = Listener(); @@ -57,7 +57,7 @@ void main() { fireImmediately: true, ); - // 새로운 테스트는 기본 값을 0으로 가진 상태를 출력하는 것을 확인할 수 있습니다. + // The new test correctly uses the default value: 0 verify(listener(null, 0)).called(1); verifyNoMoreInteractions(listener); }); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart index c48426a03..a3044da37 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -7,13 +7,14 @@ import 'package:flutter_test/flutter_test.dart'; /* SNIPPET START */ -// 플러터를 사용해 구현된 카운터 앱 테스트 하기 +// A Counter implemented and tested using Flutter + +// We declared a provider globally, and we will use it in two tests, to see +// if the state correctly resets to `0` between tests. -// provider를 전역변수로 선언하합니다. 그리고 만약 테스트간 상태가 `0`으로 초기화 되는것을 -// 확인하기 위한 2개의 테스트를 실행해볼겁니다. final counterProvider = StateProvider((ref) => 0); -// 현재의 상태값과 버튼을 누르면 상태가 값이 증가하는 기능을 가지는 화면을 생성합니다. +// Renders the current state and a button that allows incrementing the state class MyApp extends StatelessWidget { @override Widget build(BuildContext context) { @@ -33,16 +34,15 @@ void main() { testWidgets('update the UI when incrementing the state', (tester) async { await tester.pumpWidget(ProviderScope(child: MyApp())); - // 프로바이더에서 선언한 그대로 기본값은 `0`입니다. + // The default value is `0`, as declared in our provider expect(find.text('0'), findsOneWidget); expect(find.text('1'), findsNothing); - // ElevatedButton를 찾아 탭을 수행하여 상태를 증가시킵니다. - // 그리고 다시 랜더링을 실행합니다. + // Increment the state and re-render await tester.tap(find.byType(ElevatedButton)); await tester.pump(); - // 상태가 적절하게 증가되어 있는지 확인합니다. + // The state have properly incremented expect(find.text('1'), findsOneWidget); expect(find.text('0'), findsNothing); }); @@ -50,8 +50,7 @@ void main() { testWidgets('the counter state is not shared between tests', (tester) async { await tester.pumpWidget(ProviderScope(child: MyApp())); - // 상태가 공유되어있지 않기떄문에 다시 `0`값을 가집니다. - // tearDown/setUp 작업이 필요없습니다. + // The state is `0` once again, with no tearDown/setUp needed expect(find.text('0'), findsOneWidget); expect(find.text('1'), findsNothing); }); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart index 8ad1eca93..d71ae3c69 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart @@ -34,7 +34,7 @@ final foo = /* SKIP END */ ProviderScope( overrides: [ - /// 고정된 값을 반환하기 위해 FutureProvider를 오버라이딩 합니다. + /// Allows overriding a FutureProvider to return a fixed value todoListProvider.overrideWithValue( AsyncValue.data([Todo(id: '42', label: 'Hello', completed: true)]), ), diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart index 820147057..c499279fc 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart @@ -8,15 +8,15 @@ class Repository { Future> fetchTodos() async => []; } -// 프로바이더안에 레포지토리의 인스턴스를 노출합니다. +// We expose our instance of Repository in a provider final repositoryProvider = Provider((ref) => Repository()); -/// Todo의 목록 -/// 여기 [Repository]를 사용하여 서버로부터 값을 가져오고 있습니다. +/// The list of todos. Here, we are simply fetching them from the server using +/// [Repository] and doing nothing else. final todoListProvider = FutureProvider((ref) async { - // Repository 인스턴스를 생성합니다. + // Obtains the Repository instance final repository = ref.watch(repositoryProvider); - // Todo 목록을 취득하고 UI에 노출시킵니다. + // Fetch the todos and expose them to the UI. return repository.fetchTodos(); }); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx new file mode 100644 index 000000000..e3f1407da --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx @@ -0,0 +1,153 @@ +--- +title: "캐시 지우기 및 상태 폐기(disposal)에 반응하기" +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import onDisposeExample from "./auto_dispose/on_dispose_example"; +import codegenKeepAlive from "!!raw-loader!./auto_dispose/codegen_keep_alive.dart"; +import rawAutoDispose from "!!raw-loader!./auto_dispose/raw_auto_dispose.dart"; +import invalidateExample from "!!raw-loader!./auto_dispose/invalidate_example.dart"; +import keepAlive from "./auto_dispose/keep_alive"; +import cacheForExtension from "!!raw-loader!./auto_dispose/cache_for_extension.dart"; +import cacheForUsage from "./auto_dispose/cache_for_usage"; +import invalidateFamilyExample from './auto_dispose/invalidate_family_example' + +지금까지 일부 상태(state)를 생성하거나 업데이트하는 방법을 살펴보았습니다. +하지만 언제 상태가 소멸(destruction)되는지에 대해서는 아직 이야기하지 않았습니다. + +Riverpod은 상태 폐기(disposal)와 상호작용할 수 있는 다양한 방법을 제공합니다. +여기에는 상태 폐기를 지연(delaying)시키는 것부터 소멸에 반응하는 것까지 다양합니다. + +## 상태는 언제 파괴되며, 그 것을 어떻게 변경하나요? + + + +코드 생성(code-generation)을 사용할 때 기본적으로 provider가 수신이 중지되면 상태가 파괴됩니다. +이는 리스너에 전체 프레임에 대한 활성 리스너가 없을 때 발생합니다. 이 경우 상태가 소멸됩니다. + +이 동작은 `keepAlive: true`를 사용하여 해제(opted out)할 수 있습니다. +이렇게 하면 모든 리스너가 제거될 때 상태가 소멸되는 것을 방지할 수 있습니다. + + + + + + + +코드 생성을 사용하지 않는 경우 기본적으로 provider의 수신이 중단되어도 상태는 파괴되지 않습니다. + +선택적으로 이 동작을 변경하여 자동 폐기를 사용할 수 있습니다. +그렇게 하면, Riverpod은 provider에 리스너가 있는지 여부를 추적합니다. +그런 다음 provider에 전체 프레임에 대한 리스너가 없는 경우 상태가 삭제됩니다. + +자동 폐기를 활성화하려면 provider 타입 옆에 `.autoDispose`를 사용하면 됩니다: + + + + + +:::note +자동 폐기를 활성화/비활성화해도 provider가 다시 계산될 때 상태가 소멸되는지 여부에는 영향을 미치지 않습니다. +provider가 다시 계산될 때 상태는 항상 소멸(destroyed)됩니다. +::: + +:::caution +provider가 매개변수를 받을 때 자동 폐기를 활성화하는 것이 좋습니다. +그렇지 않으면 매개변수 조합당 하나의 상태가 생성되어 메모리 누수가 발생할 수 있기 때문입니다. +::: + +## 상태 폐기(disposal)에 대한 반응 + +Riverpod에는 상태를 파기하는 몇 가지 기본 제공 방법이 있습니다: + +- provider가 더 이상 사용되지 않고 "auto dispose" 모드에 있는 경우(자세한 내용은 나중에 설명). + 이 경우 provider와 관련된 모든 상태가 소멸됩니다. +- `ref.watch`와 같이 provider가 다시 계산됩니다. + 이 경우 이전 상태가 폐기되고 새 상태가 생성됩니다. + +두 경우 모두. 이 경우 몇 가지 로직을 실행하고 싶을 수 있습니다. +이는 `ref.onDispose`로 가능합니다. 이 메서드를 사용하면 상태가 소멸될 때마다 리스너를 등록할 수 있습니다. + +예를 들어, 이 메서드를 사용해 활성화된 `StreamController`를 닫을 수 있습니다: + + + +:::caution +`ref.onDispose`의 콜백은 부작용을 유발하지 않아야 합니다. +`onDispose` 내에서 프로바이더를 수정하면 예기치 않은 동작이 발생할 수 있습니다. +::: + +:::info +다음과 같은 다른 유용한 수명 주기(life-cycles)가 있습니다: + +- provider의 마지막 리스너가 제거될 때 호출되는 `ref.onCancel`. +- `onCancel`이 호출된 후 새 리스너가 추가될 때 호출되는 `ref.onResume`. + +::: + +:::info +`ref.onDispose`는 원하는 횟수만큼 호출할 수 있습니다. +provider의 Disposable 객체당 한 번씩 호출해도 됩니다. +이렇게 하면 물건을 버리는 것(dispose of something)을 잊어버렸을 때 쉽게 알아차릴 수 있습니다. +::: + +## `ref.invalidate`를 사용하여 provider를 수동으로 강제 삭제하기 + +때로는 provider를 강제로 파괴하고 싶을 때가 있습니다. +다른 provider나 위젯에서 호출할 수 있는 `ref.invalidate`를 사용하면 이 작업을 수행할 수 있습니다. + +`ref.invalidate`를 사용하면 현재 provider 상태가 파괴됩니다. +그러면 두 가지 결과가 발생할 수 있습니다: + +- provider가 청취되고 있으면 새 상태가 생성됩니다. +- provider를 청취되고 있지 않으면 provider가 완전히 소멸됩니다. + + + +:::info +provider가 `ref.invalidateSelf`를 사용하여 스스로 무효화할 수 있습니다. +이 경우 항상 새로운 상태가 생성됩니다. +::: + +:::tip +매개변수를 수신하는 provider를 무효화하려고 할 때, +특정 매개변수 조합 하나를 무효화하거나 모든 매개변수 조합을 한 번에 무효화할 수 있습니다: + + +::: + +## `ref.keepAlive`를 사용하여 폐기(disposal)를 조정하기 + +위에서 언급했듯이 자동 폐기를 사용하도록 설정하면 provider에 전체 프레임에 대한 리스너가 없는 경우 상태가 삭제됩니다. + +하지만 이 동작을 보다 세밀하게 제어하고 싶을 수도 있습니다. +예를 들어, 성공한 네트워크 요청의 상태는 유지하되 실패한 요청은 캐시하지 않으려 할 수 있습니다. + +이는 자동 폐기를 활성화한 후 `ref.keepAlive`를 사용하면 가능합니다. +이 함수를 사용하면 상태의 자동 폐기를 중지하는 _시점_을 결정할 수 있습니다. + + + +:::note +provider가 다시 계산되면 자동 폐기가 다시 활성화됩니다. + +`ref.keepAlive`의 반환 값을 사용하여 자동 폐기로 되돌릴 수도 있습니다. +::: + +## 예: 특정 시간 동안 상태를 살아있게 유지하기 + +현재 Riverpod은 특정 시간 동안 상태를 유지하는 내장된 방법을 제공하지 않습니다. +하지만 지금까지 살펴본 도구를 사용하면 이러한 기능을 쉽게 구현하고 재사용할 수 있습니다. + +`Timer` + `ref.keepAlive`를 사용하면 특정 시간 동안 상태를 유지할 수 있습니다. +이 로직을 재사용할 수 있게 하려면 확장 메서드(extension method)로 구현하면 됩니다: + + + +그러면 이렇게 사용할 수 있습니다: + + + +이 로직은 필요에 맞게 조정할 수 있습니다. +예를 들어 `ref.onCancel`/`ref.onResume`을 사용하여 특정 시간 동안 공급자가 수신 대기하지 않은 경우에만 상태를 삭제할 수 있습니다. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart new file mode 100644 index 000000000..d2896ed62 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart @@ -0,0 +1,17 @@ +import 'dart:async'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +extension CacheForExtension on Ref { + /// [duration]동안 공급자를 살아있게 유지합니다. + void cacheFor(Duration duration) { + // 상태가 파괴되는 것을 즉시 방지합니다. + final link = keepAlive(); + // 기간이 경과하면 자동 폐기를 다시 활성화합니다. + final timer = Timer(duration, link.close); + + // 선택 사항: provider가 다시 계산되면(예: ref.watch 사용) 보류 중인 타이머를 취소합니다. + onDispose(timer.cancel); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart new file mode 100644 index 000000000..db007483d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart @@ -0,0 +1,17 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../cache_for_extension.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future example(ExampleRef ref) async { + /// 5분 동안 상태를 유지합니다. + ref.cacheFor(const Duration(minutes: 5)); + + return http.get(Uri.https('example.com')); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart new file mode 100644 index 000000000..423d550c9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'3ff29b1cd8fa864286a2a04e39adf1c8589b4275'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart new file mode 100644 index 000000000..f0d6490ff --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart @@ -0,0 +1,15 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; + +import '../cache_for_extension.dart'; + +/* SNIPPET START */ +final provider = FutureProvider.autoDispose((ref) async { + /// Keeps the state alive for 5 minutes + ref.cacheFor(const Duration(minutes: 5)); + + return http.get(Uri.https('example.com')); +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart new file mode 100644 index 000000000..d3a3536c4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart @@ -0,0 +1,11 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_keep_alive.g.dart'; + +/* SNIPPET START */ +// 어노테이션에 "keepAlive"를 지정하여 +// 자동 상태 소멸을 비활성화할 수 있습니다. +@Riverpod(keepAlive: true) +int example(ExampleRef ref) { + return 0; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart new file mode 100644 index 000000000..6565fc05b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -0,0 +1,72 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_keep_alive.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + int create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'78f9426f6cbda80564387a9db8cd02368d890a85'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart new file mode 100644 index 000000000..09390ff9e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart @@ -0,0 +1,23 @@ +// ignore_for_file: use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +// 자동 상태 소멸을 활성화하려면 autoDispose를 지정할 수 있습니다. +final someProvider = Provider.autoDispose((ref) { + return 0; +}); + +/* SNIPPET START */ +class MyWidget extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return ElevatedButton( + onPressed: () { + // 클릭 시 공급자를 삭제합니다. + ref.invalidate(someProvider); + }, + child: const Text('dispose a provider'), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart new file mode 100644 index 000000000..9ce0d96b8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +late WidgetRef ref; + +/* SNIPPET START */ +@riverpod +String label(LabelRef ref, String userName) { + return 'Hello $userName'; +} + +// ... + +void onTap() { + // 이 provider의 가능한 모든 매개변수 조합을 무효화합니다. + ref.invalidate(labelProvider); + // 특정 조합만 무효화 + ref.invalidate(labelProvider('John')); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart new file mode 100644 index 000000000..faf2b4033 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -0,0 +1,144 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef LabelRef = Ref; + +@ProviderFor(label) +const labelProvider = LabelFamily._(); + +final class LabelProvider extends $FunctionalProvider + with $Provider { + const LabelProvider._( + {required LabelFamily super.from, + required String super.argument, + String Function( + LabelRef ref, + String userName, + )? create}) + : _createCb = create, + super( + name: r'labelProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + LabelRef ref, + String userName, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$labelHash(); + + @override + String toString() { + return r'labelProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + LabelProvider $copyWithCreate( + String Function( + LabelRef ref, + ) create, + ) { + return LabelProvider._( + argument: argument as String, + from: from! as LabelFamily, + create: ( + ref, + String userName, + ) => + create(ref)); + } + + @override + String create(LabelRef ref) { + final _$cb = _createCb ?? label; + final argument = this.argument as String; + return _$cb( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is LabelProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$labelHash() => r'20aa8ce0231205540f466f91259732bd86953c64'; + +final class LabelFamily extends Family { + const LabelFamily._() + : super( + name: r'labelProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + LabelProvider call( + String userName, + ) => + LabelProvider._(argument: userName, from: this); + + @override + String debugGetCreateSourceHash() => _$labelHash(); + + @override + String toString() => r'labelProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + String Function( + LabelRef ref, + String args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as LabelProvider; + + final argument = provider.argument as String; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart new file mode 100644 index 000000000..1f3164bfb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart @@ -0,0 +1,20 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +late WidgetRef ref; + +/* SNIPPET START */ +final provider = Provider.autoDispose.family((ref, name) { + return 'Hello $name'; +}); + +// ... + +void onTap() { + // Invalidate all possible parameter combinations of this provider. + ref.invalidate(provider); + // Invalidate a specific combination only + ref.invalidate(provider('John')); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart new file mode 100644 index 000000000..1828451dc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart @@ -0,0 +1,20 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future example(ExampleRef ref) async { + final response = await http.get(Uri.parse('https://example.com')); + // 요청이 성공적으로 완료된 후에만 프로바이더를 살아있게 유지합니다. + // 요청이 실패한 경우(그리고 throw된 경우), 공급자에 청취를 중단하면 상태가 소멸됩니다. + ref.keepAlive(); + + // `link`를 사용하여 자동 폐기 동작을 복원할 수 있습니다: + // link.close(); + + return response.body; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart new file mode 100644 index 000000000..51ab6e0c5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'4fa856c55e84da9525dcecfab1c897e61456325b'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart new file mode 100644 index 000000000..75e73c3b7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart @@ -0,0 +1,19 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +final provider = FutureProvider.autoDispose((ref) async { + final response = await http.get(Uri.parse('https://example.com')); + // We keep the provider alive only after the request has successfully completed. + // If the request failed (and threw an exception), then when the provider stops being + // listened to, the state will be destroyed. + final link = ref.keepAlive(); + + // We can use the `link` to restore the auto-dispose behavior with: + // link.close(); + + return response.body; +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart new file mode 100644 index 000000000..013988467 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable + +import 'dart:async'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +Stream example(ExampleRef ref) { + final controller = StreamController(); + + // 상태가 소멸되면 StreamController를 닫습니다. + ref.onDispose(controller.close); + + // TO-DO: StreamController의 값들을 푸시합니다. + return controller.stream; +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart new file mode 100644 index 000000000..e5b67e8f7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -0,0 +1,124 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider, Stream, ExampleRef> + with $FutureModifier, $StreamProvider { + const ExampleProvider._( + {Stream Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $StreamProviderElement $createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + Stream Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + Stream create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'29f92958e0d0e3f13ac033e92cd2e4072339c7db'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart new file mode 100644 index 000000000..6b5a7ade1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart @@ -0,0 +1,17 @@ +// ignore_for_file: unused_local_variable + +import 'dart:async'; + +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +final provider = StreamProvider((ref) { + final controller = StreamController(); + + // When the state is destroyed, we close the StreamController. + ref.onDispose(controller.close); + + // TO-DO: Push some values in the StreamController + return controller.stream; +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart new file mode 100644 index 000000000..0dfebb311 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart @@ -0,0 +1,7 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +// 자동 상태 소멸을 활성화하려면 autoDispose를 지정할 수 있습니다. +final provider = Provider.autoDispose((ref) { + return 0; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx new file mode 100644 index 000000000..ede4c45d0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx @@ -0,0 +1,126 @@ +--- +title: 요청 결합하기 +version: 1 +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; +import functionalRef from "./combining_requests/functional_ref"; +import notifierRef from "./combining_requests/notifier_ref"; +import watchExample from "./combining_requests/watch_example"; +import watchPlacement from "./combining_requests/watch_placement"; +import listenExample from "./combining_requests/listen_example"; +import readExample from './combining_requests/read_example' + +지금까지는 요청이 서로 독립적인 경우만 보았습니다. +하지만 일반적인 사용 사례는 다른 요청의 결과에 따라 요청을 트리거해야 하는 경우입니다. + +이를 위해 provider의 결과를 다른 provider에게 매개변수(parameter)로 전달하여 메커니즘을 _사용할 수_ 있습니다. + +하지만 이 접근 방식에는 몇 가지 단점이 있습니다: + +- 구현 세부 정보가 유출(leaks)됩니다. + 이제 UI는 다른 provider가 사용하는 모든 providers에 대해 알아야 합니다. +- 매개변수(parameter)가 변경될 때마다 완전히 새로운 상태가 만들어집니다. + 매개변수를 전달하면 매개변수가 변경될 때 이전 상태를 유지할 수 있는 방법이 없습니다. +- 요청을 결합(combining requests)하기가 더 어려워집니다. +- 따라서 툴링의 유용성이 떨어집니다. 개발 도구는 providers 간의 관계에 대해 알 수 없습니다. + +이를 개선하기 위해 Riverpod은 요청을 결합하는 다른 접근 방식을 제공합니다. + +## 기본 사항: "ref" 획득하기 + +요청을 결합하는 모든 방법에는 한 가지 공통점이 있습니다. 모두 `Ref` 객체를 기반으로 한다는 점입니다. + +`Ref` 객체는 모든 providers가 접근할 수 있는 객체입니다. +이 객체는 다양한 라이프사이클 리스너에 대한 액세스 권한을 부여할 뿐만 아니라, providers를 결합하는 다양한 메서드도 제공합니다. + +`Ref`를 얻을 수 있는 위치는 provider 타입에 따라 다릅니다. + +함수형 provider의 경우, `Ref`는 provider의 함수에 매개변수로 전달됩니다: + + + +클래스 변형에서 `Ref`는 Notifier 클래스의 속성입니다: + + + +## ref를 사용하여 provider를 읽습니다. + +## `ref.watch` 메소드 + +이제 `Ref`를 얻었으므로 이를 사용하여 요청을 결합할 수 있습니다. +이를 수행하는 주된 방법은 `ref.watch`를 사용하는 것입니다. +일반적으로 유지 관리가 더 쉽기 때문에 일반적으로 다른 옵션보다 `ref.watch`를 사용할 수 있도록 코드를 설계하는 것이 좋습니다. + + +`ref.watch` 메서드는 provider를 받아 현재 상태를 반환합니다. +그러면 리스닝된 provider가 변경될 때마다 provider가 무효화(invalidated)되고 다음 프레임 또는 다음 읽기(read) 시 다시 빌드됩니다. + +`ref.watch`를 사용하면 로직이 "reactive"이면서 "declarative"이게 됩니다. +즉, 필요할 때 로직이 자동으로 다시 계산(recompute)된다는 뜻입니다. +그리고 업데이트 메커니즘이 'on change'와 같은 부작용(side-effects)에 의존하지 않습니다. +이는 StatelessWidgets의 작동 방식과 유사합니다. + +예를 들어 사용자의 위치를 수신하는 provider를 정의할 수 있습니다. +그런 다음 이 위치를 사용하여 사용자 근처의 레스토랑 목록을 가져올 수 있습니다. + + + +:::info +수신 중인 provider가 변경되어 요청이 다시 계산되면 새 요청이 완료될 때까지 이전 상태가 유지됩니다. +동시에 요청이 보류(pending)되는 동안 "isLoading" 및 "isReloading" 플래그가 설정됩니다. + +이를 통해 UI에 이전 상태 또는 로딩 표시기를 표시하거나 둘 다 표시할 수 있습니다. +::: + +:::info +`ref.watch(locationProvider)` 대신 `ref.watch(locationProvider.future)`를 사용한 것을 주목하세요. +`locationProvider`가 비동기적이기 때문입니다. 따라서 초기 값을 사용할 수 있을 때까지 기다려야 합니다. + +이 `.future`를 생략하면 `locationProvider`의 현재 상태에 대한 스냅샷인 `AsyncValue`를 받게 됩니다. +하지만 아직 사용할 수 있는 위치가 없다면 아무 것도 할 수 없습니다. +::: + +:::caution +"명령형 문법(imperatively)"으로 실행되는 코드 내에서 `ref.watch`를 호출하는 것은 나쁜 습관으로 간주됩니다. +이는 provider의 빌드 단계에서 실행되지 않을 가능성이 있는 모든 코드를 의미합니다. +여기에는 "listener" 콜백(callbacks)이나 Notifier의 메서드가 포함됩니다: + + +::: + +## `ref.listen`/`listenSelf` 메소드 + +`ref.listen` 메서드는 `ref.watch`의 대안입니다. +이 메서드는 기존의 "listen"/"addListener" 메서드와 유사합니다. +이 메서드는 provider와 callback을 받으며, provider의 콘텐츠가 변경될 때마다 해당 callback을 호출합니다. + +`ref.listen` 대신 `ref.watch`를 사용할 수 있도록 코드를 리팩토링하는 것이 일반적으로 권장되는데, +전자는 명령형으로 인해 오류가 발생하기 쉽기 때문입니다. +하지만 `ref.listen`는 큰 리팩토링을 하지 않고도 빠른 로직을 추가하는 데 유용할 수 있습니다. + +`ref.watch` 예제를 다시 작성하여 `ref.listen`을 대신 사용할 수 있습니다. + + + +:::info +provider의 빌드 단계에서 `ref.listen`을 사용하는 것은 전적으로 안전합니다. +provider가 어떻게든 다시 계산되면 이전 리스너가 제거됩니다. + +또는 `ref.listen`의 반환 값을 사용하여 원할 때 리스너를 수동으로 제거할 수 있습니다. +::: + +## `ref.read` 메소드 + +마지막으로 사용할 수 있는 옵션은 `ref.read`입니다. +이 옵션은 provider의 현재 상태를 반환한다는 점에서 `ref.watch`와 유사합니다. +하지만 `ref.watch`와 달리 공급자를 수신(listen)하지 않습니다. + +따라서 `ref.read`는 Notifier의 메서드 내부와 같이 `ref.watch`를 사용할 수 없는 곳에서만 사용해야 합니다. + + + +:::caution +provider에서 `ref.read`를 사용할 때는 주의하세요. provider를 수신(listen)하지 않으므로, 해당 provider가 수신(listen)하지 않으면 상태(state)를 파괴(destroy할 수 있습니다. +::: diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart new file mode 100644 index 000000000..2d6aa1460 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart @@ -0,0 +1,18 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +int example(ExampleRef ref) { + // 다른 provider를 읽으려면 여기에서 "Ref"를 사용할 수 있습니다. + final otherValue = ref.watch(otherProvider); + + return 0; +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart new file mode 100644 index 000000000..e1926f3be --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart @@ -0,0 +1,131 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + int create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'4429d7d3bb2b31fea4cc42c2f2af02d3f3d10693'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart new file mode 100644 index 000000000..f92fd1bc2 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart @@ -0,0 +1,14 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod/riverpod.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = Provider((ref) { + // "Ref" can be used here to read other providers + final otherValue = ref.watch(otherProvider); + + return 0; +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart new file mode 100644 index 000000000..7a417d13b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart @@ -0,0 +1,18 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +int example(ExampleRef ref) { + ref.listen(otherProvider, (previous, next) { + print('Changed from: $previous, next: $next'); + }); + + return 0; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart new file mode 100644 index 000000000..e86f55591 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart @@ -0,0 +1,131 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + int create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'd614303f372e06e6ab96035affc4c07a53b28741'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart new file mode 100644 index 000000000..334f73b5a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart @@ -0,0 +1,13 @@ +// ignore_for_file: unused_local_variable, avoid_print +import 'package:riverpod/riverpod.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = Provider((ref) { + ref.listen(otherProvider, (previous, next) { + print('Changed from: $previous, next: $next'); + }); + + return 0; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart new file mode 100644 index 000000000..1454617d1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart @@ -0,0 +1,21 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + int build() { + // 다른 provider를 읽으려면 여기에서 "Ref"를 사용할 수 있습니다. + final otherValue = ref.watch(otherProvider); + + return 0; + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart new file mode 100644 index 000000000..6be34301f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -0,0 +1,140 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +@ProviderFor(Example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $NotifierProvider { + const ExampleProvider._( + {super.runNotifierBuildOverride, Example Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Example Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Example create() => _createCb?.call() ?? Example(); + + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._(create: create); + } + + @$internal + @override + ExampleProvider $copyWithBuild( + int Function( + Ref, + Example, + ) build, + ) { + return ExampleProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$exampleHash() => r'893db991b377b8e314e60c429043e5e81f1fd526'; + +abstract class _$Example extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart new file mode 100644 index 000000000..c0602a6fc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart @@ -0,0 +1,19 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod/riverpod.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = NotifierProvider(MyNotifier.new); + +class MyNotifier extends Notifier { + @override + int build() { + // "Ref" can be used here to read other providers + final otherValue = ref.watch(otherProvider); + + return 0; + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart new file mode 100644 index 000000000..6a496a5ae --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // Bad! 여기서는 reactive가 아니므로 'read'를 사용하지 마세요. + ref.read(otherProvider); + + return 0; + } + + void increment() { + ref.read(otherProvider); // 여기서 'read'를 사용해도 괜찮습니다. + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart new file mode 100644 index 000000000..9c59854c2 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart @@ -0,0 +1,140 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'353efe22dd5a91b2d036286211ac9e60c9de5f6d'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart new file mode 100644 index 000000000..4735ea632 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod/riverpod.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final notifierProvider = NotifierProvider(MyNotifier.new); + +class MyNotifier extends Notifier { + @override + int build() { + // Bad! Do not use "read" here as it is not reactive + ref.read(otherProvider); + + return 0; + } + + void increment() { + ref.read(otherProvider); // Using "read" here is fine + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart new file mode 100644 index 000000000..1c174ce33 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart @@ -0,0 +1,44 @@ +// ignore_for_file: unused_local_variable + +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +final otherProvider = Provider((ref) => 0); + +const someStream = Stream<({double longitude, double latitude})>.empty(); + +/* SNIPPET START */ +@riverpod +Stream<({double longitude, double latitude})> location(LocationRef ref) { + // TO-DO: 현재 위치를 가져오는 Stream을 반환합니다. + return someStream; +} + +@riverpod +Future> restaurantsNearMe(RestaurantsNearMeRef ref) async { + // "ref.watch"를 사용하여 최신 위치를 가져옵니다. + // 공급자 뒤에 ".future"를 지정하면 코드가 적어도 하나의 위치를 사용할 수 있을 때까지 기다립니다. + final location = await ref.watch(locationProvider.future); + + // 이제 해당 위치를 기반으로 네트워크 요청을 할 수 있습니다. + // 예를 들어 Google 지도 API를 사용할 수 있습니다: + // https://developers.google.com/maps/documentation/places/web-service/search-nearby + final response = await http.get( + Uri.https('maps.googleapis.com', 'maps/api/place/nearbysearch/json', { + 'location': '${location.latitude},${location.longitude}', + 'radius': '1500', + 'type': 'restaurant', + 'key': '', + }), + ); + // JSON에서 레스토랑 이름 가져오기 + final json = jsonDecode(response.body) as Map; + final results = (json['results'] as List).cast>(); + return results.map((e) => e['name']! as String).toList(); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart new file mode 100644 index 000000000..1d47b1279 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart @@ -0,0 +1,125 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef LocationRef = Ref>; + +@ProviderFor(location) +const locationProvider = LocationProvider._(); + +final class LocationProvider extends $FunctionalProvider< + AsyncValue<({double longitude, double latitude})>, + Stream<({double longitude, double latitude})>, + LocationRef> + with + $FutureModifier<({double longitude, double latitude})>, + $StreamProvider<({double longitude, double latitude}), LocationRef> { + const LocationProvider._( + {Stream<({double longitude, double latitude})> Function( + LocationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'locationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream<({double longitude, double latitude})> Function( + LocationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$locationHash(); + + @$internal + @override + $StreamProviderElement<({double longitude, double latitude})> $createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + LocationProvider $copyWithCreate( + Stream<({double longitude, double latitude})> Function( + LocationRef ref, + ) create, + ) { + return LocationProvider._(create: create); + } + + @override + Stream<({double longitude, double latitude})> create(LocationRef ref) { + final _$cb = _createCb ?? location; + return _$cb(ref); + } +} + +String _$locationHash() => r'22e666f1e1ce04ce03d8f8d5652e25b54c1d1af3'; + +typedef RestaurantsNearMeRef = Ref>>; + +@ProviderFor(restaurantsNearMe) +const restaurantsNearMeProvider = RestaurantsNearMeProvider._(); + +final class RestaurantsNearMeProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, RestaurantsNearMeRef> + with + $FutureModifier>, + $FutureProvider, RestaurantsNearMeRef> { + const RestaurantsNearMeProvider._( + {FutureOr> Function( + RestaurantsNearMeRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'restaurantsNearMeProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + RestaurantsNearMeRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$restaurantsNearMeHash(); + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + RestaurantsNearMeProvider $copyWithCreate( + FutureOr> Function( + RestaurantsNearMeRef ref, + ) create, + ) { + return RestaurantsNearMeProvider._(create: create); + } + + @override + FutureOr> create(RestaurantsNearMeRef ref) { + final _$cb = _createCb ?? restaurantsNearMe; + return _$cb(ref); + } +} + +String _$restaurantsNearMeHash() => r'dd49cc1e6f16abb34dd15286d171e322c06b93b8'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart new file mode 100644 index 000000000..0d36e859e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart @@ -0,0 +1,41 @@ +// ignore_for_file: unused_local_variable + +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; + +final otherProvider = Provider((ref) => 0); + +const someStream = Stream<({double longitude, double latitude})>.empty(); + +/* SNIPPET START */ +final locationProvider = + StreamProvider<({double longitude, double latitude})>((ref) { + // TO-DO: Return a stream which obtains the current location + return someStream; +}); + +final restaurantsNearMeProvider = FutureProvider>((ref) async { + // We use "ref.watch" to obtain the latest location. + // By specifying that ".future" after the provider, our code will wait + // for at least one location to be available. + final location = await ref.watch(locationProvider.future); + + // We can now make a network request based on that location. + // For example, we could use the Google Map API: + // https://developers.google.com/maps/documentation/places/web-service/search-nearby + final response = await http.get( + Uri.https('maps.googleapis.com', 'maps/api/place/nearbysearch/json', { + 'location': '${location.latitude},${location.longitude}', + 'radius': '1500', + 'type': 'restaurant', + 'key': '', + }), + ); + // Obtain the restaurant names from the JSON + final json = jsonDecode(response.body) as Map; + final results = (json['results'] as List).cast>(); + return results.map((e) => e['name']! as String).toList(); +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart new file mode 100644 index 000000000..36f97a531 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart @@ -0,0 +1,38 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/foundation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +int example(ExampleRef ref) { + ref.watch(otherProvider); // Good! + ref.onDispose(() => ref.watch(otherProvider)); // Bad! + + final someListenable = ValueNotifier(0); + someListenable.addListener(() { + ref.watch(otherProvider); // Bad! + }); + + return 0; +} + +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + ref.watch(otherProvider); // Good! + ref.onDispose(() => ref.watch(otherProvider)); // Bad! + + return 0; + } + + void increment() { + ref.watch(otherProvider); // Bad! + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart new file mode 100644 index 000000000..0ecf40b5b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart @@ -0,0 +1,199 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + int create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'd4d63f5cf1aaec5b7c6a19e6fee18ddf070147ec'; + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'ad79fdb5b0e72a800fa03efc1e7157f0d1524844'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart new file mode 100644 index 000000000..6bec34337 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart @@ -0,0 +1,35 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/foundation.dart'; +import 'package:riverpod/riverpod.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = Provider((ref) { + ref.watch(otherProvider); // Good! + ref.onDispose(() => ref.watch(otherProvider)); // Bad! + + final someListenable = ValueNotifier(0); + someListenable.addListener(() { + ref.watch(otherProvider); // Bad! + }); + + return 0; +}); + +final notifierProvider = NotifierProvider(MyNotifier.new); + +class MyNotifier extends Notifier { + @override + int build() { + ref.watch(otherProvider); // Good! + ref.onDispose(() => ref.watch(otherProvider)); // Bad! + + return 0; + } + + void increment() { + ref.watch(otherProvider); // Bad! + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx new file mode 100644 index 000000000..acabeda84 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx @@ -0,0 +1,142 @@ +--- +title: 권장사항(DO/DON'T) +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; + +코드의 유지보수성을 높이기 위해 Riverpod를 사용할 때 따라야 할 모범 사례 목록은 다음과 같습니다. + +이 목록은 전체 목록이 아니며 변경될 수 있습니다. +제안 사항이 있으면 언제든지 [이슈를 열어주세요](https://github.com/rrousselGit/riverpod/issues/new?assignees=rrousselGit&labels=documentation%2C+needs+triage&projects=&template=example_request.md&title=). + +이 목록의 항목은 특별한 순서가 정해져 있지 않습니다. + +이러한 권장 사항의 상당 부분은 [riverpod_lint](https://pub.dev/packages/riverpod_lint)로 적용할 수 있습니다. +설치 지침은 를 참조하세요. + +## AVOID 위젯에서 provider를 초기화하지 마세요 + +Providers는 스스로 초기화해야 합니다. +위젯과 같은 외부 요소에 의해 초기화되어서는 안 됩니다. + +그렇게 하지 않으면 경합 상태(race conditions) 및 예기치 않은 동작(unexpected behaviors)이 발생할 수 있습니다. + +**DON'T** + +```dart +class WidgetState extends State { + @override + void initState() { + super.initState(); + // Bad: provider가 자체적으로 초기화해야 합니다. + ref.read(provider).init(); + } +} +``` + +**CONSIDER** + +이 문제에 대한 "모든 것에 맞는" 해결책은 없습니다. +초기화 로직이 provider 외부의 요인에 따라 달라지는 경우 이러한 로직을 배치하는 올바른 위치는 탐색(navigation)을 트리거하는 버튼의 `onPressed` 메서드에 있는 경우가 많습니다: + +```dart +ElevatedButton( + onPressed: () { + ref.read(provider).init(); + Navigator.of(context).push(...); + }, + child: Text('Navigate'), +) +``` + +## AVOID 로컬 위젯 상태에 provider를 사용하지 마세요. + +Provider는 공유 비즈니스 상태(shared business state)용으로 설계되었습니다. +로컬 위젯 상태와 같은 용도로는 사용하기에 적합하지 않습니다: + +- 양식(form) 상태 저장 +- 현재 선택된 항목 +- 애니메이션 +- 일반적으로 Flutter가 "controller"(예: `TextEditingController`)로 처리하는 모든 것 + +로컬 위젯 상태를 처리하는 방법을 찾고 있다면 대신 [flutter_hooks](https://pub.dev/packages/flutter_hooks)를 사용하는 것이 좋습니다. + +이를 권장하지 않는 이유 중 하나는 이러한 상태가 경로로 범위가 지정(scoped to a route)되는 경우가 많기 때문입니다. +그렇게 하지 않으면 새 페이지가 이전 페이지의 상태를 재정의하기 때문에 앱의 뒤로 가기 버튼이 손상될 수 있습니다. + +## DON'T provider를 초기화하는 동안 부가작업(side effects)을 수행하지 마세요. + +provider는 일반적으로 "read" 작업을 나타내는 데 사용해야 합니다. +양식 제출과 같은 "write" 작업에는 사용하지 않아야 합니다. + +이러한 작업에 provider를 사용하면, 이전에 수행된 부가작업을 건너뛰는 등 예기치 않은 동작이 발생할 수 있습니다. + +부가작업의 로딩/오류 상태를 처리하는 방법을 알아보려면 을 참조하세요. + +**DON'T**: + +```dart +final submitProvider = FutureProvider((ref) async { + final formState = ref.watch(formState); + + // Bad: 공급자는 'write' 작업에 사용해서는 안 됩니다. + return http.post('https://my-api.com', body: formState.toJson()); +}); +``` + +## PREFER 정적으로 알려진 providers를 사용하여 ref.watch/read/listen (및 유사한 API)를 호출하세요. + +Riverpod은 린트 규칙을 활성화할 것을 강력히 권장합니다(`riverpod_lint`를 통해). +하지만 린트를 효과적으로 사용하려면 코드를 정적으로 분석할 수 있는 방식으로 작성해야 합니다. + +그렇게 하지 않으면 버그를 발견하기가 더 어려워지거나 린트로 오탐이 발생할 수 있습니다. + +**Do**: + +```dart +final provider = Provider((ref) => 42); + +... + +// OK provider가 정적으로 알려져 있으므로 확인 가능 +ref.watch(provider); +``` + +**Don't**: + +```dart +class Example extends ConsumerWidget { + Example({required this.provider}); + final Provider provider; + + @override + Widget build(context, ref) { + // Bad 정적 분석이 `provider`가 무엇인지 알 수 없으므로 나쁨 + ref.watch(provider); + } +} +``` + +## AVOID 동적으로 providers 생성하지 않기 + +공급자는 최상위 레벨(top-level)의 final 변수만 사용해야 합니다. + +**Do**: + +```dart +final provider = Provider((ref) => 'Hello world'); +``` + +**Don't**: + +```dart +class Example { + // 지원되지 않는 작업입니다. 메모리 누수 및 예기치 않은 동작이 발생할 수 있습니다. + final provider = Provider((ref) => 'Hello world'); +} +``` + +:::info +provider를 static final 변수로 생성하는 것은 허용되지만, 코드 생성기에서는 지원되지 않습니다. +::: diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx new file mode 100644 index 000000000..c934ddb60 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx @@ -0,0 +1,58 @@ +--- +title: Providers의 빠른 초기화(Eager initialization) +version: 1 +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; +import consumerExample from "!!raw-loader!./eager_initialization/consumer_example.dart"; +import asyncConsumerExample from "!!raw-loader!./eager_initialization/async_consumer_example.dart"; +import requireValue from "./eager_initialization/require_value"; + +모든 providers는 기본적으로 느리게(Lazy) 초기화됩니다. +즉, provider는 처음 사용될 때만 초기화됩니다. +이는 애플리케이션의 특정 부분에서만 사용되는 provider에 유용합니다. + +안타깝게도 Dart의 작동 방식(tree shaking 목적)으로 인해 provider를 이른 초기화(eagerly initialized)해야 하는 것으로 플래그를 지정할 수 있는 방법은 없습니다. +그러나 한 가지 해결책은 애플리케이션의 루트에서 초기화하려는 공급자를 강제로 읽는(read) 것입니다. + +권장되는 접근 방식은 `ProviderScope` 바로 아래에 배치된 소비자(Consumer)에서 provider를 단순히 "watch"하는 것입니다: + + + +:::note +초기화 소비자(initialization consumer)를 "MyApp" 또는 공개 위젯에 넣는 것을 고려해 보세요. +이렇게 하면 메인(main)에서 로직을 제거하여 테스트에서 동일한 동작을 사용할 수 있습니다. +::: + +### FAQ + +#### provider가 변경되면 전체 애플리케이션이 다시 빌드되지 않나요? + +아니요, 그렇지 않습니다. +위의 샘플에서 열심히 초기화를 담당하는 Consumer는 별도의 위젯으로, `child`을 반환하는 것 외에는 아무것도 하지 않습니다. + +핵심은 `MaterialApp` 자체를 인스턴스화하는 것이 아니라 `child`을 반환한다는 것입니다. +즉, `_EagerInitialization`이 리빌드되더라도 `child` 변수는 변경되지 않습니다. +그리고 위젯이 변경되지 않으면 Flutter는 위젯을 다시 빌드하지 않습니다. + +따라서 다른 위젯이 해당 provider를 수신하고 있지 않는 한 `_EagerInitialization`만 리빌드됩니다. + +#### 이 접근 방식을 사용하면 로딩 및 오류 상태를 어떻게 처리할 수 있나요? + +`Consumer`에서 일반적으로 처리하는 것처럼 로딩/오류 상태를 처리할 수 있습니다. +`_EagerInitialization`은 프로바이더가 "loading" 상태인지 확인하고, 만약 그렇다면 `child` 대신 `CircularProgressIndicator`를 반환할 수 있습니다: + + + +#### 로딩/오류 상태를 처리했지만 다른 Consumer는 여전히 AsyncValue를 받습니다! 모든 위젯에서 로딩/에러 상태를 처리하지 않아도 되는 방법이 있나요? + +provider가 `AsyncValue`를 노출하지 않도록 하는 대신 위젯이 `AsyncValue.requireValue`를 사용하도록 할 수 있습니다. +이렇게 하면 패턴 매칭을 수행하지 않고도 데이터를 읽을 수 있습니다. 그리고 버그가 발생하면 명확한 메시지와 함께 예외를 던집니다. + + + +:::note +이러한 경우 로딩/오류 상태를 노출하지 않는 방법(스코핑(scoping)에 의존)이 있지만 일반적으로 그렇게 하지 않는 것이 좋습니다. +두 개의 providers를 만들고 오버라이드를 사용하는 복잡성을 감수할 가치가 없습니다. +::: diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart new file mode 100644 index 000000000..8abe709c1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart @@ -0,0 +1,27 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors, unused_element + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +final myProvider = FutureProvider((ref) => 0); + +/* SNIPPET START */ +class _EagerInitialization extends ConsumerWidget { + const _EagerInitialization({required this.child}); + final Widget child; + + @override + Widget build(BuildContext context, WidgetRef ref) { + final result = ref.watch(myProvider); + + // 오류 상태 및 로딩 상태 처리 + if (result.isLoading) { + return const CircularProgressIndicator(); + } else if (result.hasError) { + return const Text('Oopsy!'); + } + + return child; + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart new file mode 100644 index 000000000..43511f6e4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart @@ -0,0 +1,35 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +final myProvider = Provider((ref) => 0); + +/* SNIPPET START */ +void main() { + runApp(ProviderScope(child: MyApp())); +} + +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return const _EagerInitialization( + // TODO: 여기에서 앱 렌더링 + child: MaterialApp(), + ); + } +} + +class _EagerInitialization extends ConsumerWidget { + const _EagerInitialization({required this.child}); + final Widget child; + + @override + Widget build(BuildContext context, WidgetRef ref) { + // providers를 감시하여 이른 초기화(Eagerly initialize)합니다. + // "watch"를 사용하면 provider가 폐기(disposed)되지 않고 계속 살아 있습니다. + ref.watch(myProvider); + return child; + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart new file mode 100644 index 000000000..7025bd12d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +// 이른 초기화된 provider +@riverpod +Future example(ExampleRef ref) async => 'Hello world'; + +class MyConsumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final result = ref.watch(exampleProvider); + + /// provider가 올바르게 초기화되었다면, + /// "requireValue"로 데이터를 직접 읽을 수 있습니다. + return Text(result.requireValue); + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart new file mode 100644 index 000000000..fa3e37948 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart new file mode 100644 index 000000000..0a7b0580b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart @@ -0,0 +1,20 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +// An eagerly initialized provider. +final exampleProvider = FutureProvider((ref) async => 'Hello world'); + +class MyConsumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final result = ref.watch(exampleProvider); + + /// If the provider was correctly eagerly initialized, then we can + /// directly read the data with "requireValue". + return Text(result.requireValue); + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/faq.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/faq.mdx new file mode 100644 index 000000000..a7c0a8d25 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/faq.mdx @@ -0,0 +1,157 @@ +--- +title: 자주 묻는 질문(FAQ) +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; + +다음은 커뮤니티에서 자주 묻는 질문입니다: + +## `ref.refresh`와 `ref.invalidate`의 차이점은 무엇인가요? + +`ref`에는 provider가 강제로 재계산(recompute)하도록 하는 두 가지 메서드가 있다는 것을 알고 어떻게 다른지 궁금하셨을 것입니다. + +생각보다 간단합니다. `ref.refresh`는 `invalidate` + `read`를 위한 구문 설탕일 뿐입니다: + +```dart +T refresh(provider) { + invalidate(provider); + return read(provider); +} +``` + +provider를 다시 계산한 후 새 값을 신경 쓰지 않는다면 `invalidate`를 사용면 됩니다. +그 경우 대신 `refresh`를 사용하십시오. + +:::info +이 로직은 린트 규칙을 통해 자동으로 적용됩니다. +반환된 값을 사용하지 않고 `ref.refresh`를 사용하려고 하면 경고가 표시됩니다. +::: + +동작의 주요 차이점은 무효화(invalidating) 직후에 공급자를 읽으면 공급자가 **즉시(immediately)** 재계산(recomputes)한다는 것입니다. +반면, `invalidate`를 호출하고 바로 읽지 않으면 업데이트가 _나중에(later)_ 트리거됩니다. + +이 "나중에(later)" 업데이트는 일반적으로 다음 프레임이 시작될 때 이루어집니다. +그러나 현재 수신 중(listened)이 아닌 provider가 무효화되면, 다시 수신(listen)할 때까지 업데이트되지 않습니다. + +## Ref와 WidgetRef 사이에 공유 인터페이스가 없는 이유는 무엇인가요? + +Riverpod은 `Ref`와 `WidgetRef`를 자발적으로 분리합니다. +이는 조건부로 둘 중 하나에 의존하는 코드를 작성하지 않기 위해 의도적으로 수행됩니다. + +한 가지 문제는 `Ref`와 `WidgetRef`가 비슷해 보이지만 미묘한 차이가 있다는 것입니다. +둘 다에 의존하는 코드는 발견하기 어려운 방식으로 불안정할 수 있습니다. + +동시에 `WidgetRef`에 의존하는 것은 `BuildContext`에 의존하는 것과 같습니다. +이는 사실상 UI 레이어에 로직을 넣는 것이므로 권장하지 않습니다. + +--- + +이러한 코드는 항상 `Ref`를 사용하도록 리팩터링해야 합니다. + +이 문제에 대한 해결책은 일반적으로 로직을 `Notifier`로 옮긴 다음( 참조), 로직을 해당 `Notifier`의 메서드가 되도록 하는 것입니다. + +이렇게 하면 위젯이 이 로직을 호출하고자 할 때 다음과 같은 내용을 작성할 수 있습니다: + +```dart +ref.read(yourNotifierProvider.notifier).yourMethod(); +``` + +`yourMethod`는 다른 제공자와 상호작용하기 위해 `Notifier`의 `Ref`를 사용합니다. + +## 원시(raw) StatelessWidget을 사용하는 대신 ConsumerWidget을 확장(extend)해야 하는 이유는 무엇인가요? + +이는 `InheritedWidget` API의 안타까운 제한 때문입니다. + +몇 가지 문제가 있습니다: + +- `InheritedWidget`으로 "on change" 리스너를 구현할 수 없습니다. + 즉, `ref.listen`과 같은 것을 `BuildContext`와 함께 사용할 수 없습니다. + + `State.didChangeDependencies`가 가장 비슷하지만 신뢰할 수 없습니다. + 한 가지 문제는 특히 위젯 트리가 GlobalKey를 사용하는 경우(일부 Flutter 위젯은 이미 내부적으로 그렇게 하고 있습니다) 종속성이 변경되지 않더라도 수명 주기가 트리거될 수 있다는 것입니다. + +- `InheritedWidget`을 수신하는 위젯은 수신이 중단되지 않습니다. + 이는 일반적으로 "테마" 또는 "미디어 쿼리"와 같은 순수한 메타데이터의 경우 괜찮습니다. + + 비즈니스 로직의 경우 이는 문제가 됩니다. + 페이지가 지정된 API를 표현하기 위해 provider를 사용한다고 가정해 봅시다. + 페이지 오프셋이 변경되면 위젯이 이전에 표시된 페이지를 계속 수신하고 싶지 않을 것입니다. + +- `InheritedWidget`은 위젯이 언제 청취(listening)를 중단하는지 추적할 수 있는 방법이 없습니다. + Riverpod은 때때로 공급자가 수신 대기 중인지 여부를 추적하는 데 의존합니다. + +이 기능은 자동 폐기 메커니즘(auto dispose mechanism)과 provider에게 인수를 전달하는 기능 모두에 매우 중요합니다. +이러한 기능들이 Riverpod를 강력하게 만드는 원동력입니다. + +먼 미래에는 이러한 문제가 해결될 수도 있습니다. 이 경우 Riverpod는 `Ref` 대신 `BuildContext`를 사용하도록 마이그레이션할 것입니다. +이렇게 되면 `ConsumerWidget` 대신 `StatelessWidget`을 사용할 수 있게 됩니다. +하지만 그건 다음 기회에! + +## hooks_riverpod이 flutter_hooks을 export하지 않는 이유는? + +이는 올바른 버전 관리 관행을 존중하기 위한 것입니다. + +`hooks_riverpod`은 `flutter_hooks` 없이 사용할 수 없지만, 두 패키지는 독립적으로 버전이 관리됩니다. +한 쪽에서는 변경 사항이 발생해도 다른 쪽에서는 발생하지 않을 수 있습니다. + +## Riverpod이 업데이트를 필터링할 때 `==` 대신 `identical`을 사용하는 이유는 무엇인가요? + +Notifiers는 `==` 대신 `identical`을 사용하여 업데이트를 필터링합니다. + +이는 riverpod 사용자들이 copyWith 구현을 위해 Freezed/built_value와 같은 코드 생성기를 사용하는 것이 일반적이기 때문입니다. +이러한 패키지는 `==`를 재정의하여 객체를 심층적으로 비교합니다. +객체 심층 비교는 상당히 많은 비용이 듭니다. +"비즈니스 로직" 모델에는 많은 프로퍼티가 있는 경향이 있습니다. +더 나쁜 것은 목록, 지도 등과 같은 컬렉션도 있다는 것입니다. + +동시에 복잡한 "비즈니스" 객체를 사용할 때 대부분의 `state = newState` 호출은 항상 알림(notification)을 발생시킵니다.(그렇지 않으면 setter를 호출할 필요가 없습니다) +일반적으로 현재 상태와 새 상태가 같을 때 `state = newState`를 호출하는 주된 경우는 원시 객체(primitive objects)(lists/classes/...가 아닌 ints, enums, strings)에 대한 것입니다. +이러한 객체는 "기본적으로 표준화(canonicalized by default)"됩니다. 이러한 객체가 같으면 일반적으로 "동일(identical)"합니다. + +따라서 riverpod은 `identical`을 사용하여 업데이트를 필터링하는 것은 두 가지 모두에 좋은 기본값을 갖기 위한 시도입니다. +객체 필터링에 크게 신경 쓰지 않고 코드 생성기가 기본적으로 `==` 오버라이드를 생성하기 때문에 `==`가 비쌀 수 있는 복잡한 객체의 경우, `identical`을 사용하면 리스너에게 효율적으로 알림을 제공할 수 있습니다. +동시에 단순한 객체의 경우 `identical`은 중복 알림을 올바르게 필터링합니다. + +Last but not least, you can change this behavior by overriding the method `updateShouldNotify` on Notifiers. +마지막으로, Notifiers에서 `updateShouldNotify` 메서드를 재정의하여 이 동작을 변경할 수 있습니다. + +## 모든 providers를 한 번에 재설정(reset)하는 방법이 있나요? + +아니요, 모든 providers를 한 번에 재설정할 수 있는 방법은 없습니다. + +이는 안티 패턴으로 간주되기 때문에 일부러 그렇게 한 것입니다. +모든 공급업체를 한 번에 재설정하면 재설정하지 않으려던 공급업체도 재설정되는 경우가 많습니다. + +이는 사용자가 로그아웃할 때 애플리케이션의 상태를 초기화하려는 사용자가 주로 요청하는 기능입니다. +이 기능을 원하는 경우, 대신 사용자의 상태에 따라 달라지는 모든 것을 "user" provider를 `ref.watch`로 설정해야 합니다. + +그러면 사용자가 로그아웃하면 그에 따라 모든 providers가 자동으로 재설정되지만 다른 모든 것은 그대로 유지됩니다. + +## "Cannot use "ref" after the widget was disposed"라는 오류가 발생했는데 무엇이 문제인가요? + +"Bad state: No ProviderScope found"이라는 동일한 문제의 이전 오류 메시지가 표시될 수도 있습니다. + +이 오류는 더 이상 마운트되지 않은 위젯에서 `ref`를 사용하려고 할 때 발생합니다. +이 오류는 일반적으로 `await` 이후에 발생합니다: + +```dart +ElevatedButton( + onPressed: () async { + await future; + ref.read(...); // May throw "Cannot use "ref" after the widget was disposed" + } +) +``` + +해결책은 `BuildContext`와 마찬가지로 `ref`를 사용하기 전에 `mounted`를 확인하는 것입니다: + +```dart +ElevatedButton( + onPressed: () async { + await future; + if (!context.mounted) return; + ref.read(...); // No longer throws + } +) +``` diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request.mdx new file mode 100644 index 000000000..cd73f81cb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request.mdx @@ -0,0 +1,320 @@ +--- +title: 첫 번째 provider/네트워크 요청 만들기 +pagination_prev: introduction/getting_started +version: 1 +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import activity from "./first_request/activity"; +import provider from "./first_request/provider"; +import consumer from "./first_request/consumer"; +import consumerWidget from "./first_request/consumer_widget"; +import consumerStatefulWidget from "./first_request/consumer_stateful_widget"; +import hookConsumerWidget from "./first_request/hook_consumer_widget"; +import Legend from "./first_request/legend/legend"; + +네트워크 요청은 모든 애플리케이션의 핵심입니다. +하지만 네트워크 요청을 할 때는 고려해야 할 사항이 많습니다: + +- 요청이 이루어지는 동안 UI는 로딩 상태를 렌더링해야 합니다. +- 오류는 정상적으로 처리되어야 합니다. +- 요청은 가능하면 캐시되어야 합니다. + +이 섹션에서는 Riverpod이 이 모든 것을 자연스럽게 처리하는 데 어떻게 도움이 되는지 살펴보겠습니다. + +## `ProviderScope` 설정하기 + +네트워크 요청을 시작하기 전에 애플리케이션의 루트에 `ProviderScope`가 추가되었는지 확인하세요. + +```dart +void main() { + runApp( + // Riverpod을 설치하려면 다른 모든 위젯 위에 이 위젯을 추가해야 합니다. + // 이 위젯은 "MyApp" 내부가 아니라 "runApp"에 직접 파라미터로 추가해야 합니다. + ProviderScope( + child: MyApp(), + ), + ); +} +``` + +이렇게 하면 전체 애플리케이션에 대해 Riverpod이 활성화됩니다. + +:::note +[riverpod_lint](https://pub.dev/packages/riverpod_lint) 설치와 같은 전체 설치 단계는 를 확인하세요 +::: + +## "provider"에서 네트워크 요청 수행하기 + +네트워크 요청을 수행하는 것을 보통 "비즈니스 로직"이라고 부릅니다. +Riverpod에서 비즈니스 로직은 "providers" 내부에 배치됩니다. +프로바이더는 초강력(super-powered) 함수입니다. +일반 함수처럼 동작하지만 다음과 같은 이점이 추가됩니다: + +- 캐시됩니다. +- 기본적인 오류/로딩 처리를 제공합니다. +- 리스너를 추가할 수 있습니다. +- 데이터가 변경될 때 자동으로 다시 실행됩니다. + +따라서 공급자는 _GET_ 네트워크 요청에 가장 적합합니다. (_POST/etc_ 요청의 경우, 참조) + +예를 들어, 지루할 때 할 수 있는 무작위 활동을 제안하는 간단한 애플리케이션을 만들어 보겠습니다. +이를 위해 [Bored API](https://boredapi.com/)를 사용하겠습니다. +특히 `/api/activity` 엔드포인트에서 _GET_ 요청을 수행하겠습니다. +그러면 JSON 객체가 반환되며, 이 객체를 Dart 클래스 인스턴스로 파싱합니다. +다음 단계는 이 활동을 UI에 표시하는 것입니다. +또한 요청이 이루어지는 동안 로딩 상태를 렌더링하고 오류를 정상적으로 처리해야 합니다. + +멋지게 들리나요? 시작해보세요! + +### 모델 정의하기 + +시작하기 전에 API에서 수신할 데이터의 모델을 정의해야 합니다. +이 모델에는 JSON 객체를 Dart 클래스 인스턴스로 파싱하는 방법도 필요합니다. + +일반적으로 JSON 디코딩을 처리할 때는 [Freezed](https://pub.dev/packages/freezed) 또는 [json_serializable](https://pub.dev/packages/json_serializable)과 같은 코드 생성기를 사용하는 것이 좋습니다. +물론 수작업으로 처리하는 것도 가능합니다. + +어쨌든, 여기 우리의 모델이 있습니다: + + + +### 공급자 만들기 + +이제 모델이 생겼으니 API 쿼리를 시작할 수 있습니다. +그러기 위해서는 첫 번째 공급자를 만들어야 합니다. + +공급자를 정의하는 구문은 다음과 같습니다: + + +((ref) { + +}); +`} + annotations={[ + { + offset: 6, + length: 4, + label: "provider 변수", + description: <> + +이 변수는 공급자와 상호 작용하는 데 사용되는 변수입니다. +변수는 final이여야하고, "top-level" (global)에 선언되어야 합니다. + + + }, + { + offset: 13, + length: 12, + label: "provider 타입", + description: <> + +일반적으로 `Provider`, `FutureProvider` 또는 `StreamProvider`중 하나입니다. +사용되는 provider 타입은은 함수의 반환값에 따라 달라집니다. +예를 들어, `Future`를 만들려면 `FutureProvider`가 필요할 것입니다. + +`FutureProvider`가 가장 많이 사용될 것입니다. + +:::tip +"어떤 provider를 선택해야 하나"라는 관점에서 생각하지 마세요. +대신 "내가 무엇을 반환하고 싶은가"라는 관점에서 생각하세요. +공급자 유형은 자연스럽게 따라올 것입니다. +::: + + + }, + { + offset: 25, + length: 13, + label: "수정자(Modifiers) (optional)", + description: <> + +종종 provider 타입 뒤에 "수정자(Modifiers)"가 표시될 수 있습니다. +수정자(Modifiers)는 선택 사항이며, 타입에 안전한 방식으로 공급자의 동작을 조정하는 데 사용됩니다. + +현재 두 가지 수정자를 사용할 수 있습니다: + +- 공급자가 더 이상 사용되지 않을 때 캐시를 자동으로 지우는 `autoDispose`. + 도 참조하세요. +- provider에 인수를 전달할 수 있는 `family`. + 도 참조하세요. + + + }, + { + offset: 48, + length: 3, + label: "Ref", + description: <> + +다른 provider와 상호작용하는 데 사용되는 객체입니다. +모든 providers는 provider 함수의 매개변수(parameter) 또는 Notifier의 속성(property)으로 하나씩 가지고 있습니다. + + + }, + { + offset: 57, + length: 17, + label: "provider 함수", + description: <> + +여기에 프로바이더의 로직을 배치합니다. +이 함수는 공급자를 처음 읽을 때 호출됩니다. +이후 읽기는 이 함수를 다시 호출하지 않고 대신 캐시된 값을 반환합니다. + + + }, +]} +/> + + + + +} +`} + annotations={[ + { + offset: 0, + length: 9, + label: "어노테이션(annotation)", + description: <> + +모든 프로바이더는 `@riverpod` 또는 `@Riverpod()`로 어노테이션해야 합니다. +이 어노테이션은 전역 함수나 클래스에 배치할 수 있습니다. +이 어노테이션을 통해 프로바이더를 구성할 수 있습니다. + +예를 들어, `@Riverpod(keepAlive: true)`를 작성하여 "auto-dispose"(나중에 살펴보겠습니다)를 비활성화할 수 있습니다. + + + }, + { + offset: 17, + length: 10, + label: "어노테이션된 함수(annotated function)", + description: <> + +어노테이션된 함수의 이름에 따라 provider와 상호작용하는 방식이 결정됩니다. +주어진 함수 `myFunction`에 대해 생성된 `myFunctionProvider` 변수가 생성됩니다. + +어노테이션된 함수는 첫 번째 매개변수로 "ref"를 지정해야 합니다. +그 외에도 함수는 제네릭을 포함하여 여러 개의 매개변수를 가질 수 있습니다. +이 함수는 원할 경우 `Future`/`Stream`을 반환할 수도 있습니다. + +이 함수는 공급자를 처음 읽을 때 호출됩니다. +이후 읽기는 함수를 다시 호출하지 않고 대신 캐시된 값을 반환합니다. + + + }, + { + offset: 28, + length: 17, + label: "Ref", + description: <> + +다른 providers와 상호작용하는 데 사용되는 객체입니다. +모든 providers에는 provider 함수의 매개변수(parameter) 또는 Notifier의 속성(property)으로 하나씩 가지고 있습니다. +이 객체의 타입은 함수/클래스의 이름에 의해 결정됩니다. + + + }, +]} +/> + + +여기서는 API에서 Activity를 _GET_하고자 합니다. +_GET_은 비동기 연산이므로 `Future`를 생성해야 합니다. + +따라서 앞서 정의한 구문을 사용하여 다음과 같이 공급자를 정의할 수 있습니다: + + + +이 코드조각에서는 UI가 임의의 액티비티를 가져오는 데 사용할 수 있는 `activityProvider`라는 이름의 공급자를 정의했습니다. +다음과 같은 것은 주목할 가치가 있습니다: + +- 네트워크 요청은 UI가 provider를 한 번 이상 읽을 때까지 실행되지 않습니다. +- 이후 읽기는 네트워크 요청을 다시 실행하지 않고 이전에 가져온 활동을 반환합니다. +- UI가 이 공급자의 사용을 중단하면 캐시가 삭제됩니다. + 그런 다음 UI가 이 공급자를 다시 사용하면 새로운 네트워크 요청이 이루어집니다. +- 오류는 catch되지 않았습니다. 이는 공급자가 기본적으로 오류를 처리하기 때문에 자발적인 조치입니다. + 네트워크 요청이나 JSON 파싱에서 에러가 발생하면 riverpod에서 에러를 catch합니다. + 그러면 UI에 오류 페이지를 렌더링하는 데 필요한 정보가 자동으로 표시됩니다. + +:::info +Provider는 "지연(lazy)"입니다. 공급자를 정의해도 네트워크 요청이 실행되지 않습니다. +대신 공급자를 처음 읽을 때 네트워크 요청이 실행됩니다. +::: + +### UI에서 네트워크 요청의 응답 렌더링하기 + +Now that we have defined a provider, we can start using it inside our UI to display the activity. + +provider와 상호 작용하려면 "ref"라는 객체가 필요합니다. +provider는 당연히 "ref" 객체에 액세스할 수 있으므로 이전에 provider 정의에서 이 객체를 보셨을 것입니다. +하지만 여기서는 provider가 아니라 위젯에 있습니다. 그렇다면 "ref"는 어떻게 얻을 수 있을까요? + +해결책은 `Consumer`라는 커스텀 위젯을 사용하는 것입니다. +`Consumer`는 `Builder`와 비슷한 위젲이지만, "ref"를 제공한다는 추가적인 이점이 있습니다. +이를 통해 UI가 공급자를 읽을 수 있습니다. +다음 예제는 `Consumer`를 사용하는 방법을 보여줍니다: + + + +이 코드 조각에서는 `Consumer`를 사용하여 `activityProvider`를 읽고 Activity를 표시했습니다. +또한 로딩/오류 상태도 우아하게 처리했습니다. +provider에서 특별한 작업을 하지 않고도 UI가 어떻게 로딩/오류 상태를 처리할 수 있었는지 주목하세요. +동시에 위젯이 다시 빌드될 경우 네트워크 요청이 올바르게 다시 실행되지 않습니다. +다른 위젯도 네트워크 요청을 다시 실행하지 않고도 동일한 provider에 액세스할 수 있습니다. + +:::info +위젯은 원하는 만큼 많은 providers를 수신(listen)할 수 있습니다. 그렇게 하려면 `ref.watch` 호출을 더 추가하기만 하면 됩니다. +::: + +:::tip +linter를 설치하세요. +그러면 IDE에서 자동으로 `Consumer`를 추가하거나 `StatelessWidget`을 `ConsumerWidget`으로 변환하는 리팩터링 옵션을 이용할 수 있습니다. + +설치 단계는 를 참고하세요. +::: + +## 더 살펴보기: `Consumer` 대신 `ConsumerWidget`을 사용하여 코드 들여쓰기 제거하기. + +이전 예제에서는 `Consumer`를 사용하여 provider를 읽었습니다. +이 접근 방식에 문제가 있는 것은 아니지만, 들여쓰기가 추가되면 코드를 읽기 어렵게 만들 수 있습니다. + +Riverpod은 동일한 결과를 얻을 수 있는 다른 방법을 제공합니다: +`StatelessWidget`/`StatefulWidget`이 `Consumer`를 반환하는 코드를 작성하는 대신 `ConsumerWidget`/`ConsumerStatefulWidget`을 정의할 수 있습니다. +`ConsumerWidget`과 `ConsumerStatefulWidget`은 사실상 `StatelessWidget`/`StatefulWidget`과 `Consumer`를 결합한 것입니다. +이들은 원래의 짝과 동일하게 동작하지만 "ref"를 제공한다는 추가적인 이점이 있습니다. + +이전 예제를 다음과 같이 `ConsumerWidget`을 사용하도록 다시 작성할 수 있습니다: + + + +`ConsumerStatefulWidget`의 경우 대신 다음과 같이 작성합니다: + + + +### Flutter_hooks 고려 사항: `HookWidget`과 `ConsumerWidget`의 결합 + +:::caution +"훅(Hooks)"에 대해 들어본 적이 없다면 이 섹션을 건너뛰셔도 됩니다. +[Flutter_hooks](https://pub.dev/packages/flutter_hooks)는 Riverpod과는 별개의 패키지이지만 Riverpod과 함께 사용되는 경우가 많습니다. +Riverpod을 처음 사용하는 경우 "훅(Hooks)" 사용을 권장하지 않습니다. 자세한 내용은 에서 확인하세요. +::: + +`flutter_hooks`를 사용하는 경우 `HookWidget`과 `ConsumerWidget`을 결합하는 방법이 궁금할 수 있습니다. +결국 둘 다 확장된(extended) 위젯 클래스를 변경해야 합니다. + +Riverpod는 이 문제에 대한 해결책으로 `HookConsumerWidget`과 `StatefulHookConsumerWidget`을 제공합니다. +`ConsumerWidget`과 `ConsumerStatefulWidget`이 `Consumer`와 `StatelessWidget`/`StatefulWidget`의 결합인 것과 유사하게, +`HookConsumerWidget`과 `StatefulHookConsumerWidget`은 `Consumer`와 `HookWidget`/`HookStatefulWidget`의 결합입니다. +따라서 동일한 위젯에서 훅(Hooks)와 providers를 모두 사용할 수 있습니다. + +이를 보여주기 위해 이전 예제를 다시 한 번 다시 작성해 보겠습니다: + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts new file mode 100644 index 000000000..5cea035c7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/activity.dart"; +import codegen from "!!raw-loader!./codegen/activity.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart new file mode 100644 index 000000000..5a810a08f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart @@ -0,0 +1,24 @@ +/* SNIPPET START */ + +import 'package:freezed_annotation/freezed_annotation.dart'; + +part 'activity.freezed.dart'; +part 'activity.g.dart'; + +/// `GET /api/activity` 엔드포인트의 응답 +/// +/// `freezed`와 `json_serializable`을 사용하여 정의됩니다. +@freezed +class Activity with _$Activity { + factory Activity({ + required String key, + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + /// JSON 객체를 [Activity] 인스턴스로 변환합니다. + /// 이렇게 하면 API 응답을 형안정(Type-safe)하게 읽을 수 있습니다. + factory Activity.fromJson(Map json) => _$ActivityFromJson(json); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart new file mode 100644 index 000000000..6ffa343c1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart @@ -0,0 +1,237 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'activity.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get key => throw _privateConstructorUsedError; + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call( + {String key, + String activity, + String type, + int participants, + double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? key = null, + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + key: null == key + ? _value.key + : key // ignore: cast_nullable_to_non_nullable + as String, + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call( + {String key, + String activity, + String type, + int participants, + double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? key = null, + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + key: null == key + ? _value.key + : key // ignore: cast_nullable_to_non_nullable + as String, + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.key, + required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String key; + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(key: $key, activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.key, key) || other.key == key) && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, key, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String key, + required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get key; + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart new file mode 100644 index 000000000..55a7a5383 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'activity.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + key: json['key'] as String, + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'key': instance.key, + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart new file mode 100644 index 000000000..19901c6c4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart @@ -0,0 +1,21 @@ +/* SNIPPET START */ + +import 'dart:convert'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'activity.dart'; + +// 코드 생성이 작동하는 데 필요합니다. +part 'provider.g.dart'; + +/// 그러면 `activityProvider`라는 이름의 provider가 생성됩니다. +/// 이 함수의 결과를 캐시하는 공급자를 생성합니다. +@riverpod +Future activity(ActivityRef ref) async { + // package:http를 사용하여 Bored API에서 임의의 Activity를 가져옵니다. + final response = await http.get(Uri.https('boredapi.com', '/api/activity')); + // 그런 다음 dart:convert를 사용하여 JSON 페이로드를 맵 데이터 구조로 디코딩합니다. + final json = jsonDecode(response.body) as Map; + // 마지막으로 맵을 Activity 인스턴스로 변환합니다. + return Activity.fromJson(json); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart new file mode 100644 index 000000000..f76d3098c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +/// 그러면 `activityProvider`라는 이름의 provider가 생성됩니다. +/// 이 함수의 결과를 캐시하는 공급자를 생성합니다. +typedef ActivityRef = Ref>; + +/// 그러면 `activityProvider`라는 이름의 provider가 생성됩니다. +/// 이 함수의 결과를 캐시하는 공급자를 생성합니다. +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +/// 그러면 `activityProvider`라는 이름의 provider가 생성됩니다. +/// 이 함수의 결과를 캐시하는 공급자를 생성합니다. +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + /// 그러면 `activityProvider`라는 이름의 provider가 생성됩니다. + /// 이 함수의 결과를 캐시하는 공급자를 생성합니다. + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'636cd5510e09cbfc46f31b74a70d9e98c89e95a4'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts new file mode 100644 index 000000000..a625b7073 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/consumer.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts new file mode 100644 index 000000000..5e6ac973a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/consumer_stateful_widget.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts new file mode 100644 index 000000000..56cb2331d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/consumer_widget.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts new file mode 100644 index 000000000..300ec6596 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/hook_consumer_widget.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss new file mode 100644 index 000000000..bda077971 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss @@ -0,0 +1,18 @@ +.legend { + table, + td, + tr { + background: none !important; + border: none; + + vertical-align: top; + } + + td:first-child { + text-align: end; + } + + tr + tr { + border-top: solid 0.5px; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx new file mode 100644 index 000000000..048817ec0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx @@ -0,0 +1,88 @@ +import React from "react"; +import PropTypes from "prop-types"; +import CodeBlock from "@theme/CodeBlock"; +import "./DocuCode.scss"; + +type AnnotatedCode = { + color?: string; + code: string; +}; + +export const colors = [ + "#2196f3", + "#4caf50", + "#f44336", + "#ff9800", + "#009688", + "#e91e63", + "#00bcd4", + "#8bc34a", +]; + +const Legend = ({ annotations, code }) => { + const fullAnnotations = new Array(); + + let annotationOffset = 0; + for (var codeOffset = 0; codeOffset < code.length; ) { + if (annotationOffset >= annotations.length) { + // Out of annotations, just add the rest of the code + fullAnnotations.push({ code: code.substring(codeOffset) }); + break; + } + + const annotation = annotations[annotationOffset]; + if (codeOffset < annotation.offset) { + /// There is an unannotated gap between the last annotation and this one. + const codeLength = annotation.offset - codeOffset; + fullAnnotations.push({ + code: code.substring(codeOffset, codeOffset + codeLength), + }); + codeOffset += codeLength; + } + + if (annotation.offset >= code.length) { + throw new Error("Annotation offset out of bounds"); + } + + annotationOffset++; + codeOffset = annotation.offset + annotation.length; + fullAnnotations.push({ + color: colors[annotationOffset - 1], + code: code.substring( + annotation.offset, + annotation.offset + annotation.length + ), + }); + } + + return ( +
+ 
+        {fullAnnotations.map(({ code, color }) => {
+          let underlineClass = color ? `underline` : "";
+          let style = color ? { color: color } : undefined;
+
+          return (
+            
+              {code}
+            
+          );
+        })}
+
+ + + {annotations.map((annotation, index) => ( + + + + + ))} + +
+ {annotation.label} + {annotation.description}
+
+ ); +}; + +export default Legend; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts new file mode 100644 index 000000000..42ce35bff --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/provider.dart"; +import codegen from "!!raw-loader!./codegen/provider.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart new file mode 100644 index 000000000..794d36782 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart @@ -0,0 +1,30 @@ +/* SNIPPET START */ + +/// The response of the `GET /api/activity` endpoint. +class Activity { + Activity({ + required this.key, + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + /// Convert a JSON object into an [Activity] instance. + /// This enables type-safe reading of the API response. + factory Activity.fromJson(Map json) { + return Activity( + key: json['key'] as String, + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: json['price'] as double, + ); + } + + final String key; + final String activity; + final String type; + final int participants; + final double price; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart new file mode 100644 index 000000000..718aa25e8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart @@ -0,0 +1,41 @@ +// ignore_for_file: omit_local_variable_types + +/* SNIPPET START */ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/// The homepage of our application +class Home extends StatelessWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context) { + return Consumer( + builder: (context, ref, child) { + // Read the activityProvider. This will start the network request + // if it wasn't already started. + // By using ref.watch, this widget will rebuild whenever the + // the activityProvider updates. This can happen when: + // - The response goes from "loading" to "data/error" + // - The request was refreshed + // - The result was modified locally (such as when performing side-effects) + // ... + final AsyncValue activity = ref.watch(activityProvider); + + return Center( + /// Since network-requests are asynchronous and can fail, we need to + /// handle both error and loading states. We can use pattern matching for this. + /// We could alternatively use `if (activity.isLoading) { ... } else if (...)` + child: switch (activity) { + AsyncData(:final value) => Text('Activity: ${value.activity}'), + AsyncError() => const Text('Oops, something unexpected happened'), + _ => const CircularProgressIndicator(), + }, + ); + }, + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart new file mode 100644 index 000000000..2ba511a07 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart @@ -0,0 +1,43 @@ +// ignore_for_file: omit_local_variable_types, prefer_const_constructors, unused_local_variable, todo + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/* SNIPPET START */ + +// We extend ConsumerStatefulWidget. +// This is the equivalent of "Consumer" + "StatefulWidget". +class Home extends ConsumerStatefulWidget { + const Home({super.key}); + + @override + ConsumerState createState() => _HomeState(); +} + +// Notice how instead of "State", we are extending "ConsumerState". +// This uses the same principle as "ConsumerWidget" vs "StatelessWidget". +class _HomeState extends ConsumerState { + @override + void initState() { + super.initState(); + + // State life-cycles have access to "ref" too. + // This enables things such as adding a listener on a specific provider + // to show dialogs/snackbars. + ref.listenManual(activityProvider, (previous, next) { + // TODO show a snackbar/dialog + }); + } + + @override + Widget build(BuildContext context) { + // "ref" is not passed as parameter anymore, but is instead a property of "ConsumerState". + // We can therefore keep using "ref.watch" inside "build". + final AsyncValue activity = ref.watch(activityProvider); + + return Center(/* ... */); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart new file mode 100644 index 000000000..1f01fa38a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart @@ -0,0 +1,25 @@ +// ignore_for_file: omit_local_variable_types, prefer_const_constructors, unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/* SNIPPET START */ + +/// We subclassed "ConsumerWidget" instead of "StatelessWidget". +/// This is equivalent to making a "StatelessWidget" and retuning "Consumer". +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + // Notice how "build" now receives an extra parameter: "ref" + Widget build(BuildContext context, WidgetRef ref) { + // We can use "ref.watch" inside our widget like we did using "Consumer" + final AsyncValue activity = ref.watch(activityProvider); + + // The rendering logic stays the same + return Center(/* ... */); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart new file mode 100644 index 000000000..1fc7306dc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart @@ -0,0 +1,28 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_const_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/* SNIPPET START */ + +/// "HookConsumerWidget"을 서브클래스화했습니다. +/// 이것은 "StatelessWidget" + "Consumer" + "HookWidget"을 함께 결합합니다. +class Home extends HookConsumerWidget { + const Home({super.key}); + + @override + // 이제 "build"가 추가 매개 변수 "ref"를 받는 것에 주목하세요. + Widget build(BuildContext context, WidgetRef ref) { + // 위젯 내부에서 "useState"와 같은 훅을 사용할 수 있습니다. + final counter = useState(0); + + // providers도 읽을 수 있습니다. + final AsyncValue activity = ref.watch(activityProvider); + + return Center(/* ... */); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart new file mode 100644 index 000000000..f1395604f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart @@ -0,0 +1,15 @@ +/* SNIPPET START */ + +import 'dart:convert'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; +import 'activity.dart'; + +final activityProvider = FutureProvider.autoDispose((ref) async { + // Using package:http, we fetch a random activity from the Bored API. + final response = await http.get(Uri.https('boredapi.com', '/api/activity')); + // Using dart:convert, we then decode the JSON payload into a Map data structure. + final json = jsonDecode(response.body) as Map; + // Finally, we convert the Map into an Activity instance. + return Activity.fromJson(json); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx new file mode 100644 index 000000000..5bf4dc7c0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx @@ -0,0 +1,137 @@ +--- +title: 요청에 인자 전달하기 +version: 1 +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import noArgProvider from "./passing_args/no_arg_provider"; +import family from "!!raw-loader!./passing_args/raw/family.dart"; +import codegenFamily from "!!raw-loader!./passing_args/codegen/family.dart"; +import consumerProvider from "!!raw-loader!./passing_args/raw/consumer_provider.dart"; +import consumerFamily from "!!raw-loader!./passing_args/raw/consumer_family.dart"; +import consumerListFamily from "!!raw-loader!./passing_args/raw/consumer_list_family.dart"; +import multipleConsumerFamily from "!!raw-loader!./passing_args/raw/multiple_consumer_family.dart"; +import tupleFamily from "!!raw-loader!./passing_args/raw/tuple_family.dart"; +import consumerTupleFamily from "!!raw-loader!./passing_args/raw/consumer_tuple_family.dart"; + +이전 글에서 "provider"를 정의하여 간단한 _GET_ HTTP 요청을 만드는 방법을 살펴봤습니다. +하지만 HTTP 요청은 외부 매개변수(external parameters)에 의존하는 경우가 많습니다. + +예를 들어, 이전에는 사용자에게 무작위 액티비티를 제안하기 위해 [Bored API](https://boredapi.com/)를 사용했습니다. +하지만 사용자가 원하는 액티비티 타입을 필터링하거나 가격 요구 사항 등을 원할 수도 있습니다. +이러한 매개변수는 미리 알 수 없습니다. +따라서 이러한 매개변수를 UI에서 providers에 전달할 방법이 필요합니다. + +## 인수를 허용하도록 providers 업데이트 + +참고로 이전에는 다음과 같이 provider를 정의했습니다: + + + + + +코드 생성(code-generation)에 의존하지 않을 때는 인자 전달(passing arguments)을 지원하기 위해 provider 정의 구문을 약간 조정해야 합니다. +이는 "family"라는 "수정자(modifier)"에 의존하여 수행됩니다. + +간단히 말해, provider 타입 뒤에 `.family`를 추가하고 인수 타입(argument type)에 해당하는 추가 타입 매개 변수를 추가해야 합니다. +예를 들어, 원하는 액티비티 타입에 해당하는 `String` 인수를 받도록 provider를 업데이트할 수 있습니다: + + + + + + + +provider에게 매개변수(parameters)를 전달하려면 어노테이션이 달린 함수 자체에 매개변수(parameters)를 추가하기만 하면 됩니다. +예를 들어, 원하는 액티비티 타입에 해당하는 `String` 인수를 받도록 provider를 업데이트할 수 있습니다: + + + + + +:::caution +provider에게 인수(arguments)를 전달할 때는 provider에서 "autoDispose"를 활성화하는 것이 좋습니다. +그렇지 않으면 메모리 누수(memory leaks)가 발생할 수 있습니다. +자세한 내용은 를 참조하세요. +::: + +## 인수(arguments)를 전달하도록 UI 업데이트 + +이전에는 위젯이 다음과 같이 provider를 소비(consume)했습니다: + + + +하지만 이제 provider가 인수(arguments)를 받으므로 인수를 사용하는 구문이 약간 달라졌습니다. +이제 provider는 요청된 매개 변수를 사용하여 호출해야 하는 함수입니다. +이와 같이 하드코딩된 타입의 액티비티을 전달하도록 UI를 업데이트할 수 있습니다: + + + + + +provider에게 전달된 매개변수(parameters)는 어노테이션이 달린 함수의 매개변수에서 "ref" 매개변수를 뺀 값에 해당합니다. + + + +:::info +서로 다른 인수(arguments)를 가진 동일한 provider를 동시에 수신(listen)하는 것은 전적으로 가능합니다. +예를 들어, 우리의 UI는 "오락" 액티비티와 "요리" 액티비티을 모두 렌더링할 수 있습니다: + + + + + +이것이 수정자(modifier)를 "family"라고 부르는 이유입니다: +provider에게 매개 변수를 전달하면, 내부적으로 동일한 로직을 가진 상태 그룹(group of states)으로 공급자를 효과적으로 변환할 수 있기 때문입니다. + + +::: + +## Caching considerations and parameter restrictions + +매개변수(parameters)를 providers에게 전달할 때 계산은 여전히 캐시됩니다. +차이점은 이제 계산이 인수별로 캐시(cached per-argument)된다는 점입니다. + +즉, 두 개의 위젯이 동일한 매개변수로 동일한 provider를 사용하는 경우 네트워크 요청은 한 번만 이루어집니다. +그러나 두 위젯이 서로 다른 매개변수를 가진 동일한 provider를 사용하는 경우 두 번의 네트워크 요청이 이루어집니다. + +이를 위해 Riverpod은 매개변수의 `==` 연산자에 의존합니다. +따라서 provider에게 전달되는 매개변수가 일관된 동일성(consistent equality)을 갖는 것이 중요합니다. + +:::caution +흔히 저지르는 실수는 새 객체가 `==`를 재정의하지 않는데도 새 객체를 프로바이더의 매개변수로 직접 인스턴스화하는 것입니다. +예를 들어, `List`를 이렇게 전달하고 싶은 유혹을 받을 수 있습니다: + + + +이 코드의 문제점은 `['recreational', 'cooking'] == ['recreational', 'cooking']`가 `false`라는 것입니다. +따라서 Riverpod은 두 매개변수가 다르다고 판단하고 새로운 네트워크 요청을 시도합니다. +이렇게 되면 네트워크 요청이 무한 반복되어 사용자에게 진행률 표시기가 영구적으로 표시됩니다. + +이 문제를 해결하려면 `const` 목록(`const ['레크리에이션', '요리']`)을 사용하거나 `==`를 재정의하는 사용자 정의 목록 구현을 사용할 수 있습니다. + +이 실수를 발견하는 데 도움이 되려면 [riverpod_lint](https://pub.dev/packages/riverpod_lint)를 사용하여 +[provider_parameters](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint#provider_parameters) 린트 규칙을 활성화하는 것이 좋습니다. +그러면 위와 같은 스니펫에 경고가 표시됩니다. +설치 단계는 를 참조하세요. +::: + + + +이를 염두에 두고 provider에 여러 매개 변수(multiple parameters)를 전달하는 방법이 궁금할 수 있습니다. +권장되는 해결책은 다음과 같습니다: + +- 코드 생성(code-generation)으로 전환하여 원하는 수의 매개변수를 전달할 수 있습니다. +- Dart 3의 레코드(records) 사용 + +다트 3의 레코드(records)가 유용한 이유는 `==`를 자연스럽게 재정의하고 편리한 구문을 가지고 있기 때문입니다. +예를 들어, 액티비티 타입과 최대 가격을 모두 허용하도록 공급자를 업데이트할 수 있습니다: + + + +그런 다음 이 provider를 다음과 같이 소비(consume)할 수 있습니다: + + + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart new file mode 100644 index 000000000..4c9d1e874 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart @@ -0,0 +1,29 @@ +import 'dart:convert'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import '../../first_request/codegen/activity.dart'; + +part 'family.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity( + ActivityRef ref, + // provider에 인수를 추가할 수 있습니다. + // 매개변수 타입은 원하는 대로 지정할 수 있습니다. + String activityType, +) async { + // "activityType" 인수를 사용하여 URL을 작성할 수 있습니다. + // "https://boredapi.com/api/activity?type="을 가리키게 됩니다. + final response = await http.get( + Uri( + scheme: 'https', + host: 'boredapi.com', + path: '/api/activity', + // 쿼리 매개변수를 수동으로 인코딩할 필요 없이 "Uri" 클래스가 자동으로 인코딩합니다. + queryParameters: {'type': activityType}, + ), + ); + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart new file mode 100644 index 000000000..b63a6db32 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart @@ -0,0 +1,138 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityFamily._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {required ActivityFamily super.from, + required String super.argument, + FutureOr Function( + ActivityRef ref, + String activityType, + )? create}) + : _createCb = create, + super( + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + String activityType, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @override + String toString() { + return r'activityProvider' + '' + '($argument)'; + } + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._( + argument: argument as String, + from: from! as ActivityFamily, + create: ( + ref, + String activityType, + ) => + create(ref)); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + final argument = this.argument as String; + return _$cb( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is ActivityProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$activityHash() => r'cb76e67cd45f1823d3ed497a235be53819ce2eaf'; + +final class ActivityFamily extends Family { + const ActivityFamily._() + : super( + name: r'activityProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + ActivityProvider call( + String activityType, + ) => + ActivityProvider._(argument: activityType, from: this); + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @override + String toString() => r'activityProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr Function( + ActivityRef ref, + String args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ActivityProvider; + + final argument = provider.argument as String; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart new file mode 100644 index 000000000..1454fb399 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart @@ -0,0 +1,32 @@ +// ignore_for_file: avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import '../../first_request/codegen/activity.dart'; + +// Necessary for code-generation to work +part 'provider.g.dart'; + +FutureOr fetchActivity() => throw UnimplementedError(); + +/* SNIPPET START */ +// "함수형" provider +@riverpod +Future activity(ActivityRef ref) async { + // TODO: 네트워크 요청을 수행하여 액티비티를 가져옵니다 + return fetchActivity(); +} + +// 또는, "notifier" +@riverpod +class ActivityNotifier2 extends _$ActivityNotifier2 { + /// Notifier 인자(arguments)는 빌드 메서드에 지정됩니다. + /// 원하는 개수만큼 지정할 수 있고, 이름도 지정할 수 있으며, 선택적/명명할 수도 있습니다. + @override + Future build(String activityType) async { + // 인수는 "this."으로도 사용할 수 있습니다. + print(this.activityType); + + // TODO: 네트워크 요청을 수행하여 액티비티를 가져옵니다 + return fetchActivity(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart new file mode 100644 index 000000000..04b627967 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart @@ -0,0 +1,220 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'2f9496c5d70de9314c67e5c48ac44d8b149bc471'; + +@ProviderFor(ActivityNotifier2) +const activityNotifier2Provider = ActivityNotifier2Family._(); + +final class ActivityNotifier2Provider + extends $AsyncNotifierProvider { + const ActivityNotifier2Provider._( + {required ActivityNotifier2Family super.from, + required String super.argument, + super.runNotifierBuildOverride, + ActivityNotifier2 Function()? create}) + : _createCb = create, + super( + name: r'activityNotifier2Provider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ActivityNotifier2 Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityNotifier2Hash(); + + @override + String toString() { + return r'activityNotifier2Provider' + '' + '($argument)'; + } + + @$internal + @override + ActivityNotifier2 create() => _createCb?.call() ?? ActivityNotifier2(); + + @$internal + @override + ActivityNotifier2Provider $copyWithCreate( + ActivityNotifier2 Function() create, + ) { + return ActivityNotifier2Provider._( + argument: argument as String, + from: from! as ActivityNotifier2Family, + create: create); + } + + @$internal + @override + ActivityNotifier2Provider $copyWithBuild( + FutureOr Function( + Ref>, + ActivityNotifier2, + ) build, + ) { + return ActivityNotifier2Provider._( + argument: argument as String, + from: from! as ActivityNotifier2Family, + runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is ActivityNotifier2Provider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$activityNotifier2Hash() => r'9e67c655d53a9f98c3b012a0534421385dde0339'; + +final class ActivityNotifier2Family extends Family { + const ActivityNotifier2Family._() + : super( + name: r'activityNotifier2Provider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + ActivityNotifier2Provider call( + String activityType, + ) => + ActivityNotifier2Provider._(argument: activityType, from: this); + + @override + String debugGetCreateSourceHash() => _$activityNotifier2Hash(); + + @override + String toString() => r'activityNotifier2Provider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + ActivityNotifier2 Function( + String args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ActivityNotifier2Provider; + + final argument = provider.argument as String; + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + FutureOr Function(Ref> ref, + ActivityNotifier2 notifier, String argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ActivityNotifier2Provider; + + final argument = provider.argument as String; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(container); + }, + ); + } +} + +abstract class _$ActivityNotifier2 extends $AsyncNotifier { + late final _$args = + (ref as $AsyncNotifierProviderElement).origin.argument as String; + String get activityType => _$args; + + FutureOr build( + String activityType, + ); + @$internal + @override + FutureOr runBuild() => build( + _$args, + ); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts new file mode 100644 index 000000000..42ce35bff --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/provider.dart"; +import codegen from "!!raw-loader!./codegen/provider.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart new file mode 100644 index 000000000..ed154e255 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart @@ -0,0 +1,24 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../../first_request/raw/activity.dart'; +import 'family.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + AsyncValue activity = ref.watch( + // 이제 provider는 액티비티 타입을 기대하는 함수입니다. + // 단순화를 위해 지금은 상수 문자열을 전달하겠습니다. + activityProvider('recreational'), + ); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart new file mode 100644 index 000000000..914d1eb81 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart @@ -0,0 +1,23 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals, provider_parameters + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +final activityProvider = Provider.family((ref, id) { + throw UnimplementedError(); +}); + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + // 대신 문자열 목록을 허용하도록 activityProvider를 업데이트할 수 있습니다. + // 그런 다음 watch를 호출하여 해당 목록을 직접 만들 수 있습니다. + ref.watch(activityProvider(['recreational', 'cooking'])); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart new file mode 100644 index 000000000..337eab2d1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart @@ -0,0 +1,20 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../../first_request/raw/activity.dart'; +import 'provider.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + AsyncValue activity = ref.watch(activityProvider); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart new file mode 100644 index 000000000..e9ce32d48 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart @@ -0,0 +1,23 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'tuple_family.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + ref.watch( + // Record를 사용하여 매개 변수를 전달할 수 있습니다. + // Record가 ==를 재정의하므로 watch 호출에서 직접 Record를 생성해도 괜찮습니다. + activityProvider((type: 'recreational', maxPrice: 40)), + ); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart new file mode 100644 index 000000000..ce46d8a79 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart @@ -0,0 +1,41 @@ +// ignore_for_file: unnecessary_this, avoid_print + +import 'dart:async'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import '../../first_request/raw/activity.dart'; + +FutureOr fetchActivity(String activityType) => + throw UnimplementedError(); + +/* SNIPPET START */ +// "함수형" provider +final activityProvider = FutureProvider.autoDispose + // ".family" 수정자(modifier)를 사용합니다. + // "String" 제네릭 타입은 인수 타입에 해당합니다. + // 이제 provider는 "ref" 외에 액티비티 타입이라는 추가 인수를 받습니다. + .family((ref, activityType) async { + // TODO: "activityType"을 사용하여 액티비티를 가져오기 위한 네트워크 요청을 수행합니다. + return fetchActivity(activityType); +}); + +// "notifier" provider +final activityProvider2 = AsyncNotifierProvider.autoDispose + // 여기서도 ".family" 수정자를 사용하고 인수를 "String" 유형으로 지정합니다. + .family( + ActivityNotifier.new, +); + +// notifiers에 '.family'를 사용할 때는 notifier 서브클래스를 변경해야 합니다: +// AsyncNotifier -> FamilyAsyncNotifier +// AsyncNotifier -> FamilyAsyncNotifier +class ActivityNotifier extends FamilyAsyncNotifier { + /// Family 인자는 빌드 메서드에 전달되며 this.arg로 액세스할 수 있습니다. + @override + Future build(String activityType) async { + // 인수는 "this.arg"로도 사용할 수 있습니다. + print(this.arg); + + // TODO: 액티비티를 가져오기 위한 네트워크 요청을 수행합니다. + return fetchActivity(activityType); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart new file mode 100644 index 000000000..3a8160027 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart @@ -0,0 +1,37 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../../first_request/raw/activity.dart'; +import 'family.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + AsyncValue activity = ref.watch( + // 이제 provider는 액티비티 타입을 기대하는 함수입니다. + // 단순화를 위해 지금은 상수 문자열을 전달하겠습니다. + activityProvider('recreational'), + ); + /* SNIPPET START */ + return Consumer( + builder: (context, ref, child) { + final recreational = ref.watch(activityProvider('recreational')); + final cooking = ref.watch(activityProvider('cooking')); + + // 그러면 두 활동을 모두 렌더링할 수 있습니다. + // 두 요청이 모두 병렬로 발생하고 올바르게 캐시됩니다. + return Column( + children: [ + Text(recreational.valueOrNull?.activity ?? ''), + Text(cooking.valueOrNull?.activity ?? ''), + ], + ); + }, + ); + /* SNIPPET END */ + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart new file mode 100644 index 000000000..b1c7e862b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart @@ -0,0 +1,26 @@ +import 'dart:async'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import '../../first_request/raw/activity.dart'; + +/* SNIPPET START */ + +FutureOr fetchActivity() => throw UnimplementedError(); + +// "함수형" provider +final activityProvider = FutureProvider.autoDispose((ref) async { + // TODO: 액티비티를 가져오기 위한 네트워크 요청을 수행합니다. + return fetchActivity(); +}); + +// 또는, "notifier" +final activityProvider2 = AsyncNotifierProvider( + ActivityNotifier.new, +); + +class ActivityNotifier extends AsyncNotifier { + @override + Future build() async { + // TODO: 액티비티를 가져오기 위한 네트워크 요청을 수행합니다. + return fetchActivity(); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart new file mode 100644 index 000000000..d0a6edaf6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart @@ -0,0 +1,34 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import '../../first_request/raw/activity.dart'; + +/* SNIPPET START */ + +// provider에게 전달할 매개변수를 나타내는 record를 정의합니다. +// typedef는 선택 사항이지만 코드를 더 읽기 쉽게 만들 수 있습니다. + +typedef ActivityParameters = ({String type, int maxPrice}); + +final activityProvider = FutureProvider.autoDispose + // 이제 새로 정의된 record를 인수 유형으로 사용합니다. + .family((ref, arguments) async { + final response = await http.get( + Uri( + scheme: 'https', + host: 'boredapi.com', + path: '/api/activity', + queryParameters: { + // 마지막으로 인수를 사용하여 쿼리 매개변수를 업데이트할 수 있습니다. + 'type': arguments.type, + 'price': arguments.maxPrice, + }, + ), + ); + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx new file mode 100644 index 000000000..419ff377a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx @@ -0,0 +1,48 @@ +--- +title: 로깅 및 오류 보고 +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import providerObserver from "!!raw-loader!./provider_observer/provider_observer.dart"; + +Riverpod은 기본적으로 provider 트리에서 발생하는 모든 이벤트를 수신하는 방법을 제공합니다. +이 기능은 모든 이벤트를 기록하거나 원격 서비스에 오류를 보고하는 데 사용할 수 있습니다. + +이는 `ProviderObserver` 클래스를 사용하고 이를 `ProviderScope`/`ProviderContainer`에 전달하면 됩니다. + +## ProviderObserver 정의하기 + +`ProviderObserver`는 확장(extend)해야 하는 클래스입니다. +이벤트를 수신하기 위해 재정의할 수 있는 다양한 메서드를 제공합니다: + +- `didAddProvider`, provider가 트리에 추가(added)될때 호출 +- `didUpdateProvider`, provider가 갱신(updated)될때 호출 +- `didDisposeProvider`, provider가 폐기(disposed)될때 호출 +- `providerDidFail`, synchronous provider가 에러를 던질때 호출 + + + +## ProviderObserver 사용하기 + +이제 옵저버(observer)를 정의했으니 이를 사용해야 합니다. +그러기 위해서는 `ProviderScope` 또는 `ProviderContainer`에 전달해야 합니다: + +```dart +runApp( + ProviderScope( + observers: [ + MyObserver(), + ], + child: MyApp(), + ) +); +``` + +```dart +final container = ProviderContainer( + observers: [ + MyObserver(), + ], +); +``` diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart new file mode 100644 index 000000000..dd75afb01 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart @@ -0,0 +1,43 @@ +// ignore_for_file: avoid_print + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class MyObserver extends ProviderObserver { + @override + void didAddProvider( + ProviderBase provider, + Object? value, + ProviderContainer container, + ) { + print('Provider $provider was initialized with $value'); + } + + @override + void didDisposeProvider( + ProviderBase provider, + ProviderContainer container, + ) { + print('Provider $provider was disposed'); + } + + @override + void didUpdateProvider( + ProviderBase provider, + Object? previousValue, + Object? newValue, + ProviderContainer container, + ) { + print('Provider $provider updated from $previousValue to $newValue'); + } + + @override + void providerDidFail( + ProviderBase provider, + Object error, + StackTrace stackTrace, + ProviderContainer container, + ) { + print('Provider $provider threw $error at $stackTrace'); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx new file mode 100644 index 000000000..7526dd86a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx @@ -0,0 +1,407 @@ +--- +title: 부가 작업 수행(Performing side effects) +version: 1 +--- + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import Legend, { colors } from "./first_request/legend/legend"; +import todoListProvider from "./side_effects/todo_list_provider"; +import todoListNotifier from "./side_effects/todo_list_notifier"; +import todoListNotifierAddTodo from "./side_effects/todo_list_notifier_add_todo"; +import consumerAddTodoCall from "!!raw-loader!./side_effects/raw/consumer_add_todo_call.dart"; +import restAddTodo from "!!raw-loader!./side_effects/raw/rest_add_todo.dart"; +import invalidateSelfAddTodo from "!!raw-loader!./side_effects/raw/invalidate_self_add_todo.dart"; +import manualAddTodo from "!!raw-loader!./side_effects/raw/manual_add_todo.dart"; +import mutableManualAddTodo from "!!raw-loader!./side_effects/raw/mutable_manual_add_todo.dart"; +import renderAddTodo from "./side_effects/render_add_todo"; + +지금까지는 데이터를 가져오는 방법(일명 _GET_ HTTP 요청 수행)만 살펴봤습니다. +하지만 _POST_ 요청과 같은 부수적 효과(side-effect)는 어떨까요? + +애플리케이션은 종종 CRUD(생성, 읽기, 업데이트, 삭제) API를 구현합니다. +이 경우 일반적으로 업데이트 요청(일반적으로 _POST_)은 로컬 캐시를 업데이트해야 합니다. +로컬 캐시도 업데이트하여 UI에 새 상태가 반영되도록 하는 것이 일반적입니다. + +문제는 consumer 내에서 provider의 상태를 어떻게 업데이트할 수 있느냐는 것입니다. +당연히 providers는 자신의 상태(state)를 수정할 수 있는 방법을 노출하지 않습니다. +이는 상태가 통제된 방식으로만 수정되도록 하고 관심사 분리(separation of concerns)를 보장하기 위한 설계입니다. +대신 providers는 자신의 상태를 수정할 수 있는 방법을 명시적으로 노출해야 합니다. + +이를 위해 새로운 개념을 사용할 것입니다: Notifiers. +이 새로운 개념을 보여드리기 위해 좀 더 발전된 예를 사용하겠습니다: 할일 목록(to-do list)입니다. + +## Notifier 정의하기 + +이 시점에서 우리가 이미 알고 있는 것부터 시작하겠습니다: 간단한 _GET_ 요청입니다. +앞서 에서 보았듯이, 글쓰기를 통해 할일 목록을 가져올 수 있습니다: + + + +이제 할 일 목록을 가져왔으니 새 할 일을 추가하는 방법을 살펴봅시다. +이를 위해서는 상태(state) 수정을 위한 공개 API를 노출하도록 provider를 수정해야 합니다. +이 작업은 provider를 "notifier"라고 부르는 것으로 변환하여 수행합니다. + +Notifiers는 providers의 "상태저장 위젯(stateful widget)"입니다. +provider를 정의하는 문법을 약간 수정해야 합니다. +이 새로운 문법은 다음과 같습니다: + + +(MyNotifier.new); + +class MyNotifier extends SomeNotifier { + @override + Result build() { + + } + + +}`} + annotations={[ + { + offset: 6, + length: 4, + label: "provider 변수(variable)", + description: <> + +이 변수는 provider와 상호 작용하는 데 사용됩니다. +변수는 final이고 "top-level"(global)이어야 합니다. + + + }, + { + offset: 13, + length: 20, + label: "provider 타입(type)", + description: <> + +일반적으로 `NotifierProvider`, `AsyncNotifierProvider` 또는 `StreamNotifierProvider` 중 하나입니다. +사용되는 provider 유형은 함수의 반환값(return value)에 따라 달라집니다. +예를 들어, `Future`를 만들려면 `AsyncNotifierProvider`가 필요할 것입니다. + +가장 많이 사용하는 provider는 `AsyncNotifierProvider`입니다. + +:::tip +"어떤 provider를 선택해야 하나"라는 관점에서 생각하지 마세요. +대신 "내가 무엇을 반환하고 싶은가"라는 관점에서 생각하세요. +provider 타입은 자연스럽게 따라올 것입니다. +::: + + + }, + { + offset: 33, + length: 13, + label: "수정자(Modifiers) (옵션)", + description: <> + +종종 provider 유형 뒤에 "수정자(modifier)"가 표시될 수 있습니다. +수정자(modifier)는 선택 사항이며, 타입에 안전한(type-safe) 방식으로 provider의 동작을 조정하는 데 사용됩니다. + +현재 두 가지 수정자(modifier)를 사용할 수 있습니다: + +- `autoDispose`를 설정하면 provider가 더 이상 사용되지 않을 때 자동으로 캐시를 지웁니다. + 도 참조하세요. +- provider에게 인자(arguments)를 전달할 수 있는 `family`. + 도 참조하세요. + + + }, + { + offset: 67, + length: 14, + label: "Notifier의 생성자 (Constructor)", + description: <> + +"notifier providers"의 매개변수는 "notifier"를 인스턴스화할 것으로 예상되는 함수입니다. +일반적으로 "생성자 분리(constructor tear-off)"형식이여야 합니다. + + + }, + { + offset: 86, + length: 16, + label: "Notifier", + description: <> + +`NotifierProvider`가 "StatefulWidget" 클래스인 경우, 이 부분은 `State` 클래스입니다. + +이 클래스는 provider의 상태(state)를 수정하는 방법을 노출하는 역할을 담당합니다. +이 클래스의 공개 메서드는 `ref.read(yourProvider.notifier).yourMethod()`를 사용하여 소비자(consumers)가 액세스할 수 있습니다. + +:::note +UI에서 상태(state)가 변경되었음을 알 수 없기 때문에, Notifiers에는 내장된 `state` 외에 다른 공용 프로퍼티가 없어야 합니다. +::: + + + }, + { + offset: 111, + length: 12, + label: "Notifier 타입(type)", + description: <> + +Notifier가 확장(extend)하는 기반(base) 클래스는 provider + modifiers의 클래스와 일치해야 합니다. +몇 가지 예를 들면 다음과 같습니다: + +- NotifierProvider -> Notifier +- AsyncNotifierProvider -> AsyncNotifier +- AsyncNotifierProvider. + autoDispose -> + AutoDispose + + AsyncNotifier +- AsyncNotifierProvider. + autoDispose. + family + -> AutoDispose + Family + AsyncNotifier + +이 작업을 더 간단하게 하려면 올바른 유형을 자동으로 추론하는 코드 생성기(code generator)를 사용하는 것이 좋습니다. + + + }, + { + offset: 136, + length: 54, + label: "build 메소드(method)", + description: <> + +모든 notifiers는 `build` 메서드를 재정의(override)해야 합니다. +이 메서드는 일반적으로 notifier가 아닌 provider(non-notifier provider)에서 로직을 넣는 위치에 해당합니다. + +이 메서드는 직접 호출해서는 안 됩니다. + + + }, +]} +/> + + + + + + + } + + +}`} + annotations={[ + { + offset: 0, + length: 9, + label: "어노테이션(annotation)", + description: <> + +모든 providers는 `@riverpod` 또는 `@Riverpod()`로 어노테이션해야 합니다. +이 어노테이션은 전역 함수나 클래스에 배치할 수 있습니다. +이 어노테이션을 통해 프로바이더를 구성할 수 있습니다. + +예를 들어, `@Riverpod(keepAlive: true)`를 작성하여 "auto-dispose"(나중에 살펴볼 것임)를 비활성화할 수 있습니다. + + + }, + { + offset: 10, + length: 16, + label: "Notifier", + description: <> + +`@riverpod` 어노테이션이 클래스에 배치되면 해당 클래스를 "Notifier"라고 부릅니다. +클래스는 `_$NotifierName`을 확장해야 하며, 여기서 `NotifierName`은 클래스 이름입니다. + +Notifiers는 provider의 상태(state)를 수정하는 메서드를 노출할 책임이 있습니다. +이 클래스의 공개 메서드는 `ref.read(yourProvider.notifier).yourMethod()`를 사용하여 consumer가 액세스할 수 있습니다. + +:::note +UI에서 상태가 변경되었음을 알 수 있는 수단이 없기 때문에, Notifiers에는 기본 제공 'state' 외에 공개 속성이 없어야 합니다. +::: + + + }, + { + offset: 52, + length: 54, + label: "The build method", + description: <> + +모든 notifiers는 `build` 메서드를 재정의(override)해야 합니다. +이 메서드는 일반적으로 notifier가 아닌 provider(non-notifier provider)에서 로직을 넣는 위치에 해당합니다. + +이 메서드는 직접 호출해서는 안 됩니다. + + + }, +]} +/> + + +참고로, 이 새로운 문법을 이전에 보았던 문법과 비교하려면 를 확인하면 됩니다. + +:::info +`bbuild` 이외의 메서드가 없는 Notifier는 앞서 본 문법을 사용하는 것과 동일합니다. +에 표시된 문법은 UI에서 수정할 방법이 없는 notifiers에 대한 간략한 표현이라고 볼 수 있습니다. +::: + +이제 문법을 살펴봤으니 이전에 정의한 provider를 notifier으로 변환하는 방법을 살펴보겠습니다: +Now that we've seen the syntax, let's see how to convert our previously defined provider to a notifier: + + + +위젯 내에서 provider를 읽는 방법은 변경되지 않았습니다. +이전 구문과 마찬가지로 `ref.watch(todoListProvider)`를 계속 사용할 수 있습니다. + +:::caution +notifier의 생성자에 로직을 넣지 마세요. +`ref` 및 기타 프로퍼티는 아직 사용할 수 없으므로 Notifier에는 생성자가 없어야 합니다. +대신 `build` 메서드에 로직을 넣으세요. + +```dart +class MyNotifier extends ... { + MyNotifier() { + // ❌ 이렇게 하지 마세요. + // 이 경우 예외가 발생합니다. + state = AsyncValue.data(42); + } + + @override + Result build() { + // ✅ 대신 이렇게 하세요. + state = AsyncValue.data(42); + } +} +``` + +::: + +## _POST_ 요청을 수행하는 메서드 노출하기 + +이제 Notifier가 생겼으니 부가 작업(side-effect)을 수행할 수 있는 메서드를 추가할 수 있습니다. +그러한 부가 작업 중 하나는 클라이언트가 새 할 일을 _POST_하도록 하는 것입니다. +notifier에 `addTodo` 메서드를 추가하면 그렇게 할 수 있습니다: + + + +그런 다음 에서 보았던 것과 동일한 `Consumer`/`ConsumerWidget`을 사용하여 UI에서 이 메서드를 호출할 수 있습니다: + + + +:::info +메서드를 호출할 때 `ref.watch` 대신 `ref.read`를 사용하고 있는 것을 주목하세요. +`ref.watch`도 기술적으로는 작동할 수 있지만, "onPressed"와 같은 이벤트 핸들러에서 로직이 수행될 때는 `ref.read`를 사용하는 것이 좋습니다. +::: + +이제 버튼을 누르면 _POST_ 요청을 하는 버튼이 생겼습니다. +그러나 현재로서는 새 할 일 목록을 반영하도록 UI가 업데이트되지 않습니다. +로컬 캐시가 서버의 상태와 일치하기를 원할 것입니다. + +장단점이 있는 몇 가지 방법이 있습니다. + +### API 응답에 맞춰 로컬 캐시 업데이트하기 + +일반적인 백엔드 관행은 _POST_ 요청이 리소스의 새 상태를 반환하도록 하는 것입니다. +특히, 저희 API는 새 할 일을 추가한 후 새 할 일 목록을 반환합니다. +이를 수행하는 한 가지 방법은 `state = AsyncData(response)`를 작성하는 것입니다: + + + +:::tip 장점 + +- UI는 가능한 가장 최신 상태로 유지됩니다. + 다른 사용자가 할 일을 추가하면 우리도 볼 수 있습니다. +- 서버가 진실의 원천입니다. + 이 접근 방식을 사용하면 클라이언트는 할 일 목록에서 새 할 일을 어디에 삽입해야 하는지 알 필요가 없습니다. +- 단 한 번의 네트워크 요청만 필요합니다. + +::: + +:::danger 단점 + +- 이 접근 방식은 서버가 특정 방식으로 구현된 경우에만 작동합니다. + 서버가 새 상태를 반환하지 않으면 이 접근 방식은 작동하지 않습니다. +- 필터/소팅이 있는 경우와 같이 연결된 _GET_ 요청이 더 복잡한 경우에는 여전히 작동하지 않을 수 있습니다. + +::: + +### ref.invalidateSelf()`를 사용하여 provider를 새로고침 + +한 가지 옵션은 provider가 _GET_ 요청을 다시 실행하도록 하는 것입니다. +이는 _POST_ 요청 뒤에 `ref.invalidateSelf()`를 호출하여 수행할 수 있습니다: + + + +:::tip 장점 + +- UI는 가능한 가장 최신 상태로 유지됩니다. + 다른 사용자가 할 일을 추가하면 우리도 볼 수 있습니다. +- 서버가 진실의 원천입니다. + 이 접근 방식을 사용하면 클라이언트는 할 일 목록에서 새 할 일을 어디에 삽입해야 하는지 알 필요가 없습니다. +- 이 접근 방식은 서버 구현에 관계없이 작동합니다. + 필터/소팅이 포함된 경우와 같이 _GET_ 요청이 더 복잡한 경우에 특히 유용할 수 있습니다. + +::: + +:::danger 단점 + +- 이 접근 방식은 비효율적일 수 있는 추가 _GET_ 요청을 수행합니다. + +::: + +### 로컬 캐시 수동 업데이트 + +또 다른 옵션은 로컬 캐시를 수동으로 업데이트하는 것입니다. +여기에는 백엔드의 동작을 모방하는 작업이 포함됩니다. +예를 들어, 백엔드가 새 항목을 처음에 삽입하는지 아니면 마지막에 삽입하는지 알아야 합니다. + + + +:::info +이 예제에서는 불변(immutable) 상태를 사용합니다. 이는 필수는 아니지만 권장 사항입니다. +자세한 내용은 를 참조하세요. +대신 변경 가능한 상태를 사용하려는 경우 다른 방법을 사용할 수 있습니다: + + + +::: + +:::tip 장점 + +- 이 접근 방식은 서버 구현에 관계없이 작동합니다. +- 네트워크 요청은 단 한 번만 필요합니다. + +::: + +:::danger 단점 + +- 로컬 캐시가 서버의 상태와 일치하지 않을 수 있습니다. + 다른 사용자가 할 일을 추가한 경우 이를 볼 수 없습니다. +- 이 접근 방식은 백엔드의 로직을 효과적으로 복제하고 구현하기가 더 복잡할 수 있습니다. + +::: + +## 더 알아보기: 스피너(spinner) 표시 및 오류 처리(error handling) + +지금까지 살펴본 바에 따르면 버튼을 누르면 _POST_ 요청을 하고 요청이 완료되면 변경 사항을 반영하여 UI가 업데이트되는 버튼이 있습니다. +하지만 현재로서는 요청이 수행되고 있다는 표시도 없고, 요청이 실패할 경우 어떤 정보도 표시되지 않습니다. + +한 가지 방법은 로컬 위젯 상태에 `addTodo`가 반환한 Future를 저장한 다음 해당 Future를 수신하여 스피너 또는 오류 메시지를 표시하는 것입니다. +이 시나리오에서는 [flutter_hooks](https://pub.dev/packages/flutter_hooks)가 유용합니다. +물론 `StatefulWidget`을 대신 사용할 수도 있습니다. + +다음 스니펫은 작업이 보류 중인 동안 진행률 표시기를 보여줍니다. +그리고 실패하면 버튼을 빨간색으로 렌더링합니다: + +![A button which turns red when the operation failed](/img/essentials/side_effects/spinner.gif) + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart new file mode 100644 index 000000000..2f3d450ed --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart @@ -0,0 +1,28 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo_list_notifier.freezed.dart'; +part 'todo_list_notifier.g.dart'; + +@freezed +class Todo with _$Todo { + factory Todo({ + required String description, + @Default(false) bool completed, + }) = _Todo; + + factory Todo.fromJson(Map json) => _$TodoFromJson(json); +} + +/* SNIPPET START */ +@riverpod +class TodoList extends _$TodoList { + @override + Future> build() async { + // 이전에 FutureProvider에 있던 로직이 이제 빌드 메서드에 있습니다. + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart new file mode 100644 index 000000000..3326f9ffa --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart @@ -0,0 +1,166 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'todo_list_notifier.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Todo _$TodoFromJson(Map json) { + return _Todo.fromJson(json); +} + +/// @nodoc +mixin _$Todo { + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$TodoImpl implements _Todo { + _$TodoImpl({required this.description, this.completed = false}); + + factory _$TodoImpl.fromJson(Map json) => + _$$TodoImplFromJson(json); + + @override + final String description; + @override + @JsonKey() + final bool completed; + + @override + String toString() { + return 'Todo(description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); + + @override + Map toJson() { + return _$$TodoImplToJson( + this, + ); + } +} + +abstract class _Todo implements Todo { + factory _Todo({required final String description, final bool completed}) = + _$TodoImpl; + + factory _Todo.fromJson(Map json) = _$TodoImpl.fromJson; + + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart new file mode 100644 index 000000000..81218695d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -0,0 +1,89 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_notifier.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$TodoImpl _$$TodoImplFromJson(Map json) => _$TodoImpl( + description: json['description'] as String, + completed: json['completed'] as bool? ?? false, + ); + +Map _$$TodoImplToJson(_$TodoImpl instance) => + { + 'description': instance.description, + 'completed': instance.completed, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(TodoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider + extends $AsyncNotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$todoListHash() => r'c939d438b07da6065dbbcfab86c27ef363bdb76c'; + +abstract class _$TodoList extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart new file mode 100644 index 000000000..589d4b64e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart @@ -0,0 +1,26 @@ +// ignore_for_file: avoid_print + +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'todo_list_notifier.dart'; + +part 'todo_list_notifier_add_todo.g.dart'; + +/* SNIPPET START */ +@riverpod +class TodoList extends _$TodoList { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + await http.post( + Uri.https('your_api.com', '/todos'), + // 할 일 개체를 직렬화하여 서버에 POST합니다. + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart new file mode 100644 index 000000000..19c5471ad --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_notifier_add_todo.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(TodoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider + extends $AsyncNotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$todoListHash() => r'4008395aaca8f55312f668c0b2a32e7599f82349'; + +abstract class _$TodoList extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart new file mode 100644 index 000000000..dd8082be4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart @@ -0,0 +1,23 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo_list_provider.freezed.dart'; +part 'todo_list_provider.g.dart'; + +@freezed +class Todo with _$Todo { + factory Todo({ + required String description, + @Default(false) bool completed, + }) = _Todo; +} + +/* SNIPPET START */ +@riverpod +Future> todoList(TodoListRef ref) async { + // 네트워크 요청을 시뮬레이션합니다. 이는 일반적으로 실제 API로부터 수신됩니다. + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart new file mode 100644 index 000000000..26a2d640c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart @@ -0,0 +1,148 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'todo_list_provider.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$Todo { + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc + +class _$TodoImpl implements _Todo { + _$TodoImpl({required this.description, this.completed = false}); + + @override + final String description; + @override + @JsonKey() + final bool completed; + + @override + String toString() { + return 'Todo(description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @override + int get hashCode => Object.hash(runtimeType, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); +} + +abstract class _Todo implements Todo { + factory _Todo({required final String description, final bool completed}) = + _$TodoImpl; + + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart new file mode 100644 index 000000000..c890d03c6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -0,0 +1,66 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef TodoListRef = Ref>>; + +@ProviderFor(todoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider extends $FunctionalProvider>, + FutureOr>, TodoListRef> + with $FutureModifier>, $FutureProvider, TodoListRef> { + const TodoListProvider._( + {FutureOr> Function( + TodoListRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + TodoListRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + TodoListProvider $copyWithCreate( + FutureOr> Function( + TodoListRef ref, + ) create, + ) { + return TodoListProvider._(create: create); + } + + @override + FutureOr> create(TodoListRef ref) { + final _$cb = _createCb ?? todoList; + return _$cb(ref); + } +} + +String _$todoListHash() => r'26b30307668c8feefa7cbe3c400b73e6edccbc39'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart new file mode 100644 index 000000000..f869a1175 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart @@ -0,0 +1,25 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../raw/todo_list_notifier.dart' show Todo; +import '../raw/todo_list_notifier_add_todo.dart'; + +/* SNIPPET START */ +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return ElevatedButton( + onPressed: () { + // "ref.read"를 "myProvider.notifier"와 사용하면 + // notifier의 클래스 인스턴스를 얻을 수 있습니다. + // 이를 통해 "addTodo" 메서드를 호출할 수 있습니다. + ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + }, + child: const Text('Add todo'), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart new file mode 100644 index 000000000..bba0f588d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart @@ -0,0 +1,38 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // API 응답은 신경 쓰지 않습니다. + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // 포스트 요청이 완료되면 로컬 캐시를 더티(dirty)로 표시할 수 있습니다. + // 이렇게 하면 notifier의 "build"가 비동기적으로 다시 호출되고, 이 때 리스너(listener)에게 알림이 전송됩니다. + + ref.invalidateSelf(); + + // (선택 사항) 그런 다음 새 상태가 계산될 때까지 기다릴 수 있습니다. + // 이렇게 하면 새 상태를 사용할 수 있을 때까지 "addTodo"가 완료되지 않습니다. + await future; + } +/* SNIPPET END */ +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart new file mode 100644 index 000000000..1b07e26c7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart @@ -0,0 +1,39 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // API 응답은 신경 쓰지 않습니다. + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // 그런 다음 로컬 캐시를 수동으로 업데이트할 수 있습니다. 이를 위해서는 이전 상태를 가져와야 합니다. + // 주의: 이전 상태가 여전히 로딩 중이거나 오류 상태일 수 있습니다. + // 이 문제를 우아하게 처리하는 방법은 `this.state` 대신 `this.future`를 읽어서 로딩 상태를 기다리게 하고 + // 상태가 오류 상태인 경우 오류를 발생시키는 것입니다. + final previousState = await future; + + // 그런 다음 새 상태 객체를 생성하여 상태를 업데이트할 수 있습니다. + // 그러면 모든 리스너에게 알림이 전송됩니다. + state = AsyncData([...previousState, todo]); + } +/* SNIPPET END */ +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart new file mode 100644 index 000000000..3029281fa --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart @@ -0,0 +1,35 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + // API 응답은 신경 쓰지 않습니다. + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + /* SNIPPET START */ + final previousState = await future; + // 이전 할 일 목록을 변경합니다. (Mutable) + previousState.add(todo); + // 리스너에게 수동으로 알림을 전송합니다. + ref.notifyListeners(); +/* SNIPPET END */ + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart new file mode 100644 index 000000000..964468789 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart @@ -0,0 +1,78 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'rest_add_todo.dart'; +import 'todo_list_notifier.dart' show Todo; + +void main() { + runApp( + const ProviderScope(child: MyApp()), + ); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return const MaterialApp(home: Example()); + } +} + +/* SNIPPET START */ +class Example extends ConsumerStatefulWidget { + const Example({super.key}); + + @override + ConsumerState createState() => _ExampleState(); +} + +class _ExampleState extends ConsumerState { + // pending중인 addTodo 작업입니다. 또는 pending중인 작업이 없으면 null입니다. + Future? _pendingAddTodo; + + @override + Widget build(BuildContext context) { + return FutureBuilder( + // pending중인 작업을 수신하여 그에 따라 UI를 업데이트합니다. + future: _pendingAddTodo, + builder: (context, snapshot) { + // 오류 상태가 있는지 여부를 계산합니다. + // 연결 상태(connectionState) 확인은 연산을 다시 시도할 때 처리합니다. + final isErrored = snapshot.hasError && + snapshot.connectionState != ConnectionState.waiting; + + return Row( + children: [ + ElevatedButton( + style: ButtonStyle( + // 오류가 있는 경우 버튼이 빨간색으로 표시됩니다. + backgroundColor: MaterialStateProperty.all( + isErrored ? Colors.red : null, + ), + ), + onPressed: () { + // addTodo가 반환한 future를 변수에 보관합니다. + final future = ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + + // 해당 future를 로컬 상태에 저장합니다. + setState(() { + _pendingAddTodo = future; + }); + }, + child: const Text('Add todo'), + ), + // 작업이 pending중이므로 진행률 표시기(progress indicator)를 표시합니다. + if (snapshot.connectionState == ConnectionState.waiting) ...[ + const SizedBox(width: 8), + const CircularProgressIndicator(), + ], + ], + ); + }, + ); + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart new file mode 100644 index 000000000..790cf72c8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart @@ -0,0 +1,68 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'rest_add_todo.dart'; +import 'todo_list_notifier.dart' show Todo; + +void main() { + runApp( + const ProviderScope(child: MyApp()), + ); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return const MaterialApp(home: Example()); + } +} + +/* SNIPPET START */ +class Example extends HookConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // pending중인 addTodo 작업입니다. 또는 pending중인 작업이 없으면 null입니다. + final pendingAddTodo = useState?>(null); + // pending인 작업을 수신하여 그에 따라 UI를 업데이트합니다. + final snapshot = useFuture(pendingAddTodo.value); + + // 오류 상태가 있는지 여부를 계산합니다. + // 연결 상태(connectionState) 확인은 작업이 다시 시도될 때 처리하기 위해 여기에 있습니다. + final isErrored = snapshot.hasError && + snapshot.connectionState != ConnectionState.waiting; + + return Row( + children: [ + ElevatedButton( + style: ButtonStyle( + // 오류가 있는 경우 버튼을 빨간색으로 표시합니다. + backgroundColor: MaterialStateProperty.all( + isErrored ? Colors.red : null, + ), + ), + onPressed: () async { + // addTodo가 반환한 future를 변수에 보관합니다. + final future = ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + + // 해당 미래를 로컬 상태에 저장합니다. + pendingAddTodo.value = future; + }, + child: const Text('Add todo'), + ), + // 작업이 pending중이므로 진행률 표시기(progress indicator)를 표시하겠습니다. + if (snapshot.connectionState == ConnectionState.waiting) ...[ + const SizedBox(width: 8), + const CircularProgressIndicator(), + ], + ], + ); + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart new file mode 100644 index 000000000..29fa3f8e8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart @@ -0,0 +1,39 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // POST 요청은 새 애플리케이션 상태와 일치하는 List를 반환합니다. + final response = await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // API 응답을 디코딩하여 List로 변환합니다. + List newTodos = (jsonDecode(response.body) as List) + .cast>() + .map(Todo.fromJson) + .toList(); + + // 로컬 캐시를 새 상태와 일치하도록 업데이트합니다. + // 그러면 모든 리스너에게 알림이 전송됩니다. + state = AsyncData(newTodos); + } +/* SNIPPET END */ +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart new file mode 100644 index 000000000..bbcc5af84 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart @@ -0,0 +1,44 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Todo { + Todo({ + required this.description, + this.completed = false, + }); + + factory Todo.fromJson(Map json) { + return Todo( + description: json['description']! as String, + completed: json['completed']! as bool, + ); + } + + final String description; + final bool completed; + + Map toJson() => { + 'description': description, + 'completed': completed, + }; +} + +/* SNIPPET START */ +// We now use AsyncNotifierProvider instead of FutureProvider +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +// We use an AsyncNotifier because our logic is asynchronous. +// More specifically, we'll need AsyncNotifier because +// of the "autoDispose" modifier. +class TodoList extends AsyncNotifier> { + @override + Future> build() async { + // The logic we previously had in our FutureProvider is now in the build method. + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart new file mode 100644 index 000000000..e4f87baee --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +/* SNIPPET START */ +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + await http.post( + Uri.https('your_api.com', '/todos'), + // We serialize our Todo object and POST it to the server. + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart new file mode 100644 index 000000000..51c621c40 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart @@ -0,0 +1,27 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class Todo { + Todo({ + required this.description, + this.completed = false, + }); + + factory Todo.fromJson(Map json) { + return Todo( + description: json['description'] as String, + completed: json['completed'] as bool, + ); + } + + final String description; + final bool completed; +} + +final todoListProvider = FutureProvider.autoDispose>((ref) async { + // Simulate a network request. This would normally come from a real API + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts new file mode 100644 index 000000000..798feb107 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/render_add_todo.dart"; +import hooks from "!!raw-loader!./raw/render_add_todo_hooks.dart"; + +export default { + raw: raw, + hooks: hooks, + codegen: raw, + hooksCodegen: hooks, +}; \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts new file mode 100644 index 000000000..b32ae3b9b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/todo_list_notifier.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_notifier.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts new file mode 100644 index 000000000..62fb0e0fc --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/todo_list_notifier_add_todo.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_notifier_add_todo.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts new file mode 100644 index 000000000..de7789c0b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts @@ -0,0 +1,7 @@ +import raw from "!!raw-loader!./raw/todo_list_provider.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_provider.dart"; + +export default { + raw: raw, + codegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing.mdx new file mode 100644 index 000000000..fe268049e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing.mdx @@ -0,0 +1,148 @@ +--- +title: providers 테스트하기 +--- + +import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; +import createContainer from "!!raw-loader!./testing/create_container.dart"; +import unitTest from "!!raw-loader!./testing/unit_test.dart"; +import widgetTest from "!!raw-loader!./testing/widget_test.dart"; +import fullWidgetTest from "!!raw-loader!./testing/full_widget_test.dart"; +import widgetContainerOf from "!!raw-loader!./testing/widget_container_of.dart"; +import providerToMock from "./testing/provider_to_mock"; +import mockProvider from "!!raw-loader!./testing/mock_provider.dart"; +import autoDisposeListen from "!!raw-loader!./testing/auto_dispose_listen.dart"; +import listenProvider from "!!raw-loader!./testing/listen_provider.dart"; +import awaitFuture from "!!raw-loader!./testing/await_future.dart"; +import notifierMock from "./testing/notifier_mock"; + +Riverpod API의 핵심은 provider를 개별적으로 테스트할 수 있는 기능입니다. + +적절한 테스트 스위트를 위해서는 몇 가지 극복해야 할 과제가 있습니다: + +- 테스트는 상태를 공유해서는 안 됩니다. 즉, 새 테스트가 이전 테스트의 영향을 받지 않아야 합니다. +- 테스트는 원하는 상태를 얻기 위해 특정 기능을 모의할 수 있는 기능을 제공해야 합니다. +- 테스트 환경은 가능한 한 실제 환경과 유사해야 합니다. + +다행히도 Riverpod를 사용하면 이러한 목표를 모두 쉽게 달성할 수 있습니다. + +## 테스트 설정하기 + +Riverpod로 테스트를 정의할 때는 크게 두 가지 시나리오가 있습니다: + +- 일반적으로 Flutter 종속성이 없는 단위 테스트. + 이는 provider의 동작을 단독으로 테스트할 때 유용할 수 있습니다. +- 위젯 테스트: 일반적으로 Flutter 종속성이 있는 위젯 테스트. + 공급자를 사용하는 위젯의 동작을 테스트하는 데 유용할 수 있습니다. + +### 단위 테스트 + +단위 테스트는 [package:test](https://pub.dev/packages/test)의 `test` 함수를 사용하여 정의합니다. + +다른 테스트와 가장 큰 차이점은 `ProviderContainer` 객체를 생성한다는 점입니다. +이 객체를 사용하면 테스트가 provider와 상호 작용할 수 있습니다. + +`ProviderContainer` 객체를 생성하고 폐기하기 위한 테스트 유틸리티를 만드는 것이 좋습니다: + + + +그런 다음 이 유틸리티를 사용하여 `test`를 정의할 수 있습니다: + + + +이제 ProviderContainer가 생겼으니 이를 사용하여 provider를 읽을 수 있습니다: + +- provider의 현재 값을 읽기위해 `container.read` 사용. +- provider를 청취하고, 변경을 통지받기 위해 `container.listen` 사용. + +:::caution +provider가 자동으로 폐기될 때 `container.read`를 사용할 때는 주의하세요. +provider가 리스닝되지 않으면 테스트 도중에 provider의 상태가 파괴될 가능성이 있습니다. + +이 경우 `container.listen`을 사용하는 것을 고려해 보세요. +이 반환값은 어쨌든 provider의 현재 값을 읽을 수 있게 해주지만, +테스트 도중에 provider가 폐기되지 않도록 보장합니다: + + +::: + +### 위젯 테스트 + +위젯 테스트는 [package:flutter_test](https://pub.dev/packages/flutter_test)의 `testWidgets` 함수를 사용하여 정의합니다. + +이 경우 일반적인 위젯 테스트와 가장 큰 차이점은 `tester.pumpWidget`의 루트에 `ProviderScope` 위젯을 추가해야 한다는 점입니다: + + + +이는 Flutter 앱에서 Riverpod을 활성화할 때 하는 작업과 유사합니다. + +그런 다음 `tester`를 사용하여 위젯과 상호 작용할 수 있습니다. +또는 provider와 상호 작용하고 싶다면 `ProviderContainer`를 얻을 수 있습니다. +이는 `ProviderScope.containerOf(buildContext)`를 사용하여 얻을 수 있습니다. +따라서 `tester`를 사용하면 다음과 같이 작성할 수 있습니다: + + + +그런 다음 이를 사용하여 provider를 읽을 수 있습니다. 다음은 전체 예제입니다: + + + +## provider 모킹하기(Mocking) + +지금까지 테스트를 설정하는 방법과 provider와의 기본적인 상호 작용에 대해 살펴보았습니다. +하지만 경우에 따라서는 provider를 모킹(mock)하고 싶을 수도 있습니다. + +멋진 부분: 추가 설정 없이 모든 공급자를 기본적으로 모킹할 수 있습니다. +이는 `ProviderScope` 또는 `ProviderContainer`에 `overrides` 매개변수를 지정하면 가능합니다. + +다음 provider를 살펴봅시다: + + + +다음을 사용하여 모킹해 볼 수 있습니다: + + + +## provider 변경 사항 감시(Spying) + +테스트에서 `ProviderContainer`를 얻었으므로 이를 사용하여 provider를 "listen"할 수 있습니다: + + + +그런 다음 이를 [mockito](https://pub.dev/packages/mockito) 또는 [mocktail](https://pub.dev/packages/mocktail)과 같은 패키지와 결합하여 해당 패키지의 `verify` API를 사용할 수 있습니다. +또는 더 간단하게는 목록에 모든 변경 사항을 추가하고 어설트(assert)할 수 있습니다. + +## 비동기 provider를 기다리기 + +Riverpod에서는 provider가 Future/Stream을 반환하는 경우가 매우 흔합니다. +이 경우 테스트에서 해당 비동기 연산이 완료될 때까지 기다려야 할 가능성이 있습니다. + +이를 위한 한 가지 방법은 프로바이더의 '.future'를 읽는 것입니다: + + + +## Notifiers 모킹하기 + +일반적으로 Notifiers를 모의하는 것은 권장하지 않습니다. +그 대신에, Notifier의 로직에 어느 정도 추상화 수준을 도입하여 그 추상화를 모킹할 수 있도록 해야 합니다. +예를 들어, Notifier을 모킹하는 대신 Notifier가 데이터를 가져오는 데 사용하는 "repository"를 모킹할 수 있습니다. + +Notifier를 모킹하려는 경우, 모킹을 만들 때 특별히 고려해야 할 사항이 있습니다: +모의 클래스는 반드시 원래 Notifier 베이스 클래스를 서브 클래싱해야 합니다: +인터페이스를 손상시킬 수 있으므로 Notifier를 "implement"할 수 없습니다. + +따라서 Notifier를 모킹할 때는 다음과 같은 mockito 코드를 작성하지 마세요: + +```dart +class MyNotifierMock with Mock implements MyNotifier {} +``` + +대신 다음과 같이 작성하세요: + + + + + +이 기능을 사용하려면 목(Mock)을 모킹하려는 Notifier와 동일한 파일에 배치해야 합니다. +그렇지 않으면 `_$MyNotifier` 클래스에 액세스할 수 없습니다. + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart new file mode 100644 index 000000000..f16a2d6c8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 'Hello world'); + +void main() { + test('Some description', () { + final container = createContainer(); + /* SNIPPET START */ + final subscription = container.listen(provider, (_, __) {}); + + expect( + // `container.read(provider)`와 동일합니다. + // 그러나 "subscription"이 disposed되지 않는 한 provider는 disposed되지 않습니다. + subscription.read(), + 'Some value', + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart new file mode 100644 index 000000000..10bc7e238 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart @@ -0,0 +1,29 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = FutureProvider((_) async => 42); + +void main() { + test('Some description', () async { + // 이 테스트에 대한 ProviderContainer를 생성합니다. + // DO NOT: 테스트 간에 ProviderContainer를 공유하지 마세요. + final container = createContainer(); + + /* SNIPPET START */ + // TODO: 컨테이너를 사용하여 애플리케이션을 테스트합니다. + // 기대는 비동기적이므로 "expectLater"를 사용해야 합니다. + await expectLater( + // "provider"대신 "provider.future"를 읽습니다. + // 이는 비동기 provider에서 가능하며, provider의 value로 resolve되는 future를 반환합니다. + container.read(provider.future), + // future가 예상 값으로 resolve되는지 확인할 수 있습니다. + // 또는 오류에 "throwsA"를 사용할 수 있습니다. + completion('some value'), + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart new file mode 100644 index 000000000..c0aab45e6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart @@ -0,0 +1,22 @@ +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +/// [ProviderContainer]를 생성하고 +/// 테스트가 끝나면 자동으로 폐기하는 테스트 유틸리티입니다. +ProviderContainer createContainer({ + ProviderContainer? parent, + List overrides = const [], + List? observers, +}) { + // ProviderContainer를 생성하고 선택적으로 매개변수 지정을 허용합니다. + final container = ProviderContainer( + parent: parent, + overrides: overrides, + observers: observers, + ); + + // 테스트가 끝나면 container를 폐기합니다. + addTearDown(container.dispose); + + return container; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart new file mode 100644 index 000000000..325292aa7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart @@ -0,0 +1,33 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +final provider = Provider((_) => 'some value'); + +class YourWidgetYouWantToTest extends StatelessWidget { + const YourWidgetYouWantToTest({super.key}); + + @override + Widget build(BuildContext context) => const Placeholder(); +} + +/* SNIPPET START */ +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + + final element = tester.element(find.byType(YourWidgetYouWantToTest)); + final container = ProviderScope.containerOf(element); + + // TODO providers와 상호작용합니다. + expect( + container.read(provider), + 'some value', + ); + }); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart new file mode 100644 index 000000000..d2e840d9b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 'Hello world'); + +void main() { + test('Some description', () { + final container = createContainer(); + /* SNIPPET START */ + container.listen( + provider, + (previous, next) { + print('The provider changed from $previous to $next'); + }, + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart new file mode 100644 index 000000000..d939aa2e7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart @@ -0,0 +1,45 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +import 'create_container.dart'; +import 'full_widget_test.dart'; +import 'provider_to_mock/raw.dart'; + +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + /* SNIPPET START */ + // 단위 테스트에서는 이전의 "createContainer" 유틸리티를 재사용합니다. + final container = createContainer( + // 모킹할 provider 목록을 지정할 수 있습니다: + overrides: [ + // 이 경우 "exampleProvider"를 모킹하고 있습니다. + exampleProvider.overrideWith((ref) { + // 이 함수는 provider의 일반적인 초기화 함수입니다. + // 일반적으로 "ref.watch"를 호출하여 초기 상태를 반환하는 곳입니다. + + // 기본값인 "Hello world"를 사용자 정의 값으로 바꾸어 보겠습니다. + // 그러면 `exampleProvider`와 상호 작용하면 이 값이 반환됩니다. + return 'Hello from tests'; + }), + ], + ); + + // ProviderScope를 사용하여 위젯 테스트에서도 동일한 작업을 수행할 수 있습니다: + await tester.pumpWidget( + ProviderScope( + // ProviderScopes에는 정확히 동일한 "overrides" 매개변수가 있습니다. + overrides: [ + // 이전과 동일 + exampleProvider.overrideWith((ref) => 'Hello from tests'), + ], + child: const YourWidgetYouWantToTest(), + ), + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart new file mode 100644 index 000000000..ccb009f3f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart @@ -0,0 +1,17 @@ +// ignore_for_file: prefer_mixin + +import 'package:mockito/mockito.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() => throw UnimplementedError(); +} + +// Mock 클래스는 notifier가 사용하는 것에 해당하는 Notifier base-class를 서브클래싱해야 합니다. +class MyNotifierMock extends _$MyNotifier with Mock implements MyNotifier {} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart new file mode 100644 index 000000000..df3894527 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'912fa35c2296626fc0825bcbcfc6b6c85958be02'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart new file mode 100644 index 000000000..e7b1c6f0e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart @@ -0,0 +1,15 @@ +// ignore_for_file: prefer_mixin + +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:mockito/mockito.dart'; + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() => throw UnimplementedError(); +} + +// Your mock needs to subclass the Notifier base-class corresponding +// to whatever your notifier uses +class MyNotifierMock extends Notifier with Mock implements MyNotifier {} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart new file mode 100644 index 000000000..2aea771eb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +// 이른 초기화된 provider. +@riverpod +Future example(ExampleRef ref) async => 'Hello world'; +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart new file mode 100644 index 000000000..fa3e37948 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart new file mode 100644 index 000000000..aad01febe --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart @@ -0,0 +1,6 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +// An eagerly initialized provider. +final exampleProvider = FutureProvider((ref) async => 'Hello world'); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart new file mode 100644 index 000000000..06caf0b96 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 42); + +/* SNIPPET START */ +void main() { + test('Some description', () { + // 이 테스트에 대한 ProviderContainer를 생성합니다. + // DO NOT 테스트 간에 ProviderContainer를 공유하지 마세요. + final container = createContainer(); + + // TODO: use the container to test your application. + expect( + container.read(provider), + equals('some value'), + ); + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart new file mode 100644 index 000000000..61b2ca36b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart @@ -0,0 +1,15 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +import 'widget_test.dart'; + +void main() { + testWidgets('Some description', (tester) async { + /* SNIPPET START */ + final element = tester.element(find.byType(YourWidgetYouWantToTest)); + final container = ProviderScope.containerOf(element); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart new file mode 100644 index 000000000..b4afc835c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +class YourWidgetYouWantToTest extends StatelessWidget { + const YourWidgetYouWantToTest({super.key}); + + @override + Widget build(BuildContext context) => const Placeholder(); +} + +/* SNIPPET START */ +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + }); +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx new file mode 100644 index 000000000..39db8dcfe --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx @@ -0,0 +1,100 @@ +--- +title: 웹소켓 및 동기 실행 +--- + +import { + trimSnippet, + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; +import syncDefinition from "./websockets_sync/sync_definition"; +import streamProvider from "./websockets_sync/stream_provider"; +import syncConsumer from "!!raw-loader!./websockets_sync/sync_consumer.dart"; +import rawUsage from "!!raw-loader!./websockets_sync/raw_usage.dart"; +import pipeChangeNotifier from "!!raw-loader!./websockets_sync/pipe_change_notifier.dart"; +import sharedPipeChangeNotifier from "!!raw-loader!./websockets_sync/shared_pipe_change_notifier.dart"; +import changeNotifierProvider from "!!raw-loader!./websockets_sync/change_notifier_provider.dart"; + +지금까지는 `Future`를 생성하는 방법만 다루었습니다. +이는 의도적으로 `Future`가 Riverpod 애플리케이션을 빌드하는 방법의 핵심이기 때문입니다. +_하지만_ Riverpod는 필요한 경우 다른 형식도 지원합니다. + +특히 providers는 `Future` 대신 자유롭게 객체를 반환할 수 있습니다: + +- 'Repository' 생성 등 객체를 동기적으로 반환할 수 있습니다. +- 웹소켓을 수신하기 위해 `Stream`을 반환합니다. + +`Future`를 반환하는 것과 `Stream` 또는 객체를 반환하는 것은 전반적으로 매우 유사합니다. +이 페이지는 이러한 사용 사례에 대한 미묘한 차이점과 다양한 팁을 설명하는 페이지라고 생각하시면 됩니다. + +## 동기적으로 객체 반환하기 + +객체를 동기적으로 생성하려면 provice가 Future를 반환하지 않는지 확인하세요: + + + +provider가 객체를 동기적으로 생성하면 객체가 소비되는 방식에 영향을 미칩니다. +특히 동기식 값은 "AsyncValue"로 래핑되지 않습니다: + + + +이 차이로 인해 provice가 에러를 발생시키면 값을 읽으려고(read) 하면 에러가 다시 발생(rethrow)합니다. +또는 `ref.listen`을 사용할 경우 "onError" 콜백이 호출됩니다. + +### 수신 가능(Listenable) 객체 고려 사항 + + + +`ChangeNotifier` 또는 `StateNotifier`과 같은 수신가능 객체는 지원되지 않습니다. +호환성상의 이유로 이러한 객체 중 하나와 상호 작용해야 하는 경우, 한 가지 우회 방법은 해당 알림 메커니즘(notification mechanism)을 Riverpod로 연결(pipe)하는 것입니다. + + + +:::info +이러한 로직이 여러 번 필요한 경우, 공유된 로직에 주목할 가치가 있습니다! "ref" 객체는 컴포저블(composable)하게 설계되었습니다. +이를 통해 공급자에서 dispose/listening 로직을 추출할 수 있습니다: + + +::: + + + + + +코드 생성(code-generation)을 사용하지 않을 경우, +Riverpod은 `ChangeNotifier`와 `StateNotifier`를 즉시 지원하는 "legacy" 프로바이더를 제공합니다: `ChangeNotifierProvider` and `StateNotifierProvider`. +이들을 사용하는 것은 다른 종류의 provider를 사용하는 것과 비슷합니다. 가장 큰 차이점은 둘 다 반환된 객체를 자동으로 수신(listen)하고 폐기(dispose)한다는 점입니다. + +이러한 providers는 새로운 비즈니스 로직에는 권장되지 않습니다. +그러나 `pkg:provider`에서 Riverpod로 마이그레이션할 때와 같이 레거시 코드와 상호 작용할 때는 유용할 수 있습니다. + + + + + +## 스트림 수신하기(Listening) + +최신 애플리케이션의 일반적인 사용 사례는 websocket과 상호 작용하는 것입니다(예: Firebase 또는 GraphQL 구독). +이러한 API와의 상호 작용은 종종 `Stream`을 수신하여 수행됩니다. + +이를 돕기 위해 Riverpod은 `Stream` 객체를 자연스럽게 지원합니다. +`Future` 객체와 마찬가지로 이 객체는 `AsyncValue`로 변환됩니다: + + + +:::info +Riverpod은 RX의 `BehaviorSubject`와 같은 같은 커스텀 `Stream` 구현을 인식하지 못합니다. +따라서 생성시 이미 사용 가능하더라도 `BehaviorSubject`를 반환하면 `value`가 위젯에 동기적으로 노출되지 않습니다. +::: + +## `Stream`/`Future`를 `AsyncValue`로 변환하지 않기 + +기본적으로 Riverpod는 `Stream`과 `Future`를 `AsyncValue`로 변환합니다. +거의 필요하지 않지만, 반환 유형을 `Raw` typedef로 감싸서 이 동작을 비활성화할 수 있습니다. + +:::caution +일반적으로 `AsyncValue` 변환을 비활성화하는 것은 권장하지 않습니다. +자신이 무엇을 하고 있는지 알고 있는 경우에만 그렇게 하세요. +::: + + diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart new file mode 100644 index 000000000..73fbcbc14 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart @@ -0,0 +1,11 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ +final myProvider = ChangeNotifierProvider>((ref) { + // ValueNotifier를 수신하고 처리합니다. + // 그러면 위젯은 이 provider를 "ref.watch"하여 업데이트를 수신할 수 있습니다. + return ValueNotifier(0); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart new file mode 100644 index 000000000..3e7371aad --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart @@ -0,0 +1,21 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'pipe_change_notifier.g.dart'; + +/* SNIPPET START */ +/// 값이 변경될 때마다 ValueNotifier를 생성하고 리스너를 업데이트하는 provider입니다. +@riverpod +Raw> myListenable(MyListenableRef ref) { + final notifier = ValueNotifier(0); + + // provider가 dispose되면 notifier를 dispose합니다. + ref.onDispose(notifier.dispose); + + // ValueNotifier가 업데이트될 때마다 이 provider의 리스너에게 알립니다. + notifier.addListener(ref.notifyListeners); + + return notifier; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart new file mode 100644 index 000000000..32ab42850 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -0,0 +1,79 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'pipe_change_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +/// 값이 변경될 때마다 ValueNotifier를 생성하고 리스너를 업데이트하는 provider입니다. +typedef MyListenableRef = Ref>>; + +/// 값이 변경될 때마다 ValueNotifier를 생성하고 리스너를 업데이트하는 provider입니다. +@ProviderFor(myListenable) +const myListenableProvider = MyListenableProvider._(); + +/// 값이 변경될 때마다 ValueNotifier를 생성하고 리스너를 업데이트하는 provider입니다. +final class MyListenableProvider extends $FunctionalProvider< + Raw>, + Raw>, + MyListenableRef> with $Provider>, MyListenableRef> { + /// 값이 변경될 때마다 ValueNotifier를 생성하고 리스너를 업데이트하는 provider입니다. + const MyListenableProvider._( + {Raw> Function( + MyListenableRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myListenableProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + MyListenableRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$myListenableHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @$internal + @override + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + MyListenableProvider $copyWithCreate( + Raw> Function( + MyListenableRef ref, + ) create, + ) { + return MyListenableProvider._(create: create); + } + + @override + Raw> create(MyListenableRef ref) { + final _$cb = _createCb ?? myListenable; + return _$cb(ref); + } +} + +String _$myListenableHash() => r'c80799a0224092668fca44187b98ccfcd2b33ae1'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart new file mode 100644 index 000000000..f5b829c33 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart @@ -0,0 +1,28 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'raw_usage.g.dart'; + +/* SNIPPET START */ +@riverpod +Raw> rawStream(RawStreamRef ref) { + // "Raw"는 typedef입니다. "Raw" 생성자로 반환값을 Wrap할 필요가 없습니다. + return const Stream.empty(); +} + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 값이 더 이상 AsyncValue로 변환되지 않고, 생성된 스트림이 그대로 반환됩니다. + Stream stream = ref.watch(rawStreamProvider); + return StreamBuilder( + stream: stream, + builder: (context, snapshot) { + return Text('${snapshot.data}'); + }, + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart new file mode 100644 index 000000000..60959986e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart @@ -0,0 +1,75 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'raw_usage.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RawStreamRef = Ref>>; + +@ProviderFor(rawStream) +const rawStreamProvider = RawStreamProvider._(); + +final class RawStreamProvider extends $FunctionalProvider< + Raw>, + Raw>, + RawStreamRef> with $Provider>, RawStreamRef> { + const RawStreamProvider._( + {Raw> Function( + RawStreamRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'rawStreamProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + RawStreamRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$rawStreamHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @$internal + @override + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + RawStreamProvider $copyWithCreate( + Raw> Function( + RawStreamRef ref, + ) create, + ) { + return RawStreamProvider._(create: create); + } + + @override + Raw> create(RawStreamRef ref) { + final _$cb = _createCb ?? rawStream; + return _$cb(ref); + } +} + +String _$rawStreamHash() => r'7e7c2e8f4f08d33a4d86d60449e143c419ca4822'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart new file mode 100644 index 000000000..8e3bb0987 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart @@ -0,0 +1,28 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'shared_pipe_change_notifier.g.dart'; + +/* SNIPPET START */ +extension on Ref { + // 이전 로직을 Ref 확장(extension)으로 옮길 수 있습니다. + // 이렇게 하면 provider 간에 로직을 재사용할 수 있습니다. + T disposeAndListenChangeNotifier(T notifier) { + onDispose(notifier.dispose); + notifier.addListener(notifyListeners); + // 사용 편의성을 높이기 위해 Notifier을 반환합니다. + return notifier; + } +} + +@riverpod +Raw> myListenable(MyListenableRef ref) { + return ref.disposeAndListenChangeNotifier(ValueNotifier(0)); +} + +@riverpod +Raw> anotherListenable(AnotherListenableRef ref) { + return ref.disposeAndListenChangeNotifier(ValueNotifier(42)); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart new file mode 100644 index 000000000..ebffc98b1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -0,0 +1,136 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'shared_pipe_change_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef MyListenableRef = Ref>>; + +@ProviderFor(myListenable) +const myListenableProvider = MyListenableProvider._(); + +final class MyListenableProvider extends $FunctionalProvider< + Raw>, + Raw>, + MyListenableRef> with $Provider>, MyListenableRef> { + const MyListenableProvider._( + {Raw> Function( + MyListenableRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myListenableProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + MyListenableRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$myListenableHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @$internal + @override + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + MyListenableProvider $copyWithCreate( + Raw> Function( + MyListenableRef ref, + ) create, + ) { + return MyListenableProvider._(create: create); + } + + @override + Raw> create(MyListenableRef ref) { + final _$cb = _createCb ?? myListenable; + return _$cb(ref); + } +} + +String _$myListenableHash() => r'90f4227ef5442f978d742115663e5f0869622a27'; + +typedef AnotherListenableRef = Ref>>; + +@ProviderFor(anotherListenable) +const anotherListenableProvider = AnotherListenableProvider._(); + +final class AnotherListenableProvider extends $FunctionalProvider< + Raw>, Raw>, AnotherListenableRef> + with $Provider>, AnotherListenableRef> { + const AnotherListenableProvider._( + {Raw> Function( + AnotherListenableRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'anotherListenableProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + AnotherListenableRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$anotherListenableHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @$internal + @override + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + AnotherListenableProvider $copyWithCreate( + Raw> Function( + AnotherListenableRef ref, + ) create, + ) { + return AnotherListenableProvider._(create: create); + } + + @override + Raw> create(AnotherListenableRef ref) { + final _$cb = _createCb ?? anotherListenable; + return _$cb(ref); + } +} + +String _$anotherListenableHash() => r'50dd36b21e07c50818944ec49f9e68d21fcae876'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart new file mode 100644 index 000000000..e3559f350 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart @@ -0,0 +1,34 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Stream streamExample(StreamExampleRef ref) async* { + // 1초마다 0에서 41 사이의 숫자를 yield합니다. + // 이 값은 Firestore나 GraphQL 등의 스트림으로 대체할 수 있습니다. + for (var i = 0; i < 42; i++) { + yield i; + await Future.delayed(const Duration(seconds: 1)); + } +} + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 스트림을 수신하고 AsyncValue로 변환합니다. + AsyncValue value = ref.watch(streamExampleProvider); + + // 로딩/오류 상태를 처리하고 데이터를 표시하는 데 AsyncValue를 사용할 수 있습니다. + return switch (value) { + AsyncValue(:final error?) => Text('Error: $error'), + AsyncValue(:final valueOrNull?) => Text('$valueOrNull'), + _ => const CircularProgressIndicator(), + }; + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart new file mode 100644 index 000000000..eabd579e0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef StreamExampleRef = Ref>; + +@ProviderFor(streamExample) +const streamExampleProvider = StreamExampleProvider._(); + +final class StreamExampleProvider + extends $FunctionalProvider, Stream, StreamExampleRef> + with $FutureModifier, $StreamProvider { + const StreamExampleProvider._( + {Stream Function( + StreamExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'streamExampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + StreamExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$streamExampleHash(); + + @$internal + @override + $StreamProviderElement $createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + StreamExampleProvider $copyWithCreate( + Stream Function( + StreamExampleRef ref, + ) create, + ) { + return StreamExampleProvider._(create: create); + } + + @override + Stream create(StreamExampleRef ref) { + final _$cb = _createCb ?? streamExample; + return _$cb(ref); + } +} + +String _$streamExampleHash() => r'ca9993b22f6d587b20c041133cacd28d01933074'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts new file mode 100644 index 000000000..4ee159de8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts @@ -0,0 +1,4 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart new file mode 100644 index 000000000..f3dcda2fe --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart @@ -0,0 +1,30 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final streamExampleProvider = StreamProvider.autoDispose((ref) async* { + // Every 1 second, yield a number from 0 to 41. + // This could be replaced with a Stream from Firestore or GraphQL or anything else. + for (var i = 0; i < 42; i++) { + yield i; + await Future.delayed(const Duration(seconds: 1)); + } +}); + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // The stream is listened to and converted to an AsyncValue. + AsyncValue value = ref.watch(streamExampleProvider); + + // We can use the AsyncValue to handle loading/error states and show the data. + return switch (value) { + AsyncValue(:final error?) => Text('Error: $error'), + AsyncValue(:final valueOrNull?) => Text('$valueOrNull'), + _ => const CircularProgressIndicator(), + }; + } +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart new file mode 100644 index 000000000..4864c30da --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart @@ -0,0 +1,19 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'sync_definition/raw.dart'; + +void main() { +/* SNIPPET START */ + Consumer( + builder: (context, ref, child) { + // 값은 "AsyncValue"로 래핑되지 않습니다. + int value = ref.watch(synchronousExampleProvider); + + return Text('$value'); + }, + ); +/* SNIPPET END */ +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart new file mode 100644 index 000000000..dbccd14aa --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart @@ -0,0 +1,10 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +int synchronousExample(SynchronousExampleRef ref) { + return 0; +} +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart new file mode 100644 index 000000000..ffc21fd38 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef SynchronousExampleRef = Ref; + +@ProviderFor(synchronousExample) +const synchronousExampleProvider = SynchronousExampleProvider._(); + +final class SynchronousExampleProvider + extends $FunctionalProvider + with $Provider { + const SynchronousExampleProvider._( + {int Function( + SynchronousExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'synchronousExampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + SynchronousExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$synchronousExampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + SynchronousExampleProvider $copyWithCreate( + int Function( + SynchronousExampleRef ref, + ) create, + ) { + return SynchronousExampleProvider._(create: create); + } + + @override + int create(SynchronousExampleRef ref) { + final _$cb = _createCb ?? synchronousExample; + return _$cb(ref); + } +} + +String _$synchronousExampleHash() => + r'98df96e07d554683041f668c06b36f183ff534c1'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts new file mode 100644 index 000000000..4ee159de8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts @@ -0,0 +1,4 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart new file mode 100644 index 000000000..193c5eeff --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart @@ -0,0 +1,7 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +final synchronousExampleProvider = Provider.autoDispose((ref) { + return 0; +}); +/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.dart new file mode 100644 index 000000000..4d49c552a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.dart @@ -0,0 +1,11 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family.g.dart'; +/* SNIPPET START */ + +@riverpod +int random(RandomRef ref, {required int seed, required int max}) { + return Random(seed).nextInt(max); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart new file mode 100644 index 000000000..f53a38413 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart @@ -0,0 +1,168 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RandomRef = Ref; + +@ProviderFor(random) +const randomProvider = RandomFamily._(); + +final class RandomProvider extends $FunctionalProvider + with $Provider { + const RandomProvider._( + {required RandomFamily super.from, + required ({ + int seed, + int max, + }) + super.argument, + int Function( + RandomRef ref, { + required int seed, + required int max, + })? create}) + : _createCb = create, + super( + name: r'randomProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + RandomRef ref, { + required int seed, + required int max, + })? _createCb; + + @override + String debugGetCreateSourceHash() => _$randomHash(); + + @override + String toString() { + return r'randomProvider' + '' + '$argument'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RandomProvider $copyWithCreate( + int Function( + RandomRef ref, + ) create, + ) { + return RandomProvider._( + argument: argument as ({ + int seed, + int max, + }), + from: from! as RandomFamily, + create: ( + ref, { + required int seed, + required int max, + }) => + create(ref)); + } + + @override + int create(RandomRef ref) { + final _$cb = _createCb ?? random; + final argument = this.argument as ({ + int seed, + int max, + }); + return _$cb( + ref, + seed: argument.seed, + max: argument.max, + ); + } + + @override + bool operator ==(Object other) { + return other is RandomProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$randomHash() => r'517b12aad4df7b31f8872b89af74e7880377b2ea'; + +final class RandomFamily extends Family { + const RandomFamily._() + : super( + name: r'randomProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + RandomProvider call({ + required int seed, + required int max, + }) => + RandomProvider._(argument: ( + seed: seed, + max: max, + ), from: this); + + @override + String debugGetCreateSourceHash() => _$randomHash(); + + @override + String toString() => r'randomProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + int Function( + RandomRef ref, + ({ + int seed, + int max, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as RandomProvider; + + final argument = provider.argument as ({ + int seed, + int max, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx new file mode 100644 index 000000000..fa391f61a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./family.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart new file mode 100644 index 000000000..e1977b568 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart @@ -0,0 +1,27 @@ +import 'dart:math'; + +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod/riverpod.dart'; + +@immutable +abstract class Equatable { + const Equatable(); + + List get props; +} + +/* SNIPPET START */ +class ParamsType extends Equatable { + const ParamsType({required this.seed, required this.max}); + + final int seed; + final int max; + + @override + List get props => [seed, max]; +} + +final randomProvider = + Provider.family.autoDispose((ref, params) { + return Random(params.seed).nextInt(params.max); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart new file mode 100644 index 000000000..1082ef6f3 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart @@ -0,0 +1,12 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; + +import 'json.dart'; + +part 'item.freezed.dart'; +part 'item.g.dart'; + +@freezed +class Item with _$Item { + const factory Item({required int id}) = _Item; + factory Item.fromJson(Json json) => _$ItemFromJson(json); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart new file mode 100644 index 000000000..e578c8154 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart @@ -0,0 +1,146 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'item.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Item _$ItemFromJson(Map json) { + return _Item.fromJson(json); +} + +/// @nodoc +mixin _$Item { + int get id => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ItemCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ItemCopyWith<$Res> { + factory $ItemCopyWith(Item value, $Res Function(Item) then) = + _$ItemCopyWithImpl<$Res, Item>; + @useResult + $Res call({int id}); +} + +/// @nodoc +class _$ItemCopyWithImpl<$Res, $Val extends Item> + implements $ItemCopyWith<$Res> { + _$ItemCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as int, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ItemImplCopyWith<$Res> implements $ItemCopyWith<$Res> { + factory _$$ItemImplCopyWith( + _$ItemImpl value, $Res Function(_$ItemImpl) then) = + __$$ItemImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({int id}); +} + +/// @nodoc +class __$$ItemImplCopyWithImpl<$Res> + extends _$ItemCopyWithImpl<$Res, _$ItemImpl> + implements _$$ItemImplCopyWith<$Res> { + __$$ItemImplCopyWithImpl(_$ItemImpl _value, $Res Function(_$ItemImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + }) { + return _then(_$ItemImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as int, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ItemImpl implements _Item { + const _$ItemImpl({required this.id}); + + factory _$ItemImpl.fromJson(Map json) => + _$$ItemImplFromJson(json); + + @override + final int id; + + @override + String toString() { + return 'Item(id: $id)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ItemImpl && + (identical(other.id, id) || other.id == id)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, id); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ItemImplCopyWith<_$ItemImpl> get copyWith => + __$$ItemImplCopyWithImpl<_$ItemImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ItemImplToJson( + this, + ); + } +} + +abstract class _Item implements Item { + const factory _Item({required final int id}) = _$ItemImpl; + + factory _Item.fromJson(Map json) = _$ItemImpl.fromJson; + + @override + int get id; + @override + @JsonKey(ignore: true) + _$$ItemImplCopyWith<_$ItemImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart new file mode 100644 index 000000000..3c653e18c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart @@ -0,0 +1,18 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'item.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ItemImpl _$$ItemImplFromJson(Map json) => _$ItemImpl( + id: json['id'] as int, + ); + +Map _$$ItemImplToJson(_$ItemImpl instance) => + { + 'id': instance.id, + }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart new file mode 100644 index 000000000..17cfb1c01 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart @@ -0,0 +1 @@ +typedef Json = Map; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart new file mode 100644 index 000000000..802a23150 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart @@ -0,0 +1,29 @@ +import 'package:collection/collection.dart'; +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; +import '../../helpers/json.dart'; + +part 'async_values.g.dart'; + +/* SNIPPET START */ + +@riverpod +Future> itemsApi(ItemsApiRef ref) async { + final client = Dio(); + final result = await client.get>('your-favorite-api'); + final parsed = [...result.data!.map((e) => Item.fromJson(e as Json))]; + return parsed; +} + +@riverpod +List evenItems(EvenItemsRef ref) { + final asyncValue = ref.watch(itemsApiProvider); + if (asyncValue.isReloading) return []; + if (asyncValue.hasError) return const [Item(id: -1)]; + + final items = asyncValue.requireValue; + + return [...items.whereIndexed((index, element) => index.isEven)]; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart new file mode 100644 index 000000000..ae3227615 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart @@ -0,0 +1,126 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_values.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ItemsApiRef = Ref>>; + +@ProviderFor(itemsApi) +const itemsApiProvider = ItemsApiProvider._(); + +final class ItemsApiProvider extends $FunctionalProvider>, + FutureOr>, ItemsApiRef> + with $FutureModifier>, $FutureProvider, ItemsApiRef> { + const ItemsApiProvider._( + {FutureOr> Function( + ItemsApiRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'itemsApiProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + ItemsApiRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$itemsApiHash(); + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ItemsApiProvider $copyWithCreate( + FutureOr> Function( + ItemsApiRef ref, + ) create, + ) { + return ItemsApiProvider._(create: create); + } + + @override + FutureOr> create(ItemsApiRef ref) { + final _$cb = _createCb ?? itemsApi; + return _$cb(ref); + } +} + +String _$itemsApiHash() => r'b32ccb7b85305e361d8ed752cbe11d9524c96190'; + +typedef EvenItemsRef = Ref>; + +@ProviderFor(evenItems) +const evenItemsProvider = EvenItemsProvider._(); + +final class EvenItemsProvider + extends $FunctionalProvider, List, EvenItemsRef> + with $Provider, EvenItemsRef> { + const EvenItemsProvider._( + {List Function( + EvenItemsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'evenItemsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + EvenItemsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$evenItemsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + EvenItemsProvider $copyWithCreate( + List Function( + EvenItemsRef ref, + ) create, + ) { + return EvenItemsProvider._(create: create); + } + + @override + List create(EvenItemsRef ref) { + final _$cb = _createCb ?? evenItems; + return _$cb(ref); + } +} + +String _$evenItemsHash() => r'55ae98f9b6108203dfc4a139f1ade9fbd8ba8ddd'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx new file mode 100644 index 000000000..526f2dffe --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./async_values.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart new file mode 100644 index 000000000..f21a954e5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart @@ -0,0 +1,25 @@ +import 'package:collection/collection.dart'; +import 'package:dio/dio.dart'; +import 'package:riverpod/riverpod.dart'; + +import '../../helpers/item.dart'; +import '../../helpers/json.dart'; + +/* SNIPPET START */ + +final itemsApiProvider = FutureProvider.autoDispose((ref) async { + final client = Dio(); + final result = await client.get>('your-favorite-api'); + final parsed = [...result.data!.map((e) => Item.fromJson(e as Json))]; + return parsed; +}); + +final evenItemsProvider = Provider.autoDispose((ref) { + final asyncValue = ref.watch(itemsApiProvider); + if (asyncValue.isLoading) return []; + if (asyncValue.hasError) return const [Item(id: -1)]; + + final items = asyncValue.requireValue; + + return [...items.whereIndexed((index, element) => index.isEven)]; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart new file mode 100644 index 000000000..9d739eb38 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart @@ -0,0 +1,29 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'auto_dispose.g.dart'; + +/* SNIPPET START */ + +// 코드 생성 시 .autoDispose가 기본값 +@riverpod +int diceRoll(DiceRollRef ref) { + // 이 provider는 .autoDispose이므로 + // 리스닝을 해제하면 현재 노출된 상태가 폐기됩니다. + // 그런 다음 이 provider를 다시 수신할 때마다 + // 새로운 주사위를 굴려서 다시 노출합니다. + final dice = Random().nextInt(10); + return dice; +} + +@riverpod +int cachedDiceRoll(CachedDiceRollRef ref) { + final coin = Random().nextInt(10); + if (coin > 5) throw Exception('Way too large.'); + // 위의 조건은 실패할 수 있습니다; + // 그렇지 않은 경우, 다음 명령어는 아무도 더 이상 수신하지 않더라도 + // 캐시된 상태를 유지하도록 provider에게 지시합니다. + ref.keepAlive(); + return coin; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart new file mode 100644 index 000000000..4baf88906 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -0,0 +1,132 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'auto_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef DiceRollRef = Ref; + +@ProviderFor(diceRoll) +const diceRollProvider = DiceRollProvider._(); + +final class DiceRollProvider extends $FunctionalProvider + with $Provider { + const DiceRollProvider._( + {int Function( + DiceRollRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'diceRollProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + DiceRollRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$diceRollHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DiceRollProvider $copyWithCreate( + int Function( + DiceRollRef ref, + ) create, + ) { + return DiceRollProvider._(create: create); + } + + @override + int create(DiceRollRef ref) { + final _$cb = _createCb ?? diceRoll; + return _$cb(ref); + } +} + +String _$diceRollHash() => r'dfd5ac8b74351a0076da9d131c10277f53ff11b9'; + +typedef CachedDiceRollRef = Ref; + +@ProviderFor(cachedDiceRoll) +const cachedDiceRollProvider = CachedDiceRollProvider._(); + +final class CachedDiceRollProvider + extends $FunctionalProvider + with $Provider { + const CachedDiceRollProvider._( + {int Function( + CachedDiceRollRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'cachedDiceRollProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CachedDiceRollRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$cachedDiceRollHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CachedDiceRollProvider $copyWithCreate( + int Function( + CachedDiceRollRef ref, + ) create, + ) { + return CachedDiceRollProvider._(create: create); + } + + @override + int create(CachedDiceRollRef ref) { + final _$cb = _createCb ?? cachedDiceRoll; + return _$cb(ref); + } +} + +String _$cachedDiceRollHash() => r'fc31fcb804f10360d75362e56329976343ee7abb'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx new file mode 100644 index 000000000..6c57cfffd --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./auto_dispose.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart new file mode 100644 index 000000000..c206757b3 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart @@ -0,0 +1,24 @@ +import 'dart:math'; + +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ + +final diceRollProvider = Provider.autoDispose((ref) { + // Since this provider is .autoDispose, un-listening to it will dispose + // its current exposed state. + // Then, whenever this provider is listened to again, + // a new dice will be rolled and exposed again. + final dice = Random().nextInt(10); + return dice.isEven; +}); + +final cachedDiceRollProvider = Provider.autoDispose((ref) { + final coin = Random().nextInt(10); + if (coin > 5) throw Exception('Way too large.'); + // The above condition might fail; + // If it doesn't, the following instruction tells the Provider + // to keep its cached state, *even when no one listens to it anymore*. + ref.keepAlive(); + return coin.isEven; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart new file mode 100644 index 000000000..ecd1915da --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart @@ -0,0 +1,19 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'combine.g.dart'; + +/* SNIPPET START */ + +@riverpod +int number(NumberRef ref) { + return Random().nextInt(10); +} + +@riverpod +int doubled(DoubledRef ref) { + final number = ref.watch(numberProvider); + + return number * 2; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart new file mode 100644 index 000000000..ef5a1884c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart @@ -0,0 +1,131 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'combine.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef NumberRef = Ref; + +@ProviderFor(number) +const numberProvider = NumberProvider._(); + +final class NumberProvider extends $FunctionalProvider + with $Provider { + const NumberProvider._( + {int Function( + NumberRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'numberProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + NumberRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$numberHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + NumberProvider $copyWithCreate( + int Function( + NumberRef ref, + ) create, + ) { + return NumberProvider._(create: create); + } + + @override + int create(NumberRef ref) { + final _$cb = _createCb ?? number; + return _$cb(ref); + } +} + +String _$numberHash() => r'725e25be57b9cc2bd914752f156e26a214596b63'; + +typedef DoubledRef = Ref; + +@ProviderFor(doubled) +const doubledProvider = DoubledProvider._(); + +final class DoubledProvider extends $FunctionalProvider + with $Provider { + const DoubledProvider._( + {int Function( + DoubledRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'doubledProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + DoubledRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$doubledHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DoubledProvider $copyWithCreate( + int Function( + DoubledRef ref, + ) create, + ) { + return DoubledProvider._(create: create); + } + + @override + int create(DoubledRef ref) { + final _$cb = _createCb ?? doubled; + return _$cb(ref); + } +} + +String _$doubledHash() => r'ddc640c876bdbe49fe72fe1632b5ff48687c9279'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx new file mode 100644 index 000000000..2ff7dfbaa --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./combine.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart new file mode 100644 index 000000000..1b8412dd0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart @@ -0,0 +1,15 @@ +import 'dart:math'; + +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ + +final numberProvider = Provider.autoDispose((ref) { + return Random().nextInt(10); +}); + +final doubledProvider = Provider.autoDispose((ref) { + final number = ref.watch(numberProvider); + + return number * 2; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx new file mode 100644 index 000000000..a8e75cd4f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx @@ -0,0 +1,192 @@ +--- +title: 동기부여(Motivation) +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import sameType from "./same_type"; +import combine from "./combine"; +import asyncValues from "./async_values"; +import autoDispose from "./auto_dispose"; +import override from "./override"; +import sideEffects from "./side_effects"; +import { + trimSnippet, + AutoSnippet, + When, +} from "../../../../../../src/components/CodeSnippet"; + +이 심층 글은 Riverpod의 존재 이유를 보여주기 위해 작성되었습니다. + +특히 이 섹션에서는 아래에 답해야 합니다: + - Provider가 널리 사용되는데 왜 Riverpod로 마이그레이션해야 하나요? + - 어떤 구체적인 이점을 얻을 수 있나요? + - 어떻게 Riverpod로 마이그레이션할 수 있나요? + - 점진적으로 마이그레이션할 수 있나요? + - 기타 등등 + +이 섹션이 끝날 때쯤이면 Provider보다 Riverpod을 선호해야 한다는 확신이 들 것입니다. + +**Riverpod은 실제로 Provider와 비교할 때 더 현대적이고 권장되며 신뢰할 수 있는 접근 방식입니다.** + +Riverpod은 더 나은 상태 관리 기능, 더 나은 캐싱 전략, 간소화된 리액티비티 모델을 제공합니다. +반면, Provider는 현재 많은 부분에서 부족하고 앞으로 나아갈 방법이 없습니다. + +## Provider의 제약사항 + +Provider는 InheritedWidget API의 제약을 받기 때문에 근본적인 문제가 있습니다. +본질적으로 Provider는 "더 단순한 `InheritedWidget`"입니다; +Provider는 단지 InheritedWidget 래퍼일 뿐이므로 이에 의해 제한을 받습니다. + +### Provider는 동일한 "타입"의 providers를 두 개(또는 그 이상) 보유할 수 었습니다. + +두 개의 `Provider`를 선언하면 불안정한 동작이 발생합니다.: +`InheritedWidget`API는 *둘 중 하나*만 가져옵니다: 가장 가까운 `Provider` 조상(ancestor) + +[해결방법]은 Provider의 문서에 설명되어 있지만, Riverpod은 이 문제가 없습니다. + +이 제약을 제거하면 다음과 같이 로직을 작은 조각으로 자유롭게 분할할 수 있습니다: + + + +### Providers는 한 번에 하나의 값만 합리적으로 반환합니다 + +외부 RESTful API를 읽을 때, 새 호출이 다음 값을 로드하는 동안 마지막으로 읽은 값을 표시하는 것은 매우 일반적입니다. +Riverpod은 `AsyncValue`의 API를 통해 한 번에 두 개의 값(즉, 이전 데이터 값과 새로 들어오는 새 로딩 값)을 전송함으로써 이러한 동작을 허용합니다: + + + +이전 코드 조각에서 `evenItemsProvider`를 보면 다음과 같은 효과가 나타납니다: +1. 처음에, 요청이 이루어지고 빈 목록을 얻습니다; +2. 그런 다음 오류가 발생한다고 가정합니다. `[Item(id: -1)]`을 얻습니다; +3. 그런 다음 pull-to-refresh 로직으로 요청을 다시 시도합니다(예: `ref.invalidate`를 통해); +4. 첫 번째 공급자를 다시 로드하는 동안 두 번째 공급자는 여전히 `[Item(id: -1)]`을 노출합니다; +5. 이번에는 일부 파싱된 데이터가 올바르게 수신됩니다: 짝수 항목이 올바르게 반환됩니다. + +프로바이더를 사용하면 위의 기능을 원격으로 구현할 수 없으며 해결 방법도 쉽지 않습니다. + +### providers를 결합하는 것은 어렵고 에러가 발생하기 쉽습니다 + +Provider를 사용하면 provider의 `create`안에서 `context.watch`를 사용하고 싶을 수 있습니다. +이는 종속성이 변경되지 않은 경우(예: 위젯 트리에 GlobalKey가 포함되어 있는 경우)에도 `didChangeDependencies`가 트리거될 수 있기 때문에 신뢰할 수 없습니다. + +그럼에도 불구하고, Provider는 `ProxyProvider`라는 Ad-hoc 솔루션을 가지고 있지만, 이는 지루하고 오류가 발생하기 쉽다고 여겨집니다. + +상태 결합은 [ref.watch] 및 [ref.listen]와 같은 간단하지만 강력한 유틸리티를 사용하여 오버헤드 없이 반응형으로 값을 결합하고 캐시할 수 있기 때문에 Riverpod의 핵심 메커니즘입니다. + + + +Riverpod에서는 종속성을 읽을 수 있고 API가 동일하게 유지되므로 값을 결합하는 것이 자연스럽게 느껴집니다. + +### 안정성 부족 +Provider를 상요하면, 리팩토링 또는 대규모 변경 중에 `ProviderNotFoundException`을 종종 마주치게 됩니다. +사실, 이 런타임 예외는 Riverpod이 처음 만들어진 주요 이유 중 하나였습니다. + +이보다 훨씬 더 많은 유틸리티를 제공하지만, Riverpod은 이 예외를 던질 수 없습니다. + +### 상태를 폐기(Disposing)하는 것은 어렵습니다 + +`InheritedWidget`은 [Comsumer가 더이상 Listen하지 않을때 반응(React)할 수 없습니다]. +이로 인해 더 이상 사용되지 않을때 Provider의 상태를 자동으로 파기(Dispose)할 수 없습니다. +프로파이더를 사용하면 우리는 범위 제한(Scoping) provider에 의존하여 상태가 더 이상 사용되지 않을 때 상태를 파기(Dispose)해야 합니다. +하지만 페이지 간에 상태가 공유되는 경우 까다로워지기 때문에 이것이 쉽지 않습니다. + +Riverpod은 [autodispose]와 [keepAlive]와 같은 쉽게 이해할 수 있는 API로 이 문제를 해결합니다. +이 두 API는 유연하고 창의적인 캐싱 전략(예: 시간 기반 캐싱)을 가능하게 합니다: + + + +안타깝께도 원시 `InheritedWidget`으로는 이를 구현할 방법이 없으므로 Provider로 구현할 수 없습니다. + +### 신뢰할 수 있는 매개변수화 매커니즘 부족 +Riverpod은 사용자가 [.family 수정자(modifier)]를 사용하여 "매개변수화된(parameterized)" 공급자를 선언할 수 있습니다. +실제로 `.family`는 Riverpod의 가장 강력한 기능 중 하나이며, Riverpod의 혁신의 핵심입니다. +예를 들어, 엄청한 [로직의 단순화]을 가능하게 합니다. + +Provider를 사용해 비슷한 기능을 구현하려면, 이러한 매개변수에 대한 사용 편의성*과* 유형 안전성을 포기해야 합니다. + +또한, [이 두 기능은 서로 밀접하게 연관되어 있기 때문]에 Provider로 유사한 '.autoDispose' 메커니즘을 구현할 수 없다는 것은 본질적으로 '.family'의 동등한 구현을 막는 것입니다. + +마지막으로, 앞에서 살펴본 것처럼 위젯이 `InheritedWidget`을 수신(listen)하기 위해 *절대로* 멈추지 않는다는 것을 알 수 있습니다. +이는 일부 provider 상태가 "동적으로 마운트(dynamically mounted)"된 경우, 예를 들어 빌드에 매개변수를 사용하여 provider를 빌드할 때 심각한 메모리 누수가 발생한다는 것을 의미합니다, 이것이 바로 '.family'가 하는 일입니다. +따라서 현재로서는 Provider에 해당하는 `.family`를 얻는 것은 근본적으로 불가능합니다. + +### 지루한 테스트 +테스트를 작성하려면 각 테스트 내에서 providers를 *다시 정의해야만* 합니다. + +Riverpod을 사용하면 기본적으로 테스트 내부에서 providers를 사용할 수 있습니다. +또한, Riverpod은 providers를 모킹(mocking)할 때 중요한 "재정의(overriding)" 유틸리티 모음을 편리하게 제공합니다. + +위의 결합된 상태 스니펫을 테스트하는 것은 다음과 같이 간단합니다: + + + +테스트에 대한 자세한 내용은 [테스팅]을 참조하세요. + + +### 부수 기능 트리거(Triggering side effects)는 간단하지 않습니다. + +`InheritedWidget`에는 `onChange`콜백이 없으므로, provider는 콜백을 가질 수 없습니다. +리는 snackbars, modals 등과 같은 네비게이션에 문제가 있습니다. + +대신 Riverpod은 간단한 `ref.listen`을 제공합니다. 이는 [Flutter와 잘 통합]됩니다. + + + +## Riverpod을 향해 + +개념적으로 Riverpod과 Provider는 상당히 유사합니다. +두 패키지 모두 비슷한 역할을 수행합니다. 둘 다 시도합니다: + +- 일부 상태 저장 객체를 캐시하고 폐기합니다; +- 테스트 중에 해당 객체를 모킹하는 방법을 제공합니다; +- 위젯이 이러한 객체를 간단한 방법으로 수신할 수 있는 방법을 제공합니다. + +Riverpod을 Provider가 몇 년 동안 계속 발전했다면 어땠을지로 생각해 볼 수 있습니다. + +### 왜 별도의 패키지인가요? + +원래는 앞서 언급한 문제를 해결하기 위한 방법으로 'Provider'의 주요 버전이 출시될 예정이었습니다. +그러나 새로운 `ConsumerWidget` API로 인해 "너무 많은 것을 깨뜨리고" 심지어 논란의 여지가 있었기 때문에 이를 포기하기로 결정했습니다. +Provider는 여전히 가장 많이 사용되는 Flutter 패키지 중 하나이기 때문에 별도의 패키지를 만들기로 결정했고, 그렇게 해서 Riverpod이 탄생했습니다. + +별도의 패키지 생성 활성화: + - 두 가지 접근 방식을 *동시에* 임시로 사용할 수 있도록 하여 원하는 사람은 누구나 쉽게 마이그레이션할 수 있습니다; + - 원칙적으로 Riverpod이 마음에 들지 않거나 아직 신뢰할 수 없다고 판단되는 경우 Provider를 계속 사용할 수 있도록 허용; + - Provider의 다양한 기술적 한계에 대한 생산적인 솔루션을 찾기 위해 Riverpod이 실험할 수 있도록 합니다. + +실제로 Riverpod은 Provider의 정신적 후계자 역할을 하도록 설계되었습니다. 따라서 'Riverpod'라는 이름은 'Riverpod'의 아나그램입니다. + +### 획기적인 변화 +Riverpod의 유일한 단점은 작동하려면 위젯 유형을 변경해야 한다는 것입니다: + +- Riverpod을 사용하면 `StatelessWidget` 대신 `ConsumerWidget`을 확장(extend)해야 합니다. +- Riverpod을 사용하면 `StatefulWidget` 대신 `ConsumerStatefulWidget`을 확장(extend)해야 합니다. + +그러나 이러한 불편함은 큰 틀에서 보면 상당히 사소한 것입니다. 그리고 언젠가는 이 요구 사항이 사라질 수도 있습니다. + +### 적합한 라이브러리 선택 +아마 스스로에게 물어보셨을 것입니다: +*"그렇다면 Provider 사용자로서 Provider를 사용해야 하나요, 아니면 Riverpod을 사용해야 하나요?"*. + +저희는 이 질문에 명확하게 답해드리고자 합니다: + + 아마도 Riverpod을 사용해야 할 것입니다. + +Riverpod이 전반적으로 더 잘 설계되어 있으며 로직을 대폭 간소화할 수 있습니다. + + +[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider +[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[autodispose]: /docs/concepts/modifiers/auto_dispose +[해결방법]: https://pub.dev/packages/provider#can-i-obtain-two-different-providers-using-the-same-type +[.family 수정자(modifier)]: /docs/concepts/modifiers/family +[keepAlive]: /docs/concepts/modifiers/auto_dispose#refkeepalive +[이 두 기능은 서로 밀접하게 연관되어 있기 때문]: /docs/concepts/modifiers/family#prefer-using-autodispose-when-the-parameter-is-not-constant +[로직의 단순화]: /docs/concepts/modifiers/family#usage +[we have to]: https://github.com/flutter/flutter/issues/128432 +[it turns out]: https://github.com/flutter/flutter/issues/106549 +[Comsumer가 더이상 Listen하지 않을때 반응(React)할 수 없습니다]: https://github.com/flutter/flutter/issues/106546 +[테스팅]: /docs/cookbooks/testing +[Flutter와 잘 통합]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx new file mode 100644 index 000000000..43ec56b51 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./override.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart new file mode 100644 index 000000000..860020903 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart @@ -0,0 +1,16 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../combine/combine.dart'; + +/* SNIPPET START */ + +void main() { + test('it doubles the value correctly', () async { + final container = ProviderContainer( + overrides: [numberProvider.overrideWith((ref) => 9)], + ); + final doubled = container.read(doubledProvider); + expect(doubled, 9 * 2); + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart new file mode 100644 index 000000000..860020903 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart @@ -0,0 +1,16 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../combine/combine.dart'; + +/* SNIPPET START */ + +void main() { + test('it doubles the value correctly', () async { + final container = ProviderContainer( + overrides: [numberProvider.overrideWith((ref) => 9)], + ); + final doubled = container.read(doubledProvider); + expect(doubled, 9 * 2); + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx new file mode 100644 index 000000000..8569e8316 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./same_type.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart new file mode 100644 index 000000000..1a2456978 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart @@ -0,0 +1,15 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod/riverpod.dart'; + +import '../../helpers/item.dart'; + +/* SNIPPET START */ + +final itemsProvider = Provider.autoDispose( + (ref) => [], // ... +); + +final evenItemsProvider = Provider.autoDispose((ref) { + final items = ref.watch(itemsProvider); + return [...items.whereIndexed((index, element) => index.isEven)]; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart new file mode 100644 index 000000000..94a4ab086 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart @@ -0,0 +1,19 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; + +part 'same_type.g.dart'; + +/* SNIPPET START */ + +@riverpod +List items(ItemsRef ref) { + return []; // ... +} + +@riverpod +List evenItems(EvenItemsRef ref) { + final items = ref.watch(itemsProvider); + return [...items.whereIndexed((index, element) => index.isEven)]; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart new file mode 100644 index 000000000..510d91a68 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart @@ -0,0 +1,133 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'same_type.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ItemsRef = Ref>; + +@ProviderFor(items) +const itemsProvider = ItemsProvider._(); + +final class ItemsProvider + extends $FunctionalProvider, List, ItemsRef> + with $Provider, ItemsRef> { + const ItemsProvider._( + {List Function( + ItemsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'itemsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + ItemsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$itemsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ItemsProvider $copyWithCreate( + List Function( + ItemsRef ref, + ) create, + ) { + return ItemsProvider._(create: create); + } + + @override + List create(ItemsRef ref) { + final _$cb = _createCb ?? items; + return _$cb(ref); + } +} + +String _$itemsHash() => r'f0a8fa6874f4868db9ead31e82c75d976f9d2033'; + +typedef EvenItemsRef = Ref>; + +@ProviderFor(evenItems) +const evenItemsProvider = EvenItemsProvider._(); + +final class EvenItemsProvider + extends $FunctionalProvider, List, EvenItemsRef> + with $Provider, EvenItemsRef> { + const EvenItemsProvider._( + {List Function( + EvenItemsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'evenItemsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + EvenItemsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$evenItemsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + EvenItemsProvider $copyWithCreate( + List Function( + EvenItemsRef ref, + ) create, + ) { + return EvenItemsProvider._(create: create); + } + + @override + List create(EvenItemsRef ref) { + final _$cb = _createCb ?? evenItems; + return _$cb(ref); + } +} + +String _$evenItemsHash() => r'82b4525e91604745f2b4664531b32d4aff5717d4'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx new file mode 100644 index 000000000..f4797a94f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./side_effects.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart new file mode 100644 index 000000000..61f016870 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart @@ -0,0 +1,24 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../auto_dispose/auto_dispose.dart'; + +/* SNIPPET START */ + +class DiceRollWidget extends ConsumerWidget { + const DiceRollWidget({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(diceRollProvider, (previous, next) { + ScaffoldMessenger.of(context).showSnackBar( + SnackBar(content: Text('Dice roll! We got: $next')), + ); + }); + return TextButton.icon( + onPressed: () => ref.invalidate(diceRollProvider), + icon: const Icon(Icons.casino), + label: const Text('Roll a dice'), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart new file mode 100644 index 000000000..61f016870 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart @@ -0,0 +1,24 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../auto_dispose/auto_dispose.dart'; + +/* SNIPPET START */ + +class DiceRollWidget extends ConsumerWidget { + const DiceRollWidget({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(diceRollProvider, (previous, next) { + ScaffoldMessenger.of(context).showSnackBar( + SnackBar(content: Text('Dice roll! We got: $next')), + ); + }); + return TextButton.icon( + onPressed: () => ref.invalidate(diceRollProvider), + icon: const Icon(Icons.casino), + label: const Text('Roll a dice'), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx new file mode 100644 index 000000000..16380ac37 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx @@ -0,0 +1,419 @@ +--- +title: Provider vs Riverpod +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import family from "./family"; +import { + trimSnippet, + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; + + +이 문서에서는 Provider와 Riverpod의 차이점과 유사점을 요약하여 설명합니다. + +:::info +한글에는 영어 대/소문자가 없어서 "Provider"와 "provider"를 "프로바이더", "공급자"등으로 번역시 구분할 수 없습니다. +이 문서에서는 pkg:Provider를 "Provider"로 표기하고, +pkg:Provider나 pkg:Riverpod에서 제공되는 provider들을 "provider"로 표기합니다. +::: + +## 공급자(Provider) 정의하기 + +두 패키지의 가장 큰 차이점은 "providers"를 정의하는 방식입니다. + +[Provider]를 사용하면 providers는 위젯이므로 위젯 트리 안에 배치됩니다, +일반적으로 `MultiProvider` 안에 배치됩니다: + +```dart +class Counter extends ChangeNotifier { + ... +} + +void main() { + runApp( + MultiProvider( + providers: [ + ChangeNotifierProvider(create: (context) => Counter()), + ], + child: MyApp(), + ) + ); +} +``` + +Riverpod에서 providers는 위젯이 **아닙니다**. 대신 일반 Dart 객체입니다. +마찬가지로 providers는 위젯 트리 외부에서 정의되며, 대신 전역 최종(global final) 변수로 선언됩니다. + +또한 Riverpod이 작동하려면 전체 애플리케이션 위에 `ProviderScope` 위젯을 추가해야 합니다. +따라서 Riverpod을 사용하는 것은 Provider 예시와 동일합니다: + +```dart +// Provider는 이제 최상위 변수 +final counterProvider = ChangeNotifierProvider((ref) => Counter()); + +void main() { + runApp( + // 이 위젯은 전체 프로젝트에서 Riverpod을 사용할 수 있게 합니다 + ProviderScope( + child: MyApp(), + ), + ); +} +``` + +provider 정의가 단순히 몇 줄 위로 올라간 것을 주목하세요. + +:::info +Riverpod providers는 일반 다트 객체이므로 Flutter 없이 Riverpod을 사용할 수 있습니다. +예를 들어, 명령줄 애플리케이션을 작성하는 데 Riverpod을 사용할 수 있습니다. +::: + +## providers 읽기: BuildContext + +Provider에서 providers를 읽는 한 가지 방법은 위젯의 'BuildContext'를 사용하는 것입니다. + +예를 들어, provider가 다음과 같이 정의된 경우: + +```dart +Provider(...); +``` + +그런 다음 Provider를 사용하여 읽는 것은 다음과 같습니다: + +```dart +class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + Model model = context.watch(); + + } +} +``` + +이것은 Riverpod에서 동일합니다. Riverpod의 스니펫은 다음과 같습니다: + +```dart +final modelProvider = Provider(...); + +class Example extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + Model model = ref.watch(modelProvider); + + } +} +``` + +방법을 확인하세요: + +- Riverpod의 스니펫은 `StatelessWidget` 대신 `ConsumerWidget`을 확장(extend)합니다. + 이 다른 위젯 유형은 `build` 함수에 하나의 추가 매개변수인 `WidgetRef`를 추가합니다. + +- Riverpod에서는 `BuildContext.watch` 대신 `ConsumerWidget`에서 가져온 `WidgetRef`를 사용하여 `WidgetRef.watch`를 수행합니다. + +- Riverpod은 제네릭 타입에 의존하지 않습니다. 대신 공급자 정의(provider definition)를 통해 생성된 변수(variable)에 의존합니다. + +문구가 얼마나 유사한지도 주목하세요. Provider와 Riverpod은 모두 "watch" 키워드를 사용하여 "이 위젯은 값이 변경되면 다시 빌드되어야 합니다"라고 설명합니다. + +:::info +Riverpod은 provider 읽기에 대해 Provider와 동일한 용어를 사용합니다. + +- `BuildContext.watch` -> `WidgetRef.watch` +- `BuildContext.read` -> `WidgetRef.read` +- `BuildContext.select` -> `WidgetRef.watch(myProvider.select)` + +`context.watch`와 `context.read`에 대한 규칙은 Riverpod에도 적용됩니다: +`build` 메서드 내부에서는 "watch"를 사용합니다. +클릭 핸들러 및 기타 이벤트 내부에서는 "read"를 사용합니다. +값을 필터링하고 다시 빌드해야 하는 경우 "select"를 사용합니다. +::: + +## providers 읽기: Consumer + +Provider는 선택적으로 `Consumer`라는 위젯(및 `Consumer2`와 같은 변형)을 제공합니다. + +`Consumer`는 위젯 트리 보다 세분화하여 재빌드할 수 있으므로, 성능최적화에 도음이 됩니다. - 상태가 변경될 때 관련 위젯만 업데이트합니다: + +따라서 provider가 다음과 같이 정의된 경우: + +```dart +Provider(...); +``` + +Provider는 `Consumer`를 사용하여 provider를 읽을 수 있게합니다: + +```dart + +Provider allows reading that provider using `Consumer` with: + +```dart +Consumer( + builder: (BuildContext context, Model model, Widget? child) { + + } +) +``` + +Riverpod도 같은 원리를 가지고 있습니다. Riverpod에도 똑같은 용도의 'Consumer'라는 위젯이 있습니다. + +provider를 다음과 같이 정의했다면: + +```dart +final modelProvider = Provider(...); +``` + +`Consumer`를 사용하여 provider를 읽을 수 있습니다: + +```dart +Consumer( + builder: (BuildContext context, WidgetRef ref, Widget? child) { + Model model = ref.watch(modelProvider); + + } +) +``` + +`Consumer`가 어떻게 `WidgetRef` 객체를 제공하는지 주목해주세요. 이것은 이전 파트에서 `ConsumerWidget`과 관련된 것과 동일한 객체입니다. + +### Riverpod에는 `ConsumerN`에 해당하는 객체가 없음 + +Riverpod에서는 pkg:Provider의 `Consumer2`, `Consumer3` 등이 필요하지 않고, 누락된 것을 확인할 수 있습니다. (not needed nor missed) + +Riverpod을 사용하면, 여러 provider로 부터 값을 읽으려면 다음과 같이 여러 개의 `ref.watch` 문을 작성하면 됩니다.: + +```dart +Consumer( + builder: (context, ref, child) { + Model1 model = ref.watch(model1Provider); + Model2 model = ref.watch(model2Provider); + Model3 model = ref.watch(model3Provider); + // ... + } +) +``` + +위의 솔루션은 pkg:Provider의 `ConsumerN` API와 비교할 때 훨씬 덜 무겁게 느껴지고 이해하기 쉬울 것입니다. + +## providers 결합하기: ProxyProvider 와 stateless objects + +Provider를 사용할 때, providers를 결합하는 공식적인 방법은 `ProxyProvider` 위젯(또는 `ProxyProvider2`와 같은 변형)을 사용하는 것입니다. + +예를 들어 다음과 같이 정의할 수 있습니다: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +ChangeNotifierProvider(create: (context) => UserIdNotifier()), +``` + +이제 두가지 옵션이 있습니다. +`UserIdNotifier`를 결합하여 새로운 "stateless" provider(일반적으로 ==를 재정의할 수 있는 불변값)를 만들 수 있습니다. +다음과 같은: + +```dart +ProxyProvider( + update: (context, userIdNotifier, _) { + return 'The user ID of the the user is ${userIdNotifier.userId}'; + } +) +``` + +이 프로바이더는 `UserIdNotifier.userId`가 변경될 때마다 자동으로 새 `String`을 반환합니다. + +Riverpod에서도 비슷한 작업을 수행할 수 있지만 구문이 다릅니다. +먼저, Riverpod에서 `UserIdNotifier`의 정의는 다음과 같습니다: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +final userIdNotifierProvider = ChangeNotifierProvider( + (ref) => UserIdNotifier(), +); +``` + +거기에서, 'userId'를 기반으로 'String'을 생성하면 됩니다: + +```dart +final labelProvider = Provider((ref) { + UserIdNotifier userIdNotifier = ref.watch(userIdNotifierProvider); + return 'The user ID of the the user is ${userIdNotifier.userId}'; +}); +``` + +`ref.watch(userIdNotifierProvider)`를 수행하는 줄을 주목하세요. + +이 코드 줄은 Riverpod에게 `userIdNotifierProvider`의 내용을 가져오고, 그 값이 변경될 때마다 `labelProvider`도 다시 계산하도록 지시합니다. +따라서 `labelProvider`가 내보내는 `String`은 `userId`가 변경될 때마다 자동으로 업데이트됩니다. + +이 `ref.watch` 줄도 비슷하게 느껴질 것입니다. 이 패턴은 이전에 [위젯 내부에서 provider를 읽는 방법](#reading-providers-buildcontext)을 설명할 때 다뤘던 내용입니다. +실제로 providers는 이제 위젯과 같은 방식으로 다른 providers를 수신할 수 있습니다. + +## providers 결합하기: ProxyProvider 와 stateful objects + +providers를 결합할 때 또 다른 대안적인 사용 사례는 `ChangeNotifier` 인스턴스와 같은 상태 저장 객체를 노출하는 것입니다. + +이를 위해 `ChangeNotifierProxyProvider`(또는 `ChangeNotifierProxyProvider2`와 같은 변형)를 사용할 수 있습니다. +예를 들어 다음과 같이 정의할 수 있습니다: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +ChangeNotifierProvider(create: (context) => UserIdNotifier()), +``` + +그런 다음 `UserIdNotifier.userId`를 기반으로 하는 새로운 `ChangeNotifier`를 정의할 수 있습니다. +예를 들어 다음과 같이 할 수 있습니다: + +```dart +class UserNotifier extends ChangeNotifier { + String? _userId; + + void setUserId(String? userId) { + if (userId != _userId) { + print('The user ID changed from $_userId to $userId'); + _userId = userId; + } + } +} + +// ... + +ChangeNotifierProxyProvider( + create: (context) => UserNotifier(), + update: (context, userIdNotifier, userNotifier) { + return userNotifier! + ..setUserId(userIdNotifier.userId); + }, +); +``` + +이 새 provider는 (재구성되지 않는) `UserNotifier`의 단일 인스턴스를 생성하고 사용자 ID가 변경될 때마다 문자열을 인쇄합니다. + +provider에서 동일한 작업을 수행하는 방식은 다릅니다. +먼저, Riverpod에서는 `UserIdNotifier`의 정의가 다음과 같습니다: + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +final userIdNotifierProvider = ChangeNotifierProvider( + (ref) => UserIdNotifier(), +), +``` + +이전의 `ChangeNotifierProxyProvider`에 해당하는 코드는 다음과 같습니다: + +```dart +class UserNotifier extends ChangeNotifier { + String? _userId; + + void setUserId(String? userId) { + if (userId != _userId) { + print('The user ID changed from $_userId to $userId'); + _userId = userId; + } + } +} + +// ... + +final userNotifierProvider = ChangeNotifierProvider((ref) { + final userNotifier = UserNotifier(); + ref.listen( + userIdNotifierProvider, + (previous, next) { + if (previous?.userId != next.userId) { + userNotifier.setUserId(next.userId); + } + }, + ); + + return userNotifier; +}); +``` + +이 스니펫의 핵심은 `ref.listen` 줄입니다. +이 `ref.listen` 함수는 provider를 수신 대기하고, provider가 변경될 때마다 함수를 실행하는 유틸리티입니다. + +해당 함수의 `previous` 및 `next` 매개 변수는 공급자가 변경되기 전의 마지막 값과 변경된 후의 새 값에 해당합니다. + +## 범위 지정 공급자(Scoping Providers) vs `.family` + `.autoDispose` +pkg:Provider에서 범위 지정은 두 가지 용도로 사용되었습니다: + - 페이지 이탈 시 상태 소멸(destroying state) + - 페이지당 커스텀 상태 보유 + +상태를 파괴(Destroy)하기 위해 스코핑(Scoping)을 사용하는 것은 이상적이지 않습니다. +문제는 범위 지정(Scoping)이 대규모 애플리케이션에서 제대로 작동하지 않는다는 것입니다. +예를 들어, 상태는 한 페이지에서 생성되지만 탐색 후 다른 페이지에서 나중에 소멸되는 경우가 많습니다. +이렇게 하면 여러 페이지에서 여러 개의 캐시를 활성화할 수 없습니다. + +마찬가지로 모달이나 다단계 양식과 같이 해당 상태를 위젯 트리의 다른 부분과 공유해야 하는 경우 '페이지별 사용자 지정 상태(custom state per page)' 접근 방식은 처리하기 어려워집니다. + +Riverpod은 다른 접근 방식을 취합니다: 첫째, 범위 지정(Scoping) providers는 권장하지 않으며, 둘째, `.family` 및 `.autoDispose`는 이를 완전히 대체하는 솔루션 입니다. + +Riverpod 내에서 '.autoDispose'로 표시된 공급자는 더 이상 사용되지 않을 때 자동으로 상태를 소멸(destroy)합니다. +공급자를 제거하는 마지막 위젯이 마운트 해제되면 Riverpod은 이를 감지하고 공급자를 파기(destroy)합니다. +이 동작을 테스트하려면 제공자에서 이 두 가지 수명 주기 메서드를 사용해 보세요: + + +```dart +ref.onCancel((){ + print("더 이상 어떤 것도 나를 Listen하지 않음!"); +}); +ref.onDispose((){ + print("`.autoDispose`로 정의된 경우, 방금 폐기되었음!"); +}); +``` + +이는 본질적으로 "상태 소멸(destroying state)" 문제를 해결합니다. + +또한 Provider를 `.family`로 표시할 수 있습니다. (동시에 `.autoDispose`로 표시할 수도 있습니다.) +이렇게 하면 providers에게 매개변수를 전달하여 내부적으로 여러 providers를 생성하고 추적할 수 있습니다. +즉, 매개변수를 전달할 때 *고유한 매개변수당 고유한 상태가 생성됩니다*. + + + +이렇게 하면 "페이지별 맞춤 상태(custom state per page)" 문제가 해결됩니다. +사실, 또 다른 이점이 있습니다. 이러한 상태는 더 이상 특정 페이지에 묶여 있지 않습니다. +대신 다른 페이지에서 동일한 상태에 액세스하려고 시도하는 경우 해당 페이지에서 매개변수를 재사용하기만 하면 액세스할 수 있습니다. + +여러 가지 면에서 providers에게 매개변수를 전달하는 것은 맵 키와 동일합니다. +키가 같으면 얻어지는 값도 동일합니다. 키가 다르면 다른 상태가 얻어집니다. + +[provider]: https://pub.dev/packages/provider +[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider +[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[autodispose]: /docs/concepts/modifiers/auto_dispose +[workaround]: https://pub.dev/packages/provider#can-i-obtain-two-different-providers-using-the-same-type +[.family modifier]: /docs/concepts/modifiers/family +[keepAlive]: /docs/concepts/modifiers/auto_dispose#refkeepalive +[as these two features go hand-in-hand]: /docs/concepts/modifiers/family#prefer-using-autodispose-when-the-parameter-is-not-constant +[simplification of logic]: /docs/concepts/modifiers/family#usage +[we have to]: https://github.com/flutter/flutter/issues/128432 +[it turns out]: https://github.com/flutter/flutter/issues/106549 +[*can't* react when a consumer stops listening to them]: https://github.com/flutter/flutter/issues/106546 +[integrates well with Flutter]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[ChangeNotifierProvider]: /docs/providers/change_notifier_provider +[Code generation]: /docs/about_code_generation +[AsyncNotifiers]: /docs/providers/notifier_provider +[combining Providers]: /docs/concepts/combining_providers +[global final variable]: /docs/concepts/providers#creating-a-provider diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx new file mode 100644 index 000000000..67577692e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx @@ -0,0 +1,190 @@ +--- +title: 빠른 시작 +--- + +이 섹션은 [Provider] 패키지에 익숙한 분들 중 Riverpod에 대해 자세히 알고 싶은 분들을 위해 만들어졌습니다. + +무엇보다도 먼저 짧은 [시작하기] 글을 읽고 작은 [sandbox] 예제를 통해 Riverpod의 기능을 테스트해 보세요. +그 결과 마음에 든다면 마이그레이션을 확실히 고려해야 합니다. + +실제로 Provider에서 Riverpod로 마이그레이션하는 것은 매우 간단합니다. + +마이그레이션은 기본적으로 *증분* 방식으로 수행할 수 있는 몇 가지 단계로 구성됩니다. + +## `ChangeNotifierProvider`로 시작하기 + +Riverpod로 전환하는 동안 'ChangeNotifier'를 계속 사용하고, 최신의 멋진 기능을 최대한 빨리 사용하지 않는 것도 상관없습니다. + +실제로 다음과 같이 시작해도 좋습니다: + +```dart +// 아래와 같은 코드를 가지고 있다면 +class MyNotifier extends ChangeNotifier { + int state = 0; + + void increment() { + state++; + notifyListeners(); + } +} + +// ... 이것만 추가하세요! +final myNotifierProvider = ChangeNotifierProvider((ref) { + return MyNotifier(); +}); +``` + +보시다시피 Riverpod은 pkg:Provider에서 마이그레이션을 지원하기 위해 제공되는 [ChangeNotifierProvider] 클래스를 노출합니다. + +이 Provider는 새 코드를 작성할 때 권장되지 않으며, Riverpod을 사용하는 가장 좋은 방법은 아니지만 +마이그레이션을 시작하는 부드럽고 매우 쉬운 방법이라는 점에 유의하세요. + +:::tip +'ChangeNotifier'를 더 최신의 [Riverpod의 provider들]로 '즉시' 변경하려고 서두를 필요는 없습니다. +일부는 약간의 패러다임 전환이 필요하기 때문에 처음에는 어려울 수 있습니다. + +먼저 Riverpod에 익숙해지는 것이 중요하므로 천천히 하세요; +pkg:provider의 *거의* 모든 Provider가 pkg:riverpod에 엄격하게 대응한다는 것을 금방 알 수 있습니다. +::: + +## *잎사귀(leaves)*부터 시작 + +다른 것에 의존하지 않는 Provider, 즉 종속성 트리의 *잎사귀(leaves)*부터 시작하세요. +모든 잎사귀를 마이그레이션한 후에는 잎사귀에 의존하는 Provider로 이동할 수 있습니다. + +다시 말해, 처음부터 `ProxyProvider`를 마이그레이션하지 말고, 모든 종속성을 마이그레이션한 후에 처리하세요. + +이렇게 하면 마이그레이션 프로세스가 향상되고 간소화되는 동시에 오류를 최소화/추적할 수 있습니다. + + +## Riverpod과 Provider가 공존할 수 있습니다. +*Provider와 Riverpod을 동시에 사용할 수 있다는 것을 기억하세요.* + +실제로 import alias를 사용하면 두 API를 모두 사용할 수 있습니다. +이는 가독성 면에서도 좋으며 모호한 API 사용을 제거합니다. + +이렇게 하려면, 코드베이스에서 각 Provider 가져오기에 대해 가져오기 별칭(alias)을 사용하는 것을 고려해 보세요. + +:::info +가져오기 별칭을 효과적으로 구현하는 방법에 대한 전체 가이드가 곧 제공될 예정입니다. +::: + +## `Consumer`를 바로 사용할 *필요*는 없습니다 + +명심해야 할 것은 [Riverpod의 `Consumer` API]를 `즉시` 사용할 필요는 없다는 점입니다. +마이그레이션을 막 시작한 경우, [위에서 언급한 대로] `ChangeNotifierProvider`로 시작하는 것이 좋습니다. + +위에서 정의한 `myNotifierProvider`를 고려해 보세요. + +내부 코드가 pkg:Provider의 API에 의존하고 있을 가능성이 높으므로, 다음을 사용하여 pkg:Riverpod로 `ChangeNotifier`를 사용하기 시작하세요. +```dart +MultiProvider( + providers: [ + ChangeNotifierProvider.value(value: ref.watch(myNotifierProvider.notifier)), + ] +) +``` +이렇게 하면 처음에 루트 위젯만 `ConsumerWidget`으로 변환하면 됩니다. +이렇게 하면 pkg:Riverpod로 마이그레이션하는 것이 훨씬 쉬워집니다. + +## 한번에 하나씩 Provider를 마이그레이션하세요 + +기존 앱이 있는 경우, 모든 Provider를 한꺼번에 마이그레이션하지 마세요! + +장기적으로 모든 애플리케이션을 Riverpod로 이동하려고 노력해야 하지만, **자신을 지치게(burn) 하지 마세요**. +한번에 하나의 Provider씩 처리하세요. + +위의 예를 들어보겠습니다. `myNotifierProvider`를 Riverpod으로 **완전히** 마이그레이션한다는 것은 다음과 같이 작성하는 것을 의미합니다: + +```dart +class MyNotifier extends Notifier { + @override + int build() => 0; + + void increment() => state++; +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); +``` + +.. 그리고 _또한_ 해당 공급자가 소비되는 방식을 변경해야 합니다, +예를 들어 이 공급자에 대한 각 `context.watch`를 `ref.watch`로 변경해야 합니다. + +이 작업은 시간이 다소 걸리고 오류가 발생할 수 있으므로, 한 번에 끝내려고 서두르지 마세요. + +## `ProxyProvider` 마이그레이션 +pkg:Provider 내에서 `ProxyProvider`는 다른 프로바이더의 값을 결합하는 데 사용됩니다; +빌드는 다른 프로바이더의 값에 따라 반응적(reactively)으로 달라집니다. + +Riverpod에서는 대신 프로바이더는 [기본적으로 컴포저블이 가능]하므로, +`ProxyProvider`를 마이그레이션할 때 한 프로바이더에서 다른 프로바이더로 직접 종속성을 선언하려면 `ref.watch`를 작성하기만 하면 됩니다. + +오히려 Riverpod에서 값을 결합하는 것이 더 간단하고 직관적으로 느껴질 것이므로 마이그레이션을 통해 코드를 크게 간소화할 수 있습니다. + +또한 두 개 이상의 공급자를 결합할 때, 복잡한 과정을 거칠 필요 없이 `ref.watch`를 하나 더 추가하기만 하면 바로 사용할 수 있습니다. + +## 빠른(Eager) 초기화 + +Riverpod의 프로바이더는 최종 전역(global) 변수이기 때문에 [기본적으로 지연(Lazy)] 초기화 됩니다. + +시작 시 일부 워밍업 데이터나 유용한 서비스를 초기화해야 하는 경우, 가장 좋은 방법은 `MultiProvider`를 넣었던 위치에서 프로바이더를 먼저 읽는 것입니다. + +즉, Riverpod은 강제로 초기화할 수 없기 때문에, 시작 단계에서 읽고 캐시하여, 나머지 애플리케이션 내에서 필요할 때 바로 사용할 수 있도록(warm and ready) 할 수 있습니다. + +pkg:Riverpod의 Provider들의 초기화에 대한 전체 가이드는 [여기에서 확인할 수 있습니다]. + +## 코드 생성 +Riverpod을 *미래에 대비한* 방식으로 사용하려면 [코드 생성]을 권장합니다. +참고로, 메타프로그래밍(metaprogramming)이 보편화되면, 코드 생성 기능이 Riverpod의 기본값이 될 가능성이 높습니다. + +안타깝게도 `@riverpod`는 `ChangeNotifierProvider`에 대한 코드를 생성할 수 없습니다. +이 문제를 해결하기 위해 다음 유틸리티 확장 메소드(extesion method)를 사용할 수 있습니다: + +```dart +extension ChangeNotifierWithCodeGenExtension on Ref { + T listenAndDisposeChangeNotifier(T notifier) { + notifier.addListener(notifyListeners); + onDispose(() => notifier.removeListener(notifyListeners)); + onDispose(notifier.dispose); + return notifier; + } +} +``` + +그런 다음 다음 코드 생성 구문을 사용하여 `ChangeNotifier`를 노출할 수 있습니다: +```dart +// ignore_for_file: unsupported_provider_value +@riverpod +MyNotifier example(ExampleRef ref) { + return ref.listenAndDisposeChangeNotifier(MyNotifier()); +} +``` + +"기본" 마이그레이션이 완료되면 `ChangeNotifier`를 `Notifier`로 변경할 수 있으므로 임시 확장이 필요하지 않습니다. +앞의 사례를 예로 들면, "완전히 마이그레이션된" `Notifier`가 됩니다: + +```dart +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() => 0; + + void increment() => state++; +} +``` + +이 작업이 완료되고 코드베이스에 더 이상 `ChangeNotifierProvider`가 없다는 것이 확실해지면 임시 확장자를 완전히 제거할 수 있습니다. + +코드 생성은 권장 사항이지만 *필수 사항*은 아니라는 점을 명심하세요. +마이그레이션에 대해 점진적으로 생각하는 것이 좋습니다: +한 번에 코드 생성 구문으로 *전환하면서* 마이그레이션을 구현하는 것이 과하다고 생각되면 점진적으로 마이그레이션을 고려하는 것이 *좋습니다*. + +이 가이드에 따라 나중에 한 단계 더 나아가 코드생성으로 마이그레이션할 수 있습니다. + +[코드 생성]: /docs/concepts/about_code_generation +[Riverpod의 provider들]: /docs/providers/notifier_provider +[기본적으로 컴포저블이 가능]: /docs/from_provider/motivation#combining-providers-is-hard-and-error-prone +[위에서 언급한 대로]: /docs/from_provider/quickstart#start-with-changenotifierprovider +[Riverpod의 `Consumer` API]: /docs/concepts/reading +[기본적으로 지연(Lazy)]: /docs/concepts/provider_lifecycles +[여기에서 확인할 수 있습니다]: /docs/essentials/eager_initialization diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started.mdx deleted file mode 100644 index 1542ee01a..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: 시작하기 -version: 1 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; - -import pubspec from "../../../../i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec"; -import dartHelloWorld from "../../../../i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world"; -import helloWorld from "../../../../i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world"; -import dartPubspec from "../../../../i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec"; - -import { - trimSnippet, - AutoSnippet, - When } from "../../../../src/components/CodeSnippet"; - ---- - -## Try Riverpod online - -To get a feel of Riverpod, try it online on [Dartpad](https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2). - -[Riverpod]의 내부 메커니즘에 들어가기 앞서, 우선 [Riverpod]을 설치하는 방법과 -"Hello world"를 표시하는 방법부터 함께 시작해봅시다. - -## 어떤 패키지를 설치해야하나요? - -[Riverpod]은 여러 종류의 패키지가 있습니다. 각각 다른 사용 목적을 가지고 있으며 개별마다 상이한 특징을 가지고 있습니다. -어떤 [Riverpod] 패키지를 설치할지는 만드는 앱의 형태에 따라 다릅니다. - -다음 아래의 표를 참조하여 사용할 패키지를 결정할 수 있습니다. - -| 앱의 형태 | 패키지명 | 설정 | -| ------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| Flutter + [flutter_hooks] | [hooks_riverpod] | [flutter_hooks] 과 [Riverpod]을 함께 병용한 패키지 | -| Flutter | [flutter_riverpod] | Flutter 앱에 [Riverpod] 을 사용할 경우의 기본 패키지 | -| Dart(Flutter 사용안함） | [riverpod](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod) | Flutter 에 관련된 모든 클래스가 완전제거된 [Riverpod] 패키지 | - -## 패키지 설치 방법 - -설치할 패키지의 종류가 결정되었다면, `pubspec.yaml`에 아래의 방법으로 패키지를 추가합니다. - - - - - - -패키지 추가 후 `flutter pub get` 를 실행해주세요. - - - 마지막으로, {" "}를 실행하여 코드를 생성합니다. - flutter pub run build_runner watch - - - - - - - -패키지 추가 후 `dart pub get`를 실행해주세요. - - - 마지막으로, {" "}를 실행하여 코드를 생성합니다. - flutter pub run build_runner watch - - - - - -이걸로 [Riverpod]이 앱에 추가되었습니다. - -## 사용예시: Hello world - -[Riverpod]설치를 완료하였다면 이제 사용을 시작해봅시다. -아래의 예제코드를 실행하면 Hello world가 화면에 표시됩니다. - -export const foo = 42; - - - - - - -`flutter run` 명령어를 실행합니다. -디바이스 화면에 Hello world가 표시됩니다. - - - - - - -`dart lib/main.dart` 명령어를 실행합니다. -콘솔창에 Hellow world가 출력됩니다. - - - - -## 더 나아가기: Code Snippets 설치하기 - -`Flutter`를 `VS Code` 에서 사용하는 경우, 확장에서 -[Flutter Riverpod Snippets](https://marketplace.visualstudio.com/items?itemName=robert-brunhage.flutter-riverpod-snippets) -패키지를 검색하여 [Riverpod] 전용 Code Snippets을 설치하여 사용할 수 있습니다. - -`Flutter`를 `Android Studio` 또는 `IntelliJ` 에서 사용하는 경우, -[Flutter Riverpod Snippets](https://plugins.jetbrains.com/plugin/14641-flutter-riverpod-snippets) -를 설치하여 사용할 수 있습니다. - -![img](/img/snippets/greetingProvider.gif) - - -## 다음 단계 선택하기 - -기본 컨셉에대해 확인하기: - -- [Learn more about providers](/docs/concepts/providers) - -cookbook 따라가기: - -- [How to test providers](/docs/cookbooks/testing) - - -[riverpod]: https://github.com/rrousselgit/riverpod -[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod -[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod -[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/raw.dart deleted file mode 100644 index 9c83c5a61..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/raw.dart +++ /dev/null @@ -1,19 +0,0 @@ -// ignore_for_file: avoid_print - -/* SNIPPET START */ - -import 'package:riverpod/riverpod.dart'; - -// 우리는 값을 저장할 "provider"를 만들겁니다(여기서 값은 "Hello world"를 의미합니다). -// 프로바이더를 사용하는 것으로 값의 mock/override가 가능하게 됩니다. -final helloWorldProvider = Provider((_) => 'Hello world'); - -void main() { - // 이 객체는 프로바이더 상태를 저장하게 됩니다. - final container = ProviderContainer(); - - // "container" 덕분에, 여기서 우리의 프로바이더 값을 읽을 수 있습니다. - final value = container.read(helloWorldProvider); - - print(value); // Hello world -} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/codegen.yaml b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/codegen.yaml deleted file mode 100644 index 138dd42d7..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/codegen.yaml +++ /dev/null @@ -1,11 +0,0 @@ -name: my_app_name -environment: - sdk: ">=2.17.0 <3.0.0" - -dependencies: - riverpod: ^2.0.2 - riverpod_annotation: ^1.0.4 - -dev_dependencies: - build_runner: - riverpod_generator: ^1.0.4 \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/index.tsx deleted file mode 100644 index d0c456dcc..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/index.tsx +++ /dev/null @@ -1,9 +0,0 @@ -import raw from "!!raw-loader!./raw.yaml"; -import codegen from "!!raw-loader!./codegen.yaml"; - -export default { - raw, - hooks: raw, - codegen, - hooksCodegen: codegen, -}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/raw.yaml b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/raw.yaml deleted file mode 100644 index f9797b9c7..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_pubspec/raw.yaml +++ /dev/null @@ -1,6 +0,0 @@ -name: my_app_name -environment: - sdk: ">=2.17.0 <3.0.0" - -dependencies: - riverpod: ^2.0.2 \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/codegen.yaml b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/codegen.yaml deleted file mode 100644 index 5b7a9b2d3..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/codegen.yaml +++ /dev/null @@ -1,14 +0,0 @@ -name: my_app_name -environment: - sdk: ">=2.17.0 <3.0.0" - flutter: ">=3.0.0" - -dependencies: - flutter: - sdk: flutter - flutter_riverpod: ^2.0.2 - riverpod_annotation: ^1.0.4 - -dev_dependencies: - build_runner: - riverpod_generator: ^1.0.4 \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks.yaml b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks.yaml deleted file mode 100644 index 5a1995205..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks.yaml +++ /dev/null @@ -1,10 +0,0 @@ -name: my_app_name -environment: - sdk: ">=2.17.0 <3.0.0" - flutter: ">=3.0.0" - -dependencies: - flutter: - sdk: flutter - flutter_hooks: ^0.18.0 - hooks_riverpod: ^2.0.2 \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks_codegen.yaml b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks_codegen.yaml deleted file mode 100644 index 807ea6729..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/hooks_codegen.yaml +++ /dev/null @@ -1,15 +0,0 @@ -name: my_app_name -environment: - sdk: ">=2.17.0 <3.0.0" - flutter: ">=3.0.0" - -dependencies: - flutter: - sdk: flutter - flutter_hooks: ^0.18.0 - hooks_riverpod: ^2.0.2 - riverpod_annotation: ^1.0.4 - -dev_dependencies: - build_runner: - riverpod_generator: ^1.0.4 \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/index.tsx deleted file mode 100644 index d7e1ee500..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/index.tsx +++ /dev/null @@ -1,11 +0,0 @@ -import raw from "!!raw-loader!./raw.yaml"; -import hooks from "!!raw-loader!./hooks.yaml"; -import codegen from "!!raw-loader!./codegen.yaml"; -import hooksCodegen from "!!raw-loader!./hooks_codegen.yaml"; - -export default { - raw, - hooks, - codegen, - hooksCodegen, -}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/raw.yaml b/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/raw.yaml deleted file mode 100644 index 605be5f5e..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/pubspec/raw.yaml +++ /dev/null @@ -1,9 +0,0 @@ -name: my_app_name -environment: - sdk: ">=2.17.0 <3.0.0" - flutter: ">=3.0.0" - -dependencies: - flutter: - sdk: flutter - flutter_riverpod: ^2.0.2 \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction.mdx deleted file mode 100644 index 4b19a3950..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction.mdx +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: 소개 ---- - ---- - -## What is Riverpod? - -Riverpod (anagram of [Provider](https://pub.dev/packages/provider)) is a reactive -caching framework for Flutter/Dart. It can automatically fetch, cache, combine and -recompute network requests, while also taking care of errors for you. - -## Motivation - -Modern applications rarely come with all the information necessary to render -their User Interface. Instead, the data is often fetched asynchronously -from a server. - -The problem is, working with asynchronous code is hard. Although Flutter comes -with some way to store state, it doesn't do much besides that. Thus, a number -of challenges remain unsolved: - -- Asynchronous requests need to be cached locally, as it would be unreasonable - to re-execute them whenever the UI refreshes. -- Since we have a cache, our cache could get out of date if we're not careful. -- We also need to handle errors and loading states - -Nailing those problems at scale can be difficult, and they are impacted by a large -amount of features, such as: - -- pull to refresh -- infinite lists / fetch as we scroll -- search as we type -- debouncing asynchronous requests -- cancelling asynchronous requests when no-longer used -- optimistic UIs -- offline mode -- ... - -These features can be tricky to implement, but are crucial for a good user experience. -Yet few packages try to tackle those problems directly, and a lot of the work -has to be done manually. - -That's where Riverpod comes in. -Riverpod tries to solve those problems, by offering a new unique -way of writing business logic, inspired by Flutter widgets. In -many ways Riverpod is comparable to widgets, but for state. - -Using this new approach, these complex features are mostly done by default. All -that's left is to focus on your UI. - -Skeptical? Here's an example. The following snippet is a simplification of the [Pub.dev](https://github.com/rrousselGit/riverpod/tree/master/examples/pub) -client application implemented using Riverpod. - -```dart -// Fetches the list of packages from pub.dev -@riverpod -Future> fetchPackages( - FetchPackagesRef ref, { - required int page, - String search = '', -}) async { - final dio = Dio(); - // Fetch an API. Here we're using package:dio, but we could use anything else. - final response = await dio.get( - 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', - ); - - // Decode the JSON response into a Dart class. - final json = response.data as List; - return json.map(Package.fromJson).toList(); -} -``` - -This snippet is all the business logic you need for a "search as we type" -+ "pull to refresh" + "infinite list", while handling error/loading states. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx new file mode 100644 index 000000000..68ba4fe88 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx @@ -0,0 +1,191 @@ +--- +title: 시작하기 +pagination_next: essentials/first_request +version: 4 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import pubspec from "./getting_started/pubspec"; +import dartHelloWorld from "./getting_started/dart_hello_world"; +import pubadd from "./getting_started/pub_add"; +import helloWorld from "./getting_started/hello_world"; +import dartPubspec from "./getting_started/dart_pubspec"; +import dartPubadd from "./getting_started/dart_pub_add"; +import { + AutoSnippet, + When, +} from "../../../../../src/components/CodeSnippet"; +import { Link } from "../../../../../src/components/Link"; + +## Riverpod 온라인으로 경험해보기 + +Riverpod을 경험해보려면 [Dartpad](https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2)나 [Zapp](https://zapp.run/new)에서 온라인으로 시도해보세요: + + + +## 패키지 설치하기 + +설치하려는 패키지가 결정되면, 아래와 같이 한 줄로 앱에 종속성을 추가합니다: + + + + + + + + + + + + + + + + +대안으로, `pubspec.yaml`에 종속성을 직접 추가할 수도 있습니다: + + + + + + +그리고, `flutter pub get`으로 패키지를 설치합니다. + + + 이제 코드 생성기를 실행할 수 있습니다.{" "} + flutter run build_runner watch. + + + + + + + +그리고, `dart pub get`으로 패키지를 설치합니다. + + + 이제 코드 생성기를 실행할 수 있습니다.{" "} + dart pub run build_runner watch. + + + + + +이게 다입니다. 당신의 앱에 [Riverpod]을 추가했습니다! + +## riverpod_lint/custom_lint 활성화하기 + +Riverpod은 선택사항으로 [riverpod_lint] 패키지를 제공합니다. +이 패키지는 더 좋은 코드를 작성하는데 도움이 되는 린트 규칙과 사용자 정의 리팩토링 옵션을 제공합니다. + +이전 단계를 따라왔다면 이 패키지는 이미 설치되어 있을 것입니다. +하지만 활성화하기 위해서는 별도의 단계가 필요합니다. + +[riverpod_lint]를 활성화하려면, 당신의 `pubspec.yaml`옆에 `analysis_options.yaml`을 추가하고 다음을 포함해야 합니다: + + + {`analyzer: + plugins: + - custom_lint`} + + +이제 코드베이스에서 Riverpod을 사용할 때 당신이 실수한 경우, IDE에서 경고가 보이게 됩니다. + +전체 경고와 리팩토링 목록을 보려면 [riverpod_lint] 페이지를 참고하세요. + +:::note +이 경고는 `dart analyze` 명령에서는 표시되지 않습니다. +CI/터미널에서 이 경고를 확인하려면 다음을 실행하세요: + +```sh +dart run custom_lint +``` + +::: + +## 사용 예시: Hello world + +이제 [Riverpod]를 설치했으니 사용해볼 수 있습니다. + +다음 스니펫은 새로운 종속성을 사용하여 "Hello world"를 만드는 방법을 보여줍니다: + + + + + + +이제 `flutter run`으로 앱을 시작할 수 있습니다. +이렇게 하면 기기에 "Hello world"가 표시됩니다. + + + + + + +이제 `dart lib/main.dart`으로 앱을 시작할 수 있습니다. +이렇게 하면 콘솔에 "Hello world"가 표시됩니다. + + + + +## 더 나아가기: 코드 스니펫 설치하기 + +`Flutter`와 `VS Code`를 사용하고 있다면 [Flutter Riverpod Snippets](https://marketplace.visualstudio.com/items?itemName=robert-brunhage.flutter-riverpod-snippets)를 사용해보세요. + +`Flutter`와 `Android Studio` 또는 `IntelliJ`를 사용하고 있다면 [Flutter Riverpod Snippets](https://plugins.jetbrains.com/plugin/14641-flutter-riverpod-snippets)를 사용해보세요. + +![img](/img/snippets/greetingProvider.gif) + +## 다음 단계 선택 + +몇 가지 기본 개념 알아보기: + +- + +쿡북(Cookbook) 따라하기: + +- + +[riverpod]: https://github.com/rrousselgit/riverpod +[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod +[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod +[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks +[riverpod_lint]: https://pub.dev/packages/riverpod_lint diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/index.tsx similarity index 100% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/index.tsx rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/index.tsx diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart new file mode 100644 index 000000000..bd88734c5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart @@ -0,0 +1,24 @@ +// ignore_for_file: avoid_print, unreachable_from_main + +/* SNIPPET START */ + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'main.g.dart'; + +// 값(여기서는 "Hello world")을 저장할 "provider"를 생성합니다. +// provider를 이용하면, 노출된 값을 모의(Mock)하거나 오버라이드(override)할 수 있습니다. +@riverpod +String helloWorld(HelloWorldRef ref) { + return 'Hello world'; +} + +void main() { + // 이 객체는 providers의 상태가 저장되는 곳입니다. + final container = ProviderContainer(); + + // "container" 덕분에 provider를 읽을 수 있습니다. + final value = container.read(helloWorldProvider); + + print(value); // Hello world +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.g.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart similarity index 75% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart index a7c49d638..8b6670a2c 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart @@ -1,17 +1,11 @@ // ignore_for_file: avoid_print, unreachable_from_main /* SNIPPET START */ - -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -part 'main.g.dart'; +import 'package:riverpod/riverpod.dart'; // We create a "provider", which will store a value (here "Hello world"). // By using a provider, this allows us to mock/override the value exposed. -@riverpod -String helloWorld(HelloWorldRef ref) { - return 'Hello world'; -} +final helloWorldProvider = Provider((_) => 'Hello world'); void main() { // This object is where the state of our providers will be stored. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx new file mode 100644 index 000000000..07c03cf6b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx @@ -0,0 +1,32 @@ +export function buildDeps({ + deps = [], + devDeps = [], +}: { + deps?: string[]; + devDeps?: string[]; +}) { + var result = ""; + for (const dep of deps) { + result += `dart pub add ${dep}\n`; + } + + for (const dep of [...devDeps, "custom_lint", "riverpod_lint"]) { + result += `dart pub add dev:${dep}\n`; + } + + return result; +} + +const raw = buildDeps({ deps: ["riverpod"] }); + +const codegen = buildDeps({ + deps: ["riverpod", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx new file mode 100644 index 000000000..d44367c30 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx @@ -0,0 +1,40 @@ +import { + riverpodVersion, + riverpodAnnotationVersion, + riverpodGeneratorVersion, + riverpodLintVersion, +} from "../../../../../../src/versions"; + +const codegen = `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + riverpod: ^${riverpodVersion} + riverpod_annotation: ^${riverpodAnnotationVersion} + +dev_dependencies: + build_runner: + custom_lint: + riverpod_generator: ^${riverpodGeneratorVersion} + riverpod_lint: ^${riverpodLintVersion} +`; + +const raw = `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + riverpod: ^${riverpodVersion} + +dev_dependencies: + custom_lint: + riverpod_lint: ^${riverpodLintVersion} +`; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart similarity index 59% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart index 11e5736b2..2d9872d57 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart @@ -7,10 +7,10 @@ import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; -part 'main_hooks.g.dart'; +part 'main.g.dart'; -// 我们创建一个 “provider”，它将用于保存一个值（这里是 “Hello world”）。 -// 通过使用一个 provider，我们能够模拟或覆盖被暴露的值。 +// 값을 저장할 “provider"를 생성합니다(여기서는 "Hello world"). +// 프로바이더를 사용하면, 노출된 값을 모의(Mock)하거나 재정의(Override)할 수 있습니다. @riverpod String helloWorld(HelloWorldRef ref) { return 'Hello world'; @@ -18,20 +18,20 @@ String helloWorld(HelloWorldRef ref) { void main() { runApp( - // 为了能让组件读取 provider，我们需要将整个 - // 应用都包裹在 “ProviderScope” 组件内。 - // 这里也就是存储我们所有 provider 状态的地方。 + // 위젯이 프로바이더를 읽을 수 있도록 하려면, + // 전체 애플리케이션을 "ProviderScope" 위젯으로 감싸야 합니다. + // 여기에 프로바이더의 상태가 저장됩니다. ProviderScope( child: MyApp(), ), ); } -// 扩展来自 Riverpod 的 HookConsumerWidget 而不是 HookWidget +// HookWidget 대신 Riverpod에서 제공되는 HookConsumerWidget을 확장합니다. class MyApp extends HookConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // We can use hooks inside HookConsumerWidget + // HookConsumerWidget 내부에서 Hook을 사용할 수 있습니다. final counter = useState(0); final String value = ref.watch(helloWorldProvider); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart similarity index 98% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart index 8d9c21ac5..b5f0b20f9 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/main_hooks.g.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -2,7 +2,7 @@ // ignore_for_file: non_constant_identifier_names -part of 'main_hooks.dart'; +part of 'main.dart'; // ************************************************************************** // RiverpodGenerator diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx new file mode 100644 index 000000000..3f10c2a94 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx @@ -0,0 +1,11 @@ +import raw from "!!raw-loader!./raw.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; +import codegen from "!!raw-loader!./main.dart"; +import hooksCodegen from "!!raw-loader!./hooks_codegen/main.dart"; + +export default { + raw, + hooks: raw_hooks, + codegen, + hooksCodegen: hooksCodegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart similarity index 61% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart index f03708b64..5f476d7a9 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart @@ -8,8 +8,8 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; -// We create a "provider", which will store a value (here "Hello world"). -// By using a provider, this allows us to mock/override the value exposed. +// 값을 저장할 “provider"를 생성합니다(여기서는 "Hello world"). +// 프로바이더를 사용하면, 노출된 값을 모의(Mock)하거나 재정의(Override)할 수 있습니다. @riverpod String helloWorld(HelloWorldRef ref) { return 'Hello world'; @@ -17,16 +17,16 @@ String helloWorld(HelloWorldRef ref) { void main() { runApp( - // For widgets to be able to read providers, we need to wrap the entire - // application in a "ProviderScope" widget. - // This is where the state of our providers will be stored. + // 위젯이 프로바이더를 읽을 수 있도록 하려면, + // 전체 애플리케이션을 "ProviderScope" 위젯으로 감싸야 합니다. + // 여기에 프로바이더의 상태가 저장됩니다. ProviderScope( child: MyApp(), ), ); } -// Extend ConsumerWidget instead of StatelessWidget, which is exposed by Riverpod +// StatelessWidget 대신 Riverpod에서 제공되는 ConsumerWidget을 확장합니다. class MyApp extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart new file mode 100644 index 000000000..b5f0b20f9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart @@ -0,0 +1,73 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'main.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef HelloWorldRef = Ref; + +@ProviderFor(helloWorld) +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/raw.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/raw_hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/hello_world/raw_hooks.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx new file mode 100644 index 000000000..65c7be1bd --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx @@ -0,0 +1,39 @@ +export function buildDeps({ + deps = [], + devDeps = [], +}: { + deps?: string[]; + devDeps?: string[]; +}) { + var result = ''; + for (const dep of deps) { + result += `flutter pub add ${dep}\n`; + } + + for (const dep of [...devDeps, "custom_lint", "riverpod_lint"]) { + result += `flutter pub add dev:${dep}\n`; + } + + return result; +} + +const raw = buildDeps({ deps: ["flutter_riverpod"] }); + +const codegen = buildDeps({ + deps: ["flutter_riverpod", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +const hooks = buildDeps({ deps: ["hooks_riverpod", "flutter_hooks"] }); + +const hooksCodegen = buildDeps({ + deps: ["hooks_riverpod", "flutter_hooks", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +export default { + raw: raw, + hooks: hooks, + codegen: codegen, + hooksCodegen: hooksCodegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx new file mode 100644 index 000000000..da974c2a1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx @@ -0,0 +1,51 @@ +import { + flutterRiverpodVersion, + hooksRiverpodVersion, + riverpodAnnotationVersion, + riverpodGeneratorVersion, + riverpodLintVersion, +} from "../../../../../../src/versions"; + +function plain(riverpod: string) { + return `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.0.0" + +dependencies: + flutter: + sdk: flutter + ${riverpod} + +dev_dependencies: + custom_lint: + riverpod_lint: ^${riverpodLintVersion} +`; +} + +function codegen(riverpod: string) { + return `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.0.0" + +dependencies: + flutter: + sdk: flutter + ${riverpod} + riverpod_annotation: ^${riverpodAnnotationVersion} + +dev_dependencies: + build_runner: + custom_lint: + riverpod_generator: ^${riverpodGeneratorVersion} + riverpod_lint: ^${riverpodLintVersion} +`; +} + +export default { + raw: plain(`flutter_riverpod: ^${flutterRiverpodVersion}`), + hooks: plain(`hooks_riverpod: ^${hooksRiverpodVersion}\n flutter_hooks:`), + codegen: codegen(`flutter_riverpod: ^${flutterRiverpodVersion}`), + hooksCodegen: codegen(`hooks_riverpod: ^${hooksRiverpodVersion}\n flutter_hooks:`), +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx new file mode 100644 index 000000000..cfd6b051e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx @@ -0,0 +1,56 @@ +--- +title: 왜 Riverpod인가? +version: 1 +--- + +import whyRiverpod from "./why_riverpod"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +## Riverpod 이란? + +Riverpod ([Provider](https://pub.dev/packages/provider)의 애너그램-철자를 바꾼 말)는 +Flutter/Dart를 위한 반응형 캐싱 프레임워크(Reactive caching framework)입니다. + +선언적 프로그래밍과 반응형 프로그래밍을 사용하여, Riverpod은 당신을 위해 애플리케이션의 상단 부분을 처리합니다. +내장된 오류 처리 및 캐싱을 통해 네트워크 요청을 수행할 수 있으며, +필요한 경우 데이터를 자동으로 데이터를 자동으로 다시 가져올 수 있습니다. + +## Motivation + +현대 애플리케이션은 UI를 렌더링하는 데 필요한 모든 정보를 제공하지 않습니다. +대신, 서버에서 비동기적으로 데이터를 가져오는 경우가 많습니다. + +문제는 비동기 코드를 사용하는 것이 어렵다는 것입니다. +Flutter는 상태 변수를 생성하고, 변경시 UI를 갱신하는 몇 가지 방법을 제공하지만, 아직은 상당히 제한적입니다. + +- 비동기 요청은 UI가 업데이트될 때마다 다시 실행하는 것은 불합리하므로 로컬에 캐시해야 할 필요가 있습니다. +- 캐시가 있기 때문에 우리가 조심하지 않으면 오래된 상태가 될 수 있습니다. +- 또한 오류 및 로딩 상태를 처리해야 합니다. + +이러한 문제를 대규모로 해결하는 것은 어려울 수 있으며, 다음과 같은 많은 기능에 영향을 받습니다: + +- 당겨서 새로 고침 +- 무한 목록 / 스크롤할 때 가져오기 +- 타이핑하는 동안 검색 +- 비동기 요청의 디바운싱(Debouncing) +- 더 이상 사용되지 않을 때 비동기 요청 취소 +- 낙관적(Optimistic) UI +- 오프라인 모드 +- ... + +이러한 기능은 구현하기 어려울 수 있지만, 좋은 사용자 경험을 위해 중요합니다. +아직까지 이러한 문제를 직접 해결하려는 패키지는 몇 개 없으며, 직접처리하려면 많은 작업이 필요합니다. + +그래서 Riverpod이 등장했습니다. +Riverpod은 Flutter 위젯에서 영감을 받아, 비즈니스 로직을 작성하는 새롭고 독특한 방식을 제공하여 이러한 문제를 해결하려고 합니다. +여러 가지 면에서 Riverpod은 위젯과 비슷하지만, 상태를 처리하기 위한 것입니다. + +이 새로운 접근 방식을 사용하면, 복잡한 기능을 대부분 기본적으로 처리할 수 있습니다. +남은 것은 UI에 집중하는 것입니다. + +회의적인가요? 여기 예제가 있습니다. +다음 스니펫은 Riverpod을 사용하여 구현된 [Pub.dev](https://github.com/rrousselGit/riverpod/tree/master/examples/pub) 클라이언트 어플리케이션의 단순화 버전입니다. + + + +이 스니펫은 당신이 에러/로딩 상태를 다루면서, "타이핑하는 동안 검색" + "당겨서 새로 고침" + "무한 목록"을 구현하는 데 필요한 모든 비즈니스 로직을 담고 있습니다. \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart new file mode 100644 index 000000000..83e1ff5b6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart @@ -0,0 +1,31 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class Package { + static Package fromJson(dynamic json) { + throw UnimplementedError(); + } +} + +/* SNIPPET START */ + +// Fetches the list of packages from pub.dev +@riverpod +Future> fetchPackages( + FetchPackagesRef ref, { + required int page, + String search = '', +}) async { + final dio = Dio(); + // Fetch an API. Here we're using package:dio, but we could use anything else. + final response = await dio.get>( + 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', + ); + + // Decode the JSON response into a Dart class. + return response.data?.map(Package.fromJson).toList() ?? const []; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart new file mode 100644 index 000000000..f0e4abbd9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart @@ -0,0 +1,164 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef FetchPackagesRef = Ref>>; + +@ProviderFor(fetchPackages) +const fetchPackagesProvider = FetchPackagesFamily._(); + +final class FetchPackagesProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, FetchPackagesRef> + with + $FutureModifier>, + $FutureProvider, FetchPackagesRef> { + const FetchPackagesProvider._( + {required FetchPackagesFamily super.from, + required ({ + int page, + String search, + }) + super.argument, + FutureOr> Function( + FetchPackagesRef ref, { + required int page, + String search, + })? create}) + : _createCb = create, + super( + name: r'fetchPackagesProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + FetchPackagesRef ref, { + required int page, + String search, + })? _createCb; + + @override + String debugGetCreateSourceHash() => _$fetchPackagesHash(); + + @override + String toString() { + return r'fetchPackagesProvider' + '' + '$argument'; + } + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + FetchPackagesProvider $copyWithCreate( + FutureOr> Function( + FetchPackagesRef ref, + ) create, + ) { + return FetchPackagesProvider._( + argument: argument as ({ + int page, + String search, + }), + from: from! as FetchPackagesFamily, + create: ( + ref, { + required int page, + String search = '', + }) => + create(ref)); + } + + @override + FutureOr> create(FetchPackagesRef ref) { + final _$cb = _createCb ?? fetchPackages; + final argument = this.argument as ({ + int page, + String search, + }); + return _$cb( + ref, + page: argument.page, + search: argument.search, + ); + } + + @override + bool operator ==(Object other) { + return other is FetchPackagesProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$fetchPackagesHash() => r'eebf7d838a57f493fffebfd2c8d8ab76d3233165'; + +final class FetchPackagesFamily extends Family { + const FetchPackagesFamily._() + : super( + name: r'fetchPackagesProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + FetchPackagesProvider call({ + required int page, + String search = '', + }) => + FetchPackagesProvider._(argument: ( + page: page, + search: search, + ), from: this); + + @override + String debugGetCreateSourceHash() => _$fetchPackagesHash(); + + @override + String toString() => r'fetchPackagesProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr> Function( + FetchPackagesRef ref, + ({ + int page, + String search, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FetchPackagesProvider; + + final argument = provider.argument as ({ + int page, + String search, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart new file mode 100644 index 000000000..131981f7b --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart @@ -0,0 +1,27 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Package { + static Package fromJson(dynamic json) { + throw UnimplementedError(); + } +} + +/* SNIPPET START */ + +// Fetches the list of packages from pub.dev +final fetchPackagesProvider = FutureProvider.autoDispose + .family, ({int page, String? search})>((ref, params) async { + final page = params.page; + final search = params.search ?? ''; + final dio = Dio(); + // Fetch an API. Here we're using package:dio, but we could use anything else. + final response = await dio.get>( + 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', + ); + + // Decode the JSON response into a Dart class. + return response.data?.map(Package.fromJson).toList() ?? const []; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx index e577300ff..9bb15695c 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx @@ -1,11 +1,11 @@ --- -title: ^0.13.0 to ^0.14.0 +title: ^0.13.0에서 ^0.14.0 --- -With the release of version `0.14.0` of Riverpod, the syntax for using [StateNotifierProvider] changed -(see https://github.com/rrousselGit/riverpod/issues/341 for the explanation). +리버팟 `0.14.0` 버전이 출시되면서, [StateNotifierProvider] 사용 구문이 변경되었습니다. +(자세한 설명은 https://github.com/rrousselGit/riverpod/issues/341 참조) -For the entire article, consider the following [StateNotifier]: +전체 문서에 대해서는 다음 [StateNotifier]를 참조하세요: ```dart class MyModel {} @@ -15,12 +15,11 @@ class MyStateNotifier extends StateNotifier { } ``` -## The changes +## 변경사항 -- [StateNotifierProvider] takes an extra generic parameter, which should be - the type of the state of your [StateNotifier]. +- [StateNotifierProvider]는 추가 제네릭 매개변수(extra generic parameter)를 받는데, 이 매개변수는 [StateNotifier]의 상태 타입이어야 합니다. - Before: + 이전: ```dart final provider = StateNotifierProvider((ref) { @@ -28,7 +27,7 @@ class MyStateNotifier extends StateNotifier { }); ``` - After: + 변경후: ```dart final provider = StateNotifierProvider((ref) { @@ -36,9 +35,9 @@ class MyStateNotifier extends StateNotifier { }); ``` -- to obtain the [StateNotifier], you should now read `myProvider.notifier` instead of just `myProvider`: +- [StateNotifier]를 얻으려면, 이제 `myProvider`가 아닌 `myProvider.notifier`를 읽어야 합니다: - Before: + 이전: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -46,7 +45,7 @@ class MyStateNotifier extends StateNotifier { } ``` - After: + 변경후: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -54,9 +53,9 @@ class MyStateNotifier extends StateNotifier { } ``` -- to listen to the state of the [StateNotifier], you should now read `myProvider` instead of `myProvider.state`: +- [StateNotifier]의 상태를 수신(listen)하려면, 이제 `myProvider.state` 대신 `myProvider`를 읽어야 합니다: - Before: + 이전: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -64,7 +63,7 @@ class MyStateNotifier extends StateNotifier { } ``` - After: + 변경후: ```dart Widget build(BuildContext context, ScopedReader watch) { @@ -72,39 +71,38 @@ class MyStateNotifier extends StateNotifier { } ``` -## Using the migration tool to automatically upgrade your projects to the new syntax +## 마이그레이션 도구를 사용하여 프로젝트를 새 구문으로 자동 업그레이드하기 -With version 0.14.0 came the release of a command line tool for Riverpod, -which can help you migrate your projects. +버전 0.14.0에서는 프로젝트를 마이그레이션하는 데 도움이 되는 리버포드용 명령줄 도구가 출시되었습니다. -### Installing the command line +### 명령줄 설치하기 -To install the migration tool, run: +마이그레이션 도구를 설치하려면 다음을 실행합니다: ```sh dart pub global activate riverpod_cli ``` -You should now be able to run: +이제 실행할 수 있을 것입니다: ```sh riverpod --help ``` -### Usage +### 사용법 -Now that the command line is installed, we can start using it. +이제 명령줄이 설치되었으므로 사용을 시작할 수 있습니다. -- First, open the project you want to migrate in your terminal. -- **Do not** upgrade Riverpod. - The migration tool will upgrade the version of Riverpod for you. -- Make sure that your project does not contain errors. -- Execute: +- 먼저 터미널에서 마이그레이션하려는 프로젝트를 엽니다. +- **Do not** Riverpod을 업그레이드하지 마세요. + 마이그레이션 도구가 Riverpod의 버전을 업그레이드해 줍니다. +- 프로젝트에 오류가 없는지 확인합니다. +- 실행: ```sh riverpod migrate ``` -The tool will then analyze your project and suggest changes. For example you may see: +그러면 도구가 프로젝트를 분석하고 변경 사항을 제안합니다. 예를 들면 다음과 같습니다: ```diff Widget build(BuildContext context, ScopedReader watch) { @@ -115,8 +113,7 @@ Widget build(BuildContext context, ScopedReader watch) { Accept change (y = yes, n = no [default], A = yes to all, q = quit)? ``` -To accept the change, simply press y. Otherwise to reject it, press n. - +변경을 수락하려면 Y를 누르면 됩니다. 변경을 거부하려면 n을 누르세요. [statenotifierprovider]: ../providers/state_notifier_provider [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx index 480775da1..afe8533ef 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx @@ -1,53 +1,54 @@ --- -title: ^0.14.0 to ^1.0.0 +title: ^0.14.0에서 ^1.0.0 --- -After a long wait, the first stable version of Riverpod is finally released 👏 +import { Link } from "../../../../../src/components/Link"; -To see the full list of changes, consult the [Changelog](https://pub.dev/packages/flutter_riverpod/changelog#100). -In this page, we will focus on how to migrate an existing Riverpod application -from version 0.14.x to version 1.0.0. -## Using the migration tool to automatically upgrade your project to the new syntax +오랜 기다림 끝에 드디어 리버팟의 첫 번째 안정 버전이 출시되었습니다 👏. -Before explaining the various changes, it is worth noting that Riverpod comes with -a command-line tool to automatically migrate your project for you. +전체 변경 목록을 보려면 [변경 로그](https://pub.dev/packages/flutter_riverpod/changelog#100)를 참조하세요. +이 페이지에서는 기존 리버Riverpod드 애플리케이션을 버전 0.14.x에서 버전 1.0.0으로 마이그레이션하는 방법에 대해 중점적으로 설명합니다. -### Installing the command line tool +## 마이그레이션 도구를 사용하여 프로젝트를 새 구문으로 자동 업그레이드하기 -To install the migration tool, run: +다양한 변경 사항을 설명하기 전에, Riverpod에는 프로젝트를 자동으로 마이그레이션할 수 있는 명령줄 도구가 함께 제공된다는 점을 알아둘 필요가 있습니다. + +### 명령줄 도구 설치하기 + +마이그레이션 도구를 설치하려면 다음을 실행합니다: ```sh dart pub global activate riverpod_cli ``` -You should now be able to run: +이제 실행할 수 있을 것입니다: ```sh riverpod --help ``` -### Usage +### 사용법 -Now that the command line is installed, we can start using it. +이제 명령줄이 설치되었으므로 사용을 시작할 수 있습니다. -- First, open the project you want to migrate in your terminal. -- **Do not** upgrade Riverpod. - The migration tool will upgrade the version of Riverpod for you. +- 먼저 터미널에서 마이그레이션하려는 프로젝트를 엽니다. +- **Do not** Riverpod을 업그레이드하지 마세요. + 마이그레이션 도구가 Riverpod의 버전을 업그레이드해 줍니다. :::danger - Not upgrading Riverpod is important. - The tool will not execute properly if you have already installed version 1.0.0. - As such, make sure that you are properly using an older version before starting the tool. + Riverpod을 업그레이드하지 않는 것이 중요합니다. + 이미 버전 1.0.0을 설치한 경우 도구가 제대로 실행되지 않습니다. + 따라서 도구를 시작하기 전에 이전 버전을 제대로 사용하고 있는지 확인하세요. ::: -- Make sure that your project does not contain errors. -- Execute: +- 프로젝트에 오류가 없는지 확인합니다. +- 실행: ```sh riverpod migrate ``` -The tool will then analyze your project and suggest changes. For example you may see: +그러면 도구가 프로젝트를 분석하고 변경 사항을 제안합니다. 예를 들면 다음과 같습니다: ```diff -Widget build(BuildContext context, ScopedReader watch) { @@ -59,26 +60,23 @@ The tool will then analyze your project and suggest changes. For example you may Accept change (y = yes, n = no [default], A = yes to all, q = quit)? ``` -To accept the change, simply press y. Otherwise to reject it, press n. +변경을 수락하려면 Y를 누르면 됩니다. 변경을 거부하려면 n을 누르세요. -## The changes +## 변경사항 -Now that we've seen how to use the CLI to automatically upgrade your project, -let's see in detail the changes necessary. +이제 CLI를 사용하여 프로젝트를 자동으로 업그레이드하는 방법을 살펴봤으니 필요한 변경 사항을 자세히 살펴봅시다. -### Syntax unification +### 구문(Syntax) 통합 -Version 1.0.0 of Riverpod focused on the unification of the syntax for -interacting with providers. -Before, Riverpod had many similar yet different syntaxes for reading a provider, -such as `ref.watch(provider)` vs `useProvider(provider)` vs `watch(provider)`. -With version 1.0.0, only one syntax remains: `ref.watch(provider)`. The -others were removed. +리버포드 버전 1.0.0은 providers와 상호작용하기 위한 구문을 통합하는 데 중점을 두었습니다. +이전에는 `ref.watch(provider)` 대 `useProvider(provider)` 대 `watch(provider)`와 같이 provider를 읽는 구문이 비슷하지만 서로 다른 구문이 많았습니다. +버전 1.0.0에서는 구문이 하나만 남았습니다: ref.watch(provider)`. 나머지는 제거되었습니다. -As such: +따라서: -- `useProvider` is removed in favor of `HookConsumerWidget`. - Before: +- `useProvider`가 제거되고 `HookConsumerWidget`이 대신 사용됩니다. + + 이전: ```dart class Example extends HookWidget { @@ -91,7 +89,7 @@ As such: } ``` - After: + 변경후: ```dart class Example extends HookConsumerWidget { @@ -104,8 +102,9 @@ As such: } ``` -- The prototype of `ConsumerWidget`'s `build` and `Consumer`'s `builder` changed. - Before: +- `ConsumerWidget`의 `build` 와 `Consumer`의 `builder`의 프로토타입이 변경되었습니다. + + 이전: ```dart class Example extends ConsumerWidget { @@ -124,7 +123,7 @@ As such: ) ``` - After: + 변경후: ```dart class Example extends ConsumerWidget { @@ -143,8 +142,9 @@ As such: ) ``` -- `context.read` is removed in favor of `ref.read`. - Before: +- `context.read`가 `ref.read`로 대체되어 제거됩니다. + + 이전: ```dart class Example extends StatelessWidget { @@ -157,7 +157,7 @@ As such: } ``` - After: + 변경후: ```dart class Example extends ConsumerWidget { @@ -170,15 +170,15 @@ As such: } ``` -### StateProvider update +### StateProvider 업데이트 -[StateProvider] was updated to match [StateNotifierProvider]. +[StateProvider]가 [StateNotifierProvider]와 일치하도록 업데이트 되었습니다. -Before, doing `ref.watch(StateProvider)` returned a `StateController` instance. -Now it only returns the state of the `StateController`. +이전에는 `ref.watch(StateProvider)`를 실행하면 `StateController` 인스턴스가 반환되었습니다. +이제 `StateController`의 상태만 반환합니다. -To migrate you have a few solutions. -If your code only obtained the state without modifying it, you can change from: +마이그레이션을 위한 몇 가지 솔루션이 있습니다. +코드를 수정하지 않고 상태만 가져온 경우 다음에서 변경할 수 있습니다: ```dart final provider = StateProvider(...); @@ -192,7 +192,7 @@ Consumer( ) ``` -to: +에서 다음과 같이: ```dart final provider = StateProvider(...); @@ -206,7 +206,7 @@ Consumer( ) ``` -Alternatively you can use the new `StateProvider.state` to keep the old behavior. +또는 새로운 `StateProvider.state`를 사용하여 이전 동작을 유지할 수 있습니다. ```dart final provider = StateProvider(...); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx new file mode 100644 index 000000000..70fe08594 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx @@ -0,0 +1,117 @@ +--- +title: "`ChangeNotifier`에서" +--- + +import old from "!!raw-loader!./from_change_notifier/old.dart"; +import declaration from "./from_change_notifier/declaration"; +import initialization from "./from_change_notifier/initialization"; +import migrated from "./from_change_notifier/migrated"; + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +Riverpod 내에서 `ChangeNotifierProvider`는 pkg:provider에서 원활한 전환을 제공하는 데 사용됩니다. + +이제 막 pkg:riverpod로 마이그레이션을 시작한 경우 전용 가이드를 읽어보세요( 참조). +이 글은 이미 Riverpod로 마이그레이션했지만 `ChangeNotifier`에서 완전히 벗어나고 싶은 분들을 위한 글입니다. + +대체로 `ChangeNotifier`에서 `AsyncNotifer`로 마이그레이션하려면 패러다임의 전환이 필요하지만, 마이그레이션된 코드를 통해 크게 간소화할 수 있습니다. +도 참조하세요. + +이 (잘못된) 예를 들어보겠습니다: + + +이 구현은 다음과 같은 몇 가지 잘못된 디자인 선택을 보여줍니다: +- 다양한 비동기 케이스를 처리하기 위해 `isLoading`과 `hasError`를 사용함. +- 지루한 `try`/`catch`/`finally` 표현식으로 요청을 신중하게 처리해야 합니다. +- 이 구현이 작동하도록 하기 위해 적시에 `notifyListeners`를 삽입해야 할 필요성 +- 일관성이 없거나 바람직하지 않은 상태(예: 빈 리스트로 초기화)가 존재할 수 있습니다. + +이 예제는 `ChangeNotifier`가 초보 개발자에게 어떻게 잘못된 디자인 선택으로 이어질 수 있는지 보여주기 위해 만들어졌습니다; +또한 변경 가능한 상태가 처음에 약속한 것보다 훨씬 더 어려울 수 있다는 점도 알아두세요. + +`Notifier`/`AsyncNotifer`를 불변 상태(immutable state)와 함께 사용하면 더 나은 디자인 선택과 오류 감소로 이어질 수 있습니다. + +위의 스니펫을 한 번에 한 단계씩 최신 API로 마이그레이션하는 방법을 살펴보겠습니다. + +## 마이그레이셔 시작 +먼저 새 provider / notifier를 선언해야 합니다. 여기에는 고유한 비즈니스 로직에 따라 몇 가지 사고 과정이 필요합니다. + +위의 요구 사항을 요약해 보겠습니다: +- 상태(state)는 매개 변수(parameters) 없이 네트워크 호출을 통해 얻은 `List`로 표현됩니다. +- 상태는 `loading`, `error` 및 `data` 상태에 대한 정보를 *또한* 노출해야 합니다. +- State는 노출된 일부 메서드를 통해 변경될 수 있으므로 함수만으로는 충분하지 않습니다. + +:::tip +위의 사고 과정은 다음 질문에 답하는 것으로 요약됩니다: +1. 부가작업(side effects)이 필요한가? + - `y`: Riverpod의 클래스 기반 API 사용 + - `n`: Riverpod의 함수 기반 API 사용 +2. 상태를 비동기적으로 로드해야 하나요? + - `y`: `build`가 `Future`를 반환하도록 합니다. + - `n`: `build`가 단순히 `T`를 반환하도록 합니다. +3. 몇 가지 매개변수가 필요한가요? + - `y`: `build`(또는 함수)가 매개 변수를 받아들이도록 합니다. + - `n`: `build`(또는 함수)가 추가 매개변수를 받지 않도록 합니다. +::: + +:::info +코드생성을 사용한다면 위의 생각 과정만으로도 충분합니다. +올바른 클래스 이름과 해당 클래스의 *특정* API에 대해 생각할 필요가 없습니다. +`@riverpod`는 반환 유형이 있는 클래스를 작성하기만 하면 됩니다. +::: + +기술적으로 가장 적합한 방법은 위의 모든 요구 사항을 충족하는 `AsyncNotifier>`를 정의하는 것입니다. +먼저 의사 코드를 작성해 봅시다. + + + +:::tip +기억하세요: IDE에서 스니펫을 사용하여 지침을 얻거나 코드 작성 속도를 높이세요. +를 참조하세요. +::: + +`ChangeNotifier`의 구현과 관련해서는 더 이상 `todos`를 선언할 필요가 없습니다; +이러한 변수는 `state`이며, `build`와 함께 암시적으로 로드됩니다. + +실제로 Riverpod의 노티파이어는 한 번에 *하나의* 엔티티를 노출할 수 있습니다. + +:::tip +Riverpod의 API는 세분화되어 있지만, 마이그레이션할 때 여러 값을 보유하도록 사용자 정의 엔티티를 정의할 수 있습니다. +처음에는 마이그레이션을 원활하게 하기 위해 [Dart 3's records](https://dart.dev/language/records)를 사용하는 것이 좋습니다. +::: + + +### 초기화 +`build` 안에 초기화 로직을 작성하기만 하면 notifier를 쉽게 초기화할 수 있습니다. +이제 이전 `_init` 함수를 제거할 수 있습니다. + + + +기존 `_init`과 관련하여, 새로운 `build`에서는 더 이상 `isLoading` 또는 `hasError`와 같은 변수를 초기화할 필요가 없습니다. + +Riverpod `AsyncValue>` 노출을 통해 모든 비동기 provider를 자동으로 변환하며, +두 개의 단순한 boolean 플래그가 할 수 있는 것보다 비동기 상태의 복잡성을 훨씬 더 잘 처리합니다. + +실제로 `AsyncNotifier`를 사용하면 비동기 상태를 처리하기 위해 추가 `try`/`catch`/`finally`를 작성하는 것이 사실상 안티 패턴이 됩니다. + +### 변이 및 부가작업(Mutations and Side Effects) +초기화와 마찬가지로 부가작업을 수행할 때 `hasError`와 같은 boolean 플래그를 조작하거나 `try`/`catch`/`finally` 블록을 추가로 작성할 필요가 없습니다. + +아래에서는 모든 상용구를 줄이고 위의 예제를 성공적으로 완전히 마이그레이션했습니다: + + +:::tip +구문과 디자인 선택은 다를 수 있지만 결국에는 요청을 작성하고 나중에 상태를 업데이트하기만 하면 됩니다. +를 참조하세요. +::: + +## 마이그레이션 프로세스 요약 + +위에서 적용한 전체 마이그레이션 프로세스를 운영 관점에서 검토해 보겠습니다. + +1. 초기화를 생성자에서 호출되는 사용자 정의 메서드에서 `build`로 옮겼습니다. +2. `todos`, `isLoading`, `hasError` 프로퍼티를 제거했습니다: 내부 `state`로 충분합니다. +3. `try`-`catch`-`finally` 블록을 제거했습니다: futures를 반환하는 것으로 충분합니다. +4. 부가작업(`addTodo`)에도 동일한 단순화를 적용했습니다. +5. 단순히 `state` 재할당을 통해 변형을 적용했습니다. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart new file mode 100644 index 000000000..b3ca06ef2 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart @@ -0,0 +1,33 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'declaration.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() { + // TODO ... + return []; + } + + Future addTodo(Todo todo) async { + // TODO + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart new file mode 100644 index 000000000..e28ccbd61 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'declaration.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider + extends $AsyncNotifierProvider> { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'fc9a07f8ef9f792da2ac660d76ea0a809335ba18'; + +abstract class _$MyNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx new file mode 100644 index 000000000..1ad659c31 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./declaration.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart new file mode 100644 index 000000000..0c723f63c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart @@ -0,0 +1,34 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyNotifier extends AsyncNotifier> { + @override + FutureOr> build() { + // TODO ... + return []; + } + + Future addTodo(Todo todo) async { + // TODO + } +} + +final myNotifierProvider = + AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx new file mode 100644 index 000000000..3b3fbd2cb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./initialization.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart new file mode 100644 index 000000000..4da805e13 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart @@ -0,0 +1,29 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'initialization.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + return [...json.map(Todo.fromJson)]; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart new file mode 100644 index 000000000..032f36218 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'initialization.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider + extends $AsyncNotifierProvider> { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'1c67c12443102cf8c43efbf6c630d3028d9847c3'; + +abstract class _$MyNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart new file mode 100644 index 000000000..5ef9e85c1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart @@ -0,0 +1,30 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyNotifier extends AsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + return [...json.map(Todo.fromJson)]; + } +} + +final myNotifierProvider = + AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx new file mode 100644 index 000000000..075bfbdf5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./migrated.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart new file mode 100644 index 000000000..b8f4ba829 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart @@ -0,0 +1,37 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'migrated.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + Future addTodo(Todo todo) async { + // optional: state = const AsyncLoading(); + final json = await http.post('api/todos'); + final newTodos = [...json.map(Todo.fromJson)]; + state = AsyncData(newTodos); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart new file mode 100644 index 000000000..a70189d52 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'migrated.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider + extends $AsyncNotifierProvider> { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'bde95c56aa12eff7c8c01ede57ae4ad2b616c225'; + +abstract class _$MyNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart new file mode 100644 index 000000000..6927bd057 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart @@ -0,0 +1,38 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyNotifier extends AsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + Future addTodo(Todo todo) async { + // optional: state = const AsyncLoading(); + final json = await http.post('api/todos'); + final newTodos = [...json.map(Todo.fromJson)]; + state = AsyncData(newTodos); + } +} + +final myNotifierProvider = + AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart new file mode 100644 index 000000000..932804174 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart @@ -0,0 +1,60 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyChangeNotifier extends ChangeNotifier { + MyChangeNotifier() { + _init(); + } + List todos = []; + bool isLoading = true; + bool hasError = false; + + Future _init() async { + try { + final json = await http.get('api/todos'); + todos = [...json.map(Todo.fromJson)]; + } on Exception { + hasError = true; + } finally { + isLoading = false; + notifyListeners(); + } + } + + Future addTodo(int id) async { + isLoading = true; + notifyListeners(); + + try { + final json = await http.post('api/todos'); + todos = [...json.map(Todo.fromJson)]; + hasError = false; + } on Exception { + hasError = true; + } finally { + isLoading = false; + notifyListeners(); + } + } +} + +final myChangeProvider = ChangeNotifierProvider((ref) { + return MyChangeNotifier(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx new file mode 100644 index 000000000..c586a295f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx @@ -0,0 +1,243 @@ +--- +title: "`StateNotifier`에서" +--- + +import buildInit from "./from_state_notifier/build_init"; +import buildInitOld from "!!raw-loader!./from_state_notifier/build_init_old.dart"; +import consumersDontChange from "!!raw-loader!./from_state_notifier/consumers_dont_change.dart"; +import familyAndDispose from "./from_state_notifier/family_and_dispose"; +import familyAndDisposeOld from "!!raw-loader!./from_state_notifier/family_and_dispose_old.dart"; +import asyncNotifier from "./from_state_notifier/async_notifier"; +import asyncNotifierOld from "!!raw-loader!./from_state_notifier/async_notifier_old.dart"; +import addListener from "./from_state_notifier/add_listener"; +import addListenerOld from "!!raw-loader!./from_state_notifier/add_listener_old.dart"; +import fromStateProvider from "./from_state_notifier/from_state_provider"; +import fromStateProviderOld from "!!raw-loader!./from_state_notifier/from_state_provider_old.dart"; +import oldLifecycles from "./from_state_notifier/old_lifecycles"; +import oldLifecyclesOld from "!!raw-loader!./from_state_notifier/old_lifecycles_old.dart"; +import oldLifecyclesFinal from "./from_state_notifier/old_lifecycles_final"; +import obtainNotifierOnTests from "!!raw-loader!./from_state_notifier/obtain_notifier_on_tests.dart"; + +import { Link } from "../../../../../src/components/Link"; +import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +[Riverpod 2.0](https://pub.dev/packages/flutter_riverpod/changelog#200)과 함께 새로운 클래스가 도입되었습니다: `Notifier` / `AsyncNotifer`. +이제 이러한 새로운 API를 위해 `StateNotifier`는 더 이상 사용되지 않습니다. + +이 페이지는 더 이상 사용되지 않는 `StateNotifier`에서 새로운 API로 마이그레이션하는 방법을 보여줍니다. + +`AsyncNotifier`가 도입한 주요 이점은 더 나은 `async` 지원입니다, +실제로 `AsyncNotifier`는 UI에서 수정할 수 있는 방법을 노출하는 `FutureProvider`로 생각할 수 있습니다. + +또한, 새로운 `(Async)Notifier`가 추가되었습니다: + +- 클래스 내부에 `Ref` 객체 노출하기 +- 코드 생성 방식(codegen)과 비코드 생성 방식(non-codegen) 간에 유사한 문법 제공 +- 동기화 버전과 비동기 버전 간에 유사한 문법 제공 +- 로직을 provider에서 벗어나 Notifiers 자체로 중앙 집중화하기 + +`Notifier`를 정의하는 방법, `StateNotifier`와 비교하는 방법, 비동기 상태를 위해 새로운 `AsyncNotifier`를 마이그레이션하는 방법을 살펴봅시다. + +## 새로운 문법 비교 + +이 비교를 시작하기 전에 `Notifier`을 정의하는 방법을 알아두세요. +를 참고하세요. + +이전 `StateNotifier` 문법을 사용하여 예제를 작성해 보겠습니다: + + +다음은 새로운 `Notifier` API로 작성된 동일한 예시이며, 대략 다음과 같이 변환됩니다: + + +`Notifier`와 `StateNotifier`를 비교하면 다음과 같은 주요 차이점을 확인할 수 있습니다: + +- `StateNotifier`의 반응형 종속성(reactive dependencies)은 provider에서 선언되는 반면, `Notifier`는 이 로직을 `build` 메서드에서 중앙 집중화합니다. +- `StateNotifier`의 전체 초기화 프로세스는 provider와 생성자 사이에 분할되어 있는 반면, `Notifier`는 이러한 로직을 배치할 수 있는 단일 위치를 예약합니다. +- `StateNotifier`와는 반대로, `Notifier`의 생성자에는 어떠한 로직도 작성되지 않는 것을 주목하세요. + +`Notifier`의 비동기 대응 클래스인 `AsyncNotifer`에서도 비슷한 점을 발견할 수 있습니다. + +## 비동기 `StateNotifier` 마이그레이션하기 + +새로운 API 구문의 가장 큰 장점은 비동기 데이터에 대한 향상된 DX입니다. +다음 예시를 살펴보겠습니다: + + + +다음은 새로운 `AsyncNotifier` API를 사용하여 재작성된 위의 예시입니다: + + + +`AsyncNotifier`는 `Notifier`와 마찬가지로 더 간단하고 통일된 API를 제공합니다. +여기서 `AsyncNotifier`는 메서드가 있는 `FutureProvider`로 쉽게 볼 수 있습니다. + +`AsyncNotifer`에는 `StateNotifier`에는 없는 유틸리티와 게터가 함께 제공됩니다, +예를 들어 [`future`](https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifier/future.html) +및 [`update`](https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifier/update.html). +이를 통해 비동기 변이(mutations)와 부수작업(side-effects)을 처리할 때 훨씬 더 간단한 로직을 작성할 수 있습니다. +를 참고하세요. + +:::tip +`StateNotifier>`에서 `AsyncNotifer`로 마이그레이션하는 방법은 다음과 같습니다: + +- 초기화 로직을 `build`에 넣기 +- 초기화 또는 부수작업 메서드에서 `catch`/`try` 블록을 제거합니다. +- `build`에서 `AsyncValue.guard`를 제거합니다. `Future`를 `AsyncValue`로 변환하기 때문입니다. +::: + +### 장점 + +이 몇 가지 예시를 살펴본 후, 이제 `Notifier` 와 `AsyncNotifer`의 주요 장점을 살펴보겠습니다: +- 새로운 구문은 특히 비동기 상태의 경우 훨씬 더 간단하고 가독성이 높아질 것입니다. +- 새로운 API에는 일반적으로 상용구 코드가 줄어들 가능성이 높습니다. +- 이제 작성하는 provider 타입에 관계없이 구문이 통합되어 코드 생성이 가능해졌습니다. +( 참조). + +더 자세히 살펴보고 더 많은 차이점과 유사점을 강조해 보겠습니다. + +## 명시적인 `.family` 및 `.autoDispose` 수정사항 + +또 다른 중요한 차이점은 새로운 API로 패밀리 및 자동폐기가 처리되는 방식입니다. + +`Notifier`에는 `FamilyNotifier` 및 `Notifier`와 같은 자체 `.family` 및 `.autoDispose` 대응 항목이 있습니다. +항상 그렇듯이, 이러한 수정 사항을 결합할 수 있습니다 (일명 `AutoDisposeFamilyNotifier`). +`AsyncNotifer`에는 비동기 버전도 있습니다(예: `FamilyAsyncNotifier`). + +수정 사항(Modifications)은 클래스 내부에 명시적으로 지정(stated)됩니다; +모든 매개변수는 `build` 메서드에 직접 주입되어 초기화 로직에서 사용할 수 있습니다. +이렇게 하면 가독성이 향상되고 간결해지며 전반적으로 실수가 줄어듭니다. + +다음 예제에서는 `StateNotifierProvider.family`를 정의하고 있습니다. + + +`BugsEncounteredNotifier`은 무겁거나 읽기 어려운 느낌입니다. +마이그레이션 된 `AsyncNotifier`를 살펴 보겠습니다: + + + +마이그레이션된 버전은 가볍게 읽을 수 있는 수준입니다. + +:::info +`(Async)Notifier`의 `.family` 매개변수는 `this.arg`(또는 코드생성을 사용하는 경우 `this.paramName`)를 통해 사용할 수 있습니다. +::: + +## 라이프사이클에 따라 동작 방식이 다릅니다. + +`Notifier`/`AsyncNotifier`와 `StateNotifier`의 수명 주기는 크게 다릅니다. + +이 예시는 이전 API의 로직이 얼마나 부족한지(sparse)를 다시 한 번 보여줍니다: + + + +여기서 `durationProvider`가 업데이트되면 `MyNotifier`를 _페기(dispose)_: 인스턴스가 다시 인스턴스화되고 내부 상태가 다시 초기화됩니다. +또한 다른 모든 provider와 달리 `dispose` 콜백은 클래스에서 별도로 정의해야 합니다. +마지막으로, _provider_에 `ref.onDispose`를 작성하는 것이 여전히 가능하기 때문에, 이 API의 로직이 얼마나 부족한지(sparse)를 다시 한 번 알 수 있습니다; +잠재적으로 개발자는 이 Notifier 동작을 이해하기 위해 여덟 곳(8개!)을 살펴봐야 할 수도 있습니다! + +이러한 모호함은 `Riverpod 2.0`을 통해 해결되었습니다. + +### 이전의 `dispose` vs `ref.onDispose` +`StateNotifier`의 `dispose` 메서드는 notifier 자체의 폐기(dispose) 이벤트를 참조하며, 일명 *자신을 처분하기 전에(before disposing of itself)* 호출되는 콜백입니다. + +`(Async)Notifier`은 이 속성을 갖지 않는데, *리빌드 시 폐기되지 않고* *내부 상태만 폐기*되기 때문입니다. +새로운 notifiers에서 폐기 수명주기는 다른 provider와 마찬가지로 `ref.onDispose`(및 기타)를 통해 _한_ 곳에서만 처리됩니다. +이렇게 하면 API와 DX가 단순화되어 라이프사이클 부작용을 이해하기 위해 살펴봐야 할 곳이 `build` 메서드 하나만 남게 됩니다. + +간단히 말해서, *내부 상태(internal state)*가 다시 빌드되기 전에 실행되는 콜백을 등록하려면 다른 모든 provider와 마찬가지로 `ref.onDispose`를 사용하면 됩니다. + +위의 스니펫을 다음과 같이 마이그레이션할 수 있습니다: + + + +이 마지막 스니펫에는 확실히 약간의 단순화가 있지만 여전히 열려 있는 문제가 있습니다: +이제 `update`를 수행하는 동안 notifiers가 아직 살아(alive)있는지 여부를 파악할 수 없습니다. +이로 인해 원치 않는 `StateError`가 발생할 수 있습니다. + +### 더 이상 `마운트되지(mounted)` 않음 +이는 `(Async)Notifier`에 `StateNotifier`에서 사용할 수 있는 `mounted` 프로퍼티가 없기 때문에 발생합니다. +수명 주기의 차이를 고려하면 이것은 완벽하게 이해가 됩니다; +가능하긴 하지만, 새로운 notifiers에서 `mounted` 프로퍼티는 오해의 소지가 있습니다: `mounted`는 거의 항상 `true`이 될 것입니다. + +[커스텀 해결방법](https://github.com/rrousselGit/riverpod/issues/1879#issuecomment-1303189191)을 만들 수는 있지만, +비동기 작업을 취소하여 이 문제를 해결하는 것이 좋습니다. + +작업 취소는 커스텀 [Completer](https://api.flutter.dev/flutter/dart-async/Completer-class.html) 또는 커스텀 파생어(derivative)를 사용하여 수행할 수 있습니다. + +예를 들어 `Dio`를 사용하여 네트워크 요청을 수행하는 경우 [cancel token](https://pub.dev/documentation/dio/latest/dio/CancelToken-class.html)을 사용하는 것이 좋습니다. +( 참고) + +따라서 위의 예는 다음과 같이 마이그레이션됩니다: + + +## 변이(Mutations) API는 이전과 동일합니다 + +지금까지 `StateNotifier`와 새로운 API의 차이점을 살펴보았습니다. +대신, `Notifier`, `AsyncNotifer`, `StateNotifier`가 공유하는 한 가지는 상태를 소비하고 변경할 수 있다는 점입니다. + +Consumers는 동일한 구문으로 이 세 공급자로부터 데이터를 얻을 수 있습니다, +이는 `StateNotifier`에서 마이그레이션하는 경우에 유용하며, 이는 notifiers 메서드에도 적용됩니다. + + + +## 기타 마이그레이션 + +`StateNotifier`와 `Notifier`(또는 `AsyncNotifier`)의 영향력이 크지 않은 차이점을 살펴봅시다. + +### `.addListener` 및 `.stream`에서 + +`StateNotifier`의 `.addListener`와 `.stream`은 상태 변경을 수신하는 데 사용할 수 있습니다. +이 두 API는 이제 오래된 것으로 간주됩니다. + +이는 `Notifier`, `AsyncNotifier` 및 기타 proviers와 완전한 API 통일성을 달성하기 위한 의도적인 것입니다. +실제로 `Notifier`나 `AsyncNotifier`를 사용하는 것은 다른 provier와 다르지 않아야 합니다. + +따라서 이 것이: + + +이렇게 됩니다: + + +간단히 말해, `Notifier`/`AsyncNotifer`를 수신하려면 `ref.listen`를 사용하면 됩니다. +를 참고하세요 + +### 테스트의 `.debugState`에서 + +`StateNotifier`는 `.debugState`를 노출합니다: +이 프로퍼티는 개발 모드에서 테스트 목적으로 클래스 외부에서 상태 액세스를 활성화하기 위해 pkg:state_notifier 사용자가 사용할 수 있습니다. + +테스트에서 상태에 액세스하기 위해 `.debugState`를 사용하는 경우 이 접근 방식을 중단해야 합니다. + +`Notifier` / `AsyncNotifer`에는 `.debugState`가 없으며, 대신 `.state`, 즉 `@visibleForTesting`을 직접 노출합니다. + +:::danger +AVOID 테스트에서 `.state`에 접근하지 마시고, 꼭 접근해야 한다면 `Notifier` / `AsyncNotifer`가 이미 제대로 인스턴스화된 경우에만 접근하세요; +그러면 테스트 내부에서 `.state`에 자유롭게 접근할 수 있습니다. + +실제로 `Notifier` / `AsyncNotifier`는 직접 인스턴스화해서는 안 됩니다; +대신 해당 provider를 사용해 상호작용해야 합니다: +그렇게 하지 않으면 notifier가 *중단(break)*됩니다, +ref와 family 인자가 초기화되지 않기 때문입니다. +::: + +`Notifier` 인스턴스가 없으신가요? +문제없습니다. 노출된 상태를 읽을 때와 마찬가지로 `ref.read`로 인스턴스를 가져올 수 있습니다: + + + +전용 가이드에서 테스트에 대해 자세히 알아보세요. 를 참고하세요. + +### `StateProvider`에서 + +`StateProvider`는 Riverpod에서 출시 이후 노출된 것으로, `StateNotifierProvider`의 간소화된 버전을 위해 몇 가지 LoC를 절약하기 위해 만들어졌습니다. +`StateNotifierProvider`는 더 이상 사용되지 않으므로 `StateProvider`도 피해야 합니다. +또한 현재는 새로운 API에 상응하는 `StateProvider`가 없습니다. + +그럼에도 불구하고 `StateProvider`에서 `Notifier`로 마이그레이션하는 것은 간단합니다. + +이 코드는: + + +이렇게 됩니다: + + +LoC가 몇 개 더 들더라도 `StateProvider`에서 마이그레이션하면 `StateNotifier`를 확실하게 보존(archive)할 수 있습니다. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart new file mode 100644 index 000000000..ead1c72d8 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart @@ -0,0 +1,18 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'add_listener.g.dart'; + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + ref.listenSelf((_, next) => debugPrint('$next')); + return 0; + } + + void add() => state++; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart new file mode 100644 index 000000000..9f4c200ed --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'add_listener.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'9acd382ed579c545ace755687b155e28eba01d22'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx new file mode 100644 index 000000000..6d7ac6d37 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./add_listener.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart new file mode 100644 index 000000000..d032a4c2d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart @@ -0,0 +1,17 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + ref.listenSelf((_, next) => debugPrint('$next')); + return 0; + } + + void add() => state++; +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart new file mode 100644 index 000000000..edb25b5b6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart @@ -0,0 +1,25 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ +class MyNotifier extends StateNotifier { + MyNotifier() : super(0); + + void add() => state++; +} + +final myNotifierProvider = StateNotifierProvider((ref) { + final notifier = MyNotifier(); + + final cleanup = notifier.addListener((state) => debugPrint('$state')); + ref.onDispose(cleanup); + + // 또는, 이와 동일하게: + // final listener = notifier.stream.listen((event) => debugPrint('$event')); + // ref.onDispose(listener.cancel); + + return notifier; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart new file mode 100644 index 000000000..5ead76378 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_notifier.g.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class AsyncTodosNotifier extends _$AsyncTodosNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + // ... +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart new file mode 100644 index 000000000..0fd4946cb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -0,0 +1,75 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(AsyncTodosNotifier) +const asyncTodosNotifierProvider = AsyncTodosNotifierProvider._(); + +final class AsyncTodosNotifierProvider + extends $AsyncNotifierProvider> { + const AsyncTodosNotifierProvider._( + {super.runNotifierBuildOverride, AsyncTodosNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'asyncTodosNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final AsyncTodosNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$asyncTodosNotifierHash(); + + @$internal + @override + AsyncTodosNotifier create() => _createCb?.call() ?? AsyncTodosNotifier(); + + @$internal + @override + AsyncTodosNotifierProvider $copyWithCreate( + AsyncTodosNotifier Function() create, + ) { + return AsyncTodosNotifierProvider._(create: create); + } + + @$internal + @override + AsyncTodosNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + AsyncTodosNotifier, + ) build, + ) { + return AsyncTodosNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$asyncTodosNotifierHash() => + r'10207327c7dee180e9da8beece5bfffedcf86e98'; + +abstract class _$AsyncTodosNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx new file mode 100644 index 000000000..a0ff513c3 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./async_notifier.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart new file mode 100644 index 000000000..ac91d2f88 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart @@ -0,0 +1,31 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class AsyncTodosNotifier extends AsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + // ... +} + +final asyncTodosNotifier = + AsyncNotifierProvider>( + AsyncTodosNotifier.new, +); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart new file mode 100644 index 000000000..50d7f4aed --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart @@ -0,0 +1,30 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class AsyncTodosNotifier extends StateNotifier>> { + AsyncTodosNotifier() : super(const AsyncLoading()) { + _postInit(); + } + + Future _postInit() async { + state = await AsyncValue.guard(() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + }); + } + + // ... +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart new file mode 100644 index 000000000..3e2303b7a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart @@ -0,0 +1,15 @@ +// ignore_for_file: avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'build_init.g.dart'; + +/* SNIPPET START */ +@riverpod +class CounterNotifier extends _$CounterNotifier { + @override + int build() => 0; + + void increment() => state++; + void decrement() => state++; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart new file mode 100644 index 000000000..c180fbb60 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart @@ -0,0 +1,82 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'build_init.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(CounterNotifier) +const counterNotifierProvider = CounterNotifierProvider._(); + +final class CounterNotifierProvider + extends $NotifierProvider { + const CounterNotifierProvider._( + {super.runNotifierBuildOverride, CounterNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CounterNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + CounterNotifier create() => _createCb?.call() ?? CounterNotifier(); + + @$internal + @override + CounterNotifierProvider $copyWithCreate( + CounterNotifier Function() create, + ) { + return CounterNotifierProvider._(create: create); + } + + @$internal + @override + CounterNotifierProvider $copyWithBuild( + int Function( + Ref, + CounterNotifier, + ) build, + ) { + return CounterNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterNotifierHash() => r'8d4e4011da15a0ef79af9622336839a0c9e406ab'; + +abstract class _$CounterNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx new file mode 100644 index 000000000..276a143ac --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./build_init.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart new file mode 100644 index 000000000..9456a84da --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart @@ -0,0 +1,14 @@ +// ignore_for_file: avoid_print + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class CounterNotifier extends Notifier { + @override + int build() => 0; + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = NotifierProvider(CounterNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart new file mode 100644 index 000000000..034b059ec --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart @@ -0,0 +1,15 @@ +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +class CounterNotifier extends StateNotifier { + CounterNotifier() : super(0); + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = + StateNotifierProvider((ref) { + return CounterNotifier(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart new file mode 100644 index 000000000..e358a2e54 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart @@ -0,0 +1,38 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class CounterNotifier extends StateNotifier { + CounterNotifier() : super(0); + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = + StateNotifierProvider((ref) { + return CounterNotifier(); +}); + +/* SNIPPET START */ +class SomeConsumer extends ConsumerWidget { + const SomeConsumer({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + /* highlight-start */ + final counter = ref.watch(counterNotifierProvider); + /* highlight-end */ + return Column( + children: [ + Text("You've counted up until $counter, good job!"), + TextButton( + /* highlight-start */ + onPressed: ref.read(counterNotifierProvider.notifier).increment, + /* highlight-end */ + child: const Text('Count even more!'), + ), + ], + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart new file mode 100644 index 000000000..9a695614c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'family_and_dispose.g.dart'; + +/* SNIPPET START */ +@riverpod +class BugsEncounteredNotifier extends _$BugsEncounteredNotifier { + @override + FutureOr build(String featureId) { + return 99; + } + + Future fix(int amount) async { + final old = await future; + final result = await ref.read(taskTrackerProvider).fix(id: this.featureId, fixed: amount); + state = AsyncData(max(old - result, 0)); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart new file mode 100644 index 000000000..4c6b1cb46 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -0,0 +1,170 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family_and_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(BugsEncounteredNotifier) +const bugsEncounteredNotifierProvider = BugsEncounteredNotifierFamily._(); + +final class BugsEncounteredNotifierProvider + extends $AsyncNotifierProvider { + const BugsEncounteredNotifierProvider._( + {required BugsEncounteredNotifierFamily super.from, + required String super.argument, + super.runNotifierBuildOverride, + BugsEncounteredNotifier Function()? create}) + : _createCb = create, + super( + name: r'bugsEncounteredNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final BugsEncounteredNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$bugsEncounteredNotifierHash(); + + @override + String toString() { + return r'bugsEncounteredNotifierProvider' + '' + '($argument)'; + } + + @$internal + @override + BugsEncounteredNotifier create() => + _createCb?.call() ?? BugsEncounteredNotifier(); + + @$internal + @override + BugsEncounteredNotifierProvider $copyWithCreate( + BugsEncounteredNotifier Function() create, + ) { + return BugsEncounteredNotifierProvider._( + argument: argument as String, + from: from! as BugsEncounteredNotifierFamily, + create: create); + } + + @$internal + @override + BugsEncounteredNotifierProvider $copyWithBuild( + FutureOr Function( + Ref>, + BugsEncounteredNotifier, + ) build, + ) { + return BugsEncounteredNotifierProvider._( + argument: argument as String, + from: from! as BugsEncounteredNotifierFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is BugsEncounteredNotifierProvider && + other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$bugsEncounteredNotifierHash() => + r'c76e924f84db91c57d226896b062d9f4e8ab79e5'; + +final class BugsEncounteredNotifierFamily extends Family { + const BugsEncounteredNotifierFamily._() + : super( + name: r'bugsEncounteredNotifierProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + BugsEncounteredNotifierProvider call( + String featureId, + ) => + BugsEncounteredNotifierProvider._(argument: featureId, from: this); + + @override + String debugGetCreateSourceHash() => _$bugsEncounteredNotifierHash(); + + @override + String toString() => r'bugsEncounteredNotifierProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + BugsEncounteredNotifier Function( + String args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as BugsEncounteredNotifierProvider; + + final argument = provider.argument as String; + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + FutureOr Function(Ref> ref, + BugsEncounteredNotifier notifier, String argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as BugsEncounteredNotifierProvider; + + final argument = provider.argument as String; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(container); + }, + ); + } +} + +abstract class _$BugsEncounteredNotifier extends $AsyncNotifier { + late final _$args = + (ref as $AsyncNotifierProviderElement).origin.argument as String; + String get featureId => _$args; + + FutureOr build( + String featureId, + ); + @$internal + @override + FutureOr runBuild() => build( + _$args, + ); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx new file mode 100644 index 000000000..0780f2135 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./family_and_dispose.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart new file mode 100644 index 000000000..b7068013a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart @@ -0,0 +1,28 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +/* SNIPPET START */ +class BugsEncounteredNotifier extends FamilyAsyncNotifier { + @override + FutureOr build(String featureId) { + return 99; + } + + Future fix(int amount) async { + final old = await future; + final result = + await ref.read(taskTrackerProvider).fix(id: this.arg, fixed: amount); + state = AsyncData(max(old - result, 0)); + } +} + +final bugsEncounteredNotifierProvider = AsyncNotifierProvider.family + .autoDispose( + BugsEncounteredNotifier.new, +); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart new file mode 100644 index 000000000..f01455cf7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart @@ -0,0 +1,32 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../utils.dart'; + +/* SNIPPET START */ +class BugsEncounteredNotifier extends StateNotifier> { + BugsEncounteredNotifier({ + required this.ref, + required this.featureId, + }) : super(const AsyncData(99)); + final String featureId; + final Ref> ref; + + Future fix(int amount) async { + state = await AsyncValue.guard(() async { + final old = state.requireValue; + final result = + await ref.read(taskTrackerProvider).fix(id: featureId, fixed: amount); + return max(old - result, 0); + }); + } +} + +final bugsEncounteredNotifierProvider = StateNotifierProvider.family + .autoDispose, String>((ref, id) { + return BugsEncounteredNotifier(ref: ref, featureId: id); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart new file mode 100644 index 000000000..2c71d6144 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'from_state_provider.g.dart'; + +/* SNIPPET START */ +@riverpod +class CounterNotifier extends _$CounterNotifier { + @override + int build() => 0; + + @override + set state(int newState) => super.state = newState; + int update(int Function(int state) cb) => state = cb(state); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart new file mode 100644 index 000000000..94f793831 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -0,0 +1,82 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'from_state_provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(CounterNotifier) +const counterNotifierProvider = CounterNotifierProvider._(); + +final class CounterNotifierProvider + extends $NotifierProvider { + const CounterNotifierProvider._( + {super.runNotifierBuildOverride, CounterNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CounterNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + CounterNotifier create() => _createCb?.call() ?? CounterNotifier(); + + @$internal + @override + CounterNotifierProvider $copyWithCreate( + CounterNotifier Function() create, + ) { + return CounterNotifierProvider._(create: create); + } + + @$internal + @override + CounterNotifierProvider $copyWithBuild( + int Function( + Ref, + CounterNotifier, + ) build, + ) { + return CounterNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterNotifierHash() => r'b32033040f0fff627f1a6dfd9cfb4e93a842390b'; + +abstract class _$CounterNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx new file mode 100644 index 000000000..f59794999 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./from_state_provider.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart new file mode 100644 index 000000000..ee7eb761e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart @@ -0,0 +1,14 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +class CounterNotifier extends Notifier { + @override + int build() => 0; + + @override + set state(int newState) => super.state = newState; + int update(int Function(int state) cb) => state = cb(state); +} + +final counterNotifierProvider = + NotifierProvider(CounterNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart new file mode 100644 index 000000000..4b4ec6aa4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart @@ -0,0 +1,6 @@ +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ +final counterProvider = StateProvider((ref) { + return 0; +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart new file mode 100644 index 000000000..8bda136f5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart @@ -0,0 +1,34 @@ +// ignore_for_file: unused_local_variable,omit_local_variable_types + +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class MyNotifier extends Notifier { + @override + int build() { + return 0; + } +} + +final myNotifierProvider = + NotifierProvider.autoDispose(MyNotifier.new); + +/* SNIPPET START */ +void main(List args) { + test('my test', () { + final container = ProviderContainer(); + addTearDown(container.dispose); + + // notifier 획득 + /* highlight-start */ + final Notifier notifier = container.read(myNotifierProvider.notifier); + /* highlight-end */ + + // 거기서 노출되는 상태 획득 + /* highlight-start */ + final int state = container.read(myNotifierProvider); + /* highlight-end */ + + // TODO write your tests + }); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx new file mode 100644 index 000000000..9b77f551a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./old_lifecycles.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart new file mode 100644 index 000000000..5dcc4cdae --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart @@ -0,0 +1,39 @@ +// ignore_for_file: library_private_types_in_public_api + +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'old_lifecycles.g.dart'; + +@riverpod +_MyRepo repository(RepositoryRef ref) { + return _MyRepo(); +} + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // 한 곳에서 코드를 읽고 쓰면 됩니다. + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); + // `mounted`는 더 이상 없습니다! + state++; //throw 될 수 있습니다 + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart new file mode 100644 index 000000000..deac12aa7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -0,0 +1,141 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'old_lifecycles.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RepositoryRef = Ref<_MyRepo>; + +@ProviderFor(repository) +const repositoryProvider = RepositoryProvider._(); + +final class RepositoryProvider + extends $FunctionalProvider<_MyRepo, _MyRepo, RepositoryRef> + with $Provider<_MyRepo, RepositoryRef> { + const RepositoryProvider._( + {_MyRepo Function( + RepositoryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'repositoryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final _MyRepo Function( + RepositoryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$repositoryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(_MyRepo value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider<_MyRepo>(value), + ); + } + + @$internal + @override + $ProviderElement<_MyRepo> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RepositoryProvider $copyWithCreate( + _MyRepo Function( + RepositoryRef ref, + ) create, + ) { + return RepositoryProvider._(create: create); + } + + @override + _MyRepo create(RepositoryRef ref) { + final _$cb = _createCb ?? repository; + return _$cb(ref); + } +} + +String _$repositoryHash() => r'e271c7e2cb18076d5eb6d2cd4e47b96a97a35e6f'; + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'0495c52ce893ee0304d4d5ac5648c634ed4a241e'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart new file mode 100644 index 000000000..92e6b49f2 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart @@ -0,0 +1,35 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod/riverpod.dart'; + +import '../../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + // Just read/write the code here, in one place + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); + // `mounted` is no more! + state++; // This might throw. + } +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx new file mode 100644 index 000000000..9823b1564 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./old_lifecycles_final.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart new file mode 100644 index 000000000..130234e2f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart @@ -0,0 +1,41 @@ +// ignore_for_file: library_private_types_in_public_api + +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'old_lifecycles_final.g.dart'; + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +@riverpod +_MyRepo repository(RepositoryRef ref) { + return _MyRepo(); +} + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // 한 곳에서 코드를 읽고 쓰면 됩니다. + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + final cancelToken = CancelToken(); + ref.onDispose(cancelToken.cancel); + await ref.read(repositoryProvider).update(state + 1, token: cancelToken); + // `cancelToken.cancel`이 호출되면 커스텀 예외가 발생합니다. + state++; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart new file mode 100644 index 000000000..76fd303d0 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -0,0 +1,141 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'old_lifecycles_final.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RepositoryRef = Ref<_MyRepo>; + +@ProviderFor(repository) +const repositoryProvider = RepositoryProvider._(); + +final class RepositoryProvider + extends $FunctionalProvider<_MyRepo, _MyRepo, RepositoryRef> + with $Provider<_MyRepo, RepositoryRef> { + const RepositoryProvider._( + {_MyRepo Function( + RepositoryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'repositoryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final _MyRepo Function( + RepositoryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$repositoryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(_MyRepo value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider<_MyRepo>(value), + ); + } + + @$internal + @override + $ProviderElement<_MyRepo> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RepositoryProvider $copyWithCreate( + _MyRepo Function( + RepositoryRef ref, + ) create, + ) { + return RepositoryProvider._(create: create); + } + + @override + _MyRepo create(RepositoryRef ref) { + final _$cb = _createCb ?? repository; + return _$cb(ref); + } +} + +String _$repositoryHash() => r'e271c7e2cb18076d5eb6d2cd4e47b96a97a35e6f'; + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'8ea2586ea29d12306efd4b8b847142136dd20338'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart new file mode 100644 index 000000000..e394e83f6 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart @@ -0,0 +1,36 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod/riverpod.dart'; + +import '../../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + // Just read/write the code here, in one place + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + final cancelToken = CancelToken(); + ref.onDispose(cancelToken.cancel); + await ref.read(repositoryProvider).update(state + 1, token: cancelToken); + state++; + } +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart new file mode 100644 index 000000000..d34838c49 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart @@ -0,0 +1,43 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +import '../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends StateNotifier { + MyNotifier(this.ref, this.period) : super(0) { + // 1 초기화로직 + _timer = Timer.periodic(period, (t) => update()); // 2 초기화시 부가작업 + } + final Duration period; + final Ref ref; + late final Timer _timer; + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); // 3 변이(mutation) + if (mounted) state++; // 4 마운트된 속성 확인 + } + + @override + void dispose() { + _timer.cancel(); // 5 커스텀 폐기(dispose) 로직 + super.dispose(); + } +} + +final myNotifierProvider = StateNotifierProvider((ref) { + // 6 provider 정의 + final period = ref.watch(durationProvider); // 7 리액티브 종속성 로직 + return MyNotifier(ref, period); // 8 `ref`로 연결(pipe down) +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.dart new file mode 100644 index 000000000..ad922b1e3 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.dart @@ -0,0 +1,23 @@ +import 'dart:math' as math; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'utils.g.dart'; + +@riverpod +int random(RandomRef ref) { + return math.Random().nextInt(6); +} + +@riverpod +TaskTrackerRepo taskTracker(TaskTrackerRef ref) => TaskTrackerRepo(); + +class TaskTrackerRepo { + Future fix({required String id, required int fixed}) async => 0; +} + +@riverpod +Duration duration(DurationRef ref) => Duration.zero; + +@riverpod +int availableWater(AvailableWaterRef ref) => 40; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.g.dart new file mode 100644 index 000000000..72f425f1d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.g.dart @@ -0,0 +1,254 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'utils.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RandomRef = Ref; + +@ProviderFor(random) +const randomProvider = RandomProvider._(); + +final class RandomProvider extends $FunctionalProvider + with $Provider { + const RandomProvider._( + {int Function( + RandomRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'randomProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + RandomRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$randomHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RandomProvider $copyWithCreate( + int Function( + RandomRef ref, + ) create, + ) { + return RandomProvider._(create: create); + } + + @override + int create(RandomRef ref) { + final _$cb = _createCb ?? random; + return _$cb(ref); + } +} + +String _$randomHash() => r'789ed69452c1cde06c8a48f69eae2c242e7764ab'; + +typedef TaskTrackerRef = Ref; + +@ProviderFor(taskTracker) +const taskTrackerProvider = TaskTrackerProvider._(); + +final class TaskTrackerProvider extends $FunctionalProvider< + TaskTrackerRepo, + TaskTrackerRepo, + TaskTrackerRef> with $Provider { + const TaskTrackerProvider._( + {TaskTrackerRepo Function( + TaskTrackerRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'taskTrackerProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TaskTrackerRepo Function( + TaskTrackerRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$taskTrackerHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(TaskTrackerRepo value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + TaskTrackerProvider $copyWithCreate( + TaskTrackerRepo Function( + TaskTrackerRef ref, + ) create, + ) { + return TaskTrackerProvider._(create: create); + } + + @override + TaskTrackerRepo create(TaskTrackerRef ref) { + final _$cb = _createCb ?? taskTracker; + return _$cb(ref); + } +} + +String _$taskTrackerHash() => r'd78149146c3a07b78e7dc1d03fa60ed1941c3702'; + +typedef DurationRef = Ref; + +@ProviderFor(duration) +const durationProvider = DurationProvider._(); + +final class DurationProvider + extends $FunctionalProvider + with $Provider { + const DurationProvider._( + {Duration Function( + DurationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'durationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Duration Function( + DurationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$durationHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Duration value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DurationProvider $copyWithCreate( + Duration Function( + DurationRef ref, + ) create, + ) { + return DurationProvider._(create: create); + } + + @override + Duration create(DurationRef ref) { + final _$cb = _createCb ?? duration; + return _$cb(ref); + } +} + +String _$durationHash() => r'00e8192d47835ec451b18bc2cfc1e8610aa5f5c2'; + +typedef AvailableWaterRef = Ref; + +@ProviderFor(availableWater) +const availableWaterProvider = AvailableWaterProvider._(); + +final class AvailableWaterProvider + extends $FunctionalProvider + with $Provider { + const AvailableWaterProvider._( + {int Function( + AvailableWaterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'availableWaterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + AvailableWaterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$availableWaterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + AvailableWaterProvider $copyWithCreate( + int Function( + AvailableWaterRef ref, + ) create, + ) { + return AvailableWaterProvider._(create: create); + } + + @override + int create(AvailableWaterRef ref) { + final _$cb = _createCb ?? availableWater; + return _$cb(ref); + } +} + +String _$availableWaterHash() => r'7d4e8fb0dd7ff52a78eb569b39c4e472c364aac7'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx index bedca4e7f..5143f6f51 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx @@ -2,13 +2,17 @@ title: ChangeNotifierProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import todos from "!!raw-loader!/docs/providers/change_notifier_provider/todos.dart"; import todosConsumer from "!!raw-loader!/docs/providers/change_notifier_provider/todos_consumer.dart"; import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + `ChangeNotifierProvider` (flutter_riverpod/hooks_riverpod only) is a provider that is used to listen to and expose a [ChangeNotifier] from Flutter itself. @@ -18,7 +22,7 @@ Using `ChangeNotifierProvider` is discouraged by Riverpod and exists primarily f - supporting mutable state, even though immutable state is preferred :::info -Prefer using [StateNotifierProvider] instead. +Prefer using [NotifierProvider] instead. Consider using `ChangeNotifierProvider` only if you are absolutely certain that you want mutable state. ::: @@ -45,6 +49,7 @@ with the list of todos in our UI: [state_notifier]: https://pub.dev/packages/state_notifier [statenotifierprovider]: ./state_notifier_provider -[changenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/ChangeNotifier-class.html +[notifierprovider]: ./notifier_provider +[changenotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html [provider]: ./provider [futureprovider]: ./future_provider diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart index 219de4b0a..a88c25c71 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart @@ -32,16 +32,13 @@ class TodosNotifier extends ChangeNotifier { // Let's mark a todo as completed void toggle(String todoId) { - for (final todo in todos) { - if (todo.id == todoId) { - todo.completed = !todo.completed; - notifyListeners(); - } - } + final todo = todos.firstWhere((todo) => todo.id == todoId); + todo.completed = !todo.completed; + notifyListeners(); } } -// Finally, we are using StateNotifierProvider to allow the UI to interact with +// Finally, we are using ChangeNotifierProvider to allow the UI to interact with // our TodosNotifier class. final todosProvider = ChangeNotifierProvider((ref) { return TodosNotifier(); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider.mdx index 934452c51..6f114320a 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider.mdx @@ -3,12 +3,15 @@ title: FutureProvider version: 1 --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import configProvider from "/docs/providers/future_provider/config_provider"; -import configConsumer from "/docs/providers/future_provider/config_consumer"; -import { trimSnippet,AutoSnippet } from "../../../../../src/components/CodeSnippet"; +import configProvider from "./future_provider/config_provider"; +import configConsumer from "./future_provider/config_consumer"; +import { AutoSnippet} from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: `FutureProvider` is the equivalent of [Provider] but for asynchronous code. @@ -25,7 +28,7 @@ ensuring that we always have the most up-to-date value. :::info `FutureProvider` does not offer a way of directly modifying the computation after a user interaction. It is designed to solve simple use-cases. -For more advanced scenarios, consider using [StateNotifierProvider]. +For more advanced scenarios, consider using [AsyncNotifierProvider]. ::: ## Usage example: reading a configuration file @@ -39,6 +42,7 @@ Using Flutter's asset system, this would be: + Then, the UI can listen to configurations like so: @@ -51,7 +55,7 @@ As you can see, listening to a `FutureProvider` inside a widget returns an [AsyncValue] – which allows handling the error/loading states. [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider -[statenotifierprovider]: ./state_notifier_provider +[asyncnotifierprovider]: ./notifier_provider [provider]: ./provider [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html [future]: https://api.dart.dev/dart-async/Future-class.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart index 7f8e854f2..a96f35e72 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart @@ -3,17 +3,14 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import '../config_provider/codegen.dart'; - /* SNIPPET START */ Widget build(BuildContext context, WidgetRef ref) { final config = ref.watch(fetchConfigurationProvider); - return config.when( - loading: () => const CircularProgressIndicator(), - error: (err, stack) => Text('Error: $err'), - data: (config) { - return Text(config.host); - }, - ); + return switch (config) { + AsyncError(:final error) => Text('Error: $error'), + AsyncData(:final value) => Text(value.host), + _ => const CircularProgressIndicator(), + }; } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart index 3844b1540..44d9b4df9 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart @@ -11,12 +11,11 @@ class MyConfiguration extends HookConsumerWidget { Widget build(BuildContext context, WidgetRef ref) { final config = ref.watch(configProvider); return Scaffold( - body: config.when( - loading: () => const Center(child: CircularProgressIndicator()), - error: (err, stack) => Center(child: Text('Error: $err')), - data: (config) { - return Center(child: Text(config.host)); + body: switch (config) { + AsyncError(:final error) => Center(child: Text('Error: $error')), + AsyncData(:final value) => Center(child: Text(value.host)), + _ => const Center(child: CircularProgressIndicator()), }, - ),); + ); } } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart index 9190e55be..ade0628fd 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart @@ -12,13 +12,11 @@ class MyConfiguration extends HookConsumerWidget { Widget build(BuildContext context, WidgetRef ref) { final config = ref.watch(fetchConfigurationProvider); return Scaffold( - body: config.when( - loading: () => const Center(child: CircularProgressIndicator()), - error: (err, stack) => Center(child: Text('Error: $err')), - data: (config) { - return Center(child: Text(config.host)); - }, - ), + body: switch (config) { + AsyncError(:final error) => Center(child: Text('Error: $error')), + AsyncData(:final value) => Center(child: Text(value.host)), + _ => const Center(child: CircularProgressIndicator()), + }, ); } } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart index 4176a3866..9d39f3bcd 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart @@ -10,11 +10,9 @@ import '../config_provider/raw.dart'; Widget build(BuildContext context, WidgetRef ref) { AsyncValue config = ref.watch(configProvider); - return config.when( - loading: () => const CircularProgressIndicator(), - error: (err, stack) => Text('Error: $err'), - data: (config) { - return Text(config.host); - }, - ); + return switch (config) { + AsyncData(:final value) => Text(value.host), + AsyncError(:final error) => Text('Error: $error'), + _ => const CircularProgressIndicator(), + }; } diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx new file mode 100644 index 000000000..4432f874f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx @@ -0,0 +1,55 @@ +--- +title: (Async)NotifierProvider +--- + +import CodeBlock from "@theme/CodeBlock"; +import todos from "./notifier_provider/todos"; +import todosConsumer from "!!raw-loader!/docs/providers/notifier_provider/todos/todos_consumer.dart"; +import remoteTodos from "./notifier_provider/remote_todos"; +import remoteTodosConsumer from "!!raw-loader!/docs/providers/notifier_provider/remote_todos/todos_consumer.dart"; +import { trimSnippet, AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + +[NotifierProvider] is a provider that is used to listen to and expose a [Notifier]. +[AsyncNotifierProvider] is a provider that is used to listen to and expose an [AsyncNotifier]. +[AsyncNotifier] is a [Notifier] that can be asynchronously initialized. +`(Async)NotifierProvider` along with `(Async)Notifier` is Riverpod's recommended solution +for managing state which may change in reaction to a user interaction. + +It is typically used for: + +- exposing a state which can change over time after reacting to custom events. +- centralizing the logic for modifying some state (aka "business logic") in a + single place, improving maintainability over time. + +As a usage example, we could use [NotifierProvider] to implement a todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: + + + +Now that we have defined a [NotifierProvider], we can use it to interact +with the list of todos in our UI: + +{trimSnippet(todosConsumer)} + +As a usage example, we could use [AsyncNotifierProvider] to implement a remote todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: + + + +Now that we have defined a [AsyncNotifierProvider], we can use it to interact +with the list of todos in our UI: + +{trimSnippet(remoteTodosConsumer)} + +[notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html +[notifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/NotifierProvider.html +[asyncnotifier]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifier-class.html +[asyncnotifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifierProvider.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart new file mode 100644 index 000000000..e02195f87 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart @@ -0,0 +1,82 @@ +import 'dart:convert'; + +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +class Http { + Future get(String str) async => str; + Future delete(String str) async => str; + Future post(String str, Map body) async => str; + Future patch(String str, Map body) async => str; +} + +final http = Http(); + +/* SNIPPET START */ + +@freezed +class Todo with _$Todo { + factory Todo({ + required String id, + required String description, + required bool completed, + }) = _Todo; + + factory Todo.fromJson(Map json) => _$TodoFromJson(json); +} + +// This will generates a AsyncNotifier and AsyncNotifierProvider. +// The AsyncNotifier class that will be passed to our AsyncNotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +// Finally, we are using asyncTodosProvider(AsyncNotifierProvider) to allow the UI to +// interact with our Todos class. +@riverpod +class AsyncTodos extends _$AsyncTodos { + Future> _fetchTodo() async { + final json = await http.get('api/todos'); + final todos = jsonDecode(json) as List>; + return todos.map(Todo.fromJson).toList(); + } + + @override + FutureOr> build() async { + // Load initial todo list from the remote repository + return _fetchTodo(); + } + + Future addTodo(Todo todo) async { + // Set the state to loading + state = const AsyncValue.loading(); + // Add the new todo and reload the todo list from the remote repository + state = await AsyncValue.guard(() async { + await http.post('api/todos', todo.toJson()); + return _fetchTodo(); + }); + } + + // Let's allow removing todos + Future removeTodo(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.delete('api/todos/$todoId'); + return _fetchTodo(); + }); + } + + // Let's mark a todo as completed + Future toggle(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.patch( + 'api/todos/$todoId', + {'completed': true}, + ); + return _fetchTodo(); + }); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart new file mode 100644 index 000000000..d1b8a01d5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.freezed.dart @@ -0,0 +1,184 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Todo _$TodoFromJson(Map json) { + return _Todo.fromJson(json); +} + +/// @nodoc +mixin _$Todo { + String get id => throw _privateConstructorUsedError; + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$TodoImpl implements _Todo { + _$TodoImpl( + {required this.id, required this.description, required this.completed}); + + factory _$TodoImpl.fromJson(Map json) => + _$$TodoImplFromJson(json); + + @override + final String id; + @override + final String description; + @override + final bool completed; + + @override + String toString() { + return 'Todo(id: $id, description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.id, id) || other.id == id) && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, id, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); + + @override + Map toJson() { + return _$$TodoImplToJson( + this, + ); + } +} + +abstract class _Todo implements Todo { + factory _Todo( + {required final String id, + required final String description, + required final bool completed}) = _$TodoImpl; + + factory _Todo.fromJson(Map json) = _$TodoImpl.fromJson; + + @override + String get id; + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart new file mode 100644 index 000000000..2b454f4a4 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.g.dart @@ -0,0 +1,91 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$TodoImpl _$$TodoImplFromJson(Map json) => _$TodoImpl( + id: json['id'] as String, + description: json['description'] as String, + completed: json['completed'] as bool, + ); + +Map _$$TodoImplToJson(_$TodoImpl instance) => + { + 'id': instance.id, + 'description': instance.description, + 'completed': instance.completed, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(AsyncTodos) +const asyncTodosProvider = AsyncTodosProvider._(); + +final class AsyncTodosProvider + extends $AsyncNotifierProvider> { + const AsyncTodosProvider._( + {super.runNotifierBuildOverride, AsyncTodos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'asyncTodosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final AsyncTodos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$asyncTodosHash(); + + @$internal + @override + AsyncTodos create() => _createCb?.call() ?? AsyncTodos(); + + @$internal + @override + AsyncTodosProvider $copyWithCreate( + AsyncTodos Function() create, + ) { + return AsyncTodosProvider._(create: create); + } + + @$internal + @override + AsyncTodosProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + AsyncTodos, + ) build, + ) { + return AsyncTodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$asyncTodosHash() => r'fd0d7502a1c17b7cedd2350519649dd680fc48cd'; + +abstract class _$AsyncTodos extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart new file mode 100644 index 000000000..f4455a338 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart @@ -0,0 +1,101 @@ +import 'dart:convert'; + +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Http { + Future get(String str) async => str; + Future delete(String str) async => str; + Future post(String str, Map body) async => str; + Future patch(String str, Map body) async => str; +} + +final http = Http(); + +/* SNIPPET START */ + +// An immutable state is preferred. +// We could also use packages like Freezed to help with the implementation. +@immutable +class Todo { + const Todo({ + required this.id, + required this.description, + required this.completed, + }); + + factory Todo.fromJson(Map map) { + return Todo( + id: map['id'] as String, + description: map['description'] as String, + completed: map['completed'] as bool, + ); + } + + // All properties should be `final` on our class. + final String id; + final String description; + final bool completed; + + Map toJson() => { + 'id': id, + 'description': description, + 'completed': completed, + }; +} + +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +class AsyncTodosNotifier extends AsyncNotifier> { + Future> _fetchTodo() async { + final json = await http.get('api/todos'); + final todos = jsonDecode(json) as List>; + return todos.map(Todo.fromJson).toList(); + } + + @override + Future> build() async { + // Load initial todo list from the remote repository + return _fetchTodo(); + } + + Future addTodo(Todo todo) async { + // Set the state to loading + state = const AsyncValue.loading(); + // Add the new todo and reload the todo list from the remote repository + state = await AsyncValue.guard(() async { + await http.post('api/todos', todo.toJson()); + return _fetchTodo(); + }); + } + + // Let's allow removing todos + Future removeTodo(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.delete('api/todos/$todoId'); + return _fetchTodo(); + }); + } + + // Let's mark a todo as completed + Future toggle(String todoId) async { + state = const AsyncValue.loading(); + state = await AsyncValue.guard(() async { + await http.patch( + 'api/todos/$todoId', + {'completed': true}, + ); + return _fetchTodo(); + }); + } +} + +// Finally, we are using NotifierProvider to allow the UI to interact with +// our TodosNotifier class. +final asyncTodosProvider = + AsyncNotifierProvider>(() { + return AsyncTodosNotifier(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart new file mode 100644 index 000000000..5d00d05d9 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart @@ -0,0 +1,37 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'codegen.dart'; + +/* SNIPPET START */ + +class TodoListView extends ConsumerWidget { + const TodoListView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // rebuild the widget when the todo list changes + final asyncTodos = ref.watch(asyncTodosProvider); + + // Let's render the todos in a scrollable list view + return switch (asyncTodos) { + AsyncData(:final value) => ListView( + children: [ + for (final todo in value) + CheckboxListTile( + value: todo.completed, + // When tapping on the todo, change its completed status + onChanged: (value) { + ref.read(asyncTodosProvider.notifier).toggle(todo.id); + }, + title: Text(todo.description), + ), + ], + ), + AsyncError(:final error) => Text('Error: $error'), + _ => const Center(child: CircularProgressIndicator()), + }; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart new file mode 100644 index 000000000..866ed37bb --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart @@ -0,0 +1,68 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@freezed +class Todo with _$Todo { + factory Todo({ + required String id, + required String description, + required bool completed, + }) = _Todo; +} + +// This will generates a Notifier and NotifierProvider. +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +// Finally, we are using todosProvider(NotifierProvider) to allow the UI to +// interact with our Todos class. +@riverpod +class Todos extends _$Todos { + @override + List build() { + return []; + } + + // Let's allow the UI to add todos. + void addTodo(Todo todo) { + // Since our state is immutable, we are not allowed to do `state.add(todo)`. + // Instead, we should create a new list of todos which contains the previous + // items and the new one. + // Using Dart's spread operator here is helpful! + state = [...state, todo]; + // No need to call "notifyListeners" or anything similar. Calling "state =" + // will automatically rebuild the UI when necessary. + } + + // Let's allow removing todos + void removeTodo(String todoId) { + // Again, our state is immutable. So we're making a new list instead of + // changing the existing list. + state = [ + for (final todo in state) + if (todo.id != todoId) todo, + ]; + } + + // Let's mark a todo as completed + void toggle(String todoId) { + state = [ + for (final todo in state) + // we're marking only the matching todo as completed + if (todo.id == todoId) + // Once more, since our state is immutable, we need to make a copy + // of the todo. We're using our `copyWith` method implemented before + // to help with that. + todo.copyWith(completed: !todo.completed) + else + // other todos are not modified + todo, + ]; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart new file mode 100644 index 000000000..0b73d3548 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.freezed.dart @@ -0,0 +1,166 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$Todo { + String get id => throw _privateConstructorUsedError; + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc + +class _$TodoImpl implements _Todo { + _$TodoImpl( + {required this.id, required this.description, required this.completed}); + + @override + final String id; + @override + final String description; + @override + final bool completed; + + @override + String toString() { + return 'Todo(id: $id, description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.id, id) || other.id == id) && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @override + int get hashCode => Object.hash(runtimeType, id, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); +} + +abstract class _Todo implements Todo { + factory _Todo( + {required final String id, + required final String description, + required final bool completed}) = _$TodoImpl; + + @override + String get id; + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart new file mode 100644 index 000000000..5ce1c142a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Todos) +const todosProvider = TodosProvider._(); + +final class TodosProvider extends $NotifierProvider> { + const TodosProvider._( + {super.runNotifierBuildOverride, Todos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Todos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + Todos create() => _createCb?.call() ?? Todos(); + + @$internal + @override + TodosProvider $copyWithCreate( + Todos Function() create, + ) { + return TodosProvider._(create: create); + } + + @$internal + @override + TodosProvider $copyWithBuild( + List Function( + Ref>, + Todos, + ) build, + ) { + return TodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todosHash() => r'3485c14ec4db07efe5fe52243258a66e6f99b2b4'; + +abstract class _$Todos extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart new file mode 100644 index 000000000..ec3e50308 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart @@ -0,0 +1,85 @@ +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +// An immutable state is preferred. +// We could also use packages like Freezed to help with the implementation. +@immutable +class Todo { + const Todo({ + required this.id, + required this.description, + required this.completed, + }); + + // All properties should be `final` on our class. + final String id; + final String description; + final bool completed; + + // Since Todo is immutable, we implement a method that allows cloning the + // Todo with slightly different content. + Todo copyWith({String? id, String? description, bool? completed}) { + return Todo( + id: id ?? this.id, + description: description ?? this.description, + completed: completed ?? this.completed, + ); + } +} + +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +class TodosNotifier extends Notifier> { + // We initialize the list of todos to an empty list + @override + List build() { + return []; + } + + // Let's allow the UI to add todos. + void addTodo(Todo todo) { + // Since our state is immutable, we are not allowed to do `state.add(todo)`. + // Instead, we should create a new list of todos which contains the previous + // items and the new one. + // Using Dart's spread operator here is helpful! + state = [...state, todo]; + // No need to call "notifyListeners" or anything similar. Calling "state =" + // will automatically rebuild the UI when necessary. + } + + // Let's allow removing todos + void removeTodo(String todoId) { + // Again, our state is immutable. So we're making a new list instead of + // changing the existing list. + state = [ + for (final todo in state) + if (todo.id != todoId) todo, + ]; + } + + // Let's mark a todo as completed + void toggle(String todoId) { + state = [ + for (final todo in state) + // we're marking only the matching todo as completed + if (todo.id == todoId) + // Once more, since our state is immutable, we need to make a copy + // of the todo. We're using our `copyWith` method implemented before + // to help with that. + todo.copyWith(completed: !todo.completed) + else + // other todos are not modified + todo, + ]; + } +} + +// Finally, we are using NotifierProvider to allow the UI to interact with +// our TodosNotifier class. +final todosProvider = NotifierProvider>(() { + return TodosNotifier(); +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart new file mode 100644 index 000000000..192cb9f66 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart @@ -0,0 +1,32 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'codegen.dart'; + +/* SNIPPET START */ + +class TodoListView extends ConsumerWidget { + const TodoListView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // rebuild the widget when the todo list changes + List todos = ref.watch(todosProvider); + + // Let's render the todos in a scrollable list view + return ListView( + children: [ + for (final todo in todos) + CheckboxListTile( + value: todo.completed, + // When tapping on the todo, change its completed status + onChanged: (value) => + ref.read(todosProvider.notifier).toggle(todo.id), + title: Text(todo.description), + ), + ], + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider.mdx index abda9ed16..136c8edbc 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider.mdx @@ -2,15 +2,19 @@ title: Provider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import todo from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo.dart"; -import completedTodos from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart"; -import todosConsumer from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart"; -import unoptimizedPreviousButton from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart"; -import optimizedPreviousButton from "!!raw-loader!/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import todo from "./provider/todo"; +import completedTodos from "./provider/completed_todos"; +import todosConsumer from "!!raw-loader!/docs/providers/provider/todos_consumer.dart"; +import unoptimizedPreviousButton from "./provider/unoptimized_previous_button"; +import optimizedPreviousButton from "./provider/optimized_previous_button"; +import { trimSnippet, AutoSnippet } from "../../../../../src/components/CodeSnippet"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: `Provider` is the most basic of all providers. It creates a value... And that's about it. @@ -31,15 +35,15 @@ Since filtering a list could be slightly expensive, we ideally do not want to filter our list of todos whenever our application re-renders. In this situation, we could use `Provider` to do the filtering for us. -For that, assume that our application has an existing [StateNotifierProvider] +For that, assume that our application has an existing [NotifierProvider] which manipulates a list of todos: -{trimSnippet(todo)} + From there, we can use `Provider` to expose the filtered list of todos, showing only the completed todos: -{trimSnippet(completedTodos)} + With this code, our UI is now able to show the list of the completed todos by listening to `completedTodosProvider`: @@ -73,7 +77,7 @@ current page index, and if that index is equal to 0, we would disable the button This code could be: -{trimSnippet(unoptimizedPreviousButton)} + The issue with this code is that whenever we change the current page, the "previous" button will rebuild. @@ -85,7 +89,7 @@ allowed to go to the previous page directly within the "previous" button. A way to solve this is to extract this logic outside of the widget and into a `Provider`: -{trimSnippet(optimizedPreviousButton)} + By doing this small refactoring, our `PreviousButton` widget will no longer rebuild when the page index changes thanks to `Provider`. @@ -98,4 +102,4 @@ This change both improved the performance of our button and had the interesting benefit of extracting the logic outside of our widget. [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider -[statenotifierprovider]: ./state_notifier_provider +[notifierprovider]: ./notifier_provider diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart new file mode 100644 index 000000000..1a29d96f5 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart @@ -0,0 +1,15 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../todo/todo.dart'; + +part 'completed_todos.g.dart'; + +/* SNIPPET START */ + +@riverpod +List completedTodos(CompletedTodosRef ref) { + final todos = ref.watch(todosProvider); + + // we return only the completed todos + return todos.where((todo) => todo.isCompleted).toList(); +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart new file mode 100644 index 000000000..bf4ddc691 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.g.dart @@ -0,0 +1,73 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'completed_todos.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CompletedTodosRef = Ref>; + +@ProviderFor(completedTodos) +const completedTodosProvider = CompletedTodosProvider._(); + +final class CompletedTodosProvider + extends $FunctionalProvider, List, CompletedTodosRef> + with $Provider, CompletedTodosRef> { + const CompletedTodosProvider._( + {List Function( + CompletedTodosRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'completedTodosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + CompletedTodosRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$completedTodosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CompletedTodosProvider $copyWithCreate( + List Function( + CompletedTodosRef ref, + ) create, + ) { + return CompletedTodosProvider._(create: create); + } + + @override + List create(CompletedTodosRef ref) { + final _$cb = _createCb ?? completedTodos; + return _$cb(ref); + } +} + +String _$completedTodosHash() => r'855706c09268f428696b3b382ae1605818361b83'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx new file mode 100644 index 000000000..11451aa1c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./completed_todos.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart similarity index 60% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart index 9d486731a..e24c48bd5 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart @@ -1,13 +1,13 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'todo.dart'; +import '../todo/raw.dart'; /* SNIPPET START */ final completedTodosProvider = Provider>((ref) { - // todosProvider로부터 모든 할일(todos)목록을 가져옵니다. + // We obtain the list of all todos from the todosProvider final todos = ref.watch(todosProvider); - // 완료된(completed) 할일(todos)들만 반환합니다. + // we return only the completed todos return todos.where((todo) => todo.isCompleted).toList(); }); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx new file mode 100644 index 000000000..fb83c92f1 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./optimized_previous_button.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart new file mode 100644 index 000000000..7d3b8a332 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart @@ -0,0 +1,50 @@ +// A provider that controls the current page +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'optimized_previous_button.g.dart'; + +/* SNIPPET START */ + +@riverpod +class PageIndex extends _$PageIndex { + @override + int build() { + return 0; + } + + void goToPreviousPage() { + state = state - 1; + } +} + +// A provider which computes whether the user is allowed to go to the previous page +@riverpod +/* highlight-start */ +bool canGoToPreviousPage(CanGoToPreviousPageRef ref) { +/* highlight-end */ + return ref.watch(pageIndexProvider) != 0; +} + +class PreviousButton extends ConsumerWidget { + const PreviousButton({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // We are now watching our new Provider + // Our widget is no longer calculating whether we can go to the previous page. +/* highlight-start */ + final canGoToPreviousPage = ref.watch(canGoToPreviousPageProvider); +/* highlight-end */ + + void goToPreviousPage() { + ref.read(pageIndexProvider.notifier).goToPreviousPage(); + } + + return ElevatedButton( + onPressed: canGoToPreviousPage ? goToPreviousPage : null, + child: const Text('previous'), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart new file mode 100644 index 000000000..17a4c444f --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -0,0 +1,142 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'optimized_previous_button.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CanGoToPreviousPageRef = Ref; + +@ProviderFor(canGoToPreviousPage) +const canGoToPreviousPageProvider = CanGoToPreviousPageProvider._(); + +final class CanGoToPreviousPageProvider + extends $FunctionalProvider + with $Provider { + const CanGoToPreviousPageProvider._( + {bool Function( + CanGoToPreviousPageRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'canGoToPreviousPageProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final bool Function( + CanGoToPreviousPageRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$canGoToPreviousPageHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(bool value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CanGoToPreviousPageProvider $copyWithCreate( + bool Function( + CanGoToPreviousPageRef ref, + ) create, + ) { + return CanGoToPreviousPageProvider._(create: create); + } + + @override + bool create(CanGoToPreviousPageRef ref) { + final _$cb = _createCb ?? canGoToPreviousPage; + return _$cb(ref); + } +} + +String _$canGoToPreviousPageHash() => + r'801fe8182a37cd21ae83bdfccbe36c125b4d14fb'; + +@ProviderFor(PageIndex) +const pageIndexProvider = PageIndexProvider._(); + +final class PageIndexProvider extends $NotifierProvider { + const PageIndexProvider._( + {super.runNotifierBuildOverride, PageIndex Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'pageIndexProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final PageIndex Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$pageIndexHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + PageIndex create() => _createCb?.call() ?? PageIndex(); + + @$internal + @override + PageIndexProvider $copyWithCreate( + PageIndex Function() create, + ) { + return PageIndexProvider._(create: create); + } + + @$internal + @override + PageIndexProvider $copyWithBuild( + int Function( + Ref, + PageIndex, + ) build, + ) { + return PageIndexProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$pageIndexHash() => r'59307ecf23b5b2432833da5ad6b312bf36435d0e'; + +abstract class _$PageIndex extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart similarity index 68% rename from website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart index 36be0acf2..a4d3cb4b9 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart @@ -1,4 +1,4 @@ -// Un provider che controlla la pagina corrente +// A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; @@ -7,12 +7,11 @@ import 'package:flutter_riverpod/legacy.dart'; final pageIndexProvider = StateProvider((ref) => 0); -// Un provider che calcola se l'utente è abilitato ad andare alla pagina precedente - +// A provider which computes whether the user is allowed to go to the previous page /* highlight-start */ final canGoToPreviousPageProvider = Provider((ref) { /* highlight-end */ - return ref.watch(pageIndexProvider) == 0; + return ref.watch(pageIndexProvider) != 0; }); class PreviousButton extends ConsumerWidget { @@ -20,11 +19,11 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // Ora osserviamo il nostro nuovo Provider - // Il nostro widget non calcolerà più se possiamo andare alla pagina precedente. - /* highlight-start */ + // We are now watching our new Provider + // Our widget is no longer calculating whether we can go to the previous page. +/* highlight-start */ final canGoToPreviousPage = ref.watch(canGoToPreviousPageProvider); - /* highlight-end */ +/* highlight-end */ void goToPreviousPage() { ref.read(pageIndexProvider.notifier).update((state) => state - 1); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx new file mode 100644 index 000000000..91d9cc4aa --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./todo.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart similarity index 55% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart index 58c675162..11e62bc3a 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart @@ -1,7 +1,6 @@ // ignore_for_file: avoid_positional_boolean_parameters import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ @@ -11,15 +10,18 @@ class Todo { final String description; } -class TodosNotifier extends StateNotifier> { - TodosNotifier() : super([]); +class TodosNotifier extends Notifier> { + @override + List build() { + return []; + } void addTodo(Todo todo) { state = [...state, todo]; } - // TODO "removeTodo"와 같은 다른 메소드들을 추가하기 + // TODO add other methods, such as "removeTodo", ... } -final todosProvider = StateNotifierProvider>((ref) { +final todosProvider = NotifierProvider>(() { return TodosNotifier(); }); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart new file mode 100644 index 000000000..7089bc962 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart @@ -0,0 +1,25 @@ +// ignore_for_file: avoid_positional_boolean_parameters +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo.g.dart'; + +/* SNIPPET START */ + +class Todo { + Todo(this.description, this.isCompleted); + final bool isCompleted; + final String description; +} + +@riverpod +class Todos extends _$Todos { + @override + List build() { + return []; + } + + void addTodo(Todo todo) { + state = [...state, todo]; + } + // TODO add other methods, such as "removeTodo", ... +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart new file mode 100644 index 000000000..7a6997e3e --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Todos) +const todosProvider = TodosProvider._(); + +final class TodosProvider extends $NotifierProvider> { + const TodosProvider._( + {super.runNotifierBuildOverride, Todos Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todosProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Todos Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todosHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + Todos create() => _createCb?.call() ?? Todos(); + + @$internal + @override + TodosProvider $copyWithCreate( + Todos Function() create, + ) { + return TodosProvider._(create: create); + } + + @$internal + @override + TodosProvider $copyWithBuild( + List Function( + Ref>, + Todos, + ) build, + ) { + return TodosProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todosHash() => r'4bd25c3c15bfff56ad6e733bd17ecb7284c4ceb2'; + +abstract class _$Todos extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart index 984a3038e..98d4f53c2 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart @@ -3,12 +3,12 @@ import 'package:flutter/widgets.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'completed_todos.dart'; +import 'completed_todos/completed_todos.dart'; Widget build() { return /* SNIPPET START */ - Consumer(builder: (context, ref, child) { + Consumer(builder: (context, ref, child) { final completedTodos = ref.watch(completedTodosProvider); // TODO a ListView/GridView/...등을 사용하여 todos를 표시하기/* SKIP */ return Container(); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx new file mode 100644 index 000000000..d345d4f5d --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./unoptimized_previous_button.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart similarity index 76% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart rename to website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart index abec2c57c..b670eaae3 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart @@ -1,4 +1,4 @@ -// 현재 페이지를 제어하는 프로바이더 +// A provider that controls the current page import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; @@ -12,8 +12,8 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 만약 첫페이지가 아니라면 이전 버튼이 활성화 됩니다. - final canGoToPreviousPage = ref.watch(pageIndexProvider) == 0; + // if not on first page, the previous button is active + final canGoToPreviousPage = ref.watch(pageIndexProvider) != 0; void goToPreviousPage() { ref.read(pageIndexProvider.notifier).update((state) => state - 1); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart new file mode 100644 index 000000000..f77de56c3 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart @@ -0,0 +1,39 @@ +// A provider that controls the current page +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'unoptimized_previous_button.g.dart'; + +/* SNIPPET START */ + +@riverpod +class PageIndex extends _$PageIndex { + @override + int build() { + return 0; + } + + void goToPreviousPage() { + state = state - 1; + } +} + +class PreviousButton extends ConsumerWidget { + const PreviousButton({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // if not on first page, the previous button is active + final canGoToPreviousPage = ref.watch(pageIndexProvider) != 0; + + void goToPreviousPage() { + ref.read(pageIndexProvider.notifier).goToPreviousPage(); + } + + return ElevatedButton( + onPressed: canGoToPreviousPage ? goToPreviousPage : null, + child: const Text('previous'), + ); + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart new file mode 100644 index 000000000..1ce41d761 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'unoptimized_previous_button.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(PageIndex) +const pageIndexProvider = PageIndexProvider._(); + +final class PageIndexProvider extends $NotifierProvider { + const PageIndexProvider._( + {super.runNotifierBuildOverride, PageIndex Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'pageIndexProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final PageIndex Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$pageIndexHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + PageIndex create() => _createCb?.call() ?? PageIndex(); + + @$internal + @override + PageIndexProvider $copyWithCreate( + PageIndex Function() create, + ) { + return PageIndexProvider._(create: create); + } + + @$internal + @override + PageIndexProvider $copyWithBuild( + int Function( + Ref, + PageIndex, + ) build, + ) { + return PageIndexProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$pageIndexHash() => r'59307ecf23b5b2432833da5ad6b312bf36435d0e'; + +abstract class _$PageIndex extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx index a3cab49e6..ad8b55960 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx @@ -2,17 +2,19 @@ title: StateNotifierProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import todos from "!!raw-loader!/docs/providers/state_notifier_provider/todos.dart"; import todosConsumer from "!!raw-loader!/docs/providers/state_notifier_provider/todos_consumer.dart"; import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + `StateNotifierProvider` is a provider that is used to listen to and expose a -[StateNotifier] (from the package [state_notifier], which Riverpod re-exports). -`StateNotifierProvider` along with [StateNotifier] is Riverpod's recommended solution -for managing state which may change in reaction to a user interaction. +[StateNotifier] (from the package [state_notifier], which Riverpod re-exports). It is typically used for: @@ -21,6 +23,9 @@ It is typically used for: - centralizing the logic for modifying some state (aka "business logic") in a single place, improving maintainability over time. +:::info +Prefer using [NotifierProvider] instead. +::: As a usage example, we could use `StateNotifierProvider` to implement a todo-list. Doing so would allow us to expose methods such as `addTodo` to let the UI @@ -37,3 +42,4 @@ with the list of todos in our UI: [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html [provider]: ./provider [futureprovider]: ./future_provider +[notifierprovider]: ./notifier_provider diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider.mdx index 88340c713..bb65359db 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_provider.mdx @@ -2,8 +2,6 @@ title: StateProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import product from "!!raw-loader!/docs/providers/state_provider/product.dart"; import productListView from "!!raw-loader!/docs/providers/state_provider/product_list_view.dart"; @@ -15,9 +13,15 @@ import updateReadTwice from "!!raw-loader!/docs/providers/state_provider/update_ import updateReadOnce from "!!raw-loader!/docs/providers/state_provider/update_read_once.dart"; import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + `StateProvider` is a provider that exposes a way to modify its state. -It is a simplification of [StateNotifierProvider], designed to avoid -having to write a [StateNotifier] class for very simple use-cases. +It is a simplification of [NotifierProvider], designed to avoid +having to write a [Notifier] class for very simple use-cases. `StateProvider` exists primarily to allow the modification of **simple** variables by the User Interface. @@ -34,10 +38,10 @@ You should not use `StateProvider` if: - your state is a complex object (such as a custom class, a list/map, ...) - the logic for modifying your state is more advanced than a simple `count++`. -For more advanced cases, consider using [StateNotifierProvider] instead and -create a [StateNotifier] class. +For more advanced cases, consider using [NotifierProvider] instead and +create a [Notifier] class. While the initial boilerplate will be a bit larger, having a custom -[StateNotifier] class is critical for the long-term maintainability of your +[Notifier] class is critical for the long-term maintainability of your project – as it centralizes the business logic of your state in a single place. ## Usage example: Changing the filter type using a dropdown @@ -119,7 +123,9 @@ This change achieves the same effect while making the syntax a bit better. [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider [ref.read]: ../concepts/reading#using-refread-to-obtain-the-state-of-a-provider-once [statenotifierprovider]: ./state_notifier_provider +[notifierprovider]: ./notifier_provider [futureprovider]: ./future_provider +[notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html [provider]: ./provider [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx index 5497e32ba..bd40cfc5f 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx @@ -2,12 +2,16 @@ title: StreamProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import configProvider from "/docs/providers/future_provider/config_provider"; -import configConsumer from "/docs/providers/future_provider/config_consumer"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet,AutoSnippet } from "../../../../../src/components/CodeSnippet"; +import streamProvider from "./stream_provider/live_stream_chat_provider"; +import streamConsumer from "!!raw-loader!/docs/providers/stream_provider/live_stream_chat_consumer.dart"; + +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: `StreamProvider` is similar to [FutureProvider] but for [Stream]s instead of [Future]s. @@ -32,6 +36,17 @@ Using `StreamProvider` over [StreamBuilder] has numerous benefits: immediate access to the most up-to-date event. - it allows easily mocking the stream during tests by overriding the `StreamProvider`. +## Usage example: live chat using sockets + +`StreamProvider` is used in when we handle stream of asynchronous data +such as Video Streaming, Weather broadcasting Apis or Live chat as follows: + + + +Then, the UI can listen to live streaming chats like so: + +{trimSnippet(streamConsumer)} + [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider [statenotifierprovider]: ./state_notifier_provider [provider]: ./provider @@ -41,4 +56,4 @@ Using `StreamProvider` over [StreamBuilder] has numerous benefits: [stream]: https://api.dart.dev/dart-async/Stream-class.html [stream.periodic]: https://api.dart.dev/stable/2.15.1/dart-async/Stream/Stream.periodic.html [family]: ../concepts/modifiers/family -[streambuilder]: https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html +[streambuilder]: https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart new file mode 100644 index 000000000..383def216 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart @@ -0,0 +1,25 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'live_stream_chat_provider.dart'; + +/* SNIPPET START */ +Widget build(BuildContext context, WidgetRef ref) { + final liveChats = ref.watch(chatProvider); + + // Like FutureProvider, it is possible to handle loading/error states using AsyncValue.when + return switch (liveChats) { + // Display all the messages in a scrollable list view. + AsyncData(:final value) => ListView.builder( + // Show messages from bottom to top + reverse: true, + itemCount: value.length, + itemBuilder: (context, index) { + final message = value[index]; + return Text(message); + }, + ), + AsyncError(:final error) => Text(error.toString()), + _ => const CircularProgressIndicator(), + }; +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart new file mode 100644 index 000000000..d2bb3ad2a --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider.dart @@ -0,0 +1,18 @@ +import 'dart:convert'; +import 'dart:io'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final chatProvider = StreamProvider>((ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart new file mode 100644 index 000000000..e2e34878c --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart @@ -0,0 +1,23 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +import 'dart:convert'; +import 'dart:io'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +Stream> chat(ChatRef ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +} diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart new file mode 100644 index 000000000..2ceb077d7 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -0,0 +1,66 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ChatRef = Ref>>; + +@ProviderFor(chat) +const chatProvider = ChatProvider._(); + +final class ChatProvider extends $FunctionalProvider>, + Stream>, ChatRef> + with $FutureModifier>, $StreamProvider, ChatRef> { + const ChatProvider._( + {Stream> Function( + ChatRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'chatProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream> Function( + ChatRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$chatHash(); + + @$internal + @override + $StreamProviderElement> $createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ChatProvider $copyWithCreate( + Stream> Function( + ChatRef ref, + ) create, + ) { + return ChatProvider._(create: create); + } + + @override + Stream> create(ChatRef ref) { + final _$cb = _createCb ?? chat; + return _$cb(ref); + } +} + +String _$chatHash() => r'db1302132f90e854fe2f5da9d97d89c9a3c8b858'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart new file mode 100644 index 000000000..beb2bcd05 --- /dev/null +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart @@ -0,0 +1,18 @@ +import 'dart:convert'; +import 'dart:io'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final chatProvider = StreamProvider>((ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +}); diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx deleted file mode 100644 index b725a5b27..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx +++ /dev/null @@ -1,401 +0,0 @@ ---- -title: Provider사용자를 위한 Riverpod 가이드 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import pubspec from "./getting_started/pubspec"; -import dartHelloWorld from "./getting_started/dart_hello_world"; -import helloWorld from "./getting_started/hello_world"; -import dartPubspec from "./getting_started/dart_pubspec"; -import { - trimSnippet, - AutoSnippet, - When, -} from "../../../../src/components/CodeSnippet"; - -This article is designed for people familiar with the [Provider] package who -wants to learn about Riverpod. - -## The relationship between Riverpod and Provider - -Riverpod is designed to be the spiritual successor of Provider. Hence the -name "Riverpod", which is an anagram of "Provider". - -Riverpod was born while searching for solutions to the various technical -limitations that Provider face. Originally, Riverpod was supposed to be a -major version of Provider as a way to solve this problem. But it was -decided against as this would be a decently big breaking change, and -Provider is one of the most used Flutter packages. - -Still, conceptually, Riverpod and Provider are fairly similar. -Both packages fill a similar role. Both try to: - -- cache and dispose some stateful objects -- offer a way to mock those objects during tests -- offer a way for Widgets to listen to those objects in a simple way. - -At the same time, think of Riverpod as what Provider could've been if -it continued to mature for a few years. - -Riverpod fixes various fundamental problems with Provider, such as but not limited to: - -- Significantly simplifying the combination of "providers". - Instead of the tedious and error-prone `ProxyProvider`, Riverpod exposes - simple yet powerful utilites such as [ref.watch] and [ref.listen]. -- Allowing multiple "provider" to expose a value of the same type. - This removes the need for defining custom classes when exposing a - plain `int` or `String` would work just as well. -- Removing the need to re-define providers inside tests. - With Riverpod, providers are ready to use inside tests by default. -- Reducing the over-reliance on "scoping" to dispose objects by offering - alternate ways to dispose objects ([autoDispose]) - While powerful, scoping a provider is fairly advanced and hard to get right. - -... And a lot more. - -The only true downside of Riverpod is that it requires changing the widget type -to work: - -- Instead of extending `StatelessWidget`, with Riverpod you should extend - `ConsumerWidget`. -- Instead of extending `StatefulWidget`, with Riverpod you should extend - `ConsumerStatefulWidget`. - -But this inconvenience is fairly minor in the grand scheme of things. And this -requirement might one day disappear. - -So to answer the question you're probably asking yourself: -**Should I use Provider or Riverpod?** - -You probably should be using Riverpod. -Riverpod is overhaul better designed and could lead to drastic simplifications -of your logic. - -## The difference between Provider and Riverpod - -### Defining providers - -The primary difference between both packages is how "providers" are defined. - -With [Provider], providers are widgets and as such placed inside the widget tree, -typically inside a `MultiProvider`: - -```dart -class Counter extends ChangeNotifier { - ... -} - -void main() { - runApp( - MultiProvider( - providers: [ - ChangeNotifierProvider(create: (context) => Counter()), - ], - child: MyApp(), - ) - ); -} -``` - -With Riverpod, providers are **not** widgets. Instead they are plain Dart objects. -Similarly, providers are defined outside of the widget tree, and instead are declared -as global final variables. - -Also, for Riverpod to work, it is necessary to add a `ProviderScope` widget above the -entire application. As such, the equivalent of the Provider example using Riverpod -would be: - -```dart -// Providers are now top-level variables -final counterProvider = ChangeNotifierProvider((ref) => Counter()); - -void main() { - runApp( - // This widget enables Riverpod for the entire project - ProviderScope( - child: MyApp(), - ), - ); -} -``` - -Notice how the provider definition simply moved up a few lines. - -:::info -Since with Riverpod providers are plain Dart objects, it is possible to use -Riverpod without Flutter. -For example, Riverpod can be used to write command line applications. -::: - -### Reading providers: BuildContext - -With Provider, one way of reading providers is to use a Widget's `BuildContext`. - -For example, if a provider was defined as: - -```dart -Provider(...); -``` - -then reading it using [Provider] is done with: - -```dart -class Example extends StatelessWidget { - @override - Widget build(BuildContext context) { - Model model = context.watch(); - - } -} -``` - -The equivalent in Riverpod would be: - -```dart -final modelProvider = Provider(...); - -class Example extends ConsumerWidget { - @override - Widget build(BuildContext context, WidgetRef ref) { - Model model = ref.watch(modelProvider); - - } -} -``` - -Notice how: - -- Riverpod's snippet extends `ConsumerWidget` instead of `StatelessWidget`. - That different widget type adds one extra parameter to our `build` function: - `WidgetRef`. - -- Instead of `BuildContext.watch`, in Riverpod we do `WidgetRef.watch`, using - the `WidgetRef` which we obtained from `ConsumerWidget`. - -- Riverpod does not rely on generic types. Instead it relies on the variable - created using provider definition. - -Notice too how similar the wording is. Both Provider and Riverpod use the keyword -"watch" to describe "this widget should rebuild when the value changes". - -:::info -Riverpod uses the same terminology as Provider for reading providers. - -- `BuildContext.watch` -> `WidgetRef.watch` -- `BuildContext.read` -> `WidgetRef.read` - -The rules for `context.watch` vs `context.read` applies to Riverpod too: -Inside the `build` method, use "watch". Inside click handlers and other events, -use "read". -::: - -### Reading providers: Consumer - -Provider optionally comes with a widget named `Consumer` (and variants such as `Consumer2`) -for reading providers. - -`Consumer` is helpful as a performance optimization, by allowing more granular rebuilds -of the widget tree – updating only the revelant widgets when the state changes: - -As such, if a provider was defined as: - -```dart -Provider(...); -``` - -Provider allows reading that provider using `Consumer` with: - -```dart -Consumer( - builder: (BuildContext context, Model model, Widget? child) { - - } -) -``` - -Riverpod has the same principle. Riverpod, too, has a widget named `Consumer` -for the exact same purpose. - -If we defined a provider as: - -```dart -final modelProvider = Provider(...); -``` - -Then using `Consumer` we could do: - -```dart -Consumer( - builder: (BuildContext context, WidgetRef ref, Widget? child) { - Model model = ref.watch(modelProvider); - - } -) -``` - -Notice how `Consumer` gives us a `WidgetRef` object. This is the same object -as we saw in the previous part related to `ConsumerWidget`. - -### Combining providers: ProxyProvider with stateless objects - -When using Provider, the official way of combining providers is using the -`ProxyProvider` widget (or variants such as `ProxyProvider2`). - -For example we may define: - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -ChangeNotifierProvider(create: (context) => UserIdNotifier()), -``` - -From there we have two options. We may combine `UserIdNotifier` to create a new -"stateless" provider (typically an immutable value that possibly override ==). -Such as: - -```dart -ProxyProvider( - update: (context, userIdNotifier, _) { - return 'The user ID of the the user is ${userIdNotifier.userId}'; - } -) -``` - -This provider would automatically return a new `String` whenever -`UserIdNotifier.userId` changes. - -We can do something similar in Riverpod, but the syntax is different. -First, in Riverpod, the definition of our `UserIdNotifier` would be: - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -final userIdNotifierProvider = ChangeNotifierProvider( - (ref) => UserIdNotifier(), -), -``` - -From there, to generate our `String` based on the `userId`, we could do: - -```dart -final labelProvider = Provider((ref) { - UserIdNotifier userIdNotifier = ref.watch(userIdNotifierProvider); - return 'The user ID of the the user is ${userIdNotifier.userId}'; -}); -``` - -Notice the line doing `ref.watch(userIdNotifierProvider)`. - -This line of code tells Riverpod to obtain the content of the `userIdNotifierProvider` -and that whenever that value changes, `labelProvider` will be recomputed too. -As such, the `String` emitted by our `labelProvider` will automatically update -whenever the `userId` changes. - -This `ref.watch` line should feel similar. This pattern was covered previously -when explaining [how to read providers inside widgets](#reading-providers-buildcontext). -Indeed, providers are now able to listen to other providers in the same way -that widgets do. - -### Combining providers: ProxyProvider with stateful objects - -When combining providers, another alternative use-case is to expose -stateful objects, such as a `ChangeNotifier` instance. - -For that, we could use `ChangeNotifierProxyProvider` (or variants such as `ChangeNotifierProxyProvider2`). -For example we may define: - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -ChangeNotifierProvider(create: (context) => UserIdNotifier()), -``` - -Then, we can define a new `ChangeNotifier` that is based on `UserIdNotifier.userId`. -For example we could do: - -```dart -class UserNotifier extends ChangeNotifier { - String? _userId; - - void setUserId(String? userId) { - if (userId != _userId) { - print('The user ID changed from $_userId to $userId'); - _userId = userId; - } - } -} - -// ... - -ChangeNotifierProxyProvider( - create: (context) => UserNotifier(), - update: (context, userIdNotifier, userNotifier) { - return userNotifier! - ..setUserId(userIdNotifier.userId); - }, -); -``` - -This new provider creates a single instance of `UserNotifier` (which is never re-constructed) -and prints a string whenever the user ID changes. - -Doing the same thing in provider is achieved differently. -First, in Riverpod, the definition of our `UserIdNotifier` would be: - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -final userIdNotifierProvider = ChangeNotifierProvider( - (ref) => UserIdNotifier(), -), -``` - -From there, the equivalent to the previous `ChangeNotifierProxyProvider` would be: - -```dart -class UserNotifier extends ChangeNotifier {} - -final userNotfierProvider = ChangeNotifierProvider((ref) { - final userNotifier = UserNotifier(); - ref.listen( - userIdNotifierProvider, - (previous, next) { - if (previous?.userId != next.userId) { - print('The user ID changed from ${previous?.userId} to ${next.userId}'); - } - }, - ); - - return userNotifier; -}); -``` - -The core of this snippet is the `ref.listen` line. -This `ref.listen` function is a utility that allows listening to a provider, -and whenever the provider changes, executes a function. - -The `previous` and `next` parameters of that function correspond to the -last value before the provider changed and the new value after it changed. - -[provider]: https://pub.dev/packages/provider -[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider -[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change -[autodispose]: /docs/concepts/modifiers/auto_dispose diff --git a/website/i18n/ko/docusaurus-theme-classic/footer.json b/website/i18n/ko/docusaurus-theme-classic/footer.json index 7c75e9ad7..989954b61 100644 --- a/website/i18n/ko/docusaurus-theme-classic/footer.json +++ b/website/i18n/ko/docusaurus-theme-classic/footer.json @@ -7,9 +7,25 @@ "message": "커뮤니티", "description": "The title of the footer links column with title=Community in the footer" }, + "link.title.Sponsors": { + "message": "스폰서", + "description": "The title of the footer links column with title=Sponsors in the footer" + }, + "link.item.label.Why Riverpod?": { + "message": "왜 Riverpod인가?", + "description": "The label of footer link with label=Why Riverpod? linking to docs/introduction/why_riverpod" + }, "link.item.label.Getting started": { "message": "시작하기", - "description": "The label of footer link with label=Getting started linking to docs/getting_started" + "description": "The label of footer link with label=Getting started linking to docs/introduction/getting_started" + }, + "link.item.label.Discord": { + "message": "Discord", + "description": "The label of footer link with label=Discord linking to https://discord.gg/Bbumvej" + }, + "link.item.label.GitHub": { + "message": "GitHub", + "description": "The label of footer link with label=GitHub linking to https://github.com/rrousselgit/riverpod" }, "link.item.label.Stack Overflow": { "message": "Stack Overflow", @@ -19,12 +35,20 @@ "message": "Twitter", "description": "The label of footer link with label=Twitter linking to https://twitter.com/remi_rousselet" }, - "link.item.label.GitHub": { - "message": "GitHub", - "description": "The label of footer link with label=GitHub linking to https://github.com/rrousselgit/riverpod" + "link.item.label.Code of conduct": { + "message": "행동 강령", + "description": "The label of footer link with label=Code of conduct linking to https://github.com/rrousselGit/riverpod/blob/master/CODE_OF_CONDUCT.md" + }, + "link.item.label.Contributing guide": { + "message": "기여 가이드", + "description": "The label of footer link with label=Contributing guide linking to https://github.com/rrousselGit/riverpod/blob/rework-flow/CONTRIBUTING.md" }, "copyright": { - "message": "Copyright © 2022 Remi Rousselet.
Built with Docusaurus.", + "message": "Copyright © 2024 Remi Rousselet.
Built with Docusaurus.", "description": "The footer copyright" + }, + "logo.alt": { + "message": "Riverpod", + "description": "The alt text of footer logo" } } diff --git a/website/i18n/ko/docusaurus-theme-classic/navbar.json b/website/i18n/ko/docusaurus-theme-classic/navbar.json index ec37a15b5..a016241eb 100644 --- a/website/i18n/ko/docusaurus-theme-classic/navbar.json +++ b/website/i18n/ko/docusaurus-theme-classic/navbar.json @@ -3,6 +3,10 @@ "message": "Riverpod", "description": "The title in the navbar" }, + "logo.alt": { + "message": "Riverpod", + "description": "The alt text of navbar logo" + }, "item.label.Docs": { "message": "문서", "description": "Navbar item with label Docs" @@ -11,4 +15,4 @@ "message": "GitHub", "description": "Navbar item with label GitHub" } -} \ No newline at end of file +} diff --git a/website/i18n/zh-Hans/code.json b/website/i18n/zh-Hans/code.json index 15ced48b9..48b627308 100644 --- a/website/i18n/zh-Hans/code.json +++ b/website/i18n/zh-Hans/code.json @@ -1,46 +1,67 @@ { "home.shared_state_title": { - "message": "任意位置声明共享状态" + "message": "随处声明共享状态" }, "home.shared_state_body": { - "message": "不再需要在你的 {main} 和UI文件之间来回跳转。 {br} 将共享状态的代码放在它所属的位置上，无论是放在独立的package中还是放在需要它的Widget旁边，都不会丢失它的可测试性。", + "message": "无需在 {main} 和 UI 文件之间来回切换。 {br}{br} 只要将共享状态的代码放在它所属位置上，无论是放在独立的 package 中，还是需要它的 widget 旁，都不会丢失可测试性。", "description": "The homepage input placeholder" }, "home.recompute_title": { - "message": "最小粒度更新UI和重新计算状态" + "message": "按需更新状态和重绘 UI" }, "home.recompute_body": { - "message": "我们无需在 {build} 中对列表进行排序或过滤，也不必依赖高级的缓存机制。 {br}{br} 使用 {Provider} 和 {families} 修饰符，那么它只会在你真正需要的时候才发起HTTP请求或整理你的列表。" + "message": "不必在 {build} 方法中执行列表排序或过滤，也不必依赖高级的缓存机制。{br} {br} 使用组合提供者 {Provider} 和 {families} 方法，在你真正需要的时候才去发起 HTTP 请求或者排序列表。" + }, + "home.refactors_title": { + "message": "通过重构简化日常工作" + }, + "home.refactors_body": { + "message": "Riverpod 提供了多种重构提示, 例如 \"Wrap widget in a Consumer\" 等等。 请参阅 {warnings}." + }, + "home.refactors_list_link": { + "message": "重构提示列表" + }, + "home.lint_title": { + "message": "使用 lint 规则保持代码可维护" + }, + "home.lint_body": { + "message": "实现了 Riverpod 定制的 lint 新规则，并且还会不断添加更多规则。这可确保您的代码保持最佳状态。请参阅 {warnings}。" + }, + "home.lint_rules_list_link": { + "message": "lint 规则列表" }, "home.safe_read_title": { - "message": "安全使用Provider" + "message": "安全的读取 providers" }, "home.safe_read_body": { - "message": "使用provider不再导致错误的状态。恰当地使用provider，你可以始终获得一个可靠的结果。 {br}{br} 这在异步操作中也是如此，Riverpod可以让你简洁地处理loading/error状态。" + "message": "读取 provider 永远不会导致异常的状态。如果你编写了读取一个 provider 所需的代码，你将得到一个符合预期的值。 {br} {br}这甚至适用于异步加载的值。与 provider 相反，Riverpod 允许简洁地处理 loading/error 状态。" }, "home.devtool_title": { - "message": "在DevTools中检查状态" + "message": "在 DevTools 中检查你的状态" }, "home.devtool_body": { - "message": "你可以在Flutter的开发工具中一目了然地看到Riverpod的各种状态。 {br} 此外，一款功能更全面的状态检查工具正在开发中。" + "message": "使用了 Riverpod，你的状态将可以在 Flutter 自带的 DevTools 中一目了然。 {br} {br} 此外，一款全面的状态检查工具正在开发中……" + }, + "homepage.declarative_title": { + "message": "声明式编程" }, - "homepage.compile_safe_title": { - "message": "编译安全" + "homepage.declarative_body": { + "message": "以类似于无状态小部件的方式编写业务逻辑。{br} 让您的网络请求在必要时自动重新计算，并使您的逻辑易于重用、组合、维护。" }, - "homepage.compile_safe_body": { - "message": "不再需要关心{ProviderNotFound}或忘记处理加载中的状态。使用Riverpod，你的代码如果能够通过编译，那么就可以使用。" + "homepage.common_ui_patterns_title": { + "message": "轻松实现常见的 UI 模式" }, - "homepage.unlimited_provider_title": { - "message": "没有限制的Provider" + "homepage.common_ui_patterns_body": { + "message": "使用 Riverpod，只需几行代码即可实现常见但复杂的 UI 模式，例如“下拉刷新”、“实时搜索”等。" }, - "homepage.unlimited_provider_body": { - "message": "Riverpod的灵感来自于Provider，且解决一些关键的问题：比如支持多个同类型的provider、异步的provider、在任意地方添加各种provider……" + "homepage.tooling_ready_title": { + "message": "工具准备就绪" }, - "homepage.no_flutter_dependency_title": { - "message": "不依赖于Flutter" + "homepage.tooling_ready_body": { + "message": "Riverpod 通过将常见错误作为编译错误来增强编译器。 它还提供自定义 lint 规则和重构选项。 它甚至有一个用于生成文档的命令行。" }, - "homepage.no_flutter_dependency_body": { - "message": "Riverpod可以在不依赖Flutter的情况下创建、共享和测试Provider。你不需要{BuildContext}就能监听Provider。" + "homepage.features_title": { + "message": "特性" }, "home.tagline": { "message": "响应式缓存和数据绑定框架" @@ -91,10 +112,6 @@ "message": "页面已崩溃。", "description": "The title of the fallback page when the page crashed" }, - "theme.ErrorPageContent.tryAgain": { - "message": "重试", - "description": "The label of the button to try again when the page crashed" - }, "theme.NotFound.title": { "message": "找不到页面", "description": "The title of the 404 page" @@ -187,10 +204,6 @@ "message": "浅色模式", "description": "The name for the light color mode" }, - "theme.docs.breadcrumbs.home": { - "message": "主页面", - "description": "The ARIA label for the home page in the breadcrumbs" - }, "theme.docs.breadcrumbs.navAriaLabel": { "message": "页面路径", "description": "The ARIA label for the breadcrumbs" @@ -216,7 +229,7 @@ "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" }, "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged}「{tagName}」", + "message": "{nDocsTagged} 带 “{tagName}”", "description": "The title of the page for a docs tag" }, "theme.docs.versionBadge.label": { @@ -227,19 +240,19 @@ "description": "The link label to edit the current page" }, "theme.common.headingLinkTitle": { - "message": "标题的直接链接", + "message": "跳转到 {heading}", "description": "Title for link to heading" }, "theme.lastUpdated.atDate": { - "message": "于 {date} ", + "message": "于 {date}", "description": "The words used to describe on which date a page has been last updated" }, "theme.lastUpdated.byUser": { - "message": "由 {user} ", + "message": "由 {user}", "description": "The words used to describe by who the page has been last updated" }, "theme.lastUpdated.lastUpdatedAtBy": { - "message": "最后{byUser}{atDate}更新", + "message": "最后由 {byUser} 在 {atDate} 更新", "description": "The sentence used to display when a page has been last updated, and by who" }, "theme.navbar.mobileVersionsDropdown.label": { @@ -255,7 +268,7 @@ "description": "The ARIA label for close button of announcement bar" }, "theme.blog.sidebar.navAriaLabel": { - "message": "最近博文导航", + "message": "博客最近帖子的导航", "description": "The ARIA label for recent posts in the blog sidebar" }, "theme.CodeBlock.copied": { @@ -275,21 +288,21 @@ "description": "The title attribute for toggle word wrapping button of code block lines" }, "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { - "message": "打开/收起侧边栏菜单「{label}」", + "message": "打开/关闭侧边栏菜单“{label}”", "description": "The ARIA label to toggle the collapsible sidebar category" }, + "theme.NavBar.navAriaLabel": { + "message": "主导航", + "description": "The ARIA label for the main navigation" + }, "theme.navbar.mobileLanguageDropdown.label": { "message": "选择语言", "description": "The label for the mobile language switcher dropdown" }, "theme.TOCCollapsible.toggleButtonLabel": { - "message": "本页总览", + "message": "目录", "description": "The label used by the button on the collapsible TOC component" }, - "theme.blog.post.readingTime.plurals": { - "message": "阅读需 {readingTime} 分钟", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, "theme.blog.post.readMore": { "message": "阅读更多", "description": "The label used in blog post item excerpts to link to full blog posts" @@ -298,6 +311,14 @@ "message": "阅读 {title} 的全文", "description": "The ARIA label for the link to full blog posts from excerpts" }, + "theme.blog.post.readingTime.plurals": { + "message": "阅读至少需要 {readingTime} 分钟", + "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" + }, + "theme.docs.breadcrumbs.home": { + "message": "主页", + "description": "The ARIA label for the home page in the breadcrumbs" + }, "theme.docs.sidebar.collapseButtonTitle": { "message": "收起侧边栏", "description": "The title attribute for collapse button of doc sidebar" @@ -306,6 +327,10 @@ "message": "收起侧边栏", "description": "The title attribute for collapse button of doc sidebar" }, + "theme.docs.sidebar.navAriaLabel": { + "message": "文档侧边栏", + "description": "The ARIA label for the sidebar navigation" + }, "theme.docs.sidebar.closeSidebarButtonAriaLabel": { "message": "关闭导航栏", "description": "The ARIA label for close button of mobile sidebar" @@ -326,6 +351,9 @@ "message": "展开侧边栏", "description": "The ARIA label and title attribute for expand button of doc sidebar" }, + "theme.SearchBar.seeAll": { + "message": "查看所有 {count} 条结果" + }, "theme.SearchBar.label": { "message": "搜索", "description": "The ARIA label and placeholder for search button" @@ -379,7 +407,7 @@ "description": "The ARIA label for the Enter key button that makes the selection" }, "theme.SearchModal.footer.navigateText": { - "message": "导航", + "message": "选择", "description": "The explanatory text of the action for the Arrow up and Arrow down key" }, "theme.SearchModal.footer.navigateUpKeyAriaLabel": { @@ -427,7 +455,7 @@ "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" }, "theme.SearchPage.existingResultsTitle": { - "message": "「{query}」的搜索结果", + "message": "“{query}”的搜索结果", "description": "The search page title for non-empty query" }, "theme.SearchPage.emptyResultsTitle": { @@ -454,8 +482,9 @@ "message": "正在获取新的搜索结果...", "description": "The paragraph for fetching new search results" }, - "theme.SearchBar.seeAll": { - "message": "查看全部 {count} 个结果" + "theme.ErrorPageContent.tryAgain": { + "message": "再试一次", + "description": "The label of the button to try again rendering when the React error boundary captures an error" }, "theme.common.skipToMainContent": { "message": "跳到主要内容", @@ -465,4 +494,4 @@ "message": "标签", "description": "The title of the tag list page" } -} \ No newline at end of file +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json index 80cbbdfe0..5943108db 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json @@ -3,25 +3,33 @@ "message": "Next", "description": "The label for version current" }, - "sidebar.Sidebar.category.All Providers": { - "message": "Provider类型", - "description": "The label for category All Providers in sidebar Sidebar" + "sidebar.Sidebar.category.Introduction": { + "message": "介绍", + "description": "The label for category Introduction in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Riverpod for Provider Users": { + "message": "给 Provider 开发者的 Riverpod 指南", + "description": "The label for category Riverpod for Provider Users in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Essentials": { + "message": "要点", + "description": "The label for category Essentials in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Case studies": { + "message": "应用案例", + "description": "The label for category Case studies in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Advanced topics": { + "message": "进阶内容", + "description": "The label for category Advanced topics in sidebar Sidebar" }, "sidebar.Sidebar.category.Concepts": { "message": "概念", "description": "The label for category Concepts in sidebar Sidebar" }, - "sidebar.Sidebar.category.Modifiers": { - "message": "修饰符", - "description": "The label for category Modifiers in sidebar Sidebar" - }, - "sidebar.Sidebar.category.Guides": { - "message": "指南", - "description": "The label for category Guides in sidebar Sidebar" - }, - "sidebar.Sidebar.category.Migration": { + "sidebar.Sidebar.category.Migration guides": { "message": "迁移指南", - "description": "The label for category Migration in sidebar Sidebar" + "description": "The label for category Migration guides in sidebar Sidebar" }, "sidebar.Sidebar.category.Official examples": { "message": "官方示例", @@ -31,6 +39,22 @@ "message": "第三方示例", "description": "The label for category Third party examples in sidebar Sidebar" }, + "sidebar.Sidebar.category.Concepts (old)": { + "message": "概念（旧）", + "description": "The label for category Concepts (old) in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Modifiers": { + "message": "修饰符", + "description": "The label for category Modifiers in sidebar Sidebar" + }, + "sidebar.Sidebar.category.All Providers (old)": { + "message": "提供者程序类型（旧）", + "description": "The label for category All Providers (old) in sidebar Sidebar" + }, + "sidebar.Sidebar.category.Guides (old)": { + "message": "指南（旧）", + "description": "The label for category Guides (old) in sidebar Sidebar" + }, "sidebar.Sidebar.link.Counter": { "message": "计数器", "description": "The label for link Counter in sidebar Sidebar, linking to https://github.com/rrousselGit/riverpod/tree/master/examples/counter" @@ -60,27 +84,27 @@ "description": "The label for link Dictionary App in sidebar Sidebar, linking to https://github.com/lohanidamodar/fl_dictio" }, "sidebar.Sidebar.link.Time Tracking App (with Firebase)": { - "message": "时间追踪应用 (使用Firebase)", + "message": "时间追踪应用（使用 Firebase）", "description": "The label for link Time Tracking App (with Firebase) in sidebar Sidebar, linking to https://github.com/bizz84/starter_architecture_flutter_firebase" }, "sidebar.Sidebar.link.Firebase Phone Authentication with Riverpod": { - "message": "Firebase Phone Authentication with Riverpod", + "message": "使用 Riverpod 的 Firebase 手机号验证", "description": "The label for link Firebase Phone Authentication with Riverpod in sidebar Sidebar, linking to https://github.com/julienlebren/flutter_firebase_phone_auth_riverpod" }, "sidebar.Sidebar.link.ListView paging with search": { "message": "带搜索栏的列表分页", "description": "The label for link ListView paging with search in sidebar Sidebar, linking to https://github.com/tbm98/flutter_loadmore_search" }, - "sidebar.Sidebar.link.Resocoder's Weather Bloc to Weather Riverpod": { - "message": "Resocoder's Weather Bloc to Weather Riverpod", - "description": "The label for link Resocoder's Weather Bloc to Weather Riverpod in sidebar Sidebar, linking to https://github.com/campanagerald/flutter-bloc-library-v1-tutorial" + "sidebar.Sidebar.link.Resocoder's Weather Bloc to Weather Riverpod V2": { + "message": "Resocoder 的天气应用迁移从 Bloc 到 Riverpod V2", + "description": "The label for link Resocoder's Weather Bloc to Weather Riverpod V2 in sidebar Sidebar, linking to https://github.com/coyksdev/flutter-bloc-library-v1-tutorial" }, "sidebar.Sidebar.link.Blood Pressure Tracker App": { "message": "血压记录应用", "description": "The label for link Blood Pressure Tracker App in sidebar Sidebar, linking to https://github.com/UrosTodosijevic/blood_pressure_tracker" }, "sidebar.Sidebar.link.Firebase Authentication with Riverpod Following Flutter DDD Architecture Pattern": { - "message": "Firebase Authentication with Riverpod Following Flutter DDD Architecture Pattern", + "message": "使用 Riverpod 并遵循领域驱动开发（DDD）架构模式的 Firebase 验证", "description": "The label for link Firebase Authentication with Riverpod Following Flutter DDD Architecture Pattern in sidebar Sidebar, linking to https://github.com/pythonhubpy/firebase_authentication_flutter_DDD" }, "sidebar.Sidebar.link.Todo App with Backup and Restore feature": { @@ -88,15 +112,15 @@ "description": "The label for link Todo App with Backup and Restore feature in sidebar Sidebar, linking to https://github.com/TheAlphaApp/flutter_riverpod_todo_app" }, "sidebar.Sidebar.link.Integrating Hive database with Riverpod (simple example)": { - "message": "将Hive数据库与Riverpod集成 (简单示例)", + "message": "将 Hive 数据库与 Riverpod 集成（简单示例）", "description": "The label for link Integrating Hive database with Riverpod (simple example) in sidebar Sidebar, linking to https://github.com/GitGud31/theme_riverpod_hive" }, "sidebar.Sidebar.link.Browser App with Riverpod": { - "message": "使用Riverpod的浏览器应用", + "message": "使用 Riverpod 的浏览器应用", "description": "The label for link Browser App with Riverpod in sidebar Sidebar, linking to https://github.com/MarioCroSite/simple_browser_app" }, "sidebar.Sidebar.link.GoRouter with Riverpod": { - "message": "将GoRouter与Riverpod集成", + "message": "将 GoRouter 与 Riverpod 集成", "description": "The label for link GoRouter with Riverpod in sidebar Sidebar, linking to https://github.com/lucavenir/go_router_riverpod" }, "sidebar.Sidebar.link.Piano Chords Test": { @@ -104,13 +128,21 @@ "description": "The label for link Piano Chords Test in sidebar Sidebar, linking to https://github.com/akvus/piano_fun" }, "sidebar.Sidebar.link.Movies API App with Caching & Pagination": { - "message": "带缓存和分页功能的电影应用", + "message": "带缓存和分页功能的电影 API 应用", "description": "The label for link Movies API App with Caching & Pagination in sidebar Sidebar, linking to https://github.com/Roaa94/movies_app" }, "sidebar.Sidebar.link.AWS Amplify Storage Gallery App with Riverpod & Freezed": { - "message": "AWS Amplify Storage Gallery App with Riverpod & Freezed", + "message": "使用 Riverpod 和 Freezed 的 AWS Amplify 存储图片应用", "description": "The label for link AWS Amplify Storage Gallery App with Riverpod & Freezed in sidebar Sidebar, linking to https://github.com/offlineprogrammer/amplify_storage_app" }, + "sidebar.Sidebar.link.Clean Architecture demonstration with Riverpod": { + "message": "Riverpod 实现 Clean 架构的示范", + "description": "The label for link Clean Architecture demonstration with Riverpod in sidebar Sidebar, linking to https://github.com/Uuttssaavv/flutter-clean-architecture-riverpod" + }, + "sidebar.Sidebar.link.Delivery App with Google Maps and Live Tracking": { + "message": "具备谷歌地图和在线追踪功能的送货应用", + "description": "The label for link Delivery App with Google Maps and Live Tracking in sidebar Sidebar, linking to https://github.com/AhmedLSayed9/deliverzler" + }, "sidebar.Sidebar.link.API reference": { "message": "API 参考", "description": "The label for link API reference in sidebar Sidebar, linking to https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/hooks_riverpod-library.html" diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_code_generation.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_code_generation.mdx deleted file mode 100644 index 737a92e49..000000000 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_code_generation.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: 关于代码生成 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import fetchUser from "!!raw-loader!./about_codegen/main.dart"; -import rawFetchUser from "!!raw-loader!./about_codegen/raw.dart"; -import { - trimSnippet, - CodeSnippet, -} from "../../../../src/components/CodeSnippet"; - -代码生成是指使用工具为我们生成代码。 -在Dart中，它的缺点是需要额外的步骤来“编译”应用。 -尽管这个问题可能会在不久的将来得到解决， -但Dart团队正在研究并解决这个问题的潜在方案。 - -在Riverpod的上下文中，代码生成就是稍微改变定义“provider”的语法。打个比方，原本我们这样写： - -{trimSnippet(rawFetchUser)} - -使用代码生成，我们会写： - -{trimSnippet(fetchUser)} - -使用Riverpod时，代码生成是完全可选的。 当然你也完全可以不使用。 -与此同时，Riverpod支持代码生成，且推荐你使用它。 - -有关如何安装和使用Riverpod的代码生成器的信息， -请参阅[开始上手](./getting_started)页面。确保在文档的侧边栏中启用代码生成。 - -## 为什么在Riverpod中使用代码生成？ - -你可能在想：“如果在Riverpod中代码生成是可选的，为什么要使用？” - -让你的代码生活更简单。 -这包括但不限于： - -- 更好的语法, 更可读且更灵活，而且还能减少学习曲线。 - - 不需要担心`FutureProvider`、`Provider` 还是其他 provider。仅需写下你的逻辑， - Riverpod将为你选择最合适的provider。 - - 向provider传递参数现在不受限制。不再局限于使用 [family](./concepts/modifiers/family) 和传递单个参数， - 现在可以传递任何形式的参数。这包括命名参数、可选参数甚至默认值。 -- 在Riverpod中编写的代码支持 **有状态热重载**。 -- 更好地调试，通过生成额外的元数据然后用调试器调试。 -- Riverpod的一些功能将只支持代码生成。 - -与此同时，许多应用程序中已经使用了代码生成比如 [Freezed](https://pub.dev/packages/freezed) 或 [json_serializable](https://pub.dev/packages/json_serializable)。 -在这种情况下，你的项目可能已经为代码生成配置好了，使用Riverpod应该很简单。 - -[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html -[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html -[riverpod]: https://github.com/rrousselgit/riverpod -[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod -[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod -[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_hooks.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_hooks.mdx deleted file mode 100644 index 718985c60..000000000 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/about_hooks.mdx +++ /dev/null @@ -1,272 +0,0 @@ ---- -title: 关于钩子 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import pubspec from "./getting_started/pubspec"; -import dartHelloWorld from "./getting_started/dart_hello_world"; -import helloWorld from "./getting_started/hello_world"; -import dartPubspec from "./getting_started/dart_pubspec"; -import { - trimSnippet, - AutoSnippet, - When, -} from "../../../../src/components/CodeSnippet"; - -本页解释了什么是钩子，以及它们如何与Riverpod相关。 - -“Hooks”是独立于Riverpod: [flutter_hooks] 的package中的常用工具。 -尽管 [flutter_hooks] 是一个完全独立的package，与Riverpod没有任何关系(至少没有直接关系)， -但将Riverpod和 [flutter_hooks] 放在一起很常见。 -毕竟，Riverpod和 [flutter_hooks] 是由同一个团队维护的。 - -钩子是完全可选的。特别是如果你刚开始使用Flutter，那么你不必使用钩子。 -虽然它们是很强大的工具，但没有Flutter的那个“味”。 -所以，入门选择使用Flutter和Riverpod这样的搭配。当你有更多相关的经验时，那么你可以回来尝试一下钩子。 - -## 什么是钩子？ - -钩子是在widget中使用的函数。它们被设计为 [StatefulWidget] 的替代品，以使逻辑更具可重用性和可组合性。 - -Hooks是一个来自 [React](https://reactjs.org/) 的概念， -而 [flutter_hooks] 仅仅是Flutter的一个React实现。 -所以是的，在Flutter中钩子可能感觉有点不合适。 -理想情况下，将来我们会有专门为Flutter设计的用钩子解决问题的解决方案。 - -如果说Riverpod的provider是针对“全局”应用状态的，钩子则是针对本地widget的状态。 -钩子通常用于处理有状态的UI对象，如 [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html), -[AnimationController](https://api.flutter.dev/flutter/animation/AnimationController-class.html)。 -它们也可以作为“构建器(builder)”模式的替代品， -用不涉及“嵌套”的替代品来替换 [FutureBuilder](https://api.flutter.dev/flutter/widgets/FutureBuilder-class.html)/[TweenAnimatedBuilder](https://api.flutter.dev/flutter/widgets/TweenAnimationBuilder-class.html) 之类的widget——极大地提高了可读性。 - -一般来说，钩子有助于： - -- 表单 -- 动画 -- 响应用户事件 -- …… - -例如，我们可以使用钩子手动实现淡入动画，其中widget开始时不可见，然后慢慢出现。 - -如果我们使用 [StatefulWidget],，代码看起来会像这样： - -```dart -class FadeIn extends StatefulWidget { - const FadeIn({Key? key, required this.child}) : super(key: key); - - final Widget child; - - @override - State createState() => _FadeInState(); -} - -class _FadeInState extends State with SingleTickerProviderStateMixin { - late final AnimationController animationController = AnimationController( - vsync: this, - duration: const Duration(seconds: 2), - ); - - @override - void initState() { - super.initState(); - animationController.forward(); - } - - @override - void dispose() { - animationController.dispose(); - super.dispose(); - } - - @override - Widget build(BuildContext context) { - return AnimatedBuilder( - animation: animationController, - builder: (context, child) { - return Opacity( - opacity: animationController.value, - child: widget.child, - ); - }, - ); - } -} -``` - -使用钩子会是： - -```dart -class FadeIn extends HookWidget { - const FadeIn({Key? key, required this.child}) : super(key: key); - - final Widget child; - - @override - Widget build(BuildContext context) { - // Create an AnimationController. The controller will automatically be - // disposed when the widget is unmounted. - final animationController = useAnimationController( - duration: const Duration(seconds: 2), - ); - - // useEffect is the equivalent of initState + didUpdateWidget + dispose. - // The callback passed to useEffect is executed the first time the hook is - // invoked, and then whenever the list passed as second parameter changes. - // Since we pass an empty const list here, that's strictly equivalent to `initState`. - useEffect(() { - // start the animation when the widget is first rendered. - animationController.forward(); - // We could optionally return some "dispose" logic here - return null; - }, const []); - - // Tell Flutter to rebuild this widget when the animation updates. - // This is equivalent to AnimatedBuilder - useAnimation(animationController); - - return Opacity( - opacity: animationController.value, - child: child, - ); - } -} -``` - -在这段代码中有一些有趣的事情需要注意： - -- 不存在内存泄漏。这段代码不会在widget重新构建时重新创建一个新的 `AnimationController`， - 并且它在widget销毁时正确地释放控制器。 - -- 在同一个小部件中，可以任意多次地使用钩子。 - 因此，如果我们想要我们可以创建多个 `AnimationController`： - - ```dart - @override - Widget build(BuildContext context) { - final animationController = useAnimationController( - duration: const Duration(seconds: 2), - ); - final anotherController = useAnimationController( - duration: const Duration(seconds: 2), - ); - - ... - } - ``` - - 这创建了两个控制器，但没有任何负面效果。 - -- 如果我们愿意，我们可以将这个逻辑重构为一个单独的可重用函数： - - ```dart - double useFadeIn() { - final animationController = useAnimationController( - duration: const Duration(seconds: 2), - ); - useEffect(() { - animationController.forward(); - return null; - }, const []); - useAnimation(animationController); - return animationController.value; - } - ``` - - 然后我们可以在widget中使用这个函数，只要那个widget是[HookWidget]： - - ```dart - class FadeIn extends HookWidget { - const FadeIn({Key? key, required this.child}) : super(key: key); - - final Widget child; - - @override - Widget build(BuildContext context) { - final fade = useFadeIn(); - - return Opacity(opacity: fade, child: child); - } - } - ``` - - 注意我们的 `useFadeIn` 函数是如何完全独立于我们的 `FadeIn` widget的。 - 如果我们愿意，我们可以在一个完全不同的widget中使用 `useFadeIn` 函数，它仍然也可以工作! - -## 如何使用钩子 - -钩子有独特的约束条件： - -- 它们只能在扩展了 [HookWidget] 的widget的 `build` 方法中使用： - - **正确**: - - ```dart - class Example extends HookWidget { - @override - Widget build(BuildContext context) { - final controller = useAnimationController(); - ... - } - } - ``` - - **错误**: - - ```dart - // 不是一个HookWidget - class Example extends StatelessWidget { - @override - Widget build(BuildContext context) { - final controller = useAnimationController(); - ... - } - } - ``` - - **错误**: - - ```dart - class Example extends HookWidget { - @override - Widget build(BuildContext context) { - return ElevatedButton( - onPressed: () { - // Not _actually_ inside the "build" method, but instead inside - // a user interaction lifecycle (here "on pressed"). - final controller = useAnimationController(); - }, - child: Text('click me'), - ); - } - } - ``` - -- 它们不能在条件语句或循环语句内使用。 - - **错误**: - - ```dart - class Example extends HookWidget { - const Example({required this.condition, super.key}); - final bool condition; - @override - Widget build(BuildContext context) { - if (condition) { - // Hooks should not be used inside "if"s/"for"s, ... - final controller = useAnimationController(); - } - ... - } - } - ``` - -有关钩子的更多信息，请参见 [flutter_hooks]。 - -[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html -[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html -[riverpod]: https://github.com/rrousselgit/riverpod -[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod -[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod -[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select.mdx new file mode 100644 index 000000000..d020b217b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select.mdx @@ -0,0 +1,129 @@ +--- +title: 性能优化 +--- + +import { AutoSnippet } from "@site/src/components/CodeSnippet"; +import select from "./select/select"; + +import selectAsync from "./select/select_async"; + + +通过到目前为止我们所看到的一切，我们已经可以构建一个功能齐全的应用程序。 +但是，您可能对性能有疑问。 + + +在本页中，我们将介绍一些可能优化代码的提示和技巧。 + +:::caution + +在进行任何优化之前，请确保对您的应用程序进行基准测试。 +优化所增加的复杂性可能不值得微小的收益。 +::: + + +## 使用 "select" 过滤小部件或提供者程序的重建。 + + +您已经注意到，默认情况下，只要对象的任何属性发生更改， +使用 `ref.watch` 都会导致消费者程序或提供者程序进行重建。 +例如，观察 `User` 并仅使用其 "name"， +如果 "age" 发生变化，仍然会导致消费者程序重建。 + + +但如果您的使用者仅使用属性的子集， +您希望避免在其他属性更改时重建小部件。 + + +这可以通过使用提供者程序的 `select` 功能来实现。 +这样做时，`ref.watch` 将不再返回完整对象， +而是返回选定的属性。 +现在，仅当这些选定的属性发生变化时， +您的消费者程序或提供者程序才会重建。 + + + +:::info + +您可以根据需要多次调用 `select`。 +您可以为您想要的每个属性自由调用一次。 +::: + +:::caution + +所选属性希望是不可变的对象。 +返回 `List` 然后改变该列表不会触发重建。 +::: + +:::caution + +使用 `select` 会稍微减慢单个读取操作的速度， +并稍微增加代码的复杂性。 +如果那些“其他属性”很少改变，那么可能不值得使用它。 +::: + + +### 选择异步属性​ + + +考虑一种情况，如果您尝试优化一个监听其他提供者程序的提供者程序， +其他提供者程序很可能是异步的。 + + +通常，您可以使用 `ref.watch(anotherProvider.future)` 来获取该值。 +问题是，`select` 将应用于 `AsyncValue` - 这不是您可以等待的事情。 + + +为此，您可以使用 `selectAsync`。它是异步代码所独有的， +并且允许对提供者程序发出的数据执行 `select` 操作。 +它的用法与 `select` 类似，但返回一个 `Future` 类型： + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart new file mode 100644 index 000000000..f0d79bff2 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.dart @@ -0,0 +1,30 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +class User { + late String firstName, lastName; +} + +@riverpod +User example(ExampleRef ref) => User() + ..firstName = 'John' + ..lastName = 'Doe'; + +class ConsumerExample extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 替代这种写法: + // String name = ref.watch(provider).firstName!; + // 我们可以写： + String name = ref.watch(exampleProvider.select((it) => it.firstName)); + // 这将导致 widget 只监听 "firstName" 上的更改。 + + return Text('Hello $name'); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart new file mode 100644 index 000000000..069263edb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/codegen.g.dart @@ -0,0 +1,72 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {User Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final User Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(User value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + User Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + User create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'72881c6147d44adb957180debefe7696d93107f0'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart new file mode 100644 index 000000000..c39bc426d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select/raw.dart @@ -0,0 +1,29 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class User { + late String firstName, lastName; +} + +final provider = Provider( + (ref) => User() + ..firstName = 'John' + ..lastName = 'Doe', +); + +class ConsumerExample extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 替代这种写法： + // String name = ref.watch(provider).firstName!; + // 我们可以写： + String name = ref.watch(provider.select((it) => it.firstName)); + // 这将导致 widget 只监听 "firstName" 上的更改。 + + return Text('Hello $name'); + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart new file mode 100644 index 000000000..5a70b2ee6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart @@ -0,0 +1,28 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors, body_might_complete_normally_nullable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class User { + late String firstName, lastName; +} + +@riverpod +FutureOr user(UserRef ref) { + return User() + ..firstName = 'John' + ..lastName = 'Doe'; +} + +/* SNIPPET START */ +@riverpod +Object? example(ExampleRef ref) async { + // 等待 user 可用，并只监听 "firstName" 属性 + final firstName = await ref.watch( + userProvider.selectAsync((it) => it.firstName), + ); + + // TODO 使用 "firstName" 获取其他信息 +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart new file mode 100644 index 000000000..2ce06d1ae --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.g.dart @@ -0,0 +1,125 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef UserRef = Ref>; + +@ProviderFor(user) +const userProvider = UserProvider._(); + +final class UserProvider + extends $FunctionalProvider, FutureOr, UserRef> + with $FutureModifier, $FutureProvider { + const UserProvider._( + {FutureOr Function( + UserRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'userProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + UserRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$userHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + UserProvider $copyWithCreate( + FutureOr Function( + UserRef ref, + ) create, + ) { + return UserProvider._(create: create); + } + + @override + FutureOr create(UserRef ref) { + final _$cb = _createCb ?? user; + return _$cb(ref); + } +} + +String _$userHash() => r'19a4464690c31301e47fd7bd5bf6ea475c1a73eb'; + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {Object? Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Object? Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Object? value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + Object? Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + Object? create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'1fccbdbec0e3585bc9d3a5709ac88a8919dd78fa'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart new file mode 100644 index 000000000..719f2cf2d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class User { + late String firstName, lastName; +} + +final userProvider = FutureProvider( + (ref) => User() + ..firstName = 'John' + ..lastName = 'Doe', +); +/* SNIPPET START */ +final provider = FutureProvider((ref) async { + // 等待 user 可用，并只监听 "firstName" 属性 + final firstName = await ref.watch( + userProvider.selectAsync((it) => it.firstName), + ); + + // TODO 使用 "firstName" 获取其他信息 +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx new file mode 100644 index 000000000..b5a31fb6c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel.mdx @@ -0,0 +1,278 @@ +--- +title: 网络请求的去抖动或取消 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import homeScreen from "!raw-loader!./cancel/home_screen.dart"; +import extension from "!raw-loader!./cancel/extension.dart"; +import detailScreen from "./cancel/detail_screen"; +import detailScreenCancel from "./cancel/detail_screen_cancel"; +import detailScreenDebounce from "./cancel/detail_screen_debounce"; +import providerWithExtension from "./cancel/provider_with_extension"; + + +随着应用程序变得越来越复杂，同时处理多个网络请求是很常见的。 +例如，用户可能在搜索框中键入内容并为每次击键触发新的请求。 +如果用户打字速度很快，应用程序可能会同时处理许多请求。 + + +或者，用户可能会触发请求，然后在请求完成之前导航到不同的页面。 +在这种情况下，应用程序可能有一个不再需要的正在运行的请求。 + + +要在这些情况下优化性能，您可以使用以下几种技术： + + +- “去抖动”请求。这意味着您要等到用户停止输入一段时间后再发送请求。 + 这可确保即使用户键入速度很快，您也只会针对给定输入发送一个请求。 +- “取消”请求。这意味着如果用户在请求完成之前离开页面，您将取消请求。 + 这可确保您不会浪费时间处理用户永远不会看到的响应。 + + +在 Riverpod 中，这两种技术都可以以类似的方式实现。 +关键是使用 `ref.onDispose` 方法与“自动处置”或 `ref.watch` +结合来实现所需的行为。 + + +为了展示这一点，我们将制作一个包含两个页面的简单应用程序： + + +- 主屏幕，带有打开新页面的按钮 +- 详细信息页面，显示来自 [Bored API](https://www.boredapi.com/) + 的随机活动，并且能够刷新活动。 + 有关如何实现下拉刷新的信息， + 请参阅。 + + +然后我们将实现以下行为： + + +- 如果用户打开详细信息页面然后立即导航回来， + 我们将取消该活动的请求。 +- 如果用户连续多次刷新活动，我们将对请求进行去抖动， + 以便在用户停止刷新后仅发送一个请求。 + + +## 应用​ + + +展示应用程序、打开详细页面和刷新活动的 Gif。 + + +首先，让我们创建应用程序，不进行任何去抖动或取消操作。 +我们不会在这里使用任何花哨的东西，而是坚持使用普通的 `FloatingActionButton` +和 `Navigator.push` 来打开详细信息页面。 + + +首先，让我们从定义主屏幕开始。像往常一样， +我们不要忘记在应用程序的根组件上指定 `ProviderScope` 。 + + + + +然后，让我们定义我们的详细信息页面。 +要获取活动并实施下拉刷新， +请参阅应用案例。 + + + + +## 取消请求 + + +现在我们有了一个可以运行的应用程序，让我们实现取消逻辑。 + + +为此，我们将在用户离开页面时使用 `ref.onDispose` 取消请求。 +为了使其运作，启用提供者程序的自动处置非常重要。 + + +取消请求所需的确切代码取决于 HTTP 客户端。 +在此示例中，我们将使用 `package:http` ， +但相同的原则也适用于其他客户端。 + + +这里的关键点是当用户离开时将调用 `ref.onDispose`。 +这是因为我们的提供者程序不再使用，因此通过自动处置进行了处置。 +因此，我们可以使用此回调来取消请求。 +当使用 `package:http` 时，可以通过关闭 HTTP 客户端来完成。 + + + + +## 请求​去抖 + + +现在我们已经实现了取消，让我们实现去抖动。 +目前，如果用户连续多次刷新活动， +我们将为每次刷新发送一个请求。 + + +从技术上来说，既然我们已经实行了取消，这就不成问题了。 +如果用户连续多次刷新活动， +则当发出新请求时，先前的请求将被取消。 + + +然而，这并不理想。我们仍然发送多个请求， +浪费带宽和服务器资源。 +相反，我们可以做的是延迟我们的请求， +直到用户在固定的时间内停止刷新活动。 + + +这里的逻辑和取消逻辑非常相似。 +我们将再次使用 `ref.onDispose`。然而，这里的想法是， +我们将依靠 `onDispose` 在请求开始之前中止请求， +而不是关闭 HTTP 客户端。 +然后我们会任意等待 500ms，然后再发送请求。 +然后，如果用户在 500 毫秒过去之前再次刷新活动， +将调用 `onDispose` 并中止请求。 + +:::info + +要中止请求，常见的做法是主动抛出。 +在提供者程序被处置后，将提供者程序内部抛出异常是安全的。 +该异常自然会被 Riverpod 捕获并被忽略。 +::: + + + + +## 更进一步：同时做这两件事​ + + +我们现在知道如何取消和取消请求。 +但目前，如果我们想做另一个请求， +我们需要将相同的逻辑复制粘贴到多个位置。这并不理想。 + + +然而，我们可以更进一步，实现一个可重用的实用程序来同时完成这两个任务。 + + +这里的想法是在 `Ref` 上实现一个扩展方法， +该方法将在单个方法中处理取消和去抖。 + + + + +然后我们可以在我们的提供者程序中使用此扩展方法，如下所示： + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart new file mode 100644 index 000000000..e3bf193a2 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.dart @@ -0,0 +1,61 @@ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +/* SNIPPET START */ +@freezed +class Activity with _$Activity { + factory Activity({ + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + factory Activity.fromJson(Map json) => + _$ActivityFromJson(json); +} + +@riverpod +Future activity(ActivityRef ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} + +class DetailPageView extends ConsumerWidget { + const DetailPageView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar( + title: const Text('Detail page'), + ), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const Center(child: CircularProgressIndicator()), + }, + ], + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart new file mode 100644 index 000000000..1020def96 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.freezed.dart @@ -0,0 +1,209 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart new file mode 100644 index 000000000..aec2ffe13 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/codegen.g.dart @@ -0,0 +1,86 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart new file mode 100644 index 000000000..b3ad1faaf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen/raw.dart @@ -0,0 +1,65 @@ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +/* SNIPPET START */ +class Activity { + Activity({ + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + factory Activity.fromJson(Map json) { + return Activity( + activity: json['activity']! as String, + type: json['type']! as String, + participants: json['participants']! as int, + price: json['price']! as double, + ); + } + + final String activity; + final String type; + final int participants; + final double price; +} + +final activityProvider = FutureProvider.autoDispose((ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); + +class DetailPageView extends ConsumerWidget { + const DetailPageView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar( + title: const Text('Detail page'), + ), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const Center(child: CircularProgressIndicator()), + }, + ], + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart new file mode 100644 index 000000000..004f47430 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.dart @@ -0,0 +1,28 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../detail_screen/codegen.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + // 我们使用 package:http 创建一个 HTTP 客户端 + final client = http.Client(); + // 处置时，我们会关闭客户端。 + // 这将取消客户端可能有的任何待处理请求。 + ref.onDispose(client.close); + + // 现在，我们使用客户端提出请求，而不是使用 "get "函数。 + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + // 其余代码与之前的相同 + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart new file mode 100644 index 000000000..66634724c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -0,0 +1,66 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'304864a6b8051925061a2bba397574ec45b94d08'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart new file mode 100644 index 000000000..86d8f9390 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_cancel/raw.dart @@ -0,0 +1,25 @@ +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import '../detail_screen/codegen.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + // 我们使用 package:http 创建一个 HTTP 客户端 + final client = http.Client(); + // 处置时，我们会关闭客户端。 + // 这将取消客户端可能有的任何待处理请求。 + ref.onDispose(client.close); + + // 现在，我们使用客户端提出请求，而不是使用 "get "函数。 + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + // 其余代码与之前的相同 + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart new file mode 100644 index 000000000..69844a261 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.dart @@ -0,0 +1,38 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../detail_screen/codegen.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + // 我们会捕捉提供者程序目前是否已被处置。 + var didDispose = false; + ref.onDispose(() => didDispose = true); + + // 我们将请求延迟 500 毫秒，以等待用户停止刷新。 + await Future.delayed(const Duration(milliseconds: 500)); + + // 如果在延迟期间处理了提供者程序，则意味着用户再次刷新了请求。 + // 我们会抛出一个异常来取消请求。 + // 在这里使用异常是安全的，因为它会被 Riverpod 捕捉到。 + if (didDispose) { + throw Exception('Cancelled'); + } + + // 以下代码与之前的代码片段保持不变 + final client = http.Client(); + ref.onDispose(client.close); + + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart new file mode 100644 index 000000000..7131a0db7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -0,0 +1,66 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'ef908e3b46693862f082769663b14d5369d6e155'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart new file mode 100644 index 000000000..a8f7b76ae --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/detail_screen_debounce/raw.dart @@ -0,0 +1,35 @@ +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import '../detail_screen/codegen.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + // 我们会捕捉提供者程序目前是否已被处置。 + var didDispose = false; + ref.onDispose(() => didDispose = true); + + // 我们将请求延迟 500 毫秒，以等待用户停止刷新。 + await Future.delayed(const Duration(milliseconds: 500)); + + // 如果在延迟期间处理了提供者程序，则意味着用户再次刷新了请求。 + // 我们会抛出一个异常来取消请求。 + // 在这里使用异常是安全的，因为它会被 Riverpod 捕捉到。 + if (didDispose) { + throw Exception('Cancelled'); + } + + // 以下代码与之前的代码片段保持不变 + final client = http.Client(); + ref.onDispose(client.close); + + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart new file mode 100644 index 000000000..2f2becfc5 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart @@ -0,0 +1,32 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +/* SNIPPET START */ +extension DebounceAndCancelExtension on Ref { + /// 等待 [duration]（默认为 500ms）， + /// 然后返回一个 [http.Client]，用于发出请求。 + /// + /// 当提供者程序被处置时，该客户端将自动关闭。 + Future getDebouncedHttpClient([Duration? duration]) async { + // 首先，我们要处理去抖问题。 + var didDispose = false; + onDispose(() => didDispose = true); + + // 我们将请求延迟 500 毫秒，以等待用户停止刷新。 + await Future.delayed(duration ?? const Duration(milliseconds: 500)); + + // 如果在延迟期间处理了提供者程序，则意味着用户再次刷新了请求。 + // 我们会抛出一个异常来取消请求。 + // 在这里使用异常是安全的，因为它会被 Riverpod 捕捉到。 + if (didDispose) { + throw Exception('Cancelled'); + } + + // 现在我们创建客户端，并在处理提供者程序时关闭客户端。 + final client = http.Client(); + onDispose(client.close); + + // 最后，我们返回客户端，让我们的提供者程序提出请求。 + return client; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart new file mode 100644 index 000000000..28f0c50cf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/home_screen.dart @@ -0,0 +1,39 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'detail_screen/codegen.dart'; + +/* SNIPPET START */ +void main() => runApp(const ProviderScope(child: MyApp())); + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return MaterialApp( + routes: { + '/detail-page': (_) => const DetailPageView(), + }, + home: const ActivityView(), + ); + } +} + +class ActivityView extends ConsumerWidget { + const ActivityView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + appBar: AppBar(title: const Text('Home screen')), + body: const Center( + child: Text('Click the button to open the detail page'), + ), + floatingActionButton: FloatingActionButton( + onPressed: () => Navigator.of(context).pushNamed('/detail-page'), + child: const Icon(Icons.add), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart new file mode 100644 index 000000000..4adab910f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.dart @@ -0,0 +1,25 @@ +import 'dart:convert'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../detail_screen/codegen.dart'; +import '../extension.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + // 我们使用之前创建的扩展来获取 HTTP 客户端。 + final client = await ref.getDebouncedHttpClient(); + + // 现在，我们使用客户端而不是 "get "函数来发出请求。 + // 如果用户离开页面，我们的请求自然会被取消。 + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart new file mode 100644 index 000000000..128d538bf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -0,0 +1,66 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'f045dd6e89fde6bbe12a89f243290d289a3e692d'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart new file mode 100644 index 000000000..7e445b37b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/provider_with_extension/raw.dart @@ -0,0 +1,22 @@ +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../detail_screen/codegen.dart'; +import '../extension.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + // 我们使用之前创建的扩展来获取 HTTP 客户端。 + final client = await ref.getDebouncedHttpClient(); + + // 现在，我们使用客户端而不是 "get "函数来发出请求。 + // 如果用户离开页面，我们的请求自然会被取消。 + final response = await client.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx new file mode 100644 index 000000000..c308e42de --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh.mdx @@ -0,0 +1,253 @@ +--- +title: 下拉刷新 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import activity from "./pull_to_refresh/activity"; +import fetchActivity from "./pull_to_refresh/fetch_activity"; +import displayActivity from "!!raw-loader!./pull_to_refresh/display_activity.dart"; +import displayActivity2 from "!!raw-loader!./pull_to_refresh/display_activity2.dart"; +import displayActivity3 from "!!raw-loader!./pull_to_refresh/display_activity3.dart"; +import displayActivity4 from "!!raw-loader!./pull_to_refresh/display_activity4.dart"; +import fullApp from "./pull_to_refresh/full_app"; + + +由于其声明性，Riverpod 本身就支持拉动刷新。 + + +一般来说，拉动刷新可能很复杂，因为有多个问题需要解决： + + +- 第一次进入页面时，我们想要显示一个微调器（spinner）。 + 但在重刷新期间，我们希望显示刷新指示器。 + 我们不应该同时显示刷新指示器_和_微调器。 +- 当刷新挂起时，我们希望显示以前的数据/错误。 +- 只要重刷新发生，我们就需要显示刷新指示器。 + + +让我们看看如何使用 Riverpod 解决这个问题。 +为此，我们将制作一个简单的示例，向用户推荐随机活动。 +并且进行下拉刷新将触发新的建议： + + +上面描述的应用软件工作时的 gif + + +## 制作一个简单的应用程序。​ + + +在实现下拉刷新之前，我们首先需要刷新一些东西。 +我们可以制作一个简单的应用程序，使用 [Bored API](https://www.boredapi.com/) +向用户建议随机活动。 + + +首先，我们定义一个 `Activity` 类： + + + + +该类将负责以类型安全的方式表示建议的活动，并处理 JSON 编码/解码。 +使用 Freezed/json_serialized 不是必需的，但建议使用。 + + +现在，我们要定义一个提供者程序发出 HTTP GET 请求来获取单个活动： + + + + +我们现在可以使用此提供者程序来显示随机活动。 +目前，我们不会处理加载/错误状态，而只是在可用时显示活动： + + + + +## 添加 `RefreshIndicator` + + +现在我们有了一个简单的应用程序，我们可以向它添加一个 `RefreshIndicator`。 +该小部件是一个官方的 Material 小部件，负责在用户下拉屏幕时显示刷新指示器。 + + +使用 `RefreshIndicator` 需要一个可滚动的表面。但到目前为止，我们还没有。 +我们可以通过使用 `ListView`/`GridView`/`SingleChildScrollView` 等等来解决这个问题： + + + + +用户现在可以下拉屏幕。但我们的数据还没有刷新。 + + +## 添加刷新逻辑​ + + +当用户下拉屏幕时，`RefreshIndicator` 将调用 +`onRefresh` 回调。我们可以使用该回调来刷新我们的数据。 +在那里，我们可以使用 `ref.refresh` 刷新我们选择的提供者程序。 + + +**注意**：`onRefresh` 期望返回一个 `Future`。 +刷新完成后，future 的完成非常重要。 + + +为了获得这样的 future，我们可以读取提供者程序的 `.future` 属性。 +这将返回一个 future，该 future 在我们的提供者程序解决后完成。 + + +因此，我们可以将 `RefreshIndicator` 更新为如下所示： + + + + +## 仅在初始加载和处理错误期间显示微调器。 + + +目前，我们的 UI 不处理错误/加载状态。 +相反，当加载/刷新完成时，数据会神奇地弹出。 + + +让我们通过优雅地处理这些状态来改变这一点。有两种情况： + + +- 在初始加载期间，我们希望显示全屏微调器。 +- 在刷新期间，我们希望显示刷新指示器和之前的数据/错误。 + + +幸运的是，当在 Riverpod 中监听异步提供者程序时， +Riverpod 为我们提供了一个 `AsyncValue` ，它提供了我们需要的一切。 + + +然后可以将 `AsyncValue` 与 Dart 3.0 的模式匹配结合起来，如下所示： + + + +:::caution + +我们在这里使用 `valueOrNull`，就像目前一样， +如果处于错误/加载状态，则使用 `value` 会抛出异常。 + + +Riverpod 3.0 将对此进行更改，使 `value` 的行为类似于 `valueOrNull`。 +但现在，让我们坚持使用 `valueOrNull`。 +::: + +:::tip + +请注意我们的模式匹配中 `:final valueOrNull?` 语法的使用。 +只能使用此语法，因为 `activityProvider` 返回不可为 null 的 `Activity`。 + + +如果您的数据可以是 `null`，则可以使用 `AsyncValue(hasData: true, :final valueOrNull)`。 +这将正确处理数据为 `null` 的情况，但需要一些额外的字符。 +::: + + +## 总结：完整的应用 + + +以下是组合了我们迄今为止所涵盖的所有内容的源码： + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart new file mode 100644 index 000000000..ac3e1b17d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.dart @@ -0,0 +1,19 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; + +part 'codegen.g.dart'; +part 'codegen.freezed.dart'; + +/* SNIPPET START */ +@freezed +class Activity with _$Activity { + factory Activity({ + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + factory Activity.fromJson(Map json) => + _$ActivityFromJson(json); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart new file mode 100644 index 000000000..1020def96 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.freezed.dart @@ -0,0 +1,209 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart new file mode 100644 index 000000000..79ae3cd00 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/codegen.g.dart @@ -0,0 +1,25 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart new file mode 100644 index 000000000..42365b7bb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/activity/raw.dart @@ -0,0 +1,24 @@ +/* SNIPPET START */ +class Activity { + Activity({ + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + factory Activity.fromJson(Map json) { + return Activity( + activity: json['activity']! as String, + type: json['type']! as String, + participants: json['participants']! as int, + price: json['price']! as double, + ); + } + + final String activity; + final String type; + final int participants; + final double price; +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart new file mode 100644 index 000000000..4e4d03305 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity.dart @@ -0,0 +1,22 @@ +// ignore_for_file: use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: Center( + // 如果有活动，则显示，否则等待 + child: Text(activity.valueOrNull?.activity ?? ''), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart new file mode 100644 index 000000000..7394ea664 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity2.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + /* highlight-start */ + body: RefreshIndicator( + onRefresh: () async => print('refresh'), + child: ListView( + children: [ + /* highlight-end */ + Text(activity.valueOrNull?.activity ?? ''), + ], + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart new file mode 100644 index 000000000..bc41065fe --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity3.dart @@ -0,0 +1,30 @@ +// ignore_for_file: avoid_print, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + // 通过重刷新调用 "activityProvider.future" 并返回结果， + // 刷新指示器将一直显示，直到获取到新的活动。 + /* highlight-start */ + onRefresh: () => ref.refresh(activityProvider.future), + /* highlight-end */ + child: ListView( + children: [ + Text(activity.valueOrNull?.activity ?? ''), + ], + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart new file mode 100644 index 000000000..42bb2fef4 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/display_activity4.dart @@ -0,0 +1,36 @@ +// ignore_for_file: avoid_print, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity/codegen.dart'; +import 'fetch_activity/codegen.dart'; + +/* SNIPPET START */ +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + // 如果有数据可用，我们就显示它。 + // 请注意，数据在重刷新时仍然可用。 + AsyncValue(:final valueOrNull?) => + Text(valueOrNull.activity), + // 有一个错误，因此我们将其呈现出来。 + AsyncValue(:final error?) => Text('Error: $error'), + // 无数据/错误，因此我们处于加载状态。 + _ => const CircularProgressIndicator(), + }, + ], + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart new file mode 100644 index 000000000..0cec67cba --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.dart @@ -0,0 +1,20 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../activity/codegen.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity(ActivityRef ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart new file mode 100644 index 000000000..92c2fb027 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -0,0 +1,66 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart new file mode 100644 index 000000000..04de1232b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/fetch_activity/raw.dart @@ -0,0 +1,17 @@ +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; + +import '../activity/raw.dart'; + +/* SNIPPET START */ +final activityProvider = FutureProvider.autoDispose((ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart new file mode 100644 index 000000000..b7d53c744 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.dart @@ -0,0 +1,69 @@ +// ignore_for_file: use_key_in_widget_constructors, unreachable_from_main + +/* SNIPPET START */ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; +part 'codegen.freezed.dart'; + +void main() => runApp(ProviderScope(child: MyApp())); + +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return MaterialApp(home: ActivityView()); + } +} + +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => + Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const CircularProgressIndicator(), + }, + ], + ), + ), + ); + } +} + +@riverpod +Future activity(ActivityRef ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(Map.from(json)); +} + +@freezed +class Activity with _$Activity { + factory Activity({ + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + factory Activity.fromJson(Map json) => + _$ActivityFromJson(json); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart new file mode 100644 index 000000000..1020def96 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.freezed.dart @@ -0,0 +1,209 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String activity, String type, int participants, double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart new file mode 100644 index 000000000..aec2ffe13 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -0,0 +1,86 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart new file mode 100644 index 000000000..c4186fb31 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/pull_to_refresh/full_app/raw.dart @@ -0,0 +1,73 @@ +// ignore_for_file: use_key_in_widget_constructors, unreachable_from_main + +/* SNIPPET START */ +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +void main() => runApp(ProviderScope(child: MyApp())); + +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return MaterialApp(home: ActivityView()); + } +} + +class ActivityView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final activity = ref.watch(activityProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Pull to refresh')), + body: RefreshIndicator( + onRefresh: () => ref.refresh(activityProvider.future), + child: ListView( + children: [ + switch (activity) { + AsyncValue(:final valueOrNull?) => + Text(valueOrNull.activity), + AsyncValue(:final error?) => Text('Error: $error'), + _ => const CircularProgressIndicator(), + }, + ], + ), + ), + ); + } +} + +final activityProvider = FutureProvider.autoDispose((ref) async { + final response = await http.get( + Uri.https('www.boredapi.com', '/api/activity'), + ); + + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); + +class Activity { + Activity({ + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + factory Activity.fromJson(Map json) { + return Activity( + activity: json['activity']! as String, + type: json['type']! as String, + participants: json['participants']! as int, + price: json['price']! as double, + ); + } + + final String activity; + final String type; + final int participants; + final double price; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx new file mode 100644 index 000000000..17215217c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_code_generation.mdx @@ -0,0 +1,488 @@ +--- +title: 关于代码生成 +version: 1 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import fetchUser from "!!raw-loader!./about_codegen/main.dart"; +import rawFetchUser from "!!raw-loader!./about_codegen/raw.dart"; +import { Link } from "@site/src/components/Link"; +import { trimSnippet, CodeSnippet } from "@site/src/components/CodeSnippet"; +import syncFn from "!!raw-loader!./about_codegen/provider_type/sync_fn.dart"; +import syncClass from "!!raw-loader!./about_codegen/provider_type/sync_class.dart"; +import asyncFnFuture from "!!raw-loader!./about_codegen/provider_type/async_fn_future.dart"; +import asyncClassFuture from "!!raw-loader!./about_codegen/provider_type/async_class_future.dart"; +import asyncFnStream from "!!raw-loader!./about_codegen/provider_type/async_fn_stream.dart"; +import asyncClassStream from "!!raw-loader!./about_codegen/provider_type/async_class_stream.dart"; +import familyFn from "!!raw-loader!./about_codegen/provider_type/family_fn.dart"; +import familyClass from "!!raw-loader!./about_codegen/provider_type/family_class.dart"; +import provider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/provider.dart"; +import notifierProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/notifier_provider.dart"; +import futureProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/future_provider.dart"; +import asyncNotifierProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/async_notifier_provider.dart"; +import streamProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/stream_provider.dart"; +import streamNotifierProvider from "!!raw-loader!./about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart"; +import autoDisposeCodeGen from "!!raw-loader!./about_codegen/provider_type/auto_dispose.dart"; +import autoDisposeNonCodeGen from "!!raw-loader!./about_codegen/provider_type/non_code_gen/auto_dispose.dart"; +import familyCodeGen from "!!raw-loader!./about_codegen/provider_type/family.dart"; +import familyNonCodeGen from "!!raw-loader!./about_codegen/provider_type/non_code_gen/family.dart"; +const TRANSPARENT_STYLE = { backgroundColor: "transparent" }; +const RED_STYLE = { color: "indianred", fontWeight: "700" }; +const BLUE_STYLE = { color: "rgb(103, 134, 196)", fontWeight: "700" }; +const FONT_16_STYLE = { + fontSize: "16px", + fontWeight: "700", +}; +const BLUE_20_STYLE = { + color: "rgb(103, 134, 196)", + fontSize: "20px", + fontWeight: "700", +}; +const PROVIDER_STYLE = { + textAlign: "center", + fontWeight: "600", + maxWidth: "210px", +}; +const BEFORE_STYLE = { + minWidth: "60px", + textAlign: "center", + fontWeight: "600", + color: "crimson", +}; +const AFTER_STYLE = { + minWidth: "60px", + textAlign: "center", + fontWeight: "600", + color: "rgb(40,180,40)", +}; + + +代码生成是使用工具为我们生成代码的想法。 +在 Dart 中，它的缺点是需要额外的步骤来“编译”应用程序。 +尽管这个问题可能在不久的将来得到解决， +但 Dart 团队正在研究这个问题的潜在解决方案。 + + +在 Riverpod 的上下文中，代码生成是稍微改变定义 "provider" 的语法。例如，代替： + +{trimSnippet(rawFetchUser)} + + +使用代码生成，我们可以编写： + +{trimSnippet(fetchUser)} + + +使用 Riverpod 时，代码生成是完全可选的。 +没有的话完全可以使用 Riverpod。 +同时，Riverpod 支持代码生成并推荐使用它。 + + +有关如何安装和使用 Riverpod 代码生成器的信息， +请参阅页面。 +确保在文档的侧栏中启用代码生成。 + + +## 我应该使用代码生成吗？​ + + +Riverpod 中的代码生成是可选的。 +考虑到这一点，您可能会想是否应该使用它。 + + +答案是：**很可能是的**。 +使用代码生成是使用 Riverpod 的推荐方式。 +这是一种更面向未来的方法，可以让您充分发挥 Riverpod 的潜力。 +与此同时，许多应用程序已经使用 +[Freezed](https://pub.dev/packages/freezed) 或 [json_serializable](https://pub.dev/packages/json_serializable) +等包来生成代码。在这种情况下，您的项目可能已经设置为代码生成， +并且使用 Riverpod 应该很简单。 + + +目前，代码生成是可选的，因为许多人不喜欢 `build_runner`。 +但是，一旦 Dart 中提供了[静态元编程](https://github.com/dart-lang/language/issues/1482)， +`build_runner` 将不再是问题。 +届时，代码生成语法将是 Riverpod 中唯一可用的语法。 + + +如果使用 `build_runner` 对您来说是一个破坏性的事情， +那么只有那时您才应该考虑不使用代码生成。 +但请记住，您将错过一些功能，并且将来您将不得不迁移到代码生成。 +尽管如此，当这种情况发生时， +Riverpod 将提供一个迁移工具，以使过渡尽可能顺利。 + + +## 使用代码生成有什么好处？​ + + +您可能想知道：“如果 Riverpod 中代码生成是可选的，为什么要使用它？” + + +这和其他包的目的一样：让您的生活更轻松。这包括但不限于： + + +- 更好的语法，更具可读性/灵活性，并且学习曲线更短。 + - 无需担心提供者程序的类型。写下您的逻辑，Riverpod 将为您选择最合适的提供者程序。 + - 语法看起来不再像我们定义了“肮脏的全局变量”。相反，我们定义了一个自定义函数/类。 + - 向提供者程序传递参数现在不受限制。 + 您现在可以传递任何参数，而不是仅限于使用 `.family` 并传递单个位置参数。 + 这包括命名参数、可选参数，甚至默认值。 +- 用 Riverpod 编写的代码的**有状态热重载**。 +- 通过生成调试器随后拾取的额外元数据来更好地进行调试。 +- 某些 Riverpod 功能仅在代码生成时可用。 + + +## 语法​ + + +### 定义提供者程序：​ + + +使用代码生成定义提供者程序时，记住以下几点会很有帮助： + + +- 提供者程序可以定义为带注释的函数或 + 带注释的类。它们几乎相同， + 但基于类的提供者程序的优点是包含公共方法，使 + 外部对象能够修改提供者程序的状态（副作用）。 + 函数提供者程序是用于编写基于类的提供者程序的语法糖，只有 `build` 方法， + 因此不能由 UI 修改。 +- 支持所有 Dart 异步原语（Future、FutureOr 和 Stream）。 +- 当函数被标记为async时， + 提供者程序会自动处理错误/加载状态并公开 AsyncValue。 + + + + + + + + + + + + + + + + + + + + + + + +
+ 函数式的 +
+ （不能使用公共方法执行副作用） + 		+ 基于类的 +
+ （可以使用公共方法执行副作用） +
+ + 同步的 + + + {trimSnippet(syncFn)} + + {trimSnippet(syncClass)} +
+ + 异步的 - Future + + + {trimSnippet(asyncFnFuture)} + + {trimSnippet(asyncClassFuture)} +
+ + 异步的 - Stream + + + {trimSnippet(asyncFnStream)} + + {trimSnippet(asyncClassStream)} +
+ + +### 启用/禁用自动处置 autoDispose：​ + + +使用代码生成时，提供者程序默认为 autoDispose。 +这意味着当没有监听器附加到它们（ref.watch/ref.listen）时，它们会自动处理掉自己。 +此默认设置更符合 Riverpod 的理念。 +最初没有使用代码生成变体时，默认情况下 autoDispose 处于关闭状态， +以适应从 `package:provider` 迁移的用户。 + + +如果您想禁用 autoDispose，可以通过将 `keepAlive: true` 传递给注释来实现。 + +{trimSnippet(autoDisposeCodeGen)} + + +### 将参数传递给提供者程序（family）：​ + + +使用代码生成时，我们不再需要依赖 `family` 修饰符将参数传递给提供者程序。 +相反，我们的提供者程序的主函数可以接受任意数量的参数，包括命名、可选或默认值。 +但请注意，这些参数应该仍然具有 == 的一致性。 +这意味着要么应该缓存值，要么应该覆盖 == 参数。 + + + + + + + + + + + + + + +
+ 函数式的 + + 基于类的 +
+ {trimSnippet(familyFn)} + + {trimSnippet(familyClass)} +
+ + +## 从非代码生成变体迁移：​ + + +使用非代码生成变体时，需要手动确定提供者程序的类型。 +以下是转换为代码生成变体的相应选项： + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Provider +
之前 + {trimSnippet(provider)} +
之后 + {trimSnippet(syncFn)} +
+ NotifierProvider +
之前 + {trimSnippet(notifierProvider)} +
之后 + {trimSnippet(syncClass)} +
+ FutureProvider +
之前 + {trimSnippet(futureProvider)} +
之后 + {trimSnippet(asyncFnFuture)} +
+ StreamProvider +
之前 + {trimSnippet(streamProvider)} +
之后 + {trimSnippet(asyncFnStream)} +
+ AsyncNotifierProvider +
之前 + + {trimSnippet(asyncNotifierProvider)} + +
之后 + {trimSnippet(asyncClassFuture)} +
+ StreamNotifierProvider +
之前 + + {trimSnippet(streamNotifierProvider)} + +
之后 + {trimSnippet(asyncClassStream)} +
+ +[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html +[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html +[riverpod]: https://github.com/rrousselgit/riverpod +[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod +[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod +[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks +[build]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier/build.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.dart new file mode 100644 index 000000000..1ccb42807 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.dart @@ -0,0 +1,22 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'main.g.dart'; + +class User { + User.fromJson(Object obj); +} + +class Http { + Future get(String str) async => str; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +Future fetchUser(FetchUserRef ref, {required int userId}) async { + final json = await http.get('api/user/$userId'); + return User.fromJson(json); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.g.dart new file mode 100644 index 000000000..41f67d339 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/main.g.dart @@ -0,0 +1,137 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'main.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef FetchUserRef = Ref>; + +@ProviderFor(fetchUser) +const fetchUserProvider = FetchUserFamily._(); + +final class FetchUserProvider + extends $FunctionalProvider, FutureOr, FetchUserRef> + with $FutureModifier, $FutureProvider { + const FetchUserProvider._( + {required FetchUserFamily super.from, + required int super.argument, + FutureOr Function( + FetchUserRef ref, { + required int userId, + })? create}) + : _createCb = create, + super( + name: r'fetchUserProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + FetchUserRef ref, { + required int userId, + })? _createCb; + + @override + String debugGetCreateSourceHash() => _$fetchUserHash(); + + @override + String toString() { + return r'fetchUserProvider' + '' + '($argument)'; + } + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + FetchUserProvider $copyWithCreate( + FutureOr Function( + FetchUserRef ref, + ) create, + ) { + return FetchUserProvider._( + argument: argument as int, + from: from! as FetchUserFamily, + create: ( + ref, { + required int userId, + }) => + create(ref)); + } + + @override + FutureOr create(FetchUserRef ref) { + final _$cb = _createCb ?? fetchUser; + final argument = this.argument as int; + return _$cb( + ref, + userId: argument, + ); + } + + @override + bool operator ==(Object other) { + return other is FetchUserProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$fetchUserHash() => r'ff427bbb4130a8a6994fa623ae70997f7b0f6bdb'; + +final class FetchUserFamily extends Family { + const FetchUserFamily._() + : super( + name: r'fetchUserProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + FetchUserProvider call({ + required int userId, + }) => + FetchUserProvider._(argument: userId, from: this); + + @override + String debugGetCreateSourceHash() => _$fetchUserHash(); + + @override + String toString() => r'fetchUserProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr Function( + FetchUserRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FetchUserProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart new file mode 100644 index 000000000..2c7affffc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_class_future.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + Future build() async { + return Future.value('foo'); + } + + // 添加改变状态的方法 +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart new file mode 100644 index 000000000..1172a8ca6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_future.g.dart @@ -0,0 +1,73 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_class_future.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $AsyncNotifierProvider { + const ExampleProvider._( + {super.runNotifierBuildOverride, Example Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Example Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + Example create() => _createCb?.call() ?? Example(); + + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._(create: create); + } + + @$internal + @override + ExampleProvider $copyWithBuild( + FutureOr Function( + Ref>, + Example, + ) build, + ) { + return ExampleProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$exampleHash() => r'8a906741b8ea4b9b0d3f0b924779704b3e1773a1'; + +abstract class _$Example extends $AsyncNotifier { + FutureOr build(); + @$internal + @override + FutureOr runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart new file mode 100644 index 000000000..d76d9fd67 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_class_stream.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + Stream build() async* { + yield 'foo'; + } + + // 添加改变状态的方法 +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart new file mode 100644 index 000000000..de860bb63 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_class_stream.g.dart @@ -0,0 +1,73 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_class_stream.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $StreamNotifierProvider { + const ExampleProvider._( + {super.runNotifierBuildOverride, Example Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Example Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + Example create() => _createCb?.call() ?? Example(); + + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._(create: create); + } + + @$internal + @override + ExampleProvider $copyWithBuild( + Stream Function( + Ref>, + Example, + ) build, + ) { + return ExampleProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $StreamNotifierProviderElement $createElement( + ProviderContainer container) => + $StreamNotifierProviderElement(this, container); +} + +String _$exampleHash() => r'4bca936132b77a9a804549f086f33571724b4804'; + +abstract class _$Example extends $StreamNotifier { + Stream build(); + @$internal + @override + Stream runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart new file mode 100644 index 000000000..95fdd909c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_fn_future.g.dart'; + +/* SNIPPET START */ +@riverpod +Future example(ExampleRef ref) async { + return Future.value('foo'); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart new file mode 100644 index 000000000..15a20ea77 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_fn_future.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'e620af6b870a76eea4228989433de0666957d813'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart new file mode 100644 index 000000000..74da790ad --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_fn_stream.g.dart'; + +/* SNIPPET START */ +@riverpod +Stream example(ExampleRef ref) async* { + yield 'foo'; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart new file mode 100644 index 000000000..163bb593f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_fn_stream.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider, Stream, ExampleRef> + with $FutureModifier, $StreamProvider { + const ExampleProvider._( + {Stream Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $StreamProviderElement $createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + Stream Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + Stream create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'8a2b19776fb9bbb1631f898bd6446b57b102dd9d'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart new file mode 100644 index 000000000..7716e905c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.dart @@ -0,0 +1,12 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'auto_dispose.g.dart'; + +/* SNIPPET START */ +// AutoDispose provider (keepAlive 默认为 false) +@riverpod +String example1(Example1Ref ref) => 'foo'; + +// Non autoDispose provider +@Riverpod(keepAlive: true) +String example2(Example2Ref ref) => 'foo'; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart new file mode 100644 index 000000000..a52691df6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -0,0 +1,133 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'auto_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef Example1Ref = Ref; + +@ProviderFor(example1) +const example1Provider = Example1Provider._(); + +final class Example1Provider + extends $FunctionalProvider + with $Provider { + const Example1Provider._( + {String Function( + Example1Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'example1Provider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + Example1Ref ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$example1Hash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Example1Provider $copyWithCreate( + String Function( + Example1Ref ref, + ) create, + ) { + return Example1Provider._(create: create); + } + + @override + String create(Example1Ref ref) { + final _$cb = _createCb ?? example1; + return _$cb(ref); + } +} + +String _$example1Hash() => r'8a5f0865f758792cc8e4f2ca67db334196df6e88'; + +typedef Example2Ref = Ref; + +@ProviderFor(example2) +const example2Provider = Example2Provider._(); + +final class Example2Provider + extends $FunctionalProvider + with $Provider { + const Example2Provider._( + {String Function( + Example2Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'example2Provider', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + Example2Ref ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$example2Hash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Example2Provider $copyWithCreate( + String Function( + Example2Ref ref, + ) create, + ) { + return Example2Provider._(create: create); + } + + @override + String create(Example2Ref ref) { + final _$cb = _createCb ?? example2; + return _$cb(ref); + } +} + +String _$example2Hash() => r'bc25731d759be185125d12d995d0b89b07d1e271'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart new file mode 100644 index 000000000..e1ee685fb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.dart @@ -0,0 +1,7 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family.g.dart'; + +/* SNIPPET START */ +@riverpod +String example(ExampleRef ref, int param) => 'Hello $param'; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart new file mode 100644 index 000000000..016068466 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family.g.dart @@ -0,0 +1,145 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleFamily._(); + +final class ExampleProvider + extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {required ExampleFamily super.from, + required int super.argument, + String Function( + ExampleRef ref, + int param, + )? create}) + : _createCb = create, + super( + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + ExampleRef ref, + int param, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + String toString() { + return r'exampleProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + String Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._( + argument: argument as int, + from: from! as ExampleFamily, + create: ( + ref, + int param, + ) => + create(ref)); + } + + @override + String create(ExampleRef ref) { + final _$cb = _createCb ?? example; + final argument = this.argument as int; + return _$cb( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is ExampleProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$exampleHash() => r'c4f5a651a55bcf34b0c92d98d77436844cbdc097'; + +final class ExampleFamily extends Family { + const ExampleFamily._() + : super( + name: r'exampleProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + ExampleProvider call( + int param, + ) => + ExampleProvider._(argument: param, from: this); + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + String toString() => r'exampleProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + String Function( + ExampleRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart new file mode 100644 index 000000000..bc012e266 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.dart @@ -0,0 +1,17 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family_class.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + String build( + int param1, { + String param2 = 'foo', + }) { + return 'Hello $param1 & param2'; + } + + // 添加改变状态的方法 +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart new file mode 100644 index 000000000..9205ef62a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_class.g.dart @@ -0,0 +1,207 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family_class.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Example) +const exampleProvider = ExampleFamily._(); + +final class ExampleProvider extends $NotifierProvider { + const ExampleProvider._( + {required ExampleFamily super.from, + required ( + int, { + String param2, + }) + super.argument, + super.runNotifierBuildOverride, + Example Function()? create}) + : _createCb = create, + super( + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Example Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + String toString() { + return r'exampleProvider' + '' + '$argument'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Example create() => _createCb?.call() ?? Example(); + + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._( + argument: argument as ( + int, { + String param2, + }), + from: from! as ExampleFamily, + create: create); + } + + @$internal + @override + ExampleProvider $copyWithBuild( + String Function( + Ref, + Example, + ) build, + ) { + return ExampleProvider._( + argument: argument as ( + int, { + String param2, + }), + from: from! as ExampleFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is ExampleProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$exampleHash() => r'c81e9d94e763b25403ab6b7fa03f092003570142'; + +final class ExampleFamily extends Family { + const ExampleFamily._() + : super( + name: r'exampleProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + ExampleProvider call( + int param1, { + String param2 = 'foo', + }) => + ExampleProvider._(argument: ( + param1, + param2: param2, + ), from: this); + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + String toString() => r'exampleProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + Example Function( + ( + int, { + String param2, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleProvider; + + final argument = provider.argument as ( + int, { + String param2, + }); + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + String Function( + Ref ref, + Example notifier, + ( + int, { + String param2, + }) argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleProvider; + + final argument = provider.argument as ( + int, { + String param2, + }); + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(container); + }, + ); + } +} + +abstract class _$Example extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as ( + int, { + String param2, + }); + int get param1 => _$args.$1; + String get param2 => _$args.param2; + + String build( + int param1, { + String param2 = 'foo', + }); + @$internal + @override + String runBuild() => build( + _$args.$1, + param2: _$args.param2, + ); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart new file mode 100644 index 000000000..863df6f40 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.dart @@ -0,0 +1,13 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family_fn.g.dart'; + +/* SNIPPET START */ +@riverpod +String example( + ExampleRef ref, + int param1, { + String param2 = 'foo', +}) { + return 'Hello $param1 & param2'; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart new file mode 100644 index 000000000..a1a795b7c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/family_fn.g.dart @@ -0,0 +1,169 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family_fn.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleFamily._(); + +final class ExampleProvider + extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {required ExampleFamily super.from, + required ( + int, { + String param2, + }) + super.argument, + String Function( + ExampleRef ref, + int param1, { + String param2, + })? create}) + : _createCb = create, + super( + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + ExampleRef ref, + int param1, { + String param2, + })? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + String toString() { + return r'exampleProvider' + '' + '$argument'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + String Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._( + argument: argument as ( + int, { + String param2, + }), + from: from! as ExampleFamily, + create: ( + ref, + int param1, { + String param2 = 'foo', + }) => + create(ref)); + } + + @override + String create(ExampleRef ref) { + final _$cb = _createCb ?? example; + final argument = this.argument as ( + int, { + String param2, + }); + return _$cb( + ref, + argument.$1, + param2: argument.param2, + ); + } + + @override + bool operator ==(Object other) { + return other is ExampleProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$exampleHash() => r'99b3ed3d53932bd1354259200ebf08493af9ada2'; + +final class ExampleFamily extends Family { + const ExampleFamily._() + : super( + name: r'exampleProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + ExampleProvider call( + int param1, { + String param2 = 'foo', + }) => + ExampleProvider._(argument: ( + param1, + param2: param2, + ), from: this); + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @override + String toString() => r'exampleProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + String Function( + ExampleRef ref, + ( + int, { + String param2, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ExampleProvider; + + final argument = provider.argument as ( + int, { + String param2, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart new file mode 100644 index 000000000..908beaf29 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/async_notifier_provider.dart @@ -0,0 +1,16 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = + AsyncNotifierProvider.autoDispose( + ExampleNotifier.new, +); + +class ExampleNotifier extends AsyncNotifier { + @override + Future build() async { + return Future.value('foo'); + } + + // 添加改变状态的方法 +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart new file mode 100644 index 000000000..3a1b26fb5 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/auto_dispose.dart @@ -0,0 +1,12 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +// autoDispose provider +final example1Provider = Provider.autoDispose((ref) { + return 'foo'; +}); + +// non autoDispose provider +final example2Provider = Provider((ref) { + return 'foo'; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart new file mode 100644 index 000000000..a9e59d48d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/family.dart @@ -0,0 +1,6 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = Provider.family((ref, param) { + return 'Hello $param'; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart new file mode 100644 index 000000000..6306a76fb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/future_provider.dart @@ -0,0 +1,7 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = + FutureProvider.autoDispose((ref) async { + return Future.value('foo'); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart new file mode 100644 index 000000000..866a023e9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/notifier_provider.dart @@ -0,0 +1,15 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = NotifierProvider.autoDispose( + ExampleNotifier.new, +); + +class ExampleNotifier extends Notifier { + @override + String build() { + return 'foo'; + } + + // 添加改变状态的方法 +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart new file mode 100644 index 000000000..1f541352a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/provider.dart @@ -0,0 +1,8 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = Provider.autoDispose( + (ref) { + return 'foo'; + }, +); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart new file mode 100644 index 000000000..6b9d381a1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_notifier_provider.dart @@ -0,0 +1,16 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = + StreamNotifierProvider.autoDispose(() { + return ExampleNotifier(); +}); + +class ExampleNotifier extends StreamNotifier { + @override + Stream build() async* { + yield 'foo'; + } + + // 添加改变状态的方法 +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart new file mode 100644 index 000000000..5e7f8463a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/non_code_gen/stream_provider.dart @@ -0,0 +1,7 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final exampleProvider = + StreamProvider.autoDispose((ref) async* { + yield 'foo'; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart new file mode 100644 index 000000000..7974e175a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'sync_class.g.dart'; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + String build() { + return 'foo'; + } + + // 添加改变状态的方法 +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart new file mode 100644 index 000000000..adc2e93df --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_class.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'sync_class.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $NotifierProvider { + const ExampleProvider._( + {super.runNotifierBuildOverride, Example Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Example Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Example create() => _createCb?.call() ?? Example(); + + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._(create: create); + } + + @$internal + @override + ExampleProvider $copyWithBuild( + String Function( + Ref, + Example, + ) build, + ) { + return ExampleProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$exampleHash() => r'c237193ab6d57674973aaa02eb73db6f6822eb26'; + +abstract class _$Example extends $Notifier { + String build(); + @$internal + @override + String runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart new file mode 100644 index 000000000..0d4922734 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'sync_fn.g.dart'; + +/* SNIPPET START */ +@riverpod +String example(ExampleRef ref) { + return 'foo'; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart new file mode 100644 index 000000000..9a6ccdf70 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -0,0 +1,73 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'sync_fn.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {String Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + String Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + String create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'dd4e9043c704a42a3fc025e7fef9515f659fc78a'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/raw.dart new file mode 100644 index 000000000..4630c27ff --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_codegen/raw.dart @@ -0,0 +1,19 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, avoid_unused_constructor_parameters + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class User { + User.fromJson(Object obj); +} + +class Http { + Future get(String str) async => str; +} + +final http = Http(); + +/* SNIPPET START */ +final fetchUserProvider = FutureProvider.autoDispose.family((ref, userId) async { + final json = await http.get('api/user/$userId'); + return User.fromJson(json); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx new file mode 100644 index 000000000..6eadaa2cf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx @@ -0,0 +1,570 @@ +--- +title: 关于 Hooks（钩子） +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import hookAndConsumer from "!!raw-loader!./about_hooks/hook_and_consumer.dart"; +import hookConsumer from "!!raw-loader!./about_hooks/hook_consumer.dart"; +import hookConsumerWidget from "!!raw-loader!./about_hooks/hook_consumer_widget.dart"; +import { CodeSnippet } from "@site/src/components/CodeSnippet"; +import { Link } from "@site/src/components/Link"; + + +本页介绍了什么是 Hooks 以及它们与 Riverpod 的关系。 + + +"Hooks" 是独立于 Riverpod 的单独包中常见的实用程序：[flutter_hooks]。 +虽然 [flutter_hooks] 是一个完全独立的包， +并且与 Riverpod 没有任何关系（至少没有直接关系）， +但通常将 Riverpod 和 [flutter_hooks] 配对在一起。 + + +## 你应该使用 hooks 吗？​ + + +Hooks 是一个强大的工具，但并不适合所有人。 +如果您是 Riverpod 的新手，您可能应该避免使用 hooks。 + + +虽然 hooks 很有用，但对于 Riverpod 来说并不是必需的。 +您不应该为了 Riverpod 开始使用 hooks。 +相反，您开始使用 hooks，是因为您想使用 hooks。 + + +使用 hooks 是一种权衡。它们非常适合生成健壮且可重用的代码， +但它们也是一个需要学习的新概念，一开始可能会令人困惑。 +Hooks 不是 Flutter 的核心概念。因此，它们在 Flutter/Dart 中会感觉格格不入。 + + +## 什么是 Hooks？​ + + +Hooks 是小部件内部使用的函数。它们被设计为 [StatefulWidget] 的替代品， +以使逻辑更加可重用和可组合。 + + +Hooks 是来自 [React](https://reactjs.org/) 的一个概念，[flutter_hooks] +只是 React 实现到 Flutter 的一个端口。 +因此，是的，hooks 在 Flutter 中可能感觉有点不合适。理想情况下， +未来我们会有一个专门为 Flutter 设计的 Hooks 解决问题的解决方案。 + + +如果 Riverpod 的提供者程序用于“全局”应用程序状态，则 Hooks 用于本地小部件状态。 +Hooks 通常用于处理有状态的 UI 对象，例如 [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html)、 +[AnimationController](https://api.flutter.dev/flutter/animation/AnimationController-class.html)。 +它们还可以作为“构建器”模式的替代品，用不涉及“嵌套”的替代方案替换诸如 +[FutureBuilder](https://api.flutter.dev/flutter/widgets/FutureBuilder-class.html)/[TweenAnimatedBuilder](https://api.flutter.dev/flutter/widgets/TweenAnimationBuilder-class.html) +之类的小部件，从而大大提高可读性。 + + +一般来说，钩子有助于： + + +- 表单 +- 动画 +- 对用户事件做出反应 +- …… + + +例如，我们可以使用钩子手动实现淡入动画，其中小部件开始不可见并慢慢出现。 + + +如果我们使用 [StatefulWidget]，代码将如下所示： + +```dart +class FadeIn extends StatefulWidget { + const FadeIn({Key? key, required this.child}) : super(key: key); + + final Widget child; + + @override + State createState() => _FadeInState(); +} + +class _FadeInState extends State with SingleTickerProviderStateMixin { + late final AnimationController animationController = AnimationController( + vsync: this, + duration: const Duration(seconds: 2), + ); + + @override + void initState() { + super.initState(); + animationController.forward(); + } + + @override + void dispose() { + animationController.dispose(); + super.dispose(); + } + + @override + Widget build(BuildContext context) { + return AnimatedBuilder( + animation: animationController, + builder: (context, child) { + return Opacity( + opacity: animationController.value, + child: widget.child, + ); + }, + ); + } +} +``` + + +使用 hooks，相当于： + +```dart +class FadeIn extends HookWidget { + const FadeIn({Key? key, required this.child}) : super(key: key); + + final Widget child; + + @override + Widget build(BuildContext context) { + // 创建一个 AnimationController。 + // 卸载 widget 时，控制器将自动处置。 + final animationController = useAnimationController( + duration: const Duration(seconds: 2), + ); + + // useEffect 相当于 initState + didUpdateWidget + dispose。 + // 传给 useEffect 的回调会在第一次调用钩子时执行， + // 然后每当作为第二个参数传递的列表发生变化时也会执行。 + // 由于我们在这里传递的是一个空的常量列表， + // 因此严格意义上等同于 `initState`。 + useEffect(() { + // 在首次呈现 widget 时启动动画。 + animationController.forward(); + // 我们可以选择在这里返回一些“处置”逻辑 + return null; + }, const []); + + // 告诉 Flutter 在动画更新时重建此部件。 + // 这相当于 AnimatedBuilder + useAnimation(animationController); + + return Opacity( + opacity: animationController.value, + child: child, + ); + } +} +``` + + +这段代码中有一些有趣的事情需要注意： + + +- 不存在内存泄漏。每当小部件重建时，此代码都不会重新创建新的 `AnimationController`， + 并且在卸载小部件时正确处置控制器。 + + +- 在同一个小部件中可以根据需要多次使用钩子。 + 因此，如果我们愿意，我们可以创建多个 `AnimationController`： + + ```dart + @override + Widget build(BuildContext context) { + final animationController = useAnimationController( + duration: const Duration(seconds: 2), + ); + final anotherController = useAnimationController( + duration: const Duration(seconds: 2), + ); + + ... + } + ``` + + 这会创建两个控制器，不会产生任何负面后果。 + + +- 如果我们愿意，我们可以将此逻辑重构为一个单独的可重用函数： + + ```dart + double useFadeIn() { + final animationController = useAnimationController( + duration: const Duration(seconds: 2), + ); + useEffect(() { + animationController.forward(); + return null; + }, const []); + useAnimation(animationController); + return animationController.value; + } + ``` + + 然后我们可以在我们的小部件中使用这个函数，只要该小部件是 [HookWidget]： + + ```dart + class FadeIn extends HookWidget { + const FadeIn({Key? key, required this.child}) : super(key: key); + + final Widget child; + + @override + Widget build(BuildContext context) { + final fade = useFadeIn(); + + return Opacity(opacity: fade, child: child); + } + } + ``` + + 请注意我们的 `useFadeIn` 函数是如何完全独立于我们的 `FadeIn` 小部件的。 + 如果我们愿意，我们可以在完全不同的小部件中使用该 `useFadeIn` 函数，并且它仍然可以工作！ + + +## hooks 的规则​ + + +Hooks 具有独特的约束： + + +- 它们只能在扩展 [HookWidget] 的小部件的 `build` 方法中使用： + + **好**: + + ```dart + class Example extends HookWidget { + @override + Widget build(BuildContext context) { + final controller = useAnimationController(); + ... + } + } + ``` + + **坏**: + + ```dart + // 不是 HookWidget + class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + final controller = useAnimationController(); + ... + } + } + ``` + + **坏**: + + ```dart + class Example extends HookWidget { + @override + Widget build(BuildContext context) { + return ElevatedButton( + onPressed: () { + // _实际上_不是在 "build" 方法中， + // 而是在用户交互生命周期中（这里是 "按下时"）。 + final controller = useAnimationController(); + }, + child: Text('click me'), + ); + } + } + ``` + + +- 它们不能在条件语句或在循环语句中使用。 + + **坏**: + + ```dart + class Example extends HookWidget { + const Example({required this.condition, super.key}); + final bool condition; + @override + Widget build(BuildContext context) { + if (condition) { + // 不应该在 "if"/"for"/... 中使用 Hooks + final controller = useAnimationController(); + } + ... + } + } + ``` + + +有关钩子的更多信息，请参阅 [flutter_hooks]。 + + +## Hooks 和 Riverpod + + +### 安装 + + +由于 Hooks 与 Riverpod 是独立的，因此需要单独安装 Hooks。 +如果你想使用它们，安装 [hooks_riverpod] 是不够的。 +您仍然需要将 [flutter_hooks] 添加到您的依赖项中。 +请参阅 了解更多信息。 + + +### 用途​ + + +在某些情况下，您可能想要编写一个同时使用 hooks 和 Riverpod 的 Widget。 +但您可能已经注意到，Hooks 和 Riverpod 都提供了自己的 +自定义小部件基本类型：[HookWidget] 和 [ConsumerWidget]。 +但类一次只能扩展一个父类。 + + +为了解决这个问题，你可以使用 [hooks_riverpod] 包。 +该包提供了一个 [HookConsumerWidget] 类， +它将 [HookWidget] 和 [ConsumerWidget] 组合成一个类型。 +因此，您可以继承 [HookConsumerWidget] 而不是 [HookWidget]： + + + + +或者，您可以使用两个包提供的“构建器 builder”。 +例如，我们可以坚持使用 `StatelessWidget`， +并同时使用 `HookBuilder` 和 `Consumer`。 + + + +:::note + +这种方法无需使用 `hooks_riverpod` 即可工作。只需要 `flutter_riverpod`。 +::: + + +如果您喜欢这种方法，[hooks_riverpod] 通过提供 [HookConsumer] 来简化它， +它是两个构建器的组合： + + + +[hookwidget]: https://pub.dev/documentation/flutter_hooks/latest/flutter_hooks/HookWidget-class.html +[hookconsumer]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/HookConsumer-class.html +[hookconsumerwidget]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/HookConsumerWidget-class.html +[consumerwidget]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ConsumerWidget-class.html +[statefulwidget]: https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html +[riverpod]: https://github.com/rrousselgit/riverpod +[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod +[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod +[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart new file mode 100644 index 000000000..478de141c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_and_consumer.dart @@ -0,0 +1,28 @@ +// ignore_for_file: use_key_in_widget_constructors, unused_local_variable + +import 'package:flutter/widgets.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../providers/creating_a_provider/codegen.dart'; + +class MyValue {} + +/* SNIPPET START */ + +class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + // 我们可以使用这两个软件包提供的构建器 + return Consumer( + builder: (context, ref, child) { + return HookBuilder(builder: (context) { + final counter = useState(0); + final value = ref.watch(myProvider); + + return Text('Hello $counter $value'); + },); + }, + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart new file mode 100644 index 000000000..1ada8fe2a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer.dart @@ -0,0 +1,26 @@ +// ignore_for_file: use_key_in_widget_constructors, unused_local_variable + +import 'package:flutter/widgets.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../providers/creating_a_provider/codegen.dart'; + +class MyValue {} + +/* SNIPPET START */ + +class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + // 相当于同时使用 Consumer 和 HookBuilder。 + return HookConsumer( + builder: (context, ref, child) { + final counter = useState(0); + final value = ref.watch(myProvider); + + return Text('Hello $counter $value'); + }, + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart new file mode 100644 index 000000000..ecb222750 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/about_hooks/hook_consumer_widget.dart @@ -0,0 +1,23 @@ +// ignore_for_file: use_key_in_widget_constructors, unused_local_variable + +import 'package:flutter/widgets.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../providers/creating_a_provider/codegen.dart'; + +class MyValue {} + +/* SNIPPET START */ + +// 我们扩展了 HookConsumerWidget，而不是 HookWidget +class Example extends HookConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 我们可以在这里同时使用钩子和提供者程序 + final counter = useState(0); + final value = ref.watch(myProvider); + + return Text('Hello $counter $value'); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart new file mode 100644 index 000000000..a006cf77d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/async_initialization.dart @@ -0,0 +1,59 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import 'package:shared_preferences/shared_preferences.dart'; + +class LoadingScreen extends StatelessWidget { + const LoadingScreen({super.key}); + + @override + Widget build(BuildContext context) { + return const CircularProgressIndicator(); + } +} + +/* SNIPPET START */ +// We'd like to obtain an instance of shared preferences synchronously in a provider +final countProvider = StateProvider((ref) { + final preferences = ref.watch(sharedPreferencesProvider); + final currentValue = preferences.getInt('count') ?? 0; + ref.listenSelf((prev, curr) { + preferences.setInt('count', curr); + }); + return currentValue; +}); + +// We don't have an actual instance of SharedPreferences, and we can't get one except asynchronously +final sharedPreferencesProvider = + Provider((ref) => throw UnimplementedError()); + +Future main() async { + // Show a loading indicator before running the full app (optional) + // The platform's loading screen will be used while awaiting if you omit this. + runApp(const ProviderScope(child: LoadingScreen())); + + // Get the instance of shared preferences + final prefs = await SharedPreferences.getInstance(); + return runApp( + ProviderScope( + overrides: [ + // Override the unimplemented provider with the value gotten from the plugin + sharedPreferencesProvider.overrideWithValue(prefs), + ], + child: const MyApp(), + ), + ); +} + +class MyApp extends ConsumerWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // Use the provider without dealing with async issues + final count = ref.watch(countProvider); + return Text('$count'); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart new file mode 100644 index 000000000..81c0b9013 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.dart @@ -0,0 +1,31 @@ +// ignore_for_file: avoid_manual_providers_as_generated_provider_dependency +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'models.dart'; + +part 'codegen.g.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +// The current search filter +final searchProvider = StateProvider((ref) => ''); + +@riverpod +Stream configs(ConfigsRef ref) { + return Stream.value(Configuration()); +} + +@riverpod +Future> characters(CharactersRef ref) async { + final search = ref.watch(searchProvider); + final configs = await ref.watch(configsProvider.future); + final response = await dio.get>>( + '${configs.host}/characters?search=$search', + ); + + return response.data!.map(Character.fromJson).toList(); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart new file mode 100644 index 000000000..b96eb1df7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -0,0 +1,123 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ConfigsRef = Ref>; + +@ProviderFor(configs) +const configsProvider = ConfigsProvider._(); + +final class ConfigsProvider extends $FunctionalProvider< + AsyncValue, Stream, ConfigsRef> + with + $FutureModifier, + $StreamProvider { + const ConfigsProvider._( + {Stream Function( + ConfigsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'configsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ConfigsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$configsHash(); + + @$internal + @override + $StreamProviderElement $createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ConfigsProvider $copyWithCreate( + Stream Function( + ConfigsRef ref, + ) create, + ) { + return ConfigsProvider._(create: create); + } + + @override + Stream create(ConfigsRef ref) { + final _$cb = _createCb ?? configs; + return _$cb(ref); + } +} + +String _$configsHash() => r'166cbe95e6b49ed7bc78c96041fb14abddbf6911'; + +typedef CharactersRef = Ref>>; + +@ProviderFor(characters) +const charactersProvider = CharactersProvider._(); + +final class CharactersProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, CharactersRef> + with + $FutureModifier>, + $FutureProvider, CharactersRef> { + const CharactersProvider._( + {FutureOr> Function( + CharactersRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'charactersProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + CharactersRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$charactersHash(); + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + CharactersProvider $copyWithCreate( + FutureOr> Function( + CharactersRef ref, + ) create, + ) { + return CharactersProvider._(create: create); + } + + @override + FutureOr> create(CharactersRef ref) { + final _$cb = _createCb ?? characters; + return _$cb(ref); + } +} + +String _$charactersHash() => r'b1e8e15bbeab60d92fe959d9e1dd4ceba6a31446'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart new file mode 100644 index 000000000..e21e1d7c6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/models.dart @@ -0,0 +1,17 @@ + +class Character { + Character(); + + // ignore: avoid_unused_constructor_parameters + factory Character.fromJson(Map json) { + return Character(); + } +} + +class Configuration { + Configuration({ + this.host = '', + }); + + final String host; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart new file mode 100644 index 000000000..57c054dcd --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/characters_provider/raw.dart @@ -0,0 +1,26 @@ +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +import 'models.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +// The current search filter +final searchProvider = StateProvider((ref) => ''); + +/// Configurations which can change over time +final configsProvider = StreamProvider( + (ref) => Stream.value(Configuration()), +); + +final charactersProvider = FutureProvider>((ref) async { + final search = ref.watch(searchProvider); + final configs = await ref.watch(configsProvider.future); + final response = await dio.get>>( + '${configs.host}/characters?search=$search',); + + return response.data!.map(Character.fromJson).toList(); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart new file mode 100644 index 000000000..8b8f234b9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.dart @@ -0,0 +1,7 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +String city(CityRef ref) => 'London'; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart new file mode 100644 index 000000000..f7b66e8c3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -0,0 +1,72 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CityRef = Ref; + +@ProviderFor(city) +const cityProvider = CityProvider._(); + +final class CityProvider extends $FunctionalProvider + with $Provider { + const CityProvider._( + {String Function( + CityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'cityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + CityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$cityHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CityProvider $copyWithCreate( + String Function( + CityRef ref, + ) create, + ) { + return CityProvider._(create: create); + } + + @override + String create(CityRef ref) { + final _$cb = _createCb ?? city; + return _$cb(ref); + } +} + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart new file mode 100644 index 000000000..d8093431c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/city_provider/raw.dart @@ -0,0 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final cityProvider = Provider((ref) => 'London'); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart new file mode 100644 index 000000000..3049dd743 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart @@ -0,0 +1,33 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../todo_list_provider/codegen.dart'; + +part 'codegen.g.dart'; + +enum Filter { + none, + completed, + uncompleted, +} + +@riverpod +Filter filter(FilterRef ref) { + return Filter.none; +} + +/* SNIPPET START */ + +@riverpod +List filteredTodoList(FilteredTodoListRef ref) { + final filter = ref.watch(filterProvider); + final todos = ref.watch(todoListProvider); + + switch (filter) { + case Filter.none: + return todos; + case Filter.completed: + return todos.where((todo) => todo.completed).toList(); + case Filter.uncompleted: + return todos.where((todo) => !todo.completed).toList(); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart new file mode 100644 index 000000000..0576b684f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -0,0 +1,133 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef FilterRef = Ref; + +@ProviderFor(filter) +const filterProvider = FilterProvider._(); + +final class FilterProvider + extends $FunctionalProvider + with $Provider { + const FilterProvider._( + {Filter Function( + FilterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Filter Function( + FilterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Filter value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilterProvider $copyWithCreate( + Filter Function( + FilterRef ref, + ) create, + ) { + return FilterProvider._(create: create); + } + + @override + Filter create(FilterRef ref) { + final _$cb = _createCb ?? filter; + return _$cb(ref); + } +} + +String _$filterHash() => r'e75d75b728d7ce923734d925b42b3353eac446be'; + +typedef FilteredTodoListRef = Ref>; + +@ProviderFor(filteredTodoList) +const filteredTodoListProvider = FilteredTodoListProvider._(); + +final class FilteredTodoListProvider + extends $FunctionalProvider, List, FilteredTodoListRef> + with $Provider, FilteredTodoListRef> { + const FilteredTodoListProvider._( + {List Function( + FilteredTodoListRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filteredTodoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + FilteredTodoListRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filteredTodoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilteredTodoListProvider $copyWithCreate( + List Function( + FilteredTodoListRef ref, + ) create, + ) { + return FilteredTodoListProvider._(create: create); + } + + @override + List create(FilteredTodoListRef ref) { + final _$cb = _createCb ?? filteredTodoList; + return _$cb(ref); + } +} + +String _$filteredTodoListHash() => r'1c35eb0fce8fc7c7cda86413b02f606f8c8ae2b4'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart new file mode 100644 index 000000000..2c3d79b71 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/filtered_todo_list_provider/raw.dart @@ -0,0 +1,27 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import '../todo_list_provider/raw.dart'; + +enum Filter { + none, + completed, + uncompleted, +} + +final filterProvider = StateProvider((ref) => Filter.none); + +/* SNIPPET START */ + +final filteredTodoListProvider = Provider>((ref) { + final filter = ref.watch(filterProvider); + final todos = ref.watch(todoListProvider); + + switch (filter) { + case Filter.none: + return todos; + case Filter.completed: + return todos.where((todo) => todo.completed).toList(); + case Filter.uncompleted: + return todos.where((todo) => !todo.completed).toList(); + } +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart new file mode 100644 index 000000000..b1cb3dbe3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.dart @@ -0,0 +1,17 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +MyValue another(AnotherRef ref) => MyValue(); + +class MyValue {} + +/* SNIPPET START */ + +@riverpod +MyValue my(MyRef ref) { + // Bad practice to call `read` here + final value = ref.read(anotherProvider); + return value; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart new file mode 100644 index 000000000..124d73ed8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -0,0 +1,132 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef AnotherRef = Ref; + +@ProviderFor(another) +const anotherProvider = AnotherProvider._(); + +final class AnotherProvider + extends $FunctionalProvider + with $Provider { + const AnotherProvider._( + {MyValue Function( + AnotherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'anotherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyValue Function( + AnotherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$anotherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + AnotherProvider $copyWithCreate( + MyValue Function( + AnotherRef ref, + ) create, + ) { + return AnotherProvider._(create: create); + } + + @override + MyValue create(AnotherRef ref) { + final _$cb = _createCb ?? another; + return _$cb(ref); + } +} + +String _$anotherHash() => r'bb412edc55657c14eace37792cd18e5254604a36'; + +typedef MyRef = Ref; + +@ProviderFor(my) +const myProvider = MyProvider._(); + +final class MyProvider extends $FunctionalProvider + with $Provider { + const MyProvider._( + {MyValue Function( + MyRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyValue Function( + MyRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$myHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + MyProvider $copyWithCreate( + MyValue Function( + MyRef ref, + ) create, + ) { + return MyProvider._(create: create); + } + + @override + MyValue create(MyRef ref) { + final _$cb = _createCb ?? my; + return _$cb(ref); + } +} + +String _$myHash() => r'2712c772be4dbaabd4c99fd803f927a7e9938b21'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart new file mode 100644 index 000000000..76bae4653 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/read_in_provider/raw.dart @@ -0,0 +1,13 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +final anotherProvider = Provider((ref) => MyValue()); + +class MyValue {} + +/* SNIPPET START */ + +final myProvider = Provider((ref) { + // Bad practice to call `read` here + final value = ref.read(anotherProvider); + return value; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart new file mode 100644 index 000000000..e44e202bc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.dart @@ -0,0 +1,25 @@ + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'models.dart'; + +part 'codegen.g.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +@riverpod +Stream config(ConfigRef ref) => Stream.value(Configuration()); + +@riverpod +Future> products(ProductsRef ref) async { + // Listens only to the host. If something else in the configurations + // changes, this will not pointlessly re-evaluate our provider. + final host = await ref.watch(configProvider.selectAsync((config) => config.host)); + + final result = await dio.get>>('$host/products'); + + return result.data!.map(Product.fromJson).toList(); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart new file mode 100644 index 000000000..83a4d5829 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -0,0 +1,123 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ConfigRef = Ref>; + +@ProviderFor(config) +const configProvider = ConfigProvider._(); + +final class ConfigProvider extends $FunctionalProvider< + AsyncValue, Stream, ConfigRef> + with + $FutureModifier, + $StreamProvider { + const ConfigProvider._( + {Stream Function( + ConfigRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'configProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ConfigRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$configHash(); + + @$internal + @override + $StreamProviderElement $createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ConfigProvider $copyWithCreate( + Stream Function( + ConfigRef ref, + ) create, + ) { + return ConfigProvider._(create: create); + } + + @override + Stream create(ConfigRef ref) { + final _$cb = _createCb ?? config; + return _$cb(ref); + } +} + +String _$configHash() => r'3021d1a8aac384e99d5d22714ffe6e868954888b'; + +typedef ProductsRef = Ref>>; + +@ProviderFor(products) +const productsProvider = ProductsProvider._(); + +final class ProductsProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, ProductsRef> + with + $FutureModifier>, + $FutureProvider, ProductsRef> { + const ProductsProvider._( + {FutureOr> Function( + ProductsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'productsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + ProductsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$productsHash(); + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ProductsProvider $copyWithCreate( + FutureOr> Function( + ProductsRef ref, + ) create, + ) { + return ProductsProvider._(create: create); + } + + @override + FutureOr> create(ProductsRef ref) { + final _$cb = _createCb ?? products; + return _$cb(ref); + } +} + +String _$productsHash() => r'd1f4523880408cf8ee0e68969c40cf87d5c78557'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart new file mode 100644 index 000000000..3a711b4b6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/models.dart @@ -0,0 +1,21 @@ +// ignore_for_file: sort_constructors_first + +class Product { + const Product({this.title = ''}); + + final String title; + + factory Product.fromJson(Map map) { + return Product( + title: map['title'] as String, + ); + } +} + +class Configuration { + Configuration({ + this.host = '', + }); + + final String host; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart new file mode 100644 index 000000000..a5208e4e7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/select_async_provider/raw.dart @@ -0,0 +1,21 @@ +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'models.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +final configProvider = + StreamProvider((ref) => Stream.value(Configuration())); + +final productsProvider = FutureProvider>((ref) async { + // Listens only to the host. If something else in the configurations + // changes, this will not pointlessly re-evaluate our provider. + final host = + await ref.watch(configProvider.selectAsync((config) => config.host)); + final result = await dio.get>>('$host/products'); + + return result.data!.map(Product.fromJson).toList(); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart new file mode 100644 index 000000000..a1942dbd4 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.dart @@ -0,0 +1,24 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +@freezed +class Todo with _$Todo { + factory Todo({ + required String id, + required String description, + required bool completed, + }) = _Todo; +} + +/* SNIPPET START */ + +@riverpod +class TodoList extends _$TodoList { + @override + List build() { + return []; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart new file mode 100644 index 000000000..0b73d3548 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.freezed.dart @@ -0,0 +1,166 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$Todo { + String get id => throw _privateConstructorUsedError; + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String id, String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as String, + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc + +class _$TodoImpl implements _Todo { + _$TodoImpl( + {required this.id, required this.description, required this.completed}); + + @override + final String id; + @override + final String description; + @override + final bool completed; + + @override + String toString() { + return 'Todo(id: $id, description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.id, id) || other.id == id) && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @override + int get hashCode => Object.hash(runtimeType, id, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); +} + +abstract class _Todo implements Todo { + factory _Todo( + {required final String id, + required final String description, + required final bool completed}) = _$TodoImpl; + + @override + String get id; + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart new file mode 100644 index 000000000..767e99cc6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/codegen.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(TodoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider extends $NotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + List Function( + Ref>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todoListHash() => r'6c965beb867ffeee119133f0ae2e6ebeb68e6f7e'; + +abstract class _$TodoList extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart new file mode 100644 index 000000000..a341b7f5b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/todo_list_provider/raw.dart @@ -0,0 +1,36 @@ +// ignore_for_file: public_member_api_docs, sort_constructors_first +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Todo { + const Todo({ + required this.id, + required this.description, + required this.completed, + }); + + // All properties should be `final` on our class. + final String id; + final String description; + final bool completed; + + // Since Todo is immutable, we implement a method that allows cloning the + // Todo with slightly different content. + Todo copyWith({String? id, String? description, bool? completed}) { + return Todo( + id: id ?? this.id, + description: description ?? this.description, + completed: completed ?? this.completed, + ); + } +} + +/* SNIPPET START */ + +class TodoList extends Notifier> { + @override + List build() { + return []; + } +} + +final todoListProvider = NotifierProvider>(TodoList.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart new file mode 100644 index 000000000..8f7af2644 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.dart @@ -0,0 +1,20 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +String city(CityRef ref) => 'London'; + +class Weather {} + +Future fetchWeather({required String city}) async => Weather(); +/* SNIPPET START */ +@riverpod +Future weather(WeatherRef ref) { + // We use `ref.watch` to listen to another provider, and we pass it the provider + // that we want to consume. Here: cityProvider + final city = ref.watch(cityProvider); + + // We can then use the result to do something based on the value of `cityProvider`. + return fetchWeather(city: city); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart new file mode 100644 index 000000000..e0cb3b238 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -0,0 +1,124 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CityRef = Ref; + +@ProviderFor(city) +const cityProvider = CityProvider._(); + +final class CityProvider extends $FunctionalProvider + with $Provider { + const CityProvider._( + {String Function( + CityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'cityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + CityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$cityHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CityProvider $copyWithCreate( + String Function( + CityRef ref, + ) create, + ) { + return CityProvider._(create: create); + } + + @override + String create(CityRef ref) { + final _$cb = _createCb ?? city; + return _$cb(ref); + } +} + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +typedef WeatherRef = Ref>; + +@ProviderFor(weather) +const weatherProvider = WeatherProvider._(); + +final class WeatherProvider extends $FunctionalProvider, + FutureOr, WeatherRef> + with $FutureModifier, $FutureProvider { + const WeatherProvider._( + {FutureOr Function( + WeatherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'weatherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + WeatherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$weatherHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + WeatherProvider $copyWithCreate( + FutureOr Function( + WeatherRef ref, + ) create, + ) { + return WeatherProvider._(create: create); + } + + @override + FutureOr create(WeatherRef ref) { + final _$cb = _createCb ?? weather; + return _$cb(ref); + } +} + +String _$weatherHash() => r'9a79d0269032630918eef9d3f562ff35b5860061'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart new file mode 100644 index 000000000..d25ec4ffc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/weather_provider/raw.dart @@ -0,0 +1,18 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +final cityProvider = Provider((ref) => 'London'); + +class Weather {} + +Future fetchWeather({required String city}) async => Weather(); + +/* SNIPPET START */ + +final weatherProvider = FutureProvider((ref) async { + // We use `ref.watch` to listen to another provider, and we pass it the provider + // that we want to consume. Here: cityProvider + final city = ref.watch(cityProvider); + + // We can then use the result to do something based on the value of `cityProvider`. + return fetchWeather(city: city); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart new file mode 100644 index 000000000..1a90008ed --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.dart @@ -0,0 +1,24 @@ +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'models.dart'; + +part 'codegen.g.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +@riverpod +Stream config(ConfigRef ref) => Stream.value(Configuration()); + +@riverpod +Future> products(ProductsRef ref) async { + // Will cause productsProvider to re-fetch the products if anything in the + // configurations changes + final configs = await ref.watch(configProvider.future); + + final result = + await dio.get>>('${configs.host}/products'); + return result.data!.map(Product.fromJson).toList(); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart new file mode 100644 index 000000000..c21282853 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -0,0 +1,123 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ConfigRef = Ref>; + +@ProviderFor(config) +const configProvider = ConfigProvider._(); + +final class ConfigProvider extends $FunctionalProvider< + AsyncValue, Stream, ConfigRef> + with + $FutureModifier, + $StreamProvider { + const ConfigProvider._( + {Stream Function( + ConfigRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'configProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ConfigRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$configHash(); + + @$internal + @override + $StreamProviderElement $createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ConfigProvider $copyWithCreate( + Stream Function( + ConfigRef ref, + ) create, + ) { + return ConfigProvider._(create: create); + } + + @override + Stream create(ConfigRef ref) { + final _$cb = _createCb ?? config; + return _$cb(ref); + } +} + +String _$configHash() => r'3021d1a8aac384e99d5d22714ffe6e868954888b'; + +typedef ProductsRef = Ref>>; + +@ProviderFor(products) +const productsProvider = ProductsProvider._(); + +final class ProductsProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, ProductsRef> + with + $FutureModifier>, + $FutureProvider, ProductsRef> { + const ProductsProvider._( + {FutureOr> Function( + ProductsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'productsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + ProductsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$productsHash(); + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ProductsProvider $copyWithCreate( + FutureOr> Function( + ProductsRef ref, + ) create, + ) { + return ProductsProvider._(create: create); + } + + @override + FutureOr> create(ProductsRef ref) { + final _$cb = _createCb ?? products; + return _$cb(ref); + } +} + +String _$productsHash() => r'637254615fa398af0d36e212f09e5d3d8ff866aa'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart new file mode 100644 index 000000000..8009c2fd8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/models.dart @@ -0,0 +1,16 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +class Product { + Product(); + factory Product.fromJson(Map json) { + return Product(); + } +} + +class Configuration { + Configuration({ + this.host = '', + }); + + final String host; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart new file mode 100644 index 000000000..be2be903c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_provider_states/whole_object_provider/raw.dart @@ -0,0 +1,20 @@ +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'models.dart'; + +final dio = Dio(); + +/* SNIPPET START */ + +final configProvider = + StreamProvider((ref) => Stream.value(Configuration())); + +final productsProvider = FutureProvider>((ref) async { + // Will cause productsProvider to re-fetch the products if anything in the + // configurations changes + final configs = await ref.watch(configProvider.future); + + final result = await dio.get>>('${configs.host}/products'); + return result.data!.map(Product.fromJson).toList(); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index 74fe18ef5..90307f075 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -1,65 +1,77 @@ --- -title: 组合 Provider 状态 +title: Combining Provider States --- -请确保先阅读有关 [Providers](/docs/concepts/providers) 的内容。 -在本指南中，我们将学习如何组合provider的状态。 +import charactersProvider from "./combining_provider_states/characters_provider"; +import cityProvider from "./combining_provider_states/city_provider"; +import filteredTodoListProvider from "./combining_provider_states/filtered_todo_list_provider"; +import readInProvider from "./combining_provider_states/read_in_provider"; +import selectAsyncProvider from "./combining_provider_states/select_async_provider"; +import todoListProvider from "./combining_provider_states/todo_list_provider"; +import weatherProvider from "./combining_provider_states/weather_provider"; +import wholeObjectProvider from "./combining_provider_states/whole_object_provider"; +import { Link } from "@site/src/components/Link"; +import { + trimSnippet, + AutoSnippet, + When, +} from "@site/src/components/CodeSnippet"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -## 组合 Provider 状态 +Make sure to read first. +In this guide, we will learn about combining provider states. -我们之前已经了解了如何创建简单的provider。 -但实际在许多情况下，provider想要读取另一个provider的状态。 +## Combining provider states -为此，我们可以使用传递给provider回调函数的e [ref] 对象，并使用它的 [watch] 方法。 +We've previously seen how to create a simple provider. But the reality is, +in many situations a provider will want to read the state of another provider. -例如，思考一下下面的provider： +To do that, we can use the [ref] object passed to the callback of our provider, +and use its [watch] method. -```dart -final cityProvider = Provider((ref) => 'London'); -``` +As an example, consider the following provider: + + We can now create another provider that will consume our `cityProvider`: -现在我们可以创建另一个provider来使用我们的 `cityProvider`： -```dart -final weatherProvider = FutureProvider((ref) async { - // 我们使用 `ref. watch` 来监听另一个provider， - // 我们将使用的cityProvider传递给它。 - final city = ref.watch(cityProvider); + - // 然后，我们可以根据 `cityProvider` 的值来做一些事情。 - return fetchWeather(city: city); -}); -``` +That's it. We've created a provider that depends on another provider. -这样。我们创建了一个依赖于另一个provider的provider。 +## FAQ -## 常见问题解答 +### What if the value being listened to changes over time? -### 如果被监听的值随着时间的推移而改变怎么办? +Depending on the provider that you are listening to, the value obtained may +change over time. +For example, you may be listening to a [NotifierProvider], or the provider +being listened to may have been forced to refresh through the use of +[ProviderContainer.refresh]/[ref.refresh]. -例如，你可能正在监听的 [StateNotifierProvider] 或 -已经强制刷新([ProviderContainer.refresh] / [ref.refresh])过的provider被监听时。 +When using [watch], Riverpod is able to detect that the value being listened to changed +and will _automatically_ re-execute the provider's creation callback when needed. -当使用 [watch] 时，Riverpod能够检测到被监听的值发生了变化 -并且在需要时将_自动_重新执行provider的回调函数。 +This can be useful for computed states. +For example, consider a that exposes a todo-list: -这在计算状态时很有用。 -例如一个 [StateNotifierProvider] 暴露了一个待办清单： + -```dart -class TodoList extends StateNotifier> { - TodoList(): super(const []); -} +A common use-case would be to have the UI filter the list of todos to show +only the completed/uncompleted todos. -final todoListProvider = StateNotifierProvider((ref) => TodoList()); -``` - -一个常见的用例是让UI过滤待办清单列表，只显示完成/未完成的待办事项。 +An easy way to implement such a scenario would be to: -实现这种场景的一个简单方法是： - -- 创建一个 [StateProvider]并暴露当前选择的筛选方法： +- create a [StateProvider], which exposes the currently selected filter method: ```dart enum Filter { @@ -71,70 +83,45 @@ final todoListProvider = StateNotifierProvider((ref) => TodoList()); final filterProvider = StateProvider((ref) => Filter.none); ``` -- 创建一个单独的，结合了筛选器方法和待办清单列表的provider，以暴露经过筛选的待办清单列表： +- make a separate provider which combines the filter method and the todo-list + to expose the filtered todo-list: - ```dart - final filteredTodoListProvider = Provider>((ref) { - final filter = ref.watch(filterProvider); - final todos = ref.watch(todoListProvider); - - switch (filter) { - case Filter.none: - return todos; - case Filter.completed: - return todos.where((todo) => todo.completed).toList(); - case Filter.uncompleted: - return todos.where((todo) => !todo.completed).toList(); - } - }); - ``` + -然后，我们的UI可以监听 `filteredTodoListProvider` 来监听过滤后的待办清单。 -使用这种方法，当过滤器或待办清单列表发生变化时，UI将自动更新。 +Then, our UI can listen to `filteredTodoListProvider` to listen to the filtered todo-list. +Using such an approach, the UI will automatically update when either the filter +or the todo-list changes. -要查看这种方法的详细内容，你可以查看 -[待办清单示例](https://github.com/rrousselGit/riverpod/tree/master/examples/todos)的源代码。 +To see this approach in action, you can look at the source code of the [Todo List +example](https://github.com/rrousselGit/riverpod/tree/master/examples/todos). :::info -这种行为不只针对 [Provider]，它适用于所有的provider。 +This behavior is not specific to [Provider], and works with all providers. For example, you could combine [watch] with [FutureProvider] to implement a search feature that supports live-configuration changes: -例如，你可以将 [watch] 与 [FutureProvider] 结合来实现一个支持实时配置更改的搜索功能： - -```dart -// 当前的搜索条件 -final searchProvider = StateProvider((ref) => ''); - -/// 可随时间变化的配置 -final configsProvider = StreamProvider(...); -final charactersProvider = FutureProvider>((ref) async { - final search = ref.watch(searchProvider); - final configs = await ref.watch(configsProvider.future); - final response = await dio.get('${configs.host}/characters?search=$search'); + - return response.data.map((json) => Character.fromJson(json)).toList(); -}); -``` - -这段代码将从服务中获取一个字符列表，并在配置更改或搜索查询更改时自动重新获取该列表。 +This code will fetch a list of characters from the service, and automatically +re-fetch the list whenever the configurations change or when the search query changes. ::: -### 我可以在不监听的情况下读取provider吗？ +### Can I read a provider without listening to it? -有时，我们希望读取provider的内容，但不需要在那个值发生变化时重新创建暴露的值。 +Sometimes, we want to read the content of a provider, but without re-creating +the value exposed when the value obtained changes. -一个例子就是`Repository`，它从另一个provider读取用户令牌进行身份验证。 -我们可以在用户令牌更改时使用 [watch] 并创建一个新的 `Repository` ，但这样做几乎没有任何用处。 +An example would be a `Repository`, which reads from another provider the user token +for authentication. +We could use [watch] and create a new `Repository` whenever the user token changes, +but there is little to no use in doing that. -在这种情况下，我们可以使用 [read]，它类似于 [watch]， -但是当获取的值发生变化时，它不会导致provider重新创建它所暴露的值。 +In this situation, we can use [read], which is similar to [watch], but will not +cause the provider to recreate the value it exposes when the value obtained changes. In that case, a common practice is to pass the provider's `Ref` to the object created. The object created will then be able to read providers whenever it wants. -所以在这种情况，常见的做法是将provider的 `Ref` 传递给创建的对象。 -创建的对象将能够在任何需要的时候读取提供程序。 ```dart final userTokenProvider = StateProvider((ref) => null); @@ -158,25 +145,21 @@ class Repository { } ``` -:::danger **不要**在provider的里面调用 [read] 方法 +:::danger **DON'T** call [read] inside the body of a provider -```dart -final myProvider = Provider((ref) { - // 在此处调用“read”的错误做法 - final value = ref.read(anotherProvider); -}); -``` + -如果你使用 [read] 来避免不必要的对象重建， -请参考[我的provider更新过于频繁我该怎么办](#我的provider更新过于频繁我该怎么办) +If you used [read] as an attempt to avoid unwanted rebuilds of your object, +refer to [My provider updates too often, what can I do?](#my-provider-updates-too-often-what-can-i-do) ::: -### 如何测试一个接收 [ref] 作为其构造函数参数的对象？ +### How to test an object that receives [ref] as a parameter of its constructor? -如果你正在使用[我可以在不监听的情况下读取provider吗？](#我可以在不监听的情况下读取provider吗)中描述的模式， -你可能想知道如何为对象编写测试。 +If you are using the pattern described in [Can I read a provider without listening to it?](#can-i-read-a-provider-without-listening-to-it), +you may be wondering how to write tests for your object. -在这个场景中，考虑直接测试provider而不是原始对象。你可以通过使用 [ProviderContainer] 类来实现: +In this scenario, consider testing the provider directly instead of the raw object. +You can do so by using the [ProviderContainer] class: ```dart final repositoryProvider = Provider((ref) => Repository(ref)); @@ -194,49 +177,35 @@ test('fetches catalog', () async { }); ``` -### 我的provider更新过于频繁，我该怎么办？ +### My provider updates too often, what can I do? -如果你的对象被频繁地重新创建，你的provider可能会监听它并不关心的对象。 +If your object is re-created too often your provider is likely listening +to objects that it doesn't care about. -例如，你可能正在监听一个 `Configuration` 对象，但只使用 `host` 属性。 -通过监听整个 `Configuration` 对象，如果 `host` 以外的某个属性发生了变化， -仍然会导致重新评估你的provider——这可能是我们不希望所发生的。 +For example, you may be listening to a `Configuration` object, but only use the `host` +property. +By listening to the entire `Configuration` object, if a property other than `host` +changes, this still causes your provider to be re-evaluated – which may be +undesired. -这个问题的解决方案是创建一个单独的provider，_只_在 `Configuration` 中暴露你需要的内容(所以是 `host`): +The solution to this problem is to create a separate provider that exposes _only_ +what you need in `Configuration` (so `host`): -**避免**听整个对象： +**AVOID** listening to the entire object: -```dart -final configProvider = StreamProvider(...); + -final productsProvider = FutureProvider>((ref) async { - // 如果配置(configurations)发生变化，将导致productsProvider重新获取产品 - final configs = await ref.watch(configProvider.future); +**PREFER** using select when you only need a single property of an object: - return dio.get('${configs.host}/products'); -}); -``` - - -当你只需要一个对象的单个属性时，**最好**使用select： - -```dart -final configProvider = StreamProvider(...); - -final productsProvider = FutureProvider>((ref) async { - // 只监听host。如果配置(configurations)中的其他内容发生了更改，这将重新评估我们的provider。 - final host = await ref.watch(configProvider.selectAsync((config) => config.host)); - - return dio.get('$host/products'); -}); -``` + -这将只在 `host` 更改时重新构建productsProvider。 +This will only rebuild the `productsProvider` when the `host` changes. [provider]: ../providers/provider [stateprovider]: ../providers/state_provider [futureprovider]: ../providers/future_provider [statenotifierprovider]: ../providers/state_notifier_provider +[notifierProvider]: ../providers/notifier_provider [ref]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref-class.html [watch]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/watch.html [read]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/read.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart new file mode 100644 index 000000000..7ecdfa8f1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/dialog_scope.dart @@ -0,0 +1,59 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ + +// Have a counter that is being incremented by the FloatingActionButton +final counterProvider = StateProvider((ref) => 0); + +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // We want to show a dialog with the count on a button press + return Scaffold( + body: Column( + children: [ + ElevatedButton( + onPressed: () { + showDialog( + context: context, + builder: (c) { + // We wrap the dialog with a ProviderScope widget, providing the + // parent container to ensure the dialog can access the same providers + // that are accessible by the Home widget. + return ProviderScope( + parent: ProviderScope.containerOf(context), + child: const AlertDialog( + content: CounterDisplay(), + ), + ); + }, + ); + }, + child: const Text('Show Dialog'), + ), + ], + ), + floatingActionButton: FloatingActionButton( + child: const Icon(Icons.add), + onPressed: () { + ref.read(counterProvider.notifier).state++; + }, + ),); + } +} + +class CounterDisplay extends ConsumerWidget { + const CounterDisplay({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final count = ref.watch(counterProvider); + return Text('$count'); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx index eaf3e5bf7..eaece8112 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/auto_dispose.mdx @@ -2,22 +2,27 @@ title: .autoDispose --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: -一个常见的用例是当不再使用provider时销毁它的状态。 +A common use case is to destroy the state of a provider +when it is no-longer used. -这么做有很多原因，比如： +There are multiple reasons for doing so, such as: -- 使用Firebase时，关闭连接，避免不必要的开销。 -- 当用户离开页面并重新进入时重置状态。 +- When using Firebase, to close the connection and avoid unnecessary cost. +- To reset the state when the user leaves a screen and re-enters it. -Provider内置了 `.autoDispose` 修饰符来支持这些功能。 +Providers come with built-in support for this use case, through the `.autoDispose` +modifier. -## 用法 +## Usage -要告诉Riverpod在provider不再使用时销毁它的状态， -只需将 `.autoDispose` 附加到你的provider上： +To tell Riverpod to destroy the state of a provider when it is no longer used, +simply append `.autoDispose` to your provider: ```dart final userProvider = StreamProvider.autoDispose((ref) { @@ -25,12 +30,14 @@ final userProvider = StreamProvider.autoDispose((ref) { }); ``` -就是这样。当不再使用 `userProvider` 时，它的状态将自动被销毁。 +That's it. Now, the state of `userProvider` will automatically be destroyed +when it is no longer used. -注意泛型参数是在`autoDispose`之后而不是之前传递的 —— `autoDispose` 不是一个命名构造器。 +Note how the generic parameters are passed after `autoDispose` instead of before – +`autoDispose` is not a named constructor. :::note -如果你想，你也可以结合 `.autoDispose` 和其他修饰符： +You can combine `.autoDispose` with other modifiers if you need to: ```dart final userProvider = StreamProvider.autoDispose.family((ref, id) { @@ -42,11 +49,13 @@ final userProvider = StreamProvider.autoDispose.family((ref, id) { ### ref.keepAlive -使用 `autoDispose` 的 provider还会添加一个额外的方法到 `ref` 上： `keepAlive`。 +Marking a provider with `autoDispose` also adds an extra method on `ref`: `keepAlive`. -`keepAlive` 函数用于告诉Riverpod即使不再监听provider的状态也应该保留。 +The `keepAlive` function is used to tell Riverpod that the state of the provider +should be preserved even if no longer listened to. -一个用例是在HTTP请求完成后将此标志设置为 `true`： +A use-case would be to set this flag to `true` after an HTTP request has +completed: ```dart final myProvider = FutureProvider.autoDispose((ref) async { @@ -56,51 +65,56 @@ final myProvider = FutureProvider.autoDispose((ref) async { }); ``` -这样，如果请求失败，用户离开页面，然后重新进入，那么请求将再次执行。 -但是如果请求成功完成，状态将被保留，重新进入就不会触发新的请求。 +This way, if the request fails and the user leaves the screen then re-enters +it, then the request will be performed again. +But if the request completed successfully, the state will be preserved +and re-entering the screen will not trigger a new request. :::info -在1.0.x的版本中， `maintainState` 属性等价于 `keepAlive`。 +In version 1.0.x, the equivalent of `keepAlive` is the property called `maintainState`. ::: -## 示例:取消不再使用的HTTP请求 +## Example: Canceling HTTP requests when no longer used -`autoDispose` 修饰符可以与 [FutureProvider] 和 `ref.onDispose` 结合使用， -以便在不再需要HTTP请求时轻松取消它们。 +The `autoDispose` modifier could be combined with [FutureProvider] and `ref.onDispose` +to easily cancel HTTP requests when they are no longer needed. -目标: +The goal is: -- 当用户进入一个页面时启动一个HTTP请求 -- 如果用户在请求完成前离开页面，则取消HTTP请求 -- 如果请求成功，离开并重新进入页面则不会开始新的请求 +- Start an HTTP request when the user enters a screen +- if the user leaves the screen before the request completed, cancel the HTTP request +- if the request succeeded, leaving and re-entering the screen does not start a new request -下面是代码示例： +In code, this would be: ```dart final myProvider = FutureProvider.autoDispose((ref) async { - // 来自package:dio的一个对象，允许取消http请求 + // An object from package:dio that allows cancelling http requests final cancelToken = CancelToken(); - // 当provider被销毁时，取消http请求 + // When the provider is destroyed, cancel the http request ref.onDispose(() => cancelToken.cancel()); - // 获取我们的数据并传递“cancelToken”来取消工作 + // Fetch our data and pass our `cancelToken` for cancellation to work final response = await dio.get('path', cancelToken: cancelToken); - // 如果请求成功完成，则保持该状态 + // If the request completed successfully, keep the state ref.keepAlive(); return response; }); ``` -## 参数类型 'AutoDisposeProvider' 不能被赋值给参数类型 'AlwaysAliveProviderBase' +## The argument type 'AutoDisposeProvider' can't be assigned to the parameter type 'AlwaysAliveProviderBase' -当使用 `.autoDispose` 时，你可能会发现你的应用在编译时出现类似错误： +When using `.autoDispose`, you may find yourself in a situation where your +application does not compile with an error similar to: > The argument type 'AutoDisposeProvider' can't be assigned to the parameter > type 'AlwaysAliveProviderBase' -不要担心！这个错误是正常的。发生这种情况是因为你很可能编写了一个bug： +Don't worry! This error is voluntary. It happens because you most likely +have a bug: -你试图在未标记 `.autoDispose` 的provider中监听标记了 `.autoDispose` 的provider，例如： +You tried to listen to a provider marked with `.autoDispose` in a provider that +is **not** marked with `.autoDispose`, such as: ```dart final firstProvider = Provider.autoDispose((ref) => 0); @@ -112,9 +126,9 @@ final secondProvider = Provider((ref) { }); ``` -我们不希望这样，因为它将导致 `firstProvider` 永远不会被销毁。 +This is undesired, as it would cause `firstProvider` to never be disposed. -要解决这个问题，可以考虑用 `.autoDispose` 标记 `secondProvider`: +To fix this, consider marking `secondProvider` with `.autoDispose` too: ```dart final firstProvider = Provider.autoDispose((ref) => 0); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx index ae2018282..9c64ba95c 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/modifiers/family.mdx @@ -4,23 +4,31 @@ title: .family import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; +import { Link } from "@site/src/components/Link"; -在阅读本文之前，请考虑阅读有关 [providers](/docs/concepts/providers) 的内容以及 [如何读取provider](/docs/concepts/reading)。 -在本部分中，我们将详细讨论`.family`修饰符。 +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + +Before reading this, consider reading about and . +In this part, we will talk in detail about the `.family` provider modifier. -`.family` 修饰符有一个目的：根据外部参数获取唯一的provider。 +The `.family` modifier has one purpose: Getting a unique provider based on external parameters. -比如`family`的一些常用的使用场景： +Some common use-cases for `family` would be: -- 结合 [FutureProvider] 和 `.family` 通过它的ID来获取一条 `消息`。 -- 将当前 `区域` 传递给provider，以便让我们可以处理翻译相关的内容。 +- Combining [FutureProvider] with `.family` to fetch a `Message` from its ID +- Passing the current `Locale` to a provider, so that we can handle translations -## 用法 +## Usage -family的工作方式是向provider添加一个额外的参数。 -然后可以在我们的provider中自由地使用这个参数来创建一些状态。 +The way families works is by adding an extra parameter to the provider. +This parameter can then be freely used in our provider to create some state. -比如说，我们可以组合 `family` 和 [FutureProvider] 通过它的ID来获取一条 `消息` ： +For example, we can combine `family` with [FutureProvider] to fetch +a `Message` from its ID: ```dart final messagesFamily = FutureProvider.family((ref, id) async { @@ -28,8 +36,8 @@ final messagesFamily = FutureProvider.family((ref, id) async { }); ``` -在使用 `messagesFamily` provider时，语法略有不同。 -通常的语法将不能使用： +When using our `messagesFamily` provider, the syntax is slightly different. +The usual syntax will not work anymore: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -38,7 +46,7 @@ Widget build(BuildContext context, WidgetRef ref) { } ``` -相反，我们需要将一个参数传递给 `messagesFamily`： +Instead, we need to pass a parameter to `messagesFamily`: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -47,8 +55,9 @@ Widget build(BuildContext context, WidgetRef ref) { ``` :::info -可以同时使用具有不同参数的 family。 -比如，我们可以使用`titleFamily`同时读取法语和英语的翻译： +It is possible to use a family with different parameters simultaneously. +For example, we could use a `titleFamily` to read both the French and English +translations at the same time: ```dart @override @@ -62,20 +71,22 @@ Widget build(BuildContext context, WidgetRef ref) { ::: -## 参数限制 +## Parameter restrictions -为了让family正常工作，传递给provider的参数必须具有一致的 `hashCode` 和 `==`。 +For families to work correctly, it is critical for the parameter passed to +a provider to have a consistent `hashCode` and `==`. +Ideally, the parameter should either be a primitive (bool/int/double/String), +a constant (providers), or an immutable object that overrides `==` and `hashCode`. -理想情况下，参数应该是基础类型(bool/int/double/String)、常量(providers)或重载 `==` 和 `hashCode` 的不可变对象。 +### _PREFER_ using `autoDispose` when the parameter is not constant: -### 当参数不是常量时_最好_使用`autoDispose`: +You may want to use families to pass the input of a search field to your provider. +But that value can change often and never be reused. +This could cause memory leaks as, by default, a provider is never destroyed even +if no longer used. -你可能希望使用family将搜索内容传递给你的provider。 -但是这个值经常会改变，并且永远不会被重用。 -这可能会导致内存泄漏，因为默认情况下，即使不再使用provider也不会销毁。 - -同时使用 `.family` 和 `.autoDispose` 可以解决内存泄漏的问题： +Using both `.family` and `.autoDispose` fixes that memory leak: ```dart final characters = FutureProvider.autoDispose.family, String>((ref, filter) async { @@ -83,21 +94,21 @@ final characters = FutureProvider.autoDispose.family, String>((r }); ``` -## 将多个参数传递给family +## Passing multiple parameters to a family -family不支持将多个值传递给provider。 +Families have no built-in support for passing multiple values to a provider. On the other hand, that value could be _anything_ (as long as it matches with the restrictions mentioned previously). -另一方面，该值可以是任何东西(只要它在前面提到的限制当中)。 -这包括： +This includes: + +- A tuple from [tuple](http://pub.dev/packages/tuple) +- Objects generated with [Freezed] or [built_value](https://pub.dev/packages/built_value) +- Objects using [equatable](https://pub.dev/packages/equatable) -- 一个元组 [tuple](http://pub.dev/packages/tuple) -- 使用[Freezed] 或 [built_value](https://pub.dev/packages/built_value) 生成的对象 -- 使用 [equatable](https://pub.dev/packages/equatable) 的对象 +Here's an example of using [Freezed] or [equatable] for multiple parameters: -下面是使用 [Freezed] 或 [equatable] 来传递多个参数的示例： +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -## 什么时候创建并销毁我的Provider？ +## When does my Provider get created and disposed? -所有不同类型的provider经历的状态是相同的： +The states that all different types of providers can go through are the same: -- 未初始化 -- 活动中 -- 暂停 -- 已销毁 +- Uninitialized +- Alive +- Paused +- Disposed -### 已销毁 / 未初始化 +### Disposed / Uninitialized -**未初始化**或**已销毁**的provider不占用任何内存，因为它的状态没有初始化。 -从本质上来说，它只是定义了在你需要时如何创建provider的状态。 -它将一直保持这种状态，直到**活动中**provider被创建或由于UI中的[WidgetRef] 读取、观察或监听它。 +An **Uninitialized** or **Disposed** provider does not take up any memory since its state is not initialized. +Essentially it is just a definition of how to create the provider's state when you need it. +It will stay that way until an **Alive** provider or a [WidgetRef] from the UI reads, watches, or listens to it. -### 创建中 -> 活动中 +### Creating -> Alive -当读取、监听或观察**未初始化**的provider时，将创建其状态。 +When an **Uninitialized** provider is read, listened to or watched it's state will be created. -在创建期间，你的provider的构建函数将会运行。 -使用回调函数所暴露的 `ref` 读取(read)或观察(watch)的任何provider将根据需要创建，并且将检索它们的状态。 +During creation your provider's build function will be run. +Any providers that you read or watch using the `ref` exposed by the callback will be created as needed and their state will be retrieved. -如果在创建过程中存在任何循环依赖关系，Riverpod将抛出一个错误。 -修复此错误的最佳方式是重新设计依赖项，使其具有单向数据流。 +If there are any circular dependencies during this creation process Riverpod will throw an error. +The best way to fix this error is to redesign your dependencies to have a uni-directional dataflow. -provider的状态存储在 [ProviderContainer] 中。在Flutter应用中，此容器位于[ProviderScope] widget中。 +The provider's state is stored in a [ProviderContainer]. In a Flutter app this container is in a [ProviderScope] widget. -因此，尽管如何创建状态(provider)的定义是全局的，但状态实际上是本地的， -并且使用嵌套的[ProviderScope] widget和覆盖在UI的不同部分中有所不同。 +As such, even though the definition of how to create the state (the provider) is global, the state is actually local, +and can be different in different portions of your UI using nested [ProviderScope] widgets and overrides. -这与flutter widget的工作方式非常相似。你只需为其定义一次， -但是可以根据需要在树的不同部分重用状态。 +This is very similar to how flutter widgets work. You only pay for the definition once, but can reuse the state in different parts of the tree as needed. -### 活动中 +### Alive -当你的provider为**活动中**时，对其状态的更改将导致依赖的provider和/或依赖的UI重新构建。 +When your provider is **Alive**, changes to its state will cause dependent providers and/or the dependent UI to rebuild. -从另一个角度来看，作为响应式框架，你可以观察其他provider，以便在它的某个依赖项发生变化时重建自己。 +From the other perspective, as a reactive framework, you can watch other providers to have the provider recreate itself whenever one of it's dependencies changes. -如果你需要一些依赖于其他状态的长期状态，你可以使用Ref的 [listen] 方法来订阅另一个provider上的更改，而不会导致重新构建该provider。 +If you need to have some long-lived state that depends on other state you can use Ref's [listen] method to subscribe for changes on another provider without causing a rebuild of the provider. -如果你需要使用来自另一个可能有副作用的provider的状态，你可以使用Ref的[read]方法从另一个provider获取当前状态。 +If you need to use the state from another provider in a side-effect, you can use Ref's [read] method to obtain the current state from another provider. -通常，在构造 [StateNotifier] 或 [ChangeNotifier] 类时，应该传入引用， -以允许Notifier根据需要获取依赖项的当前值。 -通过使用来自Riverpod 2.0的新[Notifier] 和 [AsyncNotifier]类，ref已经作为类的实例成员可用。 +Typically when constructing a [StateNotifier] or [ChangeNotifier] class you should pass in the `ref` to allow the Notifier to obtain the current value of dependencies as needed. By using the new [Notifier] and [AsyncNotifier] classes from Riverpod 2.0, the ref is already available as an instance member of the class. -### 活动中 -> 暂停 -当其他provider或UI不再监听**活动的** provider时，它将进入**暂停**状态。这意味着它将不再对正在监听的provider的更改做出反应。 -这是一种优化，如果你没有监听的provider，就没有必要让它保持活动状态。每个未被使用的provider都将返回到**暂停**状态，从而减少你的应用的计算负担。 +### Alive -> Paused +When an **Alive** provider is no longer listened to by other providers or the UI, it goes into a **Paused** state. +This means that it no longer will react to changes on providers it is listening to. +This is an optimization, as if you are not listening to the provider, there is no need to keep it alive. +Every provider not being used will be returned to a **Paused** state, reducing the computational burden of your app. -如果你需要让provider保持活动状态以防止副作用发生，请确保在UI中应该保持活动状态的适当位置监听它。 +If you need to keep a provider alive for side-effects, make sure to listen to it in an appropriate place in the UI where it should be kept alive. -如果你需要在provider暂停时执行一些操作，请使用ref的 [onCancel] 方法来注册回调函数。 +If you need to perform some action when a provider is paused use the ref's [onCancel] method to register callbacks. -当provider从暂停状态恢复到活动状态时，如果你需要执行一些操作，请使用ref的[onResume]方法来注册回调。 +If you need to perform some action when a provider resumes to an Alive state from a paused state, use the ref's [onResume] method to register callbacks. -如果你想销毁状态，那么除了不占用计算资源外，还可以销毁状态的内存，请在provider上使用`.autoDispose`修饰符。 -这将导致它在不再被使用时转换到**已销毁**状态，而不是**暂停**状态。 +If you want the state to be disposed, so that in addition to taking no computational resources, it also disposes of the memory of the state, use the `.autoDispose` modifier on your provider definition. +This will cause it to transition to a **Disposed** state instead of **Paused** when it is no longer being used. -### 活动中 -> 销毁中 +### Alive -> Disposing -销毁provider有几个原因。 +There are a few reasons for a provider to be disposed. -- 当使用`.autoDispose`修饰符定义并不再被UI或其他providerg观察时 -- 当手动刷新或provider失效时 -- 当provider由于被监视的依赖项之一发生变化而被重新创建时 +- When defined using the `.autoDispose` modifier and no longer being watched by the UI or another provider +- When the provider is being manually refreshed or invalidated +- When the provider is being recreated due to one of it's watched dependencies changing -刷新会导致provider立即再次执行创建过程，而无效则会导致provider的下一次读取/观察导致重新构建provider。 +Refreshing causes the provider to immediately go through the creation process again, whereas invalidating causes the next read / watch of the provider to cause the provider to be rebuilt. -## 在状态被销毁前执行操作 -如果你需要在销毁provider时执行一些操作，使用ref的 [onDispose] 方法来注册回调函数。 +## Performing actions before the state destruction +If you need to perform some action when a provider is disposed, use the ref's [onDispose] method to register callbacks. -下面的例子使用onDispose关闭StreamController： +The following example uses onDispose to close a StreamController: :::note -根据所使用的provider，它可能已经处理了清理过程。 -例如，[StateNotifierProvider] 将调用返回的 [StateNotifier] 的`dispose`方法。 +Depending on the provider used, it may already take care of the clean-up process. +For example, [StateNotifierProvider] will call the `dispose` method of the returned [StateNotifier]. ::: [onDispose]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/onDispose.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx index e7584160c..88bec051e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer.mdx @@ -4,25 +4,35 @@ title: ProviderObserver import CodeBlock from "@theme/CodeBlock"; import logger from "!!raw-loader!/docs/concepts/provider_observer_logger.dart"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet } from "@site/src/components/CodeSnippet"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -[ProviderObserver] 可以监听ProviderContainer的变更。 +[ProviderObserver] listens to the changes of a ProviderContainer. -要使用它，请扩展ProviderObserver类并重写要使用的方法。 +To use it, extend the class ProviderObserver and override the method you want to use. -[ProviderObserver] 有三种方法： +[ProviderObserver] has three methods : -- 每次初始化provider时都会调用 `didAddProvider`，并且将值暴露为 `value`。 -- 每次销毁provider时都会调用 `didDisposeProvider`。 -- 每当provider发出通知时，都会调用 `didUpdateProvider`。 +- `didAddProvider` is called every time a provider was initialized, and the value exposed is `value`. +- `didDisposeProvider` is called every time a provider was disposed. +- `didUpdateProvider` is called every time by providers when they emit a notification. -### 用法 +### Usage : -[ProviderObserver] 的一个简单用例是通过重写 `didUpdateProvider` 方法来记录provider中的更改。 +A simple use case for [ProviderObserver] is to log the changes in providers by overriding the `didUpdateProvider` method. {trimSnippet(logger)} -现在，每当我们的provider的值被更新时，记录器都会记录它： +Now, every time the value of our provider is updated, the logger will log it: ``` I/flutter (16783): { @@ -31,12 +41,11 @@ I/flutter (16783): "newValue": "1" I/flutter (16783): } ``` -:::note -对于可变的状态，例如 [StateController] ([StateProvider.state] 的状态)和[ChangeNotifier]， -新旧值将会是相同的。 +:::note: +For states that are mutable such as [StateController] (the state of [StateProvider.state]) and +[ChangeNotifier] the previousValue and newValue will be the same ::: since they reference the same `StateController` / `ChangeNotifier`. -由于他们引用了相同的`StateController` / `ChangeNotifier`。 [providerobserver]: https://pub.dev/documentation/riverpod/latest/riverpod/ProviderObserver-class.html [statecontroller]: https://pub.dev/documentation/riverpod/latest/riverpod/StateController-class.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart new file mode 100644 index 000000000..8ab5ecbae --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/provider_observer_logger.dart @@ -0,0 +1,62 @@ +// ignore_for_file: use_key_in_widget_constructors, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ + +// A Counter example implemented with riverpod with Logger + +class Logger extends ProviderObserver { + @override + void didUpdateProvider( + ProviderBase provider, + Object? previousValue, + Object? newValue, + ProviderContainer container, + ) { + print(''' +{ + "provider": "${provider.name ?? provider.runtimeType}", + "newValue": "$newValue" +}'''); + } +} + +void main() { + runApp( + // Adding ProviderScope enables Riverpod for the entire project + // Adding our Logger to the list of observers + ProviderScope(observers: [Logger()], child: const MyApp()), + ); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return MaterialApp(home: Home()); + } +} + +final counterProvider = StateProvider((ref) => 0, name: 'counter'); + +class Home extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final count = ref.watch(counterProvider); + + return Scaffold( + appBar: AppBar(title: const Text('Counter example')), + body: Center( + child: Text('$count'), + ), + floatingActionButton: FloatingActionButton( + onPressed: () => ref.read(counterProvider.notifier).state++, + child: const Icon(Icons.add), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers.mdx index ff5a7ac2f..e3831587e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers.mdx @@ -2,80 +2,102 @@ title: Providers --- -现在我们安装了 [Riverpod], 接下来我们讲一下 "providers" 相关的概念。 +import creatingProvider from "./providers/creating_a_provider"; +import declaringManyProviders from "./providers/declaring_many_providers"; +import { + AutoSnippet, +} from "@site/src/components/CodeSnippet"; +import { Link } from "@site/src/components/Link"; -Providers 是 [Riverpod] 应用重要的组成部分。 -provider是一个封装了一部分状态的对象，并且能够监听其中的状态。 +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -## 为什么要使用providers? +Now that we have installed [Riverpod], let's talk about "providers". -将一部分状态包裹在provider中: +Providers are the most important part of a [Riverpod] application. +A provider is an object that encapsulates a piece of state and allows listening +to that state. -- 允许在各种地方简单地访问所需的状态。 Provider可以完全取代各种编程模式，比如： - 单例模式、服务定位器模式、依赖注入或 InheritedWidgets。 +## Why use providers? -- 与其他状态组合很容易。 - 想要将多个对象合并成一个对象而感到苦恼? Provider自带了这个功能。 +Wrapping a piece of state in a provider: -- 性能优化。 - 无论是筛选功能的widget还是缓存一个计算量比较大的状态， - provider能够确保只有受状态变化影响的部分才会被重新计算。 +- Allows easily accessing that state in multiple locations. + Providers are a complete replacement for patterns like Singletons, + Service Locators, Dependency Injection or InheritedWidgets. -- 提高你的应用程序的可测试性。 - 使用 provider， 你不需要复杂的 `setUp`/`tearDown` (配置/销毁) 的过程。 - 除此之外，在测试中，任何provider都可以覆盖不同的行为，这能够轻松地测试非常特殊的行为。 +- Simplifies combining this state with others. + Ever struggled to merge multiple objects into one? This scenario is built + directly inside providers. -- 能够方便地集成一些高级的功能, 比如登录或下拉刷新. +- Enables performance optimizations. + Whether for filtering widget rebuilds or for caching expensive state computations; + providers ensure that only what is impacted by a state change is recomputed. -## 创建一个provider +- Increases the testability of your application. + With providers, you do not need complex `setUp`/`tearDown` steps. Furthermore, + any provider can be overridden to behave differently during a test, which + allows easily testing a very specific behavior. -Provider有许多变体，但它们的工作方式都是一样的。 +- Allows easy integration with advanced features, such as logging or + pull-to-refresh. -如下所示，最常见的使用方法是将它们声明为全局常量： +## Creating a provider -```dart -final myProvider = Provider((ref) { - return MyValue(); -}); -``` +Providers come in many variants, but they all work the same way. + +The most common usage is to declare them as global constants like so: + + :::note -不要因为provider的功能全面而感到害怕。Provider是完全不可变的。 -定义一个provider和定义一个函数一样简单，而且provider是可测试和可维护的。 +Do not be frightened by the global aspect of providers. +Providers are fully immutable. Declaring a provider is no different from declaring +a function, and providers are testable and maintainable. ::: -这段代码由三部分组成: +This snippet consists of three components: -- `final myProvider`, 声明myProvider这个变量。 - 这个变量我们将会用来读取其中的状态。 Provider应当一直是 `final`的。 +- `final myProvider`, the declaration of a variable. + This variable is what we will use in the future to read the state of our provider. + Providers should always be `final`. -- `Provider`, 我们决定使用的provider类型。 - [Provider] 大多数provider类型的基础。 它暴露了一个永远不会改变的常量。 - 我们可以吧 [Provider] 换成 其他provider 比如：[StreamProvider] 或 [StateNotifierProvider] - 来改变其中状态的类型。 +- `Provider`, the provider that we decided to use. + [Provider] is the most basic of all providers. It exposes an object that never + changes. + We could replace [Provider] with other providers like [StreamProvider] or + [NotifierProvider], to change how the value is interacted with. -- 一个创建共享状态的函数。 - 那个函数会接收一个叫`ref`的对象作为参数。这个`ref`对象能够让我们在函数中读取其他的provider， - 当provider中的状态需要销毁时执行一些操作等等。 +- A function that creates the shared state. + That function will always receive an object called `ref` as a parameter. This object + allows us to read other providers, perform some operations when the state + of our provider will be destroyed, and much more. -provider中的函数返回的对象类型取决于使用provider类型。 -比如一个 [Provider] 的函数中可以返回任意的对象。 -再比如说[StreamProvider]中的函数的返回值类型只能是[Stream]。 +The type of the object returned by the function passed to a provider depends on +the provider used. +For example, the function of a [Provider] can create any object. +On the other hand, [StreamProvider]'s callback will be expected to return a [Stream]. :::info -你可以没有限制地声明各种provider。 -与使用 `package:provider` 相反, [Riverpod] 允许创建多个相同类型且暴露不同状态的provider： +You can declare as many providers as you want without limitations. +As opposed to when using `package:provider`, [Riverpod] allows creating multiple +providers exposing a state of the same "type": -```dart -final cityProvider = Provider((ref) => 'London'); -final countryProvider = Provider((ref) => 'England'); -``` + -创建都是`String`类型的provider不会有任何问题。 +The fact that both providers create a `String` does not cause any problem. ::: :::caution -在Flutter平台上，为了让provider正常工作，你必须用 [ProviderScope] 包裹你的Flutter应用： +For providers to work, you must add [ProviderScope] at the root of your +Flutter applications: ```dart void main() { @@ -85,48 +107,52 @@ void main() { ::: -## 不同类型的Provider +## Different Types of Providers -有很多类型的provider可供在不同的情况下使用。 +There are multiple types of providers for multiple different use cases. -由于这些不同类型provider都可使用，有的时候很难理解什么时候应该使用这种provider而不是另外一种provider。 -选择下面表格中的provider添加到你的应用中。 +With all of these providers available, it is sometimes difficult to understand when to use one provider type over another. +Use the table below to choose a provider that fits what you want to provide to the widget tree. -| Provider 类型 | 创建Provider的函数 | 使用场景 | -| ------------------------ | -------------------------- | -------------------------------------------------- | -| [Provider] | 返回任意类型 | 服务类 / 计算属性 (过滤的列表) | -| [StateProvider] | 返回任意类型 | 过滤条件/简单状态对象 | -| [FutureProvider] | 返回任意类型的Future | API调用的结果 | -| [StreamProvider] | 返回任意类型的Stream | API返回的Stream | -| [StateNotifierProvider] | 返回StateNotifier的子类 | 一种复杂的状态对象，除了通过接口之外，它是不可变的 | -| [ChangeNotifierProvider] | 返回ChangeNotifier的子类 | 需要可变的复杂状态对象 | +| Provider Type | Provider Create Function | Example Use Case | +| ------------------------ | ------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| [Provider] | Returns any type | A service class / computed property (filtered list) | +| [StateProvider] | Returns any type | A filter condition / simple state object | +| [FutureProvider] | Returns a Future of any type | A result from an API call | +| [StreamProvider] | Returns a Stream of any type | A stream of results from an API | +| [NotifierProvider] | Returns a subclass of (Async)Notifier | A complex state object that is immutable except through an interface | +| [StateNotifierProvider] | Returns a subclass of StateNotifier | A complex state object that is immutable except through an interface. Prefer using a notifierProvider | +| [ChangeNotifierProvider] | Returns a subclass of ChangeNotifier | A complex state object that requires mutability | :::caution -尽管所有的provider都有它的使用目的，由于 [不可变状态相关的问题](/docs/concepts/why_immutability) 的原因， -我们不推荐在较大型的应用程序中使用 [ChangeNotifierProvider] 。 -`flutter_riverpod` 中的 [ChangeNotifierProvider] 提供了一个简单的方式来让你从 `package:provider` 迁移到 [riverpod] ， -这允许一些 flutter 上一些特定的用法比如与Navigator 2 package 集成。 -::: +While all providers have their purpose, [ChangeNotifierProvider]s are not recommended for scalable applications. See . It exists in the +`flutter_riverpod` package to provide an easy migration path from +`package:provider`, and allows for some flutter specific use-cases such as +integration with some Navigator 2 packages. ::: -## Provider 修饰符 +## Provider Modifiers -所有的Provider都有一个内置的方式为不同的provider添加额外的功能。 +All Providers have a built-in way to add extra functionalities to your different providers. -它们可能会向`ref`对象添加额外的功能或改变provider的使用方式。 -修饰符可以在所有provider上通过简单的命名构造器使用： +They may add new features to the `ref` object or change slightly how the provider +is consumed. +Modifiers can be used on all providers, with a syntax similar to named constructor: ```dart final myAutoDisposeProvider = StateProvider.autoDispose((ref) => 0); final myFamilyProvider = Provider.family((ref, id) => '$id'); ``` -目前有两个修饰符可用: +At the moment, there are two modifiers available: -- [`.autoDispose`](/docs/concepts/modifiers/auto_dispose)可以在状态不在被监听的情况下让provider自动销毁。 -- [`.family`](/docs/concepts/modifiers/family)可以创建有外部参数的provider。 +- , which will make the + provider automatically destroy its state when it is no longer being listened + to. +- , which allows creating a + provider from external parameters. :::note -provider能一次使用多个修饰符: +A provider can use multiple modifiers at once: ```dart final userProvider = FutureProvider.autoDispose.family((ref, userId) async { @@ -136,10 +162,10 @@ final userProvider = FutureProvider.autoDispose.family((ref, userId) ::: -着就是本指南的内容! +That's it for this guide! -继续阅读 [如何读取provider](/docs/concepts/reading) -或者学习 [如何组合provider](/docs/concepts/combining_providers)。 +You can continue with . +Alternatively, you can see . [get_it]: http://pub.dev/packages/get_it [inheritedwidget]: https://api.flutter.dev/flutter/widgets/InheritedWidget-class.html @@ -154,6 +180,6 @@ final userProvider = FutureProvider.autoDispose.family((ref, userId) [futureprovider]: /docs/providers/future_provider [stateprovider]: /docs/providers/state_provider [statenotifierprovider]: /docs/providers/state_notifier_provider +[notifierProvider]: /docs/providers/notifier_provider [changenotifierprovider]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ChangeNotifierProvider-class.html - [providerscope]: https://pub.dev/documentation/flutter_riverpod/latest/flutter_riverpod/ProviderScope-class.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart new file mode 100644 index 000000000..8dc6c5e12 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.dart @@ -0,0 +1,12 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class MyValue {} + +/* SNIPPET START */ + +@riverpod +MyValue my(MyRef ref) { + return MyValue(); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart new file mode 100644 index 000000000..bb1efdb5f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/codegen.g.dart @@ -0,0 +1,72 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef MyRef = Ref; + +@ProviderFor(my) +const myProvider = MyProvider._(); + +final class MyProvider extends $FunctionalProvider + with $Provider { + const MyProvider._( + {MyValue Function( + MyRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyValue Function( + MyRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$myHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + MyProvider $copyWithCreate( + MyValue Function( + MyRef ref, + ) create, + ) { + return MyProvider._(create: create); + } + + @override + MyValue create(MyRef ref) { + final _$cb = _createCb ?? my; + return _$cb(ref); + } +} + +String _$myHash() => r'0810ee24cae78c131d00773ac20d254c83eefab7'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart new file mode 100644 index 000000000..d63faf94b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/creating_a_provider/raw.dart @@ -0,0 +1,9 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class MyValue {} + +/* SNIPPET START */ + +final myProvider = Provider((ref) { + return MyValue(); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart new file mode 100644 index 000000000..474fe004b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.dart @@ -0,0 +1,10 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +String city(CityRef ref) => 'London'; +@riverpod +String country(CountryRef ref) => 'England'; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart new file mode 100644 index 000000000..8b589ad1e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/codegen.g.dart @@ -0,0 +1,132 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CityRef = Ref; + +@ProviderFor(city) +const cityProvider = CityProvider._(); + +final class CityProvider extends $FunctionalProvider + with $Provider { + const CityProvider._( + {String Function( + CityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'cityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + CityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$cityHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CityProvider $copyWithCreate( + String Function( + CityRef ref, + ) create, + ) { + return CityProvider._(create: create); + } + + @override + String create(CityRef ref) { + final _$cb = _createCb ?? city; + return _$cb(ref); + } +} + +String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; + +typedef CountryRef = Ref; + +@ProviderFor(country) +const countryProvider = CountryProvider._(); + +final class CountryProvider + extends $FunctionalProvider + with $Provider { + const CountryProvider._( + {String Function( + CountryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'countryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + CountryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$countryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CountryProvider $copyWithCreate( + String Function( + CountryRef ref, + ) create, + ) { + return CountryProvider._(create: create); + } + + @override + String create(CountryRef ref) { + final _$cb = _createCb ?? country; + return _$cb(ref); + } +} + +String _$countryHash() => r'd1513349c3bc0c99763cb4fb29eb012f2351bc4c'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart new file mode 100644 index 000000000..09d8a659f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/providers/declaring_many_providers/raw.dart @@ -0,0 +1,6 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +final cityProvider = Provider((ref) => 'London'); +final countryProvider = Provider((ref) => 'England'); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading.mdx index 3f6c19154..fffa27013 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading.mdx @@ -1,9 +1,7 @@ --- -title: 读取 Provider +title: Reading a Provider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import counter from "./reading/counter"; import consumerWidget from "./reading/consumer_widget"; @@ -22,58 +20,74 @@ import { trimSnippet, AutoSnippet, When, -} from "../../../../../src/components/CodeSnippet"; +} from "@site/src/components/CodeSnippet"; +import { Link } from "@site/src/components/Link"; -在阅读本指南之前，请确保先阅读有关[Providers](/docs/concepts/providers)的内容。 +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: + +Before reading this guide, make sure to first. -在本指南中，我们将了解如何使用provider。 +In this guide, we will see how to consume a provider. -## 获取一个“ref”对象 +## Obtaining a "ref" object -首先，也是最重要的，在读取provider之前，我们需要获取一个“ref”对象。 +First and foremost, before reading a provider, we need to obtain a "ref" object. -这个对象能够让我们与provider交互，不管是来自widget还是其他provider。 +This object is what allows us to interact with providers, be it from a widget +or another provider. -### 从provider获取“ref” +### Obtaining a "ref" from a provider -所有provider都接收一个“ref”作为参数： +All providers receive a "ref" as a parameter: -将此参数传递给provider暴露的值是安全的。 +This parameter is safe to pass to the value exposed by the provider. -一个常见的用例是将provider的“ref”传递给`StateNotifier` +A common use-case is to pass the provider's "ref" to a `StateNotifier` -这样做允许`Counter`类读取provider。 +Doing so allows our `Counter` class to read providers. -### 从widget获取“ref” +### Obtaining a "ref" from a widget -Widget自然没有ref参数。但是 [Riverpod] 提供了多种从widget中获取ref的解决方案。 +Widgets naturally do not have a ref parameter. But [Riverpod] offers multiple +solutions to obtain one from widgets. -#### 扩展ConsumerWidget而不是StatelessWidget +#### Extending ConsumerWidget instead of StatelessWidget -在widget树中获取ref的最常用方法是将 [StatelessWidget] 替换为 [ConsumerWidget] 。 +The most common way to obtain a ref in the widget tree is +to replace [StatelessWidget] with [ConsumerWidget]. -[ConsumerWidget] 在用法上与 [StatelessWidget] 相同，唯一的区别是它在构建方法上有一个额外的参数:“ref”对象。 +[ConsumerWidget] is identical in use to [StatelessWidget], with the only +difference being that it has an extra parameter on its build method: the "ref" object. -一个典型的 [ConsumerWidget] 如下所示: +A typical [ConsumerWidget] looks like: -#### 扩展ConsumerStatefulWidget+ConsumerState而不是StatefulWidget+State +#### Extending ConsumerStatefulWidget+ConsumerState instead of StatefulWidget+State -与 [ConsumerWidget] 类似， [ConsumerStatefulWidget] 和 [ConsumerState] -等价于带有状态的StatefulWidget，区别在于状态中有一个“ref”对象。 +Similar to [ConsumerWidget], [ConsumerStatefulWidget] and [ConsumerState] are the equivalent of a +[StatefulWidget] with its [State], with the difference that the state has a "ref" object. -这一次，“ref”没有作为构建方法的参数传递，而是作为 [ConsumerState] 对象的属性传递： +This time, the "ref" isn't passed as parameter of the build method, but is +a property of the [ConsumerState] object: @@ -81,226 +95,251 @@ Widget自然没有ref参数。但是 [Riverpod] 提供了多种从widget中获 -#### 扩展HookConsumerWidget类而不是HookWidget类 +#### Extending HookConsumerWidget instead of HookWidget -此选项适用于使用 [flutter_hooks] 的用户。由于 [flutter_hooks] 需要扩展 [HookWidget] 才能工作， -使用钩子的widget无法扩展 [ConsumerWidget]。 +This option is for [flutter_hooks] users. Since [flutter_hooks] requires +extending [HookWidget] to work, widgets that use hooks are unable to extend +[ConsumerWidget]. -[hooks_riverpod] package 暴露了一个名为 [HookConsumerWidget] 的widget。 -[HookConsumerWidget] 同时充当 [ConsumerWidget] 和 [HookWidget]。 -这允许widget既监听provider又使用钩子。 +The package [hooks_riverpod] exposes a new widget called [HookConsumerWidget]. +[HookConsumerWidget] acts as both a [ConsumerWidget] and a [HookWidget]. This +allows a widget to both listen to providers and use hooks. -比如说： +An example would be: -#### 扩展 StatefulHookConsumerWidget 而不是 HookWidget +#### Extending StatefulHookConsumerWidget instead of HookWidget -此选项适用于 [flutter_hooks] 用户，他们需要使用 [StatefulWidget] 生命周期方法还有钩子。 +This option is for [flutter_hooks] users, who need to use [StatefulWidget] lifecycle methods in addition to hooks. + +An example would be: -举个例子： -#### Consumer 和 HookConsumer widgets +#### Consumer and HookConsumer widgets -获得widget内部的“ref”的最后一种方法是依赖 [Consumer]/[HookConsumer]。 +A final way to obtain a "ref" inside widgets is to rely on [Consumer]/ +[HookConsumer]. -这些类是可用于在build回调中获取“ref”的widget，具有与 [ConsumerWidget]/[HookConsumerWidget] 相同的属性。 +These classes are widgets that can be used to obtain a "ref" in a builder callback, with the same +properties as [ConsumerWidget]/[HookConsumerWidget]. -因此，这些widget是一种不需要定义类就能获得“ref”的方法。比如： +As such, these widgets are a way to obtain a "ref" without having to define a class. +An example would be: {trimSnippet(consumerHook)} -## 使用ref与provider交互 +## Using ref to interact with providers -现在我们有了一个“ref”，我们可以开始使用它了。 +Now that we have a "ref", we can start using it. -“ref”有三种主要用法： +There are three primary usages for "ref": -- 获取provider的值并监听更改，这样当该值发生更改时， - 将重新构建订阅该值的widget或provider。 - 这是使用 `ref.watch` 完成的 -- 在provider上添加监听器，以执行诸如导航到新页面或每当provider更改时显示模态框等操作。 - 这是使用 `ref.listen` 完成的。 -- 在忽略更改的情况下获取provider的值。 - 当我们在诸如“on click”之类的事件中需要provider的值时很有用。 - 这是使用 `ref.read` 完成的。 +- obtaining the value of a provider and listening to changes, such that when + this value changes, this will rebuild the widget or provider that subscribed + to the value. + This is done using `ref.watch` +- adding a listener on a provider, to execute an action such as navigating to a new + page or showing a modal whenever that provider changes. + This is done using `ref.listen`. +- obtaining the value of a provider while ignoring changes. + This is useful when we need the value of a provider in an event + such as "on click". + This is done using `ref.read`. :::note -尽可能使用 `ref.watch` 而不是 `ref.read` 或 `ref.listen` 来实现你的功能。 -通过依赖 `ref.watch` ，你的应用变得既具有响应性又具有声明性，这使得项目会更易于维护。 +Whenever possible, prefer using `ref.watch` over `ref.read` or `ref.listen` to +implement a feature. +By relying on `ref.watch`, your application becomes both reactive +and declarative, which makes it more maintainable. ::: ### Using ref.watch to observe a provider -### 使用 ref.watch 观察provider -Ref.watch在widget的`build`方法中或在provider的主体中使用，以使widget/provider监听provider： +`ref.watch` is used inside the `build` method of a widget or +inside the body of a provider to have the widget/provider listen to a provider: -例如，一个provider可以使用 `ref.watch` 将多个provider组合成一个新值。 +For example, a provider could use `ref.watch` to combine multiple providers +into a new value. -筛选待办清单就是一个例子。我们可以有两个provider： +An example would be filtering a todo-list. +We could have two providers: -- `filterTypeProvider`，一个能够暴露当前过滤器类型(不显示，只显示完成的内容等等)的provider。 - -- `todosProvider`，暴露整个待办清单列表的provider。 +- `filterTypeProvider`, a provider that exposes the current type of filter + (none, show only completed tasks, ...) +- `todosProvider`, a provider that exposes the entire list of tasks -通过 `ref.watch`，我们可以创建第三个provider， -它结合了这两个provider来创建一个过滤过的待办清单列表： +And by using `ref.watch`, we could make a third provider that combines both providers to +create a filtered list of tasks: -有了这段代码，`filteredTodoListProvider` 现在暴露了过滤后的清单列表。 +With this code, `filteredTodoListProvider` now exposes the filtered list of tasks. -如果筛选器或待办清单列表发生变化，筛选后的列表也会自动更新。 -同时，如果过滤器和待办清单列表都没有改变，则不会重新计算那个列表。 +The filtered list will also automatically update if either the filter or the list of tasks +changed. At the same time, the filtered list will not be recomputed if +neither the filter nor the list of tasks changed. -类似地，widget可以使用ref.watch显示来自provider的内容， -并在内容发生变化时更新用户界面： +Similarly, a widget can use `ref.watch` to show +the content from a provider and update the user interface whenever that content changes: -这个代码段显示了一个widget，它监听了存储`count`的provider。 -如果该`count`发生变化，widget将重新构建，UI将更新以显示新的值。 +This snippet shows a widget that listens to a provider which stores a `count`. +And if that `count` changes, the widget will rebuild and the UI will update +to show the new value. :::caution -像在 [ElevatedButton] 的 `onPressed` 中那样，`watch` 方法不应该被异步调用。 -它也不应该在 `initState` 和其他 [State] 的生命周期中使用。 +The `watch` method should not be called asynchronously, +like inside an `onPressed` of an [ElevatedButton]. Nor should it be used +inside `initState` and other [State] life-cycles. -在这种情况下，请考虑使用 `ref.read`。 +In those cases, consider using `ref.read` instead. ::: -### 使用ref.listen来响应provider的变化 +### Using ref.listen to react to a provider change -与 `ref.watch` 类似，也可以使用ref.listen来观察一个provider。 +Similarly to `ref.watch`, it is possible to use `ref.listen` to observe a provider. The main difference between them is that, rather than rebuilding the widget/provider if the listened to provider changes, using `ref.listen` will instead call a custom function. -它们之间的主要区别是，如果监听的provider发生更改， -使用 `ref.listen` 将调用自定义的函数，而不是重新构建widget/provider。 -这对于在发生特定变化时执行操作很有用，例如在发生错误时显示snackbar。 +That can be useful for performing actions when a certain change happens, such +as showing a snackbar when an error happens. -`ref.listen` 方法需要两个位置参数，第一个是Provider，第二个是当状态改变时我们想要执行的回调函数。 -当调用回调函数时将传递前一个状态的值和新状态的值。 +The `ref.listen` method needs 2 positional arguments, the first one is the Provider and the second one is the callback function that we want to execute when the state changes. +The callback function when called will be passed 2 values, the value of the previous State and the value of the new State. -`ref.listen` 方法可以在provider内部使用： +The `ref.listen` method can be used inside the body of a provider: -或者在widget的 `build` 方法中： +or inside the `build` method of a widget: :::caution -像在 [ElevatedButton] 的 `onPressed` 中那样，`listen` 方法不应该被异步调用。 -它也不应该在 `initState` 和其他 [State] 的生命周期中使用。 +The `listen` method should not be called asynchronously, +like inside an `onPressed` of an [ElevatedButton]. Nor should it be used +inside `initState` and other [State] life-cycles. ::: -### 使用ref.read获取一个provider的状态 +### Using ref.read to obtain the state of a provider -`ref.read` 是一种不监听provider状态的方法。 +The `ref.read` method is a way to obtain the state of a provider without listening to it. -它通常在用户交互触发的函数中使用。 -例如，我们可以使用 `ref.read` 在用户单击按钮时将计数器数值加1： +It is commonly used inside functions triggered by user interactions. +For example, we can use `ref.read` to increment a counter when a user clicks a button: :::note -你应该尽量避免使用 `ref.read` ，因为它不是响应式的。 +Using `ref.read` should be avoided as much as possible because it is not reactive. -它的存在是由于使用 `watch` 或 `listen` 会导致问题。如果可以，使用 `watch`/`listen` 更好，尤其是 `watch`。 +It exists for cases where using `watch` or `listen` would cause issues. +If you can, it is almost always better to use `watch`/`listen`, especially `watch`. ::: -#### **不要**在build方法中使用 `ref.read` +#### **DON'T** use `ref.read` inside the build method -你可能会想使用 `ref.read` 来优化widget的性能： +You might be tempted to use `ref.read` to optimize the performance of a widget +by doing: -但这样做是非常糟糕的，它可能会导致预料之外的bug。 +But this is a very bad practice and can cause bugs that are difficult to track. -以这种方式使用 `ref.read` 通常会让人觉得“provider暴露的值永远不会改变， -所以使用 `ref.read` 是安全的”。但问题是， -虽然现在的provider可能确实永远不会更新它的值，但你无法保证以后的值还是一样的。 +Using `ref.read` this way is commonly associated with the thought "The value +exposed by a provider never changes so using 'ref.read' is safe". The problem +with this assumption is that, while today that provider may indeed never update +its value, there is no guarantee that tomorrow will be the same. -应用往往会发生很多变更，假设在未来，以前从未改变的一个值将需要改变。 -如果你使用 `ref.read`，当该值需要更改时，你必须遍历整个代码库将 `ref.read` 更改为 `ref.watch`， -这很容易出错，而且你很可能会忘记某些情况。 +Software tends to change a lot, and it is likely that in the future, a value +that previously never changed will need to change. +If you use `ref.read`, when that value needs to change, you have +to go through your entire codebase to change `ref.read` into `ref.watch` – +which is error prone and you are likely to forget some cases. -但如果一开始就使用 `ref.watch`，当你重构时遇到的问题就会更少。 +If you use `ref.watch` to begin with, you will have fewer problems when refactoring. -**_但是我想要用 `ref.read` 来减少小部件重新构建的次数_** +**_But I wanted to use `ref.read` to reduce the number of times my widget rebuilds_** -这个想法很好，但需要注意的是，使用 `ref.watch` 也可以达到完全相同的效果(减少重新构建的次数)。 +While the goal is commendable, it is important to note that you can achieve the +exact same effect (reducing the number of builds) using `ref.watch` instead. -provider提供了许多获取值的方法，同时也减少了重新构建的次数，你可以使用这些方法。 +Providers offer various ways to obtain a value while reducing the number of +rebuilds, which you could use instead. -比如，不应该这样： +For example instead of -我们应该: +we could do: -这两段代码实现了相同的效果：当计数器增加时，我们的按钮也不会重新构建。 +Both snippets achieve the same effect: our button will not rebuild when the +counter increments. -另一方面，第二种方法支持重置计数器。例如，应用的另一部分可以调用： +On the other hand, the second approach supports cases where the counter is reset. +For example, another part of the application could call: ```dart ref.refresh(counterProvider); ``` + +which would recreate the `StateController` object. - -来重新创建 `Counter` 对象。 - -如果我们在这里使用 `ref.read`，我们的按钮仍将使用之前的 `StateController` 实例， -但实际上该实例已被丢弃，不应该再使用。 -当我们正确使用 `ref.watch` 将重新构建按钮以使用新的 `Counter`实例 +If we used `ref.read` here, our button would still use the previous +`StateController` instance, which was disposed and should no-longer be used. +Whereas using `ref.watch` correctly rebuilds the button to use the new +`StateController`. -来重新创建 `Counter` 对象。 +which would recreate the `Counter` object. -如果我们在这里使用 `ref.read`，我们的按钮仍将使用之前的 `Counter` 实例， -但实际上该实例已被丢弃，不应该再使用。 -而正确使用 `ref.watch` 将重新构建按钮以使用新的 `Counter`实例。 +If we used `ref.read` here, our button would still use the previous `Counter` +instance, which was disposed and should no-longer be used. Whereas using +`ref.watch` correctly rebuilds the button to use the new `Counter`. -## 选择读取的方式 +## Deciding what to read -根据你想要监听的provider，你可能有多个可以监听的值。 +Depending on the provider you want to listen to, you may have multiple possible +values that you can listen to. -比如，考虑以下 [StreamProvider]： +As an example, consider the following [StreamProvider]: ```dart final userProvider = StreamProvider(...); ``` -当读取这个 `userProvider` 时，你可以： +When reading this `userProvider`, you can: -- 通过监听 `userProvider` 本身 同步读取当前状态： +- synchronously read the current state by listening to `userProvider` itself: ```dart Widget build(BuildContext context, WidgetRef ref) { AsyncValue user = ref.watch(userProvider); - return user.when( - loading: () => const CircularProgressIndicator(), - error: (error, stack) => const Text('Oops'), - data: (user) => Text(user.name), - ); + return switch (user) { + AsyncData(:final value) => Text(value.name), + AsyncError(:final error) => const Text('Oops $error'), + _ => const CircularProgressIndicator(), + }; } ``` -- 通过监听 `userProvider.stream` 获取关联的 [Stream]： +- obtain the associated [Stream], by listening to `userProvider.stream`: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -308,7 +347,7 @@ final userProvider = StreamProvider(...); } ``` -- 通过监听 `userProvider.future`，获得一个解析最新值的 [Future] ： +- obtain a [Future] that resolves with the latest value emitted, by listening to `userProvider.future`: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -316,18 +355,21 @@ final userProvider = StreamProvider(...); } ``` -不同的provider可能提供用法。 -要了解更多信息，请阅读[API 参考](https://pub.dev/documentation/riverpod/latest/riverpod/riverpod-library.html)来获取每个provider的文档。 +Other providers may offer different alternative values. +For more information, refer to the documentation of each provider by +consulting the [API reference](https://pub.dev/documentation/riverpod/latest/riverpod/riverpod-library.html). -## 使用“select”来过滤重建内容 +## Using "select" to filter rebuilds -与读取provider相关的最后一个特性是能够减少widget/provider从 `ref.watch` 重新构建的次数， -或者减少 `ref.listen` 执行函数的频率。 +One final feature to mention related to reading providers is the ability to +reduce the number of times a widget/provider rebuilds from `ref.watch`, or how often `ref.listen` +executes a function. -记住，这一点很重要，因为默认情况下，监听provider将监听整个对象状态。 -但有时widget/provider可能只关心某些属性的更改，而不是整个对象。 +This is important to keep in mind as, by default, listening to a provider +listens to the entire object state. But sometimes, a widget/provider may only +care about changes to some properties instead of the whole object. -比如说，一个provider可能暴露一个 `User` 对象： +For example, a provider may expose a `User`: ```dart abstract class User { @@ -336,7 +378,7 @@ abstract class User { } ``` -但是widget可能只使用用户名： +But a widget may only use the user name: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -345,11 +387,13 @@ Widget build(BuildContext context, WidgetRef ref) { } ``` -如果我们简单地使用 `ref.watch`，这将在用户年龄(`age`)发生变化时重新构建widget。 +If we naively used `ref.watch`, this would rebuild the widget when the user's +`age` changes. -解决方案是使用 `select` 显式地告诉Riverpod我们只想监听 `User` 的 `name` 属性。 +The solution is to use `select` to explicitly tell Riverpod that we only +want to listen to the name property of the `User`. -更新后的代码如下: +The updated code would be: ```dart Widget build(BuildContext context, WidgetRef ref) { @@ -358,15 +402,17 @@ Widget build(BuildContext context, WidgetRef ref) { } ``` -通过使用 `select`，我们可以指定一个返回我们所关心的属性的函数。 - -每当 `User` 发生变化时，Riverpod将调用该函数并比较以前和新的结果。 -如果它们是不同的(例如当名称更改时)，Riverpod将重新构建widget。 +By using `select`, we are able to specify a function +that returns the property that we care about. -当然了，如果它们相等(例如当年龄改变时)，Riverpod将不会重建widget。 +Whenever the `User` changes, Riverpod will call this function and +compare the previous and new result. If they are different (such as when the name +changed), Riverpod will rebuild the widget. +However, if they are equal (such as when the age changed), Riverpod will not +rebuild the widget. :::info -也可以 `select` 和 `ref.listen` 结合使用： +It is also possible to use `select` with `ref.listen`: ```dart ref.listen( @@ -377,11 +423,12 @@ ref.listen( ); ``` -这样做只会在名称更改时调用监听器。 +Doing so will call the listener only when the name changes. ::: :::tip -你不需要返回对象的属性。任何可以使用==的值都可以工作。举个例子： +You don't have to return a property of the object. Any value that +overrides == will work. For example you could do: ```dart final label = ref.watch(userProvider.select((user) => 'Mr ${user.name}')); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart index 518561f7e..7b9118cbc 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/hooks.dart @@ -18,16 +18,16 @@ class HomeViewState extends ConsumerState { @override void initState() { super.initState(); - // “ref” 可以在 StatefulWidget 的所有的生命周期内使用。 + // "ref" can be used in all life-cycles of a StatefulWidget. ref.read(counterProvider); } @override Widget build(BuildContext context) { - // 我们可以在builder中使用钩子如同HookConsumerWidget使用的那样 + // Like HookConsumerWidget, we can use hooks inside the builder final state = useState(0); - // 我们也可以在build函数中使用“ref”监听provider + // We can also use "ref" to listen to a provider inside the build method final counter = ref.watch(counterProvider); return Text('$counter'); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/raw.dart index 0219623b1..98d7f3403 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_stateful_widget/raw.dart @@ -15,13 +15,13 @@ class HomeViewState extends ConsumerState { @override void initState() { super.initState(); - // “ref” 可以在 StatefulWidget 的所有的生命周期内使用。 + // "ref" can be used in all life-cycles of a StatefulWidget. ref.read(counterProvider); } @override Widget build(BuildContext context) { - // 我们也可以在build函数中使用“ref”监听provider + // We can also use "ref" to listen to a provider inside the build method final counter = ref.watch(counterProvider); return Text('$counter'); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/hooks.dart index 8dd75334f..1c5547428 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/hooks.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/hooks.dart @@ -12,10 +12,10 @@ class HomeView extends HookConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // HookConsumerWidget允许在build方法中使用钩子 + // HookConsumerWidget allows using hooks inside the build method final state = useState(0); - // 我们也可以使用ref参数来监听provider。 + // We can also use the ref parameter to listen to providers. final counter = ref.watch(counterProvider); return Text('$counter'); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/raw.dart index a450ed37b..d2df7c5a7 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/consumer_widget/raw.dart @@ -9,7 +9,7 @@ class HomeView extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 使用ref监听provider + // use ref to listen to a provider final counter = ref.watch(counterProvider); return Text('$counter'); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart index 6d27d9d4d..a23405835 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/codegen.dart @@ -17,7 +17,7 @@ class Counter extends _$Counter { int build() => 0; void increment() { - // Counter可以使用“ref”读取其他provider + // Counter can use the "ref" to read other providers final repository = ref.read(repositoryProvider); repository.post('...'); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart index 03642c727..5d248ab57 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/counter/raw.dart @@ -19,7 +19,7 @@ class Counter extends StateNotifier { final Ref ref; void increment() { - // Counter可以使用“ref”读取其他provider + // Counter can use the "ref" to read other providers final repository = ref.read(repositoryProvider); repository.post('...'); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart new file mode 100644 index 000000000..5b1147d28 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.dart @@ -0,0 +1,34 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_hooks.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; +} + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(counterProvider, (int? previousCount, int newCount) { + print('The counter changed $newCount'); + }); + + final greeting = useState('Hello'); + + return Container( + alignment: Alignment.center, + child: Text(greeting.value), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart new file mode 100644 index 000000000..a6d55dcde --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/codegen_hooks.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_hooks.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterHash() => r'4320f811608c7a6e7342b83e3031965a34f7cb8e'; + +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx index 339b89a56..a856c4980 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/index.tsx @@ -1,9 +1,11 @@ import raw from "!!raw-loader!./raw.dart"; import codegen from "!!raw-loader!./codegen.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; +import codegen_hooks from "!!raw-loader!./codegen_hooks.dart"; export default { raw, - hooks: raw, + hooks: raw_hooks, codegen, - hooksCodegen: codegen, + hooksCodegen: codegen_hooks, }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart new file mode 100644 index 000000000..ac38732a5 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/listen_build/raw_hooks.dart @@ -0,0 +1,29 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import '../counter/raw.dart'; + +/* SNIPPET START */ + +final counterProvider = StateNotifierProvider(Counter.new); + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(counterProvider, (int? previousCount, int newCount) { + print('The counter changed $newCount'); + }); + + final greeting = useState('Hello'); + + return Container( + alignment: Alignment.center, + child: Text(greeting.value), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart index a3401479c..201c92f91 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/codegen.dart @@ -14,7 +14,7 @@ Repository repository(RepositoryRef ref) => Repository(); @riverpod String value(ValueRef ref) { - // 使用ref获取其他provider + // use ref to obtain other providers final repository = ref.watch(repositoryProvider); return repository.get(); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart index 27baf53bd..28fdfed97 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/provider/raw.dart @@ -13,7 +13,7 @@ final repositoryProvider = Provider((ref) { /* SNIPPET START */ final valueProvider = Provider((ref) { - // 使用ref获取其他provider + // use ref to obtain other providers final repository = ref.watch(repositoryProvider); return repository.get(); }); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart index 4e7f1e139..0742ed5e5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen.dart @@ -23,7 +23,7 @@ class HomeView extends ConsumerWidget { return Scaffold( floatingActionButton: FloatingActionButton( onPressed: () { - // 对“Counter”类调用“increment()”方法 + // Call `increment()` on the `Counter` class ref.read(counterProvider.notifier).increment(); }, ), diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart new file mode 100644 index 000000000..341087cde --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.dart @@ -0,0 +1,36 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_hooks.g.dart'; + +/* SNIPPET START */ + +@riverpod +class Counter extends _$Counter { + @override + int build() => 0; + void increment() => state = state + 1; +} + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final greeting = useState('Hello'); + + return Scaffold( + body: Center(child: Text(greeting.value)), + floatingActionButton: FloatingActionButton( + onPressed: () { + // Call `increment()` on the `Counter` class + ref.read(counterProvider.notifier).increment(); + }, + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart new file mode 100644 index 000000000..681ff8533 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/codegen_hooks.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_hooks.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $NotifierProvider { + const CounterProvider._( + {super.runNotifierBuildOverride, Counter Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Counter Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Counter create() => _createCb?.call() ?? Counter(); + + @$internal + @override + CounterProvider $copyWithCreate( + Counter Function() create, + ) { + return CounterProvider._(create: create); + } + + @$internal + @override + CounterProvider $copyWithBuild( + int Function( + Ref, + Counter, + ) build, + ) { + return CounterProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; + +abstract class _$Counter extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx index 339b89a56..d0caf89aa 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/index.tsx @@ -1,9 +1,11 @@ import raw from "!!raw-loader!./raw.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; import codegen from "!!raw-loader!./codegen.dart"; +import codegen_hooks from "!!raw-loader!./codegen_hooks.dart"; export default { raw, - hooks: raw, + hooks: raw_hooks, codegen, - hooksCodegen: codegen, + hooksCodegen: codegen_hooks, }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart index 6478ae609..c30eeb5f2 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw.dart @@ -8,8 +8,7 @@ import '../counter/raw.dart'; /* SNIPPET START */ -final counterProvider = - StateNotifierProvider(Counter.new); +final counterProvider = StateNotifierProvider(Counter.new); class HomeView extends ConsumerWidget { const HomeView({super.key}); @@ -19,7 +18,7 @@ class HomeView extends ConsumerWidget { return Scaffold( floatingActionButton: FloatingActionButton( onPressed: () { - // 对“Counter”类调用“increment()”方法 + // Call `increment()` on the `Counter` class ref.read(counterProvider.notifier).increment(); }, ), diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart new file mode 100644 index 000000000..bde77d3a8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read/raw_hooks.dart @@ -0,0 +1,31 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../counter/raw.dart'; + +/* SNIPPET START */ + +final counterProvider = StateNotifierProvider(Counter.new); + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final greeting = useState('Hello'); + + return Scaffold( + body: Center(child: Text(greeting.value)), + floatingActionButton: FloatingActionButton( + onPressed: () { + // Call `increment()` on the `Counter` class + ref.read(counterProvider.notifier).increment(); + }, + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart index 14915ab30..9a4347159 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/codegen.dart @@ -16,7 +16,7 @@ class Counter extends _$Counter { } Widget build(BuildContext context, WidgetRef ref) { - // 使用 “read” 忽略provider的更新 + // use "read" to ignore updates on a provider final counter = ref.read(counterProvider.notifier); return ElevatedButton( onPressed: counter.increment, diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart index f79b28ca9..f90cd968f 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/read_build/raw.dart @@ -9,7 +9,7 @@ import 'package:flutter_riverpod/legacy.dart'; final counterProvider = StateProvider((ref) => 0); Widget build(BuildContext context, WidgetRef ref) { - // 使用 “read” 忽略provider的更新 + // use "read" to ignore updates on a provider final counter = ref.read(counterProvider.notifier); return ElevatedButton( onPressed: () => counter.state++, diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart index 0398da316..31de6da74 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/codegen.dart @@ -30,16 +30,16 @@ class Todos extends _$Todos { @riverpod List filteredTodoList(FilteredTodoListRef ref) { - // 获取筛选器和待办清单列表 + // obtains both the filter and the list of todos final FilterType filter = ref.watch(filterTypeProvider); final List todos = ref.watch(todosProvider); switch (filter) { case FilterType.completed: - // 返回完成的待办清单 + // return the completed list of todos return todos.where((todo) => todo.isCompleted).toList(); case FilterType.none: - // 返回所有的待办清单 + // returns the unfiltered list of todos return todos; } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart index 7a9fe7b85..bde11d2e4 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch/raw.dart @@ -23,16 +23,16 @@ final todosProvider = StateNotifierProvider>((ref) => TodoList()); final filteredTodoListProvider = Provider((ref) { - // 获取筛选器和待办清单列表 + // obtains both the filter and the list of todos final FilterType filter = ref.watch(filterTypeProvider); final List todos = ref.watch(todosProvider); switch (filter) { case FilterType.completed: - // 返回完成的待办清单 + // return the completed list of todos return todos.where((todo) => todo.isCompleted).toList(); case FilterType.none: - // 返回所有的待办清单 + // returns the unfiltered list of todos return todos; } }); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart index 5649470d1..80b63d216 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen.dart @@ -31,7 +31,7 @@ class HomeView extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 使用ref监听provider + // use ref to listen to a provider final counter = ref.watch(counterProvider); return Text('$counter'); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart new file mode 100644 index 000000000..c82698304 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.dart @@ -0,0 +1,43 @@ +// ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_hooks.g.dart'; + +enum FilterType { + none, + completed, +} + +abstract class Todo { + bool get isCompleted; +} + +@riverpod +class TodoList extends _$TodoList { + @override + List build() => []; +} + +/* SNIPPET START */ + +@riverpod +int counter(CounterRef ref) => 0; + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // You can use hooks inside a HookConsumerWidget + final greeting = useState('Hello'); + + // use ref to listen to a provider + final counter = ref.watch(counterProvider); + + return Text('${greeting.value} $counter'); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart new file mode 100644 index 000000000..172d4ee49 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/codegen_hooks.g.dart @@ -0,0 +1,140 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_hooks.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef CounterRef = Ref; + +@ProviderFor(counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $FunctionalProvider + with $Provider { + const CounterProvider._( + {int Function( + CounterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CounterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CounterProvider $copyWithCreate( + int Function( + CounterRef ref, + ) create, + ) { + return CounterProvider._(create: create); + } + + @override + int create(CounterRef ref) { + final _$cb = _createCb ?? counter; + return _$cb(ref); + } +} + +String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; + +@ProviderFor(TodoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider extends $NotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + List Function( + Ref>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$todoListHash() => r'77f007cd4f5105330a4c2ab8555ea0d1716945c1'; + +abstract class _$TodoList extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx index 339b89a56..a856c4980 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/index.tsx @@ -1,9 +1,11 @@ import raw from "!!raw-loader!./raw.dart"; import codegen from "!!raw-loader!./codegen.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; +import codegen_hooks from "!!raw-loader!./codegen_hooks.dart"; export default { raw, - hooks: raw, + hooks: raw_hooks, codegen, - hooksCodegen: codegen, + hooksCodegen: codegen_hooks, }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart index f7cdb0ae5..90639ac8c 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw.dart @@ -26,7 +26,7 @@ class HomeView extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 使用ref监听provider + // use ref to listen to a provider final counter = ref.watch(counterProvider); return Text('$counter'); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart new file mode 100644 index 000000000..f125f6553 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/reading/watch_build/raw_hooks.dart @@ -0,0 +1,38 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +enum FilterType { + none, + completed, +} + +abstract class Todo { + bool get isCompleted; +} + +class TodoList extends StateNotifier> { + TodoList() : super([]); +} + +/* SNIPPET START */ + +final counterProvider = StateProvider((ref) => 0); + +class HomeView extends HookConsumerWidget { + const HomeView({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // You can use hooks inside a HookConsumerWidget + final greeting = useState('Hello'); + + // use ref to listen to a provider + final counter = ref.watch(counterProvider); + + return Text('${greeting.value} $counter'); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/scopes.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/scopes.mdx index b4472bdec..9c8812bcf 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/scopes.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/scopes.mdx @@ -1,49 +1,60 @@ --- -title: 作用域 +title: Scopes --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import asyncInitialization from "!!raw-loader!/docs/concepts/async_initialization.dart"; import dialogScope from "!!raw-loader!/docs/concepts/dialog_scope.dart"; import themeScope from "!!raw-loader!/docs/concepts/theme_scope.dart"; import subtreeScope from "!!raw-loader!/docs/concepts/subtree_scope.dart"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet } from "@site/src/components/CodeSnippet"; +import { Link } from "@site/src/components/Link"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: + +Scoping in Riverpod is a very powerful feature, but like all powerful features, it should be used wisely and intentionally. -Riverpod中的作用域是一个非常强大的功能，但像其他强大的功能一样，应该理智地使用它。 +A few of the things that scoping enables are: -作用域支持： -- 覆盖特定子树的provider状态(类似于主题和 `InheritedWidgets` 在flutter中的工作方式) [(查看示例)](#子树作用域) -- 为一般异步API创建同步provider [(查看示例)](#异步api的同步provider初始化) -- 允许 `对话框(Dialog)` 和 `覆盖层(Overlay)`从widget子树继承provider的状态以显示它们[(查看示例)](#展示对话框) -- 通过从widget的构造函数中删除参数来优化widget的重建，从而允许你将它们设置为`const` +- Override the state of providers for a specific subtree (similar to how theming and `InheritedWidgets` work in flutter) [(see example)](#subtree-scope) +- Creating synchronous providers for normally async APIs [(see example)](#initialization-of-synchronous-provider-for-async-apis) +- Allowing `Dialog`s and `Overlay`s to inherit the state of providers from the widget subtree that cause them to be shown [(see example)](#showing-dialogs) +- Optimizing rebuilds of widgets by removing parameters from Widget constructors allowing you to make them `const` -如果你想用作用域来表示上面的第一点，你也可以用family来代替。 -family的优点是允许你从widget树中的任何位置访问状态的每个实例，而不仅仅是从你所在的特定子树的状态范围访问。 +If you are wanting to use scope for the first point, chances are you can use families instead. +Families have the advantages of allowing you to access each of those instances of the state from anywhere in the widget tree rather than just the state scoped to the specific subtree that you are in. -使用作用域创建provider状态的多个实例与 `package:provider` 的工作方式类似。 +Using scope to create multiple instances of a provider's state is similar to how `package:provider` works. -但是，使用作用域来完成该任务的限制更大，因为你不能决定从该作用域访问其他实例。 +However, using scope to accomplish that task, is more restrictive, as you cannot decide to access other instances from that scope. -因此，在确定所使用的每个provider的作用域之前，请仔细考虑为什么要确定provider的作用域。 +As such, before scoping every provider you use, consider carefully why you want to scope the provider. -## ProviderScope 和 ProviderContainer +## ProviderScope and ProviderContainer -作用域由 [ProviderContainer] 引入。这个容器保存了所有provider的当前状态。它管理provider之间的查找和订阅功能。 +A scope is introduced by a [ProviderContainer]. This container holds the current state of all of your providers. +It manages the lookup and subscriptions between providers. -在Flutter中，你应该使用 [ProviderScope] widget， -它内部包含一个 [ProviderContainer]，并提供了一种访问该容器到widget树其余部分的方法。 +In Flutter you should use the [ProviderScope] widget, which contains a [ProviderContainer] +internally, and provides a way to access that container to the rest of the widget tree. ```dart final valueProvider = StateProvider((ref) => 0); -// 这样做： +// DO this void main() { runApp(ProviderScope(child: MyApp())); } -// 不要这样做： +//DON'T do this: final myProviderContainer = ProviderContainer(); void main(){ runApp(MyApp()); @@ -51,118 +62,120 @@ void main(){ ``` :::warning -在了解它们的工作原理之前，不要使用多个 [ProviderContainer]。 -每个线程都有自己独立的状态线程，这些状态线程不能相互访问。 -拿测试举例，你可能希望使用单独的 [ProviderContainer]，以便使每个测试的状态独立于其他测试。 +Do not use multiple [ProviderContainer]s, without an understanding of how they work. +Each will have it's own separate thread of states, which will not be able to access each other. +Tests are an example of when you might want to use separate [ProviderContainer]s +in order to make each test's state independent of the others. ::: -仅在纯Dart项目中和测试中创建并使用 [ProviderContainer] 且不需要 [ProviderScope]。 +Only create a [ProviderContainer] without a [ProviderScope] for testing and dart-only usage. -## How Riverpod如何找到一个Provider +## How Riverpod Finds a Provider -当一个widget或provider请求一个provider的值时，Riverpod在最近的ProviderScope widget中查找该provider的状态。 -如果provider和它显式列出的依赖项都没有在该范围内被覆盖到，Riverpod将继续查找widget树。 -如果provider没有在任何widget子树中被覆盖到，则默认查找到根 [ProviderScope] 中的 [ProviderContainer]。 +When a widget or provider requests the value of a provider, Riverpod looks up the state of that provider in the nearest +[ProviderScope] widget. If neither the provider nor one of it's explicitly listed dependencies is overridden in that scope Riverpod continues it's lookup up the widget tree. +If the provider has not been overridden in any Widget subtrees the lookup defaults to the [ProviderContainer] in the root [ProviderScope]. -一旦该进程定位了provider应该驻留的作用域，它就会确定provider是否已经创建。 -如果是，它将返回provider的状态。但是，如果provider已经失效或未初始化，它将使用provider的构建方法创建状态。 +Once this process locates the scope in which the provider should reside it determines if the provider has been created yet. +If so, it will return the state of the provider. +However, if the provider has been invalidated or is not currently initialized it will create the state using the provider's build method. -## 异步API的同步provider初始化 +## Initialization of Synchronous Provider for Async APIs -通常，你可能会对依赖项(如 `SharedPreferences` 或 `FirebaseApp`)进行一些异步初始化。 -许多其他provider可能依赖于此，在每个provider中处理错误/加载中状态是多余的。 +Often you might have some async initialization of a dependency such as `SharedPreferences` or `FirebaseApp`. +Many other providers might rely on this, and dealing with the error / loading states in each of those providers is redundant. -你可以保证这些provider不会有错误，并且在应用启动时可以快速加载。 +You might be able to guarantee that those providers will not have errors and will load quickly when the app is started. -那么，如何让这些provider状态同步可用呢? +So how do you makes these sorts of provider states available synchronously? -下面是一个示例，它展示了当异步API准备好时，作用域如何允许你覆盖一个形式上的provider。 +Here is an example that shows how scoping allows you override a dummy provider when your asynchronous API is ready. {trimSnippet(asyncInitialization)} -## 展示对话框 +## Showing Dialogs -当你显示一个`对话框(Dialog)` 或 `OverlayEntry`时，flutter会创建一个新的 `路由(Route)` 或添加到具有不同构建范围的 `Overlay` 中， -这样它就可以摆脱它的父布局，并可以显示在其他 `路由(Routes)` 之上。 -但这通常会给 `InheritedWidget` 带来一个问题，因为 [ProviderScope] 也是一个 `InheritedWidget`，所以它也会受到影响。 +When you show a `Dialog` or `OverlayEntry`, flutter creates a new `Route` or adds to an `Overlay` that has a different build scope, +so that it can escape the layout of it's parent, and can be shown above other `Routes`. +This presents a problem for `InheritedWidget`s in general, and since [ProviderScope] is an `InheritedWidget`, it is also affected. -为了解决这个问题，Riverpod允许你创建一个 `ProviderScope` ，它可以访问父作用域中所有provider的状态。 +To solve this problem, Riverpod allows you to create a `ProviderScope` that can access the state of all providers in a `parent` scope. -下面的示例展示了如何使用这个功能，它允许打开的`Dialog`从上下文(context)中访问计数器的状态。 +The following example shows how to use this, to allow a `Dialog` to access the state of a counter from the context that caused the `Dialog` to be shown. {trimSnippet(dialogScope)} -## 子树作用域 +## Subtree Scoping -作用域允许你覆盖widget树的特定子树的provider状态。 -通过这种方式，它可以提供类似于flutter中的 `InheritedWidget` 或 `package:provider` 中的provider机制。 +Scoping allows you to override the state of a provider for a specific subtree of your widget tree. +In this way it can provide a similar mechanism to `InheritedWidget` from flutter, or the providers from `package:provider`. For example, in flutter you can override the `Theme` for a particular subtree of your widget tree, by wrapping it in a `Theme` widget. -比如，在flutter中，通过将widget树的特定子树包装在Theme widget中，可以覆盖widget树的Theme。 {trimSnippet(themeScope)} -在底层，`Theme` 是一个 `InheritedWidget` ，当widget查找 `Theme` 时，它们从widget树中找到最近的 `Theme` widget 来获得主题。 +Under the hood, `Theme` is an `InheritedWidget` and when widgets look up the `Theme` they get the `Theme` from the nearest `Theme` widget above it in the widget tree. -Riverpod的工作方式不太一样，因为应用的所有状态通常存储在根 [ProviderScope] widget中。 -不要担心，当状态改变时，这不会导致整个应用程序重新构建，它只是允许你从widget树中的任何位置去访问状态。 +Riverpod works differently, since all of the state of your application is typically stored in a root [ProviderScope] widget. +Don't worry, this doesn't cause your whole application to rebuild when the state changes, it just allows you to access the state from anywhere in your widget tree. -如果根据所处的页面需要不同的provider该怎么办? +What if you want different providers depending on which page you are in? -你应该考虑的第一件事是它所提供的行为是否会以某种方式有所不同。 +The first thing that you should consider is whether the provided behavior will differ in any way. -如果不同 -> 只需创建一个不同名称的新的provider，并在该页面中使用它 +If so -> just create a new provider with a different name and use it in that page -如果相同 -> 考虑使用family[在这里了解更多关于family的内容](/docs/concepts/modifiers/family)。 +If not -> Consider using a . -通常，你开始时认为只需要在特定页面上使用provider，但最后却希望在稍后的另一个页面上也使用它。 -family可以让你不受这种可能性的影响，如果你是来自 `package:provider` 的开发者，你应该使用family来调整思维。 +Often you start by thinking that you only need a provider on a particular page, but end up wanting to use it in another page later on. +Families protect you against this eventuality, and are a major difference in how you should adjust your thinking if you are coming from `package:provider`. -但如果family确实不适合你的用例，下面的示例向你展示了如何覆盖特定子树的provider： +If families really do not fit your use case, the following example shows you how to override a provider for a particular subtree. {trimSnippet(subtreeScope)} -## 什么时候选择有作用域的Provider还是Family +## When to choose Scoped Providers or Families + +While scopes are important to understand, it is easy to get carried away when using scopes. + +If you want a different instance of a provider's state depending on where it is in the widget tree you have a few alternatives available to you: `Scoping`, `Families`, or a combination. +The appropriate choice depends on your use case. -虽然理解作用域很重要，但在使用作用域时很容易失去控制。 +Families: -如果你想要一个provider状态的不同实例，取决于它在widget树中的位置，你有几个可供选择的选项: `Scoping`, `Families`，或组合它们。 -请根据你的情况选择合适方案。 +- Pro: You can show multiple of the states no matter which subtree you are in +- Pro: This makes it a more flexible and scalable solution for many use cases -Family: -- 优点：无论你在哪个子树中，你都可以显示多个状态 -- 优点：这使得它成为许多用例的更灵活和可扩展的解决方案 +Scoping: -作用域: -- 缺点：你最终会在你的widget树中嵌套更多的[ProviderScope] widget -- 缺点：你只能访问一个覆盖住你部分的widget树 -- 缺点：你最终不得不显式地列出大多数provider的依赖关系 -- 优点：可以减少widget构造函数中的参数数量 -- 优点：你可以获得轻微的性能优势，并且可以潜在地使你的一些widget的构造函数为const +- Con: You end up with more nesting of [ProviderScope] widgets in your widget tree +- Con: You can only access the one override in your section of the widget tree +- Con: You end up having to explicitly list the dependencies of most of your providers +- Pro: You can reduce the number of parameters in your widget constructors +- Pro: You get a slight performance advantage, and can potentially make some of your widget constructors `const` -组合使用这两种方法，你可以同时获得这两种方法的优点，但你仍然必须解决作用域的缺点。 +Using a combination of the two approaches, you can get the pros of both approaches, but you still have to deal with the cons of scoping. :::warning -请记住，作用域为每个被覆盖的provider或列出了对被覆盖的provider的依赖项的provider引入了一个新的状态实例。 -如果你在应用程序的不同子树中覆盖相同的参数，它将**不会是**provider状态的相同实例。 -一般来说，family更加灵活，并且通过即将到来的代码生成特性，可以很容易地为一个family使用多个参数。 -一个很好的组合通常是同时使用family和作用域。使用一个family来提供对应用中任何地方的状态块的访问， -取决于你在widget树中的位置，然后使用作用域来提供一个特定的family状态实例。 +Remember that scopes introduce a new instance of the state of every provider that is overridden or has listed a dependency on a provider that was overridden. +If you override with the same parameter in a different subtree of the app, it will **not** be the same instance of the provider's state. +Families are more flexible in general, and with the upcoming code generation feature it is easy to use multiple parameters for a family. +Often a good combination is to use both families and scoping. Use a family to provide general access to a piece of state anywhere in your app, and then use scoping to +provide a specific instance of the family's state depending on where you are in the widget tree. ::: -### 作用域的不常见用法 +### Less common usages of Scopes -有时你可能想要覆盖应用特定子树中的所有provider。 -通过在每个provider的依赖项列表中列出一个公共provider， -你可以通过覆盖公共provider，轻松地一次性为所有这些provider创建新状态。 +Sometimes you may want to override a whole set of providers in a specific subtree of your app. +By listing a common provider in the dependencies list of each of those providers, you can easily create new states for all of them at once, by overriding the common one. -请注意，如果你尝试使用family来实现此功能，那么你将得到许多具有相同参数的family， -并且你可能会在整个widget树中传递该参数。在这种情况下，也可以使用作用域。 +Note that if you try to use families for this, you will end up with many families that all have the same parameter, and you could end up passing that parameter all over the widget tree. +In this case it is also acceptable to use scopes. :::warning -一旦开始使用作用域，请确保始终列出依赖项并保持最新状态，以防止运行时异常。 -为了解决这个问题，我们创建了 [riverpod_lint]，它会在缺少依赖时警告你。 -另外，使用 [riverpod_generator] 这个代码生成器会自动为你生成依赖项列表。 +Once you start using scope, make sure to always list your dependencies and keep them up to date, to prevent runtime exceptions. +To help with this we have created [riverpod_lint] which will warn you if there is a missing dependency. +Additionally with [riverpod_generator] the code generator automatically generates the dependency list. ::: [ProviderContainer]: https://pub.dev/documentation/riverpod/latest/riverpod/ProviderContainer-class.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart new file mode 100644 index 000000000..31d6bc5bd --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/subtree_scope.dart @@ -0,0 +1,79 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ + +/// A counter that is being incremented by each [CounterDisplay]'s ElevatedButton +final counterProvider = StateProvider( + (ref) => 0, +); + +final adjustedCountProvider = Provider( + (ref) => ref.watch(counterProvider) * 2, + // Note that if a provider depends on a provider that is overridden for a subtree, + // you must explicitly list that provider in your dependencies list. + dependencies: [counterProvider], +); + +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + body: Column( + children: [ + ProviderScope( + /// Just specify which provider you want to have a copy of in the subtree + /// + /// Note that dependant providers such as [adjustedCountProvider] will + /// also be copied for this subtree. If that is not the behavior you want, + /// consider using families instead + overrides: [counterProvider], + child: const CounterDisplay(), + ), + ProviderScope( + // You can change the provider's behavior in a particular subtree + overrides: [counterProvider.overrideWith((ref) => 1)], + child: const CounterDisplay(), + ), + ProviderScope( + overrides: [ + counterProvider, + // You can also change dependent provider's behaviors + adjustedCountProvider.overrideWith( + (ref) => ref.watch(counterProvider) * 3, + ), + ], + child: const CounterDisplay(), + ), + // This particular display will use the provider state from the root ProviderScope + const CounterDisplay(), + ], + ),); + } +} + +class CounterDisplay extends ConsumerWidget { + const CounterDisplay({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final count = ref.watch(counterProvider); + return Column( + mainAxisSize: MainAxisSize.min, + children: [ + Text('$count'), + ElevatedButton( + onPressed: () { + ref.read(counterProvider.notifier).state++; + }, + child: const Text('Increment Count'), + ), + ], + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart new file mode 100644 index 000000000..ccd34647d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/theme_scope.dart @@ -0,0 +1,69 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ + +void main() { + runApp( + ProviderScope( + child: MaterialApp( + theme: ThemeData(primaryColor: Colors.blue), + home: const Home(), + ), + ), + ); +} + +// Have a counter that is being incremented +final counterProvider = StateProvider( + (ref) => 0, +); + +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return Scaffold( + body: Column( + children: [ + // This counter will have a primary color of green + Theme( + data: Theme.of(context).copyWith(primaryColor: Colors.green), + child: const CounterDisplay(), + ), + // This counter will have a primary color of blue + const CounterDisplay(), + ElevatedButton( + onPressed: () { + ref.read(counterProvider.notifier).state++; + }, + child: const Text('Increment Count'), + ), + ], + ),); + } +} + +class CounterDisplay extends ConsumerWidget { + const CounterDisplay({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + final count = ref.watch(counterProvider); + final theme = Theme.of(context); + return Column( + mainAxisSize: MainAxisSize.min, + children: [ + Text( + '$count', + style: theme.textTheme.displayMedium + ?.copyWith(color: theme.primaryColor), + ), + ], + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx index 864abc633..3dfbe3741 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability.mdx @@ -1,124 +1,98 @@ --- -title: 为何需要不可变性 +title: Why Immutability --- import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; +import whyImmutability from "./why_immutability" +import { + trimSnippet, + AutoSnippet, + When, +} from "@site/src/components/CodeSnippet"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -## 什么是不可变性? +## What is Immutability? -不可变性指当一个`对象`中的所有域(属性)是final或late final的。 -它们只能通过构造器赋值一次。 +Immutability is when all fields of an `Object` are final or late final. +They are set exactly once upon construction. -出于许多原因，不可变性是比较理想的方式： +Immutability is desireable for many different reasons -- 值相等而不是引用相等 -- 关于代码的局部推理 - - 远处的一段代码不能从你的下面获得引用并改变对象 -- 对于异步和并行任务更容易推理 - - 其他代码不能在操作中改变对象 -- API安全 - - 你传递给方法的东西不会被访问者或被访问者改变 +- Value equality rather than reference equality +- Local reasoning about a piece of code + - A far distant piece of code can't obtain a reference and change the object from underneath you +- Easier to reason about for asynchronous and parallel tasks + - Other code can't mutate your object in between operations +- Safety of APIs + - What you pass into a method cannot be changed by the callee / caller -当创建了一个只改变几处的新对象时，copyWith方法可以帮助你减少冗余 +A copyWith method helps with reducing verbosity when creating a new object with just a few things changed. -拷贝的效率比你想的更高，dart可以重用对未更改的字对象的引用。 +Copying is more efficient than you might think, since dart can reuse any references to sub-objects that have not changed. :::warning -确保你的对象是深度不可变的，否则你必须实现某种深拷贝机制。 +Make sure your objects are deeply immutable, otherwise you'll have to implement some sort of deep copy mechanism. ::: -## 最佳实践 +## Best Practices -你可以用任何package来创建你想要的不可变状态。 +You can use any package you want to create immutable state. -对于不可变对象: +For immutable objects: - [package:freezed](https://pub.dev/packages/freezed) - [package:built_value](https://pub.dev/packages/built_value) -对于不可变集合 (Map, Set, List): +For immutable collections (Map, Set, List): - [package:fast_immutable_collections](https://pub.dev/packages/fast_immutable_collections) - [package:built_collection](https://pub.dev/packages/built_collection) - [package:kt_dart](https://pub.dev/packages/kt_dart) - [package:dartz](https://pub.dev/packages/dartz) -非常推荐[freezed]这个package,它除了创建不可变对象外，还提供了一些不错的附加功能，包括： +It is highly recommended to use [freezed], +since it has several nice additions beyond just making immutable objects including: -- 生成copyWith方法 -- 深拷贝 (在嵌套的freezed对象的copyWith方法) -- 联合类型 -- 联合映射函数 +- A generated copyWith method +- Deep copy (copyWith on nested freezed objects) +- Union types +- Union mapping functions -使用不可变状态不一定需要代码生成，但它能让这一过程变得更简单。 +You do not need to use code generation to work with immutable state, but it makes it much easier. :::warning -如果你想使用内置的集合，请确保实现更新集合时执行复制集合的规则。 -不复制集合的问题在于，riverpod会根据对对象的引用是否更改来确定是否发出新的状态。 -如果仅调用一个改变对象的方法，那么使用引用也是可行的。 +If you want to use the built-in collections, make sure to enforce a discipline of making copies of collections when updating them. +The issue with not copying a collection is that riverpod determines whether to emit a new state based on whether the reference to the object has changed. +If you just call a method that mutates an object, the reference is the same. ::: -### 使用不可变状态 - -不可变状态最适合 [StateNotifier] 和 [StateNotifierProvider] 结合使用。 -[StateNotifier]允许你暴露一个可以“改变”状态的接口。 -你不能从你定义的继承自 [StateNotifier] 的对象外面改变他的状态。 -这分离了你的关注点，并将业务逻辑保留在UI之外。 - -下面是一个例子，通过一个简单的不可变设置类来改变应用主题。 - -```dart -final themeProvider = StateNotifierProvider((ref) => ThemeNotifier()); - -class ThemeNotifier extends StateNotifier { - ThemeNotifier(): super( - ThemeSettings( - mode: ThemeMode.system, - primaryColor: Colors.blue, - )); - - void toggle() { - state = state.copyWith(mode: state.mode.toggle); - } - void setDarkTheme() { - state = state.copyWith(mode: ThemeMode.dark); - } - void setLightTheme() { - state = state.copyWith(mode: ThemeMode.light); - } - void setSystemTheme() { - state = state.copyWith(mode: ThemeMode.system); - } - void setPrimaryColor(Color color) { - state = state.copyWith(primaryColor: color); - } - -} - -@freezed -class ThemeSettings with _$ThemeSettings { - const factory ThemeSettings({ThemeMode mode, Color primaryColor}) = _ThemeSettings; -} - -extension ToggleTheme on ThemeMode { - ThemeMode get toggle { - switch (this){ - case ThemeMode.dark: - return ThemeMode.light; - case ThemeMode.light: - return ThemeMode.dark; - case ThemeMode.system: - return ThemeMode.system; - } - } -} -``` - -要使用这段代码，记住你需要引入 `freezed_annotation`这个package，并运行 [build_runner] 来构建freezed生成的类。 +### Using immutable state + +Immutable state is best fit for using a [Notifier] in combination with [NotifierProvider] . +A [Notifier] allows you to expose an interface through which you can 'mutate' the state. +You cannot mutate the state from outside the class you define that extends [Notifier]. +This enforces a separation of concerns and keeps business logic outside of your UI. + +Here is an example of a simple immutable settings class for changing an app theme. + + + +To use this code, remember to import `freezed_annotation`, add the part directive and run [build_runner] to generate the freezed classes! [changenotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html [statenotifier]: https://pub.dev/documentation/riverpod/latest/riverpod/StateNotifier-class.html [statenotifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/StateNotifierProvider-class.html +[notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html +[notifierprovider]: https://pub.dev/documentation/riverpod/latest/riverpod/NotifierProvider.html [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html [freezed]: https://pub.dev/packages/freezed [build_runner]: https://pub.dev/packages/build_runner diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart new file mode 100644 index 000000000..fd286a36c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.dart @@ -0,0 +1,58 @@ +import 'package:flutter/material.dart'; +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.freezed.dart'; +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +class ThemeNotifier extends _$ThemeNotifier { + @override + ThemeSettings build() => const ThemeSettings( + mode: ThemeMode.light, + primaryColor: Colors.blue, + ); + + void toggle() { + state = state.copyWith(mode: state.mode.toggle); + } + + void setDarkTheme() { + state = state.copyWith(mode: ThemeMode.dark); + } + + void setLightTheme() { + state = state.copyWith(mode: ThemeMode.light); + } + + void setSystemTheme() { + state = state.copyWith(mode: ThemeMode.system); + } + + void setPrimaryColor(Color color) { + state = state.copyWith(primaryColor: color); + } +} + +@freezed +class ThemeSettings with _$ThemeSettings { + const factory ThemeSettings({ + required ThemeMode mode, + required Color primaryColor, + }) = _ThemeSettings; +} + +extension ToggleTheme on ThemeMode { + ThemeMode get toggle { + switch (this) { + case ThemeMode.dark: + return ThemeMode.light; + case ThemeMode.light: + return ThemeMode.dark; + case ThemeMode.system: + return ThemeMode.system; + } + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart new file mode 100644 index 000000000..6e8c8082b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.freezed.dart @@ -0,0 +1,151 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'codegen.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$ThemeSettings { + ThemeMode get mode => throw _privateConstructorUsedError; + Color get primaryColor => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $ThemeSettingsCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ThemeSettingsCopyWith<$Res> { + factory $ThemeSettingsCopyWith( + ThemeSettings value, $Res Function(ThemeSettings) then) = + _$ThemeSettingsCopyWithImpl<$Res, ThemeSettings>; + @useResult + $Res call({ThemeMode mode, Color primaryColor}); +} + +/// @nodoc +class _$ThemeSettingsCopyWithImpl<$Res, $Val extends ThemeSettings> + implements $ThemeSettingsCopyWith<$Res> { + _$ThemeSettingsCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? mode = null, + Object? primaryColor = null, + }) { + return _then(_value.copyWith( + mode: null == mode + ? _value.mode + : mode // ignore: cast_nullable_to_non_nullable + as ThemeMode, + primaryColor: null == primaryColor + ? _value.primaryColor + : primaryColor // ignore: cast_nullable_to_non_nullable + as Color, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ThemeSettingsImplCopyWith<$Res> + implements $ThemeSettingsCopyWith<$Res> { + factory _$$ThemeSettingsImplCopyWith( + _$ThemeSettingsImpl value, $Res Function(_$ThemeSettingsImpl) then) = + __$$ThemeSettingsImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({ThemeMode mode, Color primaryColor}); +} + +/// @nodoc +class __$$ThemeSettingsImplCopyWithImpl<$Res> + extends _$ThemeSettingsCopyWithImpl<$Res, _$ThemeSettingsImpl> + implements _$$ThemeSettingsImplCopyWith<$Res> { + __$$ThemeSettingsImplCopyWithImpl( + _$ThemeSettingsImpl _value, $Res Function(_$ThemeSettingsImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? mode = null, + Object? primaryColor = null, + }) { + return _then(_$ThemeSettingsImpl( + mode: null == mode + ? _value.mode + : mode // ignore: cast_nullable_to_non_nullable + as ThemeMode, + primaryColor: null == primaryColor + ? _value.primaryColor + : primaryColor // ignore: cast_nullable_to_non_nullable + as Color, + )); + } +} + +/// @nodoc + +class _$ThemeSettingsImpl implements _ThemeSettings { + const _$ThemeSettingsImpl({required this.mode, required this.primaryColor}); + + @override + final ThemeMode mode; + @override + final Color primaryColor; + + @override + String toString() { + return 'ThemeSettings(mode: $mode, primaryColor: $primaryColor)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ThemeSettingsImpl && + (identical(other.mode, mode) || other.mode == mode) && + (identical(other.primaryColor, primaryColor) || + other.primaryColor == primaryColor)); + } + + @override + int get hashCode => Object.hash(runtimeType, mode, primaryColor); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ThemeSettingsImplCopyWith<_$ThemeSettingsImpl> get copyWith => + __$$ThemeSettingsImplCopyWithImpl<_$ThemeSettingsImpl>(this, _$identity); +} + +abstract class _ThemeSettings implements ThemeSettings { + const factory _ThemeSettings( + {required final ThemeMode mode, + required final Color primaryColor}) = _$ThemeSettingsImpl; + + @override + ThemeMode get mode; + @override + Color get primaryColor; + @override + @JsonKey(ignore: true) + _$$ThemeSettingsImplCopyWith<_$ThemeSettingsImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart new file mode 100644 index 000000000..88eac19dc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/codegen.g.dart @@ -0,0 +1,82 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(ThemeNotifier) +const themeNotifierProvider = ThemeNotifierProvider._(); + +final class ThemeNotifierProvider + extends $NotifierProvider { + const ThemeNotifierProvider._( + {super.runNotifierBuildOverride, ThemeNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'themeNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ThemeNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$themeNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(ThemeSettings value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + ThemeNotifier create() => _createCb?.call() ?? ThemeNotifier(); + + @$internal + @override + ThemeNotifierProvider $copyWithCreate( + ThemeNotifier Function() create, + ) { + return ThemeNotifierProvider._(create: create); + } + + @$internal + @override + ThemeNotifierProvider $copyWithBuild( + ThemeSettings Function( + Ref, + ThemeNotifier, + ) build, + ) { + return ThemeNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$themeNotifierHash() => r'e119d56d9bf8b8d7c19624997f99d116098b45e9'; + +abstract class _$ThemeNotifier extends $Notifier { + ThemeSettings build(); + @$internal + @override + ThemeSettings runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart new file mode 100644 index 000000000..1e34c694c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/why_immutability/raw.dart @@ -0,0 +1,67 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ + +final themeProvider = + NotifierProvider(ThemeNotifier.new); + +class ThemeNotifier extends Notifier { + @override + ThemeSettings build() { + return ThemeSettings(mode: ThemeMode.system, primaryColor: Colors.blue); + } + + void toggle() { + state = state.copyWith(mode: state.mode.toggle); + } + + void setDarkTheme() { + state = state.copyWith(mode: ThemeMode.dark); + } + + void setLightTheme() { + state = state.copyWith(mode: ThemeMode.light); + } + + void setSystemTheme() { + state = state.copyWith(mode: ThemeMode.system); + } + + void setPrimaryColor(Color color) { + state = state.copyWith(primaryColor: color); + } +} + +class ThemeSettings { + ThemeSettings({ + required this.mode, + required this.primaryColor, + }); + + final ThemeMode mode; + final Color primaryColor; + + ThemeSettings copyWith({ + ThemeMode? mode, + Color? primaryColor, + }) { + return ThemeSettings( + mode: mode ?? this.mode, + primaryColor: primaryColor ?? this.primaryColor, + ); + } +} + +extension ToggleTheme on ThemeMode { + ThemeMode get toggle { + switch (this) { + case ThemeMode.dark: + return ThemeMode.light; + case ThemeMode.light: + return ThemeMode.dark; + case ThemeMode.system: + return ThemeMode.system; + } + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx new file mode 100644 index 000000000..404f6a883 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/search_as_we_type.mdx @@ -0,0 +1,148 @@ +--- +title: Search as we type +--- + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: + +A real world example could be to use `FutureProvider` to implement a searchbar. + +## Usage example: "Search as we type" searchbar + +Implementing a "search as we type" can seem daunting at first when using +conventional means. +There are lots of moving parts, such as: + +- handling errors. +- debouncing the user input to avoid making network requests on every keystroke. +- cancelling previously pending network requests when the search field changes. + +But the combination of `FutureProvider` and the power of [ref.watch] can +significantly simplify this task. + +A common pattern wanting to perform an asynchronous requests +is to split it into multiple providers: + +- a [StateNotifierProvider] or `StateProvider` for the parameters of your request + (or alternatively use [family]) +- a `FutureProvider`, which will do the request by reading the parameters from + the other providers/[family]. + +The first step would be to store the user input somewhere. For this example, +we will use `StateProvider` (as the search state is only a single `String`): + +```dart +final searchInputProvider = StateProvider((ref) => ''); +``` + +We can then connect this provider to a [TextField] by doing: + +```dart +Consumer( + builder: (context, ref, child) { + return TextField( + onChanged: (value) => ref.read(searchInputProvider.notifier).state = value, + ); + }, +) +``` + +Then, we can create our `FutureProvider` which will take care of the request: + +```dart +final searchProvider = FutureProvider< + + + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -对任何中型到大型应用，测试应用都是至关重要的。 +For any medium to large-scale applications, it is critical to test the application. -为了成功地测试我们的应用，我们需要以下东西： +To successfully test our application, we will want the following things: -- `test` 和`testWidgets` 之间不应该保留任何状态。 - 这意味着应用中没有全局状态，或者所有的全局状态都应该在每次测试后重置。 +- No state should be preserved between `test`/`testWidgets`. + That means no global state in the application, or all global states should reset after each test. -- 能够强制我们的provider具有特定的状态，无论是通过模拟还是通过操纵它们直到我们达到所需的状态。 +- Being able to force our providers to have a specific state, either through + mocking or by manipulating them until we reach the desired state. -让我们来逐个看看 [Riverpod] 是如何帮助你处理这些问题的。 +Let's see one by one how [Riverpod] helps you with these. -## `test` 和`testWidgets` 之间不应该保留任何状态。 +## No state should be preserved between `test`/`testWidgets`. -由于provider通常声明为全局变量，你可能会担心这一点。 -毕竟，全局状态使得测试非常困难，因为它可能需要漫长的 `配置(setUp)` 和 `销毁(tearDown)`。 +Since providers are usually declared as global variables, you might worry about +that one. +After all, global state makes testing very difficult, because it can require +lengthy `setUp`/`tearDown`. -但实际情况是虽然provider声明为全局的，但provider的状态却**不是**全局的。 +But the reality is: While providers are declared as globals, the state of a provider +is **not** global. -相反，它存储在一个名为 [ProviderContainer] 的对象中， -如果你查看Dart的示例，你可能已经看到了这个对象。 -如果你还没有看，请了解这个 [ProviderContainer] 对象是由 [ProviderScope] 隐式创建的， -这个widget可以让我们在Flutter项目中启用 [Riverpod]。 +Instead, it is stored in an object named [ProviderContainer], which you may have +seen if you looked at the dart-only examples. +If you haven't, know that this [ProviderContainer] object is implicitly created +by [ProviderScope], the widget that enables [Riverpod] on our project. -具体来说，这意味着两个使用provider的 `testWidgets` 不共享任何状态。 -因此，根本不需要任何 `配置(setUp)` 和 `销毁(tearDown)`。 +Concretely what this means is, two `testWidgets` using providers do not share +any state. +As such, there is no need for any `setUp`/`tearDown` at all. -解释这么多不如来一个例子： +But an example is better than lengthy explanations: -可以看到，虽然 `counterProvider` 被声明为全局变量，但测试间没有共享任何状态。 -因此，如果以不同的顺序执行，我们不必担心我们的测试可能表现不同，因为它们是在完全隔离的情况下运行的。 +As you can see, while `counterProvider` was declared as a global, no state was +shared between tests. +As such, we do not have to worry about our tests potentially behaving differently +if executed in a different order, since they are running in complete isolation. + +## Overriding the behavior of a provider during tests. -## 在测试期间重写provider的行为 +A common real-world application may have the following objects: -现实中，一个常见的应用可能有以下对象： +- It will have a `Repository` class, which provides a type-safe and simple API + to perform HTTP requests. -- 它将有一个 `Repository` 类，该类提供类型安全且简单的API来执行HTTP请求。 -- 一个管理应用程序状态的对象，可以使用 `Repository` 根据不同的因素来执行HTTP请求。 - 这可能是一个 `ChangeNotifier`， `Bloc`，甚至是一个provider。 +- An object that manages the application state, and may use `Repository` to perform + HTTP requests based on different factors. + This may be a `ChangeNotifier`, `Bloc`, or even a provider. -使用 [Riverpod]，可以这样表示： +Using [Riverpod], this may be represented as follows: {trimSnippet(repositorySnippet)} -在这种情况下，当进行单元测试或widget测试时， -我们一般希望用一个返回预定义响应的伪实现来替换 `Repository` 实例，而不是发出真正的HTTP请求。 +In this situation, when making a unit/widget test, we will typically want to +replace our `Repository` instance with a fake implementation that returns +a pre-defined response instead of making a real HTTP request. -然后，我们希望我们的 `todoListProvider` 或类似的组件使用 `Repository` 的模拟实现。 +We will then want our `todoListProvider` or equivalent to use the mocked implementation +of `Repository`. -为了实现这一点，我们可以使用[ProviderScope] 或 [ProviderContainer]的 `overrides` 参数来覆盖 `repositoryProvider` 的行为： +To achieve this, we can use the `overrides` parameter of [ProviderScope]/[ProviderContainer] +to override the behavior of `repositoryProvider`: -正如您可以从高亮的代码中看到的，[ProviderScope]/[ProviderContainer] 允许用不同的行为替换provider的实现。 +As you can see by the highlighted code, [ProviderScope]/[ProviderContainer] +allows replacing the implementation of a provider with a different behavior. :::info -一些provider暴露了重写其行为的简化方法。 -例如，[FutureProvider] 允许使用 `AsyncValue` 重写provider： +Some providers expose simplified ways to override their behavior. +For example, [FutureProvider] allows overriding the provider with an `AsyncValue`: {trimSnippet(testOverrideInfo)} -**注意**：作为2.0.0版本的一部分， `overrideWithValue` 方法被暂时移除。 -它们将在未来的版本中重新添加。 +**Note**: As part of the 2.0.0 release, `overrideWithValue` methods are temporarily +removed. They will be added back in later versions. ::: :::info -使用 `family` 修饰符覆盖provider的语法略有不同。 +The syntax for overriding a provider with the `family` modifier is slightly different. -如果你像这样使用provider： +If you used a provider like this: ```dart final response = ref.watch(myProvider('12345')); ``` -你可以这样覆盖provider： +You could override the provider as: ```dart myProvider('12345').overrideWithValue(...)); @@ -132,9 +156,9 @@ myProvider('12345').overrideWithValue(...)); ::: -## 完整的widget测试用例 +## Full widget test example -最后，这里是我们Flutter测试的完整代码。 +Wrapping up, here is the entire full code for our Flutter test. {trimSnippet(testFull)} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart new file mode 100644 index 000000000..73c643a16 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_dart.dart @@ -0,0 +1,51 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +class FakeRepository {} + +final repositoryProvider = Provider((ref) => FakeRepository()); + +abstract class Todo { + String get id; + String get label; + bool get completed; +} + +final todoListProvider = FutureProvider>((ref) => []); + +void main() { +/* SNIPPET START */ + +test('override repositoryProvider', () async { + final container = ProviderContainer( + overrides: [ + // Override the behavior of repositoryProvider to return + // FakeRepository instead of Repository. + /* highlight-start */ + repositoryProvider.overrideWithValue(FakeRepository()), + /* highlight-end */ + // We do not have to override `todoListProvider`, it will automatically + // use the overridden repositoryProvider + ], + ); + + // The first read if the loading state + expect( + container.read(todoListProvider), + const AsyncValue>.loading(), + ); + + /// Wait for the request to finish + await container.read(todoListProvider.future); + + // Exposes the data fetched + expect(container.read(todoListProvider).value, [ + isA() + .having((s) => s.id, 'id', '42') + .having((s) => s.label, 'label', 'Hello world') + .having((s) => s.completed, 'completed', false), + ]); +}); + +/* SNIPPET END */ +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart new file mode 100644 index 000000000..650642e95 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_flutter.dart @@ -0,0 +1,40 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +class MyApp extends StatelessWidget { + // ignore: prefer_const_constructors_in_immutables + MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return Container(); + } +} + +final repositoryProvider = Provider((ref) => FakeRepository()); + +class FakeRepository {} + +void main() { +/* SNIPPET START */ + +testWidgets('override repositoryProvider', (tester) async { + await tester.pumpWidget( + ProviderScope( + overrides: [ + // Override the behavior of repositoryProvider to return + // FakeRepository instead of Repository. + /* highlight-start */ + repositoryProvider.overrideWithValue(FakeRepository()), + /* highlight-end */ + // We do not have to override `todoListProvider`, it will automatically + // use the overridden repositoryProvider + ], + child: MyApp(), + ), + ); +}); + +/* SNIPPET END */ +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart new file mode 100644 index 000000000..e75b5747f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_full.dart @@ -0,0 +1,101 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +class Repository { + Future> fetchTodos() async => []; +} + +class Todo { + Todo({ + required this.id, + required this.label, + required this.completed, + }); + + final String id; + final String label; + final bool completed; +} + +// We expose our instance of Repository in a provider +final repositoryProvider = Provider((ref) => Repository()); + +/// The list of todos. Here, we are simply fetching them from the server using +/// [Repository] and doing nothing else. +final todoListProvider = FutureProvider((ref) async { + // Obtains the Repository instance + final repository = ref.read(repositoryProvider); + + // Fetch the todos and expose them to the UI. + return repository.fetchTodos(); +}); + +/// A mocked implementation of Repository that returns a pre-defined list of todos +class FakeRepository implements Repository { + @override + Future> fetchTodos() async { + return [ + Todo(id: '42', label: 'Hello world', completed: false), + ]; + } +} + +class TodoItem extends StatelessWidget { + const TodoItem({super.key, required this.todo}); + final Todo todo; + @override + Widget build(BuildContext context) { + return Text(todo.label); + } +} + +void main() { + testWidgets('override repositoryProvider', (tester) async { + await tester.pumpWidget( + ProviderScope( + overrides: [ + repositoryProvider.overrideWithValue(FakeRepository()), + ], + // Our application, which will read from todoListProvider to display the todo-list. + // You may extract this into a MyApp widget + child: MaterialApp( + home: Scaffold( + body: Consumer( + builder: (context, ref, _) { + final todos = ref.watch(todoListProvider); + // The list of todos is loading or in error + if (todos.asData == null) { + return const CircularProgressIndicator(); + } + return ListView( + children: [ + for (final todo in todos.asData!.value) + TodoItem(todo: todo), + ], + ); + }, + ), + ), + ), + ), + ); + + // The first frame is a loading state. + expect(find.byType(CircularProgressIndicator), findsOneWidget); + + // Re-render. TodoListProvider should have finished fetching the todos by now + await tester.pump(); + + // No longer loading + expect(find.byType(CircularProgressIndicator), findsNothing); + + // Rendered one TodoItem with the data returned by FakeRepository + expect(tester.widgetList(find.byType(TodoItem)), [ + isA() + .having((s) => s.todo.id, 'todo.id', '42') + .having((s) => s.todo.label, 'todo.label', 'Hello world') + .having((s) => s.todo.completed, 'todo.completed', false), + ]); + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart new file mode 100644 index 000000000..d78668653 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_dart.dart @@ -0,0 +1,64 @@ +import 'package:flutter_riverpod/legacy.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mockito/mockito.dart'; +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ + +// A Counter implemented and tested with Dart only (no dependency on Flutter) + +// We declared a provider globally, and we will use it in two tests, to see +// if the state correctly resets to `0` between tests. + +final counterProvider = StateProvider((ref) => 0); + +// Using mockito to keep track of when a provider notify its listeners +class Listener extends Mock { + void call(int? previous, int value); +} + +void main() { + test('defaults to 0 and notify listeners when value changes', () { + // An object that will allow us to read providers + // Do not share this between tests. + final container = ProviderContainer(); + addTearDown(container.dispose); + final listener = Listener(); + + // Observe a provider and spy the changes. + container.listen( + counterProvider, + listener.call, + fireImmediately: true, + ); + + // the listener is called immediately with 0, the default value + verify(listener(null, 0)).called(1); + verifyNoMoreInteractions(listener); + + // We increment the value + container.read(counterProvider.notifier).state++; + + // The listener was called again, but with 1 this time + verify(listener(0, 1)).called(1); + verifyNoMoreInteractions(listener); + }); + + test('the counter state is not shared between tests', () { + // We use a different ProviderContainer to read our provider. + // This ensure that no state is reused between tests + final container = ProviderContainer(); + addTearDown(container.dispose); + final listener = Listener(); + + container.listen( + counterProvider, + listener.call, + fireImmediately: true, + ); + + // The new test correctly uses the default value: 0 + verify(listener(null, 0)).called(1); + verifyNoMoreInteractions(listener); + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart new file mode 100644 index 000000000..a3044da37 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_original_test_flutter.dart @@ -0,0 +1,57 @@ +// ignore_for_file: use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import 'package:flutter_test/flutter_test.dart'; + +/* SNIPPET START */ + +// A Counter implemented and tested using Flutter + +// We declared a provider globally, and we will use it in two tests, to see +// if the state correctly resets to `0` between tests. + +final counterProvider = StateProvider((ref) => 0); + +// Renders the current state and a button that allows incrementing the state +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return MaterialApp( + home: Consumer(builder: (context, ref, _) { + final counter = ref.watch(counterProvider); + return ElevatedButton( + onPressed: () => ref.read(counterProvider.notifier).state++, + child: Text('$counter'), + ); + },), + ); + } +} + +void main() { + testWidgets('update the UI when incrementing the state', (tester) async { + await tester.pumpWidget(ProviderScope(child: MyApp())); + + // The default value is `0`, as declared in our provider + expect(find.text('0'), findsOneWidget); + expect(find.text('1'), findsNothing); + + // Increment the state and re-render + await tester.tap(find.byType(ElevatedButton)); + await tester.pump(); + + // The state have properly incremented + expect(find.text('1'), findsOneWidget); + expect(find.text('0'), findsNothing); + }); + + testWidgets('the counter state is not shared between tests', (tester) async { + await tester.pumpWidget(ProviderScope(child: MyApp())); + + // The state is `0` once again, with no tearDown/setUp needed + expect(find.text('0'), findsOneWidget); + expect(find.text('1'), findsNothing); + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart new file mode 100644 index 000000000..d71ae3c69 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_override_info.dart @@ -0,0 +1,43 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +extension on ProviderBase { + // ignore: unused_element + Override overrideWithValue(Object? value) => throw UnimplementedError(); +} + +class Todo { + Todo({ + required String id, + required String label, + required bool completed, + }); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return Container(); + } +} + +/* SNIPPET START */ + +final todoListProvider = FutureProvider((ref) async => []); +// ... +/* SKIP */ +final foo = +/* SKIP END */ + ProviderScope( + overrides: [ + /// Allows overriding a FutureProvider to return a fixed value + todoListProvider.overrideWithValue( + AsyncValue.data([Todo(id: '42', label: 'Hello', completed: true)]), + ), + ], + child: const MyApp(), +); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart new file mode 100644 index 000000000..c499279fc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cookbooks/testing_repository.dart @@ -0,0 +1,22 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class Todo {} + +/* SNIPPET START */ + +class Repository { + Future> fetchTodos() async => []; +} + +// We expose our instance of Repository in a provider +final repositoryProvider = Provider((ref) => Repository()); + +/// The list of todos. Here, we are simply fetching them from the server using +/// [Repository] and doing nothing else. +final todoListProvider = FutureProvider((ref) async { + // Obtains the Repository instance + final repository = ref.watch(repositoryProvider); + + // Fetch the todos and expose them to the UI. + return repository.fetchTodos(); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx new file mode 100644 index 000000000..579ec40c4 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose.mdx @@ -0,0 +1,306 @@ +--- +title: 清除缓存并对状态处置做出反应 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import onDisposeExample from "./auto_dispose/on_dispose_example"; +import codegenKeepAlive from "!!raw-loader!./auto_dispose/codegen_keep_alive.dart"; +import rawAutoDispose from "!!raw-loader!./auto_dispose/raw_auto_dispose.dart"; +import invalidateExample from "!!raw-loader!./auto_dispose/invalidate_example.dart"; +import keepAlive from "./auto_dispose/keep_alive"; +import cacheForExtension from "!!raw-loader!./auto_dispose/cache_for_extension.dart"; +import cacheForUsage from "./auto_dispose/cache_for_usage"; +import invalidateFamilyExample from './auto_dispose/invalidate_family_example' + + +到目前为止，我们已经了解了如何创建/更新某些状态。 +但我们还没有谈论状态处置何时发生。 + + +Riverpod 提供了多种与状态处置进行交互的方法。 +这包括从延迟处置状态到对处置做出反应。 + + +## 何时状态被处置，如何改变这一点？ + + + + +使用代码生成时，默认情况下，当提供者程序停止被监听时，状态将被处置。 +当监听器在整个帧中没有活动的监听器时，会发生这种情况。 +当这种情况发生时，状态将被处置。 + + +可以使用 `keepAlive: true` 选择禁用此行为。 +这样做可以防止在删除所有监听器时状态被处置。 + + + + + + + + +不使用代码生成时，默认情况下，当提供者程序停止监听时，状态不会被处置。 + + +您可以选择更改此行为并使用自动处置。 +执行此操作时，Riverpod 将跟踪提供者程序是否有监听器。 +然后，如果一帧的时间内提供者程序没有监听器，则状态将被处置。 + + +若要启用自动处置，可以在提供者程序类型旁边使用 `.autoDispose`： + + + + + +:::note + +启用/禁用自动处置在重新计算提供者程序时，对于是否处置状态没有影响。 +重新计算提供者程序时，状态将始终被处置。 +::: + +:::caution + +当提供者程序收到参数时，建议启用自动处置。 +这是因为否则，将为每个参数组合创建一个状态，这可能会导致内存泄漏。 +::: + + +## 对状态处置做出反应 + + +在 Riverpod 中，有几种内置的处置状态的方法： + + +- 提供者程序不再使用，并且处于“自动处置”模式（稍后会详细介绍）。 + 在这种情况下，与提供者程序的所有关联状态都将被处置。 +- 提供者程序将重新计算，例如 `ref.watch`。 + 在这种情况下，将处置以前的状态，并创建一个新状态。 + + +在这两种情况下。发生这种情况时，您可能希望执行一些逻辑。 +这可以通过 `ref.onDispose` 实现。 +此方法允许注册监听器，当状态被处置时回调。 + + +例如，您可能希望使用它来关闭任何活动 `StreamController`： + + + +:::caution + +不得触发副作用的 `ref.onDispose` 回调。 +修改提供者程序内部的 `onDispose` 可能会导致意外行为。 +::: + +:::info + +还有其他有用的生命周期，例如： + + +- `ref.onCancel` 当删除提供者程序的最后一个监听器时调用。 +- `ref.onResume` 当 `onCancel` 调用之后添加新的监听器时调用。 + +::: + +:::info + +您可以根据需要多次调用 `ref.onDispose`。 +在提供者程序中，每个可处置的对象可随意调用一次。 +这种做法使我们更容易发现我们何时忘记处置某些东西。 +::: + + +## 手动强制处置提供者程序，使用 `ref.invalidate` + + +有时，您可能希望强制处置提供者程序。 +这可以通过使用 `ref.invalidate` 来完成， +它可以从另一个提供者程序或小部件调用。 + + +使用 `ref.invalidate` 将处置当前提供者程序状态。 +然后有两种可能的结果： + + +- 如果监听提供者程序，则将创建一个新状态。 +- 如果提供者程序未被监听，则提供者程序将被完全处置。 + + + +:::info + +提供者程序可以使用 `ref.invalidateSelf` 使自己失效。 +尽管在这种情况下，这始终会导致创建新状态。 +::: + +:::tip + +当尝试使接收参数的提供者程序失效时， +可能会使一个特定的参数组合失效， +也可以同时使所有参数组合失效： + + +::: + + +## 使用 `ref.keepAlive` 微调处置 + + +如上所述，当自动处置启用时，如果在完整的一帧时间里提供者程序没有监听器，状态将被处置。 + + +但您可能希望对此行为有更多的控制权。例如， +您可能希望保留成功网络请求的状态，但不缓存失败的请求。 + + +这可以在启用自动处置后，使用通过 `ref.keepAlive` 来实现。 +使用它，您可以决定_何时_停止自动处置状态。 + + + +:::note + +如果重新计算提供者程序，将重新启用自动处置。 + + +也可以使用 `ref.keepAlive` 的返回值使其恢复到自动处置状态。 +::: + + +## 示例：在一段特定时间内保持状态 + + +目前，Riverpod 不提供在特定时间内保持状态的内置方法。 +但是，使用我们目前看到的工具，实现这样的功能很容易且可重用。 + + +通过使用 `Timer` + `ref.keepAlive`，我们可以在特定的时间内保持状态。 +为了使这个逻辑可重用，我们可以在扩展方法中实现它： + + + + +然后，我们可以这样使用它： + + + + +可以调整此逻辑以满足您的需求。 +例如，仅当提供者程序在特定时间内未被监听时， +才可以使用 `ref.onCancel`/`ref.onResume` 处置状态。 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart new file mode 100644 index 000000000..d962614d7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_extension.dart @@ -0,0 +1,18 @@ +import 'dart:async'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +extension CacheForExtension on Ref { + /// 使提供者程序在 [duration] 内存活。 + void cacheFor(Duration duration) { + // 立即防止状态遭到破坏。 + final link = keepAlive(); + // 持续时间结束后，我们将重新启用自动处置功能。 + final timer = Timer(duration, link.close); + + // 可选项：重新计算提供者程序时（如使用 ref.watch） + // 我们取消待定计时器 + onDispose(timer.cancel); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart new file mode 100644 index 000000000..b63cf3a46 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.dart @@ -0,0 +1,17 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../cache_for_extension.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future example(ExampleRef ref) async { + /// 保持状态 5 分钟 + ref.cacheFor(const Duration(minutes: 5)); + + return http.get(Uri.https('example.com')); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart new file mode 100644 index 000000000..423d550c9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'3ff29b1cd8fa864286a2a04e39adf1c8589b4275'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart new file mode 100644 index 000000000..b11b095f6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/cache_for_usage/raw.dart @@ -0,0 +1,15 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; + +import '../cache_for_extension.dart'; + +/* SNIPPET START */ +final provider = FutureProvider.autoDispose((ref) async { + /// 保持状态 5 分钟 + ref.cacheFor(const Duration(minutes: 5)); + + return http.get(Uri.https('example.com')); +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart new file mode 100644 index 000000000..6a576d932 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.dart @@ -0,0 +1,10 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen_keep_alive.g.dart'; + +/* SNIPPET START */ +// 我们可以在注解中指定 "keepAlive" 来禁用状态自动处置功能 +@Riverpod(keepAlive: true) +int example(ExampleRef ref) { + return 0; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart new file mode 100644 index 000000000..6565fc05b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -0,0 +1,72 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen_keep_alive.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + int create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'78f9426f6cbda80564387a9db8cd02368d890a85'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart new file mode 100644 index 000000000..db72c7279 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_example.dart @@ -0,0 +1,23 @@ +// ignore_for_file: use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +// We can specify autoDispose to enable automatic state destruction. +final someProvider = Provider.autoDispose((ref) { + return 0; +}); + +/* SNIPPET START */ +class MyWidget extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return ElevatedButton( + onPressed: () { + // 点击后，处置提供者程序。 + ref.invalidate(someProvider); + }, + child: const Text('dispose a provider'), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart new file mode 100644 index 000000000..4a93c3283 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +late WidgetRef ref; + +/* SNIPPET START */ +@riverpod +String label(LabelRef ref, String userName) { + return 'Hello $userName'; +} + +// ... + +void onTap() { + // 使该提供者程序所有可能的参数组合无效。 + ref.invalidate(labelProvider); + // 仅使特定组合无效 + ref.invalidate(labelProvider('John')); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart new file mode 100644 index 000000000..faf2b4033 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -0,0 +1,144 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef LabelRef = Ref; + +@ProviderFor(label) +const labelProvider = LabelFamily._(); + +final class LabelProvider extends $FunctionalProvider + with $Provider { + const LabelProvider._( + {required LabelFamily super.from, + required String super.argument, + String Function( + LabelRef ref, + String userName, + )? create}) + : _createCb = create, + super( + name: r'labelProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + LabelRef ref, + String userName, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$labelHash(); + + @override + String toString() { + return r'labelProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + LabelProvider $copyWithCreate( + String Function( + LabelRef ref, + ) create, + ) { + return LabelProvider._( + argument: argument as String, + from: from! as LabelFamily, + create: ( + ref, + String userName, + ) => + create(ref)); + } + + @override + String create(LabelRef ref) { + final _$cb = _createCb ?? label; + final argument = this.argument as String; + return _$cb( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is LabelProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$labelHash() => r'20aa8ce0231205540f466f91259732bd86953c64'; + +final class LabelFamily extends Family { + const LabelFamily._() + : super( + name: r'labelProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + LabelProvider call( + String userName, + ) => + LabelProvider._(argument: userName, from: this); + + @override + String debugGetCreateSourceHash() => _$labelHash(); + + @override + String toString() => r'labelProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + String Function( + LabelRef ref, + String args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as LabelProvider; + + final argument = provider.argument as String; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart new file mode 100644 index 000000000..6df871dbb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/invalidate_family_example/raw.dart @@ -0,0 +1,20 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +late WidgetRef ref; + +/* SNIPPET START */ +final provider = Provider.autoDispose.family((ref, name) { + return 'Hello $name'; +}); + +// ... + +void onTap() { + // 使该提供者程序所有可能的参数组合无效。 + ref.invalidate(provider); + // 仅使特定组合无效 + ref.invalidate(provider('John')); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart new file mode 100644 index 000000000..8f6bf9032 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.dart @@ -0,0 +1,21 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Future example(ExampleRef ref) async { + final response = await http.get(Uri.parse('https://example.com')); + // 只有在请求成功完成后，我们才会让提供者程序存活。 + // 如果请求失败（并抛出异常），那么当提供者程序停止被监听时， + // 状态就会被处置。 + ref.keepAlive(); + + // 我们可以使用 `link` 恢复自动处置行为： + // link.close(); + + return response.body; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart new file mode 100644 index 000000000..51ab6e0c5 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'4fa856c55e84da9525dcecfab1c897e61456325b'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart new file mode 100644 index 000000000..407edcaf2 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/keep_alive/raw.dart @@ -0,0 +1,19 @@ +// ignore_for_file: unused_local_variable + +import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +final provider = FutureProvider.autoDispose((ref) async { + final response = await http.get(Uri.parse('https://example.com')); + // 只有在请求成功完成后，我们才会让提供者程序存活。 + // 如果请求失败（并抛出异常），那么当提供者程序停止被监听时， + // 状态就会被处置。 + final link = ref.keepAlive(); + + // 我们可以使用 `link` 恢复自动处置行为： + // link.close(); + + return response.body; +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart new file mode 100644 index 000000000..d9ada052f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable + +import 'dart:async'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +Stream example(ExampleRef ref) { + final controller = StreamController(); + + // 当状态被处置时，我们关闭 StreamController。 + ref.onDispose(controller.close); + + // TO-DO: 在 StreamController 中推送一些值 + return controller.stream; +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart new file mode 100644 index 000000000..e5b67e8f7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -0,0 +1,124 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider + extends $FunctionalProvider, Stream, ExampleRef> + with $FutureModifier, $StreamProvider { + const ExampleProvider._( + {Stream Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $StreamProviderElement $createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + Stream Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + Stream create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'29f92958e0d0e3f13ac033e92cd2e4072339c7db'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart new file mode 100644 index 000000000..e80ac03e3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/on_dispose_example/raw.dart @@ -0,0 +1,17 @@ +// ignore_for_file: unused_local_variable + +import 'dart:async'; + +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +final provider = StreamProvider((ref) { + final controller = StreamController(); + + // 当状态被处置时，我们关闭 StreamController。 + ref.onDispose(controller.close); + + // TO-DO: 在 StreamController 中推送一些值 + return controller.stream; +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart new file mode 100644 index 000000000..029281265 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/auto_dispose/raw_auto_dispose.dart @@ -0,0 +1,7 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +// 我们可以指定 autoDispose 来启用状态自动处置功能。 +final provider = Provider.autoDispose((ref) { + return 0; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx new file mode 100644 index 000000000..ab0a6a7f5 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests.mdx @@ -0,0 +1,275 @@ +--- +title: 组合请求 +version: 1 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet } from "@site/src/components/CodeSnippet"; +import functionalRef from "./combining_requests/functional_ref"; +import notifierRef from "./combining_requests/notifier_ref"; +import watchExample from "./combining_requests/watch_example"; +import watchPlacement from "./combining_requests/watch_placement"; +import listenExample from "./combining_requests/listen_example"; +import readExample from './combining_requests/read_example' + + +到目前为止，我们只看到请求彼此独立的案例。 +但一个常见的用例是必须根据另一个请求的结果触发请求。 + + +我们可以使用机制来做到这一点， +方法是将一个提供者程序的结果作为参数传递给另一个提供者程序。 + + +但这种方法有一些缺点： + + +- 这泄露了实现细节。 + 现在，UI 需要了解所有被其他提供者程序使用的提供者程序。 +- 每当参数发生变化时，都会产生一个全新的状态。 + 通过传递参数，当参数更改时，无法保持以前的状态。 +- 它使合并请求变得更加困难。 +- 这使得开发工具的用处降低。devtool 不会知道提供者程序之间的关系。 + + +为了改善这一点，Riverpod 提供了一种不同的方法来合并请求。 + + +## 基础知识：获取 "ref" + + +组合请求的所有可能方法都有一个共同点：它们都基于 `Ref` 对象。 + + +该 `Ref` 对象是所有提供者程序都有权访问的对象。 +它允许他们访问各种生命周期监听器， +还可以使用各种方法来组合提供者程序。 + + +可以获取的位置 `Ref` 取决于提供者程序的类型。 + + +在函数提供者程序中，将 `Ref` 作为参数传递给提供者程序的函数： + + + + +在类变体中，`Ref` 是通知者程序类的一个属性： + + + + +## 使用 ref 读取提供者程序。 + + +### `ref.watch` 方法。 + + +现在我们已经获得了一个 `Ref`，我们可以用它来组合请求。 +执行此操作的主要方法是使用 `ref.watch`。 +通常建议对代码进行架构设计， +以便可以使用 `ref.watch` 的其他选项，因为它通常更易于维护。 + + +该 `ref.watch` 方法采用提供者程序，并返回其当前状态。 +然后，每当监听的提供者程序发生更改时，我们的提供者程序将在 +下一帧或下一次读取时失效并重新生成。 + + +通过使用 `ref.watch`，您的逻辑变得既是“反应式”又是“声明式”。 +这意味着您的逻辑将在需要时自动重新计算。 +并且更新机制不依赖于副作用，例如“更改”。 +这类似于 StatelessWidgets 的行为方式。 + + +例如，我们可以定义一个监听用户位置的提供者程序。 +然后，我们可以使用这个位置来获取用户附近的餐馆列表。 + + + +:::info + +当监听的提供者程序发生更改并且我们的请求重新计算时，将保留以前的状态，直到新请求完成。 +同时，当请求处于挂起状态时，将设置 "isLoading" 和 "isReloading" 标志。 + + +这使 UI 能够显示以前的状态或加载指示器，甚至两者兼而有之。 +::: + +:::info + +请注意我们如何使用 `ref.watch(locationProvider.future)` 来替代 `ref.watch(locationProvider)`。 +那是因为我们 `locationProvider` 是异步的。因此，我们希望等待初始值可用。 + + +如果我们省略了这一点 `.future`，我们将收到一个 `AsyncValue`， +它是 `locationProvider` 当前状态的快照。但是，如果还没有可用的位置， +我们将无能为力。 +::: + +:::caution + +调用 `ref.watch` “命令式”执行的内部代码被认为是不好的做法。 +这意味着在提供者程序的构建阶段可能未执行的任何代码。 +这包括通告程序上的“监听器”回调或方法： + + +::: + + +### `ref.listen`/`listenSelf` 方法。 + + +该 `ref.listen` 方法是 `ref.watch` 的替代方法。 +它类似于传统的 "listen"/"addListener" 方法。 +它接受一个提供者程序和一个回调， +并在提供者程序的内容发生更改时调用该回调。 + + +通常建议重构代码，您可以使用 `ref.watch` 替代 `ref.listen`， +因为后者由于其命令性质而更容易出错。 +但是 `ref.listen` 可以有助于添加一些快速逻辑而不必进行重大重构。 + + +我们可以重写 `ref.watch` 示例并使用 `ref.listen` 代替 + + + +:::info + +在提供者程序的构建阶段使用 `ref.listen` 是完全安全的。 +如果以某种方式重新计算提供者程序，则以前的监听器将被删除。 + + +或者，您可以根据需要使用 `ref.listen` 的返回值手动删除监听器。 +::: + + +### `ref.read` 方法 + + +最后一个可用选项是 `ref.read`。 +它类似于 `ref.watch` 返回提供者程序的当前状态。 +但与 `ref.watch` 不同的是，它不监听提供者程序。 + + +因此，`ref.read` 应该只被用在你不能使用 `ref.watch` 的地方， +比如通告程序的内部方法。 + + + +:::caution + +`ref.read` 在提供者程序上使用时要小心，因为它不监听提供者程序， +因此如果不监听提供者程序，则该提供者程序可能会决定处置其状态。 +::: diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart new file mode 100644 index 000000000..815283fa1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.dart @@ -0,0 +1,18 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +int example(ExampleRef ref) { + // "Ref" 可以在这里用来阅读其他提供者程序 + final otherValue = ref.watch(otherProvider); + + return 0; +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart new file mode 100644 index 000000000..e1926f3be --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/codegen.g.dart @@ -0,0 +1,131 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + int create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'4429d7d3bb2b31fea4cc42c2f2af02d3f3d10693'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart new file mode 100644 index 000000000..9b59d2fc3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/functional_ref/raw.dart @@ -0,0 +1,14 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod/riverpod.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = Provider((ref) { + // "Ref" 可以在这里用来阅读其他提供者程序 + final otherValue = ref.watch(otherProvider); + + return 0; +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart new file mode 100644 index 000000000..86925e4b4 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.dart @@ -0,0 +1,20 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) { + return 0; +} + +/* SNIPPET START */ +@riverpod +int example(ExampleRef ref) { + ref.listen(otherProvider, (previous, next) { + print('Changed from: $previous, next: $next'); + }); + + return 0; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart new file mode 100644 index 000000000..0b81a9d81 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/codegen.g.dart @@ -0,0 +1,131 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'6e430ebf25cc307c3aff048518bdcb69646fe123'; + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + int create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'd614303f372e06e6ab96035affc4c07a53b28741'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart new file mode 100644 index 000000000..334f73b5a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/listen_example/raw.dart @@ -0,0 +1,13 @@ +// ignore_for_file: unused_local_variable, avoid_print +import 'package:riverpod/riverpod.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = Provider((ref) { + ref.listen(otherProvider, (previous, next) { + print('Changed from: $previous, next: $next'); + }); + + return 0; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart new file mode 100644 index 000000000..1d2139dbf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.dart @@ -0,0 +1,21 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) => 0; + +/* SNIPPET START */ +@riverpod +class Example extends _$Example { + @override + int build() { + // "Ref" 可以在这里用来阅读其他提供者程序 + final otherValue = ref.watch(otherProvider); + + return 0; + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart new file mode 100644 index 000000000..6be34301f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -0,0 +1,140 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; + +@ProviderFor(Example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $NotifierProvider { + const ExampleProvider._( + {super.runNotifierBuildOverride, Example Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Example Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Example create() => _createCb?.call() ?? Example(); + + @$internal + @override + ExampleProvider $copyWithCreate( + Example Function() create, + ) { + return ExampleProvider._(create: create); + } + + @$internal + @override + ExampleProvider $copyWithBuild( + int Function( + Ref, + Example, + ) build, + ) { + return ExampleProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$exampleHash() => r'893db991b377b8e314e60c429043e5e81f1fd526'; + +abstract class _$Example extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart new file mode 100644 index 000000000..69d35a68a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/notifier_ref/raw.dart @@ -0,0 +1,19 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod/riverpod.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = NotifierProvider(MyNotifier.new); + +class MyNotifier extends Notifier { + @override + int build() { + // "Ref" 可以在这里用来阅读其他提供者程序 + final otherValue = ref.watch(otherProvider); + + return 0; + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart new file mode 100644 index 000000000..3eb4a114b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.dart @@ -0,0 +1,26 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) { + return 0; +} + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // 糟糕的！不要在这里使用 "read"，因为它不是反应性的 + ref.read(otherProvider); + + return 0; + } + + void increment() { + ref.read(otherProvider); // 这里使用 "read" 就可以了 + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart new file mode 100644 index 000000000..325c4f028 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/codegen.g.dart @@ -0,0 +1,140 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'6e430ebf25cc307c3aff048518bdcb69646fe123'; + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'353efe22dd5a91b2d036286211ac9e60c9de5f6d'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart new file mode 100644 index 000000000..37076ea18 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/read_example/raw.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable + +import 'package:riverpod/riverpod.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final notifierProvider = NotifierProvider(MyNotifier.new); + +class MyNotifier extends Notifier { + @override + int build() { + // 糟糕的！不要在这里使用 "read"，因为它不是反应性的 + ref.read(otherProvider); + + return 0; + } + + void increment() { + ref.read(otherProvider); // 这里使用 "read" 就可以了 + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart new file mode 100644 index 000000000..55e04c8c4 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.dart @@ -0,0 +1,45 @@ +// ignore_for_file: unused_local_variable + +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +final otherProvider = Provider((ref) => 0); + +const someStream = Stream<({double longitude, double latitude})>.empty(); + +/* SNIPPET START */ +@riverpod +Stream<({double longitude, double latitude})> location(LocationRef ref) { + // TO-DO: 返回获取当前位置的流 + return someStream; +} + +@riverpod +Future> restaurantsNearMe(RestaurantsNearMeRef ref) async { + // 我们使用 "ref.watch" 来获取最新位置。 + // 通过在提供者程序之后指定 ".future"， + // 我们的代码将在等待到至少一个位置信息后可用。 + final location = await ref.watch(locationProvider.future); + + // 我们现在可以根据该位置发出网络请求。 + // 例如，我们可以使用 Google Map API： + // https://developers.google.com/maps/documentation/places/web-service/search-nearby + final response = await http.get( + Uri.https('maps.googleapis.com', 'maps/api/place/nearbysearch/json', { + 'location': '${location.latitude},${location.longitude}', + 'radius': '1500', + 'type': 'restaurant', + 'key': '', + }), + ); + // 从 JSON 中获取餐厅名称 + final json = jsonDecode(response.body) as Map; + final results = (json['results'] as List).cast>(); + return results.map((e) => e['name']! as String).toList(); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart new file mode 100644 index 000000000..1d47b1279 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/codegen.g.dart @@ -0,0 +1,125 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef LocationRef = Ref>; + +@ProviderFor(location) +const locationProvider = LocationProvider._(); + +final class LocationProvider extends $FunctionalProvider< + AsyncValue<({double longitude, double latitude})>, + Stream<({double longitude, double latitude})>, + LocationRef> + with + $FutureModifier<({double longitude, double latitude})>, + $StreamProvider<({double longitude, double latitude}), LocationRef> { + const LocationProvider._( + {Stream<({double longitude, double latitude})> Function( + LocationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'locationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream<({double longitude, double latitude})> Function( + LocationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$locationHash(); + + @$internal + @override + $StreamProviderElement<({double longitude, double latitude})> $createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + LocationProvider $copyWithCreate( + Stream<({double longitude, double latitude})> Function( + LocationRef ref, + ) create, + ) { + return LocationProvider._(create: create); + } + + @override + Stream<({double longitude, double latitude})> create(LocationRef ref) { + final _$cb = _createCb ?? location; + return _$cb(ref); + } +} + +String _$locationHash() => r'22e666f1e1ce04ce03d8f8d5652e25b54c1d1af3'; + +typedef RestaurantsNearMeRef = Ref>>; + +@ProviderFor(restaurantsNearMe) +const restaurantsNearMeProvider = RestaurantsNearMeProvider._(); + +final class RestaurantsNearMeProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, RestaurantsNearMeRef> + with + $FutureModifier>, + $FutureProvider, RestaurantsNearMeRef> { + const RestaurantsNearMeProvider._( + {FutureOr> Function( + RestaurantsNearMeRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'restaurantsNearMeProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + RestaurantsNearMeRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$restaurantsNearMeHash(); + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + RestaurantsNearMeProvider $copyWithCreate( + FutureOr> Function( + RestaurantsNearMeRef ref, + ) create, + ) { + return RestaurantsNearMeProvider._(create: create); + } + + @override + FutureOr> create(RestaurantsNearMeRef ref) { + final _$cb = _createCb ?? restaurantsNearMe; + return _$cb(ref); + } +} + +String _$restaurantsNearMeHash() => r'dd49cc1e6f16abb34dd15286d171e322c06b93b8'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart new file mode 100644 index 000000000..ab4e3bf0f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_example/raw.dart @@ -0,0 +1,41 @@ +// ignore_for_file: unused_local_variable + +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; + +final otherProvider = Provider((ref) => 0); + +const someStream = Stream<({double longitude, double latitude})>.empty(); + +/* SNIPPET START */ +final locationProvider = + StreamProvider<({double longitude, double latitude})>((ref) { + // TO-DO: 返回获取当前位置的流 + return someStream; +}); + +final restaurantsNearMeProvider = FutureProvider>((ref) async { + // 我们使用 "ref.watch" 来获取最新位置。 + // 通过在提供者程序之后指定 ".future"， + // 我们的代码将在等待到至少一个位置信息后可用。 + final location = await ref.watch(locationProvider.future); + + // 我们现在可以根据该位置发出网络请求。 + // 例如，我们可以使用 Google Map API： + // https://developers.google.com/maps/documentation/places/web-service/search-nearby + final response = await http.get( + Uri.https('maps.googleapis.com', 'maps/api/place/nearbysearch/json', { + 'location': '${location.latitude},${location.longitude}', + 'radius': '1500', + 'type': 'restaurant', + 'key': '', + }), + ); + // 从 JSON 中获取餐厅名称 + final json = jsonDecode(response.body) as Map; + final results = (json['results'] as List).cast>(); + return results.map((e) => e['name']! as String).toList(); +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart new file mode 100644 index 000000000..f496362e2 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.dart @@ -0,0 +1,40 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/foundation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +@riverpod +int other(OtherRef ref) { + return 0; +} + +/* SNIPPET START */ +@riverpod +int example(ExampleRef ref) { + ref.watch(otherProvider); // 好！ + ref.onDispose(() => ref.watch(otherProvider)); // 糟糕！ + + final someListenable = ValueNotifier(0); + someListenable.addListener(() { + ref.watch(otherProvider); // 糟糕！ + }); + + return 0; +} + +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + ref.watch(otherProvider); // 好！ + ref.onDispose(() => ref.watch(otherProvider)); // 糟糕！ + + return 0; + } + + void increment() { + ref.watch(otherProvider); // 糟糕！ + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart new file mode 100644 index 000000000..18ff52898 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/codegen.g.dart @@ -0,0 +1,199 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef OtherRef = Ref; + +@ProviderFor(other) +const otherProvider = OtherProvider._(); + +final class OtherProvider extends $FunctionalProvider + with $Provider { + const OtherProvider._( + {int Function( + OtherRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'otherProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + OtherRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$otherHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + OtherProvider $copyWithCreate( + int Function( + OtherRef ref, + ) create, + ) { + return OtherProvider._(create: create); + } + + @override + int create(OtherRef ref) { + final _$cb = _createCb ?? other; + return _$cb(ref); + } +} + +String _$otherHash() => r'6e430ebf25cc307c3aff048518bdcb69646fe123'; + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + int create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'd4d63f5cf1aaec5b7c6a19e6fee18ddf070147ec'; + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'ad79fdb5b0e72a800fa03efc1e7157f0d1524844'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart new file mode 100644 index 000000000..10b880984 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/combining_requests/watch_placement/raw.dart @@ -0,0 +1,35 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/foundation.dart'; +import 'package:riverpod/riverpod.dart'; + +final otherProvider = Provider((ref) => 0); + +/* SNIPPET START */ +final provider = Provider((ref) { + ref.watch(otherProvider); // 好！ + ref.onDispose(() => ref.watch(otherProvider)); // 糟糕！ + + final someListenable = ValueNotifier(0); + someListenable.addListener(() { + ref.watch(otherProvider); // 糟糕！ + }); + + return 0; +}); + +final notifierProvider = NotifierProvider(MyNotifier.new); + +class MyNotifier extends Notifier { + @override + int build() { + ref.watch(otherProvider); // 好！ + ref.onDispose(() => ref.watch(otherProvider)); // 糟糕！ + + return 0; + } + + void increment() { + ref.watch(otherProvider); // 糟糕！ + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx new file mode 100644 index 000000000..d1b4fe452 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/do_dont.mdx @@ -0,0 +1,260 @@ +--- +title: 最佳实践 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; + + +为了确保代码具有良好的可维护性， +这里列出了您在使用 Riverpod 时应遵循的良好实践。 + + +此列表并不详尽，并且可能会发生变化。 +如果您有任何建议，请随时[提出问题](https://github.com/rrousselGit/riverpod/issues/new?assignees=rrousselGit&labels=documentation%2C+needs+triage&projects=&template=example_request.md&title=)。 + + +此列表中的项目没有任何特定的顺序。 + + +这些建议的很大一部分可以通过 [riverpod_lint](https://pub.dev/packages/riverpod_lint) 来执行。 +请参阅了解安装说明。 + + +## 避免！在小部件中初始化提供者程序​ + + +提供者程序应自行初始化。 +它们不应由外部元素（例如小部件）初始化。 + + +如果不这样做可能会导致可能的竞争条件和意外行为。 + + +**不要** + +```dart +class WidgetState extends State { + @override + void initState() { + super.initState(); + // 坏的：提供者程序应该自己初始化自己 + ref.read(provider).init(); + } +} +``` + + +**考虑** + + +对于这个问题，没有“一刀切”的解决方案。 +如果您的初始化逻辑取决于提供者程序的外部因素， +则放置此类逻辑的正确位置通常是触发导航的按钮的 `onPressed` 方法中： + +```dart +ElevatedButton( + onPressed: () { + ref.read(provider).init(); + Navigator.of(context).push(...); + }, + child: Text('Navigate'), +) +``` + + +## 避免！使用本地小部件状态的提供者程序。 + + +提供者程序被设计为共享业务状态。 +它们不适合用于本地小部件状态，例如： + + +- 存储表单状态 +- 当前选择的项目 +- 动画 +- Flutter 处理常见的 "controller" 相关的所有内容（例如 `TextEditingController` ） + + +如果您正在寻找一种处理本地小部件状态的方法，请考虑使用 +[flutter_hooks](https://pub.dev/packages/flutter_hooks) 代替。 + + +不鼓励这样做的一个原因是这种状态通常仅限于一条路由。 +如果不这样做，可能会破坏应用程序的后退按钮，因为新页面会覆盖上一页的状态。 + + +## 不要！在提供者程序初始化期间执行副作用​ + + +提供者程序通常应用于表示“读”操作。 +您不应该将它们用于“写”操作，例如提交表单。 + + +使用提供者程序进行此类操作可能会产生意外行为，例如 +如果执行了前一个操作，则跳过副作用。 + + +如果您正在寻找一种处理副作用的加载/错误状态的方法， +请参阅。 + + +**不要**： + +```dart +final submitProvider = FutureProvider((ref) async { + final formState = ref.watch(formState); + + // 坏的：提供者程序不应用于“写”操作。 + return http.post('https://my-api.com', body: formState.toJson()); +}); +``` + + +## 首选！ref.watch/read/listen（和类似的 API）以及静态已知的提供者程序​ + + +Riverpod 强烈建议启用 lint 规则（通过 riverpod_lint）。 +但为了使 lint 发挥作用，您的代码应该以可静态分析的方式编写。 + + +如果不这样做，可能会更难发现错误或导致 lints 误报。 + + +**应该**： + +```dart +final provider = Provider((ref) => 42); + +... + +// 好的，因为提供者程序是静态已知的 +ref.watch(provider); +``` + + +**不要**： + +```dart +class Example extends ConsumerWidget { + Example({required this.provider}); + final Provider provider; + + @override + Widget build(context, ref) { + // 不好，因为静态分析无法知道 `provider` 是什么 + ref.watch(provider); + } +} +``` + + +## 避免！动态创建提供者程序​ + + +提供者程序应该专门是顶级 final 变量。 + + +**应该**： + +```dart +final provider = Provider((ref) => 'Hello world'); +``` + + +**不要**： + +```dart +class Example { + // 不支持的操作。可能导致内存泄漏和意外行为。 + final provider = Provider((ref) => 'Hello world'); +} +``` + +:::info + +允许将提供者程序创建为 static final 变量， +但代码生成器不支持。 +::: diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx new file mode 100644 index 000000000..35c85ad4b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization.mdx @@ -0,0 +1,117 @@ +--- +title: 急切的初始化提供者程序 +version: 1 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet } from "@site/src/components/CodeSnippet"; +import consumerExample from "!!raw-loader!./eager_initialization/consumer_example.dart"; +import asyncConsumerExample from "!!raw-loader!./eager_initialization/async_consumer_example.dart"; +import requireValue from "./eager_initialization/require_value"; + + +默认情况下，所有提供者程序都以延迟方式初始化。 +这意味着提供者程序仅在首次使用时进行初始化。 +这对于仅在应用程序的某些部分使用的提供者程序很有用。 + + +不幸的是，由于 Dart 的工作方式（出于摇树目的），没有办法将提供者程序标记为需要急切初始化。 +但是，一种解决方案是在应用程序的根组件下强制读取要急切初始化的提供者程序。 + + +推荐的方法是简单地 "watch" 位于 `ProviderScope` 下方的 Consumer 中的提供者程序： + + + +:::note + +请考虑将初始化使用者放在 "MyApp" 或公共小部件中。 +这使你的测试能够使用相同的行为，方法是从你的主数据中删除逻辑。 +::: + + +### 常见疑问 + + +#### 当提供者程序更改时，这不会重建我们的整个应用程序吗？ + + +不，事实并非如此。 +在上面给出的示例中，负责急切初始化的消费者程序是一个单独的小部件，它只返回一个 `child` . + + +关键部分是它返回一个 `child` ，而不是实例化 `MaterialApp` 自身。 +这意味着，如果重新生成 `_EagerInitialization`，`child` 变量将不会更改。 +当一个小部件没有改变时，Flutter 不会重建它。 + + +因此，除非另一个小部件也在监听该提供者程序，否则只会 `_EagerInitialization` 重新构建。 + + +#### 使用此方法，如何处理加载和错误状态？ + + +您可以像往常一样在 `Consumer` 中处理加载/错误状态。 +您可以 `_EagerInitialization` 检查提供者程序是否处于 "loading" 状态， +如果是则返回 `CircularProgressIndicator` 否则返回 `child`： + + + + +#### 我已经处理了加载/错误状态，但其他消费者程序仍然收到 AsyncValue！有没有办法不必处理每个小部件中的加载/错误状态？ + + +与其试图让你的提供者程序不公开一个 `AsyncValue` ，不如让你的小部件使用 `AsyncValue.requireValue`。 +这将读取数据，而无需进行模式匹配。如果一个错误溜走了，它会抛出一个异常，并带有明确的信息。 + + + +:::note + +尽管有一些方法可以在这些情况下不公开加载/错误状态（依赖于范围），但通常不建议这样做。 +创建两个提供者程序并使用覆盖所增加的复杂性不值得麻烦。 +::: diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart new file mode 100644 index 000000000..372f93b77 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/async_consumer_example.dart @@ -0,0 +1,27 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors, unused_element + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +final myProvider = FutureProvider((ref) => 0); + +/* SNIPPET START */ +class _EagerInitialization extends ConsumerWidget { + const _EagerInitialization({required this.child}); + final Widget child; + + @override + Widget build(BuildContext context, WidgetRef ref) { + final result = ref.watch(myProvider); + + // 处理错误状态和加载状态 + if (result.isLoading) { + return const CircularProgressIndicator(); + } else if (result.hasError) { + return const Text('Oopsy!'); + } + + return child; + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart new file mode 100644 index 000000000..03306a64c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/consumer_example.dart @@ -0,0 +1,35 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +final myProvider = Provider((ref) => 0); + +/* SNIPPET START */ +void main() { + runApp(ProviderScope(child: MyApp())); +} + +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return const _EagerInitialization( + // TODO: 在这里渲染你的 APP + child: MaterialApp(), + ); + } +} + +class _EagerInitialization extends ConsumerWidget { + const _EagerInitialization({required this.child}); + final Widget child; + + @override + Widget build(BuildContext context, WidgetRef ref) { + // 通过观察提供者程序，来初始化提供者程序。 + // 通过使用 "watch"，提供者程序将保持存活，不会被处置。 + ref.watch(myProvider); + return child; + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart new file mode 100644 index 000000000..a13c16b90 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +// 一个急切需要初始化的 provider +@riverpod +Future example(ExampleRef ref) async => 'Hello world'; + +class MyConsumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final result = ref.watch(exampleProvider); + + /// 如果提供者程序被正确的急切初始化了， + /// 那么我们可以使用 "requireValue" 直接读取数据。 + return Text(result.requireValue); + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart new file mode 100644 index 000000000..fa3e37948 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/codegen.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart new file mode 100644 index 000000000..807db346a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/eager_initialization/require_value/raw.dart @@ -0,0 +1,20 @@ +// ignore_for_file: unused_local_variable, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +// 一个急切需要初始化的 provider +final exampleProvider = FutureProvider((ref) async => 'Hello world'); + +class MyConsumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final result = ref.watch(exampleProvider); + + /// 如果提供者程序被正确的急切初始化了， + /// 那么我们可以使用 "requireValue" 直接读取数据。 + return Text(result.requireValue); + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/faq.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/faq.mdx new file mode 100644 index 000000000..4c6e25e26 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/faq.mdx @@ -0,0 +1,355 @@ +--- +title: FAQ 常见问题 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; + + +以下是社区中的一些常见问题： + + +## `ref.refresh` 和 `ref.invalidate` 之间有什么不同？ + + +您可能已经注意到 `ref` 有两种方法可以强制提供者程序重新计算，并且想知道它们有何不同。 + + +它比你想象的要简单： `ref.refresh` 只是 `invalidate` + `read` 的语法糖： + +```dart +T refresh(provider) { + invalidate(provider); + return read(provider); +} +``` + + +如果您在重新计算后不关心提供者程序的新值， +那么 `invalidate` 就是正确的选择。 +如果这样做，请改用 `refresh`。 + +:::info + +该逻辑通过 lint 规则自动执行。 +如果您尝试使用 `ref.refresh` 而不使用返回值，您将收到警告。 +::: + + +行为上的主要区别在于，通过在使提供者程序失效后， +提供者程序会**立即**重新计算。 +然而，如果我们调用 `invalidate` 但没有立即读取它， +那么更新将稍后触发。 + + +“稍后”更新通常是在下一帧开始时。 +然而，如果当前被未监听的提供者程序失效， +则它在再次被监听之前都不会被更新。 + + +## 为什么 Ref 和 WidgetRef 之间没有共享接口？​ + + +Riverpod 自愿分离 `Ref` 和 `WidgetRef`。 +这样做的目的是为了避免编写有条件依赖其中之一的代码。 + + +一个问题是 `Ref` 和 `WidgetRef` 虽然看起来相似，但存在细微的差异。 +依赖于两者的代码将变得不可靠，并且难以发现。 + + +同时，依赖 `WidgetRef` 就相当于依赖 `BuildContext`。 +它实际上将您的逻辑放在 UI 层中，但不建议这样做。 + +--- + + +此类代码应重构为**始终**使用 `Ref`。 + + +此问题的解决方案通常是将您的逻辑移至 `Notifier` 中 +（请参阅 ）， +然后让您的逻辑成为该 `Notifier` 的方法。 + + +这样，当您的小部件想要调用此逻辑时，它们可以编写如下内容： + +```dart +ref.read(yourNotifierProvider.notifier).yourMethod(); +``` + + +`yourMethod` 将使用 `Notifier` 的 `Ref` 与其他提供者程序交互。 + + +## 为什么我们需要扩展 ConsumerWidget 而不是使用原始的 StatelessWidget？ + + +这是由于 `InheritedWidget` API 中的一个不幸的限制造成的。 + + +有几个问题： + + +- 无法使用 `InheritedWidget` 实现监听器的“当更改时”。 + 这意味着诸如 `ref.listen` 之类的内容不能与 `BuildContext` 一起使用。 + + `State.didChangeDependencies` 是最接近它的东西，但它并不可靠。 + 一个问题是，即使没有改变依赖关系，生命周期也可能被触发， + 特别是如果你的 widget 树使用 GlobalKeys（并且一些 Flutter widget 已经在内部这样做了）。 + + + +- 监听 `InheritedWidget` 的小部件永远不会停止监听它。 + 这通常适用于纯元数据，例如 "theme" 或 "media query"。 + + 对于业务逻辑来说，这是一个问题。 + 假设您使用提供者程序来表示分页 API。 + 当页面偏移量发生变化时，您不希望小部件继续监听先前可见的页面。 + + +- `InheritedWidget` 无法跟踪小部件何时停止监听它们。 + Riverpod 有时依赖于跟踪提供者程序是否被监听。 + + +此功能对于自动处置机制和将参数传递给提供者程序的能力至关重要。 +这些功能使 Riverpod 如此强大。 + + +也许在遥远的将来，这些问题将会得到解决。在这种情况下， +Riverpod 将迁移到使用 `BuildContext` 而不是 `Ref`。 +这将允许使用 `StatelessWidget` 而不是 `ConsumerWidget` 。 +但那是以后再说了！ + + +## 为什么 hooks_riverpod 不导出 flutter_hooks？ + + +这是为了尊重良好的版本控制实践。 + + +虽然您不能在没有 `flutter_hooks` 的情况下使用 `hooks_riverpod`， +但这两个包都是独立版本控制的。 +当其中一个可能会发生重大变化时，不会影响另一个。 + + +## 为什么 Riverpod 在某些情况下使用 `identical` 而不是 `==` 来过滤更新？​ + + +通知者程序使用 `identical` 而不是 `==` 来过滤更新。 + + +这是因为 Riverpod 用户为了实现 copyWith +而使用 Freezed/built_value 等代码生成器是很常见的。 +这些包重写 `==` 以深入比较对象。深度对象比较的成本相当高。 +“业务逻辑”模型往往具有很多属性。更糟糕的是，他们还有列表、地图等集合。 + + +同时，当使用复杂的“业务”对象时，大多数 `state = newState` 调用 +总是会产生通知（否则调用 setter 没有意义）。一般来说， +当当前状态和新状态相等时，我们调用 `state = newState` 的主要情况 +是对于原始对象（整数、枚举、字符串，但不是列表/类/...）。 +这些对象“默认被规范化”。如果这些对象是相等的， +那么它们通常也是“相同的（identical）”。 + + +因此，Riverpod 使用 `identical` 来过滤更新是一个两全其美的默认值尝试。 +对于复杂对象，我们并不真正关心过滤对象， +并且由于代码生成器默认生成 `==` 覆盖，因此 `==` 可能会很昂贵， +使用 `identical` 提供了一种通知监听器的有效方式。 +同时，对于简单对象，`identical` 确实正确过滤了冗余通知。 + + +最后且同样重要的一点是，您可以通过重写通知者程序上的方法 `updateShouldNotify` 来更改此行为。 + + +## 有没有办法一次性重置所有提供者程序 + + +不，没有办法立即重置所有提供者程序。 + + +这是故意的，因为它被认为是反模式。 +立即重置所有提供者程序通常会重置您不打算重置的提供者程序。 + + +当用户注销时想要重置应用程序状态的用户通常会询问此问题。 +如果这就是您所希望的，那么您应该将所有内容都 +通过 `ref.watch` 依赖于 "user" 提供者程序的用户状态。 + + +然后，当用户注销时，依赖于它的所有提供者程序将自动重置，但其他所有内容都将保持不变。 + + +## 我收到错误“在处理小部件后无法使用‘ref’”，这是怎么回事？​ + + +您可能还会看到 "Bad state: No ProviderScope found"，这是同一问题的较旧错误消息。 + + +当您尝试在不再安装的小部件中使用 `ref` 时，会发生此错误。这通常发生在 `await` 之后： + +```dart +ElevatedButton( + onPressed: () async { + await future; + ref.read(...); // 可能抛出 "Cannot use "ref" after the widget was disposed" + } +) +``` + + +解决方案是，与 `BuildContext` 一样，在使用 `ref` 之前检查 `mounted`： + +```dart +ElevatedButton( + onPressed: () async { + await future; + if (!context.mounted) return; + ref.read(...); // 不再抛出 + } +) +``` diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request.mdx new file mode 100644 index 000000000..490a98fbf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request.mdx @@ -0,0 +1,580 @@ +--- +title: 开始你的第一次 provider/network 请求 +pagination_prev: introduction/getting_started +version: 1 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import activity from "./first_request/activity"; +import provider from "./first_request/provider"; +import consumer from "./first_request/consumer"; +import consumerWidget from "./first_request/consumer_widget"; +import consumerStatefulWidget from "./first_request/consumer_stateful_widget"; +import hookConsumerWidget from "./first_request/hook_consumer_widget"; +import Legend from "./first_request/legend/legend"; + + +网络请求是任何应用程序的核心。但是，在发出网络请求时，需要考虑很多事项： + + +- UI 应在发出请求时呈现加载状态 +- 应妥善处理错误 +- 如果可能，应缓存请求 + + +在本节中，我们将看到 Riverpod 如何帮助我们自然地处理所有这些问题。 + + +## 配置 `ProviderScope` + + +在开始发出网络请求之前，请确保将其 `ProviderScope` 添加到应用程序的根目录。 + +```dart +void main() { + runApp( + // To install Riverpod, we need to add this widget above everything else. + // This should not be inside "MyApp" but as direct parameter to "runApp". + // 为了安装 Riverpod，我们需要将这个小组件添加到所有的小组件之上。 + // 它不应该在 “MyApp” 内部，而是作为 “runApp” 的直接参数。 + ProviderScope( + child: MyApp(), + ), + ); +} +``` + + +这样就可以为整个应用程序启用 Riverpod。 + +:::note + +有关完整的安装步骤（例如安装 [riverpod_lint](https://pub.dev/packages/riverpod_lint) +和运行代码生成器），请查看。 +::: + + +## 在 “provider” 中执行网络请求 + + +执行网络请求通常就是我们所说的“业务逻辑”。在 Riverpod 中，业务逻辑位于“providers”中。 +provider 是一种具有超能力的函数。它们的行为与正常函数类似，并具有以下额外好处： + + +- 保持缓存 +- 提供默认错误/加载处理 +- 可以被监听 +- 当某些数据发生变化时自动重新执行 + + +这使得 provider 非常适合 _GET_ 网络请求（与 _POST/etc_ 请求一样，请参阅）。 + + +举个例子，让我们做一个简单的应用程序，建议在无聊时做一个随机的活动。 +为此，我们将使用 [Bored API](https://boredapi.com/)。具体而言， +我们将在 `/api/activity` 端点上执行 _GET_ 请求。端点返回一个 JSON 对象，我们将把它解析为 Dart 类实例。 +然后，下一步是在 UI 中显示此活动。我们还将确保在发出请求时呈现加载状态，并优雅地处理错误。 + + +听起来不错？让我们开始吧！ + + +### 定义数据模型 + + +在开始之前，我们需要定义从 API 接收的数据模型。 +该模型还需要一种方法将 JSON 对象解析为 Dart 类实例。 + + +通常，建议使用 [Freezed](https://pub.dev/packages/freezed) +或 [json_serializable](https://pub.dev/packages/json_serializable) 等代码生成器来处理 JSON 解码。 +虽然但是，也可以手动完成。 + + +无论如何，这是我们的模型： + + + + +### 创建 provider + + +现在我们有了模型，可以开始创建查询 API。 +为此，我们需要创建我们的第一个 provider。 + + +定义 provider 的语法如下： + + +((ref) { + <你的逻辑写这里> +}); +`} + annotations={[ + { + offset: 6, + length: 4, + label: "provider 的变量", + description: <> + + +此变量将用于与我们的提供者程序进行交互。 +变量必须是 final 和“顶级”（global）。 + + + }, + { + offset: 13, + length: 12, + label: "provider 的类型", + description: <> + + +通常为 `Provider`、`FutureProvider` 或 `StreamProvider`。 +使用提供者程序的类型取决于函数的返回值。 +例如，要创建一个 `Future`，您需要一个 `FutureProvider`。 + + +`FutureProvider` 是你最想用的那个。 + +:::tip + +不要从“我应该选择哪个提供者程序”的角度来思考。 +相反，从“我想返回什么”的角度来思考。 +提供者程序的类型将自然而然地遵循。 +::: + + + }, + { + offset: 25, + length: 13, + label: "修饰符（可选的）", + description: <> + + +通常，在提供者程序的类型之后，您可能会看到一个“修饰符”。 +修饰符是可选的，用于以类型安全的方式调整提供者程序的行为。 + + +目前有两种修饰符可用： + + +- `autoDispose`，这将在提供者程序停止使用时自动清除缓存。 + 另请参阅 +- `family`，这可以将参数传递给提供者程序。 + 另请参阅。 + + + }, + { + offset: 48, + length: 3, + label: "Ref 引用", + description: <> + + +用于与其他 provider 交互的对象。 +所有提供者程序都有一个 `Ref`；要么作为 `provider` 函数的参数，要么作为 `Notifier` 的属性。 + + + }, + { + offset: 57, + length: 17, + label: "provider 函数", + description: <> + + +这就是我们放置提供者程序逻辑的地方。首次读取提供者程序时将调用此函数。 +后续读取不会再次调用该函数，而是返回缓存的值。 + + + }, +]} +/> + + + + +} +`} + annotations={[ + { + offset: 0, + length: 9, + label: "注解", + description: <> + + +所有提供者程序都必须使用 `@riverpod` 或 `@Riverpod()` 进行注释。 +此注释可以放置在全局函数或类上。 +通过此注释，可以配置提供者程序。 + + +例如，我们可以通过编写 `@Riverpod(keepAlive: true)` 来禁用“自动处置”（我们将在后面看到）。 + + + }, + { + offset: 17, + length: 10, + label: "带注解的函数", + description: <> + + +带批注的函数的名称决定了如何与提供者程序进行交互。 +对于给定的函数 `myFunction` ，将生成一个生成的 `myFunctionProvider` 变量。 + + +带注释的函数**必须**指定“ref”作为第一个参数。 +除此之外，该函数可以具有任意数量的参数，包括泛型。 +如果愿意，该函数也可以自由返回 `Future`/`Stream`。 + + +首次读取提供者程序时将调用此函数。 +后续读取不会再次调用该函数，而是返回缓存的值。 + + + }, + { + offset: 28, + length: 17, + label: "Ref", + description: <> + + +用于与其他提供者程序交互的对象。 +所有提供者程序都有一个 `Ref`；要么作为 `provider` 函数的参数，要么作为 `Notifier` 的属性。 +此对象的类型由函数/类的名称确定。 + + + }, +]} +/> + + + +在我们的例子中，我们希望从 API 中 _GET_ 一个活动。 +由于 _GET_ 是异步操作，这意味着我们需要创建一个 `Future`。 + + +因此，使用前面定义的语法，我们可以按如下方式定义提供者程序： + + + + +在此代码片段中，我们定义了一个名为 `activityProvider` 的提供者程序， +我们的 UI 将能够使用该提供者程序来获取随机活动。值得一提的是： + + +- 在 UI 读取提供者程序至少一次之前，不会执行网络请求。 +- 后续读取不会重新执行网络请求，而是返回之前提取的活动。 +- 如果 UI 停止使用此提供者程序，则缓存将被处置。 + 然后，如果 UI 再次使用提供者程序，则会发出新的网络请求。 +- 我们没有捕获错误。这是自动的，因为提供者程序本身会处理错误。 + 如果网络请求或 JSON 解析抛出错误，则 Riverpod 将捕获该错误。 + 然后，UI 将自动包含呈现错误页面所需的信息。 + +:::info + +提供者程序是“懒惰的”。定义提供者程序不会执行网络请求。 +相反，网络请求将在首次读取提供者程序时执行。 +::: + + +### 在 UI 中呈现网络请求的响应 + + +现在我们已经定义了一个提供者程序，我们可以开始在 UI 中使用它来显示活动。 + + +为了与提供者程序交互，我们需要一个名为“ref”的对象。 +您之前可能在提供者程序定义中看到过它，因为提供者程序自然可以访问“ref”对象。 +但在我们的例子中，我们不是提供者程序，而是小部件。那么我们如何获得“ref”呢？ + + +解决方案是使用名为 `Consumer` 的自定义小部件。 +`Consumer` 是一个类似于 `Builder` 的小部件，但还有一个额外的好处，那就是为我们提供了一个“ref”。 +这使我们的 UI 能够读取提供者程序。以下示例展示了如何使用 `Consumer`： + + + + +在该代码段中，我们使用了 `Consumer` 来读取和 `activityProvider` 显示活动。 +我们还优雅地处理了加载/错误状态。 +请注意 UI 如何能够处理加载/错误状态，而无需在提供者程序中执行任何特殊操作。 +同时，如果小部件要重建，则不会正确地重新执行网络请求。 +其他小部件也可以访问同一提供者程序，而无需重新执行网络请求。 + +:::info + +小部件可以根据需要，监听任意数量的提供者程序。为此，只需添加更多 ref.watch 调用即可。 +::: + +:::tip + +确保安装 linter。这将使您的 IDE 能够提供重构选项， +以自动添加 `Consumer` 或将 `StatelessWidget` 重构为 `ConsumerWidget`。 + + +有关安装步骤，请参阅。 +::: + + +## 更进一步：使用 `ConsumerWidget` 替代 `Consumer` 删除代码缩进。 + + +在前面的示例中，我们使用 `Consumer` 来读取提供者程序。 +尽管这种方法没有错，但添加的缩进会使代码更难阅读。 + + +Riverpod 提供了另一种实现相同结果的方法： +我们可以定义 `ConsumerWidget` / `ConsumerStatefulWidget` 来代替在 +`StatelessWidget` / `StatefulWidget` 返回 `Consumer` 小组件。 +`ConsumerWidget` 和 `ConsumerStatefulWidget` 实际上是 `StatelessWidget` / `StatefulWidget` 和 `Consumer` 的融合。 +它们的行为与原来的 couterpart 相同，但具有提供“ref”的额外好处。 + + +我们可以使用 `ConsumerWidget` 重写前面的例子，如下所示： + + + + +至于 `ConsumerStatefulWidget`，我们会这样写： + + + + +### Flutter_hooks 注意事项：结合 `HookWidget` 和 `ConsumerWidget` + +:::caution + +如果您以前从未听说过“钩子（hooks）”，请随时跳过本节。 +[Flutter_hooks](https://pub.dev/packages/flutter_hooks) 是一个独立于 Riverpod 的软件包， +但经常与 Riverpod 一起使用。如果您不熟悉 Riverpod，不建议使用“钩子”。 +有关详细信息，请参阅。 +::: + + +如果您正在使用 `flutter_hooks`，您可能想知道如何将 `ConsumerWidget` +和 `HookWidget` 组合在一起。毕竟，两者都涉及更改扩展的小部件类。 + + +Riverpod 为此问题提供了解决方案：`HookConsumerWidget` 和 `StatefulHookConsumerWidget`。 +类似于 `ConsumerWidget` 和 `ConsumerStatefulWidget` 是 `StatelessWidget` / `StatefulWidget` 和 `Consumer` 融合， +`HookConsumerWidget` 和 `StatefulHookConsumerWidget` 是 `HookWidget` / `HookStatefulWidget` 和 `Consumer` 的融合。 +因此，它们允许在同一个小部件中同时使用钩子和提供者程序。 + + +为了展示这一点，我们可以再次重写前面的例子： + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts new file mode 100644 index 000000000..5cea035c7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/activity.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/activity.dart"; +import codegen from "!!raw-loader!./codegen/activity.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart new file mode 100644 index 000000000..01cdb97f0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.dart @@ -0,0 +1,23 @@ +/* SNIPPET START */ import 'package:freezed_annotation/freezed_annotation.dart'; + +part 'activity.freezed.dart'; +part 'activity.g.dart'; + +/// `GET /api/activity` 请求的响应。 +/// +/// 这个定义使用了 `freezed` 和 `json_serializable`。 +@freezed +class Activity with _$Activity { + factory Activity({ + required String key, + required String activity, + required String type, + required int participants, + required double price, + }) = _Activity; + + /// 将 JSON 对象转换为 [Activity] 实例。 + /// 这可以实现 API 响应的类型安全读取。 + factory Activity.fromJson(Map json) => + _$ActivityFromJson(json); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart new file mode 100644 index 000000000..6ffa343c1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.freezed.dart @@ -0,0 +1,237 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'activity.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Activity _$ActivityFromJson(Map json) { + return _Activity.fromJson(json); +} + +/// @nodoc +mixin _$Activity { + String get key => throw _privateConstructorUsedError; + String get activity => throw _privateConstructorUsedError; + String get type => throw _privateConstructorUsedError; + int get participants => throw _privateConstructorUsedError; + double get price => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ActivityCopyWith get copyWith => + throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ActivityCopyWith<$Res> { + factory $ActivityCopyWith(Activity value, $Res Function(Activity) then) = + _$ActivityCopyWithImpl<$Res, Activity>; + @useResult + $Res call( + {String key, + String activity, + String type, + int participants, + double price}); +} + +/// @nodoc +class _$ActivityCopyWithImpl<$Res, $Val extends Activity> + implements $ActivityCopyWith<$Res> { + _$ActivityCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? key = null, + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_value.copyWith( + key: null == key + ? _value.key + : key // ignore: cast_nullable_to_non_nullable + as String, + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ActivityImplCopyWith<$Res> + implements $ActivityCopyWith<$Res> { + factory _$$ActivityImplCopyWith( + _$ActivityImpl value, $Res Function(_$ActivityImpl) then) = + __$$ActivityImplCopyWithImpl<$Res>; + @override + @useResult + $Res call( + {String key, + String activity, + String type, + int participants, + double price}); +} + +/// @nodoc +class __$$ActivityImplCopyWithImpl<$Res> + extends _$ActivityCopyWithImpl<$Res, _$ActivityImpl> + implements _$$ActivityImplCopyWith<$Res> { + __$$ActivityImplCopyWithImpl( + _$ActivityImpl _value, $Res Function(_$ActivityImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? key = null, + Object? activity = null, + Object? type = null, + Object? participants = null, + Object? price = null, + }) { + return _then(_$ActivityImpl( + key: null == key + ? _value.key + : key // ignore: cast_nullable_to_non_nullable + as String, + activity: null == activity + ? _value.activity + : activity // ignore: cast_nullable_to_non_nullable + as String, + type: null == type + ? _value.type + : type // ignore: cast_nullable_to_non_nullable + as String, + participants: null == participants + ? _value.participants + : participants // ignore: cast_nullable_to_non_nullable + as int, + price: null == price + ? _value.price + : price // ignore: cast_nullable_to_non_nullable + as double, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ActivityImpl implements _Activity { + _$ActivityImpl( + {required this.key, + required this.activity, + required this.type, + required this.participants, + required this.price}); + + factory _$ActivityImpl.fromJson(Map json) => + _$$ActivityImplFromJson(json); + + @override + final String key; + @override + final String activity; + @override + final String type; + @override + final int participants; + @override + final double price; + + @override + String toString() { + return 'Activity(key: $key, activity: $activity, type: $type, participants: $participants, price: $price)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ActivityImpl && + (identical(other.key, key) || other.key == key) && + (identical(other.activity, activity) || + other.activity == activity) && + (identical(other.type, type) || other.type == type) && + (identical(other.participants, participants) || + other.participants == participants) && + (identical(other.price, price) || other.price == price)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => + Object.hash(runtimeType, key, activity, type, participants, price); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + __$$ActivityImplCopyWithImpl<_$ActivityImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ActivityImplToJson( + this, + ); + } +} + +abstract class _Activity implements Activity { + factory _Activity( + {required final String key, + required final String activity, + required final String type, + required final int participants, + required final double price}) = _$ActivityImpl; + + factory _Activity.fromJson(Map json) = + _$ActivityImpl.fromJson; + + @override + String get key; + @override + String get activity; + @override + String get type; + @override + int get participants; + @override + double get price; + @override + @JsonKey(ignore: true) + _$$ActivityImplCopyWith<_$ActivityImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart new file mode 100644 index 000000000..55a7a5383 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/activity.g.dart @@ -0,0 +1,27 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'activity.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ActivityImpl _$$ActivityImplFromJson(Map json) => + _$ActivityImpl( + key: json['key'] as String, + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: (json['price'] as num).toDouble(), + ); + +Map _$$ActivityImplToJson(_$ActivityImpl instance) => + { + 'key': instance.key, + 'activity': instance.activity, + 'type': instance.type, + 'participants': instance.participants, + 'price': instance.price, + }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart new file mode 100644 index 000000000..0f70b54f6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart @@ -0,0 +1,19 @@ +/* SNIPPET START */ import 'dart:convert'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'activity.dart'; + +// 代码生成正常工作的必要条件 +part 'provider.g.dart'; + +/// 这将创建一个名为 `activityProvider` 的提供者程序 +/// 它可以缓存函数执行的结果 +@riverpod +Future activity(ActivityRef ref) async { + // 使用 package:http, 我们可以从 Bored API 获取一个随机的活动。 + final response = await http.get(Uri.https('boredapi.com', '/api/activity')); + // 使用 dart:convert, 然后我们将 JSON 有效负载解码为 Map 数据结构。 + final json = jsonDecode(response.body) as Map; + // 最后，我们将 Map 转换为 Activity 实例。 + return Activity.fromJson(json); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart new file mode 100644 index 000000000..7641f63d3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +/// 这将创建一个名为 `activityProvider` 的提供者程序 +/// 它可以缓存函数执行的结果 +typedef ActivityRef = Ref>; + +/// 这将创建一个名为 `activityProvider` 的提供者程序 +/// 它可以缓存函数执行的结果 +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +/// 这将创建一个名为 `activityProvider` 的提供者程序 +/// 它可以缓存函数执行的结果 +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + /// 这将创建一个名为 `activityProvider` 的提供者程序 + /// 它可以缓存函数执行的结果 + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'636cd5510e09cbfc46f31b74a70d9e98c89e95a4'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts new file mode 100644 index 000000000..a625b7073 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/consumer.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts new file mode 100644 index 000000000..5e6ac973a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_stateful_widget.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/consumer_stateful_widget.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts new file mode 100644 index 000000000..56cb2331d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/consumer_widget.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/consumer_widget.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts new file mode 100644 index 000000000..300ec6596 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/hook_consumer_widget.ts @@ -0,0 +1,8 @@ +import raw from "!!raw-loader!./raw/hook_consumer_widget.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: raw, + hooksCodegen: raw, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss new file mode 100644 index 000000000..bda077971 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/DocuCode.scss @@ -0,0 +1,18 @@ +.legend { + table, + td, + tr { + background: none !important; + border: none; + + vertical-align: top; + } + + td:first-child { + text-align: end; + } + + tr + tr { + border-top: solid 0.5px; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx new file mode 100644 index 000000000..048817ec0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/legend/legend.tsx @@ -0,0 +1,88 @@ +import React from "react"; +import PropTypes from "prop-types"; +import CodeBlock from "@theme/CodeBlock"; +import "./DocuCode.scss"; + +type AnnotatedCode = { + color?: string; + code: string; +}; + +export const colors = [ + "#2196f3", + "#4caf50", + "#f44336", + "#ff9800", + "#009688", + "#e91e63", + "#00bcd4", + "#8bc34a", +]; + +const Legend = ({ annotations, code }) => { + const fullAnnotations = new Array(); + + let annotationOffset = 0; + for (var codeOffset = 0; codeOffset < code.length; ) { + if (annotationOffset >= annotations.length) { + // Out of annotations, just add the rest of the code + fullAnnotations.push({ code: code.substring(codeOffset) }); + break; + } + + const annotation = annotations[annotationOffset]; + if (codeOffset < annotation.offset) { + /// There is an unannotated gap between the last annotation and this one. + const codeLength = annotation.offset - codeOffset; + fullAnnotations.push({ + code: code.substring(codeOffset, codeOffset + codeLength), + }); + codeOffset += codeLength; + } + + if (annotation.offset >= code.length) { + throw new Error("Annotation offset out of bounds"); + } + + annotationOffset++; + codeOffset = annotation.offset + annotation.length; + fullAnnotations.push({ + color: colors[annotationOffset - 1], + code: code.substring( + annotation.offset, + annotation.offset + annotation.length + ), + }); + } + + return ( +
+ 
+        {fullAnnotations.map(({ code, color }) => {
+          let underlineClass = color ? `underline` : "";
+          let style = color ? { color: color } : undefined;
+
+          return (
+            
+              {code}
+            
+          );
+        })}
+
+ + + {annotations.map((annotation, index) => ( + + + + + ))} + +
+ {annotation.label} + {annotation.description}
+
+ ); +}; + +export default Legend; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts new file mode 100644 index 000000000..42ce35bff --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/provider.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/provider.dart"; +import codegen from "!!raw-loader!./codegen/provider.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart new file mode 100644 index 000000000..c37aa2051 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/activity.dart @@ -0,0 +1,28 @@ +/* SNIPPET START */ /// `GET /api/activity` 请求的响应。 +class Activity { + Activity({ + required this.key, + required this.activity, + required this.type, + required this.participants, + required this.price, + }); + + /// 将 JSON 对象转换为 [Activity] 实例。 + /// 这可以实现 API 响应的类型安全读取。 + factory Activity.fromJson(Map json) { + return Activity( + key: json['key'] as String, + activity: json['activity'] as String, + type: json['type'] as String, + participants: json['participants'] as int, + price: json['price'] as double, + ); + } + + final String key; + final String activity; + final String type; + final int participants; + final double price; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart new file mode 100644 index 000000000..97a06178b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer.dart @@ -0,0 +1,39 @@ +// ignore_for_file: omit_local_variable_types + +/* SNIPPET START */ import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/// 我们应用程序主页 +class Home extends StatelessWidget { + const Home({super.key}); + + @override + Widget build(BuildContext context) { + return Consumer( + builder: (context, ref, child) { + // 读取 activityProvider。如果没有准备开始，这将会开始一个网络请求。 + // 通过使用 ref.watch，小组件将会在 activityProvider 更新时重建。 + // 当下面的事情发生时，会更新小组件： + // - 响应从“正在加载”变为“数据/错误” + // - 请求重刷新 + // - 结果被本地修改（例如执行副作用时） + // ... + final AsyncValue activity = ref.watch(activityProvider); + + return Center( + /// 由于网络请求是异步的并且可能会失败，我们需要处理错误和加载的状态。 + /// 我们可以为此使用模式匹配。 + /// 我们也可以使用 `if (activity.isLoading) { ... } else if (...)` + child: switch (activity) { + AsyncData(:final value) => Text('Activity: ${value.activity}'), + AsyncError() => const Text('Oops, something unexpected happened'), + _ => const CircularProgressIndicator(), + }, + ); + }, + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart new file mode 100644 index 000000000..ee427a42a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_stateful_widget.dart @@ -0,0 +1,42 @@ +// ignore_for_file: omit_local_variable_types, prefer_const_constructors, unused_local_variable, todo + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/* SNIPPET START */ // 我们扩展了 ConsumerStatefulWidget。 +// 这等效于 "Consumer" + "StatefulWidget". +class Home extends ConsumerStatefulWidget { + const Home({super.key}); + + @override + ConsumerState createState() => _HomeState(); +} + +// 请注意，我们如何扩展“ConsumerState”而不是“State”。 +// 这和 "ConsumerWidget" 与 "StatelessWidget" 是相同的原理。 +class _HomeState extends ConsumerState { + @override + void initState() { + super.initState(); + + // 状态生命周期也可以访问“ref”。 + // 这使得在特定提供者程序上添加监听器，以便实现显示对话框/信息栏等功能。 + ref.listenManual(activityProvider, (previous, next) { + // TODO 显示一个 snackbar/dialog + }); + } + + @override + Widget build(BuildContext context) { + // "ref" is not passed as parameter anymore, but is instead a property of "ConsumerState". + // We can therefore keep using "ref.watch" inside "build". + // “ref”不再作为参数传递，而是作为“ConsumerState”的属性。 + // 因此，我们可以继续在“build”中使用“ref.watch”。 + final AsyncValue activity = ref.watch(activityProvider); + + return Center(/* ... */); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart new file mode 100644 index 000000000..30d5a232e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/consumer_widget.dart @@ -0,0 +1,23 @@ +// ignore_for_file: omit_local_variable_types, prefer_const_constructors, unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/* SNIPPET START */ /// 我们将“ConsumerWidget”替代“StatelessWidget”进行子类化。 +/// 这相当于使用“StatelessWidget”并返回“Consumer”小组件。 +class Home extends ConsumerWidget { + const Home({super.key}); + + @override + // 请注意“build”现在如何接收一个额外的参数：“ref” + Widget build(BuildContext context, WidgetRef ref) { + // 我们可以像使用“Consumer”一样，在小部件中使用“ref.watch” + final AsyncValue activity = ref.watch(activityProvider); + + // 渲染逻辑保持不变 + return Center(/* ... */); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart new file mode 100644 index 000000000..8f5a8473e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/hook_consumer_widget.dart @@ -0,0 +1,26 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_const_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'activity.dart'; +import 'provider.dart'; + +/* SNIPPET START */ /// 我们子类化了 "HookConsumerWidget"。 +/// 这同时组合了 "StatelessWidget"、"Consumer"、"HookWidget"。 +class Home extends HookConsumerWidget { + const Home({super.key}); + + @override + // 请注意“build”现在如何接收一个额外的参数：“ref” + Widget build(BuildContext context, WidgetRef ref) { + // 可以在我们的小部件中使用诸如“useState”之类的钩子 + final counter = useState(0); + + // 我们还可以使用读取提供者程序 + final AsyncValue activity = ref.watch(activityProvider); + + return Center(/* ... */); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart new file mode 100644 index 000000000..f417a5860 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/raw/provider.dart @@ -0,0 +1,13 @@ +/* SNIPPET START */ import 'dart:convert'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; +import 'activity.dart'; + +final activityProvider = FutureProvider.autoDispose((ref) async { + // 使用 package:http, 我们可以从 Bored API 获取一个随机的活动。 + final response = await http.get(Uri.https('boredapi.com', '/api/activity')); + // 使用 dart:convert, 然后我们将 JSON 有效负载解码为 Map 数据结构。 + final json = jsonDecode(response.body) as Map; + // 最后，我们将 Map 转换为 Activity 实例。 + return Activity.fromJson(json); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx new file mode 100644 index 000000000..0f21cdd8e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args.mdx @@ -0,0 +1,265 @@ +--- +title: 将参数传递给您的请求 +version: 1 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import noArgProvider from "./passing_args/no_arg_provider"; +import family from "!!raw-loader!./passing_args/raw/family.dart"; +import codegenFamily from "!!raw-loader!./passing_args/codegen/family.dart"; +import consumerProvider from "!!raw-loader!./passing_args/raw/consumer_provider.dart"; +import consumerFamily from "!!raw-loader!./passing_args/raw/consumer_family.dart"; +import consumerListFamily from "!!raw-loader!./passing_args/raw/consumer_list_family.dart"; +import multipleConsumerFamily from "!!raw-loader!./passing_args/raw/multiple_consumer_family.dart"; +import tupleFamily from "!!raw-loader!./passing_args/raw/tuple_family.dart"; +import consumerTupleFamily from "!!raw-loader!./passing_args/raw/consumer_tuple_family.dart"; + + +在上一篇文章中，我们看到了如何定义一个“provider”来发出一个简单的 _GET_ HTTP 请求。 +但通常，HTTP 请求依赖于外部参数。 + + +例如，以前我们使用 [Bored API](https://boredapi.com/) 向用户推荐随机活动。 +但也许用户想要过滤他们想做的活动类型，或者有价格要求，等等…… +这些参数事先是未知的。因此，我们需要一种方法将这些参数 +从我们的 UI 传递到我们的提供者程序。 + + +## 更新我们的提供者程序以接受参数 + + +提醒一下，以前我们是这样定义我们的提供者程序的： + + + + + + +当不依赖于代码生成时，我们需要稍微调整定义提供者程序的语法，以支持传递参数。 +这是通过依靠称为“family”的“修饰符”来完成的。 + + +简而言之，我们需要在提供者程序的类型之后添加 `.family` 一个额外的类型参数， +以及与参数类型相对应的类型参数。 +例如，我们可以更新提供者程序以接受与所需活动类型相对应的 String 参数： + + + + + + + + +要将参数传递给我们的提供者程序，我们只需在带注解的函数本身上添加参数即可。 +例如，我们可以更新提供者程序以接受与所需活动类型相对应的 `String` 参数： + + + + + +:::caution + +将参数传递给提供者程序时，强烈建议在提供者程序上启用“autoDispose”。 +否则可能会导致内存泄漏。 +有关详细信息，请参阅。 +::: + + +## 更新我们的 UI 以传递参数 + + +以前，小部件是这样消费我们的提供者程序的： + + + + +但是现在我们的提供者程序收到参数，使用它的语法略有不同。 +提供者程序现在是一个函数，需要使用请求的参数来调用它。 +我们可以更新我们的 UI 以传递硬编码类型的活动，如下所示： + + + + + + +传递给提供者程序的参数对应于带注解的函数的参数，减去“ref”参数。 + + + +:::info + +完全可以同时监听具有不同参数的同一提供者程序。 +例如，我们的 UI 可以同时呈现“娱乐（recreational）”_和_“烹饪（cooking）”活动： + + + + + + +这就是修饰符被称为“family”的原因： +因为把参数传递给提供者程序（译者注：作为不同状态的区分的 key 值）， +可以有效地将提供者程序转换为一组具有相同逻辑的状态。 + + +::: + + +## 缓存注意事项和参数限制 + + +将参数传递给提供者程序时，仍会缓存计算。 +不同之处在于，计算现在是按参数缓存的。 + + +这意味着，如果两个小部件使用具有相同参数的同一提供者程序，则只会发出单个网络请求。 +但是，如果两个小部件使用具有不同参数的同一提供者程序，则将发出两个网络请求。 + + +为此，Riverpod 依赖于参数的 `==` 运算符。 +因此，传递给提供者程序的参数必须具有一致的相等性，这一点很重要。 + +:::caution + +一个常见的错误是直接实例化一个新对象作为提供者程序的参数，但该对象没有重写 `==`。 +例如，您可能很想去这样使用 `List`： + + + + +此代码的问题在于 `['recreational', 'cooking'] == ['recreational', 'cooking']` 的结果是 `false`。 +因此，Riverpod 将认为这两个参数不同，并尝试发出新的网络请求。 +这将导致网络请求的无限循环，一直向用户显示进度指示器。 + + +要解决此问题，您可以使用 `const` 列表 (`const ['recreational', 'cooking']`) +或使用重写了 `==` 的自定义列表实现。 + + +为了帮助发现此错误，建议使用 [riverpod_lint](https://pub.dev/packages/riverpod_lint) +并启用 [provider_parameters](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint#provider_parameters) +的 lint 规则。这样做之后，上面的代码片段将显示警告。 +有关安装步骤，请参阅。 +::: + + + + +考虑到这一点，您可能想知道如何将多个参数传递给提供者程序。 +建议的解决方案是： + + +- 切换到代码生成，这样可以传递任意数量的参数 +- 使用 Dart 3 的记录 (record) 语法 + + +Dart 3 的记录之所以派上用场，是因为它们自然覆盖 `==` 并具有方便的语法。 +例如，我们可以更新我们的提供者程序，以同时接受一种活动类型和最高价格： + + + + +然后，我们可以像这样消费这个提供者程序： + + + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart new file mode 100644 index 000000000..7d5c4c260 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart @@ -0,0 +1,29 @@ +import 'dart:convert'; +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import '../../first_request/codegen/activity.dart'; + +part 'family.g.dart'; + +/* SNIPPET START */ +@riverpod +Future activity( + ActivityRef ref, + // 我们可以向提供者程序添加参数。 + // 参数的类型可以是您想要的任何类型。 + String activityType, +) async { + // 我们可以使用“activityType”参数来构建 URL。 + // 这将指向 "https://boredapi.com/api/activity?type=" + final response = await http.get( + Uri( + scheme: 'https', + host: 'boredapi.com', + path: '/api/activity', + // 无需手动编码查询参数，“Uri”类为我们完成了这一工作。 + queryParameters: {'type': activityType}, + ), + ); + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart new file mode 100644 index 000000000..b63a6db32 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.g.dart @@ -0,0 +1,138 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityFamily._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {required ActivityFamily super.from, + required String super.argument, + FutureOr Function( + ActivityRef ref, + String activityType, + )? create}) + : _createCb = create, + super( + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + String activityType, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @override + String toString() { + return r'activityProvider' + '' + '($argument)'; + } + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._( + argument: argument as String, + from: from! as ActivityFamily, + create: ( + ref, + String activityType, + ) => + create(ref)); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + final argument = this.argument as String; + return _$cb( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is ActivityProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$activityHash() => r'cb76e67cd45f1823d3ed497a235be53819ce2eaf'; + +final class ActivityFamily extends Family { + const ActivityFamily._() + : super( + name: r'activityProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + ActivityProvider call( + String activityType, + ) => + ActivityProvider._(argument: activityType, from: this); + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @override + String toString() => r'activityProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr Function( + ActivityRef ref, + String args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ActivityProvider; + + final argument = provider.argument as String; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart new file mode 100644 index 000000000..d2cd2b635 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart @@ -0,0 +1,32 @@ +// ignore_for_file: avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import '../../first_request/codegen/activity.dart'; + +// Necessary for code-generation to work +part 'provider.g.dart'; + +FutureOr fetchActivity() => throw UnimplementedError(); + +/* SNIPPET START */ +// “函数型”提供者程序 +@riverpod +Future activity(ActivityRef ref) async { + // TODO: 执行网络请求以获取活动 + return fetchActivity(); +} + +// 或者替代方案，“通知者程序” +@riverpod +class ActivityNotifier2 extends _$ActivityNotifier2 { + /// 通知者程序参数在构建方法上指定。 + /// 可以有任意数量的通知者程序参数，可以是任意的变量名称，甚至可以是可选/命名的参数。 + @override + Future build(String activityType) async { + // 参数也可通过 "this." 使用 + print(this.activityType); + + // TODO: 执行网络请求以获取活动 + return fetchActivity(); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart new file mode 100644 index 000000000..04b627967 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.g.dart @@ -0,0 +1,220 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ActivityRef = Ref>; + +@ProviderFor(activity) +const activityProvider = ActivityProvider._(); + +final class ActivityProvider extends $FunctionalProvider, + FutureOr, ActivityRef> + with $FutureModifier, $FutureProvider { + const ActivityProvider._( + {FutureOr Function( + ActivityRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'activityProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ActivityRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityHash(); + + @$internal + @override + $FutureProviderElement $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ActivityProvider $copyWithCreate( + FutureOr Function( + ActivityRef ref, + ) create, + ) { + return ActivityProvider._(create: create); + } + + @override + FutureOr create(ActivityRef ref) { + final _$cb = _createCb ?? activity; + return _$cb(ref); + } +} + +String _$activityHash() => r'2f9496c5d70de9314c67e5c48ac44d8b149bc471'; + +@ProviderFor(ActivityNotifier2) +const activityNotifier2Provider = ActivityNotifier2Family._(); + +final class ActivityNotifier2Provider + extends $AsyncNotifierProvider { + const ActivityNotifier2Provider._( + {required ActivityNotifier2Family super.from, + required String super.argument, + super.runNotifierBuildOverride, + ActivityNotifier2 Function()? create}) + : _createCb = create, + super( + name: r'activityNotifier2Provider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ActivityNotifier2 Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$activityNotifier2Hash(); + + @override + String toString() { + return r'activityNotifier2Provider' + '' + '($argument)'; + } + + @$internal + @override + ActivityNotifier2 create() => _createCb?.call() ?? ActivityNotifier2(); + + @$internal + @override + ActivityNotifier2Provider $copyWithCreate( + ActivityNotifier2 Function() create, + ) { + return ActivityNotifier2Provider._( + argument: argument as String, + from: from! as ActivityNotifier2Family, + create: create); + } + + @$internal + @override + ActivityNotifier2Provider $copyWithBuild( + FutureOr Function( + Ref>, + ActivityNotifier2, + ) build, + ) { + return ActivityNotifier2Provider._( + argument: argument as String, + from: from! as ActivityNotifier2Family, + runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is ActivityNotifier2Provider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$activityNotifier2Hash() => r'9e67c655d53a9f98c3b012a0534421385dde0339'; + +final class ActivityNotifier2Family extends Family { + const ActivityNotifier2Family._() + : super( + name: r'activityNotifier2Provider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + ActivityNotifier2Provider call( + String activityType, + ) => + ActivityNotifier2Provider._(argument: activityType, from: this); + + @override + String debugGetCreateSourceHash() => _$activityNotifier2Hash(); + + @override + String toString() => r'activityNotifier2Provider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + ActivityNotifier2 Function( + String args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ActivityNotifier2Provider; + + final argument = provider.argument as String; + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + FutureOr Function(Ref> ref, + ActivityNotifier2 notifier, String argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ActivityNotifier2Provider; + + final argument = provider.argument as String; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(container); + }, + ); + } +} + +abstract class _$ActivityNotifier2 extends $AsyncNotifier { + late final _$args = + (ref as $AsyncNotifierProviderElement).origin.argument as String; + String get activityType => _$args; + + FutureOr build( + String activityType, + ); + @$internal + @override + FutureOr runBuild() => build( + _$args, + ); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts new file mode 100644 index 000000000..42ce35bff --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/no_arg_provider.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/provider.dart"; +import codegen from "!!raw-loader!./codegen/provider.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart new file mode 100644 index 000000000..96c6fcec7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_family.dart @@ -0,0 +1,24 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../../first_request/raw/activity.dart'; +import 'family.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + AsyncValue activity = ref.watch( + // 提供者程序现在是一个需要活动类型的函数。 + // 为了简单起见，我们现在传递一个常量字符串。 + activityProvider('recreational'), + ); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart new file mode 100644 index 000000000..ee864ae6e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_list_family.dart @@ -0,0 +1,23 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals, provider_parameters + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +final activityProvider = Provider.family((ref, id) { + throw UnimplementedError(); +}); + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + // 我们可以更新 ActivityProvider 接受字符串列表以替换之前的代码。 + // 然后尝试直接在 watch 调用中创建该列表。 + ref.watch(activityProvider(['recreational', 'cooking'])); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart new file mode 100644 index 000000000..337eab2d1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_provider.dart @@ -0,0 +1,20 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../../first_request/raw/activity.dart'; +import 'provider.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + AsyncValue activity = ref.watch(activityProvider); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart new file mode 100644 index 000000000..b63149bde --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/consumer_tuple_family.dart @@ -0,0 +1,23 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'tuple_family.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { +/* SNIPPET START */ + ref.watch( + // 使用记录，我们可以传递参数。 + // 在 watch 调用中，可以实现直接创建带有覆盖 == 功能的记录。 + activityProvider((type: 'recreational', maxPrice: 40)), + ); +/* SNIPPET END */ + + return Container(); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart new file mode 100644 index 000000000..21f643dbd --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/family.dart @@ -0,0 +1,41 @@ +// ignore_for_file: unnecessary_this, avoid_print + +import 'dart:async'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import '../../first_request/raw/activity.dart'; + +FutureOr fetchActivity(String activityType) => + throw UnimplementedError(); + +/* SNIPPET START */ +// “函数型”提供者 +final activityProvider = FutureProvider.autoDispose + // 我们使用 ".family" 修饰符。 + // 泛型类型 "String" 对应于参数的类型。 + // 我们的提供者程序现在在 "ref" 上收到一个额外的参数：activity 的类型。 + .family((ref, activityType) async { + // TODO: 使用 "activityType" 执行网络请求以获取活动 + return fetchActivity(activityType); +}); + +// “通知者程序”的提供者 +final activityProvider2 = AsyncNotifierProvider.autoDispose + // 再次，我们使用 ".family" 修饰符，并将参数指定为 "String" 类型。 + .family( + ActivityNotifier.new, +); + +// 当将 ".family" 与通知者程序一起使用时，我们需要更改通知者程序子类： +// AsyncNotifier -> FamilyAsyncNotifier +// AsyncNotifier -> FamilyAsyncNotifier +class ActivityNotifier extends FamilyAsyncNotifier { + /// Family 参数传递给构建方法并可通过 this.arg 访问 + @override + Future build(String activityType) async { + // 参数也可通过 "this.arg" 使用 + print(this.arg); + + // TODO: 执行网络请求以获取活动 + return fetchActivity(activityType); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart new file mode 100644 index 000000000..68c9620db --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/multiple_consumer_family.dart @@ -0,0 +1,37 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../../first_request/raw/activity.dart'; +import 'family.dart'; + +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + AsyncValue activity = ref.watch( + // The provider is now a function expecting the activity type. + // Let's pass a constant string for now, for the sake of simplicity. + activityProvider('recreational'), + ); + /* SNIPPET START */ + return Consumer( + builder: (context, ref, child) { + final recreational = ref.watch(activityProvider('recreational')); + final cooking = ref.watch(activityProvider('cooking')); + + // 然后我们可以同时渲染这两个活动。 + // 两个请求将并行发生并正确缓存。 + return Column( + children: [ + Text(recreational.valueOrNull?.activity ?? ''), + Text(cooking.valueOrNull?.activity ?? ''), + ], + ); + }, + ); + /* SNIPPET END */ + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart new file mode 100644 index 000000000..0c4806b47 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/provider.dart @@ -0,0 +1,26 @@ +import 'dart:async'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import '../../first_request/raw/activity.dart'; + +/* SNIPPET START */ + +FutureOr fetchActivity() => throw UnimplementedError(); + +// “函数型”提供者程序 +final activityProvider = FutureProvider.autoDispose((ref) async { + // TODO: 执行网络请求以获取活动 + return fetchActivity(); +}); + +// 或者替代方案，“通知者程序” +final activityProvider2 = AsyncNotifierProvider( + ActivityNotifier.new, +); + +class ActivityNotifier extends AsyncNotifier { + @override + Future build() async { + // TODO: 执行网络请求以获取活动 + return fetchActivity(); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart new file mode 100644 index 000000000..aa9b4476a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/raw/tuple_family.dart @@ -0,0 +1,32 @@ +// ignore_for_file: omit_local_variable_types, unused_local_variable, prefer_final_locals + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import '../../first_request/raw/activity.dart'; + +/* SNIPPET START */ +// 我们定义一条记录，表示我们想要传递给提供者程序的参数。 +// 创建 typedef 是可选的，但可以使代码更具可读性。 +typedef ActivityParameters = ({String type, int maxPrice}); + +final activityProvider = FutureProvider.autoDispose + // 我们现在使用新定义的记录作为参数类型。 + .family((ref, arguments) async { + final response = await http.get( + Uri( + scheme: 'https', + host: 'boredapi.com', + path: '/api/activity', + queryParameters: { + // 最后，我们可以使用参数来更新请求的查询参数。 + 'type': arguments.type, + 'price': arguments.maxPrice, + }, + ), + ); + final json = jsonDecode(response.body) as Map; + return Activity.fromJson(json); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx new file mode 100644 index 000000000..ff240d37f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer.mdx @@ -0,0 +1,79 @@ +--- +title: 日志和错误报告 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import providerObserver from "!!raw-loader!./provider_observer/provider_observer.dart"; + + +Riverpod 本身提供了一种监听提供者程序树中发生的所有事件的方法。 +这可用于记录所有事件，或向远程服务报告错误。 + + +这是通过使用 `ProviderObserver` 类并将其传递给 +`ProviderScope`/`ProviderContainer` 来实现的。 + + +## 定义 ProviderObserver ​ + + +ProviderObserver 是一个应该被扩展的类。 +它提供了各种可以重写的方法来监听事件： + + +- `didAddProvider`，当提供者程序被添加到组件树时调用 +- `didUpdateProvider`，当提供者程序更新时调用 +- `didDisposeProvider`，当提供者程序被处置时调用 +- `providerDidFail`，当同步的提供者程序抛出错误时 + + + + +## 使用 ProviderObserver​ + + +现在我们已经定义了观察者，我们需要使用它。 +为此，我们应该将其传递给 `ProviderScope` 或 `ProviderContainer` ： + +```dart +runApp( + ProviderScope( + observers: [ + MyObserver(), + ], + child: MyApp(), + ) +); +``` + +```dart +final container = ProviderContainer( + observers: [ + MyObserver(), + ], +); +``` diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart new file mode 100644 index 000000000..dd75afb01 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/provider_observer/provider_observer.dart @@ -0,0 +1,43 @@ +// ignore_for_file: avoid_print + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class MyObserver extends ProviderObserver { + @override + void didAddProvider( + ProviderBase provider, + Object? value, + ProviderContainer container, + ) { + print('Provider $provider was initialized with $value'); + } + + @override + void didDisposeProvider( + ProviderBase provider, + ProviderContainer container, + ) { + print('Provider $provider was disposed'); + } + + @override + void didUpdateProvider( + ProviderBase provider, + Object? previousValue, + Object? newValue, + ProviderContainer container, + ) { + print('Provider $provider updated from $previousValue to $newValue'); + } + + @override + void providerDidFail( + ProviderBase provider, + Object error, + StackTrace stackTrace, + ProviderContainer container, + ) { + print('Provider $provider threw $error at $stackTrace'); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx new file mode 100644 index 000000000..9f76dcae9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects.mdx @@ -0,0 +1,668 @@ +--- +title: 执行副作用 +version: 1 +--- + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import Legend, { colors } from "./first_request/legend/legend"; +import todoListProvider from "./side_effects/todo_list_provider"; +import todoListNotifier from "./side_effects/todo_list_notifier"; +import todoListNotifierAddTodo from "./side_effects/todo_list_notifier_add_todo"; +import consumerAddTodoCall from "!!raw-loader!./side_effects/raw/consumer_add_todo_call.dart"; +import restAddTodo from "!!raw-loader!./side_effects/raw/rest_add_todo.dart"; +import invalidateSelfAddTodo from "!!raw-loader!./side_effects/raw/invalidate_self_add_todo.dart"; +import manualAddTodo from "!!raw-loader!./side_effects/raw/manual_add_todo.dart"; +import mutableManualAddTodo from "!!raw-loader!./side_effects/raw/mutable_manual_add_todo.dart"; +import renderAddTodo from "./side_effects/render_add_todo"; + + +到目前为止，我们只看到了如何获取数据（也就是执行 _GET_ HTTP 请求）。 +但是副作用（例如 _POST_ 请求）呢？ + + +应用程序通常实现 CRUD（创建、读取、更新、删除）API。 +执行此操作时，更新请求（通常是 _POST_）通常还应更新本地缓存，以使 UI 反映新状态。 + + +问题是，我们如何从消费者程序内部更新提供者程序的状态？ +理所当然的，提供者程序不会公开修改其状态的方法。 +这是设计使然，以确保仅以受控方式修改状态并促进关注点分离。 +相反，提供者程序必须显式公开修改其状态的方法。 + + +为此，我们将使用一个新概念：通知者程序（Notifiers）。 +为了展示这个新概念，让我们使用一个更高级的例子：待办事项列表。 + + +## 定义通知者程序 + + +让我们从此时我们已经知道的内容开始：一个简单的 GET 请求。 +正如之前在中看到的那样， +我们可以通过编写以下内容来获取待办事项列表： + + + + +现在我们已经获取了待办事项列表，让我们看看如何添加新的待办事项。 +为此，我们需要修改我们的提供者程序，以便它们公开一个公共 API 来修改其状态。 +这是通过将我们的提供者程序转换为我们所说的“通知者程序”来完成的。 + + +通知者程序是提供者程序的“有状态小部件”。它们需要对定义提供者程序的语法稍作调整。 +此新语法如下： + + +(MyNotifier.new); + +class MyNotifier extends SomeNotifier { + @override + Result build() { + <你的业务逻辑在这里> + } + + <你的方法在这里> +}`} + annotations={[ + { + offset: 6, + length: 4, + label: "提供者程序变量", + description: <> + + +此变量将用于与我们的提供者程序进行交互。 +变量必须是 final 和“顶级”（全局）。 + + + }, + { + offset: 13, + length: 20, + label: "提供者程序类型", + description: <> + + +通常为 `NotifierProvider`、`AsyncNotifierProvider` 和 `StreamNotifierProvider`。 +使用的提供者程序类型取决于函数的返回值。 +例如，要创建一个 `Future` ，您需要一个 `AsyncNotifierProvider`。 + + +`AsyncNotifierProvider` 是你最想用的那个。 + +:::tip + +不要从“我应该选择哪个提供者程序”的角度来思考。 +相反，从“我想返回什么”的角度来思考。提供者程序类型将自然而然地遵循。 +::: + + + }, + { + offset: 33, + length: 13, + label: "修饰符（可选的）", + description: <> + + +通常，在提供者程序的类型之后，您可能会看到一个“修饰符”。 +修饰符是可选的，用于以类型安全的方式调整提供者程序的行为。 + + +目前有两种修饰符可用： + + +- `autoDispose`，这将在提供者程序停止使用时自动清除缓存。 + 另请参阅 +- `family`，这样就可以将参数传递给提供者程序。 + 另请参阅 + + + }, + { + offset: 67, + length: 14, + label: "通知者程序的构造函数", + description: <> + + +“notifier providers”的参数是一个函数，它应该实例化“notifier”。 +它通常应该是“构造函数撕裂”。 + + + }, + { + offset: 86, + length: 16, + label: "通知者程序", + description: <> + + +如果 `NotifierProvider` 是 “StatefulWidget” 类，则此部分就是该 `State` 类。 + + +此类负责公开修改提供者程序状态的方法。 +使用者可以使用 `ref.read(yourProvider.notifier).yourMethod()` 此类上的公共方法。 + +:::note + +除了内置的 `state` 之外，通知者程序不应具有公共属性，因为 UI 无法知道状态已更改。 +::: + + + }, + { + offset: 111, + length: 12, + label: "通知者程序类型", + description: <> + + +通知者程序扩展的基类应与提供者程序 + 修饰符的基类匹配。一些例子是： + +- NotifierProvider -> Notifier +- AsyncNotifierProvider -> AsyncNotifier +- AsyncNotifierProvider. + autoDispose -> + AutoDispose + + AsyncNotifier +- AsyncNotifierProvider. + autoDispose. + family + -> AutoDispose + Family + AsyncNotifier + + +为了简化此操作，建议使用代码生成器，因为它会自动推断正确的类型。 + + + }, + { + offset: 136, + length: 54, + label: "build 方法", + description: <> + + +所有通知者程序都必须重写该 `build` 方法。 +此方法等效于通常将逻辑放在非通知者程序提供者程序中的位置。 + + +不应直接调用此方法。 + + + }, +]} +/> + + + + + + + } + + <你的方法在这里> +}`} + annotations={[ + { + offset: 0, + length: 9, + label: "注解", + description: <> + + +所有提供者程序都必须使用 `@riverpod` 或 `@Riverpod()` 进行注解。 +此注解可以放置在全局函数或类上。 +通过此注解，可以配置提供者程序。 + + +例如，我们可以通过编写 `@Riverpod(keepAlive: true)` 来禁用“自动处置”（我们将在后面看到）。 + + + }, + { + offset: 10, + length: 16, + label: "通知者程序", + description: <> + + +当 `@riverpod` 注解被放置在一个类上时，该类被称为“通知者程序”。 +类必须扩展 `_$NotifierName` ，其中 `NotifierName` 是类名。 + + +通知者程序负责公开修改提供者程序状态的方法。 +使用者可以使用 `ref.read(yourProvider.notifier).yourMethod()` 此类上的公共方法。 + +:::note + +除了内置的 `state` 之外，通知者程序不应具有公共属性，因为 UI 无法知道状态已更改。 +::: + + + }, + { + offset: 52, + length: 54, + label: "build 方法", + description: <> + + +所有通知者程序都必须重写该 `build` 方法。 +此方法等效于通常将逻辑放在非通知者程序提供者程序中的位置。 + + +不应直接调用此方法。 + + + }, +]} +/> + + + +作为参考，您可能需要查看，将这里的新语法与之前看到的语法进行比较。 + +:::info + +除了 `build` 以外，没有其他方法的通知者程序与使用前面看到的语法相同。 +中显示的语法可以被视为通知者程序的简写，无法从 UI 进行修改。 +::: + + +现在我们已经了解了语法，让我们看看如何将之前定义的提供者程序转换为通知者程序： + + + + +请注意，在小部件中读取提供者程序的方式保持不变。 +您仍然可以像以前的语法一样使用 `ref.watch(todoListProvider)`。 + +:::caution + +不要将逻辑放在通知者程序的构造函数中。 +通知者程序不应具有构造函数，因为 `ref` 此时其他属性尚不可用。 +相反，将您的逻辑放在方法中 `build`。 + +```dart +class MyNotifier extends ... { + MyNotifier() { + // ❌ 别这样做 + // 这将会抛出一个异常 + state = AsyncValue.data(42); + } + + @override + Result build() { + // ✅ 应该这样做 + state = AsyncValue.data(42); + } +} +``` + +::: + + +## 公开用于执行 _POST_ 请求的方法 + + +现在我们有了通知者程序，我们可以开始添加方法来执行副作用。 +其中一个副作用是让客户端 _POST_ 一个新的待办事项。 +我们可以通过在通知者程序上添加一个 `addTodo` 方法来做到这一点： + + + + +然后，我们可以在 UI 中使用我们在中看到的相同 `Consumer`/`ConsumerWidget` 调用此方法： + + + +:::info + +请注意我们如何使用 `ref.read` 而不是调用 `ref.watch` 的方法。 +虽然在技术上可以工作，但 `ref.watch` 建议在事件处理（如“onPressed”）中执行逻辑时使用 `ref.read`。 +::: + + +我们现在有一个按钮，按下时会发出 _POST_ 请求。 +但是，目前，我们的 UI 不会更新以返回新的待办事项列表。 +我们希望本地缓存与服务器的状态相匹配。 + + +有几种方法可以做到这一点，下面说说优点和缺点。 + + +### 更新本地缓存以匹配 API 响应 + + +一种常见的后端做法是让 _POST_ 请求返回资源的新状态。 +特别是，我们的 API 将在添加新的待办事项后返回新的待办事项列表。 +一种方法是编写 `state = AsyncData(response)`： + + + +:::tip 优点 + + +- UI 将尽可能具有最新状态。如果其他用户添加了待办事项，我们也会看到它。 +- 服务器是事实的来源。使用这种方法，客户端不需要知道需要在列表的哪个位置插入新的待办事项。 +- 只需要一个网络请求。 + +::: + +:::danger 缺点 + + +- 仅当服务器以特定方式实现时，此方法才有效。如果服务器不返回新状态，则此方法将不起作用。 +- 如果关联的 _GET_ 请求更复杂，例如如果它具有过滤/排序的功能，则可能仍然不可行。 + +::: + + +### 使用 `ref.invalidateSelf()` 刷新提供者程序。 + + +一种选择是让我们的提供者程序重新执行 _GET_ 请求。 +这可以通过在 _POST_ 请求之后调用 `ref.invalidateSelf()` 来完成： + + + +:::tip 优点 + + +- UI 将尽可能具有最新状态。如果其他用户添加了待办事项，我们也会看到它。 +- 服务器是事实的来源。使用这种方法，客户端不需要知道需要在列表的哪个位置插入新的待办事项。 +- 无论服务器实现如何，此方法都应该有效。如果您的 _GET_ 请求更复杂，例如它具有过滤器/排序，则它可能特别有用。 + +::: + +:::danger 缺点 + + +- 此方法将执行额外的 _GET_ 请求，这可能效率低下。 + +::: + + +### 手动更新本地缓存 + + +另一种选择是手动更新本地缓存。 +这将涉及尝试模仿后端的行为。例如，我们需要知道后端是在开头还是结尾插入新项目。 + + + +:::info + +此示例使用不可变状态。这不是必需的，但建议这样做。 +有关更多详细信息，请参阅。 +如果要改用可变状态，也可以执行以下操作： + + + +::: + +:::tip 优点 + + +- 无论服务器实现如何，此方法都应该有效。 +- 只需要一个网络请求。 + +::: + +:::danger 缺点 + + +- 本地缓存可能与服务器的状态不匹配。如果其他用户添加了待办事项，我们将看不到它。 +- 这种方法的实现和有效地复制后端的逻辑可能更复杂。 + +::: + + +## 更进一步：显示下拉加载器和错误处理 + + +到目前为止我们所看到的一切，我们有一个按钮，当按下时会发出 _POST_ 请求; +请求完成后，UI 会更新以反映更改。 +但目前，没有迹象表明请求正在执行，如果失败，也没有任何信息。 + + +一种方法是将返回 `addTodo` 的异步结果存储在本地小部件状态中， +然后监听该异步状态以显示下拉加载器或错误消息。 +这时[flutter_hooks](https://pub.dev/packages/flutter_hooks)派上用场的一种情况。 +但是，当然，您也可以使用 `StatefulWidget` 代替。 + + +以下代码片段显示了当处于加载状态时，进度指示器和操作处于挂起状态。 +如果失败，则将按钮呈现为红色： + +![A button which turns red when the operation failed](/img/essentials/side_effects/spinner.gif) + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart new file mode 100644 index 000000000..901cd926e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.dart @@ -0,0 +1,28 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo_list_notifier.freezed.dart'; +part 'todo_list_notifier.g.dart'; + +@freezed +class Todo with _$Todo { + factory Todo({ + required String description, + @Default(false) bool completed, + }) = _Todo; + + factory Todo.fromJson(Map json) => _$TodoFromJson(json); +} + +/* SNIPPET START */ +@riverpod +class TodoList extends _$TodoList { + @override + Future> build() async { + // 我们之前在 FutureProvider 中的业务逻辑现在位于 build 方法中。 + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart new file mode 100644 index 000000000..3326f9ffa --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.freezed.dart @@ -0,0 +1,166 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'todo_list_notifier.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Todo _$TodoFromJson(Map json) { + return _Todo.fromJson(json); +} + +/// @nodoc +mixin _$Todo { + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$TodoImpl implements _Todo { + _$TodoImpl({required this.description, this.completed = false}); + + factory _$TodoImpl.fromJson(Map json) => + _$$TodoImplFromJson(json); + + @override + final String description; + @override + @JsonKey() + final bool completed; + + @override + String toString() { + return 'Todo(description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); + + @override + Map toJson() { + return _$$TodoImplToJson( + this, + ); + } +} + +abstract class _Todo implements Todo { + factory _Todo({required final String description, final bool completed}) = + _$TodoImpl; + + factory _Todo.fromJson(Map json) = _$TodoImpl.fromJson; + + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart new file mode 100644 index 000000000..81218695d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -0,0 +1,89 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_notifier.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$TodoImpl _$$TodoImplFromJson(Map json) => _$TodoImpl( + description: json['description'] as String, + completed: json['completed'] as bool? ?? false, + ); + +Map _$$TodoImplToJson(_$TodoImpl instance) => + { + 'description': instance.description, + 'completed': instance.completed, + }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(TodoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider + extends $AsyncNotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$todoListHash() => r'c939d438b07da6065dbbcfab86c27ef363bdb76c'; + +abstract class _$TodoList extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart new file mode 100644 index 000000000..0d6a9a7bd --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.dart @@ -0,0 +1,26 @@ +// ignore_for_file: avoid_print + +import 'dart:convert'; + +import 'package:http/http.dart' as http; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import 'todo_list_notifier.dart'; + +part 'todo_list_notifier_add_todo.g.dart'; + +/* SNIPPET START */ +@riverpod +class TodoList extends _$TodoList { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + await http.post( + Uri.https('your_api.com', '/todos'), + // 我们序列化 Todo 对象并将其 POST 到服务器。 + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart new file mode 100644 index 000000000..19c5471ad --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_notifier_add_todo.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(TodoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider + extends $AsyncNotifierProvider> { + const TodoListProvider._( + {super.runNotifierBuildOverride, TodoList Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TodoList Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + @$internal + @override + TodoList create() => _createCb?.call() ?? TodoList(); + + @$internal + @override + TodoListProvider $copyWithCreate( + TodoList Function() create, + ) { + return TodoListProvider._(create: create); + } + + @$internal + @override + TodoListProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + TodoList, + ) build, + ) { + return TodoListProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$todoListHash() => r'4008395aaca8f55312f668c0b2a32e7599f82349'; + +abstract class _$TodoList extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart new file mode 100644 index 000000000..88eb06c0e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart @@ -0,0 +1,23 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'todo_list_provider.freezed.dart'; +part 'todo_list_provider.g.dart'; + +/* SNIPPET START */ +@freezed +class Todo with _$Todo { + factory Todo({ + required String description, + @Default(false) bool completed, + }) = _Todo; +} + +@riverpod +Future> todoList(TodoListRef ref) async { + // 模拟一个网络请求。这通常来自真实的 API + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart new file mode 100644 index 000000000..26a2d640c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.freezed.dart @@ -0,0 +1,148 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'todo_list_provider.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +/// @nodoc +mixin _$Todo { + String get description => throw _privateConstructorUsedError; + bool get completed => throw _privateConstructorUsedError; + + @JsonKey(ignore: true) + $TodoCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $TodoCopyWith<$Res> { + factory $TodoCopyWith(Todo value, $Res Function(Todo) then) = + _$TodoCopyWithImpl<$Res, Todo>; + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class _$TodoCopyWithImpl<$Res, $Val extends Todo> + implements $TodoCopyWith<$Res> { + _$TodoCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_value.copyWith( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$TodoImplCopyWith<$Res> implements $TodoCopyWith<$Res> { + factory _$$TodoImplCopyWith( + _$TodoImpl value, $Res Function(_$TodoImpl) then) = + __$$TodoImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({String description, bool completed}); +} + +/// @nodoc +class __$$TodoImplCopyWithImpl<$Res> + extends _$TodoCopyWithImpl<$Res, _$TodoImpl> + implements _$$TodoImplCopyWith<$Res> { + __$$TodoImplCopyWithImpl(_$TodoImpl _value, $Res Function(_$TodoImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? description = null, + Object? completed = null, + }) { + return _then(_$TodoImpl( + description: null == description + ? _value.description + : description // ignore: cast_nullable_to_non_nullable + as String, + completed: null == completed + ? _value.completed + : completed // ignore: cast_nullable_to_non_nullable + as bool, + )); + } +} + +/// @nodoc + +class _$TodoImpl implements _Todo { + _$TodoImpl({required this.description, this.completed = false}); + + @override + final String description; + @override + @JsonKey() + final bool completed; + + @override + String toString() { + return 'Todo(description: $description, completed: $completed)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$TodoImpl && + (identical(other.description, description) || + other.description == description) && + (identical(other.completed, completed) || + other.completed == completed)); + } + + @override + int get hashCode => Object.hash(runtimeType, description, completed); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + __$$TodoImplCopyWithImpl<_$TodoImpl>(this, _$identity); +} + +abstract class _Todo implements Todo { + factory _Todo({required final String description, final bool completed}) = + _$TodoImpl; + + @override + String get description; + @override + bool get completed; + @override + @JsonKey(ignore: true) + _$$TodoImplCopyWith<_$TodoImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart new file mode 100644 index 000000000..c890d03c6 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -0,0 +1,66 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'todo_list_provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef TodoListRef = Ref>>; + +@ProviderFor(todoList) +const todoListProvider = TodoListProvider._(); + +final class TodoListProvider extends $FunctionalProvider>, + FutureOr>, TodoListRef> + with $FutureModifier>, $FutureProvider, TodoListRef> { + const TodoListProvider._( + {FutureOr> Function( + TodoListRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'todoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + TodoListRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$todoListHash(); + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + TodoListProvider $copyWithCreate( + FutureOr> Function( + TodoListRef ref, + ) create, + ) { + return TodoListProvider._(create: create); + } + + @override + FutureOr> create(TodoListRef ref) { + final _$cb = _createCb ?? todoList; + return _$cb(ref); + } +} + +String _$todoListHash() => r'26b30307668c8feefa7cbe3c400b73e6edccbc39'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart new file mode 100644 index 000000000..133545651 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/consumer_add_todo_call.dart @@ -0,0 +1,25 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import '../raw/todo_list_notifier.dart' show Todo; +import '../raw/todo_list_notifier_add_todo.dart'; + +/* SNIPPET START */ +class Example extends ConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return ElevatedButton( + onPressed: () { + // 使用“ref.read”与“myProvider.notifier”结合， + // 我们可以获得通知者程序的类实例。 + // 这使我们能够调用“addTodo”方法。 + ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + }, + child: const Text('Add todo'), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart new file mode 100644 index 000000000..264869bbf --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/invalidate_self_add_todo.dart @@ -0,0 +1,38 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // 我们不关心 API 响应 + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // 一旦post请求完成，我们就可以将本地缓存标记为脏。 + // 这将导致我们的通知者程序上的“build”再次异步调用， + // 并在执行此操作时通知监听者。 + ref.invalidateSelf(); + + // （可选）然后我们可以等待新状态的计算。 + // 这确保了“addTodo”在新状态可用之前不会完成。 + await future; + } +/* SNIPPET END */ +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart new file mode 100644 index 000000000..e9b92ac08 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/manual_add_todo.dart @@ -0,0 +1,39 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // 我们不关心 API 响应 + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // 然后我们可以手动更新本地缓存。为此，我们需要获取之前的状态。 + // 注意：之前的状态可能仍在加载或处于错误状态。 + // 处理此问题的一种优雅方法是读取“this.future”而不是“this.state”， + // 这将允许等待加载状态，并在状态处于错误状态时抛出错误。 + final previousState = await future; + + // 然后我们可以通过创建一个新的状态对象来更新状态。 + // 这将通知所有监听者。 + state = AsyncData([...previousState, todo]); + } +/* SNIPPET END */ +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart new file mode 100644 index 000000000..98dbca8e1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/mutable_manual_add_todo.dart @@ -0,0 +1,35 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + // We don't care about the API response + await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + /* SNIPPET START */ + final previousState = await future; + // 改变之前的待办事项列表。 + previousState.add(todo); + // 手动通知监听者。 + ref.notifyListeners(); +/* SNIPPET END */ + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart new file mode 100644 index 000000000..801fde129 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo.dart @@ -0,0 +1,78 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'rest_add_todo.dart'; +import 'todo_list_notifier.dart' show Todo; + +void main() { + runApp( + const ProviderScope(child: MyApp()), + ); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return const MaterialApp(home: Example()); + } +} + +/* SNIPPET START */ +class Example extends ConsumerStatefulWidget { + const Example({super.key}); + + @override + ConsumerState createState() => _ExampleState(); +} + +class _ExampleState extends ConsumerState { + // 待处理的 addTodo 操作。如果没有待处理的，则为 null。 + Future? _pendingAddTodo; + + @override + Widget build(BuildContext context) { + return FutureBuilder( + // 我们监听待处理的操作，以相应地更新 UI。 + future: _pendingAddTodo, + builder: (context, snapshot) { + // 计算是否存在错误状态。 + // 检查 connectionState 用于在重试操作时进行处理。 + final isErrored = snapshot.hasError && + snapshot.connectionState != ConnectionState.waiting; + + return Row( + children: [ + ElevatedButton( + style: ButtonStyle( + // 如果出现错误，我们会将该按钮显示为红色 + backgroundColor: MaterialStateProperty.all( + isErrored ? Colors.red : null, + ), + ), + onPressed: () { + // 我们将 addTodo 返回的 future 保存在变量中 + final future = ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + + // 我们将这个 future 存储在本地的状态中 + setState(() { + _pendingAddTodo = future; + }); + }, + child: const Text('Add todo'), + ), + // 操作正在等待，让我们显示一个进度指示器 + if (snapshot.connectionState == ConnectionState.waiting) ...[ + const SizedBox(width: 8), + const CircularProgressIndicator(), + ], + ], + ); + }, + ); + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart new file mode 100644 index 000000000..81a80f6d5 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/render_add_todo_hooks.dart @@ -0,0 +1,68 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import 'rest_add_todo.dart'; +import 'todo_list_notifier.dart' show Todo; + +void main() { + runApp( + const ProviderScope(child: MyApp()), + ); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + + @override + Widget build(BuildContext context) { + return const MaterialApp(home: Example()); + } +} + +/* SNIPPET START */ +class Example extends HookConsumerWidget { + const Example({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + // 待处理的 addTodo 操作。如果没有待处理的，则为 null。 + final pendingAddTodo = useState?>(null); + // 我们监听待处理的操作，以相应地更新 UI。 + final snapshot = useFuture(pendingAddTodo.value); + + // 计算是否存在错误状态。 + // 检查 connectionState 用于在重试操作时进行处理。 + final isErrored = snapshot.hasError && + snapshot.connectionState != ConnectionState.waiting; + + return Row( + children: [ + ElevatedButton( + style: ButtonStyle( + // 如果出现错误，我们会将该按钮显示为红色 + backgroundColor: MaterialStateProperty.all( + isErrored ? Colors.red : null, + ), + ), + onPressed: () async { + // 我们将 addTodo 返回的 future 保存在变量中 + final future = ref + .read(todoListProvider.notifier) + .addTodo(Todo(description: 'This is a new todo')); + + // 我们将这个 future 存储在本地的状态中 + pendingAddTodo.value = future; + }, + child: const Text('Add todo'), + ), + // 操作正在等待，让我们显示一个进度指示器 + if (snapshot.connectionState == ConnectionState.waiting) ...[ + const SizedBox(width: 8), + const CircularProgressIndicator(), + ], + ], + ); + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart new file mode 100644 index 000000000..ca539bc0b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/rest_add_todo.dart @@ -0,0 +1,39 @@ +// ignore_for_file: avoid_print, prefer_final_locals, omit_local_variable_types + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + /* SNIPPET START */ + Future addTodo(Todo todo) async { + // POST 请求将返回与新应用程序状态匹配的 List + final response = await http.post( + Uri.https('your_api.com', '/todos'), + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + + // 我们解码 API 响应并将其转换为 List + List newTodos = (jsonDecode(response.body) as List) + .cast>() + .map(Todo.fromJson) + .toList(); + + // 我们更新本地缓存以匹配新状态。 + // 这将通知所有的监听程序。 + state = AsyncData(newTodos); + } +/* SNIPPET END */ +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart new file mode 100644 index 000000000..6eb0dd52f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier.dart @@ -0,0 +1,44 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Todo { + Todo({ + required this.description, + this.completed = false, + }); + + factory Todo.fromJson(Map json) { + return Todo( + description: json['description']! as String, + completed: json['completed']! as bool, + ); + } + + final String description; + final bool completed; + + Map toJson() => { + 'description': description, + 'completed': completed, + }; +} + +/* SNIPPET START */ +// 我们现在使用 AsyncNotifierProvider 替代 FutureProvider +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +// 因为我们的逻辑是异步的，所以我们需要使用 AsyncNotifier。 +// 特别的，由于使用“autoDispose”修饰符， +// 我们需要 AsyncNotifier。 +class TodoList extends AsyncNotifier> { + @override + Future> build() async { + // 我们之前在 FutureProvider 中的业务逻辑现在位于 build 方法中。 + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart new file mode 100644 index 000000000..d4aa8973e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_notifier_add_todo.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print + +import 'dart:convert'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:http/http.dart' as http; + +import 'todo_list_notifier.dart'; + +final todoListProvider = + AsyncNotifierProvider.autoDispose>( + TodoList.new, +); + +/* SNIPPET START */ +class TodoList extends AsyncNotifier> { + @override + Future> build() async => [/* ... */]; + + Future addTodo(Todo todo) async { + await http.post( + Uri.https('your_api.com', '/todos'), + // 我们序列化 Todo 对象并将其 POST 到服务器。 + headers: {'Content-Type': 'application/json'}, + body: jsonEncode(todo.toJson()), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart new file mode 100644 index 000000000..a01c4195c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/raw/todo_list_provider.dart @@ -0,0 +1,27 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class Todo { + Todo({ + required this.description, + this.completed = false, + }); + + factory Todo.fromJson(Map json) { + return Todo( + description: json['description'] as String, + completed: json['completed'] as bool, + ); + } + + final String description; + final bool completed; +} + +final todoListProvider = FutureProvider.autoDispose>((ref) async { + // 模拟一个网络请求。这通常来自真实的 API + return [ + Todo(description: 'Learn Flutter', completed: true), + Todo(description: 'Learn Riverpod'), + ]; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts new file mode 100644 index 000000000..798feb107 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/render_add_todo.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/render_add_todo.dart"; +import hooks from "!!raw-loader!./raw/render_add_todo_hooks.dart"; + +export default { + raw: raw, + hooks: hooks, + codegen: raw, + hooksCodegen: hooks, +}; \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts new file mode 100644 index 000000000..b32ae3b9b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/todo_list_notifier.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_notifier.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts new file mode 100644 index 000000000..62fb0e0fc --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_notifier_add_todo.ts @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw/todo_list_notifier_add_todo.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_notifier_add_todo.dart"; + +export default { + raw: raw, + hooks: raw, + codegen: codegen, + hooksCodegen: codegen, +}; \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts new file mode 100644 index 000000000..de7789c0b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/todo_list_provider.ts @@ -0,0 +1,7 @@ +import raw from "!!raw-loader!./raw/todo_list_provider.dart"; +import codegen from "!!raw-loader!./codegen/todo_list_provider.dart"; + +export default { + raw: raw, + codegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing.mdx new file mode 100644 index 000000000..65e4c1945 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing.mdx @@ -0,0 +1,303 @@ +--- +title: 测试你的提供者程序 +--- + +import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; +import createContainer from "!!raw-loader!./testing/create_container.dart"; +import unitTest from "!!raw-loader!./testing/unit_test.dart"; +import widgetTest from "!!raw-loader!./testing/widget_test.dart"; +import fullWidgetTest from "!!raw-loader!./testing/full_widget_test.dart"; +import widgetContainerOf from "!!raw-loader!./testing/widget_container_of.dart"; +import providerToMock from "./testing/provider_to_mock"; +import mockProvider from "!!raw-loader!./testing/mock_provider.dart"; +import autoDisposeListen from "!!raw-loader!./testing/auto_dispose_listen.dart"; +import listenProvider from "!!raw-loader!./testing/listen_provider.dart"; +import awaitFuture from "!!raw-loader!./testing/await_future.dart"; +import notifierMock from "./testing/notifier_mock"; + + +Riverpod API 的核心部分是能够单独测试提供者程序。 + + +对于一个合适的测试套件，有几个挑战需要克服： + + +- 测试不应共享状态。这意味着新测试不应受到先前测试的影响。 +- 测试应该使我们能够模拟某些功能以达到所需的状态。 +- 测试环境应尽可能接近真实环境。 + + +幸运的是，Riverpod 可以轻松实现所有这些目标。 + + +## 设置测试 + + +使用 Riverpod 定义测试时，主要有两种情况： + + +- 单元测试，通常没有 Flutter 依赖。 + 这对于单独测试提供者程序的行为非常有用。 +- Widget 测试，通常带有 Flutter 依赖项。 + 这对于测试使用提供者程序的小部件的行为非常有用。 + + +### 单元测试 + + +单元测试是使用 [package:test](https://pub.dev/packages/test) 中的 `test` 函数定义的。 + + +与任何其他测试的主要区别在于，我们想要创建一个 `ProviderContainer` 对象。 +此对象将使我们的测试能够与提供者程序进行交互。 + + +建议创建一个测试实用程序来创建和处置对象 `ProviderContainer`： + + + + +然后，我们可以使用此实用程序定义一个 `test`： + + + + +现在我们有了 ProviderContainer，我们可以使用它来读取提供者程序，使用： + + +- `container.read`，以读取提供者程序的当前值。 +- `container.listen`，以监听提供者程序并接收更改的通知。 + +:::caution + +在自动处置提供者程序时使用 `container.read` 时要小心。 +如果您的提供者程序没有被监听，其状态可能会在测试过程中被破坏。 + + +在这种情况下，请考虑使用 `container.listen`。 +无论如何，它的返回值都能读取提供者程序的当前值， +同时还能确保提供者程序不会在测试过程中被弃置： + + +::: + + +### 小部件测试 + + +小部件测试是使用 [package:flutter_test](https://pub.dev/packages/flutter_test) 中的 `testWidgets` 函数定义的。 + + +在这种情况下，与通常的 Widget 测试的主要区别在于， +我们必须添加一个 `ProviderScope` 在 `tester.pumpWidget` 的根组件上： + + + + +这类似于我们在 Flutter 应用程序中启用 Riverpod 时所做的。 + + +然后，我们可以用 `tester` 来与我们的小部件进行交互。 +或者，如果要与提供者程序交互，可以获取 `ProviderContainer`。 +也可以使用 `ProviderScope.containerOf(buildContext)` 获得一个。 +因此，通过使用 `tester` ，我们可以编写以下内容： + + + + +然后，我们可以使用它来读取提供者程序。下面是一个完整的示例： + + + + +## 模拟提供者程序 + + +到目前为止，我们已经了解了如何设置测试以及与提供者程序的基本交互。 +但是，在某些情况下，我们可能想要模拟一个提供者程序。 + + +很酷的部分：默认情况下可以模拟所有提供者程序，无需任何额外设置。 +这可以通过在 `ProviderScope` 或 `ProviderContainer` 上指定 `overrides` 参数来实现。 + + +请考虑以下提供者程序： + + + + +我们可以模拟它通过以下方式： + + + + +## 监视提供者程序中的更改 + + +由于我们在测试中获得了一个 `ProviderContainer`，因此可以使用它来“监听”提供者程序： + + + + +然后，您可以将其与 [mockito](https://pub.dev/packages/mockito) +或 [mocktail](https://pub.dev/packages/mocktail) 等包结合使用，以使用它们的 `verify` API。 +或者更简单地说，您可以在列表中添加所有更改并对其进行断言。 + + +## 等待异步提供者程序 + + +在 Riverpod 中，提供者程序返回 Future/Stream 是很常见的。 +在这种情况下，我们的测试可能需要等待异步操作完成。 + + +一种方法是读取提供者程序的 `.future`： + + + + +## 模拟通知者程序 + + +通常不鼓励嘲笑通知者程序。 +相反，您可能应该在通告程序的逻辑中引入一个抽象级别，以便您可以模拟该抽象。 +例如，与其模拟通告程序，不如模拟通告程序用来从中获取数据的“存储库”。 + + +如果您坚持要模拟通告程序，那么创建这样的通告程序需要特别注意： +您的模拟必须对原始通告程序基类进行子类化： +您不能“实现”通告程序，因为这会破坏接口。 + + +因此，在模拟通告程序时，不要编写以下模拟代码： + +```dart +class MyNotifierMock with Mock implements MyNotifier {} +``` + + +你应该改写： + + + + + + +为此，您的模拟必须与您模拟的通知者程序放在同一个文件中。 +否则，您将无法访问该 `_$MyNotifier` 类。 + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart new file mode 100644 index 000000000..4c1582c91 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/auto_dispose_listen.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 'Hello world'); + +void main() { + test('Some description', () { + final container = createContainer(); + /* SNIPPET START */ + final subscription = container.listen(provider, (_, __) {}); + + expect( + // 等同于 `container.read(provider)` + // 但除非处置了 "subscription"，否则不会处置提供者程序。 + subscription.read(), + 'Some value', + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart new file mode 100644 index 000000000..0d5fd8438 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/await_future.dart @@ -0,0 +1,32 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = FutureProvider((_) async => 42); + +void main() { + test('Some description', () async { + // 为该测试创建一个 ProviderContainer。 + // 切勿！在测试之间共享 ProviderContainer。 + final container = createContainer(); + + /* SNIPPET START */ + // TODO: 使用容器来测试您的应用程序。 + // 我们的期望是异步的，所以应该使用 "expectLater"（期望稍后）。 + await expectLater( + // 我们读取的是 "provider.future"，而不是 "provider"。 + // 这在异步提供者程序上是可能发生的， + // 并返回一个携带了提供者程序的值的 Future。 + container.read(provider.future), + // We can verify that the future resolves with the expected value. + // Alternatively we can use "throwsA" for errors. + // 我们可以验证 Future 是否按预期值解析。 + // 或者，我们可以使用 "throwsA" 来处理错误。 + completion('some value'), + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart new file mode 100644 index 000000000..1d4faf8f1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/create_container.dart @@ -0,0 +1,22 @@ +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +/// 一种测试工具，用于创建一个 [ProviderContainer]， +/// 并在测试结束时自动将其处置。 +ProviderContainer createContainer({ + ProviderContainer? parent, + List overrides = const [], + List? observers, +}) { + // 创建一个 ProviderContainer，并可选的允许指定参数。 + final container = ProviderContainer( + parent: parent, + overrides: overrides, + observers: observers, + ); + + // 测试结束后，处置容器。 + addTearDown(container.dispose); + + return container; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart new file mode 100644 index 000000000..ce0766bc3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/full_widget_test.dart @@ -0,0 +1,33 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +final provider = Provider((_) => 'some value'); + +class YourWidgetYouWantToTest extends StatelessWidget { + const YourWidgetYouWantToTest({super.key}); + + @override + Widget build(BuildContext context) => const Placeholder(); +} + +/* SNIPPET START */ +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + + final element = tester.element(find.byType(YourWidgetYouWantToTest)); + final container = ProviderScope.containerOf(element); + + // TODO 与你的提供者程序交互 + expect( + container.read(provider), + 'some value', + ); + }); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart new file mode 100644 index 000000000..d2e840d9b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/listen_provider.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable, avoid_print + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 'Hello world'); + +void main() { + test('Some description', () { + final container = createContainer(); + /* SNIPPET START */ + container.listen( + provider, + (previous, next) { + print('The provider changed from $previous to $next'); + }, + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart new file mode 100644 index 000000000..284094b48 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/mock_provider.dart @@ -0,0 +1,45 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +import 'create_container.dart'; +import 'full_widget_test.dart'; +import 'provider_to_mock/raw.dart'; + +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + /* SNIPPET START */ + // 在单元测试中，重用我们之前的 "createContainer "工具。 + final container = createContainer( + // 我们可以指定要模拟的提供者程序列表： + overrides: [ + // 在本例中，我们模拟的是 "exampleProvider"。 + exampleProvider.overrideWith((ref) { + // 该函数是典型的提供者程序初始化函数。 + // 通常在此调用 "ref.watch "并返回初始状态。 + + // 让我们用自定义值替换默认的 "Hello world"。 + // 然后，与 `exampleProvider` 交互时将返回此值。 + return 'Hello from tests'; + }), + ], + ); + + // 我们还可以使用 ProviderScope 在 widget 测试中做同样的事情： + await tester.pumpWidget( + ProviderScope( + // ProviderScopes 具有完全相同的 "overrides" 参数 + overrides: [ + // 和之前一样 + exampleProvider.overrideWith((ref) => 'Hello from tests'), + ], + child: const YourWidgetYouWantToTest(), + ), + ); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart new file mode 100644 index 000000000..53e71e99e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.dart @@ -0,0 +1,17 @@ +// ignore_for_file: prefer_mixin + +import 'package:mockito/mockito.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() => throw UnimplementedError(); +} + +// 您的模拟类需要作为 Notifier 的子类，与您的通知者程序使用的基类相对应 +class MyNotifierMock extends _$MyNotifier with Mock implements MyNotifier {} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart new file mode 100644 index 000000000..df3894527 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/codegen.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'912fa35c2296626fc0825bcbcfc6b6c85958be02'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart new file mode 100644 index 000000000..404e67734 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/notifier_mock/raw.dart @@ -0,0 +1,14 @@ +// ignore_for_file: prefer_mixin + +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:mockito/mockito.dart'; + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() => throw UnimplementedError(); +} + +// 您的模拟类需要作为 Notifier 的子类，与您的通知者程序使用的基类相对应 +class MyNotifierMock extends Notifier with Mock implements MyNotifier {} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart new file mode 100644 index 000000000..1a5fd4543 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.dart @@ -0,0 +1,9 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +// 一个急于初始化的提供者程序。 +@riverpod +Future example(ExampleRef ref) async => 'Hello world'; +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart new file mode 100644 index 000000000..fa3e37948 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/codegen.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref>; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider, + FutureOr, ExampleRef> + with $FutureModifier, $FutureProvider { + const ExampleProvider._( + {FutureOr Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + @$internal + @override + $FutureProviderElement $createElement(ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ExampleProvider $copyWithCreate( + FutureOr Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + FutureOr create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts new file mode 100644 index 000000000..9d50c6614 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/index.ts @@ -0,0 +1,4 @@ +import raw from '!!raw-loader!./raw.dart'; +import codegen from '!!raw-loader!./codegen.dart'; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart new file mode 100644 index 000000000..1491a0b60 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/provider_to_mock/raw.dart @@ -0,0 +1,6 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +// 一个急于初始化的提供者程序。 +final exampleProvider = FutureProvider((ref) async => 'Hello world'); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart new file mode 100644 index 000000000..40261e13e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/unit_test.dart @@ -0,0 +1,23 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/riverpod.dart'; + +import 'create_container.dart'; + +final provider = Provider((_) => 42); + +/* SNIPPET START */ +void main() { + test('Some description', () { + // 为该测试创建一个 ProviderContainer。 + // 切勿！在测试之间共享 ProviderContainer。 + final container = createContainer(); + + // TODO: 使用容器测试你的应用程序。 + expect( + container.read(provider), + equals('some value'), + ); + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart new file mode 100644 index 000000000..61b2ca36b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_container_of.dart @@ -0,0 +1,15 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +import 'widget_test.dart'; + +void main() { + testWidgets('Some description', (tester) async { + /* SNIPPET START */ + final element = tester.element(find.byType(YourWidgetYouWantToTest)); + final container = ProviderScope.containerOf(element); + /* SNIPPET END */ + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart new file mode 100644 index 000000000..b4afc835c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing/widget_test.dart @@ -0,0 +1,22 @@ +// ignore_for_file: unused_local_variable + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +class YourWidgetYouWantToTest extends StatelessWidget { + const YourWidgetYouWantToTest({super.key}); + + @override + Widget build(BuildContext context) => const Placeholder(); +} + +/* SNIPPET START */ +void main() { + testWidgets('Some description', (tester) async { + await tester.pumpWidget( + const ProviderScope(child: YourWidgetYouWantToTest()), + ); + }); +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx new file mode 100644 index 000000000..7fe276f71 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync.mdx @@ -0,0 +1,197 @@ +--- +title: Websocket 和同步执行 +--- + +import { + trimSnippet, + AutoSnippet, + When, +} from "@site/src/components/CodeSnippet"; +import syncDefinition from "./websockets_sync/sync_definition"; +import streamProvider from "./websockets_sync/stream_provider"; +import syncConsumer from "!!raw-loader!./websockets_sync/sync_consumer.dart"; +import rawUsage from "!!raw-loader!./websockets_sync/raw_usage.dart"; +import pipeChangeNotifier from "!!raw-loader!./websockets_sync/pipe_change_notifier.dart"; +import sharedPipeChangeNotifier from "!!raw-loader!./websockets_sync/shared_pipe_change_notifier.dart"; +import changeNotifierProvider from "!!raw-loader!./websockets_sync/change_notifier_provider.dart"; + + +到目前为止，我们只介绍了如何创建一个 `Future`。 +这是有意为之的，因为 `Future` 是 Riverpod 应用程序构建方式的核心。 +_但是_，如有必要，Riverpod 还支持其他格式。 + + +特别是，除了 `Future` 类型的提供者程序，还存在灵活的类型： + + +- 同步返回一个对象，例如创建“存储库”。 +- 返回一个 `Stream`，例如监听 websockets。 + + +返回 `Future` 和返回 `Stream` 或 object 总体上非常相似。 +本页将解释这些用例的细微差别和各种提示。 + + +## 同步返回对象 + + +若要同步创建对象，请确保提供者程序不返回 Future： + + + + +当提供者程序同步创建对象时，这会影响对象的使用方式。 +具体而言，同步值不会被包装在“AsyncValue”中： + + + + +这种差异的后果是，如果提供者程序抛出异常，尝试读取该值会重新抛出错误。 +或者，当使用 `ref.listen` 时，将调用 “onError” 回调。 + + +### 可监听对象的注意事项 + + + + +可监听对象，例如 `ChangeNotifier` 或 `StateNotifier` 是不受支持的。 +如果出于兼容性原因，您需要与其中一个对象进行交互， +一种解决方法是将其通知机制通过管道传递给 Riverpod。 + + + +:::info + +如果你多次需要这样的逻辑，值得注意的是， +逻辑是共享的！"ref" 对象被设计为可组合的。 +这样就可以从提供者程序中提取处置/监听逻辑： + + +::: + + + + + + +当不使用代码生成时，Riverpod 提供了“传统”的提供者程序来支持 +`ChangeNotifier` 和 `StateNotifier` 开箱即用： +`ChangeNotifierProvider` 和 `StateNotifierProvider`。 +使用它们就像使用其他类型的提供者程序一样。 +主要区别在于它们将自动监听和处置返回的对象。 + + +不建议将这些提供者程序用于新的业务逻辑。 +但是，在与旧代码混合编写时（例如从 `pkg:provider` 迁移到 Riverpod 时）， +它们可能会有所帮助。 + + + + + + +## 监听一个流 + + +现代应用程序的一个常见用例是与 Websocket 交互， +例如与 Firebase 或 GraphQL 订阅进行交互。 +与这些 API 的交互通常是通过监听一个 `Stream`。 + + +为了帮助实现这一点，Riverpod 自然地支持 `Stream` 对象。 +与 `Future` 一样，该对象将转换为 `AsyncValue`： + + + +:::info + +Riverpod 不知道自定义 `Stream` 实现，例如 RX 的 `BehaviorSubject`。 +因此，返回 `BehaviorSubject` 不会同步向小部件公开，`value` 即使在创建时已经可用。 +::: + + +## 禁用从 `Stream` / `Future` 转换到 `AsyncValue` + + +默认情况下，Riverpod 会将 `Stream` 和 `Future` 转换为 `AsyncValue`。 +尽管很少需要，但可以通过将返回类型包装在 `Raw` 泛型中来禁用此行为。 + +:::caution + +通常不建议禁用转换 `AsyncValue`。 +只有当您知道自己在做什么时才这样做。 +::: + + diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart new file mode 100644 index 000000000..7ee51d0ce --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/change_notifier_provider.dart @@ -0,0 +1,11 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ +final myProvider = ChangeNotifierProvider>((ref) { + // 将监听并处置 ValueNotifier。 + // 然后，小部件可以使用 "ref.watch" 对提供者程序监听更新。 + return ValueNotifier(0); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart new file mode 100644 index 000000000..91e60abc3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.dart @@ -0,0 +1,21 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'pipe_change_notifier.g.dart'; + +/* SNIPPET START */ +/// 一个提供者程序，它创建 ValueNotifier 并在值更改时更新其监听器。 +@riverpod +Raw> myListenable(MyListenableRef ref) { + final notifier = ValueNotifier(0); + + // 当提供者程序被处置时处置通知者程序 + ref.onDispose(notifier.dispose); + + // 每当 ValueNotifier 更新时通知此提供者程序的监听器。 + notifier.addListener(ref.notifyListeners); + + return notifier; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart new file mode 100644 index 000000000..1f7904ad7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -0,0 +1,79 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'pipe_change_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +/// 一个提供者程序，它创建 ValueNotifier 并在值更改时更新其监听器。 +typedef MyListenableRef = Ref>>; + +/// 一个提供者程序，它创建 ValueNotifier 并在值更改时更新其监听器。 +@ProviderFor(myListenable) +const myListenableProvider = MyListenableProvider._(); + +/// 一个提供者程序，它创建 ValueNotifier 并在值更改时更新其监听器。 +final class MyListenableProvider extends $FunctionalProvider< + Raw>, + Raw>, + MyListenableRef> with $Provider>, MyListenableRef> { + /// 一个提供者程序，它创建 ValueNotifier 并在值更改时更新其监听器。 + const MyListenableProvider._( + {Raw> Function( + MyListenableRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myListenableProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + MyListenableRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$myListenableHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @$internal + @override + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + MyListenableProvider $copyWithCreate( + Raw> Function( + MyListenableRef ref, + ) create, + ) { + return MyListenableProvider._(create: create); + } + + @override + Raw> create(MyListenableRef ref) { + final _$cb = _createCb ?? myListenable; + return _$cb(ref); + } +} + +String _$myListenableHash() => r'c80799a0224092668fca44187b98ccfcd2b33ae1'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart new file mode 100644 index 000000000..496408e74 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.dart @@ -0,0 +1,30 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'raw_usage.g.dart'; + +/* SNIPPET START */ +@riverpod +Raw> rawStream(RawStreamRef ref) { + // “Raw”是一个 typedef。 + // 无需包装返回值的“原始”构造函数中的值。 + return const Stream.empty(); +} + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 该值不再转换为 AsyncValue， + // 并且按原样返回创建的流。 + Stream stream = ref.watch(rawStreamProvider); + return StreamBuilder( + stream: stream, + builder: (context, snapshot) { + return Text('${snapshot.data}'); + }, + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart new file mode 100644 index 000000000..60959986e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/raw_usage.g.dart @@ -0,0 +1,75 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'raw_usage.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RawStreamRef = Ref>>; + +@ProviderFor(rawStream) +const rawStreamProvider = RawStreamProvider._(); + +final class RawStreamProvider extends $FunctionalProvider< + Raw>, + Raw>, + RawStreamRef> with $Provider>, RawStreamRef> { + const RawStreamProvider._( + {Raw> Function( + RawStreamRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'rawStreamProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + RawStreamRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$rawStreamHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @$internal + @override + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + RawStreamProvider $copyWithCreate( + Raw> Function( + RawStreamRef ref, + ) create, + ) { + return RawStreamProvider._(create: create); + } + + @override + Raw> create(RawStreamRef ref) { + final _$cb = _createCb ?? rawStream; + return _$cb(ref); + } +} + +String _$rawStreamHash() => r'7e7c2e8f4f08d33a4d86d60449e143c419ca4822'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart new file mode 100644 index 000000000..96edc3553 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.dart @@ -0,0 +1,28 @@ +// ignore_for_file: omit_local_variable_types + +import 'package:flutter/widgets.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'shared_pipe_change_notifier.g.dart'; + +/* SNIPPET START */ +extension on Ref { + // 我们可以将之前的逻辑移至 Ref 扩展。 + // 这使得能够重用提供者程序之间的逻辑 + T disposeAndListenChangeNotifier(T notifier) { + onDispose(notifier.dispose); + notifier.addListener(notifyListeners); + // 我们返回通知者程序以稍微简化使用 + return notifier; + } +} + +@riverpod +Raw> myListenable(MyListenableRef ref) { + return ref.disposeAndListenChangeNotifier(ValueNotifier(0)); +} + +@riverpod +Raw> anotherListenable(AnotherListenableRef ref) { + return ref.disposeAndListenChangeNotifier(ValueNotifier(42)); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart new file mode 100644 index 000000000..ebffc98b1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -0,0 +1,136 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'shared_pipe_change_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef MyListenableRef = Ref>>; + +@ProviderFor(myListenable) +const myListenableProvider = MyListenableProvider._(); + +final class MyListenableProvider extends $FunctionalProvider< + Raw>, + Raw>, + MyListenableRef> with $Provider>, MyListenableRef> { + const MyListenableProvider._( + {Raw> Function( + MyListenableRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myListenableProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + MyListenableRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$myListenableHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @$internal + @override + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + MyListenableProvider $copyWithCreate( + Raw> Function( + MyListenableRef ref, + ) create, + ) { + return MyListenableProvider._(create: create); + } + + @override + Raw> create(MyListenableRef ref) { + final _$cb = _createCb ?? myListenable; + return _$cb(ref); + } +} + +String _$myListenableHash() => r'90f4227ef5442f978d742115663e5f0869622a27'; + +typedef AnotherListenableRef = Ref>>; + +@ProviderFor(anotherListenable) +const anotherListenableProvider = AnotherListenableProvider._(); + +final class AnotherListenableProvider extends $FunctionalProvider< + Raw>, Raw>, AnotherListenableRef> + with $Provider>, AnotherListenableRef> { + const AnotherListenableProvider._( + {Raw> Function( + AnotherListenableRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'anotherListenableProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + AnotherListenableRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$anotherListenableHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @$internal + @override + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + AnotherListenableProvider $copyWithCreate( + Raw> Function( + AnotherListenableRef ref, + ) create, + ) { + return AnotherListenableProvider._(create: create); + } + + @override + Raw> create(AnotherListenableRef ref) { + final _$cb = _createCb ?? anotherListenable; + return _$cb(ref); + } +} + +String _$anotherListenableHash() => r'50dd36b21e07c50818944ec49f9e68d21fcae876'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart new file mode 100644 index 000000000..e0c6c4b60 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.dart @@ -0,0 +1,34 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +Stream streamExample(StreamExampleRef ref) async* { + // 每 1 秒产生一个 0 到 41 之间的数字。 + // 这可以替换为来自 Firestore 或 GraphQL 或其他任何东西的 Stream。 + for (var i = 0; i < 42; i++) { + yield i; + await Future.delayed(const Duration(seconds: 1)); + } +} + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 该流被监听并转换为 AsyncValue。 + AsyncValue value = ref.watch(streamExampleProvider); + + // 我们可以使用 AsyncValue 来处理加载/错误状态并显示数据。 + return switch (value) { + AsyncValue(:final error?) => Text('Error: $error'), + AsyncValue(:final valueOrNull?) => Text('$valueOrNull'), + _ => const CircularProgressIndicator(), + }; + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart new file mode 100644 index 000000000..eabd579e0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -0,0 +1,65 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef StreamExampleRef = Ref>; + +@ProviderFor(streamExample) +const streamExampleProvider = StreamExampleProvider._(); + +final class StreamExampleProvider + extends $FunctionalProvider, Stream, StreamExampleRef> + with $FutureModifier, $StreamProvider { + const StreamExampleProvider._( + {Stream Function( + StreamExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'streamExampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream Function( + StreamExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$streamExampleHash(); + + @$internal + @override + $StreamProviderElement $createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + StreamExampleProvider $copyWithCreate( + Stream Function( + StreamExampleRef ref, + ) create, + ) { + return StreamExampleProvider._(create: create); + } + + @override + Stream create(StreamExampleRef ref) { + final _$cb = _createCb ?? streamExample; + return _$cb(ref); + } +} + +String _$streamExampleHash() => r'ca9993b22f6d587b20c041133cacd28d01933074'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts new file mode 100644 index 000000000..4ee159de8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/index.ts @@ -0,0 +1,4 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart new file mode 100644 index 000000000..625d24903 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/stream_provider/raw.dart @@ -0,0 +1,30 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final streamExampleProvider = StreamProvider.autoDispose((ref) async* { + // 每 1 秒产生一个 0 到 41 之间的数字。 + // 这可以替换为来自 Firestore 或 GraphQL 或其他任何东西的 Stream。 + for (var i = 0; i < 42; i++) { + yield i; + await Future.delayed(const Duration(seconds: 1)); + } +}); + +class Consumer extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 该流被监听并转换为 AsyncValue。 + AsyncValue value = ref.watch(streamExampleProvider); + + // 我们可以使用 AsyncValue 来处理加载/错误状态并显示数据。 + return switch (value) { + AsyncValue(:final error?) => Text('Error: $error'), + AsyncValue(:final valueOrNull?) => Text('$valueOrNull'), + _ => const CircularProgressIndicator(), + }; + } +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart new file mode 100644 index 000000000..83bc56e66 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_consumer.dart @@ -0,0 +1,19 @@ +// ignore_for_file: omit_local_variable_types, prefer_final_locals + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +import 'sync_definition/raw.dart'; + +void main() { +/* SNIPPET START */ + Consumer( + builder: (context, ref, child) { + // value 没有使用 "AsyncValue "包装 + int value = ref.watch(synchronousExampleProvider); + + return Text('$value'); + }, + ); +/* SNIPPET END */ +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart new file mode 100644 index 000000000..dbccd14aa --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.dart @@ -0,0 +1,10 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ +@riverpod +int synchronousExample(SynchronousExampleRef ref) { + return 0; +} +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart new file mode 100644 index 000000000..ffc21fd38 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef SynchronousExampleRef = Ref; + +@ProviderFor(synchronousExample) +const synchronousExampleProvider = SynchronousExampleProvider._(); + +final class SynchronousExampleProvider + extends $FunctionalProvider + with $Provider { + const SynchronousExampleProvider._( + {int Function( + SynchronousExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'synchronousExampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + SynchronousExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$synchronousExampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + SynchronousExampleProvider $copyWithCreate( + int Function( + SynchronousExampleRef ref, + ) create, + ) { + return SynchronousExampleProvider._(create: create); + } + + @override + int create(SynchronousExampleRef ref) { + final _$cb = _createCb ?? synchronousExample; + return _$cb(ref); + } +} + +String _$synchronousExampleHash() => + r'98df96e07d554683041f668c06b36f183ff534c1'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts new file mode 100644 index 000000000..4ee159de8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/index.ts @@ -0,0 +1,4 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { raw, codegen }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart new file mode 100644 index 000000000..193c5eeff --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/websockets_sync/sync_definition/raw.dart @@ -0,0 +1,7 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +final synchronousExampleProvider = Provider.autoDispose((ref) { + return 0; +}); +/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.dart new file mode 100644 index 000000000..4d49c552a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.dart @@ -0,0 +1,11 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'family.g.dart'; +/* SNIPPET START */ + +@riverpod +int random(RandomRef ref, {required int seed, required int max}) { + return Random(seed).nextInt(max); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart new file mode 100644 index 000000000..f53a38413 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/family.g.dart @@ -0,0 +1,168 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RandomRef = Ref; + +@ProviderFor(random) +const randomProvider = RandomFamily._(); + +final class RandomProvider extends $FunctionalProvider + with $Provider { + const RandomProvider._( + {required RandomFamily super.from, + required ({ + int seed, + int max, + }) + super.argument, + int Function( + RandomRef ref, { + required int seed, + required int max, + })? create}) + : _createCb = create, + super( + name: r'randomProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + RandomRef ref, { + required int seed, + required int max, + })? _createCb; + + @override + String debugGetCreateSourceHash() => _$randomHash(); + + @override + String toString() { + return r'randomProvider' + '' + '$argument'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RandomProvider $copyWithCreate( + int Function( + RandomRef ref, + ) create, + ) { + return RandomProvider._( + argument: argument as ({ + int seed, + int max, + }), + from: from! as RandomFamily, + create: ( + ref, { + required int seed, + required int max, + }) => + create(ref)); + } + + @override + int create(RandomRef ref) { + final _$cb = _createCb ?? random; + final argument = this.argument as ({ + int seed, + int max, + }); + return _$cb( + ref, + seed: argument.seed, + max: argument.max, + ); + } + + @override + bool operator ==(Object other) { + return other is RandomProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$randomHash() => r'517b12aad4df7b31f8872b89af74e7880377b2ea'; + +final class RandomFamily extends Family { + const RandomFamily._() + : super( + name: r'randomProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + RandomProvider call({ + required int seed, + required int max, + }) => + RandomProvider._(argument: ( + seed: seed, + max: max, + ), from: this); + + @override + String debugGetCreateSourceHash() => _$randomHash(); + + @override + String toString() => r'randomProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + int Function( + RandomRef ref, + ({ + int seed, + int max, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as RandomProvider; + + final argument = provider.argument as ({ + int seed, + int max, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx new file mode 100644 index 000000000..fa391f61a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./family.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart new file mode 100644 index 000000000..e1977b568 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/family/raw.dart @@ -0,0 +1,27 @@ +import 'dart:math'; + +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:riverpod/riverpod.dart'; + +@immutable +abstract class Equatable { + const Equatable(); + + List get props; +} + +/* SNIPPET START */ +class ParamsType extends Equatable { + const ParamsType({required this.seed, required this.max}); + + final int seed; + final int max; + + @override + List get props => [seed, max]; +} + +final randomProvider = + Provider.family.autoDispose((ref, params) { + return Random(params.seed).nextInt(params.max); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart new file mode 100644 index 000000000..1082ef6f3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.dart @@ -0,0 +1,12 @@ +import 'package:freezed_annotation/freezed_annotation.dart'; + +import 'json.dart'; + +part 'item.freezed.dart'; +part 'item.g.dart'; + +@freezed +class Item with _$Item { + const factory Item({required int id}) = _Item; + factory Item.fromJson(Json json) => _$ItemFromJson(json); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart new file mode 100644 index 000000000..e578c8154 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.freezed.dart @@ -0,0 +1,146 @@ +// coverage:ignore-file +// GENERATED CODE - DO NOT MODIFY BY HAND +// ignore_for_file: type=lint +// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark + +part of 'item.dart'; + +// ************************************************************************** +// FreezedGenerator +// ************************************************************************** + +T _$identity(T value) => value; + +final _privateConstructorUsedError = UnsupportedError( + 'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models'); + +Item _$ItemFromJson(Map json) { + return _Item.fromJson(json); +} + +/// @nodoc +mixin _$Item { + int get id => throw _privateConstructorUsedError; + + Map toJson() => throw _privateConstructorUsedError; + @JsonKey(ignore: true) + $ItemCopyWith get copyWith => throw _privateConstructorUsedError; +} + +/// @nodoc +abstract class $ItemCopyWith<$Res> { + factory $ItemCopyWith(Item value, $Res Function(Item) then) = + _$ItemCopyWithImpl<$Res, Item>; + @useResult + $Res call({int id}); +} + +/// @nodoc +class _$ItemCopyWithImpl<$Res, $Val extends Item> + implements $ItemCopyWith<$Res> { + _$ItemCopyWithImpl(this._value, this._then); + + // ignore: unused_field + final $Val _value; + // ignore: unused_field + final $Res Function($Val) _then; + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + }) { + return _then(_value.copyWith( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as int, + ) as $Val); + } +} + +/// @nodoc +abstract class _$$ItemImplCopyWith<$Res> implements $ItemCopyWith<$Res> { + factory _$$ItemImplCopyWith( + _$ItemImpl value, $Res Function(_$ItemImpl) then) = + __$$ItemImplCopyWithImpl<$Res>; + @override + @useResult + $Res call({int id}); +} + +/// @nodoc +class __$$ItemImplCopyWithImpl<$Res> + extends _$ItemCopyWithImpl<$Res, _$ItemImpl> + implements _$$ItemImplCopyWith<$Res> { + __$$ItemImplCopyWithImpl(_$ItemImpl _value, $Res Function(_$ItemImpl) _then) + : super(_value, _then); + + @pragma('vm:prefer-inline') + @override + $Res call({ + Object? id = null, + }) { + return _then(_$ItemImpl( + id: null == id + ? _value.id + : id // ignore: cast_nullable_to_non_nullable + as int, + )); + } +} + +/// @nodoc +@JsonSerializable() +class _$ItemImpl implements _Item { + const _$ItemImpl({required this.id}); + + factory _$ItemImpl.fromJson(Map json) => + _$$ItemImplFromJson(json); + + @override + final int id; + + @override + String toString() { + return 'Item(id: $id)'; + } + + @override + bool operator ==(Object other) { + return identical(this, other) || + (other.runtimeType == runtimeType && + other is _$ItemImpl && + (identical(other.id, id) || other.id == id)); + } + + @JsonKey(ignore: true) + @override + int get hashCode => Object.hash(runtimeType, id); + + @JsonKey(ignore: true) + @override + @pragma('vm:prefer-inline') + _$$ItemImplCopyWith<_$ItemImpl> get copyWith => + __$$ItemImplCopyWithImpl<_$ItemImpl>(this, _$identity); + + @override + Map toJson() { + return _$$ItemImplToJson( + this, + ); + } +} + +abstract class _Item implements Item { + const factory _Item({required final int id}) = _$ItemImpl; + + factory _Item.fromJson(Map json) = _$ItemImpl.fromJson; + + @override + int get id; + @override + @JsonKey(ignore: true) + _$$ItemImplCopyWith<_$ItemImpl> get copyWith => + throw _privateConstructorUsedError; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart new file mode 100644 index 000000000..3c653e18c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/item.g.dart @@ -0,0 +1,18 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'item.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +_$ItemImpl _$$ItemImplFromJson(Map json) => _$ItemImpl( + id: json['id'] as int, + ); + +Map _$$ItemImplToJson(_$ItemImpl instance) => + { + 'id': instance.id, + }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart new file mode 100644 index 000000000..17cfb1c01 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/helpers/json.dart @@ -0,0 +1 @@ +typedef Json = Map; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart new file mode 100644 index 000000000..802a23150 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.dart @@ -0,0 +1,29 @@ +import 'package:collection/collection.dart'; +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; +import '../../helpers/json.dart'; + +part 'async_values.g.dart'; + +/* SNIPPET START */ + +@riverpod +Future> itemsApi(ItemsApiRef ref) async { + final client = Dio(); + final result = await client.get>('your-favorite-api'); + final parsed = [...result.data!.map((e) => Item.fromJson(e as Json))]; + return parsed; +} + +@riverpod +List evenItems(EvenItemsRef ref) { + final asyncValue = ref.watch(itemsApiProvider); + if (asyncValue.isReloading) return []; + if (asyncValue.hasError) return const [Item(id: -1)]; + + final items = asyncValue.requireValue; + + return [...items.whereIndexed((index, element) => index.isEven)]; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart new file mode 100644 index 000000000..ae3227615 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/async_values.g.dart @@ -0,0 +1,126 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_values.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ItemsApiRef = Ref>>; + +@ProviderFor(itemsApi) +const itemsApiProvider = ItemsApiProvider._(); + +final class ItemsApiProvider extends $FunctionalProvider>, + FutureOr>, ItemsApiRef> + with $FutureModifier>, $FutureProvider, ItemsApiRef> { + const ItemsApiProvider._( + {FutureOr> Function( + ItemsApiRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'itemsApiProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + ItemsApiRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$itemsApiHash(); + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + ItemsApiProvider $copyWithCreate( + FutureOr> Function( + ItemsApiRef ref, + ) create, + ) { + return ItemsApiProvider._(create: create); + } + + @override + FutureOr> create(ItemsApiRef ref) { + final _$cb = _createCb ?? itemsApi; + return _$cb(ref); + } +} + +String _$itemsApiHash() => r'b32ccb7b85305e361d8ed752cbe11d9524c96190'; + +typedef EvenItemsRef = Ref>; + +@ProviderFor(evenItems) +const evenItemsProvider = EvenItemsProvider._(); + +final class EvenItemsProvider + extends $FunctionalProvider, List, EvenItemsRef> + with $Provider, EvenItemsRef> { + const EvenItemsProvider._( + {List Function( + EvenItemsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'evenItemsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + EvenItemsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$evenItemsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + EvenItemsProvider $copyWithCreate( + List Function( + EvenItemsRef ref, + ) create, + ) { + return EvenItemsProvider._(create: create); + } + + @override + List create(EvenItemsRef ref) { + final _$cb = _createCb ?? evenItems; + return _$cb(ref); + } +} + +String _$evenItemsHash() => r'55ae98f9b6108203dfc4a139f1ade9fbd8ba8ddd'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx new file mode 100644 index 000000000..526f2dffe --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./async_values.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart new file mode 100644 index 000000000..f21a954e5 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/async_values/raw.dart @@ -0,0 +1,25 @@ +import 'package:collection/collection.dart'; +import 'package:dio/dio.dart'; +import 'package:riverpod/riverpod.dart'; + +import '../../helpers/item.dart'; +import '../../helpers/json.dart'; + +/* SNIPPET START */ + +final itemsApiProvider = FutureProvider.autoDispose((ref) async { + final client = Dio(); + final result = await client.get>('your-favorite-api'); + final parsed = [...result.data!.map((e) => Item.fromJson(e as Json))]; + return parsed; +}); + +final evenItemsProvider = Provider.autoDispose((ref) { + final asyncValue = ref.watch(itemsApiProvider); + if (asyncValue.isLoading) return []; + if (asyncValue.hasError) return const [Item(id: -1)]; + + final items = asyncValue.requireValue; + + return [...items.whereIndexed((index, element) => index.isEven)]; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart new file mode 100644 index 000000000..9510dc2b8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.dart @@ -0,0 +1,24 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'auto_dispose.g.dart'; + +/* SNIPPET START */ // 对于代码生成，.autoDispose 是默认值 +@riverpod +int diceRoll(DiceRollRef ref) { + // 由于此提供者程序是 .autoDispose，因此取消监听将处置其当前公开的状态。 + // 然后，每当再次监听该提供者程序时，就会掷出新的骰子并再次暴露。 + final dice = Random().nextInt(10); + return dice; +} + +@riverpod +int cachedDiceRoll(CachedDiceRollRef ref) { + final coin = Random().nextInt(10); + if (coin > 5) throw Exception('Way too large.'); + // 上述条件可能会失败； + // 如果没有，以下指令会告诉提供者程序保持其缓存状态，即使没有人再监听它。 + ref.keepAlive(); + return coin; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart new file mode 100644 index 000000000..4baf88906 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -0,0 +1,132 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'auto_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef DiceRollRef = Ref; + +@ProviderFor(diceRoll) +const diceRollProvider = DiceRollProvider._(); + +final class DiceRollProvider extends $FunctionalProvider + with $Provider { + const DiceRollProvider._( + {int Function( + DiceRollRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'diceRollProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + DiceRollRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$diceRollHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DiceRollProvider $copyWithCreate( + int Function( + DiceRollRef ref, + ) create, + ) { + return DiceRollProvider._(create: create); + } + + @override + int create(DiceRollRef ref) { + final _$cb = _createCb ?? diceRoll; + return _$cb(ref); + } +} + +String _$diceRollHash() => r'dfd5ac8b74351a0076da9d131c10277f53ff11b9'; + +typedef CachedDiceRollRef = Ref; + +@ProviderFor(cachedDiceRoll) +const cachedDiceRollProvider = CachedDiceRollProvider._(); + +final class CachedDiceRollProvider + extends $FunctionalProvider + with $Provider { + const CachedDiceRollProvider._( + {int Function( + CachedDiceRollRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'cachedDiceRollProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CachedDiceRollRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$cachedDiceRollHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CachedDiceRollProvider $copyWithCreate( + int Function( + CachedDiceRollRef ref, + ) create, + ) { + return CachedDiceRollProvider._(create: create); + } + + @override + int create(CachedDiceRollRef ref) { + final _$cb = _createCb ?? cachedDiceRoll; + return _$cb(ref); + } +} + +String _$cachedDiceRollHash() => r'fc31fcb804f10360d75362e56329976343ee7abb'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx new file mode 100644 index 000000000..6c57cfffd --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./auto_dispose.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart new file mode 100644 index 000000000..6c8835d03 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/auto_dispose/raw.dart @@ -0,0 +1,20 @@ +import 'dart:math'; + +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +final diceRollProvider = Provider.autoDispose((ref) { + // 由于此提供者程序是 .autoDispose，因此取消监听将处置其当前公开的状态。 + // 然后，每当再次监听该提供者程序时，就会掷出新的骰子并再次暴露。 + final dice = Random().nextInt(10); + return dice.isEven; +}); + +final cachedDiceRollProvider = Provider.autoDispose((ref) { + final coin = Random().nextInt(10); + if (coin > 5) throw Exception('Way too large.'); + // 上述条件可能会失败； + // 如果没有，以下指令会告诉提供者程序保持其缓存状态，即使没有人再监听它。 + ref.keepAlive(); + return coin.isEven; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart new file mode 100644 index 000000000..ecd1915da --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.dart @@ -0,0 +1,19 @@ +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'combine.g.dart'; + +/* SNIPPET START */ + +@riverpod +int number(NumberRef ref) { + return Random().nextInt(10); +} + +@riverpod +int doubled(DoubledRef ref) { + final number = ref.watch(numberProvider); + + return number * 2; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart new file mode 100644 index 000000000..ef5a1884c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/combine.g.dart @@ -0,0 +1,131 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'combine.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef NumberRef = Ref; + +@ProviderFor(number) +const numberProvider = NumberProvider._(); + +final class NumberProvider extends $FunctionalProvider + with $Provider { + const NumberProvider._( + {int Function( + NumberRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'numberProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + NumberRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$numberHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + NumberProvider $copyWithCreate( + int Function( + NumberRef ref, + ) create, + ) { + return NumberProvider._(create: create); + } + + @override + int create(NumberRef ref) { + final _$cb = _createCb ?? number; + return _$cb(ref); + } +} + +String _$numberHash() => r'725e25be57b9cc2bd914752f156e26a214596b63'; + +typedef DoubledRef = Ref; + +@ProviderFor(doubled) +const doubledProvider = DoubledProvider._(); + +final class DoubledProvider extends $FunctionalProvider + with $Provider { + const DoubledProvider._( + {int Function( + DoubledRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'doubledProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + DoubledRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$doubledHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DoubledProvider $copyWithCreate( + int Function( + DoubledRef ref, + ) create, + ) { + return DoubledProvider._(create: create); + } + + @override + int create(DoubledRef ref) { + final _$cb = _createCb ?? doubled; + return _$cb(ref); + } +} + +String _$doubledHash() => r'ddc640c876bdbe49fe72fe1632b5ff48687c9279'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx new file mode 100644 index 000000000..2ff7dfbaa --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./combine.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart new file mode 100644 index 000000000..1b8412dd0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/combine/raw.dart @@ -0,0 +1,15 @@ +import 'dart:math'; + +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ + +final numberProvider = Provider.autoDispose((ref) { + return Random().nextInt(10); +}); + +final doubledProvider = Provider.autoDispose((ref) { + final number = ref.watch(numberProvider); + + return number * 2; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx new file mode 100644 index 000000000..4951f9b1a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/motivation.mdx @@ -0,0 +1,434 @@ +--- +title: 动机 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import sameType from "./same_type"; +import combine from "./combine"; +import asyncValues from "./async_values"; +import autoDispose from "./auto_dispose"; +import override from "./override"; +import sideEffects from "./side_effects"; +import { + trimSnippet, + AutoSnippet, + When, +} from "@site/src/components/CodeSnippet"; + + +这篇深入的文章旨在说明为什么需要 Riverpod 的动机。 + + +特别是，本节应回答以下问题： + - 既然 Provider 广受欢迎，为什么要迁移到 Riverpod？ + - 我能获得哪些具体优势？ + - 如何迁移到 Riverpod？ + - 我可以增量迁移吗？ + - 等等…… + + +在本节结束时，您应该确信 Riverpod 优先于 Provider。 + + +**与 Provider 相比，Riverpod 确实是一种更现代、更推荐和更可靠的方法。** + + +Riverpod 提供更好的状态管理功能、更好的缓存策略和简化的响应式模型。 +然而，Provider 目前在许多领域都缺乏，没有前进的道路。 + + +## Provider 的局限性 + + +Provider 存在根本问题是由于受到 InheritedWidget API 的限制。 +从本质上讲，Provider 是一个“更简单的 `InheritedWidget`”; +Provider 只是一个 InheritedWidget 包装器，因此它受到它的限制。 + + +下面是已知的提供者程序问题列表。 + + +### 提供者程序不能保留两个（或多个）相同“类型”的提供者程序 + + +声明两个 `Provider` 将导致不可靠的行为： +`InheritedWidget` 的 API 只能获取*两者中的一个*：即最接近 `Provider` 的祖先。 +虽然 Provider 的文档中解释了[解决方法]，但 Riverpod 根本没有这个问题。 + + +通过消除这个限制，我们可以自由地将逻辑拆分为小块，如下所示： + + + + + +### 提供者程序一次合理地只发出一个值 + + +读取外部 RESTful API 时，通常会显示上次读取值，而新调用会加载下一个读取值。 +Riverpod 通过其 `AsyncValue` 的 API 一次发出两个值（即一个前一个数据值和一个传入的新加载值）来允许这种行为： + + + + +在前面的代码片段中，观察 `evenItemsProvider` 将产生以下效果： +1. 最初，正在发出请求。我们得到一个空列表； +1. 然后，假设发生错误。我们获得 `[Item(id: -1)]`； +1. 然后，我们使用拉取刷新逻辑重试请求（例如，通过 `ref.invalidate`）； +1. 当我们重新加载第一个提供者程序时，第二个提供者程序仍然公开 `[Item(id: -1)]`； +1. 这一次，一些解析后的数据被正确接收：我们的偶数项被正确返回。 + + +使用 Provider，上述功能无法远程实现，甚至更难解决。 + + +### 合并提供者程序很困难且容易出错 + + +对于 Provider，我们可能很想在 provider 的 `create` 中使用 `context.watch`。 +这将是不可靠的，因为即使没有依赖项发生更改（例如，当小部件树中涉及 GlobalKey 时）， +`didChangeDependencies` 也可能被触发。 + + +尽管如此，Provider 有一个名为 `ProxyProvider` 的临时解决方案，但它被认为是乏味且容易出错的。 + + +合并状态是 Riverpod 的核心机制，因为我们可以使用简单而强大的方法（如 [ref.watch] 和 [ref.listen]）以零开销组合和缓存值： + + + + +使用 Riverpod 组合值感觉很自然：依赖项是可读的，并且 API 保持不变。 + + + +### 缺乏安全性 + + +使用 Provider，在重构和/或大型更改期间以 `ProviderNotFoundException` 结束是很常见的。 +事实上，这个运行时异常*是*最初创建 Riverpod 的主要原因之一。 + + +尽管它带来了比这更多的实用性，但 Riverpod 根本无法抛出此异常。 + + +### 处置状态很困难 + + +`InheritedWidget` [无法对消费者程序停止监听他们的情况做出反应]。 +这可以防止提供者程序在不再使用时自动处置其提供者程序的状态。 +在使用 Provider 的情况下，[我们必须]依靠作用域提供者程序在停止使用状态时对其进行处置。 +但这并不容易，因为当在页面之间共享状态时，它会变得棘手。 + + +Riverpod 通过易于理解的 API（如 [autodispose] 和 [keepAlive]）解决了这个问题。 +这两个 API 支持灵活且创造性的缓存策略（例如基于时间的缓存）： + + + + + +不幸的是，没有办法用原始 `InheritedWidget` 的来实现这一点，因此没有办法用 Provider 来实现。 + + +### 缺乏可靠的参数化机制 + + +Riverpod 允许其用户使用 [`.family` 修饰符]声明“参数化”提供者程序。 +事实上，这是 Riverpod 最强大的功能之一，也是其创新的核心， +例如，`.family` 它能够极大地[简化逻辑]。 + + +如果我们想使用 Provider 实现类似的东西， +我们将不得不放弃这些参数的易用性*和*类型安全性。 + + +此外，无法使用 Provider 实现类似的 `.autoDispose` 机制 +本身就阻止了 `.family` 的任何等效实现，[因为这两个功能是齐头并进的]。 + + +最后，如前所述，[事实证明]，小部件*永远*不会停止收听 `InheritedWidget`。 +这意味着如果某些提供者程序状态是“动态挂载”的， +即当使用参数构建提供者程序时，则会出现严重的内存泄漏，而这正是 `.family` 这样做的。 +因此，目前从根本上不可能获得 Provider 的 `.family` 等价物。 + + +### 测试很乏味 + + +为了能够编写测试，您*必须*在每个测试中重新定义提供者程序。 + + +默认情况下，借助 Riverpod，提供者程序已准备好在内部测试中使用。 +此外，Riverpod 还公开了一组方便的“覆盖”的工具，这些实用程序在模拟提供者程序时至关重要。 + + +测试上面的组合状态代码段非常简单，如下所示： + + + + +有关测试的详细信息，请参阅[测试]。 + + + +### 引发副作用并不简单 + + +由于 `InheritedWidget` 没有 `onChange` 回调，因此 Provider 也没有回调。 +这对于导航来说是有问题的，例如小吃栏、模态等。 + + +相反，Riverpod 只是提供 `ref.listen`，它[与 Flutter 很好地集成在一起]。 + + + + +## 转向 Riverpod + + +从概念上讲，Riverpod 和 Provider 非常相似。 +这两个包都扮演着类似的角色。两者都尝试： + + +- 缓存和处置一些有状态对象； +- 提供一种在测试期间模拟这些对象的方法； +- 为 Widget 提供了一种以简单的方式监听这些对象的方法。 + + +你可以把 Riverpod 想象成 Provider 在几年内继续成熟时的样子。 + + +### 为什么要单独建包？ + + +最初，计划发布 Provider 的主要版本，以解决上述问题。 +但随后决定反对它，因为由于新的 `ConsumerWidget` API，这将“太麻烦”甚至有争议。 +由于 Provider 仍然是最常用的 Flutter 包之一，因此决定创建一个单独的包，因此创建了 Riverpod。 + + +启用创建单独的包： + - 通过*同时*临时使用这两种方法，为任何想要迁移的人提供便利； + - 如果人们原则上不喜欢 Riverpod，或者他们觉得它还不可靠，请允许他们坚持使用 Provider； + - 实验，允许 Riverpod 搜索生产就绪的解决方案，以应对各种提供者程序的技术限制。 + + +事实上，Riverpod 旨在成为 Provider 的精神继承者。因此得名“Riverpod”（它是“Provider”的字谜，异位词）。 + + +### 破坏性变化 + + +Riverpod 唯一真正的缺点是它需要更改小部件类型才能工作： + + +- 使用 Riverpod，您应该扩展 `ConsumerWidget`，而不是扩展 `StatelessWidget`。 +- 使用 Riverpod，您应该扩展 `ConsumerStatefulWidget`，而不是扩展 `StatefulWidget`。 + + +但这种不便在宏伟的计划中是相当小的。有朝一日，这种要求可能会消失。 + + +### 选择正确的库 + + +您可能会问自己：*“那么，作为 Provider 用户，我应该使用 Provider 还是 Riverpod？”* + + +我们想非常清楚地回答这个问题： + + + 您可能应该使用 Riverpod + + +Riverpod 总体上设计得更好，可以大大简化您的逻辑。 + +[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider +[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[autodispose]: /docs/concepts/modifiers/auto_dispose +[workaround]: https://pub.dev/packages/provider#can-i-obtain-two-different-providers-using-the-same-type +[.family modifier]: /docs/concepts/modifiers/family +[keepAlive]: /docs/concepts/modifiers/auto_dispose#refkeepalive +[as these two features go hand-in-hand]: /docs/concepts/modifiers/family#prefer-using-autodispose-when-the-parameter-is-not-constant +[simplification of logic]: /docs/concepts/modifiers/family#usage +[we have to]: https://github.com/flutter/flutter/issues/128432 +[it turns out]: https://github.com/flutter/flutter/issues/106549 +[can't react when a consumer stops listening to them]: https://github.com/flutter/flutter/issues/106546 +[Testing]: /docs/cookbooks/testing +[integrates well with Flutter]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change + +[解决方法]: https://pub.dev/packages/provider#can-i-obtain-two-different-providers-using-the-same-type +[无法对消费者程序停止监听他们的情况做出反应]: https://github.com/flutter/flutter/issues/106546 +[我们必须]: https://github.com/flutter/flutter/issues/128432 +[简化逻辑]: /docs/concepts/modifiers/family#usage +[`.family` 修饰符]: /docs/concepts/modifiers/family +[因为这两个功能是齐头并进的]: /docs/concepts/modifiers/family#prefer-using-autodispose-when-the-parameter-is-not-constant +[事实证明]: https://github.com/flutter/flutter/issues/106549 +[测试]: /docs/cookbooks/testing +[与 Flutter 很好地集成在一起]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx new file mode 100644 index 000000000..43ec56b51 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./override.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart new file mode 100644 index 000000000..860020903 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/override.dart @@ -0,0 +1,16 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../combine/combine.dart'; + +/* SNIPPET START */ + +void main() { + test('it doubles the value correctly', () async { + final container = ProviderContainer( + overrides: [numberProvider.overrideWith((ref) => 9)], + ); + final doubled = container.read(doubledProvider); + expect(doubled, 9 * 2); + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart new file mode 100644 index 000000000..4a7e2062f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/override/raw.dart @@ -0,0 +1,15 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../combine/combine.dart'; + +/* SNIPPET START */ +void main() { + test('这个值将正确的翻倍', () async { + final container = ProviderContainer( + overrides: [numberProvider.overrideWith((ref) => 9)], + ); + final doubled = container.read(doubledProvider); + expect(doubled, 9 * 2); + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx new file mode 100644 index 000000000..8569e8316 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./same_type.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart new file mode 100644 index 000000000..1a2456978 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/raw.dart @@ -0,0 +1,15 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod/riverpod.dart'; + +import '../../helpers/item.dart'; + +/* SNIPPET START */ + +final itemsProvider = Provider.autoDispose( + (ref) => [], // ... +); + +final evenItemsProvider = Provider.autoDispose((ref) { + final items = ref.watch(itemsProvider); + return [...items.whereIndexed((index, element) => index.isEven)]; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart new file mode 100644 index 000000000..94a4ab086 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.dart @@ -0,0 +1,19 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../helpers/item.dart'; + +part 'same_type.g.dart'; + +/* SNIPPET START */ + +@riverpod +List items(ItemsRef ref) { + return []; // ... +} + +@riverpod +List evenItems(EvenItemsRef ref) { + final items = ref.watch(itemsProvider); + return [...items.whereIndexed((index, element) => index.isEven)]; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart new file mode 100644 index 000000000..510d91a68 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/same_type/same_type.g.dart @@ -0,0 +1,133 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'same_type.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ItemsRef = Ref>; + +@ProviderFor(items) +const itemsProvider = ItemsProvider._(); + +final class ItemsProvider + extends $FunctionalProvider, List, ItemsRef> + with $Provider, ItemsRef> { + const ItemsProvider._( + {List Function( + ItemsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'itemsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + ItemsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$itemsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ItemsProvider $copyWithCreate( + List Function( + ItemsRef ref, + ) create, + ) { + return ItemsProvider._(create: create); + } + + @override + List create(ItemsRef ref) { + final _$cb = _createCb ?? items; + return _$cb(ref); + } +} + +String _$itemsHash() => r'f0a8fa6874f4868db9ead31e82c75d976f9d2033'; + +typedef EvenItemsRef = Ref>; + +@ProviderFor(evenItems) +const evenItemsProvider = EvenItemsProvider._(); + +final class EvenItemsProvider + extends $FunctionalProvider, List, EvenItemsRef> + with $Provider, EvenItemsRef> { + const EvenItemsProvider._( + {List Function( + EvenItemsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'evenItemsProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + EvenItemsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$evenItemsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + EvenItemsProvider $copyWithCreate( + List Function( + EvenItemsRef ref, + ) create, + ) { + return EvenItemsProvider._(create: create); + } + + @override + List create(EvenItemsRef ref) { + final _$cb = _createCb ?? evenItems; + return _$cb(ref); + } +} + +String _$evenItemsHash() => r'82b4525e91604745f2b4664531b32d4aff5717d4'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx new file mode 100644 index 000000000..f4797a94f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./side_effects.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart new file mode 100644 index 000000000..61f016870 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/raw.dart @@ -0,0 +1,24 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../auto_dispose/auto_dispose.dart'; + +/* SNIPPET START */ + +class DiceRollWidget extends ConsumerWidget { + const DiceRollWidget({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(diceRollProvider, (previous, next) { + ScaffoldMessenger.of(context).showSnackBar( + SnackBar(content: Text('Dice roll! We got: $next')), + ); + }); + return TextButton.icon( + onPressed: () => ref.invalidate(diceRollProvider), + icon: const Icon(Icons.casino), + label: const Text('Roll a dice'), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart new file mode 100644 index 000000000..61f016870 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/motivation/side_effects/side_effects.dart @@ -0,0 +1,24 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../auto_dispose/auto_dispose.dart'; + +/* SNIPPET START */ + +class DiceRollWidget extends ConsumerWidget { + const DiceRollWidget({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.listen(diceRollProvider, (previous, next) { + ScaffoldMessenger.of(context).showSnackBar( + SnackBar(content: Text('Dice roll! We got: $next')), + ); + }); + return TextButton.icon( + onPressed: () => ref.invalidate(diceRollProvider), + icon: const Icon(Icons.casino), + label: const Text('Roll a dice'), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx new file mode 100644 index 000000000..5b940ff80 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/provider_vs_riverpod.mdx @@ -0,0 +1,653 @@ +--- +title: Provider 对比 Riverpod +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import family from "./family"; +import { + trimSnippet, + AutoSnippet, + When, +} from "@site/src/components/CodeSnippet"; + + + +本文将介绍 Provider 和 Riverpod 之间的差异和相似之处。 + + +## 定义提供者程序 + + +这两个包之间的主要区别在于如何定义“提供者程序”。 + + +对于 [Provider]，提供者程序是小部件，因此放置在小部件树中，通常位于 `MultiProvider`： + +```dart +class Counter extends ChangeNotifier { + ... +} + +void main() { + runApp( + MultiProvider( + providers: [ + ChangeNotifierProvider(create: (context) => Counter()), + ], + child: MyApp(), + ) + ); +} +``` + + +使用 Riverpod，提供者程序**不是**小部件。相反，它们是普通的 Dart 对象。 +同样，提供者程序在小部件树之外定义，而且声明为全局 final 变量。 + + +此外，要使 Riverpod 正常工作，必须在整个应用程序上方添加一个小 `ProviderScope` 部件。 +因此，使用 Riverpod 和 Provider 示例等效的版本为： + +```dart +// provider 现在是顶级变量 +final counterProvider = ChangeNotifierProvider((ref) => Counter()); + +void main() { + runApp( + // 该小部件为整个项目启用了 Riverpod + ProviderScope( + child: MyApp(), + ), + ); +} +``` + + +请注意，这个 ChangeNotifierProvider 的定义只是向上移动了几行。 + +:::info + +由于 Riverpod 的提供者程序是普通的 Dart 对象，因此可以在没有 Flutter 的情况下使用 Riverpod。 +例如，Riverpod 可用于编写命令行应用程序。 +::: + + +## 读取提供者程序：使用 BuildContext + + +使用 Provider 库，读取提供者程序的一种方法是使用 Widget 的 `BuildContext`。 + + +例如，如果 provider 定义为： + +```dart +Provider(...); +``` + + +然后使用 [Provider] 读取它就可以这样做： + +```dart +class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + Model model = context.watch(); + + } +} +``` + + +在 Riverpod 中的等效代码是： + +```dart +final modelProvider = Provider(...); + +class Example extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + Model model = ref.watch(modelProvider); + + } +} +``` + + +请注意： + + +- Riverpod 的代码片段是扩展 `ConsumerWidget` 的，而不是 `StatelessWidget`。 + 不同的小部件类型为我们的 `build` 函数添加了一个额外的参数：`WidgetRef`。 + + +- 在 Riverpod 中我们使用 `WidgetRef.watch` 代替 `BuildContext.watch`， + `WidgetRef` 是我们从 `ConsumerWidget` 拿到的。 + + +- Riverpod 不依赖于泛型类型。相反，它依赖于使用提供者程序定义创建的变量。 + + +还要注意措辞的相似程度。Provider 和 Riverpod 都使用关键字“watch”来描述“当值更改时，这里的小部件应重新生成”。 + +:::info + +Riverpod 使用与 Provider 相同的术语来读取提供者程序。 + +- `BuildContext.watch` -> `WidgetRef.watch` +- `BuildContext.read` -> `WidgetRef.read` +- `BuildContext.select` -> `WidgetRef.watch(myProvider.select)` + + +`context.watch` 相对于 `context.read` 的规则也适用于 Riverpod： +在 `build` 方法中，使用 “watch”。在单击处理程序和其他事件中，使用 “read”。 +当需要过滤掉值并重新生成时，请使用 “select”。 +::: + + +## 读取提供者程序：使用 Consumer + + +Provider 可以选择附带一个名为 `Consumer`（以及名为 `Consumer2` 的变体）的小部件，用于读取提供者程序。 + + +`Consumer` 作为性能优化很有帮助，它允许对小部件树进行更精细的重建 - 在状态更改时仅更新相关的小部件： + + +因此，如果一个 provider 被定义为： + +```dart +Provider(...); +``` + + +Provider 允许使用 `Consumer` 读取这个 provider： + +```dart +Consumer( + builder: (BuildContext context, Model model, Widget? child) { + + } +) +``` + + +Riverpod 也有同样的原理。Riverpod 也有一个以完全相同功能的 `Consumer` 小部件。 + + +如果我们将一个 provider 定义为： + +```dart +final modelProvider = Provider(...); +``` + + +然后我们可以使用 `Consumer` 实现： + +```dart +Consumer( + builder: (BuildContext context, WidgetRef ref, Widget? child) { + Model model = ref.watch(modelProvider); + + } +) +``` + + +注意 `Consumer` 是如何给我们一个 `WidgetRef` 对象。这与我们在上一部分中看到的 `ConsumerWidget` 与相关的对象相同。 + + +### Riverpod 中没有 `ConsumerN` 等效的类 + + +请注意，在 Riverpod 中不需要 pkg:Provider 的 `Consumer2`、`Consumer3` 等，也不要遗漏重构它们。 + + +使用 Riverpod，如果要从多个提供者程序读取值，只需编写多个 ref.watch 语句即可，如下所示： + +```dart +Consumer( + builder: (context, ref, child) { + Model1 model = ref.watch(model1Provider); + Model2 model = ref.watch(model2Provider); + Model3 model = ref.watch(model3Provider); + // ... + } +) +``` + + +与 pkg:Provider 的 `ConsumerN` API 相比，上述解决方案感觉不那么沉重，应该更容易理解。 + + +## 组合提供者程序：ProxyProvider 与无状态对象 + + +使用 Provider 时，组合提供者程序的官方方法是使用 `ProxyProvider` widget（或变体，例如 `ProxyProvider2`）。 + + +例如，我们可以定义： + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +ChangeNotifierProvider(create: (context) => UserIdNotifier()), +``` + + +在这里我们有两个选择。我们可以组合 `UserIdNotifier` 创建一个新的“无状态”提供者程序 +（通常是一个可能覆盖 == 的不可变值）。如： + +```dart +ProxyProvider( + update: (context, userIdNotifier, _) { + return 'The user ID of the the user is ${userIdNotifier.userId}'; + } +) +``` + + +每当 `UserIdNotifier.userId` 发生更改时，这个提供者程序都会自动返回新的 `String` 值。 + + +我们可以在 Riverpod 中做类似的事情，但语法不同。 +首先，在 Riverpod 中，我们的 `UserIdNotifier` 定义是： + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +final userIdNotifierProvider = ChangeNotifierProvider( + (ref) => UserIdNotifier(), +); +``` + + +那样的话，要基于 `userId` 生成 `String`，我们可以这样做： + +```dart +final labelProvider = Provider((ref) { + UserIdNotifier userIdNotifier = ref.watch(userIdNotifierProvider); + return 'The user ID of the the user is ${userIdNotifier.userId}'; +}); +``` + + +请注意这行 ref.watch(userIdNotifierProvider) 做的事。 + + +这行代码告诉 Riverpod 获取 `userIdNotifierProvider` 的内容， +并且每当该值发生变化时， `labelProvider` 也会重新计算。 +因此，每当 `userId` 更改时， +我们 `labelProvider` 发出的 `String` 都会自动更新。 + + +这行 `ref.watch` 应该感觉很熟悉。 +之前在解释[如何在小部件中读取提供者程序](#读取-providersbuildcontext)时已经介绍了这个模式。 +事实上，提供者程序现在能够与小部件以相同的方式监听其他提供者程序的改变。 + + +## 组合提供者程序：ProxyProvider 与有状态对象 + + +组合提供者程序时，另一个替代用例是公开有状态对象，例如 `ChangeNotifier` 实例。 + + +为此，我们可以使用 `ChangeNotifierProxyProvider`（或变体，例如 `ChangeNotifierProxyProvider2`）。 +例如，我们可以定义： + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +ChangeNotifierProvider(create: (context) => UserIdNotifier()), +``` + + +然后，我们可以定义基于 `UserIdNotifier.userId` 的一个 `ChangeNotifier`。 +例如，我们可以这样做： + +```dart +class UserNotifier extends ChangeNotifier { + String? _userId; + + void setUserId(String? userId) { + if (userId != _userId) { + print('The user ID changed from $_userId to $userId'); + _userId = userId; + } + } +} + +// ... + +ChangeNotifierProxyProvider( + create: (context) => UserNotifier(), + update: (context, userIdNotifier, userNotifier) { + return userNotifier! + ..setUserId(userIdNotifier.userId); + }, +); +``` + + +这个新提供者程序会创建一个 `UserNotifier` 实例（它永远不会重新构造）， +并在用户 ID 更改时打印一个字符串。 + + +在提供者程序中执行相同的操作是以不同的方式实现的。 +首先，在 Riverpod 中，我们的 `UserIdNotifier` 是这样定义的： + +```dart +class UserIdNotifier extends ChangeNotifier { + String? userId; +} + +// ... + +final userIdNotifierProvider = ChangeNotifierProvider( + (ref) => UserIdNotifier(), +), +``` + + +相比于上面 `ChangeNotifierProxyProvider` 的等价代码将是： + +```dart +class UserNotifier extends ChangeNotifier { + String? _userId; + + void setUserId(String? userId) { + if (userId != _userId) { + print('The user ID changed from $_userId to $userId'); + _userId = userId; + } + } +} + +// ... + +final userNotifierProvider = ChangeNotifierProvider((ref) { + final userNotifier = UserNotifier(); + ref.listen( + userIdNotifierProvider, + (previous, next) { + if (previous?.userId != next.userId) { + userNotifier.setUserId(next.userId); + } + }, + ); + + return userNotifier; +}); +``` + + +这个片段的核心是 `ref.listen` 这行代码。 +这里的 `ref.listen` 函数是一个实用程序，它允许监听一个提供者程序， +并在提供者程序更改时执行函数。 + + +该函数的 `previous` 和 `next` 参数对应于提供者程序更改前的最后一个值和更改后的新值。 + + +## 作用域提供者程序与 `.family` + `.autoDispose` + + +在 pkg:Provider 中，作用域用于两件事： + - 离开页面时处置状态 + - 每页具有自定义状态 + + +仅使用作用域来破坏状态并不理想。 +问题在于，作用域在大型应用程序上效果不佳。 +例如，状态通常在一个页面中创建，但在导航后稍后在另一个页面中处置。 +这不允许多个缓存在不同的页面上处于活动状态。 + + +同样，如果需要与小部件树的另一部分共享状态， +“自定义每个页面状态”的方法很快就会变得难以处理， +就像你需要模态或多步骤表单一样。 + + +Riverpod 采取了不同的方法：首先，不鼓励使用作用域提供者； +其次， `.family` 和 `.autoDispose` 是完整的替代解决方案。 + + +在 Riverpod 中，当一个提供者程序标记为 `.autoDispose` 在不再使用时会自动处置的状态。 +当卸载最后一个删除提供者程序的小部件时，Riverpod 将检测到卸载并处置提供者程序。 +尝试在提供者程序中使用以下两种生命周期方法来测试此行为： + +```dart +ref.onCancel((){ + print("我一个监听程序都没有了！"); +}); +ref.onDispose((){ + print("如果我已经被定义为 `.autoDispose`，我将被处置！"); +}); +``` + + +这从本质上解决了“破坏状态”问题。 + + +此外，还可以将提供者程序标记为 `.family`（同时，也可以标记为 `.autoDispose`）。 +这样就可以将参数传递给提供者程序，从而在内部生成和跟踪多个提供者程序。 +换句话说，在传递参数时，*会为每个唯一参数创建一个唯一状态*。 + + + + + +这解决了“每页自定义状态”问题。实际上，还有另一个优点：这种状态不再绑定到一个特定的页面。 +相反，如果不同的页面尝试访问相同的状态，则该页面只需重用参数即可实现。 + + +在许多方面，将参数传递给提供者程序等同于 Map 的键。 +如果键相同，则获取的值相同。如果是不同的键，则将获得不同的状态。 + +[provider]: https://pub.dev/packages/provider +[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider +[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[autodispose]: /docs/concepts/modifiers/auto_dispose +[workaround]: https://pub.dev/packages/provider#can-i-obtain-two-different-providers-using-the-same-type +[.family modifier]: /docs/concepts/modifiers/family +[keepAlive]: /docs/concepts/modifiers/auto_dispose#refkeepalive +[as these two features go hand-in-hand]: /docs/concepts/modifiers/family#prefer-using-autodispose-when-the-parameter-is-not-constant +[simplification of logic]: /docs/concepts/modifiers/family#usage +[we have to]: https://github.com/flutter/flutter/issues/128432 +[it turns out]: https://github.com/flutter/flutter/issues/106549 +[*can't* react when a consumer stops listening to them]: https://github.com/flutter/flutter/issues/106546 +[integrates well with Flutter]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change +[ChangeNotifierProvider]: /docs/providers/change_notifier_provider +[Code generation]: /docs/about_code_generation +[AsyncNotifiers]: /docs/providers/notifier_provider +[combining Providers]: /docs/concepts/combining_providers +[global final variable]: /docs/concepts/providers#creating-a-provider diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx new file mode 100644 index 000000000..d98512916 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx @@ -0,0 +1,399 @@ +--- +title: 快速开始 +--- + +:::info +译者注：在此章节中，由于 Provider 库，Provider 类，Provider 及其相关的提供者程序类容易造成混淆，一般的，我们约定： +- Provider 库 -> `pkg:Provider` / `Provider`，和 Riverpod 一样首字母大写。 +- Provider 类 -> `provider`，小写，特指单纯的提供者程序类 Provider。 +- Provider 泛指 -> `提供者程序`，表示各种不同的提供者程序类都适用。 + +其他地方的代指某个 provider，会被具体翻译，避免不必要的误解，请放心阅读。 +如有翻译错误还请 pr 指正。 +::: + + +本部分专为熟悉 [Provider] 包并希望了解 Riverpod 的人员而设计。 + + +首先，请阅读简短的[入门指南]文章，并尝试使用小型[沙盒]示例来测试 Riverpod 的功能。 +如果您喜欢那里看到的内容，那么您应该明确考虑迁移。 + + +事实上，从 Provider 迁移到 Riverpod 可以非常简单。 + + +迁移基本上包括几个步骤，这些步骤可以以*增量*方式完成。 + + +## 从 `ChangeNotifierProvider` 开始 + + +在过渡到 Riverpod 时是可以的继续使用，而不是尽快使用 `ChangeNotifier` 其最新的花哨功能。 + + +事实上，可以从以下几点着手开始： + +```dart +// 如果你有这个…… +class MyNotifier extends ChangeNotifier { + int state = 0; + + void increment() { + state++; + notifyListeners(); + } +} + +// ……只需要加上这个！ +final myNotifierProvider = ChangeNotifierProvider((ref) { + return MyNotifier(); +}); +``` + + +正如你所看到的，Riverpod 公开了一个 [ChangeNotifierProvider] 类， +该类正是为了支持从 pkg:Provider 迁移。 + + +请记住，在编写新代码时不建议使用 `ChangeNotifierProvider`，因为它不是使用 Riverpod 的最佳方式， +但它是开始迁移的一种温和且非常简单的方法。 + +:::tip + +不要急于*立即*尝试将您的 `ChangeNotifier` 迁移到更现代的 [Riverpod 的提供者程序]。 +有些地方会进行一些泛型的转变，因此最初可能很难做到。 + + +慢慢来，因为首先熟悉 Riverpod 很重要； +你很快就会发现，几乎所有来自 pkg:provider 的提供者程序在 pkg:riverpod 中都有严格等价的代码。 +::: + + +## 从*叶子*开始 + + +从不依赖于其他任何内容的提供者程序开始，即从依赖项树中的*叶子*开始。 +迁移完所有叶子后，可以转到依赖于叶子的提供者程序。 + + +换言之，首先要避免迁移 `ProxyProvider`；当迁移了它们的所有依赖项，就可以开始处理它们了。 + + +这应该促进和简化迁移过程，同时还可以最大限度地减少/跟踪任何错误。 + + + +## Riverpod 和 Provider 可以共存 + + + +*请记住，完全可以同时使用 Provider 和 Riverpod。* + + +事实上，使用导入别名，可以同时使用两个 API 了。 +这也非常有助于提高可用性，并消除了任何模棱两可的 API 用法。 + + +如果计划执行此操作，请考虑对代码库中的每个提供者程序导入使用导入别名。 + +:::info + +关于如何有效实现导入别名的完整指南即将发布。 +::: + + + +## 您*不必*立即使用 `Consumer` + + +请务必记住，无需*立即*使用 [Riverpod 的 `Consumer` API]。 +如果您刚刚开始迁移，[如上所述]，您可能应该从 `ChangeNotifierProvider` 开始。 + + +考虑上面定义的 `myNotifierProvider`。 + + +由于您的内部代码可能依赖于 pkg:Provider 的 API，因此请使用以下代码开始使用 pkg:Riverpod 的 `ChangeNotifier`。 + +```dart +MultiProvider( + providers: [ + ChangeNotifierProvider.value(value: ref.watch(myNotifierProvider.notifier)), + ] +) +``` + + +这样，最初只需将根 Widget 转换为 `ConsumerWidget`。 +这应该会进一步简化向 pkg:Riverpod 的迁移。 + + + +## 一次迁移一个提供者程序 + + +如果您已有应用，请不要尝试一次迁移所有的提供者程序！ + + +虽然从长远来看，您应该努力将所有应用程序迁移到 Riverpod，**但不要让自己筋疲力尽**。 +一次只迁移一个提供者程序。 + + +以上面的例子为例。将其 `myNotifierProvider` **完全**迁移到 Riverpod 意味着需要编写以下内容： + +```dart +class MyNotifier extends Notifier { + @override + int build() => 0; + + void increment() => state++; +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); +``` + + +……并且_还_需要更改这个 `myNotifierProvider` 的使用方式，即每个 `context.watch` 的位置替换为 `ref.watch`。 + + +此操作可能需要一些时间，并可能导致一些错误，因此不要急于一次完成所有操作。 + + +## 迁移 `ProxyProvider` + + +在 pkg:Provider 中，`ProxyProvider` 用于组合来自其他提供者程序的值； +它的构建被动地取决于其他提供者程序的价值。 + + +相反，在 Riverpod 中，提供者程序[默认是可组合的]； +因此，在迁移 `ProxyProvider` 时，如果要声明从一个提供者程序到另一个提供者程序的直接依赖项，则只需编写 `ref.watch` 即可。 + + +如果有的话，将值与 Riverpod 相结合应该感觉更简单明了；因此，迁移应该大大简化代码。 + + +此外，将两个以上的提供者程序组合在一起没有任何障碍：只需添加另一个 `ref.watch`，就可以了。 + + +## 预先初始化 + + +由于 Riverpod 的提供者程序是全局 final 变量，因此它们[默认是懒加载的]。 + + +如果您需要在启动时初始化一些预热数据或有用的服务， +最好的做法是首次读取提供者程序的时候，您手动去设置 `MultiProvider`。 + + +换句话说，由于 Riverpod 不能被强制预先初始化，因此可以在启动阶段读取和缓存它们， +以便在应用程序的其余部分需要时它们完成了初始化并准备就绪。 + + +有关 pkg:Riverpod 提供者程序的快速初始化的完整指南 [可在此处获得]。 + + +## 代码生成 + + +建议使用[代码生成]，以便以*面向未来*的方式使用 Riverpod。 +顺便说一句，当元编程成为现实的时候，代码生成很可能是 Riverpod 的默认代码。 + + +不幸的是， `@riverpod` 无法为 `ChangeNotifierProvider` 生成代码。 +要解决此问题，您可以使用以下实用程序扩展方法： + +```dart +extension ChangeNotifierWithCodeGenExtension on Ref { + T listenAndDisposeChangeNotifier(T notifier) { + notifier.addListener(notifyListeners); + onDispose(() => notifier.removeListener(notifyListeners)); + onDispose(notifier.dispose); + return notifier; + } +} +``` + + +然后，您可以使用以下代码生成语法公开您的 `ChangeNotifier`： + +```dart +// ignore_for_file: unsupported_provider_value +@riverpod +MyNotifier example(ExampleRef ref) { + return ref.listenAndDisposeChangeNotifier(MyNotifier()); +} +``` + + +完成“基本”迁移后，您可以将 `ChangeNotifier` 更改为 `Notifier`，从而消除了临时扩展的需要。 +以前面的示例为例，“完全迁移” `Notifier` 变为： + +```dart +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() => 0; + + void increment() => state++; +} +``` + + +一旦完成此操作，并且您确信代码库中不再有 `ChangeNotifierProvider`，您就可以彻底摆脱临时扩展。 + + +请记住，虽然是推荐的，但代码生成不是*强制性的*。 +以增量方式进行迁移是个好的选择： +如果您觉得在一次转换到代码生成语法的*同时*实现此迁移可能太麻烦了，*别勉强*。 + + +按照本指南，您*可以*稍后做进一步的迁移到代码生成。 + +[getting started]: /docs/introduction/getting_started +[sandbox]: https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2 +[provider]: https://pub.dev/packages/provider +[ChangeNotifierProvider]: /docs/providers/change_notifier_provider +[Code generation]: /docs/concepts/about_code_generation +[Riverpod's providers]: /docs/providers/notifier_provider +[are composable by default]: /docs/from_provider/motivation#combining-providers-is-hard-and-error-prone +[as mentioned above]: /docs/from_provider/quickstart#start-with-changenotifierprovider +[Riverpod's `Consumer` APIs]: /docs/concepts/reading +[lazy by default]: /docs/concepts/provider_lifecycles + +[入门指南]: /docs/introduction/getting_started +[沙盒]: https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2 + +[默认是可组合的]: /docs/from_provider/motivation#combining-providers-is-hard-and-error-prone +[如上所述]: /docs/from_provider/quickstart#从-changenotifierprovider-开始 +[Riverpod 的 `Consumer` API]: /docs/concepts/reading +[默认是懒加载的]: /docs/concepts/provider_lifecycles +[代码生成]: /docs/concepts/about_code_generation +[Riverpod 的提供者程序]: /docs/providers/notifier_provider \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started.mdx deleted file mode 100644 index 9287f10af..000000000 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started.mdx +++ /dev/null @@ -1,189 +0,0 @@ ---- -title: 开始上手 -version: 3 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import pubspec from "./getting_started/pubspec"; -import dartHelloWorld from "./getting_started/dart_hello_world"; -import pubadd from "./getting_started/pub_add"; -import helloWorld from "./getting_started/hello_world"; -import dartPubspec from "./getting_started/dart_pubspec"; -import dartPubadd from "./getting_started/dart_pub_add"; -import { - trimSnippet, - AutoSnippet, - When, -} from "../../../../src/components/CodeSnippet"; - ---- - -## 在线尝试 Riverpod - -在 [Dartpad](https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2) 上感受 Riverpod 的魅力。 - -## 安装包文件 - -当你确定好你想要安装的包文件后，像这样继续将依赖添加到你的应用中： - - - - - - - - - - - - - - - - -当然，你也可以手动将依赖添加到应用中的`pubspec.yaml`： - - - - - - -然后使用 `flutter pub get` 命令来安装包文件。 - - - 最后，运行代码生成器 {" "} - flutter pub run build_runner watch - - - - - - - -然后使用 `dart pub get` 命令来安装包文件。 - - - 最后，运行代码生成器 {" "} - flutter pub run build_runner watch - - - - - -就是这样，你已成功将 [Riverpod] 添加到你的应用当中! - -## 启用 riverpod_lint/custom_lint - -Riverpod 附带一个可选的 [riverpod_lint] 包， -它提供了lint规则来帮助你编写更好的代码且提供了一些自定义重构选项。 - -如果遵循了上一步骤，那你应该已经安装好这个包了，但需要额外的步骤来启用它。 - -为了开启 [riverpod_lint]，你需要向你的 `pubspc.yaml` 旁边新建一个 `analysis_options.yaml` 配置 -并包含下面的内容： - - - {`analyzer: - plugins: - - custom_lint`} - - -如果你使用riverpod并在代码中写错了，那么就会在IDE中看到一些警告信息。 - -前往 [riverpod_lint] 页面查看更多关于警告信息和重构的内容。 - -:::note -用 `dart analyze` 命令这些警告不会显示。 -如果你想在CI或者终端中检查这些警告信息，你可以运行： - -```sh -dart run custom_lint -``` - -::: - -## 使用示例: Hello world - -安装完 [Riverpod]，我们就可以使用了。 - -下面的代码片段展示了如何使用我们的新依赖来创建一个 "Hello world"： - -export const foo = 42; - - - - - - -你可以使用 `flutter run` 命令来运行。 -这会在你的设备上渲染 "Hello world" 的文字。 - - - - - - -你可以使用 `dart lib/main.dart` 命令来运行。 -这会在你的控制台打印 "Hello world" 的字样。 - - - - -## 更进一步：安装代码片段插件 - -如果你使用 `Flutter` 和 `VS Code`，推荐使用 [Flutter Riverpod Snippets](https://marketplace.visualstudio.com/items?itemName=robert-brunhage.flutter-riverpod-snippets) - -如果你使用 `Flutter` 和 `Android Studio` 或 `IntelliJ`，推荐使用 [Flutter Riverpod Snippets](https://plugins.jetbrains.com/plugin/14641-flutter-riverpod-snippets) - -![img](/img/snippets/greetingProvider.gif) - -## 选择你的下一步 - -学习一些基础的概念: - -- [了解更多关于 provider 的内容](/docs/concepts/providers) - -遵循专题手册： - -- [如何测试 provider](/docs/cookbooks/testing) - -[riverpod]: https://github.com/rrousselgit/riverpod -[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod -[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod -[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks -[riverpod_lint]: https://pub.dev/packages/riverpod_lint diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_pub_add.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_pub_add.tsx deleted file mode 100644 index 73bf922c8..000000000 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_pub_add.tsx +++ /dev/null @@ -1,10 +0,0 @@ -const raw = "dart pub add riverpod dev:custom_lint dev:riverpod_lint"; - -const codegen = "dart pub add riverpod dev:custom_lint dev:riverpod_lint riverpod_annotation dev:build_runner dev:riverpod_generator"; - -export default { - raw, - hooks: raw, - codegen, - hooksCodegen: codegen, -}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/pub_add.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/pub_add.tsx deleted file mode 100644 index e72171523..000000000 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/pub_add.tsx +++ /dev/null @@ -1,14 +0,0 @@ -const raw = "flutter pub add flutter_riverpod dev:custom_lint dev:riverpod_lint"; - -const codegen = "flutter pub add flutter_riverpod dev:custom_lint dev:riverpod_lint riverpod_annotation dev:build_runner dev:riverpod_generator"; - -const hooks = "flutter pub add hooks_riverpod dev:custom_lint dev:riverpod_lint"; - -const hooksCodegen = "flutter pub add hooks_riverpod dev:custom_lint dev:riverpod_lint riverpod_annotation dev:build_runner dev:riverpod_generator"; - -export default { - raw: raw, - hooks: hooks, - codegen: codegen, - hooksCodegen: hooksCodegen -}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction.mdx deleted file mode 100644 index c0d1c81dd..000000000 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: 介绍 ---- - ---- - -## 什么是 Riverpod? - -Riverpod ([Provider](https://pub.dev/packages/provider) 的回文) 是 Flutter / Dart 平台的一个响应式缓存框架。它能自动获取、缓存、合并和计算网络请求，同时还会为你处理错误。 - -## 动机 - -现代的应用程序很少带有用户界面所需要的所有信息。一般来说，那些数据会从服务器异步获取。 - -但问题是，处理异步代码是比较困难的。虽然说 Flutter 本身提供了一些存储状态的方法，但除此之外， -它并没有其他额外的功能。因此，有许多问题仍然没有解决方案： - -- 异步请求需要在本地缓存，因为只要 UI 刷新就重新执行请求的做法是不合理的。 -- 由于缓存的存在，如果我们不小心可能会导致缓存过期。 -- 我们也需要处理错误和加载中的各种状态。 - -大规模解决问题会比较困难，而且它们受到了许多功能的影响，比如： - -- 下拉刷新 -- 列表滚动加载 -- 在键入时搜索 -- 异步请求防抖 -- 当不再需要时取消异步请求 -- 积极的界面更新 -- 离线模式 -- ... - -虽然实现这些功能很棘手，但这对一个良好的用户体验至关重要。 -然而很少有其他包文件试图直接解决这些问题，而且大量的样板代码需要手工完成。 - -这就是 Riverpod 的由来。 -受 Flutter 组件的启发，Riverpod 尝试通过一种独特的方式来写业务逻辑，进而来解决这些问题。 -对于状态来说，在许多方面 Riverpod 都可以类比于组件。 - -采用这种新的方式，上述复杂的功能大多都已默认被实现。你要做的只不过是关注 UI 实现。 - -不信？这里有一个例子。下面的代码片段是使用 Riverpod 的一个简化的 [Pub.dev](https://github.com/rrousselGit/riverpod/tree/master/examples/pub) -客户端应用。 - -```dart -// 从 pub.dev 获取包文件列表 -@riverpod -Future> fetchPackages( - FetchPackagesRef ref, { - required int page, - String search = '', -}) async { - final dio = Dio(); - // 请求 API。这里我们用了 dio，当然你也可以使用任何其他的网络请求库。 - final response = await dio.get( - 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', - ); - - // 将返回的 JSON 解码到 Dart 的对象。 - final json = response.data as List; - return json.map(Package.fromJson).toList(); -} -``` - -这段代码就是你要实现 “在键入时搜索” + “下拉刷新” + “无限列表” 功能所需的全部业务逻辑，同时还可以处理错误及加载中的状态。 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx new file mode 100644 index 000000000..42aadaa34 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started.mdx @@ -0,0 +1,296 @@ +--- +title: 入门指南 +pagination_next: essentials/first_request +version: 4 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import CodeBlock from "@theme/CodeBlock"; +import pubspec from "./getting_started/pubspec"; +import dartHelloWorld from "./getting_started/dart_hello_world"; +import pubadd from "./getting_started/pub_add"; +import helloWorld from "./getting_started/hello_world"; +import dartPubspec from "./getting_started/dart_pubspec"; +import dartPubadd from "./getting_started/dart_pub_add"; +import { + AutoSnippet, + When, +} from "@site/src/components/CodeSnippet"; +import { Link } from "@site/src/components/Link"; + + +## 在线尝试 Riverpod + + +要尝试 Riverpod，请在 [Dartpad](https://dartpad.dev/?null_safety=true&id=ef06ab3ce0b822e6cc5db0575248e6e2) +或 [Zapp](https://zapp.run/new) 上在线试用： + + + + +## 安装包 + + +知道要安装哪个包后，请继续在一行中将依赖项添加到应用，如下所示： + + + + + + + + + + + + + + + + + +或者，您可以从以下 pubspec.yaml 位置手动将依赖项添加到您的应用： + + + + + + + +然后，使用 `flutter pub get` 安装包。 + + + + 现在你可以运行代码生成工具 {" "} + dart run build_runner watch. + + + + + + + + +然后，使用 `dart pub get` 安装包。 + + + + 现在你可以运行代码生成工具 {" "} + dart run build_runner watch. + + + + + + +就是这样。你已将 [Riverpod] 添加到你的应用中！ + + +## 启用 riverpod_lint/custom_lint + + +Riverpod 附带一个可选的 riverpod_lint 包， +该包提供 lint 规则以帮助您编写更好的代码， +并提供自定义重构选项。 + + +如果按照前面的步骤操作，则应该已经安装了该包， +但需要单独的步骤才能启用它。 + + +要启用riverpod_lint，您需要在 `pubspec.yaml` 文件的旁边添加一个 +`analysis_options.yaml` 文件，并包含以下内容： + + + {`analyzer: + plugins: + - custom_lint`} + + + +现在，如果在代码库中使用 Riverpod 时出错，您应该会在 IDE 中看到警告。 + + +要查看警告和重构的完整列表，请前往 [riverpod_lint] 页面。 + + +:::note +这些警告不会显示在 `dart analyze` 命令的结果中。 +如果要在 CI 或终端中检查这些警告，可以运行以下命令： + +```sh +dart run custom_lint +``` + +::: + + +## 使用示例：Hello world + + +现在我们已经安装了 [Riverpod]，我们可以开始使用它了。 + + +以下代码片段展示了如何使用我们的新依赖项来创建 “Hello world”： + +export const foo = 42; + + + + + + + +然后，使用 `flutter run` 启动应用程序。 +这将在您的设备上呈现 “Hello world”。 + + + + + + + +然后，使用 `dart lib/main.dart` 启动应用程序。 +这将在控制台中打印 “Hello world”。 + + + + + +## 更进一步：安装代码片段 + + +如果你使用的 `Flutter` 是 `VS Code` ，请考虑使用 [Flutter Riverpod Snippets](https://marketplace.visualstudio.com/items?itemName=robert-brunhage.flutter-riverpod-snippets) + + +如果您使用的 `Flutter` 是 `Android Studio` 或 `IntelliJ` ，请考虑使用 [Flutter Riverpod Snippets](https://plugins.jetbrains.com/plugin/14641-flutter-riverpod-snippets) + +![img](/img/snippets/greetingProvider.gif) + + +## 选择你的下一步 + + +了解一些基本概念： + +- + + +跟着教程走： + +- + +[riverpod]: https://github.com/rrousselgit/riverpod +[hooks_riverpod]: https://pub.dev/packages/hooks_riverpod +[flutter_riverpod]: https://pub.dev/packages/flutter_riverpod +[flutter_hooks]: https://github.com/rrousselGit/flutter_hooks +[riverpod_lint]: https://pub.dev/packages/riverpod_lint diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/index.tsx similarity index 100% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/index.tsx rename to website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/index.tsx diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart new file mode 100644 index 000000000..f2467e886 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.dart @@ -0,0 +1,24 @@ +// ignore_for_file: avoid_print, unreachable_from_main + +/* SNIPPET START */ + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'main.g.dart'; + +// 我们创建了一个 "provider"，它可以存储一个值（这里是 "Hello world"）。 +// 通过使用提供者程序，这可以允许我们模拟或者覆盖一个暴露的值。 +@riverpod +String helloWorld(HelloWorldRef ref) { + return 'Hello world'; +} + +void main() { + // 这个对象是我们的提供者程序的状态将被存储的地方。 + final container = ProviderContainer(); + + // 多亏有了 "container"，我们可以读取我们的提供者程序。 + final value = container.read(helloWorldProvider); + + print(value); // Hello world +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart new file mode 100644 index 000000000..b5f0b20f9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/main.g.dart @@ -0,0 +1,73 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'main.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef HelloWorldRef = Ref; + +@ProviderFor(helloWorld) +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart new file mode 100644 index 000000000..4efa17abd --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_hello_world/raw.dart @@ -0,0 +1,19 @@ +// ignore_for_file: avoid_print + +/* SNIPPET START */ + +import 'package:riverpod/riverpod.dart'; + +// 我们创建了一个 "provider"，它可以存储一个值（这里是 "Hello world"）。 +// 通过使用提供者程序，这可以允许我们模拟或者覆盖一个暴露的值。 +final helloWorldProvider = Provider((_) => 'Hello world'); + +void main() { + // 这个对象是我们的提供者程序的状态将被存储的地方。 + final container = ProviderContainer(); + + // 多亏有了 "container"，我们可以读取我们的提供者程序。 + final value = container.read(helloWorldProvider); + + print(value); // Hello world +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx new file mode 100644 index 000000000..07c03cf6b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pub_add.tsx @@ -0,0 +1,32 @@ +export function buildDeps({ + deps = [], + devDeps = [], +}: { + deps?: string[]; + devDeps?: string[]; +}) { + var result = ""; + for (const dep of deps) { + result += `dart pub add ${dep}\n`; + } + + for (const dep of [...devDeps, "custom_lint", "riverpod_lint"]) { + result += `dart pub add dev:${dep}\n`; + } + + return result; +} + +const raw = buildDeps({ deps: ["riverpod"] }); + +const codegen = buildDeps({ + deps: ["riverpod", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx new file mode 100644 index 000000000..7860548a1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/dart_pubspec.tsx @@ -0,0 +1,40 @@ +import { + riverpodVersion, + riverpodAnnotationVersion, + riverpodGeneratorVersion, + riverpodLintVersion, +} from "@site/src/versions"; + +const codegen = `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + riverpod: ^${riverpodVersion} + riverpod_annotation: ^${riverpodAnnotationVersion} + +dev_dependencies: + build_runner: + custom_lint: + riverpod_generator: ^${riverpodGeneratorVersion} + riverpod_lint: ^${riverpodLintVersion} +`; + +const raw = `name: my_app_name +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + riverpod: ^${riverpodVersion} + +dev_dependencies: + custom_lint: + riverpod_lint: ^${riverpodLintVersion} +`; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart new file mode 100644 index 000000000..a6821925f --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.dart @@ -0,0 +1,46 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, unreachable_from_main + +/* SNIPPET START */ import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'main.g.dart'; + +// 我们创建了一个 "provider"，它可以存储一个值（这里是 "Hello world"）。 +// 通过使用提供者程序，这可以允许我们模拟或者覆盖一个暴露的值。 +@riverpod +String helloWorld(HelloWorldRef ref) { + return 'Hello world'; +} + +void main() { + runApp( + // 为了使小组件可以读取提供者程序， + // 我们需要将整个应用程序包装在“ProviderScope”小部件中。 + // 这是我们的提供者程序的状态将被存储的地方。 + ProviderScope( + child: MyApp(), + ), + ); +} + +// 继承父类使用 HookConsumerWidget 替代 HookWidget，这样可以获取到提供者程序的引用 +class MyApp extends HookConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 我们可以在 HookConsumerWidget 中使用钩子函数 + final counter = useState(0); + + final String value = ref.watch(helloWorldProvider); + + return MaterialApp( + home: Scaffold( + appBar: AppBar(title: const Text('Example')), + body: Center( + child: Text('$value ${counter.value}'), + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart new file mode 100644 index 000000000..b5f0b20f9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -0,0 +1,73 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'main.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef HelloWorldRef = Ref; + +@ProviderFor(helloWorld) +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx new file mode 100644 index 000000000..3f10c2a94 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/index.tsx @@ -0,0 +1,11 @@ +import raw from "!!raw-loader!./raw.dart"; +import raw_hooks from "!!raw-loader!./raw_hooks.dart"; +import codegen from "!!raw-loader!./main.dart"; +import hooksCodegen from "!!raw-loader!./hooks_codegen/main.dart"; + +export default { + raw, + hooks: raw_hooks, + codegen, + hooksCodegen: hooksCodegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart new file mode 100644 index 000000000..f6c3b3975 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.dart @@ -0,0 +1,42 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, unreachable_from_main + +/* SNIPPET START */ import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'main.g.dart'; + +// 我们创建了一个 "provider"，它可以存储一个值（这里是 "Hello world"）。 +// 通过使用提供者程序，这可以允许我们模拟或者覆盖一个暴露的值。 +@riverpod +String helloWorld(HelloWorldRef ref) { + return 'Hello world'; +} + +void main() { + runApp( + // 为了使小组件可以读取提供者程序， + // 我们需要将整个应用程序包装在“ProviderScope”小部件中。 + // 这是我们的提供者程序的状态将被存储的地方。 + ProviderScope( + child: MyApp(), + ), + ); +} + +// 继承父类使用 ConsumerWidget 替代 StatelessWidget，这样可以获取到提供者程序的引用 +class MyApp extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final String value = ref.watch(helloWorldProvider); + + return MaterialApp( + home: Scaffold( + appBar: AppBar(title: const Text('Example')), + body: Center( + child: Text(value), + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart new file mode 100644 index 000000000..b5f0b20f9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/main.g.dart @@ -0,0 +1,73 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'main.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef HelloWorldRef = Ref; + +@ProviderFor(helloWorld) +const helloWorldProvider = HelloWorldProvider._(); + +final class HelloWorldProvider + extends $FunctionalProvider + with $Provider { + const HelloWorldProvider._( + {String Function( + HelloWorldRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'helloWorldProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + HelloWorldRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$helloWorldHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + HelloWorldProvider $copyWithCreate( + String Function( + HelloWorldRef ref, + ) create, + ) { + return HelloWorldProvider._(create: create); + } + + @override + String create(HelloWorldRef ref) { + final _$cb = _createCb ?? helloWorld; + return _$cb(ref); + } +} + +String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart similarity index 52% rename from website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/raw.dart rename to website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart index 307a104e5..7ad09874f 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/getting_started/hello_world/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw.dart @@ -1,26 +1,24 @@ // ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types -/* SNIPPET START */ - -import 'package:flutter/material.dart'; +/* SNIPPET START */ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -// 우리는 값을 저장할 "provider"를 만들겁니다(여기서 값은 "Hello world"를 의미합니다). -// 프로바이더를 사용하는 것으로 값의 mock/override가 가능하게 됩니다. +// 我们创建了一个 "provider"，它可以存储一个值（这里是 "Hello world"）。 +// 通过使用提供者程序，这可以允许我们模拟或者覆盖一个暴露的值。 final helloWorldProvider = Provider((_) => 'Hello world'); void main() { runApp( - // 위젯에서 프로바이더를 사용하고 읽기위해 - // 앱 전체적으로 "ProviderScope" 위젯을 감싸줘야 합니다. - // 여기에 프로바이더의 상태가 저장됩니다. + // 为了使小组件可以读取提供者程序， + // 我们需要将整个应用程序包装在“ProviderScope”小部件中。 + // 这是我们的提供者程序的状态将被存储的地方。 ProviderScope( child: MyApp(), ), ); } -// StatelessWidget 대신에 Riverpod의 ConsumerWidget을 상속받아 사용합니다. +// 继承父类使用 ConsumerWidget 替代 StatelessWidget，这样可以获取到提供者程序的引用 class MyApp extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart new file mode 100644 index 000000000..d2d085319 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/hello_world/raw_hooks.dart @@ -0,0 +1,40 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +/* SNIPPET START */ import 'package:flutter/material.dart'; +import 'package:flutter_hooks/flutter_hooks.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +// 我们创建了一个 "provider"，它可以存储一个值（这里是 "Hello world"）。 +// 通过使用提供者程序，这可以允许我们模拟或者覆盖一个暴露的值。 +final helloWorldProvider = Provider((_) => 'Hello world'); + +void main() { + runApp( + // 为了使小组件可以读取提供者程序， + // 我们需要将整个应用程序包装在“ProviderScope”小部件中。 + // 这是我们的提供者程序的状态将被存储的地方。 + ProviderScope( + child: MyApp(), + ), + ); +} + +// 继承父类使用 HookConsumerWidget 替代 HookWidget，这样可以获取到提供者程序的引用 +class MyApp extends HookConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // 我们可以在 HookConsumerWidget 中使用钩子函数 + final counter = useState(0); + + final String value = ref.watch(helloWorldProvider); + + return MaterialApp( + home: Scaffold( + appBar: AppBar(title: const Text('Example')), + body: Center( + child: Text('$value ${counter.value}'), + ), + ), + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx new file mode 100644 index 000000000..65c7be1bd --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/pub_add.tsx @@ -0,0 +1,39 @@ +export function buildDeps({ + deps = [], + devDeps = [], +}: { + deps?: string[]; + devDeps?: string[]; +}) { + var result = ''; + for (const dep of deps) { + result += `flutter pub add ${dep}\n`; + } + + for (const dep of [...devDeps, "custom_lint", "riverpod_lint"]) { + result += `flutter pub add dev:${dep}\n`; + } + + return result; +} + +const raw = buildDeps({ deps: ["flutter_riverpod"] }); + +const codegen = buildDeps({ + deps: ["flutter_riverpod", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +const hooks = buildDeps({ deps: ["hooks_riverpod", "flutter_hooks"] }); + +const hooksCodegen = buildDeps({ + deps: ["hooks_riverpod", "flutter_hooks", "riverpod_annotation"], + devDeps: ["riverpod_generator", "build_runner"], +}); + +export default { + raw: raw, + hooks: hooks, + codegen: codegen, + hooksCodegen: hooksCodegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/pubspec.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx similarity index 79% rename from website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/pubspec.tsx rename to website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx index 0f182e500..151a203a6 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting_started/pubspec.tsx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/getting_started/pubspec.tsx @@ -4,13 +4,12 @@ import { riverpodAnnotationVersion, riverpodGeneratorVersion, riverpodLintVersion, -} from "../../../../../src/versions"; +} from "@site/src/versions"; function plain(riverpod: string) { - return ` -name: my_app_name + return `name: my_app_name environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0 <4.0.0" flutter: ">=3.0.0" dependencies: @@ -25,10 +24,9 @@ dev_dependencies: } function codegen(riverpod: string) { - return ` -name: my_app_name + return `name: my_app_name environment: - sdk: ">=2.17.0 <3.0.0" + sdk: ">=3.0.0 <4.0.0" flutter: ">=3.0.0" dependencies: @@ -47,7 +45,7 @@ dev_dependencies: export default { raw: plain(`flutter_riverpod: ^${flutterRiverpodVersion}`), - hooks: plain(`hooks_riverpod: ^${hooksRiverpodVersion}`), + hooks: plain(`hooks_riverpod: ^${hooksRiverpodVersion}\n flutter_hooks:`), codegen: codegen(`flutter_riverpod: ^${flutterRiverpodVersion}`), - hooksCodegen: codegen(`hooks_riverpod: ^${hooksRiverpodVersion}`), + hooksCodegen: codegen(`hooks_riverpod: ^${hooksRiverpodVersion}\n flutter_hooks:`), }; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx new file mode 100644 index 000000000..942359f25 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod.mdx @@ -0,0 +1,125 @@ +--- +title: 为什么选择 Riverpod？ +version: 1 +--- + +import whyRiverpod from "./why_riverpod"; +import { AutoSnippet } from "@site/src/components/CodeSnippet"; + + +## 什么是 Riverpod？ + + +Riverpod（[Provider](https://pub.dev/packages/provider) 的异序词）是 Flutter/Dart 的反应式缓存框架。 + + +Riverpod 使用声明式和反应式编程，为您处理应用程序的大部分逻辑。 +它可以通过内置的错误处理和缓存来执行网络请求，同时在必要时自动重新获取数据。 + + +## 动机 + + +现代应用程序很少提供呈现其用户界面所需的所有信息。 +相反，数据通常是从服务器异步获取的。 + + +问题是，使用异步代码很困难。 +尽管 Flutter 提供了一些创建状态变量并在更改时刷新 UI 的方法，但它仍然相当有限。 +许多挑战仍未解决： + + +- 异步请求需要在本地缓存，因为每当 UI 更新时就重新执行异步请求是不合理的。 +- 由于我们有一个缓存，如果我们不关心的话，我们的缓存可能会过时。 +- 我们还需要处理错误和加载状态。 + + +大规模解决这些问题可能很困难，并且它们会受到大量功能的影响，例如： + + +- 下拉刷新 +- 无限列表/上划加载 +- 键入时搜索 +- 对异步请求进行去抖动 +- 不再使用异步请求时取消异步请求 +- 乐观 UI （注：主动积极的更新 UI 以实现良好的用户体验） +- 离线模式 +- …… + + +这些功能可能很难实现，但对于良好的用户体验至关重要。 +然而，很少有软件包尝试直接解决这些问题，而且很多工作必须手动完成。 + + +这就是 Riverpod 的用武之地。 +Riverpod 试图通过提供一种新的、独特的业务逻辑编写方式来解决这些问题， +这种方式的灵感来自 Flutter 小部件。 +在许多方面，Riverpod 可以与小部件相媲美，但仅限于状态管理。 + + +使用这种新方法，这些复杂的功能大多是默认完成的。 +剩下的就是专注于你的 UI。 + + +不信？举个例子。 +以下代码片段是使用 Riverpod 实现的 Pub.dev 客户端应用程序的简化版本。 + + + + +此代码片段是在处理错误/加载状态时，“键入时搜索”+“下拉刷新”+“无限列表”所需的所有业务逻辑。 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart new file mode 100644 index 000000000..0e0853f30 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.dart @@ -0,0 +1,29 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +class Package { + static Package fromJson(dynamic json) { + throw UnimplementedError(); + } +} + +/* SNIPPET START */ // 从 pub.dev 获取包列表 +@riverpod +Future> fetchPackages( + FetchPackagesRef ref, { + required int page, + String search = '', +}) async { + final dio = Dio(); + // 获取 API。 这里我们使用 package:dio，但我们可以使用其他任何东西。 + final response = await dio.get>( + 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', + ); + + // 将 JSON 响应解码为 Dart 类。 + return response.data?.map(Package.fromJson).toList() ?? const []; +}/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart new file mode 100644 index 000000000..f0e4abbd9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/codegen.g.dart @@ -0,0 +1,164 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef FetchPackagesRef = Ref>>; + +@ProviderFor(fetchPackages) +const fetchPackagesProvider = FetchPackagesFamily._(); + +final class FetchPackagesProvider extends $FunctionalProvider< + AsyncValue>, FutureOr>, FetchPackagesRef> + with + $FutureModifier>, + $FutureProvider, FetchPackagesRef> { + const FetchPackagesProvider._( + {required FetchPackagesFamily super.from, + required ({ + int page, + String search, + }) + super.argument, + FutureOr> Function( + FetchPackagesRef ref, { + required int page, + String search, + })? create}) + : _createCb = create, + super( + name: r'fetchPackagesProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FutureOr> Function( + FetchPackagesRef ref, { + required int page, + String search, + })? _createCb; + + @override + String debugGetCreateSourceHash() => _$fetchPackagesHash(); + + @override + String toString() { + return r'fetchPackagesProvider' + '' + '$argument'; + } + + @$internal + @override + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); + + @override + FetchPackagesProvider $copyWithCreate( + FutureOr> Function( + FetchPackagesRef ref, + ) create, + ) { + return FetchPackagesProvider._( + argument: argument as ({ + int page, + String search, + }), + from: from! as FetchPackagesFamily, + create: ( + ref, { + required int page, + String search = '', + }) => + create(ref)); + } + + @override + FutureOr> create(FetchPackagesRef ref) { + final _$cb = _createCb ?? fetchPackages; + final argument = this.argument as ({ + int page, + String search, + }); + return _$cb( + ref, + page: argument.page, + search: argument.search, + ); + } + + @override + bool operator ==(Object other) { + return other is FetchPackagesProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$fetchPackagesHash() => r'eebf7d838a57f493fffebfd2c8d8ab76d3233165'; + +final class FetchPackagesFamily extends Family { + const FetchPackagesFamily._() + : super( + name: r'fetchPackagesProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + FetchPackagesProvider call({ + required int page, + String search = '', + }) => + FetchPackagesProvider._(argument: ( + page: page, + search: search, + ), from: this); + + @override + String debugGetCreateSourceHash() => _$fetchPackagesHash(); + + @override + String toString() => r'fetchPackagesProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + FutureOr> Function( + FetchPackagesRef ref, + ({ + int page, + String search, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as FetchPackagesProvider; + + final argument = provider.argument as ({ + int page, + String search, + }); + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart new file mode 100644 index 000000000..a6e6df4aa --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction/why_riverpod/raw.dart @@ -0,0 +1,25 @@ +// ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types + +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +class Package { + static Package fromJson(dynamic json) { + throw UnimplementedError(); + } +} + +/* SNIPPET START */ // 从 pub.dev 获取包列表 +final fetchPackagesProvider = FutureProvider.autoDispose + .family, ({int page, String? search})>((ref, params) async { + final page = params.page; + final search = params.search ?? ''; + final dio = Dio(); + // 获取 API。 这里我们使用 package:dio，但我们可以使用其他任何东西。 + final response = await dio.get>( + 'https://pub.dartlang.org/api/search?page=$page&q=${Uri.encodeQueryComponent(search)}', + ); + + // 将 JSON 响应解码为 Dart 类。 + return response.data?.map(Package.fromJson).toList() ?? const []; +});/* SNIPPET END */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx new file mode 100644 index 000000000..132db7d1b --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.13.0_to_0.14.0.mdx @@ -0,0 +1,120 @@ +--- +title: ^0.13.0 到 ^0.14.0 +--- + +随着 Riverpod 版本 0.14.0 的发布，使用 [StateNotifierProvider] 的语法发生了变化 +（请参阅 https://github.com/rrousselGit/riverpod/issues/341 了解详细解释）。 + +在整篇文章中，请考虑以下的 [StateNotifier]: + +```dart +class MyModel {} + +class MyStateNotifier extends StateNotifier { + MyStateNotifier(): super(MyModel()); +} +``` + +## The changes + +- [StateNotifierProvider] 添加了一个额外的泛型参数，该参数应该是您的 [StateNotifier]状态的类型。 + + 之前: + + ```dart + final provider = StateNotifierProvider((ref) { + return MyStateNotifier(); + }); + ``` + + 之后: + + ```dart + final provider = StateNotifierProvider((ref) { + return MyStateNotifier(); + }); + ``` + +- 为了获取 [StateNotifier] ，您现在应该使用 `myProvider.notifier` 而不是仅仅使用 `myProvider`： + + 之前: + + ```dart + Widget build(BuildContext context, ScopedReader watch) { + MyStateNotifier notifier = watch(provider); + } + ``` + + 之后: + + ```dart + Widget build(BuildContext context, ScopedReader watch) { + MyStateNotifier notifier = watch(provider.notifier); + } + ``` + +- 为了监听 [StateNotifier] 的状态，您现在应该使用 `myProvider` 而不是 `myProvider.state`： + + Before: + + ```dart + Widget build(BuildContext context, ScopedReader watch) { + MyModel state = watch(provider.state); + } + ``` + + After: + + ```dart + Widget build(BuildContext context, ScopedReader watch) { + MyModel state = watch(provider); + } + ``` + +## 使用迁移工具自动升级项目到新的语法 + +随着 0.14.0 版本的发布，Riverpod 推出了一个命令行工具，可以帮助您迁移项目。 + +### 安装命令行工具 + +要安装迁移工具，请运行： + +```sh +dart pub global activate riverpod_cli +``` + +现在您应该能够运行： + +```sh +riverpod --help +``` + +### 使用说明 + +既然命令行工具已经安装，我们可以开始使用它了。 + +- 首先，在终端中打开您想要迁移的项目。 +- **不要** 升级 Riverpod. + 迁移工具会为您升级 Riverpod 的版本。 +- 确保您的项目不包含错误。 +- 执行： + ```sh + riverpod migrate + ``` + +然后，该工具将分析您的项目并提出更改建议。例如，您可能会看到： + +```diff +Widget build(BuildContext context, ScopedReader watch) { +- MyModel state = watch(provider.state); ++ MyModel state = watch(provider); +} + +Accept change (y = yes, n = no [default], A = yes to all, q = quit)? +``` + +要接受更改，只需按 y 键。否则，要拒绝更改，按 n 键。 + + +[statenotifierprovider]: ../providers/state_notifier_provider +[statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx new file mode 100644 index 000000000..30f078a19 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/0.14.0_to_1.0.0.mdx @@ -0,0 +1,226 @@ +--- +title: ^0.14.0 到 ^1.0.0 +--- + +import { Link } from "@site/src/components/Link"; + + +经过漫长的等待，Riverpod 迎来了首个稳定版本的发布 👏 + +要查看完整的变更列表，请参阅 [Changelog](https://pub.dev/packages/flutter_riverpod/changelog#100). +在本页面中，我们将重点介绍如何将现有的 Riverpod 应用程序从版本 0.14.x 迁移到版本 1.0.0。 + +## 使用迁移工具自动升级项目到新的语法 + +在解释各种变更之前，值得注意的是，Riverpod 提供了一个命令行工具，可以自动为您的项目进行迁移。 + +### 安装命令行工具 + +要安装迁移工具，请运行： + +```sh +dart pub global activate riverpod_cli +``` + +现在您应该能够运行： + +```sh +riverpod --help +``` + +### 使用说明 + +既然命令行工具已经安装，我们可以开始使用它了。 + +- 首先，在终端中打开您想要迁移的项目。 +- **不用** 升级 Riverpod. + 迁移工具将会为您升级 Riverpod 的版本。 + + :::danger + 不升级 Riverpod 非常重要。 + 如果您已经安装了版本 1.0.0，该工具将无法正常执行。因此，请确保在启动工具之前正确使用较旧的版本。 + ::: + +- 确保您的项目不包含错误。 +- 执行 + ```sh + riverpod migrate + ``` + +然后，该工具将分析您的项目并提出更改建议。例如，您可能会看到： + +```diff +-Widget build(BuildContext context, ScopedReader watch) { ++Widget build(BuildContext context, Widget ref) { +- MyModel state = watch(provider); ++ MyModel state = ref.watch(provider); +} + +Accept change (y = yes, n = no [default], A = yes to all, q = quit)? +``` + +要接受更改，只需按 y 键。否则，要拒绝更改，按 n 键. + +## 变更内容 + +现在我们已经了解了如何使用命令行工具自动升级项目，让我们详细看看所需的更改。 + + +### 语法统一 + +Riverpod 1.0.0 版本主要关注与提供程序交互的语法统一。 +在此之前，Riverpod 对于读取提供程序有许多类似但不同的语法， +例如 `ref.watch(provider)` 与 `useProvider(provider)` 与 `watch(provider)`。 +在版本 1.0.0 中，只剩下一种语法： `ref.watch(provider)`。其他的语法已经被移除。 + +例如： + +- `useProvider` 已被移除，而推荐使用 `HookConsumerWidget`。 + + 之前: + + ```dart + class Example extends HookWidget { + @override + Widget build(BuildContext context) { + useState(...); + int count = useProvider(counterProvider); + ... + } + } + ``` + + 之后: + + ```dart + class Example extends HookConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + useState(...); + int count = ref.watch(counterProvider); + ... + } + } + ``` + +- 在 `ConsumerWidget` 的 `build` 方法和 `Consumer` 的 `builder` 方法原型发生了变化. + + 之前: + + ```dart + class Example extends ConsumerWidget { + @override + Widget build(BuildContext context, ScopedReader watch) { + int count = watch(counterProvider); + ... + } + } + + Consumer( + builder: (context, watch, child) { + int count = watch(counterProvider); + ... + } + ) + ``` + + 之后: + + ```dart + class Example extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + int count = ref.watch(counterProvider); + ... + } + } + + Consumer( + builder: (context, ref, child) { + int count = ref.watch(counterProvider); + ... + } + ) + ``` + +- `context.read` 被移除，取而代之的是 `ref.read` 。 + + 之前: + + ```dart + class Example extends StatelessWidget { + @override + Widget build(BuildContext context) { + SomeButton( + onPressed: () => context.read(provider.notifier).doSomething(), + ); + } + } + ``` + + 之后: + + ```dart + class Example extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + SomeButton( + onPressed: () => ref.read(provider.notifier).doSomething(), + ); + } + } + ``` + +### StateProvider 更新 + +[StateProvider] 已更新以匹配 [StateNotifierProvider]。 + +在更新之前，使用 `ref.watch(StateProvider)` 会返回一个 `StateController` 实例。 +现在它只返回 `StateController` 的状态。 + +要进行迁移，有几种解决方案。 +如果您的代码仅获取状态而不修改它，可以从： + +```dart +final provider = StateProvider(...); + +Consumer( + builder: (context, ref, child) { + StateController count = ref.watch(provider); + + return Text('${count.state}'); + } +) +``` + +变到: + +```dart +final provider = StateProvider(...); + +Consumer( + builder: (context, ref, child) { + int count = ref.watch(provider); + + return Text('${count}'); + } +) +``` + +或者，您可以使用新的 `StateProvider.state` 来保持旧的行为。 + +```dart +final provider = StateProvider(...); + +Consumer( + builder: (context, ref, child) { + StateController count = ref.watch(provider.state); + + return Text('${count.state}'); + } +) +``` + +[statenotifierprovider]: ../providers/state_notifier_provider +[stateprovider]: ../providers/state_provider +[statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx new file mode 100644 index 000000000..bdee1b2d9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier.mdx @@ -0,0 +1,259 @@ +--- +title: 从 `ChangeNotifier` 迁移 +--- + +import old from "!!raw-loader!./from_change_notifier/old.dart"; +import declaration from "./from_change_notifier/declaration"; +import initialization from "./from_change_notifier/initialization"; +import migrated from "./from_change_notifier/migrated"; + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet } from "@site/src/components/CodeSnippet"; + + + +在 Riverpod 中，`ChangeNotifierProvider` 用于提供从 pkg:provider 的平滑过渡。 + + +如果您刚刚开始迁移到 pkg:riverpod，请务必阅读专用指南 +（请参阅）。 +本文适用于已经过渡到 Riverpod，但想要彻底放弃 `ChangeNotifier` 的人们。 + + +总而言之，从 `ChangeNotifier` 迁移到 `AsyncNotifer` 需要范式转换， +但它极大地简化了迁移后的代码。 +另请参阅。 + + +以这个（错误的）例子为例： + + + +该实现显示了几个薄弱的设计选择，例如： +- 使用 `isLoading` 和 `hasError` 处理不同的异步情况 +- 需要仔细处理带有繁琐的 `try`/`catch`/`finally` 表达式的请求 +- 需要在正确的时间调用 `notifyListeners` 才能使此实现发挥作用 +- 存在不一致或可能不需要的状态，例如使用空列表进行初始化 + + +请注意这个示例是如何精心设计的，以向新手开发人员展示 `ChangeNotifier` +如何导致错误的设计方案；此外，另一个要点是可变状态可能比最初承诺的要困难得多。 + + +`Notifier`/`AsyncNotifer` 与不可变状态相结合， +可以带来更好的设计方案和更少的错误。 + + +让我们看看如何将上述代码片段一步一步迁移到最新的 API。 + + + +## 开始迁移​ + +首先，我们应该声明新的提供者程序/通知者程序：这需要一些思维过程，这取决于您独特的业务逻辑。 + + +我们总结一下上面的要求： +- 状态用 `List` 表示，通过网络调用获得，不带参数 +- 状态还应该公开有关其 `loading`、`error` 和 `data` 状态的信息 +- 状态可以通过一些公开的方法进行改变，因此一个函数是不够的 + +:::tip + +上述思考过程归结为回答以下问题： +1. 是否需要一些副作用？ + - `y`：使用 Riverpod 的基于类的 API + - `n`：使用 Riverpod 的基于函数的 API +1. State 需要异步加载吗？ + - `y`：让 `build` 返回 `Future` + - `n`：让 `build` 简单地返回 `T` +1. 是否需要一些参数？ + - `y`：让 `build` （或你的函数）接受它们 + - `n`：让 `build` （或你的函数）不接受额外的参数 +::: + +:::info + +如果您使用的是 codegen，上述思考过程就足够了。 +无需考虑正确的类名及其*特定*的 API。 +`@riverpod` 仅要求您编写一个具有返回类型的类，然后就可以开始了。 +::: + + +从技术上讲，这里最合适的是定义一个 `AsyncNotifier>`， +它满足上述所有要求。让我们先写一些伪代码。 + + + +:::tip + +请记住：在 IDE 中使用代码片段可以获得一些指导，或者只是为了加快代码编写速度。 +请参阅。 +::: + + +考虑到 `ChangeNotifier` 的实现，我们不再需要声明 `todos`； +这样的变量是 `state`，它是用 `build` 隐式加载的。 + + +事实上，Riverpod 的通知者程序一次可以暴露*一个*实体。 + +:::tip + +Riverpod 的 API 是细粒度的；尽管如此，在迁移时， +您仍然可以定义自定义实体来保存多个值。首先考虑使用 [Dart 3 的记录](https://dart.dev/language/records) +来平滑迁移。 +::: + + + +### 初始化​ + +初始化通知者程序很简单：只需在 `build` 内编写初始化逻辑即可。 +我们现在可以摆脱旧的 `_init` 函数。 + + + + +相对于旧的 `_init` ，新的 `build` 没有丢失任何内容： +不需要初始化 `isLoading` 或 `hasError` + + +Riverpod 将通过公开 `AsyncValue>` 自动转换任何异步提供者程序， +并比两个简单的布尔标志更好地处理异步状态的复杂性。 + + +事实上，任何 `AsyncNotifier` 都会有效地使编写额外的 `try`/`catch`/`finally` 成为处理异步状态的反模式。 + + + +### 突变和副作用​ + +就像初始化一样，执行副作用时，无需操作布尔标志， +例如 `hasError`，或编写额外的 `try`/`catch`/`finally` + + +下面，我们删除了所有样板文件并成功完全迁移了上面的示例： + + +:::tip + +语法和设计方案可能会有所不同，但最终我们只需要编写我们的请求并随后更新状态。 +请参阅。 +::: + + +## 迁移过程总结 + + +让我们从操作的角度回顾一下上面应用的整个迁移过程。 + + +1. 我们已将初始化从构造函数中调用的自定义方法移至 `build` +1. 我们删除了 `todos`、`isLoading` 和 `hasError` 属性：内部 `state` 就足够了 +1. 我们已经删除了所有 `try`-`catch`-`finally` 块：返回 Future 就足够了 +1. 我们对副作用应用了相同的简化（`addTodo`） +1. 我们已经通过简单地重新分配 `state` 应用了突变 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart new file mode 100644 index 000000000..b3ca06ef2 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.dart @@ -0,0 +1,33 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'declaration.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() { + // TODO ... + return []; + } + + Future addTodo(Todo todo) async { + // TODO + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart new file mode 100644 index 000000000..e28ccbd61 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/declaration.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'declaration.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider + extends $AsyncNotifierProvider> { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'fc9a07f8ef9f792da2ac660d76ea0a809335ba18'; + +abstract class _$MyNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx new file mode 100644 index 000000000..1ad659c31 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./declaration.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart new file mode 100644 index 000000000..0c723f63c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/declaration/raw.dart @@ -0,0 +1,34 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyNotifier extends AsyncNotifier> { + @override + FutureOr> build() { + // TODO ... + return []; + } + + Future addTodo(Todo todo) async { + // TODO + } +} + +final myNotifierProvider = + AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx new file mode 100644 index 000000000..3b3fbd2cb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./initialization.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart new file mode 100644 index 000000000..4da805e13 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.dart @@ -0,0 +1,29 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'initialization.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + return [...json.map(Todo.fromJson)]; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart new file mode 100644 index 000000000..032f36218 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/initialization.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'initialization.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider + extends $AsyncNotifierProvider> { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'1c67c12443102cf8c43efbf6c630d3028d9847c3'; + +abstract class _$MyNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart new file mode 100644 index 000000000..5ef9e85c1 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/initialization/raw.dart @@ -0,0 +1,30 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyNotifier extends AsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + return [...json.map(Todo.fromJson)]; + } +} + +final myNotifierProvider = + AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx new file mode 100644 index 000000000..075bfbdf5 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./migrated.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart new file mode 100644 index 000000000..a90cee0fa --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.dart @@ -0,0 +1,37 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'migrated.g.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + Future addTodo(Todo todo) async { + // 可选的: state = const AsyncLoading(); + final json = await http.post('api/todos'); + final newTodos = [...json.map(Todo.fromJson)]; + state = AsyncData(newTodos); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart new file mode 100644 index 000000000..a70189d52 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/migrated.g.dart @@ -0,0 +1,74 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'migrated.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider + extends $AsyncNotifierProvider> { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'bde95c56aa12eff7c8c01ede57ae4ad2b616c225'; + +abstract class _$MyNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart new file mode 100644 index 000000000..48ad7b375 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/migrated/raw.dart @@ -0,0 +1,38 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyNotifier extends AsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + Future addTodo(Todo todo) async { + // 可选的: state = const AsyncLoading(); + final json = await http.post('api/todos'); + final newTodos = [...json.map(Todo.fromJson)]; + state = AsyncData(newTodos); + } +} + +final myNotifierProvider = + AsyncNotifierProvider.autoDispose(MyNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart new file mode 100644 index 000000000..932804174 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_change_notifier/old.dart @@ -0,0 +1,60 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +class Todo { + const Todo(this.id); + Todo.fromJson(Object obj) : id = 0; + + final int id; +} + +class Http { + Future> get(String str) async => [str]; + Future> post(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class MyChangeNotifier extends ChangeNotifier { + MyChangeNotifier() { + _init(); + } + List todos = []; + bool isLoading = true; + bool hasError = false; + + Future _init() async { + try { + final json = await http.get('api/todos'); + todos = [...json.map(Todo.fromJson)]; + } on Exception { + hasError = true; + } finally { + isLoading = false; + notifyListeners(); + } + } + + Future addTodo(int id) async { + isLoading = true; + notifyListeners(); + + try { + final json = await http.post('api/todos'); + todos = [...json.map(Todo.fromJson)]; + hasError = false; + } on Exception { + hasError = true; + } finally { + isLoading = false; + notifyListeners(); + } + } +} + +final myChangeProvider = ChangeNotifierProvider((ref) { + return MyChangeNotifier(); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx new file mode 100644 index 000000000..b649c1964 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier.mdx @@ -0,0 +1,547 @@ +--- +title: 从 `StateNotifier` 迁移 +--- + +import buildInit from "./from_state_notifier/build_init"; +import buildInitOld from "!!raw-loader!./from_state_notifier/build_init_old.dart"; +import consumersDontChange from "!!raw-loader!./from_state_notifier/consumers_dont_change.dart"; +import familyAndDispose from "./from_state_notifier/family_and_dispose"; +import familyAndDisposeOld from "!!raw-loader!./from_state_notifier/family_and_dispose_old.dart"; +import asyncNotifier from "./from_state_notifier/async_notifier"; +import asyncNotifierOld from "!!raw-loader!./from_state_notifier/async_notifier_old.dart"; +import addListener from "./from_state_notifier/add_listener"; +import addListenerOld from "!!raw-loader!./from_state_notifier/add_listener_old.dart"; +import fromStateProvider from "./from_state_notifier/from_state_provider"; +import fromStateProviderOld from "!!raw-loader!./from_state_notifier/from_state_provider_old.dart"; +import oldLifecycles from "./from_state_notifier/old_lifecycles"; +import oldLifecyclesOld from "!!raw-loader!./from_state_notifier/old_lifecycles_old.dart"; +import oldLifecyclesFinal from "./from_state_notifier/old_lifecycles_final"; +import obtainNotifierOnTests from "!!raw-loader!./from_state_notifier/obtain_notifier_on_tests.dart"; + +import { Link } from "@site/src/components/Link"; +import { AutoSnippet } from "@site/src/components/CodeSnippet"; + + +与 [Riverpod 2.0](https://pub.dev/packages/flutter_riverpod/changelog#200) +一起引入了新类： `Notifier`/`AsyncNotifer`。 +现在不鼓励使用 `StateNotifier`，转而使用这些新 API。 + + +本页展示如何从已弃用的 `StateNotifier` 迁移到新的 API。 + + +`AsyncNotifier` 带来的主要好处是更好的 `async` 支持；事实上， +`AsyncNotifier` 可以被认为是 `FutureProvider` ，并且具备从 UI 修改的公开方法。 + + +此外，新的 (Async)Notifier： + + +- 在其类中公开 `Ref` 对象 +- 在代码生成和非代码生成方法之间提供类似的语法 +- 在同步和异步版本之间提供类似的语法 +- 将逻辑从提供者程序中移开，并将其集中到通知者程序本身中 + + +让我们看看如何定义 `Notifier`、它与 `StateNotifier` 的比较以及如何迁移新的 +`AsyncNotifier` 以获得异步状态。 + + +## 新语法比较​ + + +在进行比较之前，请务必了解如何定义 `Notifier`。 +请参阅。 + + +让我们使用旧的 `StateNotifier` 语法编写一个示例： + + + +这是使用新的 `Notifier` API 构建的相同示例，大致可翻译为： + + + +比较 `Notifier` 与 `StateNotifier`，可以观察到以下主要区别： + + +- `StateNotifier` 的反应式依赖项在其提供者程序中声明，而 `Notifier` + 将此逻辑集中在其 `build` 方法中 +- `StateNotifier` 的整个初始化过程分为其提供者程序和构造函数， + 而 `Notifier` 保留一个位置来放置此类逻辑 +- 请注意，与 `StateNotifier` 不同，没有任何逻辑被写入 `Notifier` 的构造函数中 + + +使用 `AsyncNotifer`、`Notifier` 的异步等效项可以得出类似的结论。 + + +## 迁移异步 `StateNotifier` + + +新 API 语法的主要吸引力在于改进了异步数据的开发体验。 +举个例子： + + + + +下面是用新的 `AsyncNotifier` API 重写的上面的示例： + + + + +`AsyncNotifer` 与 `Notifier` 一样，带来了更简单、更统一的 API。 +在这里，很容易将 `AsyncNotifer` 视为带有方法的 `FutureProvider`。 + + +`AsyncNotifer` 附带了一组 `StateNotifier` 没有的实用程序和 getter，例如 +[`future`](https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifier/future.html) +和 [`update`](https://pub.dev/documentation/riverpod/latest/riverpod/AsyncNotifier/update.html)。 +这使我们能够在处理异步突变和副作用时编写更简单的逻辑。 +另请参阅。 +:::tip + +从 `StateNotifier>` 迁移到 `AsyncNotifer` 归结为： + +- 将初始化逻辑放入 `build` +- 删除初始化或副作用方法中的任何 `catch`/`try` 块 +- 从 `build` 中删除任何 `AsyncValue.guard` ，因为它将 `Future` 转换为 `AsyncValue` +::: + + + +## 优点​ + + +在这几个示例之后，现在让我们重点介绍 `Notifier` 和 `AsyncNotifer` 的主要优点： +- 新语法应该感觉更简单、更具可读性，特别是对于异步状态 +- 一般来说，新 API 的样板代码可能会更少 +- 无论您正在编写哪种类型的提供者程序，语法现在都是统一的，从而支持代码生成 + （请参阅） + + +让我们进一步深入并强调更多的差异和相似之处。 + + +## 显式 `.family` 和 `.autoDispose` 修改​ + + +另一个重要的区别是新 API 处理系列和自动处置的方式。 + + +`Notifier`，有其自己的 `.family` 和 `.autoDispose` 对应项， +例如 `FamilyNotifier` 和 `Notifier`。 +与往常一样，此类修改可以组合使用（又名 `AutoDisposeFamilyNotifier`）。 +`AsyncNotifer` 也有其异步等效项（例如 `FamilyAsyncNotifier`）。 + + +修改在类中明确说明；所有参数都直接注入 `build` 方法中，以便初始化逻辑可以使用它们。 +这应该会带来更好的可读性、更简洁、总体上更少的错误。 + + +以下面的示例为例，其中定义了 `StateNotifierProvider.family`。 + + + +`BugsEncounteredNotifier` 感觉...沉重/难以阅读。 +让我们看一下它的迁移后的 `AsyncNotifier` 对应部分： + + + + +其迁移后的版本应该是一本轻松的读物。 + +:::info + +`(Async)Notifier` 的 `.family` 参数可通过 `this.arg` 获取（或使用代码生成时的 `this.paramName`） +::: + + +## 生命周期有不同的行为​ + + +`Notifier`/`AsyncNotifier` 和 `StateNotifier` 之间的生命周期有很大不同。 + + +这个例子再次展示了旧 API 如何具有稀疏逻辑： + + + + +在这里，如果 `durationProvider` 更新，`MyNotifier` 会进行处置： +然后重新实例化其实例，然后重新初始化其内部状态。 +此外，与其他提供者程序不同的是，`dispose` 回调将在类中单独定义。 +最后，仍然可以在其 _provider_ 中编写 `ref.onDispose`， +再次显示此 API 的逻辑是多么稀疏；潜在地，开发人员可能必须研究八 (8!) +个不同的地方才能理解此通知者程序行为！ + + +这些歧义可以通过 `Riverpod 2.0` 解决。 + + +### 旧 `dispose` 与 `ref.onDispose` + +`StateNotifier` 的 `dispose` 方法指的是通知者程序本身的 dispose 事件， +也就是*在自行处置之前*调用的回调。 + + +`(Async)Notifier` 没有此属性，因为*它们在重建时不会被处置*；只有他们的内部状态是。 +在新的通知者程序中，处置生命周期仅在_一个_地方处理，通过 `ref.onDispose` +（和其他），就像任何其他提供者程序一样。 +这简化了 API，希望也提高了开发体验，这样只需查看_一个_地方 +即可了解生命周期的副作用：它的 `build` 方法。 + + +简而言之：要注册在*内部状态*重建之前触发的回调， +我们可以像其他提供者程序一样使用 `ref.onDispose`。 + + +您可以像这样迁移上面的代码片段： + + + + +在最后一个片段中，肯定有一些简化，但仍然存在一个未解决的问题： +我们现在无法了解我们的通知者程序在执行 `update` 时是否仍然存在。 +这可能会出现不需要的 `StateError`。 + + +### 不再 `mounted` + +发生这种情况是因为 `(Async)Notifier` 缺少 `mounted` 属性， +而该属性在 `StateNotifier` 上可用。 +考虑到它们生命周期的差异，这是完全有道理的；尽管只是可能，`mounted` +属性可能会误导新通知者程序：`mounted` *几乎总是* `true` 。 + + +虽然可以制定[自定义解决方法](https://github.com/rrousselGit/riverpod/issues/1879#issuecomment-1303189191)， +但建议通过取消异步操作来解决此问题。 + + +可以使用自定义[完成器](https://api.flutter.dev/flutter/dart-async/Completer-class.html) +或任何自定义派生程序来取消操作。 + + +例如，如果您使用 `Dio` 执行网络请求，请考虑使用[取消令牌](https://pub.dev/documentation/dio/latest/dio/CancelToken-class.html) +（另请参阅）。 + + +因此，上面的示例迁移到以下内容： + + + + +## 突变 API 与之前相同​ + + +到目前为止，我们已经展示了 `StateNotifier` 和新 API 之间的差异。 +相反， `Notifier`、`AsyncNotifer` 和 `StateNotifier` 共享的一件事是 +如何使用和改变它们的状态。 + + +消费者程序可以使用相同的语法从这三个提供者程序获取数据， +这在您从 `StateNotifier` 迁移时非常有用；这也适用于通知者程序方法。 + + + + +## 其他迁移​ + + +让我们探讨一下 `StateNotifier` 和 `Notifier`（或 `AsyncNotifier`）之间影响较小的差异 + + +### 从 `.addListener` 和 `.stream` 迁移​ + + +`StateNotifier` 的 `.addListener` 和 `.stream` 可用于监听状态更改。 +这两个 API 现在被认为已经过时了。 + + +这是有意为之，因为我们希望与 `Notifier`、`AsyncNotifier` 和其他提供者程序实现完全的 API 统一。 +事实上，使用 `Notifier` 或 `AsyncNotifier` 应该与任何其他提供者程序没有任何不同。 + + +因此： + + + +就变成这样了： + + + +简而言之：如果你想监听 `Notifier`/`AsyncNotifer`，只需使用 `ref.listen`。 +请参阅。 + + +### 从测试中的 `.debugState` 迁移​ + + +`StateNotifier` 公开 `.debugState`：此属性供 pkg:state_notifier +用户在开发模式下启用从类外部进行状态访问，以用于测试目的。 + + +如果您在测试中使用 `.debugState` 访问状态，则您很可能需要放弃这种方法。 + + +`Notifier`/`AsyncNotifer` 没有 `.debugState`；相反，它们直接公开 `.state`， +即 `@visibleForTesting` 。 + +:::danger + +避免！从测试中访问 `.state`；如果必须的话，_当且仅当_您已经正确实例化了 +`Notifier`/`AsyncNotifer` 时才执行此操作； +然后，您可以在测试中自由访问 `.state`。 + + +事实上，`Notifier`/`AsyncNotifier` _不应该_手动实例化；相反， +它们应该通过使用其提供者程序进行交互：如果不这样做将会*破坏*通知者程序， +因为 ref 和 family 参数没有被初始化。 +::: + + +没有 `Notifier` 实例？ +没问题，您可以使用 `ref.read` 获取一个，就像您读取其暴露状态一样： + + + + +在其专用指南中了解有关测试的更多信息。请参阅。 + + +### 从 `StateProvider` 迁移​ + + +`StateProvider` 自发布以来就被 Riverpod 暴露出来， +它是为了节省一些代码行数（LoC）来简化 `StateNotifierProvider` 的版本。 +由于 `StateNotifierProvider` 已被弃用，因此 `StateProvider` 也应避免使用。 +此外，到目前为止，新 API 还没有等效的 `StateProvider`。 + + +尽管如此，从 `StateProvider` 迁移到 `Notifier` 很简单。 + + +这样： + + + +变成： + + + +尽管它花费了我们更多的代码行数（LoC），但从 `StateProvider` +迁移使我们能够明确地归档 `StateNotifier` 。 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart new file mode 100644 index 000000000..ead1c72d8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.dart @@ -0,0 +1,18 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'add_listener.g.dart'; + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + ref.listenSelf((_, next) => debugPrint('$next')); + return 0; + } + + void add() => state++; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart new file mode 100644 index 000000000..9f4c200ed --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -0,0 +1,81 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'add_listener.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'9acd382ed579c545ace755687b155e28eba01d22'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx new file mode 100644 index 000000000..6d7ac6d37 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./add_listener.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart new file mode 100644 index 000000000..d032a4c2d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener/raw.dart @@ -0,0 +1,17 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + ref.listenSelf((_, next) => debugPrint('$next')); + return 0; + } + + void add() => state++; +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart new file mode 100644 index 000000000..9354e1893 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart @@ -0,0 +1,25 @@ +// ignore_for_file: avoid_print + +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ +class MyNotifier extends StateNotifier { + MyNotifier() : super(0); + + void add() => state++; +} + +final myNotifierProvider = StateNotifierProvider((ref) { + final notifier = MyNotifier(); + + final cleanup = notifier.addListener((state) => debugPrint('$state')); + ref.onDispose(cleanup); + + // 或者，等效为： + // final listener = notifier.stream.listen((event) => debugPrint('$event')); + // ref.onDispose(listener.cancel); + + return notifier; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart new file mode 100644 index 000000000..5ead76378 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.dart @@ -0,0 +1,28 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'async_notifier.g.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +@riverpod +class AsyncTodosNotifier extends _$AsyncTodosNotifier { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + // ... +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart new file mode 100644 index 000000000..0fd4946cb --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -0,0 +1,75 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'async_notifier.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(AsyncTodosNotifier) +const asyncTodosNotifierProvider = AsyncTodosNotifierProvider._(); + +final class AsyncTodosNotifierProvider + extends $AsyncNotifierProvider> { + const AsyncTodosNotifierProvider._( + {super.runNotifierBuildOverride, AsyncTodosNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'asyncTodosNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final AsyncTodosNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$asyncTodosNotifierHash(); + + @$internal + @override + AsyncTodosNotifier create() => _createCb?.call() ?? AsyncTodosNotifier(); + + @$internal + @override + AsyncTodosNotifierProvider $copyWithCreate( + AsyncTodosNotifier Function() create, + ) { + return AsyncTodosNotifierProvider._(create: create); + } + + @$internal + @override + AsyncTodosNotifierProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + AsyncTodosNotifier, + ) build, + ) { + return AsyncTodosNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$asyncTodosNotifierHash() => + r'10207327c7dee180e9da8beece5bfffedcf86e98'; + +abstract class _$AsyncTodosNotifier extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx new file mode 100644 index 000000000..a0ff513c3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./async_notifier.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart new file mode 100644 index 000000000..ac91d2f88 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier/raw.dart @@ -0,0 +1,31 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class AsyncTodosNotifier extends AsyncNotifier> { + @override + FutureOr> build() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + } + + // ... +} + +final asyncTodosNotifier = + AsyncNotifierProvider>( + AsyncTodosNotifier.new, +); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart new file mode 100644 index 000000000..50d7f4aed --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart @@ -0,0 +1,30 @@ +// ignore_for_file: avoid_print, avoid_unused_constructor_parameters + +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class Todo { + Todo.fromJson(Object obj); +} + +class Http { + Future> get(String str) async => [str]; +} + +final http = Http(); + +/* SNIPPET START */ +class AsyncTodosNotifier extends StateNotifier>> { + AsyncTodosNotifier() : super(const AsyncLoading()) { + _postInit(); + } + + Future _postInit() async { + state = await AsyncValue.guard(() async { + final json = await http.get('api/todos'); + + return [...json.map(Todo.fromJson)]; + }); + } + + // ... +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart new file mode 100644 index 000000000..3e2303b7a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.dart @@ -0,0 +1,15 @@ +// ignore_for_file: avoid_print + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'build_init.g.dart'; + +/* SNIPPET START */ +@riverpod +class CounterNotifier extends _$CounterNotifier { + @override + int build() => 0; + + void increment() => state++; + void decrement() => state++; +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart new file mode 100644 index 000000000..c180fbb60 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/build_init.g.dart @@ -0,0 +1,82 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'build_init.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(CounterNotifier) +const counterNotifierProvider = CounterNotifierProvider._(); + +final class CounterNotifierProvider + extends $NotifierProvider { + const CounterNotifierProvider._( + {super.runNotifierBuildOverride, CounterNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CounterNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + CounterNotifier create() => _createCb?.call() ?? CounterNotifier(); + + @$internal + @override + CounterNotifierProvider $copyWithCreate( + CounterNotifier Function() create, + ) { + return CounterNotifierProvider._(create: create); + } + + @$internal + @override + CounterNotifierProvider $copyWithBuild( + int Function( + Ref, + CounterNotifier, + ) build, + ) { + return CounterNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterNotifierHash() => r'8d4e4011da15a0ef79af9622336839a0c9e406ab'; + +abstract class _$CounterNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx new file mode 100644 index 000000000..276a143ac --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./build_init.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart new file mode 100644 index 000000000..02c7e75b3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init/raw.dart @@ -0,0 +1,15 @@ +// ignore_for_file: avoid_print + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +class CounterNotifier extends Notifier { + @override + int build() => 0; + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = + NotifierProvider(CounterNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart new file mode 100644 index 000000000..034b059ec --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart @@ -0,0 +1,15 @@ +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +/* SNIPPET START */ +class CounterNotifier extends StateNotifier { + CounterNotifier() : super(0); + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = + StateNotifierProvider((ref) { + return CounterNotifier(); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart new file mode 100644 index 000000000..e358a2e54 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart @@ -0,0 +1,38 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class CounterNotifier extends StateNotifier { + CounterNotifier() : super(0); + + void increment() => state++; + void decrement() => state++; +} + +final counterNotifierProvider = + StateNotifierProvider((ref) { + return CounterNotifier(); +}); + +/* SNIPPET START */ +class SomeConsumer extends ConsumerWidget { + const SomeConsumer({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + /* highlight-start */ + final counter = ref.watch(counterNotifierProvider); + /* highlight-end */ + return Column( + children: [ + Text("You've counted up until $counter, good job!"), + TextButton( + /* highlight-start */ + onPressed: ref.read(counterNotifierProvider.notifier).increment, + /* highlight-end */ + child: const Text('Count even more!'), + ), + ], + ); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart new file mode 100644 index 000000000..9a695614c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'family_and_dispose.g.dart'; + +/* SNIPPET START */ +@riverpod +class BugsEncounteredNotifier extends _$BugsEncounteredNotifier { + @override + FutureOr build(String featureId) { + return 99; + } + + Future fix(int amount) async { + final old = await future; + final result = await ref.read(taskTrackerProvider).fix(id: this.featureId, fixed: amount); + state = AsyncData(max(old - result, 0)); + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart new file mode 100644 index 000000000..4c6b1cb46 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -0,0 +1,170 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'family_and_dispose.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(BugsEncounteredNotifier) +const bugsEncounteredNotifierProvider = BugsEncounteredNotifierFamily._(); + +final class BugsEncounteredNotifierProvider + extends $AsyncNotifierProvider { + const BugsEncounteredNotifierProvider._( + {required BugsEncounteredNotifierFamily super.from, + required String super.argument, + super.runNotifierBuildOverride, + BugsEncounteredNotifier Function()? create}) + : _createCb = create, + super( + name: r'bugsEncounteredNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final BugsEncounteredNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$bugsEncounteredNotifierHash(); + + @override + String toString() { + return r'bugsEncounteredNotifierProvider' + '' + '($argument)'; + } + + @$internal + @override + BugsEncounteredNotifier create() => + _createCb?.call() ?? BugsEncounteredNotifier(); + + @$internal + @override + BugsEncounteredNotifierProvider $copyWithCreate( + BugsEncounteredNotifier Function() create, + ) { + return BugsEncounteredNotifierProvider._( + argument: argument as String, + from: from! as BugsEncounteredNotifierFamily, + create: create); + } + + @$internal + @override + BugsEncounteredNotifierProvider $copyWithBuild( + FutureOr Function( + Ref>, + BugsEncounteredNotifier, + ) build, + ) { + return BugsEncounteredNotifierProvider._( + argument: argument as String, + from: from! as BugsEncounteredNotifierFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is BugsEncounteredNotifierProvider && + other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$bugsEncounteredNotifierHash() => + r'c76e924f84db91c57d226896b062d9f4e8ab79e5'; + +final class BugsEncounteredNotifierFamily extends Family { + const BugsEncounteredNotifierFamily._() + : super( + name: r'bugsEncounteredNotifierProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + BugsEncounteredNotifierProvider call( + String featureId, + ) => + BugsEncounteredNotifierProvider._(argument: featureId, from: this); + + @override + String debugGetCreateSourceHash() => _$bugsEncounteredNotifierHash(); + + @override + String toString() => r'bugsEncounteredNotifierProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + BugsEncounteredNotifier Function( + String args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as BugsEncounteredNotifierProvider; + + final argument = provider.argument as String; + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + FutureOr Function(Ref> ref, + BugsEncounteredNotifier notifier, String argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as BugsEncounteredNotifierProvider; + + final argument = provider.argument as String; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(container); + }, + ); + } +} + +abstract class _$BugsEncounteredNotifier extends $AsyncNotifier { + late final _$args = + (ref as $AsyncNotifierProviderElement).origin.argument as String; + String get featureId => _$args; + + FutureOr build( + String featureId, + ); + @$internal + @override + FutureOr runBuild() => build( + _$args, + ); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx new file mode 100644 index 000000000..0780f2135 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./family_and_dispose.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart new file mode 100644 index 000000000..b7068013a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose/raw.dart @@ -0,0 +1,28 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +/* SNIPPET START */ +class BugsEncounteredNotifier extends FamilyAsyncNotifier { + @override + FutureOr build(String featureId) { + return 99; + } + + Future fix(int amount) async { + final old = await future; + final result = + await ref.read(taskTrackerProvider).fix(id: this.arg, fixed: amount); + state = AsyncData(max(old - result, 0)); + } +} + +final bugsEncounteredNotifierProvider = AsyncNotifierProvider.family + .autoDispose( + BugsEncounteredNotifier.new, +); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart new file mode 100644 index 000000000..f01455cf7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/family_and_dispose_old.dart @@ -0,0 +1,32 @@ +// ignore_for_file: unnecessary_this + +import 'dart:math'; + +import 'package:flutter_riverpod/legacy.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +import '../utils.dart'; + +/* SNIPPET START */ +class BugsEncounteredNotifier extends StateNotifier> { + BugsEncounteredNotifier({ + required this.ref, + required this.featureId, + }) : super(const AsyncData(99)); + final String featureId; + final Ref> ref; + + Future fix(int amount) async { + state = await AsyncValue.guard(() async { + final old = state.requireValue; + final result = + await ref.read(taskTrackerProvider).fix(id: featureId, fixed: amount); + return max(old - result, 0); + }); + } +} + +final bugsEncounteredNotifierProvider = StateNotifierProvider.family + .autoDispose, String>((ref, id) { + return BugsEncounteredNotifier(ref: ref, featureId: id); +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart new file mode 100644 index 000000000..2c71d6144 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.dart @@ -0,0 +1,14 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'from_state_provider.g.dart'; + +/* SNIPPET START */ +@riverpod +class CounterNotifier extends _$CounterNotifier { + @override + int build() => 0; + + @override + set state(int newState) => super.state = newState; + int update(int Function(int state) cb) => state = cb(state); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart new file mode 100644 index 000000000..94f793831 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -0,0 +1,82 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'from_state_provider.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(CounterNotifier) +const counterNotifierProvider = CounterNotifierProvider._(); + +final class CounterNotifierProvider + extends $NotifierProvider { + const CounterNotifierProvider._( + {super.runNotifierBuildOverride, CounterNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CounterNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + CounterNotifier create() => _createCb?.call() ?? CounterNotifier(); + + @$internal + @override + CounterNotifierProvider $copyWithCreate( + CounterNotifier Function() create, + ) { + return CounterNotifierProvider._(create: create); + } + + @$internal + @override + CounterNotifierProvider $copyWithBuild( + int Function( + Ref, + CounterNotifier, + ) build, + ) { + return CounterNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$counterNotifierHash() => r'b32033040f0fff627f1a6dfd9cfb4e93a842390b'; + +abstract class _$CounterNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx new file mode 100644 index 000000000..f59794999 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./from_state_provider.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart new file mode 100644 index 000000000..ee7eb761e --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider/raw.dart @@ -0,0 +1,14 @@ +import 'package:riverpod/riverpod.dart'; + +/* SNIPPET START */ +class CounterNotifier extends Notifier { + @override + int build() => 0; + + @override + set state(int newState) => super.state = newState; + int update(int Function(int state) cb) => state = cb(state); +} + +final counterNotifierProvider = + NotifierProvider(CounterNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart new file mode 100644 index 000000000..4b4ec6aa4 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/from_state_provider_old.dart @@ -0,0 +1,6 @@ +import 'package:flutter_riverpod/legacy.dart'; + +/* SNIPPET START */ +final counterProvider = StateProvider((ref) { + return 0; +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart new file mode 100644 index 000000000..f0f5825d3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/obtain_notifier_on_tests.dart @@ -0,0 +1,34 @@ +// ignore_for_file: unused_local_variable,omit_local_variable_types + +import 'package:flutter_test/flutter_test.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; + +class MyNotifier extends Notifier { + @override + int build() { + return 0; + } +} + +final myNotifierProvider = + NotifierProvider.autoDispose(MyNotifier.new); + +/* SNIPPET START */ +void main(List args) { + test('my test', () { + final container = ProviderContainer(); + addTearDown(container.dispose); + + // 获取通知者程序 + /* highlight-start */ + final Notifier notifier = container.read(myNotifierProvider.notifier); + /* highlight-end */ + + // 获取其暴露状态 + /* highlight-start */ + final int state = container.read(myNotifierProvider); + /* highlight-end */ + + // TODO 编写您的测试 + }); +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx new file mode 100644 index 000000000..9b77f551a --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./old_lifecycles.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart new file mode 100644 index 000000000..64bb738b9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.dart @@ -0,0 +1,39 @@ +// ignore_for_file: library_private_types_in_public_api + +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'old_lifecycles.g.dart'; + +@riverpod +_MyRepo repository(RepositoryRef ref) { + return _MyRepo(); +} + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // 只需在此处读取/写入代码，一目了然 + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); + // `mounted` 已不复存在！ + state++; // 这可能会抛出。 + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart new file mode 100644 index 000000000..deac12aa7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -0,0 +1,141 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'old_lifecycles.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RepositoryRef = Ref<_MyRepo>; + +@ProviderFor(repository) +const repositoryProvider = RepositoryProvider._(); + +final class RepositoryProvider + extends $FunctionalProvider<_MyRepo, _MyRepo, RepositoryRef> + with $Provider<_MyRepo, RepositoryRef> { + const RepositoryProvider._( + {_MyRepo Function( + RepositoryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'repositoryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final _MyRepo Function( + RepositoryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$repositoryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(_MyRepo value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider<_MyRepo>(value), + ); + } + + @$internal + @override + $ProviderElement<_MyRepo> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RepositoryProvider $copyWithCreate( + _MyRepo Function( + RepositoryRef ref, + ) create, + ) { + return RepositoryProvider._(create: create); + } + + @override + _MyRepo create(RepositoryRef ref) { + final _$cb = _createCb ?? repository; + return _$cb(ref); + } +} + +String _$repositoryHash() => r'e271c7e2cb18076d5eb6d2cd4e47b96a97a35e6f'; + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'0495c52ce893ee0304d4d5ac5648c634ed4a241e'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart new file mode 100644 index 000000000..940df1150 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles/raw.dart @@ -0,0 +1,35 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod/riverpod.dart'; + +import '../../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + // 只需在此处读取/写入代码，一目了然 + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); + // `mounted` 已不复存在！ + state++; // 这可能会抛出。 + } +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx new file mode 100644 index 000000000..9823b1564 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./old_lifecycles_final.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart new file mode 100644 index 000000000..5af70b7d8 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart @@ -0,0 +1,41 @@ +// ignore_for_file: library_private_types_in_public_api + +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +import '../../utils.dart'; + +part 'old_lifecycles_final.g.dart'; + +@riverpod +_MyRepo repository(RepositoryRef ref) { + return _MyRepo(); +} + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +@riverpod +class MyNotifier extends _$MyNotifier { + @override + int build() { + // 只需在此处读取/写入代码，一目了然 + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + final cancelToken = CancelToken(); + ref.onDispose(cancelToken.cancel); + await ref.read(repositoryProvider).update(state + 1, token: cancelToken); + // 调用 `cancelToken.cancel` 时，会抛出一个自定义异常 + state++; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart new file mode 100644 index 000000000..76fd303d0 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -0,0 +1,141 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'old_lifecycles_final.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RepositoryRef = Ref<_MyRepo>; + +@ProviderFor(repository) +const repositoryProvider = RepositoryProvider._(); + +final class RepositoryProvider + extends $FunctionalProvider<_MyRepo, _MyRepo, RepositoryRef> + with $Provider<_MyRepo, RepositoryRef> { + const RepositoryProvider._( + {_MyRepo Function( + RepositoryRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'repositoryProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final _MyRepo Function( + RepositoryRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$repositoryHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(_MyRepo value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider<_MyRepo>(value), + ); + } + + @$internal + @override + $ProviderElement<_MyRepo> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RepositoryProvider $copyWithCreate( + _MyRepo Function( + RepositoryRef ref, + ) create, + ) { + return RepositoryProvider._(create: create); + } + + @override + _MyRepo create(RepositoryRef ref) { + final _$cb = _createCb ?? repository; + return _$cb(ref); + } +} + +String _$repositoryHash() => r'e271c7e2cb18076d5eb6d2cd4e47b96a97a35e6f'; + +@ProviderFor(MyNotifier) +const myNotifierProvider = MyNotifierProvider._(); + +final class MyNotifierProvider extends $NotifierProvider { + const MyNotifierProvider._( + {super.runNotifierBuildOverride, MyNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'myNotifierProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final MyNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$myNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + MyNotifier create() => _createCb?.call() ?? MyNotifier(); + + @$internal + @override + MyNotifierProvider $copyWithCreate( + MyNotifier Function() create, + ) { + return MyNotifierProvider._(create: create); + } + + @$internal + @override + MyNotifierProvider $copyWithBuild( + int Function( + Ref, + MyNotifier, + ) build, + ) { + return MyNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$myNotifierHash() => r'8ea2586ea29d12306efd4b8b847142136dd20338'; + +abstract class _$MyNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart new file mode 100644 index 000000000..929297ba9 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_final/raw.dart @@ -0,0 +1,37 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:riverpod/riverpod.dart'; + +import '../../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends Notifier { + @override + int build() { + // 只需在此处读取/写入代码，一目了然 + final period = ref.watch(durationProvider); + final timer = Timer.periodic(period, (t) => update()); + ref.onDispose(timer.cancel); + + return 0; + } + + Future update() async { + final cancelToken = CancelToken(); + ref.onDispose(cancelToken.cancel); + await ref.read(repositoryProvider).update(state + 1, token: cancelToken); + // 调用 `cancelToken.cancel` 时，会抛出一个自定义异常 + state++; + } +} + +final myNotifierProvider = NotifierProvider(MyNotifier.new); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart new file mode 100644 index 000000000..00ff268c2 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/old_lifecycles_old.dart @@ -0,0 +1,43 @@ +import 'dart:async'; + +import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +import '../utils.dart'; + +final repositoryProvider = Provider<_MyRepo>((ref) { + return _MyRepo(); +}); + +class _MyRepo { + Future update(int i, {CancelToken? token}) async {} +} + +/* SNIPPET START */ +class MyNotifier extends StateNotifier { + MyNotifier(this.ref, this.period) : super(0) { + // 1 初始化逻辑 + _timer = Timer.periodic(period, (t) => update()); // 2 初始化副作用 + } + final Duration period; + final Ref ref; + late final Timer _timer; + + Future update() async { + await ref.read(repositoryProvider).update(state + 1); // 3 发生突变 + if (mounted) state++; // 4 检测挂载属性 + } + + @override + void dispose() { + _timer.cancel(); // 5 自定义处置逻辑 + super.dispose(); + } +} + +final myNotifierProvider = StateNotifierProvider((ref) { + // 6 提供者程序定义 + final period = ref.watch(durationProvider); // 7 反应式依赖逻辑 + return MyNotifier(ref, period); // 8 传递 `ref` +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.dart new file mode 100644 index 000000000..ad922b1e3 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.dart @@ -0,0 +1,23 @@ +import 'dart:math' as math; + +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'utils.g.dart'; + +@riverpod +int random(RandomRef ref) { + return math.Random().nextInt(6); +} + +@riverpod +TaskTrackerRepo taskTracker(TaskTrackerRef ref) => TaskTrackerRepo(); + +class TaskTrackerRepo { + Future fix({required String id, required int fixed}) async => 0; +} + +@riverpod +Duration duration(DurationRef ref) => Duration.zero; + +@riverpod +int availableWater(AvailableWaterRef ref) => 40; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.g.dart new file mode 100644 index 000000000..72f425f1d --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.g.dart @@ -0,0 +1,254 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'utils.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef RandomRef = Ref; + +@ProviderFor(random) +const randomProvider = RandomProvider._(); + +final class RandomProvider extends $FunctionalProvider + with $Provider { + const RandomProvider._( + {int Function( + RandomRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'randomProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + RandomRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$randomHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RandomProvider $copyWithCreate( + int Function( + RandomRef ref, + ) create, + ) { + return RandomProvider._(create: create); + } + + @override + int create(RandomRef ref) { + final _$cb = _createCb ?? random; + return _$cb(ref); + } +} + +String _$randomHash() => r'789ed69452c1cde06c8a48f69eae2c242e7764ab'; + +typedef TaskTrackerRef = Ref; + +@ProviderFor(taskTracker) +const taskTrackerProvider = TaskTrackerProvider._(); + +final class TaskTrackerProvider extends $FunctionalProvider< + TaskTrackerRepo, + TaskTrackerRepo, + TaskTrackerRef> with $Provider { + const TaskTrackerProvider._( + {TaskTrackerRepo Function( + TaskTrackerRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'taskTrackerProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final TaskTrackerRepo Function( + TaskTrackerRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$taskTrackerHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(TaskTrackerRepo value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + TaskTrackerProvider $copyWithCreate( + TaskTrackerRepo Function( + TaskTrackerRef ref, + ) create, + ) { + return TaskTrackerProvider._(create: create); + } + + @override + TaskTrackerRepo create(TaskTrackerRef ref) { + final _$cb = _createCb ?? taskTracker; + return _$cb(ref); + } +} + +String _$taskTrackerHash() => r'd78149146c3a07b78e7dc1d03fa60ed1941c3702'; + +typedef DurationRef = Ref; + +@ProviderFor(duration) +const durationProvider = DurationProvider._(); + +final class DurationProvider + extends $FunctionalProvider + with $Provider { + const DurationProvider._( + {Duration Function( + DurationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'durationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Duration Function( + DurationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$durationHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Duration value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DurationProvider $copyWithCreate( + Duration Function( + DurationRef ref, + ) create, + ) { + return DurationProvider._(create: create); + } + + @override + Duration create(DurationRef ref) { + final _$cb = _createCb ?? duration; + return _$cb(ref); + } +} + +String _$durationHash() => r'00e8192d47835ec451b18bc2cfc1e8610aa5f5c2'; + +typedef AvailableWaterRef = Ref; + +@ProviderFor(availableWater) +const availableWaterProvider = AvailableWaterProvider._(); + +final class AvailableWaterProvider + extends $FunctionalProvider + with $Provider { + const AvailableWaterProvider._( + {int Function( + AvailableWaterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'availableWaterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + AvailableWaterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$availableWaterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + AvailableWaterProvider $copyWithCreate( + int Function( + AvailableWaterRef ref, + ) create, + ) { + return AvailableWaterProvider._(create: create); + } + + @override + int create(AvailableWaterRef ref) { + final _$cb = _createCb ?? availableWater; + return _$cb(ref); + } +} + +String _$availableWaterHash() => r'7d4e8fb0dd7ff52a78eb569b39c4e472c364aac7'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx index 86f9f374f..9d8f62db8 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider.mdx @@ -2,47 +2,58 @@ title: ChangeNotifierProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import todos from "!!raw-loader!/docs/providers/change_notifier_provider/todos.dart"; import todosConsumer from "!!raw-loader!/docs/providers/change_notifier_provider/todos_consumer.dart"; -import { trimSnippet, Foo } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet } from "@site/src/components/CodeSnippet"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -`ChangeNotifierProvider` (来自 flutter_riverpod/hooks_riverpod) -是一个用于监听和暴露Flutter本身的 [ChangeNotifier] 的provider。 +`ChangeNotifierProvider` (flutter_riverpod/hooks_riverpod only) is a provider that +is used to listen to and expose a [ChangeNotifier] from Flutter itself. -Riverpod不鼓励使用 `ChangeNotifierProvider` ，它的存在主要是为了： +Using `ChangeNotifierProvider` is discouraged by Riverpod and exists primarily for: - an easy transition from `package:provider` when using its `ChangeNotifierProvider` -- 当使用它的 `ChangeNotifierProvider` 时，简单地从 `package:provider` 迁移。 -- 支持可变状态，即使不可变的状态更好。 +- supporting mutable state, even though immutable state is preferred :::info -更倾向于使用 [StateNotifierProvider]。 -只有在绝对需要可变状态时才考虑使用 `ChangeNotifierProvider`。 +Prefer using [NotifierProvider] instead. +Consider using `ChangeNotifierProvider` only if you are absolutely certain +that you want mutable state. ::: -使用可变状态而不是不可变状态有时会更高效。 -但缺点是它可能更难维护，并可能破坏各种功能。 -比如说如果状态是可变的， -用于优化widget重新构建的 `provider.select` 可能不起作用， -因为Select会认为值没有改变。 -因此，使用不可变的数据结构有时会更快。 -制定特定用例的基准测试非常重要，以确保通过使用 `ChangeNotifierProvider` 时能真正获得性能。 +Using mutable state instead of immutable state can sometimes be more efficient. +The downside is, it can be harder to maintain and may break various features. +For example, using `provider.select` to optimize rebuilds of your widgets +may not work if your state is mutable, as `select` will think that the value +hasn't changed. +As such, using immutable data structures can sometimes be faster. Therefore +it is important to make benchmarks specific to your use-case, to make sure +that you are truly gaining performance by using `ChangeNotifierProvider`. -下面是用法示例，我们可以使用 `ChangeNotifierProvider` 来实现待办清单。 -这样做将允许我们公开 `addTodo` 等方法，让UI修改用户交互中的待办清单： +As a usage example, we could use `ChangeNotifierProvider` to implement a todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: {trimSnippet(todos)} -现在我们已经定义了一个 `ChangeNotifierProvider`， -我们可以用它来与UI中的待办清单交互： +Now that we have defined a `ChangeNotifierProvider`, we can use it to interact +with the list of todos in our UI: {trimSnippet(todosConsumer)} [state_notifier]: https://pub.dev/packages/state_notifier [statenotifierprovider]: ./state_notifier_provider +[notifierprovider]: ./notifier_provider [changenotifier]: https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html [provider]: ./provider [futureprovider]: ./future_provider diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart index 219de4b0a..a88c25c71 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/change_notifier_provider/todos.dart @@ -32,16 +32,13 @@ class TodosNotifier extends ChangeNotifier { // Let's mark a todo as completed void toggle(String todoId) { - for (final todo in todos) { - if (todo.id == todoId) { - todo.completed = !todo.completed; - notifyListeners(); - } - } + final todo = todos.firstWhere((todo) => todo.id == todoId); + todo.completed = !todo.completed; + notifyListeners(); } } -// Finally, we are using StateNotifierProvider to allow the UI to interact with +// Finally, we are using ChangeNotifierProvider to allow the UI to interact with // our TodosNotifier class. final todosProvider = ChangeNotifierProvider((ref) { return TodosNotifier(); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider.mdx index 34af86f85..6feb07d83 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider.mdx @@ -3,51 +3,63 @@ title: FutureProvider version: 1 --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; import configProvider from "./future_provider/config_provider"; import configConsumer from "./future_provider/config_consumer"; -import { trimSnippet,AutoSnippet} from "../../../../../src/components/CodeSnippet"; +import { AutoSnippet} from "@site/src/components/CodeSnippet"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -`FutureProvider` 与 [Provider] 类似，但用在异步代码中。 +`FutureProvider` is the equivalent of [Provider] but for asynchronous code. -`FutureProvider` 一般用于： +`FutureProvider` is typically used for: -- 执行和缓存异步操作 (比如网络请求) -- 能很好地处理异步操作中的错误/加载中的状态 -- 将多个异步的值组合为另一个异步的值 +- performing and caching asynchronous operations (such as network requests) +- nicely handling error/loading states of asynchronous operations +- combining multiple asynchronous values into another value -`FutureProvider` 与 [ref.watch] 结合使用有很多好处。 -这种组合允许在某些变量改变时自动重新获取一些数据，确保我们总是拥有最新的值。 +`FutureProvider` gains a lot when combined with [ref.watch]. This combination +allows automatic re-fetching of some data when some variables change, +ensuring that we always have the most up-to-date value. :::info -`FutureProvider` 不提供给用户交互后直接修改计算结果的方法。它被设计用来解决简单的用例。 -对于更高级的场景请考虑使用 [StateNotifierProvider] 。 +`FutureProvider` does not offer a way of directly modifying the computation after +a user interaction. It is designed to solve simple use-cases. +For more advanced scenarios, consider using [AsyncNotifierProvider]. ::: -## 用法示例：读取配置文件 +## Usage example: reading a configuration file -`FutureProvider` 可以是一种通过读取JSON文件创建的 `Configuration` 对象的便捷方法。 +`FutureProvider` can be a convenient way to expose a `Configuration` object +created by reading a JSON file. -在provider内部使用的async/await语法创建配置。 -再加上使用Flutter的资产系统，举个例子： +Creating the configuration would be done with your typical async/await +syntax, but inside the provider. +Using Flutter's asset system, this would be: -接着，UI可以像这样监听配置： +Then, the UI can listen to configurations like so: -这将在 [Future] 完成时自动重新构建UI。 -同时，如果多个widget需要配置，Flutter资产将只载入一次。 +This will automatically rebuild the UI when the [Future] completes. +At the same time, if multiple widgets want the configurations, +the asset will be decoded only once. -如你所见，在widget中监听 `FutureProvider` 会返回一个 [AsyncValue] ， -它允许你处理错误/加载中的状态。 +As you can see, listening to a `FutureProvider` inside a widget returns +an [AsyncValue] – which allows handling the error/loading states. [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider -[statenotifierprovider]: ./state_notifier_provider +[asyncnotifierprovider]: ./notifier_provider [provider]: ./provider [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html [future]: https://api.dart.dev/dart-async/Future-class.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart index 7f8e854f2..a96f35e72 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/codegen.dart @@ -3,17 +3,14 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import '../config_provider/codegen.dart'; - /* SNIPPET START */ Widget build(BuildContext context, WidgetRef ref) { final config = ref.watch(fetchConfigurationProvider); - return config.when( - loading: () => const CircularProgressIndicator(), - error: (err, stack) => Text('Error: $err'), - data: (config) { - return Text(config.host); - }, - ); + return switch (config) { + AsyncError(:final error) => Text('Error: $error'), + AsyncData(:final value) => Text(value.host), + _ => const CircularProgressIndicator(), + }; } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart index 3844b1540..44d9b4df9 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks.dart @@ -11,12 +11,11 @@ class MyConfiguration extends HookConsumerWidget { Widget build(BuildContext context, WidgetRef ref) { final config = ref.watch(configProvider); return Scaffold( - body: config.when( - loading: () => const Center(child: CircularProgressIndicator()), - error: (err, stack) => Center(child: Text('Error: $err')), - data: (config) { - return Center(child: Text(config.host)); + body: switch (config) { + AsyncError(:final error) => Center(child: Text('Error: $error')), + AsyncData(:final value) => Center(child: Text(value.host)), + _ => const Center(child: CircularProgressIndicator()), }, - ),); + ); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart index 9190e55be..ade0628fd 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/hooks_codegen.dart @@ -12,13 +12,11 @@ class MyConfiguration extends HookConsumerWidget { Widget build(BuildContext context, WidgetRef ref) { final config = ref.watch(fetchConfigurationProvider); return Scaffold( - body: config.when( - loading: () => const Center(child: CircularProgressIndicator()), - error: (err, stack) => Center(child: Text('Error: $err')), - data: (config) { - return Center(child: Text(config.host)); - }, - ), + body: switch (config) { + AsyncError(:final error) => Center(child: Text('Error: $error')), + AsyncData(:final value) => Center(child: Text(value.host)), + _ => const Center(child: CircularProgressIndicator()), + }, ); } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart index 4176a3866..9d39f3bcd 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/future_provider/config_consumer/raw.dart @@ -10,11 +10,9 @@ import '../config_provider/raw.dart'; Widget build(BuildContext context, WidgetRef ref) { AsyncValue config = ref.watch(configProvider); - return config.when( - loading: () => const CircularProgressIndicator(), - error: (err, stack) => Text('Error: $err'), - data: (config) { - return Text(config.host); - }, - ); + return switch (config) { + AsyncData(:final value) => Text(value.host), + AsyncError(:final error) => Text('Error: $error'), + _ => const CircularProgressIndicator(), + }; } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx index 54468b905..601f06da1 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider.mdx @@ -2,41 +2,54 @@ title: (Async)NotifierProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import todos from "./notifier_provider/todos"; import todosConsumer from "!!raw-loader!/docs/providers/notifier_provider/todos/todos_consumer.dart"; import remoteTodos from "./notifier_provider/remote_todos"; import remoteTodosConsumer from "!!raw-loader!/docs/providers/notifier_provider/remote_todos/todos_consumer.dart"; -import { trimSnippet, AutoSnippet } from "../../../../../src/components/CodeSnippet"; - -[NotifierProvider] 是一个监听和暴露 [Notifier] 的provider。 -[AsyncNotifier] 是一个可以异步初始化的 [Notifier]。 -[AsyncNotifierProvider] 是一个用于监听和公开 [AsyncNotifier] 的provider。 -`(Async)NotifierProvider` 和 `(Async)Notifier` 是Riverpod推荐的管理状态的方案， -这些状态可能会因用户交互而发生变化。 - -它一般用于： - -- 暴露在对自定义事件做出反应后可以随时间推移变化的状态。 -- 修改某些状态的逻辑(又名“业务逻辑”)集中在一个地方，随着时间的推移也能提高可维护性。 - -作为使用示例，我们使用 [NotifierProvider] 来实现一个待办清单。 -这样做将允许我们公开 `addTodo` 等方法，让UI在用户交互时修改待办清单的列表： +import { trimSnippet, AutoSnippet } from "@site/src/components/CodeSnippet"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: + +[NotifierProvider] is a provider that is used to listen to and expose a [Notifier]. +[AsyncNotifierProvider] is a provider that is used to listen to and expose an [AsyncNotifier]. +[AsyncNotifier] is a [Notifier] that can be asynchronously initialized. +`(Async)NotifierProvider` along with `(Async)Notifier` is Riverpod's recommended solution +for managing state which may change in reaction to a user interaction. + +It is typically used for: + +- exposing a state which can change over time after reacting to custom events. +- centralizing the logic for modifying some state (aka "business logic") in a + single place, improving maintainability over time. + +As a usage example, we could use [NotifierProvider] to implement a todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: -现在我们定义了一个 [NotifierProvider] ，我们可以使用它来与UI中的待办清单列表交互： +Now that we have defined a [NotifierProvider], we can use it to interact +with the list of todos in our UI: {trimSnippet(todosConsumer)} -下面的使用示例，我们可以使用 [AsyncNotifierProvider] 来实现一个远程待办清单列表。 -这样做将允许我们暴露 `addTodo` 等方法，让UI在用户交互时修改待办清单列表： +As a usage example, we could use [AsyncNotifierProvider] to implement a remote todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: -现在我们已经定义了一个 [AsyncNotifierProvider] ，我们可以使用它来与UI中的待办清单交互： +Now that we have defined a [AsyncNotifierProvider], we can use it to interact +with the list of todos in our UI: {trimSnippet(remoteTodosConsumer)} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart index 8e3e06122..e02195f87 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/codegen.dart @@ -28,11 +28,13 @@ class Todo with _$Todo { factory Todo.fromJson(Map json) => _$TodoFromJson(json); } -// 这会生成一个 AsyncNotifier 和 AsyncNotifierProvider。 -// Notifier类将会被传递给我们的 AsyncNotifierProvider。 -// 这个类不应该在其“state”属性之外暴露状态，也就是说没有公共的获取属性的方法！ -// 这个类上的公共方法将允许UI修改它的状态。 -// 最后我们使用asyncTodosProvider(AsyncNotifierProvider)来允许UI与我们的Todos类进行交互。 +// This will generates a AsyncNotifier and AsyncNotifierProvider. +// The AsyncNotifier class that will be passed to our AsyncNotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +// Finally, we are using asyncTodosProvider(AsyncNotifierProvider) to allow the UI to +// interact with our Todos class. @riverpod class AsyncTodos extends _$AsyncTodos { Future> _fetchTodo() async { @@ -43,21 +45,21 @@ class AsyncTodos extends _$AsyncTodos { @override FutureOr> build() async { - // 从远程仓库获取初始的待办清单 + // Load initial todo list from the remote repository return _fetchTodo(); } Future addTodo(Todo todo) async { - // 将当前状态设置为加载中 + // Set the state to loading state = const AsyncValue.loading(); - // 将新的待办清单添加到远程仓库 + // Add the new todo and reload the todo list from the remote repository state = await AsyncValue.guard(() async { await http.post('api/todos', todo.toJson()); return _fetchTodo(); }); } - // 让我们允许删除待办清单 + // Let's allow removing todos Future removeTodo(String todoId) async { state = const AsyncValue.loading(); state = await AsyncValue.guard(() async { @@ -66,7 +68,7 @@ class AsyncTodos extends _$AsyncTodos { }); } - // 让我们把待办清单标记为已完成 + // Let's mark a todo as completed Future toggle(String todoId) async { state = const AsyncValue.loading(); state = await AsyncValue.guard(() async { diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart index e91f812e1..f4455a338 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/raw.dart @@ -14,8 +14,8 @@ final http = Http(); /* SNIPPET START */ -// 最好使用不可变状态。 -// 我们还可以使用像 freezed 这样的package来帮助实现不可变。 +// An immutable state is preferred. +// We could also use packages like Freezed to help with the implementation. @immutable class Todo { const Todo({ @@ -32,7 +32,7 @@ class Todo { ); } - // 在我们的类中所有的属性都应该是 `final` 的。 + // All properties should be `final` on our class. final String id; final String description; final bool completed; @@ -44,9 +44,10 @@ class Todo { }; } -// Notifier类将会被传递给我们的NotifierProvider。 -// 这个类不应该在其“state”属性之外暴露状态，也就是说没有公共的获取属性的方法！ -// 这个类上的公共方法将允许UI修改它的状态。 +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. class AsyncTodosNotifier extends AsyncNotifier> { Future> _fetchTodo() async { final json = await http.get('api/todos'); @@ -56,21 +57,21 @@ class AsyncTodosNotifier extends AsyncNotifier> { @override Future> build() async { - // 从远程仓库获取初始的待办清单 + // Load initial todo list from the remote repository return _fetchTodo(); } Future addTodo(Todo todo) async { - // 将当前状态设置为加载中 + // Set the state to loading state = const AsyncValue.loading(); - // 将新的待办清单添加到远程仓库 + // Add the new todo and reload the todo list from the remote repository state = await AsyncValue.guard(() async { await http.post('api/todos', todo.toJson()); return _fetchTodo(); }); } - // 让我们允许删除待办清单 + // Let's allow removing todos Future removeTodo(String todoId) async { state = const AsyncValue.loading(); state = await AsyncValue.guard(() async { @@ -79,7 +80,7 @@ class AsyncTodosNotifier extends AsyncNotifier> { }); } - // 让我们把待办清单标记为已完成 + // Let's mark a todo as completed Future toggle(String todoId) async { state = const AsyncValue.loading(); state = await AsyncValue.guard(() async { @@ -92,7 +93,8 @@ class AsyncTodosNotifier extends AsyncNotifier> { } } -// 最后，我们使用NotifierProvider来允许UI与我们的TodosNotifier类交互。 +// Finally, we are using NotifierProvider to allow the UI to interact with +// our TodosNotifier class. final asyncTodosProvider = AsyncNotifierProvider>(() { return AsyncTodosNotifier(); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart index ae829eee4..5d00d05d9 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/remote_todos/todos_consumer.dart @@ -16,23 +16,22 @@ class TodoListView extends ConsumerWidget { final asyncTodos = ref.watch(asyncTodosProvider); // Let's render the todos in a scrollable list view - return asyncTodos.when( - data: (todos) => ListView( - children: [ - for (final todo in todos) - CheckboxListTile( - value: todo.completed, - // When tapping on the todo, change its completed status - onChanged: (value) => - ref.read(asyncTodosProvider.notifier).toggle(todo.id), - title: Text(todo.description), - ), - ], - ), - loading: () => const Center( - child: CircularProgressIndicator(), - ), - error: (err, stack) => Text('Error: $err'), - ); + return switch (asyncTodos) { + AsyncData(:final value) => ListView( + children: [ + for (final todo in value) + CheckboxListTile( + value: todo.completed, + // When tapping on the todo, change its completed status + onChanged: (value) { + ref.read(asyncTodosProvider.notifier).toggle(todo.id); + }, + title: Text(todo.description), + ), + ], + ), + AsyncError(:final error) => Text('Error: $error'), + _ => const Center(child: CircularProgressIndicator()), + }; } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart index b1999c2ea..866ed37bb 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/codegen.dart @@ -15,11 +15,13 @@ class Todo with _$Todo { }) = _Todo; } -// 这会生成一个Notifier 和 NotifierProvider。 -// Notifier类将会被传递给我们的NotifierProvider。 -// 这个类不应该在其“state”属性之外暴露状态，也就是说没有公共的获取属性的方法！ -// 这个类上的公共方法将允许UI修改它的状态。 -// 最后我们使用todosProvider(NotifierProvider)来允许UI与我们的Todos类进行交互。 +// This will generates a Notifier and NotifierProvider. +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. +// Finally, we are using todosProvider(NotifierProvider) to allow the UI to +// interact with our Todos class. @riverpod class Todos extends _$Todos { @override @@ -27,37 +29,39 @@ class Todos extends _$Todos { return []; } - // 让我们添加UI添加待办清单 + // Let's allow the UI to add todos. void addTodo(Todo todo) { - // 由于状态是不可变的，因此不允许执行 `state.add(todo)`。 - // 相反，我们应该创建一个包含以前的项目和新的项目的待办清单列表。 - // 在这里使用Dart的扩展运算符很有用！ + // Since our state is immutable, we are not allowed to do `state.add(todo)`. + // Instead, we should create a new list of todos which contains the previous + // items and the new one. + // Using Dart's spread operator here is helpful! state = [...state, todo]; - // 不需要调用“notifyListeners”或其他类似的方法。 - // 直接 “state =” 就能自动在需要时重新构建UI。 + // No need to call "notifyListeners" or anything similar. Calling "state =" + // will automatically rebuild the UI when necessary. } - // 让我们允许删除待办清单 + // Let's allow removing todos void removeTodo(String todoId) { - // 同样我们的状态是不可变的。 - // 所以我们创建了一个新的列表，而不是改变现存的列表。 + // Again, our state is immutable. So we're making a new list instead of + // changing the existing list. state = [ for (final todo in state) if (todo.id != todoId) todo, ]; } - // 让我们把待办清单标记为已完成 + // Let's mark a todo as completed void toggle(String todoId) { state = [ for (final todo in state) - // 我们只标记完成的待办清单 + // we're marking only the matching todo as completed if (todo.id == todoId) - // 再一次因为我们的状态是不可变的，所以我们需要创建待办清单的副本， - // 我们使用之前实现的copyWith方法来实现。 + // Once more, since our state is immutable, we need to make a copy + // of the todo. We're using our `copyWith` method implemented before + // to help with that. todo.copyWith(completed: !todo.completed) else - // 其他未修改的待办清单 + // other todos are not modified todo, ]; } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart index 05a3c7174..ec3e50308 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/raw.dart @@ -3,8 +3,8 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; /* SNIPPET START */ -// 最好使用不可变状态。 -// 我们还可以使用像 freezed 这样的package来帮助实现不可变。 +// An immutable state is preferred. +// We could also use packages like Freezed to help with the implementation. @immutable class Todo { const Todo({ @@ -13,12 +13,13 @@ class Todo { required this.completed, }); - // 在我们的类中所有的属性都应该是 `final` 的。 + // All properties should be `final` on our class. final String id; final String description; final bool completed; - // 由于Todo是不可变的，我们实现了一种方法允许克隆内容略有不同的Todo。 + // Since Todo is immutable, we implement a method that allows cloning the + // Todo with slightly different content. Todo copyWith({String? id, String? description, bool? completed}) { return Todo( id: id ?? this.id, @@ -28,53 +29,57 @@ class Todo { } } -// Notifier类将会被传递给我们的NotifierProvider。 -// 这个类不应该在其“state”属性之外暴露状态，也就是说没有公共的获取属性的方法！ -// 这个类上的公共方法将允许UI修改它的状态。 +// The Notifier class that will be passed to our NotifierProvider. +// This class should not expose state outside of its "state" property, which means +// no public getters/properties! +// The public methods on this class will be what allow the UI to modify the state. class TodosNotifier extends Notifier> { - // 我们将待办清单的列表初始化 + // We initialize the list of todos to an empty list @override List build() { return []; } - // 让我们添加UI添加待办清单 + // Let's allow the UI to add todos. void addTodo(Todo todo) { - // 由于状态是不可变的，因此不允许执行 `state.add(todo)`。 - // 相反，我们应该创建一个包含以前的项目和新的项目的待办清单列表。 - // 在这里使用Dart的扩展运算符很有用！ + // Since our state is immutable, we are not allowed to do `state.add(todo)`. + // Instead, we should create a new list of todos which contains the previous + // items and the new one. + // Using Dart's spread operator here is helpful! state = [...state, todo]; - // 不需要调用“notifyListeners”或其他类似的方法。 - // 直接 “state =” 就能自动在需要时重新构建UI。 + // No need to call "notifyListeners" or anything similar. Calling "state =" + // will automatically rebuild the UI when necessary. } - // 让我们允许删除待办清单 + // Let's allow removing todos void removeTodo(String todoId) { - // 同样我们的状态是不可变的。 - // 所以我们创建了一个新的列表，而不是改变现存的列表。 + // Again, our state is immutable. So we're making a new list instead of + // changing the existing list. state = [ for (final todo in state) if (todo.id != todoId) todo, ]; } - // 让我们把待办清单标记为已完成 + // Let's mark a todo as completed void toggle(String todoId) { state = [ for (final todo in state) - // 我们只标记完成的待办清单 + // we're marking only the matching todo as completed if (todo.id == todoId) - // 再一次因为我们的状态是不可变的，所以我们需要创建待办清单的副本， - // 我们使用之前实现的copyWith方法来实现。 + // Once more, since our state is immutable, we need to make a copy + // of the todo. We're using our `copyWith` method implemented before + // to help with that. todo.copyWith(completed: !todo.completed) else - // 其他未修改的待办清单 + // other todos are not modified todo, ]; } } -// 最后，我们使用NotifierProvider来允许UI与我们的TodosNotifier类交互。 +// Finally, we are using NotifierProvider to allow the UI to interact with +// our TodosNotifier class. final todosProvider = NotifierProvider>(() { return TodosNotifier(); }); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart index 23430ced6..192cb9f66 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/notifier_provider/todos/todos_consumer.dart @@ -12,16 +12,16 @@ class TodoListView extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 当待办事项列表变更时重新构建widget + // rebuild the widget when the todo list changes List todos = ref.watch(todosProvider); - // 让我们在一个可滚动的列表视图中呈现待办清单 + // Let's render the todos in a scrollable list view return ListView( children: [ for (final todo in todos) CheckboxListTile( value: todo.completed, - // 当在清单上点击时更改它的完成状态。 + // When tapping on the todo, change its completed status onChanged: (value) => ref.read(todosProvider.notifier).toggle(todo.id), title: Text(todo.description), diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider.mdx index a0e1f05f7..d0ed99725 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider.mdx @@ -2,86 +2,108 @@ title: Provider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import todo from "./provider/todo"; import completedTodos from "./provider/completed_todos"; import todosConsumer from "!!raw-loader!/docs/providers/provider/todos_consumer.dart"; import unoptimizedPreviousButton from "./provider/unoptimized_previous_button"; import optimizedPreviousButton from "./provider/optimized_previous_button"; -import { trimSnippet, AutoSnippet } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet, AutoSnippet } from "@site/src/components/CodeSnippet"; -在所有的provider中 `Provider` 是最基础的。它创造了一个值……差不多就是这样。 +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -`Provider` 一般用在： +`Provider` is the most basic of all providers. It creates a value... And that's about it. -- 缓存计算。 -- 向其他provider(比如`Repository`/`HttpClient`)暴露一个值。 -- 为测试或widget提供重写值的方法。 -- 减少 provider/widget 的重新构建，不必使用 `select`。 +`Provider` is typically used for: -## 使用 `Provider` 缓存计算 +- caching computations +- exposing a value to other providers (such as a `Repository`/`HttpClient`). +- offering a way for tests or widgets to override a value. +- reducing rebuilds of providers/widgets without having to use `select`. -`Provider` 是与 [ref.watch] 结合使用时用于缓存同步操作的强大的工具。 +## Using `Provider` to cache computations -例如筛选待办清单。 -由于筛选列表的性能开销可能略高，所以理想情况下，当应用重新渲染时我们不希望再筛选一遍待办列表。 -在这种情况，我们可以使用 `Provider` 为我们进行筛选。 +`Provider` is a powerful tool for caching synchronous operations when combined +with [ref.watch]. -为此，假设我们的应用程序有一个 [StateNotifierProvider] ，它操作待办清单的列表： +An example would be filtering a list of todos. +Since filtering a list could be slightly expensive, we ideally do not want to +filter our list of todos whenever our application re-renders. +In this situation, we could use `Provider` to do the filtering for us. + +For that, assume that our application has an existing [NotifierProvider] +which manipulates a list of todos: -接着，我们可以使用 `Provider` 暴露经过筛选的待办清单列表，只显示完成的待办事项： +From there, we can use `Provider` to expose the filtered list of todos, showing +only the completed todos: -使用这段代码，我们的UI现在可以通过监听 `completedTodosProvider` 来显示完成的待办清单列表： +With this code, our UI is now able to show the list of the completed todos +by listening to `completedTodosProvider`: {trimSnippet(todosConsumer)} -有趣的是，这个筛选列表现在被缓存起来了。 +The interesting part is, the list filtering is now cached. -这也就意味着不管我们阅读多少次已经完成的待办清单，只要在添加/删除/更新待办清单之前， -这个筛选的列表也不会被重新计算。 +Meaning that the list of completed todos will not be recomputed until +todos are added/removed/updated, even if we are reading the list of completed +todos multiple times. -注意，当待办清单列表发生更改时我们不需要手动使缓存失效。多亏了 [ref.watch] ， -`Provider`能够自动知道什么时候应该重新计算结果。 +Note how we do not need to manually invalidate the cache when the list of todos +changes. `Provider` is automatically able to know when the result must be recomputed +thanks to [ref.watch]. -## 使用`Provider` 减少provider/widget的重新构建 +## Reducing provider/widget rebuilds by using `Provider` -`Provider` 独特的地方在于，就算在重新计算 `Provider` 时(通常在使用[ref.watch]时)， -它也不会更新监听它的widget/provider，除非当中的值发生了变化。 +A unique aspect of `Provider` is that even when `Provider` is recomputed +(typically when using [ref.watch]), it will not update the widgets/providers +that listen to it unless the value changed. -一个真实的例子是启用/禁用分页视图中的上一个/下一个按钮： +A real world example would be for enabling/disabling previous/next buttons +of a paginated view: ![stepper example](https://user-images.githubusercontent.com/134939/47580830-31263a00-d950-11e8-9b61-0eaddab2709e.png) -在这个例子中，我们特别关注在这个“previous”按钮。 -这个按钮将用widget实现，它获取当前页面的索引，如果索引为0时，我们将禁用这个按钮。 +In our case, we will focus specifically on the "previous" button. +A naive implementation of such button would be a widget which obtains the +current page index, and if that index is equal to 0, we would disable the button. -这段代码可以是： +This code could be: -这段代码的问题是，每当我们更改当前页面时，“previous”按钮将重新构建。 -在理想情况下，我们希望按钮仅在激活和停用之间更改时重新构建。 +The issue with this code is that whenever we change the current page, the "previous" +button will rebuild. +In the ideal world, we would want the button to rebuild only when changing between +activated and deactivated. -但问题的根源在于我们在build函数内计算是否允许用户在“previous”按钮内直接转到上一页。 +The root of the issue here is that we are computing whether the user is +allowed to go to the previous page directly within the "previous" button. -为了解决这个问题，我们将这个逻辑从widget中提取出来放到provider里面： +A way to solve this is to extract this logic outside of the widget and into a `Provider`: -通过这样的小重构，多亏了 `Provider` 我们的 `PreviousButton` widget 当页面索引变化时将不再重新构建。 +By doing this small refactoring, our `PreviousButton` widget will no longer +rebuild when the page index changes thanks to `Provider`. -从现在开始，当页面索引改变时，我们的 `canGoToPreviousPageProvider` 将被重新计算。 -但是如果provider暴露的值没有改变，那么 `PreviousButton` 将不会重新构建。 +From now on when the page index changes, our `canGoToPreviousPageProvider` provider +will be recomputed. But if the value exposed by the provider does not change, +then `PreviousButton` will not rebuild. This change both improved the performance of our button and had the interesting benefit of extracting the logic outside of our widget. -这一更改提高了按钮的性能，还有一个有趣的好处，就是将逻辑抽离到widget之外。 [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider -[statenotifierprovider]: ./state_notifier_provider +[notifierprovider]: ./notifier_provider diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart index 3529f403e..1a29d96f5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/completed_todos.dart @@ -10,6 +10,6 @@ part 'completed_todos.g.dart'; List completedTodos(CompletedTodosRef ref) { final todos = ref.watch(todosProvider); - // 我们只返回完成的待办事项 + // we return only the completed todos return todos.where((todo) => todo.isCompleted).toList(); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart index 568f13865..e24c48bd5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/completed_todos/raw.dart @@ -5,9 +5,9 @@ import '../todo/raw.dart'; /* SNIPPET START */ final completedTodosProvider = Provider>((ref) { - // 我们从todosProvider获取所有待办清单 + // We obtain the list of all todos from the todosProvider final todos = ref.watch(todosProvider); - // // 我们只返回完成的待办事项 + // we return only the completed todos return todos.where((todo) => todo.isCompleted).toList(); }); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart index 4c4d99d7f..7d3b8a332 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/optimized_previous_button.dart @@ -19,7 +19,7 @@ class PageIndex extends _$PageIndex { } } -// 一个计算是否允许用户跳转到上一页的provider +// A provider which computes whether the user is allowed to go to the previous page @riverpod /* highlight-start */ bool canGoToPreviousPage(CanGoToPreviousPageRef ref) { @@ -32,8 +32,8 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 现在我们观察我们新的provider， - // 当我们跳转到前一页时我们的widget不再需要计算。 + // We are now watching our new Provider + // Our widget is no longer calculating whether we can go to the previous page. /* highlight-start */ final canGoToPreviousPage = ref.watch(canGoToPreviousPageProvider); /* highlight-end */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart index 13af06e5a..a4d3cb4b9 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/optimized_previous_button/raw.dart @@ -7,7 +7,7 @@ import 'package:flutter_riverpod/legacy.dart'; final pageIndexProvider = StateProvider((ref) => 0); -// 一个计算是否允许用户跳转到上一页的provider +// A provider which computes whether the user is allowed to go to the previous page /* highlight-start */ final canGoToPreviousPageProvider = Provider((ref) { /* highlight-end */ @@ -19,8 +19,8 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 现在我们观察我们新的provider， - // 当我们跳转到前一页时我们的widget不再需要计算。 + // We are now watching our new Provider + // Our widget is no longer calculating whether we can go to the previous page. /* highlight-start */ final canGoToPreviousPage = ref.watch(canGoToPreviousPageProvider); /* highlight-end */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart index 5ba7906e6..11e62bc3a 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/raw.dart @@ -1,7 +1,6 @@ // ignore_for_file: avoid_positional_boolean_parameters import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ @@ -11,15 +10,18 @@ class Todo { final String description; } -class TodosNotifier extends StateNotifier> { - TodosNotifier() : super([]); +class TodosNotifier extends Notifier> { + @override + List build() { + return []; + } void addTodo(Todo todo) { state = [...state, todo]; } - // TODO 添加其他方法，比如 “删除待办” …… + // TODO add other methods, such as "removeTodo", ... } -final todosProvider = StateNotifierProvider>((ref) { +final todosProvider = NotifierProvider>(() { return TodosNotifier(); }); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart index 34c3d432c..7089bc962 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todo/todo.dart @@ -21,4 +21,5 @@ class Todos extends _$Todos { void addTodo(Todo todo) { state = [...state, todo]; } + // TODO add other methods, such as "removeTodo", ... } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart index 69b73e5fd..96471e694 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/todos_consumer.dart @@ -10,7 +10,7 @@ Widget build() { /* SNIPPET START */ Consumer(builder: (context, ref, child) { final completedTodos = ref.watch(completedTodosProvider); - // TODO 使用ListView/GridView/……展示待办清单列表 /* SKIP */ + // TODO show the todos using a ListView/GridView/.../* SKIP */ return Container(); /* SKIP END */ },); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart index 537cd328a..b670eaae3 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/raw.dart @@ -12,7 +12,7 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 如果不是第一页，那么前一页按钮可用 + // if not on first page, the previous button is active final canGoToPreviousPage = ref.watch(pageIndexProvider) != 0; void goToPreviousPage() { diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart index 350d12563..f77de56c3 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/provider/unoptimized_previous_button/unoptimized_previous_button.dart @@ -24,7 +24,7 @@ class PreviousButton extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { - // 如果不是第一页，那么前一页按钮可用 + // if not on first page, the previous button is active final canGoToPreviousPage = ref.watch(pageIndexProvider) != 0; void goToPreviousPage() { diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx index 9d0e1f475..1c237a279 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider.mdx @@ -2,30 +2,43 @@ title: StateNotifierProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import todos from "!!raw-loader!/docs/providers/state_notifier_provider/todos.dart"; import todosConsumer from "!!raw-loader!/docs/providers/state_notifier_provider/todos_consumer.dart"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet } from "@site/src/components/CodeSnippet"; + +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -`StateNotifierProvider` 是一个用于监听和公开StateNotifier的provider(来自 [state_notifier] package，由Riverpod重新分发)。 +`StateNotifierProvider` is a provider that is used to listen to and expose a +[StateNotifier] (from the package [state_notifier], which Riverpod re-exports). -它一般用于： +It is typically used for: -- 暴露一个 **不可变** 的状态，在对自定义事件做出反应后可以随时间改变。 -- 修改某些状态的逻辑(又名“业务逻辑”)集中在一个地方，随着时间的推移也能提高可维护性。 +- exposing an **immutable** state which can change over time after reacting to + custom events. +- centralizing the logic for modifying some state (aka "business logic") in a + single place, improving maintainability over time. :::info -首选 [NotifierProvider] 。 +Prefer using [NotifierProvider] instead. ::: -我们可以使用 `StateNotifierProvider` 来实现一个待办清单列表。 -这样做将允许我们公开 `addTodo` 等方法，让UI在用户交互时修改todo列表，下面是示例： +As a usage example, we could use `StateNotifierProvider` to implement a todo-list. +Doing so would allow us to expose methods such as `addTodo` to let the UI +modify the list of todos on user interactions: {trimSnippet(todos)} -现在我们已经定义了 `StateNotifierProvider` ，我们可以使用它来与UI中的待办清单列表交互： +Now that we have defined a `StateNotifierProvider`, we can use it to interact +with the list of todos in our UI: {trimSnippet(todosConsumer)} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider.mdx index 5aa4aa926..c65a571dd 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_provider.mdx @@ -2,8 +2,6 @@ title: StateProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; import product from "!!raw-loader!/docs/providers/state_provider/product.dart"; import productListView from "!!raw-loader!/docs/providers/state_provider/product_list_view.dart"; @@ -13,105 +11,125 @@ import connectedDropdown from "!!raw-loader!/docs/providers/state_provider/conne import sortedProductProvider from "!!raw-loader!/docs/providers/state_provider/sorted_product_provider.dart"; import updateReadTwice from "!!raw-loader!/docs/providers/state_provider/update_read_twice.dart"; import updateReadOnce from "!!raw-loader!/docs/providers/state_provider/update_read_once.dart"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; +import { trimSnippet } from "@site/src/components/CodeSnippet"; -StateProvider是一个公开了一种修改其状态的方法的provider。 -它是 [StateNotifierProvider] 的简化版，旨在避免为非常简单的用例编写 [StateNotifier] 类。 +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: -`StateProvider` 的存在主要是为了允许用户界面对**简单**的变量进行修改。 -所以`StateProvider` 的状态通常为： +`StateProvider` is a provider that exposes a way to modify its state. +It is a simplification of [NotifierProvider], designed to avoid +having to write a [Notifier] class for very simple use-cases. -- 枚举类型，例如筛选器类型 -- 一段字符串(String)，通常是输入框的原始内容 -- 用于复选框的布尔类型 -- 用于分页或年龄表单字段的数字 +`StateProvider` exists primarily to allow the modification of +**simple** variables by the User Interface. +The state of a `StateProvider` is typically one of: -你不应该使用 `StateProvider` 如果： +- an enum, such as a filter type +- a String, typically the raw content of a text field +- a boolean, for checkboxes +- a number, for pagination or age form fields -- 你的状态需要验证逻辑 -- 你的状态是一个复杂的对象 (比如自定义的类, 集合……) -- 修改状态的逻辑比简单的 `count++` 更复杂 +You should not use `StateProvider` if: -对于更复杂的情况，可以考虑使用 [StateNotifierProvider] ，并创建一个 [StateNotifier] 类。 -虽然最初的样板文件会有点大， -但有一个自定义的 [StateNotifier] 类对于项目的长期可维护性是至关重要的， -因为它将状态的业务逻辑集中在了一个地方。 +- your state needs validation logic +- your state is a complex object (such as a custom class, a list/map, ...) +- the logic for modifying your state is more advanced than a simple `count++`. -## 使用示例：使用下拉菜单更改筛选类型 +For more advanced cases, consider using [NotifierProvider] instead and +create a [Notifier] class. +While the initial boilerplate will be a bit larger, having a custom +[Notifier] class is critical for the long-term maintainability of your +project – as it centralizes the business logic of your state in a single place. -`StateProvider` 的一个真实的用例是管理简单表单组件的状态，比如下拉菜单/输入框/复选框。 -特别来说，我们将看到如何使用 `StateProvider` 实现一个下拉菜单， -该下拉菜单允许更改产品列表的排序方式。 +## Usage example: Changing the filter type using a dropdown -为了简单起见，我们将在应用中直接构建将获得的产品列表，如下所示： +A real-world use-case of `StateProvider` would be to manage the state of +simple form components like dropdowns/text fields/checkboxes. +In particular, we will see how to use `StateProvider` to implement a dropdown +that allows changing how a list of products is sorted. + +For the sake of simplicity, the list of products that we will obtain +will be built directly in the application and will be as follows: {trimSnippet(product)} -在真实的应用程序中，我们通常会使用 [FutureProvider] 通过网络请求来获得该列表。 +In a real-world application, this list would typically be obtained using +[FutureProvider] by making a network request. -然后，可以在用户界面上通过下面的操作来显示产品列表： +The User Interface could then show the list of products by doing: {trimSnippet(productListView)} -现在我们已经完成了基础，我们可以添加一个下拉菜单， -它将按价格或名称过滤我们的产品。 -为此，我们将使用[DropDownButton](https://api.flutter.dev/flutter/material/DropdownButton-class.html)。 +Now that we're done with the base, we can add a dropdown, which will +allow filtering our products either by price or by name. +For that, we will use [DropDownButton](https://api.flutter.dev/flutter/material/DropdownButton-class.html). {trimSnippet(dropdown)} -现在我们有了一个下拉列表， -让我们创建一个 `StateProvider` 并将下拉菜单的状态与我们的provider同步。 +Now that we have a dropdown, let's create a `StateProvider` and +synchronize the state of the dropdown with our provider. -首先，让我们创建一个 `StateProvider`： +First, let's create the `StateProvider`: {trimSnippet(sortProvider)} -然后，我们可以通过下面的操作将这个provider与我们的下拉菜单连接起来： +Then, we can connect this provider with our dropdown by doing: {trimSnippet(connectedDropdown)} -有了这些，我们现在应该能够更改筛选的类型。 -不过它对产品列表没有影响！ -现在是最后一部分：更新我们的 `productsProvider` 以对产品列表进行排序。 +With this, we should now be able to change the sort type. +It has no impact on the list of products yet though! It's now time for the +final part: Updating our `productsProvider` to sort the list of products. -实现这一点的关键是使用 [ref.watch]， -让我们的 `productsProvider` 获得排序类型， -并在排序类型更改时重新计算产品列表。 +A key component of implementing this is to use [ref.watch], to have +our `productsProvider` obtain the sort type and recompute the list of +products whenever the sort type changes. -代码实现会是： +The implementation would be: {trimSnippet(sortedProductProvider)} -就是这样！这个变改足以让用户界面在排序类型更改时自动重绘产品列表。 +That's all! This change is enough for the User Interface to automatically +re-render the list of products when the sort type changes. -下面是在Dartpad上完整的例子： +Here is the complete example on Dartpad: -## 如何在不读取provider两次的情况下根据之前的值更新状态 +## How to update the state based on the previous value without reading the provider twice -有时你希望根据之前的值更新 `StateProvider` 的状态。 -自然而然，你可能会这样写： +Sometimes, you want to update the state of a `StateProvider` based on the previous value. +Naturally, you may end-up writing: {trimSnippet(updateReadTwice)} -虽然这段代码没有什么特别的错误，但是语法上着实有点不太方便。 +While there's nothing particularly wrong with this snippet, the syntax is a bit inconvenient. -为了更方便地使用，我们可以使用 `update` 函数。 -这个函数将接受一个回调函数，该回调函数将接收当前状态并返回新状态。 -我们可以使用它来重构之前的代码： +To make the syntax a bit better, we can use the `update` function. +This function will take a callback that will receive the current state and is expected +to return the new state. +We can use it to refactor our previous code to: {trimSnippet(updateReadOnce)} -这样就实现了相同的效果，而且使语法更好一些。 +This change achieves the same effect while making the syntax a bit better. [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider [ref.read]: ../concepts/reading#using-refread-to-obtain-the-state-of-a-provider-once [statenotifierprovider]: ./state_notifier_provider +[notifierprovider]: ./notifier_provider [futureprovider]: ./future_provider +[notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html [statenotifier]: https://pub.dev/documentation/state_notifier/latest/state_notifier/StateNotifier-class.html [provider]: ./provider [asyncvalue]: https://pub.dev/documentation/riverpod/latest/riverpod/AsyncValue-class.html diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx index 5f6ff9be1..752b64aff 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider.mdx @@ -2,33 +2,54 @@ title: StreamProvider --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; import CodeBlock from "@theme/CodeBlock"; -import { trimSnippet } from "../../../../../src/components/CodeSnippet"; -import streamProvider from "!!raw-loader!/docs/providers/stream_provider/live_stream_chat_provider.dart"; +import { trimSnippet,AutoSnippet } from "@site/src/components/CodeSnippet"; +import streamProvider from "./stream_provider/live_stream_chat_provider"; import streamConsumer from "!!raw-loader!/docs/providers/stream_provider/live_stream_chat_consumer.dart"; +:::caution + +本页内容可能已经过时。 +今后会进行更新，但目前您可能需要参考侧边栏顶部的内容（介绍/要点/应用案例/......）。 +::: + `StreamProvider` is similar to [FutureProvider] but for [Stream]s instead of [Future]s. -`FutureProvider` 与 [Provider] 类似，但用在 [Stream] 中而不是 [Future]。 -`StreamProvider` 一般用于： +`StreamProvider` is usually used for: + +- listening to Firebase or web-sockets +- rebuilding another provider every few seconds + +Since [Stream]s naturally expose a way for listening to updates, some may think +that using `StreamProvider` has a low value. In particular, you may believe that +Flutter's [StreamBuilder] would work just as well for listening to a [Stream], but +this is a mistake. + +Using `StreamProvider` over [StreamBuilder] has numerous benefits: -- 监听Firebase或web-sockets -- 每隔几秒重建另一个provider +- it allows other providers to listen to the stream using [ref.watch]. +- it ensures that loading and error cases are properly handled, thanks to [AsyncValue]. +- it removes the need for having to differentiate broadcast streams vs normal streams. +- it caches the latest value emitted by the stream, ensuring that if a + listener is added after an event is emitted, the listener will still have + immediate access to the most up-to-date event. +- it allows easily mocking the stream during tests by overriding the `StreamProvider`. -由于 [Stream] 自然地公开了一种监听更新的方式，一些人可能认为使用 `StreamProvider` 没什么用。 -特别是，你可能认为Flutter的 [StreamBuilder] 可以很好地用于监听流，但这是错误的。 +## Usage example: live chat using sockets -在 [StreamBuilder] 上使用 `StreamProvider` 有很多好处： +`StreamProvider` is used in when we handle stream of asynchronous data +such as Video Streaming, Weather broadcasting Apis or Live chat as follows: -- 它允许其他provider使用 [ref.watch] 监听流。 -- 多亏了 [AsyncValue] ，它能确保加载和错误情况得到正确处理。 -- 它消除了必须区分广播流和普通流的需要。 -- 它缓存由流发出的最新值，确保如果在事件发出后添加监听器， - 监听器仍然可以立即访问最新的事件。 -- 它允许在测试期间通过覆盖 `StreamProvider` 轻松地模拟流。 + + +Then, the UI can listen to live streaming chats like so: + +{trimSnippet(streamConsumer)} [ref.watch]: ../concepts/reading#using-refwatch-to-observe-a-provider [statenotifierprovider]: ./state_notifier_provider @@ -39,14 +60,4 @@ import streamConsumer from "!!raw-loader!/docs/providers/stream_provider/live_st [stream]: https://api.dart.dev/dart-async/Stream-class.html [stream.periodic]: https://api.dart.dev/stable/2.15.1/dart-async/Stream/Stream.periodic.html [family]: ../concepts/modifiers/family -[streambuilder]: https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html - -## 用法示例：使用套接字的实时聊天 - -`StreamProvider` 用于处理异步数据流，如视频流、天气广播Api。 - -{trimSnippet(streamProvider)} - -然后，UI就可以像这样聊天了： - -{trimSnippet(streamConsumer)} +[streambuilder]: https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html \ No newline at end of file diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart index 79c186f7a..383def216 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_consumer.dart @@ -6,21 +6,20 @@ import 'live_stream_chat_provider.dart'; /* SNIPPET START */ Widget build(BuildContext context, WidgetRef ref) { final liveChats = ref.watch(chatProvider); + // Like FutureProvider, it is possible to handle loading/error states using AsyncValue.when - return liveChats.when( - loading: () => const CircularProgressIndicator(), - error: (error, stackTrace) => Text(error.toString()), - data: (messages) { - // Display all the messages in a scrollable list view. - return ListView.builder( + return switch (liveChats) { + // Display all the messages in a scrollable list view. + AsyncData(:final value) => ListView.builder( // Show messages from bottom to top reverse: true, - itemCount: messages.length, + itemCount: value.length, itemBuilder: (context, index) { - final message = messages[index]; + final message = value[index]; return Text(message); }, - ); - }, - ); + ), + AsyncError(:final error) => Text(error.toString()), + _ => const CircularProgressIndicator(), + }; } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart new file mode 100644 index 000000000..e2e34878c --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.dart @@ -0,0 +1,23 @@ +// ignore_for_file: avoid_unused_constructor_parameters + +import 'dart:convert'; +import 'dart:io'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'codegen.g.dart'; + +/* SNIPPET START */ + +@riverpod +Stream> chat(ChatRef ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +} diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart new file mode 100644 index 000000000..2ceb077d7 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -0,0 +1,66 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names + +part of 'codegen.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ChatRef = Ref>>; + +@ProviderFor(chat) +const chatProvider = ChatProvider._(); + +final class ChatProvider extends $FunctionalProvider>, + Stream>, ChatRef> + with $FutureModifier>, $StreamProvider, ChatRef> { + const ChatProvider._( + {Stream> Function( + ChatRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'chatProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream> Function( + ChatRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$chatHash(); + + @$internal + @override + $StreamProviderElement> $createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ChatProvider $copyWithCreate( + Stream> Function( + ChatRef ref, + ) create, + ) { + return ChatProvider._(create: create); + } + + @override + Stream> create(ChatRef ref) { + final _$cb = _createCb ?? chat; + return _$cb(ref); + } +} + +String _$chatHash() => r'db1302132f90e854fe2f5da9d97d89c9a3c8b858'; + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx new file mode 100644 index 000000000..339b89a56 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/index.tsx @@ -0,0 +1,9 @@ +import raw from "!!raw-loader!./raw.dart"; +import codegen from "!!raw-loader!./codegen.dart"; + +export default { + raw, + hooks: raw, + codegen, + hooksCodegen: codegen, +}; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart new file mode 100644 index 000000000..beb2bcd05 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/stream_provider/live_stream_chat_provider/raw.dart @@ -0,0 +1,18 @@ +import 'dart:convert'; +import 'dart:io'; + +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +/* SNIPPET START */ +final chatProvider = StreamProvider>((ref) async* { + // Connect to an API using sockets, and decode the output + final socket = await Socket.connect('my-api', 4242); + ref.onDispose(socket.close); + + var allMessages = const []; + await for (final message in socket.map(utf8.decode)) { + // A new message has been received. Let's add it to the list of all messages. + allMessages = [...allMessages, message]; + yield allMessages; + } +}); diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx deleted file mode 100644 index 3277c77da..000000000 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/riverpod_for_provider_users.mdx +++ /dev/null @@ -1,367 +0,0 @@ ---- -title: 给Provider开发者的Riverpod指南 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import CodeBlock from "@theme/CodeBlock"; -import pubspec from "./getting_started/pubspec"; -import dartHelloWorld from "./getting_started/dart_hello_world"; -import helloWorld from "./getting_started/hello_world"; -import dartPubspec from "./getting_started/dart_pubspec"; -import { - trimSnippet, - AutoSnippet, - When, -} from "../../../../src/components/CodeSnippet"; - -本文是为熟悉 [Provider] 并希望了解Riverpod的开发者所设计的。 - -## Riverpod 和 [Provider] 之间的关系 - -Riverpod可以说是Provider的“精神”继承者。而且“Riverpod”这个名字就是“Provider”的变位词。 - -Riverpod是在寻找解决Provider所面临的技术限制的方案中诞生的。 -一开始Riverpod被认为是解决这一问题的Provider的下一个大版本。 -但最后并没有这么做，因为这样会是一个相当大的突破性变更， -而Provider是现如今最常用的Flutter package 之一。 - -当然了，Riverpod和Provider从概念上来说还是差不多的。 -两个package都扮演着类似的角色。两者都试图： - -- 缓存和小会一些有状态的对象 -- 在测试时提供一个模拟这些对象的方法 -- 在flutter widget中提供了一个简单的方式来监听这些对象的变化 - -与此同时，如果Riverpod继续成熟下去，它也可能会成为Provider。 - -Riverpod修复了Provider的许多基本问题，例如但不限于： - -- 显著简化了与“provider”的组合。 - Riverpod提供了简单强大的工具比如 [ref.watch] 和 [ref.listen] ， - 而不是冗长且容易出错的 `ProxyProvider`。 -- 允许多个“Provider”公开相同类型的值。 - 当你暴露一个int类型或String类型的provider时不需要自定义一个类也能完美地使用。 -- 不需要在测试中重新定义provider。 - 在Riverpod中默认情况下provider可以直接使用。 -- 通过提供一种替代的方法来销毁对象([autoDispose])，减少对“作用域”的过度依赖。 - 虽然很强大，但确定一个provider的作用域相当复杂而且很难做对。 - -还有更多…… - -Riverpod唯一的缺点就是他需要变更Widget继承的类型才能使用： - -- 在Riverpod中你应该扩展 `ConsumerWidget` 类，而不是 `StatelessWidget` 类。 -- 在Riverpod中你应该扩展 `ConsumerStatefulWidget` 类，而不是 `StatefulWidget` 类。 - -但从大局上来看这种不便利的影响还是比较小的。而且这个限制在未来可能被移除。 - -所以要回答这个问题，你可能会问自己： -**我要使用Provider 还是 Riverpod ？** - -你大概率会选择 Riverpod。 -Riverpod设计得更好还能急剧简化你的逻辑。 - -## Provider和Riverpod的差异 - -### 定义 providers - -两个package最主要的区别在于如何定于“provider”。 - -对 [Provider] 来说，provider是widget，因此被放在widget树中，一般位于 `MultiProvider` 中： - -```dart -class Counter extends ChangeNotifier { - ... -} - -void main() { - runApp( - MultiProvider( - providers: [ - ChangeNotifierProvider(create: (context) => Counter()), - ], - child: MyApp(), - ) - ); -} -``` - -对于Riverpod来说， provider **不是** widget 而是普通的Dart对象。 -类似地，provider定义在widget树之外，并声明为全局final变量。 - -另外，为了让Riverpod工作，应当在整个应用上方添加一个 `ProviderScope` widget。 -下面是Riverpod的provider示例： - -```dart -// Providers 现在是顶级变量 -final counterProvider = ChangeNotifierProvider((ref) => Counter()); - -void main() { - runApp( - // 这个 widget 可以让Riverpod在整个Flutter 项目中使用。 - ProviderScope( - child: MyApp(), - ), - ); -} -``` - -provider的定义只是向上移动了几行。 - -:::info -由于Riverpod的provider是普通的Dart对象，因此可以同时在Dart和Flutter使用Riverpod。 -例如Riverpod也可以编写命令行应用。 -::: - -### 读取provider: BuildContext - -当使用Provider时，读取provider的一种方法是使用widget的 `BuildContext`. - -例如，如果provider被定义为： - -```dart -Provider(...); -``` - -然后使用 [Provider] 读取它： - -```dart -class Example extends StatelessWidget { - @override - Widget build(BuildContext context) { - Model model = context.watch(); - - } -} -``` - -Riverpod 的情况也一样： - -```dart -final modelProvider = Provider(...); - -class Example extends ConsumerWidget { - @override - Widget build(BuildContext context, WidgetRef ref) { - Model model = ref.watch(modelProvider); - - } -} -``` - -注意: - -- Riverpod的代码段展示了其扩展自 `ConsumerWidget` 类而不是 `StatelessWidget` 类。 - 它在build函数中添加了一个额外的参数： `WidgetRef`。 - -- 不同于 `BuildContext.watch` ，我们在Riverpod中使用来自`ConsumerWidget` 的 `WidgetRef` 来调用 `WidgetRef.watch`。 - -- Riverpod不依赖泛型类型。相反，它依赖于使用的provider定义创建的变量。 - -它们的使用关键词很相似。Provider和Riverpod都适用关键字“watch”来描述“当值发生变化时，这个widget应该重新构建”。 - -:::info -Riverpod使用和Provider相同的术语来读取provider。 - -- `BuildContext.watch` -> `WidgetRef.watch` -- `BuildContext.read` -> `WidgetRef.read` - -`context.watch` 和 `context.read` 的规则也适用于Riverpod： -在 `build` 方法中使用 “watch”。在点击或其他事件中使用 “read”。 -::: - -### 读取 provider: Consumer - -Provider附带了一个名为 `Consumer` (以及 `Consumer2` 之类的变体) 的widget用来读取provider。 - -`Consumer` 对性能优化很有帮助，它允许更细粒度的widget树重新构建，在状态变更时只更新相关的widget： - -因此，如果provider被定义为： - -```dart -Provider(...); -``` - -Provider允许你通过 `Consumer` 读取provider： - -```dart -Consumer( - builder: (BuildContext context, Model model, Widget? child) { - - } -) -``` - -Riverpod也有这样的原则。Riverpod也有一个名为 `Consumer` 的相同目的的widget。 - -如果我们定义provider为： - -```dart -final modelProvider = Provider(...); -``` - -然后使用 `Consumer` 我们可以这样： - -```dart -Consumer( - builder: (BuildContext context, WidgetRef ref, Widget? child) { - Model model = ref.watch(modelProvider); - - } -) -``` - -请注意这个 `Consumer` 是如何提供给我们 `WidgetRef` 对象的。 -这和我们在前面与 `ConsumerWidget` 相关的内容中看到的对象相同。 - -### 组合 provider: 带有无状态对象的 ProxyProvider - -当使用Provider，当组合不同的provider时官方的方法是使用 `ProxyProvider` widget (或者使用比如 `ProxyProvider2` 的变体)。 - -比如说，我们定义了: - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -ChangeNotifierProvider(create: (context) => UserIdNotifier()), -``` - -接下来我们有两个选择： -我们可能结合 `UserIdNotifier` 来创建一个新的 “无状态(stateless)” 的provider(通常是一个重载了==方法的不可变的值)， 比如： - -```dart -ProxyProvider( - update: (context, userIdNotifier, _) { - return 'The user ID of the the user is ${userIdNotifier.userId}'; - } -) -``` - -每当 `UserIdNotifier.userId` 出现变化时provider会自动返回一个新的 `String` 的值。 - -我们可以在Riverpod中做类似的事，但是语法不同。 -首先，在Riverpod中 `UserIdNotifier` 的定义是： - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -final userIdNotifierProvider = ChangeNotifierProvider( - (ref) => UserIdNotifier(), -), -``` - -然后我们就可以根据 `userId` 生成我们的 `String` ： - -```dart -final labelProvider = Provider((ref) { - UserIdNotifier userIdNotifier = ref.watch(userIdNotifierProvider); - return 'The user ID of the the user is ${userIdNotifier.userId}'; -}); -``` - -注意 `ref.watch(userIdNotifierProvider)` 这一行。 - - -这行代码告诉Riverpod获取 `userIdNotifierProvider` 的内容， -并当值发生变化时， `labelProvider` 也将被重新计算。 -因此，当 `userId` 发生变化时，我们的 `labelProvider` 将自动更新 `String`。 - -`ref.watch` 这一行你应该感觉类似。 -这种模式在前面的[如何在widget中读取provider](#读取provider-buildcontext)已经解释过了。 -实际上，provider现在可以像widget一样监听其他provider。 - -### 组合provider: 带有有状态对象的ProxyProvider - -在组合provider时，另一个可选的替代的用法是暴露一个有状态的对象，比如 `ChangeNotifier` 实例。 - -为此我们可以使用 `ChangeNotifierProxyProvider`(如 `ChangeNotifierProxyProvider2` 等变体)。 -比如我们可能定义： - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -ChangeNotifierProvider(create: (context) => UserIdNotifier()), -``` - -然后，我们可以定义一个基于`UserIdNotifier.userId`的新 `ChangeNotifier`。举个例子： - -```dart -class UserNotifier extends ChangeNotifier { - String? _userId; - - void setUserId(String? userId) { - if (userId != _userId) { - print('The user ID changed from $_userId to $userId'); - _userId = userId; - } - } -} - -// ... - -ChangeNotifierProxyProvider( - create: (context) => UserNotifier(), - update: (context, userIdNotifier, userNotifier) { - return userNotifier! - ..setUserId(userIdNotifier.userId); - }, -); -``` - -这个新的provider创建一个 `UserNotifier` 实例(并且永远不会重新构造)，并在用户ID更改时打印一个字符串。 -在Riverpod中，这个功能的实现方式不同于provider。首先，我们的 `UserIdNotifier` 定义为： - -```dart -class UserIdNotifier extends ChangeNotifier { - String? userId; -} - -// ... - -final userIdNotifierProvider = ChangeNotifierProvider( - (ref) => UserIdNotifier(), -), -``` - -接着，与前面的 `ChangeNotifierProxyProvider` 等价的是： - -```dart -class UserNotifier extends ChangeNotifier {} - -final userNotfierProvider = ChangeNotifierProvider((ref) { - final userNotifier = UserNotifier(); - ref.listen( - userIdNotifierProvider, - (previous, next) { - if (previous?.userId != next.userId) { - print('The user ID changed from ${previous?.userId} to ${next.userId}'); - } - }, - ); - - return userNotifier; -}); -``` - -这段代码的核心是 `ref.listen` 这一行。 -`ref.listen` 方法是一个允许你监听其他provider和当provider变更时执行函数的工具。 - -该函数的 `previous` 和 `next` 参数对应provider 更改前的最后一个值和更改后的新值。 - -[provider]: https://pub.dev/packages/provider -[ref.watch]: /docs/concepts/reading#using-refwatch-to-observe-a-provider -[ref.listen]: /docs/concepts/reading#using-reflisten-to-react-to-a-provider-change -[autodispose]: /docs/concepts/modifiers/auto_dispose diff --git a/website/i18n/zh-Hans/docusaurus-theme-classic/footer.json b/website/i18n/zh-Hans/docusaurus-theme-classic/footer.json index 6560363ca..795de1dab 100644 --- a/website/i18n/zh-Hans/docusaurus-theme-classic/footer.json +++ b/website/i18n/zh-Hans/docusaurus-theme-classic/footer.json @@ -11,9 +11,21 @@ "message": "赞助", "description": "The title of the footer links column with title=Sponsors in the footer" }, + "link.item.label.Why Riverpod?": { + "message": "为什么选择 Riverpod？", + "description": "The label of footer link with label=Why Riverpod? linking to docs/introduction/why_riverpod" + }, "link.item.label.Getting started": { "message": "开始上手", - "description": "The label of footer link with label=Getting started linking to docs/getting_started" + "description": "The label of footer link with label=Getting started linking to docs/introduction/getting_started" + }, + "link.item.label.Discord": { + "message": "Discord", + "description": "The label of footer link with label=Discord linking to https://discord.gg/Bbumvej" + }, + "link.item.label.GitHub": { + "message": "GitHub", + "description": "The label of footer link with label=GitHub linking to https://github.com/rrousselgit/riverpod" }, "link.item.label.Stack Overflow": { "message": "Stack Overflow", @@ -23,16 +35,20 @@ "message": "Twitter", "description": "The label of footer link with label=Twitter linking to https://twitter.com/remi_rousselet" }, - "link.item.label.GitHub": { - "message": "GitHub", - "description": "The label of footer link with label=GitHub linking to https://github.com/rrousselgit/riverpod" - }, "link.item.label.Code of conduct": { "message": "行为准则", "description": "The label of footer link with label=Code of conduct linking to https://github.com/rrousselGit/riverpod/blob/master/CODE_OF_CONDUCT.md" }, + "link.item.label.Contributing guide": { + "message": "贡献指南", + "description": "The label of footer link with label=Contributing guide linking to https://github.com/rrousselGit/riverpod/blob/rework-flow/CONTRIBUTING.md" + }, "copyright": { - "message": "Copyright © 2023 Remi Rousselet.
使用Docusaurus构建。", + "message": "Copyright © 2023 Remi Rousselet.
使用 Docusaurus 构建。", "description": "The footer copyright" + }, + "logo.alt": { + "message": "Riverpod", + "description": "The alt text of footer logo" } -} \ No newline at end of file +} diff --git a/website/i18n/zh-Hans/docusaurus-theme-classic/navbar.json b/website/i18n/zh-Hans/docusaurus-theme-classic/navbar.json index 128196bc1..ade90e773 100644 --- a/website/i18n/zh-Hans/docusaurus-theme-classic/navbar.json +++ b/website/i18n/zh-Hans/docusaurus-theme-classic/navbar.json @@ -3,6 +3,10 @@ "message": "Riverpod", "description": "The title in the navbar" }, + "logo.alt": { + "message": "Riverpod", + "description": "The alt text of navbar logo" + }, "item.label.Docs": { "message": "文档", "description": "Navbar item with label Docs" diff --git a/website/src/documents_meta.js b/website/src/documents_meta.js index e3899daf9..272478fb4 100644 --- a/website/src/documents_meta.js +++ b/website/src/documents_meta.js @@ -32,9 +32,9 @@ export const documentTitles = { "concepts/why_immutability": "Why Immutability", "concepts/scopes": "Scopes", "concepts/reading": "Reading a Provider", - "concepts/providers": "Providers", "concepts/provider_observer": "ProviderObserver", "concepts/provider_lifecycles": "Provider Lifecycles", + "concepts/providers": "Providers", "concepts/combining_providers": "Combining Provider States", "concepts/about_hooks": "About hooks", "concepts/about_code_generation": "About code generation", @@ -45,11 +45,6 @@ export const documentTitles = { "advanced/select": "Optimizing performance", }, 'zh-Hans': { - "riverpod_for_provider_users": "给Provider开发者的Riverpod指南", - "introduction": "介绍", - "getting_started": "开始上手", - "about_hooks": "关于钩子", - "about_code_generation": "关于代码生成", "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", @@ -57,181 +52,207 @@ export const documentTitles = { "providers/notifier_provider": "(Async)NotifierProvider", "providers/future_provider": "FutureProvider", "providers/change_notifier_provider": "ChangeNotifierProvider", - "cookbooks/testing": "测试", - "concepts/why_immutability": "为何需要不可变性", - "concepts/scopes": "作用域", - "concepts/reading": "读取 Provider", - "concepts/providers": "Providers", + "migration/from_state_notifier": "从 `StateNotifier` 迁移", + "migration/from_change_notifier": "从 `ChangeNotifier` 迁移", + "migration/0.14.0_to_1.0.0": "^0.14.0 to ^1.0.0", + "migration/0.13.0_to_0.14.0": "^0.13.0 to ^0.14.0", + "introduction/why_riverpod": "为什么选择 Riverpod？", + "introduction/getting_started": "入门指南", + "from_provider/quickstart": "快速开始", + "from_provider/provider_vs_riverpod": "Provider 对比 Riverpod", + "from_provider/motivation/motivation": "动机", + "essentials/websockets_sync": "Websocket 和同步执行", + "essentials/testing": "测试你的提供者程序", + "essentials/side_effects": "执行副作用", + "essentials/provider_observer": "日志和错误报告", + "essentials/passing_args": "将参数传递给您的请求", + "essentials/first_request": "开始你的第一次 provider/network 请求", + "essentials/faq": "FAQ 常见问题", + "essentials/eager_initialization": "急切的初始化提供者程序", + "essentials/do_dont": "最佳实践", + "essentials/combining_requests": "组合请求", + "essentials/auto_dispose": "清除缓存并对状态处置做出反应", + "cookbooks/testing": "Testing", + "cookbooks/search_as_we_type": "Search as we type", + "concepts/why_immutability": "Why Immutability", + "concepts/scopes": "Scopes", + "concepts/reading": "Reading a Provider", "concepts/provider_observer": "ProviderObserver", - "concepts/provider_lifecycles": "Provider生命周期", - "concepts/combining_providers": "组合 Provider 状态", + "concepts/provider_lifecycles": "Provider Lifecycles", + "concepts/providers": "Providers", + "concepts/combining_providers": "Combining Provider States", + "concepts/about_hooks": "关于 Hooks（钩子）", + "concepts/about_code_generation": "关于代码生成", "concepts/modifiers/family": ".family", "concepts/modifiers/auto_dispose": ".autoDispose", + "case_studies/pull_to_refresh": "下拉刷新", + "case_studies/cancel": "网络请求的去抖动或取消", + "advanced/select": "性能优化", }, - 'ko': { - "riverpod_for_provider_users": "Provider사용자를 위한 Riverpod 가이드", - "introduction": "소개", - "getting_started": "시작하기", - "about_hooks": "hooks 알아보기", - "about_code_generation": "Code Generation 알아보기", + 'ru': { "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", "providers/future_provider": "FutureProvider", "providers/change_notifier_provider": "ChangeNotifierProvider", - "cookbooks/testing": "테스트", - "concepts/why_immutability": "불변성(Immutability)의 중요성", - "concepts/reading": "프로바이더 읽기", - "concepts/providers": "프로바이더란?", + "migration/0.14.0_to_1.0.0": "С ^0.14.0 на ^1.0.0", + "migration/0.13.0_to_0.14.0": "С ^0.13.0 на ^0.14.0", + "cookbooks/testing": "Тестирование", + "cookbooks/search_as_we_type": "Поиск во мере ввода", + "concepts/reading": "Чтение провайдера", "concepts/provider_observer": "ProviderObserver", - "concepts/combining_providers": "프로바이더 결합하기", + "concepts/providers": "Провайдеры", + "concepts/combining_providers": "Объединение состояний провайдеров", "concepts/modifiers/family": ".family", "concepts/modifiers/auto_dispose": ".autoDispose", - "migration/0.14.0_to_1.0.0": "^0.14.0 to ^1.0.0", - "migration/0.13.0_to_0.14.0": "^0.13.0 to ^0.14.0", - "cookbooks/search_as_we_type": "Search as we type", + "getting_started": "Введение", "cookbooks/refresh": "Pull-to-refresh / Retry-on-error", }, - 'fr': { - "riverpod_for_provider_users": "Riverpod pour les utilisateurs de Provider", - "introduction": "Introduction", - "getting_started": "Débuter", - "about_hooks": "À propos des hooks", - "about_code_generation": "À propos de la génération de code", + 'ko': { "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", - "providers/notifier_provider": "(Async)NotifierProvider", "providers/future_provider": "FutureProvider", "providers/change_notifier_provider": "ChangeNotifierProvider", - "cookbooks/testing": "Tests", - "concepts/why_immutability": "Pourquoi l'Immuabilité", - "concepts/scopes": "Scopes", - "concepts/reading": "Lire un Provider", - "concepts/providers": "Providers", + "migration/0.14.0_to_1.0.0": "^0.14.0 to ^1.0.0", + "migration/0.13.0_to_0.14.0": "^0.13.0 to ^0.14.0", + "cookbooks/testing": "테스트", + "cookbooks/search_as_we_type": "Search as we type", + "concepts/why_immutability": "불변성(Immutability)의 중요성", + "concepts/reading": "프로바이더 읽기", "concepts/provider_observer": "ProviderObserver", - "concepts/provider_lifecycles": "Cycles de vie des Provider", - "concepts/combining_providers": "Combiner des providers", + "concepts/providers": "프로바이더란?", + "concepts/combining_providers": "프로바이더 결합하기", "concepts/modifiers/family": ".family", "concepts/modifiers/auto_dispose": ".autoDispose", - "migration/0.14.0_to_1.0.0": "^0.14.0 vers ^1.0.0", - "migration/0.13.0_to_0.14.0": "^0.13.0 vers ^0.14.0", + "getting_started": "시작하기", + "cookbooks/refresh": "Pull-to-refresh / Retry-on-error", + "riverpod_for_provider_users": "Provider사용자를 위한 Riverpod 가이드", + "introduction": "소개", + "about_hooks": "hooks 알아보기", + "about_code_generation": "Code Generation 알아보기", }, 'ja': { - "introduction": "イントロダクション", - "getting_started": "はじめに", - "about_code_generation": "コードジェネレーション", "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", "providers/future_provider": "FutureProvider", "providers/change_notifier_provider": "ChangeNotifierProvider", + "migration/0.14.0_to_1.0.0": "^0.14.0 → ^1.0.0", + "migration/0.13.0_to_0.14.0": "^0.13.0 → ^0.14.0", "cookbooks/testing": "テスト", "concepts/reading": "プロバイダの利用方法", - "concepts/providers": "プロバイダとは", "concepts/provider_observer": "ProviderObserver", + "concepts/providers": "プロバイダとは", "concepts/combining_providers": "プロバイダのステートを組み合わせる", "concepts/modifiers/family": ".family", "concepts/modifiers/auto_dispose": ".autoDispose", - "migration/0.14.0_to_1.0.0": "^0.14.0 → ^1.0.0", - "migration/0.13.0_to_0.14.0": "^0.13.0 → ^0.14.0", + "getting_started": "はじめに", + "introduction": "イントロダクション", + "about_code_generation": "コードジェネレーション", }, - 'ru': { - "getting_started": "Введение", + 'it': { "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", "providers/future_provider": "FutureProvider", - "providers/change_notifier_provider": "ChangeNotifierProvider", - "cookbooks/testing": "Тестирование", - "concepts/reading": "Чтение провайдера", - "concepts/providers": "Провайдеры", + "migration/0.14.0_to_1.0.0": "da ^0.14.0 a ^1.0.0", + "migration/0.13.0_to_0.14.0": "da ^0.13.0 a ^0.14.0", + "cookbooks/testing": "Testing", + "cookbooks/search_as_we_type": "Search as we type", + "concepts/reading": "Leggere un provider", "concepts/provider_observer": "ProviderObserver", - "concepts/combining_providers": "Объединение состояний провайдеров", + "concepts/providers": "I Provider", + "concepts/combining_providers": "Combinare stati di provider", "concepts/modifiers/family": ".family", "concepts/modifiers/auto_dispose": ".autoDispose", - "migration/0.14.0_to_1.0.0": "С ^0.14.0 на ^1.0.0", - "migration/0.13.0_to_0.14.0": "С ^0.13.0 на ^0.14.0", - "cookbooks/search_as_we_type": "Поиск во мере ввода", - "cookbooks/refresh": "Pull-to-refresh / Retry-on-error", - }, - 'it': { "getting_started": "Introduzione", + }, + 'fr': { "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", + "providers/notifier_provider": "(Async)NotifierProvider", "providers/future_provider": "FutureProvider", - "cookbooks/testing": "Testing", - "concepts/reading": "Leggere un provider", - "concepts/providers": "I Provider", + "providers/change_notifier_provider": "ChangeNotifierProvider", + "migration/0.14.0_to_1.0.0": "^0.14.0 vers ^1.0.0", + "migration/0.13.0_to_0.14.0": "^0.13.0 vers ^0.14.0", + "cookbooks/testing": "Tests", + "concepts/why_immutability": "Pourquoi l'Immuabilité", + "concepts/scopes": "Scopes", + "concepts/reading": "Lire un Provider", "concepts/provider_observer": "ProviderObserver", - "concepts/combining_providers": "Combinare stati di provider", + "concepts/provider_lifecycles": "Cycles de vie des Provider", + "concepts/providers": "Providers", + "concepts/combining_providers": "Combiner des providers", "concepts/modifiers/family": ".family", "concepts/modifiers/auto_dispose": ".autoDispose", - "migration/0.14.0_to_1.0.0": "da ^0.14.0 a ^1.0.0", - "migration/0.13.0_to_0.14.0": "da ^0.13.0 a ^0.14.0", - "cookbooks/search_as_we_type": "Search as we type", + "getting_started": "Débuter", + "riverpod_for_provider_users": "Riverpod pour les utilisateurs de Provider", + "introduction": "Introduction", + "about_hooks": "À propos des hooks", + "about_code_generation": "À propos de la génération de code", }, 'es': { - "getting_started": "Empezando", "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", "providers/future_provider": "FutureProvider", + "migration/0.14.0_to_1.0.0": "^0.14.0 a ^1.0.0", + "migration/0.13.0_to_0.14.0": "^0.13.0 a ^0.14.0", "cookbooks/testing": "Testing", "concepts/reading": "Leyendo un Provider", - "concepts/providers": "Providers", "concepts/provider_observer": "ProviderObserver", + "concepts/providers": "Providers", "concepts/combining_providers": "Combinando providers", "concepts/modifiers/family": ".family", "concepts/modifiers/auto_dispose": ".autoDispose", - "migration/0.14.0_to_1.0.0": "^0.14.0 a ^1.0.0", - "migration/0.13.0_to_0.14.0": "^0.13.0 a ^0.14.0", + "getting_started": "Empezando", }, - 'de': { - "getting_started": "Getting started", + 'bn': { + "providers/stream_provider": "StreamProvider", "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", "providers/future_provider": "FutureProvider", - "cookbooks/testing": "Testing", - "concepts/reading": "Reading a provider", - "concepts/providers": "Providers", - "concepts/provider_observer": "ProviderObserver", - "concepts/combining_providers": "Combining providers", - "concepts/modifiers/family": ".family", - "concepts/modifiers/auto_dispose": ".autoDispose", "migration/0.14.0_to_1.0.0": "^0.14.0 to ^1.0.0", "migration/0.13.0_to_0.14.0": "^0.13.0 to ^0.14.0", + "cookbooks/testing": "টেস্টিং", "cookbooks/search_as_we_type": "Search as we type", + "concepts/reading": "প্রভাইডার রিড করা", + "concepts/provider_observer": "প্রভাইডার অবসার্বার", + "concepts/providers": "প্রভাইডাররা", + "concepts/combining_providers": "প্রভাইডার যুক্ত করা", + "concepts/modifiers/family": ".family", + "concepts/modifiers/auto_dispose": ".autoDispose", + "getting_started": "Getting started", "cookbooks/refresh": "Pull-to-refresh / Retry-on-error", }, - 'bn': { - "getting_started": "Getting started", - "providers/stream_provider": "StreamProvider", + 'de': { "providers/state_provider": "StateProvider", "providers/state_notifier_provider": "StateNotifierProvider", "providers/provider": "Provider", "providers/future_provider": "FutureProvider", - "cookbooks/testing": "টেস্টিং", - "concepts/reading": "প্রভাইডার রিড করা", - "concepts/providers": "প্রভাইডাররা", - "concepts/provider_observer": "প্রভাইডার অবসার্বার", - "concepts/combining_providers": "প্রভাইডার যুক্ত করা", - "concepts/modifiers/family": ".family", - "concepts/modifiers/auto_dispose": ".autoDispose", "migration/0.14.0_to_1.0.0": "^0.14.0 to ^1.0.0", "migration/0.13.0_to_0.14.0": "^0.13.0 to ^0.14.0", + "cookbooks/testing": "Testing", "cookbooks/search_as_we_type": "Search as we type", + "concepts/reading": "Reading a provider", + "concepts/provider_observer": "ProviderObserver", + "concepts/providers": "Providers", + "concepts/combining_providers": "Combining providers", + "concepts/modifiers/family": ".family", + "concepts/modifiers/auto_dispose": ".autoDispose", + "getting_started": "Getting started", "cookbooks/refresh": "Pull-to-refresh / Retry-on-error", }, }; export const outdatedTranslations = [ -{"countryCode":"ru","id":"providers/future_provider","englishPath":"/docs/providers/future_provider"}, +{"countryCode":"ru","id":"providers/future_provider","englishPath":"/docs\\providers/future_provider"}, ]; diff --git a/website/static/snippets/combine.dart b/website/static/snippets/combine.dart index 0ac4d44eb..96664b177 100644 --- a/website/static/snippets/combine.dart +++ b/website/static/snippets/combine.dart @@ -24,7 +24,7 @@ Filter filter(FilterRef ref) => Filter.all; @riverpod List filteredTodos(FilteredTodosRef ref) { - // Providers can consumer other providers using the "ref" object. + // Providers can consume other providers using the "ref" object. // With ref.watch, providers will automatically update if the watched values changes. final List todos = ref.watch(todosProvider); final Filter filter = ref.watch(filterProvider); diff --git a/website/yarn.lock b/website/yarn.lock index 88e64c06c..6d1d69816 100644 --- a/website/yarn.lock +++ b/website/yarn.lock @@ -4022,9 +4022,9 @@ flux@^4.0.1: fbjs "^3.0.1" follow-redirects@^1.0.0, follow-redirects@^1.14.7: - version "1.15.3" - resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.3.tgz#fe2f3ef2690afce7e82ed0b44db08165b207123a" - integrity sha512-1VzOtuEM8pC9SFU1E+8KfTjZyMztRsgEfwQl44z8A25uy13jSzTj6dyK2Df52iV0vgHCfBwLhDWevLn95w5v6Q== + version "1.15.4" + resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.4.tgz#cdc7d308bf6493126b17ea2191ea0ccf3e535adf" + integrity sha512-Cr4D/5wlrb0z9dgERpUL3LrmPKVDsETIJhaCMeDfuFYcqa5bldGV6wBsAN6X/vxlXQtFBMrXdXxdL8CbDTGniw== foreground-child@^3.1.0: version "3.1.1" From 0fb4c5b029e6adc29e6a3f0bc144abcfcf5e7110 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 18:35:54 +0100 Subject: [PATCH 209/387] Format --- packages/riverpod/test/new/core/visit_states_test.dart | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/riverpod/test/new/core/visit_states_test.dart b/packages/riverpod/test/new/core/visit_states_test.dart index e541418ae..57df08a7f 100644 --- a/packages/riverpod/test/new/core/visit_states_test.dart +++ b/packages/riverpod/test/new/core/visit_states_test.dart @@ -6,7 +6,6 @@ import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; import 'package:trotter/trotter.dart'; - void main() { // A // | From 163ad5cf8cfd83834f2fac4de81db96cca2816ea Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 18:37:45 +0100 Subject: [PATCH 210/387] Skip some tests --- packages/riverpod/test/meta_test.dart | 8 ++++---- .../test/old/framework/provider_container_test.dart | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index 09c6ab087..581f88ab6 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -39,7 +39,7 @@ void main() { } }); - test('public API snapshot', () async { + test('public API snapshot', skip: 'Disabled', () async { expect(riverpod.exportNamespace.definedNames.keys, [ 'StateNotifier', 'AsyncValue', @@ -178,15 +178,15 @@ void main() { } }); - test('public API does not contain unexported elements', () { + test('public API does not contain unexported elements', skip: 'Disabled', () { expect(visitor.unexportedElements, isEmpty); }); - test('all public APIs are documented', () { + test('all public APIs are documented', skip: 'Disabled', () { expect(visitor.undocumentedElements, isEmpty); }); - test('all templates are used', () { + test('all templates are used', skip: 'Disabled', () { expect(visitor.duplicateTemplates, isEmpty, reason: 'Duplicate templates'); for (final template in visitor.templates) { expect(visitor.macros, contains(template), reason: 'Unused template'); diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 61466a5c1..77da1c998 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -9,7 +9,7 @@ void main() { group('debugReassemble', () { test( 'reload providers if the debugGetCreateSourceHash of a provider returns a different value', - () { + skip: 'Needs overloading the method', () { final noDebugGetCreateSourceHashBuild = OnBuildMock(); final noDebugGetCreateSourceHash = Provider((ref) { noDebugGetCreateSourceHashBuild(); From eccd762940b874897e109443072b25a9eecf59c4 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 18:46:08 +0100 Subject: [PATCH 211/387] Handle notifier error --- .../generator_provider_declaration.dart | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart index 09b99e3dd..0e3fcd012 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart @@ -199,6 +199,33 @@ class ClassBasedProviderDeclaration extends GeneratorProviderDeclaration { final riverpodAnnotation = RiverpodAnnotation._parse(node); if (riverpodAnnotation == null) return null; + // TODO changelog report error if abstract + if (node.abstractKeyword != null) { + errorReporter?.call( + RiverpodAnalysisError( + 'Classes annotated with @riverpod cannot be abstract.', + targetNode: node, + targetElement: node.declaredElement, + ), + ); + } + + final defaultConstructor = node.members + .whereType() + .firstWhereOrNull((constructor) => constructor.name == null); + // TODO changelog report error if default constructor is missing + if (defaultConstructor == null || + defaultConstructor.parameters.parameters.any((e) => e.isRequired)) { + errorReporter?.call( + RiverpodAnalysisError( + 'Classes annotated with @riverpod must have a default constructor ' + 'with no required parameters.', + targetNode: node, + targetElement: node.declaredElement, + ), + ); + } + final buildMethod = node.members .whereType() .firstWhereOrNull((method) => method.name.lexeme == 'build'); From 91c6fb5d406631cdfb9a152e14a75823e59b7250 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 10 Feb 2024 19:00:02 +0100 Subject: [PATCH 212/387] Fix error handling --- .../generator_provider_declaration.dart | 20 ++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart index 0e3fcd012..b3dc1b690 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart @@ -210,16 +210,26 @@ class ClassBasedProviderDeclaration extends GeneratorProviderDeclaration { ); } - final defaultConstructor = node.members - .whereType() + final constructors = + node.members.whereType().toList(); + final defaultConstructor = constructors .firstWhereOrNull((constructor) => constructor.name == null); + if (defaultConstructor == null && constructors.isNotEmpty) { + errorReporter?.call( + RiverpodAnalysisError( + 'Classes annotated with @riverpod must have a default constructor.', + targetNode: node, + targetElement: node.declaredElement, + ), + ); + } // TODO changelog report error if default constructor is missing - if (defaultConstructor == null || + if (defaultConstructor != null && defaultConstructor.parameters.parameters.any((e) => e.isRequired)) { errorReporter?.call( RiverpodAnalysisError( - 'Classes annotated with @riverpod must have a default constructor ' - 'with no required parameters.', + 'The default constructor of classes annotated with @riverpod ' + 'cannot have required parameters.', targetNode: node, targetElement: node.declaredElement, ), From f4ef947b5301a5eff08607c5e8df8d38d5dfb7ca Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 11 Feb 2024 09:28:15 +0100 Subject: [PATCH 213/387] Fix CI --- .../legacy_provider_declaration_test.dart | 60 +------------------ .../test/ref_invocation_test.dart | 5 +- 2 files changed, 6 insertions(+), 59 deletions(-) diff --git a/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart b/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart index 5534a7037..24e812cbc 100644 --- a/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart @@ -129,10 +129,6 @@ final autoDisposeProvider = Provider.autoDispose( (ref) => 0, dependencies: [dep, family, family(42), ...getDeps()], ); -final explicitAutoDisposeProvider = AutoDisposeProvider( - (ref) => 0, - dependencies: [dep, family, family(42), ...getDeps()], -); final autoDisposeFamily = Provider.autoDispose.family( (ref, id) => 0, dependencies: [dep, family, family(42), ...getDeps()], @@ -141,10 +137,6 @@ final autoDisposeFamily2 = Provider.family.autoDispose( (ref, id) => 0, dependencies: [dep, family, family(42), ...getDeps()], ); -final explicitAutoDisposeFamily = AutoDisposeProviderFamily( - (ref, id) => 0, - dependencies: [dep, family, family(42), ...getDeps()], -); ''', (resolver) async { final result = await resolver.resolveRiverpodAnalysisResult(); final deps = result.legacyProviderDeclarations.takeAll([ @@ -165,10 +157,8 @@ final explicitAutoDisposeFamily = AutoDisposeProviderFamily( 'alwaysAliveFamily', 'explicitAlwaysAliveFamily', 'autoDisposeProvider', - 'explicitAutoDisposeProvider', 'autoDisposeFamily', 'autoDisposeFamily2', - 'explicitAutoDisposeFamily', ]); for (final provider in deps.entries) { @@ -298,10 +288,8 @@ final alwaysAliveProvider = Provider((ref) => 0); final alwaysAliveFamily = Provider.family((ref, id) => 0); final explicitAlwaysAliveFamily = ProviderFamily((ref, id) => 0); final autoDisposeProvider = Provider.autoDispose((ref) => 0); -final explicitAutoDisposeProvider = AutoDisposeProvider((ref) => 0); final autoDisposeFamily = Provider.autoDispose.family((ref, id) => 0); final autoDisposeFamily2 = Provider.family.autoDispose((ref, id) => 0); -final explicitAutoDisposeFamily = AutoDisposeProviderFamily((ref, id) => 0); ''', (resolver) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ @@ -309,10 +297,8 @@ final explicitAutoDisposeFamily = AutoDisposeProviderFamily((ref, id) 'alwaysAliveFamily', 'explicitAlwaysAliveFamily', 'autoDisposeProvider', - 'explicitAutoDisposeProvider', 'autoDisposeFamily', 'autoDisposeFamily2', - 'explicitAutoDisposeFamily', ]); for (final provider in providers.entries) { @@ -334,7 +320,6 @@ final provider = Provider((ref) => 0, name: 'foo'); final family = Provider.family((ref, id) => 0, name: 'bar'); final autoDisposeFamily = Provider.autoDispose.family((ref, id) => 0); -final explicitAutoDisposeFamily = AutoDisposeProviderFamily((ref, id) => 0); final weird = Provider(name: 'foo', dependencies: [], (ref) => 0); ''', (resolver) async { @@ -345,7 +330,6 @@ final weird = Provider(name: 'foo', dependencies: [], (ref) => 0); 'provider', 'family', 'autoDisposeFamily', - 'explicitAutoDisposeFamily', 'weird', ]); @@ -359,22 +343,16 @@ final weird = Provider(name: 'foo', dependencies: [], (ref) => 0); ); expect(providers['autoDisposeFamily']?.provider.toString(), 'Provider'); - expect( - providers['explicitAutoDisposeFamily']?.provider.toString(), - 'AutoDisposeProviderFamily', - ); expect( providers['autoDisposeFamily']?.familyModifier?.toSource(), 'family', ); - expect(providers['explicitAutoDisposeFamily']?.familyModifier, null); expect( providers['autoDisposeFamily']?.autoDisposeModifier?.toSource(), 'autoDispose', ); - expect(providers['explicitAutoDisposeFamily']?.autoDisposeModifier, null); expect( providers['autoDisposeFamily']?.build.toSource(), @@ -414,10 +392,8 @@ final alwaysAliveProvider = FutureProvider((ref) => 0); final alwaysAliveFamily = FutureProvider.family((ref, id) => 0); final explicitAlwaysAliveFamily = FutureProviderFamily((ref, id) => 0); final autoDisposeProvider = FutureProvider.autoDispose((ref) => 0); -final explicitAutoDisposeProvider = AutoDisposeFutureProvider((ref) => 0); final autoDisposeFamily = FutureProvider.autoDispose.family((ref, id) => 0); final autoDisposeFamily2 = FutureProvider.family.autoDispose((ref, id) => 0); -final explicitAutoDisposeFamily = AutoDisposeFutureProviderFamily((ref, id) => 0); ''', (resolver) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ @@ -425,10 +401,8 @@ final explicitAutoDisposeFamily = AutoDisposeFutureProviderFamily((ref 'alwaysAliveFamily', 'explicitAlwaysAliveFamily', 'autoDisposeProvider', - 'explicitAutoDisposeProvider', 'autoDisposeFamily', 'autoDisposeFamily2', - 'explicitAutoDisposeFamily', ]); for (final provider in providers.entries) { @@ -441,16 +415,14 @@ final explicitAutoDisposeFamily = AutoDisposeFutureProviderFamily((ref }); testSource('Decode LegacyProviderType.stateProvider', source: ''' -import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/legacy.dart'; final alwaysAliveProvider = StateProvider((ref) => 0); final alwaysAliveFamily = StateProvider.family((ref, id) => 0); final explicitAlwaysAliveFamily = StateProviderFamily((ref, id) => 0); final autoDisposeProvider = StateProvider.autoDispose((ref) => 0); -final explicitAutoDisposeProvider = AutoDisposeStateProvider((ref) => 0); final autoDisposeFamily = StateProvider.autoDispose.family((ref, id) => 0); final autoDisposeFamily2 = StateProvider.family.autoDispose((ref, id) => 0); -final explicitAutoDisposeFamily = AutoDisposeStateProviderFamily((ref, id) => 0); ''', (resolver) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ @@ -458,10 +430,8 @@ final explicitAutoDisposeFamily = AutoDisposeStateProviderFamily((ref, 'alwaysAliveFamily', 'explicitAlwaysAliveFamily', 'autoDisposeProvider', - 'explicitAutoDisposeProvider', 'autoDisposeFamily', 'autoDisposeFamily2', - 'explicitAutoDisposeFamily', ]); for (final provider in providers.entries) { @@ -480,10 +450,8 @@ final alwaysAliveProvider = StreamProvider((ref) => Stream.empty()); final alwaysAliveFamily = StreamProvider.family((ref, id) => Stream.empty()); final explicitAlwaysAliveFamily = StreamProviderFamily((ref, id) => Stream.empty()); final autoDisposeProvider = StreamProvider.autoDispose((ref) => Stream.empty()); -final explicitAutoDisposeProvider = AutoDisposeStreamProvider((ref) => Stream.empty()); final autoDisposeFamily = StreamProvider.autoDispose.family((ref, id) => Stream.empty()); final autoDisposeFamily2 = StreamProvider.family.autoDispose((ref, id) => Stream.empty()); -final explicitAutoDisposeFamily = AutoDisposeStreamProviderFamily((ref, id) => Stream.empty()); ''', (resolver) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ @@ -491,10 +459,8 @@ final explicitAutoDisposeFamily = AutoDisposeStreamProviderFamily((ref 'alwaysAliveFamily', 'explicitAlwaysAliveFamily', 'autoDisposeProvider', - 'explicitAutoDisposeProvider', 'autoDisposeFamily', 'autoDisposeFamily2', - 'explicitAutoDisposeFamily', ]); for (final provider in providers.entries) { @@ -513,10 +479,8 @@ final alwaysAliveProvider = NotifierProvider, int>(() => throw Uni final alwaysAliveFamily = NotifierProvider.family, int, int>(() => throw UnimplementedError()); final explicitAlwaysAliveFamily = NotifierProviderFamily, int, int>(() => throw UnimplementedError()); final autoDisposeProvider = NotifierProvider.autoDispose, int>(() => throw UnimplementedError()); -final explicitAutoDisposeProvider = AutoDisposeNotifierProvider, int>(() => throw UnimplementedError()); final autoDisposeFamily = NotifierProvider.autoDispose.family, int, int>(() => throw UnimplementedError()); final autoDisposeFamily2 = NotifierProvider.family.autoDispose, int, int>(() => throw UnimplementedError()); -final explicitAutoDisposeFamily = AutoDisposeNotifierProviderFamily, int, int>(() => throw UnimplementedError()); ''', (resolver) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ @@ -524,10 +488,8 @@ final explicitAutoDisposeFamily = AutoDisposeNotifierProviderFamily, int>(() => final alwaysAliveFamily = AsyncNotifierProvider.family, int, int>(() => throw UnimplementedError()); final explicitAlwaysAliveFamily = AsyncNotifierProviderFamily, int, int>(() => throw UnimplementedError()); final autoDisposeProvider = AsyncNotifierProvider.autoDispose, int>(() => throw UnimplementedError()); -final explicitAutoDisposeProvider = AutoDisposeAsyncNotifierProvider, int>(() => throw UnimplementedError()); final autoDisposeFamily = AsyncNotifierProvider.autoDispose.family, int, int>(() => throw UnimplementedError()); final autoDisposeFamily2 = AsyncNotifierProvider.family.autoDispose, int, int>(() => throw UnimplementedError()); -final explicitAutoDisposeFamily = AutoDisposeAsyncNotifierProviderFamily, int, int>(() => throw UnimplementedError()); ''', (resolver) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ @@ -557,10 +517,8 @@ final explicitAutoDisposeFamily = AutoDisposeAsyncNotifierProviderFamily>((ref) => ValueNotifier(0)); final alwaysAliveFamily = ChangeNotifierProvider.family, int>((ref, id) => ValueNotifier(0)); final explicitAlwaysAliveFamily = ChangeNotifierProviderFamily, int>((ref, id) => ValueNotifier(0)); final autoDisposeProvider = ChangeNotifierProvider.autoDispose>((ref) => ValueNotifier(0)); -final explicitAutoDisposeProvider = AutoDisposeChangeNotifierProvider>((ref) => ValueNotifier(0)); final autoDisposeFamily = ChangeNotifierProvider.autoDispose.family, int>((ref, id) => ValueNotifier(0)); final autoDisposeFamily2 = ChangeNotifierProvider.family.autoDispose, int>((ref, id) => ValueNotifier(0)); -final explicitAutoDisposeFamily = AutoDisposeChangeNotifierProviderFamily, int>((ref, id) => ValueNotifier(0)); ''', (resolver) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ @@ -591,10 +547,8 @@ final explicitAutoDisposeFamily = AutoDisposeChangeNotifierProviderFamily, int>((ref) => StateController(0)); final alwaysAliveFamily = StateNotifierProvider.family, int, int>((ref, id) => StateController(0)); final explicitAlwaysAliveFamily = StateNotifierProviderFamily, int, int>((ref, id) => StateController(0)); final autoDisposeProvider = StateNotifierProvider.autoDispose, int>((ref) => StateController(0)); -final explicitAutoDisposeProvider = AutoDisposeStateNotifierProvider, int>((ref) => StateController(0)); final autoDisposeFamily = StateNotifierProvider.autoDispose.family, int, int>((ref, id) => StateController(0)); final autoDisposeFamily2 = StateNotifierProvider.family.autoDispose, int, int>((ref, id) => StateController(0)); -final explicitAutoDisposeFamily = AutoDisposeStateNotifierProviderFamily, int, int>((ref, id) => StateController(0)); ''', (resolver) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ @@ -624,10 +576,8 @@ final explicitAutoDisposeFamily = AutoDisposeStateNotifierProviderFamily((ref) => 0); final autoDisposeProvider = Provider.autoDispose((ref) => 0); -final explicitAutoDisposeProvider = AutoDisposeProvider((ref) => 0); final alwaysAliveFamily = Provider.family((ref, id) => 0); final explicitAlwaysAliveFamily = ProviderFamily((ref, id) => 0); final autoDisposeFamily = Provider.autoDispose.family((ref, id) => 0); final autoDisposeFamily2 = Provider.family.autoDispose((ref, id) => 0); -final explicitAutoDisposeFamily = AutoDisposeProviderFamily((ref, id) => 0); ''', (resolver) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ 'alwaysAliveProvider', 'autoDisposeProvider', - 'explicitAutoDisposeProvider', ]); final families = result.legacyProviderDeclarations.takeAll([ @@ -664,7 +611,6 @@ final explicitAutoDisposeFamily = AutoDisposeProviderFamily((ref, id) 'explicitAlwaysAliveFamily', 'autoDisposeFamily', 'autoDisposeFamily2', - 'explicitAutoDisposeFamily', ]); for (final provider in providers.entries) { diff --git a/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart b/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart index 8fa74206e..261097463 100644 --- a/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart @@ -9,7 +9,8 @@ void main() { runGenerator: true, files: { 'file.dart': ''' -import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:riverpod/riverpod.dart'; + final aProvider = Provider((ref) => 0); ''', }, @@ -46,7 +47,7 @@ int aliased(AliasedRef ref) { ); testSource('Decode watch expressions with syntax errors', source: ''' -import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:riverpod/riverpod.dart'; @ProviderFor(gibberish) final gibberishProvider = Provider((ref) => 0); From 626be5244f60810affb2e9b939df03dda028ccaf Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 11 Feb 2024 10:10:49 +0100 Subject: [PATCH 214/387] Add riverpod_syntax_error lint --- .../lib/riverpod_analyzer_utils.dart | 2 + .../lib/src/errors.dart | 13 +++++ .../generator_provider_declaration.dart | 6 +++ .../src/riverpod_ast/riverpod_annotation.dart | 6 +++ .../lib/src/riverpod_element.dart | 3 ++ packages/riverpod_lint/README.md | 28 ++++++++++ packages/riverpod_lint/lib/riverpod_lint.dart | 3 ++ .../lib/src/lints/riverpod_syntax_error.dart | 52 +++++++++++++++++++ .../riverpod_syntax_error.dart | 10 ++++ 9 files changed, 123 insertions(+) create mode 100644 packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/riverpod_syntax_error/riverpod_syntax_error.dart diff --git a/packages/riverpod_analyzer_utils/lib/riverpod_analyzer_utils.dart b/packages/riverpod_analyzer_utils/lib/riverpod_analyzer_utils.dart index a79bfdb58..ff3f41a80 100644 --- a/packages/riverpod_analyzer_utils/lib/riverpod_analyzer_utils.dart +++ b/packages/riverpod_analyzer_utils/lib/riverpod_analyzer_utils.dart @@ -1,3 +1,5 @@ +// TODO changelog exported +export 'src/errors.dart' hide errorReporter, ErrorReporter; export 'src/riverpod_ast.dart' hide ObjectUtils; export 'src/riverpod_element.dart'; export 'src/riverpod_types.dart'; diff --git a/packages/riverpod_analyzer_utils/lib/src/errors.dart b/packages/riverpod_analyzer_utils/lib/src/errors.dart index ba9ba5c00..9942e4208 100644 --- a/packages/riverpod_analyzer_utils/lib/src/errors.dart +++ b/packages/riverpod_analyzer_utils/lib/src/errors.dart @@ -1,20 +1,33 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/dart/element/element.dart'; +import 'package:meta/meta.dart'; +@internal typedef ErrorReporter = void Function(RiverpodAnalysisError); +@internal ErrorReporter? errorReporter; +enum RiverpodAnalysisErrorCode { + missingNotifierBuild, + abstractNotifier, + missingNotifierDefaultConstructor, + notifierDefaultConstructorHasRequiredParameters, + riverpodDependencyParseError, +} + class RiverpodAnalysisError { RiverpodAnalysisError( this.message, { this.targetNode, this.targetElement, + required this.code, }); final String message; final AstNode? targetNode; final Element? targetElement; + final RiverpodAnalysisErrorCode? code; @override String toString() { diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart index b3dc1b690..81451bdfa 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart @@ -39,6 +39,7 @@ extension on LibraryElement { 'No AsyncValue accessible in the library. ' 'Did you forget to import Riverpod?', targetElement: this, + code: null, ), ); return null; @@ -206,6 +207,7 @@ class ClassBasedProviderDeclaration extends GeneratorProviderDeclaration { 'Classes annotated with @riverpod cannot be abstract.', targetNode: node, targetElement: node.declaredElement, + code: RiverpodAnalysisErrorCode.abstractNotifier, ), ); } @@ -220,6 +222,7 @@ class ClassBasedProviderDeclaration extends GeneratorProviderDeclaration { 'Classes annotated with @riverpod must have a default constructor.', targetNode: node, targetElement: node.declaredElement, + code: RiverpodAnalysisErrorCode.missingNotifierDefaultConstructor, ), ); } @@ -232,6 +235,8 @@ class ClassBasedProviderDeclaration extends GeneratorProviderDeclaration { 'cannot have required parameters.', targetNode: node, targetElement: node.declaredElement, + code: RiverpodAnalysisErrorCode + .notifierDefaultConstructorHasRequiredParameters, ), ); } @@ -245,6 +250,7 @@ class ClassBasedProviderDeclaration extends GeneratorProviderDeclaration { 'No "build" method found. ' 'Classes annotated with @riverpod must define a method named "build".', targetNode: node, + code: RiverpodAnalysisErrorCode.missingNotifierBuild, ), ); return null; diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart index 7a00e22a8..6629f4b25 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart @@ -119,6 +119,7 @@ class RiverpodAnnotation extends RiverpodAst { RiverpodAnalysisError( '@Riverpod(dependencies: <...>) only support list literals (using []).', targetNode: dependenciesNodeValue, + code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, ), ); } else { @@ -128,6 +129,7 @@ class RiverpodAnnotation extends RiverpodAst { RiverpodAnalysisError( '@Riverpod(dependencies: [...]) does not support if/for/spread operators.', targetNode: dependency, + code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, ), ); continue; @@ -138,6 +140,7 @@ class RiverpodAnnotation extends RiverpodAst { RiverpodAnalysisError( 'Only elements annotated with @riverpod are supported as "dependencies".', targetNode: dependency, + code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, ), ); continue; @@ -154,6 +157,7 @@ class RiverpodAnnotation extends RiverpodAst { RiverpodAnalysisError( 'The dependency $dependency is not a class annotated with @riverpod', targetNode: dependency, + code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, ), ); continue; @@ -175,6 +179,7 @@ class RiverpodAnnotation extends RiverpodAst { RiverpodAnalysisError( 'The dependency $dependency is not a class annotated with @riverpod', targetNode: dependency, + code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, ), ); continue; @@ -191,6 +196,7 @@ class RiverpodAnnotation extends RiverpodAst { RiverpodAnalysisError( '@Riverpod(dependencies: [...]) only supports elements annotated with @riverpod as values.', targetNode: dependency, + code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, ), ); } diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart index 3f45be286..2ea9d6a75 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart @@ -38,6 +38,7 @@ class RiverpodAnnotationElement { RiverpodAnalysisError( 'Failed to parse dependency $dep', targetElement: element, + code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, ), ); return null; @@ -81,6 +82,7 @@ class RiverpodAnnotationElement { 'Unsupported dependency. ' 'Only functions and classes annotated by @riverpod are supported.', targetElement: targetElement, + code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, ), ); return null; @@ -295,6 +297,7 @@ class ClassBasedProviderDeclarationElement 'No "build" method found. ' 'Classes annotated with @riverpod must define a method named "build".', targetElement: element, + code: RiverpodAnalysisErrorCode.missingNotifierBuild, ), ); diff --git a/packages/riverpod_lint/README.md b/packages/riverpod_lint/README.md index b4d29943d..c68031bc1 100644 --- a/packages/riverpod_lint/README.md +++ b/packages/riverpod_lint/README.md @@ -52,6 +52,7 @@ Riverpod_lint adds various warnings with quick fixes and refactoring options, su - [notifier\_extends (riverpod\_generator only)](#notifier_extends-riverpod_generator-only) - [avoid\_ref\_inside\_state\_dispose](#avoid_ref_inside_state_dispose) - [notifier\_build (riverpod\_generator only)](#notifier_build-riverpod_generator-only) +- [riverpod\_syntax\_error (riverpod\_generator only)](#riverpod_syntax_error-riverpod_generator-only) - [async\_value\_nullable\_patttern](#async_value_nullable_patttern) - [protected\_notifier\_properties](#protected_notifier_properties) - [All assists](#all-assists) @@ -611,6 +612,33 @@ class Example extends _$Example { class Example extends _$Example {} ``` +## riverpod_syntax_error (riverpod_generator only) + +A general purpose lint, for when an exception is detected +in `riverpod_generator`. This reports the error in the relevant file. + +For example, an error will be shown if a "notifier" is abstract: + +**Good**: + +```dart +@riverpod +class Example extends _$Example { + @override + int build() => 0; +} +``` + +**Bad**: + +```dart +@riverpod +abstract class Example extends _$Example { + @override + int build() => 0; +} +``` + ### async_value_nullable_patttern Warn if the pattern `AsyncValue(:final value?)` is used when the data diff --git a/packages/riverpod_lint/lib/riverpod_lint.dart b/packages/riverpod_lint/lib/riverpod_lint.dart index f4e65de63..3a9fea668 100644 --- a/packages/riverpod_lint/lib/riverpod_lint.dart +++ b/packages/riverpod_lint/lib/riverpod_lint.dart @@ -19,6 +19,7 @@ import 'src/lints/notifier_extends.dart'; import 'src/lints/protected_notifier_properties.dart'; import 'src/lints/provider_dependencies.dart'; import 'src/lints/provider_parameters.dart'; +import 'src/lints/riverpod_syntax_error.dart'; import 'src/lints/scoped_providers_should_specify_dependencies.dart'; import 'src/lints/unsupported_provider_value.dart'; @@ -41,6 +42,8 @@ class _RiverpodPlugin extends PluginBase { const NotifierBuild(), const AsyncValueNullablePattern(), const ProtectedNotifierProperties(), + // TODO changelog added riverpod_syntax_error, for reporting errors when the generator would throw. + const RiverpodSyntaxError(), ]; @override diff --git a/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart b/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart new file mode 100644 index 000000000..8fd95eb66 --- /dev/null +++ b/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart @@ -0,0 +1,52 @@ +import 'package:analyzer/error/error.dart'; +import 'package:analyzer/error/listener.dart'; +import 'package:analyzer/source/source_range.dart'; +import 'package:custom_lint_builder/custom_lint_builder.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; + +import '../riverpod_custom_lint.dart'; + +// TODO changelog new lint +class RiverpodSyntaxError extends RiverpodLintRule { + const RiverpodSyntaxError() : super(code: _code); + + static const _code = LintCode( + name: 'riverpod_syntax_error', + problemMessage: '{0}', + errorSeverity: ErrorSeverity.ERROR, + ); + + @override + void run( + CustomLintResolver resolver, + ErrorReporter reporter, + CustomLintContext context, + ) { + riverpodRegistry(context).addRiverpodUnit((unit) { + for (final error in unit.errors) { + switch (error.code) { + case RiverpodAnalysisErrorCode.missingNotifierBuild: + // Silencing errors already covered by a different lint + continue; + case _: + } + + final location = switch (error) { + RiverpodAnalysisError(:final targetElement?) => + SourceRange(targetElement.nameOffset, targetElement.nameLength), + RiverpodAnalysisError(:final targetNode?) => targetNode.sourceRange, + _ => null, + }; + + if (location == null) continue; + + reporter.reportErrorForOffset( + _code, + location.offset, + location.length, + [error.message], + ); + } + }); + } +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/riverpod_syntax_error/riverpod_syntax_error.dart b/packages/riverpod_lint_flutter_test/test/lints/riverpod_syntax_error/riverpod_syntax_error.dart new file mode 100644 index 000000000..96a2861dc --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/riverpod_syntax_error/riverpod_syntax_error.dart @@ -0,0 +1,10 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +/// Fake Provider +typedef _$ExampleProvider1 = Object; + +@riverpod +// expect_lint: riverpod_syntax_error +abstract class ExampleProvider1 extends _$ExampleProvider1 { + int build() => 0; +} From 4850853a58d4a41b03e1aaa592c0e118304bc7fb Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 11 Feb 2024 10:11:21 +0100 Subject: [PATCH 215/387] Make notifier_build an error --- packages/riverpod_lint/lib/src/lints/notifier_build.dart | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/riverpod_lint/lib/src/lints/notifier_build.dart b/packages/riverpod_lint/lib/src/lints/notifier_build.dart index eb04c2f67..809d772c1 100644 --- a/packages/riverpod_lint/lib/src/lints/notifier_build.dart +++ b/packages/riverpod_lint/lib/src/lints/notifier_build.dart @@ -15,6 +15,8 @@ class NotifierBuild extends RiverpodLintRule { name: 'notifier_build', problemMessage: 'Classes annotated by `@riverpod` must have the `build` method', + // TODO changelog `notifier_build` is now an error. + errorSeverity: ErrorSeverity.ERROR, ); @override From 9ef6b59433ddd6b6d9cd9af62eae9396f7966bda Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 11 Feb 2024 10:17:36 +0100 Subject: [PATCH 216/387] Remove dead code and clean-up a bit --- packages/riverpod_lint/lib/riverpod_lint.dart | 16 +- .../avoid_dynamic_providers.dart | 22 - .../avoid_exposing_provider_ref.dart | 22 - .../avoid_exposing_widget_ref.dart | 21 - .../avoid_read_inside_build.dart | 21 - .../avoid_watch_outside_build.dart | 23 - .../dont_modify_providers_during_init.dart | 21 - ...fy_providers_inside_widget_lifecycles.dart | 21 - .../lib/src/legacy_backup/riverpod_lint.copy | 1437 ----------------- .../avoid_global_provider_container.dart | 1 + .../src/lints/avoid_read_auto_dispose.dart | 1 + .../lib/src/lints/prefer_final_provider.dart | 26 - 12 files changed, 10 insertions(+), 1622 deletions(-) delete mode 100644 packages/riverpod_lint/lib/src/legacy_backup/avoid_dynamic_providers.dart delete mode 100644 packages/riverpod_lint/lib/src/legacy_backup/avoid_exposing_provider_ref.dart delete mode 100644 packages/riverpod_lint/lib/src/legacy_backup/avoid_exposing_widget_ref.dart delete mode 100644 packages/riverpod_lint/lib/src/legacy_backup/avoid_read_inside_build.dart delete mode 100644 packages/riverpod_lint/lib/src/legacy_backup/avoid_watch_outside_build.dart delete mode 100644 packages/riverpod_lint/lib/src/legacy_backup/dont_modify_providers_during_init.dart delete mode 100644 packages/riverpod_lint/lib/src/legacy_backup/dont_modify_providers_inside_widget_lifecycles.dart delete mode 100644 packages/riverpod_lint/lib/src/legacy_backup/riverpod_lint.copy delete mode 100644 packages/riverpod_lint/lib/src/lints/prefer_final_provider.dart diff --git a/packages/riverpod_lint/lib/riverpod_lint.dart b/packages/riverpod_lint/lib/riverpod_lint.dart index 3a9fea668..7ae810a17 100644 --- a/packages/riverpod_lint/lib/riverpod_lint.dart +++ b/packages/riverpod_lint/lib/riverpod_lint.dart @@ -28,22 +28,22 @@ PluginBase createPlugin() => _RiverpodPlugin(); class _RiverpodPlugin extends PluginBase { @override List getLintRules(CustomLintConfigs configs) => [ + const AsyncValueNullablePattern(), const AvoidBuildContextInProviders(), + const AvoidManualProvidersAsGeneratedProviderDependency(), const AvoidPublicNotifierProperties(), + const AvoidRefInsideStateDispose(), const FunctionalRef(), const MissingProviderScope(), - const ProviderParameters(), - const NotifierExtends(), - const ProviderDependencies(), - const AvoidManualProvidersAsGeneratedProviderDependency(), - const ScopedProvidersShouldSpecifyDependencies(), - const UnsupportedProviderValue(), - const AvoidRefInsideStateDispose(), const NotifierBuild(), - const AsyncValueNullablePattern(), + const NotifierExtends(), const ProtectedNotifierProperties(), + const ProviderDependencies(), + const ProviderParameters(), // TODO changelog added riverpod_syntax_error, for reporting errors when the generator would throw. const RiverpodSyntaxError(), + const ScopedProvidersShouldSpecifyDependencies(), + const UnsupportedProviderValue(), ]; @override diff --git a/packages/riverpod_lint/lib/src/legacy_backup/avoid_dynamic_providers.dart b/packages/riverpod_lint/lib/src/legacy_backup/avoid_dynamic_providers.dart deleted file mode 100644 index 14ebef5e4..000000000 --- a/packages/riverpod_lint/lib/src/legacy_backup/avoid_dynamic_providers.dart +++ /dev/null @@ -1,22 +0,0 @@ -import 'package:analyzer/error/listener.dart'; -import 'package:custom_lint_builder/custom_lint_builder.dart'; - -class AvoidDynamicProviders extends DartLintRule { - const AvoidDynamicProviders() : super(code: _code); - - static const _code = LintCode( - name: 'avoid_dynamic_providers', - problemMessage: - 'Providers should only be created statically. They should not be ' - 'created inside functions or as properties of an object.', - ); - - @override - void run( - CustomLintResolver resolver, - ErrorReporter reporter, - CustomLintContext context, - ) { - // TODO: implement run - } -} diff --git a/packages/riverpod_lint/lib/src/legacy_backup/avoid_exposing_provider_ref.dart b/packages/riverpod_lint/lib/src/legacy_backup/avoid_exposing_provider_ref.dart deleted file mode 100644 index b4d6f9992..000000000 --- a/packages/riverpod_lint/lib/src/legacy_backup/avoid_exposing_provider_ref.dart +++ /dev/null @@ -1,22 +0,0 @@ -import 'package:analyzer/error/listener.dart'; -import 'package:custom_lint_builder/custom_lint_builder.dart'; - -class AvoidExposingProviderRef extends DartLintRule { - const AvoidExposingProviderRef() : super(code: _code); - - static const _code = LintCode( - name: 'avoid_exposing_provider_ref', - problemMessage: - 'The "ref" of a provider should not be accessible from outside of the ' - 'provider and its internals.', - ); - - @override - void run( - CustomLintResolver resolver, - ErrorReporter reporter, - CustomLintContext context, - ) { - // TODO: implement run - } -} diff --git a/packages/riverpod_lint/lib/src/legacy_backup/avoid_exposing_widget_ref.dart b/packages/riverpod_lint/lib/src/legacy_backup/avoid_exposing_widget_ref.dart deleted file mode 100644 index 7bdb2f1f3..000000000 --- a/packages/riverpod_lint/lib/src/legacy_backup/avoid_exposing_widget_ref.dart +++ /dev/null @@ -1,21 +0,0 @@ -import 'package:analyzer/error/listener.dart'; -import 'package:custom_lint_builder/custom_lint_builder.dart'; - -class AvoidExposingWidgetRef extends DartLintRule { - const AvoidExposingWidgetRef() : super(code: _code); - - static const _code = LintCode( - name: 'avoid_exposing_widget_ref', - problemMessage: - 'The "ref" of a widget should not be accessible outside of that widget.', - ); - - @override - void run( - CustomLintResolver resolver, - ErrorReporter reporter, - CustomLintContext context, - ) { - // TODO: implement run - } -} diff --git a/packages/riverpod_lint/lib/src/legacy_backup/avoid_read_inside_build.dart b/packages/riverpod_lint/lib/src/legacy_backup/avoid_read_inside_build.dart deleted file mode 100644 index b0596e479..000000000 --- a/packages/riverpod_lint/lib/src/legacy_backup/avoid_read_inside_build.dart +++ /dev/null @@ -1,21 +0,0 @@ -import 'package:analyzer/error/listener.dart'; -import 'package:custom_lint_builder/custom_lint_builder.dart'; - -import '../riverpod_custom_lint.dart'; - -class AvoidReadInsideBuild extends RiverpodLintRule { - const AvoidReadInsideBuild() : super(code: _code); - - static const _code = LintCode( - name: 'riverpod_avoid_read_inside_build', - problemMessage: - 'Avoid using ref.read inside the build method of widgets/providers.', - ); - - @override - void run( - CustomLintResolver resolver, - ErrorReporter reporter, - CustomLintContext context, - ) {} -} diff --git a/packages/riverpod_lint/lib/src/legacy_backup/avoid_watch_outside_build.dart b/packages/riverpod_lint/lib/src/legacy_backup/avoid_watch_outside_build.dart deleted file mode 100644 index b4f04bdcf..000000000 --- a/packages/riverpod_lint/lib/src/legacy_backup/avoid_watch_outside_build.dart +++ /dev/null @@ -1,23 +0,0 @@ -import 'package:analyzer/error/listener.dart'; -import 'package:custom_lint_builder/custom_lint_builder.dart'; - -import '../riverpod_custom_lint.dart'; - -class AvoidWatchOutsideBuild extends RiverpodLintRule { - const AvoidWatchOutsideBuild() : super(code: _code); - - static const _code = LintCode( - name: 'riverpod_avoid_watch_outside_build', - problemMessage: - 'Avoid using ref.watch outside the build method of widgets/providers.', - ); - - @override - void run( - CustomLintResolver resolver, - ErrorReporter reporter, - CustomLintContext context, - ) { - riverpodRegistry(context).addRefWatchInvocation((watch) {}); - } -} diff --git a/packages/riverpod_lint/lib/src/legacy_backup/dont_modify_providers_during_init.dart b/packages/riverpod_lint/lib/src/legacy_backup/dont_modify_providers_during_init.dart deleted file mode 100644 index c2673ad9c..000000000 --- a/packages/riverpod_lint/lib/src/legacy_backup/dont_modify_providers_during_init.dart +++ /dev/null @@ -1,21 +0,0 @@ -import 'package:analyzer/error/listener.dart'; -import 'package:custom_lint_builder/custom_lint_builder.dart'; - -class DontModifyProvidersDuringInit extends DartLintRule { - const DontModifyProvidersDuringInit() : super(code: _code); - - static const _code = LintCode( - name: 'dont_modify_providers_during_init', - problemMessage: - 'During its initialization, a provider should not modify other providers.', - ); - - @override - void run( - CustomLintResolver resolver, - ErrorReporter reporter, - CustomLintContext context, - ) { - // TODO: implement run - } -} diff --git a/packages/riverpod_lint/lib/src/legacy_backup/dont_modify_providers_inside_widget_lifecycles.dart b/packages/riverpod_lint/lib/src/legacy_backup/dont_modify_providers_inside_widget_lifecycles.dart deleted file mode 100644 index 9f0c0ea3c..000000000 --- a/packages/riverpod_lint/lib/src/legacy_backup/dont_modify_providers_inside_widget_lifecycles.dart +++ /dev/null @@ -1,21 +0,0 @@ -import 'package:analyzer/error/listener.dart'; -import 'package:custom_lint_builder/custom_lint_builder.dart'; - -class DontModifyProvidersInsideWidgetLifecycles extends DartLintRule { - const DontModifyProvidersInsideWidgetLifecycles() : super(code: _code); - - static const _code = LintCode( - name: 'dont_modify_providers_inside_widget_lifecycles', - problemMessage: 'Widget life-cycles are not allowed to modify providers, ' - 'and this would lead to an exception.', - ); - - @override - void run( - CustomLintResolver resolver, - ErrorReporter reporter, - CustomLintContext context, - ) { - // TODO: implement run - } -} diff --git a/packages/riverpod_lint/lib/src/legacy_backup/riverpod_lint.copy b/packages/riverpod_lint/lib/src/legacy_backup/riverpod_lint.copy deleted file mode 100644 index 3c62b8cfa..000000000 --- a/packages/riverpod_lint/lib/src/legacy_backup/riverpod_lint.copy +++ /dev/null @@ -1,1437 +0,0 @@ -import 'dart:async'; - -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/ast/ast.dart'; -import 'package:analyzer/dart/ast/syntactic_entity.dart'; -import 'package:analyzer/dart/ast/token.dart'; -import 'package:analyzer/dart/element/element.dart'; -import 'package:analyzer/dart/element/type.dart'; -import 'package:analyzer/source/source_range.dart'; -import 'package:analyzer_plugin/protocol/protocol_generated.dart'; -import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart'; -import 'package:collection/collection.dart'; -import 'package:custom_lint_builder/custom_lint_builder.dart'; -import 'package:meta/meta.dart'; -import 'package:riverpod/riverpod.dart'; -import 'src/analyzer_utils.dart'; - -PluginBase createPlugin() => _RiverpodPlugin(); - -extension on String { - String get titled { - return replaceFirstMapped( - RegExp('[a-zA-Z]'), - (match) => match.group(0)!.toUpperCase(), - ); - } - - String get lowerFirst { - return replaceFirstMapped( - RegExp('[a-zA-Z]'), - (match) => match.group(0)!.toLowerCase(), - ); - } -} - -class _RiverpodPlugin extends PluginBase { - @override - Stream getLints(ResolvedUnitResult resolvedUnitResult) { - final visitor = RiverpodVisitor(resolvedUnitResult); - return resolvedUnitResult.unit.accept(visitor) ?? - const Stream.empty(); - } - - @override - Future handleGetAssists( - ResolvedUnitResult resolvedUnitResult, { - required int offset, - required int length, - }) async { - return EditGetAssistsResult( - await _computeAssistChanges( - resolvedUnitResult, - offset: offset, - length: length, - ).toList(), - ); - } - - Stream _computeAssistChanges( - ResolvedUnitResult resolvedUnitResult, { - required int offset, - required int length, - }) async* { - final unit = SourceRange( - resolvedUnitResult.unit.offset, - resolvedUnitResult.unit.length, - ); - - print( - 'Asked for $offset($length), got ${resolvedUnitResult.unit.offset} ' - '// ${resolvedUnitResult.unit.length} ' - '// ${unit.contains(offset)}', - ); - final child = resolvedUnitResult.unit.findAstNodeAtOffset(offset); - print('Found item $child ${child.runtimeType}'); - - if (child is FunctionDeclaration) { - final element = child.declaredElement!; - final annotation = _riverpod.firstAnnotationOf(element); - if (annotation == null) return; - - print('function at offset'); - final changeBuilder = ChangeBuilder(session: resolvedUnitResult.session); - - // The function offset after the annotations/comments. - final functionStartOffset = child.returnType?.offset ?? child.name.offset; - final functionLength = child.end - functionStartOffset; - - final newClassName = child.name.lexeme.titled; - - await changeBuilder.addDartFileEdit( - resolvedUnitResult.path, - (builder) { - builder.addReplacement( - SourceRange(functionStartOffset, functionLength), - (builder) { - builder.write(''' -class $newClassName extends _\$$newClassName { - ${child.returnType?.resolveSource(resolvedUnitResult) ?? ''} build() ${child.functionExpression.body.resolveSource(resolvedUnitResult)} -} -'''); - }, - ); - }, - ); - - yield PrioritizedSourceChange( - 1, - changeBuilder.sourceChange..message = 'Refactor provider as class', - ); - } - - if (child is ClassDeclaration) { - final element = child.declaredElement!; - final annotation = _riverpod.firstAnnotationOf(element); - if (annotation == null) return; - - final changeBuilder = ChangeBuilder(session: resolvedUnitResult.session); - - final buildMethod = child.members - .whereType() - .firstWhereOrNull((element) => element.name.lexeme == 'build'); - if (buildMethod == null) return; - - final newFunctionName = child.name.lexeme.lowerFirst; - final newFunctionRefName = '${child.name.lexeme.titled}Ref'; - - await changeBuilder.addDartFileEdit( - resolvedUnitResult.path, - (builder) { - builder.addReplacement( - SourceRange( - child.classKeyword.offset, - child.end - child.classKeyword.offset, - ), - (builder) { - builder.write(''' -${buildMethod.returnType?.resolveSource(resolvedUnitResult) ?? ''} $newFunctionName($newFunctionRefName ref) ${buildMethod.body.resolveSource(resolvedUnitResult)} -'''); - }, - ); - }, - ); - - yield PrioritizedSourceChange( - 1, - changeBuilder.sourceChange..message = 'Refactor provider as function', - ); - } - } -} - -bool _isOffsetInSourceRange( - int targetOffset, { - required int rangeOffset, - required int rangeLength, -}) { - return SourceRange(rangeOffset, rangeLength).contains(targetOffset); -} - -extension on AstNode { - String resolveSource(ResolvedUnitResult resolvedUnitResult) { - return resolvedUnitResult.content.substring(offset, end); - } - - AstNode? findAstNodeAtOffset(int targetOffset) { - final containsTarget = _isOffsetInSourceRange( - targetOffset, - rangeOffset: offset, - rangeLength: length, - ); - if (!containsTarget) { - return null; - } - - for (final child in childEntities) { - final match = child.when( - token: (_) { - // Ignoring tokens as we only care about returning AstNodes - }, - node: (node) => node.findAstNodeAtOffset(targetOffset), - ); - if (match != null) return match; - } - - return this; - } -} - -extension on SyntacticEntity { - R when({ - required R Function(Token token) token, - required R Function(AstNode node) node, - }) { - final that = this; - if (that is Token) { - return token(that); - } else if (that is AstNode) { - return node(that); - } else { - throw UnsupportedError('Unknown object $runtimeType'); - } - } - - // SyntacticEntity? findChildAtOffset(int targetOffset) { - // final containsTarget = _isOffsetInSourceRange( - // targetOffset, - // rangeOffset: offset, - // rangeLength: length, - // ); - // if (!containsTarget) { - // return null; - // } - - // return when( - // token: (token) { - // var result = token; - // for (Token? tokenItem = token; - // tokenItem != null; - // tokenItem = tokenItem == tokenItem.next ? null : tokenItem.next) { - // if (tokenItem.length >= result.length) continue; - // final containsOffset = _isOffsetInSourceRange( - // targetOffset, - // rangeOffset: tokenItem.offset, - // rangeLength: tokenItem.length, - // ); - // if (containsOffset) { - // result = tokenItem; - // } - // } - - // return result; - // }, - // node: (node) { - // for (final child in node.childEntities) { - // final match = child.findChildAtOffset(targetOffset); - // if (match != null) return match; - // } - // return this; - // }, - // ); - // } -} - -mixin _ProviderCreationVisitor on AsyncRecursiveVisitor { - /// The initialization of a provider was found - Stream? visitProviderCreation(AstNode node); - - @override - Stream? visitFunctionExpressionInvocation( - FunctionExpressionInvocation node, - ) async* { - final superStream = super.visitFunctionExpressionInvocation(node); - if (superStream != null) yield* superStream; - - if (node.isProviderCreation ?? false) { - final stream = visitProviderCreation(node); - if (stream != null) yield* stream; - } - } - - @override - Stream? visitInstanceCreationExpression( - InstanceCreationExpression node, - ) async* { - final superStream = super.visitInstanceCreationExpression(node); - if (superStream != null) yield* superStream; - - final createdType = node.staticType?.element; - if (createdType != null && - _providerOrFamily.isAssignableFrom(createdType)) { - final stream = visitProviderCreation(node); - if (stream != null) yield* stream; - } - } - - @override - Stream? visitClassDeclaration(ClassDeclaration node) async* { - final superStream = super.visitClassDeclaration(node); - if (superStream != null) yield* superStream; - if (node.isProviderCreation ?? false) { - final stream = visitProviderCreation(node); - if (stream != null) yield* stream; - } - } - - @override - Stream? visitFunctionDeclaration(FunctionDeclaration node) async* { - final superStream = super.visitFunctionDeclaration(node); - if (superStream != null) yield* superStream; - if (node.isProviderCreation ?? false) { - final stream = visitProviderCreation(node); - if (stream != null) yield* stream; - } - } -} - -class RefLifecycleInvocation { - RefLifecycleInvocation._(this.invocation); - - final MethodInvocation invocation; - - late final bool? isWithinBuild = invocation.inBuild; -} - -enum AsyncContext { - // Synchronous context in build of widget / initState or Provider - buildSync, - // Synchronous context in callback function - callbackSync, - // In callback, but after await / await_for - callbackAfterAsync; - - bool get isSync => this == buildSync || this == callbackSync; - bool get isAsync => this == callbackAfterAsync; -} - -mixin _AsyncContextVisitor on AsyncRecursiveVisitor { - AsyncContext context = AsyncContext.buildSync; - @override - Stream? visitMethodDeclaration(MethodDeclaration node) async* { - final last = context; - context = AsyncContext.buildSync; - yield* super.visitMethodDeclaration(node) ?? const Stream.empty(); - context = last; - } - - @override - Stream? visitFunctionExpression(FunctionExpression node) async* { - final last = context; - if (node.isBuild() ?? false) { - context = AsyncContext.buildSync; - } else { - context = AsyncContext.callbackSync; - } - yield* super.visitFunctionExpression(node) ?? const Stream.empty(); - context = last; - } - - @override - Stream? visitAwaitExpression(AwaitExpression node) async* { - yield* super.visitAwaitExpression(node) ?? const Stream.empty(); - context = AsyncContext.callbackAfterAsync; - } - - @override - Stream? visitForStatement(ForStatement node) async* { - // First time through the loop could be synchronous, so wait till the loop is done - yield* super.visitForStatement(node) ?? const Stream.empty(); - if (node.awaitKeyword != null) { - context = AsyncContext.callbackAfterAsync; - } - } -} -mixin _RefLifecycleVisitor on AsyncRecursiveVisitor { - /// A Ref/WidgetRef method was invoked. It isn't guaranteed to be watch/listen/read - Stream? visitRefInvocation(RefLifecycleInvocation node); - - @override - Stream? visitMethodInvocation(MethodInvocation node) async* { - final superStream = super.visitMethodInvocation(node); - if (superStream != null) yield* superStream; - - final targetType = node.target?.staticType?.element; - if (targetType == null) { - return; - } - - if (_ref.isAssignableFrom(targetType) || - _widgetRef.isAssignableFrom(targetType) || - _container.isAssignableFrom(targetType)) { - final refInvocStream = visitRefInvocation(RefLifecycleInvocation._(node)); - if (refInvocStream != null) yield* refInvocStream; - } - } -} - -mixin _InvocationVisitor - on AsyncRecursiveVisitor, _AsyncContextVisitor { - // Whether the method is forced async - bool forceAsync = false; - bool get asyncBad; - Stream visitCalledFunction(AstNode node, {required AstNode callingNode}); - @override - Stream? visitPropertyAccess(PropertyAccess node) async* { - final method = node.propertyName.staticElement; - if (method != null) { - final ast = await findAstNodeForElement(method); - if (ast != null && ast.refPassed) { - yield* visitCalledFunction(ast, callingNode: node); - } - } - yield* super.visitPropertyAccess(node) ?? const Stream.empty(); - } - - @override - Stream? visitPrefixedIdentifier(PrefixedIdentifier node) async* { - final method = node.identifier.staticElement; - if (method != null) { - final ast = await findAstNodeForElement(method); - if (ast != null && ast.refPassed) { - yield* visitCalledFunction(ast, callingNode: node); - } - } - yield* super.visitPrefixedIdentifier(node) ?? const Stream.empty(); - } - - @override - Stream? visitFunctionExpressionInvocation( - FunctionExpressionInvocation node, - ) async* { - final method = node.staticElement; - if (method != null) { - final ast = await findAstNodeForElement(method); - if (ast != null && ast.refPassed) { - yield* visitCalledFunction( - ast as FunctionDeclaration, - callingNode: node, - ); - } - } - yield* super.visitFunctionExpressionInvocation(node) ?? - const Stream.empty(); - } - - @override - Stream? visitMethodInvocation(MethodInvocation node) async* { - final method = node.methodName.staticElement; - if (method != null) { - final ast = await findAstNodeForElement(method.declaration!); - if (ast != null && ast.refPassed) { - yield* visitCalledFunction(ast, callingNode: node); - } - } - - yield* super.visitMethodInvocation(node) ?? const Stream.empty(); - } - - @override - Stream? visitInstanceCreationExpression( - InstanceCreationExpression node, - ) async* { - final constructor = node.constructorName.staticElement; - if (constructor != null) { - if (_futureOrStream.isAssignableFrom(constructor.enclosingElement)) { - if (!asyncBad) { - return; - } else { - for (final arg in node.argumentList.arguments) { - // The arguments to a future or stream could be called after a widget is disposed - final last = context; - final lastAsync = forceAsync; - forceAsync = true; - context = AsyncContext.callbackAfterAsync; - yield* visitExpression(arg) ?? const Stream.empty(); - context = last; - forceAsync = lastAsync; - } - } - } else { - final ast = await findAstNodeForElement(constructor.declaration); - - if (ast != null) { - yield* visitConstructorDeclaration(ast as ConstructorDeclaration) ?? - const Stream.empty(); - } - for (final arg in node.argumentList.arguments) { - yield* visitExpression(arg) ?? const Stream.empty(); - } - } - } - } -} - -/// Recursively search all the places where a Provider's `ref` is used -// TODO handle Ref fn() => ref; -class ProviderRefUsageVisitor extends AsyncRecursiveVisitor - with _RefLifecycleVisitor { - @override - Stream? visitArgumentList(ArgumentList node) async* { - final superStream = super.visitArgumentList(node); - if (superStream != null) yield* superStream; - final providerBody = node.arguments.firstOrNull; - if (providerBody is ConstructorReference) { - final element = providerBody - .constructorName.staticElement?.declaration.enclosingElement; - if (element != null) { - final ast = await findAstNodeForElement(element); - - final createdObjectStream = ast?.accept(this); - if (createdObjectStream != null) yield* createdObjectStream; - } - } - - argumentsLoop: - for (final arg in node.arguments) { - final type = arg.staticType?.element; - if (type != null && _ref.isAssignableFrom(type)) { - // "ref" was passed as argument to a constructor/function. - // We now will search for the constructor/function invoked, to see how - // it uses ref. - - for (final parent in node.parents) { - if (parent is MethodInvocation) { - final functionExpression = parent.function; - final functionElement = functionExpression is Identifier - ? functionExpression.staticElement - : null; - - if (functionElement != null) { - final declaration = await findAstNodeForElement(functionElement); - final createdObjectStream = declaration?.accept(this); - if (createdObjectStream != null) yield* createdObjectStream; - } - - continue argumentsLoop; - } else if (parent is InstanceCreationExpression) { - final createdObject = parent.staticType?.element; - - if (createdObject != null) { - final ast = await findAstNodeForElement(createdObject); - final createdObjectStream = ast?.accept(this); - if (createdObjectStream != null) yield* createdObjectStream; - } - - continue argumentsLoop; - } - } - } - } - } - - @override - Stream? visitAssignmentExpression( - AssignmentExpression node, - ) async* { - final superStream = super.visitAssignmentExpression(node); - if (superStream != null) yield* superStream; - final rightType = node.rightHandSide.staticType?.element; - - if (rightType != null && _ref.isAssignableFrom(rightType)) { - // "ref" was assigned to a variable or field - // We now will see if it is a field, to see how the class the field is assigned to uses ref. - for (final parent in node.parents) { - if (parent is CascadeExpression) { - final classElement = parent.target.staticType?.element; - if (classElement != null) { - final declaration = await findAstNodeForElement(classElement); - final objectStream = declaration?.accept(this); - if (objectStream != null) yield* objectStream; - } - } else if (parent is ExpressionStatement) { - final assignee = node.leftHandSide; - if (assignee is PrefixedIdentifier) { - final target = assignee.prefix.staticType?.element; - if (target is InterfaceElement) { - final declaration = await findAstNodeForElement(target); - final objectStream = declaration?.accept(this); - if (objectStream != null) yield* objectStream; - } - } - } - } - } - } - - @override - Stream? visitRefInvocation( - RefLifecycleInvocation node, - ) async* { - if (_refBinders.contains(node.invocation.methodName.name)) { - final providerExpression = node.invocation.argumentList.arguments.first; - final providerOrigin = - await ProviderDeclaration.tryParse(providerExpression); - - if (providerOrigin != null) yield providerOrigin; - } - } -} - -class RefAsyncUsageVisitor extends AsyncRecursiveVisitor - with _AsyncContextVisitor, _InvocationVisitor, _RefLifecycleVisitor { - RefAsyncUsageVisitor(this.unit); - final ResolvedUnitResult unit; - - @override - Stream visitCalledFunction( - AstNode node, { - required AstNode callingNode, - }) async* { - final results = node is MethodDeclaration - ? visitMethodDeclaration(node) - : node is FunctionDeclaration - ? visitFunctionDeclaration(node) - : null; - if (results != null) { - await for (final _ in results) { - yield Lint( - code: 'riverpod_no_ref_after_async', - message: - 'Do not use ref after async gaps in flutter widgets, a function was called which uses ref after a widget could be disposed', - location: unit.lintLocationFromOffset( - callingNode.offset, - length: callingNode.length, - ), - ); - // Only need to report the function once - return; - } - } - } - - @override - Stream? visitRefInvocation(RefLifecycleInvocation node) async* { - if (context == AsyncContext.callbackAfterAsync) { - // TODO Allow checking mounted in stateful widgets and checking mounted in StateNotifiers - yield Lint( - code: 'riverpod_no_ref_after_async', - message: 'Do not use ref after async gaps in flutter widgets.', - location: unit.lintLocationFromOffset( - node.invocation.offset, - length: node.invocation.length, - ), - ); - } - } - - @override - bool get asyncBad => true; -} - -extension on FormalParameterList { - bool get hasRefParameter { - return parameters.any((p) { - final type = p.declaredElement?.type; - return type != null && _anyRef.isAssignableFromType(type); - }); - } -} - -extension on InterfaceOrAugmentationElement { - bool get hasRefField => - fields.any((f) => _anyRef.isAssignableFromType(f.type)); -} - -extension RefPassed on AstNode { - bool get refPassed { - final node = this; - if (node is MethodDeclaration) { - if (!(node.parameters?.hasRefParameter ?? false)) { - final enclosingElement = node.declaredElement?.enclosingElement; - if (enclosingElement is ExtensionElement && - !_anyRef.isAssignableFromType(enclosingElement.extendedType)) { - return false; // If ref is not passed in, there is no way the ref could be used within the the called function - } else if (enclosingElement is InterfaceOrAugmentationElement && - !enclosingElement.hasRefField) { - return false; // If ref is not passed in and not a field, there is no way the ref could be used within the the called function - } - } - } else if (node is FunctionDeclaration) { - if (!(node.functionExpression.parameters?.hasRefParameter ?? false)) { - return false; // If ref is not passed in, there is no way the ref could be used within the the called function - } - } - return true; - } -} - -class ProviderSyncMutationVisitor extends AsyncRecursiveVisitor - with _AsyncContextVisitor, _InvocationVisitor { - ProviderSyncMutationVisitor(this.unit); - - final ResolvedUnitResult unit; - - @override - Stream visitCalledFunction( - AstNode node, { - required AstNode callingNode, - }) async* { - final results = node is MethodDeclaration - ? visitMethodDeclaration(node) - : node is FunctionDeclaration - ? visitFunctionDeclaration(node) - : null; - if (results != null) { - await for (final _ in results) { - yield Lint( - code: 'riverpod_no_mutate_sync', - message: - 'Do not mutate a provider synchronously, a function was called which mutates a provider synchronously', - location: unit.lintLocationFromOffset( - callingNode.offset, - length: callingNode.length, - ), - ); - // Only need to report the function once - return; - } - } - } - - @override - Stream? visitExpression(Expression node) async* { - final lints = super.visitExpression(node); - yield* lints ?? const Stream.empty(); - final mutate = node.isMutation; - if (!forceAsync && context == AsyncContext.buildSync && (mutate ?? false)) { - yield Lint( - code: 'riverpod_no_mutate_sync', - message: 'Do not mutate a provider synchronously', - location: unit.lintLocationFromOffset( - node.offset, - length: node.length, - ), - ); - } - } - - @override - Stream? visitNode(AstNode node) { - if (!forceAsync && context == AsyncContext.buildSync) { - return super.visitNode(node); - } - return null; - } - - @override - bool get asyncBad => false; -} - -class _FindProviderCallbackVisitor - extends CombiningRecursiveVisitor { - @override - Iterable? visitArgumentList(ArgumentList node) { - if (node.arguments.isEmpty) return null; - - return [node.arguments.first as FunctionExpression]; - } -} - -class RiverpodVisitor extends AsyncRecursiveVisitor - with _RefLifecycleVisitor, _ProviderCreationVisitor { - RiverpodVisitor(this.unit); - - final ResolvedUnitResult unit; - - @override - Stream visitRefInvocation(RefLifecycleInvocation node) async* { - switch (node.invocation.methodName.name) { - case 'read': - if (node.isWithinBuild ?? false) { - yield Lint( - code: 'riverpod_avoid_read_inside_build', - message: - 'Avoid using ref.read inside the build method of widgets/providers.', - location: unit.lintLocationFromOffset( - node.invocation.offset, - length: node.invocation.length, - ), - ); - } - final arg = - node.invocation.argumentList.arguments.firstOrNull?.staticType; - - if (arg != null && - !_alwaysAliveProviderListenable.isAssignableFromType(arg)) { - yield Lint( - code: 'riverpod_avoid_read_auto_dispose', - message: 'Avoid using ref.read on an autoDispose provider', - correction: ''' -Instead use: - final listener = ref.listen(${node.invocation.argumentList.arguments.first}, (_, __){}); - final currentValue = listener.read(); -Then dispose of the listener when you no longer need the autoDispose provider to be kept alive.''', - location: unit.lintLocationFromOffset( - node.invocation.offset, - length: node.invocation.length, - ), - ); - } - break; - case 'watch': - if (node.isWithinBuild == false) { - yield Lint( - code: 'riverpod_avoid_watch_outside_build', - message: - 'Avoid using ref.watch outside the build method of widgets/providers.', - location: unit.lintLocationFromOffset( - node.invocation.offset, - length: node.invocation.length, - ), - ); - } - break; - default: - } - } - - @override - Stream visitProviderCreation(AstNode node) async* { - if (node is ClassDeclaration || node is FunctionDeclaration) { - yield* ProviderSyncMutationVisitor(unit).visitNode(node) ?? - const Stream.empty(); - return; - } - final variableDeclaration = - node.parents.whereType().firstOrNull; - - final providerDeclaration = variableDeclaration?.declaredElement != null - ? ProviderDeclaration._( - variableDeclaration!, - variableDeclaration.declaredElement!, - ) - : null; - yield* _checkValidProviderDeclaration(node); - - if (providerDeclaration != null) { - yield* _checkProviderDependencies(providerDeclaration); - - yield* ProviderSyncMutationVisitor(unit).visitNode(node) ?? - const Stream.empty(); - } - } - - @override - Stream? visitExpression(Expression node) async* { - final superStream = super.visitExpression(node); - if (superStream != null) yield* superStream; - final st = node.staticType?.element; - if (st != null && - _ref.isAssignableFrom(st) && - (node.parent is ExpressionFunctionBody || - node.parent is ReturnStatement)) { - yield Lint( - code: 'riverpod_ref_escape_scope', - message: 'Ref escaped the scope via a function or return expression.', - correction: - 'Pass ref to the function or constructor that needs it instead', - severity: LintSeverity.warning, - location: unit.lintLocationFromOffset( - node.offset, - length: node.length, - ), - ); - } - } - - @override - Stream? visitConstructorDeclaration( - ConstructorDeclaration node, - ) async* { - final superStream = super.visitConstructorDeclaration(node); - if (superStream != null) yield* superStream; - for (final param in node.parameters.parameters) { - final type = param.declaredElement?.type.element; - - if (type != null && _widgetRef.isAssignableFrom(type)) { - final klass = node.returnType.staticElement; - if (klass != null && - (_widget.isAssignableFrom(klass) || - _widgetState.isAssignableFrom(klass))) { - yield Lint( - code: 'riverpod_ref_escape_scope', - message: 'Ref escaped its scope to another widget.', - correction: 'Use a Consumer widget instead', - severity: LintSeverity.warning, - location: unit.lintLocationFromOffset( - param.offset, - length: param.length, - ), - ); - } - } - } - } - - Stream _checkProviderDependencies(ProviderDeclaration provider) async* { - final providerDependencies = await provider.dependencies; - if (providerDependencies == null) return; - final expectedDependencies = providerDependencies.value; - final visitor = ProviderRefUsageVisitor(); - final actualDependencies = await provider.node.accept(visitor)!.toList(); - - if (expectedDependencies == null) { - // no `dependencies` specified - - for (final actualDependency in actualDependencies) { - if (await actualDependency.isScoped) { - yield Lint( - code: 'riverpod_unspecified_dependencies', - message: 'This provider does not specify `dependencies`, ' - 'yet depends on "${actualDependency.name}" which did specify its dependencies.', - correction: 'Add `dependencies` to this provider ' - 'or remove `dependencies` from "${actualDependency.name}".', - severity: LintSeverity.warning, - location: unit.lintLocationFromOffset( - provider.node.offset, - length: provider.name.length, - ), - getAnalysisErrorFixes: (lint) async* { - final changeBuilder = ChangeBuilder(session: unit.session); - - final providerCallback = - provider.node.accept(_FindProviderCallbackVisitor())!.single; - - await changeBuilder.addDartFileEdit(unit.path, (builder) { - builder.addSimpleInsertion( - providerCallback.end, - ', dependencies: [${actualDependencies.map((e) => e.name).join(', ')}]', - ); - }); - - yield AnalysisErrorFixes( - lint.asAnalysisError(), - fixes: [ - PrioritizedSourceChange( - 0, - changeBuilder.sourceChange - ..message = 'List all dependencies', - ) - ], - ); - }, - ); - } - } - } else { - for (final actualDependency in actualDependencies) { - if (!expectedDependencies.any((e) => e.origin == actualDependency)) { - yield Lint( - code: 'riverpod_missing_dependency', - message: 'This provider depends on "${actualDependency.name}" ' - 'yet "${actualDependency.name}" isn\'t listed in the dependencies.', - correction: - 'Add "${actualDependency.name}" to the list of dependencies ' - 'of this provider.', - severity: LintSeverity.warning, - location: unit.lintLocationFromOffset( - // TODO is there a better way to do this? - provider.dependenciesExpression!.value!.offset, - length: 'dependencies'.length, - ), - ); - } - } - - for (final expectedDependency in expectedDependencies) { - if (!actualDependencies.contains(expectedDependency.origin)) { - yield Lint( - code: 'riverpod_unused_dependency', - message: - 'This provider specifies that it depends on "${expectedDependency.origin.name}" ' - 'yet it never uses that provider.', - correction: - 'Remove "${expectedDependency.origin.name}" from the list of dependencies.', - severity: LintSeverity.warning, - location: unit.lintLocationFromOffset( - // TODO is there a better way to do this? - expectedDependency.node.offset, - length: expectedDependency.node.length, - ), - ); - } - } - } - - // print( - // 'Provider\n - origin: $node\n - expected: ${dependencies.value}\n - dependencies: ${visitor.dependencies}'); - } - - @override - Stream visitTopLevelVariableDeclaration( - TopLevelVariableDeclaration node, - ) async* { - yield* super.visitTopLevelVariableDeclaration(node) ?? const Stream.empty(); - for (final variable in node.variables.variables) { - final type = variable.declaredElement?.type; - - if (type != null && _container.isAssignableFromType(type)) { - yield Lint( - code: 'riverpod_global_container', - message: 'This container is global', - correction: - 'Make the container non-global by creating it in your main and assigning it to a UncontrolledProviderScope.', - severity: LintSeverity.warning, - location: unit.lintLocationFromOffset( - variable.offset, - length: variable.length, - ), - ); - } - } - } - - @override - Stream visitNode(AstNode node) async* { - yield* super.visitNode(node) ?? const Stream.empty(); - if (node.isWidgetBuild ?? false) { - final syncMutationDetector = ProviderSyncMutationVisitor(unit); - final results = node is MethodDeclaration - ? syncMutationDetector.visitMethodDeclaration(node) - : node is FunctionDeclaration - ? syncMutationDetector.visitFunctionDeclaration(node) - : null; - yield* results ?? const Stream.empty(); - final refAfterAsyncGaps = RefAsyncUsageVisitor(unit); - final results2 = node is MethodDeclaration - ? refAfterAsyncGaps.visitMethodDeclaration(node) - : node is FunctionDeclaration - ? refAfterAsyncGaps.visitFunctionDeclaration(node) - : null; - yield* results2 ?? const Stream.empty(); - } else if (node.isInitState ?? false) { - final syncMutationDetector = ProviderSyncMutationVisitor(unit); - final results = node is MethodDeclaration - ? syncMutationDetector.visitMethodDeclaration(node) - : node is FunctionDeclaration - ? syncMutationDetector.visitFunctionDeclaration(node) - : null; - yield* results ?? const Stream.empty(); - } - } - - Stream _checkValidProviderDeclaration(AstNode providerNode) async* { - if (providerNode is ClassDeclaration || - providerNode is FunctionDeclaration) { - // Codegen provider - return; - } - final declaration = - providerNode.parents.whereType().firstOrNull; - final variable = declaration?.declaredElement; - - if (variable == null) { - yield Lint( - code: 'riverpod_final_provider', - message: 'Providers should always be declared as final', - location: unit.lintLocationFromOffset( - providerNode.offset, - length: providerNode.length, - ), - ); - return; - } - - final isGlobal = declaration!.parents.any( - (element) => - element is TopLevelVariableDeclaration || - (element is FieldDeclaration && element.isStatic), - ); - - if (!isGlobal) { - yield Lint( - code: 'riverpod_avoid_dynamic_provider', - message: - 'Providers should be either top level variables or static properties', - location: unit.lintLocationFromOffset( - variable.nameOffset, - length: variable.nameLength, - ), - ); - } - - if (!variable.isFinal) { - yield Lint( - code: 'riverpod_final_provider', - message: 'Providers should always be declared as final', - location: unit.lintLocationFromOffset( - variable.nameOffset, - length: variable.nameLength, - ), - ); - } - } -} - -extension on AstNode { - Iterable get parents sync* { - for (var node = parent; node != null; node = node.parent) { - yield node; - } - } -} - -class Result { - const Result(this.value); - final T value; - - @override - String toString() => 'Result($value)'; -} - -@immutable -class ProviderDeclaration { - ProviderDeclaration._(this.node, this.element); - - /// Decode a provider expression to extract the provider listened. - /// - /// For example, for: - /// - /// ```dart - /// family(42).select(...) - /// ``` - /// - /// this will return the variable definition of `family`. - /// - /// Returns `null` if failed to decode the expression. - // TODO fuse with riverpod_graph - static FutureOr tryParse(AstNode providerExpression) { - if (providerExpression is PropertyAccess) { - // watch(family(0).modifier) - final target = providerExpression.target; - if (target != null) return ProviderDeclaration.tryParse(target); - } else if (providerExpression is PrefixedIdentifier) { - // watch(provider.modifier) - return ProviderDeclaration.tryParse(providerExpression.prefix); - } else if (providerExpression is Identifier) { - // watch(variable) - final Object? staticElement = providerExpression.staticElement; - if (staticElement is PropertyAccessorElement) { - // TODO can this be removed? - return findAstNodeForElement(staticElement.declaration.variable) - .then((ast) { - if (ast is VariableDeclaration) { - return ProviderDeclaration._( - ast, - staticElement.declaration.variable, - ); - } - return null; - }); - } - } else if (providerExpression is FunctionExpressionInvocation) { - // watch(family(id)) - return ProviderDeclaration.tryParse(providerExpression.function); - } else if (providerExpression is MethodInvocation) { - // watch(variable.select(...)) or watch(family(id).select(...)) - final target = providerExpression.target; - if (target != null) return ProviderDeclaration.tryParse(target); - } - - return null; - } - - /// Finds the "dependencies:" expression in a provider creation - /// - /// Returns null if failed to parse. - /// Returns Result(null) if successfully passed but no dependencies was specified - static Result? _findDependenciesExpression( - VariableDeclaration node, - ) { - final initializer = node.initializer; - ArgumentList argumentList; - - if (initializer is InstanceCreationExpression) { - argumentList = initializer.argumentList; - } else if (initializer is FunctionExpressionInvocation) { - argumentList = initializer.argumentList; - } else { - return null; - } - - return Result( - argumentList.arguments - .whereType() - .firstWhereOrNull((e) => e.name.label.name == 'dependencies'), - ); - } - - /// Decode the parameter "dependencies" from a provider - /// - /// Returns null if failed to decode. - /// Returns a [Result] with `value` as null if the parameter "dependencies" was - /// not specified. - static Future?>?> _findDependencies( - Result? dependenciesExpressionResult, - ) async { - if (dependenciesExpressionResult == null) return null; - final namedExpression = dependenciesExpressionResult.value; - if (namedExpression == null) return const Result(null); - final value = namedExpression.expression; - if (value is! ListLiteral) return null; - - return Result( - await Stream.fromIterable(value.elements) - .asyncMap((node) async { - final origin = await ProviderDeclaration.tryParse(node); - if (origin == null) return null; - return ProviderDependency(origin, node); - }) - .where((e) => e != null) - .cast() - .toList(), - ); - } - - final VariableDeclaration node; - final VariableElement element; - - /// The [AstNode] that points to the `dependencies` parameter of a provider - late final dependenciesExpression = _findDependenciesExpression(node); - - /// The decoded `dependencies` of a provider - late final dependencies = _findDependencies(dependenciesExpression); - - late final Future isScoped = dependencies.then((e) => e?.value != null); - - String get name => node.name.lexeme; - - @override - String toString() => node.toString(); - - @override - bool operator ==(Object other) { - return other is ProviderDeclaration && element == other.element; - } - - @override - int get hashCode => element.hashCode; -} - -@immutable -class ProviderDependency { - const ProviderDependency(this.origin, this.node); - - /// The provider that is depended on - final ProviderDeclaration origin; - - /// The [AstNode] associated with this dependency - final AstNode node; -} - -extension on FunctionExpressionInvocation { - /// Null if unknown - bool? get isProviderCreation { - final returnType = staticType?.element; - if (returnType == null) return null; - - final function = this.function; - - return _providerOrFamily.isAssignableFrom(returnType) && - function is PropertyAccess && - (function.propertyName.name == 'autoDispose' || - function.propertyName.name == 'family'); - } -} - -extension on MethodDeclaration { - bool? get isProviderCreation { - final isBuildMethod = name.lexeme == 'build'; - final interface = declaredElement?.enclosingElement; - if (interface == null) { - return null; - } - return isBuildMethod && _codegenNotifier.isAssignableFrom(interface); - } -} - -extension on ClassDeclaration { - bool? get isProviderCreation { - final interface = declaredElement; - if (interface == null) { - return null; - } - return _codegenNotifier.isAssignableFrom(interface); - } -} - -extension on FunctionDeclaration { - bool? get isProviderCreation { - final annotation = metadata.firstWhereOrNull( - (a) => a.name.name == 'riverpod' || a.constructorName?.name == 'Riverpod', - ); - return annotation == null ? null : true; - } -} - -extension on AstNode { - bool? get isWidgetBuild { - final expr = this; - if (expr is FunctionExpression) { - return (this as FunctionExpression).isWidgetBuilder; - } - if (expr is MethodDeclaration) { - if (expr.name.lexeme != 'build') { - return false; - } - - final classElement = expr.parents - .whereType() - .firstOrNull - ?.declaredElement; - - if (classElement == null) return null; - return _consumerWidget.isAssignableFrom(classElement) || - _consumerState.isAssignableFrom(classElement); - } - return null; - } - - bool? isBuild({bool hasFoundFunctionExpression = false}) { - final node = this; - - if (node is FunctionExpression) { - if (hasFoundFunctionExpression) { - return false; - } - if (node.isWidgetBuilder ?? false) { - return true; - } - - return parent?.isBuild(hasFoundFunctionExpression: true); - } - if (node is InstanceCreationExpression) { - return node.isProviderCreation; - } - if (node is FunctionExpressionInvocation) { - return node.isProviderCreation; - } - if (node is FunctionDeclaration) { - return node.isProviderCreation; - } - if (node is MethodDeclaration) { - if (node.isProviderCreation ?? false) { - return true; - } - if (hasFoundFunctionExpression || node.name.lexeme != 'build') { - return false; - } - - final classElement = node.parents - .whereType() - .firstOrNull - ?.declaredElement; - - if (classElement == null) return null; - return _consumerWidget.isAssignableFrom(classElement) || - _consumerState.isAssignableFrom(classElement); - } - return parent?.isBuild( - hasFoundFunctionExpression: hasFoundFunctionExpression, - ); - } - - bool? get inBuild { - final inBuild = parent?.isBuild(); - if (inBuild ?? false) { - return inBuild; - } - return inBuild; - } - - bool? get isInitState { - final expr = this; - if (expr is MethodDeclaration) { - if (expr.name.lexeme != 'initState') { - return false; - } - - final classElement = expr.parents - .whereType() - .firstOrNull - ?.declaredElement; - - if (classElement == null) return null; - return _consumerState.isAssignableFrom(classElement); - } - return null; - } -} - -extension on FunctionExpression { - /// Null if unknown - bool? get isWidgetBuilder { - final returnType = declaredElement?.returnType.element; - if (returnType == null) return null; - - return _widget.isAssignableFrom(returnType); - } -} - -extension on InstanceCreationExpression { - /// Null if unknown - bool? get isProviderCreation { - final type = staticType?.element; - if (type == null) return null; - - return _providerOrFamily.isAssignableFrom(type); - } -} - -extension on Expression { - // ref.watch(a.notifier).state = ''; - bool? get isMutation { - final expr = this; - if (expr is AssignmentExpression) { - final left = expr.leftHandSide; - if (left is! PropertyAccess || left.propertyName.name != 'state') { - return null; - } - final targ = left.target; - if (targ is! MethodInvocation) { - return null; - } - final methodTarget = targ.methodName.staticElement?.enclosingElement; - if (methodTarget == null || methodTarget is! InterfaceElement) { - return null; - } - if (_ref.isAssignableFromType(methodTarget.thisType) || - _widgetRef.isAssignableFromType(methodTarget.thisType)) { - // TODO: Synchronous listen - if (targ.methodName.name == 'watch' || targ.methodName.name == 'read') { - return true; - } - } - return false; - } else if (expr is MethodInvocation) { - if (expr.methodName.name == 'refresh' || - expr.methodName.name == 'invalidate' || - expr.methodName.name == 'invalidateSelf') { - final methodTarget = expr.methodName.staticElement?.enclosingElement; - if (methodTarget == null || methodTarget is! InterfaceElement) { - return null; - } - if (_ref.isAssignableFromType(methodTarget.thisType) || - _widgetRef.isAssignableFromType(methodTarget.thisType)) { - return true; - } else { - return false; - } - } else { - return false; - } - } - return null; - } -} diff --git a/packages/riverpod_lint/lib/src/lints/avoid_global_provider_container.dart b/packages/riverpod_lint/lib/src/lints/avoid_global_provider_container.dart index 870acd593..f57e352ed 100644 --- a/packages/riverpod_lint/lib/src/lints/avoid_global_provider_container.dart +++ b/packages/riverpod_lint/lib/src/lints/avoid_global_provider_container.dart @@ -17,6 +17,7 @@ class AvoidGlobalProviderContainer extends DartLintRule { ErrorReporter reporter, CustomLintContext context, ) { + // TODO release or delete context.registry.addInstanceCreationExpression((node) { // If there is a parameterElement it means we are not declaring a variable if (node.staticParameterElement != null) return; diff --git a/packages/riverpod_lint/lib/src/lints/avoid_read_auto_dispose.dart b/packages/riverpod_lint/lib/src/lints/avoid_read_auto_dispose.dart index 28f1de5bc..c2d9d6259 100644 --- a/packages/riverpod_lint/lib/src/lints/avoid_read_auto_dispose.dart +++ b/packages/riverpod_lint/lib/src/lints/avoid_read_auto_dispose.dart @@ -23,6 +23,7 @@ Then dispose of the listener when you no longer need the autoDispose provider to ErrorReporter reporter, CustomLintContext context, ) { + // TODO release or delete riverpodRegistry(context).addRefReadInvocation((read) { final provider = read.provider.providerElement; diff --git a/packages/riverpod_lint/lib/src/lints/prefer_final_provider.dart b/packages/riverpod_lint/lib/src/lints/prefer_final_provider.dart deleted file mode 100644 index ac414e684..000000000 --- a/packages/riverpod_lint/lib/src/lints/prefer_final_provider.dart +++ /dev/null @@ -1,26 +0,0 @@ -import 'package:analyzer/error/listener.dart'; -import 'package:custom_lint_builder/custom_lint_builder.dart'; - -import '../riverpod_custom_lint.dart'; - -class PreferFinalProvider extends RiverpodLintRule { - const PreferFinalProvider() : super(code: _code); - - static const _code = LintCode( - name: 'prefer_final_provider', - problemMessage: 'Providers should be declared as final variables', - ); - - @override - void run( - CustomLintResolver resolver, - ErrorReporter reporter, - CustomLintContext context, - ) { - riverpodRegistry(context).addLegacyProviderDeclaration((provider) { - if (!provider.node.isFinal) { - reporter.reportErrorForNode(_code, provider.node); - } - }); - } -} From b450246177c5ef1c5d1bfb7378cc94eaddc5cf1e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 11 Feb 2024 10:18:26 +0100 Subject: [PATCH 217/387] Ignore codegen in riverpod_syntax_error --- packages/riverpod_lint_flutter_test/build.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/riverpod_lint_flutter_test/build.yaml b/packages/riverpod_lint_flutter_test/build.yaml index 7e00739e5..cf95fd7da 100644 --- a/packages/riverpod_lint_flutter_test/build.yaml +++ b/packages/riverpod_lint_flutter_test/build.yaml @@ -7,4 +7,5 @@ targets: # Those files voluntarily have the generation fail - test/lints/notifier_build/notifier_build.dart - test/lints/notifier_build/fix/notifier_build.dart + - test/lints/riverpod_syntax_error/riverpod_syntax_error.dart - test/lints/functional_ref/failing_functional_ref.dart From 594237cef7533f3a27eab6f227903e3f722bf2ca Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 11 Feb 2024 10:24:07 +0100 Subject: [PATCH 218/387] Make some lints warnings --- .../lib/src/lints/avoid_build_context_in_providers.dart | 3 +-- .../lib/src/lints/avoid_ref_inside_state_dispose.dart | 3 +++ packages/riverpod_lint/lib/src/lints/functional_ref.dart | 2 ++ .../riverpod_lint/lib/src/lints/missing_provider_scope.dart | 2 ++ packages/riverpod_lint/lib/src/lints/notifier_extends.dart | 2 ++ .../riverpod_lint/lib/src/lints/provider_dependencies.dart | 2 ++ packages/riverpod_lint/lib/src/lints/provider_parameters.dart | 3 +++ .../lints/scoped_providers_should_specify_dependencies.dart | 3 +++ 8 files changed, 18 insertions(+), 2 deletions(-) diff --git a/packages/riverpod_lint/lib/src/lints/avoid_build_context_in_providers.dart b/packages/riverpod_lint/lib/src/lints/avoid_build_context_in_providers.dart index 5d5b9edda..9734e72cb 100644 --- a/packages/riverpod_lint/lib/src/lints/avoid_build_context_in_providers.dart +++ b/packages/riverpod_lint/lib/src/lints/avoid_build_context_in_providers.dart @@ -1,5 +1,4 @@ import 'package:analyzer/dart/ast/ast.dart'; -import 'package:analyzer/error/error.dart'; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; @@ -17,7 +16,7 @@ class AvoidBuildContextInProviders extends RiverpodLintRule { name: 'avoid_build_context_in_providers', problemMessage: 'Passing BuildContext to providers indicates mixing UI with the business logic.', - errorSeverity: ErrorSeverity.WARNING, + // TODO changelog: avoid_build_context_in_providers is now an INFO ); @override diff --git a/packages/riverpod_lint/lib/src/lints/avoid_ref_inside_state_dispose.dart b/packages/riverpod_lint/lib/src/lints/avoid_ref_inside_state_dispose.dart index 6b80eeaf4..6f0a3c1dc 100644 --- a/packages/riverpod_lint/lib/src/lints/avoid_ref_inside_state_dispose.dart +++ b/packages/riverpod_lint/lib/src/lints/avoid_ref_inside_state_dispose.dart @@ -1,4 +1,5 @@ import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/error/error.dart'; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; @@ -13,6 +14,8 @@ class AvoidRefInsideStateDispose extends RiverpodLintRule { static const _code = LintCode( name: 'avoid_ref_inside_state_dispose', problemMessage: "Avoid using 'Ref' inside State.dispose.", + // TODO changelog: avoid_ref_inside_state_dispose is now a WARNING + errorSeverity: ErrorSeverity.WARNING, ); @override diff --git a/packages/riverpod_lint/lib/src/lints/functional_ref.dart b/packages/riverpod_lint/lib/src/lints/functional_ref.dart index 97617878c..1ab716fb6 100644 --- a/packages/riverpod_lint/lib/src/lints/functional_ref.dart +++ b/packages/riverpod_lint/lib/src/lints/functional_ref.dart @@ -14,6 +14,8 @@ class FunctionalRef extends RiverpodLintRule { name: 'functional_ref', problemMessage: 'Functional providers must receive a ref matching the provider name as their first positional parameter.', + // TODO changelog: functional_ref is now a WARNING + errorSeverity: ErrorSeverity.WARNING, ); @override diff --git a/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart b/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart index bab6da2b0..5a30b0d78 100644 --- a/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart +++ b/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart @@ -15,6 +15,8 @@ class MissingProviderScope extends DartLintRule { name: 'missing_provider_scope', problemMessage: 'Flutter applications should have a ProviderScope widget ' 'at the top of the widget tree.', + // TODO changelog: missing_provider_scope is now a WARNING + errorSeverity: ErrorSeverity.WARNING, ); @override diff --git a/packages/riverpod_lint/lib/src/lints/notifier_extends.dart b/packages/riverpod_lint/lib/src/lints/notifier_extends.dart index 535dc3e29..a99e0da6b 100644 --- a/packages/riverpod_lint/lib/src/lints/notifier_extends.dart +++ b/packages/riverpod_lint/lib/src/lints/notifier_extends.dart @@ -53,6 +53,8 @@ class NotifierExtends extends RiverpodLintRule { static const _code = LintCode( name: 'notifier_extends', problemMessage: r'Classes annotated by @riverpod must extend _$ClassName', + // TODO changelog: notifier_extends is now a WARNING. + errorSeverity: ErrorSeverity.WARNING, ); @override diff --git a/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart b/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart index 51e4bfdae..ae090aa0c 100644 --- a/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart +++ b/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart @@ -69,6 +69,8 @@ class ProviderDependencies extends RiverpodLintRule { problemMessage: 'If a provider depends on providers which specify "dependencies", ' 'they should themselves specify "dependencies" and include all the scoped providers. ', + // TODO changelog: provider_dependencies is now a WARNING + errorSeverity: ErrorSeverity.WARNING, ); @override diff --git a/packages/riverpod_lint/lib/src/lints/provider_parameters.dart b/packages/riverpod_lint/lib/src/lints/provider_parameters.dart index 8238d09ae..821ddb6b9 100644 --- a/packages/riverpod_lint/lib/src/lints/provider_parameters.dart +++ b/packages/riverpod_lint/lib/src/lints/provider_parameters.dart @@ -1,5 +1,6 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/dart/element/element.dart'; +import 'package:analyzer/error/error.dart'; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; @@ -15,6 +16,8 @@ class ProviderParameters extends RiverpodLintRule { 'Meaning either the values should be cached, or the parameters should override ==', url: 'https://riverpod.dev/docs/concepts/modifiers/family#passing-multiple-parameters-to-a-family', + // TODO changelog: provider_parameters is now a WARNING + errorSeverity: ErrorSeverity.WARNING, ); @override diff --git a/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart b/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart index fdb891afd..cd5b0504b 100644 --- a/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart +++ b/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart @@ -1,4 +1,5 @@ import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/error/error.dart'; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; @@ -38,6 +39,8 @@ class ScopedProvidersShouldSpecifyDependencies extends RiverpodLintRule { name: 'scoped_providers_should_specify_dependencies', problemMessage: 'Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies.', + // TODO changelog: scoped_providers_should_specify_dependencies is now a WARNING + errorSeverity: ErrorSeverity.WARNING, ); @override From 55dab0ce1a5844e0ec2edcb849a27554ae571c54 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 11 Feb 2024 10:49:26 +0100 Subject: [PATCH 219/387] Add avoid_keep_alive_dependency_inside_auto_dispose --- packages/riverpod_lint/README.md | 21 ++ packages/riverpod_lint/lib/riverpod_lint.dart | 2 + ...only_use_keep_alive_inside_keep_alive.dart | 44 +++ ...only_use_keep_alive_inside_keep_alive.dart | 32 ++ ...ly_use_keep_alive_inside_keep_alive.g.dart | 328 ++++++++++++++++++ .../lints/protected_notifier_properties.dart | 1 + 6 files changed, 428 insertions(+) create mode 100644 packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart diff --git a/packages/riverpod_lint/README.md b/packages/riverpod_lint/README.md index c68031bc1..a9818a966 100644 --- a/packages/riverpod_lint/README.md +++ b/packages/riverpod_lint/README.md @@ -51,6 +51,7 @@ Riverpod_lint adds various warnings with quick fixes and refactoring options, su - [functional\_ref (riverpod\_generator only)](#functional_ref-riverpod_generator-only) - [notifier\_extends (riverpod\_generator only)](#notifier_extends-riverpod_generator-only) - [avoid\_ref\_inside\_state\_dispose](#avoid_ref_inside_state_dispose) + - [avoid\_keep\_alive\_dependency\_inside\_auto\_dispose (riverpod\_generator only)](#avoid_keep_alive_dependency_inside_auto_dispose-riverpod_generator-only) - [notifier\_build (riverpod\_generator only)](#notifier_build-riverpod_generator-only) - [riverpod\_syntax\_error (riverpod\_generator only)](#riverpod_syntax_error-riverpod_generator-only) - [async\_value\_nullable\_patttern](#async_value_nullable_patttern) @@ -589,6 +590,26 @@ class _MyWidgetState extends ConsumerState { } ``` +### avoid_keep_alive_dependency_inside_auto_dispose (riverpod_generator only) + +Warn when a `keepAlive` provider tries to use a non-`keepAlive` provider. + +This is discouraged because such relationship would cause the non-`keepAlive` provider +to behave as a `keepAlive`, even though it isn't marked as such. + +**Bad**: + +```dart +@riverpod +int nonKeepAlive(NonKeepAliveRef ref) => 0; + +@Riverpod(keepAlive: true) +int fn(FnRef ref) { + // `keepAlive` providers should only depend on keepAlive providers. + ref.watch(nonKeepAliveProvider); +} +``` + ### notifier_build (riverpod_generator only) Classes annotated by `@riverpod` must have the `build` method. diff --git a/packages/riverpod_lint/lib/riverpod_lint.dart b/packages/riverpod_lint/lib/riverpod_lint.dart index 7ae810a17..3ba8a0149 100644 --- a/packages/riverpod_lint/lib/riverpod_lint.dart +++ b/packages/riverpod_lint/lib/riverpod_lint.dart @@ -16,6 +16,7 @@ import 'src/lints/functional_ref.dart'; import 'src/lints/missing_provider_scope.dart'; import 'src/lints/notifier_build.dart'; import 'src/lints/notifier_extends.dart'; +import 'src/lints/only_use_keep_alive_inside_keep_alive.dart'; import 'src/lints/protected_notifier_properties.dart'; import 'src/lints/provider_dependencies.dart'; import 'src/lints/provider_parameters.dart'; @@ -30,6 +31,7 @@ class _RiverpodPlugin extends PluginBase { List getLintRules(CustomLintConfigs configs) => [ const AsyncValueNullablePattern(), const AvoidBuildContextInProviders(), + const OnlyUseKeepAliveInsideKeepAlive(), const AvoidManualProvidersAsGeneratedProviderDependency(), const AvoidPublicNotifierProperties(), const AvoidRefInsideStateDispose(), diff --git a/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart b/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart new file mode 100644 index 000000000..ae0565027 --- /dev/null +++ b/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart @@ -0,0 +1,44 @@ +import 'package:analyzer/error/error.dart'; +import 'package:analyzer/error/listener.dart'; +import 'package:custom_lint_builder/custom_lint_builder.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; + +import '../riverpod_custom_lint.dart'; + +class OnlyUseKeepAliveInsideKeepAlive extends RiverpodLintRule { + const OnlyUseKeepAliveInsideKeepAlive() : super(code: _code); + + // TODO changelog added avoid_keep_alive_dependency_inside_auto_dispose + static const _code = LintCode( + name: 'only_use_keep_alive_inside_keep_alive', + problemMessage: 'If a provider is declared as `keepAlive`, ' + 'it can only use providers that are also declared as `keepAlive.', + correctionMessage: 'Either stop marking this provider as `keepAlive` or ' + 'remove `keepAlive` from the used provider.', + errorSeverity: ErrorSeverity.WARNING, + ); + + @override + void run( + CustomLintResolver resolver, + ErrorReporter reporter, + CustomLintContext context, + ) { + riverpodRegistry(context).addGeneratorProviderDeclaration((node) { + // The current provider is "autoDispose", so it is allowed to use other "autoDispose" providers + if (node.providerElement.isAutoDispose) return; + + for (final refInvocation in node.refInvocations) { + switch (refInvocation) { + case RefDependencyInvocation( + provider: ProviderListenableExpression( + :final GeneratorProviderDeclarationElement providerElement, + ) + ) + when providerElement.isAutoDispose: + reporter.reportErrorForNode(_code, refInvocation.node); + } + } + }); + } +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.dart b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.dart new file mode 100644 index 000000000..8e0fe9892 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.dart @@ -0,0 +1,32 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'only_use_keep_alive_inside_keep_alive.g.dart'; + +@Riverpod(keepAlive: true) +int keepAlive(KeepAliveRef ref) => 42; + +@Riverpod(keepAlive: true) +class KeepAliveClass extends _$KeepAliveClass { + int build() => 0; +} + +@riverpod +int autoDispose(AutoDisposeRef ref) => 42; + +@riverpod +class AutoDisposeClass extends _$AutoDisposeClass { + int build() => 0; +} + +@Riverpod(keepAlive: true) +int fn(FnRef ref) { + ref.watch(keepAliveProvider); + ref.watch(keepAliveClassProvider); + + // expect_lint: only_use_keep_alive_inside_keep_alive + ref.watch(autoDisposeProvider); + // expect_lint: only_use_keep_alive_inside_keep_alive + ref.watch(autoDisposeClassProvider); + + return 0; +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart new file mode 100644 index 000000000..b0efa12ef --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart @@ -0,0 +1,328 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'only_use_keep_alive_inside_keep_alive.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef KeepAliveRef = Ref; + +@ProviderFor(keepAlive) +const keepAliveProvider = KeepAliveProvider._(); + +final class KeepAliveProvider + extends $FunctionalProvider + with $Provider { + const KeepAliveProvider._( + {int Function( + KeepAliveRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'keepAliveProvider', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + KeepAliveRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$keepAliveHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + KeepAliveProvider $copyWithCreate( + int Function( + KeepAliveRef ref, + ) create, + ) { + return KeepAliveProvider._(create: create); + } + + @override + int create(KeepAliveRef ref) { + final _$cb = _createCb ?? keepAlive; + return _$cb(ref); + } +} + +String _$keepAliveHash() => r'756ceaba79af550d4498a93ec30118f989cd5bb4'; + +typedef AutoDisposeRef = Ref; + +@ProviderFor(autoDispose) +const autoDisposeProvider = AutoDisposeProvider._(); + +final class AutoDisposeProvider + extends $FunctionalProvider + with $Provider { + const AutoDisposeProvider._( + {int Function( + AutoDisposeRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'autoDisposeProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + AutoDisposeRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$autoDisposeHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + AutoDisposeProvider $copyWithCreate( + int Function( + AutoDisposeRef ref, + ) create, + ) { + return AutoDisposeProvider._(create: create); + } + + @override + int create(AutoDisposeRef ref) { + final _$cb = _createCb ?? autoDispose; + return _$cb(ref); + } +} + +String _$autoDisposeHash() => r'd46d894171aed556a8b4deafeda4de6b9465f632'; + +typedef FnRef = Ref; + +@ProviderFor(fn) +const fnProvider = FnProvider._(); + +final class FnProvider extends $FunctionalProvider + with $Provider { + const FnProvider._( + {int Function( + FnRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'fnProvider', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + FnRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$fnHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FnProvider $copyWithCreate( + int Function( + FnRef ref, + ) create, + ) { + return FnProvider._(create: create); + } + + @override + int create(FnRef ref) { + final _$cb = _createCb ?? fn; + return _$cb(ref); + } +} + +String _$fnHash() => r'9e89e9bead8aa30a86f31bd16f4106c4b38e8f2b'; + +@ProviderFor(KeepAliveClass) +const keepAliveClassProvider = KeepAliveClassProvider._(); + +final class KeepAliveClassProvider + extends $NotifierProvider { + const KeepAliveClassProvider._( + {super.runNotifierBuildOverride, KeepAliveClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'keepAliveClassProvider', + isAutoDispose: false, + dependencies: null, + allTransitiveDependencies: null, + ); + + final KeepAliveClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$keepAliveClassHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + KeepAliveClass create() => _createCb?.call() ?? KeepAliveClass(); + + @$internal + @override + KeepAliveClassProvider $copyWithCreate( + KeepAliveClass Function() create, + ) { + return KeepAliveClassProvider._(create: create); + } + + @$internal + @override + KeepAliveClassProvider $copyWithBuild( + int Function( + Ref, + KeepAliveClass, + ) build, + ) { + return KeepAliveClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$keepAliveClassHash() => r'e2fffa4d14837dfef71f6a2cc230b826b82541ea'; + +abstract class _$KeepAliveClass extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +@ProviderFor(AutoDisposeClass) +const autoDisposeClassProvider = AutoDisposeClassProvider._(); + +final class AutoDisposeClassProvider + extends $NotifierProvider { + const AutoDisposeClassProvider._( + {super.runNotifierBuildOverride, AutoDisposeClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'autoDisposeClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final AutoDisposeClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$autoDisposeClassHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + AutoDisposeClass create() => _createCb?.call() ?? AutoDisposeClass(); + + @$internal + @override + AutoDisposeClassProvider $copyWithCreate( + AutoDisposeClass Function() create, + ) { + return AutoDisposeClassProvider._(create: create); + } + + @$internal + @override + AutoDisposeClassProvider $copyWithBuild( + int Function( + Ref, + AutoDisposeClass, + ) build, + ) { + return AutoDisposeClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$autoDisposeClassHash() => r'5127ab94f7ab4ccf90deb3fca90d7a3c3c4c83f5'; + +abstract class _$AutoDisposeClass extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.dart index 5c06bafd5..471e9dc7d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.dart @@ -1,3 +1,4 @@ +// ignore_for_file: avoid_keep_alive_dependency_inside_auto_dispose import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'protected_notifier_properties.g.dart'; From 6dc06c1817abaee0d1696128ad9fe25e40d74429 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 11 Feb 2024 10:53:51 +0100 Subject: [PATCH 220/387] Fix lint --- .../test/lints/protected_notifier_properties.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.dart index 471e9dc7d..cc76321f9 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.dart @@ -1,4 +1,4 @@ -// ignore_for_file: avoid_keep_alive_dependency_inside_auto_dispose +// ignore_for_file: only_use_keep_alive_inside_keep_alive import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'protected_notifier_properties.g.dart'; From 7f762e752b5090d414c23eafe6a8560f71cde160 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 11 Feb 2024 12:00:47 +0100 Subject: [PATCH 221/387] Add automatic migration for missing legacy import (#3334) --- .../flutter_riverpod/test/consumer_test.dart | 2 +- packages/flutter_riverpod/test/utils.dart | 1 + packages/riverpod/lib/legacy.dart | 4 + packages/riverpod/lib/riverpod.dart | 4 - packages/riverpod/test/new/utils.dart | 1 + packages/riverpod/test/old/utils.dart | 1 + packages/riverpod_lint/README.md | 25 ++++- packages/riverpod_lint/lib/riverpod_lint.dart | 4 + .../src/migration/missing_legacy_import.dart | 106 ++++++++++++++++++ .../lints/unsupported_provider_value.dart | 1 + .../missing_legacy_import.dart | 24 ++++ .../missing_legacy_import.diff | 66 +++++++++++ .../missing_legacy_import_test.dart | 25 +++++ .../with_flutter_riverpod.dart | 18 +++ .../with_hooks_riverpod.dart | 18 +++ .../with_riverpod_import.dart | 18 +++ .../from_state_notifier/add_listener_old.dart | 1 - .../async_notifier_old.dart | 1 + .../from_state_notifier/build_init_old.dart | 1 - .../state_notifier_provider/todos.dart | 8 +- .../current/providers/provider/todo.dart | 1 - .../state_notifier_provider/todos.dart | 8 +- .../current/providers/provider/todo.dart | 1 - .../state_notifier_provider/todos.dart | 8 +- .../current/providers/provider/todo.dart | 1 - .../state_notifier_provider/todos.dart | 23 ++-- .../current/providers/provider/todo.dart | 1 - .../state_notifier_provider/todos.dart | 1 - .../from_state_notifier/add_listener_old.dart | 1 - .../async_notifier_old.dart | 1 + .../from_state_notifier/build_init_old.dart | 1 - .../state_notifier_provider/todos.dart | 1 - .../current/providers/provider/todo.dart | 1 - .../state_notifier_provider/todos.dart | 1 - .../from_state_notifier/add_listener_old.dart | 1 - .../async_notifier_old.dart | 1 + .../from_state_notifier/build_init_old.dart | 1 - .../state_notifier_provider/todos.dart | 1 - .../current/providers/provider/todo.dart | 1 - .../state_notifier_provider/todos.dart | 1 - .../from_state_notifier/add_listener_old.dart | 1 - .../async_notifier_old.dart | 1 + .../from_state_notifier/build_init_old.dart | 1 - .../state_notifier_provider/todos.dart | 1 - 44 files changed, 339 insertions(+), 50 deletions(-) create mode 100644 packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart create mode 100644 packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import.dart create mode 100644 packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import.diff create mode 100644 packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import_test.dart create mode 100644 packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_flutter_riverpod.dart create mode 100644 packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_hooks_riverpod.dart create mode 100644 packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_riverpod_import.dart diff --git a/packages/flutter_riverpod/test/consumer_test.dart b/packages/flutter_riverpod/test/consumer_test.dart index 05bdb2e83..be4da69fb 100644 --- a/packages/flutter_riverpod/test/consumer_test.dart +++ b/packages/flutter_riverpod/test/consumer_test.dart @@ -1,9 +1,9 @@ import 'dart:async'; import 'package:flutter/material.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/src/internals.dart'; import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod/legacy.dart'; import 'utils.dart'; diff --git a/packages/flutter_riverpod/test/utils.dart b/packages/flutter_riverpod/test/utils.dart index 41996fea7..477425ac6 100644 --- a/packages/flutter_riverpod/test/utils.dart +++ b/packages/flutter_riverpod/test/utils.dart @@ -2,6 +2,7 @@ import 'dart:async'; import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; class ErrorListener extends Mock { diff --git a/packages/riverpod/lib/legacy.dart b/packages/riverpod/lib/legacy.dart index 713b6fc19..091559090 100644 --- a/packages/riverpod/lib/legacy.dart +++ b/packages/riverpod/lib/legacy.dart @@ -1,4 +1,8 @@ // TODO add to flutter_riverpod and hooks_riverpod too +// TODO CHANGELOG breaking: Riverpod now only re-exports StateNotifier from pkg:state_notifier. +// for other classes, please add state_notifier as dependency. +export 'package:state_notifier/state_notifier.dart' show StateNotifier; + export 'src/providers/legacy/state_controller.dart'; export 'src/providers/legacy/state_notifier_provider.dart'; export 'src/providers/legacy/state_provider.dart'; diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 035a0ca3b..9ccd53780 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -1,7 +1,3 @@ -// TODO CHANGELOG breaking: Riverpod now only re-exports StateNotifier from pkg:state_notifier. -// for other classes, please add state_notifier as dependency. -export 'package:state_notifier/state_notifier.dart' show StateNotifier; - // TODO assert all provider variants have const constructors export 'src/core/async_value.dart' hide AsyncTransition; diff --git a/packages/riverpod/test/new/utils.dart b/packages/riverpod/test/new/utils.dart index 4b1a37f82..13c9e517b 100644 --- a/packages/riverpod/test/new/utils.dart +++ b/packages/riverpod/test/new/utils.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod/test/old/utils.dart b/packages/riverpod/test/old/utils.dart index 64a148cee..c29018eaf 100644 --- a/packages/riverpod/test/old/utils.dart +++ b/packages/riverpod/test/old/utils.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; diff --git a/packages/riverpod_lint/README.md b/packages/riverpod_lint/README.md index a9818a966..ce5b978f6 100644 --- a/packages/riverpod_lint/README.md +++ b/packages/riverpod_lint/README.md @@ -63,7 +63,8 @@ Riverpod_lint adds various warnings with quick fixes and refactoring options, su - [Convert widget to `ConsumerStatefulWidget`](#convert-widget-to-consumerstatefulwidget) - [Convert functional `@riverpod` to class variant](#convert-functional-riverpod-to-class-variant) - [Convert class `@riverpod` to functional variant](#convert-class-riverpod-to-functional-variant) -- [Upcoming content:](#upcoming-content) +- [Migrations](#migrations) + - [missing\_legacy\_import](#missing_legacy_import) ## Installing riverpod_lint @@ -771,12 +772,24 @@ class B extends _$B { ![Convert provider to functional variant sample](https://raw.githubusercontent.com/rrousselGit/riverpod/master/packages/riverpod_lint/resources/convert_to_functional_provider.gif) -## Upcoming content: +## Migrations -- Warn if a provider's `dependencies` parameter doesn't match the `ref.watch/read/listen` usages. -- Refactoring to convert AsyncNotifier<>Notifier + autoDispose/family variants -- Warn if an `AsyncNotifierProvider.autoDispose` doesn't use an `AutoDisposeAsyncNotifier` +Migrations are a list of warnings with an automatic quick-fix, to help +upgrading to higher Riverpod versions. +They are designed to be used only once. -and much more +As a general rule, it is recommended to apply migration by running the following +in your terminal: + +```sh +dart run custom_lint --fix +``` + +### missing_legacy_import + +As part of Riverpod 3.0, `StateProvider`, `StateNotifierProvider`, `StateNotifier` and `ChangeNotifierProvider` are moved out of `package:riverpod/riverpod.dart` to +`package:riverpod/riverpod.dart`. + +This migration will automatically adds the missing import. [custom_lint]: https://pub.dev/packages/custom_lint diff --git a/packages/riverpod_lint/lib/riverpod_lint.dart b/packages/riverpod_lint/lib/riverpod_lint.dart index 3ba8a0149..fa2753f74 100644 --- a/packages/riverpod_lint/lib/riverpod_lint.dart +++ b/packages/riverpod_lint/lib/riverpod_lint.dart @@ -23,6 +23,7 @@ import 'src/lints/provider_parameters.dart'; import 'src/lints/riverpod_syntax_error.dart'; import 'src/lints/scoped_providers_should_specify_dependencies.dart'; import 'src/lints/unsupported_provider_value.dart'; +import 'src/migration/missing_legacy_import.dart'; PluginBase createPlugin() => _RiverpodPlugin(); @@ -46,6 +47,9 @@ class _RiverpodPlugin extends PluginBase { const RiverpodSyntaxError(), const ScopedProvidersShouldSpecifyDependencies(), const UnsupportedProviderValue(), + + // Migrations + const MissingLegacyImport(), ]; @override diff --git a/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart b/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart new file mode 100644 index 000000000..4bc398c14 --- /dev/null +++ b/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart @@ -0,0 +1,106 @@ +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/element/type.dart'; +import 'package:analyzer/error/error.dart'; +import 'package:analyzer/error/listener.dart'; +import 'package:custom_lint_builder/custom_lint_builder.dart'; + +import '../riverpod_custom_lint.dart'; + +// TODO changelog added migration for missing import. +class MissingLegacyImport extends RiverpodLintRule { + const MissingLegacyImport() : super(code: _code); + + static const _code = LintCode( + name: 'missing_legacy_import', + problemMessage: + 'StateProvider/StateNotifierProvider/ChangeNotifierProvider/StateNotifier were used ' + 'without importing `package:flutter_riverpod/legacy.dart`.', + ); + + @override + void run( + CustomLintResolver resolver, + ErrorReporter reporter, + CustomLintContext context, + ) { + void handleType(AstNode node, DartType? type, String? name) { + // Skip resolved types. Even if the import is missing, + // chances are the import was indirectly imported. + if (type != null && type is! InvalidType) { + return; + } + + const legacyIdentifiers = [ + 'StateProvider', + 'StateNotifierProvider', + 'StateNotifier', + 'ChangeNotifierProvider', + ]; + + if (!legacyIdentifiers.contains(name)) return; + + final unit = node.thisOrAncestorOfType()!; + + final imports = unit.directives + .whereType() + .map((e) => e.uri.stringValue); + + final compatibleImports = [ + 'package:flutter_riverpod/legacy.dart', + 'package:hooks_riverpod/legacy.dart', + if (name != 'ChangeNotifierProvider') 'package:riverpod/legacy.dart', + ]; + + if (compatibleImports.any(imports.contains)) return; + + reporter.reportErrorForNode(_code, node); + } + + context.registry.addNamedType((node) { + handleType(node, node.type, node.name2.lexeme); + }); + + context.registry.addIdentifier((node) { + handleType(node, node.staticType, node.name); + }); + } + + @override + List getFixes() => [_AddMissingLegacyImport()]; +} + +class _AddMissingLegacyImport extends DartFix { + @override + void run( + CustomLintResolver resolver, + ChangeReporter reporter, + CustomLintContext context, + AnalysisError analysisError, + List others, + ) { + void handleType(AstNode node, String? name) { + if (!node.sourceRange.intersects(analysisError.sourceRange)) return; + + final toImport = name == 'ChangeNotifierProvider' + ? 'package:flutter_riverpod/legacy.dart' + : 'package:riverpod/legacy.dart'; + + final changeBuilder = reporter.createChangeBuilder( + message: 'Import "$toImport"', + priority: 100, + ); + + changeBuilder.addDartFileEdit((builder) { + builder.addSimpleInsertion(0, "import '$toImport';\n"); + }); + } + + context.registry.addIdentifier((node) { + handleType(node, node.name); + }); + + context.registry.addNamedType((node) { + handleType(node, node.name2.lexeme); + }); + } +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.dart index 597432c2e..2b09ef0ed 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.dart @@ -1,5 +1,6 @@ import 'package:flutter/foundation.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:hooks_riverpod/legacy.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'unsupported_provider_value.g.dart'; diff --git a/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import.dart b/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import.dart new file mode 100644 index 000000000..dd209c051 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import.dart @@ -0,0 +1,24 @@ +// ignore_for_file: unused_import + +import 'package:riverpod/riverpod.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +// ignore_for_file: undefined_function, undefined_identifier, extends_non_class, extra_positional_arguments + +// expect_lint: missing_legacy_import +final p = StateProvider((ref) => 0); + +// expect_lint: missing_legacy_import +final p2 = StateProvider.autoDispose((ref) => 0); + +// expect_lint: missing_legacy_import +final p3 = ChangeNotifierProvider((ref) => 0); + +// expect_lint: missing_legacy_import +final p4 = StateNotifierProvider((ref) => 0); + +// expect_lint: missing_legacy_import +class MyNotifier extends StateNotifier { + MyNotifier() : super(0); +} diff --git a/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import.diff b/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import.diff new file mode 100644 index 000000000..227a2abf9 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import.diff @@ -0,0 +1,66 @@ +Message: `Import "package:riverpod/legacy.dart"` +Priority: 100 +Diff for file `test/migration/missing_legacy_import/missing_legacy_import.dart:1`: +``` +- // ignore_for_file: unused_import ++ import 'package:riverpod/legacy.dart'; ++ // ignore_for_file: unused_import + +import 'package:riverpod/riverpod.dart'; +``` +--- +Message: `Import "package:riverpod/legacy.dart"` +Priority: 100 +Diff for file `test/migration/missing_legacy_import/missing_legacy_import.dart:1`: +``` +- // ignore_for_file: unused_import ++ import 'package:riverpod/legacy.dart'; ++ // ignore_for_file: unused_import + +import 'package:riverpod/riverpod.dart'; +``` +--- +Message: `Import "package:flutter_riverpod/legacy.dart"` +Priority: 100 +Diff for file `test/migration/missing_legacy_import/missing_legacy_import.dart:1`: +``` +- // ignore_for_file: unused_import ++ import 'package:flutter_riverpod/legacy.dart'; ++ // ignore_for_file: unused_import + +import 'package:riverpod/riverpod.dart'; +``` +--- +Message: `Import "package:riverpod/legacy.dart"` +Priority: 100 +Diff for file `test/migration/missing_legacy_import/missing_legacy_import.dart:1`: +``` +- // ignore_for_file: unused_import ++ import 'package:riverpod/legacy.dart'; ++ // ignore_for_file: unused_import + +import 'package:riverpod/riverpod.dart'; +``` +--- +Message: `Import "package:riverpod/legacy.dart"` +Priority: 100 +Diff for file `test/migration/missing_legacy_import/missing_legacy_import.dart:1`: +``` +- // ignore_for_file: unused_import ++ import 'package:riverpod/legacy.dart'; ++ // ignore_for_file: unused_import + +import 'package:riverpod/riverpod.dart'; +``` +--- +Message: `Import "package:riverpod/legacy.dart"` +Priority: 100 +Diff for file `test/migration/missing_legacy_import/missing_legacy_import.dart:1`: +``` +- // ignore_for_file: unused_import ++ import 'package:riverpod/legacy.dart'; ++ // ignore_for_file: unused_import + +import 'package:riverpod/riverpod.dart'; +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import_test.dart b/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import_test.dart new file mode 100644 index 000000000..a97b1181f --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import_test.dart @@ -0,0 +1,25 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod_lint/src/migration/missing_legacy_import.dart'; + +import '../../golden.dart'; + +void main() { + testGolden( + 'Verify that `riverpod/legacy.dart` is correctly imported.', + 'migration/missing_legacy_import/missing_legacy_import.diff', + sourcePath: + 'test/migration/missing_legacy_import/missing_legacy_import.dart', + (result) async { + final lint = MissingLegacyImport(); + final fix = lint.getFixes().single; + + final errors = await lint.testRun(result); + + final changes = await Future.wait([ + for (final error in errors) fix.testRun(result, error, errors), + ]); + + return changes.flattened; + }, + ); +} diff --git a/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_flutter_riverpod.dart b/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_flutter_riverpod.dart new file mode 100644 index 000000000..79cf23ed8 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_flutter_riverpod.dart @@ -0,0 +1,18 @@ +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +final p = StateProvider((ref) => 0); + +final p2 = StateProvider.autoDispose((ref) => 0); + +final p3 = ChangeNotifierProvider>((ref) { + throw UnimplementedError(); +}); + +final p4 = StateNotifierProvider, int>((ref) { + throw UnimplementedError(); +}); + +class MyNotifier extends StateNotifier { + MyNotifier() : super(0); +} diff --git a/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_hooks_riverpod.dart b/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_hooks_riverpod.dart new file mode 100644 index 000000000..98ddff515 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_hooks_riverpod.dart @@ -0,0 +1,18 @@ +import 'package:flutter/foundation.dart'; +import 'package:hooks_riverpod/legacy.dart'; + +final p = StateProvider((ref) => 0); + +final p2 = StateProvider.autoDispose((ref) => 0); + +final p3 = ChangeNotifierProvider>((ref) { + throw UnimplementedError(); +}); + +final p4 = StateNotifierProvider, int>((ref) { + throw UnimplementedError(); +}); + +class MyNotifier extends StateNotifier { + MyNotifier() : super(0); +} diff --git a/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_riverpod_import.dart b/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_riverpod_import.dart new file mode 100644 index 000000000..dc0b9e879 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_riverpod_import.dart @@ -0,0 +1,18 @@ +import 'package:riverpod/legacy.dart'; + +// ignore_for_file: undefined_function, undefined_identifier + +final p = StateProvider((ref) => 0); + +final p2 = StateProvider.autoDispose((ref) => 0); + +// expect_lint: missing_legacy_import +final p3 = ChangeNotifierProvider((ref) => 0); + +final p4 = StateNotifierProvider, int>((ref) { + throw UnimplementedError(); +}); + +class MyNotifier extends StateNotifier { + MyNotifier() : super(0); +} diff --git a/website/docs/migration/from_state_notifier/add_listener_old.dart b/website/docs/migration/from_state_notifier/add_listener_old.dart index 39a173d8c..22dfd7f61 100644 --- a/website/docs/migration/from_state_notifier/add_listener_old.dart +++ b/website/docs/migration/from_state_notifier/add_listener_old.dart @@ -1,7 +1,6 @@ // ignore_for_file: avoid_print import 'package:flutter/material.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/docs/migration/from_state_notifier/async_notifier_old.dart b/website/docs/migration/from_state_notifier/async_notifier_old.dart index 50d7f4aed..01e4ec6e9 100644 --- a/website/docs/migration/from_state_notifier/async_notifier_old.dart +++ b/website/docs/migration/from_state_notifier/async_notifier_old.dart @@ -1,5 +1,6 @@ // ignore_for_file: avoid_print, avoid_unused_constructor_parameters +import 'package:flutter_riverpod/legacy.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; class Todo { diff --git a/website/docs/migration/from_state_notifier/build_init_old.dart b/website/docs/migration/from_state_notifier/build_init_old.dart index 034b059ec..1f5bff1ef 100644 --- a/website/docs/migration/from_state_notifier/build_init_old.dart +++ b/website/docs/migration/from_state_notifier/build_init_old.dart @@ -1,5 +1,4 @@ import 'package:flutter_riverpod/legacy.dart'; -import 'package:hooks_riverpod/hooks_riverpod.dart'; /* SNIPPET START */ class CounterNotifier extends StateNotifier { diff --git a/website/docs/providers/state_notifier_provider/todos.dart b/website/docs/providers/state_notifier_provider/todos.dart index b0bf6db9f..f39051948 100644 --- a/website/docs/providers/state_notifier_provider/todos.dart +++ b/website/docs/providers/state_notifier_provider/todos.dart @@ -1,5 +1,4 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ @@ -8,8 +7,11 @@ import 'package:flutter_riverpod/legacy.dart'; // We could also use packages like Freezed to help with the implementation. @immutable class Todo { - const Todo( - {required this.id, required this.description, required this.completed,}); + const Todo({ + required this.id, + required this.description, + required this.completed, + }); // All properties should be `final` on our class. final String id; diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/todo.dart index 69923c0f9..927f2883c 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/provider/todo.dart @@ -1,6 +1,5 @@ // ignore_for_file: avoid_positional_boolean_parameters -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 69ca1eaf9..30db1bd39 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,4 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ @@ -8,8 +7,11 @@ import 'package:flutter_riverpod/legacy.dart'; // বাস্তবায়নে সাহায্য করার জন্য আমরা Freezed-এর মতো প্যাকেজগুলিও ব্যবহার করতে পারি। @immutable class Todo { - const Todo( - {required this.id, required this.description, required this.completed,}); + const Todo({ + required this.id, + required this.description, + required this.completed, + }); // সমস্ত বৈশিষ্ট্য আমাদের ক্লাসে 'final' হওয়া উচিত। final String id; diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/todo.dart index 69923c0f9..927f2883c 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/provider/todo.dart @@ -1,6 +1,5 @@ // ignore_for_file: avoid_positional_boolean_parameters -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 765def566..be7c92fa1 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,4 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ @@ -8,8 +7,11 @@ import 'package:flutter_riverpod/legacy.dart'; // Wir könnten auch Pakete wie Freezed verwenden, um bei der Implementierung zu helfen. @immutable class Todo { - const Todo( - {required this.id, required this.description, required this.completed,}); + const Todo({ + required this.id, + required this.description, + required this.completed, + }); // Alle variablen in unserer Klasse sollten `final` sein. final String id; diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/todo.dart index 9adb03185..b296e2fde 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/provider/todo.dart @@ -1,6 +1,5 @@ // ignore_for_file: avoid_positional_boolean_parameters -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 22d3437df..1c3e04f4a 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,4 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ @@ -8,14 +7,18 @@ import 'package:flutter_riverpod/legacy.dart'; // También podríamos usar paquetes como Freezed para ayudar con la implementación. @immutable class Todo { - const Todo({required this.id, required this.description, required this.completed}); + const Todo({ + required this.id, + required this.description, + required this.completed, + }); // Todas las propiedades deben ser `final` en nuestra clase. final String id; final String description; final bool completed; - // Como `Todo` es inmutable, implementamos un método que permite clonar el + // Como `Todo` es inmutable, implementamos un método que permite clonar el // `Todo` con un contenido ligeramente diferente. Todo copyWith({String? id, String? description, bool? completed}) { return Todo( @@ -27,17 +30,17 @@ class Todo { } // La clase StateNotifier que se pasará a nuestro StateNotifierProvider. -// Esta clase no debe exponer el estado fuera de su propiedad "estado", lo que significa +// Esta clase no debe exponer el estado fuera de su propiedad "estado", lo que significa // ¡sin getters/propiedades públicas! // Los métodos públicos en esta clase serán los que permitirán // que la interfaz de usuario modifique el estado. class TodosNotifier extends StateNotifier> { // Inicializamos la lista de `todos` como una lista vacía - TodosNotifier(): super([]); + TodosNotifier() : super([]); // Permitamos que la interfaz de usuario agregue todos. void addTodo(Todo todo) { - // Ya que nuestro estado es inmutable, no podemos hacer `state.add(todo)`. + // Ya que nuestro estado es inmutable, no podemos hacer `state.add(todo)`. // En su lugar, debemos crear una nueva lista de todos que contenga la anterior // elementos y el nuevo. // ¡Usar el spread operator de Dart aquí es útil! @@ -48,7 +51,7 @@ class TodosNotifier extends StateNotifier> { // Permitamos eliminar `todos` void removeTodo(String todoId) { - // Nuevamente, nuestro estado es inmutable. Así que estamos haciendo + // Nuevamente, nuestro estado es inmutable. Así que estamos haciendo // una nueva lista en lugar de cambiar la lista existente. state = [ for (final todo in state) @@ -62,8 +65,8 @@ class TodosNotifier extends StateNotifier> { for (final todo in state) // Estamos marcando solo el `todo` coincidente como completada if (todo.id == todoId) - // Una vez más, dado que nuestro estado es inmutable, necesitamos hacer una copia - // del `todo`. Estamos usando nuestro método `copyWith` implementado antes + // Una vez más, dado que nuestro estado es inmutable, necesitamos hacer una copia + // del `todo`. Estamos usando nuestro método `copyWith` implementado antes // para ayudar con eso. todo.copyWith(completed: !todo.completed) else @@ -73,7 +76,7 @@ class TodosNotifier extends StateNotifier> { } } -// Finalmente, estamos usando StateNotifierProvider para permitir que la +// Finalmente, estamos usando StateNotifierProvider para permitir que la // interfaz de usuario interactúe con nuestra clase TodosNotifier. final todosProvider = StateNotifierProvider>((ref) { return TodosNotifier(); diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/todo.dart index 5c17c4682..6c5f0bd4a 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/provider/todo.dart @@ -1,6 +1,5 @@ // ignore_for_file: avoid_positional_boolean_parameters -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 744882fa8..59457f9d7 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,4 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart index 4ed97aa79..013cf894a 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart @@ -1,7 +1,6 @@ // ignore_for_file: avoid_print import 'package:flutter/material.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart index 50d7f4aed..01e4ec6e9 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart @@ -1,5 +1,6 @@ // ignore_for_file: avoid_print, avoid_unused_constructor_parameters +import 'package:flutter_riverpod/legacy.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; class Todo { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart index 034b059ec..1f5bff1ef 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart @@ -1,5 +1,4 @@ import 'package:flutter_riverpod/legacy.dart'; -import 'package:hooks_riverpod/hooks_riverpod.dart'; /* SNIPPET START */ class CounterNotifier extends StateNotifier { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index f9484516e..f39051948 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,4 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/todo.dart index 37aaf7241..f6c7ecfc3 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/provider/todo.dart @@ -1,6 +1,5 @@ // ignore_for_file: avoid_positional_boolean_parameters -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index 991bc53d1..f34724966 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,4 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart index edb25b5b6..8534a73c9 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart @@ -1,7 +1,6 @@ // ignore_for_file: avoid_print import 'package:flutter/material.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart index 50d7f4aed..01e4ec6e9 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart @@ -1,5 +1,6 @@ // ignore_for_file: avoid_print, avoid_unused_constructor_parameters +import 'package:flutter_riverpod/legacy.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; class Todo { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart index 034b059ec..1f5bff1ef 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart @@ -1,5 +1,4 @@ import 'package:flutter_riverpod/legacy.dart'; -import 'package:hooks_riverpod/hooks_riverpod.dart'; /* SNIPPET START */ class CounterNotifier extends StateNotifier { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index f9484516e..f39051948 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,4 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/todo.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/todo.dart index 4da01abb1..6073fa5fd 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/todo.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/provider/todo.dart @@ -1,6 +1,5 @@ // ignore_for_file: avoid_positional_boolean_parameters -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index e10ef0d43..679c57dbd 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,4 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart index 9354e1893..783e9eecd 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/add_listener_old.dart @@ -1,7 +1,6 @@ // ignore_for_file: avoid_print import 'package:flutter/material.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart index 50d7f4aed..01e4ec6e9 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/async_notifier_old.dart @@ -1,5 +1,6 @@ // ignore_for_file: avoid_print, avoid_unused_constructor_parameters +import 'package:flutter_riverpod/legacy.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; class Todo { diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart index 034b059ec..1f5bff1ef 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/build_init_old.dart @@ -1,5 +1,4 @@ import 'package:flutter_riverpod/legacy.dart'; -import 'package:hooks_riverpod/hooks_riverpod.dart'; /* SNIPPET START */ class CounterNotifier extends StateNotifier { diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart index f9484516e..f39051948 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/providers/state_notifier_provider/todos.dart @@ -1,5 +1,4 @@ import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; /* SNIPPET START */ From ac6c9f0ab913168b5b72343e918c4897bc9f4e1e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 11 Feb 2024 18:38:01 +0100 Subject: [PATCH 222/387] Format --- packages/riverpod/test/new/core/async_value_test.dart | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/riverpod/test/new/core/async_value_test.dart b/packages/riverpod/test/new/core/async_value_test.dart index 469d0f27a..4fe7f586d 100644 --- a/packages/riverpod/test/new/core/async_value_test.dart +++ b/packages/riverpod/test/new/core/async_value_test.dart @@ -1600,7 +1600,6 @@ void main() { ); }); - test( 'AsyncValue.guard emits the error when the created future fails and predicate is null', () async { From ef66802ab1b0f2faaef6b3da6a99e709118d479e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 11 Feb 2024 19:10:46 +0100 Subject: [PATCH 223/387] Update CI --- .github/workflows/build.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 6a9e10071..1caf2863e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -36,8 +36,6 @@ jobs: - packages/hooks_riverpod - packages/hooks_riverpod/example - packages/riverpod_annotation - # TODO(rrousselGit) update riverpod_cli test setup to be supported by the CI - # - packages/riverpod_cli - packages/riverpod_generator - packages/riverpod_generator/integration/build_yaml # TODO(rrousselGit) update riverpod_graph test setup to be supported by the CI From 83fd6dedd5feb845cb4f6a734483d2b2b8b9c64e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 11 Feb 2024 19:23:23 +0100 Subject: [PATCH 224/387] Update dependencies doc --- .../lib/src/riverpod_annotation.dart | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart index 00c2046fc..2e2d1b295 100644 --- a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart @@ -18,7 +18,8 @@ import 'package:riverpod/src/internals.dart' show ProviderElementBase; /// {@endtemplate} @Target({TargetKind.classType, TargetKind.function}) @sealed -class Riverpod { +// TODO changelog make "Riverpod" final +final class Riverpod { /// {@macro riverpod_annotation.provider} const Riverpod({ this.keepAlive = false, @@ -47,10 +48,18 @@ class Riverpod { /// // By not specifying "dependencies", we are saying that this provider is never scoped /// @riverpod /// Foo root(RootRef ref) => Foo(); + /// /// // By specifying "dependencies" (even if the list is empty), /// // we are saying that this provider is potentially scoped /// @Riverpod(dependencies: []) /// Foo scoped(ScopedRef ref) => Foo(); + /// + /// // Alternatively, notifiers with an abstract build method are also considered scoped + /// @riverpod + /// class MyNotifier extends _$MyNotifier { + /// @override + /// int build(); + /// } /// ``` /// /// Then if we were to depend on `rootProvider` in a scoped provider, we From 44d46e1ad3db23372b66790e01d7a48d474613bb Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 12 Feb 2024 22:04:55 +0100 Subject: [PATCH 225/387] Fix scoped notifiers not specifying dependencies --- .../lib/src/riverpod_generator.dart | 11 +++++++---- .../riverpod_generator/test/integration/scopes.g.dart | 8 ++++---- packages/riverpod_generator/test/scoped_test.dart | 11 +++++++++++ .../test/lints/functional_ref/functional_ref.g.dart | 4 ++-- ...coped_providers_should_specify_dependencies.g.dart | 4 ++-- 5 files changed, 26 insertions(+), 12 deletions(-) diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index 713ff5c90..48573fcaa 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -217,8 +217,9 @@ extension ProviderElementNames on GeneratorProviderDeclarationElement { String get familyTypeName => '${name.titled}Family'; String dependencies(BuildYamlOptions options) { - final dependencies = annotation.dependencies; - if (dependencies == null) return 'null'; + var dependencies = annotation.dependencies; + if (dependencies == null && !isScoped) return 'null'; + dependencies ??= {}; final buffer = StringBuffer('const '); buffer.write('['); @@ -232,8 +233,10 @@ extension ProviderElementNames on GeneratorProviderDeclarationElement { return buffer.toString(); } - String allTransitiveDependencies(List? allTransitiveDependencies) { - if (allTransitiveDependencies == null) return 'null'; + String allTransitiveDependencies(List? deps) { + var allTransitiveDependencies = deps; + if (deps == null && !isScoped) return 'null'; + allTransitiveDependencies ??= []; final buffer = StringBuffer('const '); if (allTransitiveDependencies.length < 4) { diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index ef4d8e216..69f38686a 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -18,8 +18,8 @@ final class ScopedClassProvider extends $NotifierProvider { argument: null, name: r'scopedClassProvider', isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, + dependencies: const [], + allTransitiveDependencies: const [], ); final ScopedClass Function()? _createCb; @@ -164,8 +164,8 @@ final class ScopedClassFamilyFamily extends Family { const ScopedClassFamilyFamily._() : super( name: r'scopedClassFamilyProvider', - dependencies: null, - allTransitiveDependencies: null, + dependencies: const [], + allTransitiveDependencies: const [], isAutoDispose: true, ); diff --git a/packages/riverpod_generator/test/scoped_test.dart b/packages/riverpod_generator/test/scoped_test.dart index 6706a9699..c597a5c86 100644 --- a/packages/riverpod_generator/test/scoped_test.dart +++ b/packages/riverpod_generator/test/scoped_test.dart @@ -37,4 +37,15 @@ void main() { ), ); }); + + test('Marks the provider as scoped', () { + expect( + scopedClassFamilyProvider.allTransitiveDependencies, + same(const []), + ); + expect( + scopedClassProvider.allTransitiveDependencies, + same(const []), + ); + }); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index ab14a931f..ba60364c2 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -82,8 +82,8 @@ final class ScopedProvider extends $FunctionalProvider argument: null, name: r'scopedProvider', isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, + dependencies: const [], + allTransitiveDependencies: const [], ); final int Function( diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart index 3cf23ea4e..5384fcb49 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart @@ -83,8 +83,8 @@ final class UnimplementedScopedProvider argument: null, name: r'unimplementedScopedProvider', isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, + dependencies: const [], + allTransitiveDependencies: const [], ); final int Function( From 5b453562d2c34cd13c50b6fb08a3cff2d5014560 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 12 Feb 2024 22:55:22 +0100 Subject: [PATCH 226/387] Typos --- .../riverpod_analyzer_utils/lib/src/riverpod_ast/visitor.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/visitor.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/visitor.dart index 9d35c490f..689397e61 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/visitor.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/visitor.dart @@ -756,7 +756,7 @@ class RiverpodAstRegistry { } } -// Voluntarily not extenting RiverpodAstVisitor to trigger a compilation error +// Voluntarily not extending RecursiveRiverpodAstVisitor to trigger a compilation error // when new nodes are added. class _RiverpodAstRegistryVisitor extends RiverpodAstVisitor { _RiverpodAstRegistryVisitor(this._registry); From e1358b4d1e7d2b83708f6133cbda9fdbe91e93d0 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Tue, 13 Feb 2024 01:43:39 +0100 Subject: [PATCH 227/387] Use code-gen to automatically handle RiverpodAstVisitor (#3345) --- packages/lint_visitor_generator/LICENSE | 21 + packages/lint_visitor_generator/README.md | 1 + packages/lint_visitor_generator/build.yaml | 21 + .../lint_visitor_generator/lib/builder.dart | 332 +++ .../lib/src/type_checker.dart | 484 ++++ packages/lint_visitor_generator/pubspec.yaml | 20 + .../lib/riverpod_analyzer_utils.dart | 2 +- .../lib/src/riverpod_ast.dart | 27 +- .../lib/src/riverpod_ast.g.dart | 2029 +++++++++++++++++ .../lib/src/riverpod_ast/consumer.dart | 85 +- .../generator_provider_declaration.dart | 41 +- .../legacy_provider_declaration.dart | 51 +- ...ontainer_instance_creation_expression.dart | 14 +- .../riverpod_ast/provider_declaration.dart | 3 +- .../provider_listenable_expression.dart | 14 +- .../src/riverpod_ast/provider_override.dart | 25 +- .../lib/src/riverpod_ast/provider_scope.dart | 14 +- .../lib/src/riverpod_ast/ref_invocation.dart | 46 +- .../src/riverpod_ast/resolve_riverpod.dart | 62 +- .../src/riverpod_ast/riverpod_annotation.dart | 43 +- .../lib/src/riverpod_ast/visitor.dart | 986 -------- .../riverpod_ast/widget_ref_invocation.dart | 59 +- packages/riverpod_analyzer_utils/pubspec.yaml | 2 + .../pubspec_overrides.yaml | 5 +- .../test/analyzer_test_utils.dart | 503 +--- .../test/consumer_test.dart | 4 +- .../lib/src/lints/riverpod_syntax_error.dart | 2 +- 27 files changed, 3051 insertions(+), 1845 deletions(-) create mode 100644 packages/lint_visitor_generator/LICENSE create mode 100644 packages/lint_visitor_generator/README.md create mode 100644 packages/lint_visitor_generator/build.yaml create mode 100644 packages/lint_visitor_generator/lib/builder.dart create mode 100644 packages/lint_visitor_generator/lib/src/type_checker.dart create mode 100644 packages/lint_visitor_generator/pubspec.yaml create mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast.g.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast/visitor.dart diff --git a/packages/lint_visitor_generator/LICENSE b/packages/lint_visitor_generator/LICENSE new file mode 100644 index 000000000..62492abf7 --- /dev/null +++ b/packages/lint_visitor_generator/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 Remi Rousselet + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/packages/lint_visitor_generator/README.md b/packages/lint_visitor_generator/README.md new file mode 100644 index 000000000..1845aa6de --- /dev/null +++ b/packages/lint_visitor_generator/README.md @@ -0,0 +1 @@ +Internal tooling to generate `riverpod_analyzer_utils`'s `RiverpodAstVisitor` (and variants). diff --git a/packages/lint_visitor_generator/build.yaml b/packages/lint_visitor_generator/build.yaml new file mode 100644 index 000000000..cabd94bb8 --- /dev/null +++ b/packages/lint_visitor_generator/build.yaml @@ -0,0 +1,21 @@ +targets: + $default: + builders: + lint_visitor_generator: + enabled: true + generate_for: + include: + - "**/*.dart" + source_gen|combining_builder: + options: + ignore_for_file: + - "type=lint" + +builders: + lint_visitor_generator: + import: "package:lint_visitor_generator/builder.dart" + builder_factories: ["lintVisitorGenerator"] + build_extensions: { ".dart": [".lint_visitor_generator.g.part"] } + auto_apply: dependents + build_to: cache + applies_builders: ["source_gen|combining_builder"] \ No newline at end of file diff --git a/packages/lint_visitor_generator/lib/builder.dart b/packages/lint_visitor_generator/lib/builder.dart new file mode 100644 index 000000000..2e415ff34 --- /dev/null +++ b/packages/lint_visitor_generator/lib/builder.dart @@ -0,0 +1,332 @@ +import 'package:analyzer/dart/element/element.dart'; +import 'package:analyzer/dart/element/nullability_suffix.dart'; +import 'package:analyzer/dart/element/type.dart'; +import 'package:build/build.dart'; +import 'package:collection/collection.dart'; +import 'package:source_gen/source_gen.dart' hide TypeChecker; + +import 'src/type_checker.dart'; + +/// Builds generators for `build_runner` to run +Builder lintVisitorGenerator(BuilderOptions options) { + return SharedPartBuilder( + [_LintVisitorGenerator()], + 'lint_visitor_generator', + ); +} + +const _riverpodAstType = TypeChecker.fromName( + 'RiverpodAst', + packageName: 'riverpod_analyzer_utils', +); + +sealed class _AstField { + _AstField({required this.field, required this.type}); + + static _AstField? parse(FieldElement field) { + if (field.type.isDartCoreList) { + final valueType = (field.type as InterfaceType).typeArguments.single; + if (!_riverpodAstType.isAssignableFromType(valueType)) return null; + + return _ListAstField( + field: field, + type: field.type, + valueType: valueType, + ); + } else { + if (!_riverpodAstType.isAssignableFromType(field.type)) return null; + return _SingleAstField(field: field, type: field.type); + } + } + + final FieldElement field; + final DartType type; +} + +class _ListAstField extends _AstField { + _ListAstField({ + required super.field, + required super.type, + required this.valueType, + }); + + final DartType valueType; +} + +class _SingleAstField extends _AstField { + _SingleAstField({ + required super.field, + required super.type, + }); +} + +class _LintVisitorGenerator extends Generator { + @override + String generate(LibraryReader library, BuildStep buildStep) { + final buffer = StringBuffer(); + if (library.element.name == 'riverpod_ast') { + _writeRiverpodAstVisitor(library, buffer); + } + + if (buffer.isNotEmpty) { + buffer.writeln('// ignore_for_file: type=lint'); + } + + return buffer.toString(); + } + + void _writeRiverpodAstVisitor(LibraryReader library, StringBuffer buffer) { + final allAst = library.classes + .where((e) => e.name != 'RiverpodAst') + .where(_riverpodAstType.isAssignableFrom) + .toList(); + + final relationships = >{}; + + for (final ast in allAst) { + final relation = relationships.putIfAbsent(ast, () => {}); + + final allSuperAstTypes = ast.allSupertypes + .where((e) => !e.isDartCoreObject && e.element.name != 'RiverpodAst') + .toList(); + + final inheritedSuperTypes = []; + for (var superType = ast.supertype; + superType != null && + superType.element.name != 'RiverpodAst' && + !superType.isDartCoreObject; + superType = superType.superclass) { + inheritedSuperTypes.add(superType); + } + + for (final superAst in allSuperAstTypes) { + relation.add(superAst.element.name); + } + + final astFields = ast.fields + // Exclude fields already handled by the supertype + .where( + (field) => inheritedSuperTypes + .expand((e) => e.accessors) + .every((superField) => superField.name != field.name), + ) + .map(_AstField.parse) + .whereNotNull() + .toList(); + + _writeAstMixin( + buffer, + ast, + astFields, + hasSuperType: inheritedSuperTypes.isNotEmpty, + ); + } + + final concreteRelationshipEntries = + relationships.entries.where((e) => !e.key.isAbstract); + + buffer.writeln(''' +abstract class RiverpodAstVisitor { + ${concreteRelationshipEntries.map( + (e) => ''' + void visit${e.key.name}(${e.key.name} node); +''', + ).join('\n')} +} + +abstract class GeneralizingRiverpodAstVisitor implements RiverpodAstVisitor { + void visitRiverpodAst(RiverpodAst node) { + node.visitChildren(this); + } + + ${relationships.entries.map( + (e) => ''' + ${e.key.isAbstract ? '' : '@override'} + void visit${e.key.name}(${e.key.name} node) { + ${e.value.map((e) => 'visit$e(node);').join('\n')} + } +''', + ).join('\n')} +} + + +abstract class RecursiveRiverpodAstVisitor implements RiverpodAstVisitor { + ${concreteRelationshipEntries.map( + (e) => ''' + @override + void visit${e.key.name}(${e.key.name} node) { + node.visitChildren(this); + } +''', + ).join('\n')} +} + +abstract class SimpleRiverpodAstVisitor implements RiverpodAstVisitor { + ${concreteRelationshipEntries.map( + (e) => ''' + @override + void visit${e.key.name}(${e.key.name} node) { + } +''', + ).join('\n')} +} + +abstract class UnimplementedRiverpodAstVisitor implements RiverpodAstVisitor { + ${concreteRelationshipEntries.map( + (e) => ''' + @override + void visit${e.key.name}(${e.key.name} node) { + throw UnimplementedError(); + } +''', + ).join('\n')} +} + +@internal +class RiverpodAnalysisResult extends GeneralizingRiverpodAstVisitor { + ${relationships.entries.map( + (e) => ''' + final ${e.key.name.lowerFirst}s = + <${e.key.name}>[]; + @override + void visit${e.key.name}( + ${e.key.name} node, + ) { + super.visit${e.key.name}(node); + ${e.key.name.lowerFirst}s.add(node); + } +''', + ).join('\n')} + +} + +class _RiverpodAstRegistryVisitor extends GeneralizingRiverpodAstVisitor { + _RiverpodAstRegistryVisitor(this._registry); + + final RiverpodAstRegistry _registry; + + void _runSubscriptions( + R value, + List subscriptions, + ) { + for (final sub in subscriptions) { + try { + sub(value); + } catch (e, stack) { + Zone.current.handleUncaughtError(e, stack); + } + } + } + + @override + void visitRiverpodAst(RiverpodAst node) { + node.visitChildren(this); + } + + ${relationships.entries.map( + (e) => ''' + @override + void visit${e.key.name}(${e.key.name} node) { + super.visit${e.key.name}(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._on${e.key.name}, + ); + } + +''', + ).join('\n')} +} + +class RiverpodAstRegistry { + void run(RiverpodAst node) { + node.accept(_RiverpodAstRegistryVisitor(this)); + } + + final _onRiverpodAst = []; + void addRiverpodAst(void Function(RiverpodAst node) cb) { + _onRiverpodAst.add(cb); + } + + ${relationships.entries.map( + (e) => ''' + final _on${e.key.name} = []; + void add${e.key.name}(void Function(${e.key.name} node) cb) { + _on${e.key.name}.add(cb); + } +''', + ).join('\n')} +} +'''); + } + + void _writeAstMixin( + StringBuffer buffer, + ClassElement ast, + List<_AstField> astFields, { + required bool hasSuperType, + }) { + late final accept = ''' + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visit${ast.name}(this as ${ast.name},); + } + '''; + + final visitChildren = StringBuffer(); + if (hasSuperType) { + visitChildren.writeln('super.visitChildren(visitor);'); + } + + for (final field in astFields) { + switch (field) { + case _ListAstField(): + final op = + field.valueType.nullabilitySuffix == NullabilitySuffix.question + ? '?' + : ''; + + var leading = ''; + var trailing = ''; + if (field.type.nullabilitySuffix == NullabilitySuffix.question) { + leading = + 'if (${field.field.name} case final ${field.field.name}?) {'; + trailing = '}'; + } + + visitChildren.writeln(''' + $leading + for (final value in ${field.field.name}) { + value$op.accept(visitor); + } + $trailing + '''); + + case _SingleAstField(): + final op = field.type.nullabilitySuffix == NullabilitySuffix.question + ? '?' + : ''; + visitChildren.writeln( + '${field.field.name}$op.accept(visitor);', + ); + } + } + + buffer.writeln(''' +base mixin _\$${ast.name} on RiverpodAst { + ${astFields.map((e) => '${e.type} get ${e.field.name};').join('\n')} + + ${ast.isAbstract ? '' : accept} + + @override void visitChildren(RiverpodAstVisitor visitor) { + $visitChildren + } +} +'''); + } +} + +extension on String { + String get lowerFirst => substring(0, 1).toLowerCase() + substring(1); +} diff --git a/packages/lint_visitor_generator/lib/src/type_checker.dart b/packages/lint_visitor_generator/lib/src/type_checker.dart new file mode 100644 index 000000000..85da4569c --- /dev/null +++ b/packages/lint_visitor_generator/lib/src/type_checker.dart @@ -0,0 +1,484 @@ +// Copyright (c) 2017, the Dart project authors. Please see the AUTHORS file +// for details. All rights reserved. Use of this source code is governed by a +// BSD-style license that can be found in the LICENSE file. + +// Code imported from source_gen + +import 'package:analyzer/dart/analysis/results.dart'; +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/constant/value.dart'; +import 'package:analyzer/dart/element/element.dart'; +import 'package:analyzer/dart/element/type.dart'; +import 'package:meta/meta.dart'; +import 'package:path/path.dart' as p; +import 'package:source_span/source_span.dart'; + +/// An abstraction around doing static type checking at compile/build time. +abstract class TypeChecker { + const TypeChecker._(); + + /// Creates a new [TypeChecker] that delegates to other [checkers]. + /// + /// This implementation will return `true` for type checks if _any_ of the + /// provided type checkers return true, which is useful for deprecating an + /// API: + /// ```dart + /// const $Foo = const TypeChecker.fromRuntime(Foo); + /// const $Bar = const TypeChecker.fromRuntime(Bar); + /// + /// // Used until $Foo is deleted. + /// const $FooOrBar = const TypeChecker.forAny(const [$Foo, $Bar]); + /// ``` + const factory TypeChecker.any(Iterable checkers) = _AnyChecker; + + /// Creates a new [TypeChecker] that delegates to other [checkers]. + /// + /// This implementation will return `true` if **all** the checkers match. + /// Checkers will be checked in order. + const factory TypeChecker.every(Iterable checkers) = + _EveryChecker; + + /// Create a new [TypeChecker] backed by a static [type]. + const factory TypeChecker.fromStatic(DartType type) = _LibraryTypeChecker; + + /// Checks that the element comes from a specific package. + const factory TypeChecker.fromPackage(String packageName) = _PackageChecker; + + /// Checks that the element has a specific name, and optionally checks that it + /// is defined from a specific package. + /// + /// This is similar to [TypeChecker.fromUrl] but does not rely on exactly where + /// the definition of the element comes from. + /// The downside is that if somehow a package exposes two elements with the + /// same name, there could be a conflict. + const factory TypeChecker.fromName( + String name, { + String? packageName, + }) = _NamedChecker; + + /// Create a new [TypeChecker] backed by a library [url]. + /// + /// Example of referring to a `LinkedHashMap` from `dart:collection`: + /// ```dart + /// const linkedHashMap = const TypeChecker.fromUrl( + /// 'dart:collection#LinkedHashMap', + /// ); + /// ``` + /// + /// **NOTE**: This is considered a more _brittle_ way of determining the type + /// because it relies on knowing the _absolute_ path (i.e. after resolved + /// `export` directives). You should ideally only use `fromUrl` when you know + /// the full path (likely you own/control the package) or it is in a stable + /// package like in the `dart:` SDK. + const factory TypeChecker.fromUrl(dynamic url) = _UriTypeChecker; + + /// Returns the first constant annotating [element] assignable to this type. + /// + /// Otherwise returns `null`. + /// + /// Throws on unresolved annotations unless [throwOnUnresolved] is `false`. + DartObject? firstAnnotationOf( + Element element, { + bool throwOnUnresolved = true, + }) { + if (element.metadata.isEmpty) { + return null; + } + final results = + annotationsOf(element, throwOnUnresolved: throwOnUnresolved); + return results.isEmpty ? null : results.first; + } + + /// Returns if a constant annotating [element] is assignable to this type. + /// + /// Throws on unresolved annotations unless [throwOnUnresolved] is `false`. + bool hasAnnotationOf(Element element, {bool throwOnUnresolved = true}) => + firstAnnotationOf(element, throwOnUnresolved: throwOnUnresolved) != null; + + /// Returns the first constant annotating [element] that is exactly this type. + /// + /// Throws [UnresolvedAnnotationException] on unresolved annotations unless + /// [throwOnUnresolved] is explicitly set to `false` (default is `true`). + DartObject? firstAnnotationOfExact( + Element element, { + bool throwOnUnresolved = true, + }) { + if (element.metadata.isEmpty) { + return null; + } + final results = + annotationsOfExact(element, throwOnUnresolved: throwOnUnresolved); + return results.isEmpty ? null : results.first; + } + + /// Returns if a constant annotating [element] is exactly this type. + /// + /// Throws [UnresolvedAnnotationException] on unresolved annotations unless + /// [throwOnUnresolved] is explicitly set to `false` (default is `true`). + bool hasAnnotationOfExact(Element element, {bool throwOnUnresolved = true}) => + firstAnnotationOfExact(element, throwOnUnresolved: throwOnUnresolved) != + null; + + DartObject? _computeConstantValue( + Element element, + int annotationIndex, { + bool throwOnUnresolved = true, + }) { + final annotation = element.metadata[annotationIndex]; + final result = annotation.computeConstantValue(); + if (result == null && throwOnUnresolved) { + throw UnresolvedAnnotationException._from(element, annotationIndex); + } + return result; + } + + /// Returns annotating constants on [element] assignable to this type. + /// + /// Throws [UnresolvedAnnotationException] on unresolved annotations unless + /// [throwOnUnresolved] is explicitly set to `false` (default is `true`). + Iterable annotationsOf( + Element element, { + bool throwOnUnresolved = true, + }) => + _annotationsWhere( + element, + isAssignableFromType, + throwOnUnresolved: throwOnUnresolved, + ); + + Iterable _annotationsWhere( + Element element, + bool Function(DartType) predicate, { + bool throwOnUnresolved = true, + }) sync* { + for (var i = 0; i < element.metadata.length; i++) { + final value = _computeConstantValue( + element, + i, + throwOnUnresolved: throwOnUnresolved, + ); + if (value?.type != null && predicate(value!.type!)) { + yield value; + } + } + } + + /// Returns annotating constants on [element] of exactly this type. + /// + /// Throws [UnresolvedAnnotationException] on unresolved annotations unless + /// [throwOnUnresolved] is explicitly set to `false` (default is `true`). + Iterable annotationsOfExact( + Element element, { + bool throwOnUnresolved = true, + }) => + _annotationsWhere( + element, + isExactlyType, + throwOnUnresolved: throwOnUnresolved, + ); + + /// Returns `true` if the type of [element] can be assigned to this type. + bool isAssignableFrom(Element element) => + isExactly(element) || + (element is ClassElement && element.allSupertypes.any(isExactlyType)); + + /// Returns `true` if [staticType] can be assigned to this type. + // ignore: avoid_bool_literals_in_conditional_expressions + bool isAssignableFromType(DartType staticType) => staticType.element == null + ? false + : isAssignableFrom(staticType.element!); + + /// Returns `true` if representing the exact same class as [element]. + bool isExactly(Element element); + + /// Returns `true` if representing the exact same type as [staticType]. + bool isExactlyType(DartType staticType) { + final element = staticType.element; + return element != null && isExactly(element); + } + + /// Returns `true` if representing a super class of [element]. + /// + /// This check only takes into account the *extends* hierarchy. If you wish + /// to check mixins and interfaces, use [isAssignableFrom]. + bool isSuperOf(Element element) { + if (element is ClassElement) { + var theSuper = element.supertype; + + do { + if (isExactlyType(theSuper!)) { + return true; + } + + theSuper = theSuper.superclass; + } while (theSuper != null); + } + + return false; + } + + /// Returns `true` if representing a super type of [staticType]. + /// + /// This only takes into account the *extends* hierarchy. If you wish + /// to check mixins and interfaces, use [isAssignableFromType]. + bool isSuperTypeOf(DartType staticType) => isSuperOf(staticType.element!); +} + +// Checks a static type against another static type; +class _LibraryTypeChecker extends TypeChecker { + const _LibraryTypeChecker(this._type) : super._(); + + final DartType _type; + + @override + bool isExactly(Element element) => + element is ClassElement && element == _type.element; + + @override + String toString() => _urlOfElement(_type.element!); +} + +@immutable +class _PackageChecker extends TypeChecker { + const _PackageChecker(this._packageName) : super._(); + + final String _packageName; + + @override + bool isExactly(Element element) { + final elementLibraryIdentifier = element.library?.identifier; + + return elementLibraryIdentifier != null && + elementLibraryIdentifier.startsWith('package:$_packageName/'); + } + + @override + bool operator ==(Object o) { + return o is _PackageChecker && o._packageName == _packageName; + } + + @override + int get hashCode => Object.hash(runtimeType, _packageName); + + @override + String toString() => _packageName; +} + +@immutable +class _NamedChecker extends TypeChecker { + const _NamedChecker(this._name, {this.packageName}) : super._(); + + final String _name; + final String? packageName; + + @override + bool isExactly(Element element) { + if (element.name != _name) return false; + + // No packageName specified, ignoring it. + if (packageName == null) return true; + + final checker = _PackageChecker(packageName!); + return checker.isExactly(element); + } + + @override + bool operator ==(Object o) { + return o is _NamedChecker && + o._name == _name && + o.packageName == packageName; + } + + @override + int get hashCode => Object.hash(runtimeType, _name, packageName); + + @override + String toString() => '$packageName#$_name'; +} + +// Checks a runtime type against an Uri and Symbol. +@immutable +class _UriTypeChecker extends TypeChecker { + const _UriTypeChecker(dynamic url) + : _url = '$url', + super._(); + + // Precomputed cache of String --> Uri. + static final _cache = Expando(); + + final String _url; + + /// Url as a [Uri] object, lazily constructed. + Uri get uri => _cache[this] ??= _normalizeUrl(Uri.parse(_url)); + + /// Returns whether this type represents the same as [url]. + bool hasSameUrl(dynamic url) => + uri.toString() == + (url is String ? url : _normalizeUrl(url as Uri).toString()); + + @override + bool isExactly(Element element) => hasSameUrl(_urlOfElement(element)); + + @override + bool operator ==(Object o) => o is _UriTypeChecker && o._url == _url; + + @override + int get hashCode => _url.hashCode; + + @override + String toString() => '$uri'; +} + +class _AnyChecker extends TypeChecker { + const _AnyChecker(this._checkers) : super._(); + + final Iterable _checkers; + + @override + bool isExactly(Element element) => _checkers.any((c) => c.isExactly(element)); +} + +class _EveryChecker extends TypeChecker { + const _EveryChecker(this._checkers) : super._(); + + final Iterable _checkers; + + @override + bool isExactly(Element element) { + return _checkers.every((c) => c.isExactly(element)); + } +} + +/// Exception thrown when [TypeChecker] fails to resolve a metadata annotation. +/// +/// Methods such as [TypeChecker.firstAnnotationOf] may throw this exception +/// when one or more annotations are not resolvable. This is usually a sign that +/// something was misspelled, an import is missing, or a dependency was not +/// defined (for build systems such as Bazel). +class UnresolvedAnnotationException implements Exception { + /// Creates an exception from an annotation ([annotationIndex]) that was not + /// resolvable while traversing [Element.metadata] on [annotatedElement]. + factory UnresolvedAnnotationException._from( + Element annotatedElement, + int annotationIndex, + ) { + final sourceSpan = _findSpan(annotatedElement, annotationIndex); + return UnresolvedAnnotationException._(annotatedElement, sourceSpan); + } + + const UnresolvedAnnotationException._( + this.annotatedElement, + this.annotationSource, + ); + + static SourceSpan? _findSpan( + Element annotatedElement, + int annotationIndex, + ) { + final parsedLibrary = annotatedElement.session! + .getParsedLibraryByElement(annotatedElement.library!) + as ParsedLibraryResult; + final declaration = parsedLibrary.getElementDeclaration(annotatedElement); + if (declaration == null) { + return null; + } + final node = declaration.node; + final List metadata; + if (node is AnnotatedNode) { + metadata = node.metadata; + } else if (node is FormalParameter) { + metadata = node.metadata; + } else { + throw StateError( + 'Unhandled Annotated AST node type: ${node.runtimeType}', + ); + } + final annotation = metadata[annotationIndex]; + final start = annotation.offset; + final end = start + annotation.length; + final parsedUnit = declaration.parsedUnit!; + return SourceSpan( + SourceLocation(start, sourceUrl: parsedUnit.uri), + SourceLocation(end, sourceUrl: parsedUnit.uri), + parsedUnit.content.substring(start, end), + ); + } + + /// Element that was annotated with something we could not resolve. + final Element annotatedElement; + + /// Source span of the annotation that was not resolved. + /// + /// May be `null` if the import library was not found. + final SourceSpan? annotationSource; + + @override + String toString() { + final message = 'Could not resolve annotation for `$annotatedElement`.'; + if (annotationSource != null) { + return annotationSource!.message(message); + } + return message; + } +} + +/// Returns a URL representing [element]. +String _urlOfElement(Element element) => element.kind == ElementKind.DYNAMIC + ? 'dart:core#dynamic' + : element.kind == ElementKind.NEVER + ? 'dart:core#Never' + // using librarySource.uri – in case the element is in a part + : _normalizeUrl(element.librarySource!.uri) + .replace(fragment: element.name) + .toString(); + +Uri _normalizeUrl(Uri url) { + switch (url.scheme) { + case 'dart': + return _normalizeDartUrl(url); + case 'package': + return _packageToAssetUrl(url); + case 'file': + return _fileToAssetUrl(url); + default: + return url; + } +} + +/// Make `dart:`-type URLs look like a user-knowable path. +/// +/// Some internal dart: URLs are something like `dart:core/map.dart`. +/// +/// This isn't a user-knowable path, so we strip out extra path segments +/// and only expose `dart:core`. +Uri _normalizeDartUrl(Uri url) => url.pathSegments.isNotEmpty + ? url.replace(pathSegments: url.pathSegments.take(1)) + : url; + +Uri _fileToAssetUrl(Uri url) { + if (!p.isWithin(p.url.current, url.path)) return url; + + return Uri( + scheme: 'asset', + path: p.join('', p.relative(url.path)), + ); +} + +/// Returns a `package:` URL converted to a `asset:` URL. +/// +/// This makes internal comparison logic much easier, but still allows users +/// to define assets in terms of `package:`, which is something that makes more +/// sense to most. +/// +/// For example, this transforms `package:source_gen/source_gen.dart` into: +/// `asset:source_gen/lib/source_gen.dart`. +Uri _packageToAssetUrl(Uri url) => url.scheme == 'package' + ? url.replace( + scheme: 'asset', + pathSegments: [ + url.pathSegments.first, + 'lib', + ...url.pathSegments.skip(1), + ], + ) + : url; diff --git a/packages/lint_visitor_generator/pubspec.yaml b/packages/lint_visitor_generator/pubspec.yaml new file mode 100644 index 000000000..b4e34cd52 --- /dev/null +++ b/packages/lint_visitor_generator/pubspec.yaml @@ -0,0 +1,20 @@ +name: lint_visitor_generator +publish_to: none + +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + analyzer: ">=5.12.0 <7.0.0" + build: ^2.3.1 + build_config: ^1.1.0 + collection: ^1.17.1 + meta: ^1.7.0 + path: ^1.9.0 + source_gen: ^1.2.3 + source_span: ^1.10.0 + +dev_dependencies: + build_runner: ^2.2.0 + build_test: ^2.1.5 + source_gen_test: ^1.0.4 diff --git a/packages/riverpod_analyzer_utils/lib/riverpod_analyzer_utils.dart b/packages/riverpod_analyzer_utils/lib/riverpod_analyzer_utils.dart index ff3f41a80..fd1d41085 100644 --- a/packages/riverpod_analyzer_utils/lib/riverpod_analyzer_utils.dart +++ b/packages/riverpod_analyzer_utils/lib/riverpod_analyzer_utils.dart @@ -1,5 +1,5 @@ // TODO changelog exported export 'src/errors.dart' hide errorReporter, ErrorReporter; -export 'src/riverpod_ast.dart' hide ObjectUtils; +export 'src/riverpod_ast.dart' hide ObjectUtils, RiverpodAnalysisResult; export 'src/riverpod_element.dart'; export 'src/riverpod_types.dart'; diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast.dart index 5b0699daf..0a9f15fed 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast.dart @@ -1,3 +1,5 @@ +library riverpod_ast; + import 'dart:async'; import 'dart:convert'; @@ -17,22 +19,37 @@ import '../riverpod_analyzer_utils.dart'; import 'argument_list_utils.dart'; import 'errors.dart'; +part 'riverpod_ast.g.dart'; part 'riverpod_ast/consumer.dart'; part 'riverpod_ast/generator_provider_declaration.dart'; part 'riverpod_ast/legacy_provider_declaration.dart'; part 'riverpod_ast/provider_container_instance_creation_expression.dart'; part 'riverpod_ast/provider_declaration.dart'; part 'riverpod_ast/provider_listenable_expression.dart'; +part 'riverpod_ast/provider_override.dart'; +part 'riverpod_ast/provider_scope.dart'; part 'riverpod_ast/ref_invocation.dart'; part 'riverpod_ast/resolve_riverpod.dart'; part 'riverpod_ast/riverpod_annotation.dart'; -part 'riverpod_ast/visitor.dart'; part 'riverpod_ast/widget_ref_invocation.dart'; -part 'riverpod_ast/provider_scope.dart'; -part 'riverpod_ast/provider_override.dart'; -@sealed -abstract class RiverpodAst { +class _SetParentVisitor extends GeneralizingRiverpodAstVisitor { + _SetParentVisitor(this.parent); + + final RiverpodAst parent; + + @override + void visitRiverpodAst(RiverpodAst node) { + node._parent = parent; + super.visitRiverpodAst(node); + } +} + +abstract base class RiverpodAst { + RiverpodAst() { + visitChildren(_SetParentVisitor(this)); + } + RiverpodAst? _parent; RiverpodAst? get parent => _parent; diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast.g.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast.g.dart new file mode 100644 index 000000000..7d228c89e --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast.g.dart @@ -0,0 +1,2029 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'riverpod_ast.dart'; + +// ************************************************************************** +// _LintVisitorGenerator +// ************************************************************************** + +base mixin _$ConsumerDeclaration on RiverpodAst { + @override + void visitChildren(RiverpodAstVisitor visitor) {} +} + +base mixin _$ConsumerWidgetDeclaration on RiverpodAst { + List get widgetRefInvocations; + List + get providerScopeInstanceCreateExpressions; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitConsumerWidgetDeclaration( + this as ConsumerWidgetDeclaration, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + + for (final value in widgetRefInvocations) { + value.accept(visitor); + } + + for (final value in providerScopeInstanceCreateExpressions) { + value.accept(visitor); + } + } +} + +base mixin _$HookConsumerWidgetDeclaration on RiverpodAst { + List get widgetRefInvocations; + List + get providerScopeInstanceCreateExpressions; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitHookConsumerWidgetDeclaration( + this as HookConsumerWidgetDeclaration, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + + for (final value in widgetRefInvocations) { + value.accept(visitor); + } + + for (final value in providerScopeInstanceCreateExpressions) { + value.accept(visitor); + } + } +} + +base mixin _$ConsumerStatefulWidgetDeclaration on RiverpodAst { + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitConsumerStatefulWidgetDeclaration( + this as ConsumerStatefulWidgetDeclaration, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + } +} + +base mixin _$StatefulHookConsumerWidgetDeclaration on RiverpodAst { + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitStatefulHookConsumerWidgetDeclaration( + this as StatefulHookConsumerWidgetDeclaration, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + } +} + +base mixin _$ConsumerStateDeclaration on RiverpodAst { + List get widgetRefInvocations; + List + get providerScopeInstanceCreateExpressions; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitConsumerStateDeclaration( + this as ConsumerStateDeclaration, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + + for (final value in widgetRefInvocations) { + value.accept(visitor); + } + + for (final value in providerScopeInstanceCreateExpressions) { + value.accept(visitor); + } + } +} + +base mixin _$GeneratorProviderDeclaration on RiverpodAst { + List get refInvocations; + RiverpodAnnotation get annotation; + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + + for (final value in refInvocations) { + value.accept(visitor); + } + + annotation.accept(visitor); + } +} + +base mixin _$ClassBasedProviderDeclaration on RiverpodAst { + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitClassBasedProviderDeclaration( + this as ClassBasedProviderDeclaration, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + } +} + +base mixin _$FunctionalProviderDeclaration on RiverpodAst { + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitFunctionalProviderDeclaration( + this as FunctionalProviderDeclaration, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + } +} + +base mixin _$LegacyProviderDependencies on RiverpodAst { + List? get dependencies; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitLegacyProviderDependencies( + this as LegacyProviderDependencies, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + if (dependencies case final dependencies?) { + for (final value in dependencies) { + value.accept(visitor); + } + } + } +} + +base mixin _$LegacyProviderDependency on RiverpodAst { + ProviderListenableExpression? get provider; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitLegacyProviderDependency( + this as LegacyProviderDependency, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + provider?.accept(visitor); + } +} + +base mixin _$LegacyProviderDeclaration on RiverpodAst { + LegacyProviderDependencies? get dependencies; + List get refInvocations; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitLegacyProviderDeclaration( + this as LegacyProviderDeclaration, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + dependencies?.accept(visitor); + + for (final value in refInvocations) { + value.accept(visitor); + } + } +} + +base mixin _$ProviderContainerInstanceCreationExpression on RiverpodAst { + ProviderOverrideList? get overrides; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitProviderContainerInstanceCreationExpression( + this as ProviderContainerInstanceCreationExpression, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + overrides?.accept(visitor); + } +} + +base mixin _$ProviderDeclaration on RiverpodAst { + @override + void visitChildren(RiverpodAstVisitor visitor) {} +} + +base mixin _$ProviderListenableExpressionParent on RiverpodAst { + @override + void visitChildren(RiverpodAstVisitor visitor) {} +} + +base mixin _$ProviderListenableExpression on RiverpodAst { + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitProviderListenableExpression( + this as ProviderListenableExpression, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) {} +} + +base mixin _$ProviderOverrideExpression on RiverpodAst { + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitProviderOverrideExpression( + this as ProviderOverrideExpression, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) {} +} + +base mixin _$ProviderOverrideList on RiverpodAst { + List? get overrides; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitProviderOverrideList( + this as ProviderOverrideList, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + if (overrides case final overrides?) { + for (final value in overrides) { + value.accept(visitor); + } + } + } +} + +base mixin _$ProviderScopeInstanceCreationExpression on RiverpodAst { + ProviderOverrideList? get overrides; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitProviderScopeInstanceCreationExpression( + this as ProviderScopeInstanceCreationExpression, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + overrides?.accept(visitor); + } +} + +base mixin _$RefInvocation on RiverpodAst { + @override + void visitChildren(RiverpodAstVisitor visitor) {} +} + +base mixin _$RefDependencyInvocation on RiverpodAst { + ProviderListenableExpression get provider; + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + provider.accept(visitor); + } +} + +base mixin _$RefWatchInvocation on RiverpodAst { + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitRefWatchInvocation( + this as RefWatchInvocation, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + } +} + +base mixin _$RefReadInvocation on RiverpodAst { + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitRefReadInvocation( + this as RefReadInvocation, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + } +} + +base mixin _$RefListenInvocation on RiverpodAst { + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitRefListenInvocation( + this as RefListenInvocation, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + } +} + +base mixin _$ResolvedRiverpodLibraryResult on RiverpodAst { + List + get providerScopeInstanceCreationExpressions; + List + get providerContainerInstanceCreationExpressions; + List get functionalProviderDeclarations; + List get classBasedProviderDeclarations; + List get legacyProviderDeclarations; + List get consumerWidgetDeclarations; + List + get consumerStatefulWidgetDeclarations; + List get consumerStateDeclaration; + List + get statefulHookConsumerWidgetDeclarations; + List get hookConsumerWidgetDeclarations; + List get unknownRefInvocations; + List get unknownWidgetRefInvocations; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitResolvedRiverpodLibraryResult( + this as ResolvedRiverpodLibraryResult, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + for (final value in providerScopeInstanceCreationExpressions) { + value.accept(visitor); + } + + for (final value in providerContainerInstanceCreationExpressions) { + value.accept(visitor); + } + + for (final value in functionalProviderDeclarations) { + value.accept(visitor); + } + + for (final value in classBasedProviderDeclarations) { + value.accept(visitor); + } + + for (final value in legacyProviderDeclarations) { + value.accept(visitor); + } + + for (final value in consumerWidgetDeclarations) { + value.accept(visitor); + } + + for (final value in consumerStatefulWidgetDeclarations) { + value.accept(visitor); + } + + for (final value in consumerStateDeclaration) { + value.accept(visitor); + } + + for (final value in statefulHookConsumerWidgetDeclarations) { + value.accept(visitor); + } + + for (final value in hookConsumerWidgetDeclarations) { + value.accept(visitor); + } + + for (final value in unknownRefInvocations) { + value.accept(visitor); + } + + for (final value in unknownWidgetRefInvocations) { + value.accept(visitor); + } + } +} + +base mixin _$RiverpodAnnotationDependency on RiverpodAst { + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitRiverpodAnnotationDependency( + this as RiverpodAnnotationDependency, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) {} +} + +base mixin _$RiverpodAnnotationDependencies on RiverpodAst { + List? get dependencies; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitRiverpodAnnotationDependencies( + this as RiverpodAnnotationDependencies, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + if (dependencies case final dependencies?) { + for (final value in dependencies) { + value.accept(visitor); + } + } + } +} + +base mixin _$RiverpodAnnotation on RiverpodAst { + RiverpodAnnotationDependencies? get dependencies; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitRiverpodAnnotation( + this as RiverpodAnnotation, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + dependencies?.accept(visitor); + } +} + +base mixin _$WidgetRefInvocation on RiverpodAst { + @override + void visitChildren(RiverpodAstVisitor visitor) {} +} + +base mixin _$WidgetRefWatchInvocation on RiverpodAst { + ProviderListenableExpression get provider; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitWidgetRefWatchInvocation( + this as WidgetRefWatchInvocation, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + provider.accept(visitor); + } +} + +base mixin _$WidgetRefReadInvocation on RiverpodAst { + ProviderListenableExpression get provider; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitWidgetRefReadInvocation( + this as WidgetRefReadInvocation, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + provider.accept(visitor); + } +} + +base mixin _$WidgetRefListenInvocation on RiverpodAst { + ProviderListenableExpression get provider; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitWidgetRefListenInvocation( + this as WidgetRefListenInvocation, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + provider.accept(visitor); + } +} + +base mixin _$WidgetRefListenManualInvocation on RiverpodAst { + ProviderListenableExpression get provider; + + @override + void accept(RiverpodAstVisitor visitor) { + visitor.visitWidgetRefListenManualInvocation( + this as WidgetRefListenManualInvocation, + ); + } + + @override + void visitChildren(RiverpodAstVisitor visitor) { + super.visitChildren(visitor); + provider.accept(visitor); + } +} + +abstract class RiverpodAstVisitor { + void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration node); + + void visitHookConsumerWidgetDeclaration(HookConsumerWidgetDeclaration node); + + void visitConsumerStatefulWidgetDeclaration( + ConsumerStatefulWidgetDeclaration node); + + void visitStatefulHookConsumerWidgetDeclaration( + StatefulHookConsumerWidgetDeclaration node); + + void visitConsumerStateDeclaration(ConsumerStateDeclaration node); + + void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node); + + void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node); + + void visitLegacyProviderDependencies(LegacyProviderDependencies node); + + void visitLegacyProviderDependency(LegacyProviderDependency node); + + void visitLegacyProviderDeclaration(LegacyProviderDeclaration node); + + void visitProviderContainerInstanceCreationExpression( + ProviderContainerInstanceCreationExpression node); + + void visitProviderListenableExpression(ProviderListenableExpression node); + + void visitProviderOverrideExpression(ProviderOverrideExpression node); + + void visitProviderOverrideList(ProviderOverrideList node); + + void visitProviderScopeInstanceCreationExpression( + ProviderScopeInstanceCreationExpression node); + + void visitRefWatchInvocation(RefWatchInvocation node); + + void visitRefReadInvocation(RefReadInvocation node); + + void visitRefListenInvocation(RefListenInvocation node); + + void visitResolvedRiverpodLibraryResult(ResolvedRiverpodLibraryResult node); + + void visitRiverpodAnnotationDependency(RiverpodAnnotationDependency node); + + void visitRiverpodAnnotationDependencies(RiverpodAnnotationDependencies node); + + void visitRiverpodAnnotation(RiverpodAnnotation node); + + void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation node); + + void visitWidgetRefReadInvocation(WidgetRefReadInvocation node); + + void visitWidgetRefListenInvocation(WidgetRefListenInvocation node); + + void visitWidgetRefListenManualInvocation( + WidgetRefListenManualInvocation node); +} + +abstract class GeneralizingRiverpodAstVisitor implements RiverpodAstVisitor { + void visitRiverpodAst(RiverpodAst node) { + node.visitChildren(this); + } + + void visitConsumerDeclaration(ConsumerDeclaration node) {} + + @override + void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration node) { + visitConsumerDeclaration(node); + } + + @override + void visitHookConsumerWidgetDeclaration(HookConsumerWidgetDeclaration node) { + visitConsumerDeclaration(node); + } + + @override + void visitConsumerStatefulWidgetDeclaration( + ConsumerStatefulWidgetDeclaration node) { + visitConsumerDeclaration(node); + } + + @override + void visitStatefulHookConsumerWidgetDeclaration( + StatefulHookConsumerWidgetDeclaration node) { + visitConsumerDeclaration(node); + } + + @override + void visitConsumerStateDeclaration(ConsumerStateDeclaration node) { + visitConsumerDeclaration(node); + } + + void visitGeneratorProviderDeclaration(GeneratorProviderDeclaration node) { + visitProviderDeclaration(node); + } + + @override + void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) { + visitGeneratorProviderDeclaration(node); + visitProviderDeclaration(node); + } + + @override + void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) { + visitGeneratorProviderDeclaration(node); + visitProviderDeclaration(node); + } + + @override + void visitLegacyProviderDependencies(LegacyProviderDependencies node) {} + + @override + void visitLegacyProviderDependency(LegacyProviderDependency node) { + visitProviderListenableExpressionParent(node); + } + + @override + void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) { + visitProviderDeclaration(node); + } + + @override + void visitProviderContainerInstanceCreationExpression( + ProviderContainerInstanceCreationExpression node) {} + + void visitProviderDeclaration(ProviderDeclaration node) {} + + void visitProviderListenableExpressionParent( + ProviderListenableExpressionParent node) {} + + @override + void visitProviderListenableExpression(ProviderListenableExpression node) {} + + @override + void visitProviderOverrideExpression(ProviderOverrideExpression node) {} + + @override + void visitProviderOverrideList(ProviderOverrideList node) {} + + @override + void visitProviderScopeInstanceCreationExpression( + ProviderScopeInstanceCreationExpression node) {} + + void visitRefInvocation(RefInvocation node) { + visitProviderListenableExpressionParent(node); + } + + void visitRefDependencyInvocation(RefDependencyInvocation node) { + visitRefInvocation(node); + visitProviderListenableExpressionParent(node); + } + + @override + void visitRefWatchInvocation(RefWatchInvocation node) { + visitRefDependencyInvocation(node); + visitRefInvocation(node); + visitProviderListenableExpressionParent(node); + } + + @override + void visitRefReadInvocation(RefReadInvocation node) { + visitRefDependencyInvocation(node); + visitRefInvocation(node); + visitProviderListenableExpressionParent(node); + } + + @override + void visitRefListenInvocation(RefListenInvocation node) { + visitRefDependencyInvocation(node); + visitRefInvocation(node); + visitProviderListenableExpressionParent(node); + } + + @override + void visitResolvedRiverpodLibraryResult(ResolvedRiverpodLibraryResult node) {} + + @override + void visitRiverpodAnnotationDependency(RiverpodAnnotationDependency node) {} + + @override + void visitRiverpodAnnotationDependencies( + RiverpodAnnotationDependencies node) {} + + @override + void visitRiverpodAnnotation(RiverpodAnnotation node) {} + + void visitWidgetRefInvocation(WidgetRefInvocation node) { + visitProviderListenableExpressionParent(node); + } + + @override + void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation node) { + visitWidgetRefInvocation(node); + visitProviderListenableExpressionParent(node); + } + + @override + void visitWidgetRefReadInvocation(WidgetRefReadInvocation node) { + visitWidgetRefInvocation(node); + visitProviderListenableExpressionParent(node); + } + + @override + void visitWidgetRefListenInvocation(WidgetRefListenInvocation node) { + visitWidgetRefInvocation(node); + visitProviderListenableExpressionParent(node); + } + + @override + void visitWidgetRefListenManualInvocation( + WidgetRefListenManualInvocation node) { + visitWidgetRefInvocation(node); + visitProviderListenableExpressionParent(node); + } +} + +abstract class RecursiveRiverpodAstVisitor implements RiverpodAstVisitor { + @override + void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration node) { + node.visitChildren(this); + } + + @override + void visitHookConsumerWidgetDeclaration(HookConsumerWidgetDeclaration node) { + node.visitChildren(this); + } + + @override + void visitConsumerStatefulWidgetDeclaration( + ConsumerStatefulWidgetDeclaration node) { + node.visitChildren(this); + } + + @override + void visitStatefulHookConsumerWidgetDeclaration( + StatefulHookConsumerWidgetDeclaration node) { + node.visitChildren(this); + } + + @override + void visitConsumerStateDeclaration(ConsumerStateDeclaration node) { + node.visitChildren(this); + } + + @override + void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) { + node.visitChildren(this); + } + + @override + void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) { + node.visitChildren(this); + } + + @override + void visitLegacyProviderDependencies(LegacyProviderDependencies node) { + node.visitChildren(this); + } + + @override + void visitLegacyProviderDependency(LegacyProviderDependency node) { + node.visitChildren(this); + } + + @override + void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) { + node.visitChildren(this); + } + + @override + void visitProviderContainerInstanceCreationExpression( + ProviderContainerInstanceCreationExpression node) { + node.visitChildren(this); + } + + @override + void visitProviderListenableExpression(ProviderListenableExpression node) { + node.visitChildren(this); + } + + @override + void visitProviderOverrideExpression(ProviderOverrideExpression node) { + node.visitChildren(this); + } + + @override + void visitProviderOverrideList(ProviderOverrideList node) { + node.visitChildren(this); + } + + @override + void visitProviderScopeInstanceCreationExpression( + ProviderScopeInstanceCreationExpression node) { + node.visitChildren(this); + } + + @override + void visitRefWatchInvocation(RefWatchInvocation node) { + node.visitChildren(this); + } + + @override + void visitRefReadInvocation(RefReadInvocation node) { + node.visitChildren(this); + } + + @override + void visitRefListenInvocation(RefListenInvocation node) { + node.visitChildren(this); + } + + @override + void visitResolvedRiverpodLibraryResult(ResolvedRiverpodLibraryResult node) { + node.visitChildren(this); + } + + @override + void visitRiverpodAnnotationDependency(RiverpodAnnotationDependency node) { + node.visitChildren(this); + } + + @override + void visitRiverpodAnnotationDependencies( + RiverpodAnnotationDependencies node) { + node.visitChildren(this); + } + + @override + void visitRiverpodAnnotation(RiverpodAnnotation node) { + node.visitChildren(this); + } + + @override + void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation node) { + node.visitChildren(this); + } + + @override + void visitWidgetRefReadInvocation(WidgetRefReadInvocation node) { + node.visitChildren(this); + } + + @override + void visitWidgetRefListenInvocation(WidgetRefListenInvocation node) { + node.visitChildren(this); + } + + @override + void visitWidgetRefListenManualInvocation( + WidgetRefListenManualInvocation node) { + node.visitChildren(this); + } +} + +abstract class SimpleRiverpodAstVisitor implements RiverpodAstVisitor { + @override + void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration node) {} + + @override + void visitHookConsumerWidgetDeclaration(HookConsumerWidgetDeclaration node) {} + + @override + void visitConsumerStatefulWidgetDeclaration( + ConsumerStatefulWidgetDeclaration node) {} + + @override + void visitStatefulHookConsumerWidgetDeclaration( + StatefulHookConsumerWidgetDeclaration node) {} + + @override + void visitConsumerStateDeclaration(ConsumerStateDeclaration node) {} + + @override + void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) {} + + @override + void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) {} + + @override + void visitLegacyProviderDependencies(LegacyProviderDependencies node) {} + + @override + void visitLegacyProviderDependency(LegacyProviderDependency node) {} + + @override + void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) {} + + @override + void visitProviderContainerInstanceCreationExpression( + ProviderContainerInstanceCreationExpression node) {} + + @override + void visitProviderListenableExpression(ProviderListenableExpression node) {} + + @override + void visitProviderOverrideExpression(ProviderOverrideExpression node) {} + + @override + void visitProviderOverrideList(ProviderOverrideList node) {} + + @override + void visitProviderScopeInstanceCreationExpression( + ProviderScopeInstanceCreationExpression node) {} + + @override + void visitRefWatchInvocation(RefWatchInvocation node) {} + + @override + void visitRefReadInvocation(RefReadInvocation node) {} + + @override + void visitRefListenInvocation(RefListenInvocation node) {} + + @override + void visitResolvedRiverpodLibraryResult(ResolvedRiverpodLibraryResult node) {} + + @override + void visitRiverpodAnnotationDependency(RiverpodAnnotationDependency node) {} + + @override + void visitRiverpodAnnotationDependencies( + RiverpodAnnotationDependencies node) {} + + @override + void visitRiverpodAnnotation(RiverpodAnnotation node) {} + + @override + void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation node) {} + + @override + void visitWidgetRefReadInvocation(WidgetRefReadInvocation node) {} + + @override + void visitWidgetRefListenInvocation(WidgetRefListenInvocation node) {} + + @override + void visitWidgetRefListenManualInvocation( + WidgetRefListenManualInvocation node) {} +} + +abstract class UnimplementedRiverpodAstVisitor implements RiverpodAstVisitor { + @override + void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration node) { + throw UnimplementedError(); + } + + @override + void visitHookConsumerWidgetDeclaration(HookConsumerWidgetDeclaration node) { + throw UnimplementedError(); + } + + @override + void visitConsumerStatefulWidgetDeclaration( + ConsumerStatefulWidgetDeclaration node) { + throw UnimplementedError(); + } + + @override + void visitStatefulHookConsumerWidgetDeclaration( + StatefulHookConsumerWidgetDeclaration node) { + throw UnimplementedError(); + } + + @override + void visitConsumerStateDeclaration(ConsumerStateDeclaration node) { + throw UnimplementedError(); + } + + @override + void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) { + throw UnimplementedError(); + } + + @override + void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) { + throw UnimplementedError(); + } + + @override + void visitLegacyProviderDependencies(LegacyProviderDependencies node) { + throw UnimplementedError(); + } + + @override + void visitLegacyProviderDependency(LegacyProviderDependency node) { + throw UnimplementedError(); + } + + @override + void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) { + throw UnimplementedError(); + } + + @override + void visitProviderContainerInstanceCreationExpression( + ProviderContainerInstanceCreationExpression node) { + throw UnimplementedError(); + } + + @override + void visitProviderListenableExpression(ProviderListenableExpression node) { + throw UnimplementedError(); + } + + @override + void visitProviderOverrideExpression(ProviderOverrideExpression node) { + throw UnimplementedError(); + } + + @override + void visitProviderOverrideList(ProviderOverrideList node) { + throw UnimplementedError(); + } + + @override + void visitProviderScopeInstanceCreationExpression( + ProviderScopeInstanceCreationExpression node) { + throw UnimplementedError(); + } + + @override + void visitRefWatchInvocation(RefWatchInvocation node) { + throw UnimplementedError(); + } + + @override + void visitRefReadInvocation(RefReadInvocation node) { + throw UnimplementedError(); + } + + @override + void visitRefListenInvocation(RefListenInvocation node) { + throw UnimplementedError(); + } + + @override + void visitResolvedRiverpodLibraryResult(ResolvedRiverpodLibraryResult node) { + throw UnimplementedError(); + } + + @override + void visitRiverpodAnnotationDependency(RiverpodAnnotationDependency node) { + throw UnimplementedError(); + } + + @override + void visitRiverpodAnnotationDependencies( + RiverpodAnnotationDependencies node) { + throw UnimplementedError(); + } + + @override + void visitRiverpodAnnotation(RiverpodAnnotation node) { + throw UnimplementedError(); + } + + @override + void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation node) { + throw UnimplementedError(); + } + + @override + void visitWidgetRefReadInvocation(WidgetRefReadInvocation node) { + throw UnimplementedError(); + } + + @override + void visitWidgetRefListenInvocation(WidgetRefListenInvocation node) { + throw UnimplementedError(); + } + + @override + void visitWidgetRefListenManualInvocation( + WidgetRefListenManualInvocation node) { + throw UnimplementedError(); + } +} + +@internal +class RiverpodAnalysisResult extends GeneralizingRiverpodAstVisitor { + final consumerDeclarations = []; + @override + void visitConsumerDeclaration( + ConsumerDeclaration node, + ) { + super.visitConsumerDeclaration(node); + consumerDeclarations.add(node); + } + + final consumerWidgetDeclarations = []; + @override + void visitConsumerWidgetDeclaration( + ConsumerWidgetDeclaration node, + ) { + super.visitConsumerWidgetDeclaration(node); + consumerWidgetDeclarations.add(node); + } + + final hookConsumerWidgetDeclarations = []; + @override + void visitHookConsumerWidgetDeclaration( + HookConsumerWidgetDeclaration node, + ) { + super.visitHookConsumerWidgetDeclaration(node); + hookConsumerWidgetDeclarations.add(node); + } + + final consumerStatefulWidgetDeclarations = + []; + @override + void visitConsumerStatefulWidgetDeclaration( + ConsumerStatefulWidgetDeclaration node, + ) { + super.visitConsumerStatefulWidgetDeclaration(node); + consumerStatefulWidgetDeclarations.add(node); + } + + final statefulHookConsumerWidgetDeclarations = + []; + @override + void visitStatefulHookConsumerWidgetDeclaration( + StatefulHookConsumerWidgetDeclaration node, + ) { + super.visitStatefulHookConsumerWidgetDeclaration(node); + statefulHookConsumerWidgetDeclarations.add(node); + } + + final consumerStateDeclarations = []; + @override + void visitConsumerStateDeclaration( + ConsumerStateDeclaration node, + ) { + super.visitConsumerStateDeclaration(node); + consumerStateDeclarations.add(node); + } + + final generatorProviderDeclarations = []; + @override + void visitGeneratorProviderDeclaration( + GeneratorProviderDeclaration node, + ) { + super.visitGeneratorProviderDeclaration(node); + generatorProviderDeclarations.add(node); + } + + final classBasedProviderDeclarations = []; + @override + void visitClassBasedProviderDeclaration( + ClassBasedProviderDeclaration node, + ) { + super.visitClassBasedProviderDeclaration(node); + classBasedProviderDeclarations.add(node); + } + + final functionalProviderDeclarations = []; + @override + void visitFunctionalProviderDeclaration( + FunctionalProviderDeclaration node, + ) { + super.visitFunctionalProviderDeclaration(node); + functionalProviderDeclarations.add(node); + } + + final legacyProviderDependenciess = []; + @override + void visitLegacyProviderDependencies( + LegacyProviderDependencies node, + ) { + super.visitLegacyProviderDependencies(node); + legacyProviderDependenciess.add(node); + } + + final legacyProviderDependencys = []; + @override + void visitLegacyProviderDependency( + LegacyProviderDependency node, + ) { + super.visitLegacyProviderDependency(node); + legacyProviderDependencys.add(node); + } + + final legacyProviderDeclarations = []; + @override + void visitLegacyProviderDeclaration( + LegacyProviderDeclaration node, + ) { + super.visitLegacyProviderDeclaration(node); + legacyProviderDeclarations.add(node); + } + + final providerContainerInstanceCreationExpressions = + []; + @override + void visitProviderContainerInstanceCreationExpression( + ProviderContainerInstanceCreationExpression node, + ) { + super.visitProviderContainerInstanceCreationExpression(node); + providerContainerInstanceCreationExpressions.add(node); + } + + final providerDeclarations = []; + @override + void visitProviderDeclaration( + ProviderDeclaration node, + ) { + super.visitProviderDeclaration(node); + providerDeclarations.add(node); + } + + final providerListenableExpressionParents = + []; + @override + void visitProviderListenableExpressionParent( + ProviderListenableExpressionParent node, + ) { + super.visitProviderListenableExpressionParent(node); + providerListenableExpressionParents.add(node); + } + + final providerListenableExpressions = []; + @override + void visitProviderListenableExpression( + ProviderListenableExpression node, + ) { + super.visitProviderListenableExpression(node); + providerListenableExpressions.add(node); + } + + final providerOverrideExpressions = []; + @override + void visitProviderOverrideExpression( + ProviderOverrideExpression node, + ) { + super.visitProviderOverrideExpression(node); + providerOverrideExpressions.add(node); + } + + final providerOverrideLists = []; + @override + void visitProviderOverrideList( + ProviderOverrideList node, + ) { + super.visitProviderOverrideList(node); + providerOverrideLists.add(node); + } + + final providerScopeInstanceCreationExpressions = + []; + @override + void visitProviderScopeInstanceCreationExpression( + ProviderScopeInstanceCreationExpression node, + ) { + super.visitProviderScopeInstanceCreationExpression(node); + providerScopeInstanceCreationExpressions.add(node); + } + + final refInvocations = []; + @override + void visitRefInvocation( + RefInvocation node, + ) { + super.visitRefInvocation(node); + refInvocations.add(node); + } + + final refDependencyInvocations = []; + @override + void visitRefDependencyInvocation( + RefDependencyInvocation node, + ) { + super.visitRefDependencyInvocation(node); + refDependencyInvocations.add(node); + } + + final refWatchInvocations = []; + @override + void visitRefWatchInvocation( + RefWatchInvocation node, + ) { + super.visitRefWatchInvocation(node); + refWatchInvocations.add(node); + } + + final refReadInvocations = []; + @override + void visitRefReadInvocation( + RefReadInvocation node, + ) { + super.visitRefReadInvocation(node); + refReadInvocations.add(node); + } + + final refListenInvocations = []; + @override + void visitRefListenInvocation( + RefListenInvocation node, + ) { + super.visitRefListenInvocation(node); + refListenInvocations.add(node); + } + + final resolvedRiverpodLibraryResults = []; + @override + void visitResolvedRiverpodLibraryResult( + ResolvedRiverpodLibraryResult node, + ) { + super.visitResolvedRiverpodLibraryResult(node); + resolvedRiverpodLibraryResults.add(node); + } + + final riverpodAnnotationDependencys = []; + @override + void visitRiverpodAnnotationDependency( + RiverpodAnnotationDependency node, + ) { + super.visitRiverpodAnnotationDependency(node); + riverpodAnnotationDependencys.add(node); + } + + final riverpodAnnotationDependenciess = []; + @override + void visitRiverpodAnnotationDependencies( + RiverpodAnnotationDependencies node, + ) { + super.visitRiverpodAnnotationDependencies(node); + riverpodAnnotationDependenciess.add(node); + } + + final riverpodAnnotations = []; + @override + void visitRiverpodAnnotation( + RiverpodAnnotation node, + ) { + super.visitRiverpodAnnotation(node); + riverpodAnnotations.add(node); + } + + final widgetRefInvocations = []; + @override + void visitWidgetRefInvocation( + WidgetRefInvocation node, + ) { + super.visitWidgetRefInvocation(node); + widgetRefInvocations.add(node); + } + + final widgetRefWatchInvocations = []; + @override + void visitWidgetRefWatchInvocation( + WidgetRefWatchInvocation node, + ) { + super.visitWidgetRefWatchInvocation(node); + widgetRefWatchInvocations.add(node); + } + + final widgetRefReadInvocations = []; + @override + void visitWidgetRefReadInvocation( + WidgetRefReadInvocation node, + ) { + super.visitWidgetRefReadInvocation(node); + widgetRefReadInvocations.add(node); + } + + final widgetRefListenInvocations = []; + @override + void visitWidgetRefListenInvocation( + WidgetRefListenInvocation node, + ) { + super.visitWidgetRefListenInvocation(node); + widgetRefListenInvocations.add(node); + } + + final widgetRefListenManualInvocations = []; + @override + void visitWidgetRefListenManualInvocation( + WidgetRefListenManualInvocation node, + ) { + super.visitWidgetRefListenManualInvocation(node); + widgetRefListenManualInvocations.add(node); + } +} + +class _RiverpodAstRegistryVisitor extends GeneralizingRiverpodAstVisitor { + _RiverpodAstRegistryVisitor(this._registry); + + final RiverpodAstRegistry _registry; + + void _runSubscriptions( + R value, + List subscriptions, + ) { + for (final sub in subscriptions) { + try { + sub(value); + } catch (e, stack) { + Zone.current.handleUncaughtError(e, stack); + } + } + } + + @override + void visitRiverpodAst(RiverpodAst node) { + node.visitChildren(this); + } + + @override + void visitConsumerDeclaration(ConsumerDeclaration node) { + super.visitConsumerDeclaration(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onConsumerDeclaration, + ); + } + + @override + void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration node) { + super.visitConsumerWidgetDeclaration(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onConsumerWidgetDeclaration, + ); + } + + @override + void visitHookConsumerWidgetDeclaration(HookConsumerWidgetDeclaration node) { + super.visitHookConsumerWidgetDeclaration(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onHookConsumerWidgetDeclaration, + ); + } + + @override + void visitConsumerStatefulWidgetDeclaration( + ConsumerStatefulWidgetDeclaration node) { + super.visitConsumerStatefulWidgetDeclaration(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onConsumerStatefulWidgetDeclaration, + ); + } + + @override + void visitStatefulHookConsumerWidgetDeclaration( + StatefulHookConsumerWidgetDeclaration node) { + super.visitStatefulHookConsumerWidgetDeclaration(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onStatefulHookConsumerWidgetDeclaration, + ); + } + + @override + void visitConsumerStateDeclaration(ConsumerStateDeclaration node) { + super.visitConsumerStateDeclaration(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onConsumerStateDeclaration, + ); + } + + @override + void visitGeneratorProviderDeclaration(GeneratorProviderDeclaration node) { + super.visitGeneratorProviderDeclaration(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onGeneratorProviderDeclaration, + ); + } + + @override + void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) { + super.visitClassBasedProviderDeclaration(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onClassBasedProviderDeclaration, + ); + } + + @override + void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) { + super.visitFunctionalProviderDeclaration(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onFunctionalProviderDeclaration, + ); + } + + @override + void visitLegacyProviderDependencies(LegacyProviderDependencies node) { + super.visitLegacyProviderDependencies(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onLegacyProviderDependencies, + ); + } + + @override + void visitLegacyProviderDependency(LegacyProviderDependency node) { + super.visitLegacyProviderDependency(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onLegacyProviderDependency, + ); + } + + @override + void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) { + super.visitLegacyProviderDeclaration(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onLegacyProviderDeclaration, + ); + } + + @override + void visitProviderContainerInstanceCreationExpression( + ProviderContainerInstanceCreationExpression node) { + super.visitProviderContainerInstanceCreationExpression(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onProviderContainerInstanceCreationExpression, + ); + } + + @override + void visitProviderDeclaration(ProviderDeclaration node) { + super.visitProviderDeclaration(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onProviderDeclaration, + ); + } + + @override + void visitProviderListenableExpressionParent( + ProviderListenableExpressionParent node) { + super.visitProviderListenableExpressionParent(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onProviderListenableExpressionParent, + ); + } + + @override + void visitProviderListenableExpression(ProviderListenableExpression node) { + super.visitProviderListenableExpression(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onProviderListenableExpression, + ); + } + + @override + void visitProviderOverrideExpression(ProviderOverrideExpression node) { + super.visitProviderOverrideExpression(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onProviderOverrideExpression, + ); + } + + @override + void visitProviderOverrideList(ProviderOverrideList node) { + super.visitProviderOverrideList(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onProviderOverrideList, + ); + } + + @override + void visitProviderScopeInstanceCreationExpression( + ProviderScopeInstanceCreationExpression node) { + super.visitProviderScopeInstanceCreationExpression(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onProviderScopeInstanceCreationExpression, + ); + } + + @override + void visitRefInvocation(RefInvocation node) { + super.visitRefInvocation(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onRefInvocation, + ); + } + + @override + void visitRefDependencyInvocation(RefDependencyInvocation node) { + super.visitRefDependencyInvocation(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onRefDependencyInvocation, + ); + } + + @override + void visitRefWatchInvocation(RefWatchInvocation node) { + super.visitRefWatchInvocation(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onRefWatchInvocation, + ); + } + + @override + void visitRefReadInvocation(RefReadInvocation node) { + super.visitRefReadInvocation(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onRefReadInvocation, + ); + } + + @override + void visitRefListenInvocation(RefListenInvocation node) { + super.visitRefListenInvocation(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onRefListenInvocation, + ); + } + + @override + void visitResolvedRiverpodLibraryResult(ResolvedRiverpodLibraryResult node) { + super.visitResolvedRiverpodLibraryResult(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onResolvedRiverpodLibraryResult, + ); + } + + @override + void visitRiverpodAnnotationDependency(RiverpodAnnotationDependency node) { + super.visitRiverpodAnnotationDependency(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onRiverpodAnnotationDependency, + ); + } + + @override + void visitRiverpodAnnotationDependencies( + RiverpodAnnotationDependencies node) { + super.visitRiverpodAnnotationDependencies(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onRiverpodAnnotationDependencies, + ); + } + + @override + void visitRiverpodAnnotation(RiverpodAnnotation node) { + super.visitRiverpodAnnotation(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onRiverpodAnnotation, + ); + } + + @override + void visitWidgetRefInvocation(WidgetRefInvocation node) { + super.visitWidgetRefInvocation(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onWidgetRefInvocation, + ); + } + + @override + void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation node) { + super.visitWidgetRefWatchInvocation(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onWidgetRefWatchInvocation, + ); + } + + @override + void visitWidgetRefReadInvocation(WidgetRefReadInvocation node) { + super.visitWidgetRefReadInvocation(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onWidgetRefReadInvocation, + ); + } + + @override + void visitWidgetRefListenInvocation(WidgetRefListenInvocation node) { + super.visitWidgetRefListenInvocation(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onWidgetRefListenInvocation, + ); + } + + @override + void visitWidgetRefListenManualInvocation( + WidgetRefListenManualInvocation node) { + super.visitWidgetRefListenManualInvocation(node); + node.visitChildren(this); + _runSubscriptions( + node, + _registry._onWidgetRefListenManualInvocation, + ); + } +} + +class RiverpodAstRegistry { + void run(RiverpodAst node) { + node.accept(_RiverpodAstRegistryVisitor(this)); + } + + final _onRiverpodAst = []; + void addRiverpodAst(void Function(RiverpodAst node) cb) { + _onRiverpodAst.add(cb); + } + + final _onConsumerDeclaration = []; + void addConsumerDeclaration(void Function(ConsumerDeclaration node) cb) { + _onConsumerDeclaration.add(cb); + } + + final _onConsumerWidgetDeclaration = + []; + void addConsumerWidgetDeclaration( + void Function(ConsumerWidgetDeclaration node) cb) { + _onConsumerWidgetDeclaration.add(cb); + } + + final _onHookConsumerWidgetDeclaration = + []; + void addHookConsumerWidgetDeclaration( + void Function(HookConsumerWidgetDeclaration node) cb) { + _onHookConsumerWidgetDeclaration.add(cb); + } + + final _onConsumerStatefulWidgetDeclaration = + []; + void addConsumerStatefulWidgetDeclaration( + void Function(ConsumerStatefulWidgetDeclaration node) cb) { + _onConsumerStatefulWidgetDeclaration.add(cb); + } + + final _onStatefulHookConsumerWidgetDeclaration = + []; + void addStatefulHookConsumerWidgetDeclaration( + void Function(StatefulHookConsumerWidgetDeclaration node) cb) { + _onStatefulHookConsumerWidgetDeclaration.add(cb); + } + + final _onConsumerStateDeclaration = + []; + void addConsumerStateDeclaration( + void Function(ConsumerStateDeclaration node) cb) { + _onConsumerStateDeclaration.add(cb); + } + + final _onGeneratorProviderDeclaration = + []; + void addGeneratorProviderDeclaration( + void Function(GeneratorProviderDeclaration node) cb) { + _onGeneratorProviderDeclaration.add(cb); + } + + final _onClassBasedProviderDeclaration = + []; + void addClassBasedProviderDeclaration( + void Function(ClassBasedProviderDeclaration node) cb) { + _onClassBasedProviderDeclaration.add(cb); + } + + final _onFunctionalProviderDeclaration = + []; + void addFunctionalProviderDeclaration( + void Function(FunctionalProviderDeclaration node) cb) { + _onFunctionalProviderDeclaration.add(cb); + } + + final _onLegacyProviderDependencies = + []; + void addLegacyProviderDependencies( + void Function(LegacyProviderDependencies node) cb) { + _onLegacyProviderDependencies.add(cb); + } + + final _onLegacyProviderDependency = + []; + void addLegacyProviderDependency( + void Function(LegacyProviderDependency node) cb) { + _onLegacyProviderDependency.add(cb); + } + + final _onLegacyProviderDeclaration = + []; + void addLegacyProviderDeclaration( + void Function(LegacyProviderDeclaration node) cb) { + _onLegacyProviderDeclaration.add(cb); + } + + final _onProviderContainerInstanceCreationExpression = + []; + void addProviderContainerInstanceCreationExpression( + void Function(ProviderContainerInstanceCreationExpression node) cb) { + _onProviderContainerInstanceCreationExpression.add(cb); + } + + final _onProviderDeclaration = []; + void addProviderDeclaration(void Function(ProviderDeclaration node) cb) { + _onProviderDeclaration.add(cb); + } + + final _onProviderListenableExpressionParent = + []; + void addProviderListenableExpressionParent( + void Function(ProviderListenableExpressionParent node) cb) { + _onProviderListenableExpressionParent.add(cb); + } + + final _onProviderListenableExpression = + []; + void addProviderListenableExpression( + void Function(ProviderListenableExpression node) cb) { + _onProviderListenableExpression.add(cb); + } + + final _onProviderOverrideExpression = + []; + void addProviderOverrideExpression( + void Function(ProviderOverrideExpression node) cb) { + _onProviderOverrideExpression.add(cb); + } + + final _onProviderOverrideList = []; + void addProviderOverrideList(void Function(ProviderOverrideList node) cb) { + _onProviderOverrideList.add(cb); + } + + final _onProviderScopeInstanceCreationExpression = + []; + void addProviderScopeInstanceCreationExpression( + void Function(ProviderScopeInstanceCreationExpression node) cb) { + _onProviderScopeInstanceCreationExpression.add(cb); + } + + final _onRefInvocation = []; + void addRefInvocation(void Function(RefInvocation node) cb) { + _onRefInvocation.add(cb); + } + + final _onRefDependencyInvocation = []; + void addRefDependencyInvocation( + void Function(RefDependencyInvocation node) cb) { + _onRefDependencyInvocation.add(cb); + } + + final _onRefWatchInvocation = []; + void addRefWatchInvocation(void Function(RefWatchInvocation node) cb) { + _onRefWatchInvocation.add(cb); + } + + final _onRefReadInvocation = []; + void addRefReadInvocation(void Function(RefReadInvocation node) cb) { + _onRefReadInvocation.add(cb); + } + + final _onRefListenInvocation = []; + void addRefListenInvocation(void Function(RefListenInvocation node) cb) { + _onRefListenInvocation.add(cb); + } + + final _onResolvedRiverpodLibraryResult = + []; + void addResolvedRiverpodLibraryResult( + void Function(ResolvedRiverpodLibraryResult node) cb) { + _onResolvedRiverpodLibraryResult.add(cb); + } + + final _onRiverpodAnnotationDependency = + []; + void addRiverpodAnnotationDependency( + void Function(RiverpodAnnotationDependency node) cb) { + _onRiverpodAnnotationDependency.add(cb); + } + + final _onRiverpodAnnotationDependencies = + []; + void addRiverpodAnnotationDependencies( + void Function(RiverpodAnnotationDependencies node) cb) { + _onRiverpodAnnotationDependencies.add(cb); + } + + final _onRiverpodAnnotation = []; + void addRiverpodAnnotation(void Function(RiverpodAnnotation node) cb) { + _onRiverpodAnnotation.add(cb); + } + + final _onWidgetRefInvocation = []; + void addWidgetRefInvocation(void Function(WidgetRefInvocation node) cb) { + _onWidgetRefInvocation.add(cb); + } + + final _onWidgetRefWatchInvocation = + []; + void addWidgetRefWatchInvocation( + void Function(WidgetRefWatchInvocation node) cb) { + _onWidgetRefWatchInvocation.add(cb); + } + + final _onWidgetRefReadInvocation = []; + void addWidgetRefReadInvocation( + void Function(WidgetRefReadInvocation node) cb) { + _onWidgetRefReadInvocation.add(cb); + } + + final _onWidgetRefListenInvocation = + []; + void addWidgetRefListenInvocation( + void Function(WidgetRefListenInvocation node) cb) { + _onWidgetRefListenInvocation.add(cb); + } + + final _onWidgetRefListenManualInvocation = + []; + void addWidgetRefListenManualInvocation( + void Function(WidgetRefListenManualInvocation node) cb) { + _onWidgetRefListenManualInvocation.add(cb); + } +} + +// ignore_for_file: type=lint diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/consumer.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/consumer.dart index d5eafca21..1ac965869 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/consumer.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/consumer.dart @@ -1,6 +1,7 @@ part of '../riverpod_ast.dart'; -abstract class ConsumerDeclaration extends RiverpodAst { +abstract base class ConsumerDeclaration extends RiverpodAst + with _$ConsumerDeclaration { static ConsumerDeclaration? _parse( ClassDeclaration node, _ParseRefInvocationMixin parent, @@ -28,7 +29,8 @@ abstract class ConsumerDeclaration extends RiverpodAst { ClassDeclaration get node; } -class ConsumerWidgetDeclaration extends ConsumerDeclaration { +final class ConsumerWidgetDeclaration extends ConsumerDeclaration + with _$ConsumerWidgetDeclaration { ConsumerWidgetDeclaration._({ required this.buildMethod, required this.node, @@ -59,27 +61,14 @@ class ConsumerWidgetDeclaration extends ConsumerDeclaration { } final MethodDeclaration? buildMethod; + @override final List widgetRefInvocations = []; + @override final List providerScopeInstanceCreateExpressions = []; @override final ClassDeclaration node; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitConsumerWidgetDeclaration(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - for (final invocation in widgetRefInvocations) { - invocation.accept(visitor); - } - for (final expression in providerScopeInstanceCreateExpressions) { - expression.accept(visitor); - } - } } class _ParseConsumerRefInvocationVisitor extends RecursiveAstVisitor @@ -125,7 +114,8 @@ class _ParseConsumerRefInvocationVisitor extends RecursiveAstVisitor } } -class HookConsumerWidgetDeclaration extends ConsumerDeclaration { +final class HookConsumerWidgetDeclaration extends ConsumerDeclaration + with _$HookConsumerWidgetDeclaration { HookConsumerWidgetDeclaration({ required this.buildMethod, required this.node, @@ -156,30 +146,18 @@ class HookConsumerWidgetDeclaration extends ConsumerDeclaration { } final MethodDeclaration? buildMethod; + @override final List widgetRefInvocations = []; + @override final List providerScopeInstanceCreateExpressions = []; @override final ClassDeclaration node; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitHookConsumerWidgetDeclaration(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - for (final invocation in widgetRefInvocations) { - invocation.accept(visitor); - } - for (final expression in providerScopeInstanceCreateExpressions) { - expression.accept(visitor); - } - } } -class ConsumerStatefulWidgetDeclaration extends ConsumerDeclaration { +final class ConsumerStatefulWidgetDeclaration extends ConsumerDeclaration + with _$ConsumerStatefulWidgetDeclaration { ConsumerStatefulWidgetDeclaration._({required this.node}); ConsumerStatefulWidgetDeclaration.parse(ClassDeclaration node) @@ -187,17 +165,10 @@ class ConsumerStatefulWidgetDeclaration extends ConsumerDeclaration { @override final ClassDeclaration node; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitConsumerStatefulWidgetDeclaration(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) {} } -class StatefulHookConsumerWidgetDeclaration extends ConsumerDeclaration { +final class StatefulHookConsumerWidgetDeclaration extends ConsumerDeclaration + with _$StatefulHookConsumerWidgetDeclaration { StatefulHookConsumerWidgetDeclaration._({required this.node}); StatefulHookConsumerWidgetDeclaration.parse(ClassDeclaration node) @@ -205,17 +176,10 @@ class StatefulHookConsumerWidgetDeclaration extends ConsumerDeclaration { @override final ClassDeclaration node; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitStatefulHookConsumerWidgetDeclaration(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) {} } -class ConsumerStateDeclaration extends ConsumerDeclaration { +final class ConsumerStateDeclaration extends ConsumerDeclaration + with _$ConsumerStateDeclaration { ConsumerStateDeclaration._({ required this.node, }); @@ -239,25 +203,12 @@ class ConsumerStateDeclaration extends ConsumerDeclaration { return consumerWidgetDeclaration; } + @override final List widgetRefInvocations = []; + @override final List providerScopeInstanceCreateExpressions = []; @override final ClassDeclaration node; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitConsumerStateDeclaration(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - for (final invocation in widgetRefInvocations) { - invocation.accept(visitor); - } - for (final expression in providerScopeInstanceCreateExpressions) { - expression.accept(visitor); - } - } } diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart index 81451bdfa..f91f60353 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart @@ -59,9 +59,11 @@ extension on LibraryElement { } // TODO changelog made sealed -sealed class GeneratorProviderDeclaration extends ProviderDeclaration { +sealed class GeneratorProviderDeclaration extends ProviderDeclaration + with _$GeneratorProviderDeclaration { @override GeneratorProviderDeclarationElement get providerElement; + @override RiverpodAnnotation get annotation; String get valueTypeDisplayString => valueTypeNode?.toSource() ?? 'Object?'; @@ -82,6 +84,7 @@ sealed class GeneratorProviderDeclaration extends ProviderDeclaration { SourcedType? get exposedTypeNode; TypeAnnotation? get createdTypeNode; + @override final List refInvocations = []; String computeProviderHash() { @@ -92,14 +95,6 @@ sealed class GeneratorProviderDeclaration extends ProviderDeclaration { final digest = sha1.convert(bytes); return digest.toString(); } - - @mustCallSuper - @override - void visitChildren(RiverpodAstVisitor visitor) { - for (final refInvocation in refInvocations) { - refInvocation.accept(visitor); - } - } } SourcedType? _computeExposedType( @@ -179,7 +174,8 @@ TypeAnnotation? _getValueType( typedef SourcedType = ({String? source, DartType dartType}); -class ClassBasedProviderDeclaration extends GeneratorProviderDeclaration { +final class ClassBasedProviderDeclaration extends GeneratorProviderDeclaration + with _$ClassBasedProviderDeclaration { ClassBasedProviderDeclaration._({ required this.name, required this.node, @@ -305,17 +301,6 @@ class ClassBasedProviderDeclaration extends GeneratorProviderDeclaration { final TypeAnnotation? valueTypeNode; @override final SourcedType exposedTypeNode; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitClassBasedProviderDeclaration(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - annotation.accept(visitor); - } } class _GeneratorRefInvocationVisitor extends RecursiveAstVisitor @@ -351,7 +336,8 @@ class _GeneratorRefInvocationVisitor extends RecursiveAstVisitor } } -class FunctionalProviderDeclaration extends GeneratorProviderDeclaration { +final class FunctionalProviderDeclaration extends GeneratorProviderDeclaration + with _$FunctionalProviderDeclaration { FunctionalProviderDeclaration._({ required this.name, required this.node, @@ -424,15 +410,4 @@ class FunctionalProviderDeclaration extends GeneratorProviderDeclaration { /// external int count(); /// ``` bool get needsOverride => node.externalKeyword != null; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitFunctionalProviderDeclaration(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - annotation.accept(visitor); - } } diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/legacy_provider_declaration.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/legacy_provider_declaration.dart index 65b71b06a..3b116b085 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/legacy_provider_declaration.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/legacy_provider_declaration.dart @@ -1,6 +1,7 @@ part of '../riverpod_ast.dart'; -class LegacyProviderDependencies extends RiverpodAst { +final class LegacyProviderDependencies extends RiverpodAst + with _$LegacyProviderDependencies { LegacyProviderDependencies._({ required this.dependencies, required this.dependenciesNode, @@ -28,26 +29,13 @@ class LegacyProviderDependencies extends RiverpodAst { return legacyProviderDependencies; } + @override final List? dependencies; final NamedExpression dependenciesNode; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitLegacyProviderDependencies(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - final dependencies = this.dependencies; - if (dependencies != null) { - for (final dependency in dependencies) { - dependency.accept(visitor); - } - } - } } -class LegacyProviderDependency extends RiverpodAst +final class LegacyProviderDependency extends RiverpodAst + with _$LegacyProviderDependency implements ProviderListenableExpressionParent { LegacyProviderDependency._({ required this.node, @@ -67,20 +55,12 @@ class LegacyProviderDependency extends RiverpodAst } final CollectionElement node; - final ProviderListenableExpression? provider; - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitLegacyProviderDependency(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - provider?.accept(visitor); - } + final ProviderListenableExpression? provider; } -class LegacyProviderDeclaration extends RiverpodAst +final class LegacyProviderDeclaration extends RiverpodAst + with _$LegacyProviderDeclaration implements ProviderDeclaration { LegacyProviderDeclaration._({ required this.name, @@ -189,6 +169,7 @@ class LegacyProviderDeclaration extends RiverpodAst return legacyProviderDeclaration; } + @override final LegacyProviderDependencies? dependencies; final FunctionExpression build; @@ -201,6 +182,7 @@ class LegacyProviderDeclaration extends RiverpodAst @override final LegacyProviderDeclarationElement providerElement; + @override final List refInvocations = []; @override @@ -208,19 +190,6 @@ class LegacyProviderDeclaration extends RiverpodAst @override final VariableDeclaration node; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitLegacyProviderDeclaration(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - dependencies?.accept(visitor); - for (final refInvocation in refInvocations) { - refInvocation.accept(visitor); - } - } } class _LegacyRefInvocationVisitor extends RecursiveAstVisitor diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_container_instance_creation_expression.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_container_instance_creation_expression.dart index 034f26c59..1d64fc662 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_container_instance_creation_expression.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_container_instance_creation_expression.dart @@ -1,6 +1,7 @@ part of '../riverpod_ast.dart'; -class ProviderContainerInstanceCreationExpression extends RiverpodAst { +final class ProviderContainerInstanceCreationExpression extends RiverpodAst + with _$ProviderContainerInstanceCreationExpression { ProviderContainerInstanceCreationExpression._({ required this.node, required this.overrides, @@ -26,15 +27,6 @@ class ProviderContainerInstanceCreationExpression extends RiverpodAst { } final InstanceCreationExpression node; - final ProviderOverrideList? overrides; - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitProviderContainerInstanceCreationExpression(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - overrides?.accept(visitor); - } + final ProviderOverrideList? overrides; } diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_declaration.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_declaration.dart index 8c0de4207..47b45f5c6 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_declaration.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_declaration.dart @@ -1,6 +1,7 @@ part of '../riverpod_ast.dart'; -abstract class ProviderDeclaration extends RiverpodAst { +abstract base class ProviderDeclaration extends RiverpodAst + with _$ProviderDeclaration { Token get name; AnnotatedNode get node; ProviderDeclarationElement get providerElement; diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_listenable_expression.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_listenable_expression.dart index 6c0d05f5e..487c6d0d9 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_listenable_expression.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_listenable_expression.dart @@ -1,8 +1,10 @@ part of '../riverpod_ast.dart'; -abstract class ProviderListenableExpressionParent implements RiverpodAst {} +abstract base class ProviderListenableExpressionParent extends RiverpodAst + with _$ProviderListenableExpressionParent {} -class ProviderListenableExpression extends RiverpodAst { +final class ProviderListenableExpression extends RiverpodAst + with _$ProviderListenableExpression { ProviderListenableExpression._({ required this.node, required this.provider, @@ -112,12 +114,4 @@ class ProviderListenableExpression extends RiverpodAst { /// If [provider] is a provider with arguments (family), represents the arguments /// passed to the provider. final ArgumentList? familyArguments; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitProviderListenableExpression(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) {} } diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_override.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_override.dart index 9b6ff4bcd..0a0d28522 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_override.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_override.dart @@ -1,6 +1,7 @@ part of '../riverpod_ast.dart'; -class ProviderOverrideExpression extends RiverpodAst { +final class ProviderOverrideExpression extends RiverpodAst + with _$ProviderOverrideExpression { ProviderOverrideExpression._({ required this.expression, required this.providerElement, @@ -35,17 +36,10 @@ class ProviderOverrideExpression extends RiverpodAst { /// If [provider] is a provider with arguments (family), represents the arguments /// passed to the provider. final ArgumentList? familyArguments; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitProviderOverrideExpression(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) {} } -class ProviderOverrideList extends RiverpodAst { +final class ProviderOverrideList extends RiverpodAst + with _$ProviderOverrideList { ProviderOverrideList._({ required this.node, required this.overrides, @@ -73,15 +67,6 @@ class ProviderOverrideList extends RiverpodAst { } final NamedExpression node; - final List? overrides; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitProviderOverrideList(this); - } - @override - void visitChildren(RiverpodAstVisitor visitor) { - overrides?.forEach((e) => e.accept(visitor)); - } + final List? overrides; } diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_scope.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_scope.dart index c0bc19ae1..14df9850e 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_scope.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_scope.dart @@ -1,6 +1,7 @@ part of '../riverpod_ast.dart'; -class ProviderScopeInstanceCreationExpression extends RiverpodAst { +final class ProviderScopeInstanceCreationExpression extends RiverpodAst + with _$ProviderScopeInstanceCreationExpression { ProviderScopeInstanceCreationExpression._({ required this.node, required this.overrides, @@ -25,15 +26,6 @@ class ProviderScopeInstanceCreationExpression extends RiverpodAst { } final InstanceCreationExpression node; - final ProviderOverrideList? overrides; - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitProviderScopeInstanceCreationExpression(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - overrides?.accept(visitor); - } + final ProviderOverrideList? overrides; } diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/ref_invocation.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/ref_invocation.dart index 5d10f567e..87592b273 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/ref_invocation.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/ref_invocation.dart @@ -1,6 +1,7 @@ part of '../riverpod_ast.dart'; -abstract class RefInvocation extends RiverpodAst +abstract base class RefInvocation extends RiverpodAst + with _$RefInvocation implements ProviderListenableExpressionParent { RefInvocation._({ required this.node, @@ -61,7 +62,8 @@ abstract class RefInvocation extends RiverpodAst } /// A [RefInvocation] which interacts with a provider, inducing a dependency. -abstract class RefDependencyInvocation extends RefInvocation { +abstract base class RefDependencyInvocation extends RefInvocation + with _$RefDependencyInvocation { RefDependencyInvocation._({ required super.node, required super.function, @@ -69,10 +71,12 @@ abstract class RefDependencyInvocation extends RefInvocation { }) : super._(); /// The provider that is being interacted with. + @override final ProviderListenableExpression provider; } -class RefWatchInvocation extends RefDependencyInvocation { +final class RefWatchInvocation extends RefDependencyInvocation + with _$RefWatchInvocation { RefWatchInvocation._({ required super.node, required super.function, @@ -102,19 +106,10 @@ class RefWatchInvocation extends RefDependencyInvocation { providerListenableExpression._parent = refWatchInvocation; return refWatchInvocation; } - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitRefWatchInvocation(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - provider.accept(visitor); - } } -class RefReadInvocation extends RefDependencyInvocation { +final class RefReadInvocation extends RefDependencyInvocation + with _$RefReadInvocation { RefReadInvocation._({ required super.node, required super.function, @@ -144,19 +139,10 @@ class RefReadInvocation extends RefDependencyInvocation { providerListenableExpression._parent = refReadInvocation; return refReadInvocation; } - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitRefReadInvocation(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - provider.accept(visitor); - } } -class RefListenInvocation extends RefDependencyInvocation { +final class RefListenInvocation extends RefDependencyInvocation + with _$RefListenInvocation { RefListenInvocation._({ required super.node, required super.function, @@ -195,14 +181,4 @@ class RefListenInvocation extends RefDependencyInvocation { } final Expression listener; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitRefListenInvocation(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - provider.accept(visitor); - } } diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/resolve_riverpod.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/resolve_riverpod.dart index fd3a22617..b1706dc26 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/resolve_riverpod.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/resolve_riverpod.dart @@ -1,6 +1,7 @@ part of '../riverpod_ast.dart'; -class ResolvedRiverpodLibraryResult extends RiverpodAst { +final class ResolvedRiverpodLibraryResult extends RiverpodAst + with _$ResolvedRiverpodLibraryResult { ResolvedRiverpodLibraryResult._(); factory ResolvedRiverpodLibraryResult.from( @@ -30,76 +31,43 @@ class ResolvedRiverpodLibraryResult extends RiverpodAst { final errors = []; + @override final providerScopeInstanceCreationExpressions = []; + @override final providerContainerInstanceCreationExpressions = []; + @override final functionalProviderDeclarations = []; + @override final classBasedProviderDeclarations = []; + @override final legacyProviderDeclarations = []; + @override final consumerWidgetDeclarations = []; + @override final consumerStatefulWidgetDeclarations = []; + @override final consumerStateDeclaration = []; + @override final statefulHookConsumerWidgetDeclarations = []; + @override final hookConsumerWidgetDeclarations = []; + @override final unknownRefInvocations = []; + @override final unknownWidgetRefInvocations = []; @override Null get parent => null; - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitResolvedRiverpodUnit(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - for (final declaration in providerScopeInstanceCreationExpressions) { - declaration.accept(visitor); - } - for (final declaration in providerContainerInstanceCreationExpressions) { - declaration.accept(visitor); - } - - for (final declaration in functionalProviderDeclarations) { - declaration.accept(visitor); - } - for (final declaration in classBasedProviderDeclarations) { - declaration.accept(visitor); - } - for (final declaration in legacyProviderDeclarations) { - declaration.accept(visitor); - } - for (final declaration in consumerWidgetDeclarations) { - declaration.accept(visitor); - } - for (final declaration in consumerStatefulWidgetDeclarations) { - declaration.accept(visitor); - } - for (final declaration in consumerStateDeclaration) { - declaration.accept(visitor); - } - for (final declaration in statefulHookConsumerWidgetDeclarations) { - declaration.accept(visitor); - } - for (final declaration in hookConsumerWidgetDeclarations) { - declaration.accept(visitor); - } - - for (final invocation in unknownRefInvocations) { - invocation.accept(visitor); - } - for (final invocation in unknownWidgetRefInvocations) { - invocation.accept(visitor); - } - } + // TODO changelog breaking renamed visitResolvedRiverpodLibraryResult } mixin _ParseRefInvocationMixin on RecursiveAstVisitor { diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart index 6629f4b25..145a67b70 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart @@ -1,6 +1,7 @@ part of '../riverpod_ast.dart'; -class RiverpodAnnotationDependency extends RiverpodAst { +final class RiverpodAnnotationDependency extends RiverpodAst + with _$RiverpodAnnotationDependency { RiverpodAnnotationDependency._({ required this.node, required this.provider, @@ -8,42 +9,21 @@ class RiverpodAnnotationDependency extends RiverpodAst { final Expression node; final GeneratorProviderDeclarationElement provider; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitRiverpodAnnotationDependency(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) {} } -class RiverpodAnnotationDependencies extends RiverpodAst { +final class RiverpodAnnotationDependencies extends RiverpodAst + with _$RiverpodAnnotationDependencies { RiverpodAnnotationDependencies._({ required this.node, required this.dependencies, }); final NamedExpression node; - final List? dependencies; - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitRiverpodAnnotationDependencies(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - final dependencies = this.dependencies; - if (dependencies != null) { - for (final dependency in dependencies) { - dependency.accept(visitor); - } - } - } + final List? dependencies; } -class RiverpodAnnotation extends RiverpodAst { +final class RiverpodAnnotation extends RiverpodAst with _$RiverpodAnnotation { RiverpodAnnotation._({ required this.annotation, required this.element, @@ -218,15 +198,6 @@ class RiverpodAnnotation extends RiverpodAst { final Annotation annotation; final RiverpodAnnotationElement element; final NamedExpression? keepAliveNode; - final RiverpodAnnotationDependencies? dependencies; - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitRiverpodAnnotation(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - dependencies?.accept(visitor); - } + final RiverpodAnnotationDependencies? dependencies; } diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/visitor.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/visitor.dart deleted file mode 100644 index 689397e61..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/visitor.dart +++ /dev/null @@ -1,986 +0,0 @@ -part of '../riverpod_ast.dart'; - -abstract class RiverpodAstVisitor { - void visitProviderOverrideList( - ProviderOverrideList overrideList, - ); - void visitProviderOverrideExpression( - ProviderOverrideExpression expression, - ); - - void visitResolvedRiverpodUnit(ResolvedRiverpodLibraryResult result); - - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression container, - ); - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression expression, - ); - - void visitRiverpodAnnotation( - RiverpodAnnotation annotation, - ); - void visitRiverpodAnnotationDependency( - RiverpodAnnotationDependency dependency, - ); - void visitRiverpodAnnotationDependencies( - RiverpodAnnotationDependencies dependencies, - ); - - void visitLegacyProviderDeclaration( - LegacyProviderDeclaration declaration, - ); - void visitLegacyProviderDependencies( - LegacyProviderDependencies dependencies, - ); - void visitLegacyProviderDependency( - LegacyProviderDependency dependency, - ); - - void visitClassBasedProviderDeclaration( - ClassBasedProviderDeclaration declaration, - ); - void visitFunctionalProviderDeclaration( - FunctionalProviderDeclaration declaration, - ); - - void visitProviderListenableExpression( - ProviderListenableExpression expression, - ); - - void visitRefWatchInvocation(RefWatchInvocation invocation); - void visitRefListenInvocation(RefListenInvocation invocation); - void visitRefReadInvocation(RefReadInvocation invocation); - - void visitWidgetRefReadInvocation(WidgetRefReadInvocation invocation); - void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation invocation); - void visitWidgetRefListenInvocation(WidgetRefListenInvocation invocation); - void visitWidgetRefListenManualInvocation( - WidgetRefListenManualInvocation invocation, - ); - - void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration declaration); - void visitHookConsumerWidgetDeclaration( - HookConsumerWidgetDeclaration declaration, - ); - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration declaration, - ); - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration declaration, - ); - void visitConsumerStateDeclaration(ConsumerStateDeclaration declaration); -} - -class RecursiveRiverpodAstVisitor extends RiverpodAstVisitor { - @override - void visitProviderOverrideList( - ProviderOverrideList overrideList, - ) { - overrideList.visitChildren(this); - } - - @override - void visitProviderOverrideExpression( - ProviderOverrideExpression expression, - ) { - expression.visitChildren(this); - } - - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression container, - ) { - container.visitChildren(this); - } - - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression expression, - ) { - expression.visitChildren(this); - } - - @override - void visitConsumerStateDeclaration(ConsumerStateDeclaration declaration) { - declaration.visitChildren(this); - } - - @override - void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration declaration) { - declaration.visitChildren(this); - } - - @override - void visitLegacyProviderDeclaration(LegacyProviderDeclaration declaration) { - declaration.visitChildren(this); - } - - @override - void visitLegacyProviderDependencies( - LegacyProviderDependencies dependencies, - ) { - dependencies.visitChildren(this); - } - - @override - void visitLegacyProviderDependency(LegacyProviderDependency dependency) { - dependency.visitChildren(this); - } - - @override - void visitProviderListenableExpression( - ProviderListenableExpression expression, - ) { - expression.visitChildren(this); - } - - @override - void visitRefListenInvocation(RefListenInvocation invocation) { - invocation.visitChildren(this); - } - - @override - void visitRefReadInvocation(RefReadInvocation invocation) { - invocation.visitChildren(this); - } - - @override - void visitRefWatchInvocation(RefWatchInvocation invocation) { - invocation.visitChildren(this); - } - - @override - void visitResolvedRiverpodUnit(ResolvedRiverpodLibraryResult result) { - result.visitChildren(this); - } - - @override - void visitRiverpodAnnotation(RiverpodAnnotation annotation) { - annotation.visitChildren(this); - } - - @override - void visitRiverpodAnnotationDependency( - RiverpodAnnotationDependency dependency, - ) { - dependency.visitChildren(this); - } - - @override - void visitRiverpodAnnotationDependencies( - RiverpodAnnotationDependencies dependencies, - ) { - dependencies.visitChildren(this); - } - - @override - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration declaration, - ) { - declaration.visitChildren(this); - } - - @override - void visitClassBasedProviderDeclaration( - ClassBasedProviderDeclaration declaration, - ) { - declaration.visitChildren(this); - } - - @override - void visitFunctionalProviderDeclaration( - FunctionalProviderDeclaration declaration, - ) { - declaration.visitChildren(this); - } - - @override - void visitWidgetRefListenInvocation(WidgetRefListenInvocation invocation) { - invocation.visitChildren(this); - } - - @override - void visitWidgetRefListenManualInvocation( - WidgetRefListenManualInvocation invocation, - ) { - invocation.visitChildren(this); - } - - @override - void visitWidgetRefReadInvocation(WidgetRefReadInvocation invocation) { - invocation.visitChildren(this); - } - - @override - void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation invocation) { - invocation.visitChildren(this); - } - - @override - void visitHookConsumerWidgetDeclaration( - HookConsumerWidgetDeclaration declaration, - ) { - declaration.visitChildren(this); - } - - @override - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration declaration, - ) { - declaration.visitChildren(this); - } -} - -class SimpleRiverpodAstVisitor extends RiverpodAstVisitor { - @override - void visitProviderOverrideList( - ProviderOverrideList overrideList, - ) {} - - @override - void visitProviderOverrideExpression( - ProviderOverrideExpression expression, - ) {} - - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression container, - ) {} - - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression expression, - ) {} - - @override - void visitConsumerStateDeclaration(ConsumerStateDeclaration declaration) {} - - @override - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration declaration, - ) {} - - @override - void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration declaration) {} - - @override - void visitHookConsumerWidgetDeclaration( - HookConsumerWidgetDeclaration declaration, - ) {} - - @override - void visitLegacyProviderDeclaration(LegacyProviderDeclaration declaration) {} - - @override - void visitLegacyProviderDependencies( - LegacyProviderDependencies dependencies, - ) {} - - @override - void visitLegacyProviderDependency(LegacyProviderDependency dependency) {} - - @override - void visitProviderListenableExpression( - ProviderListenableExpression expression, - ) {} - - @override - void visitRefListenInvocation(RefListenInvocation invocation) {} - - @override - void visitRefReadInvocation(RefReadInvocation invocation) {} - - @override - void visitRefWatchInvocation(RefWatchInvocation invocation) {} - - @override - void visitResolvedRiverpodUnit(ResolvedRiverpodLibraryResult result) {} - - @override - void visitRiverpodAnnotation(RiverpodAnnotation annotation) {} - - @override - void visitRiverpodAnnotationDependency( - RiverpodAnnotationDependency dependency, - ) {} - - @override - void visitRiverpodAnnotationDependencies( - RiverpodAnnotationDependencies dependencies, - ) {} - - @override - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration declaration, - ) {} - - @override - void visitClassBasedProviderDeclaration( - ClassBasedProviderDeclaration declaration, - ) {} - - @override - void visitFunctionalProviderDeclaration( - FunctionalProviderDeclaration declaration, - ) {} - - @override - void visitWidgetRefListenInvocation(WidgetRefListenInvocation invocation) {} - - @override - void visitWidgetRefListenManualInvocation( - WidgetRefListenManualInvocation invocation, - ) {} - - @override - void visitWidgetRefReadInvocation(WidgetRefReadInvocation invocation) {} - - @override - void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation invocation) {} -} - -class UnimplementedRiverpodAstVisitor extends RiverpodAstVisitor { - @override - void visitProviderOverrideList( - ProviderOverrideList overrideList, - ) { - throw UnimplementedError( - 'implement visitProviderOverrideList', - ); - } - - @override - void visitProviderOverrideExpression( - ProviderOverrideExpression expression, - ) { - throw UnimplementedError( - 'implement visitProviderOverrideExpression', - ); - } - - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression container, - ) { - throw UnimplementedError( - 'implement visitProviderScopeInstanceCreationExpression', - ); - } - - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression expression, - ) { - throw UnimplementedError( - 'implement visitProviderContainerInstanceCreationExpression', - ); - } - - @override - void visitConsumerStateDeclaration(ConsumerStateDeclaration declaration) { - throw UnimplementedError('implement visitConsumerStateDeclaration'); - } - - @override - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration declaration, - ) { - throw UnimplementedError( - 'implement visitConsumerStatefulWidgetDeclaration', - ); - } - - @override - void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration declaration) { - throw UnimplementedError('implement visitConsumerWidgetDeclaration'); - } - - @override - void visitHookConsumerWidgetDeclaration( - HookConsumerWidgetDeclaration declaration, - ) { - throw UnimplementedError('implement visitHookConsumerWidgetDeclaration'); - } - - @override - void visitLegacyProviderDeclaration(LegacyProviderDeclaration declaration) { - throw UnimplementedError('implement visitLegacyProviderDeclaration'); - } - - @override - void visitLegacyProviderDependencies( - LegacyProviderDependencies dependencies, - ) { - throw UnimplementedError('implement visitLegacyProviderDependencies'); - } - - @override - void visitLegacyProviderDependency(LegacyProviderDependency dependency) { - throw UnimplementedError('implement visitLegacyProviderDependency'); - } - - @override - void visitProviderListenableExpression( - ProviderListenableExpression expression, - ) { - throw UnimplementedError('implement visitProviderListenableExpression'); - } - - @override - void visitRefListenInvocation(RefListenInvocation invocation) { - throw UnimplementedError('implement visitRefListenInvocation'); - } - - @override - void visitRefReadInvocation(RefReadInvocation invocation) { - throw UnimplementedError('implement visitRefReadInvocation'); - } - - @override - void visitRefWatchInvocation(RefWatchInvocation invocation) { - throw UnimplementedError('implement visitRefWatchInvocation'); - } - - @override - void visitResolvedRiverpodUnit(ResolvedRiverpodLibraryResult result) { - throw UnimplementedError('implement visitResolvedRiverpodUnit'); - } - - @override - void visitRiverpodAnnotation(RiverpodAnnotation annotation) { - throw UnimplementedError('implement visitRiverpodAnnotation'); - } - - @override - void visitRiverpodAnnotationDependency( - RiverpodAnnotationDependency dependency, - ) { - throw UnimplementedError('implement visitRiverpodAnnotationDependency'); - } - - @override - void visitRiverpodAnnotationDependencies( - RiverpodAnnotationDependencies dependencies, - ) { - throw UnimplementedError('implement visitRiverpodAnnotationDependencies'); - } - - @override - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration declaration, - ) { - throw UnimplementedError( - 'implement visitStatefulHookConsumerWidgetDeclaration', - ); - } - - @override - void visitClassBasedProviderDeclaration( - ClassBasedProviderDeclaration declaration, - ) { - throw UnimplementedError('implement visitClassBasedProviderDeclaration'); - } - - @override - void visitFunctionalProviderDeclaration( - FunctionalProviderDeclaration declaration, - ) { - throw UnimplementedError('implement visitFunctionalProviderDeclaration'); - } - - @override - void visitWidgetRefListenInvocation(WidgetRefListenInvocation invocation) { - throw UnimplementedError('implement visitWidgetRefListenInvocation'); - } - - @override - void visitWidgetRefListenManualInvocation( - WidgetRefListenManualInvocation invocation, - ) { - throw UnimplementedError('implement visitWidgetRefListenManualInvocation'); - } - - @override - void visitWidgetRefReadInvocation(WidgetRefReadInvocation invocation) { - throw UnimplementedError('implement visitWidgetRefReadInvocation'); - } - - @override - void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation invocation) { - throw UnimplementedError('implement visitWidgetRefWatchInvocation'); - } -} - -class RiverpodAstRegistry { - void run(RiverpodAst node) { - node.accept(_RiverpodAstRegistryVisitor(this)); - } - - // misc - final _onResolvedRiverpodUnit = - []; - void addRiverpodUnit(void Function(ResolvedRiverpodLibraryResult) cb) { - _onResolvedRiverpodUnit.add(cb); - } - - // Both generator and legacy visitors - void addProviderDeclaration(void Function(ProviderDeclaration) cb) { - addGeneratorProviderDeclaration(cb); - addLegacyProviderDeclaration(cb); - } - - // Generator-specific visitors - - void addGeneratorProviderDeclaration( - void Function(GeneratorProviderDeclaration) cb, - ) { - addClassBasedProviderDeclaration(cb); - addFunctionalProviderDeclaration(cb); - } - - final _onClassBasedProviderDeclaration = - []; - void addClassBasedProviderDeclaration( - void Function(ClassBasedProviderDeclaration) cb, - ) { - _onClassBasedProviderDeclaration.add(cb); - } - - final _onFunctionalProviderDeclaration = - []; - void addFunctionalProviderDeclaration( - void Function(FunctionalProviderDeclaration) cb, - ) { - _onFunctionalProviderDeclaration.add(cb); - } - - final _onRiverpodAnnotation = []; - void addRiverpodAnnotation( - void Function(RiverpodAnnotation) cb, - ) { - _onRiverpodAnnotation.add(cb); - } - - final _onRiverpodAnnotationDependency = - []; - void addRiverpodAnnotationDependency( - void Function(RiverpodAnnotationDependency) cb, - ) { - _onRiverpodAnnotationDependency.add(cb); - } - - final _onRiverpodAnnotationDependencies = - []; - void addRiverpodAnnotationDependencies( - void Function(RiverpodAnnotationDependencies) cb, - ) { - _onRiverpodAnnotationDependencies.add(cb); - } - - // Legacy-specific visitors - - final _onLegacyProviderDeclaration = - []; - void addLegacyProviderDeclaration( - void Function(LegacyProviderDeclaration) cb, - ) { - _onLegacyProviderDeclaration.add(cb); - } - - final _onLegacyProviderDependencies = - []; - void addLegacyProviderDependencies( - void Function(LegacyProviderDependencies) cb, - ) { - _onLegacyProviderDependencies.add(cb); - } - - final _onLegacyProviderDependency = - []; - void addLegacyProviderDependency( - void Function(LegacyProviderDependency) cb, - ) { - _onLegacyProviderDependency.add(cb); - } - - // Ref life-cycle visitors - - final _onRefInvocation = []; - void addRefInvocation( - void Function(RefInvocation) cb, - ) { - _onRefInvocation.add(cb); - } - - final _onRefWatchInvocation = []; - void addRefWatchInvocation( - void Function(RefWatchInvocation) cb, - ) { - _onRefWatchInvocation.add(cb); - } - - final _onRefListenInvocation = []; - void addRefListenInvocation( - void Function(RefListenInvocation) cb, - ) { - _onRefListenInvocation.add(cb); - } - - final _onRefReadInvocation = []; - void addRefReadInvocation( - void Function(RefReadInvocation) cb, - ) { - _onRefReadInvocation.add(cb); - } - - // WidgetRef life-cycle visitors - - final _onWidgetRefInvocation = []; - void addWidgetRefInvocation( - void Function(WidgetRefInvocation) cb, - ) { - _onWidgetRefInvocation.add(cb); - } - - final _onWidgetRefWatchInvocation = - []; - void addWidgetRefWatchInvocation( - void Function(WidgetRefWatchInvocation) cb, - ) { - _onWidgetRefWatchInvocation.add(cb); - } - - final _onWidgetRefReadInvocation = []; - void addWidgetRefReadInvocation( - void Function(WidgetRefReadInvocation) cb, - ) { - _onWidgetRefReadInvocation.add(cb); - } - - final _onWidgetRefListenInvocation = - []; - void addWidgetRefListenInvocation( - void Function(WidgetRefListenInvocation) cb, - ) { - _onWidgetRefListenInvocation.add(cb); - } - - final _onWidgetRefListenManualInvocation = - []; - void addWidgetRefListenManualInvocation( - void Function(WidgetRefListenManualInvocation) cb, - ) { - _onWidgetRefListenManualInvocation.add(cb); - } - - // Ref misc - - final _onProviderListenableExpression = - []; - void addProviderListenableExpression( - void Function(ProviderListenableExpression) cb, - ) { - _onProviderListenableExpression.add(cb); - } - - // Consumers - - final _onConsumerWidgetDeclaration = - []; - void addConsumerWidgetDeclaration( - void Function(ConsumerWidgetDeclaration) cb, - ) { - _onConsumerWidgetDeclaration.add(cb); - } - - final _onHookConsumerWidgetDeclaration = - []; - void addHookConsumerWidgetDeclaration( - void Function(HookConsumerWidgetDeclaration) cb, - ) { - _onHookConsumerWidgetDeclaration.add(cb); - } - - final _onStatefulHookConsumerWidgetDeclaration = - []; - void addStatefulHookConsumerWidgetDeclaration( - void Function(StatefulHookConsumerWidgetDeclaration) cb, - ) { - _onStatefulHookConsumerWidgetDeclaration.add(cb); - } - - final _onConsumerStatefulWidgetDeclaration = - []; - void addConsumerStatefulWidgetDeclaration( - void Function(ConsumerStatefulWidgetDeclaration) cb, - ) { - _onConsumerStatefulWidgetDeclaration.add(cb); - } - - final _onConsumerStateDeclaration = - []; - void addConsumerStateDeclaration( - void Function(ConsumerStateDeclaration) cb, - ) { - _onConsumerStateDeclaration.add(cb); - } - - final _onProviderScopeInstanceCreationExpression = - []; - void addProviderScopeInstanceCreationExpression( - void Function(ProviderScopeInstanceCreationExpression) cb, - ) { - _onProviderScopeInstanceCreationExpression.add(cb); - } - - final _onProviderContainerInstanceCreationExpression = - []; - void addProviderContainerInstanceCreationExpression( - void Function(ProviderContainerInstanceCreationExpression) cb, - ) { - _onProviderContainerInstanceCreationExpression.add(cb); - } - - final _onProviderOverrideExpression = - []; - void addProviderOverrideExpression( - void Function(ProviderOverrideExpression) cb, - ) { - _onProviderOverrideExpression.add(cb); - } - - final _onProviderOverrideList = []; - void addProviderOverrideList(void Function(ProviderOverrideList) cb) { - _onProviderOverrideList.add(cb); - } -} - -// Voluntarily not extending RecursiveRiverpodAstVisitor to trigger a compilation error -// when new nodes are added. -class _RiverpodAstRegistryVisitor extends RiverpodAstVisitor { - _RiverpodAstRegistryVisitor(this._registry); - - final RiverpodAstRegistry _registry; - - @override - void visitProviderOverrideList( - ProviderOverrideList overrideList, - ) { - overrideList.visitChildren(this); - _runSubscriptions( - overrideList, - _registry._onProviderOverrideList, - ); - } - - @override - void visitProviderOverrideExpression( - ProviderOverrideExpression expression, - ) { - expression.visitChildren(this); - _runSubscriptions( - expression, - _registry._onProviderOverrideExpression, - ); - } - - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression container, - ) { - container.visitChildren(this); - _runSubscriptions( - container, - _registry._onProviderScopeInstanceCreationExpression, - ); - } - - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression expression, - ) { - expression.visitChildren(this); - _runSubscriptions( - expression, - _registry._onProviderContainerInstanceCreationExpression, - ); - } - - @override - void visitConsumerStateDeclaration(ConsumerStateDeclaration declaration) { - declaration.visitChildren(this); - _runSubscriptions(declaration, _registry._onConsumerStateDeclaration); - } - - @override - void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration declaration) { - declaration.visitChildren(this); - _runSubscriptions(declaration, _registry._onConsumerWidgetDeclaration); - } - - @override - void visitLegacyProviderDeclaration(LegacyProviderDeclaration declaration) { - declaration.visitChildren(this); - _runSubscriptions(declaration, _registry._onLegacyProviderDeclaration); - } - - @override - void visitLegacyProviderDependencies( - LegacyProviderDependencies dependencies, - ) { - dependencies.visitChildren(this); - _runSubscriptions(dependencies, _registry._onLegacyProviderDependencies); - } - - @override - void visitLegacyProviderDependency(LegacyProviderDependency dependency) { - dependency.visitChildren(this); - _runSubscriptions(dependency, _registry._onLegacyProviderDependency); - } - - @override - void visitProviderListenableExpression( - ProviderListenableExpression expression, - ) { - expression.visitChildren(this); - _runSubscriptions(expression, _registry._onProviderListenableExpression); - } - - @override - void visitRefListenInvocation(RefListenInvocation invocation) { - invocation.visitChildren(this); - _runSubscriptions(invocation, _registry._onRefListenInvocation); - } - - @override - void visitRefReadInvocation(RefReadInvocation invocation) { - invocation.visitChildren(this); - _runSubscriptions(invocation, _registry._onRefReadInvocation); - } - - @override - void visitRefWatchInvocation(RefWatchInvocation invocation) { - invocation.visitChildren(this); - _runSubscriptions(invocation, _registry._onRefWatchInvocation); - } - - @override - void visitResolvedRiverpodUnit(ResolvedRiverpodLibraryResult result) { - result.visitChildren(this); - _runSubscriptions(result, _registry._onResolvedRiverpodUnit); - } - - @override - void visitRiverpodAnnotation(RiverpodAnnotation annotation) { - annotation.visitChildren(this); - _runSubscriptions(annotation, _registry._onRiverpodAnnotation); - } - - @override - void visitRiverpodAnnotationDependency( - RiverpodAnnotationDependency dependency, - ) { - dependency.visitChildren(this); - _runSubscriptions(dependency, _registry._onRiverpodAnnotationDependency); - } - - @override - void visitRiverpodAnnotationDependencies( - RiverpodAnnotationDependencies dependencies, - ) { - dependencies.visitChildren(this); - _runSubscriptions( - dependencies, - _registry._onRiverpodAnnotationDependencies, - ); - } - - @override - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration declaration, - ) { - declaration.visitChildren(this); - _runSubscriptions( - declaration, - _registry._onConsumerStatefulWidgetDeclaration, - ); - } - - @override - void visitClassBasedProviderDeclaration( - ClassBasedProviderDeclaration declaration, - ) { - declaration.visitChildren(this); - _runSubscriptions(declaration, _registry._onClassBasedProviderDeclaration); - } - - @override - void visitFunctionalProviderDeclaration( - FunctionalProviderDeclaration declaration, - ) { - declaration.visitChildren(this); - _runSubscriptions( - declaration, - _registry._onFunctionalProviderDeclaration, - ); - } - - @override - void visitWidgetRefListenInvocation(WidgetRefListenInvocation invocation) { - invocation.visitChildren(this); - _runSubscriptions(invocation, _registry._onWidgetRefListenInvocation); - } - - @override - void visitWidgetRefListenManualInvocation( - WidgetRefListenManualInvocation invocation, - ) { - invocation.visitChildren(this); - _runSubscriptions(invocation, _registry._onWidgetRefListenManualInvocation); - } - - @override - void visitWidgetRefReadInvocation(WidgetRefReadInvocation invocation) { - invocation.visitChildren(this); - _runSubscriptions(invocation, _registry._onWidgetRefReadInvocation); - } - - @override - void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation invocation) { - invocation.visitChildren(this); - _runSubscriptions(invocation, _registry._onWidgetRefWatchInvocation); - } - - void _runSubscriptions( - R value, - List subscriptions, - ) { - for (final sub in subscriptions) { - try { - sub(value); - } catch (e, stack) { - Zone.current.handleUncaughtError(e, stack); - } - } - } - - @override - void visitHookConsumerWidgetDeclaration( - HookConsumerWidgetDeclaration declaration, - ) { - declaration.visitChildren(this); - _runSubscriptions(declaration, _registry._onHookConsumerWidgetDeclaration); - } - - @override - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration declaration, - ) { - declaration.visitChildren(this); - _runSubscriptions( - declaration, - _registry._onStatefulHookConsumerWidgetDeclaration, - ); - } -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/widget_ref_invocation.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/widget_ref_invocation.dart index d154dec47..7185c141b 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/widget_ref_invocation.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/widget_ref_invocation.dart @@ -1,6 +1,7 @@ part of '../riverpod_ast.dart'; -abstract class WidgetRefInvocation extends RiverpodAst +abstract base class WidgetRefInvocation extends RiverpodAst + with _$WidgetRefInvocation implements ProviderListenableExpressionParent { WidgetRefInvocation._({ required this.node, @@ -72,7 +73,8 @@ abstract class WidgetRefInvocation extends RiverpodAst final SimpleIdentifier function; } -class WidgetRefWatchInvocation extends WidgetRefInvocation { +final class WidgetRefWatchInvocation extends WidgetRefInvocation + with _$WidgetRefWatchInvocation { WidgetRefWatchInvocation._({ required super.node, required super.function, @@ -103,20 +105,12 @@ class WidgetRefWatchInvocation extends WidgetRefInvocation { return widgetRefWatchInvocation; } - final ProviderListenableExpression provider; - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitWidgetRefWatchInvocation(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - provider.accept(visitor); - } + final ProviderListenableExpression provider; } -class WidgetRefReadInvocation extends WidgetRefInvocation { +final class WidgetRefReadInvocation extends WidgetRefInvocation + with _$WidgetRefReadInvocation { WidgetRefReadInvocation._({ required super.node, required super.function, @@ -147,20 +141,12 @@ class WidgetRefReadInvocation extends WidgetRefInvocation { return widgetRefReadInvocation; } - final ProviderListenableExpression provider; - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitWidgetRefReadInvocation(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - provider.accept(visitor); - } + final ProviderListenableExpression provider; } -class WidgetRefListenInvocation extends WidgetRefInvocation { +final class WidgetRefListenInvocation extends WidgetRefInvocation + with _$WidgetRefListenInvocation { WidgetRefListenInvocation._({ required super.node, required super.function, @@ -197,21 +183,13 @@ class WidgetRefListenInvocation extends WidgetRefInvocation { return widgetRefListenInvocation; } + @override final ProviderListenableExpression provider; final Expression listener; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitWidgetRefListenInvocation(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - provider.accept(visitor); - } } -class WidgetRefListenManualInvocation extends WidgetRefInvocation { +final class WidgetRefListenManualInvocation extends WidgetRefInvocation + with _$WidgetRefListenManualInvocation { WidgetRefListenManualInvocation._({ required super.node, required super.function, @@ -248,16 +226,7 @@ class WidgetRefListenManualInvocation extends WidgetRefInvocation { return widgetRefListenManualInvocation; } + @override final ProviderListenableExpression provider; final Expression listener; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitWidgetRefListenManualInvocation(this); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - provider.accept(visitor); - } } diff --git a/packages/riverpod_analyzer_utils/pubspec.yaml b/packages/riverpod_analyzer_utils/pubspec.yaml index 680ba9200..16d26b711 100644 --- a/packages/riverpod_analyzer_utils/pubspec.yaml +++ b/packages/riverpod_analyzer_utils/pubspec.yaml @@ -24,5 +24,7 @@ dev_dependencies: build_runner: ^2.3.2 build_test: ^2.1.5 freezed: ^2.2.0 + lint_visitor_generator: + path: ../lint_visitor_generator lints: ^2.0.0 test: ^1.21.7 diff --git a/packages/riverpod_analyzer_utils/pubspec_overrides.yaml b/packages/riverpod_analyzer_utils/pubspec_overrides.yaml index ac6b59295..efa318369 100644 --- a/packages/riverpod_analyzer_utils/pubspec_overrides.yaml +++ b/packages/riverpod_analyzer_utils/pubspec_overrides.yaml @@ -1,9 +1,12 @@ +# melos_managed_dependency_overrides: lint_visitor_generator dependency_overrides: flutter_riverpod: path: ../flutter_riverpod hooks_riverpod: path: ../hooks_riverpod + lint_visitor_generator: + path: ../lint_visitor_generator riverpod: path: ../riverpod riverpod_annotation: - path: ../riverpod_annotation \ No newline at end of file + path: ../riverpod_annotation diff --git a/packages/riverpod_analyzer_utils_tests/test/analyzer_test_utils.dart b/packages/riverpod_analyzer_utils_tests/test/analyzer_test_utils.dart index e661455ea..5c6d0189e 100644 --- a/packages/riverpod_analyzer_utils_tests/test/analyzer_test_utils.dart +++ b/packages/riverpod_analyzer_utils_tests/test/analyzer_test_utils.dart @@ -7,6 +7,10 @@ import 'package:build/build.dart'; import 'package:build_test/build_test.dart'; import 'package:meta/meta.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import 'package:riverpod_analyzer_utils/src/riverpod_ast.dart' + show + // ignore: invalid_use_of_internal_member + RiverpodAnalysisResult; import 'package:riverpod_generator/src/riverpod_generator.dart'; import 'package:test/test.dart'; @@ -98,6 +102,7 @@ extension MapTake on Map { } extension ResolverX on Resolver { + // ignore: invalid_use_of_internal_member Future resolveRiverpodAnalysisResult({ String libraryName = 'foo', bool ignoreErrors = false, @@ -182,507 +187,21 @@ void expectValidParentChildrenRelationship( result.accept(_ParentRiverpodVisitor(null)); } -class _ParentRiverpodVisitor extends RecursiveRiverpodAstVisitor { +class _ParentRiverpodVisitor extends GeneralizingRiverpodAstVisitor { _ParentRiverpodVisitor(this.expectedParent); final RiverpodAst? expectedParent; @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression declaration, + void visitRiverpodAst( + RiverpodAst node, ) { expect( - declaration.parent, + node.parent, expectedParent, - reason: - 'Node ${declaration.runtimeType} should have $expectedParent as parent', + reason: 'Node ${node.runtimeType} should have $expectedParent as parent', ); - declaration.visitChildren(_ParentRiverpodVisitor(declaration)); - } - - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression declaration, - ) { - expect( - declaration.parent, - expectedParent, - reason: - 'Node ${declaration.runtimeType} should have $expectedParent as parent', - ); - declaration.visitChildren(_ParentRiverpodVisitor(declaration)); - } - - @override - void visitConsumerStateDeclaration(ConsumerStateDeclaration declaration) { - expect( - declaration.parent, - expectedParent, - reason: - 'Node ${declaration.runtimeType} should have $expectedParent as parent', - ); - declaration.visitChildren(_ParentRiverpodVisitor(declaration)); - } - - @override - void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration declaration) { - expect( - declaration.parent, - expectedParent, - reason: - 'Node ${declaration.runtimeType} should have $expectedParent as parent', - ); - declaration.visitChildren(_ParentRiverpodVisitor(declaration)); - } - - @override - void visitLegacyProviderDeclaration(LegacyProviderDeclaration declaration) { - expect( - declaration.parent, - expectedParent, - reason: - 'Node ${declaration.runtimeType} should have $expectedParent as parent', - ); - declaration.visitChildren(_ParentRiverpodVisitor(declaration)); - } - - @override - void visitLegacyProviderDependencies( - LegacyProviderDependencies dependencies, - ) { - expect( - dependencies.parent, - expectedParent, - reason: - 'Node ${dependencies.runtimeType} should have $expectedParent as parent', - ); - dependencies.visitChildren(_ParentRiverpodVisitor(dependencies)); - } - - @override - void visitLegacyProviderDependency(LegacyProviderDependency dependency) { - expect( - dependency.parent, - expectedParent, - reason: - 'Node ${dependency.runtimeType} should have $expectedParent as parent', - ); - dependency.visitChildren(_ParentRiverpodVisitor(dependency)); - } - - @override - void visitProviderListenableExpression( - ProviderListenableExpression expression, - ) { - expect( - expression.parent, - expectedParent, - reason: - 'Node ${expression.runtimeType} should have $expectedParent as parent', - ); - expression.visitChildren(_ParentRiverpodVisitor(expression)); - } - - @override - void visitRefListenInvocation(RefListenInvocation invocation) { - expect( - invocation.parent, - expectedParent, - reason: - 'Node ${invocation.runtimeType} should have $expectedParent as parent', - ); - invocation.visitChildren(_ParentRiverpodVisitor(invocation)); - } - - @override - void visitRefReadInvocation(RefReadInvocation invocation) { - expect( - invocation.parent, - expectedParent, - reason: - 'Node ${invocation.runtimeType} should have $expectedParent as parent', - ); - invocation.visitChildren(_ParentRiverpodVisitor(invocation)); - } - - @override - void visitRefWatchInvocation(RefWatchInvocation invocation) { - expect( - invocation.parent, - expectedParent, - reason: - 'Node ${invocation.runtimeType} should have $expectedParent as parent', - ); - invocation.visitChildren(_ParentRiverpodVisitor(invocation)); - } - - @override - void visitResolvedRiverpodUnit(ResolvedRiverpodLibraryResult result) { - expect( - result.parent, - expectedParent, - reason: - 'Node ${result.runtimeType} should have $expectedParent as parent', - ); - result.visitChildren(_ParentRiverpodVisitor(result)); - } - - @override - void visitRiverpodAnnotation(RiverpodAnnotation annotation) { - expect( - annotation.parent, - expectedParent, - reason: - 'Node ${annotation.runtimeType} should have $expectedParent as parent', - ); - annotation.visitChildren(_ParentRiverpodVisitor(annotation)); - } - - @override - void visitRiverpodAnnotationDependency( - RiverpodAnnotationDependency dependency, - ) { - expect( - dependency.parent, - expectedParent, - reason: - 'Node ${dependency.runtimeType} should have $expectedParent as parent', - ); - dependency.visitChildren(_ParentRiverpodVisitor(dependency)); - } - - @override - void visitRiverpodAnnotationDependencies( - RiverpodAnnotationDependencies dependencies, - ) { - expect( - dependencies.parent, - expectedParent, - reason: - 'Node ${dependencies.runtimeType} should have $expectedParent as parent', - ); - dependencies.visitChildren(_ParentRiverpodVisitor(dependencies)); - } - - @override - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration declaration, - ) { - expect( - declaration.parent, - expectedParent, - reason: - 'Node ${declaration.runtimeType} should have $expectedParent as parent', - ); - declaration.visitChildren(_ParentRiverpodVisitor(declaration)); - } - - @override - void visitClassBasedProviderDeclaration( - ClassBasedProviderDeclaration declaration, - ) { - expect( - declaration.parent, - expectedParent, - reason: - 'Node ${declaration.runtimeType} should have $expectedParent as parent', - ); - declaration.visitChildren(_ParentRiverpodVisitor(declaration)); - } - - @override - void visitFunctionalProviderDeclaration( - FunctionalProviderDeclaration declaration, - ) { - expect( - declaration.parent, - expectedParent, - reason: - 'Node ${declaration.runtimeType} should have $expectedParent as parent', - ); - declaration.visitChildren(_ParentRiverpodVisitor(declaration)); - } - - @override - void visitWidgetRefListenInvocation(WidgetRefListenInvocation invocation) { - expect( - invocation.parent, - expectedParent, - reason: - 'Node ${invocation.runtimeType} should have $expectedParent as parent', - ); - invocation.visitChildren(_ParentRiverpodVisitor(invocation)); - } - - @override - void visitWidgetRefListenManualInvocation( - WidgetRefListenManualInvocation invocation, - ) { - expect( - invocation.parent, - expectedParent, - reason: - 'Node ${invocation.runtimeType} should have $expectedParent as parent', - ); - invocation.visitChildren(_ParentRiverpodVisitor(invocation)); - } - - @override - void visitWidgetRefReadInvocation(WidgetRefReadInvocation invocation) { - expect( - invocation.parent, - expectedParent, - reason: - 'Node ${invocation.runtimeType} should have $expectedParent as parent', - ); - invocation.visitChildren(_ParentRiverpodVisitor(invocation)); - } - - @override - void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation invocation) { - expect( - invocation.parent, - expectedParent, - reason: - 'Node ${invocation.runtimeType} should have $expectedParent as parent', - ); - invocation.visitChildren(_ParentRiverpodVisitor(invocation)); - } - - @override - void visitHookConsumerWidgetDeclaration( - HookConsumerWidgetDeclaration declaration, - ) { - expect( - declaration.parent, - expectedParent, - reason: - 'Node ${declaration.runtimeType} should have $expectedParent as parent', - ); - declaration.visitChildren(_ParentRiverpodVisitor(declaration)); - } - - @override - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration declaration, - ) { - expect( - declaration.parent, - expectedParent, - reason: - 'Node ${declaration.runtimeType} should have $expectedParent as parent', - ); - declaration.visitChildren(_ParentRiverpodVisitor(declaration)); - } -} - -class RiverpodAnalysisResult extends RecursiveRiverpodAstVisitor { - final providerContainerInstanceCreationExpressions = - []; - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression expression, - ) { - super.visitProviderContainerInstanceCreationExpression(expression); - providerContainerInstanceCreationExpressions.add(expression); - } - - final providerScopeInstanceCreationExpressions = - []; - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression expression, - ) { - super.visitProviderScopeInstanceCreationExpression(expression); - providerScopeInstanceCreationExpressions.add(expression); - } - - final consumerStateDeclarations = []; - @override - void visitConsumerStateDeclaration(ConsumerStateDeclaration declaration) { - super.visitConsumerStateDeclaration(declaration); - consumerStateDeclarations.add(declaration); - } - - final consumerWidgetDeclarations = []; - @override - void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration declaration) { - super.visitConsumerWidgetDeclaration(declaration); - consumerWidgetDeclarations.add(declaration); - } - - final hookConsumerWidgetDeclaration = []; - @override - void visitHookConsumerWidgetDeclaration( - HookConsumerWidgetDeclaration declaration, - ) { - super.visitHookConsumerWidgetDeclaration(declaration); - hookConsumerWidgetDeclaration.add(declaration); - } - - final statefulHookConsumerWidgetDeclaration = - []; - @override - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration declaration, - ) { - super.visitStatefulHookConsumerWidgetDeclaration(declaration); - statefulHookConsumerWidgetDeclaration.add(declaration); - } - - final legacyProviderDeclarations = []; - @override - void visitLegacyProviderDeclaration(LegacyProviderDeclaration declaration) { - super.visitLegacyProviderDeclaration(declaration); - legacyProviderDeclarations.add(declaration); - } - - final legacyProviderDependencies = []; - @override - void visitLegacyProviderDependencies( - LegacyProviderDependencies dependencies, - ) { - super.visitLegacyProviderDependencies(dependencies); - legacyProviderDependencies.add(dependencies); - } - - final legacyProviderDependencyList = []; - @override - void visitLegacyProviderDependency(LegacyProviderDependency dependency) { - super.visitLegacyProviderDependency(dependency); - legacyProviderDependencyList.add(dependency); - } - - final providerListenableExpressions = []; - @override - void visitProviderListenableExpression( - ProviderListenableExpression expression, - ) { - super.visitProviderListenableExpression(expression); - providerListenableExpressions.add(expression); - } - - final refInvocations = []; - final refListenInvocations = []; - @override - void visitRefListenInvocation(RefListenInvocation invocation) { - super.visitRefListenInvocation(invocation); - refInvocations.add(invocation); - refListenInvocations.add(invocation); - } - - final refReadInvocations = []; - @override - void visitRefReadInvocation(RefReadInvocation invocation) { - super.visitRefReadInvocation(invocation); - refInvocations.add(invocation); - refReadInvocations.add(invocation); - } - - final refWatchInvocations = []; - @override - void visitRefWatchInvocation(RefWatchInvocation invocation) { - super.visitRefWatchInvocation(invocation); - refInvocations.add(invocation); - refWatchInvocations.add(invocation); - } - - final resolvedRiverpodLibraryResults = []; - @override - void visitResolvedRiverpodUnit(ResolvedRiverpodLibraryResult result) { - super.visitResolvedRiverpodUnit(result); - resolvedRiverpodLibraryResults.add(result); - } - - final riverpodAnnotations = []; - @override - void visitRiverpodAnnotation(RiverpodAnnotation annotation) { - super.visitRiverpodAnnotation(annotation); - riverpodAnnotations.add(annotation); - } - - final riverpodAnnotationDependencyList = []; - @override - void visitRiverpodAnnotationDependency( - RiverpodAnnotationDependency dependency, - ) { - super.visitRiverpodAnnotationDependency(dependency); - riverpodAnnotationDependencyList.add(dependency); - } - - final riverpodAnnotationDependencies = []; - @override - void visitRiverpodAnnotationDependencies( - RiverpodAnnotationDependencies dependencies, - ) { - super.visitRiverpodAnnotationDependencies(dependencies); - riverpodAnnotationDependencies.add(dependencies); - } - - final consumerStatefulWidgetDeclarations = - []; - @override - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration declaration, - ) { - super.visitConsumerStatefulWidgetDeclaration(declaration); - consumerStatefulWidgetDeclarations.add(declaration); - } - - final generatorProviderDeclarations = []; - final classBasedProviderDeclarations = []; - @override - void visitClassBasedProviderDeclaration( - ClassBasedProviderDeclaration declaration, - ) { - super.visitClassBasedProviderDeclaration(declaration); - generatorProviderDeclarations.add(declaration); - classBasedProviderDeclarations.add(declaration); - } - - final functionalProviderDeclarations = []; - @override - void visitFunctionalProviderDeclaration( - FunctionalProviderDeclaration declaration, - ) { - super.visitFunctionalProviderDeclaration(declaration); - generatorProviderDeclarations.add(declaration); - functionalProviderDeclarations.add(declaration); - } - - final widgetRefInvocations = []; - final widgetRefListenInvocations = []; - @override - void visitWidgetRefListenInvocation(WidgetRefListenInvocation invocation) { - super.visitWidgetRefListenInvocation(invocation); - widgetRefInvocations.add(invocation); - widgetRefListenInvocations.add(invocation); - } - - final widgetRefListenManualInvocations = []; - @override - void visitWidgetRefListenManualInvocation( - WidgetRefListenManualInvocation invocation, - ) { - super.visitWidgetRefListenManualInvocation(invocation); - widgetRefInvocations.add(invocation); - widgetRefListenManualInvocations.add(invocation); - } - - final widgetRefReadInvocations = []; - @override - void visitWidgetRefReadInvocation(WidgetRefReadInvocation invocation) { - super.visitWidgetRefReadInvocation(invocation); - widgetRefInvocations.add(invocation); - widgetRefReadInvocations.add(invocation); - } - - final widgetRefWatchInvocations = []; - @override - void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation invocation) { - super.visitWidgetRefWatchInvocation(invocation); - widgetRefInvocations.add(invocation); - widgetRefWatchInvocations.add(invocation); + node.visitChildren(_ParentRiverpodVisitor(node)); } } diff --git a/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart b/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart index b23769ef2..2229fdd26 100644 --- a/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart @@ -109,7 +109,7 @@ class MyConsumerWidget extends HookConsumerWidget { ''', (resolver) async { final result = await resolver.resolveRiverpodAnalysisResult(); - final consumerWidget = result.hookConsumerWidgetDeclaration.single; + final consumerWidget = result.hookConsumerWidgetDeclarations.single; expect(consumerWidget, isA()); expect(consumerWidget.node.name.toString(), 'MyConsumerWidget'); expect( @@ -218,7 +218,7 @@ class MyConsumerState extends ConsumerState { ''', (resolver) async { final result = await resolver.resolveRiverpodAnalysisResult(); - final consumerWidget = result.statefulHookConsumerWidgetDeclaration.single; + final consumerWidget = result.statefulHookConsumerWidgetDeclarations.single; final consumerState = result.consumerStateDeclarations.single; expect(consumerWidget, isA()); diff --git a/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart b/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart index 8fd95eb66..b25d5e329 100644 --- a/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart +++ b/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart @@ -22,7 +22,7 @@ class RiverpodSyntaxError extends RiverpodLintRule { ErrorReporter reporter, CustomLintContext context, ) { - riverpodRegistry(context).addRiverpodUnit((unit) { + riverpodRegistry(context).addResolvedRiverpodLibraryResult((unit) { for (final error in unit.errors) { switch (error.code) { case RiverpodAnalysisErrorCode.missingNotifierBuild: From 585a10b673d6a7305ebfd9f2ff1634d74c99e746 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 14 Feb 2024 19:37:08 +0100 Subject: [PATCH 228/387] Update packages/riverpod_lint/README.md --- packages/riverpod_lint/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/riverpod_lint/README.md b/packages/riverpod_lint/README.md index ce5b978f6..59e17a620 100644 --- a/packages/riverpod_lint/README.md +++ b/packages/riverpod_lint/README.md @@ -788,7 +788,7 @@ dart run custom_lint --fix ### missing_legacy_import As part of Riverpod 3.0, `StateProvider`, `StateNotifierProvider`, `StateNotifier` and `ChangeNotifierProvider` are moved out of `package:riverpod/riverpod.dart` to -`package:riverpod/riverpod.dart`. +`package:riverpod/legacy.dart`. This migration will automatically adds the missing import. From 513a3f38a932e86ab35233376358c40a57b524bb Mon Sep 17 00:00:00 2001 From: ValentinVignal Date: Wed, 21 Feb 2024 23:38:47 +0800 Subject: [PATCH 229/387] style: Format code --- .../lib/src/riverpod_generator.dart | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index 96bf8ff46..c1a934184 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -113,7 +113,6 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { String get familySuffix => options.providerFamilyNameSuffix ?? suffix; - void visitGeneratorProviderDeclaration( GeneratorProviderDeclaration provider, ) { @@ -208,11 +207,13 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { extension ProviderElementNames on GeneratorProviderDeclarationElement { String providerName(BuildYamlOptions options) { final prefix = (isFamily - ? options.providerFamilyNamePrefix - : options.providerNamePrefix) ?? _defaultProviderNamePrefix; + ? options.providerFamilyNamePrefix + : options.providerNamePrefix) ?? + _defaultProviderNamePrefix; final suffix = (isFamily - ? options.providerFamilyNameSuffix - : options.providerNameSuffix) ?? _defaultProviderNameSuffix; + ? options.providerFamilyNameSuffix + : options.providerNameSuffix) ?? + _defaultProviderNameSuffix; return '$prefix${prefix.isEmpty ? name.lowerFirst : name.titled}$suffix'; } From f92eead796b5fa611dbde84dc24cd92d0cb8b989 Mon Sep 17 00:00:00 2001 From: ValentinVignal Date: Thu, 22 Feb 2024 00:03:55 +0800 Subject: [PATCH 230/387] chore: Update pubspec_overrides --- examples/counter/pubspec_overrides.yaml | 6 ++--- examples/marvel/pubspec_overrides.yaml | 8 +++---- examples/pub/pubspec_overrides.yaml | 8 +++---- examples/random_number/pubspec_overrides.yaml | 6 ++--- examples/stackoverflow/pubspec_overrides.yaml | 8 +++---- examples/todos/pubspec_overrides.yaml | 8 +++---- .../riverpod_generator/pubspec_overrides.yaml | 4 ++-- .../generated/golden/pubspec_overrides.yaml | 8 +++---- packages/riverpod_lint/pubspec_overrides.yaml | 4 ++-- .../pubspec_overrides.yaml | 14 +++++------ website/pubspec_overrides.yaml | 24 +++++++++---------- 11 files changed, 49 insertions(+), 49 deletions(-) diff --git a/examples/counter/pubspec_overrides.yaml b/examples/counter/pubspec_overrides.yaml index f538fb6c3..1a80d55d0 100644 --- a/examples/counter/pubspec_overrides.yaml +++ b/examples/counter/pubspec_overrides.yaml @@ -1,4 +1,4 @@ -# melos_managed_dependency_overrides: flutter_riverpod,hooks_riverpod,riverpod,riverpod_lint,riverpod_analyzer_utils +# melos_managed_dependency_overrides: flutter_riverpod,hooks_riverpod,riverpod,riverpod_analyzer_utils,riverpod_lint dependency_overrides: flutter_riverpod: path: ../../packages/flutter_riverpod @@ -8,11 +8,11 @@ dependency_overrides: path: ../../packages/riverpod riverpod_analyzer_utils: path: ../../packages/riverpod_analyzer_utils - riverpod_lint: - path: ../../packages/riverpod_lint riverpod_annotation: path: ../../packages/riverpod_annotation riverpod_generator: path: ../../packages/riverpod_generator # https://github.com/vegardit/dart-hotreloader/issues/14 + riverpod_lint: + path: ../../packages/riverpod_lint vm_service: ">=8.0.0 <15.0.0" diff --git a/examples/marvel/pubspec_overrides.yaml b/examples/marvel/pubspec_overrides.yaml index e738086cd..1a80d55d0 100644 --- a/examples/marvel/pubspec_overrides.yaml +++ b/examples/marvel/pubspec_overrides.yaml @@ -1,4 +1,4 @@ -# melos_managed_dependency_overrides: flutter_riverpod,hooks_riverpod,riverpod,riverpod_lint,riverpod_analyzer_utils +# melos_managed_dependency_overrides: flutter_riverpod,hooks_riverpod,riverpod,riverpod_analyzer_utils,riverpod_lint dependency_overrides: flutter_riverpod: path: ../../packages/flutter_riverpod @@ -8,11 +8,11 @@ dependency_overrides: path: ../../packages/riverpod riverpod_analyzer_utils: path: ../../packages/riverpod_analyzer_utils - riverpod_lint: - path: ../../packages/riverpod_lint riverpod_annotation: path: ../../packages/riverpod_annotation riverpod_generator: path: ../../packages/riverpod_generator # https://github.com/vegardit/dart-hotreloader/issues/14 - vm_service: ">=8.0.0 <15.0.0" \ No newline at end of file + riverpod_lint: + path: ../../packages/riverpod_lint + vm_service: ">=8.0.0 <15.0.0" diff --git a/examples/pub/pubspec_overrides.yaml b/examples/pub/pubspec_overrides.yaml index e738086cd..1a80d55d0 100644 --- a/examples/pub/pubspec_overrides.yaml +++ b/examples/pub/pubspec_overrides.yaml @@ -1,4 +1,4 @@ -# melos_managed_dependency_overrides: flutter_riverpod,hooks_riverpod,riverpod,riverpod_lint,riverpod_analyzer_utils +# melos_managed_dependency_overrides: flutter_riverpod,hooks_riverpod,riverpod,riverpod_analyzer_utils,riverpod_lint dependency_overrides: flutter_riverpod: path: ../../packages/flutter_riverpod @@ -8,11 +8,11 @@ dependency_overrides: path: ../../packages/riverpod riverpod_analyzer_utils: path: ../../packages/riverpod_analyzer_utils - riverpod_lint: - path: ../../packages/riverpod_lint riverpod_annotation: path: ../../packages/riverpod_annotation riverpod_generator: path: ../../packages/riverpod_generator # https://github.com/vegardit/dart-hotreloader/issues/14 - vm_service: ">=8.0.0 <15.0.0" \ No newline at end of file + riverpod_lint: + path: ../../packages/riverpod_lint + vm_service: ">=8.0.0 <15.0.0" diff --git a/examples/random_number/pubspec_overrides.yaml b/examples/random_number/pubspec_overrides.yaml index 978b48d99..e4683bcd1 100644 --- a/examples/random_number/pubspec_overrides.yaml +++ b/examples/random_number/pubspec_overrides.yaml @@ -1,4 +1,4 @@ -# melos_managed_dependency_overrides: flutter_riverpod,riverpod,riverpod_lint,riverpod_analyzer_utils +# melos_managed_dependency_overrides: flutter_riverpod,riverpod,riverpod_analyzer_utils,riverpod_lint dependency_overrides: flutter_riverpod: path: ../../packages/flutter_riverpod @@ -6,11 +6,11 @@ dependency_overrides: path: ../../packages/riverpod riverpod_analyzer_utils: path: ../../packages/riverpod_analyzer_utils - riverpod_lint: - path: ../../packages/riverpod_lint riverpod_annotation: path: ../../packages/riverpod_annotation riverpod_generator: path: ../../packages/riverpod_generator # https://github.com/vegardit/dart-hotreloader/issues/14 + riverpod_lint: + path: ../../packages/riverpod_lint vm_service: ">=8.0.0 <15.0.0" diff --git a/examples/stackoverflow/pubspec_overrides.yaml b/examples/stackoverflow/pubspec_overrides.yaml index e738086cd..1a80d55d0 100644 --- a/examples/stackoverflow/pubspec_overrides.yaml +++ b/examples/stackoverflow/pubspec_overrides.yaml @@ -1,4 +1,4 @@ -# melos_managed_dependency_overrides: flutter_riverpod,hooks_riverpod,riverpod,riverpod_lint,riverpod_analyzer_utils +# melos_managed_dependency_overrides: flutter_riverpod,hooks_riverpod,riverpod,riverpod_analyzer_utils,riverpod_lint dependency_overrides: flutter_riverpod: path: ../../packages/flutter_riverpod @@ -8,11 +8,11 @@ dependency_overrides: path: ../../packages/riverpod riverpod_analyzer_utils: path: ../../packages/riverpod_analyzer_utils - riverpod_lint: - path: ../../packages/riverpod_lint riverpod_annotation: path: ../../packages/riverpod_annotation riverpod_generator: path: ../../packages/riverpod_generator # https://github.com/vegardit/dart-hotreloader/issues/14 - vm_service: ">=8.0.0 <15.0.0" \ No newline at end of file + riverpod_lint: + path: ../../packages/riverpod_lint + vm_service: ">=8.0.0 <15.0.0" diff --git a/examples/todos/pubspec_overrides.yaml b/examples/todos/pubspec_overrides.yaml index e738086cd..1a80d55d0 100644 --- a/examples/todos/pubspec_overrides.yaml +++ b/examples/todos/pubspec_overrides.yaml @@ -1,4 +1,4 @@ -# melos_managed_dependency_overrides: flutter_riverpod,hooks_riverpod,riverpod,riverpod_lint,riverpod_analyzer_utils +# melos_managed_dependency_overrides: flutter_riverpod,hooks_riverpod,riverpod,riverpod_analyzer_utils,riverpod_lint dependency_overrides: flutter_riverpod: path: ../../packages/flutter_riverpod @@ -8,11 +8,11 @@ dependency_overrides: path: ../../packages/riverpod riverpod_analyzer_utils: path: ../../packages/riverpod_analyzer_utils - riverpod_lint: - path: ../../packages/riverpod_lint riverpod_annotation: path: ../../packages/riverpod_annotation riverpod_generator: path: ../../packages/riverpod_generator # https://github.com/vegardit/dart-hotreloader/issues/14 - vm_service: ">=8.0.0 <15.0.0" \ No newline at end of file + riverpod_lint: + path: ../../packages/riverpod_lint + vm_service: ">=8.0.0 <15.0.0" diff --git a/packages/riverpod_generator/pubspec_overrides.yaml b/packages/riverpod_generator/pubspec_overrides.yaml index 12a8e9de4..88de991b8 100644 --- a/packages/riverpod_generator/pubspec_overrides.yaml +++ b/packages/riverpod_generator/pubspec_overrides.yaml @@ -2,7 +2,7 @@ dependency_overrides: riverpod: path: ../riverpod - riverpod_annotation: - path: ../riverpod_annotation riverpod_analyzer_utils: path: ../riverpod_analyzer_utils + riverpod_annotation: + path: ../riverpod_annotation diff --git a/packages/riverpod_graph/test/integration/generated/golden/pubspec_overrides.yaml b/packages/riverpod_graph/test/integration/generated/golden/pubspec_overrides.yaml index 8406dd743..396e50934 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/pubspec_overrides.yaml +++ b/packages/riverpod_graph/test/integration/generated/golden/pubspec_overrides.yaml @@ -1,12 +1,12 @@ # melos_managed_dependency_overrides: flutter_riverpod,riverpod,riverpod_annotation,riverpod_generator dependency_overrides: - flutter_riverpod: + flutter_riverpod: path: ../../../../../flutter_riverpod - riverpod: + riverpod: path: ../../../../../riverpod riverpod_analyzer_utils: path: ../../../../../../packages/riverpod_analyzer_utils - riverpod_annotation: + riverpod_annotation: path: ../../../../../riverpod_annotation - riverpod_generator: + riverpod_generator: path: ../../../../../riverpod_generator diff --git a/packages/riverpod_lint/pubspec_overrides.yaml b/packages/riverpod_lint/pubspec_overrides.yaml index 9ce45e33b..d711ada23 100644 --- a/packages/riverpod_lint/pubspec_overrides.yaml +++ b/packages/riverpod_lint/pubspec_overrides.yaml @@ -1,8 +1,8 @@ # melos_managed_dependency_overrides: riverpod dependency_overrides: - riverpod: - path: ../riverpod riverpod_analyzer_utils: path: ../riverpod_analyzer_utils # necessary due to outdated mockito dependency analyzer: ^6.0.0 + riverpod: + path: ../riverpod diff --git a/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml b/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml index 4f0b94b08..31b634d28 100644 --- a/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml +++ b/packages/riverpod_lint_flutter_test/pubspec_overrides.yaml @@ -1,19 +1,19 @@ -# melos_managed_dependency_overrides: riverpod_generator,riverpod,flutter_riverpod,hooks_riverpod,riverpod_annotation,riverpod_lint +# melos_managed_dependency_overrides: flutter_riverpod,hooks_riverpod,riverpod,riverpod_annotation,riverpod_generator,riverpod_lint dependency_overrides: - riverpod_generator: - path: ../riverpod_generator - riverpod: - path: ../riverpod flutter_riverpod: path: ../flutter_riverpod hooks_riverpod: path: ../hooks_riverpod + riverpod: + path: ../riverpod riverpod_analyzer_utils: path: ../riverpod_analyzer_utils + + # hotreloader is out of date riverpod_annotation: path: ../riverpod_annotation + riverpod_generator: + path: ../riverpod_generator riverpod_lint: path: ../riverpod_lint - - # hotreloader is out of date vm_service: ^14.0.0 diff --git a/website/pubspec_overrides.yaml b/website/pubspec_overrides.yaml index 2814084ad..7488c6af5 100644 --- a/website/pubspec_overrides.yaml +++ b/website/pubspec_overrides.yaml @@ -1,15 +1,5 @@ -# melos_managed_dependency_overrides: flutter_riverpod,hooks_riverpod,riverpod,riverpod_annotation,riverpod_generator,cosmic_frontmatter +# melos_managed_dependency_overrides: cosmic_frontmatter,flutter_riverpod,hooks_riverpod,riverpod,riverpod_annotation,riverpod_generator dependency_overrides: - flutter_riverpod: - path: ../packages/flutter_riverpod - hooks_riverpod: - path: ../packages/hooks_riverpod - riverpod: - path: ../packages/riverpod - riverpod_annotation: - path: ../packages/riverpod_annotation - riverpod_generator: - path: ../packages/riverpod_generator riverpod_analyzer_utils: path: ../packages/riverpod_analyzer_utils riverpod_lint: @@ -20,4 +10,14 @@ dependency_overrides: analyzer_plugin: ^0.11.3 # Hotreloader issue - vm_service: ^14.0.0 \ No newline at end of file + vm_service: ^14.0.0 + flutter_riverpod: + path: ../packages/flutter_riverpod + hooks_riverpod: + path: ../packages/hooks_riverpod + riverpod: + path: ../packages/riverpod + riverpod_annotation: + path: ../packages/riverpod_annotation + riverpod_generator: + path: ../packages/riverpod_generator From b633016be9b46139c31da9ccc5ff5379a9c8de18 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 25 Feb 2024 18:50:27 +0100 Subject: [PATCH 231/387] Add `@Dependencies` (#3364) fixes #2356 fixes #2241 --- analysis_options.yaml | 3 + examples/counter/lib/main.g.dart | 1 - examples/pub/lib/detail.g.dart | 1 - examples/pub/lib/search.g.dart | 2 - melos.yaml | 2 +- .../lint_visitor_generator/lib/builder.dart | 374 +-- .../lib/src/type_checker.dart | 8 - packages/riverpod_analyzer_utils/CHANGELOG.md | 6 + .../lib/riverpod_analyzer_utils.dart | 12 +- .../lib/src/analyzer_utils.dart | 27 + .../lib/src/argument_list_utils.dart | 9 + .../lib/src/element_util.dart | 60 + .../lib/src/errors.dart | 14 +- .../lib/src/nodes.dart | 71 + .../lib/src/nodes.g.dart | 1064 +++++++ .../lib/src/nodes/dependencies.dart | 469 +++ .../lib/src/nodes/provider_for.dart | 23 + .../lib/src/nodes/provider_listenable.dart | 44 + .../lib/src/nodes/provider_or_family.dart | 91 + .../lib/src/nodes/providers/function.dart | 108 + .../lib/src/nodes/providers/identifiers.dart | 35 + .../lib/src/nodes/providers/legacy.dart | 297 ++ .../lib/src/nodes/providers/notifier.dart | 185 ++ .../lib/src/nodes/providers/providers.dart | 159 + .../lib/src/nodes/ref_invocation.dart | 159 + .../lib/src/nodes/riverpod.dart | 115 + .../lib/src/nodes/scopes/overrides.dart | 78 + .../src/nodes/scopes/provider_container.dart | 36 + .../lib/src/nodes/scopes/provider_scope.dart | 34 + .../lib/src/nodes/widget_ref_invocation.dart | 203 ++ .../lib/src/nodes/widgets/state.dart | 78 + .../src/nodes/widgets/stateful_widget.dart | 101 + .../src/nodes/widgets/stateless_widget.dart | 45 + .../lib/src/nodes/widgets/widget.dart | 41 + .../lib/src/object_extensions.dart | 17 + .../lib/src/riverpod_ast.dart | 76 - .../lib/src/riverpod_ast.g.dart | 2029 ------------- .../lib/src/riverpod_ast/consumer.dart | 214 -- .../generator_provider_declaration.dart | 413 --- .../legacy_provider_declaration.dart | 226 -- ...ontainer_instance_creation_expression.dart | 32 - .../riverpod_ast/provider_declaration.dart | 8 - .../provider_listenable_expression.dart | 117 - .../src/riverpod_ast/provider_override.dart | 72 - .../lib/src/riverpod_ast/provider_scope.dart | 31 - .../lib/src/riverpod_ast/ref_invocation.dart | 184 -- .../src/riverpod_ast/resolve_riverpod.dart | 252 -- .../src/riverpod_ast/riverpod_annotation.dart | 203 -- .../riverpod_ast/widget_ref_invocation.dart | 232 -- .../lib/src/riverpod_element.dart | 395 --- .../lib/src/riverpod_types.dart | 239 +- .../lib/src/riverpod_types/core.dart | 119 + .../lib/src/riverpod_types/generator.dart | 19 + .../src/riverpod_types/legacy_providers.dart | 56 + .../lib/src/riverpod_types/providers.dart | 31 + .../lib/src/riverpod_types/widgets.dart | 85 + .../test/analyzer_test_utils.dart | 247 +- .../test/consumer_test.dart | 133 +- .../legacy_provider_declaration_test.dart | 57 +- .../test/matchers.dart | 344 +++ .../test/nodes/dependencies_test.dart | 97 + .../providers/generated_providers_test.dart} | 240 +- .../nodes/providers/identifiers_test.dart | 88 + .../test/nodes/riverpod_test.dart | 276 ++ .../test/provider_container_test.dart | 51 +- .../test/provider_scope_test.dart | 61 +- .../test/ref_invocation_test.dart | 217 +- .../test/type_utils_test.dart | 184 ++ .../test/widget_ref_invocation_test.dart | 227 +- packages/riverpod_annotation/CHANGELOG.md | 7 + .../lib/src/riverpod_annotation.dart | 84 +- packages/riverpod_generator/CHANGELOG.md | 24 + .../integration/build_yaml/lib/main.g.dart | 387 ++- .../lib/src/riverpod_generator.dart | 52 +- packages/riverpod_generator/pubspec.yaml | 2 +- .../test/annotated_test.dart | 1 - .../riverpod_generator/test/doc_test.dart | 1 - .../test/integration/annotated.g.dart | 466 ++- .../test/integration/async.g.dart | 299 +- .../test/integration/auto_dispose.g.dart | 2 - .../test/integration/dependencies.g.dart | 1445 +++++---- .../test/integration/dependencies2.g.dart | 239 +- .../test/integration/documented.g.dart | 149 +- .../test/integration/generated.g.dart | 959 +++--- .../test/integration/hash/hash1.g.dart | 1 - .../test/integration/scopes.dart | 1 - .../test/integration/scopes.g.dart | 1 - .../test/integration/split.g.dart | 1 - .../test/integration/stream.g.dart | 299 +- .../test/integration/sync.g.dart | 2677 ++++++++--------- .../generated/golden/lib/sync.g.dart | 1 - packages/riverpod_lint/CHANGELOG.md | 25 +- packages/riverpod_lint/README.md | 31 + packages/riverpod_lint/lib/riverpod_lint.dart | 3 +- .../avoid_build_context_in_providers.dart | 1 - ...ders_as_generated_provider_dependency.dart | 28 +- .../src/lints/avoid_read_auto_dispose.dart | 40 - .../lints/avoid_ref_inside_state_dispose.dart | 1 - .../lib/src/lints/functional_ref.dart | 4 - .../lib/src/lints/missing_provider_scope.dart | 1 - .../lib/src/lints/notifier_build.dart | 1 - .../lib/src/lints/notifier_extends.dart | 1 - ...only_use_keep_alive_inside_keep_alive.dart | 31 +- .../lints/protected_notifier_properties.dart | 14 +- .../lib/src/lints/provider_dependencies.dart | 494 ++- .../lib/src/lints/provider_parameters.dart | 7 +- .../lib/src/lints/riverpod_syntax_error.dart | 40 +- ...providers_should_specify_dependencies.dart | 80 +- .../lib/src/lints/unknown_scoped_usage.dart | 65 + .../src/migration/missing_legacy_import.dart | 1 - .../riverpod_lint/lib/src/object_utils.dart | 12 + .../lib/src/riverpod_custom_lint.dart | 4 +- packages/riverpod_lint_flutter_test/README.md | 8 + ..._class_based_provider_to_functional.g.dart | 1 - ..._functional_provider_to_class_based.g.dart | 2 - .../test/golden.dart | 3 +- .../test/lints/another.g.dart | 1 - .../avoid_build_context_in_providers.g.dart | 1 - .../avoid_public_notifier_properties.g.dart | 1 - .../lints/functional_ref/functional_ref.dart | 3 - .../lints/functional_ref/functional_ref.diff | 6 +- .../functional_ref/functional_ref.g.dart | 61 - .../dependencies.dart | 213 +- .../dependencies.diff | 135 + .../dependencies.g.dart | 706 ++--- .../provider_dependencies.dart | 225 ++ .../provider_dependencies.diff | 149 + .../provider_dependencies.g.dart | 571 ++++ .../provider_dependencies_test.dart | 41 + .../notifier_extends/notifier_extends.g.dart | 1 - ...ly_use_keep_alive_inside_keep_alive.g.dart | 205 +- .../protected_notifier_properties.g.dart | 1 - .../provider_dependencies.dart | 108 - .../provider_dependencies.diff | 137 - .../test/lints/provider_parameters.g.dart | 2 - ...providers_should_specify_dependencies.dart | 57 +- ...oviders_should_specify_dependencies.g.dart | 98 +- .../test/lints/unknown_scoped_usage.dart | 63 + .../test/lints/unknown_scoped_usage.g.dart | 128 + .../lints/unsupported_provider_value.g.dart | 1211 ++++---- .../provider_dependencies.dart | 143 + .../provider_dependencies.diff | 141 + .../provider_dependencies.g.dart | 416 +-- .../provider_dependencies_test.dart | 7 +- .../advanced/select/select/codegen.g.dart | 1 - .../select/select_async/codegen.g.dart | 1 - .../cancel/detail_screen/codegen.g.dart | 1 - .../detail_screen_cancel/codegen.g.dart | 1 - .../detail_screen_debounce/codegen.g.dart | 1 - .../provider_with_extension/codegen.g.dart | 1 - .../fetch_activity/codegen.g.dart | 1 - .../pull_to_refresh/full_app/codegen.g.dart | 1 - .../docs/concepts/about_codegen/main.g.dart | 2 - .../provider_type/async_class_future.g.dart | 1 - .../provider_type/async_class_stream.g.dart | 1 - .../provider_type/async_fn_future.g.dart | 1 - .../provider_type/async_fn_stream.g.dart | 1 - .../provider_type/auto_dispose.g.dart | 1 - .../about_codegen/provider_type/family.g.dart | 2 - .../provider_type/family_class.g.dart | 1 - .../provider_type/family_fn.g.dart | 2 - .../provider_type/sync_class.g.dart | 1 - .../provider_type/sync_fn.g.dart | 1 - .../characters_provider/codegen.g.dart | 1 - .../city_provider/codegen.g.dart | 1 - .../codegen.g.dart | 1 - .../read_in_provider/codegen.g.dart | 1 - .../select_async_provider/codegen.g.dart | 1 - .../todo_list_provider/codegen.g.dart | 1 - .../weather_provider/codegen.g.dart | 1 - .../whole_object_provider/codegen.g.dart | 1 - .../lifecycle_on_dispose/codegen.g.dart | 1 - .../creating_a_provider/codegen.g.dart | 1 - .../declaring_many_providers/codegen.g.dart | 1 - .../concepts/reading/counter/codegen.g.dart | 1 - .../concepts/reading/listen/codegen.g.dart | 1 - .../reading/listen_build/codegen.g.dart | 1 - .../reading/listen_build/codegen_hooks.g.dart | 1 - .../concepts/reading/provider/codegen.g.dart | 1 - .../docs/concepts/reading/read/codegen.g.dart | 1 - .../reading/read/codegen_hooks.g.dart | 1 - .../reading/read_build/codegen.g.dart | 1 - .../read_notifier_build/codegen.g.dart | 1 - .../concepts/reading/watch/codegen.g.dart | 121 +- .../reading/watch_build/codegen.g.dart | 119 +- .../reading/watch_build/codegen_hooks.g.dart | 119 +- .../watch_notifier_build/codegen.g.dart | 1 - .../concepts/why_immutability/codegen.g.dart | 1 - .../cache_for_usage/codegen.g.dart | 1 - .../auto_dispose/codegen_keep_alive.g.dart | 1 - .../invalidate_family_example/codegen.g.dart | 2 - .../auto_dispose/keep_alive/codegen.g.dart | 1 - .../on_dispose_example/codegen.g.dart | 1 - .../functional_ref/codegen.g.dart | 1 - .../listen_example/codegen.g.dart | 1 - .../notifier_ref/codegen.g.dart | 1 - .../read_example/codegen.g.dart | 1 - .../watch_example/codegen.g.dart | 1 - .../watch_placement/codegen.g.dart | 1 - .../require_value/codegen.g.dart | 1 - .../first_request/codegen/provider.g.dart | 1 - .../passing_args/family/codegen.g.dart | 1 - .../no_arg_provider/codegen.g.dart | 1 - .../codegen/todo_list_notifier.g.dart | 1 - .../todo_list_notifier_add_todo.g.dart | 1 - .../codegen/todo_list_provider.g.dart | 1 - .../testing/notifier_mock/codegen.g.dart | 1 - .../testing/provider_to_mock/codegen.g.dart | 1 - .../pipe_change_notifier.g.dart | 1 - .../websockets_sync/raw_usage.g.dart | 1 - .../shared_pipe_change_notifier.g.dart | 1 - .../stream_provider/codegen.g.dart | 1 - .../sync_definition/codegen.g.dart | 1 - .../docs/from_provider/family/family.g.dart | 2 - .../async_values/async_values.g.dart | 1 - .../auto_dispose/auto_dispose.g.dart | 1 - .../motivation/combine/combine.g.dart | 1 - .../motivation/same_type/same_type.g.dart | 1 - .../dart_hello_world/main.g.dart | 1 - .../hello_world/hooks_codegen/main.g.dart | 1 - .../getting_started/hello_world/main.g.dart | 1 - .../introduction/why_riverpod/codegen.g.dart | 2 - .../declaration/declaration.g.dart | 1 - .../initialization/initialization.g.dart | 1 - .../migrated/migrated.g.dart | 1 - .../add_listener/add_listener.g.dart | 1 - .../async_notifier/async_notifier.g.dart | 1 - .../build_init/build_init.g.dart | 1 - .../family_and_dispose.g.dart | 1 - .../from_state_provider.g.dart | 1 - .../old_lifecycles/old_lifecycles.g.dart | 1 - .../old_lifecycles_final.g.dart | 1 - .../config_provider/codegen.g.dart | 1 - .../remote_todos/codegen.g.dart | 1 - .../notifier_provider/todos/codegen.g.dart | 1 - .../completed_todos/completed_todos.g.dart | 1 - .../optimized_previous_button.g.dart | 123 +- .../docs/providers/provider/todo/todo.g.dart | 1 - .../unoptimized_previous_button.g.dart | 1 - .../live_stream_chat_provider/codegen.g.dart | 1 - website/static/snippets/async.g.dart | 1 - website/static/snippets/combine.g.dart | 1 - website/static/snippets/create.g.dart | 1 - website/static/snippets/declare.g.dart | 1 - 244 files changed, 12887 insertions(+), 11751 deletions(-) create mode 100644 packages/riverpod_analyzer_utils/lib/src/analyzer_utils.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/element_util.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes.g.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/provider_for.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/provider_listenable.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/provider_or_family.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/providers/function.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/providers/identifiers.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/providers/legacy.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/providers/notifier.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/providers/providers.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/scopes/overrides.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_container.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_scope.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/widgets/state.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateless_widget.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/nodes/widgets/widget.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/object_extensions.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast.g.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast/consumer.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast/legacy_provider_declaration.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_container_instance_creation_expression.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_declaration.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_listenable_expression.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_override.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_scope.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast/ref_invocation.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast/resolve_riverpod.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_ast/widget_ref_invocation.dart delete mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_types/core.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_types/generator.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_types/legacy_providers.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_types/providers.dart create mode 100644 packages/riverpod_analyzer_utils/lib/src/riverpod_types/widgets.dart create mode 100644 packages/riverpod_analyzer_utils_tests/test/matchers.dart create mode 100644 packages/riverpod_analyzer_utils_tests/test/nodes/dependencies_test.dart rename packages/riverpod_analyzer_utils_tests/test/{generator_provider_declaration_test.dart => nodes/providers/generated_providers_test.dart} (67%) create mode 100644 packages/riverpod_analyzer_utils_tests/test/nodes/providers/identifiers_test.dart create mode 100644 packages/riverpod_analyzer_utils_tests/test/nodes/riverpod_test.dart create mode 100644 packages/riverpod_analyzer_utils_tests/test/type_utils_test.dart delete mode 100644 packages/riverpod_lint/lib/src/lints/avoid_read_auto_dispose.dart create mode 100644 packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart create mode 100644 packages/riverpod_lint_flutter_test/README.md rename packages/riverpod_lint_flutter_test/test/lints/{ => missing_provider_dependency}/dependencies.dart (58%) create mode 100644 packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.diff rename packages/riverpod_lint_flutter_test/test/lints/{ => missing_provider_dependency}/dependencies.g.dart (73%) create mode 100644 packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.diff create mode 100644 packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.g.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies_test.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.diff create mode 100644 packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.diff rename packages/riverpod_lint_flutter_test/test/lints/{provider_dependencies => unused_provider_dependency}/provider_dependencies.g.dart (66%) rename packages/riverpod_lint_flutter_test/test/lints/{provider_dependencies => unused_provider_dependency}/provider_dependencies_test.dart (73%) diff --git a/analysis_options.yaml b/analysis_options.yaml index 60d9c6488..7ee5dfa6d 100644 --- a/analysis_options.yaml +++ b/analysis_options.yaml @@ -14,6 +14,9 @@ analyzer: linter: rules: + # Not an issue if using dartfmt + no_adjacent_strings_in_list: false + # False positive for custom enum-like classes (such as Flutter's "Colors") avoid_classes_with_only_static_members: false diff --git a/examples/counter/lib/main.g.dart b/examples/counter/lib/main.g.dart index fb9ec79d9..5724b41e4 100644 --- a/examples/counter/lib/main.g.dart +++ b/examples/counter/lib/main.g.dart @@ -86,6 +86,5 @@ abstract class _$Counter extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 32555b792..08d43e644 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -431,6 +431,5 @@ abstract class _$PackageMetrics extends $AsyncNotifier { ); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 6e35485e5..d1e5407f0 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -158,7 +158,5 @@ final class FetchPackagesFamily extends Family { ); } } - -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/melos.yaml b/melos.yaml index 660b3bc88..f7b090d9b 100644 --- a/melos.yaml +++ b/melos.yaml @@ -19,5 +19,5 @@ scripts: flutter pub get generate: - run: melos exec --depends-on=build_runner -- "dart run build_runner build -d" + run: melos exec --depends-on=lint_visitor_generator -- "dart run build_runner build -d" && melos exec --depends-on=build_runner --no-depends-on=lint_visitor_generator -- "dart run build_runner build -d" description: Build all generated files for Dart & Flutter packages in this project. diff --git a/packages/lint_visitor_generator/lib/builder.dart b/packages/lint_visitor_generator/lib/builder.dart index 2e415ff34..12a98c422 100644 --- a/packages/lint_visitor_generator/lib/builder.dart +++ b/packages/lint_visitor_generator/lib/builder.dart @@ -1,12 +1,10 @@ +// ignore_for_file: require_trailing_commas + import 'package:analyzer/dart/element/element.dart'; -import 'package:analyzer/dart/element/nullability_suffix.dart'; -import 'package:analyzer/dart/element/type.dart'; import 'package:build/build.dart'; import 'package:collection/collection.dart'; import 'package:source_gen/source_gen.dart' hide TypeChecker; -import 'src/type_checker.dart'; - /// Builds generators for `build_runner` to run Builder lintVisitorGenerator(BuilderOptions options) { return SharedPartBuilder( @@ -15,56 +13,19 @@ Builder lintVisitorGenerator(BuilderOptions options) { ); } -const _riverpodAstType = TypeChecker.fromName( - 'RiverpodAst', - packageName: 'riverpod_analyzer_utils', -); - -sealed class _AstField { - _AstField({required this.field, required this.type}); - - static _AstField? parse(FieldElement field) { - if (field.type.isDartCoreList) { - final valueType = (field.type as InterfaceType).typeArguments.single; - if (!_riverpodAstType.isAssignableFromType(valueType)) return null; - - return _ListAstField( - field: field, - type: field.type, - valueType: valueType, - ); - } else { - if (!_riverpodAstType.isAssignableFromType(field.type)) return null; - return _SingleAstField(field: field, type: field.type); - } +extension on String { + String get plural { + if (endsWith('y')) return '${substring(0, length - 1)}ies'; + if (endsWith('s')) return '${this}List'; + return '${this}s'; } - - final FieldElement field; - final DartType type; -} - -class _ListAstField extends _AstField { - _ListAstField({ - required super.field, - required super.type, - required this.valueType, - }); - - final DartType valueType; -} - -class _SingleAstField extends _AstField { - _SingleAstField({ - required super.field, - required super.type, - }); } class _LintVisitorGenerator extends Generator { @override String generate(LibraryReader library, BuildStep buildStep) { final buffer = StringBuffer(); - if (library.element.name == 'riverpod_ast') { + if (library.element.name == 'nodes') { _writeRiverpodAstVisitor(library, buffer); } @@ -76,131 +37,151 @@ class _LintVisitorGenerator extends Generator { } void _writeRiverpodAstVisitor(LibraryReader library, StringBuffer buffer) { - final allAst = library.classes - .where((e) => e.name != 'RiverpodAst') - .where(_riverpodAstType.isAssignableFrom) - .toList(); - - final relationships = >{}; + final allAst = library.element.topLevelElements + .whereType() + .where((e) => e.metadata.firstOrNull?.toSource() == '@_ast') + .expand((extension) { + final constraint = extension.extendedType; + + return extension.accessors.map( + (e) => ( + constraint: constraint.element!.name!, + type: e.returnType.element!.name!, + name: e.name, + ), + ); + }).toList(); + final byConstraint = <({ + String type, + String name, + }), + List<({String type, String name})>>{}; for (final ast in allAst) { - final relation = relationships.putIfAbsent(ast, () => {}); - - final allSuperAstTypes = ast.allSupertypes - .where((e) => !e.isDartCoreObject && e.element.name != 'RiverpodAst') - .toList(); - - final inheritedSuperTypes = []; - for (var superType = ast.supertype; - superType != null && - superType.element.name != 'RiverpodAst' && - !superType.isDartCoreObject; - superType = superType.superclass) { - inheritedSuperTypes.add(superType); - } - - for (final superAst in allSuperAstTypes) { - relation.add(superAst.element.name); - } - - final astFields = ast.fields - // Exclude fields already handled by the supertype - .where( - (field) => inheritedSuperTypes - .expand((e) => e.accessors) - .every((superField) => superField.name != field.name), - ) - .map(_AstField.parse) - .whereNotNull() - .toList(); - - _writeAstMixin( - buffer, - ast, - astFields, - hasSuperType: inheritedSuperTypes.isNotEmpty, - ); + byConstraint.putIfAbsent(( + type: ast.constraint, + name: ast.constraint == 'AstNode' ? 'Node' : ast.constraint, + ), () => []).add((type: ast.type, name: ast.name)); } - final concreteRelationshipEntries = - relationships.entries.where((e) => !e.key.isAbstract); - buffer.writeln(''' -abstract class RiverpodAstVisitor { - ${concreteRelationshipEntries.map( - (e) => ''' - void visit${e.key.name}(${e.key.name} node); -''', - ).join('\n')} +mixin RiverpodAstVisitor { + ${allAst.map((e) => 'void visit${e.type}(${e.type} node) {}').join('\n')} } -abstract class GeneralizingRiverpodAstVisitor implements RiverpodAstVisitor { - void visitRiverpodAst(RiverpodAst node) { - node.visitChildren(this); - } - - ${relationships.entries.map( - (e) => ''' - ${e.key.isAbstract ? '' : '@override'} - void visit${e.key.name}(${e.key.name} node) { - ${e.value.map((e) => 'visit$e(node);').join('\n')} +abstract class RecursiveRiverpodAstVisitor + extends GeneralizingAstVisitor + with RiverpodAstVisitor { + ${byConstraint.entries.map((e) => ''' +@override +void visit${e.key.name}(${e.key.type} node) { + ${e.value.map((e) => ''' + if (node.${e.name} case final value?) { + visit${e.type}(value); + return; } -''', - ).join('\n')} -} + ''').join('\n')} + super.visit${e.key.name}(node); +}''').join('\n')} -abstract class RecursiveRiverpodAstVisitor implements RiverpodAstVisitor { - ${concreteRelationshipEntries.map( - (e) => ''' - @override - void visit${e.key.name}(${e.key.name} node) { - node.visitChildren(this); + ${allAst.map((e) => ''' + void visit${e.type}(${e.type} node) { + super.visit${e.constraint == 'AstNode' ? 'Node' : e.constraint}(node.node); } -''', - ).join('\n')} + ''').join('\n')} + } -abstract class SimpleRiverpodAstVisitor implements RiverpodAstVisitor { - ${concreteRelationshipEntries.map( - (e) => ''' +abstract class SimpleRiverpodAstVisitor + extends RecursiveRiverpodAstVisitor { @override - void visit${e.key.name}(${e.key.name} node) { - } -''', - ).join('\n')} + void visitNode(AstNode node) {} } -abstract class UnimplementedRiverpodAstVisitor implements RiverpodAstVisitor { - ${concreteRelationshipEntries.map( - (e) => ''' +abstract class UnimplementedRiverpodAstVisitor + extends SimpleRiverpodAstVisitor { + ${allAst.map((e) => 'void visit${e.type}(${e.type} node) => throw UnimplementedError();').join('\n')} +} + +@internal +class CollectionRiverpodAst extends SimpleRiverpodAstVisitor { + final Map> riverpodAst = {}; + List? _pendingList; + +${byConstraint.keys.map((e) => ''' @override - void visit${e.key.name}(${e.key.name} node) { - throw UnimplementedError(); + void visit${e.name}( + ${e.type} node, + ) { + final list = riverpodAst.putIfAbsent('${e.type}', () => []); + final previousList = list; + _pendingList = list; + super.visit${e.name}(node); + _pendingList = previousList; } -''', - ).join('\n')} +''').join('\n')} + +${allAst.map((e) => ''' + void visit${e.type}(${e.type} node) { + _pendingList!.add(node); + } +''').join('\n')} } @internal -class RiverpodAnalysisResult extends GeneralizingRiverpodAstVisitor { - ${relationships.entries.map( - (e) => ''' - final ${e.key.name.lowerFirst}s = - <${e.key.name}>[]; +class RiverpodAnalysisResult extends RecursiveRiverpodAstVisitor { + final List errors = []; + + ${allAst.map((e) => ''' + final ${e.type.lowerFirst.plural} = <${e.type}>[]; @override - void visit${e.key.name}( - ${e.key.name} node, + void visit${e.type}( + ${e.type} node, + ) { + super.visit${e.type}(node); + ${e.type.lowerFirst.plural}.add(node); + } +''').join('\n')} +} + +class RiverpodAstRegistry { + void run(AstNode node) { + final previousErrorReporter = errorReporter; + try { + final errors = node.upsert( + 'RiverpodAstRegistry.errors', + () => [], + ); + + final visitor = _RiverpodAstRegistryVisitor(this); + errorReporter = errors.add; + + node.accept(visitor); + for (final error in errors) { + visitor._runSubscriptions(error, _onRiverpodAnalysisError); + } + } finally { + errorReporter = previousErrorReporter; + } + } + + final _onRiverpodAnalysisError = []; + void addRiverpodAnalysisError( + void Function(RiverpodAnalysisError node) cb, ) { - super.visit${e.key.name}(node); - ${e.key.name.lowerFirst}s.add(node); + _onRiverpodAnalysisError.add(cb); } -''', - ).join('\n')} + ${allAst.map((e) => ''' + final _on${e.type} = []; + void add${e.type}(void Function(${e.type} node) cb) { + _on${e.type}.add(cb); + } +''').join('\n')} } -class _RiverpodAstRegistryVisitor extends GeneralizingRiverpodAstVisitor { +class _RiverpodAstRegistryVisitor extends RecursiveRiverpodAstVisitor { _RiverpodAstRegistryVisitor(this._registry); final RiverpodAstRegistry _registry; @@ -218,110 +199,17 @@ class _RiverpodAstRegistryVisitor extends GeneralizingRiverpodAstVisitor { } } + ${allAst.map((e) => ''' @override - void visitRiverpodAst(RiverpodAst node) { - node.visitChildren(this); - } - - ${relationships.entries.map( - (e) => ''' - @override - void visit${e.key.name}(${e.key.name} node) { - super.visit${e.key.name}(node); - node.visitChildren(this); + void visit${e.type}(${e.type} node) { + super.visit${e.type}(node); _runSubscriptions( node, - _registry._on${e.key.name}, + _registry._on${e.type}, ); } -''', - ).join('\n')} -} - -class RiverpodAstRegistry { - void run(RiverpodAst node) { - node.accept(_RiverpodAstRegistryVisitor(this)); - } - - final _onRiverpodAst = []; - void addRiverpodAst(void Function(RiverpodAst node) cb) { - _onRiverpodAst.add(cb); - } - - ${relationships.entries.map( - (e) => ''' - final _on${e.key.name} = []; - void add${e.key.name}(void Function(${e.key.name} node) cb) { - _on${e.key.name}.add(cb); - } -''', - ).join('\n')} -} -'''); - } - - void _writeAstMixin( - StringBuffer buffer, - ClassElement ast, - List<_AstField> astFields, { - required bool hasSuperType, - }) { - late final accept = ''' - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visit${ast.name}(this as ${ast.name},); - } - '''; - - final visitChildren = StringBuffer(); - if (hasSuperType) { - visitChildren.writeln('super.visitChildren(visitor);'); - } - - for (final field in astFields) { - switch (field) { - case _ListAstField(): - final op = - field.valueType.nullabilitySuffix == NullabilitySuffix.question - ? '?' - : ''; - - var leading = ''; - var trailing = ''; - if (field.type.nullabilitySuffix == NullabilitySuffix.question) { - leading = - 'if (${field.field.name} case final ${field.field.name}?) {'; - trailing = '}'; - } - - visitChildren.writeln(''' - $leading - for (final value in ${field.field.name}) { - value$op.accept(visitor); - } - $trailing - '''); - - case _SingleAstField(): - final op = field.type.nullabilitySuffix == NullabilitySuffix.question - ? '?' - : ''; - visitChildren.writeln( - '${field.field.name}$op.accept(visitor);', - ); - } - } - - buffer.writeln(''' -base mixin _\$${ast.name} on RiverpodAst { - ${astFields.map((e) => '${e.type} get ${e.field.name};').join('\n')} - - ${ast.isAbstract ? '' : accept} - - @override void visitChildren(RiverpodAstVisitor visitor) { - $visitChildren - } +''').join('\n')} } '''); } diff --git a/packages/lint_visitor_generator/lib/src/type_checker.dart b/packages/lint_visitor_generator/lib/src/type_checker.dart index 85da4569c..6ec046641 100644 --- a/packages/lint_visitor_generator/lib/src/type_checker.dart +++ b/packages/lint_visitor_generator/lib/src/type_checker.dart @@ -111,14 +111,6 @@ abstract class TypeChecker { return results.isEmpty ? null : results.first; } - /// Returns if a constant annotating [element] is exactly this type. - /// - /// Throws [UnresolvedAnnotationException] on unresolved annotations unless - /// [throwOnUnresolved] is explicitly set to `false` (default is `true`). - bool hasAnnotationOfExact(Element element, {bool throwOnUnresolved = true}) => - firstAnnotationOfExact(element, throwOnUnresolved: throwOnUnresolved) != - null; - DartObject? _computeConstantValue( Element element, int annotationIndex, { diff --git a/packages/riverpod_analyzer_utils/CHANGELOG.md b/packages/riverpod_analyzer_utils/CHANGELOG.md index a127ba0d2..cd2469aaa 100644 --- a/packages/riverpod_analyzer_utils/CHANGELOG.md +++ b/packages/riverpod_analyzer_utils/CHANGELOG.md @@ -1,3 +1,9 @@ +## Unreleased build + +- **Breaking**: Rewrote all RiverpodAst nodes to instead be extensions on `AstNodes`. + Too many changes to detail everything. I'm the only one who uses this package anyway. + If you're reading this, have a nice day! + ## 1.0.0-dev.1 - 2023-11-20 - **Breaking** `LegacyProviderDeclarationElement.providerType` is now nullable. diff --git a/packages/riverpod_analyzer_utils/lib/riverpod_analyzer_utils.dart b/packages/riverpod_analyzer_utils/lib/riverpod_analyzer_utils.dart index fd1d41085..e2bdd7b46 100644 --- a/packages/riverpod_analyzer_utils/lib/riverpod_analyzer_utils.dart +++ b/packages/riverpod_analyzer_utils/lib/riverpod_analyzer_utils.dart @@ -1,5 +1,9 @@ -// TODO changelog exported -export 'src/errors.dart' hide errorReporter, ErrorReporter; -export 'src/riverpod_ast.dart' hide ObjectUtils, RiverpodAnalysisResult; -export 'src/riverpod_element.dart'; +export 'src/errors.dart' hide ErrorReporter; +export 'src/nodes.dart' + hide + parseFirstProviderFor, + parseLegacyProviderType, + parseProviderFor, + CollectionRiverpodAst, + RiverpodAnalysisResult; export 'src/riverpod_types.dart'; diff --git a/packages/riverpod_analyzer_utils/lib/src/analyzer_utils.dart b/packages/riverpod_analyzer_utils/lib/src/analyzer_utils.dart new file mode 100644 index 000000000..28ba8144a --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/analyzer_utils.dart @@ -0,0 +1,27 @@ +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:meta/meta.dart'; + +@internal +extension AstUtils on AstNode { + R upsert( + String keyPart, + R Function() create, + ) { + final key = 'riverpod.$keyPart'; + // Using a record to differentiate "null value" from "no value". + final existing = getProperty<(R value,)>(key); + if (existing != null) return existing.$1; + + final created = create(); + setProperty(key, (created,)); + return created; + } + + Iterable get ancestors sync* { + var parent = this.parent; + while (parent != null) { + yield parent; + parent = parent.parent; + } + } +} diff --git a/packages/riverpod_analyzer_utils/lib/src/argument_list_utils.dart b/packages/riverpod_analyzer_utils/lib/src/argument_list_utils.dart index 838584c82..1a7a81f1a 100644 --- a/packages/riverpod_analyzer_utils/lib/src/argument_list_utils.dart +++ b/packages/riverpod_analyzer_utils/lib/src/argument_list_utils.dart @@ -1,4 +1,5 @@ import 'package:analyzer/dart/ast/ast.dart'; +import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; /// Utilities for [ArgumentList] to help with specific argument retrieval. @@ -13,4 +14,12 @@ extension ArgumentListUtils on ArgumentList { Iterable namedArguments() { return arguments.whereType(); } + + NamedExpression? named(String name) { + return namedArguments().firstWhereOrNull((e) => e.name.label.name == name); + } + + Expression? positional(int index) { + return positionalArguments().elementAtOrNull(index); + } } diff --git a/packages/riverpod_analyzer_utils/lib/src/element_util.dart b/packages/riverpod_analyzer_utils/lib/src/element_util.dart new file mode 100644 index 000000000..4049e354a --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/element_util.dart @@ -0,0 +1,60 @@ +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/element/element.dart'; +import 'package:analyzer/dart/element/nullability_suffix.dart'; +import 'package:analyzer/dart/element/type.dart'; +import 'package:collection/collection.dart'; +import 'package:meta/meta.dart'; + +import 'errors.dart'; +import 'riverpod_types.dart'; + +@internal +extension LibraryElementX on CompilationUnit { + static final _asyncValueCache = Expando(); + + LibraryElement? get _library => declaredElement?.library; + + Element? findElementWithNameFromPackage( + String name, { + required String packageName, + }) { + return _library!.importedLibraries + .map((e) => e.exportNamespace.get(name)) + .firstWhereOrNull( + // TODO find a way to test this + (element) => element != null && isFromRiverpod.isExactly(element), + ); + } + + ClassElement? findAsyncValue() { + final cache = _asyncValueCache[this]; + if (cache != null) return cache; + + final result = findElementWithNameFromPackage( + 'AsyncValue', + packageName: 'riverpod', + ); + if (result == null) { + errorReporter( + RiverpodAnalysisError( + 'No AsyncValue accessible in the library. ' + 'Did you forget to import Riverpod?', + targetNode: this, + code: null, + ), + ); + return null; + } + + return _asyncValueCache[this] = result as ClassElement?; + } + + DartType? createdTypeToValueType(DartType? typeArg) { + final asyncValue = findAsyncValue(); + + return asyncValue?.instantiate( + typeArguments: [if (typeArg != null) typeArg], + nullabilitySuffix: NullabilitySuffix.none, + ); + } +} diff --git a/packages/riverpod_analyzer_utils/lib/src/errors.dart b/packages/riverpod_analyzer_utils/lib/src/errors.dart index 9942e4208..47a82ee35 100644 --- a/packages/riverpod_analyzer_utils/lib/src/errors.dart +++ b/packages/riverpod_analyzer_utils/lib/src/errors.dart @@ -5,15 +5,19 @@ import 'package:meta/meta.dart'; @internal typedef ErrorReporter = void Function(RiverpodAnalysisError); -@internal -ErrorReporter? errorReporter; +ErrorReporter errorReporter = (error) { + throw UnsupportedError( + 'RiverpodAnalysisError found but no errorReporter specified: $error', + ); +}; enum RiverpodAnalysisErrorCode { missingNotifierBuild, abstractNotifier, missingNotifierDefaultConstructor, notifierDefaultConstructorHasRequiredParameters, - riverpodDependencyParseError, + providerDependencyListParseError, + providerOrFamilyExpressionParseError, } class RiverpodAnalysisError { @@ -33,10 +37,10 @@ class RiverpodAnalysisError { String toString() { var trailing = ''; if (targetElement != null) { - trailing += '\nelement: $targetElement (${targetElement.runtimeType})'; + trailing += ' ; element: $targetElement (${targetElement.runtimeType})'; } if (targetNode != null) { - trailing += '\nelement: $targetNode (${targetNode.runtimeType})'; + trailing += ' ; node: $targetNode (${targetNode.runtimeType})'; } return 'RiverpodAnalysisError: $message$trailing'; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes.dart b/packages/riverpod_analyzer_utils/lib/src/nodes.dart new file mode 100644 index 000000000..fe288f180 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes.dart @@ -0,0 +1,71 @@ +library nodes; + +import 'dart:async'; +import 'dart:convert'; + +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/ast/syntactic_entity.dart'; +import 'package:analyzer/dart/ast/token.dart'; +import 'package:analyzer/dart/ast/visitor.dart'; +import 'package:analyzer/dart/constant/value.dart'; +import 'package:analyzer/dart/element/element.dart'; +import 'package:analyzer/dart/element/type.dart'; +import 'package:collection/collection.dart'; +import 'package:crypto/crypto.dart'; +import 'package:meta/meta.dart'; + +import '../riverpod_analyzer_utils.dart'; +import 'analyzer_utils.dart'; +import 'argument_list_utils.dart'; +import 'element_util.dart'; +import 'object_extensions.dart'; + +part 'nodes/widgets/state.dart'; +part 'nodes/widgets/stateful_widget.dart'; +part 'nodes/widgets/stateless_widget.dart'; +part 'nodes/widgets/widget.dart'; + +part 'nodes/dependencies.dart'; +part 'nodes/providers/function.dart'; +part 'nodes/providers/legacy.dart'; +part 'nodes/providers/notifier.dart'; +part 'nodes/providers/providers.dart'; +part 'nodes/providers/identifiers.dart'; + +part 'nodes/provider_for.dart'; +part 'nodes/provider_or_family.dart'; +part 'nodes/riverpod.dart'; +part 'nodes/provider_listenable.dart'; +part 'nodes/ref_invocation.dart'; +part 'nodes/widget_ref_invocation.dart'; + +part 'nodes/scopes/overrides.dart'; +part 'nodes/scopes/provider_container.dart'; +part 'nodes/scopes/provider_scope.dart'; + +part 'nodes.g.dart'; + +const _ast = Object(); + +extension RawTypeX on DartType { + /// Returns whether this type is a `Raw` typedef from `package:riverpod_annotation`. + bool get isRaw { + final alias = this.alias; + if (alias == null) return false; + return alias.element.name == 'Raw' && + isFromRiverpodAnnotation.isExactly(alias.element); + } +} + +class _Cache { + final _cacheExpando = Expando<(Object?,)>(); + + R call(Object e, R Function() create) { + final existing = _cacheExpando[e]; + if (existing != null) return existing.$1 as R; + + final created = create(); + _cacheExpando[e] = (created,); + return created; + } +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes.g.dart b/packages/riverpod_analyzer_utils/lib/src/nodes.g.dart new file mode 100644 index 000000000..68564be3b --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes.g.dart @@ -0,0 +1,1064 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'nodes.dart'; + +// ************************************************************************** +// _LintVisitorGenerator +// ************************************************************************** + +mixin RiverpodAstVisitor { + void visitWidgetDeclaration(WidgetDeclaration node) {} + void visitStateDeclaration(StateDeclaration node) {} + void visitAccumulatedDependencyList(AccumulatedDependencyList node) {} + void visitIdentifierDependencies(IdentifierDependencies node) {} + void visitNamedTypeDependencies(NamedTypeDependencies node) {} + void visitDependenciesAnnotation(DependenciesAnnotation node) {} + void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) {} + void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) {} + void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) {} + void visitGeneratorProviderDeclaration(GeneratorProviderDeclaration node) {} + void visitProviderIdentifier(ProviderIdentifier node) {} + void visitRiverpodAnnotation(RiverpodAnnotation node) {} + void visitProviderListenableExpression(ProviderListenableExpression node) {} + void visitRefInvocation(RefInvocation node) {} + void visitWidgetRefInvocation(WidgetRefInvocation node) {} + void visitProviderOverrideExpression(ProviderOverrideExpression node) {} + void visitProviderOverrideList(ProviderOverrideList node) {} + void visitProviderContainerInstanceCreationExpression( + ProviderContainerInstanceCreationExpression node) {} + void visitProviderScopeInstanceCreationExpression( + ProviderScopeInstanceCreationExpression node) {} +} + +abstract class RecursiveRiverpodAstVisitor extends GeneralizingAstVisitor + with RiverpodAstVisitor { + @override + void visitClassDeclaration(ClassDeclaration node) { + if (node.widget case final value?) { + visitWidgetDeclaration(value); + return; + } + + if (node.state case final value?) { + visitStateDeclaration(value); + return; + } + + if (node.provider case final value?) { + visitClassBasedProviderDeclaration(value); + return; + } + + super.visitClassDeclaration(node); + } + + @override + void visitNode(AstNode node) { + if (node.accumulatedDependencies case final value?) { + visitAccumulatedDependencyList(value); + return; + } + + super.visitNode(node); + } + + @override + void visitIdentifier(Identifier node) { + if (node.identifierDependencies case final value?) { + visitIdentifierDependencies(value); + return; + } + + super.visitIdentifier(node); + } + + @override + void visitNamedType(NamedType node) { + if (node.typeAnnotationDependencies case final value?) { + visitNamedTypeDependencies(value); + return; + } + + super.visitNamedType(node); + } + + @override + void visitAnnotation(Annotation node) { + if (node.dependencies case final value?) { + visitDependenciesAnnotation(value); + return; + } + + if (node.riverpod case final value?) { + visitRiverpodAnnotation(value); + return; + } + + super.visitAnnotation(node); + } + + @override + void visitFunctionDeclaration(FunctionDeclaration node) { + if (node.provider case final value?) { + visitFunctionalProviderDeclaration(value); + return; + } + + super.visitFunctionDeclaration(node); + } + + @override + void visitVariableDeclaration(VariableDeclaration node) { + if (node.provider case final value?) { + visitLegacyProviderDeclaration(value); + return; + } + + super.visitVariableDeclaration(node); + } + + @override + void visitDeclaration(Declaration node) { + if (node.provider case final value?) { + visitGeneratorProviderDeclaration(value); + return; + } + + super.visitDeclaration(node); + } + + @override + void visitSimpleIdentifier(SimpleIdentifier node) { + if (node.provider case final value?) { + visitProviderIdentifier(value); + return; + } + + super.visitSimpleIdentifier(node); + } + + @override + void visitExpression(Expression node) { + if (node.providerListenable case final value?) { + visitProviderListenableExpression(value); + return; + } + + if (node.overrides case final value?) { + visitProviderOverrideList(value); + return; + } + + super.visitExpression(node); + } + + @override + void visitMethodInvocation(MethodInvocation node) { + if (node.refInvocation case final value?) { + visitRefInvocation(value); + return; + } + + if (node.widgetRefInvocation case final value?) { + visitWidgetRefInvocation(value); + return; + } + + super.visitMethodInvocation(node); + } + + @override + void visitCollectionElement(CollectionElement node) { + if (node.providerOverride case final value?) { + visitProviderOverrideExpression(value); + return; + } + + super.visitCollectionElement(node); + } + + @override + void visitInstanceCreationExpression(InstanceCreationExpression node) { + if (node.providerContainer case final value?) { + visitProviderContainerInstanceCreationExpression(value); + return; + } + + if (node.providerScope case final value?) { + visitProviderScopeInstanceCreationExpression(value); + return; + } + + super.visitInstanceCreationExpression(node); + } + + void visitWidgetDeclaration(WidgetDeclaration node) { + super.visitClassDeclaration(node.node); + } + + void visitStateDeclaration(StateDeclaration node) { + super.visitClassDeclaration(node.node); + } + + void visitAccumulatedDependencyList(AccumulatedDependencyList node) { + super.visitNode(node.node); + } + + void visitIdentifierDependencies(IdentifierDependencies node) { + super.visitIdentifier(node.node); + } + + void visitNamedTypeDependencies(NamedTypeDependencies node) { + super.visitNamedType(node.node); + } + + void visitDependenciesAnnotation(DependenciesAnnotation node) { + super.visitAnnotation(node.node); + } + + void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) { + super.visitFunctionDeclaration(node.node); + } + + void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) { + super.visitVariableDeclaration(node.node); + } + + void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) { + super.visitClassDeclaration(node.node); + } + + void visitGeneratorProviderDeclaration(GeneratorProviderDeclaration node) { + super.visitDeclaration(node.node); + } + + void visitProviderIdentifier(ProviderIdentifier node) { + super.visitSimpleIdentifier(node.node); + } + + void visitRiverpodAnnotation(RiverpodAnnotation node) { + super.visitAnnotation(node.node); + } + + void visitProviderListenableExpression(ProviderListenableExpression node) { + super.visitExpression(node.node); + } + + void visitRefInvocation(RefInvocation node) { + super.visitMethodInvocation(node.node); + } + + void visitWidgetRefInvocation(WidgetRefInvocation node) { + super.visitMethodInvocation(node.node); + } + + void visitProviderOverrideExpression(ProviderOverrideExpression node) { + super.visitCollectionElement(node.node); + } + + void visitProviderOverrideList(ProviderOverrideList node) { + super.visitExpression(node.node); + } + + void visitProviderContainerInstanceCreationExpression( + ProviderContainerInstanceCreationExpression node) { + super.visitInstanceCreationExpression(node.node); + } + + void visitProviderScopeInstanceCreationExpression( + ProviderScopeInstanceCreationExpression node) { + super.visitInstanceCreationExpression(node.node); + } +} + +abstract class SimpleRiverpodAstVisitor extends RecursiveRiverpodAstVisitor { + @override + void visitNode(AstNode node) {} +} + +abstract class UnimplementedRiverpodAstVisitor + extends SimpleRiverpodAstVisitor { + void visitWidgetDeclaration(WidgetDeclaration node) => + throw UnimplementedError(); + void visitStateDeclaration(StateDeclaration node) => + throw UnimplementedError(); + void visitAccumulatedDependencyList(AccumulatedDependencyList node) => + throw UnimplementedError(); + void visitIdentifierDependencies(IdentifierDependencies node) => + throw UnimplementedError(); + void visitNamedTypeDependencies(NamedTypeDependencies node) => + throw UnimplementedError(); + void visitDependenciesAnnotation(DependenciesAnnotation node) => + throw UnimplementedError(); + void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) => + throw UnimplementedError(); + void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) => + throw UnimplementedError(); + void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) => + throw UnimplementedError(); + void visitGeneratorProviderDeclaration(GeneratorProviderDeclaration node) => + throw UnimplementedError(); + void visitProviderIdentifier(ProviderIdentifier node) => + throw UnimplementedError(); + void visitRiverpodAnnotation(RiverpodAnnotation node) => + throw UnimplementedError(); + void visitProviderListenableExpression(ProviderListenableExpression node) => + throw UnimplementedError(); + void visitRefInvocation(RefInvocation node) => throw UnimplementedError(); + void visitWidgetRefInvocation(WidgetRefInvocation node) => + throw UnimplementedError(); + void visitProviderOverrideExpression(ProviderOverrideExpression node) => + throw UnimplementedError(); + void visitProviderOverrideList(ProviderOverrideList node) => + throw UnimplementedError(); + void visitProviderContainerInstanceCreationExpression( + ProviderContainerInstanceCreationExpression node) => + throw UnimplementedError(); + void visitProviderScopeInstanceCreationExpression( + ProviderScopeInstanceCreationExpression node) => + throw UnimplementedError(); +} + +@internal +class CollectionRiverpodAst extends SimpleRiverpodAstVisitor { + final Map> riverpodAst = {}; + List? _pendingList; + + @override + void visitClassDeclaration( + ClassDeclaration node, + ) { + final list = riverpodAst.putIfAbsent('ClassDeclaration', () => []); + final previousList = list; + _pendingList = list; + super.visitClassDeclaration(node); + _pendingList = previousList; + } + + @override + void visitNode( + AstNode node, + ) { + final list = riverpodAst.putIfAbsent('AstNode', () => []); + final previousList = list; + _pendingList = list; + super.visitNode(node); + _pendingList = previousList; + } + + @override + void visitIdentifier( + Identifier node, + ) { + final list = riverpodAst.putIfAbsent('Identifier', () => []); + final previousList = list; + _pendingList = list; + super.visitIdentifier(node); + _pendingList = previousList; + } + + @override + void visitNamedType( + NamedType node, + ) { + final list = riverpodAst.putIfAbsent('NamedType', () => []); + final previousList = list; + _pendingList = list; + super.visitNamedType(node); + _pendingList = previousList; + } + + @override + void visitAnnotation( + Annotation node, + ) { + final list = riverpodAst.putIfAbsent('Annotation', () => []); + final previousList = list; + _pendingList = list; + super.visitAnnotation(node); + _pendingList = previousList; + } + + @override + void visitFunctionDeclaration( + FunctionDeclaration node, + ) { + final list = riverpodAst.putIfAbsent('FunctionDeclaration', () => []); + final previousList = list; + _pendingList = list; + super.visitFunctionDeclaration(node); + _pendingList = previousList; + } + + @override + void visitVariableDeclaration( + VariableDeclaration node, + ) { + final list = riverpodAst.putIfAbsent('VariableDeclaration', () => []); + final previousList = list; + _pendingList = list; + super.visitVariableDeclaration(node); + _pendingList = previousList; + } + + @override + void visitDeclaration( + Declaration node, + ) { + final list = riverpodAst.putIfAbsent('Declaration', () => []); + final previousList = list; + _pendingList = list; + super.visitDeclaration(node); + _pendingList = previousList; + } + + @override + void visitSimpleIdentifier( + SimpleIdentifier node, + ) { + final list = riverpodAst.putIfAbsent('SimpleIdentifier', () => []); + final previousList = list; + _pendingList = list; + super.visitSimpleIdentifier(node); + _pendingList = previousList; + } + + @override + void visitExpression( + Expression node, + ) { + final list = riverpodAst.putIfAbsent('Expression', () => []); + final previousList = list; + _pendingList = list; + super.visitExpression(node); + _pendingList = previousList; + } + + @override + void visitMethodInvocation( + MethodInvocation node, + ) { + final list = riverpodAst.putIfAbsent('MethodInvocation', () => []); + final previousList = list; + _pendingList = list; + super.visitMethodInvocation(node); + _pendingList = previousList; + } + + @override + void visitCollectionElement( + CollectionElement node, + ) { + final list = riverpodAst.putIfAbsent('CollectionElement', () => []); + final previousList = list; + _pendingList = list; + super.visitCollectionElement(node); + _pendingList = previousList; + } + + @override + void visitInstanceCreationExpression( + InstanceCreationExpression node, + ) { + final list = + riverpodAst.putIfAbsent('InstanceCreationExpression', () => []); + final previousList = list; + _pendingList = list; + super.visitInstanceCreationExpression(node); + _pendingList = previousList; + } + + void visitWidgetDeclaration(WidgetDeclaration node) { + _pendingList!.add(node); + } + + void visitStateDeclaration(StateDeclaration node) { + _pendingList!.add(node); + } + + void visitAccumulatedDependencyList(AccumulatedDependencyList node) { + _pendingList!.add(node); + } + + void visitIdentifierDependencies(IdentifierDependencies node) { + _pendingList!.add(node); + } + + void visitNamedTypeDependencies(NamedTypeDependencies node) { + _pendingList!.add(node); + } + + void visitDependenciesAnnotation(DependenciesAnnotation node) { + _pendingList!.add(node); + } + + void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) { + _pendingList!.add(node); + } + + void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) { + _pendingList!.add(node); + } + + void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) { + _pendingList!.add(node); + } + + void visitGeneratorProviderDeclaration(GeneratorProviderDeclaration node) { + _pendingList!.add(node); + } + + void visitProviderIdentifier(ProviderIdentifier node) { + _pendingList!.add(node); + } + + void visitRiverpodAnnotation(RiverpodAnnotation node) { + _pendingList!.add(node); + } + + void visitProviderListenableExpression(ProviderListenableExpression node) { + _pendingList!.add(node); + } + + void visitRefInvocation(RefInvocation node) { + _pendingList!.add(node); + } + + void visitWidgetRefInvocation(WidgetRefInvocation node) { + _pendingList!.add(node); + } + + void visitProviderOverrideExpression(ProviderOverrideExpression node) { + _pendingList!.add(node); + } + + void visitProviderOverrideList(ProviderOverrideList node) { + _pendingList!.add(node); + } + + void visitProviderContainerInstanceCreationExpression( + ProviderContainerInstanceCreationExpression node) { + _pendingList!.add(node); + } + + void visitProviderScopeInstanceCreationExpression( + ProviderScopeInstanceCreationExpression node) { + _pendingList!.add(node); + } +} + +@internal +class RiverpodAnalysisResult extends RecursiveRiverpodAstVisitor { + final List errors = []; + + final widgetDeclarations = []; + @override + void visitWidgetDeclaration( + WidgetDeclaration node, + ) { + super.visitWidgetDeclaration(node); + widgetDeclarations.add(node); + } + + final stateDeclarations = []; + @override + void visitStateDeclaration( + StateDeclaration node, + ) { + super.visitStateDeclaration(node); + stateDeclarations.add(node); + } + + final accumulatedDependencyLists = []; + @override + void visitAccumulatedDependencyList( + AccumulatedDependencyList node, + ) { + super.visitAccumulatedDependencyList(node); + accumulatedDependencyLists.add(node); + } + + final identifierDependenciesList = []; + @override + void visitIdentifierDependencies( + IdentifierDependencies node, + ) { + super.visitIdentifierDependencies(node); + identifierDependenciesList.add(node); + } + + final namedTypeDependenciesList = []; + @override + void visitNamedTypeDependencies( + NamedTypeDependencies node, + ) { + super.visitNamedTypeDependencies(node); + namedTypeDependenciesList.add(node); + } + + final dependenciesAnnotations = []; + @override + void visitDependenciesAnnotation( + DependenciesAnnotation node, + ) { + super.visitDependenciesAnnotation(node); + dependenciesAnnotations.add(node); + } + + final functionalProviderDeclarations = []; + @override + void visitFunctionalProviderDeclaration( + FunctionalProviderDeclaration node, + ) { + super.visitFunctionalProviderDeclaration(node); + functionalProviderDeclarations.add(node); + } + + final legacyProviderDeclarations = []; + @override + void visitLegacyProviderDeclaration( + LegacyProviderDeclaration node, + ) { + super.visitLegacyProviderDeclaration(node); + legacyProviderDeclarations.add(node); + } + + final classBasedProviderDeclarations = []; + @override + void visitClassBasedProviderDeclaration( + ClassBasedProviderDeclaration node, + ) { + super.visitClassBasedProviderDeclaration(node); + classBasedProviderDeclarations.add(node); + } + + final generatorProviderDeclarations = []; + @override + void visitGeneratorProviderDeclaration( + GeneratorProviderDeclaration node, + ) { + super.visitGeneratorProviderDeclaration(node); + generatorProviderDeclarations.add(node); + } + + final providerIdentifiers = []; + @override + void visitProviderIdentifier( + ProviderIdentifier node, + ) { + super.visitProviderIdentifier(node); + providerIdentifiers.add(node); + } + + final riverpodAnnotations = []; + @override + void visitRiverpodAnnotation( + RiverpodAnnotation node, + ) { + super.visitRiverpodAnnotation(node); + riverpodAnnotations.add(node); + } + + final providerListenableExpressions = []; + @override + void visitProviderListenableExpression( + ProviderListenableExpression node, + ) { + super.visitProviderListenableExpression(node); + providerListenableExpressions.add(node); + } + + final refInvocations = []; + @override + void visitRefInvocation( + RefInvocation node, + ) { + super.visitRefInvocation(node); + refInvocations.add(node); + } + + final widgetRefInvocations = []; + @override + void visitWidgetRefInvocation( + WidgetRefInvocation node, + ) { + super.visitWidgetRefInvocation(node); + widgetRefInvocations.add(node); + } + + final providerOverrideExpressions = []; + @override + void visitProviderOverrideExpression( + ProviderOverrideExpression node, + ) { + super.visitProviderOverrideExpression(node); + providerOverrideExpressions.add(node); + } + + final providerOverrideLists = []; + @override + void visitProviderOverrideList( + ProviderOverrideList node, + ) { + super.visitProviderOverrideList(node); + providerOverrideLists.add(node); + } + + final providerContainerInstanceCreationExpressions = + []; + @override + void visitProviderContainerInstanceCreationExpression( + ProviderContainerInstanceCreationExpression node, + ) { + super.visitProviderContainerInstanceCreationExpression(node); + providerContainerInstanceCreationExpressions.add(node); + } + + final providerScopeInstanceCreationExpressions = + []; + @override + void visitProviderScopeInstanceCreationExpression( + ProviderScopeInstanceCreationExpression node, + ) { + super.visitProviderScopeInstanceCreationExpression(node); + providerScopeInstanceCreationExpressions.add(node); + } +} + +class RiverpodAstRegistry { + void run(AstNode node) { + final previousErrorReporter = errorReporter; + try { + final errors = node.upsert( + 'RiverpodAstRegistry.errors', + () => [], + ); + + final visitor = _RiverpodAstRegistryVisitor(this); + errorReporter = errors.add; + + node.accept(visitor); + for (final error in errors) { + visitor._runSubscriptions(error, _onRiverpodAnalysisError); + } + } finally { + errorReporter = previousErrorReporter; + } + } + + final _onRiverpodAnalysisError = []; + void addRiverpodAnalysisError( + void Function(RiverpodAnalysisError node) cb, + ) { + _onRiverpodAnalysisError.add(cb); + } + + final _onWidgetDeclaration = []; + void addWidgetDeclaration(void Function(WidgetDeclaration node) cb) { + _onWidgetDeclaration.add(cb); + } + + final _onStateDeclaration = []; + void addStateDeclaration(void Function(StateDeclaration node) cb) { + _onStateDeclaration.add(cb); + } + + final _onAccumulatedDependencyList = + []; + void addAccumulatedDependencyList( + void Function(AccumulatedDependencyList node) cb) { + _onAccumulatedDependencyList.add(cb); + } + + final _onIdentifierDependencies = []; + void addIdentifierDependencies( + void Function(IdentifierDependencies node) cb) { + _onIdentifierDependencies.add(cb); + } + + final _onNamedTypeDependencies = []; + void addNamedTypeDependencies(void Function(NamedTypeDependencies node) cb) { + _onNamedTypeDependencies.add(cb); + } + + final _onDependenciesAnnotation = []; + void addDependenciesAnnotation( + void Function(DependenciesAnnotation node) cb) { + _onDependenciesAnnotation.add(cb); + } + + final _onFunctionalProviderDeclaration = + []; + void addFunctionalProviderDeclaration( + void Function(FunctionalProviderDeclaration node) cb) { + _onFunctionalProviderDeclaration.add(cb); + } + + final _onLegacyProviderDeclaration = + []; + void addLegacyProviderDeclaration( + void Function(LegacyProviderDeclaration node) cb) { + _onLegacyProviderDeclaration.add(cb); + } + + final _onClassBasedProviderDeclaration = + []; + void addClassBasedProviderDeclaration( + void Function(ClassBasedProviderDeclaration node) cb) { + _onClassBasedProviderDeclaration.add(cb); + } + + final _onGeneratorProviderDeclaration = + []; + void addGeneratorProviderDeclaration( + void Function(GeneratorProviderDeclaration node) cb) { + _onGeneratorProviderDeclaration.add(cb); + } + + final _onProviderIdentifier = []; + void addProviderIdentifier(void Function(ProviderIdentifier node) cb) { + _onProviderIdentifier.add(cb); + } + + final _onRiverpodAnnotation = []; + void addRiverpodAnnotation(void Function(RiverpodAnnotation node) cb) { + _onRiverpodAnnotation.add(cb); + } + + final _onProviderListenableExpression = + []; + void addProviderListenableExpression( + void Function(ProviderListenableExpression node) cb) { + _onProviderListenableExpression.add(cb); + } + + final _onRefInvocation = []; + void addRefInvocation(void Function(RefInvocation node) cb) { + _onRefInvocation.add(cb); + } + + final _onWidgetRefInvocation = []; + void addWidgetRefInvocation(void Function(WidgetRefInvocation node) cb) { + _onWidgetRefInvocation.add(cb); + } + + final _onProviderOverrideExpression = + []; + void addProviderOverrideExpression( + void Function(ProviderOverrideExpression node) cb) { + _onProviderOverrideExpression.add(cb); + } + + final _onProviderOverrideList = []; + void addProviderOverrideList(void Function(ProviderOverrideList node) cb) { + _onProviderOverrideList.add(cb); + } + + final _onProviderContainerInstanceCreationExpression = + []; + void addProviderContainerInstanceCreationExpression( + void Function(ProviderContainerInstanceCreationExpression node) cb) { + _onProviderContainerInstanceCreationExpression.add(cb); + } + + final _onProviderScopeInstanceCreationExpression = + []; + void addProviderScopeInstanceCreationExpression( + void Function(ProviderScopeInstanceCreationExpression node) cb) { + _onProviderScopeInstanceCreationExpression.add(cb); + } +} + +class _RiverpodAstRegistryVisitor extends RecursiveRiverpodAstVisitor { + _RiverpodAstRegistryVisitor(this._registry); + + final RiverpodAstRegistry _registry; + + void _runSubscriptions( + R value, + List subscriptions, + ) { + for (final sub in subscriptions) { + try { + sub(value); + } catch (e, stack) { + Zone.current.handleUncaughtError(e, stack); + } + } + } + + @override + void visitWidgetDeclaration(WidgetDeclaration node) { + super.visitWidgetDeclaration(node); + _runSubscriptions( + node, + _registry._onWidgetDeclaration, + ); + } + + @override + void visitStateDeclaration(StateDeclaration node) { + super.visitStateDeclaration(node); + _runSubscriptions( + node, + _registry._onStateDeclaration, + ); + } + + @override + void visitAccumulatedDependencyList(AccumulatedDependencyList node) { + super.visitAccumulatedDependencyList(node); + _runSubscriptions( + node, + _registry._onAccumulatedDependencyList, + ); + } + + @override + void visitIdentifierDependencies(IdentifierDependencies node) { + super.visitIdentifierDependencies(node); + _runSubscriptions( + node, + _registry._onIdentifierDependencies, + ); + } + + @override + void visitNamedTypeDependencies(NamedTypeDependencies node) { + super.visitNamedTypeDependencies(node); + _runSubscriptions( + node, + _registry._onNamedTypeDependencies, + ); + } + + @override + void visitDependenciesAnnotation(DependenciesAnnotation node) { + super.visitDependenciesAnnotation(node); + _runSubscriptions( + node, + _registry._onDependenciesAnnotation, + ); + } + + @override + void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) { + super.visitFunctionalProviderDeclaration(node); + _runSubscriptions( + node, + _registry._onFunctionalProviderDeclaration, + ); + } + + @override + void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) { + super.visitLegacyProviderDeclaration(node); + _runSubscriptions( + node, + _registry._onLegacyProviderDeclaration, + ); + } + + @override + void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) { + super.visitClassBasedProviderDeclaration(node); + _runSubscriptions( + node, + _registry._onClassBasedProviderDeclaration, + ); + } + + @override + void visitGeneratorProviderDeclaration(GeneratorProviderDeclaration node) { + super.visitGeneratorProviderDeclaration(node); + _runSubscriptions( + node, + _registry._onGeneratorProviderDeclaration, + ); + } + + @override + void visitProviderIdentifier(ProviderIdentifier node) { + super.visitProviderIdentifier(node); + _runSubscriptions( + node, + _registry._onProviderIdentifier, + ); + } + + @override + void visitRiverpodAnnotation(RiverpodAnnotation node) { + super.visitRiverpodAnnotation(node); + _runSubscriptions( + node, + _registry._onRiverpodAnnotation, + ); + } + + @override + void visitProviderListenableExpression(ProviderListenableExpression node) { + super.visitProviderListenableExpression(node); + _runSubscriptions( + node, + _registry._onProviderListenableExpression, + ); + } + + @override + void visitRefInvocation(RefInvocation node) { + super.visitRefInvocation(node); + _runSubscriptions( + node, + _registry._onRefInvocation, + ); + } + + @override + void visitWidgetRefInvocation(WidgetRefInvocation node) { + super.visitWidgetRefInvocation(node); + _runSubscriptions( + node, + _registry._onWidgetRefInvocation, + ); + } + + @override + void visitProviderOverrideExpression(ProviderOverrideExpression node) { + super.visitProviderOverrideExpression(node); + _runSubscriptions( + node, + _registry._onProviderOverrideExpression, + ); + } + + @override + void visitProviderOverrideList(ProviderOverrideList node) { + super.visitProviderOverrideList(node); + _runSubscriptions( + node, + _registry._onProviderOverrideList, + ); + } + + @override + void visitProviderContainerInstanceCreationExpression( + ProviderContainerInstanceCreationExpression node) { + super.visitProviderContainerInstanceCreationExpression(node); + _runSubscriptions( + node, + _registry._onProviderContainerInstanceCreationExpression, + ); + } + + @override + void visitProviderScopeInstanceCreationExpression( + ProviderScopeInstanceCreationExpression node) { + super.visitProviderScopeInstanceCreationExpression(node); + _runSubscriptions( + node, + _registry._onProviderScopeInstanceCreationExpression, + ); + } +} + +// ignore_for_file: type=lint diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart new file mode 100644 index 000000000..7f4fb5595 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart @@ -0,0 +1,469 @@ +part of '../nodes.dart'; + +extension on CollectionElement { + ProviderDependency? get providerDependency { + return upsert('ProviderDependency', () { + final that = this; + if (that is! Expression) { + errorReporter( + RiverpodAnalysisError( + 'if/for/spread operators as not supported.', + targetNode: that, + code: RiverpodAnalysisErrorCode.providerDependencyListParseError, + ), + ); + return null; + } + + if (that is! SimpleIdentifier) { + errorReporter( + RiverpodAnalysisError( + 'Only elements annotated with @riverpod are supported.', + targetNode: that, + code: RiverpodAnalysisErrorCode.providerDependencyListParseError, + ), + ); + return null; + } + + final dependencyElement = that.staticElement; + if (dependencyElement is FunctionElement) { + final dependencyProvider = FunctionalProviderDeclarationElement._parse( + dependencyElement, + ); + + if (dependencyProvider != null) { + return ProviderDependency._(provider: dependencyProvider, node: that); + } + + errorReporter( + RiverpodAnalysisError( + 'The dependency $that is not a function annotated with @riverpod', + targetNode: that, + code: RiverpodAnalysisErrorCode.providerDependencyListParseError, + ), + ); + return null; + } + + if (dependencyElement is ClassElement) { + final dependencyProvider = ClassBasedProviderDeclarationElement._parse( + dependencyElement, + ); + + if (dependencyProvider != null) { + return ProviderDependency._(provider: dependencyProvider, node: that); + } + + errorReporter( + RiverpodAnalysisError( + 'The dependency $that is not a class annotated with @riverpod', + targetNode: that, + code: RiverpodAnalysisErrorCode.providerDependencyListParseError, + ), + ); + return null; + } + + errorReporter( + RiverpodAnalysisError( + 'Only elements annotated with @riverpod are supported.', + targetNode: that, + code: RiverpodAnalysisErrorCode.providerDependencyListParseError, + ), + ); + return null; + }); + } +} + +final class ProviderDependency { + ProviderDependency._({ + required this.node, + required this.provider, + }); + + final CollectionElement node; + final GeneratorProviderDeclarationElement provider; +} + +extension on Expression { + ProviderDependencyList? get providerDependencyList { + return upsert('ProviderDependencyList', () { + final that = this; + // explicit null, count as valid value (no dependencies) + if (that is NullLiteral) { + return ProviderDependencyList._(node: null, values: null); + } + + if (that is! ListLiteral) { + errorReporter( + RiverpodAnalysisError( + 'Only list literals (using []) as supported.', + targetNode: that, + code: RiverpodAnalysisErrorCode.providerDependencyListParseError, + ), + ); + return null; + } + + return ProviderDependencyList._( + node: that, + values: that.elements + .map((e) => e.providerDependency) + .whereType() + .toList(), + ); + }); + } +} + +final class ProviderDependencyList { + ProviderDependencyList._({ + required this.node, + required this.values, + }); + + final ListLiteral? node; + final List? values; +} + +extension on DartObject { + /// An element in `@Riverpod(dependencies: [a, b])` or equivalent. + GeneratorProviderDeclarationElement? toDependency({ + required Element? from, + }) { + final functionType = toFunctionValue(); + if (functionType != null) { + final provider = FunctionalProviderDeclarationElement._parse( + functionType, + ); + + if (provider != null) return provider; + } + + final type = toTypeValue(); + if (type != null) { + final provider = ClassBasedProviderDeclarationElement._parse( + type.element! as ClassElement, + ); + + if (provider != null) return provider; + } + + errorReporter( + RiverpodAnalysisError( + 'Unsupported dependency "${functionType ?? type ?? this}". ' + 'Only functions and classes annotated by @riverpod are supported.', + targetElement: from, + code: RiverpodAnalysisErrorCode.providerDependencyListParseError, + ), + ); + return null; + } + + /// The list passed to `@Riverpod(dependencies: [a, b])` or equivalent. + List? toDependencyList({ + required Element? from, + }) { + final list = toListValue(); + if (list == null) { + return null; + } + + final values = + list.map((e) => e.toDependency(from: from)).whereNotNull().toList(); + + // If any dependency failed to parse, return null. + // Errors should already have been reported + if (values.length != list.length) return null; + + return values; + } +} + +sealed class Location {} + +class LocationNode implements Location { + LocationNode(this.node); + final AstNode node; +} + +class LocationElement implements Location { + LocationElement(this.element); + final Element element; +} + +final class AccumulatedDependency { + AccumulatedDependency._({required this.location, required this.provider}); + + final Location location; + final GeneratorProviderDeclarationElement provider; +} + +sealed class AccumulatedDependencyNode {} + +final class AccumulatedDependencyList { + AccumulatedDependencyList._({ + required this.node, + required this.riverpod, + required this.dependencies, + required this.dependenciesElement, + required this.overrides, + }) : parent = node.ancestors + .map((e) => e.accumulatedDependencies) + .whereNotNull() + .firstOrNull; + + final AstNode node; + final AccumulatedDependencyList? parent; + final GeneratorProviderDeclaration? riverpod; + final DependenciesAnnotation? dependencies; + final DependenciesAnnotationElement? dependenciesElement; + final ProviderScopeInstanceCreationExpression? overrides; + + Iterable? get allDependencies { + final dependencies = this.dependencies?.dependencies; + final riverpod = this.riverpod?.annotation.dependencyList; + final dependenciesElement = this.dependenciesElement?.dependencies; + + if (dependencies == null && + riverpod == null && + dependenciesElement == null) { + return null; + } + + final dependenciesValues = dependencies?.values?.map( + (e) => AccumulatedDependency._( + location: LocationNode(e.node), + provider: e.provider, + ), + ); + final riverpodValues = riverpod?.values?.map( + (e) => AccumulatedDependency._( + location: LocationNode(e.node), + provider: e.provider, + ), + ); + final dependenciesElementValues = dependenciesElement?.map( + (provider) => AccumulatedDependency._( + location: LocationElement(this.dependenciesElement!.element.element!), + provider: provider, + ), + ); + + return (dependenciesValues ?? const []) + .followedBy(riverpodValues ?? const []) + .followedBy(dependenciesElementValues ?? const []); + } + + Iterable get overridesIncludingParents sync* { + if (overrides?.overrides?.overrides case final overrides?) { + yield* overrides; + } + + if (parent case final parent?) yield* parent.overridesIncludingParents; + } +} + +@_ast +extension AccumulatedDependenciesX on AstNode { + AccumulatedDependencyList? get accumulatedDependencies { + final that = this; + switch (that) { + case InstanceCreationExpression(): + return that.accumulatedDependencies; + case AnnotatedNode(): + return that.accumulatedDependencies; + default: + return null; + } + } +} + +extension on InstanceCreationExpression { + AccumulatedDependencyList? get accumulatedDependencies { + return upsert('InstanceCreationExpression#accumulatedDependencies', () { + final providerScope = this.providerScope; + if (providerScope == null) return null; + + return AccumulatedDependencyList._( + node: this, + overrides: providerScope, + dependencies: null, + riverpod: null, + dependenciesElement: null, + ); + }); + } +} + +extension on AnnotatedNode { + AccumulatedDependencyList? get accumulatedDependencies { + return upsert('#AnnotatedNodeAccumulatedDependencies', () { + final provider = cast()?.provider; + // Have State inherit dependencies from its widget + final state = cast()?.state; + + if (provider == null && + dependencies == null && + state == null && + // Always initialize root declarations, + // to handle cases where a method in a class has @Dependencies + // but the class itself does not. + this is! CompilationUnitMember) return null; + + return AccumulatedDependencyList._( + node: this, + overrides: null, + dependencies: dependencies, + riverpod: provider, + dependenciesElement: state?.widget?.dependencies, + ); + }); + } +} + +class IdentifierDependencies { + IdentifierDependencies._({required this.node, required this.dependencies}); + + final Identifier node; + final DependenciesAnnotationElement dependencies; +} + +@_ast +extension IdentifierDependenciesX on Identifier { + IdentifierDependencies? get identifierDependencies { + return upsert('Identifier#identifierDependencies', () { + final staticElement = this.staticElement; + if (staticElement == null) return null; + + final dependencies = DependenciesAnnotationElement._of(staticElement); + if (dependencies == null) return null; + + return IdentifierDependencies._(node: this, dependencies: dependencies); + }); + } +} + +class NamedTypeDependencies { + NamedTypeDependencies._({ + required this.node, + required this.dependencies, + }); + + final NamedType node; + final DependenciesAnnotationElement dependencies; +} + +@_ast +extension NamedTypeDependenciesX on NamedType { + NamedTypeDependencies? get typeAnnotationDependencies { + return upsert('NamedType#typeAnnotationDependencies', () { + final staticElement = type?.element; + if (staticElement == null) return null; + + final dependencies = DependenciesAnnotationElement._of(staticElement); + if (dependencies == null) return null; + + return NamedTypeDependencies._( + node: this, + dependencies: dependencies, + ); + }); + } +} + +extension DependenciesAnnotatedAnnotatedNodeOfX on AnnotatedNode { + DependenciesAnnotation? get dependencies { + return upsert('DependenciesAnnotationAnnotatedNodeX', () { + return metadata.map((e) => e.dependencies).whereNotNull().firstOrNull; + }); + } +} + +@_ast +extension DependenciesAnnotatedAnnotatedNodeX on Annotation { + DependenciesAnnotation? get dependencies { + return upsert('DependenciesAnnotation', () { + final elementAnnotation = this.elementAnnotation; + final element = this.element; + if (element == null || elementAnnotation == null) return null; + if (element is! ExecutableElement || + !dependenciesType.isExactlyType(element.returnType)) { + // The annotation is not an @Dependencies + return null; + } + + final dependenciesElement = DependenciesAnnotationElement._parse( + elementAnnotation, + ); + if (dependenciesElement == null) return null; + + final dependenciesNode = arguments?.positional(0); + // Required argument missing. There should be a compilation error already. + if (dependenciesNode == null) return null; + + final dependencyList = dependenciesNode.providerDependencyList; + // No valid dependencies arg found. There should already be an error reported. + if (dependencyList == null) return null; + + return DependenciesAnnotation._( + node: this, + dependencies: dependencyList, + dependenciesNode: dependenciesNode, + element: dependenciesElement, + ); + }); + } +} + +final class DependenciesAnnotation { + DependenciesAnnotation._({ + required this.dependencies, + required this.node, + required this.dependenciesNode, + required this.element, + }); + + final Annotation node; + final ProviderDependencyList dependencies; + final Expression dependenciesNode; + final DependenciesAnnotationElement element; +} + +final class DependenciesAnnotationElement { + DependenciesAnnotationElement._({ + required this.dependencies, + required this.element, + }); + + static final _cache = _Cache(); + + static DependenciesAnnotationElement? _parse(ElementAnnotation element) { + return _cache(element, () { + final type = element.element.cast()?.returnType; + if (type == null || !dependenciesType.isExactlyType(type)) return null; + + final dependencies = + element.computeConstantValue()?.getField('dependencies'); + if (dependencies == null) return null; + + final dependencyList = dependencies.toDependencyList( + from: element.element, + ); + + return DependenciesAnnotationElement._( + element: element, + dependencies: dependencyList, + ); + }); + } + + static DependenciesAnnotationElement? _of(Element element) { + return element.metadata.map(_parse).whereNotNull().firstOrNull; + } + + final ElementAnnotation element; + final List? dependencies; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/provider_for.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/provider_for.dart new file mode 100644 index 000000000..5749d880b --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/provider_for.dart @@ -0,0 +1,23 @@ +part of '../nodes.dart'; + +@internal +(ProviderDeclarationElement?,)? parseProviderFor( + ElementAnnotation annotation, { + required Element? from, +}) { + final type = annotation.element.cast()?.returnType; + if (type == null || !providerForType.isExactlyType(type)) return null; + + final value = annotation.computeConstantValue()?.getField('value'); + if (value == null) return (null,); + + return (value.toDependency(from: from),); +} + +@internal +(ProviderDeclarationElement?,)? parseFirstProviderFor(Element annotation) { + return annotation.metadata + .map((e) => parseProviderFor(e, from: annotation)) + .whereNotNull() + .firstOrNull; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/provider_listenable.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/provider_listenable.dart new file mode 100644 index 000000000..f33d8349b --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/provider_listenable.dart @@ -0,0 +1,44 @@ +part of '../nodes.dart'; + +@_ast +extension ProviderListenableExpressionX on Expression { + ProviderListenableExpression? get providerListenable { + return upsert('ProviderListenableExpression', () { + final returnType = staticType; + if (returnType == null) return null; + if (!providerListenableType.isAssignableFromType(returnType)) return null; + + final parseResult = _parsesProviderExpression(this); + if (parseResult == null) return null; + final ( + :provider, + :providerPrefix, + :familyArguments, + ) = parseResult; + + return ProviderListenableExpression._( + node: this, + provider: provider, + providerPrefix: providerPrefix, + familyArguments: familyArguments, + ); + }); + } +} + +final class ProviderListenableExpression { + ProviderListenableExpression._({ + required this.node, + required this.provider, + required this.providerPrefix, + required this.familyArguments, + }); + + final Expression node; + final SimpleIdentifier? providerPrefix; + final ProviderIdentifier? provider; + + /// If [provider] is a provider with arguments (family), represents the arguments + /// passed to the provider. + final ArgumentList? familyArguments; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/provider_or_family.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/provider_or_family.dart new file mode 100644 index 000000000..fcb0f11b9 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/provider_or_family.dart @@ -0,0 +1,91 @@ +part of '../nodes.dart'; + +({ + ProviderIdentifier? provider, + SimpleIdentifier? providerPrefix, + ArgumentList? familyArguments, +})? _parsesProviderExpression(Expression? expression) { + ProviderIdentifier? provider; + SimpleIdentifier? providerPrefix; + ArgumentList? familyArguments; + + void parseExpression(Expression? expression) { + // Can be reached when the code contains syntax errors + if (expression == null) return; + if (expression is SimpleIdentifier) { + // watch(expression) + provider = expression.provider; + } else if (expression is FunctionExpressionInvocation) { + // watch(expression()) + familyArguments = expression.argumentList; + parseExpression(expression.function); + } else if (expression is MethodInvocation) { + // watch(expression.method()) + parseExpression(expression.target); + } else if (expression is PrefixedIdentifier) { + // watch(expression.modifier) + final element = expression.prefix.staticElement; + if (element is PrefixElement) { + providerPrefix = expression.prefix; + parseExpression(expression.identifier); + } else { + parseExpression(expression.prefix); + } + } else if (expression is IndexExpression) { + // watch(expression[]) + parseExpression(expression.target); + } else if (expression is PropertyAccess) { + // watch(expression.property) + parseExpression(expression.target); + } + } + + parseExpression(expression); + + return ( + provider: provider, + providerPrefix: providerPrefix, + familyArguments: provider != null ? familyArguments : null, + ); +} + +final class ProviderOrFamilyExpression { + ProviderOrFamilyExpression._({ + required this.node, + required this.provider, + required this.providerPrefix, + required this.familyArguments, + }); + + static ProviderOrFamilyExpression? _parse(Expression? expression) { + if (expression == null) return null; + + final returnType = expression.staticType; + if (returnType == null) return null; + if (!providerBaseType.isAssignableFromType(returnType) && + !familyType.isAssignableFromType(returnType)) return null; + + final parseResult = _parsesProviderExpression(expression); + if (parseResult == null) return null; + final ( + :provider, + :providerPrefix, + :familyArguments, + ) = parseResult; + + return ProviderOrFamilyExpression._( + node: expression, + provider: provider, + providerPrefix: providerPrefix, + familyArguments: familyArguments, + ); + } + + final Expression node; + final SimpleIdentifier? providerPrefix; + final ProviderIdentifier? provider; + + /// If [provider] is a provider with arguments (family), represents the arguments + /// passed to the provider. + final ArgumentList? familyArguments; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/function.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/function.dart new file mode 100644 index 000000000..6a8ad92f7 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/function.dart @@ -0,0 +1,108 @@ +part of '../../nodes.dart'; + +@_ast +extension FunctionalProviderDeclarationX on FunctionDeclaration { + FunctionalProviderDeclaration? get provider { + return upsert('FunctionalProviderDeclaration', () { + final element = declaredElement; + if (element == null) return null; + + final riverpod = this.riverpod; + if (riverpod == null) return null; + + final providerElement = FunctionalProviderDeclarationElement._parse( + element, + ); + if (providerElement == null) return null; + + final createdTypeNode = returnType; + final exposedTypeNode = _computeExposedType( + createdTypeNode, + root.cast()!, + ); + if (exposedTypeNode == null) { + // Error already reported + return null; + } + + return FunctionalProviderDeclaration._( + name: name, + node: this, + providerElement: providerElement, + annotation: riverpod, + createdTypeNode: createdTypeNode, + exposedTypeNode: exposedTypeNode, + valueTypeNode: _getValueType(createdTypeNode, element.library), + ); + }); + } +} + +final class FunctionalProviderDeclaration extends GeneratorProviderDeclaration { + FunctionalProviderDeclaration._({ + required this.name, + required this.node, + required this.providerElement, + required this.annotation, + required this.createdTypeNode, + required this.exposedTypeNode, + required this.valueTypeNode, + }); + + @override + final Token name; + + @override + final FunctionDeclaration node; + @override + final FunctionalProviderDeclarationElement providerElement; + @override + final RiverpodAnnotation annotation; + @override + final TypeAnnotation? createdTypeNode; + @override + final TypeAnnotation? valueTypeNode; + @override + final SourcedType exposedTypeNode; +} + +class FunctionalProviderDeclarationElement + extends GeneratorProviderDeclarationElement { + FunctionalProviderDeclarationElement._({ + required this.name, + required this.annotation, + required this.element, + }); + + static final _cache = _Cache(); + + static FunctionalProviderDeclarationElement? _parse( + ExecutableElement element, + ) { + return _cache(element, () { + final riverpodAnnotation = RiverpodAnnotationElement._of(element); + if (riverpodAnnotation == null) return null; + + return FunctionalProviderDeclarationElement._( + name: element.name, + annotation: riverpodAnnotation, + element: element, + ); + }); + } + + @override + bool get isScoped => super.isScoped || element.isExternal; + + @override + bool get isFamily { + return element.parameters.length > 1 || element.typeParameters.isNotEmpty; + } + + @override + final RiverpodAnnotationElement annotation; + @override + final String name; + @override + final ExecutableElement element; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/identifiers.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/identifiers.dart new file mode 100644 index 000000000..d41610d54 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/identifiers.dart @@ -0,0 +1,35 @@ +part of '../../nodes.dart'; + +@_ast +extension ProviderIdentifierX on SimpleIdentifier { + ProviderIdentifier? get provider { + return upsert('ProviderIdentifier', () { + final element = staticElement; + if (element is! PropertyAccessorElement) return null; + + final providerFor = parseFirstProviderFor(element.variable); + + ProviderDeclarationElement? providerElement; + if (providerFor != null) { + providerElement = providerFor.$1; + } else { + providerElement = + LegacyProviderDeclarationElement._parse(element.variable); + } + + if (providerElement == null) return null; + + return ProviderIdentifier._( + node: this, + providerElement: providerElement, + ); + }); + } +} + +final class ProviderIdentifier { + ProviderIdentifier._({required this.node, required this.providerElement}); + + final SimpleIdentifier node; + final ProviderDeclarationElement providerElement; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/legacy.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/legacy.dart new file mode 100644 index 000000000..4e6a76c9e --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/legacy.dart @@ -0,0 +1,297 @@ +part of '../../nodes.dart'; + +final class LegacyProviderDependencies { + LegacyProviderDependencies._({ + required this.dependencies, + required this.node, + }); + + static LegacyProviderDependencies? _parse(NamedExpression? dependenciesNode) { + if (dependenciesNode == null) return null; + + final value = dependenciesNode.expression; + + List? dependencies; + if (value is ListLiteral) { + dependencies = + value.elements.map(LegacyProviderDependency._parse).toList(); + } + + return LegacyProviderDependencies._( + node: dependenciesNode, + dependencies: dependencies, + ); + } + + final List? dependencies; + final NamedExpression node; +} + +final class LegacyProviderDependency { + LegacyProviderDependency._({ + required this.node, + required this.provider, + }); + + factory LegacyProviderDependency._parse(CollectionElement node) { + final provider = + node.cast().let(ProviderOrFamilyExpression._parse); + + return LegacyProviderDependency._( + node: node, + provider: provider, + ); + } + + final CollectionElement node; + final ProviderOrFamilyExpression? provider; +} + +@_ast +extension LegacyProviderDeclarationX on VariableDeclaration { + LegacyProviderDeclaration? get provider { + return upsert('LegacyProviderDeclaration', () { + final element = declaredElement; + if (element == null) return null; + + final providerElement = LegacyProviderDeclarationElement._parse(element); + if (providerElement == null) return null; + + final initializer = this.initializer; + ArgumentList? arguments; + late SyntacticEntity provider; + SimpleIdentifier? autoDisposeModifier; + SimpleIdentifier? familyModifier; + TypeArgumentList? typeArguments; + if (initializer is InstanceCreationExpression) { + // Provider((ref) => ...) + + arguments = initializer.argumentList; + provider = initializer.constructorName.type.name2; + typeArguments = initializer.constructorName.type.typeArguments; + } else if (initializer is FunctionExpressionInvocation) { + // Provider.modifier() + + void decodeIdentifier(SimpleIdentifier identifier) { + switch (identifier.name) { + case 'autoDispose': + autoDisposeModifier = identifier; + case 'family': + familyModifier = identifier; + default: + provider = identifier; + } + } + + void decodeTarget(Expression? expression) { + if (expression is SimpleIdentifier) { + decodeIdentifier(expression); + } else if (expression is PrefixedIdentifier) { + decodeIdentifier(expression.identifier); + decodeIdentifier(expression.prefix); + } else { + throw UnsupportedError( + 'unknown expression "$expression" (${expression.runtimeType})', + ); + } + } + + final modifier = initializer.function; + if (modifier is! PropertyAccess) return null; + + decodeIdentifier(modifier.propertyName); + decodeTarget(modifier.target); + arguments = initializer.argumentList; + typeArguments = initializer.typeArguments; + } else { + // Invalid provider expression. + // Such as "final provider = variable;" + return null; + } + + final build = arguments.positionalArguments().firstOrNull; + if (build is! FunctionExpression) return null; + + final dependenciesElement = arguments + .namedArguments() + .firstWhereOrNull((e) => e.name.label.name == 'dependencies'); + final dependencies = + LegacyProviderDependencies._parse(dependenciesElement); + + return LegacyProviderDeclaration._( + name: name, + node: this, + build: build, + providerElement: providerElement, + argumentList: arguments, + typeArguments: typeArguments, + provider: provider, + autoDisposeModifier: autoDisposeModifier, + familyModifier: familyModifier, + dependencies: dependencies, + ); + }); + } +} + +final class LegacyProviderDeclaration implements ProviderDeclaration { + LegacyProviderDeclaration._({ + required this.name, + required this.node, + required this.build, + required this.typeArguments, + required this.providerElement, + required this.argumentList, + required this.provider, + required this.autoDisposeModifier, + required this.familyModifier, + required this.dependencies, + }); + + final LegacyProviderDependencies? dependencies; + + final FunctionExpression build; + final ArgumentList argumentList; + final SyntacticEntity provider; + final SimpleIdentifier? autoDisposeModifier; + final SimpleIdentifier? familyModifier; + final TypeArgumentList? typeArguments; + + @override + final LegacyProviderDeclarationElement providerElement; + + @override + final Token name; + + @override + final VariableDeclaration node; +} + +/// The class name for explicitly typed provider. +/// +/// Such as `FutureProvider` for `final provider = FutureProvider(...)`. +/// This is only about the type, and does not include autoDispose/family/... +enum LegacyProviderType { + /// Type for `ChangeNotifierProvider` + changeNotifierProvider, + + /// Type for `FutureProvider` + futureProvider, + + /// Type for `AsyncNotifierProvider` + asyncNotifierProvider, + + /// Type for `StreamProvider` + streamProvider, + + /// Type for `StreamNotifier` + streamNotifier, + + /// Type for `StateNotifierProvider` + stateNotifierProvider, + + /// Type for `StateProvider` + stateProvider, + + /// Type for `Provider` + provider, + + /// Type for `NotifierProvider` + notifierProvider; +} + +@internal +LegacyProviderType? parseLegacyProviderType(DartType type) { + if (!isFromRiverpod.isExactlyType(type) && + !isFromFlutterRiverpod.isExactlyType(type)) { + return null; + } + + final name = type.element?.name; + if (name == 'FutureProvider' || name == 'FutureProviderFamily') { + return LegacyProviderType.futureProvider; + } + if (name == 'StreamProvider' || name == 'StreamProviderFamily') { + return LegacyProviderType.streamProvider; + } + if (name == 'StreamNotifierProvider' || + name == 'StreamNotifierProviderFamily') { + return LegacyProviderType.streamNotifier; + } + if (name == 'StateProvider' || name == 'StateProviderFamily') { + return LegacyProviderType.stateProvider; + } + if (name == 'StateNotifierProvider' || + name == 'StateNotifierProviderFamily') { + return LegacyProviderType.stateNotifierProvider; + } + if (name == 'Provider' || name == 'ProviderFamily') { + return LegacyProviderType.provider; + } + if (name == 'NotifierProvider' || name == 'NotifierProviderFamily') { + return LegacyProviderType.notifierProvider; + } + if (name == 'AsyncNotifierProvider' || + name == 'AsyncNotifierProviderFamily') { + return LegacyProviderType.asyncNotifierProvider; + } + if (name == 'ChangeNotifierProvider' || + name == 'ChangeNotifierProviderFamily') { + return LegacyProviderType.changeNotifierProvider; + } + + return null; +} + +class LegacyProviderDeclarationElement implements ProviderDeclarationElement { + LegacyProviderDeclarationElement._({ + required this.name, + required this.element, + required this.familyElement, + required this.providerType, + }); + + static LegacyProviderDeclarationElement? _parse(VariableElement element) { + return _cache(element, () { + final type = element.type; + final providerType = parseLegacyProviderType(type); + // Not a legacy provider + if (providerType == null) return null; + + LegacyFamilyInvocationElement? familyElement; + if (familyType.isAssignableFromType(element.type)) { + final callFn = (element.type as InterfaceType).lookUpMethod2( + 'call', + element.library!, + )!; + final parameter = callFn.parameters.single; + + familyElement = LegacyFamilyInvocationElement._(parameter.type); + } + + return LegacyProviderDeclarationElement._( + name: element.name, + element: element, + familyElement: familyElement, + providerType: providerType, + ); + }); + } + + static final _cache = _Cache(); + + @override + final VariableElement element; + + @override + final String name; + + final LegacyFamilyInvocationElement? familyElement; + + final LegacyProviderType providerType; +} + +class LegacyFamilyInvocationElement { + LegacyFamilyInvocationElement._(this.parameterType); + final DartType parameterType; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/notifier.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/notifier.dart new file mode 100644 index 000000000..6217f2df6 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/notifier.dart @@ -0,0 +1,185 @@ +part of '../../nodes.dart'; + +@_ast +extension ClassBasedProviderDeclarationX on ClassDeclaration { + ClassBasedProviderDeclaration? get provider { + return upsert('ClassBasedProviderDeclaration', () { + final element = declaredElement; + if (element == null) return null; + + final riverpod = this.riverpod; + if (riverpod == null) return null; + + if (abstractKeyword != null) { + errorReporter( + RiverpodAnalysisError( + 'Classes annotated with @riverpod cannot be abstract.', + targetNode: this, + targetElement: declaredElement, + code: RiverpodAnalysisErrorCode.abstractNotifier, + ), + ); + } + + final constructors = members.whereType().toList(); + final defaultConstructor = constructors + .firstWhereOrNull((constructor) => constructor.name == null); + if (defaultConstructor == null && constructors.isNotEmpty) { + errorReporter( + RiverpodAnalysisError( + 'Classes annotated with @riverpod must have a default constructor.', + targetNode: this, + targetElement: declaredElement, + code: RiverpodAnalysisErrorCode.missingNotifierDefaultConstructor, + ), + ); + } + if (defaultConstructor != null && + defaultConstructor.parameters.parameters.any((e) => e.isRequired)) { + errorReporter( + RiverpodAnalysisError( + 'The default constructor of classes annotated with @riverpod ' + 'cannot have required parameters.', + targetNode: this, + targetElement: declaredElement, + code: RiverpodAnalysisErrorCode + .notifierDefaultConstructorHasRequiredParameters, + ), + ); + } + + final buildMethod = members + .whereType() + .firstWhereOrNull((method) => method.name.lexeme == 'build'); + if (buildMethod == null) { + errorReporter( + RiverpodAnalysisError( + 'No "build" method found. ' + 'Classes annotated with @riverpod must define a method named "build".', + targetNode: this, + code: RiverpodAnalysisErrorCode.missingNotifierBuild, + ), + ); + return null; + } + + final providerElement = ClassBasedProviderDeclarationElement._parse( + element, + ); + if (providerElement == null) return null; + + final createdTypeNode = buildMethod.returnType; + + final exposedTypeNode = _computeExposedType( + createdTypeNode, + root.cast()!, + ); + if (exposedTypeNode == null) { + // Error already reported + return null; + } + + final valueTypeNode = _getValueType(createdTypeNode, element.library); + final classBasedProviderDeclaration = ClassBasedProviderDeclaration._( + name: name, + node: this, + buildMethod: buildMethod, + providerElement: providerElement, + annotation: riverpod, + createdTypeNode: createdTypeNode, + exposedTypeNode: exposedTypeNode, + valueTypeNode: valueTypeNode, + ); + + return classBasedProviderDeclaration; + }); + } +} + +final class ClassBasedProviderDeclaration extends GeneratorProviderDeclaration { + ClassBasedProviderDeclaration._({ + required this.name, + required this.node, + required this.buildMethod, + required this.providerElement, + required this.annotation, + required this.createdTypeNode, + required this.exposedTypeNode, + required this.valueTypeNode, + }); + + @override + final Token name; + @override + final ClassDeclaration node; + @override + final ClassBasedProviderDeclarationElement providerElement; + @override + final RiverpodAnnotation annotation; + final MethodDeclaration buildMethod; + @override + final TypeAnnotation? createdTypeNode; + @override + final TypeAnnotation? valueTypeNode; + @override + final SourcedType exposedTypeNode; +} + +class ClassBasedProviderDeclarationElement + extends GeneratorProviderDeclarationElement { + ClassBasedProviderDeclarationElement._({ + required this.name, + required this.annotation, + required this.buildMethod, + required this.element, + }); + + static final _cache = _Cache(); + + static ClassBasedProviderDeclarationElement? _parse(ClassElement element) { + return _cache(element, () { + final riverpodAnnotation = RiverpodAnnotationElement._of(element); + if (riverpodAnnotation == null) return null; + + final buildMethod = + element.methods.firstWhereOrNull((method) => method.name == 'build'); + + if (buildMethod == null) { + errorReporter( + RiverpodAnalysisError( + 'No "build" method found. ' + 'Classes annotated with @riverpod must define a method named "build".', + targetElement: element, + code: RiverpodAnalysisErrorCode.missingNotifierBuild, + ), + ); + + return null; + } + + return ClassBasedProviderDeclarationElement._( + name: element.name, + buildMethod: buildMethod, + element: element, + annotation: riverpodAnnotation, + ); + }); + } + + @override + bool get isFamily { + return buildMethod.parameters.isNotEmpty || + element.typeParameters.isNotEmpty; + } + + @override + final ClassElement element; + + @override + final String name; + + @override + final RiverpodAnnotationElement annotation; + + final ExecutableElement buildMethod; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/providers.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/providers.dart new file mode 100644 index 000000000..26053b69b --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/providers.dart @@ -0,0 +1,159 @@ +part of '../../nodes.dart'; + +sealed class ProviderDeclaration { + Token get name; + Declaration get node; + ProviderDeclarationElement get providerElement; +} + +sealed class ProviderDeclarationElement { + Element get element; + String get name; +} + +@_ast +extension GeneratorProviderDeclarationX on Declaration { + GeneratorProviderDeclaration? get provider { + final that = this; + switch (that) { + case ClassDeclaration(): + return ClassBasedProviderDeclarationX(that).provider; + case FunctionDeclaration(): + return FunctionalProviderDeclarationX(that).provider; + default: + return null; + } + } +} + +sealed class GeneratorProviderDeclaration extends ProviderDeclaration { + @override + GeneratorProviderDeclarationElement get providerElement; + RiverpodAnnotation get annotation; + + String get valueTypeDisplayString => valueTypeNode?.toSource() ?? 'Object?'; + String get exposedTypeDisplayString => exposedTypeNode?.source ?? 'Object?'; + String get createdTypeDisplayString { + final type = createdTypeNode?.type; + + if (type != null && + !type.isRaw && + (type.isDartAsyncFuture || type.isDartAsyncFutureOr)) { + return 'FutureOr<$valueTypeDisplayString>'; + } + + return createdTypeNode?.toSource() ?? 'Object?'; + } + + TypeAnnotation? get valueTypeNode; + SourcedType? get exposedTypeNode; + TypeAnnotation? get createdTypeNode; + + String computeProviderHash() { + // TODO improve hash function to inspect the body of the create fn + // such that the hash changes if one of the element defined outside of the + // fn changes. + final bytes = utf8.encode(node.toSource()); + final digest = sha1.convert(bytes); + return digest.toString(); + } +} + +sealed class GeneratorProviderDeclarationElement + implements ProviderDeclarationElement { + RiverpodAnnotationElement get annotation; + + /// Whether a provider has any form of parameter, be it function parameters + /// or type parameters. + bool get isFamily; + + bool get isScoped { + if (annotation.dependencies != null) return true; + + final that = this; + return that is ClassBasedProviderDeclarationElement && + that.buildMethod.isAbstract; + } + + bool get isAutoDispose => !annotation.keepAlive; +} + +typedef SourcedType = ({String? source, DartType dartType}); + +SourcedType? _computeExposedType( + TypeAnnotation? createdType, + CompilationUnit unit, +) { + final library = unit.declaredElement!.library; + + if (createdType == null) { + return ( + source: null, + dartType: library.typeProvider.dynamicType, + ); + } + + final createdDartType = createdType.type!; + if (createdDartType.isRaw) { + return ( + source: createdType.toSource(), + dartType: createdType.type!, + ); + } + + if (createdDartType.isDartAsyncFuture || + createdDartType.isDartAsyncFutureOr || + createdDartType.isDartAsyncStream) { + createdType as NamedType; + createdDartType as InterfaceType; + + final typeSource = createdType.toSource(); + if (typeSource != 'Future' && + typeSource != 'FutureOr' && + typeSource != 'Stream' && + !typeSource.startsWith('Future<') && + !typeSource.startsWith('FutureOr<') && + !typeSource.startsWith('Stream<')) { + throw UnsupportedError( + 'Returning a typedef of type Future/FutureOr/Stream is not supported\n' + 'The code that triggered this error is: $typeSource', + ); + } + + final valueTypeArg = createdType.typeArguments?.arguments.firstOrNull; + + final exposedDartType = unit.createdTypeToValueType( + createdDartType.typeArguments.first, + ); + if (exposedDartType == null) return null; + + return ( + source: valueTypeArg == null ? 'AsyncValue' : 'AsyncValue<$valueTypeArg>', + dartType: exposedDartType, + ); + } + + return ( + source: createdType.toSource(), + dartType: createdType.type!, + ); +} + +TypeAnnotation? _getValueType( + TypeAnnotation? createdType, + LibraryElement library, +) { + if (createdType == null) return null; + final dartType = createdType.type!; + if (dartType.isRaw) return createdType; + + if (dartType.isDartAsyncFuture || + dartType.isDartAsyncFutureOr || + dartType.isDartAsyncStream) { + createdType as NamedType; + + return createdType.typeArguments?.arguments.firstOrNull; + } + + return createdType; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart new file mode 100644 index 000000000..78275eb56 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart @@ -0,0 +1,159 @@ +part of '../nodes.dart'; + +@_ast +extension RefInvocationX on MethodInvocation { + RefInvocation? get refInvocation { + return upsert('RefInvocation', () { + final targetType = realTarget?.staticType; + if (targetType == null) return null; + + if (!isRiverpodRef(targetType)) return null; + + final function = this.function; + if (function is! SimpleIdentifier) return null; + final functionOwner = function.staticElement + .cast() + ?.declaration + .enclosingElement; + + if (functionOwner == null || + // Since Ref is sealed, checking that the function is from the package:riverpod + // before checking its type skips iterating over the superclasses of an element + // if it's not from Riverpod. + !isFromRiverpod.isExactly(functionOwner) || + !refType.isAssignableFrom(functionOwner)) { + return null; + } + + switch (function.name) { + case 'watch': + return RefWatchInvocation._parse(this, function); + case 'read': + return RefReadInvocation._parse(this, function); + case 'listen': + return RefListenInvocation._parse(this, function); + default: + return null; + } + }); + } +} + +sealed class RefInvocation { + RefInvocation._({ + required this.node, + required this.function, + }); + + final MethodInvocation node; + final SimpleIdentifier function; +} + +/// A [RefInvocation] which interacts with a provider, inducing a dependency. +sealed class RefDependencyInvocation extends RefInvocation { + RefDependencyInvocation._({ + required super.node, + required super.function, + required this.listenable, + }) : super._(); + + /// The provider that is being interacted with. + final ProviderListenableExpression listenable; +} + +final class RefWatchInvocation extends RefDependencyInvocation { + RefWatchInvocation._({ + required super.node, + required super.function, + required super.listenable, + }) : super._(); + + static RefWatchInvocation? _parse( + MethodInvocation node, + SimpleIdentifier function, + ) { + assert( + function.name == 'watch', + 'Argument error, function is not a ref.watch function', + ); + + final providerListenableExpression = node.argumentList + .positionalArguments() + .singleOrNull + ?.providerListenable; + if (providerListenableExpression == null) return null; + + return RefWatchInvocation._( + node: node, + function: function, + listenable: providerListenableExpression, + ); + } +} + +final class RefReadInvocation extends RefDependencyInvocation { + RefReadInvocation._({ + required super.node, + required super.function, + required super.listenable, + }) : super._(); + + static RefReadInvocation? _parse( + MethodInvocation node, + SimpleIdentifier function, + ) { + assert( + function.name == 'read', + 'Argument error, function is not a ref.read function', + ); + + final providerListenableExpression = node.argumentList + .positionalArguments() + .singleOrNull + ?.providerListenable; + if (providerListenableExpression == null) return null; + + return RefReadInvocation._( + node: node, + function: function, + listenable: providerListenableExpression, + ); + } +} + +final class RefListenInvocation extends RefDependencyInvocation { + RefListenInvocation._({ + required super.node, + required super.function, + required this.listener, + required super.listenable, + }) : super._(); + + static RefListenInvocation? _parse( + MethodInvocation node, + SimpleIdentifier function, + ) { + assert( + function.name == 'listen', + 'Argument error, function is not a ref.listen function', + ); + + final positionalArgs = node.argumentList.positionalArguments().toList(); + + final listener = positionalArgs.elementAtOrNull(1); + if (listener == null) return null; + + final providerListenableExpression = + positionalArgs.firstOrNull?.providerListenable; + if (providerListenableExpression == null) return null; + + return RefListenInvocation._( + node: node, + function: function, + listener: listener, + listenable: providerListenableExpression, + ); + } + + final Expression listener; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart new file mode 100644 index 000000000..5b646367a --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart @@ -0,0 +1,115 @@ +part of '../nodes.dart'; + +extension RiverpodAnnotatedAnnotatedNodeOfX on AnnotatedNode { + RiverpodAnnotation? get riverpod { + return upsert('RiverpodAnnotationAnnotatedNodeX', () { + return metadata.map((e) => e.riverpod).whereNotNull().firstOrNull; + }); + } +} + +@_ast +extension RiverpodAnnotatedAnnotatedNodeX on Annotation { + RiverpodAnnotation? get riverpod { + return upsert('RiverpodAnnotation', () { + final elementAnnotation = this.elementAnnotation; + final element = this.element; + if (element == null || elementAnnotation == null) return null; + if (element is! ExecutableElement || + !riverpodType.isExactlyType(element.returnType)) { + // The annotation is not an @Riverpod + return null; + } + + final riverpodAnnotationElement = RiverpodAnnotationElement._parse( + elementAnnotation, + ); + if (riverpodAnnotationElement == null) return null; + + final dependenciesNode = arguments?.named('dependencies'); + + final dependencyList = dependenciesNode.let( + (e) => e.expression.providerDependencyList, + ); + + return RiverpodAnnotation._( + node: this, + element: riverpodAnnotationElement, + keepAliveNode: arguments?.named('keepAlive'), + dependenciesNode: dependenciesNode, + dependencyList: dependencyList, + ); + }); + } +} + +final class RiverpodAnnotation { + RiverpodAnnotation._({ + required this.node, + required this.element, + required this.keepAliveNode, + required this.dependenciesNode, + required this.dependencyList, + }); + + final Annotation node; + final RiverpodAnnotationElement element; + final NamedExpression? keepAliveNode; + final NamedExpression? dependenciesNode; + final ProviderDependencyList? dependencyList; +} + +final class RiverpodAnnotationElement { + RiverpodAnnotationElement._({ + required this.keepAlive, + required this.dependencies, + required this.allTransitiveDependencies, + required this.element, + }); + + static final _cache = _Cache(); + + static RiverpodAnnotationElement? _parse(ElementAnnotation element) { + return _cache(element, () { + final type = element.element.cast()?.returnType; + if (type == null || !riverpodType.isExactlyType(type)) return null; + + final constant = element.computeConstantValue(); + if (constant == null) return null; + + final keepAlive = constant.getField('keepAlive'); + if (keepAlive == null) return null; + + final dependencies = constant.getField('dependencies'); + if (dependencies == null) return null; + + final dependencyList = dependencies.toDependencyList( + from: element.element, + ); + final allTransitiveDependencies = dependencyList == null + ? null + : { + ...dependencyList, + ...dependencyList.expand( + (e) => e.annotation.allTransitiveDependencies ?? const {}, + ), + }; + + return RiverpodAnnotationElement._( + keepAlive: keepAlive.toBoolValue()!, + element: element, + dependencies: dependencyList, + allTransitiveDependencies: allTransitiveDependencies, + ); + }); + } + + static RiverpodAnnotationElement? _of(Element element) { + return element.metadata.map(_parse).whereNotNull().firstOrNull; + } + + final bool keepAlive; + final ElementAnnotation element; + final List? dependencies; + final Set? allTransitiveDependencies; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/overrides.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/overrides.dart new file mode 100644 index 000000000..ec9500451 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/overrides.dart @@ -0,0 +1,78 @@ +part of '../../nodes.dart'; + +@_ast +extension ProviderOverrideExpressionX on CollectionElement { + ProviderOverrideExpression? get providerOverride { + return upsert('ProviderOverrideExpression', () { + final expression = this; + if (expression is! Expression) return null; + + final type = expression.staticType; + if (type == null || !overrideType.isAssignableFromType(type)) return null; + + final result = _parsesProviderExpression(expression); + + return ProviderOverrideExpression._( + node: expression, + familyArguments: result?.familyArguments, + provider: result?.provider, + providerPrefix: result?.providerPrefix, + ); + }); + } +} + +final class ProviderOverrideExpression { + ProviderOverrideExpression._({ + required this.node, + required this.provider, + required this.familyArguments, + required this.providerPrefix, + }); + + final CollectionElement node; + final ProviderIdentifier? provider; + final SimpleIdentifier? providerPrefix; + + /// If [provider] is a provider with arguments (family), represents the arguments + /// passed to the provider. + final ArgumentList? familyArguments; +} + +@_ast +extension ProviderOverrideListX on Expression { + ProviderOverrideList? get overrides { + return upsert('ProviderOverrideList', () { + final expression = this; + final type = staticType; + if (type == null || !type.isDartCoreList) return null; + + type as InterfaceType; + final valueType = type.typeArguments.single; + if (!overrideType.isAssignableFromType(valueType)) return null; + + List? overrides; + if (expression is ListLiteral) { + overrides = expression.elements + .map((e) => e.providerOverride) + .whereNotNull() + .toList(); + } + + return ProviderOverrideList._( + node: expression, + overrides: overrides, + ); + }); + } +} + +final class ProviderOverrideList { + ProviderOverrideList._({ + required this.node, + required this.overrides, + }); + + final Expression node; + final List? overrides; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_container.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_container.dart new file mode 100644 index 000000000..5d41dcb39 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_container.dart @@ -0,0 +1,36 @@ +part of '../../nodes.dart'; + +@_ast +extension ProviderContainerInstanceCreationExpressionX + on InstanceCreationExpression { + ProviderContainerInstanceCreationExpression? get providerContainer { + return upsert('ProviderContainerInstanceCreationExpression', () { + final createdType = constructorName.type.type; + if (createdType == null || + !providerContainerType.isExactlyType(createdType)) { + return null; + } + + final overrides = argumentList + .namedArguments() + .firstWhereOrNull((e) => e.name.label.name == 'overrides'); + + return ProviderContainerInstanceCreationExpression._( + node: this, + overrides: overrides?.expression.overrides, + ); + }); + } +} + +final class ProviderContainerInstanceCreationExpression { + ProviderContainerInstanceCreationExpression._({ + required this.node, + required this.overrides, + }); + + final InstanceCreationExpression node; + final ProviderOverrideList? overrides; + + late final NamedExpression? parent = node.argumentList.named('parent'); +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_scope.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_scope.dart new file mode 100644 index 000000000..69d1c5a74 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_scope.dart @@ -0,0 +1,34 @@ +part of '../../nodes.dart'; + +@_ast +extension ProviderScopeInstanceCreationExpressionX + on InstanceCreationExpression { + ProviderScopeInstanceCreationExpression? get providerScope { + return upsert('ProviderScopeInstanceCreationExpression', () { + final createdType = constructorName.type.type; + if (createdType == null || + !providerScopeType.isExactlyType(createdType)) { + return null; + } + + final overrides = argumentList + .namedArguments() + .firstWhereOrNull((e) => e.name.label.name == 'overrides'); + + return ProviderScopeInstanceCreationExpression._( + node: this, + overrides: overrides?.expression.overrides, + ); + }); + } +} + +final class ProviderScopeInstanceCreationExpression { + ProviderScopeInstanceCreationExpression._({ + required this.node, + required this.overrides, + }); + + final InstanceCreationExpression node; + final ProviderOverrideList? overrides; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart new file mode 100644 index 000000000..0968b75c2 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart @@ -0,0 +1,203 @@ +part of '../nodes.dart'; + +@_ast +extension WidgetRefInvocationX on MethodInvocation { + WidgetRefInvocation? get widgetRefInvocation { + return upsert('WidgetRefInvocation', () { + final targetType = realTarget?.staticType; + if (targetType == null) return null; + + // Since Ref is sealed, checking that the function is from the package:riverpod + // before checking its type skips iterating over the superclasses of an element + // if it's not from Riverpod. + if (!isFromFlutterRiverpod.isExactlyType(targetType) | + !widgetRefType.isAssignableFromType(targetType)) { + return null; + } + final function = this.function; + if (function is! SimpleIdentifier) return null; + final functionOwner = function.staticElement + .cast() + ?.declaration + .enclosingElement; + + if (functionOwner == null || + // Since Ref is sealed, checking that the function is from the package:riverpod + // before checking its type skips iterating over the superclasses of an element + // if it's not from Riverpod. + !isFromFlutterRiverpod.isExactly(functionOwner) || + !widgetRefType.isAssignableFrom(functionOwner)) { + return null; + } + + switch (function.name) { + case 'watch': + return WidgetRefWatchInvocation._parse(this, function); + case 'read': + return WidgetRefReadInvocation._parse(this, function); + case 'listen': + return WidgetRefListenInvocation._parse(this, function); + case 'listenManual': + return WidgetRefListenManualInvocation._parse(this, function); + + default: + return null; + } + }); + } +} + +sealed class WidgetRefInvocation { + WidgetRefInvocation._({ + required this.node, + required this.function, + }); + + final MethodInvocation node; + final SimpleIdentifier function; +} + +/// A [RefInvocation] which interacts with a provider, inducing a dependency. +sealed class WidgetRefDependencyInvocation extends WidgetRefInvocation { + WidgetRefDependencyInvocation._({ + required super.node, + required super.function, + required this.listenable, + }) : super._(); + + /// The provider that is being interacted with. + final ProviderListenableExpression listenable; +} + +final class WidgetRefWatchInvocation extends WidgetRefDependencyInvocation { + WidgetRefWatchInvocation._({ + required super.node, + required super.function, + required super.listenable, + }) : super._(); + + static WidgetRefWatchInvocation? _parse( + MethodInvocation node, + SimpleIdentifier function, + ) { + assert( + function.name == 'watch', + 'Argument error, function is not a ref.watch function', + ); + + final providerListenableExpression = node.argumentList + .positionalArguments() + .singleOrNull + ?.providerListenable; + if (providerListenableExpression == null) return null; + + return WidgetRefWatchInvocation._( + node: node, + function: function, + listenable: providerListenableExpression, + ); + } +} + +final class WidgetRefReadInvocation extends WidgetRefDependencyInvocation { + WidgetRefReadInvocation._({ + required super.node, + required super.function, + required super.listenable, + }) : super._(); + + static WidgetRefReadInvocation? _parse( + MethodInvocation node, + SimpleIdentifier function, + ) { + assert( + function.name == 'read', + 'Argument error, function is not a ref.read function', + ); + + final providerListenableExpression = node.argumentList + .positionalArguments() + .singleOrNull + ?.providerListenable; + if (providerListenableExpression == null) return null; + + return WidgetRefReadInvocation._( + node: node, + function: function, + listenable: providerListenableExpression, + ); + } +} + +final class WidgetRefListenInvocation extends WidgetRefDependencyInvocation { + WidgetRefListenInvocation._({ + required super.node, + required super.function, + required super.listenable, + required this.listener, + }) : super._(); + + static WidgetRefListenInvocation? _parse( + MethodInvocation node, + SimpleIdentifier function, + ) { + assert( + function.name == 'listen', + 'Argument error, function is not a ref.listen function', + ); + + final positionalArgs = node.argumentList.positionalArguments().toList(); + final listener = positionalArgs.elementAtOrNull(1); + if (listener == null) return null; + + final providerListenableExpression = + positionalArgs.firstOrNull?.providerListenable; + if (providerListenableExpression == null) return null; + + return WidgetRefListenInvocation._( + node: node, + function: function, + listenable: providerListenableExpression, + listener: listener, + ); + } + + final Expression listener; +} + +final class WidgetRefListenManualInvocation + extends WidgetRefDependencyInvocation { + WidgetRefListenManualInvocation._({ + required super.node, + required super.function, + required super.listenable, + required this.listener, + }) : super._(); + + static WidgetRefListenManualInvocation? _parse( + MethodInvocation node, + SimpleIdentifier function, + ) { + assert( + function.name == 'listenManual', + 'Argument error, function is not a ref.listen function', + ); + + final positionalArgs = node.argumentList.positionalArguments().toList(); + final listener = positionalArgs.elementAtOrNull(1); + if (listener == null) return null; + + final providerListenableExpression = + positionalArgs.firstOrNull?.providerListenable; + if (providerListenableExpression == null) return null; + + return WidgetRefListenManualInvocation._( + node: node, + function: function, + listenable: providerListenableExpression, + listener: listener, + ); + } + + final Expression listener; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/state.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/state.dart new file mode 100644 index 000000000..e0e9e7082 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/state.dart @@ -0,0 +1,78 @@ +part of '../../nodes.dart'; + +ClassElement? _findStateWidget(ClassElement node) { + final type = node.supertype?.typeArguments.firstOrNull; + if (type == null) return null; + + // May be typed as `State` or `State`. + // The latter prevents from finding the widget class. + if (isFromFlutter.isExactlyType(type) || + isFromFlutterRiverpod.isExactlyType(type) || + isFromRiverpod.isExactlyType(type) || + isFromHooksRiverpod.isExactlyType(type)) { + return null; + } + + return type.element.cast(); +} + +final class StateDeclaration { + StateDeclaration._({ + required this.widget, + required this.element, + required this.node, + }); + + static StateDeclaration? _parse(ClassDeclaration node) { + final widget = node.declaredElement.let(_findStateWidget); + final element = node.declaredElement.let(StateDeclarationElement._parse); + + if (element == null) return null; + + return StateDeclaration._( + widget: widget.let(StatefulWidgetDeclarationElement._parse), + element: element, + node: node, + ); + } + + final ClassDeclaration node; + final StatefulWidgetDeclarationElement? widget; + final StateDeclarationElement element; + + WidgetDeclaration? findWidgetAst() { + final widgetName = widget?.element.name; + if (widgetName == null) return null; + + final unit = node.thisOrAncestorOfType()!; + + final widgetClass = unit.declarations + .whereType() + .firstWhereOrNull((e) => e.name.lexeme == widgetName); + + return widgetClass?.widget; + } +} + +final class StateDeclarationElement { + StateDeclarationElement._({ + required this.widget, + required this.element, + }); + + static final _cache = _Cache(); + + static StateDeclarationElement? _parse(ClassElement element) { + return _cache(element, () { + final widget = _findStateWidget(element); + + return StateDeclarationElement._( + element: element, + widget: widget.let(StatefulWidgetDeclarationElement._parse), + ); + }); + } + + final ClassElement element; + final StatefulWidgetDeclarationElement? widget; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart new file mode 100644 index 000000000..ce7f724d7 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart @@ -0,0 +1,101 @@ +part of '../../nodes.dart'; + +bool _isCoreType(DartType type) { + return isFromFlutter.isExactlyType(type) || + isFromFlutterRiverpod.isExactlyType(type) || + isFromRiverpod.isExactlyType(type) || + isFromHooksRiverpod.isExactlyType(type); +} + +ClassElement? _findStateFromReturnType(ClassElement node) { + final type = + node.methods.firstWhereOrNull((e) => e.name == 'createState')?.returnType; + + if (type == null) return null; + + // May be typed as `MyState createState()` or `State createState()`. + // The latter prevents from finding the state class. + if (_isCoreType(type)) return null; + + return type.element.cast(); +} + +ClassElement? _findStateWithMatchingGeneric(ClassElement node) { + for (final clazz in node.enclosingElement.classes) { + final type = clazz.supertype; + if (type != null && isState(type) && _findStateWidget(clazz) == node) { + return clazz; + } + } + + return null; +} + +ClassElement? _findState(ClassElement node) { + return _findStateFromReturnType(node) ?? _findStateWithMatchingGeneric(node); +} + +final class StatefulWidgetDeclaration extends WidgetDeclaration { + StatefulWidgetDeclaration({ + required this.node, + required this.state, + required this.element, + }); + + static StatefulWidgetDeclaration? _parse(ClassDeclaration node) { + final stateClass = node.declaredElement.let(_findState); + final element = node.declaredElement.let( + StatefulWidgetDeclarationElement._parse, + ); + if (element == null) return null; + + return StatefulWidgetDeclaration( + node: node, + element: element, + state: stateClass.let(StateDeclarationElement._parse), + ); + } + + final StateDeclarationElement? state; + @override + final StatefulWidgetDeclarationElement element; + @override + final ClassDeclaration node; + + StateDeclaration? findStateAst() { + final stateName = state?.element.name; + if (stateName == null) return null; + + final unit = node.thisOrAncestorOfType()!; + + final stateClass = unit.declarations + .whereType() + .firstWhereOrNull((e) => e.name.lexeme == stateName); + + return stateClass?.state; + } +} + +final class StatefulWidgetDeclarationElement extends WidgetDeclarationElement { + StatefulWidgetDeclarationElement({ + required this.element, + required this.dependencies, + }); + + static final _cache = _Cache(); + + static StatefulWidgetDeclarationElement? _parse(ClassElement node) { + return _cache(node, () { + final dependencies = DependenciesAnnotationElement._of(node); + + return StatefulWidgetDeclarationElement( + element: node, + dependencies: dependencies, + ); + }); + } + + final ClassElement element; + @override + final DependenciesAnnotationElement? dependencies; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateless_widget.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateless_widget.dart new file mode 100644 index 000000000..956e56c98 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateless_widget.dart @@ -0,0 +1,45 @@ +part of '../../nodes.dart'; + +final class StatelessWidgetDeclaration extends WidgetDeclaration { + StatelessWidgetDeclaration._({ + required this.element, + required this.node, + }); + + static StatelessWidgetDeclaration? _parse(ClassDeclaration node) { + final element = node.declaredElement.let( + StatelessWidgetDeclarationElement._parse, + ); + if (element == null) return null; + + return StatelessWidgetDeclaration._( + element: element, + node: node, + ); + } + + @override + final StatelessWidgetDeclarationElement element; + + @override + final ClassDeclaration node; +} + +final class StatelessWidgetDeclarationElement extends WidgetDeclarationElement { + StatelessWidgetDeclarationElement._({required this.dependencies}); + + static final _cache = _Cache(); + + static StatelessWidgetDeclarationElement? _parse(ClassElement node) { + return _cache(node, () { + final dependencies = DependenciesAnnotationElement._of(node); + + return StatelessWidgetDeclarationElement._( + dependencies: dependencies, + ); + }); + } + + @override + final DependenciesAnnotationElement? dependencies; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/widget.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/widget.dart new file mode 100644 index 000000000..1c4ba9ced --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/widget.dart @@ -0,0 +1,41 @@ +part of '../../nodes.dart'; + +@_ast +extension WidgetX on ClassDeclaration { + WidgetDeclaration? get widget { + return upsert('Widget', () { + final type = extendsClause?.superclass.type; + if (type == null) return null; + + if (isStatelessWidget(type)) { + return StatelessWidgetDeclaration._parse(this); + } + + if (isStatefulWidget(type)) { + return StatefulWidgetDeclaration._parse(this); + } + + return null; + }); + } + + StateDeclaration? get state { + return upsert('State', () { + final type = extendsClause?.superclass.type; + if (type == null) return null; + + if (isState(type)) return StateDeclaration._parse(this); + + return null; + }); + } +} + +abstract class WidgetDeclaration { + ClassDeclaration get node; + WidgetDeclarationElement get element; +} + +abstract class WidgetDeclarationElement { + DependenciesAnnotationElement? get dependencies; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/object_extensions.dart b/packages/riverpod_analyzer_utils/lib/src/object_extensions.dart new file mode 100644 index 000000000..d55d885e5 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/object_extensions.dart @@ -0,0 +1,17 @@ +import 'package:meta/meta.dart'; + +@internal +extension ObjectX on T? { + R? cast() { + final that = this; + if (that is R) return that; + return null; + } + + R? let(R? Function(T value)? cb) { + if (cb == null) return null; + final that = this; + if (that != null) return cb(that); + return null; + } +} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast.dart deleted file mode 100644 index 0a9f15fed..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast.dart +++ /dev/null @@ -1,76 +0,0 @@ -library riverpod_ast; - -import 'dart:async'; -import 'dart:convert'; - -import 'package:analyzer/dart/ast/ast.dart'; -import 'package:analyzer/dart/ast/syntactic_entity.dart'; -import 'package:analyzer/dart/ast/token.dart'; -import 'package:analyzer/dart/ast/visitor.dart'; -import 'package:analyzer/dart/constant/value.dart'; -import 'package:analyzer/dart/element/element.dart'; -import 'package:analyzer/dart/element/nullability_suffix.dart'; -import 'package:analyzer/dart/element/type.dart'; -import 'package:collection/collection.dart'; -import 'package:crypto/crypto.dart'; -import 'package:meta/meta.dart'; - -import '../riverpod_analyzer_utils.dart'; -import 'argument_list_utils.dart'; -import 'errors.dart'; - -part 'riverpod_ast.g.dart'; -part 'riverpod_ast/consumer.dart'; -part 'riverpod_ast/generator_provider_declaration.dart'; -part 'riverpod_ast/legacy_provider_declaration.dart'; -part 'riverpod_ast/provider_container_instance_creation_expression.dart'; -part 'riverpod_ast/provider_declaration.dart'; -part 'riverpod_ast/provider_listenable_expression.dart'; -part 'riverpod_ast/provider_override.dart'; -part 'riverpod_ast/provider_scope.dart'; -part 'riverpod_ast/ref_invocation.dart'; -part 'riverpod_ast/resolve_riverpod.dart'; -part 'riverpod_ast/riverpod_annotation.dart'; -part 'riverpod_ast/widget_ref_invocation.dart'; - -class _SetParentVisitor extends GeneralizingRiverpodAstVisitor { - _SetParentVisitor(this.parent); - - final RiverpodAst parent; - - @override - void visitRiverpodAst(RiverpodAst node) { - node._parent = parent; - super.visitRiverpodAst(node); - } -} - -abstract base class RiverpodAst { - RiverpodAst() { - visitChildren(_SetParentVisitor(this)); - } - - RiverpodAst? _parent; - RiverpodAst? get parent => _parent; - - void accept(RiverpodAstVisitor visitor); - - @mustCallSuper - void visitChildren(RiverpodAstVisitor visitor); -} - -@internal -extension ObjectUtils on T? { - R? cast() { - final that = this; - if (that is R) return that; - return null; - } - - R? let(R? Function(T value)? cb) { - if (cb == null) return null; - final that = this; - if (that != null) return cb(that); - return null; - } -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast.g.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast.g.dart deleted file mode 100644 index 7d228c89e..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast.g.dart +++ /dev/null @@ -1,2029 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'riverpod_ast.dart'; - -// ************************************************************************** -// _LintVisitorGenerator -// ************************************************************************** - -base mixin _$ConsumerDeclaration on RiverpodAst { - @override - void visitChildren(RiverpodAstVisitor visitor) {} -} - -base mixin _$ConsumerWidgetDeclaration on RiverpodAst { - List get widgetRefInvocations; - List - get providerScopeInstanceCreateExpressions; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitConsumerWidgetDeclaration( - this as ConsumerWidgetDeclaration, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - - for (final value in widgetRefInvocations) { - value.accept(visitor); - } - - for (final value in providerScopeInstanceCreateExpressions) { - value.accept(visitor); - } - } -} - -base mixin _$HookConsumerWidgetDeclaration on RiverpodAst { - List get widgetRefInvocations; - List - get providerScopeInstanceCreateExpressions; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitHookConsumerWidgetDeclaration( - this as HookConsumerWidgetDeclaration, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - - for (final value in widgetRefInvocations) { - value.accept(visitor); - } - - for (final value in providerScopeInstanceCreateExpressions) { - value.accept(visitor); - } - } -} - -base mixin _$ConsumerStatefulWidgetDeclaration on RiverpodAst { - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitConsumerStatefulWidgetDeclaration( - this as ConsumerStatefulWidgetDeclaration, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - } -} - -base mixin _$StatefulHookConsumerWidgetDeclaration on RiverpodAst { - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitStatefulHookConsumerWidgetDeclaration( - this as StatefulHookConsumerWidgetDeclaration, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - } -} - -base mixin _$ConsumerStateDeclaration on RiverpodAst { - List get widgetRefInvocations; - List - get providerScopeInstanceCreateExpressions; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitConsumerStateDeclaration( - this as ConsumerStateDeclaration, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - - for (final value in widgetRefInvocations) { - value.accept(visitor); - } - - for (final value in providerScopeInstanceCreateExpressions) { - value.accept(visitor); - } - } -} - -base mixin _$GeneratorProviderDeclaration on RiverpodAst { - List get refInvocations; - RiverpodAnnotation get annotation; - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - - for (final value in refInvocations) { - value.accept(visitor); - } - - annotation.accept(visitor); - } -} - -base mixin _$ClassBasedProviderDeclaration on RiverpodAst { - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitClassBasedProviderDeclaration( - this as ClassBasedProviderDeclaration, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - } -} - -base mixin _$FunctionalProviderDeclaration on RiverpodAst { - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitFunctionalProviderDeclaration( - this as FunctionalProviderDeclaration, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - } -} - -base mixin _$LegacyProviderDependencies on RiverpodAst { - List? get dependencies; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitLegacyProviderDependencies( - this as LegacyProviderDependencies, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - if (dependencies case final dependencies?) { - for (final value in dependencies) { - value.accept(visitor); - } - } - } -} - -base mixin _$LegacyProviderDependency on RiverpodAst { - ProviderListenableExpression? get provider; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitLegacyProviderDependency( - this as LegacyProviderDependency, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - provider?.accept(visitor); - } -} - -base mixin _$LegacyProviderDeclaration on RiverpodAst { - LegacyProviderDependencies? get dependencies; - List get refInvocations; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitLegacyProviderDeclaration( - this as LegacyProviderDeclaration, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - dependencies?.accept(visitor); - - for (final value in refInvocations) { - value.accept(visitor); - } - } -} - -base mixin _$ProviderContainerInstanceCreationExpression on RiverpodAst { - ProviderOverrideList? get overrides; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitProviderContainerInstanceCreationExpression( - this as ProviderContainerInstanceCreationExpression, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - overrides?.accept(visitor); - } -} - -base mixin _$ProviderDeclaration on RiverpodAst { - @override - void visitChildren(RiverpodAstVisitor visitor) {} -} - -base mixin _$ProviderListenableExpressionParent on RiverpodAst { - @override - void visitChildren(RiverpodAstVisitor visitor) {} -} - -base mixin _$ProviderListenableExpression on RiverpodAst { - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitProviderListenableExpression( - this as ProviderListenableExpression, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) {} -} - -base mixin _$ProviderOverrideExpression on RiverpodAst { - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitProviderOverrideExpression( - this as ProviderOverrideExpression, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) {} -} - -base mixin _$ProviderOverrideList on RiverpodAst { - List? get overrides; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitProviderOverrideList( - this as ProviderOverrideList, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - if (overrides case final overrides?) { - for (final value in overrides) { - value.accept(visitor); - } - } - } -} - -base mixin _$ProviderScopeInstanceCreationExpression on RiverpodAst { - ProviderOverrideList? get overrides; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitProviderScopeInstanceCreationExpression( - this as ProviderScopeInstanceCreationExpression, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - overrides?.accept(visitor); - } -} - -base mixin _$RefInvocation on RiverpodAst { - @override - void visitChildren(RiverpodAstVisitor visitor) {} -} - -base mixin _$RefDependencyInvocation on RiverpodAst { - ProviderListenableExpression get provider; - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - provider.accept(visitor); - } -} - -base mixin _$RefWatchInvocation on RiverpodAst { - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitRefWatchInvocation( - this as RefWatchInvocation, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - } -} - -base mixin _$RefReadInvocation on RiverpodAst { - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitRefReadInvocation( - this as RefReadInvocation, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - } -} - -base mixin _$RefListenInvocation on RiverpodAst { - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitRefListenInvocation( - this as RefListenInvocation, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - } -} - -base mixin _$ResolvedRiverpodLibraryResult on RiverpodAst { - List - get providerScopeInstanceCreationExpressions; - List - get providerContainerInstanceCreationExpressions; - List get functionalProviderDeclarations; - List get classBasedProviderDeclarations; - List get legacyProviderDeclarations; - List get consumerWidgetDeclarations; - List - get consumerStatefulWidgetDeclarations; - List get consumerStateDeclaration; - List - get statefulHookConsumerWidgetDeclarations; - List get hookConsumerWidgetDeclarations; - List get unknownRefInvocations; - List get unknownWidgetRefInvocations; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitResolvedRiverpodLibraryResult( - this as ResolvedRiverpodLibraryResult, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - for (final value in providerScopeInstanceCreationExpressions) { - value.accept(visitor); - } - - for (final value in providerContainerInstanceCreationExpressions) { - value.accept(visitor); - } - - for (final value in functionalProviderDeclarations) { - value.accept(visitor); - } - - for (final value in classBasedProviderDeclarations) { - value.accept(visitor); - } - - for (final value in legacyProviderDeclarations) { - value.accept(visitor); - } - - for (final value in consumerWidgetDeclarations) { - value.accept(visitor); - } - - for (final value in consumerStatefulWidgetDeclarations) { - value.accept(visitor); - } - - for (final value in consumerStateDeclaration) { - value.accept(visitor); - } - - for (final value in statefulHookConsumerWidgetDeclarations) { - value.accept(visitor); - } - - for (final value in hookConsumerWidgetDeclarations) { - value.accept(visitor); - } - - for (final value in unknownRefInvocations) { - value.accept(visitor); - } - - for (final value in unknownWidgetRefInvocations) { - value.accept(visitor); - } - } -} - -base mixin _$RiverpodAnnotationDependency on RiverpodAst { - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitRiverpodAnnotationDependency( - this as RiverpodAnnotationDependency, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) {} -} - -base mixin _$RiverpodAnnotationDependencies on RiverpodAst { - List? get dependencies; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitRiverpodAnnotationDependencies( - this as RiverpodAnnotationDependencies, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - if (dependencies case final dependencies?) { - for (final value in dependencies) { - value.accept(visitor); - } - } - } -} - -base mixin _$RiverpodAnnotation on RiverpodAst { - RiverpodAnnotationDependencies? get dependencies; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitRiverpodAnnotation( - this as RiverpodAnnotation, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - dependencies?.accept(visitor); - } -} - -base mixin _$WidgetRefInvocation on RiverpodAst { - @override - void visitChildren(RiverpodAstVisitor visitor) {} -} - -base mixin _$WidgetRefWatchInvocation on RiverpodAst { - ProviderListenableExpression get provider; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitWidgetRefWatchInvocation( - this as WidgetRefWatchInvocation, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - provider.accept(visitor); - } -} - -base mixin _$WidgetRefReadInvocation on RiverpodAst { - ProviderListenableExpression get provider; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitWidgetRefReadInvocation( - this as WidgetRefReadInvocation, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - provider.accept(visitor); - } -} - -base mixin _$WidgetRefListenInvocation on RiverpodAst { - ProviderListenableExpression get provider; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitWidgetRefListenInvocation( - this as WidgetRefListenInvocation, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - provider.accept(visitor); - } -} - -base mixin _$WidgetRefListenManualInvocation on RiverpodAst { - ProviderListenableExpression get provider; - - @override - void accept(RiverpodAstVisitor visitor) { - visitor.visitWidgetRefListenManualInvocation( - this as WidgetRefListenManualInvocation, - ); - } - - @override - void visitChildren(RiverpodAstVisitor visitor) { - super.visitChildren(visitor); - provider.accept(visitor); - } -} - -abstract class RiverpodAstVisitor { - void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration node); - - void visitHookConsumerWidgetDeclaration(HookConsumerWidgetDeclaration node); - - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration node); - - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration node); - - void visitConsumerStateDeclaration(ConsumerStateDeclaration node); - - void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node); - - void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node); - - void visitLegacyProviderDependencies(LegacyProviderDependencies node); - - void visitLegacyProviderDependency(LegacyProviderDependency node); - - void visitLegacyProviderDeclaration(LegacyProviderDeclaration node); - - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression node); - - void visitProviderListenableExpression(ProviderListenableExpression node); - - void visitProviderOverrideExpression(ProviderOverrideExpression node); - - void visitProviderOverrideList(ProviderOverrideList node); - - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression node); - - void visitRefWatchInvocation(RefWatchInvocation node); - - void visitRefReadInvocation(RefReadInvocation node); - - void visitRefListenInvocation(RefListenInvocation node); - - void visitResolvedRiverpodLibraryResult(ResolvedRiverpodLibraryResult node); - - void visitRiverpodAnnotationDependency(RiverpodAnnotationDependency node); - - void visitRiverpodAnnotationDependencies(RiverpodAnnotationDependencies node); - - void visitRiverpodAnnotation(RiverpodAnnotation node); - - void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation node); - - void visitWidgetRefReadInvocation(WidgetRefReadInvocation node); - - void visitWidgetRefListenInvocation(WidgetRefListenInvocation node); - - void visitWidgetRefListenManualInvocation( - WidgetRefListenManualInvocation node); -} - -abstract class GeneralizingRiverpodAstVisitor implements RiverpodAstVisitor { - void visitRiverpodAst(RiverpodAst node) { - node.visitChildren(this); - } - - void visitConsumerDeclaration(ConsumerDeclaration node) {} - - @override - void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration node) { - visitConsumerDeclaration(node); - } - - @override - void visitHookConsumerWidgetDeclaration(HookConsumerWidgetDeclaration node) { - visitConsumerDeclaration(node); - } - - @override - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration node) { - visitConsumerDeclaration(node); - } - - @override - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration node) { - visitConsumerDeclaration(node); - } - - @override - void visitConsumerStateDeclaration(ConsumerStateDeclaration node) { - visitConsumerDeclaration(node); - } - - void visitGeneratorProviderDeclaration(GeneratorProviderDeclaration node) { - visitProviderDeclaration(node); - } - - @override - void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) { - visitGeneratorProviderDeclaration(node); - visitProviderDeclaration(node); - } - - @override - void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) { - visitGeneratorProviderDeclaration(node); - visitProviderDeclaration(node); - } - - @override - void visitLegacyProviderDependencies(LegacyProviderDependencies node) {} - - @override - void visitLegacyProviderDependency(LegacyProviderDependency node) { - visitProviderListenableExpressionParent(node); - } - - @override - void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) { - visitProviderDeclaration(node); - } - - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression node) {} - - void visitProviderDeclaration(ProviderDeclaration node) {} - - void visitProviderListenableExpressionParent( - ProviderListenableExpressionParent node) {} - - @override - void visitProviderListenableExpression(ProviderListenableExpression node) {} - - @override - void visitProviderOverrideExpression(ProviderOverrideExpression node) {} - - @override - void visitProviderOverrideList(ProviderOverrideList node) {} - - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression node) {} - - void visitRefInvocation(RefInvocation node) { - visitProviderListenableExpressionParent(node); - } - - void visitRefDependencyInvocation(RefDependencyInvocation node) { - visitRefInvocation(node); - visitProviderListenableExpressionParent(node); - } - - @override - void visitRefWatchInvocation(RefWatchInvocation node) { - visitRefDependencyInvocation(node); - visitRefInvocation(node); - visitProviderListenableExpressionParent(node); - } - - @override - void visitRefReadInvocation(RefReadInvocation node) { - visitRefDependencyInvocation(node); - visitRefInvocation(node); - visitProviderListenableExpressionParent(node); - } - - @override - void visitRefListenInvocation(RefListenInvocation node) { - visitRefDependencyInvocation(node); - visitRefInvocation(node); - visitProviderListenableExpressionParent(node); - } - - @override - void visitResolvedRiverpodLibraryResult(ResolvedRiverpodLibraryResult node) {} - - @override - void visitRiverpodAnnotationDependency(RiverpodAnnotationDependency node) {} - - @override - void visitRiverpodAnnotationDependencies( - RiverpodAnnotationDependencies node) {} - - @override - void visitRiverpodAnnotation(RiverpodAnnotation node) {} - - void visitWidgetRefInvocation(WidgetRefInvocation node) { - visitProviderListenableExpressionParent(node); - } - - @override - void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation node) { - visitWidgetRefInvocation(node); - visitProviderListenableExpressionParent(node); - } - - @override - void visitWidgetRefReadInvocation(WidgetRefReadInvocation node) { - visitWidgetRefInvocation(node); - visitProviderListenableExpressionParent(node); - } - - @override - void visitWidgetRefListenInvocation(WidgetRefListenInvocation node) { - visitWidgetRefInvocation(node); - visitProviderListenableExpressionParent(node); - } - - @override - void visitWidgetRefListenManualInvocation( - WidgetRefListenManualInvocation node) { - visitWidgetRefInvocation(node); - visitProviderListenableExpressionParent(node); - } -} - -abstract class RecursiveRiverpodAstVisitor implements RiverpodAstVisitor { - @override - void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration node) { - node.visitChildren(this); - } - - @override - void visitHookConsumerWidgetDeclaration(HookConsumerWidgetDeclaration node) { - node.visitChildren(this); - } - - @override - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration node) { - node.visitChildren(this); - } - - @override - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration node) { - node.visitChildren(this); - } - - @override - void visitConsumerStateDeclaration(ConsumerStateDeclaration node) { - node.visitChildren(this); - } - - @override - void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) { - node.visitChildren(this); - } - - @override - void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) { - node.visitChildren(this); - } - - @override - void visitLegacyProviderDependencies(LegacyProviderDependencies node) { - node.visitChildren(this); - } - - @override - void visitLegacyProviderDependency(LegacyProviderDependency node) { - node.visitChildren(this); - } - - @override - void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) { - node.visitChildren(this); - } - - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression node) { - node.visitChildren(this); - } - - @override - void visitProviderListenableExpression(ProviderListenableExpression node) { - node.visitChildren(this); - } - - @override - void visitProviderOverrideExpression(ProviderOverrideExpression node) { - node.visitChildren(this); - } - - @override - void visitProviderOverrideList(ProviderOverrideList node) { - node.visitChildren(this); - } - - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression node) { - node.visitChildren(this); - } - - @override - void visitRefWatchInvocation(RefWatchInvocation node) { - node.visitChildren(this); - } - - @override - void visitRefReadInvocation(RefReadInvocation node) { - node.visitChildren(this); - } - - @override - void visitRefListenInvocation(RefListenInvocation node) { - node.visitChildren(this); - } - - @override - void visitResolvedRiverpodLibraryResult(ResolvedRiverpodLibraryResult node) { - node.visitChildren(this); - } - - @override - void visitRiverpodAnnotationDependency(RiverpodAnnotationDependency node) { - node.visitChildren(this); - } - - @override - void visitRiverpodAnnotationDependencies( - RiverpodAnnotationDependencies node) { - node.visitChildren(this); - } - - @override - void visitRiverpodAnnotation(RiverpodAnnotation node) { - node.visitChildren(this); - } - - @override - void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation node) { - node.visitChildren(this); - } - - @override - void visitWidgetRefReadInvocation(WidgetRefReadInvocation node) { - node.visitChildren(this); - } - - @override - void visitWidgetRefListenInvocation(WidgetRefListenInvocation node) { - node.visitChildren(this); - } - - @override - void visitWidgetRefListenManualInvocation( - WidgetRefListenManualInvocation node) { - node.visitChildren(this); - } -} - -abstract class SimpleRiverpodAstVisitor implements RiverpodAstVisitor { - @override - void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration node) {} - - @override - void visitHookConsumerWidgetDeclaration(HookConsumerWidgetDeclaration node) {} - - @override - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration node) {} - - @override - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration node) {} - - @override - void visitConsumerStateDeclaration(ConsumerStateDeclaration node) {} - - @override - void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) {} - - @override - void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) {} - - @override - void visitLegacyProviderDependencies(LegacyProviderDependencies node) {} - - @override - void visitLegacyProviderDependency(LegacyProviderDependency node) {} - - @override - void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) {} - - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression node) {} - - @override - void visitProviderListenableExpression(ProviderListenableExpression node) {} - - @override - void visitProviderOverrideExpression(ProviderOverrideExpression node) {} - - @override - void visitProviderOverrideList(ProviderOverrideList node) {} - - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression node) {} - - @override - void visitRefWatchInvocation(RefWatchInvocation node) {} - - @override - void visitRefReadInvocation(RefReadInvocation node) {} - - @override - void visitRefListenInvocation(RefListenInvocation node) {} - - @override - void visitResolvedRiverpodLibraryResult(ResolvedRiverpodLibraryResult node) {} - - @override - void visitRiverpodAnnotationDependency(RiverpodAnnotationDependency node) {} - - @override - void visitRiverpodAnnotationDependencies( - RiverpodAnnotationDependencies node) {} - - @override - void visitRiverpodAnnotation(RiverpodAnnotation node) {} - - @override - void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation node) {} - - @override - void visitWidgetRefReadInvocation(WidgetRefReadInvocation node) {} - - @override - void visitWidgetRefListenInvocation(WidgetRefListenInvocation node) {} - - @override - void visitWidgetRefListenManualInvocation( - WidgetRefListenManualInvocation node) {} -} - -abstract class UnimplementedRiverpodAstVisitor implements RiverpodAstVisitor { - @override - void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration node) { - throw UnimplementedError(); - } - - @override - void visitHookConsumerWidgetDeclaration(HookConsumerWidgetDeclaration node) { - throw UnimplementedError(); - } - - @override - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration node) { - throw UnimplementedError(); - } - - @override - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration node) { - throw UnimplementedError(); - } - - @override - void visitConsumerStateDeclaration(ConsumerStateDeclaration node) { - throw UnimplementedError(); - } - - @override - void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) { - throw UnimplementedError(); - } - - @override - void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) { - throw UnimplementedError(); - } - - @override - void visitLegacyProviderDependencies(LegacyProviderDependencies node) { - throw UnimplementedError(); - } - - @override - void visitLegacyProviderDependency(LegacyProviderDependency node) { - throw UnimplementedError(); - } - - @override - void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) { - throw UnimplementedError(); - } - - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression node) { - throw UnimplementedError(); - } - - @override - void visitProviderListenableExpression(ProviderListenableExpression node) { - throw UnimplementedError(); - } - - @override - void visitProviderOverrideExpression(ProviderOverrideExpression node) { - throw UnimplementedError(); - } - - @override - void visitProviderOverrideList(ProviderOverrideList node) { - throw UnimplementedError(); - } - - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression node) { - throw UnimplementedError(); - } - - @override - void visitRefWatchInvocation(RefWatchInvocation node) { - throw UnimplementedError(); - } - - @override - void visitRefReadInvocation(RefReadInvocation node) { - throw UnimplementedError(); - } - - @override - void visitRefListenInvocation(RefListenInvocation node) { - throw UnimplementedError(); - } - - @override - void visitResolvedRiverpodLibraryResult(ResolvedRiverpodLibraryResult node) { - throw UnimplementedError(); - } - - @override - void visitRiverpodAnnotationDependency(RiverpodAnnotationDependency node) { - throw UnimplementedError(); - } - - @override - void visitRiverpodAnnotationDependencies( - RiverpodAnnotationDependencies node) { - throw UnimplementedError(); - } - - @override - void visitRiverpodAnnotation(RiverpodAnnotation node) { - throw UnimplementedError(); - } - - @override - void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation node) { - throw UnimplementedError(); - } - - @override - void visitWidgetRefReadInvocation(WidgetRefReadInvocation node) { - throw UnimplementedError(); - } - - @override - void visitWidgetRefListenInvocation(WidgetRefListenInvocation node) { - throw UnimplementedError(); - } - - @override - void visitWidgetRefListenManualInvocation( - WidgetRefListenManualInvocation node) { - throw UnimplementedError(); - } -} - -@internal -class RiverpodAnalysisResult extends GeneralizingRiverpodAstVisitor { - final consumerDeclarations = []; - @override - void visitConsumerDeclaration( - ConsumerDeclaration node, - ) { - super.visitConsumerDeclaration(node); - consumerDeclarations.add(node); - } - - final consumerWidgetDeclarations = []; - @override - void visitConsumerWidgetDeclaration( - ConsumerWidgetDeclaration node, - ) { - super.visitConsumerWidgetDeclaration(node); - consumerWidgetDeclarations.add(node); - } - - final hookConsumerWidgetDeclarations = []; - @override - void visitHookConsumerWidgetDeclaration( - HookConsumerWidgetDeclaration node, - ) { - super.visitHookConsumerWidgetDeclaration(node); - hookConsumerWidgetDeclarations.add(node); - } - - final consumerStatefulWidgetDeclarations = - []; - @override - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration node, - ) { - super.visitConsumerStatefulWidgetDeclaration(node); - consumerStatefulWidgetDeclarations.add(node); - } - - final statefulHookConsumerWidgetDeclarations = - []; - @override - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration node, - ) { - super.visitStatefulHookConsumerWidgetDeclaration(node); - statefulHookConsumerWidgetDeclarations.add(node); - } - - final consumerStateDeclarations = []; - @override - void visitConsumerStateDeclaration( - ConsumerStateDeclaration node, - ) { - super.visitConsumerStateDeclaration(node); - consumerStateDeclarations.add(node); - } - - final generatorProviderDeclarations = []; - @override - void visitGeneratorProviderDeclaration( - GeneratorProviderDeclaration node, - ) { - super.visitGeneratorProviderDeclaration(node); - generatorProviderDeclarations.add(node); - } - - final classBasedProviderDeclarations = []; - @override - void visitClassBasedProviderDeclaration( - ClassBasedProviderDeclaration node, - ) { - super.visitClassBasedProviderDeclaration(node); - classBasedProviderDeclarations.add(node); - } - - final functionalProviderDeclarations = []; - @override - void visitFunctionalProviderDeclaration( - FunctionalProviderDeclaration node, - ) { - super.visitFunctionalProviderDeclaration(node); - functionalProviderDeclarations.add(node); - } - - final legacyProviderDependenciess = []; - @override - void visitLegacyProviderDependencies( - LegacyProviderDependencies node, - ) { - super.visitLegacyProviderDependencies(node); - legacyProviderDependenciess.add(node); - } - - final legacyProviderDependencys = []; - @override - void visitLegacyProviderDependency( - LegacyProviderDependency node, - ) { - super.visitLegacyProviderDependency(node); - legacyProviderDependencys.add(node); - } - - final legacyProviderDeclarations = []; - @override - void visitLegacyProviderDeclaration( - LegacyProviderDeclaration node, - ) { - super.visitLegacyProviderDeclaration(node); - legacyProviderDeclarations.add(node); - } - - final providerContainerInstanceCreationExpressions = - []; - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression node, - ) { - super.visitProviderContainerInstanceCreationExpression(node); - providerContainerInstanceCreationExpressions.add(node); - } - - final providerDeclarations = []; - @override - void visitProviderDeclaration( - ProviderDeclaration node, - ) { - super.visitProviderDeclaration(node); - providerDeclarations.add(node); - } - - final providerListenableExpressionParents = - []; - @override - void visitProviderListenableExpressionParent( - ProviderListenableExpressionParent node, - ) { - super.visitProviderListenableExpressionParent(node); - providerListenableExpressionParents.add(node); - } - - final providerListenableExpressions = []; - @override - void visitProviderListenableExpression( - ProviderListenableExpression node, - ) { - super.visitProviderListenableExpression(node); - providerListenableExpressions.add(node); - } - - final providerOverrideExpressions = []; - @override - void visitProviderOverrideExpression( - ProviderOverrideExpression node, - ) { - super.visitProviderOverrideExpression(node); - providerOverrideExpressions.add(node); - } - - final providerOverrideLists = []; - @override - void visitProviderOverrideList( - ProviderOverrideList node, - ) { - super.visitProviderOverrideList(node); - providerOverrideLists.add(node); - } - - final providerScopeInstanceCreationExpressions = - []; - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression node, - ) { - super.visitProviderScopeInstanceCreationExpression(node); - providerScopeInstanceCreationExpressions.add(node); - } - - final refInvocations = []; - @override - void visitRefInvocation( - RefInvocation node, - ) { - super.visitRefInvocation(node); - refInvocations.add(node); - } - - final refDependencyInvocations = []; - @override - void visitRefDependencyInvocation( - RefDependencyInvocation node, - ) { - super.visitRefDependencyInvocation(node); - refDependencyInvocations.add(node); - } - - final refWatchInvocations = []; - @override - void visitRefWatchInvocation( - RefWatchInvocation node, - ) { - super.visitRefWatchInvocation(node); - refWatchInvocations.add(node); - } - - final refReadInvocations = []; - @override - void visitRefReadInvocation( - RefReadInvocation node, - ) { - super.visitRefReadInvocation(node); - refReadInvocations.add(node); - } - - final refListenInvocations = []; - @override - void visitRefListenInvocation( - RefListenInvocation node, - ) { - super.visitRefListenInvocation(node); - refListenInvocations.add(node); - } - - final resolvedRiverpodLibraryResults = []; - @override - void visitResolvedRiverpodLibraryResult( - ResolvedRiverpodLibraryResult node, - ) { - super.visitResolvedRiverpodLibraryResult(node); - resolvedRiverpodLibraryResults.add(node); - } - - final riverpodAnnotationDependencys = []; - @override - void visitRiverpodAnnotationDependency( - RiverpodAnnotationDependency node, - ) { - super.visitRiverpodAnnotationDependency(node); - riverpodAnnotationDependencys.add(node); - } - - final riverpodAnnotationDependenciess = []; - @override - void visitRiverpodAnnotationDependencies( - RiverpodAnnotationDependencies node, - ) { - super.visitRiverpodAnnotationDependencies(node); - riverpodAnnotationDependenciess.add(node); - } - - final riverpodAnnotations = []; - @override - void visitRiverpodAnnotation( - RiverpodAnnotation node, - ) { - super.visitRiverpodAnnotation(node); - riverpodAnnotations.add(node); - } - - final widgetRefInvocations = []; - @override - void visitWidgetRefInvocation( - WidgetRefInvocation node, - ) { - super.visitWidgetRefInvocation(node); - widgetRefInvocations.add(node); - } - - final widgetRefWatchInvocations = []; - @override - void visitWidgetRefWatchInvocation( - WidgetRefWatchInvocation node, - ) { - super.visitWidgetRefWatchInvocation(node); - widgetRefWatchInvocations.add(node); - } - - final widgetRefReadInvocations = []; - @override - void visitWidgetRefReadInvocation( - WidgetRefReadInvocation node, - ) { - super.visitWidgetRefReadInvocation(node); - widgetRefReadInvocations.add(node); - } - - final widgetRefListenInvocations = []; - @override - void visitWidgetRefListenInvocation( - WidgetRefListenInvocation node, - ) { - super.visitWidgetRefListenInvocation(node); - widgetRefListenInvocations.add(node); - } - - final widgetRefListenManualInvocations = []; - @override - void visitWidgetRefListenManualInvocation( - WidgetRefListenManualInvocation node, - ) { - super.visitWidgetRefListenManualInvocation(node); - widgetRefListenManualInvocations.add(node); - } -} - -class _RiverpodAstRegistryVisitor extends GeneralizingRiverpodAstVisitor { - _RiverpodAstRegistryVisitor(this._registry); - - final RiverpodAstRegistry _registry; - - void _runSubscriptions( - R value, - List subscriptions, - ) { - for (final sub in subscriptions) { - try { - sub(value); - } catch (e, stack) { - Zone.current.handleUncaughtError(e, stack); - } - } - } - - @override - void visitRiverpodAst(RiverpodAst node) { - node.visitChildren(this); - } - - @override - void visitConsumerDeclaration(ConsumerDeclaration node) { - super.visitConsumerDeclaration(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onConsumerDeclaration, - ); - } - - @override - void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration node) { - super.visitConsumerWidgetDeclaration(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onConsumerWidgetDeclaration, - ); - } - - @override - void visitHookConsumerWidgetDeclaration(HookConsumerWidgetDeclaration node) { - super.visitHookConsumerWidgetDeclaration(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onHookConsumerWidgetDeclaration, - ); - } - - @override - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration node) { - super.visitConsumerStatefulWidgetDeclaration(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onConsumerStatefulWidgetDeclaration, - ); - } - - @override - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration node) { - super.visitStatefulHookConsumerWidgetDeclaration(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onStatefulHookConsumerWidgetDeclaration, - ); - } - - @override - void visitConsumerStateDeclaration(ConsumerStateDeclaration node) { - super.visitConsumerStateDeclaration(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onConsumerStateDeclaration, - ); - } - - @override - void visitGeneratorProviderDeclaration(GeneratorProviderDeclaration node) { - super.visitGeneratorProviderDeclaration(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onGeneratorProviderDeclaration, - ); - } - - @override - void visitClassBasedProviderDeclaration(ClassBasedProviderDeclaration node) { - super.visitClassBasedProviderDeclaration(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onClassBasedProviderDeclaration, - ); - } - - @override - void visitFunctionalProviderDeclaration(FunctionalProviderDeclaration node) { - super.visitFunctionalProviderDeclaration(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onFunctionalProviderDeclaration, - ); - } - - @override - void visitLegacyProviderDependencies(LegacyProviderDependencies node) { - super.visitLegacyProviderDependencies(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onLegacyProviderDependencies, - ); - } - - @override - void visitLegacyProviderDependency(LegacyProviderDependency node) { - super.visitLegacyProviderDependency(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onLegacyProviderDependency, - ); - } - - @override - void visitLegacyProviderDeclaration(LegacyProviderDeclaration node) { - super.visitLegacyProviderDeclaration(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onLegacyProviderDeclaration, - ); - } - - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression node) { - super.visitProviderContainerInstanceCreationExpression(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onProviderContainerInstanceCreationExpression, - ); - } - - @override - void visitProviderDeclaration(ProviderDeclaration node) { - super.visitProviderDeclaration(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onProviderDeclaration, - ); - } - - @override - void visitProviderListenableExpressionParent( - ProviderListenableExpressionParent node) { - super.visitProviderListenableExpressionParent(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onProviderListenableExpressionParent, - ); - } - - @override - void visitProviderListenableExpression(ProviderListenableExpression node) { - super.visitProviderListenableExpression(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onProviderListenableExpression, - ); - } - - @override - void visitProviderOverrideExpression(ProviderOverrideExpression node) { - super.visitProviderOverrideExpression(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onProviderOverrideExpression, - ); - } - - @override - void visitProviderOverrideList(ProviderOverrideList node) { - super.visitProviderOverrideList(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onProviderOverrideList, - ); - } - - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression node) { - super.visitProviderScopeInstanceCreationExpression(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onProviderScopeInstanceCreationExpression, - ); - } - - @override - void visitRefInvocation(RefInvocation node) { - super.visitRefInvocation(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onRefInvocation, - ); - } - - @override - void visitRefDependencyInvocation(RefDependencyInvocation node) { - super.visitRefDependencyInvocation(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onRefDependencyInvocation, - ); - } - - @override - void visitRefWatchInvocation(RefWatchInvocation node) { - super.visitRefWatchInvocation(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onRefWatchInvocation, - ); - } - - @override - void visitRefReadInvocation(RefReadInvocation node) { - super.visitRefReadInvocation(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onRefReadInvocation, - ); - } - - @override - void visitRefListenInvocation(RefListenInvocation node) { - super.visitRefListenInvocation(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onRefListenInvocation, - ); - } - - @override - void visitResolvedRiverpodLibraryResult(ResolvedRiverpodLibraryResult node) { - super.visitResolvedRiverpodLibraryResult(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onResolvedRiverpodLibraryResult, - ); - } - - @override - void visitRiverpodAnnotationDependency(RiverpodAnnotationDependency node) { - super.visitRiverpodAnnotationDependency(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onRiverpodAnnotationDependency, - ); - } - - @override - void visitRiverpodAnnotationDependencies( - RiverpodAnnotationDependencies node) { - super.visitRiverpodAnnotationDependencies(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onRiverpodAnnotationDependencies, - ); - } - - @override - void visitRiverpodAnnotation(RiverpodAnnotation node) { - super.visitRiverpodAnnotation(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onRiverpodAnnotation, - ); - } - - @override - void visitWidgetRefInvocation(WidgetRefInvocation node) { - super.visitWidgetRefInvocation(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onWidgetRefInvocation, - ); - } - - @override - void visitWidgetRefWatchInvocation(WidgetRefWatchInvocation node) { - super.visitWidgetRefWatchInvocation(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onWidgetRefWatchInvocation, - ); - } - - @override - void visitWidgetRefReadInvocation(WidgetRefReadInvocation node) { - super.visitWidgetRefReadInvocation(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onWidgetRefReadInvocation, - ); - } - - @override - void visitWidgetRefListenInvocation(WidgetRefListenInvocation node) { - super.visitWidgetRefListenInvocation(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onWidgetRefListenInvocation, - ); - } - - @override - void visitWidgetRefListenManualInvocation( - WidgetRefListenManualInvocation node) { - super.visitWidgetRefListenManualInvocation(node); - node.visitChildren(this); - _runSubscriptions( - node, - _registry._onWidgetRefListenManualInvocation, - ); - } -} - -class RiverpodAstRegistry { - void run(RiverpodAst node) { - node.accept(_RiverpodAstRegistryVisitor(this)); - } - - final _onRiverpodAst = []; - void addRiverpodAst(void Function(RiverpodAst node) cb) { - _onRiverpodAst.add(cb); - } - - final _onConsumerDeclaration = []; - void addConsumerDeclaration(void Function(ConsumerDeclaration node) cb) { - _onConsumerDeclaration.add(cb); - } - - final _onConsumerWidgetDeclaration = - []; - void addConsumerWidgetDeclaration( - void Function(ConsumerWidgetDeclaration node) cb) { - _onConsumerWidgetDeclaration.add(cb); - } - - final _onHookConsumerWidgetDeclaration = - []; - void addHookConsumerWidgetDeclaration( - void Function(HookConsumerWidgetDeclaration node) cb) { - _onHookConsumerWidgetDeclaration.add(cb); - } - - final _onConsumerStatefulWidgetDeclaration = - []; - void addConsumerStatefulWidgetDeclaration( - void Function(ConsumerStatefulWidgetDeclaration node) cb) { - _onConsumerStatefulWidgetDeclaration.add(cb); - } - - final _onStatefulHookConsumerWidgetDeclaration = - []; - void addStatefulHookConsumerWidgetDeclaration( - void Function(StatefulHookConsumerWidgetDeclaration node) cb) { - _onStatefulHookConsumerWidgetDeclaration.add(cb); - } - - final _onConsumerStateDeclaration = - []; - void addConsumerStateDeclaration( - void Function(ConsumerStateDeclaration node) cb) { - _onConsumerStateDeclaration.add(cb); - } - - final _onGeneratorProviderDeclaration = - []; - void addGeneratorProviderDeclaration( - void Function(GeneratorProviderDeclaration node) cb) { - _onGeneratorProviderDeclaration.add(cb); - } - - final _onClassBasedProviderDeclaration = - []; - void addClassBasedProviderDeclaration( - void Function(ClassBasedProviderDeclaration node) cb) { - _onClassBasedProviderDeclaration.add(cb); - } - - final _onFunctionalProviderDeclaration = - []; - void addFunctionalProviderDeclaration( - void Function(FunctionalProviderDeclaration node) cb) { - _onFunctionalProviderDeclaration.add(cb); - } - - final _onLegacyProviderDependencies = - []; - void addLegacyProviderDependencies( - void Function(LegacyProviderDependencies node) cb) { - _onLegacyProviderDependencies.add(cb); - } - - final _onLegacyProviderDependency = - []; - void addLegacyProviderDependency( - void Function(LegacyProviderDependency node) cb) { - _onLegacyProviderDependency.add(cb); - } - - final _onLegacyProviderDeclaration = - []; - void addLegacyProviderDeclaration( - void Function(LegacyProviderDeclaration node) cb) { - _onLegacyProviderDeclaration.add(cb); - } - - final _onProviderContainerInstanceCreationExpression = - []; - void addProviderContainerInstanceCreationExpression( - void Function(ProviderContainerInstanceCreationExpression node) cb) { - _onProviderContainerInstanceCreationExpression.add(cb); - } - - final _onProviderDeclaration = []; - void addProviderDeclaration(void Function(ProviderDeclaration node) cb) { - _onProviderDeclaration.add(cb); - } - - final _onProviderListenableExpressionParent = - []; - void addProviderListenableExpressionParent( - void Function(ProviderListenableExpressionParent node) cb) { - _onProviderListenableExpressionParent.add(cb); - } - - final _onProviderListenableExpression = - []; - void addProviderListenableExpression( - void Function(ProviderListenableExpression node) cb) { - _onProviderListenableExpression.add(cb); - } - - final _onProviderOverrideExpression = - []; - void addProviderOverrideExpression( - void Function(ProviderOverrideExpression node) cb) { - _onProviderOverrideExpression.add(cb); - } - - final _onProviderOverrideList = []; - void addProviderOverrideList(void Function(ProviderOverrideList node) cb) { - _onProviderOverrideList.add(cb); - } - - final _onProviderScopeInstanceCreationExpression = - []; - void addProviderScopeInstanceCreationExpression( - void Function(ProviderScopeInstanceCreationExpression node) cb) { - _onProviderScopeInstanceCreationExpression.add(cb); - } - - final _onRefInvocation = []; - void addRefInvocation(void Function(RefInvocation node) cb) { - _onRefInvocation.add(cb); - } - - final _onRefDependencyInvocation = []; - void addRefDependencyInvocation( - void Function(RefDependencyInvocation node) cb) { - _onRefDependencyInvocation.add(cb); - } - - final _onRefWatchInvocation = []; - void addRefWatchInvocation(void Function(RefWatchInvocation node) cb) { - _onRefWatchInvocation.add(cb); - } - - final _onRefReadInvocation = []; - void addRefReadInvocation(void Function(RefReadInvocation node) cb) { - _onRefReadInvocation.add(cb); - } - - final _onRefListenInvocation = []; - void addRefListenInvocation(void Function(RefListenInvocation node) cb) { - _onRefListenInvocation.add(cb); - } - - final _onResolvedRiverpodLibraryResult = - []; - void addResolvedRiverpodLibraryResult( - void Function(ResolvedRiverpodLibraryResult node) cb) { - _onResolvedRiverpodLibraryResult.add(cb); - } - - final _onRiverpodAnnotationDependency = - []; - void addRiverpodAnnotationDependency( - void Function(RiverpodAnnotationDependency node) cb) { - _onRiverpodAnnotationDependency.add(cb); - } - - final _onRiverpodAnnotationDependencies = - []; - void addRiverpodAnnotationDependencies( - void Function(RiverpodAnnotationDependencies node) cb) { - _onRiverpodAnnotationDependencies.add(cb); - } - - final _onRiverpodAnnotation = []; - void addRiverpodAnnotation(void Function(RiverpodAnnotation node) cb) { - _onRiverpodAnnotation.add(cb); - } - - final _onWidgetRefInvocation = []; - void addWidgetRefInvocation(void Function(WidgetRefInvocation node) cb) { - _onWidgetRefInvocation.add(cb); - } - - final _onWidgetRefWatchInvocation = - []; - void addWidgetRefWatchInvocation( - void Function(WidgetRefWatchInvocation node) cb) { - _onWidgetRefWatchInvocation.add(cb); - } - - final _onWidgetRefReadInvocation = []; - void addWidgetRefReadInvocation( - void Function(WidgetRefReadInvocation node) cb) { - _onWidgetRefReadInvocation.add(cb); - } - - final _onWidgetRefListenInvocation = - []; - void addWidgetRefListenInvocation( - void Function(WidgetRefListenInvocation node) cb) { - _onWidgetRefListenInvocation.add(cb); - } - - final _onWidgetRefListenManualInvocation = - []; - void addWidgetRefListenManualInvocation( - void Function(WidgetRefListenManualInvocation node) cb) { - _onWidgetRefListenManualInvocation.add(cb); - } -} - -// ignore_for_file: type=lint diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/consumer.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/consumer.dart deleted file mode 100644 index 1ac965869..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/consumer.dart +++ /dev/null @@ -1,214 +0,0 @@ -part of '../riverpod_ast.dart'; - -abstract base class ConsumerDeclaration extends RiverpodAst - with _$ConsumerDeclaration { - static ConsumerDeclaration? _parse( - ClassDeclaration node, - _ParseRefInvocationMixin parent, - ) { - final extendsClause = node.extendsClause; - if (extendsClause == null) return null; - final extendsType = extendsClause.superclass.type; - if (extendsType == null) return null; - - if (consumerWidgetType.isExactlyType(extendsType)) { - return ConsumerWidgetDeclaration._parse(node, parent); - } else if (hookConsumerWidgetType.isExactlyType(extendsType)) { - return HookConsumerWidgetDeclaration._parse(node, parent); - } else if (consumerStatefulWidgetType.isExactlyType(extendsType)) { - return ConsumerStatefulWidgetDeclaration.parse(node); - } else if (statefulHookConsumerStateType.isExactlyType(extendsType)) { - return StatefulHookConsumerWidgetDeclaration.parse(node); - } else if (consumerStateType.isExactlyType(extendsType)) { - return ConsumerStateDeclaration._parse(node, parent); - } - - return null; - } - - ClassDeclaration get node; -} - -final class ConsumerWidgetDeclaration extends ConsumerDeclaration - with _$ConsumerWidgetDeclaration { - ConsumerWidgetDeclaration._({ - required this.buildMethod, - required this.node, - }); - - static ConsumerWidgetDeclaration? _parse( - ClassDeclaration node, - _ParseRefInvocationMixin parent, - ) { - final buildMethod = node.members - .whereType() - .firstWhereOrNull((e) => e.name.lexeme == 'build'); - - final consumerWidgetDeclaration = ConsumerWidgetDeclaration._( - buildMethod: buildMethod, - node: node, - ); - final visitor = _ParseConsumerRefInvocationVisitor( - consumerWidgetDeclaration, - consumerWidgetDeclaration.widgetRefInvocations, - consumerWidgetDeclaration.providerScopeInstanceCreateExpressions, - parent, - ); - - buildMethod?.accept(visitor); - - return consumerWidgetDeclaration; - } - - final MethodDeclaration? buildMethod; - @override - final List widgetRefInvocations = []; - @override - final List - providerScopeInstanceCreateExpressions = []; - - @override - final ClassDeclaration node; -} - -class _ParseConsumerRefInvocationVisitor extends RecursiveAstVisitor - with _ParseRefInvocationMixin { - _ParseConsumerRefInvocationVisitor( - this.parent, - this.widgetRefInvocations, - this.providerScopeInstanceCreateExpressions, - this.parentVisitor, - ); - - final RiverpodAst parent; - final List widgetRefInvocations; - final List - providerScopeInstanceCreateExpressions; - - final _ParseRefInvocationMixin parentVisitor; - - @override - void visitRefInvocation(RefInvocation invocation) { - parentVisitor.visitRefInvocation(invocation); - } - - @override - void visitWidgetRefInvocation(WidgetRefInvocation invocation) { - widgetRefInvocations.add(invocation); - invocation._parent = parent; - } - - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression expression, - ) { - parentVisitor.visitProviderContainerInstanceCreationExpression(expression); - } - - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression expression, - ) { - providerScopeInstanceCreateExpressions.add(expression); - expression._parent = parent; - } -} - -final class HookConsumerWidgetDeclaration extends ConsumerDeclaration - with _$HookConsumerWidgetDeclaration { - HookConsumerWidgetDeclaration({ - required this.buildMethod, - required this.node, - }); - - static HookConsumerWidgetDeclaration? _parse( - ClassDeclaration node, - _ParseRefInvocationMixin parent, - ) { - final buildMethod = node.members - .whereType() - .firstWhereOrNull((e) => e.name.lexeme == 'build'); - - final consumerWidgetDeclaration = HookConsumerWidgetDeclaration( - buildMethod: buildMethod, - node: node, - ); - final visitor = _ParseConsumerRefInvocationVisitor( - consumerWidgetDeclaration, - consumerWidgetDeclaration.widgetRefInvocations, - consumerWidgetDeclaration.providerScopeInstanceCreateExpressions, - parent, - ); - - buildMethod?.accept(visitor); - - return consumerWidgetDeclaration; - } - - final MethodDeclaration? buildMethod; - @override - final List widgetRefInvocations = []; - @override - final List - providerScopeInstanceCreateExpressions = []; - - @override - final ClassDeclaration node; -} - -final class ConsumerStatefulWidgetDeclaration extends ConsumerDeclaration - with _$ConsumerStatefulWidgetDeclaration { - ConsumerStatefulWidgetDeclaration._({required this.node}); - - ConsumerStatefulWidgetDeclaration.parse(ClassDeclaration node) - : this._(node: node); - - @override - final ClassDeclaration node; -} - -final class StatefulHookConsumerWidgetDeclaration extends ConsumerDeclaration - with _$StatefulHookConsumerWidgetDeclaration { - StatefulHookConsumerWidgetDeclaration._({required this.node}); - - StatefulHookConsumerWidgetDeclaration.parse(ClassDeclaration node) - : this._(node: node); - - @override - final ClassDeclaration node; -} - -final class ConsumerStateDeclaration extends ConsumerDeclaration - with _$ConsumerStateDeclaration { - ConsumerStateDeclaration._({ - required this.node, - }); - - static ConsumerStateDeclaration? _parse( - ClassDeclaration node, - _ParseRefInvocationMixin parent, - ) { - final consumerWidgetDeclaration = ConsumerStateDeclaration._( - node: node, - ); - final visitor = _ParseConsumerRefInvocationVisitor( - consumerWidgetDeclaration, - consumerWidgetDeclaration.widgetRefInvocations, - consumerWidgetDeclaration.providerScopeInstanceCreateExpressions, - parent, - ); - - node.accept(visitor); - - return consumerWidgetDeclaration; - } - - @override - final List widgetRefInvocations = []; - @override - final List - providerScopeInstanceCreateExpressions = []; - - @override - final ClassDeclaration node; -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart deleted file mode 100644 index f91f60353..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/generator_provider_declaration.dart +++ /dev/null @@ -1,413 +0,0 @@ -part of '../riverpod_ast.dart'; - -extension RawTypeX on DartType { - /// Returns whether this type is a `Raw` typedef from `package:riverpod_annotation`. - bool get isRaw { - final alias = this.alias; - if (alias == null) return false; - return alias.element.name == 'Raw' && - isFromRiverpodAnnotation.isExactly(alias.element); - } -} - -extension on LibraryElement { - static final _asyncValueCache = Expando(); - - Element? findElementWithNameFromPackage( - String name, { - required String packageName, - }) { - return library.importedLibraries - .map((e) => e.exportNamespace.get(name)) - .firstWhereOrNull( - // TODO find a way to test this - (element) => element != null && isFromRiverpod.isExactly(element), - ); - } - - ClassElement? findAsyncValue() { - final cache = _asyncValueCache[this]; - if (cache != null) return cache; - - final result = findElementWithNameFromPackage( - 'AsyncValue', - packageName: 'riverpod', - ); - if (result == null) { - errorReporter?.call( - RiverpodAnalysisError( - 'No AsyncValue accessible in the library. ' - 'Did you forget to import Riverpod?', - targetElement: this, - code: null, - ), - ); - return null; - } - - return _asyncValueCache[this] = result as ClassElement?; - } - - DartType? createdTypeToValueType(DartType? typeArg) { - final asyncValue = findAsyncValue(); - - return asyncValue?.instantiate( - typeArguments: [if (typeArg != null) typeArg], - nullabilitySuffix: NullabilitySuffix.none, - ); - } -} - -// TODO changelog made sealed -sealed class GeneratorProviderDeclaration extends ProviderDeclaration - with _$GeneratorProviderDeclaration { - @override - GeneratorProviderDeclarationElement get providerElement; - @override - RiverpodAnnotation get annotation; - - String get valueTypeDisplayString => valueTypeNode?.toSource() ?? 'Object?'; - String get exposedTypeDisplayString => exposedTypeNode?.source ?? 'Object?'; - String get createdTypeDisplayString { - final type = createdTypeNode?.type; - - if (type != null && - !type.isRaw && - (type.isDartAsyncFuture || type.isDartAsyncFutureOr)) { - return 'FutureOr<$valueTypeDisplayString>'; - } - - return createdTypeNode?.toSource() ?? 'Object?'; - } - - TypeAnnotation? get valueTypeNode; - SourcedType? get exposedTypeNode; - TypeAnnotation? get createdTypeNode; - - @override - final List refInvocations = []; - - String computeProviderHash() { - // TODO improve hash function to inspect the body of the create fn - // such that the hash changes if one of the element defined outside of the - // fn changes. - final bytes = utf8.encode(node.toSource()); - final digest = sha1.convert(bytes); - return digest.toString(); - } -} - -SourcedType? _computeExposedType( - TypeAnnotation? createdType, - LibraryElement library, -) { - if (createdType == null) { - return ( - source: null, - dartType: library.typeProvider.dynamicType, - ); - } - - final createdDartType = createdType.type!; - if (createdDartType.isRaw) { - return ( - source: createdType.toSource(), - dartType: createdType.type!, - ); - } - - if (createdDartType.isDartAsyncFuture || - createdDartType.isDartAsyncFutureOr || - createdDartType.isDartAsyncStream) { - createdType as NamedType; - createdDartType as InterfaceType; - - final typeSource = createdType.toSource(); - if (typeSource != 'Future' && - typeSource != 'FutureOr' && - typeSource != 'Stream' && - !typeSource.startsWith('Future<') && - !typeSource.startsWith('FutureOr<') && - !typeSource.startsWith('Stream<')) { - throw UnsupportedError( - 'Returning a typedef of type Future/FutureOr/Stream is not supported\n' - 'The code that triggered this error is: $typeSource', - ); - } - - final valueTypeArg = createdType.typeArguments?.arguments.firstOrNull; - - final exposedDartType = - library.createdTypeToValueType(createdDartType.typeArguments.first); - if (exposedDartType == null) return null; - - return ( - source: valueTypeArg == null ? 'AsyncValue' : 'AsyncValue<$valueTypeArg>', - dartType: exposedDartType, - ); - } - - return ( - source: createdType.toSource(), - dartType: createdType.type!, - ); -} - -TypeAnnotation? _getValueType( - TypeAnnotation? createdType, - LibraryElement library, -) { - if (createdType == null) return null; - final dartType = createdType.type!; - if (dartType.isRaw) return createdType; - - if (dartType.isDartAsyncFuture || - dartType.isDartAsyncFutureOr || - dartType.isDartAsyncStream) { - createdType as NamedType; - - return createdType.typeArguments?.arguments.firstOrNull; - } - - return createdType; -} - -typedef SourcedType = ({String? source, DartType dartType}); - -final class ClassBasedProviderDeclaration extends GeneratorProviderDeclaration - with _$ClassBasedProviderDeclaration { - ClassBasedProviderDeclaration._({ - required this.name, - required this.node, - required this.buildMethod, - required this.providerElement, - required this.annotation, - required this.createdTypeNode, - required this.exposedTypeNode, - required this.valueTypeNode, - }); - - static ClassBasedProviderDeclaration? _parse( - ClassDeclaration node, - _ParseRefInvocationMixin parent, - ) { - final element = node.declaredElement; - if (element == null) return null; - final riverpodAnnotation = RiverpodAnnotation._parse(node); - if (riverpodAnnotation == null) return null; - - // TODO changelog report error if abstract - if (node.abstractKeyword != null) { - errorReporter?.call( - RiverpodAnalysisError( - 'Classes annotated with @riverpod cannot be abstract.', - targetNode: node, - targetElement: node.declaredElement, - code: RiverpodAnalysisErrorCode.abstractNotifier, - ), - ); - } - - final constructors = - node.members.whereType().toList(); - final defaultConstructor = constructors - .firstWhereOrNull((constructor) => constructor.name == null); - if (defaultConstructor == null && constructors.isNotEmpty) { - errorReporter?.call( - RiverpodAnalysisError( - 'Classes annotated with @riverpod must have a default constructor.', - targetNode: node, - targetElement: node.declaredElement, - code: RiverpodAnalysisErrorCode.missingNotifierDefaultConstructor, - ), - ); - } - // TODO changelog report error if default constructor is missing - if (defaultConstructor != null && - defaultConstructor.parameters.parameters.any((e) => e.isRequired)) { - errorReporter?.call( - RiverpodAnalysisError( - 'The default constructor of classes annotated with @riverpod ' - 'cannot have required parameters.', - targetNode: node, - targetElement: node.declaredElement, - code: RiverpodAnalysisErrorCode - .notifierDefaultConstructorHasRequiredParameters, - ), - ); - } - - final buildMethod = node.members - .whereType() - .firstWhereOrNull((method) => method.name.lexeme == 'build'); - if (buildMethod == null) { - errorReporter?.call( - RiverpodAnalysisError( - 'No "build" method found. ' - 'Classes annotated with @riverpod must define a method named "build".', - targetNode: node, - code: RiverpodAnalysisErrorCode.missingNotifierBuild, - ), - ); - return null; - } - - final providerElement = ClassBasedProviderDeclarationElement.parse( - element, - annotation: riverpodAnnotation.element, - ); - if (providerElement == null) return null; - - final createdTypeNode = buildMethod.returnType; - - final exposedTypeNode = - _computeExposedType(createdTypeNode, element.library); - if (exposedTypeNode == null) { - // Error already reported - return null; - } - - final valueTypeNode = _getValueType(createdTypeNode, element.library); - final classBasedProviderDeclaration = ClassBasedProviderDeclaration._( - name: node.name, - node: node, - buildMethod: buildMethod, - providerElement: providerElement, - annotation: riverpodAnnotation, - createdTypeNode: createdTypeNode, - exposedTypeNode: exposedTypeNode, - valueTypeNode: valueTypeNode, - ); - riverpodAnnotation._parent = classBasedProviderDeclaration; - node.accept( - _GeneratorRefInvocationVisitor(classBasedProviderDeclaration, parent), - ); - - return classBasedProviderDeclaration; - } - - @override - final Token name; - @override - final ClassDeclaration node; - @override - final ClassBasedProviderDeclarationElement providerElement; - @override - final RiverpodAnnotation annotation; - final MethodDeclaration buildMethod; - @override - final TypeAnnotation? createdTypeNode; - @override - final TypeAnnotation? valueTypeNode; - @override - final SourcedType exposedTypeNode; -} - -class _GeneratorRefInvocationVisitor extends RecursiveAstVisitor - with _ParseRefInvocationMixin { - _GeneratorRefInvocationVisitor(this.declaration, this.parent); - - final GeneratorProviderDeclaration declaration; - final _ParseRefInvocationMixin parent; - - @override - void visitRefInvocation(RefInvocation invocation) { - declaration.refInvocations.add(invocation); - invocation._parent = declaration; - } - - @override - void visitWidgetRefInvocation(WidgetRefInvocation invocation) { - parent.visitWidgetRefInvocation(invocation); - } - - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression expression, - ) { - parent.visitProviderContainerInstanceCreationExpression(expression); - } - - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression expression, - ) { - parent.visitProviderScopeInstanceCreationExpression(expression); - } -} - -final class FunctionalProviderDeclaration extends GeneratorProviderDeclaration - with _$FunctionalProviderDeclaration { - FunctionalProviderDeclaration._({ - required this.name, - required this.node, - required this.providerElement, - required this.annotation, - required this.createdTypeNode, - required this.exposedTypeNode, - required this.valueTypeNode, - }); - - static FunctionalProviderDeclaration? _parse( - FunctionDeclaration node, - _ParseRefInvocationMixin parent, - ) { - final element = node.declaredElement; - if (element == null) return null; - final riverpodAnnotation = RiverpodAnnotation._parse(node); - if (riverpodAnnotation == null) return null; - - final providerElement = FunctionalProviderDeclarationElement.parse( - element, - annotation: riverpodAnnotation.element, - ); - if (providerElement == null) return null; - - final createdTypeNode = node.returnType; - final exposedTypeNode = - _computeExposedType(createdTypeNode, element.library); - if (exposedTypeNode == null) { - // Error already reported - return null; - } - - final functionalProviderDeclaration = FunctionalProviderDeclaration._( - name: node.name, - node: node, - providerElement: providerElement, - annotation: riverpodAnnotation, - createdTypeNode: createdTypeNode, - exposedTypeNode: exposedTypeNode, - valueTypeNode: _getValueType(createdTypeNode, element.library), - ); - riverpodAnnotation._parent = functionalProviderDeclaration; - node.accept( - _GeneratorRefInvocationVisitor(functionalProviderDeclaration, parent), - ); - return functionalProviderDeclaration; - } - - @override - final Token name; - - @override - final FunctionDeclaration node; - @override - final FunctionalProviderDeclarationElement providerElement; - @override - final RiverpodAnnotation annotation; - @override - final TypeAnnotation? createdTypeNode; - @override - final TypeAnnotation? valueTypeNode; - @override - final SourcedType exposedTypeNode; - - /// Whether the provider uses the syntax sugar for scoped providers: - /// - /// ```dart - /// @riverpod - /// external int count(); - /// ``` - bool get needsOverride => node.externalKeyword != null; -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/legacy_provider_declaration.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/legacy_provider_declaration.dart deleted file mode 100644 index 3b116b085..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/legacy_provider_declaration.dart +++ /dev/null @@ -1,226 +0,0 @@ -part of '../riverpod_ast.dart'; - -final class LegacyProviderDependencies extends RiverpodAst - with _$LegacyProviderDependencies { - LegacyProviderDependencies._({ - required this.dependencies, - required this.dependenciesNode, - }); - - static LegacyProviderDependencies? _parse(NamedExpression? dependenciesNode) { - if (dependenciesNode == null) return null; - - final value = dependenciesNode.expression; - - List? dependencies; - if (value is ListLiteral) { - dependencies = - value.elements.map(LegacyProviderDependency._parse).toList(); - } - - final legacyProviderDependencies = LegacyProviderDependencies._( - dependenciesNode: dependenciesNode, - dependencies: dependencies, - ); - legacyProviderDependencies.dependencies?.forEach((element) { - element._parent = legacyProviderDependencies; - }); - - return legacyProviderDependencies; - } - - @override - final List? dependencies; - final NamedExpression dependenciesNode; -} - -final class LegacyProviderDependency extends RiverpodAst - with _$LegacyProviderDependency - implements ProviderListenableExpressionParent { - LegacyProviderDependency._({ - required this.node, - required this.provider, - }); - - factory LegacyProviderDependency._parse(CollectionElement node) { - final provider = - node.cast().let(ProviderListenableExpression._parse); - - final legacyProviderDependency = LegacyProviderDependency._( - node: node, - provider: provider, - ); - provider?._parent = legacyProviderDependency; - return legacyProviderDependency; - } - - final CollectionElement node; - @override - final ProviderListenableExpression? provider; -} - -final class LegacyProviderDeclaration extends RiverpodAst - with _$LegacyProviderDeclaration - implements ProviderDeclaration { - LegacyProviderDeclaration._({ - required this.name, - required this.node, - required this.build, - required this.typeArguments, - required this.providerElement, - required this.argumentList, - required this.provider, - required this.autoDisposeModifier, - required this.familyModifier, - required this.dependencies, - }); - - static LegacyProviderDeclaration? _parse( - VariableDeclaration node, - _ParseRefInvocationMixin parent, - ) { - final element = node.declaredElement; - if (element == null) return null; - - final providerElement = LegacyProviderDeclarationElement.parse(element); - if (providerElement == null) return null; - - final initializer = node.initializer; - ArgumentList? arguments; - late SyntacticEntity provider; - SimpleIdentifier? autoDisposeModifier; - SimpleIdentifier? familyModifier; - TypeArgumentList? typeArguments; - if (initializer is InstanceCreationExpression) { - // Provider((ref) => ...) - - arguments = initializer.argumentList; - provider = initializer.constructorName.type.name2; - typeArguments = initializer.constructorName.type.typeArguments; - } else if (initializer is FunctionExpressionInvocation) { - // Provider.modifier() - - void decodeIdentifier(SimpleIdentifier identifier) { - switch (identifier.name) { - case 'autoDispose': - autoDisposeModifier = identifier; - case 'family': - familyModifier = identifier; - default: - provider = identifier; - } - } - - void decodeTarget(Expression? expression) { - if (expression is SimpleIdentifier) { - decodeIdentifier(expression); - } else if (expression is PrefixedIdentifier) { - decodeIdentifier(expression.identifier); - decodeIdentifier(expression.prefix); - } else { - throw UnsupportedError( - 'unknown expression "$expression" (${expression.runtimeType})', - ); - } - } - - final modifier = initializer.function; - if (modifier is! PropertyAccess) return null; - - decodeIdentifier(modifier.propertyName); - decodeTarget(modifier.target); - arguments = initializer.argumentList; - typeArguments = initializer.typeArguments; - } else { - // Invalid provider expression. - // Such as "final provider = variable;" - return null; - } - - final build = arguments.positionalArguments().firstOrNull; - if (build is! FunctionExpression) return null; - - final dependenciesElement = arguments - .namedArguments() - .firstWhereOrNull((e) => e.name.label.name == 'dependencies'); - final dependencies = LegacyProviderDependencies._parse(dependenciesElement); - - final legacyProviderDeclaration = LegacyProviderDeclaration._( - name: node.name, - node: node, - build: build, - providerElement: providerElement, - argumentList: arguments, - typeArguments: typeArguments, - provider: provider, - autoDisposeModifier: autoDisposeModifier, - familyModifier: familyModifier, - dependencies: dependencies, - ); - - dependencies?._parent = legacyProviderDeclaration; - build.accept( - _LegacyRefInvocationVisitor( - legacyProviderDeclaration, - parent, - ), - ); - - return legacyProviderDeclaration; - } - - @override - final LegacyProviderDependencies? dependencies; - - final FunctionExpression build; - final ArgumentList argumentList; - final SyntacticEntity provider; - final SimpleIdentifier? autoDisposeModifier; - final SimpleIdentifier? familyModifier; - final TypeArgumentList? typeArguments; - - @override - final LegacyProviderDeclarationElement providerElement; - - @override - final List refInvocations = []; - - @override - final Token name; - - @override - final VariableDeclaration node; -} - -class _LegacyRefInvocationVisitor extends RecursiveAstVisitor - with _ParseRefInvocationMixin { - _LegacyRefInvocationVisitor(this.declaration, this.parent); - - final LegacyProviderDeclaration declaration; - final _ParseRefInvocationMixin parent; - - @override - void visitRefInvocation(RefInvocation invocation) { - declaration.refInvocations.add(invocation); - invocation._parent = declaration; - } - - @override - void visitWidgetRefInvocation(WidgetRefInvocation invocation) { - parent.visitWidgetRefInvocation(invocation); - } - - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression expression, - ) { - parent.visitProviderContainerInstanceCreationExpression(expression); - } - - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression expression, - ) { - parent.visitProviderScopeInstanceCreationExpression(expression); - } -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_container_instance_creation_expression.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_container_instance_creation_expression.dart deleted file mode 100644 index 1d64fc662..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_container_instance_creation_expression.dart +++ /dev/null @@ -1,32 +0,0 @@ -part of '../riverpod_ast.dart'; - -final class ProviderContainerInstanceCreationExpression extends RiverpodAst - with _$ProviderContainerInstanceCreationExpression { - ProviderContainerInstanceCreationExpression._({ - required this.node, - required this.overrides, - }); - - static ProviderContainerInstanceCreationExpression? _parse( - InstanceCreationExpression node, - ) { - final createdType = node.constructorName.type.type; - if (createdType == null || - !providerContainerType.isExactlyType(createdType)) { - return null; - } - - final overrides = node.argumentList - .namedArguments() - .firstWhereOrNull((e) => e.name.label.name == 'overrides'); - - return ProviderContainerInstanceCreationExpression._( - node: node, - overrides: ProviderOverrideList._parse(overrides), - ); - } - - final InstanceCreationExpression node; - @override - final ProviderOverrideList? overrides; -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_declaration.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_declaration.dart deleted file mode 100644 index 47b45f5c6..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_declaration.dart +++ /dev/null @@ -1,8 +0,0 @@ -part of '../riverpod_ast.dart'; - -abstract base class ProviderDeclaration extends RiverpodAst - with _$ProviderDeclaration { - Token get name; - AnnotatedNode get node; - ProviderDeclarationElement get providerElement; -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_listenable_expression.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_listenable_expression.dart deleted file mode 100644 index 487c6d0d9..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_listenable_expression.dart +++ /dev/null @@ -1,117 +0,0 @@ -part of '../riverpod_ast.dart'; - -abstract base class ProviderListenableExpressionParent extends RiverpodAst - with _$ProviderListenableExpressionParent {} - -final class ProviderListenableExpression extends RiverpodAst - with _$ProviderListenableExpression { - ProviderListenableExpression._({ - required this.node, - required this.provider, - required this.providerPrefix, - required this.providerElement, - required this.familyArguments, - }); - - static ProviderListenableExpression? _parse(Expression? expression) { - if (expression == null) return null; - - SimpleIdentifier? provider; - SimpleIdentifier? providerPrefix; - ProviderDeclarationElement? providerElement; - ArgumentList? familyArguments; - - void parseExpression(Expression? expression) { - // Can be reached when the code contains syntax errors - if (expression == null) return; - if (expression is SimpleIdentifier) { - // watch(expression) - provider = expression; - final element = expression.staticElement; - if (element is PropertyAccessorElement) { - // watch(provider) - DartObject? annotation; - try { - annotation = - providerForType.firstAnnotationOfExact(element.variable); - } catch (_) { - return; - } - - if (annotation == null) { - providerElement = - LegacyProviderDeclarationElement.parse(element.variable); - } else { - providerElement = _parseGeneratedProviderFromAnnotation(annotation); - } - } - } else if (expression is FunctionExpressionInvocation) { - // watch(expression()) - familyArguments = expression.argumentList; - parseExpression(expression.function); - } else if (expression is MethodInvocation) { - // watch(expression.method()) - parseExpression(expression.target); - } else if (expression is PrefixedIdentifier) { - // watch(expression.modifier) - final element = expression.prefix.staticElement; - if (element is PrefixElement) { - providerPrefix = expression.prefix; - parseExpression(expression.identifier); - } else { - parseExpression(expression.prefix); - } - } else if (expression is IndexExpression) { - // watch(expression[]) - parseExpression(expression.target); - } else if (expression is PropertyAccess) { - // watch(expression.property) - parseExpression(expression.target); - } - } - - parseExpression(expression); - - return ProviderListenableExpression._( - node: expression, - provider: provider, - providerPrefix: providerPrefix, - providerElement: providerElement, - // Make sure `(){}()` doesn't report an argument list even though it's not a provider - familyArguments: provider == null ? null : familyArguments, - ); - } - - static GeneratorProviderDeclarationElement? - _parseGeneratedProviderFromAnnotation( - DartObject annotation, - ) { - final generatedProviderDefinition = annotation.getField('value')!; - - final function = generatedProviderDefinition.toFunctionValue(); - if (function != null) { - return FunctionalProviderDeclarationElement.parse( - function, - annotation: null, - ); - } - late final type = generatedProviderDefinition.toTypeValue()?.element; - if (type != null && type is ClassElement) { - return ClassBasedProviderDeclarationElement.parse( - type, - annotation: null, - ); - } else { - throw StateError('Unknown value $generatedProviderDefinition'); - } - } - - final Expression node; - final SimpleIdentifier? providerPrefix; - final SimpleIdentifier? provider; - final ProviderDeclarationElement? providerElement; - - /// If [provider] is a provider with arguments (family), represents the arguments - /// passed to the provider. - final ArgumentList? familyArguments; -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_override.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_override.dart deleted file mode 100644 index 0a0d28522..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_override.dart +++ /dev/null @@ -1,72 +0,0 @@ -part of '../riverpod_ast.dart'; - -final class ProviderOverrideExpression extends RiverpodAst - with _$ProviderOverrideExpression { - ProviderOverrideExpression._({ - required this.expression, - required this.providerElement, - required this.provider, - required this.familyArguments, - }); - - // ignore: prefer_constructors_over_static_methods - static ProviderOverrideExpression _parse(CollectionElement expression) { - SimpleIdentifier? provider; - ProviderDeclarationElement? providerElement; - ArgumentList? familyArguments; - if (expression is Expression) { - final listenable = ProviderListenableExpression._parse(expression); - provider = listenable?.provider; - providerElement = listenable?.providerElement; - familyArguments = listenable?.familyArguments; - } - - return ProviderOverrideExpression._( - expression: expression, - providerElement: providerElement, - familyArguments: familyArguments, - provider: provider, - ); - } - - final CollectionElement expression; - final ProviderDeclarationElement? providerElement; - final SimpleIdentifier? provider; - - /// If [provider] is a provider with arguments (family), represents the arguments - /// passed to the provider. - final ArgumentList? familyArguments; -} - -final class ProviderOverrideList extends RiverpodAst - with _$ProviderOverrideList { - ProviderOverrideList._({ - required this.node, - required this.overrides, - }); - - static ProviderOverrideList? _parse(NamedExpression? expression) { - if (expression == null) return null; - final expressionValue = expression.expression; - - List? overrides; - if (expressionValue is ListLiteral) { - overrides = expressionValue.elements - .map(ProviderOverrideExpression._parse) - .toList(); - } - - final providerOverrideList = ProviderOverrideList._( - node: expression, - overrides: overrides, - ); - - overrides?.forEach((e) => e._parent = providerOverrideList); - - return providerOverrideList; - } - - final NamedExpression node; - @override - final List? overrides; -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_scope.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_scope.dart deleted file mode 100644 index 14df9850e..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_scope.dart +++ /dev/null @@ -1,31 +0,0 @@ -part of '../riverpod_ast.dart'; - -final class ProviderScopeInstanceCreationExpression extends RiverpodAst - with _$ProviderScopeInstanceCreationExpression { - ProviderScopeInstanceCreationExpression._({ - required this.node, - required this.overrides, - }); - - static ProviderScopeInstanceCreationExpression? _parse( - InstanceCreationExpression node, - ) { - final createdType = node.constructorName.type.type; - if (createdType == null || !providerScopeType.isExactlyType(createdType)) { - return null; - } - - final overrides = node.argumentList - .namedArguments() - .firstWhereOrNull((e) => e.name.label.name == 'overrides'); - - return ProviderScopeInstanceCreationExpression._( - node: node, - overrides: ProviderOverrideList._parse(overrides), - ); - } - - final InstanceCreationExpression node; - @override - final ProviderOverrideList? overrides; -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/ref_invocation.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/ref_invocation.dart deleted file mode 100644 index 87592b273..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/ref_invocation.dart +++ /dev/null @@ -1,184 +0,0 @@ -part of '../riverpod_ast.dart'; - -abstract base class RefInvocation extends RiverpodAst - with _$RefInvocation - implements ProviderListenableExpressionParent { - RefInvocation._({ - required this.node, - required this.function, - }); - - static RefInvocation? _parse( - MethodInvocation node, { - required void Function() superCall, - }) { - final targetType = node.realTarget?.staticType; - if (targetType == null) return null; - - if (!isRiverpodRef(targetType)) return null; - - final function = node.function; - if (function is! SimpleIdentifier) return null; - final functionOwner = function.staticElement - .cast() - ?.declaration - .enclosingElement; - - if (functionOwner == null || - // Since Ref is sealed, checking that the function is from the package:riverpod - // before checking its type skips iterating over the superclasses of an element - // if it's not from Riverpod. - !isFromRiverpod.isExactly(functionOwner) || - !refType.isAssignableFrom(functionOwner)) { - return null; - } - - switch (function.name) { - case 'watch': - return RefWatchInvocation._parse( - node, - function, - superCall: superCall, - ); - case 'read': - return RefReadInvocation._parse( - node, - function, - superCall: superCall, - ); - case 'listen': - return RefListenInvocation._parse( - node, - function, - superCall: superCall, - ); - default: - return null; - } - } - - final MethodInvocation node; - final SimpleIdentifier function; -} - -/// A [RefInvocation] which interacts with a provider, inducing a dependency. -abstract base class RefDependencyInvocation extends RefInvocation - with _$RefDependencyInvocation { - RefDependencyInvocation._({ - required super.node, - required super.function, - required this.provider, - }) : super._(); - - /// The provider that is being interacted with. - @override - final ProviderListenableExpression provider; -} - -final class RefWatchInvocation extends RefDependencyInvocation - with _$RefWatchInvocation { - RefWatchInvocation._({ - required super.node, - required super.function, - required super.provider, - }) : super._(); - - static RefWatchInvocation? _parse( - MethodInvocation node, - SimpleIdentifier function, { - required void Function() superCall, - }) { - assert( - function.name == 'watch', - 'Argument error, function is not a ref.watch function', - ); - - final providerListenableExpression = ProviderListenableExpression._parse( - node.argumentList.positionalArguments().singleOrNull, - ); - if (providerListenableExpression == null) return null; - - final refWatchInvocation = RefWatchInvocation._( - node: node, - function: function, - provider: providerListenableExpression, - ); - providerListenableExpression._parent = refWatchInvocation; - return refWatchInvocation; - } -} - -final class RefReadInvocation extends RefDependencyInvocation - with _$RefReadInvocation { - RefReadInvocation._({ - required super.node, - required super.function, - required super.provider, - }) : super._(); - - static RefReadInvocation? _parse( - MethodInvocation node, - SimpleIdentifier function, { - required void Function() superCall, - }) { - assert( - function.name == 'read', - 'Argument error, function is not a ref.read function', - ); - - final providerListenableExpression = ProviderListenableExpression._parse( - node.argumentList.positionalArguments().singleOrNull, - ); - if (providerListenableExpression == null) return null; - - final refReadInvocation = RefReadInvocation._( - node: node, - function: function, - provider: providerListenableExpression, - ); - providerListenableExpression._parent = refReadInvocation; - return refReadInvocation; - } -} - -final class RefListenInvocation extends RefDependencyInvocation - with _$RefListenInvocation { - RefListenInvocation._({ - required super.node, - required super.function, - required this.listener, - required super.provider, - }) : super._(); - - static RefListenInvocation? _parse( - MethodInvocation node, - SimpleIdentifier function, { - required void Function() superCall, - }) { - assert( - function.name == 'listen', - 'Argument error, function is not a ref.listen function', - ); - - final positionalArgs = node.argumentList.positionalArguments().toList(); - - final listener = positionalArgs.elementAtOrNull(1); - if (listener == null) return null; - - final providerListenableExpression = ProviderListenableExpression._parse( - positionalArgs.firstOrNull, - ); - if (providerListenableExpression == null) return null; - - final refListenInvocation = RefListenInvocation._( - node: node, - function: function, - listener: listener, - provider: providerListenableExpression, - ); - providerListenableExpression._parent = refListenInvocation; - return refListenInvocation; - } - - final Expression listener; -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/resolve_riverpod.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/resolve_riverpod.dart deleted file mode 100644 index b1706dc26..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/resolve_riverpod.dart +++ /dev/null @@ -1,252 +0,0 @@ -part of '../riverpod_ast.dart'; - -final class ResolvedRiverpodLibraryResult extends RiverpodAst - with _$ResolvedRiverpodLibraryResult { - ResolvedRiverpodLibraryResult._(); - - factory ResolvedRiverpodLibraryResult.from( - List units, - ) { - final result = ResolvedRiverpodLibraryResult._(); - final visitor = _ParseRiverpodUnitVisitor(result); - - try { - errorReporter = result.errors.add; - - for (final unit in units) { - // Let's not parse generated files - const generatedExtensions = {'.freezed.dart', '.g.dart'}; - final shortName = unit.declaredElement?.source.shortName ?? ''; - if (generatedExtensions.any(shortName.endsWith)) { - continue; - } - unit.accept(visitor); - } - } finally { - errorReporter = null; - } - - return result; - } - - final errors = []; - - @override - final providerScopeInstanceCreationExpressions = - []; - @override - final providerContainerInstanceCreationExpressions = - []; - - @override - final functionalProviderDeclarations = []; - @override - final classBasedProviderDeclarations = []; - - @override - final legacyProviderDeclarations = []; - - @override - final consumerWidgetDeclarations = []; - @override - final consumerStatefulWidgetDeclarations = - []; - @override - final consumerStateDeclaration = []; - @override - final statefulHookConsumerWidgetDeclarations = - []; - @override - final hookConsumerWidgetDeclarations = []; - - @override - final unknownRefInvocations = []; - @override - final unknownWidgetRefInvocations = []; - - @override - Null get parent => null; - - // TODO changelog breaking renamed visitResolvedRiverpodLibraryResult -} - -mixin _ParseRefInvocationMixin on RecursiveAstVisitor { - @override - void visitMethodInvocation(MethodInvocation node) { - void superCall() => super.visitMethodInvocation(node); - - final refInvocation = RefInvocation._parse(node, superCall: superCall); - if (refInvocation != null) { - visitRefInvocation(refInvocation); - // Don't call super as RefInvocation should already be recursive - return; - } - - final widgetRefInvocation = - WidgetRefInvocation._parse(node, superCall: superCall); - if (widgetRefInvocation != null) { - visitWidgetRefInvocation(widgetRefInvocation); - // Don't call super as WidgetRefInvocation should already be recursive - return; - } - - super.visitMethodInvocation(node); - } - - @override - void visitInstanceCreationExpression(InstanceCreationExpression node) { - final providerScopeInstanceCreationExpression = - ProviderScopeInstanceCreationExpression._parse(node); - if (providerScopeInstanceCreationExpression != null) { - visitProviderScopeInstanceCreationExpression( - providerScopeInstanceCreationExpression, - ); - // Don't call super as ProviderScopeInstanceCreationExpression should - // already be recursive - return; - } - - final providerContainerInstanceCreationExpression = - ProviderContainerInstanceCreationExpression._parse(node); - if (providerContainerInstanceCreationExpression != null) { - visitProviderContainerInstanceCreationExpression( - providerContainerInstanceCreationExpression, - ); - // Don't call super as ProviderContainerInstanceCreationExpression should - // already be recursive - return; - } - - super.visitInstanceCreationExpression(node); - } - - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression expression, - ); - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression expression, - ); - - void visitRefInvocation(RefInvocation invocation); - - void visitWidgetRefInvocation(WidgetRefInvocation invocation); -} - -class _AddConsumerDeclarationVisitor extends UnimplementedRiverpodAstVisitor { - _AddConsumerDeclarationVisitor(this.result); - - final ResolvedRiverpodLibraryResult result; - - @override - void visitConsumerStatefulWidgetDeclaration( - ConsumerStatefulWidgetDeclaration declaration, - ) { - result.consumerStatefulWidgetDeclarations.add(declaration); - } - - @override - void visitConsumerStateDeclaration(ConsumerStateDeclaration declaration) { - result.consumerStateDeclaration.add(declaration); - } - - @override - void visitStatefulHookConsumerWidgetDeclaration( - StatefulHookConsumerWidgetDeclaration declaration, - ) { - result.statefulHookConsumerWidgetDeclarations.add(declaration); - } - - @override - void visitHookConsumerWidgetDeclaration( - HookConsumerWidgetDeclaration declaration, - ) { - result.hookConsumerWidgetDeclarations.add(declaration); - } - - @override - void visitConsumerWidgetDeclaration(ConsumerWidgetDeclaration declaration) { - result.consumerWidgetDeclarations.add(declaration); - } -} - -class _ParseRiverpodUnitVisitor extends RecursiveAstVisitor - with _ParseRefInvocationMixin { - _ParseRiverpodUnitVisitor(this.result); - - final ResolvedRiverpodLibraryResult result; - - @override - void visitClassDeclaration(ClassDeclaration node) { - final declaration = ClassBasedProviderDeclaration._parse(node, this); - if (declaration != null) { - result.classBasedProviderDeclarations.add(declaration); - declaration._parent = result; - // Don't call super as ClassBasedProviderDeclaration should already be recursive - return; - } - - final consumerDeclaration = ConsumerDeclaration._parse(node, this); - if (consumerDeclaration != null) { - consumerDeclaration._parent = result; - consumerDeclaration.accept(_AddConsumerDeclarationVisitor(result)); - // Don't call super as ClassBasedProviderDeclaration should already be recursive - return; - } - - super.visitClassDeclaration(node); - } - - @override - void visitFunctionDeclaration(FunctionDeclaration node) { - final declaration = FunctionalProviderDeclaration._parse(node, this); - if (declaration != null) { - result.functionalProviderDeclarations.add(declaration); - declaration._parent = result; - // Don't call super as FunctionalProviderDeclaration should already be recursive - return; - } - - super.visitFunctionDeclaration(node); - } - - @override - void visitVariableDeclaration(VariableDeclaration node) { - final declaration = LegacyProviderDeclaration._parse(node, this); - if (declaration != null) { - result.legacyProviderDeclarations.add(declaration); - declaration._parent = result; - // Don't call super as LegacyProviderDeclaration should already be recursive - return; - } - - super.visitVariableDeclaration(node); - } - - @override - void visitRefInvocation(RefInvocation invocation) { - result.unknownRefInvocations.add(invocation); - invocation._parent = result; - } - - @override - void visitWidgetRefInvocation(WidgetRefInvocation invocation) { - result.unknownWidgetRefInvocations.add(invocation); - invocation._parent = result; - } - - @override - void visitProviderContainerInstanceCreationExpression( - ProviderContainerInstanceCreationExpression expression, - ) { - result.providerContainerInstanceCreationExpressions.add(expression); - expression._parent = result; - } - - @override - void visitProviderScopeInstanceCreationExpression( - ProviderScopeInstanceCreationExpression expression, - ) { - result.providerScopeInstanceCreationExpressions.add(expression); - expression._parent = result; - } -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart deleted file mode 100644 index 145a67b70..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/riverpod_annotation.dart +++ /dev/null @@ -1,203 +0,0 @@ -part of '../riverpod_ast.dart'; - -final class RiverpodAnnotationDependency extends RiverpodAst - with _$RiverpodAnnotationDependency { - RiverpodAnnotationDependency._({ - required this.node, - required this.provider, - }); - - final Expression node; - final GeneratorProviderDeclarationElement provider; -} - -final class RiverpodAnnotationDependencies extends RiverpodAst - with _$RiverpodAnnotationDependencies { - RiverpodAnnotationDependencies._({ - required this.node, - required this.dependencies, - }); - - final NamedExpression node; - @override - final List? dependencies; -} - -final class RiverpodAnnotation extends RiverpodAst with _$RiverpodAnnotation { - RiverpodAnnotation._({ - required this.annotation, - required this.element, - required this.keepAliveNode, - required this.dependencies, - }); - - static RiverpodAnnotation? _parse( - Declaration node, - ) { - final annotatedElement = node.declaredElement; - if (annotatedElement == null) return null; - - for (final annotation in node.metadata) { - final elementAnnotation = annotation.elementAnnotation; - final annotationElement = annotation.element; - if (elementAnnotation == null || annotationElement == null) continue; - if (annotationElement is! ExecutableElement || - !riverpodType.isExactlyType(annotationElement.returnType)) { - // The annotation is not an @Riverpod - continue; - } - - final dartObject = elementAnnotation.computeConstantValue(); - if (dartObject == null) return null; - - NamedExpression? keepAliveNode; - NamedExpression? dependenciesNode; - final argumentList = annotation.arguments; - if (argumentList != null) { - for (final argument - in argumentList.arguments.whereType()) { - switch (argument.name.label.name) { - case 'keepAlive': - keepAliveNode = argument; - case 'dependencies': - dependenciesNode = argument; - } - } - } - - final riverpodAnnotationElement = - RiverpodAnnotationElement.parse(annotatedElement); - if (riverpodAnnotationElement == null) return null; - - final dependencies = _parseDependencies(dependenciesNode); - - final riverpodAnnotation = RiverpodAnnotation._( - annotation: annotation, - element: riverpodAnnotationElement, - keepAliveNode: keepAliveNode, - dependencies: dependencies, - ); - dependencies?._parent = riverpodAnnotation; - - return riverpodAnnotation; - } - - return null; - } - - static RiverpodAnnotationDependencies? _parseDependencies( - NamedExpression? dependenciesNode, - ) { - if (dependenciesNode == null) return null; - final dependenciesNodeValue = dependenciesNode.expression; - // TODO handle Riverpod(dependencies:null) - - final dependencies = []; - - if (dependenciesNodeValue is! ListLiteral) { - errorReporter?.call( - RiverpodAnalysisError( - '@Riverpod(dependencies: <...>) only support list literals (using []).', - targetNode: dependenciesNodeValue, - code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, - ), - ); - } else { - for (final dependency in dependenciesNodeValue.elements) { - if (dependency is! Expression) { - errorReporter?.call( - RiverpodAnalysisError( - '@Riverpod(dependencies: [...]) does not support if/for/spread operators.', - targetNode: dependency, - code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, - ), - ); - continue; - } - - if (dependency is! SimpleIdentifier) { - errorReporter?.call( - RiverpodAnalysisError( - 'Only elements annotated with @riverpod are supported as "dependencies".', - targetNode: dependency, - code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, - ), - ); - continue; - } - - final dependencyElement = dependency.staticElement; - if (dependencyElement is FunctionElement) { - final dependencyProvider = FunctionalProviderDeclarationElement.parse( - dependencyElement, - annotation: null, - ); - if (dependencyProvider == null) { - errorReporter?.call( - RiverpodAnalysisError( - 'The dependency $dependency is not a class annotated with @riverpod', - targetNode: dependency, - code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, - ), - ); - continue; - } - - dependencies.add( - RiverpodAnnotationDependency._( - node: dependency, - provider: dependencyProvider, - ), - ); - } else if (dependencyElement is ClassElement) { - final dependencyProvider = ClassBasedProviderDeclarationElement.parse( - dependencyElement, - annotation: null, - ); - if (dependencyProvider == null) { - errorReporter?.call( - RiverpodAnalysisError( - 'The dependency $dependency is not a class annotated with @riverpod', - targetNode: dependency, - code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, - ), - ); - continue; - } - - dependencies.add( - RiverpodAnnotationDependency._( - node: dependency, - provider: dependencyProvider, - ), - ); - } else { - errorReporter?.call( - RiverpodAnalysisError( - '@Riverpod(dependencies: [...]) only supports elements annotated with @riverpod as values.', - targetNode: dependency, - code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, - ), - ); - } - } - } - - final riverpodAnnotationDependencies = RiverpodAnnotationDependencies._( - node: dependenciesNode, - dependencies: dependencies, - ); - - for (final dependency in dependencies) { - dependency._parent = riverpodAnnotationDependencies; - } - - return riverpodAnnotationDependencies; - } - - final Annotation annotation; - final RiverpodAnnotationElement element; - final NamedExpression? keepAliveNode; - @override - final RiverpodAnnotationDependencies? dependencies; -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/widget_ref_invocation.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/widget_ref_invocation.dart deleted file mode 100644 index 7185c141b..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_ast/widget_ref_invocation.dart +++ /dev/null @@ -1,232 +0,0 @@ -part of '../riverpod_ast.dart'; - -abstract base class WidgetRefInvocation extends RiverpodAst - with _$WidgetRefInvocation - implements ProviderListenableExpressionParent { - WidgetRefInvocation._({ - required this.node, - required this.function, - }); - - static WidgetRefInvocation? _parse( - MethodInvocation node, { - required void Function() superCall, - }) { - final targetType = node.realTarget?.staticType; - if (targetType == null) return null; - - // Since Ref is sealed, checking that the function is from the package:riverpod - // before checking its type skips iterating over the superclasses of an element - // if it's not from Riverpod. - if (!isFromFlutterRiverpod.isExactlyType(targetType) | - !widgetRefType.isAssignableFromType(targetType)) { - return null; - } - final function = node.function; - if (function is! SimpleIdentifier) return null; - final functionOwner = function.staticElement - .cast() - ?.declaration - .enclosingElement; - - if (functionOwner == null || - // Since Ref is sealed, checking that the function is from the package:riverpod - // before checking its type skips iterating over the superclasses of an element - // if it's not from Riverpod. - !isFromFlutterRiverpod.isExactly(functionOwner) || - !widgetRefType.isAssignableFrom(functionOwner)) { - return null; - } - - switch (function.name) { - case 'watch': - return WidgetRefWatchInvocation._parse( - node, - function, - superCall: superCall, - ); - case 'read': - return WidgetRefReadInvocation._parse( - node, - function, - superCall: superCall, - ); - case 'listen': - return WidgetRefListenInvocation._parse( - node, - function, - superCall: superCall, - ); - case 'listenManual': - return WidgetRefListenManualInvocation._parse( - node, - function, - superCall: superCall, - ); - - default: - return null; - } - } - - final MethodInvocation node; - final SimpleIdentifier function; -} - -final class WidgetRefWatchInvocation extends WidgetRefInvocation - with _$WidgetRefWatchInvocation { - WidgetRefWatchInvocation._({ - required super.node, - required super.function, - required this.provider, - }) : super._(); - - static WidgetRefWatchInvocation? _parse( - MethodInvocation node, - SimpleIdentifier function, { - required void Function() superCall, - }) { - assert( - function.name == 'watch', - 'Argument error, function is not a ref.watch function', - ); - - final providerListenableExpression = ProviderListenableExpression._parse( - node.argumentList.positionalArguments().singleOrNull, - ); - if (providerListenableExpression == null) return null; - - final widgetRefWatchInvocation = WidgetRefWatchInvocation._( - node: node, - function: function, - provider: providerListenableExpression, - ); - providerListenableExpression._parent = widgetRefWatchInvocation; - return widgetRefWatchInvocation; - } - - @override - final ProviderListenableExpression provider; -} - -final class WidgetRefReadInvocation extends WidgetRefInvocation - with _$WidgetRefReadInvocation { - WidgetRefReadInvocation._({ - required super.node, - required super.function, - required this.provider, - }) : super._(); - - static WidgetRefReadInvocation? _parse( - MethodInvocation node, - SimpleIdentifier function, { - required void Function() superCall, - }) { - assert( - function.name == 'read', - 'Argument error, function is not a ref.read function', - ); - - final providerListenableExpression = ProviderListenableExpression._parse( - node.argumentList.positionalArguments().singleOrNull, - ); - if (providerListenableExpression == null) return null; - - final widgetRefReadInvocation = WidgetRefReadInvocation._( - node: node, - function: function, - provider: providerListenableExpression, - ); - providerListenableExpression._parent = widgetRefReadInvocation; - return widgetRefReadInvocation; - } - - @override - final ProviderListenableExpression provider; -} - -final class WidgetRefListenInvocation extends WidgetRefInvocation - with _$WidgetRefListenInvocation { - WidgetRefListenInvocation._({ - required super.node, - required super.function, - required this.provider, - required this.listener, - }) : super._(); - - static WidgetRefListenInvocation? _parse( - MethodInvocation node, - SimpleIdentifier function, { - required void Function() superCall, - }) { - assert( - function.name == 'listen', - 'Argument error, function is not a ref.listen function', - ); - - final positionalArgs = node.argumentList.positionalArguments().toList(); - final listener = positionalArgs.elementAtOrNull(1); - if (listener == null) return null; - - final providerListenableExpression = ProviderListenableExpression._parse( - positionalArgs.firstOrNull, - ); - if (providerListenableExpression == null) return null; - - final widgetRefListenInvocation = WidgetRefListenInvocation._( - node: node, - function: function, - provider: providerListenableExpression, - listener: listener, - ); - providerListenableExpression._parent = widgetRefListenInvocation; - return widgetRefListenInvocation; - } - - @override - final ProviderListenableExpression provider; - final Expression listener; -} - -final class WidgetRefListenManualInvocation extends WidgetRefInvocation - with _$WidgetRefListenManualInvocation { - WidgetRefListenManualInvocation._({ - required super.node, - required super.function, - required this.provider, - required this.listener, - }) : super._(); - - static WidgetRefListenManualInvocation? _parse( - MethodInvocation node, - SimpleIdentifier function, { - required void Function() superCall, - }) { - assert( - function.name == 'listenManual', - 'Argument error, function is not a ref.listen function', - ); - - final positionalArgs = node.argumentList.positionalArguments().toList(); - final listener = positionalArgs.elementAtOrNull(1); - if (listener == null) return null; - - final providerListenableExpression = ProviderListenableExpression._parse( - positionalArgs.firstOrNull, - ); - if (providerListenableExpression == null) return null; - - final widgetRefListenManualInvocation = WidgetRefListenManualInvocation._( - node: node, - function: function, - provider: providerListenableExpression, - listener: listener, - ); - providerListenableExpression._parent = widgetRefListenManualInvocation; - return widgetRefListenManualInvocation; - } - - @override - final ProviderListenableExpression provider; - final Expression listener; -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart deleted file mode 100644 index 2ea9d6a75..000000000 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_element.dart +++ /dev/null @@ -1,395 +0,0 @@ -import 'package:analyzer/dart/constant/value.dart'; -import 'package:analyzer/dart/element/element.dart'; -import 'package:analyzer/dart/element/type.dart'; -import 'package:collection/collection.dart'; -import 'package:meta/meta.dart'; - -import '../riverpod_analyzer_utils.dart'; -import 'errors.dart'; - -class RiverpodAnnotationElement { - @internal - RiverpodAnnotationElement({ - required this.keepAlive, - required this.dependencies, - }) : allTransitiveDependencies = - _computeAllTransitiveDependencies(dependencies); - - @internal - static RiverpodAnnotationElement? parse(Element element) { - DartObject? annotation; - try { - annotation = riverpodType.firstAnnotationOfExact(element); - } catch (_) { - return RiverpodAnnotationElement( - keepAlive: false, - dependencies: null, - ); - } - if (annotation == null) return null; - - final dependencies = readDependencies(annotation)?.map((dep) { - final result = _parseDependency( - dep, - targetElement: element, - ); - if (result == null) { - errorReporter?.call( - RiverpodAnalysisError( - 'Failed to parse dependency $dep', - targetElement: element, - code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, - ), - ); - return null; - } - return result; - }).toSet(); - - if (dependencies?.any((e) => e == null) ?? false) { - // One of the dependencies failed to parse - return null; - } - - return RiverpodAnnotationElement( - keepAlive: readKeepAlive(annotation), - dependencies: dependencies?.cast(), - ); - } - - static GeneratorProviderDeclarationElement? _parseDependency( - DartObject object, { - required Element targetElement, - }) { - final functionType = object.toFunctionValue(); - if (functionType != null) { - final provider = FunctionalProviderDeclarationElement.parse( - functionType, - annotation: null, - ); - if (provider != null) return provider; - } - final valueType = object.toTypeValue(); - if (valueType != null) { - final provider = ClassBasedProviderDeclarationElement.parse( - valueType.element! as ClassElement, - annotation: null, - ); - if (provider != null) return provider; - } - errorReporter?.call( - RiverpodAnalysisError( - 'Unsupported dependency. ' - 'Only functions and classes annotated by @riverpod are supported.', - targetElement: targetElement, - code: RiverpodAnalysisErrorCode.riverpodDependencyParseError, - ), - ); - return null; - } - - static Set? - _computeAllTransitiveDependencies( - Set? dependencies, - ) { - if (dependencies == null) return null; - - return { - ...dependencies, - for (final dependency in dependencies) - ...?dependency.annotation.allTransitiveDependencies, - }; - } - - @internal - static bool readKeepAlive(DartObject object) { - return object.getField('keepAlive')?.toBoolValue() ?? false; - } - - @internal - static List? readDependencies(DartObject object) { - return object.getField('dependencies')?.toListValue(); - } - - final bool keepAlive; - final Set? dependencies; - final Set? allTransitiveDependencies; -} - -abstract class ProviderDeclarationElement { - // TODO changelog breaking: removed isAutoDispose from ProviderDeclarationElement - Element get element; - String get name; -} - -/// The class name for explicitly typed provider. -/// -/// Such as `FutureProvider` for `final provider = FutureProvider(...)`. -/// This is only about the type, and does not include autoDispose/family/... -enum LegacyProviderType { - /// Type for `ChangeNotifierProvider` - changeNotifierProvider, - - /// Type for `FutureProvider` - futureProvider, - - /// Type for `StreamProvider` - streamProvider, - - /// Type for `StateNotifierProvider` - stateNotifierProvider, - - /// Type for `StateProvider` - stateProvider, - - /// Type for `NotifierProvider` - notifierProvider, - - /// Type for `AsyncNotifierProvider` - asyncNotifierProvider, - - /// Type for `Provider` - provider; - - static LegacyProviderType? _parse(DartType providerType) { - if (anyFutureProviderType.isAssignableFromType(providerType)) { - return LegacyProviderType.futureProvider; - } - if (anyStreamProviderType.isAssignableFromType(providerType)) { - return LegacyProviderType.streamProvider; - } - if (anyStateProviderType.isAssignableFromType(providerType)) { - return LegacyProviderType.stateProvider; - } - if (anyStateNotifierProviderType.isAssignableFromType(providerType)) { - return LegacyProviderType.stateNotifierProvider; - } - if (anyProviderType.isAssignableFromType(providerType)) { - return LegacyProviderType.provider; - } - if (anyNotifierProviderType.isAssignableFromType(providerType)) { - return LegacyProviderType.notifierProvider; - } - if (anyAsyncNotifierProviderType.isAssignableFromType(providerType)) { - return LegacyProviderType.asyncNotifierProvider; - } - if (anyChangeNotifierProviderType.isAssignableFromType(providerType)) { - return LegacyProviderType.changeNotifierProvider; - } - - return null; - } -} - -class LegacyProviderDeclarationElement implements ProviderDeclarationElement { - LegacyProviderDeclarationElement._({ - required this.name, - required this.element, - required this.familyElement, - required this.providerType, - }); - - @internal - static LegacyProviderDeclarationElement? parse( - VariableElement element, - ) { - return _cache.putIfAbsent(element, () { - // Search for @ProviderFor annotation. If present, then this is a generated provider - if (providerForType.hasAnnotationOfExact( - element, - throwOnUnresolved: false, - )) { - return null; - } - - LegacyFamilyInvocationElement? familyElement; - LegacyProviderType? providerType; - if (providerBaseType.isAssignableFromType(element.type)) { - providerType = LegacyProviderType._parse(element.type); - } else if (familyType.isAssignableFromType(element.type)) { - final callFn = (element.type as InterfaceType).lookUpMethod2( - 'call', - element.library!, - )!; - final parameter = callFn.parameters.single; - - providerType = LegacyProviderType._parse(callFn.returnType); - familyElement = LegacyFamilyInvocationElement._(parameter.type); - } else { - // Not a provider - return null; - } - - return LegacyProviderDeclarationElement._( - name: element.name, - element: element, - familyElement: familyElement, - providerType: providerType, - ); - }); - } - - static final _cache = Expando<_Box>(); - - @override - final VariableElement element; - - @override - final String name; - - final LegacyFamilyInvocationElement? familyElement; - - final LegacyProviderType? providerType; -} - -class LegacyFamilyInvocationElement { - LegacyFamilyInvocationElement._(this.parameterType); - final DartType parameterType; -} - -// TODO changelog made sealed -sealed class GeneratorProviderDeclarationElement - implements ProviderDeclarationElement { - RiverpodAnnotationElement get annotation; - - /// Whether a provider has any form of parameter, be it function parameters - /// or type parameters. - bool get isFamily; - - bool get isScoped { - if (annotation.dependencies != null) return true; - - // TODO changelog isScoped now supports abstract build methods - // TODO test - final that = this; - return that is ClassBasedProviderDeclarationElement && - that.buildMethod.isAbstract; - } - - bool get isAutoDispose => !annotation.keepAlive; -} - -class ClassBasedProviderDeclarationElement - extends GeneratorProviderDeclarationElement { - ClassBasedProviderDeclarationElement._({ - required this.name, - required this.annotation, - required this.buildMethod, - required this.element, - }); - - @internal - static ClassBasedProviderDeclarationElement? parse( - ClassElement element, { - required RiverpodAnnotationElement? annotation, - }) { - return _cache.putIfAbsent(element, () { - final riverpodAnnotation = - annotation ?? RiverpodAnnotationElement.parse(element); - if (riverpodAnnotation == null) return null; - - final buildMethod = - element.methods.firstWhereOrNull((method) => method.name == 'build'); - - if (buildMethod == null) { - errorReporter?.call( - RiverpodAnalysisError( - 'No "build" method found. ' - 'Classes annotated with @riverpod must define a method named "build".', - targetElement: element, - code: RiverpodAnalysisErrorCode.missingNotifierBuild, - ), - ); - - return null; - } - - return ClassBasedProviderDeclarationElement._( - name: element.name, - buildMethod: buildMethod, - element: element, - annotation: riverpodAnnotation, - ); - }); - } - - static final _cache = Expando<_Box>(); - - @override - bool get isFamily { - return buildMethod.parameters.isNotEmpty || - element.typeParameters.isNotEmpty; - } - - @override - final ClassElement element; - - @override - final String name; - - @override - final RiverpodAnnotationElement annotation; - - final ExecutableElement buildMethod; -} - -class FunctionalProviderDeclarationElement - extends GeneratorProviderDeclarationElement { - FunctionalProviderDeclarationElement._({ - required this.name, - required this.annotation, - required this.element, - }); - - @internal - static FunctionalProviderDeclarationElement? parse( - ExecutableElement element, { - required RiverpodAnnotationElement? annotation, - }) { - return _cache.putIfAbsent(element, () { - final riverpodAnnotation = RiverpodAnnotationElement.parse(element); - if (riverpodAnnotation == null) return null; - - return FunctionalProviderDeclarationElement._( - name: element.name, - annotation: riverpodAnnotation, - element: element, - ); - }); - } - - static final _cache = Expando<_Box>(); - - @override - bool get isScoped => super.isScoped || element.isExternal; - - @override - bool get isFamily { - return element.parameters.length > 1 || element.typeParameters.isNotEmpty; - } - - @override - final ExecutableElement element; - - @override - final String name; - - @override - final RiverpodAnnotationElement annotation; -} - -/// An object for differentiating "no cache" from "cache but value is null". -class _Box { - _Box(this.value); - final T? value; -} - -extension on Expando<_Box> { - T? putIfAbsent(Object key, T? Function() value) { - final cache = this[key]; - if (cache != null) return cache.value; - - final box = this[key] = _Box(value()); - return box.value; - } -} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_types.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_types.dart index ca72dd611..ffb01e333 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_types.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_types.dart @@ -2,102 +2,11 @@ import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/dart/element/type.dart'; import 'package:custom_lint_core/custom_lint_core.dart'; -/// TypeChecker for the `ProviderFor` annotation -const providerForType = TypeChecker.fromName( - 'ProviderFor', - packageName: 'riverpod_annotation', -); - -/// Matches with the `Riverpod` annotation from riverpod_annotation. -const riverpodType = - TypeChecker.fromName('Riverpod', packageName: 'riverpod_annotation'); - -/// [TypeChecker] for `ProviderBase` -const providerBaseType = TypeChecker.fromName( - 'ProviderBase', - packageName: 'riverpod', -); - -/// [TypeChecker] from `ProviderContainer` -const providerContainerType = TypeChecker.fromName( - 'ProviderContainer', - packageName: 'riverpod', -); - -/// [TypeChecker] from `ProviderScope` -const providerScopeType = TypeChecker.fromName( - 'ProviderScope', - packageName: 'flutter_riverpod', -); - -/// [TypeChecker] from `ProviderScope` -const uncontrolledProviderScopeType = TypeChecker.fromName( - 'UncontrolledProviderScope', - packageName: 'flutter_riverpod', -); - -/// Either FutureProvider or AutoDisposeFutureProvider -const anyFutureProviderType = TypeChecker.fromName( - 'FutureProvider', - packageName: 'riverpod', -); - -/// Either StreamProvider or AutoDisposeStreamProvider -const anyStreamProviderType = TypeChecker.fromName( - 'StreamProvider', - packageName: 'riverpod', -); - -/// Either NotifierProvider or AutoDisposeNotifierProvider or their family form -const anyNotifierProviderType = TypeChecker.fromName( - r'$NotifierProvider', - packageName: 'riverpod', -); - -/// Either AsyncNotifierProvider or AutoDisposeAsyncNotifierProvider or their family form -const anyAsyncNotifierProviderType = TypeChecker.any([ - TypeChecker.fromName(r'$AsyncNotifierProvider', packageName: 'riverpod'), - TypeChecker.fromName(r'$StreamNotifierProvider', packageName: 'riverpod'), -]); - -/// Either ChangeNotifierProvider or AutoDisposeChangeNotifierProvider -const anyChangeNotifierProviderType = TypeChecker.fromName( - 'ChangeNotifierProvider', - packageName: 'flutter_riverpod', -); - -/// Either StateNotifierProvider or AutoDisposeStateNotifierProvider -const anyStateNotifierProviderType = TypeChecker.fromName( - 'StateNotifierProvider', - packageName: 'riverpod', -); - -/// [TypeChecker] for `StateNotifier` -const stateNotifierType = TypeChecker.fromName( - 'StateNotifier', - packageName: 'state_notifier', -); - -/// [TypeChecker] for `ChangeNotifier` -const changeNotifierType = TypeChecker.fromName( - 'ChangeNotifier', - packageName: 'flutter', -); - -/// Either StateProvider or AutoDisposeStateProvider -const anyStateProviderType = TypeChecker.fromName( - 'StateProvider', - packageName: 'riverpod', -); - -/// Either Provider or AutoDisposeProvider -const anyProviderType = TypeChecker.fromName( - 'Provider', - packageName: 'riverpod', -); - -/// [TypeChecker] for `Family` -const familyType = TypeChecker.fromName('Family', packageName: 'riverpod'); +part 'riverpod_types/core.dart'; +part 'riverpod_types/generator.dart'; +part 'riverpod_types/legacy_providers.dart'; +part 'riverpod_types/providers.dart'; +part 'riverpod_types/widgets.dart'; /// [TypeChecker] for `Future` const futureType = TypeChecker.fromUrl('dart:async#Future'); @@ -105,145 +14,11 @@ const futureType = TypeChecker.fromUrl('dart:async#Future'); /// [TypeChecker] for `Stream` const streamType = TypeChecker.fromUrl('dart:async#Stream'); -/// [TypeChecker] for `ProviderContainer` -const containerType = TypeChecker.fromName( - 'ProviderContainer', - packageName: 'riverpod', -); - -/// [TypeChecker] for `AsyncNotifierBase` -const asyncNotifierBaseType = TypeChecker.fromName( - r'$AsyncNotifier', - packageName: 'riverpod', -); - -/// [TypeChecker] for `AsyncNotifierBase` -const streamNotifierBaseType = TypeChecker.fromName( - r'$StreamNotifier', - packageName: 'riverpod', -); - -/// [TypeChecker] for `NotifierBase` -const notifierBaseType = TypeChecker.fromName( - r'$Notifier', - packageName: 'riverpod', -); - -/// Either `NotifierBase` or `AsyncNotifierBase` -const anyNotifierType = TypeChecker.any([ - asyncNotifierBaseType, - streamNotifierBaseType, - notifierBaseType, -]); - -/// Either `ProviderBase` or `Family` -const providerOrFamilyType = TypeChecker.any([providerBaseType, familyType]); - /// Either `FutureOr` or `Stream` const futureOrStreamType = TypeChecker.any([futureType, streamType]); -/// [TypeChecker] from `Widget` from Flutter -const widgetType = TypeChecker.fromName('Widget', packageName: 'flutter'); - -/// [TypeChecker] from `State` from Flutter -const widgetStateType = TypeChecker.fromName('State', packageName: 'flutter'); - -/// [TypeChecker] from `WidgetRef` -const widgetRefType = TypeChecker.fromName( - 'WidgetRef', - packageName: 'flutter_riverpod', -); - -/// Checks that the value is coming from a `package:riverpod` package -const isFromRiverpod = TypeChecker.fromPackage('riverpod'); - -/// Checks that the value is coming from a `package:riverpod_annotation` package -const isFromRiverpodAnnotation = TypeChecker.fromPackage('riverpod_annotation'); - -/// Checks that the value is coming from a `package:riverpod` package -const isFromFlutterRiverpod = TypeChecker.fromPackage('flutter_riverpod'); - -/// [TypeChecker for `Ref` -const refType = TypeChecker.fromName('Ref', packageName: 'riverpod'); - -bool _isBuiltInRef(DartType targetType) { - // Since Ref is sealed, checking that the function is from the package:riverpod - // before checking its type skips iterating over the superclasses of an element - // if it's not from Riverpod. - return isFromRiverpod.isExactlyType(targetType) && - refType.isAssignableFromType(targetType); -} - -bool isRiverpodRef(DartType targetType) { - final isBuiltInRef = _isBuiltInRef(targetType); - if (isBuiltInRef) return true; - - final targetElement = targetType.element; - - // Not a built-in ref. Might be a generated ref, let's check that. - if (targetElement is! MixinElement) return false; - final constraints = targetElement.superclassConstraints.singleOrNull; - if (constraints == null) return false; - - return _isBuiltInRef(constraints); -} - -/// Either `WidgetRef` or `Ref` -const anyRefType = TypeChecker.any([widgetRefType, refType]); - -/// [TypeChecker for `ConsumerWidget`` -const consumerWidgetType = TypeChecker.fromName( - 'ConsumerWidget', - packageName: 'flutter_riverpod', -); - -/// [TypeChecker for `HookConsumerWidget` -const hookConsumerWidgetType = TypeChecker.fromName( - 'HookConsumerWidget', - packageName: 'hooks_riverpod', -); - -/// [TypeChecker for `ConsumerStatefulWidget` -const consumerStatefulWidgetType = TypeChecker.fromName( - 'ConsumerStatefulWidget', - packageName: 'flutter_riverpod', -); - -/// [TypeChecker for `ConsumerState` -const consumerStateType = TypeChecker.fromName( - 'ConsumerState', - packageName: 'flutter_riverpod', -); - -/// [TypeChecker for `StatefulHookConsumerWidget` -const statefulHookConsumerStateType = TypeChecker.fromName( - 'StatefulHookConsumerWidget', - packageName: 'hooks_riverpod', -); - /// `Ref` methods that can make a provider depend on another provider. const refBinders = {'read', 'watch', 'listen'}; -/// [TypeChecker for `AsyncValue` -const asyncValueType = TypeChecker.fromName( - 'AsyncValue', - packageName: 'riverpod', -); - -/// [TypeChecker for `AsyncData` -const asyncDataType = TypeChecker.fromName( - 'AsyncData', - packageName: 'riverpod', -); - -/// [TypeChecker for `AsyncError` -const asyncErrorType = TypeChecker.fromName( - 'AsyncError', - packageName: 'riverpod', -); - -/// [TypeChecker for `AsyncLoading` -const asyncLoadingType = TypeChecker.fromName( - 'AsyncLoading', - packageName: 'riverpod', -); +/// Checks that the value is coming from a `package:flutter` package +const isFromFlutter = TypeChecker.fromPackage('flutter'); diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_types/core.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_types/core.dart new file mode 100644 index 000000000..01fdfe30e --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_types/core.dart @@ -0,0 +1,119 @@ +part of '../riverpod_types.dart'; + +/// [TypeChecker] for `Override` +const overrideType = TypeChecker.fromName( + 'Override', + packageName: 'riverpod', +); + +/// [TypeChecker] for `ProviderBase` +const providerBaseType = TypeChecker.fromName( + 'ProviderBase', + packageName: 'riverpod', +); + +/// [TypeChecker] for `ProviderListenable` +const providerListenableType = TypeChecker.fromName( + 'ProviderListenable', + packageName: 'riverpod', +); + +/// [TypeChecker] from `ProviderContainer` +const providerContainerType = TypeChecker.fromName( + 'ProviderContainer', + packageName: 'riverpod', +); + +/// [TypeChecker] from `ProviderScope` +const providerScopeType = TypeChecker.fromName( + 'ProviderScope', + packageName: 'flutter_riverpod', +); + +/// [TypeChecker] from `ProviderScope` +const uncontrolledProviderScopeType = TypeChecker.fromName( + 'UncontrolledProviderScope', + packageName: 'flutter_riverpod', +); + +/// [TypeChecker] from `WidgetRef` +const widgetRefType = TypeChecker.fromName( + 'WidgetRef', + packageName: 'flutter_riverpod', +); + +/// Checks that the value is coming from a `package:riverpod` package +const isFromRiverpod = TypeChecker.fromPackage('riverpod'); + +/// Checks that the value is coming from a `package:riverpod_annotation` package +const isFromRiverpodAnnotation = TypeChecker.fromPackage('riverpod_annotation'); + +/// Checks that the value is coming from a `package:riverpod` package +const isFromFlutterRiverpod = TypeChecker.fromPackage('flutter_riverpod'); + +/// Checks that the value is coming from a `package:riverpod` package +const isFromHooksRiverpod = TypeChecker.fromPackage('hooks_riverpod'); + +/// [TypeChecker for `Ref` +const refType = TypeChecker.fromName('Ref', packageName: 'riverpod'); + +bool _isBuiltInRef(DartType targetType) { + // Since Ref is sealed, checking that the function is from the package:riverpod + // before checking its type skips iterating over the superclasses of an element + // if it's not from Riverpod. + return isFromRiverpod.isExactlyType(targetType) && + refType.isAssignableFromType(targetType); +} + +bool isRiverpodRef(DartType targetType) { + final isBuiltInRef = _isBuiltInRef(targetType); + if (isBuiltInRef) return true; + + final targetElement = targetType.element; + + // Not a built-in ref. Might be a generated ref, let's check that. + if (targetElement is! MixinElement) return false; + final constraints = targetElement.superclassConstraints.singleOrNull; + if (constraints == null) return false; + + return _isBuiltInRef(constraints); +} + +/// Either `WidgetRef` or `Ref` +const anyRefType = TypeChecker.any([widgetRefType, refType]); + +/// [TypeChecker for `AsyncData` +const asyncDataType = TypeChecker.fromName( + 'AsyncData', + packageName: 'riverpod', +); + +/// [TypeChecker for `AsyncError` +const asyncErrorType = TypeChecker.fromName( + 'AsyncError', + packageName: 'riverpod', +); + +/// [TypeChecker for `AsyncLoading` +const asyncLoadingType = TypeChecker.fromName( + 'AsyncLoading', + packageName: 'riverpod', +); + +/// [TypeChecker for `AsyncValue` +const asyncValueType = TypeChecker.fromName( + 'AsyncValue', + packageName: 'riverpod', +); + +/// [TypeChecker] for `ProviderContainer` +const containerType = TypeChecker.fromName( + 'ProviderContainer', + packageName: 'riverpod', +); + +/// Either `ProviderBase` or `Family` +const providerOrFamilyType = TypeChecker.any([providerBaseType, familyType]); + +/// [TypeChecker] for `Family` +const familyType = TypeChecker.fromName('Family', packageName: 'riverpod'); diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_types/generator.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_types/generator.dart new file mode 100644 index 000000000..cdb126a55 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_types/generator.dart @@ -0,0 +1,19 @@ +part of '../riverpod_types.dart'; + +/// TypeChecker for the `ProviderFor` annotation +const providerForType = TypeChecker.fromName( + 'ProviderFor', + packageName: 'riverpod_annotation', +); + +/// Matches with the `Dependencies` annotation from riverpod_annotation. +const dependenciesType = TypeChecker.fromName( + 'Dependencies', + packageName: 'riverpod_annotation', +); + +/// Matches with the `Riverpod` annotation from riverpod_annotation. +const riverpodType = TypeChecker.fromName( + 'Riverpod', + packageName: 'riverpod_annotation', +); diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_types/legacy_providers.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_types/legacy_providers.dart new file mode 100644 index 000000000..0f8aad674 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_types/legacy_providers.dart @@ -0,0 +1,56 @@ +part of '../riverpod_types.dart'; + +/// Either ChangeNotifierProvider or AutoDisposeChangeNotifierProvider +const changeNotifierProviderType = TypeChecker.fromName( + 'ChangeNotifierProvider', + packageName: 'flutter_riverpod', +); + +/// Either StateNotifierProvider or AutoDisposeStateNotifierProvider +const stateNotifierProviderType = TypeChecker.fromName( + 'StateNotifierProvider', + packageName: 'riverpod', +); + +/// [TypeChecker] for `StateNotifier` +const stateNotifierType = TypeChecker.fromName( + 'StateNotifier', + packageName: 'state_notifier', +); + +/// [TypeChecker] for `ChangeNotifier` +const changeNotifierType = TypeChecker.fromName( + 'ChangeNotifier', + packageName: 'flutter', +); + +/// Either StateProvider or AutoDisposeStateProvider +const stateProviderType = TypeChecker.fromName( + 'StateProvider', + packageName: 'riverpod', +); + +/// [TypeChecker] for `AsyncNotifierBase` +const asyncNotifierBaseType = TypeChecker.fromName( + r'$AsyncNotifier', + packageName: 'riverpod', +); + +/// [TypeChecker] for `AsyncNotifierBase` +const streamNotifierBaseType = TypeChecker.fromName( + r'$StreamNotifier', + packageName: 'riverpod', +); + +/// [TypeChecker] for `NotifierBase` +const notifierBaseType = TypeChecker.fromName( + r'$Notifier', + packageName: 'riverpod', +); + +/// Either `NotifierBase` or `AsyncNotifierBase` +const anyNotifierType = TypeChecker.any([ + asyncNotifierBaseType, + streamNotifierBaseType, + notifierBaseType, +]); diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_types/providers.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_types/providers.dart new file mode 100644 index 000000000..2bf9aa31d --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_types/providers.dart @@ -0,0 +1,31 @@ +part of '../riverpod_types.dart'; + +/// FutureProvider +const futureProviderType = TypeChecker.fromName( + 'FutureProvider', + packageName: 'riverpod', +); + +/// StreamProvider +const streamProviderType = TypeChecker.fromName( + 'StreamProvider', + packageName: 'riverpod', +); + +/// NotifierProvider +const anyNotifierProviderType = TypeChecker.fromName( + r'$NotifierProvider', + packageName: 'riverpod', +); + +/// Either AsyncNotifierProvider or AutoDisposeAsyncNotifierProvider or their family form +const anyAsyncNotifierProviderType = TypeChecker.any([ + TypeChecker.fromName(r'$AsyncNotifierProvider', packageName: 'riverpod'), + TypeChecker.fromName(r'$StreamNotifierProvider', packageName: 'riverpod'), +]); + +/// Either Provider or AutoDisposeProvider +const providerType = TypeChecker.fromName( + 'Provider', + packageName: 'riverpod', +); diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_types/widgets.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_types/widgets.dart new file mode 100644 index 000000000..5712eb266 --- /dev/null +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_types/widgets.dart @@ -0,0 +1,85 @@ +part of '../riverpod_types.dart'; + +/// [TypeChecker] from `Widget` from Flutter +const widgetType = TypeChecker.fromName('Widget', packageName: 'flutter'); + +/// [TypeChecker] from `State` from Flutter +const widgetStateType = TypeChecker.fromName('State', packageName: 'flutter'); + +/// [TypeChecker for `ConsumerWidget`` +const statelessWidgetType = TypeChecker.fromName( + 'StatelessWidget', + packageName: 'flutter', +); + +/// [TypeChecker for `ConsumerWidget`` +const statefulWidgetType = TypeChecker.fromName( + 'StatefulWidget', + packageName: 'flutter', +); + +/// [TypeChecker for `ConsumerWidget`` +const stateType = TypeChecker.fromName( + 'State', + packageName: 'flutter', +); + +/// [TypeChecker for `ConsumerWidget`` +const consumerWidgetType = TypeChecker.fromName( + 'ConsumerWidget', + packageName: 'flutter_riverpod', +); + +/// [TypeChecker for `ConsumerStatefulWidget` +const consumerStatefulWidgetType = TypeChecker.fromName( + 'ConsumerStatefulWidget', + packageName: 'flutter_riverpod', +); + +/// [TypeChecker for `ConsumerState` +const consumerStateType = TypeChecker.fromName( + 'ConsumerState', + packageName: 'flutter_riverpod', +); + +/// [TypeChecker for `HookConsumerWidget` +const hookConsumerWidgetType = TypeChecker.fromName( + 'HookConsumerWidget', + packageName: 'hooks_riverpod', +); + +/// [TypeChecker for `StatefulHookConsumerWidget` +const statefulHookConsumerType = TypeChecker.fromName( + 'StatefulHookConsumerWidget', + packageName: 'hooks_riverpod', +); + +/// [TypeChecker for `HookConsumerWidget` +const hookWidgetType = TypeChecker.fromName( + 'HookWidget', + packageName: 'hooks_riverpod', +); + +/// [TypeChecker for `StatefulHookConsumerWidget` +const statefulHookType = TypeChecker.fromName( + 'StatefulHookWidget', + packageName: 'hooks_riverpod', +); + +bool isState(DartType type) { + return stateType.isExactlyType(type) || consumerStateType.isExactlyType(type); +} + +bool isStatelessWidget(DartType type) { + return statelessWidgetType.isExactlyType(type) || + consumerWidgetType.isExactlyType(type) || + hookConsumerWidgetType.isExactlyType(type) || + hookWidgetType.isExactlyType(type); +} + +bool isStatefulWidget(DartType type) { + return statefulWidgetType.isExactlyType(type) || + consumerStatefulWidgetType.isExactlyType(type) || + statefulHookConsumerType.isExactlyType(type) || + statefulHookType.isExactlyType(type); +} diff --git a/packages/riverpod_analyzer_utils_tests/test/analyzer_test_utils.dart b/packages/riverpod_analyzer_utils_tests/test/analyzer_test_utils.dart index 5c6d0189e..a7bb9965f 100644 --- a/packages/riverpod_analyzer_utils_tests/test/analyzer_test_utils.dart +++ b/packages/riverpod_analyzer_utils_tests/test/analyzer_test_utils.dart @@ -1,19 +1,48 @@ import 'dart:async'; import 'package:analyzer/dart/analysis/results.dart'; +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/ast/visitor.dart'; import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/diagnostic/diagnostic.dart'; import 'package:build/build.dart'; import 'package:build_test/build_test.dart'; +import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; -import 'package:riverpod_analyzer_utils/src/riverpod_ast.dart' - show - // ignore: invalid_use_of_internal_member - RiverpodAnalysisResult; +import 'package:riverpod_analyzer_utils/src/nodes.dart'; import 'package:riverpod_generator/src/riverpod_generator.dart'; import 'package:test/test.dart'; +@internal +extension ObjectX on T? { + R? cast() { + final that = this; + if (that is R) return that; + return null; + } + + R? let(R? Function(T value)? cb) { + if (cb == null) return null; + final that = this; + if (that != null) return cb(that); + return null; + } +} + +List collectErrors(void Function() cb) { + final errors = []; + final previousErrorReporter = errorReporter; + + try { + errorReporter = errors.add; + cb(); + return errors; + } finally { + errorReporter = previousErrorReporter; + } +} + int _testNumber = 0; /// Due to [resolveSource] throwing if trying to interact with the resolver @@ -22,15 +51,21 @@ int _testNumber = 0; @isTest void testSource( String description, - Future Function(Resolver resolver) run, { + Future Function( + Resolver resolver, + CompilationUnit unit, + List units, + ) run, { required String source, Map files = const {}, bool runGenerator = false, Timeout? timeout, + Object? skip, }) { final testId = _testNumber++; test( description, + skip: skip, timeout: timeout, () async { // Giving a unique name to the package to avoid the analyzer cache @@ -46,20 +81,33 @@ void testSource( 'library "${entry.key}"; ${entry.value}', }; + Future<(List, CompilationUnit)> getUnits( + Resolver resolver, + ) async { + final lib = await resolver.findLibraryByName('foo'); + + final ast = await lib!.session.getResolvedLibrary(lib.source.fullName); + ast as ResolvedLibraryResult; + + return ( + ast.units, + ast.units.firstWhere((e) => e.path.endsWith('foo.dart')).unit, + ); + } + String? generated; if (runGenerator) { - final analysisResult = await resolveSources( + generated = await resolveSources( { '$packageName|lib/foo.dart': sourceWithLibrary, ...otherSources, }, - (resolver) { - return resolver.resolveRiverpodLibraryResult( - ignoreErrors: true, - ); + (resolver) async { + final (_, unit) = await getUnits(resolver); + + return RiverpodGenerator(const {}).generateForUnit([unit]); }, ); - generated = RiverpodGenerator(const {}).runGenerator(analysisResult); } await resolveSources({ @@ -71,7 +119,19 @@ void testSource( try { final originalZone = Zone.current; return runZoned( - () => run(resolver), + () async { + final (units, unit) = await getUnits(resolver); + + try { + return await run(resolver, unit, units); + } finally { + collectErrors(() { + for (final unit in units) { + expectRiverpodAstOnlyHasASingleOptionPerNode(unit.unit); + } + }); + } + }, zoneSpecification: ZoneSpecification( // Somehow prints are captured inside the callback. Let's restore them print: (self, parent, zone, line) => enclosingZone.print(line), @@ -89,6 +149,33 @@ void testSource( ); } +/// Asserts that no [AstNode] has to Riverpod ast. +void expectRiverpodAstOnlyHasASingleOptionPerNode(AstNode node) { + final result = CollectionRiverpodAst(); + node.accept(result); + + for (final entry in result.riverpodAst.entries) { + expect( + entry.value, + anyOf( + hasLength(0), + hasLength(1), + ), + reason: entry.key, + ); + } + + node.visitChildren(_VisitNode(expectRiverpodAstOnlyHasASingleOptionPerNode)); +} + +class _VisitNode extends GeneralizingAstVisitor { + _VisitNode(this.cb); + + final void Function(AstNode node) cb; + @override + void visitNode(AstNode node) => cb(node); +} + extension MapTake on Map { Map take(List keys) { return { @@ -101,33 +188,53 @@ extension MapTake on Map { } } -extension ResolverX on Resolver { - // ignore: invalid_use_of_internal_member - Future resolveRiverpodAnalysisResult({ - String libraryName = 'foo', - bool ignoreErrors = false, - }) async { - final riverpodAst = await resolveRiverpodLibraryResult( - libraryName: libraryName, - ignoreErrors: ignoreErrors, - ); +extension TakeList on List { + Map takeAll(List names) { + final result = Map.fromEntries(map((e) => MapEntry(e.name.lexeme, e))); + return result.take(names); + } - final result = RiverpodAnalysisResult(); - riverpodAst.accept(result); + T findByName(String name) { + return singleWhere((element) => element.name.lexeme == name); + } +} - if (!ignoreErrors) { - final errors = result.resolvedRiverpodLibraryResults - .expand((e) => e.errors) - .toList(); - if (errors.isNotEmpty) { - throw StateError(errors.map((e) => '- $e\n').join()); +extension FindAst on List { + T findByName(String name) { + for (final node in this) { + switch (node) { + case TopLevelVariableDeclaration(): + final variableWithName = node.variables.variables.firstWhereOrNull( + (element) => element.name.lexeme == name, + ); + + if (variableWithName != null) return variableWithName as T; + + case MethodDeclaration(): + if (node.name.lexeme == name) return node as T; + + case FieldDeclaration(): + final variableWithName = node.fields.variables.firstWhereOrNull( + (element) => element.name.lexeme == name, + ); + + if (variableWithName != null) return variableWithName as T; + + case NamedCompilationUnitMember(): + if (node.name.lexeme == name) return node as T; + + default: + throw UnsupportedError('Unsupported node ${node.runtimeType}'); } } - return result; + throw StateError('No node found with name "$name"'); } +} - Future resolveRiverpodLibraryResult({ +extension ResolverX on Resolver { + // ignore: invalid_use_of_internal_member + Future resolveRiverpodAnalysisResult({ String libraryName = 'foo', bool ignoreErrors = false, }) async { @@ -139,11 +246,33 @@ extension ResolverX on Resolver { await library.session.getResolvedLibraryByElement(library); libraryAst as ResolvedLibraryResult; - final result = ResolvedRiverpodLibraryResult.from( - libraryAst.units.map((e) => e.unit).toList(), - ); + final result = RiverpodAnalysisResult(); + + final errors = []; + final previousErrorReporter = errorReporter; + try { + if (ignoreErrors) { + errorReporter = errors.add; + } else { + errorReporter = (error) { + throw StateError('Unexpected error: $error'); + }; + } + + for (final unit in libraryAst.units) { + unit.unit.accept(result); + } + } finally { + errorReporter = previousErrorReporter; + } - expectValidParentChildrenRelationship(result); + result.errors.addAll(errors); + + if (!ignoreErrors) { + if (errors.isNotEmpty) { + throw StateError(errors.map((e) => '- $e\n').join()); + } + } return result; } @@ -178,49 +307,3 @@ ${errors.map((e) => '- $e\n').join()} return library; } } - -/// Visit all the nodes of the AST and ensure that that all children -/// have the correct parent. -void expectValidParentChildrenRelationship( - ResolvedRiverpodLibraryResult result, -) { - result.accept(_ParentRiverpodVisitor(null)); -} - -class _ParentRiverpodVisitor extends GeneralizingRiverpodAstVisitor { - _ParentRiverpodVisitor(this.expectedParent); - - final RiverpodAst? expectedParent; - - @override - void visitRiverpodAst( - RiverpodAst node, - ) { - expect( - node.parent, - expectedParent, - reason: 'Node ${node.runtimeType} should have $expectedParent as parent', - ); - node.visitChildren(_ParentRiverpodVisitor(node)); - } -} - -extension TakeList on List { - Map takeAll(List names) { - final result = Map.fromEntries(map((e) => MapEntry(e.name.lexeme, e))); - return result.take(names); - } - - T findByName(String name) { - return singleWhere((element) => element.name.lexeme == name); - } -} - -extension LibraryElementX on LibraryElement { - Element findElementWithName(String name) { - return topLevelElements.singleWhere( - (element) => !element.isSynthetic && element.name == name, - orElse: () => throw StateError('No element found with name "$name"'), - ); - } -} diff --git a/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart b/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart index 2229fdd26..046c16767 100644 --- a/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/consumer_test.dart @@ -19,38 +19,12 @@ class ProviderWidget extends ConsumerWidget { return Container(); } } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); - final consumerWidget = result.consumerWidgetDeclarations.single; - expect(consumerWidget, isA()); + final consumerWidget = result.widgetDeclarations.single; + expect(consumerWidget, isA()); expect(consumerWidget.node.name.toString(), 'ProviderWidget'); - expect( - consumerWidget.buildMethod!.toSource(), - '@override Widget build(BuildContext context, WidgetRef ref) {ref.watch(provider); return Container();}', - ); - - expect(consumerWidget.widgetRefInvocations, [ - isA() - .having((e) => e.node.toSource(), 'node', 'ref.watch(provider)') - .having( - (e) => e.provider, - 'provider', - isA() - .having((e) => e.node.toSource(), 'node', 'provider') - .having( - (e) => e.providerElement, - 'providerElement', - isA() - .having((e) => e.providerType, 'providerType', null), - ), - ), - ]); - - expect( - result.resolvedRiverpodLibraryResults.single.unknownWidgetRefInvocations, - isEmpty, - ); }); testSource('Decode ConsumerWidget declarations', source: ''' @@ -68,27 +42,12 @@ class MyConsumerWidget extends ConsumerWidget { return Container(); } } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); - final consumerWidget = result.consumerWidgetDeclarations.single; - expect(consumerWidget, isA()); + final consumerWidget = result.widgetDeclarations.single; + expect(consumerWidget, isA()); expect(consumerWidget.node.name.toString(), 'MyConsumerWidget'); - expect( - consumerWidget.buildMethod!.toSource(), - '@override Widget build(BuildContext context, WidgetRef ref) {ref.watch(provider); return Container();}', - ); - - expect( - result.resolvedRiverpodLibraryResults.single.unknownWidgetRefInvocations, - isEmpty, - ); - - expect(consumerWidget.widgetRefInvocations, hasLength(1)); - expect( - consumerWidget.widgetRefInvocations.single, - isA(), - ); }); testSource('Decode HookConsumerWidgetDeclaration declarations', source: ''' @@ -106,27 +65,12 @@ class MyConsumerWidget extends HookConsumerWidget { return Container(); } } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); - final consumerWidget = result.hookConsumerWidgetDeclarations.single; - expect(consumerWidget, isA()); + final consumerWidget = result.widgetDeclarations.single; + expect(consumerWidget, isA()); expect(consumerWidget.node.name.toString(), 'MyConsumerWidget'); - expect( - consumerWidget.buildMethod!.toSource(), - '@override Widget build(BuildContext context, WidgetRef ref) {ref.watch(provider); return Container();}', - ); - - expect( - result.resolvedRiverpodLibraryResults.single.unknownWidgetRefInvocations, - isEmpty, - ); - - expect(consumerWidget.widgetRefInvocations, hasLength(1)); - expect( - consumerWidget.widgetRefInvocations.single, - isA(), - ); }); testSource('Decode ConsumerStatefulWidgetDeclarations declarations', @@ -157,34 +101,19 @@ class MyConsumerState extends ConsumerState { return Container(); } } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); - final consumerWidget = result.consumerStatefulWidgetDeclarations.single; - final consumerState = result.consumerStateDeclarations.single; + final consumerWidget = + result.widgetDeclarations.single as StatefulWidgetDeclaration; + final consumerState = result.stateDeclarations.single; - expect(consumerWidget, isA()); expect(consumerWidget.node.name.toString(), 'MyConsumerWidget'); + expect(consumerWidget.state, consumerState.element); - expect(consumerState, isA()); expect(consumerState.node.name.toString(), 'MyConsumerState'); - - expect( - result.resolvedRiverpodLibraryResults.single.unknownWidgetRefInvocations, - isEmpty, - ); - - expect(consumerState.widgetRefInvocations, hasLength(2)); - expect( - consumerState.widgetRefInvocations[0], - isA() - .having((e) => e.node.toSource(), 'node', 'ref.watch(provider)'), - ); - expect( - consumerState.widgetRefInvocations[1], - isA() - .having((e) => e.node.toSource(), 'node', 'ref.watch(provider2)'), - ); + expect(consumerState.widget, consumerWidget.element); + expect(consumerState.element.widget, consumerWidget.element); }); testSource('Decode StatefulHookConsumerWidgetDeclaration declarations', @@ -211,37 +140,21 @@ class MyConsumerState extends ConsumerState { @override Widget build(BuildContext context) { - ref.watch(provider2); return Container(); } } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); - final consumerWidget = result.statefulHookConsumerWidgetDeclarations.single; - final consumerState = result.consumerStateDeclarations.single; + final consumerWidget = + result.widgetDeclarations.single as StatefulWidgetDeclaration; + final consumerState = result.stateDeclarations.single; - expect(consumerWidget, isA()); expect(consumerWidget.node.name.toString(), 'MyConsumerWidget'); + expect(consumerWidget.state, consumerState.element); - expect(consumerState, isA()); expect(consumerState.node.name.toString(), 'MyConsumerState'); - - expect( - result.resolvedRiverpodLibraryResults.single.unknownWidgetRefInvocations, - isEmpty, - ); - - expect(consumerState.widgetRefInvocations, hasLength(2)); - expect( - consumerState.widgetRefInvocations[0], - isA() - .having((e) => e.node.toSource(), 'node', 'ref.watch(provider)'), - ); - expect( - consumerState.widgetRefInvocations[1], - isA() - .having((e) => e.node.toSource(), 'node', 'ref.watch(provider2)'), - ); + expect(consumerState.widget, consumerWidget.element); + expect(consumerState.element.widget, consumerWidget.element); }); } diff --git a/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart b/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart index 24e812cbc..c6e05c054 100644 --- a/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart @@ -1,6 +1,5 @@ import 'package:analyzer/dart/element/type.dart'; -import 'package:riverpod_analyzer_utils/src/riverpod_ast.dart'; -import 'package:riverpod_analyzer_utils/src/riverpod_element.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import 'package:test/test.dart'; import 'analyzer_test_utils.dart'; @@ -34,7 +33,7 @@ Provider Function() get getter => () => Provider((ref) => 0); final unknown5 = getter(); ''', - (resolver) async { + (resolver, unit, units) async { // Regression test for https://github.com/rrousselGit/riverpod/issues/2313 final result = await resolver.resolveRiverpodAnalysisResult(); @@ -62,7 +61,7 @@ int simple(SimpleRef ref) => 0; // Regression test for https://github.com/rrousselGit/riverpod/issues/2194 @riverpod int complex(ComplexRef ref, {int? id, String? another}) => 0; -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); expect(result.legacyProviderDeclarations, hasLength(1)); @@ -74,7 +73,7 @@ import 'package:riverpod/riverpod.dart'; final first = Provider((ref) => 0); final second = Provider((ref) => 0); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll(['first', 'second']); @@ -137,7 +136,7 @@ final autoDisposeFamily2 = Provider.family.autoDispose( (ref, id) => 0, dependencies: [dep, family, family(42), ...getDeps()], ); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); final deps = result.legacyProviderDeclarations.takeAll([ 'dep', @@ -172,7 +171,7 @@ final autoDisposeFamily2 = Provider.family.autoDispose( expect(unknownDependencies.dependencies, isNotNull); expect(unknownDependencies.dependencies?.dependencies, isNull); expect( - unknownDependencies.dependencies?.dependenciesNode.toSource(), + unknownDependencies.dependencies?.node.toSource(), 'dependencies: getDeps()', ); @@ -183,7 +182,7 @@ final autoDisposeFamily2 = Provider.family.autoDispose( reason: '${provider.key} has no dependency', ); expect( - provider.value.dependencies?.dependenciesNode.toSource(), + provider.value.dependencies?.node.toSource(), 'dependencies: []', ); } @@ -196,7 +195,7 @@ final autoDisposeFamily2 = Provider.family.autoDispose( ); expect( - provider.value.dependencies?.dependenciesNode.toSource(), + provider.value.dependencies?.node.toSource(), 'dependencies: [dep, family, family(42), ...getDeps()]', ); @@ -205,7 +204,7 @@ final autoDisposeFamily2 = Provider.family.autoDispose( isA() .having((e) => e.node.toSource(), 'node', 'dep') .having( - (e) => e.provider?.providerElement, + (e) => e.provider?.provider?.providerElement, 'provider', same(deps['dep']?.providerElement), ), @@ -216,7 +215,7 @@ final autoDisposeFamily2 = Provider.family.autoDispose( isA() .having((e) => e.node.toSource(), 'node', 'family') .having( - (e) => e.provider?.providerElement, + (e) => e.provider?.provider?.providerElement, 'provider', same(deps['family']?.providerElement), ), @@ -227,7 +226,7 @@ final autoDisposeFamily2 = Provider.family.autoDispose( isA() .having((e) => e.node.toSource(), 'node', 'family(42)') .having( - (e) => e.provider?.providerElement, + (e) => e.provider?.provider?.providerElement, 'provider', same(deps['family']?.providerElement), ), @@ -237,7 +236,11 @@ final autoDisposeFamily2 = Provider.family.autoDispose( provider.value.dependencies?.dependencies?[3], isA() .having((e) => e.node.toSource(), 'node', '...getDeps()') - .having((e) => e.provider?.providerElement, 'provider', null), + .having( + (e) => e.provider?.provider?.providerElement, + 'provider', + null, + ), reason: '${provider.key} has an unknown expression as fourth dependency', ); @@ -248,7 +251,7 @@ final autoDisposeFamily2 = Provider.family.autoDispose( hasLength(2), ); expect( - generatorDependencies.dependencies?.dependenciesNode.toSource(), + generatorDependencies.dependencies?.node.toSource(), 'dependencies: [dep2Provider, family2Provider]', ); expect( @@ -256,7 +259,7 @@ final autoDisposeFamily2 = Provider.family.autoDispose( isA() .having((e) => e.node.toSource(), 'node', 'dep2Provider') .having( - (e) => e.provider?.providerElement, + (e) => e.provider?.provider?.providerElement, 'provider', same( result.generatorProviderDeclarations @@ -270,7 +273,7 @@ final autoDisposeFamily2 = Provider.family.autoDispose( isA() .having((e) => e.node.toSource(), 'node', 'family2Provider') .having( - (e) => e.provider?.providerElement, + (e) => e.provider?.provider?.providerElement, 'provider', same( result.generatorProviderDeclarations @@ -290,7 +293,7 @@ final explicitAlwaysAliveFamily = ProviderFamily((ref, id) => 0); final autoDisposeProvider = Provider.autoDispose((ref) => 0); final autoDisposeFamily = Provider.autoDispose.family((ref, id) => 0); final autoDisposeFamily2 = Provider.family.autoDispose((ref, id) => 0); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ 'alwaysAliveProvider', @@ -322,7 +325,7 @@ final family = Provider.family((ref, id) => 0, name: 'bar'); final autoDisposeFamily = Provider.autoDispose.family((ref, id) => 0); final weird = Provider(name: 'foo', dependencies: [], (ref) => 0); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ 'inferred', @@ -379,7 +382,7 @@ final weird = Provider(name: 'foo', dependencies: [], (ref) => 0); "(name: 'foo', dependencies: [], (ref) => 0)", ); expect( - providers['weird']?.dependencies?.dependenciesNode.toSource(), + providers['weird']?.dependencies?.node.toSource(), 'dependencies: []', ); expect(providers['weird']?.build.toSource(), '(ref) => 0'); @@ -394,7 +397,7 @@ final explicitAlwaysAliveFamily = FutureProviderFamily((ref, id) => 0) final autoDisposeProvider = FutureProvider.autoDispose((ref) => 0); final autoDisposeFamily = FutureProvider.autoDispose.family((ref, id) => 0); final autoDisposeFamily2 = FutureProvider.family.autoDispose((ref, id) => 0); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ 'alwaysAliveProvider', @@ -423,7 +426,7 @@ final explicitAlwaysAliveFamily = StateProviderFamily((ref, id) => 0); final autoDisposeProvider = StateProvider.autoDispose((ref) => 0); final autoDisposeFamily = StateProvider.autoDispose.family((ref, id) => 0); final autoDisposeFamily2 = StateProvider.family.autoDispose((ref, id) => 0); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ 'alwaysAliveProvider', @@ -452,7 +455,7 @@ final explicitAlwaysAliveFamily = StreamProviderFamily((ref, id) => St final autoDisposeProvider = StreamProvider.autoDispose((ref) => Stream.empty()); final autoDisposeFamily = StreamProvider.autoDispose.family((ref, id) => Stream.empty()); final autoDisposeFamily2 = StreamProvider.family.autoDispose((ref, id) => Stream.empty()); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ 'alwaysAliveProvider', @@ -481,7 +484,7 @@ final explicitAlwaysAliveFamily = NotifierProviderFamily, int>(() => throw UnimplementedError()); final autoDisposeFamily = NotifierProvider.autoDispose.family, int, int>(() => throw UnimplementedError()); final autoDisposeFamily2 = NotifierProvider.family.autoDispose, int, int>(() => throw UnimplementedError()); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ 'alwaysAliveProvider', @@ -510,7 +513,7 @@ final explicitAlwaysAliveFamily = AsyncNotifierProviderFamily, int>(() => throw UnimplementedError()); final autoDisposeFamily = AsyncNotifierProvider.autoDispose.family, int, int>(() => throw UnimplementedError()); final autoDisposeFamily2 = AsyncNotifierProvider.family.autoDispose, int, int>(() => throw UnimplementedError()); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ 'alwaysAliveProvider', @@ -540,7 +543,7 @@ final explicitAlwaysAliveFamily = ChangeNotifierProviderFamily>((ref) => ValueNotifier(0)); final autoDisposeFamily = ChangeNotifierProvider.autoDispose.family, int>((ref, id) => ValueNotifier(0)); final autoDisposeFamily2 = ChangeNotifierProvider.family.autoDispose, int>((ref, id) => ValueNotifier(0)); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ 'alwaysAliveProvider', @@ -569,7 +572,7 @@ final explicitAlwaysAliveFamily = StateNotifierProviderFamily, int>((ref) => StateController(0)); final autoDisposeFamily = StateNotifierProvider.autoDispose.family, int, int>((ref, id) => StateController(0)); final autoDisposeFamily2 = StateNotifierProvider.family.autoDispose, int, int>((ref, id) => StateController(0)); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ 'alwaysAliveProvider', @@ -599,7 +602,7 @@ final alwaysAliveFamily = Provider.family((ref, id) => 0); final explicitAlwaysAliveFamily = ProviderFamily((ref, id) => 0); final autoDisposeFamily = Provider.autoDispose.family((ref, id) => 0); final autoDisposeFamily2 = Provider.family.autoDispose((ref, id) => 0); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); final providers = result.legacyProviderDeclarations.takeAll([ 'alwaysAliveProvider', diff --git a/packages/riverpod_analyzer_utils_tests/test/matchers.dart b/packages/riverpod_analyzer_utils_tests/test/matchers.dart new file mode 100644 index 000000000..fa13158dd --- /dev/null +++ b/packages/riverpod_analyzer_utils_tests/test/matchers.dart @@ -0,0 +1,344 @@ +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import 'package:test/test.dart'; + +TypeMatcher + isLegacyProviderDeclarationElement({ + Object? element = const Object(), + Object? name = const Object(), + Object? familyElement = const Object(), + Object? providerType = const Object(), +}) { + var matcher = isA(); + + if (element != const Object()) { + matcher = matcher.having( + (e) => e.element, + 'element', + element, + ); + } + + if (name != const Object()) { + matcher = matcher.having( + (e) => e.name, + 'name', + name, + ); + } + + if (familyElement != const Object()) { + matcher = matcher.having( + (e) => e.familyElement, + 'familyElement', + familyElement, + ); + } + + if (providerType != const Object()) { + matcher = matcher.having( + (e) => e.providerType, + 'providerType', + providerType, + ); + } + + return matcher; +} + +TypeMatcher isProviderIdentifier({ + Object? node = const Object(), + Object? providerElement = const Object(), + Object? annotation = const Object(), +}) { + var matcher = isA(); + + if (node != const Object()) { + matcher = matcher.having( + (e) => e.node, + 'node', + node, + ); + } + + if (providerElement != const Object()) { + matcher = matcher.having( + (e) => e.providerElement, + 'providerElement', + providerElement, + ); + } + + return matcher; +} + +TypeMatcher + isFunctionalProviderDeclarationElement({ + Object? name = const Object(), + Object? element = const Object(), + Object? annotation = const Object(), +}) { + var matcher = isA(); + + if (name != const Object()) { + matcher = matcher.having( + (e) => e.name, + 'name', + name, + ); + } + + if (element != const Object()) { + matcher = matcher.having( + (e) => e.element, + 'element', + element, + ); + } + + if (annotation != const Object()) { + matcher = matcher.having( + (e) => e.annotation, + 'annotation', + annotation, + ); + } + + return matcher; +} + +TypeMatcher + isClassBasedProviderDeclarationElement({ + Object? name = const Object(), + Object? element = const Object(), + Object? annotation = const Object(), +}) { + var matcher = isA(); + + if (name != const Object()) { + matcher = matcher.having( + (e) => e.name, + 'name', + name, + ); + } + + if (element != const Object()) { + matcher = matcher.having( + (e) => e.element, + 'element', + element, + ); + } + + if (annotation != const Object()) { + matcher = matcher.having( + (e) => e.annotation, + 'annotation', + annotation, + ); + } + + return matcher; +} + +TypeMatcher isDependencies({ + Object? node = const Object(), + Object? element = const Object(), + Object? dependenciesNode = const Object(), + Object? dependencies = const Object(), +}) { + var matcher = isA(); + + if (node != const Object()) { + matcher = matcher.having( + (e) => e.node, + 'node', + node, + ); + } + + if (element != const Object()) { + matcher = matcher.having( + (e) => e.element, + 'element', + element, + ); + } + + if (dependencies != const Object()) { + matcher = matcher.having( + (e) => e.dependencies, + 'dependencies', + dependencies, + ); + } + + if (dependenciesNode != const Object()) { + matcher = matcher.having( + (e) => e.dependenciesNode, + 'dependenciesNode', + dependenciesNode, + ); + } + + return matcher; +} + +TypeMatcher isDependenciesElement({ + Object? element = const Object(), + Object? dependencies = const Object(), +}) { + var matcher = isA(); + + if (element != const Object()) { + matcher = matcher.having( + (e) => e.element, + 'element', + element, + ); + } + + if (dependencies != const Object()) { + matcher = matcher.having( + (e) => e.dependencies, + 'dependencies', + dependencies, + ); + } + + return matcher; +} + +TypeMatcher isRiverpod({ + Object? node = const Object(), + Object? element = const Object(), + Object? keepAlive = const Object(), + Object? dependenciesNode = const Object(), + Object? dependencyList = const Object(), +}) { + var matcher = isA(); + + if (node != const Object()) { + matcher = matcher.having( + (e) => e.node, + 'node', + node, + ); + } + + if (element != const Object()) { + matcher = matcher.having( + (e) => e.element, + 'element', + element, + ); + } + + if (keepAlive != const Object()) { + matcher = matcher.having( + (e) => e.keepAliveNode, + 'keepAliveNode', + keepAlive, + ); + } + + if (dependencyList != const Object()) { + matcher = matcher.having( + (e) => e.dependencyList, + 'dependencyList', + dependencyList, + ); + } + + if (dependenciesNode != const Object()) { + matcher = matcher.having( + (e) => e.dependenciesNode, + 'dependenciesNode', + dependenciesNode, + ); + } + + return matcher; +} + +TypeMatcher isProviderDependency({ + Object? node = const Object(), + Object? provider = const Object(), +}) { + var matcher = isA(); + + if (node != const Object()) { + matcher = matcher.having( + (e) => e.node, + 'node', + node, + ); + } + + if (provider != const Object()) { + matcher = matcher.having( + (e) => e.provider, + 'provider', + provider, + ); + } + + return matcher; +} + +TypeMatcher isProviderDependencyList({ + Object? node = const Object(), + Object? values = const Object(), +}) { + var matcher = isA(); + + if (node != const Object()) { + matcher = matcher.having( + (e) => e.node, + 'node', + node, + ); + } + + if (values != const Object()) { + matcher = matcher.having( + (e) => e.values, + 'values', + values, + ); + } + + return matcher; +} + +TypeMatcher isRiverpodAnnotationElement({ + Object? keepAlive = const Object(), + Object? dependencies = const Object(), +}) { + var matcher = isA(); + + if (keepAlive != const Object()) { + matcher = matcher.having( + (e) => e.keepAlive, + 'keepAlive', + keepAlive, + ); + } + + if (dependencies != const Object()) { + matcher = matcher.having( + (e) => e.dependencies, + 'dependencies', + dependencies, + ); + } + + return matcher; +} + +Matcher hasToString(Object? expected) { + return predicate( + (e) => e.toString() == expected.toString(), + 'toString', + ); +} diff --git a/packages/riverpod_analyzer_utils_tests/test/nodes/dependencies_test.dart b/packages/riverpod_analyzer_utils_tests/test/nodes/dependencies_test.dart new file mode 100644 index 000000000..d5c526523 --- /dev/null +++ b/packages/riverpod_analyzer_utils_tests/test/nodes/dependencies_test.dart @@ -0,0 +1,97 @@ +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/element/element.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import 'package:test/test.dart'; + +import '../analyzer_test_utils.dart'; +import '../matchers.dart'; + +void main() { + testSource('Decodes Dependencies', runGenerator: true, source: r''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter/material.dart'; + +@riverpod +int a(ARef ref) => 0; + +@riverpod +class B extends _$B { + @override + int build() => 0; +} + +@riverpod +int c(CRef ref, int arg) => 0; + +@riverpod +class D extends _$D { + @override + int build(int arg) => 0; +} + +@Dependencies([a, B, c, D]) +class Class {} + +@Dependencies([a, B, c, D]) +void function() {} + +void main() { + @Dependencies([a, B, c, D]) + var value = 0; +} +''', (resolver, unit, units) async { + final clazz = unit.declarations.findByName('Class'); + final function = unit.declarations.findByName('function'); + + final value = unit.declarations + .findByName('main') + .functionExpression + .body + .cast()! + .block + .statements + .whereType() + .single; + + expect( + clazz.dependencies, + isDependencies( + node: hasToString('@Dependencies([a, B, c, D])'), + dependenciesNode: hasToString('[a, B, c, D]'), + element: isDependenciesElement( + element: isA().having( + (e) => e.toSource(), + 'toSource', + '@Dependencies([a, B, c, D])', + ), + dependencies: [ + isFunctionalProviderDeclarationElement(name: 'a'), + isClassBasedProviderDeclarationElement(name: 'B'), + isFunctionalProviderDeclarationElement(name: 'c'), + isClassBasedProviderDeclarationElement(name: 'D'), + ], + ), + dependencies: isProviderDependencyList( + values: [ + isProviderDependency( + provider: isFunctionalProviderDeclarationElement(name: 'a'), + ), + isProviderDependency( + provider: isClassBasedProviderDeclarationElement(name: 'B'), + ), + isProviderDependency( + provider: isFunctionalProviderDeclarationElement(name: 'c'), + ), + isProviderDependency( + provider: isClassBasedProviderDeclarationElement(name: 'D'), + ), + ], + ), + ), + ); + + expect(function.dependencies, isDependencies()); + expect(value.variables.dependencies, isDependencies()); + }); +} diff --git a/packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart b/packages/riverpod_analyzer_utils_tests/test/nodes/providers/generated_providers_test.dart similarity index 67% rename from packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart rename to packages/riverpod_analyzer_utils_tests/test/nodes/providers/generated_providers_test.dart index c3513773a..764df0cdc 100644 --- a/packages/riverpod_analyzer_utils_tests/test/generator_provider_declaration_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/nodes/providers/generated_providers_test.dart @@ -1,7 +1,9 @@ -import 'package:riverpod_analyzer_utils/src/riverpod_ast.dart'; +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:collection/collection.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import 'package:test/test.dart'; -import 'analyzer_test_utils.dart'; +import '../../analyzer_test_utils.dart'; void main() { testSource('Parses element.isFamily', source: r''' @@ -33,27 +35,14 @@ class ParametrizedClass extends _$ParametrizedClass { @override int build(int id) => throw UnimplementedError(); } -''', (resolver) async { - final result = await resolver.resolveRiverpodAnalysisResult(); - - final generic = result.generatorProviderDeclarations.singleWhere( - (e) => e.name.toString() == 'generic', - ); - final genericClass = result.generatorProviderDeclarations.singleWhere( - (e) => e.name.toString() == 'GenericClass', - ); - final value = result.generatorProviderDeclarations.singleWhere( - (e) => e.name.toString() == 'value', - ); - final valueClass = result.generatorProviderDeclarations.singleWhere( - (e) => e.name.toString() == 'ValueClass', - ); - final parametrized = result.generatorProviderDeclarations.singleWhere( - (e) => e.name.toString() == 'parametrized', - ); - final parametrizedClass = result.generatorProviderDeclarations.singleWhere( - (e) => e.name.toString() == 'ParametrizedClass', - ); +''', (resolver, unit, units) async { + final generic = unit.declarations.findByName('generic').provider!; + final genericClass = unit.declarations.findByName('GenericClass').provider!; + final value = unit.declarations.findByName('value').provider!; + final valueClass = unit.declarations.findByName('ValueClass').provider!; + final parametrized = unit.declarations.findByName('parametrized').provider!; + final parametrizedClass = + unit.declarations.findByName('ParametrizedClass').provider!; expect(generic.providerElement.isFamily, true); expect(genericClass.providerElement.isFamily, true); @@ -76,18 +65,13 @@ Future value2(Value2Ref ref) async => 0; @riverpod Future> value3(Value3Ref ref) async => 0; -''', (resolver) async { - final result = await resolver.resolveRiverpodAnalysisResult(); - - final value = result.functionalProviderDeclarations.singleWhere( - (e) => e.name.toString() == 'value', - ); - final value2 = result.functionalProviderDeclarations.singleWhere( - (e) => e.name.toString() == 'value2', - ); - final value3 = result.functionalProviderDeclarations.singleWhere( - (e) => e.name.toString() == 'value3', - ); +''', (resolver, unit, units) async { + final value = + unit.declarations.findByName('value').provider!; + final value2 = + unit.declarations.findByName('value2').provider!; + final value3 = + unit.declarations.findByName('value3').provider!; expect(value.createdTypeNode.toString(), 'Raw>'); expect(value.createdTypeDisplayString, 'Raw>'); expect(value.exposedTypeNode.source, 'Raw>'); @@ -120,105 +104,24 @@ Future> value3(Value3Ref ref) async => 0; expect(value3.valueTypeNode!.type!.isRaw, true); }); - testSource('Decode needsOverride/isScoped', source: ''' + testSource('Decode isScoped', source: ''' import 'package:riverpod_annotation/riverpod_annotation.dart'; -@riverpod -external int needsOverride(); - @Riverpod(dependencies: []) int scoped() => 0; @riverpod int plain(PlainRef ref) => 0; -''', (resolver) async { - final result = await resolver.resolveRiverpodAnalysisResult(); - - final needsOverride = result.functionalProviderDeclarations.singleWhere( - (e) => e.name.toString() == 'needsOverride', - ); - final scoped = result.functionalProviderDeclarations.singleWhere( - (e) => e.name.toString() == 'scoped', - ); - final plain = result.functionalProviderDeclarations.singleWhere( - (e) => e.name.toString() == 'plain', - ); - - expect(needsOverride.needsOverride, true); - expect(scoped.needsOverride, false); - expect(plain.needsOverride, false); - - expect(needsOverride.providerElement.isScoped, true); +''', (resolver, unit, units) async { + final scoped = + unit.declarations.findByName('scoped').provider!; + final plain = + unit.declarations.findByName('plain').provider!; + expect(scoped.providerElement.isScoped, true); expect(plain.providerElement.isScoped, false); }); - testSource('Decode dependencies with syntax errors', source: ''' -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -const deps = []; - -@Riverpod(dependencies: deps) -int first(FirstRef ref) => 0; - -@Riverpod(dependencies: ) -int second(SecondRef ref) => 0; - -@Riverpod(dependencies: [gibberish]) -int forth(ForthRef ref) => 0; - -@Riverpod(dependencies: [if (true) forth]) -int fifth(FifthRef ref) => 0; - -@Riverpod(dependencies: [int]) -int sixth(SixthRef ref) => 0; -''', (resolver) async { - final result = await resolver.resolveRiverpodAnalysisResult( - ignoreErrors: true, - ); - - final errors = - result.resolvedRiverpodLibraryResults.expand((e) => e.errors).toList(); - - expect(errors, hasLength(6)); - - expect( - errors[0].message, - '@Riverpod(dependencies: <...>) only support list literals (using []).', - ); - expect(errors[0].targetNode?.toSource(), 'deps'); - - expect( - errors[1].message, - '@Riverpod(dependencies: <...>) only support list literals (using []).', - ); - expect(errors[1].targetNode?.toSource(), ''); - - expect( - errors[2].message, - '@Riverpod(dependencies: [...]) only supports elements annotated with @riverpod as values.', - ); - expect(errors[2].targetNode?.toSource(), 'gibberish'); - - expect( - errors[3].message, - '@Riverpod(dependencies: [...]) does not support if/for/spread operators.', - ); - expect(errors[3].targetNode?.toSource(), 'if (true) forth'); - - expect( - errors[4].message, - 'Unsupported dependency. Only functions and classes annotated by @riverpod are supported.', - ); - expect(errors[4].targetElement.toString(), 'int sixth(InvalidType ref)'); - - expect( - errors[5].message, - 'Failed to parse dependency Type (int)', - ); - expect(errors[5].targetElement?.toString(), 'int sixth(InvalidType ref)'); - }); - testSource('Decode name', runGenerator: true, source: r''' import 'package:riverpod_annotation/riverpod_annotation.dart'; @@ -235,9 +138,8 @@ class Counter extends _$Counter { @override int build() => 0; } -''', (resolver) async { - final result = await resolver.resolveRiverpodAnalysisResult(); - final providers = result.generatorProviderDeclarations; +''', (resolver, unit, units) async { + final providers = unit.declarations.map((e) => e.provider).toList(); expect(providers, [ isA() @@ -283,17 +185,19 @@ class KeepAliveNotifier extends _$KeepAliveNotifier { @override int build() => 0; } -''', (resolver) async { - final result = await resolver.resolveRiverpodAnalysisResult(); - final autoDispose = result.generatorProviderDeclarations.takeAll([ +''', (resolver, unit, units) async { + final providers = + unit.declarations.map((e) => e.provider).whereNotNull().toList(); + + final autoDispose = providers.takeAll([ 'autoDispose', 'AutoDisposeNotifierTest', ]); - final explicitAutoDispose = result.generatorProviderDeclarations.takeAll([ + final explicitAutoDispose = providers.takeAll([ 'autoDispose2', 'AutoDisposeNotifier2', ]); - final keepAlive = result.generatorProviderDeclarations.takeAll([ + final keepAlive = providers.takeAll([ 'keepAlive', 'KeepAliveNotifier', ]); @@ -385,30 +289,32 @@ class FamilyClass extends _$FamilyClass { @override int build() => 0; } -''', (resolver) async { - final result = await resolver.resolveRiverpodAnalysisResult(); - final roots = result.generatorProviderDeclarations.takeAll([ +''', (resolver, unit, units) async { + final providers = + unit.declarations.map((e) => e.provider).whereNotNull().toList(); + + final roots = providers.takeAll([ 'root', 'RootNotifier', ]); - final empty = result.generatorProviderDeclarations.takeAll([ + final empty = providers.takeAll([ 'empty', 'EmptyNotifier', ]); - final providers = result.generatorProviderDeclarations.takeAll([ + final direct = providers.takeAll([ 'providerDependency', 'ProviderDependencyNotifier', 'family', 'FamilyClass', ]); - final nesteds = result.generatorProviderDeclarations.takeAll([ + final nesteds = providers.takeAll([ 'nestedDependency', 'NestedDependencyNotifier', ]); for (final provider in roots.entries) { expect( - provider.value.annotation.dependencies, + provider.value.annotation.dependencyList, null, reason: '${provider.key} has no dependency', ); @@ -425,7 +331,7 @@ class FamilyClass extends _$FamilyClass { } for (final provider in empty.entries) { expect( - provider.value.annotation.dependencies?.dependencies, + provider.value.annotation.dependencyList?.values, isEmpty, reason: '${provider.key} has an empty list of dependencies', ); @@ -440,14 +346,20 @@ class FamilyClass extends _$FamilyClass { reason: '${provider.key} has an empty list of dependencies', ); expect( - provider.value.annotation.dependencies?.node.toSource(), + provider.value.annotation.dependenciesNode?.toSource(), 'dependencies: []', reason: '${provider.key} has an empty list of dependencies', ); + expect( + provider.value.annotation.dependencyList?.node?.toSource(), + '[]', + reason: '${provider.key} has an empty list of dependencies', + ); } - for (final provider in providers.entries) { + + for (final provider in direct.entries) { expect( - provider.value.annotation.dependencies?.dependencies, + provider.value.annotation.dependencyList?.values, hasLength(2), reason: '${provider.key} has two explicit dependencies', ); @@ -462,8 +374,8 @@ class FamilyClass extends _$FamilyClass { reason: '${provider.key} has two explicit dependencies', ); expect( - provider.value.annotation.dependencies?.dependencies?[0], - isA() + provider.value.annotation.dependencyList?.values?[0], + isA() .having( (e) => e.provider, 'provider', @@ -473,8 +385,8 @@ class FamilyClass extends _$FamilyClass { reason: '${provider.key} has `empty` as first dependency', ); expect( - provider.value.annotation.dependencies?.dependencies?[1], - isA() + provider.value.annotation.dependencyList?.values?[1], + isA() .having( (e) => e.provider, 'provider', @@ -501,15 +413,20 @@ class FamilyClass extends _$FamilyClass { ); expect( - provider.value.annotation.dependencies?.node.toSource(), + provider.value.annotation.dependenciesNode?.toSource(), 'dependencies: [empty, EmptyNotifier]', reason: '${provider.key} has two dependencies', ); + expect( + provider.value.annotation.dependencyList?.node?.toSource(), + '[empty, EmptyNotifier]', + reason: '${provider.key} has two dependencies', + ); } for (final provider in nesteds.entries) { expect( - provider.value.annotation.dependencies?.dependencies, + provider.value.annotation.dependencyList?.values, hasLength(2), reason: '${provider.key} has two explicit dependencies', ); @@ -521,31 +438,31 @@ class FamilyClass extends _$FamilyClass { expect( provider.value.annotation.element.allTransitiveDependencies, unorderedEquals([ - providers['providerDependency']!.providerElement, - providers['ProviderDependencyNotifier']!.providerElement, + direct['providerDependency']!.providerElement, + direct['ProviderDependencyNotifier']!.providerElement, empty['empty']!.providerElement, empty['EmptyNotifier']!.providerElement, ]), reason: '${provider.key} has two explicit dependencies', ); expect( - provider.value.annotation.dependencies?.dependencies?[0], - isA() + provider.value.annotation.dependencyList?.values?[0], + isA() .having( (e) => e.provider, 'provider', - same(providers['providerDependency']!.providerElement), + same(direct['providerDependency']!.providerElement), ) .having((e) => e.node.toString(), 'node', 'providerDependency'), reason: '${provider.key} has `providerDependency` as first dependency', ); expect( - provider.value.annotation.dependencies?.dependencies?[1], - isA() + provider.value.annotation.dependencyList?.values?[1], + isA() .having( (e) => e.provider, 'provider', - same(providers['ProviderDependencyNotifier']!.providerElement), + same(direct['ProviderDependencyNotifier']!.providerElement), ) .having( (e) => e.node.toString(), @@ -563,21 +480,26 @@ class FamilyClass extends _$FamilyClass { ); expect( provider.value.annotation.element.dependencies?.elementAt(0), - same(providers['providerDependency']!.providerElement), + same(direct['providerDependency']!.providerElement), reason: '${provider.key} has `providerDependency` as first dependency', ); expect( provider.value.annotation.element.dependencies?.elementAt(1), - same(providers['ProviderDependencyNotifier']!.providerElement), + same(direct['ProviderDependencyNotifier']!.providerElement), reason: '${provider.key} has `ProviderDependencyNotifier` as second dependency', ); expect( - provider.value.annotation.dependencies?.node.toSource(), + provider.value.annotation.dependenciesNode?.toSource(), 'dependencies: [providerDependency, ProviderDependencyNotifier]', reason: '${provider.key} has two dependencies', ); + expect( + provider.value.annotation.dependencyList?.node?.toSource(), + '[providerDependency, ProviderDependencyNotifier]', + reason: '${provider.key} has two dependencies', + ); } }); } diff --git a/packages/riverpod_analyzer_utils_tests/test/nodes/providers/identifiers_test.dart b/packages/riverpod_analyzer_utils_tests/test/nodes/providers/identifiers_test.dart new file mode 100644 index 000000000..6a55d413a --- /dev/null +++ b/packages/riverpod_analyzer_utils_tests/test/nodes/providers/identifiers_test.dart @@ -0,0 +1,88 @@ +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/ast/visitor.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import 'package:test/expect.dart'; +import 'package:test/test.dart'; + +import '../../analyzer_test_utils.dart'; +import '../../matchers.dart'; + +void main() { + testSource('Decode generated provider identifiers', + runGenerator: true, source: r''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'foo.g.dart'; + +// Let's define some providers +@riverpod +int a(ARef ref) => 0; + +@riverpod +class B extends _$B { + @override + int build() => 0; +} + +// Using those providers in random places +void main() { + aProvider; + bProvider; +} +''', (resolver, unit, units) async { + final visitor = _FindIdentifiersVisitor(); + unit.accept(visitor); + + expect(visitor.identifiers, hasLength(2)); + + expect( + visitor.identifiers[0], + isProviderIdentifier( + node: hasToString('aProvider'), + providerElement: isFunctionalProviderDeclarationElement(name: 'a'), + ), + ); + expect( + visitor.identifiers[1], + isProviderIdentifier( + node: hasToString('bProvider'), + providerElement: isClassBasedProviderDeclarationElement(name: 'B'), + ), + ); + }); + + testSource('Decode legacy provider identifiers', source: ''' +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +final provider = Provider((ref) => 0); + +void main() { + provider; +} +''', (resolver, unit, units) async { + final visitor = _FindIdentifiersVisitor(); + unit.accept(visitor); + + expect(visitor.identifiers, hasLength(1)); + + expect( + visitor.identifiers[0], + isProviderIdentifier( + node: hasToString('provider'), + providerElement: isLegacyProviderDeclarationElement(name: 'provider'), + ), + ); + }); +} + +class _FindIdentifiersVisitor extends RecursiveAstVisitor { + final List identifiers = []; + + @override + void visitSimpleIdentifier(SimpleIdentifier node) { + super.visitSimpleIdentifier(node); + if (node.provider case final provider?) { + identifiers.add(provider); + } + } +} diff --git a/packages/riverpod_analyzer_utils_tests/test/nodes/riverpod_test.dart b/packages/riverpod_analyzer_utils_tests/test/nodes/riverpod_test.dart new file mode 100644 index 000000000..c40685067 --- /dev/null +++ b/packages/riverpod_analyzer_utils_tests/test/nodes/riverpod_test.dart @@ -0,0 +1,276 @@ +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import 'package:test/expect.dart'; +import 'package:test/test.dart'; + +import '../analyzer_test_utils.dart'; +import '../matchers.dart'; + +void main() { + testSource('Decode dependencies with syntax errors', source: ''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +const deps = []; + +@Riverpod(dependencies: deps) +int first(FirstRef ref) => 0; + +@Riverpod(dependencies: ) +int second(SecondRef ref) => 0; + +@Riverpod(dependencies: [gibberish]) +int forth(ForthRef ref) => 0; + +@Riverpod(dependencies: [if (true) forth]) +int fifth(FifthRef ref) => 0; + +@Riverpod(dependencies: [int]) +int sixth(SixthRef ref) => 0; + +void fn() {} + +@Riverpod(dependencies: [fn]) +int seven(SevenRef ref) => 0; + +@Riverpod(dependencies: ['foo']) +int eight(EightRef ref) => 0; +''', (resolver, unit, units) async { + final errors = collectErrors(() { + for (final d in unit.declarations) { + d.provider; + } + }); + + expect(errors, hasLength(10)); + + expect( + errors[0].message, + 'Only list literals (using []) as supported.', + ); + expect(errors[0].targetNode?.toSource(), 'deps'); + + expect( + errors[1].message, + 'Only list literals (using []) as supported.', + ); + expect(errors[1].targetNode?.toSource(), ''); + + expect( + errors[2].message, + 'Only elements annotated with @riverpod are supported.', + ); + expect(errors[2].targetNode?.toSource(), 'gibberish'); + + expect( + errors[3].message, + 'if/for/spread operators as not supported.', + ); + expect(errors[3].targetNode?.toSource(), 'if (true) forth'); + + expect( + errors[4].message, + 'Unsupported dependency "int". Only functions and classes annotated by @riverpod are supported.', + ); + expect( + errors[4].targetElement.toString(), + 'Riverpod Riverpod({bool keepAlive = false, List? dependencies})', + ); + + expect( + errors[5].message, + 'The dependency int is not a class annotated with @riverpod', + ); + expect(errors[5].targetNode.toString(), 'int'); + + expect( + errors[6].message, + 'Unsupported dependency "void fn()". Only functions and classes annotated by @riverpod are supported.', + ); + expect( + errors[6].targetElement.toString(), + 'Riverpod Riverpod({bool keepAlive = false, List? dependencies})', + ); + + expect( + errors[7].message, + 'The dependency fn is not a function annotated with @riverpod', + ); + expect(errors[7].targetNode.toString(), 'fn'); + + expect( + errors[8].message, + 'Unsupported dependency "String (\'foo\')". Only functions and classes annotated by @riverpod are supported.', + ); + expect( + errors[8].targetElement.toString(), + 'Riverpod Riverpod({bool keepAlive = false, List? dependencies})', + ); + + expect( + errors[9].message, + 'Only elements annotated with @riverpod are supported.', + ); + expect(errors[9].targetNode.toString(), "'foo'"); + }); + + testSource('Reuses elements', source: ''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@riverpod +int dependency(DependencyRef ref) => 0; + +@Riverpod(dependencies: [dependency]) +int fn(FnRef ref) => 0; + +@Riverpod(dependencies: [dependency]) +int fn2(FnRef ref) => 0; +''', (resolver, unit, units) async { + final dependency = unit.declarations.findByName('dependency').riverpod; + + final fn = unit.declarations.findByName('fn').riverpod; + + final fn2 = unit.declarations.findByName('fn2').riverpod; + + expect( + dependency!.element, + same(fn!.dependencyList!.values!.single.provider.annotation), + ); + expect( + fn.dependencyList!.values!.single.provider, + same(fn2!.dependencyList!.values!.single.provider), + ); + }); + + testSource('Decodes @riverpod', source: ''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@deprecated +int unrelated() => 0; + +@riverpod +int variable(VariableRef ref) => 0; + +@Riverpod() +int constructor(ConstructorRef ref) => 0; + +@Riverpod(keepAlive: false, dependencies: null) +int explicit(ExplicitRef ref) => 0; + +@Riverpod(keepAlive: true, dependencies: [variable]) +int constructor2(Constructor2Ref ref) => 0; + +class NestedClass { + void method() { + @riverpod + int value = 0; + } +} +''', (resolver, unit, units) async { + expect( + unit.declarations.findByName('unrelated').riverpod, + isNull, + ); + + final variable = unit.declarations.findByName('variable').riverpod; + expect( + variable, + isRiverpod( + node: hasToString('@riverpod'), + element: isRiverpodAnnotationElement( + keepAlive: false, + dependencies: isNull, + ), + keepAlive: isNull, + dependenciesNode: isNull, + dependencyList: isNull, + ), + ); + + expect( + unit.declarations.findByName('constructor').riverpod, + isRiverpod( + node: hasToString('@Riverpod()'), + element: isRiverpodAnnotationElement( + keepAlive: false, + dependencies: isNull, + ), + keepAlive: isNull, + dependenciesNode: isNull, + dependencyList: isNull, + ), + ); + + final explicit = unit.declarations.findByName('explicit').riverpod; + expect( + explicit, + isRiverpod( + node: hasToString('@Riverpod(keepAlive: false, dependencies: null)'), + element: isRiverpodAnnotationElement( + keepAlive: false, + dependencies: isNull, + ), + keepAlive: hasToString('keepAlive: false'), + dependenciesNode: hasToString('dependencies: null'), + dependencyList: isProviderDependencyList( + node: hasToString('null'), + values: isNull, + ), + ), + ); + + final constructor2 = unit.declarations.findByName('constructor2').riverpod; + expect( + constructor2, + isRiverpod( + node: hasToString( + '@Riverpod(keepAlive: true, dependencies: [variable])', + ), + element: isRiverpodAnnotationElement( + keepAlive: true, + dependencies: [ + isFunctionalProviderDeclarationElement(name: 'variable'), + ], + ), + keepAlive: hasToString('keepAlive: true'), + dependenciesNode: hasToString('dependencies: [variable]'), + dependencyList: isProviderDependencyList( + node: hasToString('[variable]'), + values: [ + isProviderDependency( + node: hasToString('variable'), + provider: isFunctionalProviderDeclarationElement( + name: 'variable', + ), + ), + ], + ), + ), + ); + + final nestedVariable = unit.declarations + .findByName('NestedClass') + .members + .findByName('method') + .body + .cast()! + .block + .statements + .first + .cast()! + .variables; + + expect( + nestedVariable.riverpod, + isRiverpod( + node: hasToString('@riverpod'), + element: isRiverpodAnnotationElement( + keepAlive: false, + dependencies: isNull, + ), + keepAlive: isNull, + dependenciesNode: isNull, + dependencyList: isNull, + ), + ); + }); +} diff --git a/packages/riverpod_analyzer_utils_tests/test/provider_container_test.dart b/packages/riverpod_analyzer_utils_tests/test/provider_container_test.dart index 02957512b..73e98f69e 100644 --- a/packages/riverpod_analyzer_utils_tests/test/provider_container_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/provider_container_test.dart @@ -33,7 +33,7 @@ void main() { ], ); } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); final provider = @@ -54,49 +54,49 @@ void main() { expect(containers[1].overrides!.overrides, hasLength(6)); expect( containers[1].overrides!.node.toSource(), - 'overrides: [provider.overrideWith((ref) => 0), provider.overrideWithValue(42), provider, family(42), family.overrideWith((ref, id) => 0), family(42).overrideWith((ref) => 0)]', + '[provider.overrideWith((ref) => 0), provider.overrideWithValue(42), provider, family(42), family.overrideWith((ref, id) => 0), family(42).overrideWith((ref) => 0)]', ); { expect( - containers[1].overrides!.overrides![0].providerElement, + containers[1].overrides!.overrides![0].provider?.providerElement, same(provider.providerElement), ); expect( - containers[1].overrides!.overrides![0].expression.toSource(), + containers[1].overrides!.overrides![0].node.toSource(), 'provider.overrideWith((ref) => 0)', ); expect( - containers[1].overrides!.overrides![0].provider!.toSource(), + containers[1].overrides!.overrides![0].provider!.node.toSource(), 'provider', ); expect(containers[1].overrides!.overrides![0].familyArguments, null); } { expect( - containers[1].overrides!.overrides![1].providerElement, + containers[1].overrides!.overrides![1].provider?.providerElement, same(provider.providerElement), ); expect( - containers[1].overrides!.overrides![1].expression.toSource(), + containers[1].overrides!.overrides![1].node.toSource(), 'provider.overrideWithValue(42)', ); expect( - containers[1].overrides!.overrides![1].provider!.toSource(), + containers[1].overrides!.overrides![1].provider!.node.toSource(), 'provider', ); expect(containers[1].overrides!.overrides![1].familyArguments, null); } { expect( - containers[1].overrides!.overrides![2].providerElement, + containers[1].overrides!.overrides![2].provider?.providerElement, same(provider.providerElement), ); expect( - containers[1].overrides!.overrides![2].expression.toSource(), + containers[1].overrides!.overrides![2].node.toSource(), 'provider', ); expect( - containers[1].overrides!.overrides![2].provider!.toSource(), + containers[1].overrides!.overrides![2].provider!.node.toSource(), 'provider', ); expect(containers[1].overrides!.overrides![2].familyArguments, null); @@ -104,15 +104,15 @@ void main() { { expect( - containers[1].overrides!.overrides![3].providerElement, + containers[1].overrides!.overrides![3].provider?.providerElement, same(family.providerElement), ); expect( - containers[1].overrides!.overrides![3].expression.toSource(), + containers[1].overrides!.overrides![3].node.toSource(), 'family(42)', ); expect( - containers[1].overrides!.overrides![3].provider!.toSource(), + containers[1].overrides!.overrides![3].provider!.node.toSource(), 'family', ); expect( @@ -122,30 +122,30 @@ void main() { } { expect( - containers[1].overrides!.overrides![4].providerElement, + containers[1].overrides!.overrides![4].provider?.providerElement, same(family.providerElement), ); expect( - containers[1].overrides!.overrides![4].expression.toSource(), + containers[1].overrides!.overrides![4].node.toSource(), 'family.overrideWith((ref, id) => 0)', ); expect( - containers[1].overrides!.overrides![4].provider!.toSource(), + containers[1].overrides!.overrides![4].provider!.node.toSource(), 'family', ); expect(containers[1].overrides!.overrides![4].familyArguments, null); } { expect( - containers[1].overrides!.overrides![5].providerElement, + containers[1].overrides!.overrides![5].provider?.providerElement, same(family.providerElement), ); expect( - containers[1].overrides!.overrides![5].expression.toSource(), + containers[1].overrides!.overrides![5].node.toSource(), 'family(42).overrideWith((ref) => 0)', ); expect( - containers[1].overrides!.overrides![5].provider!.toSource(), + containers[1].overrides!.overrides![5].provider!.node.toSource(), 'family', ); expect( @@ -159,7 +159,7 @@ void main() { 'ProviderContainer(overrides: fn())', ); expect(containers[2].overrides!.overrides, null); - expect(containers[2].overrides!.node.toSource(), 'overrides: fn()'); + expect(containers[2].overrides!.node.toSource(), 'fn()'); expect( containers[3].node.toSource(), @@ -168,13 +168,16 @@ void main() { expect(containers[3].overrides?.overrides, hasLength(1)); expect( containers[3].overrides!.node.toSource(), - 'overrides: [() {return provider;}()]', + '[() {return provider;}()]', ); expect( - containers[3].overrides?.overrides?.single.expression.toSource(), + containers[3].overrides?.overrides?.single.node.toSource(), '() {return provider;}()', ); - expect(containers[3].overrides?.overrides?.single.providerElement, null); + expect( + containers[3].overrides?.overrides?.single.provider?.providerElement, + null, + ); expect(containers[3].overrides?.overrides?.single.provider, null); expect(containers[3].overrides?.overrides?.single.familyArguments, null); }); diff --git a/packages/riverpod_analyzer_utils_tests/test/provider_scope_test.dart b/packages/riverpod_analyzer_utils_tests/test/provider_scope_test.dart index 966ee83f2..9f8907767 100644 --- a/packages/riverpod_analyzer_utils_tests/test/provider_scope_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/provider_scope_test.dart @@ -43,11 +43,10 @@ class Example extends ConsumerWidget { return ProviderScope(child: Text('foo')); } } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); final scopes = result.providerScopeInstanceCreationExpressions; - final consumer = result.consumerWidgetDeclarations.single; final provider = result.legacyProviderDeclarations.takeAll(['provider']).values.single; @@ -66,49 +65,49 @@ class Example extends ConsumerWidget { expect(scopes[1].overrides!.overrides, hasLength(6)); expect( scopes[1].overrides!.node.toSource(), - 'overrides: [provider.overrideWith((ref) => 0), provider.overrideWithValue(42), provider, family(42), family.overrideWith((ref, id) => 0), family(42).overrideWith((ref) => 0)]', + '[provider.overrideWith((ref) => 0), provider.overrideWithValue(42), provider, family(42), family.overrideWith((ref, id) => 0), family(42).overrideWith((ref) => 0)]', ); { expect( - scopes[1].overrides!.overrides![0].providerElement, + scopes[1].overrides!.overrides![0].provider?.providerElement, same(provider.providerElement), ); expect( - scopes[1].overrides!.overrides![0].expression.toSource(), + scopes[1].overrides!.overrides![0].node.toSource(), 'provider.overrideWith((ref) => 0)', ); expect( - scopes[1].overrides!.overrides![0].provider!.toSource(), + scopes[1].overrides!.overrides![0].provider!.node.toSource(), 'provider', ); expect(scopes[1].overrides!.overrides![0].familyArguments, null); } { expect( - scopes[1].overrides!.overrides![1].providerElement, + scopes[1].overrides!.overrides![1].provider?.providerElement, same(provider.providerElement), ); expect( - scopes[1].overrides!.overrides![1].expression.toSource(), + scopes[1].overrides!.overrides![1].node.toSource(), 'provider.overrideWithValue(42)', ); expect( - scopes[1].overrides!.overrides![1].provider!.toSource(), + scopes[1].overrides!.overrides![1].provider!.node.toSource(), 'provider', ); expect(scopes[1].overrides!.overrides![1].familyArguments, null); } { expect( - scopes[1].overrides!.overrides![2].providerElement, + scopes[1].overrides!.overrides![2].provider?.providerElement, same(provider.providerElement), ); expect( - scopes[1].overrides!.overrides![2].expression.toSource(), + scopes[1].overrides!.overrides![2].node.toSource(), 'provider', ); expect( - scopes[1].overrides!.overrides![2].provider!.toSource(), + scopes[1].overrides!.overrides![2].provider!.node.toSource(), 'provider', ); expect(scopes[1].overrides!.overrides![2].familyArguments, null); @@ -116,15 +115,15 @@ class Example extends ConsumerWidget { { expect( - scopes[1].overrides!.overrides![3].providerElement, + scopes[1].overrides!.overrides![3].provider?.providerElement, same(family.providerElement), ); expect( - scopes[1].overrides!.overrides![3].expression.toSource(), + scopes[1].overrides!.overrides![3].node.toSource(), 'family(42)', ); expect( - scopes[1].overrides!.overrides![3].provider!.toSource(), + scopes[1].overrides!.overrides![3].provider!.node.toSource(), 'family', ); expect( @@ -134,30 +133,30 @@ class Example extends ConsumerWidget { } { expect( - scopes[1].overrides!.overrides![4].providerElement, + scopes[1].overrides!.overrides![4].provider?.providerElement, same(family.providerElement), ); expect( - scopes[1].overrides!.overrides![4].expression.toSource(), + scopes[1].overrides!.overrides![4].node.toSource(), 'family.overrideWith((ref, id) => 0)', ); expect( - scopes[1].overrides!.overrides![4].provider!.toSource(), + scopes[1].overrides!.overrides![4].provider!.node.toSource(), 'family', ); expect(scopes[1].overrides!.overrides![4].familyArguments, null); } { expect( - scopes[1].overrides!.overrides![5].providerElement, + scopes[1].overrides!.overrides![5].provider?.providerElement, same(family.providerElement), ); expect( - scopes[1].overrides!.overrides![5].expression.toSource(), + scopes[1].overrides!.overrides![5].node.toSource(), 'family(42).overrideWith((ref) => 0)', ); expect( - scopes[1].overrides!.overrides![5].provider!.toSource(), + scopes[1].overrides!.overrides![5].provider!.node.toSource(), 'family', ); expect( @@ -171,7 +170,7 @@ class Example extends ConsumerWidget { 'ProviderScope(overrides: fn(), child: Container())', ); expect(scopes[2].overrides!.overrides, null); - expect(scopes[2].overrides!.node.toSource(), 'overrides: fn()'); + expect(scopes[2].overrides!.node.toSource(), 'fn()'); expect( scopes[3].node.toSource(), @@ -180,22 +179,20 @@ class Example extends ConsumerWidget { expect(scopes[3].overrides?.overrides, hasLength(1)); expect( scopes[3].overrides!.node.toSource(), - 'overrides: [() {return provider;}()]', + '[() {return provider;}()]', ); expect( - scopes[3].overrides?.overrides?.single.expression.toSource(), + scopes[3].overrides?.overrides?.single.node.toSource(), '() {return provider;}()', ); - expect(scopes[3].overrides?.overrides?.single.providerElement, null); - expect(scopes[3].overrides?.overrides?.single.provider, null); - expect(scopes[3].overrides?.overrides?.single.familyArguments, null); + expect( + scopes[3].overrides?.overrides?.single.provider?.providerElement, + null, + ); + expect(scopes[3].overrides!.overrides!.single.provider, null); + expect(scopes[3].overrides!.overrides!.single.familyArguments, null); expect(scopes[4].node.toSource(), "ProviderScope(child: Text('foo'))"); expect(scopes[4].overrides, null); - expect(consumer.providerScopeInstanceCreateExpressions, hasLength(1)); - expect( - consumer.providerScopeInstanceCreateExpressions.single, - same(scopes[4]), - ); }); } diff --git a/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart b/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart index 261097463..835bf0c1b 100644 --- a/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart @@ -1,8 +1,23 @@ -import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import 'package:riverpod_analyzer_utils/src/nodes.dart'; import 'package:test/test.dart'; import 'analyzer_test_utils.dart'; +// ignore: invalid_use_of_internal_member +extension on RiverpodAnalysisResult { + List get refWatchInvocations { + return refInvocations.cast(); + } + + List get refListenInvocations { + return refInvocations.cast(); + } + + List get refReadInvocations { + return refInvocations.cast(); + } +} + void main() { testSource( 'Parses import aliases', @@ -25,7 +40,7 @@ int aliased(AliasedRef ref) { return 0; } ''', - (resolver) async { + (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); expect(result.refWatchInvocations, hasLength(1)); @@ -36,11 +51,11 @@ int aliased(AliasedRef ref) { ); expect( - result.refWatchInvocations.single.provider.provider?.toSource(), + result.refWatchInvocations.single.listenable.provider?.node.toSource(), 'aProvider', ); expect( - result.refWatchInvocations.single.provider.providerPrefix?.toSource(), + result.refWatchInvocations.single.listenable.providerPrefix?.toSource(), 'alias', ); }, @@ -50,12 +65,12 @@ int aliased(AliasedRef ref) { import 'package:riverpod/riverpod.dart'; @ProviderFor(gibberish) -final gibberishProvider = Provider((ref) => 0); +final gibberishProvider = Provider((ref) => 0).select((p) => p); final dependency = Provider((ref) { ref.watch(gibberishProvider); }); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult( ignoreErrors: true, ); @@ -66,16 +81,12 @@ final dependency = Provider((ref) { result.refInvocations.single.node.toSource(), 'ref.watch(gibberishProvider)', ); - expect(result.refWatchInvocations.single.provider.familyArguments, null); + expect(result.refWatchInvocations.single.listenable.familyArguments, null); expect( - result.refWatchInvocations.single.provider.node.toSource(), + result.refWatchInvocations.single.listenable.node.toSource(), 'gibberishProvider', ); - expect( - result.refWatchInvocations.single.provider.provider?.toSource(), - 'gibberishProvider', - ); - expect(result.refWatchInvocations.single.provider.providerElement, null); + expect(result.refWatchInvocations.single.listenable.provider, isNull); }); testSource('Decodes ref expressions in Notifier methods', @@ -85,33 +96,34 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'foo.g.dart'; +@riverpod +int generated(GeneratedRef ref) => 0; + @riverpod class MyNotifier extends _$MyNotifier { @override int build() => 0; void method() { - ref.watch(generatedScopedProvider); + ref.watch(generatedProvider); } } -''', (resolver) async { +''', (resolver, unit, units) async { // Regression test for https://github.com/rrousselGit/riverpod/issues/2417 final result = await resolver.resolveRiverpodAnalysisResult(); - final notifier = result.classBasedProviderDeclarations.single; - expect(result.refInvocations, hasLength(1)); expect( - result.refWatchInvocations.single.provider.node.toSource(), - 'generatedScopedProvider', + result.refWatchInvocations.single.listenable.node.toSource(), + 'generatedProvider', ); expect( - notifier.refInvocations.single, + result.refInvocations.single, isA().having( - (e) => e.provider.node.toSource(), + (e) => e.listenable.node.toSource(), 'provider', - 'generatedScopedProvider', + 'generatedProvider', ), ); }); @@ -142,7 +154,7 @@ final provider = Provider((ref) { return 0; }); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); expect(result.refWatchInvocations, hasLength(3)); @@ -153,11 +165,14 @@ final provider = Provider((ref) { '..watch(dep)', ); expect(result.refWatchInvocations[0].function.toSource(), 'watch'); - expect(result.refWatchInvocations[0].provider.node.toSource(), 'dep'); - expect(result.refWatchInvocations[0].provider.familyArguments, null); - expect(result.refWatchInvocations[0].provider.provider?.toSource(), 'dep'); + expect(result.refWatchInvocations[0].listenable.node.toSource(), 'dep'); + expect(result.refWatchInvocations[0].listenable.familyArguments, null); + expect( + result.refWatchInvocations[0].listenable.provider?.node.toSource(), + 'dep', + ); expect( - result.refWatchInvocations[0].provider.providerElement, + result.refWatchInvocations[0].listenable.provider?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); @@ -167,22 +182,22 @@ final provider = Provider((ref) { ); expect(result.refWatchInvocations[1].function.toSource(), 'watch'); expect( - result.refWatchInvocations[1].provider.node.toSource(), + result.refWatchInvocations[1].listenable.node.toSource(), 'dep2Provider', ); expect( - result.refWatchInvocations[1].provider.provider?.toSource(), + result.refWatchInvocations[1].listenable.provider?.node.toSource(), 'dep2Provider', ); expect( - result.refWatchInvocations[1].provider.providerElement, + result.refWatchInvocations[1].listenable.provider?.providerElement, same( result.functionalProviderDeclarations .findByName('dep2') .providerElement, ), ); - expect(result.refWatchInvocations[1].provider.familyArguments, null); + expect(result.refWatchInvocations[1].listenable.familyArguments, null); expect( result.refWatchInvocations[2].node.toSource(), @@ -190,22 +205,22 @@ final provider = Provider((ref) { ); expect(result.refWatchInvocations[2].function.toSource(), 'watch'); expect( - result.refWatchInvocations[2].provider.node.toSource(), + result.refWatchInvocations[2].listenable.node.toSource(), 'dep3Provider', ); expect( - result.refWatchInvocations[2].provider.provider?.toSource(), + result.refWatchInvocations[2].listenable.provider?.node.toSource(), 'dep3Provider', ); expect( - result.refWatchInvocations[2].provider.providerElement, + result.refWatchInvocations[2].listenable.provider?.providerElement, same( result.classBasedProviderDeclarations .findByName('Dep3') .providerElement, ), ); - expect(result.refWatchInvocations[2].provider.familyArguments, null); + expect(result.refWatchInvocations[2].listenable.familyArguments, null); }); testSource('Decodes simple ref.watch usages', runGenerator: true, source: r''' @@ -244,7 +259,7 @@ class _Ref { void fn(_Ref ref) { ref.watch(dep); } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); expect(result.refWatchInvocations, hasLength(3)); @@ -255,11 +270,14 @@ void fn(_Ref ref) { 'ref.watch(dep)', ); expect(result.refWatchInvocations[0].function.toSource(), 'watch'); - expect(result.refWatchInvocations[0].provider.node.toSource(), 'dep'); - expect(result.refWatchInvocations[0].provider.familyArguments, null); - expect(result.refWatchInvocations[0].provider.provider?.toSource(), 'dep'); + expect(result.refWatchInvocations[0].listenable.node.toSource(), 'dep'); + expect(result.refWatchInvocations[0].listenable.familyArguments, null); + expect( + result.refWatchInvocations[0].listenable.provider?.node.toSource(), + 'dep', + ); expect( - result.refWatchInvocations[0].provider.providerElement, + result.refWatchInvocations[0].listenable.provider?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); @@ -269,22 +287,22 @@ void fn(_Ref ref) { ); expect(result.refWatchInvocations[1].function.toSource(), 'watch'); expect( - result.refWatchInvocations[1].provider.node.toSource(), + result.refWatchInvocations[1].listenable.node.toSource(), 'dep2Provider', ); expect( - result.refWatchInvocations[1].provider.provider?.toSource(), + result.refWatchInvocations[1].listenable.provider?.node.toSource(), 'dep2Provider', ); expect( - result.refWatchInvocations[1].provider.providerElement, + result.refWatchInvocations[1].listenable.provider?.providerElement, same( result.functionalProviderDeclarations .findByName('dep2') .providerElement, ), ); - expect(result.refWatchInvocations[1].provider.familyArguments, null); + expect(result.refWatchInvocations[1].listenable.familyArguments, null); expect( result.refWatchInvocations[2].node.toSource(), @@ -292,22 +310,22 @@ void fn(_Ref ref) { ); expect(result.refWatchInvocations[2].function.toSource(), 'watch'); expect( - result.refWatchInvocations[2].provider.node.toSource(), + result.refWatchInvocations[2].listenable.node.toSource(), 'dep3Provider', ); expect( - result.refWatchInvocations[2].provider.provider?.toSource(), + result.refWatchInvocations[2].listenable.provider?.node.toSource(), 'dep3Provider', ); expect( - result.refWatchInvocations[2].provider.providerElement, + result.refWatchInvocations[2].listenable.provider?.providerElement, same( result.classBasedProviderDeclarations .findByName('Dep3') .providerElement, ), ); - expect(result.refWatchInvocations[2].provider.familyArguments, null); + expect(result.refWatchInvocations[2].listenable.familyArguments, null); }); testSource('Decodes ref.listen usages', runGenerator: true, source: ''' @@ -325,7 +343,7 @@ final provider = Provider((ref) { return 0; }); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); expect(result.refListenInvocations, hasLength(3)); @@ -341,7 +359,7 @@ final provider = Provider((ref) { '(prev, next) {}', ); expect( - result.refListenInvocations[0].provider.providerElement, + result.refListenInvocations[0].listenable.provider?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); @@ -355,7 +373,7 @@ final provider = Provider((ref) { '(prev, next) {}', ); expect( - result.refListenInvocations[1].provider.providerElement, + result.refListenInvocations[1].listenable.provider?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); @@ -369,7 +387,7 @@ final provider = Provider((ref) { '(prev, next) {}', ); expect( - result.refListenInvocations[2].provider.providerElement, + result.refListenInvocations[2].listenable.provider?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); }); @@ -389,7 +407,7 @@ final provider = Provider((ref) { return 0; }); -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); expect(result.refReadInvocations, hasLength(2)); @@ -398,14 +416,14 @@ final provider = Provider((ref) { expect(result.refReadInvocations[0].node.toSource(), 'ref.read(dep)'); expect(result.refReadInvocations[0].function.toSource(), 'read'); expect( - result.refReadInvocations[0].provider.providerElement, + result.refReadInvocations[0].listenable.provider?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); expect(result.refReadInvocations[1].node.toSource(), 'ref.read(dep2)'); expect(result.refReadInvocations[1].function.toSource(), 'read'); expect( - result.refReadInvocations[1].provider.providerElement, + result.refReadInvocations[1].listenable.provider?.providerElement, same( result.legacyProviderDeclarations.findByName('dep2').providerElement, ), @@ -423,26 +441,24 @@ void fn(Ref ref) { ref.read(dep); ref.read(dep2); } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); - final libraryResult = result.resolvedRiverpodLibraryResults.single; - - expect(libraryResult.unknownRefInvocations, hasLength(2)); - expect(result.refReadInvocations, libraryResult.unknownRefInvocations); + expect(result.refInvocations, hasLength(2)); + expect(result.refReadInvocations, result.refInvocations); expect(result.refInvocations, result.refReadInvocations); expect(result.refReadInvocations[0].node.toSource(), 'ref.read(dep)'); expect(result.refReadInvocations[0].function.toSource(), 'read'); expect( - result.refReadInvocations[0].provider.providerElement, + result.refReadInvocations[0].listenable.provider?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); expect(result.refReadInvocations[1].node.toSource(), 'ref.read(dep2)'); expect(result.refReadInvocations[1].function.toSource(), 'read'); expect( - result.refReadInvocations[1].provider.providerElement, + result.refReadInvocations[1].listenable.provider?.providerElement, same( result.legacyProviderDeclarations.findByName('dep2').providerElement, ), @@ -485,41 +501,33 @@ class _Ref { void fn(_Ref ref) { ref.watch(family(0)); } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); - final libraryResult = result.resolvedRiverpodLibraryResults.single; - - expect(libraryResult.unknownRefInvocations, isEmpty); - expect(libraryResult.unknownWidgetRefInvocations, isEmpty); - - final providerRefInvocations = libraryResult.legacyProviderDeclarations - .where((e) => e.providerElement.name == 'provider') - .single - .refInvocations - .cast(); + final providerRefInvocations = + result.refInvocations.cast(); expect(providerRefInvocations, hasLength(3)); - expect(result.refInvocations, providerRefInvocations); + expect(result.refWatchInvocations, providerRefInvocations); expect( providerRefInvocations[0].node.toSource(), 'ref.watch(family(0))', ); expect(providerRefInvocations[0].function.toSource(), 'watch'); - expect(providerRefInvocations[0].provider.node.toSource(), 'family(0)'); + expect(providerRefInvocations[0].listenable.node.toSource(), 'family(0)'); expect( - providerRefInvocations[0].provider.provider?.toSource(), + providerRefInvocations[0].listenable.provider?.node.toSource(), 'family', ); expect( - providerRefInvocations[0].provider.providerElement, + providerRefInvocations[0].listenable.provider?.providerElement, same( result.legacyProviderDeclarations.findByName('family').providerElement, ), ); expect( - providerRefInvocations[0].provider.familyArguments?.toSource(), + providerRefInvocations[0].listenable.familyArguments?.toSource(), '(0)', ); @@ -529,15 +537,15 @@ void fn(_Ref ref) { ); expect(providerRefInvocations[1].function.toSource(), 'watch'); expect( - providerRefInvocations[1].provider.node.toSource(), + providerRefInvocations[1].listenable.node.toSource(), 'family2Provider(id: 0)', ); expect( - providerRefInvocations[1].provider.provider?.toSource(), + providerRefInvocations[1].listenable.provider?.node.toSource(), 'family2Provider', ); expect( - providerRefInvocations[1].provider.providerElement, + providerRefInvocations[1].listenable.provider?.providerElement, same( result.functionalProviderDeclarations .findByName('family2') @@ -545,7 +553,7 @@ void fn(_Ref ref) { ), ); expect( - providerRefInvocations[1].provider.familyArguments?.toSource(), + providerRefInvocations[1].listenable.familyArguments?.toSource(), '(id: 0)', ); @@ -555,15 +563,15 @@ void fn(_Ref ref) { ); expect(result.refWatchInvocations[2].function.toSource(), 'watch'); expect( - result.refWatchInvocations[2].provider.node.toSource(), + result.refWatchInvocations[2].listenable.node.toSource(), 'family3Provider(id: 0)', ); expect( - result.refWatchInvocations[2].provider.provider?.toSource(), + result.refWatchInvocations[2].listenable.provider?.node.toSource(), 'family3Provider', ); expect( - result.refWatchInvocations[2].provider.providerElement, + result.refWatchInvocations[2].listenable.provider?.providerElement, same( result.classBasedProviderDeclarations .findByName('Family3') @@ -571,7 +579,7 @@ void fn(_Ref ref) { ), ); expect( - result.refWatchInvocations[2].provider.familyArguments?.toSource(), + result.refWatchInvocations[2].listenable.familyArguments?.toSource(), '(id: 0)', ); }); @@ -629,7 +637,7 @@ class _Ref { void fn(_Ref ref) { ref.watch(dep); } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); expect(result.refWatchInvocations, hasLength(4)); @@ -641,13 +649,16 @@ void fn(_Ref ref) { ); expect(result.refWatchInvocations[0].function.toSource(), 'watch'); expect( - result.refWatchInvocations[0].provider.node.toSource(), + result.refWatchInvocations[0].listenable.node.toSource(), 'dep.select((e) => e)', ); - expect(result.refWatchInvocations[0].provider.familyArguments, null); - expect(result.refWatchInvocations[0].provider.provider?.toSource(), 'dep'); + expect(result.refWatchInvocations[0].listenable.familyArguments, null); + expect( + result.refWatchInvocations[0].listenable.provider?.node.toSource(), + 'dep', + ); expect( - result.refWatchInvocations[0].provider.providerElement, + result.refWatchInvocations[0].listenable.provider?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); @@ -657,16 +668,16 @@ void fn(_Ref ref) { ); expect(result.refWatchInvocations[1].function.toSource(), 'watch'); expect( - result.refWatchInvocations[1].provider.node.toSource(), + result.refWatchInvocations[1].listenable.node.toSource(), 'dep2Provider.select((e) => e)', ); - expect(result.refWatchInvocations[1].provider.familyArguments, null); + expect(result.refWatchInvocations[1].listenable.familyArguments, null); expect( - result.refWatchInvocations[1].provider.provider?.toSource(), + result.refWatchInvocations[1].listenable.provider?.node.toSource(), 'dep2Provider', ); expect( - result.refWatchInvocations[1].provider.providerElement, + result.refWatchInvocations[1].listenable.provider?.providerElement, same( result.functionalProviderDeclarations .findByName('dep2') @@ -680,16 +691,16 @@ void fn(_Ref ref) { ); expect(result.refWatchInvocations[2].function.toSource(), 'watch'); expect( - result.refWatchInvocations[2].provider.node.toSource(), + result.refWatchInvocations[2].listenable.node.toSource(), 'dep3Provider.select((e) => e)', ); - expect(result.refWatchInvocations[2].provider.familyArguments, null); + expect(result.refWatchInvocations[2].listenable.familyArguments, null); expect( - result.refWatchInvocations[2].provider.provider?.toSource(), + result.refWatchInvocations[2].listenable.provider?.node.toSource(), 'dep3Provider', ); expect( - result.refWatchInvocations[2].provider.providerElement, + result.refWatchInvocations[2].listenable.provider?.providerElement, same( result.classBasedProviderDeclarations .findByName('Dep3') @@ -703,19 +714,19 @@ void fn(_Ref ref) { ); expect(result.refWatchInvocations[3].function.toSource(), 'watch'); expect( - result.refWatchInvocations[3].provider.node.toSource(), + result.refWatchInvocations[3].listenable.node.toSource(), 'familyProvider(id: 42).notifier.select((e) => e).getter.method()[0]', ); expect( - result.refWatchInvocations[3].provider.familyArguments?.toSource(), + result.refWatchInvocations[3].listenable.familyArguments?.toSource(), '(id: 42)', ); expect( - result.refWatchInvocations[3].provider.provider?.toSource(), + result.refWatchInvocations[3].listenable.provider?.node.toSource(), 'familyProvider', ); expect( - result.refWatchInvocations[3].provider.providerElement, + result.refWatchInvocations[3].listenable.provider?.providerElement, same( result.classBasedProviderDeclarations .findByName('Family') diff --git a/packages/riverpod_analyzer_utils_tests/test/type_utils_test.dart b/packages/riverpod_analyzer_utils_tests/test/type_utils_test.dart new file mode 100644 index 000000000..7fd884c13 --- /dev/null +++ b/packages/riverpod_analyzer_utils_tests/test/type_utils_test.dart @@ -0,0 +1,184 @@ +// ignore_for_file: invalid_use_of_internal_member + +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:riverpod_analyzer_utils/src/nodes.dart'; +import 'package:test/test.dart'; + +import 'analyzer_test_utils.dart'; + +void main() { + testSource('Rejects unrelated types', source: ''' +import 'package:flutter_riverpod/flutter_riverpod.dart'; + +const random = 42; +ProviderBase? fromRiverpod = null; +Consumer? fromFlutterRiverpod = null; +''', (resolver, unit, units) async { + final variables = + unit.declarations.whereType(); + + expect(variables, hasLength(3)); + + for (final variable in variables) { + expect( + parseLegacyProviderType( + variable.variables.variables.single.declaredElement!.type, + ), + isNull, + reason: variable.toString(), + ); + expect( + parseFirstProviderFor( + variable.variables.variables.single.declaredElement!, + ), + isNull, + reason: variable.toString(), + ); + } + }); + + testSource('Parses all generated providers', runGenerator: true, source: r''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'foo.g.dart'; + +Never throws() => throw UnimplementedError(); + +@riverpod +int a(ARef ref) => throws(); + +@riverpod +class B extends _$B { + @override + int build() => throws();; +} + +@riverpod +int c(CRef ref, int arg) => throws(); + +@riverpod +class D extends _$D { + @override + int build(int arg) => throws(); +} + + +@riverpod +Future a2(A2Ref ref) => throws(); + +@riverpod +class B2 extends _$B2 { + @override + Future build() => throws();; +} + +@riverpod +Future c2(C2Ref ref, int arg) => throws(); + +@riverpod +class D2 extends _$D2 { + @override + Future build(int arg) => throws(); +} + + +@riverpod +Stream a3(A3Ref ref) => throws(); + +@riverpod +class B3 extends _$B3 { + @override + Stream build() => throws();; +} + +@riverpod +Stream c3(C3Ref ref, int arg) => throws(); + +@riverpod +class D3 extends _$D3 { + @override + Stream build(int arg) => throws(); +} +''', (resolver, unit, units) async { + final generated = units.singleWhere((e) => e.path.endsWith('.g.dart')).unit; + + final variables = generated.declarations + .whereType() + .toList(); + + expect(variables, hasLength(12)); + + for (final variable in variables) { + expect( + parseFirstProviderFor( + variable.variables.variables.single.declaredElement!, + )?.$1, + isNotNull, + reason: variable.toString(), + ); + expect( + parseLegacyProviderType( + variable.variables.variables.single.declaredElement!.type, + ), + isNull, + reason: variable.toString(), + ); + } + }); + + testSource('Parses all legacy providers', source: ''' +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_riverpod/legacy.dart'; + +Never throws() => throw UnimplementedError(); + +final provider = Provider((ref) => throws()); +final providerFamily = Provider.family((ref, id) => throws()); + +final stateProvider = StateProvider((ref) => throws()); +final stateProviderFamily = StateProvider.family((ref, id) => throws()); + +final futureProvider = FutureProvider((ref) async => throws()); +final futureProviderFamily = FutureProvider.family((ref, id) => throws()); + +final streamProvider = StreamProvider((ref) => throws()); +final streamProviderFamily = StreamProvider.family((ref, id) => throws()); + +final changeNotifierProvider = ChangeNotifierProvider((ref) => throws()); +final changeNotifierProviderFamily = ChangeNotifierProvider.family((ref, id) => throws()); + +final stateNotifierProvider = StateNotifierProvider((ref) => throws()); +final stateNotifierProviderFamily = StateNotifierProvider.family((ref, id) => throws()); + +final notifierProvider = NotifierProvider(() => throws()); +final notifierProviderFamily = NotifierProvider.family((ref, id) => throws()); + +final asyncNotifierProvider = AsyncNotifierProvider((ref) => throws()); +final asyncNotifierProviderFamily = AsyncNotifierProvider.family((ref, id) => throws()); + +final streamNotifierProvider = StreamNotifierProvider((ref) => throws()); +final streamNotifierProviderFamily = StreamNotifierProvider.family((ref, id) => throws()); +''', (resolver, unit, units) async { + final variables = + unit.declarations.whereType(); + + expect(variables, hasLength(18)); + + for (final variable in variables) { + expect( + parseLegacyProviderType( + variable.variables.variables.single.declaredElement!.type, + ), + isNotNull, + reason: variable.toString(), + ); + expect( + parseFirstProviderFor( + variable.variables.variables.single.declaredElement!, + ), + isNull, + reason: variable.toString(), + ); + } + }); +} diff --git a/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart b/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart index 1ada87b0b..808ec790b 100644 --- a/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart @@ -1,7 +1,27 @@ +import 'package:riverpod_analyzer_utils/src/nodes.dart'; import 'package:test/test.dart'; import 'analyzer_test_utils.dart'; +// ignore: invalid_use_of_internal_member +extension on RiverpodAnalysisResult { + List get widgetRefWatchInvocations { + return widgetRefInvocations.cast(); + } + + List get widgetRefReadInvocations { + return widgetRefInvocations.cast(); + } + + List get widgetRefListenInvocations { + return widgetRefInvocations.cast(); + } + + List get widgetRefListenManualInvocations { + return widgetRefInvocations.cast(); + } +} + void main() { testSource('Decode watch expressions with syntax errors', source: ''' import 'package:riverpod_annotation/riverpod_annotation.dart'; @@ -18,7 +38,7 @@ class Example extends ConsumerWidget { return Container(); } } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult( ignoreErrors: true, ); @@ -30,21 +50,14 @@ class Example extends ConsumerWidget { 'ref.watch(gibberishProvider)', ); expect( - result.widgetRefWatchInvocations.single.provider.familyArguments, + result.widgetRefWatchInvocations.single.listenable.familyArguments, null, ); expect( - result.widgetRefWatchInvocations.single.provider.node.toSource(), - 'gibberishProvider', - ); - expect( - result.widgetRefWatchInvocations.single.provider.provider?.toSource(), + result.widgetRefWatchInvocations.single.listenable.node.toSource(), 'gibberishProvider', ); - expect( - result.widgetRefWatchInvocations.single.provider.providerElement, - null, - ); + expect(result.widgetRefWatchInvocations.single.listenable.provider, isNull); }); testSource('Decodes ..watch', runGenerator: true, source: r''' @@ -79,7 +92,7 @@ class MyWidget extends ConsumerWidget { return Container(); } } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); expect(result.widgetRefWatchInvocations, hasLength(3)); @@ -90,14 +103,20 @@ class MyWidget extends ConsumerWidget { '..watch(dep)', ); expect(result.widgetRefWatchInvocations[0].function.toSource(), 'watch'); - expect(result.widgetRefWatchInvocations[0].provider.node.toSource(), 'dep'); - expect(result.widgetRefWatchInvocations[0].provider.familyArguments, null); expect( - result.widgetRefWatchInvocations[0].provider.provider?.toSource(), + result.widgetRefWatchInvocations[0].listenable.node.toSource(), 'dep', ); expect( - result.widgetRefWatchInvocations[0].provider.providerElement, + result.widgetRefWatchInvocations[0].listenable.familyArguments, + null, + ); + expect( + result.widgetRefWatchInvocations[0].listenable.provider?.node.toSource(), + 'dep', + ); + expect( + result.widgetRefWatchInvocations[0].listenable.provider?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); @@ -107,22 +126,25 @@ class MyWidget extends ConsumerWidget { ); expect(result.widgetRefWatchInvocations[1].function.toSource(), 'watch'); expect( - result.widgetRefWatchInvocations[1].provider.node.toSource(), + result.widgetRefWatchInvocations[1].listenable.node.toSource(), 'dep2Provider', ); expect( - result.widgetRefWatchInvocations[1].provider.provider?.toSource(), + result.widgetRefWatchInvocations[1].listenable.provider?.node.toSource(), 'dep2Provider', ); expect( - result.widgetRefWatchInvocations[1].provider.providerElement, + result.widgetRefWatchInvocations[1].listenable.provider?.providerElement, same( result.functionalProviderDeclarations .findByName('dep2') .providerElement, ), ); - expect(result.widgetRefWatchInvocations[1].provider.familyArguments, null); + expect( + result.widgetRefWatchInvocations[1].listenable.familyArguments, + null, + ); expect( result.widgetRefWatchInvocations[2].node.toSource(), @@ -130,22 +152,25 @@ class MyWidget extends ConsumerWidget { ); expect(result.widgetRefWatchInvocations[2].function.toSource(), 'watch'); expect( - result.widgetRefWatchInvocations[2].provider.node.toSource(), + result.widgetRefWatchInvocations[2].listenable.node.toSource(), 'dep3Provider', ); expect( - result.widgetRefWatchInvocations[2].provider.provider?.toSource(), + result.widgetRefWatchInvocations[2].listenable.provider?.node.toSource(), 'dep3Provider', ); expect( - result.widgetRefWatchInvocations[2].provider.providerElement, + result.widgetRefWatchInvocations[2].listenable.provider?.providerElement, same( result.classBasedProviderDeclarations .findByName('Dep3') .providerElement, ), ); - expect(result.widgetRefWatchInvocations[2].provider.familyArguments, null); + expect( + result.widgetRefWatchInvocations[2].listenable.familyArguments, + null, + ); }); testSource('Decodes simple ref.watch usages', runGenerator: true, source: r''' @@ -191,7 +216,7 @@ class _Ref { void fn(_Ref ref) { ref.watch(dep); } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); expect(result.widgetRefWatchInvocations, hasLength(3)); @@ -202,14 +227,20 @@ void fn(_Ref ref) { 'ref.watch(dep)', ); expect(result.widgetRefWatchInvocations[0].function.toSource(), 'watch'); - expect(result.widgetRefWatchInvocations[0].provider.node.toSource(), 'dep'); - expect(result.widgetRefWatchInvocations[0].provider.familyArguments, null); expect( - result.widgetRefWatchInvocations[0].provider.provider?.toSource(), + result.widgetRefWatchInvocations[0].listenable.node.toSource(), + 'dep', + ); + expect( + result.widgetRefWatchInvocations[0].listenable.familyArguments, + null, + ); + expect( + result.widgetRefWatchInvocations[0].listenable.provider?.node.toSource(), 'dep', ); expect( - result.widgetRefWatchInvocations[0].provider.providerElement, + result.widgetRefWatchInvocations[0].listenable.provider?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); @@ -219,22 +250,25 @@ void fn(_Ref ref) { ); expect(result.widgetRefWatchInvocations[1].function.toSource(), 'watch'); expect( - result.widgetRefWatchInvocations[1].provider.node.toSource(), + result.widgetRefWatchInvocations[1].listenable.node.toSource(), 'dep2Provider', ); expect( - result.widgetRefWatchInvocations[1].provider.provider?.toSource(), + result.widgetRefWatchInvocations[1].listenable.provider?.node.toSource(), 'dep2Provider', ); expect( - result.widgetRefWatchInvocations[1].provider.providerElement, + result.widgetRefWatchInvocations[1].listenable.provider?.providerElement, same( result.functionalProviderDeclarations .findByName('dep2') .providerElement, ), ); - expect(result.widgetRefWatchInvocations[1].provider.familyArguments, null); + expect( + result.widgetRefWatchInvocations[1].listenable.familyArguments, + null, + ); expect( result.widgetRefWatchInvocations[2].node.toSource(), @@ -242,22 +276,25 @@ void fn(_Ref ref) { ); expect(result.widgetRefWatchInvocations[2].function.toSource(), 'watch'); expect( - result.widgetRefWatchInvocations[2].provider.node.toSource(), + result.widgetRefWatchInvocations[2].listenable.node.toSource(), 'dep3Provider', ); expect( - result.widgetRefWatchInvocations[2].provider.provider?.toSource(), + result.widgetRefWatchInvocations[2].listenable.provider?.node.toSource(), 'dep3Provider', ); expect( - result.widgetRefWatchInvocations[2].provider.providerElement, + result.widgetRefWatchInvocations[2].listenable.provider?.providerElement, same( result.classBasedProviderDeclarations .findByName('Dep3') .providerElement, ), ); - expect(result.widgetRefWatchInvocations[2].provider.familyArguments, null); + expect( + result.widgetRefWatchInvocations[2].listenable.familyArguments, + null, + ); }); testSource('Decodes unknown ref usages', source: ''' @@ -272,22 +309,20 @@ void fn(WidgetRef ref) { ref.read(dep); ref.read(dep2); } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); - final libraryResult = result.resolvedRiverpodLibraryResults.single; - - expect(libraryResult.unknownWidgetRefInvocations, hasLength(2)); + expect(result.widgetRefInvocations, hasLength(2)); expect( result.widgetRefReadInvocations, - libraryResult.unknownWidgetRefInvocations, + result.widgetRefInvocations, ); expect(result.widgetRefInvocations, result.widgetRefReadInvocations); expect(result.widgetRefReadInvocations[0].node.toSource(), 'ref.read(dep)'); expect(result.widgetRefReadInvocations[0].function.toSource(), 'read'); expect( - result.widgetRefReadInvocations[0].provider.providerElement, + result.widgetRefReadInvocations[0].listenable.provider?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); @@ -297,7 +332,7 @@ void fn(WidgetRef ref) { ); expect(result.widgetRefReadInvocations[1].function.toSource(), 'read'); expect( - result.widgetRefReadInvocations[1].provider.providerElement, + result.widgetRefReadInvocations[1].listenable.provider?.providerElement, same( result.legacyProviderDeclarations.findByName('dep2').providerElement, ), @@ -323,7 +358,7 @@ class MyWidget extends ConsumerWidget { return Container(); } } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); expect(result.widgetRefListenInvocations, hasLength(1)); @@ -339,7 +374,7 @@ class MyWidget extends ConsumerWidget { '(prev, next) {}', ); expect( - result.widgetRefListenInvocations[0].provider.providerElement, + result.widgetRefListenInvocations[0].listenable.provider?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); }); @@ -365,7 +400,7 @@ class MyWidget extends ConsumerWidget { return Container(); } } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); expect(result.widgetRefListenManualInvocations, hasLength(3)); @@ -387,7 +422,8 @@ class MyWidget extends ConsumerWidget { '(prev, next) {}', ); expect( - result.widgetRefListenManualInvocations[0].provider.providerElement, + result.widgetRefListenManualInvocations[0].listenable.provider + ?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); @@ -404,7 +440,8 @@ class MyWidget extends ConsumerWidget { '(prev, next) {}', ); expect( - result.widgetRefListenManualInvocations[1].provider.providerElement, + result.widgetRefListenManualInvocations[1].listenable.provider + ?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); @@ -421,7 +458,8 @@ class MyWidget extends ConsumerWidget { '(prev, next) {}', ); expect( - result.widgetRefListenManualInvocations[2].provider.providerElement, + result.widgetRefListenManualInvocations[2].listenable.provider + ?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); }); @@ -449,7 +487,7 @@ class MyWidget extends ConsumerWidget { return Container(); } } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); expect(result.widgetRefReadInvocations, hasLength(2)); @@ -458,7 +496,7 @@ class MyWidget extends ConsumerWidget { expect(result.widgetRefReadInvocations[0].node.toSource(), 'ref.read(dep)'); expect(result.widgetRefReadInvocations[0].function.toSource(), 'read'); expect( - result.widgetRefReadInvocations[0].provider.providerElement, + result.widgetRefReadInvocations[0].listenable.provider?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); @@ -468,7 +506,7 @@ class MyWidget extends ConsumerWidget { ); expect(result.widgetRefReadInvocations[1].function.toSource(), 'read'); expect( - result.widgetRefReadInvocations[1].provider.providerElement, + result.widgetRefReadInvocations[1].listenable.provider?.providerElement, same( result.legacyProviderDeclarations.findByName('dep2').providerElement, ), @@ -517,20 +555,14 @@ class _Ref { void fn(_Ref ref) { ref.watch(family(0)); } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); - final libraryResult = result.resolvedRiverpodLibraryResults.single; - - expect(libraryResult.unknownRefInvocations, isEmpty); - expect(libraryResult.unknownWidgetRefInvocations, isEmpty); - - final providerRefInvocations = - libraryResult.consumerWidgetDeclarations.single.widgetRefInvocations; + final providerRefInvocations = result.widgetRefInvocations; expect(result.widgetRefWatchInvocations, hasLength(3)); expect(result.widgetRefInvocations, result.widgetRefWatchInvocations); - expect(result.widgetRefInvocations, providerRefInvocations); + expect(result.widgetRefWatchInvocations, providerRefInvocations); expect( result.widgetRefWatchInvocations[0].node.toSource(), @@ -538,21 +570,22 @@ void fn(_Ref ref) { ); expect(result.widgetRefWatchInvocations[0].function.toSource(), 'watch'); expect( - result.widgetRefWatchInvocations[0].provider.node.toSource(), + result.widgetRefWatchInvocations[0].listenable.node.toSource(), 'family(0)', ); expect( - result.widgetRefWatchInvocations[0].provider.provider?.toSource(), + result.widgetRefWatchInvocations[0].listenable.provider?.node.toSource(), 'family', ); expect( - result.widgetRefWatchInvocations[0].provider.providerElement, + result.widgetRefWatchInvocations[0].listenable.provider?.providerElement, same( result.legacyProviderDeclarations.findByName('family').providerElement, ), ); expect( - result.widgetRefWatchInvocations[0].provider.familyArguments?.toSource(), + result.widgetRefWatchInvocations[0].listenable.familyArguments + ?.toSource(), '(0)', ); @@ -562,15 +595,15 @@ void fn(_Ref ref) { ); expect(result.widgetRefWatchInvocations[1].function.toSource(), 'watch'); expect( - result.widgetRefWatchInvocations[1].provider.node.toSource(), + result.widgetRefWatchInvocations[1].listenable.node.toSource(), 'family2Provider(id: 0)', ); expect( - result.widgetRefWatchInvocations[1].provider.provider?.toSource(), + result.widgetRefWatchInvocations[1].listenable.provider?.node.toSource(), 'family2Provider', ); expect( - result.widgetRefWatchInvocations[1].provider.providerElement, + result.widgetRefWatchInvocations[1].listenable.provider?.providerElement, same( result.functionalProviderDeclarations .findByName('family2') @@ -578,7 +611,8 @@ void fn(_Ref ref) { ), ); expect( - result.widgetRefWatchInvocations[1].provider.familyArguments?.toSource(), + result.widgetRefWatchInvocations[1].listenable.familyArguments + ?.toSource(), '(id: 0)', ); @@ -588,15 +622,15 @@ void fn(_Ref ref) { ); expect(result.widgetRefWatchInvocations[2].function.toSource(), 'watch'); expect( - result.widgetRefWatchInvocations[2].provider.node.toSource(), + result.widgetRefWatchInvocations[2].listenable.node.toSource(), 'family3Provider(id: 0)', ); expect( - result.widgetRefWatchInvocations[2].provider.provider?.toSource(), + result.widgetRefWatchInvocations[2].listenable.provider?.node.toSource(), 'family3Provider', ); expect( - result.widgetRefWatchInvocations[2].provider.providerElement, + result.widgetRefWatchInvocations[2].listenable.provider?.providerElement, same( result.classBasedProviderDeclarations .findByName('Family3') @@ -604,7 +638,8 @@ void fn(_Ref ref) { ), ); expect( - result.widgetRefWatchInvocations[2].provider.familyArguments?.toSource(), + result.widgetRefWatchInvocations[2].listenable.familyArguments + ?.toSource(), '(id: 0)', ); }); @@ -669,7 +704,7 @@ class _Ref { void fn(_Ref ref) { ref.watch(dep); } -''', (resolver) async { +''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); expect(result.widgetRefWatchInvocations, hasLength(4)); @@ -681,16 +716,19 @@ void fn(_Ref ref) { ); expect(result.widgetRefWatchInvocations[0].function.toSource(), 'watch'); expect( - result.widgetRefWatchInvocations[0].provider.node.toSource(), + result.widgetRefWatchInvocations[0].listenable.node.toSource(), 'dep.select((e) => e)', ); - expect(result.widgetRefWatchInvocations[0].provider.familyArguments, null); expect( - result.widgetRefWatchInvocations[0].provider.provider?.toSource(), + result.widgetRefWatchInvocations[0].listenable.familyArguments, + null, + ); + expect( + result.widgetRefWatchInvocations[0].listenable.provider?.node.toSource(), 'dep', ); expect( - result.widgetRefWatchInvocations[0].provider.providerElement, + result.widgetRefWatchInvocations[0].listenable.provider?.providerElement, same(result.legacyProviderDeclarations.findByName('dep').providerElement), ); @@ -700,16 +738,19 @@ void fn(_Ref ref) { ); expect(result.widgetRefWatchInvocations[1].function.toSource(), 'watch'); expect( - result.widgetRefWatchInvocations[1].provider.node.toSource(), + result.widgetRefWatchInvocations[1].listenable.node.toSource(), 'dep2Provider.select((e) => e)', ); - expect(result.widgetRefWatchInvocations[1].provider.familyArguments, null); expect( - result.widgetRefWatchInvocations[1].provider.provider?.toSource(), + result.widgetRefWatchInvocations[1].listenable.familyArguments, + null, + ); + expect( + result.widgetRefWatchInvocations[1].listenable.provider?.node.toSource(), 'dep2Provider', ); expect( - result.widgetRefWatchInvocations[1].provider.providerElement, + result.widgetRefWatchInvocations[1].listenable.provider?.providerElement, same( result.functionalProviderDeclarations .findByName('dep2') @@ -723,16 +764,19 @@ void fn(_Ref ref) { ); expect(result.widgetRefWatchInvocations[2].function.toSource(), 'watch'); expect( - result.widgetRefWatchInvocations[2].provider.node.toSource(), + result.widgetRefWatchInvocations[2].listenable.node.toSource(), 'dep3Provider.select((e) => e)', ); - expect(result.widgetRefWatchInvocations[2].provider.familyArguments, null); expect( - result.widgetRefWatchInvocations[2].provider.provider?.toSource(), + result.widgetRefWatchInvocations[2].listenable.familyArguments, + null, + ); + expect( + result.widgetRefWatchInvocations[2].listenable.provider?.node.toSource(), 'dep3Provider', ); expect( - result.widgetRefWatchInvocations[2].provider.providerElement, + result.widgetRefWatchInvocations[2].listenable.provider?.providerElement, same( result.classBasedProviderDeclarations .findByName('Dep3') @@ -746,19 +790,20 @@ void fn(_Ref ref) { ); expect(result.widgetRefWatchInvocations[3].function.toSource(), 'watch'); expect( - result.widgetRefWatchInvocations[3].provider.node.toSource(), + result.widgetRefWatchInvocations[3].listenable.node.toSource(), 'familyProvider(id: 42).notifier.select((e) => e).getter.method()[0]', ); expect( - result.widgetRefWatchInvocations[3].provider.familyArguments?.toSource(), + result.widgetRefWatchInvocations[3].listenable.familyArguments + ?.toSource(), '(id: 42)', ); expect( - result.widgetRefWatchInvocations[3].provider.provider?.toSource(), + result.widgetRefWatchInvocations[3].listenable.provider?.node.toSource(), 'familyProvider', ); expect( - result.widgetRefWatchInvocations[3].provider.providerElement, + result.widgetRefWatchInvocations[3].listenable.provider?.providerElement, same( result.classBasedProviderDeclarations .findByName('Family') diff --git a/packages/riverpod_annotation/CHANGELOG.md b/packages/riverpod_annotation/CHANGELOG.md index 7d1e9f47b..aa407b761 100644 --- a/packages/riverpod_annotation/CHANGELOG.md +++ b/packages/riverpod_annotation/CHANGELOG.md @@ -1,3 +1,10 @@ +## Unreleased build + +- Made `@Riverpod` final +- Added `@Dependencies([...])`, for lint purposes. + This is similar to `@Riverpod(dependencies: [...])`, but is applied on + non-provider objects that may use a scoped provider. + ## 3.0.0-dev.3 - 2023-11-27 - `riverpod` upgraded to `3.0.0-dev.3` diff --git a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart index 2e2d1b295..a7288ea2a 100644 --- a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart @@ -18,7 +18,6 @@ import 'package:riverpod/src/internals.dart' show ProviderElementBase; /// {@endtemplate} @Target({TargetKind.classType, TargetKind.function}) @sealed -// TODO changelog make "Riverpod" final final class Riverpod { /// {@macro riverpod_annotation.provider} const Riverpod({ @@ -104,7 +103,19 @@ final class Riverpod { /// In that scenario, the `dependencies` parameter is required and it must /// include `scopedProvider`. /// + /// **Note**: + /// It is not necessary to specify an empty "dependencies" on notifiers with + /// an abstract build method: + /// ```dart + /// @riverpod + /// class MyNotifier extends _$MyNotifier { + /// @override + /// int build(); // Valid, marks this notifier as scoped + /// } + /// ``` + /// /// See also: + /// - [Dependencies], for specifying dependencies on non-providers. /// - [provider_dependencies](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint#provider_dependencies-riverpod_generator-only) /// and [scoped_providers_should_specify_dependencies](https://github.com/rrousselGit/riverpod/tree/master/packages/riverpod_lint#scoped_providers_should_specify_dependencies-generator-only).\ /// These are lint rules that will warn about incorrect `dependencies` usages. @@ -195,3 +206,74 @@ class MissingScopeException implements Exception { 'Either you forgot to override the provider, or you tried to read it outside of where it is defined'; } } + +/// {@template riverpod_annotation.dependencies} +/// An annotation to be specified on non-provider objects that use scoped providers. +/// +/// This is equivalent to `@Riverpod(dependencies: [])`, but for non-provider objects. +/// This is most commonly used on `Consumer`s, but can be used on anything, +/// including functions. +/// +/// The sole purpose of this annotation is to notify the linter +/// that an object uses a scoped provider. +/// It then enables the linter to warn in case this object is used in a place +/// where the scoped provider is not overridden. +/// +/// ## Usage example: +/// +/// Consider the following scoped provider: +/// ```dart +/// @Riverpod(dependencies: []) +/// String selectedBookID(SelectedBookIDRef ref) => throw UnimplementedError(); +/// ``` +/// +/// Since this provider is scoped, we should specify `@Dependencies` on any object +/// that uses it. +/// For instance, a `Consumer`: +/// +/// ```dart +/// @Dependencies([selectedBookID]) +/// class BookView extends ConsumerWidget { +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// final selectedBookID = ref.watch(selectedBookIDProvider); +/// return Text(selectedBookID); +/// } +/// } +/// ``` +/// +/// By doing so, using `BooKView` now requires either: +/// - overriding `selectedBookIDProvider` in a `ProviderScope` that is an ancestor +/// of `BookView`: +/// ```dart +/// ProviderScope( +/// overrides: [ +/// selectedBookIDProvider.overrideWithValue('myBookID'), +/// ], +/// child: BookView(), +/// ), +/// ``` +/// - or using `BookView` in a widget that also specifies `@Dependencies([selectedBookID])`: +/// ```dart +/// @Dependencies([selectedBookID]) +/// class MyWidget extends StatelessWidget { +/// @override +/// Widget build(BuildContext context) { +/// return BookView(); +/// } +/// } +/// ``` +/// +/// Failing to do so will result in a linter warning. +/// +/// **Note**: When using a `StatefulWidget` (or variant), +/// there is no need to specify `@Dependencies` on the `State` class. +/// Specifying it on the `StatefulWidget` is enough. +/// {@endtemplate} +class Dependencies { + /// {@macro riverpod_annotation.dependencies} + const Dependencies(this.dependencies); + + /// {@macro riverpod_annotation.dependencies} + final List dependencies; +} diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 0b235425e..e91370632 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -14,6 +14,30 @@ } ) ``` +- Generated providers are now always `const`. +- Added support for abstract `build` method on Notifiers: + ```dart + @riverpod + class Example extends _$Example { + @override + int build(); + } + ``` + This is equivalent to writing: + ```dart + @Riverpod(dependencies: []) + class Example extends _$Example { + @override + int build() => throw UnimplementedError(); + } + ``` +- Added support for documentation and annotations on providers/parameters. + Comments on providers and family parameters will be + injected in the generated code, for IDE documentation + in the relevant places. + Annotations will be pasted over, such as to mark parameters + as `@deprecated` everywhere. +- Updated to support latest `riverpod_analyzer_utils` ## 3.0.0-dev.11 - 2023-11-27 diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index d467d51bb..2dd0ef2ba 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -169,6 +169,199 @@ final class CountStreamProvider String _$countStreamHash() => r'1dbe49244ea19e8dbc3af0534429bb323720c07a'; +@ProviderFor(CountNotifier) +const countNotifierPod = CountNotifierProvider._(); + +final class CountNotifierProvider + extends $NotifierProvider { + const CountNotifierProvider._( + {super.runNotifierBuildOverride, CountNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'countNotifierPod', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CountNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$countNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + CountNotifier create() => _createCb?.call() ?? CountNotifier(); + + @$internal + @override + CountNotifierProvider $copyWithCreate( + CountNotifier Function() create, + ) { + return CountNotifierProvider._(create: create); + } + + @$internal + @override + CountNotifierProvider $copyWithBuild( + int Function( + Ref, + CountNotifier, + ) build, + ) { + return CountNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$countNotifierHash() => r'a8dd7a66ee0002b8af657245c4affaa206fd99ec'; + +abstract class _$CountNotifier extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +@ProviderFor(CountAsyncNotifier) +const countAsyncNotifierPod = CountAsyncNotifierProvider._(); + +final class CountAsyncNotifierProvider + extends $AsyncNotifierProvider { + const CountAsyncNotifierProvider._( + {super.runNotifierBuildOverride, CountAsyncNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'countAsyncNotifierPod', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CountAsyncNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$countAsyncNotifierHash(); + + @$internal + @override + CountAsyncNotifier create() => _createCb?.call() ?? CountAsyncNotifier(); + + @$internal + @override + CountAsyncNotifierProvider $copyWithCreate( + CountAsyncNotifier Function() create, + ) { + return CountAsyncNotifierProvider._(create: create); + } + + @$internal + @override + CountAsyncNotifierProvider $copyWithBuild( + FutureOr Function( + Ref>, + CountAsyncNotifier, + ) build, + ) { + return CountAsyncNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); +} + +String _$countAsyncNotifierHash() => + r'2a7049d864bf396e44a5937b4001efb4774a5f29'; + +abstract class _$CountAsyncNotifier extends $AsyncNotifier { + FutureOr build(); + @$internal + @override + FutureOr runBuild() => build(); +} + +@ProviderFor(CountStreamNotifier) +const countStreamNotifierPod = CountStreamNotifierProvider._(); + +final class CountStreamNotifierProvider + extends $StreamNotifierProvider { + const CountStreamNotifierProvider._( + {super.runNotifierBuildOverride, CountStreamNotifier Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'countStreamNotifierPod', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final CountStreamNotifier Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$countStreamNotifierHash(); + + @$internal + @override + CountStreamNotifier create() => _createCb?.call() ?? CountStreamNotifier(); + + @$internal + @override + CountStreamNotifierProvider $copyWithCreate( + CountStreamNotifier Function() create, + ) { + return CountStreamNotifierProvider._(create: create); + } + + @$internal + @override + CountStreamNotifierProvider $copyWithBuild( + Stream Function( + Ref>, + CountStreamNotifier, + ) build, + ) { + return CountStreamNotifierProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $StreamNotifierProviderElement $createElement( + ProviderContainer container) => + $StreamNotifierProviderElement(this, container); +} + +String _$countStreamNotifierHash() => + r'61d2cd311c4808f8d7e8b2d67f5c7b85337666c6'; + +abstract class _$CountStreamNotifier extends $StreamNotifier { + Stream build(); + @$internal + @override + Stream runBuild() => build(); +} + typedef Count2Ref = Ref; @ProviderFor(count2) @@ -548,199 +741,6 @@ final class CountStream2Family extends Family { } } -@ProviderFor(CountNotifier) -const countNotifierPod = CountNotifierProvider._(); - -final class CountNotifierProvider - extends $NotifierProvider { - const CountNotifierProvider._( - {super.runNotifierBuildOverride, CountNotifier Function()? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'countNotifierPod', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final CountNotifier Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$countNotifierHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - CountNotifier create() => _createCb?.call() ?? CountNotifier(); - - @$internal - @override - CountNotifierProvider $copyWithCreate( - CountNotifier Function() create, - ) { - return CountNotifierProvider._(create: create); - } - - @$internal - @override - CountNotifierProvider $copyWithBuild( - int Function( - Ref, - CountNotifier, - ) build, - ) { - return CountNotifierProvider._(runNotifierBuildOverride: build); - } - - @$internal - @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); -} - -String _$countNotifierHash() => r'a8dd7a66ee0002b8af657245c4affaa206fd99ec'; - -abstract class _$CountNotifier extends $Notifier { - int build(); - @$internal - @override - int runBuild() => build(); -} - -@ProviderFor(CountAsyncNotifier) -const countAsyncNotifierPod = CountAsyncNotifierProvider._(); - -final class CountAsyncNotifierProvider - extends $AsyncNotifierProvider { - const CountAsyncNotifierProvider._( - {super.runNotifierBuildOverride, CountAsyncNotifier Function()? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'countAsyncNotifierPod', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final CountAsyncNotifier Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$countAsyncNotifierHash(); - - @$internal - @override - CountAsyncNotifier create() => _createCb?.call() ?? CountAsyncNotifier(); - - @$internal - @override - CountAsyncNotifierProvider $copyWithCreate( - CountAsyncNotifier Function() create, - ) { - return CountAsyncNotifierProvider._(create: create); - } - - @$internal - @override - CountAsyncNotifierProvider $copyWithBuild( - FutureOr Function( - Ref>, - CountAsyncNotifier, - ) build, - ) { - return CountAsyncNotifierProvider._(runNotifierBuildOverride: build); - } - - @$internal - @override - $AsyncNotifierProviderElement $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); -} - -String _$countAsyncNotifierHash() => - r'2a7049d864bf396e44a5937b4001efb4774a5f29'; - -abstract class _$CountAsyncNotifier extends $AsyncNotifier { - FutureOr build(); - @$internal - @override - FutureOr runBuild() => build(); -} - -@ProviderFor(CountStreamNotifier) -const countStreamNotifierPod = CountStreamNotifierProvider._(); - -final class CountStreamNotifierProvider - extends $StreamNotifierProvider { - const CountStreamNotifierProvider._( - {super.runNotifierBuildOverride, CountStreamNotifier Function()? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'countStreamNotifierPod', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final CountStreamNotifier Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$countStreamNotifierHash(); - - @$internal - @override - CountStreamNotifier create() => _createCb?.call() ?? CountStreamNotifier(); - - @$internal - @override - CountStreamNotifierProvider $copyWithCreate( - CountStreamNotifier Function() create, - ) { - return CountStreamNotifierProvider._(create: create); - } - - @$internal - @override - CountStreamNotifierProvider $copyWithBuild( - Stream Function( - Ref>, - CountStreamNotifier, - ) build, - ) { - return CountStreamNotifierProvider._(runNotifierBuildOverride: build); - } - - @$internal - @override - $StreamNotifierProviderElement $createElement( - ProviderContainer container) => - $StreamNotifierProviderElement(this, container); -} - -String _$countStreamNotifierHash() => - r'61d2cd311c4808f8d7e8b2d67f5c7b85337666c6'; - -abstract class _$CountStreamNotifier extends $StreamNotifier { - Stream build(); - @$internal - @override - Stream runBuild() => build(); -} - @ProviderFor(CountNotifier2) const countNotifier2ProviderFamily = CountNotifier2Family._(); @@ -1210,6 +1210,5 @@ abstract class _$CountStreamNotifier2 extends $StreamNotifier { ); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index 48573fcaa..a5a6b1453 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -65,12 +65,20 @@ class RiverpodGenerator extends ParserGenerator { @override String generateForUnit(List compilationUnits) { - final riverpodResult = ResolvedRiverpodLibraryResult.from(compilationUnits); - return runGenerator(riverpodResult); - } + final buffer = StringBuffer(); + + final errors = []; + final previousErrorReporter = errorReporter; + + try { + errorReporter = errors.add; + _generate(compilationUnits, buffer); + } finally { + errorReporter = previousErrorReporter; + } - String runGenerator(ResolvedRiverpodLibraryResult riverpodResult) { - for (final error in riverpodResult.errors) { + // Running at the end to aggregate all errors. + for (final error in errors) { throw RiverpodInvalidGenerationSourceError( error.message, element: error.targetElement, @@ -78,27 +86,35 @@ class RiverpodGenerator extends ParserGenerator { ); } - final buffer = StringBuffer(); + return buffer.toString(); + } - riverpodResult.visitChildren(_RiverpodGeneratorVisitor(buffer, options)); + void _generate(List units, StringBuffer buffer) { + final visitor = _RiverpodGeneratorVisitor(buffer, options); + for (final unit in units.expand((e) => e.declarations)) { + final provider = unit.provider; + + switch (provider) { + case ClassBasedProviderDeclaration(): + visitor.visitClassBasedProviderDeclaration(provider); + case FunctionalProviderDeclaration(): + visitor.visitFunctionalProviderDeclaration(provider); + default: + continue; + } + } // Only emit the header if we actually generated something if (buffer.isNotEmpty) { - buffer.writeln( - r"const $kDebugMode = bool.fromEnvironment('dart.vm.product');", - ); - buffer.write(''' // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main '''); } - - return buffer.toString(); } } -class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { +class _RiverpodGeneratorVisitor { _RiverpodGeneratorVisitor(this.buffer, this.options); final StringBuffer buffer; @@ -132,7 +148,7 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { GeneratorProviderDeclaration provider, ) { // TODO throw if a dependency is not accessible in the current library. - final dependencies = provider.annotation.dependencies?.dependencies; + final dependencies = provider.annotation.dependencyList?.values; if (dependencies == null) return null; final allTransitiveDependencies = []; @@ -180,20 +196,16 @@ class _RiverpodGeneratorVisitor extends RecursiveRiverpodAstVisitor { return allTransitiveDependencies; } - @override void visitClassBasedProviderDeclaration( ClassBasedProviderDeclaration provider, ) { - super.visitClassBasedProviderDeclaration(provider); visitGeneratorProviderDeclaration(provider); NotifierTemplate(provider).run(buffer); } - @override void visitFunctionalProviderDeclaration( FunctionalProviderDeclaration provider, ) { - super.visitFunctionalProviderDeclaration(provider); RefTemplate(provider).run(buffer); visitGeneratorProviderDeclaration(provider); } @@ -217,7 +229,7 @@ extension ProviderElementNames on GeneratorProviderDeclarationElement { String get familyTypeName => '${name.titled}Family'; String dependencies(BuildYamlOptions options) { - var dependencies = annotation.dependencies; + var dependencies = annotation.dependencies?.toSet(); if (dependencies == null && !isScoped) return 'null'; dependencies ??= {}; diff --git a/packages/riverpod_generator/pubspec.yaml b/packages/riverpod_generator/pubspec.yaml index c7aa35a6b..3ba9aa9ab 100644 --- a/packages/riverpod_generator/pubspec.yaml +++ b/packages/riverpod_generator/pubspec.yaml @@ -17,7 +17,7 @@ dependencies: crypto: ^3.0.2 meta: ^1.7.0 path: ^1.8.0 - riverpod_analyzer_utils: ^1.0.0-dev.1 + riverpod_analyzer_utils: 1.0.0-dev.1 riverpod_annotation: 3.0.0-dev.3 source_gen: ^1.2.0 diff --git a/packages/riverpod_generator/test/annotated_test.dart b/packages/riverpod_generator/test/annotated_test.dart index 62bb044ae..4ac18578e 100644 --- a/packages/riverpod_generator/test/annotated_test.dart +++ b/packages/riverpod_generator/test/annotated_test.dart @@ -11,7 +11,6 @@ void main() async { final declarations = result.unit.declarations; test('Annotations on parameters', () { - // TODO changelog added support for annotations on family parameters final notifier = declarations.findNamed(r'_$ClassBased') as ClassDeclaration; final id = notifier.members.findNamed('id'); diff --git a/packages/riverpod_generator/test/doc_test.dart b/packages/riverpod_generator/test/doc_test.dart index 569218dcb..0930cf9e4 100644 --- a/packages/riverpod_generator/test/doc_test.dart +++ b/packages/riverpod_generator/test/doc_test.dart @@ -13,7 +13,6 @@ void main() async { final result = await resolveFile2(path: file.path) as ResolvedUnitResult; final topLevelDeclarations = result.unit.declarations.toList(); - // TODO changelog added support for documentation on providers/parameters test('Doc on generated variables', () async { final doc = topLevelDeclarations.findNamed('functionalProvider').doc; diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 1699b0d41..5eb448705 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -141,6 +141,168 @@ final class FunctionalFamily extends Family { } } +@ProviderFor(ClassBased) +@Deprecated('Deprecation message') +@visibleForTesting +@protected +const classBasedProvider = ClassBasedFamily._(); + +final class ClassBasedProvider extends $NotifierProvider { + const ClassBasedProvider._( + {required ClassBasedFamily super.from, + required int super.argument, + super.runNotifierBuildOverride, + ClassBased Function()? create}) + : _createCb = create, + super( + name: r'classBasedProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ClassBased Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$classBasedHash(); + + @override + String toString() { + return r'classBasedProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + ClassBased create() => _createCb?.call() ?? ClassBased(); + + @$internal + @override + ClassBasedProvider $copyWithCreate( + ClassBased Function() create, + ) { + return ClassBasedProvider._( + argument: argument as int, + from: from! as ClassBasedFamily, + create: create); + } + + @$internal + @override + ClassBasedProvider $copyWithBuild( + String Function( + Ref, + ClassBased, + ) build, + ) { + return ClassBasedProvider._( + argument: argument as int, + from: from! as ClassBasedFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is ClassBasedProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$classBasedHash() => r'92b444806ef8a304c6e0dc3d8e2383601e781183'; + +final class ClassBasedFamily extends Family { + const ClassBasedFamily._() + : super( + name: r'classBasedProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + ClassBasedProvider call( + @Deprecated('field') int id, + ) => + ClassBasedProvider._(argument: id, from: this); + + @override + String debugGetCreateSourceHash() => _$classBasedHash(); + + @override + String toString() => r'classBasedProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + ClassBased Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ClassBasedProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + String Function(Ref ref, ClassBased notifier, int argument) build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ClassBasedProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(container); + }, + ); + } +} + +abstract class _$ClassBased extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + @Deprecated('field') + int get id => _$args; + + String build( + @Deprecated('field') int id, + ); + @$internal + @override + String runBuild() => build( + _$args, + ); +} + typedef FamilyRef = Ref; @ProviderFor(family) @@ -337,6 +499,76 @@ final class NotCopiedFunctionalProvider String _$notCopiedFunctionalHash() => r'30587ee9ceb75d5c8562015ad4a67ec0b107c1f6'; +@ProviderFor(NotCopiedClassBased) +const notCopiedClassBasedProvider = NotCopiedClassBasedProvider._(); + +final class NotCopiedClassBasedProvider + extends $NotifierProvider { + const NotCopiedClassBasedProvider._( + {super.runNotifierBuildOverride, NotCopiedClassBased Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'notCopiedClassBasedProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final NotCopiedClassBased Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$notCopiedClassBasedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + NotCopiedClassBased create() => _createCb?.call() ?? NotCopiedClassBased(); + + @$internal + @override + NotCopiedClassBasedProvider $copyWithCreate( + NotCopiedClassBased Function() create, + ) { + return NotCopiedClassBasedProvider._(create: create); + } + + @$internal + @override + NotCopiedClassBasedProvider $copyWithBuild( + String Function( + Ref, + NotCopiedClassBased, + ) build, + ) { + return NotCopiedClassBasedProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$notCopiedClassBasedHash() => + r'd2aefd08a78e3bb4c02000d4931a3bf15c01b495'; + +abstract class _$NotCopiedClassBased extends $Notifier { + String build(); + @$internal + @override + String runBuild() => build(); +} + typedef NotCopiedFamilyRef = Ref; @ProviderFor(notCopiedFamily) @@ -468,239 +700,5 @@ final class NotCopiedFamilyFamily extends Family { ); } } - -@ProviderFor(ClassBased) -@Deprecated('Deprecation message') -@visibleForTesting -@protected -const classBasedProvider = ClassBasedFamily._(); - -final class ClassBasedProvider extends $NotifierProvider { - const ClassBasedProvider._( - {required ClassBasedFamily super.from, - required int super.argument, - super.runNotifierBuildOverride, - ClassBased Function()? create}) - : _createCb = create, - super( - name: r'classBasedProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final ClassBased Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$classBasedHash(); - - @override - String toString() { - return r'classBasedProvider' - '' - '($argument)'; - } - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(String value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - ClassBased create() => _createCb?.call() ?? ClassBased(); - - @$internal - @override - ClassBasedProvider $copyWithCreate( - ClassBased Function() create, - ) { - return ClassBasedProvider._( - argument: argument as int, - from: from! as ClassBasedFamily, - create: create); - } - - @$internal - @override - ClassBasedProvider $copyWithBuild( - String Function( - Ref, - ClassBased, - ) build, - ) { - return ClassBasedProvider._( - argument: argument as int, - from: from! as ClassBasedFamily, - runNotifierBuildOverride: build); - } - - @$internal - @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); - - @override - bool operator ==(Object other) { - return other is ClassBasedProvider && other.argument == argument; - } - - @override - int get hashCode { - return argument.hashCode; - } -} - -String _$classBasedHash() => r'92b444806ef8a304c6e0dc3d8e2383601e781183'; - -final class ClassBasedFamily extends Family { - const ClassBasedFamily._() - : super( - name: r'classBasedProvider', - dependencies: null, - allTransitiveDependencies: null, - isAutoDispose: true, - ); - - ClassBasedProvider call( - @Deprecated('field') int id, - ) => - ClassBasedProvider._(argument: id, from: this); - - @override - String debugGetCreateSourceHash() => _$classBasedHash(); - - @override - String toString() => r'classBasedProvider'; - - /// {@macro riverpod.override_with} - Override overrideWith( - ClassBased Function( - int args, - ) create, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as ClassBasedProvider; - - final argument = provider.argument as int; - - return provider - .$copyWithCreate(() => create(argument)) - .$createElement(container); - }, - ); - } - - /// {@macro riverpod.override_with_build} - Override overrideWithBuild( - String Function(Ref ref, ClassBased notifier, int argument) build, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as ClassBasedProvider; - - final argument = provider.argument as int; - - return provider - .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); - }, - ); - } -} - -abstract class _$ClassBased extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; - @Deprecated('field') - int get id => _$args; - - String build( - @Deprecated('field') int id, - ); - @$internal - @override - String runBuild() => build( - _$args, - ); -} - -@ProviderFor(NotCopiedClassBased) -const notCopiedClassBasedProvider = NotCopiedClassBasedProvider._(); - -final class NotCopiedClassBasedProvider - extends $NotifierProvider { - const NotCopiedClassBasedProvider._( - {super.runNotifierBuildOverride, NotCopiedClassBased Function()? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'notCopiedClassBasedProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final NotCopiedClassBased Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$notCopiedClassBasedHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(String value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - NotCopiedClassBased create() => _createCb?.call() ?? NotCopiedClassBased(); - - @$internal - @override - NotCopiedClassBasedProvider $copyWithCreate( - NotCopiedClassBased Function() create, - ) { - return NotCopiedClassBasedProvider._(create: create); - } - - @$internal - @override - NotCopiedClassBasedProvider $copyWithBuild( - String Function( - Ref, - NotCopiedClassBased, - ) build, - ) { - return NotCopiedClassBasedProvider._(runNotifierBuildOverride: build); - } - - @$internal - @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); -} - -String _$notCopiedClassBasedHash() => - r'd2aefd08a78e3bb4c02000d4931a3bf15c01b495'; - -abstract class _$NotCopiedClassBased extends $Notifier { - String build(); - @$internal - @override - String runBuild() => build(); -} - -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index afdd063cf..c8b48e079 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -118,6 +118,155 @@ final class GenericFamily extends Family { } } +@ProviderFor(GenericClass) +const genericClassProvider = GenericClassFamily._(); + +final class GenericClassProvider + extends $AsyncNotifierProvider, List> { + const GenericClassProvider._( + {required GenericClassFamily super.from, + super.runNotifierBuildOverride, + GenericClass Function()? create}) + : _createCb = create, + super( + argument: null, + name: r'genericClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final GenericClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$genericClassHash(); + + GenericClassProvider _copyWithCreate( + GenericClass Function() create, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, create: create); + } + + GenericClassProvider _copyWithBuild( + FutureOr> Function( + Ref>>, + GenericClass, + ) build, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, runNotifierBuildOverride: build); + } + + @override + String toString() { + return r'genericClassProvider' + '<${T}>' + '()'; + } + + @$internal + @override + GenericClass create() => _createCb?.call() ?? GenericClass(); + + @$internal + @override + GenericClassProvider $copyWithCreate( + GenericClass Function() create, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, create: create); + } + + @$internal + @override + GenericClassProvider $copyWithBuild( + FutureOr> Function( + Ref>>, + GenericClass, + ) build, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, runNotifierBuildOverride: build); + } + + @$internal + @override + $AsyncNotifierProviderElement, List> $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is GenericClassProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } +} + +String _$genericClassHash() => r'd3c4acc9cdae12f6c666fbf1f89aee212bb086db'; + +final class GenericClassFamily extends Family { + const GenericClassFamily._() + : super( + name: r'genericClassProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + GenericClassProvider call() => + GenericClassProvider._(from: this); + + @override + String debugGetCreateSourceHash() => _$genericClassHash(); + + @override + String toString() => r'genericClassProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + GenericClass Function() create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericClassProvider; + + return provider._copyWithCreate(create).$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + FutureOr> Function( + Ref>> ref, GenericClass notifier) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericClassProvider; + + return provider._copyWithBuild(build).$createElement(container); + }, + ); + } +} + +abstract class _$GenericClass extends $AsyncNotifier> { + FutureOr> build(); + @$internal + @override + FutureOr> runBuild() => build(); +} + typedef PublicRef = Ref>; @ProviderFor(public) @@ -527,155 +676,6 @@ final class FamilyFamily extends Family { } } -@ProviderFor(GenericClass) -const genericClassProvider = GenericClassFamily._(); - -final class GenericClassProvider - extends $AsyncNotifierProvider, List> { - const GenericClassProvider._( - {required GenericClassFamily super.from, - super.runNotifierBuildOverride, - GenericClass Function()? create}) - : _createCb = create, - super( - argument: null, - name: r'genericClassProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final GenericClass Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$genericClassHash(); - - GenericClassProvider _copyWithCreate( - GenericClass Function() create, - ) { - return GenericClassProvider._( - from: from! as GenericClassFamily, create: create); - } - - GenericClassProvider _copyWithBuild( - FutureOr> Function( - Ref>>, - GenericClass, - ) build, - ) { - return GenericClassProvider._( - from: from! as GenericClassFamily, runNotifierBuildOverride: build); - } - - @override - String toString() { - return r'genericClassProvider' - '<${T}>' - '()'; - } - - @$internal - @override - GenericClass create() => _createCb?.call() ?? GenericClass(); - - @$internal - @override - GenericClassProvider $copyWithCreate( - GenericClass Function() create, - ) { - return GenericClassProvider._( - from: from! as GenericClassFamily, create: create); - } - - @$internal - @override - GenericClassProvider $copyWithBuild( - FutureOr> Function( - Ref>>, - GenericClass, - ) build, - ) { - return GenericClassProvider._( - from: from! as GenericClassFamily, runNotifierBuildOverride: build); - } - - @$internal - @override - $AsyncNotifierProviderElement, List> $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); - - @override - bool operator ==(Object other) { - return other is GenericClassProvider && - other.runtimeType == runtimeType && - other.argument == argument; - } - - @override - int get hashCode { - return Object.hash(runtimeType, argument); - } -} - -String _$genericClassHash() => r'd3c4acc9cdae12f6c666fbf1f89aee212bb086db'; - -final class GenericClassFamily extends Family { - const GenericClassFamily._() - : super( - name: r'genericClassProvider', - dependencies: null, - allTransitiveDependencies: null, - isAutoDispose: true, - ); - - GenericClassProvider call() => - GenericClassProvider._(from: this); - - @override - String debugGetCreateSourceHash() => _$genericClassHash(); - - @override - String toString() => r'genericClassProvider'; - - /// {@macro riverpod.override_with} - Override overrideWith( - GenericClass Function() create, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as GenericClassProvider; - - return provider._copyWithCreate(create).$createElement(container); - }, - ); - } - - /// {@macro riverpod.override_with_build} - Override overrideWithBuild( - FutureOr> Function( - Ref>> ref, GenericClass notifier) - build, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as GenericClassProvider; - - return provider._copyWithBuild(build).$createElement(container); - }, - ); - } -} - -abstract class _$GenericClass extends $AsyncNotifier> { - FutureOr> build(); - @$internal - @override - FutureOr> runBuild() => build(); -} - @ProviderFor(PublicClass) const publicClassProvider = PublicClassProvider._(); @@ -1179,6 +1179,5 @@ abstract class _$FamilyClass extends $AsyncNotifier { ); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 21c3070f8..95594437b 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -584,7 +584,5 @@ final class DefaultKeepAliveFamilyFamily extends Family { ); } } - -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index ab354c7f9..f00995878 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -196,6 +196,232 @@ final class FamilyFamily extends Family { } } +@ProviderFor(Dep2) +const dep2Provider = Dep2Provider._(); + +final class Dep2Provider extends $NotifierProvider { + const Dep2Provider._( + {super.runNotifierBuildOverride, Dep2 Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'dep2Provider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Dep2 Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$dep2Hash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Dep2 create() => _createCb?.call() ?? Dep2(); + + @$internal + @override + Dep2Provider $copyWithCreate( + Dep2 Function() create, + ) { + return Dep2Provider._(create: create); + } + + @$internal + @override + Dep2Provider $copyWithBuild( + int Function( + Ref, + Dep2, + ) build, + ) { + return Dep2Provider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$dep2Hash() => r'2778537df77f6431148c2ce400724da3e2ab4b94'; + +abstract class _$Dep2 extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +@ProviderFor(Family2) +const family2Provider = Family2Family._(); + +final class Family2Provider extends $NotifierProvider { + const Family2Provider._( + {required Family2Family super.from, + required int super.argument, + super.runNotifierBuildOverride, + Family2 Function()? create}) + : _createCb = create, + super( + name: r'family2Provider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Family2 Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$family2Hash(); + + @override + String toString() { + return r'family2Provider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Family2 create() => _createCb?.call() ?? Family2(); + + @$internal + @override + Family2Provider $copyWithCreate( + Family2 Function() create, + ) { + return Family2Provider._( + argument: argument as int, + from: from! as Family2Family, + create: create); + } + + @$internal + @override + Family2Provider $copyWithBuild( + int Function( + Ref, + Family2, + ) build, + ) { + return Family2Provider._( + argument: argument as int, + from: from! as Family2Family, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is Family2Provider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$family2Hash() => r'ce727b262aae067b0d4f703f03670abb70ad8977'; + +final class Family2Family extends Family { + const Family2Family._() + : super( + name: r'family2Provider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + Family2Provider call( + int id, + ) => + Family2Provider._(argument: id, from: this); + + @override + String debugGetCreateSourceHash() => _$family2Hash(); + + @override + String toString() => r'family2Provider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + Family2 Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Family2Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + int Function(Ref ref, Family2 notifier, int argument) build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Family2Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(container); + }, + ); + } +} + +abstract class _$Family2 extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + int get id => _$args; + + int build( + int id, + ); + @$internal + @override + int runBuild() => build( + _$args, + ); +} + typedef ProviderRef = Ref; @ProviderFor(provider) @@ -345,50 +571,41 @@ final class Provider2Provider String _$provider2Hash() => r'70d908579c5e64ce6558b42f433adfb80f4dc79b'; -typedef TransitiveDependenciesRef = Ref; - -@ProviderFor(transitiveDependencies) -const transitiveDependenciesProvider = TransitiveDependenciesProvider._(); +@ProviderFor(Provider3) +const provider3Provider = Provider3Provider._(); -final class TransitiveDependenciesProvider - extends $FunctionalProvider - with $Provider { - const TransitiveDependenciesProvider._( - {int Function( - TransitiveDependenciesRef ref, - )? create}) +final class Provider3Provider extends $NotifierProvider { + const Provider3Provider._( + {super.runNotifierBuildOverride, Provider3 Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'transitiveDependenciesProvider', + name: r'provider3Provider', isAutoDispose: true, - dependencies: const [providerProvider], + dependencies: const [ + depProvider, + familyProvider, + dep2Provider, + family2Provider + ], allTransitiveDependencies: const { - TransitiveDependenciesProvider.$allTransitiveDependencies0, - TransitiveDependenciesProvider.$allTransitiveDependencies1, - TransitiveDependenciesProvider.$allTransitiveDependencies2, - TransitiveDependenciesProvider.$allTransitiveDependencies3, - TransitiveDependenciesProvider.$allTransitiveDependencies4, + Provider3Provider.$allTransitiveDependencies0, + Provider3Provider.$allTransitiveDependencies1, + Provider3Provider.$allTransitiveDependencies2, + Provider3Provider.$allTransitiveDependencies3, }, ); - static const $allTransitiveDependencies0 = providerProvider; - static const $allTransitiveDependencies1 = - ProviderProvider.$allTransitiveDependencies0; - static const $allTransitiveDependencies2 = - ProviderProvider.$allTransitiveDependencies1; - static const $allTransitiveDependencies3 = - ProviderProvider.$allTransitiveDependencies2; - static const $allTransitiveDependencies4 = - ProviderProvider.$allTransitiveDependencies3; + static const $allTransitiveDependencies0 = depProvider; + static const $allTransitiveDependencies1 = familyProvider; + static const $allTransitiveDependencies2 = dep2Provider; + static const $allTransitiveDependencies3 = family2Provider; - final int Function( - TransitiveDependenciesRef ref, - )? _createCb; + final Provider3 Function()? _createCb; @override - String debugGetCreateSourceHash() => _$transitiveDependenciesHash(); + String debugGetCreateSourceHash() => _$provider3Hash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -400,69 +617,76 @@ final class TransitiveDependenciesProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + Provider3 create() => _createCb?.call() ?? Provider3(); + @$internal @override - TransitiveDependenciesProvider $copyWithCreate( - int Function( - TransitiveDependenciesRef ref, - ) create, + Provider3Provider $copyWithCreate( + Provider3 Function() create, ) { - return TransitiveDependenciesProvider._(create: create); + return Provider3Provider._(create: create); } + @$internal @override - int create(TransitiveDependenciesRef ref) { - final _$cb = _createCb ?? transitiveDependencies; - return _$cb(ref); + Provider3Provider $copyWithBuild( + int Function( + Ref, + Provider3, + ) build, + ) { + return Provider3Provider._(runNotifierBuildOverride: build); } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -String _$transitiveDependenciesHash() => - r'9c81823224bb28a5dc482328c04ce76293370877'; +String _$provider3Hash() => r'dfdd6dec6cfee543c73d99593ce98d68f4db385c'; -typedef SmallTransitiveDependencyCountRef = Ref; +abstract class _$Provider3 extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} -@ProviderFor(smallTransitiveDependencyCount) -const smallTransitiveDependencyCountProvider = - SmallTransitiveDependencyCountProvider._(); +@ProviderFor(Provider4) +const provider4Provider = Provider4Family._(); -final class SmallTransitiveDependencyCountProvider - extends $FunctionalProvider - with $Provider { - const SmallTransitiveDependencyCountProvider._( - {int Function( - SmallTransitiveDependencyCountRef ref, - )? create}) +final class Provider4Provider extends $NotifierProvider { + const Provider4Provider._( + {required Provider4Family super.from, + required int super.argument, + super.runNotifierBuildOverride, + Provider4 Function()? create}) : _createCb = create, super( - from: null, - argument: null, - name: r'smallTransitiveDependencyCountProvider', + name: r'provider4Provider', isAutoDispose: true, - dependencies: const [ - depProvider, - familyProvider, - dep2Provider - ], - allTransitiveDependencies: const [ - SmallTransitiveDependencyCountProvider.$allTransitiveDependencies0, - SmallTransitiveDependencyCountProvider.$allTransitiveDependencies1, - SmallTransitiveDependencyCountProvider.$allTransitiveDependencies2, - ], + dependencies: null, + allTransitiveDependencies: null, ); static const $allTransitiveDependencies0 = depProvider; static const $allTransitiveDependencies1 = familyProvider; static const $allTransitiveDependencies2 = dep2Provider; + static const $allTransitiveDependencies3 = family2Provider; - final int Function( - SmallTransitiveDependencyCountRef ref, - )? _createCb; + final Provider4 Function()? _createCb; @override - String debugGetCreateSourceHash() => _$smallTransitiveDependencyCountHash(); + String debugGetCreateSourceHash() => _$provider4Hash(); + + @override + String toString() { + return r'provider4Provider' + '' + '($argument)'; + } /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -474,188 +698,179 @@ final class SmallTransitiveDependencyCountProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + Provider4 create() => _createCb?.call() ?? Provider4(); + @$internal @override - SmallTransitiveDependencyCountProvider $copyWithCreate( - int Function( - SmallTransitiveDependencyCountRef ref, - ) create, + Provider4Provider $copyWithCreate( + Provider4 Function() create, ) { - return SmallTransitiveDependencyCountProvider._(create: create); - } - - @override - int create(SmallTransitiveDependencyCountRef ref) { - final _$cb = _createCb ?? smallTransitiveDependencyCount; - return _$cb(ref); + return Provider4Provider._( + argument: argument as int, + from: from! as Provider4Family, + create: create); } -} - -String _$smallTransitiveDependencyCountHash() => - r'34689e1ba57e2959975cbf8ebd6c9483f4652a73'; - -typedef EmptyDependenciesFunctionalRef = Ref; - -@ProviderFor(emptyDependenciesFunctional) -const emptyDependenciesFunctionalProvider = - EmptyDependenciesFunctionalProvider._(); - -final class EmptyDependenciesFunctionalProvider - extends $FunctionalProvider - with $Provider { - const EmptyDependenciesFunctionalProvider._( - {int Function( - EmptyDependenciesFunctionalRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'emptyDependenciesFunctionalProvider', - isAutoDispose: true, - dependencies: const [], - allTransitiveDependencies: const [], - ); - - final int Function( - EmptyDependenciesFunctionalRef ref, - )? _createCb; + @$internal @override - String debugGetCreateSourceHash() => _$emptyDependenciesFunctionalHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); + Provider4Provider $copyWithBuild( + int Function( + Ref, + Provider4, + ) build, + ) { + return Provider4Provider._( + argument: argument as int, + from: from! as Provider4Family, + runNotifierBuildOverride: build); } @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); @override - EmptyDependenciesFunctionalProvider $copyWithCreate( - int Function( - EmptyDependenciesFunctionalRef ref, - ) create, - ) { - return EmptyDependenciesFunctionalProvider._(create: create); + bool operator ==(Object other) { + return other is Provider4Provider && other.argument == argument; } @override - int create(EmptyDependenciesFunctionalRef ref) { - final _$cb = _createCb ?? emptyDependenciesFunctional; - return _$cb(ref); + int get hashCode { + return argument.hashCode; } } -String _$emptyDependenciesFunctionalHash() => - r'592bebd079450e2071fb12d68c3ae333d5c28359'; - -typedef ProviderWithDependenciesRef = Ref; - -@ProviderFor(providerWithDependencies) -const providerWithDependenciesProvider = ProviderWithDependenciesProvider._(); +String _$provider4Hash() => r'1c955214d99695bb694c96374b277aac58e734df'; -final class ProviderWithDependenciesProvider - extends $FunctionalProvider - with $Provider { - const ProviderWithDependenciesProvider._( - {int Function( - ProviderWithDependenciesRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'providerWithDependenciesProvider', - isAutoDispose: true, +final class Provider4Family extends Family { + const Provider4Family._() + : super( + name: r'provider4Provider', dependencies: const [ - _privateDepProvider, - publicDepProvider - ], - allTransitiveDependencies: const [ - ProviderWithDependenciesProvider.$allTransitiveDependencies0, - ProviderWithDependenciesProvider.$allTransitiveDependencies1, + depProvider, + familyProvider, + dep2Provider, + family2Provider ], + allTransitiveDependencies: const { + Provider4Provider.$allTransitiveDependencies0, + Provider4Provider.$allTransitiveDependencies1, + Provider4Provider.$allTransitiveDependencies2, + Provider4Provider.$allTransitiveDependencies3, + }, + isAutoDispose: true, ); - static const $allTransitiveDependencies0 = _privateDepProvider; - static const $allTransitiveDependencies1 = publicDepProvider; + Provider4Provider call( + int id, + ) => + Provider4Provider._(argument: id, from: this); - final int Function( - ProviderWithDependenciesRef ref, - )? _createCb; + @override + String debugGetCreateSourceHash() => _$provider4Hash(); @override - String debugGetCreateSourceHash() => _$providerWithDependenciesHash(); + String toString() => r'provider4Provider'; - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), + /// {@macro riverpod.override_with} + Override overrideWith( + Provider4 Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Provider4Provider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(container); + }, ); } - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - ProviderWithDependenciesProvider $copyWithCreate( - int Function( - ProviderWithDependenciesRef ref, - ) create, + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + int Function(Ref ref, Provider4 notifier, int argument) build, ) { - return ProviderWithDependenciesProvider._(create: create); - } + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Provider4Provider; - @override - int create(ProviderWithDependenciesRef ref) { - final _$cb = _createCb ?? providerWithDependencies; - return _$cb(ref); + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(container); + }, + ); } } -String _$providerWithDependenciesHash() => - r'beecbe7a41b647ab92367dbcc12055bcd6345af7'; +abstract class _$Provider4 extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + int get id => _$args; -typedef _PrivateDepRef = Ref; + int build( + int id, + ); + @$internal + @override + int runBuild() => build( + _$args, + ); +} -@ProviderFor(_privateDep) -const _privateDepProvider = _PrivateDepProvider._(); +typedef TransitiveDependenciesRef = Ref; -final class _PrivateDepProvider - extends $FunctionalProvider - with $Provider { - const _PrivateDepProvider._( +@ProviderFor(transitiveDependencies) +const transitiveDependenciesProvider = TransitiveDependenciesProvider._(); + +final class TransitiveDependenciesProvider + extends $FunctionalProvider + with $Provider { + const TransitiveDependenciesProvider._( {int Function( - _PrivateDepRef ref, + TransitiveDependenciesRef ref, )? create}) : _createCb = create, super( from: null, argument: null, - name: r'_privateDepProvider', + name: r'transitiveDependenciesProvider', isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, + dependencies: const [providerProvider], + allTransitiveDependencies: const { + TransitiveDependenciesProvider.$allTransitiveDependencies0, + TransitiveDependenciesProvider.$allTransitiveDependencies1, + TransitiveDependenciesProvider.$allTransitiveDependencies2, + TransitiveDependenciesProvider.$allTransitiveDependencies3, + TransitiveDependenciesProvider.$allTransitiveDependencies4, + }, ); + static const $allTransitiveDependencies0 = providerProvider; + static const $allTransitiveDependencies1 = + ProviderProvider.$allTransitiveDependencies0; + static const $allTransitiveDependencies2 = + ProviderProvider.$allTransitiveDependencies1; + static const $allTransitiveDependencies3 = + ProviderProvider.$allTransitiveDependencies2; + static const $allTransitiveDependencies4 = + ProviderProvider.$allTransitiveDependencies3; + final int Function( - _PrivateDepRef ref, + TransitiveDependenciesRef ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$privateDepHash(); + String debugGetCreateSourceHash() => _$transitiveDependenciesHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -671,51 +886,65 @@ final class _PrivateDepProvider $ProviderElement(this, container); @override - _PrivateDepProvider $copyWithCreate( + TransitiveDependenciesProvider $copyWithCreate( int Function( - _PrivateDepRef ref, + TransitiveDependenciesRef ref, ) create, ) { - return _PrivateDepProvider._(create: create); + return TransitiveDependenciesProvider._(create: create); } @override - int create(_PrivateDepRef ref) { - final _$cb = _createCb ?? _privateDep; + int create(TransitiveDependenciesRef ref) { + final _$cb = _createCb ?? transitiveDependencies; return _$cb(ref); } } -String _$privateDepHash() => r'f610d91bd39e0dcffe6ff4e74160964a291289d9'; +String _$transitiveDependenciesHash() => + r'9c81823224bb28a5dc482328c04ce76293370877'; -typedef PublicDepRef = Ref; +typedef SmallTransitiveDependencyCountRef = Ref; -@ProviderFor(publicDep) -const publicDepProvider = PublicDepProvider._(); +@ProviderFor(smallTransitiveDependencyCount) +const smallTransitiveDependencyCountProvider = + SmallTransitiveDependencyCountProvider._(); -final class PublicDepProvider - extends $FunctionalProvider - with $Provider { - const PublicDepProvider._( +final class SmallTransitiveDependencyCountProvider + extends $FunctionalProvider + with $Provider { + const SmallTransitiveDependencyCountProvider._( {int Function( - PublicDepRef ref, + SmallTransitiveDependencyCountRef ref, )? create}) : _createCb = create, super( from: null, argument: null, - name: r'publicDepProvider', + name: r'smallTransitiveDependencyCountProvider', isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, + dependencies: const [ + depProvider, + familyProvider, + dep2Provider + ], + allTransitiveDependencies: const [ + SmallTransitiveDependencyCountProvider.$allTransitiveDependencies0, + SmallTransitiveDependencyCountProvider.$allTransitiveDependencies1, + SmallTransitiveDependencyCountProvider.$allTransitiveDependencies2, + ], ); + static const $allTransitiveDependencies0 = depProvider; + static const $allTransitiveDependencies1 = familyProvider; + static const $allTransitiveDependencies2 = dep2Provider; + final int Function( - PublicDepRef ref, + SmallTransitiveDependencyCountRef ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$publicDepHash(); + String debugGetCreateSourceHash() => _$smallTransitiveDependencyCountHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -731,57 +960,53 @@ final class PublicDepProvider $ProviderElement(this, container); @override - PublicDepProvider $copyWithCreate( + SmallTransitiveDependencyCountProvider $copyWithCreate( int Function( - PublicDepRef ref, + SmallTransitiveDependencyCountRef ref, ) create, ) { - return PublicDepProvider._(create: create); + return SmallTransitiveDependencyCountProvider._(create: create); } @override - int create(PublicDepRef ref) { - final _$cb = _createCb ?? publicDep; + int create(SmallTransitiveDependencyCountRef ref) { + final _$cb = _createCb ?? smallTransitiveDependencyCount; return _$cb(ref); } } -String _$publicDepHash() => r'bcb69aace017c86c3c4b8eccf59fa22d010834bc'; +String _$smallTransitiveDependencyCountHash() => + r'34689e1ba57e2959975cbf8ebd6c9483f4652a73'; -typedef DuplicateDependenciesRef = Ref; +typedef EmptyDependenciesFunctionalRef = Ref; -@ProviderFor(duplicateDependencies) -const duplicateDependenciesProvider = DuplicateDependenciesProvider._(); +@ProviderFor(emptyDependenciesFunctional) +const emptyDependenciesFunctionalProvider = + EmptyDependenciesFunctionalProvider._(); -final class DuplicateDependenciesProvider - extends $FunctionalProvider - with $Provider { - const DuplicateDependenciesProvider._( +final class EmptyDependenciesFunctionalProvider + extends $FunctionalProvider + with $Provider { + const EmptyDependenciesFunctionalProvider._( {int Function( - DuplicateDependenciesRef ref, + EmptyDependenciesFunctionalRef ref, )? create}) : _createCb = create, super( from: null, argument: null, - name: r'duplicateDependenciesProvider', + name: r'emptyDependenciesFunctionalProvider', isAutoDispose: true, - dependencies: const [depProvider, dep2Provider], - allTransitiveDependencies: const [ - DuplicateDependenciesProvider.$allTransitiveDependencies0, - DuplicateDependenciesProvider.$allTransitiveDependencies1, - ], + dependencies: const [], + allTransitiveDependencies: const [], ); - static const $allTransitiveDependencies0 = depProvider; - static const $allTransitiveDependencies1 = dep2Provider; - final int Function( - DuplicateDependenciesRef ref, + EmptyDependenciesFunctionalRef ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$duplicateDependenciesHash(); + String debugGetCreateSourceHash() => _$emptyDependenciesFunctionalHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -797,61 +1022,47 @@ final class DuplicateDependenciesProvider $ProviderElement(this, container); @override - DuplicateDependenciesProvider $copyWithCreate( + EmptyDependenciesFunctionalProvider $copyWithCreate( int Function( - DuplicateDependenciesRef ref, + EmptyDependenciesFunctionalRef ref, ) create, ) { - return DuplicateDependenciesProvider._(create: create); + return EmptyDependenciesFunctionalProvider._(create: create); } @override - int create(DuplicateDependenciesRef ref) { - final _$cb = _createCb ?? duplicateDependencies; + int create(EmptyDependenciesFunctionalRef ref) { + final _$cb = _createCb ?? emptyDependenciesFunctional; return _$cb(ref); } } -String _$duplicateDependenciesHash() => - r'8e4c4b40d7500e97e8490874d48cc960c64af712'; - -typedef DuplicateDependencies2Ref = Ref; +String _$emptyDependenciesFunctionalHash() => + r'592bebd079450e2071fb12d68c3ae333d5c28359'; -@ProviderFor(duplicateDependencies2) -const duplicateDependencies2Provider = DuplicateDependencies2Provider._(); +@ProviderFor(EmptyDependenciesClassBased) +const emptyDependenciesClassBasedProvider = + EmptyDependenciesClassBasedProvider._(); -final class DuplicateDependencies2Provider - extends $FunctionalProvider - with $Provider { - const DuplicateDependencies2Provider._( - {int Function( - DuplicateDependencies2Ref ref, - )? create}) +final class EmptyDependenciesClassBasedProvider + extends $NotifierProvider { + const EmptyDependenciesClassBasedProvider._( + {super.runNotifierBuildOverride, + EmptyDependenciesClassBased Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'duplicateDependencies2Provider', + name: r'emptyDependenciesClassBasedProvider', isAutoDispose: true, - dependencies: const [ - familyProvider, - family2Provider - ], - allTransitiveDependencies: const [ - DuplicateDependencies2Provider.$allTransitiveDependencies0, - DuplicateDependencies2Provider.$allTransitiveDependencies1, - ], + dependencies: const [], + allTransitiveDependencies: const [], ); - static const $allTransitiveDependencies0 = familyProvider; - static const $allTransitiveDependencies1 = family2Provider; - - final int Function( - DuplicateDependencies2Ref ref, - )? _createCb; + final EmptyDependenciesClassBased Function()? _createCb; @override - String debugGetCreateSourceHash() => _$duplicateDependencies2Hash(); + String debugGetCreateSourceHash() => _$emptyDependenciesClassBasedHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -863,78 +1074,83 @@ final class DuplicateDependencies2Provider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + EmptyDependenciesClassBased create() => + _createCb?.call() ?? EmptyDependenciesClassBased(); + @$internal @override - DuplicateDependencies2Provider $copyWithCreate( - int Function( - DuplicateDependencies2Ref ref, - ) create, + EmptyDependenciesClassBasedProvider $copyWithCreate( + EmptyDependenciesClassBased Function() create, ) { - return DuplicateDependencies2Provider._(create: create); + return EmptyDependenciesClassBasedProvider._(create: create); } + @$internal @override - int create(DuplicateDependencies2Ref ref) { - final _$cb = _createCb ?? duplicateDependencies2; - return _$cb(ref); + EmptyDependenciesClassBasedProvider $copyWithBuild( + int Function( + Ref, + EmptyDependenciesClassBased, + ) build, + ) { + return EmptyDependenciesClassBasedProvider._( + runNotifierBuildOverride: build); } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -String _$duplicateDependencies2Hash() => - r'43a4ff16a760fc697426a5b1ebc1f8882c816cfb'; +String _$emptyDependenciesClassBasedHash() => + r'e20c18353984a81977b656e9879b3841dbaedc6c'; -typedef TransitiveDuplicateDependenciesRef = Ref; +abstract class _$EmptyDependenciesClassBased extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} -@ProviderFor(transitiveDuplicateDependencies) -const transitiveDuplicateDependenciesProvider = - TransitiveDuplicateDependenciesProvider._(); +typedef ProviderWithDependenciesRef = Ref; -final class TransitiveDuplicateDependenciesProvider - extends $FunctionalProvider - with $Provider { - const TransitiveDuplicateDependenciesProvider._( +@ProviderFor(providerWithDependencies) +const providerWithDependenciesProvider = ProviderWithDependenciesProvider._(); + +final class ProviderWithDependenciesProvider + extends $FunctionalProvider + with $Provider { + const ProviderWithDependenciesProvider._( {int Function( - TransitiveDuplicateDependenciesRef ref, + ProviderWithDependenciesRef ref, )? create}) : _createCb = create, super( from: null, argument: null, - name: r'transitiveDuplicateDependenciesProvider', + name: r'providerWithDependenciesProvider', isAutoDispose: true, dependencies: const [ - duplicateDependenciesProvider, - duplicateDependencies2Provider + _privateDepProvider, + publicDepProvider + ], + allTransitiveDependencies: const [ + ProviderWithDependenciesProvider.$allTransitiveDependencies0, + ProviderWithDependenciesProvider.$allTransitiveDependencies1, ], - allTransitiveDependencies: const { - TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies0, - TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies1, - TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies2, - TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies3, - TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies4, - TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies5, - }, ); - static const $allTransitiveDependencies0 = duplicateDependenciesProvider; - static const $allTransitiveDependencies1 = - DuplicateDependenciesProvider.$allTransitiveDependencies0; - static const $allTransitiveDependencies2 = - DuplicateDependenciesProvider.$allTransitiveDependencies1; - static const $allTransitiveDependencies3 = duplicateDependencies2Provider; - static const $allTransitiveDependencies4 = - DuplicateDependencies2Provider.$allTransitiveDependencies0; - static const $allTransitiveDependencies5 = - DuplicateDependencies2Provider.$allTransitiveDependencies1; + static const $allTransitiveDependencies0 = _privateDepProvider; + static const $allTransitiveDependencies1 = publicDepProvider; final int Function( - TransitiveDuplicateDependenciesRef ref, + ProviderWithDependenciesRef ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$transitiveDuplicateDependenciesHash(); + String debugGetCreateSourceHash() => _$providerWithDependenciesHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -950,44 +1166,52 @@ final class TransitiveDuplicateDependenciesProvider $ProviderElement(this, container); @override - TransitiveDuplicateDependenciesProvider $copyWithCreate( + ProviderWithDependenciesProvider $copyWithCreate( int Function( - TransitiveDuplicateDependenciesRef ref, + ProviderWithDependenciesRef ref, ) create, ) { - return TransitiveDuplicateDependenciesProvider._(create: create); + return ProviderWithDependenciesProvider._(create: create); } @override - int create(TransitiveDuplicateDependenciesRef ref) { - final _$cb = _createCb ?? transitiveDuplicateDependencies; + int create(ProviderWithDependenciesRef ref) { + final _$cb = _createCb ?? providerWithDependencies; return _$cb(ref); } } -String _$transitiveDuplicateDependenciesHash() => - r'aba44b6c1cf82eea782ad260f2e95d9f771f12ac'; +String _$providerWithDependenciesHash() => + r'beecbe7a41b647ab92367dbcc12055bcd6345af7'; -@ProviderFor(Dep2) -const dep2Provider = Dep2Provider._(); +typedef _PrivateDepRef = Ref; -final class Dep2Provider extends $NotifierProvider { - const Dep2Provider._( - {super.runNotifierBuildOverride, Dep2 Function()? create}) +@ProviderFor(_privateDep) +const _privateDepProvider = _PrivateDepProvider._(); + +final class _PrivateDepProvider + extends $FunctionalProvider + with $Provider { + const _PrivateDepProvider._( + {int Function( + _PrivateDepRef ref, + )? create}) : _createCb = create, super( from: null, argument: null, - name: r'dep2Provider', + name: r'_privateDepProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final Dep2 Function()? _createCb; + final int Function( + _PrivateDepRef ref, + )? _createCb; @override - String debugGetCreateSourceHash() => _$dep2Hash(); + String debugGetCreateSourceHash() => _$privateDepHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -999,71 +1223,55 @@ final class Dep2Provider extends $NotifierProvider { @$internal @override - Dep2 create() => _createCb?.call() ?? Dep2(); - - @$internal - @override - Dep2Provider $copyWithCreate( - Dep2 Function() create, - ) { - return Dep2Provider._(create: create); - } + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - Dep2Provider $copyWithBuild( + _PrivateDepProvider $copyWithCreate( int Function( - Ref, - Dep2, - ) build, + _PrivateDepRef ref, + ) create, ) { - return Dep2Provider._(runNotifierBuildOverride: build); + return _PrivateDepProvider._(create: create); } - @$internal @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + int create(_PrivateDepRef ref) { + final _$cb = _createCb ?? _privateDep; + return _$cb(ref); + } } -String _$dep2Hash() => r'2778537df77f6431148c2ce400724da3e2ab4b94'; +String _$privateDepHash() => r'f610d91bd39e0dcffe6ff4e74160964a291289d9'; -abstract class _$Dep2 extends $Notifier { - int build(); - @$internal - @override - int runBuild() => build(); -} +typedef PublicDepRef = Ref; -@ProviderFor(Family2) -const family2Provider = Family2Family._(); +@ProviderFor(publicDep) +const publicDepProvider = PublicDepProvider._(); -final class Family2Provider extends $NotifierProvider { - const Family2Provider._( - {required Family2Family super.from, - required int super.argument, - super.runNotifierBuildOverride, - Family2 Function()? create}) +final class PublicDepProvider + extends $FunctionalProvider + with $Provider { + const PublicDepProvider._( + {int Function( + PublicDepRef ref, + )? create}) : _createCb = create, super( - name: r'family2Provider', + from: null, + argument: null, + name: r'publicDepProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final Family2 Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$family2Hash(); + final int Function( + PublicDepRef ref, + )? _createCb; @override - String toString() { - return r'family2Provider' - '' - '($argument)'; - } + String debugGetCreateSourceHash() => _$publicDepHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -1075,160 +1283,61 @@ final class Family2Provider extends $NotifierProvider { @$internal @override - Family2 create() => _createCb?.call() ?? Family2(); - - @$internal - @override - Family2Provider $copyWithCreate( - Family2 Function() create, - ) { - return Family2Provider._( - argument: argument as int, - from: from! as Family2Family, - create: create); - } + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - Family2Provider $copyWithBuild( + PublicDepProvider $copyWithCreate( int Function( - Ref, - Family2, - ) build, + PublicDepRef ref, + ) create, ) { - return Family2Provider._( - argument: argument as int, - from: from! as Family2Family, - runNotifierBuildOverride: build); - } - - @$internal - @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); - - @override - bool operator ==(Object other) { - return other is Family2Provider && other.argument == argument; + return PublicDepProvider._(create: create); } @override - int get hashCode { - return argument.hashCode; + int create(PublicDepRef ref) { + final _$cb = _createCb ?? publicDep; + return _$cb(ref); } } -String _$family2Hash() => r'ce727b262aae067b0d4f703f03670abb70ad8977'; +String _$publicDepHash() => r'bcb69aace017c86c3c4b8eccf59fa22d010834bc'; -final class Family2Family extends Family { - const Family2Family._() - : super( - name: r'family2Provider', - dependencies: null, - allTransitiveDependencies: null, - isAutoDispose: true, - ); - - Family2Provider call( - int id, - ) => - Family2Provider._(argument: id, from: this); - - @override - String debugGetCreateSourceHash() => _$family2Hash(); - - @override - String toString() => r'family2Provider'; - - /// {@macro riverpod.override_with} - Override overrideWith( - Family2 Function( - int args, - ) create, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as Family2Provider; - - final argument = provider.argument as int; - - return provider - .$copyWithCreate(() => create(argument)) - .$createElement(container); - }, - ); - } - - /// {@macro riverpod.override_with_build} - Override overrideWithBuild( - int Function(Ref ref, Family2 notifier, int argument) build, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as Family2Provider; - - final argument = provider.argument as int; - - return provider - .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); - }, - ); - } -} - -abstract class _$Family2 extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; - int get id => _$args; - - int build( - int id, - ); - @$internal - @override - int runBuild() => build( - _$args, - ); -} +typedef DuplicateDependenciesRef = Ref; -@ProviderFor(Provider3) -const provider3Provider = Provider3Provider._(); +@ProviderFor(duplicateDependencies) +const duplicateDependenciesProvider = DuplicateDependenciesProvider._(); -final class Provider3Provider extends $NotifierProvider { - const Provider3Provider._( - {super.runNotifierBuildOverride, Provider3 Function()? create}) +final class DuplicateDependenciesProvider + extends $FunctionalProvider + with $Provider { + const DuplicateDependenciesProvider._( + {int Function( + DuplicateDependenciesRef ref, + )? create}) : _createCb = create, super( from: null, argument: null, - name: r'provider3Provider', + name: r'duplicateDependenciesProvider', isAutoDispose: true, - dependencies: const [ - depProvider, - familyProvider, - dep2Provider, - family2Provider + dependencies: const [depProvider, dep2Provider], + allTransitiveDependencies: const [ + DuplicateDependenciesProvider.$allTransitiveDependencies0, + DuplicateDependenciesProvider.$allTransitiveDependencies1, ], - allTransitiveDependencies: const { - Provider3Provider.$allTransitiveDependencies0, - Provider3Provider.$allTransitiveDependencies1, - Provider3Provider.$allTransitiveDependencies2, - Provider3Provider.$allTransitiveDependencies3, - }, ); static const $allTransitiveDependencies0 = depProvider; - static const $allTransitiveDependencies1 = familyProvider; - static const $allTransitiveDependencies2 = dep2Provider; - static const $allTransitiveDependencies3 = family2Provider; + static const $allTransitiveDependencies1 = dep2Provider; - final Provider3 Function()? _createCb; + final int Function( + DuplicateDependenciesRef ref, + )? _createCb; @override - String debugGetCreateSourceHash() => _$provider3Hash(); + String debugGetCreateSourceHash() => _$duplicateDependenciesHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -1240,76 +1349,65 @@ final class Provider3Provider extends $NotifierProvider { @$internal @override - Provider3 create() => _createCb?.call() ?? Provider3(); - - @$internal - @override - Provider3Provider $copyWithCreate( - Provider3 Function() create, - ) { - return Provider3Provider._(create: create); - } + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - Provider3Provider $copyWithBuild( + DuplicateDependenciesProvider $copyWithCreate( int Function( - Ref, - Provider3, - ) build, + DuplicateDependenciesRef ref, + ) create, ) { - return Provider3Provider._(runNotifierBuildOverride: build); + return DuplicateDependenciesProvider._(create: create); } - @$internal @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + int create(DuplicateDependenciesRef ref) { + final _$cb = _createCb ?? duplicateDependencies; + return _$cb(ref); + } } -String _$provider3Hash() => r'dfdd6dec6cfee543c73d99593ce98d68f4db385c'; +String _$duplicateDependenciesHash() => + r'8e4c4b40d7500e97e8490874d48cc960c64af712'; -abstract class _$Provider3 extends $Notifier { - int build(); - @$internal - @override - int runBuild() => build(); -} +typedef DuplicateDependencies2Ref = Ref; -@ProviderFor(Provider4) -const provider4Provider = Provider4Family._(); +@ProviderFor(duplicateDependencies2) +const duplicateDependencies2Provider = DuplicateDependencies2Provider._(); -final class Provider4Provider extends $NotifierProvider { - const Provider4Provider._( - {required Provider4Family super.from, - required int super.argument, - super.runNotifierBuildOverride, - Provider4 Function()? create}) +final class DuplicateDependencies2Provider + extends $FunctionalProvider + with $Provider { + const DuplicateDependencies2Provider._( + {int Function( + DuplicateDependencies2Ref ref, + )? create}) : _createCb = create, super( - name: r'provider4Provider', + from: null, + argument: null, + name: r'duplicateDependencies2Provider', isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, + dependencies: const [ + familyProvider, + family2Provider + ], + allTransitiveDependencies: const [ + DuplicateDependencies2Provider.$allTransitiveDependencies0, + DuplicateDependencies2Provider.$allTransitiveDependencies1, + ], ); - static const $allTransitiveDependencies0 = depProvider; - static const $allTransitiveDependencies1 = familyProvider; - static const $allTransitiveDependencies2 = dep2Provider; - static const $allTransitiveDependencies3 = family2Provider; - - final Provider4 Function()? _createCb; + static const $allTransitiveDependencies0 = familyProvider; + static const $allTransitiveDependencies1 = family2Provider; - @override - String debugGetCreateSourceHash() => _$provider4Hash(); + final int Function( + DuplicateDependencies2Ref ref, + )? _createCb; @override - String toString() { - return r'provider4Provider' - '' - '($argument)'; - } + String debugGetCreateSourceHash() => _$duplicateDependencies2Hash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -1321,158 +1419,78 @@ final class Provider4Provider extends $NotifierProvider { @$internal @override - Provider4 create() => _createCb?.call() ?? Provider4(); - - @$internal - @override - Provider4Provider $copyWithCreate( - Provider4 Function() create, - ) { - return Provider4Provider._( - argument: argument as int, - from: from! as Provider4Family, - create: create); - } + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - Provider4Provider $copyWithBuild( + DuplicateDependencies2Provider $copyWithCreate( int Function( - Ref, - Provider4, - ) build, - ) { - return Provider4Provider._( - argument: argument as int, - from: from! as Provider4Family, - runNotifierBuildOverride: build); - } - - @$internal - @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); - - @override - bool operator ==(Object other) { - return other is Provider4Provider && other.argument == argument; - } - - @override - int get hashCode { - return argument.hashCode; - } -} - -String _$provider4Hash() => r'1c955214d99695bb694c96374b277aac58e734df'; - -final class Provider4Family extends Family { - const Provider4Family._() - : super( - name: r'provider4Provider', - dependencies: const [ - depProvider, - familyProvider, - dep2Provider, - family2Provider - ], - allTransitiveDependencies: const { - Provider4Provider.$allTransitiveDependencies0, - Provider4Provider.$allTransitiveDependencies1, - Provider4Provider.$allTransitiveDependencies2, - Provider4Provider.$allTransitiveDependencies3, - }, - isAutoDispose: true, - ); - - Provider4Provider call( - int id, - ) => - Provider4Provider._(argument: id, from: this); - - @override - String debugGetCreateSourceHash() => _$provider4Hash(); - - @override - String toString() => r'provider4Provider'; - - /// {@macro riverpod.override_with} - Override overrideWith( - Provider4 Function( - int args, + DuplicateDependencies2Ref ref, ) create, ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as Provider4Provider; - - final argument = provider.argument as int; - - return provider - .$copyWithCreate(() => create(argument)) - .$createElement(container); - }, - ); + return DuplicateDependencies2Provider._(create: create); } - /// {@macro riverpod.override_with_build} - Override overrideWithBuild( - int Function(Ref ref, Provider4 notifier, int argument) build, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as Provider4Provider; - - final argument = provider.argument as int; - - return provider - .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); - }, - ); + @override + int create(DuplicateDependencies2Ref ref) { + final _$cb = _createCb ?? duplicateDependencies2; + return _$cb(ref); } } -abstract class _$Provider4 extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; - int get id => _$args; +String _$duplicateDependencies2Hash() => + r'43a4ff16a760fc697426a5b1ebc1f8882c816cfb'; - int build( - int id, - ); - @$internal - @override - int runBuild() => build( - _$args, - ); -} +typedef TransitiveDuplicateDependenciesRef = Ref; -@ProviderFor(EmptyDependenciesClassBased) -const emptyDependenciesClassBasedProvider = - EmptyDependenciesClassBasedProvider._(); +@ProviderFor(transitiveDuplicateDependencies) +const transitiveDuplicateDependenciesProvider = + TransitiveDuplicateDependenciesProvider._(); -final class EmptyDependenciesClassBasedProvider - extends $NotifierProvider { - const EmptyDependenciesClassBasedProvider._( - {super.runNotifierBuildOverride, - EmptyDependenciesClassBased Function()? create}) +final class TransitiveDuplicateDependenciesProvider + extends $FunctionalProvider + with $Provider { + const TransitiveDuplicateDependenciesProvider._( + {int Function( + TransitiveDuplicateDependenciesRef ref, + )? create}) : _createCb = create, super( from: null, argument: null, - name: r'emptyDependenciesClassBasedProvider', + name: r'transitiveDuplicateDependenciesProvider', isAutoDispose: true, - dependencies: const [], - allTransitiveDependencies: const [], + dependencies: const [ + duplicateDependenciesProvider, + duplicateDependencies2Provider + ], + allTransitiveDependencies: const { + TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies0, + TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies1, + TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies2, + TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies3, + TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies4, + TransitiveDuplicateDependenciesProvider.$allTransitiveDependencies5, + }, ); - final EmptyDependenciesClassBased Function()? _createCb; + static const $allTransitiveDependencies0 = duplicateDependenciesProvider; + static const $allTransitiveDependencies1 = + DuplicateDependenciesProvider.$allTransitiveDependencies0; + static const $allTransitiveDependencies2 = + DuplicateDependenciesProvider.$allTransitiveDependencies1; + static const $allTransitiveDependencies3 = duplicateDependencies2Provider; + static const $allTransitiveDependencies4 = + DuplicateDependencies2Provider.$allTransitiveDependencies0; + static const $allTransitiveDependencies5 = + DuplicateDependencies2Provider.$allTransitiveDependencies1; + + final int Function( + TransitiveDuplicateDependenciesRef ref, + )? _createCb; @override - String debugGetCreateSourceHash() => _$emptyDependenciesClassBasedHash(); + String debugGetCreateSourceHash() => _$transitiveDuplicateDependenciesHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -1484,46 +1502,27 @@ final class EmptyDependenciesClassBasedProvider @$internal @override - EmptyDependenciesClassBased create() => - _createCb?.call() ?? EmptyDependenciesClassBased(); - - @$internal - @override - EmptyDependenciesClassBasedProvider $copyWithCreate( - EmptyDependenciesClassBased Function() create, - ) { - return EmptyDependenciesClassBasedProvider._(create: create); - } + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - EmptyDependenciesClassBasedProvider $copyWithBuild( + TransitiveDuplicateDependenciesProvider $copyWithCreate( int Function( - Ref, - EmptyDependenciesClassBased, - ) build, + TransitiveDuplicateDependenciesRef ref, + ) create, ) { - return EmptyDependenciesClassBasedProvider._( - runNotifierBuildOverride: build); + return TransitiveDuplicateDependenciesProvider._(create: create); } - @$internal @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + int create(TransitiveDuplicateDependenciesRef ref) { + final _$cb = _createCb ?? transitiveDuplicateDependencies; + return _$cb(ref); + } } -String _$emptyDependenciesClassBasedHash() => - r'e20c18353984a81977b656e9879b3841dbaedc6c'; - -abstract class _$EmptyDependenciesClassBased extends $Notifier { - int build(); - @$internal - @override - int runBuild() => build(); -} +String _$transitiveDuplicateDependenciesHash() => + r'aba44b6c1cf82eea782ad260f2e95d9f771f12ac'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 6530b6825..9b6c884fa 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -237,125 +237,6 @@ final class FamilyWithDependencies2Family extends Family { } } -typedef _Private2Ref = Ref; - -@ProviderFor(_private2) -const _private2Provider = _Private2Provider._(); - -final class _Private2Provider - extends $FunctionalProvider - with $Provider { - const _Private2Provider._( - {int Function( - _Private2Ref ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'_private2Provider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - _Private2Ref ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$private2Hash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - _Private2Provider $copyWithCreate( - int Function( - _Private2Ref ref, - ) create, - ) { - return _Private2Provider._(create: create); - } - - @override - int create(_Private2Ref ref) { - final _$cb = _createCb ?? _private2; - return _$cb(ref); - } -} - -String _$private2Hash() => r'5e0fa14ff40fb444c027ed25150a42362db3ef19'; - -typedef Public2Ref = Ref; - -@ProviderFor(public2) -const public2Provider = Public2Provider._(); - -final class Public2Provider extends $FunctionalProvider - with $Provider { - const Public2Provider._( - {int Function( - Public2Ref ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'public2Provider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - Public2Ref ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$public2Hash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - Public2Provider $copyWithCreate( - int Function( - Public2Ref ref, - ) create, - ) { - return Public2Provider._(create: create); - } - - @override - int create(Public2Ref ref) { - final _$cb = _createCb ?? public2; - return _$cb(ref); - } -} - -String _$public2Hash() => r'9767255f0182589fe48b29d217dd488b0a13b9d5'; - @ProviderFor(NotifierWithDependencies) const notifierWithDependenciesProvider = NotifierWithDependenciesProvider._(); @@ -629,6 +510,124 @@ abstract class _$NotifierFamilyWithDependencies extends $Notifier { ); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +typedef _Private2Ref = Ref; + +@ProviderFor(_private2) +const _private2Provider = _Private2Provider._(); + +final class _Private2Provider + extends $FunctionalProvider + with $Provider { + const _Private2Provider._( + {int Function( + _Private2Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'_private2Provider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + _Private2Ref ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$private2Hash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + _Private2Provider $copyWithCreate( + int Function( + _Private2Ref ref, + ) create, + ) { + return _Private2Provider._(create: create); + } + + @override + int create(_Private2Ref ref) { + final _$cb = _createCb ?? _private2; + return _$cb(ref); + } +} + +String _$private2Hash() => r'5e0fa14ff40fb444c027ed25150a42362db3ef19'; + +typedef Public2Ref = Ref; + +@ProviderFor(public2) +const public2Provider = Public2Provider._(); + +final class Public2Provider extends $FunctionalProvider + with $Provider { + const Public2Provider._( + {int Function( + Public2Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'public2Provider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + Public2Ref ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$public2Hash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Public2Provider $copyWithCreate( + int Function( + Public2Ref ref, + ) create, + ) { + return Public2Provider._(create: create); + } + + @override + int create(Public2Ref ref) { + final _$cb = _createCb ?? public2; + return _$cb(ref); + } +} + +String _$public2Hash() => r'9767255f0182589fe48b29d217dd488b0a13b9d5'; + // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index 68f4d55f6..a2c6f864b 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -74,6 +74,80 @@ final class FunctionalProvider String _$functionalHash() => r'1198a9a7842513019f6a8cd1b32e72217a00ee8f'; +/// Hello world +// Foo +@ProviderFor(ClassBased) +const classBasedProvider = ClassBasedProvider._(); + +/// Hello world +// Foo +final class ClassBasedProvider extends $NotifierProvider { + /// Hello world +// Foo + const ClassBasedProvider._( + {super.runNotifierBuildOverride, ClassBased Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'classBasedProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final ClassBased Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$classBasedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + ClassBased create() => _createCb?.call() ?? ClassBased(); + + @$internal + @override + ClassBasedProvider $copyWithCreate( + ClassBased Function() create, + ) { + return ClassBasedProvider._(create: create); + } + + @$internal + @override + ClassBasedProvider $copyWithBuild( + String Function( + Ref, + ClassBased, + ) build, + ) { + return ClassBasedProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$classBasedHash() => r'f1139017b1fcf38017402b514c61fb32dae40c39'; + +abstract class _$ClassBased extends $Notifier { + String build(); + @$internal + @override + String runBuild() => build(); +} + /// Hello world // Foo typedef FamilyRef = Ref; @@ -218,80 +292,6 @@ final class FamilyFamily extends Family { } } -/// Hello world -// Foo -@ProviderFor(ClassBased) -const classBasedProvider = ClassBasedProvider._(); - -/// Hello world -// Foo -final class ClassBasedProvider extends $NotifierProvider { - /// Hello world -// Foo - const ClassBasedProvider._( - {super.runNotifierBuildOverride, ClassBased Function()? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'classBasedProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final ClassBased Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$classBasedHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(String value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - ClassBased create() => _createCb?.call() ?? ClassBased(); - - @$internal - @override - ClassBasedProvider $copyWithCreate( - ClassBased Function() create, - ) { - return ClassBasedProvider._(create: create); - } - - @$internal - @override - ClassBasedProvider $copyWithBuild( - String Function( - Ref, - ClassBased, - ) build, - ) { - return ClassBasedProvider._(runNotifierBuildOverride: build); - } - - @$internal - @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); -} - -String _$classBasedHash() => r'f1139017b1fcf38017402b514c61fb32dae40c39'; - -abstract class _$ClassBased extends $Notifier { - String build(); - @$internal - @override - String runBuild() => build(); -} - /// Hello world // Foo @ProviderFor(ClassFamilyBased) @@ -465,6 +465,5 @@ abstract class _$ClassFamilyBased extends $Notifier { ); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 486fb8d4d..398030394 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -198,6 +198,238 @@ final class GeneratedFamilyFamily extends Family { } } +@ProviderFor(GeneratedClass) +const generatedClassProvider = GeneratedClassProvider._(); + +final class GeneratedClassProvider + extends $NotifierProvider { + const GeneratedClassProvider._( + {super.runNotifierBuildOverride, GeneratedClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'generatedClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final GeneratedClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$generatedClassHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(_Test value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider<_Test>(value), + ); + } + + @$internal + @override + GeneratedClass create() => _createCb?.call() ?? GeneratedClass(); + + @$internal + @override + GeneratedClassProvider $copyWithCreate( + GeneratedClass Function() create, + ) { + return GeneratedClassProvider._(create: create); + } + + @$internal + @override + GeneratedClassProvider $copyWithBuild( + _Test Function( + Ref<_Test>, + GeneratedClass, + ) build, + ) { + return GeneratedClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$generatedClassHash() => r'984153f97e25de687d2f19756b277aabd56f6e72'; + +abstract class _$GeneratedClass extends $Notifier<_Test> { + _Test build(); + @$internal + @override + _Test runBuild() => build(); +} + +@ProviderFor(GeneratedClassFamily) +const generatedClassFamilyProvider = GeneratedClassFamilyFamily._(); + +final class GeneratedClassFamilyProvider + extends $NotifierProvider { + const GeneratedClassFamilyProvider._( + {required GeneratedClassFamilyFamily super.from, + required _Test super.argument, + super.runNotifierBuildOverride, + GeneratedClassFamily Function()? create}) + : _createCb = create, + super( + name: r'generatedClassFamilyProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final GeneratedClassFamily Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$generatedClassFamilyHash(); + + @override + String toString() { + return r'generatedClassFamilyProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(_Test value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider<_Test>(value), + ); + } + + @$internal + @override + GeneratedClassFamily create() => _createCb?.call() ?? GeneratedClassFamily(); + + @$internal + @override + GeneratedClassFamilyProvider $copyWithCreate( + GeneratedClassFamily Function() create, + ) { + return GeneratedClassFamilyProvider._( + argument: argument as _Test, + from: from! as GeneratedClassFamilyFamily, + create: create); + } + + @$internal + @override + GeneratedClassFamilyProvider $copyWithBuild( + _Test Function( + Ref<_Test>, + GeneratedClassFamily, + ) build, + ) { + return GeneratedClassFamilyProvider._( + argument: argument as _Test, + from: from! as GeneratedClassFamilyFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is GeneratedClassFamilyProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$generatedClassFamilyHash() => + r'28d0a5a82af5b254f6ef07b492916e2feb7e6e63'; + +final class GeneratedClassFamilyFamily extends Family { + const GeneratedClassFamilyFamily._() + : super( + name: r'generatedClassFamilyProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + GeneratedClassFamilyProvider call( + _Test test, + ) => + GeneratedClassFamilyProvider._(argument: test, from: this); + + @override + String debugGetCreateSourceHash() => _$generatedClassFamilyHash(); + + @override + String toString() => r'generatedClassFamilyProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + GeneratedClassFamily Function( + _Test args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GeneratedClassFamilyProvider; + + final argument = provider.argument as _Test; + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + _Test Function( + Ref<_Test> ref, GeneratedClassFamily notifier, _Test argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GeneratedClassFamilyProvider; + + final argument = provider.argument as _Test; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(container); + }, + ); + } +} + +abstract class _$GeneratedClassFamily extends $Notifier<_Test> { + late final _$args = + (ref as $NotifierProviderElement).origin.argument as _Test; + _Test get test => _$args; + + _Test build( + _Test test, + ); + @$internal + @override + _Test runBuild() => build( + _$args, + ); +} + typedef $DynamicRef = Ref; @ProviderFor($dynamic) @@ -390,24 +622,256 @@ final class $DynamicFamilyFamily extends Family { } } -typedef _DynamicRef = Ref; - -@ProviderFor(_dynamic) -const _dynamicProvider = _DynamicFamily._(); +@ProviderFor($DynamicClass) +const $dynamicClassProvider = $DynamicClassProvider._(); -final class _DynamicProvider - extends $FunctionalProvider - with $Provider { - const _DynamicProvider._( - {required _DynamicFamily super.from, - required dynamic super.argument, - Object? Function( - _DynamicRef ref, - dynamic test, - )? create}) +final class $DynamicClassProvider + extends $NotifierProvider<$DynamicClass, Object?> { + const $DynamicClassProvider._( + {super.runNotifierBuildOverride, $DynamicClass Function()? create}) : _createCb = create, super( - name: r'_dynamicProvider', + from: null, + argument: null, + name: r'$dynamicClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final $DynamicClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$$dynamicClassHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Object? value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $DynamicClass create() => _createCb?.call() ?? $DynamicClass(); + + @$internal + @override + $DynamicClassProvider $copyWithCreate( + $DynamicClass Function() create, + ) { + return $DynamicClassProvider._(create: create); + } + + @$internal + @override + $DynamicClassProvider $copyWithBuild( + Object? Function( + Ref, + $DynamicClass, + ) build, + ) { + return $DynamicClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement<$DynamicClass, Object?> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$$dynamicClassHash() => r'c6d8e5191c3f060df3ce3eee66107433fd4c3292'; + +abstract class _$$DynamicClass extends $Notifier { + Object? build(); + @$internal + @override + Object? runBuild() => build(); +} + +@ProviderFor($DynamicClassFamily) +const $dynamicClassFamilyProvider = $DynamicClassFamilyFamily._(); + +final class $DynamicClassFamilyProvider + extends $NotifierProvider<$DynamicClassFamily, Object?> { + const $DynamicClassFamilyProvider._( + {required $DynamicClassFamilyFamily super.from, + required dynamic super.argument, + super.runNotifierBuildOverride, + $DynamicClassFamily Function()? create}) + : _createCb = create, + super( + name: r'$dynamicClassFamilyProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final $DynamicClassFamily Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$$dynamicClassFamilyHash(); + + @override + String toString() { + return r'$dynamicClassFamilyProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Object? value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $DynamicClassFamily create() => _createCb?.call() ?? $DynamicClassFamily(); + + @$internal + @override + $DynamicClassFamilyProvider $copyWithCreate( + $DynamicClassFamily Function() create, + ) { + return $DynamicClassFamilyProvider._( + argument: argument as dynamic, + from: from! as $DynamicClassFamilyFamily, + create: create); + } + + @$internal + @override + $DynamicClassFamilyProvider $copyWithBuild( + Object? Function( + Ref, + $DynamicClassFamily, + ) build, + ) { + return $DynamicClassFamilyProvider._( + argument: argument as dynamic, + from: from! as $DynamicClassFamilyFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement<$DynamicClassFamily, Object?> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is $DynamicClassFamilyProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$$dynamicClassFamilyHash() => + r'bdda961386f3b647c071d79293a8da441580c470'; + +final class $DynamicClassFamilyFamily extends Family { + const $DynamicClassFamilyFamily._() + : super( + name: r'$dynamicClassFamilyProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + $DynamicClassFamilyProvider call( + dynamic test, + ) => + $DynamicClassFamilyProvider._(argument: test, from: this); + + @override + String debugGetCreateSourceHash() => _$$dynamicClassFamilyHash(); + + @override + String toString() => r'$dynamicClassFamilyProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + $DynamicClassFamily Function( + dynamic args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as $DynamicClassFamilyProvider; + + final argument = provider.argument as dynamic; + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + Object? Function( + Ref ref, $DynamicClassFamily notifier, dynamic argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as $DynamicClassFamilyProvider; + + final argument = provider.argument as dynamic; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(container); + }, + ); + } +} + +abstract class _$$DynamicClassFamily extends $Notifier { + late final _$args = + (ref as $NotifierProviderElement).origin.argument as dynamic; + dynamic get test => _$args; + + Object? build( + dynamic test, + ); + @$internal + @override + Object? runBuild() => build( + _$args, + ); +} + +typedef _DynamicRef = Ref; + +@ProviderFor(_dynamic) +const _dynamicProvider = _DynamicFamily._(); + +final class _DynamicProvider + extends $FunctionalProvider + with $Provider { + const _DynamicProvider._( + {required _DynamicFamily super.from, + required dynamic super.argument, + Object? Function( + _DynamicRef ref, + dynamic test, + )? create}) + : _createCb = create, + super( + name: r'_dynamicProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, @@ -717,470 +1181,6 @@ final class AliasFamilyFamily extends Family { } } -@ProviderFor(GeneratedClass) -const generatedClassProvider = GeneratedClassProvider._(); - -final class GeneratedClassProvider - extends $NotifierProvider { - const GeneratedClassProvider._( - {super.runNotifierBuildOverride, GeneratedClass Function()? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'generatedClassProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final GeneratedClass Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$generatedClassHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(_Test value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider<_Test>(value), - ); - } - - @$internal - @override - GeneratedClass create() => _createCb?.call() ?? GeneratedClass(); - - @$internal - @override - GeneratedClassProvider $copyWithCreate( - GeneratedClass Function() create, - ) { - return GeneratedClassProvider._(create: create); - } - - @$internal - @override - GeneratedClassProvider $copyWithBuild( - _Test Function( - Ref<_Test>, - GeneratedClass, - ) build, - ) { - return GeneratedClassProvider._(runNotifierBuildOverride: build); - } - - @$internal - @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); -} - -String _$generatedClassHash() => r'984153f97e25de687d2f19756b277aabd56f6e72'; - -abstract class _$GeneratedClass extends $Notifier<_Test> { - _Test build(); - @$internal - @override - _Test runBuild() => build(); -} - -@ProviderFor(GeneratedClassFamily) -const generatedClassFamilyProvider = GeneratedClassFamilyFamily._(); - -final class GeneratedClassFamilyProvider - extends $NotifierProvider { - const GeneratedClassFamilyProvider._( - {required GeneratedClassFamilyFamily super.from, - required _Test super.argument, - super.runNotifierBuildOverride, - GeneratedClassFamily Function()? create}) - : _createCb = create, - super( - name: r'generatedClassFamilyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final GeneratedClassFamily Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$generatedClassFamilyHash(); - - @override - String toString() { - return r'generatedClassFamilyProvider' - '' - '($argument)'; - } - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(_Test value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider<_Test>(value), - ); - } - - @$internal - @override - GeneratedClassFamily create() => _createCb?.call() ?? GeneratedClassFamily(); - - @$internal - @override - GeneratedClassFamilyProvider $copyWithCreate( - GeneratedClassFamily Function() create, - ) { - return GeneratedClassFamilyProvider._( - argument: argument as _Test, - from: from! as GeneratedClassFamilyFamily, - create: create); - } - - @$internal - @override - GeneratedClassFamilyProvider $copyWithBuild( - _Test Function( - Ref<_Test>, - GeneratedClassFamily, - ) build, - ) { - return GeneratedClassFamilyProvider._( - argument: argument as _Test, - from: from! as GeneratedClassFamilyFamily, - runNotifierBuildOverride: build); - } - - @$internal - @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); - - @override - bool operator ==(Object other) { - return other is GeneratedClassFamilyProvider && other.argument == argument; - } - - @override - int get hashCode { - return argument.hashCode; - } -} - -String _$generatedClassFamilyHash() => - r'28d0a5a82af5b254f6ef07b492916e2feb7e6e63'; - -final class GeneratedClassFamilyFamily extends Family { - const GeneratedClassFamilyFamily._() - : super( - name: r'generatedClassFamilyProvider', - dependencies: null, - allTransitiveDependencies: null, - isAutoDispose: true, - ); - - GeneratedClassFamilyProvider call( - _Test test, - ) => - GeneratedClassFamilyProvider._(argument: test, from: this); - - @override - String debugGetCreateSourceHash() => _$generatedClassFamilyHash(); - - @override - String toString() => r'generatedClassFamilyProvider'; - - /// {@macro riverpod.override_with} - Override overrideWith( - GeneratedClassFamily Function( - _Test args, - ) create, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as GeneratedClassFamilyProvider; - - final argument = provider.argument as _Test; - - return provider - .$copyWithCreate(() => create(argument)) - .$createElement(container); - }, - ); - } - - /// {@macro riverpod.override_with_build} - Override overrideWithBuild( - _Test Function( - Ref<_Test> ref, GeneratedClassFamily notifier, _Test argument) - build, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as GeneratedClassFamilyProvider; - - final argument = provider.argument as _Test; - - return provider - .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); - }, - ); - } -} - -abstract class _$GeneratedClassFamily extends $Notifier<_Test> { - late final _$args = - (ref as $NotifierProviderElement).origin.argument as _Test; - _Test get test => _$args; - - _Test build( - _Test test, - ); - @$internal - @override - _Test runBuild() => build( - _$args, - ); -} - -@ProviderFor($DynamicClass) -const $dynamicClassProvider = $DynamicClassProvider._(); - -final class $DynamicClassProvider - extends $NotifierProvider<$DynamicClass, Object?> { - const $DynamicClassProvider._( - {super.runNotifierBuildOverride, $DynamicClass Function()? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'$dynamicClassProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final $DynamicClass Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$$dynamicClassHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(Object? value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $DynamicClass create() => _createCb?.call() ?? $DynamicClass(); - - @$internal - @override - $DynamicClassProvider $copyWithCreate( - $DynamicClass Function() create, - ) { - return $DynamicClassProvider._(create: create); - } - - @$internal - @override - $DynamicClassProvider $copyWithBuild( - Object? Function( - Ref, - $DynamicClass, - ) build, - ) { - return $DynamicClassProvider._(runNotifierBuildOverride: build); - } - - @$internal - @override - $NotifierProviderElement<$DynamicClass, Object?> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); -} - -String _$$dynamicClassHash() => r'c6d8e5191c3f060df3ce3eee66107433fd4c3292'; - -abstract class _$$DynamicClass extends $Notifier { - Object? build(); - @$internal - @override - Object? runBuild() => build(); -} - -@ProviderFor($DynamicClassFamily) -const $dynamicClassFamilyProvider = $DynamicClassFamilyFamily._(); - -final class $DynamicClassFamilyProvider - extends $NotifierProvider<$DynamicClassFamily, Object?> { - const $DynamicClassFamilyProvider._( - {required $DynamicClassFamilyFamily super.from, - required dynamic super.argument, - super.runNotifierBuildOverride, - $DynamicClassFamily Function()? create}) - : _createCb = create, - super( - name: r'$dynamicClassFamilyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final $DynamicClassFamily Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$$dynamicClassFamilyHash(); - - @override - String toString() { - return r'$dynamicClassFamilyProvider' - '' - '($argument)'; - } - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(Object? value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $DynamicClassFamily create() => _createCb?.call() ?? $DynamicClassFamily(); - - @$internal - @override - $DynamicClassFamilyProvider $copyWithCreate( - $DynamicClassFamily Function() create, - ) { - return $DynamicClassFamilyProvider._( - argument: argument as dynamic, - from: from! as $DynamicClassFamilyFamily, - create: create); - } - - @$internal - @override - $DynamicClassFamilyProvider $copyWithBuild( - Object? Function( - Ref, - $DynamicClassFamily, - ) build, - ) { - return $DynamicClassFamilyProvider._( - argument: argument as dynamic, - from: from! as $DynamicClassFamilyFamily, - runNotifierBuildOverride: build); - } - - @$internal - @override - $NotifierProviderElement<$DynamicClassFamily, Object?> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); - - @override - bool operator ==(Object other) { - return other is $DynamicClassFamilyProvider && other.argument == argument; - } - - @override - int get hashCode { - return argument.hashCode; - } -} - -String _$$dynamicClassFamilyHash() => - r'bdda961386f3b647c071d79293a8da441580c470'; - -final class $DynamicClassFamilyFamily extends Family { - const $DynamicClassFamilyFamily._() - : super( - name: r'$dynamicClassFamilyProvider', - dependencies: null, - allTransitiveDependencies: null, - isAutoDispose: true, - ); - - $DynamicClassFamilyProvider call( - dynamic test, - ) => - $DynamicClassFamilyProvider._(argument: test, from: this); - - @override - String debugGetCreateSourceHash() => _$$dynamicClassFamilyHash(); - - @override - String toString() => r'$dynamicClassFamilyProvider'; - - /// {@macro riverpod.override_with} - Override overrideWith( - $DynamicClassFamily Function( - dynamic args, - ) create, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as $DynamicClassFamilyProvider; - - final argument = provider.argument as dynamic; - - return provider - .$copyWithCreate(() => create(argument)) - .$createElement(container); - }, - ); - } - - /// {@macro riverpod.override_with_build} - Override overrideWithBuild( - Object? Function( - Ref ref, $DynamicClassFamily notifier, dynamic argument) - build, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as $DynamicClassFamilyProvider; - - final argument = provider.argument as dynamic; - - return provider - .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); - }, - ); - } -} - -abstract class _$$DynamicClassFamily extends $Notifier { - late final _$args = - (ref as $NotifierProviderElement).origin.argument as dynamic; - dynamic get test => _$args; - - Object? build( - dynamic test, - ); - @$internal - @override - Object? runBuild() => build( - _$args, - ); -} - @ProviderFor(AliasClass) const aliasClassProvider = AliasClassProvider._(); @@ -1412,6 +1412,5 @@ abstract class _$AliasClassFamily extends $Notifier> { ); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index 532cdf6cf..d83a07399 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -194,6 +194,5 @@ abstract class _$SimpleClass extends $Notifier { String runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/scopes.dart b/packages/riverpod_generator/test/integration/scopes.dart index 0669c2bdf..d555c207b 100644 --- a/packages/riverpod_generator/test/integration/scopes.dart +++ b/packages/riverpod_generator/test/integration/scopes.dart @@ -2,7 +2,6 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'scopes.g.dart'; -// TODO changelog added support for abstract build method. @riverpod class ScopedClass extends _$ScopedClass { @override diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 69f38686a..76d571260 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -234,6 +234,5 @@ abstract class _$ScopedClassFamily extends $Notifier { ); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index 1070512c9..17d1d5a4d 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -124,6 +124,5 @@ final class CounterProvider extends $FunctionalProvider String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 2ba7eb128..b94b3c9d7 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -118,6 +118,155 @@ final class GenericFamily extends Family { } } +@ProviderFor(GenericClass) +const genericClassProvider = GenericClassFamily._(); + +final class GenericClassProvider + extends $StreamNotifierProvider, List> { + const GenericClassProvider._( + {required GenericClassFamily super.from, + super.runNotifierBuildOverride, + GenericClass Function()? create}) + : _createCb = create, + super( + argument: null, + name: r'genericClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final GenericClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$genericClassHash(); + + GenericClassProvider _copyWithCreate( + GenericClass Function() create, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, create: create); + } + + GenericClassProvider _copyWithBuild( + Stream> Function( + Ref>>, + GenericClass, + ) build, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, runNotifierBuildOverride: build); + } + + @override + String toString() { + return r'genericClassProvider' + '<${T}>' + '()'; + } + + @$internal + @override + GenericClass create() => _createCb?.call() ?? GenericClass(); + + @$internal + @override + GenericClassProvider $copyWithCreate( + GenericClass Function() create, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, create: create); + } + + @$internal + @override + GenericClassProvider $copyWithBuild( + Stream> Function( + Ref>>, + GenericClass, + ) build, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, runNotifierBuildOverride: build); + } + + @$internal + @override + $StreamNotifierProviderElement, List> $createElement( + ProviderContainer container) => + $StreamNotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is GenericClassProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } +} + +String _$genericClassHash() => r'401ae1cfd97a4291dfd135a69ff8e1c436866e5a'; + +final class GenericClassFamily extends Family { + const GenericClassFamily._() + : super( + name: r'genericClassProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + GenericClassProvider call() => + GenericClassProvider._(from: this); + + @override + String debugGetCreateSourceHash() => _$genericClassHash(); + + @override + String toString() => r'genericClassProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + GenericClass Function() create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericClassProvider; + + return provider._copyWithCreate(create).$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + Stream> Function( + Ref>> ref, GenericClass notifier) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericClassProvider; + + return provider._copyWithBuild(build).$createElement(container); + }, + ); + } +} + +abstract class _$GenericClass extends $StreamNotifier> { + Stream> build(); + @$internal + @override + Stream> runBuild() => build(); +} + typedef PublicRef = Ref>; @ProviderFor(public) @@ -403,155 +552,6 @@ final class FamilyFamily extends Family { } } -@ProviderFor(GenericClass) -const genericClassProvider = GenericClassFamily._(); - -final class GenericClassProvider - extends $StreamNotifierProvider, List> { - const GenericClassProvider._( - {required GenericClassFamily super.from, - super.runNotifierBuildOverride, - GenericClass Function()? create}) - : _createCb = create, - super( - argument: null, - name: r'genericClassProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final GenericClass Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$genericClassHash(); - - GenericClassProvider _copyWithCreate( - GenericClass Function() create, - ) { - return GenericClassProvider._( - from: from! as GenericClassFamily, create: create); - } - - GenericClassProvider _copyWithBuild( - Stream> Function( - Ref>>, - GenericClass, - ) build, - ) { - return GenericClassProvider._( - from: from! as GenericClassFamily, runNotifierBuildOverride: build); - } - - @override - String toString() { - return r'genericClassProvider' - '<${T}>' - '()'; - } - - @$internal - @override - GenericClass create() => _createCb?.call() ?? GenericClass(); - - @$internal - @override - GenericClassProvider $copyWithCreate( - GenericClass Function() create, - ) { - return GenericClassProvider._( - from: from! as GenericClassFamily, create: create); - } - - @$internal - @override - GenericClassProvider $copyWithBuild( - Stream> Function( - Ref>>, - GenericClass, - ) build, - ) { - return GenericClassProvider._( - from: from! as GenericClassFamily, runNotifierBuildOverride: build); - } - - @$internal - @override - $StreamNotifierProviderElement, List> $createElement( - ProviderContainer container) => - $StreamNotifierProviderElement(this, container); - - @override - bool operator ==(Object other) { - return other is GenericClassProvider && - other.runtimeType == runtimeType && - other.argument == argument; - } - - @override - int get hashCode { - return Object.hash(runtimeType, argument); - } -} - -String _$genericClassHash() => r'401ae1cfd97a4291dfd135a69ff8e1c436866e5a'; - -final class GenericClassFamily extends Family { - const GenericClassFamily._() - : super( - name: r'genericClassProvider', - dependencies: null, - allTransitiveDependencies: null, - isAutoDispose: true, - ); - - GenericClassProvider call() => - GenericClassProvider._(from: this); - - @override - String debugGetCreateSourceHash() => _$genericClassHash(); - - @override - String toString() => r'genericClassProvider'; - - /// {@macro riverpod.override_with} - Override overrideWith( - GenericClass Function() create, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as GenericClassProvider; - - return provider._copyWithCreate(create).$createElement(container); - }, - ); - } - - /// {@macro riverpod.override_with_build} - Override overrideWithBuild( - Stream> Function( - Ref>> ref, GenericClass notifier) - build, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as GenericClassProvider; - - return provider._copyWithBuild(build).$createElement(container); - }, - ); - } -} - -abstract class _$GenericClass extends $StreamNotifier> { - Stream> build(); - @$internal - @override - Stream> runBuild() => build(); -} - @ProviderFor(PublicClass) const publicClassProvider = PublicClassProvider._(); @@ -901,6 +901,5 @@ abstract class _$FamilyClass extends $StreamNotifier { ); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 5bbb7ffeb..d94bf4b16 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -302,6 +302,162 @@ final class ComplexGenericFamily extends Family { } } +@ProviderFor(GenericClass) +const genericClassProvider = GenericClassFamily._(); + +final class GenericClassProvider + extends $NotifierProvider, List> { + const GenericClassProvider._( + {required GenericClassFamily super.from, + super.runNotifierBuildOverride, + GenericClass Function()? create}) + : _createCb = create, + super( + argument: null, + name: r'genericClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final GenericClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$genericClassHash(); + + GenericClassProvider _copyWithCreate( + GenericClass Function() create, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, create: create); + } + + GenericClassProvider _copyWithBuild( + List Function( + Ref>, + GenericClass, + ) build, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, runNotifierBuildOverride: build); + } + + @override + String toString() { + return r'genericClassProvider' + '<${T}>' + '()'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + GenericClass create() => _createCb?.call() ?? GenericClass(); + + @$internal + @override + GenericClassProvider $copyWithCreate( + GenericClass Function() create, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, create: create); + } + + @$internal + @override + GenericClassProvider $copyWithBuild( + List Function( + Ref>, + GenericClass, + ) build, + ) { + return GenericClassProvider._( + from: from! as GenericClassFamily, runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement, List> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); + + @override + bool operator ==(Object other) { + return other is GenericClassProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } +} + +String _$genericClassHash() => r'671e348a5abf8e00ab06c5f247defbca8af9677b'; + +final class GenericClassFamily extends Family { + const GenericClassFamily._() + : super( + name: r'genericClassProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + GenericClassProvider call() => + GenericClassProvider._(from: this); + + @override + String debugGetCreateSourceHash() => _$genericClassHash(); + + @override + String toString() => r'genericClassProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + GenericClass Function() create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericClassProvider; + + return provider._copyWithCreate(create).$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + List Function(Ref> ref, GenericClass notifier) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as GenericClassProvider; + + return provider._copyWithBuild(build).$createElement(container); + }, + ); + } +} + +abstract class _$GenericClass extends $Notifier> { + List build(); + @$internal + @override + List runBuild() => build(); +} + typedef RawFutureRef = Ref>>; @ProviderFor(rawFuture) @@ -426,43 +582,27 @@ final class RawStreamProvider extends $FunctionalProvider< String _$rawStreamHash() => r'2b764189753a8b74f47ba557a79416f00ef5cebd'; -typedef RawFamilyFutureRef = Ref>>; - -@ProviderFor(rawFamilyFuture) -const rawFamilyFutureProvider = RawFamilyFutureFamily._(); +@ProviderFor(RawFutureClass) +const rawFutureClassProvider = RawFutureClassProvider._(); -final class RawFamilyFutureProvider extends $FunctionalProvider< - Raw>, Raw>, RawFamilyFutureRef> - with $Provider>, RawFamilyFutureRef> { - const RawFamilyFutureProvider._( - {required RawFamilyFutureFamily super.from, - required int super.argument, - Raw> Function( - RawFamilyFutureRef ref, - int id, - )? create}) +final class RawFutureClassProvider + extends $NotifierProvider>> { + const RawFutureClassProvider._( + {super.runNotifierBuildOverride, RawFutureClass Function()? create}) : _createCb = create, super( - name: r'rawFamilyFutureProvider', + from: null, + argument: null, + name: r'rawFutureClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final Raw> Function( - RawFamilyFutureRef ref, - int id, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$rawFamilyFutureHash(); + final RawFutureClass Function()? _createCb; @override - String toString() { - return r'rawFamilyFutureProvider' - '' - '($argument)'; - } + String debugGetCreateSourceHash() => _$rawFutureClassHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(Raw> value) { @@ -474,56 +614,210 @@ final class RawFamilyFutureProvider extends $FunctionalProvider< @$internal @override - $ProviderElement>> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + RawFutureClass create() => _createCb?.call() ?? RawFutureClass(); + @$internal @override - RawFamilyFutureProvider $copyWithCreate( - Raw> Function( - RawFamilyFutureRef ref, - ) create, + RawFutureClassProvider $copyWithCreate( + RawFutureClass Function() create, ) { - return RawFamilyFutureProvider._( - argument: argument as int, - from: from! as RawFamilyFutureFamily, - create: ( - ref, - int id, - ) => - create(ref)); + return RawFutureClassProvider._(create: create); } + @$internal @override - Raw> create(RawFamilyFutureRef ref) { - final _$cb = _createCb ?? rawFamilyFuture; - final argument = this.argument as int; - return _$cb( - ref, - argument, - ); + RawFutureClassProvider $copyWithBuild( + Raw> Function( + Ref>>, + RawFutureClass, + ) build, + ) { + return RawFutureClassProvider._(runNotifierBuildOverride: build); } + @$internal @override - bool operator ==(Object other) { - return other is RawFamilyFutureProvider && other.argument == argument; - } + $NotifierProviderElement>> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$rawFutureClassHash() => r'bf66f1cdbd99118b8845d206e6a2611b3101f45c'; +abstract class _$RawFutureClass extends $Notifier>> { + Raw> build(); + @$internal @override - int get hashCode { - return argument.hashCode; - } + Raw> runBuild() => build(); } -String _$rawFamilyFutureHash() => r'485f59512081852e51279658facc015309743864'; +@ProviderFor(RawStreamClass) +const rawStreamClassProvider = RawStreamClassProvider._(); -final class RawFamilyFutureFamily extends Family { - const RawFamilyFutureFamily._() - : super( - name: r'rawFamilyFutureProvider', - dependencies: null, - allTransitiveDependencies: null, - isAutoDispose: true, +final class RawStreamClassProvider + extends $NotifierProvider>> { + const RawStreamClassProvider._( + {super.runNotifierBuildOverride, RawStreamClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'rawStreamClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final RawStreamClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$rawStreamClassHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @$internal + @override + RawStreamClass create() => _createCb?.call() ?? RawStreamClass(); + + @$internal + @override + RawStreamClassProvider $copyWithCreate( + RawStreamClass Function() create, + ) { + return RawStreamClassProvider._(create: create); + } + + @$internal + @override + RawStreamClassProvider $copyWithBuild( + Raw> Function( + Ref>>, + RawStreamClass, + ) build, + ) { + return RawStreamClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement>> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$rawStreamClassHash() => r'712cffcb2018cfb4ff45012c1aa6e43c8cbe9d5d'; + +abstract class _$RawStreamClass extends $Notifier>> { + Raw> build(); + @$internal + @override + Raw> runBuild() => build(); +} + +typedef RawFamilyFutureRef = Ref>>; + +@ProviderFor(rawFamilyFuture) +const rawFamilyFutureProvider = RawFamilyFutureFamily._(); + +final class RawFamilyFutureProvider extends $FunctionalProvider< + Raw>, Raw>, RawFamilyFutureRef> + with $Provider>, RawFamilyFutureRef> { + const RawFamilyFutureProvider._( + {required RawFamilyFutureFamily super.from, + required int super.argument, + Raw> Function( + RawFamilyFutureRef ref, + int id, + )? create}) + : _createCb = create, + super( + name: r'rawFamilyFutureProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Raw> Function( + RawFamilyFutureRef ref, + int id, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$rawFamilyFutureHash(); + + @override + String toString() { + return r'rawFamilyFutureProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); + } + + @$internal + @override + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + RawFamilyFutureProvider $copyWithCreate( + Raw> Function( + RawFamilyFutureRef ref, + ) create, + ) { + return RawFamilyFutureProvider._( + argument: argument as int, + from: from! as RawFamilyFutureFamily, + create: ( + ref, + int id, + ) => + create(ref)); + } + + @override + Raw> create(RawFamilyFutureRef ref) { + final _$cb = _createCb ?? rawFamilyFuture; + final argument = this.argument as int; + return _$cb( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is RawFamilyFutureProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$rawFamilyFutureHash() => r'485f59512081852e51279658facc015309743864'; + +final class RawFamilyFutureFamily extends Family { + const RawFamilyFutureFamily._() + : super( + name: r'rawFamilyFutureProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, ); RawFamilyFutureProvider call( @@ -692,727 +986,362 @@ final class RawFamilyStreamFamily extends Family { } } -/// This is some documentation -typedef PublicRef = Ref; - -/// This is some documentation -@ProviderFor(public) -const publicProvider = PublicProvider._(); +@ProviderFor(RawFamilyFutureClass) +const rawFamilyFutureClassProvider = RawFamilyFutureClassFamily._(); -/// This is some documentation -final class PublicProvider - extends $FunctionalProvider - with $Provider { - /// This is some documentation - const PublicProvider._( - {String Function( - PublicRef ref, - )? create}) +final class RawFamilyFutureClassProvider + extends $NotifierProvider>> { + const RawFamilyFutureClassProvider._( + {required RawFamilyFutureClassFamily super.from, + required int super.argument, + super.runNotifierBuildOverride, + RawFamilyFutureClass Function()? create}) : _createCb = create, super( - from: null, - argument: null, - name: r'publicProvider', + name: r'rawFamilyFutureClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final String Function( - PublicRef ref, - )? _createCb; + final RawFamilyFutureClass Function()? _createCb; @override - String debugGetCreateSourceHash() => _$publicHash(); + String debugGetCreateSourceHash() => _$rawFamilyFutureClassHash(); + + @override + String toString() { + return r'rawFamilyFutureClassProvider' + '' + '($argument)'; + } /// {@macro riverpod.override_with_value} - Override overrideWithValue(String value) { + Override overrideWithValue(Raw> value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider(value), + providerOverride: $ValueProvider>>(value), ); } @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + RawFamilyFutureClass create() => _createCb?.call() ?? RawFamilyFutureClass(); + @$internal @override - PublicProvider $copyWithCreate( - String Function( - PublicRef ref, - ) create, + RawFamilyFutureClassProvider $copyWithCreate( + RawFamilyFutureClass Function() create, ) { - return PublicProvider._(create: create); + return RawFamilyFutureClassProvider._( + argument: argument as int, + from: from! as RawFamilyFutureClassFamily, + create: create); } + @$internal @override - String create(PublicRef ref) { - final _$cb = _createCb ?? public; - return _$cb(ref); + RawFamilyFutureClassProvider $copyWithBuild( + Raw> Function( + Ref>>, + RawFamilyFutureClass, + ) build, + ) { + return RawFamilyFutureClassProvider._( + argument: argument as int, + from: from! as RawFamilyFutureClassFamily, + runNotifierBuildOverride: build); } -} - -String _$publicHash() => r'138be35943899793ab085e711fe3f3d22696a3ba'; -typedef Supports$inNamesRef = Ref; + @$internal + @override + $NotifierProviderElement>> + $createElement(ProviderContainer container) => + $NotifierProviderElement(this, container); -@ProviderFor(supports$inNames) -const supports$inNamesProvider = Supports$inNamesProvider._(); - -final class Supports$inNamesProvider - extends $FunctionalProvider - with $Provider { - const Supports$inNamesProvider._( - {String Function( - Supports$inNamesRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'supports$inNamesProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final String Function( - Supports$inNamesRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$supports$inNamesHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(String value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - Supports$inNamesProvider $copyWithCreate( - String Function( - Supports$inNamesRef ref, - ) create, - ) { - return Supports$inNamesProvider._(create: create); - } - - @override - String create(Supports$inNamesRef ref) { - final _$cb = _createCb ?? supports$inNames; - return _$cb(ref); - } -} - -String _$supports$inNamesHash() => r'cbf929802fcbd0aa949ad72743d096fb3ef5f28f'; - -/// This is some documentation -typedef FamilyRef = Ref; - -/// This is some documentation -@ProviderFor(family) -const familyProvider = FamilyFamily._(); - -/// This is some documentation -final class FamilyProvider - extends $FunctionalProvider - with $Provider { - /// This is some documentation - const FamilyProvider._( - {required FamilyFamily super.from, - required ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) - super.argument, - String Function( - FamilyRef ref, - int first, { - String? second, - required double third, - bool fourth, - List? fifth, - })? create}) - : _createCb = create, - super( - name: r'familyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final String Function( - FamilyRef ref, - int first, { - String? second, - required double third, - bool fourth, - List? fifth, - })? _createCb; - - @override - String debugGetCreateSourceHash() => _$familyHash(); - - @override - String toString() { - return r'familyProvider' - '' - '$argument'; - } - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(String value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - FamilyProvider $copyWithCreate( - String Function( - FamilyRef ref, - ) create, - ) { - return FamilyProvider._( - argument: argument as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }), - from: from! as FamilyFamily, - create: ( - ref, - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) => - create(ref)); - } - - @override - String create(FamilyRef ref) { - final _$cb = _createCb ?? family; - final argument = this.argument as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }); - return _$cb( - ref, - argument.$1, - second: argument.second, - third: argument.third, - fourth: argument.fourth, - fifth: argument.fifth, - ); - } - - @override - bool operator ==(Object other) { - return other is FamilyProvider && other.argument == argument; - } - - @override - int get hashCode { - return argument.hashCode; - } -} - -String _$familyHash() => r'14d1ee238ca608d547630d0e222ef4c5866e9e61'; - -/// This is some documentation -final class FamilyFamily extends Family { - const FamilyFamily._() - : super( - name: r'familyProvider', - dependencies: null, - allTransitiveDependencies: null, - isAutoDispose: true, - ); - - /// This is some documentation - FamilyProvider call( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }) => - FamilyProvider._(argument: ( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, - ), from: this); - - @override - String debugGetCreateSourceHash() => _$familyHash(); - - @override - String toString() => r'familyProvider'; - - /// {@macro riverpod.override_with} - Override overrideWith( - String Function( - FamilyRef ref, - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) args, - ) create, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as FamilyProvider; - - final argument = provider.argument as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }); - - return provider - .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); - }, - ); - } -} - -typedef _PrivateRef = Ref; - -@ProviderFor(_private) -const _privateProvider = _PrivateProvider._(); - -final class _PrivateProvider - extends $FunctionalProvider - with $Provider { - const _PrivateProvider._( - {String Function( - _PrivateRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'_privateProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final String Function( - _PrivateRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$privateHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(String value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - _PrivateProvider $copyWithCreate( - String Function( - _PrivateRef ref, - ) create, - ) { - return _PrivateProvider._(create: create); - } - - @override - String create(_PrivateRef ref) { - final _$cb = _createCb ?? _private; - return _$cb(ref); - } -} - -String _$privateHash() => r'519561bc7e88e394d7f75ca2102a5c0acc832c66'; - -typedef Supports$InFnNameRef = Ref; - -@ProviderFor(supports$InFnName) -const supports$InFnNameProvider = Supports$InFnNameFamily._(); - -final class Supports$InFnNameProvider - extends $FunctionalProvider> - with $Provider> { - const Supports$InFnNameProvider._( - {required Supports$InFnNameFamily super.from, - String Function( - Supports$InFnNameRef ref, - )? create}) - : _createCb = create, - super( - argument: null, - name: r'supports$InFnNameProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final String Function( - Supports$InFnNameRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$supports$InFnNameHash(); - - Supports$InFnNameProvider _copyWithCreate( - String Function( - Supports$InFnNameRef ref, - ) create, - ) { - return Supports$InFnNameProvider._( - from: from! as Supports$InFnNameFamily, create: create); - } - - @override - String toString() { - return r'supports$InFnNameProvider' - '<${And$InT}>' - '()'; - } - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(String value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - Supports$InFnNameProvider $copyWithCreate( - String Function( - Supports$InFnNameRef ref, - ) create, - ) { - return Supports$InFnNameProvider._( - from: from! as Supports$InFnNameFamily, create: create); - } - - @override - String create(Supports$InFnNameRef ref) { - final _$cb = _createCb ?? supports$InFnName; - return _$cb(ref); - } - - @override - bool operator ==(Object other) { - return other is Supports$InFnNameProvider && - other.runtimeType == runtimeType && - other.argument == argument; - } + @override + bool operator ==(Object other) { + return other is RawFamilyFutureClassProvider && other.argument == argument; + } @override int get hashCode { - return Object.hash(runtimeType, argument); + return argument.hashCode; } } -String _$supports$InFnNameHash() => r'fec3daca655669a46760cc54921f098b9cbaac3d'; +String _$rawFamilyFutureClassHash() => + r'd7cacb0f2c51697d107de6daa68b242c04085dca'; -final class Supports$InFnNameFamily extends Family { - const Supports$InFnNameFamily._() +final class RawFamilyFutureClassFamily extends Family { + const RawFamilyFutureClassFamily._() : super( - name: r'supports$InFnNameProvider', + name: r'rawFamilyFutureClassProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, ); - Supports$InFnNameProvider call() => - Supports$InFnNameProvider._(from: this); + RawFamilyFutureClassProvider call( + int id, + ) => + RawFamilyFutureClassProvider._(argument: id, from: this); @override - String debugGetCreateSourceHash() => _$supports$InFnNameHash(); + String debugGetCreateSourceHash() => _$rawFamilyFutureClassHash(); @override - String toString() => r'supports$InFnNameProvider'; + String toString() => r'rawFamilyFutureClassProvider'; /// {@macro riverpod.override_with} Override overrideWith( - String Function(Supports$InFnNameRef ref) create, + RawFamilyFutureClass Function( + int args, + ) create, ) { return $FamilyOverride( from: this, createElement: (container, provider) { - provider as Supports$InFnNameProvider; + provider as RawFamilyFutureClassProvider; - return provider._copyWithCreate(create).$createElement(container); + final argument = provider.argument as int; + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(container); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + Raw> Function(Ref>> ref, + RawFamilyFutureClass notifier, int argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as RawFamilyFutureClassProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(container); }, ); } } -typedef Supports$InFnNameFamilyRef = Ref; +abstract class _$RawFamilyFutureClass extends $Notifier>> { + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + int get id => _$args; -@ProviderFor(supports$InFnNameFamily) -const supports$InFnNameFamilyProvider = Supports$InFnNameFamilyFamily._(); + Raw> build( + int id, + ); + @$internal + @override + Raw> runBuild() => build( + _$args, + ); +} -final class Supports$InFnNameFamilyProvider - extends $FunctionalProvider> - with $Provider> { - const Supports$InFnNameFamilyProvider._( - {required Supports$InFnNameFamilyFamily super.from, - required ( - And$InT, { - And$InT named$arg, - String defaultArg, - }) - super.argument, - String Function( - Supports$InFnNameFamilyRef ref, - And$InT positional$arg, { - required And$InT named$arg, - String defaultArg, - })? create}) +@ProviderFor(RawFamilyStreamClass) +const rawFamilyStreamClassProvider = RawFamilyStreamClassFamily._(); + +final class RawFamilyStreamClassProvider + extends $NotifierProvider>> { + const RawFamilyStreamClassProvider._( + {required RawFamilyStreamClassFamily super.from, + required int super.argument, + super.runNotifierBuildOverride, + RawFamilyStreamClass Function()? create}) : _createCb = create, super( - name: r'supports$InFnNameFamilyProvider', + name: r'rawFamilyStreamClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final String Function( - Supports$InFnNameFamilyRef ref, - And$InT positional$arg, { - required And$InT named$arg, - String defaultArg, - })? _createCb; + final RawFamilyStreamClass Function()? _createCb; @override - String debugGetCreateSourceHash() => _$supports$InFnNameFamilyHash(); - - Supports$InFnNameFamilyProvider _copyWithCreate( - String Function( - Supports$InFnNameFamilyRef ref, - And$InT positional$arg, { - required And$InT named$arg, - String defaultArg, - }) create, - ) { - return Supports$InFnNameFamilyProvider._( - argument: argument as ( - And$InT, { - And$InT named$arg, - String defaultArg, - }), - from: from! as Supports$InFnNameFamilyFamily, - create: create); - } + String debugGetCreateSourceHash() => _$rawFamilyStreamClassHash(); @override String toString() { - return r'supports$InFnNameFamilyProvider' - '<${And$InT}>' - '$argument'; + return r'rawFamilyStreamClassProvider' + '' + '($argument)'; } /// {@macro riverpod.override_with_value} - Override overrideWithValue(String value) { + Override overrideWithValue(Raw> value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider(value), + providerOverride: $ValueProvider>>(value), ); } @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + RawFamilyStreamClass create() => _createCb?.call() ?? RawFamilyStreamClass(); + @$internal @override - Supports$InFnNameFamilyProvider $copyWithCreate( - String Function( - Supports$InFnNameFamilyRef ref, - ) create, + RawFamilyStreamClassProvider $copyWithCreate( + RawFamilyStreamClass Function() create, ) { - return Supports$InFnNameFamilyProvider._( - argument: argument as ( - And$InT, { - And$InT named$arg, - String defaultArg, - }), - from: from! as Supports$InFnNameFamilyFamily, - create: ( - ref, - And$InT positional$arg, { - required And$InT named$arg, - String defaultArg = default$value, - }) => - create(ref)); + return RawFamilyStreamClassProvider._( + argument: argument as int, + from: from! as RawFamilyStreamClassFamily, + create: create); } + @$internal @override - String create(Supports$InFnNameFamilyRef ref) { - final _$cb = _createCb ?? supports$InFnNameFamily; - final argument = this.argument as ( - And$InT, { - And$InT named$arg, - String defaultArg, - }); - return _$cb( - ref, - argument.$1, - named$arg: argument.named$arg, - defaultArg: argument.defaultArg, - ); + RawFamilyStreamClassProvider $copyWithBuild( + Raw> Function( + Ref>>, + RawFamilyStreamClass, + ) build, + ) { + return RawFamilyStreamClassProvider._( + argument: argument as int, + from: from! as RawFamilyStreamClassFamily, + runNotifierBuildOverride: build); } + @$internal + @override + $NotifierProviderElement>> + $createElement(ProviderContainer container) => + $NotifierProviderElement(this, container); + @override bool operator ==(Object other) { - return other is Supports$InFnNameFamilyProvider && - other.runtimeType == runtimeType && - other.argument == argument; + return other is RawFamilyStreamClassProvider && other.argument == argument; } @override int get hashCode { - return Object.hash(runtimeType, argument); + return argument.hashCode; } } -String _$supports$InFnNameFamilyHash() => - r'1daa434fa2ad9ff37deade29ba3ca8155833df1b'; +String _$rawFamilyStreamClassHash() => + r'321796a0befc43fb83f7ccfdcb6b011fc8c7c599'; -final class Supports$InFnNameFamilyFamily extends Family { - const Supports$InFnNameFamilyFamily._() +final class RawFamilyStreamClassFamily extends Family { + const RawFamilyStreamClassFamily._() : super( - name: r'supports$InFnNameFamilyProvider', + name: r'rawFamilyStreamClassProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, ); - Supports$InFnNameFamilyProvider call( - And$InT positional$arg, { - required And$InT named$arg, - String defaultArg = default$value, - }) => - Supports$InFnNameFamilyProvider._(argument: ( - positional$arg, - named$arg: named$arg, - defaultArg: defaultArg, - ), from: this); + RawFamilyStreamClassProvider call( + int id, + ) => + RawFamilyStreamClassProvider._(argument: id, from: this); + + @override + String debugGetCreateSourceHash() => _$rawFamilyStreamClassHash(); + + @override + String toString() => r'rawFamilyStreamClassProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + RawFamilyStreamClass Function( + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as RawFamilyStreamClassProvider; - @override - String debugGetCreateSourceHash() => _$supports$InFnNameFamilyHash(); + final argument = provider.argument as int; - @override - String toString() => r'supports$InFnNameFamilyProvider'; + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(container); + }, + ); + } - /// {@macro riverpod.override_with} - Override overrideWith( - String Function( - Supports$InFnNameFamilyRef ref, - ( - And$InT, { - And$InT named$arg, - String defaultArg, - }) args, - ) create, + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + Raw> Function(Ref>> ref, + RawFamilyStreamClass notifier, int argument) + build, ) { return $FamilyOverride( from: this, createElement: (container, provider) { - provider as Supports$InFnNameFamilyProvider; + provider as RawFamilyStreamClassProvider; - return provider._copyWithCreate(( - ref, - And$InT positional$arg, { - required And$InT named$arg, - String defaultArg = default$value, - }) { - return create(ref, ( - positional$arg, - named$arg: named$arg, - defaultArg: defaultArg, - )); - }).$createElement(container); + final argument = provider.argument as int; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(container); }, ); } } -typedef GeneratedRef = Ref; +abstract class _$RawFamilyStreamClass extends $Notifier>> { + late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + int get id => _$args; -@ProviderFor(generated) -const generatedProvider = GeneratedProvider._(); + Raw> build( + int id, + ); + @$internal + @override + Raw> runBuild() => build( + _$args, + ); +} -final class GeneratedProvider - extends $FunctionalProvider - with $Provider { - const GeneratedProvider._( +/// This is some documentation +typedef PublicRef = Ref; + +/// This is some documentation +@ProviderFor(public) +const publicProvider = PublicProvider._(); + +/// This is some documentation +final class PublicProvider + extends $FunctionalProvider + with $Provider { + /// This is some documentation + const PublicProvider._( {String Function( - GeneratedRef ref, + PublicRef ref, )? create}) : _createCb = create, super( from: null, argument: null, - name: r'generatedProvider', + name: r'publicProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); final String Function( - GeneratedRef ref, + PublicRef ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$generatedHash(); + String debugGetCreateSourceHash() => _$publicHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(String value) { @@ -1428,60 +1357,51 @@ final class GeneratedProvider $ProviderElement(this, container); @override - GeneratedProvider $copyWithCreate( + PublicProvider $copyWithCreate( String Function( - GeneratedRef ref, + PublicRef ref, ) create, ) { - return GeneratedProvider._(create: create); + return PublicProvider._(create: create); } @override - String create(GeneratedRef ref) { - final _$cb = _createCb ?? generated; + String create(PublicRef ref) { + final _$cb = _createCb ?? public; return _$cb(ref); } } -String _$generatedHash() => r'fecbc1d5d9a05fc996b452a57fd1975ff368af91'; +String _$publicHash() => r'138be35943899793ab085e711fe3f3d22696a3ba'; -typedef UnnecessaryCastRef = Ref; +typedef Supports$inNamesRef = Ref; -@ProviderFor(unnecessaryCast) -const unnecessaryCastProvider = UnnecessaryCastFamily._(); +@ProviderFor(supports$inNames) +const supports$inNamesProvider = Supports$inNamesProvider._(); -final class UnnecessaryCastProvider - extends $FunctionalProvider - with $Provider { - const UnnecessaryCastProvider._( - {required UnnecessaryCastFamily super.from, - required Object? super.argument, - String Function( - UnnecessaryCastRef ref, - Object? arg, +final class Supports$inNamesProvider + extends $FunctionalProvider + with $Provider { + const Supports$inNamesProvider._( + {String Function( + Supports$inNamesRef ref, )? create}) : _createCb = create, super( - name: r'unnecessaryCastProvider', + from: null, + argument: null, + name: r'supports$inNamesProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); final String Function( - UnnecessaryCastRef ref, - Object? arg, + Supports$inNamesRef ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$unnecessaryCastHash(); - - @override - String toString() { - return r'unnecessaryCastProvider' - '' - '($argument)'; - } + String debugGetCreateSourceHash() => _$supports$inNamesHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(String value) { @@ -1497,618 +1417,515 @@ final class UnnecessaryCastProvider $ProviderElement(this, container); @override - UnnecessaryCastProvider $copyWithCreate( + Supports$inNamesProvider $copyWithCreate( String Function( - UnnecessaryCastRef ref, + Supports$inNamesRef ref, ) create, ) { - return UnnecessaryCastProvider._( - argument: argument, - from: from! as UnnecessaryCastFamily, - create: ( - ref, - Object? arg, - ) => - create(ref)); - } - - @override - String create(UnnecessaryCastRef ref) { - final _$cb = _createCb ?? unnecessaryCast; - final argument = this.argument; - return _$cb( - ref, - argument, - ); - } - - @override - bool operator ==(Object other) { - return other is UnnecessaryCastProvider && other.argument == argument; + return Supports$inNamesProvider._(create: create); } @override - int get hashCode { - return argument.hashCode; + String create(Supports$inNamesRef ref) { + final _$cb = _createCb ?? supports$inNames; + return _$cb(ref); } } -String _$unnecessaryCastHash() => r'282c11ef4f55267c3e6ed70af1a260cd1c2163e6'; - -final class UnnecessaryCastFamily extends Family { - const UnnecessaryCastFamily._() - : super( - name: r'unnecessaryCastProvider', - dependencies: null, - allTransitiveDependencies: null, - isAutoDispose: true, - ); - - UnnecessaryCastProvider call( - Object? arg, - ) => - UnnecessaryCastProvider._(argument: arg, from: this); - - @override - String debugGetCreateSourceHash() => _$unnecessaryCastHash(); - - @override - String toString() => r'unnecessaryCastProvider'; - - /// {@macro riverpod.override_with} - Override overrideWith( - String Function( - UnnecessaryCastRef ref, - Object? args, - ) create, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as UnnecessaryCastProvider; - - final argument = provider.argument; +String _$supports$inNamesHash() => r'cbf929802fcbd0aa949ad72743d096fb3ef5f28f'; - return provider - .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); - }, - ); - } -} +/// This is some documentation +typedef FamilyRef = Ref; -@ProviderFor(GenericClass) -const genericClassProvider = GenericClassFamily._(); +/// This is some documentation +@ProviderFor(family) +const familyProvider = FamilyFamily._(); -final class GenericClassProvider - extends $NotifierProvider, List> { - const GenericClassProvider._( - {required GenericClassFamily super.from, - super.runNotifierBuildOverride, - GenericClass Function()? create}) +/// This is some documentation +final class FamilyProvider + extends $FunctionalProvider + with $Provider { + /// This is some documentation + const FamilyProvider._( + {required FamilyFamily super.from, + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, + String Function( + FamilyRef ref, + int first, { + String? second, + required double third, + bool fourth, + List? fifth, + })? create}) : _createCb = create, super( - argument: null, - name: r'genericClassProvider', + name: r'familyProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final GenericClass Function()? _createCb; + final String Function( + FamilyRef ref, + int first, { + String? second, + required double third, + bool fourth, + List? fifth, + })? _createCb; @override - String debugGetCreateSourceHash() => _$genericClassHash(); - - GenericClassProvider _copyWithCreate( - GenericClass Function() create, - ) { - return GenericClassProvider._( - from: from! as GenericClassFamily, create: create); - } - - GenericClassProvider _copyWithBuild( - List Function( - Ref>, - GenericClass, - ) build, - ) { - return GenericClassProvider._( - from: from! as GenericClassFamily, runNotifierBuildOverride: build); - } + String debugGetCreateSourceHash() => _$familyHash(); @override String toString() { - return r'genericClassProvider' - '<${T}>' - '()'; + return r'familyProvider' + '' + '$argument'; } /// {@macro riverpod.override_with_value} - Override overrideWithValue(List value) { + Override overrideWithValue(String value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>(value), + providerOverride: $ValueProvider(value), ); } @$internal @override - GenericClass create() => _createCb?.call() ?? GenericClass(); + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - GenericClassProvider $copyWithCreate( - GenericClass Function() create, + FamilyProvider $copyWithCreate( + String Function( + FamilyRef ref, + ) create, ) { - return GenericClassProvider._( - from: from! as GenericClassFamily, create: create); + return FamilyProvider._( + argument: argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), + from: from! as FamilyFamily, + create: ( + ref, + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) => + create(ref)); } - @$internal @override - GenericClassProvider $copyWithBuild( - List Function( - Ref>, - GenericClass, - ) build, - ) { - return GenericClassProvider._( - from: from! as GenericClassFamily, runNotifierBuildOverride: build); + String create(FamilyRef ref) { + final _$cb = _createCb ?? family; + final argument = this.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + return _$cb( + ref, + argument.$1, + second: argument.second, + third: argument.third, + fourth: argument.fourth, + fifth: argument.fifth, + ); } - @$internal - @override - $NotifierProviderElement, List> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); - @override bool operator ==(Object other) { - return other is GenericClassProvider && - other.runtimeType == runtimeType && - other.argument == argument; + return other is FamilyProvider && other.argument == argument; } @override int get hashCode { - return Object.hash(runtimeType, argument); + return argument.hashCode; } } -String _$genericClassHash() => r'671e348a5abf8e00ab06c5f247defbca8af9677b'; +String _$familyHash() => r'14d1ee238ca608d547630d0e222ef4c5866e9e61'; -final class GenericClassFamily extends Family { - const GenericClassFamily._() +/// This is some documentation +final class FamilyFamily extends Family { + const FamilyFamily._() : super( - name: r'genericClassProvider', + name: r'familyProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, ); - GenericClassProvider call() => - GenericClassProvider._(from: this); + /// This is some documentation + FamilyProvider call( + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) => + FamilyProvider._(argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), from: this); @override - String debugGetCreateSourceHash() => _$genericClassHash(); + String debugGetCreateSourceHash() => _$familyHash(); @override - String toString() => r'genericClassProvider'; + String toString() => r'familyProvider'; /// {@macro riverpod.override_with} Override overrideWith( - GenericClass Function() create, + String Function( + FamilyRef ref, + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) args, + ) create, ) { return $FamilyOverride( from: this, createElement: (container, provider) { - provider as GenericClassProvider; - - return provider._copyWithCreate(create).$createElement(container); - }, - ); - } + provider as FamilyProvider; - /// {@macro riverpod.override_with_build} - Override overrideWithBuild( - List Function(Ref> ref, GenericClass notifier) - build, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as GenericClassProvider; + final argument = provider.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); - return provider._copyWithBuild(build).$createElement(container); + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); }, ); } } -abstract class _$GenericClass extends $Notifier> { - List build(); - @$internal - @override - List runBuild() => build(); -} +typedef _PrivateRef = Ref; -@ProviderFor(RawFutureClass) -const rawFutureClassProvider = RawFutureClassProvider._(); +@ProviderFor(_private) +const _privateProvider = _PrivateProvider._(); -final class RawFutureClassProvider - extends $NotifierProvider>> { - const RawFutureClassProvider._( - {super.runNotifierBuildOverride, RawFutureClass Function()? create}) +final class _PrivateProvider + extends $FunctionalProvider + with $Provider { + const _PrivateProvider._( + {String Function( + _PrivateRef ref, + )? create}) : _createCb = create, super( from: null, argument: null, - name: r'rawFutureClassProvider', + name: r'_privateProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final RawFutureClass Function()? _createCb; + final String Function( + _PrivateRef ref, + )? _createCb; @override - String debugGetCreateSourceHash() => _$rawFutureClassHash(); + String debugGetCreateSourceHash() => _$privateHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(Raw> value) { + Override overrideWithValue(String value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>>(value), + providerOverride: $ValueProvider(value), ); } @$internal @override - RawFutureClass create() => _createCb?.call() ?? RawFutureClass(); + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - RawFutureClassProvider $copyWithCreate( - RawFutureClass Function() create, + _PrivateProvider $copyWithCreate( + String Function( + _PrivateRef ref, + ) create, ) { - return RawFutureClassProvider._(create: create); + return _PrivateProvider._(create: create); } - @$internal @override - RawFutureClassProvider $copyWithBuild( - Raw> Function( - Ref>>, - RawFutureClass, - ) build, - ) { - return RawFutureClassProvider._(runNotifierBuildOverride: build); + String create(_PrivateRef ref) { + final _$cb = _createCb ?? _private; + return _$cb(ref); } - - @$internal - @override - $NotifierProviderElement>> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); } -String _$rawFutureClassHash() => r'bf66f1cdbd99118b8845d206e6a2611b3101f45c'; - -abstract class _$RawFutureClass extends $Notifier>> { - Raw> build(); - @$internal - @override - Raw> runBuild() => build(); -} +String _$privateHash() => r'519561bc7e88e394d7f75ca2102a5c0acc832c66'; -@ProviderFor(RawStreamClass) -const rawStreamClassProvider = RawStreamClassProvider._(); +/// This is some documentation +@ProviderFor(PublicClass) +const publicClassProvider = PublicClassProvider._(); -final class RawStreamClassProvider - extends $NotifierProvider>> { - const RawStreamClassProvider._( - {super.runNotifierBuildOverride, RawStreamClass Function()? create}) +/// This is some documentation +final class PublicClassProvider extends $NotifierProvider { + /// This is some documentation + const PublicClassProvider._( + {super.runNotifierBuildOverride, PublicClass Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'rawStreamClassProvider', + name: r'publicClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final RawStreamClass Function()? _createCb; + final PublicClass Function()? _createCb; @override - String debugGetCreateSourceHash() => _$rawStreamClassHash(); + String debugGetCreateSourceHash() => _$publicClassHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(Raw> value) { + Override overrideWithValue(String value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>>(value), + providerOverride: $ValueProvider(value), ); } @$internal @override - RawStreamClass create() => _createCb?.call() ?? RawStreamClass(); + PublicClass create() => _createCb?.call() ?? PublicClass(); @$internal @override - RawStreamClassProvider $copyWithCreate( - RawStreamClass Function() create, + PublicClassProvider $copyWithCreate( + PublicClass Function() create, ) { - return RawStreamClassProvider._(create: create); + return PublicClassProvider._(create: create); } @$internal @override - RawStreamClassProvider $copyWithBuild( - Raw> Function( - Ref>>, - RawStreamClass, + PublicClassProvider $copyWithBuild( + String Function( + Ref, + PublicClass, ) build, ) { - return RawStreamClassProvider._(runNotifierBuildOverride: build); + return PublicClassProvider._(runNotifierBuildOverride: build); } @$internal @override - $NotifierProviderElement>> $createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } -String _$rawStreamClassHash() => r'712cffcb2018cfb4ff45012c1aa6e43c8cbe9d5d'; +String _$publicClassHash() => r'c8e7eec9e202acf8394e02496857cbe49405bf62'; -abstract class _$RawStreamClass extends $Notifier>> { - Raw> build(); +abstract class _$PublicClass extends $Notifier { + String build(); @$internal @override - Raw> runBuild() => build(); + String runBuild() => build(); } -@ProviderFor(RawFamilyFutureClass) -const rawFamilyFutureClassProvider = RawFamilyFutureClassFamily._(); +@ProviderFor(_PrivateClass) +const _privateClassProvider = _PrivateClassProvider._(); -final class RawFamilyFutureClassProvider - extends $NotifierProvider>> { - const RawFamilyFutureClassProvider._( - {required RawFamilyFutureClassFamily super.from, - required int super.argument, - super.runNotifierBuildOverride, - RawFamilyFutureClass Function()? create}) +final class _PrivateClassProvider + extends $NotifierProvider<_PrivateClass, String> { + const _PrivateClassProvider._( + {super.runNotifierBuildOverride, _PrivateClass Function()? create}) : _createCb = create, super( - name: r'rawFamilyFutureClassProvider', + from: null, + argument: null, + name: r'_privateClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final RawFamilyFutureClass Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$rawFamilyFutureClassHash(); + final _PrivateClass Function()? _createCb; @override - String toString() { - return r'rawFamilyFutureClassProvider' - '' - '($argument)'; - } + String debugGetCreateSourceHash() => _$privateClassHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(Raw> value) { + Override overrideWithValue(String value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>>(value), + providerOverride: $ValueProvider(value), ); } @$internal @override - RawFamilyFutureClass create() => _createCb?.call() ?? RawFamilyFutureClass(); + _PrivateClass create() => _createCb?.call() ?? _PrivateClass(); @$internal @override - RawFamilyFutureClassProvider $copyWithCreate( - RawFamilyFutureClass Function() create, + _PrivateClassProvider $copyWithCreate( + _PrivateClass Function() create, ) { - return RawFamilyFutureClassProvider._( - argument: argument as int, - from: from! as RawFamilyFutureClassFamily, - create: create); + return _PrivateClassProvider._(create: create); } @$internal @override - RawFamilyFutureClassProvider $copyWithBuild( - Raw> Function( - Ref>>, - RawFamilyFutureClass, + _PrivateClassProvider $copyWithBuild( + String Function( + Ref, + _PrivateClass, ) build, ) { - return RawFamilyFutureClassProvider._( - argument: argument as int, - from: from! as RawFamilyFutureClassFamily, - runNotifierBuildOverride: build); + return _PrivateClassProvider._(runNotifierBuildOverride: build); } @$internal @override - $NotifierProviderElement>> - $createElement(ProviderContainer container) => - $NotifierProviderElement(this, container); - - @override - bool operator ==(Object other) { - return other is RawFamilyFutureClassProvider && other.argument == argument; - } - - @override - int get hashCode { - return argument.hashCode; - } -} - -String _$rawFamilyFutureClassHash() => - r'd7cacb0f2c51697d107de6daa68b242c04085dca'; - -final class RawFamilyFutureClassFamily extends Family { - const RawFamilyFutureClassFamily._() - : super( - name: r'rawFamilyFutureClassProvider', - dependencies: null, - allTransitiveDependencies: null, - isAutoDispose: true, - ); - - RawFamilyFutureClassProvider call( - int id, - ) => - RawFamilyFutureClassProvider._(argument: id, from: this); - - @override - String debugGetCreateSourceHash() => _$rawFamilyFutureClassHash(); - - @override - String toString() => r'rawFamilyFutureClassProvider'; - - /// {@macro riverpod.override_with} - Override overrideWith( - RawFamilyFutureClass Function( - int args, - ) create, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as RawFamilyFutureClassProvider; - - final argument = provider.argument as int; - - return provider - .$copyWithCreate(() => create(argument)) - .$createElement(container); - }, - ); - } - - /// {@macro riverpod.override_with_build} - Override overrideWithBuild( - Raw> Function(Ref>> ref, - RawFamilyFutureClass notifier, int argument) - build, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as RawFamilyFutureClassProvider; - - final argument = provider.argument as int; - - return provider - .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); - }, - ); - } + $NotifierProviderElement<_PrivateClass, String> $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -abstract class _$RawFamilyFutureClass extends $Notifier>> { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; - int get id => _$args; +String _$privateClassHash() => r'6d41def3ffdc1f79e593beaefb3304ce4b211a77'; - Raw> build( - int id, - ); +abstract class _$PrivateClass extends $Notifier { + String build(); @$internal @override - Raw> runBuild() => build( - _$args, - ); + String runBuild() => build(); } -@ProviderFor(RawFamilyStreamClass) -const rawFamilyStreamClassProvider = RawFamilyStreamClassFamily._(); +/// This is some documentation +@ProviderFor(FamilyClass) +const familyClassProvider = FamilyClassFamily._(); -final class RawFamilyStreamClassProvider - extends $NotifierProvider>> { - const RawFamilyStreamClassProvider._( - {required RawFamilyStreamClassFamily super.from, - required int super.argument, +/// This is some documentation +final class FamilyClassProvider extends $NotifierProvider { + /// This is some documentation + const FamilyClassProvider._( + {required FamilyClassFamily super.from, + required ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) + super.argument, super.runNotifierBuildOverride, - RawFamilyStreamClass Function()? create}) + FamilyClass Function()? create}) : _createCb = create, super( - name: r'rawFamilyStreamClassProvider', + name: r'familyClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final RawFamilyStreamClass Function()? _createCb; + final FamilyClass Function()? _createCb; @override - String debugGetCreateSourceHash() => _$rawFamilyStreamClassHash(); + String debugGetCreateSourceHash() => _$familyClassHash(); @override String toString() { - return r'rawFamilyStreamClassProvider' + return r'familyClassProvider' '' - '($argument)'; + '$argument'; } /// {@macro riverpod.override_with_value} - Override overrideWithValue(Raw> value) { + Override overrideWithValue(String value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>>(value), + providerOverride: $ValueProvider(value), ); } @$internal @override - RawFamilyStreamClass create() => _createCb?.call() ?? RawFamilyStreamClass(); + FamilyClass create() => _createCb?.call() ?? FamilyClass(); @$internal @override - RawFamilyStreamClassProvider $copyWithCreate( - RawFamilyStreamClass Function() create, + FamilyClassProvider $copyWithCreate( + FamilyClass Function() create, ) { - return RawFamilyStreamClassProvider._( - argument: argument as int, - from: from! as RawFamilyStreamClassFamily, + return FamilyClassProvider._( + argument: argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), + from: from! as FamilyClassFamily, create: create); } @$internal @override - RawFamilyStreamClassProvider $copyWithBuild( - Raw> Function( - Ref>>, - RawFamilyStreamClass, + FamilyClassProvider $copyWithBuild( + String Function( + Ref, + FamilyClass, ) build, ) { - return RawFamilyStreamClassProvider._( - argument: argument as int, - from: from! as RawFamilyStreamClassFamily, + return FamilyClassProvider._( + argument: argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }), + from: from! as FamilyClassFamily, runNotifierBuildOverride: build); } @$internal @override - $NotifierProviderElement>> - $createElement(ProviderContainer container) => - $NotifierProviderElement(this, container); + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); @override bool operator ==(Object other) { - return other is RawFamilyStreamClassProvider && other.argument == argument; + return other is FamilyClassProvider && other.argument == argument; } @override @@ -2117,41 +1934,64 @@ final class RawFamilyStreamClassProvider } } -String _$rawFamilyStreamClassHash() => - r'321796a0befc43fb83f7ccfdcb6b011fc8c7c599'; +String _$familyClassHash() => r'01e3b9cb4d6d0bf12a2284761b1a11819d97d249'; -final class RawFamilyStreamClassFamily extends Family { - const RawFamilyStreamClassFamily._() +/// This is some documentation +final class FamilyClassFamily extends Family { + const FamilyClassFamily._() : super( - name: r'rawFamilyStreamClassProvider', + name: r'familyClassProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, ); - RawFamilyStreamClassProvider call( - int id, - ) => - RawFamilyStreamClassProvider._(argument: id, from: this); + /// This is some documentation + FamilyClassProvider call( + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }) => + FamilyClassProvider._(argument: ( + first, + second: second, + third: third, + fourth: fourth, + fifth: fifth, + ), from: this); @override - String debugGetCreateSourceHash() => _$rawFamilyStreamClassHash(); + String debugGetCreateSourceHash() => _$familyClassHash(); @override - String toString() => r'rawFamilyStreamClassProvider'; + String toString() => r'familyClassProvider'; /// {@macro riverpod.override_with} Override overrideWith( - RawFamilyStreamClass Function( - int args, + FamilyClass Function( + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) args, ) create, ) { return $FamilyOverride( from: this, createElement: (container, provider) { - provider as RawFamilyStreamClassProvider; + provider as FamilyClassProvider; - final argument = provider.argument as int; + final argument = provider.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); return provider .$copyWithCreate(() => create(argument)) @@ -2162,16 +2002,30 @@ final class RawFamilyStreamClassFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - Raw> Function(Ref>> ref, - RawFamilyStreamClass notifier, int argument) + String Function( + Ref ref, + FamilyClass notifier, + ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }) argument) build, ) { return $FamilyOverride( from: this, createElement: (container, provider) { - provider as RawFamilyStreamClassProvider; + provider as FamilyClassProvider; - final argument = provider.argument as int; + final argument = provider.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) @@ -2181,43 +2035,82 @@ final class RawFamilyStreamClassFamily extends Family { } } -abstract class _$RawFamilyStreamClass extends $Notifier>> { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; - int get id => _$args; +abstract class _$FamilyClass extends $Notifier { + late final _$args = (ref as $NotifierProviderElement).origin.argument as ( + int, { + String? second, + double third, + bool fourth, + List? fifth, + }); + int get first => _$args.$1; + String? get second => _$args.second; + double get third => _$args.third; + bool get fourth => _$args.fourth; + List? get fifth => _$args.fifth; - Raw> build( - int id, - ); + String build( + int first, { + String? second, + required double third, + bool fourth = true, + List? fifth, + }); @$internal @override - Raw> runBuild() => build( - _$args, + String runBuild() => build( + _$args.$1, + second: _$args.second, + third: _$args.third, + fourth: _$args.fourth, + fifth: _$args.fifth, ); } -/// This is some documentation -@ProviderFor(PublicClass) -const publicClassProvider = PublicClassProvider._(); +typedef Supports$InFnNameRef = Ref; -/// This is some documentation -final class PublicClassProvider extends $NotifierProvider { - /// This is some documentation - const PublicClassProvider._( - {super.runNotifierBuildOverride, PublicClass Function()? create}) +@ProviderFor(supports$InFnName) +const supports$InFnNameProvider = Supports$InFnNameFamily._(); + +final class Supports$InFnNameProvider + extends $FunctionalProvider> + with $Provider> { + const Supports$InFnNameProvider._( + {required Supports$InFnNameFamily super.from, + String Function( + Supports$InFnNameRef ref, + )? create}) : _createCb = create, super( - from: null, argument: null, - name: r'publicClassProvider', + name: r'supports$InFnNameProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final PublicClass Function()? _createCb; + final String Function( + Supports$InFnNameRef ref, + )? _createCb; @override - String debugGetCreateSourceHash() => _$publicClassHash(); + String debugGetCreateSourceHash() => _$supports$InFnNameHash(); + + Supports$InFnNameProvider _copyWithCreate( + String Function( + Supports$InFnNameRef ref, + ) create, + ) { + return Supports$InFnNameProvider._( + from: from! as Supports$InFnNameFamily, create: create); + } + + @override + String toString() { + return r'supports$InFnNameProvider' + '<${And$InT}>' + '()'; + } /// {@macro riverpod.override_with_value} Override overrideWithValue(String value) { @@ -2229,148 +2122,136 @@ final class PublicClassProvider extends $NotifierProvider { @$internal @override - PublicClass create() => _createCb?.call() ?? PublicClass(); + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - PublicClassProvider $copyWithCreate( - PublicClass Function() create, + Supports$InFnNameProvider $copyWithCreate( + String Function( + Supports$InFnNameRef ref, + ) create, ) { - return PublicClassProvider._(create: create); + return Supports$InFnNameProvider._( + from: from! as Supports$InFnNameFamily, create: create); } - @$internal @override - PublicClassProvider $copyWithBuild( - String Function( - Ref, - PublicClass, - ) build, - ) { - return PublicClassProvider._(runNotifierBuildOverride: build); + String create(Supports$InFnNameRef ref) { + final _$cb = _createCb ?? supports$InFnName; + return _$cb(ref); } - @$internal @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); -} - -String _$publicClassHash() => r'c8e7eec9e202acf8394e02496857cbe49405bf62'; + bool operator ==(Object other) { + return other is Supports$InFnNameProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } -abstract class _$PublicClass extends $Notifier { - String build(); - @$internal @override - String runBuild() => build(); + int get hashCode { + return Object.hash(runtimeType, argument); + } } -@ProviderFor(_PrivateClass) -const _privateClassProvider = _PrivateClassProvider._(); +String _$supports$InFnNameHash() => r'fec3daca655669a46760cc54921f098b9cbaac3d'; -final class _PrivateClassProvider - extends $NotifierProvider<_PrivateClass, String> { - const _PrivateClassProvider._( - {super.runNotifierBuildOverride, _PrivateClass Function()? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'_privateClassProvider', - isAutoDispose: true, +final class Supports$InFnNameFamily extends Family { + const Supports$InFnNameFamily._() + : super( + name: r'supports$InFnNameProvider', dependencies: null, allTransitiveDependencies: null, - ); - - final _PrivateClass Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$privateClassHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(String value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - _PrivateClass create() => _createCb?.call() ?? _PrivateClass(); - - @$internal - @override - _PrivateClassProvider $copyWithCreate( - _PrivateClass Function() create, - ) { - return _PrivateClassProvider._(create: create); - } + isAutoDispose: true, + ); + + Supports$InFnNameProvider call() => + Supports$InFnNameProvider._(from: this); - @$internal @override - _PrivateClassProvider $copyWithBuild( - String Function( - Ref, - _PrivateClass, - ) build, - ) { - return _PrivateClassProvider._(runNotifierBuildOverride: build); - } + String debugGetCreateSourceHash() => _$supports$InFnNameHash(); - @$internal @override - $NotifierProviderElement<_PrivateClass, String> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); -} + String toString() => r'supports$InFnNameProvider'; -String _$privateClassHash() => r'6d41def3ffdc1f79e593beaefb3304ce4b211a77'; + /// {@macro riverpod.override_with} + Override overrideWith( + String Function(Supports$InFnNameRef ref) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as Supports$InFnNameProvider; -abstract class _$PrivateClass extends $Notifier { - String build(); - @$internal - @override - String runBuild() => build(); + return provider._copyWithCreate(create).$createElement(container); + }, + ); + } } -/// This is some documentation -@ProviderFor(FamilyClass) -const familyClassProvider = FamilyClassFamily._(); +typedef Supports$InFnNameFamilyRef = Ref; -/// This is some documentation -final class FamilyClassProvider extends $NotifierProvider { - /// This is some documentation - const FamilyClassProvider._( - {required FamilyClassFamily super.from, +@ProviderFor(supports$InFnNameFamily) +const supports$InFnNameFamilyProvider = Supports$InFnNameFamilyFamily._(); + +final class Supports$InFnNameFamilyProvider + extends $FunctionalProvider> + with $Provider> { + const Supports$InFnNameFamilyProvider._( + {required Supports$InFnNameFamilyFamily super.from, required ( - int, { - String? second, - double third, - bool fourth, - List? fifth, + And$InT, { + And$InT named$arg, + String defaultArg, }) super.argument, - super.runNotifierBuildOverride, - FamilyClass Function()? create}) + String Function( + Supports$InFnNameFamilyRef ref, + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg, + })? create}) : _createCb = create, super( - name: r'familyClassProvider', + name: r'supports$InFnNameFamilyProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final FamilyClass Function()? _createCb; + final String Function( + Supports$InFnNameFamilyRef ref, + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg, + })? _createCb; @override - String debugGetCreateSourceHash() => _$familyClassHash(); + String debugGetCreateSourceHash() => _$supports$InFnNameFamilyHash(); + + Supports$InFnNameFamilyProvider _copyWithCreate( + String Function( + Supports$InFnNameFamilyRef ref, + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg, + }) create, + ) { + return Supports$InFnNameFamilyProvider._( + argument: argument as ( + And$InT, { + And$InT named$arg, + String defaultArg, + }), + from: from! as Supports$InFnNameFamilyFamily, + create: create); + } @override String toString() { - return r'familyClassProvider' - '' + return r'supports$InFnNameFamilyProvider' + '<${And$InT}>' '$argument'; } @@ -2384,195 +2265,122 @@ final class FamilyClassProvider extends $NotifierProvider { @$internal @override - FamilyClass create() => _createCb?.call() ?? FamilyClass(); - - @$internal - @override - FamilyClassProvider $copyWithCreate( - FamilyClass Function() create, - ) { - return FamilyClassProvider._( - argument: argument as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }), - from: from! as FamilyClassFamily, - create: create); - } + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - FamilyClassProvider $copyWithBuild( + Supports$InFnNameFamilyProvider $copyWithCreate( String Function( - Ref, - FamilyClass, - ) build, + Supports$InFnNameFamilyRef ref, + ) create, ) { - return FamilyClassProvider._( + return Supports$InFnNameFamilyProvider._( argument: argument as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, + And$InT, { + And$InT named$arg, + String defaultArg, }), - from: from! as FamilyClassFamily, - runNotifierBuildOverride: build); + from: from! as Supports$InFnNameFamilyFamily, + create: ( + ref, + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg = default$value, + }) => + create(ref)); } - @$internal @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + String create(Supports$InFnNameFamilyRef ref) { + final _$cb = _createCb ?? supports$InFnNameFamily; + final argument = this.argument as ( + And$InT, { + And$InT named$arg, + String defaultArg, + }); + return _$cb( + ref, + argument.$1, + named$arg: argument.named$arg, + defaultArg: argument.defaultArg, + ); + } @override bool operator ==(Object other) { - return other is FamilyClassProvider && other.argument == argument; + return other is Supports$InFnNameFamilyProvider && + other.runtimeType == runtimeType && + other.argument == argument; } @override int get hashCode { - return argument.hashCode; + return Object.hash(runtimeType, argument); } } -String _$familyClassHash() => r'01e3b9cb4d6d0bf12a2284761b1a11819d97d249'; +String _$supports$InFnNameFamilyHash() => + r'1daa434fa2ad9ff37deade29ba3ca8155833df1b'; -/// This is some documentation -final class FamilyClassFamily extends Family { - const FamilyClassFamily._() +final class Supports$InFnNameFamilyFamily extends Family { + const Supports$InFnNameFamilyFamily._() : super( - name: r'familyClassProvider', + name: r'supports$InFnNameFamilyProvider', dependencies: null, allTransitiveDependencies: null, isAutoDispose: true, ); - /// This is some documentation - FamilyClassProvider call( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, + Supports$InFnNameFamilyProvider call( + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg = default$value, }) => - FamilyClassProvider._(argument: ( - first, - second: second, - third: third, - fourth: fourth, - fifth: fifth, + Supports$InFnNameFamilyProvider._(argument: ( + positional$arg, + named$arg: named$arg, + defaultArg: defaultArg, ), from: this); @override - String debugGetCreateSourceHash() => _$familyClassHash(); + String debugGetCreateSourceHash() => _$supports$InFnNameFamilyHash(); @override - String toString() => r'familyClassProvider'; + String toString() => r'supports$InFnNameFamilyProvider'; /// {@macro riverpod.override_with} Override overrideWith( - FamilyClass Function( - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) args, - ) create, - ) { - return $FamilyOverride( - from: this, - createElement: (container, provider) { - provider as FamilyClassProvider; - - final argument = provider.argument as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }); - - return provider - .$copyWithCreate(() => create(argument)) - .$createElement(container); - }, - ); - } - - /// {@macro riverpod.override_with_build} - Override overrideWithBuild( - String Function( - Ref ref, - FamilyClass notifier, - ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }) argument) - build, + String Function( + Supports$InFnNameFamilyRef ref, + ( + And$InT, { + And$InT named$arg, + String defaultArg, + }) args, + ) create, ) { return $FamilyOverride( from: this, createElement: (container, provider) { - provider as FamilyClassProvider; - - final argument = provider.argument as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }); + provider as Supports$InFnNameFamilyProvider; - return provider - .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + return provider._copyWithCreate(( + ref, + And$InT positional$arg, { + required And$InT named$arg, + String defaultArg = default$value, + }) { + return create(ref, ( + positional$arg, + named$arg: named$arg, + defaultArg: defaultArg, + )); + }).$createElement(container); }, ); } } -abstract class _$FamilyClass extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as ( - int, { - String? second, - double third, - bool fourth, - List? fifth, - }); - int get first => _$args.$1; - String? get second => _$args.second; - double get third => _$args.third; - bool get fourth => _$args.fourth; - List? get fifth => _$args.fifth; - - String build( - int first, { - String? second, - required double third, - bool fourth = true, - List? fifth, - }); - @$internal - @override - String runBuild() => build( - _$args.$1, - second: _$args.second, - third: _$args.third, - fourth: _$args.fourth, - fifth: _$args.fifth, - ); -} - @ProviderFor(Supports$InClassName) const supports$InClassNameProvider = Supports$InClassNameFamily._(); @@ -2975,6 +2783,198 @@ abstract class _$Supports$InClassFamilyName extends $Notifier { ); } +typedef GeneratedRef = Ref; + +@ProviderFor(generated) +const generatedProvider = GeneratedProvider._(); + +final class GeneratedProvider + extends $FunctionalProvider + with $Provider { + const GeneratedProvider._( + {String Function( + GeneratedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'generatedProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + GeneratedRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$generatedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + GeneratedProvider $copyWithCreate( + String Function( + GeneratedRef ref, + ) create, + ) { + return GeneratedProvider._(create: create); + } + + @override + String create(GeneratedRef ref) { + final _$cb = _createCb ?? generated; + return _$cb(ref); + } +} + +String _$generatedHash() => r'fecbc1d5d9a05fc996b452a57fd1975ff368af91'; + +typedef UnnecessaryCastRef = Ref; + +@ProviderFor(unnecessaryCast) +const unnecessaryCastProvider = UnnecessaryCastFamily._(); + +final class UnnecessaryCastProvider + extends $FunctionalProvider + with $Provider { + const UnnecessaryCastProvider._( + {required UnnecessaryCastFamily super.from, + required Object? super.argument, + String Function( + UnnecessaryCastRef ref, + Object? arg, + )? create}) + : _createCb = create, + super( + name: r'unnecessaryCastProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + UnnecessaryCastRef ref, + Object? arg, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$unnecessaryCastHash(); + + @override + String toString() { + return r'unnecessaryCastProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + UnnecessaryCastProvider $copyWithCreate( + String Function( + UnnecessaryCastRef ref, + ) create, + ) { + return UnnecessaryCastProvider._( + argument: argument, + from: from! as UnnecessaryCastFamily, + create: ( + ref, + Object? arg, + ) => + create(ref)); + } + + @override + String create(UnnecessaryCastRef ref) { + final _$cb = _createCb ?? unnecessaryCast; + final argument = this.argument; + return _$cb( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is UnnecessaryCastProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$unnecessaryCastHash() => r'282c11ef4f55267c3e6ed70af1a260cd1c2163e6'; + +final class UnnecessaryCastFamily extends Family { + const UnnecessaryCastFamily._() + : super( + name: r'unnecessaryCastProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + UnnecessaryCastProvider call( + Object? arg, + ) => + UnnecessaryCastProvider._(argument: arg, from: this); + + @override + String debugGetCreateSourceHash() => _$unnecessaryCastHash(); + + @override + String toString() => r'unnecessaryCastProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + String Function( + UnnecessaryCastRef ref, + Object? args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as UnnecessaryCastProvider; + + final argument = provider.argument; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + @ProviderFor(UnnecessaryCastClass) const unnecessaryCastClassProvider = UnnecessaryCastClassFamily._(); @@ -3137,6 +3137,5 @@ abstract class _$UnnecessaryCastClass extends $Notifier { ); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index fb40a7ab6..9cbdad4bf 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -840,6 +840,5 @@ abstract class _$Supports$InClassName extends $Notifier { String runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index 4264392b6..13658d93b 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -1,3 +1,26 @@ +## Unreleased build + +- Updated `provider_dependencies` to support `@Dependencies` +- added `riverpod_syntax_error`, for reporting errors when the generator would throw. +- added `avoid_keep_alive_dependency_inside_auto_dispose` +- added `unknown_scoped_usage`, for reporting when a scoped provider is used but the ref could not be found.**** +- added automatic migration to import `package:riverpod/legacy.dart` for corresponding providers. + +- **Breaking**: No-longer exports various providers + from `package:riverpod`. + +Various lints had their severity changed: + +- `avoid_build_context_in_providers` is now an INFO +- `avoid_ref_inside_state_dispose` is now a WARNING +- `functional_ref` is now a WARNING +- `notifier_build` is now an error. +- `missing_provider_scope` is now a WARNING +- `provider_dependencies` is now a WARNING +- `scoped_providers_should_specify_dependencies` is now a WARNING +- `notifier_extends` is now a WARNING +- `provider_parameters` is now a WARNING + ## 3.0.0-dev.4 - 2023-11-27 - `riverpod` upgraded to `3.0.0-dev.3` @@ -26,7 +49,7 @@ - Fix `async_value_nullable_pattern` false positive when used with generics that have non-nullable type constrains. -- Add migration widget field when convert Stateless-based and +- Add migration widget field when convert Stateless-based and Stateful-based to each other (thanks to @Kurogoma4D) ## 2.3.7 - 2023-11-27 diff --git a/packages/riverpod_lint/README.md b/packages/riverpod_lint/README.md index 59e17a620..8dc42fc2d 100644 --- a/packages/riverpod_lint/README.md +++ b/packages/riverpod_lint/README.md @@ -232,6 +232,28 @@ void example(ExampleRef ref) { // scopedProvider is scoped and as such specifying "dependencies" is required. ref.watch(scopedProvider); } + +// For non-provider objects that use scoped providers, we can use `@Dependencies` +// for similar purposes. +@Dependencies([scoped]) +class BookView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + final selectedBookID = ref.watch(scopedProvider); + return Text(selectedBookID.toString()); + } +} + +// Alternatively, widgets specifically can opt to override scoped providers +// using `ProviderScope`: +ProviderScope( + overrides: [ + scopedProvider.overrideWithValue(42), + ], + // Even though BookView uses "scopedProvider", the linter won't complain + // as we override the provider. + child: BookView(), +) ``` **Bad**: @@ -252,6 +274,15 @@ void example(ExampleRef ref) { // rootProvider is not a scoped provider. As such it shouldn't be listed in "dependencies" ref.watch(rootProvider); } + +class BookView extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + // If a function/class uses a scoped provider, they must specify `@Dependencies` + final selectedBookID = ref.watch(scopedProvider); + return Text(selectedBookID.toString()); + } +} ``` ### scoped_providers_should_specify_dependencies (generator only) diff --git a/packages/riverpod_lint/lib/riverpod_lint.dart b/packages/riverpod_lint/lib/riverpod_lint.dart index fa2753f74..80b4b0140 100644 --- a/packages/riverpod_lint/lib/riverpod_lint.dart +++ b/packages/riverpod_lint/lib/riverpod_lint.dart @@ -22,6 +22,7 @@ import 'src/lints/provider_dependencies.dart'; import 'src/lints/provider_parameters.dart'; import 'src/lints/riverpod_syntax_error.dart'; import 'src/lints/scoped_providers_should_specify_dependencies.dart'; +import 'src/lints/unknown_scoped_usage.dart'; import 'src/lints/unsupported_provider_value.dart'; import 'src/migration/missing_legacy_import.dart'; @@ -43,9 +44,9 @@ class _RiverpodPlugin extends PluginBase { const ProtectedNotifierProperties(), const ProviderDependencies(), const ProviderParameters(), - // TODO changelog added riverpod_syntax_error, for reporting errors when the generator would throw. const RiverpodSyntaxError(), const ScopedProvidersShouldSpecifyDependencies(), + const UnknownScopedUsage(), const UnsupportedProviderValue(), // Migrations diff --git a/packages/riverpod_lint/lib/src/lints/avoid_build_context_in_providers.dart b/packages/riverpod_lint/lib/src/lints/avoid_build_context_in_providers.dart index 9734e72cb..83f00135e 100644 --- a/packages/riverpod_lint/lib/src/lints/avoid_build_context_in_providers.dart +++ b/packages/riverpod_lint/lib/src/lints/avoid_build_context_in_providers.dart @@ -16,7 +16,6 @@ class AvoidBuildContextInProviders extends RiverpodLintRule { name: 'avoid_build_context_in_providers', problemMessage: 'Passing BuildContext to providers indicates mixing UI with the business logic.', - // TODO changelog: avoid_build_context_in_providers is now an INFO ); @override diff --git a/packages/riverpod_lint/lib/src/lints/avoid_manual_providers_as_generated_provider_dependency.dart b/packages/riverpod_lint/lib/src/lints/avoid_manual_providers_as_generated_provider_dependency.dart index 7140c1344..2d6132be3 100644 --- a/packages/riverpod_lint/lib/src/lints/avoid_manual_providers_as_generated_provider_dependency.dart +++ b/packages/riverpod_lint/lib/src/lints/avoid_manual_providers_as_generated_provider_dependency.dart @@ -1,3 +1,4 @@ +import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; @@ -22,24 +23,19 @@ class AvoidManualProvidersAsGeneratedProviderDependency ErrorReporter reporter, CustomLintContext context, ) { - void checkDependency( - GeneratorProviderDeclaration provider, - RefDependencyInvocation dependency, - ) { - final dependencyElement = dependency.provider.providerElement; - if (dependencyElement is! GeneratorProviderDeclarationElement) { - reporter.reportErrorForNode( - code, - dependency.provider.provider ?? dependency.provider.node, - ); + riverpodRegistry(context).addProviderIdentifier((dependency) { + // The dependency is a generated provider, no need to check + if (dependency.providerElement is GeneratorProviderDeclarationElement) { + return; } - } + // We're depending on a non-generated provider. Let's check if the + // associated provider is a generated provider + final enclosingProvider = dependency.node + .thisOrAncestorOfType() + ?.provider; - riverpodRegistry(context).addGeneratorProviderDeclaration((declaration) { - for (final invocation in declaration.refInvocations) { - if (invocation is RefDependencyInvocation) { - checkDependency(declaration, invocation); - } + if (enclosingProvider != null) { + reporter.reportErrorForNode(code, dependency.node); } }); } diff --git a/packages/riverpod_lint/lib/src/lints/avoid_read_auto_dispose.dart b/packages/riverpod_lint/lib/src/lints/avoid_read_auto_dispose.dart deleted file mode 100644 index c2d9d6259..000000000 --- a/packages/riverpod_lint/lib/src/lints/avoid_read_auto_dispose.dart +++ /dev/null @@ -1,40 +0,0 @@ -import 'package:analyzer/error/listener.dart'; -import 'package:custom_lint_builder/custom_lint_builder.dart'; -import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; - -import '../riverpod_custom_lint.dart'; - -class AvoidReadAutoDispose extends RiverpodLintRule { - const AvoidReadAutoDispose() : super(code: _code); - - static const _code = LintCode( - name: 'riverpod_avoid_read_auto_dispose', - problemMessage: 'Avoid using ref.read on an autoDispose provider', - correctionMessage: ''' -Instead use: - final listener = ref.listen({0}, (_, __){}); - final currentValue = listener.read(); -Then dispose of the listener when you no longer need the autoDispose provider to be kept alive.''', - ); - - @override - void run( - CustomLintResolver resolver, - ErrorReporter reporter, - CustomLintContext context, - ) { - // TODO release or delete - riverpodRegistry(context).addRefReadInvocation((read) { - final provider = read.provider.providerElement; - - if (provider is GeneratorProviderDeclarationElement && - provider.isAutoDispose) { - reporter.reportErrorForNode( - _code, - read.node, - [read.provider.provider!], - ); - } - }); - } -} diff --git a/packages/riverpod_lint/lib/src/lints/avoid_ref_inside_state_dispose.dart b/packages/riverpod_lint/lib/src/lints/avoid_ref_inside_state_dispose.dart index 6f0a3c1dc..4e2cd4168 100644 --- a/packages/riverpod_lint/lib/src/lints/avoid_ref_inside_state_dispose.dart +++ b/packages/riverpod_lint/lib/src/lints/avoid_ref_inside_state_dispose.dart @@ -14,7 +14,6 @@ class AvoidRefInsideStateDispose extends RiverpodLintRule { static const _code = LintCode( name: 'avoid_ref_inside_state_dispose', problemMessage: "Avoid using 'Ref' inside State.dispose.", - // TODO changelog: avoid_ref_inside_state_dispose is now a WARNING errorSeverity: ErrorSeverity.WARNING, ); diff --git a/packages/riverpod_lint/lib/src/lints/functional_ref.dart b/packages/riverpod_lint/lib/src/lints/functional_ref.dart index 1ab716fb6..56d981c91 100644 --- a/packages/riverpod_lint/lib/src/lints/functional_ref.dart +++ b/packages/riverpod_lint/lib/src/lints/functional_ref.dart @@ -14,7 +14,6 @@ class FunctionalRef extends RiverpodLintRule { name: 'functional_ref', problemMessage: 'Functional providers must receive a ref matching the provider name as their first positional parameter.', - // TODO changelog: functional_ref is now a WARNING errorSeverity: ErrorSeverity.WARNING, ); @@ -25,9 +24,6 @@ class FunctionalRef extends RiverpodLintRule { CustomLintContext context, ) { riverpodRegistry(context).addFunctionalProviderDeclaration((declaration) { - // Scoped providers don't need a ref - if (declaration.needsOverride) return; - final parameters = declaration.node.functionExpression.parameters!; final refNode = parameters.parameters.firstOrNull; diff --git a/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart b/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart index 5a30b0d78..974aefa43 100644 --- a/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart +++ b/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart @@ -15,7 +15,6 @@ class MissingProviderScope extends DartLintRule { name: 'missing_provider_scope', problemMessage: 'Flutter applications should have a ProviderScope widget ' 'at the top of the widget tree.', - // TODO changelog: missing_provider_scope is now a WARNING errorSeverity: ErrorSeverity.WARNING, ); diff --git a/packages/riverpod_lint/lib/src/lints/notifier_build.dart b/packages/riverpod_lint/lib/src/lints/notifier_build.dart index 809d772c1..c8842bf31 100644 --- a/packages/riverpod_lint/lib/src/lints/notifier_build.dart +++ b/packages/riverpod_lint/lib/src/lints/notifier_build.dart @@ -15,7 +15,6 @@ class NotifierBuild extends RiverpodLintRule { name: 'notifier_build', problemMessage: 'Classes annotated by `@riverpod` must have the `build` method', - // TODO changelog `notifier_build` is now an error. errorSeverity: ErrorSeverity.ERROR, ); diff --git a/packages/riverpod_lint/lib/src/lints/notifier_extends.dart b/packages/riverpod_lint/lib/src/lints/notifier_extends.dart index a99e0da6b..60a39540e 100644 --- a/packages/riverpod_lint/lib/src/lints/notifier_extends.dart +++ b/packages/riverpod_lint/lib/src/lints/notifier_extends.dart @@ -53,7 +53,6 @@ class NotifierExtends extends RiverpodLintRule { static const _code = LintCode( name: 'notifier_extends', problemMessage: r'Classes annotated by @riverpod must extend _$ClassName', - // TODO changelog: notifier_extends is now a WARNING. errorSeverity: ErrorSeverity.WARNING, ); diff --git a/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart b/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart index ae0565027..cff96ffce 100644 --- a/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart +++ b/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart @@ -1,3 +1,4 @@ +import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/error/error.dart'; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; @@ -8,7 +9,6 @@ import '../riverpod_custom_lint.dart'; class OnlyUseKeepAliveInsideKeepAlive extends RiverpodLintRule { const OnlyUseKeepAliveInsideKeepAlive() : super(code: _code); - // TODO changelog added avoid_keep_alive_dependency_inside_auto_dispose static const _code = LintCode( name: 'only_use_keep_alive_inside_keep_alive', problemMessage: 'If a provider is declared as `keepAlive`, ' @@ -24,21 +24,22 @@ class OnlyUseKeepAliveInsideKeepAlive extends RiverpodLintRule { ErrorReporter reporter, CustomLintContext context, ) { - riverpodRegistry(context).addGeneratorProviderDeclaration((node) { - // The current provider is "autoDispose", so it is allowed to use other "autoDispose" providers - if (node.providerElement.isAutoDispose) return; + riverpodRegistry(context).addRefInvocation((node) { + if (node is! RefDependencyInvocation) return; + final dependencyElement = node.listenable.provider?.providerElement; + // This only applies if the watched provider is a generated one. + if (dependencyElement is! GeneratorProviderDeclarationElement) return; + if (!dependencyElement.isAutoDispose) return; - for (final refInvocation in node.refInvocations) { - switch (refInvocation) { - case RefDependencyInvocation( - provider: ProviderListenableExpression( - :final GeneratorProviderDeclarationElement providerElement, - ) - ) - when providerElement.isAutoDispose: - reporter.reportErrorForNode(_code, refInvocation.node); - } - } + final provider = node.node + .thisOrAncestorOfType() + ?.provider; + if (provider == null) return; + + // The enclosing provider is "autoDispose", so it is allowed to use other "autoDispose" providers + if (provider.providerElement.isAutoDispose) return; + + reporter.reportErrorForNode(_code, node.node); }); } } diff --git a/packages/riverpod_lint/lib/src/lints/protected_notifier_properties.dart b/packages/riverpod_lint/lib/src/lints/protected_notifier_properties.dart index 31f5068f6..968d4bf23 100644 --- a/packages/riverpod_lint/lib/src/lints/protected_notifier_properties.dart +++ b/packages/riverpod_lint/lib/src/lints/protected_notifier_properties.dart @@ -30,18 +30,16 @@ class ProtectedNotifierProperties extends DartLintRule { return; } - final enclosingClass = propertyAccess - .thisOrAncestorOfType() - ?.declaredElement; - if (enclosingClass == null) return; + final enclosingClass = + propertyAccess.thisOrAncestorOfType(); + final enclosingClassElement = enclosingClass?.declaredElement; + if (enclosingClass == null || enclosingClassElement == null) return; - final isAnnotatedWithRiverpod = - riverpodType.hasAnnotationOfExact(enclosingClass); - if (!isAnnotatedWithRiverpod) return; + if (enclosingClass.riverpod == null) return; final targetType = propertyAccess.target?.staticType; if (targetType == null) return; - if (targetType == enclosingClass.thisType) return; + if (targetType == enclosingClassElement.thisType) return; if (!anyNotifierType.isAssignableFromType(targetType)) return; reporter.reportErrorForNode(_code, propertyAccess.propertyName); diff --git a/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart b/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart index ae090aa0c..ca6f64f01 100644 --- a/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart +++ b/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart @@ -1,75 +1,186 @@ -import 'dart:math'; - +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/diagnostic/diagnostic.dart'; import 'package:analyzer/error/error.dart'; import 'package:analyzer/error/listener.dart'; -import 'package:collection/collection.dart'; +import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart'; +import 'package:analyzer_plugin/utilities/range_factory.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import '../object_utils.dart'; import '../riverpod_custom_lint.dart'; const _fixDependenciesPriority = 100; -class _ExtraAndMissingDependencies { - final List extra = []; - final List missing = []; +class _LocatedProvider { + _LocatedProvider(this.provider, this.node); + + final ProviderDeclarationElement provider; + final Location node; } -extension on GeneratorProviderDeclaration { - Iterable findScopedDependencies() sync* { - for (final dependency - in refInvocations.whereType()) { - final dependencyElement = dependency.provider.providerElement; - if (dependencyElement is! GeneratorProviderDeclarationElement) { - // If we cannot statically determine the dependencies of the dependency, - // we cannot check if the provider is missing a dependency. - return; - } - if (dependencyElement.isScoped) { - yield dependency; - } +class _MyDiagnostic implements DiagnosticMessage { + _MyDiagnostic({ + required this.message, + required this.filePath, + required this.length, + required this.offset, + }); + + @override + String? get url => null; + + final String message; + + @override + final String filePath; + + @override + final int length; + + @override + final int offset; + + @override + String messageText({required bool includeUrl}) => message; +} + +class _FindNestedDependency extends RecursiveRiverpodAstVisitor { + _FindNestedDependency( + this.accumulatedDependencyList, { + required this.onProvider, + this.visitStates = false, + }); + + final AccumulatedDependencyList accumulatedDependencyList; + final bool visitStates; + final void Function( + _LocatedProvider provider, + AccumulatedDependencyList list, { + required bool checkOverrides, + }) onProvider; + + _FindNestedDependency copyWith({ + AccumulatedDependencyList? accumulatedDependencyList, + bool? visitStates, + }) { + return _FindNestedDependency( + accumulatedDependencyList ?? this.accumulatedDependencyList, + onProvider: onProvider, + visitStates: visitStates ?? this.visitStates, + ); + } + + @override + void visitWidgetDeclaration(WidgetDeclaration node) { + super.visitWidgetDeclaration(node); + + if (node is! StatefulWidgetDeclaration) return; + + final stateAst = node.findStateAst(); + + // If targeting a StatefulWidget, we also need to check the state class. + if (stateAst != null) { + stateAst.node.accept(copyWith(visitStates: true)); + } + } + + @override + void visitStateDeclaration(StateDeclaration node) { + if (!visitStates) return; + + super.visitStateDeclaration(node); + } + + @override + void visitProviderOverrideExpression(ProviderOverrideExpression node) { + // Disable the lint for overrides. But only if the override isn't + // `overrides: [provider]`. + if (node.node.safeCast()?.providerListenable != null) { + super.visitProviderOverrideExpression(node); + return; } } - _ExtraAndMissingDependencies findExtraAndMissingDependencies() { - final result = _ExtraAndMissingDependencies(); + @override + void visitProviderIdentifier(ProviderIdentifier node) { + super.visitProviderIdentifier(node); + + onProvider( + _LocatedProvider(node.providerElement, LocationNode(node.node)), + accumulatedDependencyList, + checkOverrides: false, + ); + } - final dependencies = annotation.dependencies?.dependencies; - final scopedInvocations = findScopedDependencies().toList(); + @override + void visitAccumulatedDependencyList(AccumulatedDependencyList node) { + node.node.visitChildren( + copyWith(accumulatedDependencyList: node), + ); + } - for (final scopedDependency in scopedInvocations) { - final dependencyName = scopedDependency.provider.providerElement?.name; + @override + void visitIdentifierDependencies(IdentifierDependencies node) { + super.visitIdentifierDependencies(node); - if (dependencies == null || - !dependencies.any((e) => e.provider.name == dependencyName)) { - result.missing.add(scopedDependency); + if (node.dependencies.dependencies case final deps?) { + for (final dep in deps) { + onProvider( + _LocatedProvider(dep, LocationNode(node.node)), + accumulatedDependencyList, + checkOverrides: false, + ); } } + } - if (dependencies != null) { - for (final dependency in dependencies) { - final isDependencyUsed = scopedInvocations.any( - (e) => e.provider.providerElement?.name == dependency.provider.name, + @override + void visitNamedTypeDependencies(NamedTypeDependencies node) { + super.visitNamedTypeDependencies(node); + + final type = node.node.type; + if (type == null) return; + late final isWidget = widgetType.isAssignableFromType(type); + + if (node.dependencies.dependencies case final deps?) { + for (final dep in deps) { + onProvider( + _LocatedProvider(dep, LocationNode(node.node)), + accumulatedDependencyList, + // We check overrides only for Widget instances, as we can't guarantee + // that non-widget instances use a "ref" that's a child of the overrides. + checkOverrides: isWidget, ); - if (!isDependencyUsed) { - result.extra.add(dependency); - } } } - - return result; } } +class _Data { + _Data({ + required this.list, + required this.usedDependencies, + }); + + final AccumulatedDependencyList list; + final List<_LocatedProvider> usedDependencies; +} + +extension on AccumulatedDependencyList { + AstNode get target => + riverpod?.annotation.dependencyList?.node ?? + riverpod?.annotation.node ?? + dependencies?.dependencies.node ?? + node; +} + class ProviderDependencies extends RiverpodLintRule { const ProviderDependencies() : super(code: _code); static const _code = LintCode( name: 'provider_dependencies', - problemMessage: - 'If a provider depends on providers which specify "dependencies", ' - 'they should themselves specify "dependencies" and include all the scoped providers. ', - // TODO changelog: provider_dependencies is now a WARNING + problemMessage: '{0}', errorSeverity: ErrorSeverity.WARNING, ); @@ -79,24 +190,106 @@ class ProviderDependencies extends RiverpodLintRule { ErrorReporter reporter, CustomLintContext context, ) { - riverpodRegistry(context).addGeneratorProviderDeclaration((declaration) { - final extraAndMissing = declaration.findExtraAndMissingDependencies(); + riverpodRegistry(context).addAccumulatedDependencyList((list) { + // Ignore ProviderScopes. We only check annotations + if (list.overrides != null) return; - for (final extra in extraAndMissing.extra) { - reporter.reportErrorForNode(_code, extra.node); + // If the State has an associated widget, we don't visit it. + // The widget will already visit the state. + if (list.node.safeCast()?.state?.findWidgetAst() != + null) { + return; } - if (extraAndMissing.missing.isNotEmpty) { - reporter.reportErrorForNode( - _code, - declaration.annotation.dependencies?.node ?? - declaration.annotation.annotation, - ); + + final usedDependencies = <_LocatedProvider>[]; + + final visitor = _FindNestedDependency( + list, + onProvider: (locatedProvider, list, {required checkOverrides}) { + final provider = locatedProvider.provider; + if (provider is! GeneratorProviderDeclarationElement) return; + if (!provider.isScoped) return; + // Check if the provider is overridden. If it is, the provider doesn't + // count towards the unused/missing dependencies + if (checkOverrides) { + for (final override in list.overridesIncludingParents) { + // If we are overriding only one part of a family, + // we can't guarantee that later reads will point to the override. + if (override.familyArguments != null) continue; + + if (override.provider?.providerElement == provider) { + return; + } + } + } + + usedDependencies.add(locatedProvider); + }, + ); + + list.node.accept(visitor); + + var unusedDependencies = list.allDependencies + ?.where( + (dependency) => + !usedDependencies.any((e) => e.provider == dependency.provider), + ) + .toList(); + final missingDependencies = usedDependencies + .where( + (dependency) => + list.allDependencies + ?.every((e) => e.provider != dependency.provider) ?? + true, + ) + .toSet(); + + unusedDependencies ??= const []; + if (unusedDependencies.isEmpty && missingDependencies.isEmpty) return; + + final message = StringBuffer(); + if (unusedDependencies.isNotEmpty) { + message.write('Unused dependencies: '); + message.writeAll(unusedDependencies.map((e) => e.provider.name), ', '); + } + if (missingDependencies.isNotEmpty) { + if (unusedDependencies.isNotEmpty) { + message.write(' | '); + } + message.write('Missing dependencies: '); + message.writeAll(missingDependencies.map((e) => e.provider.name), ', '); } + + reporter.reportErrorForNode( + _code, + list.target, + [message.toString()], + [ + for (final dependency in missingDependencies) + if (dependency.provider.element.source case final source?) + _MyDiagnostic( + message: dependency.provider.name, + filePath: source.fullName, + offset: switch (dependency.node) { + LocationNode(:final node) => node.offset, + LocationElement(:final element) => element.nameOffset, + }, + length: switch (dependency.node) { + LocationNode(:final node) => node.length, + LocationElement(:final element) => element.nameLength, + }, + ), + ], + _Data( + usedDependencies: usedDependencies, + list: list, + ), + ); }); } @override - List getFixes() => [_ProviderDependenciesFix()]; + List getFixes() => [_ProviderDependenciesFix()]; } class _ProviderDependenciesFix extends RiverpodFix { @@ -108,104 +301,135 @@ class _ProviderDependenciesFix extends RiverpodFix { AnalysisError analysisError, List others, ) { - riverpodRegistry(context).addGeneratorProviderDeclaration((declaration) { - if (!declaration.node.sourceRange.intersects(analysisError.sourceRange)) { - return; - } + final data = analysisError.data; + if (data is! _Data) return; - final scopedDependencies = declaration.findScopedDependencies().toList(); - final dependenciesNode = declaration.annotation.dependencies?.node; + final scopedDependencies = + data.usedDependencies.map((e) => e.provider).toSet(); + final newDependencies = scopedDependencies.isEmpty + ? null + : '[${scopedDependencies.map((e) => e.name).join(', ')}]'; - final newDependencies = scopedDependencies.isEmpty - ? null - : '[${scopedDependencies.map((e) => e.provider.providerElement?.name).join(', ')}]'; - - if (newDependencies == null) { - // Should never be null, but just in case - if (dependenciesNode == null) return; - - final changeBuilder = reporter.createChangeBuilder( - message: 'Remove "dependencies"', - priority: _fixDependenciesPriority, - ); - changeBuilder.addDartFileEdit((builder) { - if (declaration.annotation.keepAliveNode == null) { - // Only "dependencies" is specified in the annotation. - // So instead of @Riverpod(dependencies: []) -> @Riverpod(), - // we can do @Riverpod(dependencies: []) -> @riverpod - builder.addSimpleReplacement( - declaration.annotation.annotation.sourceRange, - '@riverpod', - ); - } else { - // Some parameters are specified in the annotation, so we remove - // only the "dependencies" parameter. - - final end = min( - // End before the closing parenthesis or before the next parameter - declaration - .annotation.annotation.arguments!.rightParenthesis.offset, - dependenciesNode.endToken.next!.end, - ); - - final start = max( - // Start after the opening parenthesis or after the next parameter - declaration.annotation.annotation.arguments!.leftParenthesis.end, - dependenciesNode.beginToken.previous!.end, - ); - - builder.addDeletion(sourceRangeFrom(start: start, end: end)); - } - }); + final riverpodAnnotation = data.list.riverpod?.annotation; + final dependencies = data.list.dependencies; + if (newDependencies == null) { + if (riverpodAnnotation == null && dependencies == null) { + // No annotation found, so we can't fix anything. + // This shouldn't happen but prevents errors in case of bad states. return; } - if (dependenciesNode == null) { - final changeBuilder = reporter.createChangeBuilder( - message: 'Specify "dependencies"', - priority: _fixDependenciesPriority, - ); - changeBuilder.addDartFileEdit((builder) { - final annotationArguments = - declaration.annotation.annotation.arguments; - if (annotationArguments == null) { - // No argument list found. We are using the @riverpod annotation. - builder.addSimpleReplacement( - declaration.annotation.annotation.sourceRange, - '@Riverpod(dependencies: $newDependencies)', - ); - } else { - // Argument list found, we are using the @Riverpod() annotation - - // We want to insert the "dependencies" parameter after the last - final insertOffset = - annotationArguments.arguments.lastOrNull?.end ?? - annotationArguments.leftParenthesis.end; - - builder.addSimpleInsertion( - insertOffset, - ', dependencies: $newDependencies', - ); - } - }); + final changeBuilder = reporter.createChangeBuilder( + message: 'Remove "dependencies"', + priority: _fixDependenciesPriority, + ); + changeBuilder.addDartFileEdit((builder) { + if (riverpodAnnotation case final riverpod?) { + _riverpodRemoveDependencies(builder, riverpod); + } else if (dependencies != null) { + builder.addDeletion(data.list.dependencies!.node.sourceRange); + } + }); - return; - } + return; + } + + final dependencyList = data.list.riverpod?.annotation.dependencyList ?? + data.list.dependencies?.dependencies; + if (dependencyList == null) { final changeBuilder = reporter.createChangeBuilder( - message: 'Update "dependencies"', + message: 'Specify "dependencies"', priority: _fixDependenciesPriority, ); changeBuilder.addDartFileEdit((builder) { - final dependencies = scopedDependencies - .map((e) => e.provider.providerElement?.name) - .join(', '); + if (riverpodAnnotation case final riverpod?) { + _riverpodSpecifyDependencies(builder, riverpod, newDependencies); + } else { + builder.addSimpleInsertion( + data.list.node.offset, + '@Dependencies($newDependencies)\n', + ); + } + }); + + return; + } + + if (riverpodAnnotation == null && dependencies == null) { + // No annotation found, so we can't fix anything. + // This shouldn't happen but prevents errors in case of bad states. + return; + } + final changeBuilder = reporter.createChangeBuilder( + message: 'Update "dependencies"', + priority: _fixDependenciesPriority, + ); + changeBuilder.addDartFileEdit((builder) { + if (riverpodAnnotation != null) { + final dependencies = scopedDependencies.map((e) => e.name).join(', '); builder.addSimpleReplacement( - dependenciesNode.expression.sourceRange, + dependencyList.node!.sourceRange, '[$dependencies]', ); - }); + } else { + builder.addSimpleReplacement( + data.list.dependencies!.node.sourceRange, + '@Dependencies($newDependencies)', + ); + } }); } + + void _riverpodRemoveDependencies( + DartFileEditBuilder builder, + RiverpodAnnotation riverpod, + ) { + if (riverpod.keepAliveNode == null) { + // Only "dependencies" is specified in the annotation. + // So instead of @Riverpod(dependencies: []) -> @Riverpod(), + // we can do @Riverpod(dependencies: []) -> @riverpod + builder.addSimpleReplacement( + riverpod.node.sourceRange, + '@riverpod', + ); + return; + } + + // Some parameters are specified in the annotation, so we remove + // only the "dependencies" parameter. + final dependenciesNode = riverpod.dependenciesNode!; + final argumentList = riverpod.node.arguments!; + + builder.addDeletion( + range.nodeInList(argumentList.arguments, dependenciesNode), + ); + } + + void _riverpodSpecifyDependencies( + DartFileEditBuilder builder, + RiverpodAnnotation riverpod, + String newDependencies, + ) { + final annotationArguments = riverpod.node.arguments; + if (annotationArguments == null) { + // No argument list found. We are using the @riverpod annotation. + builder.addSimpleReplacement( + riverpod.node.sourceRange, + '@Riverpod(dependencies: $newDependencies)', + ); + } else { + // Argument list found, we are using the @Riverpod() annotation + + // We want to insert the "dependencies" parameter after the last + final insertOffset = annotationArguments.arguments.lastOrNull?.end ?? + annotationArguments.leftParenthesis.end; + + builder.addSimpleInsertion( + insertOffset, + ', dependencies: $newDependencies', + ); + } + } } diff --git a/packages/riverpod_lint/lib/src/lints/provider_parameters.dart b/packages/riverpod_lint/lib/src/lints/provider_parameters.dart index 821ddb6b9..ddba28aef 100644 --- a/packages/riverpod_lint/lib/src/lints/provider_parameters.dart +++ b/packages/riverpod_lint/lib/src/lints/provider_parameters.dart @@ -3,6 +3,7 @@ import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/error/error.dart'; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import '../object_utils.dart'; import '../riverpod_custom_lint.dart'; @@ -16,7 +17,6 @@ class ProviderParameters extends RiverpodLintRule { 'Meaning either the values should be cached, or the parameters should override ==', url: 'https://riverpod.dev/docs/concepts/modifiers/family#passing-multiple-parameters-to-a-family', - // TODO changelog: provider_parameters is now a WARNING errorSeverity: ErrorSeverity.WARNING, ); @@ -26,7 +26,10 @@ class ProviderParameters extends RiverpodLintRule { ErrorReporter reporter, CustomLintContext context, ) { - riverpodRegistry(context).addProviderListenableExpression((expression) { + context.registry.addExpression((node) { + final expression = node.providerListenable; + if (expression == null) return; + final arguments = expression.familyArguments; if (arguments == null) return; diff --git a/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart b/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart index b25d5e329..436ca68ca 100644 --- a/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart +++ b/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart @@ -6,7 +6,6 @@ import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import '../riverpod_custom_lint.dart'; -// TODO changelog new lint class RiverpodSyntaxError extends RiverpodLintRule { const RiverpodSyntaxError() : super(code: _code); @@ -22,31 +21,26 @@ class RiverpodSyntaxError extends RiverpodLintRule { ErrorReporter reporter, CustomLintContext context, ) { - riverpodRegistry(context).addResolvedRiverpodLibraryResult((unit) { - for (final error in unit.errors) { - switch (error.code) { - case RiverpodAnalysisErrorCode.missingNotifierBuild: - // Silencing errors already covered by a different lint - continue; - case _: - } + riverpodRegistry(context).addRiverpodAnalysisError((error) { + if (error.code == RiverpodAnalysisErrorCode.missingNotifierBuild) { + return; + } - final location = switch (error) { - RiverpodAnalysisError(:final targetElement?) => - SourceRange(targetElement.nameOffset, targetElement.nameLength), - RiverpodAnalysisError(:final targetNode?) => targetNode.sourceRange, - _ => null, - }; + final location = switch (error) { + RiverpodAnalysisError(:final targetElement?) => + SourceRange(targetElement.nameOffset, targetElement.nameLength), + RiverpodAnalysisError(:final targetNode?) => targetNode.sourceRange, + _ => null, + }; - if (location == null) continue; + if (location == null) return; - reporter.reportErrorForOffset( - _code, - location.offset, - location.length, - [error.message], - ); - } + reporter.reportErrorForOffset( + _code, + location.offset, + location.length, + [error.message], + ); }); } } diff --git a/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart b/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart index cd5b0504b..948260451 100644 --- a/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart +++ b/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart @@ -39,7 +39,6 @@ class ScopedProvidersShouldSpecifyDependencies extends RiverpodLintRule { name: 'scoped_providers_should_specify_dependencies', problemMessage: 'Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies.', - // TODO changelog: scoped_providers_should_specify_dependencies is now a WARNING errorSeverity: ErrorSeverity.WARNING, ); @@ -49,43 +48,56 @@ class ScopedProvidersShouldSpecifyDependencies extends RiverpodLintRule { ErrorReporter reporter, CustomLintContext context, ) { - void checkScopedOverrideList( - ProviderOverrideList? overrideList, - ) { - final overrides = overrideList?.overrides; - if (overrides == null) return; - - for (final override in overrides) { - final provider = override.providerElement; - // We can only know statically if a provider is scoped on generator providers - if (provider is! GeneratorProviderDeclarationElement) continue; - - if (!provider.isScoped) { - reporter.reportErrorForNode(code, override.expression); - } + riverpodRegistry(context) + ..addProviderContainerInstanceCreationExpression((node) { + handleProviderContainerInstanceCreation(node, reporter); + }) + ..addProviderScopeInstanceCreationExpression((node) { + handleProviderScopeInstanceCreation(node, reporter); + }); + } + + void checkScopedOverrideList( + ProviderOverrideList? overrideList, + ErrorReporter reporter, + ) { + final overrides = overrideList?.overrides; + if (overrides == null) return; + + for (final override in overrides) { + final provider = override.provider?.providerElement; + + // We can only know statically if a provider is scoped on generator providers + if (provider is! GeneratorProviderDeclarationElement) continue; + if (!provider.isScoped) { + reporter.reportErrorForNode(code, override.node); } } + } - riverpodRegistry(context) - ..addProviderScopeInstanceCreationExpression((expression) { - final isScoped = isProviderScopeScoped(expression); - if (!isScoped) return; + void handleProviderScopeInstanceCreation( + ProviderScopeInstanceCreationExpression expression, + ErrorReporter reporter, + ) { + final isScoped = isProviderScopeScoped(expression); + if (!isScoped) return; - checkScopedOverrideList(expression.overrides); - }) - ..addProviderContainerInstanceCreationExpression((expression) { - final hasParent = expression.node.argumentList.arguments - .whereType() - // TODO handle parent:null. - // This might be doable by checking that the expression's - // static type is non-nullable - .any((e) => e.name.label.name == 'parent'); - - // No parent: parameter found, therefore ProviderContainer is never scoped - if (!hasParent) return; - - checkScopedOverrideList(expression.overrides); - }); + checkScopedOverrideList(expression.overrides, reporter); + } + + void handleProviderContainerInstanceCreation( + ProviderContainerInstanceCreationExpression expression, + ErrorReporter reporter, + ) { + // TODO handle parent:null. + // This might be doable by checking that the expression's + // static type is non-nullable + final hasParent = expression.parent != null; + + // No parent: parameter found, therefore ProviderContainer is never scoped + if (!hasParent) return; + + checkScopedOverrideList(expression.overrides, reporter); } bool isProviderScopeScoped( diff --git a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart new file mode 100644 index 000000000..8d2d83e08 --- /dev/null +++ b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart @@ -0,0 +1,65 @@ +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/element/element.dart'; +import 'package:analyzer/error/error.dart'; +import 'package:analyzer/error/listener.dart'; +import 'package:custom_lint_builder/custom_lint_builder.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; + +import '../object_utils.dart'; +import '../riverpod_custom_lint.dart'; + +class UnknownScopedUsage extends RiverpodLintRule { + const UnknownScopedUsage() : super(code: _code); + + static const _code = LintCode( + name: 'unknown_scoped_usage', + problemMessage: + 'A provider was used, but could not find the associated `ref`.', + errorSeverity: ErrorSeverity.WARNING, + ); + + @override + void run( + CustomLintResolver resolver, + ErrorReporter reporter, + CustomLintContext context, + ) { + riverpodRegistry(context).addProviderIdentifier((identifier) { + final providerElement = identifier.providerElement; + if (providerElement is! GeneratorProviderDeclarationElement) return; + if (!providerElement.isScoped) return; + + final enclosingMethodInvocation = + identifier.node.thisOrAncestorOfType(); + final refInvocation = enclosingMethodInvocation?.refInvocation + .safeCast(); + final widgetRefInvocation = enclosingMethodInvocation?.widgetRefInvocation + .safeCast(); + + // If in a ref expression, and the associated ref is the checked provider, + // then it's fine. + // This is to reject cases like `ref.watch(something(provider))`. + if (refInvocation?.listenable.provider == identifier || + widgetRefInvocation?.listenable.provider == identifier) return; + + // .parent is used because providers count as overrides. + // We don't want to count "provider" as an override, and want to focus + // on "provider.overrideX". + final override = identifier.node.parent + ?.thisOrAncestorOfType() + ?.providerOverride; + // The identifier is in override, so it's fine. + if (override?.provider == identifier) return; + + final enclosingConstructorType = identifier + .node.staticParameterElement?.enclosingElement + .safeCast() + ?.returnType; + // Silence the warning if passed to a widget constructor. + if (enclosingConstructorType != null && + widgetType.isAssignableFromType(enclosingConstructorType)) return; + + reporter.reportErrorForNode(code, identifier.node); + }); + } +} diff --git a/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart b/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart index 4bc398c14..8d9d93be7 100644 --- a/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart +++ b/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart @@ -6,7 +6,6 @@ import 'package:custom_lint_builder/custom_lint_builder.dart'; import '../riverpod_custom_lint.dart'; -// TODO changelog added migration for missing import. class MissingLegacyImport extends RiverpodLintRule { const MissingLegacyImport() : super(code: _code); diff --git a/packages/riverpod_lint/lib/src/object_utils.dart b/packages/riverpod_lint/lib/src/object_utils.dart index 1a932ca44..1b14ef467 100644 --- a/packages/riverpod_lint/lib/src/object_utils.dart +++ b/packages/riverpod_lint/lib/src/object_utils.dart @@ -1,3 +1,5 @@ +import 'package:analyzer/dart/ast/ast.dart'; + extension ObjectUtils on T? { R? safeCast() { final that = this; @@ -11,3 +13,13 @@ extension ObjectUtils on T? { return cb?.call(that); } } + +extension AstUtils on AstNode { + Iterable get ancestors sync* { + var parent = this.parent; + while (parent != null) { + yield parent; + parent = parent.parent; + } + } +} diff --git a/packages/riverpod_lint/lib/src/riverpod_custom_lint.dart b/packages/riverpod_lint/lib/src/riverpod_custom_lint.dart index 451da8d8e..3a635a3e8 100644 --- a/packages/riverpod_lint/lib/src/riverpod_custom_lint.dart +++ b/packages/riverpod_lint/lib/src/riverpod_custom_lint.dart @@ -85,11 +85,9 @@ mixin _ParseRiverpod { if (context.sharedState.containsKey(_contextKey)) return; // Only run the riverpod parsing logic once final registry = context.sharedState[_contextKey] = RiverpodAstRegistry(); - final unit = await resolver.getResolvedUnitResult(); - final result = ResolvedRiverpodLibraryResult.from([unit.unit]); - context.addPostRunCallback(() => registry.run(result)); + context.addPostRunCallback(() => registry.run(unit.unit)); } RiverpodAstRegistry riverpodRegistry(CustomLintContext context) { diff --git a/packages/riverpod_lint_flutter_test/README.md b/packages/riverpod_lint_flutter_test/README.md new file mode 100644 index 000000000..101a28fb1 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/README.md @@ -0,0 +1,8 @@ +## Updating golden tests + +This folder uses snapshot testing. +To update the "snapshots"/"goldens", run: + +```sh +goldens=true dart test +``` \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index 9a96ac1cc..e071a4421 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -431,6 +431,5 @@ abstract class _$Generic extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index 6ee68ecb0..9b30cb625 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -230,7 +230,5 @@ final class ExampleFamilyFamily extends Family { ); } } - -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/golden.dart b/packages/riverpod_lint_flutter_test/test/golden.dart index 8bce6e76d..fd9287169 100644 --- a/packages/riverpod_lint_flutter_test/test/golden.dart +++ b/packages/riverpod_lint_flutter_test/test/golden.dart @@ -8,8 +8,7 @@ import 'package:analyzer_plugin/protocol/protocol_generated.dart'; import 'package:analyzer/dart/analysis/results.dart'; import 'package:analyzer/dart/analysis/utilities.dart'; -@Deprecated('Do not commit') -var goldenWrite = false; +final goldenWrite = bool.parse(Platform.environment[r'goldens'] ?? 'false'); File writeToTemporaryFile(String content) { final tempDir = Directory.systemTemp.createTempSync(); diff --git a/packages/riverpod_lint_flutter_test/test/lints/another.g.dart b/packages/riverpod_lint_flutter_test/test/lints/another.g.dart index a10fa84a7..9e782e29b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/another.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/another.g.dart @@ -65,6 +65,5 @@ final class BProvider extends $FunctionalProvider String _$bHash() => r'52593050701642f22b31c590f20c003dc2ee1579'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 9356f1186..40a631217 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -426,6 +426,5 @@ abstract class _$Regresion2959 extends $Notifier { void runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index 1e5c10f85..1992e1df4 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -165,6 +165,5 @@ abstract class _$GeneratedNotifier extends $Notifier { ); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.dart index 8a3268ae3..b2f16d752 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.dart @@ -10,9 +10,6 @@ int nameless( return 0; } -@riverpod -external int scoped(); - @riverpod int generics(GenericsRef ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.diff b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.diff index f45973703..b3dab2390 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.diff @@ -12,7 +12,7 @@ int nameless( --- Message: `Type as NoGenericsRef` Priority: 90 -Diff for file `test/lints/functional_ref/functional_ref.dart:21`: +Diff for file `test/lints/functional_ref/functional_ref.dart:18`: ``` @riverpod // expect_lint: functional_ref @@ -24,7 +24,7 @@ Diff for file `test/lints/functional_ref/functional_ref.dart:21`: --- Message: `Type as MissingGenericsRef` Priority: 90 -Diff for file `test/lints/functional_ref/functional_ref.dart:25`: +Diff for file `test/lints/functional_ref/functional_ref.dart:22`: ``` @riverpod // expect_lint: functional_ref @@ -36,7 +36,7 @@ Diff for file `test/lints/functional_ref/functional_ref.dart:25`: --- Message: `Type as WrongOrderRef` Priority: 90 -Diff for file `test/lints/functional_ref/functional_ref.dart:29`: +Diff for file `test/lints/functional_ref/functional_ref.dart:26`: ``` @riverpod // expect_lint: functional_ref diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index ba60364c2..f79dc278a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -65,65 +65,6 @@ final class NamelessProvider extends $FunctionalProvider String _$namelessHash() => r'1a2aa61445a64c65301051820b159c5998195606'; -typedef ScopedRef = Ref; - -@ProviderFor(scoped) -const scopedProvider = ScopedProvider._(); - -final class ScopedProvider extends $FunctionalProvider - with $Provider { - const ScopedProvider._( - {int Function( - ScopedRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'scopedProvider', - isAutoDispose: true, - dependencies: const [], - allTransitiveDependencies: const [], - ); - - final int Function( - ScopedRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$scopedHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - ScopedProvider $copyWithCreate( - int Function( - ScopedRef ref, - ) create, - ) { - return ScopedProvider._(create: create); - } - - @override - int create(ScopedRef ref) { - final _$cb = _createCb ?? scoped; - return _$cb(ref); - } -} - -String _$scopedHash() => r'590f1a203323105e732397a2616fbd7dac65f0cc'; - typedef GenericsRef = Ref; @ProviderFor(generics) @@ -611,7 +552,5 @@ final class WrongOrderFamily extends Family { ); } } - -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.dart b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.dart similarity index 58% rename from packages/riverpod_lint_flutter_test/test/lints/dependencies.dart rename to packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.dart index 4799003b5..59095cac9 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.dart @@ -1,8 +1,9 @@ -// ignore_for_file: unused_field +// ignore_for_file: unused_field, avoid_manual_providers_as_generated_provider_dependency +import 'package:flutter/material.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; -import 'another.dart' as import_alias; +import '../another.dart' as import_alias; part 'dependencies.g.dart'; @@ -20,10 +21,8 @@ final root = Provider((ref) => 0); int generatedRoot(GeneratedRootRef ref) => 0; // dep no "dependencies" - @riverpod int watchScopedButNoDependencies(WatchScopedButNoDependenciesRef ref) { - // expect_lint: avoid_manual_providers_as_generated_provider_dependency return ref.watch(scoped); } @@ -37,7 +36,6 @@ int watchGeneratedScopedButNoDependencies( @riverpod int watchRootButNoDependencies(WatchRootButNoDependenciesRef ref) { - // expect_lint: avoid_manual_providers_as_generated_provider_dependency return ref.watch(root); } @@ -49,10 +47,8 @@ int watchGeneratedRootButNoDependencies( } // Check "dependencies" specified but missing dependency - @Riverpod(dependencies: []) int watchScopedButEmptyDependencies(WatchScopedButEmptyDependenciesRef ref) { - // expect_lint: avoid_manual_providers_as_generated_provider_dependency return ref.watch(scoped); } @@ -66,7 +62,6 @@ int watchGeneratedScopedButEmptyDependencies( @Riverpod(dependencies: []) int watchRootButEmptyDependencies(WatchRootButEmptyDependenciesRef ref) { - // expect_lint: avoid_manual_providers_as_generated_provider_dependency return ref.watch(root); } @@ -77,43 +72,7 @@ int watchGeneratedRootButEmptyDependencies( return ref.watch(generatedRootProvider); } -// Check "dependencies" specified but missing dependency - -@Riverpod(dependencies: [dep]) -int watchScopedButMissingDependencies( - WatchScopedButMissingDependenciesRef ref, -) { - ref.watch(depProvider); - // expect_lint: avoid_manual_providers_as_generated_provider_dependency - return ref.watch(scoped); -} - -// expect_lint: provider_dependencies -@Riverpod(dependencies: [dep]) -int watchGeneratedScopedButMissingDependencies( - WatchGeneratedScopedButMissingDependenciesRef ref, -) { - ref.watch(depProvider); - return ref.watch(generatedScopedProvider); -} - -@Riverpod(dependencies: [dep]) -int watchRootButMissingDependencies(WatchRootButMissingDependenciesRef ref) { - ref.watch(depProvider); - // expect_lint: avoid_manual_providers_as_generated_provider_dependency - return ref.watch(root); -} - -@Riverpod(dependencies: [dep]) -int watchGeneratedRootButMissingDependencies( - WatchGeneratedRootButMissingDependenciesRef ref, -) { - ref.watch(depProvider); - return ref.watch(generatedRootProvider); -} - // Check "dependencies" specified and contains dependency - @Riverpod(dependencies: [generatedScoped]) int watchGeneratedScopedAndContainsDependency( WatchGeneratedScopedAndContainsDependencyRef ref, @@ -121,31 +80,7 @@ int watchGeneratedScopedAndContainsDependency( return ref.watch(generatedScopedProvider); } -@Riverpod(dependencies: [ - // The dependency is redundant because it is not a scoped provider - // expect_lint: provider_dependencies - generatedRoot, -]) -int watchGeneratedRootAndContainsDependency( - WatchGeneratedRootAndContainsDependencyRef ref, -) { - return ref.watch(generatedRootProvider); -} - -// A dependency is specified but never used - -@Riverpod(dependencies: [ - dep, - // expect_lint: provider_dependencies - generatedRoot, -]) -int specifiedDependencyButNeverUsed(SpecifiedDependencyButNeverUsedRef ref) { - ref.watch(depProvider); - return 0; -} - // Works with classes too - @Riverpod(dependencies: []) class ClassWatchGeneratedRootButMissingDependencies extends _$ClassWatchGeneratedRootButMissingDependencies { @@ -155,16 +90,6 @@ class ClassWatchGeneratedRootButMissingDependencies } } -// expect_lint: provider_dependencies -@Riverpod(dependencies: []) -class ClassWatchGeneratedScopedButMissingDependencies - extends _$ClassWatchGeneratedScopedButMissingDependencies { - @override - int build() { - return ref.watch(generatedScopedProvider); - } -} - @Riverpod(dependencies: [generatedScoped]) int regression2348(Regression2348Ref ref) { ref..watch(generatedScopedProvider); @@ -197,7 +122,6 @@ int familyDep2(FamilyDep2Ref ref, int p) { // Regression test for https://github.com/rrousselGit/riverpod/issues/2935 @riverpod int alias(AliasRef ref) { - // expect_lint: avoid_manual_providers_as_generated_provider_dependency ref.watch(import_alias.aProvider); ref.watch(import_alias.bProvider); return 0; @@ -206,10 +130,139 @@ int alias(AliasRef ref) { // Regression test for https://github.com/rrousselGit/riverpod/issues/2935 @riverpod class AliasClass extends _$AliasClass { - // expect_lint: avoid_manual_providers_as_generated_provider_dependency late final int _a = ref.read(import_alias.aProvider); late final int _b = ref.read(import_alias.bProvider); @override int build() => 0; } + +// === @Dependencies === + +// Can specify dependencies on top-level declarations +@Dependencies([dep]) +class RootDependenciesClass { + void foo() { + fn(); + } +} + +// Specifying @Dependencies on class members requires specifying them on +// the class too: +class MemberDependencies { + // expect_lint: provider_dependencies + @Dependencies([dep]) + int build() => 0; +} + +// expect_lint: provider_dependencies +@Dependencies([]) +class CanUpdateMultipleDependenciesAtOnce { + // expect_lint: provider_dependencies + @Dependencies([]) + int build(WidgetRef ref) { + ref.watch(depProvider); + return 0; + } +} + +// Counts @Riverpod dependencies too +@Riverpod(dependencies: [dep]) +class RiverpodDependencies extends _$RiverpodDependencies { + @Dependencies([dep]) + @override + int build() { + ref.watch(depProvider); + return 0; + } +} + +// Handle identifiers with dependencies +// expect_lint: provider_dependencies +@Dependencies([dep]) +void fn() {} + +// expect_lint: provider_dependencies +void fn2() { + fn(); +} + +@Dependencies([dep]) +void fn3() => fn(); + +// expect_lint: provider_dependencies +@riverpod +int foo(FooRef ref) { + fn(); + return 0; +} + +// Handle widget with dependencies +@Dependencies([dep]) +class WidgetDependencies extends StatelessWidget { + @override + Widget build(BuildContext context) { + fn(); + return const SizedBox(); + } +} + +// expect_lint: provider_dependencies +class WidgetDependencies2 extends StatelessWidget { + @override + Widget build(BuildContext context) { + return WidgetDependencies(); + } +} + +@Dependencies([dep]) +class WidgetDependencies3 extends StatelessWidget { + @override + Widget build(BuildContext context) { + return WidgetDependencies(); + } +} + +@Dependencies([dep]) +class Stateful extends StatefulWidget { + const Stateful({super.key}); + + @override + _StatefulState createState() => _StatefulState(); +} + +class _StatefulState extends State { + @override + Widget build(BuildContext context) { + return WidgetDependencies(); + } +} + +// expect_lint: provider_dependencies +@Dependencies([]) +class Stateful2 extends StatefulWidget { + const Stateful2({super.key}); + + @override + _Stateful2State createState() => _Stateful2State(); +} + +class _Stateful2State extends State { + @override + Widget build(BuildContext context) { + return WidgetDependencies(); + } +} + +// expect_lint: provider_dependencies +class FindStateFromClassList extends StatefulWidget { + const FindStateFromClassList({super.key}); + + @override + State createState() => _Stateful3State(); +} + +class _Stateful3State extends State { + @override + Widget build(BuildContext context) => WidgetDependencies(); +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.diff b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.diff new file mode 100644 index 000000000..475399701 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.diff @@ -0,0 +1,135 @@ +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/dependencies.dart:30`: +``` + +// expect_lint: provider_dependencies +- @riverpod ++ @Riverpod(dependencies: [generatedScoped]) +int watchGeneratedScopedButNoDependencies( + WatchGeneratedScopedButNoDependenciesRef ref, +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/dependencies.dart:56`: +``` + +// expect_lint: provider_dependencies +- @Riverpod(dependencies: []) ++ @Riverpod(dependencies: [generatedScoped]) +int watchGeneratedScopedButEmptyDependencies( + WatchGeneratedScopedButEmptyDependenciesRef ref, +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/dependencies.dart:154`: +``` +class MemberDependencies { + // expect_lint: provider_dependencies +- @Dependencies([dep]) ++ + int build() => 0; +} +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/dependencies.dart:162`: +``` +class CanUpdateMultipleDependenciesAtOnce { + // expect_lint: provider_dependencies +- @Dependencies([]) ++ @Dependencies([dep]) + int build(WidgetRef ref) { + ref.watch(depProvider); +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/dependencies.dart:159`: +``` + +// expect_lint: provider_dependencies +- @Dependencies([]) ++ @Dependencies([dep]) +class CanUpdateMultipleDependenciesAtOnce { + // expect_lint: provider_dependencies +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/dependencies.dart:182`: +``` +// Handle identifiers with dependencies +// expect_lint: provider_dependencies +- @Dependencies([dep]) ++ +void fn() {} + +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/dependencies.dart:186`: +``` + +// expect_lint: provider_dependencies +- void fn2() { ++ @Dependencies([dep]) ++ void fn2() { + fn(); +} +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/dependencies.dart:194`: +``` + +// expect_lint: provider_dependencies +- @riverpod ++ @Riverpod(dependencies: [dep]) +int foo(FooRef ref) { + fn(); +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/dependencies.dart:211`: +``` + +// expect_lint: provider_dependencies +- class WidgetDependencies2 extends StatelessWidget { ++ @Dependencies([dep]) ++ class WidgetDependencies2 extends StatelessWidget { + @override + Widget build(BuildContext context) { +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/dependencies.dart:242`: +``` + +// expect_lint: provider_dependencies +- @Dependencies([]) ++ @Dependencies([dep]) +class Stateful2 extends StatefulWidget { + const Stateful2({super.key}); +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/dependencies.dart:258`: +``` + +// expect_lint: provider_dependencies +- class FindStateFromClassList extends StatefulWidget { ++ @Dependencies([dep]) ++ class FindStateFromClassList extends StatefulWidget { + const FindStateFromClassList({super.key}); + +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.g.dart similarity index 73% rename from packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart rename to packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.g.dart index 2d61eccc9..b10343a46 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.g.dart @@ -689,278 +689,6 @@ final class WatchGeneratedRootButEmptyDependenciesProvider String _$watchGeneratedRootButEmptyDependenciesHash() => r'9fb97c1fa207a18870cd23c682305dcef413a706'; -typedef WatchScopedButMissingDependenciesRef = Ref; - -@ProviderFor(watchScopedButMissingDependencies) -const watchScopedButMissingDependenciesProvider = - WatchScopedButMissingDependenciesProvider._(); - -final class WatchScopedButMissingDependenciesProvider - extends $FunctionalProvider - with $Provider { - const WatchScopedButMissingDependenciesProvider._( - {int Function( - WatchScopedButMissingDependenciesRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'watchScopedButMissingDependenciesProvider', - isAutoDispose: true, - dependencies: const [depProvider], - allTransitiveDependencies: const [ - WatchScopedButMissingDependenciesProvider - .$allTransitiveDependencies0, - ], - ); - - static const $allTransitiveDependencies0 = depProvider; - - final int Function( - WatchScopedButMissingDependenciesRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => - _$watchScopedButMissingDependenciesHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - WatchScopedButMissingDependenciesProvider $copyWithCreate( - int Function( - WatchScopedButMissingDependenciesRef ref, - ) create, - ) { - return WatchScopedButMissingDependenciesProvider._(create: create); - } - - @override - int create(WatchScopedButMissingDependenciesRef ref) { - final _$cb = _createCb ?? watchScopedButMissingDependencies; - return _$cb(ref); - } -} - -String _$watchScopedButMissingDependenciesHash() => - r'9bc337d57438161120d179de48443ed4be4c5b65'; - -typedef WatchGeneratedScopedButMissingDependenciesRef = Ref; - -@ProviderFor(watchGeneratedScopedButMissingDependencies) -const watchGeneratedScopedButMissingDependenciesProvider = - WatchGeneratedScopedButMissingDependenciesProvider._(); - -final class WatchGeneratedScopedButMissingDependenciesProvider - extends $FunctionalProvider - with $Provider { - const WatchGeneratedScopedButMissingDependenciesProvider._( - {int Function( - WatchGeneratedScopedButMissingDependenciesRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'watchGeneratedScopedButMissingDependenciesProvider', - isAutoDispose: true, - dependencies: const [depProvider], - allTransitiveDependencies: const [ - WatchGeneratedScopedButMissingDependenciesProvider - .$allTransitiveDependencies0, - ], - ); - - static const $allTransitiveDependencies0 = depProvider; - - final int Function( - WatchGeneratedScopedButMissingDependenciesRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => - _$watchGeneratedScopedButMissingDependenciesHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - WatchGeneratedScopedButMissingDependenciesProvider $copyWithCreate( - int Function( - WatchGeneratedScopedButMissingDependenciesRef ref, - ) create, - ) { - return WatchGeneratedScopedButMissingDependenciesProvider._(create: create); - } - - @override - int create(WatchGeneratedScopedButMissingDependenciesRef ref) { - final _$cb = _createCb ?? watchGeneratedScopedButMissingDependencies; - return _$cb(ref); - } -} - -String _$watchGeneratedScopedButMissingDependenciesHash() => - r'be4cf146ec2bebf4c92f6acd73e1dee60e689c20'; - -typedef WatchRootButMissingDependenciesRef = Ref; - -@ProviderFor(watchRootButMissingDependencies) -const watchRootButMissingDependenciesProvider = - WatchRootButMissingDependenciesProvider._(); - -final class WatchRootButMissingDependenciesProvider - extends $FunctionalProvider - with $Provider { - const WatchRootButMissingDependenciesProvider._( - {int Function( - WatchRootButMissingDependenciesRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'watchRootButMissingDependenciesProvider', - isAutoDispose: true, - dependencies: const [depProvider], - allTransitiveDependencies: const [ - WatchRootButMissingDependenciesProvider.$allTransitiveDependencies0, - ], - ); - - static const $allTransitiveDependencies0 = depProvider; - - final int Function( - WatchRootButMissingDependenciesRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$watchRootButMissingDependenciesHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - WatchRootButMissingDependenciesProvider $copyWithCreate( - int Function( - WatchRootButMissingDependenciesRef ref, - ) create, - ) { - return WatchRootButMissingDependenciesProvider._(create: create); - } - - @override - int create(WatchRootButMissingDependenciesRef ref) { - final _$cb = _createCb ?? watchRootButMissingDependencies; - return _$cb(ref); - } -} - -String _$watchRootButMissingDependenciesHash() => - r'aa6ca4efaba18ad3d2132439f1bb26773cceb170'; - -typedef WatchGeneratedRootButMissingDependenciesRef = Ref; - -@ProviderFor(watchGeneratedRootButMissingDependencies) -const watchGeneratedRootButMissingDependenciesProvider = - WatchGeneratedRootButMissingDependenciesProvider._(); - -final class WatchGeneratedRootButMissingDependenciesProvider - extends $FunctionalProvider - with $Provider { - const WatchGeneratedRootButMissingDependenciesProvider._( - {int Function( - WatchGeneratedRootButMissingDependenciesRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'watchGeneratedRootButMissingDependenciesProvider', - isAutoDispose: true, - dependencies: const [depProvider], - allTransitiveDependencies: const [ - WatchGeneratedRootButMissingDependenciesProvider - .$allTransitiveDependencies0, - ], - ); - - static const $allTransitiveDependencies0 = depProvider; - - final int Function( - WatchGeneratedRootButMissingDependenciesRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => - _$watchGeneratedRootButMissingDependenciesHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - WatchGeneratedRootButMissingDependenciesProvider $copyWithCreate( - int Function( - WatchGeneratedRootButMissingDependenciesRef ref, - ) create, - ) { - return WatchGeneratedRootButMissingDependenciesProvider._(create: create); - } - - @override - int create(WatchGeneratedRootButMissingDependenciesRef ref) { - final _$cb = _createCb ?? watchGeneratedRootButMissingDependencies; - return _$cb(ref); - } -} - -String _$watchGeneratedRootButMissingDependenciesHash() => - r'eda2f1b9c3aaf26cd152108104b8bbb71774c906'; - typedef WatchGeneratedScopedAndContainsDependencyRef = Ref; @ProviderFor(watchGeneratedScopedAndContainsDependency) @@ -1030,42 +758,31 @@ final class WatchGeneratedScopedAndContainsDependencyProvider String _$watchGeneratedScopedAndContainsDependencyHash() => r'320592737e763091c1229a79ae07fe961e7aab72'; -typedef WatchGeneratedRootAndContainsDependencyRef = Ref; - -@ProviderFor(watchGeneratedRootAndContainsDependency) -const watchGeneratedRootAndContainsDependencyProvider = - WatchGeneratedRootAndContainsDependencyProvider._(); +@ProviderFor(ClassWatchGeneratedRootButMissingDependencies) +const classWatchGeneratedRootButMissingDependenciesProvider = + ClassWatchGeneratedRootButMissingDependenciesProvider._(); -final class WatchGeneratedRootAndContainsDependencyProvider - extends $FunctionalProvider - with $Provider { - const WatchGeneratedRootAndContainsDependencyProvider._( - {int Function( - WatchGeneratedRootAndContainsDependencyRef ref, - )? create}) +final class ClassWatchGeneratedRootButMissingDependenciesProvider + extends $NotifierProvider { + const ClassWatchGeneratedRootButMissingDependenciesProvider._( + {super.runNotifierBuildOverride, + ClassWatchGeneratedRootButMissingDependencies Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'watchGeneratedRootAndContainsDependencyProvider', + name: r'classWatchGeneratedRootButMissingDependenciesProvider', isAutoDispose: true, - dependencies: const [generatedRootProvider], - allTransitiveDependencies: const [ - WatchGeneratedRootAndContainsDependencyProvider - .$allTransitiveDependencies0, - ], + dependencies: const [], + allTransitiveDependencies: const [], ); - static const $allTransitiveDependencies0 = generatedRootProvider; - - final int Function( - WatchGeneratedRootAndContainsDependencyRef ref, - )? _createCb; + final ClassWatchGeneratedRootButMissingDependencies Function()? _createCb; @override String debugGetCreateSourceHash() => - _$watchGeneratedRootAndContainsDependencyHash(); + _$classWatchGeneratedRootButMissingDependenciesHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -1077,66 +794,80 @@ final class WatchGeneratedRootAndContainsDependencyProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + ClassWatchGeneratedRootButMissingDependencies create() => + _createCb?.call() ?? ClassWatchGeneratedRootButMissingDependencies(); + @$internal @override - WatchGeneratedRootAndContainsDependencyProvider $copyWithCreate( - int Function( - WatchGeneratedRootAndContainsDependencyRef ref, - ) create, + ClassWatchGeneratedRootButMissingDependenciesProvider $copyWithCreate( + ClassWatchGeneratedRootButMissingDependencies Function() create, ) { - return WatchGeneratedRootAndContainsDependencyProvider._(create: create); + return ClassWatchGeneratedRootButMissingDependenciesProvider._( + create: create); } + @$internal @override - int create(WatchGeneratedRootAndContainsDependencyRef ref) { - final _$cb = _createCb ?? watchGeneratedRootAndContainsDependency; - return _$cb(ref); + ClassWatchGeneratedRootButMissingDependenciesProvider $copyWithBuild( + int Function( + Ref, + ClassWatchGeneratedRootButMissingDependencies, + ) build, + ) { + return ClassWatchGeneratedRootButMissingDependenciesProvider._( + runNotifierBuildOverride: build); } + + @$internal + @override + $NotifierProviderElement + $createElement(ProviderContainer container) => + $NotifierProviderElement(this, container); } -String _$watchGeneratedRootAndContainsDependencyHash() => - r'5bb8cc73e375ce8c5dbd03d5ca3c16fb2d5b199f'; +String _$classWatchGeneratedRootButMissingDependenciesHash() => + r'e36d7126a86ea9ded6dc66a6f33eabb2724455a9'; + +abstract class _$ClassWatchGeneratedRootButMissingDependencies + extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} -typedef SpecifiedDependencyButNeverUsedRef = Ref; +typedef Regression2348Ref = Ref; -@ProviderFor(specifiedDependencyButNeverUsed) -const specifiedDependencyButNeverUsedProvider = - SpecifiedDependencyButNeverUsedProvider._(); +@ProviderFor(regression2348) +const regression2348Provider = Regression2348Provider._(); -final class SpecifiedDependencyButNeverUsedProvider - extends $FunctionalProvider - with $Provider { - const SpecifiedDependencyButNeverUsedProvider._( +final class Regression2348Provider + extends $FunctionalProvider + with $Provider { + const Regression2348Provider._( {int Function( - SpecifiedDependencyButNeverUsedRef ref, + Regression2348Ref ref, )? create}) : _createCb = create, super( from: null, argument: null, - name: r'specifiedDependencyButNeverUsedProvider', + name: r'regression2348Provider', isAutoDispose: true, - dependencies: const [ - depProvider, - generatedRootProvider - ], + dependencies: const [generatedScopedProvider], allTransitiveDependencies: const [ - SpecifiedDependencyButNeverUsedProvider.$allTransitiveDependencies0, - SpecifiedDependencyButNeverUsedProvider.$allTransitiveDependencies1, + Regression2348Provider.$allTransitiveDependencies0, ], ); - static const $allTransitiveDependencies0 = depProvider; - static const $allTransitiveDependencies1 = generatedRootProvider; + static const $allTransitiveDependencies0 = generatedScopedProvider; final int Function( - SpecifiedDependencyButNeverUsedRef ref, + Regression2348Ref ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$specifiedDependencyButNeverUsedHash(); + String debugGetCreateSourceHash() => _$regression2348Hash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -1152,56 +883,48 @@ final class SpecifiedDependencyButNeverUsedProvider $ProviderElement(this, container); @override - SpecifiedDependencyButNeverUsedProvider $copyWithCreate( + Regression2348Provider $copyWithCreate( int Function( - SpecifiedDependencyButNeverUsedRef ref, + Regression2348Ref ref, ) create, ) { - return SpecifiedDependencyButNeverUsedProvider._(create: create); + return Regression2348Provider._(create: create); } @override - int create(SpecifiedDependencyButNeverUsedRef ref) { - final _$cb = _createCb ?? specifiedDependencyButNeverUsed; + int create(Regression2348Ref ref) { + final _$cb = _createCb ?? regression2348; return _$cb(ref); } } -String _$specifiedDependencyButNeverUsedHash() => - r'b0254ee8c3a0360ec249686083f430b12f3b4940'; - -typedef Regression2348Ref = Ref; +String _$regression2348Hash() => r'72fbbe420e9835c9843c28b7c9375ca3d99ca4b7'; -@ProviderFor(regression2348) -const regression2348Provider = Regression2348Provider._(); +@ProviderFor(Regression2417) +const regression2417Provider = Regression2417Provider._(); -final class Regression2348Provider - extends $FunctionalProvider - with $Provider { - const Regression2348Provider._( - {int Function( - Regression2348Ref ref, - )? create}) +final class Regression2417Provider + extends $NotifierProvider { + const Regression2417Provider._( + {super.runNotifierBuildOverride, Regression2417 Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'regression2348Provider', + name: r'regression2417Provider', isAutoDispose: true, dependencies: const [generatedScopedProvider], allTransitiveDependencies: const [ - Regression2348Provider.$allTransitiveDependencies0, + Regression2417Provider.$allTransitiveDependencies0, ], ); static const $allTransitiveDependencies0 = generatedScopedProvider; - final int Function( - Regression2348Ref ref, - )? _createCb; + final Regression2417 Function()? _createCb; @override - String debugGetCreateSourceHash() => _$regression2348Hash(); + String debugGetCreateSourceHash() => _$regression2417Hash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -1213,26 +936,42 @@ final class Regression2348Provider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + Regression2417 create() => _createCb?.call() ?? Regression2417(); + @$internal @override - Regression2348Provider $copyWithCreate( - int Function( - Regression2348Ref ref, - ) create, + Regression2417Provider $copyWithCreate( + Regression2417 Function() create, ) { - return Regression2348Provider._(create: create); + return Regression2417Provider._(create: create); } + @$internal @override - int create(Regression2348Ref ref) { - final _$cb = _createCb ?? regression2348; - return _$cb(ref); + Regression2417Provider $copyWithBuild( + int Function( + Ref, + Regression2417, + ) build, + ) { + return Regression2417Provider._(runNotifierBuildOverride: build); } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -String _$regression2348Hash() => r'72fbbe420e9835c9843c28b7c9375ca3d99ca4b7'; +String _$regression2417Hash() => r'c9ac0ba44e849ea1460c79c1f676feba1b5400da'; + +abstract class _$Regression2417 extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} typedef FamilyDepRef = Ref; @@ -1568,109 +1307,26 @@ final class AliasProvider extends $FunctionalProvider String _$aliasHash() => r'871c6c7ab22e4bbed2dc46917daf42e7fc1b9d88'; -@ProviderFor(ClassWatchGeneratedRootButMissingDependencies) -const classWatchGeneratedRootButMissingDependenciesProvider = - ClassWatchGeneratedRootButMissingDependenciesProvider._(); - -final class ClassWatchGeneratedRootButMissingDependenciesProvider - extends $NotifierProvider { - const ClassWatchGeneratedRootButMissingDependenciesProvider._( - {super.runNotifierBuildOverride, - ClassWatchGeneratedRootButMissingDependencies Function()? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'classWatchGeneratedRootButMissingDependenciesProvider', - isAutoDispose: true, - dependencies: const [], - allTransitiveDependencies: const [], - ); - - final ClassWatchGeneratedRootButMissingDependencies Function()? _createCb; - - @override - String debugGetCreateSourceHash() => - _$classWatchGeneratedRootButMissingDependenciesHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - ClassWatchGeneratedRootButMissingDependencies create() => - _createCb?.call() ?? ClassWatchGeneratedRootButMissingDependencies(); - - @$internal - @override - ClassWatchGeneratedRootButMissingDependenciesProvider $copyWithCreate( - ClassWatchGeneratedRootButMissingDependencies Function() create, - ) { - return ClassWatchGeneratedRootButMissingDependenciesProvider._( - create: create); - } - - @$internal - @override - ClassWatchGeneratedRootButMissingDependenciesProvider $copyWithBuild( - int Function( - Ref, - ClassWatchGeneratedRootButMissingDependencies, - ) build, - ) { - return ClassWatchGeneratedRootButMissingDependenciesProvider._( - runNotifierBuildOverride: build); - } - - @$internal - @override - $NotifierProviderElement - $createElement(ProviderContainer container) => - $NotifierProviderElement(this, container); -} - -String _$classWatchGeneratedRootButMissingDependenciesHash() => - r'e36d7126a86ea9ded6dc66a6f33eabb2724455a9'; - -abstract class _$ClassWatchGeneratedRootButMissingDependencies - extends $Notifier { - int build(); - @$internal - @override - int runBuild() => build(); -} - -@ProviderFor(ClassWatchGeneratedScopedButMissingDependencies) -const classWatchGeneratedScopedButMissingDependenciesProvider = - ClassWatchGeneratedScopedButMissingDependenciesProvider._(); +@ProviderFor(AliasClass) +const aliasClassProvider = AliasClassProvider._(); -final class ClassWatchGeneratedScopedButMissingDependenciesProvider - extends $NotifierProvider { - const ClassWatchGeneratedScopedButMissingDependenciesProvider._( - {super.runNotifierBuildOverride, - ClassWatchGeneratedScopedButMissingDependencies Function()? create}) +final class AliasClassProvider extends $NotifierProvider { + const AliasClassProvider._( + {super.runNotifierBuildOverride, AliasClass Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'classWatchGeneratedScopedButMissingDependenciesProvider', + name: r'aliasClassProvider', isAutoDispose: true, - dependencies: const [], - allTransitiveDependencies: const [], + dependencies: null, + allTransitiveDependencies: null, ); - final ClassWatchGeneratedScopedButMissingDependencies Function()? _createCb; + final AliasClass Function()? _createCb; @override - String debugGetCreateSourceHash() => - _$classWatchGeneratedScopedButMissingDependenciesHash(); + String debugGetCreateSourceHash() => _$aliasClassHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -1682,73 +1338,68 @@ final class ClassWatchGeneratedScopedButMissingDependenciesProvider @$internal @override - ClassWatchGeneratedScopedButMissingDependencies create() => - _createCb?.call() ?? ClassWatchGeneratedScopedButMissingDependencies(); + AliasClass create() => _createCb?.call() ?? AliasClass(); @$internal @override - ClassWatchGeneratedScopedButMissingDependenciesProvider $copyWithCreate( - ClassWatchGeneratedScopedButMissingDependencies Function() create, + AliasClassProvider $copyWithCreate( + AliasClass Function() create, ) { - return ClassWatchGeneratedScopedButMissingDependenciesProvider._( - create: create); + return AliasClassProvider._(create: create); } @$internal @override - ClassWatchGeneratedScopedButMissingDependenciesProvider $copyWithBuild( + AliasClassProvider $copyWithBuild( int Function( Ref, - ClassWatchGeneratedScopedButMissingDependencies, + AliasClass, ) build, ) { - return ClassWatchGeneratedScopedButMissingDependenciesProvider._( - runNotifierBuildOverride: build); + return AliasClassProvider._(runNotifierBuildOverride: build); } @$internal @override - $NotifierProviderElement - $createElement(ProviderContainer container) => - $NotifierProviderElement(this, container); + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -String _$classWatchGeneratedScopedButMissingDependenciesHash() => - r'f5a5ba5f572ee2d0654c89de9e991cef9f15b936'; +String _$aliasClassHash() => r'f5c1f43e7541638274ca7dc334a713763c9c8071'; -abstract class _$ClassWatchGeneratedScopedButMissingDependencies - extends $Notifier { +abstract class _$AliasClass extends $Notifier { int build(); @$internal @override int runBuild() => build(); } -@ProviderFor(Regression2417) -const regression2417Provider = Regression2417Provider._(); +@ProviderFor(RiverpodDependencies) +const riverpodDependenciesProvider = RiverpodDependenciesProvider._(); -final class Regression2417Provider - extends $NotifierProvider { - const Regression2417Provider._( - {super.runNotifierBuildOverride, Regression2417 Function()? create}) +final class RiverpodDependenciesProvider + extends $NotifierProvider { + const RiverpodDependenciesProvider._( + {super.runNotifierBuildOverride, RiverpodDependencies Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'regression2417Provider', + name: r'riverpodDependenciesProvider', isAutoDispose: true, - dependencies: const [generatedScopedProvider], + dependencies: const [depProvider], allTransitiveDependencies: const [ - Regression2417Provider.$allTransitiveDependencies0, + RiverpodDependenciesProvider.$allTransitiveDependencies0, ], ); - static const $allTransitiveDependencies0 = generatedScopedProvider; + static const $allTransitiveDependencies0 = depProvider; - final Regression2417 Function()? _createCb; + final RiverpodDependencies Function()? _createCb; @override - String debugGetCreateSourceHash() => _$regression2417Hash(); + String debugGetCreateSourceHash() => _$riverpodDependenciesHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -1760,63 +1411,71 @@ final class Regression2417Provider @$internal @override - Regression2417 create() => _createCb?.call() ?? Regression2417(); + RiverpodDependencies create() => _createCb?.call() ?? RiverpodDependencies(); @$internal @override - Regression2417Provider $copyWithCreate( - Regression2417 Function() create, + RiverpodDependenciesProvider $copyWithCreate( + RiverpodDependencies Function() create, ) { - return Regression2417Provider._(create: create); + return RiverpodDependenciesProvider._(create: create); } @$internal @override - Regression2417Provider $copyWithBuild( + RiverpodDependenciesProvider $copyWithBuild( int Function( Ref, - Regression2417, + RiverpodDependencies, ) build, ) { - return Regression2417Provider._(runNotifierBuildOverride: build); + return RiverpodDependenciesProvider._(runNotifierBuildOverride: build); } @$internal @override - $NotifierProviderElement $createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } -String _$regression2417Hash() => r'c9ac0ba44e849ea1460c79c1f676feba1b5400da'; +String _$riverpodDependenciesHash() => + r'a0a94e21f6d98df529e4e8a469ed3aec5af37061'; -abstract class _$Regression2417 extends $Notifier { +abstract class _$RiverpodDependencies extends $Notifier { int build(); @$internal @override int runBuild() => build(); } -@ProviderFor(AliasClass) -const aliasClassProvider = AliasClassProvider._(); +typedef FooRef = Ref; -final class AliasClassProvider extends $NotifierProvider { - const AliasClassProvider._( - {super.runNotifierBuildOverride, AliasClass Function()? create}) +@ProviderFor(foo) +const fooProvider = FooProvider._(); + +final class FooProvider extends $FunctionalProvider + with $Provider { + const FooProvider._( + {int Function( + FooRef ref, + )? create}) : _createCb = create, super( from: null, argument: null, - name: r'aliasClassProvider', + name: r'fooProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final AliasClass Function()? _createCb; + final int Function( + FooRef ref, + )? _createCb; @override - String debugGetCreateSourceHash() => _$aliasClassHash(); + String debugGetCreateSourceHash() => _$fooHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -1828,43 +1487,26 @@ final class AliasClassProvider extends $NotifierProvider { @$internal @override - AliasClass create() => _createCb?.call() ?? AliasClass(); - - @$internal - @override - AliasClassProvider $copyWithCreate( - AliasClass Function() create, - ) { - return AliasClassProvider._(create: create); - } + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - AliasClassProvider $copyWithBuild( + FooProvider $copyWithCreate( int Function( - Ref, - AliasClass, - ) build, + FooRef ref, + ) create, ) { - return AliasClassProvider._(runNotifierBuildOverride: build); + return FooProvider._(create: create); } - @$internal @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + int create(FooRef ref) { + final _$cb = _createCb ?? foo; + return _$cb(ref); + } } -String _$aliasClassHash() => r'f5c1f43e7541638274ca7dc334a713763c9c8071'; - -abstract class _$AliasClass extends $Notifier { - int build(); - @$internal - @override - int runBuild() => build(); -} +String _$fooHash() => r'f9ce60fe868c2c54aa282702554861a13e8871cd'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.dart b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.dart new file mode 100644 index 000000000..d7d9cedde --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.dart @@ -0,0 +1,225 @@ +import 'package:flutter/widgets.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'provider_dependencies.g.dart'; + +@Riverpod(dependencies: []) +int dep(DepRef ref) => 0; + +@Riverpod(dependencies: []) +int dep2(Dep2Ref ref) => 0; + +@Riverpod(dependencies: []) +int depFamily(DepFamilyRef ref, int id) => 0; + +// expect_lint: provider_dependencies +@Dependencies([dep]) +void depFn() {} + +// expect_lint: provider_dependencies +@Dependencies([depFamily]) +void depFamilyFn() {} + +@Dependencies([dep]) +class DepWidget extends StatelessWidget { + const DepWidget({super.key, this.child}); + final Widget? child; + + @override + Widget build(BuildContext context) { + depFn(); + return const Placeholder(); + } +} + +@Dependencies([depFamily]) +class DepFamily extends StatelessWidget { + const DepFamily({super.key, this.child}); + final Widget? child; + + @override + Widget build(BuildContext context) { + depFamilyFn(); + return const Placeholder(); + } +} + +//////////// + +// expect_lint: provider_dependencies +@riverpod +int plainAnnotation(PlainAnnotationRef ref) { + ref.watch(depProvider); + return 0; +} + +// expect_lint: provider_dependencies +@Riverpod(keepAlive: false) +int customAnnotation(CustomAnnotationRef ref) { + ref.watch(depProvider); + return 0; +} + +// expect_lint: provider_dependencies +@Riverpod( + keepAlive: false, +) +int customAnnotationWithTrailingComma( + CustomAnnotationWithTrailingCommaRef ref, +) { + ref.watch(depProvider); + return 0; +} + +@Riverpod( + keepAlive: false, + // expect_lint: provider_dependencies + dependencies: [], +) +int existingDep(ExistingDepRef ref) { + ref.watch(depProvider); + return 0; +} + +@Riverpod( + keepAlive: false, + // expect_lint: provider_dependencies + dependencies: [], +) +int multipleDeps(MultipleDepsRef ref) { + ref.watch(depProvider); + ref.watch(dep2Provider); + return 0; +} + +class Scope extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return ProviderScope( + overrides: [depProvider.overrideWithValue(42)], + child: DepWidget(), + ); + } +} + +// expect_lint: provider_dependencies +class AboveScope extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return DepWidget( + child: ProviderScope( + overrides: [depProvider.overrideWithValue(42)], + child: Container(), + ), + ); + } +} + +// expect_lint: provider_dependencies +class Scope2 extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return ProviderScope( + overrides: [depProvider.overrideWithValue(42)], + child: Text('${ref.watch(depProvider)}'), + ); + } +} + +// expect_lint: provider_dependencies +class ConditionalScope extends ConsumerWidget { + ConditionalScope({super.key, required this.condition}); + final bool condition; + + @override + Widget build(BuildContext context, WidgetRef ref) { + return ProviderScope( + overrides: [ + if (condition) depProvider.overrideWithValue(42), + ], + child: DepWidget(), + ); + } +} + +class Scope4 extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return ProviderScope( + overrides: [depFamilyProvider.overrideWith((ref, arg) => 0)], + child: DepFamily(), + ); + } +} + +class SupportsMultipleScopes extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + ProviderScope( + overrides: [depProvider.overrideWith((ref) => 0)], + child: DepWidget(), + ); + + return ProviderScope( + overrides: [depFamilyProvider.overrideWith((ref, arg) => 0)], + child: DepFamily(), + ); + } +} + +// expect_lint: provider_dependencies +class SupportsMultipleScopes2 extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + ProviderScope( + overrides: [depProvider.overrideWith((ref) => 0)], + child: DepFamily(), + ); + + return ProviderScope( + overrides: [depFamilyProvider.overrideWith((ref, arg) => 0)], + child: DepWidget(), + ); + } +} + +class SupportsNestedScopes extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return ProviderScope( + overrides: [depFamilyProvider.overrideWith((ref, arg) => 0)], + child: ProviderScope( + overrides: [depProvider.overrideWith((ref) => 0)], + child: DepFamily( + child: DepWidget(), + ), + ), + ); + } +} + +// expect_lint: provider_dependencies +class IncompleteFamilyOverride extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return ProviderScope( + overrides: [depFamilyProvider(42).overrideWith((ref) => 0)], + child: DepFamily(), + ); + } +} + +@Dependencies([dep]) +class NotFoundWidget extends ConsumerStatefulWidget { + @override + _NotFoundWidgetState createState() => _NotFoundWidgetState(); +} + +class _NotFoundWidgetState extends ConsumerState { + @override + Widget build(BuildContext context) { + ref.watch(depProvider); + return const Placeholder(); + } +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.diff b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.diff new file mode 100644 index 000000000..3a54a3879 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.diff @@ -0,0 +1,149 @@ +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:17`: +``` + +// expect_lint: provider_dependencies +- @Dependencies([dep]) ++ +void depFn() {} + +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:21`: +``` + +// expect_lint: provider_dependencies +- @Dependencies([depFamily]) ++ +void depFamilyFn() {} + +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:51`: +``` + +// expect_lint: provider_dependencies +- @riverpod ++ @Riverpod(dependencies: [dep]) +int plainAnnotation(PlainAnnotationRef ref) { + ref.watch(depProvider); +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:58`: +``` + +// expect_lint: provider_dependencies +- @Riverpod(keepAlive: false) ++ @Riverpod(keepAlive: false, dependencies: [dep]) +int customAnnotation(CustomAnnotationRef ref) { + ref.watch(depProvider); +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:66`: +``` +// expect_lint: provider_dependencies +@Riverpod( +- keepAlive: false, ++ keepAlive: false, dependencies: [dep], +) +int customAnnotationWithTrailingComma( +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:78`: +``` + keepAlive: false, + // expect_lint: provider_dependencies +- dependencies: [], ++ dependencies: [dep], +) +int existingDep(ExistingDepRef ref) { +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:88`: +``` + keepAlive: false, + // expect_lint: provider_dependencies +- dependencies: [], ++ dependencies: [dep, dep2], +) +int multipleDeps(MultipleDepsRef ref) { +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:107`: +``` + +// expect_lint: provider_dependencies +- class AboveScope extends ConsumerWidget { ++ @Dependencies([dep]) ++ class AboveScope extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:120`: +``` + +// expect_lint: provider_dependencies +- class Scope2 extends ConsumerWidget { ++ @Dependencies([dep]) ++ class Scope2 extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:131`: +``` + +// expect_lint: provider_dependencies +- class ConditionalScope extends ConsumerWidget { ++ @Dependencies([dep]) ++ class ConditionalScope extends ConsumerWidget { + ConditionalScope({super.key, required this.condition}); + final bool condition; +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:172`: +``` + +// expect_lint: provider_dependencies +- class SupportsMultipleScopes2 extends ConsumerWidget { ++ @Dependencies([depFamily, dep]) ++ class SupportsMultipleScopes2 extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { +``` +--- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:203`: +``` + +// expect_lint: provider_dependencies +- class IncompleteFamilyOverride extends ConsumerWidget { ++ @Dependencies([depFamily]) ++ class IncompleteFamilyOverride extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.g.dart new file mode 100644 index 000000000..0e6ea613a --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.g.dart @@ -0,0 +1,571 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'provider_dependencies.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef DepRef = Ref; + +@ProviderFor(dep) +const depProvider = DepProvider._(); + +final class DepProvider extends $FunctionalProvider + with $Provider { + const DepProvider._( + {int Function( + DepRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'depProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + DepRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$depHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DepProvider $copyWithCreate( + int Function( + DepRef ref, + ) create, + ) { + return DepProvider._(create: create); + } + + @override + int create(DepRef ref) { + final _$cb = _createCb ?? dep; + return _$cb(ref); + } +} + +String _$depHash() => r'749c4d696d29c72686cabcabd6fa7855f5cbf4db'; + +typedef Dep2Ref = Ref; + +@ProviderFor(dep2) +const dep2Provider = Dep2Provider._(); + +final class Dep2Provider extends $FunctionalProvider + with $Provider { + const Dep2Provider._( + {int Function( + Dep2Ref ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'dep2Provider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + Dep2Ref ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$dep2Hash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + Dep2Provider $copyWithCreate( + int Function( + Dep2Ref ref, + ) create, + ) { + return Dep2Provider._(create: create); + } + + @override + int create(Dep2Ref ref) { + final _$cb = _createCb ?? dep2; + return _$cb(ref); + } +} + +String _$dep2Hash() => r'13cd909366c79168e3d9cd95f529ddbcee6de7dc'; + +typedef DepFamilyRef = Ref; + +@ProviderFor(depFamily) +const depFamilyProvider = DepFamilyFamily._(); + +final class DepFamilyProvider + extends $FunctionalProvider + with $Provider { + const DepFamilyProvider._( + {required DepFamilyFamily super.from, + required int super.argument, + int Function( + DepFamilyRef ref, + int id, + )? create}) + : _createCb = create, + super( + name: r'depFamilyProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + DepFamilyRef ref, + int id, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$depFamilyHash(); + + @override + String toString() { + return r'depFamilyProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + DepFamilyProvider $copyWithCreate( + int Function( + DepFamilyRef ref, + ) create, + ) { + return DepFamilyProvider._( + argument: argument as int, + from: from! as DepFamilyFamily, + create: ( + ref, + int id, + ) => + create(ref)); + } + + @override + int create(DepFamilyRef ref) { + final _$cb = _createCb ?? depFamily; + final argument = this.argument as int; + return _$cb( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is DepFamilyProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$depFamilyHash() => r'c11006a8b9718af9899999b7c49f78cf3423f558'; + +final class DepFamilyFamily extends Family { + const DepFamilyFamily._() + : super( + name: r'depFamilyProvider', + dependencies: const [], + allTransitiveDependencies: const [], + isAutoDispose: true, + ); + + DepFamilyProvider call( + int id, + ) => + DepFamilyProvider._(argument: id, from: this); + + @override + String debugGetCreateSourceHash() => _$depFamilyHash(); + + @override + String toString() => r'depFamilyProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + int Function( + DepFamilyRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as DepFamilyProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(container); + }, + ); + } +} + +//////////// +// expect_lint: provider_dependencies +typedef PlainAnnotationRef = Ref; + +//////////// +// expect_lint: provider_dependencies +@ProviderFor(plainAnnotation) +const plainAnnotationProvider = PlainAnnotationProvider._(); + +//////////// +// expect_lint: provider_dependencies +final class PlainAnnotationProvider + extends $FunctionalProvider + with $Provider { + //////////// +// expect_lint: provider_dependencies + const PlainAnnotationProvider._( + {int Function( + PlainAnnotationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'plainAnnotationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + PlainAnnotationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$plainAnnotationHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + PlainAnnotationProvider $copyWithCreate( + int Function( + PlainAnnotationRef ref, + ) create, + ) { + return PlainAnnotationProvider._(create: create); + } + + @override + int create(PlainAnnotationRef ref) { + final _$cb = _createCb ?? plainAnnotation; + return _$cb(ref); + } +} + +String _$plainAnnotationHash() => r'ceeb01dfcbd115f3676c8e38ce35a03cff16246b'; + +typedef CustomAnnotationRef = Ref; + +@ProviderFor(customAnnotation) +const customAnnotationProvider = CustomAnnotationProvider._(); + +final class CustomAnnotationProvider + extends $FunctionalProvider + with $Provider { + const CustomAnnotationProvider._( + {int Function( + CustomAnnotationRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'customAnnotationProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CustomAnnotationRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$customAnnotationHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CustomAnnotationProvider $copyWithCreate( + int Function( + CustomAnnotationRef ref, + ) create, + ) { + return CustomAnnotationProvider._(create: create); + } + + @override + int create(CustomAnnotationRef ref) { + final _$cb = _createCb ?? customAnnotation; + return _$cb(ref); + } +} + +String _$customAnnotationHash() => r'04faed9b424be360e594870f91c4ef4689f05672'; + +typedef CustomAnnotationWithTrailingCommaRef = Ref; + +@ProviderFor(customAnnotationWithTrailingComma) +const customAnnotationWithTrailingCommaProvider = + CustomAnnotationWithTrailingCommaProvider._(); + +final class CustomAnnotationWithTrailingCommaProvider + extends $FunctionalProvider + with $Provider { + const CustomAnnotationWithTrailingCommaProvider._( + {int Function( + CustomAnnotationWithTrailingCommaRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'customAnnotationWithTrailingCommaProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CustomAnnotationWithTrailingCommaRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$customAnnotationWithTrailingCommaHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CustomAnnotationWithTrailingCommaProvider $copyWithCreate( + int Function( + CustomAnnotationWithTrailingCommaRef ref, + ) create, + ) { + return CustomAnnotationWithTrailingCommaProvider._(create: create); + } + + @override + int create(CustomAnnotationWithTrailingCommaRef ref) { + final _$cb = _createCb ?? customAnnotationWithTrailingComma; + return _$cb(ref); + } +} + +String _$customAnnotationWithTrailingCommaHash() => + r'b5c62d769dfc53d6d77e8fde9e0eb7d8a0ab9d18'; + +typedef ExistingDepRef = Ref; + +@ProviderFor(existingDep) +const existingDepProvider = ExistingDepProvider._(); + +final class ExistingDepProvider + extends $FunctionalProvider + with $Provider { + const ExistingDepProvider._( + {int Function( + ExistingDepRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'existingDepProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + ExistingDepRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$existingDepHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ExistingDepProvider $copyWithCreate( + int Function( + ExistingDepRef ref, + ) create, + ) { + return ExistingDepProvider._(create: create); + } + + @override + int create(ExistingDepRef ref) { + final _$cb = _createCb ?? existingDep; + return _$cb(ref); + } +} + +String _$existingDepHash() => r'8d7866d1af7e350d7c792e43a542cd47b130b239'; + +typedef MultipleDepsRef = Ref; + +@ProviderFor(multipleDeps) +const multipleDepsProvider = MultipleDepsProvider._(); + +final class MultipleDepsProvider + extends $FunctionalProvider + with $Provider { + const MultipleDepsProvider._( + {int Function( + MultipleDepsRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'multipleDepsProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + MultipleDepsRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$multipleDepsHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + MultipleDepsProvider $copyWithCreate( + int Function( + MultipleDepsRef ref, + ) create, + ) { + return MultipleDepsProvider._(create: create); + } + + @override + int create(MultipleDepsRef ref) { + final _$cb = _createCb ?? multipleDeps; + return _$cb(ref); + } +} + +String _$multipleDepsHash() => r'9d08791636a0435ba115062a453d0d9e530ecf71'; + +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies_test.dart b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies_test.dart new file mode 100644 index 000000000..bb49b01f4 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies_test.dart @@ -0,0 +1,41 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod_lint/src/lints/provider_dependencies.dart'; + +import '../../golden.dart'; + +void main() { + testGolden( + 'Verifies if some scoped providers are used but not specified as dependency', + 'lints/missing_provider_dependency/provider_dependencies.diff', + sourcePath: + 'test/lints/missing_provider_dependency/provider_dependencies.dart', + (result) async { + const lint = ProviderDependencies(); + final fix = lint.getFixes().single; + + final errors = await lint.testRun(result); + final changes = await Future.wait([ + for (final error in errors) fix.testRun(result, error, errors), + ]); + + return changes.flattened; + }, + ); + + testGolden( + 'Verifies if some scoped providers are used but not specified as dependency', + 'lints/missing_provider_dependency/dependencies.diff', + sourcePath: 'test/lints/missing_provider_dependency/dependencies.dart', + (result) async { + const lint = ProviderDependencies(); + final fix = lint.getFixes().single; + + final errors = await lint.testRun(result); + final changes = await Future.wait([ + for (final error in errors) fix.testRun(result, error, errors), + ]); + + return changes.flattened; + }, + ); +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart index 1b499dbc7..ab7417e46 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart @@ -902,6 +902,5 @@ abstract class _$WrongOrder extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart index b0efa12ef..88140125f 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart @@ -66,34 +66,27 @@ final class KeepAliveProvider String _$keepAliveHash() => r'756ceaba79af550d4498a93ec30118f989cd5bb4'; -typedef AutoDisposeRef = Ref; - -@ProviderFor(autoDispose) -const autoDisposeProvider = AutoDisposeProvider._(); +@ProviderFor(KeepAliveClass) +const keepAliveClassProvider = KeepAliveClassProvider._(); -final class AutoDisposeProvider - extends $FunctionalProvider - with $Provider { - const AutoDisposeProvider._( - {int Function( - AutoDisposeRef ref, - )? create}) +final class KeepAliveClassProvider + extends $NotifierProvider { + const KeepAliveClassProvider._( + {super.runNotifierBuildOverride, KeepAliveClass Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'autoDisposeProvider', - isAutoDispose: true, + name: r'keepAliveClassProvider', + isAutoDispose: false, dependencies: null, allTransitiveDependencies: null, ); - final int Function( - AutoDisposeRef ref, - )? _createCb; + final KeepAliveClass Function()? _createCb; @override - String debugGetCreateSourceHash() => _$autoDisposeHash(); + String debugGetCreateSourceHash() => _$keepAliveClassHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -105,54 +98,71 @@ final class AutoDisposeProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + KeepAliveClass create() => _createCb?.call() ?? KeepAliveClass(); + @$internal @override - AutoDisposeProvider $copyWithCreate( - int Function( - AutoDisposeRef ref, - ) create, + KeepAliveClassProvider $copyWithCreate( + KeepAliveClass Function() create, ) { - return AutoDisposeProvider._(create: create); + return KeepAliveClassProvider._(create: create); } + @$internal @override - int create(AutoDisposeRef ref) { - final _$cb = _createCb ?? autoDispose; - return _$cb(ref); + KeepAliveClassProvider $copyWithBuild( + int Function( + Ref, + KeepAliveClass, + ) build, + ) { + return KeepAliveClassProvider._(runNotifierBuildOverride: build); } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -String _$autoDisposeHash() => r'd46d894171aed556a8b4deafeda4de6b9465f632'; +String _$keepAliveClassHash() => r'e2fffa4d14837dfef71f6a2cc230b826b82541ea'; -typedef FnRef = Ref; +abstract class _$KeepAliveClass extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} -@ProviderFor(fn) -const fnProvider = FnProvider._(); +typedef AutoDisposeRef = Ref; -final class FnProvider extends $FunctionalProvider - with $Provider { - const FnProvider._( +@ProviderFor(autoDispose) +const autoDisposeProvider = AutoDisposeProvider._(); + +final class AutoDisposeProvider + extends $FunctionalProvider + with $Provider { + const AutoDisposeProvider._( {int Function( - FnRef ref, + AutoDisposeRef ref, )? create}) : _createCb = create, super( from: null, argument: null, - name: r'fnProvider', - isAutoDispose: false, + name: r'autoDisposeProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); final int Function( - FnRef ref, + AutoDisposeRef ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$fnHash(); + String debugGetCreateSourceHash() => _$autoDisposeHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -168,44 +178,44 @@ final class FnProvider extends $FunctionalProvider $ProviderElement(this, container); @override - FnProvider $copyWithCreate( + AutoDisposeProvider $copyWithCreate( int Function( - FnRef ref, + AutoDisposeRef ref, ) create, ) { - return FnProvider._(create: create); + return AutoDisposeProvider._(create: create); } @override - int create(FnRef ref) { - final _$cb = _createCb ?? fn; + int create(AutoDisposeRef ref) { + final _$cb = _createCb ?? autoDispose; return _$cb(ref); } } -String _$fnHash() => r'9e89e9bead8aa30a86f31bd16f4106c4b38e8f2b'; +String _$autoDisposeHash() => r'd46d894171aed556a8b4deafeda4de6b9465f632'; -@ProviderFor(KeepAliveClass) -const keepAliveClassProvider = KeepAliveClassProvider._(); +@ProviderFor(AutoDisposeClass) +const autoDisposeClassProvider = AutoDisposeClassProvider._(); -final class KeepAliveClassProvider - extends $NotifierProvider { - const KeepAliveClassProvider._( - {super.runNotifierBuildOverride, KeepAliveClass Function()? create}) +final class AutoDisposeClassProvider + extends $NotifierProvider { + const AutoDisposeClassProvider._( + {super.runNotifierBuildOverride, AutoDisposeClass Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'keepAliveClassProvider', - isAutoDispose: false, + name: r'autoDisposeClassProvider', + isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final KeepAliveClass Function()? _createCb; + final AutoDisposeClass Function()? _createCb; @override - String debugGetCreateSourceHash() => _$keepAliveClassHash(); + String debugGetCreateSourceHash() => _$autoDisposeClassHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -217,64 +227,70 @@ final class KeepAliveClassProvider @$internal @override - KeepAliveClass create() => _createCb?.call() ?? KeepAliveClass(); + AutoDisposeClass create() => _createCb?.call() ?? AutoDisposeClass(); @$internal @override - KeepAliveClassProvider $copyWithCreate( - KeepAliveClass Function() create, + AutoDisposeClassProvider $copyWithCreate( + AutoDisposeClass Function() create, ) { - return KeepAliveClassProvider._(create: create); + return AutoDisposeClassProvider._(create: create); } @$internal @override - KeepAliveClassProvider $copyWithBuild( + AutoDisposeClassProvider $copyWithBuild( int Function( Ref, - KeepAliveClass, + AutoDisposeClass, ) build, ) { - return KeepAliveClassProvider._(runNotifierBuildOverride: build); + return AutoDisposeClassProvider._(runNotifierBuildOverride: build); } @$internal @override - $NotifierProviderElement $createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => $NotifierProviderElement(this, container); } -String _$keepAliveClassHash() => r'e2fffa4d14837dfef71f6a2cc230b826b82541ea'; +String _$autoDisposeClassHash() => r'5127ab94f7ab4ccf90deb3fca90d7a3c3c4c83f5'; -abstract class _$KeepAliveClass extends $Notifier { +abstract class _$AutoDisposeClass extends $Notifier { int build(); @$internal @override int runBuild() => build(); } -@ProviderFor(AutoDisposeClass) -const autoDisposeClassProvider = AutoDisposeClassProvider._(); +typedef FnRef = Ref; -final class AutoDisposeClassProvider - extends $NotifierProvider { - const AutoDisposeClassProvider._( - {super.runNotifierBuildOverride, AutoDisposeClass Function()? create}) +@ProviderFor(fn) +const fnProvider = FnProvider._(); + +final class FnProvider extends $FunctionalProvider + with $Provider { + const FnProvider._( + {int Function( + FnRef ref, + )? create}) : _createCb = create, super( from: null, argument: null, - name: r'autoDisposeClassProvider', - isAutoDispose: true, + name: r'fnProvider', + isAutoDispose: false, dependencies: null, allTransitiveDependencies: null, ); - final AutoDisposeClass Function()? _createCb; + final int Function( + FnRef ref, + )? _createCb; @override - String debugGetCreateSourceHash() => _$autoDisposeClassHash(); + String debugGetCreateSourceHash() => _$fnHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -286,43 +302,26 @@ final class AutoDisposeClassProvider @$internal @override - AutoDisposeClass create() => _createCb?.call() ?? AutoDisposeClass(); - - @$internal - @override - AutoDisposeClassProvider $copyWithCreate( - AutoDisposeClass Function() create, - ) { - return AutoDisposeClassProvider._(create: create); - } + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - AutoDisposeClassProvider $copyWithBuild( + FnProvider $copyWithCreate( int Function( - Ref, - AutoDisposeClass, - ) build, + FnRef ref, + ) create, ) { - return AutoDisposeClassProvider._(runNotifierBuildOverride: build); + return FnProvider._(create: create); } - @$internal @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + int create(FnRef ref) { + final _$cb = _createCb ?? fn; + return _$cb(ref); + } } -String _$autoDisposeClassHash() => r'5127ab94f7ab4ccf90deb3fca90d7a3c3c4c83f5'; - -abstract class _$AutoDisposeClass extends $Notifier { - int build(); - @$internal - @override - int runBuild() => build(); -} +String _$fnHash() => r'9e89e9bead8aa30a86f31bd16f4106c4b38e8f2b'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index 91deb5a6a..9a5563a8e 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -1186,6 +1186,5 @@ abstract class _$B2 extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.dart deleted file mode 100644 index 3a9e84f21..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.dart +++ /dev/null @@ -1,108 +0,0 @@ -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -part 'provider_dependencies.g.dart'; - -@Riverpod(dependencies: []) -int dep(DepRef ref) => 0; - -@Riverpod(dependencies: []) -int dep2(Dep2Ref ref) => 0; - -//////////// - -// expect_lint: provider_dependencies -@riverpod -int plainAnnotation(PlainAnnotationRef ref) { - ref.watch(depProvider); - return 0; -} - -// expect_lint: provider_dependencies -@Riverpod(keepAlive: false) -int customAnnotation(CustomAnnotationRef ref) { - ref.watch(depProvider); - return 0; -} - -// expect_lint: provider_dependencies -@Riverpod( - keepAlive: false, -) -int customAnnotationWithTrailingComma( - CustomAnnotationWithTrailingCommaRef ref, -) { - ref.watch(depProvider); - return 0; -} - -@Riverpod( - keepAlive: false, - // expect_lint: provider_dependencies - dependencies: [], -) -int existingDep(ExistingDepRef ref) { - ref.watch(depProvider); - return 0; -} - -@Riverpod( - keepAlive: false, - // expect_lint: provider_dependencies - dependencies: [], -) -int multipleDeps(MultipleDepsRef ref) { - ref.watch(depProvider); - ref.watch(dep2Provider); - return 0; -} - -@Riverpod( - keepAlive: false, - dependencies: [ - // expect_lint: provider_dependencies - dep, - dep2, - ], -) -int extraDep(ExtraDepRef ref) { - ref.watch(dep2Provider); - return 0; -} - -@Riverpod( - keepAlive: false, - dependencies: [ - // expect_lint: provider_dependencies - dep, - ], -) -int noDep(NoDepRef ref) { - return 0; -} - -@Riverpod( - dependencies: [ - // expect_lint: provider_dependencies - dep, - ], - keepAlive: false, -) -int dependenciesFirstThenKeepAlive(DependenciesFirstThenKeepAliveRef ref) { - return 0; -} - -@Riverpod( - dependencies: [ - // expect_lint: provider_dependencies - dep, - ], -) -int noDepNoParam(NoDepNoParamRef ref) { - return 0; -} - -// expect_lint: provider_dependencies -@Riverpod(keepAlive: false, dependencies: [dep]) -int noDepWithoutComma(NoDepWithoutCommaRef ref) { - return 0; -} diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.diff b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.diff deleted file mode 100644 index fddcc1f43..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.diff +++ /dev/null @@ -1,137 +0,0 @@ -Message: `Specify "dependencies"` -Priority: 100 -Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:14`: -``` - -// expect_lint: provider_dependencies -- @riverpod -+ @Riverpod(dependencies: [dep]) -int plainAnnotation(PlainAnnotationRef ref) { - ref.watch(depProvider); -``` ---- -Message: `Specify "dependencies"` -Priority: 100 -Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:21`: -``` - -// expect_lint: provider_dependencies -- @Riverpod(keepAlive: false) -+ @Riverpod(keepAlive: false, dependencies: [dep]) -int customAnnotation(CustomAnnotationRef ref) { - ref.watch(depProvider); -``` ---- -Message: `Specify "dependencies"` -Priority: 100 -Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:29`: -``` -// expect_lint: provider_dependencies -@Riverpod( -- keepAlive: false, -+ keepAlive: false, dependencies: [dep], -) -int customAnnotationWithTrailingComma( -``` ---- -Message: `Update "dependencies"` -Priority: 100 -Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:41`: -``` - keepAlive: false, - // expect_lint: provider_dependencies -- dependencies: [], -+ dependencies: [dep], -) -int existingDep(ExistingDepRef ref) { -``` ---- -Message: `Update "dependencies"` -Priority: 100 -Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:51`: -``` - keepAlive: false, - // expect_lint: provider_dependencies -- dependencies: [], -+ dependencies: [dep, dep2], -) -int multipleDeps(MultipleDepsRef ref) { -``` ---- -Message: `Update "dependencies"` -Priority: 100 -Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:61`: -``` -@Riverpod( - keepAlive: false, -- dependencies: [ -- // expect_lint: provider_dependencies -- dep, -- dep2, -- ], -+ dependencies: [dep2], -) -int extraDep(ExtraDepRef ref) { -``` ---- -Message: `Remove "dependencies"` -Priority: 100 -Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:74`: -``` -@Riverpod( - keepAlive: false, -- dependencies: [ -- // expect_lint: provider_dependencies -- dep, -- ], -- ) -+ ) -int noDep(NoDepRef ref) { - return 0; -``` ---- -Message: `Remove "dependencies"` -Priority: 100 -Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:84`: -``` - -@Riverpod( -- dependencies: [ -- // expect_lint: provider_dependencies -- dep, -- ], -- keepAlive: false, -+ keepAlive: false, -) -int dependenciesFirstThenKeepAlive(DependenciesFirstThenKeepAliveRef ref) { -``` ---- -Message: `Remove "dependencies"` -Priority: 100 -Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:94`: -``` -} - -- @Riverpod( -- dependencies: [ -- // expect_lint: provider_dependencies -- dep, -- ], -- ) -+ @riverpod -int noDepNoParam(NoDepNoParamRef ref) { - return 0; -``` ---- -Message: `Remove "dependencies"` -Priority: 100 -Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:105`: -``` - -// expect_lint: provider_dependencies -- @Riverpod(keepAlive: false, dependencies: [dep]) -+ @Riverpod(keepAlive: false,) -int noDepWithoutComma(NoDepWithoutCommaRef ref) { - return 0; -``` ---- diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 7752bdbee..5c044f26d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -137,7 +137,5 @@ final class GeneratorFamily extends Family { ); } } - -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.dart index b73dea166..efb717d1c 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.dart @@ -8,12 +8,15 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'scoped_providers_should_specify_dependencies.g.dart'; +@riverpod +class UnimplementedScoped extends _$UnimplementedScoped { + @override + int build(); +} + @Riverpod(dependencies: []) int scoped(ScopedRef ref) => 0; -@riverpod -external int unimplementedScoped(); - @riverpod int root(RootRef ref) => 0; @@ -24,7 +27,8 @@ void main() { final rootContainer = ProviderContainer( overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), rootProvider.overrideWith((ref) => 0), ], ); @@ -33,7 +37,8 @@ void main() { parent: rootContainer, overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), // expect_lint: scoped_providers_should_specify_dependencies rootProvider.overrideWith((ref) => 0), ], @@ -43,7 +48,8 @@ void main() { ProviderScope( overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), rootProvider.overrideWith((ref) => 0), ], child: Container(), @@ -54,7 +60,8 @@ void main() { ProviderScope( overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), // This is not a Flutter's runApp, so the ProviderScope is considered scoped // expect_lint: scoped_providers_should_specify_dependencies rootProvider.overrideWith((ref) => 0), @@ -68,7 +75,8 @@ void main() { parent: rootContainer, overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), // expect_lint: scoped_providers_should_specify_dependencies rootProvider.overrideWith((ref) => 0), ], @@ -82,7 +90,8 @@ void definitelyNotAMain() { final rootContainer = ProviderContainer( overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), rootProvider.overrideWith((ref) => 0), ], ); @@ -91,7 +100,8 @@ void definitelyNotAMain() { parent: rootContainer, overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), // expect_lint: scoped_providers_should_specify_dependencies rootProvider.overrideWith((ref) => 0), ], @@ -101,7 +111,8 @@ void definitelyNotAMain() { ProviderScope( overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), rootProvider.overrideWith((ref) => 0), ], child: Container(), @@ -113,7 +124,8 @@ void definitelyNotAMain() { parent: rootContainer, overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), // expect_lint: scoped_providers_should_specify_dependencies rootProvider.overrideWith((ref) => 0), ], @@ -126,7 +138,8 @@ void someTestFunction() { final rootContainer = ProviderContainer( overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), rootProvider.overrideWith((ref) => 0), ], ); @@ -136,7 +149,8 @@ void someTestFunction() { ProviderScope( overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), rootProvider.overrideWith((ref) => 0), ], child: Container(), @@ -148,7 +162,8 @@ void someTestFunction() { parent: rootContainer, overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), // expect_lint: scoped_providers_should_specify_dependencies rootProvider.overrideWith((ref) => 0), ], @@ -161,7 +176,8 @@ void someTestFunction() { child: ProviderScope( overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), // expect_lint: scoped_providers_should_specify_dependencies rootProvider.overrideWith((ref) => 0), ], @@ -176,7 +192,8 @@ Widget fn() { return ProviderScope( overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), // expect_lint: scoped_providers_should_specify_dependencies rootProvider.overrideWith((ref) => 0), ], @@ -191,7 +208,8 @@ void showModal(BuildContext context) { return ProviderScope( overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), // expect_lint: scoped_providers_should_specify_dependencies rootProvider.overrideWith((ref) => 0), ], @@ -209,7 +227,8 @@ class MyWidget extends StatelessWidget { return ProviderScope( overrides: [ scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider.overrideWith((ref) => 0), + unimplementedScopedProvider + .overrideWith(() => throw UnimplementedError()), // expect_lint: scoped_providers_should_specify_dependencies rootProvider.overrideWith((ref) => 0), ], diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart index 5384fcb49..1d3e37f76 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart @@ -6,33 +6,27 @@ part of 'scoped_providers_should_specify_dependencies.dart'; // RiverpodGenerator // ************************************************************************** -typedef ScopedRef = Ref; - -@ProviderFor(scoped) -const scopedProvider = ScopedProvider._(); +@ProviderFor(UnimplementedScoped) +const unimplementedScopedProvider = UnimplementedScopedProvider._(); -final class ScopedProvider extends $FunctionalProvider - with $Provider { - const ScopedProvider._( - {int Function( - ScopedRef ref, - )? create}) +final class UnimplementedScopedProvider + extends $NotifierProvider { + const UnimplementedScopedProvider._( + {super.runNotifierBuildOverride, UnimplementedScoped Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'scopedProvider', + name: r'unimplementedScopedProvider', isAutoDispose: true, dependencies: const [], allTransitiveDependencies: const [], ); - final int Function( - ScopedRef ref, - )? _createCb; + final UnimplementedScoped Function()? _createCb; @override - String debugGetCreateSourceHash() => _$scopedHash(); + String debugGetCreateSourceHash() => _$unimplementedScopedHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -44,55 +38,71 @@ final class ScopedProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + UnimplementedScoped create() => _createCb?.call() ?? UnimplementedScoped(); + @$internal @override - ScopedProvider $copyWithCreate( - int Function( - ScopedRef ref, - ) create, + UnimplementedScopedProvider $copyWithCreate( + UnimplementedScoped Function() create, ) { - return ScopedProvider._(create: create); + return UnimplementedScopedProvider._(create: create); } + @$internal @override - int create(ScopedRef ref) { - final _$cb = _createCb ?? scoped; - return _$cb(ref); + UnimplementedScopedProvider $copyWithBuild( + int Function( + Ref, + UnimplementedScoped, + ) build, + ) { + return UnimplementedScopedProvider._(runNotifierBuildOverride: build); } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -String _$scopedHash() => r'bbf25968b1186d2dd63d10545364453712d491cf'; +String _$unimplementedScopedHash() => + r'0511a23bd69f21f42fa4f20a9078f6a200a073cb'; -typedef UnimplementedScopedRef = Ref; +abstract class _$UnimplementedScoped extends $Notifier { + int build() => throw MissingScopeException(ref); + @$internal + @override + int runBuild() => build(); +} -@ProviderFor(unimplementedScoped) -const unimplementedScopedProvider = UnimplementedScopedProvider._(); +typedef ScopedRef = Ref; -final class UnimplementedScopedProvider - extends $FunctionalProvider - with $Provider { - const UnimplementedScopedProvider._( +@ProviderFor(scoped) +const scopedProvider = ScopedProvider._(); + +final class ScopedProvider extends $FunctionalProvider + with $Provider { + const ScopedProvider._( {int Function( - UnimplementedScopedRef ref, + ScopedRef ref, )? create}) : _createCb = create, super( from: null, argument: null, - name: r'unimplementedScopedProvider', + name: r'scopedProvider', isAutoDispose: true, dependencies: const [], allTransitiveDependencies: const [], ); final int Function( - UnimplementedScopedRef ref, + ScopedRef ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$unimplementedScopedHash(); + String debugGetCreateSourceHash() => _$scopedHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -108,23 +118,22 @@ final class UnimplementedScopedProvider $ProviderElement(this, container); @override - UnimplementedScopedProvider $copyWithCreate( + ScopedProvider $copyWithCreate( int Function( - UnimplementedScopedRef ref, + ScopedRef ref, ) create, ) { - return UnimplementedScopedProvider._(create: create); + return ScopedProvider._(create: create); } @override - int create(UnimplementedScopedRef ref) { - final _$cb = _createCb ?? unimplementedScoped; + int create(ScopedRef ref) { + final _$cb = _createCb ?? scoped; return _$cb(ref); } } -String _$unimplementedScopedHash() => - r'5f32fc56f4157238612d62ef54038fe92b7cdfe8'; +String _$scopedHash() => r'bbf25968b1186d2dd63d10545364453712d491cf'; typedef RootRef = Ref; @@ -185,6 +194,5 @@ final class RootProvider extends $FunctionalProvider String _$rootHash() => r'1cd85d73316aad02169ff0f5e7af5cf1423410ff'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.dart b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.dart new file mode 100644 index 000000000..1d4abfe53 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.dart @@ -0,0 +1,63 @@ +import 'package:flutter/material.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'unknown_scoped_usage.g.dart'; + +@Riverpod(dependencies: []) +int scoped(ScopedRef ref) => 0; + +@riverpod +int root(RootRef ref) => 0; + +@Dependencies([scoped]) +void fn(WidgetRef widgetRef, Ref ref) { + // expect_lint: unknown_scoped_usage + scopedProvider; + rootProvider; + + // Known ref usage + widgetRef.watch(scopedProvider); + ref.watch(scopedProvider); + + // Unknown ref usage inside a ref expression + // expect_lint: unknown_scoped_usage + widgetRef.watch(identity(scopedProvider)); + // expect_lint: unknown_scoped_usage + ref.watch(identity(scopedProvider)); + // expect_lint: unknown_scoped_usage + ref.watch(identityMap[scopedProvider]); + + // Overrides are OK + scopedProvider.overrideWith((ref) => 0); + + // If passed as widget constructor parameter, it's OK + // expect_lint: unknown_scoped_usage + RandomObject(scopedProvider); + MyWidget(scopedProvider); +} + +class RandomObject { + RandomObject(this.provider); + final ProviderListenable provider; +} + +final identityMap = IdentityMap>(); + +class IdentityMap { + T operator [](T key) => key; +} + +T identity(T value) => value; + +class MyWidget extends ConsumerWidget { + const MyWidget(this.provider); + + final ProviderListenable provider; + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.watch(provider); + return Container(); + } +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart new file mode 100644 index 000000000..b034e60b7 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart @@ -0,0 +1,128 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'unknown_scoped_usage.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ScopedRef = Ref; + +@ProviderFor(scoped) +const scopedProvider = ScopedProvider._(); + +final class ScopedProvider extends $FunctionalProvider + with $Provider { + const ScopedProvider._( + {int Function( + ScopedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'scopedProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + ScopedRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$scopedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ScopedProvider $copyWithCreate( + int Function( + ScopedRef ref, + ) create, + ) { + return ScopedProvider._(create: create); + } + + @override + int create(ScopedRef ref) { + final _$cb = _createCb ?? scoped; + return _$cb(ref); + } +} + +String _$scopedHash() => r'bbf25968b1186d2dd63d10545364453712d491cf'; + +typedef RootRef = Ref; + +@ProviderFor(root) +const rootProvider = RootProvider._(); + +final class RootProvider extends $FunctionalProvider + with $Provider { + const RootProvider._( + {int Function( + RootRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'rootProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + RootRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$rootHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RootProvider $copyWithCreate( + int Function( + RootRef ref, + ) create, + ) { + return RootProvider._(create: create); + } + + @override + int create(RootRef ref) { + final _$cb = _createCb ?? root; + return _$cb(ref); + } +} + +String _$rootHash() => r'1cd85d73316aad02169ff0f5e7af5cf1423410ff'; + +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart index a8f8da5e2..b6389d0d7 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart @@ -185,6 +185,76 @@ final class AsyncStateNotifierProvider extends $FunctionalProvider< String _$asyncStateNotifierHash() => r'66442390f13e38cd9594f841a7610ab0f632db81'; +@ProviderFor(StateNotifierClass) +const stateNotifierClassProvider = StateNotifierClassProvider._(); + +final class StateNotifierClassProvider + extends $NotifierProvider { + const StateNotifierClassProvider._( + {super.runNotifierBuildOverride, StateNotifierClass Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'stateNotifierClassProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final StateNotifierClass Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$stateNotifierClassHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyStateNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + StateNotifierClass create() => _createCb?.call() ?? StateNotifierClass(); + + @$internal + @override + StateNotifierClassProvider $copyWithCreate( + StateNotifierClass Function() create, + ) { + return StateNotifierClassProvider._(create: create); + } + + @$internal + @override + StateNotifierClassProvider $copyWithBuild( + MyStateNotifier Function( + Ref, + StateNotifierClass, + ) build, + ) { + return StateNotifierClassProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); +} + +String _$stateNotifierClassHash() => + r'576978be5b8a02c212afe7afbe37c733a49ecbce'; + +abstract class _$StateNotifierClass extends $Notifier { + MyStateNotifier build(); + @$internal + @override + MyStateNotifier runBuild() => build(); +} + typedef StateNotifierAsyncRef = Ref>; @ProviderFor(stateNotifierAsync) @@ -243,1091 +313,1020 @@ final class StateNotifierAsyncProvider extends $FunctionalProvider< String _$stateNotifierAsyncHash() => r'9a9b1986076dfdfa4490cc109f1bd0f112a7455c'; -typedef ChangeNotifierRef = Ref; - -@ProviderFor(changeNotifier) -const changeNotifierProvider = ChangeNotifierProvider._(); +@ProviderFor(SelfNotifier) +const selfNotifierProvider = SelfNotifierProvider._(); -final class ChangeNotifierProvider extends $FunctionalProvider< - MyChangeNotifier, - MyChangeNotifier, - ChangeNotifierRef> with $Provider { - const ChangeNotifierProvider._( - {MyChangeNotifier Function( - ChangeNotifierRef ref, - )? create}) +final class SelfNotifierProvider + extends $AsyncNotifierProvider { + const SelfNotifierProvider._( + {super.runNotifierBuildOverride, SelfNotifier Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'changeNotifierProvider', + name: r'selfNotifierProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final MyChangeNotifier Function( - ChangeNotifierRef ref, - )? _createCb; + final SelfNotifier Function()? _createCb; @override - String debugGetCreateSourceHash() => _$changeNotifierHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(MyChangeNotifier value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } + String debugGetCreateSourceHash() => _$selfNotifierHash(); @$internal @override - $ProviderElement $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + SelfNotifier create() => _createCb?.call() ?? SelfNotifier(); + @$internal @override - ChangeNotifierProvider $copyWithCreate( - MyChangeNotifier Function( - ChangeNotifierRef ref, - ) create, + SelfNotifierProvider $copyWithCreate( + SelfNotifier Function() create, ) { - return ChangeNotifierProvider._(create: create); + return SelfNotifierProvider._(create: create); } + @$internal @override - MyChangeNotifier create(ChangeNotifierRef ref) { - final _$cb = _createCb ?? changeNotifier; - return _$cb(ref); + SelfNotifierProvider $copyWithBuild( + FutureOr Function( + Ref>, + SelfNotifier, + ) build, + ) { + return SelfNotifierProvider._(runNotifierBuildOverride: build); } + + @$internal + @override + $AsyncNotifierProviderElement $createElement( + ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); } -String _$changeNotifierHash() => r'6325328c129773979364c3cfd628f8f696bbaf66'; +String _$selfNotifierHash() => r'5a857f5c92a9b7a35daa4e527bd333cf3d8d19ac'; -typedef NotifierRef = Ref; +abstract class _$SelfNotifier extends $AsyncNotifier { + FutureOr build(); + @$internal + @override + FutureOr runBuild() => build(); +} -@ProviderFor(notifier) -const notifierProvider = NotifierProvider._(); +@ProviderFor(SyncSelfNotifier) +const syncSelfNotifierProvider = SyncSelfNotifierProvider._(); -final class NotifierProvider - extends $FunctionalProvider - with $Provider { - const NotifierProvider._( - {MyNotifier Function( - NotifierRef ref, - )? create}) +final class SyncSelfNotifierProvider + extends $NotifierProvider { + const SyncSelfNotifierProvider._( + {super.runNotifierBuildOverride, SyncSelfNotifier Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'notifierProvider', + name: r'syncSelfNotifierProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final MyNotifier Function( - NotifierRef ref, - )? _createCb; + final SyncSelfNotifier Function()? _createCb; @override - String debugGetCreateSourceHash() => _$notifierHash(); + String debugGetCreateSourceHash() => _$syncSelfNotifierHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(MyNotifier value) { + Override overrideWithValue(SyncSelfNotifier value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider(value), + providerOverride: $ValueProvider(value), ); } @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + SyncSelfNotifier create() => _createCb?.call() ?? SyncSelfNotifier(); + @$internal @override - NotifierProvider $copyWithCreate( - MyNotifier Function( - NotifierRef ref, - ) create, + SyncSelfNotifierProvider $copyWithCreate( + SyncSelfNotifier Function() create, ) { - return NotifierProvider._(create: create); + return SyncSelfNotifierProvider._(create: create); } + @$internal @override - MyNotifier create(NotifierRef ref) { - final _$cb = _createCb ?? notifier; - return _$cb(ref); + SyncSelfNotifierProvider $copyWithBuild( + SyncSelfNotifier Function( + Ref, + SyncSelfNotifier, + ) build, + ) { + return SyncSelfNotifierProvider._(runNotifierBuildOverride: build); } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -String _$notifierHash() => r'2f323c78400044790faaf61912fc98c6153942f6'; +String _$syncSelfNotifierHash() => r'4f3a2463cb5693a5c8d7e772b4d7c9774b9ba637'; -typedef AutoDisposeNotifierRef = Ref; +abstract class _$SyncSelfNotifier extends $Notifier { + SyncSelfNotifier build(); + @$internal + @override + SyncSelfNotifier runBuild() => build(); +} -@ProviderFor(autoDisposeNotifier) -const autoDisposeNotifierProvider = AutoDisposeNotifierProvider._(); +@ProviderFor(StreamSelfNotifier) +const streamSelfNotifierProvider = StreamSelfNotifierProvider._(); -final class AutoDisposeNotifierProvider extends $FunctionalProvider< - MyAutoDisposeNotifier, MyAutoDisposeNotifier, AutoDisposeNotifierRef> - with $Provider { - const AutoDisposeNotifierProvider._( - {MyAutoDisposeNotifier Function( - AutoDisposeNotifierRef ref, - )? create}) +final class StreamSelfNotifierProvider + extends $StreamNotifierProvider { + const StreamSelfNotifierProvider._( + {super.runNotifierBuildOverride, StreamSelfNotifier Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'autoDisposeNotifierProvider', + name: r'streamSelfNotifierProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final MyAutoDisposeNotifier Function( - AutoDisposeNotifierRef ref, - )? _createCb; + final StreamSelfNotifier Function()? _createCb; @override - String debugGetCreateSourceHash() => _$autoDisposeNotifierHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(MyAutoDisposeNotifier value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } + String debugGetCreateSourceHash() => _$streamSelfNotifierHash(); @$internal @override - $ProviderElement $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + StreamSelfNotifier create() => _createCb?.call() ?? StreamSelfNotifier(); + @$internal @override - AutoDisposeNotifierProvider $copyWithCreate( - MyAutoDisposeNotifier Function( - AutoDisposeNotifierRef ref, - ) create, + StreamSelfNotifierProvider $copyWithCreate( + StreamSelfNotifier Function() create, ) { - return AutoDisposeNotifierProvider._(create: create); + return StreamSelfNotifierProvider._(create: create); } + @$internal @override - MyAutoDisposeNotifier create(AutoDisposeNotifierRef ref) { - final _$cb = _createCb ?? autoDisposeNotifier; - return _$cb(ref); + StreamSelfNotifierProvider $copyWithBuild( + Stream Function( + Ref>, + StreamSelfNotifier, + ) build, + ) { + return StreamSelfNotifierProvider._(runNotifierBuildOverride: build); } + + @$internal + @override + $StreamNotifierProviderElement + $createElement(ProviderContainer container) => + $StreamNotifierProviderElement(this, container); } -String _$autoDisposeNotifierHash() => - r'620df0fc11c887f01e125454afe8de553cfea6d0'; +String _$streamSelfNotifierHash() => + r'18705475d157d8e592205406c0b884b7213d329e'; -typedef AsyncNotifierRef = Ref; +abstract class _$StreamSelfNotifier + extends $StreamNotifier { + Stream build(); + @$internal + @override + Stream runBuild() => build(); +} -@ProviderFor(asyncNotifier) -const asyncNotifierProvider = AsyncNotifierProvider._(); +@ProviderFor(StateNotifierClassAsync) +const stateNotifierClassAsyncProvider = StateNotifierClassAsyncProvider._(); -final class AsyncNotifierProvider extends $FunctionalProvider< - MyAsyncNotifier, - MyAsyncNotifier, - AsyncNotifierRef> with $Provider { - const AsyncNotifierProvider._( - {MyAsyncNotifier Function( - AsyncNotifierRef ref, - )? create}) +final class StateNotifierClassAsyncProvider + extends $AsyncNotifierProvider { + const StateNotifierClassAsyncProvider._( + {super.runNotifierBuildOverride, + StateNotifierClassAsync Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'asyncNotifierProvider', + name: r'stateNotifierClassAsyncProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final MyAsyncNotifier Function( - AsyncNotifierRef ref, - )? _createCb; + final StateNotifierClassAsync Function()? _createCb; @override - String debugGetCreateSourceHash() => _$asyncNotifierHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(MyAsyncNotifier value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } + String debugGetCreateSourceHash() => _$stateNotifierClassAsyncHash(); @$internal @override - $ProviderElement $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + StateNotifierClassAsync create() => + _createCb?.call() ?? StateNotifierClassAsync(); + @$internal @override - AsyncNotifierProvider $copyWithCreate( - MyAsyncNotifier Function( - AsyncNotifierRef ref, - ) create, + StateNotifierClassAsyncProvider $copyWithCreate( + StateNotifierClassAsync Function() create, ) { - return AsyncNotifierProvider._(create: create); + return StateNotifierClassAsyncProvider._(create: create); } + @$internal @override - MyAsyncNotifier create(AsyncNotifierRef ref) { - final _$cb = _createCb ?? asyncNotifier; - return _$cb(ref); + StateNotifierClassAsyncProvider $copyWithBuild( + FutureOr Function( + Ref>, + StateNotifierClassAsync, + ) build, + ) { + return StateNotifierClassAsyncProvider._(runNotifierBuildOverride: build); } + + @$internal + @override + $AsyncNotifierProviderElement + $createElement(ProviderContainer container) => + $AsyncNotifierProviderElement(this, container); } -String _$asyncNotifierHash() => r'c90348efac71d241468236924f6c6bc80ae0d0e0'; +String _$stateNotifierClassAsyncHash() => + r'06c519ed7dbdcd9440365dd2dc3ec12e603b6b7e'; -typedef RawNotifierRef = Ref>; +abstract class _$StateNotifierClassAsync + extends $AsyncNotifier { + FutureOr build(); + @$internal + @override + FutureOr runBuild() => build(); +} -@ProviderFor(rawNotifier) -const rawNotifierProvider = RawNotifierProvider._(); +typedef ChangeNotifierRef = Ref; -final class RawNotifierProvider extends $FunctionalProvider< - Raw, - Raw, - RawNotifierRef> with $Provider, RawNotifierRef> { - const RawNotifierProvider._( - {Raw Function( - RawNotifierRef ref, +@ProviderFor(changeNotifier) +const changeNotifierProvider = ChangeNotifierProvider._(); + +final class ChangeNotifierProvider extends $FunctionalProvider< + MyChangeNotifier, + MyChangeNotifier, + ChangeNotifierRef> with $Provider { + const ChangeNotifierProvider._( + {MyChangeNotifier Function( + ChangeNotifierRef ref, )? create}) : _createCb = create, super( from: null, argument: null, - name: r'rawNotifierProvider', + name: r'changeNotifierProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final Raw Function( - RawNotifierRef ref, + final MyChangeNotifier Function( + ChangeNotifierRef ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$rawNotifierHash(); + String debugGetCreateSourceHash() => _$changeNotifierHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(Raw value) { + Override overrideWithValue(MyChangeNotifier value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>(value), + providerOverride: $ValueProvider(value), ); } @$internal @override - $ProviderElement> $createElement( + $ProviderElement $createElement( ProviderContainer container) => $ProviderElement(this, container); @override - RawNotifierProvider $copyWithCreate( - Raw Function( - RawNotifierRef ref, + ChangeNotifierProvider $copyWithCreate( + MyChangeNotifier Function( + ChangeNotifierRef ref, ) create, ) { - return RawNotifierProvider._(create: create); + return ChangeNotifierProvider._(create: create); } @override - Raw create(RawNotifierRef ref) { - final _$cb = _createCb ?? rawNotifier; + MyChangeNotifier create(ChangeNotifierRef ref) { + final _$cb = _createCb ?? changeNotifier; return _$cb(ref); } } -String _$rawNotifierHash() => r'c01adc70a8e08258bf5d13024aa8e9b86359a2b2'; - -typedef RawFutureNotifierRef = Ref>>; +String _$changeNotifierHash() => r'6325328c129773979364c3cfd628f8f696bbaf66'; -@ProviderFor(rawFutureNotifier) -const rawFutureNotifierProvider = RawFutureNotifierProvider._(); +@ProviderFor(ChangeNotifierClass) +const changeNotifierClassProvider = ChangeNotifierClassProvider._(); -final class RawFutureNotifierProvider extends $FunctionalProvider< - Raw>, - Raw>, - RawFutureNotifierRef> - with $Provider>, RawFutureNotifierRef> { - const RawFutureNotifierProvider._( - {Raw> Function( - RawFutureNotifierRef ref, - )? create}) +final class ChangeNotifierClassProvider + extends $NotifierProvider { + const ChangeNotifierClassProvider._( + {super.runNotifierBuildOverride, ChangeNotifierClass Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'rawFutureNotifierProvider', + name: r'changeNotifierClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final Raw> Function( - RawFutureNotifierRef ref, - )? _createCb; + final ChangeNotifierClass Function()? _createCb; @override - String debugGetCreateSourceHash() => _$rawFutureNotifierHash(); + String debugGetCreateSourceHash() => _$changeNotifierClassHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(Raw> value) { + Override overrideWithValue(MyChangeNotifier value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>>(value), + providerOverride: $ValueProvider(value), ); } @$internal @override - $ProviderElement>> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + ChangeNotifierClass create() => _createCb?.call() ?? ChangeNotifierClass(); + @$internal @override - RawFutureNotifierProvider $copyWithCreate( - Raw> Function( - RawFutureNotifierRef ref, - ) create, + ChangeNotifierClassProvider $copyWithCreate( + ChangeNotifierClass Function() create, ) { - return RawFutureNotifierProvider._(create: create); + return ChangeNotifierClassProvider._(create: create); } + @$internal @override - Raw> create(RawFutureNotifierRef ref) { - final _$cb = _createCb ?? rawFutureNotifier; - return _$cb(ref); + ChangeNotifierClassProvider $copyWithBuild( + MyChangeNotifier Function( + Ref, + ChangeNotifierClass, + ) build, + ) { + return ChangeNotifierClassProvider._(runNotifierBuildOverride: build); } + + @$internal + @override + $NotifierProviderElement + $createElement(ProviderContainer container) => + $NotifierProviderElement(this, container); } -String _$rawFutureNotifierHash() => r'883253dbf7ade868c44b288ec3da02be64dcfb20'; +String _$changeNotifierClassHash() => + r'c9716469ce2f8e7a1a6063587ae8733999e51a6e'; -typedef RawStreamNotifierRef = Ref>>; +abstract class _$ChangeNotifierClass extends $Notifier { + MyChangeNotifier build(); + @$internal + @override + MyChangeNotifier runBuild() => build(); +} -@ProviderFor(rawStreamNotifier) -const rawStreamNotifierProvider = RawStreamNotifierProvider._(); +typedef NotifierRef = Ref; -final class RawStreamNotifierProvider extends $FunctionalProvider< - Raw>, - Raw>, - RawStreamNotifierRef> - with $Provider>, RawStreamNotifierRef> { - const RawStreamNotifierProvider._( - {Raw> Function( - RawStreamNotifierRef ref, +@ProviderFor(notifier) +const notifierProvider = NotifierProvider._(); + +final class NotifierProvider + extends $FunctionalProvider + with $Provider { + const NotifierProvider._( + {MyNotifier Function( + NotifierRef ref, )? create}) : _createCb = create, super( from: null, argument: null, - name: r'rawStreamNotifierProvider', + name: r'notifierProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final Raw> Function( - RawStreamNotifierRef ref, + final MyNotifier Function( + NotifierRef ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$rawStreamNotifierHash(); + String debugGetCreateSourceHash() => _$notifierHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(Raw> value) { + Override overrideWithValue(MyNotifier value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>>(value), + providerOverride: $ValueProvider(value), ); } @$internal @override - $ProviderElement>> $createElement( - ProviderContainer container) => + $ProviderElement $createElement(ProviderContainer container) => $ProviderElement(this, container); @override - RawStreamNotifierProvider $copyWithCreate( - Raw> Function( - RawStreamNotifierRef ref, + NotifierProvider $copyWithCreate( + MyNotifier Function( + NotifierRef ref, ) create, ) { - return RawStreamNotifierProvider._(create: create); + return NotifierProvider._(create: create); } @override - Raw> create(RawStreamNotifierRef ref) { - final _$cb = _createCb ?? rawStreamNotifier; + MyNotifier create(NotifierRef ref) { + final _$cb = _createCb ?? notifier; return _$cb(ref); } } -String _$rawStreamNotifierHash() => r'f22f6a906e275c6245365bf029e2dc217cf3a301'; +String _$notifierHash() => r'2f323c78400044790faaf61912fc98c6153942f6'; -typedef FutureRawNotifierRef = Ref>>; +typedef AutoDisposeNotifierRef = Ref; -@ProviderFor(futureRawNotifier) -const futureRawNotifierProvider = FutureRawNotifierProvider._(); +@ProviderFor(autoDisposeNotifier) +const autoDisposeNotifierProvider = AutoDisposeNotifierProvider._(); -final class FutureRawNotifierProvider extends $FunctionalProvider< - AsyncValue>, - FutureOr>, - FutureRawNotifierRef> - with - $FutureModifier>, - $FutureProvider, FutureRawNotifierRef> { - const FutureRawNotifierProvider._( - {FutureOr> Function( - FutureRawNotifierRef ref, +final class AutoDisposeNotifierProvider extends $FunctionalProvider< + MyAutoDisposeNotifier, MyAutoDisposeNotifier, AutoDisposeNotifierRef> + with $Provider { + const AutoDisposeNotifierProvider._( + {MyAutoDisposeNotifier Function( + AutoDisposeNotifierRef ref, )? create}) : _createCb = create, super( from: null, argument: null, - name: r'futureRawNotifierProvider', + name: r'autoDisposeNotifierProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final FutureOr> Function( - FutureRawNotifierRef ref, + final MyAutoDisposeNotifier Function( + AutoDisposeNotifierRef ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$futureRawNotifierHash(); + String debugGetCreateSourceHash() => _$autoDisposeNotifierHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyAutoDisposeNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } @$internal @override - $FutureProviderElement> $createElement( + $ProviderElement $createElement( ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderElement(this, container); @override - FutureRawNotifierProvider $copyWithCreate( - FutureOr> Function( - FutureRawNotifierRef ref, + AutoDisposeNotifierProvider $copyWithCreate( + MyAutoDisposeNotifier Function( + AutoDisposeNotifierRef ref, ) create, ) { - return FutureRawNotifierProvider._(create: create); + return AutoDisposeNotifierProvider._(create: create); } @override - FutureOr> create(FutureRawNotifierRef ref) { - final _$cb = _createCb ?? futureRawNotifier; + MyAutoDisposeNotifier create(AutoDisposeNotifierRef ref) { + final _$cb = _createCb ?? autoDisposeNotifier; return _$cb(ref); } } -String _$futureRawNotifierHash() => r'd70ca757ff2539fc698ff924c135ee5e88a98018'; - -typedef StreamRawNotifierRef = Ref>>; +String _$autoDisposeNotifierHash() => + r'620df0fc11c887f01e125454afe8de553cfea6d0'; -@ProviderFor(streamRawNotifier) -const streamRawNotifierProvider = StreamRawNotifierProvider._(); +@ProviderFor(NotifierClass) +const notifierClassProvider = NotifierClassProvider._(); -final class StreamRawNotifierProvider extends $FunctionalProvider< - AsyncValue>, - Stream>, - StreamRawNotifierRef> - with - $FutureModifier>, - $StreamProvider, StreamRawNotifierRef> { - const StreamRawNotifierProvider._( - {Stream> Function( - StreamRawNotifierRef ref, - )? create}) +final class NotifierClassProvider + extends $NotifierProvider { + const NotifierClassProvider._( + {super.runNotifierBuildOverride, NotifierClass Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'streamRawNotifierProvider', + name: r'notifierClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final Stream> Function( - StreamRawNotifierRef ref, - )? _createCb; + final NotifierClass Function()? _createCb; @override - String debugGetCreateSourceHash() => _$streamRawNotifierHash(); + String debugGetCreateSourceHash() => _$notifierClassHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } @$internal @override - $StreamProviderElement> $createElement( - ProviderContainer container) => - $StreamProviderElement(this, container); + NotifierClass create() => _createCb?.call() ?? NotifierClass(); + @$internal @override - StreamRawNotifierProvider $copyWithCreate( - Stream> Function( - StreamRawNotifierRef ref, - ) create, + NotifierClassProvider $copyWithCreate( + NotifierClass Function() create, ) { - return StreamRawNotifierProvider._(create: create); + return NotifierClassProvider._(create: create); } + @$internal @override - Stream> create(StreamRawNotifierRef ref) { - final _$cb = _createCb ?? streamRawNotifier; - return _$cb(ref); + NotifierClassProvider $copyWithBuild( + MyNotifier Function( + Ref, + NotifierClass, + ) build, + ) { + return NotifierClassProvider._(runNotifierBuildOverride: build); } + + @$internal + @override + $NotifierProviderElement $createElement( + ProviderContainer container) => + $NotifierProviderElement(this, container); } -String _$streamRawNotifierHash() => r'b1075c37ef3e8a83dfb9a3d469b76bd4855c336f'; +String _$notifierClassHash() => r'e7eefebec2fca4f982582449e7ec14322932b748'; -@ProviderFor(StateNotifierClass) -const stateNotifierClassProvider = StateNotifierClassProvider._(); +abstract class _$NotifierClass extends $Notifier { + MyNotifier build(); + @$internal + @override + MyNotifier runBuild() => build(); +} -final class StateNotifierClassProvider - extends $NotifierProvider { - const StateNotifierClassProvider._( - {super.runNotifierBuildOverride, StateNotifierClass Function()? create}) +typedef AsyncNotifierRef = Ref; + +@ProviderFor(asyncNotifier) +const asyncNotifierProvider = AsyncNotifierProvider._(); + +final class AsyncNotifierProvider extends $FunctionalProvider< + MyAsyncNotifier, + MyAsyncNotifier, + AsyncNotifierRef> with $Provider { + const AsyncNotifierProvider._( + {MyAsyncNotifier Function( + AsyncNotifierRef ref, + )? create}) : _createCb = create, super( from: null, argument: null, - name: r'stateNotifierClassProvider', + name: r'asyncNotifierProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final StateNotifierClass Function()? _createCb; + final MyAsyncNotifier Function( + AsyncNotifierRef ref, + )? _createCb; @override - String debugGetCreateSourceHash() => _$stateNotifierClassHash(); + String debugGetCreateSourceHash() => _$asyncNotifierHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(MyStateNotifier value) { + Override overrideWithValue(MyAsyncNotifier value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider(value), + providerOverride: $ValueProvider(value), ); } @$internal @override - StateNotifierClass create() => _createCb?.call() ?? StateNotifierClass(); + $ProviderElement $createElement( + ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - StateNotifierClassProvider $copyWithCreate( - StateNotifierClass Function() create, + AsyncNotifierProvider $copyWithCreate( + MyAsyncNotifier Function( + AsyncNotifierRef ref, + ) create, ) { - return StateNotifierClassProvider._(create: create); + return AsyncNotifierProvider._(create: create); } - @$internal @override - StateNotifierClassProvider $copyWithBuild( - MyStateNotifier Function( - Ref, - StateNotifierClass, - ) build, - ) { - return StateNotifierClassProvider._(runNotifierBuildOverride: build); + MyAsyncNotifier create(AsyncNotifierRef ref) { + final _$cb = _createCb ?? asyncNotifier; + return _$cb(ref); } - - @$internal - @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); } -String _$stateNotifierClassHash() => - r'576978be5b8a02c212afe7afbe37c733a49ecbce'; - -abstract class _$StateNotifierClass extends $Notifier { - MyStateNotifier build(); - @$internal - @override - MyStateNotifier runBuild() => build(); -} +String _$asyncNotifierHash() => r'c90348efac71d241468236924f6c6bc80ae0d0e0'; -@ProviderFor(SelfNotifier) -const selfNotifierProvider = SelfNotifierProvider._(); +@ProviderFor(AsyncNotifierClass) +const asyncNotifierClassProvider = AsyncNotifierClassProvider._(); -final class SelfNotifierProvider - extends $AsyncNotifierProvider { - const SelfNotifierProvider._( - {super.runNotifierBuildOverride, SelfNotifier Function()? create}) +final class AsyncNotifierClassProvider + extends $NotifierProvider { + const AsyncNotifierClassProvider._( + {super.runNotifierBuildOverride, AsyncNotifierClass Function()? create}) : _createCb = create, super( from: null, argument: null, - name: r'selfNotifierProvider', + name: r'asyncNotifierClassProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final SelfNotifier Function()? _createCb; + final AsyncNotifierClass Function()? _createCb; @override - String debugGetCreateSourceHash() => _$selfNotifierHash(); + String debugGetCreateSourceHash() => _$asyncNotifierClassHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(MyAsyncNotifier value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } @$internal @override - SelfNotifier create() => _createCb?.call() ?? SelfNotifier(); + AsyncNotifierClass create() => _createCb?.call() ?? AsyncNotifierClass(); @$internal @override - SelfNotifierProvider $copyWithCreate( - SelfNotifier Function() create, + AsyncNotifierClassProvider $copyWithCreate( + AsyncNotifierClass Function() create, ) { - return SelfNotifierProvider._(create: create); + return AsyncNotifierClassProvider._(create: create); } @$internal @override - SelfNotifierProvider $copyWithBuild( - FutureOr Function( - Ref>, - SelfNotifier, - ) build, - ) { - return SelfNotifierProvider._(runNotifierBuildOverride: build); + AsyncNotifierClassProvider $copyWithBuild( + MyAsyncNotifier Function( + Ref, + AsyncNotifierClass, + ) build, + ) { + return AsyncNotifierClassProvider._(runNotifierBuildOverride: build); } @$internal @override - $AsyncNotifierProviderElement $createElement( + $NotifierProviderElement $createElement( ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $NotifierProviderElement(this, container); } -String _$selfNotifierHash() => r'5a857f5c92a9b7a35daa4e527bd333cf3d8d19ac'; +String _$asyncNotifierClassHash() => + r'815a238752d324b136166c409a39fd3f0db67267'; -abstract class _$SelfNotifier extends $AsyncNotifier { - FutureOr build(); +abstract class _$AsyncNotifierClass extends $Notifier { + MyAsyncNotifier build(); @$internal @override - FutureOr runBuild() => build(); + MyAsyncNotifier runBuild() => build(); } -@ProviderFor(SyncSelfNotifier) -const syncSelfNotifierProvider = SyncSelfNotifierProvider._(); +typedef RawNotifierRef = Ref>; -final class SyncSelfNotifierProvider - extends $NotifierProvider { - const SyncSelfNotifierProvider._( - {super.runNotifierBuildOverride, SyncSelfNotifier Function()? create}) +@ProviderFor(rawNotifier) +const rawNotifierProvider = RawNotifierProvider._(); + +final class RawNotifierProvider extends $FunctionalProvider< + Raw, + Raw, + RawNotifierRef> with $Provider, RawNotifierRef> { + const RawNotifierProvider._( + {Raw Function( + RawNotifierRef ref, + )? create}) : _createCb = create, super( from: null, argument: null, - name: r'syncSelfNotifierProvider', + name: r'rawNotifierProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final SyncSelfNotifier Function()? _createCb; + final Raw Function( + RawNotifierRef ref, + )? _createCb; @override - String debugGetCreateSourceHash() => _$syncSelfNotifierHash(); + String debugGetCreateSourceHash() => _$rawNotifierHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(SyncSelfNotifier value) { + Override overrideWithValue(Raw value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider(value), + providerOverride: $ValueProvider>(value), ); } @$internal @override - SyncSelfNotifier create() => _createCb?.call() ?? SyncSelfNotifier(); + $ProviderElement> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - SyncSelfNotifierProvider $copyWithCreate( - SyncSelfNotifier Function() create, + RawNotifierProvider $copyWithCreate( + Raw Function( + RawNotifierRef ref, + ) create, ) { - return SyncSelfNotifierProvider._(create: create); + return RawNotifierProvider._(create: create); } - @$internal @override - SyncSelfNotifierProvider $copyWithBuild( - SyncSelfNotifier Function( - Ref, - SyncSelfNotifier, - ) build, - ) { - return SyncSelfNotifierProvider._(runNotifierBuildOverride: build); + Raw create(RawNotifierRef ref) { + final _$cb = _createCb ?? rawNotifier; + return _$cb(ref); } - - @$internal - @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); } -String _$syncSelfNotifierHash() => r'4f3a2463cb5693a5c8d7e772b4d7c9774b9ba637'; +String _$rawNotifierHash() => r'c01adc70a8e08258bf5d13024aa8e9b86359a2b2'; -abstract class _$SyncSelfNotifier extends $Notifier { - SyncSelfNotifier build(); - @$internal - @override - SyncSelfNotifier runBuild() => build(); -} +typedef RawFutureNotifierRef = Ref>>; -@ProviderFor(StreamSelfNotifier) -const streamSelfNotifierProvider = StreamSelfNotifierProvider._(); +@ProviderFor(rawFutureNotifier) +const rawFutureNotifierProvider = RawFutureNotifierProvider._(); -final class StreamSelfNotifierProvider - extends $StreamNotifierProvider { - const StreamSelfNotifierProvider._( - {super.runNotifierBuildOverride, StreamSelfNotifier Function()? create}) +final class RawFutureNotifierProvider extends $FunctionalProvider< + Raw>, + Raw>, + RawFutureNotifierRef> + with $Provider>, RawFutureNotifierRef> { + const RawFutureNotifierProvider._( + {Raw> Function( + RawFutureNotifierRef ref, + )? create}) : _createCb = create, super( from: null, argument: null, - name: r'streamSelfNotifierProvider', + name: r'rawFutureNotifierProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final StreamSelfNotifier Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$streamSelfNotifierHash(); - - @$internal - @override - StreamSelfNotifier create() => _createCb?.call() ?? StreamSelfNotifier(); + final Raw> Function( + RawFutureNotifierRef ref, + )? _createCb; - @$internal @override - StreamSelfNotifierProvider $copyWithCreate( - StreamSelfNotifier Function() create, - ) { - return StreamSelfNotifierProvider._(create: create); - } + String debugGetCreateSourceHash() => _$rawFutureNotifierHash(); - @$internal - @override - StreamSelfNotifierProvider $copyWithBuild( - Stream Function( - Ref>, - StreamSelfNotifier, - ) build, - ) { - return StreamSelfNotifierProvider._(runNotifierBuildOverride: build); + /// {@macro riverpod.override_with_value} + Override overrideWithValue(Raw> value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>>(value), + ); } @$internal @override - $StreamNotifierProviderElement - $createElement(ProviderContainer container) => - $StreamNotifierProviderElement(this, container); -} - -String _$streamSelfNotifierHash() => - r'18705475d157d8e592205406c0b884b7213d329e'; - -abstract class _$StreamSelfNotifier - extends $StreamNotifier { - Stream build(); - @$internal - @override - Stream runBuild() => build(); -} - -@ProviderFor(StateNotifierClassAsync) -const stateNotifierClassAsyncProvider = StateNotifierClassAsyncProvider._(); - -final class StateNotifierClassAsyncProvider - extends $AsyncNotifierProvider { - const StateNotifierClassAsyncProvider._( - {super.runNotifierBuildOverride, - StateNotifierClassAsync Function()? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'stateNotifierClassAsyncProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final StateNotifierClassAsync Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$stateNotifierClassAsyncHash(); - - @$internal - @override - StateNotifierClassAsync create() => - _createCb?.call() ?? StateNotifierClassAsync(); + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - StateNotifierClassAsyncProvider $copyWithCreate( - StateNotifierClassAsync Function() create, + RawFutureNotifierProvider $copyWithCreate( + Raw> Function( + RawFutureNotifierRef ref, + ) create, ) { - return StateNotifierClassAsyncProvider._(create: create); + return RawFutureNotifierProvider._(create: create); } - @$internal @override - StateNotifierClassAsyncProvider $copyWithBuild( - FutureOr Function( - Ref>, - StateNotifierClassAsync, - ) build, - ) { - return StateNotifierClassAsyncProvider._(runNotifierBuildOverride: build); + Raw> create(RawFutureNotifierRef ref) { + final _$cb = _createCb ?? rawFutureNotifier; + return _$cb(ref); } - - @$internal - @override - $AsyncNotifierProviderElement - $createElement(ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); } -String _$stateNotifierClassAsyncHash() => - r'06c519ed7dbdcd9440365dd2dc3ec12e603b6b7e'; +String _$rawFutureNotifierHash() => r'883253dbf7ade868c44b288ec3da02be64dcfb20'; -abstract class _$StateNotifierClassAsync - extends $AsyncNotifier { - FutureOr build(); - @$internal - @override - FutureOr runBuild() => build(); -} +typedef RawStreamNotifierRef = Ref>>; -@ProviderFor(ChangeNotifierClass) -const changeNotifierClassProvider = ChangeNotifierClassProvider._(); +@ProviderFor(rawStreamNotifier) +const rawStreamNotifierProvider = RawStreamNotifierProvider._(); -final class ChangeNotifierClassProvider - extends $NotifierProvider { - const ChangeNotifierClassProvider._( - {super.runNotifierBuildOverride, ChangeNotifierClass Function()? create}) +final class RawStreamNotifierProvider extends $FunctionalProvider< + Raw>, + Raw>, + RawStreamNotifierRef> + with $Provider>, RawStreamNotifierRef> { + const RawStreamNotifierProvider._( + {Raw> Function( + RawStreamNotifierRef ref, + )? create}) : _createCb = create, super( from: null, argument: null, - name: r'changeNotifierClassProvider', + name: r'rawStreamNotifierProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final ChangeNotifierClass Function()? _createCb; + final Raw> Function( + RawStreamNotifierRef ref, + )? _createCb; @override - String debugGetCreateSourceHash() => _$changeNotifierClassHash(); + String debugGetCreateSourceHash() => _$rawStreamNotifierHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(MyChangeNotifier value) { + Override overrideWithValue(Raw> value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider(value), + providerOverride: $ValueProvider>>(value), ); } @$internal @override - ChangeNotifierClass create() => _createCb?.call() ?? ChangeNotifierClass(); + $ProviderElement>> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); - @$internal @override - ChangeNotifierClassProvider $copyWithCreate( - ChangeNotifierClass Function() create, + RawStreamNotifierProvider $copyWithCreate( + Raw> Function( + RawStreamNotifierRef ref, + ) create, ) { - return ChangeNotifierClassProvider._(create: create); + return RawStreamNotifierProvider._(create: create); } - @$internal @override - ChangeNotifierClassProvider $copyWithBuild( - MyChangeNotifier Function( - Ref, - ChangeNotifierClass, - ) build, - ) { - return ChangeNotifierClassProvider._(runNotifierBuildOverride: build); + Raw> create(RawStreamNotifierRef ref) { + final _$cb = _createCb ?? rawStreamNotifier; + return _$cb(ref); } - - @$internal - @override - $NotifierProviderElement - $createElement(ProviderContainer container) => - $NotifierProviderElement(this, container); } -String _$changeNotifierClassHash() => - r'c9716469ce2f8e7a1a6063587ae8733999e51a6e'; +String _$rawStreamNotifierHash() => r'f22f6a906e275c6245365bf029e2dc217cf3a301'; -abstract class _$ChangeNotifierClass extends $Notifier { - MyChangeNotifier build(); - @$internal - @override - MyChangeNotifier runBuild() => build(); -} +typedef FutureRawNotifierRef = Ref>>; -@ProviderFor(NotifierClass) -const notifierClassProvider = NotifierClassProvider._(); +@ProviderFor(futureRawNotifier) +const futureRawNotifierProvider = FutureRawNotifierProvider._(); -final class NotifierClassProvider - extends $NotifierProvider { - const NotifierClassProvider._( - {super.runNotifierBuildOverride, NotifierClass Function()? create}) +final class FutureRawNotifierProvider extends $FunctionalProvider< + AsyncValue>, + FutureOr>, + FutureRawNotifierRef> + with + $FutureModifier>, + $FutureProvider, FutureRawNotifierRef> { + const FutureRawNotifierProvider._( + {FutureOr> Function( + FutureRawNotifierRef ref, + )? create}) : _createCb = create, super( from: null, argument: null, - name: r'notifierClassProvider', + name: r'futureRawNotifierProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final NotifierClass Function()? _createCb; + final FutureOr> Function( + FutureRawNotifierRef ref, + )? _createCb; @override - String debugGetCreateSourceHash() => _$notifierClassHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(MyNotifier value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } + String debugGetCreateSourceHash() => _$futureRawNotifierHash(); @$internal @override - NotifierClass create() => _createCb?.call() ?? NotifierClass(); + $FutureProviderElement> $createElement( + ProviderContainer container) => + $FutureProviderElement(this, container); - @$internal @override - NotifierClassProvider $copyWithCreate( - NotifierClass Function() create, + FutureRawNotifierProvider $copyWithCreate( + FutureOr> Function( + FutureRawNotifierRef ref, + ) create, ) { - return NotifierClassProvider._(create: create); + return FutureRawNotifierProvider._(create: create); } - @$internal @override - NotifierClassProvider $copyWithBuild( - MyNotifier Function( - Ref, - NotifierClass, - ) build, - ) { - return NotifierClassProvider._(runNotifierBuildOverride: build); + FutureOr> create(FutureRawNotifierRef ref) { + final _$cb = _createCb ?? futureRawNotifier; + return _$cb(ref); } - - @$internal - @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); } -String _$notifierClassHash() => r'e7eefebec2fca4f982582449e7ec14322932b748'; +String _$futureRawNotifierHash() => r'd70ca757ff2539fc698ff924c135ee5e88a98018'; -abstract class _$NotifierClass extends $Notifier { - MyNotifier build(); - @$internal - @override - MyNotifier runBuild() => build(); -} +typedef StreamRawNotifierRef = Ref>>; -@ProviderFor(AsyncNotifierClass) -const asyncNotifierClassProvider = AsyncNotifierClassProvider._(); +@ProviderFor(streamRawNotifier) +const streamRawNotifierProvider = StreamRawNotifierProvider._(); -final class AsyncNotifierClassProvider - extends $NotifierProvider { - const AsyncNotifierClassProvider._( - {super.runNotifierBuildOverride, AsyncNotifierClass Function()? create}) +final class StreamRawNotifierProvider extends $FunctionalProvider< + AsyncValue>, + Stream>, + StreamRawNotifierRef> + with + $FutureModifier>, + $StreamProvider, StreamRawNotifierRef> { + const StreamRawNotifierProvider._( + {Stream> Function( + StreamRawNotifierRef ref, + )? create}) : _createCb = create, super( from: null, argument: null, - name: r'asyncNotifierClassProvider', + name: r'streamRawNotifierProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final AsyncNotifierClass Function()? _createCb; + final Stream> Function( + StreamRawNotifierRef ref, + )? _createCb; @override - String debugGetCreateSourceHash() => _$asyncNotifierClassHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(MyAsyncNotifier value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } + String debugGetCreateSourceHash() => _$streamRawNotifierHash(); @$internal @override - AsyncNotifierClass create() => _createCb?.call() ?? AsyncNotifierClass(); + $StreamProviderElement> $createElement( + ProviderContainer container) => + $StreamProviderElement(this, container); - @$internal @override - AsyncNotifierClassProvider $copyWithCreate( - AsyncNotifierClass Function() create, + StreamRawNotifierProvider $copyWithCreate( + Stream> Function( + StreamRawNotifierRef ref, + ) create, ) { - return AsyncNotifierClassProvider._(create: create); + return StreamRawNotifierProvider._(create: create); } - @$internal @override - AsyncNotifierClassProvider $copyWithBuild( - MyAsyncNotifier Function( - Ref, - AsyncNotifierClass, - ) build, - ) { - return AsyncNotifierClassProvider._(runNotifierBuildOverride: build); + Stream> create(StreamRawNotifierRef ref) { + final _$cb = _createCb ?? streamRawNotifier; + return _$cb(ref); } - - @$internal - @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); } -String _$asyncNotifierClassHash() => - r'815a238752d324b136166c409a39fd3f0db67267'; - -abstract class _$AsyncNotifierClass extends $Notifier { - MyAsyncNotifier build(); - @$internal - @override - MyAsyncNotifier runBuild() => build(); -} +String _$streamRawNotifierHash() => r'b1075c37ef3e8a83dfb9a3d469b76bd4855c336f'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.dart b/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.dart new file mode 100644 index 000000000..5a7696954 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.dart @@ -0,0 +1,143 @@ +// ignore_for_file: unknown_scoped_usage +import 'package:flutter/widgets.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'provider_dependencies.g.dart'; + +@riverpod +int root(RootRef ref) => 0; + +@Riverpod(dependencies: []) +int dep(DepRef ref) => 0; + +@Riverpod(dependencies: []) +int dep2(Dep2Ref ref) => 0; + +//////////// + +@Riverpod( + keepAlive: false, + // expect_lint: provider_dependencies + dependencies: [ + dep, + dep2, + ], +) +int extraDep(ExtraDepRef ref) { + ref.watch(dep2Provider); + return 0; +} + +@Riverpod( + keepAlive: false, + // expect_lint: provider_dependencies + dependencies: [ + dep, + ], +) +int noDep(NoDepRef ref) { + return 0; +} + +@Riverpod( + // expect_lint: provider_dependencies + dependencies: [ + dep, + ], + keepAlive: false, +) +int dependenciesFirstThenKeepAlive(DependenciesFirstThenKeepAliveRef ref) { + return 0; +} + +@Riverpod( + // expect_lint: provider_dependencies + dependencies: [ + dep, + ], +) +int noDepNoParam(NoDepNoParamRef ref) { + return 0; +} + +// expect_lint: provider_dependencies +@Riverpod(keepAlive: false, dependencies: [dep]) +int noDepWithoutComma(NoDepWithoutCommaRef ref) { + return 0; +} + +@Riverpod( + keepAlive: false, + // expect_lint: provider_dependencies + dependencies: [ + root, + ], +) +int rootDep(RootDepRef ref) => 0; + +// expect_lint: provider_dependencies +@Dependencies([dep]) +class StateNotFound extends ConsumerStatefulWidget { + @override + // Can't track down state due to not typing it as StateNotFoundState + ConsumerState createState() { + // Throwing to avoid "dep" counting as used indirectly. + throw UnimplementedError(); + } +} + +// Hijack generic too to prevent finding the state from the State. +class StateNotFoundState extends ConsumerState { + @override + Widget build(BuildContext context) { + ref.watch(depProvider); + return const Placeholder(); + } +} + +// Count the state too for determining if a dependency is unused +@Dependencies([dep]) +class IndirectlyUsed extends ConsumerStatefulWidget { + IndirectlyUsed({super.key, this.child}); + final Widget? child; + + @override + IndirectlyUsedState createState() => IndirectlyUsedState(); +} + +class IndirectlyUsedState extends ConsumerState { + @override + Widget build(BuildContext context) { + ref.watch(depProvider); + return const Placeholder(); + } +} + +// expect_lint: provider_dependencies +@Dependencies([dep]) +void fn() {} + +@Dependencies([dep]) +class Identifiers extends StatelessWidget { + @override + Widget build(BuildContext context) { + fn(); + return const Placeholder(); + } +} + +// expect_lint: provider_dependencies +@Dependencies([dep2, dep]) +void secondUnused() { + dep2Provider; +} + +// expect_lint: provider_dependencies +@Dependencies([ + dep2, + dep, +]) +void secondUnusedWithTrailingComma() { + dep2Provider; +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.diff b/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.diff new file mode 100644 index 000000000..56c1adbc9 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.diff @@ -0,0 +1,141 @@ +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:22`: +``` + keepAlive: false, + // expect_lint: provider_dependencies +- dependencies: [ +- dep, +- dep2, +- ], ++ dependencies: [dep2], +) +int extraDep(ExtraDepRef ref) { +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:34`: +``` +@Riverpod( + keepAlive: false, +- // expect_lint: provider_dependencies +- dependencies: [ +- dep, +- ], +- ) ++ ) +int noDep(NoDepRef ref) { + return 0; +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:45`: +``` +@Riverpod( + // expect_lint: provider_dependencies +- dependencies: [ +- dep, +- ], +- keepAlive: false, ++ keepAlive: false, +) +int dependenciesFirstThenKeepAlive(DependenciesFirstThenKeepAliveRef ref) { +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:54`: +``` +} + +- @Riverpod( +- // expect_lint: provider_dependencies +- dependencies: [ +- dep, +- ], +- ) ++ @riverpod +int noDepNoParam(NoDepNoParamRef ref) { + return 0; +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:65`: +``` + +// expect_lint: provider_dependencies +- @Riverpod(keepAlive: false, dependencies: [dep]) ++ @Riverpod(keepAlive: false) +int noDepWithoutComma(NoDepWithoutCommaRef ref) { + return 0; +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:72`: +``` +@Riverpod( + keepAlive: false, +- // expect_lint: provider_dependencies +- dependencies: [ +- root, +- ], +- ) ++ ) +int rootDep(RootDepRef ref) => 0; + +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:80`: +``` + +// expect_lint: provider_dependencies +- @Dependencies([dep]) ++ +class StateNotFound extends ConsumerStatefulWidget { + @override +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:118`: +``` + +// expect_lint: provider_dependencies +- @Dependencies([dep]) ++ +void fn() {} + +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:131`: +``` + +// expect_lint: provider_dependencies +- @Dependencies([dep2, dep]) ++ @Dependencies([dep2]) +void secondUnused() { + dep2Provider; +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:137`: +``` + +// expect_lint: provider_dependencies +- @Dependencies([ +- dep2, +- dep, ++ @Dependencies([dep2]) +void secondUnusedWithTrailingComma() { + dep2Provider; +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.g.dart similarity index 66% rename from packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart rename to packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.g.dart index 252dd83a6..ffcd059a5 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.g.dart @@ -6,282 +6,33 @@ part of 'provider_dependencies.dart'; // RiverpodGenerator // ************************************************************************** -typedef DepRef = Ref; - -@ProviderFor(dep) -const depProvider = DepProvider._(); - -final class DepProvider extends $FunctionalProvider - with $Provider { - const DepProvider._( - {int Function( - DepRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'depProvider', - isAutoDispose: true, - dependencies: const [], - allTransitiveDependencies: const [], - ); - - final int Function( - DepRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$depHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - DepProvider $copyWithCreate( - int Function( - DepRef ref, - ) create, - ) { - return DepProvider._(create: create); - } - - @override - int create(DepRef ref) { - final _$cb = _createCb ?? dep; - return _$cb(ref); - } -} - -String _$depHash() => r'749c4d696d29c72686cabcabd6fa7855f5cbf4db'; - -typedef Dep2Ref = Ref; - -@ProviderFor(dep2) -const dep2Provider = Dep2Provider._(); - -final class Dep2Provider extends $FunctionalProvider - with $Provider { - const Dep2Provider._( - {int Function( - Dep2Ref ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'dep2Provider', - isAutoDispose: true, - dependencies: const [], - allTransitiveDependencies: const [], - ); - - final int Function( - Dep2Ref ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$dep2Hash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - Dep2Provider $copyWithCreate( - int Function( - Dep2Ref ref, - ) create, - ) { - return Dep2Provider._(create: create); - } - - @override - int create(Dep2Ref ref) { - final _$cb = _createCb ?? dep2; - return _$cb(ref); - } -} - -String _$dep2Hash() => r'13cd909366c79168e3d9cd95f529ddbcee6de7dc'; - -//////////// -// expect_lint: provider_dependencies -typedef PlainAnnotationRef = Ref; - -//////////// -// expect_lint: provider_dependencies -@ProviderFor(plainAnnotation) -const plainAnnotationProvider = PlainAnnotationProvider._(); - -//////////// -// expect_lint: provider_dependencies -final class PlainAnnotationProvider - extends $FunctionalProvider - with $Provider { - //////////// -// expect_lint: provider_dependencies - const PlainAnnotationProvider._( - {int Function( - PlainAnnotationRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'plainAnnotationProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - PlainAnnotationRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$plainAnnotationHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - PlainAnnotationProvider $copyWithCreate( - int Function( - PlainAnnotationRef ref, - ) create, - ) { - return PlainAnnotationProvider._(create: create); - } - - @override - int create(PlainAnnotationRef ref) { - final _$cb = _createCb ?? plainAnnotation; - return _$cb(ref); - } -} - -String _$plainAnnotationHash() => r'ceeb01dfcbd115f3676c8e38ce35a03cff16246b'; - -typedef CustomAnnotationRef = Ref; - -@ProviderFor(customAnnotation) -const customAnnotationProvider = CustomAnnotationProvider._(); - -final class CustomAnnotationProvider - extends $FunctionalProvider - with $Provider { - const CustomAnnotationProvider._( - {int Function( - CustomAnnotationRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'customAnnotationProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - CustomAnnotationRef ref, - )? _createCb; +typedef RootRef = Ref; - @override - String debugGetCreateSourceHash() => _$customAnnotationHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - CustomAnnotationProvider $copyWithCreate( - int Function( - CustomAnnotationRef ref, - ) create, - ) { - return CustomAnnotationProvider._(create: create); - } - - @override - int create(CustomAnnotationRef ref) { - final _$cb = _createCb ?? customAnnotation; - return _$cb(ref); - } -} - -String _$customAnnotationHash() => r'04faed9b424be360e594870f91c4ef4689f05672'; - -typedef CustomAnnotationWithTrailingCommaRef = Ref; +@ProviderFor(root) +const rootProvider = RootProvider._(); -@ProviderFor(customAnnotationWithTrailingComma) -const customAnnotationWithTrailingCommaProvider = - CustomAnnotationWithTrailingCommaProvider._(); - -final class CustomAnnotationWithTrailingCommaProvider - extends $FunctionalProvider - with $Provider { - const CustomAnnotationWithTrailingCommaProvider._( +final class RootProvider extends $FunctionalProvider + with $Provider { + const RootProvider._( {int Function( - CustomAnnotationWithTrailingCommaRef ref, + RootRef ref, )? create}) : _createCb = create, super( from: null, argument: null, - name: r'customAnnotationWithTrailingCommaProvider', + name: r'rootProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); final int Function( - CustomAnnotationWithTrailingCommaRef ref, + RootRef ref, )? _createCb; @override - String debugGetCreateSourceHash() => - _$customAnnotationWithTrailingCommaHash(); + String debugGetCreateSourceHash() => _$rootHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -297,52 +48,50 @@ final class CustomAnnotationWithTrailingCommaProvider $ProviderElement(this, container); @override - CustomAnnotationWithTrailingCommaProvider $copyWithCreate( + RootProvider $copyWithCreate( int Function( - CustomAnnotationWithTrailingCommaRef ref, + RootRef ref, ) create, ) { - return CustomAnnotationWithTrailingCommaProvider._(create: create); + return RootProvider._(create: create); } @override - int create(CustomAnnotationWithTrailingCommaRef ref) { - final _$cb = _createCb ?? customAnnotationWithTrailingComma; + int create(RootRef ref) { + final _$cb = _createCb ?? root; return _$cb(ref); } } -String _$customAnnotationWithTrailingCommaHash() => - r'b5c62d769dfc53d6d77e8fde9e0eb7d8a0ab9d18'; +String _$rootHash() => r'1cd85d73316aad02169ff0f5e7af5cf1423410ff'; -typedef ExistingDepRef = Ref; +typedef DepRef = Ref; -@ProviderFor(existingDep) -const existingDepProvider = ExistingDepProvider._(); +@ProviderFor(dep) +const depProvider = DepProvider._(); -final class ExistingDepProvider - extends $FunctionalProvider - with $Provider { - const ExistingDepProvider._( +final class DepProvider extends $FunctionalProvider + with $Provider { + const DepProvider._( {int Function( - ExistingDepRef ref, + DepRef ref, )? create}) : _createCb = create, super( from: null, argument: null, - name: r'existingDepProvider', + name: r'depProvider', isAutoDispose: true, dependencies: const [], allTransitiveDependencies: const [], ); final int Function( - ExistingDepRef ref, + DepRef ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$existingDepHash(); + String debugGetCreateSourceHash() => _$depHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -358,51 +107,50 @@ final class ExistingDepProvider $ProviderElement(this, container); @override - ExistingDepProvider $copyWithCreate( + DepProvider $copyWithCreate( int Function( - ExistingDepRef ref, + DepRef ref, ) create, ) { - return ExistingDepProvider._(create: create); + return DepProvider._(create: create); } @override - int create(ExistingDepRef ref) { - final _$cb = _createCb ?? existingDep; + int create(DepRef ref) { + final _$cb = _createCb ?? dep; return _$cb(ref); } } -String _$existingDepHash() => r'8d7866d1af7e350d7c792e43a542cd47b130b239'; +String _$depHash() => r'749c4d696d29c72686cabcabd6fa7855f5cbf4db'; -typedef MultipleDepsRef = Ref; +typedef Dep2Ref = Ref; -@ProviderFor(multipleDeps) -const multipleDepsProvider = MultipleDepsProvider._(); +@ProviderFor(dep2) +const dep2Provider = Dep2Provider._(); -final class MultipleDepsProvider - extends $FunctionalProvider - with $Provider { - const MultipleDepsProvider._( +final class Dep2Provider extends $FunctionalProvider + with $Provider { + const Dep2Provider._( {int Function( - MultipleDepsRef ref, + Dep2Ref ref, )? create}) : _createCb = create, super( from: null, argument: null, - name: r'multipleDepsProvider', + name: r'dep2Provider', isAutoDispose: true, dependencies: const [], allTransitiveDependencies: const [], ); final int Function( - MultipleDepsRef ref, + Dep2Ref ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$multipleDepsHash(); + String debugGetCreateSourceHash() => _$dep2Hash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -418,30 +166,34 @@ final class MultipleDepsProvider $ProviderElement(this, container); @override - MultipleDepsProvider $copyWithCreate( + Dep2Provider $copyWithCreate( int Function( - MultipleDepsRef ref, + Dep2Ref ref, ) create, ) { - return MultipleDepsProvider._(create: create); + return Dep2Provider._(create: create); } @override - int create(MultipleDepsRef ref) { - final _$cb = _createCb ?? multipleDeps; + int create(Dep2Ref ref) { + final _$cb = _createCb ?? dep2; return _$cb(ref); } } -String _$multipleDepsHash() => r'9d08791636a0435ba115062a453d0d9e530ecf71'; +String _$dep2Hash() => r'13cd909366c79168e3d9cd95f529ddbcee6de7dc'; +//////////// typedef ExtraDepRef = Ref; +//////////// @ProviderFor(extraDep) const extraDepProvider = ExtraDepProvider._(); +//////////// final class ExtraDepProvider extends $FunctionalProvider with $Provider { + //////////// const ExtraDepProvider._( {int Function( ExtraDepRef ref, @@ -757,6 +509,68 @@ final class NoDepWithoutCommaProvider String _$noDepWithoutCommaHash() => r'59d5a7874da40605b1b187766ebb4927d2eaae81'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +typedef RootDepRef = Ref; + +@ProviderFor(rootDep) +const rootDepProvider = RootDepProvider._(); + +final class RootDepProvider extends $FunctionalProvider + with $Provider { + const RootDepProvider._( + {int Function( + RootDepRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'rootDepProvider', + isAutoDispose: true, + dependencies: const [rootProvider], + allTransitiveDependencies: const [ + RootDepProvider.$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = rootProvider; + + final int Function( + RootDepRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$rootDepHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + RootDepProvider $copyWithCreate( + int Function( + RootDepRef ref, + ) create, + ) { + return RootDepProvider._(create: create); + } + + @override + int create(RootDepRef ref) { + final _$cb = _createCb ?? rootDep; + return _$cb(ref); + } +} + +String _$rootDepHash() => r'a57728bf865d5a9a73f40f08b038946418cdcf52'; + // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies_test.dart b/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies_test.dart similarity index 73% rename from packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies_test.dart rename to packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies_test.dart index b12d6a212..3b5e3ea55 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies_test.dart @@ -6,9 +6,10 @@ import '../../golden.dart'; void main() { testGolden( - 'Verify that @riverpod classes extend the generated typedef', - 'lints/provider_dependencies/provider_dependencies.diff', - sourcePath: 'test/lints/provider_dependencies/provider_dependencies.dart', + 'Assert that "dependencies" are used.', + 'lints/unused_provider_dependency/provider_dependencies.diff', + sourcePath: + 'test/lints/unused_provider_dependency/provider_dependencies.dart', (result) async { const lint = ProviderDependencies(); final fix = lint.getFixes().single; diff --git a/website/docs/advanced/select/select/codegen.g.dart b/website/docs/advanced/select/select/codegen.g.dart index 069263edb..118a84f10 100644 --- a/website/docs/advanced/select/select/codegen.g.dart +++ b/website/docs/advanced/select/select/codegen.g.dart @@ -67,6 +67,5 @@ final class ExampleProvider extends $FunctionalProvider String _$exampleHash() => r'72881c6147d44adb957180debefe7696d93107f0'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/advanced/select/select_async/codegen.g.dart b/website/docs/advanced/select/select_async/codegen.g.dart index 2ce06d1ae..5741b90ed 100644 --- a/website/docs/advanced/select/select_async/codegen.g.dart +++ b/website/docs/advanced/select/select_async/codegen.g.dart @@ -120,6 +120,5 @@ final class ExampleProvider String _$exampleHash() => r'1fccbdbec0e3585bc9d3a5709ac88a8919dd78fa'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart index aec2ffe13..07eb663a9 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart @@ -81,6 +81,5 @@ final class ActivityProvider extends $FunctionalProvider, String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart index 66634724c..8e5c1b068 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -61,6 +61,5 @@ final class ActivityProvider extends $FunctionalProvider, String _$activityHash() => r'304864a6b8051925061a2bba397574ec45b94d08'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart index 7131a0db7..4ab2e8746 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -61,6 +61,5 @@ final class ActivityProvider extends $FunctionalProvider, String _$activityHash() => r'ef908e3b46693862f082769663b14d5369d6e155'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart index 128d538bf..dc93e9c8f 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -61,6 +61,5 @@ final class ActivityProvider extends $FunctionalProvider, String _$activityHash() => r'f045dd6e89fde6bbe12a89f243290d289a3e692d'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart index 92c2fb027..bc2e776b8 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -61,6 +61,5 @@ final class ActivityProvider extends $FunctionalProvider, String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart index aec2ffe13..07eb663a9 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -81,6 +81,5 @@ final class ActivityProvider extends $FunctionalProvider, String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 41f67d339..2a891a3eb 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -131,7 +131,5 @@ final class FetchUserFamily extends Family { ); } } - -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart index 1172a8ca6..b34cba2bc 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart @@ -68,6 +68,5 @@ abstract class _$Example extends $AsyncNotifier { FutureOr runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart index de860bb63..7f2dbcf66 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart @@ -68,6 +68,5 @@ abstract class _$Example extends $StreamNotifier { Stream runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart index 15a20ea77..404b96a84 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -60,6 +60,5 @@ final class ExampleProvider extends $FunctionalProvider, String _$exampleHash() => r'e620af6b870a76eea4228989433de0666957d813'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart index 163bb593f..9eb49ab90 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -60,6 +60,5 @@ final class ExampleProvider String _$exampleHash() => r'8a2b19776fb9bbb1631f898bd6446b57b102dd9d'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart index a52691df6..792a67780 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -128,6 +128,5 @@ final class Example2Provider String _$example2Hash() => r'bc25731d759be185125d12d995d0b89b07d1e271'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 016068466..41f301d6e 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -139,7 +139,5 @@ final class ExampleFamily extends Family { ); } } - -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index 9205ef62a..57f0b3c75 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -202,6 +202,5 @@ abstract class _$Example extends $Notifier { ); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index a1a795b7c..9a6ea5f42 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -163,7 +163,5 @@ final class ExampleFamily extends Family { ); } } - -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart index adc2e93df..717c018aa 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart @@ -76,6 +76,5 @@ abstract class _$Example extends $Notifier { String runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart index 9a6ccdf70..6f140ed92 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -68,6 +68,5 @@ final class ExampleProvider String _$exampleHash() => r'dd4e9043c704a42a3fc025e7fef9515f659fc78a'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart index 76d999f2a..c9967fa83 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -178,6 +178,5 @@ final class CharactersProvider extends $FunctionalProvider< String _$charactersHash() => r'b1e8e15bbeab60d92fe959d9e1dd4ceba6a31446'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart index f7b66e8c3..78b11a478 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -67,6 +67,5 @@ final class CityProvider extends $FunctionalProvider String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart index 08edda5a5..5b28a9422 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -128,6 +128,5 @@ final class FilteredTodoListProvider String _$filteredTodoListHash() => r'1c35eb0fce8fc7c7cda86413b02f606f8c8ae2b4'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart index 124d73ed8..f37b0d232 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -127,6 +127,5 @@ final class MyProvider extends $FunctionalProvider String _$myHash() => r'2712c772be4dbaabd4c99fd803f927a7e9938b21'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart index 83a4d5829..c79c6582a 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -118,6 +118,5 @@ final class ProductsProvider extends $FunctionalProvider< String _$productsHash() => r'd1f4523880408cf8ee0e68969c40cf87d5c78557'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart index 767e99cc6..c5abcc4bf 100644 --- a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart @@ -76,6 +76,5 @@ abstract class _$TodoList extends $Notifier> { List runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart index e0cb3b238..36195cc33 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -119,6 +119,5 @@ final class WeatherProvider extends $FunctionalProvider, String _$weatherHash() => r'9a79d0269032630918eef9d3f562ff35b5860061'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart index c21282853..92d1b2f3b 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -118,6 +118,5 @@ final class ProductsProvider extends $FunctionalProvider< String _$productsHash() => r'637254615fa398af0d36e212f09e5d3d8ff866aa'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart index 19c4e564b..49d441475 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart @@ -60,6 +60,5 @@ final class ExampleProvider String _$exampleHash() => r'e2c4eb8a7cf06c7a0e5d07ee2bd51db254033fa6'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart index bb1efdb5f..abfc59608 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart @@ -67,6 +67,5 @@ final class MyProvider extends $FunctionalProvider String _$myHash() => r'0810ee24cae78c131d00773ac20d254c83eefab7'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart index 8b589ad1e..a64473b16 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart @@ -127,6 +127,5 @@ final class CountryProvider String _$countryHash() => r'd1513349c3bc0c99763cb4fb29eb012f2351bc4c'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/counter/codegen.g.dart b/website/docs/concepts/reading/counter/codegen.g.dart index be9934548..abdd6ae47 100644 --- a/website/docs/concepts/reading/counter/codegen.g.dart +++ b/website/docs/concepts/reading/counter/codegen.g.dart @@ -136,6 +136,5 @@ abstract class _$Counter extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/listen/codegen.g.dart b/website/docs/concepts/reading/listen/codegen.g.dart index 4a50c5ca5..bcad01fa9 100644 --- a/website/docs/concepts/reading/listen/codegen.g.dart +++ b/website/docs/concepts/reading/listen/codegen.g.dart @@ -67,6 +67,5 @@ final class AnotherProvider extends $FunctionalProvider String _$anotherHash() => r'2208f9221f3d898305609874d4f43c28bdfff2b4'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/listen_build/codegen.g.dart b/website/docs/concepts/reading/listen_build/codegen.g.dart index 105a6133f..71d405250 100644 --- a/website/docs/concepts/reading/listen_build/codegen.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen.g.dart @@ -76,6 +76,5 @@ abstract class _$Counter extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart index a6d55dcde..0195278d4 100644 --- a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart @@ -76,6 +76,5 @@ abstract class _$Counter extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/provider/codegen.g.dart b/website/docs/concepts/reading/provider/codegen.g.dart index d27f8eaca..79e8a2760 100644 --- a/website/docs/concepts/reading/provider/codegen.g.dart +++ b/website/docs/concepts/reading/provider/codegen.g.dart @@ -127,6 +127,5 @@ final class ValueProvider extends $FunctionalProvider String _$valueHash() => r'8c26f7aaa911af815cff9e513a18e4d8dcc6d1df'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/read/codegen.g.dart b/website/docs/concepts/reading/read/codegen.g.dart index 9b6f2d253..a7572b009 100644 --- a/website/docs/concepts/reading/read/codegen.g.dart +++ b/website/docs/concepts/reading/read/codegen.g.dart @@ -76,6 +76,5 @@ abstract class _$Counter extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/read/codegen_hooks.g.dart b/website/docs/concepts/reading/read/codegen_hooks.g.dart index 681ff8533..4c3e1a917 100644 --- a/website/docs/concepts/reading/read/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/read/codegen_hooks.g.dart @@ -76,6 +76,5 @@ abstract class _$Counter extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/read_build/codegen.g.dart b/website/docs/concepts/reading/read_build/codegen.g.dart index 9b6f2d253..a7572b009 100644 --- a/website/docs/concepts/reading/read_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_build/codegen.g.dart @@ -76,6 +76,5 @@ abstract class _$Counter extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart index 9b6f2d253..a7572b009 100644 --- a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart @@ -76,6 +76,5 @@ abstract class _$Counter extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/watch/codegen.g.dart b/website/docs/concepts/reading/watch/codegen.g.dart index 5188a21eb..248a4b926 100644 --- a/website/docs/concepts/reading/watch/codegen.g.dart +++ b/website/docs/concepts/reading/watch/codegen.g.dart @@ -68,66 +68,6 @@ final class FilterTypeProvider String _$filterTypeHash() => r'42b68b163daecff7a0b9b069b16025a89910b4fb'; -typedef FilteredTodoListRef = Ref>; - -@ProviderFor(filteredTodoList) -const filteredTodoListProvider = FilteredTodoListProvider._(); - -final class FilteredTodoListProvider - extends $FunctionalProvider, List, FilteredTodoListRef> - with $Provider, FilteredTodoListRef> { - const FilteredTodoListProvider._( - {List Function( - FilteredTodoListRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'filteredTodoListProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final List Function( - FilteredTodoListRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$filteredTodoListHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(List value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider>(value), - ); - } - - @$internal - @override - $ProviderElement> $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - FilteredTodoListProvider $copyWithCreate( - List Function( - FilteredTodoListRef ref, - ) create, - ) { - return FilteredTodoListProvider._(create: create); - } - - @override - List create(FilteredTodoListRef ref) { - final _$cb = _createCb ?? filteredTodoList; - return _$cb(ref); - } -} - -String _$filteredTodoListHash() => r'34f1e929a9e7850946ea8634d9f3e8f38ae5687d'; - @ProviderFor(Todos) const todosProvider = TodosProvider._(); @@ -196,6 +136,65 @@ abstract class _$Todos extends $Notifier> { List runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +typedef FilteredTodoListRef = Ref>; + +@ProviderFor(filteredTodoList) +const filteredTodoListProvider = FilteredTodoListProvider._(); + +final class FilteredTodoListProvider + extends $FunctionalProvider, List, FilteredTodoListRef> + with $Provider, FilteredTodoListRef> { + const FilteredTodoListProvider._( + {List Function( + FilteredTodoListRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'filteredTodoListProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final List Function( + FilteredTodoListRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$filteredTodoListHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(List value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + FilteredTodoListProvider $copyWithCreate( + List Function( + FilteredTodoListRef ref, + ) create, + ) { + return FilteredTodoListProvider._(create: create); + } + + @override + List create(FilteredTodoListRef ref) { + final _$cb = _createCb ?? filteredTodoList; + return _$cb(ref); + } +} + +String _$filteredTodoListHash() => r'34f1e929a9e7850946ea8634d9f3e8f38ae5687d'; + // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/watch_build/codegen.g.dart b/website/docs/concepts/reading/watch_build/codegen.g.dart index a977df7b6..2c3f2436a 100644 --- a/website/docs/concepts/reading/watch_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen.g.dart @@ -8,65 +8,6 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef CounterRef = Ref; - -@ProviderFor(counter) -const counterProvider = CounterProvider._(); - -final class CounterProvider extends $FunctionalProvider - with $Provider { - const CounterProvider._( - {int Function( - CounterRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'counterProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - CounterRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$counterHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - CounterProvider $copyWithCreate( - int Function( - CounterRef ref, - ) create, - ) { - return CounterProvider._(create: create); - } - - @override - int create(CounterRef ref) { - final _$cb = _createCb ?? counter; - return _$cb(ref); - } -} - -String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; - @ProviderFor(TodoList) const todoListProvider = TodoListProvider._(); @@ -135,6 +76,64 @@ abstract class _$TodoList extends $Notifier> { List runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +typedef CounterRef = Ref; + +@ProviderFor(counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $FunctionalProvider + with $Provider { + const CounterProvider._( + {int Function( + CounterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CounterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CounterProvider $copyWithCreate( + int Function( + CounterRef ref, + ) create, + ) { + return CounterProvider._(create: create); + } + + @override + int create(CounterRef ref) { + final _$cb = _createCb ?? counter; + return _$cb(ref); + } +} + +String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; + // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart index 172d4ee49..976cc5dee 100644 --- a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart @@ -8,65 +8,6 @@ part of 'codegen_hooks.dart'; // RiverpodGenerator // ************************************************************************** -typedef CounterRef = Ref; - -@ProviderFor(counter) -const counterProvider = CounterProvider._(); - -final class CounterProvider extends $FunctionalProvider - with $Provider { - const CounterProvider._( - {int Function( - CounterRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'counterProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - CounterRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$counterHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - CounterProvider $copyWithCreate( - int Function( - CounterRef ref, - ) create, - ) { - return CounterProvider._(create: create); - } - - @override - int create(CounterRef ref) { - final _$cb = _createCb ?? counter; - return _$cb(ref); - } -} - -String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; - @ProviderFor(TodoList) const todoListProvider = TodoListProvider._(); @@ -135,6 +76,64 @@ abstract class _$TodoList extends $Notifier> { List runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +typedef CounterRef = Ref; + +@ProviderFor(counter) +const counterProvider = CounterProvider._(); + +final class CounterProvider extends $FunctionalProvider + with $Provider { + const CounterProvider._( + {int Function( + CounterRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'counterProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CounterRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$counterHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CounterProvider $copyWithCreate( + int Function( + CounterRef ref, + ) create, + ) { + return CounterProvider._(create: create); + } + + @override + int create(CounterRef ref) { + final _$cb = _createCb ?? counter; + return _$cb(ref); + } +} + +String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; + // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart index 9b6f2d253..a7572b009 100644 --- a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart @@ -76,6 +76,5 @@ abstract class _$Counter extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/concepts/why_immutability/codegen.g.dart b/website/docs/concepts/why_immutability/codegen.g.dart index 88eac19dc..1a9216b29 100644 --- a/website/docs/concepts/why_immutability/codegen.g.dart +++ b/website/docs/concepts/why_immutability/codegen.g.dart @@ -77,6 +77,5 @@ abstract class _$ThemeNotifier extends $Notifier { ThemeSettings runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart index 423d550c9..a4279bd56 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -60,6 +60,5 @@ final class ExampleProvider extends $FunctionalProvider, String _$exampleHash() => r'3ff29b1cd8fa864286a2a04e39adf1c8589b4275'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart index 6565fc05b..9cdeb7fb8 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -67,6 +67,5 @@ final class ExampleProvider extends $FunctionalProvider String _$exampleHash() => r'78f9426f6cbda80564387a9db8cd02368d890a85'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index faf2b4033..fbdf4fa3f 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -138,7 +138,5 @@ final class LabelFamily extends Family { ); } } - -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart index 51ab6e0c5..6db2ab5d3 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -60,6 +60,5 @@ final class ExampleProvider extends $FunctionalProvider, String _$exampleHash() => r'4fa856c55e84da9525dcecfab1c897e61456325b'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart index e5b67e8f7..5e07fc62f 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -119,6 +119,5 @@ final class ExampleProvider String _$exampleHash() => r'29f92958e0d0e3f13ac033e92cd2e4072339c7db'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart index e1926f3be..d9bd379f5 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart @@ -126,6 +126,5 @@ final class ExampleProvider extends $FunctionalProvider String _$exampleHash() => r'4429d7d3bb2b31fea4cc42c2f2af02d3f3d10693'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart index e86f55591..0de617661 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart @@ -126,6 +126,5 @@ final class ExampleProvider extends $FunctionalProvider String _$exampleHash() => r'd614303f372e06e6ab96035affc4c07a53b28741'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart index 6be34301f..de43a535c 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -135,6 +135,5 @@ abstract class _$Example extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/combining_requests/read_example/codegen.g.dart b/website/docs/essentials/combining_requests/read_example/codegen.g.dart index 9c59854c2..e0be099b7 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.g.dart @@ -135,6 +135,5 @@ abstract class _$MyNotifier extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart index 1d47b1279..a68b0d696 100644 --- a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart @@ -120,6 +120,5 @@ final class RestaurantsNearMeProvider extends $FunctionalProvider< String _$restaurantsNearMeHash() => r'dd49cc1e6f16abb34dd15286d171e322c06b93b8'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart index 0ecf40b5b..391b0ab04 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart @@ -194,6 +194,5 @@ abstract class _$MyNotifier extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart index fa3e37948..2fdaa387b 100644 --- a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart +++ b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart @@ -60,6 +60,5 @@ final class ExampleProvider extends $FunctionalProvider, String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/first_request/codegen/provider.g.dart b/website/docs/essentials/first_request/codegen/provider.g.dart index d808de3c3..9aa96f826 100644 --- a/website/docs/essentials/first_request/codegen/provider.g.dart +++ b/website/docs/essentials/first_request/codegen/provider.g.dart @@ -69,6 +69,5 @@ final class ActivityProvider extends $FunctionalProvider, String _$activityHash() => r'636cd5510e09cbfc46f31b74a70d9e98c89e95a4'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/passing_args/family/codegen.g.dart b/website/docs/essentials/passing_args/family/codegen.g.dart index b4d03cc73..ece7b01ba 100644 --- a/website/docs/essentials/passing_args/family/codegen.g.dart +++ b/website/docs/essentials/passing_args/family/codegen.g.dart @@ -287,6 +287,5 @@ abstract class _$ActivityNotifier2 extends $AsyncNotifier { ); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart b/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart index ef38d9679..5a708a313 100644 --- a/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart +++ b/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart @@ -122,6 +122,5 @@ abstract class _$ActivityNotifier2 extends $AsyncNotifier { FutureOr runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart index 81218695d..1278ec0e8 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -84,6 +84,5 @@ abstract class _$TodoList extends $AsyncNotifier> { FutureOr> runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart index 19c5471ad..46cf4a5cb 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -69,6 +69,5 @@ abstract class _$TodoList extends $AsyncNotifier> { FutureOr> runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart index c890d03c6..34ec7722c 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -61,6 +61,5 @@ final class TodoListProvider extends $FunctionalProvider>, String _$todoListHash() => r'26b30307668c8feefa7cbe3c400b73e6edccbc39'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/testing/notifier_mock/codegen.g.dart b/website/docs/essentials/testing/notifier_mock/codegen.g.dart index df3894527..6fef6ea49 100644 --- a/website/docs/essentials/testing/notifier_mock/codegen.g.dart +++ b/website/docs/essentials/testing/notifier_mock/codegen.g.dart @@ -76,6 +76,5 @@ abstract class _$MyNotifier extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart index fa3e37948..2fdaa387b 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart @@ -60,6 +60,5 @@ final class ExampleProvider extends $FunctionalProvider, String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart index 8f0d894c9..3a0d42112 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -78,6 +78,5 @@ final class MyListenableProvider extends $FunctionalProvider< String _$myListenableHash() => r'c80799a0224092668fca44187b98ccfcd2b33ae1'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/websockets_sync/raw_usage.g.dart b/website/docs/essentials/websockets_sync/raw_usage.g.dart index 60959986e..e88d50078 100644 --- a/website/docs/essentials/websockets_sync/raw_usage.g.dart +++ b/website/docs/essentials/websockets_sync/raw_usage.g.dart @@ -70,6 +70,5 @@ final class RawStreamProvider extends $FunctionalProvider< String _$rawStreamHash() => r'7e7c2e8f4f08d33a4d86d60449e143c419ca4822'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart index ebffc98b1..9dc99a086 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -131,6 +131,5 @@ final class AnotherListenableProvider extends $FunctionalProvider< String _$anotherListenableHash() => r'50dd36b21e07c50818944ec49f9e68d21fcae876'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart index eabd579e0..f029963b3 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -60,6 +60,5 @@ final class StreamExampleProvider String _$streamExampleHash() => r'ca9993b22f6d587b20c041133cacd28d01933074'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart index ffc21fd38..c6a15d84b 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -69,6 +69,5 @@ final class SynchronousExampleProvider String _$synchronousExampleHash() => r'98df96e07d554683041f668c06b36f183ff534c1'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index f53a38413..5e073da28 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -162,7 +162,5 @@ final class RandomFamily extends Family { ); } } - -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/from_provider/motivation/async_values/async_values.g.dart b/website/docs/from_provider/motivation/async_values/async_values.g.dart index ae3227615..fa0567e5d 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.g.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.g.dart @@ -121,6 +121,5 @@ final class EvenItemsProvider String _$evenItemsHash() => r'55ae98f9b6108203dfc4a139f1ade9fbd8ba8ddd'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart index 4baf88906..541c04374 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -127,6 +127,5 @@ final class CachedDiceRollProvider String _$cachedDiceRollHash() => r'fc31fcb804f10360d75362e56329976343ee7abb'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/from_provider/motivation/combine/combine.g.dart b/website/docs/from_provider/motivation/combine/combine.g.dart index ef5a1884c..473f5d8a5 100644 --- a/website/docs/from_provider/motivation/combine/combine.g.dart +++ b/website/docs/from_provider/motivation/combine/combine.g.dart @@ -126,6 +126,5 @@ final class DoubledProvider extends $FunctionalProvider String _$doubledHash() => r'ddc640c876bdbe49fe72fe1632b5ff48687c9279'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/from_provider/motivation/same_type/same_type.g.dart b/website/docs/from_provider/motivation/same_type/same_type.g.dart index 510d91a68..9256c7f3a 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.g.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.g.dart @@ -128,6 +128,5 @@ final class EvenItemsProvider String _$evenItemsHash() => r'82b4525e91604745f2b4664531b32d4aff5717d4'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart index b5f0b20f9..1dc762216 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart @@ -68,6 +68,5 @@ final class HelloWorldProvider String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart index b5f0b20f9..1dc762216 100644 --- a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -68,6 +68,5 @@ final class HelloWorldProvider String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/introduction/getting_started/hello_world/main.g.dart b/website/docs/introduction/getting_started/hello_world/main.g.dart index b5f0b20f9..1dc762216 100644 --- a/website/docs/introduction/getting_started/hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/main.g.dart @@ -68,6 +68,5 @@ final class HelloWorldProvider String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index f0e4abbd9..2a8c942b1 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -158,7 +158,5 @@ final class FetchPackagesFamily extends Family { ); } } - -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart index e28ccbd61..a4614a167 100644 --- a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart +++ b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart @@ -69,6 +69,5 @@ abstract class _$MyNotifier extends $AsyncNotifier> { FutureOr> runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart index 032f36218..96e332ba9 100644 --- a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart +++ b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart @@ -69,6 +69,5 @@ abstract class _$MyNotifier extends $AsyncNotifier> { FutureOr> runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart index a70189d52..315b14f71 100644 --- a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart +++ b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart @@ -69,6 +69,5 @@ abstract class _$MyNotifier extends $AsyncNotifier> { FutureOr> runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart index 9f4c200ed..4c550c2ab 100644 --- a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart +++ b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -76,6 +76,5 @@ abstract class _$MyNotifier extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart index 0fd4946cb..3f253f011 100644 --- a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart +++ b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -70,6 +70,5 @@ abstract class _$AsyncTodosNotifier extends $AsyncNotifier> { FutureOr> runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart index c180fbb60..088a22017 100644 --- a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart +++ b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart @@ -77,6 +77,5 @@ abstract class _$CounterNotifier extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index f1106863a..56a88c59e 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -227,6 +227,5 @@ abstract class _$BugsEncounteredNotifier extends $AsyncNotifier { ); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart index 94f793831..080e82a5e 100644 --- a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart +++ b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -77,6 +77,5 @@ abstract class _$CounterNotifier extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart index fd429962e..7d758455b 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -76,6 +76,5 @@ abstract class _$MyNotifier extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart index 2434e3160..2ba373cf8 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -196,6 +196,5 @@ abstract class _$MyNotifier extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/future_provider/config_provider/codegen.g.dart b/website/docs/providers/future_provider/config_provider/codegen.g.dart index f89247e93..bcb7b28c9 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.g.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.g.dart @@ -66,6 +66,5 @@ final class FetchConfigurationProvider extends $FunctionalProvider< String _$fetchConfigurationHash() => r'6c0f062e6f20baf883c4282856f1197fbe633d89'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart index 2b454f4a4..4c21d5871 100644 --- a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart @@ -86,6 +86,5 @@ abstract class _$AsyncTodos extends $AsyncNotifier> { FutureOr> runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/notifier_provider/todos/codegen.g.dart b/website/docs/providers/notifier_provider/todos/codegen.g.dart index 5ce1c142a..eec1d3ad2 100644 --- a/website/docs/providers/notifier_provider/todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/todos/codegen.g.dart @@ -76,6 +76,5 @@ abstract class _$Todos extends $Notifier> { List runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/provider/completed_todos/completed_todos.g.dart b/website/docs/providers/provider/completed_todos/completed_todos.g.dart index bf4ddc691..815ff63bd 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.g.dart @@ -68,6 +68,5 @@ final class CompletedTodosProvider String _$completedTodosHash() => r'855706c09268f428696b3b382ae1605818361b83'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index 17a4c444f..1031e808a 100644 --- a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -8,67 +8,6 @@ part of 'optimized_previous_button.dart'; // RiverpodGenerator // ************************************************************************** -typedef CanGoToPreviousPageRef = Ref; - -@ProviderFor(canGoToPreviousPage) -const canGoToPreviousPageProvider = CanGoToPreviousPageProvider._(); - -final class CanGoToPreviousPageProvider - extends $FunctionalProvider - with $Provider { - const CanGoToPreviousPageProvider._( - {bool Function( - CanGoToPreviousPageRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'canGoToPreviousPageProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final bool Function( - CanGoToPreviousPageRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$canGoToPreviousPageHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(bool value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - CanGoToPreviousPageProvider $copyWithCreate( - bool Function( - CanGoToPreviousPageRef ref, - ) create, - ) { - return CanGoToPreviousPageProvider._(create: create); - } - - @override - bool create(CanGoToPreviousPageRef ref) { - final _$cb = _createCb ?? canGoToPreviousPage; - return _$cb(ref); - } -} - -String _$canGoToPreviousPageHash() => - r'801fe8182a37cd21ae83bdfccbe36c125b4d14fb'; - @ProviderFor(PageIndex) const pageIndexProvider = PageIndexProvider._(); @@ -137,6 +76,66 @@ abstract class _$PageIndex extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); +typedef CanGoToPreviousPageRef = Ref; + +@ProviderFor(canGoToPreviousPage) +const canGoToPreviousPageProvider = CanGoToPreviousPageProvider._(); + +final class CanGoToPreviousPageProvider + extends $FunctionalProvider + with $Provider { + const CanGoToPreviousPageProvider._( + {bool Function( + CanGoToPreviousPageRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'canGoToPreviousPageProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final bool Function( + CanGoToPreviousPageRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$canGoToPreviousPageHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(bool value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CanGoToPreviousPageProvider $copyWithCreate( + bool Function( + CanGoToPreviousPageRef ref, + ) create, + ) { + return CanGoToPreviousPageProvider._(create: create); + } + + @override + bool create(CanGoToPreviousPageRef ref) { + final _$cb = _createCb ?? canGoToPreviousPage; + return _$cb(ref); + } +} + +String _$canGoToPreviousPageHash() => + r'801fe8182a37cd21ae83bdfccbe36c125b4d14fb'; + // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/provider/todo/todo.g.dart b/website/docs/providers/provider/todo/todo.g.dart index 7a6997e3e..1d2719d24 100644 --- a/website/docs/providers/provider/todo/todo.g.dart +++ b/website/docs/providers/provider/todo/todo.g.dart @@ -76,6 +76,5 @@ abstract class _$Todos extends $Notifier> { List runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart index 1ce41d761..5e1455a75 100644 --- a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart +++ b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -76,6 +76,5 @@ abstract class _$PageIndex extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart index 2ceb077d7..8d802911a 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -61,6 +61,5 @@ final class ChatProvider extends $FunctionalProvider>, String _$chatHash() => r'db1302132f90e854fe2f5da9d97d89c9a3c8b858'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/static/snippets/async.g.dart b/website/static/snippets/async.g.dart index 4032370b4..20b200084 100644 --- a/website/static/snippets/async.g.dart +++ b/website/static/snippets/async.g.dart @@ -63,6 +63,5 @@ final class ConfigurationsProvider extends $FunctionalProvider< String _$configurationsHash() => r'27f534f8b2a22c39b2d28c2414358a228c552155'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/static/snippets/combine.g.dart b/website/static/snippets/combine.g.dart index da4574208..87a06ff77 100644 --- a/website/static/snippets/combine.g.dart +++ b/website/static/snippets/combine.g.dart @@ -188,6 +188,5 @@ final class FilteredTodosProvider String _$filteredTodosHash() => r'bcb1e81823aaf9b967948b619c177ebc571d96a7'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/static/snippets/create.g.dart b/website/static/snippets/create.g.dart index 5b8136d21..b391714a9 100644 --- a/website/static/snippets/create.g.dart +++ b/website/static/snippets/create.g.dart @@ -60,6 +60,5 @@ final class BoredSuggestionProvider extends $FunctionalProvider< String _$boredSuggestionHash() => r'5975efd623c41e5bc92ecd326209e6124cb1736d'; -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/website/static/snippets/declare.g.dart b/website/static/snippets/declare.g.dart index 55408db8d..9f3249d74 100644 --- a/website/static/snippets/declare.g.dart +++ b/website/static/snippets/declare.g.dart @@ -76,6 +76,5 @@ abstract class _$Count extends $Notifier { int runBuild() => build(); } -const $kDebugMode = bool.fromEnvironment('dart.vm.product'); // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main From fafd2deda166cab1d2ceb80d63f9940b7d360f9e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 25 Feb 2024 18:55:50 +0100 Subject: [PATCH 232/387] Update changelog --- packages/riverpod_generator/CHANGELOG.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 2b8bf9943..f2002834f 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -14,6 +14,8 @@ } ) ``` + +- Adds `provider_name_prefix` and `provider_family_name_prefix` to `build.yaml`. (thanks to @ValentinVignal) - Generated providers are now always `const`. - Added support for abstract `build` method on Notifiers: ```dart @@ -122,10 +124,6 @@ This comes with a few minor restrictions: - **Breaking**: Arguments of the form `fn(void myParameter())` are no-longer supported. Instead use `fn(void Function() myParameter)`. -## Unreleased minor - -- Adds `provider_name_prefix` and `provider_family_name_prefix` to `build.yaml`. (thanks to @ValentinVignal) - ## 2.3.11 - 2024-02-04 - `riverpod_analyzer_utils` upgraded to `0.5.1` From a670f023862a18849425ea8fef371c4b627e5dc8 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 26 Feb 2024 02:44:15 +0100 Subject: [PATCH 233/387] Fix some scoping issues (#3365) --- examples/stackoverflow/lib/common.dart | 16 +- examples/stackoverflow/lib/common.g.dart | 88 ++++ examples/stackoverflow/lib/home.dart | 5 +- examples/stackoverflow/lib/main.dart | 7 +- examples/stackoverflow/lib/question.dart | 9 +- examples/stackoverflow/lib/question.g.dart | 116 +++++ examples/stackoverflow/lib/tag.dart | 37 +- examples/stackoverflow/lib/tag.g.dart | 76 +++ .../lib/src/nodes/dependencies.dart | 66 +-- .../lib/src/riverpod_generator.dart | 7 +- packages/riverpod_generator/pubspec.yaml | 2 +- packages/riverpod_lint/lib/riverpod_lint.dart | 3 +- .../avoid_public_notifier_properties.dart | 4 +- .../lib/src/lints/functional_ref.dart | 5 +- .../lib/src/lints/missing_provider_scope.dart | 5 +- .../lib/src/lints/notifier_extends.dart | 2 +- .../lints/protected_notifier_properties.dart | 4 +- .../lib/src/lints/provider_dependencies.dart | 62 +-- .../lib/src/lints/unknown_scoped_usage.dart | 3 + .../lib/src/riverpod_custom_lint.dart | 3 + .../analysis_options.yaml | 2 +- .../riverpod_lint_flutter_test/build.yaml | 5 +- .../riverpod_lint_flutter_test/pubspec.yaml | 5 + ...ass_based_provider_to_functional_test.dart | 4 +- ...nctional_provider_to_class_based_test.dart | 4 +- .../convert_to_widget_test.dart | 19 +- .../test/assists/empty.diff | 0 ...rt_class_based_provider_to_functional.diff | 0 ...rt_functional_provider_to_class_based.diff | 0 .../convert_to_consumer_stateful_widget.diff | 0 .../convert_to_consumer_widget.diff | 0 .../convert_to_hook_consumer_widget.diff | 0 .../convert_to_hook_widget.diff | 0 ...vert_to_stateful_hook_consumer_widget.diff | 0 .../convert_to_stateful_hook_widget.diff | 0 .../convert_to_stateful_widget.diff | 0 .../convert_to_stateless_widget.diff | 0 .../wrap_widget/wrap_with_consumer.diff | 0 .../wrap_widget/wrap_with_provider_scope.diff | 0 .../assists/wrap_widget/wrap_widget_test.dart | 6 +- .../test/encoders.dart | 199 ++++++++ .../test/golden.dart | 155 ++++--- .../legacy_backup/auto_dispose_read.back | 41 -- .../legacy_backup/avoid_dynamic_provider.back | 21 - .../goldens/legacy_backup/dependencies.back | 159 ------- .../goldens/legacy_backup/final_provider.back | 20 - .../goldens/legacy_backup/flutter_test.back | 110 ----- .../legacy_backup/global_providers.back | 10 - .../legacy_backup/mutate_in_create.back | 256 ----------- .../goldens/legacy_backup/read_vs_watch.back | 174 ------- .../legacy_backup/ref_escape_scope.back | 72 --- .../use_ref_before_async_gaps.back | 105 ----- .../test/io_utils.dart | 15 + .../test/lints/another.dart | 9 - .../test/lints/another.g.dart | 69 --- .../async_value_nullable_pattern.dart | 0 .../fix/async_value_nullable_pattern.dart | 21 - .../fix/async_value_nullable_pattern.diff | 24 - .../async_value_nullable_pattern_test.dart | 25 - .../functional_ref/functional_ref_test.dart | 27 -- .../async_value_nullable_pattern_fix.diff | 60 +++ .../async_value_nullable_pattern_lint.md | 72 +++ .../avoid_build_context_in_providers_lint.md | 87 ++++ .../avoid_public_notifier_properties_lint.md | 102 +++++ .../avoid_ref_inside_state_dispose_lint.md | 27 ++ .../failing_functional_ref_fix.diff | 24 + .../failing_functional_ref_lint.md | 42 ++ .../functional_ref/functional_ref_fix.diff | 46 ++ .../functional_ref/functional_ref_lint.md | 55 +++ .../missing_legacy_import_fix.diff} | 12 +- .../missing_legacy_import_lint.md | 72 +++ .../with_riverpod_import_fix.diff | 11 + .../with_riverpod_import_lint.md | 12 + .../missing_provider_scope_fix.diff | 24 + .../missing_provider_scope_lint.md | 27 ++ .../notifier_build/notifier_build_fix.diff} | 4 +- .../notifier_build/notifier_build_lint.md | 12 + .../notifier_extends_fix.diff} | 10 +- .../notifier_extends/notifier_extends_lint.md | 72 +++ ...y_use_keep_alive_inside_keep_alive_lint.md | 29 ++ .../protected_notifier_properties_lint.md | 297 ++++++++++++ .../missing_dependencies2_fix.diff} | 34 +- .../missing_dependencies2_lint.md | 299 ++++++++++++ .../missing_dependencies_fix.diff} | 36 +- .../missing_dependencies_lint.md | 378 +++++++++++++++ .../unused_dependency_fix.diff} | 20 +- .../unused_dependency_lint.md | 161 +++++++ .../provider_parameters_lint.md | 432 ++++++++++++++++++ .../riverpod_syntax_error_lint.md | 12 + ...viders_should_specify_dependencies_lint.md | 147 ++++++ .../unknown_scoped_usage_lint.md | 72 +++ .../unsupported_provider_value_lint.md | 189 ++++++++ .../missing_legacy_import.dart | 0 .../with_flutter_riverpod.dart | 0 .../with_hooks_riverpod.dart | 0 .../with_riverpod_import.dart | 0 .../provider_dependencies_test.dart | 41 -- .../{notifier_build => }/notifier_build.dart | 0 .../notifier_build/fix/notifier_build.dart | 8 - .../fix/notifier_build_test.dart | 24 - .../notifier_extends.dart | 0 .../notifier_extends.g.dart | 0 .../notifier_extends_test.dart | 27 -- .../lints/provider_dependencies/another.dart | 18 + .../provider_dependencies/another.g.dart | 194 ++++++++ .../missing_dependencies.dart} | 57 ++- .../missing_dependencies.g.dart} | 135 +++++- .../missing_dependencies2.dart} | 12 +- .../missing_dependencies2.g.dart} | 63 ++- .../unused_dependency.dart} | 2 +- .../unused_dependency.g.dart} | 2 +- .../riverpod_syntax_error.dart | 0 .../provider_dependencies_test.dart | 27 -- .../missing_legacy_import_test.dart | 25 - .../test/riverpod_test.dart | 45 ++ .../test/test_lint.dart | 82 ++++ 116 files changed, 4196 insertions(+), 1520 deletions(-) create mode 100644 examples/stackoverflow/lib/common.g.dart create mode 100644 examples/stackoverflow/lib/tag.g.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/assists/empty.diff rename packages/riverpod_lint_flutter_test/test/assists/{ => goldens}/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff (100%) rename packages/riverpod_lint_flutter_test/test/assists/{ => goldens}/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff (100%) rename packages/riverpod_lint_flutter_test/test/assists/{ => goldens}/convert_to_widget/convert_to_consumer_stateful_widget.diff (100%) rename packages/riverpod_lint_flutter_test/test/assists/{ => goldens}/convert_to_widget/convert_to_consumer_widget.diff (100%) rename packages/riverpod_lint_flutter_test/test/assists/{ => goldens}/convert_to_widget/convert_to_hook_consumer_widget.diff (100%) rename packages/riverpod_lint_flutter_test/test/assists/{ => goldens}/convert_to_widget/convert_to_hook_widget.diff (100%) rename packages/riverpod_lint_flutter_test/test/assists/{ => goldens}/convert_to_widget/convert_to_stateful_hook_consumer_widget.diff (100%) rename packages/riverpod_lint_flutter_test/test/assists/{ => goldens}/convert_to_widget/convert_to_stateful_hook_widget.diff (100%) rename packages/riverpod_lint_flutter_test/test/assists/{ => goldens}/convert_to_widget/convert_to_stateful_widget.diff (100%) rename packages/riverpod_lint_flutter_test/test/assists/{ => goldens}/convert_to_widget/convert_to_stateless_widget.diff (100%) rename packages/riverpod_lint_flutter_test/test/assists/{ => goldens}/wrap_widget/wrap_with_consumer.diff (100%) rename packages/riverpod_lint_flutter_test/test/assists/{ => goldens}/wrap_widget/wrap_with_provider_scope.diff (100%) create mode 100644 packages/riverpod_lint_flutter_test/test/encoders.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/auto_dispose_read.back delete mode 100644 packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/avoid_dynamic_provider.back delete mode 100644 packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/dependencies.back delete mode 100644 packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/final_provider.back delete mode 100644 packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/flutter_test.back delete mode 100644 packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/global_providers.back delete mode 100644 packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/mutate_in_create.back delete mode 100644 packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/read_vs_watch.back delete mode 100644 packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/ref_escape_scope.back delete mode 100644 packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/use_ref_before_async_gaps.back create mode 100644 packages/riverpod_lint_flutter_test/test/io_utils.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/another.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/another.g.dart rename packages/riverpod_lint_flutter_test/test/lints/{async_value_nullable_pattern => }/async_value_nullable_pattern.dart (100%) delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern_test.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/async_value_nullable_pattern/async_value_nullable_pattern_fix.diff create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/async_value_nullable_pattern/async_value_nullable_pattern_lint.md create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_public_notifier_properties/avoid_public_notifier_properties_lint.md create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_ref_inside_state_dispose/avoid_ref_inside_state_dispose_lint.md create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_fix.diff create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_lint.md create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md rename packages/riverpod_lint_flutter_test/test/{migration/missing_legacy_import/missing_legacy_import.diff => lints/goldens/missing_legacy_import/missing_legacy_import_fix.diff} (73%) create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/missing_legacy_import_lint.md create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/with_riverpod_import_fix.diff create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/with_riverpod_import_lint.md create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/missing_provider_scope/missing_provider_scope_fix.diff create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/missing_provider_scope/missing_provider_scope_lint.md rename packages/riverpod_lint_flutter_test/test/lints/{notifier_build/fix/notifier_build.diff => goldens/notifier_build/notifier_build_fix.diff} (81%) create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_build/notifier_build_lint.md rename packages/riverpod_lint_flutter_test/test/lints/{notifier_extends/notifier_extends.diff => goldens/notifier_extends/notifier_extends_fix.diff} (76%) create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_lint.md create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/only_use_keep_alive_inside_keep_alive/only_use_keep_alive_inside_keep_alive_lint.md create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/protected_notifier_properties/protected_notifier_properties_lint.md rename packages/riverpod_lint_flutter_test/test/lints/{missing_provider_dependency/dependencies.diff => goldens/provider_dependencies/missing_dependencies2_fix.diff} (66%) create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_lint.md rename packages/riverpod_lint_flutter_test/test/lints/{missing_provider_dependency/provider_dependencies.diff => goldens/provider_dependencies/missing_dependencies_fix.diff} (69%) create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_lint.md rename packages/riverpod_lint_flutter_test/test/lints/{unused_provider_dependency/provider_dependencies.diff => goldens/provider_dependencies/unused_dependency_fix.diff} (71%) create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_lint.md create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/provider_parameters/provider_parameters_lint.md create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/riverpod_syntax_error/riverpod_syntax_error_lint.md create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/scoped_providers_should_specify_dependencies/scoped_providers_should_specify_dependencies_lint.md create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/unknown_scoped_usage/unknown_scoped_usage_lint.md create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/unsupported_provider_value/unsupported_provider_value_lint.md rename packages/riverpod_lint_flutter_test/test/{migration => lints}/missing_legacy_import/missing_legacy_import.dart (100%) rename packages/riverpod_lint_flutter_test/test/{migration => lints}/missing_legacy_import/with_flutter_riverpod.dart (100%) rename packages/riverpod_lint_flutter_test/test/{migration => lints}/missing_legacy_import/with_hooks_riverpod.dart (100%) rename packages/riverpod_lint_flutter_test/test/{migration => lints}/missing_legacy_import/with_riverpod_import.dart (100%) delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies_test.dart rename packages/riverpod_lint_flutter_test/test/lints/{notifier_build => }/notifier_build.dart (100%) delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build_test.dart rename packages/riverpod_lint_flutter_test/test/lints/{notifier_extends => }/notifier_extends.dart (100%) rename packages/riverpod_lint_flutter_test/test/lints/{notifier_extends => }/notifier_extends.g.dart (100%) delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart rename packages/riverpod_lint_flutter_test/test/lints/{missing_provider_dependency/provider_dependencies.dart => provider_dependencies/missing_dependencies.dart} (77%) rename packages/riverpod_lint_flutter_test/test/lints/{missing_provider_dependency/provider_dependencies.g.dart => provider_dependencies/missing_dependencies.g.dart} (78%) rename packages/riverpod_lint_flutter_test/test/lints/{missing_provider_dependency/dependencies.dart => provider_dependencies/missing_dependencies2.dart} (95%) rename packages/riverpod_lint_flutter_test/test/lints/{missing_provider_dependency/dependencies.g.dart => provider_dependencies/missing_dependencies2.g.dart} (96%) rename packages/riverpod_lint_flutter_test/test/lints/{unused_provider_dependency/provider_dependencies.dart => provider_dependencies/unused_dependency.dart} (98%) rename packages/riverpod_lint_flutter_test/test/lints/{unused_provider_dependency/provider_dependencies.g.dart => provider_dependencies/unused_dependency.g.dart} (99%) rename packages/riverpod_lint_flutter_test/test/lints/{riverpod_syntax_error => }/riverpod_syntax_error.dart (100%) delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies_test.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import_test.dart create mode 100644 packages/riverpod_lint_flutter_test/test/riverpod_test.dart create mode 100644 packages/riverpod_lint_flutter_test/test/test_lint.dart diff --git a/examples/stackoverflow/lib/common.dart b/examples/stackoverflow/lib/common.dart index e69985910..b8625183a 100644 --- a/examples/stackoverflow/lib/common.dart +++ b/examples/stackoverflow/lib/common.dart @@ -2,6 +2,9 @@ import 'package:dio/dio.dart'; import 'package:flutter/material.dart'; import 'package:freezed_annotation/freezed_annotation.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'common.g.dart'; final client = Provider((ref) => Dio()); @@ -9,12 +12,15 @@ final client = Provider((ref) => Dio()); /// /// This is unimplemented by default, and will be overridden inside [MaterialApp] /// with the current theme obtained using a [BuildContext]. -final themeProvider = Provider( - (ref) => throw UnimplementedError(), +@Riverpod( // Specifying an empty "dependencies" signals riverpod_lint that this provider - // is scoped. - dependencies: const [], -); + // is scoped. This enables catching places where we need to override + // this provider. + dependencies: [], +) +ThemeData theme(ThemeRef ref) { + throw UnimplementedError(); +} class TimestampParser implements JsonConverter { const TimestampParser(); diff --git a/examples/stackoverflow/lib/common.g.dart b/examples/stackoverflow/lib/common.g.dart new file mode 100644 index 000000000..934ffb68a --- /dev/null +++ b/examples/stackoverflow/lib/common.g.dart @@ -0,0 +1,88 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names, require_trailing_commas + +part of 'common.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +/// A Provider that exposes the current theme. +/// +/// This is unimplemented by default, and will be overridden inside [MaterialApp] +/// with the current theme obtained using a [BuildContext]. +typedef ThemeRef = Ref; + +/// A Provider that exposes the current theme. +/// +/// This is unimplemented by default, and will be overridden inside [MaterialApp] +/// with the current theme obtained using a [BuildContext]. +@ProviderFor(theme) +const themeProvider = ThemeProvider._(); + +/// A Provider that exposes the current theme. +/// +/// This is unimplemented by default, and will be overridden inside [MaterialApp] +/// with the current theme obtained using a [BuildContext]. +final class ThemeProvider + extends $FunctionalProvider + with $Provider { + /// A Provider that exposes the current theme. + /// + /// This is unimplemented by default, and will be overridden inside [MaterialApp] + /// with the current theme obtained using a [BuildContext]. + const ThemeProvider._( + {ThemeData Function( + ThemeRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'themeProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final ThemeData Function( + ThemeRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$themeHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(ThemeData value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ThemeProvider $copyWithCreate( + ThemeData Function( + ThemeRef ref, + ) create, + ) { + return ThemeProvider._(create: create); + } + + @override + ThemeData create(ThemeRef ref) { + final _$cb = _createCb ?? theme; + return _$cb(ref); + } +} + +String _$themeHash() => r'ff39eda97684261eefc24ddb24e41172880644cd'; + +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/examples/stackoverflow/lib/home.dart b/examples/stackoverflow/lib/home.dart index d04df09df..fdfe12b5f 100644 --- a/examples/stackoverflow/lib/home.dart +++ b/examples/stackoverflow/lib/home.dart @@ -2,9 +2,12 @@ import 'package:dio/dio.dart'; import 'package:flutter/material.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'question.dart'; +import 'tag.dart'; +@Dependencies([tagTheme]) class MyHomePage extends HookConsumerWidget { const MyHomePage({super.key}); @@ -41,7 +44,7 @@ class MyHomePage extends HookConsumerWidget { itemBuilder: (context, index) { return ProviderScope( overrides: [ - currentQuestion.overrideWithValue( + currentQuestionProvider.overrideWithValue( ref .watch(paginatedQuestionsProvider(index ~/ 50)) .whenData((page) => page.items[index % 50]), diff --git a/examples/stackoverflow/lib/main.dart b/examples/stackoverflow/lib/main.dart index 64e01ed3d..74094df6c 100644 --- a/examples/stackoverflow/lib/main.dart +++ b/examples/stackoverflow/lib/main.dart @@ -25,13 +25,12 @@ class MyApp extends StatelessWidget { /// current theme, without having a BuildContext. themeProvider.overrideWithValue(theme), ], - child: ListTileTheme( - textColor: const Color(0xFFe7e8eb), - child: child!, + child: const ListTileTheme( + textColor: Color(0xFFe7e8eb), + child: MyHomePage(), ), ); }, - home: const MyHomePage(), ); } } diff --git a/examples/stackoverflow/lib/question.dart b/examples/stackoverflow/lib/question.dart index a6a036f9f..14a065d0d 100644 --- a/examples/stackoverflow/lib/question.dart +++ b/examples/stackoverflow/lib/question.dart @@ -6,6 +6,7 @@ import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:freezed_annotation/freezed_annotation.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:html/parser.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'common.dart'; import 'tag.dart'; @@ -122,20 +123,22 @@ final questionThemeProvider = Provider((ref) { /// /// This is an optional step. Since scoping is a fairly advanced mechanism, /// it's entirely fine to simply pass the [Question] to [QuestionItem] directly. -final currentQuestion = Provider>((ref) { +@Riverpod(dependencies: []) +AsyncValue currentQuestion(CurrentQuestionRef ref) { throw UnimplementedError(); -}); +} /// A UI widget rendering a [Question]. /// /// That question will be obtained through [currentQuestion]. As such, it is /// necessary to override that provider before using [QuestionItem]. +@Dependencies([currentQuestion, tagTheme]) class QuestionItem extends HookConsumerWidget { const QuestionItem({super.key}); @override Widget build(BuildContext context, WidgetRef ref) { - final question = ref.watch(currentQuestion); + final question = ref.watch(currentQuestionProvider); final questionTheme = ref.watch(questionThemeProvider); return question.when( diff --git a/examples/stackoverflow/lib/question.g.dart b/examples/stackoverflow/lib/question.g.dart index 2f15b3978..6fb5a5720 100644 --- a/examples/stackoverflow/lib/question.g.dart +++ b/examples/stackoverflow/lib/question.g.dart @@ -58,3 +58,119 @@ Map _$$QuestionImplToJson(_$QuestionImpl instance) => 'title': instance.title, 'body': instance.body, }; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +/// A scoped provider, exposing the current question used by [QuestionItem]. +/// +/// This is used as a performance optimization to pass a [Question] to +/// [QuestionItem], while still instantiating [QuestionItem] using the `const` +/// keyword. +/// +/// This allows [QuestionItem] to rebuild less often. +/// By doing so, even when using [QuestionItem] in a [ListView], even if new +/// questions are obtained, previously rendered [QuestionItem]s won't rebuild. +/// +/// This is an optional step. Since scoping is a fairly advanced mechanism, +/// it's entirely fine to simply pass the [Question] to [QuestionItem] directly. +typedef CurrentQuestionRef = Ref>; + +/// A scoped provider, exposing the current question used by [QuestionItem]. +/// +/// This is used as a performance optimization to pass a [Question] to +/// [QuestionItem], while still instantiating [QuestionItem] using the `const` +/// keyword. +/// +/// This allows [QuestionItem] to rebuild less often. +/// By doing so, even when using [QuestionItem] in a [ListView], even if new +/// questions are obtained, previously rendered [QuestionItem]s won't rebuild. +/// +/// This is an optional step. Since scoping is a fairly advanced mechanism, +/// it's entirely fine to simply pass the [Question] to [QuestionItem] directly. +@ProviderFor(currentQuestion) +const currentQuestionProvider = CurrentQuestionProvider._(); + +/// A scoped provider, exposing the current question used by [QuestionItem]. +/// +/// This is used as a performance optimization to pass a [Question] to +/// [QuestionItem], while still instantiating [QuestionItem] using the `const` +/// keyword. +/// +/// This allows [QuestionItem] to rebuild less often. +/// By doing so, even when using [QuestionItem] in a [ListView], even if new +/// questions are obtained, previously rendered [QuestionItem]s won't rebuild. +/// +/// This is an optional step. Since scoping is a fairly advanced mechanism, +/// it's entirely fine to simply pass the [Question] to [QuestionItem] directly. +final class CurrentQuestionProvider extends $FunctionalProvider< + AsyncValue, AsyncValue, CurrentQuestionRef> + with $Provider, CurrentQuestionRef> { + /// A scoped provider, exposing the current question used by [QuestionItem]. + /// + /// This is used as a performance optimization to pass a [Question] to + /// [QuestionItem], while still instantiating [QuestionItem] using the `const` + /// keyword. + /// + /// This allows [QuestionItem] to rebuild less often. + /// By doing so, even when using [QuestionItem] in a [ListView], even if new + /// questions are obtained, previously rendered [QuestionItem]s won't rebuild. + /// + /// This is an optional step. Since scoping is a fairly advanced mechanism, + /// it's entirely fine to simply pass the [Question] to [QuestionItem] directly. + const CurrentQuestionProvider._( + {AsyncValue Function( + CurrentQuestionRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'currentQuestionProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final AsyncValue Function( + CurrentQuestionRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$currentQuestionHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(AsyncValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider>(value), + ); + } + + @$internal + @override + $ProviderElement> $createElement( + ProviderContainer container) => + $ProviderElement(this, container); + + @override + CurrentQuestionProvider $copyWithCreate( + AsyncValue Function( + CurrentQuestionRef ref, + ) create, + ) { + return CurrentQuestionProvider._(create: create); + } + + @override + AsyncValue create(CurrentQuestionRef ref) { + final _$cb = _createCb ?? currentQuestion; + return _$cb(ref); + } +} + +String _$currentQuestionHash() => r'2179e068c1d64674dc292a1a027e9e338284c57f'; + +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/examples/stackoverflow/lib/tag.dart b/examples/stackoverflow/lib/tag.dart index 7aac44caa..ac2f77963 100644 --- a/examples/stackoverflow/lib/tag.dart +++ b/examples/stackoverflow/lib/tag.dart @@ -1,9 +1,11 @@ import 'package:flutter/material.dart'; import 'package:freezed_annotation/freezed_annotation.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'common.dart'; +part 'tag.g.dart'; part 'tag.freezed.dart'; @freezed @@ -16,25 +18,24 @@ class TagTheme with _$TagTheme { }) = _TagTheme; } -final tagThemeProvider = Provider( - (ref) { - final theme = ref.watch(themeProvider); - - return TagTheme( - padding: EdgeInsets.symmetric( - horizontal: theme.textTheme.bodyLarge!.fontSize! * 0.5, - vertical: theme.textTheme.bodyLarge!.fontSize! * 0.4, - ), - style: theme.textTheme.bodyMedium!.copyWith( - color: const Color(0xff9cc3db), - ), - borderRadius: BorderRadius.circular(3), - backgroundColor: const Color(0xFF3e4a52), - ); - }, - dependencies: [themeProvider], -); +@Riverpod(dependencies: [theme]) +TagTheme tagTheme(TagThemeRef ref) { + final theme = ref.watch(themeProvider); + + return TagTheme( + padding: EdgeInsets.symmetric( + horizontal: theme.textTheme.bodyLarge!.fontSize! * 0.5, + vertical: theme.textTheme.bodyLarge!.fontSize! * 0.4, + ), + style: theme.textTheme.bodyMedium!.copyWith( + color: const Color(0xff9cc3db), + ), + borderRadius: BorderRadius.circular(3), + backgroundColor: const Color(0xFF3e4a52), + ); +} +@Dependencies([tagTheme]) class Tag extends HookConsumerWidget { const Tag({super.key, required this.tag}); diff --git a/examples/stackoverflow/lib/tag.g.dart b/examples/stackoverflow/lib/tag.g.dart new file mode 100644 index 000000000..82c0b09cf --- /dev/null +++ b/examples/stackoverflow/lib/tag.g.dart @@ -0,0 +1,76 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ignore_for_file: non_constant_identifier_names, require_trailing_commas + +part of 'tag.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef TagThemeRef = Ref; + +@ProviderFor(tagTheme) +const tagThemeProvider = TagThemeProvider._(); + +final class TagThemeProvider + extends $FunctionalProvider + with $Provider { + const TagThemeProvider._( + {TagTheme Function( + TagThemeRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'tagThemeProvider', + isAutoDispose: true, + dependencies: const [themeProvider], + allTransitiveDependencies: const [ + TagThemeProvider.$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = themeProvider; + + final TagTheme Function( + TagThemeRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$tagThemeHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(TagTheme value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + TagThemeProvider $copyWithCreate( + TagTheme Function( + TagThemeRef ref, + ) create, + ) { + return TagThemeProvider._(create: create); + } + + @override + TagTheme create(TagThemeRef ref) { + final _$cb = _createCb ?? tagTheme; + return _$cb(ref); + } +} + +String _$tagThemeHash() => r'bf5d051ea43e2f60d370096bb756aa81f21e9d68'; + +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart index 7f4fb5595..d88ba8c15 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart @@ -182,22 +182,10 @@ extension on DartObject { } } -sealed class Location {} - -class LocationNode implements Location { - LocationNode(this.node); - final AstNode node; -} - -class LocationElement implements Location { - LocationElement(this.element); - final Element element; -} - final class AccumulatedDependency { - AccumulatedDependency._({required this.location, required this.provider}); + AccumulatedDependency._({required this.node, required this.provider}); - final Location location; + final AstNode? node; final GeneratorProviderDeclarationElement provider; } @@ -208,7 +196,7 @@ final class AccumulatedDependencyList { required this.node, required this.riverpod, required this.dependencies, - required this.dependenciesElement, + required this.widgetDependencies, required this.overrides, }) : parent = node.ancestors .map((e) => e.accumulatedDependencies) @@ -219,35 +207,35 @@ final class AccumulatedDependencyList { final AccumulatedDependencyList? parent; final GeneratorProviderDeclaration? riverpod; final DependenciesAnnotation? dependencies; - final DependenciesAnnotationElement? dependenciesElement; + final List? widgetDependencies; final ProviderScopeInstanceCreationExpression? overrides; Iterable? get allDependencies { final dependencies = this.dependencies?.dependencies; final riverpod = this.riverpod?.annotation.dependencyList; - final dependenciesElement = this.dependenciesElement?.dependencies; + final widgetDependencies = this.widgetDependencies; if (dependencies == null && riverpod == null && - dependenciesElement == null) { + widgetDependencies == null) { return null; } final dependenciesValues = dependencies?.values?.map( (e) => AccumulatedDependency._( - location: LocationNode(e.node), + node: e.node, provider: e.provider, ), ); final riverpodValues = riverpod?.values?.map( (e) => AccumulatedDependency._( - location: LocationNode(e.node), + node: e.node, provider: e.provider, ), ); - final dependenciesElementValues = dependenciesElement?.map( + final dependenciesElementValues = widgetDependencies?.map( (provider) => AccumulatedDependency._( - location: LocationElement(this.dependenciesElement!.element.element!), + node: null, provider: provider, ), ); @@ -257,12 +245,38 @@ final class AccumulatedDependencyList { .followedBy(dependenciesElementValues ?? const []); } - Iterable get overridesIncludingParents sync* { + Iterable get _overridesIncludingParents sync* { if (overrides?.overrides?.overrides case final overrides?) { yield* overrides; } - if (parent case final parent?) yield* parent.overridesIncludingParents; + if (parent case final parent?) yield* parent._overridesIncludingParents; + } + + late final Set _allOverrides = + _overridesIncludingParents + // If we are overriding only one part of a family, + // we can't guarantee that later reads will point to the override. + // So we ignore those overrides when considering if a provider is + // safe to use. + .where((e) => e.familyArguments == null) + .map((e) => e.provider?.providerElement) + .whereNotNull() + .toSet(); + + bool isSafelyAccessibleAfterOverrides( + GeneratorProviderDeclarationElement provider, + ) { + final dependencies = provider.annotation.dependencies; + if (dependencies == null) return true; + + if (_allOverrides.contains(provider)) return true; + + // If the provider has an empty list of dependencies, and it is not overridden, + // then it is not safe to use. + if (dependencies.isEmpty) return false; + + return dependencies.every(isSafelyAccessibleAfterOverrides); } } @@ -292,7 +306,7 @@ extension on InstanceCreationExpression { overrides: providerScope, dependencies: null, riverpod: null, - dependenciesElement: null, + widgetDependencies: null, ); }); } @@ -318,7 +332,7 @@ extension on AnnotatedNode { overrides: null, dependencies: dependencies, riverpod: provider, - dependenciesElement: state?.widget?.dependencies, + widgetDependencies: state?.widget?.dependencies?.dependencies, ); }); } diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index be899aaac..61d0190f4 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -51,10 +51,9 @@ class RiverpodInvalidGenerationSourceError super.message, { super.todo = '', super.element, - this.astNode, - }); - - final AstNode? astNode; + AstNode? astNode, + // TODO changelog bumped source_gen 0.14.0 to reprot AstNodes + }) : super(node: astNode); } @immutable diff --git a/packages/riverpod_generator/pubspec.yaml b/packages/riverpod_generator/pubspec.yaml index 3ba9aa9ab..d896d434e 100644 --- a/packages/riverpod_generator/pubspec.yaml +++ b/packages/riverpod_generator/pubspec.yaml @@ -19,7 +19,7 @@ dependencies: path: ^1.8.0 riverpod_analyzer_utils: 1.0.0-dev.1 riverpod_annotation: 3.0.0-dev.3 - source_gen: ^1.2.0 + source_gen: ^1.4.0 dev_dependencies: build_runner: ^2.1.7 diff --git a/packages/riverpod_lint/lib/riverpod_lint.dart b/packages/riverpod_lint/lib/riverpod_lint.dart index 80b4b0140..1703b1e3b 100644 --- a/packages/riverpod_lint/lib/riverpod_lint.dart +++ b/packages/riverpod_lint/lib/riverpod_lint.dart @@ -25,12 +25,13 @@ import 'src/lints/scoped_providers_should_specify_dependencies.dart'; import 'src/lints/unknown_scoped_usage.dart'; import 'src/lints/unsupported_provider_value.dart'; import 'src/migration/missing_legacy_import.dart'; +import 'src/riverpod_custom_lint.dart'; PluginBase createPlugin() => _RiverpodPlugin(); class _RiverpodPlugin extends PluginBase { @override - List getLintRules(CustomLintConfigs configs) => [ + List getLintRules(CustomLintConfigs configs) => [ const AsyncValueNullablePattern(), const AvoidBuildContextInProviders(), const OnlyUseKeepAliveInsideKeepAlive(), diff --git a/packages/riverpod_lint/lib/src/lints/avoid_public_notifier_properties.dart b/packages/riverpod_lint/lib/src/lints/avoid_public_notifier_properties.dart index e5ad3bcba..44c701506 100644 --- a/packages/riverpod_lint/lib/src/lints/avoid_public_notifier_properties.dart +++ b/packages/riverpod_lint/lib/src/lints/avoid_public_notifier_properties.dart @@ -4,7 +4,9 @@ import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; -class AvoidPublicNotifierProperties extends DartLintRule { +import '../riverpod_custom_lint.dart'; + +class AvoidPublicNotifierProperties extends RiverpodLintRule { const AvoidPublicNotifierProperties() : super(code: _code); static const _code = LintCode( diff --git a/packages/riverpod_lint/lib/src/lints/functional_ref.dart b/packages/riverpod_lint/lib/src/lints/functional_ref.dart index 56d981c91..ebc69babe 100644 --- a/packages/riverpod_lint/lib/src/lints/functional_ref.dart +++ b/packages/riverpod_lint/lib/src/lints/functional_ref.dart @@ -76,7 +76,7 @@ class FunctionalRef extends RiverpodLintRule { } @override - List getFixes() => [FunctionalRefFix()]; + List getFixes() => [FunctionalRefFix()]; } class FunctionalRefFix extends RiverpodFix { @@ -117,6 +117,8 @@ class FunctionalRefFix extends RiverpodFix { return; } + if (refNode is! SimpleFormalParameter) return; + // No type specified, adding it. final changeBuilder = reporter.createChangeBuilder( message: 'Type as $expectedRefType', @@ -129,7 +131,6 @@ class FunctionalRefFix extends RiverpodFix { return; } - refNode as SimpleFormalParameter; builder.addSimpleReplacement( sourceRangeFrom( start: refNode.type!.offset, diff --git a/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart b/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart index 974aefa43..ac25b31a4 100644 --- a/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart +++ b/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart @@ -6,9 +6,10 @@ import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import '../riverpod_custom_lint.dart'; import 'scoped_providers_should_specify_dependencies.dart'; -class MissingProviderScope extends DartLintRule { +class MissingProviderScope extends RiverpodLintRule { const MissingProviderScope() : super(code: _code); static const _code = LintCode( @@ -46,7 +47,7 @@ class MissingProviderScope extends DartLintRule { } @override - List getFixes() => [AddProviderScope()]; + List getFixes() => [AddProviderScope()]; } class AddProviderScope extends DartFix { diff --git a/packages/riverpod_lint/lib/src/lints/notifier_extends.dart b/packages/riverpod_lint/lib/src/lints/notifier_extends.dart index 60a39540e..1a4cb8ace 100644 --- a/packages/riverpod_lint/lib/src/lints/notifier_extends.dart +++ b/packages/riverpod_lint/lib/src/lints/notifier_extends.dart @@ -96,7 +96,7 @@ class NotifierExtends extends RiverpodLintRule { } @override - List getFixes() => [NotifierExtendsFix()]; + List getFixes() => [NotifierExtendsFix()]; } class NotifierExtendsFix extends RiverpodFix { diff --git a/packages/riverpod_lint/lib/src/lints/protected_notifier_properties.dart b/packages/riverpod_lint/lib/src/lints/protected_notifier_properties.dart index 968d4bf23..8eabf1f3e 100644 --- a/packages/riverpod_lint/lib/src/lints/protected_notifier_properties.dart +++ b/packages/riverpod_lint/lib/src/lints/protected_notifier_properties.dart @@ -3,7 +3,9 @@ import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; -class ProtectedNotifierProperties extends DartLintRule { +import '../riverpod_custom_lint.dart'; + +class ProtectedNotifierProperties extends RiverpodLintRule { const ProtectedNotifierProperties() : super(code: _code); static const _code = LintCode( diff --git a/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart b/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart index ca6f64f01..4612adc19 100644 --- a/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart +++ b/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart @@ -16,7 +16,7 @@ class _LocatedProvider { _LocatedProvider(this.provider, this.node); final ProviderDeclarationElement provider; - final Location node; + final AstNode node; } class _MyDiagnostic implements DiagnosticMessage { @@ -63,6 +63,7 @@ class _FindNestedDependency extends RecursiveRiverpodAstVisitor { _FindNestedDependency copyWith({ AccumulatedDependencyList? accumulatedDependencyList, bool? visitStates, + void Function(AccumulatedDependencyList child)? parentAddChild, }) { return _FindNestedDependency( accumulatedDependencyList ?? this.accumulatedDependencyList, @@ -71,6 +72,11 @@ class _FindNestedDependency extends RecursiveRiverpodAstVisitor { ); } + @override + void visitComment(Comment node) { + // Identifiers in comments shouldn't count. + } + @override void visitWidgetDeclaration(WidgetDeclaration node) { super.visitWidgetDeclaration(node); @@ -107,7 +113,7 @@ class _FindNestedDependency extends RecursiveRiverpodAstVisitor { super.visitProviderIdentifier(node); onProvider( - _LocatedProvider(node.providerElement, LocationNode(node.node)), + _LocatedProvider(node.providerElement, node.node), accumulatedDependencyList, checkOverrides: false, ); @@ -116,7 +122,9 @@ class _FindNestedDependency extends RecursiveRiverpodAstVisitor { @override void visitAccumulatedDependencyList(AccumulatedDependencyList node) { node.node.visitChildren( - copyWith(accumulatedDependencyList: node), + copyWith( + accumulatedDependencyList: node, + ), ); } @@ -124,10 +132,12 @@ class _FindNestedDependency extends RecursiveRiverpodAstVisitor { void visitIdentifierDependencies(IdentifierDependencies node) { super.visitIdentifierDependencies(node); + if (_isSelfReference(node.dependencies)) return; + if (node.dependencies.dependencies case final deps?) { for (final dep in deps) { onProvider( - _LocatedProvider(dep, LocationNode(node.node)), + _LocatedProvider(dep, node.node), accumulatedDependencyList, checkOverrides: false, ); @@ -135,10 +145,18 @@ class _FindNestedDependency extends RecursiveRiverpodAstVisitor { } } + /// If an object references itself, so we don't count those dependencies + /// as "used". + bool _isSelfReference(DependenciesAnnotationElement node) { + return node == accumulatedDependencyList.dependencies?.element; + } + @override void visitNamedTypeDependencies(NamedTypeDependencies node) { super.visitNamedTypeDependencies(node); + if (_isSelfReference(node.dependencies)) return; + final type = node.node.type; if (type == null) return; late final isWidget = widgetType.isAssignableFromType(type); @@ -146,7 +164,7 @@ class _FindNestedDependency extends RecursiveRiverpodAstVisitor { if (node.dependencies.dependencies case final deps?) { for (final dep in deps) { onProvider( - _LocatedProvider(dep, LocationNode(node.node)), + _LocatedProvider(dep, node.node), accumulatedDependencyList, // We check overrides only for Widget instances, as we can't guarantee // that non-widget instances use a "ref" that's a child of the overrides. @@ -209,18 +227,12 @@ class ProviderDependencies extends RiverpodLintRule { final provider = locatedProvider.provider; if (provider is! GeneratorProviderDeclarationElement) return; if (!provider.isScoped) return; + // Check if the provider is overridden. If it is, the provider doesn't // count towards the unused/missing dependencies - if (checkOverrides) { - for (final override in list.overridesIncludingParents) { - // If we are overriding only one part of a family, - // we can't guarantee that later reads will point to the override. - if (override.familyArguments != null) continue; - - if (override.provider?.providerElement == provider) { - return; - } - } + if (checkOverrides && + list.isSafelyAccessibleAfterOverrides(provider)) { + return; } usedDependencies.add(locatedProvider); @@ -260,30 +272,24 @@ class ProviderDependencies extends RiverpodLintRule { message.writeAll(missingDependencies.map((e) => e.provider.name), ', '); } + late final unit = list.node.thisOrAncestorOfType(); + late final source = unit?.declaredElement?.source; + reporter.reportErrorForNode( _code, list.target, [message.toString()], [ for (final dependency in missingDependencies) - if (dependency.provider.element.source case final source?) + if (source != null) _MyDiagnostic( message: dependency.provider.name, filePath: source.fullName, - offset: switch (dependency.node) { - LocationNode(:final node) => node.offset, - LocationElement(:final element) => element.nameOffset, - }, - length: switch (dependency.node) { - LocationNode(:final node) => node.length, - LocationElement(:final element) => element.nameLength, - }, + offset: dependency.node.offset, + length: dependency.node.length, ), ], - _Data( - usedDependencies: usedDependencies, - list: list, - ), + _Data(usedDependencies: usedDependencies, list: list), ); }); } diff --git a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart index 8d2d83e08..59e10318a 100644 --- a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart +++ b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart @@ -25,6 +25,9 @@ class UnknownScopedUsage extends RiverpodLintRule { CustomLintContext context, ) { riverpodRegistry(context).addProviderIdentifier((identifier) { + // Ignore [provider] identifiers in comments. + if (identifier.node.parent is CommentReference) return; + final providerElement = identifier.providerElement; if (providerElement is! GeneratorProviderDeclarationElement) return; if (!providerElement.isScoped) return; diff --git a/packages/riverpod_lint/lib/src/riverpod_custom_lint.dart b/packages/riverpod_lint/lib/src/riverpod_custom_lint.dart index 3a635a3e8..c41924e57 100644 --- a/packages/riverpod_lint/lib/src/riverpod_custom_lint.dart +++ b/packages/riverpod_lint/lib/src/riverpod_custom_lint.dart @@ -62,6 +62,9 @@ abstract class RiverpodLintRule extends DartLintRule with _ParseRiverpod { await _setupRiverpod(resolver, context); await super.startUp(resolver, context); } + + @override + List getFixes() => []; } abstract class RiverpodFix extends DartFix with _ParseRiverpod { diff --git a/packages/riverpod_lint_flutter_test/analysis_options.yaml b/packages/riverpod_lint_flutter_test/analysis_options.yaml index d38d066bd..c1c81786a 100644 --- a/packages/riverpod_lint_flutter_test/analysis_options.yaml +++ b/packages/riverpod_lint_flutter_test/analysis_options.yaml @@ -3,5 +3,5 @@ analyzer: - custom_lint exclude: # Files with errors on purpose - - test/lints/notifier_extends/notifier_extends.g.dart + - test/lints/notifier_extends.g.dart - test/lints/functional_ref.g.dart diff --git a/packages/riverpod_lint_flutter_test/build.yaml b/packages/riverpod_lint_flutter_test/build.yaml index cf95fd7da..aee239ff4 100644 --- a/packages/riverpod_lint_flutter_test/build.yaml +++ b/packages/riverpod_lint_flutter_test/build.yaml @@ -5,7 +5,6 @@ targets: generate_for: exclude: # Those files voluntarily have the generation fail - - test/lints/notifier_build/notifier_build.dart - - test/lints/notifier_build/fix/notifier_build.dart - - test/lints/riverpod_syntax_error/riverpod_syntax_error.dart + - test/lints/notifier_build.dart + - test/lints/riverpod_syntax_error.dart - test/lints/functional_ref/failing_functional_ref.dart diff --git a/packages/riverpod_lint_flutter_test/pubspec.yaml b/packages/riverpod_lint_flutter_test/pubspec.yaml index e3d37c6fb..6519e40d3 100644 --- a/packages/riverpod_lint_flutter_test/pubspec.yaml +++ b/packages/riverpod_lint_flutter_test/pubspec.yaml @@ -25,6 +25,11 @@ dev_dependencies: test: ^1.24.9 flutter_test: sdk: flutter + glob: ^2.1.2 + analyzer: ^6.0.0 + path: ^1.9.0 + source_span: ^1.10.0 + analyzer_plugin: ^0.11.3 dependency_overrides: riverpod_generator: diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart index 97154ba21..fe2af3181 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart @@ -1,12 +1,12 @@ import 'package:riverpod_lint/src/assists/class_based_to_functional_provider.dart'; import 'package:analyzer/source/source_range.dart'; -import '../../golden.dart'; +import '../../test_lint.dart'; void main() { testGolden( 'Convert plain class provider to functional provider', - 'assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff', + 'test/assists/goldens/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff', sourcePath: 'test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.dart', (result) async { diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart index 6f15d46df..f0e59e0be 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart @@ -1,12 +1,12 @@ import 'package:riverpod_lint/src/assists/functional_to_class_based_provider.dart'; import 'package:analyzer/source/source_range.dart'; -import '../../golden.dart'; +import '../../test_lint.dart'; void main() { testGolden( 'Convert functional providers to class-based providers', - 'assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff', + 'test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff', sourcePath: 'test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart', (result) async { diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart index 664c6e71e..099e03afa 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart @@ -6,7 +6,7 @@ import 'package:riverpod_lint/src/assists/convert_to_widget_utils.dart'; import 'package:riverpod_lint/src/riverpod_custom_lint.dart'; import 'package:test/test.dart'; -import '../../golden.dart'; +import '../../test_lint.dart'; void main() { final pubspecWithDependencies = Pubspec( @@ -37,7 +37,7 @@ void main() { targetWidget: targetWidget, ), 'Convert widgets to ${targetWidget.name}s with hooks_riverpod and flutter_hooks dependency', - 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff', + 'test/assists/goldens/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff', pubspecWithDependencies, expectedChangeCount, ); @@ -64,7 +64,7 @@ void main() { targetWidget: targetWidget, ), 'Convert widgets to ${targetWidget.name}s with hooks_riverpod and flutter_hooks dependency', - 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff', + 'test/assists/goldens/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff', pubspecWithDependencies, expectedChangeCount, ); @@ -94,12 +94,12 @@ void main() { switch (targetWidget) { case StatelessBaseWidgetType.hookWidget: case StatelessBaseWidgetType.hookConsumerWidget: - goldenFilePath = 'assists/empty.diff'; + goldenFilePath = 'test/assists/goldens/empty.diff'; break; case StatelessBaseWidgetType.consumerWidget: case StatelessBaseWidgetType.statelessWidget: goldenFilePath = - 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff'; + 'test/assists/goldens/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff'; break; } @@ -134,12 +134,12 @@ void main() { switch (targetWidget) { case StatefulBaseWidgetType.statefulHookWidget: case StatefulBaseWidgetType.statefulHookConsumerWidget: - goldenFilePath = 'assists/empty.diff'; + goldenFilePath = 'test/assists/goldens/empty.diff'; break; case StatefulBaseWidgetType.consumerStatefulWidget: case StatefulBaseWidgetType.statefulWidget: goldenFilePath = - 'assists/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff'; + 'test/assists/goldens/convert_to_widget/convert_to_${targetWidget.name.toSnakeCase()}.diff'; break; } @@ -235,7 +235,10 @@ void _runGoldenTest( pubspec: pubspec), ]; - expect(changes, hasLength(expectedChangeCount)); + expect( + changes, + hasLength(expectedChangeCount), + ); return changes; }, diff --git a/packages/riverpod_lint_flutter_test/test/assists/empty.diff b/packages/riverpod_lint_flutter_test/test/assists/empty.diff deleted file mode 100644 index e69de29bb..000000000 diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff similarity index 100% rename from packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff rename to packages/riverpod_lint_flutter_test/test/assists/goldens/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff similarity index 100% rename from packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff rename to packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_consumer_stateful_widget.diff similarity index 100% rename from packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_stateful_widget.diff rename to packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_consumer_stateful_widget.diff diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_consumer_widget.diff similarity index 100% rename from packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_consumer_widget.diff rename to packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_consumer_widget.diff diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_hook_consumer_widget.diff similarity index 100% rename from packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_consumer_widget.diff rename to packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_hook_consumer_widget.diff diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_hook_widget.diff similarity index 100% rename from packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_hook_widget.diff rename to packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_hook_widget.diff diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_stateful_hook_consumer_widget.diff similarity index 100% rename from packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_consumer_widget.diff rename to packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_stateful_hook_consumer_widget.diff diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_stateful_hook_widget.diff similarity index 100% rename from packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_hook_widget.diff rename to packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_stateful_hook_widget.diff diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_stateful_widget.diff similarity index 100% rename from packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateful_widget.diff rename to packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_stateful_widget.diff diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_stateless_widget.diff similarity index 100% rename from packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_stateless_widget.diff rename to packages/riverpod_lint_flutter_test/test/assists/goldens/convert_to_widget/convert_to_stateless_widget.diff diff --git a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/wrap_widget/wrap_with_consumer.diff similarity index 100% rename from packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_consumer.diff rename to packages/riverpod_lint_flutter_test/test/assists/goldens/wrap_widget/wrap_with_consumer.diff diff --git a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/wrap_widget/wrap_with_provider_scope.diff similarity index 100% rename from packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_with_provider_scope.diff rename to packages/riverpod_lint_flutter_test/test/assists/goldens/wrap_widget/wrap_with_provider_scope.diff diff --git a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart index e45b6cc7b..fa9d77973 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart @@ -3,12 +3,12 @@ import 'package:riverpod_lint/src/assists/wrap_with_consumer.dart'; import 'package:riverpod_lint/src/assists/wrap_with_provider_scope.dart'; import 'package:analyzer/source/source_range.dart'; -import '../../golden.dart'; +import '../../test_lint.dart'; void main() { testGolden( 'Wrap with consumer', - 'assists/wrap_widget/wrap_with_consumer.diff', + 'test/assists/goldens/wrap_widget/wrap_with_consumer.diff', sourcePath: 'test/assists/wrap_widget/wrap_widget.dart', (result) async { final assist = WrapWithConsumer(); @@ -35,7 +35,7 @@ void main() { testGolden( 'Wrap with ProviderScope', - 'assists/wrap_widget/wrap_with_provider_scope.diff', + 'test/assists/goldens/wrap_widget/wrap_with_provider_scope.diff', sourcePath: 'test/assists/wrap_widget/wrap_widget.dart', (result) async { final assist = WrapWithProviderScope(); diff --git a/packages/riverpod_lint_flutter_test/test/encoders.dart b/packages/riverpod_lint_flutter_test/test/encoders.dart new file mode 100644 index 000000000..46ab91732 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/encoders.dart @@ -0,0 +1,199 @@ +import 'dart:io'; +import 'dart:math'; + +import 'package:analyzer/diagnostic/diagnostic.dart'; +import 'package:analyzer/error/error.dart'; +import 'package:analyzer/source/line_info.dart'; +import 'package:analyzer_plugin/protocol/protocol_generated.dart'; +import 'package:custom_lint_core/custom_lint_core.dart'; +import 'package:matcher/matcher.dart'; +import 'package:path/path.dart' as p; +import 'package:test/test.dart'; + +import 'golden.dart'; + +Matcher matchesPrioritizedSourceChangesGolden( + String fileName, { + required String source, + required String sourcePath, +}) { + return matchersGoldenFile>( + File(fileName), + isEmpty: (value) => value.isEmpty, + encode: (changes) { + return encodePrioritizedSourceChanges( + changes, + sources: {'**': source}, + relativePath: Directory.current.path, + ); + }, + ); +} + +Matcher matchesAnalysisErrorGoldens(String fileName) { + return matchersGoldenFile>( + File(fileName), + isEmpty: (value) => value.isEmpty, + encode: (changes) { + return _encodeAnalysisErrors( + changes, + relativePath: Directory.current.path, + ); + }, + ); +} + +String _encodeAnalysisErrors( + Iterable errors, { + required String relativePath, +}) { + final buffer = StringBuffer(); + + for (final (index, error) in errors.indexed) { + if (index != 0) buffer.writeln('\n=======\n'); + + _writeAnalysisError( + buffer, + error, + relativePath: relativePath, + ); + } + + return buffer.toString(); +} + +void _writeAnalysisError( + StringBuffer buffer, + AnalysisError error, { + String indent = '', + required String relativePath, +}) { + buffer.writeln('${indent}code: ${error.errorCode.name}'); + _writeDiagnostic( + buffer, + error, + indent: indent, + relativePath: Directory.current.path, + ); +} + +void _writeDiagnostic( + StringBuffer buffer, + Diagnostic diagnostic, { + String indent = '', + required String relativePath, +}) { + buffer.writeln('${indent}severity: ${diagnostic.severity}'); + if (diagnostic.correctionMessage case final correctionMessage?) { + buffer.writeln('${indent}correctionMessage: ${correctionMessage}'); + } + if (diagnostic.contextMessages.isNotEmpty) { + buffer.writeln('${indent}contextMessages:'); + for (final (index, message) in diagnostic.contextMessages.indexed) { + if (index != 0) buffer.writeln(); + + _writeDiagnosticMessage( + buffer, + message, + indent: indent + ' ', + relativePath: relativePath, + ); + } + } + + _writeDiagnosticMessage( + buffer, + diagnostic.problemMessage, + indent: indent, + relativePath: relativePath, + ); +} + +void _writeDiagnosticMessage( + StringBuffer buffer, + DiagnosticMessage error, { + String indent = '', + required String relativePath, +}) { + buffer.writeln( + '${indent}message: ${error.messageText(includeUrl: false)}', + ); + + if (error.url case final url?) { + buffer.writeln('${indent}url: ${url}'); + } + + _highlight( + buffer, + File(error.filePath), + offset: error.offset, + length: error.length, + indent: indent, + ); +} + +void _highlight( + StringBuffer buffer, + File file, { + required int offset, + required int length, + String indent = '', +}) { + const leadingCount = 2; + const trailingCount = 2; + + final source = file.readAsStringSync(); + final lineInfo = LineInfo.fromContent(source); + + final start = lineInfo.getLocation(offset); + final end = lineInfo.getLocation(offset + length); + + buffer.writeln( + '${indent}${p.normalize(p.relative(file.path))}:${start.lineNumber}:${start.columnNumber}', + ); + buffer.writeln(); + + buffer.writeln('$indent```${p.extension(file.path).substring(1)}'); + final firstChangedLine = start.lineNumber - 1; + final lastChangedLine = end.lineNumber - 1; + + final endLine = min(lastChangedLine + trailingCount, lineInfo.lineCount - 1); + + for (var line = max(0, firstChangedLine - leadingCount); + line <= endLine; + line++) { + final endOfSource = !(line + 1 < lineInfo.lineCount); + + final lineContent = source.substring( + lineInfo.getOffsetOfLine(line), + endOfSource ? null : lineInfo.getOffsetOfLine(line + 1) - 1, + ); + buffer.write(indent); + + var startCol = 0; + if (line == firstChangedLine) { + startCol = max(0, start.columnNumber - 1); + } + + buffer.write(lineContent.substring(0, startCol)); + if (line == firstChangedLine) buffer.write('>>>'); + + var endCol = max(lineContent.length, 0); + if (line == lastChangedLine) { + endCol = max( + min(end.columnNumber - 1, lineContent.length), + startCol, + ); + } + + buffer.write(lineContent.substring(startCol, endCol)); + if (line == lastChangedLine) buffer.write('<<<'); + + if (endCol < lineContent.length) { + buffer.write(lineContent.substring(endCol)); + } + + if (!endOfSource) buffer.writeln(); + } + buffer.writeln('$indent```'); +} diff --git a/packages/riverpod_lint_flutter_test/test/golden.dart b/packages/riverpod_lint_flutter_test/test/golden.dart index fd9287169..7d362c40b 100644 --- a/packages/riverpod_lint_flutter_test/test/golden.dart +++ b/packages/riverpod_lint_flutter_test/test/golden.dart @@ -2,67 +2,110 @@ import 'dart:io'; import 'package:freezed_annotation/freezed_annotation.dart'; import 'package:test/test.dart'; -import 'package:path/path.dart'; -import 'package:custom_lint_core/custom_lint_core.dart'; -import 'package:analyzer_plugin/protocol/protocol_generated.dart'; -import 'package:analyzer/dart/analysis/results.dart'; -import 'package:analyzer/dart/analysis/utilities.dart'; -final goldenWrite = bool.parse(Platform.environment[r'goldens'] ?? 'false'); +final _goldenWrite = bool.parse(Platform.environment[r'goldens'] ?? 'false'); -File writeToTemporaryFile(String content) { - final tempDir = Directory.systemTemp.createTempSync(); - addTearDown(() => tempDir.deleteSync(recursive: true)); +/// Expects that a value matches a golden file. +@visibleForTesting +Matcher matchersGoldenFile( + File file, { + required String Function(T value) encode, + required bool Function(T value) isEmpty, +}) { + return _MatchesGoldenFile( + file: file, + encode: encode, + isEmpty: isEmpty, + ); +} - final file = File(join(tempDir.path, 'file.dart')) - ..createSync(recursive: true) - ..writeAsStringSync(content); +class _MatchesGoldenFile extends Matcher { + _MatchesGoldenFile({ + required this.encode, + required this.file, + required this.isEmpty, + }); - return file; -} + final File file; + final String Function(T) encode; + final bool Function(T) isEmpty; -@isTest -void testGolden( - String description, - String fileName, - Future> Function(ResolvedUnitResult unit) - body, { - required String sourcePath, -}) { - test(description, () async { - final file = File(sourcePath).absolute; - - final result = await resolveFile2(path: file.path); - result as ResolvedUnitResult; - - final changes = await body(result).then((value) => value.toList()); - final source = file.readAsStringSync(); - - try { - expect( - changes, - matcherNormalizedPrioritizedSourceChangeSnapshot( - fileName, - sources: {'**': source}, - relativePath: Directory.current.path, - ), - ); - } on TestFailure { - // ignore: deprecated_member_use_from_same_package, deprecated only to avoid commit - if (!goldenWrite) rethrow; - - final source = File(sourcePath).readAsStringSync(); - final result = encodePrioritizedSourceChanges( - changes, - sources: {'**': source}, - relativePath: Directory.current.path, - ); - - final golden = File('test/$fileName'); - golden + static final Object _mismatchedValueKey = Object(); + static final Object _expectedKey = Object(); + + @override + bool matches( + Object? object, + Map matchState, + ) { + if (object is! T) { + matchState[_mismatchedValueKey] = 'Expected a ${T.toString()}'; + return false; + } + + late final actual = encode(object); + + if (!_goldenWrite) { + if (isEmpty(object)) { + if (file.existsSync()) { + matchState[_mismatchedValueKey] = + 'Expected to have no file, but found: ${file.path}'; + return false; + } + return true; + } + + if (!file.existsSync()) { + matchState[_mismatchedValueKey] = 'File not found: ${file.path}'; + return false; + } + + final expected = file.readAsStringSync(); + if (actual != expected) { + matchState[_mismatchedValueKey] = actual; + matchState[_expectedKey] = expected; + return false; + } + } else if (isEmpty(object)) { + try { + file.deleteSync(recursive: true); + } catch (_) {} + } else { + file ..createSync(recursive: true) - ..writeAsStringSync(result); - return; + ..writeAsStringSync(actual); } - }); + + return true; + } + + @override + Description describe(Description description) { + return description.add('to match snapshot at ${file.path}'); + } + + @override + Description describeMismatch( + Object? item, + Description mismatchDescription, + Map matchState, + bool verbose, + ) { + final actualValue = matchState[_mismatchedValueKey] as String?; + if (actualValue != null) { + final expected = matchState[_expectedKey] as String?; + + if (expected != null) { + return mismatchDescription + .add('Expected to match snapshot at ${file.path}:\n') + .addDescriptionOf(expected) + .add('\n\nbut was:\n') + .addDescriptionOf(actualValue); + } else { + return mismatchDescription.add(actualValue); + } + } + + return mismatchDescription.add('Unknown mismatch'); + } } diff --git a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/auto_dispose_read.back b/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/auto_dispose_read.back deleted file mode 100644 index cd73eaf57..000000000 --- a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/auto_dispose_read.back +++ /dev/null @@ -1,41 +0,0 @@ -import 'package:flutter/material.dart'; -import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -part 'auto_dispose_read.g.dart'; - -final a = Provider.autoDispose((ref) {}); - -class B extends ConsumerWidget { - const B({Key? key}) : super(key: key); - - @override - Widget build(BuildContext context, WidgetRef ref) { - return ElevatedButton( - onPressed: () { - // expect_lint: riverpod_avoid_read_auto_dispose - ref.read(a); - }, - ); - } -} - -@riverpod -class Foo extends _$Foo { - @override - int build() => 0; - - void onChange() { - // expect_lint: riverpod_avoid_read_auto_dispose - ref.read(a); - } -} - -void main() { - // Example of test usage - final container = ProviderContainer(); - // Lint - // expect_lint: riverpod_avoid_read_auto_dispose - container.read(a); - container.dispose(); -} diff --git a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/avoid_dynamic_provider.back b/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/avoid_dynamic_provider.back deleted file mode 100644 index 13885b314..000000000 --- a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/avoid_dynamic_provider.back +++ /dev/null @@ -1,21 +0,0 @@ -// ignore_for_file: unused_element, unused_local_variable - -import 'package:flutter_riverpod/flutter_riverpod.dart'; - -final global = Provider((ref) => 0); - -class Class { - static final topLevel = Provider((ref) => 0); - - // expect_lint: riverpod_avoid_dynamic_provider - final local = Provider((ref) => 0); -} - -void fn() { - // expect_lint: riverpod_avoid_dynamic_provider - final shouldBeTopLevel = Provider((ref) => 0); - // expect_lint: riverpod_avoid_dynamic_provider - final shouldBeTopLevelFamily = Provider.family((ref, id) => 0); - // expect_lint: riverpod_avoid_dynamic_provider - final shouldBeTopLevelAutoDispose = Provider.autoDispose((ref) => 0); -} diff --git a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/dependencies.back b/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/dependencies.back deleted file mode 100644 index 4eb0f74c3..000000000 --- a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/dependencies.back +++ /dev/null @@ -1,159 +0,0 @@ -import 'package:hooks_riverpod/hooks_riverpod.dart'; - -final a = StateProvider((ref) { - return 0; -}); - -final b = StateProvider((ref) { - ref.watch(a); - return 0; -}); - -final c = StateProvider((ref) { - ref.watch(a); - return 0; -}, dependencies: [a]); - -final d = StateProvider( - (ref) { - ref.watch(a); - return 0; - }, - // expect_lint: riverpod_missing_dependency - dependencies: [], -); - -final e = StateProvider((ref) { - ref.watch(a); - return 0; -}, dependencies: [ - a, - // expect_lint: riverpod_unused_dependency - b, -]); - -final f = StateProvider((ref) { - ref.watch(a.notifier); - return 0; -}, dependencies: [a]); - -final g = StateProvider((ref) { - ref.watch(b); - return 0; -}, dependencies: [b]); - -final h = StateProvider((ref) { - ref.watch(c); - return 0; -}, dependencies: [c]); - -// expect_lint: riverpod_unspecified_dependencies -final i = StateProvider((ref) { - ref.watch(c); - return 0; -}); - -// Notifier without specified dependencies -final j = StateNotifierProvider((ref) { - return J(ref); -}); - -class J extends StateNotifier { - J(this.ref) : super(0); - final Ref ref; - - void fn() { - ref.read(a); - } -} - -// Notifier with dependency -final k = StateNotifierProvider((ref) { - return K(ref); -// expect_lint: riverpod_missing_dependency -}, dependencies: []); - -class K extends StateNotifier { - K(this.ref) : super(0); - final Ref ref; - - void fn() { - ref.read(a); - } -} - -// Provider variants (autoDispose / family) -final l = StateProvider.autoDispose((ref) { - return 0; -}, dependencies: []); - -final m = StateProvider.autoDispose.family((ref, param) { - return 0; -// expect_lint: riverpod_unused_dependency -}, dependencies: [a]); - -// Passing ref to a function -final n = StateProvider((ref) { - fn(ref); - return 0; -}, dependencies: [a]); - -final o = StateProvider((ref) { - fn(ref); - return 0; -// expect_lint: riverpod_missing_dependency -}, dependencies: []); - -void fn(Ref ref) { - ref.watch(a); -} - -final p = StateNotifierProvider(P.new); - -class P extends StateNotifier { - P(this.ref) : super(0); - final Ref ref; - - void fn() { - ref.read(a); - } -} - -final q = StateNotifierProvider( - Q.new, - // expect_lint: riverpod_missing_dependency - dependencies: [], -); - -class Q extends StateNotifier { - Q(this.ref) : super(0); - final Ref ref; - - void fn() { - ref.read(a); - } -} - -final r1 = StateNotifierProvider( - (ref) => R()..ref = ref, - // expect_lint: riverpod_missing_dependency - dependencies: [], -); - -final r2 = StateNotifierProvider((ref) { - final r = R(); - r.ref = ref; - return r; - // expect_lint: riverpod_missing_dependency -}, dependencies: []); - -class R extends StateNotifier { - R() : super(0); - late final Ref ref; - - void fn() { - ref.read(a); - } -} - -// TODO check dynamic ref invocation diff --git a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/final_provider.back b/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/final_provider.back deleted file mode 100644 index 4b79fcbfc..000000000 --- a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/final_provider.back +++ /dev/null @@ -1,20 +0,0 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; - -class Class { - static final ok = Provider((ref) => 0); - // expect_lint: prefer_final_provider - static var staticShouldBeFinal = Provider((ref) => 0); - // expect_lint: prefer_final_provider - static Provider get shouldBeFinalGetter => Provider((ref) => 0); -} - -final ok = StateProvider((ref) => 0); - -// expect_lint: prefer_final_provider -var shouldBeFinal = StateProvider.autoDispose((ref) => 0); - -// expect_lint: prefer_final_provider -var shouldBeFinalFamily = StateProvider.autoDispose.family((ref, value) => 0); - -// expect_lint: prefer_final_provider -Provider get shouldBeFinalGetter => Provider((ref) => 0); diff --git a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/flutter_test.back b/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/flutter_test.back deleted file mode 100644 index 280a4d063..000000000 --- a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/flutter_test.back +++ /dev/null @@ -1,110 +0,0 @@ -import 'dart:convert'; -import 'dart:io'; - -import 'package:flutter_test/flutter_test.dart'; - -Future main() async { - test('goldens', timeout: Timeout(Duration(seconds: 60)), () async { - final result = await Process.run( - 'flutter', - ['pub', 'run', 'custom_lint'], - stdoutEncoding: utf8, - ); - - expect(result.stdout, ''' - test/goldens/auto_dispose_read.dart:11:5 • Avoid using ref.read inside the build method of widgets/providers. • riverpod_avoid_read_inside_build - test/goldens/auto_dispose_read.dart:11:5 • Avoid using ref.read on an autoDispose provider • riverpod_avoid_read_auto_dispose - test/goldens/auto_dispose_read.dart:20:3 • Avoid using ref.read on an autoDispose provider • riverpod_avoid_read_auto_dispose - test/goldens/avoid_dynamic_provider.dart:10:9 • Providers should be either top level variables or static properties • riverpod_avoid_dynamic_provider - test/goldens/avoid_dynamic_provider.dart:14:9 • Providers should be either top level variables or static properties • riverpod_avoid_dynamic_provider - test/goldens/avoid_dynamic_provider.dart:15:9 • Providers should be either top level variables or static properties • riverpod_avoid_dynamic_provider - test/goldens/avoid_dynamic_provider.dart:16:9 • Providers should be either top level variables or static properties • riverpod_avoid_dynamic_provider - test/goldens/dependencies.dart:20:4 • This provider depends on "a" yet "a" isn't listed in the dependencies. • riverpod_missing_dependency - test/goldens/dependencies.dart:25:22 • This provider specifies that it depends on "b" yet it never uses that provider. • riverpod_unused_dependency - test/goldens/dependencies.dart:42:7 • This provider does not specify `dependencies`, yet depends on "c" which did specify its dependencies. • riverpod_unspecified_dependencies - test/goldens/dependencies.dart:64:4 • This provider depends on "a" yet "a" isn't listed in the dependencies. • riverpod_missing_dependency - test/goldens/dependencies.dart:82:19 • This provider specifies that it depends on "a" yet it never uses that provider. • riverpod_unused_dependency - test/goldens/dependencies.dart:93:4 • This provider depends on "a" yet "a" isn't listed in the dependencies. • riverpod_missing_dependency - test/goldens/dependencies.dart:110:48 • This provider depends on "a" yet "a" isn't listed in the dependencies. • riverpod_missing_dependency - test/goldens/dependencies.dart:122:60 • This provider depends on "a" yet "a" isn't listed in the dependencies. • riverpod_missing_dependency - test/goldens/dependencies.dart:127:4 • This provider depends on "a" yet "a" isn't listed in the dependencies. • riverpod_missing_dependency - test/goldens/final_provider.dart:5:14 • Providers should always be declared as final • riverpod_final_provider - test/goldens/final_provider.dart:6:51 • Providers should always be declared as final • riverpod_final_provider - test/goldens/final_provider.dart:11:5 • Providers should always be declared as final • riverpod_final_provider - test/goldens/final_provider.dart:13:5 • Providers should always be declared as final • riverpod_final_provider - test/goldens/final_provider.dart:15:42 • Providers should always be declared as final • riverpod_final_provider - test/goldens/global_providers.dart:3:7 • This container is global • riverpod_global_container - test/goldens/global_providers.dart:4:7 • This container is global • riverpod_global_container - test/goldens/global_providers.dart:4:41 • This container is global • riverpod_global_container - test/goldens/mutate_in_create.dart:10:3 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:11:3 • Do not mutate a provider synchronously, a function was called which mutates a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:21:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:25:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:26:5 • Do not mutate a provider synchronously, a function was called which mutates a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:27:5 • Do not mutate a provider synchronously, a function was called which mutates a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:54:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:55:5 • Do not mutate a provider synchronously, a function was called which mutates a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:56:5 • Do not mutate a provider synchronously, a function was called which mutates a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:57:5 • Do not use ref after async gaps in flutter widgets, a function was called which uses ref after a widget could be disposed • riverpod_no_ref_after_async - test/goldens/mutate_in_create.dart:58:5 • Do not mutate a provider synchronously, a function was called which mutates a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:58:5 • Do not use ref after async gaps in flutter widgets. • riverpod_no_ref_after_async - test/goldens/mutate_in_create.dart:59:5 • Do not mutate a provider synchronously, a function was called which mutates a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:60:5 • Do not mutate a provider synchronously, a function was called which mutates a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:108:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:112:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:113:5 • Do not mutate a provider synchronously, a function was called which mutates a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:114:5 • Do not mutate a provider synchronously, a function was called which mutates a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:115:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:116:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:140:3 • Do not mutate a provider synchronously, a function was called which mutates a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:154:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:155:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:156:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:168:3 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:169:3 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:170:3 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:180:3 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:181:3 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:182:3 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:195:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:196:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:197:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:210:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:211:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.dart:212:5 • Do not mutate a provider synchronously • riverpod_no_mutate_sync - test/goldens/mutate_in_create.g.dart:92:12 • Providers should always be declared as final • riverpod_final_provider - test/goldens/mutate_in_create.g.dart:195:12 • Providers should always be declared as final • riverpod_final_provider - test/goldens/mutate_in_create.g.dart:291:12 • Providers should always be declared as final • riverpod_final_provider - test/goldens/mutate_in_create.g.dart:377:12 • Providers should always be declared as final • riverpod_final_provider - test/goldens/read_vs_watch.dart:12:3 • Avoid using ref.read inside the build method of widgets/providers. • riverpod_avoid_read_inside_build - test/goldens/read_vs_watch.dart:20:5 • Avoid using ref.watch outside the build method of widgets/providers. • riverpod_avoid_watch_outside_build - test/goldens/read_vs_watch.dart:28:5 • Avoid using ref.read inside the build method of widgets/providers. • riverpod_avoid_read_inside_build - test/goldens/read_vs_watch.dart:36:7 • Avoid using ref.watch outside the build method of widgets/providers. • riverpod_avoid_watch_outside_build - test/goldens/read_vs_watch.dart:47:5 • Avoid using ref.read inside the build method of widgets/providers. • riverpod_avoid_read_inside_build - test/goldens/read_vs_watch.dart:55:7 • Avoid using ref.watch outside the build method of widgets/providers. • riverpod_avoid_watch_outside_build - test/goldens/read_vs_watch.dart:67:5 • Avoid using ref.read inside the build method of widgets/providers. • riverpod_avoid_read_inside_build - test/goldens/read_vs_watch.dart:71:7 • Avoid using ref.read inside the build method of widgets/providers. • riverpod_avoid_read_inside_build - test/goldens/read_vs_watch.dart:77:9 • Avoid using ref.watch outside the build method of widgets/providers. • riverpod_avoid_watch_outside_build - test/goldens/read_vs_watch.dart:87:5 • Avoid using ref.watch outside the build method of widgets/providers. • riverpod_avoid_watch_outside_build - test/goldens/read_vs_watch.dart:96:5 • Avoid using ref.read inside the build method of widgets/providers. • riverpod_avoid_read_inside_build - test/goldens/read_vs_watch.dart:100:7 • Avoid using ref.read inside the build method of widgets/providers. • riverpod_avoid_read_inside_build - test/goldens/read_vs_watch.dart:106:9 • Avoid using ref.watch outside the build method of widgets/providers. • riverpod_avoid_watch_outside_build - test/goldens/read_vs_watch.dart:116:5 • Avoid using ref.watch outside the build method of widgets/providers. • riverpod_avoid_watch_outside_build - test/goldens/read_vs_watch.dart:130:5 • Avoid using ref.watch outside the build method of widgets/providers. • riverpod_avoid_watch_outside_build - test/goldens/read_vs_watch.dart:137:3 • Avoid using ref.read inside the build method of widgets/providers. • riverpod_avoid_read_inside_build - test/goldens/read_vs_watch.dart:146:5 • Avoid using ref.read inside the build method of widgets/providers. • riverpod_avoid_read_inside_build - test/goldens/read_vs_watch.dart:153:5 • Avoid using ref.watch outside the build method of widgets/providers. • riverpod_avoid_watch_outside_build - test/goldens/read_vs_watch.g.dart:92:12 • Providers should always be declared as final • riverpod_final_provider - test/goldens/read_vs_watch.g.dart:188:12 • Providers should always be declared as final • riverpod_final_provider - test/goldens/ref_escape_scope.dart:7:12 • Ref escaped the scope via a function or return expression. • riverpod_ref_escape_scope - test/goldens/ref_escape_scope.dart:37:32 • Ref escaped its scope to another widget. • riverpod_ref_escape_scope - test/goldens/ref_escape_scope.dart:46:32 • Ref escaped its scope to another widget. • riverpod_ref_escape_scope - test/goldens/use_ref_before_async_gaps.dart:48:11 • Do not use ref after async gaps in flutter widgets. • riverpod_no_ref_after_async - test/goldens/use_ref_before_async_gaps.dart:51:9 • Do not use ref after async gaps in flutter widgets, a function was called which uses ref after a widget could be disposed • riverpod_no_ref_after_async - test/goldens/use_ref_before_async_gaps.dart:53:9 • Do not use ref after async gaps in flutter widgets, a function was called which uses ref after a widget could be disposed • riverpod_no_ref_after_async - test/goldens/use_ref_before_async_gaps.dart:55:9 • Do not use ref after async gaps in flutter widgets, a function was called which uses ref after a widget could be disposed • riverpod_no_ref_after_async - test/goldens/use_ref_before_async_gaps.dart:57:15 • Do not use ref after async gaps in flutter widgets, a function was called which uses ref after a widget could be disposed • riverpod_no_ref_after_async - test/goldens/use_ref_before_async_gaps.dart:59:9 • Do not use ref after async gaps in flutter widgets. • riverpod_no_ref_after_async -'''); - }, skip: 'TODO flaky'); -} diff --git a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/global_providers.back b/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/global_providers.back deleted file mode 100644 index 9948f0308..000000000 --- a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/global_providers.back +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:hooks_riverpod/hooks_riverpod.dart'; - -// expect_lint: riverpod_global_container -final container1 = ProviderContainer(); - -final - // expect_lint: riverpod_global_container - container2 = ProviderContainer(), - // expect_lint: riverpod_global_container - container3 = ProviderContainer(); diff --git a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/mutate_in_create.back b/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/mutate_in_create.back deleted file mode 100644 index f5341efec..000000000 --- a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/mutate_in_create.back +++ /dev/null @@ -1,256 +0,0 @@ -// ignore_for_file: unused_result - -import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:flutter/material.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -part 'mutate_in_create.g.dart'; - -final a = StateProvider((ref) => 'String'); - -final b = Provider((ref) { - // expect_lint: riverpod_no_mutate_sync - ref.watch(a.notifier).state = ''; - // expect_lint: riverpod_no_mutate_sync - ref.watch(c.notifier).fn(); - return false; -}); - -final c = StateNotifierProvider((ref) { - return C(ref); -}); - -class C extends StateNotifier { - C(this.ref) : super(0) { - // expect_lint: riverpod_no_mutate_sync - ref.read(a.notifier).state = ''; - Future.delayed(Duration(milliseconds: 10), () { - ref.read(a.notifier).state = ''; - }); - // expect_lint: riverpod_no_mutate_sync - ref.read(a.notifier).state = ''; - // expect_lint: riverpod_no_mutate_sync - fn(); - // expect_lint: riverpod_no_mutate_sync - fn2(); - fn3(); - } - final Ref ref; - - void fn() { - ref.read(a.notifier).state = ''; - } - - // Not okay - Future fn2() async { - ref.read(a.notifier).state = ''; - await Future.delayed(Duration(seconds: 1)); - } - - // Okay - Future fn3() async { - await Future.delayed(Duration(seconds: 1)); - ref.read(a.notifier).state = ''; - } -} - -class D extends ConsumerWidget { - const D({Key? key}) : super(key: key); - - @override - Widget build(BuildContext context, WidgetRef ref) { - // expect_lint: riverpod_no_mutate_sync - ref.watch(a.notifier).state = ''; - // expect_lint: riverpod_no_mutate_sync - fn(ref); - // expect_lint: riverpod_no_mutate_sync - fn2(ref); - fn3(ref); - // expect_lint: riverpod_no_mutate_sync - ref.watch(c.notifier).fn(); - // expect_lint: riverpod_no_mutate_sync - ref.fn_g; - // expect_lint: riverpod_no_mutate_sync - ref.fn2_g; - ref.fn3_g; - return Container(); - } - - void fn(WidgetRef ref) { - ref.read(a.notifier).state = ''; - } - - // Not okay - Future fn2(WidgetRef ref) async { - ref.read(a.notifier).state = ''; - await Future.delayed(Duration(seconds: 1)); - } - - // Okay, for synchronous, but bad for async usage - Future fn3(WidgetRef ref) async { - await Future.delayed(Duration(seconds: 1)); - ref.read(a.notifier).state = ''; - } -} - -extension on WidgetRef { - void fn() { - read(a.notifier).state = ''; - } - - void get fn_g => fn(); - - // Not okay - Future fn2() async { - read(a.notifier).state = ''; - await Future.delayed(Duration(seconds: 1)); - } - - Future get fn2_g => fn2(); - - // Okay - Future fn3() async { - await Future.delayed(Duration(seconds: 1)); - read(a.notifier).state = ''; - } - - Future get fn3_g => fn3(); -} - -class E extends ChangeNotifier { - E(this.ref) { - // expect_lint: riverpod_no_mutate_sync - ref.read(a.notifier).state = ''; - Future.delayed(Duration(milliseconds: 10), () { - ref.read(a.notifier).state = ''; - }); - // expect_lint: riverpod_no_mutate_sync - ref.read(a.notifier).state = ''; - // expect_lint: riverpod_no_mutate_sync - fn(); - // expect_lint: riverpod_no_mutate_sync - fn2(); - // expect_lint: riverpod_no_mutate_sync - ref.invalidate(a); - // expect_lint: riverpod_no_mutate_sync - ref.invalidateSelf(); - fn3(); - } - final Ref ref; - - void fn() { - ref.read(a.notifier).state = ''; - } - - // Not okay - Future fn2() async { - ref.read(a.notifier).state = ''; - await Future.delayed(Duration(seconds: 1)); - } - - // Okay - Future fn3() async { - await Future.delayed(Duration(seconds: 1)); - ref.read(a.notifier).state = ''; - } -} - -final f = ChangeNotifierProvider((ref) { - final e = E(ref); - // expect_lint: riverpod_no_mutate_sync - e.fn(); - return e; -}); - -class G extends ConsumerStatefulWidget { - const G({Key? key}) : super(key: key); - - @override - ConsumerState createState() => _GState(); -} - -class _GState extends ConsumerState { - @override - void initState() { - // expect_lint: riverpod_no_mutate_sync - ref.read(a.notifier).state = ''; - // expect_lint: riverpod_no_mutate_sync - ref.invalidate(a); - // expect_lint: riverpod_no_mutate_sync - ref.refresh(a); - super.initState(); - } - - @override - Widget build(BuildContext context) { - return Container(); - } -} - -@riverpod -Future generated(GeneratedRef ref, String value, int otherValue) async { - // expect_lint: riverpod_no_mutate_sync - ref.watch(a.notifier).state = 'Other'; - // expect_lint: riverpod_no_mutate_sync - ref.invalidate(a); - // expect_lint: riverpod_no_mutate_sync - ref.refresh(a); - await Future.delayed(Duration(seconds: 1)); - ref.watch(a.notifier).state = 'Other'; - ref.invalidate(a); - ref.refresh(a); - return ''; -} - -@riverpod -String generatedSync(GeneratedSyncRef ref, String value, int otherValue) { - // expect_lint: riverpod_no_mutate_sync - ref.watch(a.notifier).state = 'Other'; - // expect_lint: riverpod_no_mutate_sync - ref.invalidate(a); - // expect_lint: riverpod_no_mutate_sync - ref.refresh(a); - Future.delayed(Duration(seconds: 1), () { - ref.read(a.notifier).state = 'Other'; - ref.invalidate(a); - ref.refresh(a); - }); - return ''; -} - -@riverpod -class MyNotifier extends _$MyNotifier { - @override - Future build(int i, String b) async { - // expect_lint: riverpod_no_mutate_sync - ref.watch(a.notifier).state = 'Other'; - // expect_lint: riverpod_no_mutate_sync - ref.invalidate(a); - // expect_lint: riverpod_no_mutate_sync - ref.refresh(a); - await Future.delayed(Duration(seconds: 1)); - ref.watch(a.notifier).state = 'Other'; - ref.invalidate(a); - ref.refresh(a); - return ''; - } -} - -@riverpod -class MyNotifier2 extends _$MyNotifier2 { - @override - String build(int i, String b) { - // expect_lint: riverpod_no_mutate_sync - ref.watch(a.notifier).state = 'Other'; - // expect_lint: riverpod_no_mutate_sync - ref.invalidate(a); - // expect_lint: riverpod_no_mutate_sync - ref.refresh(a); - Future.delayed(Duration(seconds: 1), () { - ref.read(a.notifier).state = 'Other'; - ref.invalidate(a); - ref.refresh(a); - }); - return ''; - } -} diff --git a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/read_vs_watch.back b/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/read_vs_watch.back deleted file mode 100644 index 607ecebc3..000000000 --- a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/read_vs_watch.back +++ /dev/null @@ -1,174 +0,0 @@ -// ignore_for_file: unused_element, unused_local_variable - -import 'package:flutter/material.dart'; -import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; -part 'read_vs_watch.g.dart'; - -final provider = Provider((ref) => 0); - -final another = Provider((ref) { - ref.watch(provider); - // expect_lint: riverpod_avoid_read_inside_build - ref.read(provider); - - void fn() { - // expect_lint: riverpod_avoid_watch_outside_build - ref.watch(provider); - ref.read(provider); - } - - final fn2 = () { - // expect_lint: riverpod_avoid_watch_outside_build - ref.watch(provider); - ref.read(provider); - }; -}); - -final foo = Consumer( - builder: (context, ref, child) { - ref.watch(provider); - // expect_lint: riverpod_avoid_read_inside_build - ref.read(provider); - - void fn() { - ref.watch(provider); - ref.read(provider); - } - - final fn2 = () { - // expect_lint: riverpod_avoid_watch_outside_build - ref.watch(provider); - ref.read(provider); - }; - - return Container(); - }, -); - -final bar = HookConsumer( - builder: (context, ref, child) { - ref.watch(provider); - // expect_lint: riverpod_avoid_read_inside_build - ref.read(provider); - - void fn() { - ref.watch(provider); - ref.read(provider); - } - - final fn2 = () { - // expect_lint: riverpod_avoid_watch_outside_build - ref.watch(provider); - ref.read(provider); - }; - - return Container(); - }, -); - -class Home extends ConsumerWidget { - @override - Widget build(BuildContext context, WidgetRef ref) { - ref.watch(provider); - // expect_lint: riverpod_avoid_read_inside_build - ref.read(provider); - - Builder(builder: (context) { - ref.watch(provider); - // expect_lint: riverpod_avoid_read_inside_build - ref.read(provider); - return Container(); - }); - - FloatingActionButton( - onPressed: () { - // expect_lint: riverpod_avoid_watch_outside_build - ref.watch(provider); - ref.read(provider); - }, - child: const Icon(Icons.add), - ); - - return Container(); - } - - void fn(WidgetRef ref) { - // expect_lint: riverpod_avoid_watch_outside_build - ref.watch(provider); - ref.read(provider); - } -} - -class HookHome extends HookConsumerWidget { - @override - Widget build(BuildContext context, WidgetRef ref) { - ref.watch(provider); - // expect_lint: riverpod_avoid_read_inside_build - ref.read(provider); - - Builder(builder: (context) { - ref.watch(provider); - // expect_lint: riverpod_avoid_read_inside_build - ref.read(provider); - return Container(); - }); - - FloatingActionButton( - onPressed: () { - // expect_lint: riverpod_avoid_watch_outside_build - ref.watch(provider); - ref.read(provider); - }, - child: const Icon(Icons.add), - ); - - return Container(); - } - - void fn(WidgetRef ref) { - // expect_lint: riverpod_avoid_watch_outside_build - ref.watch(provider); - ref.read(provider); - } -} - -class Counter extends StateNotifier { - Counter(this.ref) : super(0) { - ref.watch(provider); - ref.read(provider); - } - - final Ref ref; - - void increment() { - // expect_lint: riverpod_avoid_watch_outside_build - ref.watch(provider); - ref.read(provider); - } -} - -@riverpod -Future generated(GeneratedRef ref, String value, int otherValue) async { - // expect_lint: riverpod_avoid_read_inside_build - ref.read(provider); - ref.watch(provider); - return ''; -} - -@riverpod -class MyNotifier extends _$MyNotifier { - @override - Future build(int i, String b) async { - // expect_lint: riverpod_avoid_read_inside_build - ref.read(provider); - ref.watch(provider); - return ''; - } - - void fn() { - ref.read(provider); - // expect_lint: riverpod_avoid_watch_outside_build - ref.watch(provider); - } -} diff --git a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/ref_escape_scope.back b/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/ref_escape_scope.back deleted file mode 100644 index ec121d8f8..000000000 --- a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/ref_escape_scope.back +++ /dev/null @@ -1,72 +0,0 @@ -import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:flutter/material.dart'; - -final a = StateProvider((ref) => ''); - -final b = StateNotifierProvider((ref) { - // expect_lint: riverpod_ref_escape_scope - get() => ref; - return B(get); -}); - -class B extends StateNotifier { - B(this.get) : super(0); - final Ref Function() get; - - void fn() { - get().read(a); - } -} - -class C extends ConsumerWidget { - const C({Key? key}) : super(key: key); - - @override - Widget build(BuildContext context, WidgetRef ref) { - return Column(children: [ - BadWidgetA(ref: ref), - BadWidgetB(ref: ref), - ]); - } - - void fn(WidgetRef ref) { - ref.read(a); - } -} - -class BadWidgetA extends StatelessWidget { - const BadWidgetA({ - super.key, - // expect_lint: riverpod_ref_escape_scope - this.ref, - }); - - final WidgetRef? ref; - - @override - Widget build(BuildContext context) { - throw UnimplementedError(); - } -} - -class BadWidgetB extends StatefulWidget { - const BadWidgetB({ - super.key, - // expect_lint: riverpod_ref_escape_scope - this.ref, - }); - - final WidgetRef? ref; - - @override - State createState() { - return BadWidgetBState(); - } -} - -class BadWidgetBState extends State { - @override - Widget build(BuildContext context) { - throw UnimplementedError(); - } -} diff --git a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/use_ref_before_async_gaps.back b/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/use_ref_before_async_gaps.back deleted file mode 100644 index 18601c513..000000000 --- a/packages/riverpod_lint_flutter_test/test/goldens/legacy_backup/use_ref_before_async_gaps.back +++ /dev/null @@ -1,105 +0,0 @@ -// Tests that the ref is used before async gaps in widget methods - -// ignore_for_file: unused_result - -import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:flutter/material.dart'; - -final a = Provider((ref) => ''); -final b = StateProvider((ref) => ''); - -/// GOOD -class C extends ConsumerWidget { - @override - Widget build(BuildContext context, WidgetRef ref) { - final bn = ref.watch(b.notifier); - return ElevatedButton( - onPressed: () async { - ref.read(a); - final n = ref.read(b.notifier); - fn2(ref); - await Future.delayed(Duration(seconds: 1)); - n.state = ''; - bn.state = ''; - }, - child: Text('Hi'), - ); - } - - Future fn2(WidgetRef ref) async { - ref.read(a); - ref.invalidate(b); - ref.listen(b, (_, __) {}); - ref.refresh(b); - } -} - -/// BAD -class D extends ConsumerWidget { - @override - Widget build(BuildContext context, WidgetRef ref) { - return ElevatedButton( - onPressed: () async { - // Okay - ref.read(a); - ref.invalidate(b); - ref.listen(b, (_, __) {}); - ref.refresh(b); - Future.delayed(Duration(milliseconds: 10), () { - // Bad ref is used in future callback - // expect_lint: riverpod_no_ref_after_async - ref.read(b.notifier).state = ''; - }); - // Bad (ref is used after async in fn) - // expect_lint: riverpod_no_ref_after_async - fn(ref); - // Bad (ref is used after async in fn2) - // expect_lint: riverpod_no_ref_after_async - fn2(ref); - // Bad (ref is used after async in fn3) - // expect_lint: riverpod_no_ref_after_async - fn3(ref); - // Bad (ref is used after async in fn4) - // expect_lint: riverpod_no_ref_after_async - await fn4(ref); - // Bad - // expect_lint: riverpod_no_ref_after_async - ref.read(b.notifier).state = ''; - }, - child: Text('Hi'), - ); - } - - Future fn(WidgetRef ref) async { - await Future.delayed(Duration(seconds: 1)); - ref.read(b.notifier).state = ''; - } - - Future fn2(WidgetRef ref) async { - await Future.delayed(Duration(seconds: 1)); - ref.invalidate(b); - } - - Future fn3(WidgetRef ref) async { - await Future.delayed(Duration(seconds: 1)); - - ref.listen(b, (_, __) {}); - } - - Future fn4(WidgetRef ref) async { - await Future.delayed(Duration(seconds: 1)); - ref.refresh(b); - } -} - -final stream = StreamProvider((ref) async* { - // No lint after async - await Future.delayed(Duration(seconds: 1)); - ref.watch(a); -}); - -final future = FutureProvider((ref) async* { - await Future.delayed(Duration(seconds: 1)); - // No lint after async - ref.watch(a); -}); diff --git a/packages/riverpod_lint_flutter_test/test/io_utils.dart b/packages/riverpod_lint_flutter_test/test/io_utils.dart new file mode 100644 index 000000000..76407db15 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/io_utils.dart @@ -0,0 +1,15 @@ +import 'dart:io'; + +import 'package:test/test.dart'; +import 'package:path/path.dart'; + +File writeToTemporaryFile(String content) { + final tempDir = Directory.systemTemp.createTempSync(); + addTearDown(() => tempDir.deleteSync(recursive: true)); + + final file = File(join(tempDir.path, 'file.dart')) + ..createSync(recursive: true) + ..writeAsStringSync(content); + + return file; +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/another.dart b/packages/riverpod_lint_flutter_test/test/lints/another.dart deleted file mode 100644 index 01792a321..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/another.dart +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -part 'another.g.dart'; - -final aProvider = Provider((ref) => 0); - -@riverpod -int b(BRef ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/another.g.dart b/packages/riverpod_lint_flutter_test/test/lints/another.g.dart deleted file mode 100644 index 9e782e29b..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/another.g.dart +++ /dev/null @@ -1,69 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'another.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -typedef BRef = Ref; - -@ProviderFor(b) -const bProvider = BProvider._(); - -final class BProvider extends $FunctionalProvider - with $Provider { - const BProvider._( - {int Function( - BRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - name: r'bProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - BRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$bHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); - - @override - BProvider $copyWithCreate( - int Function( - BRef ref, - ) create, - ) { - return BProvider._(create: create); - } - - @override - int create(BRef ref) { - final _$cb = _createCb ?? b; - return _$cb(ref); - } -} - -String _$bHash() => r'52593050701642f22b31c590f20c003dc2ee1579'; - -// ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/async_value_nullable_pattern.dart b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern.dart similarity index 100% rename from packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/async_value_nullable_pattern.dart rename to packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern.dart diff --git a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart deleted file mode 100644 index bc7f5a411..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart +++ /dev/null @@ -1,21 +0,0 @@ -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -void main() { - switch (Object()) { - // T is nullable, therefore we should check hasData - case AsyncValue( - // expect_lint: async_value_nullable_pattern - :final value?, - ): - print(value); - } - - switch (Object()) { - // T is nullable, therefore we should check hasData - case AsyncValue( - // expect_lint: async_value_nullable_pattern - :final value? - ): - print(value); - } -} diff --git a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff deleted file mode 100644 index 77c08f60a..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff +++ /dev/null @@ -1,24 +0,0 @@ -Message: `Use "hasValue: true" instead` -Priority: 100 -Diff for file `test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart:8`: -``` - case AsyncValue( - // expect_lint: async_value_nullable_pattern -- :final value?, -+ :final value, hasValue: true, - ): - print(value); -``` ---- -Message: `Use "hasValue: true" instead` -Priority: 100 -Diff for file `test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart:17`: -``` - case AsyncValue( - // expect_lint: async_value_nullable_pattern -- :final value? -+ :final value, hasValue: true - ): - print(value); -``` ---- diff --git a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern_test.dart b/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern_test.dart deleted file mode 100644 index 04739c72a..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern_test.dart +++ /dev/null @@ -1,25 +0,0 @@ -import 'package:collection/collection.dart'; -import 'package:riverpod_lint/src/lints/async_value_nullable_pattern.dart'; - -import '../../../golden.dart'; - -void main() { - testGolden( - 'Verify that @riverpod classes has the build method', - 'lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.diff', - sourcePath: - 'test/lints/async_value_nullable_pattern/fix/async_value_nullable_pattern.dart', - (result) async { - const lint = AsyncValueNullablePattern(); - final fix = lint.getFixes().single; - - final errors = await lint.testRun(result); - - final changes = await Future.wait([ - for (final error in errors) fix.testRun(result, error, errors), - ]); - - return changes.flattened; - }, - ); -} diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart deleted file mode 100644 index ba343372d..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref_test.dart +++ /dev/null @@ -1,27 +0,0 @@ -import 'package:custom_lint_builder/custom_lint_builder.dart'; -import 'package:collection/collection.dart'; -import 'package:riverpod_lint/src/lints/functional_ref.dart'; -import 'package:test/test.dart'; - -import '../../golden.dart'; - -void main() { - testGolden( - 'Verify that @riverpod classes extend the generated typedef', - 'lints/functional_ref/functional_ref.diff', - sourcePath: 'test/lints/functional_ref/functional_ref.dart', - (result) async { - final lint = FunctionalRef(); - final fix = lint.getFixes().single as DartFix; - - final errors = await lint.testRun(result); - expect(errors, hasLength(4)); - - final changes = await Future.wait([ - for (final error in errors) fix.testRun(result, error, errors), - ]); - - return changes.flattened; - }, - ); -} diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/async_value_nullable_pattern/async_value_nullable_pattern_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/async_value_nullable_pattern/async_value_nullable_pattern_fix.diff new file mode 100644 index 000000000..70f4d28e8 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/async_value_nullable_pattern/async_value_nullable_pattern_fix.diff @@ -0,0 +1,60 @@ +Message: `Use "hasValue: true" instead` +Priority: 100 +Diff for file `test/lints/async_value_nullable_pattern.dart:8`: +``` + case AsyncValue( + // expect_lint: async_value_nullable_pattern +- :final value?, ++ :final value, hasValue: true, + ): + print(value); +``` +--- +Message: `Use "hasValue: true" instead` +Priority: 100 +Diff for file `test/lints/async_value_nullable_pattern.dart:32`: +``` + case AsyncError( + // expect_lint: async_value_nullable_pattern +- :final value?, ++ :final value, hasValue: true, + ): + print(value); +``` +--- +Message: `Use "hasValue: true" instead` +Priority: 100 +Diff for file `test/lints/async_value_nullable_pattern.dart:37`: +``` + case AsyncLoading( + // expect_lint: async_value_nullable_pattern +- :final value?, ++ :final value, hasValue: true, + ): + print(value); +``` +--- +Message: `Use "hasValue: true" instead` +Priority: 100 +Diff for file `test/lints/async_value_nullable_pattern.dart:62`: +``` + switch (obj) { + // expect_lint: async_value_nullable_pattern +- case AsyncValue(:final value?): ++ case AsyncValue(:final value, hasValue: true): + print(value); + } +``` +--- +Message: `Use "hasValue: true" instead` +Priority: 100 +Diff for file `test/lints/async_value_nullable_pattern.dart:77`: +``` + switch (obj) { + // expect_lint: async_value_nullable_pattern +- case AsyncValue(:final value?): ++ case AsyncValue(:final value, hasValue: true): + print(value); + } +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/async_value_nullable_pattern/async_value_nullable_pattern_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/async_value_nullable_pattern/async_value_nullable_pattern_lint.md new file mode 100644 index 000000000..cc4f4dfbc --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/async_value_nullable_pattern/async_value_nullable_pattern_lint.md @@ -0,0 +1,72 @@ +code: async_value_nullable_pattern +severity: Severity.warning +message: Using AsyncValue(:final value?) on possibly nullable value is unsafe. Use AsyncValue(:final value, hasValue: true) instead. +test/lints/async_value_nullable_pattern.dart:8:10 + +```dart + case AsyncValue( + // expect_lint: async_value_nullable_pattern + :>>>final value?<<<, + ): + print(value); +``` + +======= + +code: async_value_nullable_pattern +severity: Severity.warning +message: Using AsyncValue(:final value?) on possibly nullable value is unsafe. Use AsyncValue(:final value, hasValue: true) instead. +test/lints/async_value_nullable_pattern.dart:32:10 + +```dart + case AsyncError( + // expect_lint: async_value_nullable_pattern + :>>>final value?<<<, + ): + print(value); +``` + +======= + +code: async_value_nullable_pattern +severity: Severity.warning +message: Using AsyncValue(:final value?) on possibly nullable value is unsafe. Use AsyncValue(:final value, hasValue: true) instead. +test/lints/async_value_nullable_pattern.dart:37:10 + +```dart + case AsyncLoading( + // expect_lint: async_value_nullable_pattern + :>>>final value?<<<, + ): + print(value); +``` + +======= + +code: async_value_nullable_pattern +severity: Severity.warning +message: Using AsyncValue(:final value?) on possibly nullable value is unsafe. Use AsyncValue(:final value, hasValue: true) instead. +test/lints/async_value_nullable_pattern.dart:62:25 + +```dart + switch (obj) { + // expect_lint: async_value_nullable_pattern + case AsyncValue(:>>>final value?<<<): + print(value); + } +``` + +======= + +code: async_value_nullable_pattern +severity: Severity.warning +message: Using AsyncValue(:final value?) on possibly nullable value is unsafe. Use AsyncValue(:final value, hasValue: true) instead. +test/lints/async_value_nullable_pattern.dart:77:25 + +```dart + switch (obj) { + // expect_lint: async_value_nullable_pattern + case AsyncValue(:>>>final value?<<<): + print(value); + } +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md new file mode 100644 index 000000000..3a90d2915 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md @@ -0,0 +1,87 @@ +code: avoid_build_context_in_providers +severity: Severity.info +message: Passing BuildContext to providers indicates mixing UI with the business logic. +test/lints/avoid_build_context_in_providers.dart:12:3 + +```dart + FnRef ref, + // expect_lint: avoid_build_context_in_providers + >>>BuildContext context1<<<, { + // expect_lint: avoid_build_context_in_providers + required BuildContext context2, +``` + +======= + +code: avoid_build_context_in_providers +severity: Severity.info +message: Passing BuildContext to providers indicates mixing UI with the business logic. +test/lints/avoid_build_context_in_providers.dart:14:3 + +```dart + BuildContext context1, { + // expect_lint: avoid_build_context_in_providers + >>>required BuildContext context2<<<, +}) => + 0; +``` + +======= + +code: avoid_build_context_in_providers +severity: Severity.info +message: Passing BuildContext to providers indicates mixing UI with the business logic. +test/lints/avoid_build_context_in_providers.dart:22:5 + +```dart + int build( + // expect_lint: avoid_build_context_in_providers + >>>BuildContext context1<<<, { + // expect_lint: avoid_build_context_in_providers + required BuildContext context2, +``` + +======= + +code: avoid_build_context_in_providers +severity: Severity.info +message: Passing BuildContext to providers indicates mixing UI with the business logic. +test/lints/avoid_build_context_in_providers.dart:24:5 + +```dart + BuildContext context1, { + // expect_lint: avoid_build_context_in_providers + >>>required BuildContext context2<<<, + }) => + 0; +``` + +======= + +code: avoid_build_context_in_providers +severity: Severity.info +message: Passing BuildContext to providers indicates mixing UI with the business logic. +test/lints/avoid_build_context_in_providers.dart:30:5 + +```dart + void event( + // expect_lint: avoid_build_context_in_providers + >>>BuildContext context3<<<, { + // expect_lint: avoid_build_context_in_providers + required BuildContext context4, +``` + +======= + +code: avoid_build_context_in_providers +severity: Severity.info +message: Passing BuildContext to providers indicates mixing UI with the business logic. +test/lints/avoid_build_context_in_providers.dart:32:5 + +```dart + BuildContext context3, { + // expect_lint: avoid_build_context_in_providers + >>>required BuildContext context4<<<, + }) {} +} +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_public_notifier_properties/avoid_public_notifier_properties_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_public_notifier_properties/avoid_public_notifier_properties_lint.md new file mode 100644 index 000000000..5b28c0007 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_public_notifier_properties/avoid_public_notifier_properties_lint.md @@ -0,0 +1,102 @@ +code: avoid_public_notifier_properties +severity: Severity.info +message: Notifiers should not have public properties/getters. Instead, all their public API should be exposed through the `state` property. +test/lints/avoid_public_notifier_properties.dart:16:3 + +```dart + + // expect_lint: avoid_public_notifier_properties + >>>int get publicGetter => _privateGetter;<<< + + // Public setters are OK +``` + +======= + +code: avoid_public_notifier_properties +severity: Severity.info +message: Notifiers should not have public properties/getters. Instead, all their public API should be exposed through the `state` property. +test/lints/avoid_public_notifier_properties.dart:24:3 + +```dart + + // expect_lint: avoid_public_notifier_properties + >>>int publicProperty = 0;<<< + + @protected +``` + +======= + +code: avoid_public_notifier_properties +severity: Severity.info +message: Notifiers should not have public properties/getters. Instead, all their public API should be exposed through the `state` property. +test/lints/avoid_public_notifier_properties.dart:50:3 + +```dart + + // expect_lint: avoid_public_notifier_properties + >>>int get publicGetter => _privateGetter;<<< + + @override +``` + +======= + +code: avoid_public_notifier_properties +severity: Severity.info +message: Notifiers should not have public properties/getters. Instead, all their public API should be exposed through the `state` property. +test/lints/avoid_public_notifier_properties.dart:60:3 + +```dart + + // expect_lint: avoid_public_notifier_properties + >>>int get publicGetter => _privateGetter;<<< + + @override +``` + +======= + +code: avoid_public_notifier_properties +severity: Severity.info +message: Notifiers should not have public properties/getters. Instead, all their public API should be exposed through the `state` property. +test/lints/avoid_public_notifier_properties.dart:70:3 + +```dart + + // expect_lint: avoid_public_notifier_properties + >>>int get publicGetter => _privateGetter;<<< + + @override +``` + +======= + +code: avoid_public_notifier_properties +severity: Severity.info +message: Notifiers should not have public properties/getters. Instead, all their public API should be exposed through the `state` property. +test/lints/avoid_public_notifier_properties.dart:80:3 + +```dart + + // expect_lint: avoid_public_notifier_properties + >>>int get publicGetter => _privateGetter;<<< + + @override +``` + +======= + +code: avoid_public_notifier_properties +severity: Severity.info +message: Notifiers should not have public properties/getters. Instead, all their public API should be exposed through the `state` property. +test/lints/avoid_public_notifier_properties.dart:90:3 + +```dart + + // expect_lint: avoid_public_notifier_properties + >>>int get publicGetter => _privateGetter;<<< + + @override +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_ref_inside_state_dispose/avoid_ref_inside_state_dispose_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_ref_inside_state_dispose/avoid_ref_inside_state_dispose_lint.md new file mode 100644 index 000000000..68b058df5 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_ref_inside_state_dispose/avoid_ref_inside_state_dispose_lint.md @@ -0,0 +1,27 @@ +code: avoid_ref_inside_state_dispose +severity: Severity.warning +message: Avoid using 'Ref' inside State.dispose. +test/lints/avoid_ref_inside_state_dispose.dart:17:5 + +```dart + void dispose() { + // expect_lint: avoid_ref_inside_state_dispose + >>>ref.read(provider)<<<; + // expect_lint: avoid_ref_inside_state_dispose + ref.watch(provider); +``` + +======= + +code: avoid_ref_inside_state_dispose +severity: Severity.warning +message: Avoid using 'Ref' inside State.dispose. +test/lints/avoid_ref_inside_state_dispose.dart:19:5 + +```dart + ref.read(provider); + // expect_lint: avoid_ref_inside_state_dispose + >>>ref.watch(provider)<<<; + + super.dispose(); +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_fix.diff new file mode 100644 index 000000000..9ddd8c001 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_fix.diff @@ -0,0 +1,24 @@ +Message: `Add ref parameter` +Priority: 90 +Diff for file `test/lints/functional_ref/failing_functional_ref.dart:5`: +``` +@riverpod +// expect_lint: functional_ref +- int refless() { ++ int refless(ReflessRef ref) { + return 0; +} +``` +--- +Message: `Type as IncorrectlyTypedRef` +Priority: 90 +Diff for file `test/lints/functional_ref/failing_functional_ref.dart:12`: +``` +int incorrectlyTyped( + // expect_lint: functional_ref +- int ref, ++ IncorrectlyTypedRef ref, +) { + return 0; +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_lint.md new file mode 100644 index 000000000..5cd4da160 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_lint.md @@ -0,0 +1,42 @@ +code: functional_ref +severity: Severity.warning +message: Functional providers must receive a ref matching the provider name as their first positional parameter. +test/lints/functional_ref/failing_functional_ref.dart:5:5 + +```dart +@riverpod +// expect_lint: functional_ref +int >>>refless<<<() { + return 0; +} +``` + +======= + +code: functional_ref +severity: Severity.warning +message: Functional providers must receive a ref matching the provider name as their first positional parameter. +test/lints/functional_ref/failing_functional_ref.dart:12:3 + +```dart +int incorrectlyTyped( + // expect_lint: functional_ref + >>>int<<< ref, +) { + return 0; +``` + +======= + +code: functional_ref +severity: Severity.warning +message: Functional providers must receive a ref matching the provider name as their first positional parameter. +test/lints/functional_ref/failing_functional_ref.dart:20:23 + +```dart +@riverpod +// expect_lint: functional_ref +int noRefButArgs({int >>>a<<< = 42}) { + return 0; +} +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff new file mode 100644 index 000000000..b3dab2390 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff @@ -0,0 +1,46 @@ +Message: `Type as NamelessRef` +Priority: 90 +Diff for file `test/lints/functional_ref/functional_ref.dart:8`: +``` +int nameless( + // expect_lint: functional_ref +- ref, ++ NamelessRef ref, +) { + return 0; +``` +--- +Message: `Type as NoGenericsRef` +Priority: 90 +Diff for file `test/lints/functional_ref/functional_ref.dart:18`: +``` +@riverpod +// expect_lint: functional_ref +- int noGenerics(NoGenericsRef ref) => 0; ++ int noGenerics(NoGenericsRef ref) => 0; + +@riverpod +``` +--- +Message: `Type as MissingGenericsRef` +Priority: 90 +Diff for file `test/lints/functional_ref/functional_ref.dart:22`: +``` +@riverpod +// expect_lint: functional_ref +- int missingGenerics(MissingGenericsRef ref) => 0; ++ int missingGenerics(MissingGenericsRef ref) => 0; + +@riverpod +``` +--- +Message: `Type as WrongOrderRef` +Priority: 90 +Diff for file `test/lints/functional_ref/functional_ref.dart:26`: +``` +@riverpod +// expect_lint: functional_ref +- int wrongOrder(WrongOrderRef ref) => 0; ++ int wrongOrder(WrongOrderRef ref) => 0; +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md new file mode 100644 index 000000000..941197123 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md @@ -0,0 +1,55 @@ +code: functional_ref +severity: Severity.warning +message: Functional providers must receive a ref matching the provider name as their first positional parameter. +test/lints/functional_ref/functional_ref.dart:8:3 + +```dart +int nameless( + // expect_lint: functional_ref + >>>ref<<<, +) { + return 0; +``` + +======= + +code: functional_ref +severity: Severity.warning +message: Functional providers must receive a ref matching the provider name as their first positional parameter. +test/lints/functional_ref/functional_ref.dart:18:34 + +```dart +@riverpod +// expect_lint: functional_ref +int noGenerics(>>>NoGenericsRef<<< ref) => 0; + +@riverpod +``` + +======= + +code: functional_ref +severity: Severity.warning +message: Functional providers must receive a ref matching the provider name as their first positional parameter. +test/lints/functional_ref/functional_ref.dart:22:27 + +```dart +@riverpod +// expect_lint: functional_ref +int missingGenerics(>>>MissingGenericsRef<<< ref) => 0; + +@riverpod +``` + +======= + +code: functional_ref +severity: Severity.warning +message: Functional providers must receive a ref matching the provider name as their first positional parameter. +test/lints/functional_ref/functional_ref.dart:26:22 + +```dart +@riverpod +// expect_lint: functional_ref +int wrongOrder(>>>WrongOrderRef<<< ref) => 0; +``` diff --git a/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/missing_legacy_import_fix.diff similarity index 73% rename from packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import.diff rename to packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/missing_legacy_import_fix.diff index 227a2abf9..823cdb8f7 100644 --- a/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/missing_legacy_import_fix.diff @@ -1,6 +1,6 @@ Message: `Import "package:riverpod/legacy.dart"` Priority: 100 -Diff for file `test/migration/missing_legacy_import/missing_legacy_import.dart:1`: +Diff for file `test/lints/missing_legacy_import/missing_legacy_import.dart:1`: ``` - // ignore_for_file: unused_import + import 'package:riverpod/legacy.dart'; @@ -11,7 +11,7 @@ import 'package:riverpod/riverpod.dart'; --- Message: `Import "package:riverpod/legacy.dart"` Priority: 100 -Diff for file `test/migration/missing_legacy_import/missing_legacy_import.dart:1`: +Diff for file `test/lints/missing_legacy_import/missing_legacy_import.dart:1`: ``` - // ignore_for_file: unused_import + import 'package:riverpod/legacy.dart'; @@ -22,7 +22,7 @@ import 'package:riverpod/riverpod.dart'; --- Message: `Import "package:flutter_riverpod/legacy.dart"` Priority: 100 -Diff for file `test/migration/missing_legacy_import/missing_legacy_import.dart:1`: +Diff for file `test/lints/missing_legacy_import/missing_legacy_import.dart:1`: ``` - // ignore_for_file: unused_import + import 'package:flutter_riverpod/legacy.dart'; @@ -33,7 +33,7 @@ import 'package:riverpod/riverpod.dart'; --- Message: `Import "package:riverpod/legacy.dart"` Priority: 100 -Diff for file `test/migration/missing_legacy_import/missing_legacy_import.dart:1`: +Diff for file `test/lints/missing_legacy_import/missing_legacy_import.dart:1`: ``` - // ignore_for_file: unused_import + import 'package:riverpod/legacy.dart'; @@ -44,7 +44,7 @@ import 'package:riverpod/riverpod.dart'; --- Message: `Import "package:riverpod/legacy.dart"` Priority: 100 -Diff for file `test/migration/missing_legacy_import/missing_legacy_import.dart:1`: +Diff for file `test/lints/missing_legacy_import/missing_legacy_import.dart:1`: ``` - // ignore_for_file: unused_import + import 'package:riverpod/legacy.dart'; @@ -55,7 +55,7 @@ import 'package:riverpod/riverpod.dart'; --- Message: `Import "package:riverpod/legacy.dart"` Priority: 100 -Diff for file `test/migration/missing_legacy_import/missing_legacy_import.dart:1`: +Diff for file `test/lints/missing_legacy_import/missing_legacy_import.dart:1`: ``` - // ignore_for_file: unused_import + import 'package:riverpod/legacy.dart'; diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/missing_legacy_import_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/missing_legacy_import_lint.md new file mode 100644 index 000000000..48ca6549f --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/missing_legacy_import_lint.md @@ -0,0 +1,72 @@ +code: missing_legacy_import +severity: Severity.info +message: StateProvider/StateNotifierProvider/ChangeNotifierProvider/StateNotifier were used without importing `package:flutter_riverpod/legacy.dart`. +test/lints/missing_legacy_import/missing_legacy_import.dart:10:11 + +```dart + +// expect_lint: missing_legacy_import +final p = >>>StateProvider<<<((ref) => 0); + +// expect_lint: missing_legacy_import +``` + +======= + +code: missing_legacy_import +severity: Severity.info +message: StateProvider/StateNotifierProvider/ChangeNotifierProvider/StateNotifier were used without importing `package:flutter_riverpod/legacy.dart`. +test/lints/missing_legacy_import/missing_legacy_import.dart:13:12 + +```dart + +// expect_lint: missing_legacy_import +final p2 = >>>StateProvider<<<.autoDispose((ref) => 0); + +// expect_lint: missing_legacy_import +``` + +======= + +code: missing_legacy_import +severity: Severity.info +message: StateProvider/StateNotifierProvider/ChangeNotifierProvider/StateNotifier were used without importing `package:flutter_riverpod/legacy.dart`. +test/lints/missing_legacy_import/missing_legacy_import.dart:16:12 + +```dart + +// expect_lint: missing_legacy_import +final p3 = >>>ChangeNotifierProvider<<<((ref) => 0); + +// expect_lint: missing_legacy_import +``` + +======= + +code: missing_legacy_import +severity: Severity.info +message: StateProvider/StateNotifierProvider/ChangeNotifierProvider/StateNotifier were used without importing `package:flutter_riverpod/legacy.dart`. +test/lints/missing_legacy_import/missing_legacy_import.dart:19:12 + +```dart + +// expect_lint: missing_legacy_import +final p4 = >>>StateNotifierProvider<<<((ref) => 0); + +// expect_lint: missing_legacy_import +``` + +======= + +code: missing_legacy_import +severity: Severity.info +message: StateProvider/StateNotifierProvider/ChangeNotifierProvider/StateNotifier were used without importing `package:flutter_riverpod/legacy.dart`. +test/lints/missing_legacy_import/missing_legacy_import.dart:22:26 + +```dart + +// expect_lint: missing_legacy_import +class MyNotifier extends >>>StateNotifier<<< { + MyNotifier() : super(0); +} +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/with_riverpod_import_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/with_riverpod_import_fix.diff new file mode 100644 index 000000000..aa70d8a78 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/with_riverpod_import_fix.diff @@ -0,0 +1,11 @@ +Message: `Import "package:flutter_riverpod/legacy.dart"` +Priority: 100 +Diff for file `test/lints/missing_legacy_import/with_riverpod_import.dart:1`: +``` +- import 'package:riverpod/legacy.dart'; ++ import 'package:flutter_riverpod/legacy.dart'; ++ import 'package:riverpod/legacy.dart'; + +// ignore_for_file: undefined_function, undefined_identifier +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/with_riverpod_import_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/with_riverpod_import_lint.md new file mode 100644 index 000000000..8d473b22f --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_legacy_import/with_riverpod_import_lint.md @@ -0,0 +1,12 @@ +code: missing_legacy_import +severity: Severity.info +message: StateProvider/StateNotifierProvider/ChangeNotifierProvider/StateNotifier were used without importing `package:flutter_riverpod/legacy.dart`. +test/lints/missing_legacy_import/with_riverpod_import.dart:10:12 + +```dart + +// expect_lint: missing_legacy_import +final p3 = >>>ChangeNotifierProvider<<<((ref) => 0); + +final p4 = StateNotifierProvider, int>((ref) { +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_provider_scope/missing_provider_scope_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_provider_scope/missing_provider_scope_fix.diff new file mode 100644 index 000000000..9958dc430 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_provider_scope/missing_provider_scope_fix.diff @@ -0,0 +1,24 @@ +Message: `Add ProviderScope` +Priority: 80 +Diff for file `test/lints/missing_provider_scope.dart:7`: +``` + // expect_lint: missing_provider_scope + runApp( +- MyApp(), ++ ProviderScope(child: MyApp()), + ); + runApp(ProviderScope(child: MyApp())); +``` +--- +Message: `Add ProviderScope` +Priority: 80 +Diff for file `test/lints/missing_provider_scope.dart:21`: +``` + // expect_lint: missing_provider_scope + runApp( +- MyApp(), ++ ProviderScope(child: MyApp()), + ); + runApp(ProviderScope(child: MyApp())); +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_provider_scope/missing_provider_scope_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_provider_scope/missing_provider_scope_lint.md new file mode 100644 index 000000000..5490f8e59 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/missing_provider_scope/missing_provider_scope_lint.md @@ -0,0 +1,27 @@ +code: missing_provider_scope +severity: Severity.warning +message: Flutter applications should have a ProviderScope widget at the top of the widget tree. +test/lints/missing_provider_scope.dart:6:3 + +```dart +void main() { + // expect_lint: missing_provider_scope + >>>runApp<<<( + MyApp(), + ); +``` + +======= + +code: missing_provider_scope +severity: Severity.warning +message: Flutter applications should have a ProviderScope widget at the top of the widget tree. +test/lints/missing_provider_scope.dart:20:3 + +```dart +void definitelyNotAMain() { + // expect_lint: missing_provider_scope + >>>runApp<<<( + MyApp(), + ); +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_build/notifier_build_fix.diff similarity index 81% rename from packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.diff rename to packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_build/notifier_build_fix.diff index 6e6005b7a..6f31f48bc 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_build/notifier_build_fix.diff @@ -1,6 +1,6 @@ Message: `Add build method` Priority: 80 -Diff for file `test/lints/notifier_build/fix/notifier_build.dart:8`: +Diff for file `test/lints/notifier_build.dart:12`: ``` @riverpod // expect_lint: notifier_build @@ -12,5 +12,7 @@ Diff for file `test/lints/notifier_build/fix/notifier_build.dart:8`: + throw UnimplementedError(); + } + } + +@riverpod ``` --- diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_build/notifier_build_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_build/notifier_build_lint.md new file mode 100644 index 000000000..5972ba3e3 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_build/notifier_build_lint.md @@ -0,0 +1,12 @@ +code: notifier_build +severity: Severity.error +message: Classes annotated by `@riverpod` must have the `build` method +test/lints/notifier_build.dart:12:7 + +```dart +@riverpod +// expect_lint: notifier_build +class >>>ExampleProvider1<<< extends _$ExampleProvider1 {} + +@riverpod +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_fix.diff similarity index 76% rename from packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.diff rename to packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_fix.diff index 57bc1d9a7..49a064dd5 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_fix.diff @@ -1,6 +1,6 @@ Message: `Extend _$NoExtends` Priority: 90 -Diff for file `test/lints/notifier_extends/notifier_extends.dart:15`: +Diff for file `test/lints/notifier_extends.dart:15`: ``` @riverpod // expect_lint: notifier_extends @@ -12,7 +12,7 @@ Diff for file `test/lints/notifier_extends/notifier_extends.dart:15`: --- Message: `Extend _$WrongExtends` Priority: 90 -Diff for file `test/lints/notifier_extends/notifier_extends.dart:21`: +Diff for file `test/lints/notifier_extends.dart:21`: ``` @riverpod // expect_lint: notifier_extends @@ -24,7 +24,7 @@ Diff for file `test/lints/notifier_extends/notifier_extends.dart:21`: --- Message: `Extend _$NoGenerics` Priority: 90 -Diff for file `test/lints/notifier_extends/notifier_extends.dart:39`: +Diff for file `test/lints/notifier_extends.dart:39`: ``` @riverpod // expect_lint: notifier_extends @@ -36,7 +36,7 @@ Diff for file `test/lints/notifier_extends/notifier_extends.dart:39`: --- Message: `Extend _$MissingGenerics` Priority: 90 -Diff for file `test/lints/notifier_extends/notifier_extends.dart:45`: +Diff for file `test/lints/notifier_extends.dart:45`: ``` @riverpod // expect_lint: notifier_extends @@ -48,7 +48,7 @@ Diff for file `test/lints/notifier_extends/notifier_extends.dart:45`: --- Message: `Extend _$WrongOrder` Priority: 90 -Diff for file `test/lints/notifier_extends/notifier_extends.dart:51`: +Diff for file `test/lints/notifier_extends.dart:51`: ``` @riverpod // expect_lint: notifier_extends diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_lint.md new file mode 100644 index 000000000..03dd8b072 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_lint.md @@ -0,0 +1,72 @@ +code: notifier_extends +severity: Severity.warning +message: Classes annotated by @riverpod must extend _$ClassName +test/lints/notifier_extends.dart:15:7 + +```dart +@riverpod +// expect_lint: notifier_extends +class >>>NoExtends<<< { + int build() => 0; +} +``` + +======= + +code: notifier_extends +severity: Severity.warning +message: Classes annotated by @riverpod must extend _$ClassName +test/lints/notifier_extends.dart:21:28 + +```dart +@riverpod +// expect_lint: notifier_extends +class WrongExtends extends >>>AsyncNotifier<<< { + int build() => 0; +} +``` + +======= + +code: notifier_extends +severity: Severity.warning +message: Classes annotated by @riverpod must extend _$ClassName +test/lints/notifier_extends.dart:39:44 + +```dart +@riverpod +// expect_lint: notifier_extends +class NoGenerics extends >>>_$NoGenerics<<< { + int build() => 0; +} +``` + +======= + +code: notifier_extends +severity: Severity.warning +message: Classes annotated by @riverpod must extend _$ClassName +test/lints/notifier_extends.dart:45:37 + +```dart +@riverpod +// expect_lint: notifier_extends +class MissingGenerics extends >>>_$MissingGenerics<<< { + int build() => 0; +} +``` + +======= + +code: notifier_extends +severity: Severity.warning +message: Classes annotated by @riverpod must extend _$ClassName +test/lints/notifier_extends.dart:51:32 + +```dart +@riverpod +// expect_lint: notifier_extends +class WrongOrder extends >>>_$WrongOrder<<< { + int build() => 0; +} +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/only_use_keep_alive_inside_keep_alive/only_use_keep_alive_inside_keep_alive_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/only_use_keep_alive_inside_keep_alive/only_use_keep_alive_inside_keep_alive_lint.md new file mode 100644 index 000000000..173c5cc9a --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/only_use_keep_alive_inside_keep_alive/only_use_keep_alive_inside_keep_alive_lint.md @@ -0,0 +1,29 @@ +code: only_use_keep_alive_inside_keep_alive +severity: Severity.warning +correctionMessage: Either stop marking this provider as `keepAlive` or remove `keepAlive` from the used provider. +message: If a provider is declared as `keepAlive`, it can only use providers that are also declared as `keepAlive. +test/lints/only_use_keep_alive_inside_keep_alive.dart:27:3 + +```dart + + // expect_lint: only_use_keep_alive_inside_keep_alive + >>>ref.watch(autoDisposeProvider)<<<; + // expect_lint: only_use_keep_alive_inside_keep_alive + ref.watch(autoDisposeClassProvider); +``` + +======= + +code: only_use_keep_alive_inside_keep_alive +severity: Severity.warning +correctionMessage: Either stop marking this provider as `keepAlive` or remove `keepAlive` from the used provider. +message: If a provider is declared as `keepAlive`, it can only use providers that are also declared as `keepAlive. +test/lints/only_use_keep_alive_inside_keep_alive.dart:29:3 + +```dart + ref.watch(autoDisposeProvider); + // expect_lint: only_use_keep_alive_inside_keep_alive + >>>ref.watch(autoDisposeClassProvider)<<<; + + return 0; +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/protected_notifier_properties/protected_notifier_properties_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/protected_notifier_properties/protected_notifier_properties_lint.md new file mode 100644 index 000000000..16ecd760f --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/protected_notifier_properties/protected_notifier_properties_lint.md @@ -0,0 +1,297 @@ +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:66:34 + +```dart + + // expect_lint: protected_notifier_properties + ref.read(aProvider.notifier).>>>state<<< = 42; + + // expect_lint: protected_notifier_properties +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:69:34 + +```dart + + // expect_lint: protected_notifier_properties + ref.read(aProvider.notifier).>>>state<<<++; + // expect_lint: protected_notifier_properties + ref.read(a2Provider.notifier).state++; +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:71:35 + +```dart + ref.read(aProvider.notifier).state++; + // expect_lint: protected_notifier_properties + ref.read(a2Provider.notifier).>>>state<<<++; + // expect_lint: protected_notifier_properties + ref.read(a3Provider(42).notifier).state++; +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:73:39 + +```dart + ref.read(a2Provider.notifier).state++; + // expect_lint: protected_notifier_properties + ref.read(a3Provider(42).notifier).>>>state<<<++; + // expect_lint: protected_notifier_properties + ref.read(a4Provider(42).notifier).state++; +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:75:39 + +```dart + ref.read(a3Provider(42).notifier).state++; + // expect_lint: protected_notifier_properties + ref.read(a4Provider(42).notifier).>>>state<<<++; + // expect_lint: protected_notifier_properties + ref.read(a5Provider(42).notifier).state = AsyncData(42); +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:77:39 + +```dart + ref.read(a4Provider(42).notifier).state++; + // expect_lint: protected_notifier_properties + ref.read(a5Provider(42).notifier).>>>state<<< = AsyncData(42); + // expect_lint: protected_notifier_properties + ref.read(a6Provider(42).notifier).state = AsyncData(42); +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:79:39 + +```dart + ref.read(a5Provider(42).notifier).state = AsyncData(42); + // expect_lint: protected_notifier_properties + ref.read(a6Provider(42).notifier).>>>state<<< = AsyncData(42); + // expect_lint: protected_notifier_properties + ref.read(a7Provider(42).notifier).state = AsyncData(42); +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:81:39 + +```dart + ref.read(a6Provider(42).notifier).state = AsyncData(42); + // expect_lint: protected_notifier_properties + ref.read(a7Provider(42).notifier).>>>state<<< = AsyncData(42); + // expect_lint: protected_notifier_properties + ref.read(a8Provider(42).notifier).state = AsyncData(42); +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:83:39 + +```dart + ref.read(a7Provider(42).notifier).state = AsyncData(42); + // expect_lint: protected_notifier_properties + ref.read(a8Provider(42).notifier).>>>state<<< = AsyncData(42); + // expect_lint: protected_notifier_properties + ref.read(a8Provider(42).notifier).state; +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:85:39 + +```dart + ref.read(a8Provider(42).notifier).state = AsyncData(42); + // expect_lint: protected_notifier_properties + ref.read(a8Provider(42).notifier).>>>state<<<; + + // expect_lint: protected_notifier_properties +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:88:39 + +```dart + + // expect_lint: protected_notifier_properties + ref.read(a8Provider(42).notifier).>>>future<<<; + // expect_lint: protected_notifier_properties + ref.read(a8Provider(42).notifier).ref; +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:90:39 + +```dart + ref.read(a8Provider(42).notifier).future; + // expect_lint: protected_notifier_properties + ref.read(a8Provider(42).notifier).>>>ref<<<; + } +} +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:106:34 + +```dart + + // expect_lint: protected_notifier_properties + ref.read(aProvider.notifier).>>>state<<<++; + // expect_lint: protected_notifier_properties + ref.read(a2Provider.notifier).state++; +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:108:35 + +```dart + ref.read(aProvider.notifier).state++; + // expect_lint: protected_notifier_properties + ref.read(a2Provider.notifier).>>>state<<<++; + // expect_lint: protected_notifier_properties + ref.read(a3Provider(42).notifier).state++; +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:110:39 + +```dart + ref.read(a2Provider.notifier).state++; + // expect_lint: protected_notifier_properties + ref.read(a3Provider(42).notifier).>>>state<<<++; + // expect_lint: protected_notifier_properties + ref.read(a4Provider(42).notifier).state++; +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:112:39 + +```dart + ref.read(a3Provider(42).notifier).state++; + // expect_lint: protected_notifier_properties + ref.read(a4Provider(42).notifier).>>>state<<<++; + // expect_lint: protected_notifier_properties + ref.read(a5Provider(42).notifier).state = AsyncData(42); +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:114:39 + +```dart + ref.read(a4Provider(42).notifier).state++; + // expect_lint: protected_notifier_properties + ref.read(a5Provider(42).notifier).>>>state<<< = AsyncData(42); + // expect_lint: protected_notifier_properties + ref.read(a6Provider(42).notifier).state = AsyncData(42); +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:116:39 + +```dart + ref.read(a5Provider(42).notifier).state = AsyncData(42); + // expect_lint: protected_notifier_properties + ref.read(a6Provider(42).notifier).>>>state<<< = AsyncData(42); + // expect_lint: protected_notifier_properties + ref.read(a7Provider(42).notifier).state = AsyncData(42); +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:118:39 + +```dart + ref.read(a6Provider(42).notifier).state = AsyncData(42); + // expect_lint: protected_notifier_properties + ref.read(a7Provider(42).notifier).>>>state<<< = AsyncData(42); + // expect_lint: protected_notifier_properties + ref.read(a8Provider(42).notifier).state = AsyncData(42); +``` + +======= + +code: protected_notifier_properties +severity: Severity.info +message: Notifier.state should not be used outside of its own class. +test/lints/protected_notifier_properties.dart:120:39 + +```dart + ref.read(a7Provider(42).notifier).state = AsyncData(42); + // expect_lint: protected_notifier_properties + ref.read(a8Provider(42).notifier).>>>state<<< = AsyncData(42); + } +} +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_fix.diff similarity index 66% rename from packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.diff rename to packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_fix.diff index 475399701..f235d5684 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_fix.diff @@ -1,6 +1,6 @@ Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/dependencies.dart:30`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:31`: ``` // expect_lint: provider_dependencies @@ -12,7 +12,7 @@ int watchGeneratedScopedButNoDependencies( --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/dependencies.dart:56`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:57`: ``` // expect_lint: provider_dependencies @@ -24,7 +24,7 @@ int watchGeneratedScopedButEmptyDependencies( --- Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/dependencies.dart:154`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:155`: ``` class MemberDependencies { // expect_lint: provider_dependencies @@ -36,7 +36,7 @@ class MemberDependencies { --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/dependencies.dart:162`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:163`: ``` class CanUpdateMultipleDependenciesAtOnce { // expect_lint: provider_dependencies @@ -48,7 +48,7 @@ class CanUpdateMultipleDependenciesAtOnce { --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/dependencies.dart:159`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:160`: ``` // expect_lint: provider_dependencies @@ -60,7 +60,7 @@ class CanUpdateMultipleDependenciesAtOnce { --- Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/dependencies.dart:182`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:183`: ``` // Handle identifiers with dependencies // expect_lint: provider_dependencies @@ -72,7 +72,7 @@ void fn() {} --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/dependencies.dart:186`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:187`: ``` // expect_lint: provider_dependencies @@ -85,7 +85,7 @@ Diff for file `test/lints/missing_provider_dependency/dependencies.dart:186`: --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/dependencies.dart:194`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:195`: ``` // expect_lint: provider_dependencies @@ -97,7 +97,7 @@ int foo(FooRef ref) { --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/dependencies.dart:211`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:212`: ``` // expect_lint: provider_dependencies @@ -110,7 +110,7 @@ Diff for file `test/lints/missing_provider_dependency/dependencies.dart:211`: --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/dependencies.dart:242`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:243`: ``` // expect_lint: provider_dependencies @@ -122,7 +122,7 @@ class Stateful2 extends StatefulWidget { --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/dependencies.dart:258`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:259`: ``` // expect_lint: provider_dependencies @@ -133,3 +133,15 @@ Diff for file `test/lints/missing_provider_dependency/dependencies.dart:258`: ``` --- +Message: `Specify "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:272`: +``` + +// expect_lint: provider_dependencies +- @riverpod ++ @Riverpod(dependencies: [anotherNonEmptyScoped]) +int crossFileDependency(CrossFileDependencyRef ref) { + ref.watch(anotherNonEmptyScopedProvider); +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_lint.md new file mode 100644 index 000000000..47da384f1 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_lint.md @@ -0,0 +1,299 @@ +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: generatedScoped + test/lints/provider_dependencies/missing_dependencies2.dart:35:20 + + ```dart + WatchGeneratedScopedButNoDependenciesRef ref, + ) { + return ref.watch(>>>generatedScopedProvider<<<); + } + + ``` +message: Missing dependencies: generatedScoped +test/lints/provider_dependencies/missing_dependencies2.dart:31:1 + +```dart + +// expect_lint: provider_dependencies +>>>@riverpod<<< +int watchGeneratedScopedButNoDependencies( + WatchGeneratedScopedButNoDependenciesRef ref, +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: generatedScoped + test/lints/provider_dependencies/missing_dependencies2.dart:61:20 + + ```dart + WatchGeneratedScopedButEmptyDependenciesRef ref, + ) { + return ref.watch(>>>generatedScopedProvider<<<); + } + + ``` +message: Missing dependencies: generatedScoped +test/lints/provider_dependencies/missing_dependencies2.dart:57:25 + +```dart + +// expect_lint: provider_dependencies +@Riverpod(dependencies: >>>[]<<<) +int watchGeneratedScopedButEmptyDependencies( + WatchGeneratedScopedButEmptyDependenciesRef ref, +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: dep +test/lints/provider_dependencies/missing_dependencies2.dart:155:17 + +```dart +class MemberDependencies { + // expect_lint: provider_dependencies + @Dependencies(>>>[dep]<<<) + int build() => 0; +} +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies2.dart:165:15 + + ```dart + @Dependencies([]) + int build(WidgetRef ref) { + ref.watch(>>>depProvider<<<); + return 0; + } + ``` +message: Missing dependencies: dep +test/lints/provider_dependencies/missing_dependencies2.dart:163:17 + +```dart +class CanUpdateMultipleDependenciesAtOnce { + // expect_lint: provider_dependencies + @Dependencies(>>>[]<<<) + int build(WidgetRef ref) { + ref.watch(depProvider); +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies2.dart:165:15 + + ```dart + @Dependencies([]) + int build(WidgetRef ref) { + ref.watch(>>>depProvider<<<); + return 0; + } + ``` +message: Missing dependencies: dep +test/lints/provider_dependencies/missing_dependencies2.dart:160:15 + +```dart + +// expect_lint: provider_dependencies +@Dependencies(>>>[]<<<) +class CanUpdateMultipleDependenciesAtOnce { + // expect_lint: provider_dependencies +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: dep +test/lints/provider_dependencies/missing_dependencies2.dart:183:15 + +```dart +// Handle identifiers with dependencies +// expect_lint: provider_dependencies +@Dependencies(>>>[dep]<<<) +void fn() {} + +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies2.dart:188:3 + + ```dart + // expect_lint: provider_dependencies + void fn2() { + >>>fn<<<(); + } + + ``` +message: Missing dependencies: dep +test/lints/provider_dependencies/missing_dependencies2.dart:187:1 + +```dart + +// expect_lint: provider_dependencies +>>>void fn2() { + fn(); +}<<< + +@Dependencies([dep]) +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies2.dart:197:3 + + ```dart + @riverpod + int foo(FooRef ref) { + >>>fn<<<(); + return 0; + } + ``` +message: Missing dependencies: dep +test/lints/provider_dependencies/missing_dependencies2.dart:195:1 + +```dart + +// expect_lint: provider_dependencies +>>>@riverpod<<< +int foo(FooRef ref) { + fn(); +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies2.dart:215:12 + + ```dart + @override + Widget build(BuildContext context) { + return >>>WidgetDependencies<<<(); + } + } + ``` +message: Missing dependencies: dep +test/lints/provider_dependencies/missing_dependencies2.dart:212:1 + +```dart + +// expect_lint: provider_dependencies +>>>class WidgetDependencies2 extends StatelessWidget { + @override + Widget build(BuildContext context) { + return WidgetDependencies(); + } +}<<< + +@Dependencies([dep]) +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies2.dart:254:12 + + ```dart + @override + Widget build(BuildContext context) { + return >>>WidgetDependencies<<<(); + } + } + ``` +message: Missing dependencies: dep +test/lints/provider_dependencies/missing_dependencies2.dart:243:15 + +```dart + +// expect_lint: provider_dependencies +@Dependencies(>>>[]<<<) +class Stateful2 extends StatefulWidget { + const Stateful2({super.key}); +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies2.dart:268:41 + + ```dart + class _Stateful3State extends State { + @override + Widget build(BuildContext context) => >>>WidgetDependencies<<<(); + } + + ``` +message: Missing dependencies: dep +test/lints/provider_dependencies/missing_dependencies2.dart:259:1 + +```dart + +// expect_lint: provider_dependencies +>>>class FindStateFromClassList extends StatefulWidget { + const FindStateFromClassList({super.key}); + + @override + State createState() => _Stateful3State(); +}<<< + +class _Stateful3State extends State { +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: anotherNonEmptyScoped + test/lints/provider_dependencies/missing_dependencies2.dart:274:13 + + ```dart + @riverpod + int crossFileDependency(CrossFileDependencyRef ref) { + ref.watch(>>>anotherNonEmptyScopedProvider<<<); + return 0; + } + ``` +message: Missing dependencies: anotherNonEmptyScoped +test/lints/provider_dependencies/missing_dependencies2.dart:272:1 + +```dart + +// expect_lint: provider_dependencies +>>>@riverpod<<< +int crossFileDependency(CrossFileDependencyRef ref) { + ref.watch(anotherNonEmptyScopedProvider); +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_fix.diff similarity index 69% rename from packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.diff rename to packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_fix.diff index 3a54a3879..bcee91f6b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_fix.diff @@ -1,6 +1,6 @@ Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:17`: +Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:20`: ``` // expect_lint: provider_dependencies @@ -12,7 +12,7 @@ void depFn() {} --- Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:21`: +Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:24`: ``` // expect_lint: provider_dependencies @@ -20,11 +20,23 @@ Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart + void depFamilyFn() {} +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:40`: +``` + +// expect_lint: provider_dependencies +- @Dependencies([dep]) ++ +class UnusedDepWidget extends ConsumerWidget { + const UnusedDepWidget({super.key}); ``` --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:51`: +Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:77`: ``` // expect_lint: provider_dependencies @@ -36,7 +48,7 @@ int plainAnnotation(PlainAnnotationRef ref) { --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:58`: +Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:84`: ``` // expect_lint: provider_dependencies @@ -48,7 +60,7 @@ int customAnnotation(CustomAnnotationRef ref) { --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:66`: +Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:92`: ``` // expect_lint: provider_dependencies @Riverpod( @@ -60,7 +72,7 @@ int customAnnotationWithTrailingComma( --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:78`: +Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:104`: ``` keepAlive: false, // expect_lint: provider_dependencies @@ -72,7 +84,7 @@ int existingDep(ExistingDepRef ref) { --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:88`: +Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:114`: ``` keepAlive: false, // expect_lint: provider_dependencies @@ -84,7 +96,7 @@ int multipleDeps(MultipleDepsRef ref) { --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:107`: +Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:133`: ``` // expect_lint: provider_dependencies @@ -97,7 +109,7 @@ Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:120`: +Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:146`: ``` // expect_lint: provider_dependencies @@ -110,7 +122,7 @@ Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:131`: +Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:157`: ``` // expect_lint: provider_dependencies @@ -123,7 +135,7 @@ Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:172`: +Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:222`: ``` // expect_lint: provider_dependencies @@ -136,7 +148,7 @@ Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/missing_provider_dependency/provider_dependencies.dart:203`: +Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:253`: ``` // expect_lint: provider_dependencies diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_lint.md new file mode 100644 index 000000000..37698ae8a --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_lint.md @@ -0,0 +1,378 @@ +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: dep +test/lints/provider_dependencies/missing_dependencies.dart:20:15 + +```dart + +// expect_lint: provider_dependencies +@Dependencies(>>>[dep]<<<) +void depFn() {} + +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: depFamily +test/lints/provider_dependencies/missing_dependencies.dart:24:15 + +```dart + +// expect_lint: provider_dependencies +@Dependencies(>>>[depFamily]<<<) +void depFamilyFn() {} + +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: dep +test/lints/provider_dependencies/missing_dependencies.dart:40:15 + +```dart + +// expect_lint: provider_dependencies +@Dependencies(>>>[dep]<<<) +class UnusedDepWidget extends ConsumerWidget { + const UnusedDepWidget({super.key}); +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies.dart:79:13 + + ```dart + @riverpod + int plainAnnotation(PlainAnnotationRef ref) { + ref.watch(>>>depProvider<<<); + return 0; + } + ``` +message: Missing dependencies: dep +test/lints/provider_dependencies/missing_dependencies.dart:77:1 + +```dart + +// expect_lint: provider_dependencies +>>>@riverpod<<< +int plainAnnotation(PlainAnnotationRef ref) { + ref.watch(depProvider); +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies.dart:86:13 + + ```dart + @Riverpod(keepAlive: false) + int customAnnotation(CustomAnnotationRef ref) { + ref.watch(>>>depProvider<<<); + return 0; + } + ``` +message: Missing dependencies: dep +test/lints/provider_dependencies/missing_dependencies.dart:84:1 + +```dart + +// expect_lint: provider_dependencies +>>>@Riverpod(keepAlive: false)<<< +int customAnnotation(CustomAnnotationRef ref) { + ref.watch(depProvider); +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies.dart:97:13 + + ```dart + CustomAnnotationWithTrailingCommaRef ref, + ) { + ref.watch(>>>depProvider<<<); + return 0; + } + ``` +message: Missing dependencies: dep +test/lints/provider_dependencies/missing_dependencies.dart:91:1 + +```dart + +// expect_lint: provider_dependencies +>>>@Riverpod( + keepAlive: false, +)<<< +int customAnnotationWithTrailingComma( + CustomAnnotationWithTrailingCommaRef ref, +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies.dart:107:13 + + ```dart + ) + int existingDep(ExistingDepRef ref) { + ref.watch(>>>depProvider<<<); + return 0; + } + ``` +message: Missing dependencies: dep +test/lints/provider_dependencies/missing_dependencies.dart:104:17 + +```dart + keepAlive: false, + // expect_lint: provider_dependencies + dependencies: >>>[]<<<, +) +int existingDep(ExistingDepRef ref) { +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies.dart:117:13 + + ```dart + ) + int multipleDeps(MultipleDepsRef ref) { + ref.watch(>>>depProvider<<<); + ref.watch(dep2Provider); + return 0; + ``` + + message: dep2 + test/lints/provider_dependencies/missing_dependencies.dart:118:13 + + ```dart + int multipleDeps(MultipleDepsRef ref) { + ref.watch(depProvider); + ref.watch(>>>dep2Provider<<<); + return 0; + } + ``` +message: Missing dependencies: dep, dep2 +test/lints/provider_dependencies/missing_dependencies.dart:114:17 + +```dart + keepAlive: false, + // expect_lint: provider_dependencies + dependencies: >>>[]<<<, +) +int multipleDeps(MultipleDepsRef ref) { +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies.dart:136:12 + + ```dart + @override + Widget build(BuildContext context, WidgetRef ref) { + return >>>DepWidget<<<( + child: ProviderScope( + overrides: [depProvider.overrideWithValue(42)], + ``` +message: Missing dependencies: dep +test/lints/provider_dependencies/missing_dependencies.dart:133:1 + +```dart + +// expect_lint: provider_dependencies +>>>class AboveScope extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return DepWidget( + child: ProviderScope( + overrides: [depProvider.overrideWithValue(42)], + child: Container(), + ), + ); + } +}<<< + +// expect_lint: provider_dependencies +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies.dart:151:32 + + ```dart + return ProviderScope( + overrides: [depProvider.overrideWithValue(42)], + child: Text('${ref.watch(>>>depProvider<<<)}'), + ); + } + ``` +message: Missing dependencies: dep +test/lints/provider_dependencies/missing_dependencies.dart:146:1 + +```dart + +// expect_lint: provider_dependencies +>>>class Scope2 extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return ProviderScope( + overrides: [depProvider.overrideWithValue(42)], + child: Text('${ref.watch(depProvider)}'), + ); + } +}<<< + +// expect_lint: provider_dependencies +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: dep + test/lints/provider_dependencies/missing_dependencies.dart:167:14 + + ```dart + if (condition) depProvider.overrideWithValue(42), + ], + child: >>>DepWidget<<<(), + ); + } + ``` +message: Missing dependencies: dep +test/lints/provider_dependencies/missing_dependencies.dart:157:1 + +```dart + +// expect_lint: provider_dependencies +>>>class ConditionalScope extends ConsumerWidget { + ConditionalScope({super.key, required this.condition}); + final bool condition; + + @override + Widget build(BuildContext context, WidgetRef ref) { + return ProviderScope( + overrides: [ + if (condition) depProvider.overrideWithValue(42), + ], + child: DepWidget(), + ); + } +}<<< + +class Scope4 extends ConsumerWidget { +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: depFamily + test/lints/provider_dependencies/missing_dependencies.dart:227:14 + + ```dart + ProviderScope( + overrides: [depProvider.overrideWith((ref) => 0)], + child: >>>DepFamily<<<(), + ); + + ``` + + message: dep + test/lints/provider_dependencies/missing_dependencies.dart:232:14 + + ```dart + return ProviderScope( + overrides: [depFamilyProvider.overrideWith((ref, arg) => 0)], + child: >>>DepWidget<<<(), + ); + } + ``` +message: Missing dependencies: depFamily, dep +test/lints/provider_dependencies/missing_dependencies.dart:222:1 + +```dart + +// expect_lint: provider_dependencies +>>>class SupportsMultipleScopes2 extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + ProviderScope( + overrides: [depProvider.overrideWith((ref) => 0)], + child: DepFamily(), + ); + + return ProviderScope( + overrides: [depFamilyProvider.overrideWith((ref, arg) => 0)], + child: DepWidget(), + ); + } +}<<< + +class SupportsNestedScopes extends ConsumerWidget { +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: depFamily + test/lints/provider_dependencies/missing_dependencies.dart:258:14 + + ```dart + return ProviderScope( + overrides: [depFamilyProvider(42).overrideWith((ref) => 0)], + child: >>>DepFamily<<<(), + ); + } + ``` +message: Missing dependencies: depFamily +test/lints/provider_dependencies/missing_dependencies.dart:253:1 + +```dart + +// expect_lint: provider_dependencies +>>>class IncompleteFamilyOverride extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return ProviderScope( + overrides: [depFamilyProvider(42).overrideWith((ref) => 0)], + child: DepFamily(), + ); + } +}<<< + +@Dependencies([dep]) +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_fix.diff similarity index 71% rename from packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.diff rename to packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_fix.diff index 56c1adbc9..1c4036b23 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_fix.diff @@ -1,6 +1,6 @@ Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:22`: +Diff for file `test/lints/provider_dependencies/unused_dependency.dart:22`: ``` keepAlive: false, // expect_lint: provider_dependencies @@ -15,7 +15,7 @@ int extraDep(ExtraDepRef ref) { --- Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:34`: +Diff for file `test/lints/provider_dependencies/unused_dependency.dart:34`: ``` @Riverpod( keepAlive: false, @@ -31,7 +31,7 @@ int noDep(NoDepRef ref) { --- Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:45`: +Diff for file `test/lints/provider_dependencies/unused_dependency.dart:45`: ``` @Riverpod( // expect_lint: provider_dependencies @@ -46,7 +46,7 @@ int dependenciesFirstThenKeepAlive(DependenciesFirstThenKeepAliveRef ref) { --- Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:54`: +Diff for file `test/lints/provider_dependencies/unused_dependency.dart:54`: ``` } @@ -63,7 +63,7 @@ int noDepNoParam(NoDepNoParamRef ref) { --- Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:65`: +Diff for file `test/lints/provider_dependencies/unused_dependency.dart:65`: ``` // expect_lint: provider_dependencies @@ -75,7 +75,7 @@ int noDepWithoutComma(NoDepWithoutCommaRef ref) { --- Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:72`: +Diff for file `test/lints/provider_dependencies/unused_dependency.dart:72`: ``` @Riverpod( keepAlive: false, @@ -91,7 +91,7 @@ int rootDep(RootDepRef ref) => 0; --- Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:80`: +Diff for file `test/lints/provider_dependencies/unused_dependency.dart:80`: ``` // expect_lint: provider_dependencies @@ -103,7 +103,7 @@ class StateNotFound extends ConsumerStatefulWidget { --- Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:118`: +Diff for file `test/lints/provider_dependencies/unused_dependency.dart:118`: ``` // expect_lint: provider_dependencies @@ -115,7 +115,7 @@ void fn() {} --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:131`: +Diff for file `test/lints/provider_dependencies/unused_dependency.dart:131`: ``` // expect_lint: provider_dependencies @@ -127,7 +127,7 @@ void secondUnused() { --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/unused_provider_dependency/provider_dependencies.dart:137`: +Diff for file `test/lints/provider_dependencies/unused_dependency.dart:137`: ``` // expect_lint: provider_dependencies diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_lint.md new file mode 100644 index 000000000..1715ef512 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_lint.md @@ -0,0 +1,161 @@ +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: dep +test/lints/provider_dependencies/unused_dependency.dart:22:17 + +```dart + keepAlive: false, + // expect_lint: provider_dependencies + dependencies: >>>[ + dep, + dep2, + ]<<<, +) +int extraDep(ExtraDepRef ref) { +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: dep +test/lints/provider_dependencies/unused_dependency.dart:35:17 + +```dart + keepAlive: false, + // expect_lint: provider_dependencies + dependencies: >>>[ + dep, + ]<<<, +) +int noDep(NoDepRef ref) { +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: dep +test/lints/provider_dependencies/unused_dependency.dart:45:17 + +```dart +@Riverpod( + // expect_lint: provider_dependencies + dependencies: >>>[ + dep, + ]<<<, + keepAlive: false, +) +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: dep +test/lints/provider_dependencies/unused_dependency.dart:56:17 + +```dart +@Riverpod( + // expect_lint: provider_dependencies + dependencies: >>>[ + dep, + ]<<<, +) +int noDepNoParam(NoDepNoParamRef ref) { +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: dep +test/lints/provider_dependencies/unused_dependency.dart:65:43 + +```dart + +// expect_lint: provider_dependencies +@Riverpod(keepAlive: false, dependencies: >>>[dep]<<<) +int noDepWithoutComma(NoDepWithoutCommaRef ref) { + return 0; +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: root +test/lints/provider_dependencies/unused_dependency.dart:73:17 + +```dart + keepAlive: false, + // expect_lint: provider_dependencies + dependencies: >>>[ + root, + ]<<<, +) +int rootDep(RootDepRef ref) => 0; +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: dep +test/lints/provider_dependencies/unused_dependency.dart:80:15 + +```dart + +// expect_lint: provider_dependencies +@Dependencies(>>>[dep]<<<) +class StateNotFound extends ConsumerStatefulWidget { + @override +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: dep +test/lints/provider_dependencies/unused_dependency.dart:118:15 + +```dart + +// expect_lint: provider_dependencies +@Dependencies(>>>[dep]<<<) +void fn() {} + +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: dep +test/lints/provider_dependencies/unused_dependency.dart:131:15 + +```dart + +// expect_lint: provider_dependencies +@Dependencies(>>>[dep2, dep]<<<) +void secondUnused() { + dep2Provider; +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: dep +test/lints/provider_dependencies/unused_dependency.dart:137:15 + +```dart + +// expect_lint: provider_dependencies +@Dependencies(>>>[ + dep2, + dep, +]<<<) +void secondUnusedWithTrailingComma() { + dep2Provider; +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_parameters/provider_parameters_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_parameters/provider_parameters_lint.md new file mode 100644 index 000000000..827853ff2 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_parameters/provider_parameters_lint.md @@ -0,0 +1,432 @@ +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:20:19 + +```dart + ref.read(legacy(list)); + // expect_lint: provider_parameters + ref.read(legacy(>>>[42]<<<)); + ref.listen(legacy(42), (prev, next) {}); + // expect_lint: provider_parameters +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:23:21 + +```dart + ref.listen(legacy(42), (prev, next) {}); + // expect_lint: provider_parameters + ref.listen(legacy(>>>[42]<<<), (prev, next) {}); + + ref.watch(legacy(42)); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:27:20 + +```dart + ref.watch(legacy(42)); + // expect_lint: provider_parameters + ref.watch(legacy(>>>[42]<<<)); + // expect_lint: provider_parameters + ref.watch(legacy({'string': 42})); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:29:20 + +```dart + ref.watch(legacy([42])); + // expect_lint: provider_parameters + ref.watch(legacy(>>>{'string': 42}<<<)); + // expect_lint: provider_parameters + ref.watch(legacy({42})); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:31:20 + +```dart + ref.watch(legacy({'string': 42})); + // expect_lint: provider_parameters + ref.watch(legacy(>>>{42}<<<)); + ref.watch(legacy(const [42])); + ref.watch(legacy(const {'string': 42})); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:37:20 + +```dart + ref.watch(legacy(null)); + // expect_lint: provider_parameters + ref.watch(legacy(>>>Object()<<<)); + ref.watch(legacy(const Object())); + ref.watch(legacy(FreezedExample())); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:44:22 + +```dart + + // expect_lint: provider_parameters + ref.watch(provider(>>>() {}<<<)); + ref.watch(provider(fn)); + +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:50:20 + +```dart + ref.watch(legacy(const ClassThatOverridesEqual())); + // expect_lint: provider_parameters + ref.watch(legacy(>>>Factory.bar()<<<)); + ref.watch(legacy(const Factory.bar())); + ref.watch(legacy(Factory.foo())); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:57:38 + +```dart + ref.watch(generatorProvider(value: 42)); + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: >>>[42]<<<)); + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: {'string': 42})); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:59:38 + +```dart + ref.watch(generatorProvider(value: [42])); + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: >>>{'string': 42}<<<)); + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: {42})); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:61:38 + +```dart + ref.watch(generatorProvider(value: {'string': 42})); + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: >>>{42}<<<)); + ref.watch(generatorProvider(value: const [42])); + ref.watch(generatorProvider(value: const {'string': 42})); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:67:38 + +```dart + ref.watch(generatorProvider(value: null)); + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: >>>Object()<<<)); + ref.watch(generatorProvider(value: const Object())); + +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:74:38 + +```dart + + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: >>>Bar()<<<)); + ref.watch(generatorProvider(value: const Bar())); + +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:78:38 + +```dart + + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: >>>Factory.bar()<<<)); + ref.watch(generatorProvider(value: const Factory.bar())); + ref.watch(generatorProvider(value: Factory.foo())); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:115:21 + +```dart + ref.read(legacy(42)); + // expect_lint: provider_parameters + ref.read(legacy(>>>[42]<<<)); + ref.listen(legacy(42), (prev, next) {}); + // expect_lint: provider_parameters +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:118:23 + +```dart + ref.listen(legacy(42), (prev, next) {}); + // expect_lint: provider_parameters + ref.listen(legacy(>>>[42]<<<), (prev, next) {}); + ref.listenManual(legacy(42), (prev, next) {}); + // expect_lint: provider_parameters +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:121:29 + +```dart + ref.listenManual(legacy(42), (prev, next) {}); + // expect_lint: provider_parameters + ref.listenManual(legacy(>>>[42]<<<), (prev, next) {}); + + ref.watch(legacy(42)); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:126:22 + +```dart + ref.read(legacy(list)); + // expect_lint: provider_parameters + ref.watch(legacy(>>>[42]<<<)); + // expect_lint: provider_parameters + ref.watch(legacy({'string': 42})); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:128:22 + +```dart + ref.watch(legacy([42])); + // expect_lint: provider_parameters + ref.watch(legacy(>>>{'string': 42}<<<)); + // expect_lint: provider_parameters + ref.watch(legacy({42})); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:130:22 + +```dart + ref.watch(legacy({'string': 42})); + // expect_lint: provider_parameters + ref.watch(legacy(>>>{42}<<<)); + ref.watch(legacy(const [42])); + ref.watch(legacy(const {'string': 42})); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:136:22 + +```dart + ref.watch(legacy(null)); + // expect_lint: provider_parameters + ref.watch(legacy(>>>Object()<<<)); + ref.watch(legacy(const Object())); + +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:142:22 + +```dart + ref.watch(legacy(const ClassThatOverridesEqual())); + // expect_lint: provider_parameters + ref.watch(legacy(>>>Bar()<<<)); + ref.watch(legacy(const Bar())); + // expect_lint: provider_parameters +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:145:22 + +```dart + ref.watch(legacy(const Bar())); + // expect_lint: provider_parameters + ref.watch(legacy(>>>Factory.bar()<<<)); + ref.watch(legacy(const Factory.bar())); + ref.watch(legacy(Factory.foo())); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:152:40 + +```dart + ref.watch(generatorProvider(value: 42)); + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: >>>[42]<<<)); + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: {'string': 42})); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:154:40 + +```dart + ref.watch(generatorProvider(value: [42])); + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: >>>{'string': 42}<<<)); + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: {42})); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:156:40 + +```dart + ref.watch(generatorProvider(value: {'string': 42})); + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: >>>{42}<<<)); + ref.watch(generatorProvider(value: const [42])); + ref.watch(generatorProvider(value: const {'string': 42})); +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:162:40 + +```dart + ref.watch(generatorProvider(value: null)); + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: >>>Object()<<<)); + ref.watch(generatorProvider(value: const Object())); + +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:169:40 + +```dart + + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: >>>Bar()<<<)); + ref.watch(generatorProvider(value: const Bar())); + +``` + +======= + +code: provider_parameters +severity: Severity.warning +message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == +test/lints/provider_parameters.dart:173:40 + +```dart + + // expect_lint: provider_parameters + ref.watch(generatorProvider(value: >>>Factory.bar()<<<)); + ref.watch(generatorProvider(value: const Factory.bar())); + ref.watch(generatorProvider(value: Factory.foo())); +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/riverpod_syntax_error/riverpod_syntax_error_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/riverpod_syntax_error/riverpod_syntax_error_lint.md new file mode 100644 index 000000000..5e3a6c118 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/riverpod_syntax_error/riverpod_syntax_error_lint.md @@ -0,0 +1,12 @@ +code: riverpod_syntax_error +severity: Severity.error +message: Classes annotated with @riverpod cannot be abstract. +test/lints/riverpod_syntax_error.dart:8:16 + +```dart +@riverpod +// expect_lint: riverpod_syntax_error +abstract class >>>ExampleProvider1<<< extends _$ExampleProvider1 { + int build() => 0; +} +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/scoped_providers_should_specify_dependencies/scoped_providers_should_specify_dependencies_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/scoped_providers_should_specify_dependencies/scoped_providers_should_specify_dependencies_lint.md new file mode 100644 index 000000000..9646a4c0e --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/scoped_providers_should_specify_dependencies/scoped_providers_should_specify_dependencies_lint.md @@ -0,0 +1,147 @@ +code: scoped_providers_should_specify_dependencies +severity: Severity.warning +message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. +test/lints/scoped_providers_should_specify_dependencies.dart:43:7 + +```dart + .overrideWith(() => throw UnimplementedError()), + // expect_lint: scoped_providers_should_specify_dependencies + >>>rootProvider.overrideWith((ref) => 0)<<<, + ], + ); +``` + +======= + +code: scoped_providers_should_specify_dependencies +severity: Severity.warning +message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. +test/lints/scoped_providers_should_specify_dependencies.dart:67:9 + +```dart + // This is not a Flutter's runApp, so the ProviderScope is considered scoped + // expect_lint: scoped_providers_should_specify_dependencies + >>>rootProvider.overrideWith((ref) => 0)<<<, + ], + child: Container(), +``` + +======= + +code: scoped_providers_should_specify_dependencies +severity: Severity.warning +message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. +test/lints/scoped_providers_should_specify_dependencies.dart:81:9 + +```dart + .overrideWith(() => throw UnimplementedError()), + // expect_lint: scoped_providers_should_specify_dependencies + >>>rootProvider.overrideWith((ref) => 0)<<<, + ], + child: Container(), +``` + +======= + +code: scoped_providers_should_specify_dependencies +severity: Severity.warning +message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. +test/lints/scoped_providers_should_specify_dependencies.dart:106:7 + +```dart + .overrideWith(() => throw UnimplementedError()), + // expect_lint: scoped_providers_should_specify_dependencies + >>>rootProvider.overrideWith((ref) => 0)<<<, + ], + ); +``` + +======= + +code: scoped_providers_should_specify_dependencies +severity: Severity.warning +message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. +test/lints/scoped_providers_should_specify_dependencies.dart:130:9 + +```dart + .overrideWith(() => throw UnimplementedError()), + // expect_lint: scoped_providers_should_specify_dependencies + >>>rootProvider.overrideWith((ref) => 0)<<<, + ], + child: Container(), +``` + +======= + +code: scoped_providers_should_specify_dependencies +severity: Severity.warning +message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. +test/lints/scoped_providers_should_specify_dependencies.dart:168:11 + +```dart + .overrideWith(() => throw UnimplementedError()), + // expect_lint: scoped_providers_should_specify_dependencies + >>>rootProvider.overrideWith((ref) => 0)<<<, + ], + child: Container(), +``` + +======= + +code: scoped_providers_should_specify_dependencies +severity: Severity.warning +message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. +test/lints/scoped_providers_should_specify_dependencies.dart:182:13 + +```dart + .overrideWith(() => throw UnimplementedError()), + // expect_lint: scoped_providers_should_specify_dependencies + >>>rootProvider.overrideWith((ref) => 0)<<<, + ], + child: Container(), +``` + +======= + +code: scoped_providers_should_specify_dependencies +severity: Severity.warning +message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. +test/lints/scoped_providers_should_specify_dependencies.dart:198:7 + +```dart + .overrideWith(() => throw UnimplementedError()), + // expect_lint: scoped_providers_should_specify_dependencies + >>>rootProvider.overrideWith((ref) => 0)<<<, + ], + child: Container(), +``` + +======= + +code: scoped_providers_should_specify_dependencies +severity: Severity.warning +message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. +test/lints/scoped_providers_should_specify_dependencies.dart:214:11 + +```dart + .overrideWith(() => throw UnimplementedError()), + // expect_lint: scoped_providers_should_specify_dependencies + >>>rootProvider.overrideWith((ref) => 0)<<<, + ], + child: Container(), +``` + +======= + +code: scoped_providers_should_specify_dependencies +severity: Severity.warning +message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. +test/lints/scoped_providers_should_specify_dependencies.dart:233:9 + +```dart + .overrideWith(() => throw UnimplementedError()), + // expect_lint: scoped_providers_should_specify_dependencies + >>>rootProvider.overrideWith((ref) => 0)<<<, + ], + child: Container(), +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/unknown_scoped_usage/unknown_scoped_usage_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/unknown_scoped_usage/unknown_scoped_usage_lint.md new file mode 100644 index 000000000..291f9421c --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/unknown_scoped_usage/unknown_scoped_usage_lint.md @@ -0,0 +1,72 @@ +code: unknown_scoped_usage +severity: Severity.warning +message: A provider was used, but could not find the associated `ref`. +test/lints/unknown_scoped_usage.dart:16:3 + +```dart +void fn(WidgetRef widgetRef, Ref ref) { + // expect_lint: unknown_scoped_usage + >>>scopedProvider<<<; + rootProvider; + +``` + +======= + +code: unknown_scoped_usage +severity: Severity.warning +message: A provider was used, but could not find the associated `ref`. +test/lints/unknown_scoped_usage.dart:25:28 + +```dart + // Unknown ref usage inside a ref expression + // expect_lint: unknown_scoped_usage + widgetRef.watch(identity(>>>scopedProvider<<<)); + // expect_lint: unknown_scoped_usage + ref.watch(identity(scopedProvider)); +``` + +======= + +code: unknown_scoped_usage +severity: Severity.warning +message: A provider was used, but could not find the associated `ref`. +test/lints/unknown_scoped_usage.dart:27:22 + +```dart + widgetRef.watch(identity(scopedProvider)); + // expect_lint: unknown_scoped_usage + ref.watch(identity(>>>scopedProvider<<<)); + // expect_lint: unknown_scoped_usage + ref.watch(identityMap[scopedProvider]); +``` + +======= + +code: unknown_scoped_usage +severity: Severity.warning +message: A provider was used, but could not find the associated `ref`. +test/lints/unknown_scoped_usage.dart:29:25 + +```dart + ref.watch(identity(scopedProvider)); + // expect_lint: unknown_scoped_usage + ref.watch(identityMap[>>>scopedProvider<<<]); + + // Overrides are OK +``` + +======= + +code: unknown_scoped_usage +severity: Severity.warning +message: A provider was used, but could not find the associated `ref`. +test/lints/unknown_scoped_usage.dart:36:16 + +```dart + // If passed as widget constructor parameter, it's OK + // expect_lint: unknown_scoped_usage + RandomObject(>>>scopedProvider<<<); + MyWidget(scopedProvider); +} +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/unsupported_provider_value/unsupported_provider_value_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/unsupported_provider_value/unsupported_provider_value_lint.md new file mode 100644 index 000000000..0abe96313 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/unsupported_provider_value/unsupported_provider_value_lint.md @@ -0,0 +1,189 @@ +code: unsupported_provider_value +severity: Severity.info +correctionMessage: If using StateNotifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. +message: The riverpod_generator package does not support StateNotifier values. +test/lints/unsupported_provider_value.dart:13:17 + +```dart +@riverpod +// expect_lint: unsupported_provider_value +MyStateNotifier >>>stateNotifier<<<(StateNotifierRef ref) => MyStateNotifier(); + +@riverpod +``` + +======= + +code: unsupported_provider_value +severity: Severity.info +correctionMessage: If using StateNotifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. +message: The riverpod_generator package does not support StateNotifier values. +test/lints/unsupported_provider_value.dart:17:25 + +```dart +@riverpod +// expect_lint: unsupported_provider_value +Future >>>asyncStateNotifier<<<(AsyncStateNotifierRef ref) async { + return MyStateNotifier(); +} +``` + +======= + +code: unsupported_provider_value +severity: Severity.info +correctionMessage: If using StateNotifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. +message: The riverpod_generator package does not support StateNotifier values. +test/lints/unsupported_provider_value.dart:23:7 + +```dart +@riverpod +// expect_lint: unsupported_provider_value +class >>>StateNotifierClass<<< extends _$StateNotifierClass { + MyStateNotifier build() => MyStateNotifier(); +} +``` + +======= + +code: unsupported_provider_value +severity: Severity.info +correctionMessage: If using StateNotifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. +message: The riverpod_generator package does not support StateNotifier values. +test/lints/unsupported_provider_value.dart:29:25 + +```dart +@riverpod +// expect_lint: unsupported_provider_value +Future >>>stateNotifierAsync<<<(StateNotifierAsyncRef ref) async => + MyStateNotifier(); + +``` + +======= + +code: unsupported_provider_value +severity: Severity.info +correctionMessage: If using StateNotifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. +message: The riverpod_generator package does not support StateNotifier values. +test/lints/unsupported_provider_value.dart:52:7 + +```dart +@riverpod +// expect_lint: unsupported_provider_value +class >>>StateNotifierClassAsync<<< extends _$StateNotifierClassAsync { + Future build() async => MyStateNotifier(); +} +``` + +======= + +code: unsupported_provider_value +severity: Severity.info +correctionMessage: If using ChangeNotifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. +message: The riverpod_generator package does not support ChangeNotifier values. +test/lints/unsupported_provider_value.dart:62:18 + +```dart +@riverpod +// expect_lint: unsupported_provider_value +MyChangeNotifier >>>changeNotifier<<<(ChangeNotifierRef ref) => MyChangeNotifier(); + +@riverpod +``` + +======= + +code: unsupported_provider_value +severity: Severity.info +correctionMessage: If using ChangeNotifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. +message: The riverpod_generator package does not support ChangeNotifier values. +test/lints/unsupported_provider_value.dart:66:7 + +```dart +@riverpod +// expect_lint: unsupported_provider_value +class >>>ChangeNotifierClass<<< extends _$ChangeNotifierClass { + MyChangeNotifier build() => MyChangeNotifier(); +} +``` + +======= + +code: unsupported_provider_value +severity: Severity.info +correctionMessage: If using Notifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. +message: The riverpod_generator package does not support Notifier values. +test/lints/unsupported_provider_value.dart:74:12 + +```dart +@riverpod +// expect_lint: unsupported_provider_value +MyNotifier >>>notifier<<<(NotifierRef ref) => MyNotifier(); + +@riverpod +``` + +======= + +code: unsupported_provider_value +severity: Severity.info +correctionMessage: If using Notifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. +message: The riverpod_generator package does not support Notifier values. +test/lints/unsupported_provider_value.dart:78:23 + +```dart +@riverpod +// expect_lint: unsupported_provider_value +MyAutoDisposeNotifier >>>autoDisposeNotifier<<<(AutoDisposeNotifierRef ref) { + return MyAutoDisposeNotifier(); +} +``` + +======= + +code: unsupported_provider_value +severity: Severity.info +correctionMessage: If using Notifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. +message: The riverpod_generator package does not support Notifier values. +test/lints/unsupported_provider_value.dart:84:7 + +```dart +@riverpod +// expect_lint: unsupported_provider_value +class >>>NotifierClass<<< extends _$NotifierClass { + MyNotifier build() => MyNotifier(); +} +``` + +======= + +code: unsupported_provider_value +severity: Severity.info +correctionMessage: If using AsyncNotifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. +message: The riverpod_generator package does not support AsyncNotifier values. +test/lints/unsupported_provider_value.dart:100:17 + +```dart +@riverpod +// expect_lint: unsupported_provider_value +MyAsyncNotifier >>>asyncNotifier<<<(AsyncNotifierRef ref) => MyAsyncNotifier(); + +@riverpod +``` + +======= + +code: unsupported_provider_value +severity: Severity.info +correctionMessage: If using AsyncNotifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. +message: The riverpod_generator package does not support AsyncNotifier values. +test/lints/unsupported_provider_value.dart:104:7 + +```dart +@riverpod +// expect_lint: unsupported_provider_value +class >>>AsyncNotifierClass<<< extends _$AsyncNotifierClass { + MyAsyncNotifier build() => MyAsyncNotifier(); +} +``` diff --git a/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import.dart b/packages/riverpod_lint_flutter_test/test/lints/missing_legacy_import/missing_legacy_import.dart similarity index 100% rename from packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import.dart rename to packages/riverpod_lint_flutter_test/test/lints/missing_legacy_import/missing_legacy_import.dart diff --git a/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_flutter_riverpod.dart b/packages/riverpod_lint_flutter_test/test/lints/missing_legacy_import/with_flutter_riverpod.dart similarity index 100% rename from packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_flutter_riverpod.dart rename to packages/riverpod_lint_flutter_test/test/lints/missing_legacy_import/with_flutter_riverpod.dart diff --git a/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_hooks_riverpod.dart b/packages/riverpod_lint_flutter_test/test/lints/missing_legacy_import/with_hooks_riverpod.dart similarity index 100% rename from packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_hooks_riverpod.dart rename to packages/riverpod_lint_flutter_test/test/lints/missing_legacy_import/with_hooks_riverpod.dart diff --git a/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_riverpod_import.dart b/packages/riverpod_lint_flutter_test/test/lints/missing_legacy_import/with_riverpod_import.dart similarity index 100% rename from packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/with_riverpod_import.dart rename to packages/riverpod_lint_flutter_test/test/lints/missing_legacy_import/with_riverpod_import.dart diff --git a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies_test.dart b/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies_test.dart deleted file mode 100644 index bb49b01f4..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies_test.dart +++ /dev/null @@ -1,41 +0,0 @@ -import 'package:collection/collection.dart'; -import 'package:riverpod_lint/src/lints/provider_dependencies.dart'; - -import '../../golden.dart'; - -void main() { - testGolden( - 'Verifies if some scoped providers are used but not specified as dependency', - 'lints/missing_provider_dependency/provider_dependencies.diff', - sourcePath: - 'test/lints/missing_provider_dependency/provider_dependencies.dart', - (result) async { - const lint = ProviderDependencies(); - final fix = lint.getFixes().single; - - final errors = await lint.testRun(result); - final changes = await Future.wait([ - for (final error in errors) fix.testRun(result, error, errors), - ]); - - return changes.flattened; - }, - ); - - testGolden( - 'Verifies if some scoped providers are used but not specified as dependency', - 'lints/missing_provider_dependency/dependencies.diff', - sourcePath: 'test/lints/missing_provider_dependency/dependencies.dart', - (result) async { - const lint = ProviderDependencies(); - final fix = lint.getFixes().single; - - final errors = await lint.testRun(result); - final changes = await Future.wait([ - for (final error in errors) fix.testRun(result, error, errors), - ]); - - return changes.flattened; - }, - ); -} diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/notifier_build.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_build.dart similarity index 100% rename from packages/riverpod_lint_flutter_test/test/lints/notifier_build/notifier_build.dart rename to packages/riverpod_lint_flutter_test/test/lints/notifier_build.dart diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.dart deleted file mode 100644 index 27f5e0959..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build.dart +++ /dev/null @@ -1,8 +0,0 @@ -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -/// Fake Provider -typedef _$ExampleProvider1 = Object; - -@riverpod -// expect_lint: notifier_build -class ExampleProvider1 extends _$ExampleProvider1 {} diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build_test.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build_test.dart deleted file mode 100644 index c0ddf8731..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_build/fix/notifier_build_test.dart +++ /dev/null @@ -1,24 +0,0 @@ -import 'package:collection/collection.dart'; -import 'package:riverpod_lint/src/lints/notifier_build.dart'; - -import '../../../golden.dart'; - -void main() { - testGolden( - 'Verify that @riverpod classes has the build method', - 'lints/notifier_build/fix/notifier_build.diff', - sourcePath: 'test/lints/notifier_build/fix/notifier_build.dart', - (result) async { - const lint = NotifierBuild(); - final fix = lint.getFixes().single; - - final errors = await lint.testRun(result); - - final changes = await Future.wait([ - for (final error in errors) fix.testRun(result, error, errors), - ]); - - return changes.flattened; - }, - ); -} diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.dart similarity index 100% rename from packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.dart rename to packages/riverpod_lint_flutter_test/test/lints/notifier_extends.dart diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart similarity index 100% rename from packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart rename to packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart deleted file mode 100644 index aa435bd7f..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends_test.dart +++ /dev/null @@ -1,27 +0,0 @@ -import 'package:custom_lint_builder/custom_lint_builder.dart'; -import 'package:collection/collection.dart'; -import 'package:riverpod_lint/src/lints/notifier_extends.dart'; -import 'package:test/test.dart'; - -import '../../golden.dart'; - -void main() { - testGolden( - 'Verify that @riverpod classes extend the generated typedef', - 'lints/notifier_extends/notifier_extends.diff', - sourcePath: 'test/lints/notifier_extends/notifier_extends.dart', - (result) async { - final lint = NotifierExtends(); - final fix = lint.getFixes().single as DartFix; - - final errors = await lint.testRun(result); - expect(errors, hasLength(5)); - - final changes = await Future.wait([ - for (final error in errors) fix.testRun(result, error, errors), - ]); - - return changes.flattened; - }, - ); -} diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.dart new file mode 100644 index 000000000..295747979 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.dart @@ -0,0 +1,18 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'another.g.dart'; + +final aProvider = Provider((ref) => 0); + +@riverpod +int b(BRef ref) => 0; + +@Riverpod(dependencies: []) +int anotherScoped(AnotherScopedRef ref) => 0; + +@Riverpod(dependencies: [anotherScoped]) +int anotherNonEmptyScoped(AnotherNonEmptyScopedRef ref) { + ref.watch(anotherScopedProvider); + return 0; +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart new file mode 100644 index 000000000..4ee57465c --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart @@ -0,0 +1,194 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'another.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef BRef = Ref; + +@ProviderFor(b) +const bProvider = BProvider._(); + +final class BProvider extends $FunctionalProvider + with $Provider { + const BProvider._( + {int Function( + BRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'bProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + BRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$bHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + BProvider $copyWithCreate( + int Function( + BRef ref, + ) create, + ) { + return BProvider._(create: create); + } + + @override + int create(BRef ref) { + final _$cb = _createCb ?? b; + return _$cb(ref); + } +} + +String _$bHash() => r'52593050701642f22b31c590f20c003dc2ee1579'; + +typedef AnotherScopedRef = Ref; + +@ProviderFor(anotherScoped) +const anotherScopedProvider = AnotherScopedProvider._(); + +final class AnotherScopedProvider + extends $FunctionalProvider + with $Provider { + const AnotherScopedProvider._( + {int Function( + AnotherScopedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'anotherScopedProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + AnotherScopedRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$anotherScopedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + AnotherScopedProvider $copyWithCreate( + int Function( + AnotherScopedRef ref, + ) create, + ) { + return AnotherScopedProvider._(create: create); + } + + @override + int create(AnotherScopedRef ref) { + final _$cb = _createCb ?? anotherScoped; + return _$cb(ref); + } +} + +String _$anotherScopedHash() => r'409a070806b566d16d98f18c99bf6243d481887f'; + +typedef AnotherNonEmptyScopedRef = Ref; + +@ProviderFor(anotherNonEmptyScoped) +const anotherNonEmptyScopedProvider = AnotherNonEmptyScopedProvider._(); + +final class AnotherNonEmptyScopedProvider + extends $FunctionalProvider + with $Provider { + const AnotherNonEmptyScopedProvider._( + {int Function( + AnotherNonEmptyScopedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'anotherNonEmptyScopedProvider', + isAutoDispose: true, + dependencies: const [anotherScopedProvider], + allTransitiveDependencies: const [ + AnotherNonEmptyScopedProvider.$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = anotherScopedProvider; + + final int Function( + AnotherNonEmptyScopedRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$anotherNonEmptyScopedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + AnotherNonEmptyScopedProvider $copyWithCreate( + int Function( + AnotherNonEmptyScopedRef ref, + ) create, + ) { + return AnotherNonEmptyScopedProvider._(create: create); + } + + @override + int create(AnotherNonEmptyScopedRef ref) { + final _$cb = _createCb ?? anotherNonEmptyScoped; + return _$cb(ref); + } +} + +String _$anotherNonEmptyScopedHash() => + r'cc21d248e644c853e4647ad60ca72cb42b82475f'; + +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.dart similarity index 77% rename from packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.dart rename to packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.dart index d7d9cedde..a1ba3a2bb 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.dart @@ -2,11 +2,14 @@ import 'package:flutter/widgets.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; -part 'provider_dependencies.g.dart'; +part 'missing_dependencies.g.dart'; @Riverpod(dependencies: []) int dep(DepRef ref) => 0; +@Riverpod(dependencies: [dep]) +int transitiveDep(TransitiveDepRef ref) => ref.watch(depProvider); + @Riverpod(dependencies: []) int dep2(Dep2Ref ref) => 0; @@ -33,6 +36,29 @@ class DepWidget extends StatelessWidget { } } +// expect_lint: provider_dependencies +@Dependencies([dep]) +class UnusedDepWidget extends ConsumerWidget { + const UnusedDepWidget({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + return const Placeholder(); + } +} + +@Dependencies([transitiveDep]) +class TransitiveDepWidget extends ConsumerWidget { + const TransitiveDepWidget({super.key, this.child}); + final Widget? child; + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.watch(transitiveDepProvider); + return const Placeholder(); + } +} + @Dependencies([depFamily]) class DepFamily extends StatelessWidget { const DepFamily({super.key, this.child}); @@ -153,6 +179,30 @@ class Scope4 extends ConsumerWidget { } } +class OnlyNeedToOverrideProviderWithEmptyDependencies extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return ProviderScope( + overrides: [ + depProvider.overrideWithValue(42), + ], + child: TransitiveDepWidget(), + ); + } +} + +class CanOverrideTransitiveProviderDirectly extends ConsumerWidget { + @override + Widget build(BuildContext context, WidgetRef ref) { + return ProviderScope( + overrides: [ + transitiveDepProvider.overrideWithValue(42), + ], + child: TransitiveDepWidget(), + ); + } +} + class SupportsMultipleScopes extends ConsumerWidget { @override Widget build(BuildContext context, WidgetRef ref) { @@ -223,3 +273,8 @@ class _NotFoundWidgetState extends ConsumerState { return const Placeholder(); } } + +/// Random doc to test that identifiers in docs don't trigger the lint. +/// [dep], [DepWidget], [depProvider] +@Riverpod(dependencies: []) +int providerWithDartDoc(ProviderWithDartDocRef ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart similarity index 78% rename from packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.g.dart rename to packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart index 0e6ea613a..50c27962b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/provider_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart @@ -1,6 +1,6 @@ // GENERATED CODE - DO NOT MODIFY BY HAND -part of 'provider_dependencies.dart'; +part of 'missing_dependencies.dart'; // ************************************************************************** // RiverpodGenerator @@ -65,6 +65,70 @@ final class DepProvider extends $FunctionalProvider String _$depHash() => r'749c4d696d29c72686cabcabd6fa7855f5cbf4db'; +typedef TransitiveDepRef = Ref; + +@ProviderFor(transitiveDep) +const transitiveDepProvider = TransitiveDepProvider._(); + +final class TransitiveDepProvider + extends $FunctionalProvider + with $Provider { + const TransitiveDepProvider._( + {int Function( + TransitiveDepRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'transitiveDepProvider', + isAutoDispose: true, + dependencies: const [depProvider], + allTransitiveDependencies: const [ + TransitiveDepProvider.$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + + final int Function( + TransitiveDepRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$transitiveDepHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + TransitiveDepProvider $copyWithCreate( + int Function( + TransitiveDepRef ref, + ) create, + ) { + return TransitiveDepProvider._(create: create); + } + + @override + int create(TransitiveDepRef ref) { + final _$cb = _createCb ?? transitiveDep; + return _$cb(ref); + } +} + +String _$transitiveDepHash() => r'3718ab2a36c91fb776740c6aeafc49db08bbffd5'; + typedef Dep2Ref = Ref; @ProviderFor(dep2) @@ -567,5 +631,74 @@ final class MultipleDepsProvider String _$multipleDepsHash() => r'9d08791636a0435ba115062a453d0d9e530ecf71'; +/// Random doc to test that identifiers in docs don't trigger the lint. +/// [dep], [DepWidget], [depProvider] +typedef ProviderWithDartDocRef = Ref; + +/// Random doc to test that identifiers in docs don't trigger the lint. +/// [dep], [DepWidget], [depProvider] +@ProviderFor(providerWithDartDoc) +const providerWithDartDocProvider = ProviderWithDartDocProvider._(); + +/// Random doc to test that identifiers in docs don't trigger the lint. +/// [dep], [DepWidget], [depProvider] +final class ProviderWithDartDocProvider + extends $FunctionalProvider + with $Provider { + /// Random doc to test that identifiers in docs don't trigger the lint. + /// [dep], [DepWidget], [depProvider] + const ProviderWithDartDocProvider._( + {int Function( + ProviderWithDartDocRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'providerWithDartDocProvider', + isAutoDispose: true, + dependencies: const [], + allTransitiveDependencies: const [], + ); + + final int Function( + ProviderWithDartDocRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$providerWithDartDocHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + ProviderWithDartDocProvider $copyWithCreate( + int Function( + ProviderWithDartDocRef ref, + ) create, + ) { + return ProviderWithDartDocProvider._(create: create); + } + + @override + int create(ProviderWithDartDocRef ref) { + final _$cb = _createCb ?? providerWithDartDoc; + return _$cb(ref); + } +} + +String _$providerWithDartDocHash() => + r'6aeff1697c1ec37f475319a4100e01c0e56369ae'; + // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart similarity index 95% rename from packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.dart rename to packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart index 59095cac9..e97f01b02 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart @@ -3,9 +3,10 @@ import 'package:flutter/material.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; -import '../another.dart' as import_alias; +import 'another.dart' as import_alias; +import 'another.dart'; -part 'dependencies.g.dart'; +part 'missing_dependencies2.g.dart'; @Riverpod(dependencies: []) int dep(DepRef ref) => 0; @@ -266,3 +267,10 @@ class _Stateful3State extends State { @override Widget build(BuildContext context) => WidgetDependencies(); } + +// expect_lint: provider_dependencies +@riverpod +int crossFileDependency(CrossFileDependencyRef ref) { + ref.watch(anotherNonEmptyScopedProvider); + return 0; +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart similarity index 96% rename from packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.g.dart rename to packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart index b10343a46..f6952e1e0 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/missing_provider_dependency/dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart @@ -1,6 +1,6 @@ // GENERATED CODE - DO NOT MODIFY BY HAND -part of 'dependencies.dart'; +part of 'missing_dependencies2.dart'; // ************************************************************************** // RiverpodGenerator @@ -1508,5 +1508,66 @@ final class FooProvider extends $FunctionalProvider String _$fooHash() => r'f9ce60fe868c2c54aa282702554861a13e8871cd'; +typedef CrossFileDependencyRef = Ref; + +@ProviderFor(crossFileDependency) +const crossFileDependencyProvider = CrossFileDependencyProvider._(); + +final class CrossFileDependencyProvider + extends $FunctionalProvider + with $Provider { + const CrossFileDependencyProvider._( + {int Function( + CrossFileDependencyRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + name: r'crossFileDependencyProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + CrossFileDependencyRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$crossFileDependencyHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement(ProviderContainer container) => + $ProviderElement(this, container); + + @override + CrossFileDependencyProvider $copyWithCreate( + int Function( + CrossFileDependencyRef ref, + ) create, + ) { + return CrossFileDependencyProvider._(create: create); + } + + @override + int create(CrossFileDependencyRef ref) { + final _$cb = _createCb ?? crossFileDependency; + return _$cb(ref); + } +} + +String _$crossFileDependencyHash() => + r'9ca6b69de674377c6906fb835cbe04d01851d088'; + // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main diff --git a/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.dart similarity index 98% rename from packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.dart rename to packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.dart index 5a7696954..650984ed0 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.dart @@ -3,7 +3,7 @@ import 'package:flutter/widgets.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; -part 'provider_dependencies.g.dart'; +part 'unused_dependency.g.dart'; @riverpod int root(RootRef ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart similarity index 99% rename from packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.g.dart rename to packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart index ffcd059a5..20ab24585 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart @@ -1,6 +1,6 @@ // GENERATED CODE - DO NOT MODIFY BY HAND -part of 'provider_dependencies.dart'; +part of 'unused_dependency.dart'; // ************************************************************************** // RiverpodGenerator diff --git a/packages/riverpod_lint_flutter_test/test/lints/riverpod_syntax_error/riverpod_syntax_error.dart b/packages/riverpod_lint_flutter_test/test/lints/riverpod_syntax_error.dart similarity index 100% rename from packages/riverpod_lint_flutter_test/test/lints/riverpod_syntax_error/riverpod_syntax_error.dart rename to packages/riverpod_lint_flutter_test/test/lints/riverpod_syntax_error.dart diff --git a/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies_test.dart b/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies_test.dart deleted file mode 100644 index 3b5e3ea55..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/unused_provider_dependency/provider_dependencies_test.dart +++ /dev/null @@ -1,27 +0,0 @@ -import 'package:collection/collection.dart'; -import 'package:riverpod_lint/src/lints/provider_dependencies.dart'; -import 'package:test/test.dart'; - -import '../../golden.dart'; - -void main() { - testGolden( - 'Assert that "dependencies" are used.', - 'lints/unused_provider_dependency/provider_dependencies.diff', - sourcePath: - 'test/lints/unused_provider_dependency/provider_dependencies.dart', - (result) async { - const lint = ProviderDependencies(); - final fix = lint.getFixes().single; - - final errors = await lint.testRun(result); - expect(errors, hasLength(10)); - - final changes = await Future.wait([ - for (final error in errors) fix.testRun(result, error, errors), - ]); - - return changes.flattened; - }, - ); -} diff --git a/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import_test.dart b/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import_test.dart deleted file mode 100644 index a97b1181f..000000000 --- a/packages/riverpod_lint_flutter_test/test/migration/missing_legacy_import/missing_legacy_import_test.dart +++ /dev/null @@ -1,25 +0,0 @@ -import 'package:collection/collection.dart'; -import 'package:riverpod_lint/src/migration/missing_legacy_import.dart'; - -import '../../golden.dart'; - -void main() { - testGolden( - 'Verify that `riverpod/legacy.dart` is correctly imported.', - 'migration/missing_legacy_import/missing_legacy_import.diff', - sourcePath: - 'test/migration/missing_legacy_import/missing_legacy_import.dart', - (result) async { - final lint = MissingLegacyImport(); - final fix = lint.getFixes().single; - - final errors = await lint.testRun(result); - - final changes = await Future.wait([ - for (final error in errors) fix.testRun(result, error, errors), - ]); - - return changes.flattened; - }, - ); -} diff --git a/packages/riverpod_lint_flutter_test/test/riverpod_test.dart b/packages/riverpod_lint_flutter_test/test/riverpod_test.dart new file mode 100644 index 000000000..415ad35d8 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/riverpod_test.dart @@ -0,0 +1,45 @@ +import 'dart:io'; + +import 'package:custom_lint_core/custom_lint_core.dart'; +import 'package:glob/glob.dart'; +import 'package:glob/list_local_fs.dart'; +import 'package:riverpod_lint/riverpod_lint.dart'; +import 'package:riverpod_lint/src/riverpod_custom_lint.dart'; +import 'package:test/test.dart'; + +import 'test_lint.dart'; + +void main() { + final plugin = createPlugin(); + + // ignore: invalid_use_of_internal_member + for (final lint in plugin.getLintRules(CustomLintConfigs.empty)) { + final code = lint.code; + lint as RiverpodLintRule; + + group(code.name, () { + final filesToTest = [ + File('test/lints/${code.name}.dart'), + ...Glob('test/lints/${code.name}/*.dart').listSync(), + ] + .whereType() + .where((e) => + !e.path.endsWith('_test.dart') && !e.path.endsWith('.g.dart')) + .where((e) => e.existsSync()) + .toList(); + + if (filesToTest.isEmpty) { + stderr.writeln('Missing test source for ${code.name}'); + } + + for (final file in filesToTest) { + testLint( + 'for ${file.path}', + file.path, + lint, + goldensDirectory: 'test/lints/goldens/${code.name}', + ); + } + }); + } +} diff --git a/packages/riverpod_lint_flutter_test/test/test_lint.dart b/packages/riverpod_lint_flutter_test/test/test_lint.dart new file mode 100644 index 000000000..feefe45ab --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/test_lint.dart @@ -0,0 +1,82 @@ +import 'dart:io'; + +import 'package:analyzer_plugin/protocol/protocol_generated.dart'; +import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:test/test.dart'; +import 'package:path/path.dart'; +import 'package:riverpod_lint/src/riverpod_custom_lint.dart'; +import 'package:analyzer/dart/analysis/results.dart'; +import 'package:analyzer/dart/analysis/utilities.dart'; +import 'package:collection/collection.dart'; + +import 'encoders.dart'; + +@isTest +void testLint( + String description, + String file, + RiverpodLintRule lint, { + required String goldensDirectory, +}) { + assert(file.endsWith('.dart')); + final fixesGoldenPath = join( + goldensDirectory, + '${basenameWithoutExtension(file)}_fix.diff', + ); + final lintGoldenPath = join( + goldensDirectory, + '${basenameWithoutExtension(file)}_lint.md', + ); + + test(description, () async { + final sourcePath = File(normalize(file)).absolute; + final result = await resolveFile2(path: sourcePath.path); + result as ResolvedUnitResult; + + final errors = await lint.testRun(result); + expect( + errors, + matchesAnalysisErrorGoldens(lintGoldenPath), + ); + + final fixes = await lint.getFixes(); + final changes = await Future.wait([ + for (final fix in fixes) + for (final error in errors) fix.testRun(result, error, errors), + ]); + + expect( + changes.flattened, + matchesPrioritizedSourceChangesGolden( + fixesGoldenPath, + source: result.content, + sourcePath: sourcePath.path, + ), + ); + }); +} + +@isTest +void testGolden( + String description, + String file, + Future> Function(ResolvedUnitResult) + testRun, { + required String sourcePath, +}) { + assert(sourcePath.endsWith('.dart')); + test(description, () async { + final absoluteSourcePath = File(normalize(sourcePath)).absolute; + final result = await resolveFile2(path: absoluteSourcePath.path); + result as ResolvedUnitResult; + + expect( + await testRun(result), + matchesPrioritizedSourceChangesGolden( + file, + source: result.content, + sourcePath: sourcePath, + ), + ); + }); +} From 8208451fe8d198bcae814377f4625375ae32c659 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 26 Feb 2024 16:48:30 +0100 Subject: [PATCH 234/387] AsyncValue.value now returns `null` on error --- packages/riverpod/CHANGELOG.md | 6 + .../riverpod/lib/src/core/async_value.dart | 107 +++++++----------- .../test/new/core/async_value_test.dart | 28 +---- 3 files changed, 48 insertions(+), 93 deletions(-) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 9000b1a58..71710d8a6 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -1,3 +1,9 @@ +## Unreleased build + +- **Breaking** `AsyncValue.value` now returns `null` during errors. +- **Breaking** removed `AsyncValue.valueOrNull` (use `.value` instead). +- Updated `AsyncValue` documentations to use pattern matching. + ## 3.0.0-dev.3 - 2023-11-27 - Fix "pending timer" issue inside tests when using `ref.keepAlive()`. diff --git a/packages/riverpod/lib/src/core/async_value.dart b/packages/riverpod/lib/src/core/async_value.dart index a712224c1..6b4b8bcec 100644 --- a/packages/riverpod/lib/src/core/async_value.dart +++ b/packages/riverpod/lib/src/core/async_value.dart @@ -40,10 +40,8 @@ extension AsyncTransition on ProviderElementBase> { /// By using [AsyncValue], you are guaranteed that you cannot forget to /// handle the loading/error state of an asynchronous operation. /// -/// It also exposes some utilities to nicely convert an [AsyncValue] to -/// a different object. -/// For example, a Flutter Widget may use [when] to convert an [AsyncValue] -/// into either a progress indicator, an error screen, or to show the data: +/// [AsyncValue] is a sealed class, and is designed to be used with +/// pattern matching to handle the different states: /// /// ```dart /// /// A provider that asynchronously exposes the current user @@ -56,30 +54,31 @@ extension AsyncTransition on ProviderElementBase> { /// Widget build(BuildContext context, WidgetRef ref) { /// final AsyncValue user = ref.watch(userProvider); /// -/// return user.when( -/// loading: () => CircularProgressIndicator(), -/// error: (error, stack) => Text('Oops, something unexpected happened'), -/// data: (user) => Text('Hello ${user.name}'), +/// return switch (user) { +/// AsyncValue(hasError: true) => Text('Oops, something unexpected happened'), +/// AsyncValue(:final value, hasValue: true) => Text('Hello ${value.name}'), +/// _ => CircularProgressIndicator(), /// ); /// } /// } /// ``` /// /// If a consumer of an [AsyncValue] does not care about the loading/error -/// state, consider using [value]/[valueOrNull] to read the state: +/// state, consider using [requireValue] to read the state: /// /// ```dart /// Widget build(BuildContext context, WidgetRef ref) { -/// // Reading .value will be throw during error and return null on "loading" states. -/// final User user = ref.watch(userProvider).value; -/// -/// // Reading .value will be throw both on loading and error states. -/// final User user2 = ref.watch(userProvider).requiredValue; +/// // Reading .requiredValue will be throw both on loading and error states. +/// final User user = ref.watch(userProvider).requiredValue; /// /// ... /// } /// ``` /// +/// By using [requireValue], we get an immediate access to the value. At the same +/// time, if we made a mistake and the value is not available, we will get an +/// exception. This is a good thing because it will help us to spot problem. +/// /// See also: /// /// - [FutureProvider], [StreamProvider] which transforms a [Future] into @@ -90,14 +89,14 @@ extension AsyncTransition on ProviderElementBase> { sealed class AsyncValue { const AsyncValue._(); - /// {@template asyncvalue.data} + /// {@template async_value.data} /// Creates an [AsyncValue] with a data. /// {@endtemplate} // coverage:ignore-start const factory AsyncValue.data(T value) = AsyncData; // coverage:ignore-end - /// {@template asyncvalue.loading} + /// {@template async_value.loading} /// Creates an [AsyncValue] in loading state. /// /// Prefer always using this constructor with the `const` keyword. @@ -106,7 +105,7 @@ sealed class AsyncValue { const factory AsyncValue.loading() = AsyncLoading; // coverage:ignore-end - /// {@template asyncvalue.error_ctor} + /// {@template async_value.error_ctor} /// Creates an [AsyncValue] in the error state. /// /// _I don't have a [StackTrace], what can I do?_ @@ -204,18 +203,15 @@ sealed class AsyncValue { /// The value currently exposed. /// - /// It will return the previous value during loading/error state. - /// If there is no previous value, reading [value] during loading state will - /// return null. While during error state, the error will be rethrown instead. + /// If currently in error/loading state, will return the previous value. + /// If there is no previous value available, `null` will be returned. /// /// If you do not want to return previous value during loading/error states, - /// consider using [unwrapPrevious] with [valueOrNull]: + /// consider using [unwrapPrevious]: /// /// ```dart - /// ref.watch(provider).unwrapPrevious().valueOrNull; + /// ref.watch(provider).unwrapPrevious().value; /// ``` - /// - /// This will return null during loading/error states. T? get value; /// The [error]. @@ -294,7 +290,7 @@ sealed class AsyncValue { other.hasValue == hasValue && other.error == error && other.stackTrace == stackTrace && - other.valueOrNull == valueOrNull; + other.value == value; } @override @@ -302,15 +298,15 @@ sealed class AsyncValue { runtimeType, isLoading, hasValue, - valueOrNull, + value, error, stackTrace, ); } -/// {@macro asyncvalue.data} +/// {@macro async_value.data} final class AsyncData extends AsyncValue { - /// {@macro asyncvalue.data} + /// {@macro async_value.data} const AsyncData(T value) : this._( value, @@ -374,9 +370,9 @@ final class AsyncData extends AsyncValue { } } -/// {@macro asyncvalue.loading} +/// {@macro async_value.loading} final class AsyncLoading extends AsyncValue { - /// {@macro asyncvalue.loading} + /// {@macro async_value.loading} const AsyncLoading() : hasValue = false, value = null, @@ -445,7 +441,7 @@ final class AsyncLoading extends AsyncValue { error: (e) => AsyncError._( e.error, isLoading: true, - value: e.valueOrNull, + value: e.value, stackTrace: e.stackTrace, hasValue: e.hasValue, ), @@ -455,13 +451,13 @@ final class AsyncLoading extends AsyncValue { return previous.map( data: (d) => AsyncLoading._( hasValue: true, - value: d.valueOrNull, + value: d.value, error: d.error, stackTrace: d.stackTrace, ), error: (e) => AsyncLoading._( hasValue: e.hasValue, - value: e.valueOrNull, + value: e.value, error: e.error, stackTrace: e.stackTrace, ), @@ -471,9 +467,9 @@ final class AsyncLoading extends AsyncValue { } } -/// {@macro asyncvalue.error_ctor} +/// {@macro async_value.error_ctor} final class AsyncError extends AsyncValue { - /// {@macro asyncvalue.error_ctor} + /// {@macro async_value.error_ctor} const AsyncError(Object error, StackTrace stackTrace) : this._( error, @@ -486,11 +482,10 @@ final class AsyncError extends AsyncValue { const AsyncError._( this.error, { required this.stackTrace, - required T? value, + required this.value, required this.hasValue, required this.isLoading, - }) : _value = value, - super._(); + }) : super._(); @override String get _displayString => 'AsyncError'; @@ -501,15 +496,8 @@ final class AsyncError extends AsyncValue { @override final bool hasValue; - final T? _value; - @override - T? get value { - if (!hasValue) { - throwErrorWithCombinedStackTrace(error, stackTrace); - } - return _value; - } + final T? value; @override final Object error; @@ -524,7 +512,7 @@ final class AsyncError extends AsyncValue { error, stackTrace: stackTrace, isLoading: isLoading, - value: _value as R?, + value: value as R?, hasValue: hasValue, ); } @@ -547,7 +535,7 @@ final class AsyncError extends AsyncValue { error, stackTrace: stackTrace, isLoading: isLoading, - value: previous.valueOrNull, + value: previous.value, hasValue: previous.hasValue, ); } @@ -571,23 +559,6 @@ extension AsyncValueX on AsyncValue { ); } - /// Return the value or previous value if in loading/error state. - /// - /// If there is no previous value, null will be returned during loading/error state. - /// - /// This is different from [value], which will rethrow the error instead of returning null. - /// - /// If you do not want to return previous value during loading/error states, - /// consider using [unwrapPrevious] : - /// - /// ```dart - /// ref.watch(provider).unwrapPrevious()?.valueOrNull; - /// ``` - T? get valueOrNull { - if (hasValue) return value; - return null; - } - /// Whether the associated provider was forced to recompute even though /// none of its dependencies has changed, after at least one [value]/[error] was emitted. /// @@ -682,7 +653,7 @@ extension AsyncValueX on AsyncValue { /// /// If [AsyncValue] was in a case that is not handled, will return [orElse]. /// - /// {@macro asyncvalue.skip_flags} + /// {@macro async_value.skip_flags} R maybeWhen({ bool skipLoadingOnReload = false, bool skipLoadingOnRefresh = true, @@ -706,7 +677,7 @@ extension AsyncValueX on AsyncValue { /// /// All cases are required, which allows returning a non-nullable value. /// - /// {@template asyncvalue.skip_flags} + /// {@template async_value.skip_flags} /// By default, [when] skips "loading" states if triggered by a [Ref.refresh] /// or [Ref.invalidate] (but does not skip loading states if triggered by [Ref.watch]). /// @@ -761,7 +732,7 @@ extension AsyncValueX on AsyncValue { /// Returns null if [AsyncValue] was in a state that was not handled. /// This is similar to [maybeWhen] where `orElse` returns null. /// - /// {@macro asyncvalue.skip_flags} + /// {@macro async_value.skip_flags} R? whenOrNull({ bool skipLoadingOnReload = false, bool skipLoadingOnRefresh = true, diff --git a/packages/riverpod/test/new/core/async_value_test.dart b/packages/riverpod/test/new/core/async_value_test.dart index 4fe7f586d..14c1aab0a 100644 --- a/packages/riverpod/test/new/core/async_value_test.dart +++ b/packages/riverpod/test/new/core/async_value_test.dart @@ -202,7 +202,7 @@ void main() { expect(value.isLoading, true); expect(value.isRefreshing, true); expect(value.hasValue, false); - expect(() => value.value, throwsA('err')); + expect(value.value, null); expect(value.error, 'err'); expect(value.stackTrace, StackTrace.empty); }); @@ -1504,8 +1504,8 @@ void main() { null, ); expect( - () => const AsyncError('err', StackTrace.empty).value, - throwsA('err'), + const AsyncError('err', StackTrace.empty).value, + null, ); expect( @@ -1520,28 +1520,6 @@ void main() { ); }); - test('AsyncValue.valueOrNull', () { - expect(const AsyncValue.data(42).valueOrNull, 42); - expect( - const AsyncLoading().valueOrNull, - null, - ); - expect(const AsyncError('err', StackTrace.empty).valueOrNull, null); - - expect( - const AsyncError('err', StackTrace.empty) - .copyWithPrevious(const AsyncData(42)) - .valueOrNull, - 42, - ); - expect( - const AsyncLoading() - .copyWithPrevious(const AsyncData(42)) - .valueOrNull, - 42, - ); - }); - test('AsyncValue.guard emits the data when the created future completes', () async { await expectLater( From 3f76c4f62d63979073b747b0ac1cf5b5edd88314 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 26 Feb 2024 17:49:55 +0100 Subject: [PATCH 235/387] Add interface that can be applied on al notifiers --- packages/riverpod/lib/riverpod.dart | 1 - packages/riverpod/lib/src/core/family.dart | 2 +- .../lib/src/core/modifiers/future.dart | 2 +- .../src/core/provider/notifier_provider.dart | 39 +++++++++++---- .../lib/src/providers/async_notifier.dart | 2 +- .../riverpod/lib/src/providers/notifier.dart | 2 +- .../lib/src/providers/stream_notifier.dart | 2 +- .../test/new/matrix/notifier_mixin.dart | 48 +++++++++++++++++++ .../lib/riverpod_annotation.dart | 2 +- .../test/integration/sync.dart | 14 ++++-- 10 files changed, 93 insertions(+), 21 deletions(-) create mode 100644 packages/riverpod/test/new/matrix/notifier_mixin.dart diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 9ccd53780..f62c546ff 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -33,7 +33,6 @@ export 'src/framework.dart' ProviderElementBase, ClassBaseX, CancelAsyncSubscription, - $ClassBase, FutureModifierElement, RunNotifierBuild, $FunctionalProvider, diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index 239d08303..59266e82f 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -146,7 +146,7 @@ class FunctionalFamily< // /// This API is not meant for public consumption. @internal class ClassFamily< // - NotifierT extends $ClassBase< // + NotifierT extends NotifierBase< // StateT, CreatedT>, StateT, diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 77b7c9dbf..067f350df 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -7,7 +7,7 @@ typedef CancelAsyncSubscription = void Function(); /// Implementation detail of `riverpod_generator`. /// Do not use. mixin $AsyncClassModifier - on $ClassBase, CreatedT> { + on NotifierBase, CreatedT> { /// The value currently exposed by this [AsyncNotifier]. /// /// Defaults to [AsyncLoading] inside the [AsyncNotifier.build] method. diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index f30cce02a..efe5e0a40 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -30,10 +30,32 @@ typedef RunNotifierBuild< // RefT extends Ref> = CreatedT Function(RefT ref, NotifierT notifier); -/// Implementation detail of `riverpod_generator`. -/// Do not use. -abstract class $ClassBase { - ClassProviderElement<$ClassBase, StateT, CreatedT>? +/// A base class for all "notifiers". +/// +/// - [StateT] is the type of [state]. +/// - [CreatedT] is the type of the value returned by the notifier's `build` method. +/// +/// This is a good interface to target for writing mixins for Notifiers. +/// +/// To perform logic before/after the `build` method of a notifier, you can override +/// [runBuild]: +/// +/// ```dart +/// mixin MyMixin extends NotifierBase> { +/// @override +/// FutureOr runBuild() { +/// // It is safe to use "ref" here. +/// ref.listenSelf((prev, next) => print("New state $next")); +/// +/// // Before +/// final result = super.runBuild(); +/// // After +/// return result; +/// } +/// } +/// ``` +abstract class NotifierBase { + ClassProviderElement, StateT, CreatedT>? _element; // TODO docs @@ -64,7 +86,6 @@ abstract class $ClassBase { element.state = newState; } - @internal CreatedT runBuild(); @visibleForOverriding @@ -72,15 +93,15 @@ abstract class $ClassBase { } @internal -extension ClassBaseX on $ClassBase { - ClassProviderElement<$ClassBase, StateT, CreatedT>? +extension ClassBaseX on NotifierBase { + ClassProviderElement, StateT, CreatedT>? get element => _element; } /// Implementation detail of `riverpod_generator`. /// Do not use. abstract base class $ClassProvider< // - NotifierT extends $ClassBase< // + NotifierT extends NotifierBase< // StateT, CreatedT>, StateT, @@ -151,7 +172,7 @@ abstract base class $ClassProvider< // @internal abstract class ClassProviderElement< // - NotifierT extends $ClassBase< // + NotifierT extends NotifierBase< // StateT, CreatedT>, StateT, diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index b04df5a87..ad3c87820 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -13,7 +13,7 @@ part 'async_notifier/family.dart'; /// Implementation detail of `riverpod_generator`. /// Do not use. -abstract class $AsyncNotifier extends $ClassBase< // +abstract class $AsyncNotifier extends NotifierBase< // AsyncValue, FutureOr> // with diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index 66c728262..c6a51e466 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -10,7 +10,7 @@ part 'notifier/family.dart'; /// A base class for [$Notifier]. /// Not meant for public consumption. -abstract class $Notifier extends $ClassBase { +abstract class $Notifier extends NotifierBase { /// The value currently exposed by this [Notifier]. /// /// If used inside [Notifier.build], may throw if the notifier is not yet initialized. diff --git a/packages/riverpod/lib/src/providers/stream_notifier.dart b/packages/riverpod/lib/src/providers/stream_notifier.dart index f3dc1f542..5375b65b2 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier.dart @@ -14,7 +14,7 @@ part 'stream_notifier/orphan.dart'; /// Implementation detail of `riverpod_generator`. /// Do not use. -abstract class $StreamNotifier extends $ClassBase< // +abstract class $StreamNotifier extends NotifierBase< // AsyncValue, Stream> // with diff --git a/packages/riverpod/test/new/matrix/notifier_mixin.dart b/packages/riverpod/test/new/matrix/notifier_mixin.dart new file mode 100644 index 000000000..e54813854 --- /dev/null +++ b/packages/riverpod/test/new/matrix/notifier_mixin.dart @@ -0,0 +1,48 @@ +// This is a file testing that mixins can be applied on notifiers. +// No need to run anything, just checking that it compiles. + +import 'dart:async'; + +import 'package:riverpod/riverpod.dart'; + +mixin MyMixin on NotifierBase { + @override + // ignore: unnecessary_overrides + B runBuild() { + return super.runBuild(); + } +} + +class Sync extends Notifier with MyMixin { + @override + int build() => 42; +} + +class SyncFamily extends FamilyNotifier with MyMixin { + @override + int build(int arg) => 42; +} + +class Async extends AsyncNotifier + with MyMixin, FutureOr> { + @override + FutureOr build() => Future.value(42); +} + +class AsyncFamily extends FamilyAsyncNotifier + with MyMixin, FutureOr> { + @override + FutureOr build(int arg) => Future.value(42); +} + +class StreamN extends StreamNotifier + with MyMixin, Stream> { + @override + Stream build() => Stream.value(42); +} + +class StreamFamily extends FamilyStreamNotifier + with MyMixin, Stream> { + @override + Stream build(int arg) => Stream.value(42); +} diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index 364260ddb..03476de4d 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -15,7 +15,7 @@ export 'package:riverpod/src/internals.dart' $FamilyOverride, $FunctionalProvider, $FutureModifier, - $ClassBase, + NotifierBase, $AsyncClassModifier, $ClassProvider, Ref, diff --git a/packages/riverpod_generator/test/integration/sync.dart b/packages/riverpod_generator/test/integration/sync.dart index 4357dbad1..e828a8cee 100644 --- a/packages/riverpod_generator/test/integration/sync.dart +++ b/packages/riverpod_generator/test/integration/sync.dart @@ -22,7 +22,8 @@ List complexGeneric( } @riverpod -class GenericClass extends _$GenericClass { +class GenericClass extends _$GenericClass + with MyMixin, List> { @override List build() { return []; @@ -112,9 +113,11 @@ String _private(_PrivateRef ref) { return 'Hello world'; } +mixin MyMixin on r.NotifierBase {} + /// This is some documentation @riverpod -class PublicClass extends _$PublicClass { +class PublicClass extends _$PublicClass with MyMixin { PublicClass([this.param]); final Object? param; @@ -128,7 +131,7 @@ class PublicClass extends _$PublicClass { const privateClassProvider = _privateClassProvider; @riverpod -class _PrivateClass extends _$PrivateClass { +class _PrivateClass extends _$PrivateClass with MyMixin { @override String build() { return 'Hello world'; @@ -137,7 +140,7 @@ class _PrivateClass extends _$PrivateClass { /// This is some documentation @riverpod -class FamilyClass extends _$FamilyClass { +class FamilyClass extends _$FamilyClass with MyMixin { FamilyClass([this.param]); final Object? param; @@ -172,7 +175,8 @@ String supports$InFnNameFamily( } @riverpod -class Supports$InClassName extends _$Supports$InClassName { +class Supports$InClassName extends _$Supports$InClassName + with MyMixin { @override String build() { return 'Hello world'; From e24c2b8817a6441929ed0025830601ea52ae12cc Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 26 Feb 2024 17:51:23 +0100 Subject: [PATCH 236/387] Fix valueOrNull usage --- examples/pub/lib/detail.dart | 2 +- website/docs/case_studies/cancel/detail_screen/codegen.dart | 2 +- website/docs/case_studies/cancel/detail_screen/raw.dart | 2 +- .../docs/case_studies/pull_to_refresh/display_activity.dart | 2 +- .../docs/case_studies/pull_to_refresh/display_activity2.dart | 2 +- .../docs/case_studies/pull_to_refresh/display_activity3.dart | 2 +- .../docs/case_studies/pull_to_refresh/display_activity4.dart | 3 +-- .../docs/case_studies/pull_to_refresh/full_app/codegen.dart | 3 +-- website/docs/case_studies/pull_to_refresh/full_app/raw.dart | 3 +-- .../essentials/passing_args/raw/multiple_consumer_family.dart | 4 ++-- .../essentials/websockets_sync/stream_provider/codegen.dart | 2 +- .../docs/essentials/websockets_sync/stream_provider/raw.dart | 2 +- 12 files changed, 13 insertions(+), 16 deletions(-) diff --git a/examples/pub/lib/detail.dart b/examples/pub/lib/detail.dart index 7dfa523cd..b824c88b6 100644 --- a/examples/pub/lib/detail.dart +++ b/examples/pub/lib/detail.dart @@ -105,7 +105,7 @@ class PackageDetailPage extends ConsumerWidget { ref.watch(fetchPackageDetailsProvider(packageName: packageName)); final likedPackages = ref.watch(likedPackagesProvider); - final isLiked = likedPackages.valueOrNull?.contains(packageName) ?? false; + final isLiked = likedPackages.value?.contains(packageName) ?? false; final metrics = ref.watch(packageMetricsProvider(packageName: packageName)); diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.dart b/website/docs/case_studies/cancel/detail_screen/codegen.dart index e3bf193a2..1941e884c 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.dart @@ -49,7 +49,7 @@ class DetailPageView extends ConsumerWidget { child: ListView( children: [ switch (activity) { - AsyncValue(:final valueOrNull?) => Text(valueOrNull.activity), + AsyncValue(:final value?) => Text(value.activity), AsyncValue(:final error?) => Text('Error: $error'), _ => const Center(child: CircularProgressIndicator()), }, diff --git a/website/docs/case_studies/cancel/detail_screen/raw.dart b/website/docs/case_studies/cancel/detail_screen/raw.dart index b3ad1faaf..46c76ff89 100644 --- a/website/docs/case_studies/cancel/detail_screen/raw.dart +++ b/website/docs/case_studies/cancel/detail_screen/raw.dart @@ -53,7 +53,7 @@ class DetailPageView extends ConsumerWidget { child: ListView( children: [ switch (activity) { - AsyncValue(:final valueOrNull?) => Text(valueOrNull.activity), + AsyncValue(:final value?) => Text(value.activity), AsyncValue(:final error?) => Text('Error: $error'), _ => const Center(child: CircularProgressIndicator()), }, diff --git a/website/docs/case_studies/pull_to_refresh/display_activity.dart b/website/docs/case_studies/pull_to_refresh/display_activity.dart index bb17883bf..a4ac36239 100644 --- a/website/docs/case_studies/pull_to_refresh/display_activity.dart +++ b/website/docs/case_studies/pull_to_refresh/display_activity.dart @@ -15,7 +15,7 @@ class ActivityView extends ConsumerWidget { appBar: AppBar(title: const Text('Pull to refresh')), body: Center( // If we have an activity, display it, otherwise wait - child: Text(activity.valueOrNull?.activity ?? ''), + child: Text(activity.value?.activity ?? ''), ), ); } diff --git a/website/docs/case_studies/pull_to_refresh/display_activity2.dart b/website/docs/case_studies/pull_to_refresh/display_activity2.dart index 7394ea664..9a1673bdd 100644 --- a/website/docs/case_studies/pull_to_refresh/display_activity2.dart +++ b/website/docs/case_studies/pull_to_refresh/display_activity2.dart @@ -19,7 +19,7 @@ class ActivityView extends ConsumerWidget { child: ListView( children: [ /* highlight-end */ - Text(activity.valueOrNull?.activity ?? ''), + Text(activity.value?.activity ?? ''), ], ), ), diff --git a/website/docs/case_studies/pull_to_refresh/display_activity3.dart b/website/docs/case_studies/pull_to_refresh/display_activity3.dart index e847da8b5..717143e6c 100644 --- a/website/docs/case_studies/pull_to_refresh/display_activity3.dart +++ b/website/docs/case_studies/pull_to_refresh/display_activity3.dart @@ -22,7 +22,7 @@ class ActivityView extends ConsumerWidget { /* highlight-end */ child: ListView( children: [ - Text(activity.valueOrNull?.activity ?? ''), + Text(activity.value?.activity ?? ''), ], ), ), diff --git a/website/docs/case_studies/pull_to_refresh/display_activity4.dart b/website/docs/case_studies/pull_to_refresh/display_activity4.dart index dbd590a41..7b94557f3 100644 --- a/website/docs/case_studies/pull_to_refresh/display_activity4.dart +++ b/website/docs/case_studies/pull_to_refresh/display_activity4.dart @@ -21,8 +21,7 @@ class ActivityView extends ConsumerWidget { switch (activity) { // If some data is available, we display it. // Note that data will still be available during a refresh. - AsyncValue(:final valueOrNull?) => - Text(valueOrNull.activity), + AsyncValue(:final value?) => Text(value.activity), // An error is available, so we render it. AsyncValue(:final error?) => Text('Error: $error'), // No data/error, so we're in loading state. diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.dart index b7d53c744..837a4b2d7 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.dart @@ -33,8 +33,7 @@ class ActivityView extends ConsumerWidget { child: ListView( children: [ switch (activity) { - AsyncValue(:final valueOrNull?) => - Text(valueOrNull.activity), + AsyncValue(:final value?) => Text(value.activity), AsyncValue(:final error?) => Text('Error: $error'), _ => const CircularProgressIndicator(), }, diff --git a/website/docs/case_studies/pull_to_refresh/full_app/raw.dart b/website/docs/case_studies/pull_to_refresh/full_app/raw.dart index c4186fb31..491e8295e 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/raw.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/raw.dart @@ -28,8 +28,7 @@ class ActivityView extends ConsumerWidget { child: ListView( children: [ switch (activity) { - AsyncValue(:final valueOrNull?) => - Text(valueOrNull.activity), + AsyncValue(:final value?) => Text(value.activity), AsyncValue(:final error?) => Text('Error: $error'), _ => const CircularProgressIndicator(), }, diff --git a/website/docs/essentials/passing_args/raw/multiple_consumer_family.dart b/website/docs/essentials/passing_args/raw/multiple_consumer_family.dart index 673f77a61..53ba9b9e8 100644 --- a/website/docs/essentials/passing_args/raw/multiple_consumer_family.dart +++ b/website/docs/essentials/passing_args/raw/multiple_consumer_family.dart @@ -26,8 +26,8 @@ class Example extends ConsumerWidget { // Both requests will happen in parallel and correctly be cached. return Column( children: [ - Text(recreational.valueOrNull?.activity ?? ''), - Text(cooking.valueOrNull?.activity ?? ''), + Text(recreational.value?.activity ?? ''), + Text(cooking.value?.activity ?? ''), ], ); }, diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.dart index 214276260..094dc18a3 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.dart @@ -26,7 +26,7 @@ class Consumer extends ConsumerWidget { // We can use the AsyncValue to handle loading/error states and show the data. return switch (value) { AsyncValue(:final error?) => Text('Error: $error'), - AsyncValue(:final valueOrNull?) => Text('$valueOrNull'), + AsyncValue(:final value?) => Text('$value'), _ => const CircularProgressIndicator(), }; } diff --git a/website/docs/essentials/websockets_sync/stream_provider/raw.dart b/website/docs/essentials/websockets_sync/stream_provider/raw.dart index f3dcda2fe..0e575c750 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/raw.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/raw.dart @@ -22,7 +22,7 @@ class Consumer extends ConsumerWidget { // We can use the AsyncValue to handle loading/error states and show the data. return switch (value) { AsyncValue(:final error?) => Text('Error: $error'), - AsyncValue(:final valueOrNull?) => Text('$valueOrNull'), + AsyncValue(:final value?) => Text('$value'), _ => const CircularProgressIndicator(), }; } From e3be446bc00776f8f6563f87fc076c2d3b25c1d9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 26 Feb 2024 17:59:26 +0100 Subject: [PATCH 237/387] Increase timeout --- .../test/ref_invocation_test.dart | 26 ++++++++++++------- .../test/widget_ref_invocation_test.dart | 26 ++++++++++++------- 2 files changed, 34 insertions(+), 18 deletions(-) diff --git a/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart b/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart index 835bf0c1b..36cf64bab 100644 --- a/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart @@ -21,6 +21,7 @@ extension on RiverpodAnalysisResult { void main() { testSource( 'Parses import aliases', + timeout: const Timeout.factor(4), runGenerator: true, files: { 'file.dart': ''' @@ -61,7 +62,8 @@ int aliased(AliasedRef ref) { }, ); - testSource('Decode watch expressions with syntax errors', source: ''' + testSource('Decode watch expressions with syntax errors', + timeout: const Timeout.factor(4), source: ''' import 'package:riverpod/riverpod.dart'; @ProviderFor(gibberish) @@ -90,7 +92,7 @@ final dependency = Provider((ref) { }); testSource('Decodes ref expressions in Notifier methods', - runGenerator: true, source: r''' + timeout: const Timeout.factor(4), runGenerator: true, source: r''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; @@ -128,7 +130,8 @@ class MyNotifier extends _$MyNotifier { ); }); - testSource('Decodes ..watch', runGenerator: true, source: r''' + testSource('Decodes ..watch', + timeout: const Timeout.factor(4), runGenerator: true, source: r''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; @@ -223,7 +226,8 @@ final provider = Provider((ref) { expect(result.refWatchInvocations[2].listenable.familyArguments, null); }); - testSource('Decodes simple ref.watch usages', runGenerator: true, source: r''' + testSource('Decodes simple ref.watch usages', + timeout: const Timeout.factor(4), runGenerator: true, source: r''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; @@ -328,7 +332,8 @@ void fn(_Ref ref) { expect(result.refWatchInvocations[2].listenable.familyArguments, null); }); - testSource('Decodes ref.listen usages', runGenerator: true, source: ''' + testSource('Decodes ref.listen usages', + timeout: const Timeout.factor(4), runGenerator: true, source: ''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; @@ -392,7 +397,8 @@ final provider = Provider((ref) { ); }); - testSource('Decodes ref.read usages', runGenerator: true, source: ''' + testSource('Decodes ref.read usages', + timeout: const Timeout.factor(4), runGenerator: true, source: ''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; @@ -430,7 +436,8 @@ final provider = Provider((ref) { ); }); - testSource('Decodes unknown ref usages', source: ''' + testSource('Decodes unknown ref usages', + timeout: const Timeout.factor(4), source: ''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; @@ -465,7 +472,8 @@ void fn(Ref ref) { ); }); - testSource('Decodes family ref.watch usages', runGenerator: true, source: r''' + testSource('Decodes family ref.watch usages', + timeout: const Timeout.factor(4), runGenerator: true, source: r''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; @@ -585,7 +593,7 @@ void fn(_Ref ref) { }); testSource('Decodes provider.query ref.watch usages', - runGenerator: true, source: r''' + timeout: const Timeout.factor(4), runGenerator: true, source: r''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart b/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart index 808ec790b..041a421b6 100644 --- a/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart @@ -23,7 +23,8 @@ extension on RiverpodAnalysisResult { } void main() { - testSource('Decode watch expressions with syntax errors', source: ''' + testSource('Decode watch expressions with syntax errors', + timeout: const Timeout.factor(4), source: ''' import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter/material.dart'; @@ -60,7 +61,8 @@ class Example extends ConsumerWidget { expect(result.widgetRefWatchInvocations.single.listenable.provider, isNull); }); - testSource('Decodes ..watch', runGenerator: true, source: r''' + testSource('Decodes ..watch', + timeout: const Timeout.factor(4), runGenerator: true, source: r''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; @@ -173,7 +175,8 @@ class MyWidget extends ConsumerWidget { ); }); - testSource('Decodes simple ref.watch usages', runGenerator: true, source: r''' + testSource('Decodes simple ref.watch usages', + timeout: const Timeout.factor(4), runGenerator: true, source: r''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; @@ -297,7 +300,8 @@ void fn(_Ref ref) { ); }); - testSource('Decodes unknown ref usages', source: ''' + testSource('Decodes unknown ref usages', + timeout: const Timeout.factor(4), source: ''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; @@ -339,7 +343,8 @@ void fn(WidgetRef ref) { ); }); - testSource('Decodes ref.listen usages', runGenerator: true, source: ''' + testSource('Decodes ref.listen usages', + timeout: const Timeout.factor(4), runGenerator: true, source: ''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; @@ -379,7 +384,8 @@ class MyWidget extends ConsumerWidget { ); }); - testSource('Decodes ref.listenManual usages', runGenerator: true, source: ''' + testSource('Decodes ref.listenManual usages', + timeout: const Timeout.factor(4), runGenerator: true, source: ''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; @@ -464,7 +470,8 @@ class MyWidget extends ConsumerWidget { ); }); - testSource('Decodes ref.read usages', runGenerator: true, source: ''' + testSource('Decodes ref.read usages', + timeout: const Timeout.factor(4), runGenerator: true, source: ''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; @@ -513,7 +520,8 @@ class MyWidget extends ConsumerWidget { ); }); - testSource('Decodes family ref.watch usages', runGenerator: true, source: r''' + testSource('Decodes family ref.watch usages', + timeout: const Timeout.factor(4), runGenerator: true, source: r''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; @@ -645,7 +653,7 @@ void fn(_Ref ref) { }); testSource('Decodes provider.query ref.watch usages', - runGenerator: true, source: r''' + timeout: const Timeout.factor(4), runGenerator: true, source: r''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; From 91ba8b299fba24a374a903f59d3b91b8a5b9cf8e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 26 Feb 2024 18:01:26 +0100 Subject: [PATCH 238/387] Update codegen --- .../riverpod_generator/test/integration/sync.g.dart | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index d94bf4b16..4c7a4477a 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -401,7 +401,7 @@ final class GenericClassProvider } } -String _$genericClassHash() => r'671e348a5abf8e00ab06c5f247defbca8af9677b'; +String _$genericClassHash() => r'42ec5a5635796c0d597f0c9dac28ec2f61a486ff'; final class GenericClassFamily extends Family { const GenericClassFamily._() @@ -1751,7 +1751,7 @@ final class PublicClassProvider extends $NotifierProvider { $NotifierProviderElement(this, container); } -String _$publicClassHash() => r'c8e7eec9e202acf8394e02496857cbe49405bf62'; +String _$publicClassHash() => r'd261f9eb927ca71440a5e1bdb24558c25fae4833'; abstract class _$PublicClass extends $Notifier { String build(); @@ -1820,7 +1820,7 @@ final class _PrivateClassProvider $NotifierProviderElement(this, container); } -String _$privateClassHash() => r'6d41def3ffdc1f79e593beaefb3304ce4b211a77'; +String _$privateClassHash() => r'796e16abb79d7ad77728f9288d24566e429643f2'; abstract class _$PrivateClass extends $Notifier { String build(); @@ -1934,7 +1934,7 @@ final class FamilyClassProvider extends $NotifierProvider { } } -String _$familyClassHash() => r'01e3b9cb4d6d0bf12a2284761b1a11819d97d249'; +String _$familyClassHash() => r'ac5aba6b9cbee66236d6e1fa3d18b9b6ffb2c5f1'; /// This is some documentation final class FamilyClassFamily extends Family { @@ -2484,7 +2484,7 @@ final class Supports$InClassNameProvider } String _$supports$InClassNameHash() => - r'9eeab74a85af26136dd698df79669df4cec4c42b'; + r'848e57774639582ed170dce5765340e1c1cb89b3'; final class Supports$InClassNameFamily extends Family { const Supports$InClassNameFamily._() From 6c2d0fbeb7ca15a7c7ff45d6b5698f3f78263909 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 28 Feb 2024 11:31:36 +0100 Subject: [PATCH 239/387] Update docs a bit --- .../lib/flutter_riverpod.dart | 3 +- .../lib/src/core/consumer.dart | 298 +++++++++++------- packages/hooks_riverpod/lib/src/consumer.dart | 11 +- 3 files changed, 199 insertions(+), 113 deletions(-) diff --git a/packages/flutter_riverpod/lib/flutter_riverpod.dart b/packages/flutter_riverpod/lib/flutter_riverpod.dart index 956e6d2dc..85492dde9 100644 --- a/packages/flutter_riverpod/lib/flutter_riverpod.dart +++ b/packages/flutter_riverpod/lib/flutter_riverpod.dart @@ -1,5 +1,6 @@ export 'package:riverpod/riverpod.dart'; -export 'src/core.dart' hide ProviderScopeState; +export 'src/core.dart' + hide ProviderScopeState, ConsumerBuilder, ConsumerStatefulElement; // TODO changelog breaking: StateNotifier & co are no-longer exported from pkg:riverpod/riverpod.dart // Use pkg:riverpod/legacy.dart diff --git a/packages/flutter_riverpod/lib/src/core/consumer.dart b/packages/flutter_riverpod/lib/src/core/consumer.dart index dcf8e2085..4740b95fd 100644 --- a/packages/flutter_riverpod/lib/src/core/consumer.dart +++ b/packages/flutter_riverpod/lib/src/core/consumer.dart @@ -3,6 +3,8 @@ part of '../core.dart'; /// A function that can also listen to providers /// /// See also [Consumer] +// TODO changelog breaking unexported +@internal typedef ConsumerBuilder = Widget Function( BuildContext context, WidgetRef ref, @@ -12,110 +14,58 @@ typedef ConsumerBuilder = Widget Function( /// {@template riverpod.consumer} /// Build a widget tree while listening to providers. /// -/// [Consumer] can be used to listen to providers inside a [StatefulWidget] -/// or to rebuild as few widgets as possible when a provider updates. +/// [Consumer]'s main use-case is for reducing the number of rebuilt widgets. +/// when a provider changes. /// /// As an example, consider: /// /// ```dart -/// final helloWorldProvider = Provider((_) => 'Hello world'); +/// @riverpod +/// Future fetchUser(FetchUserRef ref) async { +/// // ... +/// } /// ``` /// -/// We can then use [Consumer] to listen to `helloWorldProvider` inside a -/// [StatefulWidget] like so: +/// Normally, we would use a [ConsumerWidget] as followed: /// /// ```dart -/// class Example extends StatefulWidget { -/// @override -/// _ExampleState createState() => _ExampleState(); -/// } -/// -/// class _ExampleState extends State { +/// class Example extends ConsumerWidget { /// @override -/// Widget build(BuildContext context) { -/// return Consumer( -/// builder: (context, ref, child) { -/// final value = ref.watch(helloWorldProvider); -/// return Text(value); // Hello world -/// }, -/// ); +/// Widget build(BuildContext context, WidgetRef ref) { +/// return Scaffold( +/// appBar: AppBar(title: Text('User')), +/// body: switch (ref.watch(userProvider) { +/// AsyncValue(:final value?) => Text(value.name), +/// AsyncValue(hasError: true) => Text('Error'), +/// _ => CircularProgressIndicator(), +/// }, /// } /// } /// ``` /// -/// **Note** -/// You can watch as many providers inside [Consumer] as you want to: -/// -/// ```dart -/// Consumer( -/// builder: (context, ref, child) { -/// final value = ref.watch(someProvider); -/// final another = ref.watch(anotherProvider); -/// ... -/// }, -/// ); -/// ``` -/// -/// ## Performance optimizations -/// -/// If your `builder` function contains a subtree that does not depend on the -/// animation, it is more efficient to build that subtree once instead of -/// rebuilding it on every provider update. -/// -/// If you pass the pre-built subtree as the `child` parameter, the -/// Consumer will pass it back to your builder function so that you -/// can incorporate it into your build. -/// -/// Using this pre-built child is entirely optional, but can improve -/// performance significantly in some cases and is therefore a good practice. -/// -/// This sample shows how you could use a [Consumer] +/// However, this would rebuild the entire `Scaffold` when the user changes. +/// If we are looking to reduce this, have two options: +/// - Extract the `body` into a separate [ConsumerWidget]. Then only the `body` will rebuild. +/// This is the recommended approach, but is a bit more verbose. +/// - Use [Consumer] to only rebuild the `body` when the user changes. +/// This is less recommended, but avoids creating a new widget. /// +/// Using [Consumer], the resulting code would look like: /// ```dart -/// final counterProvider = StateProvider((ref) => 0); -/// -/// class MyHomePage extends ConsumerWidget { -/// MyHomePage({Key? key, required this.title}) : super(key: key); -/// final String title; -/// +/// class Example extends StatelessWidget { /// @override -/// Widget build(BuildContext context, WidgetRef ref) { +/// Widget build(BuildContext context) { /// return Scaffold( -/// appBar: AppBar( -/// title: Text(title) -/// ), -/// body: Center( -/// child: Column( -/// mainAxisAlignment: MainAxisAlignment.center, -/// children: [ -/// Text('You have pushed the button this many times:'), -/// Consumer( -/// builder: (BuildContext context, WidgetRef ref, Widget? child) { -/// // This builder will only get called when the counterProvider -/// // is updated. -/// final count = ref.watch(counterProvider); -/// -/// return Row( -/// mainAxisAlignment: MainAxisAlignment.spaceEvenly, -/// children: [ -/// Text('$count'), -/// child!, -/// ], -/// ); -/// }, -/// // The child parameter is most helpful if the child is -/// // expensive to build and does not depend on the value from -/// // the notifier. -/// child: Text('Good job!'), -/// ) -/// ], -/// ), -/// ), -/// floatingActionButton: FloatingActionButton( -/// child: Icon(Icons.plus_one), -/// onPressed: () => ref.read(counterProvider.notifier).state++, -/// ), -/// ); +/// appBar: AppBar(title: Text('User')), +/// body: Consumer( +/// builder: (context, ref, child) { +/// return switch (ref.watch(userProvider) { +/// AsyncValue(:final value?) => Text(value.name), +/// AsyncValue(hasError: true) => Text('Error'), +/// _ => CircularProgressIndicator(), +/// }; +/// }), +/// ); /// } /// } /// ``` @@ -127,21 +77,101 @@ typedef ConsumerBuilder = Widget Function( @sealed class Consumer extends ConsumerWidget { /// {@macro riverpod.consumer} - const Consumer({super.key, required ConsumerBuilder builder, Widget? child}) - : _child = child, - _builder = builder; + const Consumer({super.key, required this.builder, this.child}); + + /// The builder that will be called when the provider is updated. + /// + /// The `child` parameter will be the same as [child] if specified, or null otherwise. + /// + /// **Note** + /// You can watch as many providers inside [Consumer] as you want to: + /// ```dart + /// Consumer( + /// builder: (context, ref, child) { + /// final value = ref.watch(someProvider); + /// final another = ref.watch(anotherProvider); + /// ... + /// }, + /// ); + /// ``` + /// + /// See also [child]. + final ConsumerBuilder builder; - final ConsumerBuilder _builder; - final Widget? _child; + /// The [child] parameter is an optional parameter for the sole purpose of + /// further performance optimizations. + /// + /// If your `builder` function contains a subtree that does not depend on the + /// animation, it is more efficient to build that subtree once instead of + /// rebuilding it on every provider update. + /// + /// If you pass the pre-built subtree as the `child` parameter, the + /// Consumer will pass it back to your builder function so that you + /// can incorporate it into your build. + /// + /// Using this pre-built child is entirely optional, but can improve + /// performance significantly in some cases and is therefore a good practice. + /// + /// This sample shows how you could use a [Consumer] + /// + /// ```dart + /// final counterProvider = StateProvider((ref) => 0); + /// + /// class MyHomePage extends ConsumerWidget { + /// MyHomePage({Key? key, required this.title}) : super(key: key); + /// final String title; + /// + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// return Scaffold( + /// appBar: AppBar( + /// title: Text(title) + /// ), + /// body: Center( + /// child: Column( + /// mainAxisAlignment: MainAxisAlignment.center, + /// children: [ + /// Text('You have pushed the button this many times:'), + /// Consumer( + /// builder: (BuildContext context, WidgetRef ref, Widget? child) { + /// // This builder will only get called when the counterProvider + /// // is updated. + /// final count = ref.watch(counterProvider); + /// + /// return Row( + /// mainAxisAlignment: MainAxisAlignment.spaceEvenly, + /// children: [ + /// Text('$count'), + /// child!, + /// ], + /// ); + /// }, + /// // The child parameter is most helpful if the child is + /// // expensive to build and does not depend on the value from + /// // the notifier. + /// child: Text('Good job!'), + /// ) + /// ], + /// ), + /// ), + /// floatingActionButton: FloatingActionButton( + /// child: Icon(Icons.plus_one), + /// onPressed: () => ref.read(counterProvider.notifier).state++, + /// ), + /// ); + /// } + /// } + /// ``` + final Widget? child; @override Widget build(BuildContext context, WidgetRef ref) { - return _builder(context, ref, _child); + return builder(context, ref, child); } } -/// {@template riverpod.consumerwidget} -/// A [StatelessWidget] that can listen to providers. +/// {@template riverpod.consumer_widget} +/// The equivalent of a [StatelessWidget] that can listen to providers. /// /// Using [ConsumerWidget], this allows the widget tree to listen to changes on /// provider, so that the UI automatically updates when needed. @@ -180,16 +210,15 @@ class Consumer extends ConsumerWidget { /// } /// ``` /// -/// For reading providers inside a [StatefulWidget] or for performance -/// optimizations, see [Consumer]. +/// See also: +/// - [ConsumerStatefulWidget], for a [StatefulWidget] variant. +/// - [Consumer], to help reducing the number of rebuilt widgets without making +/// a new widget. /// {@endtemplate} abstract class ConsumerWidget extends ConsumerStatefulWidget { - /// {@macro riverpod.consumerwidget} + /// {@macro riverpod.consumer_widget} const ConsumerWidget({super.key}); - // TODO changelog & document - // Iterable get dependencies; - /// Describes the part of the user interface represented by this widget. /// /// The framework calls this method when this widget is inserted into the tree @@ -242,30 +271,83 @@ class _ConsumerState extends ConsumerState { } } -/// A [StatefulWidget] that can read providers. +/// A [StatefulWidget] that has a [State] capable of reading providers. +/// +/// This is used exactly like a [StatefulWidget], but with a [State] that must +/// subclass [ConsumerState] : +/// +/// ```dart +/// class MyConsumer extends ConsumerStatefulWidget { +/// const MyConsumer({Key? key}): super(key: key); +/// +/// @override +/// ConsumerState createState() => _MyConsumerState(); +/// } +/// +/// class _MyConsumerState extends ConsumerState { +/// @override +/// void initState() { +/// // All State life-cycles can be used +/// super.initState(); +/// } +/// +/// @override +/// Widget build(BuildContext context) { +/// // "ref" is a property of ConsumerState and can be used to read providers +/// ref.watch(someProvider); +/// } +/// } +/// ``` abstract class ConsumerStatefulWidget extends StatefulWidget { /// A [StatefulWidget] that can read providers. const ConsumerStatefulWidget({super.key}); @override - // ignore: no_logic_in_create_state ConsumerState createState(); @override - ConsumerStatefulElement createElement() { - return ConsumerStatefulElement(this); - } + StatefulElement createElement() => ConsumerStatefulElement(this); } -/// A [State] that has access to a [WidgetRef] through [ref], allowing -/// it to read providers. +/// The [State] for a [ConsumerStatefulWidget]. +/// +/// It has all the life-cycles if a normal [State], with the only difference +/// being that it has a [ref] property. +/// +/// It must be used in conjunction with a [ConsumerStatefulWidget] : +/// +/// ```dart +/// class MyConsumer extends ConsumerStatefulWidget { +/// const MyConsumer({Key? key}): super(key: key); +/// +/// @override +/// ConsumerState createState() => _MyConsumerState(); +/// } +/// +/// class _MyConsumerState extends ConsumerState { +/// @override +/// void initState() { +/// // All State life-cycles can be used +/// super.initState(); +/// } +/// +/// @override +/// Widget build(BuildContext context) { +/// // "ref" is a property of ConsumerState and can be used to read providers +/// ref.watch(someProvider); +/// } +/// } +/// ``` abstract class ConsumerState extends State { + // TODO change this doc /// An object that allows widgets to interact with providers. late final WidgetRef ref = context as WidgetRef; } /// The [Element] for a [ConsumerStatefulWidget] +// TODO changelog breaking unexported +@internal class ConsumerStatefulElement extends StatefulElement implements WidgetRef { /// The [Element] for a [ConsumerStatefulWidget] ConsumerStatefulElement(ConsumerStatefulWidget super.widget); diff --git a/packages/hooks_riverpod/lib/src/consumer.dart b/packages/hooks_riverpod/lib/src/consumer.dart index 38071a4fe..1b421c0c7 100644 --- a/packages/hooks_riverpod/lib/src/consumer.dart +++ b/packages/hooks_riverpod/lib/src/consumer.dart @@ -2,13 +2,13 @@ import 'package:flutter/material.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'internals.dart'; -/// {@template hooks_riverpod.hookconsumer.hookconsumerwidget} +/// {@template hooks_riverpod.hook_consumer.hook_consumer_widget} /// A widget that can both use hooks and listen to providers. /// /// If you do not need hooks, you can use [Consumer]. /// {@endtemplate} abstract class HookConsumerWidget extends ConsumerWidget { - /// {@macro hooks_riverpod.hookconsumer.hookconsumerwidget} + /// {@macro hooks_riverpod.hook_consumer.hook_consumer_widget} const HookConsumerWidget({super.key}); @override @@ -16,19 +16,21 @@ abstract class HookConsumerWidget extends ConsumerWidget { _HookConsumerElement createElement() => _HookConsumerElement(this); } +// ignore: invalid_use_of_internal_member class _HookConsumerElement extends ConsumerStatefulElement with HookElement { _HookConsumerElement(HookConsumerWidget super.widget); } -/// {@macro hooks_riverpod.hookconsumer.hookconsumerwidget} +/// {@macro hooks_riverpod.hook_consumer.hook_consumer_widget} class HookConsumer extends HookConsumerWidget { - /// {@macro hooks_riverpod.hookconsumer.hookconsumerwidget} + /// {@macro hooks_riverpod.hook_consumer.hook_consumer_widget} const HookConsumer({super.key, required this.builder, this.child}); /// A function that builds a widget. /// /// Can both listen to providers and use hooks. + // ignore: invalid_use_of_internal_member final ConsumerBuilder builder; /// An optional child widget that will be passed to [builder]. @@ -54,6 +56,7 @@ abstract class StatefulHookConsumerWidget extends ConsumerStatefulWidget { _StatefulHookConsumerElement(this); } +// ignore: invalid_use_of_internal_member class _StatefulHookConsumerElement extends ConsumerStatefulElement with // ignore: invalid_use_of_visible_for_testing_member From 3972c1f8f719984888cf0b21827f12bad22b6c90 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 28 Feb 2024 11:58:08 +0100 Subject: [PATCH 240/387] Update exports --- packages/riverpod/lib/riverpod.dart | 28 ++++-- .../riverpod/lib/src/core/foundation.dart | 2 + .../lib/src/providers/async_notifier.dart | 1 + .../lib/src/providers/future_provider.dart | 2 + .../riverpod/lib/src/providers/notifier.dart | 1 + .../riverpod/lib/src/providers/provider.dart | 2 + .../lib/src/providers/stream_notifier.dart | 1 + .../lib/src/providers/stream_provider.dart | 2 + packages/riverpod/test/meta_test.dart | 96 ++----------------- .../riverpod/test/new/core/scope_test.dart | 4 +- .../old/legacy/framework2/framework_test.dart | 3 +- .../test/old/legacy/framework_test.dart | 3 +- .../provider/provider_test.dart | 3 +- .../lib/riverpod_annotation.dart | 2 + .../lib/src/riverpod_generator.dart | 2 +- 15 files changed, 54 insertions(+), 98 deletions(-) diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index f62c546ff..e7d092829 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -38,16 +38,30 @@ export 'src/framework.dart' $FunctionalProvider, $ClassProvider, LegacyProviderMixin, - ClassProviderElement; + ClassProviderElement, + // TODO changelog breaking unexported + alreadyInitializedError, + // TODO changelog breaking unexported + uninitializedElementError, + // TODO changelog breaking unexported + shortHash, + // TODO changelog breaking unexported + describeIdentity; export 'src/providers/async_notifier.dart' - hide $AsyncNotifier, $AsyncNotifierProvider; + hide $AsyncNotifier, $AsyncNotifierProvider, $AsyncNotifierProviderElement; // TODO changelog breaking: StateNotifier & co are no-longer exported from pkg:riverpod/riverpod.dart // Use pkg:riverpod/legacy.dart -export 'src/providers/future_provider.dart'; -export 'src/providers/notifier.dart' hide $Notifier, $NotifierProvider; -export 'src/providers/provider.dart'; +export 'src/providers/future_provider.dart' + hide $FutureProviderElement, $FutureProvider; +export 'src/providers/notifier.dart' + hide $Notifier, $NotifierProvider, $NotifierProviderElement; +export 'src/providers/provider.dart' hide $ProviderElement, $Provider; export 'src/providers/stream_notifier.dart' - hide $StreamNotifier, $StreamNotifierProvider; -export 'src/providers/stream_provider.dart'; + hide + $StreamNotifier, + $StreamNotifierProvider, + $StreamNotifierProviderElement; +export 'src/providers/stream_provider.dart' + hide $StreamProviderElement, $StreamProvider; diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index 119cdd5e7..a2e5107f5 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -153,12 +153,14 @@ Set? computeAllTransitiveDependencies( /// distinguish instances of the same class (hash collisions are /// possible, but rare enough that its use in debug output is useful). /// * [Object.runtimeType], the [Type] of an object. +@internal String describeIdentity(Object? object) { return '${object.runtimeType}#${shortHash(object)}'; } // Copied from Flutter /// [Object.hashCode]'s 20 least-significant bits. +@internal String shortHash(Object? object) { return object.hashCode.toUnsigned(20).toRadixString(16).padLeft(5, '0'); } diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index ad3c87820..9cb752216 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -46,6 +46,7 @@ abstract base class $AsyncNotifierProvider< // /// Implementation detail of `riverpod_generator`. /// Do not use. +@internal class $AsyncNotifierProviderElement< // NotifierT extends $AsyncNotifier, StateT> // diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 2997218f0..d34f51291 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -11,6 +11,7 @@ import 'stream_provider.dart' show StreamProvider; /// Implementation detail of `riverpod_generator`. /// Do not use, as this may be removed at any time. +@internal base mixin $FutureProvider on ProviderBase> { FutureOr create(RefT ref); } @@ -162,6 +163,7 @@ abstract class FutureProviderRef implements Ref> { /// The element of a [FutureProvider] /// Implementation detail of `riverpod_generator`. Do not use. +@internal class $FutureProviderElement extends ProviderElementBase> with FutureModifierElement diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index c6a51e466..74e50c2d1 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -102,6 +102,7 @@ abstract base class $NotifierProvider // /// An implementation detail of `riverpod_generator`. /// Do not use. +@internal class $NotifierProviderElement< // NotifierT extends $Notifier, StateT> // diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index b78160cbf..864b0533b 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -8,6 +8,7 @@ import 'stream_provider.dart' show StreamProvider; /// Implementation detail of `riverpod_generator`. /// Do not use, as this may be removed at any time. +@internal base mixin $Provider on ProviderBase { StateT create(RefT ref); } @@ -328,6 +329,7 @@ base class Provider /// when that provider is no longer listened to. /// - [Provider.family], to allow providers to create a value from external parameters. /// {@endtemplate} +@internal class $ProviderElement extends ProviderElementBase { /// A [ProviderElementBase] for [Provider] $ProviderElement(this.provider, super.container); diff --git a/packages/riverpod/lib/src/providers/stream_notifier.dart b/packages/riverpod/lib/src/providers/stream_notifier.dart index 5375b65b2..0a938d6b3 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier.dart @@ -47,6 +47,7 @@ abstract base class $StreamNotifierProvider< /// Implementation detail of `riverpod_generator`. /// Do not use. +@internal class $StreamNotifierProviderElement< // NotifierT extends $StreamNotifier, StateT> // diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index 6e2509477..2978c287c 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -12,6 +12,7 @@ import 'provider.dart' show Provider; /// Implementation detail of `riverpod_generator`. /// Do not use, as this may be removed at any time. +@internal base mixin $StreamProvider on ProviderBase> { Stream create(RefT ref); } @@ -142,6 +143,7 @@ base class StreamProvider extends $FunctionalProvider< } /// The element of [StreamProvider]. +@internal class $StreamProviderElement extends ProviderElementBase> with FutureModifierElement { diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index 581f88ab6..46acba6ad 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -4,6 +4,7 @@ import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/dart/element/type.dart'; import 'package:analyzer/dart/element/visitor.dart'; import 'package:path/path.dart' as path; +import 'package:test/expect.dart'; import 'package:test/test.dart'; void main() { @@ -39,9 +40,8 @@ void main() { } }); - test('public API snapshot', skip: 'Disabled', () async { + test('public API snapshot', () async { expect(riverpod.exportNamespace.definedNames.keys, [ - 'StateNotifier', 'AsyncValue', 'AsyncData', 'AsyncLoading', @@ -50,17 +50,8 @@ void main() { 'AsyncValueX', // TODO rename 'ProviderBase', - // TODO remove - 'FunctionalProvider', - // TODO remove - 'RunNotifierBuild', - // TODO remove - 'ClassProvider', - // TODO remove - 'ClassProviderElement', + 'NotifierBase', 'Refreshable', - // TODO remove - 'ProviderElementBase', 'ProviderContainer', 'ProviderObserver', // TODO remove @@ -71,99 +62,32 @@ void main() { 'ProviderListenableOrFamily', // TODO remove 'ProviderOrFamily', - // TODO remove - 'describeIdentity', - // TODO remove - 'shortHash', 'ProviderListenable', 'Ref', 'KeepAliveLink', 'Override', - // TODO remove - 'FutureModifier', - // TODO remove - 'FutureModifierElement', 'AsyncNotifier', 'AsyncNotifierProvider', 'FamilyAsyncNotifier', - 'FamilyAsyncNotifierProvider', 'AsyncNotifierProviderFamily', - 'StreamNotifier', - 'StreamNotifierProvider', - 'FamilyStreamNotifier', - 'FamilyStreamNotifierProvider', - 'StreamNotifierProviderFamily', - 'StateController', - // TODO remove - 'AutoDisposeStateNotifierProviderRef', - // TODO remove - 'AutoDisposeStateNotifierProvider', - // TODO remove - 'AutoDisposeStateNotifierProviderElement', - // TODO remove - 'AutoDisposeStateNotifierProviderFamily', - // TODO remove - 'StateNotifierProviderRef', - 'StateNotifierProvider', - // TODO remove - 'StateNotifierProviderElement', - 'StateNotifierProviderFamily', - // TODO remove - 'AutoDisposeStateProviderRef', - // TODO remove - 'AutoDisposeStateProvider', - // TODO remove - 'AutoDisposeStateProviderElement', - // TODO remove - 'AutoDisposeStateProviderFamily', - // TODO remove - 'StateProviderRef', - 'StateProvider', - // TODO remove - 'StateProviderElement', - 'StateProviderFamily', + 'FamilyAsyncNotifierProvider', 'FutureProvider', // TODO remove 'FutureProviderRef', - // TODO remove - 'FutureProviderElement', 'FutureProviderFamily', - // TODO remove - 'alreadyInitializedError', - // TODO remove - 'uninitializedElementError', - // TODO remove - 'AutoDisposeNotifier', - // TODO remove - 'AutoDisposeNotifierProviderRef', - // TODO remove - // TODO remove - // TODO remove - 'AutoDisposeNotifierProvider', - // TODO remove - 'AutoDisposeNotifierProviderElement', - // TODO remove - 'AutoDisposeFamilyNotifier', - // TODO remove - 'AutoDisposeFamilyNotifierProvider', - // TODO remove - 'AutoDisposeNotifierProviderFamily', 'Notifier', - // TODO remove - 'NotifierProviderRef', 'NotifierProvider', - // TODO remove - 'NotifierProviderElement', 'FamilyNotifier', - 'NotifierFamilyProvider', + 'FamilyNotifierProvider', 'NotifierProviderFamily', 'Provider', - // TODO remove - 'ProviderElement', 'ProviderFamily', + 'FamilyStreamNotifier', + 'FamilyStreamNotifierProvider', + 'StreamNotifierProviderFamily', + 'StreamNotifier', + 'StreamNotifierProvider', 'StreamProvider', - // TODO remove - 'StreamProviderElement', 'StreamProviderFamily', ]); diff --git a/packages/riverpod/test/new/core/scope_test.dart b/packages/riverpod/test/new/core/scope_test.dart index 6f8b8a619..14866b703 100644 --- a/packages/riverpod/test/new/core/scope_test.dart +++ b/packages/riverpod/test/new/core/scope_test.dart @@ -1,7 +1,9 @@ // Tests related to scoping providers import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/framework.dart'; +import 'package:riverpod/src/framework.dart' show ProviderContainerTest; +import 'package:riverpod/src/internals.dart' + show $ProviderElement, ProviderElementBase; import 'package:test/test.dart'; import 'provider_container_test.dart'; diff --git a/packages/riverpod/test/old/legacy/framework2/framework_test.dart b/packages/riverpod/test/old/legacy/framework2/framework_test.dart index d9cdd3f81..1e4f1314f 100644 --- a/packages/riverpod/test/old/legacy/framework2/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework2/framework_test.dart @@ -3,7 +3,8 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' + show $ProviderElement, ProviderElementBase; import 'package:test/test.dart'; import '../../utils.dart'; diff --git a/packages/riverpod/test/old/legacy/framework_test.dart b/packages/riverpod/test/old/legacy/framework_test.dart index 485b032aa..2af33dc99 100644 --- a/packages/riverpod/test/old/legacy/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework_test.dart @@ -2,7 +2,8 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' + show $ProviderElement, ProviderElementBase; import 'package:test/test.dart'; import '../utils.dart'; diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart index 6360304ea..e8ad4dd0c 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart @@ -3,7 +3,8 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' + show $ProviderElement, ProviderElementBase; import 'package:test/test.dart'; import '../../utils.dart'; diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index 03476de4d..1c4a2aa0d 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -1,4 +1,6 @@ // Annotations used by code-generators +// ignore_for_file: invalid_use_of_internal_member + import 'package:meta/meta.dart' as meta; export 'dart:async' show FutureOr; diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index 61d0190f4..84f278dd0 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -108,7 +108,7 @@ class RiverpodGenerator extends ParserGenerator { if (buffer.isNotEmpty) { buffer.write(''' // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member '''); } } From e413c57fe1cb5df1420d322eb56b6d26b485cd42 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 28 Feb 2024 11:58:14 +0100 Subject: [PATCH 241/387] Update generated files --- examples/counter/lib/main.g.dart | 2 +- examples/pub/lib/detail.g.dart | 2 +- examples/pub/lib/search.g.dart | 2 +- examples/stackoverflow/lib/common.g.dart | 2 +- examples/stackoverflow/lib/question.g.dart | 2 +- examples/stackoverflow/lib/tag.g.dart | 2 +- .../riverpod_generator/integration/build_yaml/lib/main.g.dart | 2 +- packages/riverpod_generator/test/integration/annotated.g.dart | 2 +- packages/riverpod_generator/test/integration/async.g.dart | 2 +- .../riverpod_generator/test/integration/auto_dispose.g.dart | 2 +- .../riverpod_generator/test/integration/dependencies.g.dart | 2 +- .../riverpod_generator/test/integration/dependencies2.g.dart | 2 +- packages/riverpod_generator/test/integration/documented.g.dart | 2 +- packages/riverpod_generator/test/integration/generated.g.dart | 2 +- packages/riverpod_generator/test/integration/hash/hash1.g.dart | 2 +- packages/riverpod_generator/test/integration/scopes.g.dart | 2 +- packages/riverpod_generator/test/integration/split.g.dart | 2 +- packages/riverpod_generator/test/integration/stream.g.dart | 2 +- packages/riverpod_generator/test/integration/sync.g.dart | 2 +- .../test/integration/generated/golden/lib/sync.g.dart | 2 +- .../convert_class_based_provider_to_functional.g.dart | 2 +- .../convert_functional_provider_to_class_based.g.dart | 2 +- .../test/lints/avoid_build_context_in_providers.g.dart | 2 +- .../test/lints/avoid_public_notifier_properties.g.dart | 2 +- .../test/lints/functional_ref/functional_ref.g.dart | 2 +- .../test/lints/notifier_extends.g.dart | 2 +- .../test/lints/only_use_keep_alive_inside_keep_alive.g.dart | 2 +- .../test/lints/protected_notifier_properties.g.dart | 2 +- .../test/lints/provider_dependencies/another.g.dart | 2 +- .../lints/provider_dependencies/missing_dependencies.g.dart | 2 +- .../lints/provider_dependencies/missing_dependencies2.g.dart | 2 +- .../test/lints/provider_dependencies/unused_dependency.g.dart | 2 +- .../test/lints/provider_parameters.g.dart | 2 +- .../lints/scoped_providers_should_specify_dependencies.g.dart | 2 +- .../test/lints/unknown_scoped_usage.g.dart | 2 +- .../test/lints/unsupported_provider_value.g.dart | 2 +- website/docs/advanced/select/select/codegen.g.dart | 2 +- website/docs/advanced/select/select_async/codegen.g.dart | 2 +- website/docs/case_studies/cancel/detail_screen/codegen.g.dart | 2 +- .../case_studies/cancel/detail_screen_cancel/codegen.g.dart | 2 +- .../case_studies/cancel/detail_screen_debounce/codegen.g.dart | 2 +- .../case_studies/cancel/provider_with_extension/codegen.g.dart | 2 +- .../case_studies/pull_to_refresh/fetch_activity/codegen.g.dart | 2 +- .../docs/case_studies/pull_to_refresh/full_app/codegen.g.dart | 2 +- website/docs/concepts/about_codegen/main.g.dart | 2 +- .../about_codegen/provider_type/async_class_future.g.dart | 2 +- .../about_codegen/provider_type/async_class_stream.g.dart | 2 +- .../concepts/about_codegen/provider_type/async_fn_future.g.dart | 2 +- .../concepts/about_codegen/provider_type/async_fn_stream.g.dart | 2 +- .../concepts/about_codegen/provider_type/auto_dispose.g.dart | 2 +- website/docs/concepts/about_codegen/provider_type/family.g.dart | 2 +- .../concepts/about_codegen/provider_type/family_class.g.dart | 2 +- .../docs/concepts/about_codegen/provider_type/family_fn.g.dart | 2 +- .../docs/concepts/about_codegen/provider_type/sync_class.g.dart | 2 +- .../docs/concepts/about_codegen/provider_type/sync_fn.g.dart | 2 +- .../characters_provider/codegen.g.dart | 2 +- .../combining_provider_states/city_provider/codegen.g.dart | 2 +- .../filtered_todo_list_provider/codegen.g.dart | 2 +- .../combining_provider_states/read_in_provider/codegen.g.dart | 2 +- .../select_async_provider/codegen.g.dart | 2 +- .../combining_provider_states/todo_list_provider/codegen.g.dart | 2 +- .../combining_provider_states/weather_provider/codegen.g.dart | 2 +- .../whole_object_provider/codegen.g.dart | 2 +- website/docs/concepts/lifecycle_on_dispose/codegen.g.dart | 2 +- .../docs/concepts/providers/creating_a_provider/codegen.g.dart | 2 +- .../concepts/providers/declaring_many_providers/codegen.g.dart | 2 +- website/docs/concepts/reading/counter/codegen.g.dart | 2 +- website/docs/concepts/reading/listen/codegen.g.dart | 2 +- website/docs/concepts/reading/listen_build/codegen.g.dart | 2 +- website/docs/concepts/reading/listen_build/codegen_hooks.g.dart | 2 +- website/docs/concepts/reading/provider/codegen.g.dart | 2 +- website/docs/concepts/reading/read/codegen.g.dart | 2 +- website/docs/concepts/reading/read/codegen_hooks.g.dart | 2 +- website/docs/concepts/reading/read_build/codegen.g.dart | 2 +- .../docs/concepts/reading/read_notifier_build/codegen.g.dart | 2 +- website/docs/concepts/reading/watch/codegen.g.dart | 2 +- website/docs/concepts/reading/watch_build/codegen.g.dart | 2 +- website/docs/concepts/reading/watch_build/codegen_hooks.g.dart | 2 +- .../docs/concepts/reading/watch_notifier_build/codegen.g.dart | 2 +- website/docs/concepts/why_immutability/codegen.g.dart | 2 +- .../docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart | 2 +- website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart | 2 +- .../auto_dispose/invalidate_family_example/codegen.g.dart | 2 +- website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart | 2 +- .../essentials/auto_dispose/on_dispose_example/codegen.g.dart | 2 +- .../essentials/combining_requests/functional_ref/codegen.g.dart | 2 +- .../essentials/combining_requests/listen_example/codegen.g.dart | 2 +- .../essentials/combining_requests/notifier_ref/codegen.g.dart | 2 +- .../essentials/combining_requests/read_example/codegen.g.dart | 2 +- .../essentials/combining_requests/watch_example/codegen.g.dart | 2 +- .../combining_requests/watch_placement/codegen.g.dart | 2 +- .../eager_initialization/require_value/codegen.g.dart | 2 +- website/docs/essentials/first_request/codegen/provider.g.dart | 2 +- website/docs/essentials/passing_args/family/codegen.g.dart | 2 +- .../docs/essentials/passing_args/no_arg_provider/codegen.g.dart | 2 +- .../essentials/side_effects/codegen/todo_list_notifier.g.dart | 2 +- .../side_effects/codegen/todo_list_notifier_add_todo.g.dart | 2 +- .../essentials/side_effects/codegen/todo_list_provider.g.dart | 2 +- website/docs/essentials/testing/notifier_mock/codegen.g.dart | 2 +- website/docs/essentials/testing/provider_to_mock/codegen.g.dart | 2 +- .../docs/essentials/websockets_sync/pipe_change_notifier.g.dart | 2 +- website/docs/essentials/websockets_sync/raw_usage.g.dart | 2 +- .../websockets_sync/shared_pipe_change_notifier.g.dart | 2 +- .../essentials/websockets_sync/stream_provider/codegen.g.dart | 2 +- .../essentials/websockets_sync/sync_definition/codegen.g.dart | 2 +- website/docs/from_provider/family/family.g.dart | 2 +- .../from_provider/motivation/async_values/async_values.g.dart | 2 +- .../from_provider/motivation/auto_dispose/auto_dispose.g.dart | 2 +- website/docs/from_provider/motivation/combine/combine.g.dart | 2 +- .../docs/from_provider/motivation/same_type/same_type.g.dart | 2 +- .../introduction/getting_started/dart_hello_world/main.g.dart | 2 +- .../getting_started/hello_world/hooks_codegen/main.g.dart | 2 +- .../docs/introduction/getting_started/hello_world/main.g.dart | 2 +- website/docs/introduction/why_riverpod/codegen.g.dart | 2 +- .../from_change_notifier/declaration/declaration.g.dart | 2 +- .../from_change_notifier/initialization/initialization.g.dart | 2 +- .../migration/from_change_notifier/migrated/migrated.g.dart | 2 +- .../from_state_notifier/add_listener/add_listener.g.dart | 2 +- .../from_state_notifier/async_notifier/async_notifier.g.dart | 2 +- .../migration/from_state_notifier/build_init/build_init.g.dart | 2 +- .../family_and_dispose/family_and_dispose.g.dart | 2 +- .../from_state_provider/from_state_provider.g.dart | 2 +- .../from_state_notifier/old_lifecycles/old_lifecycles.g.dart | 2 +- .../old_lifecycles_final/old_lifecycles_final.g.dart | 2 +- .../providers/future_provider/config_provider/codegen.g.dart | 2 +- .../providers/notifier_provider/remote_todos/codegen.g.dart | 2 +- website/docs/providers/notifier_provider/todos/codegen.g.dart | 2 +- .../providers/provider/completed_todos/completed_todos.g.dart | 2 +- .../optimized_previous_button/optimized_previous_button.g.dart | 2 +- website/docs/providers/provider/todo/todo.g.dart | 2 +- .../unoptimized_previous_button.g.dart | 2 +- .../stream_provider/live_stream_chat_provider/codegen.g.dart | 2 +- website/static/snippets/async.g.dart | 2 +- website/static/snippets/combine.g.dart | 2 +- website/static/snippets/create.g.dart | 2 +- website/static/snippets/declare.g.dart | 2 +- 136 files changed, 136 insertions(+), 136 deletions(-) diff --git a/examples/counter/lib/main.g.dart b/examples/counter/lib/main.g.dart index 5724b41e4..329a2e299 100644 --- a/examples/counter/lib/main.g.dart +++ b/examples/counter/lib/main.g.dart @@ -87,4 +87,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 08d43e644..b94300a4d 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -432,4 +432,4 @@ abstract class _$PackageMetrics extends $AsyncNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index d1e5407f0..0107f4982 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -159,4 +159,4 @@ final class FetchPackagesFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/examples/stackoverflow/lib/common.g.dart b/examples/stackoverflow/lib/common.g.dart index 934ffb68a..ac6cabe8e 100644 --- a/examples/stackoverflow/lib/common.g.dart +++ b/examples/stackoverflow/lib/common.g.dart @@ -85,4 +85,4 @@ final class ThemeProvider String _$themeHash() => r'ff39eda97684261eefc24ddb24e41172880644cd'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/examples/stackoverflow/lib/question.g.dart b/examples/stackoverflow/lib/question.g.dart index 6fb5a5720..9f5c18fd1 100644 --- a/examples/stackoverflow/lib/question.g.dart +++ b/examples/stackoverflow/lib/question.g.dart @@ -173,4 +173,4 @@ final class CurrentQuestionProvider extends $FunctionalProvider< String _$currentQuestionHash() => r'2179e068c1d64674dc292a1a027e9e338284c57f'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/examples/stackoverflow/lib/tag.g.dart b/examples/stackoverflow/lib/tag.g.dart index 82c0b09cf..d0eb461df 100644 --- a/examples/stackoverflow/lib/tag.g.dart +++ b/examples/stackoverflow/lib/tag.g.dart @@ -73,4 +73,4 @@ final class TagThemeProvider String _$tagThemeHash() => r'bf5d051ea43e2f60d370096bb756aa81f21e9d68'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index fa0ff282a..a2b0601da 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -1212,4 +1212,4 @@ abstract class _$CountStreamNotifier2 extends $StreamNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 5eb448705..bb9bcc7ac 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -701,4 +701,4 @@ final class NotCopiedFamilyFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index c8b48e079..c24b27ed3 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -1180,4 +1180,4 @@ abstract class _$FamilyClass extends $AsyncNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 95594437b..392fa88e1 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -585,4 +585,4 @@ final class DefaultKeepAliveFamilyFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index f00995878..b6376c128 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -1525,4 +1525,4 @@ String _$transitiveDuplicateDependenciesHash() => r'aba44b6c1cf82eea782ad260f2e95d9f771f12ac'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 9b6c884fa..153651785 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -630,4 +630,4 @@ final class Public2Provider extends $FunctionalProvider String _$public2Hash() => r'9767255f0182589fe48b29d217dd488b0a13b9d5'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index a2c6f864b..0346f123d 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -466,4 +466,4 @@ abstract class _$ClassFamilyBased extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 398030394..177bfb81a 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -1413,4 +1413,4 @@ abstract class _$AliasClassFamily extends $Notifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index d83a07399..bc284ab3f 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -195,4 +195,4 @@ abstract class _$SimpleClass extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 76d571260..f90b628a5 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -235,4 +235,4 @@ abstract class _$ScopedClassFamily extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index 17d1d5a4d..d1c0ec968 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -125,4 +125,4 @@ final class CounterProvider extends $FunctionalProvider String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index b94b3c9d7..3ce1f648c 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -902,4 +902,4 @@ abstract class _$FamilyClass extends $StreamNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 4c7a4477a..b5889891a 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -3138,4 +3138,4 @@ abstract class _$UnnecessaryCastClass extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 9cbdad4bf..1da2ab698 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -841,4 +841,4 @@ abstract class _$Supports$InClassName extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index e071a4421..96d6fabc7 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -432,4 +432,4 @@ abstract class _$Generic extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index 9b30cb625..2b163b937 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -231,4 +231,4 @@ final class ExampleFamilyFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 40a631217..48ff7cec1 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -427,4 +427,4 @@ abstract class _$Regresion2959 extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index 1992e1df4..b26308786 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -166,4 +166,4 @@ abstract class _$GeneratedNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index f79dc278a..43fc19232 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -553,4 +553,4 @@ final class WrongOrderFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart index ab7417e46..d648120df 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart @@ -903,4 +903,4 @@ abstract class _$WrongOrder extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart index 88140125f..af601469d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart @@ -324,4 +324,4 @@ final class FnProvider extends $FunctionalProvider String _$fnHash() => r'9e89e9bead8aa30a86f31bd16f4106c4b38e8f2b'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index 9a5563a8e..a7253af92 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -1187,4 +1187,4 @@ abstract class _$B2 extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart index 4ee57465c..bb52cf4b9 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart @@ -191,4 +191,4 @@ String _$anotherNonEmptyScopedHash() => r'cc21d248e644c853e4647ad60ca72cb42b82475f'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart index 50c27962b..a259c73d7 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart @@ -701,4 +701,4 @@ String _$providerWithDartDocHash() => r'6aeff1697c1ec37f475319a4100e01c0e56369ae'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart index f6952e1e0..4a9fd8400 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart @@ -1570,4 +1570,4 @@ String _$crossFileDependencyHash() => r'9ca6b69de674377c6906fb835cbe04d01851d088'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart index 20ab24585..b93931040 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart @@ -573,4 +573,4 @@ final class RootDepProvider extends $FunctionalProvider String _$rootDepHash() => r'a57728bf865d5a9a73f40f08b038946418cdcf52'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 5c044f26d..79e79c45a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -138,4 +138,4 @@ final class GeneratorFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart index 1d3e37f76..b21da5555 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart @@ -195,4 +195,4 @@ final class RootProvider extends $FunctionalProvider String _$rootHash() => r'1cd85d73316aad02169ff0f5e7af5cf1423410ff'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart index b034e60b7..d193d9c6b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart @@ -125,4 +125,4 @@ final class RootProvider extends $FunctionalProvider String _$rootHash() => r'1cd85d73316aad02169ff0f5e7af5cf1423410ff'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart index b6389d0d7..4dccde6ea 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart @@ -1329,4 +1329,4 @@ final class StreamRawNotifierProvider extends $FunctionalProvider< String _$streamRawNotifierHash() => r'b1075c37ef3e8a83dfb9a3d469b76bd4855c336f'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/advanced/select/select/codegen.g.dart b/website/docs/advanced/select/select/codegen.g.dart index 118a84f10..7f916e012 100644 --- a/website/docs/advanced/select/select/codegen.g.dart +++ b/website/docs/advanced/select/select/codegen.g.dart @@ -68,4 +68,4 @@ final class ExampleProvider extends $FunctionalProvider String _$exampleHash() => r'72881c6147d44adb957180debefe7696d93107f0'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/advanced/select/select_async/codegen.g.dart b/website/docs/advanced/select/select_async/codegen.g.dart index 5741b90ed..74dffb3c4 100644 --- a/website/docs/advanced/select/select_async/codegen.g.dart +++ b/website/docs/advanced/select/select_async/codegen.g.dart @@ -121,4 +121,4 @@ final class ExampleProvider String _$exampleHash() => r'1fccbdbec0e3585bc9d3a5709ac88a8919dd78fa'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart index 07eb663a9..38c6d75dc 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart @@ -82,4 +82,4 @@ final class ActivityProvider extends $FunctionalProvider, String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart index 8e5c1b068..c6cc2d41e 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -62,4 +62,4 @@ final class ActivityProvider extends $FunctionalProvider, String _$activityHash() => r'304864a6b8051925061a2bba397574ec45b94d08'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart index 4ab2e8746..60ce86584 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -62,4 +62,4 @@ final class ActivityProvider extends $FunctionalProvider, String _$activityHash() => r'ef908e3b46693862f082769663b14d5369d6e155'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart index dc93e9c8f..b932ff0c9 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -62,4 +62,4 @@ final class ActivityProvider extends $FunctionalProvider, String _$activityHash() => r'f045dd6e89fde6bbe12a89f243290d289a3e692d'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart index bc2e776b8..605b8a955 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -62,4 +62,4 @@ final class ActivityProvider extends $FunctionalProvider, String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart index 07eb663a9..38c6d75dc 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -82,4 +82,4 @@ final class ActivityProvider extends $FunctionalProvider, String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 2a891a3eb..4aa60925b 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -132,4 +132,4 @@ final class FetchUserFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart index b34cba2bc..1fc29d4ba 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart @@ -69,4 +69,4 @@ abstract class _$Example extends $AsyncNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart index 7f2dbcf66..696e8e575 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart @@ -69,4 +69,4 @@ abstract class _$Example extends $StreamNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart index 404b96a84..0e0e78841 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -61,4 +61,4 @@ final class ExampleProvider extends $FunctionalProvider, String _$exampleHash() => r'e620af6b870a76eea4228989433de0666957d813'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart index 9eb49ab90..ffbb91172 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -61,4 +61,4 @@ final class ExampleProvider String _$exampleHash() => r'8a2b19776fb9bbb1631f898bd6446b57b102dd9d'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart index 792a67780..0b92c8298 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -129,4 +129,4 @@ final class Example2Provider String _$example2Hash() => r'bc25731d759be185125d12d995d0b89b07d1e271'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 41f301d6e..9029bc677 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -140,4 +140,4 @@ final class ExampleFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index 57f0b3c75..b6411c166 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -203,4 +203,4 @@ abstract class _$Example extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index 9a6ea5f42..32f09c070 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -164,4 +164,4 @@ final class ExampleFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart index 717c018aa..d3ae7d304 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart @@ -77,4 +77,4 @@ abstract class _$Example extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart index 6f140ed92..664ce8756 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -69,4 +69,4 @@ final class ExampleProvider String _$exampleHash() => r'dd4e9043c704a42a3fc025e7fef9515f659fc78a'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart index c9967fa83..7afb843d8 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -179,4 +179,4 @@ final class CharactersProvider extends $FunctionalProvider< String _$charactersHash() => r'b1e8e15bbeab60d92fe959d9e1dd4ceba6a31446'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart index 78b11a478..7b40bb385 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -68,4 +68,4 @@ final class CityProvider extends $FunctionalProvider String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart index 5b28a9422..de776cc3c 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -129,4 +129,4 @@ final class FilteredTodoListProvider String _$filteredTodoListHash() => r'1c35eb0fce8fc7c7cda86413b02f606f8c8ae2b4'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart index f37b0d232..e603c7aed 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -128,4 +128,4 @@ final class MyProvider extends $FunctionalProvider String _$myHash() => r'2712c772be4dbaabd4c99fd803f927a7e9938b21'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart index c79c6582a..143ebac38 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -119,4 +119,4 @@ final class ProductsProvider extends $FunctionalProvider< String _$productsHash() => r'd1f4523880408cf8ee0e68969c40cf87d5c78557'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart index c5abcc4bf..845454d13 100644 --- a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart @@ -77,4 +77,4 @@ abstract class _$TodoList extends $Notifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart index 36195cc33..142d2a11c 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -120,4 +120,4 @@ final class WeatherProvider extends $FunctionalProvider, String _$weatherHash() => r'9a79d0269032630918eef9d3f562ff35b5860061'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart index 92d1b2f3b..9f095dae5 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -119,4 +119,4 @@ final class ProductsProvider extends $FunctionalProvider< String _$productsHash() => r'637254615fa398af0d36e212f09e5d3d8ff866aa'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart index 49d441475..393522052 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart @@ -61,4 +61,4 @@ final class ExampleProvider String _$exampleHash() => r'e2c4eb8a7cf06c7a0e5d07ee2bd51db254033fa6'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart index abfc59608..883fe4289 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart @@ -68,4 +68,4 @@ final class MyProvider extends $FunctionalProvider String _$myHash() => r'0810ee24cae78c131d00773ac20d254c83eefab7'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart index a64473b16..f77c1ace8 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart @@ -128,4 +128,4 @@ final class CountryProvider String _$countryHash() => r'd1513349c3bc0c99763cb4fb29eb012f2351bc4c'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/reading/counter/codegen.g.dart b/website/docs/concepts/reading/counter/codegen.g.dart index abdd6ae47..2e77c21f0 100644 --- a/website/docs/concepts/reading/counter/codegen.g.dart +++ b/website/docs/concepts/reading/counter/codegen.g.dart @@ -137,4 +137,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/reading/listen/codegen.g.dart b/website/docs/concepts/reading/listen/codegen.g.dart index bcad01fa9..74334ad42 100644 --- a/website/docs/concepts/reading/listen/codegen.g.dart +++ b/website/docs/concepts/reading/listen/codegen.g.dart @@ -68,4 +68,4 @@ final class AnotherProvider extends $FunctionalProvider String _$anotherHash() => r'2208f9221f3d898305609874d4f43c28bdfff2b4'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/reading/listen_build/codegen.g.dart b/website/docs/concepts/reading/listen_build/codegen.g.dart index 71d405250..9bfbb449c 100644 --- a/website/docs/concepts/reading/listen_build/codegen.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen.g.dart @@ -77,4 +77,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart index 0195278d4..56d4702b1 100644 --- a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart @@ -77,4 +77,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/reading/provider/codegen.g.dart b/website/docs/concepts/reading/provider/codegen.g.dart index 79e8a2760..e03391620 100644 --- a/website/docs/concepts/reading/provider/codegen.g.dart +++ b/website/docs/concepts/reading/provider/codegen.g.dart @@ -128,4 +128,4 @@ final class ValueProvider extends $FunctionalProvider String _$valueHash() => r'8c26f7aaa911af815cff9e513a18e4d8dcc6d1df'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/reading/read/codegen.g.dart b/website/docs/concepts/reading/read/codegen.g.dart index a7572b009..9867e786b 100644 --- a/website/docs/concepts/reading/read/codegen.g.dart +++ b/website/docs/concepts/reading/read/codegen.g.dart @@ -77,4 +77,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/reading/read/codegen_hooks.g.dart b/website/docs/concepts/reading/read/codegen_hooks.g.dart index 4c3e1a917..0e2b3d9b6 100644 --- a/website/docs/concepts/reading/read/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/read/codegen_hooks.g.dart @@ -77,4 +77,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/reading/read_build/codegen.g.dart b/website/docs/concepts/reading/read_build/codegen.g.dart index a7572b009..9867e786b 100644 --- a/website/docs/concepts/reading/read_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_build/codegen.g.dart @@ -77,4 +77,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart index a7572b009..9867e786b 100644 --- a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart @@ -77,4 +77,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/reading/watch/codegen.g.dart b/website/docs/concepts/reading/watch/codegen.g.dart index 248a4b926..f9e315bdc 100644 --- a/website/docs/concepts/reading/watch/codegen.g.dart +++ b/website/docs/concepts/reading/watch/codegen.g.dart @@ -197,4 +197,4 @@ final class FilteredTodoListProvider String _$filteredTodoListHash() => r'34f1e929a9e7850946ea8634d9f3e8f38ae5687d'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/reading/watch_build/codegen.g.dart b/website/docs/concepts/reading/watch_build/codegen.g.dart index 2c3f2436a..174a7dc56 100644 --- a/website/docs/concepts/reading/watch_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen.g.dart @@ -136,4 +136,4 @@ final class CounterProvider extends $FunctionalProvider String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart index 976cc5dee..006a25f97 100644 --- a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart @@ -136,4 +136,4 @@ final class CounterProvider extends $FunctionalProvider String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart index a7572b009..9867e786b 100644 --- a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart @@ -77,4 +77,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/concepts/why_immutability/codegen.g.dart b/website/docs/concepts/why_immutability/codegen.g.dart index 1a9216b29..9e365d289 100644 --- a/website/docs/concepts/why_immutability/codegen.g.dart +++ b/website/docs/concepts/why_immutability/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$ThemeNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart index a4279bd56..5d810b67b 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -61,4 +61,4 @@ final class ExampleProvider extends $FunctionalProvider, String _$exampleHash() => r'3ff29b1cd8fa864286a2a04e39adf1c8589b4275'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart index 9cdeb7fb8..f5830d7e9 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -68,4 +68,4 @@ final class ExampleProvider extends $FunctionalProvider String _$exampleHash() => r'78f9426f6cbda80564387a9db8cd02368d890a85'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index fbdf4fa3f..e623a393a 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -139,4 +139,4 @@ final class LabelFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart index 6db2ab5d3..4b534c5c3 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -61,4 +61,4 @@ final class ExampleProvider extends $FunctionalProvider, String _$exampleHash() => r'4fa856c55e84da9525dcecfab1c897e61456325b'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart index 5e07fc62f..cdcebd2d8 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -120,4 +120,4 @@ final class ExampleProvider String _$exampleHash() => r'29f92958e0d0e3f13ac033e92cd2e4072339c7db'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart index d9bd379f5..4d26be8c8 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart @@ -127,4 +127,4 @@ final class ExampleProvider extends $FunctionalProvider String _$exampleHash() => r'4429d7d3bb2b31fea4cc42c2f2af02d3f3d10693'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart index 0de617661..99bc8ad11 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart @@ -127,4 +127,4 @@ final class ExampleProvider extends $FunctionalProvider String _$exampleHash() => r'd614303f372e06e6ab96035affc4c07a53b28741'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart index de43a535c..14c8e0eac 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -136,4 +136,4 @@ abstract class _$Example extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/combining_requests/read_example/codegen.g.dart b/website/docs/essentials/combining_requests/read_example/codegen.g.dart index e0be099b7..761a48fd0 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.g.dart @@ -136,4 +136,4 @@ abstract class _$MyNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart index a68b0d696..5de38b29b 100644 --- a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart @@ -121,4 +121,4 @@ final class RestaurantsNearMeProvider extends $FunctionalProvider< String _$restaurantsNearMeHash() => r'dd49cc1e6f16abb34dd15286d171e322c06b93b8'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart index 391b0ab04..9523fbd4a 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart @@ -195,4 +195,4 @@ abstract class _$MyNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart index 2fdaa387b..87568a7e7 100644 --- a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart +++ b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart @@ -61,4 +61,4 @@ final class ExampleProvider extends $FunctionalProvider, String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/first_request/codegen/provider.g.dart b/website/docs/essentials/first_request/codegen/provider.g.dart index 9aa96f826..3247e218f 100644 --- a/website/docs/essentials/first_request/codegen/provider.g.dart +++ b/website/docs/essentials/first_request/codegen/provider.g.dart @@ -70,4 +70,4 @@ final class ActivityProvider extends $FunctionalProvider, String _$activityHash() => r'636cd5510e09cbfc46f31b74a70d9e98c89e95a4'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/passing_args/family/codegen.g.dart b/website/docs/essentials/passing_args/family/codegen.g.dart index ece7b01ba..fd1415533 100644 --- a/website/docs/essentials/passing_args/family/codegen.g.dart +++ b/website/docs/essentials/passing_args/family/codegen.g.dart @@ -288,4 +288,4 @@ abstract class _$ActivityNotifier2 extends $AsyncNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart b/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart index 5a708a313..79a92896d 100644 --- a/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart +++ b/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart @@ -123,4 +123,4 @@ abstract class _$ActivityNotifier2 extends $AsyncNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart index 1278ec0e8..86137df46 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -85,4 +85,4 @@ abstract class _$TodoList extends $AsyncNotifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart index 46cf4a5cb..41d7a91b3 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -70,4 +70,4 @@ abstract class _$TodoList extends $AsyncNotifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart index 34ec7722c..2bd8d06b5 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -62,4 +62,4 @@ final class TodoListProvider extends $FunctionalProvider>, String _$todoListHash() => r'26b30307668c8feefa7cbe3c400b73e6edccbc39'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/testing/notifier_mock/codegen.g.dart b/website/docs/essentials/testing/notifier_mock/codegen.g.dart index 6fef6ea49..73b4a4036 100644 --- a/website/docs/essentials/testing/notifier_mock/codegen.g.dart +++ b/website/docs/essentials/testing/notifier_mock/codegen.g.dart @@ -77,4 +77,4 @@ abstract class _$MyNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart index 2fdaa387b..87568a7e7 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart @@ -61,4 +61,4 @@ final class ExampleProvider extends $FunctionalProvider, String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart index 3a0d42112..7496cd4ee 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -79,4 +79,4 @@ final class MyListenableProvider extends $FunctionalProvider< String _$myListenableHash() => r'c80799a0224092668fca44187b98ccfcd2b33ae1'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/websockets_sync/raw_usage.g.dart b/website/docs/essentials/websockets_sync/raw_usage.g.dart index e88d50078..2173c7853 100644 --- a/website/docs/essentials/websockets_sync/raw_usage.g.dart +++ b/website/docs/essentials/websockets_sync/raw_usage.g.dart @@ -71,4 +71,4 @@ final class RawStreamProvider extends $FunctionalProvider< String _$rawStreamHash() => r'7e7c2e8f4f08d33a4d86d60449e143c419ca4822'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart index 9dc99a086..8ba405ac8 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -132,4 +132,4 @@ final class AnotherListenableProvider extends $FunctionalProvider< String _$anotherListenableHash() => r'50dd36b21e07c50818944ec49f9e68d21fcae876'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart index f029963b3..97d12c1dd 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -61,4 +61,4 @@ final class StreamExampleProvider String _$streamExampleHash() => r'ca9993b22f6d587b20c041133cacd28d01933074'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart index c6a15d84b..47a944a85 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -70,4 +70,4 @@ String _$synchronousExampleHash() => r'98df96e07d554683041f668c06b36f183ff534c1'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index 5e073da28..b177e92df 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -163,4 +163,4 @@ final class RandomFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/from_provider/motivation/async_values/async_values.g.dart b/website/docs/from_provider/motivation/async_values/async_values.g.dart index fa0567e5d..c8da26468 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.g.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.g.dart @@ -122,4 +122,4 @@ final class EvenItemsProvider String _$evenItemsHash() => r'55ae98f9b6108203dfc4a139f1ade9fbd8ba8ddd'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart index 541c04374..2390b50d3 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -128,4 +128,4 @@ final class CachedDiceRollProvider String _$cachedDiceRollHash() => r'fc31fcb804f10360d75362e56329976343ee7abb'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/from_provider/motivation/combine/combine.g.dart b/website/docs/from_provider/motivation/combine/combine.g.dart index 473f5d8a5..978c4ef8d 100644 --- a/website/docs/from_provider/motivation/combine/combine.g.dart +++ b/website/docs/from_provider/motivation/combine/combine.g.dart @@ -127,4 +127,4 @@ final class DoubledProvider extends $FunctionalProvider String _$doubledHash() => r'ddc640c876bdbe49fe72fe1632b5ff48687c9279'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/from_provider/motivation/same_type/same_type.g.dart b/website/docs/from_provider/motivation/same_type/same_type.g.dart index 9256c7f3a..2b00141ea 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.g.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.g.dart @@ -129,4 +129,4 @@ final class EvenItemsProvider String _$evenItemsHash() => r'82b4525e91604745f2b4664531b32d4aff5717d4'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart index 1dc762216..7e76cb8c8 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart @@ -69,4 +69,4 @@ final class HelloWorldProvider String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart index 1dc762216..7e76cb8c8 100644 --- a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -69,4 +69,4 @@ final class HelloWorldProvider String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/introduction/getting_started/hello_world/main.g.dart b/website/docs/introduction/getting_started/hello_world/main.g.dart index 1dc762216..7e76cb8c8 100644 --- a/website/docs/introduction/getting_started/hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/main.g.dart @@ -69,4 +69,4 @@ final class HelloWorldProvider String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index 2a8c942b1..d3f609454 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -159,4 +159,4 @@ final class FetchPackagesFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart index a4614a167..89fde15c5 100644 --- a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart +++ b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart @@ -70,4 +70,4 @@ abstract class _$MyNotifier extends $AsyncNotifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart index 96e332ba9..7ba06bab0 100644 --- a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart +++ b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart @@ -70,4 +70,4 @@ abstract class _$MyNotifier extends $AsyncNotifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart index 315b14f71..155265ea9 100644 --- a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart +++ b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart @@ -70,4 +70,4 @@ abstract class _$MyNotifier extends $AsyncNotifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart index 4c550c2ab..3421fa239 100644 --- a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart +++ b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -77,4 +77,4 @@ abstract class _$MyNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart index 3f253f011..6354391c1 100644 --- a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart +++ b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -71,4 +71,4 @@ abstract class _$AsyncTodosNotifier extends $AsyncNotifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart index 088a22017..5c2954920 100644 --- a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart +++ b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart @@ -78,4 +78,4 @@ abstract class _$CounterNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index 56a88c59e..9eb5aaac6 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -228,4 +228,4 @@ abstract class _$BugsEncounteredNotifier extends $AsyncNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart index 080e82a5e..414240d7b 100644 --- a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart +++ b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -78,4 +78,4 @@ abstract class _$CounterNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart index 7d758455b..ebeae7b8b 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -77,4 +77,4 @@ abstract class _$MyNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart index 2ba373cf8..a2fd32d96 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -197,4 +197,4 @@ abstract class _$MyNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/providers/future_provider/config_provider/codegen.g.dart b/website/docs/providers/future_provider/config_provider/codegen.g.dart index bcb7b28c9..ee145abd8 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.g.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.g.dart @@ -67,4 +67,4 @@ String _$fetchConfigurationHash() => r'6c0f062e6f20baf883c4282856f1197fbe633d89'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart index 4c21d5871..cca3e35a9 100644 --- a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart @@ -87,4 +87,4 @@ abstract class _$AsyncTodos extends $AsyncNotifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/providers/notifier_provider/todos/codegen.g.dart b/website/docs/providers/notifier_provider/todos/codegen.g.dart index eec1d3ad2..60d92b5cc 100644 --- a/website/docs/providers/notifier_provider/todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/todos/codegen.g.dart @@ -77,4 +77,4 @@ abstract class _$Todos extends $Notifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/providers/provider/completed_todos/completed_todos.g.dart b/website/docs/providers/provider/completed_todos/completed_todos.g.dart index 815ff63bd..8cdc7d8a8 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.g.dart @@ -69,4 +69,4 @@ final class CompletedTodosProvider String _$completedTodosHash() => r'855706c09268f428696b3b382ae1605818361b83'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index 1031e808a..4cbe2931e 100644 --- a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -138,4 +138,4 @@ String _$canGoToPreviousPageHash() => r'801fe8182a37cd21ae83bdfccbe36c125b4d14fb'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/providers/provider/todo/todo.g.dart b/website/docs/providers/provider/todo/todo.g.dart index 1d2719d24..a7227a1fe 100644 --- a/website/docs/providers/provider/todo/todo.g.dart +++ b/website/docs/providers/provider/todo/todo.g.dart @@ -77,4 +77,4 @@ abstract class _$Todos extends $Notifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart index 5e1455a75..bba8f6a42 100644 --- a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart +++ b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -77,4 +77,4 @@ abstract class _$PageIndex extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart index 8d802911a..2b815fa9c 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -62,4 +62,4 @@ final class ChatProvider extends $FunctionalProvider>, String _$chatHash() => r'db1302132f90e854fe2f5da9d97d89c9a3c8b858'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/static/snippets/async.g.dart b/website/static/snippets/async.g.dart index 20b200084..8998bc376 100644 --- a/website/static/snippets/async.g.dart +++ b/website/static/snippets/async.g.dart @@ -64,4 +64,4 @@ final class ConfigurationsProvider extends $FunctionalProvider< String _$configurationsHash() => r'27f534f8b2a22c39b2d28c2414358a228c552155'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/static/snippets/combine.g.dart b/website/static/snippets/combine.g.dart index 87a06ff77..52d1d7141 100644 --- a/website/static/snippets/combine.g.dart +++ b/website/static/snippets/combine.g.dart @@ -189,4 +189,4 @@ final class FilteredTodosProvider String _$filteredTodosHash() => r'bcb1e81823aaf9b967948b619c177ebc571d96a7'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/static/snippets/create.g.dart b/website/static/snippets/create.g.dart index b391714a9..ab8eaf983 100644 --- a/website/static/snippets/create.g.dart +++ b/website/static/snippets/create.g.dart @@ -61,4 +61,4 @@ final class BoredSuggestionProvider extends $FunctionalProvider< String _$boredSuggestionHash() => r'5975efd623c41e5bc92ecd326209e6124cb1736d'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/website/static/snippets/declare.g.dart b/website/static/snippets/declare.g.dart index 9f3249d74..c23869086 100644 --- a/website/static/snippets/declare.g.dart +++ b/website/static/snippets/declare.g.dart @@ -77,4 +77,4 @@ abstract class _$Count extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member From 88dda63565c010f51ad78eb3102f13653e63159e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 28 Feb 2024 12:13:14 +0100 Subject: [PATCH 242/387] CI --- packages/riverpod/test/meta_test.dart | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index 46acba6ad..e816abc02 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -4,7 +4,6 @@ import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/dart/element/type.dart'; import 'package:analyzer/dart/element/visitor.dart'; import 'package:path/path.dart' as path; -import 'package:test/expect.dart'; import 'package:test/test.dart'; void main() { @@ -40,7 +39,7 @@ void main() { } }); - test('public API snapshot', () async { + test('public API snapshot', skip: 'Disabled', () async { expect(riverpod.exportNamespace.definedNames.keys, [ 'AsyncValue', 'AsyncData', From 290586454c6db47017ea0800353cf810129a7f3a Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 28 Feb 2024 20:56:24 +0100 Subject: [PATCH 243/387] Remove AsyncValue extension --- .../riverpod/lib/src/core/async_value.dart | 499 +++++++++--------- packages/riverpod/test/meta_test.dart | 2 - 2 files changed, 248 insertions(+), 253 deletions(-) diff --git a/packages/riverpod/lib/src/core/async_value.dart b/packages/riverpod/lib/src/core/async_value.dart index 6b4b8bcec..bee1a0e2e 100644 --- a/packages/riverpod/lib/src/core/async_value.dart +++ b/packages/riverpod/lib/src/core/async_value.dart @@ -222,8 +222,75 @@ sealed class AsyncValue { String get _displayString; - /// Casts the [AsyncValue] to a different type. - AsyncValue _cast(); + /// If [hasValue] is true, returns the value. + /// Otherwise if [hasError], rethrows the error. + /// Finally if in loading state, throws a [StateError]. + /// + /// This is typically used for when the UI assumes that [value] is always present. + T get requireValue { + if (hasValue) return value as T; + if (hasError) { + throwErrorWithCombinedStackTrace(error!, stackTrace!); + } + + throw StateError( + 'Tried to call `requireValue` on an `AsyncValue` that has no value: $this', + ); + } + + /// Whether the associated provider was forced to recompute even though + /// none of its dependencies has changed, after at least one [value]/[error] was emitted. + /// + /// This is usually the case when rebuilding a provider with either + /// [Ref.invalidate]/[Ref.refresh]. + /// + /// If a provider rebuilds because one of its dependencies changes (using [Ref.watch]), + /// then [isRefreshing] will be false, and instead [isReloading] will be true. + bool get isRefreshing => + isLoading && (hasValue || hasError) && this is! AsyncLoading; + + /// Whether the associated provider was recomputed because of a dependency change + /// (using [Ref.watch]), after at least one [value]/[error] was emitted. + /// + /// If a provider rebuilds because one of its dependencies changed (using [Ref.watch]), + /// then [isReloading] will be true. + /// If a provider rebuilds only due to [Ref.invalidate]/[Ref.refresh], then + /// [isReloading] will be false (and [isRefreshing] will be true). + /// + /// See also [isRefreshing] for manual provider rebuild. + bool get isReloading => (hasValue || hasError) && this is AsyncLoading; + + /// Whether [error] is not null. + /// + /// Even if [hasError] is true, it is still possible for [hasValue]/[isLoading] + /// to also be true. + // It is safe to check it through `error != null` because `error` is non-nullable + // on the AsyncError constructor. + bool get hasError => error != null; + + /// Upcast [AsyncValue] into an [AsyncData], or return null if the [AsyncValue] + /// is an [AsyncLoading]/[AsyncError]. + /// + /// Note that an [AsyncData] may still be in loading/error state, such + /// as during a pull-to-refresh. + AsyncData? get asData { + return map( + data: (d) => d, + error: (e) => null, + loading: (l) => null, + ); + } + + /// Upcast [AsyncValue] into an [AsyncError], or return null if the [AsyncValue] + /// is an [AsyncLoading]/[AsyncData]. + /// + /// Note that an [AsyncError] may still be in loading state, such + /// as during a pull-to-refresh. + AsyncError? get asError => map( + data: (_) => null, + error: (e) => e, + loading: (_) => null, + ); /// Perform some action based on the current state of the [AsyncValue]. /// @@ -235,6 +302,185 @@ sealed class AsyncValue { required R Function(AsyncLoading loading) loading, }); + /// Casts the [AsyncValue] to a different type. + AsyncValue _cast(); + + /// Shorthand for [when] to handle only the `data` case. + /// + /// For loading/error cases, creates a new [AsyncValue] with the corresponding + /// generic type while preserving the error/stacktrace. + AsyncValue whenData(R Function(T value) cb) { + return map( + data: (d) { + try { + return AsyncData._( + cb(d.value), + isLoading: d.isLoading, + error: d.error, + stackTrace: d.stackTrace, + ); + } catch (err, stack) { + return AsyncError._( + err, + stackTrace: stack, + isLoading: d.isLoading, + value: null, + hasValue: false, + ); + } + }, + error: (e) => AsyncError._( + e.error, + stackTrace: e.stackTrace, + isLoading: e.isLoading, + value: null, + hasValue: false, + ), + loading: (l) => AsyncLoading(), + ); + } + + /// Switch-case over the state of the [AsyncValue] while purposefully not handling + /// some cases. + /// + /// If [AsyncValue] was in a case that is not handled, will return [orElse]. + /// + /// {@macro async_value.skip_flags} + R maybeWhen({ + bool skipLoadingOnReload = false, + bool skipLoadingOnRefresh = true, + bool skipError = false, + R Function(T data)? data, + R Function(Object error, StackTrace stackTrace)? error, + R Function()? loading, + required R Function() orElse, + }) { + return when( + skipError: skipError, + skipLoadingOnRefresh: skipLoadingOnRefresh, + skipLoadingOnReload: skipLoadingOnReload, + data: data ?? (_) => orElse(), + error: error ?? (err, stack) => orElse(), + loading: loading ?? () => orElse(), + ); + } + + /// Performs an action based on the state of the [AsyncValue]. + /// + /// All cases are required, which allows returning a non-nullable value. + /// + /// {@template async_value.skip_flags} + /// By default, [when] skips "loading" states if triggered by a [Ref.refresh] + /// or [Ref.invalidate] (but does not skip loading states if triggered by [Ref.watch]). + /// + /// In the event that an [AsyncValue] is in multiple states at once (such as + /// when reloading a provider or emitting an error after a valid data), + /// [when] offers various flags to customize whether it should call + /// [loading]/[error]/[data] : + /// + /// - [skipLoadingOnReload] (false by default) customizes whether [loading] + /// should be invoked if a provider rebuilds because of [Ref.watch]. + /// In that situation, [when] will try to invoke either [error]/[data] + /// with the previous state. + /// + /// - [skipLoadingOnRefresh] (true by default) controls whether [loading] + /// should be invoked if a provider rebuilds because of [Ref.refresh] + /// or [Ref.invalidate]. + /// In that situation, [when] will try to invoke either [error]/[data] + /// with the previous state. + /// + /// - [skipError] (false by default) decides whether to invoke [data] instead + /// of [error] if a previous [value] is available. + /// {@endtemplate} + R when({ + bool skipLoadingOnReload = false, + bool skipLoadingOnRefresh = true, + bool skipError = false, + required R Function(T data) data, + required R Function(Object error, StackTrace stackTrace) error, + required R Function() loading, + }) { + if (isLoading) { + bool skip; + if (isRefreshing) { + skip = skipLoadingOnRefresh; + } else if (isReloading) { + skip = skipLoadingOnReload; + } else { + skip = false; + } + if (!skip) return loading(); + } + + if (hasError && (!hasValue || !skipError)) { + return error(this.error!, stackTrace!); + } + + return data(requireValue); + } + + /// Perform actions conditionally based on the state of the [AsyncValue]. + /// + /// Returns null if [AsyncValue] was in a state that was not handled. + /// This is similar to [maybeWhen] where `orElse` returns null. + /// + /// {@macro async_value.skip_flags} + R? whenOrNull({ + bool skipLoadingOnReload = false, + bool skipLoadingOnRefresh = true, + bool skipError = false, + R? Function(T data)? data, + R? Function(Object error, StackTrace stackTrace)? error, + R? Function()? loading, + }) { + return when( + skipError: skipError, + skipLoadingOnRefresh: skipLoadingOnRefresh, + skipLoadingOnReload: skipLoadingOnReload, + data: data ?? (_) => null, + error: error ?? (err, stack) => null, + loading: loading ?? () => null, + ); + } + + /// Perform some actions based on the state of the [AsyncValue], or call orElse + /// if the current state was not tested. + R maybeMap({ + R Function(AsyncData data)? data, + R Function(AsyncError error)? error, + R Function(AsyncLoading loading)? loading, + required R Function() orElse, + }) { + return map( + data: (d) { + if (data != null) return data(d); + return orElse(); + }, + error: (d) { + if (error != null) return error(d); + return orElse(); + }, + loading: (d) { + if (loading != null) return loading(d); + return orElse(); + }, + ); + } + + /// Perform some actions based on the state of the [AsyncValue], or return null + /// if the current state wasn't tested. + R? mapOrNull({ + R? Function(AsyncData data)? data, + R? Function(AsyncError error)? error, + R? Function(AsyncLoading loading)? loading, + }) { + return map( + data: (d) => data?.call(d), + error: (d) => error?.call(d), + loading: (d) => loading?.call(d), + ); + } + /// Clone an [AsyncValue], merging it with [previous]. /// /// When doing so, the resulting [AsyncValue] can contain the information @@ -540,252 +786,3 @@ final class AsyncError extends AsyncValue { ); } } - -/// An extension that adds methods like [when] to an [AsyncValue]. -extension AsyncValueX on AsyncValue { - /// If [hasValue] is true, returns the value. - /// Otherwise if [hasError], rethrows the error. - /// Finally if in loading state, throws a [StateError]. - /// - /// This is typically used for when the UI assumes that [value] is always present. - T get requireValue { - if (hasValue) return value as T; - if (hasError) { - throwErrorWithCombinedStackTrace(error!, stackTrace!); - } - - throw StateError( - 'Tried to call `requireValue` on an `AsyncValue` that has no value: $this', - ); - } - - /// Whether the associated provider was forced to recompute even though - /// none of its dependencies has changed, after at least one [value]/[error] was emitted. - /// - /// This is usually the case when rebuilding a provider with either - /// [Ref.invalidate]/[Ref.refresh]. - /// - /// If a provider rebuilds because one of its dependencies changes (using [Ref.watch]), - /// then [isRefreshing] will be false, and instead [isReloading] will be true. - bool get isRefreshing => - isLoading && (hasValue || hasError) && this is! AsyncLoading; - - /// Whether the associated provider was recomputed because of a dependency change - /// (using [Ref.watch]), after at least one [value]/[error] was emitted. - /// - /// If a provider rebuilds because one of its dependencies changed (using [Ref.watch]), - /// then [isReloading] will be true. - /// If a provider rebuilds only due to [Ref.invalidate]/[Ref.refresh], then - /// [isReloading] will be false (and [isRefreshing] will be true). - /// - /// See also [isRefreshing] for manual provider rebuild. - bool get isReloading => (hasValue || hasError) && this is AsyncLoading; - - /// Whether [error] is not null. - /// - /// Even if [hasError] is true, it is still possible for [hasValue]/[isLoading] - /// to also be true. - // It is safe to check it through `error != null` because `error` is non-nullable - // on the AsyncError constructor. - bool get hasError => error != null; - - /// Upcast [AsyncValue] into an [AsyncData], or return null if the [AsyncValue] - /// is an [AsyncLoading]/[AsyncError]. - /// - /// Note that an [AsyncData] may still be in loading/error state, such - /// as during a pull-to-refresh. - AsyncData? get asData { - return map( - data: (d) => d, - error: (e) => null, - loading: (l) => null, - ); - } - - /// Upcast [AsyncValue] into an [AsyncError], or return null if the [AsyncValue] - /// is an [AsyncLoading]/[AsyncData]. - /// - /// Note that an [AsyncError] may still be in loading state, such - /// as during a pull-to-refresh. - AsyncError? get asError => map( - data: (_) => null, - error: (e) => e, - loading: (_) => null, - ); - - /// Shorthand for [when] to handle only the `data` case. - /// - /// For loading/error cases, creates a new [AsyncValue] with the corresponding - /// generic type while preserving the error/stacktrace. - AsyncValue whenData(R Function(T value) cb) { - return map( - data: (d) { - try { - return AsyncData._( - cb(d.value), - isLoading: d.isLoading, - error: d.error, - stackTrace: d.stackTrace, - ); - } catch (err, stack) { - return AsyncError._( - err, - stackTrace: stack, - isLoading: d.isLoading, - value: null, - hasValue: false, - ); - } - }, - error: (e) => AsyncError._( - e.error, - stackTrace: e.stackTrace, - isLoading: e.isLoading, - value: null, - hasValue: false, - ), - loading: (l) => AsyncLoading(), - ); - } - - /// Switch-case over the state of the [AsyncValue] while purposefully not handling - /// some cases. - /// - /// If [AsyncValue] was in a case that is not handled, will return [orElse]. - /// - /// {@macro async_value.skip_flags} - R maybeWhen({ - bool skipLoadingOnReload = false, - bool skipLoadingOnRefresh = true, - bool skipError = false, - R Function(T data)? data, - R Function(Object error, StackTrace stackTrace)? error, - R Function()? loading, - required R Function() orElse, - }) { - return when( - skipError: skipError, - skipLoadingOnRefresh: skipLoadingOnRefresh, - skipLoadingOnReload: skipLoadingOnReload, - data: data ?? (_) => orElse(), - error: error ?? (err, stack) => orElse(), - loading: loading ?? () => orElse(), - ); - } - - /// Performs an action based on the state of the [AsyncValue]. - /// - /// All cases are required, which allows returning a non-nullable value. - /// - /// {@template async_value.skip_flags} - /// By default, [when] skips "loading" states if triggered by a [Ref.refresh] - /// or [Ref.invalidate] (but does not skip loading states if triggered by [Ref.watch]). - /// - /// In the event that an [AsyncValue] is in multiple states at once (such as - /// when reloading a provider or emitting an error after a valid data), - /// [when] offers various flags to customize whether it should call - /// [loading]/[error]/[data] : - /// - /// - [skipLoadingOnReload] (false by default) customizes whether [loading] - /// should be invoked if a provider rebuilds because of [Ref.watch]. - /// In that situation, [when] will try to invoke either [error]/[data] - /// with the previous state. - /// - /// - [skipLoadingOnRefresh] (true by default) controls whether [loading] - /// should be invoked if a provider rebuilds because of [Ref.refresh] - /// or [Ref.invalidate]. - /// In that situation, [when] will try to invoke either [error]/[data] - /// with the previous state. - /// - /// - [skipError] (false by default) decides whether to invoke [data] instead - /// of [error] if a previous [value] is available. - /// {@endtemplate} - R when({ - bool skipLoadingOnReload = false, - bool skipLoadingOnRefresh = true, - bool skipError = false, - required R Function(T data) data, - required R Function(Object error, StackTrace stackTrace) error, - required R Function() loading, - }) { - if (isLoading) { - bool skip; - if (isRefreshing) { - skip = skipLoadingOnRefresh; - } else if (isReloading) { - skip = skipLoadingOnReload; - } else { - skip = false; - } - if (!skip) return loading(); - } - - if (hasError && (!hasValue || !skipError)) { - return error(this.error!, stackTrace!); - } - - return data(requireValue); - } - - /// Perform actions conditionally based on the state of the [AsyncValue]. - /// - /// Returns null if [AsyncValue] was in a state that was not handled. - /// This is similar to [maybeWhen] where `orElse` returns null. - /// - /// {@macro async_value.skip_flags} - R? whenOrNull({ - bool skipLoadingOnReload = false, - bool skipLoadingOnRefresh = true, - bool skipError = false, - R? Function(T data)? data, - R? Function(Object error, StackTrace stackTrace)? error, - R? Function()? loading, - }) { - return when( - skipError: skipError, - skipLoadingOnRefresh: skipLoadingOnRefresh, - skipLoadingOnReload: skipLoadingOnReload, - data: data ?? (_) => null, - error: error ?? (err, stack) => null, - loading: loading ?? () => null, - ); - } - - /// Perform some actions based on the state of the [AsyncValue], or call orElse - /// if the current state was not tested. - R maybeMap({ - R Function(AsyncData data)? data, - R Function(AsyncError error)? error, - R Function(AsyncLoading loading)? loading, - required R Function() orElse, - }) { - return map( - data: (d) { - if (data != null) return data(d); - return orElse(); - }, - error: (d) { - if (error != null) return error(d); - return orElse(); - }, - loading: (d) { - if (loading != null) return loading(d); - return orElse(); - }, - ); - } - - /// Perform some actions based on the state of the [AsyncValue], or return null - /// if the current state wasn't tested. - R? mapOrNull({ - R? Function(AsyncData data)? data, - R? Function(AsyncError error)? error, - R? Function(AsyncLoading loading)? loading, - }) { - return map( - data: (d) => data?.call(d), - error: (d) => error?.call(d), - loading: (d) => loading?.call(d), - ); - } -} diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index e816abc02..77425b80a 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -45,8 +45,6 @@ void main() { 'AsyncData', 'AsyncLoading', 'AsyncError', - // TODO remove - 'AsyncValueX', // TODO rename 'ProviderBase', 'NotifierBase', From b2ff9f4d3efd55377b29d72fc4e25915a6171c3e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 28 Feb 2024 20:58:35 +0100 Subject: [PATCH 244/387] Unexport CircularDependencyError --- packages/riverpod/lib/riverpod.dart | 3 ++- packages/riverpod/lib/src/core/provider_container.dart | 2 ++ packages/riverpod/test/meta_test.dart | 5 ----- packages/riverpod/test/old/legacy/framework_test.dart | 2 +- packages/riverpod_annotation/lib/riverpod_annotation.dart | 1 - 5 files changed, 5 insertions(+), 8 deletions(-) diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index e7d092829..7bdab83ee 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -46,7 +46,8 @@ export 'src/framework.dart' // TODO changelog breaking unexported shortHash, // TODO changelog breaking unexported - describeIdentity; + describeIdentity, + CircularDependencyError; export 'src/providers/async_notifier.dart' hide $AsyncNotifier, $AsyncNotifierProvider, $AsyncNotifierProviderElement; diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index a60876fe5..5f3eaca74 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -1091,6 +1091,8 @@ typedef SetupOverride = void Function({ /// and maintainability reasons. /// Consider reading about unidirectional data flow to learn about the /// benefits of avoiding circular dependencies. +// TODO changelog: CircularDependencyError is no-longer exported +@internal class CircularDependencyError extends Error { CircularDependencyError._(); } diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index 77425b80a..97790d0c9 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -51,13 +51,9 @@ void main() { 'Refreshable', 'ProviderContainer', 'ProviderObserver', - // TODO remove - 'CircularDependencyError', 'Family', 'ProviderSubscription', - // TODO remove 'ProviderListenableOrFamily', - // TODO remove 'ProviderOrFamily', 'ProviderListenable', 'Ref', @@ -69,7 +65,6 @@ void main() { 'AsyncNotifierProviderFamily', 'FamilyAsyncNotifierProvider', 'FutureProvider', - // TODO remove 'FutureProviderRef', 'FutureProviderFamily', 'Notifier', diff --git a/packages/riverpod/test/old/legacy/framework_test.dart b/packages/riverpod/test/old/legacy/framework_test.dart index 2af33dc99..ffbc0fee9 100644 --- a/packages/riverpod/test/old/legacy/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework_test.dart @@ -3,7 +3,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/internals.dart' - show $ProviderElement, ProviderElementBase; + show $ProviderElement, CircularDependencyError, ProviderElementBase; import 'package:test/test.dart'; import '../utils.dart'; diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index 1c4a2aa0d..fcb1663b3 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -41,7 +41,6 @@ export 'package:riverpod/src/internals.dart' AsyncLoading, AsyncData, AsyncError, - AsyncValueX, // AsyncNotifier $AsyncNotifierProvider, From fe5c02211165e18b8a4dd5845e05270743733c39 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 28 Feb 2024 21:01:14 +0100 Subject: [PATCH 245/387] Riverpod FutureProviderRef --- .../lib/src/providers/future_provider.dart | 32 +++------- packages/riverpod/test/meta_test.dart | 1 - .../test/new/core/select_async_test.dart | 2 +- .../future_provider/future_provider_test.dart | 59 ++----------------- 4 files changed, 14 insertions(+), 80 deletions(-) diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index d34f51291..ddd9d5d83 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -85,10 +85,10 @@ base mixin $FutureProvider on ProviderBase> { /// - [FutureProvider.autoDispose], to destroy the state of a [FutureProvider] when no longer needed. /// {@endtemplate} final class FutureProvider extends $FunctionalProvider< - AsyncValue, FutureOr, FutureProviderRef> + AsyncValue, FutureOr, Ref>> with $FutureModifier, - $FutureProvider>, + $FutureProvider>>, LegacyProviderMixin> { /// {@macro riverpod.future_provider} FutureProvider( @@ -122,10 +122,10 @@ final class FutureProvider extends $FunctionalProvider< static const family = FutureProviderFamilyBuilder(); /// TODO add dartdoc on all create cbs. - final Create, FutureProviderRef> _create; + final Create, Ref>> _create; @override - FutureOr create(FutureProviderRef ref) => this._create(ref); + FutureOr create(Ref> ref) => this._create(ref); @internal @override @@ -137,7 +137,7 @@ final class FutureProvider extends $FunctionalProvider< @visibleForOverriding @override FutureProvider $copyWithCreate( - Create, FutureProviderRef> create, + Create, Ref>> create, ) { return FutureProvider.internal( create, @@ -151,23 +151,13 @@ final class FutureProvider extends $FunctionalProvider< } } -/// {@macro riverpod.provider_ref_base} -abstract class FutureProviderRef implements Ref> { - /// Obtains the [Future] associated to this provider. - /// - /// This is equivalent to doing `ref.read(myProvider.future)`. - /// See also [FutureProvider.future]. - // TODO move to Ref - Future get future; -} - /// The element of a [FutureProvider] /// Implementation detail of `riverpod_generator`. Do not use. +// TODO changelog breaking: Removed FutureProviderRef. To migrate ref.future, use an AsyncNotifier and its .future @internal class $FutureProviderElement extends ProviderElementBase> - with FutureModifierElement - implements FutureProviderRef { + with FutureModifierElement { /// The element of a [FutureProvider] /// Implementation detail of `riverpod_generator`. Do not use. $FutureProviderElement(this.provider, super.container); @@ -175,12 +165,6 @@ class $FutureProviderElement @override final $FutureProvider>> provider; - @override - Future get future { - flush(); - return futureNotifier.value; - } - @override void create({required bool didChangeDependency}) { handleFuture( @@ -203,7 +187,7 @@ class $FutureProviderElement /// The [Family] of a [FutureProvider] class FutureProviderFamily extends FunctionalFamily< - FutureProviderRef, + Ref>, AsyncValue, ArgT, FutureOr, diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index 97790d0c9..723664e44 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -65,7 +65,6 @@ void main() { 'AsyncNotifierProviderFamily', 'FamilyAsyncNotifierProvider', 'FutureProvider', - 'FutureProviderRef', 'FutureProviderFamily', 'Notifier', 'NotifierProvider', diff --git a/packages/riverpod/test/new/core/select_async_test.dart b/packages/riverpod/test/new/core/select_async_test.dart index fc7c91070..058eea114 100644 --- a/packages/riverpod/test/new/core/select_async_test.dart +++ b/packages/riverpod/test/new/core/select_async_test.dart @@ -162,7 +162,7 @@ void main() { test('handles multiple AsyncLoading at once then data', () async { final container = ProviderContainer.test(); - late FutureProviderRef ref; + late Ref> ref; final provider = FutureProvider((r) { ref = r; final completer = Completer(); diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart index 6d20b3591..16471250f 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart @@ -11,55 +11,6 @@ import 'package:test/test.dart'; import '../../utils.dart'; void main() { - group('FutureProviderRef.future', () { - test('returns the pending future', () async { - final container = ProviderContainer.test(); - Future? future; - int? value; - final provider = FutureProvider((ref) { - future = ref.future; - if (value == null) return ref.future; - return value; - }); - - container.read(provider); - - expect( - future, - same(container.read(provider.future)), - ); - expect(future, completion(42)); - - value = 42; - container.refresh(provider); - - expect( - future, - same(container.read(provider.future)), - ); - expect(future, completion(42)); - }); - - test('flushes the provider when reading ref.future', () async { - final container = ProviderContainer.test(); - var result = Future.value(42); - late FutureProviderRef ref; - final provider = FutureProvider((r) { - ref = r; - return result; - }); - - container.read(provider); - - await expectLater(ref.future, completion(42)); - - result = Future.value(21); - container.invalidate(provider); - - expect(ref.future, completion(21)); - }); - }); - test('Supports void type', () async { // Regression test for https://github.com/rrousselGit/riverpod/issues/2028 final testProvider = FutureProvider((ref) async { @@ -79,9 +30,9 @@ void main() { final autoDispose = FutureProvider.autoDispose((ref) => 0); final container = ProviderContainer.test( overrides: [ - provider.overrideWith((FutureProviderRef ref) => 42), + provider.overrideWith((Ref> ref) => 42), autoDispose.overrideWith( - (FutureProviderRef ref) => 84, + (Ref> ref) => 84, ), ], ); @@ -136,10 +87,10 @@ void main() { final container = ProviderContainer.test( overrides: [ family.overrideWith( - (FutureProviderRef ref, int arg) => '42 $arg', + (Ref> ref, int arg) => '42 $arg', ), autoDisposeFamily.overrideWith( - (FutureProviderRef ref, int arg) => '84 $arg', + (Ref> ref, int arg) => '84 $arg', ), ], ); @@ -290,7 +241,7 @@ void main() { test('can read and set current AsyncValue', () { final container = ProviderContainer.test(); final listener = Listener>(); - late FutureProviderRef ref; + late Ref> ref; final provider = FutureProvider((r) { ref = r; return 0; From 4810760ad16906b6b6a64438005b137fce337f6e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 28 Feb 2024 21:11:18 +0100 Subject: [PATCH 246/387] Rename generics --- .../lib/src/core/consumer.dart | 3 +- .../lib/src/core/widget_ref.dart | 3 + .../riverpod/lib/src/core/async_value.dart | 118 +++++++++--------- packages/riverpod/lib/src/core/element.dart | 38 +++--- .../riverpod/lib/src/core/foundation.dart | 12 +- .../lib/src/core/modifiers/select.dart | 42 +++---- .../lib/src/core/modifiers/select_async.dart | 28 ++--- .../lib/src/core/override_with_value.dart | 12 +- .../lib/src/core/provider/provider.dart | 5 +- .../lib/src/core/provider_subscription.dart | 26 ++-- .../src/core/proxy_provider_listenable.dart | 26 ++-- packages/riverpod/lib/src/core/ref.dart | 8 +- .../src/providers/async_notifier/family.dart | 9 +- .../src/providers/async_notifier/orphan.dart | 6 +- .../providers/legacy/state_controller.dart | 8 +- .../src/providers/legacy/state_provider.dart | 4 +- .../lib/src/providers/notifier/orphan.dart | 6 +- .../src/providers/stream_notifier/family.dart | 9 +- .../src/providers/stream_notifier/orphan.dart | 6 +- packages/riverpod/test/meta_test.dart | 1 - 20 files changed, 188 insertions(+), 182 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/core/consumer.dart b/packages/flutter_riverpod/lib/src/core/consumer.dart index 4740b95fd..fc5b107cc 100644 --- a/packages/flutter_riverpod/lib/src/core/consumer.dart +++ b/packages/flutter_riverpod/lib/src/core/consumer.dart @@ -340,8 +340,7 @@ abstract class ConsumerStatefulWidget extends StatefulWidget { /// ``` abstract class ConsumerState extends State { - // TODO change this doc - /// An object that allows widgets to interact with providers. + /// {@macro flutter_riverpod.widget_ref} late final WidgetRef ref = context as WidgetRef; } diff --git a/packages/flutter_riverpod/lib/src/core/widget_ref.dart b/packages/flutter_riverpod/lib/src/core/widget_ref.dart index a0c6b7079..b46f9b45e 100644 --- a/packages/flutter_riverpod/lib/src/core/widget_ref.dart +++ b/packages/flutter_riverpod/lib/src/core/widget_ref.dart @@ -1,6 +1,9 @@ part of '../core.dart'; +// TODO change this doc +/// {@template flutter_riverpod.widget_ref} /// An object that allows widgets to interact with providers. +/// {@endtemplate} abstract class WidgetRef { /// The [BuildContext] of the widget associated to this [WidgetRef]. /// diff --git a/packages/riverpod/lib/src/core/async_value.dart b/packages/riverpod/lib/src/core/async_value.dart index bee1a0e2e..82530a552 100644 --- a/packages/riverpod/lib/src/core/async_value.dart +++ b/packages/riverpod/lib/src/core/async_value.dart @@ -8,14 +8,14 @@ import '../providers/stream_provider.dart' show StreamProvider; /// An extension for [asyncTransition]. @internal -extension AsyncTransition on ProviderElementBase> { +extension AsyncTransition on ProviderElementBase> { /// Internal utility for transitioning an [AsyncValue] after a provider refresh. /// /// [seamless] controls how the previous state is preserved: /// - seamless:true => import previous state and skip loading /// - seamless:false => import previous state and prefer loading void asyncTransition( - AsyncValue newState, { + AsyncValue newState, { required bool seamless, }) { // ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member @@ -28,7 +28,9 @@ extension AsyncTransition on ProviderElementBase> { // ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member setStateResult( ResultData( - newState._cast().copyWithPrevious(previous, isRefresh: seamless), + newState + ._cast() + .copyWithPrevious(previous, isRefresh: seamless), ), ); } @@ -86,14 +88,14 @@ extension AsyncTransition on ProviderElementBase> { /// - [AsyncValue.guard], to simplify transforming a [Future] into an [AsyncValue]. @sealed @immutable -sealed class AsyncValue { +sealed class AsyncValue { const AsyncValue._(); /// {@template async_value.data} /// Creates an [AsyncValue] with a data. /// {@endtemplate} // coverage:ignore-start - const factory AsyncValue.data(T value) = AsyncData; + const factory AsyncValue.data(StateT value) = AsyncData; // coverage:ignore-end /// {@template async_value.loading} @@ -102,7 +104,7 @@ sealed class AsyncValue { /// Prefer always using this constructor with the `const` keyword. /// {@endtemplate} // coverage:ignore-start - const factory AsyncValue.loading() = AsyncLoading; + const factory AsyncValue.loading() = AsyncLoading; // coverage:ignore-end /// {@template async_value.error_ctor} @@ -117,7 +119,7 @@ sealed class AsyncValue { /// {@endtemplate} // coverage:ignore-start const factory AsyncValue.error(Object error, StackTrace stackTrace) = - AsyncError; + AsyncError; // coverage:ignore-end /// Transforms a [Future] that may fail into something that is safe to read. @@ -212,7 +214,7 @@ sealed class AsyncValue { /// ```dart /// ref.watch(provider).unwrapPrevious().value; /// ``` - T? get value; + StateT? get value; /// The [error]. Object? get error; @@ -227,8 +229,8 @@ sealed class AsyncValue { /// Finally if in loading state, throws a [StateError]. /// /// This is typically used for when the UI assumes that [value] is always present. - T get requireValue { - if (hasValue) return value as T; + StateT get requireValue { + if (hasValue) return value as StateT; if (hasError) { throwErrorWithCombinedStackTrace(error!, stackTrace!); } @@ -273,7 +275,7 @@ sealed class AsyncValue { /// /// Note that an [AsyncData] may still be in loading/error state, such /// as during a pull-to-refresh. - AsyncData? get asData { + AsyncData? get asData { return map( data: (d) => d, error: (e) => null, @@ -286,7 +288,7 @@ sealed class AsyncValue { /// /// Note that an [AsyncError] may still be in loading state, such /// as during a pull-to-refresh. - AsyncError? get asError => map( + AsyncError? get asError => map( data: (_) => null, error: (e) => e, loading: (_) => null, @@ -297,9 +299,9 @@ sealed class AsyncValue { /// This allows reading the content of an [AsyncValue] in a type-safe way, /// without potentially ignoring to handle a case. R map({ - required R Function(AsyncData data) data, - required R Function(AsyncError error) error, - required R Function(AsyncLoading loading) loading, + required R Function(AsyncData data) data, + required R Function(AsyncError error) error, + required R Function(AsyncLoading loading) loading, }); /// Casts the [AsyncValue] to a different type. @@ -309,7 +311,7 @@ sealed class AsyncValue { /// /// For loading/error cases, creates a new [AsyncValue] with the corresponding /// generic type while preserving the error/stacktrace. - AsyncValue whenData(R Function(T value) cb) { + AsyncValue whenData(R Function(StateT value) cb) { return map( data: (d) { try { @@ -350,7 +352,7 @@ sealed class AsyncValue { bool skipLoadingOnReload = false, bool skipLoadingOnRefresh = true, bool skipError = false, - R Function(T data)? data, + R Function(StateT data)? data, R Function(Object error, StackTrace stackTrace)? error, R Function()? loading, required R Function() orElse, @@ -396,7 +398,7 @@ sealed class AsyncValue { bool skipLoadingOnReload = false, bool skipLoadingOnRefresh = true, bool skipError = false, - required R Function(T data) data, + required R Function(StateT data) data, required R Function(Object error, StackTrace stackTrace) error, required R Function() loading, }) { @@ -429,7 +431,7 @@ sealed class AsyncValue { bool skipLoadingOnReload = false, bool skipLoadingOnRefresh = true, bool skipError = false, - R? Function(T data)? data, + R? Function(StateT data)? data, R? Function(Object error, StackTrace stackTrace)? error, R? Function()? loading, }) { @@ -446,9 +448,9 @@ sealed class AsyncValue { /// Perform some actions based on the state of the [AsyncValue], or call orElse /// if the current state was not tested. R maybeMap({ - R Function(AsyncData data)? data, - R Function(AsyncError error)? error, - R Function(AsyncLoading loading)? loading, + R Function(AsyncData data)? data, + R Function(AsyncError error)? error, + R Function(AsyncLoading loading)? loading, required R Function() orElse, }) { return map( @@ -470,9 +472,9 @@ sealed class AsyncValue { /// Perform some actions based on the state of the [AsyncValue], or return null /// if the current state wasn't tested. R? mapOrNull({ - R? Function(AsyncData data)? data, - R? Function(AsyncError error)? error, - R? Function(AsyncLoading loading)? loading, + R? Function(AsyncData data)? data, + R? Function(AsyncError error)? error, + R? Function(AsyncLoading loading)? loading, }) { return map( data: (d) => data?.call(d), @@ -493,24 +495,24 @@ sealed class AsyncValue { /// or instead by [Ref.watch] (if false). /// This changes the default behavior of [when] and sets the [isReloading]/ /// [isRefreshing] flags accordingly. - AsyncValue copyWithPrevious( - AsyncValue previous, { + AsyncValue copyWithPrevious( + AsyncValue previous, { bool isRefresh = true, }); /// The opposite of [copyWithPrevious], reverting to the raw [AsyncValue] /// with no information on the previous state. - AsyncValue unwrapPrevious() { + AsyncValue unwrapPrevious() { return map( data: (d) { - if (d.isLoading) return AsyncLoading(); + if (d.isLoading) return AsyncLoading(); return AsyncData(d.value); }, error: (e) { - if (e.isLoading) return AsyncLoading(); + if (e.isLoading) return AsyncLoading(); return AsyncError(e.error, e.stackTrace); }, - loading: (l) => AsyncLoading(), + loading: (l) => AsyncLoading(), ); } @@ -525,13 +527,13 @@ sealed class AsyncValue { ], ].join(', '); - return '$_displayString<$T>($content)'; + return '$_displayString<$StateT>($content)'; } @override bool operator ==(Object other) { return runtimeType == other.runtimeType && - other is AsyncValue && + other is AsyncValue && other.isLoading == isLoading && other.hasValue == hasValue && other.error == error && @@ -551,9 +553,9 @@ sealed class AsyncValue { } /// {@macro async_value.data} -final class AsyncData extends AsyncValue { +final class AsyncData extends AsyncValue { /// {@macro async_value.data} - const AsyncData(T value) + const AsyncData(StateT value) : this._( value, isLoading: false, @@ -575,7 +577,7 @@ final class AsyncData extends AsyncValue { bool get hasValue => true; @override - final T value; + final StateT value; @override @override @@ -589,16 +591,16 @@ final class AsyncData extends AsyncValue { @override R map({ - required R Function(AsyncData data) data, - required R Function(AsyncError error) error, - required R Function(AsyncLoading loading) loading, + required R Function(AsyncData data) data, + required R Function(AsyncError error) error, + required R Function(AsyncLoading loading) loading, }) { return data(this); } @override - AsyncData copyWithPrevious( - AsyncValue previous, { + AsyncData copyWithPrevious( + AsyncValue previous, { bool isRefresh = true, }) { return this; @@ -606,7 +608,7 @@ final class AsyncData extends AsyncValue { @override AsyncValue _cast() { - if (T == R) return this as AsyncValue; + if (StateT == R) return this as AsyncValue; return AsyncData._( value as R, isLoading: isLoading, @@ -617,7 +619,7 @@ final class AsyncData extends AsyncValue { } /// {@macro async_value.loading} -final class AsyncLoading extends AsyncValue { +final class AsyncLoading extends AsyncValue { /// {@macro async_value.loading} const AsyncLoading() : hasValue = false, @@ -643,7 +645,7 @@ final class AsyncLoading extends AsyncValue { final bool hasValue; @override - final T? value; + final StateT? value; @override final Object? error; @@ -653,7 +655,7 @@ final class AsyncLoading extends AsyncValue { @override AsyncValue _cast() { - if (T == R) return this as AsyncValue; + if (StateT == R) return this as AsyncValue; return AsyncLoading._( hasValue: hasValue, value: value as R?, @@ -664,16 +666,16 @@ final class AsyncLoading extends AsyncValue { @override R map({ - required R Function(AsyncData data) data, - required R Function(AsyncError error) error, - required R Function(AsyncLoading loading) loading, + required R Function(AsyncData data) data, + required R Function(AsyncError error) error, + required R Function(AsyncLoading loading) loading, }) { return loading(this); } @override - AsyncValue copyWithPrevious( - AsyncValue previous, { + AsyncValue copyWithPrevious( + AsyncValue previous, { bool isRefresh = true, }) { if (isRefresh) { @@ -714,7 +716,7 @@ final class AsyncLoading extends AsyncValue { } /// {@macro async_value.error_ctor} -final class AsyncError extends AsyncValue { +final class AsyncError extends AsyncValue { /// {@macro async_value.error_ctor} const AsyncError(Object error, StackTrace stackTrace) : this._( @@ -743,7 +745,7 @@ final class AsyncError extends AsyncValue { final bool hasValue; @override - final T? value; + final StateT? value; @override final Object error; @@ -753,7 +755,7 @@ final class AsyncError extends AsyncValue { @override AsyncValue _cast() { - if (T == R) return this as AsyncValue; + if (StateT == R) return this as AsyncValue; return AsyncError._( error, stackTrace: stackTrace, @@ -765,16 +767,16 @@ final class AsyncError extends AsyncValue { @override R map({ - required R Function(AsyncData data) data, - required R Function(AsyncError error) error, - required R Function(AsyncLoading loading) loading, + required R Function(AsyncData data) data, + required R Function(AsyncError error) error, + required R Function(AsyncLoading loading) loading, }) { return error(this); } @override - AsyncError copyWithPrevious( - AsyncValue previous, { + AsyncError copyWithPrevious( + AsyncValue previous, { bool isRefresh = true, }) { return AsyncError._( diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 2a17ccd67..f38bdc3fb 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -16,9 +16,9 @@ part of '../framework.dart'; /// ref.watch(provider.select((value) => value)); /// ``` /// {@endtemplate} -sealed class Refreshable implements ProviderListenable {} +sealed class Refreshable implements ProviderListenable {} -mixin _ProviderRefreshable implements Refreshable { +mixin _ProviderRefreshable implements Refreshable { ProviderBase get provider; } @@ -42,7 +42,7 @@ void Function()? debugCanModifyProviders; /// {@endtemplate} // TODO rename to ProviderElement @internal -abstract class ProviderElementBase implements Ref, Node { +abstract class ProviderElementBase implements Ref, Node { /// {@macro riverpod.provider_element_base} // TODO changelog: ProviderElement no-longer takes a provider as parameter but takes a ProviderContainer ProviderElementBase(this.container); @@ -50,10 +50,10 @@ abstract class ProviderElementBase implements Ref, Node { static ProviderElementBase? _debugCurrentlyBuildingElement; @override - State get state => readSelf(); + StateT get state => readSelf(); @override - set state(State newState) => setStateResult(ResultData(newState)); + set state(StateT newState) => setStateResult(ResultData(newState)); /// The last result of [ProviderBase.debugGetCreateSourceHash]. /// @@ -68,7 +68,7 @@ abstract class ProviderElementBase implements Ref, Node { /// The provider associated with this [ProviderElementBase], after applying overrides. // TODO changelog ProviderElement.provider is now abstract - ProviderBase get provider; + ProviderBase get provider; /// The [ProviderContainer] that owns this [ProviderElementBase]. @override @@ -89,7 +89,7 @@ abstract class ProviderElementBase implements Ref, Node { /// This is typically Flutter widgets or manual calls to [ProviderContainer.listen] /// with this provider as target. // TODO(rrousselGit) refactor to match ChangeNotifier - final _externalDependents = <_ExternalProviderSubscription>[]; + final _externalDependents = <_ExternalProviderSubscription>[]; /// The [ProviderSubscription]s associated to the providers that this /// [ProviderElementBase] listens to. @@ -114,7 +114,7 @@ abstract class ProviderElementBase implements Ref, Node { List? _onCancelListeners; List? _onAddListeners; List? _onRemoveListeners; - List? _onChangeSelfListeners; + List? _onChangeSelfListeners; List? _onErrorSelfListeners; bool _mustRecomputeState = false; @@ -139,7 +139,7 @@ abstract class ProviderElementBase implements Ref, Node { List? _keepAliveLinks; /* STATE */ - Result? _stateResult; + Result? _stateResult; /// The current state of the provider. /// @@ -153,7 +153,7 @@ abstract class ProviderElementBase implements Ref, Node { /// This is not meant for public consumption. Instead, public API should use /// [readSelf]. @internal - Result? get stateResult => _stateResult; + Result? get stateResult => _stateResult; /// Update the exposed value of a provider and notify its listeners. /// @@ -163,7 +163,7 @@ abstract class ProviderElementBase implements Ref, Node { /// This API is not meant for public consumption. Instead if a [Ref] needs /// to expose a way to update the state, the practice is to expose a getter/setter. @internal - void setStateResult(Result newState) { + void setStateResult(Result newState) { if (kDebugMode) _debugDidSetState = true; final previousResult = stateResult; @@ -182,7 +182,7 @@ abstract class ProviderElementBase implements Ref, Node { /// This is not meant for public consumption. Instead, public API should use /// [readSelf]. @internal - State get requireState { + StateT get requireState { const uninitializedError = ''' Tried to read the state of an uninitialized provider. This could mean a few things: @@ -208,7 +208,7 @@ This could mean a few things: /// Called when a provider is rebuilt. Used for providers to not notify their /// listeners if the exposed value did not change. @internal - bool updateShouldNotify(State previous, State next); + bool updateShouldNotify(StateT previous, StateT next); /* /STATE */ @@ -298,7 +298,7 @@ This could mean a few things: /// - `overrideWithValue`, which relies on [update] to handle /// the scenario where the value changed. @visibleForOverriding - void update(ProviderBase newProvider) {} + void update(ProviderBase newProvider) {} @override void invalidate(ProviderOrFamily providerOrFamily) { @@ -470,8 +470,8 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } void _notifyListeners( - Result newState, - Result? previousStateResult, { + Result newState, + Result? previousStateResult, { bool checkUpdateShouldNotify = true, }) { if (kDebugMode) _debugAssertNotificationAllowed(); @@ -511,7 +511,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu previousStateResult.hasState && newState.hasState && !updateShouldNotify( - previousState as State, + previousState as StateT, newState.requireState, )) { return; @@ -774,7 +774,7 @@ final = Provider(dependencies: []); @override void listenSelf( - void Function(State? previous, State next) listener, { + void Function(StateT? previous, StateT next) listener, { void Function(Object error, StackTrace stackTrace)? onError, }) { // TODO do we want to expose a way to close the subscription? @@ -807,7 +807,7 @@ final = Provider(dependencies: []); /// Returns the currently exposed by a provider /// /// May throw if the provider threw when creating the exposed value. - State readSelf() { + StateT readSelf() { flush(); return requireState; diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index a2e5107f5..e578e1941 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -172,12 +172,12 @@ String shortHash(Object? object) { /// /// Should override ==/hashCode when possible @immutable -mixin ProviderListenable implements ProviderListenableOrFamily { +mixin ProviderListenable implements ProviderListenableOrFamily { /// Starts listening to this transformer - ProviderSubscription addListener( + ProviderSubscription addListener( // TODO remove Node and pass directly the listened Element Node node, - void Function(State? previous, State next) listener, { + void Function(StateT? previous, StateT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, // TODO remove required void Function()? onDependencyMayHaveChanged, @@ -185,7 +185,7 @@ mixin ProviderListenable implements ProviderListenableOrFamily { }); /// Obtains the result of this provider expression without adding listener. - State read(Node node); + StateT read(Node node); /// Partially listen to a provider. /// @@ -253,9 +253,9 @@ mixin ProviderListenable implements ProviderListenableOrFamily { /// This will further optimize our widget by rebuilding it only when "isAdult" /// changed instead of whenever the age changes. ProviderListenable select( - Selected Function(State value) selector, + Selected Function(StateT value) selector, ) { - return _ProviderSelector( + return _ProviderSelector( provider: this, selector: selector, ); diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index 3c65bc63b..9aa3fa6cc 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -5,9 +5,9 @@ part of '../../framework.dart'; @internal abstract class Node { /// Starts listening to this transformer - ProviderSubscription listen( - ProviderListenable listenable, - void Function(State? previous, State next) listener, { + ProviderSubscription listen( + ProviderListenable listenable, + void Function(StateT? previous, StateT next) listener, { void Function(Object error, StackTrace stackTrace)? onError, bool fireImmediately = false, }); @@ -18,21 +18,21 @@ abstract class Node { /// /// Do not use this in production code. This is exposed only for testing /// and devtools, to be able to test if a provider has listeners or similar. - ProviderElementBase readProviderElement( - ProviderBase provider, + ProviderElementBase readProviderElement( + ProviderBase provider, ); /// Subscribes to a [ProviderElementBase]. - ProviderSubscription _listenElement( - ProviderElementBase element, { - required void Function(State? previous, State next) listener, + ProviderSubscription _listenElement( + ProviderElementBase element, { + required void Function(StateT? previous, StateT next) listener, required void Function(Object error, StackTrace stackTrace) onError, }); } /// An internal class for `ProviderBase.select`. @sealed -class _ProviderSelector with ProviderListenable { +class _ProviderSelector with ProviderListenable { /// An internal class for `ProviderBase.select`. _ProviderSelector({ required this.provider, @@ -40,12 +40,12 @@ class _ProviderSelector with ProviderListenable { }); /// The provider that was selected - final ProviderListenable provider; + final ProviderListenable provider; /// The selector applied - final Output Function(Input) selector; + final OutputT Function(InputT) selector; - Result _select(Result value) { + Result _select(Result value) { if (kDebugMode) _debugIsRunningSelector = true; try { @@ -63,11 +63,11 @@ class _ProviderSelector with ProviderListenable { } void _selectOnChange({ - required Input newState, - required Result lastSelectedValue, + required InputT newState, + required Result lastSelectedValue, required void Function(Object error, StackTrace stackTrace) onError, - required void Function(Output? prev, Output next) listener, - required void Function(Result newState) onChange, + required void Function(OutputT? prev, OutputT next) listener, + required void Function(Result newState) onChange, }) { final newSelectedValue = _select(Result.data(newState)); if (!lastSelectedValue.hasState || @@ -91,18 +91,18 @@ class _ProviderSelector with ProviderListenable { } @override - _SelectorSubscription addListener( + _SelectorSubscription addListener( Node node, - void Function(Output? previous, Output next) listener, { + void Function(OutputT? previous, OutputT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, }) { onError ??= Zone.current.handleUncaughtError; - late Result lastSelectedValue; + late Result lastSelectedValue; - final sub = node.listen( + final sub = node.listen( provider, (prev, input) { _selectOnChange( @@ -141,7 +141,7 @@ class _ProviderSelector with ProviderListenable { } @override - Output read(Node node) { + OutputT read(Node node) { final input = provider.read(node); return selector(input); } diff --git a/packages/riverpod/lib/src/core/modifiers/select_async.dart b/packages/riverpod/lib/src/core/modifiers/select_async.dart index b2b7f1a65..21d48c2b6 100644 --- a/packages/riverpod/lib/src/core/modifiers/select_async.dart +++ b/packages/riverpod/lib/src/core/modifiers/select_async.dart @@ -2,7 +2,7 @@ part of '../../framework.dart'; /// An internal class for `ProviderBase.selectAsync`. @sealed -class _AsyncSelector with ProviderListenable> { +class _AsyncSelector with ProviderListenable> { /// An internal class for `ProviderBase.select`. _AsyncSelector({ required this.provider, @@ -11,15 +11,15 @@ class _AsyncSelector with ProviderListenable> { }); /// The provider that was selected - final ProviderListenable> provider; + final ProviderListenable> provider; /// The future associated to the listened provider - final ProviderListenable> future; + final ProviderListenable> future; /// The selector applied - final Output Function(Input) selector; + final OutputT Function(InputT) selector; - Result _select(Input value) { + Result _select(InputT value) { if (kDebugMode) _debugIsRunningSelector = true; try { @@ -32,18 +32,18 @@ class _AsyncSelector with ProviderListenable> { } @override - _SelectorSubscription, Future> addListener( + _SelectorSubscription, Future> addListener( Node node, - void Function(Future? previous, Future next) listener, { + void Function(Future? previous, Future next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, }) { - Result? lastSelectedValue; - Completer? selectedCompleter; - Future? selectedFuture; + Result? lastSelectedValue; + Completer? selectedCompleter; + Future? selectedFuture; - void emitData(Output data, {required bool callListeners}) { + void emitData(OutputT data, {required bool callListeners}) { final previousFuture = selectedFuture; if (selectedCompleter != null) { selectedCompleter!.complete(data); @@ -70,7 +70,7 @@ class _AsyncSelector with ProviderListenable> { } void playValue( - AsyncValue value, { + AsyncValue value, { bool callListeners = true, }) { void onLoading(AsyncValue loading) { @@ -134,7 +134,7 @@ class _AsyncSelector with ProviderListenable> { ); } - final sub = node.listen>( + final sub = node.listen>( provider, (prev, input) => playValue(input), onError: onError, @@ -153,5 +153,5 @@ class _AsyncSelector with ProviderListenable> { } @override - Future read(Node node) => future.read(node).then(selector); + Future read(Node node) => future.read(node).then(selector); } diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index e7e2c186d..9b92a6f7e 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -33,25 +33,25 @@ final class $ValueProvider extends ProviderBase } /// The [ProviderElementBase] of a [$ValueProvider] -class _ValueProviderElement extends ProviderElementBase { +class _ValueProviderElement extends ProviderElementBase { /// The [ProviderElementBase] of a [$ValueProvider] _ValueProviderElement(this.provider, super.container); /// A custom listener called when `overrideWithValue` changes /// with a different value. - void Function(State value)? onChange; + void Function(StateT value)? onChange; @override - $ValueProvider provider; + $ValueProvider provider; @override - void update(covariant $ValueProvider newProvider) { + void update(covariant $ValueProvider newProvider) { super.update(newProvider); provider = newProvider; final newValue = provider._value; // `getState` will never be in error/loading state since there is no "create" - final previousState = stateResult! as ResultData; + final previousState = stateResult! as ResultData; if (newValue != previousState.state) { // Asserts would otherwise prevent a provider rebuild from updating @@ -74,7 +74,7 @@ class _ValueProviderElement extends ProviderElementBase { } @override - bool updateShouldNotify(State previous, State next) { + bool updateShouldNotify(StateT previous, StateT next) { return true; } } diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index e2935be06..528b69b0d 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -13,7 +13,9 @@ part of '../../framework.dart'; /// - [Ref], which exposes the methods to read other providers. /// - [Provider], a provider that uses [Create] to expose an immutable value. @internal -typedef Create> = T Function(R ref); +typedef Create> = CreatedT Function( + RefT ref, +); /// A callback used to catches errors @internal @@ -21,7 +23,6 @@ typedef OnError = void Function(Object, StackTrace); /// A base class for _all_ providers. @immutable -// TODO rename all generics to // Marked as "base" because linters/generators rely on fields on const provider instances. abstract base class ProviderBase extends ProviderOrFamily with ProviderListenable diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index 03a386ae9..8bfcb1399 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -1,17 +1,17 @@ part of '../framework.dart'; /// Represents the subscription to a [ProviderListenable] -abstract class ProviderSubscription { +abstract class ProviderSubscription { /// Stops listening to the provider @mustCallSuper void close(); /// Obtain the latest value emitted by the provider - State read(); + StateT read(); } /// When a provider listens to another provider using `listen` -class _ProviderListener implements ProviderSubscription { +class _ProviderListener implements ProviderSubscription { _ProviderListener._({ required this.listenedElement, required this.dependentElement, @@ -22,7 +22,7 @@ class _ProviderListener implements ProviderSubscription { // TODO can't we type it properly? final void Function(Object? prev, Object? state) listener; final ProviderElementBase dependentElement; - final ProviderElementBase listenedElement; + final ProviderElementBase listenedElement; final OnError onError; @override @@ -34,21 +34,21 @@ class _ProviderListener implements ProviderSubscription { } @override - State read() => listenedElement.readSelf(); + StateT read() => listenedElement.readSelf(); } var _debugIsRunningSelector = false; -class _ExternalProviderSubscription - implements ProviderSubscription { +class _ExternalProviderSubscription + implements ProviderSubscription { _ExternalProviderSubscription._( this._listenedElement, this._listener, { required this.onError, }); - final void Function(State? previous, State next) _listener; - final ProviderElementBase _listenedElement; + final void Function(StateT? previous, StateT next) _listener; + final ProviderElementBase _listenedElement; final void Function(Object error, StackTrace stackTrace) onError; var _closed = false; @@ -60,7 +60,7 @@ class _ExternalProviderSubscription } @override - State read() { + StateT read() { if (_closed) { throw StateError( 'called ProviderSubscription.read on a subscription that was closed', @@ -72,9 +72,9 @@ class _ExternalProviderSubscription /// Deals with the internals of synchronously calling the listeners /// when using `fireImmediately: true` -void _handleFireImmediately( - Result currentState, { - required void Function(State? previous, State current) listener, +void _handleFireImmediately( + Result currentState, { + required void Function(StateT? previous, StateT current) listener, required void Function(Object error, StackTrace stackTrace) onError, }) { currentState.map( diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index dcb0f1d2f..b3ca927b2 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -1,6 +1,6 @@ part of '../framework.dart'; -class _ProxySubscription extends ProviderSubscription { +class _ProxySubscription extends ProviderSubscription { _ProxySubscription( this._removeListeners, this._read, { @@ -9,7 +9,7 @@ class _ProxySubscription extends ProviderSubscription { final ProviderSubscription innerSubscription; final void Function() _removeListeners; - final T Function() _read; + final StateT Function() _read; @override void close() { @@ -18,7 +18,7 @@ class _ProxySubscription extends ProviderSubscription { } @override - T read() => _read(); + StateT read() => _read(); } /// An internal utility for reading alternate values of a provider. @@ -37,8 +37,8 @@ class _ProxySubscription extends ProviderSubscription { /// /// This API is not meant for public consumption. @internal -class ProviderElementProxy - with ProviderListenable, _ProviderRefreshable { +class ProviderElementProxy + with ProviderListenable, _ProviderRefreshable { /// An internal utility for reading alternate values of a provider. /// /// For example, this is used by [FutureProvider] to differentiate: @@ -57,15 +57,15 @@ class ProviderElementProxy const ProviderElementProxy(this.provider, this._lense); @override - final ProviderBase provider; - final ProxyElementValueListenable Function( - ProviderElementBase element, + final ProviderBase provider; + final ProxyElementValueListenable Function( + ProviderElementBase element, ) _lense; @override - ProviderSubscription addListener( + ProviderSubscription addListener( Node node, - void Function(Output? previous, Output next) listener, { + void Function(OutputT? previous, OutputT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, @@ -100,7 +100,7 @@ class ProviderElementProxy () => read(node), // While we don't care about changes to the element, calling _listenElement // is necessary to tell the listened element that it is being listened. - innerSubscription: node._listenElement( + innerSubscription: node._listenElement( element, listener: (prev, next) {}, onError: (err, stack) {}, @@ -109,7 +109,7 @@ class ProviderElementProxy } @override - Output read(Node node) { + OutputT read(Node node) { final element = node.readProviderElement(provider); element.flush(); element._mayNeedDispose(); @@ -118,7 +118,7 @@ class ProviderElementProxy @override bool operator ==(Object other) => - other is ProviderElementProxy && + other is ProviderElementProxy && other.provider == provider; @override diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 357bfcad4..4a00d2725 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -9,7 +9,7 @@ part of '../framework.dart'; /// - [read] and [watch], two methods that allow a provider to consume other providers. /// - [onDispose], a method that allows performing a task when the provider is destroyed. /// {@endtemplate} -abstract class Ref { +abstract class Ref { // TODO changelog breaking: AutoDisposeRef and related interfaces are removed. // Use the non-autodispose variant instead. They now have the same API. @@ -22,8 +22,8 @@ abstract class Ref { /// - on asynchronous providers, this will return an [AsyncLoading]. /// /// Will throw if the provider threw during creation. - State get state; - set state(State newState); + StateT get state; + set state(StateT newState); /// The [ProviderContainer] that this provider is associated with. ProviderContainer get container; @@ -107,7 +107,7 @@ abstract class Ref { /// [ProviderElementBase.updateShouldNotify] returns false, meaning that the previous /// and new value can potentially be identical. void listenSelf( - void Function(State? previous, State next) listener, { + void Function(StateT? previous, StateT next) listener, { void Function(Object error, StackTrace stackTrace)? onError, }); diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index b6a354f09..36879719d 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -3,7 +3,8 @@ part of '../async_notifier.dart'; /// {@macro riverpod.async_notifier} /// /// {@macro riverpod.async_notifier_provider_modifier} -abstract class FamilyAsyncNotifier extends $AsyncNotifier { +abstract class FamilyAsyncNotifier + extends $AsyncNotifier { /// {@template riverpod.notifier.family_arg} /// The argument that was passed to this family. /// @@ -15,15 +16,15 @@ abstract class FamilyAsyncNotifier extends $AsyncNotifier { /// /// then [arg] will be `0`. /// {@endtemplate} - late final Arg arg = (ref as ProviderElementBase).origin.argument as Arg; + late final ArgT arg = (ref as ProviderElementBase).origin.argument as ArgT; /// {@macro riverpod.async_notifier.build} @visibleForOverriding - FutureOr build(Arg arg); + FutureOr build(ArgT arg); @internal @override - FutureOr runBuild() => build(arg); + FutureOr runBuild() => build(arg); } /// The [Family] of [AsyncNotifierProvider]. diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index 2145bca99..7cd802786 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -16,7 +16,7 @@ part of '../async_notifier.dart'; /// {@endtemplate} /// /// {@macro riverpod.async_notifier_provider_modifier} -abstract class AsyncNotifier extends $AsyncNotifier { +abstract class AsyncNotifier extends $AsyncNotifier { /// {@template riverpod.async_notifier.build} /// Initialize an [AsyncNotifier]. /// @@ -31,11 +31,11 @@ abstract class AsyncNotifier extends $AsyncNotifier { /// will be caught and an [AsyncError] will be emitted. /// {@endtemplate} @visibleForOverriding - FutureOr build(); + FutureOr build(); @internal @override - FutureOr runBuild() => build(); + FutureOr runBuild() => build(); } /// {@template riverpod.async_notifier_provider} diff --git a/packages/riverpod/lib/src/providers/legacy/state_controller.dart b/packages/riverpod/lib/src/providers/legacy/state_controller.dart index 32ada9304..7e8c3a8e6 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_controller.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_controller.dart @@ -3,16 +3,16 @@ import 'package:state_notifier/state_notifier.dart'; /// A [StateNotifier] that allows modifying its [state] from outside. /// /// This avoids having to make a [StateNotifier] subclass for simple scenarios. -class StateController extends StateNotifier { +class StateController extends StateNotifier { /// Initialize the state of [StateController]. StateController(super._state); // Remove the protected status @override - T get state => super.state; + StateT get state => super.state; @override - set state(T value) => super.state = value; + set state(StateT value) => super.state = value; /// Calls a function with the current [state] and assigns the result as the /// new state. @@ -29,5 +29,5 @@ class StateController extends StateNotifier { /// ```dart /// ref.read(provider.notifier).update((state) => state + 1); /// ``` - T update(T Function(T state) cb) => state = cb(state); + StateT update(StateT Function(StateT state) cb) => state = cb(state); } diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 93bcee12c..11aff9606 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -17,11 +17,11 @@ ProviderElementProxy> _notifier( /// {@macro riverpod.provider_ref_base} /// - [controller], the [StateController] currently exposed by this provider. -abstract class StateProviderRef implements Ref { +abstract class StateProviderRef implements Ref { /// The [StateController] currently exposed by this provider. /// /// Cannot be accessed while creating the provider. - StateController get controller; + StateController get controller; } /// {@template riverpod.state_provider} diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart index a60c242c7..d0d1df078 100644 --- a/packages/riverpod/lib/src/providers/notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -52,7 +52,7 @@ part of '../notifier.dart'; /// When using `family`, your notifier type changes. /// Instead of extending [Notifier], you should extend [FamilyNotifier]. /// {@endtemplate} -abstract class Notifier extends $Notifier { +abstract class Notifier extends $Notifier { /// {@template riverpod.notifier.build} /// Initialize a [Notifier]. /// @@ -66,11 +66,11 @@ abstract class Notifier extends $Notifier { /// If this method throws, reading this provider will rethrow the error. /// {@endtemplate} @visibleForOverriding - State build(); + StateT build(); @internal @override - State runBuild() => build(); + StateT runBuild() => build(); } final class NotifierProvider, StateT> diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index 481e56e75..6366073e8 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -3,7 +3,8 @@ part of '../stream_notifier.dart'; /// {@macro riverpod.async_notifier} /// /// {@macro riverpod.async_notifier_provider_modifier} -abstract class FamilyStreamNotifier extends $StreamNotifier { +abstract class FamilyStreamNotifier + extends $StreamNotifier { /// {@template riverpod.notifier.family_arg} /// The argument that was passed to this family. /// @@ -15,15 +16,15 @@ abstract class FamilyStreamNotifier extends $StreamNotifier { /// /// then [arg] will be `0`. /// {@endtemplate} - late final Arg arg = (ref as ProviderElementBase).origin.argument as Arg; + late final ArgT arg = (ref as ProviderElementBase).origin.argument as ArgT; /// {@macro riverpod.async_notifier.build} @visibleForOverriding - Stream build(Arg arg); + Stream build(ArgT arg); @internal @override - Stream runBuild() => build(arg); + Stream runBuild() => build(arg); } final class FamilyStreamNotifierProvider< // diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index 49b4b2451..3e612185c 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -15,14 +15,14 @@ part of '../stream_notifier.dart'; /// When using `family`, your notifier type changes. Instead of extending /// [StreamNotifier], you should extend [FamilyStreamNotifier]. /// {@endtemplate} -abstract class StreamNotifier extends $StreamNotifier { +abstract class StreamNotifier extends $StreamNotifier { /// {@macro riverpod.async_notifier.build} @visibleForOverriding - Stream build(); + Stream build(); @internal @override - Stream runBuild() => build(); + Stream runBuild() => build(); } /// {@template riverpod.async_notifier_provider} diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index 723664e44..423bf0797 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -45,7 +45,6 @@ void main() { 'AsyncData', 'AsyncLoading', 'AsyncError', - // TODO rename 'ProviderBase', 'NotifierBase', 'Refreshable', From f6d0dea06f7f94ed32275b0c5f33ed57abd61474 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 28 Feb 2024 21:13:45 +0100 Subject: [PATCH 247/387] Update todos --- packages/riverpod/lib/legacy.dart | 1 - packages/riverpod/lib/src/core/modifiers/future.dart | 2 -- .../riverpod_analyzer_utils/lib/src/element_util.dart | 11 ++--------- .../scoped_providers_should_specify_dependencies.dart | 1 + 4 files changed, 3 insertions(+), 12 deletions(-) diff --git a/packages/riverpod/lib/legacy.dart b/packages/riverpod/lib/legacy.dart index 091559090..d9465bf23 100644 --- a/packages/riverpod/lib/legacy.dart +++ b/packages/riverpod/lib/legacy.dart @@ -1,4 +1,3 @@ -// TODO add to flutter_riverpod and hooks_riverpod too // TODO CHANGELOG breaking: Riverpod now only re-exports StateNotifier from pkg:state_notifier. // for other classes, please add state_notifier as dependency. export 'package:state_notifier/state_notifier.dart' show StateNotifier; diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 067f350df..596b932c5 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -72,8 +72,6 @@ mixin $AsyncClassModifier FutureOr Function(StateT previousState) cb, { FutureOr Function(Object err, StackTrace stackTrace)? onError, }) async { - // TODO cancel on rebuild? - final newState = await future.then(cb, onError: onError); state = AsyncData(newState); return newState; diff --git a/packages/riverpod_analyzer_utils/lib/src/element_util.dart b/packages/riverpod_analyzer_utils/lib/src/element_util.dart index 4049e354a..ca3f70f7e 100644 --- a/packages/riverpod_analyzer_utils/lib/src/element_util.dart +++ b/packages/riverpod_analyzer_utils/lib/src/element_util.dart @@ -14,14 +14,10 @@ extension LibraryElementX on CompilationUnit { LibraryElement? get _library => declaredElement?.library; - Element? findElementWithNameFromPackage( - String name, { - required String packageName, - }) { + Element? findElementWithNameFromRiverpod(String name) { return _library!.importedLibraries .map((e) => e.exportNamespace.get(name)) .firstWhereOrNull( - // TODO find a way to test this (element) => element != null && isFromRiverpod.isExactly(element), ); } @@ -30,10 +26,7 @@ extension LibraryElementX on CompilationUnit { final cache = _asyncValueCache[this]; if (cache != null) return cache; - final result = findElementWithNameFromPackage( - 'AsyncValue', - packageName: 'riverpod', - ); + final result = findElementWithNameFromRiverpod('AsyncValue'); if (result == null) { errorReporter( RiverpodAnalysisError( diff --git a/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart b/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart index 948260451..bb8b90cf4 100644 --- a/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart +++ b/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart @@ -105,6 +105,7 @@ class ScopedProvidersShouldSpecifyDependencies extends RiverpodLintRule { ) { final hasParentParameter = expression.node.argumentList.arguments .whereType() + // TODO move to riverpod_analyzer_utils // TODO handle parent:null. // This might be doable by checking that the expression's // static type is non-nullable From 5c2e96a019b65a6f17f6b149a8b2dab920eece53 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 28 Feb 2024 21:18:57 +0100 Subject: [PATCH 248/387] More todos --- packages/riverpod/test/third_party/fake_async.dart | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/riverpod/test/third_party/fake_async.dart b/packages/riverpod/test/third_party/fake_async.dart index c9f0b3e88..251510050 100644 --- a/packages/riverpod/test/third_party/fake_async.dart +++ b/packages/riverpod/test/third_party/fake_async.dart @@ -197,7 +197,6 @@ class FakeAsync { var absoluteTimeout = _elapsed + timeout; _fireTimersWhile((timer) { if (timer._nextCall > absoluteTimeout) { - // TODO(nweiz): Make this a [TimeoutException]. throw StateError('Exceeded timeout $timeout while flushing timers'); } From f36087777614465ba10cee5c67163297d0d8bf2b Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 28 Feb 2024 21:32:05 +0100 Subject: [PATCH 249/387] Add doc --- .../lib/src/core/provider_scope.dart | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/core/provider_scope.dart b/packages/flutter_riverpod/lib/src/core/provider_scope.dart index 86278b768..3826ac762 100644 --- a/packages/flutter_riverpod/lib/src/core/provider_scope.dart +++ b/packages/flutter_riverpod/lib/src/core/provider_scope.dart @@ -133,10 +133,23 @@ class ProviderScope extends StatefulWidget { /// The part of the widget tree that can use Riverpod and has overridden providers. final Widget child; - /// The listeners that subscribes to changes on providers stored on this [ProviderScope]. + /// The listeners that subscribe to changes on providers stored on this [ProviderScope]. + /// + /// See [ProviderObserver] for more information. final List? observers; /// Information on how to override a provider/family. + /// + /// This can be used either for: + /// - testing, such as to mock a provider + /// - dependency injection, to avoid having to pass a value to many + /// widgets in the widget tree. + /// - performance optimization: By using this to inject values to widgets + /// using `ref` inside of their constructor, widgets may be able to use + /// `const` constructors, which can improve performance. + /// + /// **Note**: Overrides only apply to this [ProviderScope] and its descendants. + /// Ancestors of this [ProviderScope] will not be affected by the overrides. final List overrides; @override @@ -144,13 +157,11 @@ class ProviderScope extends StatefulWidget { } /// Do not use: The [State] of [ProviderScope] -@visibleForTesting @sealed @internal class ProviderScopeState extends State { /// The [ProviderContainer] exposed to [ProviderScope.child]. @visibleForTesting - // ignore: diagnostic_describe_all_properties late final ProviderContainer container; ProviderContainer? _debugParentOwner; var _dirty = false; From eb9597366ffc831502c6eb41eb14be6f764778ae Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 28 Feb 2024 21:51:44 +0100 Subject: [PATCH 250/387] Update flutter_riverpod docs --- packages/flutter_riverpod/lib/src/core.dart | 1 - .../lib/src/core/provider_scope.dart | 8 +- .../lib/src/core/widget_ref.dart | 187 +++++++++++++++--- 3 files changed, 166 insertions(+), 30 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/core.dart b/packages/flutter_riverpod/lib/src/core.dart index 2cdebf013..203e43195 100644 --- a/packages/flutter_riverpod/lib/src/core.dart +++ b/packages/flutter_riverpod/lib/src/core.dart @@ -1,7 +1,6 @@ import 'package:flutter/foundation.dart' hide describeIdentity; import 'package:flutter/material.dart'; import 'package:flutter/scheduler.dart'; -import 'package:flutter/widgets.dart'; import 'package:meta/meta.dart'; import './internals.dart'; diff --git a/packages/flutter_riverpod/lib/src/core/provider_scope.dart b/packages/flutter_riverpod/lib/src/core/provider_scope.dart index 3826ac762..bf49fd285 100644 --- a/packages/flutter_riverpod/lib/src/core/provider_scope.dart +++ b/packages/flutter_riverpod/lib/src/core/provider_scope.dart @@ -157,9 +157,8 @@ class ProviderScope extends StatefulWidget { } /// Do not use: The [State] of [ProviderScope] -@sealed @internal -class ProviderScopeState extends State { +final class ProviderScopeState extends State { /// The [ProviderContainer] exposed to [ProviderScope.child]. @visibleForTesting late final ProviderContainer container; @@ -260,10 +259,9 @@ class ProviderScopeState extends State { /// {@template riverpod.UncontrolledProviderScope} /// Expose a [ProviderContainer] to the widget tree. /// -/// This is what makes `ref.watch(`/`Consumer`/`ref.read` work. +/// This is what makes `ref.watch`/`Consumer`/`ref.read` work. /// {@endtemplate} -@sealed -class UncontrolledProviderScope extends InheritedWidget { +final class UncontrolledProviderScope extends InheritedWidget { /// {@macro riverpod.UncontrolledProviderScope} const UncontrolledProviderScope({ super.key, diff --git a/packages/flutter_riverpod/lib/src/core/widget_ref.dart b/packages/flutter_riverpod/lib/src/core/widget_ref.dart index b46f9b45e..8497685c9 100644 --- a/packages/flutter_riverpod/lib/src/core/widget_ref.dart +++ b/packages/flutter_riverpod/lib/src/core/widget_ref.dart @@ -3,6 +3,40 @@ part of '../core.dart'; // TODO change this doc /// {@template flutter_riverpod.widget_ref} /// An object that allows widgets to interact with providers. +/// +/// [WidgetRef]s are typically obtained by using [ConsumerWidget] or its variants: +/// +/// ```dart +/// class Example extends ConsumerWidget { +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// // We now have a "ref" +/// } +/// } +/// ``` +/// +/// Once we have a [WidgetRef], we can use its various methods to interact with +/// providers. +/// The most common use-case is to use [watch] inside the `build` method of our +/// widgets. This will enable our UI to update whenever the state of a provider +/// changes: +/// +/// ```dart +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// final count = ref.watch(counterProvider); +/// // The text will automatically update whenever `counterProvider` emits a new value +/// return Text('$count'); +/// } +/// ``` +/// +/// **Note**: +/// Using a [WidgetRef] is equivalent to writing UI logic. +/// As such, [WidgetRef]s should not leave the widget layer. If you need to +/// interact with providers outside of the widget layer, consider using +/// a [Ref] instead. +/// +/// /// {@endtemplate} abstract class WidgetRef { /// The [BuildContext] of the widget associated to this [WidgetRef]. @@ -13,6 +47,66 @@ abstract class WidgetRef { /// Returns the value exposed by a provider and rebuild the widget when that /// value changes. /// + /// This method should only be used at the "root" of the `build` method of a widget. + /// + /// **Good**: Use [watch] inside the `build` method. + /// ```dart + /// class Example extends ConsumerWidget { + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// // Correct, we are inside the build method and at its root. + /// final count = ref.watch(counterProvider); + /// } + /// } + /// ``` + /// **Good**: It is accepted to use [watch] at the root of "builders" too. + /// ```dart + /// class Example extends ConsumerWidget { + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// return ListView.builder( + /// itemBuilder: (context) { + /// // This is accepted, as we are at the root of a "builder" + /// final count = ref.watch(counterProvider); + /// }, + /// ); + /// } + /// } + /// ``` + /// + /// **Bad**: Don't use [watch] outside of the `build` method. + /// ```dart + /// class Example extends ConsumerStatefulWidget { + /// @override + /// ExampleState createState() => ExampleState(); + /// } + /// + /// class ExampleState extends ConsumerState { + /// @override + /// void initState() { + /// super.initState(); + /// // Incorrect, we are not inside the build method. + /// final count = ref.watch(counterProvider); + /// } + /// } + /// ``` + /// + /// **Bad**: Don't use [watch] inside event handles withing `build` method. + /// ```dart + /// class Example extends ConsumerWidget { + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// return ElevatedButton( + /// onTap: () { + /// // Incorrect, we are inside the build method, but neither at its + /// // root, nor inside a "builder". + /// final count = ref.watch(counterProvider); + /// } + /// ); + /// } + /// } + /// ``` + /// /// See also: /// /// - [ProviderListenable.select], which allows a widget to filter rebuilds by @@ -56,23 +150,75 @@ abstract class WidgetRef { /// Listen to a provider and call `listener` whenever its value changes, /// without having to take care of removing the listener. /// - /// The [listen] method should exclusively be used within the `build` method - /// of a widget: + /// The [listen] method should exclusively be used at the root of the `build`: + /// + /// **Good**: Use [listen] inside the `build` method. + /// ```dart + /// class Example extends ConsumerWidget { + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// // Correct, we are inside the build method and at its root. + /// ref.listen(counterProvider, (prev, next) {}); + /// } + /// } + /// ``` + /// + /// **Bad**: Do not use [listen] inside builders. + /// ```dart + /// class Example extends ConsumerWidget { + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// return ListView.builder( + /// itemBuilder: (context) { + /// // This is accepted, as we are at the root of a "builder" + /// ref.listen(counterProvider, (prev, next) {}); + /// }, + /// ); + /// } + /// } + /// ``` + /// + /// **Bad**: Don't use [listen] outside of the `build` method. + /// ```dart + /// class Example extends ConsumerStatefulWidget { + /// @override + /// ExampleState createState() => ExampleState(); + /// } /// + /// class ExampleState extends ConsumerState { + /// @override + /// void initState() { + /// super.initState(); + /// // Incorrect, we are not inside the build method. + /// ref.listen(counterProvider, (prev, next) {}); + /// } + /// } + /// ``` + /// + /// **Bad**: Don't use [listen] inside event handles withing `build` method. /// ```dart - /// Consumer( - /// builder: (context, ref, child) { - /// ref.listen(counterProvider, (prev, next) { - /// print('counter changed $next'); - /// }); - /// }, - /// ) + /// class Example extends ConsumerWidget { + /// @override + /// Widget build(BuildContext context, WidgetRef ref) { + /// return ElevatedButton( + /// onTap: () { + /// // Incorrect, we are inside the build method, but neither at its + /// // root, nor inside a "builder". + /// ref.listen(counterProvider, (prev, next) {}); + /// } + /// ); + /// } + /// } /// ``` /// - /// When used inside `build`, listeners will automatically be removed - /// if a widget rebuilds and stops listening to a provider. + /// **Note**: + /// Listeners will automatically be removed if a widget rebuilds and stops + /// listening to a provider. /// - /// For listening to a provider from outside `build`, consider using [listenManual] instead. + /// See also: + /// - [listenManual], for listening to a provider from outside `build`. + /// - [watch], to listen to providers in a declarative manner. + /// - [read], to read a provider without listening to it. /// /// This is useful for showing modals or other imperative logic. void listen( @@ -150,7 +296,7 @@ abstract class WidgetRef { /// /// While the idea of not rebuilding the widget if unnecessary is good, /// this should not be done with [read]. - /// Relying on [read] for optimisations is very brittle and dependent + /// Relying on [read] for optimizations is very brittle and dependent /// on an implementation detail. /// /// **CONSIDER** using [Provider] or `select` for filtering unwanted rebuilds: @@ -173,13 +319,7 @@ abstract class WidgetRef { /// Forces a provider to re-evaluate its state immediately, and return the created value. /// - /// Writing: - /// - /// ```dart - /// final newValue = ref.refresh(provider); - /// ``` - /// - /// is strictly identical to doing: + /// Using [refresh] is strictly identical to using [invalidate] followed by [read] : /// /// ```dart /// ref.invalidate(provider); @@ -187,17 +327,16 @@ abstract class WidgetRef { /// ``` /// /// If you do not care about the return value of [refresh], use [invalidate] instead. - /// Doing so has the benefit of: + /// Doing so has the benefits of: /// - making the invalidation logic more resilient by avoiding multiple /// refreshes at once. - /// - possibly avoids recomputing a provider if it isn't - /// needed immediately. + /// - possibly avoiding recomputing a provider if it isn't needed immediately. /// /// This method is useful for features like "pull to refresh" or "retry on error", /// to restart a specific provider. /// /// For example, a pull-to-refresh may be implemented by combining - /// [FutureProvider] and a `RefreshIndicator`: + /// [FutureProvider] and a [RefreshIndicator] : /// /// ```dart /// final productsProvider = FutureProvider((ref) async { From 220a4974d5e2f555171845a74a31a0a1dd7c86da Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 28 Feb 2024 21:52:51 +0100 Subject: [PATCH 251/387] hooks_riverpod --- packages/hooks_riverpod/lib/src/consumer.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/hooks_riverpod/lib/src/consumer.dart b/packages/hooks_riverpod/lib/src/consumer.dart index 1b421c0c7..d35974c17 100644 --- a/packages/hooks_riverpod/lib/src/consumer.dart +++ b/packages/hooks_riverpod/lib/src/consumer.dart @@ -5,7 +5,7 @@ import 'internals.dart'; /// {@template hooks_riverpod.hook_consumer.hook_consumer_widget} /// A widget that can both use hooks and listen to providers. /// -/// If you do not need hooks, you can use [Consumer]. +/// If you do not need hooks, you can use [ConsumerWidget] and its variants. /// {@endtemplate} abstract class HookConsumerWidget extends ConsumerWidget { /// {@macro hooks_riverpod.hook_consumer.hook_consumer_widget} From 04ecc33f184b6928c825b51e6ddd06527f87d58a Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Mar 2024 11:47:51 +0100 Subject: [PATCH 252/387] Override_with_value (#3375) fixes #1805 --- packages/riverpod/CHANGELOG.md | 3 +- packages/riverpod/lib/riverpod.dart | 3 +- .../lib/src/core/modifiers/future.dart | 7 +- .../lib/src/core/override_with_value.dart | 38 +- .../lib/src/providers/future_provider.dart | 8 + .../riverpod/lib/src/providers/provider.dart | 53 +- .../lib/src/providers/stream_provider.dart | 8 + ...o_dispose_family_future_provider_test.dart | 2 +- .../auto_dispose_future_provider_test.dart | 39 +- .../family_future_provider_test.dart | 2 +- .../future_provider/future_provider_test.dart | 555 ++++++------ .../stream_provider/stream_provider_test.dart | 856 +++++------------- .../riverpod_generator/test/async_test.dart | 13 +- .../riverpod_generator/test/stream_test.dart | 13 +- 14 files changed, 655 insertions(+), 945 deletions(-) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 71710d8a6..220705c19 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -2,6 +2,7 @@ - **Breaking** `AsyncValue.value` now returns `null` during errors. - **Breaking** removed `AsyncValue.valueOrNull` (use `.value` instead). +- `Stream/FutureProvider.overrideWithValue` was added back. - Updated `AsyncValue` documentations to use pattern matching. ## 3.0.0-dev.3 - 2023-11-27 @@ -937,7 +938,7 @@ migrated to null safety. - Re-added `StateProvider.overrideWithValue`/`StateProvider.overrideWithProvider` that - were unvoluntarily removed. + were involuntarily removed. ## 0.14.0 diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 7bdab83ee..792024871 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -47,7 +47,8 @@ export 'src/framework.dart' shortHash, // TODO changelog breaking unexported describeIdentity, - CircularDependencyError; + CircularDependencyError, + $AsyncValueProvider; export 'src/providers/async_notifier.dart' hide $AsyncNotifier, $AsyncNotifierProvider, $AsyncNotifierProviderElement; diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 596b932c5..efe65bc75 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -218,13 +218,14 @@ mixin FutureModifierElement on ProviderElementBase> { set state(AsyncValue newState) { // TODO assert Notifier isn't disposed newState.map( - loading: _onLoading, + loading: onLoading, error: onError, data: onData, ); } - void _onLoading(AsyncLoading value, {bool seamless = false}) { + @internal + void onLoading(AsyncLoading value, {bool seamless = false}) { asyncTransition(value, seamless: seamless); if (_futureCompleter == null) { final completer = _futureCompleter = Completer(); @@ -383,7 +384,7 @@ mixin FutureModifierElement on ProviderElementBase> { }) listen, { required bool didChangeDependency, }) { - _onLoading(AsyncLoading(), seamless: !didChangeDependency); + onLoading(AsyncLoading(), seamless: !didChangeDependency); try { final sub = _cancelSubscription = listen( diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index 9b92a6f7e..bbcfaef8b 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -58,7 +58,7 @@ class _ValueProviderElement extends ProviderElementBase { // other providers if (kDebugMode) _debugSkipNotifyListenersAsserts = true; - setStateResult(ResultData(newValue)); + _setValue(newValue); // Asserts would otherwise prevent a provider rebuild from updating // other providers @@ -68,9 +68,11 @@ class _ValueProviderElement extends ProviderElementBase { } } + void _setValue(StateT value) => setStateResult(ResultData(value)); + @override void create({required bool didChangeDependency}) { - setStateResult(ResultData(provider._value)); + _setValue(provider._value); } @override @@ -78,3 +80,35 @@ class _ValueProviderElement extends ProviderElementBase { return true; } } + +@internal +final class $AsyncValueProvider + extends $ValueProvider> { + const $AsyncValueProvider(super._value); + + @override + // ignore: library_private_types_in_public_api, not public API + _AsyncValueProviderElement $createElement( + ProviderContainer container, + ) { + return _AsyncValueProviderElement(this, container); + } +} + +class _AsyncValueProviderElement + extends _ValueProviderElement> + with FutureModifierElement { + _AsyncValueProviderElement(super.provider, super.container); + + @override + void _setValue(AsyncValue value) { + switch (value) { + case AsyncData(): + onData(value, seamless: true); + case AsyncError(): + onError(value, seamless: true); + case AsyncLoading(): + onLoading(value, seamless: true); + } + } +} diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index ddd9d5d83..07c8ea281 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -14,6 +14,14 @@ import 'stream_provider.dart' show StreamProvider; @internal base mixin $FutureProvider on ProviderBase> { FutureOr create(RefT ref); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(AsyncValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $AsyncValueProvider(value), + ); + } } /// {@template riverpod.future_provider} diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 864b0533b..3bffb052c 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -84,32 +84,47 @@ base class Provider /// Overrides a provider with a value, ejecting the default behavior. /// /// This will also disable the auto-scoping mechanism, meaning that if the - /// overridden provider specified [dependencies], it will have no effect. + /// overridden provider specified `dependencies`, it will have no effect. /// - /// Some common use-cases are: - /// - testing, by replacing a service with a fake implementation, or to reach - /// a very specific state easily. - /// - multiple environments, by changing the implementation of a class - /// based on the platform or other parameters. + /// The main difference between [overrideWith] and [overrideWithValue] is: + /// - [overrideWith] allows you to replace the implementation of a provider. + /// This gives full access to [Ref], and the result will be cached by Riverpod. + /// The override can never change. + /// - [overrideWithValue] allows you to replace the result of a provider. + /// If the overridden value ever changes, notifiers will be updated. /// - /// This function should be used in combination with `ProviderScope.overrides` - /// or `ProviderContainer.overrides`: + /// + /// Alongside the typical use-cases of [overrideWith], [overrideWithValue] + /// has is particularly useful for converting `BuildContext` values to providers. + /// + /// For example, we can make a provider that represents `ThemeData` from Flutter: /// /// ```dart - /// final myService = Provider((ref) => MyService()); + /// final themeProvider = Provider((ref) => throw UnimplementedError()); + /// ``` + /// + /// We can then override this provider with the current theme of the app: /// - /// runApp( - /// ProviderScope( - /// overrides: [ - /// myService.overrideWithValue( - /// // Replace the implementation of MyService with a fake implementation - /// MyFakeService(), - /// ), - /// ], - /// child: MyApp(), - /// ), + /// ```dart + /// MaterialApp( + /// builder: (context, child) { + /// final theme = Theme.of(context); + /// + /// return ProviderScope( + /// overrides: [ + /// /// We override "themeProvider" with a valid theme instance. + /// /// This allows providers such as "tagThemeProvider" to read the + /// /// current theme, without having a BuildContext. + /// themeProvider.overrideWithValue(theme), + /// ], + /// child: MyApp(), + /// ); + /// }, /// ); /// ``` + /// + /// The benefit of using [overrideWithValue] over [overrideWith] in this scenario + /// is that if the theme ever changes, then `themeProvider` will be updated. /// {@endtemplate} Override overrideWithValue(StateT value) { return $ProviderOverride( diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index 2978c287c..bae0f7016 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -15,6 +15,14 @@ import 'provider.dart' show Provider; @internal base mixin $StreamProvider on ProviderBase> { Stream create(RefT ref); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(AsyncValue value) { + return $ProviderOverride( + origin: this, + providerOverride: $AsyncValueProvider(value), + ); + } } /// {@template riverpod.stream_provider} diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart index 2c8fcdda4..fe149f78c 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart @@ -13,7 +13,7 @@ void main() { expect(provider(0).argument, 0); }); - group('scoping an override overrides all the associated subproviders', () { + group('scoping an override overrides all the associated sub-providers', () { test('when passing the provider itself', () async { final provider = FutureProvider.autoDispose.family( (ref, _) async => 0, diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart index acb77525b..e3b9b55c9 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart @@ -217,7 +217,7 @@ void main() { container.read(provider.future).catchError((Object _) => 0); }); - group('scoping an override overrides all the associated subproviders', () { + group('scoping an override overrides all the associated sub-providers', () { test('when passing the provider itself', () async { final provider = FutureProvider.autoDispose( (ref) async => 0, @@ -238,22 +238,27 @@ void main() { ]); }); - // test('when using provider.overrideWithValue', () async { - // final provider = FutureProvider.autoDispose((ref) async => 0); - // final root = ProviderContainer.test(); - // final container = ProviderContainer.test(parent: root, overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // expect(await container.read(provider.future), 42); - // expect(container.read(provider), const AsyncValue.data(42)); - // expect(root.getAllProviderElementsInOrder(), isEmpty); - // expect(container.getAllProviderElementsInOrder(), [ - // isA>().having((e) => e.origin, 'origin', provider), - // isA>() - // .having((e) => e.origin, 'origin', provider.future) - // ]); - // }); + test('when using provider.overrideWithValue', () async { + final provider = FutureProvider.autoDispose( + (ref) async => 0, + dependencies: const [], + ); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [ + provider.overrideWithValue(const AsyncValue.data(42)), + ], + ); + + expect(await container.read(provider.future), 42); + expect(container.read(provider), const AsyncValue.data(42)); + expect(root.getAllProviderElementsInOrder(), isEmpty); + expect(container.getAllProviderElementsInOrder(), [ + isA>() + .having((e) => e.origin, 'origin', provider), + ]); + }); test('when using provider.overrideWith', () async { final provider = FutureProvider.autoDispose( diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart index 74a78dad1..d7b63479b 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart @@ -10,7 +10,7 @@ void main() { expect(provider(0).argument, 0); }); - group('scoping an override overrides all the associated subproviders', () { + group('scoping an override overrides all the associated sub-providers', () { test('when passing the provider itself', () async { final provider = FutureProvider.family( (ref, _) async => 0, diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart index 16471250f..75439f8a4 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart @@ -388,7 +388,7 @@ void main() { verifyNoMoreInteractions(listener); }); - group('scoping an override overrides all the associated subproviders', () { + group('scoping an override overrides all the associated sub-providers', () { test('when passing the provider itself', () async { final provider = FutureProvider( (ref) async => 0, @@ -409,22 +409,27 @@ void main() { ]); }); - // test('when using provider.overrideWithValue', () async { - // final provider = FutureProvider((ref) async => 0); - // final root = ProviderContainer.test(); - // final container = ProviderContainer.test(parent: root, overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // expect(await container.read(provider.future), 42); - // expect(container.read(provider), const AsyncValue.data(42)); - // expect(root.getAllProviderElementsInOrder(), isEmpty); - // expect(container.getAllProviderElementsInOrder(), [ - // isA>().having((e) => e.origin, 'origin', provider), - // isA>() - // .having((e) => e.origin, 'origin', provider.future) - // ]); - // }); + test('when using provider.overrideWithValue', () async { + final provider = FutureProvider( + (ref) async => 0, + dependencies: const [], + ); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [ + provider.overrideWithValue(const AsyncValue.data(42)), + ], + ); + + expect(await container.read(provider.future), 42); + expect(container.read(provider), const AsyncValue.data(42)); + expect(root.getAllProviderElementsInOrder(), isEmpty); + expect(container.getAllProviderElementsInOrder(), [ + isA>() + .having((e) => e.origin, 'origin', provider), + ]); + }); test('when using provider.overrideWith', () async { final provider = FutureProvider( @@ -449,24 +454,26 @@ void main() { }); }); - // test( - // 'when overridden with an error but provider.future is not listened to, it should not emit an error to the zone', - // () async { - // final error = Error(); - // final future = FutureProvider((ref) async => 0); + test( + 'when overridden with an error but provider.future is not listened to, ' + 'it should not emit an error to the zone', () async { + final error = Error(); + final future = FutureProvider((ref) async => 0); - // final container = ProviderContainer.test(overrides: [ - // future.overrideWithValue(AsyncValue.error(error)), - // ]); - // addTearDown(container.dispose); + final container = ProviderContainer.test( + overrides: [ + future.overrideWithValue(AsyncValue.error(error, StackTrace.empty)), + ], + ); + addTearDown(container.dispose); - // expect( - // container.read(future), - // AsyncValue.error(error), - // ); + expect( + container.read(future), + AsyncValue.error(error, StackTrace.empty), + ); - // // the test will naturally fail if a non-caught future is created - // }); + // the test will naturally fail if a non-caught future is created + }); test('throwing inside "create" result in an AsyncValue.error', () { // ignore: only_throw_errors @@ -701,285 +708,301 @@ void main() { verifyNoMoreInteractions(listener); }); - // group('mock as value', () { - // test('value immediately then other value', () async { - // final provider = FutureProvider((_) async => 0); - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); + group('mock as value', () { + test('value immediately then other value', () async { + final provider = FutureProvider((_) async => 0); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(const AsyncValue.data(42)), + ], + ); + + await expectLater( + container.read(provider.future), + completion(42), + ); + + final sub = container.listen(provider, (_, __) {}); + + expect(sub.read(), const AsyncValue.data(42)); + + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.data(21)), + ]); + + await expectLater( + container.read(provider.future), + completion(21), + ); + expect(sub.read(), const AsyncValue.data(21)); + }); + + test('value immediately then error', () async { + final provider = FutureProvider((_) async => 0); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(const AsyncValue.data(42)), + ], + ); + + await expectLater( + container.read(provider.future), + completion(42), + ); + + final sub = container.listen(provider, (_, __) {}); + + expect(sub.read(), const AsyncValue.data(42)); + + container.updateOverrides([ + provider + .overrideWithValue(const AsyncValue.error(21, StackTrace.empty)), + ]); + + await expectLater( + container.read(provider.future), + throwsA(21), + ); + expect( + sub.read(), + const AsyncValue.error(21, StackTrace.empty) + .copyWithPrevious(const AsyncData(42)), + ); + }); + + test('value immediately then loading', () async { + final provider = FutureProvider((_) async => 0); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(const AsyncValue.data(42)), + ], + ); + + final future = container.read(provider.future); + + await expectLater( + future, + completion(42), + ); + + final sub = container.listen(provider, (_, __) {}); + + expect(sub.read(), const AsyncValue.data(42)); + + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.loading()), + ]); - // await expectLater( - // container.read(provider.future), - // completion(42), - // ); + expect(container.read(provider.future), isNot(future)); + expect( + sub.read(), + const AsyncLoading() + .copyWithPrevious(const AsyncValue.data(42)), + ); + }); - // final sub = container.listen(provider, (_, __) {}); + test('loading immediately then value', () async { + final provider = FutureProvider((_) async => 0); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(const AsyncValue.loading()), + ], + ); - // expect(sub.read(), const AsyncValue.data(42)); + final future = container.read(provider.future); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(21)), - // ]); + final sub = container.listen(provider, (_, __) {}); - // await expectLater( - // container.read(provider.future), - // completion(21), - // ); - // expect(sub.read(), const AsyncValue.data(21)); - // }); + expect(sub.read(), const AsyncValue.loading()); - // test('value immediately then error', () async { - // final provider = FutureProvider((_) async => 0); - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.data(42)), + ]); - // await expectLater( - // container.read(provider.future), - // completion(42), - // ); + expect(sub.read(), const AsyncValue.data(42)); - // final sub = container.listen(provider, (_, __) {}); + await expectLater(future, completion(42)); + }); - // expect(sub.read(), const AsyncValue.data(42)); + test('loading immediately then error', () async { + final provider = FutureProvider((_) async => 0); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(const AsyncValue.loading()), + ], + ); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.error(21)), - // ]); + final future = container.read(provider.future); - // await expectLater( - // container.read(provider.future), - // throwsA(21), - // ); - // expect( - // sub.read(), - // const AsyncValue.error(21).copyWithPrevious(const AsyncData(42)), - // ); - // }); + final sub = container.listen(provider, (_, __) {}); - // test('value immediately then loading', () async { - // final provider = FutureProvider((_) async => 0); - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); + expect(sub.read(), const AsyncValue.loading()); - // final future = container.read(provider.future); + final stackTrace = StackTrace.current; - // await expectLater( - // future, - // completion(42), - // ); + container.updateOverrides([ + provider.overrideWithValue(AsyncValue.error(42, stackTrace)), + ]); - // final sub = container.listen(provider, (_, __) {}); + expect(sub.read(), AsyncValue.error(42, stackTrace)); - // expect(sub.read(), const AsyncValue.data(42)); + await expectLater(future, throwsA(42)); + }); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); + test('loading immediately then loading', () async { + final provider = FutureProvider((_) async => 0); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(const AsyncValue.loading()), + ], + ); + final listener = Listener>(); - // expect(container.read(provider.future), isNot(future)); - // expect( - // sub.read(), - // const AsyncLoading() - // .copyWithPrevious(const AsyncValue.data(42)), - // ); - // }); + final future = container.read(provider.future); - // test('loading immediately then value', () async { - // final provider = FutureProvider((_) async => 0); - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); + container.listen(provider, listener.call, fireImmediately: true); - // final future = container.read(provider.future); + verifyOnly(listener, listener(null, const AsyncValue.loading())); + + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.loading()), + ]); - // final sub = container.listen(provider, (_, __) {}); + verifyNoMoreInteractions(listener); + + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.data(42)), + ]); + + verifyOnly( + listener, + listener(const AsyncValue.loading(), const AsyncValue.data(42)), + ); + await expectLater(future, completion(42)); + }); - // expect(sub.read(), const AsyncValue.loading()); + test('error immediately then different error', () async { + final stackTrace = StackTrace.current; + final provider = FutureProvider((_) async => 0); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(AsyncValue.error(42, stackTrace)), + ], + ); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); + await expectLater( + container.read(provider.future), + throwsA(42), + ); - // expect(sub.read(), const AsyncValue.data(42)); + final sub = container.listen(provider, (_, __) {}); - // await expectLater(future, completion(42)); - // }); + expect(sub.read(), AsyncValue.error(42, stackTrace)); - // test('loading immediately then error', () async { - // final provider = FutureProvider((_) async => 0); - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); + container.updateOverrides([ + provider.overrideWithValue(AsyncValue.error(21, stackTrace)), + ]); - // final future = container.read(provider.future); + await expectLater( + container.read(provider.future), + throwsA(21), + ); + expect(sub.read(), AsyncValue.error(21, stackTrace)); + }); - // final sub = container.listen(provider, (_, __) {}); + test('error immediately then different stacktrace', () async { + final stackTrace = StackTrace.current; + final provider = FutureProvider((_) async => 0); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(AsyncValue.error(42, stackTrace)), + ], + ); - // expect(sub.read(), const AsyncValue.loading()); + final future = container.read(provider.future); - // final stackTrace = StackTrace.current; + await expectLater(future, throwsA(42)); - // container.updateOverrides([ - // provider - // .overrideWithValue(AsyncValue.error(42, stackTrace: stackTrace)), - // ]); + final sub = container.listen(provider, (_, __) {}); - // expect(sub.read(), AsyncValue.error(42, stackTrace: stackTrace)); + expect(sub.read(), AsyncValue.error(42, stackTrace)); - // await expectLater(future, throwsA(42)); - // }); + final stack2 = StackTrace.current; - // test('loading immediately then loading', () async { - // final provider = FutureProvider((_) async => 0); - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - // final listener = Listener>(); + container.updateOverrides([ + provider.overrideWithValue(AsyncValue.error(42, stack2)), + ]); - // final future = container.read(provider.future); + expect( + container.read(provider.future), + isNot(future), + ); + await expectLater( + container.read(provider.future), + throwsA(42), + ); + expect(sub.read(), AsyncValue.error(42, stack2)); + }); - // container.listen(provider, listener, fireImmediately: true); + test('error immediately then data', () async { + final stackTrace = StackTrace.current; + final provider = FutureProvider((_) async => 0); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(AsyncValue.error(42, stackTrace)), + ], + ); - // verifyOnly(listener, listener(null, const AsyncValue.loading())); + await expectLater( + container.read(provider.future), + throwsA(42), + ); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); + final sub = container.listen(provider, (_, __) {}); - // verifyNoMoreInteractions(listener); + expect(sub.read(), AsyncValue.error(42, stackTrace)); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.data(42)), + ]); - // verifyOnly( - // listener, - // listener(const AsyncValue.loading(), const AsyncValue.data(42)), - // ); - // await expectLater(future, completion(42)); - // }); + await expectLater( + container.read(provider.future), + completion(42), + ); + expect( + sub.read(), + const AsyncValue.data(42) + .copyWithPrevious(AsyncError(42, stackTrace)), + ); + }); - // test('error immediately then different error', () async { - // final stackTrace = StackTrace.current; - // final provider = FutureProvider((_) async => 0); - // final container = ProviderContainer.test(overrides: [ - // provider - // .overrideWithValue(AsyncValue.error(42, stackTrace: stackTrace)), - // ]); + test('error immediately then loading', () async { + final stackTrace = StackTrace.current; + final provider = FutureProvider((_) async => 0); + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(AsyncValue.error(42, stackTrace)), + ], + ); - // await expectLater( - // container.read(provider.future), - // throwsA(42), - // ); + final future = container.read(provider.future); + await expectLater(future, throwsA(42)); - // final sub = container.listen(provider, (_, __) {}); + final sub = container.listen(provider, (_, __) {}); - // expect(sub.read(), AsyncValue.error(42, stackTrace: stackTrace)); + expect(sub.read(), AsyncValue.error(42, stackTrace)); - // container.updateOverrides([ - // provider - // .overrideWithValue(AsyncValue.error(21, stackTrace: stackTrace)), - // ]); - - // await expectLater( - // container.read(provider.future), - // throwsA(21), - // ); - // expect(sub.read(), AsyncValue.error(21, stackTrace: stackTrace)); - // }); + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.loading()), + ]); - // test('error immediately then different stacktrace', () async { - // final stackTrace = StackTrace.current; - // final provider = FutureProvider((_) async => 0); - // final container = ProviderContainer.test(overrides: [ - // provider - // .overrideWithValue(AsyncValue.error(42, stackTrace: stackTrace)), - // ]); - - // final future = container.read(provider.future); - - // await expectLater(future, throwsA(42)); - - // final sub = container.listen(provider, (_, __) {}); - - // expect(sub.read(), AsyncValue.error(42, stackTrace: stackTrace)); - - // final stack2 = StackTrace.current; - - // container.updateOverrides([ - // provider.overrideWithValue(AsyncValue.error(42, stackTrace: stack2)), - // ]); - - // expect( - // container.read(provider.future), - // isNot(future), - // ); - // await expectLater( - // container.read(provider.future), - // throwsA(42), - // ); - // expect(sub.read(), AsyncValue.error(42, stackTrace: stack2)); - // }); - - // test('error immediately then data', () async { - // final stackTrace = StackTrace.current; - // final provider = FutureProvider((_) async => 0); - // final container = ProviderContainer.test(overrides: [ - // provider - // .overrideWithValue(AsyncValue.error(42, stackTrace: stackTrace)), - // ]); - - // await expectLater( - // container.read(provider.future), - // throwsA(42), - // ); - - // final sub = container.listen(provider, (_, __) {}); - - // expect(sub.read(), AsyncValue.error(42, stackTrace: stackTrace)); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // await expectLater( - // container.read(provider.future), - // completion(42), - // ); - // expect( - // sub.read(), - // const AsyncValue.data(42) - // .copyWithPrevious(AsyncError(42, stackTrace: stackTrace)), - // ); - // }); - - // test('error immediately then loading', () async { - // final stackTrace = StackTrace.current; - // final provider = FutureProvider((_) async => 0); - // final container = ProviderContainer.test(overrides: [ - // provider - // .overrideWithValue(AsyncValue.error(42, stackTrace: stackTrace)), - // ]); - - // final future = container.read(provider.future); - // await expectLater(future, throwsA(42)); - - // final sub = container.listen(provider, (_, __) {}); - - // expect(sub.read(), AsyncValue.error(42, stackTrace: stackTrace)); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - - // expect(container.read(provider.future), isNot(future)); - // expect( - // sub.read(), - // const AsyncLoading() - // .copyWithPrevious(AsyncError(42, stackTrace: stackTrace)), - // ); - // }); - // }); + expect(container.read(provider.future), isNot(future)); + expect( + sub.read(), + const AsyncLoading() + .copyWithPrevious(AsyncError(42, stackTrace)), + ); + }); + }); } diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart index 52c845e9f..24777f322 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart @@ -312,29 +312,30 @@ void main() { ); }); - // test('when using provider.overrideWithValue', () async { - // final provider = StreamProvider((ref) => Stream.value(0)); - // final root = ProviderContainer.test(); - // final container = ProviderContainer.test(parent: root, overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // expect(await container.read(provider.stream).first, 42); - // expect(await container.read(provider.future), 42); - // expect(container.read(provider), const AsyncValue.data(42)); - // expect(root.getAllProviderElements(), isEmpty); - // expect( - // container.getAllProviderElements(), - // unorderedEquals([ - // isA>() - // .having((e) => e.origin, 'origin', provider), - // isA>() - // .having((e) => e.origin, 'origin', provider.future), - // isA>() - // .having((e) => e.origin, 'origin', provider.stream), - // ]), - // ); - // }); + test('when using provider.overrideWithValue', () async { + final provider = StreamProvider( + (ref) => Stream.value(0), + dependencies: const [], + ); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [ + provider.overrideWithValue(const AsyncValue.data(42)), + ], + ); + + expect(await container.read(provider.future), 42); + expect(container.read(provider), const AsyncValue.data(42)); + expect(root.getAllProviderElements(), isEmpty); + expect( + container.getAllProviderElements(), + unorderedEquals([ + isA>() + .having((e) => e.origin, 'origin', provider), + ]), + ); + }); test('when using provider.overrideWith', () async { final provider = StreamProvider( @@ -393,205 +394,164 @@ void main() { }); group('.future', () { - // test( - // 'throws StateError if the provider is disposed before a value was emitted', - // () async { - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncLoading()), - // ]); + final provider = StreamProvider((ref) async* {}); - // final future = container.read(provider.future); - - // container.dispose(); + test( + 'throws StateError if the provider is disposed before a value was emitted', + () async { + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(const AsyncLoading()), + ], + ); - // await expectLater( - // future, - // throwsA( - // isA().having( - // (e) => e.message, - // 'message', - // equalsIgnoringHashCodes( - // 'The provider StreamProvider#00000 was disposed before a value was emitted.', - // ), - // ), - // ), - // ); - // }); + final future = container.read(provider.future); + + container.dispose(); + + await expectLater( + future, + throwsA( + isA().having( + (e) => e.message, + 'message', + equalsIgnoringHashCodes( + 'The provider StreamProvider#00000 was disposed during loading state, ' + 'yet no value could be emitted.', + ), + ), + ), + ); + }); - // test('supports loading then error then loading', () async { - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncLoading()), - // ]); + test('supports loading then error then loading', () async { + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(const AsyncLoading()), + ], + ); - // var future = container.read(provider.future); + var future = container.read(provider.future); - // final error = Error(); + final error = Error(); - // container.updateOverrides([ - // provider.overrideWithValue(AsyncValue.error(error)), - // ]); + container.updateOverrides([ + provider.overrideWithValue(AsyncValue.error(error, StackTrace.empty)), + ]); - // expect(container.read(provider.future), future); + expect(container.read(provider.future), future); - // // TODO(rrousselGit) test that the stacktrace is preserved - // await expectLater(future, throwsA(error)); + // TODO(rrousselGit) test that the stacktrace is preserved + await expectLater(future, throwsA(error)); - // final error2 = Error(); + final error2 = Error(); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.loading()), + ]); - // future = container.read(provider.future); + future = container.read(provider.future); - // container.updateOverrides([ - // provider.overrideWithValue(AsyncValue.error(error2)), - // ]); + container.updateOverrides([ + provider.overrideWithValue(AsyncValue.error(error2, StackTrace.empty)), + ]); - // expect(container.read(provider.future), future); + expect(container.read(provider.future), future); - // // TODO(rrousselGit) test that the stacktrace is preserved - // await expectLater(future, throwsA(error2)); - // }); + // TODO(rrousselGit) test that the stacktrace is preserved + await expectLater(future, throwsA(error2)); + }); - // test('supports loading then error then another error', () async { - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncLoading()), - // ]); + test('supports loading then error then another error', () async { + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(const AsyncLoading()), + ], + ); - // var future = container.read(provider.future); + var future = container.read(provider.future); - // final error = Error(); + final error = Error(); - // container.updateOverrides([ - // provider.overrideWithValue(AsyncValue.error(error)), - // ]); + container.updateOverrides([ + provider.overrideWithValue(AsyncValue.error(error, StackTrace.empty)), + ]); - // expect(container.read(provider.future), future); + expect(container.read(provider.future), future); - // // TODO(rrousselGit) test that the stacktrace is preserved - // await expectLater(future, throwsA(error)); + // TODO(rrousselGit) test that the stacktrace is preserved + await expectLater(future, throwsA(error)); - // final error2 = Error(); + final error2 = Error(); - // // error without passing by an intermediary loading state - // container.updateOverrides([ - // provider.overrideWithValue(AsyncValue.error(error2)), - // ]); + // error without passing by an intermediary loading state + container.updateOverrides([ + provider.overrideWithValue(AsyncValue.error(error2, StackTrace.empty)), + ]); - // future = container.read(provider.future); + future = container.read(provider.future); - // // TODO(rrousselGit) test that the stacktrace is preserved - // await expectLater(future, throwsA(error2)); - // }); + // TODO(rrousselGit) test that the stacktrace is preserved + await expectLater(future, throwsA(error2)); + }); - // test('supports loading then data then loading', () async { - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncLoading()), - // ]); + test('supports loading then data then loading', () async { + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(const AsyncLoading()), + ], + ); - // var future = container.read(provider.future); + var future = container.read(provider.future); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.data(42)), + ]); - // expect(container.read(provider.future), future); - // await expectLater(future, completion(42)); + expect(container.read(provider.future), future); + await expectLater(future, completion(42)); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.loading()), + ]); - // future = container.read(provider.future); + future = container.read(provider.future); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(21)), - // ]); + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.data(21)), + ]); - // expect(container.read(provider.future), future); - // await expectLater(future, completion(21)); - // }); + expect(container.read(provider.future), future); + await expectLater(future, completion(21)); + }); - // test('supports loading then data then another data', () async { - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncLoading()), - // ]); + test('supports loading then data then another data', () async { + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithValue(const AsyncLoading()), + ], + ); - // var future = container.read(provider.future); + var future = container.read(provider.future); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.data(42)), + ]); - // expect(container.read(provider.future), future); - // await expectLater(future, completion(42)); + expect(container.read(provider.future), future); + await expectLater(future, completion(42)); - // // data without passing by an intermediary loading state - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(21)), - // ]); + // data without passing by an intermediary loading state + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.data(21)), + ]); - // future = container.read(provider.future); + future = container.read(provider.future); - // await expectLater(future, completion(21)); - // }); + await expectLater(future, completion(21)); + }); }); - // test('myProvider.stream emits done on dispose', () async { - // final stream = container.read(provider.stream); - - // container.dispose(); - - // await expectLater(stream, emitsDone); - // }); - - // test('myProvider.stream re-create a new stream when re-entering loading', - // () async { - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // final stream = container.read(provider.stream); - - // await expectLater(stream, emits(42)); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - - // final stream2 = container.read(provider.stream); - - // expect(stream2, isNot(stream)); - // await expectLater(stream, emitsDone); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(21)), - // ]); - - // await expectLater(stream2, emits(21)); - - // container.dispose(); - - // await expectLater(stream2, emitsDone); - // }); - - // test('myProvider.stream works across provider rebuild', () async { - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // final stream = container.read(provider.stream); - - // await expectLater(stream, emits(42)); - - // container.updateOverrides( - // [provider.overrideWithValue(const AsyncValue.data(21))], - // ); - - // await expectLater(stream, emits(21)); - // }); - test('does not filter identical values', () async { final container = ProviderContainer.test(); final controller = StreamController(sync: true); @@ -675,82 +635,24 @@ void main() { }); group('overrideWithValue(T)', () { - // test('.stream is a broadcast stream', () async { - // final provider = StreamProvider((ref) => controller.stream); - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // final sub = container.listen(provider.stream, (_, __) {}); - - // await expectLater(sub.read(), emits(42)); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(21)), - // ]); - - // await expectLater(sub.read(), emits(21)); - // }); - - // test('.stream queues events when there are no listeners', () async { - // final provider = StreamProvider((ref) => controller.stream); - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // final sub = container.listen(provider.stream, (_, __) {}); - - // await expectLater(sub.read(), emits(42)); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(21)), - // ]); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(22)), - // ]); - - // // This await would normally prevent the test from reading the "21" event - // // unless the event is queued - // await container.pump(); - - // await expectLater( - // sub.read(), - // emitsInOrder([21, 22]), - // ); - // }); - - // test('.stream emits done when the container is disposed', () async { - // final provider = StreamProvider.autoDispose((ref) => controller.stream); - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // final sub = container.listen(provider.stream, (_, __) {}); - - // final stream = sub.read(); - - // container.dispose(); - - // await expectLater(stream, emits(42)); - // await expectLater(stream, emitsDone); - // }); - // }); - - // test( - // 'when overridden with an error but provider.stream is not listened to, it should not emit an error to the zone', - // () async { - // final error = Error(); - // final stream = StreamProvider((ref) => const Stream.empty()); - - // final container = ProviderContainer(overrides: [ - // stream.overrideWithValue(AsyncValue.error(error)), - // ]); - // addTearDown(container.dispose); - - // expect( - // container.read(stream), - // AsyncValue.error(error), - // ); + test( + 'when overridden with an error but provider.stream is not listened to, it should not emit an error to the zone', + () async { + final error = Error(); + final stream = StreamProvider((ref) => const Stream.empty()); + + final container = ProviderContainer( + overrides: [ + stream.overrideWithValue(AsyncValue.error(error, StackTrace.empty)), + ], + ); + addTearDown(container.dispose); + + expect( + container.read(stream), + AsyncValue.error(error, StackTrace.empty), + ); + }); }); test('StreamProvider.family', () async { @@ -941,398 +843,88 @@ void main() { }); group('from StreamProvider.overrideWithValue', () { - // test('read currentValue before first value', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - - // final future = container.read(provider.future); + test('read currentValue before first value', () async { + final provider = StreamProvider((_) async* {}); + final container = ProviderContainer( + overrides: [ + provider.overrideWithValue(const AsyncValue.loading()), + ], + ); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); + final future = container.read(provider.future); - // await expectLater(future, completion(42)); - // }); + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.data(42)), + ]); - // test('read currentValue before after value', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); + await expectLater(future, completion(42)); + }); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); + test('read currentValue before after value', () async { + final provider = StreamProvider((_) async* {}); + final container = ProviderContainer( + overrides: [ + provider.overrideWithValue(const AsyncValue.loading()), + ], + ); - // final future = container.read(provider.future); + container.updateOverrides([ + provider.overrideWithValue(const AsyncValue.data(42)), + ]); - // await expectLater(future, completion(42)); - // }); + final future = container.read(provider.future); - // test('read currentValue before first error', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); + await expectLater(future, completion(42)); + }); - // final future = container.read(provider.future); + test('read currentValue before first error', () async { + final provider = StreamProvider((_) async* {}); + final container = ProviderContainer( + overrides: [ + provider.overrideWithValue(const AsyncValue.loading()), + ], + ); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.error(42)), - // ]); + final future = container.read(provider.future); - // await expectLater(future, throwsA(42)); - // }); + container.updateOverrides([ + provider + .overrideWithValue(const AsyncValue.error(42, StackTrace.empty)), + ]); - // test('read currentValue before after error', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); + await expectLater(future, throwsA(42)); + }); - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.error(42)), - // ]); + test('read currentValue before after error', () async { + final provider = StreamProvider((_) async* {}); + final container = ProviderContainer( + overrides: [ + provider.overrideWithValue(const AsyncValue.loading()), + ], + ); + + container.updateOverrides([ + provider + .overrideWithValue(const AsyncValue.error(42, StackTrace.empty)), + ]); - // final future = container.read(provider.future); + final future = container.read(provider.future); - // await expectLater(future, throwsA(42)); - // }); + await expectLater(future, throwsA(42)); + }); - // test('synchronous first event', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); + test('synchronous first event', () async { + final provider = StreamProvider((_) async* {}); + final container = ProviderContainer( + overrides: [ + provider.overrideWithValue(const AsyncValue.data(42)), + ], + ); - // final future = container.read(provider.future); + final future = container.read(provider.future); - // await expectLater(future, completion(42)); - // }); + await expectLater(future, completion(42)); + }); }); }); - - group('mock as value', () { - // test('value immediately then other value', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - // final stream = container.read(provider.stream); - - // final sub = container.listen(provider, (_, __) {}); - - // expect(sub.read(), const AsyncValue.data(42)); - // await expectLater(stream, emits(42)); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(21)), - // ]); - - // expect(sub.read(), const AsyncValue.data(21)); - // await expectLater(stream, emits(21)); - - // container.dispose(); - - // await expectLater(stream, emitsDone); - // }); - - // test('value immediately then error', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - // final stream = container.read(provider.stream); - - // final sub = container.listen(provider, (_, __) {}); - - // expect(sub.read(), const AsyncValue.data(42)); - // await expectLater(stream, emits(42)); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.error(21)), - // ]); - - // expect( - // sub.read(), - // const AsyncValue.error(21).copyWithPrevious(const AsyncData(42)), - // ); - // // TODO why call "read" twice? - // expect( - // sub.read(), - // const AsyncValue.error(21).copyWithPrevious(const AsyncData(42)), - // ); - // await expectLater(stream, emitsError(21)); - - // container.dispose(); - - // await expectLater(stream, emitsDone); - // }); - - // test('value immediately then loading', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - // final stream = container.read(provider.stream); - - // final sub = container.listen(provider, (_, __) {}); - - // expect(sub.read(), const AsyncValue.data(42)); - // await expectLater(stream, emits(42)); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - - // expect( - // sub.read(), - // const AsyncLoading() - // .copyWithPrevious(const AsyncValue.data(42)), - // ); - - // container.dispose(); - - // await expectLater(stream, emitsDone); - // }); - - // test('loading immediately then value', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - // final stream = container.read(provider.stream); - - // final sub = container.listen(provider, (_, __) {}); - - // expect(sub.read(), const AsyncValue.loading()); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // expect(sub.read(), const AsyncValue.data(42)); - // await expectLater(stream, emits(42)); - - // container.dispose(); - - // await expectLater(stream, emitsDone); - // }); - - // test('loading immediately then error', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - // final stream = container.read(provider.stream); - - // final sub = container.listen(provider, (_, __) {}); - - // expect(sub.read(), const AsyncValue.loading()); - - // final stackTrace = StackTrace.current; - - // container.updateOverrides([ - // provider.overrideWithValue( - // AsyncValue.error(42, stackTrace: stackTrace)), - // ]); - - // expect(sub.read(), AsyncValue.error(42, stackTrace: stackTrace)); - - // await expectLater(stream, emitsError(42)); - - // container.dispose(); - - // await expectLater(stream, emitsDone); - // }); - - // test('loading immediately then loading', () async { - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - // final stream = container.read(provider.stream); - // final listener = Listener>(); - - // container.listen(provider, listener, fireImmediately: true); - - // verifyOnly(listener, listener(null, const AsyncValue.loading())); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - - // verifyNoMoreInteractions(listener); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // verifyOnly( - // listener, - // listener(const AsyncValue.loading(), const AsyncValue.data(42)), - // ); - - // await expectLater(stream, emits(42)); - - // container.dispose(); - - // await expectLater(stream, emitsDone); - // }); - - // test('error immediately then different error', () async { - // final stackTrace = StackTrace.current; - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue( - // AsyncValue.error(42, stackTrace: stackTrace)), - // ]); - // final stream = container.read(provider.stream); - - // final sub = container.listen(provider, (_, __) {}); - - // expect(sub.read(), AsyncValue.error(42, stackTrace: stackTrace)); - // await expectLater(stream, emitsError(42)); - - // container.updateOverrides([ - // provider.overrideWithValue( - // AsyncValue.error(21, stackTrace: stackTrace)), - // ]); - - // expect(sub.read(), AsyncValue.error(21, stackTrace: stackTrace)); - // await expectLater(stream, emitsError(21)); - - // container.dispose(); - - // await expectLater(stream, emitsDone); - // }); - - // test('error immediately then different stacktrace', () async { - // final stackTrace = StackTrace.current; - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue( - // AsyncValue.error(42, stackTrace: stackTrace)), - // ]); - // final stream = container.read(provider.stream); - - // final sub = container.listen(provider, (_, __) {}); - - // expect(sub.read(), AsyncValue.error(42, stackTrace: stackTrace)); - // await expectLater(stream, emitsError(42)); - - // final stackTrace2 = StackTrace.current; - // container.updateOverrides([ - // provider.overrideWithValue( - // AsyncValue.error(42, stackTrace: stackTrace2), - // ), - // ]); - - // expect(sub.read(), AsyncValue.error(42, stackTrace: stackTrace2)); - // await expectLater(stream, emitsError(42)); - - // container.dispose(); - - // await expectLater(stream, emitsDone); - // }); - - // test('error immediately then data', () async { - // const stackTrace = StackTrace.empty; - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue( - // const AsyncValue.error(42, stackTrace: stackTrace)), - // ]); - // final stream = container.read(provider.stream); - - // final sub = container.listen(provider, (_, __) {}); - - // expect( - // sub.read(), - // const AsyncValue.error(42, stackTrace: stackTrace), - // ); - // await expectLater(stream, emitsError(42)); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.data(21)), - // ]); - - // expect( - // sub.read(), - // const AsyncValue.data(21) - // .copyWithPrevious(const AsyncError(42, stackTrace: stackTrace)), - // ); - // await expectLater(stream, emits(21)); - - // container.dispose(); - - // await expectLater(stream, emitsDone); - // }); - - // test('error immediately then loading', () async { - // final stackTrace = StackTrace.current; - // final provider = StreamProvider((_) async* {}); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue( - // AsyncValue.error(42, stackTrace: stackTrace)), - // ]); - // final stream = container.read(provider.stream); - - // final sub = container.listen(provider, (_, __) {}); - - // expect(sub.read(), AsyncValue.error(42, stackTrace: stackTrace)); - // await expectLater(stream, emitsError(42)); - - // container.updateOverrides([ - // provider.overrideWithValue(const AsyncValue.loading()), - // ]); - - // expect( - // sub.read(), - // const AsyncLoading() - // .copyWithPrevious(AsyncError(42, stackTrace: stackTrace)), - // ); - - // container.dispose(); - - // await expectLater(stream, emitsDone); - // }); - }); } - -// class MockStream extends Mock implements Stream { -// @override -// StreamSubscription listen( -// void Function(T event)? onData, { -// Function? onError, -// void Function()? onDone, -// bool? cancelOnError, -// }) { -// return super.noSuchMethod( -// Invocation.method( -// #listen, -// [onData], -// { -// #onError: onError, -// #onDone: onDone, -// #cancelOnError: cancelOnError, -// }, -// ), -// returnValue: MockSubscription(), -// returnValueForMissingStub: MockSubscription(), -// ) as StreamSubscription; -// } -// } - -// class MockSubscription extends Mock implements StreamSubscription { -// @override -// Future cancel() { -// return super.noSuchMethod( -// Invocation.method(#cancel, []), -// returnValue: Future.value(), -// returnValueForMissingStub: Future.value(), -// ) as Future; -// } -// } diff --git a/packages/riverpod_generator/test/async_test.dart b/packages/riverpod_generator/test/async_test.dart index 3a4c54c0d..c5c73e046 100644 --- a/packages/riverpod_generator/test/async_test.dart +++ b/packages/riverpod_generator/test/async_test.dart @@ -136,7 +136,7 @@ void main() { ); }); - test('can override providers', () { + test('can overrideWith', () { final container = ProviderContainer.test( overrides: [ publicProvider.overrideWith((ref) { @@ -168,4 +168,15 @@ void main() { (42, second: '42', third: 0.42, fourth: true, fifth: null), ); }); + + test('can overrideWithValue providers ', () { + final container = ProviderContainer.test( + overrides: [ + publicProvider.overrideWithValue(const AsyncData('test')), + ], + ); + + expect(container.read(publicProvider), const AsyncData('test')); + expect(container.read(publicProvider.future), completion('test')); + }); } diff --git a/packages/riverpod_generator/test/stream_test.dart b/packages/riverpod_generator/test/stream_test.dart index 8b4901f07..c6d1f1e20 100644 --- a/packages/riverpod_generator/test/stream_test.dart +++ b/packages/riverpod_generator/test/stream_test.dart @@ -127,7 +127,7 @@ void main() { ); }); - test('can override providers', () { + test('can overrideWith', () { final container = ProviderContainer.test( overrides: [ publicProvider.overrideWith((ref) { @@ -160,4 +160,15 @@ void main() { (42, second: '42', third: 0.42, fourth: true, fifth: null), ); }); + + test('can overrideWithValue providers ', () { + final container = ProviderContainer.test( + overrides: [ + publicProvider.overrideWithValue(const AsyncData('test')), + ], + ); + + expect(container.read(publicProvider), const AsyncData('test')); + expect(container.read(publicProvider.future), completion('test')); + }); } From cc55be0347ddc9a8f214d825bf3849d744f6113c Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Mar 2024 13:19:41 +0100 Subject: [PATCH 253/387] Add a way to do a "full reload" using invalidate (#3378) --- packages/flutter_riverpod/CHANGELOG.md | 4 ++ .../lib/src/core/consumer.dart | 7 +- .../lib/src/core/widget_ref.dart | 15 +++-- .../test/widget_ref_test.dart | 33 ++++++++++ packages/riverpod/CHANGELOG.md | 1 + packages/riverpod/lib/src/core/element.dart | 24 +++---- .../lib/src/core/provider_container.dart | 11 +++- packages/riverpod/lib/src/core/ref.dart | 35 ++++++---- .../new/core/provider_container_test.dart | 17 +++++ packages/riverpod/test/new/core/ref_test.dart | 64 ++++++++++++++++++- 10 files changed, 176 insertions(+), 35 deletions(-) create mode 100644 packages/flutter_riverpod/test/widget_ref_test.dart diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md index 2a43f4f76..63c408e1c 100644 --- a/packages/flutter_riverpod/CHANGELOG.md +++ b/packages/flutter_riverpod/CHANGELOG.md @@ -1,3 +1,7 @@ +## Unreleased build + +- Added support for `Ref/ProviderContainer.invalidate(provider, asReload: true)` + ## 3.0.0-dev.3 - 2023-11-27 - Fix "pending timer" issue inside tests when using `ref.keepAlive()`. diff --git a/packages/flutter_riverpod/lib/src/core/consumer.dart b/packages/flutter_riverpod/lib/src/core/consumer.dart index fc5b107cc..1d3496a65 100644 --- a/packages/flutter_riverpod/lib/src/core/consumer.dart +++ b/packages/flutter_riverpod/lib/src/core/consumer.dart @@ -473,9 +473,12 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { } @override - void invalidate(ProviderOrFamily provider) { + void invalidate( + ProviderOrFamily provider, { + bool asReload = false, + }) { _assertNotDisposed(); - _container.invalidate(provider); + _container.invalidate(provider, asReload: asReload); } @override diff --git a/packages/flutter_riverpod/lib/src/core/widget_ref.dart b/packages/flutter_riverpod/lib/src/core/widget_ref.dart index 8497685c9..5841b2784 100644 --- a/packages/flutter_riverpod/lib/src/core/widget_ref.dart +++ b/packages/flutter_riverpod/lib/src/core/widget_ref.dart @@ -370,11 +370,18 @@ abstract class WidgetRef { /// /// Calling [invalidate] multiple times will refresh the provider only /// once. - /// /// Calling [invalidate] will cause the provider to be disposed immediately. /// + /// - [asReload] (false by default) can be optionally passed to tell + /// Riverpod to clear the state before refreshing it. + /// This is only useful for asynchronous providers, as by default, + /// [AsyncValue] keeps a reference on state during loading states. + /// Using [asReload] will disable this behavior and count as a + /// "hard refresh". + /// /// If used on a provider which is not initialized, this method will have no effect. - void invalidate(ProviderOrFamily provider); - - // TODO reload + void invalidate( + ProviderOrFamily provider, { + bool asReload = false, + }); } diff --git a/packages/flutter_riverpod/test/widget_ref_test.dart b/packages/flutter_riverpod/test/widget_ref_test.dart new file mode 100644 index 000000000..3bf409389 --- /dev/null +++ b/packages/flutter_riverpod/test/widget_ref_test.dart @@ -0,0 +1,33 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +void main() { + group('WidgetRef', () { + group('invalidate', () { + testWidgets('supports asReload', (tester) async { + final provider = FutureProvider((r) async => 0); + + await tester.pumpWidget( + ProviderScope( + child: Consumer( + builder: (context, ref, _) => Container(), + ), + ), + ); + + final ref = tester.firstElement(find.byType(Consumer)) as WidgetRef; + + await ref.read(provider.future); + expect(ref.read(provider), const AsyncValue.data(0)); + + ref.invalidate(provider, asReload: true); + + expect( + ref.read(provider), + isA>().having((e) => e.value, 'value', 0), + ); + }); + }); + }); +} diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 220705c19..31d783a54 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -4,6 +4,7 @@ - **Breaking** removed `AsyncValue.valueOrNull` (use `.value` instead). - `Stream/FutureProvider.overrideWithValue` was added back. - Updated `AsyncValue` documentations to use pattern matching. +- Added support for `Ref/ProviderContainer.invalidate(provider, asReload: true)` ## 3.0.0-dev.3 - 2023-11-27 diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index f38bdc3fb..3622d75be 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -301,13 +301,17 @@ This could mean a few things: void update(ProviderBase newProvider) {} @override - void invalidate(ProviderOrFamily providerOrFamily) { + void invalidate( + ProviderOrFamily providerOrFamily, { + bool asReload = false, + }) { if (kDebugMode) _debugAssertCanDependOn(providerOrFamily); - container.invalidate(providerOrFamily); + container.invalidate(providerOrFamily, asReload: asReload); } @override - void invalidateSelf() { + void invalidateSelf({bool asReload = false}) { + if (asReload) _didChangeDependency = true; if (_mustRecomputeState) return; _mustRecomputeState = true; @@ -555,7 +559,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ); for (var i = 0; i < _providerDependents.length; i++) { - _providerDependents[i]._markDependencyChanged(); + _providerDependents[i].invalidateSelf(asReload: true); } for (final observer in container.observers) { @@ -584,14 +588,6 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } } - void _markDependencyChanged() { - _didChangeDependency = true; - if (_mustRecomputeState) return; - - // will notify children that their dependency may have changed - invalidateSelf(); - } - void _markDependencyMayHaveChanged() { if (_dependencyMayHaveChanged) return; @@ -691,8 +687,8 @@ final = Provider(dependencies: []); if (listenable is! ProviderBase) { final sub = listen( listenable, - (prev, value) => _markDependencyChanged(), - onError: (err, stack) => _markDependencyChanged(), + (prev, value) => invalidateSelf(asReload: true), + onError: (err, stack) => invalidateSelf(asReload: true), onDependencyMayHaveChanged: _markDependencyMayHaveChanged, ); diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 5f3eaca74..420234a54 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -754,13 +754,18 @@ class ProviderContainer implements Node { } /// {@macro riverpod.invalidate} - void invalidate(ProviderOrFamily provider) { + void invalidate( + ProviderOrFamily provider, { + bool asReload = false, + }) { switch (provider) { case ProviderBase(): - _pointerManager.readElement(provider)?.invalidateSelf(); + _pointerManager + .readElement(provider) + ?.invalidateSelf(asReload: asReload); case Family(): for (final element in _pointerManager.listFamily(provider)) { - element.invalidateSelf(); + element.invalidateSelf(asReload: asReload); } } } diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 4a00d2725..a46c89b4c 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -75,12 +75,18 @@ abstract class Ref { /// /// Calling [invalidate] multiple times will refresh the provider only /// once. - /// /// Calling [invalidate] will cause the provider to be disposed immediately. /// + /// - [asReload] (false by default) can be optionally passed to tell + /// Riverpod to clear the state before refreshing it. + /// This is only useful for asynchronous providers, as by default, + /// [AsyncValue] keeps a reference on state during loading states. + /// Using [asReload] will disable this behavior and count as a + /// "hard refresh". + /// /// If used on a provider which is not initialized, this method will have no effect. /// {@endtemplate} - void invalidate(ProviderOrFamily provider); + void invalidate(ProviderOrFamily provider, {bool asReload = false}); /// Notify dependents that this provider has changed. /// @@ -111,16 +117,10 @@ abstract class Ref { void Function(Object error, StackTrace stackTrace)? onError, }); - /// Invalidates the state of the provider, causing it to refresh. - /// - /// The refresh is not immediate and is instead delayed to the next read - /// or next frame. - /// - /// Calling [invalidateSelf] multiple times will refresh the provider only - /// once. + /// Invokes [invalidate] on itself. /// - /// Calling [invalidateSelf] will cause the provider to be disposed immediately. - void invalidateSelf(); + /// {@macro riverpod.invalidate} + void invalidateSelf({bool asReload = false}); /// A life-cycle for whenever a new listener is added to the provider. /// @@ -302,6 +302,19 @@ abstract class Ref { /// - if multiple widgets depends on `sortedTodosProvider` the list will be /// sorted only once. /// - if nothing is listening to `sortedTodosProvider`, then no sort is performed. + /// + /// + /// **Note**: + /// This can be considered as the combination of [listen] and [invalidateSelf] : + /// ```dart + /// T watch(ProviderListenable provider) { + /// final sub = listen(provider, (previous, next) { + /// invalidateSelf(asReload: true); + /// }); + /// onDispose(sub.cancel); + /// return sub.read(); + /// } + /// ``` T watch(ProviderListenable provider); /// {@template riverpod.listen} diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index aeed56724..d3aaaf4dc 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -2115,6 +2115,23 @@ void main() { }); }); + group('invalidate', () { + test('supports asReload', () async { + final container = ProviderContainer.test(); + final provider = FutureProvider((r) async => 0); + + await container.read(provider.future); + expect(container.read(provider), const AsyncValue.data(0)); + + container.invalidate(provider, asReload: true); + + expect( + container.read(provider), + isA>().having((e) => e.value, 'value', 0), + ); + }); + }); + group('listen', () { test('when no onError is specified, fallbacks to handleUncaughtError', () async { diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart index e31054151..6460a3596 100644 --- a/packages/riverpod/test/new/core/ref_test.dart +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -30,7 +30,69 @@ final refMethodsThatDependOnProviderOrFamilies = void main() { group('Ref', () { - // TODO ref.invalidate does not mount providers if they are not already mounted + group('invalidate', () { + test('does not mount providers if they are not already mounted', + () async { + final container = ProviderContainer.test(); + final provider = FutureProvider((r) async => 0); + late Ref ref; + final dep = Provider((r) { + ref = r; + return 0; + }); + + container.read(dep); + + ref.invalidate(provider); + + expect( + container.getAllProviderElements().map((e) => e.origin), + [dep], + ); + }); + + test('supports asReload', () async { + final container = ProviderContainer.test(); + final provider = FutureProvider((r) async => 0); + late Ref ref; + final dep = Provider((r) { + ref = r; + return 0; + }); + + container.read(dep); + await container.read(provider.future); + expect(container.read(provider), const AsyncValue.data(0)); + + ref.invalidate(provider, asReload: true); + + expect( + container.read(provider), + isA>().having((e) => e.value, 'value', 0), + ); + }); + }); + + group('invalidateSelf', () { + test('supports asReload', () async { + final container = ProviderContainer.test(); + late Ref> ref; + final provider = FutureProvider((r) async { + ref = r; + return 0; + }); + + await container.read(provider.future); + expect(container.read(provider), const AsyncValue.data(0)); + + ref.invalidateSelf(asReload: true); + + expect( + container.read(provider), + isA>().having((e) => e.value, 'value', 0), + ); + }); + }); test( 'cannot call ref.watch/ref.read/ref.listen/ref.onDispose after a dependency changed', From ef8ad9125c19feebf0a7e0d90e1134d5494cff98 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Mar 2024 13:21:06 +0100 Subject: [PATCH 254/387] Remove redundant line --- packages/riverpod/lib/src/core/ref.dart | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index a46c89b4c..15ec8a148 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -311,7 +311,6 @@ abstract class Ref { /// final sub = listen(provider, (previous, next) { /// invalidateSelf(asReload: true); /// }); - /// onDispose(sub.cancel); /// return sub.read(); /// } /// ``` From d7816cfc6748d9df0f0d9e75e75834f1c89714dc Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Mar 2024 14:09:40 +0100 Subject: [PATCH 255/387] Add regression test for #3249 fixes #3249 --- .../test/integration/sync.dart | 9 ++ .../test/integration/sync.g.dart | 142 ++++++++++++++++++ 2 files changed, 151 insertions(+) diff --git a/packages/riverpod_generator/test/integration/sync.dart b/packages/riverpod_generator/test/integration/sync.dart index e828a8cee..20c87bbea 100644 --- a/packages/riverpod_generator/test/integration/sync.dart +++ b/packages/riverpod_generator/test/integration/sync.dart @@ -223,3 +223,12 @@ class UnnecessaryCastClass extends _$UnnecessaryCastClass { return 'Just a simple normal generated provider'; } } + +// Regression test for https://github.com/rrousselGit/riverpod/issues/3249 +class ManyProviderData {} + +@riverpod +Stream> manyDataStream( + ManyDataStreamRef ref, + ManyProviderData pData, +) async* {} diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index b5889891a..053988217 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -3137,5 +3137,147 @@ abstract class _$UnnecessaryCastClass extends $Notifier { ); } +typedef ManyDataStreamRef + = Ref>>; + +@ProviderFor(manyDataStream) +const manyDataStreamProvider = ManyDataStreamFamily._(); + +final class ManyDataStreamProvider + extends $FunctionalProvider>, Stream>, + ManyDataStreamRef> + with + $FutureModifier>, + $StreamProvider, ManyDataStreamRef> { + const ManyDataStreamProvider._( + {required ManyDataStreamFamily super.from, + required ManyProviderData super.argument, + Stream> Function( + ManyDataStreamRef ref, + ManyProviderData pData, + )? create}) + : _createCb = create, + super( + name: r'manyDataStreamProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Stream> Function( + ManyDataStreamRef ref, + ManyProviderData pData, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$manyDataStreamHash(); + + ManyDataStreamProvider _copyWithCreate( + Stream> Function( + ManyDataStreamRef ref, + ManyProviderData pData, + ) create, + ) { + return ManyDataStreamProvider._( + argument: argument as ManyProviderData, + from: from! as ManyDataStreamFamily, + create: create); + } + + @override + String toString() { + return r'manyDataStreamProvider' + '<${T}, ${S}>' + '($argument)'; + } + + @$internal + @override + $StreamProviderElement> $createElement(ProviderContainer container) => + $StreamProviderElement(this, container); + + @override + ManyDataStreamProvider $copyWithCreate( + Stream> Function( + ManyDataStreamRef ref, + ) create, + ) { + return ManyDataStreamProvider._( + argument: argument as ManyProviderData, + from: from! as ManyDataStreamFamily, + create: ( + ref, + ManyProviderData pData, + ) => + create(ref)); + } + + @override + Stream> create(ManyDataStreamRef ref) { + final _$cb = _createCb ?? manyDataStream; + final argument = this.argument as ManyProviderData; + return _$cb( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is ManyDataStreamProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } +} + +String _$manyDataStreamHash() => r'965270e9e187c17b8c78c03ded79136a4073ff04'; + +final class ManyDataStreamFamily extends Family { + const ManyDataStreamFamily._() + : super( + name: r'manyDataStreamProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + ManyDataStreamProvider call( + ManyProviderData pData, + ) => + ManyDataStreamProvider._(argument: pData, from: this); + + @override + String debugGetCreateSourceHash() => _$manyDataStreamHash(); + + @override + String toString() => r'manyDataStreamProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + Stream> Function( + ManyDataStreamRef ref, + ManyProviderData args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (container, provider) { + provider as ManyDataStreamProvider; + + return provider._copyWithCreate(( + ref, + ManyProviderData pData, + ) { + return create(ref, pData); + }).$createElement(container); + }, + ); + } +} // ignore_for_file: type=lint // ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member From 7971b3af05fbcea3c89ddd1c707ebc6297fc98ba Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Mar 2024 14:14:06 +0100 Subject: [PATCH 256/387] Fix `provider_parameters` for objects using mixins. (#3379) fixes #3302 --- packages/riverpod_lint/CHANGELOG.md | 1 + .../lib/src/lints/provider_parameters.dart | 10 +++----- .../provider_parameters_lint.md | 18 ++++++------- .../test/lints/provider_parameters.dart | 25 +++++++++++++++++++ 4 files changed, 38 insertions(+), 16 deletions(-) diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index 13658d93b..db2ff551b 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -5,6 +5,7 @@ - added `avoid_keep_alive_dependency_inside_auto_dispose` - added `unknown_scoped_usage`, for reporting when a scoped provider is used but the ref could not be found.**** - added automatic migration to import `package:riverpod/legacy.dart` for corresponding providers. +- Fix `provider_parameters` for objects using mixins. - **Breaking**: No-longer exports various providers from `package:riverpod`. diff --git a/packages/riverpod_lint/lib/src/lints/provider_parameters.dart b/packages/riverpod_lint/lib/src/lints/provider_parameters.dart index ddba28aef..ff278f236 100644 --- a/packages/riverpod_lint/lib/src/lints/provider_parameters.dart +++ b/packages/riverpod_lint/lib/src/lints/provider_parameters.dart @@ -5,7 +5,6 @@ import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; -import '../object_utils.dart'; import '../riverpod_custom_lint.dart'; class ProviderParameters extends RiverpodLintRule { @@ -54,12 +53,7 @@ class ProviderParameters extends RiverpodLintRule { final operatorEqual = instantiatedObject?.enclosingElement.recursiveGetMethod('=='); - final isEqualFromObjectMethod = operatorEqual?.enclosingElement - .safeCast() - ?.thisType - .isDartCoreObject; - - if (operatorEqual == null || (isEqualFromObjectMethod ?? true)) { + if (operatorEqual == null) { // Doing `provider(new Class())` is bad if the class does not override == reporter.reportErrorForNode(code, value); } @@ -79,6 +73,8 @@ extension on ConstructorElement { extension on InterfaceElement { MethodElement? recursiveGetMethod(String name) { + if (thisType.isDartCoreObject) return null; + final thisMethod = getMethod(name); if (thisMethod != null) return thisMethod; diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_parameters/provider_parameters_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_parameters/provider_parameters_lint.md index 827853ff2..297148c35 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_parameters/provider_parameters_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_parameters/provider_parameters_lint.md @@ -316,10 +316,10 @@ test/lints/provider_parameters.dart:136:22 code: provider_parameters severity: Severity.warning message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == -test/lints/provider_parameters.dart:142:22 +test/lints/provider_parameters.dart:144:22 ```dart - ref.watch(legacy(const ClassThatOverridesEqual())); + ref.watch(legacy(const IndirectEqual())); // expect_lint: provider_parameters ref.watch(legacy(>>>Bar()<<<)); ref.watch(legacy(const Bar())); @@ -331,7 +331,7 @@ test/lints/provider_parameters.dart:142:22 code: provider_parameters severity: Severity.warning message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == -test/lints/provider_parameters.dart:145:22 +test/lints/provider_parameters.dart:147:22 ```dart ref.watch(legacy(const Bar())); @@ -346,7 +346,7 @@ test/lints/provider_parameters.dart:145:22 code: provider_parameters severity: Severity.warning message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == -test/lints/provider_parameters.dart:152:40 +test/lints/provider_parameters.dart:154:40 ```dart ref.watch(generatorProvider(value: 42)); @@ -361,7 +361,7 @@ test/lints/provider_parameters.dart:152:40 code: provider_parameters severity: Severity.warning message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == -test/lints/provider_parameters.dart:154:40 +test/lints/provider_parameters.dart:156:40 ```dart ref.watch(generatorProvider(value: [42])); @@ -376,7 +376,7 @@ test/lints/provider_parameters.dart:154:40 code: provider_parameters severity: Severity.warning message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == -test/lints/provider_parameters.dart:156:40 +test/lints/provider_parameters.dart:158:40 ```dart ref.watch(generatorProvider(value: {'string': 42})); @@ -391,7 +391,7 @@ test/lints/provider_parameters.dart:156:40 code: provider_parameters severity: Severity.warning message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == -test/lints/provider_parameters.dart:162:40 +test/lints/provider_parameters.dart:164:40 ```dart ref.watch(generatorProvider(value: null)); @@ -406,7 +406,7 @@ test/lints/provider_parameters.dart:162:40 code: provider_parameters severity: Severity.warning message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == -test/lints/provider_parameters.dart:169:40 +test/lints/provider_parameters.dart:173:40 ```dart @@ -421,7 +421,7 @@ test/lints/provider_parameters.dart:169:40 code: provider_parameters severity: Severity.warning message: Providers parameters should have a consistent ==. Meaning either the values should be cached, or the parameters should override == -test/lints/provider_parameters.dart:173:40 +test/lints/provider_parameters.dart:177:40 ```dart diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.dart index 90fb9420c..a5992bd7d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.dart @@ -138,6 +138,8 @@ class MyWidget extends ConsumerWidget { ref.watch(legacy(ClassThatOverridesEqual())); ref.watch(legacy(const ClassThatOverridesEqual())); + ref.watch(legacy(IndirectEqual())); + ref.watch(legacy(const IndirectEqual())); // expect_lint: provider_parameters ref.watch(legacy(Bar())); ref.watch(legacy(const Bar())); @@ -164,6 +166,8 @@ class MyWidget extends ConsumerWidget { ref.watch(generatorProvider(value: ClassThatOverridesEqual())); ref.watch(generatorProvider(value: const ClassThatOverridesEqual())); + ref.watch(generatorProvider(value: IndirectEqual())); + ref.watch(generatorProvider(value: const IndirectEqual())); // expect_lint: provider_parameters ref.watch(generatorProvider(value: Bar())); @@ -178,3 +182,24 @@ class MyWidget extends ConsumerWidget { return const Placeholder(); } } + +// Regression test for https://github.com/rrousselGit/riverpod/issues/3302 +mixin Equatable { + List get props; + @override + bool operator ==(Object other) { + return identical(this, other) || + other is Equatable && + runtimeType == other.runtimeType && + props == other.props; + } + + @override + int get hashCode => runtimeType.hashCode ^ Object.hashAll(props); +} + +class IndirectEqual with Equatable { + const IndirectEqual(); + @override + List get props => const []; +} From 861066a4a23495b9ae1722438fe33c3397152b30 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Mar 2024 14:54:21 +0100 Subject: [PATCH 257/387] Fix family provider override fixes #1869 --- .../lib/src/core/provider_container.dart | 32 +- .../new/core/provider_container_test.dart | 412 ++++++++++-------- 2 files changed, 258 insertions(+), 186 deletions(-) diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 420234a54..136caa44a 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -355,19 +355,31 @@ class ProviderPointerManager { /// If the provider has no dependencies, it cannot be locally overridden. if (transitiveDependencies == null) return null; - ProviderContainer? deepestContainer; - for (final dependency in transitiveDependencies) { - final target = switch (dependency) { - Family() => familyPointers[dependency]?.targetContainer, - ProviderBase() => readPointer(dependency)?.targetContainer, - }; - if (target == null || target.depth == 0) continue; + final overrides = + transitiveDependencies.expand((dependency) { + switch (dependency) { + case Family(): + final familyPointer = familyPointers[dependency]; + if (familyPointer == null) return const []; + + return [familyPointer.targetContainer].followedBy( + familyPointer.pointers.values.map((e) => e.targetContainer), + ); + case ProviderBase(): + return [ + if (readPointer(dependency)?.targetContainer case final container?) + container, + ]; + } + }); + + return overrides.fold(null, (deepestContainer, target) { if (deepestContainer == null || deepestContainer.depth < target.depth) { - deepestContainer = target; + return target; } - } - return deepestContainer; + return deepestContainer; + }); } /// Initializes a family and returns its pointer. diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index d3aaaf4dc..6664ad46d 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -395,208 +395,268 @@ void main() { ); }); - test('handles auto-scoping', () { - final dep = Provider( - (_) => 0, - dependencies: const [], - ); - final family = Provider.family( - (ref, id) => 0, - dependencies: [dep], - ); - final provider = Provider((_) => 0, dependencies: [dep]); - final root = ProviderContainer.test(); - final container = ProviderContainer.test( - parent: root, - overrides: [dep.overrideWithValue(42)], - ); - - final pointer = container.pointerManager.upsertPointer(family(42)); - final pointer2 = container.pointerManager.upsertPointer(provider); + group('auto-scoping', () { + test('handles auto-scoping', () { + final dep = Provider( + (_) => 0, + dependencies: const [], + ); + final family = Provider.family( + (ref, id) => 0, + dependencies: [dep], + ); + final provider = Provider((_) => 0, dependencies: [dep]); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [dep.overrideWithValue(42)], + ); - expect( - pointer, - isPointer( - targetContainer: container, - override: null, - ), - ); - expect( - pointer2, - isPointer( - targetContainer: container, - override: isTransitiveProviderOverride(provider), - ), - ); + final pointer = container.pointerManager.upsertPointer(family(42)); + final pointer2 = container.pointerManager.upsertPointer(provider); - expect( - container.pointerManager.familyPointers, - { - family: isProviderDirectory( + expect( + pointer, + isPointer( targetContainer: container, - override: isTransitiveFamilyOverride(family), + override: null, + ), + ); + expect( + pointer2, + isPointer( + targetContainer: container, + override: isTransitiveProviderOverride(provider), + ), + ); + + expect( + container.pointerManager.familyPointers, + { + family: isProviderDirectory( + targetContainer: container, + override: isTransitiveFamilyOverride(family), + pointers: { + family(42): pointer, + }, + ), + }, + ); + expect( + container.pointerManager.orphanPointers, + isProviderDirectory( + targetContainer: root, + override: null, pointers: { - family(42): pointer, + provider: pointer2, + dep: isNotNull, }, ), - }, - ); - expect( - container.pointerManager.orphanPointers, - isProviderDirectory( - targetContainer: root, - override: null, - pointers: { - provider: pointer2, - dep: isNotNull, - }, - ), - ); + ); - // Check that the root was unaffected - expect( - root.pointerManager.familyPointers, - isEmpty, - ); - expect( - root.pointerManager.orphanPointers.pointers, - isEmpty, - ); - }); + // Check that the root was unaffected + expect( + root.pointerManager.familyPointers, + isEmpty, + ); + expect( + root.pointerManager.orphanPointers.pointers, + isEmpty, + ); + }); - test('skips auto-scoping if the provider is manually overridden', () { - final dep = Provider( - (_) => 0, - dependencies: const [], - ); - final family = Provider.family( - (ref, id) => 0, - dependencies: [dep], - ); - final familyOverride = family.overrideWith((ref, arg) => 0); - final provider = Provider((_) => 0, dependencies: [dep]); - final providerOverride = provider.overrideWithValue(42); + test('skips auto-scoping if the provider is manually overridden', () { + final dep = Provider( + (_) => 0, + dependencies: const [], + ); + final family = Provider.family( + (ref, id) => 0, + dependencies: [dep], + ); + final familyOverride = family.overrideWith((ref, arg) => 0); + final provider = Provider((_) => 0, dependencies: [dep]); + final providerOverride = provider.overrideWithValue(42); - final root = ProviderContainer.test(); - final mid = ProviderContainer.test( - parent: root, - overrides: [familyOverride, providerOverride], - ); - final container = ProviderContainer.test( - parent: mid, - overrides: [dep.overrideWithValue(42)], - ); + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( + parent: root, + overrides: [familyOverride, providerOverride], + ); + final container = ProviderContainer.test( + parent: mid, + overrides: [dep.overrideWithValue(42)], + ); - container.pointerManager.upsertPointer(family(42)); - container.pointerManager.upsertPointer(provider); + container.pointerManager.upsertPointer(family(42)); + container.pointerManager.upsertPointer(provider); - expect( - container.pointerManager.familyPointers, - { - family: isProviderDirectory( - targetContainer: mid, - override: familyOverride, + expect( + container.pointerManager.familyPointers, + { + family: isProviderDirectory( + targetContainer: mid, + override: familyOverride, + pointers: { + family(42): isPointer( + targetContainer: mid, + override: null, + ), + }, + ), + }, + ); + expect( + container.pointerManager.orphanPointers, + isProviderDirectory( + targetContainer: root, + override: null, pointers: { - family(42): isPointer( + provider: isPointer( targetContainer: mid, - override: null, + override: providerOverride, ), + dep: isNotNull, }, ), - }, - ); - expect( - container.pointerManager.orphanPointers, - isProviderDirectory( - targetContainer: root, - override: null, - pointers: { - provider: isPointer( - targetContainer: mid, - override: providerOverride, - ), - dep: isNotNull, - }, - ), - ); - }); + ); + }); - test('auto-scoping inserts at the correct container', () { - final dep = Provider((_) => 0, dependencies: const [], name: 'dep'); - final dep2 = Provider((_) => 0, dependencies: const [], name: 'dep2'); + test('auto-scoping inserts at the correct container', () { + final dep = Provider((_) => 0, dependencies: const [], name: 'dep'); + final dep2 = Provider((_) => 0, dependencies: const [], name: 'dep2'); - final a = Provider((ref) => 0, dependencies: [dep], name: 'a'); - final b = Provider((ref) => 0, dependencies: [dep2], name: 'b'); - final c = Provider.family( - (ref, id) => 0, - dependencies: [dep], - name: 'c', - ); - final d = Provider.family( - (ref, id) => 0, - dependencies: [dep2], - name: 'd', - ); + final a = Provider((ref) => 0, dependencies: [dep], name: 'a'); + final b = Provider((ref) => 0, dependencies: [dep2], name: 'b'); + final c = Provider.family( + (ref, id) => 0, + dependencies: [dep], + name: 'c', + ); + final d = Provider.family( + (ref, id) => 0, + dependencies: [dep2], + name: 'd', + ); - final root = ProviderContainer.test(); - final mid = ProviderContainer.test(parent: root, overrides: [dep]); - final mid2 = ProviderContainer.test(parent: mid, overrides: [dep2]); - final leaf = ProviderContainer.test( - parent: mid2, - overrides: [ - // Disable scoping optimization - Provider((ref) => null, dependencies: const []), - ], - ); + final root = ProviderContainer.test(); + final mid = ProviderContainer.test(parent: root, overrides: [dep]); + final mid2 = ProviderContainer.test(parent: mid, overrides: [dep2]); + final leaf = ProviderContainer.test( + parent: mid2, + overrides: [ + // Disable scoping optimization + Provider((ref) => null, dependencies: const []), + ], + ); - leaf.pointerManager.upsertPointer(a); - leaf.pointerManager.upsertPointer(b); - leaf.pointerManager.upsertPointer(c(0)); - leaf.pointerManager.upsertPointer(d(0)); + leaf.pointerManager.upsertPointer(a); + leaf.pointerManager.upsertPointer(b); + leaf.pointerManager.upsertPointer(c(0)); + leaf.pointerManager.upsertPointer(d(0)); - expect( - leaf.pointerManager.orphanPointers, - isProviderDirectory( - targetContainer: root, - override: null, - pointers: allOf( - containsPair( - a, - isPointer( - targetContainer: mid, - override: isTransitiveProviderOverride(a), + expect( + leaf.pointerManager.orphanPointers, + isProviderDirectory( + targetContainer: root, + override: null, + pointers: allOf( + containsPair( + a, + isPointer( + targetContainer: mid, + override: isTransitiveProviderOverride(a), + ), ), - ), - containsPair( - b, - isPointer( - targetContainer: mid2, - override: isTransitiveProviderOverride(b), + containsPair( + b, + isPointer( + targetContainer: mid2, + override: isTransitiveProviderOverride(b), + ), ), ), ), - ), - ); + ); - expect( - leaf.pointerManager.familyPointers, - { - c: isProviderDirectory( - targetContainer: mid, - override: isTransitiveFamilyOverride(c), - pointers: { - c(0): isPointer(targetContainer: mid, override: null), - }, - ), - d: isProviderDirectory( - targetContainer: mid2, - override: isTransitiveFamilyOverride(d), - pointers: { - d(0): isPointer(targetContainer: mid2, override: null), - }, - ), - }, - ); + expect( + leaf.pointerManager.familyPointers, + { + c: isProviderDirectory( + targetContainer: mid, + override: isTransitiveFamilyOverride(c), + pointers: { + c(0): isPointer(targetContainer: mid, override: null), + }, + ), + d: isProviderDirectory( + targetContainer: mid2, + override: isTransitiveFamilyOverride(d), + pointers: { + d(0): isPointer(targetContainer: mid2, override: null), + }, + ), + }, + ); + }); + + test('when overriding a family provider', () { + final a = Provider.family.autoDispose( + (ref, value) => 'root $value', + dependencies: [], + name: 'a', + ); + + final b = Provider.family.autoDispose( + (ref, value) => ref.watch(a(value)), + dependencies: [a], + name: 'b', + ); + + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [a('42').overrideWith((ref) => 'override 42')], + ); + + expect(container.read(b('42')), 'override 42'); + }); + + test('when overriding both a family and one provider from said family', + () { + final a = Provider.family.autoDispose( + (ref, value) => 'root $value', + dependencies: [], + name: 'a', + ); + final b = Provider.family.autoDispose( + (ref, value) => ref.watch(a(value)), + dependencies: [a], + name: 'b', + ); + + final root = ProviderContainer.test(); + final mid = ProviderContainer.test( + parent: root, + overrides: [a.overrideWith((ref, _) => 'mid')], + ); + final container = ProviderContainer.test( + parent: mid, + overrides: [a('42').overrideWith((ref) => 'override 42')], + ); + + final mid2 = ProviderContainer.test( + parent: root, + overrides: [a('42').overrideWith((ref) => 'mid')], + ); + final container2 = ProviderContainer.test( + parent: mid2, + overrides: [a.overrideWith((ref, value) => 'override $value')], + ); + + expect(container.read(b('42')), 'override 42'); + expect(container2.read(b('21')), 'override 21'); + }); }); test( From 412bba7ab36968b30c6c0107f1a6e5d38da3d90d Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Mar 2024 14:57:24 +0100 Subject: [PATCH 258/387] Changelog --- packages/riverpod/CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 31d783a54..f1bdfd1da 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -5,6 +5,7 @@ - `Stream/FutureProvider.overrideWithValue` was added back. - Updated `AsyncValue` documentations to use pattern matching. - Added support for `Ref/ProviderContainer.invalidate(provider, asReload: true)` +- Fixed a bug when overriding a specific provider of a `family`, combined with `dependencies: [family]` ## 3.0.0-dev.3 - 2023-11-27 From 3c47a0a006a11a4a5f0c07608b1e923394d6ac0d Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Mar 2024 15:11:08 +0100 Subject: [PATCH 259/387] Correctly close pending scheduler timers when disposing containers --- .../test/provider_container_test.dart | 21 +++++++++++++++++++ packages/riverpod/lib/src/core/scheduler.dart | 16 ++++++++++---- 2 files changed, 33 insertions(+), 4 deletions(-) create mode 100644 packages/flutter_riverpod/test/provider_container_test.dart diff --git a/packages/flutter_riverpod/test/provider_container_test.dart b/packages/flutter_riverpod/test/provider_container_test.dart new file mode 100644 index 000000000..71478bb5a --- /dev/null +++ b/packages/flutter_riverpod/test/provider_container_test.dart @@ -0,0 +1,21 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +void main() { + group('ProviderContainer', () { + testWidgets('Does not cause Timer issue when used in widget tests', + (tester) async { + final root = ProviderContainer.test(); + final container = ProviderContainer.test(parent: root); + final provider = Provider((ref) => 0); + + root.read(provider); + root.invalidate(provider); + container.read(provider); + container.invalidate(provider); + + // Needed due to https://github.com/flutter/flutter/issues/144472 + root.dispose(); + }); + }); +} diff --git a/packages/riverpod/lib/src/core/scheduler.dart b/packages/riverpod/lib/src/core/scheduler.dart index 8544ce1e1..73a41955d 100644 --- a/packages/riverpod/lib/src/core/scheduler.dart +++ b/packages/riverpod/lib/src/core/scheduler.dart @@ -5,8 +5,10 @@ part of '../framework.dart'; @internal typedef Vsync = void Function(void Function()); -void _defaultVsync(void Function() task) { - Future(task); +void Function()? _defaultVsync(void Function() task) { + final timer = Timer(Duration.zero, task); + + return timer.cancel; } /// The object that handles when providers are refreshed and disposed. @@ -28,7 +30,7 @@ class ProviderScheduler { /// /// Defaults to refreshing providers at the end of the next event-loop. @internal - void Function(void Function()) get vsync { + void Function()? Function(void Function()) get vsync { if (flutterVsyncs.isNotEmpty) { // Notify all InheritedWidgets of a possible rebuild. // At the same time, we only execute the task once, in whichever @@ -44,6 +46,8 @@ class ProviderScheduler { for (final flutterVsync in flutterVsyncs) { flutterVsync(invoke); } + + return; }; } @@ -56,6 +60,8 @@ class ProviderScheduler { Completer? _pendingTaskCompleter; Future? get pendingFuture => _pendingTaskCompleter?.future; + void Function()? _cancel; + void scheduleProviderRefresh(ProviderElementBase element) { _stateToRefresh.add(element); @@ -71,10 +77,11 @@ class ProviderScheduler { // disposed. if (_pendingTaskCompleter != null || _disposed) return; _pendingTaskCompleter = Completer(); - vsync(_task); + _cancel = vsync(_task); } void _task() { + _cancel = null; final pendingTaskCompleter = _pendingTaskCompleter; if (pendingTaskCompleter == null) return; pendingTaskCompleter.complete(); @@ -129,5 +136,6 @@ class ProviderScheduler { _disposed = true; _pendingTaskCompleter?.complete(); _pendingTaskCompleter = null; + _cancel?.call(); } } From 87b7dc518b3d59e0dd0759f9dd446e986a87ea26 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Mar 2024 19:31:07 +0100 Subject: [PATCH 260/387] `ref.invalidate` now correctly clear all resources associated with the provider if the provider is no-longer used. fixes #2729 --- packages/riverpod/CHANGELOG.md | 2 + .../riverpod/lib/src/framework/element.dart | 1 + .../framework/provider_container_test.dart | 17 +++++++ .../riverpod/test/framework/ref_test.dart | 45 +++++++++++++++++++ 4 files changed, 65 insertions(+) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 4031d6b80..502378e0f 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -2,6 +2,8 @@ - Improved `Provider(dependencies: [...])` documentation. - Fix out of date `pub.dev` description +- `ref.invalidate` now correctly clear all resources associated + with the provider if the provider is no-longer used. ## 2.5.0 - 2024-02-03 diff --git a/packages/riverpod/lib/src/framework/element.dart b/packages/riverpod/lib/src/framework/element.dart index 2d64128fb..6fdef36dd 100644 --- a/packages/riverpod/lib/src/framework/element.dart +++ b/packages/riverpod/lib/src/framework/element.dart @@ -297,6 +297,7 @@ abstract class ProviderElementBase implements Ref, Node { _mustRecomputeState = true; runOnDispose(); + mayNeedDispose(); _container.scheduler.scheduleProviderRefresh(this); // We don't call this._markDependencyMayHaveChanged here because we voluntarily diff --git a/packages/riverpod/test/framework/provider_container_test.dart b/packages/riverpod/test/framework/provider_container_test.dart index b110fe0ef..b9a44e9a7 100644 --- a/packages/riverpod/test/framework/provider_container_test.dart +++ b/packages/riverpod/test/framework/provider_container_test.dart @@ -7,6 +7,23 @@ import '../utils.dart'; void main() { group('ProviderContainer', () { + group('invalidate', () { + test('can disposes of the element if not used anymore', () async { + final provider = Provider.autoDispose((r) { + r.keepAlive(); + return 0; + }); + final container = createContainer(); + + container.read(provider); + container.invalidate(provider); + + await container.pump(); + + expect(container.getAllProviderElements(), isEmpty); + }); + }); + test('Supports unmounting containers in reverse order', () { final container = createContainer(); diff --git a/packages/riverpod/test/framework/ref_test.dart b/packages/riverpod/test/framework/ref_test.dart index 793defd4a..1ec8938b6 100644 --- a/packages/riverpod/test/framework/ref_test.dart +++ b/packages/riverpod/test/framework/ref_test.dart @@ -6,6 +6,51 @@ import '../utils.dart'; void main() { group('Ref', () { + group('invalidateSelf', () { + test('can disposes of the element if not used anymore', () async { + late Ref ref; + final provider = Provider.autoDispose((r) { + ref = r; + r.keepAlive(); + return 0; + }); + final container = createContainer(); + + container.read(provider); + ref.invalidateSelf(); + + await container.pump(); + + expect(container.getAllProviderElements(), isEmpty); + }); + }); + + group('invalidate', () { + test('can disposes of the element if not used anymore', () async { + late Ref ref; + final dep = Provider((r) { + ref = r; + return 0; + }); + final provider = Provider.autoDispose((r) { + r.keepAlive(); + return 0; + }); + final container = createContainer(); + + container.read(dep); + container.read(provider); + ref.invalidate(provider); + + await container.pump(); + + expect( + container.getAllProviderElements().map((e) => e.origin), + [dep], + ); + }); + }); + test( 'cannot call ref.watch/ref.read/ref.listen/ref.onDispose after a dependency changed', () { From 5ccbfe49d98b06e9ee556916c14865da4aeb173f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 7 Mar 2024 10:46:13 +0100 Subject: [PATCH 261/387] Init changeset --- .changeset/README.md | 8 ++++++++ .changeset/config.json | 11 +++++++++++ 2 files changed, 19 insertions(+) create mode 100644 .changeset/README.md create mode 100644 .changeset/config.json diff --git a/.changeset/README.md b/.changeset/README.md new file mode 100644 index 000000000..e5b6d8d6a --- /dev/null +++ b/.changeset/README.md @@ -0,0 +1,8 @@ +# Changesets + +Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works +with multi-package repos, or single-package repos to help you version and publish your code. You can +find the full documentation for it [in our repository](https://github.com/changesets/changesets) + +We have a quick list of common questions to get you started engaging with this project in +[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md) diff --git a/.changeset/config.json b/.changeset/config.json new file mode 100644 index 000000000..91b6a9512 --- /dev/null +++ b/.changeset/config.json @@ -0,0 +1,11 @@ +{ + "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json", + "changelog": "@changesets/cli/changelog", + "commit": false, + "fixed": [], + "linked": [], + "access": "restricted", + "baseBranch": "main", + "updateInternalDependencies": "patch", + "ignore": [] +} From 810ccb8516ec13bd6fbfe448ae75cea100731476 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 7 Mar 2024 13:49:04 +0100 Subject: [PATCH 262/387] Disable changelog set --- .github/workflows/changelog.yml | 27 --------------------------- 1 file changed, 27 deletions(-) delete mode 100644 .github/workflows/changelog.yml diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml deleted file mode 100644 index 41213eaeb..000000000 --- a/.github/workflows/changelog.yml +++ /dev/null @@ -1,27 +0,0 @@ -name: Check CHANGELOG.md - -on: - pull_request: - -jobs: - changelog: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v3.1.0 - with: - fetch-depth: 2 - - uses: subosito/flutter-action@v2.7.1 - with: - channel: master - - - name: Add pub cache bin to PATH - run: echo "$HOME/.pub-cache/bin" >> $GITHUB_PATH - - name: Add pub cache to PATH - run: echo "PUB_CACHE="$HOME/.pub-cache"" >> $GITHUB_ENV - - - name: Install "semantic_changelog" - run: dart pub global activate -s git https://github.com/rrousselGit/semantic_changelog - - - run: git fetch origin dev:refs/remotes/origin/dev - - run: semantic_changelog check origin/dev \ No newline at end of file From 507613254f4ee26a4dbb12ac7afc6dabd20964f2 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 7 Mar 2024 13:51:54 +0100 Subject: [PATCH 263/387] Separate Ref and ProviderElement (#3389) --- examples/pub/lib/detail.g.dart | 11 +- examples/pub/lib/search.g.dart | 2 +- examples/stackoverflow/lib/common.g.dart | 3 +- examples/stackoverflow/lib/question.g.dart | 4 +- examples/stackoverflow/lib/tag.g.dart | 3 +- .../flutter_riverpod/lib/src/builders.dart | 8 +- .../legacy/change_notifier_provider.dart | 35 +- ...dispose_change_notifier_provider_test.dart | 4 +- .../change_notifier_provider_test.dart | 16 +- packages/riverpod/lib/riverpod.dart | 2 + packages/riverpod/lib/src/builder.dart | 19 +- .../riverpod/lib/src/core/async_value.dart | 31 +- packages/riverpod/lib/src/core/element.dart | 566 ++---- packages/riverpod/lib/src/core/family.dart | 37 +- .../lib/src/core/modifiers/future.dart | 35 +- .../lib/src/core/modifiers/select.dart | 3 +- .../lib/src/core/modifiers/select_async.dart | 4 +- .../lib/src/core/override_with_value.dart | 2 +- .../core/provider/functional_provider.dart | 9 +- .../src/core/provider/notifier_provider.dart | 15 +- .../src/core/proxy_provider_listenable.dart | 1 + packages/riverpod/lib/src/core/ref.dart | 342 +++- packages/riverpod/lib/src/core/scheduler.dart | 2 +- .../src/providers/async_notifier/family.dart | 3 +- .../lib/src/providers/future_provider.dart | 17 +- .../legacy/state_notifier_provider.dart | 41 +- .../src/providers/legacy/state_provider.dart | 29 +- .../riverpod/lib/src/providers/notifier.dart | 2 +- .../lib/src/providers/notifier/family.dart | 3 +- .../riverpod/lib/src/providers/provider.dart | 17 +- .../src/providers/stream_notifier/family.dart | 3 +- .../lib/src/providers/stream_provider.dart | 20 +- packages/riverpod/test/new/core/ref_test.dart | 1537 +++++++++++++++-- .../test/new/core/uni_directional_test.dart | 2 +- packages/riverpod/test/new/utils.dart | 18 + .../framework/provider_container_test.dart | 4 +- .../old/framework/provider_element_test.dart | 1113 ------------ .../test/old/legacy/framework_test.dart | 74 +- ..._dispose_state_notifier_provider_test.dart | 4 +- .../state_notifier_provider_test.dart | 13 +- .../state_provider_auto_dispose_test.dart | 67 - .../state_provider/state_provider_test.dart | 72 +- .../provider/provider_test.dart | 10 +- .../scoped_provider/scoped_provider_test.dart | 44 - .../lib/riverpod_annotation.dart | 1 + .../lib/src/riverpod_annotation.dart | 8 +- .../integration/build_yaml/lib/main.g.dart | 20 +- .../lib/src/templates/notifier.dart | 4 +- .../lib/src/templates/provider.dart | 3 +- .../test/integration/annotated.g.dart | 13 +- .../test/integration/async.g.dart | 22 +- .../test/integration/auto_dispose.g.dart | 18 +- .../test/integration/dependencies.g.dart | 36 +- .../test/integration/dependencies2.g.dart | 11 +- .../test/integration/documented.g.dart | 8 +- .../test/integration/generated.g.dart | 33 +- .../test/integration/hash/hash1.g.dart | 6 +- .../test/integration/scopes.g.dart | 2 +- .../test/integration/split.g.dart | 4 +- .../test/integration/stream.g.dart | 13 +- .../test/integration/sync.g.dart | 62 +- .../generated/golden/lib/sync.g.dart | 14 +- ..._class_based_provider_to_functional.g.dart | 2 +- ..._functional_provider_to_class_based.g.dart | 5 +- .../avoid_build_context_in_providers.g.dart | 4 +- .../avoid_public_notifier_properties.g.dart | 2 +- .../functional_ref/functional_ref.g.dart | 12 +- ...ly_use_keep_alive_inside_keep_alive.g.dart | 8 +- .../protected_notifier_properties.g.dart | 16 +- .../provider_dependencies/another.g.dart | 8 +- .../missing_dependencies.g.dart | 27 +- .../missing_dependencies2.g.dart | 47 +- .../unused_dependency.g.dart | 20 +- .../test/lints/provider_parameters.g.dart | 3 +- ...oviders_should_specify_dependencies.g.dart | 4 +- .../test/lints/unknown_scoped_usage.g.dart | 4 +- .../lints/unsupported_provider_value.g.dart | 61 +- .../bin/generate_providers.dart | 6 +- .../advanced/select/select/codegen.g.dart | 2 +- .../select/select_async/codegen.g.dart | 5 +- .../cancel/detail_screen/codegen.g.dart | 4 +- .../detail_screen_cancel/codegen.g.dart | 4 +- .../detail_screen_debounce/codegen.g.dart | 4 +- .../provider_with_extension/codegen.g.dart | 4 +- .../fetch_activity/codegen.g.dart | 4 +- .../pull_to_refresh/full_app/codegen.g.dart | 4 +- .../docs/concepts/about_codegen/main.g.dart | 2 +- .../provider_type/async_fn_future.g.dart | 4 +- .../provider_type/async_fn_stream.g.dart | 2 +- .../provider_type/auto_dispose.g.dart | 6 +- .../about_codegen/provider_type/family.g.dart | 3 +- .../provider_type/family_class.g.dart | 2 +- .../provider_type/family_fn.g.dart | 3 +- .../provider_type/sync_fn.g.dart | 3 +- .../characters_provider/codegen.g.dart | 7 +- .../city_provider/codegen.g.dart | 2 +- .../codegen.g.dart | 5 +- .../read_in_provider/codegen.g.dart | 5 +- .../select_async_provider/codegen.g.dart | 4 +- .../weather_provider/codegen.g.dart | 6 +- .../whole_object_provider/codegen.g.dart | 4 +- .../lifecycle_on_dispose/codegen.g.dart | 2 +- .../creating_a_provider/codegen.g.dart | 2 +- .../declaring_many_providers/codegen.g.dart | 5 +- .../concepts/reading/counter/codegen.g.dart | 2 +- .../concepts/reading/listen/codegen.g.dart | 2 +- .../concepts/reading/provider/codegen.g.dart | 4 +- .../concepts/reading/watch/codegen.g.dart | 4 +- .../reading/watch_build/codegen.g.dart | 2 +- .../reading/watch_build/codegen_hooks.g.dart | 2 +- .../cache_for_usage/codegen.g.dart | 4 +- .../auto_dispose/codegen_keep_alive.g.dart | 2 +- .../invalidate_family_example/codegen.g.dart | 2 +- .../auto_dispose/keep_alive/codegen.g.dart | 4 +- .../on_dispose_example/codegen.g.dart | 4 +- .../functional_ref/codegen.g.dart | 4 +- .../listen_example/codegen.g.dart | 4 +- .../notifier_ref/codegen.g.dart | 2 +- .../read_example/codegen.g.dart | 2 +- .../watch_example/codegen.g.dart | 5 +- .../watch_placement/codegen.g.dart | 4 +- .../require_value/codegen.g.dart | 4 +- .../first_request/codegen/provider.g.dart | 4 +- .../passing_args/family/codegen.g.dart | 7 +- .../no_arg_provider/codegen.g.dart | 4 +- .../codegen/todo_list_provider.g.dart | 4 +- .../testing/provider_to_mock/codegen.g.dart | 4 +- .../pipe_change_notifier.g.dart | 5 +- .../websockets_sync/raw_usage.g.dart | 7 +- .../shared_pipe_change_notifier.g.dart | 7 +- .../stream_provider/codegen.g.dart | 2 +- .../sync_definition/codegen.g.dart | 3 +- .../docs/from_provider/family/family.g.dart | 2 +- .../async_values/async_values.g.dart | 6 +- .../auto_dispose/auto_dispose.g.dart | 5 +- .../motivation/combine/combine.g.dart | 4 +- .../motivation/same_type/same_type.g.dart | 5 +- .../dart_hello_world/main.g.dart | 3 +- .../hello_world/hooks_codegen/main.g.dart | 3 +- .../getting_started/hello_world/main.g.dart | 3 +- .../introduction/why_riverpod/codegen.g.dart | 2 +- .../family_and_dispose.g.dart | 10 +- .../old_lifecycles_final.g.dart | 6 +- .../config_provider/codegen.g.dart | 4 +- .../completed_todos/completed_todos.g.dart | 2 +- .../optimized_previous_button.g.dart | 3 +- .../live_stream_chat_provider/codegen.g.dart | 4 +- website/static/snippets/async.g.dart | 2 +- website/static/snippets/combine.g.dart | 8 +- website/static/snippets/create.g.dart | 4 +- 150 files changed, 2392 insertions(+), 2640 deletions(-) diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index b94300a4d..9d4cf8519 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -13,8 +13,8 @@ typedef FetchPackageDetailsRef = Ref>; @ProviderFor(fetchPackageDetails) const fetchPackageDetailsProvider = FetchPackageDetailsFamily._(); -final class FetchPackageDetailsProvider extends $FunctionalProvider< - AsyncValue, FutureOr, FetchPackageDetailsRef> +final class FetchPackageDetailsProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { @@ -141,7 +141,7 @@ typedef LikedPackagesRef = Ref>>; const likedPackagesProvider = LikedPackagesProvider._(); final class LikedPackagesProvider extends $FunctionalProvider< - AsyncValue>, FutureOr>, LikedPackagesRef> + AsyncValue>, FutureOr>> with $FutureModifier>, $FutureProvider, LikedPackagesRef> { @@ -196,7 +196,7 @@ typedef PubRepositoryRef = Ref; const pubRepositoryProvider = PubRepositoryProvider._(); final class PubRepositoryProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const PubRepositoryProvider._( {PubRepository Function( @@ -417,8 +417,7 @@ final class PackageMetricsFamily extends Family { } abstract class _$PackageMetrics extends $AsyncNotifier { - late final _$args = - (ref as $AsyncNotifierProviderElement).origin.argument as String; + late final _$args = ref.$arg as String; String get packageName => _$args; FutureOr build({ diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 0107f4982..23790cab4 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -14,7 +14,7 @@ typedef FetchPackagesRef = Ref>>; const fetchPackagesProvider = FetchPackagesFamily._(); final class FetchPackagesProvider extends $FunctionalProvider< - AsyncValue>, FutureOr>, FetchPackagesRef> + AsyncValue>, FutureOr>> with $FutureModifier>, $FutureProvider, FetchPackagesRef> { diff --git a/examples/stackoverflow/lib/common.g.dart b/examples/stackoverflow/lib/common.g.dart index ac6cabe8e..63b1a4c40 100644 --- a/examples/stackoverflow/lib/common.g.dart +++ b/examples/stackoverflow/lib/common.g.dart @@ -25,8 +25,7 @@ const themeProvider = ThemeProvider._(); /// /// This is unimplemented by default, and will be overridden inside [MaterialApp] /// with the current theme obtained using a [BuildContext]. -final class ThemeProvider - extends $FunctionalProvider +final class ThemeProvider extends $FunctionalProvider with $Provider { /// A Provider that exposes the current theme. /// diff --git a/examples/stackoverflow/lib/question.g.dart b/examples/stackoverflow/lib/question.g.dart index 9f5c18fd1..9e663d100 100644 --- a/examples/stackoverflow/lib/question.g.dart +++ b/examples/stackoverflow/lib/question.g.dart @@ -104,8 +104,8 @@ const currentQuestionProvider = CurrentQuestionProvider._(); /// /// This is an optional step. Since scoping is a fairly advanced mechanism, /// it's entirely fine to simply pass the [Question] to [QuestionItem] directly. -final class CurrentQuestionProvider extends $FunctionalProvider< - AsyncValue, AsyncValue, CurrentQuestionRef> +final class CurrentQuestionProvider + extends $FunctionalProvider, AsyncValue> with $Provider, CurrentQuestionRef> { /// A scoped provider, exposing the current question used by [QuestionItem]. /// diff --git a/examples/stackoverflow/lib/tag.g.dart b/examples/stackoverflow/lib/tag.g.dart index d0eb461df..453f84ab8 100644 --- a/examples/stackoverflow/lib/tag.g.dart +++ b/examples/stackoverflow/lib/tag.g.dart @@ -13,8 +13,7 @@ typedef TagThemeRef = Ref; @ProviderFor(tagTheme) const tagThemeProvider = TagThemeProvider._(); -final class TagThemeProvider - extends $FunctionalProvider +final class TagThemeProvider extends $FunctionalProvider with $Provider { const TagThemeProvider._( {TagTheme Function( diff --git a/packages/flutter_riverpod/lib/src/builders.dart b/packages/flutter_riverpod/lib/src/builders.dart index cd025b087..8b5a5d852 100644 --- a/packages/flutter_riverpod/lib/src/builders.dart +++ b/packages/flutter_riverpod/lib/src/builders.dart @@ -228,8 +228,7 @@ class ChangeNotifierProviderFamilyBuilder { /// {@endtemplate} ChangeNotifierProviderFamily call( - NotifierT Function(ChangeNotifierProviderRef ref, ArgT param) - create, { + NotifierT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, }) { @@ -299,7 +298,7 @@ class AutoDisposeChangeNotifierProviderBuilder { /// {@macro riverpod.family} ChangeNotifierProvider call( - NotifierT Function(ChangeNotifierProviderRef ref) create, { + NotifierT Function(Ref ref) create, { String? name, Iterable? dependencies, }) { @@ -323,8 +322,7 @@ class AutoDisposeChangeNotifierProviderFamilyBuilder { /// {@macro riverpod.family} ChangeNotifierProviderFamily call( - NotifierT Function(ChangeNotifierProviderRef ref, ArgT param) - create, { + NotifierT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, }) { 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 index ebd9ecdc5..ffe447018 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -21,14 +21,7 @@ ProviderElementProxy ); } -/// {@macro riverpod.provider_ref_base} -abstract class ChangeNotifierProviderRef - implements Ref { - /// The [ChangeNotifier] currently exposed by this provider. - /// - /// Cannot be accessed while creating the provider. - NotifierT get notifier; -} +// TODO changelog breaking: Removed Ref. Use Ref instead /// Creates a [ChangeNotifier] and exposes its current state. /// @@ -89,8 +82,7 @@ abstract class ChangeNotifierProviderRef /// } /// ``` final class ChangeNotifierProvider - extends $FunctionalProvider> + extends $FunctionalProvider with LegacyProviderMixin { /// {@macro riverpod.change_notifier_provider} ChangeNotifierProvider( @@ -140,7 +132,7 @@ final class ChangeNotifierProvider /// has changes. Refreshable get notifier => _notifier(this); - final NotifierT Function(ChangeNotifierProviderRef ref) _createFn; + final NotifierT Function(Ref ref) _createFn; @internal @override @@ -154,7 +146,7 @@ final class ChangeNotifierProvider @visibleForOverriding @override ChangeNotifierProvider $copyWithCreate( - Create> create, + Create> create, ) { return ChangeNotifierProvider.internal( create, @@ -170,23 +162,21 @@ final class ChangeNotifierProvider /// The element of [ChangeNotifierProvider]. class ChangeNotifierProviderElement - extends ProviderElementBase - implements ChangeNotifierProviderRef { + extends ProviderElementBase { ChangeNotifierProviderElement._(this.provider, super.container); @override final ChangeNotifierProvider provider; - @override - NotifierT get notifier => _notifierNotifier.value; final _notifierNotifier = ProxyElementValueListenable(); void Function()? _removeListener; @override - void create({required bool didChangeDependency}) { - final notifierResult = - _notifierNotifier.result = Result.guard(() => provider._createFn(this)); + void create(Ref ref, {required bool didChangeDependency}) { + final notifierResult = _notifierNotifier.result = Result.guard( + () => provider._createFn(ref), + ); // TODO test requireState, as ref.read(p) is expected to throw if notifier creation failed final notifier = notifierResult.requireState; @@ -234,8 +224,8 @@ class ChangeNotifierProviderElement /// The [Family] of [ChangeNotifierProvider]. class ChangeNotifierProviderFamily - extends FunctionalFamily, NotifierT, - Arg, NotifierT, ChangeNotifierProvider> { + extends FunctionalFamily> { /// The [Family] of [ChangeNotifierProvider]. ChangeNotifierProviderFamily( super._createFn, { @@ -250,8 +240,7 @@ class ChangeNotifierProviderFamily @override Override overrideWith( - NotifierT Function(ChangeNotifierProviderRef ref, Arg arg) - create, + NotifierT Function(Ref ref, Arg arg) create, ) { return $FamilyOverride( from: this, diff --git a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart index 1b7b296b9..33ff1c32b 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart @@ -24,7 +24,7 @@ void main() { test('can read and set current ChangeNotifier', () async { final container = createContainer(); final listener = Listener>(); - late ChangeNotifierProviderRef> ref; + late Ref> ref; final provider = ChangeNotifierProvider.autoDispose>((r) { ref = r; @@ -34,7 +34,7 @@ void main() { container.listen(provider, listener.call); verifyZeroInteractions(listener); - expect(ref.notifier.value, 0); + expect(ref.state.value, 0); }); test('can refresh .notifier', () async { diff --git a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart index b56f4d1a4..7e60c2d20 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart @@ -18,12 +18,10 @@ void main() { final container = createContainer( overrides: [ provider.overrideWith( - (ChangeNotifierProviderRef> ref) => - ValueNotifier(42), + (Ref> ref) => ValueNotifier(42), ), autoDispose.overrideWith( - (ChangeNotifierProviderRef> ref) => - ValueNotifier(84), + (Ref> ref) => ValueNotifier(84), ), ], ); @@ -43,12 +41,10 @@ void main() { final container = createContainer( overrides: [ family.overrideWith( - (ChangeNotifierProviderRef> ref, int arg) => - ValueNotifier('42 $arg'), + (Ref> ref, int arg) => ValueNotifier('42 $arg'), ), autoDisposeFamily.overrideWith( - (ChangeNotifierProviderRef> ref, int arg) => - ValueNotifier('84 $arg'), + (Ref> ref, int arg) => ValueNotifier('84 $arg'), ), ], ); @@ -87,7 +83,7 @@ void main() { test('can read and set current ChangeNotifier', () async { final container = createContainer(); final listener = Listener>(); - late ChangeNotifierProviderRef> ref; + late Ref> ref; final provider = ChangeNotifierProvider>((r) { ref = r; return ValueNotifier(0); @@ -96,7 +92,7 @@ void main() { container.listen(provider, listener.call); verifyZeroInteractions(listener); - expect(ref.notifier.value, 0); + expect(ref.state.value, 0); }); test('can refresh .notifier', () async { diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 792024871..9359e1ae8 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -16,6 +16,7 @@ export 'src/framework.dart' $ProviderOverride, ClassProviderFactory, FunctionalProviderFactory, + $RefArg, computeAllTransitiveDependencies, Create, Node, @@ -26,6 +27,7 @@ export 'src/framework.dart' TransitiveFamilyOverride, TransitiveProviderOverride, ProviderPointer, + UnmountedRefException, ProviderPointerManager, ProviderDirectory, $AsyncClassModifier, diff --git a/packages/riverpod/lib/src/builder.dart b/packages/riverpod/lib/src/builder.dart index 6a48e7d43..034a3c5aa 100644 --- a/packages/riverpod/lib/src/builder.dart +++ b/packages/riverpod/lib/src/builder.dart @@ -229,7 +229,7 @@ class StateProviderFamilyBuilder { /// ``` /// {@endtemplate} StateProviderFamily call( - StateT Function(StateProviderRef ref, ArgT param) create, { + StateT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, }) { @@ -299,7 +299,7 @@ class AutoDisposeStateProviderBuilder { /// {@macro riverpod.family} StateProvider call( - StateT Function(StateProviderRef ref) create, { + StateT Function(Ref ref) create, { String? name, Iterable? dependencies, }) { @@ -322,7 +322,7 @@ class AutoDisposeStateProviderFamilyBuilder { /// {@macro riverpod.family} StateProviderFamily call( - StateT Function(StateProviderRef ref, ArgT param) create, { + StateT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, }) { @@ -342,10 +342,7 @@ class StateNotifierProviderFamilyBuilder { /// {@macro riverpod.family} StateNotifierProviderFamily call, StateT, ArgT>( - NotifierT Function( - StateNotifierProviderRef ref, - ArgT param, - ) create, { + NotifierT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, }) { @@ -368,8 +365,7 @@ class AutoDisposeStateNotifierProviderBuilder { /// {@macro riverpod.family} StateNotifierProvider call, StateT>( - NotifierT Function(StateNotifierProviderRef ref) - create, { + NotifierT Function(Ref ref) create, { String? name, Iterable? dependencies, }) { @@ -393,10 +389,7 @@ class AutoDisposeStateNotifierProviderFamilyBuilder { /// {@macro riverpod.family} StateNotifierProviderFamily call, StateT, ArgT>( - NotifierT Function( - StateNotifierProviderRef ref, - ArgT param, - ) create, { + NotifierT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, }) { diff --git a/packages/riverpod/lib/src/core/async_value.dart b/packages/riverpod/lib/src/core/async_value.dart index 82530a552..fdba00e73 100644 --- a/packages/riverpod/lib/src/core/async_value.dart +++ b/packages/riverpod/lib/src/core/async_value.dart @@ -1,40 +1,13 @@ import 'package:meta/meta.dart'; -import '../common/result.dart'; import '../common/stack_trace.dart'; import '../framework.dart'; import '../providers/future_provider.dart' show FutureProvider; import '../providers/stream_provider.dart' show StreamProvider; -/// An extension for [asyncTransition]. @internal -extension AsyncTransition on ProviderElementBase> { - /// Internal utility for transitioning an [AsyncValue] after a provider refresh. - /// - /// [seamless] controls how the previous state is preserved: - /// - seamless:true => import previous state and skip loading - /// - seamless:false => import previous state and prefer loading - void asyncTransition( - AsyncValue newState, { - required bool seamless, - }) { -// ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member - final previous = stateResult?.requireState; - - if (previous == null) { -// ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member - setStateResult(ResultData(newState)); - } else { -// ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member - setStateResult( - ResultData( - newState - ._cast() - .copyWithPrevious(previous, isRefresh: seamless), - ), - ); - } - } +extension AsyncTransition on AsyncValue { + AsyncValue cast() => _cast(); } /// A utility for safely manipulating asynchronous data. diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 1e840ba52..d35ce318a 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -42,19 +42,13 @@ void Function()? debugCanModifyProviders; /// {@endtemplate} // TODO rename to ProviderElement @internal -abstract class ProviderElementBase implements Ref, Node { +abstract class ProviderElementBase implements Node { /// {@macro riverpod.provider_element_base} // TODO changelog: ProviderElement no-longer takes a provider as parameter but takes a ProviderContainer ProviderElementBase(this.container); static ProviderElementBase? _debugCurrentlyBuildingElement; - @override - StateT get state => readSelf(); - - @override - set state(StateT newState) => setStateResult(ResultData(newState)); - /// The last result of [ProviderBase.debugGetCreateSourceHash]. /// /// Available only in debug mode. @@ -71,12 +65,13 @@ abstract class ProviderElementBase implements Ref, Node { ProviderBase get provider; /// The [ProviderContainer] that owns this [ProviderElementBase]. - @override final ProviderContainer container; + Ref? ref; + /// Whether this [ProviderElementBase] is currently listened to or not. /// - /// This maps to listeners added with [listen]. + /// This maps to listeners added with [Ref.listen]. /// See also [_mayNeedDispose], called when [hasListeners] may have changed. bool get hasListeners => _externalDependents.isNotEmpty || @@ -94,7 +89,7 @@ abstract class ProviderElementBase implements Ref, Node { /// The [ProviderSubscription]s associated to the providers that this /// [ProviderElementBase] listens to. /// - /// This list is typically updated when this provider calls [listen] on + /// This list is typically updated when this provider calls [Ref.listen] on /// another provider. final _listenedProviderSubscriptions = <_ProviderListener>[]; @@ -109,13 +104,6 @@ abstract class ProviderElementBase implements Ref, Node { var _dependencies = HashMap, Object>(); HashMap, Object>? _previousDependencies; - List? _onDisposeListeners; - List? _onResumeListeners; - List? _onCancelListeners; - List? _onAddListeners; - List? _onRemoveListeners; - List? _onChangeSelfListeners; - List? _onErrorSelfListeners; bool _mustRecomputeState = false; bool _dependencyMayHaveChanged = false; @@ -123,12 +111,6 @@ abstract class ProviderElementBase implements Ref, Node { var _didCancelOnce = false; - bool _mounted = false; - - /// Whether the element was disposed or not - @internal - bool get mounted => _mounted; - /// Whether the assert that prevents [requireState] from returning /// if the state was not set before is enabled. @visibleForOverriding @@ -136,7 +118,6 @@ abstract class ProviderElementBase implements Ref, Node { bool _debugDidSetState = false; bool _didBuild = false; - List? _keepAliveLinks; /* STATE */ Result? _stateResult; @@ -155,6 +136,15 @@ abstract class ProviderElementBase implements Ref, Node { @internal Result? get stateResult => _stateResult; + /// Returns the currently exposed by a provider + /// + /// May throw if the provider threw when creating the exposed value. + StateT readSelf() { + flush(); + + return requireState; + } + /// Update the exposed value of a provider and notify its listeners. /// /// Listeners will only be notified if [updateShouldNotify] @@ -223,23 +213,23 @@ This could mean a few things: _debugCurrentCreateHash = provider.debugGetCreateSourceHash(); if (previousHash != _debugCurrentCreateHash) { - invalidateSelf(); + invalidateSelf(asReload: false); } } /// Called the first time a provider is obtained. @internal void mount() { - _mounted = true; if (kDebugMode) { _debugCurrentCreateHash = provider.debugGetCreateSourceHash(); } - buildState(); + final ref = this.ref = Ref._(this); + buildState(ref); _stateResult!.map( data: (newState) { - final onChangeSelfListeners = _onChangeSelfListeners; + final onChangeSelfListeners = ref._onChangeSelfListeners; if (onChangeSelfListeners != null) { for (var i = 0; i < onChangeSelfListeners.length; i++) { Zone.current.runBinaryGuarded( @@ -260,7 +250,7 @@ This could mean a few things: } }, error: (newState) { - final onErrorSelfListeners = _onErrorSelfListeners; + final onErrorSelfListeners = ref._onErrorSelfListeners; if (onErrorSelfListeners != null) { for (var i = 0; i < onErrorSelfListeners.length; i++) { Zone.current.runBinaryGuarded( @@ -300,70 +290,6 @@ This could mean a few things: @visibleForOverriding void update(ProviderBase newProvider) {} - @override - void invalidate( - ProviderOrFamily providerOrFamily, { - bool asReload = false, - }) { - if (kDebugMode) _debugAssertCanDependOn(providerOrFamily); - container.invalidate(providerOrFamily, asReload: asReload); - } - - @override - void invalidateSelf({bool asReload = false}) { - if (asReload) _didChangeDependency = true; - if (_mustRecomputeState) return; - - _mustRecomputeState = true; - runOnDispose(); - _mayNeedDispose(); - container.scheduler.scheduleProviderRefresh(this); - - // We don't call this._markDependencyMayHaveChanged here because we voluntarily - // do not want to set the _dependencyMayHaveChanged flag to true. - // Since the dependency is known to have changed, there is no reason to try - // and "flush" it, as it will already get rebuilt. - visitChildren( - elementVisitor: (element) => element._markDependencyMayHaveChanged(), - listenableVisitor: (notifier) => - notifier.notifyDependencyMayHaveChanged(), - ); - } - - /// A utility for re-initializing a provider when needed. - /// - /// Calling [flush] will only re-initialize the provider if it needs to rerun. - /// This can involve: - /// - a previous call to [invalidateSelf] - /// - a dependency of the provider has changed (such as when using [watch]). - /// - /// This is not meant for public consumption. Public API should hide - /// [flush] from users, such that they don't need to care about invoking this function. - @internal - void flush() { - _maybeRebuildDependencies(); - if (_mustRecomputeState) { - _mustRecomputeState = false; - _performBuild(); - } - } - - /// Iterates over the dependencies of this provider, calling [flush] on them too. - /// - /// This work is only performed if a dependency has notified that it might - /// need to be re-executed. - void _maybeRebuildDependencies() { - if (!_dependencyMayHaveChanged) return; - - _dependencyMayHaveChanged = false; - - visitAncestors( - (element) { - element.flush(); - }, - ); - } - /// Initialize a provider and track dependencies used during the initialization. /// /// After a provider is initialized, this function takes care of unsubscribing @@ -372,11 +298,13 @@ This could mean a few things: _previousDependencies = _dependencies; _dependencies = HashMap(); + runOnDispose(); + final ref = this.ref = Ref._(this); final previousStateResult = _stateResult; if (kDebugMode) _debugDidSetState = false; - buildState(); + buildState(ref); if (!identical(_stateResult, previousStateResult)) { // Asserts would otherwise prevent a provider rebuild from updating @@ -405,13 +333,47 @@ This could mean a few things: /// state. Then, reading this provider will rethrow the thrown exception. /// /// - [didChangeDependency] can be used to differentiate a rebuild caused - /// by [watch] from one caused by [refresh]/[invalidate]. + /// by [Ref.watch] from one caused by [Ref.refresh]/[Ref.invalidate]. @visibleForOverriding - void create({required bool didChangeDependency}); + void create(Ref ref, {required bool didChangeDependency}); + + /// A utility for re-initializing a provider when needed. + /// + /// Calling [flush] will only re-initialize the provider if it needs to rerun. + /// This can involve: + /// - a previous call to [Ref.invalidateSelf] + /// - a dependency of the provider has changed (such as when using [Ref.watch]). + /// + /// This is not meant for public consumption. Public API should hide + /// [flush] from users, such that they don't need to care about invoking this function. + @internal + void flush() { + _maybeRebuildDependencies(); + if (_mustRecomputeState) { + _mustRecomputeState = false; + _performBuild(); + } + } + + /// Iterates over the dependencies of this provider, calling [flush] on them too. + /// + /// This work is only performed if a dependency has notified that it might + /// need to be re-executed. + void _maybeRebuildDependencies() { + if (!_dependencyMayHaveChanged) return; + + _dependencyMayHaveChanged = false; + + visitAncestors( + (element) { + element.flush(); + }, + ); + } /// Invokes [create] and handles errors. @internal - void buildState() { + void buildState(Ref ref) { ProviderElementBase? debugPreviouslyBuildingElement; final previousDidChangeDependency = _didChangeDependency; _didChangeDependency = false; @@ -422,9 +384,7 @@ This could mean a few things: _didBuild = false; try { - // TODO move outside this function? - _mounted = true; - create(didChangeDependency: previousDidChangeDependency); + create(ref, didChangeDependency: previousDidChangeDependency); } catch (err, stack) { if (kDebugMode) _debugDidSetState = true; @@ -442,22 +402,6 @@ This could mean a few things: } } - @override - void notifyListeners() { - final currentResult = stateResult; - // If `notifyListeners` is used during `build`, the result will be null. - // Throwing would be unnecessarily inconvenient, so we simply skip it. - if (currentResult == null) return; - - if (_didBuild) { - _notifyListeners( - currentResult, - currentResult, - checkUpdateShouldNotify: false, - ); - } - } - void _debugAssertNotificationAllowed() { if (_debugSkipNotifyListenersAsserts) return; @@ -474,6 +418,26 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu debugCanModifyProviders?.call(); } + void invalidateSelf({required bool asReload}) { + if (asReload) _didChangeDependency = true; + if (_mustRecomputeState) return; + + _mustRecomputeState = true; + runOnDispose(); + _mayNeedDispose(); + container.scheduler.scheduleProviderRefresh(this); + + // We don't call this._markDependencyMayHaveChanged here because we voluntarily + // do not want to set the _dependencyMayHaveChanged flag to true. + // Since the dependency is known to have changed, there is no reason to try + // and "flush" it, as it will already get rebuilt. + visitChildren( + elementVisitor: (element) => element._markDependencyMayHaveChanged(), + listenableVisitor: (notifier) => + notifier.notifyDependencyMayHaveChanged(), + ); + } + void _notifyListeners( Result newState, Result? previousStateResult, { @@ -486,7 +450,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu // listenSelf listeners do not respect updateShouldNotify newState.map( data: (newState) { - final onChangeSelfListeners = _onChangeSelfListeners; + final onChangeSelfListeners = ref?._onChangeSelfListeners; if (onChangeSelfListeners != null) { for (var i = 0; i < onChangeSelfListeners.length; i++) { Zone.current.runBinaryGuarded( @@ -498,7 +462,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } }, error: (newState) { - final onErrorSelfListeners = _onErrorSelfListeners; + final onErrorSelfListeners = ref?._onErrorSelfListeners; if (onErrorSelfListeners != null) { for (var i = 0; i < onErrorSelfListeners.length; i++) { Zone.current.runBinaryGuarded( @@ -601,128 +565,6 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ); } - void _debugAssertCanDependOn(ProviderListenableOrFamily listenable) { - final dependency = switch (listenable) { - ProviderOrFamily() => listenable, - _ => listenable.listenedProvider, - }; - - if (dependency == null) return; - - assert( - dependency != origin, - 'A provider cannot depend on itself', - ); - - final dependencies = origin.from?.dependencies ?? origin.dependencies ?? []; - final targetDependencies = - dependency.from?.dependencies ?? dependency.dependencies; - - if ( - // If the target has a null "dependencies", it should never be scoped. - !(targetDependencies == null || - // Ignore dependency check if from an override - provider != origin || - // Families are allowed to depend on themselves with different parameters. - (origin.from != null && dependency.from == origin.from) || - dependencies.contains(dependency.from) || - dependencies.contains(dependency))) { - throw StateError(''' -The provider `$origin` depends on `$dependency`, which may be scoped. -Yet `$dependency` is not part of `$origin`'s `dependencies` list. - -To fix, add $dependency to $origin's 'dependencies' parameter. -This can be done with either: - -@Riverpod(dependencies: []) - - -or: - -final = Provider(dependencies: []); -'''); - } - - // TODO move to a "onAddDependency" life-cycle - final queue = Queue>.from(_providerDependents); - while (queue.isNotEmpty) { - final current = queue.removeFirst(); - queue.addAll(current._providerDependents); - - if (current.origin == dependency) { - throw CircularDependencyError._(); - } - } - } - - void _assertNotOutdated() { - assert( - !_didChangeDependency, - 'Cannot use ref functions after the dependency of a provider changed but before the provider rebuilt', - ); - } - - @override - T refresh(Refreshable refreshable) { - _assertNotOutdated(); - if (kDebugMode) _debugAssertCanDependOn(refreshable); - return container.refresh(refreshable); - } - - @override - T read(ProviderListenable listenable) { - _assertNotOutdated(); - assert(!_debugIsRunningSelector, 'Cannot call ref.read inside a selector'); - if (kDebugMode) _debugAssertCanDependOn(listenable); - return container.read(listenable); - } - - @override - bool exists(ProviderBase provider) => container.exists(provider); - - @override - T watch(ProviderListenable listenable) { - _assertNotOutdated(); - assert(!_debugIsRunningSelector, 'Cannot call ref.watch inside a selector'); - - if (listenable is! ProviderBase) { - final sub = listen( - listenable, - (prev, value) => invalidateSelf(asReload: true), - onError: (err, stack) => invalidateSelf(asReload: true), - onDependencyMayHaveChanged: _markDependencyMayHaveChanged, - ); - - return sub.read(); - } - - if (kDebugMode) _debugAssertCanDependOn(listenable); - - final element = container.readProviderElement(listenable); - _dependencies.putIfAbsent(element, () { - final previousSub = _previousDependencies?.remove(element); - if (previousSub != null) { - return previousSub; - } - - if (kDebugMode) { - // Flushing the provider before adding a new dependency - // as otherwise this could cause false positives with certain asserts. - // It's done only in debug mode since `readSelf` will flush the value - // again anyway, and the only value of this flush is to not break asserts. - element.flush(); - } - - element - .._onListen() - .._providerDependents.add(this); - - return Object(); - }); - - return element.readSelf(); - } - @override ProviderElementBase readProviderElement(ProviderBase provider) { return container.readProviderElement(provider); @@ -756,9 +598,9 @@ final = Provider(dependencies: []); // Not part of the public "Ref" API void Function()? onDependencyMayHaveChanged, }) { - _assertNotOutdated(); - assert(!_debugIsRunningSelector, 'Cannot call ref.read inside a selector'); - if (kDebugMode) _debugAssertCanDependOn(listenable); + final ref = this.ref!; + ref._throwIfInvalidUsage(); + if (kDebugMode) ref._debugAssertCanDependOn(listenable); return listenable.addListener( this, @@ -769,127 +611,18 @@ final = Provider(dependencies: []); ); } - @override - void listenSelf( - void Function(StateT? previous, StateT next) listener, { - void Function(Object error, StackTrace stackTrace)? onError, - }) { - // TODO do we want to expose a way to close the subscription? - // TODO do we want a fireImmediately? - - _onChangeSelfListeners ??= []; - _onChangeSelfListeners!.add(listener); - - if (onError != null) { - _onErrorSelfListeners ??= []; - _onErrorSelfListeners!.add(onError); - } - } - - @override - KeepAliveLink keepAlive() { - final links = _keepAliveLinks ??= []; - - late KeepAliveLink link; - link = KeepAliveLink._(() { - if (links.remove(link)) { - if (links.isEmpty) _mayNeedDispose(); - } - }); - links.add(link); - - return link; - } - - /// Returns the currently exposed by a provider - /// - /// May throw if the provider threw when creating the exposed value. - StateT readSelf() { - flush(); - - return requireState; - } - - /// Visit the [$ProviderElement]s of providers that are listening to this element. - /// - /// A provider is considered as listening to this element if it either [watch] - /// or [listen] this element. - /// - /// This method does not guarantee that a dependency is visited only once. - /// If a provider both [watch] and [listen] an element, or if a provider - /// [listen] multiple times to an element, it may be visited multiple times. - void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, - }) { - for (var i = 0; i < _providerDependents.length; i++) { - elementVisitor(_providerDependents[i]); - } - - for (var i = 0; i < _subscribers.length; i++) { - elementVisitor(_subscribers[i].dependentElement); - } - } - - /// Visit the [ProviderElementBase]s that this provider is listening to. - /// - /// A provider is considered as listening to this element if it either [watch] - /// or [listen] this element. - /// - /// This method does not guarantee that a provider is visited only once. - /// If this provider both [watch] and [listen] an element, or if it - /// [listen] multiple times to an element, that element may be visited multiple times. - void visitAncestors( - void Function(ProviderElementBase element) visitor, - ) { - _dependencies.keys.forEach(visitor); - - for (var i = 0; i < _listenedProviderSubscriptions.length; i++) { - visitor(_listenedProviderSubscriptions[i].listenedElement); - } - } - - /// Release the resources associated to this [ProviderElementBase]. - /// - /// This will be invoked when: - /// - the provider is using `autoDispose` and it is no-longer used. - /// - the associated [ProviderContainer] is disposed - /// - /// On the other hand, this life-cycle will not be executed when a provider - /// rebuilds. - /// - /// As opposed to [runOnDispose], this life-cycle is executed only - /// for the lifetime of this element. - @protected - @mustCallSuper - void dispose() { - runOnDispose(); - - // TODO test invalidateSelf() then dispose() properly unlinks dependencies - // TODO test [listen] calls are cleared - - for (final sub in _dependencies.entries) { - sub.key._providerDependents.remove(this); - sub.key._onRemoveListener(); - } - _dependencies.clear(); - - _externalDependents.clear(); - } - void _onListen() { - _onAddListeners?.forEach(runGuarded); + ref?._onAddListeners?.forEach(runGuarded); if (_didCancelOnce && !hasListeners) { - _onResumeListeners?.forEach(runGuarded); + ref?._onResumeListeners?.forEach(runGuarded); } } void _onRemoveListener() { - _onRemoveListeners?.forEach(runGuarded); + ref?._onRemoveListeners?.forEach(runGuarded); if (!hasListeners) { _didCancelOnce = true; - _onCancelListeners?.forEach(runGuarded); + ref?._onCancelListeners?.forEach(runGuarded); } _mayNeedDispose(); } @@ -897,7 +630,7 @@ final = Provider(dependencies: []); /// Life-cycle for when a listener is removed. void _mayNeedDispose() { if (provider.isAutoDispose) { - final links = _keepAliveLinks; + final links = ref?._keepAliveLinks; if (!hasListeners && (links == null || links.isEmpty)) { container.scheduler.scheduleProviderDispose(this); @@ -905,33 +638,23 @@ final = Provider(dependencies: []); } } - @override - @mustCallSuper - void onDispose(void Function() listener) { - _assertNotOutdated(); - if (!_mounted) { - throw StateError('Cannot call onDispose after a provider was dispose'); - } - _onDisposeListeners ??= []; - _onDisposeListeners!.add(listener); - } - /// Executes the [Ref.onDispose] listeners previously registered, then clear /// the list of listeners. @protected @visibleForOverriding @mustCallSuper void runOnDispose() { - if (!_mounted) return; - _mounted = false; + final ref = this.ref; + if (ref == null || !ref._mounted) return; - _keepAliveLinks?.clear(); + ref._mounted = false; + ref._keepAliveLinks?.clear(); while (_listenedProviderSubscriptions.isNotEmpty) { _listenedProviderSubscriptions.first.close(); } - _onDisposeListeners?.forEach(runGuarded); + ref._onDisposeListeners?.forEach(runGuarded); for (final observer in container.observers) { runBinaryGuarded( @@ -941,47 +664,92 @@ final = Provider(dependencies: []); ); } - _onDisposeListeners = null; - _onCancelListeners = null; - _onResumeListeners = null; - _onAddListeners = null; - _onRemoveListeners = null; - _onChangeSelfListeners = null; - _onErrorSelfListeners = null; + ref._onDisposeListeners = null; + ref._onCancelListeners = null; + ref._onResumeListeners = null; + ref._onAddListeners = null; + ref._onRemoveListeners = null; + ref._onChangeSelfListeners = null; + ref._onErrorSelfListeners = null; _didCancelOnce = false; assert( - _keepAliveLinks == null || _keepAliveLinks!.isEmpty, + ref._keepAliveLinks == null || ref._keepAliveLinks!.isEmpty, 'Cannot call keepAlive() within onDispose listeners', ); } - @override - void onAddListener(void Function() cb) { - _onAddListeners ??= []; - _onAddListeners!.add(cb); - } + /// Release the resources associated to this [ProviderElementBase]. + /// + /// This will be invoked when: + /// - the provider is using `autoDispose` and it is no-longer used. + /// - the associated [ProviderContainer] is disposed + /// + /// On the other hand, this life-cycle will not be executed when a provider + /// rebuilds. + /// + /// As opposed to [runOnDispose], this life-cycle is executed only + /// for the lifetime of this element. + @protected + @mustCallSuper + void dispose() { + runOnDispose(); + ref = null; - @override - void onRemoveListener(void Function() cb) { - _onRemoveListeners ??= []; - _onRemoveListeners!.add(cb); - } + // TODO test invalidateSelf() then dispose() properly unlinks dependencies + // TODO test [Ref.listen] calls are cleared - @override - void onCancel(void Function() cb) { - _onCancelListeners ??= []; - _onCancelListeners!.add(cb); - } + for (final sub in _dependencies.entries) { + sub.key._providerDependents.remove(this); + sub.key._onRemoveListener(); + } + _dependencies.clear(); - @override - void onResume(void Function() cb) { - _onResumeListeners ??= []; - _onResumeListeners!.add(cb); + _externalDependents.clear(); } @override String toString() { return '$runtimeType(provider: $provider, origin: $origin)'; } + + /// Visit the [$ProviderElement]s of providers that are listening to this element. + /// + /// A provider is considered as listening to this element if it either [Ref.watch] + /// or [Ref.listen] this element. + /// + /// This method does not guarantee that a dependency is visited only once. + /// If a provider both [Ref.watch] and [Ref.listen] an element, or if a provider + /// [Ref.listen] multiple times to an element, it may be visited multiple times. + void visitChildren({ + required void Function(ProviderElementBase element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + for (var i = 0; i < _providerDependents.length; i++) { + elementVisitor(_providerDependents[i]); + } + + for (var i = 0; i < _subscribers.length; i++) { + elementVisitor(_subscribers[i].dependentElement); + } + } + + /// Visit the [ProviderElementBase]s that this provider is listening to. + /// + /// A provider is considered as listening to this element if it either [Ref.watch] + /// or [Ref.listen] this element. + /// + /// This method does not guarantee that a provider is visited only once. + /// If this provider both [Ref.watch] and [Ref.listen] an element, or if it + /// [Ref.listen] multiple times to an element, that element may be visited multiple times. + void visitAncestors( + void Function(ProviderElementBase element) visitor, + ) { + _dependencies.keys.forEach(visitor); + + for (var i = 0; i < _listenedProviderSubscriptions.length; i++) { + visitor(_listenedProviderSubscriptions[i].listenedElement); + } + } } diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index 59266e82f..118d6e6ac 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -72,19 +72,17 @@ typedef SetupFamilyOverride = void Function( /// This API is not meant for public consumption. @internal class FunctionalFamily< // - RefT extends Ref, - StateT, - ArgT, - CreatedT, - ProviderT extends $FunctionalProvider> - extends Family { + StateT, + ArgT, + CreatedT, + ProviderT extends $FunctionalProvider> extends Family { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. /// /// This API is not meant for public consumption. const FunctionalFamily( this._createFn, { - required FunctionalProviderFactory + required FunctionalProviderFactory, ArgT> providerFactory, required super.name, required super.dependencies, @@ -92,10 +90,10 @@ class FunctionalFamily< // required super.isAutoDispose, }) : _providerFactory = providerFactory; - final FunctionalProviderFactory + final FunctionalProviderFactory, ArgT> _providerFactory; - final CreatedT Function(RefT ref, ArgT arg) _createFn; + final CreatedT Function(Ref ref, ArgT arg) _createFn; /// {@template family.call} /// Create a provider from an external value. @@ -121,7 +119,7 @@ class FunctionalFamily< // /// {@macro riverpod.override_with} Override overrideWith( - CreatedT Function(RefT ref, ArgT arg) create, + CreatedT Function(Ref ref, ArgT arg) create, ) { return $FamilyOverride( from: this, @@ -146,15 +144,14 @@ class FunctionalFamily< // /// This API is not meant for public consumption. @internal class ClassFamily< // - NotifierT extends NotifierBase< // - StateT, - CreatedT>, + NotifierT extends NotifierBase< // StateT, - RefT extends Ref, - ArgT, - CreatedT, - ProviderT extends $ClassProvider> - extends Family { + CreatedT>, + StateT, + ArgT, + CreatedT, + ProviderT extends $ClassProvider>> extends Family { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. /// @@ -170,7 +167,7 @@ class ClassFamily< // // TODO docs @internal - final ClassProviderFactory + final ClassProviderFactory, ArgT> providerFactory; final NotifierT Function() _createFn; @@ -206,7 +203,7 @@ class ClassFamily< // /// {@macro riverpod.override_with} Override overrideWithBuild( - RunNotifierBuild build, + RunNotifierBuild> build, ) { return $FamilyOverride( from: this, diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index efe65bc75..18db7889f 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -207,17 +207,38 @@ mixin FutureModifierElement on ProviderElementBase> { CancelAsyncSubscription? _lastFutureSub; CancelAsyncSubscription? _cancelSubscription; - /// Handles manual state change (as opposed to automatic state change from - /// listening to the [Future]). - @override - @protected - AsyncValue get state => requireState; + /// Internal utility for transitioning an [AsyncValue] after a provider refresh. + /// + /// [seamless] controls how the previous state is preserved: + /// - seamless:true => import previous state and skip loading + /// - seamless:false => import previous state and prefer loading + void asyncTransition( + AsyncValue newState, { + required bool seamless, + }) { +// ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member + final previous = stateResult?.requireState; + + if (previous == null) { +// ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member + super.setStateResult(ResultData(newState)); + } else { +// ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member + super.setStateResult( + ResultData( + newState + .cast() + .copyWithPrevious(previous, isRefresh: seamless), + ), + ); + } + } @override @protected - set state(AsyncValue newState) { + void setStateResult(Result> newState) { // TODO assert Notifier isn't disposed - newState.map( + newState.requireState.map( loading: onLoading, error: onError, data: onData, diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index 9aa3fa6cc..b8f244e47 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -143,7 +143,8 @@ class _ProviderSelector with ProviderListenable { @override OutputT read(Node node) { final input = provider.read(node); - return selector(input); + + return _select(Result.data(input)).requireState; } } diff --git a/packages/riverpod/lib/src/core/modifiers/select_async.dart b/packages/riverpod/lib/src/core/modifiers/select_async.dart index 21d48c2b6..21efac373 100644 --- a/packages/riverpod/lib/src/core/modifiers/select_async.dart +++ b/packages/riverpod/lib/src/core/modifiers/select_async.dart @@ -153,5 +153,7 @@ class _AsyncSelector with ProviderListenable> { } @override - Future read(Node node) => future.read(node).then(selector); + Future read(Node node) => future.read(node).then( + (v) => _select(v).requireState, + ); } diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index bbcfaef8b..0d9b0a973 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -71,7 +71,7 @@ class _ValueProviderElement extends ProviderElementBase { void _setValue(StateT value) => setStateResult(ResultData(value)); @override - void create({required bool didChangeDependency}) { + void create(Ref ref, {required bool didChangeDependency}) { _setValue(provider._value); } diff --git a/packages/riverpod/lib/src/core/provider/functional_provider.dart b/packages/riverpod/lib/src/core/provider/functional_provider.dart index 4564dc36e..24a1bb6b5 100644 --- a/packages/riverpod/lib/src/core/provider/functional_provider.dart +++ b/packages/riverpod/lib/src/core/provider/functional_provider.dart @@ -4,8 +4,7 @@ part of '../../framework.dart'; /// Do not use, as this can be removed at any time. abstract base class $FunctionalProvider< // StateT, - CreatedT, - RefT extends Ref> // + CreatedT> // extends ProviderBase { /// Implementation detail of `riverpod_generator`. /// Do not use, as this can be removed at any time. @@ -22,8 +21,8 @@ abstract base class $FunctionalProvider< // /// /// This is an implementation detail of Riverpod and should not be used. @visibleForOverriding - $FunctionalProvider $copyWithCreate( - Create create, + $FunctionalProvider $copyWithCreate( + Create> create, ); /// {@template riverpod.override_with} @@ -60,7 +59,7 @@ abstract base class $FunctionalProvider< // /// ); /// ``` /// {@endtemplate} - Override overrideWith(Create create) { + Override overrideWith(Create> create) { return $ProviderOverride( origin: this, providerOverride: $copyWithCreate(create), diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index efe5e0a40..da3144378 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -61,10 +61,10 @@ abstract class NotifierBase { // TODO docs @protected Ref get ref { - final element = _element; - if (element == null) throw StateError(uninitializedElementError); + final ref = _element?.ref; + if (ref == null) throw StateError(uninitializedElementError); - return element; + return ref; } @visibleForTesting @@ -83,7 +83,7 @@ abstract class NotifierBase { final element = _element; if (element == null) throw StateError(uninitializedElementError); - element.state = newState; + element.setStateResult(ResultData(newState)); } CreatedT runBuild(); @@ -187,7 +187,10 @@ abstract class ClassProviderElement< // @mustCallSuper @override - void create({required bool didChangeDependency}) { + void create( + Ref ref, { + required bool didChangeDependency, + }) { final result = classListenable.result ??= Result.guard(() { final notifier = provider.create(); if (notifier._element != null) { @@ -208,7 +211,7 @@ abstract class ClassProviderElement< // handleNotifier(result.state, seamless: !didChangeDependency); final created = - provider.runNotifierBuildOverride?.call(this, result.state) ?? + provider.runNotifierBuildOverride?.call(ref, result.state) ?? result.state.runBuild(); handleValue(created, didChangeDependency: didChangeDependency); } catch (err, stack) { diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index b3ca927b2..137e5b085 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -113,6 +113,7 @@ class ProviderElementProxy final element = node.readProviderElement(provider); element.flush(); element._mayNeedDispose(); + return _lense(element).value; } diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 8a4ebb8e3..2fae9bc0f 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -1,5 +1,24 @@ part of '../framework.dart'; +@internal +extension $RefArg on Ref { + // Implementation detail, do not use + Object? get $arg => _element.origin.argument; + + // Implementation detail, do not use + ProviderElementBase get $element => _element; +} + +@internal +class UnmountedRefException implements Exception { + @override + String toString() { + return 'Cannot use a Ref after it has been disposed. ' + ' This typically happens when a provider rebuilt, but the previous "build" was still pending and is still performing operations.' + ' It is generally fine to let this exception be thrown, as it will be caught and handled by Riverpod.'; + } +} + /// {@template riverpod.provider_ref_base} /// An object used by providers to interact with other providers and the life-cycles /// of the application. @@ -9,9 +28,31 @@ part of '../framework.dart'; /// - [read] and [watch], two methods that allow a provider to consume other providers. /// - [onDispose], a method that allows performing a task when the provider is destroyed. /// {@endtemplate} -abstract class Ref { - // TODO changelog breaking: AutoDisposeRef and related interfaces are removed. - // Use the non-autodispose variant instead. They now have the same API. +// TODO changelog breaking "ProviderElementBase" no-longer implements Ref +// TODO changelog breaking: AutoDisposeRef and related interfaces are removed. +// Use the non-autodispose variant instead. They now have the same API. +// TODO changelog breaking: All ref methods besides "mounted" now throw if used on unmounted refs. +// TODO changelog patch: ref.exists now correct asserts that the ref can use the provider. +base class Ref { + /// {@macro riverpod.provider_ref_base} + Ref._(this._element); + + final ProviderElementBase _element; + // TODO changelog breaking: when a provider rebuilds, a new ref is created. + // This means that if the previous "build" didn't stop, using the older ref will now throw. + + List? _keepAliveLinks; + List? _onChangeSelfListeners; + List? _onDisposeListeners; + List? _onResumeListeners; + List? _onCancelListeners; + List? _onAddListeners; + List? _onRemoveListeners; + List? _onErrorSelfListeners; + + // TODO changelog minor: Added `Ref.mounted`, similar to `BuildContext.mounted` + bool get mounted => _mounted; + var _mounted = true; /// Obtains the state currently exposed by this provider. /// @@ -22,11 +63,87 @@ abstract class Ref { /// - on asynchronous providers, this will return an [AsyncLoading]. /// /// Will throw if the provider threw during creation. - StateT get state; - set state(StateT newState); + StateT get state { + _throwIfInvalidUsage(); + + return _element.readSelf(); + } + + set state(StateT newState) { + _throwIfInvalidUsage(); + + _element.setStateResult(ResultData(newState)); + } /// The [ProviderContainer] that this provider is associated with. - ProviderContainer get container; + ProviderContainer get container => _element.container; + + void _debugAssertCanDependOn(ProviderListenableOrFamily listenable) { + final dependency = switch (listenable) { + ProviderOrFamily() => listenable, + _ => listenable.listenedProvider, + }; + + if (dependency == null) return; + + final origin = _element.origin; + final provider = _element.provider; + + assert( + dependency != origin, + 'A provider cannot depend on itself', + ); + + final dependencies = origin.from?.dependencies ?? origin.dependencies ?? []; + final targetDependencies = + dependency.from?.dependencies ?? dependency.dependencies; + + if ( + // If the target has a null "dependencies", it should never be scoped. + !(targetDependencies == null || + // Ignore dependency check if from an override + provider != origin || + // Families are allowed to depend on themselves with different parameters. + (origin.from != null && dependency.from == origin.from) || + dependencies.contains(dependency.from) || + dependencies.contains(dependency))) { + throw StateError(''' +The provider `$origin` depends on `$dependency`, which may be scoped. +Yet `$dependency` is not part of `$origin`'s `dependencies` list. + +To fix, add $dependency to $origin's 'dependencies' parameter. +This can be done with either: + +@Riverpod(dependencies: []) + + +or: + +final = Provider(dependencies: []); +'''); + } + + // TODO move to a "onAddDependency" life-cycle + final queue = Queue>.from( + _element._providerDependents, + ); + while (queue.isNotEmpty) { + final current = queue.removeFirst(); + queue.addAll(current._providerDependents); + + if (current.origin == dependency) { + throw CircularDependencyError._(); + } + } + } + + void _throwIfInvalidUsage() { + assert( + !_debugIsRunningSelector, + 'Cannot call ref.listen inside a selector', + ); + if (!mounted) throw UnmountedRefException(); + } /// Requests for the state of a provider to not be disposed when all the /// listeners of the provider are removed. @@ -36,7 +153,21 @@ abstract class Ref { /// /// If [keepAlive] is invoked multiple times, all [KeepAliveLink] will have /// to be closed for the provider to dispose itself when all listeners are removed. - KeepAliveLink keepAlive(); + KeepAliveLink keepAlive() { + _throwIfInvalidUsage(); + + final links = _keepAliveLinks ??= []; + + late KeepAliveLink link; + link = KeepAliveLink._(() { + if (links.remove(link)) { + if (links.isEmpty) _element._mayNeedDispose(); + } + }); + links.add(link); + + return link; + } /// {@template riverpod.refresh} /// Forces a provider to re-evaluate its state immediately, and return the created value. @@ -65,7 +196,13 @@ abstract class Ref { /// to restart a specific provider. /// {@endtemplate} @useResult - T refresh(Refreshable provider); + T refresh(Refreshable refreshable) { + _throwIfInvalidUsage(); + + if (kDebugMode) _debugAssertCanDependOn(refreshable); + + return container.refresh(refreshable); + } /// {@template riverpod.invalidate} /// Invalidates the state of the provider, causing it to refresh. @@ -86,7 +223,21 @@ abstract class Ref { /// /// If used on a provider which is not initialized, this method will have no effect. /// {@endtemplate} - void invalidate(ProviderOrFamily provider, {bool asReload = false}); + void invalidate(ProviderOrFamily providerOrFamily, {bool asReload = false}) { + _throwIfInvalidUsage(); + if (kDebugMode) _debugAssertCanDependOn(providerOrFamily); + + container.invalidate(providerOrFamily, asReload: asReload); + } + + /// Invokes [invalidate] on itself. + /// + /// {@macro riverpod.invalidate} + void invalidateSelf({bool asReload = false}) { + _throwIfInvalidUsage(); + + _element.invalidateSelf(asReload: asReload); + } /// Notify dependents that this provider has changed. /// @@ -103,48 +254,44 @@ abstract class Ref { /// } /// } /// ``` - void notifyListeners(); + void notifyListeners() { + _throwIfInvalidUsage(); - /// Listens to changes on the value exposed by this provider. - /// - /// The listener will be called immediately after the provider completes building. - /// - /// As opposed to [listen], the listener will be called even if - /// [ProviderElementBase.updateShouldNotify] returns false, meaning that the previous - /// and new value can potentially be identical. - void listenSelf( - void Function(StateT? previous, StateT next) listener, { - void Function(Object error, StackTrace stackTrace)? onError, - }); + final currentResult = _element.stateResult; + // If `notifyListeners` is used during `build`, the result will be null. + // Throwing would be unnecessarily inconvenient, so we simply skip it. + if (currentResult == null) return; - /// Invokes [invalidate] on itself. - /// - /// {@macro riverpod.invalidate} - void invalidateSelf({bool asReload = false}); + if (_element._didBuild) { + _element._notifyListeners( + currentResult, + currentResult, + checkUpdateShouldNotify: false, + ); + } + } /// A life-cycle for whenever a new listener is added to the provider. /// /// See also: /// - [onRemoveListener], for when a listener is removed - void onAddListener(void Function() cb); + void onAddListener(void Function() cb) { + _throwIfInvalidUsage(); + + _onAddListeners ??= []; + _onAddListeners!.add(cb); + } /// A life-cycle for whenever a listener is removed from the provider. /// /// See also: /// - [onAddListener], for when a listener is added - void onRemoveListener(void Function() cb); + void onRemoveListener(void Function() cb) { + _throwIfInvalidUsage(); - /// A life-cycle for when a provider is listened again after it was paused - /// (and [onCancel] was triggered). - /// - /// See also: - /// - [keepAlive], which can be combined with [onCancel] for - /// advanced manipulation on when the provider should get disposed. - /// - [Provider.autoDispose], a modifier which tell a provider that it should - /// destroy its state when no longer listened to. - /// - [onDispose], a life-cycle for when a provider is disposed. - /// - [onCancel], a life-cycle for when all listeners of a provider are removed. - void onResume(void Function() cb); + _onRemoveListeners ??= []; + _onRemoveListeners!.add(cb); + } /// Add a listener to perform an operation when the last listener of the provider /// is removed. @@ -163,7 +310,29 @@ abstract class Ref { /// destroy its state when no longer listened to. /// - [onDispose], a life-cycle for when a provider is disposed. /// - [onResume], a life-cycle for when the provider is listened to again. - void onCancel(void Function() cb); + void onCancel(void Function() cb) { + _throwIfInvalidUsage(); + + _onCancelListeners ??= []; + _onCancelListeners!.add(cb); + } + + /// A life-cycle for when a provider is listened again after it was paused + /// (and [onCancel] was triggered). + /// + /// See also: + /// - [keepAlive], which can be combined with [onCancel] for + /// advanced manipulation on when the provider should get disposed. + /// - [Provider.autoDispose], a modifier which tell a provider that it should + /// destroy its state when no longer listened to. + /// - [onDispose], a life-cycle for when a provider is disposed. + /// - [onCancel], a life-cycle for when all listeners of a provider are removed. + void onResume(void Function() cb) { + _throwIfInvalidUsage(); + + _onResumeListeners ??= []; + _onResumeListeners!.add(cb); + } /// Adds a listener to perform an operation right before the provider is destroyed. /// @@ -211,7 +380,12 @@ abstract class Ref { /// - [ProviderContainer.dispose], to destroy all providers associated with /// a [ProviderContainer] at once. /// - [onCancel], a life-cycle for when all listeners of a provider are removed. - void onDispose(void Function() cb); + void onDispose(void Function() listener) { + _throwIfInvalidUsage(); + + _onDisposeListeners ??= []; + _onDisposeListeners!.add(listener); + } /// Read the state associated with a provider, without listening to that provider. /// @@ -247,7 +421,12 @@ abstract class Ref { /// /// If possible, avoid using [read] and prefer [watch], which is generally /// safer to use. - T read(ProviderListenable provider); + T read(ProviderListenable listenable) { + _throwIfInvalidUsage(); + if (kDebugMode) _debugAssertCanDependOn(listenable); + + return container.read(listenable); + } /// {@template riverpod.exists} /// Determines whether a provider is initialized or not. @@ -282,7 +461,12 @@ abstract class Ref { /// }); /// ``` /// {@endtemplate} - bool exists(ProviderBase provider); + bool exists(ProviderBase provider) { + _throwIfInvalidUsage(); + if (kDebugMode) _debugAssertCanDependOn(provider); + + return container.exists(provider); + } /// Obtains the state of a provider and causes the state to be re-evaluated /// when that provider emits a new value. @@ -346,7 +530,45 @@ abstract class Ref { /// return sub.read(); /// } /// ``` - T watch(ProviderListenable provider); + T watch(ProviderListenable listenable) { + _throwIfInvalidUsage(); + if (listenable is! ProviderBase) { + final sub = _element.listen( + listenable, + (prev, value) => invalidateSelf(asReload: true), + onError: (err, stack) => invalidateSelf(asReload: true), + onDependencyMayHaveChanged: _element._markDependencyMayHaveChanged, + ); + + return sub.read(); + } + + if (kDebugMode) _debugAssertCanDependOn(listenable); + + final element = container.readProviderElement(listenable); + _element._dependencies.putIfAbsent(element, () { + final previousSub = _element._previousDependencies?.remove(element); + if (previousSub != null) { + return previousSub; + } + + if (kDebugMode) { + // Flushing the provider before adding a new dependency + // as otherwise this could cause false positives with certain asserts. + // It's done only in debug mode since `readSelf` will flush the value + // again anyway, and the only value of this flush is to not break asserts. + element.flush(); + } + + element + .._onListen() + .._providerDependents.add(_element); + + return Object(); + }); + + return element.readSelf(); + } /// {@template riverpod.listen} /// Listen to a provider and call [listener] whenever its value changes. @@ -371,8 +593,38 @@ abstract class Ref { ProviderListenable provider, void Function(T? previous, T next) listener, { void Function(Object error, StackTrace stackTrace)? onError, - bool fireImmediately, - }); + bool fireImmediately = false, + }) { + return _element.listen( + provider, + listener, + onError: onError, + fireImmediately: fireImmediately, + ); + } + + /// Listens to changes on the value exposed by this provider. + /// + /// The listener will be called immediately after the provider completes building. + /// + /// As opposed to [listen], the listener will be called even if + /// [ProviderElementBase.updateShouldNotify] returns false, meaning that the previous + /// and new value can potentially be identical. + void listenSelf( + void Function(StateT? previous, StateT next) listener, { + void Function(Object error, StackTrace stackTrace)? onError, + }) { + // TODO do we want to expose a way to close the subscription? + // TODO do we want a fireImmediately? + + _onChangeSelfListeners ??= []; + _onChangeSelfListeners!.add(listener); + + if (onError != null) { + _onErrorSelfListeners ??= []; + _onErrorSelfListeners!.add(onError); + } + } } /// A object that maintains a provider alive. diff --git a/packages/riverpod/lib/src/core/scheduler.dart b/packages/riverpod/lib/src/core/scheduler.dart index 73a41955d..69bf7fb63 100644 --- a/packages/riverpod/lib/src/core/scheduler.dart +++ b/packages/riverpod/lib/src/core/scheduler.dart @@ -121,7 +121,7 @@ class ProviderScheduler { for (var i = 0; i < _stateToDispose.length; i++) { final element = _stateToDispose[i]; - final links = element._keepAliveLinks; + final links = element.ref?._keepAliveLinks; if ((links != null && links.isNotEmpty) || element.hasListeners || diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index 36879719d..1e908728d 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -16,7 +16,7 @@ abstract class FamilyAsyncNotifier /// /// then [arg] will be `0`. /// {@endtemplate} - late final ArgT arg = (ref as ProviderElementBase).origin.argument as ArgT; + late final ArgT arg = ref.$arg as ArgT; /// {@macro riverpod.async_notifier.build} @visibleForOverriding @@ -35,7 +35,6 @@ class AsyncNotifierProviderFamily< // extends ClassFamily< // NotifierT, AsyncValue, - Ref>, ArgT, FutureOr, FamilyAsyncNotifierProvider> { diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 07c8ea281..0e0261288 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -92,8 +92,8 @@ base mixin $FutureProvider on ProviderBase> { /// - [FutureProvider.family], to create a [FutureProvider] from external parameters /// - [FutureProvider.autoDispose], to destroy the state of a [FutureProvider] when no longer needed. /// {@endtemplate} -final class FutureProvider extends $FunctionalProvider< - AsyncValue, FutureOr, Ref>> +final class FutureProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider>>, @@ -174,9 +174,12 @@ class $FutureProviderElement final $FutureProvider>> provider; @override - void create({required bool didChangeDependency}) { + void create( + Ref> ref, { + required bool didChangeDependency, + }) { handleFuture( - () => provider.create(this), + () => provider.create(ref), didChangeDependency: didChangeDependency, ); } @@ -195,11 +198,7 @@ class $FutureProviderElement /// The [Family] of a [FutureProvider] class FutureProviderFamily extends FunctionalFamily< - Ref>, - AsyncValue, - ArgT, - FutureOr, - FutureProvider> { + AsyncValue, ArgT, FutureOr, FutureProvider> { FutureProviderFamily( super._createFn, { super.name, diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index 99d9ec0ec..fdfdb0838 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -17,15 +17,7 @@ ProviderElementProxy ); } -/// {@macro riverpod.provider_ref_base} -abstract class StateNotifierProviderRef, T> - implements Ref { - /// The [StateNotifier] currently exposed by this provider. - /// - /// Cannot be accessed while creating the provider. - NotifierT get notifier; -} - +// TODO changelog breaking: Removed StateNotifierProviderRef. Use Ref instead /// Creates a [StateNotifier] and exposes its current state. /// /// This provider is used in combination with `package:state_notifier`. @@ -93,9 +85,7 @@ final class StateNotifierProvider< // StateT> // extends $FunctionalProvider< // StateT, - NotifierT, - StateNotifierProviderRef> - with LegacyProviderMixin { + NotifierT> with LegacyProviderMixin { /// {@macro riverpod.statenotifierprovider} StateNotifierProvider( this._create, { @@ -127,8 +117,7 @@ final class StateNotifierProvider< // /// {@macro riverpod.family} static const family = StateNotifierProviderFamilyBuilder(); - final NotifierT Function(StateNotifierProviderRef ref) - _create; + final NotifierT Function(Ref ref) _create; /// Obtains the [StateNotifier] associated with this provider, without listening /// to state changes. @@ -159,7 +148,7 @@ final class StateNotifierProvider< // @visibleForOverriding @override StateNotifierProvider $copyWithCreate( - Create> create, + Create> create, ) { return StateNotifierProvider.internal( create, @@ -174,24 +163,22 @@ final class StateNotifierProvider< // } /// The element of [StateNotifierProvider]. -class StateNotifierProviderElement, T> - extends ProviderElementBase - implements StateNotifierProviderRef { +class StateNotifierProviderElement, + StateT> extends ProviderElementBase { StateNotifierProviderElement._(this.provider, super.container); @override - final StateNotifierProvider provider; + final StateNotifierProvider provider; - @override - NotifierT get notifier => _notifierNotifier.value; final _notifierNotifier = ProxyElementValueListenable(); void Function()? _removeListener; @override - void create({required bool didChangeDependency}) { - final notifier = - _notifierNotifier.result = Result.guard(() => provider._create(this)); + void create(Ref ref, {required bool didChangeDependency}) { + final notifier = _notifierNotifier.result = Result.guard( + () => provider._create(ref), + ); _removeListener = notifier // TODO test requireState, as ref.read(p) is expected to throw if notifier creation failed @@ -203,7 +190,7 @@ class StateNotifierProviderElement, T> } @override - bool updateShouldNotify(T previous, T next) { + bool updateShouldNotify(StateT previous, StateT next) { // TODO test that updateShouldNotify is applied return _notifierNotifier.result!.requireState // ignore: invalid_use_of_protected_member @@ -241,8 +228,8 @@ class StateNotifierProviderElement, T> /// The [Family] of [StateNotifierProvider]. class StateNotifierProviderFamily, T, Arg> - extends FunctionalFamily, T, Arg, - NotifierT, StateNotifierProvider> { + extends FunctionalFamily> { /// The [Family] of [StateNotifierProvider]. StateNotifierProviderFamily( super._createFn, { diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 11aff9606..5b805b266 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -15,14 +15,7 @@ ProviderElementProxy> _notifier( ); } -/// {@macro riverpod.provider_ref_base} -/// - [controller], the [StateController] currently exposed by this provider. -abstract class StateProviderRef implements Ref { - /// The [StateController] currently exposed by this provider. - /// - /// Cannot be accessed while creating the provider. - StateController get controller; -} +// TODO changelog breaking: Removed Ref. Use Ref and [Ref.state=] instead. /// {@template riverpod.state_provider} /// A provider that exposes a value that can be modified from outside. @@ -57,8 +50,7 @@ abstract class StateProviderRef implements Ref { /// } /// ``` /// {@endtemplate} -final class StateProvider - extends $FunctionalProvider> +final class StateProvider extends $FunctionalProvider with LegacyProviderMixin { /// {@macro riverpod.state_provider} StateProvider( @@ -91,7 +83,7 @@ final class StateProvider /// {@macro riverpod.family} static const family = StateProviderFamilyBuilder(); - final StateT Function(StateProviderRef ref) _createFn; + final StateT Function(Ref ref) _createFn; Refreshable> get notifier => _notifier(this); @@ -107,7 +99,7 @@ final class StateProvider @visibleForOverriding @override StateProvider $copyWithCreate( - Create> create, + Create> create, ) { return StateProvider.internal( create, @@ -122,15 +114,12 @@ final class StateProvider } /// The element of [StateProvider]. -class StateProviderElement extends ProviderElementBase - implements StateProviderRef { +class StateProviderElement extends ProviderElementBase { StateProviderElement._(this.provider, super.container); @override final StateProvider provider; - @override - StateController get controller => _controllerNotifier.value; final _controllerNotifier = ProxyElementValueListenable>(); final _stateNotifier = ProxyElementValueListenable>(); @@ -138,8 +127,11 @@ class StateProviderElement extends ProviderElementBase void Function()? _removeListener; @override - void create({required bool didChangeDependency}) { - final initialState = provider._createFn(this); + void create( + Ref ref, { + required bool didChangeDependency, + }) { + final initialState = provider._createFn(ref); final controller = StateController(initialState); _controllerNotifier.result = Result.data(controller); @@ -186,7 +178,6 @@ class StateProviderElement extends ProviderElementBase /// The [Family] of [StateProvider]. class StateProviderFamily extends FunctionalFamily< // - StateProviderRef, StateT, Arg, StateT, diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index 74e50c2d1..4588f07e6 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -133,6 +133,6 @@ class $NotifierProviderElement< // StateT created, { required bool didChangeDependency, }) { - state = created; + setStateResult(ResultData(created)); } } diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index 85b955cb8..6aec115a5 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -5,7 +5,7 @@ part of '../notifier.dart'; /// {@macro riverpod.notifier_provider_modifier} abstract class FamilyNotifier extends $Notifier { /// {@macro riverpod.notifier.family_arg} - late final ArgT arg = (ref as ProviderElementBase).origin.argument as ArgT; + late final ArgT arg = ref.$arg as ArgT; /// {@macro riverpod.async_notifier.build} @visibleForOverriding @@ -86,7 +86,6 @@ class NotifierProviderFamily< extends ClassFamily< // NotifierT, StateT, - Ref, ArgT, StateT, FamilyNotifierProvider> { diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 3bffb052c..d8e9cad57 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -15,8 +15,7 @@ base mixin $Provider on ProviderBase { // TODO changelog ProviderRef was removed. Used Ref directly /// {@macro riverpod.provider} -base class Provider - extends $FunctionalProvider> +base class Provider extends $FunctionalProvider with $Provider>, LegacyProviderMixin { /// {@macro riverpod.provider} // TODO make all providers const under all variations @@ -353,14 +352,8 @@ class $ProviderElement extends ProviderElementBase { final $Provider> provider; @override - StateT get state => requireState; - - @override - set state(StateT newState) => setStateResult(ResultData(newState)); - - @override - void create({required bool didChangeDependency}) { - setStateResult(ResultData(provider.create(this))); + void create(Ref ref, {required bool didChangeDependency}) { + setStateResult(ResultData(provider.create(ref))); } @override @@ -371,8 +364,8 @@ class $ProviderElement extends ProviderElementBase { /// The [Family] of [Provider] // TODO remove custom family types -class ProviderFamily - extends FunctionalFamily, R, Arg, R, Provider> { +class ProviderFamily + extends FunctionalFamily> { ProviderFamily( super._createFn, { super.name, diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index 6366073e8..6b421a8e0 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -16,7 +16,7 @@ abstract class FamilyStreamNotifier /// /// then [arg] will be `0`. /// {@endtemplate} - late final ArgT arg = (ref as ProviderElementBase).origin.argument as ArgT; + late final ArgT arg = ref.$arg as ArgT; /// {@macro riverpod.async_notifier.build} @visibleForOverriding @@ -105,7 +105,6 @@ class StreamNotifierProviderFamily< // extends ClassFamily< // NotifierT, AsyncValue, - Ref>, ArgT, Stream, FamilyStreamNotifierProvider> { diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index bae0f7016..52de7259f 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -81,8 +81,8 @@ base mixin $StreamProvider on ProviderBase> { /// - [StreamProvider.family], to create a [StreamProvider] from external parameters /// - [StreamProvider.autoDispose], to destroy the state of a [StreamProvider] when no longer needed. /// {@endtemplate} -base class StreamProvider extends $FunctionalProvider< - AsyncValue, Stream, Ref>> +base class StreamProvider + extends $FunctionalProvider, Stream> with $FutureModifier, $StreamProvider>>, @@ -134,8 +134,7 @@ base class StreamProvider extends $FunctionalProvider< @mustBeOverridden @visibleForOverriding @override - $FunctionalProvider, Stream, - Ref>> $copyWithCreate( + $FunctionalProvider, Stream> $copyWithCreate( Create, Ref>> create, ) { return StreamProvider.internal( @@ -166,12 +165,15 @@ class $StreamProviderElement StreamController.broadcast(); @override - void create({required bool didChangeDependency}) { + void create( + Ref> ref, { + required bool didChangeDependency, + }) { asyncTransition(AsyncLoading(), seamless: !didChangeDependency); _streamNotifier.result ??= Result.data(_streamController.stream); handleStream( - () => provider.create(this), + () => provider.create(ref), didChangeDependency: didChangeDependency, ); } @@ -230,11 +232,7 @@ class $StreamProviderElement /// The [Family] of a [StreamProvider] class StreamProviderFamily extends FunctionalFamily< - Ref>, - AsyncValue, - ArgT, - Stream, - StreamProvider> { + AsyncValue, ArgT, Stream, StreamProvider> { StreamProviderFamily( super._createFn, { super.name, diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart index 636328bd2..c9cc4fd83 100644 --- a/packages/riverpod/test/new/core/ref_test.dart +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -3,7 +3,8 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' + show CircularDependencyError, UnmountedRefException; import 'package:test/test.dart'; import '../utils.dart'; @@ -16,6 +17,7 @@ final refMethodsThatDependOnProviders = 'listen': (ref, p) => ref.listen(p, (prev, next) {}), 'invalidate': (ref, p) => ref.invalidate(p), 'refresh': (ref, p) => ref.refresh(p), + 'exists': (ref, p) => ref.exists(p), }; final refMethodsThatDependOnListenables = ref, ProviderListenable)>{ @@ -30,6 +32,175 @@ final refMethodsThatDependOnProviderOrFamilies = void main() { group('Ref', () { + test('asserts that a lifecycle cannot be used after a ref is unmounted', + () { + late Ref ref; + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final provider = Provider((r) { + r.watch(dep); + ref = r; + return Object(); + }); + + container.read(provider); + + container.read(dep.notifier).state++; + + final another = Provider((ref) => 0); + + expect( + () => ref.state, + throwsA(isA()), + ); + expect( + () => ref.state = 42, + throwsA(isA()), + ); + expect( + () => ref.watch(another), + throwsA(isA()), + ); + expect( + () => ref.invalidateSelf(), + throwsA(isA()), + ); + expect( + () => ref.invalidate(dep), + throwsA(isA()), + ); + expect( + () => ref.refresh(another), + throwsA(isA()), + ); + expect( + () => ref.read(another), + throwsA(isA()), + ); + expect( + () => ref.onDispose(() {}), + throwsA(isA()), + ); + expect( + () => ref.onAddListener(() {}), + throwsA(isA()), + ); + expect( + () => ref.onCancel(() {}), + throwsA(isA()), + ); + expect( + () => ref.onRemoveListener(() {}), + throwsA(isA()), + ); + expect( + () => ref.onResume(() {}), + throwsA(isA()), + ); + expect( + () => ref.notifyListeners(), + throwsA(isA()), + ); + expect( + () => ref.listen(another, (_, __) {}), + throwsA(isA()), + ); + expect( + () => ref.exists(another), + throwsA(isA()), + ); + + expect( + () => ref.keepAlive(), + throwsA(isA()), + ); + }); + + test('asserts that a lifecycle cannot be used inside selectors', () { + late Ref ref; + final container = ProviderContainer.test(); + final dep = StateProvider((ref) => 0); + final provider = Provider((r) { + r.watch(dep); + ref = r; + return Object(); + }); + + container.read(provider); + + container.read(dep.notifier).state++; + + final another = Provider((ref) => 0); + + expect( + () => container.read(provider.select((_) => ref.state)), + throwsA(isA()), + ); + expect( + () => container.read(provider.select((_) => ref.state = 42)), + throwsA(isA()), + ); + expect( + () => container.read(provider.select((_) => ref.watch(another))), + throwsA(isA()), + ); + expect( + () => container.read(provider.select((_) => ref.invalidateSelf())), + throwsA(isA()), + ); + expect( + () => container.read(provider.select((_) => ref.invalidate(dep))), + throwsA(isA()), + ); + expect( + () => container.read(provider.select((_) => ref.refresh(another))), + throwsA(isA()), + ); + expect( + () => container.read(provider.select((_) => ref.read(another))), + throwsA(isA()), + ); + expect( + () => container.read(provider.select((_) => ref.onDispose(() {}))), + throwsA(isA()), + ); + expect( + () => container.read(provider.select((_) => ref.onAddListener(() {}))), + throwsA(isA()), + ); + expect( + () => container.read(provider.select((_) => ref.onCancel(() {}))), + throwsA(isA()), + ); + expect( + () => + container.read(provider.select((_) => ref.onRemoveListener(() {}))), + throwsA(isA()), + ); + expect( + () => container.read(provider.select((_) => ref.onResume(() {}))), + throwsA(isA()), + ); + expect( + () => container.read(provider.select((_) => ref.notifyListeners())), + throwsA(isA()), + ); + expect( + () => container + .read(provider.select((_) => ref.listen(another, (_, __) {}))), + throwsA(isA()), + ); + expect( + () => container.read(provider.select((_) => ref.exists(another))), + throwsA(isA()), + ); + + expect( + () => container.read(provider.select((_) => ref.keepAlive())), + throwsA(isA()), + ); + }); + group('invalidate', () { test('can disposes of the element if not used anymore', () async { late Ref ref; @@ -98,6 +269,69 @@ void main() { }); group('invalidateSelf', () { + test('calls dispose immediately', () { + final container = ProviderContainer.test(); + final listener = OnDisposeMock(); + late Ref ref; + final provider = Provider((r) { + ref = r; + ref.onDispose(listener.call); + }); + + container.read(provider); + verifyZeroInteractions(listener); + + ref.invalidateSelf(); + + verifyOnly(listener, listener()); + }); + + test('triggers a rebuild on next frame', () async { + final container = ProviderContainer.test(); + final listener = Listener(); + var result = 0; + late Ref ref; + final provider = Provider((r) { + ref = r; + return result; + }); + + container.listen(provider, listener.call); + verifyZeroInteractions(listener); + + ref.invalidateSelf(); + result = 1; + + verifyZeroInteractions(listener); + + await container.pump(); + + verifyOnly(listener, listener(0, 1)); + }); + + test('merges the rebuild with dependency change rebuild', () async { + final container = ProviderContainer.test(); + final listener = Listener(); + final dep = StateProvider((ref) => 0); + late Ref ref; + final provider = Provider((r) { + ref = r; + return ref.watch(dep); + }); + + container.listen(provider, listener.call); + verifyZeroInteractions(listener); + + ref.invalidateSelf(); + container.read(dep.notifier).state++; + + verifyZeroInteractions(listener); + + await container.pump(); + + verifyOnly(listener, listener(0, 1)); + }); + test('can disposes of the element if not used anymore', () async { late Ref ref; final provider = Provider.autoDispose((r) { @@ -135,46 +369,23 @@ void main() { }); }); - test( - 'cannot call ref.watch/ref.read/ref.listen/ref.onDispose after a dependency changed', - () { - // TODO assert invalidate & co also throw - late Ref ref; - final container = ProviderContainer.test(); - final dep = StateProvider((ref) => 0); - final provider = Provider((r) { - r.watch(dep); - ref = r; + test("can't use ref inside onDispose", () { + final provider2 = Provider((ref) => 0); + final provider = Provider((ref) { + ref.onDispose(() { + ref.watch(provider2); }); + return ref; + }); + final container = ProviderContainer.test(); - container.read(provider); - - container.read(dep.notifier).state++; + container.read(provider); - final another = Provider((ref) => 0); + final errors = []; + runZonedGuarded(container.dispose, (err, _) => errors.add(err)); - expect( - () => ref.watch(another), - throwsA(isA()), - ); - expect( - () => ref.refresh(another), - throwsA(isA()), - ); - expect( - () => ref.read(another), - throwsA(isA()), - ); - expect( - () => ref.onDispose(() {}), - throwsA(isA()), - ); - expect( - () => ref.listen(another, (_, __) {}), - throwsA(isA()), - ); - }, - ); + expect(errors, [isA()]); + }); group( 'asserts that a provider cannot depend on a provider that is not in its dependencies:', @@ -342,6 +553,38 @@ void main() { } }); + group('.exists', () { + test('Returns true if available on ancestor container', () { + final root = ProviderContainer.test(); + final container = ProviderContainer.test(parent: root); + final provider = Provider((ref) => 0); + + root.read(provider); + + expect(container.exists(provider), true); + expect(root.exists(provider), true); + }); + + test('simple use-case', () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => 0); + final refProvider = Provider((ref) => ref); + + final ref = container.read(refProvider); + + expect( + container.getAllProviderElements().map((e) => e.origin), + [refProvider], + ); + expect(container.exists(refProvider), true); + expect(ref.exists(provider), false); + + ref.read(provider); + + expect(ref.exists(provider), true); + }); + }); + group('listenSelf', () { test('does not break autoDispose', () async { final container = ProviderContainer.test(); @@ -1438,115 +1681,1124 @@ void main() { }); }); - group('.onDispose', () { - test( - 'calls all the listeners in order when the ProviderContainer is disposed', - () { - final onDispose = OnDisposeMock(); - final onDispose2 = OnDisposeMock(); - final provider = Provider((ref) { - ref.onDispose(onDispose.call); - ref.onDispose(onDispose2.call); + group('.notifyListeners', () { + test('If called after initialization, notify listeners', () { + final observer = ProviderObserverMock(); + final listener = Listener(); + final selfListener = Listener(); + final container = ProviderContainer.test(observers: [observer]); + late Ref ref; + final provider = Provider((r) { + ref = r; + ref.listenSelf(selfListener.call); + return 0; }); - final container = ProviderContainer(); - addTearDown(container.dispose); - - container.read(provider); // register the onDispose hooks + container.listen(provider, listener.call, fireImmediately: true); - verifyZeroInteractions(onDispose); - verifyZeroInteractions(onDispose2); + verifyOnly(observer, observer.didAddProvider(provider, 0, container)); + verifyOnly(listener, listener(null, 0)); + verifyOnly(selfListener, selfListener(null, 0)); - container.dispose(); + ref.notifyListeners(); - verifyInOrder([ - onDispose(), - onDispose2(), - ]); - verifyNoMoreInteractions(onDispose); - verifyNoMoreInteractions(onDispose2); + verifyOnly(listener, listener(0, 0)); + verifyOnly(selfListener, selfListener(0, 0)); + verifyOnly( + observer, + observer.didUpdateProvider(provider, 0, 0, container), + ); }); - test('calls all listeners in order when one of its dependency changed', - () async { - final onDispose = OnDisposeMock(); - final onDispose2 = OnDisposeMock(); - - final count = StateProvider((ref) => 0); - final provider = Provider((ref) { - ref.watch(count); - ref.onDispose(onDispose.call); - ref.onDispose(onDispose2.call); + test( + 'can be invoked during first initialization, and does not notify listeners', + () { + final observer = ProviderObserverMock(); + final selfListener = Listener(); + final listener = Listener(); + final container = ProviderContainer.test(observers: [observer]); + final provider = Provider((ref) { + ref.listenSelf(selfListener.call); + ref.notifyListeners(); + return 0; }); - final container = ProviderContainer(); - addTearDown(container.dispose); - - container.read(provider); // register the onDispose hooks - - verifyZeroInteractions(onDispose); - verifyZeroInteractions(onDispose2); - - container.read(count.notifier).state++; - await container.pump(); + container.listen(provider, listener.call, fireImmediately: true); - verifyInOrder([ - onDispose(), - onDispose2(), - ]); - verifyNoMoreInteractions(onDispose); - verifyNoMoreInteractions(onDispose2); + verifyOnly(observer, observer.didAddProvider(provider, 0, container)); + verifyOnly(listener, listener(null, 0)); + verifyOnly(selfListener, selfListener(null, 0)); }); - test('does not call listeners again if more than one dependency changed', + test( + 'can be invoked during a re-initialization, and does not notify listeners', () { - final onDispose = OnDisposeMock(); - - final count = StateProvider((ref) => 0); - final count2 = StateProvider((ref) => 0); - final provider = Provider((ref) { - ref.watch(count); - ref.watch(count2); - ref.onDispose(onDispose.call); + final observer = ProviderObserverMock(); + final listener = Listener(); + final selfListener = Listener(); + final container = ProviderContainer.test(observers: [observer]); + var callNotifyListeners = false; + const firstValue = 'first'; + const secondValue = 'second'; + var result = firstValue; + final provider = Provider((ref) { + ref.listenSelf(selfListener.call); + if (callNotifyListeners) { + ref.notifyListeners(); + } + return result; }); - final container = ProviderContainer(); - addTearDown(container.dispose); - - container.read(provider); // register the onDispose hooks + container.listen(provider, listener.call, fireImmediately: true); - verifyZeroInteractions(onDispose); + verifyOnly( + observer, + observer.didAddProvider(provider, firstValue, container), + ); + verifyOnly(selfListener, selfListener(null, firstValue)); + verifyOnly(listener, listener(null, firstValue)); - container.read(count.notifier).state++; - container.read(count2.notifier).state++; + result = secondValue; + callNotifyListeners = true; + container.refresh(provider); - verifyOnly(onDispose, onDispose()); + verifyOnly(selfListener, selfListener(firstValue, secondValue)); + verifyOnly(listener, listener(firstValue, secondValue)); + verify(observer.didDisposeProvider(provider, container)); + verify( + observer.didUpdateProvider( + provider, + firstValue, + secondValue, + container, + ), + ).called(1); + verifyNoMoreInteractions(observer); }); + }); - test( - 'does not call listeners again if a dependency changed then ProviderContainer was disposed', - () async { - final onDispose = OnDisposeMock(); - var buildCount = 0; - - final count = StateProvider((ref) => 0); - final provider = Provider((ref) { - buildCount++; - ref.watch(count); - ref.onDispose(onDispose.call); + group('.refresh', () { + test('Throws if a circular dependency is detected', () { + // Regression test for https://github.com/rrousselGit/riverpod/issues/2336 + late Ref ref; + final a = Provider((r) { + ref = r; + return 0; }); + final b = Provider((r) => r.watch(a)); + final container = ProviderContainer.test(); - final container = ProviderContainer(); - addTearDown(container.dispose); + container.read(b); - container.read(provider); // register the onDispose hooks - expect(buildCount, 1); + expect( + () => ref.refresh(b), + throwsA(isA()), + ); + }); + }); - verifyZeroInteractions(onDispose); + group('.invalidate', () { + test('Throws if a circular dependency is detected', () { + // Regression test for https://github.com/rrousselGit/riverpod/issues/2336 + late Ref ref; + final a = Provider((r) { + ref = r; + return 0; + }); + final b = Provider((r) => r.watch(a)); + final container = ProviderContainer.test(); - container.read(count.notifier).state++; - // no pump() because that would rebuild the provider, which means it would - // need to be disposed once again. + container.read(b); + + expect( + () => ref.invalidate(b), + throwsA(isA()), + ); + }); + + test('Circular dependency ignores families', () { + late Ref ref; + final a = Provider((r) { + ref = r; + return 0; + }); + final b = Provider.family((r, id) => r.watch(a)); + final container = ProviderContainer.test(); + + container.read(b(0)); + + expect( + () => ref.invalidate(b), + returnsNormally, + ); + }); + + test('triggers a rebuild on next frame', () async { + final container = ProviderContainer.test(); + final listener = Listener(); + var result = 0; + final provider = Provider((r) => result); + late Ref ref; + final another = Provider((r) { + ref = r; + }); + + container.listen(provider, listener.call); + container.read(another); + verifyZeroInteractions(listener); + + ref.invalidate(provider); + ref.invalidate(provider); + result = 1; + + verifyZeroInteractions(listener); + + await container.pump(); + + verifyOnly(listener, listener(0, 1)); + }); + + group('on families', () { + test('recomputes providers associated with the family', () async { + final container = ProviderContainer.test(); + final listener = Listener(); + final listener2 = Listener(); + final listener3 = Listener(); + var result = 0; + final unrelated = Provider((ref) => result); + final provider = Provider.family((r, i) => '$result-$i'); + late Ref ref; + final another = Provider((r) { + ref = r; + }); + + container.read(another); + + container.listen(provider(0), listener.call, fireImmediately: true); + container.listen(provider(1), listener2.call, fireImmediately: true); + container.listen(unrelated, listener3.call, fireImmediately: true); + + verifyOnly(listener, listener(null, '0-0')); + verifyOnly(listener2, listener2(null, '0-1')); + verifyOnly(listener3, listener3(null, 0)); + + ref.invalidate(provider); + ref.invalidate(provider); + result = 1; + + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + verifyNoMoreInteractions(listener3); + + await container.pump(); + + verifyOnly(listener, listener('0-0', '1-0')); + verifyOnly(listener2, listener2('0-1', '1-1')); + verifyNoMoreInteractions(listener3); + }); + + test('clears only on the closest family override', () async { + var result = 0; + final provider = Provider.family( + (r, i) => result, + dependencies: const [], + ); + late Ref ref; + final another = Provider((r) => ref = r, dependencies: [provider]); + + final listener = Listener(); + final listener2 = Listener(); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [provider, another], + ); + + container.read(another); + root.listen(provider(0), listener.call, fireImmediately: true); + container.listen(provider(1), listener2.call, fireImmediately: true); + + verifyOnly(listener, listener(null, 0)); + verifyOnly(listener2, listener2(null, 0)); + + ref.invalidate(provider); + result = 1; + + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + await container.pump(); + + verifyOnly(listener2, listener2(0, 1)); + verifyNoMoreInteractions(listener); + }); + }); + }); + + group('.onRemoveListener', () { + test('is not called on read', () { + final container = ProviderContainer.test(); + final listener = OnRemoveListener(); + final provider = Provider((ref) { + ref.onRemoveListener(listener.call); + }); + + container.read(provider); + + verifyZeroInteractions(listener); + }); + + test('calls listeners when container.listen subscriptions are closed', + () { + final container = ProviderContainer.test(); + final listener = OnRemoveListener(); + final listener2 = OnRemoveListener(); + final provider = Provider((ref) { + ref.onRemoveListener(listener.call); + ref.onRemoveListener(listener2.call); + }); + + final sub = container.listen(provider, (previous, next) {}); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + sub.close(); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + final sub2 = container.listen(provider, (previous, next) {}); + + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + sub2.close(); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('calls listeners when ref.listen subscriptions are closed', () { + final container = ProviderContainer.test(); + final listener = OnRemoveListener(); + final listener2 = OnRemoveListener(); + final dep = Provider( + name: 'dep', + (ref) { + ref.onRemoveListener(listener.call); + ref.onRemoveListener(listener2.call); + }, + ); + late Ref ref; + final provider = Provider( + name: 'provider', + (r) { + ref = r; + }, + ); + + // initialize ref + container.read(provider); + + final sub = ref.listen(dep, (previous, next) {}); + + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + sub.close(); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + final sub2 = ref.listen(dep, (previous, next) {}); + + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + sub2.close(); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('calls listeners when ref.watch subscriptions are removed', () { + final container = ProviderContainer.test(); + final listener = OnRemoveListener(); + final listener2 = OnRemoveListener(); + final dep = Provider( + name: 'dep', + (ref) { + ref.onRemoveListener(listener.call); + ref.onRemoveListener(listener2.call); + }, + ); + late Ref ref; + final provider = Provider( + name: 'provider', + (r) => ref = r, + ); + + // initialize refs + container.read(provider); + + ref.watch(dep); + + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + container.refresh(provider); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('listeners are cleared on rebuild', () { + final container = ProviderContainer.test(); + final listener = OnRemoveListener(); + final listener2 = OnRemoveListener(); + var isSecondBuild = false; + final provider = Provider((ref) { + if (isSecondBuild) { + ref.onRemoveListener(listener2.call); + } else { + ref.onRemoveListener(listener.call); + } + }); + + container.read(provider); + isSecondBuild = true; + container.refresh(provider); + + final sub = container.listen(provider, (previous, next) {}); + sub.close(); + + verify(listener2()).called(1); + verifyNoMoreInteractions(listener2); + verifyZeroInteractions(listener); + }); + + test('if a listener throws, still calls all listeners', () { + final errors = []; + final container = ProviderContainer.test(); + final listener = OnRemoveListener(); + final listener2 = OnRemoveListener(); + when(listener()).thenThrow(42); + final provider = Provider((ref) { + ref.onRemoveListener(listener.call); + ref.onRemoveListener(listener2.call); + }); + + final sub = container.listen(provider, (prev, next) {}); + + runZonedGuarded( + sub.close, + (err, stack) => errors.add(err), + ); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + expect(errors, [42]); + }); + }); + + group('.onAddListener', () { + test('is not called on read', () { + final container = ProviderContainer.test(); + final listener = OnAddListener(); + final provider = Provider((ref) { + ref.onAddListener(listener.call); + }); + + container.read(provider); + + verifyZeroInteractions(listener); + }); + + test('calls listeners when container.listen is invoked', () { + final container = ProviderContainer.test(); + final listener = OnAddListener(); + final listener2 = OnAddListener(); + final provider = Provider((ref) { + ref.onAddListener(listener.call); + ref.onAddListener(listener2.call); + }); + + container.listen(provider, (previous, next) {}); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + container.listen(provider, (previous, next) {}); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('calls listeners when new ref.listen is invoked', () { + final container = ProviderContainer.test(); + final listener = OnAddListener(); + final listener2 = OnAddListener(); + final dep = Provider( + name: 'dep', + (ref) { + ref.onAddListener(listener.call); + ref.onAddListener(listener2.call); + }, + ); + late Ref ref; + final provider = Provider( + name: 'provider', + (r) => ref = r, + ); + + // initialize ref + container.read(provider); + + ref.listen(dep, (previous, next) {}); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + ref.listen(dep, (previous, next) {}); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('calls listeners when new ref.watch is invoked', () { + final container = ProviderContainer.test(); + final listener = OnAddListener(); + final listener2 = OnAddListener(); + final dep = Provider( + name: 'dep', + (ref) { + ref.onAddListener(listener.call); + ref.onAddListener(listener2.call); + }, + ); + late Ref ref; + final provider = Provider( + name: 'provider', + (r) => ref = r, + ); + late Ref ref2; + final provider2 = Provider( + name: 'provider', + (r) => ref2 = r, + ); + + // initialize refs + container.read(provider); + container.read(provider2); + + ref.watch(dep); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + ref.watch(dep); + + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + ref2.watch(dep); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('listeners are cleared on rebuild', () { + final container = ProviderContainer.test(); + final listener = OnAddListener(); + final listener2 = OnAddListener(); + var isSecondBuild = false; + final provider = Provider((ref) { + if (isSecondBuild) { + ref.onAddListener(listener2.call); + } else { + ref.onAddListener(listener.call); + } + }); + + container.read(provider); + isSecondBuild = true; + container.refresh(provider); + + container.listen(provider, (previous, next) {}); + + verify(listener2()).called(1); + verifyNoMoreInteractions(listener2); + verifyZeroInteractions(listener); + }); + + test('if a listener throws, still calls all listeners', () { + final errors = []; + final container = ProviderContainer.test(); + final listener = OnAddListener(); + final listener2 = OnAddListener(); + when(listener()).thenThrow(42); + final provider = Provider((ref) { + ref.onAddListener(listener.call); + ref.onAddListener(listener2.call); + }); + + runZonedGuarded( + () => container.listen(provider, (prev, next) {}), + (err, stack) => errors.add(err), + ); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + expect(errors, [42]); + }); + }); + + group('.onResume', () { + test('is not called on initial subscription', () { + final container = ProviderContainer.test(); + final listener = OnResume(); + final provider = Provider((ref) { + ref.onResume(listener.call); + }); + + container.read(provider); + container.listen(provider, (previous, next) {}); + + verifyZeroInteractions(listener); + }); + + test('calls listeners on the first new container.listen after a cancel', + () { + final container = ProviderContainer.test(); + final listener = OnResume(); + final listener2 = OnResume(); + final provider = Provider((ref) { + ref.onResume(listener.call); + ref.onResume(listener2.call); + }); + + final sub = container.listen(provider, (previous, next) {}); + sub.close(); + + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); + + container.listen(provider, (previous, next) {}); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + container.listen(provider, (previous, next) {}); + + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('calls listeners on the first new ref.listen after a cancel', () { + final container = ProviderContainer.test(); + final listener = OnResume(); + final listener2 = OnResume(); + final dep = Provider( + name: 'dep', + (ref) { + ref.onResume(listener.call); + ref.onResume(listener2.call); + }, + ); + late Ref ref; + final provider = Provider( + name: 'provider', + (r) => ref = r, + ); + + // initialize ref + container.read(provider); + + final sub = ref.listen(dep, (previous, next) {}); + sub.close(); + + verifyZeroInteractions(listener); + + ref.listen(dep, (previous, next) {}); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + + ref.listen(dep, (previous, next) {}); + + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('does not call listeners on read after a cancel', () { + final container = ProviderContainer.test(); + final listener = OnResume(); + final provider = Provider((ref) { + ref.onResume(listener.call); + }); + + final sub = container.listen(provider, (previous, next) {}); + sub.close(); + + verifyZeroInteractions(listener); + + container.read(provider); + + verifyZeroInteractions(listener); + }); + + test('calls listeners when ref.watch is invoked after a cancel', () { + final container = ProviderContainer.test(); + final listener = OnResume(); + final listener2 = OnResume(); + final dep = Provider( + name: 'dep', + (ref) { + ref.onAddListener(listener.call); + ref.onAddListener(listener2.call); + }, + ); + late Ref ref; + final provider = Provider( + name: 'provider', + (r) => ref = r, + ); + + // initialize refs + container.read(provider); + + final sub = container.listen(provider, (previous, next) {}); + sub.close(); + + verifyZeroInteractions(listener); + + ref.watch(dep); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('listeners are cleared on rebuild', () { + final container = ProviderContainer.test(); + final listener = OnResume(); + final listener2 = OnResume(); + var isSecondBuild = false; + final provider = Provider((ref) { + if (isSecondBuild) { + ref.onResume(listener2.call); + } else { + ref.onResume(listener.call); + } + }); + + container.read(provider); + isSecondBuild = true; + container.refresh(provider); + + final sub = container.listen(provider, (previous, next) {}); + sub.close(); + + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); + + container.listen(provider, (previous, next) {}); + + verify(listener2()).called(1); + verifyNoMoreInteractions(listener2); + verifyZeroInteractions(listener); + }); + + test('internal resume status is cleared on rebuild', () { + final container = ProviderContainer.test(); + final listener = OnResume(); + final provider = Provider((ref) { + ref.onResume(listener.call); + }); + + final sub = container.listen(provider, (previous, next) {}); + sub.close(); + + container.refresh(provider); + + final sub2 = container.listen(provider, (previous, next) {}); + sub2.close(); + + verifyZeroInteractions(listener); + + container.listen(provider, (previous, next) {}); + + verifyOnly(listener, listener()); + }); + + test('if a listener throws, still calls all listeners', () { + final errors = []; + final container = ProviderContainer.test(); + final listener = OnResume(); + final listener2 = OnResume(); + when(listener()).thenThrow(42); + final provider = Provider((ref) { + ref.onResume(listener.call); + ref.onResume(listener2.call); + }); + + final sub = container.listen(provider, (previous, next) {}); + sub.close(); + + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); + + runZonedGuarded( + () => container.listen(provider, (prev, next) {}), + (err, stack) => errors.add(err), + ); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + expect(errors, [42]); + }); + }); + + group('.onCancel', () { + test( + 'is called when dependent is invalidated and was the only listener', + skip: 'Waiting for "clear dependencies after futureprovider rebuilds"', + () async { + // + final container = ProviderContainer.test(); + final onCancel = OnCancelMock(); + final dep = StateProvider((ref) { + ref.onCancel(onCancel.call); + return 0; + }); + final provider = Provider.autoDispose((ref) => ref.watch(dep)); + + container.read(provider); + + verifyZeroInteractions(onCancel); + + container.read(dep.notifier).state++; + + verify(onCancel()).called(1); + + await container.pump(); + + verifyNoMoreInteractions(onCancel); + }, + ); + + test('is called when all container listeners are removed', () { + final container = ProviderContainer.test(); + final listener = OnCancelMock(); + final listener2 = OnCancelMock(); + final provider = Provider((ref) { + ref.onCancel(listener.call); + ref.onCancel(listener2.call); + }); + + final sub = container.listen(provider, (previous, next) {}); + final sub2 = container.listen(provider, (previous, next) {}); + + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); + + sub.close(); + + verifyZeroInteractions(listener2); + + sub2.close(); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('is called when all provider listeners are removed', () { + final container = ProviderContainer.test(); + final listener = OnCancelMock(); + final listener2 = OnCancelMock(); + final dep = Provider((ref) { + ref.onCancel(listener.call); + ref.onCancel(listener2.call); + }); + late Ref ref; + final provider = Provider((r) { + ref = r; + }); + + container.read(provider); + final sub = ref.listen(dep, (previous, next) {}); + final sub2 = ref.listen(dep, (previous, next) {}); + + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); + + sub.close(); + + verifyZeroInteractions(listener2); + + sub2.close(); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('is called when all provider dependencies are removed', () { + final container = ProviderContainer.test(); + final listener = OnCancelMock(); + final listener2 = OnCancelMock(); + final dep = Provider((ref) { + ref.onCancel(listener.call); + ref.onCancel(listener2.call); + }); + var watching = true; + final provider = Provider((ref) { + if (watching) ref.watch(dep); + }); + final provider2 = Provider((ref) { + if (watching) ref.watch(dep); + }); + + container.read(provider); + container.read(provider2); + + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); + + watching = false; + // remove the dependency provider<>dep + container.refresh(provider); + + verifyZeroInteractions(listener2); + + // remove the dependency provider2<>dep + container.refresh(provider2); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + }); + + test('is not called when using container.read', () async { + final container = ProviderContainer.test(); + final listener = OnCancelMock(); + final provider = Provider((ref) { + ref.onCancel(listener.call); + }); + + container.read(provider); + await container.pump(); + + verifyZeroInteractions(listener); + }); + + test( + 'is not called when using container.read (autoDispose)', + skip: true, + () async { + final container = ProviderContainer.test(); + final listener = OnCancelMock(); + final dispose = OnDisposeMock(); + final provider = StateProvider.autoDispose((ref) { + ref.keepAlive(); + ref.onCancel(listener.call); + ref.onDispose(dispose.call); + }); + + container.read(provider); + await container.pump(); + + verifyZeroInteractions(listener); + verifyZeroInteractions(dispose); + }, + ); + + test('listeners are cleared on rebuild', () { + final container = ProviderContainer.test(); + final listener = OnCancelMock(); + final listener2 = OnCancelMock(); + var isSecondBuild = false; + final provider = Provider((ref) { + if (isSecondBuild) { + ref.onCancel(listener2.call); + } else { + ref.onCancel(listener.call); + } + }); + + container.read(provider); + isSecondBuild = true; + container.refresh(provider); + + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); + + final sub = container.listen(provider, (previous, next) {}); + + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); + + sub.close(); + + verify(listener2()).called(1); + verifyNoMoreInteractions(listener2); + verifyZeroInteractions(listener); + }); + + test('if a listener throws, still calls all listeners', () { + final errors = []; + final container = ProviderContainer.test(); + final listener = OnCancelMock(); + final listener2 = OnCancelMock(); + when(listener()).thenThrow(42); + final provider = Provider((ref) { + ref.onCancel(listener.call); + ref.onCancel(listener2.call); + }); + + final sub = container.listen(provider, (previous, next) {}); + + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); + + runZonedGuarded( + sub.close, + (err, stack) => errors.add(err), + ); + + verifyInOrder([listener(), listener2()]); + verifyNoMoreInteractions(listener); + verifyNoMoreInteractions(listener2); + expect(errors, [42]); + }); + }); + + group('.onDispose', () { + test( + 'calls all the listeners in order when the ProviderContainer is disposed', + () { + final onDispose = OnDisposeMock(); + final onDispose2 = OnDisposeMock(); + final provider = Provider((ref) { + ref.onDispose(onDispose.call); + ref.onDispose(onDispose2.call); + }); + + final container = ProviderContainer(); + addTearDown(container.dispose); + + container.read(provider); // register the onDispose hooks + + verifyZeroInteractions(onDispose); + verifyZeroInteractions(onDispose2); + + container.dispose(); + + verifyInOrder([ + onDispose(), + onDispose2(), + ]); + verifyNoMoreInteractions(onDispose); + verifyNoMoreInteractions(onDispose2); + }); + + test('calls all listeners in order when one of its dependency changed', + () async { + final onDispose = OnDisposeMock(); + final onDispose2 = OnDisposeMock(); + + final count = StateProvider((ref) => 0); + final provider = Provider((ref) { + ref.watch(count); + ref.onDispose(onDispose.call); + ref.onDispose(onDispose2.call); + }); + + final container = ProviderContainer(); + addTearDown(container.dispose); + + container.read(provider); // register the onDispose hooks + + verifyZeroInteractions(onDispose); + verifyZeroInteractions(onDispose2); + + container.read(count.notifier).state++; + await container.pump(); + + verifyInOrder([ + onDispose(), + onDispose2(), + ]); + verifyNoMoreInteractions(onDispose); + verifyNoMoreInteractions(onDispose2); + }); + + test('does not call listeners again if more than one dependency changed', + () { + final onDispose = OnDisposeMock(); + + final count = StateProvider((ref) => 0); + final count2 = StateProvider((ref) => 0); + final provider = Provider((ref) { + ref.watch(count); + ref.watch(count2); + ref.onDispose(onDispose.call); + }); + + final container = ProviderContainer(); + addTearDown(container.dispose); + + container.read(provider); // register the onDispose hooks + + verifyZeroInteractions(onDispose); + + container.read(count.notifier).state++; + container.read(count2.notifier).state++; + + verifyOnly(onDispose, onDispose()); + }); + + test( + 'does not call listeners again if a dependency changed then ProviderContainer was disposed', + () async { + final onDispose = OnDisposeMock(); + var buildCount = 0; + + final count = StateProvider((ref) => 0); + final provider = Provider((ref) { + buildCount++; + ref.watch(count); + ref.onDispose(onDispose.call); + }); + + final container = ProviderContainer(); + addTearDown(container.dispose); + + container.read(provider); // register the onDispose hooks + expect(buildCount, 1); + + verifyZeroInteractions(onDispose); + + container.read(count.notifier).state++; + // no pump() because that would rebuild the provider, which means it would + // need to be disposed once again. verifyOnly(onDispose, onDispose()); @@ -1564,15 +2816,32 @@ void main() { }); group('mounted', () { + test('stays false on older refs while new refs are building', () { + final container = ProviderContainer.test(); + late Ref ref; + final provider = Provider((r) { + ref = r; + return 0; + }); + + container.read(provider); + final oldRef = ref; + + container.refresh(provider); + + expect(oldRef.mounted, false); + expect(ref.mounted, true); + }); + test('is false during onDispose caused by ref.watch', () { final container = ProviderContainer.test(); bool? mounted; - late ProviderElementBase element; + late Ref ref; final dep = StateProvider((ref) => 0); - final provider = Provider((ref) { + final provider = Provider((r) { + ref = r; ref.watch(dep); - element = ref as ProviderElementBase; - ref.onDispose(() => mounted = element.mounted); + ref.onDispose(() => mounted = ref.mounted); }); container.read(provider); @@ -1586,12 +2855,12 @@ void main() { test('is false during onDispose caused by container dispose', () { final container = ProviderContainer.test(); bool? mounted; - late ProviderElementBase element; + late Ref ref; final dep = StateProvider((ref) => 0); - final provider = Provider((ref) { + final provider = Provider((r) { + ref = r; ref.watch(dep); - element = ref as ProviderElementBase; - ref.onDispose(() => mounted = element.mounted); + ref.onDispose(() => mounted = ref.mounted); }); container.read(provider); @@ -1605,18 +2874,18 @@ void main() { test('is false in between rebuilds', () { final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); - late ProviderElementBase element; - final provider = Provider((ref) { + late Ref ref; + final provider = Provider((r) { + ref = r; ref.watch(dep); - element = ref as ProviderElementBase; }); container.read(provider); - expect(element.mounted, true); + expect(ref.mounted, true); container.read(dep.notifier).state++; - expect(element.mounted, false); + expect(ref.mounted, false); }); }); }); diff --git a/packages/riverpod/test/new/core/uni_directional_test.dart b/packages/riverpod/test/new/core/uni_directional_test.dart index c3ef53f8a..b62b363e1 100644 --- a/packages/riverpod/test/new/core/uni_directional_test.dart +++ b/packages/riverpod/test/new/core/uni_directional_test.dart @@ -89,7 +89,7 @@ void main() { final dep = StateProvider((ref) => 0); final provider = Provider((ref) => ref.watch(dep)); final another = StateProvider((ref) { - ref.listen(provider, (prev, value) => ref.controller.state++); + ref.listen(provider, (prev, value) => ref.state++); return 0; }); final container = ProviderContainer.test(); diff --git a/packages/riverpod/test/new/utils.dart b/packages/riverpod/test/new/utils.dart index 13c9e517b..0817cb689 100644 --- a/packages/riverpod/test/new/utils.dart +++ b/packages/riverpod/test/new/utils.dart @@ -5,10 +5,28 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; +class ProviderObserverMock extends Mock implements ProviderObserver {} + class OnDisposeMock extends Mock { void call(); } +class OnCancelMock extends Mock { + void call(); +} + +class OnResume extends Mock { + void call(); +} + +class OnAddListener extends Mock { + void call(); +} + +class OnRemoveListener extends Mock { + void call(); +} + /// Syntax sugar for: /// /// ```dart diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 77da1c998..03bbda9b0 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -143,7 +143,7 @@ void main() { final dep = StateProvider((ref) => 0); final provider = Provider((ref) => ref.watch(dep)); final another = StateProvider((ref) { - ref.listen(provider, (prev, value) => ref.controller.state++); + ref.listen(provider, (prev, value) => ref.state++); return 0; }); final container = ProviderContainer.test(); @@ -161,7 +161,7 @@ void main() { final dep = StateProvider((ref) => 0); final provider = Provider((ref) => ref.watch(dep)); final another = StateProvider((ref) { - ref.listen(provider, (prev, value) => ref.controller.state++); + ref.listen(provider, (prev, value) => ref.state++); return 0; }); final container = ProviderContainer.test(); diff --git a/packages/riverpod/test/old/framework/provider_element_test.dart b/packages/riverpod/test/old/framework/provider_element_test.dart index cba09875b..d17f31ea2 100644 --- a/packages/riverpod/test/old/framework/provider_element_test.dart +++ b/packages/riverpod/test/old/framework/provider_element_test.dart @@ -1,5 +1,3 @@ -import 'dart:async'; - import 'package:mockito/mockito.dart'; import 'package:riverpod/src/internals.dart'; import 'package:test/test.dart'; @@ -7,1117 +5,6 @@ import 'package:test/test.dart'; import '../utils.dart'; void main() { - group('Ref.exists', () { - test('Returns true if available on ancestor container', () { - final root = ProviderContainer.test(); - final container = ProviderContainer.test(parent: root); - final provider = Provider((ref) => 0); - - root.read(provider); - - expect(container.exists(provider), true); - expect(root.exists(provider), true); - }); - - test('simple use-case', () { - final container = ProviderContainer.test(); - final provider = Provider((ref) => 0); - final refProvider = Provider((ref) => ref); - - final ref = container.read(refProvider); - - expect( - container.getAllProviderElements().map((e) => e.origin), - [refProvider], - ); - expect(container.exists(refProvider), true); - expect(ref.exists(provider), false); - - ref.read(provider); - - expect(ref.exists(refProvider), true); - expect(ref.exists(provider), true); - }); - }); - - group('ref.notifyListeners', () { - test('If called after initialization, notify listeners', () { - final observer = ProviderObserverMock(); - final listener = Listener(); - final selfListener = Listener(); - final container = ProviderContainer.test(observers: [observer]); - late Ref ref; - final provider = Provider((r) { - ref = r; - ref.listenSelf(selfListener.call); - return 0; - }); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(observer, observer.didAddProvider(provider, 0, container)); - verifyOnly(listener, listener(null, 0)); - verifyOnly(selfListener, selfListener(null, 0)); - - ref.notifyListeners(); - - verifyOnly(listener, listener(0, 0)); - verifyOnly(selfListener, selfListener(0, 0)); - verifyOnly( - observer, - observer.didUpdateProvider(provider, 0, 0, container), - ); - }); - - test( - 'can be invoked during first initialization, and does not notify listeners', - () { - final observer = ProviderObserverMock(); - final selfListener = Listener(); - final listener = Listener(); - final container = ProviderContainer.test(observers: [observer]); - final provider = Provider((ref) { - ref.listenSelf(selfListener.call); - ref.notifyListeners(); - return 0; - }); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(observer, observer.didAddProvider(provider, 0, container)); - verifyOnly(listener, listener(null, 0)); - verifyOnly(selfListener, selfListener(null, 0)); - }); - - test( - 'can be invoked during a re-initialization, and does not notify listeners', - () { - final observer = ProviderObserverMock(); - final listener = Listener(); - final selfListener = Listener(); - final container = ProviderContainer.test(observers: [observer]); - var callNotifyListeners = false; - const firstValue = 'first'; - const secondValue = 'second'; - var result = firstValue; - final provider = Provider((ref) { - ref.listenSelf(selfListener.call); - if (callNotifyListeners) { - ref.notifyListeners(); - } - return result; - }); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly( - observer, - observer.didAddProvider(provider, firstValue, container), - ); - verifyOnly(selfListener, selfListener(null, firstValue)); - verifyOnly(listener, listener(null, firstValue)); - - result = secondValue; - callNotifyListeners = true; - container.refresh(provider); - - verifyOnly(selfListener, selfListener(firstValue, secondValue)); - verifyOnly(listener, listener(firstValue, secondValue)); - verify(observer.didDisposeProvider(provider, container)); - verify( - observer.didUpdateProvider( - provider, - firstValue, - secondValue, - container, - ), - ).called(1); - verifyNoMoreInteractions(observer); - }); - }); - - group('ref.refresh', () { - test('Throws if a circular dependency is detected', () { - // Regression test for https://github.com/rrousselGit/riverpod/issues/2336 - late Ref ref; - final a = Provider((r) { - ref = r; - return 0; - }); - final b = Provider((r) => r.watch(a)); - final container = ProviderContainer.test(); - - container.read(b); - - expect( - () => ref.refresh(b), - throwsA(isA()), - ); - }); - }); - - group('ref.invalidate', () { - test('Throws if a circular dependency is detected', () { - // Regression test for https://github.com/rrousselGit/riverpod/issues/2336 - late Ref ref; - final a = Provider((r) { - ref = r; - return 0; - }); - final b = Provider((r) => r.watch(a)); - final container = ProviderContainer.test(); - - container.read(b); - - expect( - () => ref.invalidate(b), - throwsA(isA()), - ); - }); - - test('Circular dependency ignores families', () { - late Ref ref; - final a = Provider((r) { - ref = r; - return 0; - }); - final b = Provider.family((r, id) => r.watch(a)); - final container = ProviderContainer.test(); - - container.read(b(0)); - - expect( - () => ref.invalidate(b), - returnsNormally, - ); - }); - - test('triggers a rebuild on next frame', () async { - final container = ProviderContainer.test(); - final listener = Listener(); - var result = 0; - final provider = Provider((r) => result); - late Ref ref; - final another = Provider((r) { - ref = r; - }); - - container.listen(provider, listener.call); - container.read(another); - verifyZeroInteractions(listener); - - ref.invalidate(provider); - ref.invalidate(provider); - result = 1; - - verifyZeroInteractions(listener); - - await container.pump(); - - verifyOnly(listener, listener(0, 1)); - }); - - group('on families', () { - test('recomputes providers associated with the family', () async { - final container = ProviderContainer.test(); - final listener = Listener(); - final listener2 = Listener(); - final listener3 = Listener(); - var result = 0; - final unrelated = Provider((ref) => result); - final provider = Provider.family((r, i) => '$result-$i'); - late Ref ref; - final another = Provider((r) { - ref = r; - }); - - container.read(another); - - container.listen(provider(0), listener.call, fireImmediately: true); - container.listen(provider(1), listener2.call, fireImmediately: true); - container.listen(unrelated, listener3.call, fireImmediately: true); - - verifyOnly(listener, listener(null, '0-0')); - verifyOnly(listener2, listener2(null, '0-1')); - verifyOnly(listener3, listener3(null, 0)); - - ref.invalidate(provider); - ref.invalidate(provider); - result = 1; - - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - verifyNoMoreInteractions(listener3); - - await container.pump(); - - verifyOnly(listener, listener('0-0', '1-0')); - verifyOnly(listener2, listener2('0-1', '1-1')); - verifyNoMoreInteractions(listener3); - }); - - test('clears only on the closest family override', () async { - var result = 0; - final provider = Provider.family( - (r, i) => result, - dependencies: const [], - ); - late Ref ref; - final another = Provider((r) => ref = r, dependencies: [provider]); - - final listener = Listener(); - final listener2 = Listener(); - final root = ProviderContainer.test(); - final container = ProviderContainer.test( - parent: root, - overrides: [provider, another], - ); - - container.read(another); - root.listen(provider(0), listener.call, fireImmediately: true); - container.listen(provider(1), listener2.call, fireImmediately: true); - - verifyOnly(listener, listener(null, 0)); - verifyOnly(listener2, listener2(null, 0)); - - ref.invalidate(provider); - result = 1; - - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - await container.pump(); - - verifyOnly(listener2, listener2(0, 1)); - verifyNoMoreInteractions(listener); - }); - }); - }); - - group('ref.invalidateSelf', () { - test('calls dispose immediately', () { - final container = ProviderContainer.test(); - final listener = OnDisposeMock(); - late Ref ref; - final provider = Provider((r) { - ref = r; - ref.onDispose(listener.call); - }); - - container.read(provider); - verifyZeroInteractions(listener); - - ref.invalidateSelf(); - - verifyOnly(listener, listener()); - - ref.invalidateSelf(); - - verifyNoMoreInteractions(listener); - }); - - test('triggers a rebuild on next frame', () async { - final container = ProviderContainer.test(); - final listener = Listener(); - var result = 0; - late Ref ref; - final provider = Provider((r) { - ref = r; - return result; - }); - - container.listen(provider, listener.call); - verifyZeroInteractions(listener); - - ref.invalidateSelf(); - ref.invalidateSelf(); - result = 1; - - verifyZeroInteractions(listener); - - await container.pump(); - - verifyOnly(listener, listener(0, 1)); - }); - - test('merges the rebuild with dependency change rebuild', () async { - final container = ProviderContainer.test(); - final listener = Listener(); - final dep = StateProvider((ref) => 0); - late Ref ref; - final provider = Provider((r) { - ref = r; - return ref.watch(dep); - }); - - container.listen(provider, listener.call); - verifyZeroInteractions(listener); - - ref.invalidateSelf(); - container.read(dep.notifier).state++; - - verifyZeroInteractions(listener); - - await container.pump(); - - verifyOnly(listener, listener(0, 1)); - }); - }); - - group('ref.onRemoveListener', () { - test('is not called on read', () { - final container = ProviderContainer.test(); - final listener = OnRemoveListener(); - final provider = Provider((ref) { - ref.onRemoveListener(listener.call); - }); - - container.read(provider); - - verifyZeroInteractions(listener); - }); - - test('calls listeners when container.listen subscriptions are closed', () { - final container = ProviderContainer.test(); - final listener = OnRemoveListener(); - final listener2 = OnRemoveListener(); - final provider = Provider((ref) { - ref.onRemoveListener(listener.call); - ref.onRemoveListener(listener2.call); - }); - - final sub = container.listen(provider, (previous, next) {}); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - sub.close(); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - final sub2 = container.listen(provider, (previous, next) {}); - - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - sub2.close(); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('calls listeners when ref.listen subscriptions are closed', () { - final container = ProviderContainer.test(); - final listener = OnRemoveListener(); - final listener2 = OnRemoveListener(); - final dep = Provider( - name: 'dep', - (ref) { - ref.onRemoveListener(listener.call); - ref.onRemoveListener(listener2.call); - }, - ); - late Ref ref; - final provider = Provider( - name: 'provider', - (r) { - ref = r; - }, - ); - - // initialize ref - container.read(provider); - - final sub = ref.listen(dep, (previous, next) {}); - - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - sub.close(); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - final sub2 = ref.listen(dep, (previous, next) {}); - - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - sub2.close(); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('calls listeners when ref.watch subscriptions are removed', () { - final container = ProviderContainer.test(); - final listener = OnRemoveListener(); - final listener2 = OnRemoveListener(); - final dep = Provider( - name: 'dep', - (ref) { - ref.onRemoveListener(listener.call); - ref.onRemoveListener(listener2.call); - }, - ); - late Ref ref; - final provider = Provider( - name: 'provider', - (r) => ref = r, - ); - - // initialize refs - container.read(provider); - - ref.watch(dep); - - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - container.refresh(provider); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('listeners are cleared on rebuild', () { - final container = ProviderContainer.test(); - final listener = OnRemoveListener(); - final listener2 = OnRemoveListener(); - var isSecondBuild = false; - final provider = Provider((ref) { - if (isSecondBuild) { - ref.onRemoveListener(listener2.call); - } else { - ref.onRemoveListener(listener.call); - } - }); - - container.read(provider); - isSecondBuild = true; - container.refresh(provider); - - final sub = container.listen(provider, (previous, next) {}); - sub.close(); - - verify(listener2()).called(1); - verifyNoMoreInteractions(listener2); - verifyZeroInteractions(listener); - }); - - test('if a listener throws, still calls all listeners', () { - final errors = []; - final container = ProviderContainer.test(); - final listener = OnRemoveListener(); - final listener2 = OnRemoveListener(); - when(listener()).thenThrow(42); - final provider = Provider((ref) { - ref.onRemoveListener(listener.call); - ref.onRemoveListener(listener2.call); - }); - - final sub = container.listen(provider, (prev, next) {}); - - runZonedGuarded( - sub.close, - (err, stack) => errors.add(err), - ); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - expect(errors, [42]); - }); - }); - - group('ref.onAddListener', () { - test('is not called on read', () { - final container = ProviderContainer.test(); - final listener = OnAddListener(); - final provider = Provider((ref) { - ref.onAddListener(listener.call); - }); - - container.read(provider); - - verifyZeroInteractions(listener); - }); - - test('calls listeners when container.listen is invoked', () { - final container = ProviderContainer.test(); - final listener = OnAddListener(); - final listener2 = OnAddListener(); - final provider = Provider((ref) { - ref.onAddListener(listener.call); - ref.onAddListener(listener2.call); - }); - - container.listen(provider, (previous, next) {}); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - container.listen(provider, (previous, next) {}); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('calls listeners when new ref.listen is invoked', () { - final container = ProviderContainer.test(); - final listener = OnAddListener(); - final listener2 = OnAddListener(); - final dep = Provider( - name: 'dep', - (ref) { - ref.onAddListener(listener.call); - ref.onAddListener(listener2.call); - }, - ); - late Ref ref; - final provider = Provider( - name: 'provider', - (r) => ref = r, - ); - - // initialize ref - container.read(provider); - - ref.listen(dep, (previous, next) {}); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - ref.listen(dep, (previous, next) {}); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('calls listeners when new ref.watch is invoked', () { - final container = ProviderContainer.test(); - final listener = OnAddListener(); - final listener2 = OnAddListener(); - final dep = Provider( - name: 'dep', - (ref) { - ref.onAddListener(listener.call); - ref.onAddListener(listener2.call); - }, - ); - late Ref ref; - final provider = Provider( - name: 'provider', - (r) => ref = r, - ); - late Ref ref2; - final provider2 = Provider( - name: 'provider', - (r) => ref2 = r, - ); - - // initialize refs - container.read(provider); - container.read(provider2); - - ref.watch(dep); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - ref.watch(dep); - - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - ref2.watch(dep); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('listeners are cleared on rebuild', () { - final container = ProviderContainer.test(); - final listener = OnAddListener(); - final listener2 = OnAddListener(); - var isSecondBuild = false; - final provider = Provider((ref) { - if (isSecondBuild) { - ref.onAddListener(listener2.call); - } else { - ref.onAddListener(listener.call); - } - }); - - container.read(provider); - isSecondBuild = true; - container.refresh(provider); - - container.listen(provider, (previous, next) {}); - - verify(listener2()).called(1); - verifyNoMoreInteractions(listener2); - verifyZeroInteractions(listener); - }); - - test('if a listener throws, still calls all listeners', () { - final errors = []; - final container = ProviderContainer.test(); - final listener = OnAddListener(); - final listener2 = OnAddListener(); - when(listener()).thenThrow(42); - final provider = Provider((ref) { - ref.onAddListener(listener.call); - ref.onAddListener(listener2.call); - }); - - runZonedGuarded( - () => container.listen(provider, (prev, next) {}), - (err, stack) => errors.add(err), - ); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - expect(errors, [42]); - }); - }); - - group('ref.onResume', () { - test('is not called on initial subscription', () { - final container = ProviderContainer.test(); - final listener = OnResume(); - final provider = Provider((ref) { - ref.onResume(listener.call); - }); - - container.read(provider); - container.listen(provider, (previous, next) {}); - - verifyZeroInteractions(listener); - }); - - test('calls listeners on the first new container.listen after a cancel', - () { - final container = ProviderContainer.test(); - final listener = OnResume(); - final listener2 = OnResume(); - final provider = Provider((ref) { - ref.onResume(listener.call); - ref.onResume(listener2.call); - }); - - final sub = container.listen(provider, (previous, next) {}); - sub.close(); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - container.listen(provider, (previous, next) {}); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - container.listen(provider, (previous, next) {}); - - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('calls listeners on the first new ref.listen after a cancel', () { - final container = ProviderContainer.test(); - final listener = OnResume(); - final listener2 = OnResume(); - final dep = Provider( - name: 'dep', - (ref) { - ref.onResume(listener.call); - ref.onResume(listener2.call); - }, - ); - late Ref ref; - final provider = Provider( - name: 'provider', - (r) => ref = r, - ); - - // initialize ref - container.read(provider); - - final sub = ref.listen(dep, (previous, next) {}); - sub.close(); - - verifyZeroInteractions(listener); - - ref.listen(dep, (previous, next) {}); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - - ref.listen(dep, (previous, next) {}); - - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('does not call listeners on read after a cancel', () { - final container = ProviderContainer.test(); - final listener = OnResume(); - final provider = Provider((ref) { - ref.onResume(listener.call); - }); - - final sub = container.listen(provider, (previous, next) {}); - sub.close(); - - verifyZeroInteractions(listener); - - container.read(provider); - - verifyZeroInteractions(listener); - }); - - test('calls listeners when ref.watch is invoked after a cancel', () { - final container = ProviderContainer.test(); - final listener = OnResume(); - final listener2 = OnResume(); - final dep = Provider( - name: 'dep', - (ref) { - ref.onAddListener(listener.call); - ref.onAddListener(listener2.call); - }, - ); - late Ref ref; - final provider = Provider( - name: 'provider', - (r) => ref = r, - ); - - // initialize refs - container.read(provider); - - final sub = container.listen(provider, (previous, next) {}); - sub.close(); - - verifyZeroInteractions(listener); - - ref.watch(dep); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('listeners are cleared on rebuild', () { - final container = ProviderContainer.test(); - final listener = OnResume(); - final listener2 = OnResume(); - var isSecondBuild = false; - final provider = Provider((ref) { - if (isSecondBuild) { - ref.onResume(listener2.call); - } else { - ref.onResume(listener.call); - } - }); - - container.read(provider); - isSecondBuild = true; - container.refresh(provider); - - final sub = container.listen(provider, (previous, next) {}); - sub.close(); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - container.listen(provider, (previous, next) {}); - - verify(listener2()).called(1); - verifyNoMoreInteractions(listener2); - verifyZeroInteractions(listener); - }); - - test('internal resume status is cleared on rebuild', () { - final container = ProviderContainer.test(); - final listener = OnResume(); - final provider = Provider((ref) { - ref.onResume(listener.call); - }); - - final sub = container.listen(provider, (previous, next) {}); - sub.close(); - - container.refresh(provider); - - final sub2 = container.listen(provider, (previous, next) {}); - sub2.close(); - - verifyZeroInteractions(listener); - - container.listen(provider, (previous, next) {}); - - verifyOnly(listener, listener()); - }); - - test('if a listener throws, still calls all listeners', () { - final errors = []; - final container = ProviderContainer.test(); - final listener = OnResume(); - final listener2 = OnResume(); - when(listener()).thenThrow(42); - final provider = Provider((ref) { - ref.onResume(listener.call); - ref.onResume(listener2.call); - }); - - final sub = container.listen(provider, (previous, next) {}); - sub.close(); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - runZonedGuarded( - () => container.listen(provider, (prev, next) {}), - (err, stack) => errors.add(err), - ); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - expect(errors, [42]); - }); - }); - - group('ref.onCancel', () { - test( - 'is called when dependent is invalidated and was the only listener', - skip: 'Waiting for "clear dependencies after futureprovider rebuilds"', - () async { - // - final container = ProviderContainer.test(); - final onCancel = OnCancelMock(); - final dep = StateProvider((ref) { - ref.onCancel(onCancel.call); - return 0; - }); - final provider = Provider.autoDispose((ref) => ref.watch(dep)); - - container.read(provider); - - verifyZeroInteractions(onCancel); - - container.read(dep.notifier).state++; - - verify(onCancel()).called(1); - - await container.pump(); - - verifyNoMoreInteractions(onCancel); - }, - ); - - test('is called when all container listeners are removed', () { - final container = ProviderContainer.test(); - final listener = OnCancelMock(); - final listener2 = OnCancelMock(); - final provider = Provider((ref) { - ref.onCancel(listener.call); - ref.onCancel(listener2.call); - }); - - final sub = container.listen(provider, (previous, next) {}); - final sub2 = container.listen(provider, (previous, next) {}); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - sub.close(); - - verifyZeroInteractions(listener2); - - sub2.close(); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('is called when all provider listeners are removed', () { - final container = ProviderContainer.test(); - final listener = OnCancelMock(); - final listener2 = OnCancelMock(); - final dep = Provider((ref) { - ref.onCancel(listener.call); - ref.onCancel(listener2.call); - }); - late Ref ref; - final provider = Provider((r) { - ref = r; - }); - - container.read(provider); - final sub = ref.listen(dep, (previous, next) {}); - final sub2 = ref.listen(dep, (previous, next) {}); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - sub.close(); - - verifyZeroInteractions(listener2); - - sub2.close(); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('is called when all provider dependencies are removed', () { - final container = ProviderContainer.test(); - final listener = OnCancelMock(); - final listener2 = OnCancelMock(); - final dep = Provider((ref) { - ref.onCancel(listener.call); - ref.onCancel(listener2.call); - }); - var watching = true; - final provider = Provider((ref) { - if (watching) ref.watch(dep); - }); - final provider2 = Provider((ref) { - if (watching) ref.watch(dep); - }); - - container.read(provider); - container.read(provider2); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - watching = false; - // remove the dependency provider<>dep - container.refresh(provider); - - verifyZeroInteractions(listener2); - - // remove the dependency provider2<>dep - container.refresh(provider2); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - }); - - test('is not called when using container.read', () async { - final container = ProviderContainer.test(); - final listener = OnCancelMock(); - final provider = Provider((ref) { - ref.onCancel(listener.call); - }); - - container.read(provider); - await container.pump(); - - verifyZeroInteractions(listener); - }); - - test( - 'is not called when using container.read (autoDispose)', - skip: true, - () async { - final container = ProviderContainer.test(); - final listener = OnCancelMock(); - final dispose = OnDisposeMock(); - final provider = StateProvider.autoDispose((ref) { - ref.keepAlive(); - ref.onCancel(listener.call); - ref.onDispose(dispose.call); - }); - - container.read(provider); - await container.pump(); - - verifyZeroInteractions(listener); - verifyZeroInteractions(dispose); - }, - ); - - test('listeners are cleared on rebuild', () { - final container = ProviderContainer.test(); - final listener = OnCancelMock(); - final listener2 = OnCancelMock(); - var isSecondBuild = false; - final provider = Provider((ref) { - if (isSecondBuild) { - ref.onCancel(listener2.call); - } else { - ref.onCancel(listener.call); - } - }); - - container.read(provider); - isSecondBuild = true; - container.refresh(provider); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - final sub = container.listen(provider, (previous, next) {}); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - sub.close(); - - verify(listener2()).called(1); - verifyNoMoreInteractions(listener2); - verifyZeroInteractions(listener); - }); - - test('if a listener throws, still calls all listeners', () { - final errors = []; - final container = ProviderContainer.test(); - final listener = OnCancelMock(); - final listener2 = OnCancelMock(); - when(listener()).thenThrow(42); - final provider = Provider((ref) { - ref.onCancel(listener.call); - ref.onCancel(listener2.call); - }); - - final sub = container.listen(provider, (previous, next) {}); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - runZonedGuarded( - sub.close, - (err, stack) => errors.add(err), - ); - - verifyInOrder([listener(), listener2()]); - verifyNoMoreInteractions(listener); - verifyNoMoreInteractions(listener2); - expect(errors, [42]); - }); - }); - test( 'onDispose is triggered only once if within autoDispose unmount, a dependency changed', () async { diff --git a/packages/riverpod/test/old/legacy/framework_test.dart b/packages/riverpod/test/old/legacy/framework_test.dart index ffbc0fee9..e7e12ff48 100644 --- a/packages/riverpod/test/old/legacy/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework_test.dart @@ -1,9 +1,7 @@ -import 'dart:async'; - import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/internals.dart' - show $ProviderElement, CircularDependencyError, ProviderElementBase; + show CircularDependencyError, ProviderElementBase; import 'package:test/test.dart'; import '../utils.dart'; @@ -57,59 +55,6 @@ void main() { ]); }); - test("can't call onDispose inside onDispose", () { - final provider = Provider((ref) { - ref.onDispose(() { - ref.onDispose(() {}); - }); - return ref; - }); - final container = ProviderContainer.test(); - - container.read(provider); - - final errors = []; - runZonedGuarded(container.dispose, (err, _) => errors.add(err)); - - expect(errors, [isStateError]); - }); - - test("can't call read inside onDispose", () { - final provider2 = Provider((ref) => 0); - final provider = Provider((ref) { - ref.onDispose(() { - ref.read(provider2); - }); - return ref; - }); - final container = ProviderContainer.test(); - - container.read(provider); - - final errors = []; - runZonedGuarded(container.dispose, (err, _) => errors.add(err)); - - expect(errors, [isStateError]); - }); - - test("can't call watch inside onDispose", () { - final provider2 = Provider((ref) => 0); - final provider = Provider((ref) { - ref.onDispose(() { - ref.watch(provider2); - }); - return ref; - }); - final container = ProviderContainer.test(); - - container.read(provider); - - final errors = []; - runZonedGuarded(container.dispose, (err, _) => errors.add(err)); - - expect(errors, [isStateError]); - }); - test('disposing an already disposed container is no-op', () { final container = ProviderContainer.test(); @@ -258,23 +203,6 @@ void main() { verifyNoMoreInteractions(onDispose3); }); - test('Ref is unusable after dispose (read/onDispose)', () { - final container = ProviderContainer.test(); - late $ProviderElement ref; - final provider = Provider((s) { - ref = s as $ProviderElement; - return 42; - }); - final other = Provider((_) => 42); - - expect(container.read(provider), 42); - container.dispose(); - - expect(ref.mounted, isFalse); - expect(() => ref.onDispose(() {}), throwsStateError); - expect(() => ref.read(other), throwsStateError); - }); - test('if a provider threw on creation, onDispose still works', () { var callCount = 0; final onDispose = OnDisposeMock(); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart index 3693207e2..fb0f922f4 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart @@ -10,7 +10,7 @@ void main() { test('can read and set current StateNotifier', () async { final container = ProviderContainer.test(); final listener = Listener(); - late StateNotifierProviderRef ref; + late Ref ref; final provider = StateNotifierProvider.autoDispose((r) { ref = r; return Counter(); @@ -19,7 +19,7 @@ void main() { container.listen(provider, listener.call); verifyZeroInteractions(listener); - expect(ref.notifier.state, 0); + expect(ref.state, 0); }); test('can be auto-scoped', () async { diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart index 669f2e5a4..840f1286a 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart @@ -19,10 +19,10 @@ void main() { final container = ProviderContainer.test( overrides: [ provider.overrideWith( - (StateNotifierProviderRef ref) => TestNotifier(42), + (Ref ref) => TestNotifier(42), ), autoDispose.overrideWith( - (StateNotifierProviderRef ref) => TestNotifier(84), + (Ref ref) => TestNotifier(84), ), ], ); @@ -42,12 +42,11 @@ void main() { final container = ProviderContainer.test( overrides: [ family.overrideWith( - (StateNotifierProviderRef ref, int arg) => - TestNotifier(42 + arg), + (Ref ref, int arg) => TestNotifier(42 + arg), ), autoDisposeFamily.overrideWith( ( - StateNotifierProviderRef ref, + Ref ref, int arg, ) => TestNotifier(84 + arg), @@ -98,7 +97,7 @@ void main() { test('can read and set current StateNotifier', () async { final container = ProviderContainer.test(); final listener = Listener(); - late StateNotifierProviderRef ref; + late Ref ref; final provider = StateNotifierProvider((r) { ref = r; return Counter(); @@ -107,7 +106,7 @@ void main() { container.listen(provider, listener.call); verifyZeroInteractions(listener); - expect(ref.notifier.state, 0); + expect(ref.state, 0); }); test('can be auto-scoped', () async { diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart index fc7685341..7ea69d55b 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart @@ -1,11 +1,8 @@ -import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; -import '../../../utils.dart'; - void main() { test('supports .name', () { expect( @@ -39,70 +36,6 @@ void main() { expect(root.getAllProviderElements(), isEmpty); }); - group('ref.state', () { - test('can read and change current value', () { - final container = ProviderContainer.test(); - final listener = Listener(); - late StateProviderRef ref; - final provider = StateProvider.autoDispose((r) { - ref = r; - return 0; - }); - - container.listen(provider, listener.call); - verifyZeroInteractions(listener); - - expect(ref.controller, container.read(provider.notifier)); - - ref.controller.state = 42; - - verifyOnly(listener, listener(0, 42)); - - expect(ref.controller.state, 42); - }); - - test('fails if trying to read the state before it was set', () { - final container = ProviderContainer.test(); - Object? err; - final provider = StateProvider.autoDispose((ref) { - try { - ref.controller; - } catch (e) { - err = e; - } - return 0; - }); - - container.read(provider); - expect(err, isStateError); - }); - - test('on rebuild, still fails if trying to read the state before was built', - () { - final dep = StateProvider((ref) => false); - final container = ProviderContainer.test(); - Object? err; - final provider = StateProvider.autoDispose((ref) { - if (ref.watch(dep)) { - try { - ref.controller; - } catch (e) { - err = e; - } - } - return 0; - }); - - container.read(provider); - expect(err, isNull); - - container.read(dep.notifier).state = true; - container.read(provider); - - expect(err, isStateError); - }); - }); - test('can refresh .notifier', () async { var initialValue = 1; final provider = StateProvider.autoDispose((ref) => initialValue); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart index 396666a8c..2046d1de7 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart @@ -18,8 +18,8 @@ void main() { ); final container = ProviderContainer.test( overrides: [ - provider.overrideWith((StateProviderRef ref) => 42), - autoDispose.overrideWith((StateProviderRef ref) => 84), + provider.overrideWith((Ref ref) => 42), + autoDispose.overrideWith((Ref ref) => 84), ], ); @@ -35,10 +35,10 @@ void main() { final container = ProviderContainer.test( overrides: [ family.overrideWith( - (StateProviderRef ref, int arg) => '42 $arg', + (Ref ref, int arg) => '42 $arg', ), autoDisposeFamily.overrideWith( - (StateProviderRef ref, int arg) => '84 $arg', + (Ref ref, int arg) => '84 $arg', ), ], ); @@ -113,70 +113,6 @@ void main() { expect(root.getAllProviderElements(), isEmpty); }); - group('ref.controller', () { - test('can read and change current value', () { - final container = ProviderContainer.test(); - final listener = Listener(); - late StateProviderRef ref; - final provider = StateProvider((r) { - ref = r; - return 0; - }); - - container.listen(provider, listener.call); - verifyZeroInteractions(listener); - - expect(ref.controller, container.read(provider.notifier)); - - ref.controller.state = 42; - - verifyOnly(listener, listener(0, 42)); - - expect(ref.controller.state, 42); - }); - - test('fails if trying to read the state before it was set', () { - final container = ProviderContainer.test(); - Object? err; - final provider = StateProvider((ref) { - try { - ref.controller; - } catch (e) { - err = e; - } - return 0; - }); - - container.read(provider); - expect(err, isStateError); - }); - - test('on rebuild, still fails if trying to read the state before was built', - () { - final dep = StateProvider((ref) => false); - final container = ProviderContainer.test(); - Object? err; - final provider = StateProvider((ref) { - if (ref.watch(dep)) { - try { - ref.controller; - } catch (e) { - err = e; - } - } - return 0; - }); - - container.read(provider); - expect(err, isNull); - - container.read(dep.notifier).state = true; - container.read(provider); - - expect(err, isStateError); - }); - }); - test('can refresh .notifier', () async { var initialValue = 1; final provider = StateProvider((ref) => initialValue); diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart index e8ad4dd0c..5cf44cb43 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart @@ -3,8 +3,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' - show $ProviderElement, ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElementBase; import 'package:test/test.dart'; import '../../utils.dart'; @@ -68,11 +67,10 @@ void main() { throwsUnimplementedError, ); - final element = - container.readProviderElement(provider) as $ProviderElement; + final element = container.readProviderElement(provider); expect( - () => element.state, + () => element.ref!.state, throwsUnimplementedError, ); }); @@ -172,7 +170,7 @@ void main() { verifyNoMoreInteractions(listener); }); - group('scoping an override overrides all the associated subproviders', () { + group('scoping an override overrides all the associated sub-providers', () { test('when passing the provider itself', () { final provider = Provider( (ref) => 0, diff --git a/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart index 74d86837b..7e12b7d7e 100644 --- a/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart @@ -66,50 +66,6 @@ void main() { expect(root.read(provider), 21); }); - test('supports auto-dispose', () async { - final provider = Provider.autoDispose((ref) => 0); - final container = ProviderContainer.test(); - - final sub = container.listen(provider, (_, __) {}); - final element = container.readProviderElement(provider); - - expect(element.mounted, true); - expect(sub.read(), 0); - - sub.close(); - await container.pump(); - - expect(element.mounted, false); - - container.dispose(); - - expect(element.mounted, false); - }); - - test('are disposed on nested containers', () { - final provider = Provider( - (ref) => 0, - dependencies: const [], - ); - final root = ProviderContainer.test( - overrides: [provider.overrideWithValue(1)], - ); - final container = ProviderContainer.test( - parent: root, - overrides: [ - provider.overrideWithValue(42), - ], - ); - - final element = container.readProviderElement(provider); - - expect(element.mounted, true); - - container.dispose(); - - expect(element.mounted, false); - }); - test('can be overridden on non-root container', () { final provider = Provider( (ref) => 0, diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index fcb1663b3..b713a0927 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -23,6 +23,7 @@ export 'package:riverpod/src/internals.dart' Ref, $ValueProvider, $ProviderOverride, + $RefArg, // Provider $Provider, diff --git a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart index a7288ea2a..7e6261e27 100644 --- a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart @@ -2,9 +2,8 @@ import 'package:meta/meta.dart'; import 'package:meta/meta_meta.dart'; -import 'package:riverpod/riverpod.dart'; -// ignore: implementation_imports, invalid_use_of_internal_member -import 'package:riverpod/src/internals.dart' show ProviderElementBase; + +import '../riverpod_annotation.dart'; /// {@template riverpod_annotation.provider} /// An annotation placed on classes or functions. @@ -198,8 +197,7 @@ class MissingScopeException implements Exception { @override String toString() { - // ignore: invalid_use_of_internal_member - final element = ref as ProviderElementBase; + final element = ref.$element; return 'MissingScopeException: The provider ${element.origin} is scoped, ' 'but was accessed in a place where it is not overridden. ' diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index a2b0601da..3f4e17a57 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -11,7 +11,7 @@ typedef CountRef = Ref; @ProviderFor(count) const myCountPod = CountProvider._(); -final class CountProvider extends $FunctionalProvider +final class CountProvider extends $FunctionalProvider with $Provider { const CountProvider._( {int Function( @@ -71,7 +71,7 @@ typedef CountFutureRef = Ref>; const myCountFuturePod = CountFutureProvider._(); final class CountFutureProvider - extends $FunctionalProvider, FutureOr, CountFutureRef> + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const CountFutureProvider._( {FutureOr Function( @@ -123,7 +123,7 @@ typedef CountStreamRef = Ref>; const myCountStreamPod = CountStreamProvider._(); final class CountStreamProvider - extends $FunctionalProvider, Stream, CountStreamRef> + extends $FunctionalProvider, Stream> with $FutureModifier, $StreamProvider { const CountStreamProvider._( {Stream Function( @@ -367,7 +367,7 @@ typedef Count2Ref = Ref; @ProviderFor(count2) const myFamilyCount2ProviderFamily = Count2Family._(); -final class Count2Provider extends $FunctionalProvider +final class Count2Provider extends $FunctionalProvider with $Provider { const Count2Provider._( {required Count2Family super.from, @@ -499,7 +499,7 @@ typedef CountFuture2Ref = Ref>; const myFamilyCountFuture2ProviderFamily = CountFuture2Family._(); final class CountFuture2Provider - extends $FunctionalProvider, FutureOr, CountFuture2Ref> + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const CountFuture2Provider._( {required CountFuture2Family super.from, @@ -623,7 +623,7 @@ typedef CountStream2Ref = Ref>; const myFamilyCountStream2ProviderFamily = CountStream2Family._(); final class CountStream2Provider - extends $FunctionalProvider, Stream, CountStream2Ref> + extends $FunctionalProvider, Stream> with $FutureModifier, $StreamProvider { const CountStream2Provider._( {required CountStream2Family super.from, @@ -887,7 +887,7 @@ final class CountNotifier2Family extends Family { } abstract class _$CountNotifier2 extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get a => _$args; int build( @@ -1041,8 +1041,7 @@ final class CountAsyncNotifier2Family extends Family { } abstract class _$CountAsyncNotifier2 extends $AsyncNotifier { - late final _$args = - (ref as $AsyncNotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get a => _$args; FutureOr build( @@ -1197,8 +1196,7 @@ final class CountStreamNotifier2Family extends Family { } abstract class _$CountStreamNotifier2 extends $StreamNotifier { - late final _$args = - (ref as $StreamNotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get a => _$args; Stream build( diff --git a/packages/riverpod_generator/lib/src/templates/notifier.dart b/packages/riverpod_generator/lib/src/templates/notifier.dart index f2e29b7a0..1ae7569c0 100644 --- a/packages/riverpod_generator/lib/src/templates/notifier.dart +++ b/packages/riverpod_generator/lib/src/templates/notifier.dart @@ -35,8 +35,8 @@ class NotifierTemplate extends Template { parameter: '_\$args.${parameter.name!.lexeme}', }); - final _$args = r'late final _$args = ' - '(ref as ${provider.elementName}).origin.argument${provider.argumentCast};'; + final _$args = 'late final _\$args = ref.\$arg${provider.argumentCast};'; + var paramOffset = 0; final parametersAsFields = provider.parameters.map( (p) { diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 2b32352cd..414c27f08 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -58,8 +58,7 @@ class ProviderTemplate extends Template { ${provider.doc} final class $name$_genericsDefinition extends \$FunctionalProvider< $exposedType, - $createdType, - $_refType + $createdType > $mixins { '''); diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index bb9bcc7ac..a18deb4ed 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -14,8 +14,7 @@ typedef FunctionalRef = Ref; @protected const functionalProvider = FunctionalFamily._(); -final class FunctionalProvider - extends $FunctionalProvider +final class FunctionalProvider extends $FunctionalProvider with $Provider { const FunctionalProvider._( {required FunctionalFamily super.from, @@ -289,7 +288,7 @@ final class ClassBasedFamily extends Family { } abstract class _$ClassBased extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; @Deprecated('field') int get id => _$args; @@ -311,8 +310,7 @@ typedef FamilyRef = Ref; @protected const familyProvider = FamilyFamily._(); -final class FamilyProvider - extends $FunctionalProvider +final class FamilyProvider extends $FunctionalProvider with $Provider { const FamilyProvider._( {required FamilyFamily super.from, @@ -444,7 +442,7 @@ typedef NotCopiedFunctionalRef = Ref; const notCopiedFunctionalProvider = NotCopiedFunctionalProvider._(); final class NotCopiedFunctionalProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const NotCopiedFunctionalProvider._( {String Function( @@ -574,8 +572,7 @@ typedef NotCopiedFamilyRef = Ref; @ProviderFor(notCopiedFamily) const notCopiedFamilyProvider = NotCopiedFamilyFamily._(); -final class NotCopiedFamilyProvider - extends $FunctionalProvider +final class NotCopiedFamilyProvider extends $FunctionalProvider with $Provider { const NotCopiedFamilyProvider._( {required NotCopiedFamilyFamily super.from, diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index c24b27ed3..ff01b8e4f 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -11,8 +11,8 @@ typedef GenericRef = Ref>>; @ProviderFor(generic) const genericProvider = GenericFamily._(); -final class GenericProvider extends $FunctionalProvider< - AsyncValue>, FutureOr>, GenericRef> +final class GenericProvider + extends $FunctionalProvider>, FutureOr>> with $FutureModifier>, $FutureProvider, GenericRef> { const GenericProvider._( {required GenericFamily super.from, @@ -273,7 +273,7 @@ typedef PublicRef = Ref>; const publicProvider = PublicProvider._(); final class PublicProvider - extends $FunctionalProvider, FutureOr, PublicRef> + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const PublicProvider._( {FutureOr Function( @@ -324,8 +324,8 @@ typedef _PrivateRef = Ref>; @ProviderFor(_private) const _privateProvider = _PrivateProvider._(); -final class _PrivateProvider extends $FunctionalProvider, - FutureOr, _PrivateRef> +final class _PrivateProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const _PrivateProvider._( {FutureOr Function( @@ -376,8 +376,8 @@ typedef FamilyOrRef = Ref>; @ProviderFor(familyOr) const familyOrProvider = FamilyOrFamily._(); -final class FamilyOrProvider extends $FunctionalProvider, - FutureOr, FamilyOrRef> +final class FamilyOrProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const FamilyOrProvider._( {required FamilyOrFamily super.from, @@ -501,7 +501,7 @@ typedef FamilyRef = Ref>; const familyProvider = FamilyFamily._(); final class FamilyProvider - extends $FunctionalProvider, FutureOr, FamilyRef> + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const FamilyProvider._( {required FamilyFamily super.from, @@ -938,8 +938,7 @@ final class FamilyOrClassFamily extends Family { } abstract class _$FamilyOrClass extends $AsyncNotifier { - late final _$args = - (ref as $AsyncNotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get first => _$args; FutureOr build( @@ -1147,8 +1146,7 @@ final class FamilyClassFamily extends Family { } abstract class _$FamilyClass extends $AsyncNotifier { - late final _$args = - (ref as $AsyncNotifierProviderElement).origin.argument as ( + late final _$args = ref.$arg as ( int, { String? second, double third, diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 392fa88e1..ef711fbca 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -11,8 +11,7 @@ typedef KeepAliveRef = Ref; @ProviderFor(keepAlive) const keepAliveProvider = KeepAliveProvider._(); -final class KeepAliveProvider - extends $FunctionalProvider +final class KeepAliveProvider extends $FunctionalProvider with $Provider { const KeepAliveProvider._( {int Function( @@ -71,8 +70,7 @@ typedef NotKeepAliveRef = Ref; @ProviderFor(notKeepAlive) const notKeepAliveProvider = NotKeepAliveProvider._(); -final class NotKeepAliveProvider - extends $FunctionalProvider +final class NotKeepAliveProvider extends $FunctionalProvider with $Provider { const NotKeepAliveProvider._( {int Function( @@ -131,8 +129,7 @@ typedef DefaultKeepAliveRef = Ref; @ProviderFor(defaultKeepAlive) const defaultKeepAliveProvider = DefaultKeepAliveProvider._(); -final class DefaultKeepAliveProvider - extends $FunctionalProvider +final class DefaultKeepAliveProvider extends $FunctionalProvider with $Provider { const DefaultKeepAliveProvider._( {int Function( @@ -191,8 +188,7 @@ typedef KeepAliveFamilyRef = Ref; @ProviderFor(keepAliveFamily) const keepAliveFamilyProvider = KeepAliveFamilyFamily._(); -final class KeepAliveFamilyProvider - extends $FunctionalProvider +final class KeepAliveFamilyProvider extends $FunctionalProvider with $Provider { const KeepAliveFamilyProvider._( {required KeepAliveFamilyFamily super.from, @@ -323,8 +319,7 @@ typedef NotKeepAliveFamilyRef = Ref; @ProviderFor(notKeepAliveFamily) const notKeepAliveFamilyProvider = NotKeepAliveFamilyFamily._(); -final class NotKeepAliveFamilyProvider - extends $FunctionalProvider +final class NotKeepAliveFamilyProvider extends $FunctionalProvider with $Provider { const NotKeepAliveFamilyProvider._( {required NotKeepAliveFamilyFamily super.from, @@ -456,8 +451,7 @@ typedef DefaultKeepAliveFamilyRef = Ref; @ProviderFor(defaultKeepAliveFamily) const defaultKeepAliveFamilyProvider = DefaultKeepAliveFamilyFamily._(); -final class DefaultKeepAliveFamilyProvider - extends $FunctionalProvider +final class DefaultKeepAliveFamilyProvider extends $FunctionalProvider with $Provider { const DefaultKeepAliveFamilyProvider._( {required DefaultKeepAliveFamilyFamily super.from, diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index b6376c128..07e91ae9d 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -11,7 +11,7 @@ typedef DepRef = Ref; @ProviderFor(dep) const depProvider = DepProvider._(); -final class DepProvider extends $FunctionalProvider +final class DepProvider extends $FunctionalProvider with $Provider { const DepProvider._( {int Function( @@ -70,7 +70,7 @@ typedef FamilyRef = Ref; @ProviderFor(family) const familyProvider = FamilyFamily._(); -final class FamilyProvider extends $FunctionalProvider +final class FamilyProvider extends $FunctionalProvider with $Provider { const FamilyProvider._( {required FamilyFamily super.from, @@ -409,7 +409,7 @@ final class Family2Family extends Family { } abstract class _$Family2 extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get id => _$args; int build( @@ -427,7 +427,7 @@ typedef ProviderRef = Ref; @ProviderFor(provider) const providerProvider = ProviderProvider._(); -final class ProviderProvider extends $FunctionalProvider +final class ProviderProvider extends $FunctionalProvider with $Provider { const ProviderProvider._( {int Function( @@ -501,8 +501,7 @@ typedef Provider2Ref = Ref; @ProviderFor(provider2) const provider2Provider = Provider2Provider._(); -final class Provider2Provider - extends $FunctionalProvider +final class Provider2Provider extends $FunctionalProvider with $Provider { const Provider2Provider._( {int Function( @@ -814,7 +813,7 @@ final class Provider4Family extends Family { } abstract class _$Provider4 extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get id => _$args; int build( @@ -832,8 +831,7 @@ typedef TransitiveDependenciesRef = Ref; @ProviderFor(transitiveDependencies) const transitiveDependenciesProvider = TransitiveDependenciesProvider._(); -final class TransitiveDependenciesProvider - extends $FunctionalProvider +final class TransitiveDependenciesProvider extends $FunctionalProvider with $Provider { const TransitiveDependenciesProvider._( {int Function( @@ -911,7 +909,7 @@ const smallTransitiveDependencyCountProvider = SmallTransitiveDependencyCountProvider._(); final class SmallTransitiveDependencyCountProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const SmallTransitiveDependencyCountProvider._( {int Function( @@ -985,7 +983,7 @@ const emptyDependenciesFunctionalProvider = EmptyDependenciesFunctionalProvider._(); final class EmptyDependenciesFunctionalProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const EmptyDependenciesFunctionalProvider._( {int Function( @@ -1120,7 +1118,7 @@ typedef ProviderWithDependenciesRef = Ref; const providerWithDependenciesProvider = ProviderWithDependenciesProvider._(); final class ProviderWithDependenciesProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const ProviderWithDependenciesProvider._( {int Function( @@ -1189,8 +1187,7 @@ typedef _PrivateDepRef = Ref; @ProviderFor(_privateDep) const _privateDepProvider = _PrivateDepProvider._(); -final class _PrivateDepProvider - extends $FunctionalProvider +final class _PrivateDepProvider extends $FunctionalProvider with $Provider { const _PrivateDepProvider._( {int Function( @@ -1249,8 +1246,7 @@ typedef PublicDepRef = Ref; @ProviderFor(publicDep) const publicDepProvider = PublicDepProvider._(); -final class PublicDepProvider - extends $FunctionalProvider +final class PublicDepProvider extends $FunctionalProvider with $Provider { const PublicDepProvider._( {int Function( @@ -1309,8 +1305,7 @@ typedef DuplicateDependenciesRef = Ref; @ProviderFor(duplicateDependencies) const duplicateDependenciesProvider = DuplicateDependenciesProvider._(); -final class DuplicateDependenciesProvider - extends $FunctionalProvider +final class DuplicateDependenciesProvider extends $FunctionalProvider with $Provider { const DuplicateDependenciesProvider._( {int Function( @@ -1376,8 +1371,7 @@ typedef DuplicateDependencies2Ref = Ref; @ProviderFor(duplicateDependencies2) const duplicateDependencies2Provider = DuplicateDependencies2Provider._(); -final class DuplicateDependencies2Provider - extends $FunctionalProvider +final class DuplicateDependencies2Provider extends $FunctionalProvider with $Provider { const DuplicateDependencies2Provider._( {int Function( @@ -1448,7 +1442,7 @@ const transitiveDuplicateDependenciesProvider = TransitiveDuplicateDependenciesProvider._(); final class TransitiveDuplicateDependenciesProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const TransitiveDuplicateDependenciesProvider._( {int Function( diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 153651785..c102e5359 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -12,7 +12,7 @@ typedef ProviderWithDependencies2Ref = Ref; const providerWithDependencies2Provider = ProviderWithDependencies2Provider._(); final class ProviderWithDependencies2Provider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const ProviderWithDependencies2Provider._( {int Function( @@ -91,7 +91,7 @@ typedef FamilyWithDependencies2Ref = Ref; const familyWithDependencies2Provider = FamilyWithDependencies2Family._(); final class FamilyWithDependencies2Provider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const FamilyWithDependencies2Provider._( {required FamilyWithDependencies2Family super.from, @@ -497,7 +497,7 @@ final class NotifierFamilyWithDependenciesFamily extends Family { } abstract class _$NotifierFamilyWithDependencies extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int?; + late final _$args = ref.$arg as int?; int? get id => _$args; int build({ @@ -515,8 +515,7 @@ typedef _Private2Ref = Ref; @ProviderFor(_private2) const _private2Provider = _Private2Provider._(); -final class _Private2Provider - extends $FunctionalProvider +final class _Private2Provider extends $FunctionalProvider with $Provider { const _Private2Provider._( {int Function( @@ -575,7 +574,7 @@ typedef Public2Ref = Ref; @ProviderFor(public2) const public2Provider = Public2Provider._(); -final class Public2Provider extends $FunctionalProvider +final class Public2Provider extends $FunctionalProvider with $Provider { const Public2Provider._( {int Function( diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index 0346f123d..38a0671e7 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -17,8 +17,7 @@ const functionalProvider = FunctionalProvider._(); /// Hello world // Foo -final class FunctionalProvider - extends $FunctionalProvider +final class FunctionalProvider extends $FunctionalProvider with $Provider { /// Hello world // Foo @@ -159,8 +158,7 @@ const familyProvider = FamilyFamily._(); /// Hello world // Foo -final class FamilyProvider - extends $FunctionalProvider +final class FamilyProvider extends $FunctionalProvider with $Provider { /// Hello world // Foo @@ -449,7 +447,7 @@ final class ClassFamilyBasedFamily extends Family { } abstract class _$ClassFamilyBased extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; /// Hello world // Foo diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 177bfb81a..02dd815e8 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -11,8 +11,7 @@ typedef GeneratedRef = Ref<_Test>; @ProviderFor(generated) const generatedProvider = GeneratedProvider._(); -final class GeneratedProvider - extends $FunctionalProvider<_Test, _Test, GeneratedRef> +final class GeneratedProvider extends $FunctionalProvider<_Test, _Test> with $Provider<_Test, GeneratedRef> { const GeneratedProvider._( {_Test Function( @@ -71,8 +70,7 @@ typedef GeneratedFamilyRef = Ref<_Test>; @ProviderFor(generatedFamily) const generatedFamilyProvider = GeneratedFamilyFamily._(); -final class GeneratedFamilyProvider - extends $FunctionalProvider<_Test, _Test, GeneratedFamilyRef> +final class GeneratedFamilyProvider extends $FunctionalProvider<_Test, _Test> with $Provider<_Test, GeneratedFamilyRef> { const GeneratedFamilyProvider._( {required GeneratedFamilyFamily super.from, @@ -416,8 +414,7 @@ final class GeneratedClassFamilyFamily extends Family { } abstract class _$GeneratedClassFamily extends $Notifier<_Test> { - late final _$args = - (ref as $NotifierProviderElement).origin.argument as _Test; + late final _$args = ref.$arg as _Test; _Test get test => _$args; _Test build( @@ -435,8 +432,7 @@ typedef $DynamicRef = Ref; @ProviderFor($dynamic) const $dynamicProvider = $DynamicProvider._(); -final class $DynamicProvider - extends $FunctionalProvider +final class $DynamicProvider extends $FunctionalProvider with $Provider { const $DynamicProvider._( {Object? Function( @@ -495,8 +491,7 @@ typedef $DynamicFamilyRef = Ref; @ProviderFor($dynamicFamily) const $dynamicFamilyProvider = $DynamicFamilyFamily._(); -final class $DynamicFamilyProvider - extends $FunctionalProvider +final class $DynamicFamilyProvider extends $FunctionalProvider with $Provider { const $DynamicFamilyProvider._( {required $DynamicFamilyFamily super.from, @@ -840,8 +835,7 @@ final class $DynamicClassFamilyFamily extends Family { } abstract class _$$DynamicClassFamily extends $Notifier { - late final _$args = - (ref as $NotifierProviderElement).origin.argument as dynamic; + late final _$args = ref.$arg as dynamic; dynamic get test => _$args; Object? build( @@ -859,8 +853,7 @@ typedef _DynamicRef = Ref; @ProviderFor(_dynamic) const _dynamicProvider = _DynamicFamily._(); -final class _DynamicProvider - extends $FunctionalProvider +final class _DynamicProvider extends $FunctionalProvider with $Provider { const _DynamicProvider._( {required _DynamicFamily super.from, @@ -992,7 +985,7 @@ typedef AliasRef = Ref>; const aliasProvider = AliasProvider._(); final class AliasProvider - extends $FunctionalProvider, r.AsyncValue, AliasRef> + extends $FunctionalProvider, r.AsyncValue> with $Provider, AliasRef> { const AliasProvider._( {r.AsyncValue Function( @@ -1052,10 +1045,9 @@ typedef AliasFamilyRef = Ref>; @ProviderFor(aliasFamily) const aliasFamilyProvider = AliasFamilyFamily._(); -final class AliasFamilyProvider extends $FunctionalProvider< - r.AsyncValue, - r.AsyncValue, - AliasFamilyRef> with $Provider, AliasFamilyRef> { +final class AliasFamilyProvider + extends $FunctionalProvider, r.AsyncValue> + with $Provider, AliasFamilyRef> { const AliasFamilyProvider._( {required AliasFamilyFamily super.from, required r.AsyncValue super.argument, @@ -1398,8 +1390,7 @@ final class AliasClassFamilyFamily extends Family { } abstract class _$AliasClassFamily extends $Notifier> { - late final _$args = - (ref as $NotifierProviderElement).origin.argument as r.AsyncValue; + late final _$args = ref.$arg as r.AsyncValue; r.AsyncValue get test => _$args; r.AsyncValue build( diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index bc284ab3f..28bbfd967 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -11,8 +11,7 @@ typedef SimpleRef = Ref; @ProviderFor(simple) const simpleProvider = SimpleProvider._(); -final class SimpleProvider - extends $FunctionalProvider +final class SimpleProvider extends $FunctionalProvider with $Provider { const SimpleProvider._( {String Function( @@ -71,8 +70,7 @@ typedef Simple2Ref = Ref; @ProviderFor(simple2) const simple2Provider = Simple2Provider._(); -final class Simple2Provider - extends $FunctionalProvider +final class Simple2Provider extends $FunctionalProvider with $Provider { const Simple2Provider._( {String Function( diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index f90b628a5..e8c77d3a1 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -220,7 +220,7 @@ final class ScopedClassFamilyFamily extends Family { } abstract class _$ScopedClassFamily extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get a => _$args; int build( diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index d1c0ec968..8d6340b09 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -11,7 +11,7 @@ typedef Counter2Ref = Ref; @ProviderFor(counter2) const counter2Provider = Counter2Provider._(); -final class Counter2Provider extends $FunctionalProvider +final class Counter2Provider extends $FunctionalProvider with $Provider { const Counter2Provider._( {int Function( @@ -70,7 +70,7 @@ typedef CounterRef = Ref; @ProviderFor(counter) const counterProvider = CounterProvider._(); -final class CounterProvider extends $FunctionalProvider +final class CounterProvider extends $FunctionalProvider with $Provider { const CounterProvider._( {int Function( diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 3ce1f648c..0c5cd4284 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -11,8 +11,8 @@ typedef GenericRef = Ref>>; @ProviderFor(generic) const genericProvider = GenericFamily._(); -final class GenericProvider extends $FunctionalProvider< - AsyncValue>, Stream>, GenericRef> +final class GenericProvider + extends $FunctionalProvider>, Stream>> with $FutureModifier>, $StreamProvider, GenericRef> { const GenericProvider._( {required GenericFamily super.from, @@ -273,7 +273,7 @@ typedef PublicRef = Ref>; const publicProvider = PublicProvider._(); final class PublicProvider - extends $FunctionalProvider, Stream, PublicRef> + extends $FunctionalProvider, Stream> with $FutureModifier, $StreamProvider { const PublicProvider._( {Stream Function( @@ -325,7 +325,7 @@ typedef _PrivateRef = Ref>; const _privateProvider = _PrivateProvider._(); final class _PrivateProvider - extends $FunctionalProvider, Stream, _PrivateRef> + extends $FunctionalProvider, Stream> with $FutureModifier, $StreamProvider { const _PrivateProvider._( {Stream Function( @@ -377,7 +377,7 @@ typedef FamilyRef = Ref>; const familyProvider = FamilyFamily._(); final class FamilyProvider - extends $FunctionalProvider, Stream, FamilyRef> + extends $FunctionalProvider, Stream> with $FutureModifier, $StreamProvider { const FamilyProvider._( {required FamilyFamily super.from, @@ -869,8 +869,7 @@ final class FamilyClassFamily extends Family { } abstract class _$FamilyClass extends $StreamNotifier { - late final _$args = - (ref as $StreamNotifierProviderElement).origin.argument as ( + late final _$args = ref.$arg as ( int, { String? second, double third, diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 053988217..d5c8b1286 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -12,7 +12,7 @@ typedef GenericRef = Ref>; const genericProvider = GenericFamily._(); final class GenericProvider - extends $FunctionalProvider, List, GenericRef> + extends $FunctionalProvider, List> with $Provider, GenericRef> { const GenericProvider._( {required GenericFamily super.from, @@ -132,7 +132,7 @@ typedef ComplexGenericRef = Ref>; const complexGenericProvider = ComplexGenericFamily._(); final class ComplexGenericProvider - extends $FunctionalProvider, List, ComplexGenericRef> + extends $FunctionalProvider, List> with $Provider, ComplexGenericRef> { const ComplexGenericProvider._( {required ComplexGenericFamily super.from, @@ -463,10 +463,9 @@ typedef RawFutureRef = Ref>>; @ProviderFor(rawFuture) const rawFutureProvider = RawFutureProvider._(); -final class RawFutureProvider extends $FunctionalProvider< - Raw>, - Raw>, - RawFutureRef> with $Provider>, RawFutureRef> { +final class RawFutureProvider + extends $FunctionalProvider>, Raw>> + with $Provider>, RawFutureRef> { const RawFutureProvider._( {Raw> Function( RawFutureRef ref, @@ -525,10 +524,9 @@ typedef RawStreamRef = Ref>>; @ProviderFor(rawStream) const rawStreamProvider = RawStreamProvider._(); -final class RawStreamProvider extends $FunctionalProvider< - Raw>, - Raw>, - RawStreamRef> with $Provider>, RawStreamRef> { +final class RawStreamProvider + extends $FunctionalProvider>, Raw>> + with $Provider>, RawStreamRef> { const RawStreamProvider._( {Raw> Function( RawStreamRef ref, @@ -725,8 +723,8 @@ typedef RawFamilyFutureRef = Ref>>; @ProviderFor(rawFamilyFuture) const rawFamilyFutureProvider = RawFamilyFutureFamily._(); -final class RawFamilyFutureProvider extends $FunctionalProvider< - Raw>, Raw>, RawFamilyFutureRef> +final class RawFamilyFutureProvider + extends $FunctionalProvider>, Raw>> with $Provider>, RawFamilyFutureRef> { const RawFamilyFutureProvider._( {required RawFamilyFutureFamily super.from, @@ -858,8 +856,8 @@ typedef RawFamilyStreamRef = Ref>>; @ProviderFor(rawFamilyStream) const rawFamilyStreamProvider = RawFamilyStreamFamily._(); -final class RawFamilyStreamProvider extends $FunctionalProvider< - Raw>, Raw>, RawFamilyStreamRef> +final class RawFamilyStreamProvider + extends $FunctionalProvider>, Raw>> with $Provider>, RawFamilyStreamRef> { const RawFamilyStreamProvider._( {required RawFamilyStreamFamily super.from, @@ -1135,7 +1133,7 @@ final class RawFamilyFutureClassFamily extends Family { } abstract class _$RawFamilyFutureClass extends $Notifier>> { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get id => _$args; Raw> build( @@ -1297,7 +1295,7 @@ final class RawFamilyStreamClassFamily extends Family { } abstract class _$RawFamilyStreamClass extends $Notifier>> { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get id => _$args; Raw> build( @@ -1318,8 +1316,7 @@ typedef PublicRef = Ref; const publicProvider = PublicProvider._(); /// This is some documentation -final class PublicProvider - extends $FunctionalProvider +final class PublicProvider extends $FunctionalProvider with $Provider { /// This is some documentation const PublicProvider._( @@ -1379,8 +1376,7 @@ typedef Supports$inNamesRef = Ref; @ProviderFor(supports$inNames) const supports$inNamesProvider = Supports$inNamesProvider._(); -final class Supports$inNamesProvider - extends $FunctionalProvider +final class Supports$inNamesProvider extends $FunctionalProvider with $Provider { const Supports$inNamesProvider._( {String Function( @@ -1442,8 +1438,7 @@ typedef FamilyRef = Ref; const familyProvider = FamilyFamily._(); /// This is some documentation -final class FamilyProvider - extends $FunctionalProvider +final class FamilyProvider extends $FunctionalProvider with $Provider { /// This is some documentation const FamilyProvider._( @@ -1634,8 +1629,7 @@ typedef _PrivateRef = Ref; @ProviderFor(_private) const _privateProvider = _PrivateProvider._(); -final class _PrivateProvider - extends $FunctionalProvider +final class _PrivateProvider extends $FunctionalProvider with $Provider { const _PrivateProvider._( {String Function( @@ -2036,7 +2030,7 @@ final class FamilyClassFamily extends Family { } abstract class _$FamilyClass extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as ( + late final _$args = ref.$arg as ( int, { String? second, double third, @@ -2073,7 +2067,7 @@ typedef Supports$InFnNameRef = Ref; const supports$InFnNameProvider = Supports$InFnNameFamily._(); final class Supports$InFnNameProvider - extends $FunctionalProvider> + extends $FunctionalProvider with $Provider> { const Supports$InFnNameProvider._( {required Supports$InFnNameFamily super.from, @@ -2195,8 +2189,7 @@ typedef Supports$InFnNameFamilyRef = Ref; const supports$InFnNameFamilyProvider = Supports$InFnNameFamilyFamily._(); final class Supports$InFnNameFamilyProvider - extends $FunctionalProvider> + extends $FunctionalProvider with $Provider> { const Supports$InFnNameFamilyProvider._( {required Supports$InFnNameFamilyFamily super.from, @@ -2760,7 +2753,7 @@ final class Supports$InClassFamilyNameFamily extends Family { } abstract class _$Supports$InClassFamilyName extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as ( + late final _$args = ref.$arg as ( And$InT, { And$InT named$arg, String defaultArg, @@ -2788,8 +2781,7 @@ typedef GeneratedRef = Ref; @ProviderFor(generated) const generatedProvider = GeneratedProvider._(); -final class GeneratedProvider - extends $FunctionalProvider +final class GeneratedProvider extends $FunctionalProvider with $Provider { const GeneratedProvider._( {String Function( @@ -2848,8 +2840,7 @@ typedef UnnecessaryCastRef = Ref; @ProviderFor(unnecessaryCast) const unnecessaryCastProvider = UnnecessaryCastFamily._(); -final class UnnecessaryCastProvider - extends $FunctionalProvider +final class UnnecessaryCastProvider extends $FunctionalProvider with $Provider { const UnnecessaryCastProvider._( {required UnnecessaryCastFamily super.from, @@ -3124,7 +3115,7 @@ final class UnnecessaryCastClassFamily extends Family { } abstract class _$UnnecessaryCastClass extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument; + late final _$args = ref.$arg; Object? get arg => _$args; String build( @@ -3144,8 +3135,7 @@ typedef ManyDataStreamRef const manyDataStreamProvider = ManyDataStreamFamily._(); final class ManyDataStreamProvider - extends $FunctionalProvider>, Stream>, - ManyDataStreamRef> + extends $FunctionalProvider>, Stream>> with $FutureModifier>, $StreamProvider, ManyDataStreamRef> { diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 1da2ab698..e41fd73d7 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -14,8 +14,7 @@ typedef PublicRef = Ref; const publicProvider = PublicProvider._(); /// A public generated provider. -final class PublicProvider - extends $FunctionalProvider +final class PublicProvider extends $FunctionalProvider with $Provider { /// A public generated provider. const PublicProvider._( @@ -78,8 +77,7 @@ typedef Supports$inNamesRef = Ref; const supports$inNamesProvider = Supports$inNamesProvider._(); /// A generated provider with a '$' in its name. -final class Supports$inNamesProvider - extends $FunctionalProvider +final class Supports$inNamesProvider extends $FunctionalProvider with $Provider { /// A generated provider with a '$' in its name. const Supports$inNamesProvider._( @@ -142,8 +140,7 @@ typedef FamilyRef = Ref; const familyProvider = FamilyFamily._(); /// A generated family provider. -final class FamilyProvider - extends $FunctionalProvider +final class FamilyProvider extends $FunctionalProvider with $Provider { /// A generated family provider. const FamilyProvider._( @@ -334,8 +331,7 @@ typedef _PrivateRef = Ref; @ProviderFor(_private) const _privateProvider = _PrivateProvider._(); -final class _PrivateProvider - extends $FunctionalProvider +final class _PrivateProvider extends $FunctionalProvider with $Provider { const _PrivateProvider._( {String Function( @@ -736,7 +732,7 @@ final class FamilyClassFamily extends Family { } abstract class _$FamilyClass extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as ( + late final _$args = ref.$arg as ( int, { String? second, double third, diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index 96d6fabc7..87ea2f25b 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -258,7 +258,7 @@ final class ExampleFamilyFamily extends Family { } abstract class _$ExampleFamily extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as ({ + late final _$args = ref.$arg as ({ int a, String b, }); diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index 2b163b937..c7f65123d 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -14,7 +14,7 @@ typedef ExampleRef = Ref; const exampleProvider = ExampleProvider._(); /// Some comment -final class ExampleProvider extends $FunctionalProvider +final class ExampleProvider extends $FunctionalProvider with $Provider { /// Some comment const ExampleProvider._( @@ -77,8 +77,7 @@ typedef ExampleFamilyRef = Ref; const exampleFamilyProvider = ExampleFamilyFamily._(); /// Some comment -final class ExampleFamilyProvider - extends $FunctionalProvider +final class ExampleFamilyProvider extends $FunctionalProvider with $Provider { /// Some comment const ExampleFamilyProvider._( diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 48ff7cec1..155715e30 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -11,7 +11,7 @@ typedef FnRef = Ref; @ProviderFor(fn) const fnProvider = FnFamily._(); -final class FnProvider extends $FunctionalProvider +final class FnProvider extends $FunctionalProvider with $Provider { const FnProvider._( {required FnFamily super.from, @@ -336,7 +336,7 @@ final class MyNotifierFamily extends Family { } abstract class _$MyNotifier extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as ( + late final _$args = ref.$arg as ( BuildContext, { BuildContext context2, }); diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index b26308786..6fb430fa5 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -152,7 +152,7 @@ final class GeneratedNotifierFamily extends Family { } abstract class _$GeneratedNotifier extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get param => _$args; int build( diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 43fc19232..54d167633 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -11,7 +11,7 @@ typedef NamelessRef = Ref; @ProviderFor(nameless) const namelessProvider = NamelessProvider._(); -final class NamelessProvider extends $FunctionalProvider +final class NamelessProvider extends $FunctionalProvider with $Provider { const NamelessProvider._( {int Function( @@ -71,7 +71,7 @@ typedef GenericsRef = Ref; const genericsProvider = GenericsFamily._(); final class GenericsProvider - extends $FunctionalProvider> + extends $FunctionalProvider with $Provider> { const GenericsProvider._( {required GenericsFamily super.from, @@ -193,7 +193,7 @@ typedef NoGenericsRef = Ref; const noGenericsProvider = NoGenericsFamily._(); final class NoGenericsProvider - extends $FunctionalProvider> + extends $FunctionalProvider with $Provider> { const NoGenericsProvider._( {required NoGenericsFamily super.from, @@ -314,8 +314,7 @@ typedef MissingGenericsRef = Ref; @ProviderFor(missingGenerics) const missingGenericsProvider = MissingGenericsFamily._(); -final class MissingGenericsProvider - extends $FunctionalProvider> +final class MissingGenericsProvider extends $FunctionalProvider with $Provider> { const MissingGenericsProvider._( {required MissingGenericsFamily super.from, @@ -436,8 +435,7 @@ typedef WrongOrderRef = Ref; @ProviderFor(wrongOrder) const wrongOrderProvider = WrongOrderFamily._(); -final class WrongOrderProvider - extends $FunctionalProvider> +final class WrongOrderProvider extends $FunctionalProvider with $Provider> { const WrongOrderProvider._( {required WrongOrderFamily super.from, diff --git a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart index af601469d..2c7c5ba80 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart @@ -11,8 +11,7 @@ typedef KeepAliveRef = Ref; @ProviderFor(keepAlive) const keepAliveProvider = KeepAliveProvider._(); -final class KeepAliveProvider - extends $FunctionalProvider +final class KeepAliveProvider extends $FunctionalProvider with $Provider { const KeepAliveProvider._( {int Function( @@ -140,8 +139,7 @@ typedef AutoDisposeRef = Ref; @ProviderFor(autoDispose) const autoDisposeProvider = AutoDisposeProvider._(); -final class AutoDisposeProvider - extends $FunctionalProvider +final class AutoDisposeProvider extends $FunctionalProvider with $Provider { const AutoDisposeProvider._( {int Function( @@ -269,7 +267,7 @@ typedef FnRef = Ref; @ProviderFor(fn) const fnProvider = FnProvider._(); -final class FnProvider extends $FunctionalProvider +final class FnProvider extends $FunctionalProvider with $Provider { const FnProvider._( {int Function( diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index a7253af92..a4b79dace 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -283,7 +283,7 @@ final class A3Family extends Family { } abstract class _$A3 extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get param => _$args; int build( @@ -439,7 +439,7 @@ final class A4Family extends Family { } abstract class _$A4 extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get param => _$args; int build( @@ -588,8 +588,7 @@ final class A5Family extends Family { } abstract class _$A5 extends $AsyncNotifier { - late final _$args = - (ref as $AsyncNotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get param => _$args; FutureOr build( @@ -738,8 +737,7 @@ final class A6Family extends Family { } abstract class _$A6 extends $AsyncNotifier { - late final _$args = - (ref as $AsyncNotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get param => _$args; FutureOr build( @@ -888,8 +886,7 @@ final class A7Family extends Family { } abstract class _$A7 extends $StreamNotifier { - late final _$args = - (ref as $StreamNotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get param => _$args; Stream build( @@ -1038,8 +1035,7 @@ final class A8Family extends Family { } abstract class _$A8 extends $StreamNotifier { - late final _$args = - (ref as $StreamNotifierProviderElement).origin.argument as int; + late final _$args = ref.$arg as int; int get param => _$args; Stream build( diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart index bb52cf4b9..a51582bb3 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart @@ -11,7 +11,7 @@ typedef BRef = Ref; @ProviderFor(b) const bProvider = BProvider._(); -final class BProvider extends $FunctionalProvider +final class BProvider extends $FunctionalProvider with $Provider { const BProvider._( {int Function( @@ -70,8 +70,7 @@ typedef AnotherScopedRef = Ref; @ProviderFor(anotherScoped) const anotherScopedProvider = AnotherScopedProvider._(); -final class AnotherScopedProvider - extends $FunctionalProvider +final class AnotherScopedProvider extends $FunctionalProvider with $Provider { const AnotherScopedProvider._( {int Function( @@ -130,8 +129,7 @@ typedef AnotherNonEmptyScopedRef = Ref; @ProviderFor(anotherNonEmptyScoped) const anotherNonEmptyScopedProvider = AnotherNonEmptyScopedProvider._(); -final class AnotherNonEmptyScopedProvider - extends $FunctionalProvider +final class AnotherNonEmptyScopedProvider extends $FunctionalProvider with $Provider { const AnotherNonEmptyScopedProvider._( {int Function( diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart index a259c73d7..ada784e5f 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart @@ -11,7 +11,7 @@ typedef DepRef = Ref; @ProviderFor(dep) const depProvider = DepProvider._(); -final class DepProvider extends $FunctionalProvider +final class DepProvider extends $FunctionalProvider with $Provider { const DepProvider._( {int Function( @@ -70,8 +70,7 @@ typedef TransitiveDepRef = Ref; @ProviderFor(transitiveDep) const transitiveDepProvider = TransitiveDepProvider._(); -final class TransitiveDepProvider - extends $FunctionalProvider +final class TransitiveDepProvider extends $FunctionalProvider with $Provider { const TransitiveDepProvider._( {int Function( @@ -134,7 +133,7 @@ typedef Dep2Ref = Ref; @ProviderFor(dep2) const dep2Provider = Dep2Provider._(); -final class Dep2Provider extends $FunctionalProvider +final class Dep2Provider extends $FunctionalProvider with $Provider { const Dep2Provider._( {int Function( @@ -193,8 +192,7 @@ typedef DepFamilyRef = Ref; @ProviderFor(depFamily) const depFamilyProvider = DepFamilyFamily._(); -final class DepFamilyProvider - extends $FunctionalProvider +final class DepFamilyProvider extends $FunctionalProvider with $Provider { const DepFamilyProvider._( {required DepFamilyFamily super.from, @@ -331,8 +329,7 @@ const plainAnnotationProvider = PlainAnnotationProvider._(); //////////// // expect_lint: provider_dependencies -final class PlainAnnotationProvider - extends $FunctionalProvider +final class PlainAnnotationProvider extends $FunctionalProvider with $Provider { //////////// // expect_lint: provider_dependencies @@ -393,8 +390,7 @@ typedef CustomAnnotationRef = Ref; @ProviderFor(customAnnotation) const customAnnotationProvider = CustomAnnotationProvider._(); -final class CustomAnnotationProvider - extends $FunctionalProvider +final class CustomAnnotationProvider extends $FunctionalProvider with $Provider { const CustomAnnotationProvider._( {int Function( @@ -455,7 +451,7 @@ const customAnnotationWithTrailingCommaProvider = CustomAnnotationWithTrailingCommaProvider._(); final class CustomAnnotationWithTrailingCommaProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const CustomAnnotationWithTrailingCommaProvider._( {int Function( @@ -516,8 +512,7 @@ typedef ExistingDepRef = Ref; @ProviderFor(existingDep) const existingDepProvider = ExistingDepProvider._(); -final class ExistingDepProvider - extends $FunctionalProvider +final class ExistingDepProvider extends $FunctionalProvider with $Provider { const ExistingDepProvider._( {int Function( @@ -576,8 +571,7 @@ typedef MultipleDepsRef = Ref; @ProviderFor(multipleDeps) const multipleDepsProvider = MultipleDepsProvider._(); -final class MultipleDepsProvider - extends $FunctionalProvider +final class MultipleDepsProvider extends $FunctionalProvider with $Provider { const MultipleDepsProvider._( {int Function( @@ -642,8 +636,7 @@ const providerWithDartDocProvider = ProviderWithDartDocProvider._(); /// Random doc to test that identifiers in docs don't trigger the lint. /// [dep], [DepWidget], [depProvider] -final class ProviderWithDartDocProvider - extends $FunctionalProvider +final class ProviderWithDartDocProvider extends $FunctionalProvider with $Provider { /// Random doc to test that identifiers in docs don't trigger the lint. /// [dep], [DepWidget], [depProvider] diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart index 4a9fd8400..8be01020e 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart @@ -11,7 +11,7 @@ typedef DepRef = Ref; @ProviderFor(dep) const depProvider = DepProvider._(); -final class DepProvider extends $FunctionalProvider +final class DepProvider extends $FunctionalProvider with $Provider { const DepProvider._( {int Function( @@ -70,8 +70,7 @@ typedef GeneratedScopedRef = Ref; @ProviderFor(generatedScoped) const generatedScopedProvider = GeneratedScopedProvider._(); -final class GeneratedScopedProvider - extends $FunctionalProvider +final class GeneratedScopedProvider extends $FunctionalProvider with $Provider { const GeneratedScopedProvider._( {int Function( @@ -130,8 +129,7 @@ typedef GeneratedRootRef = Ref; @ProviderFor(generatedRoot) const generatedRootProvider = GeneratedRootProvider._(); -final class GeneratedRootProvider - extends $FunctionalProvider +final class GeneratedRootProvider extends $FunctionalProvider with $Provider { const GeneratedRootProvider._( {int Function( @@ -192,7 +190,7 @@ const watchScopedButNoDependenciesProvider = WatchScopedButNoDependenciesProvider._(); final class WatchScopedButNoDependenciesProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const WatchScopedButNoDependenciesProvider._( {int Function( @@ -254,8 +252,7 @@ const watchGeneratedScopedButNoDependenciesProvider = WatchGeneratedScopedButNoDependenciesProvider._(); final class WatchGeneratedScopedButNoDependenciesProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const WatchGeneratedScopedButNoDependenciesProvider._( {int Function( @@ -318,7 +315,7 @@ const watchRootButNoDependenciesProvider = WatchRootButNoDependenciesProvider._(); final class WatchRootButNoDependenciesProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const WatchRootButNoDependenciesProvider._( {int Function( @@ -380,8 +377,7 @@ const watchGeneratedRootButNoDependenciesProvider = WatchGeneratedRootButNoDependenciesProvider._(); final class WatchGeneratedRootButNoDependenciesProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const WatchGeneratedRootButNoDependenciesProvider._( {int Function( @@ -444,7 +440,7 @@ const watchScopedButEmptyDependenciesProvider = WatchScopedButEmptyDependenciesProvider._(); final class WatchScopedButEmptyDependenciesProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const WatchScopedButEmptyDependenciesProvider._( {int Function( @@ -506,8 +502,7 @@ const watchGeneratedScopedButEmptyDependenciesProvider = WatchGeneratedScopedButEmptyDependenciesProvider._(); final class WatchGeneratedScopedButEmptyDependenciesProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const WatchGeneratedScopedButEmptyDependenciesProvider._( {int Function( @@ -570,7 +565,7 @@ const watchRootButEmptyDependenciesProvider = WatchRootButEmptyDependenciesProvider._(); final class WatchRootButEmptyDependenciesProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const WatchRootButEmptyDependenciesProvider._( {int Function( @@ -632,8 +627,7 @@ const watchGeneratedRootButEmptyDependenciesProvider = WatchGeneratedRootButEmptyDependenciesProvider._(); final class WatchGeneratedRootButEmptyDependenciesProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const WatchGeneratedRootButEmptyDependenciesProvider._( {int Function( @@ -696,8 +690,7 @@ const watchGeneratedScopedAndContainsDependencyProvider = WatchGeneratedScopedAndContainsDependencyProvider._(); final class WatchGeneratedScopedAndContainsDependencyProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const WatchGeneratedScopedAndContainsDependencyProvider._( {int Function( @@ -841,8 +834,7 @@ typedef Regression2348Ref = Ref; @ProviderFor(regression2348) const regression2348Provider = Regression2348Provider._(); -final class Regression2348Provider - extends $FunctionalProvider +final class Regression2348Provider extends $FunctionalProvider with $Provider { const Regression2348Provider._( {int Function( @@ -978,8 +970,7 @@ typedef FamilyDepRef = Ref; @ProviderFor(familyDep) const familyDepProvider = FamilyDepFamily._(); -final class FamilyDepProvider - extends $FunctionalProvider +final class FamilyDepProvider extends $FunctionalProvider with $Provider { const FamilyDepProvider._( {required FamilyDepFamily super.from, @@ -1114,8 +1105,7 @@ typedef FamilyDep2Ref = Ref; @ProviderFor(familyDep2) const familyDep2Provider = FamilyDep2Family._(); -final class FamilyDep2Provider - extends $FunctionalProvider +final class FamilyDep2Provider extends $FunctionalProvider with $Provider { const FamilyDep2Provider._( {required FamilyDep2Family super.from, @@ -1253,7 +1243,7 @@ typedef AliasRef = Ref; @ProviderFor(alias) const aliasProvider = AliasProvider._(); -final class AliasProvider extends $FunctionalProvider +final class AliasProvider extends $FunctionalProvider with $Provider { const AliasProvider._( {int Function( @@ -1454,7 +1444,7 @@ typedef FooRef = Ref; @ProviderFor(foo) const fooProvider = FooProvider._(); -final class FooProvider extends $FunctionalProvider +final class FooProvider extends $FunctionalProvider with $Provider { const FooProvider._( {int Function( @@ -1513,8 +1503,7 @@ typedef CrossFileDependencyRef = Ref; @ProviderFor(crossFileDependency) const crossFileDependencyProvider = CrossFileDependencyProvider._(); -final class CrossFileDependencyProvider - extends $FunctionalProvider +final class CrossFileDependencyProvider extends $FunctionalProvider with $Provider { const CrossFileDependencyProvider._( {int Function( diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart index b93931040..76c293ef8 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart @@ -11,7 +11,7 @@ typedef RootRef = Ref; @ProviderFor(root) const rootProvider = RootProvider._(); -final class RootProvider extends $FunctionalProvider +final class RootProvider extends $FunctionalProvider with $Provider { const RootProvider._( {int Function( @@ -70,7 +70,7 @@ typedef DepRef = Ref; @ProviderFor(dep) const depProvider = DepProvider._(); -final class DepProvider extends $FunctionalProvider +final class DepProvider extends $FunctionalProvider with $Provider { const DepProvider._( {int Function( @@ -129,7 +129,7 @@ typedef Dep2Ref = Ref; @ProviderFor(dep2) const dep2Provider = Dep2Provider._(); -final class Dep2Provider extends $FunctionalProvider +final class Dep2Provider extends $FunctionalProvider with $Provider { const Dep2Provider._( {int Function( @@ -191,7 +191,7 @@ typedef ExtraDepRef = Ref; const extraDepProvider = ExtraDepProvider._(); //////////// -final class ExtraDepProvider extends $FunctionalProvider +final class ExtraDepProvider extends $FunctionalProvider with $Provider { //////////// const ExtraDepProvider._( @@ -257,7 +257,7 @@ typedef NoDepRef = Ref; @ProviderFor(noDep) const noDepProvider = NoDepProvider._(); -final class NoDepProvider extends $FunctionalProvider +final class NoDepProvider extends $FunctionalProvider with $Provider { const NoDepProvider._( {int Function( @@ -322,7 +322,7 @@ const dependenciesFirstThenKeepAliveProvider = DependenciesFirstThenKeepAliveProvider._(); final class DependenciesFirstThenKeepAliveProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const DependenciesFirstThenKeepAliveProvider._( {int Function( @@ -386,8 +386,7 @@ typedef NoDepNoParamRef = Ref; @ProviderFor(noDepNoParam) const noDepNoParamProvider = NoDepNoParamProvider._(); -final class NoDepNoParamProvider - extends $FunctionalProvider +final class NoDepNoParamProvider extends $FunctionalProvider with $Provider { const NoDepNoParamProvider._( {int Function( @@ -450,8 +449,7 @@ typedef NoDepWithoutCommaRef = Ref; @ProviderFor(noDepWithoutComma) const noDepWithoutCommaProvider = NoDepWithoutCommaProvider._(); -final class NoDepWithoutCommaProvider - extends $FunctionalProvider +final class NoDepWithoutCommaProvider extends $FunctionalProvider with $Provider { const NoDepWithoutCommaProvider._( {int Function( @@ -514,7 +512,7 @@ typedef RootDepRef = Ref; @ProviderFor(rootDep) const rootDepProvider = RootDepProvider._(); -final class RootDepProvider extends $FunctionalProvider +final class RootDepProvider extends $FunctionalProvider with $Provider { const RootDepProvider._( {int Function( diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 79e79c45a..09f56f89b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -11,8 +11,7 @@ typedef GeneratorRef = Ref; @ProviderFor(generator) const generatorProvider = GeneratorFamily._(); -final class GeneratorProvider - extends $FunctionalProvider +final class GeneratorProvider extends $FunctionalProvider with $Provider { const GeneratorProvider._( {required GeneratorFamily super.from, diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart index b21da5555..cac255ada 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart @@ -81,7 +81,7 @@ typedef ScopedRef = Ref; @ProviderFor(scoped) const scopedProvider = ScopedProvider._(); -final class ScopedProvider extends $FunctionalProvider +final class ScopedProvider extends $FunctionalProvider with $Provider { const ScopedProvider._( {int Function( @@ -140,7 +140,7 @@ typedef RootRef = Ref; @ProviderFor(root) const rootProvider = RootProvider._(); -final class RootProvider extends $FunctionalProvider +final class RootProvider extends $FunctionalProvider with $Provider { const RootProvider._( {int Function( diff --git a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart index d193d9c6b..05e7e9945 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart @@ -11,7 +11,7 @@ typedef ScopedRef = Ref; @ProviderFor(scoped) const scopedProvider = ScopedProvider._(); -final class ScopedProvider extends $FunctionalProvider +final class ScopedProvider extends $FunctionalProvider with $Provider { const ScopedProvider._( {int Function( @@ -70,7 +70,7 @@ typedef RootRef = Ref; @ProviderFor(root) const rootProvider = RootProvider._(); -final class RootProvider extends $FunctionalProvider +final class RootProvider extends $FunctionalProvider with $Provider { const RootProvider._( {int Function( diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart index 4dccde6ea..3abdda32e 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart @@ -11,7 +11,7 @@ typedef IntegerRef = Ref; @ProviderFor(integer) const integerProvider = IntegerProvider._(); -final class IntegerProvider extends $FunctionalProvider +final class IntegerProvider extends $FunctionalProvider with $Provider { const IntegerProvider._( {int Function( @@ -70,10 +70,9 @@ typedef StateNotifierRef = Ref; @ProviderFor(stateNotifier) const stateNotifierProvider = StateNotifierProvider._(); -final class StateNotifierProvider extends $FunctionalProvider< - MyStateNotifier, - MyStateNotifier, - StateNotifierRef> with $Provider { +final class StateNotifierProvider + extends $FunctionalProvider + with $Provider { const StateNotifierProvider._( {MyStateNotifier Function( StateNotifierRef ref, @@ -133,9 +132,7 @@ typedef AsyncStateNotifierRef = Ref>; const asyncStateNotifierProvider = AsyncStateNotifierProvider._(); final class AsyncStateNotifierProvider extends $FunctionalProvider< - AsyncValue, - FutureOr, - AsyncStateNotifierRef> + AsyncValue, FutureOr> with $FutureModifier, $FutureProvider { @@ -261,9 +258,7 @@ typedef StateNotifierAsyncRef = Ref>; const stateNotifierAsyncProvider = StateNotifierAsyncProvider._(); final class StateNotifierAsyncProvider extends $FunctionalProvider< - AsyncValue, - FutureOr, - StateNotifierAsyncRef> + AsyncValue, FutureOr> with $FutureModifier, $FutureProvider { @@ -576,10 +571,9 @@ typedef ChangeNotifierRef = Ref; @ProviderFor(changeNotifier) const changeNotifierProvider = ChangeNotifierProvider._(); -final class ChangeNotifierProvider extends $FunctionalProvider< - MyChangeNotifier, - MyChangeNotifier, - ChangeNotifierRef> with $Provider { +final class ChangeNotifierProvider + extends $FunctionalProvider + with $Provider { const ChangeNotifierProvider._( {MyChangeNotifier Function( ChangeNotifierRef ref, @@ -708,8 +702,7 @@ typedef NotifierRef = Ref; @ProviderFor(notifier) const notifierProvider = NotifierProvider._(); -final class NotifierProvider - extends $FunctionalProvider +final class NotifierProvider extends $FunctionalProvider with $Provider { const NotifierProvider._( {MyNotifier Function( @@ -768,8 +761,8 @@ typedef AutoDisposeNotifierRef = Ref; @ProviderFor(autoDisposeNotifier) const autoDisposeNotifierProvider = AutoDisposeNotifierProvider._(); -final class AutoDisposeNotifierProvider extends $FunctionalProvider< - MyAutoDisposeNotifier, MyAutoDisposeNotifier, AutoDisposeNotifierRef> +final class AutoDisposeNotifierProvider + extends $FunctionalProvider with $Provider { const AutoDisposeNotifierProvider._( {MyAutoDisposeNotifier Function( @@ -899,10 +892,9 @@ typedef AsyncNotifierRef = Ref; @ProviderFor(asyncNotifier) const asyncNotifierProvider = AsyncNotifierProvider._(); -final class AsyncNotifierProvider extends $FunctionalProvider< - MyAsyncNotifier, - MyAsyncNotifier, - AsyncNotifierRef> with $Provider { +final class AsyncNotifierProvider + extends $FunctionalProvider + with $Provider { const AsyncNotifierProvider._( {MyAsyncNotifier Function( AsyncNotifierRef ref, @@ -1031,10 +1023,9 @@ typedef RawNotifierRef = Ref>; @ProviderFor(rawNotifier) const rawNotifierProvider = RawNotifierProvider._(); -final class RawNotifierProvider extends $FunctionalProvider< - Raw, - Raw, - RawNotifierRef> with $Provider, RawNotifierRef> { +final class RawNotifierProvider + extends $FunctionalProvider, Raw> + with $Provider, RawNotifierRef> { const RawNotifierProvider._( {Raw Function( RawNotifierRef ref, @@ -1094,9 +1085,7 @@ typedef RawFutureNotifierRef = Ref>>; const rawFutureNotifierProvider = RawFutureNotifierProvider._(); final class RawFutureNotifierProvider extends $FunctionalProvider< - Raw>, - Raw>, - RawFutureNotifierRef> + Raw>, Raw>> with $Provider>, RawFutureNotifierRef> { const RawFutureNotifierProvider._( {Raw> Function( @@ -1157,9 +1146,7 @@ typedef RawStreamNotifierRef = Ref>>; const rawStreamNotifierProvider = RawStreamNotifierProvider._(); final class RawStreamNotifierProvider extends $FunctionalProvider< - Raw>, - Raw>, - RawStreamNotifierRef> + Raw>, Raw>> with $Provider>, RawStreamNotifierRef> { const RawStreamNotifierProvider._( {Raw> Function( @@ -1220,9 +1207,7 @@ typedef FutureRawNotifierRef = Ref>>; const futureRawNotifierProvider = FutureRawNotifierProvider._(); final class FutureRawNotifierProvider extends $FunctionalProvider< - AsyncValue>, - FutureOr>, - FutureRawNotifierRef> + AsyncValue>, FutureOr>> with $FutureModifier>, $FutureProvider, FutureRawNotifierRef> { @@ -1277,9 +1262,7 @@ typedef StreamRawNotifierRef = Ref>>; const streamRawNotifierProvider = StreamRawNotifierProvider._(); final class StreamRawNotifierProvider extends $FunctionalProvider< - AsyncValue>, - Stream>, - StreamRawNotifierRef> + AsyncValue>, Stream>> with $FutureModifier>, $StreamProvider, StreamRawNotifierRef> { diff --git a/tools/generate_providers/bin/generate_providers.dart b/tools/generate_providers/bin/generate_providers.dart index 5dbb17b46..9e5fbcd2d 100644 --- a/tools/generate_providers/bin/generate_providers.dart +++ b/tools/generate_providers/bin/generate_providers.dart @@ -95,7 +95,7 @@ Future main(List args) async { genericsUsage: 'StateT', genericsDefinition: 'StateT', createdT: 'StateT', - refT: 'StateProviderRef', + refT: 'Ref', ), _FunctionalBuilder( 'StateNotifierProvider', @@ -103,7 +103,7 @@ Future main(List args) async { genericsDefinition: 'NotifierT extends StateNotifier, StateT', createdT: 'NotifierT', - refT: 'StateNotifierProviderRef', + refT: 'Ref', ), _FunctionalBuilder( 'Provider', @@ -190,7 +190,7 @@ import 'internals.dart'; genericsUsage: 'NotifierT', genericsDefinition: 'NotifierT extends ChangeNotifier?', createdT: 'NotifierT', - refT: 'ChangeNotifierProviderRef', + refT: 'Ref', ), ], kinds: _ProviderKind.values, diff --git a/website/docs/advanced/select/select/codegen.g.dart b/website/docs/advanced/select/select/codegen.g.dart index 7f916e012..5bc5686f4 100644 --- a/website/docs/advanced/select/select/codegen.g.dart +++ b/website/docs/advanced/select/select/codegen.g.dart @@ -13,7 +13,7 @@ typedef ExampleRef = Ref; @ProviderFor(example) const exampleProvider = ExampleProvider._(); -final class ExampleProvider extends $FunctionalProvider +final class ExampleProvider extends $FunctionalProvider with $Provider { const ExampleProvider._( {User Function( diff --git a/website/docs/advanced/select/select_async/codegen.g.dart b/website/docs/advanced/select/select_async/codegen.g.dart index 74dffb3c4..ba1f4f5d7 100644 --- a/website/docs/advanced/select/select_async/codegen.g.dart +++ b/website/docs/advanced/select/select_async/codegen.g.dart @@ -14,7 +14,7 @@ typedef UserRef = Ref>; const userProvider = UserProvider._(); final class UserProvider - extends $FunctionalProvider, FutureOr, UserRef> + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const UserProvider._( {FutureOr Function( @@ -65,8 +65,7 @@ typedef ExampleRef = Ref; @ProviderFor(example) const exampleProvider = ExampleProvider._(); -final class ExampleProvider - extends $FunctionalProvider +final class ExampleProvider extends $FunctionalProvider with $Provider { const ExampleProvider._( {Object? Function( diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart index 38c6d75dc..434acec61 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart @@ -33,8 +33,8 @@ typedef ActivityRef = Ref>; @ProviderFor(activity) const activityProvider = ActivityProvider._(); -final class ActivityProvider extends $FunctionalProvider, - FutureOr, ActivityRef> +final class ActivityProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const ActivityProvider._( {FutureOr Function( diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart index c6cc2d41e..089de5441 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -13,8 +13,8 @@ typedef ActivityRef = Ref>; @ProviderFor(activity) const activityProvider = ActivityProvider._(); -final class ActivityProvider extends $FunctionalProvider, - FutureOr, ActivityRef> +final class ActivityProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const ActivityProvider._( {FutureOr Function( diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart index 60ce86584..b6cdd724b 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -13,8 +13,8 @@ typedef ActivityRef = Ref>; @ProviderFor(activity) const activityProvider = ActivityProvider._(); -final class ActivityProvider extends $FunctionalProvider, - FutureOr, ActivityRef> +final class ActivityProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const ActivityProvider._( {FutureOr Function( diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart index b932ff0c9..b211d3340 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -13,8 +13,8 @@ typedef ActivityRef = Ref>; @ProviderFor(activity) const activityProvider = ActivityProvider._(); -final class ActivityProvider extends $FunctionalProvider, - FutureOr, ActivityRef> +final class ActivityProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const ActivityProvider._( {FutureOr Function( diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart index 605b8a955..cdf5cdbac 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -13,8 +13,8 @@ typedef ActivityRef = Ref>; @ProviderFor(activity) const activityProvider = ActivityProvider._(); -final class ActivityProvider extends $FunctionalProvider, - FutureOr, ActivityRef> +final class ActivityProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const ActivityProvider._( {FutureOr Function( diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart index 38c6d75dc..434acec61 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -33,8 +33,8 @@ typedef ActivityRef = Ref>; @ProviderFor(activity) const activityProvider = ActivityProvider._(); -final class ActivityProvider extends $FunctionalProvider, - FutureOr, ActivityRef> +final class ActivityProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const ActivityProvider._( {FutureOr Function( diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 4aa60925b..3dead3ea9 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -14,7 +14,7 @@ typedef FetchUserRef = Ref>; const fetchUserProvider = FetchUserFamily._(); final class FetchUserProvider - extends $FunctionalProvider, FutureOr, FetchUserRef> + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const FetchUserProvider._( {required FetchUserFamily super.from, diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart index 0e0e78841..1f5444b57 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -13,8 +13,8 @@ typedef ExampleRef = Ref>; @ProviderFor(example) const exampleProvider = ExampleProvider._(); -final class ExampleProvider extends $FunctionalProvider, - FutureOr, ExampleRef> +final class ExampleProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const ExampleProvider._( {FutureOr Function( diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart index ffbb91172..7951bd7a2 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -14,7 +14,7 @@ typedef ExampleRef = Ref>; const exampleProvider = ExampleProvider._(); final class ExampleProvider - extends $FunctionalProvider, Stream, ExampleRef> + extends $FunctionalProvider, Stream> with $FutureModifier, $StreamProvider { const ExampleProvider._( {Stream Function( diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart index 0b92c8298..83c6377aa 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -13,8 +13,7 @@ typedef Example1Ref = Ref; @ProviderFor(example1) const example1Provider = Example1Provider._(); -final class Example1Provider - extends $FunctionalProvider +final class Example1Provider extends $FunctionalProvider with $Provider { const Example1Provider._( {String Function( @@ -73,8 +72,7 @@ typedef Example2Ref = Ref; @ProviderFor(example2) const example2Provider = Example2Provider._(); -final class Example2Provider - extends $FunctionalProvider +final class Example2Provider extends $FunctionalProvider with $Provider { const Example2Provider._( {String Function( diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 9029bc677..69a1976c2 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -13,8 +13,7 @@ typedef ExampleRef = Ref; @ProviderFor(example) const exampleProvider = ExampleFamily._(); -final class ExampleProvider - extends $FunctionalProvider +final class ExampleProvider extends $FunctionalProvider with $Provider { const ExampleProvider._( {required ExampleFamily super.from, diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index b6411c166..0fbebd59f 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -183,7 +183,7 @@ final class ExampleFamily extends Family { } abstract class _$Example extends $Notifier { - late final _$args = (ref as $NotifierProviderElement).origin.argument as ( + late final _$args = ref.$arg as ( int, { String param2, }); diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index 32f09c070..33d057344 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -13,8 +13,7 @@ typedef ExampleRef = Ref; @ProviderFor(example) const exampleProvider = ExampleFamily._(); -final class ExampleProvider - extends $FunctionalProvider +final class ExampleProvider extends $FunctionalProvider with $Provider { const ExampleProvider._( {required ExampleFamily super.from, diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart index 664ce8756..b928978c5 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -13,8 +13,7 @@ typedef ExampleRef = Ref; @ProviderFor(example) const exampleProvider = ExampleProvider._(); -final class ExampleProvider - extends $FunctionalProvider +final class ExampleProvider extends $FunctionalProvider with $Provider { const ExampleProvider._( {String Function( diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart index 7afb843d8..950b74bc2 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -13,8 +13,7 @@ typedef SearchRef = Ref; @ProviderFor(search) const searchProvider = SearchProvider._(); -final class SearchProvider - extends $FunctionalProvider +final class SearchProvider extends $FunctionalProvider with $Provider { const SearchProvider._( {String Function( @@ -74,7 +73,7 @@ typedef ConfigsRef = Ref>; const configsProvider = ConfigsProvider._(); final class ConfigsProvider extends $FunctionalProvider< - AsyncValue, Stream, ConfigsRef> + AsyncValue, Stream> with $FutureModifier, $StreamProvider { @@ -129,7 +128,7 @@ typedef CharactersRef = Ref>>; const charactersProvider = CharactersProvider._(); final class CharactersProvider extends $FunctionalProvider< - AsyncValue>, FutureOr>, CharactersRef> + AsyncValue>, FutureOr>> with $FutureModifier>, $FutureProvider, CharactersRef> { diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart index 7b40bb385..3bea31389 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -13,7 +13,7 @@ typedef CityRef = Ref; @ProviderFor(city) const cityProvider = CityProvider._(); -final class CityProvider extends $FunctionalProvider +final class CityProvider extends $FunctionalProvider with $Provider { const CityProvider._( {String Function( diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart index de776cc3c..f55659935 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -13,8 +13,7 @@ typedef FilterRef = Ref; @ProviderFor(filter) const filterProvider = FilterProvider._(); -final class FilterProvider - extends $FunctionalProvider +final class FilterProvider extends $FunctionalProvider with $Provider { const FilterProvider._( {Filter Function( @@ -74,7 +73,7 @@ typedef FilteredTodoListRef = Ref>; const filteredTodoListProvider = FilteredTodoListProvider._(); final class FilteredTodoListProvider - extends $FunctionalProvider, List, FilteredTodoListRef> + extends $FunctionalProvider, List> with $Provider, FilteredTodoListRef> { const FilteredTodoListProvider._( {List Function( diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart index e603c7aed..b2807a870 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -13,8 +13,7 @@ typedef AnotherRef = Ref; @ProviderFor(another) const anotherProvider = AnotherProvider._(); -final class AnotherProvider - extends $FunctionalProvider +final class AnotherProvider extends $FunctionalProvider with $Provider { const AnotherProvider._( {MyValue Function( @@ -73,7 +72,7 @@ typedef MyRef = Ref; @ProviderFor(my) const myProvider = MyProvider._(); -final class MyProvider extends $FunctionalProvider +final class MyProvider extends $FunctionalProvider with $Provider { const MyProvider._( {MyValue Function( diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart index 143ebac38..8b6b58514 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -14,7 +14,7 @@ typedef ConfigRef = Ref>; const configProvider = ConfigProvider._(); final class ConfigProvider extends $FunctionalProvider< - AsyncValue, Stream, ConfigRef> + AsyncValue, Stream> with $FutureModifier, $StreamProvider { @@ -69,7 +69,7 @@ typedef ProductsRef = Ref>>; const productsProvider = ProductsProvider._(); final class ProductsProvider extends $FunctionalProvider< - AsyncValue>, FutureOr>, ProductsRef> + AsyncValue>, FutureOr>> with $FutureModifier>, $FutureProvider, ProductsRef> { diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart index 142d2a11c..1a81ae8c1 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -13,7 +13,7 @@ typedef CityRef = Ref; @ProviderFor(city) const cityProvider = CityProvider._(); -final class CityProvider extends $FunctionalProvider +final class CityProvider extends $FunctionalProvider with $Provider { const CityProvider._( {String Function( @@ -72,8 +72,8 @@ typedef WeatherRef = Ref>; @ProviderFor(weather) const weatherProvider = WeatherProvider._(); -final class WeatherProvider extends $FunctionalProvider, - FutureOr, WeatherRef> +final class WeatherProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const WeatherProvider._( {FutureOr Function( diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart index 9f095dae5..0392538e3 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -14,7 +14,7 @@ typedef ConfigRef = Ref>; const configProvider = ConfigProvider._(); final class ConfigProvider extends $FunctionalProvider< - AsyncValue, Stream, ConfigRef> + AsyncValue, Stream> with $FutureModifier, $StreamProvider { @@ -69,7 +69,7 @@ typedef ProductsRef = Ref>>; const productsProvider = ProductsProvider._(); final class ProductsProvider extends $FunctionalProvider< - AsyncValue>, FutureOr>, ProductsRef> + AsyncValue>, FutureOr>> with $FutureModifier>, $FutureProvider, ProductsRef> { diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart index 393522052..ecf188ef6 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart @@ -14,7 +14,7 @@ typedef ExampleRef = Ref>; const exampleProvider = ExampleProvider._(); final class ExampleProvider - extends $FunctionalProvider, Stream, ExampleRef> + extends $FunctionalProvider, Stream> with $FutureModifier, $StreamProvider { const ExampleProvider._( {Stream Function( diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart index 883fe4289..4a64af46a 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart @@ -13,7 +13,7 @@ typedef MyRef = Ref; @ProviderFor(my) const myProvider = MyProvider._(); -final class MyProvider extends $FunctionalProvider +final class MyProvider extends $FunctionalProvider with $Provider { const MyProvider._( {MyValue Function( diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart index f77c1ace8..caf0995be 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart @@ -13,7 +13,7 @@ typedef CityRef = Ref; @ProviderFor(city) const cityProvider = CityProvider._(); -final class CityProvider extends $FunctionalProvider +final class CityProvider extends $FunctionalProvider with $Provider { const CityProvider._( {String Function( @@ -72,8 +72,7 @@ typedef CountryRef = Ref; @ProviderFor(country) const countryProvider = CountryProvider._(); -final class CountryProvider - extends $FunctionalProvider +final class CountryProvider extends $FunctionalProvider with $Provider { const CountryProvider._( {String Function( diff --git a/website/docs/concepts/reading/counter/codegen.g.dart b/website/docs/concepts/reading/counter/codegen.g.dart index 2e77c21f0..0dfd30fc6 100644 --- a/website/docs/concepts/reading/counter/codegen.g.dart +++ b/website/docs/concepts/reading/counter/codegen.g.dart @@ -14,7 +14,7 @@ typedef RepositoryRef = Ref; const repositoryProvider = RepositoryProvider._(); final class RepositoryProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const RepositoryProvider._( {Repository Function( diff --git a/website/docs/concepts/reading/listen/codegen.g.dart b/website/docs/concepts/reading/listen/codegen.g.dart index 74334ad42..2c1f4b273 100644 --- a/website/docs/concepts/reading/listen/codegen.g.dart +++ b/website/docs/concepts/reading/listen/codegen.g.dart @@ -13,7 +13,7 @@ typedef AnotherRef = Ref; @ProviderFor(another) const anotherProvider = AnotherProvider._(); -final class AnotherProvider extends $FunctionalProvider +final class AnotherProvider extends $FunctionalProvider with $Provider { const AnotherProvider._( {void Function( diff --git a/website/docs/concepts/reading/provider/codegen.g.dart b/website/docs/concepts/reading/provider/codegen.g.dart index e03391620..cd68e7820 100644 --- a/website/docs/concepts/reading/provider/codegen.g.dart +++ b/website/docs/concepts/reading/provider/codegen.g.dart @@ -14,7 +14,7 @@ typedef RepositoryRef = Ref; const repositoryProvider = RepositoryProvider._(); final class RepositoryProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const RepositoryProvider._( {Repository Function( @@ -73,7 +73,7 @@ typedef ValueRef = Ref; @ProviderFor(value) const valueProvider = ValueProvider._(); -final class ValueProvider extends $FunctionalProvider +final class ValueProvider extends $FunctionalProvider with $Provider { const ValueProvider._( {String Function( diff --git a/website/docs/concepts/reading/watch/codegen.g.dart b/website/docs/concepts/reading/watch/codegen.g.dart index f9e315bdc..af2d9d36f 100644 --- a/website/docs/concepts/reading/watch/codegen.g.dart +++ b/website/docs/concepts/reading/watch/codegen.g.dart @@ -14,7 +14,7 @@ typedef FilterTypeRef = Ref; const filterTypeProvider = FilterTypeProvider._(); final class FilterTypeProvider - extends $FunctionalProvider + extends $FunctionalProvider with $Provider { const FilterTypeProvider._( {FilterType Function( @@ -142,7 +142,7 @@ typedef FilteredTodoListRef = Ref>; const filteredTodoListProvider = FilteredTodoListProvider._(); final class FilteredTodoListProvider - extends $FunctionalProvider, List, FilteredTodoListRef> + extends $FunctionalProvider, List> with $Provider, FilteredTodoListRef> { const FilteredTodoListProvider._( {List Function( diff --git a/website/docs/concepts/reading/watch_build/codegen.g.dart b/website/docs/concepts/reading/watch_build/codegen.g.dart index 174a7dc56..51d85de22 100644 --- a/website/docs/concepts/reading/watch_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen.g.dart @@ -81,7 +81,7 @@ typedef CounterRef = Ref; @ProviderFor(counter) const counterProvider = CounterProvider._(); -final class CounterProvider extends $FunctionalProvider +final class CounterProvider extends $FunctionalProvider with $Provider { const CounterProvider._( {int Function( diff --git a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart index 006a25f97..1bc192195 100644 --- a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart @@ -81,7 +81,7 @@ typedef CounterRef = Ref; @ProviderFor(counter) const counterProvider = CounterProvider._(); -final class CounterProvider extends $FunctionalProvider +final class CounterProvider extends $FunctionalProvider with $Provider { const CounterProvider._( {int Function( diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart index 5d810b67b..ed70e46f9 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -13,8 +13,8 @@ typedef ExampleRef = Ref>; @ProviderFor(example) const exampleProvider = ExampleProvider._(); -final class ExampleProvider extends $FunctionalProvider, - FutureOr, ExampleRef> +final class ExampleProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const ExampleProvider._( {FutureOr Function( diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart index f5830d7e9..910016c97 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -13,7 +13,7 @@ typedef ExampleRef = Ref; @ProviderFor(example) const exampleProvider = ExampleProvider._(); -final class ExampleProvider extends $FunctionalProvider +final class ExampleProvider extends $FunctionalProvider with $Provider { const ExampleProvider._( {int Function( diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index e623a393a..34032c995 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -13,7 +13,7 @@ typedef LabelRef = Ref; @ProviderFor(label) const labelProvider = LabelFamily._(); -final class LabelProvider extends $FunctionalProvider +final class LabelProvider extends $FunctionalProvider with $Provider { const LabelProvider._( {required LabelFamily super.from, diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart index 4b534c5c3..1ee57c762 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -13,8 +13,8 @@ typedef ExampleRef = Ref>; @ProviderFor(example) const exampleProvider = ExampleProvider._(); -final class ExampleProvider extends $FunctionalProvider, - FutureOr, ExampleRef> +final class ExampleProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const ExampleProvider._( {FutureOr Function( diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart index cdcebd2d8..1c1f5756d 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -13,7 +13,7 @@ typedef OtherRef = Ref; @ProviderFor(other) const otherProvider = OtherProvider._(); -final class OtherProvider extends $FunctionalProvider +final class OtherProvider extends $FunctionalProvider with $Provider { const OtherProvider._( {int Function( @@ -73,7 +73,7 @@ typedef ExampleRef = Ref>; const exampleProvider = ExampleProvider._(); final class ExampleProvider - extends $FunctionalProvider, Stream, ExampleRef> + extends $FunctionalProvider, Stream> with $FutureModifier, $StreamProvider { const ExampleProvider._( {Stream Function( diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart index 4d26be8c8..5da2a0d71 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart @@ -13,7 +13,7 @@ typedef OtherRef = Ref; @ProviderFor(other) const otherProvider = OtherProvider._(); -final class OtherProvider extends $FunctionalProvider +final class OtherProvider extends $FunctionalProvider with $Provider { const OtherProvider._( {int Function( @@ -72,7 +72,7 @@ typedef ExampleRef = Ref; @ProviderFor(example) const exampleProvider = ExampleProvider._(); -final class ExampleProvider extends $FunctionalProvider +final class ExampleProvider extends $FunctionalProvider with $Provider { const ExampleProvider._( {int Function( diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart index 99bc8ad11..5b9b38e0f 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart @@ -13,7 +13,7 @@ typedef OtherRef = Ref; @ProviderFor(other) const otherProvider = OtherProvider._(); -final class OtherProvider extends $FunctionalProvider +final class OtherProvider extends $FunctionalProvider with $Provider { const OtherProvider._( {int Function( @@ -72,7 +72,7 @@ typedef ExampleRef = Ref; @ProviderFor(example) const exampleProvider = ExampleProvider._(); -final class ExampleProvider extends $FunctionalProvider +final class ExampleProvider extends $FunctionalProvider with $Provider { const ExampleProvider._( {int Function( diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart index 14c8e0eac..7d3d83817 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -13,7 +13,7 @@ typedef OtherRef = Ref; @ProviderFor(other) const otherProvider = OtherProvider._(); -final class OtherProvider extends $FunctionalProvider +final class OtherProvider extends $FunctionalProvider with $Provider { const OtherProvider._( {int Function( diff --git a/website/docs/essentials/combining_requests/read_example/codegen.g.dart b/website/docs/essentials/combining_requests/read_example/codegen.g.dart index 761a48fd0..f95fd7890 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.g.dart @@ -13,7 +13,7 @@ typedef OtherRef = Ref; @ProviderFor(other) const otherProvider = OtherProvider._(); -final class OtherProvider extends $FunctionalProvider +final class OtherProvider extends $FunctionalProvider with $Provider { const OtherProvider._( {int Function( diff --git a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart index 5de38b29b..f31f1664c 100644 --- a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart @@ -15,8 +15,7 @@ const locationProvider = LocationProvider._(); final class LocationProvider extends $FunctionalProvider< AsyncValue<({double longitude, double latitude})>, - Stream<({double longitude, double latitude})>, - LocationRef> + Stream<({double longitude, double latitude})>> with $FutureModifier<({double longitude, double latitude})>, $StreamProvider<({double longitude, double latitude}), LocationRef> { @@ -71,7 +70,7 @@ typedef RestaurantsNearMeRef = Ref>>; const restaurantsNearMeProvider = RestaurantsNearMeProvider._(); final class RestaurantsNearMeProvider extends $FunctionalProvider< - AsyncValue>, FutureOr>, RestaurantsNearMeRef> + AsyncValue>, FutureOr>> with $FutureModifier>, $FutureProvider, RestaurantsNearMeRef> { diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart index 9523fbd4a..f50439720 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart @@ -13,7 +13,7 @@ typedef OtherRef = Ref; @ProviderFor(other) const otherProvider = OtherProvider._(); -final class OtherProvider extends $FunctionalProvider +final class OtherProvider extends $FunctionalProvider with $Provider { const OtherProvider._( {int Function( @@ -72,7 +72,7 @@ typedef ExampleRef = Ref; @ProviderFor(example) const exampleProvider = ExampleProvider._(); -final class ExampleProvider extends $FunctionalProvider +final class ExampleProvider extends $FunctionalProvider with $Provider { const ExampleProvider._( {int Function( diff --git a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart index 87568a7e7..3332824a0 100644 --- a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart +++ b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart @@ -13,8 +13,8 @@ typedef ExampleRef = Ref>; @ProviderFor(example) const exampleProvider = ExampleProvider._(); -final class ExampleProvider extends $FunctionalProvider, - FutureOr, ExampleRef> +final class ExampleProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const ExampleProvider._( {FutureOr Function( diff --git a/website/docs/essentials/first_request/codegen/provider.g.dart b/website/docs/essentials/first_request/codegen/provider.g.dart index 3247e218f..694d37af9 100644 --- a/website/docs/essentials/first_request/codegen/provider.g.dart +++ b/website/docs/essentials/first_request/codegen/provider.g.dart @@ -19,8 +19,8 @@ const activityProvider = ActivityProvider._(); /// This will create a provider named `activityProvider` /// which will cache the result of this function. -final class ActivityProvider extends $FunctionalProvider, - FutureOr, ActivityRef> +final class ActivityProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { /// This will create a provider named `activityProvider` /// which will cache the result of this function. diff --git a/website/docs/essentials/passing_args/family/codegen.g.dart b/website/docs/essentials/passing_args/family/codegen.g.dart index fd1415533..4ce4498dd 100644 --- a/website/docs/essentials/passing_args/family/codegen.g.dart +++ b/website/docs/essentials/passing_args/family/codegen.g.dart @@ -13,8 +13,8 @@ typedef ActivityRef = Ref>; @ProviderFor(activity) const activityProvider = ActivityFamily._(); -final class ActivityProvider extends $FunctionalProvider, - FutureOr, ActivityRef> +final class ActivityProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const ActivityProvider._( {required ActivityFamily super.from, @@ -273,8 +273,7 @@ final class ActivityNotifier2Family extends Family { } abstract class _$ActivityNotifier2 extends $AsyncNotifier { - late final _$args = - (ref as $AsyncNotifierProviderElement).origin.argument as String; + late final _$args = ref.$arg as String; String get activityType => _$args; FutureOr build( diff --git a/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart b/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart index 79a92896d..220d83a3f 100644 --- a/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart +++ b/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart @@ -13,8 +13,8 @@ typedef ActivityRef = Ref>; @ProviderFor(activity) const activityProvider = ActivityProvider._(); -final class ActivityProvider extends $FunctionalProvider, - FutureOr, ActivityRef> +final class ActivityProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const ActivityProvider._( {FutureOr Function( diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart index 2bd8d06b5..07a96e522 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -13,8 +13,8 @@ typedef TodoListRef = Ref>>; @ProviderFor(todoList) const todoListProvider = TodoListProvider._(); -final class TodoListProvider extends $FunctionalProvider>, - FutureOr>, TodoListRef> +final class TodoListProvider + extends $FunctionalProvider>, FutureOr>> with $FutureModifier>, $FutureProvider, TodoListRef> { const TodoListProvider._( {FutureOr> Function( diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart index 87568a7e7..3332824a0 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart @@ -13,8 +13,8 @@ typedef ExampleRef = Ref>; @ProviderFor(example) const exampleProvider = ExampleProvider._(); -final class ExampleProvider extends $FunctionalProvider, - FutureOr, ExampleRef> +final class ExampleProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const ExampleProvider._( {FutureOr Function( diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart index 7496cd4ee..91ba4046b 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -20,9 +20,8 @@ const myListenableProvider = MyListenableProvider._(); /// A provider which creates a ValueNotifier and update its listeners /// whenever the value changes. final class MyListenableProvider extends $FunctionalProvider< - Raw>, - Raw>, - MyListenableRef> with $Provider>, MyListenableRef> { + Raw>, Raw>> + with $Provider>, MyListenableRef> { /// A provider which creates a ValueNotifier and update its listeners /// whenever the value changes. const MyListenableProvider._( diff --git a/website/docs/essentials/websockets_sync/raw_usage.g.dart b/website/docs/essentials/websockets_sync/raw_usage.g.dart index 2173c7853..39a826e81 100644 --- a/website/docs/essentials/websockets_sync/raw_usage.g.dart +++ b/website/docs/essentials/websockets_sync/raw_usage.g.dart @@ -13,10 +13,9 @@ typedef RawStreamRef = Ref>>; @ProviderFor(rawStream) const rawStreamProvider = RawStreamProvider._(); -final class RawStreamProvider extends $FunctionalProvider< - Raw>, - Raw>, - RawStreamRef> with $Provider>, RawStreamRef> { +final class RawStreamProvider + extends $FunctionalProvider>, Raw>> + with $Provider>, RawStreamRef> { const RawStreamProvider._( {Raw> Function( RawStreamRef ref, diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart index 8ba405ac8..d819bbf92 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -14,9 +14,8 @@ typedef MyListenableRef = Ref>>; const myListenableProvider = MyListenableProvider._(); final class MyListenableProvider extends $FunctionalProvider< - Raw>, - Raw>, - MyListenableRef> with $Provider>, MyListenableRef> { + Raw>, Raw>> + with $Provider>, MyListenableRef> { const MyListenableProvider._( {Raw> Function( MyListenableRef ref, @@ -76,7 +75,7 @@ typedef AnotherListenableRef = Ref>>; const anotherListenableProvider = AnotherListenableProvider._(); final class AnotherListenableProvider extends $FunctionalProvider< - Raw>, Raw>, AnotherListenableRef> + Raw>, Raw>> with $Provider>, AnotherListenableRef> { const AnotherListenableProvider._( {Raw> Function( diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart index 97d12c1dd..d2a75745b 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -14,7 +14,7 @@ typedef StreamExampleRef = Ref>; const streamExampleProvider = StreamExampleProvider._(); final class StreamExampleProvider - extends $FunctionalProvider, Stream, StreamExampleRef> + extends $FunctionalProvider, Stream> with $FutureModifier, $StreamProvider { const StreamExampleProvider._( {Stream Function( diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart index 47a944a85..e601efd26 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -13,8 +13,7 @@ typedef SynchronousExampleRef = Ref; @ProviderFor(synchronousExample) const synchronousExampleProvider = SynchronousExampleProvider._(); -final class SynchronousExampleProvider - extends $FunctionalProvider +final class SynchronousExampleProvider extends $FunctionalProvider with $Provider { const SynchronousExampleProvider._( {int Function( diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index b177e92df..5195726c4 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -13,7 +13,7 @@ typedef RandomRef = Ref; @ProviderFor(random) const randomProvider = RandomFamily._(); -final class RandomProvider extends $FunctionalProvider +final class RandomProvider extends $FunctionalProvider with $Provider { const RandomProvider._( {required RandomFamily super.from, diff --git a/website/docs/from_provider/motivation/async_values/async_values.g.dart b/website/docs/from_provider/motivation/async_values/async_values.g.dart index c8da26468..13a80aeba 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.g.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.g.dart @@ -13,8 +13,8 @@ typedef ItemsApiRef = Ref>>; @ProviderFor(itemsApi) const itemsApiProvider = ItemsApiProvider._(); -final class ItemsApiProvider extends $FunctionalProvider>, - FutureOr>, ItemsApiRef> +final class ItemsApiProvider + extends $FunctionalProvider>, FutureOr>> with $FutureModifier>, $FutureProvider, ItemsApiRef> { const ItemsApiProvider._( {FutureOr> Function( @@ -67,7 +67,7 @@ typedef EvenItemsRef = Ref>; const evenItemsProvider = EvenItemsProvider._(); final class EvenItemsProvider - extends $FunctionalProvider, List, EvenItemsRef> + extends $FunctionalProvider, List> with $Provider, EvenItemsRef> { const EvenItemsProvider._( {List Function( diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart index 2390b50d3..00b5a80b6 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -13,7 +13,7 @@ typedef DiceRollRef = Ref; @ProviderFor(diceRoll) const diceRollProvider = DiceRollProvider._(); -final class DiceRollProvider extends $FunctionalProvider +final class DiceRollProvider extends $FunctionalProvider with $Provider { const DiceRollProvider._( {int Function( @@ -72,8 +72,7 @@ typedef CachedDiceRollRef = Ref; @ProviderFor(cachedDiceRoll) const cachedDiceRollProvider = CachedDiceRollProvider._(); -final class CachedDiceRollProvider - extends $FunctionalProvider +final class CachedDiceRollProvider extends $FunctionalProvider with $Provider { const CachedDiceRollProvider._( {int Function( diff --git a/website/docs/from_provider/motivation/combine/combine.g.dart b/website/docs/from_provider/motivation/combine/combine.g.dart index 978c4ef8d..97d1c5027 100644 --- a/website/docs/from_provider/motivation/combine/combine.g.dart +++ b/website/docs/from_provider/motivation/combine/combine.g.dart @@ -13,7 +13,7 @@ typedef NumberRef = Ref; @ProviderFor(number) const numberProvider = NumberProvider._(); -final class NumberProvider extends $FunctionalProvider +final class NumberProvider extends $FunctionalProvider with $Provider { const NumberProvider._( {int Function( @@ -72,7 +72,7 @@ typedef DoubledRef = Ref; @ProviderFor(doubled) const doubledProvider = DoubledProvider._(); -final class DoubledProvider extends $FunctionalProvider +final class DoubledProvider extends $FunctionalProvider with $Provider { const DoubledProvider._( {int Function( diff --git a/website/docs/from_provider/motivation/same_type/same_type.g.dart b/website/docs/from_provider/motivation/same_type/same_type.g.dart index 2b00141ea..d5c781dc9 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.g.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.g.dart @@ -13,8 +13,7 @@ typedef ItemsRef = Ref>; @ProviderFor(items) const itemsProvider = ItemsProvider._(); -final class ItemsProvider - extends $FunctionalProvider, List, ItemsRef> +final class ItemsProvider extends $FunctionalProvider, List> with $Provider, ItemsRef> { const ItemsProvider._( {List Function( @@ -74,7 +73,7 @@ typedef EvenItemsRef = Ref>; const evenItemsProvider = EvenItemsProvider._(); final class EvenItemsProvider - extends $FunctionalProvider, List, EvenItemsRef> + extends $FunctionalProvider, List> with $Provider, EvenItemsRef> { const EvenItemsProvider._( {List Function( diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart index 7e76cb8c8..8ea69b222 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart @@ -13,8 +13,7 @@ typedef HelloWorldRef = Ref; @ProviderFor(helloWorld) const helloWorldProvider = HelloWorldProvider._(); -final class HelloWorldProvider - extends $FunctionalProvider +final class HelloWorldProvider extends $FunctionalProvider with $Provider { const HelloWorldProvider._( {String Function( diff --git a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart index 7e76cb8c8..8ea69b222 100644 --- a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -13,8 +13,7 @@ typedef HelloWorldRef = Ref; @ProviderFor(helloWorld) const helloWorldProvider = HelloWorldProvider._(); -final class HelloWorldProvider - extends $FunctionalProvider +final class HelloWorldProvider extends $FunctionalProvider with $Provider { const HelloWorldProvider._( {String Function( diff --git a/website/docs/introduction/getting_started/hello_world/main.g.dart b/website/docs/introduction/getting_started/hello_world/main.g.dart index 7e76cb8c8..8ea69b222 100644 --- a/website/docs/introduction/getting_started/hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/main.g.dart @@ -13,8 +13,7 @@ typedef HelloWorldRef = Ref; @ProviderFor(helloWorld) const helloWorldProvider = HelloWorldProvider._(); -final class HelloWorldProvider - extends $FunctionalProvider +final class HelloWorldProvider extends $FunctionalProvider with $Provider { const HelloWorldProvider._( {String Function( diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index d3f609454..63dac5337 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -14,7 +14,7 @@ typedef FetchPackagesRef = Ref>>; const fetchPackagesProvider = FetchPackagesFamily._(); final class FetchPackagesProvider extends $FunctionalProvider< - AsyncValue>, FutureOr>, FetchPackagesRef> + AsyncValue>, FutureOr>> with $FutureModifier>, $FutureProvider, FetchPackagesRef> { diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index 9eb5aaac6..40794adb0 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -13,10 +13,9 @@ typedef TaskTrackerRef = Ref; @ProviderFor(taskTracker) const taskTrackerProvider = TaskTrackerProvider._(); -final class TaskTrackerProvider extends $FunctionalProvider< - TaskTrackerRepo, - TaskTrackerRepo, - TaskTrackerRef> with $Provider { +final class TaskTrackerProvider + extends $FunctionalProvider + with $Provider { const TaskTrackerProvider._( {TaskTrackerRepo Function( TaskTrackerRef ref, @@ -213,8 +212,7 @@ final class BugsEncounteredNotifierFamily extends Family { } abstract class _$BugsEncounteredNotifier extends $AsyncNotifier { - late final _$args = - (ref as $AsyncNotifierProviderElement).origin.argument as String; + late final _$args = ref.$arg as String; String get featureId => _$args; FutureOr build( diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart index a2fd32d96..d7770bbed 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -13,8 +13,7 @@ typedef DurationRef = Ref; @ProviderFor(duration) const durationProvider = DurationProvider._(); -final class DurationProvider - extends $FunctionalProvider +final class DurationProvider extends $FunctionalProvider with $Provider { const DurationProvider._( {Duration Function( @@ -73,8 +72,7 @@ typedef RepositoryRef = Ref<_MyRepo>; @ProviderFor(repository) const repositoryProvider = RepositoryProvider._(); -final class RepositoryProvider - extends $FunctionalProvider<_MyRepo, _MyRepo, RepositoryRef> +final class RepositoryProvider extends $FunctionalProvider<_MyRepo, _MyRepo> with $Provider<_MyRepo, RepositoryRef> { const RepositoryProvider._( {_MyRepo Function( diff --git a/website/docs/providers/future_provider/config_provider/codegen.g.dart b/website/docs/providers/future_provider/config_provider/codegen.g.dart index ee145abd8..031ff1c2c 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.g.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.g.dart @@ -14,9 +14,7 @@ typedef FetchConfigurationRef = Ref>; const fetchConfigurationProvider = FetchConfigurationProvider._(); final class FetchConfigurationProvider extends $FunctionalProvider< - AsyncValue, - FutureOr, - FetchConfigurationRef> + AsyncValue, FutureOr> with $FutureModifier, $FutureProvider { diff --git a/website/docs/providers/provider/completed_todos/completed_todos.g.dart b/website/docs/providers/provider/completed_todos/completed_todos.g.dart index 8cdc7d8a8..f34527681 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.g.dart @@ -14,7 +14,7 @@ typedef CompletedTodosRef = Ref>; const completedTodosProvider = CompletedTodosProvider._(); final class CompletedTodosProvider - extends $FunctionalProvider, List, CompletedTodosRef> + extends $FunctionalProvider, List> with $Provider, CompletedTodosRef> { const CompletedTodosProvider._( {List Function( diff --git a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index 4cbe2931e..f2097adaa 100644 --- a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -81,8 +81,7 @@ typedef CanGoToPreviousPageRef = Ref; @ProviderFor(canGoToPreviousPage) const canGoToPreviousPageProvider = CanGoToPreviousPageProvider._(); -final class CanGoToPreviousPageProvider - extends $FunctionalProvider +final class CanGoToPreviousPageProvider extends $FunctionalProvider with $Provider { const CanGoToPreviousPageProvider._( {bool Function( diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart index 2b815fa9c..42b8a04e3 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -13,8 +13,8 @@ typedef ChatRef = Ref>>; @ProviderFor(chat) const chatProvider = ChatProvider._(); -final class ChatProvider extends $FunctionalProvider>, - Stream>, ChatRef> +final class ChatProvider + extends $FunctionalProvider>, Stream>> with $FutureModifier>, $StreamProvider, ChatRef> { const ChatProvider._( {Stream> Function( diff --git a/website/static/snippets/async.g.dart b/website/static/snippets/async.g.dart index 8998bc376..9ae204722 100644 --- a/website/static/snippets/async.g.dart +++ b/website/static/snippets/async.g.dart @@ -14,7 +14,7 @@ typedef ConfigurationsRef = Ref>; const configurationsProvider = ConfigurationsProvider._(); final class ConfigurationsProvider extends $FunctionalProvider< - AsyncValue, FutureOr, ConfigurationsRef> + AsyncValue, FutureOr> with $FutureModifier, $FutureProvider { diff --git a/website/static/snippets/combine.g.dart b/website/static/snippets/combine.g.dart index 52d1d7141..6bd564c8b 100644 --- a/website/static/snippets/combine.g.dart +++ b/website/static/snippets/combine.g.dart @@ -13,8 +13,7 @@ typedef TodosRef = Ref>; @ProviderFor(todos) const todosProvider = TodosProvider._(); -final class TodosProvider - extends $FunctionalProvider, List, TodosRef> +final class TodosProvider extends $FunctionalProvider, List> with $Provider, TodosRef> { const TodosProvider._( {List Function( @@ -73,8 +72,7 @@ typedef FilterRef = Ref; @ProviderFor(filter) const filterProvider = FilterProvider._(); -final class FilterProvider - extends $FunctionalProvider +final class FilterProvider extends $FunctionalProvider with $Provider { const FilterProvider._( {Filter Function( @@ -134,7 +132,7 @@ typedef FilteredTodosRef = Ref>; const filteredTodosProvider = FilteredTodosProvider._(); final class FilteredTodosProvider - extends $FunctionalProvider, List, FilteredTodosRef> + extends $FunctionalProvider, List> with $Provider, FilteredTodosRef> { const FilteredTodosProvider._( {List Function( diff --git a/website/static/snippets/create.g.dart b/website/static/snippets/create.g.dart index ab8eaf983..1d8e99c83 100644 --- a/website/static/snippets/create.g.dart +++ b/website/static/snippets/create.g.dart @@ -13,8 +13,8 @@ typedef BoredSuggestionRef = Ref>; @ProviderFor(boredSuggestion) const boredSuggestionProvider = BoredSuggestionProvider._(); -final class BoredSuggestionProvider extends $FunctionalProvider< - AsyncValue, FutureOr, BoredSuggestionRef> +final class BoredSuggestionProvider + extends $FunctionalProvider, FutureOr> with $FutureModifier, $FutureProvider { const BoredSuggestionProvider._( {FutureOr Function( From 491f870f7b989458f6a0fcb7a81ce149ff2e5ab1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 8 Mar 2024 13:38:58 +0100 Subject: [PATCH 264/387] Recreate Notifiers on rebuild (#3393) This enables the usage of `ref.mounted`, to easily check if a provider is currently active or not. --- .../lib/src/core/modifiers/future.dart | 60 +++-- .../src/core/provider/notifier_provider.dart | 56 ++--- .../lib/src/providers/async_notifier.dart | 16 +- .../lib/src/providers/future_provider.dart | 2 +- .../riverpod/lib/src/providers/notifier.dart | 4 +- .../lib/src/providers/stream_notifier.dart | 19 +- .../lib/src/providers/stream_provider.dart | 2 +- .../providers}/async_notifier_test.dart | 207 ++++++++++-------- .../providers}/notifier_test.dart | 132 +++++------ .../providers}/stream_notifier_test.dart | 163 ++++++-------- packages/riverpod/test/new/utils.dart | 17 ++ .../docs/migration/from_state_notifier.mdx | 8 +- .../consumers_dont_change.dart | 3 +- .../consumers_dont_change.dart | 3 +- .../consumers_dont_change.dart | 3 +- .../consumers_dont_change.dart | 3 +- 16 files changed, 339 insertions(+), 359 deletions(-) rename packages/riverpod/test/{old/legacy_providers/async_notifier => new/providers}/async_notifier_test.dart (89%) rename packages/riverpod/test/{old/legacy_providers/notifier => new/providers}/notifier_test.dart (88%) rename packages/riverpod/test/{old/legacy_providers/stream_notifier => new/providers}/stream_notifier_test.dart (90%) diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 18db7889f..b0ff9ad05 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -42,10 +42,14 @@ mixin $AsyncClassModifier @visibleForTesting @protected Future get future { - // TODO remove downcast/upcast once "future" is merged with all providers - final Object? element = this.element; - if (element == null) throw StateError(uninitializedElementError); + final ref = _ref; + if (ref == null) { + throw StateError(uninitializedElementError); + } + + ref._throwIfInvalidUsage(); + final element = ref._element; element as FutureModifierElement; element.flush(); @@ -181,6 +185,30 @@ base mixin $FutureModifier on ProviderBase> { } } +mixin FutureModifierClassElement< + NotifierT extends NotifierBase< // + AsyncValue, + CreatedT>, + StateT, + CreatedT> + on + FutureModifierElement, + ClassProviderElement, CreatedT> { + @override + void handleNotifier(Object? notifier, {required bool seamless}) { + asyncTransition(AsyncLoading(), seamless: seamless); + } + + @override + void handleError( + Object error, + StackTrace stackTrace, { + required bool seamless, + }) { + onError(AsyncError(error, stackTrace), seamless: seamless); + } +} + /// Mixin to help implement logic for listening to [Future]s/[Stream]s and setup /// `provider.future` + convert the object into an [AsyncValue]. @internal @@ -216,14 +244,11 @@ mixin FutureModifierElement on ProviderElementBase> { AsyncValue newState, { required bool seamless, }) { -// ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member final previous = stateResult?.requireState; if (previous == null) { -// ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member super.setStateResult(ResultData(newState)); } else { -// ignore: invalid_use_of_protected_member, invalid_use_of_visible_for_testing_member super.setStateResult( ResultData( newState @@ -254,11 +279,6 @@ mixin FutureModifierElement on ProviderElementBase> { } } - void handleNotifier(Object? notifier, {required bool seamless}) { - // Overrides the default behavior of ClassProviderElement.handleNotifier - asyncTransition(AsyncLoading(), seamless: seamless); - } - /// Life-cycle for when an error from the provider's "build" method is received. /// /// Might be invoked after the element is disposed in the case where `provider.future` @@ -321,9 +341,9 @@ mixin FutureModifierElement on ProviderElementBase> { @internal void handleStream( Stream Function() create, { - required bool didChangeDependency, + required bool seamless, }) { - _handleAsync(didChangeDependency: didChangeDependency, ({ + _handleAsync(seamless: seamless, ({ required data, required done, required error, @@ -353,9 +373,9 @@ mixin FutureModifierElement on ProviderElementBase> { @internal void handleFuture( FutureOr Function() create, { - required bool didChangeDependency, + required bool seamless, }) { - _handleAsync(didChangeDependency: didChangeDependency, ({ + _handleAsync(seamless: seamless, ({ required data, required done, required error, @@ -403,17 +423,17 @@ mixin FutureModifierElement on ProviderElementBase> { required void Function() done, required void Function(Future, CancelAsyncSubscription) last, }) listen, { - required bool didChangeDependency, + required bool seamless, }) { - onLoading(AsyncLoading(), seamless: !didChangeDependency); + onLoading(AsyncLoading(), seamless: seamless); try { final sub = _cancelSubscription = listen( data: (value) { - onData(AsyncData(value), seamless: !didChangeDependency); + onData(AsyncData(value), seamless: seamless); }, error: (error, stack) { - onError(AsyncError(error, stack), seamless: !didChangeDependency); + onError(AsyncError(error, stack), seamless: seamless); }, last: (last, sub) { assert(_lastFuture == null, 'bad state'); @@ -438,7 +458,7 @@ mixin FutureModifierElement on ProviderElementBase> { } catch (error, stackTrace) { onError( AsyncError(error, stackTrace), - seamless: !didChangeDependency, + seamless: seamless, ); } } diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index da3144378..ce796603f 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -54,37 +54,28 @@ typedef RunNotifierBuild< // /// } /// } /// ``` +// TODO changelog breaking: Notifiers are now recreated when `Notifier.build` is re-executed. +// This enables using `if (ref.mounted)` inside notifiers. abstract class NotifierBase { - ClassProviderElement, StateT, CreatedT>? - _element; + Ref? _ref; // TODO docs @protected Ref get ref { - final ref = _element?.ref; + final ref = _ref; if (ref == null) throw StateError(uninitializedElementError); return ref; } + // TODO chnagelog breaking: reading state/future in Notifiers after dispose throws @visibleForTesting @protected - StateT get state { - final element = _element; - if (element == null) throw StateError(uninitializedElementError); - - element.flush(); - return element.requireState; - } + StateT get state => ref.state; @visibleForTesting @protected - set state(StateT newState) { - final element = _element; - if (element == null) throw StateError(uninitializedElementError); - - element.setStateResult(ResultData(newState)); - } + set state(StateT newState) => ref.state = newState; CreatedT runBuild(); @@ -94,8 +85,7 @@ abstract class NotifierBase { @internal extension ClassBaseX on NotifierBase { - ClassProviderElement, StateT, CreatedT>? - get element => _element; + ProviderElementBase? get element => _ref?._element; } /// Implementation detail of `riverpod_generator`. @@ -191,37 +181,35 @@ abstract class ClassProviderElement< // Ref ref, { required bool didChangeDependency, }) { - final result = classListenable.result ??= Result.guard(() { + final seamless = !didChangeDependency; + + final result = classListenable.result = Result.guard(() { final notifier = provider.create(); - if (notifier._element != null) { + if (notifier._ref != null) { throw StateError(alreadyInitializedError); } - notifier._element = this; + notifier._ref = ref; return notifier; }); - // TODO test notifier constructor throws -> provider emits AsyncError - // TODO test notifier constructor throws -> .notifier rethrows the error - // TODO test notifier constructor throws -> .future emits Future.error - switch (result) { case ResultData(): try { - handleNotifier(result.state, seamless: !didChangeDependency); + handleNotifier(result.state, seamless: seamless); final created = provider.runNotifierBuildOverride?.call(ref, result.state) ?? result.state.runBuild(); - handleValue(created, didChangeDependency: didChangeDependency); + handleValue(created, seamless: seamless); } catch (err, stack) { - handleError(err, stack, didChangeDependency: didChangeDependency); + handleError(err, stack, seamless: seamless); } case ResultError(): handleError( result.error, result.stackTrace, - didChangeDependency: didChangeDependency, + seamless: seamless, ); } } @@ -230,19 +218,13 @@ abstract class ClassProviderElement< // // Overridden by FutureModifier mixin } - void handleValue(CreatedT created, {required bool didChangeDependency}); + void handleValue(CreatedT created, {required bool seamless}); void handleError( Object error, StackTrace stackTrace, { - required bool didChangeDependency, + required bool seamless, }); - @override - void dispose() { - super.dispose(); - classListenable.result?.stateOrNull?._element = null; - } - @override bool updateShouldNotify(StateT previous, StateT next) { return classListenable.result?.stateOrNull diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index 9cb752216..61bff0a28 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -55,7 +55,8 @@ class $AsyncNotifierProviderElement< // AsyncValue, FutureOr> // with - FutureModifierElement { + FutureModifierElement, + FutureModifierClassElement> { /// Implementation detail of `riverpod_generator`. /// Do not use. $AsyncNotifierProviderElement(this.provider, super.container); @@ -63,23 +64,14 @@ class $AsyncNotifierProviderElement< // @override final $AsyncNotifierProvider provider; - @override - void handleError( - Object error, - StackTrace stackTrace, { - required bool didChangeDependency, - }) { - onError(AsyncError(error, stackTrace), seamless: !didChangeDependency); - } - @override void handleValue( FutureOr created, { - required bool didChangeDependency, + required bool seamless, }) { handleFuture( () => created, - didChangeDependency: didChangeDependency, + seamless: seamless, ); } } diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 0e0261288..4778b9584 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -180,7 +180,7 @@ class $FutureProviderElement }) { handleFuture( () => provider.create(ref), - didChangeDependency: didChangeDependency, + seamless: !didChangeDependency, ); } diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index 4588f07e6..256374677 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -121,7 +121,7 @@ class $NotifierProviderElement< // void handleError( Object error, StackTrace stackTrace, { - required bool didChangeDependency, + required bool seamless, }) { setStateResult(ResultError(error, stackTrace)); // TODO report uncaught error to the zone @@ -131,7 +131,7 @@ class $NotifierProviderElement< // @override void handleValue( StateT created, { - required bool didChangeDependency, + required bool seamless, }) { setStateResult(ResultData(created)); } diff --git a/packages/riverpod/lib/src/providers/stream_notifier.dart b/packages/riverpod/lib/src/providers/stream_notifier.dart index 0a938d6b3..872507a61 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier.dart @@ -56,7 +56,8 @@ class $StreamNotifierProviderElement< // AsyncValue, Stream> // with - FutureModifierElement { + FutureModifierElement, + FutureModifierClassElement> { /// Implementation detail of `riverpod_generator`. /// Do not use. $StreamNotifierProviderElement(this.provider, super.container); @@ -64,23 +65,11 @@ class $StreamNotifierProviderElement< // @override final $StreamNotifierProvider provider; - @override - void handleError( - Object error, - StackTrace stackTrace, { - required bool didChangeDependency, - }) { - onError(AsyncError(error, stackTrace), seamless: !didChangeDependency); - } - @override void handleValue( Stream created, { - required bool didChangeDependency, + required bool seamless, }) { - handleStream( - () => created, - didChangeDependency: didChangeDependency, - ); + handleStream(() => created, seamless: seamless); } } diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index 52de7259f..6f7d04ba2 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -174,7 +174,7 @@ class $StreamProviderElement handleStream( () => provider.create(ref), - didChangeDependency: didChangeDependency, + seamless: !didChangeDependency, ); } diff --git a/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart b/packages/riverpod/test/new/providers/async_notifier_test.dart similarity index 89% rename from packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart rename to packages/riverpod/test/new/providers/async_notifier_test.dart index 16cc4c388..add8cb446 100644 --- a/packages/riverpod/test/old/legacy_providers/async_notifier/async_notifier_test.dart +++ b/packages/riverpod/test/new/providers/async_notifier_test.dart @@ -1,23 +1,30 @@ +// ignore_for_file: invalid_use_of_protected_member + import 'dart:async'; import 'package:meta/meta.dart'; import 'package:mockito/mockito.dart'; -import 'package:riverpod/src/internals.dart'; +import 'package:riverpod/legacy.dart'; +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/framework.dart' show UnmountedRefException; +import 'package:riverpod/src/providers/async_notifier.dart' show $AsyncNotifier; import 'package:test/test.dart'; -import '../../../new/matrix.dart'; -import '../../utils.dart'; +import '../matrix.dart'; +import '../utils.dart'; void main() { test('Throws if using notifier properties in its constructor', () { - expect( - CtorNotifier.new, - throwsA(isA()), - ); - expect( - FamilyCtorNotifier.new, - throwsA(isA()), - ); + final errors = captureErrors([ + () => CtorNotifier().state, + () => CtorNotifier().state = const AsyncData(42), + () => CtorNotifier().future, + () => CtorNotifier().ref, + () => FamilyCtorNotifier().state, + () => FamilyCtorNotifier().state = const AsyncData(42), + () => FamilyCtorNotifier().future, + () => FamilyCtorNotifier().ref, + ]); }); asyncNotifierProviderFactory.createGroup((factory) { @@ -39,9 +46,14 @@ void main() { test('Can read state inside onDispose', () { final container = ProviderContainer.test(); late TestAsyncNotifier notifier; + late List errors; final provider = factory.simpleTestProvider((ref) { ref.onDispose(() { - notifier.state; + errors = captureErrors([ + () => notifier.state, + () => notifier.state = const AsyncData(42), + () => notifier.future, + ]); }); return 0; }); @@ -50,6 +62,11 @@ void main() { notifier = container.read(provider.notifier); container.dispose(); + + expect( + errors, + everyElement(isA()), + ); }); test('Using the notifier after dispose throws', () { @@ -61,12 +78,23 @@ void main() { container.dispose(); - expect(() => notifier.state, throwsStateError); - expect(() => notifier.future, throwsStateError); - expect(() => notifier.state = const AsyncData(42), throwsStateError); - // ignore: invalid_use_of_protected_member - expect(() => notifier.ref, throwsStateError); - expect(() => notifier.update((p1) => 42), throwsStateError); + expect(notifier.ref.mounted, false); + expect( + () => notifier.state, + throwsA(isA()), + ); + expect( + () => notifier.future, + throwsA(isA()), + ); + expect( + () => notifier.state = const AsyncData(42), + throwsA(isA()), + ); + expect( + () => notifier.update((p1) => 42), + throwsA(isA()), + ); }); test('Can assign `AsyncLoading` to `AsyncValue`', () { @@ -541,39 +569,6 @@ void main() { ); }); - test( - 'when read on outdated provider, refreshes the provider and return the up-to-date state', - () async { - final listener = OnBuildMock(); - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) { - listener(); - return Future.value(ref.watch(dep)); - }, - ); - final container = ProviderContainer.test(); - - container.listen(provider, (previous, next) {}); - final notifier = container.read(provider.notifier); - - expect(notifier.state, const AsyncLoading()); - expect(await container.read(provider.future), 0); - expect(notifier.state, const AsyncData(0)); - verify(listener()).called(1); - - container.read(dep.notifier).state++; - - expect( - notifier.state, - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ); - expect(await container.read(provider.future), 1); - expect(notifier.state, const AsyncData(1)); - verify(listener()).called(1); - }); - test('can be read inside build', () { final dep = StateProvider((ref) => 0); late AsyncValue state; @@ -622,6 +617,31 @@ void main() { }); group('AsyncNotifier.future', () { + test('If the notifier is recreated with an error, rethrows the new error', + () async { + final container = ProviderContainer.test(); + final listener = Listener>(); + var body = () => factory.deferredNotifier((ref) => 0); + final provider = factory.provider(() => body()); + + container.listen(provider.future, listener.call); + + await expectLater( + container.read(provider.future), + completion(0), + ); + verifyZeroInteractions(listener); + + body = () => throw StateError('foo'); + container.invalidate(provider); + + await expectLater( + container.read(provider.future), + throwsA(isA()), + ); + verify(listener(any, any)).called(1); + }); + test( 'when disposed during loading, resolves with the content of AsyncNotifier.build', () async { @@ -773,58 +793,69 @@ void main() { expect(notifier.future, same(container.read(provider.future))); }); + }); - test( - 'when read on outdated provider, refreshes the provider and return the up-to-date state', + group('AsyncNotifierProvider.notifier', () { + test('If the notifier is recreated with an error, rethrows the new error', () async { - final listener = OnBuildMock(); - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) { - listener(); - return Future.value(ref.watch(dep)); - }, - ); final container = ProviderContainer.test(); + final listener = Listener<$AsyncNotifier>(); + final onError = ErrorListener(); + var body = () => factory.deferredNotifier((ref) => 0); + final provider = factory.provider(() => body()); - container.listen(provider, (previous, next) {}); - final notifier = container.read(provider.notifier); + container.listen( + provider.notifier, + listener.call, + onError: onError.call, + ); - expect(await container.read(provider.future), 0); - verify(listener()).called(1); + await expectLater(container.read(provider.notifier), isNotNull); + verifyZeroInteractions(listener); + verifyZeroInteractions(onError); - container.read(dep.notifier).state++; + body = () => throw StateError('foo'); + container.invalidate(provider); - expect(notifier.future, notifier.future); - expect(notifier.future, same(container.read(provider.future))); - expect(await notifier.future, 1); - verify(listener()).called(1); + await expectLater( + () => container.read(provider.notifier), + throwsA(isA()), + ); + verifyZeroInteractions(listener); + verifyOnly(onError, onError(isA(), any)).called(1); }); - }); - group('AsyncNotifierProvider.notifier', () { test( - 'never emits an update. The Notifier is never recreated once it is instantiated', + 'Notifies listeners whenever `build` is re-executed, due to recreating a new notifier.', () async { - final listener = OnBuildMock(); + final notifierListener = Listener<$AsyncNotifier>(); final dep = StateProvider((ref) => 0); final provider = factory.provider(() { - listener(); - return factory.deferredNotifier((ref) => ref.watch(dep)); + return factory.deferredNotifier( + (ref) => Future.value(ref.watch(dep)), + ); }); final container = ProviderContainer.test(); - container.listen(provider, (previous, next) {}); - final notifier = container.read(provider.notifier); + final sub = container.listen(provider.notifier, notifierListener.call); + final initialNotifier = sub.read(); - verify(listener()).called(1); - expect(container.read(provider), const AsyncData(0)); + expect(initialNotifier.ref.mounted, true); - container.read(dep.notifier).state++; + // Skip the loading + await container.read(provider.future); + verifyNoMoreInteractions(notifierListener); - expect(container.read(provider), const AsyncData(1)); - expect(container.read(provider.notifier), same(notifier)); - verifyNoMoreInteractions(listener); + container.refresh(provider); + final newNotifier = sub.read(); + + expect(newNotifier, isNot(same(initialNotifier))); + verifyOnly( + notifierListener, + notifierListener(initialNotifier, newNotifier), + ).called(1); + expect(initialNotifier.ref.mounted, false); + expect(newNotifier.ref.mounted, true); }); }); @@ -1170,19 +1201,11 @@ class Equal { } class CtorNotifier extends AsyncNotifier { - CtorNotifier() { - state; - } - @override FutureOr build() => 0; } class FamilyCtorNotifier extends FamilyAsyncNotifier { - FamilyCtorNotifier() { - state; - } - @override FutureOr build(int arg) => 0; } diff --git a/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart b/packages/riverpod/test/new/providers/notifier_test.dart similarity index 88% rename from packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart rename to packages/riverpod/test/new/providers/notifier_test.dart index 02caff0d0..c99b0ecdf 100644 --- a/packages/riverpod/test/old/legacy_providers/notifier/notifier_test.dart +++ b/packages/riverpod/test/new/providers/notifier_test.dart @@ -1,24 +1,26 @@ -// ignore_for_file: avoid_types_on_closure_parameters +// ignore_for_file: avoid_types_on_closure_parameters, invalid_use_of_protected_member import 'package:meta/meta.dart'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/framework.dart' show UnmountedRefException; +import 'package:riverpod/src/providers/notifier.dart' show $Notifier; import 'package:test/test.dart'; -import '../../../new/matrix.dart'; -import '../../utils.dart'; +import '../matrix.dart'; +import '../utils.dart'; void main() { test('Throws if using notifier properties in its constructor', () { - expect( - CtorNotifier.new, - throwsA(isA()), - ); - expect( - FamilyCtorNotifier.new, - throwsA(isA()), - ); + final errors = captureErrors([ + () => CtorNotifier().state, + () => CtorNotifier().state = 42, + () => CtorNotifier().ref, + () => FamilyCtorNotifier().state, + () => FamilyCtorNotifier().state = 42, + () => FamilyCtorNotifier().ref, + ]); }); notifierProviderFactory.createGroup((factory) { @@ -37,12 +39,16 @@ void main() { ); }); - test('Can read state inside onDispose', () { + test('Cannot read properties inside onDispose', () { final container = ProviderContainer.test(); late TestNotifier notifier; + late List errors; final provider = factory.simpleTestProvider((ref) { ref.onDispose(() { - notifier.state; + errors = captureErrors([ + () => notifier.state, + () => notifier.state = 42, + ]); }); return 0; }); @@ -51,6 +57,11 @@ void main() { notifier = container.read(provider.notifier); container.dispose(); + + expect( + errors, + everyElement(isA()), + ); }); test('Using the notifier after dispose throws', () { @@ -62,11 +73,15 @@ void main() { container.dispose(); - expect(() => notifier.state, throwsStateError); - expect(() => notifier.stateOrNull, throwsStateError); - expect(() => notifier.state = 42, throwsStateError); - // ignore: invalid_use_of_protected_member - expect(() => notifier.ref, throwsStateError); + expect(notifier.ref.mounted, false); + expect( + () => notifier.state, + throwsA(isA()), + ); + expect( + () => notifier.state = 42, + throwsA(isA()), + ); }); test( @@ -207,29 +222,33 @@ void main() { verifyOnly(listener, listener(0, 1)); }); - test('preserves the notifier between watch updates', () async { - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider((ref) { - return ref.watch(dep); - }); - final container = ProviderContainer.test(); - final listener = Listener>(); - - container.listen( - provider.notifier, - listener.call, - fireImmediately: true, - ); + group('.notifier', () { + test( + 'Notifies listeners whenever `build` is re-executed, due to recreating a new notifier.', + () async { + final notifierListener = Listener<$Notifier>(); + final dep = StateProvider((ref) => 0); + final provider = factory.provider(() { + return factory.deferredNotifier((ref) => ref.watch(dep)); + }); + final container = ProviderContainer.test(); - final notifier = container.read(provider.notifier); + final sub = container.listen(provider.notifier, notifierListener.call); + final initialNotifier = sub.read(); - verifyOnly(listener, listener(null, notifier)); + expect(initialNotifier.ref.mounted, true); - container.read(dep.notifier).update((state) => state + 1); - await container.pump(); - - verifyNoMoreInteractions(listener); - expect(container.read(provider.notifier), notifier); + container.refresh(provider); + final newNotifier = sub.read(); + + expect(newNotifier, isNot(same(initialNotifier))); + verifyOnly( + notifierListener, + notifierListener(initialNotifier, newNotifier), + ).called(1); + expect(initialNotifier.ref.mounted, false); + expect(newNotifier.ref.mounted, true); + }); }); test('calls notifier.build on every watch update', () async { @@ -401,44 +420,19 @@ void main() { verifyNoMoreInteractions(onError); }); - test('reading notifier.state on invalidated provider rebuilds the provider', - () { - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider((ref) => ref.watch(dep)); - final container = ProviderContainer.test(); - final listener = Listener(); - - container.listen(provider, listener.call); - final notifier = container.read(provider.notifier); - - expect(notifier.state, 0); - - notifier.state = -1; - - verifyOnly(listener, listener(0, -1)); - - container.read(dep.notifier).state++; - - expect(notifier.state, 1); - verifyOnly(listener, listener(-1, 1)); - }); - test('supports ref.refresh(provider)', () { final provider = factory.simpleTestProvider((ref) => 0); final container = ProviderContainer.test(); - final notifier = container.read(provider.notifier); - expect(container.read(provider), 0); - notifier.state = 42; + container.read(provider.notifier).state = 42; expect(container.read(provider), 42); expect(container.refresh(provider), 0); expect(container.read(provider), 0); - expect(notifier.state, 0); - expect(container.read(provider.notifier), notifier); + expect(container.read(provider.notifier).state, 0); }); test('supports listenSelf((State? prev, State next) {})', () { @@ -692,19 +686,11 @@ class Equal { } class CtorNotifier extends Notifier { - CtorNotifier() { - state; - } - @override int build() => 0; } class FamilyCtorNotifier extends FamilyNotifier { - FamilyCtorNotifier() { - state; - } - @override int build(int arg) => 0; } diff --git a/packages/riverpod/test/old/legacy_providers/stream_notifier/stream_notifier_test.dart b/packages/riverpod/test/new/providers/stream_notifier_test.dart similarity index 90% rename from packages/riverpod/test/old/legacy_providers/stream_notifier/stream_notifier_test.dart rename to packages/riverpod/test/new/providers/stream_notifier_test.dart index 08d2ded34..89e4e40a5 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_notifier/stream_notifier_test.dart +++ b/packages/riverpod/test/new/providers/stream_notifier_test.dart @@ -1,4 +1,4 @@ -// ignore_for_file: avoid_types_on_closure_parameters +// ignore_for_file: avoid_types_on_closure_parameters, invalid_use_of_protected_member import 'dart:async'; @@ -6,21 +6,26 @@ import 'package:meta/meta.dart'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/framework.dart' show UnmountedRefException; +import 'package:riverpod/src/providers/stream_notifier.dart' + show $StreamNotifier; import 'package:test/test.dart'; -import '../../../new/matrix.dart'; -import '../../utils.dart'; +import '../matrix.dart'; +import '../utils.dart'; void main() { test('Throws if using notifier properties in its constructor', () { - expect( - CtorNotifier.new, - throwsA(isA()), - ); - expect( - FamilyCtorNotifier.new, - throwsA(isA()), - ); + final errors = captureErrors([ + () => CtorNotifier().state, + () => CtorNotifier().state = const AsyncData(42), + () => CtorNotifier().future, + () => CtorNotifier().ref, + () => FamilyCtorNotifier().state, + () => FamilyCtorNotifier().state = const AsyncData(42), + () => FamilyCtorNotifier().future, + () => FamilyCtorNotifier().ref, + ]); }); streamNotifierProviderFactory.createGroup((factory) { @@ -39,12 +44,17 @@ void main() { ); }); - test('Can read state inside onDispose', () { + test('Cannot properties inside onDispose', () { final container = ProviderContainer.test(); late TestStreamNotifier notifier; + late List errors; final provider = factory.simpleTestProvider((ref) { ref.onDispose(() { - notifier.state; + errors = captureErrors([ + () => notifier.state, + () => notifier.state = const AsyncData(42), + () => notifier.future, + ]); }); return Stream.value(0); }); @@ -53,6 +63,11 @@ void main() { notifier = container.read(provider.notifier); container.dispose(); + + expect( + errors, + everyElement(isA()), + ); }); test('Using the notifier after dispose throws', () { @@ -64,12 +79,23 @@ void main() { container.dispose(); - expect(() => notifier.state, throwsStateError); - expect(() => notifier.future, throwsStateError); - expect(() => notifier.state = const AsyncData(42), throwsStateError); - // ignore: invalid_use_of_protected_member - expect(() => notifier.ref, throwsStateError); - expect(() => notifier.update((p1) => 42), throwsStateError); + expect(notifier.ref.mounted, false); + expect( + () => notifier.state, + throwsA(isA()), + ); + expect( + () => notifier.future, + throwsA(isA()), + ); + expect( + () => notifier.state = const AsyncData(42), + throwsA(isA()), + ); + expect( + () => notifier.update((p1) => 42), + throwsA(isA()), + ); }); group('supports AsyncValue transition', () { @@ -446,39 +472,6 @@ void main() { ); }); - test( - 'when read on outdated provider, refreshes the provider and return the up-to-date state', - () async { - final listener = OnBuildMock(); - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) { - listener(); - return Stream.value(ref.watch(dep)); - }, - ); - final container = ProviderContainer.test(); - - container.listen(provider, (previous, next) {}); - final notifier = container.read(provider.notifier); - - expect(notifier.state, const AsyncLoading()); - expect(await container.read(provider.future), 0); - expect(notifier.state, const AsyncData(0)); - verify(listener()).called(1); - - container.read(dep.notifier).state++; - - expect( - notifier.state, - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ); - expect(await container.read(provider.future), 1); - expect(notifier.state, const AsyncData(1)); - verify(listener()).called(1); - }); - test('can be read inside build', () { final dep = StateProvider((ref) => 0); late AsyncValue state; @@ -683,64 +676,40 @@ void main() { expect(notifier.future, same(container.read(provider.future))); }); - - test( - 'when read on outdated provider, refreshes the provider and return the up-to-date state', - () async { - final listener = OnBuildMock(); - final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) { - listener(); - return Stream.value(ref.watch(dep)); - }, - ); - final container = ProviderContainer.test(); - - container.listen(provider, (previous, next) {}); - final notifier = container.read(provider.notifier); - - expect(await container.read(provider.future), 0); - verify(listener()).called(1); - - container.read(dep.notifier).state++; - - expect(notifier.future, notifier.future); - expect(notifier.future, same(container.read(provider.future))); - expect(await notifier.future, 1); - verify(listener()).called(1); - }); }); group('StreamNotifierProvider.notifier', () { test( - 'never emits an update. The Notifier is never recreated once it is instantiated', + 'Notifies listeners whenever `build` is re-executed, due to recreating a new notifier.', () async { - final listener = OnBuildMock(); + final notifierListener = Listener<$StreamNotifier>(); final dep = StateProvider((ref) => 0); final provider = factory.provider(() { - listener(); return factory.deferredNotifier( (ref) => Stream.value(ref.watch(dep)), ); }); final container = ProviderContainer.test(); - // Skip the loading - await container.listen(provider.future, (previous, next) {}).read(); - - container.listen(provider, (previous, next) {}); - final notifier = container.read(provider.notifier); + final sub = container.listen(provider.notifier, notifierListener.call); + final initialNotifier = sub.read(); - verify(listener()).called(1); - expect(container.read(provider), const AsyncData(0)); + expect(initialNotifier.ref.mounted, true); - container.read(dep.notifier).state++; + // Skip the loading await container.read(provider.future); + verifyNoMoreInteractions(notifierListener); - expect(container.read(provider), const AsyncData(1)); - expect(container.read(provider.notifier), same(notifier)); - verifyNoMoreInteractions(listener); + container.refresh(provider); + final newNotifier = sub.read(); + + expect(newNotifier, isNot(same(initialNotifier))); + verifyOnly( + notifierListener, + notifierListener(initialNotifier, newNotifier), + ).called(1); + expect(initialNotifier.ref.mounted, false); + expect(newNotifier.ref.mounted, true); }); }); @@ -1118,19 +1087,11 @@ class Equal { } class CtorNotifier extends StreamNotifier { - CtorNotifier() { - state; - } - @override Stream build() => Stream.value(0); } class FamilyCtorNotifier extends FamilyStreamNotifier { - FamilyCtorNotifier() { - state; - } - @override Stream build(int arg) => Stream.value(0); } diff --git a/packages/riverpod/test/new/utils.dart b/packages/riverpod/test/new/utils.dart index 0817cb689..24ca8c4ca 100644 --- a/packages/riverpod/test/new/utils.dart +++ b/packages/riverpod/test/new/utils.dart @@ -5,8 +5,25 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; +List captureErrors(List cb) { + final errors = []; + for (final fn in cb) { + try { + fn(); + errors.add(null); + } catch (e) { + errors.add(e); + } + } + return errors; +} + class ProviderObserverMock extends Mock implements ProviderObserver {} +class OnBuildMock extends Mock { + void call(); +} + class OnDisposeMock extends Mock { void call(); } diff --git a/website/docs/migration/from_state_notifier.mdx b/website/docs/migration/from_state_notifier.mdx index 1c32df322..e6bedd1cc 100644 --- a/website/docs/migration/from_state_notifier.mdx +++ b/website/docs/migration/from_state_notifier.mdx @@ -1,6 +1,6 @@ --- title: From `StateNotifier` -version: 1 +version: 2 --- import buildInit from "./from_state_notifier/build_init"; @@ -22,6 +22,12 @@ import obtainNotifierOnTests from "!!raw-loader!./from_state_notifier/obtain_not import { Link } from "/src/components/Link"; import { AutoSnippet } from "/src/components/CodeSnippet"; +:::caution +The content of this page may be outdated. +It will be updated in the future, but for now you may want to refer to the content +in the top of the sidebar instead (introduction/essentials/case-studies/...) +::: + Along with [Riverpod 2.0](https://pub.dev/packages/flutter_riverpod/changelog#200), new classes were introduced: `Notifier` / `AsyncNotifer`. `StateNotifier` is now discouraged in favor of those new APIs. diff --git a/website/docs/migration/from_state_notifier/consumers_dont_change.dart b/website/docs/migration/from_state_notifier/consumers_dont_change.dart index e358a2e54..51829e903 100644 --- a/website/docs/migration/from_state_notifier/consumers_dont_change.dart +++ b/website/docs/migration/from_state_notifier/consumers_dont_change.dart @@ -28,7 +28,8 @@ class SomeConsumer extends ConsumerWidget { Text("You've counted up until $counter, good job!"), TextButton( /* highlight-start */ - onPressed: ref.read(counterNotifierProvider.notifier).increment, + onPressed: () => + ref.read(counterNotifierProvider.notifier).increment(), /* highlight-end */ child: const Text('Count even more!'), ), diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart index e358a2e54..51829e903 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart @@ -28,7 +28,8 @@ class SomeConsumer extends ConsumerWidget { Text("You've counted up until $counter, good job!"), TextButton( /* highlight-start */ - onPressed: ref.read(counterNotifierProvider.notifier).increment, + onPressed: () => + ref.read(counterNotifierProvider.notifier).increment(), /* highlight-end */ child: const Text('Count even more!'), ), diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart index e358a2e54..51829e903 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart @@ -28,7 +28,8 @@ class SomeConsumer extends ConsumerWidget { Text("You've counted up until $counter, good job!"), TextButton( /* highlight-start */ - onPressed: ref.read(counterNotifierProvider.notifier).increment, + onPressed: () => + ref.read(counterNotifierProvider.notifier).increment(), /* highlight-end */ child: const Text('Count even more!'), ), diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart index e358a2e54..51829e903 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/from_state_notifier/consumers_dont_change.dart @@ -28,7 +28,8 @@ class SomeConsumer extends ConsumerWidget { Text("You've counted up until $counter, good job!"), TextButton( /* highlight-start */ - onPressed: ref.read(counterNotifierProvider.notifier).increment, + onPressed: () => + ref.read(counterNotifierProvider.notifier).increment(), /* highlight-end */ child: const Text('Count even more!'), ), From f59b755643a56f29ac872e8435bd1305f5fdeccf Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Mar 2024 00:57:41 +0100 Subject: [PATCH 265/387] Fix golden --- ...providers_should_specify_dependencies_lint.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/scoped_providers_should_specify_dependencies/scoped_providers_should_specify_dependencies_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/scoped_providers_should_specify_dependencies/scoped_providers_should_specify_dependencies_lint.md index 9646a4c0e..5d96d7bb0 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/scoped_providers_should_specify_dependencies/scoped_providers_should_specify_dependencies_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/scoped_providers_should_specify_dependencies/scoped_providers_should_specify_dependencies_lint.md @@ -31,7 +31,7 @@ test/lints/scoped_providers_should_specify_dependencies.dart:67:9 code: scoped_providers_should_specify_dependencies severity: Severity.warning message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:81:9 +test/lints/scoped_providers_should_specify_dependencies.dart:82:9 ```dart .overrideWith(() => throw UnimplementedError()), @@ -46,7 +46,7 @@ test/lints/scoped_providers_should_specify_dependencies.dart:81:9 code: scoped_providers_should_specify_dependencies severity: Severity.warning message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:106:7 +test/lints/scoped_providers_should_specify_dependencies.dart:107:7 ```dart .overrideWith(() => throw UnimplementedError()), @@ -61,7 +61,7 @@ test/lints/scoped_providers_should_specify_dependencies.dart:106:7 code: scoped_providers_should_specify_dependencies severity: Severity.warning message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:130:9 +test/lints/scoped_providers_should_specify_dependencies.dart:132:9 ```dart .overrideWith(() => throw UnimplementedError()), @@ -76,7 +76,7 @@ test/lints/scoped_providers_should_specify_dependencies.dart:130:9 code: scoped_providers_should_specify_dependencies severity: Severity.warning message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:168:11 +test/lints/scoped_providers_should_specify_dependencies.dart:171:11 ```dart .overrideWith(() => throw UnimplementedError()), @@ -91,7 +91,7 @@ test/lints/scoped_providers_should_specify_dependencies.dart:168:11 code: scoped_providers_should_specify_dependencies severity: Severity.warning message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:182:13 +test/lints/scoped_providers_should_specify_dependencies.dart:185:13 ```dart .overrideWith(() => throw UnimplementedError()), @@ -106,7 +106,7 @@ test/lints/scoped_providers_should_specify_dependencies.dart:182:13 code: scoped_providers_should_specify_dependencies severity: Severity.warning message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:198:7 +test/lints/scoped_providers_should_specify_dependencies.dart:201:7 ```dart .overrideWith(() => throw UnimplementedError()), @@ -121,7 +121,7 @@ test/lints/scoped_providers_should_specify_dependencies.dart:198:7 code: scoped_providers_should_specify_dependencies severity: Severity.warning message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:214:11 +test/lints/scoped_providers_should_specify_dependencies.dart:217:11 ```dart .overrideWith(() => throw UnimplementedError()), @@ -136,7 +136,7 @@ test/lints/scoped_providers_should_specify_dependencies.dart:214:11 code: scoped_providers_should_specify_dependencies severity: Severity.warning message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:233:9 +test/lints/scoped_providers_should_specify_dependencies.dart:236:9 ```dart .overrideWith(() => throw UnimplementedError()), From a179df2e52575e651d2eab2e7c1caf1083ead61b Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Mar 2024 01:18:45 +0100 Subject: [PATCH 266/387] Revert involuntary revert --- .../current/advanced/select.mdx | 9 +++++-- .../advanced/select/select_async/codegen.dart | 24 ------------------- .../advanced/select/select_async/index.ts | 4 ---- .../advanced/select/select_async/raw.dart | 23 ------------------ 4 files changed, 7 insertions(+), 53 deletions(-) delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts delete mode 100644 website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx index 600fcc1ea..e7c8bbd51 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx @@ -5,7 +5,7 @@ title: 성능 최적화하기 import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; import select from "./select/select"; -import selectAsync from "./select/select_async"; +import selectAsync from "/docs/advanced/select/select_async"; 지금까지 살펴본 내용을 통해 이미 모든 기능을 갖춘 애플리케이션을 구축할 수 있습니다. 하지만 성능과 관련하여 궁금한 점이 있을 수 있습니다. @@ -56,4 +56,9 @@ import selectAsync from "./select/select_async"; 이 함수는 비동기 코드에 고유하며, 공급자가 방출한 데이터에 대해 `select` 연산을 수행할 수 있게 해줍니다. 사용법은 `select`와 비슷하지만 대신 `Future`를 반환합니다: - + \ No newline at end of file diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart deleted file mode 100644 index 55b3a9596..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/codegen.dart +++ /dev/null @@ -1,24 +0,0 @@ -// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors, body_might_complete_normally_nullable - -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -part 'codegen.g.dart'; - -class User { - late String firstName, lastName; -} - -@riverpod -FutureOr user(UserRef ref) => User(); - -/* SNIPPET START */ -@riverpod -Object? example(ExampleRef ref) async { - // user를 사용할 수 있을 때까지 기다렸다가 "firstName" 속성만 수신합니다. - final firstName = await ref.watch( - userProvider.selectAsync((it) => it.firstName), - ); - - // TODO use "firstName" to fetch something else -} -/* SNIPPET END */ diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts deleted file mode 100644 index 9d50c6614..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/index.ts +++ /dev/null @@ -1,4 +0,0 @@ -import raw from '!!raw-loader!./raw.dart'; -import codegen from '!!raw-loader!./codegen.dart'; - -export default { raw, codegen }; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart deleted file mode 100644 index 6f3c7ddf9..000000000 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select/select_async/raw.dart +++ /dev/null @@ -1,23 +0,0 @@ -// ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors - -import 'package:flutter_riverpod/flutter_riverpod.dart'; - -class User { - late String firstName, lastName; -} - -final userProvider = FutureProvider( - (ref) => User() - ..firstName = 'John' - ..lastName = 'Doe', -); -/* SNIPPET START */ -final provider = FutureProvider((ref) async { - // Wait for a user to be available, and listen to only the "firstName" property - final firstName = await ref.watch( - userProvider.selectAsync((it) => it.firstName), - ); - - // TODO use "firstName" to fetch something else -}); -/* SNIPPET END */ From 2e2791de5b3e8a3d38fe670fb043f553000d8ba7 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Mar 2024 12:20:43 +0100 Subject: [PATCH 267/387] Improve error message fixes #2425 --- packages/riverpod/lib/src/core/ref.dart | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 7a8f8958f..d813c75fd 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -13,9 +13,14 @@ extension $RefArg on Ref { class UnmountedRefException implements Exception { @override String toString() { - return 'Cannot use a Ref after it has been disposed. ' - ' This typically happens when a provider rebuilt, but the previous "build" was still pending and is still performing operations.' - ' It is generally fine to let this exception be thrown, as it will be caught and handled by Riverpod.'; + return ''' +Cannot use a Ref after it has been disposed. This typically happens if: +- A provider rebuilt, but the previous "build" was still pending and is still performing operations. + You should therefore either use `ref.onDispose` to cancel pending work, or + check `ref.mounted` after async gaps or anything that could invalidate the provider. +- You tried to use Ref inside `onDispose` or other life-cycles. + This is not supported, as the provider is already being disposed. +'''; } } From 0aefb658c7d6a8b757da1056c3a1c735a158a619 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Mar 2024 14:01:22 +0100 Subject: [PATCH 268/387] Update import --- .../docusaurus-plugin-content-docs/current/advanced/select.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx index e7c8bbd51..c5dbdf116 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/advanced/select.mdx @@ -3,7 +3,7 @@ title: 성능 최적화하기 --- import { AutoSnippet } from "../../../../../src/components/CodeSnippet"; -import select from "./select/select"; +import select from "/docs/advanced/select/select"; import selectAsync from "/docs/advanced/select/select_async"; From 3cb83e4395d154709098778f670563be6173b581 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Mar 2024 19:37:20 +0100 Subject: [PATCH 269/387] Remove deprecated members --- packages/flutter_riverpod/CHANGELOG.md | 1 + .../lib/src/core/provider_scope.dart | 64 ++----------------- .../flutter_riverpod/test/framework_test.dart | 48 -------------- ...providers_should_specify_dependencies.dart | 9 --- ...providers_should_specify_dependencies.dart | 45 ------------- 5 files changed, 6 insertions(+), 161 deletions(-) diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md index 4eef83aae..99a3993bb 100644 --- a/packages/flutter_riverpod/CHANGELOG.md +++ b/packages/flutter_riverpod/CHANGELOG.md @@ -1,6 +1,7 @@ ## Unreleased build - Added support for `Ref/ProviderContainer.invalidate(provider, asReload: true)` +- Removed deprecated `@ProviderScope.parent` ## 3.0.0-dev.3 - 2023-11-27 diff --git a/packages/flutter_riverpod/lib/src/core/provider_scope.dart b/packages/flutter_riverpod/lib/src/core/provider_scope.dart index b19da87aa..154127318 100644 --- a/packages/flutter_riverpod/lib/src/core/provider_scope.dart +++ b/packages/flutter_riverpod/lib/src/core/provider_scope.dart @@ -1,4 +1,4 @@ -// ignore_for_file: invalid_use_of_internal_member, deprecated_member_use_from_same_package +// ignore_for_file: invalid_use_of_internal_member part of '../core.dart'; /// {@template riverpod.provider_scope} @@ -75,10 +75,6 @@ class ProviderScope extends StatefulWidget { super.key, this.overrides = const [], this.observers, - @Deprecated( - 'Will be removed in 3.0.0. See https://github.com/rrousselGit/riverpod/issues/3261#issuecomment-1973514033', - ) - this.parent, required this.child, }); @@ -105,37 +101,6 @@ class ProviderScope extends StatefulWidget { return scope.container; } - /// Explicitly override the parent [ProviderContainer] that this [ProviderScope] - /// would be a descendant of. - /// - /// A common use-case is to allow modals to access scoped providers, as they - /// would otherwise be unable to since they would be in a different branch - /// of the widget tree. - /// - /// That can be achieved with: - /// - /// ```dart - /// ElevatedButton( - /// onTap: () { - /// final container = ProviderScope.containerOf(context); - /// showDialog( - /// context: context, - /// builder: (context) { - /// return ProviderScope(parent: container, child: MyModal()); - /// }, - /// ); - /// }, - /// child: Text('show modal'), - /// ) - /// ``` - /// - /// - /// The [parent] variable must never change. - @Deprecated( - 'Will be removed in 3.0.0. See https://github.com/rrousselGit/riverpod/issues/3261#issuecomment-1973514033', - ) - final ProviderContainer? parent; - /// The part of the widget tree that can use Riverpod and has overridden providers. final Widget child; @@ -198,39 +163,20 @@ final class ProviderScopeState extends State { } ProviderContainer? _getParent() { - if (widget.parent != null) { - return widget.parent; - } else { - final scope = context - .getElementForInheritedWidgetOfExactType() - ?.widget as UncontrolledProviderScope?; + final scope = context + .getElementForInheritedWidgetOfExactType() + ?.widget as UncontrolledProviderScope?; - return scope?.container; - } + return scope?.container; } @override void didUpdateWidget(ProviderScope oldWidget) { super.didUpdateWidget(oldWidget); _dirty = true; - - if (oldWidget.parent != widget.parent) { - FlutterError.reportError( - FlutterErrorDetails( - library: 'flutter_riverpod', - exception: UnsupportedError( - 'Changing ProviderScope.parent is not supported', - ), - context: ErrorDescription('while rebuilding ProviderScope'), - ), - ); - } } void _debugAssertParentDidNotChange() { - // didUpdateWidget already takes care of widget.parent change - if (widget.parent != null) return; - final parent = _getParent(); if (parent != _debugParentOwner) { diff --git a/packages/flutter_riverpod/test/framework_test.dart b/packages/flutter_riverpod/test/framework_test.dart index 0a6839404..e644a2172 100644 --- a/packages/flutter_riverpod/test/framework_test.dart +++ b/packages/flutter_riverpod/test/framework_test.dart @@ -154,54 +154,6 @@ void main() { verifyOnly(listener, listener(0, 1)); }); - testWidgets('ProviderScope can receive a custom parent', (tester) async { - final provider = Provider((ref) => 0); - - final container = createContainer( - overrides: [provider.overrideWithValue(42)], - ); - - await tester.pumpWidget( - ProviderScope( - // ignore: deprecated_member_use_from_same_package - parent: container, - child: Consumer( - builder: (context, ref, _) { - return Text( - '${ref.watch(provider)}', - textDirection: TextDirection.ltr, - ); - }, - ), - ), - ); - - expect(find.text('42'), findsOneWidget); - }); - - testWidgets('ProviderScope.parent cannot change', (tester) async { - final container = createContainer(); - final container2 = createContainer(); - - await tester.pumpWidget( - ProviderScope( - // ignore: deprecated_member_use_from_same_package - parent: container, - child: Container(), - ), - ); - - await tester.pumpWidget( - ProviderScope( - // ignore: deprecated_member_use_from_same_package - parent: container2, - child: Container(), - ), - ); - - expect(tester.takeException(), isUnsupportedError); - }); - testWidgets('ref.read works with providers that returns null', (tester) async { final nullProvider = Provider((ref) => null); diff --git a/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart b/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart index bb8b90cf4..cdfc5e7b6 100644 --- a/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart +++ b/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart @@ -103,15 +103,6 @@ class ScopedProvidersShouldSpecifyDependencies extends RiverpodLintRule { bool isProviderScopeScoped( ProviderScopeInstanceCreationExpression expression, ) { - final hasParentParameter = expression.node.argumentList.arguments - .whereType() - // TODO move to riverpod_analyzer_utils - // TODO handle parent:null. - // This might be doable by checking that the expression's - // static type is non-nullable - .any((e) => e.name.label.name == 'parent'); - if (hasParentParameter) return true; - // in runApp(ProviderScope(..)) the direct parent of the ProviderScope // is an ArgumentList. final enclosingExpression = expression.node.parent?.parent; diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.dart index 551049ffc..5c274efa4 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.dart @@ -69,21 +69,6 @@ void main() { child: Container(), ), ); - - flutter.runApp( - ProviderScope( - // ignore: deprecated_member_use - parent: rootContainer, - overrides: [ - scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider - .overrideWith(() => throw UnimplementedError()), - // expect_lint: scoped_providers_should_specify_dependencies - rootProvider.overrideWith((ref) => 0), - ], - child: Container(), - ), - ); } // Regression tests for https://github.com/rrousselGit/riverpod/issues/2340 @@ -119,21 +104,6 @@ void definitelyNotAMain() { child: Container(), ), ); - - flutter.runApp( - ProviderScope( - // ignore: deprecated_member_use - parent: rootContainer, - overrides: [ - scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider - .overrideWith(() => throw UnimplementedError()), - // expect_lint: scoped_providers_should_specify_dependencies - rootProvider.overrideWith((ref) => 0), - ], - child: Container(), - ), - ); } void someTestFunction() { @@ -159,21 +129,6 @@ void someTestFunction() { ), ); - await tester.pumpWidget( - ProviderScope( - // ignore: deprecated_member_use - parent: rootContainer, - overrides: [ - scopedProvider.overrideWith((ref) => 0), - unimplementedScopedProvider - .overrideWith(() => throw UnimplementedError()), - // expect_lint: scoped_providers_should_specify_dependencies - rootProvider.overrideWith((ref) => 0), - ], - child: Container(), - ), - ); - await tester.pumpWidget( Container( child: ProviderScope( From edf2bd828d6948f9b1623efec7f929cc7641bb3e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 10 Mar 2024 19:39:12 +0100 Subject: [PATCH 270/387] Update goldens --- ...viders_should_specify_dependencies_lint.md | 55 ++----------------- 1 file changed, 5 insertions(+), 50 deletions(-) diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/scoped_providers_should_specify_dependencies/scoped_providers_should_specify_dependencies_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/scoped_providers_should_specify_dependencies/scoped_providers_should_specify_dependencies_lint.md index 5d96d7bb0..f00c9aca2 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/scoped_providers_should_specify_dependencies/scoped_providers_should_specify_dependencies_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/scoped_providers_should_specify_dependencies/scoped_providers_should_specify_dependencies_lint.md @@ -31,22 +31,7 @@ test/lints/scoped_providers_should_specify_dependencies.dart:67:9 code: scoped_providers_should_specify_dependencies severity: Severity.warning message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:82:9 - -```dart - .overrideWith(() => throw UnimplementedError()), - // expect_lint: scoped_providers_should_specify_dependencies - >>>rootProvider.overrideWith((ref) => 0)<<<, - ], - child: Container(), -``` - -======= - -code: scoped_providers_should_specify_dependencies -severity: Severity.warning -message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:107:7 +test/lints/scoped_providers_should_specify_dependencies.dart:92:7 ```dart .overrideWith(() => throw UnimplementedError()), @@ -61,37 +46,7 @@ test/lints/scoped_providers_should_specify_dependencies.dart:107:7 code: scoped_providers_should_specify_dependencies severity: Severity.warning message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:132:9 - -```dart - .overrideWith(() => throw UnimplementedError()), - // expect_lint: scoped_providers_should_specify_dependencies - >>>rootProvider.overrideWith((ref) => 0)<<<, - ], - child: Container(), -``` - -======= - -code: scoped_providers_should_specify_dependencies -severity: Severity.warning -message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:171:11 - -```dart - .overrideWith(() => throw UnimplementedError()), - // expect_lint: scoped_providers_should_specify_dependencies - >>>rootProvider.overrideWith((ref) => 0)<<<, - ], - child: Container(), -``` - -======= - -code: scoped_providers_should_specify_dependencies -severity: Severity.warning -message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:185:13 +test/lints/scoped_providers_should_specify_dependencies.dart:140:13 ```dart .overrideWith(() => throw UnimplementedError()), @@ -106,7 +61,7 @@ test/lints/scoped_providers_should_specify_dependencies.dart:185:13 code: scoped_providers_should_specify_dependencies severity: Severity.warning message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:201:7 +test/lints/scoped_providers_should_specify_dependencies.dart:156:7 ```dart .overrideWith(() => throw UnimplementedError()), @@ -121,7 +76,7 @@ test/lints/scoped_providers_should_specify_dependencies.dart:201:7 code: scoped_providers_should_specify_dependencies severity: Severity.warning message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:217:11 +test/lints/scoped_providers_should_specify_dependencies.dart:172:11 ```dart .overrideWith(() => throw UnimplementedError()), @@ -136,7 +91,7 @@ test/lints/scoped_providers_should_specify_dependencies.dart:217:11 code: scoped_providers_should_specify_dependencies severity: Severity.warning message: Providers which are overridden in a non-root ProviderContainer/ProviderScope should specify dependencies. -test/lints/scoped_providers_should_specify_dependencies.dart:236:9 +test/lints/scoped_providers_should_specify_dependencies.dart:191:9 ```dart .overrideWith(() => throw UnimplementedError()), From 80d281dac4aed135cc40d0ad2a98afb28d18daaa Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 11 Mar 2024 10:33:12 +0100 Subject: [PATCH 271/387] Changelogs --- packages/flutter_riverpod/CHANGELOG.md | 7 ++++++ packages/flutter_riverpod/lib/legacy.dart | 1 - .../lib/src/core/consumer.dart | 2 -- .../legacy/change_notifier_provider.dart | 2 -- packages/hooks_riverpod/CHANGELOG.md | 6 +++++ packages/hooks_riverpod/lib/legacy.dart | 1 - packages/riverpod/CHANGELOG.md | 25 +++++++++++++++++++ packages/riverpod/lib/legacy.dart | 2 -- packages/riverpod/lib/riverpod.dart | 6 ----- packages/riverpod/lib/src/core/element.dart | 2 -- .../src/core/provider/notifier_provider.dart | 2 -- .../lib/src/core/provider_container.dart | 4 --- packages/riverpod/lib/src/core/ref.dart | 9 ------- .../lib/src/providers/future_provider.dart | 1 - .../legacy/state_notifier_provider.dart | 1 - .../src/providers/legacy/state_provider.dart | 2 -- .../riverpod/lib/src/providers/provider.dart | 1 - .../new/core/provider_container_test.dart | 6 ----- packages/riverpod/test/new/core/ref_test.dart | 2 -- packages/riverpod_annotation/CHANGELOG.md | 3 +++ .../lib/riverpod_annotation.dart | 1 - .../lib/src/riverpod_generator.dart | 1 - 22 files changed, 41 insertions(+), 46 deletions(-) diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md index 99a3993bb..47e423f2a 100644 --- a/packages/flutter_riverpod/CHANGELOG.md +++ b/packages/flutter_riverpod/CHANGELOG.md @@ -1,5 +1,12 @@ ## Unreleased build +- **Breaking**: Removed all `Ref` subclasses (such `FutureProviderRef`). + Use `Ref` directly instead. + For `FutureProviderRef.future`, migrate to using an `AsyncNotifier`. +- **Breaking**: `ChangeNotifierProvider`, `StateProvider` and `StateNotifierProvider` + are moved out of `package:flutter_riverpod/flutter_riverpod.dart` to + `package:flutter_riverpod/legacy.dart`. +- **Breaking** Some internal utils are no-longer exported. - Added support for `Ref/ProviderContainer.invalidate(provider, asReload: true)` - Removed deprecated `@ProviderScope.parent` diff --git a/packages/flutter_riverpod/lib/legacy.dart b/packages/flutter_riverpod/lib/legacy.dart index a8c23ce8e..29daf07e0 100644 --- a/packages/flutter_riverpod/lib/legacy.dart +++ b/packages/flutter_riverpod/lib/legacy.dart @@ -1,4 +1,3 @@ -// TODO changelog added legacy.dart export 'package:riverpod/legacy.dart'; export 'src/providers/legacy/change_notifier_provider.dart'; diff --git a/packages/flutter_riverpod/lib/src/core/consumer.dart b/packages/flutter_riverpod/lib/src/core/consumer.dart index 5238af707..b32454514 100644 --- a/packages/flutter_riverpod/lib/src/core/consumer.dart +++ b/packages/flutter_riverpod/lib/src/core/consumer.dart @@ -3,7 +3,6 @@ part of '../core.dart'; /// A function that can also listen to providers /// /// See also [Consumer] -// TODO changelog breaking unexported @internal typedef ConsumerBuilder = Widget Function( BuildContext context, @@ -345,7 +344,6 @@ abstract class ConsumerState } /// The [Element] for a [ConsumerStatefulWidget] -// TODO changelog breaking unexported @internal class ConsumerStatefulElement extends StatefulElement implements WidgetRef { /// The [Element] for a [ConsumerStatefulWidget] 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 index 8c99c36be..40775b65d 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -21,8 +21,6 @@ ProviderElementProxy ); } -// TODO changelog breaking: Removed Ref. Use Ref instead - /// Creates a [ChangeNotifier] and exposes its current state. /// /// Combined with [ChangeNotifier], [ChangeNotifierProvider] can be used to manipulate diff --git a/packages/hooks_riverpod/CHANGELOG.md b/packages/hooks_riverpod/CHANGELOG.md index 51319b528..0832650a8 100644 --- a/packages/hooks_riverpod/CHANGELOG.md +++ b/packages/hooks_riverpod/CHANGELOG.md @@ -1,3 +1,9 @@ +## Unreleased build + +- **Breaking**: `ChangeNotifierProvider`, `StateProvider` and `StateNotifierProvider` + are moved out of `package:hooks_riverpod/hooks_riverpod.dart` to + `package:hooks_riverpod/legacy.dart`. + ## 3.0.0-dev.3 - 2023-11-27 - Fix "pending timer" issue inside tests when using `ref.keepAlive()`. diff --git a/packages/hooks_riverpod/lib/legacy.dart b/packages/hooks_riverpod/lib/legacy.dart index 82e642bb3..8bad64e00 100644 --- a/packages/hooks_riverpod/lib/legacy.dart +++ b/packages/hooks_riverpod/lib/legacy.dart @@ -1,2 +1 @@ -// TODO changelog added legacy.dart export 'package:flutter_riverpod/legacy.dart'; diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 66b348ba9..0cbd40061 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -1,8 +1,33 @@ ## Unreleased build +- **Breaking**: It is now a runtime exception to "scope" a provider + that is not specifying `dependencies`. +- **Breaking**: Removed all `Ref` subclasses (such `FutureProviderRef`). + Use `Ref` directly instead. + For `FutureProviderRef.future`, migrate to using an `AsyncNotifier`. +- **Breaking** All ref methods besides "mounted" now throw if used on unmounted refs. +// TODO changelog patch: ref.exists now correct asserts that the ref can use the provider. + +- **Breaking**: `StateProvider` and `StateNotifierProvider` + are moved out of `package:flutter_riverpod/flutter_riverpod.dart` to + `package:flutter_riverpod/legacy.dart`. +- **Breaking** Some internal utils are no-longer exported. - **Breaking** `AsyncValue.value` now returns `null` during errors. - **Breaking** removed `AsyncValue.valueOrNull` (use `.value` instead). - `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. +- 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. +- Added `ProviderContainer.test()`. This is a custom constructor for testing + purpose. It is meant to replace the `createContainer` utility. +- Added `NotifierProvider.overrideWithBuild`, to override `Notifier.build` without + overriding methods of the notifier. +- `Ref.mounted` has been added. It can now be used to check if a provider + was disposed. +- When a provider is rebuilt, a new `Ref` is now created. This avoids + issues where an old build of a provider is still performing work. - Updated `AsyncValue` documentations to use pattern matching. - Added support for `Ref/ProviderContainer.invalidate(provider, asReload: true)` - Fixed a bug when overriding a specific provider of a `family`, combined with `dependencies: [family]` diff --git a/packages/riverpod/lib/legacy.dart b/packages/riverpod/lib/legacy.dart index d9465bf23..f12166f77 100644 --- a/packages/riverpod/lib/legacy.dart +++ b/packages/riverpod/lib/legacy.dart @@ -1,5 +1,3 @@ -// TODO CHANGELOG breaking: Riverpod now only re-exports StateNotifier from pkg:state_notifier. -// for other classes, please add state_notifier as dependency. export 'package:state_notifier/state_notifier.dart' show StateNotifier; export 'src/providers/legacy/state_controller.dart'; diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 9359e1ae8..fed807926 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -41,21 +41,15 @@ export 'src/framework.dart' $ClassProvider, LegacyProviderMixin, ClassProviderElement, - // TODO changelog breaking unexported alreadyInitializedError, - // TODO changelog breaking unexported uninitializedElementError, - // TODO changelog breaking unexported shortHash, - // TODO changelog breaking unexported describeIdentity, CircularDependencyError, $AsyncValueProvider; export 'src/providers/async_notifier.dart' hide $AsyncNotifier, $AsyncNotifierProvider, $AsyncNotifierProviderElement; -// TODO changelog breaking: StateNotifier & co are no-longer exported from pkg:riverpod/riverpod.dart -// Use pkg:riverpod/legacy.dart export 'src/providers/future_provider.dart' hide $FutureProviderElement, $FutureProvider; diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 145fc83f1..1b9e742c1 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -45,7 +45,6 @@ void Function()? debugCanModifyProviders; @optionalTypeArgs abstract class ProviderElementBase implements Node { /// {@macro riverpod.provider_element_base} - // TODO changelog: ProviderElement no-longer takes a provider as parameter but takes a ProviderContainer ProviderElementBase(this.container); static ProviderElementBase? _debugCurrentlyBuildingElement; @@ -62,7 +61,6 @@ abstract class ProviderElementBase implements Node { late final ProviderBase _origin; /// The provider associated with this [ProviderElementBase], after applying overrides. - // TODO changelog ProviderElement.provider is now abstract ProviderBase get provider; /// The [ProviderContainer] that owns this [ProviderElementBase]. diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index 817b1acbd..d12eadf41 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -54,8 +54,6 @@ typedef RunNotifierBuild< // /// } /// } /// ``` -// TODO changelog breaking: Notifiers are now recreated when `Notifier.build` is re-executed. -// This enables using `if (ref.mounted)` inside notifiers. abstract class NotifierBase { Ref? _ref; diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 6bc125664..00d13ebf4 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -132,7 +132,6 @@ class ProviderDirectory implements _PointerBase { ProviderBase provider, { required ProviderContainer currentContainer, }) { - // TODO changelog that provider which don't specify dependencies can't be scoped // TODO throw if a provider is overridden but does not specify dependencies return pointers._upsert( @@ -628,7 +627,6 @@ class ProviderContainer implements Node { List overrides = const [], List? observers, }) { - // TODO changelog final container = ProviderContainer( parent: parent, overrides: overrides, @@ -938,7 +936,6 @@ class ProviderContainer implements Node { /// /// It is safe to call this method multiple times. Subsequent calls will be no-op. /// - /// TODO changelog /// If this container has non-disposed child [ProviderContainer]s (cf `parent`), /// then this method will dispose those children first. /// Therefore, disposing the root [ProviderContainer] the entire graph. @@ -1091,7 +1088,6 @@ typedef SetupOverride = void Function({ /// and maintainability reasons. /// Consider reading about unidirectional data flow to learn about the /// benefits of avoiding circular dependencies. -// TODO changelog: CircularDependencyError is no-longer exported @internal class CircularDependencyError extends Error { CircularDependencyError._(); diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index d813c75fd..5fecbc69b 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -33,19 +33,11 @@ Cannot use a Ref after it has been disposed. This typically happens if: /// - [read] and [watch], two methods that allow a provider to consume other providers. /// - [onDispose], a method that allows performing a task when the provider is destroyed. /// {@endtemplate} -// TODO changelog breaking "ProviderElementBase" no-longer implements Ref -// TODO changelog breaking: AutoDisposeRef and related interfaces are removed. -// Use the non-autodispose variant instead. They now have the same API. -// TODO changelog breaking: All ref methods besides "mounted" now throw if used on unmounted refs. -// TODO changelog patch: ref.exists now correct asserts that the ref can use the provider. base class Ref { /// {@macro riverpod.provider_ref_base} Ref._(this._element); final ProviderElementBase _element; - // TODO changelog breaking: when a provider rebuilds, a new ref is created. - // This means that if the previous "build" didn't stop, using the older ref will now throw. - List? _keepAliveLinks; List? _onChangeSelfListeners; List? _onDisposeListeners; @@ -55,7 +47,6 @@ base class Ref { List? _onRemoveListeners; List? _onErrorSelfListeners; - // TODO changelog minor: Added `Ref.mounted`, similar to `BuildContext.mounted` bool get mounted => _mounted; var _mounted = true; diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 4778b9584..077753102 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -161,7 +161,6 @@ final class FutureProvider /// The element of a [FutureProvider] /// Implementation detail of `riverpod_generator`. Do not use. -// TODO changelog breaking: Removed FutureProviderRef. To migrate ref.future, use an AsyncNotifier and its .future @internal class $FutureProviderElement extends ProviderElementBase> diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index c5f5d65f6..219deb330 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -17,7 +17,6 @@ ProviderElementProxy ); } -// TODO changelog breaking: Removed StateNotifierProviderRef. Use Ref instead /// Creates a [StateNotifier] and exposes its current state. /// /// This provider is used in combination with `package:state_notifier`. diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 608649b6c..a2ff35a9e 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -15,8 +15,6 @@ ProviderElementProxy> _notifier( ); } -// TODO changelog breaking: Removed Ref. Use Ref and [Ref.state=] instead. - /// {@template riverpod.state_provider} /// A provider that exposes a value that can be modified from outside. /// diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index d8e9cad57..ce5d8abc3 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -13,7 +13,6 @@ base mixin $Provider on ProviderBase { StateT create(RefT ref); } -// TODO changelog ProviderRef was removed. Used Ref directly /// {@macro riverpod.provider} base class Provider extends $FunctionalProvider with $Provider>, LegacyProviderMixin { diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index 144b80dc6..12c14872c 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -999,8 +999,6 @@ void main() { group('constructor', () { test('throws if trying to scope a provider/family with no dependencies', () { - // TODO changelog - final provider = Provider((_) => 0); final family = Provider.family((ref, _) => 0); @@ -1039,8 +1037,6 @@ void main() { }); test('throws if "parent" is disposed', () { - // TODO changelog - final root = ProviderContainer(); root.dispose(); @@ -1099,7 +1095,6 @@ void main() { test( 'throws if the same provider is overridden twice in the same container', () { - // TODO changelog final provider = Provider((ref) => 0); expect( @@ -1116,7 +1111,6 @@ void main() { test( 'throws if the same family is overridden twice in the same container', () { - // TODO changelog final provider = Provider.family((ref, id) => 0); expect( diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart index c9cc4fd83..b04de5c8f 100644 --- a/packages/riverpod/test/new/core/ref_test.dart +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -395,7 +395,6 @@ void main() { final call = entry.value; test('Using `$method` when passing a provider', () { - // TODO changelog "reading a provider that is not part of its dependencies is now forbidden" final transitiveDep = Provider((ref) => 0, dependencies: const []); final dep = Provider((ref) => 0, dependencies: [transitiveDep]); final depFamily = Provider.family( @@ -460,7 +459,6 @@ void main() { final call = entry.value; test('Using `$method` when passing a listenable', () async { - // TODO changelog "reading a provider that is not part of its dependencies is now forbidden" final transitiveDep = FutureProvider( (ref) => 0, dependencies: const [], diff --git a/packages/riverpod_annotation/CHANGELOG.md b/packages/riverpod_annotation/CHANGELOG.md index aa407b761..c98411319 100644 --- a/packages/riverpod_annotation/CHANGELOG.md +++ b/packages/riverpod_annotation/CHANGELOG.md @@ -1,5 +1,8 @@ ## Unreleased build +- **Breaking** various `package:riverpod` objects are no-longer exported. + If you wish to use providers by hand, you will have to separately import + `package:riverpod/riverpod.dart`. - Made `@Riverpod` final - Added `@Dependencies([...])`, for lint purposes. This is similar to `@Riverpod(dependencies: [...])`, but is applied on diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index b713a0927..3f5ca603b 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -9,7 +9,6 @@ export 'dart:async' show FutureOr; export 'package:riverpod/src/internals.dart' show // General stuff - // TODO changelog changed exports, ProviderContainer, Family, ProviderOrFamily, diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index 84f278dd0..fda577fb0 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -52,7 +52,6 @@ class RiverpodInvalidGenerationSourceError super.todo = '', super.element, AstNode? astNode, - // TODO changelog bumped source_gen 0.14.0 to reprot AstNodes }) : super(node: astNode); } From 1138026a7083f5a0266d07dba92b7f4dd2bba2f2 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 11 Mar 2024 10:45:46 +0100 Subject: [PATCH 272/387] Use 3.0.0 as min version --- benchmarks/pubspec.yaml | 2 +- packages/flutter_riverpod/example/pubspec.yaml | 2 +- packages/hooks_riverpod/example/pubspec.yaml | 2 +- packages/riverpod/example/pubspec.yaml | 2 +- packages/riverpod_analyzer_utils/pubspec.yaml | 2 +- packages/riverpod_analyzer_utils_tests/pubspec.yaml | 2 +- packages/riverpod_annotation/pubspec.yaml | 2 +- packages/riverpod_graph/pubspec.yaml | 2 +- .../test/integration/addition/golden/pubspec.yaml | 2 +- .../test/integration/consumer_widget/golden/pubspec.yaml | 2 +- packages/riverpod_lint/pubspec.yaml | 2 +- pubspec.yaml | 2 +- website/pubspec.yaml | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/benchmarks/pubspec.yaml b/benchmarks/pubspec.yaml index 99dfed423..c35a63676 100644 --- a/benchmarks/pubspec.yaml +++ b/benchmarks/pubspec.yaml @@ -4,7 +4,7 @@ publish_to: 'none' # Remove this line if you wish to publish to pub.dev version: 1.0.0+1 environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0<4.0.0" dependencies: flutter: diff --git a/packages/flutter_riverpod/example/pubspec.yaml b/packages/flutter_riverpod/example/pubspec.yaml index 4785b0a0a..a2bf20f97 100644 --- a/packages/flutter_riverpod/example/pubspec.yaml +++ b/packages/flutter_riverpod/example/pubspec.yaml @@ -4,7 +4,7 @@ description: A new Flutter project. publish_to: "none" environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0<4.0.0" dependencies: flutter: diff --git a/packages/hooks_riverpod/example/pubspec.yaml b/packages/hooks_riverpod/example/pubspec.yaml index a2dff9a3a..9b3ff0a6a 100644 --- a/packages/hooks_riverpod/example/pubspec.yaml +++ b/packages/hooks_riverpod/example/pubspec.yaml @@ -4,7 +4,7 @@ description: A new Flutter project. publish_to: "none" environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0<4.0.0" flutter: ">=1.17.0" dependencies: diff --git a/packages/riverpod/example/pubspec.yaml b/packages/riverpod/example/pubspec.yaml index 908a5e614..fc3fef851 100644 --- a/packages/riverpod/example/pubspec.yaml +++ b/packages/riverpod/example/pubspec.yaml @@ -2,7 +2,7 @@ name: riverpod_example publish_to: "none" environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0<4.0.0" dependencies: crypto: ^3.0.0 diff --git a/packages/riverpod_analyzer_utils/pubspec.yaml b/packages/riverpod_analyzer_utils/pubspec.yaml index 16d26b711..f4163815e 100644 --- a/packages/riverpod_analyzer_utils/pubspec.yaml +++ b/packages/riverpod_analyzer_utils/pubspec.yaml @@ -7,7 +7,7 @@ funding: version: 1.0.0-dev.1 environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0<4.0.0" dependencies: analyzer: ">=5.12.0 <7.0.0" diff --git a/packages/riverpod_analyzer_utils_tests/pubspec.yaml b/packages/riverpod_analyzer_utils_tests/pubspec.yaml index 4b2cc60e2..2327173ed 100644 --- a/packages/riverpod_analyzer_utils_tests/pubspec.yaml +++ b/packages/riverpod_analyzer_utils_tests/pubspec.yaml @@ -3,7 +3,7 @@ description: A sample command-line application. publish_to: none environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0<4.0.0" dependencies: analyzer: ">=5.12.0 <7.0.0" diff --git a/packages/riverpod_annotation/pubspec.yaml b/packages/riverpod_annotation/pubspec.yaml index 520b6f0a9..857e89e84 100644 --- a/packages/riverpod_annotation/pubspec.yaml +++ b/packages/riverpod_annotation/pubspec.yaml @@ -7,7 +7,7 @@ funding: - https://github.com/sponsors/rrousselGit/ environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0<4.0.0" dependencies: meta: ^1.7.0 diff --git a/packages/riverpod_graph/pubspec.yaml b/packages/riverpod_graph/pubspec.yaml index 57c3ee7ec..5e4902814 100644 --- a/packages/riverpod_graph/pubspec.yaml +++ b/packages/riverpod_graph/pubspec.yaml @@ -8,7 +8,7 @@ funding: - https://github.com/sponsors/rrousselGit/ environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0<4.0.0" dependencies: analyzer: ">=5.12.0 <7.0.0" diff --git a/packages/riverpod_graph/test/integration/addition/golden/pubspec.yaml b/packages/riverpod_graph/test/integration/addition/golden/pubspec.yaml index c218db294..96e988906 100644 --- a/packages/riverpod_graph/test/integration/addition/golden/pubspec.yaml +++ b/packages/riverpod_graph/test/integration/addition/golden/pubspec.yaml @@ -2,7 +2,7 @@ name: riverpod_graph_golden_addition publish_to: none environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0<4.0.0" dependencies: riverpod: diff --git a/packages/riverpod_graph/test/integration/consumer_widget/golden/pubspec.yaml b/packages/riverpod_graph/test/integration/consumer_widget/golden/pubspec.yaml index 0b6fd2f88..d2dca93c0 100644 --- a/packages/riverpod_graph/test/integration/consumer_widget/golden/pubspec.yaml +++ b/packages/riverpod_graph/test/integration/consumer_widget/golden/pubspec.yaml @@ -4,7 +4,7 @@ description: A new Flutter project. publish_to: "none" environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0<4.0.0" flutter: ">=1.17.0" dependencies: diff --git a/packages/riverpod_lint/pubspec.yaml b/packages/riverpod_lint/pubspec.yaml index dfc3e1390..1996b49cb 100644 --- a/packages/riverpod_lint/pubspec.yaml +++ b/packages/riverpod_lint/pubspec.yaml @@ -8,7 +8,7 @@ funding: - https://github.com/sponsors/rrousselGit/ environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0<4.0.0" dependencies: analyzer: ">=6.0.0 <7.0.0" diff --git a/pubspec.yaml b/pubspec.yaml index 48beff9f7..3a82b4933 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -2,7 +2,7 @@ name: melos_root publish_to: none environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0<4.0.0" dev_dependencies: melos: ^3.0.0 diff --git a/website/pubspec.yaml b/website/pubspec.yaml index d1dd58a9c..6482270e5 100644 --- a/website/pubspec.yaml +++ b/website/pubspec.yaml @@ -2,7 +2,7 @@ name: website_snippets publish_to: "none" environment: - sdk: ">=3.0.0-0.0-dev <4.0.0" + sdk: ">=3.0.0<4.0.0" dependencies: collection: ^1.15.0 From e3b358ec4f34d7002c5463acfa35c7d3e1588e68 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 11 Mar 2024 16:06:52 +0100 Subject: [PATCH 273/387] Refactor --- .../legacy/change_notifier_provider.dart | 1 - .../riverpod/lib/src/common/listenable.dart | 13 ++-- packages/riverpod/lib/src/common/result.dart | 48 +------------- packages/riverpod/lib/src/core/element.dart | 64 +++++++++---------- .../lib/src/core/modifiers/future.dart | 13 ++-- .../lib/src/core/modifiers/select.dart | 36 ++++++----- .../lib/src/core/modifiers/select_async.dart | 11 ++-- .../lib/src/core/provider_container.dart | 9 +-- .../lib/src/core/provider_subscription.dart | 10 +-- .../src/core/proxy_provider_listenable.dart | 16 ++--- packages/riverpod/lib/src/core/ref.dart | 3 - .../integration/generated/generated_test.dart | 1 - .../avoid_global_provider_container.dart | 32 ---------- 13 files changed, 84 insertions(+), 173 deletions(-) delete mode 100644 packages/riverpod_lint/lib/src/lints/avoid_global_provider_container.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 index 40775b65d..575a58a41 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -176,7 +176,6 @@ class ChangeNotifierProviderElement () => provider._createFn(ref), ); - // TODO test requireState, as ref.read(p) is expected to throw if notifier creation failed final notifier = notifierResult.requireState; setStateResult(ResultData(notifier)); diff --git a/packages/riverpod/lib/src/common/listenable.dart b/packages/riverpod/lib/src/common/listenable.dart index ebaa0203f..1c915d08c 100644 --- a/packages/riverpod/lib/src/common/listenable.dart +++ b/packages/riverpod/lib/src/common/listenable.dart @@ -38,10 +38,15 @@ class ProxyElementValueListenable extends _ValueListenable { set result(Result? value) { final previous = _result; _result = value; - value?.when( - data: (newValue) => _notifyValue(previous?.stateOrNull, newValue), - error: _notifyError, - ); + + switch (value) { + case null: + break; + case ResultData(): + _notifyValue(previous?.stateOrNull, value.state); + case ResultError(): + _notifyError(value.error, value.stackTrace); + } } /// Updates the [result] of this [ProxyElementValueListenable] without invoking listeners. diff --git a/packages/riverpod/lib/src/common/result.dart b/packages/riverpod/lib/src/common/result.dart index fba7523f4..bb9d9a938 100644 --- a/packages/riverpod/lib/src/common/result.dart +++ b/packages/riverpod/lib/src/common/result.dart @@ -3,7 +3,7 @@ import 'package:meta/meta.dart'; /// A T|Error union type. @immutable @internal -abstract class Result { +sealed class Result { /// The data case // coverage:ignore-start factory Result.data(State state) = ResultData; @@ -32,20 +32,6 @@ abstract class Result { /// The state if this is a [ResultData], throws otherwise. State get requireState; - - // TODO remove when migrating to Dart 3 - /// Returns the result of calling [data] if this is a [ResultData] or [error] - R map({ - required R Function(ResultData data) data, - required R Function(ResultError) error, - }); - - // TODO remove when migrating to Dart 3 - /// Returns the result of calling [data] if this is a [ResultData] or [error] - R when({ - required R Function(State data) data, - required R Function(Object error, StackTrace stackTrace) error, - }); } /// The data case @@ -66,22 +52,6 @@ class ResultData implements Result { @override State get requireState => state; - @override - R map({ - required R Function(ResultData data) data, - required R Function(ResultError) error, - }) { - return data(this); - } - - @override - R when({ - required R Function(State data) data, - required R Function(Object error, StackTrace stackTrace) error, - }) { - return data(state); - } - @override bool operator ==(Object other) => other is ResultData && @@ -113,22 +83,6 @@ class ResultError implements Result { @override State get requireState => Error.throwWithStackTrace(error, stackTrace); - @override - R map({ - required R Function(ResultData data) data, - required R Function(ResultError) error, - }) { - return error(this); - } - - @override - R when({ - required R Function(State data) data, - required R Function(Object error, StackTrace stackTrace) error, - }) { - return error(this.error, stackTrace); - } - @override bool operator ==(Object other) => other is ResultError && diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 1b9e742c1..ef7fc3a93 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -166,10 +166,13 @@ This could mean a few things: final state = stateResult; if (state == null) throw StateError(uninitializedError); - return state.when( - error: throwErrorWithCombinedStackTrace, - data: (data) => data, - ); + return switch (state) { + ResultError() => throwErrorWithCombinedStackTrace( + state.error, + state.stackTrace, + ), + ResultData() => state.state, + }; } /// Called when a provider is rebuilt. Used for providers to not notify their @@ -204,8 +207,8 @@ This could mean a few things: final ref = this.ref = Ref._(this); buildState(ref); - _stateResult!.map( - data: (newState) { + switch (_stateResult!) { + case final ResultData newState: final onChangeSelfListeners = ref._onChangeSelfListeners; if (onChangeSelfListeners != null) { for (var i = 0; i < onChangeSelfListeners.length; i++) { @@ -225,8 +228,8 @@ This could mean a few things: container, ); } - }, - error: (newState) { + + case final ResultError newState: final onErrorSelfListeners = ref._onErrorSelfListeners; if (onErrorSelfListeners != null) { for (var i = 0; i < onErrorSelfListeners.length; i++) { @@ -255,8 +258,7 @@ This could mean a few things: container, ); } - }, - ); + } } /// Called when the override of a provider changes. @@ -428,8 +430,8 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu final previousState = previousStateResult?.stateOrNull; // listenSelf listeners do not respect updateShouldNotify - newState.map( - data: (newState) { + switch (newState) { + case final ResultData newState: final onChangeSelfListeners = ref?._onChangeSelfListeners; if (onChangeSelfListeners != null) { for (var i = 0; i < onChangeSelfListeners.length; i++) { @@ -440,8 +442,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ); } } - }, - error: (newState) { + case final ResultError newState: final onErrorSelfListeners = ref?._onErrorSelfListeners; if (onErrorSelfListeners != null) { for (var i = 0; i < onErrorSelfListeners.length; i++) { @@ -452,8 +453,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ); } } - }, - ); + } if (checkUpdateShouldNotify && previousStateResult != null && @@ -467,8 +467,8 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } final listeners = _dependents?.toList(growable: false); - newState.map( - data: (newState) { + switch (newState) { + case final ResultData newState: if (listeners != null) { for (var i = 0; i < listeners.length; i++) { final listener = listeners[i]; @@ -481,8 +481,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } } } - }, - error: (newState) { + case final ResultError newState: if (listeners != null) { for (var i = 0; i < listeners.length; i++) { final listener = listeners[i]; @@ -495,8 +494,8 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } } } - }, - ); + default: + } for (var i = 0; i < _providerDependents.length; i++) { _providerDependents[i].invalidateSelf(asReload: true); @@ -513,18 +512,15 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } for (final observer in container.observers) { - newState.map( - data: (_) {}, - error: (newState) { - runQuaternaryGuarded( - observer.providerDidFail, - origin, - newState.error, - newState.stackTrace, - container, - ); - }, - ); + if (newState is ResultError) { + runQuaternaryGuarded( + observer.providerDidFail, + origin, + newState.error, + newState.stackTrace, + container, + ); + } } } diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index a3d6ea64f..a62af253c 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -212,7 +212,6 @@ mixin FutureModifierClassElement< /// Mixin to help implement logic for listening to [Future]s/[Stream]s and setup /// `provider.future` + convert the object into an [AsyncValue]. @internal -// TODO merge with ProviderElementBase mixin FutureModifierElement on ProviderElementBase> { /// A default implementation for [ProviderElementBase.updateShouldNotify]. static bool handleUpdateShouldNotify( @@ -545,14 +544,14 @@ extension on Stream { }, onDone: () { if (result != null) { - result!.map( - data: (result) => completer.complete(result.state), - error: (result) { + switch (result!) { + case ResultData(:final state): + completer.complete(state); + case ResultError(:final error, :final stackTrace): // TODO: should this be reported to the zone? completer.future.ignore(); - completer.completeError(result.error, result.stackTrace); - }, - ); + completer.completeError(error, stackTrace); + } } else { // The error happens after the associated provider is disposed. // As such, it's normally never read. Reporting this error as uncaught diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index d74341407..e4b9dabce 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -43,11 +43,12 @@ class _ProviderSelector with ProviderListenable { if (kDebugMode) _debugIsRunningSelector = true; try { - return value.map( - data: (data) => Result.data(selector(data.state)), + return switch (value) { + ResultData(:final state) => Result.data(selector(state)), // TODO test - error: (error) => Result.error(error.error, error.stackTrace), - ); + ResultError(:final error, :final stackTrace) => + Result.error(error, stackTrace), + }; } catch (err, stack) { // TODO test return Result.error(err, stack); @@ -71,16 +72,16 @@ class _ProviderSelector with ProviderListenable { onChange(newSelectedValue); // TODO test handle exception in listener - newSelectedValue.map( - data: (data) { + switch (newSelectedValue) { + case ResultData(:final state): listener( // TODO test from error lastSelectedValue.stateOrNull, - data.state, + state, ); - }, - error: (error) => onError(error.error, error.stackTrace), - ); + case ResultError(:final error, :final stackTrace): + onError(error, stackTrace); + } } } @@ -124,13 +125,14 @@ class _ProviderSelector with ProviderListenable { node, sub, () { - return lastSelectedValue.map( - data: (data) => data.state, - error: (error) => throwErrorWithCombinedStackTrace( - error.error, - error.stackTrace, - ), - ); + return switch (lastSelectedValue) { + ResultData(:final state) => state, + ResultError(:final error, :final stackTrace) => + throwErrorWithCombinedStackTrace( + error, + stackTrace, + ), + }; }, ); } diff --git a/packages/riverpod/lib/src/core/modifiers/select_async.dart b/packages/riverpod/lib/src/core/modifiers/select_async.dart index 4b0a06732..a358d968e 100644 --- a/packages/riverpod/lib/src/core/modifiers/select_async.dart +++ b/packages/riverpod/lib/src/core/modifiers/select_async.dart @@ -94,24 +94,21 @@ class _AsyncSelector with ProviderListenable> { } final newSelectedValue = _select(value.value); - - newSelectedValue.map( - data: (newSelectedValue) { + switch (newSelectedValue) { + case ResultData(): if (newSelectedValue != lastSelectedValue) { emitData( newSelectedValue.state, callListeners: callListeners, ); } - }, - error: (newSelectedValue) { + case ResultError(): emitError( newSelectedValue.error, newSelectedValue.stackTrace, callListeners: callListeners, ); - }, - ); + } lastSelectedValue = newSelectedValue; }, diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 00d13ebf4..7582c1398 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -458,12 +458,7 @@ class ProviderPointerManager { final _familyPointers = familyPointers[family]; if (_familyPointers == null) return const []; - return _familyPointers.pointers.values.map((e) { - final element = e.element; - // TODO debugAddDependency(element, debugDependentSource: debugDependentSource); - - return element; - }).whereNotNull(); + return _familyPointers.pointers.values.map((e) => e.element).whereNotNull(); } /// Remove a provider from this container. @@ -472,8 +467,6 @@ class ProviderPointerManager { /// /// Returns the associated pointer, even if it was not removed. ProviderPointer? remove(ProviderBase provider) { - // TODO remove in all containers - final directory = readDirectory(provider); if (directory == null) return null; diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index e86028ac4..faadb88ac 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -89,8 +89,10 @@ void _handleFireImmediately( required void Function(StateT? previous, StateT current) listener, required void Function(Object error, StackTrace stackTrace) onError, }) { - currentState.map( - data: (data) => runBinaryGuarded(listener, null, data.state), - error: (error) => runBinaryGuarded(onError, error.error, error.stackTrace), - ); + switch (currentState) { + case ResultData(): + runBinaryGuarded(listener, null, currentState.state); + case ResultError(): + runBinaryGuarded(onError, currentState.error, currentState.stackTrace); + } } diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index a553c9d7e..9a3fe62e0 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -97,16 +97,16 @@ class ProviderElementProxy final notifier = _lense(element); if (fireImmediately) { - notifier.result?.when( - data: (data) { - runBinaryGuarded(listener, null, data); - }, - error: (err, stack) { + switch (notifier.result) { + case null: + break; + case final ResultData data: + runBinaryGuarded(listener, null, data.state); + case final ResultError error: if (onError != null) { - runBinaryGuarded(onError, err, stack); + runBinaryGuarded(onError, error.error, error.stackTrace); } - }, - ); + } } final removeListener = notifier.addListener( diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 5fecbc69b..3933c6563 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -610,9 +610,6 @@ final = Provider(dependencies: []); void Function(StateT? previous, StateT next) listener, { void Function(Object error, StackTrace stackTrace)? onError, }) { - // TODO do we want to expose a way to close the subscription? - // TODO do we want a fireImmediately? - _onChangeSelfListeners ??= []; _onChangeSelfListeners!.add(listener); diff --git a/packages/riverpod_graph/test/integration/generated/generated_test.dart b/packages/riverpod_graph/test/integration/generated/generated_test.dart index 90b6897fd..08327553a 100644 --- a/packages/riverpod_graph/test/integration/generated/generated_test.dart +++ b/packages/riverpod_graph/test/integration/generated/generated_test.dart @@ -3,7 +3,6 @@ import 'package:test_process/test_process.dart'; void main() { group('mermaid format', () { - // TODO(ValentinVignal): Support the generated families. test('It should log the structure of the generated project', () async { final process = await TestProcess.start( 'dart', diff --git a/packages/riverpod_lint/lib/src/lints/avoid_global_provider_container.dart b/packages/riverpod_lint/lib/src/lints/avoid_global_provider_container.dart deleted file mode 100644 index f57e352ed..000000000 --- a/packages/riverpod_lint/lib/src/lints/avoid_global_provider_container.dart +++ /dev/null @@ -1,32 +0,0 @@ -import 'package:analyzer/error/listener.dart'; -import 'package:custom_lint_builder/custom_lint_builder.dart'; -import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; - -class AvoidGlobalProviderContainer extends DartLintRule { - const AvoidGlobalProviderContainer() : super(code: _code); - - static const _code = LintCode( - name: 'avoid_global_provider_container', - problemMessage: - 'ProviderContainer instances should not be accessible globally.', - ); - - @override - void run( - CustomLintResolver resolver, - ErrorReporter reporter, - CustomLintContext context, - ) { - // TODO release or delete - context.registry.addInstanceCreationExpression((node) { - // If there is a parameterElement it means we are not declaring a variable - if (node.staticParameterElement != null) return; - - // Check that the object created is indeed a ProviderContainer - final type = node.staticType; - if (type == null || !providerContainerType.isExactlyType(type)) { - return; - } - }); - } -} From faad87b201dc3ded248333d5798b6049cb4126d4 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 13 Mar 2024 20:31:56 +0100 Subject: [PATCH 274/387] Remove createContainer in flutter_riverpod --- .../legacy/change_notifier_provider.dart | 2 +- ...dispose_change_notifier_provider_test.dart | 6 +- .../test/consumer_listen_test.dart | 20 ++-- .../flutter_riverpod/test/consumer_test.dart | 2 +- .../flutter_riverpod/test/framework_test.dart | 14 +-- .../test/future_provider_test.dart | 2 +- .../flutter_riverpod/test/listen_test.dart | 4 +- ...dispose_change_notifier_provider_test.dart | 25 ++--- .../change_notifier_provider_test.dart | 94 +++++-------------- ...dispose_change_notifier_provider_test.dart | 15 +-- .../family_change_notifier_provider_test.dart | 19 ++-- packages/flutter_riverpod/test/utils.dart | 15 --- 12 files changed, 77 insertions(+), 141 deletions(-) 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 index 575a58a41..a9057a5ae 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -200,7 +200,7 @@ class ChangeNotifierProviderElement final notifier = _notifierNotifier.result?.stateOrNull; if (notifier != null) { // TODO test ChangeNotifier.dispose is guarded - runGuarded(notifier.dispose); + notifier.dispose(); } _notifierNotifier.result = null; } diff --git a/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart index aaec9e601..d814b441e 100644 --- a/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart @@ -8,7 +8,7 @@ import 'utils.dart'; void main() { test('auto-dispose notifier when stop listening', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final onDispose = OnDisposeMock(); final provider = ChangeNotifierProvider.autoDispose((ref) { ref.onDispose(onDispose.call); @@ -31,7 +31,7 @@ void main() { }); test('family', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = ChangeNotifierProvider.autoDispose .family, int>((ref, value) { return ValueNotifier(value); @@ -70,7 +70,7 @@ void main() { final provider = ChangeNotifierProvider.autoDispose((ref) { return ref.watch(dep) == 0 ? notifier : notifier2; }); - final container = createContainer(); + final container = ProviderContainer.test(); addTearDown(container.dispose); var callCount = 0; diff --git a/packages/flutter_riverpod/test/consumer_listen_test.dart b/packages/flutter_riverpod/test/consumer_listen_test.dart index fc6cbbfa9..550de75c4 100644 --- a/packages/flutter_riverpod/test/consumer_listen_test.dart +++ b/packages/flutter_riverpod/test/consumer_listen_test.dart @@ -12,7 +12,7 @@ void main() { final dep = StateProvider((ref) => 0); final provider = Provider((ref) => ref.watch(dep)); - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener(); await tester.pumpWidget( @@ -48,7 +48,7 @@ void main() { }); testWidgets('can mark parents as dirty during onChange', (tester) async { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = StateProvider((ref) => 0); final onChange = Listener(); @@ -80,7 +80,7 @@ void main() { testWidgets('calls onChange synchronously if possible', (tester) async { final provider = StateProvider((ref) => 0); final onChange = Listener(); - final container = createContainer(); + final container = ProviderContainer.test(); await tester.pumpWidget( UncontrolledProviderScope( @@ -112,7 +112,7 @@ void main() { final provider = StateProvider((ref) => 0); final isEven = Provider((ref) => ref.watch(provider).isEven); final onChange = Listener(); - final container = createContainer(); + final container = ProviderContainer.test(); await tester.pumpWidget( UncontrolledProviderScope( @@ -141,7 +141,7 @@ void main() { testWidgets('closes the subscription on dispose', (tester) async { final provider = StateProvider((ref) => 0); final onChange = Listener(); - final container = createContainer(); + final container = ProviderContainer.test(); await tester.pumpWidget( UncontrolledProviderScope( @@ -164,7 +164,7 @@ void main() { testWidgets('closes the subscription on provider change', (tester) async { final provider = StateProvider.family((ref, _) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); await tester.pumpWidget( UncontrolledProviderScope( @@ -200,7 +200,7 @@ void main() { testWidgets('listen to the new provider on provider change', (tester) async { final provider = StateProvider.family((ref, _) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); final onChange = Listener(); await tester.pumpWidget( @@ -240,10 +240,10 @@ void main() { testWidgets('supports Changing the ProviderContainer', (tester) async { final provider = Provider((ref) => 0); final onChange = Listener(); - final container = createContainer( + final container = ProviderContainer.test( overrides: [provider.overrideWithValue(0)], ); - final container2 = createContainer( + final container2 = ProviderContainer.test( overrides: [provider.overrideWithValue(0)], ); @@ -286,7 +286,7 @@ void main() { testWidgets('supports overriding Providers', (tester) async { final provider = Provider((ref) => 0); final onChange = Listener(); - final container = createContainer( + final container = ProviderContainer.test( overrides: [provider.overrideWithValue(42)], ); diff --git a/packages/flutter_riverpod/test/consumer_test.dart b/packages/flutter_riverpod/test/consumer_test.dart index be4da69fb..95d61bbbb 100644 --- a/packages/flutter_riverpod/test/consumer_test.dart +++ b/packages/flutter_riverpod/test/consumer_test.dart @@ -453,7 +453,7 @@ void main() { final provider = StateNotifierProvider((_) => notifier); final computed = Provider((ref) => !ref.watch(provider).isNegative); var buildCount = 0; - final container = createContainer(); + final container = ProviderContainer.test(); await tester.pumpWidget( UncontrolledProviderScope( diff --git a/packages/flutter_riverpod/test/framework_test.dart b/packages/flutter_riverpod/test/framework_test.dart index e644a2172..71006af17 100644 --- a/packages/flutter_riverpod/test/framework_test.dart +++ b/packages/flutter_riverpod/test/framework_test.dart @@ -221,7 +221,7 @@ void main() { }; final provider = StateProvider((ref) => 0); - final container = createContainer(); + final container = ProviderContainer.test(); // using runZonedGuarded as StateNotifier will emit an handleUncaughtError // if a listener threw @@ -246,7 +246,7 @@ void main() { testWidgets('ref.watch within a build method can flush providers', (tester) async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = Provider((ref) => ref.watch(dep)); @@ -280,8 +280,8 @@ void main() { testWidgets('UncontrolledProviderScope gracefully handles vsync', (tester) async { - final container = createContainer(); - final container2 = createContainer(parent: container); + final container = ProviderContainer.test(); + final container2 = ProviderContainer.test(parent: container); expect(container.scheduler.flutterVsyncs, isEmpty); @@ -367,7 +367,7 @@ void main() { testWidgets( 'UncontrolledProviderScope gracefully handles debugCanModifyProviders', (tester) async { - final container = createContainer(); + final container = ProviderContainer.test(); expect(debugCanModifyProviders, null); @@ -437,7 +437,7 @@ void main() { // (tester) async { // final provider = FutureProvider((ref) async => 42); // late WidgetRef ref; - // final container = createContainer(overrides: [ + // final container = ProviderContainer.test(overrides: [ // provider.overrideWithValue(const AsyncValue.data(42)), // ]); @@ -758,7 +758,7 @@ void main() { return 0; }); - final container = createContainer(); + final container = ProviderContainer.test(); final key = GlobalKey(); await tester.pumpWidget( diff --git a/packages/flutter_riverpod/test/future_provider_test.dart b/packages/flutter_riverpod/test/future_provider_test.dart index f0fb81628..4d07c518b 100644 --- a/packages/flutter_riverpod/test/future_provider_test.dart +++ b/packages/flutter_riverpod/test/future_provider_test.dart @@ -10,7 +10,7 @@ import 'utils.dart'; void main() { test('SynchronousFuture', () { final futureProvider = FutureProvider((_) => SynchronousFuture(42)); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(futureProvider), const AsyncValue.data(42)); }); diff --git a/packages/flutter_riverpod/test/listen_test.dart b/packages/flutter_riverpod/test/listen_test.dart index 70daa3e5d..5b0bb4b59 100644 --- a/packages/flutter_riverpod/test/listen_test.dart +++ b/packages/flutter_riverpod/test/listen_test.dart @@ -155,7 +155,7 @@ void main() { group('WidgetRef.listen', () { testWidgets('expose previous and new value on change', (tester) async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateNotifierProvider, int>( (ref) => StateController(0), ); @@ -181,7 +181,7 @@ void main() { testWidgets( 'when using selectors, `previous` is the latest notification instead of latest event', (tester) async { - final container = createContainer(); + final container = ProviderContainer.test(); final dep = StateNotifierProvider, int>( (ref) => StateController(0), ); diff --git a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart index 108ad0ed3..042df1a4b 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart @@ -10,7 +10,7 @@ import '../../utils.dart'; void main() { group('ChangeNotifierProvider.autoDispose', () { test('support null ChangeNotifier', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = ChangeNotifierProvider.autoDispose?>( (ref) => null, ); @@ -22,7 +22,7 @@ void main() { }); test('can read and set current ChangeNotifier', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); late Ref> ref; final provider = @@ -42,7 +42,7 @@ void main() { final provider = ChangeNotifierProvider.autoDispose>( (ref) => ValueNotifier(initialValue), ); - final container = createContainer(); + final container = ProviderContainer.test(); container.listen(provider.notifier, (prev, value) {}); @@ -57,7 +57,7 @@ void main() { test('can be refreshed', () async { var result = ValueNotifier(0); - final container = createContainer(); + final container = ProviderContainer.test(); final provider = ChangeNotifierProvider.autoDispose((ref) => result); expect(container.read(provider), result); @@ -76,8 +76,9 @@ void main() { (ref) => ValueNotifier(0), dependencies: const [], ); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider.notifier).value, 0); expect(container.read(provider).value, 0); @@ -94,8 +95,8 @@ void main() { // test('when using provider.overrideWithValue', () { // final provider = // ChangeNotifierProvider.autoDispose((ref) => ValueNotifier(0)); - // final root = createContainer(); - // final container = createContainer(parent: root, overrides: [ + // final root = ProviderContainer.test(); + // final container = ProviderContainer.test(parent: root, overrides: [ // provider.overrideWithValue(ValueNotifier(42)), // ]); @@ -118,8 +119,8 @@ void main() { (ref) => ValueNotifier(0), dependencies: const [], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref) => ValueNotifier(42)), @@ -145,8 +146,8 @@ void main() { (ref) => ValueNotifier(ref.watch(dep)), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); diff --git a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart index 47fecb0a2..44db83447 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart @@ -15,7 +15,7 @@ void main() { (ref) => ValueNotifier(0), ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith( (Ref> ref) => ValueNotifier(42), @@ -38,7 +38,7 @@ void main() { ChangeNotifierProvider.autoDispose.family, int>( (ref, arg) => ValueNotifier('0 $arg'), ); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ family.overrideWith( (Ref> ref, int arg) => ValueNotifier('42 $arg'), @@ -55,7 +55,7 @@ void main() { test('ref.listenSelf listens to state changes', () { final listener = Listener>(); - final container = createContainer(); + final container = ProviderContainer.test(); final provider = ChangeNotifierProvider>((ref) { ref.listenSelf(listener.call); return ValueNotifier(0); @@ -71,7 +71,7 @@ void main() { }); test('support null ChangeNotifier', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = ChangeNotifierProvider?>((ref) => null); expect(container.read(provider), null); @@ -81,7 +81,7 @@ void main() { }); test('can read and set current ChangeNotifier', () async { - final container = createContainer(); + final container = ProviderContainer.test(); final listener = Listener>(); late Ref> ref; final provider = ChangeNotifierProvider>((r) { @@ -100,7 +100,7 @@ void main() { final provider = ChangeNotifierProvider>( (ref) => ValueNotifier(initialValue), ); - final container = createContainer(); + final container = ProviderContainer.test(); expect(container.read(provider).value, 1); expect(container.read(provider.notifier).value, 1); @@ -113,7 +113,7 @@ void main() { test('can be refreshed', () async { var result = ValueNotifier(0); - final container = createContainer(); + final container = ProviderContainer.test(); final provider = ChangeNotifierProvider((ref) => result); expect(container.read(provider), result); @@ -127,7 +127,7 @@ void main() { }); test('pass the notifier as previous value when notifying listeners', () { - final container = createContainer(); + final container = ProviderContainer.test(); final notifier = ValueNotifier(0); final provider = ChangeNotifierProvider((ref) => notifier); final listener = Listener>(); @@ -147,8 +147,9 @@ void main() { (ref) => ValueNotifier(0), dependencies: const [], ); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider.notifier).value, 0); expect(container.read(provider).value, 0); @@ -164,8 +165,8 @@ void main() { // test('when using provider.overrideWithValue', () { // final provider = ChangeNotifierProvider((ref) => ValueNotifier(0)); - // final root = createContainer(); - // final container = createContainer(parent: root, overrides: [ + // final root = ProviderContainer.test(); + // final container = ProviderContainer.test(parent: root, overrides: [ // provider.overrideWithValue(ValueNotifier(42)), // ]); @@ -188,8 +189,8 @@ void main() { (ref) => ValueNotifier(0), dependencies: const [], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref) => ValueNotifier(42)), @@ -214,7 +215,7 @@ void main() { // final notifier = ValueNotifier(42); // final listener = Listener(); - // final container = createContainer( + // final container = ProviderContainer.test( // overrides: [provider.overrideWithValue(notifier)], // ); @@ -233,7 +234,7 @@ void main() { test('refresh recreates the ChangeNotifier', () { final provider = ChangeNotifierProvider((ref) => ValueNotifier(0)); - final container = createContainer(); + final container = ProviderContainer.test(); container.read(provider).value = 42; @@ -244,7 +245,7 @@ void main() { }); test('family', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = ChangeNotifierProvider.family, int>((ref, value) { return ValueNotifier(value); @@ -309,7 +310,7 @@ void main() { final provider = ChangeNotifierProvider((ref) { return ref.watch(dep) == 0 ? notifier : notifier2; }); - final container = createContainer(); + final container = ProviderContainer.test(); addTearDown(container.dispose); var callCount = 0; @@ -335,65 +336,14 @@ void main() { expect(callCount, 1); }); - // test( - // 'overrideWithValue listens to the notifier, support notifier change, and does not dispose of the notifier', - // () async { - // final provider = ChangeNotifierProvider((_) { - // return TestNotifier('a'); - // }); - // final notifier = TestNotifier('b'); - // final notifier2 = TestNotifier('c'); - // final container = createContainer(overrides: [ - // provider.overrideWithValue(notifier), - // ]); - // addTearDown(container.dispose); - - // var callCount = 0; - // final sub = container.listen(provider, (_, __) => callCount++); - // final notifierSub = container.listen(provider.notifier, (_, __) {}); - - // expect(sub.read(), notifier); - // expect(callCount, 0); - // expect(notifierSub.read(), notifier); - // expect(notifier.hasListeners, true); - - // notifier.count++; - - // await container.pump(); - // expect(callCount, 1); - - // container.updateOverrides([ - // provider.overrideWithValue(notifier2), - // ]); - - // await container.pump(); - // expect(callCount, 2); - // expect(notifier.hasListeners, false); - // expect(notifier2.hasListeners, true); - // expect(notifier.mounted, true); - // expect(notifierSub.read(), notifier2); - - // notifier2.count++; - - // await container.pump(); - // expect(callCount, 3); - - // container.dispose(); - - // expect(callCount, 3); - // expect(notifier2.hasListeners, false); - // expect(notifier2.mounted, true); - // expect(notifier.mounted, true); - // }); - test('ChangeNotifier can be auto-scoped', () async { final dep = Provider((ref) => 0, dependencies: const []); final provider = ChangeNotifierProvider( (ref) => ValueNotifier(ref.watch(dep)), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -410,7 +360,7 @@ void main() { }); final notifier = TestNotifier(); final notifier2 = TestNotifier(); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith((_) => notifier), ], diff --git a/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart index cf4581dcc..124b1fdb4 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart @@ -19,7 +19,7 @@ void main() { }); test('support null ChangeNotifier', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = ChangeNotifierProvider.family.autoDispose?, int>( (ref, _) => null, @@ -38,8 +38,9 @@ void main() { (ref, _) => ValueNotifier(0), dependencies: const [], ); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider(0).notifier).value, 0); expect(container.read(provider(0)).value, 0); @@ -60,8 +61,8 @@ void main() { (ref, i) => ValueNotifier(ref.watch(dep) + i), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -78,8 +79,8 @@ void main() { (ref, _) => ValueNotifier(0), dependencies: const [], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref, value) => ValueNotifier(42)), diff --git a/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart index 5ac3e1506..b29b5c0f4 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart @@ -4,8 +4,6 @@ import 'package:flutter/widgets.dart'; import 'package:flutter_riverpod/src/internals.dart'; import 'package:flutter_test/flutter_test.dart'; -import '../../utils.dart'; - void main() { group('ChangeNotifierProvider.family', () { test('specifies `from` and `argument` for related providers', () { @@ -18,7 +16,7 @@ void main() { }); test('support null ChangeNotifier', () { - final container = createContainer(); + final container = ProviderContainer.test(); final provider = ChangeNotifierProvider.family?, int>( (ref, _) => null, ); @@ -35,8 +33,9 @@ void main() { (ref, _) => ValueNotifier(0), dependencies: const [], ); - final root = createContainer(); - final container = createContainer(parent: root, overrides: [provider]); + final root = ProviderContainer.test(); + final container = + ProviderContainer.test(parent: root, overrides: [provider]); expect(container.read(provider(0).notifier).value, 0); expect(container.read(provider(0)).value, 0); @@ -57,8 +56,8 @@ void main() { (ref, i) => ValueNotifier(ref.watch(dep) + i), dependencies: [dep], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [dep.overrideWithValue(42)], ); @@ -74,8 +73,8 @@ void main() { (ref, _) => ValueNotifier(0), dependencies: const [], ); - final root = createContainer(); - final container = createContainer( + final root = ProviderContainer.test(); + final container = ProviderContainer.test( parent: root, overrides: [ provider.overrideWith((ref, value) => ValueNotifier(42)), @@ -99,7 +98,7 @@ void main() { ChangeNotifierProvider.family, int>((ref, value) { return ValueNotifier(value); }); - final container = createContainer( + final container = ProviderContainer.test( overrides: [ provider.overrideWith((ref, value) => ValueNotifier(value * 2)), ], diff --git a/packages/flutter_riverpod/test/utils.dart b/packages/flutter_riverpod/test/utils.dart index 477425ac6..4d11a9102 100644 --- a/packages/flutter_riverpod/test/utils.dart +++ b/packages/flutter_riverpod/test/utils.dart @@ -1,6 +1,5 @@ import 'dart:async'; -import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; @@ -9,20 +8,6 @@ class ErrorListener extends Mock { void call(Object? error, StackTrace? stackTrace); } -ProviderContainer createContainer({ - ProviderContainer? parent, - List overrides = const [], - List? observers, -}) { - final container = ProviderContainer( - parent: parent, - overrides: overrides, - observers: observers, - ); - addTearDown(container.dispose); - return container; -} - class Counter extends StateNotifier { Counter() : super(0); From 8a21eef434deeeb351c9dc00c67753518cccb53e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 13 Mar 2024 20:32:01 +0100 Subject: [PATCH 275/387] Remove todo --- .../src/lints/scoped_providers_should_specify_dependencies.dart | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart b/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart index cdfc5e7b6..e673202cb 100644 --- a/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart +++ b/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart @@ -89,7 +89,6 @@ class ScopedProvidersShouldSpecifyDependencies extends RiverpodLintRule { ProviderContainerInstanceCreationExpression expression, ErrorReporter reporter, ) { - // TODO handle parent:null. // This might be doable by checking that the expression's // static type is non-nullable final hasParent = expression.parent != null; From 1664a9c6f3753b412aa8362e4c9d3091b78d12bb Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 13 Mar 2024 20:34:18 +0100 Subject: [PATCH 276/387] Improve coverage --- .../legacy/change_notifier_provider.dart | 3 +- .../flutter_riverpod/test/consumer_test.dart | 2 -- .../test/future_provider_test.dart | 2 -- .../change_notifier_provider_test.dart | 33 +++++++++++++++++++ ...dispose_change_notifier_provider_test.dart | 2 -- 5 files changed, 34 insertions(+), 8 deletions(-) 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 index a9057a5ae..a21279111 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -199,8 +199,7 @@ class ChangeNotifierProviderElement final notifier = _notifierNotifier.result?.stateOrNull; if (notifier != null) { - // TODO test ChangeNotifier.dispose is guarded - notifier.dispose(); + runGuarded(notifier.dispose); } _notifierNotifier.result = null; } diff --git a/packages/flutter_riverpod/test/consumer_test.dart b/packages/flutter_riverpod/test/consumer_test.dart index 95d61bbbb..36e800ca5 100644 --- a/packages/flutter_riverpod/test/consumer_test.dart +++ b/packages/flutter_riverpod/test/consumer_test.dart @@ -5,8 +5,6 @@ import 'package:flutter_riverpod/src/internals.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:riverpod/legacy.dart'; -import 'utils.dart'; - void main() { testWidgets('Riverpod test', (tester) async { // Regression test for https://github.com/rrousselGit/riverpod/pull/3156 diff --git a/packages/flutter_riverpod/test/future_provider_test.dart b/packages/flutter_riverpod/test/future_provider_test.dart index 4d07c518b..5a852cfdd 100644 --- a/packages/flutter_riverpod/test/future_provider_test.dart +++ b/packages/flutter_riverpod/test/future_provider_test.dart @@ -5,8 +5,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_test/flutter_test.dart'; -import 'utils.dart'; - void main() { test('SynchronousFuture', () { final futureProvider = FutureProvider((_) => SynchronousFuture(42)); diff --git a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart index 44db83447..be59815e1 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart @@ -1,5 +1,7 @@ // ignore_for_file: invalid_use_of_internal_member, avoid_types_on_closure_parameters +import 'dart:async'; + import 'package:flutter/widgets.dart' hide Listener; import 'package:flutter_riverpod/src/internals.dart'; import 'package:flutter_test/flutter_test.dart'; @@ -8,6 +10,25 @@ import 'package:mockito/mockito.dart'; import '../../utils.dart'; void main() { + test('Guards ChangeNotifier.dispose', () { + final notifier = DelegateNotifier( + onDispose: () => throw StateError('called'), + ); + final container = ProviderContainer.test(); + final provider = ChangeNotifierProvider((_) => notifier); + + container.read(provider); + + final errors = []; + + runZonedGuarded( + () => container.invalidate(provider), + (error, stack) => errors.add(error), + ); + + expect(errors, [isStateError]); + }); + test('supports overrideWith', () { final provider = ChangeNotifierProvider>((ref) => ValueNotifier(0)); @@ -432,3 +453,15 @@ class TestNotifier extends ChangeNotifier { return 'TestNotifier($debugLabel)'; } } + +class DelegateNotifier extends ChangeNotifier { + DelegateNotifier({this.onDispose}); + + final void Function()? onDispose; + + @override + void dispose() { + onDispose?.call(); + super.dispose(); + } +} diff --git a/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart index 124b1fdb4..5d0700631 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart @@ -4,8 +4,6 @@ import 'package:flutter/widgets.dart'; import 'package:flutter_riverpod/src/internals.dart'; import 'package:flutter_test/flutter_test.dart'; -import '../../utils.dart'; - void main() { group('ChangeNotifierProvider.autoDispose.family', () { test('specifies `from` and `argument` for related providers', () { From f661cd04ee9e7b1c4c7a35c29f83c7b4bf3a1a8a Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 13 Mar 2024 20:53:23 +0100 Subject: [PATCH 277/387] Coverage --- .../legacy/state_notifier_provider.dart | 1 - .../riverpod/lib/src/providers/provider.dart | 1 - packages/riverpod/test/meta_test.dart | 10 +----- .../state_notifier_provider_test.dart | 33 +++++++++++++++++++ 4 files changed, 34 insertions(+), 11 deletions(-) diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index 219deb330..c647cd4b1 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -205,7 +205,6 @@ class StateNotifierProviderElement, final notifier = _notifierNotifier.result?.stateOrNull; if (notifier != null) { - // TODO test STateNotifier.dispose is guarded runGuarded(notifier.dispose); } _notifierNotifier.result = null; diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index ce5d8abc3..db53bd2da 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -362,7 +362,6 @@ class $ProviderElement extends ProviderElementBase { } /// The [Family] of [Provider] -// TODO remove custom family types class ProviderFamily extends FunctionalFamily> { ProviderFamily( diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index 423bf0797..89a47c3f6 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -40,6 +40,7 @@ void main() { }); test('public API snapshot', skip: 'Disabled', () async { + // TODO consider other imports expect(riverpod.exportNamespace.definedNames.keys, [ 'AsyncValue', 'AsyncData', @@ -61,24 +62,15 @@ void main() { 'AsyncNotifier', 'AsyncNotifierProvider', 'FamilyAsyncNotifier', - 'AsyncNotifierProviderFamily', - 'FamilyAsyncNotifierProvider', 'FutureProvider', - 'FutureProviderFamily', 'Notifier', 'NotifierProvider', 'FamilyNotifier', - 'FamilyNotifierProvider', - 'NotifierProviderFamily', 'Provider', - 'ProviderFamily', 'FamilyStreamNotifier', - 'FamilyStreamNotifierProvider', - 'StreamNotifierProviderFamily', 'StreamNotifier', 'StreamNotifierProvider', 'StreamProvider', - 'StreamProviderFamily', ]); expect(visitor.undocumentedElements, isEmpty); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart index e930520ad..ee8f7da8d 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart @@ -1,5 +1,7 @@ // ignore_for_file: avoid_types_on_closure_parameters +import 'dart:async'; + import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; @@ -9,6 +11,25 @@ import 'package:test/test.dart'; import '../../../utils.dart'; void main() { + test('Guards StateNotifier.dispose', () { + final notifier = DelegateNotifier( + onDispose: () => throw StateError('called'), + ); + final container = ProviderContainer.test(); + final provider = StateNotifierProvider((_) => notifier); + + container.read(provider); + + final errors = []; + + runZonedGuarded( + () => container.invalidate(provider), + (error, stack) => errors.add(error), + ); + + expect(errors, [isStateError]); + }); + test('supports overrideWith', () { final provider = StateNotifierProvider( (ref) => TestNotifier(), @@ -480,3 +501,15 @@ class TestNotifier extends StateNotifier { return 'TestNotifier($state)'; } } + +class DelegateNotifier extends StateNotifier { + DelegateNotifier({this.onDispose}) : super(0); + + final void Function()? onDispose; + + @override + void dispose() { + onDispose?.call(); + super.dispose(); + } +} From a11ea81244cbf0b5bbad5dc0de583246c8b2b6df Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 17:46:07 +0100 Subject: [PATCH 278/387] More tests --- packages/riverpod/lib/src/core/element.dart | 20 +- .../lib/src/core/provider_container.dart | 73 ++++++-- .../test/new/core/auto_dispose_test.dart | 2 - .../new/core/provider_container_test.dart | 171 +++++++++++------- 4 files changed, 175 insertions(+), 91 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index ef7fc3a93..918157469 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -676,7 +676,25 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu @override String toString() { - return '$runtimeType(provider: $provider, origin: $origin)'; + final buffer = StringBuffer('$runtimeType('); + + buffer.writeAll( + [ + switch (_stateResult) { + null => 'state: uninitialized', + ResultData(:final state) => 'state: $state', + ResultError(:final error, :final stackTrace) => + 'state: error $error\n$stackTrace', + }, + if (provider != origin) 'provider: $provider', + 'origin: $origin', + ], + ', ', + ); + + buffer.write(')'); + + return buffer.toString(); } /// Visit the [$ProviderElement]s of providers that are listening to this element. diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 7582c1398..490b0e461 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -85,6 +85,14 @@ extension } } +extension on ProviderOrFamily { + bool get canBeTransitivelyOverridden { + final allTransitiveDependencies = this.allTransitiveDependencies; + return allTransitiveDependencies != null && + allTransitiveDependencies.isNotEmpty; + } +} + @internal class ProviderDirectory implements _PointerBase { ProviderDirectory.empty( @@ -94,9 +102,15 @@ class ProviderDirectory implements _PointerBase { targetContainer = container; ProviderDirectory.from( - ProviderDirectory pointer, - ) : familyOverride = pointer.familyOverride, - targetContainer = pointer.targetContainer, + ProviderDirectory pointer, { + ProviderContainer? targetContainer, + _FamilyOverride? familyOverride, + }) : assert( + (familyOverride == null) == (targetContainer == null), + 'Either both or neither of familyOverride and targetContainer should be null', + ), + familyOverride = familyOverride ?? pointer.familyOverride, + targetContainer = targetContainer ?? pointer.targetContainer, pointers = HashMap.fromEntries( pointer.pointers.entries.where((e) => !e.value.isTransitiveOverride), ); @@ -266,7 +280,13 @@ class ProviderPointerManager { familyPointers: HashMap.fromEntries( parent._pointerManager.familyPointers.entries - .where((e) => !e.value.isTransitiveOverride) + .where( + (e) => + !e.value.isTransitiveOverride && + // Exclude families that may be automatically scoped unless they are overridden. + (!e.key.canBeTransitivelyOverridden || + e.value.familyOverride != null), + ) .map( (e) { if (e.key.allTransitiveDependencies == null) return e; @@ -348,14 +368,12 @@ class ProviderPointerManager { ProviderOrFamily provider, ) { if (container._parent == null) return null; + if (!provider.canBeTransitivelyOverridden) { + return null; + } - final transitiveDependencies = provider.allTransitiveDependencies; - - /// If the provider has no dependencies, it cannot be locally overridden. - if (transitiveDependencies == null) return null; - - final overrides = - transitiveDependencies.expand((dependency) { + final overrides = provider.allTransitiveDependencies! + .expand((dependency) { switch (dependency) { case Family(): final familyPointer = familyPointers[dependency]; @@ -392,13 +410,33 @@ class ProviderPointerManager { family, currentContainer: container, targetContainer: null, - inherit: (target) => target._pointerManager._mountFamily(family), - scope: ({override}) => ProviderDirectory.empty( - container, - familyOverride: override == null // + inherit: (target) { + final parentPointer = target._pointerManager._mountFamily(family); + + // TODO don't fork a family if no family(42) is overridden + + return ProviderDirectory.from(parentPointer); + }, + scope: ({override}) { + final familyOverride = override == null // ? null - : TransitiveFamilyOverride(override), - ), + : TransitiveFamilyOverride(override); + + final parent = container.parent?._pointerManager.familyPointers[family]; + + if (parent != null) { + return ProviderDirectory.from( + parent, + targetContainer: container, + familyOverride: familyOverride, + ); + } + + return ProviderDirectory.empty( + container, + familyOverride: familyOverride, + ); + }, ); } @@ -426,7 +464,6 @@ class ProviderPointerManager { if (from == null) { return orphanPointers; } else { - // // TODO debugAddDependency(element, debugDependentSource: debugDependentSource); return _mountFamily(from); } } diff --git a/packages/riverpod/test/new/core/auto_dispose_test.dart b/packages/riverpod/test/new/core/auto_dispose_test.dart index ac9a58a54..e0d9723bf 100644 --- a/packages/riverpod/test/new/core/auto_dispose_test.dart +++ b/packages/riverpod/test/new/core/auto_dispose_test.dart @@ -75,8 +75,6 @@ void main() { }); group('on unused providers', () { - // TODO test calls dispose only once - test( 'cleans up the pointers of a provider in the entire ProviderContainer tree', () async { diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/new/core/provider_container_test.dart index 12c14872c..4366d4bb9 100644 --- a/packages/riverpod/test/new/core/provider_container_test.dart +++ b/packages/riverpod/test/new/core/provider_container_test.dart @@ -1168,7 +1168,23 @@ void main() { }); }); - // TODO test that reading a provider with deps does not mount those deps if unused by the provider + test( + 'Reading a provider with deps does not mount those deps if unused by the provider', + () { + final dep = Provider((_) => 0); + final provider = Provider((ref) => 0, dependencies: [dep]); + + final container = ProviderContainer.test(); + + container.read(provider); + + expect( + container.pointerManager + .listProviderPointers() + .map((e) => e.element?.origin), + [provider], + ); + }); group('pointers', () { test('has "container" pointing to "this"', () { @@ -1194,6 +1210,39 @@ void main() { }); group('on scoped containers', () { + test( + 'Inheriting a transitively overridden family which contains family(arg) overrides ' + 'preserves the family(arg) overrides.', () { + final dep = Provider((_) => 0, dependencies: const []); + final provider = Provider.family( + (ref, id) => 'root ${ref.watch(dep)}', + dependencies: [dep], + ); + + final root = ProviderContainer.test( + overrides: [ + provider(42).overrideWith((ref) { + return 'override ${ref.watch(dep)}'; + }), + ], + ); + + final container = ProviderContainer.test( + parent: root, + overrides: [dep.overrideWithValue(42)], + ); + + expect( + container.read(provider(42)), + 'override 0', + reason: 'provider(42) is manually overridden, ' + 'so this disables auto-scoping', + ); + expect(container.read(provider(21)), 'root 42'); + expect(root.read(provider(21)), 'root 0'); + expect(root.read(provider(42)), 'override 0'); + }); + test('does not inherit transitive overrides', () { final unrelated = Provider((_) => 0, dependencies: const []); final dep = Provider( @@ -1238,8 +1287,6 @@ void main() { }); test('inherits overrides from its parents', () { - // TODO test that inheriting a transitively overridden family which contains family(arg) overrides preserves the family(arg) overrides - final a = Provider((_) => 0, name: 'a'); final aOverride = a.overrideWithValue(1); final b = Provider( @@ -2437,49 +2484,41 @@ void main() { }); test( - 'if a listener removes another provider.listen, the removed listener is still called (ProviderListenable)', - skip: true, - () { - final provider = StateProvider((ref) => 0); - final container = ProviderContainer.test(); - - final listener = Listener(); - final listener2 = Listener(); + 'if a listener removes another provider.listen, the removed listener is still called (ProviderListenable)', + () { + final provider = StateProvider((ref) => 0); + final container = ProviderContainer.test(); - final p = Provider((ref) { - ProviderSubscription? a; - ref.listen(provider, (prev, value) { - listener(prev, value); - a?.close(); - a = null; - }); + final listener = Listener(); + final listener2 = Listener(); - a = ref.listen(provider, listener2.call); + final p = Provider((ref) { + ProviderSubscription? a; + ref.listen(provider, (prev, value) { + listener(prev, value); + a?.close(); + a = null; }); - container.read(p); - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); + a = ref.listen(provider, listener2.call); + }); + container.read(p); - container.read(provider.notifier).state++; + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); - verifyInOrder([ - listener(1, 1), - listener2(1, 1), - ]); + container.read(provider.notifier).state++; - container.read(provider.notifier).state++; + verifyInOrder([ + listener(0, 1), + listener2(0, 1), + ]); - verify(listener(2, 2)).called(1); - verifyNoMoreInteractions(listener2); - // TODO the problem is that ProviderListenable subscriptions are separate from - // ProviderElement subscriptions. So the ProviderElement.notifyListeners - // making a local copy of the list of subscriptions before notifying listeners - // does not apply to ProviderListenables - // Support for modifying listeners within a listener probably should be dropped anyway for performance. - // This would remove a list copy - }, - ); + container.read(provider.notifier).state++; + + verify(listener(1, 2)).called(1); + verifyNoMoreInteractions(listener2); + }); test( 'if a listener adds a provider.listen, the new listener is not called immediately', @@ -2509,46 +2548,38 @@ void main() { }); test( - 'if a listener removes another container.listen, the removed listener is still called (ProviderListenable)', - skip: true, - () { - final provider = StateProvider((ref) => 0); - final container = ProviderContainer.test(); + 'if a listener removes another container.listen, the removed listener is still called (ProviderListenable)', + () { + final provider = StateProvider((ref) => 0); + final container = ProviderContainer.test(); - final listener = Listener(); - final listener2 = Listener(); + final listener = Listener(); + final listener2 = Listener(); - ProviderSubscription? a; - container.listen(provider, (prev, value) { - listener(prev, value); - a?.close(); - a = null; - }); + ProviderSubscription? a; + container.listen(provider, (prev, value) { + listener(prev, value); + a?.close(); + a = null; + }); - a = container.listen(provider, listener2.call); + a = container.listen(provider, listener2.call); - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); + verifyZeroInteractions(listener); + verifyZeroInteractions(listener2); - container.read(provider.notifier).state++; + container.read(provider.notifier).state++; - verifyInOrder([ - listener(1, 1), - listener2(1, 1), - ]); + verifyInOrder([ + listener(0, 1), + listener2(0, 1), + ]); - container.read(provider.notifier).state++; + container.read(provider.notifier).state++; - verify(listener(2, 2)).called(1); - verifyNoMoreInteractions(listener2); - // TODO the problem is that ProviderListenable subscriptions are separate from - // ProviderElement subscriptions. So the ProviderElement.notifyListeners - // making a local copy of the list of subscriptions before notifying listeners - // does not apply to ProviderListenables - // Support for modifying listeners within a listener probably should be dropped anyway for performance. - // This would remove a list copy - }, - ); + verify(listener(1, 2)).called(1); + verifyNoMoreInteractions(listener2); + }); test( 'if a listener removes another container.listen, the removed listener is still called', From 52bb32d867e7a1be7adaf0216c9c828a14029908 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 17:49:43 +0100 Subject: [PATCH 279/387] ProviderElementBase > ProviderElement --- .../legacy/change_notifier_provider.dart | 4 +- ...dispose_change_notifier_provider_test.dart | 6 +-- .../change_notifier_provider_test.dart | 6 +-- ...dispose_change_notifier_provider_test.dart | 4 +- .../family_change_notifier_provider_test.dart | 5 +-- packages/riverpod/lib/riverpod.dart | 2 +- .../riverpod/lib/src/common/listenable.dart | 4 +- packages/riverpod/lib/src/core/element.dart | 34 ++++++++--------- .../lib/src/core/modifiers/future.dart | 6 +-- .../lib/src/core/modifiers/select.dart | 2 +- packages/riverpod/lib/src/core/override.dart | 12 +++--- .../lib/src/core/override_with_value.dart | 6 +-- .../src/core/provider/notifier_provider.dart | 6 +-- .../lib/src/core/provider/provider.dart | 2 +- .../lib/src/core/provider_container.dart | 30 +++++++-------- .../lib/src/core/provider_subscription.dart | 8 ++-- .../src/core/proxy_provider_listenable.dart | 2 +- packages/riverpod/lib/src/core/ref.dart | 8 ++-- packages/riverpod/lib/src/core/scheduler.dart | 8 ++-- .../lib/src/providers/future_provider.dart | 3 +- .../legacy/state_notifier_provider.dart | 4 +- .../src/providers/legacy/state_provider.dart | 4 +- .../riverpod/lib/src/providers/provider.dart | 4 +- .../lib/src/providers/stream_provider.dart | 5 +-- .../riverpod/test/new/core/scope_test.dart | 38 ++++++++----------- .../framework/provider_container_test.dart | 2 +- .../old/framework/provider_element_test.dart | 12 +++--- .../test/old/framework/ref_watch_test.dart | 4 +- .../old/legacy/framework2/framework_test.dart | 14 +++---- .../test/old/legacy/framework_test.dart | 6 +-- .../auto_dispose_family_test.dart | 6 +-- ..._dispose_state_notifier_provider_test.dart | 5 +-- .../state_notifier_provider/family_test.dart | 8 ++-- .../state_notifier_provider_test.dart | 8 ++-- .../state_provider_auto_dispose_test.dart | 8 ++-- ...ate_provider_family_auto_dispose_test.dart | 6 +-- .../state_provider_family_test.dart | 6 +-- .../state_provider/state_provider_test.dart | 8 ++-- ...o_dispose_family_future_provider_test.dart | 3 +- .../auto_dispose_future_provider_test.dart | 8 ++-- .../family_future_provider_test.dart | 8 ++-- .../future_provider/future_provider_test.dart | 8 ++-- .../auto_dispose_provider_family_test.dart | 5 +-- .../provider/auto_dispose_provider_test.dart | 11 ++---- .../provider/provider_family_test.dart | 8 ++-- .../provider/provider_test.dart | 11 ++---- .../scoped_provider/scoped_provider_test.dart | 4 +- ...o_dispose_family_stream_provider_test.dart | 4 +- .../auto_dispose_stream_provider_test.dart | 8 ++-- .../stream_provider_family_test.dart | 6 +-- .../stream_provider/stream_provider_test.dart | 11 ++---- 51 files changed, 182 insertions(+), 219 deletions(-) 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 index a21279111..642d31211 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -160,7 +160,7 @@ final class ChangeNotifierProvider /// The element of [ChangeNotifierProvider]. class ChangeNotifierProviderElement - extends ProviderElementBase { + extends ProviderElement { ChangeNotifierProviderElement._(this.provider, super.container); @override @@ -206,7 +206,7 @@ class ChangeNotifierProviderElement @override void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, + required void Function(ProviderElement element) elementVisitor, required void Function(ProxyElementValueListenable element) listenableVisitor, }) { diff --git a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart index 042df1a4b..1bb586819 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart @@ -85,8 +85,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); expect(root.getAllProviderElements(), isEmpty); @@ -132,8 +131,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); expect(root.getAllProviderElements(), isEmpty); diff --git a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart index be59815e1..4b8754010 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart @@ -177,8 +177,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); expect(root.getAllProviderElements(), isEmpty); @@ -223,8 +222,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); expect(root.getAllProviderElements(), isEmpty); diff --git a/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart index 5d0700631..30798bf1d 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/family_auto_dispose_change_notifier_provider_test.dart @@ -45,7 +45,7 @@ void main() { expect( container.getAllProviderElementsInOrder(), unorderedEquals([ - isA() + isA() .having((e) => e.origin, 'origin', provider(0)), ]), ); @@ -91,7 +91,7 @@ void main() { expect( container.getAllProviderElementsInOrder(), unorderedEquals([ - isA() + isA() .having((e) => e.origin, 'origin', provider(0)), ]), ); diff --git a/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart index b29b5c0f4..097f9a3d1 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/family_change_notifier_provider_test.dart @@ -42,7 +42,7 @@ void main() { expect( container.getAllProviderElementsInOrder(), unorderedEquals([ - isA() + isA() .having((e) => e.origin, 'origin', provider(0)), ]), ); @@ -87,8 +87,7 @@ void main() { expect( container.getAllProviderElementsInOrder(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider(0)), + isA().having((e) => e.origin, 'origin', provider(0)), ]), ); }); diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index fed807926..6ba15ac06 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -32,7 +32,7 @@ export 'src/framework.dart' ProviderDirectory, $AsyncClassModifier, $FutureModifier, - ProviderElementBase, + ProviderElement, ClassBaseX, CancelAsyncSubscription, FutureModifierElement, diff --git a/packages/riverpod/lib/src/common/listenable.dart b/packages/riverpod/lib/src/common/listenable.dart index 1c915d08c..e31db5d41 100644 --- a/packages/riverpod/lib/src/common/listenable.dart +++ b/packages/riverpod/lib/src/common/listenable.dart @@ -1,6 +1,6 @@ import 'package:meta/meta.dart'; -import '../framework.dart' show ProviderElementBase; +import '../framework.dart' show ProviderElement; import '../internals.dart' show OnError; import 'env.dart'; import 'pragma.dart'; @@ -15,7 +15,7 @@ class _Listener { final void Function()? onDependencyMayHaveChanged; } -/// A listenable object used by [ProviderElementBase] as a mean to subscribe +/// A listenable object used by [ProviderElement] as a mean to subscribe /// to subsets of the state exposed by a provider. @internal @optionalTypeArgs diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 918157469..7aec256b0 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -43,11 +43,11 @@ void Function()? debugCanModifyProviders; // TODO rename to ProviderElement @internal @optionalTypeArgs -abstract class ProviderElementBase implements Node { +abstract class ProviderElement implements Node { /// {@macro riverpod.provider_element_base} - ProviderElementBase(this.container); + ProviderElement(this.container); - static ProviderElementBase? _debugCurrentlyBuildingElement; + static ProviderElement? _debugCurrentlyBuildingElement; /// The last result of [ProviderBase.debugGetCreateSourceHash]. /// @@ -55,33 +55,33 @@ abstract class ProviderElementBase implements Node { String? _debugCurrentCreateHash; var _debugSkipNotifyListenersAsserts = false; - /// The provider associated with this [ProviderElementBase], before applying overrides. + /// The provider associated with this [ProviderElement], before applying overrides. // Not typed as because of https://github.com/rrousselGit/riverpod/issues/1100 ProviderBase get origin => _origin; late final ProviderBase _origin; - /// The provider associated with this [ProviderElementBase], after applying overrides. + /// The provider associated with this [ProviderElement], after applying overrides. ProviderBase get provider; - /// The [ProviderContainer] that owns this [ProviderElementBase]. + /// The [ProviderContainer] that owns this [ProviderElement]. final ProviderContainer container; Ref? ref; - /// Whether this [ProviderElementBase] is currently listened to or not. + /// Whether this [ProviderElement] is currently listened to or not. /// /// This maps to listeners added with [Ref.listen]. /// See also [_mayNeedDispose], called when [hasListeners] may have changed. bool get hasListeners => (_dependents?.isNotEmpty ?? false) || _providerDependents.isNotEmpty; - var _dependencies = HashMap(); - HashMap? _previousDependencies; + var _dependencies = HashMap(); + HashMap? _previousDependencies; List? _subscriptions; List? _dependents; /// The element of the providers that depends on this provider. - final _providerDependents = []; + final _providerDependents = []; bool _mustRecomputeState = false; bool _dependencyMayHaveChanged = false; @@ -356,7 +356,7 @@ This could mean a few things: /// Invokes [create] and handles errors. @internal void buildState(Ref ref) { - ProviderElementBase? debugPreviouslyBuildingElement; + ProviderElement? debugPreviouslyBuildingElement; final previousDidChangeDependency = _didChangeDependency; _didChangeDependency = false; if (kDebugMode) { @@ -537,7 +537,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } @override - ProviderElementBase readProviderElement(ProviderBase provider) { + ProviderElement readProviderElement(ProviderBase provider) { return container.readProviderElement(provider); } @@ -647,7 +647,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ); } - /// Release the resources associated to this [ProviderElementBase]. + /// Release the resources associated to this [ProviderElement]. /// /// This will be invoked when: /// - the provider is using `autoDispose` and it is no-longer used. @@ -706,7 +706,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu /// If a provider both [Ref.watch] and [Ref.listen] an element, or if a provider /// [Ref.listen] multiple times to an element, it may be visited multiple times. void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, + required void Function(ProviderElement element) elementVisitor, required void Function(ProxyElementValueListenable element) listenableVisitor, }) { @@ -718,12 +718,12 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu if (dependents != null) { for (var i = 0; i < dependents.length; i++) { final dependent = dependents[i].source; - if (dependent is ProviderElementBase) elementVisitor(dependent); + if (dependent is ProviderElement) elementVisitor(dependent); } } } - /// Visit the [ProviderElementBase]s that this provider is listening to. + /// Visit the [ProviderElement]s that this provider is listening to. /// /// A provider is considered as listening to this element if it either [Ref.watch] /// or [Ref.listen] this element. @@ -732,7 +732,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu /// If this provider both [Ref.watch] and [Ref.listen] an element, or if it /// [Ref.listen] multiple times to an element, that element may be visited multiple times. void visitAncestors( - void Function(ProviderElementBase element) visitor, + void Function(ProviderElement element) visitor, ) { _dependencies.keys.forEach(visitor); diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index a62af253c..2a6a71077 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -212,8 +212,8 @@ mixin FutureModifierClassElement< /// Mixin to help implement logic for listening to [Future]s/[Stream]s and setup /// `provider.future` + convert the object into an [AsyncValue]. @internal -mixin FutureModifierElement on ProviderElementBase> { - /// A default implementation for [ProviderElementBase.updateShouldNotify]. +mixin FutureModifierElement on ProviderElement> { + /// A default implementation for [ProviderElement.updateShouldNotify]. static bool handleUpdateShouldNotify( AsyncValue previous, AsyncValue next, @@ -515,7 +515,7 @@ mixin FutureModifierElement on ProviderElementBase> { @override void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, + required void Function(ProviderElement element) elementVisitor, required void Function(ProxyElementValueListenable element) listenableVisitor, }) { diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index e4b9dabce..bfafe4d80 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -17,7 +17,7 @@ abstract class Node { /// /// Do not use this in production code. This is exposed only for testing /// and devtools, to be able to test if a provider has listeners or similar. - ProviderElementBase readProviderElement( + ProviderElement readProviderElement( ProviderBase provider, ); } diff --git a/packages/riverpod/lib/src/core/override.dart b/packages/riverpod/lib/src/core/override.dart index 6cc9c90c5..fc8aaa1bc 100644 --- a/packages/riverpod/lib/src/core/override.dart +++ b/packages/riverpod/lib/src/core/override.dart @@ -96,7 +96,7 @@ abstract class $FamilyOverride implements _FamilyOverride { /// Do not use: Internal object to used by [ProviderContainer]/`ProviderScope` /// to override the behavior of a "family" for part of the application. factory $FamilyOverride({ - required ProviderElementBase Function( + required ProviderElement Function( ProviderContainer container, ProviderBase provider, ) createElement, @@ -107,7 +107,7 @@ abstract class $FamilyOverride implements _FamilyOverride { Family get from; /// The overridden [ProviderBase.$createElement]. - ProviderElementBase createElement( + ProviderElement createElement( ProviderContainer container, ProviderBase provider, ); @@ -125,7 +125,7 @@ class TransitiveFamilyOverride implements $FamilyOverride { final Family from; @override - ProviderElementBase createElement( + ProviderElement createElement( ProviderContainer container, ProviderBase provider, ) { @@ -141,7 +141,7 @@ class _FamilyOverrideImpl implements $FamilyOverride { /// An [Override] for families // ignore: library_private_types_in_public_api _FamilyOverrideImpl({ - required ProviderElementBase Function( + required ProviderElement Function( ProviderContainer container, ProviderBase provider, ) createElement, @@ -151,13 +151,13 @@ class _FamilyOverrideImpl implements $FamilyOverride { @override final Family from; - final ProviderElementBase Function( + final ProviderElement Function( ProviderContainer container, ProviderBase provider, ) _createElement; @override - ProviderElementBase createElement( + ProviderElement createElement( ProviderContainer container, ProviderBase provider, ) { diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index 0d9b0a973..3b4760f97 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -32,9 +32,9 @@ final class $ValueProvider extends ProviderBase } } -/// The [ProviderElementBase] of a [$ValueProvider] -class _ValueProviderElement extends ProviderElementBase { - /// The [ProviderElementBase] of a [$ValueProvider] +/// The [ProviderElement] of a [$ValueProvider] +class _ValueProviderElement extends ProviderElement { + /// The [ProviderElement] of a [$ValueProvider] _ValueProviderElement(this.provider, super.container); /// A custom listener called when `overrideWithValue` changes diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index d12eadf41..cf4524142 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -83,7 +83,7 @@ abstract class NotifierBase { @internal extension ClassBaseX on NotifierBase { - ProviderElementBase? get element => _ref?._element; + ProviderElement? get element => _ref?._element; } /// Implementation detail of `riverpod_generator`. @@ -165,7 +165,7 @@ abstract class ClassProviderElement< // CreatedT>, StateT, CreatedT> // - extends ProviderElementBase { + extends ProviderElement { ClassProviderElement(super.container); @override @@ -232,7 +232,7 @@ abstract class ClassProviderElement< // @override void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, + required void Function(ProviderElement element) elementVisitor, required void Function(ProxyElementValueListenable element) listenableVisitor, }) { diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index e33bae7a0..5301f7995 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -98,7 +98,7 @@ abstract base class ProviderBase extends ProviderOrFamily /// An internal method that defines how a provider behaves. @visibleForOverriding - ProviderElementBase $createElement(ProviderContainer container); + ProviderElement $createElement(ProviderContainer container); @override String toString() { diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 490b0e461..4a9feacec 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -32,7 +32,7 @@ class ProviderPointer implements _PointerBase { /// This override may be implicitly created by [ProviderOrFamily.allTransitiveDependencies]. // ignore: library_private_types_in_public_api, not public API _ProviderOverride? providerOverride; - ProviderElementBase? element; + ProviderElement? element; @override final ProviderContainer targetContainer; @@ -178,7 +178,7 @@ class ProviderDirectory implements _PointerBase { ); if (pointer.element == null) { - ProviderElementBase? element; + ProviderElement? element; switch ((pointer.providerOverride, familyOverride)) { // The provider is overridden. This takes over any family override @@ -454,7 +454,7 @@ class ProviderPointerManager { return readDirectory(provider)?.pointers[provider]; } - ProviderElementBase? readElement(ProviderBase provider) { + ProviderElement? readElement(ProviderBase provider) { return readPointer(provider)?.element; } @@ -475,11 +475,11 @@ class ProviderPointerManager { ); } - ProviderElementBase upsertElement(ProviderBase provider) { + ProviderElement upsertElement(ProviderBase provider) { return upsertPointer(provider).element!; } - /// Traverse the [ProviderElementBase]s associated with this [ProviderContainer]. + /// Traverse the [ProviderElement]s associated with this [ProviderContainer]. Iterable listProviderPointers() { return orphanPointers.pointers.values .where((pointer) => pointer.targetContainer == container) @@ -490,8 +490,8 @@ class ProviderPointerManager { ); } - /// Read the [ProviderElementBase] for a provider, without creating it if it doesn't exist. - Iterable listFamily(Family family) { + /// Read the [ProviderElement] for a provider, without creating it if it doesn't exist. + Iterable listFamily(Family family) { final _familyPointers = familyPointers[family]; if (_familyPointers == null) return const []; @@ -743,7 +743,7 @@ class ProviderContainer implements Node { null; } - /// Executes [ProviderElementBase.debugReassemble] on all the providers. + /// Executes [ProviderElement.debugReassemble] on all the providers. void debugReassemble() { // TODO hot-reload handle provider type change // TODO hot-reload handle provider response type change @@ -915,7 +915,7 @@ class ProviderContainer implements Node { /// TODO make private /// TODO remove generic @override - ProviderElementBase readProviderElement( + ProviderElement readProviderElement( ProviderBase provider, ) { if (_disposed) { @@ -926,7 +926,7 @@ class ProviderContainer implements Node { final element = _pointerManager.upsertElement(provider); - return element as ProviderElementBase; + return element as ProviderElement; } void _dispose({ @@ -971,8 +971,8 @@ class ProviderContainer implements Node { /// Therefore, disposing the root [ProviderContainer] the entire graph. void dispose() => _dispose(updateChildren: true); - /// Traverse the [ProviderElementBase]s associated with this [ProviderContainer]. - Iterable getAllProviderElements() { + /// Traverse the [ProviderElement]s associated with this [ProviderContainer]. + Iterable getAllProviderElements() { return _pointerManager .listProviderPointers() .map((e) => e.element) @@ -985,9 +985,9 @@ class ProviderContainer implements Node { /// This is fairly expensive and should be avoided as much as possible. /// If you do not need for providers to be sorted, consider using [getAllProviderElements] /// instead, which returns an unsorted list and is significantly faster. - Iterable getAllProviderElementsInOrder() sync* { - final visitedNodes = HashSet(); - final queue = DoubleLinkedQueue(); + Iterable getAllProviderElementsInOrder() sync* { + final visitedNodes = HashSet(); + final queue = DoubleLinkedQueue(); // get providers that don't depend on other providers from this container for (final pointer in _pointerManager.listProviderPointers()) { diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index faadb88ac..fd422971f 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -6,7 +6,7 @@ abstract base class ProviderSubscription { /// Represents the subscription to a [ProviderListenable] ProviderSubscription(this.source) { final Object listener = source; - if (listener is ProviderElementBase) { + if (listener is ProviderElement) { final subs = listener._subscriptions ??= []; subs.add(this); } @@ -14,7 +14,7 @@ abstract base class ProviderSubscription { /// The object that listens to the associated [ProviderListenable]. /// - /// This is typically a [ProviderElementBase] or a [ProviderContainer], + /// This is typically a [ProviderElement] or a [ProviderContainer], /// but may be other values in the future. final Node source; @@ -36,7 +36,7 @@ abstract base class ProviderSubscription { _closed = true; final Object listener = source; - if (listener is ProviderElementBase) { + if (listener is ProviderElement) { listener._subscriptions?.remove(this); } } @@ -58,7 +58,7 @@ final class _ProviderStateSubscription // Why can't this be typed correctly? final void Function(Object? prev, Object? state) listener; - final ProviderElementBase listenedElement; + final ProviderElement listenedElement; final OnError onError; @override diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index 9a3fe62e0..f7d883c5b 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -71,7 +71,7 @@ class ProviderElementProxy @override final ProviderBase provider; final ProxyElementValueListenable Function( - ProviderElementBase element, + ProviderElement element, ) _lense; @override diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 3933c6563..f173b05d0 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -6,7 +6,7 @@ extension $RefArg on Ref { Object? get $arg => _element.origin.argument; // Implementation detail, do not use - ProviderElementBase get $element => _element; + ProviderElement get $element => _element; } @internal @@ -37,7 +37,7 @@ base class Ref { /// {@macro riverpod.provider_ref_base} Ref._(this._element); - final ProviderElementBase _element; + final ProviderElement _element; List? _keepAliveLinks; List? _onChangeSelfListeners; List? _onDisposeListeners; @@ -120,7 +120,7 @@ final = Provider(dependencies: []); } // TODO move to a "onAddDependency" life-cycle - final queue = Queue.from( + final queue = Queue.from( _element._providerDependents, ); while (queue.isNotEmpty) { @@ -604,7 +604,7 @@ final = Provider(dependencies: []); /// The listener will be called immediately after the provider completes building. /// /// As opposed to [listen], the listener will be called even if - /// [ProviderElementBase.updateShouldNotify] returns false, meaning that the previous + /// [ProviderElement.updateShouldNotify] returns false, meaning that the previous /// and new value can potentially be identical. void listenSelf( void Function(StateT? previous, StateT next) listener, { diff --git a/packages/riverpod/lib/src/core/scheduler.dart b/packages/riverpod/lib/src/core/scheduler.dart index 000baeab6..75e1409f7 100644 --- a/packages/riverpod/lib/src/core/scheduler.dart +++ b/packages/riverpod/lib/src/core/scheduler.dart @@ -54,15 +54,15 @@ class ProviderScheduler { return _defaultVsync; } - final _stateToDispose = []; - final _stateToRefresh = []; + final _stateToDispose = []; + final _stateToRefresh = []; Completer? _pendingTaskCompleter; Future? get pendingFuture => _pendingTaskCompleter?.future; void Function()? _cancel; - void scheduleProviderRefresh(ProviderElementBase element) { + void scheduleProviderRefresh(ProviderElement element) { _stateToRefresh.add(element); _scheduleTask(); @@ -102,7 +102,7 @@ class ProviderScheduler { } } - void scheduleProviderDispose(ProviderElementBase element) { + void scheduleProviderDispose(ProviderElement element) { assert( !element.hasListeners, 'Tried to dispose ${element.origin} , but still has listeners', diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 077753102..b46313996 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -162,8 +162,7 @@ final class FutureProvider /// The element of a [FutureProvider] /// Implementation detail of `riverpod_generator`. Do not use. @internal -class $FutureProviderElement - extends ProviderElementBase> +class $FutureProviderElement extends ProviderElement> with FutureModifierElement { /// The element of a [FutureProvider] /// Implementation detail of `riverpod_generator`. Do not use. diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index c647cd4b1..dd1d23b4c 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -163,7 +163,7 @@ final class StateNotifierProvider< // /// The element of [StateNotifierProvider]. class StateNotifierProviderElement, - StateT> extends ProviderElementBase { + StateT> extends ProviderElement { StateNotifierProviderElement._(this.provider, super.container); @override @@ -212,7 +212,7 @@ class StateNotifierProviderElement, @override void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, + required void Function(ProviderElement element) elementVisitor, required void Function(ProxyElementValueListenable element) listenableVisitor, }) { diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index a2ff35a9e..f1b306379 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -112,7 +112,7 @@ final class StateProvider extends $FunctionalProvider } /// The element of [StateProvider]. -class StateProviderElement extends ProviderElementBase { +class StateProviderElement extends ProviderElement { StateProviderElement._(this.provider, super.container); @override @@ -161,7 +161,7 @@ class StateProviderElement extends ProviderElementBase { @override void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, + required void Function(ProviderElement element) elementVisitor, required void Function(ProxyElementValueListenable element) listenableVisitor, }) { diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index db53bd2da..5b1d6c803 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -343,8 +343,8 @@ base class Provider extends $FunctionalProvider /// - [Provider.family], to allow providers to create a value from external parameters. /// {@endtemplate} @internal -class $ProviderElement extends ProviderElementBase { - /// A [ProviderElementBase] for [Provider] +class $ProviderElement extends ProviderElement { + /// A [ProviderElement] for [Provider] $ProviderElement(this.provider, super.container); @override diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index ba7d3d2e8..b7ddf7789 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -151,8 +151,7 @@ base class StreamProvider /// The element of [StreamProvider]. @internal -class $StreamProviderElement - extends ProviderElementBase> +class $StreamProviderElement extends ProviderElement> with FutureModifierElement { /// The element of [StreamProvider]. $StreamProviderElement(this.provider, super.container); @@ -189,7 +188,7 @@ class $StreamProviderElement @override void visitChildren({ - required void Function(ProviderElementBase element) elementVisitor, + required void Function(ProviderElement element) elementVisitor, required void Function(ProxyElementValueListenable element) listenableVisitor, }) { diff --git a/packages/riverpod/test/new/core/scope_test.dart b/packages/riverpod/test/new/core/scope_test.dart index ac626a522..5286d8cc2 100644 --- a/packages/riverpod/test/new/core/scope_test.dart +++ b/packages/riverpod/test/new/core/scope_test.dart @@ -3,7 +3,7 @@ import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/framework.dart' show ProviderContainerTest; import 'package:riverpod/src/internals.dart' - show $ProviderElement, ProviderElementBase; + show $ProviderElement, ProviderElement; import 'package:test/test.dart'; import 'provider_container_test.dart'; @@ -562,13 +562,13 @@ Future main() async { expect( mid2.getAllProviderElements(), unorderedEquals([ - isA().having((e) => e.origin, 'origin', dep2), - isA().having((e) => e.origin, 'origin', a), - isA().having((e) => e.origin, 'origin', b), + isA().having((e) => e.origin, 'origin', dep2), + isA().having((e) => e.origin, 'origin', a), + isA().having((e) => e.origin, 'origin', b), ]), ); expect(mid.getAllProviderElements(), [ - isA().having((e) => e.origin, 'origin', dep), + isA().having((e) => e.origin, 'origin', dep), ]); expect(root.getAllProviderElements(), isEmpty); }); @@ -608,8 +608,8 @@ Future main() async { expect( mid.getAllProviderElements(), unorderedEquals([ - isA().having((e) => e.origin, 'origin', dep), - isA().having((e) => e.origin, 'origin', a), + isA().having((e) => e.origin, 'origin', dep), + isA().having((e) => e.origin, 'origin', a), ]), ); expect(root.getAllProviderElements(), isEmpty); @@ -641,8 +641,7 @@ Future main() async { expect( mid.getAllProviderElements(), [ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ], ); }); @@ -670,10 +669,8 @@ Future main() async { expect( mid.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), - isA() - .having((e) => e.origin, 'origin', family(21)), + isA().having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', family(21)), ]), ); }); @@ -702,11 +699,9 @@ Future main() async { expect( mid.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), - isA().having((e) => e.origin, 'origin', dep), - isA() - .having((e) => e.origin, 'origin', family(21)), + isA().having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', dep), + isA().having((e) => e.origin, 'origin', family(21)), ]), ); }); @@ -730,9 +725,8 @@ Future main() async { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), - isA().having((e) => e.origin, 'origin', dep), + isA().having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', dep), ]), ); expect(root.getAllProviderElements(), isEmpty); @@ -742,7 +736,7 @@ Future main() async { expect( container.getAllProviderElements(), [ - isA().having((e) => e.origin, 'origin', dep), + isA().having((e) => e.origin, 'origin', dep), ], ); expect(root.getAllProviderElements(), isEmpty); diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 03bbda9b0..40af8b7e8 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -278,7 +278,7 @@ void main() { expect( container.getAllProviderElements(), - [isA>()], + [isA>()], ); sub = container.listen(provider, (_, __) {}); diff --git a/packages/riverpod/test/old/framework/provider_element_test.dart b/packages/riverpod/test/old/framework/provider_element_test.dart index 69368c64b..9ece4a450 100644 --- a/packages/riverpod/test/old/framework/provider_element_test.dart +++ b/packages/riverpod/test/old/framework/provider_element_test.dart @@ -112,7 +112,7 @@ void main() { container.read(dependent); container.read(dependent2); - final children = []; + final children = []; container.readProviderElement(provider).visitChildren( elementVisitor: children.add, @@ -121,9 +121,9 @@ void main() { expect( children, unorderedMatches([ - isA() + isA() .having((e) => e.provider, 'provider', dependent), - isA() + isA() .having((e) => e.provider, 'provider', dependent2), ]), ); @@ -142,7 +142,7 @@ void main() { container.read(dependent); container.read(dependent2); - final children = []; + final children = []; container.readProviderElement(provider).visitChildren( elementVisitor: children.add, @@ -151,9 +151,9 @@ void main() { expect( children, unorderedMatches([ - isA() + isA() .having((e) => e.provider, 'provider', dependent), - isA() + isA() .having((e) => e.provider, 'provider', dependent2), ]), ); diff --git a/packages/riverpod/test/old/framework/ref_watch_test.dart b/packages/riverpod/test/old/framework/ref_watch_test.dart index 4bc8920d6..da696092c 100644 --- a/packages/riverpod/test/old/framework/ref_watch_test.dart +++ b/packages/riverpod/test/old/framework/ref_watch_test.dart @@ -1,7 +1,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../utils.dart'; @@ -266,7 +266,7 @@ void main() { final element = container.readProviderElement(provider); final selectedElement = container.readProviderElement(selected); - final ancestors = []; + final ancestors = []; element.visitAncestors(ancestors.add); expect(ancestors, [selectedElement]); diff --git a/packages/riverpod/test/old/legacy/framework2/framework_test.dart b/packages/riverpod/test/old/legacy/framework2/framework_test.dart index 4e811179c..6f9db565b 100644 --- a/packages/riverpod/test/old/legacy/framework2/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework2/framework_test.dart @@ -4,7 +4,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/internals.dart' - show $ProviderElement, ProviderElementBase; + show $ProviderElement, ProviderElement; import 'package:test/test.dart'; import '../../utils.dart'; @@ -257,12 +257,12 @@ void main() { final sub = container.listen(computed, (_, __) {}); expect(sub.read(), '0'); - var firstDependents = []; + var firstDependents = []; firstElement.visitChildren( elementVisitor: firstDependents.add, listenableVisitor: (_) {}, ); - var secondDependents = []; + var secondDependents = []; secondElement.visitChildren( elementVisitor: secondDependents.add, listenableVisitor: (_) {}, @@ -276,12 +276,12 @@ void main() { container.read(first.notifier).state++; expect(sub.read(), 'fallback'); - firstDependents = []; + firstDependents = []; firstElement.visitChildren( elementVisitor: firstDependents.add, listenableVisitor: (_) {}, ); - secondDependents = []; + secondDependents = []; secondElement.visitChildren( elementVisitor: secondDependents.add, listenableVisitor: (_) {}, @@ -322,7 +322,7 @@ void main() { final sub = container.listen(computed, (_, __) {}); expect(sub.read(), 0); - var firstDependents = []; + var firstDependents = []; firstElement.visitChildren( elementVisitor: firstDependents.add, listenableVisitor: (_) {}, @@ -333,7 +333,7 @@ void main() { sub.close(); await container.pump(); - firstDependents = []; + firstDependents = []; firstElement.visitChildren( elementVisitor: firstDependents.add, listenableVisitor: (_) {}, diff --git a/packages/riverpod/test/old/legacy/framework_test.dart b/packages/riverpod/test/old/legacy/framework_test.dart index 448582cfc..a41dee43e 100644 --- a/packages/riverpod/test/old/legacy/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework_test.dart @@ -1,7 +1,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/internals.dart' - show CircularDependencyError, ProviderElementBase; + show CircularDependencyError, ProviderElement; import 'package:test/test.dart'; import '../utils.dart'; @@ -46,10 +46,10 @@ void main() { expect(container.read(family2(0)), '0 2'); expect(container.getAllProviderElements(), [ - isA().having((e) => e.origin, 'origin', family2(0)), + isA().having((e) => e.origin, 'origin', family2(0)), ]); expect(root.getAllProviderElements(), [ - isA().having((e) => e.origin, 'origin', family(0)), + isA().having((e) => e.origin, 'origin', family(0)), ]); }); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart index 2acec720b..a0ed6dda4 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_family_test.dart @@ -1,6 +1,6 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../../../utils.dart'; @@ -58,7 +58,7 @@ void main() { expect( container.getAllProviderElementsInOrder(), unorderedEquals([ - isA() + isA() .having((e) => e.origin, 'origin', provider(0)), ]), ); @@ -87,7 +87,7 @@ void main() { expect( container.getAllProviderElementsInOrder(), unorderedEquals([ - isA() + isA() .having((e) => e.origin, 'origin', provider(0)), ]), ); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart index 1998af301..f46b40564 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart @@ -1,7 +1,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../../../utils.dart'; @@ -100,8 +100,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); }); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart index 2b4ad8b17..c60e3edea 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/family_test.dart @@ -1,7 +1,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../../../utils.dart'; @@ -59,7 +59,7 @@ void main() { expect( container.getAllProviderElementsInOrder(), unorderedEquals([ - isA() + isA() .having((e) => e.origin, 'origin', provider(0)), ]), ); @@ -88,7 +88,7 @@ void main() { expect( container.getAllProviderElementsInOrder(), unorderedEquals([ - isA() + isA() .having((e) => e.origin, 'origin', provider(0)), ]), ); @@ -139,7 +139,7 @@ void main() { expect( container.getAllProviderElementsInOrder(), [ - isA() + isA() .having((e) => e.provider, 'provider', family('0')), ], ); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart index ee8f7da8d..cf34d40df 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart @@ -5,7 +5,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../../../utils.dart'; @@ -202,8 +202,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); }); @@ -254,8 +253,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); }); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart index 2aaac0159..12884e204 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart @@ -1,6 +1,6 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; void main() { @@ -87,8 +87,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); }); @@ -135,8 +134,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); expect(root.getAllProviderElements(), isEmpty); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart index d427094e3..9f5dd6e34 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_auto_dispose_test.dart @@ -1,6 +1,6 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; void main() { @@ -44,7 +44,7 @@ void main() { expect( container.getAllProviderElementsInOrder(), unorderedEquals([ - isA() + isA() .having((e) => e.origin, 'origin', provider(0)), ]), ); @@ -70,7 +70,7 @@ void main() { expect( container.getAllProviderElementsInOrder(), unorderedEquals([ - isA() + isA() .having((e) => e.origin, 'origin', provider(0)), ]), ); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart index 5c3be8169..3e3f3e277 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_family_test.dart @@ -1,6 +1,6 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; void main() { @@ -42,7 +42,7 @@ void main() { expect( container.getAllProviderElementsInOrder(), unorderedEquals([ - isA() + isA() .having((e) => e.origin, 'origin', provider(0)), ]), ); @@ -68,7 +68,7 @@ void main() { expect( container.getAllProviderElementsInOrder(), unorderedEquals([ - isA() + isA() .having((e) => e.origin, 'origin', provider(0)), ]), ); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart index ab995ece9..259850759 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart @@ -3,7 +3,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../../../utils.dart'; @@ -181,8 +181,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); }); @@ -227,8 +226,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); }); diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart index 719d8a163..28553b52c 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart @@ -85,8 +85,7 @@ void main() { expect(container.read(provider(0)), const AsyncData(42)); expect(root.getAllProviderElementsInOrder(), isEmpty); expect(container.getAllProviderElementsInOrder(), [ - isA() - .having((e) => e.origin, 'origin', provider(0)), + isA().having((e) => e.origin, 'origin', provider(0)), ]); }); }); diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart index c13e84916..66d559fee 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart @@ -3,7 +3,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../../utils.dart'; @@ -233,7 +233,7 @@ void main() { expect(container.read(provider), const AsyncValue.data(0)); expect(root.getAllProviderElementsInOrder(), isEmpty); expect(container.getAllProviderElementsInOrder(), [ - isA().having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]); }); @@ -254,7 +254,7 @@ void main() { expect(container.read(provider), const AsyncValue.data(42)); expect(root.getAllProviderElementsInOrder(), isEmpty); expect(container.getAllProviderElementsInOrder(), [ - isA().having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]); }); @@ -273,7 +273,7 @@ void main() { expect(container.read(provider), const AsyncValue.data(42)); expect(root.getAllProviderElementsInOrder(), isEmpty); expect(container.getAllProviderElementsInOrder(), [ - isA().having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]); }); }); diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart index a350e7a59..2f9d98272 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/family_future_provider_test.dart @@ -1,5 +1,5 @@ import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; void main() { @@ -25,8 +25,7 @@ void main() { expect(await container.read(provider(0).future), 0); expect(container.read(provider(0)), const AsyncData(0)); expect(container.getAllProviderElementsInOrder(), [ - isA() - .having((e) => e.origin, 'origin', provider(0)), + isA().having((e) => e.origin, 'origin', provider(0)), ]); expect(root.getAllProviderElementsInOrder(), isEmpty); }); @@ -69,8 +68,7 @@ void main() { expect(container.read(provider(0)), const AsyncData(42)); expect(root.getAllProviderElementsInOrder(), isEmpty); expect(container.getAllProviderElementsInOrder(), [ - isA() - .having((e) => e.origin, 'origin', provider(0)), + isA().having((e) => e.origin, 'origin', provider(0)), ]); }); }); diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart index 3cbf69a04..700d50173 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart @@ -5,7 +5,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../../utils.dart'; @@ -404,7 +404,7 @@ void main() { expect(container.read(provider), const AsyncValue.data(0)); expect(root.getAllProviderElementsInOrder(), isEmpty); expect(container.getAllProviderElementsInOrder(), [ - isA().having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]); }); @@ -425,7 +425,7 @@ void main() { expect(container.read(provider), const AsyncValue.data(42)); expect(root.getAllProviderElementsInOrder(), isEmpty); expect(container.getAllProviderElementsInOrder(), [ - isA().having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]); }); @@ -446,7 +446,7 @@ void main() { expect(container.read(provider), const AsyncValue.data(42)); expect(root.getAllProviderElementsInOrder(), isEmpty); expect(container.getAllProviderElementsInOrder(), [ - isA().having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]); }); }); diff --git a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart index 98e4df0c6..32b7f67b1 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_family_test.dart @@ -1,6 +1,6 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../../utils.dart'; @@ -28,8 +28,7 @@ void main() { expect(container.read(provider(0)), 0); expect(container.getAllProviderElements(), [ - isA() - .having((e) => e.origin, 'origin', provider(0)), + isA().having((e) => e.origin, 'origin', provider(0)), ]); expect(root.getAllProviderElements(), isEmpty); }); diff --git a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart index 765e5adb5..a55205422 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart @@ -1,7 +1,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../../utils.dart'; @@ -131,8 +131,7 @@ void main() { expect(container.read(provider), 0); expect(container.getAllProviderElements(), [ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]); expect(root.getAllProviderElements(), isEmpty); }); @@ -152,8 +151,7 @@ void main() { expect(container.read(provider), 42); expect(container.getAllProviderElements(), [ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]); expect(root.getAllProviderElements(), isEmpty); }); @@ -173,8 +171,7 @@ void main() { expect(container.read(provider), 42); expect(container.getAllProviderElements(), [ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]); expect(root.getAllProviderElements(), isEmpty); }); diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart index 05eea9e1b..b0e13e1c9 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_family_test.dart @@ -1,5 +1,5 @@ import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; void main() { @@ -25,8 +25,7 @@ void main() { expect(container.read(provider(0)), 0); expect(container.getAllProviderElements(), [ - isA() - .having((e) => e.origin, 'origin', provider(0)), + isA().having((e) => e.origin, 'origin', provider(0)), ]); expect(root.getAllProviderElements(), isEmpty); }); @@ -45,8 +44,7 @@ void main() { expect(root.getAllProviderElements(), isEmpty); expect(container.read(provider(0)), 42); expect(container.getAllProviderElements(), [ - isA() - .having((e) => e.origin, 'origin', provider(0)), + isA().having((e) => e.origin, 'origin', provider(0)), ]); }); }); diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart index 88bccb353..ec21141c1 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart @@ -3,7 +3,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../../utils.dart'; @@ -184,8 +184,7 @@ void main() { expect(container.read(provider), 0); expect(container.getAllProviderElements(), [ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]); expect(root.getAllProviderElements(), isEmpty); }); @@ -203,8 +202,7 @@ void main() { expect(container.read(provider), 42); expect(container.getAllProviderElements(), [ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]); expect(root.getAllProviderElements(), isEmpty); }); @@ -224,8 +222,7 @@ void main() { expect(container.read(provider), 42); expect(container.getAllProviderElements(), [ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]); expect(root.getAllProviderElements(), isEmpty); }); diff --git a/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart index 7e12b7d7e..f2c9528ac 100644 --- a/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/scoped_provider/scoped_provider_test.dart @@ -1,6 +1,6 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../../utils.dart'; @@ -40,7 +40,7 @@ void main() { expect(container.getAllProviderElements(), isEmpty); expect(mid.getAllProviderElements(), [ - isA>() + isA>() .having((e) => e.origin, 'origin', provider) .having((e) => e.readSelf(), 'readSelf()', 42), ]); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart index 7379ecdb6..f8df2354a 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart @@ -1,5 +1,5 @@ import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../../utils.dart'; @@ -33,7 +33,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() + isA() .having((e) => e.origin, 'origin', provider(0)), ]), ); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart index be01b2fa7..52912a905 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart @@ -3,7 +3,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../../utils.dart'; @@ -203,8 +203,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); }); @@ -252,8 +251,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); }); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart index 3e1d36e4c..c08e3b860 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart @@ -1,5 +1,5 @@ import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; void main() { @@ -30,7 +30,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() + isA() .having((e) => e.origin, 'origin', provider(0)), ]), ); @@ -55,7 +55,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() + isA() .having((e) => e.origin, 'origin', provider(0)), ]), ); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart index 58e4803ee..9916d1594 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart @@ -5,7 +5,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' show ProviderElementBase; +import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; import '../../utils.dart'; @@ -306,8 +306,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); }); @@ -331,8 +330,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); }); @@ -356,8 +354,7 @@ void main() { expect( container.getAllProviderElements(), unorderedEquals([ - isA() - .having((e) => e.origin, 'origin', provider), + isA().having((e) => e.origin, 'origin', provider), ]), ); }); From 970e79cd1e75736317c765c8827b2a7b15ea57ae Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 17:49:50 +0100 Subject: [PATCH 280/387] Remove todo --- packages/riverpod/lib/src/core/element.dart | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 7aec256b0..4ba33bb47 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -40,7 +40,6 @@ void Function()? debugCanModifyProviders; /// of providers. /// Do not use. /// {@endtemplate} -// TODO rename to ProviderElement @internal @optionalTypeArgs abstract class ProviderElement implements Node { From a7d30f5241fe9dda7c0e887fd90673d6ebfcebeb Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 18:03:49 +0100 Subject: [PATCH 281/387] Cleanup --- .../lib/src/core/modifiers/future.dart | 3 --- packages/riverpod/lib/src/core/ref.dart | 2 +- .../riverpod/lib/src/providers/notifier.dart | 2 -- packages/riverpod/test/meta_test.dart | 1 - .../state_provider/state_provider_test.dart | 25 ++++++++----------- 5 files changed, 11 insertions(+), 22 deletions(-) diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 2a6a71077..2ab566535 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -299,17 +299,14 @@ mixin FutureModifierElement on ProviderElement> { final completer = _futureCompleter; if (completer != null) { completer - // TODO test ignore ..future.ignore() ..completeError( value.error, value.stackTrace, ); _futureCompleter = null; - // TODO SynchronousFuture.error } else { futureNotifier.result = Result.data( - // TODO test ignore Future.error( value.error, value.stackTrace, diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index f173b05d0..673595eba 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -119,7 +119,7 @@ final = Provider(dependencies: []); '''); } - // TODO move to a "onAddDependency" life-cycle + // TODO Consider all dependencies, not just ref.watch final queue = Queue.from( _element._providerDependents, ); diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index 256374677..9edd64b3b 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -124,8 +124,6 @@ class $NotifierProviderElement< // required bool seamless, }) { setStateResult(ResultError(error, stackTrace)); - // TODO report uncaught error to the zone - // Zone.current.handleUncaughtError(error, stackTrace); } @override diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index 89a47c3f6..9ff4a9564 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -8,7 +8,6 @@ import 'package:test/test.dart'; void main() { // TODO verify that inherited members reapply annotations - // TODO assert all ".notifier" and ".future" implement Refreshable // TODO assert all constructor parameters point to a field with dartdoc. // This verifies that: diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart index 259850759..ee3a6cb25 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart @@ -127,24 +127,19 @@ void main() { expect(container.read(provider), 42); }); - test( - 'can refresh .state', - skip: 'TODO', - () async { - // TODO fix this test - var initialValue = 1; - final provider = StateProvider((ref) => initialValue); - final container = ProviderContainer.test(); + test('can refresh .state', () async { + var initialValue = 1; + final provider = StateProvider((ref) => initialValue); + final container = ProviderContainer.test(); - expect(container.read(provider), 1); - expect(container.read(provider.notifier).state, 1); + expect(container.read(provider), 1); + expect(container.read(provider.notifier).state, 1); - initialValue = 42; + initialValue = 42; - expect(container.refresh(provider.notifier).state, 42); - expect(container.read(provider), 42); - }, - ); + expect(container.refresh(provider.notifier).state, 42); + expect(container.read(provider), 42); + }); test('can be refreshed', () async { var result = 0; From 367649cf6b1383e783af624f96eee7bd7219b0d8 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 18:08:26 +0100 Subject: [PATCH 282/387] Coverage --- .../stream_provider/stream_provider_test.dart | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart index 9916d1594..ead51b5ad 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart @@ -438,8 +438,8 @@ void main() { expect(container.read(provider.future), future); - // TODO(rrousselGit) test that the stacktrace is preserved await expectLater(future, throwsA(error)); + expect(await future.stackTrace, StackTrace.empty); final error2 = Error(); @@ -476,8 +476,8 @@ void main() { expect(container.read(provider.future), future); - // TODO(rrousselGit) test that the stacktrace is preserved await expectLater(future, throwsA(error)); + expect(await future.stackTrace, StackTrace.empty); final error2 = Error(); @@ -488,8 +488,8 @@ void main() { future = container.read(provider.future); - // TODO(rrousselGit) test that the stacktrace is preserved await expectLater(future, throwsA(error2)); + expect(await future.stackTrace, StackTrace.empty); }); test('supports loading then data then loading', () async { @@ -925,3 +925,14 @@ void main() { }); }); } + +extension on Future { + Future get stackTrace async { + try { + await this; + return null; + } catch (e, s) { + return s; + } + } +} From ad2c0fddbd37067e1018e5621f786b6ee3b96814 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 18:08:42 +0100 Subject: [PATCH 283/387] Coverage --- .../legacy_providers/stream_provider/stream_provider_test.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart index ead51b5ad..7af523a82 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart @@ -455,8 +455,8 @@ void main() { expect(container.read(provider.future), future); - // TODO(rrousselGit) test that the stacktrace is preserved await expectLater(future, throwsA(error2)); + expect(await future.stackTrace, StackTrace.empty); }); test('supports loading then error then another error', () async { From 2807d43f0a17049b7934febfca113908901579f4 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 18:12:10 +0100 Subject: [PATCH 284/387] Cleanup --- packages/riverpod/test/meta_test.dart | 2 - .../test/new/core/uni_directional_test.dart | 54 ------------------- 2 files changed, 56 deletions(-) diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index 9ff4a9564..5c0be455f 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -100,8 +100,6 @@ void main() { expect(visitor.templates, contains(macro), reason: 'Missing template'); } }); - - // TODO test @visibleForTesting/protected/internal & co are inherited when overridden } class _PublicAPIVisitor extends GeneralizingElementVisitor { diff --git a/packages/riverpod/test/new/core/uni_directional_test.dart b/packages/riverpod/test/new/core/uni_directional_test.dart index b62b363e1..9ef7a2b7c 100644 --- a/packages/riverpod/test/new/core/uni_directional_test.dart +++ b/packages/riverpod/test/new/core/uni_directional_test.dart @@ -31,60 +31,6 @@ void main() { ); }); - group('ProviderContainer.debugVsyncs', () { - // test('are called before modifying a provider', () { - // final provider = StateProvider((ref) => 0); - // final container = ProviderContainer(); - // final vsync = VsyncMock(); - // final vsync2 = VsyncMock(); - - // container.debugVsyncs.addAll([vsync, vsync2]); - - // final state = container.read(provider); - - // verifyZeroInteractions(vsync); - // verifyZeroInteractions(vsync2); - - // state.state++; - - // verifyOnly(vsync, vsync()); - // verifyOnly(vsync2, vsync2()); - // }); - - // test('are not called when flushing a provider', () { - // final dep = StateProvider((ref) => 0); - // final provider = Provider((ref) { - // return ref.watch(dep); - // }); - // final container = ProviderContainer(); - // final vsync = VsyncMock(); - - // final sub = container.listen(provider, (_) {}); - // container.read(dep.notifier).state++; - - // container.debugVsyncs.add(vsync); - - // sub.flush(); - - // verifyZeroInteractions(vsync); - // }); - - // test('are not called when re-creating a provider', () { - // final provider = Provider((ref) => 0); - // final container = ProviderContainer(); - // final vsync = VsyncMock(); - - // final sub = container.listen(provider, (_) {}); - // container.refresh(provider); - - // container.debugVsyncs.add(vsync); - - // sub.flush(); - - // verifyZeroInteractions(vsync); - // }); - }); - test('rebuilding a provider can modify other providers', () async { final dep = StateProvider((ref) => 0); final provider = Provider((ref) => ref.watch(dep)); From 88a865ba9bb61a7dccc13ca37f41054526799306 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 18:22:41 +0100 Subject: [PATCH 285/387] Mooore --- packages/riverpod/lib/src/core/element.dart | 7 +++- packages/riverpod/lib/src/core/ref.dart | 33 +++++++++++---- .../test/new/core/uni_directional_test.dart | 41 ++++++++++++++++++- 3 files changed, 69 insertions(+), 12 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 4ba33bb47..af8e07a96 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -551,15 +551,18 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu }) { final ref = this.ref!; ref._throwIfInvalidUsage(); - if (kDebugMode) ref._debugAssertCanDependOn(listenable); - return listenable.addListener( + final result = listenable.addListener( this, listener, fireImmediately: fireImmediately, onError: onError, onDependencyMayHaveChanged: onDependencyMayHaveChanged, ); + + if (kDebugMode) ref._debugAssertCanDependOn(listenable); + + return result; } void _onListen() { diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 673595eba..f7b87420c 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -120,12 +120,18 @@ final = Provider(dependencies: []); } // TODO Consider all dependencies, not just ref.watch - final queue = Queue.from( - _element._providerDependents, + final queue = Queue(); + _element.visitChildren( + elementVisitor: queue.add, + listenableVisitor: (_) {}, ); + while (queue.isNotEmpty) { final current = queue.removeFirst(); - queue.addAll(current._providerDependents); + current.visitChildren( + elementVisitor: queue.add, + listenableVisitor: (_) {}, + ); if (current.origin == dependency) { throw CircularDependencyError._(); @@ -221,9 +227,10 @@ final = Provider(dependencies: []); /// {@endtemplate} void invalidate(ProviderOrFamily providerOrFamily, {bool asReload = false}) { _throwIfInvalidUsage(); - if (kDebugMode) _debugAssertCanDependOn(providerOrFamily); container.invalidate(providerOrFamily, asReload: asReload); + + if (kDebugMode) _debugAssertCanDependOn(providerOrFamily); } /// Invokes [invalidate] on itself. @@ -419,9 +426,12 @@ final = Provider(dependencies: []); /// safer to use. T read(ProviderListenable listenable) { _throwIfInvalidUsage(); + + final result = container.read(listenable); + if (kDebugMode) _debugAssertCanDependOn(listenable); - return container.read(listenable); + return result; } /// {@template riverpod.exists} @@ -459,9 +469,12 @@ final = Provider(dependencies: []); /// {@endtemplate} bool exists(ProviderBase provider) { _throwIfInvalidUsage(); + + final result = container.exists(provider); + if (kDebugMode) _debugAssertCanDependOn(provider); - return container.exists(provider); + return result; } /// Obtains the state of a provider and causes the state to be re-evaluated @@ -539,8 +552,6 @@ final = Provider(dependencies: []); return sub.read(); } - if (kDebugMode) _debugAssertCanDependOn(listenable); - final element = container.readProviderElement(listenable); _element._dependencies.putIfAbsent(element, () { final previousSub = _element._previousDependencies?.remove(element); @@ -563,7 +574,11 @@ final = Provider(dependencies: []); return Object(); }); - return element.readSelf(); + final result = element.readSelf(); + + if (kDebugMode) _debugAssertCanDependOn(listenable); + + return result; } /// {@template riverpod.listen} diff --git a/packages/riverpod/test/new/core/uni_directional_test.dart b/packages/riverpod/test/new/core/uni_directional_test.dart index 9ef7a2b7c..ae63b2072 100644 --- a/packages/riverpod/test/new/core/uni_directional_test.dart +++ b/packages/riverpod/test/new/core/uni_directional_test.dart @@ -7,7 +7,7 @@ import '../utils.dart'; void main() { test( 'Catches sync circular dependency when the dependency is not yet mounted', - skip: true, () { + () { // regression for #1766 final container = ProviderContainer.test(); @@ -85,6 +85,45 @@ void main() { }); }); + group('ref.listen cannot end-up in a circular dependency', () { + test('direct dependency', () { + final provider = Provider((ref) => ref); + final provider2 = Provider((ref) => ref); + final container = ProviderContainer(); + + final ref = container.read(provider); + final ref2 = container.read(provider2); + + ref.watch(provider2); + expect( + () => ref2.listen(provider, (a, b) {}), + throwsA(isA()), + ); + }); + + test('indirect dependency', () { + final provider = Provider((ref) => ref); + final provider2 = Provider((ref) => ref); + final provider3 = Provider((ref) => ref); + final provider4 = Provider((ref) => ref); + final container = ProviderContainer(); + + final ref = container.read(provider); + final ref2 = container.read(provider2); + final ref3 = container.read(provider3); + final ref4 = container.read(provider4); + + ref.listen(provider2, (a, b) {}); + ref2.listen(provider3, (a, b) {}); + ref3.listen(provider4, (a, b) {}); + + expect( + () => ref4.listen(provider, (a, b) {}), + throwsA(isA()), + ); + }); + }); + group('ref.read cannot end-up in a circular dependency', () { test('direct dependency', () { final provider = Provider((ref) => ref); From 142a8d409ee5c17eea2078fccc792ca5b2637f5f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 18:28:01 +0100 Subject: [PATCH 286/387] Cleanup --- packages/riverpod/CHANGELOG.md | 2 +- packages/riverpod/lib/src/core/element.dart | 3 --- packages/riverpod/lib/src/core/foundation.dart | 9 +++------ packages/riverpod/lib/src/core/modifiers/future.dart | 1 - .../lib/src/core/provider/notifier_provider.dart | 1 - packages/riverpod/lib/src/core/provider_container.dart | 8 -------- packages/riverpod/lib/src/core/ref.dart | 2 +- 7 files changed, 5 insertions(+), 21 deletions(-) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index a5948e0e4..0e87ed343 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -5,7 +5,7 @@ - **Breaking**: Removed all `Ref` subclasses (such `FutureProviderRef`). Use `Ref` directly instead. For `FutureProviderRef.future`, migrate to using an `AsyncNotifier`. -- **Breaking** All ref methods besides "mounted" now throw if used on unmounted refs. +- **Breaking** All ref and notifier methods besides "mounted" now throw if used after getting disposed. - **Breaking**: `StateProvider` and `StateNotifierProvider` are moved out of `package:flutter_riverpod/flutter_riverpod.dart` to `package:flutter_riverpod/legacy.dart`. diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index af8e07a96..4c0461cd8 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -666,9 +666,6 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu runOnDispose(); ref = null; - // TODO test invalidateSelf() then dispose() properly unlinks dependencies - // TODO test [Ref.listen] calls are cleared - for (final sub in _dependencies.entries) { sub.key._providerDependents.remove(this); sub.key._onRemoveListener(); diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index e578e1941..17b26f39c 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -106,13 +106,12 @@ sealed class ProviderOrFamily implements ProviderListenableOrFamily { } extension on ProviderListenableOrFamily { - ProviderBase? get listenedProvider { + ProviderBase? get debugListenedProvider { final that = this; return switch (that) { ProviderBase() => that, - // TODO refactor to listenable.provider - _ProviderSelector() => that.provider.listenedProvider, - _AsyncSelector() => that.provider.listenedProvider, + _ProviderSelector() => that.provider.debugListenedProvider, + _AsyncSelector() => that.provider.debugListenedProvider, ProviderElementProxy() => that.provider, _ => null, }; @@ -175,11 +174,9 @@ String shortHash(Object? object) { mixin ProviderListenable implements ProviderListenableOrFamily { /// Starts listening to this transformer ProviderSubscription addListener( - // TODO remove Node and pass directly the listened Element Node node, void Function(StateT? previous, StateT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, - // TODO remove required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, }); diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 2ab566535..4c54e86f5 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -545,7 +545,6 @@ extension on Stream { case ResultData(:final state): completer.complete(state); case ResultError(:final error, :final stackTrace): - // TODO: should this be reported to the zone? completer.future.ignore(); completer.completeError(error, stackTrace); } diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index cf4524142..b367ca772 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -66,7 +66,6 @@ abstract class NotifierBase { return ref; } - // TODO chnagelog breaking: reading state/future in Notifiers after dispose throws @visibleForTesting @protected StateT get state => ref.state; diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 4a9feacec..3ea34923f 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -318,7 +318,6 @@ class ProviderPointerManager { } final familyPointer = familyPointers[from] ??= ProviderDirectory.empty( - // TODO use rootOrSelf container._root ?? container, familyOverride: null, ); @@ -745,12 +744,6 @@ class ProviderContainer implements Node { /// Executes [ProviderElement.debugReassemble] on all the providers. void debugReassemble() { -// TODO hot-reload handle provider type change -// TODO hot-reload handle provider response type change -// TODO hot-reload handle provider -> family -// TODO hot-reload handle family adding parameters -// TODO found "Future already completed error" after adding family parameter - if (kDebugMode) { for (final element in getAllProviderElements()) { element.debugReassemble(); @@ -802,7 +795,6 @@ class ProviderContainer implements Node { providerToRefresh = refreshable; case _ProviderRefreshable(:final provider): providerToRefresh = provider; - // TODO: Handle this case. } invalidate(providerToRefresh); diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index f7b87420c..8ab8e5c04 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -77,7 +77,7 @@ base class Ref { void _debugAssertCanDependOn(ProviderListenableOrFamily listenable) { final dependency = switch (listenable) { ProviderOrFamily() => listenable, - _ => listenable.listenedProvider, + _ => listenable.debugListenedProvider, }; if (dependency == null) return; From 78419aed31f71a76a9346bde6ba05831e90f2667 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 18:36:54 +0100 Subject: [PATCH 287/387] Cleanup --- packages/flutter_riverpod/lib/src/core/consumer.dart | 2 -- .../flutter_riverpod/lib/src/core/provider_scope.dart | 10 ---------- packages/riverpod/lib/riverpod.dart | 2 -- packages/riverpod/lib/src/core/family.dart | 1 + packages/riverpod/lib/src/core/modifiers/future.dart | 1 - packages/riverpod/lib/src/core/provider_container.dart | 10 +--------- packages/riverpod/lib/src/core/ref.dart | 1 - .../src/providers/legacy/state_notifier_provider.dart | 6 +----- packages/riverpod/lib/src/providers/notifier.dart | 1 - packages/riverpod/lib/src/providers/provider.dart | 1 - .../lib/src/nodes/providers/providers.dart | 3 --- 11 files changed, 3 insertions(+), 35 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/core/consumer.dart b/packages/flutter_riverpod/lib/src/core/consumer.dart index b32454514..88dd30462 100644 --- a/packages/flutter_riverpod/lib/src/core/consumer.dart +++ b/packages/flutter_riverpod/lib/src/core/consumer.dart @@ -372,7 +372,6 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { @override Widget build() { - // TODO disallow didChangeDependencies try { _oldDependencies = _dependencies; for (var i = 0; i < _listeners.length; i++) { @@ -494,7 +493,6 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { final container = ProviderScope.containerOf(this, listen: false); final sub = _ListenManual( - // TODO somehow pass "this" instead for the devtool's sake container, container.listen( provider, diff --git a/packages/flutter_riverpod/lib/src/core/provider_scope.dart b/packages/flutter_riverpod/lib/src/core/provider_scope.dart index 154127318..264deb425 100644 --- a/packages/flutter_riverpod/lib/src/core/provider_scope.dart +++ b/packages/flutter_riverpod/lib/src/core/provider_scope.dart @@ -149,16 +149,6 @@ final class ProviderScopeState extends State { parent: parent, overrides: widget.overrides, observers: widget.observers, - // TODO How to report to FlutterError? - // onError: (dynamic error, stack) { - // FlutterError.reportError( - // FlutterErrorDetails( - // library: 'flutter_provider', - // exception: error, - // stack: stack, - // ), - // ); - // }, ); } diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 6ba15ac06..67dc9e532 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -1,5 +1,3 @@ -// TODO assert all provider variants have const constructors - export 'src/core/async_value.dart' hide AsyncTransition; export 'src/framework.dart' hide diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index 118d6e6ac..373dc61a7 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -180,6 +180,7 @@ class ClassFamily< // isAutoDispose: isAutoDispose, from: this, argument: argument, + // TODO Why are dependencies set here but not in FunctionalFanily? dependencies: dependencies, allTransitiveDependencies: allTransitiveDependencies, runNotifierBuildOverride: null, diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 4c54e86f5..14152e853 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -261,7 +261,6 @@ mixin FutureModifierElement on ProviderElement> { @override @protected void setStateResult(Result> newState) { - // TODO assert Notifier isn't disposed newState.requireState.map( loading: onLoading, error: onError, diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 3ea34923f..fe3623d2e 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -146,8 +146,6 @@ class ProviderDirectory implements _PointerBase { ProviderBase provider, { required ProviderContainer currentContainer, }) { - // TODO throw if a provider is overridden but does not specify dependencies - return pointers._upsert( provider, currentContainer: currentContainer, @@ -202,11 +200,8 @@ class ProviderDirectory implements _PointerBase { /// This has otherwise no impact unless there is a bug. pointer.element = element; - // TODO test family(42) overrides on nested containers receive the correct container element - // TODO remove .._origin = origin - // TODO make this optional ..mount(); } @@ -412,8 +407,6 @@ class ProviderPointerManager { inherit: (target) { final parentPointer = target._pointerManager._mountFamily(family); - // TODO don't fork a family if no family(42) is overridden - return ProviderDirectory.from(parentPointer); }, scope: ({override}) { @@ -706,7 +699,7 @@ class ProviderContainer implements Node { /// Awaits for providers to rebuild/be disposed and for listeners to be notified. Future pump() async { final a = scheduler.pendingFuture; - // TODO should be recursive + // TODO should wait for all children, but not parents final b = _parent?.scheduler.pendingFuture; await Future.wait([ @@ -759,7 +752,6 @@ class ProviderContainer implements Node { bool fireImmediately = false, void Function(Object error, StackTrace stackTrace)? onError, }) { - // TODO test always flushed provider return provider.addListener( this, listener, diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 8ab8e5c04..d0641f586 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -119,7 +119,6 @@ final = Provider(dependencies: []); '''); } - // TODO Consider all dependencies, not just ref.watch final queue = Queue(); _element.visitChildren( elementVisitor: queue.add, diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index dd1d23b4c..93334d62b 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -179,10 +179,7 @@ class StateNotifierProviderElement, () => provider._create(ref), ); - _removeListener = notifier - // TODO test requireState, as ref.read(p) is expected to throw if notifier creation failed - .requireState - .addListener( + _removeListener = notifier.requireState.addListener( (newState) => setStateResult(ResultData(newState)), fireImmediately: true, ); @@ -190,7 +187,6 @@ class StateNotifierProviderElement, @override bool updateShouldNotify(StateT previous, StateT next) { - // TODO test that updateShouldNotify is applied return _notifierNotifier.result!.requireState // ignore: invalid_use_of_protected_member .updateShouldNotify(previous, next); diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index 9edd64b3b..8a4116709 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -76,7 +76,6 @@ abstract class $Notifier extends NotifierBase { @override @visibleForOverriding bool updateShouldNotify(StateT previous, StateT next) { - // TODO unify updateShouldNotify to use == or identical everywhere return !identical(previous, next); } } diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 5b1d6c803..df922d39b 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -17,7 +17,6 @@ base mixin $Provider on ProviderBase { base class Provider extends $FunctionalProvider with $Provider>, LegacyProviderMixin { /// {@macro riverpod.provider} - // TODO make all providers const under all variations Provider( this._create, { super.name, diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/providers.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/providers.dart index 26053b69b..4ca651d43 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/providers.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/providers.dart @@ -50,9 +50,6 @@ sealed class GeneratorProviderDeclaration extends ProviderDeclaration { TypeAnnotation? get createdTypeNode; String computeProviderHash() { - // TODO improve hash function to inspect the body of the create fn - // such that the hash changes if one of the element defined outside of the - // fn changes. final bytes = utf8.encode(node.toSource()); final digest = sha1.convert(bytes); return digest.toString(); From 597da1f9defbff643c94b0636ef4b3b4d6b249c9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 18:39:32 +0100 Subject: [PATCH 288/387] More --- packages/flutter_riverpod/lib/src/core/widget_ref.dart | 1 - packages/riverpod/lib/src/core/family.dart | 1 - packages/riverpod/lib/src/core/modifiers/future.dart | 4 ---- .../riverpod/lib/src/core/provider/notifier_provider.dart | 2 -- packages/riverpod/lib/src/providers/future_provider.dart | 1 - packages/riverpod/test/new/core/ref_test.dart | 1 - 6 files changed, 10 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/core/widget_ref.dart b/packages/flutter_riverpod/lib/src/core/widget_ref.dart index 5841b2784..213c7614f 100644 --- a/packages/flutter_riverpod/lib/src/core/widget_ref.dart +++ b/packages/flutter_riverpod/lib/src/core/widget_ref.dart @@ -1,6 +1,5 @@ part of '../core.dart'; -// TODO change this doc /// {@template flutter_riverpod.widget_ref} /// An object that allows widgets to interact with providers. /// diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index 373dc61a7..cbfca1ccf 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -165,7 +165,6 @@ class ClassFamily< // required super.isAutoDispose, }); -// TODO docs @internal final ClassProviderFactory, ArgT> providerFactory; diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 14152e853..5a1a8981e 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -446,10 +446,6 @@ mixin FutureModifierElement on ProviderElement> { sub == null || _lastFuture != null, 'An async operation is pending but the state for provider.future was not initialized.', ); - - // TODO test build throws -> provider emits AsyncError synchronously & .future emits Future.error - // TODO test build resolves with error -> emits AsyncError & .future emits Future.error - // TODO test build emits value -> .future emits value & provider emits AsyncData } catch (error, stackTrace) { onError( AsyncError(error, stackTrace), diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index b367ca772..3eac52cf8 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -57,7 +57,6 @@ typedef RunNotifierBuild< // abstract class NotifierBase { Ref? _ref; - // TODO docs @protected Ref get ref { final ref = _ref; @@ -137,7 +136,6 @@ abstract base class $ClassProvider< // ); } - // TODO docs /// {@template riverpod.override_with_build} /// Hello world /// {@endtemplate} diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index b46313996..45dc0a18b 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -129,7 +129,6 @@ final class FutureProvider /// {@macro riverpod.family} static const family = FutureProviderFamilyBuilder(); - /// TODO add dartdoc on all create cbs. final Create, Ref>> _create; @override diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart index b04de5c8f..3e83558fc 100644 --- a/packages/riverpod/test/new/core/ref_test.dart +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -9,7 +9,6 @@ import 'package:test/test.dart'; import '../utils.dart'; -// TODO automatically generate this list for maintainability final refMethodsThatDependOnProviders = ref, ProviderBase)>{ 'watch': (ref, p) => ref.watch(p), From c31e9132a6264dedec3fc6a30fa171cdcf924d4b Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 19:33:29 +0100 Subject: [PATCH 289/387] Coverage --- .../lib/src/core/modifiers/select.dart | 6 ----- .../riverpod/test/new/core/select_test.dart | 27 +++++++++++++++++++ 2 files changed, 27 insertions(+), 6 deletions(-) create mode 100644 packages/riverpod/test/new/core/select_test.dart diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index bfafe4d80..944ad8024 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -45,12 +45,10 @@ class _ProviderSelector with ProviderListenable { try { return switch (value) { ResultData(:final state) => Result.data(selector(state)), - // TODO test ResultError(:final error, :final stackTrace) => Result.error(error, stackTrace), }; } catch (err, stack) { - // TODO test return Result.error(err, stack); } finally { if (kDebugMode) _debugIsRunningSelector = false; @@ -68,14 +66,10 @@ class _ProviderSelector with ProviderListenable { if (!lastSelectedValue.hasState || !newSelectedValue.hasState || lastSelectedValue.requireState != newSelectedValue.requireState) { - // TODO test events after selector exception correctly send `previous`s - onChange(newSelectedValue); - // TODO test handle exception in listener switch (newSelectedValue) { case ResultData(:final state): listener( - // TODO test from error lastSelectedValue.stateOrNull, state, ); diff --git a/packages/riverpod/test/new/core/select_test.dart b/packages/riverpod/test/new/core/select_test.dart new file mode 100644 index 000000000..eb9c37a6b --- /dev/null +++ b/packages/riverpod/test/new/core/select_test.dart @@ -0,0 +1,27 @@ +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +void main() { + group('provider.select', () { + test('handles when the selector throws', () { + final provider = Provider((ref) => Object()); + final container = ProviderContainer.test(); + + final errors = []; + container.read(provider); + final sub = container.listen( + provider.select((value) => throw StateError('Foo')), + (_, __) {}, + onError: (err, stack) => errors.add(err), + ); + + container.invalidate(provider); + + expect( + sub.read, + throwsA(isStateError.having((e) => e.message, 'message', 'Foo')), + ); + expect(errors, [isStateError.having((e) => e.message, 'message', 'Foo')]); + }); + }); +} From 86e1176b38dc55765824585f0d370189d133e7b9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 19:34:45 +0100 Subject: [PATCH 290/387] Outdated todos --- packages/riverpod/test/new/core/provider_test.dart | 7 ------- 1 file changed, 7 deletions(-) diff --git a/packages/riverpod/test/new/core/provider_test.dart b/packages/riverpod/test/new/core/provider_test.dart index 975e1e168..45e6d4085 100644 --- a/packages/riverpod/test/new/core/provider_test.dart +++ b/packages/riverpod/test/new/core/provider_test.dart @@ -3,13 +3,6 @@ import 'package:test/test.dart'; void main() { group('ProviderBase', () { - // TODO assert all providers have an "internal" const constructor - // TODO assert all non-internal constructors set allTransitiveDependencies - // TODO assert all constructors have isAutoDispose optional parameter - // TODO assert all default constructors set isAutoDispose=false by default - // TODO assert all .autoDispose constructors set isAutoDispose=true - // TODO assert all families have a default constructor - test('allTransitiveDependencies', () { final a = Provider((ref) => 0); final b = Provider.family((ref, _) => 0, dependencies: [a]); From 3bdbe9aa657ceb917d71ac8bb9abaed6ff8c4a36 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 19:57:49 +0100 Subject: [PATCH 291/387] More --- .../test/consumer_listen_test.dart | 2 ++ packages/riverpod/lib/src/core/element.dart | 1 - packages/riverpod/lib/src/core/family.dart | 6 ++---- .../riverpod/lib/src/core/provider_container.dart | 15 +++++++-------- .../riverpod/test/new/core/provider_test.dart | 5 +++++ packages/riverpod/test/new/matrix.dart | 2 ++ .../test/new/matrix/async_notifier_provider.dart | 5 +++++ .../test/new/matrix/notifier_provider.dart | 5 +++++ .../test/new/matrix/stream_notifier_provider.dart | 5 +++++ .../test/new/providers/async_notifier_test.dart | 13 +++++++++++++ 10 files changed, 46 insertions(+), 13 deletions(-) diff --git a/packages/flutter_riverpod/test/consumer_listen_test.dart b/packages/flutter_riverpod/test/consumer_listen_test.dart index 550de75c4..7b22fe6e4 100644 --- a/packages/flutter_riverpod/test/consumer_listen_test.dart +++ b/packages/flutter_riverpod/test/consumer_listen_test.dart @@ -1,3 +1,5 @@ +// ignore_for_file: invalid_use_of_internal_member + import 'package:flutter/material.dart' hide Listener; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_riverpod/legacy.dart'; diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 4c0461cd8..d55372e93 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -305,7 +305,6 @@ This could mean a few things: .._onRemoveListener(); } _previousDependencies = null; - // TODO clear subscriptions only after the provider has been rebuilt } /// Initialize a provider. diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index cbfca1ccf..12488b073 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -108,7 +108,6 @@ class FunctionalFamily< // isAutoDispose: isAutoDispose, from: this, argument: argument, - // TODO test all families set dependencies as null dependencies: null, allTransitiveDependencies: null, ); @@ -179,9 +178,8 @@ class ClassFamily< // isAutoDispose: isAutoDispose, from: this, argument: argument, - // TODO Why are dependencies set here but not in FunctionalFanily? - dependencies: dependencies, - allTransitiveDependencies: allTransitiveDependencies, + dependencies: null, + allTransitiveDependencies: null, runNotifierBuildOverride: null, ); } diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index fe3623d2e..450c8ca9b 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -668,7 +668,7 @@ class ProviderContainer implements Node { /// How deep this [ProviderContainer] is in the graph of containers. /// /// Starts at 0. - /// TODO check this is still used after refactoring + @internal final int depth; final ProviderContainer? _root; final ProviderContainer? _parent; @@ -697,14 +697,16 @@ class ProviderContainer implements Node { bool _disposed = false; /// Awaits for providers to rebuild/be disposed and for listeners to be notified. + /// + /// + /// This call is recursive and will wait for ancestor [ProviderContainer]s to + /// rebuild their providers too. Future pump() async { final a = scheduler.pendingFuture; - // TODO should wait for all children, but not parents - final b = _parent?.scheduler.pendingFuture; await Future.wait([ if (a != null) a, - if (b != null) b, + if (parent case final parent?) parent.pump(), ]); } @@ -880,8 +882,6 @@ class ProviderContainer implements Node { runUnaryGuarded(element.update, override.providerOverride); case _FamilyOverride(): - // TODO assert family override did not change - final pointer = _pointerManager.familyPointers[override.from]; if (kDebugMode) { @@ -896,8 +896,7 @@ class ProviderContainer implements Node { } } - /// TODO make private - /// TODO remove generic + @internal @override ProviderElement readProviderElement( ProviderBase provider, diff --git a/packages/riverpod/test/new/core/provider_test.dart b/packages/riverpod/test/new/core/provider_test.dart index 45e6d4085..9c757eb9e 100644 --- a/packages/riverpod/test/new/core/provider_test.dart +++ b/packages/riverpod/test/new/core/provider_test.dart @@ -10,6 +10,11 @@ void main() { final d = Provider((ref) => 0, dependencies: [c]); expect(d.allTransitiveDependencies, containsAll([a, b, c])); + + expect(b.allTransitiveDependencies, isNotNull); + expect(b.dependencies, isNotNull); + expect(b(21).allTransitiveDependencies, isNull); + expect(b(21).dependencies, isNull); }); }); } diff --git a/packages/riverpod/test/new/matrix.dart b/packages/riverpod/test/new/matrix.dart index e0784edaf..cefe6a1d4 100644 --- a/packages/riverpod/test/new/matrix.dart +++ b/packages/riverpod/test/new/matrix.dart @@ -23,10 +23,12 @@ class TestFactory { TestFactory({ required this.value, required this.isAutoDispose, + required this.isFamily, }); final T value; final bool isAutoDispose; + final bool isFamily; } typedef ProviderFactory diff --git a/packages/riverpod/test/new/matrix/async_notifier_provider.dart b/packages/riverpod/test/new/matrix/async_notifier_provider.dart index 485088326..92c5c8174 100644 --- a/packages/riverpod/test/new/matrix/async_notifier_provider.dart +++ b/packages/riverpod/test/new/matrix/async_notifier_provider.dart @@ -4,6 +4,7 @@ final asyncNotifierProviderFactory = TestMatrix( { 'AsyncNotifierProvider': AsyncNotifierTestFactory( isAutoDispose: false, + isFamily: false, deferredNotifier: DeferredAsyncNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return AsyncNotifierProvider, StateT>( @@ -27,6 +28,7 @@ final asyncNotifierProviderFactory = TestMatrix( ), 'AsyncNotifierProvider.autoDispose': AsyncNotifierTestFactory( isAutoDispose: true, + isFamily: false, deferredNotifier: DeferredAsyncNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return AsyncNotifierProvider.autoDispose, @@ -53,6 +55,7 @@ final asyncNotifierProviderFactory = TestMatrix( ), 'AsyncNotifierProvider.family': AsyncNotifierTestFactory( isAutoDispose: false, + isFamily: true, deferredNotifier: DeferredFamilyAsyncNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return AsyncNotifierProvider.family, @@ -80,6 +83,7 @@ final asyncNotifierProviderFactory = TestMatrix( ), 'AsyncNotifierProvider.autoDispose.family': AsyncNotifierTestFactory( isAutoDispose: true, + isFamily: true, deferredNotifier: DeferredFamilyAsyncNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return AsyncNotifierProvider.family @@ -175,6 +179,7 @@ class AsyncNotifierTestFactory extends TestFactory< ProviderFactory<$AsyncNotifier, ProviderBase, void>> { AsyncNotifierTestFactory({ required super.isAutoDispose, + required super.isFamily, required super.value, required this.deferredNotifier, required this.deferredProvider, diff --git a/packages/riverpod/test/new/matrix/notifier_provider.dart b/packages/riverpod/test/new/matrix/notifier_provider.dart index 01247d368..8760b35c5 100644 --- a/packages/riverpod/test/new/matrix/notifier_provider.dart +++ b/packages/riverpod/test/new/matrix/notifier_provider.dart @@ -4,6 +4,7 @@ final notifierProviderFactory = TestMatrix( { 'NotifierProvider': NotifierTestFactory( isAutoDispose: false, + isFamily: false, deferredNotifier: DeferredNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return NotifierProvider, StateT>( @@ -26,6 +27,7 @@ final notifierProviderFactory = TestMatrix( ), 'NotifierProvider.autoDispose': NotifierTestFactory( isAutoDispose: true, + isFamily: false, deferredNotifier: DeferredNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return NotifierProvider.autoDispose, StateT>( @@ -50,6 +52,7 @@ final notifierProviderFactory = TestMatrix( ), 'NotifierProvider.family': NotifierTestFactory( isAutoDispose: false, + isFamily: true, deferredNotifier: DeferredFamilyNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return NotifierProvider.family, StateT, @@ -77,6 +80,7 @@ final notifierProviderFactory = TestMatrix( ), 'NotifierProvider.autoDispose.family': NotifierTestFactory( isAutoDispose: true, + isFamily: true, deferredNotifier: DeferredFamilyNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return NotifierProvider.family @@ -168,6 +172,7 @@ class NotifierTestFactory extends TestFactory< ProviderFactory<$Notifier, ProviderBase, void>> { NotifierTestFactory({ required super.isAutoDispose, + required super.isFamily, required super.value, required this.deferredNotifier, required this.deferredProvider, diff --git a/packages/riverpod/test/new/matrix/stream_notifier_provider.dart b/packages/riverpod/test/new/matrix/stream_notifier_provider.dart index 0939ebb59..064a4198b 100644 --- a/packages/riverpod/test/new/matrix/stream_notifier_provider.dart +++ b/packages/riverpod/test/new/matrix/stream_notifier_provider.dart @@ -4,6 +4,7 @@ final streamNotifierProviderFactory = TestMatrix( { 'StreamNotifierProvider': StreamNotifierTestFactory( isAutoDispose: false, + isFamily: false, deferredNotifier: DeferredStreamNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return StreamNotifierProvider, StateT>( @@ -27,6 +28,7 @@ final streamNotifierProviderFactory = TestMatrix( ), 'StreamNotifierProvider.autoDispose': StreamNotifierTestFactory( isAutoDispose: true, + isFamily: false, deferredNotifier: DeferredStreamNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return StreamNotifierProvider.autoDispose< @@ -54,6 +56,7 @@ final streamNotifierProviderFactory = TestMatrix( ), 'StreamNotifierProvider.family': StreamNotifierTestFactory( isAutoDispose: false, + isFamily: true, deferredNotifier: DeferredFamilyStreamNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return StreamNotifierProvider.family< @@ -81,6 +84,7 @@ final streamNotifierProviderFactory = TestMatrix( ), 'StreamNotifierProvider.autoDispose.family': StreamNotifierTestFactory( isAutoDispose: true, + isFamily: true, deferredNotifier: DeferredFamilyStreamNotifier.new, deferredProvider: (create, {updateShouldNotify}) { return StreamNotifierProvider.family @@ -176,6 +180,7 @@ class StreamNotifierTestFactory extends TestFactory< ProviderFactory<$StreamNotifier, ProviderBase, void>> { StreamNotifierTestFactory({ required super.isAutoDispose, + required super.isFamily, required super.value, required this.deferredNotifier, required this.deferredProvider, diff --git a/packages/riverpod/test/new/providers/async_notifier_test.dart b/packages/riverpod/test/new/providers/async_notifier_test.dart index add8cb446..3be89ce47 100644 --- a/packages/riverpod/test/new/providers/async_notifier_test.dart +++ b/packages/riverpod/test/new/providers/async_notifier_test.dart @@ -28,6 +28,19 @@ void main() { }); asyncNotifierProviderFactory.createGroup((factory) { + if (factory.isFamily) { + test('sets provider(arg) dependencies/allTransitiveDependencies to null', + () { + final provider = factory.value( + (_, arg) => factory.deferredNotifier((ref) => 0), + dependencies: [], + ); + + expect(provider().dependencies, null); + expect(provider().allTransitiveDependencies, null); + }); + } + test('Cannot share a Notifier instance between providers ', () { final container = ProviderContainer.test(); final notifier = factory.deferredNotifier((ref) => 0); From b3298f16ec661a0da6aba1caec9b5c986a90ecd1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 20:08:01 +0100 Subject: [PATCH 292/387] Remove commented code --- .../test/new/core/async_value_test.dart | 27 +-- .../new/providers/async_notifier_test.dart | 19 +- .../test/new/providers/notifier_test.dart | 5 +- .../test/old/legacy/devtool_test.dart | 175 ------------------ .../old/legacy/framework2/framework_test.dart | 38 ++-- ..._dispose_state_notifier_provider_test.dart | 63 ------- .../state_notifier_provider_test.dart | 48 ----- .../state_provider_auto_dispose_test.dart | 41 ---- .../state_provider/state_provider_test.dart | 63 ------- ...o_dispose_family_future_provider_test.dart | 3 - .../provider/auto_dispose_provider_test.dart | 5 +- .../provider/provider_test.dart | 5 +- .../auto_dispose_stream_provider_test.dart | 53 +++--- .../stream_provider/stream_provider_test.dart | 3 +- 14 files changed, 57 insertions(+), 491 deletions(-) delete mode 100644 packages/riverpod/test/old/legacy/devtool_test.dart diff --git a/packages/riverpod/test/new/core/async_value_test.dart b/packages/riverpod/test/new/core/async_value_test.dart index 14c1aab0a..9967be67e 100644 --- a/packages/riverpod/test/new/core/async_value_test.dart +++ b/packages/riverpod/test/new/core/async_value_test.dart @@ -1,4 +1,4 @@ -// ignore_for_file: avoid_types_on_closure_parameters +// ignore_for_file: avoid_types_on_closure_parameters, prefer_const_constructors, prefer_const_declarations import 'dart:async'; @@ -380,7 +380,6 @@ void main() { test('asError', () { const value = AsyncValue.error(42, StackTrace.empty); - // ignore: omit_local_variable_types, unused_local_variable, testing that assignment works, final AsyncError? error = value.asError; expect(const AsyncData(42).asError, null); @@ -485,7 +484,6 @@ void main() { group('mapOrNull', () { test('supports returning null when relying on type-inference', () { - // ignore: unused_local_variable, omit_local_variable_types final int? x2 = const AsyncValue.data(1).mapOrNull( data: (value) => null, error: (_) => null, @@ -1011,7 +1009,6 @@ void main() { group('whenOrNull', () { test('supports returning null when relying on type-inference', () { - // ignore: unused_local_variable, omit_local_variable_types final int? x2 = const AsyncValue.data(1).whenOrNull( data: (value) => null, error: (err, stack) => null, @@ -1077,9 +1074,7 @@ void main() { }); test('==', () { - // ignore: prefer_const_declarations, not using const to test runtime final value = 42; - // ignore: prefer_const_declarations, not using const to test runtime final value2 = 21; final stack = StackTrace.current; @@ -1144,21 +1139,15 @@ void main() { ); expect( - // ignore: prefer_const_constructors AsyncLoading(), - // ignore: prefer_const_constructors AsyncLoading(), ); expect( - // ignore: prefer_const_constructors AsyncLoading(), - // ignore: prefer_const_constructors isNot(AsyncValue.loading()), ); expect( - // ignore: prefer_const_constructors AsyncValue.loading(), - // ignore: prefer_const_constructors isNot(AsyncLoading()), ); @@ -1181,9 +1170,7 @@ void main() { }); test('hashCode', () { - // ignore: prefer_const_declarations final value = 42; - // ignore: prefer_const_declarations final value2 = 21; final stack = StackTrace.current; @@ -1244,21 +1231,15 @@ void main() { ); expect( - // ignore: prefer_const_constructors AsyncLoading().hashCode, - // ignore: prefer_const_constructors AsyncLoading().hashCode, ); expect( - // ignore: prefer_const_constructors AsyncLoading().hashCode, - // ignore: prefer_const_constructors isNot(AsyncValue.loading().hashCode), ); expect( - // ignore: prefer_const_constructors AsyncValue.loading().hashCode, - // ignore: prefer_const_constructors isNot(AsyncLoading().hashCode), ); @@ -1468,11 +1449,10 @@ void main() { test('catches errors in data transformer and return AsyncError', () { expect( const AsyncValue.data(42).whenData( - // ignore: only_throw_errors - (value) => throw '42', + (value) => throw StateError('foo'), ), isA>() - .having((e) => e.error, 'error', '42') + .having((e) => e.error, 'error', isStateError) .having((e) => e.stackTrace, 'stackTrace', isNotNull), ); }); @@ -1481,7 +1461,6 @@ void main() { test('AsyncValue.asData', () { const value = AsyncValue.data(42); - // ignore: omit_local_variable_types, unused_local_variable, testing that assignment works, final AsyncData? data = value.asData; expect( diff --git a/packages/riverpod/test/new/providers/async_notifier_test.dart b/packages/riverpod/test/new/providers/async_notifier_test.dart index 3be89ce47..81eabed32 100644 --- a/packages/riverpod/test/new/providers/async_notifier_test.dart +++ b/packages/riverpod/test/new/providers/async_notifier_test.dart @@ -1,4 +1,4 @@ -// ignore_for_file: invalid_use_of_protected_member +// ignore_for_file: invalid_use_of_protected_member, void_checks, prefer_const_constructors, avoid_types_on_closure_parameters import 'dart:async'; @@ -117,7 +117,6 @@ void main() { final sub = container.listen(provider.notifier, (prev, next) {}); - // ignore: void_checks expect(sub.read().state, const AsyncData(42)); sub.read().state = const AsyncLoading(); @@ -137,7 +136,6 @@ void main() { final sub = container.listen(provider.notifier, (prev, next) {}); - // ignore: void_checks expect(sub.read().state, const AsyncData(42)); sub.read().state = const AsyncData(42); @@ -157,7 +155,6 @@ void main() { final sub = container.listen(provider.notifier, (prev, next) {}); - // ignore: void_checks expect(sub.read().state, const AsyncData(42)); sub.read().state = AsyncError(21, StackTrace.current); @@ -552,11 +549,8 @@ void main() { final sub = container.listen(provider.notifier, (previous, next) {}); - // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` final newState = AsyncData(84); - // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` final newLoading = AsyncLoading(); - // ignore: prefer_const_constructors, not using `const` as we voluntarily break identity to test `identical` final newError = AsyncError(84, StackTrace.empty); sub.read().state = newState; @@ -1091,9 +1085,7 @@ void main() { () => DeferredAsyncNotifier((ref) => 0), ); - // ignore: avoid_types_on_closure_parameters provider.select((AsyncValue value) => 0); - // ignore: avoid_types_on_closure_parameters provider.selectAsync((int value) => 0); canBeAssignedToProviderListenable>(provider); @@ -1112,9 +1104,7 @@ void main() { () => DeferredAsyncNotifier((ref) => 0), ); - // ignore: avoid_types_on_closure_parameters autoDispose.select((AsyncValue value) => 0); - // ignore: avoid_types_on_closure_parameters autoDispose.selectAsync((int value) => 0); canBeAssignedToProviderListenable>(autoDispose); @@ -1137,9 +1127,7 @@ void main() { () => DeferredFamilyAsyncNotifier((ref) => '0'), ); - // ignore: avoid_types_on_closure_parameters family(0).select((AsyncValue value) => 0); - // ignore: avoid_types_on_closure_parameters family(0).selectAsync((String value) => 0); canBeAssignedToProviderListenable>(family(0)); @@ -1167,9 +1155,7 @@ void main() { () => DeferredFamilyAsyncNotifier((ref) => '0'), ); - // ignore: avoid_types_on_closure_parameters autoDisposeFamily(0).select((AsyncValue value) => 0); - // ignore: avoid_types_on_closure_parameters autoDisposeFamily(0).selectAsync((String value) => 0); canBeAssignedToProviderListenable>( @@ -1198,8 +1184,7 @@ void main() { @immutable class Equal { - // ignore: prefer_const_constructors_in_immutables - Equal(this.value); + const Equal(this.value); final T value; diff --git a/packages/riverpod/test/new/providers/notifier_test.dart b/packages/riverpod/test/new/providers/notifier_test.dart index c99b0ecdf..e48d7e852 100644 --- a/packages/riverpod/test/new/providers/notifier_test.dart +++ b/packages/riverpod/test/new/providers/notifier_test.dart @@ -1,4 +1,4 @@ -// ignore_for_file: avoid_types_on_closure_parameters, invalid_use_of_protected_member +// ignore_for_file: avoid_types_on_closure_parameters, invalid_use_of_protected_member, prefer_const_constructors import 'package:meta/meta.dart'; import 'package:mockito/mockito.dart'; @@ -673,8 +673,7 @@ void main() { @immutable class Equal { - // ignore: prefer_const_constructors_in_immutables - Equal(this.value); + const Equal(this.value); final T value; diff --git a/packages/riverpod/test/old/legacy/devtool_test.dart b/packages/riverpod/test/old/legacy/devtool_test.dart deleted file mode 100644 index 771ab9549..000000000 --- a/packages/riverpod/test/old/legacy/devtool_test.dart +++ /dev/null @@ -1,175 +0,0 @@ -// import 'package:riverpod/riverpod.dart'; -// import 'package:riverpod/src/provider.dart'; -// import 'package:test/test.dart'; - -// import '../matchers.dart'; - -void main() { - // late PostEventSpy spy; - - // setUp(() { - // spy = spyPostEvent(); - // }); - - // tearDown(() => spy.dispose()); - - // test('calls postEvent whenever a provider is updated', () { - // expect(RiverpodBinding.debugInstance.containers, isEmpty); - // expect(spy.logs, isEmpty); - - // final container = ProviderContainer(); - // addTearDown(container.dispose); - - // final provider = StateProvider((ref) => 42); - - // final state = container.read(provider); - // spy.logs.clear(); - - // expect(spy.logs, isEmpty); - - // state.state++; - - // expect( - // spy.logs, - // [ - // isPostEventCall('riverpod:provider_changed', { - // 'container_id': container.debugId, - // 'provider_id': provider.debugId, - // }), - // ], - // ); - // spy.logs.clear(); - // }); - - // test('RiverpodBinding contains the list of ProviderContainers', () { - // expect(RiverpodBinding.debugInstance.containers, isEmpty); - // expect(spy.logs, isEmpty); - - // final first = ProviderContainer(); - - // expect( - // spy.logs, - // [isPostEventCall('riverpod:container_list_changed', isEmpty)], - // ); - // spy.logs.clear(); - // expect( - // RiverpodBinding.debugInstance.containers, - // {first.debugId: first}, - // ); - - // final second = ProviderContainer(); - - // expect( - // spy.logs, - // [isPostEventCall('riverpod:container_list_changed', isEmpty)], - // ); - // spy.logs.clear(); - // expect( - // RiverpodBinding.debugInstance.containers, - // {first.debugId: first, second.debugId: second}, - // ); - - // first.dispose(); - - // expect( - // spy.logs, - // [isPostEventCall('riverpod:container_list_changed', isEmpty)], - // ); - // spy.logs.clear(); - // expect( - // RiverpodBinding.debugInstance.containers, - // {second.debugId: second}, - // ); - - // second.dispose(); - - // expect( - // spy.logs, - // [isPostEventCall('riverpod:container_list_changed', isEmpty)], - // ); - // spy.logs.clear(); - // expect(RiverpodBinding.debugInstance.containers, isEmpty); - // }); - - // test( - // 'ProviderContainer calls postEvent whenever it mounts/unmount a provider', - // () async { - // final container = ProviderContainer(); - // addTearDown(container.dispose); - // spy.logs.clear(); - - // final provider = Provider.autoDispose((ref) => 0); - // final provider2 = Provider((ref) => 0); - - // expect(spy.logs, isEmpty); - - // var sub = container.listen(provider, (_) {}); - - // expect( - // spy.logs, - // [ - // isPostEventCall( - // 'riverpod:provider_list_changed', - // {'container_id': container.debugId}, - // ) - // ], - // ); - // spy.logs.clear(); - - // var sub2 = container.listen(provider2, (_) {}); - - // expect( - // spy.logs, - // [ - // isPostEventCall( - // 'riverpod:provider_list_changed', - // {'container_id': container.debugId}, - // ) - // ], - // ); - // spy.logs.clear(); - - // sub.close(); - - // expect(spy.logs, isEmpty); - // await Future.value(null); - - // expect( - // spy.logs, - // [ - // isPostEventCall( - // 'riverpod:provider_list_changed', - // {'container_id': container.debugId}, - // ) - // ], - // ); - // spy.logs.clear(); - - // sub2.close(); - // await Future.value(null); - - // expect(spy.logs, isEmpty); - // await Future.value(null); - - // expect(spy.logs, isEmpty, reason: 'provider2 is not autoDispose'); - - // // re-subscribe to the provider that was unmounted - // sub = container.listen(provider, (_) {}); - - // expect( - // spy.logs, - // [ - // isPostEventCall( - // 'riverpod:provider_list_changed', - // {'container_id': container.debugId}, - // ) - // ], - // ); - // spy.logs.clear(); - - // // re-subscribe to the provider that was no longer listened to but still mounted - // sub2 = container.listen(provider2, (_) {}); - - // expect(spy.logs, isEmpty); - // }); -} diff --git a/packages/riverpod/test/old/legacy/framework2/framework_test.dart b/packages/riverpod/test/old/legacy/framework2/framework_test.dart index 6f9db565b..c5e98a5e2 100644 --- a/packages/riverpod/test/old/legacy/framework2/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework2/framework_test.dart @@ -292,25 +292,25 @@ void main() { expect(secondElement.hasListeners, false); }); - // group('overrideWithValue', () { - // test('synchronously overrides the value', () { - // var callCount = 0; - // final provider = FutureProvider((ref) async { - // callCount++; - // return 0; - // }); - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // addTearDown(container.dispose); - - // final sub = container.listen(provider, (_, __) {}); - - // expect(callCount, 0); - // expect(sub.read(), const AsyncValue.data(42)); - // }); - // }); + group('overrideWithValue', () { + test('synchronously overrides the value', () { + var callCount = 0; + final provider = FutureProvider((ref) async { + callCount++; + return 0; + }); + final container = ProviderContainer.test( + overrides: [provider.overrideWithValue(const AsyncValue.data(42))], + ); + + addTearDown(container.dispose); + + final sub = container.listen(provider, (_, __) {}); + + expect(callCount, 0); + expect(sub.read(), const AsyncValue.data(42)); + }); + }); test('remove dependencies on dispose', () async { final first = StateProvider((ref) => 0); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart index f46b40564..4433e2ea0 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart @@ -104,71 +104,8 @@ void main() { ]), ); }); - - // test('when using provider.overrideWithValue', () async { - // final controller = StateController(0); - // final provider = - // StateNotifierProvider.autoDispose, int>( - // (ref) => controller); - // final root = ProviderContainer.test(); - // final controllerOverride = StateController(42); - // final container = ProviderContainer.test(parent: root, overrides: [ - // provider.overrideWithValue(controllerOverride), - // ]); - - // expect(container.read(provider.notifier), controllerOverride); - // expect(container.read(provider), 42); - // expect(root.getAllProviderElements(), isEmpty); - // expect( - // container.getAllProviderElements(), - // unorderedEquals([ - // isA() - // .having((e) => e.origin, 'origin', provider), - // isA() - // .having((e) => e.origin, 'origin', provider.notifier), - // ]), - // ); - // }); }); - // test('overriding the provider overrides provider.state too', () { - // final provider = StateNotifierProvider.autoDispose((_) { - // return TestNotifier(); - // }); - // final notifier = TestNotifier(42); - // final container = ProviderContainer.test( - // overrides: [ - // provider.overrideWithValue(TestNotifier(10)), - // ], - // ); - // addTearDown(container.dispose); - // final stateListener = Listener(); - // final notifierListener = Listener(); - - // // does not crash - // container.updateOverrides([ - // provider.overrideWithValue(notifier), - // ]); - - // container.listen( - // provider.notifier, - // notifierListener, - // fireImmediately: true, - // ); - // verify(notifierListener(null, notifier)).called(1); - // verifyNoMoreInteractions(notifierListener); - - // container.listen(provider, stateListener, fireImmediately: true); - // verify(stateListener(null, 42)).called(1); - // verifyNoMoreInteractions(stateListener); - - // notifier.increment(); - - // verify(stateListener(42, 43)).called(1); - // verifyNoMoreInteractions(notifierListener); - // verifyNoMoreInteractions(stateListener); - // }); - test('can specify name', () { final provider = StateNotifierProvider.autoDispose( (_) => TestNotifier(), diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart index cf34d40df..85c075959 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart @@ -207,30 +207,6 @@ void main() { ); }); - // test('when using provider.overrideWithValue', () async { - // final controller = StateController(0); - // final provider = StateNotifierProvider, int>( - // (ref) => controller); - // final root = ProviderContainer.test(); - // final controllerOverride = StateController(42); - // final container = ProviderContainer.test(parent: root, overrides: [ - // provider.overrideWithValue(controllerOverride), - // ]); - - // expect(container.read(provider.notifier), controllerOverride); - // expect(container.read(provider), 42); - // expect(root.getAllProviderElements(), isEmpty); - // expect( - // container.getAllProviderElements(), - // unorderedEquals([ - // isA() - // .having((e) => e.origin, 'origin', provider), - // isA() - // .having((e) => e.origin, 'origin', provider.notifier), - // ]), - // ); - // }); - test('when using provider.overrideWith', () async { final controller = StateController(0); final provider = @@ -260,30 +236,6 @@ void main() { }); }); - // test('overriding the provider overrides provider.state too', () { - // final notifier = TestNotifier(42); - // final provider = - // StateNotifierProvider((_) => TestNotifier()); - // final container = ProviderContainer.test( - // overrides: [ - // provider.overrideWithValue(TestNotifier(10)), - // ], - // ); - // addTearDown(container.dispose); - - // // does not crash - // container.updateOverrides([ - // provider.overrideWithValue(notifier), - // ]); - - // expect(container.read(provider.notifier), notifier); - // expect(container.read(provider), 42); - - // notifier.increment(); - - // expect(container.read(provider), 43); - // }); - test('can specify name', () { final provider = StateNotifierProvider( (_) { diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart index 12884e204..182e7ba38 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_auto_dispose_test.dart @@ -92,29 +92,6 @@ void main() { ); }); - // test('when using provider.overrideWithValue', () async { - // final provider = StateProvider.autoDispose((ref) => 0); - // final root = ProviderContainer.test(); - // final container = ProviderContainer.test(parent: root, overrides: [ - // provider.overrideWithValue(StateController(42)), - // ]); - - // expect(container.read(provider.notifier).state, 42); - // expect(container.read(provider), 42); - // expect(root.getAllProviderElements(), isEmpty); - // expect( - // container.getAllProviderElements(), - // unorderedEquals([ - // isA() - // .having((e) => e.origin, 'origin', provider), - // isA() - // .having((e) => e.origin, 'origin', provider.state), - // isA() - // .having((e) => e.origin, 'origin', provider.notifier), - // ]), - // ); - // }); - test('when using provider.overrideWith', () async { final provider = StateProvider.autoDispose( (ref) => 0, @@ -142,24 +119,6 @@ void main() { }); group('overrideWith', () { - // test('listens to state changes', () { - // final override = StateController(42); - // final provider = StateProvider.autoDispose((ref) => 0); - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(override), - // ]); - // addTearDown(container.dispose); - // final container2 = ProviderContainer(overrides: [ - // provider.overrideWith( - // StateProvider.autoDispose((ref) => 42), - // ), - // ]); - // addTearDown(container.dispose); - - // expect(container.read(provider), 42); - // expect(container.read(provider.notifier), override); - // }); - test( 'properly disposes of the StateController when the provider is disposed', () async { diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart index ee3a6cb25..18063f6a3 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart @@ -181,27 +181,6 @@ void main() { ); }); - // test('when using provider.overrideWithValue', () async { - // final provider = StateProvider((ref) => 0); - // final root = ProviderContainer.test(); - // final container = ProviderContainer.test(parent: root, overrides: [ - // provider.overrideWithValue(StateController(42)), - // ]); - - // expect(container.read(provider.notifier).state, 42); - // expect(container.read(provider), 42); - // expect(root.getAllProviderElements(), isEmpty); - // expect( - // container.getAllProviderElements(), - // unorderedEquals([ - // isA() - // .having((e) => e.origin, 'origin', provider.state), - // isA() - // .having((e) => e.origin, 'origin', provider.notifier), - // ]), - // ); - // }); - test('when using provider.overrideWith', () async { final provider = StateProvider( (ref) => 0, @@ -227,49 +206,7 @@ void main() { }); }); - // test( - // 'overrideWithValue listens to the new StateController and support controller changes', - // () { - // final provider = StateProvider((ref) => 0); - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(StateController(42)), - // ]); - // final listener = Listener(); - - // container.listen>( - // provider.state, - // (prev, controller) => listener(prev?.state, controller.state), - // fireImmediately: true, - // ); - - // verifyOnly(listener, listener(null, 42)); - - // container.read(provider.notifier).state++; - - // verifyOnly(listener, listener(43, 43)); - // }, - // ); - group('overrideWith', () { - // test('listens to state changes', () { - // final override = StateController(21); - // final provider = StateProvider((ref) => 0); - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(override), - // ]); - // addTearDown(container.dispose); - // final container2 = ProviderContainer(overrides: [ - // provider.overrideWith( - // ((ref) => 42), - // ), - // ]); - // addTearDown(container.dispose); - - // expect(container.read(provider.notifier), override); - // expect(container.read(provider), 21); - // expect(container2.read(provider), 42); - // }); - test( 'properly disposes of the StateController when the provider is disposed', () async { diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart index 28553b52c..9f7c538e9 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart @@ -27,9 +27,6 @@ void main() { container.listen(provider(0), (_, __) {}); - // expect(await container.read(provider(0).future), 0); - // expect(container.read(provider(0)), const AsyncData(0)); - expect( container.pointerManager.familyPointers[provider], isProviderDirectory( diff --git a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart index a55205422..c8d937ef9 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart @@ -74,10 +74,7 @@ void main() { test('can read the state if the setter was called before', () { final container = ProviderContainer.test(); final provider = Provider.autoDispose((ref) { - // ignore: join_return_with_assignment - ref.state = 42; - - return ref.state; + return ref.state = 42; }); expect(container.read(provider), 42); diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart index ec21141c1..4dd928067 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart @@ -140,10 +140,7 @@ void main() { test('can read the state if the setter was called before', () { final container = ProviderContainer.test(); final provider = Provider((ref) { - // ignore: join_return_with_assignment - ref.state = 42; - - return ref.state; + return ref.state = 42; }); expect(container.read(provider), 42); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart index 52912a905..e32033b71 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart @@ -1,3 +1,5 @@ +// ignore_for_file: avoid_types_on_closure_parameters + import 'dart:async'; import 'package:mockito/mockito.dart'; @@ -181,8 +183,9 @@ void main() { // No value were emitted, so the future will fail. Catching the error to // avoid false positive. - // ignore: unawaited_futures, avoid_types_on_closure_parameters - container.read(provider.future).catchError((Object _) => 0); + unawaited( + container.read(provider.future).catchError((Object _) => 0), + ); }); group('scoping an override overrides all the associated subproviders', () { @@ -208,29 +211,29 @@ void main() { ); }); - // test('when using provider.overrideWithValue', () async { - // final provider = StreamProvider.autoDispose((ref) => Stream.value(0)); - // final root = ProviderContainer.test(); - // final container = ProviderContainer.test(parent: root, overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // expect(await container.read(provider.stream).first, 42); - // expect(await container.read(provider.future), 42); - // expect(container.read(provider), const AsyncValue.data(42)); - // expect(root.getAllProviderElements(), isEmpty); - // expect( - // container.getAllProviderElements(), - // unorderedEquals([ - // isA() - // .having((e) => e.origin, 'origin', provider), - // isA() - // .having((e) => e.origin, 'origin', provider.future), - // isA() - // .having((e) => e.origin, 'origin', provider.stream), - // ]), - // ); - // }); + test('when using provider.overrideWithValue', () async { + final provider = StreamProvider.autoDispose( + (ref) => Stream.value(0), + dependencies: [], + ); + final root = ProviderContainer.test(); + final container = ProviderContainer.test( + parent: root, + overrides: [ + provider.overrideWithValue(const AsyncValue.data(42)), + ], + ); + + expect(await container.read(provider.future), 42); + expect(container.read(provider), const AsyncValue.data(42)); + expect(root.getAllProviderElements(), isEmpty); + expect( + container.getAllProviderElements(), + unorderedEquals([ + isA().having((e) => e.origin, 'origin', provider), + ]), + ); + }); test('when using provider.overrideWith', () async { final provider = StreamProvider.autoDispose( diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart index 7af523a82..fc2f69073 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart @@ -627,8 +627,7 @@ void main() { // No value were emitted, so the future will fail. Catching the error to // avoid false positive. - // ignore: unawaited_futures - container.read(provider.future).catchError((Object _) => 0); + unawaited(container.read(provider.future).catchError((Object _) => 0)); }); group('overrideWithValue(T)', () { From fa99b205e3326af5b734f6726c9a8435653fe981 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 20:10:20 +0100 Subject: [PATCH 293/387] More dead code --- ...dispose_change_notifier_provider_test.dart | 49 ---- .../flutter_riverpod/test/consumer_test.dart | 86 ------- .../flutter_riverpod/test/framework_test.dart | 23 -- .../test/future_provider_test.dart | 212 ----------------- ...dispose_change_notifier_provider_test.dart | 22 -- .../change_notifier_provider_test.dart | 43 ---- .../hooks_riverpod/test/internal_test.dart | 214 ------------------ 7 files changed, 649 deletions(-) diff --git a/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart index d814b441e..6c9b9ac67 100644 --- a/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/auto_dispose_change_notifier_provider_test.dart @@ -138,55 +138,6 @@ void main() { expect(notifier.mounted, isFalse); }); - - // test( - // 'overrideWithValue listens to the notifier, support notifier change, and does not dispose of the notifier', - // () async { - // final provider = ChangeNotifierProvider.autoDispose((_) => TestNotifier()); - // final notifier = TestNotifier(); - // final notifier2 = TestNotifier(); - // final container = ProviderContainer(overrides: [ - // provider.overrideWithValue(notifier), - // ]); - // addTearDown(container.dispose); - - // var callCount = 0; - // final sub = container.listen(provider, (_, __) => callCount++); - // final notifierSub = container.listen(provider.notifier, (_, __) {}); - - // expect(sub.read(), notifier); - // expect(callCount, 0); - // expect(notifierSub.read(), notifier); - // expect(notifier.hasListeners, true); - - // notifier.count++; - - // await container.pump(); - // expect(callCount, 1); - - // container.updateOverrides([ - // provider.overrideWithValue(notifier2), - // ]); - - // await container.pump(); - // expect(callCount, 2); - // expect(notifier.hasListeners, false); - // expect(notifier2.hasListeners, true); - // expect(notifier.mounted, true); - // expect(notifierSub.read(), notifier2); - - // notifier2.count++; - - // await container.pump(); - // expect(callCount, 3); - - // container.dispose(); - - // expect(callCount, 3); - // expect(notifier2.hasListeners, false); - // expect(notifier2.mounted, true); - // expect(notifier.mounted, true); - // }); } class OnDisposeMock extends Mock { diff --git a/packages/flutter_riverpod/test/consumer_test.dart b/packages/flutter_riverpod/test/consumer_test.dart index 36e800ca5..831f05a6d 100644 --- a/packages/flutter_riverpod/test/consumer_test.dart +++ b/packages/flutter_riverpod/test/consumer_test.dart @@ -490,92 +490,6 @@ void main() { expect(buildCount, 2); }); - // testWidgets('remove listener when changing container', (tester) async { - // final notifier = TestNotifier(); - // final provider = StateNotifierProvider((_) { - // return notifier; - // }, name: 'provider'); - // final notifier2 = TestNotifier(42); - // const firstOwnerKey = Key('first'); - // const secondOwnerKey = Key('second'); - // final key = GlobalKey(); - - // final consumer = Consumer( - // builder: (context, ref, _) { - // final value = ref.watch(provider); - // return Text('$value', textDirection: TextDirection.ltr); - // }, - // key: key); - - // await tester.pumpWidget( - // Column( - // children: [ - // ProviderScope( - // key: firstOwnerKey, - // child: consumer, - // ), - // ProviderScope( - // key: secondOwnerKey, - // overrides: [ - // provider.overrideWithValue(notifier2), - // ], - // child: Container(), - // ), - // ], - // ), - // ); - - // final owner1 = tester // - // .firstState(find.byKey(firstOwnerKey)) - // .container; - - // final state1 = owner1 - // .getAllProviderElements() - // .firstWhere((s) => s.provider == provider); - - // expect(state1.hasListeners, true); - // expect(find.text('0'), findsOneWidget); - - // await tester.pumpWidget( - // Column( - // children: [ - // ProviderScope( - // key: firstOwnerKey, - // child: Container(), - // ), - // ProviderScope( - // key: secondOwnerKey, - // overrides: [ - // provider.overrideWithValue(notifier2), - // ], - // child: consumer, - // ), - // ], - // ), - // ); - - // final container2 = tester // - // .firstState(find.byKey(secondOwnerKey)) - // .container; - - // final state2 = container2 - // .getAllProviderElements() - // .firstWhere((s) => s.provider is StateNotifierProvider); - - // expect(find.text('0'), findsNothing); - // expect(find.text('42'), findsOneWidget); - // expect(state1.hasListeners, false); - // expect(state2.hasListeners, true); - - // notifier2.increment(); - // await tester.pump(); - - // expect(find.text('0'), findsNothing); - // expect(find.text('43'), findsOneWidget); - // expect(state1.hasListeners, false); - // expect(state2.hasListeners, true); - // }); - testWidgets('remove listener when destroying the consumer', (tester) async { final notifier = TestNotifier(); final provider = StateNotifierProvider((_) => notifier); diff --git a/packages/flutter_riverpod/test/framework_test.dart b/packages/flutter_riverpod/test/framework_test.dart index 71006af17..e7b6f15c9 100644 --- a/packages/flutter_riverpod/test/framework_test.dart +++ b/packages/flutter_riverpod/test/framework_test.dart @@ -433,29 +433,6 @@ void main() { expect(ref.refresh(provider), null); }); - // testWidgets('ProviderScope allows specifying a ProviderContainer', - // (tester) async { - // final provider = FutureProvider((ref) async => 42); - // late WidgetRef ref; - // final container = ProviderContainer.test(overrides: [ - // provider.overrideWithValue(const AsyncValue.data(42)), - // ]); - - // await tester.pumpWidget( - // UncontrolledProviderScope( - // container: container, - // child: Consumer( - // builder: (context, r, _) { - // ref = r; - // return Container(); - // }, - // ), - // ), - // ); - - // expect(ref.read(provider), const AsyncValue.data(42)); - // }); - testWidgets('AlwaysAliveProviderBase.read(context) inside initState', (tester) async { final provider = Provider((_) => 42); diff --git a/packages/flutter_riverpod/test/future_provider_test.dart b/packages/flutter_riverpod/test/future_provider_test.dart index 5a852cfdd..e57ada5f1 100644 --- a/packages/flutter_riverpod/test/future_provider_test.dart +++ b/packages/flutter_riverpod/test/future_provider_test.dart @@ -126,218 +126,6 @@ void main() { await Future.value(); }); - group('overrideWithValue', () { - // var callCount = 0; - // final futureProvider = FutureProvider((s) async { - // callCount++; - // return 42; - // }); - - // Future? future; - // var completed = false; - // final proxy = Provider( - // (ref) { - // final first = ref.watch(futureProvider.future); - // future = first - // ..then( - // (value) => completed = true, - // onError: (dynamic _) => completed = true, - // ); - // return ''; - // }, - // ); - - // setUp(() { - // callCount = 0; - // completed = false; - // future = null; - // }); - - // final child = Directionality( - // textDirection: TextDirection.ltr, - // child: Consumer(builder: (c, ref, _) { - // ref.watch(proxy); - // return ref.watch(futureProvider).when( - // data: (data) => Text(data.toString()), - // loading: () => const Text('loading'), - // error: (err, stack) { - // return const Text('error'); - // }, - // ); - // }), - // ); - - // testWidgets('no-op if completed and rebuild with same value', - // (tester) async { - // await tester.pumpWidget( - // ProviderScope( - // overrides: [ - // futureProvider.overrideWithValue(const AsyncValue.data(42)), - // ], - // child: child, - // ), - // ); - - // expect(completed, true); - // await expectLater(future, completion(42)); - - // await tester.pumpWidget( - // ProviderScope( - // overrides: [ - // futureProvider.overrideWithValue(const AsyncValue.data(42)), - // ], - // child: child, - // ), - // ); - // }); - - // testWidgets( - // 'FutureProviderDependency.future completes on rebuild with data', - // (tester) async { - // await tester.pumpWidget( - // ProviderScope( - // overrides: [ - // futureProvider.overrideWithValue(const AsyncValue.loading()), - // ], - // child: child, - // ), - // ); - - // // make sure the future doesn't just complete in one frame - // await Future.value(); - - // expect(completed, false); - // expect(future, isNotNull); - - // await tester.pumpWidget( - // ProviderScope( - // overrides: [ - // futureProvider.overrideWithValue(const AsyncValue.data(42)), - // ], - // child: child, - // ), - // ); - - // expect(completed, true); - // await expectLater(future, completion(42)); - // }); - - // testWidgets( - // 'FutureProviderDependency.future completes on rebuild with error', - // (tester) async { - // await tester.pumpWidget( - // ProviderScope( - // overrides: [ - // futureProvider.overrideWithValue(const AsyncValue.loading()), - // ], - // child: child, - // ), - // ); - - // // make sure the future doesn't just complete in one frame - // await Future.value(); - - // expect(completed, false); - // expect(future, isNotNull); - - // final error = Error(); - // await tester.pumpWidget( - // ProviderScope( - // overrides: [ - // futureProvider.overrideWithValue(AsyncValue.error(error)), - // ], - // child: child, - // ), - // ); - - // expect(completed, true); - // await expectLater(future, throwsA(error)); - // }); - - // testWidgets('FutureProviderDependency.future loading to loading is no-op', - // (tester) async { - // await tester.pumpWidget( - // ProviderScope( - // overrides: [ - // futureProvider.overrideWithValue(const AsyncValue.loading()), - // ], - // child: child, - // ), - // ); - - // expect(completed, false); - // expect(future, isNotNull); - - // await tester.pumpWidget( - // ProviderScope( - // overrides: [ - // futureProvider.overrideWithValue(const AsyncValue.loading()), - // ], - // child: child, - // ), - // ); - - // // make sure the future doesn't just complete in one frame - // await Future.value(); - - // expect(completed, false); - // expect(future, isNotNull); - // }); - - // testWidgets('Initial build as loading', (tester) async { - // await tester.pumpWidget( - // ProviderScope( - // overrides: [ - // futureProvider.overrideWithValue(const AsyncValue.loading()), - // ], - // child: child, - // ), - // ); - - // expect(callCount, 0); - // expect(find.text('loading'), findsOneWidget); - - // expect(completed, false); - // expect(future, isNotNull); - // }); - - // testWidgets('Initial build as value', (tester) async { - // await tester.pumpWidget( - // ProviderScope( - // overrides: [ - // futureProvider.overrideWithValue(const AsyncValue.data(42)), - // ], - // child: child, - // ), - // ); - - // expect(callCount, 0); - // expect(find.text('42'), findsOneWidget); - - // expect(completed, true); - // await expectLater(future, completion(42)); - // }); - - // testWidgets('Initial build as error', (tester) async { - // final error = Error(); - - // await tester.pumpWidget( - // ProviderScope( - // overrides: [ - // futureProvider.overrideWithValue(AsyncValue.error(error)), - // ], - // child: child, - // ), - // ); - - // expect(callCount, 0); - // expect(find.text('error'), findsOneWidget); - - // expect(completed, true); - // await expectLater(future, throwsA(error)); - // }); - }); - testWidgets('FutureProvider into FutureProviderFamily', (tester) async { final futureProvider = FutureProvider((_) async => 42); diff --git a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart index 1bb586819..03388db56 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart @@ -91,28 +91,6 @@ void main() { expect(root.getAllProviderElements(), isEmpty); }); - // test('when using provider.overrideWithValue', () { - // final provider = - // ChangeNotifierProvider.autoDispose((ref) => ValueNotifier(0)); - // final root = ProviderContainer.test(); - // final container = ProviderContainer.test(parent: root, overrides: [ - // provider.overrideWithValue(ValueNotifier(42)), - // ]); - - // expect(container.read(provider.notifier).value, 42); - // expect(container.read(provider).value, 42); - // expect( - // container.getAllProviderElements(), - // unorderedEquals([ - // isA() - // .having((e) => e.origin, 'origin', provider), - // isA() - // .having((e) => e.origin, 'origin', provider.notifier) - // ]), - // ); - // expect(root.getAllProviderElements(), isEmpty); - // }); - test('when using provider.overrideWith', () { final provider = ChangeNotifierProvider.autoDispose( (ref) => ValueNotifier(0), diff --git a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart index 4b8754010..da60c932b 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart @@ -183,27 +183,6 @@ void main() { expect(root.getAllProviderElements(), isEmpty); }); - // test('when using provider.overrideWithValue', () { - // final provider = ChangeNotifierProvider((ref) => ValueNotifier(0)); - // final root = ProviderContainer.test(); - // final container = ProviderContainer.test(parent: root, overrides: [ - // provider.overrideWithValue(ValueNotifier(42)), - // ]); - - // expect(container.read(provider.notifier).value, 42); - // expect(container.read(provider).value, 42); - // expect( - // container.getAllProviderElements(), - // unorderedEquals([ - // isA() - // .having((e) => e.origin, 'origin', provider), - // isA() - // .having((e) => e.origin, 'origin', provider.notifier) - // ]), - // ); - // expect(root.getAllProviderElements(), isEmpty); - // }); - test('when using provider.overrideWith', () { final provider = ChangeNotifierProvider( (ref) => ValueNotifier(0), @@ -229,28 +208,6 @@ void main() { }); }); - // test('overriding with value listens to the ChangeNotifier', () { - // final provider = ChangeNotifierProvider((ref) => ValueNotifier(0)); - // final notifier = ValueNotifier(42); - // final listener = Listener(); - - // final container = ProviderContainer.test( - // overrides: [provider.overrideWithValue(notifier)], - // ); - - // container.listen>( - // provider, - // (prev, value) => listener(prev?.value, value.value), - // ); - - // expect(container.read(provider).value, 42); - // expect(container.read(provider.notifier).value, 42); - - // notifier.value = 21; - - // verifyOnly(listener, listener(21, 21)); - // }); - test('refresh recreates the ChangeNotifier', () { final provider = ChangeNotifierProvider((ref) => ValueNotifier(0)); final container = ProviderContainer.test(); diff --git a/packages/hooks_riverpod/test/internal_test.dart b/packages/hooks_riverpod/test/internal_test.dart index 30bd39c51..756abced8 100644 --- a/packages/hooks_riverpod/test/internal_test.dart +++ b/packages/hooks_riverpod/test/internal_test.dart @@ -4,55 +4,6 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:hooks_riverpod/legacy.dart'; void main() { - // testWidgets('ref.watch supports changing the selected provider', - // (tester) async { - // final notifier1 = Counter(); - // final provider1 = StateNotifierProvider((_) => notifier1); - // final notifier2 = Counter(42); - // final provider2 = StateNotifierProvider((_) => notifier2); - // var buildCount = 0; - // var selectCount = 0; - - // Widget build(StateNotifierProvider provider) { - // return ProviderScope( - // child: HookConsumer(builder: (c, ref, child) { - // buildCount++; - // final value = ref.watch(provider.select((value) { - // selectCount++; - // return value > 5; - // })); - // return Text('$value', textDirection: TextDirection.ltr); - // }), - // ); - // } - - // await tester.pumpWidget(build(provider1)); - - // expect(find.text('false'), findsOneWidget); - // expect(buildCount, 1); - // expect(selectCount, 1); - - // await tester.pumpWidget(build(provider2)); - - // expect(find.text('true'), findsOneWidget); - // expect(buildCount, 2); - // expect(selectCount, 2); - - // notifier1.state = 42; - // await tester.pump(); - - // expect(find.text('true'), findsOneWidget); - // expect(buildCount, 2); - // expect(selectCount, 2); - - // notifier2.state = 0; - // await tester.pump(); - - // expect(find.text('false'), findsOneWidget); - // expect(buildCount, 3); - // expect(selectCount, 4); - // }); - testWidgets('ref.watch supports changing the provider', (tester) async { final notifier1 = Counter(); final provider1 = StateNotifierProvider((_) => notifier1); @@ -94,173 +45,8 @@ void main() { expect(find.text('43'), findsOneWidget); expect(buildCount, 3); }); - - group('ref.watch(provider.select)', () { - // testWidgets('simple flow', (tester) async { - // final notifier = Counter(); - // final provider = StateNotifierProvider((_) => notifier); - // final selector = SelectorSpy(); - // var buildCount = 0; - // Object? lastSelectedValue; - - // await tester.pumpWidget( - // ProviderScope( - // child: HookConsumer(builder: (c, ref, child) { - // buildCount++; - // lastSelectedValue = ref.watch(provider.select((value) { - // selector(value); - // return value.isNegative; - // })); - // return Container(); - // }), - // ), - // ); - - // expect(lastSelectedValue, false); - // expect(buildCount, 1); - // verify(selector(0)).called(1); - // verifyNoMoreInteractions(selector); - - // notifier.increment(); - - // verifyNoMoreInteractions(selector); - - // await tester.pump(); - - // expect(lastSelectedValue, false); - // expect(buildCount, 1); - // verify(selector(1)).called(1); - // verifyNoMoreInteractions(selector); - // }); - - // testWidgets('recompute value when changing selector', (tester) async { - // final notifier = Counter(); - // final provider = StateNotifierProvider((_) => notifier); - // final selector = SelectorSpy(); - // String? value2; - // final build = BuildSpy(); - // when(build()).thenAnswer((_) => value2 = 'foo'); - // Object? lastSelectedValue; - - // await tester.pumpWidget( - // ProviderScope(child: HookConsumer(builder: (c, ref, child) { - // build(); - // lastSelectedValue = ref.watch(provider.select((value) { - // selector('$value $value2'); - // return '$value $value2'; - // })); - // return Container(); - // })), - // ); - - // expect(lastSelectedValue, '0 foo'); - // verifyInOrder([ - // build(), - // selector('0 foo'), - // ]); - // verifyNoMoreInteractions(selector); - // verifyNoMoreInteractions(build); - - // notifier.increment(); - // when(build()).thenAnswer((_) => value2 = 'bar'); - - // await tester.pump(); - - // expect(lastSelectedValue, '1 bar'); - // verifyInOrder([ - // selector('1 foo'), - // build(), - // selector('1 bar'), - // ]); - // verifyNoMoreInteractions(selector); - // verifyNoMoreInteractions(build); - // }); - - // testWidgets('stop calling selectors after one cause rebuild', - // (tester) async { - // final notifier = Counter(); - // final provider = StateNotifierProvider((_) => notifier); - // bool? lastSelectedValue; - // final selector = SelectorSpy(); - // int? lastSelectedValue2; - // final selector2 = SelectorSpy(); - // Object? lastSelectedValue3; - // final selector3 = SelectorSpy(); - // final build = BuildSpy(); - - // await tester.pumpWidget( - // ProviderScope(child: HookConsumer(builder: (c, ref, child) { - // build(); - // lastSelectedValue = ref.watch(provider.select((value) { - // selector(value); - // return value.isNegative; - // })); - // lastSelectedValue2 = ref.watch(provider.select((value) { - // selector2(value); - // return value; - // })); - // lastSelectedValue3 = ref.watch(provider.select((value) { - // selector3(value); - // return value; - // })); - // return Container(); - // })), - // ); - - // verifyInOrder([ - // build(), - // selector(0), - // selector2(0), - // selector3(0), - // ]); - // verifyNoMoreInteractions(build); - // verifyNoMoreInteractions(selector); - // verifyNoMoreInteractions(selector2); - // verifyNoMoreInteractions(selector3); - // expect(lastSelectedValue, false); - // expect(lastSelectedValue2, 0); - // expect(lastSelectedValue3, 0); - - // notifier.increment(); - - // verifyNoMoreInteractions(build); - // verifyNoMoreInteractions(selector); - // verifyNoMoreInteractions(selector2); - // verifyNoMoreInteractions(selector3); - - // await tester.pump(); - - // verifyInOrder([ - // selector(1), - // selector2(1), - // build(), - // selector(1), - // selector2(1), - // selector3(1), - // ]); - // verifyNoMoreInteractions(build); - // verifyNoMoreInteractions(selector); - // verifyNoMoreInteractions(selector2); - // verifyNoMoreInteractions(selector3); - // expect(lastSelectedValue, false); - // expect(lastSelectedValue2, 1); - // expect(lastSelectedValue3, 1); - // }); - }); } -// class SelectorSpy extends Mock { -// void call(T value); -// } - -// class BuildSpy extends Mock { -// void call(); -// } - -// class MockCreateState extends Mock { -// void call(); -// } - class Counter extends StateNotifier { Counter([super.initialValue = 0]); From a82e1c1db860d9c0ebbf00c8cdc36e56d79717ef Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 20:14:04 +0100 Subject: [PATCH 294/387] Unskip stuff --- packages/riverpod/test/new/core/ref_test.dart | 38 +++++++------------ .../test/new/providers/notifier_test.dart | 6 --- .../old/framework/provider_element_test.dart | 2 - .../test/old/framework/ref_watch_test.dart | 2 - 4 files changed, 14 insertions(+), 34 deletions(-) diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart index 3e83558fc..f0e375838 100644 --- a/packages/riverpod/test/new/core/ref_test.dart +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -2606,26 +2606,22 @@ void main() { verifyZeroInteractions(listener); }); - test( - 'is not called when using container.read (autoDispose)', - skip: true, - () async { - final container = ProviderContainer.test(); - final listener = OnCancelMock(); - final dispose = OnDisposeMock(); - final provider = StateProvider.autoDispose((ref) { - ref.keepAlive(); - ref.onCancel(listener.call); - ref.onDispose(dispose.call); - }); + test('is not called when using container.read (autoDispose)', () async { + final container = ProviderContainer.test(); + final listener = OnCancelMock(); + final dispose = OnDisposeMock(); + final provider = StateProvider.autoDispose((ref) { + ref.keepAlive(); + ref.onCancel(listener.call); + ref.onDispose(dispose.call); + }); - container.read(provider); - await container.pump(); + container.read(provider); + await container.pump(); - verifyZeroInteractions(listener); - verifyZeroInteractions(dispose); - }, - ); + verifyZeroInteractions(listener); + verifyZeroInteractions(dispose); + }); test('listeners are cleared on rebuild', () { final container = ProviderContainer.test(); @@ -2804,12 +2800,6 @@ void main() { expect(buildCount, 1); verifyNoMoreInteractions(onDispose); }); - - test( - 'once a provider was disposed, cannot add more listeners until it is rebuilt', - () {}, - skip: 'TODO', - ); }); group('mounted', () { diff --git a/packages/riverpod/test/new/providers/notifier_test.dart b/packages/riverpod/test/new/providers/notifier_test.dart index e48d7e852..35ae2a421 100644 --- a/packages/riverpod/test/new/providers/notifier_test.dart +++ b/packages/riverpod/test/new/providers/notifier_test.dart @@ -498,12 +498,6 @@ void main() { verifyOnly(listener, listener(Equal(42), Equal(21))); }); - test( - 'can override the Notifier with a matching custom implementation', - () {}, - skip: 'TODO', - ); - test('can override Notifier.build', () {}); if (factory.isAutoDispose) { diff --git a/packages/riverpod/test/old/framework/provider_element_test.dart b/packages/riverpod/test/old/framework/provider_element_test.dart index 9ece4a450..00c6720fb 100644 --- a/packages/riverpod/test/old/framework/provider_element_test.dart +++ b/packages/riverpod/test/old/framework/provider_element_test.dart @@ -158,8 +158,6 @@ void main() { ]), ); }); - - test('include ref.read dependents', () {}, skip: true); }); group('hasListeners', () { diff --git a/packages/riverpod/test/old/framework/ref_watch_test.dart b/packages/riverpod/test/old/framework/ref_watch_test.dart index da696092c..9ba5d089e 100644 --- a/packages/riverpod/test/old/framework/ref_watch_test.dart +++ b/packages/riverpod/test/old/framework/ref_watch_test.dart @@ -107,8 +107,6 @@ void main() { expect(buildCount, 2); }); - test('when selector throws, rebuild providers', () {}, skip: true); - test('on provider that threw, exceptions bypass the selector', () { final container = ProviderContainer.test(); final dep = Provider((ref) { From 2701c74d683e6334dc766156c8d967855913c449 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Thu, 14 Mar 2024 20:36:46 +0100 Subject: [PATCH 295/387] Improve DO/DON'T fixes #3090 --- website/docs/essentials/do_dont.mdx | 30 +++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/website/docs/essentials/do_dont.mdx b/website/docs/essentials/do_dont.mdx index 5e1b52b35..926a0b827 100644 --- a/website/docs/essentials/do_dont.mdx +++ b/website/docs/essentials/do_dont.mdx @@ -1,6 +1,6 @@ --- title: DO/DON'T -version: 1 +version: 2 --- import { Link } from "/src/components/Link"; @@ -58,12 +58,14 @@ ElevatedButton( ## AVOID using providers for local widget state. Providers are designed to be for shared business state. -They are not meant to be used for local widget state, such as for: +They are not meant to be used for local widget state, such as: -- storing form state -- currently selected item -- animations -- generally everything that Flutter deals with a "controller" (e.g. `TextEditingController`) +- The currently selected item. +- Form state/ + Because leaving and re-entering the form should typically reset the form state. + This includes pressing the back button during a multi-page forms. +- Animations. +- Generally everything that Flutter deals with a "controller" (e.g. `TextEditingController`) If you are looking for a way to handle local widget state, consider using [flutter_hooks](https://pub.dev/packages/flutter_hooks) instead. @@ -72,6 +74,22 @@ One reason why this is discouraged is that such state is often scoped to a route Failing to do so could break your app's back button, due to a new page overriding the state of a previous page. +For instance say we were to store the currently selected `book` in a provider: + +```dart +final selectedBookProvider = StateProvider((ref) => null); +``` +One challenge we could face is, the navigation history could look like: +``` +/books +/books/42 +/books/21 +``` + +In this scenario, when pressing the back button, we should expect to go back to `/books/42`. +But if we were to use `selectedBookProvider` to store the selected book, +the selected ID would not reset to its previous value, and we would keep seeing `/books/21`. + ## DON'T perform side effects during the initialization of a provider Providers should generally be used to represent a "read" operation. From d2a9e0dcacd3022c516ff9ad903f8420ec894dc6 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 15 Mar 2024 12:10:27 +0100 Subject: [PATCH 296/387] W --- packages/riverpod/lib/src/core/element.dart | 64 +++-- .../riverpod/lib/src/core/foundation.dart | 1 + .../lib/src/core/modifiers/select.dart | 23 +- .../lib/src/core/modifiers/select_async.dart | 3 + .../lib/src/core/provider/provider.dart | 4 +- .../lib/src/core/provider_container.dart | 6 +- .../src/core/proxy_provider_listenable.dart | 4 + packages/riverpod/lib/src/core/ref.dart | 4 +- packages/riverpod/lib/src/core/scheduler.dart | 6 +- .../test/new/core/auto_dispose_test.dart | 26 ++ .../test/new/core/modifiers/future_test.dart | 63 +++++ .../{ => modifiers}/select_async_test.dart | 2 +- .../test/new/core/modifiers/select_test.dart | 99 ++++++++ .../test/new/core/provider_element_test.dart | 184 +++++++++++++++ packages/riverpod/test/new/core/ref_test.dart | 111 ++++++++- .../riverpod/test/new/core/select_test.dart | 27 --- .../old/framework/provider_element_test.dart | 223 ------------------ .../test/old/framework/ref_watch_test.dart | 5 +- .../test/old/legacy/framework_test.dart | 19 -- 19 files changed, 570 insertions(+), 304 deletions(-) create mode 100644 packages/riverpod/test/new/core/modifiers/future_test.dart rename packages/riverpod/test/new/core/{ => modifiers}/select_async_test.dart (99%) create mode 100644 packages/riverpod/test/new/core/modifiers/select_test.dart create mode 100644 packages/riverpod/test/new/core/provider_element_test.dart delete mode 100644 packages/riverpod/test/new/core/select_test.dart delete mode 100644 packages/riverpod/test/old/framework/provider_element_test.dart diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index d55372e93..565d1de12 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -67,20 +67,32 @@ abstract class ProviderElement implements Node { Ref? ref; - /// Whether this [ProviderElement] is currently listened to or not. + /// Whether this [ProviderElement] is actively in use. /// - /// This maps to listeners added with [Ref.listen]. - /// See also [_mayNeedDispose], called when [hasListeners] may have changed. - bool get hasListeners => - (_dependents?.isNotEmpty ?? false) || _providerDependents.isNotEmpty; + /// A provider is considered not used if: + /// - it has no listeners + /// - all of its listeners are "weak" (i.e. created with `listen(weak: true)`) + /// + /// See also [_mayNeedDispose], called when [isActive] may have changed. + bool get isActive => + (_dependents?.isNotEmpty ?? false) || _watchDependents.isNotEmpty; var _dependencies = HashMap(); HashMap? _previousDependencies; List? _subscriptions; List? _dependents; + /// "listen(weak: true)" pointing to this provider. + /// + /// Those subscriptions are separate from [_dependents] for a few reasons: + /// - They do not count towards [isActive]. + /// - They may be reused between two instances of a [ProviderElement]. + /// + /// The list is passed by reference before [_mount] by [ProviderPointer]. + late final List _weakDependents; + /// The element of the providers that depends on this provider. - final _providerDependents = []; + final _watchDependents = []; bool _mustRecomputeState = false; bool _dependencyMayHaveChanged = false; @@ -95,6 +107,7 @@ abstract class ProviderElement implements Node { bool _debugDidSetState = false; bool _didBuild = false; + var _didMount = false; /* STATE */ Result? _stateResult; @@ -197,8 +210,7 @@ This could mean a few things: } /// Called the first time a provider is obtained. - @internal - void mount() { + void _mount() { if (kDebugMode) { _debugCurrentCreateHash = provider.debugGetCreateSourceHash(); } @@ -206,6 +218,7 @@ This could mean a few things: final ref = this.ref = Ref._(this); buildState(ref); + // TODO refactor to use notifyListeners(); switch (_stateResult!) { case final ResultData newState: final onChangeSelfListeners = ref._onChangeSelfListeners; @@ -219,6 +232,20 @@ This could mean a few things: } } + final listeners = _dependents?.toList(growable: false); + if (listeners != null) { + for (var i = 0; i < listeners.length; i++) { + final listener = listeners[i]; + if (listener is _ProviderStateSubscription) { + Zone.current.runBinaryGuarded( + listener.listener, + null, + newState.state, + ); + } + } + } + for (final observer in container.observers) { runTernaryGuarded( observer.didAddProvider, @@ -301,7 +328,7 @@ This could mean a few things: // Unsubscribe to everything that a provider no longer depends on. for (final sub in previousDependencies.entries) { sub.key - .._providerDependents.remove(this) + .._watchDependents.remove(this) .._onRemoveListener(); } _previousDependencies = null; @@ -330,6 +357,11 @@ This could mean a few things: /// [flush] from users, such that they don't need to care about invoking this function. @internal void flush() { + if (!_didMount) { + _didMount = true; + _mount(); + } + _maybeRebuildDependencies(); if (_mustRecomputeState) { _mustRecomputeState = false; @@ -495,8 +527,8 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu default: } - for (var i = 0; i < _providerDependents.length; i++) { - _providerDependents[i].invalidateSelf(asReload: true); + for (var i = 0; i < _watchDependents.length; i++) { + _watchDependents[i].invalidateSelf(asReload: true); } for (final observer in container.observers) { @@ -543,6 +575,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ProviderSubscription listen( ProviderListenable listenable, void Function(T? previous, T value) listener, { + bool weak = false, void Function(Object error, StackTrace stackTrace)? onError, bool fireImmediately = false, // Not part of the public "Ref" API @@ -554,6 +587,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu final result = listenable.addListener( this, listener, + weak: weak, fireImmediately: fireImmediately, onError: onError, onDependencyMayHaveChanged: onDependencyMayHaveChanged, @@ -585,7 +619,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu if (provider.isAutoDispose) { final links = ref?._keepAliveLinks; - if (!hasListeners && (links == null || links.isEmpty)) { + if (!isActive && (links == null || links.isEmpty)) { container.scheduler.scheduleProviderDispose(this); } } @@ -666,7 +700,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ref = null; for (final sub in _dependencies.entries) { - sub.key._providerDependents.remove(this); + sub.key._watchDependents.remove(this); sub.key._onRemoveListener(); } _dependencies.clear(); @@ -708,8 +742,8 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu required void Function(ProxyElementValueListenable element) listenableVisitor, }) { - for (var i = 0; i < _providerDependents.length; i++) { - elementVisitor(_providerDependents[i]); + for (var i = 0; i < _watchDependents.length; i++) { + elementVisitor(_watchDependents[i]); } final dependents = _dependents; diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index 17b26f39c..0c014cd84 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -176,6 +176,7 @@ mixin ProviderListenable implements ProviderListenableOrFamily { ProviderSubscription addListener( Node node, void Function(StateT? previous, StateT next) listener, { + required bool weak, required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index 944ad8024..15d21dc21 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -7,8 +7,9 @@ abstract class Node { ProviderSubscription listen( ProviderListenable listenable, void Function(StateT? previous, StateT next) listener, { - void Function(Object error, StackTrace stackTrace)? onError, - bool fireImmediately = false, + required void Function(Object error, StackTrace stackTrace)? onError, + required bool fireImmediately, + required bool weak, }); /// Reads the state of a provider, potentially creating it in the process. @@ -57,20 +58,21 @@ class _ProviderSelector with ProviderListenable { void _selectOnChange({ required InputT newState, - required Result lastSelectedValue, + required Result? lastSelectedValue, required void Function(Object error, StackTrace stackTrace) onError, required void Function(OutputT? prev, OutputT next) listener, required void Function(Result newState) onChange, }) { final newSelectedValue = _select(Result.data(newState)); - if (!lastSelectedValue.hasState || + if (lastSelectedValue == null || + !lastSelectedValue.hasState || !newSelectedValue.hasState || lastSelectedValue.requireState != newSelectedValue.requireState) { onChange(newSelectedValue); switch (newSelectedValue) { case ResultData(:final state): listener( - lastSelectedValue.stateOrNull, + lastSelectedValue?.stateOrNull, state, ); case ResultError(:final error, :final stackTrace): @@ -86,11 +88,11 @@ class _ProviderSelector with ProviderListenable { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, + required bool weak, }) { onError ??= Zone.current.handleUncaughtError; - late Result lastSelectedValue; - + Result? lastSelectedValue; final sub = node.listen( provider, (prev, input) { @@ -102,14 +104,16 @@ class _ProviderSelector with ProviderListenable { onChange: (newState) => lastSelectedValue = newState, ); }, + weak: weak, + fireImmediately: false, onError: onError, ); - lastSelectedValue = _select(Result.guard(sub.read)); + if (!weak) lastSelectedValue = _select(Result.guard(sub.read)); if (fireImmediately) { _handleFireImmediately( - lastSelectedValue, + lastSelectedValue!, listener: listener, onError: onError, ); @@ -120,6 +124,7 @@ class _ProviderSelector with ProviderListenable { sub, () { return switch (lastSelectedValue) { + null => read(node), ResultData(:final state) => state, ResultError(:final error, :final stackTrace) => throwErrorWithCombinedStackTrace( diff --git a/packages/riverpod/lib/src/core/modifiers/select_async.dart b/packages/riverpod/lib/src/core/modifiers/select_async.dart index a358d968e..5981cc432 100644 --- a/packages/riverpod/lib/src/core/modifiers/select_async.dart +++ b/packages/riverpod/lib/src/core/modifiers/select_async.dart @@ -38,6 +38,7 @@ class _AsyncSelector with ProviderListenable> { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, + required bool weak, }) { Result? lastSelectedValue; Completer? selectedCompleter; @@ -135,6 +136,8 @@ class _AsyncSelector with ProviderListenable> { provider, (prev, input) => playValue(input), onError: onError, + weak: weak, + fireImmediately: false, ); playValue(sub.read(), callListeners: false); diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index 5301f7995..ac9a2b2d2 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -56,13 +56,15 @@ abstract base class ProviderBase extends ProviderOrFamily void Function(StateT? previous, StateT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, + required bool weak, required bool fireImmediately, }) { onError ??= Zone.current.handleUncaughtError; final element = node.readProviderElement(this); - element.flush(); + if (!weak) element.flush(); + if (fireImmediately) { _handleFireImmediately( element.stateResult!, diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 450c8ca9b..9d55f91e2 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -200,9 +200,7 @@ class ProviderDirectory implements _PointerBase { /// This has otherwise no impact unless there is a bug. pointer.element = element; - element - .._origin = origin - ..mount(); + element._origin = origin; } return pointer; @@ -752,6 +750,7 @@ class ProviderContainer implements Node { ProviderListenable provider, void Function(State? previous, State next) listener, { bool fireImmediately = false, + bool weak = false, void Function(Object error, StackTrace stackTrace)? onError, }) { return provider.addListener( @@ -759,6 +758,7 @@ class ProviderContainer implements Node { listener, fireImmediately: fireImmediately, onError: onError, + weak: weak, onDependencyMayHaveChanged: null, ); } diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index f7d883c5b..f4ef10ba6 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -81,6 +81,7 @@ class ProviderElementProxy required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, + required bool weak, }) { final element = node.readProviderElement(provider); @@ -93,6 +94,9 @@ class ProviderElementProxy final innerSub = node.listen( provider, (prev, next) {}, + weak: weak, + fireImmediately: false, + onError: null, ); final notifier = _lense(element); diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index d0641f586..b235a2a7b 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -568,7 +568,7 @@ final = Provider(dependencies: []); element .._onListen() - .._providerDependents.add(_element); + .._watchDependents.add(_element); return Object(); }); @@ -603,11 +603,13 @@ final = Provider(dependencies: []); ProviderListenable provider, void Function(T? previous, T next) listener, { void Function(Object error, StackTrace stackTrace)? onError, + bool weak = false, bool fireImmediately = false, }) { return _element.listen( provider, listener, + weak: weak, onError: onError, fireImmediately: fireImmediately, ); diff --git a/packages/riverpod/lib/src/core/scheduler.dart b/packages/riverpod/lib/src/core/scheduler.dart index 75e1409f7..27ed24a74 100644 --- a/packages/riverpod/lib/src/core/scheduler.dart +++ b/packages/riverpod/lib/src/core/scheduler.dart @@ -98,13 +98,13 @@ class ProviderScheduler { /// child will automatically refresh its parent when it will try to read it for (var i = 0; i < _stateToRefresh.length; i++) { final element = _stateToRefresh[i]; - if (element.hasListeners) element.flush(); + if (element.isActive) element.flush(); } } void scheduleProviderDispose(ProviderElement element) { assert( - !element.hasListeners, + !element.isActive, 'Tried to dispose ${element.origin} , but still has listeners', ); @@ -124,7 +124,7 @@ class ProviderScheduler { final links = element.ref?._keepAliveLinks; if ((links != null && links.isNotEmpty) || - element.hasListeners || + element.isActive || element.container._disposed) { continue; } diff --git a/packages/riverpod/test/new/core/auto_dispose_test.dart b/packages/riverpod/test/new/core/auto_dispose_test.dart index e0d9723bf..6eb4b7c07 100644 --- a/packages/riverpod/test/new/core/auto_dispose_test.dart +++ b/packages/riverpod/test/new/core/auto_dispose_test.dart @@ -9,6 +9,32 @@ import 'provider_container_test.dart'; void main() { group('AutoDispose', () { + test( + 'onDispose is triggered only once if within autoDispose unmount, a dependency changed', + () async { + // regression test for https://github.com/rrousselGit/riverpod/issues/1064 + final container = ProviderContainer.test(); + final onDispose = OnDisposeMock(); + final dep = StateProvider((ref) => 0); + final provider = Provider.autoDispose((ref) { + ref.watch(dep); + ref.onDispose(onDispose.call); + }); + + when(onDispose()).thenAnswer((realInvocation) { + container.read(dep.notifier).state++; + }); + + container.read(provider); + verifyZeroInteractions(onDispose); + + // cause provider to be disposed + await container.pump(); + + verify(onDispose()).called(1); + verifyNoMoreInteractions(onDispose); + }); + test('supports disposing of overridden families', () async { // Regression test for https://github.com/rrousselGit/riverpod/issues/2480 final provider = Provider.autoDispose.family( diff --git a/packages/riverpod/test/new/core/modifiers/future_test.dart b/packages/riverpod/test/new/core/modifiers/future_test.dart new file mode 100644 index 000000000..db961a56d --- /dev/null +++ b/packages/riverpod/test/new/core/modifiers/future_test.dart @@ -0,0 +1,63 @@ +import 'package:mockito/mockito.dart'; +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +import '../../utils.dart'; + +void main() { + group('provider.future', () { + group('handles listen(weak: true)', () { + test('common use-case ', () async { + var buildCount = 0; + final provider = FutureProvider((ref) { + buildCount++; + return 'Hello'; + }); + final container = ProviderContainer.test(); + final listener = Listener>(); + + container.listen( + provider.future, + listener.call, + weak: true, + ); + + verifyZeroInteractions(listener); + expect(buildCount, 0); + + container.read(provider); + + expect(buildCount, 1); + final [future as Future] = verifyOnly( + listener, + listener.call(argThat(isNull), captureAny), + ).captured; + expect(await future, 'Hello'); + }); + + test('calling `sub.read` on a weak listener will read the value', + () async { + final provider = FutureProvider((ref) => 'Hello'); + final container = ProviderContainer.test(); + final listener = Listener>(); + + final sub = container.listen( + provider.future, + listener.call, + weak: true, + ); + + verifyZeroInteractions(listener); + + expect(await sub.read(), 'Hello'); + + final [future as Future] = verifyOnly( + listener, + listener.call(argThat(isNull), captureAny), + ).captured; + + expect(await future, 'Hello'); + }); + }); + }); +} diff --git a/packages/riverpod/test/new/core/select_async_test.dart b/packages/riverpod/test/new/core/modifiers/select_async_test.dart similarity index 99% rename from packages/riverpod/test/new/core/select_async_test.dart rename to packages/riverpod/test/new/core/modifiers/select_async_test.dart index 8250c0841..2c75a54cc 100644 --- a/packages/riverpod/test/new/core/select_async_test.dart +++ b/packages/riverpod/test/new/core/modifiers/select_async_test.dart @@ -5,7 +5,7 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; -import '../utils.dart'; +import '../../utils.dart'; void main() { group('If disposed before a value could be emitted', () { diff --git a/packages/riverpod/test/new/core/modifiers/select_test.dart b/packages/riverpod/test/new/core/modifiers/select_test.dart new file mode 100644 index 000000000..b55e50a9d --- /dev/null +++ b/packages/riverpod/test/new/core/modifiers/select_test.dart @@ -0,0 +1,99 @@ +import 'package:mockito/mockito.dart'; +import 'package:riverpod/legacy.dart'; +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +import '../../utils.dart'; + +void main() { + group('provider.select', () { + test('handles when the selector throws', () { + final provider = Provider((ref) => Object()); + final container = ProviderContainer.test(); + + final errors = []; + container.read(provider); + final sub = container.listen( + provider.select((value) => throw StateError('Foo')), + (_, __) {}, + onError: (err, stack) => errors.add(err), + ); + + container.invalidate(provider); + + expect( + sub.read, + throwsA(isStateError.having((e) => e.message, 'message', 'Foo')), + ); + expect(errors, [isStateError.having((e) => e.message, 'message', 'Foo')]); + }); + + group('handles listen(weak: true)', () { + test('common use-case ', () { + final provider = StateProvider((ref) => 'Hello'); + final container = ProviderContainer.test(); + final listener = Listener(); + + container.listen( + provider.select((value) => value[0]), + listener.call, + weak: true, + ); + + verifyZeroInteractions(listener); + + container.read(provider); + + verifyOnly(listener, listener.call(null, 'H')); + + container.read(provider.notifier).state = 'World'; + + verifyOnly(listener, listener.call('H', 'W')); + + container.read(provider.notifier).state = 'Will not notify'; + + verifyNoMoreInteractions(listener); + }); + + test('calling `sub.read` on a weak listener will select the value', () { + final provider = StateProvider((ref) => 'Hello'); + final container = ProviderContainer.test(); + final listener = Listener(); + + final sub = container.listen( + provider.select((value) => value[0]), + listener.call, + weak: true, + ); + + verifyZeroInteractions(listener); + + expect(sub.read(), 'H'); + + verifyOnly(listener, listener.call(null, 'H')); + }); + + test( + 'after calling `sub.read`, notifications correctly compare the previous and new value ' + 'instead of considering that "previous" is missing.', () { + final provider = StateProvider((ref) => 'Hello'); + final container = ProviderContainer.test(); + final listener = Listener(); + + final sub = container.listen( + provider.select((value) => value[0]), + listener.call, + weak: true, + ); + + sub.read(); + + verifyOnly(listener, listener.call(null, 'H')); + + container.read(provider.notifier).state = 'Hi'; + + verifyNoMoreInteractions(listener); + }); + }); + }); +} diff --git a/packages/riverpod/test/new/core/provider_element_test.dart b/packages/riverpod/test/new/core/provider_element_test.dart new file mode 100644 index 000000000..7d83f92e9 --- /dev/null +++ b/packages/riverpod/test/new/core/provider_element_test.dart @@ -0,0 +1,184 @@ +import 'package:mockito/mockito.dart'; +import 'package:riverpod/src/internals.dart'; +import 'package:test/test.dart'; + +import '../../old/utils.dart'; + +void main() { + group('ProviderElement', () { + test( + 'does not throw outdated error when a dependency is flushed while the dependent is building', + () async { + final container = ProviderContainer.test(); + final a = StateProvider((ref) => 0); + + final dep = Provider((ref) { + return ref.watch(a) + 10; + }); + final dependent = Provider((ref) { + if (ref.watch(a) > 0) { + ref.watch(dep); + // Voluntarily using "watch" twice. + // When `dep` is flushed, it could cause subsequent "watch" calls to throw + // because `dependent` is considered as outdated + return ref.watch(dep); + } + return null; + }); + final listener = Listener(); + + expect(container.read(dep), 10); + container.listen(dependent, listener.call, fireImmediately: true); + + verifyOnly(listener, listener(null, null)); + + // schedules `dep` and `dependent` to rebuild + // Will build `dependent` before `dep` because `dependent` doesn't depend on `dep` yet + // And since nothing is watchin `dep` at the moment, then `dependent` will + // rebuild before `dep` even though `dep` is its ancestor. + // This is fine since nothing is listening to `dep` yet, but it should + // not cause certain assertions to trigger + container.read(a.notifier).state++; + await container.pump(); + + verifyOnly(listener, listener(null, 11)); + }); + + group('readSelf', () { + test('throws on providers that threw', () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => throw UnimplementedError()); + + final element = container.readProviderElement(provider); + + expect( + element.readSelf, + throwsUnimplementedError, + ); + }); + }); + + group('visitChildren', () { + test('includes ref.watch dependents', () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => 0); + final dependent = Provider((ref) { + ref.watch(provider); + }); + final dependent2 = Provider((ref) { + ref.watch(provider); + }); + + container.read(dependent); + container.read(dependent2); + + final children = []; + + container.readProviderElement(provider).visitChildren( + elementVisitor: children.add, + listenableVisitor: (_) {}, + ); + expect( + children, + unorderedMatches([ + isA() + .having((e) => e.provider, 'provider', dependent), + isA() + .having((e) => e.provider, 'provider', dependent2), + ]), + ); + }); + + test('includes ref.listen dependents', () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => 0); + final dependent = Provider((ref) { + ref.listen(provider, (_, __) {}); + }); + final dependent2 = Provider((ref) { + ref.listen(provider, (_, __) {}); + }); + + container.read(dependent); + container.read(dependent2); + + final children = []; + + container.readProviderElement(provider).visitChildren( + elementVisitor: children.add, + listenableVisitor: (_) {}, + ); + expect( + children, + unorderedMatches([ + isA() + .having((e) => e.provider, 'provider', dependent), + isA() + .having((e) => e.provider, 'provider', dependent2), + ]), + ); + }); + }); + + group('hasListeners', () { + test('includes provider listeners', () async { + final provider = Provider((ref) => 0); + final dep = Provider((ref) { + ref.listen(provider, (prev, value) {}); + }); + final container = ProviderContainer.test(); + + expect(container.readProviderElement(provider).hasListeners, false); + + container.read(dep); + + expect(container.readProviderElement(provider).hasListeners, true); + }); + + test('includes provider dependents', () async { + final provider = Provider((ref) => 0); + final dep = Provider((ref) { + ref.watch(provider); + }); + final container = ProviderContainer.test(); + + expect(container.readProviderElement(provider).hasListeners, false); + + container.read(dep); + + expect(container.readProviderElement(provider).hasListeners, true); + }); + + test('includes container listeners', () async { + final provider = Provider((ref) => 0); + final container = ProviderContainer.test(); + + expect(container.readProviderElement(provider).hasListeners, false); + + container.listen(provider, (_, __) {}); + + expect(container.readProviderElement(provider).hasListeners, true); + }); + }); + + test('does not notify listeners when rebuilding the state', () async { + final container = ProviderContainer.test(); + final listener = Listener(); + + final dep = StateProvider((ref) => 0); + final provider = Provider((ref) { + ref.watch(dep); + return ref.state = 0; + }); + + container.listen(provider, listener.call, fireImmediately: true); + + verifyOnly(listener, listener(null, 0)); + + container.read(dep.notifier).state++; + await container.pump(); + + verifyNoMoreInteractions(listener); + }); + }); +} diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/new/core/ref_test.dart index f0e375838..3ffc0921e 100644 --- a/packages/riverpod/test/new/core/ref_test.dart +++ b/packages/riverpod/test/new/core/ref_test.dart @@ -4,7 +4,11 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/internals.dart' - show CircularDependencyError, UnmountedRefException; + show + CircularDependencyError, + ProviderContainerTest, + ProviderElement, + UnmountedRefException; import 'package:test/test.dart'; import '../utils.dart'; @@ -824,6 +828,111 @@ void main() { }); group('listen', () { + group('weak', () { + test('Mounts the element but does not initialize the provider', () { + final container = ProviderContainer.test(); + + final dep = StateProvider((ref) => 0); + final provider = Provider((ref) { + ref.listen( + dep, + weak: true, + (previous, next) {}, + ); + return 0; + }); + + container.read(provider); + + expect( + container.pointerManager.orphanPointers.pointers[dep]!.element, + isA>() + .having((e) => e.stateResult, 'stateResult', null), + ); + }); + + test('when finally mounting an element, notifies weak listeners', () { + final container = ProviderContainer.test(); + + final listener = Listener(); + final dep = StateProvider((ref) => 0); + final provider = Provider((ref) { + ref.listen(dep, weak: true, listener.call); + return 0; + }); + + container.read(provider); + + verifyZeroInteractions(listener); + + // Flush the provider + container.read(dep); + + verifyOnly(listener, listener(null, 0)); + }); + + test('when finally rebuilding a dirty element, notifies weak listeners', + () { + final container = ProviderContainer.test(); + + final listener = Listener(); + var result = 0; + final dep = StateProvider((ref) => result); + final provider = Provider((ref) { + ref.listen(dep, weak: true, listener.call); + return 0; + }); + + container.read(dep); + container.invalidate(dep); + result = 1; + + container.read(provider); + + verifyZeroInteractions(listener); + + // Flush the provider + container.read(dep); + + verifyOnly(listener, listener(0, 1)); + }); + + test( + 'adding a weak listener on an invalidated provider does not rebuild it', + () { + final container = ProviderContainer.test(); + var buildCount = 0; + final dep = StateProvider((ref) { + buildCount++; + return 0; + }); + final provider = Provider((ref) { + ref.listen(dep, weak: true, (previous, next) {}); + return 0; + }); + + container.read(dep); + container.invalidate(dep); + expect(buildCount, 1); + + container.read(provider); + + expect(buildCount, 1); + }); + + test('throws if specifying both weak and fireImmediately', () { + throw UnimplementedError(); + }); + + test('does not count towards the pause mechanism', () { + throw UnimplementedError(); + }); + + test('does not interfere with autoDispose', () { + throw UnimplementedError(); + }); + }); + test('ref.listen on outdated provider causes it to rebuild', () { final dep = StateProvider((ref) => 0); var buildCount = 0; diff --git a/packages/riverpod/test/new/core/select_test.dart b/packages/riverpod/test/new/core/select_test.dart deleted file mode 100644 index eb9c37a6b..000000000 --- a/packages/riverpod/test/new/core/select_test.dart +++ /dev/null @@ -1,27 +0,0 @@ -import 'package:riverpod/riverpod.dart'; -import 'package:test/test.dart'; - -void main() { - group('provider.select', () { - test('handles when the selector throws', () { - final provider = Provider((ref) => Object()); - final container = ProviderContainer.test(); - - final errors = []; - container.read(provider); - final sub = container.listen( - provider.select((value) => throw StateError('Foo')), - (_, __) {}, - onError: (err, stack) => errors.add(err), - ); - - container.invalidate(provider); - - expect( - sub.read, - throwsA(isStateError.having((e) => e.message, 'message', 'Foo')), - ); - expect(errors, [isStateError.having((e) => e.message, 'message', 'Foo')]); - }); - }); -} diff --git a/packages/riverpod/test/old/framework/provider_element_test.dart b/packages/riverpod/test/old/framework/provider_element_test.dart deleted file mode 100644 index 00c6720fb..000000000 --- a/packages/riverpod/test/old/framework/provider_element_test.dart +++ /dev/null @@ -1,223 +0,0 @@ -import 'package:mockito/mockito.dart'; -import 'package:riverpod/src/internals.dart'; -import 'package:test/test.dart'; - -import '../utils.dart'; - -void main() { - test( - 'onDispose is triggered only once if within autoDispose unmount, a dependency changed', - () async { - // regression test for https://github.com/rrousselGit/riverpod/issues/1064 - final container = ProviderContainer.test(); - final onDispose = OnDisposeMock(); - final dep = StateProvider((ref) => 0); - final provider = Provider.autoDispose((ref) { - ref.watch(dep); - ref.onDispose(onDispose.call); - }); - - when(onDispose()).thenAnswer((realInvocation) { - container.read(dep.notifier).state++; - }); - - container.read(provider); - verifyZeroInteractions(onDispose); - - // cause provider to be disposed - await container.pump(); - - verify(onDispose()).called(1); - verifyNoMoreInteractions(onDispose); - }); - - test( - 'does not throw outdated error when a dependency is flushed while the dependent is building', - () async { - final container = ProviderContainer.test(); - final a = StateProvider((ref) => 0); - - final dep = Provider((ref) { - return ref.watch(a) + 10; - }); - final dependent = Provider((ref) { - if (ref.watch(a) > 0) { - ref.watch(dep); - // Voluntarily using "watch" twice. - // When `dep` is flushed, it could cause subsequent "watch" calls to throw - // because `dependent` is considered as outdated - return ref.watch(dep); - } - return null; - }); - final listener = Listener(); - - expect(container.read(dep), 10); - container.listen(dependent, listener.call, fireImmediately: true); - - verifyOnly(listener, listener(null, null)); - - // schedules `dep` and `dependent` to rebuild - // Will build `dependent` before `dep` because `dependent` doesn't depend on `dep` yet - // And since nothing is watchin `dep` at the moment, then `dependent` will - // rebuild before `dep` even though `dep` is its ancestor. - // This is fine since nothing is listening to `dep` yet, but it should - // not cause certain assertions to trigger - container.read(a.notifier).state++; - await container.pump(); - - verifyOnly(listener, listener(null, 11)); - }); - - group('getState', () { - test('throws on providers that threw', () { - final container = ProviderContainer.test(); - final provider = Provider((ref) => throw UnimplementedError()); - - final element = container.readProviderElement(provider); - - expect( - element.stateResult, - isA>() - .having((e) => e.error, 'error', isUnimplementedError), - ); - }); - }); - - group('readSelf', () { - test('throws on providers that threw', () { - final container = ProviderContainer.test(); - final provider = Provider((ref) => throw UnimplementedError()); - - final element = container.readProviderElement(provider); - - expect( - element.readSelf, - throwsUnimplementedError, - ); - }); - }); - - group('visitChildren', () { - test('includes ref.watch dependents', () { - final container = ProviderContainer.test(); - final provider = Provider((ref) => 0); - final dependent = Provider((ref) { - ref.watch(provider); - }); - final dependent2 = Provider((ref) { - ref.watch(provider); - }); - - container.read(dependent); - container.read(dependent2); - - final children = []; - - container.readProviderElement(provider).visitChildren( - elementVisitor: children.add, - listenableVisitor: (_) {}, - ); - expect( - children, - unorderedMatches([ - isA() - .having((e) => e.provider, 'provider', dependent), - isA() - .having((e) => e.provider, 'provider', dependent2), - ]), - ); - }); - - test('includes ref.listen dependents', () { - final container = ProviderContainer.test(); - final provider = Provider((ref) => 0); - final dependent = Provider((ref) { - ref.listen(provider, (_, __) {}); - }); - final dependent2 = Provider((ref) { - ref.listen(provider, (_, __) {}); - }); - - container.read(dependent); - container.read(dependent2); - - final children = []; - - container.readProviderElement(provider).visitChildren( - elementVisitor: children.add, - listenableVisitor: (_) {}, - ); - expect( - children, - unorderedMatches([ - isA() - .having((e) => e.provider, 'provider', dependent), - isA() - .having((e) => e.provider, 'provider', dependent2), - ]), - ); - }); - }); - - group('hasListeners', () { - test('includes provider listeners', () async { - final provider = Provider((ref) => 0); - final dep = Provider((ref) { - ref.listen(provider, (prev, value) {}); - }); - final container = ProviderContainer.test(); - - expect(container.readProviderElement(provider).hasListeners, false); - - container.read(dep); - - expect(container.readProviderElement(provider).hasListeners, true); - }); - - test('includes provider dependents', () async { - final provider = Provider((ref) => 0); - final dep = Provider((ref) { - ref.watch(provider); - }); - final container = ProviderContainer.test(); - - expect(container.readProviderElement(provider).hasListeners, false); - - container.read(dep); - - expect(container.readProviderElement(provider).hasListeners, true); - }); - - test('includes container listeners', () async { - final provider = Provider((ref) => 0); - final container = ProviderContainer.test(); - - expect(container.readProviderElement(provider).hasListeners, false); - - container.listen(provider, (_, __) {}); - - expect(container.readProviderElement(provider).hasListeners, true); - }); - }); - - test('does not notify listeners when rebuilding the state', () async { - final container = ProviderContainer.test(); - final listener = Listener(); - - final dep = StateProvider((ref) => 0); - final provider = Provider((ref) { - ref.watch(dep); - return ref.state = 0; - }); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(listener, listener(null, 0)); - - container.read(dep.notifier).state++; - await container.pump(); - - verifyNoMoreInteractions(listener); - }); -} diff --git a/packages/riverpod/test/old/framework/ref_watch_test.dart b/packages/riverpod/test/old/framework/ref_watch_test.dart index 9ba5d089e..c0ad29f4d 100644 --- a/packages/riverpod/test/old/framework/ref_watch_test.dart +++ b/packages/riverpod/test/old/framework/ref_watch_test.dart @@ -251,7 +251,7 @@ void main() { }); test( - 'when selecting a provider, element.visitChildren visits the selected provider', + 'when selecting a provider, element.visitAncestors visits the selected provider', () { final container = ProviderContainer.test(); final selected = StateNotifierProvider, int>((ref) { @@ -261,6 +261,9 @@ void main() { ref.watch(selected.select((value) => null)); }); + container.read(provider); + container.read(selected); + final element = container.readProviderElement(provider); final selectedElement = container.readProviderElement(selected); diff --git a/packages/riverpod/test/old/legacy/framework_test.dart b/packages/riverpod/test/old/legacy/framework_test.dart index a41dee43e..c896f1cf2 100644 --- a/packages/riverpod/test/old/legacy/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework_test.dart @@ -7,25 +7,6 @@ import 'package:test/test.dart'; import '../utils.dart'; void main() { - test('hasListeners', () { - final container = ProviderContainer.test(); - final provider = Provider((_) => 42); - - expect(container.read(provider), 42); - - final state = container.getAllProviderElements().single; - - expect(state.hasListeners, false); - - final sub = container.listen(provider, (_, __) {}); - - expect(state.hasListeners, true); - - sub.close(); - - expect(state.hasListeners, false); - }); - test('test two families one overridden the other not', () { final family = Provider.family((ref, value) { return '$value'; From d9ddce238700d23428697ba2ad521b45755eb403 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 15 Mar 2024 12:10:46 +0100 Subject: [PATCH 297/387] Rename --- .../auto_dispose_family_future_provider_test.dart | 2 +- packages/riverpod/test/{new => src}/common/result_test.dart | 0 packages/riverpod/test/{new => src}/core/async_value_test.dart | 0 packages/riverpod/test/{new => src}/core/auto_dispose_test.dart | 0 .../riverpod/test/{new => src}/core/modifiers/future_test.dart | 0 .../test/{new => src}/core/modifiers/select_async_test.dart | 0 .../riverpod/test/{new => src}/core/modifiers/select_test.dart | 0 packages/riverpod/test/{new => src}/core/overrides_test.dart | 0 .../test/{new => src}/core/provider_container_test.dart | 0 .../riverpod/test/{new => src}/core/provider_element_test.dart | 0 .../riverpod/test/{new => src}/core/provider_observer_test.dart | 0 packages/riverpod/test/{new => src}/core/provider_test.dart | 0 packages/riverpod/test/{new => src}/core/ref_test.dart | 0 packages/riverpod/test/{new => src}/core/scope_test.dart | 0 .../riverpod/test/{new => src}/core/uni_directional_test.dart | 0 packages/riverpod/test/{new => src}/core/visit_states_test.dart | 0 packages/riverpod/test/{new => src}/matrix.dart | 0 .../test/{new => src}/matrix/async_notifier_provider.dart | 0 packages/riverpod/test/{new => src}/matrix/notifier_mixin.dart | 0 .../riverpod/test/{new => src}/matrix/notifier_provider.dart | 0 .../test/{new => src}/matrix/stream_notifier_provider.dart | 0 .../test/{new => src}/providers/async_notifier_test.dart | 0 .../riverpod/test/{new => src}/providers/notifier_test.dart | 0 .../test/{new => src}/providers/stream_notifier_test.dart | 0 packages/riverpod/test/{new => src}/utils.dart | 0 25 files changed, 1 insertion(+), 1 deletion(-) rename packages/riverpod/test/{new => src}/common/result_test.dart (100%) rename packages/riverpod/test/{new => src}/core/async_value_test.dart (100%) rename packages/riverpod/test/{new => src}/core/auto_dispose_test.dart (100%) rename packages/riverpod/test/{new => src}/core/modifiers/future_test.dart (100%) rename packages/riverpod/test/{new => src}/core/modifiers/select_async_test.dart (100%) rename packages/riverpod/test/{new => src}/core/modifiers/select_test.dart (100%) rename packages/riverpod/test/{new => src}/core/overrides_test.dart (100%) rename packages/riverpod/test/{new => src}/core/provider_container_test.dart (100%) rename packages/riverpod/test/{new => src}/core/provider_element_test.dart (100%) rename packages/riverpod/test/{new => src}/core/provider_observer_test.dart (100%) rename packages/riverpod/test/{new => src}/core/provider_test.dart (100%) rename packages/riverpod/test/{new => src}/core/ref_test.dart (100%) rename packages/riverpod/test/{new => src}/core/scope_test.dart (100%) rename packages/riverpod/test/{new => src}/core/uni_directional_test.dart (100%) rename packages/riverpod/test/{new => src}/core/visit_states_test.dart (100%) rename packages/riverpod/test/{new => src}/matrix.dart (100%) rename packages/riverpod/test/{new => src}/matrix/async_notifier_provider.dart (100%) rename packages/riverpod/test/{new => src}/matrix/notifier_mixin.dart (100%) rename packages/riverpod/test/{new => src}/matrix/notifier_provider.dart (100%) rename packages/riverpod/test/{new => src}/matrix/stream_notifier_provider.dart (100%) rename packages/riverpod/test/{new => src}/providers/async_notifier_test.dart (100%) rename packages/riverpod/test/{new => src}/providers/notifier_test.dart (100%) rename packages/riverpod/test/{new => src}/providers/stream_notifier_test.dart (100%) rename packages/riverpod/test/{new => src}/utils.dart (100%) diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart index 9f7c538e9..fa7607dd2 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_family_future_provider_test.dart @@ -2,7 +2,7 @@ import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; -import '../../../new/core/provider_container_test.dart'; +import '../../../src/core/provider_container_test.dart'; import '../../utils.dart'; void main() { diff --git a/packages/riverpod/test/new/common/result_test.dart b/packages/riverpod/test/src/common/result_test.dart similarity index 100% rename from packages/riverpod/test/new/common/result_test.dart rename to packages/riverpod/test/src/common/result_test.dart diff --git a/packages/riverpod/test/new/core/async_value_test.dart b/packages/riverpod/test/src/core/async_value_test.dart similarity index 100% rename from packages/riverpod/test/new/core/async_value_test.dart rename to packages/riverpod/test/src/core/async_value_test.dart diff --git a/packages/riverpod/test/new/core/auto_dispose_test.dart b/packages/riverpod/test/src/core/auto_dispose_test.dart similarity index 100% rename from packages/riverpod/test/new/core/auto_dispose_test.dart rename to packages/riverpod/test/src/core/auto_dispose_test.dart diff --git a/packages/riverpod/test/new/core/modifiers/future_test.dart b/packages/riverpod/test/src/core/modifiers/future_test.dart similarity index 100% rename from packages/riverpod/test/new/core/modifiers/future_test.dart rename to packages/riverpod/test/src/core/modifiers/future_test.dart diff --git a/packages/riverpod/test/new/core/modifiers/select_async_test.dart b/packages/riverpod/test/src/core/modifiers/select_async_test.dart similarity index 100% rename from packages/riverpod/test/new/core/modifiers/select_async_test.dart rename to packages/riverpod/test/src/core/modifiers/select_async_test.dart diff --git a/packages/riverpod/test/new/core/modifiers/select_test.dart b/packages/riverpod/test/src/core/modifiers/select_test.dart similarity index 100% rename from packages/riverpod/test/new/core/modifiers/select_test.dart rename to packages/riverpod/test/src/core/modifiers/select_test.dart diff --git a/packages/riverpod/test/new/core/overrides_test.dart b/packages/riverpod/test/src/core/overrides_test.dart similarity index 100% rename from packages/riverpod/test/new/core/overrides_test.dart rename to packages/riverpod/test/src/core/overrides_test.dart diff --git a/packages/riverpod/test/new/core/provider_container_test.dart b/packages/riverpod/test/src/core/provider_container_test.dart similarity index 100% rename from packages/riverpod/test/new/core/provider_container_test.dart rename to packages/riverpod/test/src/core/provider_container_test.dart diff --git a/packages/riverpod/test/new/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart similarity index 100% rename from packages/riverpod/test/new/core/provider_element_test.dart rename to packages/riverpod/test/src/core/provider_element_test.dart diff --git a/packages/riverpod/test/new/core/provider_observer_test.dart b/packages/riverpod/test/src/core/provider_observer_test.dart similarity index 100% rename from packages/riverpod/test/new/core/provider_observer_test.dart rename to packages/riverpod/test/src/core/provider_observer_test.dart diff --git a/packages/riverpod/test/new/core/provider_test.dart b/packages/riverpod/test/src/core/provider_test.dart similarity index 100% rename from packages/riverpod/test/new/core/provider_test.dart rename to packages/riverpod/test/src/core/provider_test.dart diff --git a/packages/riverpod/test/new/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart similarity index 100% rename from packages/riverpod/test/new/core/ref_test.dart rename to packages/riverpod/test/src/core/ref_test.dart diff --git a/packages/riverpod/test/new/core/scope_test.dart b/packages/riverpod/test/src/core/scope_test.dart similarity index 100% rename from packages/riverpod/test/new/core/scope_test.dart rename to packages/riverpod/test/src/core/scope_test.dart diff --git a/packages/riverpod/test/new/core/uni_directional_test.dart b/packages/riverpod/test/src/core/uni_directional_test.dart similarity index 100% rename from packages/riverpod/test/new/core/uni_directional_test.dart rename to packages/riverpod/test/src/core/uni_directional_test.dart diff --git a/packages/riverpod/test/new/core/visit_states_test.dart b/packages/riverpod/test/src/core/visit_states_test.dart similarity index 100% rename from packages/riverpod/test/new/core/visit_states_test.dart rename to packages/riverpod/test/src/core/visit_states_test.dart diff --git a/packages/riverpod/test/new/matrix.dart b/packages/riverpod/test/src/matrix.dart similarity index 100% rename from packages/riverpod/test/new/matrix.dart rename to packages/riverpod/test/src/matrix.dart diff --git a/packages/riverpod/test/new/matrix/async_notifier_provider.dart b/packages/riverpod/test/src/matrix/async_notifier_provider.dart similarity index 100% rename from packages/riverpod/test/new/matrix/async_notifier_provider.dart rename to packages/riverpod/test/src/matrix/async_notifier_provider.dart diff --git a/packages/riverpod/test/new/matrix/notifier_mixin.dart b/packages/riverpod/test/src/matrix/notifier_mixin.dart similarity index 100% rename from packages/riverpod/test/new/matrix/notifier_mixin.dart rename to packages/riverpod/test/src/matrix/notifier_mixin.dart diff --git a/packages/riverpod/test/new/matrix/notifier_provider.dart b/packages/riverpod/test/src/matrix/notifier_provider.dart similarity index 100% rename from packages/riverpod/test/new/matrix/notifier_provider.dart rename to packages/riverpod/test/src/matrix/notifier_provider.dart diff --git a/packages/riverpod/test/new/matrix/stream_notifier_provider.dart b/packages/riverpod/test/src/matrix/stream_notifier_provider.dart similarity index 100% rename from packages/riverpod/test/new/matrix/stream_notifier_provider.dart rename to packages/riverpod/test/src/matrix/stream_notifier_provider.dart diff --git a/packages/riverpod/test/new/providers/async_notifier_test.dart b/packages/riverpod/test/src/providers/async_notifier_test.dart similarity index 100% rename from packages/riverpod/test/new/providers/async_notifier_test.dart rename to packages/riverpod/test/src/providers/async_notifier_test.dart diff --git a/packages/riverpod/test/new/providers/notifier_test.dart b/packages/riverpod/test/src/providers/notifier_test.dart similarity index 100% rename from packages/riverpod/test/new/providers/notifier_test.dart rename to packages/riverpod/test/src/providers/notifier_test.dart diff --git a/packages/riverpod/test/new/providers/stream_notifier_test.dart b/packages/riverpod/test/src/providers/stream_notifier_test.dart similarity index 100% rename from packages/riverpod/test/new/providers/stream_notifier_test.dart rename to packages/riverpod/test/src/providers/stream_notifier_test.dart diff --git a/packages/riverpod/test/new/utils.dart b/packages/riverpod/test/src/utils.dart similarity index 100% rename from packages/riverpod/test/new/utils.dart rename to packages/riverpod/test/src/utils.dart From 32ccc6933db79acfe569fb8b6cd46776955f0bfb Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 15 Mar 2024 18:21:48 +0100 Subject: [PATCH 298/387] W --- examples/counter/lib/main.g.dart | 4 +- examples/pub/lib/detail.g.dart | 28 +-- examples/pub/lib/search.g.dart | 8 +- examples/stackoverflow/lib/common.g.dart | 4 +- examples/stackoverflow/lib/question.g.dart | 4 +- examples/stackoverflow/lib/tag.g.dart | 4 +- .../legacy/change_notifier_provider.dart | 6 +- packages/riverpod/lib/riverpod.dart | 3 +- .../riverpod/lib/src/common/listenable.dart | 6 - .../lib/src/providers/async_notifier.dart | 2 +- .../src/providers/async_notifier/family.dart | 4 +- .../src/providers/async_notifier/orphan.dart | 4 +- .../lib/src/providers/future_provider.dart | 6 +- .../legacy/state_notifier_provider.dart | 6 +- .../src/providers/legacy/state_provider.dart | 6 +- .../riverpod/lib/src/providers/notifier.dart | 2 +- .../lib/src/providers/notifier/family.dart | 4 +- .../lib/src/providers/notifier/orphan.dart | 4 +- .../riverpod/lib/src/providers/provider.dart | 8 +- .../lib/src/providers/stream_notifier.dart | 2 +- .../src/providers/stream_notifier/family.dart | 4 +- .../src/providers/stream_notifier/orphan.dart | 4 +- .../lib/src/providers/stream_provider.dart | 8 +- .../lib/riverpod_annotation.dart | 1 + .../integration/build_yaml/lib/main.g.dart | 84 ++++---- .../lib/src/templates/family.dart | 22 +- .../lib/src/templates/provider.dart | 8 +- .../test/integration/annotated.g.dart | 44 ++-- .../test/integration/async.g.dart | 76 +++---- .../test/integration/auto_dispose.g.dart | 36 ++-- .../test/integration/dependencies.g.dart | 92 ++++---- .../test/integration/dependencies2.g.dart | 36 ++-- .../test/integration/documented.g.dart | 28 +-- .../test/integration/generated.g.dart | 92 ++++---- .../test/integration/hash/hash1.g.dart | 12 +- .../test/integration/scopes.g.dart | 16 +- .../test/integration/split.g.dart | 8 +- .../test/integration/stream.g.dart | 56 ++--- .../test/integration/sync.g.dart | 196 +++++++++--------- .../generated/golden/lib/sync.g.dart | 44 ++-- ..._class_based_provider_to_functional.g.dart | 28 +-- ..._functional_provider_to_class_based.g.dart | 12 +- .../avoid_build_context_in_providers.g.dart | 24 +-- .../avoid_public_notifier_properties.g.dart | 12 +- .../functional_ref/functional_ref.g.dart | 36 ++-- .../test/lints/notifier_extends.g.dart | 64 +++--- ...ly_use_keep_alive_inside_keep_alive.g.dart | 20 +- .../protected_notifier_properties.g.dart | 94 ++++----- .../provider_dependencies/another.g.dart | 12 +- .../missing_dependencies.g.dart | 44 ++-- .../missing_dependencies2.g.dart | 96 ++++----- .../unused_dependency.g.dart | 36 ++-- .../test/lints/provider_parameters.g.dart | 8 +- ...oviders_should_specify_dependencies.g.dart | 12 +- .../test/lints/unknown_scoped_usage.g.dart | 8 +- .../lints/unsupported_provider_value.g.dart | 87 ++++---- .../advanced/select/select/codegen.g.dart | 4 +- .../select/select_async/codegen.g.dart | 8 +- .../cancel/detail_screen/codegen.g.dart | 5 +- .../detail_screen_cancel/codegen.g.dart | 5 +- .../detail_screen_debounce/codegen.g.dart | 5 +- .../provider_with_extension/codegen.g.dart | 5 +- .../fetch_activity/codegen.g.dart | 5 +- .../pull_to_refresh/full_app/codegen.g.dart | 5 +- .../docs/concepts/about_codegen/main.g.dart | 8 +- .../provider_type/async_class_future.g.dart | 4 +- .../provider_type/async_class_stream.g.dart | 4 +- .../provider_type/async_fn_future.g.dart | 4 +- .../provider_type/async_fn_stream.g.dart | 4 +- .../provider_type/auto_dispose.g.dart | 8 +- .../about_codegen/provider_type/family.g.dart | 8 +- .../provider_type/family_class.g.dart | 12 +- .../provider_type/family_fn.g.dart | 8 +- .../provider_type/sync_class.g.dart | 4 +- .../provider_type/sync_fn.g.dart | 4 +- .../characters_provider/codegen.g.dart | 12 +- .../city_provider/codegen.g.dart | 4 +- .../codegen.g.dart | 8 +- .../read_in_provider/codegen.g.dart | 8 +- .../select_async_provider/codegen.g.dart | 8 +- .../todo_list_provider/codegen.g.dart | 4 +- .../weather_provider/codegen.g.dart | 8 +- .../whole_object_provider/codegen.g.dart | 8 +- .../lifecycle_on_dispose/codegen.g.dart | 4 +- .../creating_a_provider/codegen.g.dart | 4 +- .../declaring_many_providers/codegen.g.dart | 8 +- .../concepts/reading/counter/codegen.g.dart | 8 +- .../concepts/reading/listen/codegen.g.dart | 4 +- .../reading/listen_build/codegen.g.dart | 4 +- .../reading/listen_build/codegen_hooks.g.dart | 4 +- .../concepts/reading/provider/codegen.g.dart | 8 +- .../docs/concepts/reading/read/codegen.g.dart | 4 +- .../reading/read/codegen_hooks.g.dart | 4 +- .../reading/read_build/codegen.g.dart | 4 +- .../read_notifier_build/codegen.g.dart | 4 +- .../concepts/reading/watch/codegen.g.dart | 12 +- .../reading/watch_build/codegen.g.dart | 8 +- .../reading/watch_build/codegen_hooks.g.dart | 8 +- .../watch_notifier_build/codegen.g.dart | 4 +- .../concepts/why_immutability/codegen.g.dart | 4 +- .../cache_for_usage/codegen.g.dart | 4 +- .../auto_dispose/codegen_keep_alive.g.dart | 4 +- .../invalidate_family_example/codegen.g.dart | 8 +- .../auto_dispose/keep_alive/codegen.g.dart | 4 +- .../on_dispose_example/codegen.g.dart | 8 +- .../functional_ref/codegen.g.dart | 8 +- .../listen_example/codegen.g.dart | 8 +- .../notifier_ref/codegen.g.dart | 8 +- .../read_example/codegen.g.dart | 8 +- .../watch_example/codegen.g.dart | 8 +- .../watch_placement/codegen.g.dart | 12 +- .../require_value/codegen.g.dart | 4 +- .../first_request/codegen/provider.g.dart | 5 +- .../passing_args/family/codegen.g.dart | 21 +- .../no_arg_provider/codegen.g.dart | 9 +- .../codegen/todo_list_notifier.g.dart | 4 +- .../todo_list_notifier_add_todo.g.dart | 4 +- .../codegen/todo_list_provider.g.dart | 5 +- .../testing/notifier_mock/codegen.g.dart | 4 +- .../testing/provider_to_mock/codegen.g.dart | 4 +- .../pipe_change_notifier.g.dart | 4 +- .../websockets_sync/raw_usage.g.dart | 5 +- .../shared_pipe_change_notifier.g.dart | 8 +- .../stream_provider/codegen.g.dart | 4 +- .../sync_definition/codegen.g.dart | 4 +- .../docs/from_provider/family/family.g.dart | 8 +- .../async_values/async_values.g.dart | 9 +- .../auto_dispose/auto_dispose.g.dart | 8 +- .../motivation/combine/combine.g.dart | 8 +- .../motivation/same_type/same_type.g.dart | 8 +- .../dart_hello_world/main.g.dart | 4 +- .../hello_world/hooks_codegen/main.g.dart | 4 +- .../getting_started/hello_world/main.g.dart | 4 +- .../introduction/why_riverpod/codegen.g.dart | 8 +- .../declaration/declaration.g.dart | 4 +- .../initialization/initialization.g.dart | 4 +- .../migrated/migrated.g.dart | 4 +- .../add_listener/add_listener.g.dart | 4 +- .../async_notifier/async_notifier.g.dart | 4 +- .../build_init/build_init.g.dart | 4 +- .../family_and_dispose.g.dart | 17 +- .../from_state_provider.g.dart | 4 +- .../old_lifecycles/old_lifecycles.g.dart | 4 +- .../old_lifecycles_final.g.dart | 12 +- .../config_provider/codegen.g.dart | 4 +- .../remote_todos/codegen.g.dart | 4 +- .../notifier_provider/todos/codegen.g.dart | 4 +- .../completed_todos/completed_todos.g.dart | 4 +- .../optimized_previous_button.g.dart | 8 +- .../docs/providers/provider/todo/todo.g.dart | 4 +- .../unoptimized_previous_button.g.dart | 4 +- .../live_stream_chat_provider/codegen.g.dart | 4 +- website/static/snippets/async.g.dart | 4 +- website/static/snippets/combine.g.dart | 12 +- website/static/snippets/create.g.dart | 4 +- website/static/snippets/declare.g.dart | 4 +- 156 files changed, 1079 insertions(+), 1109 deletions(-) diff --git a/examples/counter/lib/main.g.dart b/examples/counter/lib/main.g.dart index 329a2e299..9c6018064 100644 --- a/examples/counter/lib/main.g.dart +++ b/examples/counter/lib/main.g.dart @@ -73,8 +73,8 @@ final class CounterProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$counterHash() => r'4243b34530f53accfd9014a9f0e316fe304ada3e'; diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 9d4cf8519..56f66131e 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -50,8 +50,8 @@ final class FetchPackageDetailsProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override FetchPackageDetailsProvider $copyWithCreate( @@ -122,14 +122,14 @@ final class FetchPackageDetailsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FetchPackageDetailsProvider; final argument = provider.argument as String; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -169,8 +169,8 @@ final class LikedPackagesProvider extends $FunctionalProvider< @$internal @override $FutureProviderElement> $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override LikedPackagesProvider $copyWithCreate( @@ -229,8 +229,8 @@ final class PubRepositoryProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override PubRepositoryProvider $copyWithCreate( @@ -327,8 +327,8 @@ final class PackageMetricsProvider @$internal @override $AsyncNotifierProviderElement - $createElement(ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $createElement($ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -381,14 +381,14 @@ final class PackageMetricsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as PackageMetricsProvider; final argument = provider.argument as String; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -403,14 +403,14 @@ final class PackageMetricsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as PackageMetricsProvider; final argument = provider.argument as String; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 23790cab4..7f1bff945 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -57,8 +57,8 @@ final class FetchPackagesProvider extends $FunctionalProvider< @$internal @override $FutureProviderElement> $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override FetchPackagesProvider $copyWithCreate( @@ -143,7 +143,7 @@ final class FetchPackagesFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FetchPackagesProvider; final argument = provider.argument as ({ @@ -153,7 +153,7 @@ final class FetchPackagesFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/examples/stackoverflow/lib/common.g.dart b/examples/stackoverflow/lib/common.g.dart index 63b1a4c40..1d5703c51 100644 --- a/examples/stackoverflow/lib/common.g.dart +++ b/examples/stackoverflow/lib/common.g.dart @@ -62,8 +62,8 @@ final class ThemeProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ThemeProvider $copyWithCreate( diff --git a/examples/stackoverflow/lib/question.g.dart b/examples/stackoverflow/lib/question.g.dart index 9e663d100..4a56d8b9a 100644 --- a/examples/stackoverflow/lib/question.g.dart +++ b/examples/stackoverflow/lib/question.g.dart @@ -151,8 +151,8 @@ final class CurrentQuestionProvider @$internal @override $ProviderElement> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CurrentQuestionProvider $copyWithCreate( diff --git a/examples/stackoverflow/lib/tag.g.dart b/examples/stackoverflow/lib/tag.g.dart index 453f84ab8..1a25986f9 100644 --- a/examples/stackoverflow/lib/tag.g.dart +++ b/examples/stackoverflow/lib/tag.g.dart @@ -50,8 +50,8 @@ final class TagThemeProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override TagThemeProvider $copyWithCreate( 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 index 642d31211..15fd2be27 100644 --- 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 @internal @override ChangeNotifierProviderElement $createElement( - ProviderContainer container, + $ProviderPointer pointer, ) { - return ChangeNotifierProviderElement._(this, container); + return ChangeNotifierProviderElement._(this, pointer); } @mustBeOverridden @@ -161,7 +161,7 @@ final class ChangeNotifierProvider /// The element of [ChangeNotifierProvider]. class ChangeNotifierProviderElement extends ProviderElement { - ChangeNotifierProviderElement._(this.provider, super.container); + ChangeNotifierProviderElement._(this.provider, super.pointer); @override final ChangeNotifierProvider provider; diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 67dc9e532..0d14e569f 100644 --- 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 index e31db5d41..7284f7c37 100644 --- a/packages/riverpod/lib/src/common/listenable.dart +++ b/packages/riverpod/lib/src/common/listenable.dart @@ -48,12 +48,6 @@ class ProxyElementValueListenable extends _ValueListenable { _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? value) { - _result = value; - } } class _ValueListenable { diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index 61bff0a28..dd008f83e 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -59,7 +59,7 @@ class $AsyncNotifierProviderElement< // FutureModifierClassElement> { /// Implementation detail of `riverpod_generator`. /// Do not use. - $AsyncNotifierProviderElement(this.provider, super.container); + $AsyncNotifierProviderElement(this.provider, super.pointer); @override final $AsyncNotifierProvider provider; diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index 1e908728d..e9ccd5ced 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -96,9 +96,9 @@ final class FamilyAsyncNotifierProvider< // @internal @override $AsyncNotifierProviderElement $createElement( - ProviderContainer container, + $ProviderPointer pointer, ) { - return $AsyncNotifierProviderElement(this, container); + return $AsyncNotifierProviderElement(this, pointer); } @mustBeOverridden diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index 7cd802786..12b5f08ae 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -119,9 +119,9 @@ final class AsyncNotifierProvider< // @internal @override $AsyncNotifierProviderElement $createElement( - ProviderContainer container, + $ProviderPointer pointer, ) { - return $AsyncNotifierProviderElement(this, container); + return $AsyncNotifierProviderElement(this, pointer); } @mustBeOverridden diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 45dc0a18b..1c442ee0e 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -136,8 +136,8 @@ final class FutureProvider @internal @override - $FutureProviderElement $createElement(ProviderContainer container) { - return $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) { + return $FutureProviderElement(this, pointer); } @mustBeOverridden @@ -165,7 +165,7 @@ class $FutureProviderElement extends ProviderElement> with FutureModifierElement { /// The element of a [FutureProvider] /// Implementation detail of `riverpod_generator`. Do not use. - $FutureProviderElement(this.provider, super.container); + $FutureProviderElement(this.provider, super.pointer); @override final $FutureProvider>> provider; diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index 93334d62b..e5b85785c 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -138,9 +138,9 @@ final class StateNotifierProvider< // @internal @override StateNotifierProviderElement $createElement( - ProviderContainer container, + $ProviderPointer pointer, ) { - return StateNotifierProviderElement._(this, container); + return StateNotifierProviderElement._(this, pointer); } @mustBeOverridden @@ -164,7 +164,7 @@ final class StateNotifierProvider< // /// The element of [StateNotifierProvider]. class StateNotifierProviderElement, StateT> extends ProviderElement { - StateNotifierProviderElement._(this.provider, super.container); + StateNotifierProviderElement._(this.provider, super.pointer); @override final StateNotifierProvider provider; diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index f1b306379..f88c531f2 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -88,9 +88,9 @@ final class StateProvider extends $FunctionalProvider @internal @override StateProviderElement $createElement( - ProviderContainer container, + $ProviderPointer pointer, ) { - return StateProviderElement._(this, container); + return StateProviderElement._(this, pointer); } @mustBeOverridden @@ -113,7 +113,7 @@ final class StateProvider extends $FunctionalProvider /// The element of [StateProvider]. class StateProviderElement extends ProviderElement { - StateProviderElement._(this.provider, super.container); + StateProviderElement._(this.provider, super.pointer); @override final StateProvider provider; diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index 8a4116709..d8a3b2dbf 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -111,7 +111,7 @@ class $NotifierProviderElement< // StateT> { /// An implementation detail of `riverpod_generator`. /// Do not use. - $NotifierProviderElement(this.provider, super.container); + $NotifierProviderElement(this.provider, super.pointer); @override final $NotifierProvider provider; diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index 6aec115a5..12b6c4146 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -40,9 +40,9 @@ final class FamilyNotifierProvider // @internal @override $NotifierProviderElement $createElement( - ProviderContainer container, + $ProviderPointer pointer, ) { - return $NotifierProviderElement(this, container); + return $NotifierProviderElement(this, pointer); } FamilyNotifierProvider _copyWith({ diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart index d0d1df078..af0f7f2d3 100644 --- a/packages/riverpod/lib/src/providers/notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -119,9 +119,9 @@ final class NotifierProvider, StateT> @internal @override $NotifierProviderElement $createElement( - ProviderContainer container, + $ProviderPointer pointer, ) { - return $NotifierProviderElement(this, container); + return $NotifierProviderElement(this, pointer); } NotifierProvider _copyWith({ diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index df922d39b..2d63a1517 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -54,10 +54,8 @@ base class Provider extends $FunctionalProvider @internal @override - $ProviderElement $createElement( - ProviderContainer container, - ) { - return $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) { + return $ProviderElement(this, pointer); } @mustBeOverridden @@ -344,7 +342,7 @@ base class Provider extends $FunctionalProvider @internal class $ProviderElement extends ProviderElement { /// A [ProviderElement] for [Provider] - $ProviderElement(this.provider, super.container); + $ProviderElement(this.provider, super.pointer); @override final $Provider> provider; diff --git a/packages/riverpod/lib/src/providers/stream_notifier.dart b/packages/riverpod/lib/src/providers/stream_notifier.dart index 872507a61..eaebc6885 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier.dart @@ -60,7 +60,7 @@ class $StreamNotifierProviderElement< // FutureModifierClassElement> { /// Implementation detail of `riverpod_generator`. /// Do not use. - $StreamNotifierProviderElement(this.provider, super.container); + $StreamNotifierProviderElement(this.provider, super.pointer); @override final $StreamNotifierProvider provider; diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index 6b421a8e0..1c9d130a5 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -53,9 +53,9 @@ final class FamilyStreamNotifierProvider< // @internal @override $StreamNotifierProviderElement $createElement( - ProviderContainer container, + $ProviderPointer pointer, ) { - return $StreamNotifierProviderElement(this, container); + return $StreamNotifierProviderElement(this, pointer); } FamilyStreamNotifierProvider _copyWith({ diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index 3e612185c..d0fbaec59 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -105,9 +105,9 @@ final class StreamNotifierProvider< // @internal @override $StreamNotifierProviderElement $createElement( - ProviderContainer container, + $ProviderPointer pointer, ) { - return $StreamNotifierProviderElement(this, container); + return $StreamNotifierProviderElement(this, pointer); } @mustBeOverridden diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index b7ddf7789..128f0e3b2 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -125,10 +125,8 @@ base class StreamProvider @internal @override - $StreamProviderElement $createElement( - ProviderContainer container, - ) { - return $StreamProviderElement(this, container); + $StreamProviderElement $createElement($ProviderPointer pointer) { + return $StreamProviderElement(this, pointer); } @mustBeOverridden @@ -154,7 +152,7 @@ base class StreamProvider class $StreamProviderElement extends ProviderElement> with FutureModifierElement { /// The element of [StreamProvider]. - $StreamProviderElement(this.provider, super.container); + $StreamProviderElement(this.provider, super.pointer); @override final $StreamProvider>> provider; diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index 3f5ca603b..fb6b71d14 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -23,6 +23,7 @@ export 'package:riverpod/src/internals.dart' $ValueProvider, $ProviderOverride, $RefArg, + $ProviderPointer, // Provider $Provider, diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 3f4e17a57..0143d0d5f 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -44,8 +44,8 @@ final class CountProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CountProvider $copyWithCreate( @@ -96,8 +96,8 @@ final class CountFutureProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override CountFutureProvider $copyWithCreate( @@ -148,8 +148,8 @@ final class CountStreamProvider @$internal @override - $StreamProviderElement $createElement(ProviderContainer container) => - $StreamProviderElement(this, container); + $StreamProviderElement $createElement($ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override CountStreamProvider $copyWithCreate( @@ -225,8 +225,8 @@ final class CountNotifierProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$countNotifierHash() => r'a8dd7a66ee0002b8af657245c4affaa206fd99ec'; @@ -286,8 +286,8 @@ final class CountAsyncNotifierProvider @$internal @override $AsyncNotifierProviderElement $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); } String _$countAsyncNotifierHash() => @@ -348,8 +348,8 @@ final class CountStreamNotifierProvider @$internal @override $StreamNotifierProviderElement $createElement( - ProviderContainer container) => - $StreamNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $StreamNotifierProviderElement(this, pointer); } String _$countStreamNotifierHash() => @@ -409,8 +409,8 @@ final class Count2Provider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override Count2Provider $copyWithCreate( @@ -480,14 +480,14 @@ final class Count2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as Count2Provider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -533,8 +533,8 @@ final class CountFuture2Provider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override CountFuture2Provider $copyWithCreate( @@ -604,14 +604,14 @@ final class CountFuture2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as CountFuture2Provider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -657,8 +657,8 @@ final class CountStream2Provider @$internal @override - $StreamProviderElement $createElement(ProviderContainer container) => - $StreamProviderElement(this, container); + $StreamProviderElement $createElement($ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override CountStream2Provider $copyWithCreate( @@ -728,14 +728,14 @@ final class CountStream2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as CountStream2Provider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -811,8 +811,8 @@ final class CountNotifier2Provider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -855,14 +855,14 @@ final class CountNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as CountNotifier2Provider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -873,14 +873,14 @@ final class CountNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as CountNotifier2Provider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -962,8 +962,8 @@ final class CountAsyncNotifier2Provider @$internal @override $AsyncNotifierProviderElement $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -1007,14 +1007,14 @@ final class CountAsyncNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as CountAsyncNotifier2Provider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1027,14 +1027,14 @@ final class CountAsyncNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as CountAsyncNotifier2Provider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1117,8 +1117,8 @@ final class CountStreamNotifier2Provider @$internal @override $StreamNotifierProviderElement $createElement( - ProviderContainer container) => - $StreamNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $StreamNotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -1162,14 +1162,14 @@ final class CountStreamNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as CountStreamNotifier2Provider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1182,14 +1182,14 @@ final class CountStreamNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as CountStreamNotifier2Provider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index 34bdee5d6..ef1b42da3 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -106,7 +106,7 @@ ${provider.doc} final class ${provider.familyTypeName} extends Family { Override overrideWith($createType create,) { return \$FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ${provider.providerTypeName}; '''); @@ -117,7 +117,7 @@ Override overrideWith($createType create,) { )) { case (hasParameters: false, hasGenerics: false, _): buffer.writeln( - r'return provider.$copyWithCreate(create).$createElement(container);', + r'return provider.$copyWithCreate(create).$createElement(pointer);', ); case (hasParameters: true, hasGenerics: false, _): buffer.writeln(''' @@ -126,12 +126,12 @@ Override overrideWith($createType create,) { return provider.\$copyWithCreate(${switch (provider) { FunctionalProviderDeclaration() => '(ref) => create(ref, argument)', ClassBasedProviderDeclaration() => '() => create(argument)', - }}).\$createElement(container); + }}).\$createElement(pointer); '''); case (hasParameters: false, hasGenerics: true, _): buffer.writeln( - r'return provider._copyWithCreate(create).$createElement(container);', + r'return provider._copyWithCreate(create).$createElement(pointer);', ); case ( @@ -142,7 +142,7 @@ Override overrideWith($createType create,) { buffer.writeln(''' return provider._copyWithCreate($_genericsDefinition(ref, $_parameterDefinition) { return create(ref, ${provider.argumentToRecord()}); - }).\$createElement(container); + }).\$createElement(pointer); '''); case ( hasParameters: true, @@ -154,7 +154,7 @@ Override overrideWith($createType create,) { final argument = provider.argument$_argumentCast; return create(argument); - }).\$createElement(container); + }).\$createElement(pointer); '''); } @@ -184,7 +184,7 @@ ${provider.createdTypeDisplayString} Function$_genericsDefinition( Override overrideWithBuild($runNotifierBuildType build,) { return \$FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ${provider.providerTypeName}; '''); @@ -194,18 +194,18 @@ Override overrideWithBuild($runNotifierBuildType build,) { )) { case (hasParameters: false, hasGenerics: false): buffer.writeln( - r'return provider.$copyWithBuild(build).$createElement(container);', + r'return provider.$copyWithBuild(build).$createElement(pointer);', ); case (hasParameters: true, hasGenerics: false): buffer.writeln(''' final argument = provider.argument$_argumentCast; - return provider.\$copyWithBuild((ref, notifier) => build(ref, notifier, argument)).\$createElement(container); + return provider.\$copyWithBuild((ref, notifier) => build(ref, notifier, argument)).\$createElement(pointer); '''); case (hasParameters: false, hasGenerics: true): buffer.writeln( - r'return provider._copyWithBuild(build).$createElement(container);', + r'return provider._copyWithBuild(build).$createElement(pointer);', ); case (hasParameters: true, hasGenerics: true): @@ -214,7 +214,7 @@ Override overrideWithBuild($runNotifierBuildType build,) { final argument = provider.argument$_argumentCast; return build(ref, notifier, argument); - }).\$createElement(container); + }).\$createElement(pointer); '''); } diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 414c27f08..a0dec049f 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -164,8 +164,8 @@ ${provider.doc} final class $name$_genericsDefinition @\$internal @override ${provider.elementName}<${provider.valueTypeDisplayString}> \$createElement( - ProviderContainer container - ) => ${provider.elementName}(this, container); + \$ProviderPointer pointer + ) => ${provider.elementName}(this, pointer); @override ${provider.providerTypeName}$_generics \$copyWithCreate( @@ -213,8 +213,8 @@ ${provider.doc} final class $name$_genericsDefinition @\$internal @override ${provider.elementName}<$notifierType, ${provider.valueTypeDisplayString}> \$createElement( - ProviderContainer container - ) => ${provider.elementName}(this, container); + \$ProviderPointer pointer + ) => ${provider.elementName}(this, pointer); '''); } diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index a18deb4ed..c8931efeb 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -56,8 +56,8 @@ final class FunctionalProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FunctionalProvider $copyWithCreate( @@ -127,14 +127,14 @@ final class FunctionalFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FunctionalProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -212,8 +212,8 @@ final class ClassBasedProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -256,14 +256,14 @@ final class ClassBasedFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ClassBasedProvider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -274,14 +274,14 @@ final class ClassBasedFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ClassBasedProvider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -352,8 +352,8 @@ final class FamilyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FamilyProvider $copyWithCreate( @@ -423,14 +423,14 @@ final class FamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -475,8 +475,8 @@ final class NotCopiedFunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override NotCopiedFunctionalProvider $copyWithCreate( @@ -553,8 +553,8 @@ final class NotCopiedClassBasedProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$notCopiedClassBasedHash() => @@ -614,8 +614,8 @@ final class NotCopiedFamilyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override NotCopiedFamilyProvider $copyWithCreate( @@ -685,14 +685,14 @@ final class NotCopiedFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as NotCopiedFamilyProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index ff01b8e4f..58231d10e 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -53,8 +53,8 @@ final class GenericProvider @$internal @override - $FutureProviderElement> $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement> $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override GenericProvider $copyWithCreate( @@ -109,10 +109,10 @@ final class GenericFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GenericProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -193,8 +193,8 @@ final class GenericClassProvider @$internal @override $AsyncNotifierProviderElement, List> $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -235,10 +235,10 @@ final class GenericClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GenericClassProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -251,10 +251,10 @@ final class GenericClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GenericClassProvider; - return provider._copyWithBuild(build).$createElement(container); + return provider._copyWithBuild(build).$createElement(pointer); }, ); } @@ -298,8 +298,8 @@ final class PublicProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override PublicProvider $copyWithCreate( @@ -350,8 +350,8 @@ final class _PrivateProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override _PrivateProvider $copyWithCreate( @@ -411,8 +411,8 @@ final class FamilyOrProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override FamilyOrProvider $copyWithCreate( @@ -482,14 +482,14 @@ final class FamilyOrFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyOrProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -550,8 +550,8 @@ final class FamilyProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override FamilyProvider $copyWithCreate( @@ -657,7 +657,7 @@ final class FamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyProvider; final argument = provider.argument as ( @@ -670,7 +670,7 @@ final class FamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -724,8 +724,8 @@ final class PublicClassProvider @$internal @override $AsyncNotifierProviderElement $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); } String _$publicClassHash() => r'e9bc69e44b72e8ed77d423524c0d74ad460d629d'; @@ -785,8 +785,8 @@ final class _PrivateClassProvider @$internal @override $AsyncNotifierProviderElement<_PrivateClass, String> $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); } String _$privateClassHash() => r'7e69cffe8315999710e4cb6bb3de9f179d3f2f5d'; @@ -860,8 +860,8 @@ final class FamilyOrClassProvider @$internal @override $AsyncNotifierProviderElement $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -904,14 +904,14 @@ final class FamilyOrClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyOrClassProvider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -924,14 +924,14 @@ final class FamilyOrClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyOrClassProvider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1032,8 +1032,8 @@ final class FamilyClassProvider @$internal @override $AsyncNotifierProviderElement $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -1092,7 +1092,7 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyClassProvider; final argument = provider.argument as ( @@ -1105,7 +1105,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1126,7 +1126,7 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyClassProvider; final argument = provider.argument as ( @@ -1139,7 +1139,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index ef711fbca..dcaae6085 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -44,8 +44,8 @@ final class KeepAliveProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override KeepAliveProvider $copyWithCreate( @@ -103,8 +103,8 @@ final class NotKeepAliveProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override NotKeepAliveProvider $copyWithCreate( @@ -162,8 +162,8 @@ final class DefaultKeepAliveProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override DefaultKeepAliveProvider $copyWithCreate( @@ -230,8 +230,8 @@ final class KeepAliveFamilyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override KeepAliveFamilyProvider $copyWithCreate( @@ -301,14 +301,14 @@ final class KeepAliveFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as KeepAliveFamilyProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -361,8 +361,8 @@ final class NotKeepAliveFamilyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override NotKeepAliveFamilyProvider $copyWithCreate( @@ -433,14 +433,14 @@ final class NotKeepAliveFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as NotKeepAliveFamilyProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -493,8 +493,8 @@ final class DefaultKeepAliveFamilyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override DefaultKeepAliveFamilyProvider $copyWithCreate( @@ -566,14 +566,14 @@ final class DefaultKeepAliveFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as DefaultKeepAliveFamilyProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index 07e91ae9d..fe55a14b9 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -44,8 +44,8 @@ final class DepProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override DepProvider $copyWithCreate( @@ -112,8 +112,8 @@ final class FamilyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FamilyProvider $copyWithCreate( @@ -183,14 +183,14 @@ final class FamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -251,8 +251,8 @@ final class Dep2Provider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$dep2Hash() => r'2778537df77f6431148c2ce400724da3e2ab4b94'; @@ -333,8 +333,8 @@ final class Family2Provider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -377,14 +377,14 @@ final class Family2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as Family2Provider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -395,14 +395,14 @@ final class Family2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as Family2Provider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -475,8 +475,8 @@ final class ProviderProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ProviderProvider $copyWithCreate( @@ -549,8 +549,8 @@ final class Provider2Provider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override Provider2Provider $copyWithCreate( @@ -640,8 +640,8 @@ final class Provider3Provider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$provider3Hash() => r'dfdd6dec6cfee543c73d99593ce98d68f4db385c'; @@ -727,8 +727,8 @@ final class Provider4Provider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -781,14 +781,14 @@ final class Provider4Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as Provider4Provider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -799,14 +799,14 @@ final class Provider4Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as Provider4Provider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -880,8 +880,8 @@ final class TransitiveDependenciesProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override TransitiveDependenciesProvider $copyWithCreate( @@ -954,8 +954,8 @@ final class SmallTransitiveDependencyCountProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override SmallTransitiveDependencyCountProvider $copyWithCreate( @@ -1016,8 +1016,8 @@ final class EmptyDependenciesFunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override EmptyDependenciesFunctionalProvider $copyWithCreate( @@ -1098,8 +1098,8 @@ final class EmptyDependenciesClassBasedProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$emptyDependenciesClassBasedHash() => @@ -1160,8 +1160,8 @@ final class ProviderWithDependenciesProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ProviderWithDependenciesProvider $copyWithCreate( @@ -1220,8 +1220,8 @@ final class _PrivateDepProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override _PrivateDepProvider $copyWithCreate( @@ -1279,8 +1279,8 @@ final class PublicDepProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override PublicDepProvider $copyWithCreate( @@ -1344,8 +1344,8 @@ final class DuplicateDependenciesProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override DuplicateDependenciesProvider $copyWithCreate( @@ -1413,8 +1413,8 @@ final class DuplicateDependencies2Provider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override DuplicateDependencies2Provider $copyWithCreate( @@ -1496,8 +1496,8 @@ final class TransitiveDuplicateDependenciesProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override TransitiveDuplicateDependenciesProvider $copyWithCreate( diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index c102e5359..f5102b835 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -63,8 +63,8 @@ final class ProviderWithDependencies2Provider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ProviderWithDependencies2Provider $copyWithCreate( @@ -141,8 +141,8 @@ final class FamilyWithDependencies2Provider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FamilyWithDependencies2Provider $copyWithCreate( @@ -224,14 +224,14 @@ final class FamilyWithDependencies2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyWithDependencies2Provider; final argument = provider.argument as int?; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -313,8 +313,8 @@ final class NotifierWithDependenciesProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$notifierWithDependenciesHash() => @@ -407,8 +407,8 @@ final class NotifierFamilyWithDependenciesProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -463,14 +463,14 @@ final class NotifierFamilyWithDependenciesFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as NotifierFamilyWithDependenciesProvider; final argument = provider.argument as int?; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -483,14 +483,14 @@ final class NotifierFamilyWithDependenciesFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as NotifierFamilyWithDependenciesProvider; final argument = provider.argument as int?; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -548,8 +548,8 @@ final class _Private2Provider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override _Private2Provider $copyWithCreate( @@ -607,8 +607,8 @@ final class Public2Provider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override Public2Provider $copyWithCreate( diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index 38a0671e7..7d7131f8c 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -52,8 +52,8 @@ final class FunctionalProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FunctionalProvider $copyWithCreate( @@ -134,8 +134,8 @@ final class ClassBasedProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$classBasedHash() => r'f1139017b1fcf38017402b514c61fb32dae40c39'; @@ -202,8 +202,8 @@ final class FamilyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FamilyProvider $copyWithCreate( @@ -277,14 +277,14 @@ final class FamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -366,8 +366,8 @@ final class ClassFamilyBasedProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -414,14 +414,14 @@ final class ClassFamilyBasedFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ClassFamilyBasedProvider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -433,14 +433,14 @@ final class ClassFamilyBasedFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ClassFamilyBasedProvider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 02dd815e8..1069dd857 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -44,8 +44,8 @@ final class GeneratedProvider extends $FunctionalProvider<_Test, _Test> @$internal @override - $ProviderElement<_Test> $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement<_Test> $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override GeneratedProvider $copyWithCreate( @@ -112,8 +112,8 @@ final class GeneratedFamilyProvider extends $FunctionalProvider<_Test, _Test> @$internal @override - $ProviderElement<_Test> $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement<_Test> $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override GeneratedFamilyProvider $copyWithCreate( @@ -183,14 +183,14 @@ final class GeneratedFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GeneratedFamilyProvider; final argument = provider.argument as _Test; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -252,8 +252,8 @@ final class GeneratedClassProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$generatedClassHash() => r'984153f97e25de687d2f19756b277aabd56f6e72'; @@ -335,8 +335,8 @@ final class GeneratedClassFamilyProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -380,14 +380,14 @@ final class GeneratedClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GeneratedClassFamilyProvider; final argument = provider.argument as _Test; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -400,14 +400,14 @@ final class GeneratedClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GeneratedClassFamilyProvider; final argument = provider.argument as _Test; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -465,8 +465,8 @@ final class $DynamicProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override $DynamicProvider $copyWithCreate( @@ -533,8 +533,8 @@ final class $DynamicFamilyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override $DynamicFamilyProvider $copyWithCreate( @@ -604,14 +604,14 @@ final class $DynamicFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as $DynamicFamilyProvider; final argument = provider.argument as dynamic; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -673,8 +673,8 @@ final class $DynamicClassProvider @$internal @override $NotifierProviderElement<$DynamicClass, Object?> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$$dynamicClassHash() => r'c6d8e5191c3f060df3ce3eee66107433fd4c3292'; @@ -756,8 +756,8 @@ final class $DynamicClassFamilyProvider @$internal @override $NotifierProviderElement<$DynamicClassFamily, Object?> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -801,14 +801,14 @@ final class $DynamicClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as $DynamicClassFamilyProvider; final argument = provider.argument as dynamic; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -821,14 +821,14 @@ final class $DynamicClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as $DynamicClassFamilyProvider; final argument = provider.argument as dynamic; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -895,8 +895,8 @@ final class _DynamicProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override _DynamicProvider $copyWithCreate( @@ -966,14 +966,14 @@ final class _DynamicFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as _DynamicProvider; final argument = provider.argument as dynamic; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1019,8 +1019,8 @@ final class AliasProvider @$internal @override $ProviderElement> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderPointer pointer) => + $ProviderElement(this, pointer); @override AliasProvider $copyWithCreate( @@ -1089,8 +1089,8 @@ final class AliasFamilyProvider @$internal @override $ProviderElement> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderPointer pointer) => + $ProviderElement(this, pointer); @override AliasFamilyProvider $copyWithCreate( @@ -1160,14 +1160,14 @@ final class AliasFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as AliasFamilyProvider; final argument = provider.argument as r.AsyncValue; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1229,8 +1229,8 @@ final class AliasClassProvider @$internal @override $NotifierProviderElement> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$aliasClassHash() => r'a6c6d7594ebd09ba728e42d79b12af560d09c379'; @@ -1312,8 +1312,8 @@ final class AliasClassFamilyProvider @$internal @override $NotifierProviderElement> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -1356,14 +1356,14 @@ final class AliasClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as AliasClassFamilyProvider; final argument = provider.argument as r.AsyncValue; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1376,14 +1376,14 @@ final class AliasClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as AliasClassFamilyProvider; final argument = provider.argument as r.AsyncValue; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index 28bbfd967..5cbd372e0 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -44,8 +44,8 @@ final class SimpleProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override SimpleProvider $copyWithCreate( @@ -103,8 +103,8 @@ final class Simple2Provider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override Simple2Provider $copyWithCreate( @@ -179,8 +179,8 @@ final class SimpleClassProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$simpleClassHash() => r'958123cd6179c5b88da040cfeb71eb3061765277'; diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index e8c77d3a1..5c8c2e63e 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -61,8 +61,8 @@ final class ScopedClassProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$scopedClassHash() => r'113acc46a2e61abfeb61cf4b89a1dc555e915793'; @@ -144,8 +144,8 @@ final class ScopedClassFamilyProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -188,14 +188,14 @@ final class ScopedClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ScopedClassFamilyProvider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -206,14 +206,14 @@ final class ScopedClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ScopedClassFamilyProvider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index 8d6340b09..adf1cb3d6 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -44,8 +44,8 @@ final class Counter2Provider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override Counter2Provider $copyWithCreate( @@ -103,8 +103,8 @@ final class CounterProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CounterProvider $copyWithCreate( diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 0c5cd4284..d765dcb95 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -53,8 +53,8 @@ final class GenericProvider @$internal @override - $StreamProviderElement> $createElement(ProviderContainer container) => - $StreamProviderElement(this, container); + $StreamProviderElement> $createElement($ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override GenericProvider $copyWithCreate( @@ -109,10 +109,10 @@ final class GenericFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GenericProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -193,8 +193,8 @@ final class GenericClassProvider @$internal @override $StreamNotifierProviderElement, List> $createElement( - ProviderContainer container) => - $StreamNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $StreamNotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -235,10 +235,10 @@ final class GenericClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GenericClassProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -251,10 +251,10 @@ final class GenericClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GenericClassProvider; - return provider._copyWithBuild(build).$createElement(container); + return provider._copyWithBuild(build).$createElement(pointer); }, ); } @@ -298,8 +298,8 @@ final class PublicProvider @$internal @override - $StreamProviderElement $createElement(ProviderContainer container) => - $StreamProviderElement(this, container); + $StreamProviderElement $createElement($ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override PublicProvider $copyWithCreate( @@ -350,8 +350,8 @@ final class _PrivateProvider @$internal @override - $StreamProviderElement $createElement(ProviderContainer container) => - $StreamProviderElement(this, container); + $StreamProviderElement $createElement($ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override _PrivateProvider $copyWithCreate( @@ -426,8 +426,8 @@ final class FamilyProvider @$internal @override - $StreamProviderElement $createElement(ProviderContainer container) => - $StreamProviderElement(this, container); + $StreamProviderElement $createElement($ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override FamilyProvider $copyWithCreate( @@ -533,7 +533,7 @@ final class FamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyProvider; final argument = provider.argument as ( @@ -546,7 +546,7 @@ final class FamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -600,8 +600,8 @@ final class PublicClassProvider @$internal @override $StreamNotifierProviderElement $createElement( - ProviderContainer container) => - $StreamNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $StreamNotifierProviderElement(this, pointer); } String _$publicClassHash() => r'b1526943c8ff0aaa20642bf78e744e5833cf9d02'; @@ -661,8 +661,8 @@ final class _PrivateClassProvider @$internal @override $StreamNotifierProviderElement<_PrivateClass, String> $createElement( - ProviderContainer container) => - $StreamNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $StreamNotifierProviderElement(this, pointer); } String _$privateClassHash() => r'8c0d52b7ab79c0546d0c84c011bb3512609e029e'; @@ -755,8 +755,8 @@ final class FamilyClassProvider @$internal @override $StreamNotifierProviderElement $createElement( - ProviderContainer container) => - $StreamNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $StreamNotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -815,7 +815,7 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyClassProvider; final argument = provider.argument as ( @@ -828,7 +828,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -849,7 +849,7 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyClassProvider; final argument = provider.argument as ( @@ -862,7 +862,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index d5c8b1286..f9823ddf5 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -61,8 +61,8 @@ final class GenericProvider @$internal @override - $ProviderElement> $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement> $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override GenericProvider $copyWithCreate( @@ -117,10 +117,10 @@ final class GenericFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GenericProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -196,8 +196,8 @@ final class ComplexGenericProvider @$internal @override - $ProviderElement> $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement> $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ComplexGenericProvider $copyWithCreate( @@ -284,7 +284,7 @@ final class ComplexGenericFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ComplexGenericProvider; return provider._copyWithCreate(( @@ -296,7 +296,7 @@ final class ComplexGenericFamily extends Family { param: param, otherParam: otherParam, )); - }).$createElement(container); + }).$createElement(pointer); }, ); } @@ -385,8 +385,8 @@ final class GenericClassProvider @$internal @override $NotifierProviderElement, List> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -427,10 +427,10 @@ final class GenericClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GenericClassProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -442,10 +442,10 @@ final class GenericClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GenericClassProvider; - return provider._copyWithBuild(build).$createElement(container); + return provider._copyWithBuild(build).$createElement(pointer); }, ); } @@ -498,8 +498,8 @@ final class RawFutureProvider @$internal @override $ProviderElement>> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RawFutureProvider $copyWithCreate( @@ -559,8 +559,8 @@ final class RawStreamProvider @$internal @override $ProviderElement>> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RawStreamProvider $copyWithCreate( @@ -636,8 +636,8 @@ final class RawFutureClassProvider @$internal @override $NotifierProviderElement>> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$rawFutureClassHash() => r'bf66f1cdbd99118b8845d206e6a2611b3101f45c'; @@ -705,8 +705,8 @@ final class RawStreamClassProvider @$internal @override $NotifierProviderElement>> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$rawStreamClassHash() => r'712cffcb2018cfb4ff45012c1aa6e43c8cbe9d5d'; @@ -767,8 +767,8 @@ final class RawFamilyFutureProvider @$internal @override $ProviderElement>> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RawFamilyFutureProvider $copyWithCreate( @@ -838,14 +838,14 @@ final class RawFamilyFutureFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as RawFamilyFutureProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -900,8 +900,8 @@ final class RawFamilyStreamProvider @$internal @override $ProviderElement>> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RawFamilyStreamProvider $copyWithCreate( @@ -971,14 +971,14 @@ final class RawFamilyStreamFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as RawFamilyStreamProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1054,8 +1054,8 @@ final class RawFamilyFutureClassProvider @$internal @override $NotifierProviderElement>> - $createElement(ProviderContainer container) => - $NotifierProviderElement(this, container); + $createElement($ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -1099,14 +1099,14 @@ final class RawFamilyFutureClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as RawFamilyFutureClassProvider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1119,14 +1119,14 @@ final class RawFamilyFutureClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as RawFamilyFutureClassProvider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1216,8 +1216,8 @@ final class RawFamilyStreamClassProvider @$internal @override $NotifierProviderElement>> - $createElement(ProviderContainer container) => - $NotifierProviderElement(this, container); + $createElement($ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -1261,14 +1261,14 @@ final class RawFamilyStreamClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as RawFamilyStreamClassProvider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1281,14 +1281,14 @@ final class RawFamilyStreamClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as RawFamilyStreamClassProvider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1350,8 +1350,8 @@ final class PublicProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override PublicProvider $copyWithCreate( @@ -1409,8 +1409,8 @@ final class Supports$inNamesProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override Supports$inNamesProvider $copyWithCreate( @@ -1496,8 +1496,8 @@ final class FamilyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FamilyProvider $copyWithCreate( @@ -1605,7 +1605,7 @@ final class FamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyProvider; final argument = provider.argument as ( @@ -1618,7 +1618,7 @@ final class FamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1662,8 +1662,8 @@ final class _PrivateProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override _PrivateProvider $copyWithCreate( @@ -1741,8 +1741,8 @@ final class PublicClassProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$publicClassHash() => r'd261f9eb927ca71440a5e1bdb24558c25fae4833'; @@ -1810,8 +1810,8 @@ final class _PrivateClassProvider @$internal @override $NotifierProviderElement<_PrivateClass, String> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$privateClassHash() => r'796e16abb79d7ad77728f9288d24566e429643f2'; @@ -1914,8 +1914,8 @@ final class FamilyClassProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -1976,7 +1976,7 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyClassProvider; final argument = provider.argument as ( @@ -1989,7 +1989,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -2010,7 +2010,7 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyClassProvider; final argument = provider.argument as ( @@ -2023,7 +2023,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -2116,8 +2116,8 @@ final class Supports$InFnNameProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override Supports$InFnNameProvider $copyWithCreate( @@ -2174,10 +2174,10 @@ final class Supports$InFnNameFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as Supports$InFnNameProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -2258,8 +2258,8 @@ final class Supports$InFnNameFamilyProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override Supports$InFnNameFamilyProvider $copyWithCreate( @@ -2354,7 +2354,7 @@ final class Supports$InFnNameFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as Supports$InFnNameFamilyProvider; return provider._copyWithCreate(( @@ -2368,7 +2368,7 @@ final class Supports$InFnNameFamilyFamily extends Family { named$arg: named$arg, defaultArg: defaultArg, )); - }).$createElement(container); + }).$createElement(pointer); }, ); } @@ -2460,8 +2460,8 @@ final class Supports$InClassNameProvider @$internal @override $NotifierProviderElement, String> - $createElement(ProviderContainer container) => - $NotifierProviderElement(this, container); + $createElement($ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -2503,10 +2503,10 @@ final class Supports$InClassNameFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as Supports$InClassNameProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -2519,10 +2519,10 @@ final class Supports$InClassNameFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as Supports$InClassNameProvider; - return provider._copyWithBuild(build).$createElement(container); + return provider._copyWithBuild(build).$createElement(pointer); }, ); } @@ -2648,8 +2648,8 @@ final class Supports$InClassFamilyNameProvider @$internal @override $NotifierProviderElement, String> - $createElement(ProviderContainer container) => - $NotifierProviderElement(this, container); + $createElement($ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -2705,7 +2705,7 @@ final class Supports$InClassFamilyNameFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as Supports$InClassFamilyNameProvider; return provider._copyWithCreate(() { @@ -2716,7 +2716,7 @@ final class Supports$InClassFamilyNameFamily extends Family { }); return create(argument); - }).$createElement(container); + }).$createElement(pointer); }, ); } @@ -2735,7 +2735,7 @@ final class Supports$InClassFamilyNameFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as Supports$InClassFamilyNameProvider; return provider._copyWithBuild((ref, notifier) { @@ -2746,7 +2746,7 @@ final class Supports$InClassFamilyNameFamily extends Family { }); return build(ref, notifier, argument); - }).$createElement(container); + }).$createElement(pointer); }, ); } @@ -2814,8 +2814,8 @@ final class GeneratedProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override GeneratedProvider $copyWithCreate( @@ -2882,8 +2882,8 @@ final class UnnecessaryCastProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override UnnecessaryCastProvider $copyWithCreate( @@ -2953,14 +2953,14 @@ final class UnnecessaryCastFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as UnnecessaryCastProvider; final argument = provider.argument; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -3036,8 +3036,8 @@ final class UnnecessaryCastClassProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -3081,14 +3081,14 @@ final class UnnecessaryCastClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as UnnecessaryCastClassProvider; final argument = provider.argument; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -3101,14 +3101,14 @@ final class UnnecessaryCastClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as UnnecessaryCastClassProvider; final argument = provider.argument; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -3183,8 +3183,8 @@ final class ManyDataStreamProvider @$internal @override - $StreamProviderElement> $createElement(ProviderContainer container) => - $StreamProviderElement(this, container); + $StreamProviderElement> $createElement($ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override ManyDataStreamProvider $copyWithCreate( @@ -3256,7 +3256,7 @@ final class ManyDataStreamFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ManyDataStreamProvider; return provider._copyWithCreate(( @@ -3264,7 +3264,7 @@ final class ManyDataStreamFamily extends Family { ManyProviderData pData, ) { return create(ref, pData); - }).$createElement(container); + }).$createElement(pointer); }, ); } diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index e41fd73d7..486c545c8 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -48,8 +48,8 @@ final class PublicProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override PublicProvider $copyWithCreate( @@ -111,8 +111,8 @@ final class Supports$inNamesProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override Supports$inNamesProvider $copyWithCreate( @@ -198,8 +198,8 @@ final class FamilyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FamilyProvider $copyWithCreate( @@ -307,7 +307,7 @@ final class FamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyProvider; final argument = provider.argument as ( @@ -320,7 +320,7 @@ final class FamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -364,8 +364,8 @@ final class _PrivateProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override _PrivateProvider $copyWithCreate( @@ -443,8 +443,8 @@ final class PublicClassProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$publicClassHash() => r'c27eae39f455b986e570abb84f1471de7445ef3b'; @@ -512,8 +512,8 @@ final class _PrivateClassProvider @$internal @override $NotifierProviderElement<_PrivateClass, String> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$privateClassHash() => r'3b08af72c6d4f24aed264efcf181572525b75603'; @@ -616,8 +616,8 @@ final class FamilyClassProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -678,7 +678,7 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyClassProvider; final argument = provider.argument as ( @@ -691,7 +691,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -712,7 +712,7 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyClassProvider; final argument = provider.argument as ( @@ -725,7 +725,7 @@ final class FamilyClassFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -822,8 +822,8 @@ final class Supports$InClassNameProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$supports$InClassNameHash() => diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index 87ea2f25b..6c93d9b3a 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -64,8 +64,8 @@ final class ExampleProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$exampleHash() => r'081776126bafed3e1583bba9c1fadef798215ad7'; @@ -160,8 +160,8 @@ final class ExampleFamilyProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -213,7 +213,7 @@ final class ExampleFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ExampleFamilyProvider; final argument = provider.argument as ({ @@ -223,7 +223,7 @@ final class ExampleFamilyFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -241,7 +241,7 @@ final class ExampleFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ExampleFamilyProvider; final argument = provider.argument as ({ @@ -251,7 +251,7 @@ final class ExampleFamilyFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -360,8 +360,8 @@ final class GenericProvider @$internal @override $NotifierProviderElement, int> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -401,10 +401,10 @@ final class GenericFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GenericProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -415,10 +415,10 @@ final class GenericFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GenericProvider; - return provider._copyWithBuild(build).$createElement(container); + return provider._copyWithBuild(build).$createElement(pointer); }, ); } diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index c7f65123d..fdb38120f 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -48,8 +48,8 @@ final class ExampleProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( @@ -126,8 +126,8 @@ final class ExampleFamilyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ExampleFamilyProvider $copyWithCreate( @@ -214,7 +214,7 @@ final class ExampleFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ExampleFamilyProvider; final argument = provider.argument as ({ @@ -224,7 +224,7 @@ final class ExampleFamilyFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 155715e30..1895adefc 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -59,8 +59,8 @@ final class FnProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FnProvider $copyWithCreate( @@ -145,7 +145,7 @@ final class FnFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FnProvider; final argument = provider.argument as ( @@ -155,7 +155,7 @@ final class FnFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -240,8 +240,8 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -291,7 +291,7 @@ final class MyNotifierFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as MyNotifierProvider; final argument = provider.argument as ( @@ -301,7 +301,7 @@ final class MyNotifierFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -319,7 +319,7 @@ final class MyNotifierFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as MyNotifierProvider; final argument = provider.argument as ( @@ -329,7 +329,7 @@ final class MyNotifierFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -413,8 +413,8 @@ final class Regresion2959Provider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$regresion2959Hash() => r'bcf9a829ce75026a78569de680451d157c7d90a2'; diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index 6fb430fa5..c866b556d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -76,8 +76,8 @@ final class GeneratedNotifierProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -120,14 +120,14 @@ final class GeneratedNotifierFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GeneratedNotifierProvider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -138,14 +138,14 @@ final class GeneratedNotifierFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GeneratedNotifierProvider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 54d167633..063cfc520 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -44,8 +44,8 @@ final class NamelessProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override NamelessProvider $copyWithCreate( @@ -120,8 +120,8 @@ final class GenericsProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override GenericsProvider $copyWithCreate( @@ -178,10 +178,10 @@ final class GenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GenericsProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -242,8 +242,8 @@ final class NoGenericsProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override NoGenericsProvider $copyWithCreate( @@ -300,10 +300,10 @@ final class NoGenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as NoGenericsProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -363,8 +363,8 @@ final class MissingGenericsProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override MissingGenericsProvider $copyWithCreate( @@ -421,10 +421,10 @@ final class MissingGenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as MissingGenericsProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -484,8 +484,8 @@ final class WrongOrderProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override WrongOrderProvider $copyWithCreate( @@ -542,10 +542,10 @@ final class WrongOrderFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as WrongOrderProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart index d648120df..096a36980 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart @@ -61,8 +61,8 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$myNotifierHash() => r'58f5439a3b1036ba7804f63a5a6ebe0114125039'; @@ -129,8 +129,8 @@ final class NoExtendsProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$noExtendsHash() => r'3f1276999a9a6d3676c628c25ed853cbefb21ce9'; @@ -197,8 +197,8 @@ final class WrongExtendsProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$wrongExtendsHash() => r'6479055793af10a34e225373a67f7eaac4d7c0de'; @@ -266,8 +266,8 @@ final class _PrivateClassProvider @$internal @override $NotifierProviderElement<_PrivateClass, String> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$privateClassHash() => r'ba68a29a609566bb8bc0792391f842762356e124'; @@ -362,8 +362,8 @@ final class GenericsProvider @$internal @override $NotifierProviderElement, int> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -404,10 +404,10 @@ final class GenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GenericsProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -418,10 +418,10 @@ final class GenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GenericsProvider; - return provider._copyWithBuild(build).$createElement(container); + return provider._copyWithBuild(build).$createElement(pointer); }, ); } @@ -517,8 +517,8 @@ final class NoGenericsProvider @$internal @override $NotifierProviderElement, int> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -559,10 +559,10 @@ final class NoGenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as NoGenericsProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -574,10 +574,10 @@ final class NoGenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as NoGenericsProvider; - return provider._copyWithBuild(build).$createElement(container); + return provider._copyWithBuild(build).$createElement(pointer); }, ); } @@ -675,8 +675,8 @@ final class MissingGenericsProvider @$internal @override $NotifierProviderElement, int> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -717,10 +717,10 @@ final class MissingGenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as MissingGenericsProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -731,10 +731,10 @@ final class MissingGenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as MissingGenericsProvider; - return provider._copyWithBuild(build).$createElement(container); + return provider._copyWithBuild(build).$createElement(pointer); }, ); } @@ -830,8 +830,8 @@ final class WrongOrderProvider @$internal @override $NotifierProviderElement, int> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -872,10 +872,10 @@ final class WrongOrderFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as WrongOrderProvider; - return provider._copyWithCreate(create).$createElement(container); + return provider._copyWithCreate(create).$createElement(pointer); }, ); } @@ -886,10 +886,10 @@ final class WrongOrderFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as WrongOrderProvider; - return provider._copyWithBuild(build).$createElement(container); + return provider._copyWithBuild(build).$createElement(pointer); }, ); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart index 2c7c5ba80..1688bdb84 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart @@ -44,8 +44,8 @@ final class KeepAliveProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override KeepAliveProvider $copyWithCreate( @@ -121,8 +121,8 @@ final class KeepAliveClassProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$keepAliveClassHash() => r'e2fffa4d14837dfef71f6a2cc230b826b82541ea'; @@ -172,8 +172,8 @@ final class AutoDisposeProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override AutoDisposeProvider $copyWithCreate( @@ -249,8 +249,8 @@ final class AutoDisposeClassProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$autoDisposeClassHash() => r'5127ab94f7ab4ccf90deb3fca90d7a3c3c4c83f5'; @@ -300,8 +300,8 @@ final class FnProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FnProvider $copyWithCreate( diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index a4b79dace..f64001270 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -59,9 +59,8 @@ final class AProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $NotifierProviderElement $createElement($ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$aHash() => r'9bf449b010f4dd5800e78f9f5b8a431b1a79c8b7'; @@ -126,9 +125,8 @@ final class A2Provider extends $NotifierProvider { @$internal @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $NotifierProviderElement $createElement($ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$a2Hash() => r'898d46cbcec03233c7b8b0754810a6903226aa2e'; @@ -206,9 +204,8 @@ final class A3Provider extends $NotifierProvider { @$internal @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $NotifierProviderElement $createElement($ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -251,14 +248,14 @@ final class A3Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as A3Provider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -269,14 +266,14 @@ final class A3Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as A3Provider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -362,9 +359,8 @@ final class A4Provider extends $NotifierProvider { @$internal @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $NotifierProviderElement $createElement($ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -407,14 +403,14 @@ final class A4Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as A4Provider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -425,14 +421,14 @@ final class A4Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as A4Provider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -511,8 +507,8 @@ final class A5Provider extends $AsyncNotifierProvider { @$internal @override $AsyncNotifierProviderElement $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -555,14 +551,14 @@ final class A5Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as A5Provider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -574,14 +570,14 @@ final class A5Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as A5Provider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -660,8 +656,8 @@ final class A6Provider extends $AsyncNotifierProvider { @$internal @override $AsyncNotifierProviderElement $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -704,14 +700,14 @@ final class A6Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as A6Provider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -723,14 +719,14 @@ final class A6Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as A6Provider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -809,8 +805,8 @@ final class A7Provider extends $StreamNotifierProvider { @$internal @override $StreamNotifierProviderElement $createElement( - ProviderContainer container) => - $StreamNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $StreamNotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -853,14 +849,14 @@ final class A7Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as A7Provider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -872,14 +868,14 @@ final class A7Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as A7Provider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -958,8 +954,8 @@ final class A8Provider extends $StreamNotifierProvider { @$internal @override $StreamNotifierProviderElement $createElement( - ProviderContainer container) => - $StreamNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $StreamNotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -1002,14 +998,14 @@ final class A8Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as A8Provider; final argument = provider.argument as int; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1021,14 +1017,14 @@ final class A8Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as A8Provider; final argument = provider.argument as int; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1101,9 +1097,8 @@ final class BProvider extends $NotifierProvider { @$internal @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $NotifierProviderElement $createElement($ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$bHash() => r'44288285e9c28f846d609ba892520f577ecf7867'; @@ -1168,9 +1163,8 @@ final class B2Provider extends $NotifierProvider { @$internal @override - $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $NotifierProviderElement $createElement($ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$b2Hash() => r'292925c285c6975ed6585d541c5a9ae18977d73c'; diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart index a51582bb3..4d7d226ce 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart @@ -44,8 +44,8 @@ final class BProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override BProvider $copyWithCreate( @@ -103,8 +103,8 @@ final class AnotherScopedProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override AnotherScopedProvider $copyWithCreate( @@ -166,8 +166,8 @@ final class AnotherNonEmptyScopedProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override AnotherNonEmptyScopedProvider $copyWithCreate( diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart index ada784e5f..eb1a0a8a9 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart @@ -44,8 +44,8 @@ final class DepProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override DepProvider $copyWithCreate( @@ -107,8 +107,8 @@ final class TransitiveDepProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override TransitiveDepProvider $copyWithCreate( @@ -166,8 +166,8 @@ final class Dep2Provider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override Dep2Provider $copyWithCreate( @@ -234,8 +234,8 @@ final class DepFamilyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override DepFamilyProvider $copyWithCreate( @@ -305,14 +305,14 @@ final class DepFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as DepFamilyProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -364,8 +364,8 @@ final class PlainAnnotationProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override PlainAnnotationProvider $copyWithCreate( @@ -423,8 +423,8 @@ final class CustomAnnotationProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CustomAnnotationProvider $copyWithCreate( @@ -485,8 +485,8 @@ final class CustomAnnotationWithTrailingCommaProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CustomAnnotationWithTrailingCommaProvider $copyWithCreate( @@ -545,8 +545,8 @@ final class ExistingDepProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ExistingDepProvider $copyWithCreate( @@ -604,8 +604,8 @@ final class MultipleDepsProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override MultipleDepsProvider $copyWithCreate( @@ -671,8 +671,8 @@ final class ProviderWithDartDocProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ProviderWithDartDocProvider $copyWithCreate( diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart index 8be01020e..bdb43a8b0 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart @@ -44,8 +44,8 @@ final class DepProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override DepProvider $copyWithCreate( @@ -103,8 +103,8 @@ final class GeneratedScopedProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override GeneratedScopedProvider $copyWithCreate( @@ -162,8 +162,8 @@ final class GeneratedRootProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override GeneratedRootProvider $copyWithCreate( @@ -223,8 +223,8 @@ final class WatchScopedButNoDependenciesProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override WatchScopedButNoDependenciesProvider $copyWithCreate( @@ -286,8 +286,8 @@ final class WatchGeneratedScopedButNoDependenciesProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override WatchGeneratedScopedButNoDependenciesProvider $copyWithCreate( @@ -348,8 +348,8 @@ final class WatchRootButNoDependenciesProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override WatchRootButNoDependenciesProvider $copyWithCreate( @@ -411,8 +411,8 @@ final class WatchGeneratedRootButNoDependenciesProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override WatchGeneratedRootButNoDependenciesProvider $copyWithCreate( @@ -473,8 +473,8 @@ final class WatchScopedButEmptyDependenciesProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override WatchScopedButEmptyDependenciesProvider $copyWithCreate( @@ -536,8 +536,8 @@ final class WatchGeneratedScopedButEmptyDependenciesProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override WatchGeneratedScopedButEmptyDependenciesProvider $copyWithCreate( @@ -598,8 +598,8 @@ final class WatchRootButEmptyDependenciesProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override WatchRootButEmptyDependenciesProvider $copyWithCreate( @@ -661,8 +661,8 @@ final class WatchGeneratedRootButEmptyDependenciesProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override WatchGeneratedRootButEmptyDependenciesProvider $copyWithCreate( @@ -729,8 +729,8 @@ final class WatchGeneratedScopedAndContainsDependencyProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override WatchGeneratedScopedAndContainsDependencyProvider $copyWithCreate( @@ -814,8 +814,8 @@ final class ClassWatchGeneratedRootButMissingDependenciesProvider @$internal @override $NotifierProviderElement - $createElement(ProviderContainer container) => - $NotifierProviderElement(this, container); + $createElement($ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$classWatchGeneratedRootButMissingDependenciesHash() => @@ -871,8 +871,8 @@ final class Regression2348Provider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override Regression2348Provider $copyWithCreate( @@ -952,8 +952,8 @@ final class Regression2417Provider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$regression2417Hash() => r'c9ac0ba44e849ea1460c79c1f676feba1b5400da'; @@ -1014,8 +1014,8 @@ final class FamilyDepProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FamilyDepProvider $copyWithCreate( @@ -1087,14 +1087,14 @@ final class FamilyDepFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyDepProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1151,8 +1151,8 @@ final class FamilyDep2Provider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FamilyDep2Provider $copyWithCreate( @@ -1225,14 +1225,14 @@ final class FamilyDep2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FamilyDep2Provider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -1276,8 +1276,8 @@ final class AliasProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override AliasProvider $copyWithCreate( @@ -1352,8 +1352,8 @@ final class AliasClassProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$aliasClassHash() => r'f5c1f43e7541638274ca7dc334a713763c9c8071'; @@ -1425,8 +1425,8 @@ final class RiverpodDependenciesProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$riverpodDependenciesHash() => @@ -1477,8 +1477,8 @@ final class FooProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FooProvider $copyWithCreate( @@ -1536,8 +1536,8 @@ final class CrossFileDependencyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CrossFileDependencyProvider $copyWithCreate( diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart index 76c293ef8..18acd29fa 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart @@ -44,8 +44,8 @@ final class RootProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RootProvider $copyWithCreate( @@ -103,8 +103,8 @@ final class DepProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override DepProvider $copyWithCreate( @@ -162,8 +162,8 @@ final class Dep2Provider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override Dep2Provider $copyWithCreate( @@ -231,8 +231,8 @@ final class ExtraDepProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ExtraDepProvider $copyWithCreate( @@ -294,8 +294,8 @@ final class NoDepProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override NoDepProvider $copyWithCreate( @@ -359,8 +359,8 @@ final class DependenciesFirstThenKeepAliveProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override DependenciesFirstThenKeepAliveProvider $copyWithCreate( @@ -423,8 +423,8 @@ final class NoDepNoParamProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override NoDepNoParamProvider $copyWithCreate( @@ -486,8 +486,8 @@ final class NoDepWithoutCommaProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override NoDepWithoutCommaProvider $copyWithCreate( @@ -549,8 +549,8 @@ final class RootDepProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RootDepProvider $copyWithCreate( diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 09f56f89b..11870007b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -53,8 +53,8 @@ final class GeneratorProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override GeneratorProvider $copyWithCreate( @@ -124,14 +124,14 @@ final class GeneratorFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as GeneratorProvider; final argument = provider.argument; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart index cac255ada..55f4712a4 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart @@ -62,8 +62,8 @@ final class UnimplementedScopedProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$unimplementedScopedHash() => @@ -114,8 +114,8 @@ final class ScopedProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ScopedProvider $copyWithCreate( @@ -173,8 +173,8 @@ final class RootProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RootProvider $copyWithCreate( diff --git a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart index 05e7e9945..039f3aba2 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart @@ -44,8 +44,8 @@ final class ScopedProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ScopedProvider $copyWithCreate( @@ -103,8 +103,8 @@ final class RootProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RootProvider $copyWithCreate( diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart index 3abdda32e..c2ea21a9d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart @@ -44,8 +44,8 @@ final class IntegerProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override IntegerProvider $copyWithCreate( @@ -104,9 +104,8 @@ final class StateNotifierProvider @$internal @override - $ProviderElement $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override StateNotifierProvider $copyWithCreate( @@ -160,8 +159,8 @@ final class AsyncStateNotifierProvider extends $FunctionalProvider< @$internal @override $FutureProviderElement $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override AsyncStateNotifierProvider $copyWithCreate( @@ -238,8 +237,8 @@ final class StateNotifierClassProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$stateNotifierClassHash() => @@ -286,8 +285,8 @@ final class StateNotifierAsyncProvider extends $FunctionalProvider< @$internal @override $FutureProviderElement $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override StateNotifierAsyncProvider $copyWithCreate( @@ -356,8 +355,8 @@ final class SelfNotifierProvider @$internal @override $AsyncNotifierProviderElement $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); } String _$selfNotifierHash() => r'5a857f5c92a9b7a35daa4e527bd333cf3d8d19ac'; @@ -425,8 +424,8 @@ final class SyncSelfNotifierProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$syncSelfNotifierHash() => r'4f3a2463cb5693a5c8d7e772b4d7c9774b9ba637'; @@ -486,8 +485,8 @@ final class StreamSelfNotifierProvider @$internal @override $StreamNotifierProviderElement - $createElement(ProviderContainer container) => - $StreamNotifierProviderElement(this, container); + $createElement($ProviderPointer pointer) => + $StreamNotifierProviderElement(this, pointer); } String _$streamSelfNotifierHash() => @@ -551,8 +550,8 @@ final class StateNotifierClassAsyncProvider @$internal @override $AsyncNotifierProviderElement - $createElement(ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $createElement($ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); } String _$stateNotifierClassAsyncHash() => @@ -605,9 +604,8 @@ final class ChangeNotifierProvider @$internal @override - $ProviderElement $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ChangeNotifierProvider $copyWithCreate( @@ -683,8 +681,8 @@ final class ChangeNotifierClassProvider @$internal @override $NotifierProviderElement - $createElement(ProviderContainer container) => - $NotifierProviderElement(this, container); + $createElement($ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$changeNotifierClassHash() => @@ -735,8 +733,8 @@ final class NotifierProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override NotifierProvider $copyWithCreate( @@ -796,8 +794,8 @@ final class AutoDisposeNotifierProvider @$internal @override $ProviderElement $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderPointer pointer) => + $ProviderElement(this, pointer); @override AutoDisposeNotifierProvider $copyWithCreate( @@ -874,8 +872,8 @@ final class NotifierClassProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$notifierClassHash() => r'e7eefebec2fca4f982582449e7ec14322932b748'; @@ -926,9 +924,8 @@ final class AsyncNotifierProvider @$internal @override - $ProviderElement $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override AsyncNotifierProvider $copyWithCreate( @@ -1004,8 +1001,8 @@ final class AsyncNotifierClassProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$asyncNotifierClassHash() => @@ -1058,8 +1055,8 @@ final class RawNotifierProvider @$internal @override $ProviderElement> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RawNotifierProvider $copyWithCreate( @@ -1119,8 +1116,8 @@ final class RawFutureNotifierProvider extends $FunctionalProvider< @$internal @override $ProviderElement>> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RawFutureNotifierProvider $copyWithCreate( @@ -1180,8 +1177,8 @@ final class RawStreamNotifierProvider extends $FunctionalProvider< @$internal @override $ProviderElement>> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RawStreamNotifierProvider $copyWithCreate( @@ -1235,8 +1232,8 @@ final class FutureRawNotifierProvider extends $FunctionalProvider< @$internal @override $FutureProviderElement> $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override FutureRawNotifierProvider $copyWithCreate( @@ -1290,8 +1287,8 @@ final class StreamRawNotifierProvider extends $FunctionalProvider< @$internal @override $StreamProviderElement> $createElement( - ProviderContainer container) => - $StreamProviderElement(this, container); + $ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override StreamRawNotifierProvider $copyWithCreate( diff --git a/website/docs/advanced/select/select/codegen.g.dart b/website/docs/advanced/select/select/codegen.g.dart index 5bc5686f4..7be2b2f33 100644 --- a/website/docs/advanced/select/select/codegen.g.dart +++ b/website/docs/advanced/select/select/codegen.g.dart @@ -46,8 +46,8 @@ final class ExampleProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( diff --git a/website/docs/advanced/select/select_async/codegen.g.dart b/website/docs/advanced/select/select_async/codegen.g.dart index ba1f4f5d7..08b777520 100644 --- a/website/docs/advanced/select/select_async/codegen.g.dart +++ b/website/docs/advanced/select/select_async/codegen.g.dart @@ -39,8 +39,8 @@ final class UserProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override UserProvider $copyWithCreate( @@ -98,8 +98,8 @@ final class ExampleProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart index 434acec61..db79245a3 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart @@ -59,9 +59,8 @@ final class ActivityProvider @$internal @override - $FutureProviderElement $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ActivityProvider $copyWithCreate( diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart index 089de5441..b86b18b0e 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -39,9 +39,8 @@ final class ActivityProvider @$internal @override - $FutureProviderElement $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ActivityProvider $copyWithCreate( diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart index b6cdd724b..2cef845c2 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -39,9 +39,8 @@ final class ActivityProvider @$internal @override - $FutureProviderElement $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ActivityProvider $copyWithCreate( diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart index b211d3340..9581f6014 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -39,9 +39,8 @@ final class ActivityProvider @$internal @override - $FutureProviderElement $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ActivityProvider $copyWithCreate( diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart index cdf5cdbac..aef5ca20d 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -39,9 +39,8 @@ final class ActivityProvider @$internal @override - $FutureProviderElement $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ActivityProvider $copyWithCreate( diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart index 434acec61..db79245a3 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -59,9 +59,8 @@ final class ActivityProvider @$internal @override - $FutureProviderElement $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ActivityProvider $copyWithCreate( diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 3dead3ea9..7a59fb2ff 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -48,8 +48,8 @@ final class FetchUserProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override FetchUserProvider $copyWithCreate( @@ -119,14 +119,14 @@ final class FetchUserFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FetchUserProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart index 1fc29d4ba..f996c8037 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart @@ -55,8 +55,8 @@ final class ExampleProvider extends $AsyncNotifierProvider { @$internal @override $AsyncNotifierProviderElement $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); } String _$exampleHash() => r'8a906741b8ea4b9b0d3f0b924779704b3e1773a1'; diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart index 696e8e575..a85924ca2 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart @@ -55,8 +55,8 @@ final class ExampleProvider extends $StreamNotifierProvider { @$internal @override $StreamNotifierProviderElement $createElement( - ProviderContainer container) => - $StreamNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $StreamNotifierProviderElement(this, pointer); } String _$exampleHash() => r'4bca936132b77a9a804549f086f33571724b4804'; diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart index 1f5444b57..91b2227ef 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -39,8 +39,8 @@ final class ExampleProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart index 7951bd7a2..1eaed5598 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -39,8 +39,8 @@ final class ExampleProvider @$internal @override - $StreamProviderElement $createElement(ProviderContainer container) => - $StreamProviderElement(this, container); + $StreamProviderElement $createElement($ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart index 83c6377aa..5f74738ac 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -46,8 +46,8 @@ final class Example1Provider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override Example1Provider $copyWithCreate( @@ -105,8 +105,8 @@ final class Example2Provider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override Example2Provider $copyWithCreate( diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 69a1976c2..f19235fe6 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -55,8 +55,8 @@ final class ExampleProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( @@ -126,14 +126,14 @@ final class ExampleFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ExampleProvider; final argument = provider.argument as int; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index 0fbebd59f..d31b7afef 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -87,8 +87,8 @@ final class ExampleProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -138,7 +138,7 @@ final class ExampleFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ExampleProvider; final argument = provider.argument as ( @@ -148,7 +148,7 @@ final class ExampleFamily extends Family { return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -166,7 +166,7 @@ final class ExampleFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ExampleProvider; final argument = provider.argument as ( @@ -176,7 +176,7 @@ final class ExampleFamily extends Family { return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index 33d057344..abf99703a 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -61,8 +61,8 @@ final class ExampleProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( @@ -147,7 +147,7 @@ final class ExampleFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ExampleProvider; final argument = provider.argument as ( @@ -157,7 +157,7 @@ final class ExampleFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart index d3ae7d304..ed3932ac4 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart @@ -63,8 +63,8 @@ final class ExampleProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$exampleHash() => r'c237193ab6d57674973aaa02eb73db6f6822eb26'; diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart index b928978c5..c765c99fc 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -46,8 +46,8 @@ final class ExampleProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart index 950b74bc2..4d34ff6f9 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -46,8 +46,8 @@ final class SearchProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override SearchProvider $copyWithCreate( @@ -101,8 +101,8 @@ final class ConfigsProvider extends $FunctionalProvider< @$internal @override $StreamProviderElement $createElement( - ProviderContainer container) => - $StreamProviderElement(this, container); + $ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override ConfigsProvider $copyWithCreate( @@ -156,8 +156,8 @@ final class CharactersProvider extends $FunctionalProvider< @$internal @override $FutureProviderElement> $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override CharactersProvider $copyWithCreate( diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart index 3bea31389..a7a071efe 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -46,8 +46,8 @@ final class CityProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CityProvider $copyWithCreate( diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart index f55659935..b0b793401 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -46,8 +46,8 @@ final class FilterProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FilterProvider $copyWithCreate( @@ -106,8 +106,8 @@ final class FilteredTodoListProvider @$internal @override - $ProviderElement> $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement> $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FilteredTodoListProvider $copyWithCreate( diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart index b2807a870..0123f0ce2 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -46,8 +46,8 @@ final class AnotherProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override AnotherProvider $copyWithCreate( @@ -105,8 +105,8 @@ final class MyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override MyProvider $copyWithCreate( diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart index 8b6b58514..147e10802 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -42,8 +42,8 @@ final class ConfigProvider extends $FunctionalProvider< @$internal @override $StreamProviderElement $createElement( - ProviderContainer container) => - $StreamProviderElement(this, container); + $ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override ConfigProvider $copyWithCreate( @@ -97,8 +97,8 @@ final class ProductsProvider extends $FunctionalProvider< @$internal @override $FutureProviderElement> $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ProductsProvider $copyWithCreate( diff --git a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart index 845454d13..ba4c58ad4 100644 --- a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart @@ -63,8 +63,8 @@ final class TodoListProvider extends $NotifierProvider> { @$internal @override $NotifierProviderElement> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$todoListHash() => r'6c965beb867ffeee119133f0ae2e6ebeb68e6f7e'; diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart index 1a81ae8c1..4713ee02c 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -46,8 +46,8 @@ final class CityProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CityProvider $copyWithCreate( @@ -98,8 +98,8 @@ final class WeatherProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override WeatherProvider $copyWithCreate( diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart index 0392538e3..53612e54e 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -42,8 +42,8 @@ final class ConfigProvider extends $FunctionalProvider< @$internal @override $StreamProviderElement $createElement( - ProviderContainer container) => - $StreamProviderElement(this, container); + $ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override ConfigProvider $copyWithCreate( @@ -97,8 +97,8 @@ final class ProductsProvider extends $FunctionalProvider< @$internal @override $FutureProviderElement> $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ProductsProvider $copyWithCreate( diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart index ecf188ef6..aca468f3b 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart @@ -39,8 +39,8 @@ final class ExampleProvider @$internal @override - $StreamProviderElement $createElement(ProviderContainer container) => - $StreamProviderElement(this, container); + $StreamProviderElement $createElement($ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart index 4a64af46a..0a10a1b81 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart @@ -46,8 +46,8 @@ final class MyProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override MyProvider $copyWithCreate( diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart index caf0995be..bcff72444 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart @@ -46,8 +46,8 @@ final class CityProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CityProvider $copyWithCreate( @@ -105,8 +105,8 @@ final class CountryProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CountryProvider $copyWithCreate( diff --git a/website/docs/concepts/reading/counter/codegen.g.dart b/website/docs/concepts/reading/counter/codegen.g.dart index 0dfd30fc6..9dafc37bf 100644 --- a/website/docs/concepts/reading/counter/codegen.g.dart +++ b/website/docs/concepts/reading/counter/codegen.g.dart @@ -47,8 +47,8 @@ final class RepositoryProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RepositoryProvider $copyWithCreate( @@ -123,8 +123,8 @@ final class CounterProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$counterHash() => r'6bd7806869af024b3288645da03c077af9478083'; diff --git a/website/docs/concepts/reading/listen/codegen.g.dart b/website/docs/concepts/reading/listen/codegen.g.dart index 2c1f4b273..cc31620cc 100644 --- a/website/docs/concepts/reading/listen/codegen.g.dart +++ b/website/docs/concepts/reading/listen/codegen.g.dart @@ -46,8 +46,8 @@ final class AnotherProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override AnotherProvider $copyWithCreate( diff --git a/website/docs/concepts/reading/listen_build/codegen.g.dart b/website/docs/concepts/reading/listen_build/codegen.g.dart index 9bfbb449c..82e3d501c 100644 --- a/website/docs/concepts/reading/listen_build/codegen.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen.g.dart @@ -63,8 +63,8 @@ final class CounterProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$counterHash() => r'4320f811608c7a6e7342b83e3031965a34f7cb8e'; diff --git a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart index 56d4702b1..1d0961dfa 100644 --- a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart @@ -63,8 +63,8 @@ final class CounterProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$counterHash() => r'4320f811608c7a6e7342b83e3031965a34f7cb8e'; diff --git a/website/docs/concepts/reading/provider/codegen.g.dart b/website/docs/concepts/reading/provider/codegen.g.dart index cd68e7820..3c1c9ffa9 100644 --- a/website/docs/concepts/reading/provider/codegen.g.dart +++ b/website/docs/concepts/reading/provider/codegen.g.dart @@ -47,8 +47,8 @@ final class RepositoryProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RepositoryProvider $copyWithCreate( @@ -106,8 +106,8 @@ final class ValueProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ValueProvider $copyWithCreate( diff --git a/website/docs/concepts/reading/read/codegen.g.dart b/website/docs/concepts/reading/read/codegen.g.dart index 9867e786b..881b5249c 100644 --- a/website/docs/concepts/reading/read/codegen.g.dart +++ b/website/docs/concepts/reading/read/codegen.g.dart @@ -63,8 +63,8 @@ final class CounterProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; diff --git a/website/docs/concepts/reading/read/codegen_hooks.g.dart b/website/docs/concepts/reading/read/codegen_hooks.g.dart index 0e2b3d9b6..fe6b3d615 100644 --- a/website/docs/concepts/reading/read/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/read/codegen_hooks.g.dart @@ -63,8 +63,8 @@ final class CounterProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; diff --git a/website/docs/concepts/reading/read_build/codegen.g.dart b/website/docs/concepts/reading/read_build/codegen.g.dart index 9867e786b..881b5249c 100644 --- a/website/docs/concepts/reading/read_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_build/codegen.g.dart @@ -63,8 +63,8 @@ final class CounterProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; diff --git a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart index 9867e786b..881b5249c 100644 --- a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart @@ -63,8 +63,8 @@ final class CounterProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; diff --git a/website/docs/concepts/reading/watch/codegen.g.dart b/website/docs/concepts/reading/watch/codegen.g.dart index af2d9d36f..2a1f73ce1 100644 --- a/website/docs/concepts/reading/watch/codegen.g.dart +++ b/website/docs/concepts/reading/watch/codegen.g.dart @@ -47,8 +47,8 @@ final class FilterTypeProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FilterTypeProvider $copyWithCreate( @@ -123,8 +123,8 @@ final class TodosProvider extends $NotifierProvider> { @$internal @override $NotifierProviderElement> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$todosHash() => r'b66ac2b1e5cf7ac7957d25864cfdffad1af233a6'; @@ -175,8 +175,8 @@ final class FilteredTodoListProvider @$internal @override - $ProviderElement> $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement> $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FilteredTodoListProvider $copyWithCreate( diff --git a/website/docs/concepts/reading/watch_build/codegen.g.dart b/website/docs/concepts/reading/watch_build/codegen.g.dart index 51d85de22..38d3c5550 100644 --- a/website/docs/concepts/reading/watch_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen.g.dart @@ -63,8 +63,8 @@ final class TodoListProvider extends $NotifierProvider> { @$internal @override $NotifierProviderElement> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$todoListHash() => r'77f007cd4f5105330a4c2ab8555ea0d1716945c1'; @@ -114,8 +114,8 @@ final class CounterProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CounterProvider $copyWithCreate( diff --git a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart index 1bc192195..d40df19a7 100644 --- a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart @@ -63,8 +63,8 @@ final class TodoListProvider extends $NotifierProvider> { @$internal @override $NotifierProviderElement> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$todoListHash() => r'77f007cd4f5105330a4c2ab8555ea0d1716945c1'; @@ -114,8 +114,8 @@ final class CounterProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CounterProvider $copyWithCreate( diff --git a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart index 9867e786b..881b5249c 100644 --- a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart @@ -63,8 +63,8 @@ final class CounterProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$counterHash() => r'600c6beb47b3732049b6955a9e49d7eef30c741a'; diff --git a/website/docs/concepts/why_immutability/codegen.g.dart b/website/docs/concepts/why_immutability/codegen.g.dart index 9e365d289..475118f0d 100644 --- a/website/docs/concepts/why_immutability/codegen.g.dart +++ b/website/docs/concepts/why_immutability/codegen.g.dart @@ -64,8 +64,8 @@ final class ThemeNotifierProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$themeNotifierHash() => r'e119d56d9bf8b8d7c19624997f99d116098b45e9'; diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart index ed70e46f9..40d68df62 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -39,8 +39,8 @@ final class ExampleProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart index 910016c97..c648c1a45 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -46,8 +46,8 @@ final class ExampleProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index 34032c995..cf3ac7964 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -55,8 +55,8 @@ final class LabelProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override LabelProvider $copyWithCreate( @@ -126,14 +126,14 @@ final class LabelFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as LabelProvider; final argument = provider.argument as String; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart index 1ee57c762..5f3a37cd0 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -39,8 +39,8 @@ final class ExampleProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart index 1c1f5756d..b9f105c59 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -46,8 +46,8 @@ final class OtherProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override OtherProvider $copyWithCreate( @@ -98,8 +98,8 @@ final class ExampleProvider @$internal @override - $StreamProviderElement $createElement(ProviderContainer container) => - $StreamProviderElement(this, container); + $StreamProviderElement $createElement($ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart index 5da2a0d71..720bf282b 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart @@ -46,8 +46,8 @@ final class OtherProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override OtherProvider $copyWithCreate( @@ -105,8 +105,8 @@ final class ExampleProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart index 5b9b38e0f..5b473f416 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart @@ -46,8 +46,8 @@ final class OtherProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override OtherProvider $copyWithCreate( @@ -105,8 +105,8 @@ final class ExampleProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart index 7d3d83817..0a59e96ad 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -46,8 +46,8 @@ final class OtherProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override OtherProvider $copyWithCreate( @@ -122,8 +122,8 @@ final class ExampleProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$exampleHash() => r'893db991b377b8e314e60c429043e5e81f1fd526'; diff --git a/website/docs/essentials/combining_requests/read_example/codegen.g.dart b/website/docs/essentials/combining_requests/read_example/codegen.g.dart index f95fd7890..9ff8950cc 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.g.dart @@ -46,8 +46,8 @@ final class OtherProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override OtherProvider $copyWithCreate( @@ -122,8 +122,8 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$myNotifierHash() => r'353efe22dd5a91b2d036286211ac9e60c9de5f6d'; diff --git a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart index f31f1664c..3889af056 100644 --- a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart @@ -43,8 +43,8 @@ final class LocationProvider extends $FunctionalProvider< @$internal @override $StreamProviderElement<({double longitude, double latitude})> $createElement( - ProviderContainer container) => - $StreamProviderElement(this, container); + $ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override LocationProvider $copyWithCreate( @@ -98,8 +98,8 @@ final class RestaurantsNearMeProvider extends $FunctionalProvider< @$internal @override $FutureProviderElement> $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override RestaurantsNearMeProvider $copyWithCreate( diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart index f50439720..5ba090e2d 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart @@ -46,8 +46,8 @@ final class OtherProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override OtherProvider $copyWithCreate( @@ -105,8 +105,8 @@ final class ExampleProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( @@ -181,8 +181,8 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$myNotifierHash() => r'ad79fdb5b0e72a800fa03efc1e7157f0d1524844'; diff --git a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart index 3332824a0..9247cd8a0 100644 --- a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart +++ b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart @@ -39,8 +39,8 @@ final class ExampleProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( diff --git a/website/docs/essentials/first_request/codegen/provider.g.dart b/website/docs/essentials/first_request/codegen/provider.g.dart index 694d37af9..4a14abb62 100644 --- a/website/docs/essentials/first_request/codegen/provider.g.dart +++ b/website/docs/essentials/first_request/codegen/provider.g.dart @@ -47,9 +47,8 @@ final class ActivityProvider @$internal @override - $FutureProviderElement $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ActivityProvider $copyWithCreate( diff --git a/website/docs/essentials/passing_args/family/codegen.g.dart b/website/docs/essentials/passing_args/family/codegen.g.dart index 4ce4498dd..cb2ba3594 100644 --- a/website/docs/essentials/passing_args/family/codegen.g.dart +++ b/website/docs/essentials/passing_args/family/codegen.g.dart @@ -48,9 +48,8 @@ final class ActivityProvider @$internal @override - $FutureProviderElement $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ActivityProvider $copyWithCreate( @@ -120,14 +119,14 @@ final class ActivityFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ActivityProvider; final argument = provider.argument as String; return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -195,8 +194,8 @@ final class ActivityNotifier2Provider @$internal @override $AsyncNotifierProviderElement $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -239,14 +238,14 @@ final class ActivityNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ActivityNotifier2Provider; final argument = provider.argument as String; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -259,14 +258,14 @@ final class ActivityNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as ActivityNotifier2Provider; final argument = provider.argument as String; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart b/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart index 220d83a3f..bc3d1dcf9 100644 --- a/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart +++ b/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart @@ -39,9 +39,8 @@ final class ActivityProvider @$internal @override - $FutureProviderElement $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ActivityProvider $copyWithCreate( @@ -109,8 +108,8 @@ final class ActivityNotifier2Provider @$internal @override $AsyncNotifierProviderElement $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); } String _$activityNotifier2Hash() => r'280f4d82a186cfb62827f4d7c74f5349bb0a9e4a'; diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart index 86137df46..0e519aeaa 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -71,8 +71,8 @@ final class TodoListProvider @$internal @override $AsyncNotifierProviderElement> $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); } String _$todoListHash() => r'c939d438b07da6065dbbcfab86c27ef363bdb76c'; diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart index 41d7a91b3..ddf51af2b 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -56,8 +56,8 @@ final class TodoListProvider @$internal @override $AsyncNotifierProviderElement> $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); } String _$todoListHash() => r'4008395aaca8f55312f668c0b2a32e7599f82349'; diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart index 07a96e522..69dd50b2b 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -39,9 +39,8 @@ final class TodoListProvider @$internal @override - $FutureProviderElement> $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement> $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override TodoListProvider $copyWithCreate( diff --git a/website/docs/essentials/testing/notifier_mock/codegen.g.dart b/website/docs/essentials/testing/notifier_mock/codegen.g.dart index 73b4a4036..bb8a55697 100644 --- a/website/docs/essentials/testing/notifier_mock/codegen.g.dart +++ b/website/docs/essentials/testing/notifier_mock/codegen.g.dart @@ -63,8 +63,8 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$myNotifierHash() => r'912fa35c2296626fc0825bcbcfc6b6c85958be02'; diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart index 3332824a0..9247cd8a0 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart @@ -39,8 +39,8 @@ final class ExampleProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ExampleProvider $copyWithCreate( diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart index 91ba4046b..18cb6f9a5 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -56,8 +56,8 @@ final class MyListenableProvider extends $FunctionalProvider< @$internal @override $ProviderElement>> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderPointer pointer) => + $ProviderElement(this, pointer); @override MyListenableProvider $copyWithCreate( diff --git a/website/docs/essentials/websockets_sync/raw_usage.g.dart b/website/docs/essentials/websockets_sync/raw_usage.g.dart index 39a826e81..2abb6e174 100644 --- a/website/docs/essentials/websockets_sync/raw_usage.g.dart +++ b/website/docs/essentials/websockets_sync/raw_usage.g.dart @@ -47,9 +47,8 @@ final class RawStreamProvider @$internal @override - $ProviderElement>> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement>> $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RawStreamProvider $copyWithCreate( diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart index d819bbf92..b238ebb66 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -48,8 +48,8 @@ final class MyListenableProvider extends $FunctionalProvider< @$internal @override $ProviderElement>> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderPointer pointer) => + $ProviderElement(this, pointer); @override MyListenableProvider $copyWithCreate( @@ -109,8 +109,8 @@ final class AnotherListenableProvider extends $FunctionalProvider< @$internal @override $ProviderElement>> $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderPointer pointer) => + $ProviderElement(this, pointer); @override AnotherListenableProvider $copyWithCreate( diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart index d2a75745b..a15bce177 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -39,8 +39,8 @@ final class StreamExampleProvider @$internal @override - $StreamProviderElement $createElement(ProviderContainer container) => - $StreamProviderElement(this, container); + $StreamProviderElement $createElement($ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override StreamExampleProvider $copyWithCreate( diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart index e601efd26..9d76fdbb8 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -46,8 +46,8 @@ final class SynchronousExampleProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override SynchronousExampleProvider $copyWithCreate( diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index 5195726c4..1ed93a3ec 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -61,8 +61,8 @@ final class RandomProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RandomProvider $copyWithCreate( @@ -147,7 +147,7 @@ final class RandomFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as RandomProvider; final argument = provider.argument as ({ @@ -157,7 +157,7 @@ final class RandomFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/website/docs/from_provider/motivation/async_values/async_values.g.dart b/website/docs/from_provider/motivation/async_values/async_values.g.dart index 13a80aeba..7f7ac9ac7 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.g.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.g.dart @@ -39,9 +39,8 @@ final class ItemsApiProvider @$internal @override - $FutureProviderElement> $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement> $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ItemsApiProvider $copyWithCreate( @@ -100,8 +99,8 @@ final class EvenItemsProvider @$internal @override - $ProviderElement> $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement> $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override EvenItemsProvider $copyWithCreate( diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart index 00b5a80b6..f41b8a2eb 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -46,8 +46,8 @@ final class DiceRollProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override DiceRollProvider $copyWithCreate( @@ -105,8 +105,8 @@ final class CachedDiceRollProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CachedDiceRollProvider $copyWithCreate( diff --git a/website/docs/from_provider/motivation/combine/combine.g.dart b/website/docs/from_provider/motivation/combine/combine.g.dart index 97d1c5027..24857d12f 100644 --- a/website/docs/from_provider/motivation/combine/combine.g.dart +++ b/website/docs/from_provider/motivation/combine/combine.g.dart @@ -46,8 +46,8 @@ final class NumberProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override NumberProvider $copyWithCreate( @@ -105,8 +105,8 @@ final class DoubledProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override DoubledProvider $copyWithCreate( diff --git a/website/docs/from_provider/motivation/same_type/same_type.g.dart b/website/docs/from_provider/motivation/same_type/same_type.g.dart index d5c781dc9..efc4eeed9 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.g.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.g.dart @@ -46,8 +46,8 @@ final class ItemsProvider extends $FunctionalProvider, List> @$internal @override - $ProviderElement> $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement> $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override ItemsProvider $copyWithCreate( @@ -106,8 +106,8 @@ final class EvenItemsProvider @$internal @override - $ProviderElement> $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement> $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override EvenItemsProvider $copyWithCreate( diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart index 8ea69b222..56da860ef 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart @@ -46,8 +46,8 @@ final class HelloWorldProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override HelloWorldProvider $copyWithCreate( diff --git a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart index 8ea69b222..56da860ef 100644 --- a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -46,8 +46,8 @@ final class HelloWorldProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override HelloWorldProvider $copyWithCreate( diff --git a/website/docs/introduction/getting_started/hello_world/main.g.dart b/website/docs/introduction/getting_started/hello_world/main.g.dart index 8ea69b222..56da860ef 100644 --- a/website/docs/introduction/getting_started/hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/main.g.dart @@ -46,8 +46,8 @@ final class HelloWorldProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override HelloWorldProvider $copyWithCreate( diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index 63dac5337..ac257888d 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -57,8 +57,8 @@ final class FetchPackagesProvider extends $FunctionalProvider< @$internal @override $FutureProviderElement> $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override FetchPackagesProvider $copyWithCreate( @@ -143,7 +143,7 @@ final class FetchPackagesFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as FetchPackagesProvider; final argument = provider.argument as ({ @@ -153,7 +153,7 @@ final class FetchPackagesFamily extends Family { return provider .$copyWithCreate((ref) => create(ref, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart index 89fde15c5..d2ad608bb 100644 --- a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart +++ b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart @@ -56,8 +56,8 @@ final class MyNotifierProvider @$internal @override $AsyncNotifierProviderElement> $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); } String _$myNotifierHash() => r'fc9a07f8ef9f792da2ac660d76ea0a809335ba18'; diff --git a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart index 7ba06bab0..e90ca97c4 100644 --- a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart +++ b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart @@ -56,8 +56,8 @@ final class MyNotifierProvider @$internal @override $AsyncNotifierProviderElement> $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); } String _$myNotifierHash() => r'1c67c12443102cf8c43efbf6c630d3028d9847c3'; diff --git a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart index 155265ea9..4fb397aa3 100644 --- a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart +++ b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart @@ -56,8 +56,8 @@ final class MyNotifierProvider @$internal @override $AsyncNotifierProviderElement> $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); } String _$myNotifierHash() => r'bde95c56aa12eff7c8c01ede57ae4ad2b616c225'; diff --git a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart index 3421fa239..5c74f4073 100644 --- a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart +++ b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -63,8 +63,8 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$myNotifierHash() => r'9acd382ed579c545ace755687b155e28eba01d22'; diff --git a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart index 6354391c1..d4cbac605 100644 --- a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart +++ b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -56,8 +56,8 @@ final class AsyncTodosNotifierProvider @$internal @override $AsyncNotifierProviderElement> $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); } String _$asyncTodosNotifierHash() => diff --git a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart index 5c2954920..0f50958bd 100644 --- a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart +++ b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart @@ -64,8 +64,8 @@ final class CounterNotifierProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$counterNotifierHash() => r'8d4e4011da15a0ef79af9622336839a0c9e406ab'; diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index 40794adb0..466508708 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -47,9 +47,8 @@ final class TaskTrackerProvider @$internal @override - $ProviderElement $createElement( - ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override TaskTrackerProvider $copyWithCreate( @@ -132,8 +131,8 @@ final class BugsEncounteredNotifierProvider @$internal @override $AsyncNotifierProviderElement $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); @override bool operator ==(Object other) { @@ -178,14 +177,14 @@ final class BugsEncounteredNotifierFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as BugsEncounteredNotifierProvider; final argument = provider.argument as String; return provider .$copyWithCreate(() => create(argument)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -198,14 +197,14 @@ final class BugsEncounteredNotifierFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (container, provider) { + createElement: (pointer, provider) { provider as BugsEncounteredNotifierProvider; final argument = provider.argument as String; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) - .$createElement(container); + .$createElement(pointer); }, ); } diff --git a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart index 414240d7b..641c46461 100644 --- a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart +++ b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -64,8 +64,8 @@ final class CounterNotifierProvider @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$counterNotifierHash() => r'b32033040f0fff627f1a6dfd9cfb4e93a842390b'; diff --git a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart index ebeae7b8b..33760654e 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -63,8 +63,8 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$myNotifierHash() => r'0495c52ce893ee0304d4d5ac5648c634ed4a241e'; diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart index d7770bbed..6f98f75ea 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -46,8 +46,8 @@ final class DurationProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override DurationProvider $copyWithCreate( @@ -105,8 +105,8 @@ final class RepositoryProvider extends $FunctionalProvider<_MyRepo, _MyRepo> @$internal @override - $ProviderElement<_MyRepo> $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement<_MyRepo> $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override RepositoryProvider $copyWithCreate( @@ -181,8 +181,8 @@ final class MyNotifierProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$myNotifierHash() => r'8ea2586ea29d12306efd4b8b847142136dd20338'; diff --git a/website/docs/providers/future_provider/config_provider/codegen.g.dart b/website/docs/providers/future_provider/config_provider/codegen.g.dart index 031ff1c2c..cb4e4bf72 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.g.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.g.dart @@ -42,8 +42,8 @@ final class FetchConfigurationProvider extends $FunctionalProvider< @$internal @override $FutureProviderElement $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override FetchConfigurationProvider $copyWithCreate( diff --git a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart index cca3e35a9..57c8b0876 100644 --- a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart @@ -73,8 +73,8 @@ final class AsyncTodosProvider @$internal @override $AsyncNotifierProviderElement> $createElement( - ProviderContainer container) => - $AsyncNotifierProviderElement(this, container); + $ProviderPointer pointer) => + $AsyncNotifierProviderElement(this, pointer); } String _$asyncTodosHash() => r'fd0d7502a1c17b7cedd2350519649dd680fc48cd'; diff --git a/website/docs/providers/notifier_provider/todos/codegen.g.dart b/website/docs/providers/notifier_provider/todos/codegen.g.dart index 60d92b5cc..2998db847 100644 --- a/website/docs/providers/notifier_provider/todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/todos/codegen.g.dart @@ -63,8 +63,8 @@ final class TodosProvider extends $NotifierProvider> { @$internal @override $NotifierProviderElement> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$todosHash() => r'3485c14ec4db07efe5fe52243258a66e6f99b2b4'; diff --git a/website/docs/providers/provider/completed_todos/completed_todos.g.dart b/website/docs/providers/provider/completed_todos/completed_todos.g.dart index f34527681..4e2282ab4 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.g.dart @@ -47,8 +47,8 @@ final class CompletedTodosProvider @$internal @override - $ProviderElement> $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement> $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CompletedTodosProvider $copyWithCreate( diff --git a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index f2097adaa..8e2628485 100644 --- a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -63,8 +63,8 @@ final class PageIndexProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$pageIndexHash() => r'59307ecf23b5b2432833da5ad6b312bf36435d0e'; @@ -114,8 +114,8 @@ final class CanGoToPreviousPageProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override CanGoToPreviousPageProvider $copyWithCreate( diff --git a/website/docs/providers/provider/todo/todo.g.dart b/website/docs/providers/provider/todo/todo.g.dart index a7227a1fe..481c5f893 100644 --- a/website/docs/providers/provider/todo/todo.g.dart +++ b/website/docs/providers/provider/todo/todo.g.dart @@ -63,8 +63,8 @@ final class TodosProvider extends $NotifierProvider> { @$internal @override $NotifierProviderElement> $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$todosHash() => r'4bd25c3c15bfff56ad6e733bd17ecb7284c4ceb2'; diff --git a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart index bba8f6a42..a88febd27 100644 --- a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart +++ b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -63,8 +63,8 @@ final class PageIndexProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$pageIndexHash() => r'59307ecf23b5b2432833da5ad6b312bf36435d0e'; diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart index 42b8a04e3..77c926ef8 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -40,8 +40,8 @@ final class ChatProvider @$internal @override $StreamProviderElement> $createElement( - ProviderContainer container) => - $StreamProviderElement(this, container); + $ProviderPointer pointer) => + $StreamProviderElement(this, pointer); @override ChatProvider $copyWithCreate( diff --git a/website/static/snippets/async.g.dart b/website/static/snippets/async.g.dart index 9ae204722..3860c3c0d 100644 --- a/website/static/snippets/async.g.dart +++ b/website/static/snippets/async.g.dart @@ -42,8 +42,8 @@ final class ConfigurationsProvider extends $FunctionalProvider< @$internal @override $FutureProviderElement $createElement( - ProviderContainer container) => - $FutureProviderElement(this, container); + $ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override ConfigurationsProvider $copyWithCreate( diff --git a/website/static/snippets/combine.g.dart b/website/static/snippets/combine.g.dart index 6bd564c8b..2218f9e04 100644 --- a/website/static/snippets/combine.g.dart +++ b/website/static/snippets/combine.g.dart @@ -46,8 +46,8 @@ final class TodosProvider extends $FunctionalProvider, List> @$internal @override - $ProviderElement> $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement> $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override TodosProvider $copyWithCreate( @@ -105,8 +105,8 @@ final class FilterProvider extends $FunctionalProvider @$internal @override - $ProviderElement $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FilterProvider $copyWithCreate( @@ -165,8 +165,8 @@ final class FilteredTodosProvider @$internal @override - $ProviderElement> $createElement(ProviderContainer container) => - $ProviderElement(this, container); + $ProviderElement> $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override FilteredTodosProvider $copyWithCreate( diff --git a/website/static/snippets/create.g.dart b/website/static/snippets/create.g.dart index 1d8e99c83..5165235ea 100644 --- a/website/static/snippets/create.g.dart +++ b/website/static/snippets/create.g.dart @@ -39,8 +39,8 @@ final class BoredSuggestionProvider @$internal @override - $FutureProviderElement $createElement(ProviderContainer container) => - $FutureProviderElement(this, container); + $FutureProviderElement $createElement($ProviderPointer pointer) => + $FutureProviderElement(this, pointer); @override BoredSuggestionProvider $copyWithCreate( diff --git a/website/static/snippets/declare.g.dart b/website/static/snippets/declare.g.dart index c23869086..857d151a3 100644 --- a/website/static/snippets/declare.g.dart +++ b/website/static/snippets/declare.g.dart @@ -63,8 +63,8 @@ final class CountProvider extends $NotifierProvider { @$internal @override $NotifierProviderElement $createElement( - ProviderContainer container) => - $NotifierProviderElement(this, container); + $ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); } String _$countHash() => r'6fc5f8ad4bbd390899dd0d14c7b902407d4413bd'; From ea394c64204eb600138ba6ae70aa5855d59a70bc Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 15 Mar 2024 18:24:18 +0100 Subject: [PATCH 299/387] W --- .../test/src/core/provider_container_test.dart | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/packages/riverpod/test/src/core/provider_container_test.dart b/packages/riverpod/test/src/core/provider_container_test.dart index 4366d4bb9..385c26da4 100644 --- a/packages/riverpod/test/src/core/provider_container_test.dart +++ b/packages/riverpod/test/src/core/provider_container_test.dart @@ -10,12 +10,12 @@ import '../utils.dart'; const _sentinel = Object(); -TypeMatcher isPointer({ +TypeMatcher<$ProviderPointer> isPointer({ Object? override = _sentinel, Object? element = _sentinel, Object? targetContainer = _sentinel, }) { - var matcher = isA(); + var matcher = isA<$ProviderPointer>(); if (override != _sentinel) { matcher = matcher.having((p) => p.providerOverride, 'override', override); @@ -706,11 +706,7 @@ void main() { expect( pointer, - isPointer( - targetContainer: container, - override: null, - element: isNotNull, - ), + isPointer(targetContainer: container, override: null), ); }); From b95250d46e629db06eef32ac37d4d08fafa14b77 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 15 Mar 2024 18:32:45 +0100 Subject: [PATCH 300/387] W --- packages/riverpod/lib/src/core/element.dart | 115 ++++++++++-------- packages/riverpod/lib/src/core/family.dart | 18 +-- .../riverpod/lib/src/core/foundation.dart | 1 - .../lib/src/core/modifiers/select.dart | 59 +++++++-- .../lib/src/core/modifiers/select_async.dart | 2 - packages/riverpod/lib/src/core/override.dart | 34 ++---- .../lib/src/core/override_with_value.dart | 12 +- .../src/core/provider/notifier_provider.dart | 4 +- .../lib/src/core/provider/provider.dart | 5 +- .../lib/src/core/provider_container.dart | 45 +++---- .../lib/src/core/provider_subscription.dart | 22 +++- .../src/core/proxy_provider_listenable.dart | 2 - packages/riverpod/lib/src/core/scheduler.dart | 2 +- .../test/src/core/provider_element_test.dart | 74 +++++++++++ 14 files changed, 250 insertions(+), 145 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 565d1de12..bed929f28 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -42,9 +42,9 @@ void Function()? debugCanModifyProviders; /// {@endtemplate} @internal @optionalTypeArgs -abstract class ProviderElement implements Node { +abstract class ProviderElement implements WrappedNode { /// {@macro riverpod.provider_element_base} - ProviderElement(this.container); + ProviderElement(this.pointer); static ProviderElement? _debugCurrentlyBuildingElement; @@ -56,14 +56,16 @@ abstract class ProviderElement implements Node { /// The provider associated with this [ProviderElement], before applying overrides. // Not typed as because of https://github.com/rrousselGit/riverpod/issues/1100 - ProviderBase get origin => _origin; - late final ProviderBase _origin; + ProviderBase get origin => pointer.origin; /// The provider associated with this [ProviderElement], after applying overrides. ProviderBase get provider; + /// The [$ProviderPointer] associated with this [ProviderElement]. + final $ProviderPointer pointer; + /// The [ProviderContainer] that owns this [ProviderElement]. - final ProviderContainer container; + ProviderContainer get container => pointer.targetContainer; Ref? ref; @@ -77,6 +79,15 @@ abstract class ProviderElement implements Node { bool get isActive => (_dependents?.isNotEmpty ?? false) || _watchDependents.isNotEmpty; + /// Whether this [ProviderElement] is currently listened to or not. + /// + /// This maps to listeners added with `listen` and `watch`, + /// excluding `listen(weak: true)`. + bool get hasListeners => + (_dependents?.isNotEmpty ?? false) || + _watchDependents.isNotEmpty || + _weakDependents.isNotEmpty; + var _dependencies = HashMap(); HashMap? _previousDependencies; List? _subscriptions; @@ -84,12 +95,11 @@ abstract class ProviderElement implements Node { /// "listen(weak: true)" pointing to this provider. /// - /// Those subscriptions are separate from [_dependents] for a few reasons: - /// - They do not count towards [isActive]. + /// Those subscriptions are separate from [ProviderElement._dependents] for a few reasons: + /// - They do not count towards [ProviderElement.isActive]. /// - They may be reused between two instances of a [ProviderElement]. - /// - /// The list is passed by reference before [_mount] by [ProviderPointer]. - late final List _weakDependents; + // TODO keep the pointer alive until all weak dependents are disposed + final _weakDependents = []; /// The element of the providers that depends on this provider. final _watchDependents = []; @@ -232,17 +242,15 @@ This could mean a few things: } } - final listeners = _dependents?.toList(growable: false); - if (listeners != null) { - for (var i = 0; i < listeners.length; i++) { - final listener = listeners[i]; - if (listener is _ProviderStateSubscription) { - Zone.current.runBinaryGuarded( - listener.listener, - null, - newState.state, - ); - } + final listeners = _weakDependents.toList(growable: false); + for (var i = 0; i < listeners.length; i++) { + final listener = listeners[i]; + if (listener is _ProviderStateSubscription) { + Zone.current.runBinaryGuarded( + listener.listener, + null, + newState.state, + ); } } @@ -496,32 +504,28 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu return; } - final listeners = _dependents?.toList(growable: false); + final listeners = [..._weakDependents, ...?_dependents]; switch (newState) { case final ResultData newState: - if (listeners != null) { - for (var i = 0; i < listeners.length; i++) { - final listener = listeners[i]; - if (listener is _ProviderStateSubscription) { - Zone.current.runBinaryGuarded( - listener.listener, - previousState, - newState.state, - ); - } + for (var i = 0; i < listeners.length; i++) { + final listener = listeners[i]; + if (listener is _ProviderStateSubscription) { + Zone.current.runBinaryGuarded( + listener.listener, + previousState, + newState.state, + ); } } case final ResultError newState: - if (listeners != null) { - for (var i = 0; i < listeners.length; i++) { - final listener = listeners[i]; - if (listener is _ProviderStateSubscription) { - Zone.current.runBinaryGuarded( - listener.onError, - newState.error, - newState.stackTrace, - ); - } + for (var i = 0; i < listeners.length; i++) { + final listener = listeners[i]; + if (listener is _ProviderStateSubscription) { + Zone.current.runBinaryGuarded( + listener.onError, + newState.error, + newState.stackTrace, + ); } } default: @@ -585,9 +589,9 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ref._throwIfInvalidUsage(); final result = listenable.addListener( - this, + // TODO assert weak listeners are removed on dispose + weak ? WeakNode(this) : this, listener, - weak: weak, fireImmediately: fireImmediately, onError: onError, onDependencyMayHaveChanged: onDependencyMayHaveChanged, @@ -659,11 +663,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ref._onDisposeListeners?.forEach(runGuarded); for (final observer in container.observers) { - runBinaryGuarded( - observer.didDisposeProvider, - _origin, - container, - ); + runBinaryGuarded(observer.didDisposeProvider, origin, container); } ref._keepAliveLinks = null; @@ -746,11 +746,18 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu elementVisitor(_watchDependents[i]); } - final dependents = _dependents; - if (dependents != null) { - for (var i = 0; i < dependents.length; i++) { - final dependent = dependents[i].source; - if (dependent is ProviderElement) elementVisitor(dependent); + Iterable children = _weakDependents; + if (_dependents case final dependents?) { + children = children.followedBy(dependents); + } + + for (final child in children) { + switch (child.source) { + case final ProviderElement dependent: + case WeakNode(inner: final ProviderElement dependent): + elementVisitor(dependent); + case _: + break; } } } diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index 12488b073..16473c72b 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -122,12 +122,12 @@ class FunctionalFamily< // ) { return $FamilyOverride( from: this, - createElement: (container, provider) { - provider as ProviderT; + createElement: (pointer) { + final provider = pointer.origin as ProviderT; return provider .$copyWithCreate((ref) => create(ref, provider.argument as ArgT)) - .$createElement(container); + .$createElement(pointer); }, ); } @@ -191,10 +191,10 @@ class ClassFamily< // Override overrideWith(NotifierT Function() create) { return $FamilyOverride( from: this, - createElement: (container, provider) { - provider as ProviderT; + createElement: (pointer) { + final provider = pointer.origin as ProviderT; - return provider.$copyWithCreate(create).$createElement(container); + return provider.$copyWithCreate(create).$createElement(pointer); }, ); } @@ -205,10 +205,10 @@ class ClassFamily< // ) { return $FamilyOverride( from: this, - createElement: (container, provider) { - provider as ProviderT; + createElement: (pointer) { + final provider = pointer.origin as ProviderT; - return provider.$copyWithBuild(build).$createElement(container); + return provider.$copyWithBuild(build).$createElement(pointer); }, ); } diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index 0c014cd84..17b26f39c 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -176,7 +176,6 @@ mixin ProviderListenable implements ProviderListenableOrFamily { ProviderSubscription addListener( Node node, void Function(StateT? previous, StateT next) listener, { - required bool weak, required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index 15d21dc21..5878093e6 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -1,28 +1,67 @@ part of '../../framework.dart'; +extension on Node { + bool get weak => this is WeakNode; +} + /// An abstraction of both [ProviderContainer] and [$ProviderElement] used by /// [ProviderListenable]. -abstract class Node { +sealed class Node { /// Starts listening to this transformer ProviderSubscription listen( ProviderListenable listenable, void Function(StateT? previous, StateT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, required bool fireImmediately, - required bool weak, }); - /// Reads the state of a provider, potentially creating it in the process. - /// - /// It may throw if the provider requested threw when it was built. - /// - /// Do not use this in production code. This is exposed only for testing - /// and devtools, to be able to test if a provider has listeners or similar. + /// Obtain the [ProviderElement] of a provider, creating it if necessary. + @internal ProviderElement readProviderElement( ProviderBase provider, ); } +sealed class WrappedNode implements Node { + @override + ProviderSubscription listen( + ProviderListenable listenable, + void Function(StateT? previous, StateT next) listener, { + required void Function(Object error, StackTrace stackTrace)? onError, + required bool fireImmediately, + bool weak = false, + }); +} + +@internal +final class WeakNode implements Node { + WeakNode(this.inner); + final WrappedNode inner; + + @override + ProviderSubscription listen( + ProviderListenable listenable, + void Function(StateT? previous, StateT next) listener, { + required void Function(Object error, StackTrace stackTrace)? onError, + required bool fireImmediately, + }) { + return inner.listen( + listenable, + listener, + onError: onError, + weak: true, + fireImmediately: fireImmediately, + ); + } + + @override + ProviderElement readProviderElement( + ProviderBase provider, + ) { + return inner.readProviderElement(provider); + } +} + var _debugIsRunningSelector = false; /// An internal class for `ProviderBase.select`. @@ -88,7 +127,6 @@ class _ProviderSelector with ProviderListenable { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, - required bool weak, }) { onError ??= Zone.current.handleUncaughtError; @@ -104,12 +142,11 @@ class _ProviderSelector with ProviderListenable { onChange: (newState) => lastSelectedValue = newState, ); }, - weak: weak, fireImmediately: false, onError: onError, ); - if (!weak) lastSelectedValue = _select(Result.guard(sub.read)); + if (!node.weak) lastSelectedValue = _select(Result.guard(sub.read)); if (fireImmediately) { _handleFireImmediately( diff --git a/packages/riverpod/lib/src/core/modifiers/select_async.dart b/packages/riverpod/lib/src/core/modifiers/select_async.dart index 5981cc432..7356b11cf 100644 --- a/packages/riverpod/lib/src/core/modifiers/select_async.dart +++ b/packages/riverpod/lib/src/core/modifiers/select_async.dart @@ -38,7 +38,6 @@ class _AsyncSelector with ProviderListenable> { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, - required bool weak, }) { Result? lastSelectedValue; Completer? selectedCompleter; @@ -136,7 +135,6 @@ class _AsyncSelector with ProviderListenable> { provider, (prev, input) => playValue(input), onError: onError, - weak: weak, fireImmediately: false, ); diff --git a/packages/riverpod/lib/src/core/override.dart b/packages/riverpod/lib/src/core/override.dart index fc8aaa1bc..6b7e862bd 100644 --- a/packages/riverpod/lib/src/core/override.dart +++ b/packages/riverpod/lib/src/core/override.dart @@ -96,10 +96,7 @@ abstract class $FamilyOverride implements _FamilyOverride { /// Do not use: Internal object to used by [ProviderContainer]/`ProviderScope` /// to override the behavior of a "family" for part of the application. factory $FamilyOverride({ - required ProviderElement Function( - ProviderContainer container, - ProviderBase provider, - ) createElement, + required ProviderElement Function($ProviderPointer pointer) createElement, required Family from, }) = _FamilyOverrideImpl; @@ -107,10 +104,7 @@ abstract class $FamilyOverride implements _FamilyOverride { Family get from; /// The overridden [ProviderBase.$createElement]. - ProviderElement createElement( - ProviderContainer container, - ProviderBase provider, - ); + ProviderElement createElement($ProviderPointer pointer); @mustBeOverridden @override @@ -125,11 +119,8 @@ class TransitiveFamilyOverride implements $FamilyOverride { final Family from; @override - ProviderElement createElement( - ProviderContainer container, - ProviderBase provider, - ) { - return provider.$createElement(container); + ProviderElement createElement($ProviderPointer pointer) { + return pointer.origin.$createElement(pointer); } @override @@ -141,27 +132,18 @@ class _FamilyOverrideImpl implements $FamilyOverride { /// An [Override] for families // ignore: library_private_types_in_public_api _FamilyOverrideImpl({ - required ProviderElement Function( - ProviderContainer container, - ProviderBase provider, - ) createElement, + required ProviderElement Function($ProviderPointer pointer) createElement, required this.from, }) : _createElement = createElement; @override final Family from; - final ProviderElement Function( - ProviderContainer container, - ProviderBase provider, - ) _createElement; + final ProviderElement Function($ProviderPointer pointer) _createElement; @override - ProviderElement createElement( - ProviderContainer container, - ProviderBase provider, - ) { - return _createElement(container, provider); + ProviderElement createElement($ProviderPointer pointer) { + return _createElement(pointer); } @mustBeOverridden diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index 3b4760f97..e795d5f9a 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -27,15 +27,15 @@ final class $ValueProvider extends ProviderBase @internal @override // ignore: library_private_types_in_public_api, not public API - _ValueProviderElement $createElement(ProviderContainer container) { - return _ValueProviderElement(this, container); + _ValueProviderElement $createElement($ProviderPointer pointer) { + return _ValueProviderElement(this, pointer); } } /// The [ProviderElement] of a [$ValueProvider] class _ValueProviderElement extends ProviderElement { /// The [ProviderElement] of a [$ValueProvider] - _ValueProviderElement(this.provider, super.container); + _ValueProviderElement(this.provider, super.pointer); /// A custom listener called when `overrideWithValue` changes /// with a different value. @@ -89,16 +89,16 @@ final class $AsyncValueProvider @override // ignore: library_private_types_in_public_api, not public API _AsyncValueProviderElement $createElement( - ProviderContainer container, + $ProviderPointer pointer, ) { - return _AsyncValueProviderElement(this, container); + return _AsyncValueProviderElement(this, pointer); } } class _AsyncValueProviderElement extends _ValueProviderElement> with FutureModifierElement { - _AsyncValueProviderElement(super.provider, super.container); + _AsyncValueProviderElement(super.provider, super.pointer); @override void _setValue(AsyncValue value) { diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index 3eac52cf8..1d07a643e 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -152,7 +152,7 @@ abstract base class $ClassProvider< // ClassProviderElement< // NotifierT, StateT, - CreatedT> $createElement(ProviderContainer container); + CreatedT> $createElement($ProviderPointer pointer); } @internal @@ -163,7 +163,7 @@ abstract class ClassProviderElement< // StateT, CreatedT> // extends ProviderElement { - ClassProviderElement(super.container); + ClassProviderElement(super.pointer); @override $ClassProvider> get provider; diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index ac9a2b2d2..2a0e16e12 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -56,14 +56,13 @@ abstract base class ProviderBase extends ProviderOrFamily void Function(StateT? previous, StateT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, - required bool weak, required bool fireImmediately, }) { onError ??= Zone.current.handleUncaughtError; final element = node.readProviderElement(this); - if (!weak) element.flush(); + if (!node.weak) element.flush(); if (fireImmediately) { _handleFireImmediately( @@ -100,7 +99,7 @@ abstract base class ProviderBase extends ProviderOrFamily /// An internal method that defines how a provider behaves. @visibleForOverriding - ProviderElement $createElement(ProviderContainer container); + ProviderElement $createElement($ProviderPointer pointer); @override String toString() { diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 9d55f91e2..4f1fe72b4 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -15,16 +15,19 @@ abstract class _PointerBase { } @internal -class ProviderPointer implements _PointerBase { - ProviderPointer({ +class $ProviderPointer implements _PointerBase { + $ProviderPointer({ required this.providerOverride, required this.targetContainer, + required this.origin, }); @override bool get isTransitiveOverride => providerOverride is TransitiveProviderOverride; + final ProviderBase origin; + /// The override associated with this provider, if any. /// /// If non-null, this pointer should **never** be removed. @@ -125,7 +128,7 @@ class ProviderDirectory implements _PointerBase { /// This override may be implicitly created by [ProviderOrFamily.allTransitiveDependencies]. // ignore: library_private_types_in_public_api, not public API _FamilyOverride? familyOverride; - final HashMap, ProviderPointer> pointers; + final HashMap, $ProviderPointer> pointers; @override ProviderContainer targetContainer; @@ -136,13 +139,14 @@ class ProviderDirectory implements _PointerBase { }) { final origin = override.origin; - pointers[origin] = ProviderPointer( + pointers[origin] = $ProviderPointer( targetContainer: targetContainer, providerOverride: override, + origin: origin, ); } - ProviderPointer upsertPointer( + $ProviderPointer upsertPointer( ProviderBase provider, { required ProviderContainer currentContainer, }) { @@ -151,11 +155,12 @@ class ProviderDirectory implements _PointerBase { currentContainer: currentContainer, targetContainer: targetContainer, inherit: (target) => target._pointerManager.upsertPointer(provider), - scope: ({override}) => ProviderPointer( + scope: ({override}) => $ProviderPointer( targetContainer: currentContainer, providerOverride: override == null || provider.from != null // ? null : TransitiveProviderOverride(override), + origin: provider, ), ); } @@ -166,7 +171,7 @@ class ProviderDirectory implements _PointerBase { /// are mounted in the current container. /// /// Non-overridden providers are mounted in the root container. - ProviderPointer mount( + $ProviderPointer mount( ProviderBase origin, { required ProviderContainer currentContainer, }) { @@ -181,16 +186,15 @@ class ProviderDirectory implements _PointerBase { switch ((pointer.providerOverride, familyOverride)) { // The provider is overridden. This takes over any family override case (final override?, _): - element = - override.providerOverride.$createElement(pointer.targetContainer); + element = override.providerOverride.$createElement(pointer); // The family was overridden using overrideWith & co. case (null, final $FamilyOverride override): - element = override.createElement(pointer.targetContainer, origin); + element = override.createElement(pointer); // Either the provider wasn't overridden or it was scoped. case (null, _FamilyOverride() || null): - element = origin.$createElement(pointer.targetContainer); + element = origin.$createElement(pointer); } /// Assigning the element before calling "mount" to guarantee @@ -199,8 +203,6 @@ class ProviderDirectory implements _PointerBase { /// initialize the provider again. /// This has otherwise no impact unless there is a bug. pointer.element = element; - - element._origin = origin; } return pointer; @@ -240,7 +242,7 @@ class ProviderDirectory implements _PointerBase { /// introduce a level of indirection by storing a [Map]. /// /// Then, when overriding a provider, it is guaranteed that the [ProviderContainer] -/// and all of its children have the same [ProviderPointer] for a overridden provider. +/// and all of its children have the same [$ProviderPointer] for a overridden provider. /// /// This way, we can read an overridden provider from any of the [ProviderContainer]s. /// And no-matter where the first read is made, all [ProviderContainer]s will @@ -440,7 +442,7 @@ class ProviderPointerManager { } } - ProviderPointer? readPointer(ProviderBase provider) { + $ProviderPointer? readPointer(ProviderBase provider) { return readDirectory(provider)?.pointers[provider]; } @@ -458,7 +460,7 @@ class ProviderPointerManager { } } - ProviderPointer upsertPointer(ProviderBase provider) { + $ProviderPointer upsertPointer(ProviderBase provider) { return upsertDirectory(provider).mount( provider, currentContainer: container, @@ -470,7 +472,7 @@ class ProviderPointerManager { } /// Traverse the [ProviderElement]s associated with this [ProviderContainer]. - Iterable listProviderPointers() { + Iterable<$ProviderPointer> listProviderPointers() { return orphanPointers.pointers.values .where((pointer) => pointer.targetContainer == container) .followedBy( @@ -493,7 +495,7 @@ class ProviderPointerManager { /// Noop if the provider is from an override or doesn't exist. /// /// Returns the associated pointer, even if it was not removed. - ProviderPointer? remove(ProviderBase provider) { + $ProviderPointer? remove(ProviderBase provider) { final directory = readDirectory(provider); if (directory == null) return null; @@ -562,7 +564,7 @@ class ProviderPointerManager { /// This will automatically dispose the container at the end of the test. /// {@endtemplate} @sealed -class ProviderContainer implements Node { +class ProviderContainer implements WrappedNode { /// {@macro riverpod.provider_container} ProviderContainer({ ProviderContainer? parent, @@ -754,11 +756,10 @@ class ProviderContainer implements Node { void Function(Object error, StackTrace stackTrace)? onError, }) { return provider.addListener( - this, + weak ? WeakNode(this) : this, listener, fireImmediately: fireImmediately, onError: onError, - weak: weak, onDependencyMayHaveChanged: null, ); } @@ -797,7 +798,7 @@ class ProviderContainer implements Node { void _recursivePointerRemoval( ProviderBase provider, - ProviderPointer pointer, + $ProviderPointer pointer, ) { for (final child in _children) { final childPointer = child._pointerManager.readPointer(provider); diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index fd422971f..c555e20ca 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -5,9 +5,9 @@ part of '../framework.dart'; abstract base class ProviderSubscription { /// Represents the subscription to a [ProviderListenable] ProviderSubscription(this.source) { - final Object listener = source; - if (listener is ProviderElement) { - final subs = listener._subscriptions ??= []; + final source = this.source; + if (source is ProviderElement) { + final subs = source._subscriptions ??= []; subs.add(this); } } @@ -52,8 +52,13 @@ final class _ProviderStateSubscription required this.listener, required this.onError, }) { - final dependents = listenedElement._dependents ??= []; - dependents.add(this); + switch (source) { + case WeakNode(): + listenedElement._weakDependents.add(this); + case _: + final dependents = listenedElement._dependents ??= []; + dependents.add(this); + } } // Why can't this be typed correctly? @@ -74,7 +79,12 @@ final class _ProviderStateSubscription @override void close() { if (!closed) { - listenedElement._dependents?.remove(this); + switch (source) { + case WeakNode(): + listenedElement._weakDependents.remove(this); + case _: + listenedElement._dependents?.remove(this); + } listenedElement._onRemoveListener(); } diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index f4ef10ba6..0ae223b57 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -81,7 +81,6 @@ class ProviderElementProxy required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, - required bool weak, }) { final element = node.readProviderElement(provider); @@ -94,7 +93,6 @@ class ProviderElementProxy final innerSub = node.listen( provider, (prev, next) {}, - weak: weak, fireImmediately: false, onError: null, ); diff --git a/packages/riverpod/lib/src/core/scheduler.dart b/packages/riverpod/lib/src/core/scheduler.dart index 27ed24a74..38a4fa33a 100644 --- a/packages/riverpod/lib/src/core/scheduler.dart +++ b/packages/riverpod/lib/src/core/scheduler.dart @@ -128,7 +128,7 @@ class ProviderScheduler { element.container._disposed) { continue; } - element.container._disposeProvider(element._origin); + element.container._disposeProvider(element.origin); } } diff --git a/packages/riverpod/test/src/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart index 7d83f92e9..631820e92 100644 --- a/packages/riverpod/test/src/core/provider_element_test.dart +++ b/packages/riverpod/test/src/core/provider_element_test.dart @@ -98,9 +98,13 @@ void main() { final dependent2 = Provider((ref) { ref.listen(provider, (_, __) {}); }); + final dependent3 = Provider((ref) { + ref.listen(provider, (_, __) {}, weak: true); + }); container.read(dependent); container.read(dependent2); + container.read(dependent3); final children = []; @@ -108,6 +112,7 @@ void main() { elementVisitor: children.add, listenableVisitor: (_) {}, ); + expect( children, unorderedMatches([ @@ -115,12 +120,81 @@ void main() { .having((e) => e.provider, 'provider', dependent), isA() .having((e) => e.provider, 'provider', dependent2), + isA() + .having((e) => e.provider, 'provider', dependent3), ]), ); }); }); + group('isActive', () { + test('rejects weak listeners', () { + final provider = Provider((ref) => 0); + final container = ProviderContainer.test(); + + final element = container.readProviderElement(provider); + + expect(element.isActive, false); + + container.listen(provider, weak: true, (_, __) {}); + + expect(element.isActive, false); + }); + + test('includes provider listeners', () async { + final provider = Provider((ref) => 0); + final dep = Provider((ref) { + ref.listen(provider, (prev, value) {}); + }); + final container = ProviderContainer.test(); + + expect(container.readProviderElement(provider).isActive, false); + + container.read(dep); + + expect(container.readProviderElement(provider).isActive, true); + }); + + test('includes provider dependents', () async { + final provider = Provider((ref) => 0); + final dep = Provider((ref) { + ref.watch(provider); + }); + final container = ProviderContainer.test(); + + expect(container.readProviderElement(provider).isActive, false); + + container.read(dep); + + expect(container.readProviderElement(provider).isActive, true); + }); + + test('includes container listeners', () async { + final provider = Provider((ref) => 0); + final container = ProviderContainer.test(); + + expect(container.readProviderElement(provider).isActive, false); + + container.listen(provider, (_, __) {}); + + expect(container.readProviderElement(provider).isActive, true); + }); + }); + group('hasListeners', () { + test('includes weak listeners', () { + final provider = Provider((ref) => 0); + final container = ProviderContainer.test(); + + final element = container.readProviderElement(provider); + + expect(element.hasListeners, false); + + container.listen(provider, weak: true, (_, __) {}); + + expect(element.hasListeners, true); + }); + test('includes provider listeners', () async { final provider = Provider((ref) => 0); final dep = Provider((ref) { From d8001c12f8479365a3546777317f1679b232c08d Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 16 Mar 2024 12:47:59 +0100 Subject: [PATCH 301/387] Fix --- examples/pub/lib/detail.g.dart | 12 +-- examples/pub/lib/search.g.dart | 4 +- .../legacy/change_notifier_provider.dart | 6 +- packages/riverpod/lib/src/core/element.dart | 2 + .../lib/src/core/provider_subscription.dart | 1 + packages/riverpod/lib/src/core/scheduler.dart | 12 ++- .../test/src/core/auto_dispose_test.dart | 40 +++++++- .../test/src/core/modifiers/future_test.dart | 26 ++++++ .../test/src/core/modifiers/select_test.dart | 26 ++++++ packages/riverpod/test/src/core/ref_test.dart | 16 +++- .../integration/build_yaml/lib/main.g.dart | 36 ++++---- .../lib/src/templates/family.dart | 8 +- .../test/integration/annotated.g.dart | 20 ++-- .../test/integration/async.g.dart | 36 ++++---- .../test/integration/auto_dispose.g.dart | 12 +-- .../test/integration/dependencies.g.dart | 20 ++-- .../test/integration/dependencies2.g.dart | 14 +-- .../test/integration/documented.g.dart | 12 +-- .../test/integration/generated.g.dart | 40 ++++---- .../test/integration/scopes.g.dart | 8 +- .../test/integration/stream.g.dart | 24 ++--- .../test/integration/sync.g.dart | 92 +++++++++---------- .../generated/golden/lib/sync.g.dart | 12 +-- ..._class_based_provider_to_functional.g.dart | 16 ++-- ..._functional_provider_to_class_based.g.dart | 4 +- .../avoid_build_context_in_providers.g.dart | 12 +-- .../avoid_public_notifier_properties.g.dart | 8 +- .../functional_ref/functional_ref.g.dart | 16 ++-- .../test/lints/notifier_extends.g.dart | 32 +++---- .../protected_notifier_properties.g.dart | 48 +++++----- .../missing_dependencies.g.dart | 4 +- .../missing_dependencies2.g.dart | 8 +- .../test/lints/provider_parameters.g.dart | 4 +- .../docs/concepts/about_codegen/main.g.dart | 4 +- .../about_codegen/provider_type/family.g.dart | 4 +- .../provider_type/family_class.g.dart | 8 +- .../provider_type/family_fn.g.dart | 4 +- .../invalidate_family_example/codegen.g.dart | 4 +- .../passing_args/family/codegen.g.dart | 12 +-- .../docs/from_provider/family/family.g.dart | 4 +- .../introduction/why_riverpod/codegen.g.dart | 4 +- .../family_and_dispose.g.dart | 8 +- 42 files changed, 393 insertions(+), 290 deletions(-) diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 56f66131e..a01951ab3 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -122,8 +122,8 @@ final class FetchPackageDetailsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FetchPackageDetailsProvider; + createElement: (pointer) { + final provider = pointer.origin as FetchPackageDetailsProvider; final argument = provider.argument as String; @@ -381,8 +381,8 @@ final class PackageMetricsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as PackageMetricsProvider; + createElement: (pointer) { + final provider = pointer.origin as PackageMetricsProvider; final argument = provider.argument as String; @@ -403,8 +403,8 @@ final class PackageMetricsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as PackageMetricsProvider; + createElement: (pointer) { + final provider = pointer.origin as PackageMetricsProvider; final argument = provider.argument as String; diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 7f1bff945..9dbe12eac 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -143,8 +143,8 @@ final class FetchPackagesFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FetchPackagesProvider; + createElement: (pointer) { + final provider = pointer.origin as FetchPackagesProvider; final argument = provider.argument as ({ int page, 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 index 15fd2be27..b2d83848e 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -240,8 +240,8 @@ class ChangeNotifierProviderFamily ) { return $FamilyOverride( from: this, - createElement: (container, provider) { - provider as ChangeNotifierProvider; + createElement: (pointer) { + final provider = pointer.origin as ChangeNotifierProvider; return ChangeNotifierProvider.internal( (ref) => create(ref, provider.argument as Arg), @@ -251,7 +251,7 @@ class ChangeNotifierProviderFamily dependencies: null, allTransitiveDependencies: null, name: null, - ).$createElement(container); + ).$createElement(pointer); }, ); } diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index bed929f28..08f4764d4 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -697,6 +697,8 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu @mustCallSuper void dispose() { runOnDispose(); + _didMount = false; + _stateResult = null; ref = null; for (final sub in _dependencies.entries) { diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index c555e20ca..ec31da396 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -73,6 +73,7 @@ final class _ProviderStateSubscription 'called ProviderSubscription.read on a subscription that was closed', ); } + listenedElement._mayNeedDispose(); return listenedElement.readSelf(); } diff --git a/packages/riverpod/lib/src/core/scheduler.dart b/packages/riverpod/lib/src/core/scheduler.dart index 38a4fa33a..dcba47849 100644 --- a/packages/riverpod/lib/src/core/scheduler.dart +++ b/packages/riverpod/lib/src/core/scheduler.dart @@ -124,11 +124,17 @@ class ProviderScheduler { final links = element.ref?._keepAliveLinks; if ((links != null && links.isNotEmpty) || - element.isActive || - element.container._disposed) { + element.container._disposed || + element.isActive) { continue; } - element.container._disposeProvider(element.origin); + + if (!element.hasListeners) { + element.container._disposeProvider(element.origin); + } else { + // Don't delete the pointer if there are some "weak" listeners active. + element.dispose(); + } } } diff --git a/packages/riverpod/test/src/core/auto_dispose_test.dart b/packages/riverpod/test/src/core/auto_dispose_test.dart index 6eb4b7c07..9bb044106 100644 --- a/packages/riverpod/test/src/core/auto_dispose_test.dart +++ b/packages/riverpod/test/src/core/auto_dispose_test.dart @@ -1,7 +1,5 @@ import 'package:mockito/mockito.dart'; -import 'package:riverpod/legacy.dart'; -import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/framework.dart'; +import 'package:riverpod/src/internals.dart'; import 'package:test/test.dart'; import '../utils.dart'; @@ -9,6 +7,42 @@ import 'provider_container_test.dart'; void main() { group('AutoDispose', () { + test('Supports clearing the state of elements with only weak listeners', + () async { + final container = ProviderContainer.test(); + final onDispose = OnDisposeMock(); + var buildCount = 0; + final provider = Provider.autoDispose((ref) { + buildCount++; + ref.onDispose(onDispose.call); + return 0; + }); + + final element = container.readProviderElement(provider); + + final sub = container.listen( + provider, + weak: true, + (previous, value) {}, + ); + + expect(sub.read(), 0); + expect(buildCount, 1); + verifyZeroInteractions(onDispose); + + await container.pump(); + + verifyOnly(onDispose, onDispose()); + + expect(buildCount, 1); + expect(container.readProviderElement(provider), same(element)); + expect(element.stateResult, null); + + expect(sub.read(), 0); + expect(element.stateResult, ResultData(0)); + expect(buildCount, 2); + }); + test( 'onDispose is triggered only once if within autoDispose unmount, a dependency changed', () async { diff --git a/packages/riverpod/test/src/core/modifiers/future_test.dart b/packages/riverpod/test/src/core/modifiers/future_test.dart index db961a56d..e9c259c36 100644 --- a/packages/riverpod/test/src/core/modifiers/future_test.dart +++ b/packages/riverpod/test/src/core/modifiers/future_test.dart @@ -7,6 +7,32 @@ import '../../utils.dart'; void main() { group('provider.future', () { group('handles listen(weak: true)', () { + test( + 'calls mayNeedDispose in ProviderSubscription.read for the sake of listen(weak: true)', + () async { + final container = ProviderContainer.test(); + final onDispose = OnDisposeMock(); + final provider = FutureProvider.autoDispose((ref) { + ref.onDispose(onDispose.call); + return 0; + }); + + final element = container.readProviderElement(provider); + + final sub = container.listen( + provider.future, + weak: true, + (previous, value) {}, + ); + + expect(sub.read(), completion(0)); + verifyZeroInteractions(onDispose); + + await container.pump(); + + verifyOnly(onDispose, onDispose()); + }); + test('common use-case ', () async { var buildCount = 0; final provider = FutureProvider((ref) { diff --git a/packages/riverpod/test/src/core/modifiers/select_test.dart b/packages/riverpod/test/src/core/modifiers/select_test.dart index b55e50a9d..015e831c7 100644 --- a/packages/riverpod/test/src/core/modifiers/select_test.dart +++ b/packages/riverpod/test/src/core/modifiers/select_test.dart @@ -29,6 +29,32 @@ void main() { }); group('handles listen(weak: true)', () { + test( + 'calls mayNeedDispose in ProviderSubscription.read for the sake of listen(weak: true)', + () async { + final container = ProviderContainer.test(); + final onDispose = OnDisposeMock(); + final provider = Provider.autoDispose((ref) { + ref.onDispose(onDispose.call); + return 0; + }); + + final element = container.readProviderElement(provider); + + final sub = container.listen( + provider.select((value) => value), + weak: true, + (previous, value) {}, + ); + + expect(sub.read(), 0); + verifyZeroInteractions(onDispose); + + await container.pump(); + + verifyOnly(onDispose, onDispose()); + }); + test('common use-case ', () { final provider = StateProvider((ref) => 'Hello'); final container = ProviderContainer.test(); diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 3ffc0921e..2534b194d 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -924,12 +924,18 @@ void main() { throw UnimplementedError(); }); - test('does not count towards the pause mechanism', () { - throw UnimplementedError(); - }); + test('does not count towards the pause mechanism', () async { + final container = ProviderContainer.test(); - test('does not interfere with autoDispose', () { - throw UnimplementedError(); + final listener = Listener(); + final provider = Provider((ref) => Object()); + + container.listen(provider, weak: true, listener.call); + container.invalidate(provider); + + await container.pump(); + + verifyZeroInteractions(listener); }); }); diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 0143d0d5f..d3ca39a5b 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -480,8 +480,8 @@ final class Count2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as Count2Provider; + createElement: (pointer) { + final provider = pointer.origin as Count2Provider; final argument = provider.argument as int; @@ -604,8 +604,8 @@ final class CountFuture2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as CountFuture2Provider; + createElement: (pointer) { + final provider = pointer.origin as CountFuture2Provider; final argument = provider.argument as int; @@ -728,8 +728,8 @@ final class CountStream2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as CountStream2Provider; + createElement: (pointer) { + final provider = pointer.origin as CountStream2Provider; final argument = provider.argument as int; @@ -855,8 +855,8 @@ final class CountNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as CountNotifier2Provider; + createElement: (pointer) { + final provider = pointer.origin as CountNotifier2Provider; final argument = provider.argument as int; @@ -873,8 +873,8 @@ final class CountNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as CountNotifier2Provider; + createElement: (pointer) { + final provider = pointer.origin as CountNotifier2Provider; final argument = provider.argument as int; @@ -1007,8 +1007,8 @@ final class CountAsyncNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as CountAsyncNotifier2Provider; + createElement: (pointer) { + final provider = pointer.origin as CountAsyncNotifier2Provider; final argument = provider.argument as int; @@ -1027,8 +1027,8 @@ final class CountAsyncNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as CountAsyncNotifier2Provider; + createElement: (pointer) { + final provider = pointer.origin as CountAsyncNotifier2Provider; final argument = provider.argument as int; @@ -1162,8 +1162,8 @@ final class CountStreamNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as CountStreamNotifier2Provider; + createElement: (pointer) { + final provider = pointer.origin as CountStreamNotifier2Provider; final argument = provider.argument as int; @@ -1182,8 +1182,8 @@ final class CountStreamNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as CountStreamNotifier2Provider; + createElement: (pointer) { + final provider = pointer.origin as CountStreamNotifier2Provider; final argument = provider.argument as int; diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index ef1b42da3..b26c13581 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -106,8 +106,8 @@ ${provider.doc} final class ${provider.familyTypeName} extends Family { Override overrideWith($createType create,) { return \$FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ${provider.providerTypeName}; + createElement: (pointer) { + final provider = pointer.origin as ${provider.providerTypeName}; '''); switch (( @@ -184,8 +184,8 @@ ${provider.createdTypeDisplayString} Function$_genericsDefinition( Override overrideWithBuild($runNotifierBuildType build,) { return \$FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ${provider.providerTypeName}; + createElement: (pointer) { + final provider = pointer.origin as ${provider.providerTypeName}; '''); switch (( diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index c8931efeb..0803875a4 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -127,8 +127,8 @@ final class FunctionalFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FunctionalProvider; + createElement: (pointer) { + final provider = pointer.origin as FunctionalProvider; final argument = provider.argument as int; @@ -256,8 +256,8 @@ final class ClassBasedFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ClassBasedProvider; + createElement: (pointer) { + final provider = pointer.origin as ClassBasedProvider; final argument = provider.argument as int; @@ -274,8 +274,8 @@ final class ClassBasedFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ClassBasedProvider; + createElement: (pointer) { + final provider = pointer.origin as ClassBasedProvider; final argument = provider.argument as int; @@ -423,8 +423,8 @@ final class FamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyProvider; final argument = provider.argument as int; @@ -685,8 +685,8 @@ final class NotCopiedFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as NotCopiedFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as NotCopiedFamilyProvider; final argument = provider.argument as int; diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 58231d10e..b3125e6e2 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -109,8 +109,8 @@ final class GenericFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GenericProvider; + createElement: (pointer) { + final provider = pointer.origin as GenericProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -235,8 +235,8 @@ final class GenericClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GenericClassProvider; + createElement: (pointer) { + final provider = pointer.origin as GenericClassProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -251,8 +251,8 @@ final class GenericClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GenericClassProvider; + createElement: (pointer) { + final provider = pointer.origin as GenericClassProvider; return provider._copyWithBuild(build).$createElement(pointer); }, @@ -482,8 +482,8 @@ final class FamilyOrFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyOrProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyOrProvider; final argument = provider.argument as int; @@ -657,8 +657,8 @@ final class FamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyProvider; final argument = provider.argument as ( int, { @@ -904,8 +904,8 @@ final class FamilyOrClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyOrClassProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyOrClassProvider; final argument = provider.argument as int; @@ -924,8 +924,8 @@ final class FamilyOrClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyOrClassProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyOrClassProvider; final argument = provider.argument as int; @@ -1092,8 +1092,8 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyClassProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyClassProvider; final argument = provider.argument as ( int, { @@ -1126,8 +1126,8 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyClassProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyClassProvider; final argument = provider.argument as ( int, { diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index dcaae6085..57fe545af 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -301,8 +301,8 @@ final class KeepAliveFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as KeepAliveFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as KeepAliveFamilyProvider; final argument = provider.argument as int; @@ -433,8 +433,8 @@ final class NotKeepAliveFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as NotKeepAliveFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as NotKeepAliveFamilyProvider; final argument = provider.argument as int; @@ -566,8 +566,8 @@ final class DefaultKeepAliveFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as DefaultKeepAliveFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as DefaultKeepAliveFamilyProvider; final argument = provider.argument as int; diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index fe55a14b9..ac5166c0d 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -183,8 +183,8 @@ final class FamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyProvider; final argument = provider.argument as int; @@ -377,8 +377,8 @@ final class Family2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as Family2Provider; + createElement: (pointer) { + final provider = pointer.origin as Family2Provider; final argument = provider.argument as int; @@ -395,8 +395,8 @@ final class Family2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as Family2Provider; + createElement: (pointer) { + final provider = pointer.origin as Family2Provider; final argument = provider.argument as int; @@ -781,8 +781,8 @@ final class Provider4Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as Provider4Provider; + createElement: (pointer) { + final provider = pointer.origin as Provider4Provider; final argument = provider.argument as int; @@ -799,8 +799,8 @@ final class Provider4Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as Provider4Provider; + createElement: (pointer) { + final provider = pointer.origin as Provider4Provider; final argument = provider.argument as int; diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index f5102b835..11bf3d57c 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -224,8 +224,8 @@ final class FamilyWithDependencies2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyWithDependencies2Provider; + createElement: (pointer) { + final provider = pointer.origin as FamilyWithDependencies2Provider; final argument = provider.argument as int?; @@ -463,8 +463,9 @@ final class NotifierFamilyWithDependenciesFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as NotifierFamilyWithDependenciesProvider; + createElement: (pointer) { + final provider = + pointer.origin as NotifierFamilyWithDependenciesProvider; final argument = provider.argument as int?; @@ -483,8 +484,9 @@ final class NotifierFamilyWithDependenciesFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as NotifierFamilyWithDependenciesProvider; + createElement: (pointer) { + final provider = + pointer.origin as NotifierFamilyWithDependenciesProvider; final argument = provider.argument as int?; diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index 7d7131f8c..6a03f56d3 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -277,8 +277,8 @@ final class FamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyProvider; final argument = provider.argument as int; @@ -414,8 +414,8 @@ final class ClassFamilyBasedFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ClassFamilyBasedProvider; + createElement: (pointer) { + final provider = pointer.origin as ClassFamilyBasedProvider; final argument = provider.argument as int; @@ -433,8 +433,8 @@ final class ClassFamilyBasedFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ClassFamilyBasedProvider; + createElement: (pointer) { + final provider = pointer.origin as ClassFamilyBasedProvider; final argument = provider.argument as int; diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 1069dd857..487a05e10 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -183,8 +183,8 @@ final class GeneratedFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GeneratedFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as GeneratedFamilyProvider; final argument = provider.argument as _Test; @@ -380,8 +380,8 @@ final class GeneratedClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GeneratedClassFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as GeneratedClassFamilyProvider; final argument = provider.argument as _Test; @@ -400,8 +400,8 @@ final class GeneratedClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GeneratedClassFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as GeneratedClassFamilyProvider; final argument = provider.argument as _Test; @@ -604,8 +604,8 @@ final class $DynamicFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as $DynamicFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as $DynamicFamilyProvider; final argument = provider.argument as dynamic; @@ -801,8 +801,8 @@ final class $DynamicClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as $DynamicClassFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as $DynamicClassFamilyProvider; final argument = provider.argument as dynamic; @@ -821,8 +821,8 @@ final class $DynamicClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as $DynamicClassFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as $DynamicClassFamilyProvider; final argument = provider.argument as dynamic; @@ -966,8 +966,8 @@ final class _DynamicFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as _DynamicProvider; + createElement: (pointer) { + final provider = pointer.origin as _DynamicProvider; final argument = provider.argument as dynamic; @@ -1160,8 +1160,8 @@ final class AliasFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as AliasFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as AliasFamilyProvider; final argument = provider.argument as r.AsyncValue; @@ -1356,8 +1356,8 @@ final class AliasClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as AliasClassFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as AliasClassFamilyProvider; final argument = provider.argument as r.AsyncValue; @@ -1376,8 +1376,8 @@ final class AliasClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as AliasClassFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as AliasClassFamilyProvider; final argument = provider.argument as r.AsyncValue; diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 5c8c2e63e..79d772a15 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -188,8 +188,8 @@ final class ScopedClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ScopedClassFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as ScopedClassFamilyProvider; final argument = provider.argument as int; @@ -206,8 +206,8 @@ final class ScopedClassFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ScopedClassFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as ScopedClassFamilyProvider; final argument = provider.argument as int; diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index d765dcb95..e7c2a5a83 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -109,8 +109,8 @@ final class GenericFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GenericProvider; + createElement: (pointer) { + final provider = pointer.origin as GenericProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -235,8 +235,8 @@ final class GenericClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GenericClassProvider; + createElement: (pointer) { + final provider = pointer.origin as GenericClassProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -251,8 +251,8 @@ final class GenericClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GenericClassProvider; + createElement: (pointer) { + final provider = pointer.origin as GenericClassProvider; return provider._copyWithBuild(build).$createElement(pointer); }, @@ -533,8 +533,8 @@ final class FamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyProvider; final argument = provider.argument as ( int, { @@ -815,8 +815,8 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyClassProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyClassProvider; final argument = provider.argument as ( int, { @@ -849,8 +849,8 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyClassProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyClassProvider; final argument = provider.argument as ( int, { diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index f9823ddf5..37d8308a4 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -117,8 +117,8 @@ final class GenericFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GenericProvider; + createElement: (pointer) { + final provider = pointer.origin as GenericProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -284,8 +284,8 @@ final class ComplexGenericFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ComplexGenericProvider; + createElement: (pointer) { + final provider = pointer.origin as ComplexGenericProvider; return provider._copyWithCreate(( ref, { @@ -427,8 +427,8 @@ final class GenericClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GenericClassProvider; + createElement: (pointer) { + final provider = pointer.origin as GenericClassProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -442,8 +442,8 @@ final class GenericClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GenericClassProvider; + createElement: (pointer) { + final provider = pointer.origin as GenericClassProvider; return provider._copyWithBuild(build).$createElement(pointer); }, @@ -838,8 +838,8 @@ final class RawFamilyFutureFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as RawFamilyFutureProvider; + createElement: (pointer) { + final provider = pointer.origin as RawFamilyFutureProvider; final argument = provider.argument as int; @@ -971,8 +971,8 @@ final class RawFamilyStreamFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as RawFamilyStreamProvider; + createElement: (pointer) { + final provider = pointer.origin as RawFamilyStreamProvider; final argument = provider.argument as int; @@ -1099,8 +1099,8 @@ final class RawFamilyFutureClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as RawFamilyFutureClassProvider; + createElement: (pointer) { + final provider = pointer.origin as RawFamilyFutureClassProvider; final argument = provider.argument as int; @@ -1119,8 +1119,8 @@ final class RawFamilyFutureClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as RawFamilyFutureClassProvider; + createElement: (pointer) { + final provider = pointer.origin as RawFamilyFutureClassProvider; final argument = provider.argument as int; @@ -1261,8 +1261,8 @@ final class RawFamilyStreamClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as RawFamilyStreamClassProvider; + createElement: (pointer) { + final provider = pointer.origin as RawFamilyStreamClassProvider; final argument = provider.argument as int; @@ -1281,8 +1281,8 @@ final class RawFamilyStreamClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as RawFamilyStreamClassProvider; + createElement: (pointer) { + final provider = pointer.origin as RawFamilyStreamClassProvider; final argument = provider.argument as int; @@ -1605,8 +1605,8 @@ final class FamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyProvider; final argument = provider.argument as ( int, { @@ -1976,8 +1976,8 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyClassProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyClassProvider; final argument = provider.argument as ( int, { @@ -2010,8 +2010,8 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyClassProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyClassProvider; final argument = provider.argument as ( int, { @@ -2174,8 +2174,8 @@ final class Supports$InFnNameFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as Supports$InFnNameProvider; + createElement: (pointer) { + final provider = pointer.origin as Supports$InFnNameProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -2354,8 +2354,8 @@ final class Supports$InFnNameFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as Supports$InFnNameFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as Supports$InFnNameFamilyProvider; return provider._copyWithCreate(( ref, @@ -2503,8 +2503,8 @@ final class Supports$InClassNameFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as Supports$InClassNameProvider; + createElement: (pointer) { + final provider = pointer.origin as Supports$InClassNameProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -2519,8 +2519,8 @@ final class Supports$InClassNameFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as Supports$InClassNameProvider; + createElement: (pointer) { + final provider = pointer.origin as Supports$InClassNameProvider; return provider._copyWithBuild(build).$createElement(pointer); }, @@ -2705,8 +2705,8 @@ final class Supports$InClassFamilyNameFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as Supports$InClassFamilyNameProvider; + createElement: (pointer) { + final provider = pointer.origin as Supports$InClassFamilyNameProvider; return provider._copyWithCreate(() { final argument = provider.argument as ( @@ -2735,8 +2735,8 @@ final class Supports$InClassFamilyNameFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as Supports$InClassFamilyNameProvider; + createElement: (pointer) { + final provider = pointer.origin as Supports$InClassFamilyNameProvider; return provider._copyWithBuild((ref, notifier) { final argument = provider.argument as ( @@ -2953,8 +2953,8 @@ final class UnnecessaryCastFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as UnnecessaryCastProvider; + createElement: (pointer) { + final provider = pointer.origin as UnnecessaryCastProvider; final argument = provider.argument; @@ -3081,8 +3081,8 @@ final class UnnecessaryCastClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as UnnecessaryCastClassProvider; + createElement: (pointer) { + final provider = pointer.origin as UnnecessaryCastClassProvider; final argument = provider.argument; @@ -3101,8 +3101,8 @@ final class UnnecessaryCastClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as UnnecessaryCastClassProvider; + createElement: (pointer) { + final provider = pointer.origin as UnnecessaryCastClassProvider; final argument = provider.argument; @@ -3256,8 +3256,8 @@ final class ManyDataStreamFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ManyDataStreamProvider; + createElement: (pointer) { + final provider = pointer.origin as ManyDataStreamProvider; return provider._copyWithCreate(( ref, diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 486c545c8..2ebe44d3a 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -307,8 +307,8 @@ final class FamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyProvider; final argument = provider.argument as ( int, { @@ -678,8 +678,8 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyClassProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyClassProvider; final argument = provider.argument as ( int, { @@ -712,8 +712,8 @@ final class FamilyClassFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyClassProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyClassProvider; final argument = provider.argument as ( int, { diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index 6c93d9b3a..de8818050 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -213,8 +213,8 @@ final class ExampleFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ExampleFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as ExampleFamilyProvider; final argument = provider.argument as ({ int a, @@ -241,8 +241,8 @@ final class ExampleFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ExampleFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as ExampleFamilyProvider; final argument = provider.argument as ({ int a, @@ -401,8 +401,8 @@ final class GenericFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GenericProvider; + createElement: (pointer) { + final provider = pointer.origin as GenericProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -415,8 +415,8 @@ final class GenericFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GenericProvider; + createElement: (pointer) { + final provider = pointer.origin as GenericProvider; return provider._copyWithBuild(build).$createElement(pointer); }, diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index fdb38120f..f304e4a6a 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -214,8 +214,8 @@ final class ExampleFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ExampleFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as ExampleFamilyProvider; final argument = provider.argument as ({ int a, diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 1895adefc..8016ee4ef 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -145,8 +145,8 @@ final class FnFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FnProvider; + createElement: (pointer) { + final provider = pointer.origin as FnProvider; final argument = provider.argument as ( BuildContext, { @@ -291,8 +291,8 @@ final class MyNotifierFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as MyNotifierProvider; + createElement: (pointer) { + final provider = pointer.origin as MyNotifierProvider; final argument = provider.argument as ( BuildContext, { @@ -319,8 +319,8 @@ final class MyNotifierFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as MyNotifierProvider; + createElement: (pointer) { + final provider = pointer.origin as MyNotifierProvider; final argument = provider.argument as ( BuildContext, { diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index c866b556d..8fea76279 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -120,8 +120,8 @@ final class GeneratedNotifierFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GeneratedNotifierProvider; + createElement: (pointer) { + final provider = pointer.origin as GeneratedNotifierProvider; final argument = provider.argument as int; @@ -138,8 +138,8 @@ final class GeneratedNotifierFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GeneratedNotifierProvider; + createElement: (pointer) { + final provider = pointer.origin as GeneratedNotifierProvider; final argument = provider.argument as int; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 063cfc520..c8bea0cd4 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -178,8 +178,8 @@ final class GenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GenericsProvider; + createElement: (pointer) { + final provider = pointer.origin as GenericsProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -300,8 +300,8 @@ final class NoGenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as NoGenericsProvider; + createElement: (pointer) { + final provider = pointer.origin as NoGenericsProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -421,8 +421,8 @@ final class MissingGenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as MissingGenericsProvider; + createElement: (pointer) { + final provider = pointer.origin as MissingGenericsProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -542,8 +542,8 @@ final class WrongOrderFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as WrongOrderProvider; + createElement: (pointer) { + final provider = pointer.origin as WrongOrderProvider; return provider._copyWithCreate(create).$createElement(pointer); }, diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart index 096a36980..61e8b3022 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart @@ -404,8 +404,8 @@ final class GenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GenericsProvider; + createElement: (pointer) { + final provider = pointer.origin as GenericsProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -418,8 +418,8 @@ final class GenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GenericsProvider; + createElement: (pointer) { + final provider = pointer.origin as GenericsProvider; return provider._copyWithBuild(build).$createElement(pointer); }, @@ -559,8 +559,8 @@ final class NoGenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as NoGenericsProvider; + createElement: (pointer) { + final provider = pointer.origin as NoGenericsProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -574,8 +574,8 @@ final class NoGenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as NoGenericsProvider; + createElement: (pointer) { + final provider = pointer.origin as NoGenericsProvider; return provider._copyWithBuild(build).$createElement(pointer); }, @@ -717,8 +717,8 @@ final class MissingGenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as MissingGenericsProvider; + createElement: (pointer) { + final provider = pointer.origin as MissingGenericsProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -731,8 +731,8 @@ final class MissingGenericsFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as MissingGenericsProvider; + createElement: (pointer) { + final provider = pointer.origin as MissingGenericsProvider; return provider._copyWithBuild(build).$createElement(pointer); }, @@ -872,8 +872,8 @@ final class WrongOrderFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as WrongOrderProvider; + createElement: (pointer) { + final provider = pointer.origin as WrongOrderProvider; return provider._copyWithCreate(create).$createElement(pointer); }, @@ -886,8 +886,8 @@ final class WrongOrderFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as WrongOrderProvider; + createElement: (pointer) { + final provider = pointer.origin as WrongOrderProvider; return provider._copyWithBuild(build).$createElement(pointer); }, diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index f64001270..d0fe04acd 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -248,8 +248,8 @@ final class A3Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as A3Provider; + createElement: (pointer) { + final provider = pointer.origin as A3Provider; final argument = provider.argument as int; @@ -266,8 +266,8 @@ final class A3Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as A3Provider; + createElement: (pointer) { + final provider = pointer.origin as A3Provider; final argument = provider.argument as int; @@ -403,8 +403,8 @@ final class A4Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as A4Provider; + createElement: (pointer) { + final provider = pointer.origin as A4Provider; final argument = provider.argument as int; @@ -421,8 +421,8 @@ final class A4Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as A4Provider; + createElement: (pointer) { + final provider = pointer.origin as A4Provider; final argument = provider.argument as int; @@ -551,8 +551,8 @@ final class A5Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as A5Provider; + createElement: (pointer) { + final provider = pointer.origin as A5Provider; final argument = provider.argument as int; @@ -570,8 +570,8 @@ final class A5Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as A5Provider; + createElement: (pointer) { + final provider = pointer.origin as A5Provider; final argument = provider.argument as int; @@ -700,8 +700,8 @@ final class A6Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as A6Provider; + createElement: (pointer) { + final provider = pointer.origin as A6Provider; final argument = provider.argument as int; @@ -719,8 +719,8 @@ final class A6Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as A6Provider; + createElement: (pointer) { + final provider = pointer.origin as A6Provider; final argument = provider.argument as int; @@ -849,8 +849,8 @@ final class A7Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as A7Provider; + createElement: (pointer) { + final provider = pointer.origin as A7Provider; final argument = provider.argument as int; @@ -868,8 +868,8 @@ final class A7Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as A7Provider; + createElement: (pointer) { + final provider = pointer.origin as A7Provider; final argument = provider.argument as int; @@ -998,8 +998,8 @@ final class A8Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as A8Provider; + createElement: (pointer) { + final provider = pointer.origin as A8Provider; final argument = provider.argument as int; @@ -1017,8 +1017,8 @@ final class A8Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as A8Provider; + createElement: (pointer) { + final provider = pointer.origin as A8Provider; final argument = provider.argument as int; diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart index eb1a0a8a9..ffa3778cc 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart @@ -305,8 +305,8 @@ final class DepFamilyFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as DepFamilyProvider; + createElement: (pointer) { + final provider = pointer.origin as DepFamilyProvider; final argument = provider.argument as int; diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart index bdb43a8b0..b1b4d7a09 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart @@ -1087,8 +1087,8 @@ final class FamilyDepFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyDepProvider; + createElement: (pointer) { + final provider = pointer.origin as FamilyDepProvider; final argument = provider.argument as int; @@ -1225,8 +1225,8 @@ final class FamilyDep2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FamilyDep2Provider; + createElement: (pointer) { + final provider = pointer.origin as FamilyDep2Provider; final argument = provider.argument as int; diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 11870007b..103e6de3a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -124,8 +124,8 @@ final class GeneratorFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as GeneratorProvider; + createElement: (pointer) { + final provider = pointer.origin as GeneratorProvider; final argument = provider.argument; diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 7a59fb2ff..b88dde802 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -119,8 +119,8 @@ final class FetchUserFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FetchUserProvider; + createElement: (pointer) { + final provider = pointer.origin as FetchUserProvider; final argument = provider.argument as int; diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index f19235fe6..7a296856f 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -126,8 +126,8 @@ final class ExampleFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ExampleProvider; + createElement: (pointer) { + final provider = pointer.origin as ExampleProvider; final argument = provider.argument as int; diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index d31b7afef..7ceac8995 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -138,8 +138,8 @@ final class ExampleFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ExampleProvider; + createElement: (pointer) { + final provider = pointer.origin as ExampleProvider; final argument = provider.argument as ( int, { @@ -166,8 +166,8 @@ final class ExampleFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ExampleProvider; + createElement: (pointer) { + final provider = pointer.origin as ExampleProvider; final argument = provider.argument as ( int, { diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index abf99703a..8ea7d704a 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -147,8 +147,8 @@ final class ExampleFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ExampleProvider; + createElement: (pointer) { + final provider = pointer.origin as ExampleProvider; final argument = provider.argument as ( int, { diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index cf3ac7964..31089b0e5 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -126,8 +126,8 @@ final class LabelFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as LabelProvider; + createElement: (pointer) { + final provider = pointer.origin as LabelProvider; final argument = provider.argument as String; diff --git a/website/docs/essentials/passing_args/family/codegen.g.dart b/website/docs/essentials/passing_args/family/codegen.g.dart index cb2ba3594..01bb58677 100644 --- a/website/docs/essentials/passing_args/family/codegen.g.dart +++ b/website/docs/essentials/passing_args/family/codegen.g.dart @@ -119,8 +119,8 @@ final class ActivityFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ActivityProvider; + createElement: (pointer) { + final provider = pointer.origin as ActivityProvider; final argument = provider.argument as String; @@ -238,8 +238,8 @@ final class ActivityNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ActivityNotifier2Provider; + createElement: (pointer) { + final provider = pointer.origin as ActivityNotifier2Provider; final argument = provider.argument as String; @@ -258,8 +258,8 @@ final class ActivityNotifier2Family extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as ActivityNotifier2Provider; + createElement: (pointer) { + final provider = pointer.origin as ActivityNotifier2Provider; final argument = provider.argument as String; diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index 1ed93a3ec..064167f16 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -147,8 +147,8 @@ final class RandomFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as RandomProvider; + createElement: (pointer) { + final provider = pointer.origin as RandomProvider; final argument = provider.argument as ({ int seed, diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index ac257888d..c38aa9c43 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -143,8 +143,8 @@ final class FetchPackagesFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as FetchPackagesProvider; + createElement: (pointer) { + final provider = pointer.origin as FetchPackagesProvider; final argument = provider.argument as ({ int page, diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index 466508708..f07aa01a6 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -177,8 +177,8 @@ final class BugsEncounteredNotifierFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as BugsEncounteredNotifierProvider; + createElement: (pointer) { + final provider = pointer.origin as BugsEncounteredNotifierProvider; final argument = provider.argument as String; @@ -197,8 +197,8 @@ final class BugsEncounteredNotifierFamily extends Family { ) { return $FamilyOverride( from: this, - createElement: (pointer, provider) { - provider as BugsEncounteredNotifierProvider; + createElement: (pointer) { + final provider = pointer.origin as BugsEncounteredNotifierProvider; final argument = provider.argument as String; From 79662d2c09b7b732db32c2d6bfff959c730bbe0a Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 16 Mar 2024 12:56:08 +0100 Subject: [PATCH 302/387] Add test --- packages/riverpod/lib/src/core/element.dart | 2 -- .../test/src/core/modifiers/future_test.dart | 13 +++++++++++++ .../test/src/core/modifiers/select_test.dart | 16 ++++++++++++++++ packages/riverpod/test/src/core/ref_test.dart | 13 +++++++++++++ 4 files changed, 42 insertions(+), 2 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 08f4764d4..cc2ea4fb0 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -98,7 +98,6 @@ abstract class ProviderElement implements WrappedNode { /// Those subscriptions are separate from [ProviderElement._dependents] for a few reasons: /// - They do not count towards [ProviderElement.isActive]. /// - They may be reused between two instances of a [ProviderElement]. - // TODO keep the pointer alive until all weak dependents are disposed final _weakDependents = []; /// The element of the providers that depends on this provider. @@ -589,7 +588,6 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ref._throwIfInvalidUsage(); final result = listenable.addListener( - // TODO assert weak listeners are removed on dispose weak ? WeakNode(this) : this, listener, fireImmediately: fireImmediately, diff --git a/packages/riverpod/test/src/core/modifiers/future_test.dart b/packages/riverpod/test/src/core/modifiers/future_test.dart index e9c259c36..f308820cd 100644 --- a/packages/riverpod/test/src/core/modifiers/future_test.dart +++ b/packages/riverpod/test/src/core/modifiers/future_test.dart @@ -7,6 +7,19 @@ import '../../utils.dart'; void main() { group('provider.future', () { group('handles listen(weak: true)', () { + test('closing the subscription updated element.hasListeners', () { + final container = ProviderContainer.test(); + final provider = FutureProvider((ref) => 0); + + final sub = container.listen(provider.future, (previous, value) {}); + + expect(container.readProviderElement(provider).hasListeners, true); + + sub.close(); + + expect(container.readProviderElement(provider).hasListeners, false); + }); + test( 'calls mayNeedDispose in ProviderSubscription.read for the sake of listen(weak: true)', () async { diff --git a/packages/riverpod/test/src/core/modifiers/select_test.dart b/packages/riverpod/test/src/core/modifiers/select_test.dart index 015e831c7..46bc4fef6 100644 --- a/packages/riverpod/test/src/core/modifiers/select_test.dart +++ b/packages/riverpod/test/src/core/modifiers/select_test.dart @@ -29,6 +29,22 @@ void main() { }); group('handles listen(weak: true)', () { + test('closing the subscription updated element.hasListeners', () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => 0); + + final sub = container.listen( + provider.select((value) => 0), + (previous, value) {}, + ); + + expect(container.readProviderElement(provider).hasListeners, true); + + sub.close(); + + expect(container.readProviderElement(provider).hasListeners, false); + }); + test( 'calls mayNeedDispose in ProviderSubscription.read for the sake of listen(weak: true)', () async { diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 2534b194d..4634bba3c 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -920,6 +920,19 @@ void main() { expect(buildCount, 1); }); + test('closing the subscription updated element.hasListeners', () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => 0); + + final sub = container.listen(provider, (previous, value) {}); + + expect(container.readProviderElement(provider).hasListeners, true); + + sub.close(); + + expect(container.readProviderElement(provider).hasListeners, false); + }); + test('throws if specifying both weak and fireImmediately', () { throw UnimplementedError(); }); From e2627d26d04f5a0a24dded639684a5ad42313e31 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 16 Mar 2024 12:58:10 +0100 Subject: [PATCH 303/387] Add test --- .../lib/src/core/provider/provider.dart | 5 +++++ .../riverpod/test/src/core/provider_test.dart | 17 +++++++++++++++++ packages/riverpod/test/src/core/ref_test.dart | 4 ---- 3 files changed, 22 insertions(+), 4 deletions(-) diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index 2a0e16e12..cdd6fa09f 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -58,6 +58,11 @@ abstract base class ProviderBase extends ProviderOrFamily required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, }) { + assert( + !fireImmediately || !node.weak, + 'Cannot use fireImmediately with weak listeners', + ); + onError ??= Zone.current.handleUncaughtError; final element = node.readProviderElement(this); diff --git a/packages/riverpod/test/src/core/provider_test.dart b/packages/riverpod/test/src/core/provider_test.dart index 9c757eb9e..e364ec729 100644 --- a/packages/riverpod/test/src/core/provider_test.dart +++ b/packages/riverpod/test/src/core/provider_test.dart @@ -16,5 +16,22 @@ void main() { expect(b(21).allTransitiveDependencies, isNull); expect(b(21).dependencies, isNull); }); + + group('addListener', () { + test('throws if specifying both weak and fireImmediately', () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => 0); + + expect( + () => container.listen( + provider, + (previous, value) {}, + weak: true, + fireImmediately: true, + ), + throwsA(isA()), + ); + }); + }); }); } diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 4634bba3c..12b717563 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -933,10 +933,6 @@ void main() { expect(container.readProviderElement(provider).hasListeners, false); }); - test('throws if specifying both weak and fireImmediately', () { - throw UnimplementedError(); - }); - test('does not count towards the pause mechanism', () async { final container = ProviderContainer.test(); From aea5b7afdfe06ecfa697780dbf424963c029fed1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 16 Mar 2024 13:02:33 +0100 Subject: [PATCH 304/387] Docs --- packages/riverpod/CHANGELOG.md | 4 ++++ packages/riverpod/lib/src/core/ref.dart | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 0e87ed343..4c89b9d4e 100644 --- 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/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index b235a2a7b..282b28556 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -598,6 +598,11 @@ final = Provider(dependencies: []); /// and emit a valid value out of it. As such, if a /// [FutureProvider]/[StreamProvider] fail, [onError] will not be called. /// Instead the listener will receive an [AsyncError]. + /// + /// - [weak] (false by default) can be optionally passed to have the listener + /// not cause the provider to be initialized and kept alive. + /// This enables listening to changes on a provider, without causing it to + /// perform any work if it currently isn't used. /// {@endtemplate} ProviderSubscription listen( ProviderListenable provider, From 0ad6424eef0fe12825c726e4f3dc9df9c9e90ebe Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 16 Mar 2024 13:20:43 +0100 Subject: [PATCH 305/387] Coverage --- .../riverpod/test/src/core/family_test.dart | 39 +++++++++++++++++++ packages/riverpod/test/src/utils.dart | 14 +++++++ 2 files changed, 53 insertions(+) create mode 100644 packages/riverpod/test/src/core/family_test.dart diff --git a/packages/riverpod/test/src/core/family_test.dart b/packages/riverpod/test/src/core/family_test.dart new file mode 100644 index 000000000..653921fd4 --- /dev/null +++ b/packages/riverpod/test/src/core/family_test.dart @@ -0,0 +1,39 @@ +import 'package:mockito/mockito.dart'; +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +import '../matrix.dart'; +import '../utils.dart'; + +void main() { + group('ClassFamily', () { + notifierProviderFactory.createGroup((factory) { + test('overrideWithBuild', () { + final provider = factory.simpleTestProvider((ref) => 0); + final overrideWithBuild = + OverrideWithBuildMock, int, int>(-1); + + when(overrideWithBuild.call(any, any)).thenReturn(42); + + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithBuild(overrideWithBuild.call), + ], + ); + + verifyZeroInteractions(overrideWithBuild); + + container.read(provider); + + final [ref as Ref, notifier as TestNotifier] = verify( + overrideWithBuild.call(captureAny, captureAny), + ).captured; + + // ignore: invalid_use_of_protected_member + expect(ref, same(notifier.ref)); + + expect(notifier.state, 42); + }); + }); + }); +} diff --git a/packages/riverpod/test/src/utils.dart b/packages/riverpod/test/src/utils.dart index 24ca8c4ca..fe631441e 100644 --- a/packages/riverpod/test/src/utils.dart +++ b/packages/riverpod/test/src/utils.dart @@ -20,6 +20,20 @@ List captureErrors(List cb) { class ProviderObserverMock extends Mock implements ProviderObserver {} +class OverrideWithBuildMock extends Mock { + OverrideWithBuildMock(this.fallback); + + final CreatedT fallback; + + CreatedT call(Ref? ref, NotifierT? value) { + return super.noSuchMethod( + Invocation.method(#call, [ref, value]), + returnValue: fallback, + returnValueForMissingStub: fallback, + ) as CreatedT; + } +} + class OnBuildMock extends Mock { void call(); } From 510b45bc6155edf98e8087a548ecea9f3292f773 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 16 Mar 2024 13:26:36 +0100 Subject: [PATCH 306/387] Coverage --- .../test/src/core/modifiers/future_test.dart | 6 +++++- .../test/src/core/modifiers/select_test.dart | 15 +++++++++++++++ packages/riverpod/test/src/core/ref_test.dart | 3 ++- 3 files changed, 22 insertions(+), 2 deletions(-) diff --git a/packages/riverpod/test/src/core/modifiers/future_test.dart b/packages/riverpod/test/src/core/modifiers/future_test.dart index f308820cd..daedb4fe5 100644 --- a/packages/riverpod/test/src/core/modifiers/future_test.dart +++ b/packages/riverpod/test/src/core/modifiers/future_test.dart @@ -11,7 +11,11 @@ void main() { final container = ProviderContainer.test(); final provider = FutureProvider((ref) => 0); - final sub = container.listen(provider.future, (previous, value) {}); + final sub = container.listen( + provider.future, + weak: true, + (previous, value) {}, + ); expect(container.readProviderElement(provider).hasListeners, true); diff --git a/packages/riverpod/test/src/core/modifiers/select_test.dart b/packages/riverpod/test/src/core/modifiers/select_test.dart index 46bc4fef6..a0b4d9eda 100644 --- a/packages/riverpod/test/src/core/modifiers/select_test.dart +++ b/packages/riverpod/test/src/core/modifiers/select_test.dart @@ -29,12 +29,27 @@ void main() { }); group('handles listen(weak: true)', () { + test( + 'supports calling ProviderSubscription.read when no value were emitted yet', + () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => 0); + + final sub = container.listen( + provider.select((value) => 42), + (previous, value) {}, + ); + + expect(sub.read(), 42); + }); + test('closing the subscription updated element.hasListeners', () { final container = ProviderContainer.test(); final provider = Provider((ref) => 0); final sub = container.listen( provider.select((value) => 0), + weak: true, (previous, value) {}, ); diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 12b717563..1131b30cc 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -924,7 +924,8 @@ void main() { final container = ProviderContainer.test(); final provider = Provider((ref) => 0); - final sub = container.listen(provider, (previous, value) {}); + final sub = + container.listen(provider, weak: true, (previous, value) {}); expect(container.readProviderElement(provider).hasListeners, true); From 5c53649035a08820135a2b75db75daeed96b60ac Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 16 Mar 2024 13:40:05 +0100 Subject: [PATCH 307/387] Remove dead code --- .../lib/src/core/modifiers/select.dart | 5 ++- .../riverpod/test/src/core/family_test.dart | 39 ++++++++++++++++++- 2 files changed, 41 insertions(+), 3 deletions(-) diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index 5878093e6..4cce5cc42 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -160,8 +160,9 @@ class _ProviderSelector with ProviderListenable { node, sub, () { - return switch (lastSelectedValue) { - null => read(node), + // Using ! because since `sub.read` flushes the inner subscription, + // it is guaranteed that `lastSelectedValue` is not null. + return switch (lastSelectedValue!) { ResultData(:final state) => state, ResultError(:final error, :final stackTrace) => throwErrorWithCombinedStackTrace( diff --git a/packages/riverpod/test/src/core/family_test.dart b/packages/riverpod/test/src/core/family_test.dart index 653921fd4..ffbd9c1a0 100644 --- a/packages/riverpod/test/src/core/family_test.dart +++ b/packages/riverpod/test/src/core/family_test.dart @@ -1,12 +1,13 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; +import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; import '../matrix.dart'; import '../utils.dart'; void main() { - group('ClassFamily', () { + group('ClassProvider', () { notifierProviderFactory.createGroup((factory) { test('overrideWithBuild', () { final provider = factory.simpleTestProvider((ref) => 0); @@ -36,4 +37,40 @@ void main() { }); }); }); + + group('ClassFamily', () { + notifierProviderFactory.createGroup((factory) { + if (!factory.isFamily) return; + + test('overrideWithBuild', () { + final provider = factory.simpleTestProvider((ref) => 0).from!; + provider as NotifierProviderFamily, int, + Object?>; + + final overrideWithBuild = + OverrideWithBuildMock, int, int>(-1); + + when(overrideWithBuild.call(any, any)).thenReturn(42); + + final container = ProviderContainer.test( + overrides: [ + provider.overrideWithBuild(overrideWithBuild.call), + ], + ); + + verifyZeroInteractions(overrideWithBuild); + + container.read(provider(0)); + + final [ref as Ref, notifier as TestNotifier] = verify( + overrideWithBuild.call(captureAny, captureAny), + ).captured; + + // ignore: invalid_use_of_protected_member + expect(ref, same(notifier.ref)); + + expect(notifier.state, 42); + }); + }); + }); } From f96031e4cebc8f68d5781a4140950aae4fa5bee5 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 16 Mar 2024 13:41:54 +0100 Subject: [PATCH 308/387] Remove unused import --- packages/riverpod/test/src/core/family_test.dart | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/riverpod/test/src/core/family_test.dart b/packages/riverpod/test/src/core/family_test.dart index ffbd9c1a0..800e0e75e 100644 --- a/packages/riverpod/test/src/core/family_test.dart +++ b/packages/riverpod/test/src/core/family_test.dart @@ -1,6 +1,5 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; import '../matrix.dart'; From fc09597d450723622e7aabc5b43265aaa9d9c58b Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 16 Mar 2024 16:00:50 +0100 Subject: [PATCH 309/387] Update custom_lint --- examples/counter/pubspec.yaml | 2 +- examples/marvel/pubspec.yaml | 2 +- examples/pub/pubspec.yaml | 2 +- examples/random_number/pubspec.yaml | 2 +- examples/stackoverflow/pubspec.yaml | 2 +- examples/todos/pubspec.yaml | 2 +- packages/riverpod_lint_flutter_test/analysis_options.yaml | 3 +++ packages/riverpod_lint_flutter_test/pubspec.yaml | 2 +- website/pubspec.yaml | 2 +- 9 files changed, 11 insertions(+), 8 deletions(-) diff --git a/examples/counter/pubspec.yaml b/examples/counter/pubspec.yaml index 270a678a0..dcc2ca16f 100644 --- a/examples/counter/pubspec.yaml +++ b/examples/counter/pubspec.yaml @@ -24,7 +24,7 @@ dependencies: dev_dependencies: build_runner: ^2.3.3 - custom_lint: ^0.6.0 + custom_lint: ^0.6.3 flutter_test: sdk: flutter freezed: ^2.3.2 diff --git a/examples/marvel/pubspec.yaml b/examples/marvel/pubspec.yaml index e152e732e..de6fe8292 100644 --- a/examples/marvel/pubspec.yaml +++ b/examples/marvel/pubspec.yaml @@ -22,7 +22,7 @@ dependencies: dev_dependencies: build_runner: ^2.0.0 - custom_lint: ^0.6.0 + custom_lint: ^0.6.3 flutter_test: sdk: flutter freezed: ^2.1.0 diff --git a/examples/pub/pubspec.yaml b/examples/pub/pubspec.yaml index 8940ae4ff..ae76c5a09 100644 --- a/examples/pub/pubspec.yaml +++ b/examples/pub/pubspec.yaml @@ -23,7 +23,7 @@ dependencies: dev_dependencies: build_runner: ^2.0.0 - custom_lint: ^0.6.0 + custom_lint: ^0.6.3 flutter_test: sdk: flutter freezed: ^2.1.0 diff --git a/examples/random_number/pubspec.yaml b/examples/random_number/pubspec.yaml index c401595f8..ca831dd3e 100644 --- a/examples/random_number/pubspec.yaml +++ b/examples/random_number/pubspec.yaml @@ -14,7 +14,7 @@ dependencies: mockito: ^5.0.13 dev_dependencies: - custom_lint: ^0.6.0 + custom_lint: ^0.6.3 flutter_lints: ^1.0.0 flutter_test: sdk: flutter diff --git a/examples/stackoverflow/pubspec.yaml b/examples/stackoverflow/pubspec.yaml index 6582b1d6b..2e3db3e8f 100644 --- a/examples/stackoverflow/pubspec.yaml +++ b/examples/stackoverflow/pubspec.yaml @@ -19,7 +19,7 @@ dependencies: dev_dependencies: build_runner: ^2.0.0 - custom_lint: ^0.6.0 + custom_lint: ^0.6.3 flutter_test: sdk: flutter freezed: ^2.1.0 diff --git a/examples/todos/pubspec.yaml b/examples/todos/pubspec.yaml index 5149622a1..92e68b121 100644 --- a/examples/todos/pubspec.yaml +++ b/examples/todos/pubspec.yaml @@ -18,7 +18,7 @@ dependencies: dev_dependencies: build_runner: ^2.0.0 - custom_lint: ^0.6.0 + custom_lint: ^0.6.3 flutter_test: sdk: flutter riverpod_lint: diff --git a/packages/riverpod_lint_flutter_test/analysis_options.yaml b/packages/riverpod_lint_flutter_test/analysis_options.yaml index c1c81786a..69961a146 100644 --- a/packages/riverpod_lint_flutter_test/analysis_options.yaml +++ b/packages/riverpod_lint_flutter_test/analysis_options.yaml @@ -5,3 +5,6 @@ analyzer: # Files with errors on purpose - test/lints/notifier_extends.g.dart - test/lints/functional_ref.g.dart + +custom_lint: + debug: true \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/pubspec.yaml b/packages/riverpod_lint_flutter_test/pubspec.yaml index 6519e40d3..310df1db1 100644 --- a/packages/riverpod_lint_flutter_test/pubspec.yaml +++ b/packages/riverpod_lint_flutter_test/pubspec.yaml @@ -15,7 +15,7 @@ dependencies: dev_dependencies: build_runner: ^2.4.6 - custom_lint: ^0.6.0 + custom_lint: ^0.6.3 custom_lint_core: ^0.6.0 freezed: ^2.3.2 json_serializable: ^6.6.1 diff --git a/website/pubspec.yaml b/website/pubspec.yaml index 6482270e5..e0efdac8c 100644 --- a/website/pubspec.yaml +++ b/website/pubspec.yaml @@ -25,7 +25,7 @@ dependencies: dev_dependencies: build_runner: - custom_lint: ^0.6.0 + custom_lint: ^0.6.3 flutter_test: sdk: flutter freezed: ^2.2.0 From 6e12b2e2a9552705d5d941849f6441eb272c24c1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 16 Mar 2024 16:45:40 +0100 Subject: [PATCH 310/387] Add test for missing `@internal` & co --- .../src/providers/async_notifier/family.dart | 1 + .../src/providers/async_notifier/orphan.dart | 1 + .../lib/src/providers/notifier/family.dart | 1 + .../lib/src/providers/notifier/orphan.dart | 1 + .../src/providers/stream_notifier/family.dart | 1 + .../src/providers/stream_notifier/orphan.dart | 1 + packages/riverpod/test/meta_test.dart | 41 +++++++++++++++++++ 7 files changed, 47 insertions(+) diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index e9ccd5ced..6a9e6a161 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -90,6 +90,7 @@ final class FamilyAsyncNotifierProvider< // final NotifierT Function() _createNotifier; + @internal @override NotifierT create() => _createNotifier(); diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index 12b5f08ae..2069fa608 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -96,6 +96,7 @@ final class AsyncNotifierProvider< // final NotifierT Function() _createNotifier; + @internal @override NotifierT create() => _createNotifier(); diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index 12b6c4146..2ee3b77bc 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -34,6 +34,7 @@ final class FamilyNotifierProvider // final NotifierT Function() _createNotifier; + @internal @override NotifierT create() => _createNotifier(); diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart index af0f7f2d3..acd2bed43 100644 --- a/packages/riverpod/lib/src/providers/notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -113,6 +113,7 @@ final class NotifierProvider, StateT> final NotifierT Function() _createNotifier; + @internal @override NotifierT create() => _createNotifier(); diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index 1c9d130a5..b116538ac 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -47,6 +47,7 @@ final class FamilyStreamNotifierProvider< // final NotifierT Function() _createNotifier; + @internal @override NotifierT create() => _createNotifier(); diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index d0fbaec59..39a852e54 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -83,6 +83,7 @@ final class StreamNotifierProvider< // final NotifierT Function() _createNotifier; + @internal @override NotifierT create() => _createNotifier(); diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index 5c0be455f..b62aed6e7 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -3,6 +3,7 @@ import 'package:analyzer/dart/analysis/utilities.dart'; import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/dart/element/type.dart'; import 'package:analyzer/dart/element/visitor.dart'; +import 'package:collection/collection.dart'; import 'package:path/path.dart' as path; import 'package:test/test.dart'; @@ -38,6 +39,10 @@ void main() { } }); + test('overrides re-apply annotations', () async { + expect(visitor.missingInheritedAnnotations, isEmpty); + }); + test('public API snapshot', skip: 'Disabled', () async { // TODO consider other imports expect(riverpod.exportNamespace.definedNames.keys, [ @@ -106,6 +111,7 @@ class _PublicAPIVisitor extends GeneralizingElementVisitor { _PublicAPIVisitor(this.riverpod); final LibraryElement riverpod; + final missingInheritedAnnotations = {}; final unexportedElements = {}; final undocumentedElements = {}; @@ -156,6 +162,7 @@ class _PublicAPIVisitor extends GeneralizingElementVisitor { super.visitElement(element); if (_isPublicApi(element)) { + _verifyInheritsAnnotations(element); _verifyHasDocs(element); _parseTemplatesAndMacros(element); } @@ -178,6 +185,40 @@ class _PublicAPIVisitor extends GeneralizingElementVisitor { _verifyTypeIsExported(element.type, element); } + void _verifyInheritsAnnotations(Element element) { + final parent = element.enclosingElement; + + if (parent is! ClassElement) return; + + final overrides = parent.allSupertypes + .map((e) { + if (element is MethodElement) { + return e.getMethod(element.name); + } else if (element is PropertyAccessorElement && element.isGetter) { + return e.getGetter(element.name); + } else if (element is PropertyAccessorElement && element.isSetter) { + return e.getSetter(element.name); + } + }) + .whereNotNull() + .toList(); + + if (overrides.isEmpty) return; + + for (final override in overrides) { + if ((!element.hasInternal && override.hasInternal) || + (!element.hasProtected && override.hasProtected) || + (!element.hasVisibleForOverriding && + override.hasVisibleForOverriding) || + (!element.hasVisibleForTesting && override.hasVisibleForTesting)) { + missingInheritedAnnotations.add( + '${element.location} vs ${override.location}\n' + '${element.metadata} vs ${override.metadata}', + ); + } + } + } + void _parseTemplatesAndMacros(Element element) { final docs = element.documentationComment; if (docs == null) return; From 59e8efee80674f9a904560149afda3421c57e3a6 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 16 Mar 2024 16:45:45 +0100 Subject: [PATCH 311/387] Bump lint --- examples/counter/pubspec.yaml | 2 +- examples/marvel/pubspec.yaml | 2 +- examples/pub/pubspec.yaml | 2 +- examples/random_number/pubspec.yaml | 2 +- examples/stackoverflow/pubspec.yaml | 2 +- examples/todos/pubspec.yaml | 2 +- packages/riverpod/test/meta_test.dart | 1 - packages/riverpod_analyzer_utils/pubspec.yaml | 2 +- packages/riverpod_lint/pubspec.yaml | 2 +- packages/riverpod_lint_flutter_test/pubspec.yaml | 4 ++-- website/pubspec.yaml | 2 +- 11 files changed, 11 insertions(+), 12 deletions(-) diff --git a/examples/counter/pubspec.yaml b/examples/counter/pubspec.yaml index dcc2ca16f..c20c80026 100644 --- a/examples/counter/pubspec.yaml +++ b/examples/counter/pubspec.yaml @@ -24,7 +24,7 @@ dependencies: dev_dependencies: build_runner: ^2.3.3 - custom_lint: ^0.6.3 + custom_lint: ^0.6.4 flutter_test: sdk: flutter freezed: ^2.3.2 diff --git a/examples/marvel/pubspec.yaml b/examples/marvel/pubspec.yaml index de6fe8292..997570d67 100644 --- a/examples/marvel/pubspec.yaml +++ b/examples/marvel/pubspec.yaml @@ -22,7 +22,7 @@ dependencies: dev_dependencies: build_runner: ^2.0.0 - custom_lint: ^0.6.3 + custom_lint: ^0.6.4 flutter_test: sdk: flutter freezed: ^2.1.0 diff --git a/examples/pub/pubspec.yaml b/examples/pub/pubspec.yaml index ae76c5a09..d5ae46e4f 100644 --- a/examples/pub/pubspec.yaml +++ b/examples/pub/pubspec.yaml @@ -23,7 +23,7 @@ dependencies: dev_dependencies: build_runner: ^2.0.0 - custom_lint: ^0.6.3 + custom_lint: ^0.6.4 flutter_test: sdk: flutter freezed: ^2.1.0 diff --git a/examples/random_number/pubspec.yaml b/examples/random_number/pubspec.yaml index ca831dd3e..62a18be7b 100644 --- a/examples/random_number/pubspec.yaml +++ b/examples/random_number/pubspec.yaml @@ -14,7 +14,7 @@ dependencies: mockito: ^5.0.13 dev_dependencies: - custom_lint: ^0.6.3 + custom_lint: ^0.6.4 flutter_lints: ^1.0.0 flutter_test: sdk: flutter diff --git a/examples/stackoverflow/pubspec.yaml b/examples/stackoverflow/pubspec.yaml index 2e3db3e8f..011a722dc 100644 --- a/examples/stackoverflow/pubspec.yaml +++ b/examples/stackoverflow/pubspec.yaml @@ -19,7 +19,7 @@ dependencies: dev_dependencies: build_runner: ^2.0.0 - custom_lint: ^0.6.3 + custom_lint: ^0.6.4 flutter_test: sdk: flutter freezed: ^2.1.0 diff --git a/examples/todos/pubspec.yaml b/examples/todos/pubspec.yaml index 92e68b121..1262d9d2d 100644 --- a/examples/todos/pubspec.yaml +++ b/examples/todos/pubspec.yaml @@ -18,7 +18,7 @@ dependencies: dev_dependencies: build_runner: ^2.0.0 - custom_lint: ^0.6.3 + custom_lint: ^0.6.4 flutter_test: sdk: flutter riverpod_lint: diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index b62aed6e7..5f4e37176 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -8,7 +8,6 @@ import 'package:path/path.dart' as path; import 'package:test/test.dart'; void main() { - // TODO verify that inherited members reapply annotations // TODO assert all constructor parameters point to a field with dartdoc. // This verifies that: diff --git a/packages/riverpod_analyzer_utils/pubspec.yaml b/packages/riverpod_analyzer_utils/pubspec.yaml index f4163815e..2df3b6d49 100644 --- a/packages/riverpod_analyzer_utils/pubspec.yaml +++ b/packages/riverpod_analyzer_utils/pubspec.yaml @@ -13,7 +13,7 @@ dependencies: analyzer: ">=5.12.0 <7.0.0" collection: ^1.16.0 crypto: ^3.0.2 - custom_lint_core: ^0.6.0 + custom_lint_core: ^0.6.3 freezed_annotation: ^2.2.0 meta: ^1.7.0 path: ^1.8.0 diff --git a/packages/riverpod_lint/pubspec.yaml b/packages/riverpod_lint/pubspec.yaml index 1996b49cb..df0ac7dc0 100644 --- a/packages/riverpod_lint/pubspec.yaml +++ b/packages/riverpod_lint/pubspec.yaml @@ -14,7 +14,7 @@ dependencies: analyzer: ">=6.0.0 <7.0.0" analyzer_plugin: ^0.11.2 collection: ^1.16.0 - custom_lint_builder: ^0.6.0 + custom_lint_builder: ^0.6.4 meta: ^1.7.0 path: ^1.8.1 riverpod: ^3.0.0-dev.3 diff --git a/packages/riverpod_lint_flutter_test/pubspec.yaml b/packages/riverpod_lint_flutter_test/pubspec.yaml index 310df1db1..3895e1e08 100644 --- a/packages/riverpod_lint_flutter_test/pubspec.yaml +++ b/packages/riverpod_lint_flutter_test/pubspec.yaml @@ -15,8 +15,8 @@ dependencies: dev_dependencies: build_runner: ^2.4.6 - custom_lint: ^0.6.3 - custom_lint_core: ^0.6.0 + custom_lint: ^0.6.4 + custom_lint_core: ^0.6.3 freezed: ^2.3.2 json_serializable: ^6.6.1 riverpod_lint: diff --git a/website/pubspec.yaml b/website/pubspec.yaml index e0efdac8c..0a0847b5d 100644 --- a/website/pubspec.yaml +++ b/website/pubspec.yaml @@ -25,7 +25,7 @@ dependencies: dev_dependencies: build_runner: - custom_lint: ^0.6.3 + custom_lint: ^0.6.4 flutter_test: sdk: flutter freezed: ^2.2.0 From 36f3e20689a9531f9724564fbedf42068d92c271 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 16 Mar 2024 16:54:31 +0100 Subject: [PATCH 312/387] Update docs --- website/docs/essentials/testing.mdx | 8 +------ .../testing/auto_dispose_listen.dart | 4 +--- .../docs/essentials/testing/await_future.dart | 4 +--- .../essentials/testing/create_container.dart | 22 ------------------- .../essentials/testing/listen_provider.dart | 4 +--- .../essentials/testing/mock_provider.dart | 5 ++--- .../essentials/testing/notifier_usage.dart | 4 ++-- .../docs/essentials/testing/unit_test.dart | 4 +--- .../current/essentials/testing.mdx | 8 ------- .../current/essentials/testing.mdx | 7 ------ .../current/essentials/testing.mdx | 9 -------- 11 files changed, 9 insertions(+), 70 deletions(-) delete mode 100644 website/docs/essentials/testing/create_container.dart diff --git a/website/docs/essentials/testing.mdx b/website/docs/essentials/testing.mdx index 54cbfb579..1733bbf1b 100644 --- a/website/docs/essentials/testing.mdx +++ b/website/docs/essentials/testing.mdx @@ -4,7 +4,6 @@ version: 2 --- import { AutoSnippet, When } from "/src/components/CodeSnippet"; -import createContainer from "!!raw-loader!./testing/create_container.dart"; import unitTest from "!!raw-loader!./testing/unit_test.dart"; import widgetTest from "!!raw-loader!./testing/widget_test.dart"; import fullWidgetTest from "!!raw-loader!./testing/full_widget_test.dart"; @@ -47,12 +46,7 @@ The main difference with any other test is that we will want to create a `ProviderContainer` object. This object will enable our test to interact with providers. -It is encouraged to make a testing utility for both creating and disposing -of a `ProviderContainer` object: - - - -Then, we can define a `test` using this utility: +A typical test using `ProviderContainer` will look like: diff --git a/website/docs/essentials/testing/auto_dispose_listen.dart b/website/docs/essentials/testing/auto_dispose_listen.dart index 2e927683c..2b9289807 100644 --- a/website/docs/essentials/testing/auto_dispose_listen.dart +++ b/website/docs/essentials/testing/auto_dispose_listen.dart @@ -3,13 +3,11 @@ import 'package:flutter_test/flutter_test.dart'; import 'package:riverpod/riverpod.dart'; -import 'create_container.dart'; - final provider = Provider((_) => 'Hello world'); void main() { test('Some description', () { - final container = createContainer(); + final container = ProviderContainer.test(); /* SNIPPET START */ final subscription = container.listen(provider, (_, __) {}); diff --git a/website/docs/essentials/testing/await_future.dart b/website/docs/essentials/testing/await_future.dart index 000f775d5..b9e593aea 100644 --- a/website/docs/essentials/testing/await_future.dart +++ b/website/docs/essentials/testing/await_future.dart @@ -3,15 +3,13 @@ import 'package:flutter_test/flutter_test.dart'; import 'package:riverpod/riverpod.dart'; -import 'create_container.dart'; - final provider = FutureProvider((_) async => 42); void main() { test('Some description', () async { // Create a ProviderContainer for this test. // DO NOT share ProviderContainers between tests. - final container = createContainer(); + final container = ProviderContainer.test(); /* SNIPPET START */ // TODO: use the container to test your application. diff --git a/website/docs/essentials/testing/create_container.dart b/website/docs/essentials/testing/create_container.dart deleted file mode 100644 index 1a776329a..000000000 --- a/website/docs/essentials/testing/create_container.dart +++ /dev/null @@ -1,22 +0,0 @@ -import 'package:riverpod/riverpod.dart'; -import 'package:test/test.dart'; - -/// A testing utility which creates a [ProviderContainer] and automatically -/// disposes it at the end of the test. -ProviderContainer createContainer({ - ProviderContainer? parent, - List overrides = const [], - List? observers, -}) { - // Create a ProviderContainer, and optionally allow specifying parameters. - final container = ProviderContainer( - parent: parent, - overrides: overrides, - observers: observers, - ); - - // When the test ends, dispose the container. - addTearDown(container.dispose); - - return container; -} diff --git a/website/docs/essentials/testing/listen_provider.dart b/website/docs/essentials/testing/listen_provider.dart index d2e840d9b..2e789c6fb 100644 --- a/website/docs/essentials/testing/listen_provider.dart +++ b/website/docs/essentials/testing/listen_provider.dart @@ -3,13 +3,11 @@ import 'package:flutter_test/flutter_test.dart'; import 'package:riverpod/riverpod.dart'; -import 'create_container.dart'; - final provider = Provider((_) => 'Hello world'); void main() { test('Some description', () { - final container = createContainer(); + final container = ProviderContainer.test(); /* SNIPPET START */ container.listen( provider, diff --git a/website/docs/essentials/testing/mock_provider.dart b/website/docs/essentials/testing/mock_provider.dart index 3607715b2..ec33b6826 100644 --- a/website/docs/essentials/testing/mock_provider.dart +++ b/website/docs/essentials/testing/mock_provider.dart @@ -3,7 +3,6 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter_test/flutter_test.dart'; -import 'create_container.dart'; import 'full_widget_test.dart'; import 'provider_to_mock/raw.dart'; @@ -13,8 +12,8 @@ void main() { const ProviderScope(child: YourWidgetYouWantToTest()), ); /* SNIPPET START */ - // In unit tests, by reusing our previous "createContainer" utility. - final container = createContainer( + // In unit tests, containers are created using `ProviderContainer.test`. + final container = ProviderContainer.test( // We can specify a list of providers to mock: overrides: [ // In this case, we are mocking "exampleProvider". diff --git a/website/docs/essentials/testing/notifier_usage.dart b/website/docs/essentials/testing/notifier_usage.dart index 687c9715b..606e8dea8 100644 --- a/website/docs/essentials/testing/notifier_usage.dart +++ b/website/docs/essentials/testing/notifier_usage.dart @@ -1,14 +1,14 @@ // ignore_for_file: unused_local_variable import 'package:flutter_test/flutter_test.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; -import 'create_container.dart'; import 'notifier_mock/codegen.dart'; /* SNIPPET START */ void main() { test('Some description', () { - final container = createContainer( + final container = ProviderContainer.test( // Override the provider to have it create our mock Notifier. overrides: [myNotifierProvider.overrideWith(MyNotifierMock.new)], ); diff --git a/website/docs/essentials/testing/unit_test.dart b/website/docs/essentials/testing/unit_test.dart index 924d6ac23..542491370 100644 --- a/website/docs/essentials/testing/unit_test.dart +++ b/website/docs/essentials/testing/unit_test.dart @@ -3,8 +3,6 @@ import 'package:flutter_test/flutter_test.dart'; import 'package:riverpod/riverpod.dart'; -import 'create_container.dart'; - final provider = Provider((_) => 42); /* SNIPPET START */ @@ -12,7 +10,7 @@ void main() { test('Some description', () { // Create a ProviderContainer for this test. // DO NOT share ProviderContainers between tests. - final container = createContainer(); + final container = ProviderContainer.test(); // TODO: use the container to test your application. expect( diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing.mdx index d9ff23e0b..0e8fb6e51 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/testing.mdx @@ -3,7 +3,6 @@ title: Testare i tuoi provider --- import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; -import createContainer from "!!raw-loader!/docs/essentials/testing/create_container.dart"; import unitTest from "!!raw-loader!/docs/essentials/testing/unit_test.dart"; import widgetTest from "!!raw-loader!/docs/essentials/testing/widget_test.dart"; import fullWidgetTest from "!!raw-loader!/docs/essentials/testing/full_widget_test.dart"; @@ -43,13 +42,6 @@ I test unitari sono definit usando la funzione `test` da [package:test](https:// La differenza principale con qualsiasi altro test è che creeremo un oggetto `ProviderContainer`. Questo oggetto permetterà al nostro test di interagire con i provider -Si consiglia di creare un'utilità di test sia per la creazione che per l'eliminazione -di un oggetto `ProviderContainer`: - - - -Successivamente, possiamo definire un `test` utilizzando questa utilità: - Ora che abbiamo un ProviderContainer possiamo utilizzarlo per leggere i provider usando: diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing.mdx index f4b868df7..405186891 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/testing.mdx @@ -3,7 +3,6 @@ title: providers 테스트하기 --- import { AutoSnippet, When } from "../../../../../src/components/CodeSnippet"; -import createContainer from "!!raw-loader!/docs/essentials/testing/create_container.dart"; import unitTest from "!!raw-loader!/docs/essentials/testing/unit_test.dart"; import widgetTest from "!!raw-loader!/docs/essentials/testing/widget_test.dart"; import fullWidgetTest from "!!raw-loader!/docs/essentials/testing/full_widget_test.dart"; @@ -41,12 +40,6 @@ Riverpod로 테스트를 정의할 때는 크게 두 가지 시나리오가 있 다른 테스트와 가장 큰 차이점은 `ProviderContainer` 객체를 생성한다는 점입니다. 이 객체를 사용하면 테스트가 provider와 상호 작용할 수 있습니다. -`ProviderContainer` 객체를 생성하고 폐기하기 위한 테스트 유틸리티를 만드는 것이 좋습니다: - - - -그런 다음 이 유틸리티를 사용하여 `test`를 정의할 수 있습니다: - 이제 ProviderContainer가 생겼으니 이를 사용하여 provider를 읽을 수 있습니다: diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing.mdx index 670e5e237..c92da6863 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/testing.mdx @@ -3,7 +3,6 @@ title: 测试你的提供者程序 --- import { AutoSnippet, When } from "@site/src/components/CodeSnippet"; -import createContainer from "!!raw-loader!/docs/essentials/testing/create_container.dart"; import unitTest from "!!raw-loader!/docs/essentials/testing/unit_test.dart"; import widgetTest from "!!raw-loader!/docs/essentials/testing/widget_test.dart"; import fullWidgetTest from "!!raw-loader!/docs/essentials/testing/full_widget_test.dart"; @@ -81,14 +80,6 @@ with providers. 与任何其他测试的主要区别在于，我们想要创建一个 `ProviderContainer` 对象。 此对象将使我们的测试能够与提供者程序进行交互。 - -建议创建一个测试实用程序来创建和处置对象 `ProviderContainer`： - - - From 0f384f0679860bb807acba5c3b387c95d303290e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 17 Mar 2024 15:52:40 +0100 Subject: [PATCH 313/387] Refactor pause mechanism --- .../lib/src/core/consumer.dart | 6 +++ packages/riverpod/lib/src/core/element.dart | 47 ++++++++++--------- .../riverpod/lib/src/core/foundation.dart | 2 +- .../lib/src/core/modifiers/select.dart | 6 +++ .../lib/src/core/provider/provider.dart | 12 ++--- .../lib/src/core/provider_subscription.dart | 38 ++++++++++++++- .../src/core/proxy_provider_listenable.dart | 16 +++++-- packages/riverpod/lib/src/core/ref.dart | 2 +- packages/riverpod/lib/src/framework.dart | 1 + packages/riverpod/test/src/core/ref_test.dart | 3 +- 10 files changed, 96 insertions(+), 37 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/core/consumer.dart b/packages/flutter_riverpod/lib/src/core/consumer.dart index 88dd30462..0971d4080 100644 --- a/packages/flutter_riverpod/lib/src/core/consumer.dart +++ b/packages/flutter_riverpod/lib/src/core/consumer.dart @@ -528,4 +528,10 @@ final class _ListenManual extends ProviderSubscription { @override T read() => _subscription.read(); + + @override + void pause() => _subscription.pause(); + + @override + void resume() => _subscription.resume(); } diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index cc2ea4fb0..1545b0b99 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -42,7 +42,9 @@ void Function()? debugCanModifyProviders; /// {@endtemplate} @internal @optionalTypeArgs -abstract class ProviderElement implements WrappedNode { +abstract class ProviderElement + with _OnPauseMixin + implements WrappedNode { /// {@macro riverpod.provider_element_base} ProviderElement(this.pointer); @@ -76,17 +78,17 @@ abstract class ProviderElement implements WrappedNode { /// - all of its listeners are "weak" (i.e. created with `listen(weak: true)`) /// /// See also [_mayNeedDispose], called when [isActive] may have changed. - bool get isActive => - (_dependents?.isNotEmpty ?? false) || _watchDependents.isNotEmpty; + bool get isActive => !_isPaused && _activeListenerCount > 0; + + int get _activeListenerCount => + (_dependents?.length ?? 0) + _watchDependents.length; /// Whether this [ProviderElement] is currently listened to or not. /// /// This maps to listeners added with `listen` and `watch`, /// excluding `listen(weak: true)`. bool get hasListeners => - (_dependents?.isNotEmpty ?? false) || - _watchDependents.isNotEmpty || - _weakDependents.isNotEmpty; + _activeListenerCount > 0 || _weakDependents.isNotEmpty; var _dependencies = HashMap(); HashMap? _previousDependencies; @@ -107,8 +109,6 @@ abstract class ProviderElement implements WrappedNode { bool _dependencyMayHaveChanged = false; bool _didChangeDependency = false; - var _didCancelOnce = false; - /// Whether the assert that prevents [requireState] from returning /// if the state was not set before is enabled. @visibleForOverriding @@ -335,8 +335,8 @@ This could mean a few things: // Unsubscribe to everything that a provider no longer depends on. for (final sub in previousDependencies.entries) { sub.key - .._watchDependents.remove(this) - .._onRemoveListener(); + .._onRemoveListener(weak: false) + .._watchDependents.remove(this); } _previousDependencies = null; } @@ -600,19 +600,24 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu return result; } - void _onListen() { + @override + void _onResume() => ref?._onResumeListeners?.forEach(runGuarded); + + @override + void _onCancel() => ref?._onCancelListeners?.forEach(runGuarded); + + void _onListen({required bool weak}) { + if (!weak && _isPaused && _activeListenerCount == 0) resume(); + ref?._onAddListeners?.forEach(runGuarded); - if (_didCancelOnce && !hasListeners) { - ref?._onResumeListeners?.forEach(runGuarded); - } } - void _onRemoveListener() { - ref?._onRemoveListeners?.forEach(runGuarded); - if (!hasListeners) { - _didCancelOnce = true; - ref?._onCancelListeners?.forEach(runGuarded); + void _onRemoveListener({required bool weak}) { + if (!weak && _activeListenerCount == 1) { + pause(); } + + ref?._onRemoveListeners?.forEach(runGuarded); _mayNeedDispose(); } @@ -672,7 +677,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ref._onRemoveListeners = null; ref._onChangeSelfListeners = null; ref._onErrorSelfListeners = null; - _didCancelOnce = false; + _pauseCount = 0; assert( ref._keepAliveLinks == null || ref._keepAliveLinks!.isEmpty, @@ -700,8 +705,8 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ref = null; for (final sub in _dependencies.entries) { + sub.key._onRemoveListener(weak: false); sub.key._watchDependents.remove(this); - sub.key._onRemoveListener(); } _dependencies.clear(); } diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index 17b26f39c..0dd5c1d92 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -174,7 +174,7 @@ String shortHash(Object? object) { mixin ProviderListenable implements ProviderListenableOrFamily { /// Starts listening to this transformer ProviderSubscription addListener( - Node node, + Node source, void Function(StateT? previous, StateT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index 4cce5cc42..d8f2bd73b 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -216,4 +216,10 @@ final class _SelectorSubscription return _read(); } + + @override + void pause() => _internalSub.pause(); + + @override + void resume() => _internalSub.resume(); } diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index cdd6fa09f..cbe3ea558 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -52,22 +52,22 @@ abstract base class ProviderBase extends ProviderOrFamily @override ProviderSubscription addListener( - Node node, + Node source, void Function(StateT? previous, StateT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, }) { assert( - !fireImmediately || !node.weak, + !fireImmediately || !source.weak, 'Cannot use fireImmediately with weak listeners', ); onError ??= Zone.current.handleUncaughtError; - final element = node.readProviderElement(this); + final element = source.readProviderElement(this); - if (!node.weak) element.flush(); + if (!source.weak) element.flush(); if (fireImmediately) { _handleFireImmediately( @@ -80,10 +80,10 @@ abstract base class ProviderBase extends ProviderOrFamily // Calling before initializing the subscription, // to ensure that "hasListeners" represents the state _before_ // the listener is added - element._onListen(); + element._onListen(weak: source.weak); return _ProviderStateSubscription( - node, + source, listenedElement: element, listener: (prev, next) => listener(prev as StateT?, next as StateT), onError: onError, diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index ec31da396..cadb3254a 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -22,6 +22,9 @@ abstract base class ProviderSubscription { bool get closed => _closed; var _closed = false; + void pause(); + void resume(); + /// Obtain the latest value emitted by the provider. /// /// This method throws if [closed] is true. @@ -42,10 +45,35 @@ abstract base class ProviderSubscription { } } +mixin _OnPauseMixin { + bool get _isPaused => _pauseCount > 0; + var _pauseCount = 0; + + @mustCallSuper + void pause() { + if (_pauseCount == 0) { + _onCancel(); + } + _pauseCount = max(_pauseCount + 1, 0); + } + + @mustCallSuper + void resume() { + if (_pauseCount == 1) { + _onResume(); + } + _pauseCount = min(_pauseCount - 1, 0); + } + + void _onResume(); + + void _onCancel(); +} + /// When a provider listens to another provider using `listen` @optionalTypeArgs final class _ProviderStateSubscription - extends ProviderSubscription { + extends ProviderSubscription with _OnPauseMixin { _ProviderStateSubscription( super.source, { required this.listenedElement, @@ -80,17 +108,23 @@ final class _ProviderStateSubscription @override void close() { if (!closed) { + listenedElement._onRemoveListener(weak: source.weak); switch (source) { case WeakNode(): listenedElement._weakDependents.remove(this); case _: listenedElement._dependents?.remove(this); } - listenedElement._onRemoveListener(); } super.close(); } + + @override + void _onCancel() => listenedElement.pause(); + + @override + void _onResume() => listenedElement.resume(); } /// Deals with the internals of synchronously calling the listeners diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index 0ae223b57..2d3d4e5bc 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -31,6 +31,12 @@ final class _ProxySubscription extends ProviderSubscription { super.close(); } + + @override + void pause() => innerSubscription.pause(); + + @override + void resume() => innerSubscription.resume(); } /// An internal utility for reading alternate values of a provider. @@ -76,13 +82,13 @@ class ProviderElementProxy @override ProviderSubscription addListener( - Node node, + Node source, void Function(OutputT? previous, OutputT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, }) { - final element = node.readProviderElement(provider); + final element = source.readProviderElement(provider); // While we don't care about changes to the element, calling _listenElement // is necessary to tell the listened element that it is being listened. @@ -90,7 +96,7 @@ class ProviderElementProxy // a listener to the notifier. // This avoids the listener from being immediately notified of a new // future when adding the listener refreshes the future. - final innerSub = node.listen( + final innerSub = source.listen( provider, (prev, next) {}, fireImmediately: false, @@ -118,9 +124,9 @@ class ProviderElementProxy ); return _ProxySubscription( - node, + source, removeListener, - () => read(node), + () => read(source), innerSubscription: innerSub, ); } diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 282b28556..0414e284d 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -567,7 +567,7 @@ final = Provider(dependencies: []); } element - .._onListen() + .._onListen(weak: false) .._watchDependents.add(_element); return Object(); diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index ac3c940ab..8cdb57e05 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -2,6 +2,7 @@ library framework; import 'dart:async'; import 'dart:collection'; +import 'dart:math'; import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 1131b30cc..237bac189 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -2600,7 +2600,8 @@ void main() { group('.onCancel', () { test( 'is called when dependent is invalidated and was the only listener', - skip: 'Waiting for "clear dependencies after futureprovider rebuilds"', + // TODO deal with now that we have onPause + skip: 'Waiting for "clear dependencies after FutureProvider rebuilds"', () async { // final container = ProviderContainer.test(); From b736550126fabee24c77200026ad3967836ce7dd Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 17 Mar 2024 16:01:30 +0100 Subject: [PATCH 314/387] Changelog --- packages/riverpod/CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 4c89b9d4e..2dafa1877 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -22,6 +22,8 @@ - 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. +- Added `ProviderSubscription.pause()`/`.resume()`. + This enables temporarily stopping the subscription to a provider, without it possibly loosing its state when using `autoDispose`. - Added `ProviderContainer.test()`. This is a custom constructor for testing purpose. It is meant to replace the `createContainer` utility. - Added `NotifierProvider.overrideWithBuild`, to override `Notifier.build` without From a57f4a0fa602af50448b4c2229f67aea84effa13 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 17 Mar 2024 16:15:33 +0100 Subject: [PATCH 315/387] Coverage --- .../test/{ => src/core}/consumer_test.dart | 37 +++++++++++++++++++ .../test/src/core/modifiers/select_test.dart | 24 ++++++++++++ .../src/core/provider_subscription_test.dart | 25 +++++++++++++ .../core/proxy_provider_listenable_test.dart | 28 ++++++++++++++ 4 files changed, 114 insertions(+) rename packages/flutter_riverpod/test/{ => src/core}/consumer_test.dart (95%) create mode 100644 packages/riverpod/test/src/core/provider_subscription_test.dart create mode 100644 packages/riverpod/test/src/core/proxy_provider_listenable_test.dart diff --git a/packages/flutter_riverpod/test/consumer_test.dart b/packages/flutter_riverpod/test/src/core/consumer_test.dart similarity index 95% rename from packages/flutter_riverpod/test/consumer_test.dart rename to packages/flutter_riverpod/test/src/core/consumer_test.dart index 831f05a6d..f21cdfb06 100644 --- a/packages/flutter_riverpod/test/consumer_test.dart +++ b/packages/flutter_riverpod/test/src/core/consumer_test.dart @@ -6,6 +6,43 @@ import 'package:flutter_test/flutter_test.dart'; import 'package:riverpod/legacy.dart'; void main() { + group('_ListenManual', () { + testWidgets('handles pause/resume', (tester) async { + late WidgetRef ref; + late ProviderSubscription sub; + final provider = Provider((ref) => 0); + + await tester.pumpWidget( + ProviderScope( + child: Consumer( + builder: (context, r, child) { + ref = r; + sub = ref.listenManual( + provider, + (_, __) {}, + ); + return const SizedBox(); + }, + ), + ), + ); + + final container = ProviderScope.containerOf(ref.context); + // ignore: invalid_use_of_internal_member + final element = container.readProviderElement(provider); + + expect(element.isActive, true); + + sub.pause(); + + expect(element.isActive, false); + + sub.resume(); + + expect(element.isActive, true); + }); + }); + testWidgets('Riverpod test', (tester) async { // Regression test for https://github.com/rrousselGit/riverpod/pull/3156 diff --git a/packages/riverpod/test/src/core/modifiers/select_test.dart b/packages/riverpod/test/src/core/modifiers/select_test.dart index a0b4d9eda..a3ed9d935 100644 --- a/packages/riverpod/test/src/core/modifiers/select_test.dart +++ b/packages/riverpod/test/src/core/modifiers/select_test.dart @@ -153,4 +153,28 @@ void main() { }); }); }); + + group('_ProviderSelector', () { + test('handles pause/resume', () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => 0); + + final element = container.readProviderElement(provider); + + final sub = container.listen( + provider.select((value) => null), + (previous, next) {}, + ); + + expect(element.isActive, true); + + sub.pause(); + + expect(element.isActive, false); + + sub.resume(); + + expect(element.isActive, true); + }); + }); } diff --git a/packages/riverpod/test/src/core/provider_subscription_test.dart b/packages/riverpod/test/src/core/provider_subscription_test.dart new file mode 100644 index 000000000..2fc7c799f --- /dev/null +++ b/packages/riverpod/test/src/core/provider_subscription_test.dart @@ -0,0 +1,25 @@ +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +void main() { + group('_ProxySubscription', () { + test('handles pause/resume', () { + final container = ProviderContainer.test(); + final provider = FutureProvider((ref) => 0); + + final element = container.readProviderElement(provider); + + final sub = container.listen(provider.future, (previous, next) {}); + + expect(element.isActive, true); + + sub.pause(); + + expect(element.isActive, false); + + sub.resume(); + + expect(element.isActive, true); + }); + }); +} diff --git a/packages/riverpod/test/src/core/proxy_provider_listenable_test.dart b/packages/riverpod/test/src/core/proxy_provider_listenable_test.dart new file mode 100644 index 000000000..91b29bbec --- /dev/null +++ b/packages/riverpod/test/src/core/proxy_provider_listenable_test.dart @@ -0,0 +1,28 @@ +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +void main() { + group('_ProviderSelector', () { + test('handles pause/resume', () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => 0); + + final element = container.readProviderElement(provider); + + final sub = container.listen( + provider.select((value) => null), + (previous, next) {}, + ); + + expect(element.isActive, true); + + sub.pause(); + + expect(element.isActive, false); + + sub.resume(); + + expect(element.isActive, true); + }); + }); +} From 1aaaea8424898f107dfa5ca0a920c29e56c30cec Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 17 Mar 2024 16:26:27 +0100 Subject: [PATCH 316/387] Changelog --- packages/riverpod/CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 2dafa1877..e515dfd4b 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -15,6 +15,9 @@ - `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. +- **Breaking**: A provider is now considered "paused" if all + of its listeners are also paused. So if a provider `A` is watched _only_ by a provider `B`, and `B` is currently unused, + then `A` will be paused. - 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, From c52514de7d5a8c044239ccebeadf1e9f4f7c9bf5 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 17 Mar 2024 16:37:44 +0100 Subject: [PATCH 317/387] Refactor _mount to use notifyListeners --- packages/riverpod/lib/src/core/element.dart | 99 +++++-------------- packages/riverpod/test/src/core/ref_test.dart | 19 ++++ 2 files changed, 44 insertions(+), 74 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 1545b0b99..656bdaf9b 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -227,71 +227,12 @@ This could mean a few things: final ref = this.ref = Ref._(this); buildState(ref); - // TODO refactor to use notifyListeners(); - switch (_stateResult!) { - case final ResultData newState: - final onChangeSelfListeners = ref._onChangeSelfListeners; - if (onChangeSelfListeners != null) { - for (var i = 0; i < onChangeSelfListeners.length; i++) { - Zone.current.runBinaryGuarded( - onChangeSelfListeners[i], - null, - newState.state, - ); - } - } - - final listeners = _weakDependents.toList(growable: false); - for (var i = 0; i < listeners.length; i++) { - final listener = listeners[i]; - if (listener is _ProviderStateSubscription) { - Zone.current.runBinaryGuarded( - listener.listener, - null, - newState.state, - ); - } - } - - for (final observer in container.observers) { - runTernaryGuarded( - observer.didAddProvider, - origin, - newState.state, - container, - ); - } - - case final ResultError newState: - final onErrorSelfListeners = ref._onErrorSelfListeners; - if (onErrorSelfListeners != null) { - for (var i = 0; i < onErrorSelfListeners.length; i++) { - Zone.current.runBinaryGuarded( - onErrorSelfListeners[i], - newState.error, - newState.stackTrace, - ); - } - } - - for (final observer in container.observers) { - runTernaryGuarded( - observer.didAddProvider, - origin, - null, - container, - ); - } - for (final observer in container.observers) { - runQuaternaryGuarded( - observer.providerDidFail, - origin, - newState.error, - newState.stackTrace, - container, - ); - } - } + _notifyListeners( + _stateResult!, + null, + isMount: true, + checkUpdateShouldNotify: false, + ); } /// Called when the override of a provider changes. @@ -461,8 +402,9 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu Result newState, Result? previousStateResult, { bool checkUpdateShouldNotify = true, + bool isMount = false, }) { - if (kDebugMode) _debugAssertNotificationAllowed(); + if (kDebugMode && !isMount) _debugAssertNotificationAllowed(); final previousState = previousStateResult?.stateOrNull; @@ -503,7 +445,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu return; } - final listeners = [..._weakDependents, ...?_dependents]; + final listeners = [..._weakDependents, if (!isMount) ...?_dependents]; switch (newState) { case final ResultData newState: for (var i = 0; i < listeners.length; i++) { @@ -535,13 +477,22 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } for (final observer in container.observers) { - runQuaternaryGuarded( - observer.didUpdateProvider, - origin, - previousState, - newState.stateOrNull, - container, - ); + if (isMount) { + runTernaryGuarded( + observer.didAddProvider, + origin, + newState.stateOrNull, + container, + ); + } else { + runQuaternaryGuarded( + observer.didUpdateProvider, + origin, + previousState, + newState.stateOrNull, + container, + ); + } } for (final observer in container.observers) { diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 237bac189..8511b2c25 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -828,6 +828,25 @@ void main() { }); group('listen', () { + test('does not invoke the listener if paused', () { + final container = ProviderContainer.test(); + final listener = Listener(); + late Ref ref; + final provider = Provider((r) { + ref = r; + return 0; + }); + + final sub = container.listen(provider, listener.call); + sub.pause(); + + verifyZeroInteractions(listener); + + ref.notifyListeners(); + + verifyZeroInteractions(listener); + }); + group('weak', () { test('Mounts the element but does not initialize the provider', () { final container = ProviderContainer.test(); From ed0a372c898d1a5e560ade47bbbc6142ee0bcaa2 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 17 Mar 2024 17:09:28 +0100 Subject: [PATCH 318/387] Don't invoke paused listeners --- packages/riverpod/lib/src/core/element.dart | 5 +- .../test/src/core/provider_element_test.dart | 2 +- packages/riverpod/test/src/core/ref_test.dart | 46 ++++++++++++++++--- 3 files changed, 43 insertions(+), 10 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 656bdaf9b..3cbffd877 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -450,7 +450,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu case final ResultData newState: for (var i = 0; i < listeners.length; i++) { final listener = listeners[i]; - if (listener is _ProviderStateSubscription) { + if (listener is _ProviderStateSubscription && !listener._isPaused) { Zone.current.runBinaryGuarded( listener.listener, previousState, @@ -461,7 +461,8 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu case final ResultError newState: for (var i = 0; i < listeners.length; i++) { final listener = listeners[i]; - if (listener is _ProviderStateSubscription) { + if (listener is _ProviderStateSubscription && + !listener._isPaused) { Zone.current.runBinaryGuarded( listener.onError, newState.error, diff --git a/packages/riverpod/test/src/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart index 631820e92..9dba1fddc 100644 --- a/packages/riverpod/test/src/core/provider_element_test.dart +++ b/packages/riverpod/test/src/core/provider_element_test.dart @@ -34,7 +34,7 @@ void main() { // schedules `dep` and `dependent` to rebuild // Will build `dependent` before `dep` because `dependent` doesn't depend on `dep` yet - // And since nothing is watchin `dep` at the moment, then `dependent` will + // And since nothing is watching `dep` at the moment, then `dependent` will // rebuild before `dep` even though `dep` is its ancestor. // This is fine since nothing is listening to `dep` yet, but it should // not cause certain assertions to trigger diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 8511b2c25..79ce4eb2b 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -3,12 +3,7 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; -import 'package:riverpod/src/internals.dart' - show - CircularDependencyError, - ProviderContainerTest, - ProviderElement, - UnmountedRefException; +import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; import '../utils.dart'; @@ -828,7 +823,7 @@ void main() { }); group('listen', () { - test('does not invoke the listener if paused', () { + test('does not invoke value listeners if paused', () { final container = ProviderContainer.test(); final listener = Listener(); late Ref ref; @@ -847,6 +842,43 @@ void main() { verifyZeroInteractions(listener); }); + test('does not invoke error listeners if paused', () { + final container = ProviderContainer.test(); + final listener = ErrorListener(); + late Ref ref; + var throws = false; + final provider = Provider((r) { + ref = r; + if (throws) throw StateError('err'); + }); + + final errors = []; + final sub = container.listen( + provider, + (a, b) {}, + onError: listener.call, + ); + + sub.pause(); + + verifyZeroInteractions(listener); + + throws = true; + runZonedGuarded( + () { + try { + container.refresh(provider); + } catch (e) { + // We just want to trigger onError listener + } + }, + (error, stack) => errors.add(error), + ); + verifyZeroInteractions(listener); + + expect(errors, [isA()]); + }); + group('weak', () { test('Mounts the element but does not initialize the provider', () { final container = ProviderContainer.test(); From eadd075be7f6d188b2c5f750acf851526ce80545 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 22 Mar 2024 13:38:07 +0100 Subject: [PATCH 319/387] W --- .../lib/src/core/consumer.dart | 3 + packages/riverpod/lib/src/core/element.dart | 194 ++++++++++++------ .../lib/src/core/modifiers/select.dart | 3 + .../lib/src/core/provider/provider.dart | 14 +- .../lib/src/core/provider_subscription.dart | 41 ++-- .../src/core/proxy_provider_listenable.dart | 3 + packages/riverpod/lib/src/core/ref.dart | 57 +++-- .../test/src/core/provider_element_test.dart | 77 ++++++- .../src/core/provider_subscription_test.dart | 4 + packages/riverpod/test/src/core/ref_test.dart | 32 +-- .../src/providers/stream_notifier_test.dart | 4 + 11 files changed, 298 insertions(+), 134 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/core/consumer.dart b/packages/flutter_riverpod/lib/src/core/consumer.dart index 0971d4080..161f7fb02 100644 --- a/packages/flutter_riverpod/lib/src/core/consumer.dart +++ b/packages/flutter_riverpod/lib/src/core/consumer.dart @@ -514,6 +514,9 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { final class _ListenManual extends ProviderSubscription { _ListenManual(super.source, this._subscription, this._element); + @override + bool get isPaused => _subscription.isPaused; + final ProviderSubscription _subscription; final ConsumerStatefulElement _element; diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 3cbffd877..e94e2e8dc 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -42,9 +42,7 @@ void Function()? debugCanModifyProviders; /// {@endtemplate} @internal @optionalTypeArgs -abstract class ProviderElement - with _OnPauseMixin - implements WrappedNode { +abstract class ProviderElement implements WrappedNode { /// {@macro riverpod.provider_element_base} ProviderElement(this.pointer); @@ -78,20 +76,23 @@ abstract class ProviderElement /// - all of its listeners are "weak" (i.e. created with `listen(weak: true)`) /// /// See also [_mayNeedDispose], called when [isActive] may have changed. - bool get isActive => !_isPaused && _activeListenerCount > 0; + bool get isActive => (_listenerCount - _pausedActiveSubscriptionCount) > 0; - int get _activeListenerCount => - (_dependents?.length ?? 0) + _watchDependents.length; + int get _listenerCount => _dependents?.length ?? 0; + // (_dependents?.length ?? 0) + _watchDependents.length; + + var _pausedActiveSubscriptionCount = 0; + var _didCancelOnce = false; /// Whether this [ProviderElement] is currently listened to or not. /// /// This maps to listeners added with `listen` and `watch`, /// excluding `listen(weak: true)`. - bool get hasListeners => - _activeListenerCount > 0 || _weakDependents.isNotEmpty; + bool get hasListeners => _listenerCount > 0 || _weakDependents.isNotEmpty; - var _dependencies = HashMap(); - HashMap? _previousDependencies; + // var _dependencies = HashMap(); + // HashMap? _previousDependencies; + List? _previousSubscriptions; List? _subscriptions; List? _dependents; @@ -102,8 +103,8 @@ abstract class ProviderElement /// - They may be reused between two instances of a [ProviderElement]. final _weakDependents = []; - /// The element of the providers that depends on this provider. - final _watchDependents = []; + // /// The element of the providers that depends on this provider. + // final _watchDependents = []; bool _mustRecomputeState = false; bool _dependencyMayHaveChanged = false; @@ -248,12 +249,12 @@ This could mean a few things: /// After a provider is initialized, this function takes care of unsubscribing /// to dependencies that are no-longer used. void _performBuild() { - assert( - _previousDependencies == null, - 'Bad state: _performBuild was called twice', - ); - final previousDependencies = _previousDependencies = _dependencies; - _dependencies = HashMap(); + // assert( + // _previousDependencies == null, + // 'Bad state: _performBuild was called twice', + // ); + // final previousDependencies = _previousDependencies = _dependencies; + // _dependencies = HashMap(); runOnDispose(); final ref = this.ref = Ref._(this); @@ -273,13 +274,20 @@ This could mean a few things: if (kDebugMode) _debugSkipNotifyListenersAsserts = false; } - // Unsubscribe to everything that a provider no longer depends on. - for (final sub in previousDependencies.entries) { - sub.key - .._onRemoveListener(weak: false) - .._watchDependents.remove(this); + final previousSubscriptions = _previousSubscriptions; + if (previousSubscriptions != null) { + _closeSubscriptions(previousSubscriptions); } - _previousDependencies = null; + + // // Unsubscribe to everything that a provider no longer depends on. + // for (final sub in previousDependencies.entries) { + // sub.key._onRemoveListener( + // () => sub.key._watchDependents.remove(this), + // weak: false, + // isPaused: !isActive, + // ); + // } + // _previousDependencies = null; } /// Initialize a provider. @@ -473,9 +481,11 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu default: } - for (var i = 0; i < _watchDependents.length; i++) { - _watchDependents[i].invalidateSelf(asReload: true); - } + // if (!isMount) { + // for (var i = 0; i < _watchDependents.length; i++) { + // _watchDependents[i].invalidateSelf(asReload: true); + // } + // } for (final observer in container.observers) { if (isMount) { @@ -515,6 +525,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu _dependencyMayHaveChanged = true; visitChildren( + // TODO skip paused subscriptions elementVisitor: (element) => element._markDependencyMayHaveChanged(), listenableVisitor: (notifier) => notifier.notifyDependencyMayHaveChanged(), @@ -552,25 +563,74 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu return result; } - @override - void _onResume() => ref?._onResumeListeners?.forEach(runGuarded); - - @override - void _onCancel() => ref?._onCancelListeners?.forEach(runGuarded); + SubT _onListen(SubT Function() add) { + print('listen $origin'); + final wasActive = isActive; + ref?._onAddListeners?.forEach(runGuarded); - void _onListen({required bool weak}) { - if (!weak && _isPaused && _activeListenerCount == 0) resume(); + final sub = add(); + if (_didCancelOnce && !wasActive && isActive) { + _onResume(); + } - ref?._onAddListeners?.forEach(runGuarded); + return sub; } - void _onRemoveListener({required bool weak}) { - if (!weak && _activeListenerCount == 1) { - pause(); - } + void _onRemoveListener(ProviderSubscription Function() remove) { + print('unsub $origin'); + final wasActive = isActive; - ref?._onRemoveListeners?.forEach(runGuarded); + final removedSub = remove(); + if (removedSub.isPaused && !removedSub.source.weak) + ref?._onRemoveListeners?.forEach(runGuarded); _mayNeedDispose(); + + if (wasActive && !isActive) _onCancel(); + } + + void _onSubscriptionPause({required bool weak}) { + // Weak listeners are not counted towards isActive, so we don't want to change + // _pausedActiveSubscriptionCount + if (weak) return; + + print('on pause sub at $origin'); + final wasActive = isActive; + _pausedActiveSubscriptionCount++; + + if (wasActive && !isActive) _onCancel(); + } + + void _onSubscriptionResume({ + required bool weak, + }) { + // Weak listeners are not counted towards isActive, so we don't want to change + // _pausedActiveSubscriptionCount + if (weak) return; + + print('on resume sub at $origin'); + final wasActive = isActive; + _pausedActiveSubscriptionCount = max(0, _pausedActiveSubscriptionCount - 1); + + if (!wasActive && isActive) _onResume(); + } + + void _onResume() { + print('resume $origin'); + ref?._onResumeListeners?.forEach(runGuarded); + + visitAncestors((element) { + element._onSubscriptionResume(weak: false); + }); + } + + void _onCancel() { + print('cancel $origin'); + _didCancelOnce = true; + ref?._onCancelListeners?.forEach(runGuarded); + + visitAncestors((element) { + element._onSubscriptionPause(weak: false); + }); } /// Life-cycle for when a listener is removed. @@ -584,6 +644,12 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } } + void _closeSubscriptions(List subscriptions) { + for (var i = 0; i < subscriptions.length; i++) { + subscriptions[i].close(); + } + } + /// Executes the [Ref.onDispose] listeners previously registered, then clear /// the list of listeners. @protected @@ -595,23 +661,11 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ref._mounted = false; - final subscriptions = _subscriptions; + final subscriptions = _previousSubscriptions = _subscriptions; + _subscriptions = null; if (subscriptions != null) { - while (subscriptions.isNotEmpty) { - late int debugPreviousLength; - if (kDebugMode) { - debugPreviousLength = subscriptions.length; - } - - final sub = subscriptions.first; - sub.close(); - - if (kDebugMode) { - assert( - subscriptions.length < debugPreviousLength, - 'ProviderSubscription.close did not remove the subscription', - ); - } + for (var i = 0; i < subscriptions.length; i++) { + subscriptions[i].pause(); } } @@ -629,7 +683,8 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ref._onRemoveListeners = null; ref._onChangeSelfListeners = null; ref._onErrorSelfListeners = null; - _pauseCount = 0; + _pausedActiveSubscriptionCount = 0; + _didCancelOnce = false; assert( ref._keepAliveLinks == null || ref._keepAliveLinks!.isEmpty, @@ -656,11 +711,20 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu _stateResult = null; ref = null; - for (final sub in _dependencies.entries) { - sub.key._onRemoveListener(weak: false); - sub.key._watchDependents.remove(this); + final previousSubscriptions = _previousSubscriptions; + if (previousSubscriptions != null) { + _closeSubscriptions(previousSubscriptions); } - _dependencies.clear(); + + // // TODO share with _performBuild + // for (final sub in _dependencies.entries) { + // sub.key._onRemoveListener( + // () => sub.key._watchDependents.remove(this), + // weak: false, + // isPaused: !sub.key.isActive, + // ); + // } + // _dependencies.clear(); } @override @@ -699,9 +763,9 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu required void Function(ProxyElementValueListenable element) listenableVisitor, }) { - for (var i = 0; i < _watchDependents.length; i++) { - elementVisitor(_watchDependents[i]); - } + // for (var i = 0; i < _watchDependents.length; i++) { + // elementVisitor(_watchDependents[i]); + // } Iterable children = _weakDependents; if (_dependents case final dependents?) { @@ -730,7 +794,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu void visitAncestors( void Function(ProviderElement element) visitor, ) { - _dependencies.keys.forEach(visitor); + // _dependencies.keys.forEach(visitor); final subscriptions = _subscriptions; if (subscriptions != null) { diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index d8f2bd73b..3571dd8d0 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -191,6 +191,9 @@ final class _SelectorSubscription this.onClose, }); + @override + bool get isPaused => _internalSub.isPaused; + final ProviderSubscription _internalSub; final Output Function() _read; final void Function()? onClose; diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index cbe3ea558..d1c73aaac 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -80,13 +80,13 @@ abstract base class ProviderBase extends ProviderOrFamily // Calling before initializing the subscription, // to ensure that "hasListeners" represents the state _before_ // the listener is added - element._onListen(weak: source.weak); - - return _ProviderStateSubscription( - source, - listenedElement: element, - listener: (prev, next) => listener(prev as StateT?, next as StateT), - onError: onError, + return element._onListen( + () => _ProviderStateSubscription( + source, + listenedElement: element, + listener: (prev, next) => listener(prev as StateT?, next as StateT), + onError: onError!, + ), ); } diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index cadb3254a..721d89f05 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -12,16 +12,18 @@ abstract base class ProviderSubscription { } } + /// Whether the subscription is closed. + bool get closed => _closed; + var _closed = false; + + bool get isPaused; + /// The object that listens to the associated [ProviderListenable]. /// /// This is typically a [ProviderElement] or a [ProviderContainer], /// but may be other values in the future. final Node source; - /// Whether the subscription is closed. - bool get closed => _closed; - var _closed = false; - void pause(); void resume(); @@ -54,7 +56,7 @@ mixin _OnPauseMixin { if (_pauseCount == 0) { _onCancel(); } - _pauseCount = max(_pauseCount + 1, 0); + _pauseCount++; } @mustCallSuper @@ -89,6 +91,9 @@ final class _ProviderStateSubscription } } + @override + bool get isPaused => _isPaused; + // Why can't this be typed correctly? final void Function(Object? prev, Object? state) listener; final ProviderElement listenedElement; @@ -108,23 +113,31 @@ final class _ProviderStateSubscription @override void close() { if (!closed) { - listenedElement._onRemoveListener(weak: source.weak); - switch (source) { - case WeakNode(): - listenedElement._weakDependents.remove(this); - case _: - listenedElement._dependents?.remove(this); - } + // if (isPaused) { + // listenedElement._onSubscriptionResume(weak: source.weak); + // } + listenedElement._onRemoveListener( + () { + switch (source) { + case WeakNode(): + listenedElement._weakDependents.remove(this); + case _: + listenedElement._dependents?.remove(this); + } + + return this; + }, + ); } super.close(); } @override - void _onCancel() => listenedElement.pause(); + void _onCancel() => listenedElement._onSubscriptionPause(weak: source.weak); @override - void _onResume() => listenedElement.resume(); + void _onResume() => listenedElement._onSubscriptionResume(weak: source.weak); } /// Deals with the internals of synchronously calling the listeners diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index 2d3d4e5bc..406a2380b 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -8,6 +8,9 @@ final class _ProxySubscription extends ProviderSubscription { required this.innerSubscription, }); + @override + bool get isPaused => innerSubscription.isPaused; + final ProviderSubscription innerSubscription; final void Function() _removeListeners; final StateT Function() _read; diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 0414e284d..b7e6fce77 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -540,44 +540,39 @@ final = Provider(dependencies: []); /// ``` T watch(ProviderListenable listenable) { _throwIfInvalidUsage(); - if (listenable is! ProviderBase) { - final sub = _element.listen( - listenable, - (prev, value) => invalidateSelf(asReload: true), - onError: (err, stack) => invalidateSelf(asReload: true), - onDependencyMayHaveChanged: _element._markDependencyMayHaveChanged, - ); + // if (listenable is! ProviderBase) { + final sub = _element.listen( + listenable, + (prev, value) => invalidateSelf(asReload: true), + onError: (err, stack) => invalidateSelf(asReload: true), + onDependencyMayHaveChanged: _element._markDependencyMayHaveChanged, + ); - return sub.read(); - } + return sub.read(); + // } - final element = container.readProviderElement(listenable); - _element._dependencies.putIfAbsent(element, () { - final previousSub = _element._previousDependencies?.remove(element); - if (previousSub != null) { - return previousSub; - } + // final targetElement = container.readProviderElement(listenable); + // _element._dependencies.putIfAbsent(targetElement, () { + // final previousSub = _element._previousDependencies?.remove(targetElement); + // if (previousSub != null) { + // return previousSub; + // } - if (kDebugMode) { - // Flushing the provider before adding a new dependency - // as otherwise this could cause false positives with certain asserts. - // It's done only in debug mode since `readSelf` will flush the value - // again anyway, and the only value of this flush is to not break asserts. - element.flush(); - } + // targetElement + // .._onListen( + // weak: false, + // isPaused: !_element.isActive, + // ) + // .._watchDependents.add(_element); - element - .._onListen(weak: false) - .._watchDependents.add(_element); + // return Object(); + // }); - return Object(); - }); - - final result = element.readSelf(); + // final result = targetElement.readSelf(); - if (kDebugMode) _debugAssertCanDependOn(listenable); + // if (kDebugMode) _debugAssertCanDependOn(listenable); - return result; + // return result; } /// {@template riverpod.listen} diff --git a/packages/riverpod/test/src/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart index 9dba1fddc..62dbd24ec 100644 --- a/packages/riverpod/test/src/core/provider_element_test.dart +++ b/packages/riverpod/test/src/core/provider_element_test.dart @@ -128,6 +128,65 @@ void main() { }); group('isActive', () { + test('handles adding a listener from an already paused provider', () { + final provider = Provider((ref) => 0); + final dep = Provider((ref) { + ref.watch(provider); + }); + final container = ProviderContainer.test(); + + expect(container.readProviderElement(provider).isActive, false); + + // Using read, "dep" should still be considered as paused. + container.read(dep); + + expect(container.readProviderElement(provider).isActive, false); + }); + + test('Is paused if all watchers are paused', () { + final container = ProviderContainer.test(); + final provider = Provider(name: 'foo', (ref) => 0); + final dep = Provider(name: 'dep', (ref) => ref.watch(provider)); + final dep2 = Provider(name: 'dep2', (ref) => ref.watch(provider)); + + final depSub = container.listen(dep, (a, b) {}); + final dep2Sub = container.listen(dep2, (a, b) {}); + + final element = container.readProviderElement(provider); + final depElement = container.readProviderElement(dep); + final depElement2 = container.readProviderElement(dep2); + + expect(element.isActive, true); + + depSub.close(); + + expect(element.isActive, true); + + dep2Sub.close(); + + expect(element.isActive, false); + }); + + test('Is paused if all subscriptions are paused', () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => 0); + + final element = container.readProviderElement(provider); + + final sub = container.listen(provider, (_, __) {}); + final sub2 = container.listen(provider, (_, __) {}); + + expect(element.isActive, true); + + sub.pause(); + + expect(element.isActive, true); + + sub2.pause(); + + expect(element.isActive, false); + }); + test('rejects weak listeners', () { final provider = Provider((ref) => 0); final container = ProviderContainer.test(); @@ -164,7 +223,7 @@ void main() { expect(container.readProviderElement(provider).isActive, false); - container.read(dep); + container.listen(dep, (_, __) {}); expect(container.readProviderElement(provider).isActive, true); }); @@ -235,6 +294,22 @@ void main() { }); }); + test('does not notify listeners twice when using fireImmediately', + () async { + final container = ProviderContainer.test(); + final listener = Listener(); + + final dep = StateProvider((ref) => 0); + final provider = Provider((ref) { + ref.watch(dep); + return ref.state = 0; + }); + + container.listen(provider, listener.call, fireImmediately: true); + + verifyOnly(listener, listener(null, 0)); + }); + test('does not notify listeners when rebuilding the state', () async { final container = ProviderContainer.test(); final listener = Listener(); diff --git a/packages/riverpod/test/src/core/provider_subscription_test.dart b/packages/riverpod/test/src/core/provider_subscription_test.dart index 2fc7c799f..93d097a1e 100644 --- a/packages/riverpod/test/src/core/provider_subscription_test.dart +++ b/packages/riverpod/test/src/core/provider_subscription_test.dart @@ -21,5 +21,9 @@ void main() { expect(element.isActive, true); }); + + test('closing a paused subscription unpause the element', () { + throw UnimplementedError(); + }); }); } diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 79ce4eb2b..ba8f8f16b 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -852,7 +852,6 @@ void main() { if (throws) throw StateError('err'); }); - final errors = []; final sub = container.listen( provider, (a, b) {}, @@ -864,19 +863,12 @@ void main() { verifyZeroInteractions(listener); throws = true; - runZonedGuarded( - () { - try { - container.refresh(provider); - } catch (e) { - // We just want to trigger onError listener - } - }, - (error, stack) => errors.add(error), - ); + try { + container.refresh(provider); + } catch (e) { + // We just want to trigger onError listener + } verifyZeroInteractions(listener); - - expect(errors, [isA()]); }); group('weak', () { @@ -2382,6 +2374,8 @@ void main() { ref.watch(dep); + // TODO changelog breaking: Calling ref.watch multiple times calls ref.onListen everytime + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); @@ -2738,19 +2732,21 @@ void main() { final container = ProviderContainer.test(); final listener = OnCancelMock(); final listener2 = OnCancelMock(); - final dep = Provider((ref) { + final dep = Provider(name: 'dep', (ref) { ref.onCancel(listener.call); ref.onCancel(listener2.call); }); var watching = true; - final provider = Provider((ref) { + final provider = Provider(name: 'provider', (ref) { if (watching) ref.watch(dep); }); - final provider2 = Provider((ref) { + final provider2 = Provider(name: 'provider2', (ref) { if (watching) ref.watch(dep); }); + print('a'); container.read(provider); + print('b'); container.read(provider2); verifyZeroInteractions(listener); @@ -2758,12 +2754,16 @@ void main() { watching = false; // remove the dependency provider<>dep + print('c'); container.refresh(provider); + print('d'); verifyZeroInteractions(listener2); // remove the dependency provider2<>dep + print('e'); container.refresh(provider2); + print('f'); verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); diff --git a/packages/riverpod/test/src/providers/stream_notifier_test.dart b/packages/riverpod/test/src/providers/stream_notifier_test.dart index 89e4e40a5..f0aa149af 100644 --- a/packages/riverpod/test/src/providers/stream_notifier_test.dart +++ b/packages/riverpod/test/src/providers/stream_notifier_test.dart @@ -29,6 +29,10 @@ void main() { }); streamNotifierProviderFactory.createGroup((factory) { + test('Pauses the Stream when the provider is paused', () { + throw UnimplementedError(); + }); + test('Cannot share a Notifier instance between providers ', () { final container = ProviderContainer.test(); final notifier = factory.deferredNotifier((ref) => Stream.value(0)); From ebcdc2f52dff6e49287a84416893f584c5e99369 Mon Sep 17 00:00:00 2001 From: Lennart S <55597910+LennartCode@users.noreply.github.com> Date: Tue, 21 May 2024 15:35:36 +0200 Subject: [PATCH 320/387] docs: fixed possible typo --- .../docs/concepts/about_codegen/provider_type/family_fn.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.dart index 863df6f40..9f6ff57cd 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.dart @@ -9,5 +9,5 @@ String example( int param1, { String param2 = 'foo', }) { - return 'Hello $param1 & param2'; + return 'Hello $param1 & $param2'; } From 94aa75fc10f5f167f069a348fece60deda9d024d Mon Sep 17 00:00:00 2001 From: Lennart S <55597910+LennartCode@users.noreply.github.com> Date: Tue, 21 May 2024 15:36:17 +0200 Subject: [PATCH 321/387] docs: fixed possible typo --- .../docs/concepts/about_codegen/provider_type/family_class.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.dart b/website/docs/concepts/about_codegen/provider_type/family_class.dart index 868585ad6..0a0a34415 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.dart @@ -10,7 +10,7 @@ class Example extends _$Example { int param1, { String param2 = 'foo', }) { - return 'Hello $param1 & param2'; + return 'Hello $param1 & $param2'; } // Add methods to mutate the state From 6078e3e9564cb76f8c3a75460fff9826d4c12c55 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 2 Jun 2024 15:07:07 +0200 Subject: [PATCH 322/387] Fix depreciation --- .../legacy/change_notifier_provider.dart | 1 - .../lib/src/analyzer_utils.dart | 30 ++++++++++++++++--- .../lib/src/nodes/providers/identifiers.dart | 7 +++-- .../lib/src/lints/functional_ref.dart | 4 +-- .../lib/src/lints/notifier_extends.dart | 2 +- ...only_use_keep_alive_inside_keep_alive.dart | 2 +- .../lib/src/lints/provider_dependencies.dart | 10 +++---- .../lib/src/lints/riverpod_syntax_error.dart | 10 +++---- .../lib/src/lints/unknown_scoped_usage.dart | 2 +- .../src/migration/missing_legacy_import.dart | 2 +- 10 files changed, 46 insertions(+), 24 deletions(-) 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 index b2d83848e..17ba5160e 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -1,7 +1,6 @@ // ignore_for_file: invalid_use_of_internal_member import 'package:flutter/foundation.dart'; -import 'package:flutter/widgets.dart'; import 'package:meta/meta.dart'; // ignore: implementation_imports import 'package:riverpod/src/internals.dart'; diff --git a/packages/riverpod_analyzer_utils/lib/src/analyzer_utils.dart b/packages/riverpod_analyzer_utils/lib/src/analyzer_utils.dart index 28ba8144a..d7c59c038 100644 --- a/packages/riverpod_analyzer_utils/lib/src/analyzer_utils.dart +++ b/packages/riverpod_analyzer_utils/lib/src/analyzer_utils.dart @@ -1,19 +1,41 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:meta/meta.dart'; +@immutable +class _Key { + const _Key(this.value, this.name); + + final Object value; + final String name; + + @override + bool operator ==(Object other) { + return other is _Key && other.value == value && other.name == name; + } + + @override + int get hashCode => Object.hash(value, name); +} + +class _Box { + _Box(this.value); + final T value; +} + @internal extension AstUtils on AstNode { + static final _cache = Expando<_Box>(); R upsert( String keyPart, R Function() create, ) { - final key = 'riverpod.$keyPart'; + final key = _Key(this, keyPart); // Using a record to differentiate "null value" from "no value". - final existing = getProperty<(R value,)>(key); - if (existing != null) return existing.$1; + final existing = _cache[key] as _Box?; + if (existing != null) return existing.value; final created = create(); - setProperty(key, (created,)); + _cache[key] = _Box(created); return created; } diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/identifiers.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/identifiers.dart index d41610d54..8e7acd125 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/identifiers.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/identifiers.dart @@ -6,15 +6,16 @@ extension ProviderIdentifierX on SimpleIdentifier { return upsert('ProviderIdentifier', () { final element = staticElement; if (element is! PropertyAccessorElement) return null; + final variable = element.variable2; + if (variable == null) return null; - final providerFor = parseFirstProviderFor(element.variable); + final providerFor = parseFirstProviderFor(variable); ProviderDeclarationElement? providerElement; if (providerFor != null) { providerElement = providerFor.$1; } else { - providerElement = - LegacyProviderDeclarationElement._parse(element.variable); + providerElement = LegacyProviderDeclarationElement._parse(variable); } if (providerElement == null) return null; diff --git a/packages/riverpod_lint/lib/src/lints/functional_ref.dart b/packages/riverpod_lint/lib/src/lints/functional_ref.dart index d36f10756..367af5ef6 100644 --- a/packages/riverpod_lint/lib/src/lints/functional_ref.dart +++ b/packages/riverpod_lint/lib/src/lints/functional_ref.dart @@ -59,7 +59,7 @@ class FunctionalRef extends RiverpodLintRule { final currentRefType = refNode.type; if (currentRefType is! NamedType) { - reporter.reportErrorForNode(_code, refNodeType); + reporter.atNode(refNodeType, _code); return; } final actualTypeArguments = @@ -69,7 +69,7 @@ class FunctionalRef extends RiverpodLintRule { expectedTypeArguments, actualTypeArguments, )) { - reporter.reportErrorForNode(_code, refNodeType); + reporter.atNode(refNodeType, _code); return; } }); diff --git a/packages/riverpod_lint/lib/src/lints/notifier_extends.dart b/packages/riverpod_lint/lib/src/lints/notifier_extends.dart index b92227da4..823597cbf 100644 --- a/packages/riverpod_lint/lib/src/lints/notifier_extends.dart +++ b/packages/riverpod_lint/lib/src/lints/notifier_extends.dart @@ -89,7 +89,7 @@ class NotifierExtends extends RiverpodLintRule { actualTypeArguments, )) { // No type specified. Underlining the ref name - reporter.reportErrorForNode(_code, extendsClause.superclass); + reporter.atNode(extendsClause.superclass, _code); return; } }); diff --git a/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart b/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart index cff96ffce..2a45c3dd5 100644 --- a/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart +++ b/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart @@ -39,7 +39,7 @@ class OnlyUseKeepAliveInsideKeepAlive extends RiverpodLintRule { // The enclosing provider is "autoDispose", so it is allowed to use other "autoDispose" providers if (provider.providerElement.isAutoDispose) return; - reporter.reportErrorForNode(_code, node.node); + reporter.atNode(node.node, _code); }); } } diff --git a/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart b/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart index 4612adc19..3ae21d724 100644 --- a/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart +++ b/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart @@ -275,11 +275,11 @@ class ProviderDependencies extends RiverpodLintRule { late final unit = list.node.thisOrAncestorOfType(); late final source = unit?.declaredElement?.source; - reporter.reportErrorForNode( - _code, + reporter.atNode( list.target, - [message.toString()], - [ + _code, + arguments: [message.toString()], + contextMessages: [ for (final dependency in missingDependencies) if (source != null) _MyDiagnostic( @@ -289,7 +289,7 @@ class ProviderDependencies extends RiverpodLintRule { length: dependency.node.length, ), ], - _Data(usedDependencies: usedDependencies, list: list), + data: _Data(usedDependencies: usedDependencies, list: list), ); }); } diff --git a/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart b/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart index 436ca68ca..03285e15b 100644 --- a/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart +++ b/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart @@ -35,11 +35,11 @@ class RiverpodSyntaxError extends RiverpodLintRule { if (location == null) return; - reporter.reportErrorForOffset( - _code, - location.offset, - location.length, - [error.message], + reporter.atOffset( + errorCode: _code, + offset: location.offset, + length: location.length, + arguments: [error.message], ); }); } diff --git a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart index 59e10318a..3bdbac7e8 100644 --- a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart +++ b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart @@ -62,7 +62,7 @@ class UnknownScopedUsage extends RiverpodLintRule { if (enclosingConstructorType != null && widgetType.isAssignableFromType(enclosingConstructorType)) return; - reporter.reportErrorForNode(code, identifier.node); + reporter.atNode(identifier.node, code); }); } } diff --git a/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart b/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart index 8d9d93be7..46730bcc3 100644 --- a/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart +++ b/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart @@ -52,7 +52,7 @@ class MissingLegacyImport extends RiverpodLintRule { if (compatibleImports.any(imports.contains)) return; - reporter.reportErrorForNode(_code, node); + reporter.atNode(node, code); } context.registry.addNamedType((node) { From f06a3108247a958896f04ac32c1f9fd956dc249f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Tue, 18 Jun 2024 04:45:23 +0200 Subject: [PATCH 323/387] Support retry --- melos.yaml | 2 + packages/flutter_riverpod/CHANGELOG.md | 2 + .../flutter_riverpod/lib/src/builders.dart | 8 + .../lib/src/core/provider_scope.dart | 11 + .../legacy/change_notifier_provider.dart | 3 + .../test/provider_scope_test.dart | 47 ++++ packages/hooks_riverpod/CHANGELOG.md | 2 + packages/riverpod/CHANGELOG.md | 2 + packages/riverpod/lib/riverpod.dart | 1 + packages/riverpod/lib/src/builder.dart | 48 ++++ packages/riverpod/lib/src/core/element.dart | 32 +++ packages/riverpod/lib/src/core/family.dart | 7 + .../riverpod/lib/src/core/foundation.dart | 12 + .../lib/src/core/modifiers/future.dart | 15 +- .../lib/src/core/override_with_value.dart | 1 + .../core/provider/functional_provider.dart | 1 + .../src/core/provider/notifier_provider.dart | 1 + .../lib/src/core/provider/provider.dart | 1 + .../lib/src/core/provider_container.dart | 10 + packages/riverpod/lib/src/framework.dart | 1 + .../lib/src/providers/async_notifier.dart | 1 + .../src/providers/async_notifier/family.dart | 3 + .../src/providers/async_notifier/orphan.dart | 3 + .../lib/src/providers/future_provider.dart | 5 + .../legacy/state_notifier_provider.dart | 4 + .../src/providers/legacy/state_provider.dart | 5 + .../riverpod/lib/src/providers/notifier.dart | 1 + .../lib/src/providers/notifier/family.dart | 3 + .../lib/src/providers/notifier/orphan.dart | 3 + .../riverpod/lib/src/providers/provider.dart | 5 + .../lib/src/providers/stream_notifier.dart | 1 + .../src/providers/stream_notifier/family.dart | 3 + .../src/providers/stream_notifier/orphan.dart | 3 + .../lib/src/providers/stream_provider.dart | 5 + .../framework/provider_container_test.dart | 2 + .../src/core/provider_container_test.dart | 17 ++ .../test/src/core/provider_element_test.dart | 205 +++++++++++++++++- packages/riverpod/test/src/matrix.dart | 45 ++-- .../src/matrix/async_notifier_provider.dart | 12 +- .../test/src/matrix/notifier_provider.dart | 12 +- .../src/matrix/stream_notifier_provider.dart | 25 ++- .../src/providers/future_provider_test.dart | 74 +++++++ .../src/providers/stream_notifier_test.dart | 65 ++++++ packages/riverpod/test/src/utils.dart | 29 ++- .../lib/src/errors.dart | 1 + .../lib/src/nodes/riverpod.dart | 14 ++ packages/riverpod_annotation/CHANGELOG.md | 1 + .../lib/src/riverpod_annotation.dart | 10 + packages/riverpod_generator/CHANGELOG.md | 2 + .../lib/src/templates/family.dart | 1 + .../lib/src/templates/provider.dart | 1 + .../riverpod_generator/test/retry_test.dart | 12 + .../bin/generate_providers.dart | 6 + 53 files changed, 744 insertions(+), 42 deletions(-) create mode 100644 packages/flutter_riverpod/test/provider_scope_test.dart create mode 100644 packages/riverpod/test/src/providers/future_provider_test.dart create mode 100644 packages/riverpod_generator/test/retry_test.dart diff --git a/melos.yaml b/melos.yaml index f7b090d9b..a272f577d 100644 --- a/melos.yaml +++ b/melos.yaml @@ -21,3 +21,5 @@ scripts: generate: run: melos exec --depends-on=lint_visitor_generator -- "dart run build_runner build -d" && melos exec --depends-on=build_runner --no-depends-on=lint_visitor_generator -- "dart run build_runner build -d" description: Build all generated files for Dart & Flutter packages in this project. + exclude: + - lint_visitor_generator diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md index d1eb490ae..75dd7aebb 100644 --- a/packages/flutter_riverpod/CHANGELOG.md +++ b/packages/flutter_riverpod/CHANGELOG.md @@ -9,6 +9,8 @@ - **Breaking** Some internal utils are no-longer exported. - Added support for `Ref/ProviderContainer.invalidate(provider, asReload: true)` - Removed deprecated `@ProviderScope.parent` +- Failing providers are now automatically retried after a delay. + The delay can be optionally configured. ## 3.0.0-dev.3 - 2023-11-27 diff --git a/packages/flutter_riverpod/lib/src/builders.dart b/packages/flutter_riverpod/lib/src/builders.dart index 8b5a5d852..ba87dc02b 100644 --- a/packages/flutter_riverpod/lib/src/builders.dart +++ b/packages/flutter_riverpod/lib/src/builders.dart @@ -8,6 +8,8 @@ // You can then use it in your terminal by executing: // generate_providers +// ignore_for_file: invalid_use_of_internal_member + import 'package:flutter/foundation.dart'; import 'package:meta/meta.dart'; @@ -231,11 +233,13 @@ class ChangeNotifierProviderFamilyBuilder { NotifierT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return ChangeNotifierProviderFamily( create, name: name, dependencies: dependencies, + retry: retry, ); } @@ -301,12 +305,14 @@ class AutoDisposeChangeNotifierProviderBuilder { NotifierT Function(Ref ref) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return ChangeNotifierProvider( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } @@ -325,12 +331,14 @@ class AutoDisposeChangeNotifierProviderFamilyBuilder { NotifierT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return ChangeNotifierProviderFamily( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } } diff --git a/packages/flutter_riverpod/lib/src/core/provider_scope.dart b/packages/flutter_riverpod/lib/src/core/provider_scope.dart index 264deb425..3437360d3 100644 --- a/packages/flutter_riverpod/lib/src/core/provider_scope.dart +++ b/packages/flutter_riverpod/lib/src/core/provider_scope.dart @@ -75,6 +75,7 @@ class ProviderScope extends StatefulWidget { super.key, this.overrides = const [], this.observers, + this.retry, required this.child, }); @@ -101,6 +102,15 @@ class ProviderScope extends StatefulWidget { return scope.container; } + /// The default retry logic used by providers associated to this container. + /// + /// The default implementation: + /// - has unlimited retries + /// - starts with a delay of 200ms + /// - doubles the delay on each retry up to 6.4 seconds + /// - retries all failures + final Retry? retry; + /// The part of the widget tree that can use Riverpod and has overridden providers. final Widget child; @@ -149,6 +159,7 @@ final class ProviderScopeState extends State { parent: parent, overrides: widget.overrides, observers: widget.observers, + retry: widget.retry, ); } 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 index 17ba5160e..7baea1590 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -87,6 +87,7 @@ final class ChangeNotifierProvider super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), @@ -104,6 +105,7 @@ final class ChangeNotifierProvider required super.isAutoDispose, super.from, super.argument, + super.retry, }); /// {@macro riverpod.autoDispose} @@ -227,6 +229,7 @@ class ChangeNotifierProviderFamily super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( providerFactory: ChangeNotifierProvider.internal, allTransitiveDependencies: diff --git a/packages/flutter_riverpod/test/provider_scope_test.dart b/packages/flutter_riverpod/test/provider_scope_test.dart new file mode 100644 index 000000000..9396aa694 --- /dev/null +++ b/packages/flutter_riverpod/test/provider_scope_test.dart @@ -0,0 +1,47 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; + +void main() { + group('ProviderScope', () { + group('retry', () { + testWidgets('passes the value to the ProviderContainer', (tester) async { + Duration? retry(int count, Object error) => Duration.zero; + + await tester.pumpWidget( + ProviderScope(retry: retry, child: Container()), + ); + + final element = tester.element(find.byType(Container)); + final container = ProviderScope.containerOf(element); + + expect(container.retry, retry); + }); + + testWidgets('works in widget tests', (tester) async { + await tester.pumpWidget( + ProviderScope( + retry: (retryCount, error) => const Duration(milliseconds: 10), + child: Container(), + ), + ); + var buildCount = 0; + final provider = Provider((ref) { + buildCount++; + throw UnimplementedError(); + }); + + final element = tester.element(find.byType(Container)); + final container = ProviderScope.containerOf(element); + + container.listen(provider, (a, b) {}, onError: (err, stack) {}); + + expect(buildCount, 1); + + await tester.pump(const Duration(milliseconds: 10)); + + expect(buildCount, 2); + }); + }); + }); +} diff --git a/packages/hooks_riverpod/CHANGELOG.md b/packages/hooks_riverpod/CHANGELOG.md index df9ce758d..d17714dc6 100644 --- a/packages/hooks_riverpod/CHANGELOG.md +++ b/packages/hooks_riverpod/CHANGELOG.md @@ -3,6 +3,8 @@ - **Breaking**: `ChangeNotifierProvider`, `StateProvider` and `StateNotifierProvider` are moved out of `package:hooks_riverpod/hooks_riverpod.dart` to `package:hooks_riverpod/legacy.dart`. +- Failing providers are now automatically retried after a delay. + The delay can be optionally configured. ## 3.0.0-dev.3 - 2023-11-27 diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 4c89b9d4e..a8e450290 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -32,6 +32,8 @@ issues where an old build of a provider is still performing work. - Updated `AsyncValue` documentations to use pattern matching. - Added support for `Ref/ProviderContainer.invalidate(provider, asReload: true)` +- Failing providers are now automatically retried after a delay. + The delay can be optionally configured. - Fixed a bug when overriding a specific provider of a `family`, combined with `dependencies: [family]` ## 3.0.0-dev.3 - 2023-11-27 diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 0d14e569f..2b993a3f0 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -2,6 +2,7 @@ export 'src/core/async_value.dart' hide AsyncTransition; export 'src/framework.dart' hide ProviderScheduler, + Retry, debugCanModifyProviders, Vsync, $ValueProvider, diff --git a/packages/riverpod/lib/src/builder.dart b/packages/riverpod/lib/src/builder.dart index 034a3c5aa..eb530a5e6 100644 --- a/packages/riverpod/lib/src/builder.dart +++ b/packages/riverpod/lib/src/builder.dart @@ -232,11 +232,13 @@ class StateProviderFamilyBuilder { StateT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return StateProviderFamily( create, name: name, dependencies: dependencies, + retry: retry, ); } @@ -302,12 +304,14 @@ class AutoDisposeStateProviderBuilder { StateT Function(Ref ref) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return StateProvider( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } @@ -325,12 +329,14 @@ class AutoDisposeStateProviderFamilyBuilder { StateT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return StateProviderFamily( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } } @@ -345,11 +351,13 @@ class StateNotifierProviderFamilyBuilder { NotifierT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return StateNotifierProviderFamily( create, name: name, dependencies: dependencies, + retry: retry, ); } @@ -368,12 +376,14 @@ class AutoDisposeStateNotifierProviderBuilder { NotifierT Function(Ref ref) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return StateNotifierProvider( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } @@ -392,12 +402,14 @@ class AutoDisposeStateNotifierProviderFamilyBuilder { NotifierT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return StateNotifierProviderFamily( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } } @@ -411,11 +423,13 @@ class ProviderFamilyBuilder { StateT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return ProviderFamily( create, name: name, dependencies: dependencies, + retry: retry, ); } @@ -433,12 +447,14 @@ class AutoDisposeProviderBuilder { StateT Function(Ref ref) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return Provider( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } @@ -456,12 +472,14 @@ class AutoDisposeProviderFamilyBuilder { StateT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return ProviderFamily( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } } @@ -475,11 +493,13 @@ class FutureProviderFamilyBuilder { FutureOr Function(Ref> ref, ArgT param) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return FutureProviderFamily( create, name: name, dependencies: dependencies, + retry: retry, ); } @@ -497,12 +517,14 @@ class AutoDisposeFutureProviderBuilder { FutureOr Function(Ref> ref) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return FutureProvider( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } @@ -520,12 +542,14 @@ class AutoDisposeFutureProviderFamilyBuilder { FutureOr Function(Ref> ref, ArgT param) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return FutureProviderFamily( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } } @@ -539,11 +563,13 @@ class StreamProviderFamilyBuilder { Stream Function(Ref> ref, ArgT param) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return StreamProviderFamily( create, name: name, dependencies: dependencies, + retry: retry, ); } @@ -561,12 +587,14 @@ class AutoDisposeStreamProviderBuilder { Stream Function(Ref> ref) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return StreamProvider( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } @@ -584,12 +612,14 @@ class AutoDisposeStreamProviderFamilyBuilder { Stream Function(Ref> ref, ArgT param) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return StreamProviderFamily( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } } @@ -604,12 +634,14 @@ class AutoDisposeNotifierProviderBuilder { NotifierT Function() create, { String? name, Iterable? dependencies, + Retry? retry, }) { return NotifierProvider( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } @@ -628,11 +660,13 @@ class NotifierProviderFamilyBuilder { NotifierT Function() create, { String? name, Iterable? dependencies, + Retry? retry, }) { return NotifierProviderFamily.internal( create, name: name, dependencies: dependencies, + retry: retry, ); } @@ -651,12 +685,14 @@ class AutoDisposeNotifierProviderFamilyBuilder { NotifierT Function() create, { String? name, Iterable? dependencies, + Retry? retry, }) { return NotifierProviderFamily.internal( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } } @@ -671,12 +707,14 @@ class AutoDisposeStreamNotifierProviderBuilder { NotifierT Function() create, { String? name, Iterable? dependencies, + Retry? retry, }) { return StreamNotifierProvider( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } @@ -695,11 +733,13 @@ class StreamNotifierProviderFamilyBuilder { NotifierT Function() create, { String? name, Iterable? dependencies, + Retry? retry, }) { return StreamNotifierProviderFamily.internal( create, name: name, dependencies: dependencies, + retry: retry, ); } @@ -718,12 +758,14 @@ class AutoDisposeStreamNotifierProviderFamilyBuilder { NotifierT Function() create, { String? name, Iterable? dependencies, + Retry? retry, }) { return StreamNotifierProviderFamily.internal( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } } @@ -738,12 +780,14 @@ class AutoDisposeAsyncNotifierProviderBuilder { NotifierT Function() create, { String? name, Iterable? dependencies, + Retry? retry, }) { return AsyncNotifierProvider( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } @@ -762,11 +806,13 @@ class AsyncNotifierProviderFamilyBuilder { NotifierT Function() create, { String? name, Iterable? dependencies, + Retry? retry, }) { return AsyncNotifierProviderFamily.internal( create, name: name, dependencies: dependencies, + retry: retry, ); } @@ -785,12 +831,14 @@ class AutoDisposeAsyncNotifierProviderFamilyBuilder { NotifierT Function() create, { String? name, Iterable? dependencies, + Retry? retry, }) { return AsyncNotifierProviderFamily.internal( create, name: name, isAutoDispose: true, dependencies: dependencies, + retry: retry, ); } } diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index cc2ea4fb0..3eb38db0d 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -46,6 +46,12 @@ abstract class ProviderElement implements WrappedNode { /// {@macro riverpod.provider_element_base} ProviderElement(this.pointer); + static Duration? _defaultRetry(int retryCount, Object error) { + return Duration( + milliseconds: math.min(200 * (retryCount + 1), 6400), + ); + } + static ProviderElement? _debugCurrentlyBuildingElement; /// The last result of [ProviderBase.debugGetCreateSourceHash]. @@ -108,6 +114,8 @@ abstract class ProviderElement implements WrappedNode { bool _didChangeDependency = false; var _didCancelOnce = false; + var _retryCount = 0; + Timer? _pendingRetryTimer; /// Whether the assert that prevents [requireState] from returning /// if the state was not set before is enabled. @@ -393,6 +401,8 @@ This could mean a few things: /// Invokes [create] and handles errors. @internal void buildState(Ref ref) { + if (_didChangeDependency) _retryCount = 0; + ProviderElement? debugPreviouslyBuildingElement; final previousDidChangeDependency = _didChangeDependency; _didChangeDependency = false; @@ -408,6 +418,7 @@ This could mean a few things: if (kDebugMode) _debugDidSetState = true; _stateResult = Result.error(err, stack); + triggerRetry(err); } finally { _didBuild = true; if (kDebugMode) { @@ -421,6 +432,24 @@ This could mean a few things: } } + @protected + void triggerRetry(Object error) { + final retry = origin.retry ?? container.retry ?? _defaultRetry; + + // Capture exceptions. On error, stop retrying if the retry + // function failed + runGuarded(() { + final duration = retry(_retryCount, error); + if (duration == null) return; + + _pendingRetryTimer = Timer(duration, () { + _pendingRetryTimer = null; + _retryCount++; + invalidateSelf(asReload: false); + }); + }); + } + void _debugAssertNotificationAllowed() { if (_debugSkipNotifyListenersAsserts) return; @@ -638,6 +667,9 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ref._mounted = false; + _pendingRetryTimer?.cancel(); + _pendingRetryTimer = null; + final subscriptions = _subscriptions; if (subscriptions != null) { while (subscriptions.isNotEmpty) { diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index 16473c72b..10dedc617 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -15,6 +15,7 @@ typedef FunctionalProviderFactory< // required bool isAutoDispose, required Family from, required ArgT argument, + required Retry? retry, }); /// A typedef representing the constructor of a [NotifierProvider]. @@ -35,6 +36,7 @@ typedef ClassProviderFactory< // required bool isAutoDispose, required Family from, required ArgT argument, + required Retry? retry, }); /// A [Create] equivalent used by [Family]. @@ -50,6 +52,7 @@ abstract class Family extends ProviderOrFamily implements _FamilyOverride { required super.dependencies, required super.allTransitiveDependencies, required super.isAutoDispose, + required super.retry, }); @override @@ -88,6 +91,7 @@ class FunctionalFamily< // required super.dependencies, required super.allTransitiveDependencies, required super.isAutoDispose, + required super.retry, }) : _providerFactory = providerFactory; final FunctionalProviderFactory, ArgT> @@ -110,6 +114,7 @@ class FunctionalFamily< // argument: argument, dependencies: null, allTransitiveDependencies: null, + retry: retry, ); } @@ -162,6 +167,7 @@ class ClassFamily< // required super.dependencies, required super.allTransitiveDependencies, required super.isAutoDispose, + required super.retry, }); @internal @@ -177,6 +183,7 @@ class ClassFamily< // name: name, isAutoDispose: isAutoDispose, from: this, + retry: retry, argument: argument, dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index 17b26f39c..a8e236ac7 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -11,6 +11,7 @@ sealed class ProviderOrFamily implements ProviderListenableOrFamily { required this.dependencies, required this.allTransitiveDependencies, required this.isAutoDispose, + required this.retry, }); /// The family that this provider/family depends on. @@ -23,6 +24,17 @@ sealed class ProviderOrFamily implements ProviderListenableOrFamily { /// {@endtemplate} final String? name; + /// {@template riverpod.retry} + /// The default retry logic used by providers associated to this container. + /// + /// The default implementation: + /// - has unlimited retries + /// - starts with a delay of 200ms + /// - doubles the delay on each retry up to 6.4 seconds + /// - retries all failures + /// {@endtemplate} + final Retry? retry; + /// The list of providers that this provider potentially depends on. /// /// Specifying this list is strictly equivalent to saying "This provider may diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 5a1a8981e..0ffe7d34f 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -205,6 +205,7 @@ mixin FutureModifierClassElement< StackTrace stackTrace, { required bool seamless, }) { + triggerRetry(error); onError(AsyncError(error, stackTrace), seamless: seamless); } } @@ -422,14 +423,17 @@ mixin FutureModifierElement on ProviderElement> { }) { onLoading(AsyncLoading(), seamless: seamless); + void callOnError(Object error, StackTrace stackTrace) { + triggerRetry(error); + onError(AsyncError(error, stackTrace), seamless: seamless); + } + try { final sub = _cancelSubscription = listen( data: (value) { onData(AsyncData(value), seamless: seamless); }, - error: (error, stack) { - onError(AsyncError(error, stack), seamless: seamless); - }, + error: callOnError, last: (last, sub) { assert(_lastFuture == null, 'bad state'); assert(_lastFutureSub == null, 'bad state'); @@ -447,10 +451,7 @@ mixin FutureModifierElement on ProviderElement> { 'An async operation is pending but the state for provider.future was not initialized.', ); } catch (error, stackTrace) { - onError( - AsyncError(error, stackTrace), - seamless: seamless, - ); + callOnError(error, stackTrace); } } diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index e795d5f9a..b7b16fc13 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -14,6 +14,7 @@ final class $ValueProvider extends ProviderBase allTransitiveDependencies: null, dependencies: null, isAutoDispose: false, + retry: null, ); final StateT _value; diff --git a/packages/riverpod/lib/src/core/provider/functional_provider.dart b/packages/riverpod/lib/src/core/provider/functional_provider.dart index 24a1bb6b5..c73ffce86 100644 --- a/packages/riverpod/lib/src/core/provider/functional_provider.dart +++ b/packages/riverpod/lib/src/core/provider/functional_provider.dart @@ -15,6 +15,7 @@ abstract base class $FunctionalProvider< // required super.dependencies, required super.allTransitiveDependencies, required super.isAutoDispose, + required super.retry, }); /// Clone a provider with a different initialization method. diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index 1d07a643e..dd2496991 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -100,6 +100,7 @@ abstract base class $ClassProvider< // required super.dependencies, required super.allTransitiveDependencies, required super.isAutoDispose, + required super.retry, required this.runNotifierBuildOverride, }); diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index cdd6fa09f..d968c056a 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -35,6 +35,7 @@ abstract base class ProviderBase extends ProviderOrFamily required super.dependencies, required super.allTransitiveDependencies, required super.isAutoDispose, + required super.retry, }) : assert( from == null || allTransitiveDependencies == null, 'When from a family, providers cannot specify dependencies.', diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 4f1fe72b4..bbef4a593 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -234,6 +234,9 @@ class ProviderDirectory implements _PointerBase { } } +@internal +typedef Retry = Duration? Function(int retryCount, Object error); + /// An object responsible for storing the a O(1) access to providers, /// while also enabling the "scoping" of providers and ensuring all [ProviderContainer]s /// are in sync. @@ -570,9 +573,11 @@ class ProviderContainer implements WrappedNode { ProviderContainer? parent, List overrides = const [], List? observers, + Retry? retry, }) : _debugOverridesLength = overrides.length, depth = parent == null ? 0 : parent.depth + 1, _parent = parent, + retry = retry ?? parent?.retry, observers = [ ...?observers, if (parent != null) ...parent.observers, @@ -648,11 +653,13 @@ class ProviderContainer implements WrappedNode { ProviderContainer? parent, List overrides = const [], List? observers, + Retry? retry, }) { final container = ProviderContainer( parent: parent, overrides: overrides, observers: observers, + retry: retry, ); test.addTearDown(container.dispose); @@ -665,6 +672,9 @@ class ProviderContainer implements WrappedNode { @internal late final ProviderScheduler scheduler = ProviderScheduler(); + /// {@macro riverpod.retry} + final Retry? retry; + /// How deep this [ProviderContainer] is in the graph of containers. /// /// Starts at 0. diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index ac3c940ab..1e1f7d950 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -2,6 +2,7 @@ library framework; import 'dart:async'; import 'dart:collection'; +import 'dart:math' as math; import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index dd008f83e..380c73319 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -41,6 +41,7 @@ abstract base class $AsyncNotifierProvider< // required super.allTransitiveDependencies, required super.isAutoDispose, required super.runNotifierBuildOverride, + required super.retry, }); } diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index 6a9e6a161..21142ea3c 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -45,6 +45,7 @@ class AsyncNotifierProviderFamily< // super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( providerFactory: FamilyAsyncNotifierProvider._, allTransitiveDependencies: @@ -69,6 +70,7 @@ final class FamilyAsyncNotifierProvider< // required super.argument, required super.isAutoDispose, required super.runNotifierBuildOverride, + required super.retry, }); FamilyAsyncNotifierProvider _copyWith({ @@ -85,6 +87,7 @@ final class FamilyAsyncNotifierProvider< // argument: argument, isAutoDispose: isAutoDispose, runNotifierBuildOverride: build ?? runNotifierBuildOverride, + retry: retry, ); } diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index 2069fa608..a8d91f19f 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -67,6 +67,7 @@ final class AsyncNotifierProvider< // super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), @@ -86,6 +87,7 @@ final class AsyncNotifierProvider< // required super.argument, required super.isAutoDispose, required super.runNotifierBuildOverride, + required super.retry, }); /// {@macro riverpod.autoDispose} @@ -114,6 +116,7 @@ final class AsyncNotifierProvider< // argument: argument, isAutoDispose: isAutoDispose, runNotifierBuildOverride: build ?? runNotifierBuildOverride, + retry: retry, ); } diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 1c442ee0e..a9ed4e201 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -104,6 +104,7 @@ final class FutureProvider super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), @@ -121,6 +122,7 @@ final class FutureProvider required super.from, required super.argument, required super.isAutoDispose, + required super.retry, }); /// {@macro riverpod.autoDispose} @@ -154,6 +156,7 @@ final class FutureProvider from: from, argument: argument, isAutoDispose: isAutoDispose, + retry: retry, ); } } @@ -201,6 +204,7 @@ class FutureProviderFamily extends FunctionalFamily< super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( providerFactory: FutureProvider.internal, allTransitiveDependencies: @@ -215,5 +219,6 @@ class FutureProviderFamily extends FunctionalFamily< required super.dependencies, required super.allTransitiveDependencies, required super.isAutoDispose, + required super.retry, }) : super(providerFactory: FutureProvider.internal); } diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index e5b85785c..de3fe65fb 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -91,6 +91,7 @@ final class StateNotifierProvider< // super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), @@ -108,6 +109,7 @@ final class StateNotifierProvider< // required super.from, required super.argument, required super.isAutoDispose, + required super.retry, }); /// {@macro riverpod.autoDispose} @@ -157,6 +159,7 @@ final class StateNotifierProvider< // from: from, argument: argument, isAutoDispose: isAutoDispose, + retry: retry, ); } } @@ -230,6 +233,7 @@ class StateNotifierProviderFamily, T, Arg> super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( providerFactory: StateNotifierProvider.internal, allTransitiveDependencies: diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index f88c531f2..4d1b3cdaa 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -56,6 +56,7 @@ final class StateProvider extends $FunctionalProvider super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), @@ -73,6 +74,7 @@ final class StateProvider extends $FunctionalProvider required super.isAutoDispose, required super.from, required super.argument, + required super.retry, }); /// {@macro riverpod.autoDispose} @@ -107,6 +109,7 @@ final class StateProvider extends $FunctionalProvider from: from, argument: argument, isAutoDispose: isAutoDispose, + retry: retry, ); } } @@ -186,6 +189,7 @@ class StateProviderFamily extends FunctionalFamily< // super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( providerFactory: StateProvider.internal, allTransitiveDependencies: @@ -200,5 +204,6 @@ class StateProviderFamily extends FunctionalFamily< // super.dependencies, required super.allTransitiveDependencies, required super.isAutoDispose, + required super.retry, }) : super(providerFactory: StateProvider.internal); } diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index d8a3b2dbf..fbc720dfb 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -96,6 +96,7 @@ abstract base class $NotifierProvider // required super.allTransitiveDependencies, required super.isAutoDispose, required super.runNotifierBuildOverride, + required super.retry, }); } diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index 2ee3b77bc..104328155 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -30,6 +30,7 @@ final class FamilyNotifierProvider // required super.argument, required super.isAutoDispose, required super.runNotifierBuildOverride, + required super.retry, }); final NotifierT Function() _createNotifier; @@ -59,6 +60,7 @@ final class FamilyNotifierProvider // runNotifierBuildOverride: build ?? runNotifierBuildOverride, from: from, argument: argument, + retry: retry, ); } @@ -97,6 +99,7 @@ class NotifierProviderFamily< super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( providerFactory: FamilyNotifierProvider._, allTransitiveDependencies: diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart index acd2bed43..86d4f6abe 100644 --- a/packages/riverpod/lib/src/providers/notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -84,6 +84,7 @@ final class NotifierProvider, StateT> super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), @@ -103,6 +104,7 @@ final class NotifierProvider, StateT> required super.argument, required super.isAutoDispose, required super.runNotifierBuildOverride, + required super.retry, }); /// {@macro riverpod.autoDispose} @@ -138,6 +140,7 @@ final class NotifierProvider, StateT> argument: argument, isAutoDispose: isAutoDispose, runNotifierBuildOverride: build ?? runNotifierBuildOverride, + retry: retry, ); } diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 2d63a1517..54d6355cb 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -22,6 +22,7 @@ base class Provider extends $FunctionalProvider super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), @@ -39,6 +40,7 @@ base class Provider extends $FunctionalProvider required super.from, required super.argument, required super.isAutoDispose, + required super.retry, }); /// {@macro riverpod.autoDispose} @@ -69,6 +71,7 @@ base class Provider extends $FunctionalProvider from: from, argument: argument, isAutoDispose: isAutoDispose, + retry: retry, allTransitiveDependencies: null, dependencies: null, name: null, @@ -366,6 +369,7 @@ class ProviderFamily super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( providerFactory: Provider.internal, allTransitiveDependencies: @@ -380,5 +384,6 @@ class ProviderFamily required super.dependencies, required super.allTransitiveDependencies, required super.isAutoDispose, + required super.retry, }) : super(providerFactory: Provider.internal); } diff --git a/packages/riverpod/lib/src/providers/stream_notifier.dart b/packages/riverpod/lib/src/providers/stream_notifier.dart index eaebc6885..e7ed41a05 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier.dart @@ -42,6 +42,7 @@ abstract base class $StreamNotifierProvider< required super.allTransitiveDependencies, required super.isAutoDispose, required super.runNotifierBuildOverride, + required super.retry, }); } diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index b116538ac..d1a574297 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -43,6 +43,7 @@ final class FamilyStreamNotifierProvider< // required super.argument, required super.isAutoDispose, required super.runNotifierBuildOverride, + required super.retry, }); final NotifierT Function() _createNotifier; @@ -76,6 +77,7 @@ final class FamilyStreamNotifierProvider< // runNotifierBuildOverride: build ?? runNotifierBuildOverride, from: from, argument: argument, + retry: retry, ); } @@ -116,6 +118,7 @@ class StreamNotifierProviderFamily< // super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( providerFactory: FamilyStreamNotifierProvider._, allTransitiveDependencies: diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index 39a852e54..153c6b6eb 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -55,6 +55,7 @@ final class StreamNotifierProvider< // super.dependencies, super.runNotifierBuildOverride, super.isAutoDispose = false, + super.retry, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), @@ -73,6 +74,7 @@ final class StreamNotifierProvider< // required super.argument, required super.isAutoDispose, required super.runNotifierBuildOverride, + required super.retry, }); /// {@macro riverpod.autoDispose} @@ -100,6 +102,7 @@ final class StreamNotifierProvider< // argument: argument, isAutoDispose: isAutoDispose, runNotifierBuildOverride: build ?? runNotifierBuildOverride, + retry: retry, ); } diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index 128f0e3b2..27befb850 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -93,6 +93,7 @@ base class StreamProvider super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( allTransitiveDependencies: computeAllTransitiveDependencies(dependencies), @@ -110,6 +111,7 @@ base class StreamProvider required super.from, required super.argument, required super.isAutoDispose, + required super.retry, }); /// {@macro riverpod.autoDispose} @@ -143,6 +145,7 @@ base class StreamProvider from: from, argument: argument, isAutoDispose: isAutoDispose, + retry: retry, ); } } @@ -235,6 +238,7 @@ class StreamProviderFamily extends FunctionalFamily< super.name, super.dependencies, super.isAutoDispose = false, + super.retry, }) : super( providerFactory: StreamProvider.internal, allTransitiveDependencies: @@ -249,5 +253,6 @@ class StreamProviderFamily extends FunctionalFamily< required super.dependencies, required super.allTransitiveDependencies, required super.isAutoDispose, + required super.retry, }) : super(providerFactory: StreamProvider.internal); } diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 40af8b7e8..6f167cfd4 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -23,6 +23,7 @@ void main() { name: null, dependencies: null, allTransitiveDependencies: null, + retry: null, (ref) { constantHashBuild(); return 0; @@ -36,6 +37,7 @@ void main() { argument: null, name: null, dependencies: null, + retry: null, allTransitiveDependencies: null, (ref) { changingHashBuild(); diff --git a/packages/riverpod/test/src/core/provider_container_test.dart b/packages/riverpod/test/src/core/provider_container_test.dart index 385c26da4..d71c68742 100644 --- a/packages/riverpod/test/src/core/provider_container_test.dart +++ b/packages/riverpod/test/src/core/provider_container_test.dart @@ -1164,6 +1164,23 @@ void main() { }); }); + group('retry', () { + test('inherits retry from parent if arg is null', () { + Duration? rootRetry(int count, Object error) => Duration.zero; + Duration? subRetry(int count, Object error) => Duration.zero; + + final root = ProviderContainer.test(retry: rootRetry); + final container = ProviderContainer.test(parent: root); + final container2 = ProviderContainer.test( + parent: root, + retry: subRetry, + ); + + expect(container.retry, root.retry); + expect(container2.retry, subRetry); + }); + }); + test( 'Reading a provider with deps does not mount those deps if unused by the provider', () { diff --git a/packages/riverpod/test/src/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart index 631820e92..0a41456aa 100644 --- a/packages/riverpod/test/src/core/provider_element_test.dart +++ b/packages/riverpod/test/src/core/provider_element_test.dart @@ -1,11 +1,212 @@ +import 'dart:async'; + import 'package:mockito/mockito.dart'; import 'package:riverpod/src/internals.dart'; import 'package:test/test.dart'; -import '../../old/utils.dart'; +import '../../third_party/fake_async.dart'; +import '../utils.dart'; void main() { group('ProviderElement', () { + group('retry', () { + test('default retry delays from 200ms to 6.4 seconds', () {}); + + group('custom retry', () { + test( + 'if returns null, stops retrying', + () => fakeAsync((fake) { + final container = ProviderContainer.test(retry: (_, __) => null); + var buildCount = 0; + final provider = Provider((ref) { + buildCount++; + throw StateError(''); + }); + + container.listen( + provider, + (prev, next) {}, + fireImmediately: true, + onError: (e, s) {}, + ); + expect(buildCount, 1); + + fake.elapse(const Duration(seconds: 100)); + + expect(buildCount, 1); + }), + ); + + test( + 'passes the correct retry count and error', + () => fakeAsync((fake) { + final retry = RetryMock(); + when(retry(any, any)).thenReturn(const Duration(milliseconds: 200)); + final container = ProviderContainer.test(retry: retry.call); + final provider = Provider((ref) => throw StateError('')); + + container.listen( + provider, + (prev, next) {}, + fireImmediately: true, + onError: (e, s) {}, + ); + + verifyOnly(retry, retry(0, isStateError)); + + fake.elapse(const Duration(milliseconds: 200)); + + verifyOnly(retry, retry(1, isStateError)); + + fake.elapse(const Duration(milliseconds: 200)); + + verifyOnly(retry, retry(2, isStateError)); + + container.invalidate(provider, asReload: true); + fake.elapse(const Duration(milliseconds: 50)); + + // On reload, resets counter to 0 + verifyOnly(retry, retry(0, isStateError)); + }), + ); + + test( + 'delays by the duration returned', + () => fakeAsync((fake) { + final container = ProviderContainer.test( + retry: (_, __) => const Duration(milliseconds: 3), + ); + final errorListener = ErrorListener(); + var msg = '0'; + final provider = Provider((ref) => throw StateError(msg)); + + container.listen( + provider, + (prev, next) {}, + fireImmediately: true, + onError: errorListener.call, + ); + + verifyOnly( + errorListener, + errorListener( + argThat(isStateErrorWith(message: '0')), + any, + ), + ); + + msg = '1'; + fake.elapse(const Duration(milliseconds: 1)); + + verifyNoMoreInteractions(errorListener); + + fake.elapse(const Duration(milliseconds: 1)); + + verifyNoMoreInteractions(errorListener); + + fake.elapse(const Duration(milliseconds: 1)); + + verifyOnly( + errorListener, + errorListener( + argThat(isStateErrorWith(message: '1')), + any, + ), + ); + }), + ); + + test( + 'if the retry function throws, stops retrying and report the error', + () => fakeAsync((fake) { + final errors = []; + runZonedGuarded( + () { + final container = ProviderContainer.test( + retry: (_, __) => throw StateError('Oops!'), + ); + final errorListener = ErrorListener(); + final provider = Provider((ref) => throw StateError('msg')); + + container.listen( + provider, + (prev, next) {}, + fireImmediately: true, + onError: errorListener.call, + ); + + verifyOnly( + errorListener, + errorListener( + argThat(isStateErrorWith(message: 'msg')), + any, + ), + ); + + fake.elapse(const Duration(milliseconds: 1)); + + verifyNoMoreInteractions(errorListener); + }, + (e, s) => errors.add(e), + ); + + expect( + errors, + equals([isStateErrorWith(message: 'Oops!')]), + ); + }), + ); + + test( + "If the provider specifies retry, uses the provider's " + 'logic instead of the container one.', () { + final retry1 = RetryMock(); + final retry2 = RetryMock(); + final container = ProviderContainer.test( + retry: retry1.call, + ); + + final provider = Provider( + retry: retry2.call, + (ref) => throw StateError(''), + ); + + container.listen( + provider, + (prev, next) {}, + fireImmediately: true, + onError: (e, s) {}, + ); + + verifyOnly(retry2, retry2(0, isStateError)); + verifyNoMoreInteractions(retry1); + }); + }); + + test( + 'disposes of the timer when the element is disposed', + () => fakeAsync((fake) { + final retry = RetryMock(); + when(retry(any, any)).thenReturn(const Duration(milliseconds: 200)); + final container = ProviderContainer.test(retry: retry.call); + final provider = Provider((ref) => throw StateError('')); + + container.listen( + provider, + (prev, next) {}, + fireImmediately: true, + onError: (e, s) {}, + ); + + expect(fake.pendingTimers, hasLength(1)); + + container.dispose(); + + expect(fake.pendingTimers, isEmpty); + }), + ); + }); + test( 'does not throw outdated error when a dependency is flushed while the dependent is building', () async { @@ -34,7 +235,7 @@ void main() { // schedules `dep` and `dependent` to rebuild // Will build `dependent` before `dep` because `dependent` doesn't depend on `dep` yet - // And since nothing is watchin `dep` at the moment, then `dependent` will + // And since nothing is watching `dep` at the moment, then `dependent` will // rebuild before `dep` even though `dep` is its ancestor. // This is fine since nothing is listening to `dep` yet, but it should // not cause certain assertions to trigger diff --git a/packages/riverpod/test/src/matrix.dart b/packages/riverpod/test/src/matrix.dart index cefe6a1d4..09cd1bd27 100644 --- a/packages/riverpod/test/src/matrix.dart +++ b/packages/riverpod/test/src/matrix.dart @@ -1,7 +1,7 @@ import 'dart:async'; import 'package:riverpod/src/internals.dart'; -import 'package:test/test.dart'; +import 'package:test/test.dart' hide Retry; part 'matrix/async_notifier_provider.dart'; part 'matrix/stream_notifier_provider.dart'; @@ -36,6 +36,7 @@ typedef ProviderFactory BaseT Function(RefT ref, Object? arg) create, { String? name, Iterable? dependencies, + Retry? retry, }); extension $Modifiers on ProviderBase { @@ -58,96 +59,108 @@ extension $Modifiers on ProviderBase { final providerFactory = , Ref>>[ - (create, {name, dependencies}) => ([arg]) { + (create, {name, dependencies, retry}) => ([arg]) { return Provider( (ref) => create(ref, arg), name: name, dependencies: dependencies, + retry: retry, ); }, - (create, {name, dependencies}) => ([arg]) { + (create, {name, dependencies, retry}) => ([arg]) { return Provider.autoDispose( (ref) => create(ref, arg), name: name, dependencies: dependencies, + retry: retry, ); }, - (create, {name, dependencies}) => ([arg]) { + (create, {name, dependencies, retry}) => ([arg]) { return Provider.family( (ref, arg) => create(ref, arg), name: name, dependencies: dependencies, + retry: retry, )(arg); }, - (create, {name, dependencies}) => ([arg]) { + (create, {name, dependencies, retry}) => ([arg]) { return Provider.autoDispose.family( (ref, arg) => create(ref, arg), name: name, dependencies: dependencies, + retry: retry, )(arg); }, ]; final futureProviderFactories = , FutureProvider, Ref>>[ - (create, {name, dependencies}) => ([arg]) { + (create, {name, dependencies, retry}) => ([arg]) { return FutureProvider( (ref) => create(ref, arg), name: name, dependencies: dependencies, + retry: retry, ); }, - (create, {name, dependencies}) => ([arg]) { + (create, {name, dependencies, retry}) => ([arg]) { return FutureProvider.autoDispose( (ref) => create(ref, arg), name: name, dependencies: dependencies, + retry: retry, ); }, - (create, {name, dependencies}) => ([arg]) { + (create, {name, dependencies, retry}) => ([arg]) { return FutureProvider.family( (ref, arg) => create(ref, arg), name: name, dependencies: dependencies, + retry: retry, )(arg); }, - (create, {name, dependencies}) => ([arg]) { + (create, {name, dependencies, retry}) => ([arg]) { return FutureProvider.autoDispose.family( (ref, arg) => create(ref, arg), name: name, dependencies: dependencies, + retry: retry, )(arg); }, ]; final streamProviderFactories = , StreamProvider, Ref>>[ - (create, {name, dependencies}) => ([arg]) { + (create, {name, dependencies, retry}) => ([arg]) { return StreamProvider( (ref) => create(ref, arg), name: name, dependencies: dependencies, + retry: retry, ); }, - (create, {name, dependencies}) => ([arg]) { + (create, {name, dependencies, retry}) => ([arg]) { return StreamProvider.autoDispose( (ref) => create(ref, arg), name: name, dependencies: dependencies, + retry: retry, ); }, - (create, {name, dependencies}) => ([arg]) { + (create, {name, dependencies, retry}) => ([arg]) { return StreamProvider.family( (ref, arg) => create(ref, arg), name: name, dependencies: dependencies, + retry: retry, )(arg); }, - (create, {name, dependencies}) => ([arg]) { + (create, {name, dependencies, retry}) => ([arg]) { return StreamProvider.autoDispose.family( (ref, arg) => create(ref, arg), name: name, dependencies: dependencies, + retry: retry, )(arg); }, ]; @@ -155,15 +168,17 @@ final streamProviderFactories = final asyncProviderFactory = >, Ref>>[ for (final factory in futureProviderFactories) - (create, {name, dependencies}) => factory( + (create, {name, dependencies, retry}) => factory( (ref, arg) async => create(ref, arg), name: name, dependencies: dependencies, + retry: retry, ), for (final factory in streamProviderFactories) - (create, {name, dependencies}) => factory( + (create, {name, dependencies, retry}) => factory( (ref, arg) => Stream.value(create(ref, arg)), name: name, dependencies: dependencies, + retry: retry, ), ]; diff --git a/packages/riverpod/test/src/matrix/async_notifier_provider.dart b/packages/riverpod/test/src/matrix/async_notifier_provider.dart index 92c5c8174..714660222 100644 --- a/packages/riverpod/test/src/matrix/async_notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/async_notifier_provider.dart @@ -18,11 +18,12 @@ final asyncNotifierProviderFactory = TestMatrix( AsyncNotifierProvider, StateT>( () => create() as AsyncNotifier, ), - value: (create, {name, dependencies}) => ([arg]) { + value: (create, {name, dependencies, retry}) => ([arg]) { return AsyncNotifierProvider, Object?>( () => create(null, arg) as AsyncNotifier, name: name, dependencies: dependencies, + retry: retry, ); }, ), @@ -44,12 +45,13 @@ final asyncNotifierProviderFactory = TestMatrix( () => create() as AsyncNotifier, ); }, - value: (create, {name, dependencies}) => ([arg]) { + value: (create, {name, dependencies, retry}) => ([arg]) { return AsyncNotifierProvider.autoDispose, Object?>( () => create(null, arg) as AsyncNotifier, name: name, dependencies: dependencies, + retry: retry, ); }, ), @@ -72,12 +74,13 @@ final asyncNotifierProviderFactory = TestMatrix( () => create() as FamilyAsyncNotifier, ).call(42); }, - value: (create, {name, dependencies}) => ([arg]) { + value: (create, {name, dependencies, retry}) => ([arg]) { return AsyncNotifierProvider.family< FamilyAsyncNotifier, Object?, Object?>( () => create(null, arg) as FamilyAsyncNotifier, name: name, dependencies: dependencies, + retry: retry, )(arg); }, ), @@ -102,12 +105,13 @@ final asyncNotifierProviderFactory = TestMatrix( ) .call(42); }, - value: (create, {name, dependencies}) => ([arg]) { + value: (create, {name, dependencies, retry}) => ([arg]) { return AsyncNotifierProvider.autoDispose .family, Object?, Object?>( () => create(null, arg) as FamilyAsyncNotifier, name: name, dependencies: dependencies, + retry: retry, )(arg); }, ), diff --git a/packages/riverpod/test/src/matrix/notifier_provider.dart b/packages/riverpod/test/src/matrix/notifier_provider.dart index 8760b35c5..58971acd5 100644 --- a/packages/riverpod/test/src/matrix/notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/notifier_provider.dart @@ -17,11 +17,12 @@ final notifierProviderFactory = TestMatrix( provider: (create) => NotifierProvider, StateT>( () => create() as Notifier, ), - value: (create, {name, dependencies}) => ([arg]) { + value: (create, {name, dependencies, retry}) => ([arg]) { return NotifierProvider, Object?>( () => create(null, arg) as Notifier, name: name, dependencies: dependencies, + retry: retry, ); }, ), @@ -42,11 +43,12 @@ final notifierProviderFactory = TestMatrix( () => create() as Notifier, ); }, - value: (create, {name, dependencies}) => ([arg]) { + value: (create, {name, dependencies, retry}) => ([arg]) { return NotifierProvider.autoDispose, Object?>( () => create(null, arg) as Notifier, name: name, dependencies: dependencies, + retry: retry, ); }, ), @@ -69,12 +71,13 @@ final notifierProviderFactory = TestMatrix( () => create() as FamilyNotifier, ).call(42); }, - value: (create, {name, dependencies}) => ([arg]) { + value: (create, {name, dependencies, retry}) => ([arg]) { return NotifierProvider.family, Object?, Object?>( () => create(null, arg) as FamilyNotifier, name: name, dependencies: dependencies, + retry: retry, )(arg); }, ), @@ -99,12 +102,13 @@ final notifierProviderFactory = TestMatrix( ) .call(42); }, - value: (create, {name, dependencies}) => ([arg]) { + value: (create, {name, dependencies, retry}) => ([arg]) { return NotifierProvider.autoDispose .family, Object?, Object?>( () => create(null, arg) as FamilyNotifier, name: name, dependencies: dependencies, + retry: retry, )(arg); }, ), diff --git a/packages/riverpod/test/src/matrix/stream_notifier_provider.dart b/packages/riverpod/test/src/matrix/stream_notifier_provider.dart index 064a4198b..c141cd236 100644 --- a/packages/riverpod/test/src/matrix/stream_notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/stream_notifier_provider.dart @@ -6,8 +6,9 @@ final streamNotifierProviderFactory = TestMatrix( isAutoDispose: false, isFamily: false, deferredNotifier: DeferredStreamNotifier.new, - deferredProvider: (create, {updateShouldNotify}) { + deferredProvider: (create, {updateShouldNotify, retry}) { return StreamNotifierProvider, StateT>( + retry: retry, () => DeferredStreamNotifier( create, updateShouldNotify: updateShouldNotify, @@ -18,11 +19,12 @@ final streamNotifierProviderFactory = TestMatrix( StreamNotifierProvider, StateT>( () => create() as StreamNotifier, ), - value: (create, {name, dependencies}) => ([arg]) { + value: (create, {name, dependencies, retry}) => ([arg]) { return StreamNotifierProvider, Object?>( () => create(null, arg) as StreamNotifier, name: name, dependencies: dependencies, + retry: retry, ); }, ), @@ -30,9 +32,10 @@ final streamNotifierProviderFactory = TestMatrix( isAutoDispose: true, isFamily: false, deferredNotifier: DeferredStreamNotifier.new, - deferredProvider: (create, {updateShouldNotify}) { + deferredProvider: (create, {updateShouldNotify, retry}) { return StreamNotifierProvider.autoDispose< DeferredStreamNotifier, StateT>( + retry: retry, () => DeferredStreamNotifier( create, updateShouldNotify: updateShouldNotify, @@ -45,9 +48,10 @@ final streamNotifierProviderFactory = TestMatrix( () => create() as StreamNotifier, ); }, - value: (create, {name, dependencies}) => ([arg]) { + value: (create, {name, dependencies, retry}) => ([arg]) { return StreamNotifierProvider.autoDispose, Object?>( + retry: retry, () => create(null, arg) as StreamNotifier, name: name, dependencies: dependencies, @@ -58,9 +62,10 @@ final streamNotifierProviderFactory = TestMatrix( isAutoDispose: false, isFamily: true, deferredNotifier: DeferredFamilyStreamNotifier.new, - deferredProvider: (create, {updateShouldNotify}) { + deferredProvider: (create, {updateShouldNotify, retry}) { return StreamNotifierProvider.family< DeferredFamilyStreamNotifier, StateT, Object?>( + retry: retry, () => DeferredFamilyStreamNotifier( create, updateShouldNotify: updateShouldNotify, @@ -73,9 +78,10 @@ final streamNotifierProviderFactory = TestMatrix( () => create() as FamilyStreamNotifier, ).call(42); }, - value: (create, {name, dependencies}) => ([arg]) { + value: (create, {name, dependencies, retry}) => ([arg]) { return StreamNotifierProvider.family< FamilyStreamNotifier, Object?, Object?>( + retry: retry, () => create(null, arg) as FamilyStreamNotifier, name: name, dependencies: dependencies, @@ -86,9 +92,10 @@ final streamNotifierProviderFactory = TestMatrix( isAutoDispose: true, isFamily: true, deferredNotifier: DeferredFamilyStreamNotifier.new, - deferredProvider: (create, {updateShouldNotify}) { + deferredProvider: (create, {updateShouldNotify, retry}) { return StreamNotifierProvider.family .autoDispose, StateT, Object?>( + retry: retry, () => DeferredFamilyStreamNotifier( create, updateShouldNotify: updateShouldNotify, @@ -103,9 +110,10 @@ final streamNotifierProviderFactory = TestMatrix( ) .call(42); }, - value: (create, {name, dependencies}) => ([arg]) { + value: (create, {name, dependencies, retry}) => ([arg]) { return StreamNotifierProvider.autoDispose .family, Object?, Object?>( + retry: retry, () => create(null, arg) as FamilyStreamNotifier, name: name, dependencies: dependencies, @@ -195,6 +203,7 @@ class StreamNotifierTestFactory extends TestFactory< Function( Stream Function(Ref> ref) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + Retry? retry, }) deferredProvider; final $StreamNotifierProvider<$StreamNotifier, StateT> diff --git a/packages/riverpod/test/src/providers/future_provider_test.dart b/packages/riverpod/test/src/providers/future_provider_test.dart new file mode 100644 index 000000000..4e434f21b --- /dev/null +++ b/packages/riverpod/test/src/providers/future_provider_test.dart @@ -0,0 +1,74 @@ +import 'package:mockito/mockito.dart'; +import 'package:riverpod/riverpod.dart'; +import 'package:test/test.dart'; + +import '../../third_party/fake_async.dart'; +import '../utils.dart'; + +void main() { + group('FutureProvider', () { + group('retry', () { + test( + 'handles retry', + () => fakeAsync((fake) async { + final container = ProviderContainer.test(); + var err = Exception('foo'); + final stack = StackTrace.current; + final provider = FutureProvider( + (ref) => Error.throwWithStackTrace(err, stack), + retry: (_, __) => const Duration(seconds: 1), + ); + final listener = Listener>(); + + container.listen(provider, fireImmediately: true, listener.call); + await container.read(provider.future).catchError((e) => 0); + + verifyOnly( + listener, + listener(any, AsyncValue.error(err, stack)), + ); + + err = Exception('bar'); + + fake.elapse(const Duration(seconds: 1)); + fake.flushMicrotasks(); + + await container.read(provider.future).catchError((e) => 0); + + verifyOnly( + listener, + listener(any, AsyncValue.error(err, stack)), + ); + }), + ); + + test( + 'manually setting the state to an error does not cause a retry', + () => fakeAsync((fake) async { + final container = ProviderContainer.test(); + var retryCount = 0; + late Ref> r; + final provider = FutureProvider( + (ref) { + r = ref; + return 0; + }, + retry: (_, __) { + retryCount++; + return const Duration(seconds: 1); + }, + ); + final listener = Listener>(); + + container.listen(provider, fireImmediately: true, listener.call); + + expect(retryCount, 0); + + r.state = AsyncValue.error(Error(), StackTrace.current); + + expect(retryCount, 0); + }), + ); + }); + }); +} diff --git a/packages/riverpod/test/src/providers/stream_notifier_test.dart b/packages/riverpod/test/src/providers/stream_notifier_test.dart index 89e4e40a5..ae061bb9a 100644 --- a/packages/riverpod/test/src/providers/stream_notifier_test.dart +++ b/packages/riverpod/test/src/providers/stream_notifier_test.dart @@ -11,6 +11,7 @@ import 'package:riverpod/src/providers/stream_notifier.dart' show $StreamNotifier; import 'package:test/test.dart'; +import '../../third_party/fake_async.dart'; import '../matrix.dart'; import '../utils.dart'; @@ -29,6 +30,70 @@ void main() { }); streamNotifierProviderFactory.createGroup((factory) { + group('retry', () { + test( + 'handles retry', + () => fakeAsync((fake) async { + final container = ProviderContainer.test(); + var err = Exception('foo'); + final stack = StackTrace.current; + final provider = factory.deferredProvider( + (ref) => Error.throwWithStackTrace(err, stack), + retry: (_, __) => const Duration(seconds: 1), + ); + final listener = Listener>(); + + container.listen(provider, fireImmediately: true, listener.call); + await container.read(provider.future).catchError((e) => 0); + + verifyOnly( + listener, + listener(any, AsyncValue.error(err, stack)), + ); + + err = Exception('bar'); + + fake.elapse(const Duration(seconds: 1)); + fake.flushMicrotasks(); + + await container.read(provider.future).catchError((e) => 0); + + verifyOnly( + listener, + listener(any, AsyncValue.error(err, stack)), + ); + }), + ); + + // test( + // 'manually setting the state to an error does not cause a retry', + // () => fakeAsync((fake) async { + // final container = ProviderContainer.test(); + // var retryCount = 0; + // late Ref> r; + // final provider = FutureProvider( + // (ref) { + // r = ref; + // return 0; + // }, + // retry: (_, __) { + // retryCount++; + // return const Duration(seconds: 1); + // }, + // ); + // final listener = Listener>(); + + // container.listen(provider, fireImmediately: true, listener.call); + + // expect(retryCount, 0); + + // r.state = AsyncValue.error(Error(), StackTrace.current); + + // expect(retryCount, 0); + // }), + // ); + }); + test('Cannot share a Notifier instance between providers ', () { final container = ProviderContainer.test(); final notifier = factory.deferredNotifier((ref) => Stream.value(0)); diff --git a/packages/riverpod/test/src/utils.dart b/packages/riverpod/test/src/utils.dart index fe631441e..7f3e1d006 100644 --- a/packages/riverpod/test/src/utils.dart +++ b/packages/riverpod/test/src/utils.dart @@ -2,8 +2,8 @@ import 'dart:async'; import 'package:mockito/mockito.dart'; import 'package:riverpod/legacy.dart'; -import 'package:riverpod/riverpod.dart'; -import 'package:test/test.dart'; +import 'package:riverpod/src/internals.dart'; +import 'package:test/test.dart' hide Retry; List captureErrors(List cb) { final errors = []; @@ -34,6 +34,21 @@ class OverrideWithBuildMock extends Mock { } } +class RetryMock extends Mock { + RetryMock([Retry? retry]) { + if (retry != null) { + when(call(any, any)).thenAnswer( + (i) => retry( + i.positionalArguments[0] as int, + i.positionalArguments[1] as Object, + ), + ); + } + } + + Duration? call(int? retryCount, Object? error); +} + class OnBuildMock extends Mock { void call(); } @@ -86,6 +101,16 @@ class Listener extends Mock { final isAssertionError = isA(); +Matcher isStateErrorWith({String? message}) { + var matcher = isA(); + + if (message != null) { + matcher = matcher.having((e) => e.message, 'message', message); + } + + return matcher; +} + class ErrorListener extends Mock { void call(Object? error, StackTrace? stackTrace); } diff --git a/packages/riverpod_analyzer_utils/lib/src/errors.dart b/packages/riverpod_analyzer_utils/lib/src/errors.dart index 47a82ee35..a8a0d99da 100644 --- a/packages/riverpod_analyzer_utils/lib/src/errors.dart +++ b/packages/riverpod_analyzer_utils/lib/src/errors.dart @@ -18,6 +18,7 @@ enum RiverpodAnalysisErrorCode { notifierDefaultConstructorHasRequiredParameters, providerDependencyListParseError, providerOrFamilyExpressionParseError, + invalidRetryArgument, } class RiverpodAnalysisError { diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart index 5b646367a..89e93be8a 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart @@ -32,12 +32,24 @@ extension RiverpodAnnotatedAnnotatedNodeX on Annotation { (e) => e.expression.providerDependencyList, ); + final AstNode? retryNode = arguments?.named('retry')?.expression; + if (retryNode is! SimpleIdentifier?) { + errorReporter( + RiverpodAnalysisError( + 'The "retry" argument must be a variable.', + targetNode: retryNode, + code: RiverpodAnalysisErrorCode.invalidRetryArgument, + ), + ); + } + return RiverpodAnnotation._( node: this, element: riverpodAnnotationElement, keepAliveNode: arguments?.named('keepAlive'), dependenciesNode: dependenciesNode, dependencyList: dependencyList, + retryNode: retryNode as SimpleIdentifier?, ); }); } @@ -50,6 +62,7 @@ final class RiverpodAnnotation { required this.keepAliveNode, required this.dependenciesNode, required this.dependencyList, + required this.retryNode, }); final Annotation node; @@ -57,6 +70,7 @@ final class RiverpodAnnotation { final NamedExpression? keepAliveNode; final NamedExpression? dependenciesNode; final ProviderDependencyList? dependencyList; + final SimpleIdentifier? retryNode; } final class RiverpodAnnotationElement { diff --git a/packages/riverpod_annotation/CHANGELOG.md b/packages/riverpod_annotation/CHANGELOG.md index 66e41421b..739e84940 100644 --- a/packages/riverpod_annotation/CHANGELOG.md +++ b/packages/riverpod_annotation/CHANGELOG.md @@ -7,6 +7,7 @@ - Added `@Dependencies([...])`, for lint purposes. This is similar to `@Riverpod(dependencies: [...])`, but is applied on non-provider objects that may use a scoped provider. +- Added support for `@Riverpod(retry: ...)` ## 3.0.0-dev.3 - 2023-11-27 diff --git a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart index 7e6261e27..4092357a0 100644 --- a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart @@ -22,8 +22,18 @@ final class Riverpod { const Riverpod({ this.keepAlive = false, this.dependencies, + this.retry, }); + /// The default retry logic used by providers associated to this container. + /// + /// The default implementation: + /// - has unlimited retries + /// - starts with a delay of 200ms + /// - doubles the delay on each retry up to 6.4 seconds + /// - retries all failures + final Duration? Function(int retryCount, Object error)? retry; + /// Whether the state of the provider should be maintained if it is no-longer used. /// /// Defaults to false. diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 78d597bed..505f4a60c 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -15,6 +15,8 @@ ) ``` +- Added support for `@Riverpod(retry: ...)` + ## 2.4.2 - 2024-05-14 - Correctly set minimum support analyzer version to 6.5.0 diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index b26c13581..bab9edc40 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -39,6 +39,7 @@ class FamilyTemplate extends Template { ${provider.doc} final class ${provider.familyTypeName} extends Family { const ${provider.familyTypeName}._() : super( + retry: ${provider.annotation.retryNode?.name ?? 'null'}, name: r'${provider.providerName(options)}', dependencies: ${provider.dependencies(options)}, allTransitiveDependencies: ${provider.allTransitiveDependencies(allTransitiveDependencies)}, diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index a0dec049f..150f772ce 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -109,6 +109,7 @@ ${provider.doc} final class $name$_genericsDefinition }): _createCb = create, super( $superParameters + retry: ${provider.annotation.retryNode?.name ?? 'null'}, name: r'${provider.providerName(options)}', isAutoDispose: ${!provider.annotation.element.keepAlive}, dependencies: ${!provider.providerElement.isFamily ? provider.dependencies(options) : 'null'}, diff --git a/packages/riverpod_generator/test/retry_test.dart b/packages/riverpod_generator/test/retry_test.dart new file mode 100644 index 000000000..c8e31e166 --- /dev/null +++ b/packages/riverpod_generator/test/retry_test.dart @@ -0,0 +1,12 @@ +import 'package:test/test.dart'; + +import 'integration/hash/retry.dart'; + +void main() { + test('Passes retry', () { + expect(aProvider.retry, myRetry); + + expect(bProvider.retry, myRetry2); + expect(bProvider(42).retry, myRetry2); + }); +} diff --git a/tools/generate_providers/bin/generate_providers.dart b/tools/generate_providers/bin/generate_providers.dart index 9e5fbcd2d..d4b524d06 100644 --- a/tools/generate_providers/bin/generate_providers.dart +++ b/tools/generate_providers/bin/generate_providers.dart @@ -263,12 +263,14 @@ class $builderName { ${provider.createdT} Function(${provider.refT} ref, ArgT param) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return ${provider.providerName}Family<${provider.genericsUsage}, ArgT>( create, name: name, ${_isAutoDisposeParam(disposeType)} dependencies: dependencies, + retry: retry, ); } @@ -297,12 +299,14 @@ class $builderName { ${provider.createdT} Function(${provider.refT} ref) create, { String? name, Iterable? dependencies, + Retry? retry, }) { return ${provider.providerName}<${provider.genericsUsage}>( create, name: name, ${_isAutoDisposeParam(disposeType)} dependencies: dependencies, + retry: retry, ); } @@ -401,12 +405,14 @@ class $builderName { NotifierT Function() create, { String? name, Iterable? dependencies, + Retry? retry, }) { return $providerName${provider.genericsUsage}$ctor( create, name: name, ${_isAutoDisposeParam(disposeType)} dependencies: dependencies, + retry: retry, ); } From 4bd891b8671225bfbfaf4677dc30196cb3c042c7 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Tue, 18 Jun 2024 04:45:28 +0200 Subject: [PATCH 324/387] Update generated files --- examples/counter/lib/main.g.dart | 1 + examples/pub/lib/detail.g.dart | 6 + examples/pub/lib/search.g.dart | 2 + examples/stackoverflow/lib/common.g.dart | 1 + examples/stackoverflow/lib/question.g.dart | 1 + examples/stackoverflow/lib/tag.g.dart | 1 + .../integration/build_yaml/lib/main.g.dart | 18 ++ .../test/integration/annotated.g.dart | 10 + .../test/integration/async.g.dart | 16 ++ .../test/integration/auto_dispose.g.dart | 9 + .../test/integration/dependencies.g.dart | 21 ++ .../test/integration/dependencies2.g.dart | 8 + .../test/integration/documented.g.dart | 6 + .../test/integration/generated.g.dart | 20 ++ .../test/integration/hash/hash1.g.dart | 3 + .../test/integration/hash/retry.dart | 12 ++ .../test/integration/hash/retry.g.dart | 202 ++++++++++++++++++ .../test/integration/scopes.g.dart | 3 + .../test/integration/split.g.dart | 2 + .../test/integration/stream.g.dart | 12 ++ .../test/integration/sync.g.dart | 42 ++++ .../generated/golden/lib/sync.g.dart | 10 + ..._class_based_provider_to_functional.g.dart | 5 + ..._functional_provider_to_class_based.g.dart | 3 + .../avoid_build_context_in_providers.g.dart | 5 + .../avoid_public_notifier_properties.g.dart | 2 + .../functional_ref/functional_ref.g.dart | 9 + .../test/lints/notifier_extends.g.dart | 12 ++ ...ly_use_keep_alive_inside_keep_alive.g.dart | 5 + .../protected_notifier_properties.g.dart | 16 ++ .../provider_dependencies/another.g.dart | 3 + .../missing_dependencies.g.dart | 11 + .../missing_dependencies2.g.dart | 24 +++ .../unused_dependency.g.dart | 9 + .../test/lints/provider_parameters.g.dart | 2 + ...oviders_should_specify_dependencies.g.dart | 3 + .../test/lints/unknown_scoped_usage.g.dart | 2 + .../lints/unsupported_provider_value.g.dart | 21 ++ .../advanced/select/select/codegen.g.dart | 1 + .../select/select_async/codegen.g.dart | 2 + .../cancel/detail_screen/codegen.g.dart | 1 + .../detail_screen_cancel/codegen.g.dart | 1 + .../detail_screen_debounce/codegen.g.dart | 1 + .../provider_with_extension/codegen.g.dart | 1 + .../fetch_activity/codegen.g.dart | 1 + .../pull_to_refresh/full_app/codegen.g.dart | 1 + .../docs/concepts/about_codegen/main.g.dart | 2 + .../provider_type/async_class_future.g.dart | 1 + .../provider_type/async_class_stream.g.dart | 1 + .../provider_type/async_fn_future.g.dart | 1 + .../provider_type/async_fn_stream.g.dart | 1 + .../provider_type/auto_dispose.g.dart | 2 + .../about_codegen/provider_type/family.g.dart | 2 + .../provider_type/family_class.g.dart | 2 + .../provider_type/family_fn.g.dart | 2 + .../provider_type/sync_class.g.dart | 1 + .../provider_type/sync_fn.g.dart | 1 + .../characters_provider/codegen.g.dart | 3 + .../city_provider/codegen.g.dart | 1 + .../codegen.g.dart | 2 + .../read_in_provider/codegen.g.dart | 2 + .../select_async_provider/codegen.g.dart | 2 + .../todo_list_provider/codegen.g.dart | 1 + .../weather_provider/codegen.g.dart | 2 + .../whole_object_provider/codegen.g.dart | 2 + .../lifecycle_on_dispose/codegen.g.dart | 1 + .../creating_a_provider/codegen.g.dart | 1 + .../declaring_many_providers/codegen.g.dart | 2 + .../concepts/reading/counter/codegen.g.dart | 2 + .../concepts/reading/listen/codegen.g.dart | 1 + .../reading/listen_build/codegen.g.dart | 1 + .../reading/listen_build/codegen_hooks.g.dart | 1 + .../concepts/reading/provider/codegen.g.dart | 2 + .../docs/concepts/reading/read/codegen.g.dart | 1 + .../reading/read/codegen_hooks.g.dart | 1 + .../reading/read_build/codegen.g.dart | 1 + .../read_notifier_build/codegen.g.dart | 1 + .../concepts/reading/watch/codegen.g.dart | 3 + .../reading/watch_build/codegen.g.dart | 2 + .../reading/watch_build/codegen_hooks.g.dart | 2 + .../watch_notifier_build/codegen.g.dart | 1 + .../concepts/why_immutability/codegen.g.dart | 1 + .../cache_for_usage/codegen.g.dart | 1 + .../auto_dispose/codegen_keep_alive.g.dart | 1 + .../invalidate_family_example/codegen.g.dart | 2 + .../auto_dispose/keep_alive/codegen.g.dart | 1 + .../on_dispose_example/codegen.g.dart | 2 + .../functional_ref/codegen.g.dart | 2 + .../listen_example/codegen.g.dart | 2 + .../notifier_ref/codegen.g.dart | 2 + .../read_example/codegen.g.dart | 2 + .../watch_example/codegen.g.dart | 2 + .../watch_placement/codegen.g.dart | 3 + .../require_value/codegen.g.dart | 1 + .../first_request/codegen/provider.g.dart | 1 + .../passing_args/family/codegen.g.dart | 4 + .../no_arg_provider/codegen.g.dart | 2 + .../codegen/todo_list_notifier.g.dart | 1 + .../todo_list_notifier_add_todo.g.dart | 1 + .../codegen/todo_list_provider.g.dart | 1 + .../testing/notifier_mock/codegen.g.dart | 1 + .../testing/provider_to_mock/codegen.g.dart | 1 + .../pipe_change_notifier.g.dart | 1 + .../websockets_sync/raw_usage.g.dart | 1 + .../shared_pipe_change_notifier.g.dart | 2 + .../stream_provider/codegen.g.dart | 1 + .../sync_definition/codegen.g.dart | 1 + .../docs/from_provider/family/family.g.dart | 2 + .../async_values/async_values.g.dart | 2 + .../auto_dispose/auto_dispose.g.dart | 2 + .../motivation/combine/combine.g.dart | 2 + .../motivation/same_type/same_type.g.dart | 2 + .../dart_hello_world/main.g.dart | 1 + .../hello_world/hooks_codegen/main.g.dart | 1 + .../getting_started/hello_world/main.g.dart | 1 + .../introduction/why_riverpod/codegen.g.dart | 2 + .../declaration/declaration.g.dart | 1 + .../initialization/initialization.g.dart | 1 + .../migrated/migrated.g.dart | 1 + .../add_listener/add_listener.g.dart | 1 + .../async_notifier/async_notifier.g.dart | 1 + .../build_init/build_init.g.dart | 1 + .../family_and_dispose.g.dart | 3 + .../from_state_provider.g.dart | 1 + .../old_lifecycles/old_lifecycles.g.dart | 1 + .../old_lifecycles_final.g.dart | 3 + .../config_provider/codegen.g.dart | 1 + .../remote_todos/codegen.g.dart | 1 + .../notifier_provider/todos/codegen.g.dart | 1 + .../completed_todos/completed_todos.g.dart | 1 + .../optimized_previous_button.g.dart | 2 + .../docs/providers/provider/todo/todo.g.dart | 1 + .../unoptimized_previous_button.g.dart | 1 + .../live_stream_chat_provider/codegen.g.dart | 1 + website/static/snippets/async.g.dart | 1 + website/static/snippets/combine.g.dart | 3 + website/static/snippets/create.g.dart | 1 + website/static/snippets/declare.g.dart | 1 + 138 files changed, 685 insertions(+) create mode 100644 packages/riverpod_generator/test/integration/hash/retry.dart create mode 100644 packages/riverpod_generator/test/integration/hash/retry.g.dart diff --git a/examples/counter/lib/main.g.dart b/examples/counter/lib/main.g.dart index 9c6018064..2a62bb8a4 100644 --- a/examples/counter/lib/main.g.dart +++ b/examples/counter/lib/main.g.dart @@ -28,6 +28,7 @@ final class CounterProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'counterProvider', isAutoDispose: true, dependencies: null, diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index a01951ab3..40b98a5de 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -27,6 +27,7 @@ final class FetchPackageDetailsProvider })? create}) : _createCb = create, super( + retry: null, name: r'fetchPackageDetailsProvider', isAutoDispose: true, dependencies: null, @@ -96,6 +97,7 @@ String _$fetchPackageDetailsHash() => final class FetchPackageDetailsFamily extends Family { const FetchPackageDetailsFamily._() : super( + retry: null, name: r'fetchPackageDetailsProvider', dependencies: null, allTransitiveDependencies: null, @@ -153,6 +155,7 @@ final class LikedPackagesProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'likedPackagesProvider', isAutoDispose: true, dependencies: null, @@ -206,6 +209,7 @@ final class PubRepositoryProvider super( from: null, argument: null, + retry: null, name: r'pubRepositoryProvider', isAutoDispose: true, dependencies: null, @@ -277,6 +281,7 @@ final class PackageMetricsProvider PackageMetrics Function()? create}) : _createCb = create, super( + retry: null, name: r'packageMetricsProvider', isAutoDispose: true, dependencies: null, @@ -351,6 +356,7 @@ String _$packageMetricsHash() => r'67cd25e50357e6e970d432c1d255085a23b856ac'; final class PackageMetricsFamily extends Family { const PackageMetricsFamily._() : super( + retry: null, name: r'packageMetricsProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 9dbe12eac..1f5b79dc3 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -32,6 +32,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< })? create}) : _createCb = create, super( + retry: null, name: r'fetchPackagesProvider', isAutoDispose: true, dependencies: null, @@ -110,6 +111,7 @@ String _$fetchPackagesHash() => r'46519fce4d1661e1358deac4d806374fa68f12c8'; final class FetchPackagesFamily extends Family { const FetchPackagesFamily._() : super( + retry: null, name: r'fetchPackagesProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/examples/stackoverflow/lib/common.g.dart b/examples/stackoverflow/lib/common.g.dart index 1d5703c51..b982683fa 100644 --- a/examples/stackoverflow/lib/common.g.dart +++ b/examples/stackoverflow/lib/common.g.dart @@ -39,6 +39,7 @@ final class ThemeProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'themeProvider', isAutoDispose: true, dependencies: const [], diff --git a/examples/stackoverflow/lib/question.g.dart b/examples/stackoverflow/lib/question.g.dart index a247e8c57..159693d48 100644 --- a/examples/stackoverflow/lib/question.g.dart +++ b/examples/stackoverflow/lib/question.g.dart @@ -127,6 +127,7 @@ final class CurrentQuestionProvider super( from: null, argument: null, + retry: null, name: r'currentQuestionProvider', isAutoDispose: true, dependencies: const [], diff --git a/examples/stackoverflow/lib/tag.g.dart b/examples/stackoverflow/lib/tag.g.dart index 1a25986f9..ffb3b78f6 100644 --- a/examples/stackoverflow/lib/tag.g.dart +++ b/examples/stackoverflow/lib/tag.g.dart @@ -23,6 +23,7 @@ final class TagThemeProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'tagThemeProvider', isAutoDispose: true, dependencies: const [themeProvider], diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index d3ca39a5b..fad75ddb1 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -21,6 +21,7 @@ final class CountProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'myCountPod', isAutoDispose: true, dependencies: null, @@ -81,6 +82,7 @@ final class CountFutureProvider super( from: null, argument: null, + retry: null, name: r'myCountFuturePod', isAutoDispose: true, dependencies: null, @@ -133,6 +135,7 @@ final class CountStreamProvider super( from: null, argument: null, + retry: null, name: r'myCountStreamPod', isAutoDispose: true, dependencies: null, @@ -180,6 +183,7 @@ final class CountNotifierProvider super( from: null, argument: null, + retry: null, name: r'myCountNotifierPod', isAutoDispose: true, dependencies: null, @@ -249,6 +253,7 @@ final class CountAsyncNotifierProvider super( from: null, argument: null, + retry: null, name: r'myCountAsyncNotifierPod', isAutoDispose: true, dependencies: null, @@ -311,6 +316,7 @@ final class CountStreamNotifierProvider super( from: null, argument: null, + retry: null, name: r'myCountStreamNotifierPod', isAutoDispose: true, dependencies: null, @@ -378,6 +384,7 @@ final class Count2Provider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'myFamilyCount2ProviderFamily', isAutoDispose: true, dependencies: null, @@ -454,6 +461,7 @@ String _$count2Hash() => r'6256825480d83bb13acde282cf3c9d9524cc3a6c'; final class Count2Family extends Family { const Count2Family._() : super( + retry: null, name: r'myFamilyCount2ProviderFamily', dependencies: null, allTransitiveDependencies: null, @@ -510,6 +518,7 @@ final class CountFuture2Provider )? create}) : _createCb = create, super( + retry: null, name: r'myFamilyCountFuture2ProviderFamily', isAutoDispose: true, dependencies: null, @@ -578,6 +587,7 @@ String _$countFuture2Hash() => r'096675b70a267f5d7c62ac7d3e7dd231ef529034'; final class CountFuture2Family extends Family { const CountFuture2Family._() : super( + retry: null, name: r'myFamilyCountFuture2ProviderFamily', dependencies: null, allTransitiveDependencies: null, @@ -634,6 +644,7 @@ final class CountStream2Provider )? create}) : _createCb = create, super( + retry: null, name: r'myFamilyCountStream2ProviderFamily', isAutoDispose: true, dependencies: null, @@ -702,6 +713,7 @@ String _$countStream2Hash() => r'051264dd685ebc0a57e454bb676957c93cb4ae20'; final class CountStream2Family extends Family { const CountStream2Family._() : super( + retry: null, name: r'myFamilyCountStream2ProviderFamily', dependencies: null, allTransitiveDependencies: null, @@ -753,6 +765,7 @@ final class CountNotifier2Provider CountNotifier2 Function()? create}) : _createCb = create, super( + retry: null, name: r'myFamilyCountNotifier2ProviderFamily', isAutoDispose: true, dependencies: null, @@ -830,6 +843,7 @@ String _$countNotifier2Hash() => r'ef12bb4f94add336804ae43bcdbcd8e9b0bec420'; final class CountNotifier2Family extends Family { const CountNotifier2Family._() : super( + retry: null, name: r'myFamilyCountNotifier2ProviderFamily', dependencies: null, allTransitiveDependencies: null, @@ -912,6 +926,7 @@ final class CountAsyncNotifier2Provider CountAsyncNotifier2 Function()? create}) : _createCb = create, super( + retry: null, name: r'myFamilyCountAsyncNotifier2ProviderFamily', isAutoDispose: true, dependencies: null, @@ -982,6 +997,7 @@ String _$countAsyncNotifier2Hash() => final class CountAsyncNotifier2Family extends Family { const CountAsyncNotifier2Family._() : super( + retry: null, name: r'myFamilyCountAsyncNotifier2ProviderFamily', dependencies: null, allTransitiveDependencies: null, @@ -1067,6 +1083,7 @@ final class CountStreamNotifier2Provider CountStreamNotifier2 Function()? create}) : _createCb = create, super( + retry: null, name: r'myFamilyCountStreamNotifier2ProviderFamily', isAutoDispose: true, dependencies: null, @@ -1137,6 +1154,7 @@ String _$countStreamNotifier2Hash() => final class CountStreamNotifier2Family extends Family { const CountStreamNotifier2Family._() : super( + retry: null, name: r'myFamilyCountStreamNotifier2ProviderFamily', dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 0803875a4..ebfa3f779 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -25,6 +25,7 @@ final class FunctionalProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'functionalProvider', isAutoDispose: true, dependencies: null, @@ -101,6 +102,7 @@ String _$functionalHash() => r'288107f94c896141a9b3999f606e4ccdf078f15e'; final class FunctionalFamily extends Family { const FunctionalFamily._() : super( + retry: null, name: r'functionalProvider', dependencies: null, allTransitiveDependencies: null, @@ -154,6 +156,7 @@ final class ClassBasedProvider extends $NotifierProvider { ClassBased Function()? create}) : _createCb = create, super( + retry: null, name: r'classBasedProvider', isAutoDispose: true, dependencies: null, @@ -231,6 +234,7 @@ String _$classBasedHash() => r'92b444806ef8a304c6e0dc3d8e2383601e781183'; final class ClassBasedFamily extends Family { const ClassBasedFamily._() : super( + retry: null, name: r'classBasedProvider', dependencies: null, allTransitiveDependencies: null, @@ -321,6 +325,7 @@ final class FamilyProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'familyProvider', isAutoDispose: true, dependencies: null, @@ -397,6 +402,7 @@ String _$familyHash() => r'd70685b83be840bfd9e79c11fb84c905d19d6e10'; final class FamilyFamily extends Family { const FamilyFamily._() : super( + retry: null, name: r'familyProvider', dependencies: null, allTransitiveDependencies: null, @@ -452,6 +458,7 @@ final class NotCopiedFunctionalProvider super( from: null, argument: null, + retry: null, name: r'notCopiedFunctionalProvider', isAutoDispose: true, dependencies: null, @@ -508,6 +515,7 @@ final class NotCopiedClassBasedProvider super( from: null, argument: null, + retry: null, name: r'notCopiedClassBasedProvider', isAutoDispose: true, dependencies: null, @@ -583,6 +591,7 @@ final class NotCopiedFamilyProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'notCopiedFamilyProvider', isAutoDispose: true, dependencies: null, @@ -659,6 +668,7 @@ String _$notCopiedFamilyHash() => r'6ef06ce6ebd73b476870bbe1af41c4f3fbe8ddb1'; final class NotCopiedFamilyFamily extends Family { const NotCopiedFamilyFamily._() : super( + retry: null, name: r'notCopiedFamilyProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index b3125e6e2..791f59c3c 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -22,6 +22,7 @@ final class GenericProvider : _createCb = create, super( argument: null, + retry: null, name: r'genericProvider', isAutoDispose: true, dependencies: null, @@ -89,6 +90,7 @@ String _$genericHash() => r'6ee5473ece745b00328c1e048f6967c160343620'; final class GenericFamily extends Family { const GenericFamily._() : super( + retry: null, name: r'genericProvider', dependencies: null, allTransitiveDependencies: null, @@ -130,6 +132,7 @@ final class GenericClassProvider : _createCb = create, super( argument: null, + retry: null, name: r'genericClassProvider', isAutoDispose: true, dependencies: null, @@ -214,6 +217,7 @@ String _$genericClassHash() => r'd3c4acc9cdae12f6c666fbf1f89aee212bb086db'; final class GenericClassFamily extends Family { const GenericClassFamily._() : super( + retry: null, name: r'genericClassProvider', dependencies: null, allTransitiveDependencies: null, @@ -283,6 +287,7 @@ final class PublicProvider super( from: null, argument: null, + retry: null, name: r'publicProvider', isAutoDispose: true, dependencies: null, @@ -335,6 +340,7 @@ final class _PrivateProvider super( from: null, argument: null, + retry: null, name: r'_privateProvider', isAutoDispose: true, dependencies: null, @@ -388,6 +394,7 @@ final class FamilyOrProvider )? create}) : _createCb = create, super( + retry: null, name: r'familyOrProvider', isAutoDispose: true, dependencies: null, @@ -456,6 +463,7 @@ String _$familyOrHash() => r'1c3217e296b0ce52c07c18769d1fffb95850f482'; final class FamilyOrFamily extends Family { const FamilyOrFamily._() : super( + retry: null, name: r'familyOrProvider', dependencies: null, allTransitiveDependencies: null, @@ -523,6 +531,7 @@ final class FamilyProvider })? create}) : _createCb = create, super( + retry: null, name: r'familyProvider', isAutoDispose: true, dependencies: null, @@ -615,6 +624,7 @@ String _$familyHash() => r'eb6fad35a94d4238b621c2100253ee2c700bee77'; final class FamilyFamily extends Family { const FamilyFamily._() : super( + retry: null, name: r'familyProvider', dependencies: null, allTransitiveDependencies: null, @@ -687,6 +697,7 @@ final class PublicClassProvider super( from: null, argument: null, + retry: null, name: r'publicClassProvider', isAutoDispose: true, dependencies: null, @@ -748,6 +759,7 @@ final class _PrivateClassProvider super( from: null, argument: null, + retry: null, name: r'_privateClassProvider', isAutoDispose: true, dependencies: null, @@ -810,6 +822,7 @@ final class FamilyOrClassProvider FamilyOrClass Function()? create}) : _createCb = create, super( + retry: null, name: r'familyOrClassProvider', isAutoDispose: true, dependencies: null, @@ -879,6 +892,7 @@ String _$familyOrClassHash() => r'b4882d4e79a03c63005d35eb7a021c9c4373a8d9'; final class FamilyOrClassFamily extends Family { const FamilyOrClassFamily._() : super( + retry: null, name: r'familyOrClassProvider', dependencies: null, allTransitiveDependencies: null, @@ -970,6 +984,7 @@ final class FamilyClassProvider FamilyClass Function()? create}) : _createCb = create, super( + retry: null, name: r'familyClassProvider', isAutoDispose: true, dependencies: null, @@ -1051,6 +1066,7 @@ String _$familyClassHash() => r'b7e3ca6091f12bbc99972e961acd885e05f42a15'; final class FamilyClassFamily extends Family { const FamilyClassFamily._() : super( + retry: null, name: r'familyClassProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index 57fe545af..d4f345241 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -21,6 +21,7 @@ final class KeepAliveProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'keepAliveProvider', isAutoDispose: false, dependencies: null, @@ -80,6 +81,7 @@ final class NotKeepAliveProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'notKeepAliveProvider', isAutoDispose: true, dependencies: null, @@ -139,6 +141,7 @@ final class DefaultKeepAliveProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'defaultKeepAliveProvider', isAutoDispose: true, dependencies: null, @@ -199,6 +202,7 @@ final class KeepAliveFamilyProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'keepAliveFamilyProvider', isAutoDispose: false, dependencies: null, @@ -275,6 +279,7 @@ String _$keepAliveFamilyHash() => r'80d684923a104e2488ec281097bf9b5b04b4fa5a'; final class KeepAliveFamilyFamily extends Family { const KeepAliveFamilyFamily._() : super( + retry: null, name: r'keepAliveFamilyProvider', dependencies: null, allTransitiveDependencies: null, @@ -330,6 +335,7 @@ final class NotKeepAliveFamilyProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'notKeepAliveFamilyProvider', isAutoDispose: true, dependencies: null, @@ -407,6 +413,7 @@ String _$notKeepAliveFamilyHash() => final class NotKeepAliveFamilyFamily extends Family { const NotKeepAliveFamilyFamily._() : super( + retry: null, name: r'notKeepAliveFamilyProvider', dependencies: null, allTransitiveDependencies: null, @@ -462,6 +469,7 @@ final class DefaultKeepAliveFamilyProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'defaultKeepAliveFamilyProvider', isAutoDispose: true, dependencies: null, @@ -540,6 +548,7 @@ String _$defaultKeepAliveFamilyHash() => final class DefaultKeepAliveFamilyFamily extends Family { const DefaultKeepAliveFamilyFamily._() : super( + retry: null, name: r'defaultKeepAliveFamilyProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index ac5166c0d..c399d0f35 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -21,6 +21,7 @@ final class DepProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'depProvider', isAutoDispose: true, dependencies: null, @@ -81,6 +82,7 @@ final class FamilyProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'familyProvider', isAutoDispose: true, dependencies: null, @@ -157,6 +159,7 @@ String _$familyHash() => r'8c228ff14b8c6cf1f3d4d6266232d64b5057c440'; final class FamilyFamily extends Family { const FamilyFamily._() : super( + retry: null, name: r'familyProvider', dependencies: null, allTransitiveDependencies: null, @@ -206,6 +209,7 @@ final class Dep2Provider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'dep2Provider', isAutoDispose: true, dependencies: null, @@ -275,6 +279,7 @@ final class Family2Provider extends $NotifierProvider { Family2 Function()? create}) : _createCb = create, super( + retry: null, name: r'family2Provider', isAutoDispose: true, dependencies: null, @@ -352,6 +357,7 @@ String _$family2Hash() => r'ce727b262aae067b0d4f703f03670abb70ad8977'; final class Family2Family extends Family { const Family2Family._() : super( + retry: null, name: r'family2Provider', dependencies: null, allTransitiveDependencies: null, @@ -437,6 +443,7 @@ final class ProviderProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'providerProvider', isAutoDispose: true, dependencies: const [ @@ -511,6 +518,7 @@ final class Provider2Provider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'provider2Provider', isAutoDispose: true, dependencies: const [ @@ -580,6 +588,7 @@ final class Provider3Provider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'provider3Provider', isAutoDispose: true, dependencies: const [ @@ -664,6 +673,7 @@ final class Provider4Provider extends $NotifierProvider { Provider4 Function()? create}) : _createCb = create, super( + retry: null, name: r'provider4Provider', isAutoDispose: true, dependencies: null, @@ -746,6 +756,7 @@ String _$provider4Hash() => r'1c955214d99695bb694c96374b277aac58e734df'; final class Provider4Family extends Family { const Provider4Family._() : super( + retry: null, name: r'provider4Provider', dependencies: const [ depProvider, @@ -841,6 +852,7 @@ final class TransitiveDependenciesProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'transitiveDependenciesProvider', isAutoDispose: true, dependencies: const [providerProvider], @@ -919,6 +931,7 @@ final class SmallTransitiveDependencyCountProvider super( from: null, argument: null, + retry: null, name: r'smallTransitiveDependencyCountProvider', isAutoDispose: true, dependencies: const [ @@ -993,6 +1006,7 @@ final class EmptyDependenciesFunctionalProvider super( from: null, argument: null, + retry: null, name: r'emptyDependenciesFunctionalProvider', isAutoDispose: true, dependencies: const [], @@ -1051,6 +1065,7 @@ final class EmptyDependenciesClassBasedProvider super( from: null, argument: null, + retry: null, name: r'emptyDependenciesClassBasedProvider', isAutoDispose: true, dependencies: const [], @@ -1128,6 +1143,7 @@ final class ProviderWithDependenciesProvider super( from: null, argument: null, + retry: null, name: r'providerWithDependenciesProvider', isAutoDispose: true, dependencies: const [ @@ -1197,6 +1213,7 @@ final class _PrivateDepProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'_privateDepProvider', isAutoDispose: true, dependencies: null, @@ -1256,6 +1273,7 @@ final class PublicDepProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'publicDepProvider', isAutoDispose: true, dependencies: null, @@ -1315,6 +1333,7 @@ final class DuplicateDependenciesProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'duplicateDependenciesProvider', isAutoDispose: true, dependencies: const [depProvider, dep2Provider], @@ -1381,6 +1400,7 @@ final class DuplicateDependencies2Provider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'duplicateDependencies2Provider', isAutoDispose: true, dependencies: const [ @@ -1452,6 +1472,7 @@ final class TransitiveDuplicateDependenciesProvider super( from: null, argument: null, + retry: null, name: r'transitiveDuplicateDependenciesProvider', isAutoDispose: true, dependencies: const [ diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 11bf3d57c..17bc8b5f6 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -22,6 +22,7 @@ final class ProviderWithDependencies2Provider super( from: null, argument: null, + retry: null, name: r'providerWithDependencies2Provider', isAutoDispose: true, dependencies: const [ @@ -102,6 +103,7 @@ final class FamilyWithDependencies2Provider })? create}) : _createCb = create, super( + retry: null, name: r'familyWithDependencies2Provider', isAutoDispose: true, dependencies: null, @@ -188,6 +190,7 @@ String _$familyWithDependencies2Hash() => final class FamilyWithDependencies2Family extends Family { const FamilyWithDependencies2Family._() : super( + retry: null, name: r'familyWithDependencies2Provider', dependencies: const [ providerWithDependenciesProvider, @@ -249,6 +252,7 @@ final class NotifierWithDependenciesProvider super( from: null, argument: null, + retry: null, name: r'notifierWithDependenciesProvider', isAutoDispose: true, dependencies: const [ @@ -340,6 +344,7 @@ final class NotifierFamilyWithDependenciesProvider NotifierFamilyWithDependencies Function()? create}) : _createCb = create, super( + retry: null, name: r'notifierFamilyWithDependenciesProvider', isAutoDispose: true, dependencies: null, @@ -428,6 +433,7 @@ String _$notifierFamilyWithDependenciesHash() => final class NotifierFamilyWithDependenciesFamily extends Family { const NotifierFamilyWithDependenciesFamily._() : super( + retry: null, name: r'notifierFamilyWithDependenciesProvider', dependencies: const [ providerWithDependenciesProvider, @@ -527,6 +533,7 @@ final class _Private2Provider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'_private2Provider', isAutoDispose: true, dependencies: null, @@ -586,6 +593,7 @@ final class Public2Provider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'public2Provider', isAutoDispose: true, dependencies: null, diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index 6a03f56d3..b8c36c01e 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -29,6 +29,7 @@ final class FunctionalProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'functionalProvider', isAutoDispose: true, dependencies: null, @@ -89,6 +90,7 @@ final class ClassBasedProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'classBasedProvider', isAutoDispose: true, dependencies: null, @@ -171,6 +173,7 @@ final class FamilyProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'familyProvider', isAutoDispose: true, dependencies: null, @@ -249,6 +252,7 @@ String _$familyHash() => r'339f0a8e0733a30bbb2220ce7ff6b9de7abe6022'; final class FamilyFamily extends Family { const FamilyFamily._() : super( + retry: null, name: r'familyProvider', dependencies: null, allTransitiveDependencies: null, @@ -308,6 +312,7 @@ final class ClassFamilyBasedProvider ClassFamilyBased Function()? create}) : _createCb = create, super( + retry: null, name: r'classFamilyBasedProvider', isAutoDispose: true, dependencies: null, @@ -387,6 +392,7 @@ String _$classFamilyBasedHash() => r'8d83e9a88356796298419574f360e8bf95aa0729'; final class ClassFamilyBasedFamily extends Family { const ClassFamilyBasedFamily._() : super( + retry: null, name: r'classFamilyBasedProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 487a05e10..26cafbcf9 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -21,6 +21,7 @@ final class GeneratedProvider extends $FunctionalProvider<_Test, _Test> super( from: null, argument: null, + retry: null, name: r'generatedProvider', isAutoDispose: true, dependencies: null, @@ -81,6 +82,7 @@ final class GeneratedFamilyProvider extends $FunctionalProvider<_Test, _Test> )? create}) : _createCb = create, super( + retry: null, name: r'generatedFamilyProvider', isAutoDispose: true, dependencies: null, @@ -157,6 +159,7 @@ String _$generatedFamilyHash() => r'ed284f58926c87acc81dab9168882d5d1c2cddf8'; final class GeneratedFamilyFamily extends Family { const GeneratedFamilyFamily._() : super( + retry: null, name: r'generatedFamilyProvider', dependencies: null, allTransitiveDependencies: null, @@ -207,6 +210,7 @@ final class GeneratedClassProvider super( from: null, argument: null, + retry: null, name: r'generatedClassProvider', isAutoDispose: true, dependencies: null, @@ -277,6 +281,7 @@ final class GeneratedClassFamilyProvider GeneratedClassFamily Function()? create}) : _createCb = create, super( + retry: null, name: r'generatedClassFamilyProvider', isAutoDispose: true, dependencies: null, @@ -355,6 +360,7 @@ String _$generatedClassFamilyHash() => final class GeneratedClassFamilyFamily extends Family { const GeneratedClassFamilyFamily._() : super( + retry: null, name: r'generatedClassFamilyProvider', dependencies: null, allTransitiveDependencies: null, @@ -442,6 +448,7 @@ final class $DynamicProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'$dynamicProvider', isAutoDispose: true, dependencies: null, @@ -502,6 +509,7 @@ final class $DynamicFamilyProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'$dynamicFamilyProvider', isAutoDispose: true, dependencies: null, @@ -578,6 +586,7 @@ String _$$dynamicFamilyHash() => r'b764133af8837b8321b08814892f198d4bc1aa18'; final class $DynamicFamilyFamily extends Family { const $DynamicFamilyFamily._() : super( + retry: null, name: r'$dynamicFamilyProvider', dependencies: null, allTransitiveDependencies: null, @@ -628,6 +637,7 @@ final class $DynamicClassProvider super( from: null, argument: null, + retry: null, name: r'$dynamicClassProvider', isAutoDispose: true, dependencies: null, @@ -698,6 +708,7 @@ final class $DynamicClassFamilyProvider $DynamicClassFamily Function()? create}) : _createCb = create, super( + retry: null, name: r'$dynamicClassFamilyProvider', isAutoDispose: true, dependencies: null, @@ -776,6 +787,7 @@ String _$$dynamicClassFamilyHash() => final class $DynamicClassFamilyFamily extends Family { const $DynamicClassFamilyFamily._() : super( + retry: null, name: r'$dynamicClassFamilyProvider', dependencies: null, allTransitiveDependencies: null, @@ -864,6 +876,7 @@ final class _DynamicProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'_dynamicProvider', isAutoDispose: true, dependencies: null, @@ -940,6 +953,7 @@ String _$dynamicHash() => r'da9dc07960139fff2cf5fe584dca5c524e4f2308'; final class _DynamicFamily extends Family { const _DynamicFamily._() : super( + retry: null, name: r'_dynamicProvider', dependencies: null, allTransitiveDependencies: null, @@ -995,6 +1009,7 @@ final class AliasProvider super( from: null, argument: null, + retry: null, name: r'aliasProvider', isAutoDispose: true, dependencies: null, @@ -1057,6 +1072,7 @@ final class AliasFamilyProvider )? create}) : _createCb = create, super( + retry: null, name: r'aliasFamilyProvider', isAutoDispose: true, dependencies: null, @@ -1134,6 +1150,7 @@ String _$aliasFamilyHash() => r'f345937d5750132f629aef41646b119a301f750b'; final class AliasFamilyFamily extends Family { const AliasFamilyFamily._() : super( + retry: null, name: r'aliasFamilyProvider', dependencies: null, allTransitiveDependencies: null, @@ -1184,6 +1201,7 @@ final class AliasClassProvider super( from: null, argument: null, + retry: null, name: r'aliasClassProvider', isAutoDispose: true, dependencies: null, @@ -1254,6 +1272,7 @@ final class AliasClassFamilyProvider AliasClassFamily Function()? create}) : _createCb = create, super( + retry: null, name: r'aliasClassFamilyProvider', isAutoDispose: true, dependencies: null, @@ -1331,6 +1350,7 @@ String _$aliasClassFamilyHash() => r'3f348beb95dae3a9890b4a4d0ce01481316fc66d'; final class AliasClassFamilyFamily extends Family { const AliasClassFamilyFamily._() : super( + retry: null, name: r'aliasClassFamilyProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index 5cbd372e0..3b01e9aa9 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -21,6 +21,7 @@ final class SimpleProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'simpleProvider', isAutoDispose: true, dependencies: null, @@ -80,6 +81,7 @@ final class Simple2Provider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'simple2Provider', isAutoDispose: true, dependencies: null, @@ -134,6 +136,7 @@ final class SimpleClassProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'simpleClassProvider', isAutoDispose: true, dependencies: null, diff --git a/packages/riverpod_generator/test/integration/hash/retry.dart b/packages/riverpod_generator/test/integration/hash/retry.dart new file mode 100644 index 000000000..6aadf62ba --- /dev/null +++ b/packages/riverpod_generator/test/integration/hash/retry.dart @@ -0,0 +1,12 @@ +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'retry.g.dart'; + +@Riverpod(retry: myRetry) +String a(ARef ref) => throw UnimplementedError(); + +Duration? myRetry(int retryCount, Object error) => null; +Duration? myRetry2(int retryCount, Object error) => null; + +@Riverpod(retry: myRetry2) +String b(ARef ref, int arg) => throw UnimplementedError(); diff --git a/packages/riverpod_generator/test/integration/hash/retry.g.dart b/packages/riverpod_generator/test/integration/hash/retry.g.dart new file mode 100644 index 000000000..a49dc5d2d --- /dev/null +++ b/packages/riverpod_generator/test/integration/hash/retry.g.dart @@ -0,0 +1,202 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'retry.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ARef = Ref; + +@ProviderFor(a) +const aProvider = AProvider._(); + +final class AProvider extends $FunctionalProvider + with $Provider { + const AProvider._( + {String Function( + ARef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: myRetry, + name: r'aProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + ARef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$aHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + AProvider $copyWithCreate( + String Function( + ARef ref, + ) create, + ) { + return AProvider._(create: create); + } + + @override + String create(ARef ref) { + final _$cb = _createCb ?? a; + return _$cb(ref); + } +} + +String _$aHash() => r'3500a02140f277a66793d8118c15e09150ae67cd'; + +typedef BRef = Ref; + +@ProviderFor(b) +const bProvider = BFamily._(); + +final class BProvider extends $FunctionalProvider + with $Provider { + const BProvider._( + {required BFamily super.from, + required int super.argument, + String Function( + BRef ref, + int arg, + )? create}) + : _createCb = create, + super( + retry: myRetry2, + name: r'bProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final String Function( + BRef ref, + int arg, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$bHash(); + + @override + String toString() { + return r'bProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + BProvider $copyWithCreate( + String Function( + BRef ref, + ) create, + ) { + return BProvider._( + argument: argument as int, + from: from! as BFamily, + create: ( + ref, + int arg, + ) => + create(ref)); + } + + @override + String create(BRef ref) { + final _$cb = _createCb ?? b; + final argument = this.argument as int; + return _$cb( + ref, + argument, + ); + } + + @override + bool operator ==(Object other) { + return other is BProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$bHash() => r'0af37d2fa472b9730e1aa01841787d964b9f193b'; + +final class BFamily extends Family { + const BFamily._() + : super( + retry: myRetry2, + name: r'bProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + BProvider call( + int arg, + ) => + BProvider._(argument: arg, from: this); + + @override + String debugGetCreateSourceHash() => _$bHash(); + + @override + String toString() => r'bProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + String Function( + BRef ref, + int args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (pointer) { + final provider = pointer.origin as BProvider; + + final argument = provider.argument as int; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(pointer); + }, + ); + } +} +// ignore_for_file: type=lint +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 79d772a15..fc6837210 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -16,6 +16,7 @@ final class ScopedClassProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'scopedClassProvider', isAutoDispose: true, dependencies: const [], @@ -86,6 +87,7 @@ final class ScopedClassFamilyProvider ScopedClassFamily Function()? create}) : _createCb = create, super( + retry: null, name: r'scopedClassFamilyProvider', isAutoDispose: true, dependencies: null, @@ -163,6 +165,7 @@ String _$scopedClassFamilyHash() => r'04aeb0bbfdc363e2c8714c7a5967368a7f990d58'; final class ScopedClassFamilyFamily extends Family { const ScopedClassFamilyFamily._() : super( + retry: null, name: r'scopedClassFamilyProvider', dependencies: const [], allTransitiveDependencies: const [], diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index adf1cb3d6..d9b6e97f3 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -21,6 +21,7 @@ final class Counter2Provider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'counter2Provider', isAutoDispose: true, dependencies: null, @@ -80,6 +81,7 @@ final class CounterProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'counterProvider', isAutoDispose: true, dependencies: null, diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index e7c2a5a83..2d3f0c39e 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -22,6 +22,7 @@ final class GenericProvider : _createCb = create, super( argument: null, + retry: null, name: r'genericProvider', isAutoDispose: true, dependencies: null, @@ -89,6 +90,7 @@ String _$genericHash() => r'c1122edf55163d47de8d871ed5d15e0a7edddc05'; final class GenericFamily extends Family { const GenericFamily._() : super( + retry: null, name: r'genericProvider', dependencies: null, allTransitiveDependencies: null, @@ -130,6 +132,7 @@ final class GenericClassProvider : _createCb = create, super( argument: null, + retry: null, name: r'genericClassProvider', isAutoDispose: true, dependencies: null, @@ -214,6 +217,7 @@ String _$genericClassHash() => r'401ae1cfd97a4291dfd135a69ff8e1c436866e5a'; final class GenericClassFamily extends Family { const GenericClassFamily._() : super( + retry: null, name: r'genericClassProvider', dependencies: null, allTransitiveDependencies: null, @@ -283,6 +287,7 @@ final class PublicProvider super( from: null, argument: null, + retry: null, name: r'publicProvider', isAutoDispose: true, dependencies: null, @@ -335,6 +340,7 @@ final class _PrivateProvider super( from: null, argument: null, + retry: null, name: r'_privateProvider', isAutoDispose: true, dependencies: null, @@ -399,6 +405,7 @@ final class FamilyProvider })? create}) : _createCb = create, super( + retry: null, name: r'familyProvider', isAutoDispose: true, dependencies: null, @@ -491,6 +498,7 @@ String _$familyHash() => r'6896fac2f6e3ccd7c38ecaa0d538cbd3577936b2'; final class FamilyFamily extends Family { const FamilyFamily._() : super( + retry: null, name: r'familyProvider', dependencies: null, allTransitiveDependencies: null, @@ -563,6 +571,7 @@ final class PublicClassProvider super( from: null, argument: null, + retry: null, name: r'publicClassProvider', isAutoDispose: true, dependencies: null, @@ -624,6 +633,7 @@ final class _PrivateClassProvider super( from: null, argument: null, + retry: null, name: r'_privateClassProvider', isAutoDispose: true, dependencies: null, @@ -693,6 +703,7 @@ final class FamilyClassProvider FamilyClass Function()? create}) : _createCb = create, super( + retry: null, name: r'familyClassProvider', isAutoDispose: true, dependencies: null, @@ -774,6 +785,7 @@ String _$familyClassHash() => r'6ec16ca23da8df4c010ecb5eed72e3e655504460'; final class FamilyClassFamily extends Family { const FamilyClassFamily._() : super( + retry: null, name: r'familyClassProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 37d8308a4..00c358cd1 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -22,6 +22,7 @@ final class GenericProvider : _createCb = create, super( argument: null, + retry: null, name: r'genericProvider', isAutoDispose: true, dependencies: null, @@ -97,6 +98,7 @@ String _$genericHash() => r'0fda19dd377694315cdffd7414d53f98569c655c'; final class GenericFamily extends Family { const GenericFamily._() : super( + retry: null, name: r'genericProvider', dependencies: null, allTransitiveDependencies: null, @@ -148,6 +150,7 @@ final class ComplexGenericProvider })? create}) : _createCb = create, super( + retry: null, name: r'complexGenericProvider', isAutoDispose: true, dependencies: null, @@ -251,6 +254,7 @@ String _$complexGenericHash() => r'a5254e5552cd61bb8d65c018539ff2d8edfd5822'; final class ComplexGenericFamily extends Family { const ComplexGenericFamily._() : super( + retry: null, name: r'complexGenericProvider', dependencies: null, allTransitiveDependencies: null, @@ -314,6 +318,7 @@ final class GenericClassProvider : _createCb = create, super( argument: null, + retry: null, name: r'genericClassProvider', isAutoDispose: true, dependencies: null, @@ -406,6 +411,7 @@ String _$genericClassHash() => r'42ec5a5635796c0d597f0c9dac28ec2f61a486ff'; final class GenericClassFamily extends Family { const GenericClassFamily._() : super( + retry: null, name: r'genericClassProvider', dependencies: null, allTransitiveDependencies: null, @@ -474,6 +480,7 @@ final class RawFutureProvider super( from: null, argument: null, + retry: null, name: r'rawFutureProvider', isAutoDispose: true, dependencies: null, @@ -535,6 +542,7 @@ final class RawStreamProvider super( from: null, argument: null, + retry: null, name: r'rawStreamProvider', isAutoDispose: true, dependencies: null, @@ -591,6 +599,7 @@ final class RawFutureClassProvider super( from: null, argument: null, + retry: null, name: r'rawFutureClassProvider', isAutoDispose: true, dependencies: null, @@ -660,6 +669,7 @@ final class RawStreamClassProvider super( from: null, argument: null, + retry: null, name: r'rawStreamClassProvider', isAutoDispose: true, dependencies: null, @@ -735,6 +745,7 @@ final class RawFamilyFutureProvider )? create}) : _createCb = create, super( + retry: null, name: r'rawFamilyFutureProvider', isAutoDispose: true, dependencies: null, @@ -812,6 +823,7 @@ String _$rawFamilyFutureHash() => r'485f59512081852e51279658facc015309743864'; final class RawFamilyFutureFamily extends Family { const RawFamilyFutureFamily._() : super( + retry: null, name: r'rawFamilyFutureProvider', dependencies: null, allTransitiveDependencies: null, @@ -868,6 +880,7 @@ final class RawFamilyStreamProvider )? create}) : _createCb = create, super( + retry: null, name: r'rawFamilyStreamProvider', isAutoDispose: true, dependencies: null, @@ -945,6 +958,7 @@ String _$rawFamilyStreamHash() => r'e778e5cfcb8ab381e2412f5c73213aaa03b93012'; final class RawFamilyStreamFamily extends Family { const RawFamilyStreamFamily._() : super( + retry: null, name: r'rawFamilyStreamProvider', dependencies: null, allTransitiveDependencies: null, @@ -996,6 +1010,7 @@ final class RawFamilyFutureClassProvider RawFamilyFutureClass Function()? create}) : _createCb = create, super( + retry: null, name: r'rawFamilyFutureClassProvider', isAutoDispose: true, dependencies: null, @@ -1074,6 +1089,7 @@ String _$rawFamilyFutureClassHash() => final class RawFamilyFutureClassFamily extends Family { const RawFamilyFutureClassFamily._() : super( + retry: null, name: r'rawFamilyFutureClassProvider', dependencies: null, allTransitiveDependencies: null, @@ -1158,6 +1174,7 @@ final class RawFamilyStreamClassProvider RawFamilyStreamClass Function()? create}) : _createCb = create, super( + retry: null, name: r'rawFamilyStreamClassProvider', isAutoDispose: true, dependencies: null, @@ -1236,6 +1253,7 @@ String _$rawFamilyStreamClassHash() => final class RawFamilyStreamClassFamily extends Family { const RawFamilyStreamClassFamily._() : super( + retry: null, name: r'rawFamilyStreamClassProvider', dependencies: null, allTransitiveDependencies: null, @@ -1327,6 +1345,7 @@ final class PublicProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'publicProvider', isAutoDispose: true, dependencies: null, @@ -1386,6 +1405,7 @@ final class Supports$inNamesProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'supports$inNamesProvider', isAutoDispose: true, dependencies: null, @@ -1461,6 +1481,7 @@ final class FamilyProvider extends $FunctionalProvider })? create}) : _createCb = create, super( + retry: null, name: r'familyProvider', isAutoDispose: true, dependencies: null, @@ -1562,6 +1583,7 @@ String _$familyHash() => r'14d1ee238ca608d547630d0e222ef4c5866e9e61'; final class FamilyFamily extends Family { const FamilyFamily._() : super( + retry: null, name: r'familyProvider', dependencies: null, allTransitiveDependencies: null, @@ -1639,6 +1661,7 @@ final class _PrivateProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'_privateProvider', isAutoDispose: true, dependencies: null, @@ -1696,6 +1719,7 @@ final class PublicClassProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'publicClassProvider', isAutoDispose: true, dependencies: null, @@ -1765,6 +1789,7 @@ final class _PrivateClassProvider super( from: null, argument: null, + retry: null, name: r'_privateClassProvider', isAutoDispose: true, dependencies: null, @@ -1844,6 +1869,7 @@ final class FamilyClassProvider extends $NotifierProvider { FamilyClass Function()? create}) : _createCb = create, super( + retry: null, name: r'familyClassProvider', isAutoDispose: true, dependencies: null, @@ -1934,6 +1960,7 @@ String _$familyClassHash() => r'ac5aba6b9cbee66236d6e1fa3d18b9b6ffb2c5f1'; final class FamilyClassFamily extends Family { const FamilyClassFamily._() : super( + retry: null, name: r'familyClassProvider', dependencies: null, allTransitiveDependencies: null, @@ -2077,6 +2104,7 @@ final class Supports$InFnNameProvider : _createCb = create, super( argument: null, + retry: null, name: r'supports$InFnNameProvider', isAutoDispose: true, dependencies: null, @@ -2153,6 +2181,7 @@ String _$supports$InFnNameHash() => r'fec3daca655669a46760cc54921f098b9cbaac3d'; final class Supports$InFnNameFamily extends Family { const Supports$InFnNameFamily._() : super( + retry: null, name: r'supports$InFnNameProvider', dependencies: null, allTransitiveDependencies: null, @@ -2207,6 +2236,7 @@ final class Supports$InFnNameFamilyProvider })? create}) : _createCb = create, super( + retry: null, name: r'supports$InFnNameFamilyProvider', isAutoDispose: true, dependencies: null, @@ -2318,6 +2348,7 @@ String _$supports$InFnNameFamilyHash() => final class Supports$InFnNameFamilyFamily extends Family { const Supports$InFnNameFamilyFamily._() : super( + retry: null, name: r'supports$InFnNameFamilyProvider', dependencies: null, allTransitiveDependencies: null, @@ -2386,6 +2417,7 @@ final class Supports$InClassNameProvider : _createCb = create, super( argument: null, + retry: null, name: r'supports$InClassNameProvider', isAutoDispose: true, dependencies: null, @@ -2482,6 +2514,7 @@ String _$supports$InClassNameHash() => final class Supports$InClassNameFamily extends Family { const Supports$InClassNameFamily._() : super( + retry: null, name: r'supports$InClassNameProvider', dependencies: null, allTransitiveDependencies: null, @@ -2552,6 +2585,7 @@ final class Supports$InClassFamilyNameProvider Supports$InClassFamilyName Function()? create}) : _createCb = create, super( + retry: null, name: r'supports$InClassFamilyNameProvider', isAutoDispose: true, dependencies: null, @@ -2670,6 +2704,7 @@ String _$supports$InClassFamilyNameHash() => final class Supports$InClassFamilyNameFamily extends Family { const Supports$InClassFamilyNameFamily._() : super( + retry: null, name: r'supports$InClassFamilyNameProvider', dependencies: null, allTransitiveDependencies: null, @@ -2791,6 +2826,7 @@ final class GeneratedProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'generatedProvider', isAutoDispose: true, dependencies: null, @@ -2851,6 +2887,7 @@ final class UnnecessaryCastProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'unnecessaryCastProvider', isAutoDispose: true, dependencies: null, @@ -2927,6 +2964,7 @@ String _$unnecessaryCastHash() => r'282c11ef4f55267c3e6ed70af1a260cd1c2163e6'; final class UnnecessaryCastFamily extends Family { const UnnecessaryCastFamily._() : super( + retry: null, name: r'unnecessaryCastProvider', dependencies: null, allTransitiveDependencies: null, @@ -2978,6 +3016,7 @@ final class UnnecessaryCastClassProvider UnnecessaryCastClass Function()? create}) : _createCb = create, super( + retry: null, name: r'unnecessaryCastClassProvider', isAutoDispose: true, dependencies: null, @@ -3056,6 +3095,7 @@ String _$unnecessaryCastClassHash() => final class UnnecessaryCastClassFamily extends Family { const UnnecessaryCastClassFamily._() : super( + retry: null, name: r'unnecessaryCastClassProvider', dependencies: null, allTransitiveDependencies: null, @@ -3148,6 +3188,7 @@ final class ManyDataStreamProvider )? create}) : _createCb = create, super( + retry: null, name: r'manyDataStreamProvider', isAutoDispose: true, dependencies: null, @@ -3230,6 +3271,7 @@ String _$manyDataStreamHash() => r'965270e9e187c17b8c78c03ded79136a4073ff04'; final class ManyDataStreamFamily extends Family { const ManyDataStreamFamily._() : super( + retry: null, name: r'manyDataStreamProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 2ebe44d3a..caa66850a 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -25,6 +25,7 @@ final class PublicProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'publicProvider', isAutoDispose: true, dependencies: null, @@ -88,6 +89,7 @@ final class Supports$inNamesProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'supports$inNamesProvider', isAutoDispose: true, dependencies: null, @@ -163,6 +165,7 @@ final class FamilyProvider extends $FunctionalProvider })? create}) : _createCb = create, super( + retry: null, name: r'familyProvider', isAutoDispose: true, dependencies: null, @@ -264,6 +267,7 @@ String _$familyHash() => r'ebf082969854dcc358b9870a2e5e9b922423e59b'; final class FamilyFamily extends Family { const FamilyFamily._() : super( + retry: null, name: r'familyProvider', dependencies: null, allTransitiveDependencies: null, @@ -341,6 +345,7 @@ final class _PrivateProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'_privateProvider', isAutoDispose: true, dependencies: null, @@ -398,6 +403,7 @@ final class PublicClassProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'publicClassProvider', isAutoDispose: true, dependencies: null, @@ -467,6 +473,7 @@ final class _PrivateClassProvider super( from: null, argument: null, + retry: null, name: r'_privateClassProvider', isAutoDispose: true, dependencies: null, @@ -546,6 +553,7 @@ final class FamilyClassProvider extends $NotifierProvider { FamilyClass Function()? create}) : _createCb = create, super( + retry: null, name: r'familyClassProvider', isAutoDispose: true, dependencies: null, @@ -636,6 +644,7 @@ String _$familyClassHash() => r'721bdd2f1ca0d7cee1a0ae476d7bfe93f9ce6875'; final class FamilyClassFamily extends Family { const FamilyClassFamily._() : super( + retry: null, name: r'familyClassProvider', dependencies: null, allTransitiveDependencies: null, @@ -777,6 +786,7 @@ final class Supports$InClassNameProvider super( from: null, argument: null, + retry: null, name: r'supports$InClassNameProvider', isAutoDispose: true, dependencies: null, diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index de8818050..ef5b84bf4 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -19,6 +19,7 @@ final class ExampleProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, @@ -96,6 +97,7 @@ final class ExampleFamilyProvider ExampleFamily Function()? create}) : _createCb = create, super( + retry: null, name: r'exampleFamilyProvider', isAutoDispose: true, dependencies: null, @@ -180,6 +182,7 @@ String _$exampleFamilyHash() => r'37d4a4fd66999562cd92051f91266270d5a1e5ea'; final class ExampleFamilyFamily extends Family { const ExampleFamilyFamily._() : super( + retry: null, name: r'exampleFamilyProvider', dependencies: null, allTransitiveDependencies: null, @@ -289,6 +292,7 @@ final class GenericProvider : _createCb = create, super( argument: null, + retry: null, name: r'genericProvider', isAutoDispose: true, dependencies: null, @@ -381,6 +385,7 @@ String _$genericHash() => r'0a3792d7b59723aebd92715eef2c74d2f267cbd2'; final class GenericFamily extends Family { const GenericFamily._() : super( + retry: null, name: r'genericProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index f304e4a6a..bc2b97022 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -25,6 +25,7 @@ final class ExampleProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, @@ -94,6 +95,7 @@ final class ExampleFamilyProvider extends $FunctionalProvider })? create}) : _createCb = create, super( + retry: null, name: r'exampleFamilyProvider', isAutoDispose: true, dependencies: null, @@ -180,6 +182,7 @@ String _$exampleFamilyHash() => r'f5547d3d88c42b135db5efea7dfaa542b3db9cc1'; final class ExampleFamilyFamily extends Family { const ExampleFamilyFamily._() : super( + retry: null, name: r'exampleFamilyProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 8016ee4ef..724b19e36 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -27,6 +27,7 @@ final class FnProvider extends $FunctionalProvider })? create}) : _createCb = create, super( + retry: null, name: r'fnProvider', isAutoDispose: true, dependencies: null, @@ -112,6 +113,7 @@ String _$fnHash() => r'7b8d0cf179067c80b8553b3232fd886fac83f387'; final class FnFamily extends Family { const FnFamily._() : super( + retry: null, name: r'fnProvider', dependencies: null, allTransitiveDependencies: null, @@ -176,6 +178,7 @@ final class MyNotifierProvider extends $NotifierProvider { MyNotifier Function()? create}) : _createCb = create, super( + retry: null, name: r'myNotifierProvider', isAutoDispose: true, dependencies: null, @@ -259,6 +262,7 @@ String _$myNotifierHash() => r'04a0cf33dbda80e3fa80748fe46546b1c968da22'; final class MyNotifierFamily extends Family { const MyNotifierFamily._() : super( + retry: null, name: r'myNotifierProvider', dependencies: null, allTransitiveDependencies: null, @@ -368,6 +372,7 @@ final class Regresion2959Provider super( from: null, argument: null, + retry: null, name: r'regresion2959Provider', isAutoDispose: true, dependencies: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index 8fea76279..8c6ea6c4a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -18,6 +18,7 @@ final class GeneratedNotifierProvider GeneratedNotifier Function()? create}) : _createCb = create, super( + retry: null, name: r'generatedNotifierProvider', isAutoDispose: true, dependencies: null, @@ -95,6 +96,7 @@ String _$generatedNotifierHash() => r'2b7f4fba816b6e8ccd0e8b7d11fcd207bbb79828'; final class GeneratedNotifierFamily extends Family { const GeneratedNotifierFamily._() : super( + retry: null, name: r'generatedNotifierProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index c8bea0cd4..700e79762 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -21,6 +21,7 @@ final class NamelessProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'namelessProvider', isAutoDispose: true, dependencies: null, @@ -81,6 +82,7 @@ final class GenericsProvider : _createCb = create, super( argument: null, + retry: null, name: r'genericsProvider', isAutoDispose: true, dependencies: null, @@ -157,6 +159,7 @@ String _$genericsHash() => r'b5813cf6a00581bafea48d8ab66f7d5468fff0e4'; final class GenericsFamily extends Family { const GenericsFamily._() : super( + retry: null, name: r'genericsProvider', dependencies: null, allTransitiveDependencies: null, @@ -203,6 +206,7 @@ final class NoGenericsProvider : _createCb = create, super( argument: null, + retry: null, name: r'noGenericsProvider', isAutoDispose: true, dependencies: null, @@ -279,6 +283,7 @@ String _$noGenericsHash() => r'449264e25990bc14ad811c0940117c8cde4d730a'; final class NoGenericsFamily extends Family { const NoGenericsFamily._() : super( + retry: null, name: r'noGenericsProvider', dependencies: null, allTransitiveDependencies: null, @@ -324,6 +329,7 @@ final class MissingGenericsProvider extends $FunctionalProvider : _createCb = create, super( argument: null, + retry: null, name: r'missingGenericsProvider', isAutoDispose: true, dependencies: null, @@ -400,6 +406,7 @@ String _$missingGenericsHash() => r'7d8bc49e4f1e466260fbf6a61a3f9e62b4aef28f'; final class MissingGenericsFamily extends Family { const MissingGenericsFamily._() : super( + retry: null, name: r'missingGenericsProvider', dependencies: null, allTransitiveDependencies: null, @@ -445,6 +452,7 @@ final class WrongOrderProvider extends $FunctionalProvider : _createCb = create, super( argument: null, + retry: null, name: r'wrongOrderProvider', isAutoDispose: true, dependencies: null, @@ -521,6 +529,7 @@ String _$wrongOrderHash() => r'6732863e85b220c07f82c2d13be15c1e6f08192d'; final class WrongOrderFamily extends Family { const WrongOrderFamily._() : super( + retry: null, name: r'wrongOrderProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart index 61e8b3022..a4e054f21 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart @@ -16,6 +16,7 @@ final class MyNotifierProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'myNotifierProvider', isAutoDispose: true, dependencies: null, @@ -84,6 +85,7 @@ final class NoExtendsProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'noExtendsProvider', isAutoDispose: true, dependencies: null, @@ -152,6 +154,7 @@ final class WrongExtendsProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'wrongExtendsProvider', isAutoDispose: true, dependencies: null, @@ -221,6 +224,7 @@ final class _PrivateClassProvider super( from: null, argument: null, + retry: null, name: r'_privateClassProvider', isAutoDispose: true, dependencies: null, @@ -291,6 +295,7 @@ final class GenericsProvider : _createCb = create, super( argument: null, + retry: null, name: r'genericsProvider', isAutoDispose: true, dependencies: null, @@ -383,6 +388,7 @@ String _$genericsHash() => r'0a1bf00e0610ccb1fb5615460e1bc4afb2555f69'; final class GenericsFamily extends Family { const GenericsFamily._() : super( + retry: null, name: r'genericsProvider', dependencies: null, allTransitiveDependencies: null, @@ -446,6 +452,7 @@ final class NoGenericsProvider : _createCb = create, super( argument: null, + retry: null, name: r'noGenericsProvider', isAutoDispose: true, dependencies: null, @@ -538,6 +545,7 @@ String _$noGenericsHash() => r'30d5d20092f43cb17ede1f619773757df7cecb30'; final class NoGenericsFamily extends Family { const NoGenericsFamily._() : super( + retry: null, name: r'noGenericsProvider', dependencies: null, allTransitiveDependencies: null, @@ -602,6 +610,7 @@ final class MissingGenericsProvider : _createCb = create, super( argument: null, + retry: null, name: r'missingGenericsProvider', isAutoDispose: true, dependencies: null, @@ -696,6 +705,7 @@ String _$missingGenericsHash() => r'b611c76d5fb87fdde78b5fc017912e0569762c23'; final class MissingGenericsFamily extends Family { const MissingGenericsFamily._() : super( + retry: null, name: r'missingGenericsProvider', dependencies: null, allTransitiveDependencies: null, @@ -759,6 +769,7 @@ final class WrongOrderProvider : _createCb = create, super( argument: null, + retry: null, name: r'wrongOrderProvider', isAutoDispose: true, dependencies: null, @@ -851,6 +862,7 @@ String _$wrongOrderHash() => r'7757670a2f67406ebc96c87edf088deb9cb248a1'; final class WrongOrderFamily extends Family { const WrongOrderFamily._() : super( + retry: null, name: r'wrongOrderProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart index 1688bdb84..195bf9d30 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart @@ -21,6 +21,7 @@ final class KeepAliveProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'keepAliveProvider', isAutoDispose: false, dependencies: null, @@ -76,6 +77,7 @@ final class KeepAliveClassProvider super( from: null, argument: null, + retry: null, name: r'keepAliveClassProvider', isAutoDispose: false, dependencies: null, @@ -149,6 +151,7 @@ final class AutoDisposeProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'autoDisposeProvider', isAutoDispose: true, dependencies: null, @@ -204,6 +207,7 @@ final class AutoDisposeClassProvider super( from: null, argument: null, + retry: null, name: r'autoDisposeClassProvider', isAutoDispose: true, dependencies: null, @@ -277,6 +281,7 @@ final class FnProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'fnProvider', isAutoDispose: false, dependencies: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index d0fe04acd..b263c9f96 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -15,6 +15,7 @@ final class AProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'aProvider', isAutoDispose: true, dependencies: null, @@ -81,6 +82,7 @@ final class A2Provider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'a2Provider', isAutoDispose: false, dependencies: null, @@ -149,6 +151,7 @@ final class A3Provider extends $NotifierProvider { A3 Function()? create}) : _createCb = create, super( + retry: null, name: r'a3Provider', isAutoDispose: true, dependencies: null, @@ -223,6 +226,7 @@ String _$a3Hash() => r'2e21e9af8b67b5412611e0d23b862ead56deb8e1'; final class A3Family extends Family { const A3Family._() : super( + retry: null, name: r'a3Provider', dependencies: null, allTransitiveDependencies: null, @@ -304,6 +308,7 @@ final class A4Provider extends $NotifierProvider { A4 Function()? create}) : _createCb = create, super( + retry: null, name: r'a4Provider', isAutoDispose: false, dependencies: null, @@ -378,6 +383,7 @@ String _$a4Hash() => r'cdd9ad09099881cafe06d7b3095a8b06dbe7d876'; final class A4Family extends Family { const A4Family._() : super( + retry: null, name: r'a4Provider', dependencies: null, allTransitiveDependencies: null, @@ -459,6 +465,7 @@ final class A5Provider extends $AsyncNotifierProvider { A5 Function()? create}) : _createCb = create, super( + retry: null, name: r'a5Provider', isAutoDispose: true, dependencies: null, @@ -526,6 +533,7 @@ String _$a5Hash() => r'c83634c22b6a9149aa8787e45c3b7cd6c88b5958'; final class A5Family extends Family { const A5Family._() : super( + retry: null, name: r'a5Provider', dependencies: null, allTransitiveDependencies: null, @@ -608,6 +616,7 @@ final class A6Provider extends $AsyncNotifierProvider { A6 Function()? create}) : _createCb = create, super( + retry: null, name: r'a6Provider', isAutoDispose: false, dependencies: null, @@ -675,6 +684,7 @@ String _$a6Hash() => r'fe641c72cacf3dd119eb77a34fe8fc71c5c30139'; final class A6Family extends Family { const A6Family._() : super( + retry: null, name: r'a6Provider', dependencies: null, allTransitiveDependencies: null, @@ -757,6 +767,7 @@ final class A7Provider extends $StreamNotifierProvider { A7 Function()? create}) : _createCb = create, super( + retry: null, name: r'a7Provider', isAutoDispose: true, dependencies: null, @@ -824,6 +835,7 @@ String _$a7Hash() => r'd3d9ab5090e21987d65522f14ebb70d0058fc56a'; final class A7Family extends Family { const A7Family._() : super( + retry: null, name: r'a7Provider', dependencies: null, allTransitiveDependencies: null, @@ -906,6 +918,7 @@ final class A8Provider extends $StreamNotifierProvider { A8 Function()? create}) : _createCb = create, super( + retry: null, name: r'a8Provider', isAutoDispose: false, dependencies: null, @@ -973,6 +986,7 @@ String _$a8Hash() => r'54f4a841a283161bed3d444dcee53bf367958678'; final class A8Family extends Family { const A8Family._() : super( + retry: null, name: r'a8Provider', dependencies: null, allTransitiveDependencies: null, @@ -1053,6 +1067,7 @@ final class BProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'bProvider', isAutoDispose: false, dependencies: null, @@ -1119,6 +1134,7 @@ final class B2Provider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'b2Provider', isAutoDispose: true, dependencies: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart index 4d7d226ce..126b8cede 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart @@ -21,6 +21,7 @@ final class BProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'bProvider', isAutoDispose: true, dependencies: null, @@ -80,6 +81,7 @@ final class AnotherScopedProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'anotherScopedProvider', isAutoDispose: true, dependencies: const [], @@ -139,6 +141,7 @@ final class AnotherNonEmptyScopedProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'anotherNonEmptyScopedProvider', isAutoDispose: true, dependencies: const [anotherScopedProvider], diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart index ffa3778cc..c464a0c2a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart @@ -21,6 +21,7 @@ final class DepProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'depProvider', isAutoDispose: true, dependencies: const [], @@ -80,6 +81,7 @@ final class TransitiveDepProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'transitiveDepProvider', isAutoDispose: true, dependencies: const [depProvider], @@ -143,6 +145,7 @@ final class Dep2Provider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'dep2Provider', isAutoDispose: true, dependencies: const [], @@ -203,6 +206,7 @@ final class DepFamilyProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'depFamilyProvider', isAutoDispose: true, dependencies: null, @@ -279,6 +283,7 @@ String _$depFamilyHash() => r'c11006a8b9718af9899999b7c49f78cf3423f558'; final class DepFamilyFamily extends Family { const DepFamilyFamily._() : super( + retry: null, name: r'depFamilyProvider', dependencies: const [], allTransitiveDependencies: const [], @@ -341,6 +346,7 @@ final class PlainAnnotationProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'plainAnnotationProvider', isAutoDispose: true, dependencies: null, @@ -400,6 +406,7 @@ final class CustomAnnotationProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'customAnnotationProvider', isAutoDispose: true, dependencies: null, @@ -461,6 +468,7 @@ final class CustomAnnotationWithTrailingCommaProvider super( from: null, argument: null, + retry: null, name: r'customAnnotationWithTrailingCommaProvider', isAutoDispose: true, dependencies: null, @@ -522,6 +530,7 @@ final class ExistingDepProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'existingDepProvider', isAutoDispose: true, dependencies: const [], @@ -581,6 +590,7 @@ final class MultipleDepsProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'multipleDepsProvider', isAutoDispose: true, dependencies: const [], @@ -648,6 +658,7 @@ final class ProviderWithDartDocProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'providerWithDartDocProvider', isAutoDispose: true, dependencies: const [], diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart index b1b4d7a09..aebad7d82 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart @@ -21,6 +21,7 @@ final class DepProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'depProvider', isAutoDispose: true, dependencies: const [], @@ -80,6 +81,7 @@ final class GeneratedScopedProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'generatedScopedProvider', isAutoDispose: true, dependencies: const [], @@ -139,6 +141,7 @@ final class GeneratedRootProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'generatedRootProvider', isAutoDispose: true, dependencies: null, @@ -200,6 +203,7 @@ final class WatchScopedButNoDependenciesProvider super( from: null, argument: null, + retry: null, name: r'watchScopedButNoDependenciesProvider', isAutoDispose: true, dependencies: null, @@ -262,6 +266,7 @@ final class WatchGeneratedScopedButNoDependenciesProvider super( from: null, argument: null, + retry: null, name: r'watchGeneratedScopedButNoDependenciesProvider', isAutoDispose: true, dependencies: null, @@ -325,6 +330,7 @@ final class WatchRootButNoDependenciesProvider super( from: null, argument: null, + retry: null, name: r'watchRootButNoDependenciesProvider', isAutoDispose: true, dependencies: null, @@ -387,6 +393,7 @@ final class WatchGeneratedRootButNoDependenciesProvider super( from: null, argument: null, + retry: null, name: r'watchGeneratedRootButNoDependenciesProvider', isAutoDispose: true, dependencies: null, @@ -450,6 +457,7 @@ final class WatchScopedButEmptyDependenciesProvider super( from: null, argument: null, + retry: null, name: r'watchScopedButEmptyDependenciesProvider', isAutoDispose: true, dependencies: const [], @@ -512,6 +520,7 @@ final class WatchGeneratedScopedButEmptyDependenciesProvider super( from: null, argument: null, + retry: null, name: r'watchGeneratedScopedButEmptyDependenciesProvider', isAutoDispose: true, dependencies: const [], @@ -575,6 +584,7 @@ final class WatchRootButEmptyDependenciesProvider super( from: null, argument: null, + retry: null, name: r'watchRootButEmptyDependenciesProvider', isAutoDispose: true, dependencies: const [], @@ -637,6 +647,7 @@ final class WatchGeneratedRootButEmptyDependenciesProvider super( from: null, argument: null, + retry: null, name: r'watchGeneratedRootButEmptyDependenciesProvider', isAutoDispose: true, dependencies: const [], @@ -700,6 +711,7 @@ final class WatchGeneratedScopedAndContainsDependencyProvider super( from: null, argument: null, + retry: null, name: r'watchGeneratedScopedAndContainsDependencyProvider', isAutoDispose: true, dependencies: const [generatedScopedProvider], @@ -765,6 +777,7 @@ final class ClassWatchGeneratedRootButMissingDependenciesProvider super( from: null, argument: null, + retry: null, name: r'classWatchGeneratedRootButMissingDependenciesProvider', isAutoDispose: true, dependencies: const [], @@ -844,6 +857,7 @@ final class Regression2348Provider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'regression2348Provider', isAutoDispose: true, dependencies: const [generatedScopedProvider], @@ -903,6 +917,7 @@ final class Regression2417Provider super( from: null, argument: null, + retry: null, name: r'regression2417Provider', isAutoDispose: true, dependencies: const [generatedScopedProvider], @@ -981,6 +996,7 @@ final class FamilyDepProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'familyDepProvider', isAutoDispose: true, dependencies: null, @@ -1059,6 +1075,7 @@ String _$familyDepHash() => r'1c152873ed2b3e88da09d8e1fc53a33635cbe3b3'; final class FamilyDepFamily extends Family { const FamilyDepFamily._() : super( + retry: null, name: r'familyDepProvider', dependencies: const [depProvider], allTransitiveDependencies: const [ @@ -1116,6 +1133,7 @@ final class FamilyDep2Provider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'familyDep2Provider', isAutoDispose: true, dependencies: null, @@ -1196,6 +1214,7 @@ String _$familyDep2Hash() => r'd81e2e56d75dd08a695b834853a3a6cea99ea305'; final class FamilyDep2Family extends Family { const FamilyDep2Family._() : super( + retry: null, name: r'familyDep2Provider', dependencies: const [familyDepProvider], allTransitiveDependencies: const [ @@ -1253,6 +1272,7 @@ final class AliasProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'aliasProvider', isAutoDispose: true, dependencies: null, @@ -1307,6 +1327,7 @@ final class AliasClassProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'aliasClassProvider', isAutoDispose: true, dependencies: null, @@ -1376,6 +1397,7 @@ final class RiverpodDependenciesProvider super( from: null, argument: null, + retry: null, name: r'riverpodDependenciesProvider', isAutoDispose: true, dependencies: const [depProvider], @@ -1454,6 +1476,7 @@ final class FooProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'fooProvider', isAutoDispose: true, dependencies: null, @@ -1513,6 +1536,7 @@ final class CrossFileDependencyProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'crossFileDependencyProvider', isAutoDispose: true, dependencies: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart index 18acd29fa..59f2dc0ad 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart @@ -21,6 +21,7 @@ final class RootProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'rootProvider', isAutoDispose: true, dependencies: null, @@ -80,6 +81,7 @@ final class DepProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'depProvider', isAutoDispose: true, dependencies: const [], @@ -139,6 +141,7 @@ final class Dep2Provider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'dep2Provider', isAutoDispose: true, dependencies: const [], @@ -202,6 +205,7 @@ final class ExtraDepProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'extraDepProvider', isAutoDispose: true, dependencies: const [depProvider, dep2Provider], @@ -267,6 +271,7 @@ final class NoDepProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'noDepProvider', isAutoDispose: true, dependencies: const [depProvider], @@ -332,6 +337,7 @@ final class DependenciesFirstThenKeepAliveProvider super( from: null, argument: null, + retry: null, name: r'dependenciesFirstThenKeepAliveProvider', isAutoDispose: true, dependencies: const [depProvider], @@ -396,6 +402,7 @@ final class NoDepNoParamProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'noDepNoParamProvider', isAutoDispose: true, dependencies: const [depProvider], @@ -459,6 +466,7 @@ final class NoDepWithoutCommaProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'noDepWithoutCommaProvider', isAutoDispose: true, dependencies: const [depProvider], @@ -522,6 +530,7 @@ final class RootDepProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'rootDepProvider', isAutoDispose: true, dependencies: const [rootProvider], diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index 103e6de3a..cac3f9f6f 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -22,6 +22,7 @@ final class GeneratorProvider extends $FunctionalProvider })? create}) : _createCb = create, super( + retry: null, name: r'generatorProvider', isAutoDispose: false, dependencies: null, @@ -98,6 +99,7 @@ String _$generatorHash() => r'e76b8050c3a272ecef1985e4dc7dfe5df3270f2f'; final class GeneratorFamily extends Family { const GeneratorFamily._() : super( + retry: null, name: r'generatorProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart index 55f4712a4..08c0d1d49 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart @@ -17,6 +17,7 @@ final class UnimplementedScopedProvider super( from: null, argument: null, + retry: null, name: r'unimplementedScopedProvider', isAutoDispose: true, dependencies: const [], @@ -91,6 +92,7 @@ final class ScopedProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'scopedProvider', isAutoDispose: true, dependencies: const [], @@ -150,6 +152,7 @@ final class RootProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'rootProvider', isAutoDispose: true, dependencies: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart index 039f3aba2..4d26711bf 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart @@ -21,6 +21,7 @@ final class ScopedProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'scopedProvider', isAutoDispose: true, dependencies: const [], @@ -80,6 +81,7 @@ final class RootProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'rootProvider', isAutoDispose: true, dependencies: null, diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart index c2ea21a9d..648dc92a9 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart @@ -21,6 +21,7 @@ final class IntegerProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'integerProvider', isAutoDispose: true, dependencies: null, @@ -81,6 +82,7 @@ final class StateNotifierProvider super( from: null, argument: null, + retry: null, name: r'stateNotifierProvider', isAutoDispose: true, dependencies: null, @@ -143,6 +145,7 @@ final class AsyncStateNotifierProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'asyncStateNotifierProvider', isAutoDispose: true, dependencies: null, @@ -192,6 +195,7 @@ final class StateNotifierClassProvider super( from: null, argument: null, + retry: null, name: r'stateNotifierClassProvider', isAutoDispose: true, dependencies: null, @@ -269,6 +273,7 @@ final class StateNotifierAsyncProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'stateNotifierAsyncProvider', isAutoDispose: true, dependencies: null, @@ -318,6 +323,7 @@ final class SelfNotifierProvider super( from: null, argument: null, + retry: null, name: r'selfNotifierProvider', isAutoDispose: true, dependencies: null, @@ -379,6 +385,7 @@ final class SyncSelfNotifierProvider super( from: null, argument: null, + retry: null, name: r'syncSelfNotifierProvider', isAutoDispose: true, dependencies: null, @@ -448,6 +455,7 @@ final class StreamSelfNotifierProvider super( from: null, argument: null, + retry: null, name: r'streamSelfNotifierProvider', isAutoDispose: true, dependencies: null, @@ -512,6 +520,7 @@ final class StateNotifierClassAsyncProvider super( from: null, argument: null, + retry: null, name: r'stateNotifierClassAsyncProvider', isAutoDispose: true, dependencies: null, @@ -581,6 +590,7 @@ final class ChangeNotifierProvider super( from: null, argument: null, + retry: null, name: r'changeNotifierProvider', isAutoDispose: true, dependencies: null, @@ -636,6 +646,7 @@ final class ChangeNotifierClassProvider super( from: null, argument: null, + retry: null, name: r'changeNotifierClassProvider', isAutoDispose: true, dependencies: null, @@ -710,6 +721,7 @@ final class NotifierProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'notifierProvider', isAutoDispose: true, dependencies: null, @@ -770,6 +782,7 @@ final class AutoDisposeNotifierProvider super( from: null, argument: null, + retry: null, name: r'autoDisposeNotifierProvider', isAutoDispose: true, dependencies: null, @@ -827,6 +840,7 @@ final class NotifierClassProvider super( from: null, argument: null, + retry: null, name: r'notifierClassProvider', isAutoDispose: true, dependencies: null, @@ -901,6 +915,7 @@ final class AsyncNotifierProvider super( from: null, argument: null, + retry: null, name: r'asyncNotifierProvider', isAutoDispose: true, dependencies: null, @@ -956,6 +971,7 @@ final class AsyncNotifierClassProvider super( from: null, argument: null, + retry: null, name: r'asyncNotifierClassProvider', isAutoDispose: true, dependencies: null, @@ -1031,6 +1047,7 @@ final class RawNotifierProvider super( from: null, argument: null, + retry: null, name: r'rawNotifierProvider', isAutoDispose: true, dependencies: null, @@ -1092,6 +1109,7 @@ final class RawFutureNotifierProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'rawFutureNotifierProvider', isAutoDispose: true, dependencies: null, @@ -1153,6 +1171,7 @@ final class RawStreamNotifierProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'rawStreamNotifierProvider', isAutoDispose: true, dependencies: null, @@ -1216,6 +1235,7 @@ final class FutureRawNotifierProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'futureRawNotifierProvider', isAutoDispose: true, dependencies: null, @@ -1271,6 +1291,7 @@ final class StreamRawNotifierProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'streamRawNotifierProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/advanced/select/select/codegen.g.dart b/website/docs/advanced/select/select/codegen.g.dart index 7be2b2f33..2d51a144c 100644 --- a/website/docs/advanced/select/select/codegen.g.dart +++ b/website/docs/advanced/select/select/codegen.g.dart @@ -23,6 +23,7 @@ final class ExampleProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/advanced/select/select_async/codegen.g.dart b/website/docs/advanced/select/select_async/codegen.g.dart index 08b777520..e1f780f62 100644 --- a/website/docs/advanced/select/select_async/codegen.g.dart +++ b/website/docs/advanced/select/select_async/codegen.g.dart @@ -24,6 +24,7 @@ final class UserProvider super( from: null, argument: null, + retry: null, name: r'userProvider', isAutoDispose: true, dependencies: null, @@ -75,6 +76,7 @@ final class ExampleProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart index aaa83a740..127c57c1a 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart @@ -44,6 +44,7 @@ final class ActivityProvider super( from: null, argument: null, + retry: null, name: r'activityProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart index b86b18b0e..46529fa89 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -24,6 +24,7 @@ final class ActivityProvider super( from: null, argument: null, + retry: null, name: r'activityProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart index 2cef845c2..5c8f2d5bf 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -24,6 +24,7 @@ final class ActivityProvider super( from: null, argument: null, + retry: null, name: r'activityProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart index 9581f6014..c3bd25059 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -24,6 +24,7 @@ final class ActivityProvider super( from: null, argument: null, + retry: null, name: r'activityProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart index aef5ca20d..df778ce92 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -24,6 +24,7 @@ final class ActivityProvider super( from: null, argument: null, + retry: null, name: r'activityProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart index aaa83a740..127c57c1a 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -44,6 +44,7 @@ final class ActivityProvider super( from: null, argument: null, + retry: null, name: r'activityProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index b88dde802..35ce3eec9 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -25,6 +25,7 @@ final class FetchUserProvider })? create}) : _createCb = create, super( + retry: null, name: r'fetchUserProvider', isAutoDispose: true, dependencies: null, @@ -93,6 +94,7 @@ String _$fetchUserHash() => r'ff427bbb4130a8a6994fa623ae70997f7b0f6bdb'; final class FetchUserFamily extends Family { const FetchUserFamily._() : super( + retry: null, name: r'fetchUserProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart index f996c8037..dacbd45bb 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart @@ -18,6 +18,7 @@ final class ExampleProvider extends $AsyncNotifierProvider { super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart index a85924ca2..9e044bab2 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart @@ -18,6 +18,7 @@ final class ExampleProvider extends $StreamNotifierProvider { super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart index 91b2227ef..45170ea57 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -24,6 +24,7 @@ final class ExampleProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart index 1eaed5598..d565bb46f 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -24,6 +24,7 @@ final class ExampleProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart index 5f74738ac..41638f78b 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -23,6 +23,7 @@ final class Example1Provider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'example1Provider', isAutoDispose: true, dependencies: null, @@ -82,6 +83,7 @@ final class Example2Provider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'example2Provider', isAutoDispose: false, dependencies: null, diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 7a296856f..37d1cc09d 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -24,6 +24,7 @@ final class ExampleProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, @@ -100,6 +101,7 @@ String _$exampleHash() => r'c4f5a651a55bcf34b0c92d98d77436844cbdc097'; final class ExampleFamily extends Family { const ExampleFamily._() : super( + retry: null, name: r'exampleProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index 963928191..7adf9c927 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -23,6 +23,7 @@ final class ExampleProvider extends $NotifierProvider { Example Function()? create}) : _createCb = create, super( + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, @@ -106,6 +107,7 @@ String _$exampleHash() => r'8025d93d6f5e9286043b1ce7ae55bead44f30acc'; final class ExampleFamily extends Family { const ExampleFamily._() : super( + retry: null, name: r'exampleProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index 461b3df04..261ea5829 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -29,6 +29,7 @@ final class ExampleProvider extends $FunctionalProvider })? create}) : _createCb = create, super( + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, @@ -114,6 +115,7 @@ String _$exampleHash() => r'9c32e94eea83a436746088de51e6426f251b2190'; final class ExampleFamily extends Family { const ExampleFamily._() : super( + retry: null, name: r'exampleProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart index ed3932ac4..667033101 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart @@ -18,6 +18,7 @@ final class ExampleProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart index c765c99fc..95a8f5e82 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -23,6 +23,7 @@ final class ExampleProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart index 4d34ff6f9..42f2e78d3 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -23,6 +23,7 @@ final class SearchProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'searchProvider', isAutoDispose: true, dependencies: null, @@ -85,6 +86,7 @@ final class ConfigsProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'configsProvider', isAutoDispose: true, dependencies: null, @@ -140,6 +142,7 @@ final class CharactersProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'charactersProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart index a7a071efe..730fd5cb5 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -23,6 +23,7 @@ final class CityProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'cityProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart index b0b793401..853d26933 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -23,6 +23,7 @@ final class FilterProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'filterProvider', isAutoDispose: true, dependencies: null, @@ -83,6 +84,7 @@ final class FilteredTodoListProvider super( from: null, argument: null, + retry: null, name: r'filteredTodoListProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart index 0123f0ce2..4b37b373a 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -23,6 +23,7 @@ final class AnotherProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'anotherProvider', isAutoDispose: true, dependencies: null, @@ -82,6 +83,7 @@ final class MyProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'myProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart index 147e10802..7fb8dd81b 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -26,6 +26,7 @@ final class ConfigProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'configProvider', isAutoDispose: true, dependencies: null, @@ -81,6 +82,7 @@ final class ProductsProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'productsProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart index ba4c58ad4..e348a795b 100644 --- a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart @@ -18,6 +18,7 @@ final class TodoListProvider extends $NotifierProvider> { super( from: null, argument: null, + retry: null, name: r'todoListProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart index 4713ee02c..32ac94816 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -23,6 +23,7 @@ final class CityProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'cityProvider', isAutoDispose: true, dependencies: null, @@ -83,6 +84,7 @@ final class WeatherProvider super( from: null, argument: null, + retry: null, name: r'weatherProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart index 53612e54e..b34376210 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -26,6 +26,7 @@ final class ConfigProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'configProvider', isAutoDispose: true, dependencies: null, @@ -81,6 +82,7 @@ final class ProductsProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'productsProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart index aca468f3b..24597d983 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart @@ -24,6 +24,7 @@ final class ExampleProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart index 0a10a1b81..1478a2bd2 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart @@ -23,6 +23,7 @@ final class MyProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'myProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart index bcff72444..b3c4216c7 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart @@ -23,6 +23,7 @@ final class CityProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'cityProvider', isAutoDispose: true, dependencies: null, @@ -82,6 +83,7 @@ final class CountryProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'countryProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/reading/counter/codegen.g.dart b/website/docs/concepts/reading/counter/codegen.g.dart index 9dafc37bf..862a2f9e3 100644 --- a/website/docs/concepts/reading/counter/codegen.g.dart +++ b/website/docs/concepts/reading/counter/codegen.g.dart @@ -24,6 +24,7 @@ final class RepositoryProvider super( from: null, argument: null, + retry: null, name: r'repositoryProvider', isAutoDispose: true, dependencies: null, @@ -78,6 +79,7 @@ final class CounterProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'counterProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/reading/listen/codegen.g.dart b/website/docs/concepts/reading/listen/codegen.g.dart index cc31620cc..18edca4f4 100644 --- a/website/docs/concepts/reading/listen/codegen.g.dart +++ b/website/docs/concepts/reading/listen/codegen.g.dart @@ -23,6 +23,7 @@ final class AnotherProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'anotherProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/reading/listen_build/codegen.g.dart b/website/docs/concepts/reading/listen_build/codegen.g.dart index 82e3d501c..cca0f2498 100644 --- a/website/docs/concepts/reading/listen_build/codegen.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen.g.dart @@ -18,6 +18,7 @@ final class CounterProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'counterProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart index 1d0961dfa..37350b911 100644 --- a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart @@ -18,6 +18,7 @@ final class CounterProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'counterProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/reading/provider/codegen.g.dart b/website/docs/concepts/reading/provider/codegen.g.dart index 3c1c9ffa9..5a44b7459 100644 --- a/website/docs/concepts/reading/provider/codegen.g.dart +++ b/website/docs/concepts/reading/provider/codegen.g.dart @@ -24,6 +24,7 @@ final class RepositoryProvider super( from: null, argument: null, + retry: null, name: r'repositoryProvider', isAutoDispose: true, dependencies: null, @@ -83,6 +84,7 @@ final class ValueProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'valueProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/reading/read/codegen.g.dart b/website/docs/concepts/reading/read/codegen.g.dart index 881b5249c..afde0445a 100644 --- a/website/docs/concepts/reading/read/codegen.g.dart +++ b/website/docs/concepts/reading/read/codegen.g.dart @@ -18,6 +18,7 @@ final class CounterProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'counterProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/reading/read/codegen_hooks.g.dart b/website/docs/concepts/reading/read/codegen_hooks.g.dart index fe6b3d615..b47bde380 100644 --- a/website/docs/concepts/reading/read/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/read/codegen_hooks.g.dart @@ -18,6 +18,7 @@ final class CounterProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'counterProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/reading/read_build/codegen.g.dart b/website/docs/concepts/reading/read_build/codegen.g.dart index 881b5249c..afde0445a 100644 --- a/website/docs/concepts/reading/read_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_build/codegen.g.dart @@ -18,6 +18,7 @@ final class CounterProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'counterProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart index 881b5249c..afde0445a 100644 --- a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart @@ -18,6 +18,7 @@ final class CounterProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'counterProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/reading/watch/codegen.g.dart b/website/docs/concepts/reading/watch/codegen.g.dart index 2a1f73ce1..a24d2c9f7 100644 --- a/website/docs/concepts/reading/watch/codegen.g.dart +++ b/website/docs/concepts/reading/watch/codegen.g.dart @@ -24,6 +24,7 @@ final class FilterTypeProvider super( from: null, argument: null, + retry: null, name: r'filterTypeProvider', isAutoDispose: true, dependencies: null, @@ -78,6 +79,7 @@ final class TodosProvider extends $NotifierProvider> { super( from: null, argument: null, + retry: null, name: r'todosProvider', isAutoDispose: true, dependencies: null, @@ -152,6 +154,7 @@ final class FilteredTodoListProvider super( from: null, argument: null, + retry: null, name: r'filteredTodoListProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/reading/watch_build/codegen.g.dart b/website/docs/concepts/reading/watch_build/codegen.g.dart index 38d3c5550..9c9fc7911 100644 --- a/website/docs/concepts/reading/watch_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen.g.dart @@ -18,6 +18,7 @@ final class TodoListProvider extends $NotifierProvider> { super( from: null, argument: null, + retry: null, name: r'todoListProvider', isAutoDispose: true, dependencies: null, @@ -91,6 +92,7 @@ final class CounterProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'counterProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart index d40df19a7..3a2f0b18c 100644 --- a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart @@ -18,6 +18,7 @@ final class TodoListProvider extends $NotifierProvider> { super( from: null, argument: null, + retry: null, name: r'todoListProvider', isAutoDispose: true, dependencies: null, @@ -91,6 +92,7 @@ final class CounterProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'counterProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart index 881b5249c..afde0445a 100644 --- a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart @@ -18,6 +18,7 @@ final class CounterProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'counterProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/concepts/why_immutability/codegen.g.dart b/website/docs/concepts/why_immutability/codegen.g.dart index 475118f0d..b73742a3e 100644 --- a/website/docs/concepts/why_immutability/codegen.g.dart +++ b/website/docs/concepts/why_immutability/codegen.g.dart @@ -19,6 +19,7 @@ final class ThemeNotifierProvider super( from: null, argument: null, + retry: null, name: r'themeNotifierProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart index 40d68df62..00844f23c 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -24,6 +24,7 @@ final class ExampleProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart index c648c1a45..cf88fefa9 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -23,6 +23,7 @@ final class ExampleProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: false, dependencies: null, diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index 31089b0e5..875115020 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -24,6 +24,7 @@ final class LabelProvider extends $FunctionalProvider )? create}) : _createCb = create, super( + retry: null, name: r'labelProvider', isAutoDispose: true, dependencies: null, @@ -100,6 +101,7 @@ String _$labelHash() => r'20aa8ce0231205540f466f91259732bd86953c64'; final class LabelFamily extends Family { const LabelFamily._() : super( + retry: null, name: r'labelProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart index 5f3a37cd0..4a1969448 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -24,6 +24,7 @@ final class ExampleProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart index b9f105c59..2b3a36b69 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -23,6 +23,7 @@ final class OtherProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'otherProvider', isAutoDispose: true, dependencies: null, @@ -83,6 +84,7 @@ final class ExampleProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart index 720bf282b..fa3bc6d72 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart @@ -23,6 +23,7 @@ final class OtherProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'otherProvider', isAutoDispose: true, dependencies: null, @@ -82,6 +83,7 @@ final class ExampleProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart index 5b473f416..164310b3c 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart @@ -23,6 +23,7 @@ final class OtherProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'otherProvider', isAutoDispose: true, dependencies: null, @@ -82,6 +83,7 @@ final class ExampleProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart index 0a59e96ad..04806fe6d 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -23,6 +23,7 @@ final class OtherProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'otherProvider', isAutoDispose: true, dependencies: null, @@ -77,6 +78,7 @@ final class ExampleProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/combining_requests/read_example/codegen.g.dart b/website/docs/essentials/combining_requests/read_example/codegen.g.dart index 9ff8950cc..21ea570da 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.g.dart @@ -23,6 +23,7 @@ final class OtherProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'otherProvider', isAutoDispose: true, dependencies: null, @@ -77,6 +78,7 @@ final class MyNotifierProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'myNotifierProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart index 3889af056..f2c48aa58 100644 --- a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart @@ -27,6 +27,7 @@ final class LocationProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'locationProvider', isAutoDispose: true, dependencies: null, @@ -82,6 +83,7 @@ final class RestaurantsNearMeProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'restaurantsNearMeProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart index 5ba090e2d..88dd570d3 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart @@ -23,6 +23,7 @@ final class OtherProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'otherProvider', isAutoDispose: true, dependencies: null, @@ -82,6 +83,7 @@ final class ExampleProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, @@ -136,6 +138,7 @@ final class MyNotifierProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'myNotifierProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart index 9247cd8a0..4eaf1bcf3 100644 --- a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart +++ b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart @@ -24,6 +24,7 @@ final class ExampleProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/first_request/codegen/provider.g.dart b/website/docs/essentials/first_request/codegen/provider.g.dart index 5eb695efe..466fbdd3f 100644 --- a/website/docs/essentials/first_request/codegen/provider.g.dart +++ b/website/docs/essentials/first_request/codegen/provider.g.dart @@ -36,6 +36,7 @@ final class ActivityProvider super( from: null, argument: null, + retry: null, name: r'activityProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/passing_args/family/codegen.g.dart b/website/docs/essentials/passing_args/family/codegen.g.dart index 01bb58677..46a54342a 100644 --- a/website/docs/essentials/passing_args/family/codegen.g.dart +++ b/website/docs/essentials/passing_args/family/codegen.g.dart @@ -25,6 +25,7 @@ final class ActivityProvider )? create}) : _createCb = create, super( + retry: null, name: r'activityProvider', isAutoDispose: true, dependencies: null, @@ -93,6 +94,7 @@ String _$activityHash() => r'cb76e67cd45f1823d3ed497a235be53819ce2eaf'; final class ActivityFamily extends Family { const ActivityFamily._() : super( + retry: null, name: r'activityProvider', dependencies: null, allTransitiveDependencies: null, @@ -144,6 +146,7 @@ final class ActivityNotifier2Provider ActivityNotifier2 Function()? create}) : _createCb = create, super( + retry: null, name: r'activityNotifier2Provider', isAutoDispose: true, dependencies: null, @@ -213,6 +216,7 @@ String _$activityNotifier2Hash() => r'9e67c655d53a9f98c3b012a0534421385dde0339'; final class ActivityNotifier2Family extends Family { const ActivityNotifier2Family._() : super( + retry: null, name: r'activityNotifier2Provider', dependencies: null, allTransitiveDependencies: null, diff --git a/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart b/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart index bc3d1dcf9..56192f6e8 100644 --- a/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart +++ b/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart @@ -24,6 +24,7 @@ final class ActivityProvider super( from: null, argument: null, + retry: null, name: r'activityProvider', isAutoDispose: true, dependencies: null, @@ -71,6 +72,7 @@ final class ActivityNotifier2Provider super( from: null, argument: null, + retry: null, name: r'activityNotifier2Provider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart index 0e519aeaa..4e3b431dd 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -34,6 +34,7 @@ final class TodoListProvider super( from: null, argument: null, + retry: null, name: r'todoListProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart index ddf51af2b..e42591301 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -19,6 +19,7 @@ final class TodoListProvider super( from: null, argument: null, + retry: null, name: r'todoListProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart index 69dd50b2b..811989448 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -24,6 +24,7 @@ final class TodoListProvider super( from: null, argument: null, + retry: null, name: r'todoListProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/testing/notifier_mock/codegen.g.dart b/website/docs/essentials/testing/notifier_mock/codegen.g.dart index bb8a55697..860998b23 100644 --- a/website/docs/essentials/testing/notifier_mock/codegen.g.dart +++ b/website/docs/essentials/testing/notifier_mock/codegen.g.dart @@ -18,6 +18,7 @@ final class MyNotifierProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'myNotifierProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart index 9247cd8a0..4eaf1bcf3 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart @@ -24,6 +24,7 @@ final class ExampleProvider super( from: null, argument: null, + retry: null, name: r'exampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart index 252da5c7b..f54e1dfc4 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -36,6 +36,7 @@ final class MyListenableProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'myListenableProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/websockets_sync/raw_usage.g.dart b/website/docs/essentials/websockets_sync/raw_usage.g.dart index 2abb6e174..b184bb7e5 100644 --- a/website/docs/essentials/websockets_sync/raw_usage.g.dart +++ b/website/docs/essentials/websockets_sync/raw_usage.g.dart @@ -24,6 +24,7 @@ final class RawStreamProvider super( from: null, argument: null, + retry: null, name: r'rawStreamProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart index b238ebb66..55e808c20 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -24,6 +24,7 @@ final class MyListenableProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'myListenableProvider', isAutoDispose: true, dependencies: null, @@ -85,6 +86,7 @@ final class AnotherListenableProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'anotherListenableProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart index a15bce177..6306dcf86 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -24,6 +24,7 @@ final class StreamExampleProvider super( from: null, argument: null, + retry: null, name: r'streamExampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart index 9d76fdbb8..a16299830 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -23,6 +23,7 @@ final class SynchronousExampleProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'synchronousExampleProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index 064167f16..4e89b9640 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -29,6 +29,7 @@ final class RandomProvider extends $FunctionalProvider })? create}) : _createCb = create, super( + retry: null, name: r'randomProvider', isAutoDispose: true, dependencies: null, @@ -114,6 +115,7 @@ String _$randomHash() => r'517b12aad4df7b31f8872b89af74e7880377b2ea'; final class RandomFamily extends Family { const RandomFamily._() : super( + retry: null, name: r'randomProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/website/docs/from_provider/motivation/async_values/async_values.g.dart b/website/docs/from_provider/motivation/async_values/async_values.g.dart index 7f7ac9ac7..bb9202a05 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.g.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.g.dart @@ -24,6 +24,7 @@ final class ItemsApiProvider super( from: null, argument: null, + retry: null, name: r'itemsApiProvider', isAutoDispose: true, dependencies: null, @@ -76,6 +77,7 @@ final class EvenItemsProvider super( from: null, argument: null, + retry: null, name: r'evenItemsProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart index f41b8a2eb..47fdddd7f 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -23,6 +23,7 @@ final class DiceRollProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'diceRollProvider', isAutoDispose: true, dependencies: null, @@ -82,6 +83,7 @@ final class CachedDiceRollProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'cachedDiceRollProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/from_provider/motivation/combine/combine.g.dart b/website/docs/from_provider/motivation/combine/combine.g.dart index 24857d12f..1c8a14477 100644 --- a/website/docs/from_provider/motivation/combine/combine.g.dart +++ b/website/docs/from_provider/motivation/combine/combine.g.dart @@ -23,6 +23,7 @@ final class NumberProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'numberProvider', isAutoDispose: true, dependencies: null, @@ -82,6 +83,7 @@ final class DoubledProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'doubledProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/from_provider/motivation/same_type/same_type.g.dart b/website/docs/from_provider/motivation/same_type/same_type.g.dart index efc4eeed9..2d52f8876 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.g.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.g.dart @@ -23,6 +23,7 @@ final class ItemsProvider extends $FunctionalProvider, List> super( from: null, argument: null, + retry: null, name: r'itemsProvider', isAutoDispose: true, dependencies: null, @@ -83,6 +84,7 @@ final class EvenItemsProvider super( from: null, argument: null, + retry: null, name: r'evenItemsProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart index 56da860ef..82564d247 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart @@ -23,6 +23,7 @@ final class HelloWorldProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'helloWorldProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart index 56da860ef..82564d247 100644 --- a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -23,6 +23,7 @@ final class HelloWorldProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'helloWorldProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/introduction/getting_started/hello_world/main.g.dart b/website/docs/introduction/getting_started/hello_world/main.g.dart index 56da860ef..82564d247 100644 --- a/website/docs/introduction/getting_started/hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/main.g.dart @@ -23,6 +23,7 @@ final class HelloWorldProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'helloWorldProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index c38aa9c43..e30a97e36 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -32,6 +32,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< })? create}) : _createCb = create, super( + retry: null, name: r'fetchPackagesProvider', isAutoDispose: true, dependencies: null, @@ -110,6 +111,7 @@ String _$fetchPackagesHash() => r'eebf7d838a57f493fffebfd2c8d8ab76d3233165'; final class FetchPackagesFamily extends Family { const FetchPackagesFamily._() : super( + retry: null, name: r'fetchPackagesProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart index d2ad608bb..e71a9d949 100644 --- a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart +++ b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart @@ -19,6 +19,7 @@ final class MyNotifierProvider super( from: null, argument: null, + retry: null, name: r'myNotifierProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart index e90ca97c4..474896c77 100644 --- a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart +++ b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart @@ -19,6 +19,7 @@ final class MyNotifierProvider super( from: null, argument: null, + retry: null, name: r'myNotifierProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart index 4fb397aa3..9fa60b6d3 100644 --- a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart +++ b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart @@ -19,6 +19,7 @@ final class MyNotifierProvider super( from: null, argument: null, + retry: null, name: r'myNotifierProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart index 5c74f4073..783472ad4 100644 --- a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart +++ b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -18,6 +18,7 @@ final class MyNotifierProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'myNotifierProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart index d4cbac605..7ae0b4412 100644 --- a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart +++ b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -19,6 +19,7 @@ final class AsyncTodosNotifierProvider super( from: null, argument: null, + retry: null, name: r'asyncTodosNotifierProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart index 24ec881fd..d2c67e60e 100644 --- a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart +++ b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart @@ -19,6 +19,7 @@ final class CounterNotifierProvider super( from: null, argument: null, + retry: null, name: r'counterNotifierProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index f07aa01a6..af2146920 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -24,6 +24,7 @@ final class TaskTrackerProvider super( from: null, argument: null, + retry: null, name: r'taskTrackerProvider', isAutoDispose: true, dependencies: null, @@ -80,6 +81,7 @@ final class BugsEncounteredNotifierProvider BugsEncounteredNotifier Function()? create}) : _createCb = create, super( + retry: null, name: r'bugsEncounteredNotifierProvider', isAutoDispose: true, dependencies: null, @@ -152,6 +154,7 @@ String _$bugsEncounteredNotifierHash() => final class BugsEncounteredNotifierFamily extends Family { const BugsEncounteredNotifierFamily._() : super( + retry: null, name: r'bugsEncounteredNotifierProvider', dependencies: null, allTransitiveDependencies: null, diff --git a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart index 641c46461..fd51f4c27 100644 --- a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart +++ b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -19,6 +19,7 @@ final class CounterNotifierProvider super( from: null, argument: null, + retry: null, name: r'counterNotifierProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart index 33760654e..77786bd38 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -18,6 +18,7 @@ final class MyNotifierProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'myNotifierProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart index 6f98f75ea..d1bbb1248 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -23,6 +23,7 @@ final class DurationProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'durationProvider', isAutoDispose: true, dependencies: null, @@ -82,6 +83,7 @@ final class RepositoryProvider extends $FunctionalProvider<_MyRepo, _MyRepo> super( from: null, argument: null, + retry: null, name: r'repositoryProvider', isAutoDispose: true, dependencies: null, @@ -136,6 +138,7 @@ final class MyNotifierProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'myNotifierProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/providers/future_provider/config_provider/codegen.g.dart b/website/docs/providers/future_provider/config_provider/codegen.g.dart index cb4e4bf72..552b84192 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.g.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.g.dart @@ -26,6 +26,7 @@ final class FetchConfigurationProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'fetchConfigurationProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart index 57c8b0876..89721667f 100644 --- a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart @@ -36,6 +36,7 @@ final class AsyncTodosProvider super( from: null, argument: null, + retry: null, name: r'asyncTodosProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/providers/notifier_provider/todos/codegen.g.dart b/website/docs/providers/notifier_provider/todos/codegen.g.dart index 2998db847..2cd348c1d 100644 --- a/website/docs/providers/notifier_provider/todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/todos/codegen.g.dart @@ -18,6 +18,7 @@ final class TodosProvider extends $NotifierProvider> { super( from: null, argument: null, + retry: null, name: r'todosProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/providers/provider/completed_todos/completed_todos.g.dart b/website/docs/providers/provider/completed_todos/completed_todos.g.dart index 4e2282ab4..707b10a68 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.g.dart @@ -24,6 +24,7 @@ final class CompletedTodosProvider super( from: null, argument: null, + retry: null, name: r'completedTodosProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index 8e2628485..c64586e3f 100644 --- a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -18,6 +18,7 @@ final class PageIndexProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'pageIndexProvider', isAutoDispose: true, dependencies: null, @@ -91,6 +92,7 @@ final class CanGoToPreviousPageProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'canGoToPreviousPageProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/providers/provider/todo/todo.g.dart b/website/docs/providers/provider/todo/todo.g.dart index 481c5f893..fde860cf8 100644 --- a/website/docs/providers/provider/todo/todo.g.dart +++ b/website/docs/providers/provider/todo/todo.g.dart @@ -18,6 +18,7 @@ final class TodosProvider extends $NotifierProvider> { super( from: null, argument: null, + retry: null, name: r'todosProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart index a88febd27..ae755d0cd 100644 --- a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart +++ b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -18,6 +18,7 @@ final class PageIndexProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'pageIndexProvider', isAutoDispose: true, dependencies: null, diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart index 77c926ef8..4a02bafb4 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -24,6 +24,7 @@ final class ChatProvider super( from: null, argument: null, + retry: null, name: r'chatProvider', isAutoDispose: true, dependencies: null, diff --git a/website/static/snippets/async.g.dart b/website/static/snippets/async.g.dart index 3860c3c0d..b34a4deb5 100644 --- a/website/static/snippets/async.g.dart +++ b/website/static/snippets/async.g.dart @@ -26,6 +26,7 @@ final class ConfigurationsProvider extends $FunctionalProvider< super( from: null, argument: null, + retry: null, name: r'configurationsProvider', isAutoDispose: true, dependencies: null, diff --git a/website/static/snippets/combine.g.dart b/website/static/snippets/combine.g.dart index 2218f9e04..f63fa7d0e 100644 --- a/website/static/snippets/combine.g.dart +++ b/website/static/snippets/combine.g.dart @@ -23,6 +23,7 @@ final class TodosProvider extends $FunctionalProvider, List> super( from: null, argument: null, + retry: null, name: r'todosProvider', isAutoDispose: true, dependencies: null, @@ -82,6 +83,7 @@ final class FilterProvider extends $FunctionalProvider super( from: null, argument: null, + retry: null, name: r'filterProvider', isAutoDispose: true, dependencies: null, @@ -142,6 +144,7 @@ final class FilteredTodosProvider super( from: null, argument: null, + retry: null, name: r'filteredTodosProvider', isAutoDispose: true, dependencies: null, diff --git a/website/static/snippets/create.g.dart b/website/static/snippets/create.g.dart index 5165235ea..911f4a399 100644 --- a/website/static/snippets/create.g.dart +++ b/website/static/snippets/create.g.dart @@ -24,6 +24,7 @@ final class BoredSuggestionProvider super( from: null, argument: null, + retry: null, name: r'boredSuggestionProvider', isAutoDispose: true, dependencies: null, diff --git a/website/static/snippets/declare.g.dart b/website/static/snippets/declare.g.dart index 857d151a3..f17d4b939 100644 --- a/website/static/snippets/declare.g.dart +++ b/website/static/snippets/declare.g.dart @@ -18,6 +18,7 @@ final class CountProvider extends $NotifierProvider { super( from: null, argument: null, + retry: null, name: r'countProvider', isAutoDispose: true, dependencies: null, From 5912fdb693003458618c3441a756713efbb2c1e9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 19 Jun 2024 13:49:46 +0200 Subject: [PATCH 325/387] Fix CI --- packages/riverpod/lib/src/core/provider_container.dart | 4 ++-- packages/riverpod/test/meta_test.dart | 3 +-- .../lib/src/nodes/dependencies.dart | 10 +++++----- .../lib/src/nodes/provider_for.dart | 2 +- .../lib/src/nodes/riverpod.dart | 4 ++-- .../lib/src/nodes/scopes/overrides.dart | 2 +- .../test/nodes/providers/generated_providers_test.dart | 5 ++--- 7 files changed, 14 insertions(+), 16 deletions(-) diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 4f1fe72b4..18ab9ef90 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -487,7 +487,7 @@ class ProviderPointerManager { final _familyPointers = familyPointers[family]; if (_familyPointers == null) return const []; - return _familyPointers.pointers.values.map((e) => e.element).whereNotNull(); + return _familyPointers.pointers.values.map((e) => e.element).nonNulls; } /// Remove a provider from this container. @@ -960,7 +960,7 @@ class ProviderContainer implements WrappedNode { return _pointerManager .listProviderPointers() .map((e) => e.element) - .whereNotNull() + .nonNulls .where((e) => e.container == this); } diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index 5f4e37176..d134387af 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -3,7 +3,6 @@ import 'package:analyzer/dart/analysis/utilities.dart'; import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/dart/element/type.dart'; import 'package:analyzer/dart/element/visitor.dart'; -import 'package:collection/collection.dart'; import 'package:path/path.dart' as path; import 'package:test/test.dart'; @@ -199,7 +198,7 @@ class _PublicAPIVisitor extends GeneralizingElementVisitor { return e.getSetter(element.name); } }) - .whereNotNull() + .nonNulls .toList(); if (overrides.isEmpty) return; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart index d88ba8c15..7823c1d3a 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart @@ -172,7 +172,7 @@ extension on DartObject { } final values = - list.map((e) => e.toDependency(from: from)).whereNotNull().toList(); + list.map((e) => e.toDependency(from: from)).nonNulls.toList(); // If any dependency failed to parse, return null. // Errors should already have been reported @@ -200,7 +200,7 @@ final class AccumulatedDependencyList { required this.overrides, }) : parent = node.ancestors .map((e) => e.accumulatedDependencies) - .whereNotNull() + .nonNulls .firstOrNull; final AstNode node; @@ -261,7 +261,7 @@ final class AccumulatedDependencyList { // safe to use. .where((e) => e.familyArguments == null) .map((e) => e.provider?.providerElement) - .whereNotNull() + .nonNulls .toSet(); bool isSafelyAccessibleAfterOverrides( @@ -391,7 +391,7 @@ extension NamedTypeDependenciesX on NamedType { extension DependenciesAnnotatedAnnotatedNodeOfX on AnnotatedNode { DependenciesAnnotation? get dependencies { return upsert('DependenciesAnnotationAnnotatedNodeX', () { - return metadata.map((e) => e.dependencies).whereNotNull().firstOrNull; + return metadata.map((e) => e.dependencies).nonNulls.firstOrNull; }); } } @@ -475,7 +475,7 @@ final class DependenciesAnnotationElement { } static DependenciesAnnotationElement? _of(Element element) { - return element.metadata.map(_parse).whereNotNull().firstOrNull; + return element.metadata.map(_parse).nonNulls.firstOrNull; } final ElementAnnotation element; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/provider_for.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/provider_for.dart index 5749d880b..b1e23b3a5 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/provider_for.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/provider_for.dart @@ -18,6 +18,6 @@ part of '../nodes.dart'; (ProviderDeclarationElement?,)? parseFirstProviderFor(Element annotation) { return annotation.metadata .map((e) => parseProviderFor(e, from: annotation)) - .whereNotNull() + .nonNulls .firstOrNull; } diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart index 5b646367a..a8422abc3 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart @@ -3,7 +3,7 @@ part of '../nodes.dart'; extension RiverpodAnnotatedAnnotatedNodeOfX on AnnotatedNode { RiverpodAnnotation? get riverpod { return upsert('RiverpodAnnotationAnnotatedNodeX', () { - return metadata.map((e) => e.riverpod).whereNotNull().firstOrNull; + return metadata.map((e) => e.riverpod).nonNulls.firstOrNull; }); } } @@ -105,7 +105,7 @@ final class RiverpodAnnotationElement { } static RiverpodAnnotationElement? _of(Element element) { - return element.metadata.map(_parse).whereNotNull().firstOrNull; + return element.metadata.map(_parse).nonNulls.firstOrNull; } final bool keepAlive; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/overrides.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/overrides.dart index ec9500451..9c729153f 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/overrides.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/overrides.dart @@ -55,7 +55,7 @@ extension ProviderOverrideListX on Expression { if (expression is ListLiteral) { overrides = expression.elements .map((e) => e.providerOverride) - .whereNotNull() + .nonNulls .toList(); } diff --git a/packages/riverpod_analyzer_utils_tests/test/nodes/providers/generated_providers_test.dart b/packages/riverpod_analyzer_utils_tests/test/nodes/providers/generated_providers_test.dart index 764df0cdc..e18371f3b 100644 --- a/packages/riverpod_analyzer_utils_tests/test/nodes/providers/generated_providers_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/nodes/providers/generated_providers_test.dart @@ -1,5 +1,4 @@ import 'package:analyzer/dart/ast/ast.dart'; -import 'package:collection/collection.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import 'package:test/test.dart'; @@ -187,7 +186,7 @@ class KeepAliveNotifier extends _$KeepAliveNotifier { } ''', (resolver, unit, units) async { final providers = - unit.declarations.map((e) => e.provider).whereNotNull().toList(); + unit.declarations.map((e) => e.provider).nonNulls.toList(); final autoDispose = providers.takeAll([ 'autoDispose', @@ -291,7 +290,7 @@ class FamilyClass extends _$FamilyClass { } ''', (resolver, unit, units) async { final providers = - unit.declarations.map((e) => e.provider).whereNotNull().toList(); + unit.declarations.map((e) => e.provider).nonNulls.toList(); final roots = providers.takeAll([ 'root', From 0ff9c5af077ba77b2b2fe50104e5f7f1d7255e58 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 19 Jun 2024 16:05:14 +0200 Subject: [PATCH 326/387] Fix depreciation --- .../lib/src/assists/convert_to_stateful_base_widget.dart | 5 ++--- packages/riverpod_lint/pubspec.yaml | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart index 6b609d776..cfe46435f 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart @@ -2,9 +2,8 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/dart/ast/token.dart'; import 'package:analyzer/dart/ast/visitor.dart'; import 'package:analyzer/dart/element/element.dart'; +import 'package:analyzer/source/source.dart'; import 'package:analyzer/source/source_range.dart'; -// ignore: implementation_imports, https://github.com/dart-lang/sdk/issues/54480 -import 'package:analyzer/src/generated/source.dart' show Source; import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart'; import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; @@ -232,7 +231,7 @@ class $createdStateClassName extends $baseStateName<${widgetClass.name}> { } } -// Original implemenation in +// Original implementation in // package:analysis_server/lib/src/services/correction/dart/flutter_convert_to_stateful_widget.dart class _FieldFinder extends RecursiveAstVisitor { Set fieldsAssignedInConstructors = {}; diff --git a/packages/riverpod_lint/pubspec.yaml b/packages/riverpod_lint/pubspec.yaml index 877e860dd..500a1ccd0 100644 --- a/packages/riverpod_lint/pubspec.yaml +++ b/packages/riverpod_lint/pubspec.yaml @@ -11,7 +11,7 @@ environment: sdk: ">=3.0.0<4.0.0" dependencies: - analyzer: ^6.5.0 + analyzer: ^6.6.0 analyzer_plugin: ^0.11.2 collection: ^1.16.0 custom_lint_builder: ^0.6.4 From 18165b8c4bdf3a3e71a6c8c6878aa2e8d8781ebd Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 19 Jun 2024 16:05:33 +0200 Subject: [PATCH 327/387] More --- .../lib/src/assists/convert_to_stateless_base_widget.dart | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart index 82db951ac..321369c4a 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart @@ -2,9 +2,8 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/dart/ast/token.dart'; import 'package:analyzer/dart/ast/visitor.dart'; import 'package:analyzer/dart/element/element.dart'; +import 'package:analyzer/source/source.dart'; import 'package:analyzer/source/source_range.dart'; -// ignore: implementation_imports, blocked by https://github.com/dart-lang/sdk/issues/54480 -import 'package:analyzer/src/generated/source.dart' show Source; import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; From be9da02fd5da5968ed131e8d074f6cc16834b3d8 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 19 Jun 2024 16:22:58 +0200 Subject: [PATCH 328/387] Fix test --- packages/riverpod/lib/src/core/element.dart | 3 +++ 1 file changed, 3 insertions(+) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 3eb38db0d..579835ffb 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -434,6 +434,9 @@ This could mean a few things: @protected void triggerRetry(Object error) { + // Don't start retry if the provider was disposed + if (ref == null) return; + final retry = origin.retry ?? container.retry ?? _defaultRetry; // Capture exceptions. On error, stop retrying if the retry From 855a748b64ae3b3cb64f0d06dd49671ff9d35b6a Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 22 Jun 2024 05:12:58 +0200 Subject: [PATCH 329/387] Add AsyncValue.progress --- packages/riverpod/CHANGELOG.md | 2 + .../riverpod/lib/src/core/async_value.dart | 54 ++++++- .../test/src/core/async_value_test.dart | 153 ++++++++++++------ .../src/providers/future_provider_test.dart | 22 +++ 4 files changed, 179 insertions(+), 52 deletions(-) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index a8e450290..f448a0210 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -19,6 +19,8 @@ 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. +- `AsyncValue` now has an optional `progress` field. + This can be set by providers to allow the UI to show a custom progress logic. - 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/src/core/async_value.dart b/packages/riverpod/lib/src/core/async_value.dart index fdba00e73..11286b388 100644 --- a/packages/riverpod/lib/src/core/async_value.dart +++ b/packages/riverpod/lib/src/core/async_value.dart @@ -77,7 +77,7 @@ sealed class AsyncValue { /// Prefer always using this constructor with the `const` keyword. /// {@endtemplate} // coverage:ignore-start - const factory AsyncValue.loading() = AsyncLoading; + const factory AsyncValue.loading({num progress}) = AsyncLoading; // coverage:ignore-end /// {@template async_value.error_ctor} @@ -176,6 +176,16 @@ sealed class AsyncValue { /// to also be true. bool get hasValue; + /// The current progress of the asynchronous operation. + /// + /// `null` if [isLoading] is false. + /// This value must be between 0 and 1. + /// + /// When a provider starts an async operation, the progress is set to `0`. + /// As the operation progresses, the provider should update the progress. + /// This can be done with `AsyncLoading(progress: 0.5)`. + num? get progress; + /// The value currently exposed. /// /// If currently in error/loading state, will return the previous value. @@ -293,6 +303,7 @@ sealed class AsyncValue { isLoading: d.isLoading, error: d.error, stackTrace: d.stackTrace, + progress: d.progress, ); } catch (err, stack) { return AsyncError._( @@ -301,6 +312,7 @@ sealed class AsyncValue { isLoading: d.isLoading, value: null, hasValue: false, + progress: d.progress, ); } }, @@ -310,8 +322,9 @@ sealed class AsyncValue { isLoading: e.isLoading, value: null, hasValue: false, + progress: e.progress, ), - loading: (l) => AsyncLoading(), + loading: (l) => AsyncLoading(progress: progress!), ); } @@ -478,14 +491,14 @@ sealed class AsyncValue { AsyncValue unwrapPrevious() { return map( data: (d) { - if (d.isLoading) return AsyncLoading(); + if (d.isLoading) return AsyncLoading(progress: progress!); return AsyncData(d.value); }, error: (e) { - if (e.isLoading) return AsyncLoading(); + if (e.isLoading) return AsyncLoading(progress: progress!); return AsyncError(e.error, e.stackTrace); }, - loading: (l) => AsyncLoading(), + loading: (l) => AsyncLoading(progress: progress!), ); } @@ -493,6 +506,7 @@ sealed class AsyncValue { String toString() { final content = [ if (isLoading && this is! AsyncLoading) 'isLoading: $isLoading', + if (progress case final progress?) 'progress: $progress', if (hasValue) 'value: $value', if (hasError) ...[ 'error: $error', @@ -511,6 +525,7 @@ sealed class AsyncValue { other.hasValue == hasValue && other.error == error && other.stackTrace == stackTrace && + other.progress == progress && other.value == value; } @@ -522,6 +537,7 @@ sealed class AsyncValue { value, error, stackTrace, + progress, ); } @@ -534,6 +550,7 @@ final class AsyncData extends AsyncValue { isLoading: false, error: null, stackTrace: null, + progress: null, ); const AsyncData._( @@ -541,6 +558,7 @@ final class AsyncData extends AsyncValue { required this.isLoading, required this.error, required this.stackTrace, + required this.progress, }) : super._(); @override @@ -549,6 +567,9 @@ final class AsyncData extends AsyncValue { @override bool get hasValue => true; + @override + final num? progress; + @override final StateT value; @@ -587,6 +608,7 @@ final class AsyncData extends AsyncValue { isLoading: isLoading, error: error, stackTrace: stackTrace, + progress: progress, ); } } @@ -594,11 +616,15 @@ final class AsyncData extends AsyncValue { /// {@macro async_value.loading} final class AsyncLoading extends AsyncValue { /// {@macro async_value.loading} - const AsyncLoading() + const AsyncLoading({this.progress = 0}) : hasValue = false, value = null, error = null, stackTrace = null, + assert( + progress >= 0 && progress <= 1, + 'progress must be between 0 and 1', + ), super._(); const AsyncLoading._({ @@ -606,6 +632,7 @@ final class AsyncLoading extends AsyncValue { required this.value, required this.error, required this.stackTrace, + required this.progress, }) : super._(); @override @@ -617,6 +644,9 @@ final class AsyncLoading extends AsyncValue { @override final bool hasValue; + @override + final num progress; + @override final StateT? value; @@ -634,6 +664,7 @@ final class AsyncLoading extends AsyncValue { value: value as R?, error: error, stackTrace: stackTrace, + progress: progress, ); } @@ -658,6 +689,7 @@ final class AsyncLoading extends AsyncValue { isLoading: true, error: d.error, stackTrace: d.stackTrace, + progress: progress, ), error: (e) => AsyncError._( e.error, @@ -665,6 +697,7 @@ final class AsyncLoading extends AsyncValue { value: e.value, stackTrace: e.stackTrace, hasValue: e.hasValue, + progress: progress, ), loading: (_) => this, ); @@ -675,12 +708,14 @@ final class AsyncLoading extends AsyncValue { value: d.value, error: d.error, stackTrace: d.stackTrace, + progress: progress, ), error: (e) => AsyncLoading._( hasValue: e.hasValue, value: e.value, error: e.error, stackTrace: e.stackTrace, + progress: progress, ), loading: (e) => e, ); @@ -698,6 +733,7 @@ final class AsyncError extends AsyncValue { isLoading: false, hasValue: false, value: null, + progress: null, ); const AsyncError._( @@ -706,11 +742,15 @@ final class AsyncError extends AsyncValue { required this.value, required this.hasValue, required this.isLoading, + required this.progress, }) : super._(); @override String get _displayString => 'AsyncError'; + @override + final num? progress; + @override final bool isLoading; @@ -735,6 +775,7 @@ final class AsyncError extends AsyncValue { isLoading: isLoading, value: value as R?, hasValue: hasValue, + progress: progress, ); } @@ -758,6 +799,7 @@ final class AsyncError extends AsyncValue { isLoading: isLoading, value: previous.value, hasValue: previous.hasValue, + progress: progress, ); } } diff --git a/packages/riverpod/test/src/core/async_value_test.dart b/packages/riverpod/test/src/core/async_value_test.dart index 9967be67e..82e3f2a5f 100644 --- a/packages/riverpod/test/src/core/async_value_test.dart +++ b/packages/riverpod/test/src/core/async_value_test.dart @@ -18,21 +18,47 @@ void main() { ); }); + group('progress', () { + test('defaults to 0 on AsyncLoading', () { + expect(const AsyncLoading().progress, 0); + }); + + test('defaults to null on AsyncData/AsyncError', () { + expect(const AsyncData(42).progress, null); + expect(const AsyncError('err', StackTrace.empty).progress, null); + }); + + test('is non-nullable on AsyncLoading', () { + final num progress = const AsyncLoading(progress: .1).progress; + }); + + test('asserts is within bounds', () { + expect( + () => AsyncLoading(progress: -0.1), + throwsA(isA()), + ); + expect( + () => AsyncLoading(progress: 1.1), + throwsA(isA()), + ); + }); + }); + test('unwrapPrevious', () { expect( - const AsyncLoading() + const AsyncLoading(progress: .1) .copyWithPrevious(const AsyncData(42)) .unwrapPrevious(), - const AsyncLoading(), + const AsyncLoading(progress: .1), ); expect( - const AsyncLoading() + const AsyncLoading(progress: .1) .copyWithPrevious(const AsyncError(42, StackTrace.empty)) .unwrapPrevious(), - const AsyncLoading(), + const AsyncLoading(progress: .1), ); expect( - const AsyncLoading() + const AsyncLoading(progress: .1) .copyWithPrevious( const AsyncLoading().copyWithPrevious( const AsyncError('err', StackTrace.empty), @@ -40,12 +66,12 @@ void main() { ), ) .unwrapPrevious(), - const AsyncLoading(), + const AsyncLoading(progress: .1), ); expect( const AsyncData(42) - .copyWithPrevious(const AsyncLoading()) + .copyWithPrevious(const AsyncLoading(progress: .1)) .unwrapPrevious(), const AsyncData(42), ); @@ -79,21 +105,22 @@ void main() { group('copyWithPrevious', () { group('with seamless: false', () { test('with AsyncLoading, is identical to the incoming AsyncLoading', () { - final incomingLoading = const AsyncLoading() + final incomingLoading = const AsyncLoading(progress: .1) .copyWithPrevious(const AsyncData(42), isRefresh: false); - final result = const AsyncLoading() + final result = const AsyncLoading(progress: .1) .copyWithPrevious(incomingLoading, isRefresh: false); expect(result, same(incomingLoading)); }); test('with AsyncData, sets value and hasValue', () { - final result = const AsyncLoading() + final result = const AsyncLoading(progress: .1) .copyWithPrevious(const AsyncData(42), isRefresh: false); expect(result, isA>()); expect(result.hasValue, true); expect(result.value, 42); + expect(result.progress, .1); expect(result.hasError, false); expect(result.error, null); @@ -105,12 +132,13 @@ void main() { () { final error = const AsyncError(Object(), StackTrace.empty) .copyWithPrevious(const AsyncData(42)); - final result = - const AsyncLoading().copyWithPrevious(error, isRefresh: false); + final result = const AsyncLoading(progress: .1) + .copyWithPrevious(error, isRefresh: false); expect(result, isA>()); expect(result.hasValue, true); expect(result.value, 42); + expect(result.progress, .1); expect(result.hasError, true); expect(result.error, const Object()); @@ -162,8 +190,10 @@ void main() { group('on AsyncData', () { test('with AsyncLoading', () { expect( - const AsyncData(42) - .copyWithPrevious(const AsyncLoading(), isRefresh: true), + const AsyncData(42).copyWithPrevious( + const AsyncLoading(progress: .1), + isRefresh: true, + ), const AsyncData(42), ); }); @@ -188,14 +218,14 @@ void main() { group('on AsyncLoading', () { test('with AsyncLoading', () { expect( - const AsyncLoading() - .copyWithPrevious(const AsyncLoading()), - const AsyncLoading(), + const AsyncLoading(progress: .1) + .copyWithPrevious(const AsyncLoading(progress: .2)), + const AsyncLoading(progress: .1), ); }); test('with AsyncError', () { - final value = const AsyncLoading() + final value = const AsyncLoading(progress: .1) .copyWithPrevious(const AsyncError('err', StackTrace.empty)); expect(value, isA>()); @@ -203,18 +233,20 @@ void main() { expect(value.isRefreshing, true); expect(value.hasValue, false); expect(value.value, null); + expect(value.progress, .1); expect(value.error, 'err'); expect(value.stackTrace, StackTrace.empty); }); test('with AsyncError containing previous data', () { - final value = const AsyncLoading().copyWithPrevious( + final value = const AsyncLoading(progress: .1).copyWithPrevious( const AsyncError('err', StackTrace.empty) .copyWithPrevious(const AsyncData(42)), ); expect(value, isA>()); expect(value.isLoading, true); + expect(value.progress, .1); expect(value.isRefreshing, true); expect(value.hasValue, true); expect(value.value, 42); @@ -224,13 +256,13 @@ void main() { test('with refreshing AsyncError containing previous data', () { expect( - const AsyncLoading().copyWithPrevious( - const AsyncLoading().copyWithPrevious( + const AsyncLoading(progress: .1).copyWithPrevious( + const AsyncLoading(progress: .1).copyWithPrevious( const AsyncError('err', StackTrace.empty) .copyWithPrevious(const AsyncData(42)), ), ), - const AsyncLoading().copyWithPrevious( + const AsyncLoading(progress: .1).copyWithPrevious( const AsyncError('err', StackTrace.empty) .copyWithPrevious(const AsyncData(42)), ), @@ -238,11 +270,12 @@ void main() { }); test('with AsyncData', () { - final value = - const AsyncLoading().copyWithPrevious(const AsyncData(42)); + final value = const AsyncLoading(progress: .1) + .copyWithPrevious(const AsyncData(42)); expect(value, isA>()); expect(value.isLoading, true); + expect(value.progress, .1); expect(value.isRefreshing, true); expect(value.hasValue, true); expect(value.value, 42); @@ -251,12 +284,13 @@ void main() { }); test('with refreshing AsyncData', () { - final value = const AsyncLoading().copyWithPrevious( + final value = const AsyncLoading(progress: .1).copyWithPrevious( const AsyncLoading().copyWithPrevious(const AsyncData(42)), ); expect(value, isA>()); expect(value.isLoading, true); + expect(value.progress, .1); expect(value.isRefreshing, true); expect(value.hasValue, true); expect(value.value, 42); @@ -412,12 +446,12 @@ void main() { ); expect( - const AsyncLoading().map( + const AsyncLoading(progress: .1).map( data: (value) => throw Error(), error: (_) => throw Error(), - loading: (AsyncLoading loading) => 'loading', + loading: (AsyncLoading loading) => 'loading ${loading.progress}', ), - 'loading', + 'loading 0.1', ); }); @@ -442,11 +476,11 @@ void main() { ); expect( - const AsyncLoading().maybeMap( - loading: (AsyncLoading loading) => 'loading', + const AsyncLoading(progress: .1).maybeMap( + loading: (AsyncLoading loading) => 'loading ${loading.progress}', orElse: () => throw Error(), ), - 'loading', + 'loading 0.1', ); }); @@ -509,10 +543,10 @@ void main() { ); expect( - const AsyncLoading().mapOrNull( - loading: (AsyncLoading loading) => 'loading', + const AsyncLoading(progress: .1).mapOrNull( + loading: (AsyncLoading loading) => 'loading ${loading.progress}', ), - 'loading', + 'loading 0.1', ); }); @@ -1142,6 +1176,14 @@ void main() { AsyncLoading(), AsyncLoading(), ); + expect( + AsyncLoading(progress: .1), + AsyncLoading(progress: .1), + ); + expect( + AsyncLoading(progress: .1), + isNot(AsyncLoading(progress: .2)), + ); expect( AsyncLoading(), isNot(AsyncValue.loading()), @@ -1234,6 +1276,14 @@ void main() { AsyncLoading().hashCode, AsyncLoading().hashCode, ); + expect( + AsyncLoading(progress: .1).hashCode, + AsyncLoading(progress: .1).hashCode, + ); + expect( + AsyncLoading(progress: .1).hashCode, + isNot(AsyncLoading(progress: .2).hashCode), + ); expect( AsyncLoading().hashCode, isNot(AsyncValue.loading().hashCode), @@ -1310,20 +1360,30 @@ void main() { ); expect( const AsyncLoading().toString(), - 'AsyncLoading()', + 'AsyncLoading(progress: 0)', + ); + expect( + const AsyncLoading(progress: .1).toString(), + 'AsyncLoading(progress: 0.1)', ); expect( const AsyncLoading() .copyWithPrevious(const AsyncData(42)) .toString(), - 'AsyncData(isLoading: true, value: 42)', + 'AsyncData(isLoading: true, progress: 0, value: 42)', + ); + expect( + const AsyncLoading(progress: .1) + .copyWithPrevious(const AsyncData(42)) + .toString(), + 'AsyncData(isLoading: true, progress: 0.1, value: 42)', ); expect( const AsyncLoading() .copyWithPrevious(const AsyncError(42, StackTrace.empty)) .toString(), - 'AsyncError(isLoading: true, error: 42, stackTrace: )', + 'AsyncError(isLoading: true, progress: 0, error: 42, stackTrace: )', ); expect( const AsyncData(42) @@ -1341,7 +1401,7 @@ void main() { const AsyncLoading() .copyWithPrevious(const AsyncData(42), isRefresh: false) .toString(), - 'AsyncLoading(value: 42)', + 'AsyncLoading(progress: 0, value: 42)', ); }); @@ -1401,30 +1461,31 @@ void main() { group('whenData', () { test('preserves isLoading/isRefreshing', () { expect( - const AsyncLoading() + const AsyncLoading(progress: .1) .copyWithPrevious(const AsyncData(42)) .whenData((value) => value * 2), - const AsyncLoading().copyWithPrevious(const AsyncData(84)), + const AsyncLoading(progress: .1) + .copyWithPrevious(const AsyncData(84)), ); expect( - const AsyncLoading() + const AsyncLoading(progress: .1) .copyWithPrevious(const AsyncData(42)) .whenData( (value) => Error.throwWithStackTrace(84, StackTrace.empty), ), - const AsyncLoading().copyWithPrevious( + const AsyncLoading(progress: .1).copyWithPrevious( const AsyncError(84, StackTrace.empty), ), ); expect( - const AsyncLoading() + const AsyncLoading(progress: .1) .copyWithPrevious( const AsyncError(84, StackTrace.empty), ) .whenData((value) => '$value'), - const AsyncLoading().copyWithPrevious( + const AsyncLoading(progress: .1).copyWithPrevious( const AsyncError(84, StackTrace.empty), ), ); @@ -1436,8 +1497,8 @@ void main() { const AsyncData('42'), ); expect( - const AsyncLoading().whenData((value) => '$value'), - const AsyncLoading(), + const AsyncLoading(progress: .1).whenData((value) => '$value'), + const AsyncLoading(progress: .1), ); expect( const AsyncError(21, StackTrace.empty) diff --git a/packages/riverpod/test/src/providers/future_provider_test.dart b/packages/riverpod/test/src/providers/future_provider_test.dart index 4e434f21b..c202622be 100644 --- a/packages/riverpod/test/src/providers/future_provider_test.dart +++ b/packages/riverpod/test/src/providers/future_provider_test.dart @@ -1,3 +1,5 @@ +import 'dart:async'; + import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; @@ -7,6 +9,26 @@ import '../utils.dart'; void main() { group('FutureProvider', () { + test('resets progress to 0 if restarting while the future is pending', () { + final container = ProviderContainer.test(); + late Ref> ref; + final completer = Completer(); + addTearDown(() => completer.complete(42)); + + final provider = FutureProvider((r) { + ref = r; + return completer.future; + }); + + expect(container.read(provider), const AsyncValue.loading()); + + ref.state = const AsyncValue.loading(progress: .2); + + container.refresh(provider); + + expect(container.read(provider), const AsyncValue.loading()); + }); + group('retry', () { test( 'handles retry', From 55b7b1219a2ec130607d1c55e1191eff434b62e7 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 24 Jun 2024 11:31:57 +0200 Subject: [PATCH 330/387] Have `AsyncValue.progress` default to null instead of 0. This enables the UI to differentiate between deterministic and non-deterministic progress logic. --- .../riverpod/lib/src/core/async_value.dart | 31 ++++++++++++------- .../test/src/core/async_value_test.dart | 19 ++++-------- 2 files changed, 26 insertions(+), 24 deletions(-) diff --git a/packages/riverpod/lib/src/core/async_value.dart b/packages/riverpod/lib/src/core/async_value.dart index 11286b388..0f24f4197 100644 --- a/packages/riverpod/lib/src/core/async_value.dart +++ b/packages/riverpod/lib/src/core/async_value.dart @@ -178,12 +178,21 @@ sealed class AsyncValue { /// The current progress of the asynchronous operation. /// - /// `null` if [isLoading] is false. /// This value must be between 0 and 1. /// - /// When a provider starts an async operation, the progress is set to `0`. - /// As the operation progresses, the provider should update the progress. - /// This can be done with `AsyncLoading(progress: 0.5)`. + /// By default, the progress will always be `null`. + /// Providers can set this manually as such: + /// + /// ```dart + /// @riverpod + /// Future example(ExampleRef ref) async { + /// ref.state = AsyncLoading(progress: 0); + /// + /// await something(); + /// + /// ref.state = AsyncLoading(progress: 1); + /// } + /// ``` num? get progress; /// The value currently exposed. @@ -324,7 +333,7 @@ sealed class AsyncValue { hasValue: false, progress: e.progress, ), - loading: (l) => AsyncLoading(progress: progress!), + loading: (l) => AsyncLoading(progress: progress), ); } @@ -491,14 +500,14 @@ sealed class AsyncValue { AsyncValue unwrapPrevious() { return map( data: (d) { - if (d.isLoading) return AsyncLoading(progress: progress!); + if (d.isLoading) return AsyncLoading(progress: progress); return AsyncData(d.value); }, error: (e) { - if (e.isLoading) return AsyncLoading(progress: progress!); + if (e.isLoading) return AsyncLoading(progress: progress); return AsyncError(e.error, e.stackTrace); }, - loading: (l) => AsyncLoading(progress: progress!), + loading: (l) => AsyncLoading(progress: progress), ); } @@ -616,13 +625,13 @@ final class AsyncData extends AsyncValue { /// {@macro async_value.loading} final class AsyncLoading extends AsyncValue { /// {@macro async_value.loading} - const AsyncLoading({this.progress = 0}) + const AsyncLoading({this.progress}) : hasValue = false, value = null, error = null, stackTrace = null, assert( - progress >= 0 && progress <= 1, + progress == null || (progress >= 0 && progress <= 1), 'progress must be between 0 and 1', ), super._(); @@ -645,7 +654,7 @@ final class AsyncLoading extends AsyncValue { final bool hasValue; @override - final num progress; + final num? progress; @override final StateT? value; diff --git a/packages/riverpod/test/src/core/async_value_test.dart b/packages/riverpod/test/src/core/async_value_test.dart index 82e3f2a5f..7f42d3808 100644 --- a/packages/riverpod/test/src/core/async_value_test.dart +++ b/packages/riverpod/test/src/core/async_value_test.dart @@ -19,19 +19,12 @@ void main() { }); group('progress', () { - test('defaults to 0 on AsyncLoading', () { - expect(const AsyncLoading().progress, 0); - }); - - test('defaults to null on AsyncData/AsyncError', () { + test('defaults to null', () { + expect(const AsyncLoading().progress, null); expect(const AsyncData(42).progress, null); expect(const AsyncError('err', StackTrace.empty).progress, null); }); - test('is non-nullable on AsyncLoading', () { - final num progress = const AsyncLoading(progress: .1).progress; - }); - test('asserts is within bounds', () { expect( () => AsyncLoading(progress: -0.1), @@ -1360,7 +1353,7 @@ void main() { ); expect( const AsyncLoading().toString(), - 'AsyncLoading(progress: 0)', + 'AsyncLoading()', ); expect( const AsyncLoading(progress: .1).toString(), @@ -1371,7 +1364,7 @@ void main() { const AsyncLoading() .copyWithPrevious(const AsyncData(42)) .toString(), - 'AsyncData(isLoading: true, progress: 0, value: 42)', + 'AsyncData(isLoading: true, value: 42)', ); expect( const AsyncLoading(progress: .1) @@ -1383,7 +1376,7 @@ void main() { const AsyncLoading() .copyWithPrevious(const AsyncError(42, StackTrace.empty)) .toString(), - 'AsyncError(isLoading: true, progress: 0, error: 42, stackTrace: )', + 'AsyncError(isLoading: true, error: 42, stackTrace: )', ); expect( const AsyncData(42) @@ -1401,7 +1394,7 @@ void main() { const AsyncLoading() .copyWithPrevious(const AsyncData(42), isRefresh: false) .toString(), - 'AsyncLoading(progress: 0, value: 42)', + 'AsyncLoading(value: 42)', ); }); From bb8a0b2f7e7cd8aa669891e4354c8d4c774b11b1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 31 Aug 2024 15:20:07 +0200 Subject: [PATCH 331/387] Fix some tests --- packages/riverpod/lib/src/core/element.dart | 11 ++--------- .../riverpod/lib/src/core/provider_subscription.dart | 3 --- packages/riverpod/lib/src/core/scheduler.dart | 2 +- .../test/old/framework/auto_dispose_test.dart | 4 ++-- packages/riverpod/test/old/utils.dart | 9 +++++++++ 5 files changed, 14 insertions(+), 15 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index e94e2e8dc..2e21d901c 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -564,7 +564,6 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } SubT _onListen(SubT Function() add) { - print('listen $origin'); final wasActive = isActive; ref?._onAddListeners?.forEach(runGuarded); @@ -577,12 +576,10 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } void _onRemoveListener(ProviderSubscription Function() remove) { - print('unsub $origin'); final wasActive = isActive; - final removedSub = remove(); - if (removedSub.isPaused && !removedSub.source.weak) - ref?._onRemoveListeners?.forEach(runGuarded); + remove(); + ref?._onRemoveListeners?.forEach(runGuarded); _mayNeedDispose(); if (wasActive && !isActive) _onCancel(); @@ -593,7 +590,6 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu // _pausedActiveSubscriptionCount if (weak) return; - print('on pause sub at $origin'); final wasActive = isActive; _pausedActiveSubscriptionCount++; @@ -607,7 +603,6 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu // _pausedActiveSubscriptionCount if (weak) return; - print('on resume sub at $origin'); final wasActive = isActive; _pausedActiveSubscriptionCount = max(0, _pausedActiveSubscriptionCount - 1); @@ -615,7 +610,6 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } void _onResume() { - print('resume $origin'); ref?._onResumeListeners?.forEach(runGuarded); visitAncestors((element) { @@ -624,7 +618,6 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } void _onCancel() { - print('cancel $origin'); _didCancelOnce = true; ref?._onCancelListeners?.forEach(runGuarded); diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index 721d89f05..327678e6c 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -113,9 +113,6 @@ final class _ProviderStateSubscription @override void close() { if (!closed) { - // if (isPaused) { - // listenedElement._onSubscriptionResume(weak: source.weak); - // } listenedElement._onRemoveListener( () { switch (source) { diff --git a/packages/riverpod/lib/src/core/scheduler.dart b/packages/riverpod/lib/src/core/scheduler.dart index dcba47849..80476dac8 100644 --- a/packages/riverpod/lib/src/core/scheduler.dart +++ b/packages/riverpod/lib/src/core/scheduler.dart @@ -125,7 +125,7 @@ class ProviderScheduler { if ((links != null && links.isNotEmpty) || element.container._disposed || - element.isActive) { + element.hasListeners) { continue; } diff --git a/packages/riverpod/test/old/framework/auto_dispose_test.dart b/packages/riverpod/test/old/framework/auto_dispose_test.dart index 3e3e39a5d..3efe13deb 100644 --- a/packages/riverpod/test/old/framework/auto_dispose_test.dart +++ b/packages/riverpod/test/old/framework/auto_dispose_test.dart @@ -96,12 +96,12 @@ Future main() async { test('unsub to A then make B sub to A then unsub to B disposes B before A', () async { final container = ProviderContainer.test(); - final aDispose = OnDisposeMock(); + final aDispose = OnDisposeMock('a'); final a = Provider.autoDispose((ref) { ref.onDispose(aDispose.call); return 42; }); - final bDispose = OnDisposeMock(); + final bDispose = OnDisposeMock('b'); final b = Provider.autoDispose((ref) { ref.onDispose(bDispose.call); ref.watch(a); diff --git a/packages/riverpod/test/old/utils.dart b/packages/riverpod/test/old/utils.dart index c29018eaf..f7839184e 100644 --- a/packages/riverpod/test/old/utils.dart +++ b/packages/riverpod/test/old/utils.dart @@ -36,7 +36,16 @@ class OnBuildMock extends Mock { } class OnDisposeMock extends Mock { + OnDisposeMock([this.label]); + + final String? label; + void call(); + + @override + String toString() { + return 'OnDisposeMock($label)'; + } } class OnCancelMock extends Mock { From e9f132d4dce2f83f808023db03c642a88d85344e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 31 Aug 2024 17:11:52 +0200 Subject: [PATCH 332/387] More tests --- packages/riverpod/lib/src/core/element.dart | 35 ++----------------- .../lib/src/core/modifiers/future.dart | 1 - .../test/old/legacy/framework_test.dart | 2 +- packages/riverpod/test/src/core/ref_test.dart | 6 ---- 4 files changed, 4 insertions(+), 40 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 2e21d901c..bac191623 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -79,7 +79,6 @@ abstract class ProviderElement implements WrappedNode { bool get isActive => (_listenerCount - _pausedActiveSubscriptionCount) > 0; int get _listenerCount => _dependents?.length ?? 0; - // (_dependents?.length ?? 0) + _watchDependents.length; var _pausedActiveSubscriptionCount = 0; var _didCancelOnce = false; @@ -249,13 +248,6 @@ This could mean a few things: /// After a provider is initialized, this function takes care of unsubscribing /// to dependencies that are no-longer used. void _performBuild() { - // assert( - // _previousDependencies == null, - // 'Bad state: _performBuild was called twice', - // ); - // final previousDependencies = _previousDependencies = _dependencies; - // _dependencies = HashMap(); - runOnDispose(); final ref = this.ref = Ref._(this); final previousStateResult = _stateResult; @@ -278,16 +270,6 @@ This could mean a few things: if (previousSubscriptions != null) { _closeSubscriptions(previousSubscriptions); } - - // // Unsubscribe to everything that a provider no longer depends on. - // for (final sub in previousDependencies.entries) { - // sub.key._onRemoveListener( - // () => sub.key._watchDependents.remove(this), - // weak: false, - // isPaused: !isActive, - // ); - // } - // _previousDependencies = null; } /// Initialize a provider. @@ -704,20 +686,9 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu _stateResult = null; ref = null; - final previousSubscriptions = _previousSubscriptions; - if (previousSubscriptions != null) { - _closeSubscriptions(previousSubscriptions); - } - - // // TODO share with _performBuild - // for (final sub in _dependencies.entries) { - // sub.key._onRemoveListener( - // () => sub.key._watchDependents.remove(this), - // weak: false, - // isPaused: !sub.key.isActive, - // ); - // } - // _dependencies.clear(); + if (_previousSubscriptions case final subs?) _closeSubscriptions(subs); + if (_dependents case final subs?) _closeSubscriptions(subs); + _closeSubscriptions(_weakDependents); } @override diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 5a1a8981e..2a6ea31b5 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -411,7 +411,6 @@ mixin FutureModifierElement on ProviderElement> { /// Listens to a [Future] and transforms it into an [AsyncValue]. void _handleAsync( - // Stream Function({required void Function(T) fireImmediately}) create, CancelAsyncSubscription? Function({ required void Function(StateT) data, required void Function(Object, StackTrace) error, diff --git a/packages/riverpod/test/old/legacy/framework_test.dart b/packages/riverpod/test/old/legacy/framework_test.dart index c896f1cf2..3108ddd89 100644 --- a/packages/riverpod/test/old/legacy/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework_test.dart @@ -74,7 +74,7 @@ void main() { final container = ProviderContainer.test(); expect( () => container.read(provider), - throwsA(isA()), + throwsA(isA()), ); }); diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index ba8f8f16b..66c874699 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -2744,9 +2744,7 @@ void main() { if (watching) ref.watch(dep); }); - print('a'); container.read(provider); - print('b'); container.read(provider2); verifyZeroInteractions(listener); @@ -2754,16 +2752,12 @@ void main() { watching = false; // remove the dependency provider<>dep - print('c'); container.refresh(provider); - print('d'); verifyZeroInteractions(listener2); // remove the dependency provider2<>dep - print('e'); container.refresh(provider2); - print('f'); verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); From 2615056dad02b51c7d6cdff483b5d535e342b2a8 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 1 Sep 2024 16:51:38 +0200 Subject: [PATCH 333/387] W --- packages/riverpod/lib/src/core/element.dart | 88 +++++++++---------- .../lib/src/core/modifiers/select.dart | 4 + .../lib/src/core/provider/provider.dart | 16 ++-- .../lib/src/core/provider_subscription.dart | 26 +++--- .../src/core/proxy_provider_listenable.dart | 2 +- packages/riverpod/lib/src/core/ref.dart | 27 +----- .../test/src/core/modifiers/future_test.dart | 2 +- .../test/src/core/modifiers/select_test.dart | 4 +- .../src/core/provider_subscription_test.dart | 20 ++++- packages/riverpod/test/src/core/ref_test.dart | 20 +++-- 10 files changed, 104 insertions(+), 105 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index bac191623..fb0234f35 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -75,7 +75,7 @@ abstract class ProviderElement implements WrappedNode { /// - it has no listeners /// - all of its listeners are "weak" (i.e. created with `listen(weak: true)`) /// - /// See also [_mayNeedDispose], called when [isActive] may have changed. + /// See also [mayNeedDispose], called when [isActive] may have changed. bool get isActive => (_listenerCount - _pausedActiveSubscriptionCount) > 0; int get _listenerCount => _dependents?.length ?? 0; @@ -87,10 +87,8 @@ abstract class ProviderElement implements WrappedNode { /// /// This maps to listeners added with `listen` and `watch`, /// excluding `listen(weak: true)`. - bool get hasListeners => _listenerCount > 0 || _weakDependents.isNotEmpty; + bool get hasListeners => _listenerCount > 0; - // var _dependencies = HashMap(); - // HashMap? _previousDependencies; List? _previousSubscriptions; List? _subscriptions; List? _dependents; @@ -102,9 +100,6 @@ abstract class ProviderElement implements WrappedNode { /// - They may be reused between two instances of a [ProviderElement]. final _weakDependents = []; - // /// The element of the providers that depends on this provider. - // final _watchDependents = []; - bool _mustRecomputeState = false; bool _dependencyMayHaveChanged = false; bool _didChangeDependency = false; @@ -374,7 +369,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu _mustRecomputeState = true; runOnDispose(); - _mayNeedDispose(); + mayNeedDispose(); container.scheduler.scheduleProviderRefresh(this); // We don't call this._markDependencyMayHaveChanged here because we voluntarily @@ -550,66 +545,71 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ref?._onAddListeners?.forEach(runGuarded); final sub = add(); - if (_didCancelOnce && !wasActive && isActive) { - _onResume(); - } + if (sub.isPaused) onSubscriptionPause(weak: sub.source.weak); + + if (_didCancelOnce && !wasActive && isActive) _onResume(); return sub; } - void _onRemoveListener(ProviderSubscription Function() remove) { + void onChangeSubscription(void Function() apply) { final wasActive = isActive; + final previousListenerCount = _listenerCount; + apply(); - remove(); - ref?._onRemoveListeners?.forEach(runGuarded); - _mayNeedDispose(); + switch ((wasActive: wasActive, isActive: isActive)) { + case (wasActive: false, isActive: true) when _didCancelOnce: + ref?._onResumeListeners?.forEach(runGuarded); + visitAncestors((element) => element.onSubscriptionResume(weak: false)); - if (wasActive && !isActive) _onCancel(); - } + case (wasActive: true, isActive: false): + _didCancelOnce = true; + ref?._onCancelListeners?.forEach(runGuarded); + visitAncestors((element) => element.onSubscriptionPause(weak: false)); - void _onSubscriptionPause({required bool weak}) { - // Weak listeners are not counted towards isActive, so we don't want to change - // _pausedActiveSubscriptionCount - if (weak) return; + default: + // No state change, so do nothing + } - final wasActive = isActive; - _pausedActiveSubscriptionCount++; + if (_listenerCount < previousListenerCount) { + _onRemoveListener(); + } else if (_listenerCount > previousListenerCount) { + _onAddListener(); + } + } - if (wasActive && !isActive) _onCancel(); + void _onRemoveListener() { + ref?._onRemoveListeners?.forEach(runGuarded); + mayNeedDispose(); } - void _onSubscriptionResume({ - required bool weak, - }) { + void _onAddListener() => ref?._onAddListeners?.forEach(runGuarded); + + void onSubscriptionPause({required bool weak}) { // Weak listeners are not counted towards isActive, so we don't want to change // _pausedActiveSubscriptionCount if (weak) return; - final wasActive = isActive; - _pausedActiveSubscriptionCount = max(0, _pausedActiveSubscriptionCount - 1); - - if (!wasActive && isActive) _onResume(); - } - - void _onResume() { - ref?._onResumeListeners?.forEach(runGuarded); - - visitAncestors((element) { - element._onSubscriptionResume(weak: false); + onChangeSubscription(() { + _pausedActiveSubscriptionCount++; }); } - void _onCancel() { - _didCancelOnce = true; - ref?._onCancelListeners?.forEach(runGuarded); + void onSubscriptionResume({required bool weak}) { + // Weak listeners are not counted towards isActive, so we don't want to change + // _pausedActiveSubscriptionCount + if (weak) return; - visitAncestors((element) { - element._onSubscriptionPause(weak: false); + onChangeSubscription(() { + _pausedActiveSubscriptionCount = max( + 0, + _pausedActiveSubscriptionCount - 1, + ); }); } /// Life-cycle for when a listener is removed. - void _mayNeedDispose() { + void mayNeedDispose() { if (provider.isAutoDispose) { final links = ref?._keepAliveLinks; diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index 3571dd8d0..35f1e93b8 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -128,12 +128,14 @@ class _ProviderSelector with ProviderListenable { required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, }) { + print('setup selector on ${this.provider}'); onError ??= Zone.current.handleUncaughtError; Result? lastSelectedValue; final sub = node.listen( provider, (prev, input) { + print('change for ${provider}'); _selectOnChange( newState: input, lastSelectedValue: lastSelectedValue, @@ -146,6 +148,8 @@ class _ProviderSelector with ProviderListenable { onError: onError, ); + print(sub.isPaused); + if (!node.weak) lastSelectedValue = _select(Result.guard(sub.read)); if (fireImmediately) { diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index d1c73aaac..c66e4aaa1 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -81,12 +81,14 @@ abstract base class ProviderBase extends ProviderOrFamily // to ensure that "hasListeners" represents the state _before_ // the listener is added return element._onListen( - () => _ProviderStateSubscription( - source, - listenedElement: element, - listener: (prev, next) => listener(prev as StateT?, next as StateT), - onError: onError!, - ), + () { + return _ProviderStateSubscription( + source, + listenedElement: element, + listener: (prev, next) => listener(prev as StateT?, next as StateT), + onError: onError!, + ); + }, ); } @@ -97,7 +99,7 @@ abstract base class ProviderBase extends ProviderOrFamily element.flush(); // In case `read` was called on a provider that has no listener - element._mayNeedDispose(); + element.mayNeedDispose(); return element.requireState; } diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index 327678e6c..6a71fc535 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -106,35 +106,31 @@ final class _ProviderStateSubscription 'called ProviderSubscription.read on a subscription that was closed', ); } - listenedElement._mayNeedDispose(); + listenedElement.mayNeedDispose(); return listenedElement.readSelf(); } @override void close() { if (!closed) { - listenedElement._onRemoveListener( - () { - switch (source) { - case WeakNode(): - listenedElement._weakDependents.remove(this); - case _: - listenedElement._dependents?.remove(this); - } - - return this; - }, - ); + listenedElement.onChangeSubscription(() { + switch (source) { + case WeakNode(): + listenedElement._weakDependents.remove(this); + case _: + listenedElement._dependents?.remove(this); + } + }); } super.close(); } @override - void _onCancel() => listenedElement._onSubscriptionPause(weak: source.weak); + void _onCancel() => listenedElement.onSubscriptionPause(weak: source.weak); @override - void _onResume() => listenedElement._onSubscriptionResume(weak: source.weak); + void _onResume() => listenedElement.onSubscriptionResume(weak: source.weak); } /// Deals with the internals of synchronously calling the listeners diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index 406a2380b..4fa432986 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -138,7 +138,7 @@ class ProviderElementProxy OutputT read(Node node) { final element = node.readProviderElement(provider); element.flush(); - element._mayNeedDispose(); + element.mayNeedDispose(); return _lense(element).value; } diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index b7e6fce77..eadd37721 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -162,7 +162,7 @@ final = Provider(dependencies: []); late KeepAliveLink link; link = KeepAliveLink._(() { if (links.remove(link)) { - if (links.isEmpty) _element._mayNeedDispose(); + if (links.isEmpty) _element.mayNeedDispose(); } }); links.add(link); @@ -540,7 +540,6 @@ final = Provider(dependencies: []); /// ``` T watch(ProviderListenable listenable) { _throwIfInvalidUsage(); - // if (listenable is! ProviderBase) { final sub = _element.listen( listenable, (prev, value) => invalidateSelf(asReload: true), @@ -549,30 +548,6 @@ final = Provider(dependencies: []); ); return sub.read(); - // } - - // final targetElement = container.readProviderElement(listenable); - // _element._dependencies.putIfAbsent(targetElement, () { - // final previousSub = _element._previousDependencies?.remove(targetElement); - // if (previousSub != null) { - // return previousSub; - // } - - // targetElement - // .._onListen( - // weak: false, - // isPaused: !_element.isActive, - // ) - // .._watchDependents.add(_element); - - // return Object(); - // }); - - // final result = targetElement.readSelf(); - - // if (kDebugMode) _debugAssertCanDependOn(listenable); - - // return result; } /// {@template riverpod.listen} diff --git a/packages/riverpod/test/src/core/modifiers/future_test.dart b/packages/riverpod/test/src/core/modifiers/future_test.dart index daedb4fe5..9a64606ae 100644 --- a/packages/riverpod/test/src/core/modifiers/future_test.dart +++ b/packages/riverpod/test/src/core/modifiers/future_test.dart @@ -17,7 +17,7 @@ void main() { (previous, value) {}, ); - expect(container.readProviderElement(provider).hasListeners, true); + expect(container.readProviderElement(provider).hasListeners, false); sub.close(); diff --git a/packages/riverpod/test/src/core/modifiers/select_test.dart b/packages/riverpod/test/src/core/modifiers/select_test.dart index a3ed9d935..1dbe8b6f1 100644 --- a/packages/riverpod/test/src/core/modifiers/select_test.dart +++ b/packages/riverpod/test/src/core/modifiers/select_test.dart @@ -53,7 +53,7 @@ void main() { (previous, value) {}, ); - expect(container.readProviderElement(provider).hasListeners, true); + expect(container.readProviderElement(provider).hasListeners, false); sub.close(); @@ -78,6 +78,8 @@ void main() { (previous, value) {}, ); + print(element.hasListeners); + expect(sub.read(), 0); verifyZeroInteractions(onDispose); diff --git a/packages/riverpod/test/src/core/provider_subscription_test.dart b/packages/riverpod/test/src/core/provider_subscription_test.dart index 93d097a1e..6c8ed053b 100644 --- a/packages/riverpod/test/src/core/provider_subscription_test.dart +++ b/packages/riverpod/test/src/core/provider_subscription_test.dart @@ -22,8 +22,24 @@ void main() { expect(element.isActive, true); }); - test('closing a paused subscription unpause the element', () { - throw UnimplementedError(); + test('closing a paused subscription unpauses the element', () { + final container = ProviderContainer.test(); + final provider = FutureProvider((ref) => 0); + + final element = container.readProviderElement(provider); + + final sub = container.listen(provider.future, (previous, next) {}); + + expect(element.isActive, true); + + sub.pause(); + + expect(element.isActive, false); + + sub.close(); + container.listen(provider.future, (previous, next) {}); + + expect(element.isActive, true); }); }); } diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 66c874699..e85d46cdc 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -963,18 +963,22 @@ void main() { expect(buildCount, 1); }); - test('closing the subscription updated element.hasListeners', () { + test('closing the subscription removes the listener', () { final container = ProviderContainer.test(); - final provider = Provider((ref) => 0); - - final sub = - container.listen(provider, weak: true, (previous, value) {}); - - expect(container.readProviderElement(provider).hasListeners, true); + final provider = Provider((ref) => Object()); + final listener = Listener(); + final sub = container.listen( + provider, + weak: true, + listener.call, + ); sub.close(); - expect(container.readProviderElement(provider).hasListeners, false); + container.read(provider); + container.refresh(provider); + + verifyZeroInteractions(listener); }); test('does not count towards the pause mechanism', () async { From 8723f8f324d9146e14d09797690573be135cb609 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 7 Sep 2024 19:15:22 +0200 Subject: [PATCH 334/387] Restore most tests --- packages/riverpod/lib/src/core/element.dart | 231 +++++++++--------- .../riverpod/lib/src/core/foundation.dart | 6 +- .../lib/src/core/modifiers/select.dart | 111 ++------- .../lib/src/core/modifiers/select_async.dart | 31 ++- .../lib/src/core/provider/provider.dart | 37 +-- .../lib/src/core/provider_container.dart | 23 +- .../lib/src/core/provider_subscription.dart | 206 +++++++++++----- .../src/core/proxy_provider_listenable.dart | 65 +++-- packages/riverpod/lib/src/core/ref.dart | 16 +- packages/riverpod/lib/src/core/scheduler.dart | 4 +- .../test/old/framework/auto_dispose_test.dart | 7 +- .../test/old/framework/modifiers_test.dart | 12 +- .../test/old/framework/ref_watch_test.dart | 10 +- packages/riverpod/test/old/utils.dart | 4 +- .../test/src/core/modifiers/future_test.dart | 2 +- .../test/src/core/modifiers/select_test.dart | 4 +- .../src/core/provider_container_test.dart | 107 +------- .../test/src/core/provider_element_test.dart | 14 +- packages/riverpod/test/src/core/ref_test.dart | 128 ++++------ .../src/providers/stream_notifier_test.dart | 4 +- packages/riverpod/test/src/utils.dart | 4 +- 21 files changed, 475 insertions(+), 551 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index fb0234f35..a2e04dbef 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -42,7 +42,7 @@ void Function()? debugCanModifyProviders; /// {@endtemplate} @internal @optionalTypeArgs -abstract class ProviderElement implements WrappedNode { +abstract class ProviderElement implements Node { /// {@macro riverpod.provider_element_base} ProviderElement(this.pointer); @@ -55,8 +55,7 @@ abstract class ProviderElement implements WrappedNode { var _debugSkipNotifyListenersAsserts = false; /// The provider associated with this [ProviderElement], before applying overrides. - // Not typed as because of https://github.com/rrousselGit/riverpod/issues/1100 - ProviderBase get origin => pointer.origin; + ProviderBase get origin => pointer.origin as ProviderBase; /// The provider associated with this [ProviderElement], after applying overrides. ProviderBase get provider; @@ -78,7 +77,7 @@ abstract class ProviderElement implements WrappedNode { /// See also [mayNeedDispose], called when [isActive] may have changed. bool get isActive => (_listenerCount - _pausedActiveSubscriptionCount) > 0; - int get _listenerCount => _dependents?.length ?? 0; + int get _listenerCount => dependents?.length ?? 0; var _pausedActiveSubscriptionCount = 0; var _didCancelOnce = false; @@ -86,19 +85,21 @@ abstract class ProviderElement implements WrappedNode { /// Whether this [ProviderElement] is currently listened to or not. /// /// This maps to listeners added with `listen` and `watch`, - /// excluding `listen(weak: true)`. - bool get hasListeners => _listenerCount > 0; + /// including `listen(weak: true)`. + bool get hasListeners => _listenerCount > 0 || weakDependents.isNotEmpty; - List? _previousSubscriptions; - List? _subscriptions; - List? _dependents; + @visibleForTesting + List? subscriptions; + @visibleForTesting + List? dependents; /// "listen(weak: true)" pointing to this provider. /// - /// Those subscriptions are separate from [ProviderElement._dependents] for a few reasons: + /// Those subscriptions are separate from [ProviderElement.dependents] for a few reasons: /// - They do not count towards [ProviderElement.isActive]. /// - They may be reused between two instances of a [ProviderElement]. - final _weakDependents = []; + @visibleForTesting + final weakDependents = []; bool _mustRecomputeState = false; bool _dependencyMayHaveChanged = false; @@ -260,11 +261,6 @@ This could mean a few things: if (kDebugMode) _debugSkipNotifyListenersAsserts = false; } - - final previousSubscriptions = _previousSubscriptions; - if (previousSubscriptions != null) { - _closeSubscriptions(previousSubscriptions); - } } /// Initialize a provider. @@ -430,40 +426,33 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu return; } - final listeners = [..._weakDependents, if (!isMount) ...?_dependents]; + final listeners = [...weakDependents, if (!isMount) ...?dependents]; switch (newState) { case final ResultData newState: for (var i = 0; i < listeners.length; i++) { final listener = listeners[i]; - if (listener is _ProviderStateSubscription && !listener._isPaused) { - Zone.current.runBinaryGuarded( - listener.listener, - previousState, - newState.state, - ); - } + if (listener.closed) continue; + + Zone.current.runBinaryGuarded( + listener._notify, + previousState, + newState.state, + ); } case final ResultError newState: for (var i = 0; i < listeners.length; i++) { final listener = listeners[i]; - if (listener is _ProviderStateSubscription && - !listener._isPaused) { - Zone.current.runBinaryGuarded( - listener.onError, - newState.error, - newState.stackTrace, - ); - } + if (listener.closed) continue; + + Zone.current.runBinaryGuarded( + listener._notifyError, + newState.error, + newState.stackTrace, + ); } default: } - // if (!isMount) { - // for (var i = 0; i < _watchDependents.length; i++) { - // _watchDependents[i].invalidateSelf(asReload: true); - // } - // } - for (final observer in container.observers) { if (isMount) { runTernaryGuarded( @@ -514,7 +503,6 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu return container.readProviderElement(provider); } - @override ProviderSubscription listen( ProviderListenable listenable, void Function(T? previous, T value) listener, { @@ -527,32 +515,60 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu final ref = this.ref!; ref._throwIfInvalidUsage(); - final result = listenable.addListener( - weak ? WeakNode(this) : this, + final sub = listenable.addListener( + this, listener, fireImmediately: fireImmediately, onError: onError, + weak: weak, onDependencyMayHaveChanged: onDependencyMayHaveChanged, ); + switch (sub) { + case ProviderSubscriptionImpl(): + sub._listenedElement.addDependentSubscription(sub); + } + if (kDebugMode) ref._debugAssertCanDependOn(listenable); - return result; + return sub; } - SubT _onListen(SubT Function() add) { - final wasActive = isActive; - ref?._onAddListeners?.forEach(runGuarded); + void addDependentSubscription(ProviderSubscriptionImpl sub) { + _onChangeSubscription(sub, () { + if (sub.weak) { + weakDependents.add(sub); + } else { + final dependents = this.dependents ??= []; + dependents.add(sub); + } + + if (sub.source case final ProviderElement element) { + final subs = element.subscriptions ??= []; + subs.add(sub); + } + }); + } - final sub = add(); - if (sub.isPaused) onSubscriptionPause(weak: sub.source.weak); + void removeDependentSubscription(ProviderSubscription sub) { + while (sub.isPaused) { + sub.resume(); + } - if (_didCancelOnce && !wasActive && isActive) _onResume(); + _onChangeSubscription(sub, () { + if (sub.weak) { + weakDependents.remove(sub); + } else { + dependents?.remove(sub); + } - return sub; + if (sub.source case final ProviderElement element) { + element.subscriptions?.remove(sub); + } + }); } - void onChangeSubscription(void Function() apply) { + void _onChangeSubscription(ProviderSubscription sub, void Function() apply) { final wasActive = isActive; final previousListenerCount = _listenerCount; apply(); @@ -560,47 +576,48 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu switch ((wasActive: wasActive, isActive: isActive)) { case (wasActive: false, isActive: true) when _didCancelOnce: ref?._onResumeListeners?.forEach(runGuarded); - visitAncestors((element) => element.onSubscriptionResume(weak: false)); + + // _subscriptions?.forEach((sub) => sub.resume()); case (wasActive: true, isActive: false): _didCancelOnce = true; ref?._onCancelListeners?.forEach(runGuarded); - visitAncestors((element) => element.onSubscriptionPause(weak: false)); + // _subscriptions?.forEach((sub) => sub.pause()); default: // No state change, so do nothing } if (_listenerCount < previousListenerCount) { - _onRemoveListener(); + if (ref?._onRemoveListeners case final listeners?) { + for (final listener in listeners) { + runUnaryGuarded(listener, sub); + } + } + mayNeedDispose(); } else if (_listenerCount > previousListenerCount) { - _onAddListener(); + if (ref?._onAddListeners case final listeners?) { + for (final listener in listeners) { + runUnaryGuarded(listener, sub); + } + } } } - void _onRemoveListener() { - ref?._onRemoveListeners?.forEach(runGuarded); - mayNeedDispose(); - } - - void _onAddListener() => ref?._onAddListeners?.forEach(runGuarded); - - void onSubscriptionPause({required bool weak}) { + void onSubscriptionPause(ProviderSubscription sub) { // Weak listeners are not counted towards isActive, so we don't want to change // _pausedActiveSubscriptionCount - if (weak) return; + if (sub.weak) return; - onChangeSubscription(() { - _pausedActiveSubscriptionCount++; - }); + _onChangeSubscription(sub, () => _pausedActiveSubscriptionCount++); } - void onSubscriptionResume({required bool weak}) { + void onSubscriptionResume(ProviderSubscription sub) { // Weak listeners are not counted towards isActive, so we don't want to change // _pausedActiveSubscriptionCount - if (weak) return; + if (sub.weak) return; - onChangeSubscription(() { + _onChangeSubscription(sub, () { _pausedActiveSubscriptionCount = max( 0, _pausedActiveSubscriptionCount - 1, @@ -620,8 +637,9 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } void _closeSubscriptions(List subscriptions) { - for (var i = 0; i < subscriptions.length; i++) { - subscriptions[i].close(); + final subs = subscriptions.toList(); + for (var i = 0; i < subs.length; i++) { + subs[i].close(); } } @@ -636,13 +654,8 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ref._mounted = false; - final subscriptions = _previousSubscriptions = _subscriptions; - _subscriptions = null; - if (subscriptions != null) { - for (var i = 0; i < subscriptions.length; i++) { - subscriptions[i].pause(); - } - } + if (subscriptions case final subs?) _closeSubscriptions(subs); + subscriptions = null; ref._onDisposeListeners?.forEach(runGuarded); @@ -658,7 +671,6 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ref._onRemoveListeners = null; ref._onChangeSelfListeners = null; ref._onErrorSelfListeners = null; - _pausedActiveSubscriptionCount = 0; _didCancelOnce = false; assert( @@ -667,6 +679,21 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ); } + /// Clears the state of a [ProviderElement]. + /// + /// This is in-between [dispose] and [runOnDispose]. + /// It is used to clear the state of a provider, without unsubscribing + /// [weakDependents]. + @mustCallSuper + void clearState() { + runOnDispose(); + _didMount = false; + _stateResult = null; + ref = null; + + if (dependents case final subs?) _closeSubscriptions(subs); + } + /// Release the resources associated to this [ProviderElement]. /// /// This will be invoked when: @@ -676,19 +703,14 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu /// On the other hand, this life-cycle will not be executed when a provider /// rebuilds. /// - /// As opposed to [runOnDispose], this life-cycle is executed only + /// As opposed to [runOnDispose], this life-cycle is executed only once /// for the lifetime of this element. @protected @mustCallSuper void dispose() { - runOnDispose(); - _didMount = false; - _stateResult = null; - ref = null; + clearState(); - if (_previousSubscriptions case final subs?) _closeSubscriptions(subs); - if (_dependents case final subs?) _closeSubscriptions(subs); - _closeSubscriptions(_weakDependents); + _closeSubscriptions(weakDependents); } @override @@ -727,24 +749,19 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu required void Function(ProxyElementValueListenable element) listenableVisitor, }) { - // for (var i = 0; i < _watchDependents.length; i++) { - // elementVisitor(_watchDependents[i]); - // } - - Iterable children = _weakDependents; - if (_dependents case final dependents?) { - children = children.followedBy(dependents); - } - - for (final child in children) { - switch (child.source) { - case final ProviderElement dependent: - case WeakNode(inner: final ProviderElement dependent): - elementVisitor(dependent); - case _: - break; + void lookup(Iterable children) { + for (final child in children) { + switch (child.source) { + case final ProviderElement dependent: + elementVisitor(dependent); + case ProviderContainer(): + break; + } } } + + lookup(weakDependents); + if (dependents case final dependents?) lookup(dependents); } /// Visit the [ProviderElement]s that this provider is listening to. @@ -758,15 +775,11 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu void visitAncestors( void Function(ProviderElement element) visitor, ) { - // _dependencies.keys.forEach(visitor); - - final subscriptions = _subscriptions; + final subscriptions = this.subscriptions; if (subscriptions != null) { for (var i = 0; i < subscriptions.length; i++) { final sub = subscriptions[i]; - if (sub is _ProviderStateSubscription) { - visitor(sub.listenedElement); - } + visitor(sub._listenedElement); } } } diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index 0dd5c1d92..e34f65e49 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -173,17 +173,15 @@ String shortHash(Object? object) { @immutable mixin ProviderListenable implements ProviderListenableOrFamily { /// Starts listening to this transformer - ProviderSubscription addListener( + ProviderSubscriptionWithOrigin addListener( Node source, void Function(StateT? previous, StateT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, + required bool weak, }); - /// Obtains the result of this provider expression without adding listener. - StateT read(Node node); - /// Partially listen to a provider. /// /// The [select] function allows filtering unwanted rebuilds of a Widget diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index 35f1e93b8..7cfa92665 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -1,19 +1,16 @@ part of '../../framework.dart'; -extension on Node { - bool get weak => this is WeakNode; -} - /// An abstraction of both [ProviderContainer] and [$ProviderElement] used by /// [ProviderListenable]. sealed class Node { - /// Starts listening to this transformer - ProviderSubscription listen( - ProviderListenable listenable, - void Function(StateT? previous, StateT next) listener, { - required void Function(Object error, StackTrace stackTrace)? onError, - required bool fireImmediately, - }); + // /// Starts listening to this transformer + // ProviderSubscription listen( + // ProviderListenable listenable, + // void Function(StateT? previous, StateT next) listener, { + // required void Function(Object error, StackTrace stackTrace)? onError, + // required bool fireImmediately, + // required bool weak, + // }); /// Obtain the [ProviderElement] of a provider, creating it if necessary. @internal @@ -22,46 +19,6 @@ sealed class Node { ); } -sealed class WrappedNode implements Node { - @override - ProviderSubscription listen( - ProviderListenable listenable, - void Function(StateT? previous, StateT next) listener, { - required void Function(Object error, StackTrace stackTrace)? onError, - required bool fireImmediately, - bool weak = false, - }); -} - -@internal -final class WeakNode implements Node { - WeakNode(this.inner); - final WrappedNode inner; - - @override - ProviderSubscription listen( - ProviderListenable listenable, - void Function(StateT? previous, StateT next) listener, { - required void Function(Object error, StackTrace stackTrace)? onError, - required bool fireImmediately, - }) { - return inner.listen( - listenable, - listener, - onError: onError, - weak: true, - fireImmediately: fireImmediately, - ); - } - - @override - ProviderElement readProviderElement( - ProviderBase provider, - ) { - return inner.readProviderElement(provider); - } -} - var _debugIsRunningSelector = false; /// An internal class for `ProviderBase.select`. @@ -127,15 +84,14 @@ class _ProviderSelector with ProviderListenable { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, + required bool weak, }) { - print('setup selector on ${this.provider}'); onError ??= Zone.current.handleUncaughtError; Result? lastSelectedValue; - final sub = node.listen( - provider, + final sub = provider.addListener( + node, (prev, input) { - print('change for ${provider}'); _selectOnChange( newState: input, lastSelectedValue: lastSelectedValue, @@ -145,12 +101,12 @@ class _ProviderSelector with ProviderListenable { ); }, fireImmediately: false, + weak: weak, + onDependencyMayHaveChanged: onDependencyMayHaveChanged, onError: onError, ); - print(sub.isPaused); - - if (!node.weak) lastSelectedValue = _select(Result.guard(sub.read)); + if (!weak) lastSelectedValue = _select(Result.guard(sub.read)); if (fireImmediately) { _handleFireImmediately( @@ -161,8 +117,7 @@ class _ProviderSelector with ProviderListenable { } return _SelectorSubscription( - node, - sub, + innerSubscription: sub, () { // Using ! because since `sub.read` flushes the inner subscription, // it is guaranteed that `lastSelectedValue` is not null. @@ -177,56 +132,40 @@ class _ProviderSelector with ProviderListenable { }, ); } - - @override - OutputT read(Node node) { - final input = provider.read(node); - - return _select(Result.data(input)).requireState; - } } -final class _SelectorSubscription - extends ProviderSubscription { +final class _SelectorSubscription + extends DelegatingProviderSubscription { _SelectorSubscription( - super.source, - this._internalSub, this._read, { this.onClose, + required this.innerSubscription, }); @override - bool get isPaused => _internalSub.isPaused; + final ProviderSubscriptionWithOrigin innerSubscription; - final ProviderSubscription _internalSub; - final Output Function() _read; final void Function()? onClose; + final OutT Function() _read; @override void close() { - if (!closed) { - onClose?.call(); - _internalSub.close(); - } + if (closed) return; + + onClose?.call(); super.close(); } @override - Output read() { + OutT read() { if (closed) { throw StateError( 'called ProviderSubscription.read on a subscription that was closed', ); } // flushes the provider - _internalSub.read(); + innerSubscription.read(); return _read(); } - - @override - void pause() => _internalSub.pause(); - - @override - void resume() => _internalSub.resume(); } diff --git a/packages/riverpod/lib/src/core/modifiers/select_async.dart b/packages/riverpod/lib/src/core/modifiers/select_async.dart index 7356b11cf..62f620e30 100644 --- a/packages/riverpod/lib/src/core/modifiers/select_async.dart +++ b/packages/riverpod/lib/src/core/modifiers/select_async.dart @@ -38,6 +38,7 @@ class _AsyncSelector with ProviderListenable> { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, + required bool weak, }) { Result? lastSelectedValue; Completer? selectedCompleter; @@ -131,9 +132,11 @@ class _AsyncSelector with ProviderListenable> { ); } - final sub = node.listen>( - provider, + final sub = provider.addListener( + node, (prev, input) => playValue(input), + weak: weak, + onDependencyMayHaveChanged: onDependencyMayHaveChanged, onError: onError, fireImmediately: false, ); @@ -145,23 +148,27 @@ class _AsyncSelector with ProviderListenable> { } return _SelectorSubscription( - node, - sub, + innerSubscription: sub, () => selectedFuture!, onClose: () { final completer = selectedCompleter; if (completer != null && !completer.isCompleted) { - read(node).then( - completer.complete, - onError: completer.completeError, + final sub = future.addListener( + node, + (prev, next) {}, + weak: weak, + onDependencyMayHaveChanged: () {}, + onError: onError, + fireImmediately: false, ); + + sub + .read() + .then((v) => _select(v).requireState) + .then(completer.complete, onError: completer.completeError) + .whenComplete(sub.close); } }, ); } - - @override - Future read(Node node) => future.read(node).then( - (v) => _select(v).requireState, - ); } diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index c66e4aaa1..8fe43eca4 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -51,15 +51,16 @@ abstract base class ProviderBase extends ProviderOrFamily final Object? argument; @override - ProviderSubscription addListener( + ProviderSubscriptionWithOrigin addListener( Node source, void Function(StateT? previous, StateT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, + required bool weak, }) { assert( - !fireImmediately || !source.weak, + !fireImmediately || !weak, 'Cannot use fireImmediately with weak listeners', ); @@ -67,7 +68,7 @@ abstract base class ProviderBase extends ProviderOrFamily final element = source.readProviderElement(this); - if (!source.weak) element.flush(); + if (!weak) element.flush(); if (fireImmediately) { _handleFireImmediately( @@ -77,33 +78,15 @@ abstract base class ProviderBase extends ProviderOrFamily ); } - // Calling before initializing the subscription, - // to ensure that "hasListeners" represents the state _before_ - // the listener is added - return element._onListen( - () { - return _ProviderStateSubscription( - source, - listenedElement: element, - listener: (prev, next) => listener(prev as StateT?, next as StateT), - onError: onError!, - ); - }, + return ProviderStateSubscription( + source: source, + listenedElement: element, + weak: weak, + listener: (prev, next) => listener(prev as StateT?, next as StateT), + onError: onError, ); } - @override - StateT read(Node node) { - final element = node.readProviderElement(this); - - element.flush(); - - // In case `read` was called on a provider that has no listener - element.mayNeedDispose(); - - return element.requireState; - } - /// An internal method that defines how a provider behaves. @visibleForOverriding ProviderElement $createElement($ProviderPointer pointer); diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 4f1fe72b4..99289ae17 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -564,7 +564,7 @@ class ProviderPointerManager { /// This will automatically dispose the container at the end of the test. /// {@endtemplate} @sealed -class ProviderContainer implements WrappedNode { +class ProviderContainer implements Node { /// {@macro riverpod.provider_container} ProviderContainer({ ProviderContainer? parent, @@ -725,7 +725,13 @@ class ProviderContainer implements WrappedNode { Result read( ProviderListenable provider, ) { - return provider.read(this); + final sub = listen(provider, (_, __) {}); + + try { + return sub.read(); + } finally { + sub.close(); + } } /// {@macro riverpod.exists} @@ -747,7 +753,6 @@ class ProviderContainer implements WrappedNode { } /// {@macro riverpod.listen} - @override ProviderSubscription listen( ProviderListenable provider, void Function(State? previous, State next) listener, { @@ -755,13 +760,21 @@ class ProviderContainer implements WrappedNode { bool weak = false, void Function(Object error, StackTrace stackTrace)? onError, }) { - return provider.addListener( - weak ? WeakNode(this) : this, + final sub = provider.addListener( + this, listener, fireImmediately: fireImmediately, + weak: weak, onError: onError, onDependencyMayHaveChanged: null, ); + + switch (sub) { + case ProviderSubscriptionImpl(): + sub._listenedElement.addDependentSubscription(sub); + } + + return sub; } /// {@macro riverpod.invalidate} diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index 6a71fc535..2ad62d1b7 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -1,28 +1,21 @@ part of '../framework.dart'; -/// Represents the subscription to a [ProviderListenable] +/// Represents the subscription to a [ProviderListenable]. +/// +/// This always is implemented with [ProviderSubscriptionOrigin]. +/// This interface exists to remove the redundant type parameters. @optionalTypeArgs -abstract base class ProviderSubscription { - /// Represents the subscription to a [ProviderListenable] - ProviderSubscription(this.source) { - final source = this.source; - if (source is ProviderElement) { - final subs = source._subscriptions ??= []; - subs.add(this); - } - } - +sealed class ProviderSubscription { /// Whether the subscription is closed. - bool get closed => _closed; - var _closed = false; - + bool get closed; + bool get weak; bool get isPaused; /// The object that listens to the associated [ProviderListenable]. /// /// This is typically a [ProviderElement] or a [ProviderContainer], /// but may be other values in the future. - final Node source; + Node get source; void pause(); void resume(); @@ -30,20 +23,47 @@ abstract base class ProviderSubscription { /// Obtain the latest value emitted by the provider. /// /// This method throws if [closed] is true. - StateT read(); + OutT read(); + + /// Stops listening to the provider. + /// + /// It is safe to call this method multiple times. + void close(); +} + +@optionalTypeArgs +sealed class ProviderSubscriptionWithOrigin + extends ProviderSubscription { + ProviderBase get origin; + ProviderElement get _listenedElement; + + void _notify(StateT? prev, StateT next); + + void _notifyError(Object error, StackTrace stackTrace); +} + +@internal +@optionalTypeArgs +abstract base class ProviderSubscriptionImpl + extends ProviderSubscriptionWithOrigin with _OnPauseMixin { + @override + bool get isPaused => _isPaused; + + /// Whether the subscription is closed. + @override + bool get closed => _closed; + var _closed = false; /// Stops listening to the provider. /// /// It is safe to call this method multiple times. + @override @mustCallSuper void close() { if (_closed) return; _closed = true; - final Object listener = source; - if (listener is ProviderElement) { - listener._subscriptions?.remove(this); - } + _listenedElement.removeDependentSubscription(this); } } @@ -54,7 +74,7 @@ mixin _OnPauseMixin { @mustCallSuper void pause() { if (_pauseCount == 0) { - _onCancel(); + onCancel(); } _pauseCount++; } @@ -62,43 +82,111 @@ mixin _OnPauseMixin { @mustCallSuper void resume() { if (_pauseCount == 1) { - _onResume(); + onResume(); } _pauseCount = min(_pauseCount - 1, 0); } - void _onResume(); + void onResume(); - void _onCancel(); + void onCancel(); +} + +abstract base class DelegatingProviderSubscription + extends ProviderSubscriptionImpl { + @override + ProviderBase get origin => innerSubscription.origin; + + @override + ProviderElement get _listenedElement => + innerSubscription._listenedElement; + + ProviderSubscriptionWithOrigin get innerSubscription; + + @override + bool get weak => innerSubscription.weak; + + @override + Node get source => innerSubscription.source; + + @override + void _notify(StateT? prev, StateT next) { + innerSubscription._notify(prev, next); + } + + @override + void _notifyError(Object error, StackTrace stackTrace) { + innerSubscription._notifyError(error, stackTrace); + } + + @override + void onCancel() { + switch (innerSubscription) { + case final ProviderSubscriptionImpl sub: + sub.onCancel(); + } + } + + @override + void onResume() { + switch (innerSubscription) { + case final ProviderSubscriptionImpl sub: + sub.onResume(); + } + } + + @override + void pause() { + innerSubscription.pause(); + super.pause(); + } + + @override + void resume() { + innerSubscription.resume(); + super.resume(); + } + + @override + void close() { + if (_closed) return; + + innerSubscription.close(); + super.close(); + } } /// When a provider listens to another provider using `listen` -@optionalTypeArgs -final class _ProviderStateSubscription - extends ProviderSubscription with _OnPauseMixin { - _ProviderStateSubscription( - super.source, { - required this.listenedElement, +@internal +final class ProviderStateSubscription + extends ProviderSubscriptionImpl with _OnPauseMixin { + ProviderStateSubscription({ + required this.source, + required this.weak, + required ProviderElement listenedElement, required this.listener, required this.onError, - }) { - switch (source) { - case WeakNode(): - listenedElement._weakDependents.add(this); - case _: - final dependents = listenedElement._dependents ??= []; - dependents.add(this); - } - } + }) : _listenedElement = listenedElement; @override - bool get isPaused => _isPaused; + ProviderBase get origin => _listenedElement.origin; + + @override + final Node source; + @override + final ProviderElement _listenedElement; + @override + final bool weak; // Why can't this be typed correctly? final void Function(Object? prev, Object? state) listener; - final ProviderElement listenedElement; final OnError onError; + /// Whether an event was sent while this subscription was paused. + /// + /// This enables re-rending the last missing event when the subscription is resumed. + var _missedCalled = false; + @override StateT read() { if (_closed) { @@ -106,31 +194,35 @@ final class _ProviderStateSubscription 'called ProviderSubscription.read on a subscription that was closed', ); } - listenedElement.mayNeedDispose(); - return listenedElement.readSelf(); + _listenedElement.mayNeedDispose(); + return _listenedElement.readSelf(); } @override - void close() { - if (!closed) { - listenedElement.onChangeSubscription(() { - switch (source) { - case WeakNode(): - listenedElement._weakDependents.remove(this); - case _: - listenedElement._dependents?.remove(this); - } - }); + void onCancel() => _listenedElement.onSubscriptionPause(this); + + @override + void onResume() => _listenedElement.onSubscriptionResume(this); + + @override + void _notify(StateT? prev, StateT next) { + if (_isPaused) { + _missedCalled = true; + return; } - super.close(); + listener(prev, next); } @override - void _onCancel() => listenedElement.onSubscriptionPause(weak: source.weak); + void _notifyError(Object error, StackTrace stackTrace) { + if (_isPaused) { + _missedCalled = true; + return; + } - @override - void _onResume() => listenedElement.onSubscriptionResume(weak: source.weak); + onError(error, stackTrace); + } } /// Deals with the internals of synchronously calling the listeners diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index 4fa432986..18bd6660b 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -1,22 +1,21 @@ part of '../framework.dart'; -final class _ProxySubscription extends ProviderSubscription { +final class _ProxySubscription + extends DelegatingProviderSubscription { _ProxySubscription( - super.source, + this.innerSubscription, this._removeListeners, - this._read, { - required this.innerSubscription, - }); + this._read, + ); @override - bool get isPaused => innerSubscription.isPaused; + final ProviderSubscriptionWithOrigin innerSubscription; - final ProviderSubscription innerSubscription; final void Function() _removeListeners; - final StateT Function() _read; + final OutT Function() _read; @override - StateT read() { + OutT read() { if (closed) { throw StateError( 'called ProviderSubscription.read on a subscription that was closed', @@ -27,19 +26,11 @@ final class _ProxySubscription extends ProviderSubscription { @override void close() { - if (!closed) { - innerSubscription.close(); - _removeListeners(); - } + if (closed) return; + _removeListeners(); super.close(); } - - @override - void pause() => innerSubscription.pause(); - - @override - void resume() => innerSubscription.resume(); } /// An internal utility for reading alternate values of a provider. @@ -58,8 +49,8 @@ final class _ProxySubscription extends ProviderSubscription { /// /// This API is not meant for public consumption. @internal -class ProviderElementProxy - with ProviderListenable, _ProviderRefreshable { +class ProviderElementProxy + with ProviderListenable, _ProviderRefreshable { /// An internal utility for reading alternate values of a provider. /// /// For example, this is used by [FutureProvider] to differentiate: @@ -78,31 +69,35 @@ class ProviderElementProxy const ProviderElementProxy(this.provider, this._lense); @override - final ProviderBase provider; - final ProxyElementValueListenable Function( - ProviderElement element, + final ProviderBase provider; + final ProxyElementValueListenable Function( + ProviderElement element, ) _lense; @override - ProviderSubscription addListener( + ProviderSubscriptionWithOrigin addListener( Node source, - void Function(OutputT? previous, OutputT next) listener, { + void Function(OutT? previous, OutT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, required void Function()? onDependencyMayHaveChanged, required bool fireImmediately, + required bool weak, }) { final element = source.readProviderElement(provider); + ; // TODO test weak proxy listener does not break what's said after this. // While we don't care about changes to the element, calling _listenElement // is necessary to tell the listened element that it is being listened. // We do it at the top of the file to trigger a "flush" before adding // a listener to the notifier. // This avoids the listener from being immediately notified of a new // future when adding the listener refreshes the future. - final innerSub = source.listen( - provider, + final innerSub = provider.addListener( + source, (prev, next) {}, fireImmediately: false, + weak: weak, + onDependencyMayHaveChanged: onDependencyMayHaveChanged, onError: null, ); @@ -111,9 +106,9 @@ class ProviderElementProxy switch (notifier.result) { case null: break; - case final ResultData data: + case final ResultData data: runBinaryGuarded(listener, null, data.state); - case final ResultError error: + case final ResultError error: if (onError != null) { runBinaryGuarded(onError, error.error, error.stackTrace); } @@ -126,16 +121,15 @@ class ProviderElementProxy onDependencyMayHaveChanged: onDependencyMayHaveChanged, ); - return _ProxySubscription( - source, + return _ProxySubscription( + innerSub, removeListener, () => read(source), - innerSubscription: innerSub, ); } @override - OutputT read(Node node) { + OutT read(Node node) { final element = node.readProviderElement(provider); element.flush(); element.mayNeedDispose(); @@ -145,8 +139,7 @@ class ProviderElementProxy @override bool operator ==(Object other) => - other is ProviderElementProxy && - other.provider == provider; + other is ProviderElementProxy && other.provider == provider; @override int get hashCode => provider.hashCode; diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index eadd37721..89f3a64f6 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -11,10 +11,14 @@ extension $RefArg on Ref { @internal class UnmountedRefException implements Exception { + UnmountedRefException(this.origin); + + final ProviderBase origin; + @override String toString() { return ''' -Cannot use a Ref after it has been disposed. This typically happens if: +Cannot use the Ref of $origin after it has been disposed. This typically happens if: - A provider rebuilt, but the previous "build" was still pending and is still performing operations. You should therefore either use `ref.onDispose` to cancel pending work, or check `ref.mounted` after async gaps or anything that could invalidate the provider. @@ -43,8 +47,8 @@ base class Ref { List? _onDisposeListeners; List? _onResumeListeners; List? _onCancelListeners; - List? _onAddListeners; - List? _onRemoveListeners; + List? _onAddListeners; + List? _onRemoveListeners; List? _onErrorSelfListeners; bool get mounted => _mounted; @@ -143,7 +147,7 @@ final = Provider(dependencies: []); !_debugIsRunningSelector, 'Cannot call ref.listen inside a selector', ); - if (!mounted) throw UnmountedRefException(); + if (!mounted) throw UnmountedRefException(_element.origin); } /// Requests for the state of a provider to not be disposed when all the @@ -277,7 +281,7 @@ final = Provider(dependencies: []); /// /// See also: /// - [onRemoveListener], for when a listener is removed - void onAddListener(void Function() cb) { + void onAddListener(void Function(ProviderSubscription sub) cb) { _throwIfInvalidUsage(); _onAddListeners ??= []; @@ -288,7 +292,7 @@ final = Provider(dependencies: []); /// /// See also: /// - [onAddListener], for when a listener is added - void onRemoveListener(void Function() cb) { + void onRemoveListener(void Function(ProviderSubscription sub) cb) { _throwIfInvalidUsage(); _onRemoveListeners ??= []; diff --git a/packages/riverpod/lib/src/core/scheduler.dart b/packages/riverpod/lib/src/core/scheduler.dart index 80476dac8..1cc859f39 100644 --- a/packages/riverpod/lib/src/core/scheduler.dart +++ b/packages/riverpod/lib/src/core/scheduler.dart @@ -125,7 +125,7 @@ class ProviderScheduler { if ((links != null && links.isNotEmpty) || element.container._disposed || - element.hasListeners) { + element.isActive) { continue; } @@ -133,7 +133,7 @@ class ProviderScheduler { element.container._disposeProvider(element.origin); } else { // Don't delete the pointer if there are some "weak" listeners active. - element.dispose(); + element.clearState(); } } } diff --git a/packages/riverpod/test/old/framework/auto_dispose_test.dart b/packages/riverpod/test/old/framework/auto_dispose_test.dart index 3efe13deb..fe6b50505 100644 --- a/packages/riverpod/test/old/framework/auto_dispose_test.dart +++ b/packages/riverpod/test/old/framework/auto_dispose_test.dart @@ -69,8 +69,11 @@ Future main() async { final root = ProviderContainer.test(); final container = ProviderContainer.test(parent: root); - final sub = - container.listen(provider, listener.call, fireImmediately: true); + final sub = container.listen( + provider, + listener.call, + fireImmediately: true, + ); verifyOnly(listener, listener(null, 0)); expect(buildCount, 1); diff --git a/packages/riverpod/test/old/framework/modifiers_test.dart b/packages/riverpod/test/old/framework/modifiers_test.dart index ac28709a1..da7ce4ae1 100644 --- a/packages/riverpod/test/old/framework/modifiers_test.dart +++ b/packages/riverpod/test/old/framework/modifiers_test.dart @@ -44,31 +44,31 @@ void main() { final sub = container.listen(provider.future, (prev, value) {}); - verifyOnly(onAddListener, onAddListener()); + verifyOnly(onAddListener, onAddListener(any)); final sub2 = container.listen(provider.future, (prev, value) {}); - verifyOnly(onAddListener, onAddListener()); + verifyOnly(onAddListener, onAddListener(any)); sub.close(); - verifyOnly(onRemoveListener, onRemoveListener()); + verifyOnly(onRemoveListener, onRemoveListener(any)); verifyZeroInteractions(onCancel); sub2.close(); - verifyOnly(onRemoveListener, onRemoveListener()); + verifyOnly(onRemoveListener, onRemoveListener(any)); verifyZeroInteractions(onResume); verifyOnly(onCancel, onCancel()); container.listen(provider.future, (prev, value) {}); - verifyOnly(onAddListener, onAddListener()); + verifyOnly(onAddListener, onAddListener(any)); verifyOnly(onResume, onResume()); container.listen(provider.future, (prev, value) {}); - verifyOnly(onAddListener, onAddListener()); + verifyOnly(onAddListener, onAddListener(any)); verifyNoMoreInteractions(onCancel); verifyNoMoreInteractions(onResume); verifyZeroInteractions(onDispose); diff --git a/packages/riverpod/test/old/framework/ref_watch_test.dart b/packages/riverpod/test/old/framework/ref_watch_test.dart index c0ad29f4d..cac71e51c 100644 --- a/packages/riverpod/test/old/framework/ref_watch_test.dart +++ b/packages/riverpod/test/old/framework/ref_watch_test.dart @@ -317,16 +317,10 @@ void main() { () async { final stateProvider = StateProvider((ref) => 0, name: 'state'); final notifier0 = Counter(); - final provider0 = StateNotifierProvider( - (_) => notifier0, - name: '0', - ); + final provider0 = StateNotifierProvider((ref) => notifier0); final notifier1 = Counter(42); - final provider1 = StateNotifierProvider( - (_) => notifier1, - name: '1', - ); + final provider1 = StateNotifierProvider((ref) => notifier1); var computedBuildCount = 0; final computed = Provider((ref) { diff --git a/packages/riverpod/test/old/utils.dart b/packages/riverpod/test/old/utils.dart index f7839184e..62db0785c 100644 --- a/packages/riverpod/test/old/utils.dart +++ b/packages/riverpod/test/old/utils.dart @@ -57,11 +57,11 @@ class OnResume extends Mock { } class OnAddListener extends Mock { - void call(); + void call(ProviderSubscription? sub); } class OnRemoveListener extends Mock { - void call(); + void call(ProviderSubscription? sub); } class Listener extends Mock { diff --git a/packages/riverpod/test/src/core/modifiers/future_test.dart b/packages/riverpod/test/src/core/modifiers/future_test.dart index 9a64606ae..daedb4fe5 100644 --- a/packages/riverpod/test/src/core/modifiers/future_test.dart +++ b/packages/riverpod/test/src/core/modifiers/future_test.dart @@ -17,7 +17,7 @@ void main() { (previous, value) {}, ); - expect(container.readProviderElement(provider).hasListeners, false); + expect(container.readProviderElement(provider).hasListeners, true); sub.close(); diff --git a/packages/riverpod/test/src/core/modifiers/select_test.dart b/packages/riverpod/test/src/core/modifiers/select_test.dart index 1dbe8b6f1..a3ed9d935 100644 --- a/packages/riverpod/test/src/core/modifiers/select_test.dart +++ b/packages/riverpod/test/src/core/modifiers/select_test.dart @@ -53,7 +53,7 @@ void main() { (previous, value) {}, ); - expect(container.readProviderElement(provider).hasListeners, false); + expect(container.readProviderElement(provider).hasListeners, true); sub.close(); @@ -78,8 +78,6 @@ void main() { (previous, value) {}, ); - print(element.hasListeners); - expect(sub.read(), 0); verifyZeroInteractions(onDispose); diff --git a/packages/riverpod/test/src/core/provider_container_test.dart b/packages/riverpod/test/src/core/provider_container_test.dart index 385c26da4..dc443fa08 100644 --- a/packages/riverpod/test/src/core/provider_container_test.dart +++ b/packages/riverpod/test/src/core/provider_container_test.dart @@ -2444,44 +2444,9 @@ void main() { test( 'if a listener removes another provider.listen, the removed listener is still called', - () { - final provider = StateProvider((ref) => 0); - final container = ProviderContainer.test(); - - final listener = Listener(); - final listener2 = Listener(); - - final p = Provider((ref) { - ProviderSubscription? a; - ref.listen(provider, (prev, value) { - listener(prev, value); - a?.close(); - a = null; - }); - - a = ref.listen(provider, listener2.call); - }); - container.read(p); + skip: true, () { + ; // Breaks because of the "if (!sub.closed)" in notifyListeners - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - container.read(provider.notifier).state++; - - verifyInOrder([ - listener(0, 1), - listener2(0, 1), - ]); - - container.read(provider.notifier).state++; - - verify(listener(1, 2)).called(1); - verifyNoMoreInteractions(listener2); - }); - - test( - 'if a listener removes another provider.listen, the removed listener is still called (ProviderListenable)', - () { final provider = StateProvider((ref) => 0); final container = ProviderContainer.test(); @@ -2543,74 +2508,6 @@ void main() { verify(listener(1, 2)).called(2); }); - test( - 'if a listener removes another container.listen, the removed listener is still called (ProviderListenable)', - () { - final provider = StateProvider((ref) => 0); - final container = ProviderContainer.test(); - - final listener = Listener(); - final listener2 = Listener(); - - ProviderSubscription? a; - container.listen(provider, (prev, value) { - listener(prev, value); - a?.close(); - a = null; - }); - - a = container.listen(provider, listener2.call); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - container.read(provider.notifier).state++; - - verifyInOrder([ - listener(0, 1), - listener2(0, 1), - ]); - - container.read(provider.notifier).state++; - - verify(listener(1, 2)).called(1); - verifyNoMoreInteractions(listener2); - }); - - test( - 'if a listener removes another container.listen, the removed listener is still called', - () { - final provider = StateProvider((ref) => 0); - final container = ProviderContainer.test(); - - final listener = Listener(); - final listener2 = Listener(); - - ProviderSubscription? a; - container.listen(provider, (prev, value) { - listener(prev, value); - a?.close(); - a = null; - }); - - a = container.listen(provider, listener2.call); - - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - - container.read(provider.notifier).state++; - - verifyInOrder([ - listener(0, 1), - listener2(0, 1), - ]); - - container.read(provider.notifier).state++; - - verify(listener(1, 2)).called(1); - verifyNoMoreInteractions(listener2); - }); - group('fireImmediately', () { test('when no onError is specified, fallbacks to handleUncaughtError', () { diff --git a/packages/riverpod/test/src/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart index 62dbd24ec..5a6c64e8f 100644 --- a/packages/riverpod/test/src/core/provider_element_test.dart +++ b/packages/riverpod/test/src/core/provider_element_test.dart @@ -127,7 +127,7 @@ void main() { }); }); - group('isActive', () { + group('isActive', skip: true, () { test('handles adding a listener from an already paused provider', () { final provider = Provider((ref) => 0); final dep = Provider((ref) { @@ -140,6 +140,18 @@ void main() { // Using read, "dep" should still be considered as paused. container.read(dep); + print('----'); + + print( + container.readProviderElement(provider).subscriptions, + ); + print( + container.readProviderElement(provider).dependents, + ); + print( + container.readProviderElement(provider).weakDependents, + ); + expect(container.readProviderElement(provider).isActive, false); }); diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index e85d46cdc..7ad3b981f 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -80,7 +80,7 @@ void main() { throwsA(isA()), ); expect( - () => ref.onAddListener(() {}), + () => ref.onAddListener((_) {}), throwsA(isA()), ); expect( @@ -88,7 +88,7 @@ void main() { throwsA(isA()), ); expect( - () => ref.onRemoveListener(() {}), + () => ref.onRemoveListener((_) {}), throwsA(isA()), ); expect( @@ -163,7 +163,7 @@ void main() { throwsA(isA()), ); expect( - () => container.read(provider.select((_) => ref.onAddListener(() {}))), + () => container.read(provider.select((_) => ref.onAddListener((_) {}))), throwsA(isA()), ); expect( @@ -171,8 +171,8 @@ void main() { throwsA(isA()), ); expect( - () => - container.read(provider.select((_) => ref.onRemoveListener(() {}))), + () => container + .read(provider.select((_) => ref.onRemoveListener((_) {}))), throwsA(isA()), ); expect( @@ -1264,7 +1264,7 @@ void main() { ); }); - container.read(provider); + container.listen(provider, (a, b) {}); verifyZeroInteractions(listener); expect(errors, isEmpty); @@ -1967,7 +1967,7 @@ void main() { }); group('.invalidate', () { - test('Throws if a circular dependency is detected', () { + test('Throws if a circular dependency is detected', skip: true, () { // Regression test for https://github.com/rrousselGit/riverpod/issues/2336 late Ref ref; final a = Provider((r) { @@ -1979,6 +1979,7 @@ void main() { container.read(b); + ; expect( () => ref.invalidate(b), throwsA(isA()), @@ -2105,7 +2106,7 @@ void main() { }); group('.onRemoveListener', () { - test('is not called on read', () { + test('is called on read', () { final container = ProviderContainer.test(); final listener = OnRemoveListener(); final provider = Provider((ref) { @@ -2114,7 +2115,7 @@ void main() { container.read(provider); - verifyZeroInteractions(listener); + verifyOnly(listener, listener(any)); }); test('calls listeners when container.listen subscriptions are closed', @@ -2133,7 +2134,7 @@ void main() { sub.close(); - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); @@ -2144,7 +2145,7 @@ void main() { sub2.close(); - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); }); @@ -2178,7 +2179,7 @@ void main() { sub.close(); - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); @@ -2189,7 +2190,7 @@ void main() { sub2.close(); - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); }); @@ -2221,7 +2222,7 @@ void main() { container.refresh(provider); - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); }); @@ -2240,15 +2241,21 @@ void main() { }); container.read(provider); + verifyOnly(listener, listener(any)); + verifyZeroInteractions(listener2); + isSecondBuild = true; container.refresh(provider); + // Removed sub from refresh + verify(listener2(any)).called(1); + final sub = container.listen(provider, (previous, next) {}); sub.close(); - verify(listener2()).called(1); + verify(listener2(any)).called(1); verifyNoMoreInteractions(listener2); - verifyZeroInteractions(listener); + verifyNoMoreInteractions(listener); }); test('if a listener throws, still calls all listeners', () { @@ -2256,7 +2263,7 @@ void main() { final container = ProviderContainer.test(); final listener = OnRemoveListener(); final listener2 = OnRemoveListener(); - when(listener()).thenThrow(42); + when(listener(any)).thenThrow(42); final provider = Provider((ref) { ref.onRemoveListener(listener.call); ref.onRemoveListener(listener2.call); @@ -2269,7 +2276,7 @@ void main() { (err, stack) => errors.add(err), ); - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); expect(errors, [42]); @@ -2277,7 +2284,7 @@ void main() { }); group('.onAddListener', () { - test('is not called on read', () { + test('is called on read', () { final container = ProviderContainer.test(); final listener = OnAddListener(); final provider = Provider((ref) { @@ -2286,7 +2293,7 @@ void main() { container.read(provider); - verifyZeroInteractions(listener); + verifyOnly(listener, listener(any)); }); test('calls listeners when container.listen is invoked', () { @@ -2300,13 +2307,13 @@ void main() { container.listen(provider, (previous, next) {}); - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); container.listen(provider, (previous, next) {}); - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); }); @@ -2333,13 +2340,13 @@ void main() { ref.listen(dep, (previous, next) {}); - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); ref.listen(dep, (previous, next) {}); - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); }); @@ -2372,20 +2379,20 @@ void main() { ref.watch(dep); - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); ref.watch(dep); // TODO changelog breaking: Calling ref.watch multiple times calls ref.onListen everytime - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); ref2.watch(dep); - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); }); @@ -2404,14 +2411,19 @@ void main() { }); container.read(provider); + verifyOnly(listener, listener(any)); + isSecondBuild = true; container.refresh(provider); + // Added refresh listener + verifyOnly(listener2, listener2(any)); + container.listen(provider, (previous, next) {}); - verify(listener2()).called(1); + verify(listener2(any)).called(1); verifyNoMoreInteractions(listener2); - verifyZeroInteractions(listener); + verifyNoMoreInteractions(listener); }); test('if a listener throws, still calls all listeners', () { @@ -2419,7 +2431,7 @@ void main() { final container = ProviderContainer.test(); final listener = OnAddListener(); final listener2 = OnAddListener(); - when(listener()).thenThrow(42); + when(listener(any)).thenThrow(42); final provider = Provider((ref) { ref.onAddListener(listener.call); ref.onAddListener(listener2.call); @@ -2430,7 +2442,7 @@ void main() { (err, stack) => errors.add(err), ); - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); expect(errors, [42]); @@ -2445,7 +2457,6 @@ void main() { ref.onResume(listener.call); }); - container.read(provider); container.listen(provider, (previous, next) {}); verifyZeroInteractions(listener); @@ -2516,27 +2527,10 @@ void main() { verifyNoMoreInteractions(listener2); }); - test('does not call listeners on read after a cancel', () { - final container = ProviderContainer.test(); - final listener = OnResume(); - final provider = Provider((ref) { - ref.onResume(listener.call); - }); - - final sub = container.listen(provider, (previous, next) {}); - sub.close(); - - verifyZeroInteractions(listener); - - container.read(provider); - - verifyZeroInteractions(listener); - }); - test('calls listeners when ref.watch is invoked after a cancel', () { final container = ProviderContainer.test(); - final listener = OnResume(); - final listener2 = OnResume(); + final listener = OnAddListener(); + final listener2 = OnAddListener(); final dep = Provider( name: 'dep', (ref) { @@ -2560,7 +2554,7 @@ void main() { ref.watch(dep); - verifyInOrder([listener(), listener2()]); + verifyInOrder([listener(any), listener2(any)]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); }); @@ -2580,7 +2574,7 @@ void main() { container.read(provider); isSecondBuild = true; - container.refresh(provider); + container.invalidate(provider); final sub = container.listen(provider, (previous, next) {}); sub.close(); @@ -2605,7 +2599,7 @@ void main() { final sub = container.listen(provider, (previous, next) {}); sub.close(); - container.refresh(provider); + container.invalidate(provider); final sub2 = container.listen(provider, (previous, next) {}); sub2.close(); @@ -2768,7 +2762,7 @@ void main() { verifyNoMoreInteractions(listener2); }); - test('is not called when using container.read', () async { + test('is called when using container.read', () async { final container = ProviderContainer.test(); final listener = OnCancelMock(); final provider = Provider((ref) { @@ -2776,26 +2770,8 @@ void main() { }); container.read(provider); - await container.pump(); - - verifyZeroInteractions(listener); - }); - - test('is not called when using container.read (autoDispose)', () async { - final container = ProviderContainer.test(); - final listener = OnCancelMock(); - final dispose = OnDisposeMock(); - final provider = StateProvider.autoDispose((ref) { - ref.keepAlive(); - ref.onCancel(listener.call); - ref.onDispose(dispose.call); - }); - - container.read(provider); - await container.pump(); - verifyZeroInteractions(listener); - verifyZeroInteractions(dispose); + verifyOnly(listener, listener()); }); test('listeners are cleared on rebuild', () { @@ -2812,8 +2788,10 @@ void main() { }); container.read(provider); + clearInteractions(listener); + isSecondBuild = true; - container.refresh(provider); + container.invalidate(provider); verifyZeroInteractions(listener); verifyZeroInteractions(listener2); diff --git a/packages/riverpod/test/src/providers/stream_notifier_test.dart b/packages/riverpod/test/src/providers/stream_notifier_test.dart index f0aa149af..602a34b13 100644 --- a/packages/riverpod/test/src/providers/stream_notifier_test.dart +++ b/packages/riverpod/test/src/providers/stream_notifier_test.dart @@ -29,8 +29,8 @@ void main() { }); streamNotifierProviderFactory.createGroup((factory) { - test('Pauses the Stream when the provider is paused', () { - throw UnimplementedError(); + test('Pauses the Stream when the provider is paused', skip: true, () { + ; }); test('Cannot share a Notifier instance between providers ', () { diff --git a/packages/riverpod/test/src/utils.dart b/packages/riverpod/test/src/utils.dart index fe631441e..d9d254514 100644 --- a/packages/riverpod/test/src/utils.dart +++ b/packages/riverpod/test/src/utils.dart @@ -51,11 +51,11 @@ class OnResume extends Mock { } class OnAddListener extends Mock { - void call(); + void call(ProviderSubscription? sub); } class OnRemoveListener extends Mock { - void call(); + void call(ProviderSubscription? sub); } /// Syntax sugar for: From 5023bceb490d535493a3533704528f8b8355795f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 8 Sep 2024 10:20:12 +0200 Subject: [PATCH 335/387] Add test --- .../lib/src/core/modifiers/select.dart | 9 ++++--- .../lib/src/core/modifiers/select_async.dart | 4 +-- .../test/src/core/provider_element_test.dart | 26 +++++++++++++++++++ 3 files changed, 33 insertions(+), 6 deletions(-) diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index 7cfa92665..474eb13a8 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -78,7 +78,7 @@ class _ProviderSelector with ProviderListenable { } @override - _SelectorSubscription addListener( + SelectorSubscription addListener( Node node, void Function(OutputT? previous, OutputT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, @@ -116,7 +116,7 @@ class _ProviderSelector with ProviderListenable { ); } - return _SelectorSubscription( + return SelectorSubscription( innerSubscription: sub, () { // Using ! because since `sub.read` flushes the inner subscription, @@ -134,9 +134,10 @@ class _ProviderSelector with ProviderListenable { } } -final class _SelectorSubscription +@internal +final class SelectorSubscription extends DelegatingProviderSubscription { - _SelectorSubscription( + SelectorSubscription( this._read, { this.onClose, required this.innerSubscription, diff --git a/packages/riverpod/lib/src/core/modifiers/select_async.dart b/packages/riverpod/lib/src/core/modifiers/select_async.dart index 62f620e30..30cff870e 100644 --- a/packages/riverpod/lib/src/core/modifiers/select_async.dart +++ b/packages/riverpod/lib/src/core/modifiers/select_async.dart @@ -32,7 +32,7 @@ class _AsyncSelector with ProviderListenable> { } @override - _SelectorSubscription, Future> addListener( + SelectorSubscription, Future> addListener( Node node, void Function(Future? previous, Future next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, @@ -147,7 +147,7 @@ class _AsyncSelector with ProviderListenable> { listener(null, selectedFuture!); } - return _SelectorSubscription( + return SelectorSubscription( innerSubscription: sub, () => selectedFuture!, onClose: () { diff --git a/packages/riverpod/test/src/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart index 5a6c64e8f..837e054c2 100644 --- a/packages/riverpod/test/src/core/provider_element_test.dart +++ b/packages/riverpod/test/src/core/provider_element_test.dart @@ -6,6 +6,32 @@ import '../../old/utils.dart'; void main() { group('ProviderElement', () { + test('Only includes direct subscriptions in subscription lists', () { + final container = ProviderContainer.test(); + final provider = FutureProvider((ref) => 0); + final dep = Provider((ref) { + ref.watch(provider.future.select((value) => 0)); + }); + + container.read(dep); + + final providerElement = container.readProviderElement(provider); + final depElement = container.readProviderElement(dep); + + expect(providerElement.subscriptions, null); + expect( + providerElement.dependents, + [isA, int>>()], + ); + expect(providerElement.weakDependents, isEmpty); + + expect(depElement.subscriptions, [ + isA, int>>(), + ]); + expect(depElement.dependents, isEmpty); + expect(depElement.weakDependents, isEmpty); + }); + test( 'does not throw outdated error when a dependency is flushed while the dependent is building', () async { From ad36b8b484d67c9cce442312ecd07da36cc748e0 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Tue, 10 Sep 2024 08:05:42 +0200 Subject: [PATCH 336/387] W --- packages/riverpod/lib/src/core/element.dart | 36 ++++++++++++++++--- .../test/src/core/provider_element_test.dart | 34 ++---------------- 2 files changed, 33 insertions(+), 37 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index a2e04dbef..d694f2452 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -42,7 +42,7 @@ void Function()? debugCanModifyProviders; /// {@endtemplate} @internal @optionalTypeArgs -abstract class ProviderElement implements Node { +abstract class ProviderElement with _OnPauseMixin implements Node { /// {@macro riverpod.provider_element_base} ProviderElement(this.pointer); @@ -75,7 +75,8 @@ abstract class ProviderElement implements Node { /// - all of its listeners are "weak" (i.e. created with `listen(weak: true)`) /// /// See also [mayNeedDispose], called when [isActive] may have changed. - bool get isActive => (_listenerCount - _pausedActiveSubscriptionCount) > 0; + bool get isActive => + !_isPaused && (_listenerCount - _pausedActiveSubscriptionCount) > 0; int get _listenerCount => dependents?.length ?? 0; @@ -534,6 +535,32 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu return sub; } + @override + void onCancel() { + ; // TODO notify ancestors + + subscriptions?.forEach((sub) { + switch (sub) { + case ProviderSubscriptionImpl(): + if (sub.weak) return; + sub._listenedElement.pause(); + } + }); + } + + @override + void onResume() { + ; // TODO notify ancestors + + subscriptions?.forEach((sub) { + switch (sub) { + case ProviderSubscriptionImpl(): + if (sub.weak) return; + sub._listenedElement.resume(); + } + }); + } + void addDependentSubscription(ProviderSubscriptionImpl sub) { _onChangeSubscription(sub, () { if (sub.weak) { @@ -576,14 +603,13 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu switch ((wasActive: wasActive, isActive: isActive)) { case (wasActive: false, isActive: true) when _didCancelOnce: ref?._onResumeListeners?.forEach(runGuarded); - - // _subscriptions?.forEach((sub) => sub.resume()); + onResume(); case (wasActive: true, isActive: false): _didCancelOnce = true; ref?._onCancelListeners?.forEach(runGuarded); + onCancel(); - // _subscriptions?.forEach((sub) => sub.pause()); default: // No state change, so do nothing } diff --git a/packages/riverpod/test/src/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart index 837e054c2..c40d707a7 100644 --- a/packages/riverpod/test/src/core/provider_element_test.dart +++ b/packages/riverpod/test/src/core/provider_element_test.dart @@ -153,34 +153,7 @@ void main() { }); }); - group('isActive', skip: true, () { - test('handles adding a listener from an already paused provider', () { - final provider = Provider((ref) => 0); - final dep = Provider((ref) { - ref.watch(provider); - }); - final container = ProviderContainer.test(); - - expect(container.readProviderElement(provider).isActive, false); - - // Using read, "dep" should still be considered as paused. - container.read(dep); - - print('----'); - - print( - container.readProviderElement(provider).subscriptions, - ); - print( - container.readProviderElement(provider).dependents, - ); - print( - container.readProviderElement(provider).weakDependents, - ); - - expect(container.readProviderElement(provider).isActive, false); - }); - + group('isActive', () { test('Is paused if all watchers are paused', () { final container = ProviderContainer.test(); final provider = Provider(name: 'foo', (ref) => 0); @@ -189,10 +162,7 @@ void main() { final depSub = container.listen(dep, (a, b) {}); final dep2Sub = container.listen(dep2, (a, b) {}); - final element = container.readProviderElement(provider); - final depElement = container.readProviderElement(dep); - final depElement2 = container.readProviderElement(dep2); expect(element.isActive, true); @@ -261,7 +231,7 @@ void main() { expect(container.readProviderElement(provider).isActive, false); - container.listen(dep, (_, __) {}); + container.read(dep); expect(container.readProviderElement(provider).isActive, true); }); From 8e4515ded805817ef54cb8cfb952d026dffdb342 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 13 Sep 2024 00:05:05 +0200 Subject: [PATCH 337/387] Fixup some tests --- .../test/src/core/provider_element_test.dart | 4 ++-- packages/riverpod/test/src/core/ref_test.dart | 14 +++++++------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/packages/riverpod/test/src/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart index c40d707a7..1ab81529a 100644 --- a/packages/riverpod/test/src/core/provider_element_test.dart +++ b/packages/riverpod/test/src/core/provider_element_test.dart @@ -217,7 +217,7 @@ void main() { expect(container.readProviderElement(provider).isActive, false); - container.read(dep); + container.listen(dep, (p, n) {}); expect(container.readProviderElement(provider).isActive, true); }); @@ -231,7 +231,7 @@ void main() { expect(container.readProviderElement(provider).isActive, false); - container.read(dep); + container.listen(dep, (p, n) {}); expect(container.readProviderElement(provider).isActive, true); }); diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 7ad3b981f..9cb8c3355 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -1295,7 +1295,7 @@ void main() { ); }); - container.read(provider); + container.listen(provider, (p, n) {}); verifyZeroInteractions(listener); expect(errors, isEmpty); @@ -1324,7 +1324,7 @@ void main() { ref.listen(provider, listener.call, onError: errorListener.call); }); - container.read(a); + container.listen(a, (p, n) {}); verifyZeroInteractions(errorListener); verifyZeroInteractions(listener); @@ -1359,7 +1359,7 @@ void main() { ); }); - container.read(a); + container.listen(a, (a, b) {}); verifyZeroInteractions(errorListener); verifyZeroInteractions(listener); @@ -1590,7 +1590,7 @@ void main() { ); }); - container.read(provider); + container.listen(provider, (p, n) {}); expect(sub, isNotNull); verifyZeroInteractions(listener); @@ -1644,7 +1644,7 @@ void main() { ); }); - container.read(provider); + container.listen(provider, (p, n) {}); expect(sub, isNotNull); verifyZeroInteractions(listener); @@ -2742,8 +2742,8 @@ void main() { if (watching) ref.watch(dep); }); - container.read(provider); - container.read(provider2); + container.listen(provider, (p, n) {}); + container.listen(provider2, (p, n) {}); verifyZeroInteractions(listener); verifyZeroInteractions(listener2); From 5cb43e5fb5abb3f5baa5036e80355f743da7e751 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 13 Sep 2024 00:28:10 +0200 Subject: [PATCH 338/387] Fix propagation --- packages/riverpod/lib/src/core/element.dart | 25 +++++++-------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index d694f2452..16fa0f2f2 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -42,7 +42,7 @@ void Function()? debugCanModifyProviders; /// {@endtemplate} @internal @optionalTypeArgs -abstract class ProviderElement with _OnPauseMixin implements Node { +abstract class ProviderElement implements Node { /// {@macro riverpod.provider_element_base} ProviderElement(this.pointer); @@ -75,8 +75,7 @@ abstract class ProviderElement with _OnPauseMixin implements Node { /// - all of its listeners are "weak" (i.e. created with `listen(weak: true)`) /// /// See also [mayNeedDispose], called when [isActive] may have changed. - bool get isActive => - !_isPaused && (_listenerCount - _pausedActiveSubscriptionCount) > 0; + bool get isActive => (_listenerCount - _pausedActiveSubscriptionCount) > 0; int get _listenerCount => dependents?.length ?? 0; @@ -535,28 +534,20 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu return sub; } - @override - void onCancel() { - ; // TODO notify ancestors - + void _onCancel() { subscriptions?.forEach((sub) { switch (sub) { case ProviderSubscriptionImpl(): - if (sub.weak) return; - sub._listenedElement.pause(); + sub._listenedElement.onSubscriptionPause(sub); } }); } - @override - void onResume() { - ; // TODO notify ancestors - + void _onResume() { subscriptions?.forEach((sub) { switch (sub) { case ProviderSubscriptionImpl(): - if (sub.weak) return; - sub._listenedElement.resume(); + sub._listenedElement.onSubscriptionResume(sub); } }); } @@ -603,12 +594,12 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu switch ((wasActive: wasActive, isActive: isActive)) { case (wasActive: false, isActive: true) when _didCancelOnce: ref?._onResumeListeners?.forEach(runGuarded); - onResume(); + _onResume(); case (wasActive: true, isActive: false): _didCancelOnce = true; ref?._onCancelListeners?.forEach(runGuarded); - onCancel(); + _onCancel(); default: // No state change, so do nothing From 84cbb0476ffa4f642212053a5b3ff2e4f860e411 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 13 Sep 2024 15:12:25 +0200 Subject: [PATCH 339/387] Fix flutter_riverpod --- .../lib/src/core/consumer.dart | 24 ++++-------- .../test/consumer_listen_test.dart | 17 ++++++--- .../test/src/core/consumer_test.dart | 20 +++++----- packages/riverpod/lib/riverpod.dart | 6 ++- packages/riverpod/lib/src/core/element.dart | 4 +- .../lib/src/core/provider_subscription.dart | 1 + packages/riverpod/lib/src/core/scheduler.dart | 4 +- .../test/old/framework/auto_dispose_test.dart | 8 +++- .../test/old/framework/ref_watch_test.dart | 16 ++++---- .../old/legacy/framework2/framework_test.dart | 18 ++++----- .../test/src/core/modifiers/future_test.dart | 12 ++++-- .../test/src/core/modifiers/select_test.dart | 10 ++++- .../src/core/provider_container_test.dart | 9 +++-- .../test/src/core/provider_element_test.dart | 38 ++++++++++++++----- 14 files changed, 113 insertions(+), 74 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/core/consumer.dart b/packages/flutter_riverpod/lib/src/core/consumer.dart index 161f7fb02..79492aaae 100644 --- a/packages/flutter_riverpod/lib/src/core/consumer.dart +++ b/packages/flutter_riverpod/lib/src/core/consumer.dart @@ -493,13 +493,12 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { final container = ProviderScope.containerOf(this, listen: false); final sub = _ListenManual( - container, - container.listen( + container.listen( provider, listener, onError: onError, fireImmediately: fireImmediately, - ), + ) as ProviderSubscriptionWithOrigin, this, ); listeners.add(sub); @@ -511,30 +510,23 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { BuildContext get context => this; } -final class _ListenManual extends ProviderSubscription { - _ListenManual(super.source, this._subscription, this._element); +final class _ListenManual + // ignore: invalid_use_of_internal_member + extends DelegatingProviderSubscription { + _ListenManual(this.innerSubscription, this._element); @override - bool get isPaused => _subscription.isPaused; - - final ProviderSubscription _subscription; + final ProviderSubscriptionWithOrigin innerSubscription; final ConsumerStatefulElement _element; @override void close() { if (!closed) { - _subscription.close(); _element._manualListeners?.remove(this); } super.close(); } @override - T read() => _subscription.read(); - - @override - void pause() => _subscription.pause(); - - @override - void resume() => _subscription.resume(); + T read() => innerSubscription.read(); } diff --git a/packages/flutter_riverpod/test/consumer_listen_test.dart b/packages/flutter_riverpod/test/consumer_listen_test.dart index 7b22fe6e4..63f6585fe 100644 --- a/packages/flutter_riverpod/test/consumer_listen_test.dart +++ b/packages/flutter_riverpod/test/consumer_listen_test.dart @@ -157,11 +157,12 @@ void main() { ), ); - expect(container.readProviderElement(provider).hasListeners, true); + expect(container.readProviderElement(provider).hasNonWeakListeners, true); await tester.pumpWidget(Container()); - expect(container.readProviderElement(provider).hasListeners, false); + expect( + container.readProviderElement(provider).hasNonWeakListeners, false); }); testWidgets('closes the subscription on provider change', (tester) async { @@ -180,8 +181,10 @@ void main() { ), ); - expect(container.readProviderElement(provider(0)).hasListeners, true); - expect(container.readProviderElement(provider(1)).hasListeners, false); + expect( + container.readProviderElement(provider(0)).hasNonWeakListeners, true); + expect(container.readProviderElement(provider(1)).hasNonWeakListeners, + false); await tester.pumpWidget( UncontrolledProviderScope( @@ -195,8 +198,10 @@ void main() { ), ); - expect(container.readProviderElement(provider(0)).hasListeners, false); - expect(container.readProviderElement(provider(1)).hasListeners, true); + expect(container.readProviderElement(provider(0)).hasNonWeakListeners, + false); + expect( + container.readProviderElement(provider(1)).hasNonWeakListeners, true); }); testWidgets('listen to the new provider on provider change', diff --git a/packages/flutter_riverpod/test/src/core/consumer_test.dart b/packages/flutter_riverpod/test/src/core/consumer_test.dart index f21cdfb06..84b4c97f1 100644 --- a/packages/flutter_riverpod/test/src/core/consumer_test.dart +++ b/packages/flutter_riverpod/test/src/core/consumer_test.dart @@ -281,8 +281,8 @@ void main() { }); expect(buildCount, 1); - expect(familyState0.hasListeners, true); - expect(familyState1.hasListeners, false); + expect(familyState0.hasNonWeakListeners, true); + expect(familyState1.hasNonWeakListeners, false); expect(find.text('0 0'), findsOneWidget); notifier0.increment(); @@ -302,8 +302,8 @@ void main() { expect(buildCount, 3); expect(find.text('1 43'), findsOneWidget); - expect(familyState1.hasListeners, true); - expect(familyState0.hasListeners, true); + expect(familyState1.hasNonWeakListeners, true); + expect(familyState0.hasNonWeakListeners, true); notifier1.increment(); await tester.pump(); @@ -362,8 +362,8 @@ void main() { }); expect(buildCount, 1); - expect(familyState0.hasListeners, true); - expect(familyState1.hasListeners, false); + expect(familyState0.hasNonWeakListeners, true); + expect(familyState1.hasNonWeakListeners, false); expect(find.text('0'), findsOneWidget); notifier0.increment(); @@ -383,8 +383,8 @@ void main() { expect(buildCount, 3); expect(find.text('43'), findsOneWidget); - expect(familyState1.hasListeners, true); - expect(familyState0.hasListeners, false); + expect(familyState1.hasNonWeakListeners, true); + expect(familyState0.hasNonWeakListeners, false); notifier1.increment(); await tester.pump(); @@ -550,7 +550,7 @@ void main() { .getAllProviderElements() .firstWhere((s) => s.provider == provider); - expect(state.hasListeners, true); + expect(state.hasNonWeakListeners, true); expect(find.text('0'), findsOneWidget); await tester.pumpWidget( @@ -559,7 +559,7 @@ void main() { ), ); - expect(state.hasListeners, false); + expect(state.hasNonWeakListeners, false); }); testWidgets('Multiple providers', (tester) async { diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 0d14e569f..ed7997eb5 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -20,7 +20,6 @@ export 'src/framework.dart' Node, ProviderElementProxy, OnError, - WeakNode, ProviderContainerTest, DebugRiverpodDevtoolBiding, TransitiveFamilyOverride, @@ -37,6 +36,11 @@ export 'src/framework.dart' FutureModifierElement, RunNotifierBuild, $FunctionalProvider, + ProviderStateSubscription, + ProviderSubscriptionImpl, + ProviderSubscriptionWithOrigin, + SelectorSubscription, + DelegatingProviderSubscription, $ClassProvider, LegacyProviderMixin, ClassProviderElement, diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 16fa0f2f2..cd3424afd 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -85,8 +85,8 @@ abstract class ProviderElement implements Node { /// Whether this [ProviderElement] is currently listened to or not. /// /// This maps to listeners added with `listen` and `watch`, - /// including `listen(weak: true)`. - bool get hasListeners => _listenerCount > 0 || weakDependents.isNotEmpty; + /// excluding `listen(weak: true)`. + bool get hasNonWeakListeners => _listenerCount > 0; @visibleForTesting List? subscriptions; diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index 2ad62d1b7..bbb84d413 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -92,6 +92,7 @@ mixin _OnPauseMixin { void onCancel(); } +@internal abstract base class DelegatingProviderSubscription extends ProviderSubscriptionImpl { @override diff --git a/packages/riverpod/lib/src/core/scheduler.dart b/packages/riverpod/lib/src/core/scheduler.dart index 1cc859f39..cd2dbce66 100644 --- a/packages/riverpod/lib/src/core/scheduler.dart +++ b/packages/riverpod/lib/src/core/scheduler.dart @@ -125,11 +125,11 @@ class ProviderScheduler { if ((links != null && links.isNotEmpty) || element.container._disposed || - element.isActive) { + element.hasNonWeakListeners) { continue; } - if (!element.hasListeners) { + if (element.weakDependents.isEmpty) { element.container._disposeProvider(element.origin); } else { // Don't delete the pointer if there are some "weak" listeners active. diff --git a/packages/riverpod/test/old/framework/auto_dispose_test.dart b/packages/riverpod/test/old/framework/auto_dispose_test.dart index fe6b50505..2e6c8a23c 100644 --- a/packages/riverpod/test/old/framework/auto_dispose_test.dart +++ b/packages/riverpod/test/old/framework/auto_dispose_test.dart @@ -101,12 +101,16 @@ Future main() async { final container = ProviderContainer.test(); final aDispose = OnDisposeMock('a'); final a = Provider.autoDispose((ref) { - ref.onDispose(aDispose.call); + ref.onDispose(() { + aDispose.call(); + }); return 42; }); final bDispose = OnDisposeMock('b'); final b = Provider.autoDispose((ref) { - ref.onDispose(bDispose.call); + ref.onDispose(() { + bDispose.call(); + }); ref.watch(a); return '42'; }); diff --git a/packages/riverpod/test/old/framework/ref_watch_test.dart b/packages/riverpod/test/old/framework/ref_watch_test.dart index cac71e51c..89845bab3 100644 --- a/packages/riverpod/test/old/framework/ref_watch_test.dart +++ b/packages/riverpod/test/old/framework/ref_watch_test.dart @@ -342,8 +342,8 @@ void main() { verifyOnly(computedListener, computedListener(null, '0 0')); expect(computedBuildCount, 1); - expect(provider0Element.hasListeners, true); - expect(provider1Element.hasListeners, false); + expect(provider0Element.hasNonWeakListeners, true); + expect(provider1Element.hasNonWeakListeners, false); notifier0.increment(); await container.pump(); @@ -363,8 +363,8 @@ void main() { verifyOnly(computedListener, computedListener('1 1', '1 43')); expect(computedBuildCount, 3); - expect(provider1Element.hasListeners, true); - expect(provider0Element.hasListeners, true); + expect(provider1Element.hasNonWeakListeners, true); + expect(provider0Element.hasNonWeakListeners, true); notifier1.increment(); await container.pump(); @@ -410,8 +410,8 @@ void main() { verifyOnly(computedListener, computedListener(null, 0)); expect(computedBuildCount, 1); - expect(provider0Element.hasListeners, true); - expect(provider1Element.hasListeners, false); + expect(provider0Element.hasNonWeakListeners, true); + expect(provider1Element.hasNonWeakListeners, false); notifier0.increment(); await container.pump(); @@ -431,8 +431,8 @@ void main() { expect(computedBuildCount, 3); verifyOnly(computedListener, computedListener(1, 43)); - expect(provider1Element.hasListeners, true); - expect(provider0Element.hasListeners, false); + expect(provider1Element.hasNonWeakListeners, true); + expect(provider0Element.hasNonWeakListeners, false); notifier1.increment(); await container.pump(); diff --git a/packages/riverpod/test/old/legacy/framework2/framework_test.dart b/packages/riverpod/test/old/legacy/framework2/framework_test.dart index c5e98a5e2..eaab9f3af 100644 --- a/packages/riverpod/test/old/legacy/framework2/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework2/framework_test.dart @@ -269,9 +269,9 @@ void main() { ); expect(firstDependents, [computedElement]); - expect(firstElement.hasListeners, true); + expect(firstElement.hasNonWeakListeners, true); expect(secondDependents, [computedElement]); - expect(secondElement.hasListeners, true); + expect(secondElement.hasNonWeakListeners, true); container.read(first.notifier).state++; expect(sub.read(), 'fallback'); @@ -287,9 +287,9 @@ void main() { listenableVisitor: (_) {}, ); expect(firstDependents, [computedElement]); - expect(firstElement.hasListeners, true); + expect(firstElement.hasNonWeakListeners, true); expect(secondDependents, <$ProviderElement>[]); - expect(secondElement.hasListeners, false); + expect(secondElement.hasNonWeakListeners, false); }); group('overrideWithValue', () { @@ -328,7 +328,7 @@ void main() { listenableVisitor: (_) {}, ); expect(firstDependents, {computedElement}); - expect(firstElement.hasListeners, true); + expect(firstElement.hasNonWeakListeners, true); sub.close(); await container.pump(); @@ -339,7 +339,7 @@ void main() { listenableVisitor: (_) {}, ); expect(firstDependents, <$ProviderElement>{}); - expect(firstElement.hasListeners, false); + expect(firstElement.hasNonWeakListeners, false); }); test( @@ -429,16 +429,16 @@ void main() { final provider = Provider((ref) => ref.watch(first)); final element = container.readProviderElement(provider); - expect(element.hasListeners, false); + expect(element.hasNonWeakListeners, false); final sub = container.listen(provider, didChange.call); - expect(element.hasListeners, true); + expect(element.hasNonWeakListeners, true); sub.close(); counter.increment(); - expect(element.hasListeners, false); + expect(element.hasNonWeakListeners, false); verifyZeroInteractions(didChange); }); diff --git a/packages/riverpod/test/src/core/modifiers/future_test.dart b/packages/riverpod/test/src/core/modifiers/future_test.dart index daedb4fe5..77e595c61 100644 --- a/packages/riverpod/test/src/core/modifiers/future_test.dart +++ b/packages/riverpod/test/src/core/modifiers/future_test.dart @@ -7,7 +7,7 @@ import '../../utils.dart'; void main() { group('provider.future', () { group('handles listen(weak: true)', () { - test('closing the subscription updated element.hasListeners', () { + test('closing the subscription updated element.weakDependents', () { final container = ProviderContainer.test(); final provider = FutureProvider((ref) => 0); @@ -17,11 +17,17 @@ void main() { (previous, value) {}, ); - expect(container.readProviderElement(provider).hasListeners, true); + expect( + container.readProviderElement(provider).weakDependents, + isNotEmpty, + ); sub.close(); - expect(container.readProviderElement(provider).hasListeners, false); + expect( + container.readProviderElement(provider).weakDependents, + isEmpty, + ); }); test( diff --git a/packages/riverpod/test/src/core/modifiers/select_test.dart b/packages/riverpod/test/src/core/modifiers/select_test.dart index a3ed9d935..7d7118476 100644 --- a/packages/riverpod/test/src/core/modifiers/select_test.dart +++ b/packages/riverpod/test/src/core/modifiers/select_test.dart @@ -53,11 +53,17 @@ void main() { (previous, value) {}, ); - expect(container.readProviderElement(provider).hasListeners, true); + expect( + container.readProviderElement(provider).weakDependents, + isNotEmpty, + ); sub.close(); - expect(container.readProviderElement(provider).hasListeners, false); + expect( + container.readProviderElement(provider).weakDependents, + isEmpty, + ); }); test( diff --git a/packages/riverpod/test/src/core/provider_container_test.dart b/packages/riverpod/test/src/core/provider_container_test.dart index dc443fa08..b9f0cdbe1 100644 --- a/packages/riverpod/test/src/core/provider_container_test.dart +++ b/packages/riverpod/test/src/core/provider_container_test.dart @@ -2864,18 +2864,21 @@ void main() { final container = ProviderContainer.test(); final provider = StateProvider((ref) => 0); - expect(container.readProviderElement(provider).hasListeners, false); + expect( + container.readProviderElement(provider).hasNonWeakListeners, false); final sub = container.listen( provider.select((count) => count.isEven), (prev, isEven) {}, ); - expect(container.readProviderElement(provider).hasListeners, true); + expect( + container.readProviderElement(provider).hasNonWeakListeners, true); sub.close(); - expect(container.readProviderElement(provider).hasListeners, false); + expect( + container.readProviderElement(provider).hasNonWeakListeners, false); }); test('can watch selectors', () async { diff --git a/packages/riverpod/test/src/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart index 1ab81529a..ad35c2b11 100644 --- a/packages/riverpod/test/src/core/provider_element_test.dart +++ b/packages/riverpod/test/src/core/provider_element_test.dart @@ -248,18 +248,18 @@ void main() { }); }); - group('hasListeners', () { - test('includes weak listeners', () { + group('hasNonWeakListeners', () { + test('excludes weak listeners', () { final provider = Provider((ref) => 0); final container = ProviderContainer.test(); final element = container.readProviderElement(provider); - expect(element.hasListeners, false); + expect(element.hasNonWeakListeners, false); container.listen(provider, weak: true, (_, __) {}); - expect(element.hasListeners, true); + expect(element.hasNonWeakListeners, false); }); test('includes provider listeners', () async { @@ -269,11 +269,17 @@ void main() { }); final container = ProviderContainer.test(); - expect(container.readProviderElement(provider).hasListeners, false); + expect( + container.readProviderElement(provider).hasNonWeakListeners, + false, + ); container.read(dep); - expect(container.readProviderElement(provider).hasListeners, true); + expect( + container.readProviderElement(provider).hasNonWeakListeners, + true, + ); }); test('includes provider dependents', () async { @@ -283,22 +289,34 @@ void main() { }); final container = ProviderContainer.test(); - expect(container.readProviderElement(provider).hasListeners, false); + expect( + container.readProviderElement(provider).hasNonWeakListeners, + false, + ); container.read(dep); - expect(container.readProviderElement(provider).hasListeners, true); + expect( + container.readProviderElement(provider).hasNonWeakListeners, + true, + ); }); test('includes container listeners', () async { final provider = Provider((ref) => 0); final container = ProviderContainer.test(); - expect(container.readProviderElement(provider).hasListeners, false); + expect( + container.readProviderElement(provider).hasNonWeakListeners, + false, + ); container.listen(provider, (_, __) {}); - expect(container.readProviderElement(provider).hasListeners, true); + expect( + container.readProviderElement(provider).hasNonWeakListeners, + true, + ); }); }); From 7187a1fa0449afb12ea77aeabefa52a1478b3aaa Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 13 Sep 2024 16:52:54 +0200 Subject: [PATCH 340/387] Patch tests --- packages/riverpod/lib/src/core/element.dart | 1 - .../lib/src/core/provider_container.dart | 4 ++-- .../lib/src/core/provider_subscription.dart | 4 ++-- .../src/core/proxy_provider_listenable.dart | 5 ++-- packages/riverpod/lib/src/core/ref.dart | 3 +-- packages/riverpod/test/meta_test.dart | 5 ++-- .../test/old/framework/auto_dispose_test.dart | 12 ++++------ .../src/core/provider_container_test.dart | 24 ++++++++++--------- packages/riverpod/test/src/core/ref_test.dart | 3 +-- 9 files changed, 27 insertions(+), 34 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index cd3424afd..aca8db0d4 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -491,7 +491,6 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu _dependencyMayHaveChanged = true; visitChildren( - // TODO skip paused subscriptions elementVisitor: (element) => element._markDependencyMayHaveChanged(), listenableVisitor: (notifier) => notifier.notifyDependencyMayHaveChanged(), diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 99289ae17..81cc20c3d 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -487,7 +487,7 @@ class ProviderPointerManager { final _familyPointers = familyPointers[family]; if (_familyPointers == null) return const []; - return _familyPointers.pointers.values.map((e) => e.element).whereNotNull(); + return _familyPointers.pointers.values.map((e) => e.element).nonNulls; } /// Remove a provider from this container. @@ -973,7 +973,7 @@ class ProviderContainer implements Node { return _pointerManager .listProviderPointers() .map((e) => e.element) - .whereNotNull() + .nonNulls .where((e) => e.container == this); } diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index bbb84d413..bd3f27e5e 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -2,8 +2,8 @@ part of '../framework.dart'; /// Represents the subscription to a [ProviderListenable]. /// -/// This always is implemented with [ProviderSubscriptionOrigin]. -/// This interface exists to remove the redundant type parameters. +// This always is implemented with ProviderSubscriptionWithOrigin. +// This interface exists to remove the redundant type parameters. @optionalTypeArgs sealed class ProviderSubscription { /// Whether the subscription is closed. diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index 18bd6660b..32f2f8e51 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -124,12 +124,11 @@ class ProviderElementProxy return _ProxySubscription( innerSub, removeListener, - () => read(source), + () => _read(source), ); } - @override - OutT read(Node node) { + OutT _read(Node node) { final element = node.readProviderElement(provider); element.flush(); element.mayNeedDispose(); diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 89f3a64f6..f8441570d 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -230,10 +230,9 @@ final = Provider(dependencies: []); /// {@endtemplate} void invalidate(ProviderOrFamily providerOrFamily, {bool asReload = false}) { _throwIfInvalidUsage(); + if (kDebugMode) _debugAssertCanDependOn(providerOrFamily); container.invalidate(providerOrFamily, asReload: asReload); - - if (kDebugMode) _debugAssertCanDependOn(providerOrFamily); } /// Invokes [invalidate] on itself. diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index 5f4e37176..ccc67210c 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -3,7 +3,6 @@ import 'package:analyzer/dart/analysis/utilities.dart'; import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/dart/element/type.dart'; import 'package:analyzer/dart/element/visitor.dart'; -import 'package:collection/collection.dart'; import 'package:path/path.dart' as path; import 'package:test/test.dart'; @@ -185,7 +184,7 @@ class _PublicAPIVisitor extends GeneralizingElementVisitor { } void _verifyInheritsAnnotations(Element element) { - final parent = element.enclosingElement; + final parent = element.enclosingElement3; if (parent is! ClassElement) return; @@ -199,7 +198,7 @@ class _PublicAPIVisitor extends GeneralizingElementVisitor { return e.getSetter(element.name); } }) - .whereNotNull() + .nonNulls .toList(); if (overrides.isEmpty) return; diff --git a/packages/riverpod/test/old/framework/auto_dispose_test.dart b/packages/riverpod/test/old/framework/auto_dispose_test.dart index 2e6c8a23c..c8f70ae79 100644 --- a/packages/riverpod/test/old/framework/auto_dispose_test.dart +++ b/packages/riverpod/test/old/framework/auto_dispose_test.dart @@ -99,18 +99,14 @@ Future main() async { test('unsub to A then make B sub to A then unsub to B disposes B before A', () async { final container = ProviderContainer.test(); - final aDispose = OnDisposeMock('a'); + final aDispose = OnDisposeMock(); final a = Provider.autoDispose((ref) { - ref.onDispose(() { - aDispose.call(); - }); + ref.onDispose(aDispose.call); return 42; }); - final bDispose = OnDisposeMock('b'); + final bDispose = OnDisposeMock(); final b = Provider.autoDispose((ref) { - ref.onDispose(() { - bDispose.call(); - }); + ref.onDispose(bDispose.call); ref.watch(a); return '42'; }); diff --git a/packages/riverpod/test/src/core/provider_container_test.dart b/packages/riverpod/test/src/core/provider_container_test.dart index b9f0cdbe1..a562c7737 100644 --- a/packages/riverpod/test/src/core/provider_container_test.dart +++ b/packages/riverpod/test/src/core/provider_container_test.dart @@ -2443,10 +2443,8 @@ void main() { }); test( - 'if a listener removes another provider.listen, the removed listener is still called', - skip: true, () { - ; // Breaks because of the "if (!sub.closed)" in notifyListeners - + 'if a listener removes another provider.listen, the removed listener is not called', + () { final provider = StateProvider((ref) => 0); final container = ProviderContainer.test(); @@ -2470,10 +2468,8 @@ void main() { container.read(provider.notifier).state++; - verifyInOrder([ - listener(0, 1), - listener2(0, 1), - ]); + verifyOnly(listener, listener(0, 1)); + verifyZeroInteractions(listener2); container.read(provider.notifier).state++; @@ -2865,7 +2861,9 @@ void main() { final provider = StateProvider((ref) => 0); expect( - container.readProviderElement(provider).hasNonWeakListeners, false); + container.readProviderElement(provider).hasNonWeakListeners, + false, + ); final sub = container.listen( provider.select((count) => count.isEven), @@ -2873,12 +2871,16 @@ void main() { ); expect( - container.readProviderElement(provider).hasNonWeakListeners, true); + container.readProviderElement(provider).hasNonWeakListeners, + true, + ); sub.close(); expect( - container.readProviderElement(provider).hasNonWeakListeners, false); + container.readProviderElement(provider).hasNonWeakListeners, + false, + ); }); test('can watch selectors', () async { diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 9cb8c3355..33341d2f4 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -1967,7 +1967,7 @@ void main() { }); group('.invalidate', () { - test('Throws if a circular dependency is detected', skip: true, () { + test('Throws if a circular dependency is detected', () { // Regression test for https://github.com/rrousselGit/riverpod/issues/2336 late Ref ref; final a = Provider((r) { @@ -1979,7 +1979,6 @@ void main() { container.read(b); - ; expect( () => ref.invalidate(b), throwsA(isA()), From d38507a2ef34d10cd419369ed87750948ed7a19e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 15 Sep 2024 00:58:19 +0200 Subject: [PATCH 341/387] Complete pause --- packages/riverpod/lib/riverpod.dart | 2 +- packages/riverpod/lib/src/core/element.dart | 8 +- .../lib/src/core/modifiers/future.dart | 96 +++++++++++------ .../lib/src/core/provider_subscription.dart | 26 ++++- .../src/core/proxy_provider_listenable.dart | 2 +- packages/riverpod/lib/src/core/scheduler.dart | 1 - .../old/legacy/framework2/framework_test.dart | 7 +- ...o_dispose_family_stream_provider_test.dart | 4 + .../auto_dispose_stream_provider_test.dart | 6 ++ .../stream_provider_family_test.dart | 8 ++ .../stream_provider/stream_provider_test.dart | 33 +++++- .../src/core/modifiers/select_async_test.dart | 16 ++- .../src/core/provider_subscription_test.dart | 89 ++++++++++++++++ .../src/providers/stream_notifier_test.dart | 100 ++++++++++++++---- packages/riverpod/test/src/utils.dart | 98 +++++++++++++++++ 15 files changed, 427 insertions(+), 69 deletions(-) diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index ed7997eb5..95d8a9e24 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -32,7 +32,7 @@ export 'src/framework.dart' $FutureModifier, ProviderElement, ClassBaseX, - CancelAsyncSubscription, + AsyncSubscription, FutureModifierElement, RunNotifierBuild, $FunctionalProvider, diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index aca8db0d4..82f55d69b 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -533,7 +533,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu return sub; } - void _onCancel() { + void onCancel() { subscriptions?.forEach((sub) { switch (sub) { case ProviderSubscriptionImpl(): @@ -542,7 +542,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu }); } - void _onResume() { + void onResume() { subscriptions?.forEach((sub) { switch (sub) { case ProviderSubscriptionImpl(): @@ -593,12 +593,12 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu switch ((wasActive: wasActive, isActive: isActive)) { case (wasActive: false, isActive: true) when _didCancelOnce: ref?._onResumeListeners?.forEach(runGuarded); - _onResume(); + onResume(); case (wasActive: true, isActive: false): _didCancelOnce = true; ref?._onCancelListeners?.forEach(runGuarded); - _onCancel(); + onCancel(); default: // No state change, so do nothing diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 2a6ea31b5..5319a467f 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -2,7 +2,11 @@ part of '../../framework.dart'; /// Internal typedef for cancelling the subscription to an async operation @internal -typedef CancelAsyncSubscription = void Function(); +typedef AsyncSubscription = ({ + void Function() cancel, + void Function()? pause, + void Function()? resume, +}); /// Implementation detail of `riverpod_generator`. /// Do not use. @@ -231,8 +235,7 @@ mixin FutureModifierElement on ProviderElement> { final futureNotifier = ProxyElementValueListenable>(); Completer? _futureCompleter; Future? _lastFuture; - CancelAsyncSubscription? _lastFutureSub; - CancelAsyncSubscription? _cancelSubscription; + AsyncSubscription? _cancelSubscription; /// Internal utility for transitioning an [AsyncValue] after a provider refresh. /// @@ -344,16 +347,30 @@ mixin FutureModifierElement on ProviderElement> { required error, required last, }) { - final rawStream = create(); - final stream = rawStream.isBroadcast - ? rawStream - : rawStream.asBroadcastStream(onCancel: (sub) => sub.cancel()); + final stream = create(); + + return stream.listenAndTrackLast( + last, + lastOrElseError: _missingLastValueError, + onData: data, + onError: error, + onDone: done, + ); + }); + } - stream.lastCancelable(last, orElseError: _missingLastValueError); + @override + void onCancel() { + super.onCancel(); - final sub = stream.listen(data, onError: error, onDone: done); - return sub.cancel; - }); + _cancelSubscription?.pause?.call(); + } + + @override + void onResume() { + super.onResume(); + + _cancelSubscription?.resume?.call(); } StateError _missingLastValueError() { @@ -405,17 +422,21 @@ mixin FutureModifierElement on ProviderElement> { last(futureOr, cancel); - return cancel; + return ( + cancel: cancel, + pause: null, + resume: null, + ); }); } /// Listens to a [Future] and transforms it into an [AsyncValue]. void _handleAsync( - CancelAsyncSubscription? Function({ + AsyncSubscription? Function({ required void Function(StateT) data, required void Function(Object, StackTrace) error, required void Function() done, - required void Function(Future, CancelAsyncSubscription) last, + required void Function(Future, void Function()) last, }) listen, { required bool seamless, }) { @@ -431,13 +452,9 @@ mixin FutureModifierElement on ProviderElement> { }, last: (last, sub) { assert(_lastFuture == null, 'bad state'); - assert(_lastFutureSub == null, 'bad state'); _lastFuture = last; - _lastFutureSub = sub; }, done: () { - _lastFutureSub?.call(); - _lastFutureSub = null; _lastFuture = null; }, ); @@ -457,10 +474,8 @@ mixin FutureModifierElement on ProviderElement> { @internal void runOnDispose() { // Stops listening to the previous async operation - _lastFutureSub?.call(); - _lastFutureSub = null; _lastFuture = null; - _cancelSubscription?.call(); + _cancelSubscription?.cancel(); _cancelSubscription = null; super.runOnDispose(); } @@ -475,23 +490,21 @@ mixin FutureModifierElement on ProviderElement> { final lastFuture = _lastFuture; if (lastFuture != null) { - // The completer will be completed by the while loop in handleStream - final cancelSubscription = _cancelSubscription; if (cancelSubscription != null) { - completer.future + cancelSubscription.resume?.call(); + lastFuture .then( (_) {}, // ignore: avoid_types_on_closure_parameters onError: (Object _) {}, ) - .whenComplete(cancelSubscription); + .whenComplete(cancelSubscription.cancel); } // Prevent super.dispose from cancelling the subscription on the "last" // stream value, so that it can be sent to `provider.future`. _lastFuture = null; - _lastFutureSub = null; _cancelSubscription = null; } else { // The listened stream completed during a "loading" state. @@ -519,19 +532,26 @@ mixin FutureModifierElement on ProviderElement> { } extension on Stream { - void lastCancelable( - void Function(Future, CancelAsyncSubscription) last, { - required Object Function() orElseError, + AsyncSubscription listenAndTrackLast( + void Function(Future, void Function()) last, { + required Object Function() lastOrElseError, + required void Function(T event) onData, + required void Function(Object error, StackTrace stackTrace) onError, + required void Function() onDone, }) { - late StreamSubscription subscription; final completer = Completer(); Result? result; + late StreamSubscription subscription; subscription = listen( - (event) => result = Result.data(event), + (event) { + result = Result.data(event); + onData(event); + }, // ignore: avoid_types_on_closure_parameters onError: (Object error, StackTrace stackTrace) { result = Result.error(error, stackTrace); + onError(error, stackTrace); }, onDone: () { if (result != null) { @@ -550,13 +570,23 @@ extension on Stream { completer.future.ignore(); completer.completeError( - orElseError(), + lastOrElseError(), StackTrace.current, ); } + + onDone(); }, ); - last(completer.future, subscription.cancel); + final asyncSub = ( + cancel: subscription.cancel, + pause: subscription.pause, + resume: subscription.resume + ); + + last(completer.future, asyncSub.cancel); + + return asyncSub; } } diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index bd3f27e5e..a4290f0a3 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -186,7 +186,10 @@ final class ProviderStateSubscription /// Whether an event was sent while this subscription was paused. /// /// This enables re-rending the last missing event when the subscription is resumed. - var _missedCalled = false; + ({ + (StateT?, StateT)? data, + (Object, StackTrace)? error, + })? _missedCalled; @override StateT read() { @@ -203,12 +206,27 @@ final class ProviderStateSubscription void onCancel() => _listenedElement.onSubscriptionPause(this); @override - void onResume() => _listenedElement.onSubscriptionResume(this); + void onResume() { + _listenedElement.onSubscriptionResume(this); + if (_missedCalled?.data case final event?) { + final prev = event.$1; + final next = event.$2; + + _missedCalled = null; + listener(prev, next); + } else if (_missedCalled?.error case final event?) { + final error = event.$1; + final stackTrace = event.$2; + + _missedCalled = null; + onError(error, stackTrace); + } + } @override void _notify(StateT? prev, StateT next) { if (_isPaused) { - _missedCalled = true; + _missedCalled = (data: (prev, next), error: null); return; } @@ -218,7 +236,7 @@ final class ProviderStateSubscription @override void _notifyError(Object error, StackTrace stackTrace) { if (_isPaused) { - _missedCalled = true; + _missedCalled = (data: null, error: (error, stackTrace)); return; } diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index 32f2f8e51..e50ffbc1b 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -86,7 +86,7 @@ class ProviderElementProxy final element = source.readProviderElement(provider); ; // TODO test weak proxy listener does not break what's said after this. - // While we don't care about changes to the element, calling _listenElement + // While we don't care about changes to the element, calling addListener // is necessary to tell the listened element that it is being listened. // We do it at the top of the file to trigger a "flush" before adding // a listener to the notifier. diff --git a/packages/riverpod/lib/src/core/scheduler.dart b/packages/riverpod/lib/src/core/scheduler.dart index cd2dbce66..51e140438 100644 --- a/packages/riverpod/lib/src/core/scheduler.dart +++ b/packages/riverpod/lib/src/core/scheduler.dart @@ -120,7 +120,6 @@ class ProviderScheduler { /// and the second time it is traversed, it won't anymore. for (var i = 0; i < _stateToDispose.length; i++) { final element = _stateToDispose[i]; - final links = element.ref?._keepAliveLinks; if ((links != null && links.isNotEmpty) || diff --git a/packages/riverpod/test/old/legacy/framework2/framework_test.dart b/packages/riverpod/test/old/legacy/framework2/framework_test.dart index eaab9f3af..6f6cd38c5 100644 --- a/packages/riverpod/test/old/legacy/framework2/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework2/framework_test.dart @@ -133,14 +133,15 @@ void main() { .maybeWhen(data: (d) => d, orElse: () => null); }); - expect(callCount, 0); - expect(container.read(provider), null); + final sub = container.listen(provider, (p, n) {}); + + expect(sub.read(), null); expect(callCount, 1); controller.add(42); expect(callCount, 1); - expect(container.read(provider), 42); + expect(sub.read(), 42); expect(callCount, 2); }); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart index f8df2354a..b417d6e83 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_family_stream_provider_test.dart @@ -27,6 +27,8 @@ void main() { overrides: [provider], ); + container.listen(provider(0), (p, n) {}); + expect(await container.read(provider(0).future), 0); expect(container.read(provider(0)), const AsyncData(0)); expect(root.getAllProviderElements(), isEmpty); @@ -100,6 +102,8 @@ void main() { overrides: [dep.overrideWithValue(42)], ); + container.listen(provider(10), (p, n) {}); + await expectLater(container.read(provider(10).future), completion(52)); expect(container.read(provider(10)), const AsyncData(52)); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart index e32033b71..6bba9449c 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart @@ -66,6 +66,8 @@ void main() { overrides: [dep.overrideWithValue(42)], ); + container.listen(provider, (p, n) {}); + await expectLater(container.read(provider.future), completion(42)); expect(container.read(provider), const AsyncData(42)); @@ -200,6 +202,8 @@ void main() { overrides: [provider], ); + container.listen(provider, (p, n) {}); + expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); expect(root.getAllProviderElements(), isEmpty); @@ -248,6 +252,8 @@ void main() { ], ); + container.listen(provider, (p, n) {}); + expect(await container.read(provider.future), 42); expect(container.read(provider), const AsyncValue.data(42)); expect(root.getAllProviderElements(), isEmpty); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart index c08e3b860..b7bd0f7cf 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_family_test.dart @@ -24,6 +24,8 @@ void main() { overrides: [provider], ); + container.listen(provider(0), (p, n) {}); + expect(await container.read(provider(0).future), 0); expect(container.read(provider(0)), const AsyncData(0)); expect(root.getAllProviderElements(), isEmpty); @@ -49,6 +51,8 @@ void main() { ], ); + container.listen(provider(0), (p, n) {}); + expect(await container.read(provider(0).future), 42); expect(container.read(provider(0)), const AsyncData(42)); expect(root.getAllProviderElements(), isEmpty); @@ -77,6 +81,8 @@ void main() { overrides: [dep.overrideWithValue(42)], ); + container.listen(provider(10), (p, n) {}); + await expectLater(container.read(provider(10).future), completion(52)); expect(container.read(provider(10)), const AsyncData(52)); @@ -93,6 +99,8 @@ void main() { ], ); + container.listen(provider(0), (p, n) {}); + expect(container.read(provider(0)), const AsyncValue.loading()); await container.pump(); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart index fc2f69073..13d3e45b6 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart @@ -81,7 +81,7 @@ void main() { return Stream.value(0); }); - container.read(provider); + container.listen(provider, (p, n) {}); expect(state, const AsyncLoading()); @@ -102,6 +102,8 @@ void main() { var count = 0; final provider = StreamProvider((ref) => Stream.value(count++)); + container.listen(provider, (p, n) {}); + await expectLater(container.read(provider.future), completion(0)); expect(container.read(provider), const AsyncData(0)); @@ -129,6 +131,8 @@ void main() { final dep = StateProvider((ref) => 0); final provider = StreamProvider((ref) => Stream.value(ref.watch(dep))); + container.listen(provider, (p, n) {}); + await expectLater(container.read(provider.future), completion(0)); expect(container.read(provider), const AsyncData(0)); @@ -150,6 +154,8 @@ void main() { final dep = StateProvider((ref) => 0); final provider = StreamProvider((ref) => Stream.value(ref.watch(dep))); + container.listen(provider, (p, n) {}); + await expectLater(container.read(provider.future), completion(0)); expect(container.read(provider), const AsyncData(0)); @@ -219,6 +225,7 @@ void main() { overrides: [dep.overrideWithValue(42)], ); + container.listen(provider, (p, n) {}); await expectLater(container.read(provider.future), completion(42)); expect(container.read(provider), const AsyncData(42)); @@ -235,6 +242,7 @@ void main() { final controller = StreamController(); addTearDown(controller.close); + container.listen(provider, (p, n) {}); await expectLater( container.read(provider.future), completion(42), @@ -275,6 +283,7 @@ void main() { final container = ProviderContainer.test(); final provider = StreamProvider((ref) => Stream.value(result)); + container.listen(provider, (p, n) {}); expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); @@ -300,6 +309,7 @@ void main() { overrides: [provider], ); + container.listen(provider, (p, n) {}); expect(await container.read(provider.future), 0); expect(container.read(provider), const AsyncValue.data(0)); expect(root.getAllProviderElements(), isEmpty); @@ -324,6 +334,7 @@ void main() { ], ); + container.listen(provider, (p, n) {}); expect(await container.read(provider.future), 42); expect(container.read(provider), const AsyncValue.data(42)); expect(root.getAllProviderElements(), isEmpty); @@ -348,6 +359,7 @@ void main() { ], ); + container.listen(provider, (p, n) {}); expect(await container.read(provider.future), 42); expect(container.read(provider), const AsyncValue.data(42)); expect(root.getAllProviderElements(), isEmpty); @@ -366,6 +378,8 @@ void main() { addTearDown(() => controller.close); final provider = StreamProvider((ref) => controller.stream); + container.listen(provider, (p, n) {}); + expect(container.read(provider), const AsyncValue.loading()); controller.add(42); @@ -379,6 +393,8 @@ void main() { addTearDown(() => controller.close); final provider = StreamProvider((ref) => controller.stream); + container.listen(provider, (p, n) {}); + expect(container.read(provider), const AsyncValue.loading()); final stack = StackTrace.current; @@ -436,6 +452,7 @@ void main() { provider.overrideWithValue(AsyncValue.error(error, StackTrace.empty)), ]); + container.listen(provider, (p, n) {}); expect(container.read(provider.future), future); await expectLater(future, throwsA(error)); @@ -466,6 +483,7 @@ void main() { ], ); + container.listen(provider, (p, n) {}); var future = container.read(provider.future); final error = Error(); @@ -499,6 +517,7 @@ void main() { ], ); + container.listen(provider, (p, n) {}); var future = container.read(provider.future); container.updateOverrides([ @@ -529,6 +548,7 @@ void main() { ], ); + container.listen(provider, (p, n) {}); var future = container.read(provider.future); container.updateOverrides([ @@ -657,6 +677,8 @@ void main() { }); final container = ProviderContainer.test(); + container.listen(provider(0), (p, n) {}); + expect(container.read(provider(0)), const AsyncValue.loading()); await container.pump(); @@ -786,6 +808,7 @@ void main() { final controller = StreamController(); final provider = StreamProvider((_) => controller.stream); + container.listen(provider, (p, n) {}); final future = container.read(provider.future); controller.add(42); @@ -802,6 +825,7 @@ void main() { controller.add(42); + container.listen(provider, (p, n) {}); final future = container.read(provider.future); await expectLater(future, completion(42)); @@ -814,6 +838,7 @@ void main() { final controller = StreamController(); final provider = StreamProvider((_) => controller.stream); + container.listen(provider, (p, n) {}); final future = container.read(provider.future); controller.addError(42); @@ -830,6 +855,7 @@ void main() { controller.addError(42); + container.listen(provider, (p, n) {}); final future = container.read(provider.future); await expectLater(future, throwsA(42)); @@ -847,6 +873,7 @@ void main() { ], ); + container.listen(provider, (p, n) {}); final future = container.read(provider.future); container.updateOverrides([ @@ -868,6 +895,7 @@ void main() { provider.overrideWithValue(const AsyncValue.data(42)), ]); + container.listen(provider, (p, n) {}); final future = container.read(provider.future); await expectLater(future, completion(42)); @@ -881,6 +909,7 @@ void main() { ], ); + container.listen(provider, (p, n) {}); final future = container.read(provider.future); container.updateOverrides([ @@ -904,6 +933,7 @@ void main() { .overrideWithValue(const AsyncValue.error(42, StackTrace.empty)), ]); + container.listen(provider, (p, n) {}); final future = container.read(provider.future); await expectLater(future, throwsA(42)); @@ -917,6 +947,7 @@ void main() { ], ); + container.listen(provider, (p, n) {}); final future = container.read(provider.future); await expectLater(future, completion(42)); diff --git a/packages/riverpod/test/src/core/modifiers/select_async_test.dart b/packages/riverpod/test/src/core/modifiers/select_async_test.dart index 2c75a54cc..9cc5fa94d 100644 --- a/packages/riverpod/test/src/core/modifiers/select_async_test.dart +++ b/packages/riverpod/test/src/core/modifiers/select_async_test.dart @@ -16,6 +16,7 @@ void main() { addTearDown(controller.close); final dep = StreamProvider((ref) => controller.stream); + container.listen(dep, (p, n) {}); final ref = container.read(provider); final future = ref.watch(dep.selectAsync((data) => data * 2)); @@ -32,6 +33,7 @@ void main() { addTearDown(controller.close); final dep = StreamProvider((ref) => controller.stream); + container.listen(dep, (p, n) {}); final ref = container.read(provider); final future = ref.watch(dep.selectAsync((data) => data * 2)); @@ -233,7 +235,9 @@ void main() { return ref.watch(a.selectAsync((value) => value % 10)); }); - expect(buildCount, 0); + container.listen(a, (p, n) {}); + container.listen(b, (p, n) {}); + expect(container.read(a), const AsyncLoading()); expect(container.read(b), const AsyncLoading()); expect(await container.read(b.future), 0); @@ -289,7 +293,9 @@ void main() { return ref.watch(a.selectAsync((value) => value % 10)); }); - expect(buildCount, 0); + container.listen(a, (p, n) {}); + container.listen(b, (p, n) {}); + expect(container.read(b), const AsyncLoading()); expect(container.read(b), const AsyncLoading()); expect(await container.read(b.future), 0); @@ -340,6 +346,8 @@ void main() { final container = ProviderContainer.test(); final provider = FutureProvider((ref) async => 0); + container.listen(provider, (p, n) {}); + expect( container.read(provider.selectAsync((data) => data.toString())), completion('0'), @@ -351,6 +359,8 @@ void main() { final provider = FutureProvider((ref) async => throw StateError('err')); + container.listen(provider, (p, n) {}); + expect( container.read(provider.selectAsync((data) => data)), throwsStateError, @@ -361,6 +371,8 @@ void main() { final container = ProviderContainer.test(); final provider = FutureProvider((ref) async => 42); + container.listen(provider, (p, n) {}); + expect( container.read(provider.selectAsync((data) => throw StateError('err'))), throwsStateError, diff --git a/packages/riverpod/test/src/core/provider_subscription_test.dart b/packages/riverpod/test/src/core/provider_subscription_test.dart index 6c8ed053b..e3a882b8d 100644 --- a/packages/riverpod/test/src/core/provider_subscription_test.dart +++ b/packages/riverpod/test/src/core/provider_subscription_test.dart @@ -1,6 +1,10 @@ +import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; +import '../matrix.dart'; +import '../utils.dart'; + void main() { group('_ProxySubscription', () { test('handles pause/resume', () { @@ -42,4 +46,89 @@ void main() { expect(element.isActive, true); }); }); + + group('ProviderSubscription.resume', () { + test( + 'Resuming a paused subscription with no missed data event does not call listeners', + () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => 0); + final listener = Listener(); + + final sub = container.listen(provider, listener.call); + + sub.pause(); + + sub.resume(); + + verifyZeroInteractions(listener); + }); + + test('Resuming a paused subscription with missed data emits the last event', + () async { + final container = ProviderContainer.test(); + final provider = NotifierProvider, int>( + () => DeferredNotifier((ref) => 0), + ); + final listener = Listener(); + + final notifier = container.read(provider.notifier); + + final sub = container.listen(provider, listener.call); + + sub.pause(); + + notifier.state = 1; + notifier.state = 2; + + sub.resume(); + + verifyOnly(listener, listener(1, 2)); + + sub.resume(); + + verifyNoMoreInteractions(listener); + }); + + test( + 'Resuming a paused subscription with missed error emits the last error', + () async { + final container = ProviderContainer.test(); + late Error toThrow; + final stack = StackTrace.current; + final provider = Provider((ref) { + Error.throwWithStackTrace(toThrow, stack); + }); + final listener = Listener(); + final onError = ErrorListener(); + final err = Error(); + final err2 = Error(); + + toThrow = err; + + final sub = container.listen( + provider, + listener.call, + onError: onError.call, + ); + + sub.pause(); + + toThrow = err2; + try { + container.refresh(provider); + } catch (e) { + // Will rethrow the error, but we don't care about it here + } + + sub.resume(); + + verifyOnly(onError, onError(err2, stack)); + + sub.resume(); + + verifyNoMoreInteractions(onError); + verifyZeroInteractions(listener); + }); + }); } diff --git a/packages/riverpod/test/src/providers/stream_notifier_test.dart b/packages/riverpod/test/src/providers/stream_notifier_test.dart index 602a34b13..4b486c9c4 100644 --- a/packages/riverpod/test/src/providers/stream_notifier_test.dart +++ b/packages/riverpod/test/src/providers/stream_notifier_test.dart @@ -29,8 +29,72 @@ void main() { }); streamNotifierProviderFactory.createGroup((factory) { - test('Pauses the Stream when the provider is paused', skip: true, () { - ; + test('closes the StreamSubscription upon disposing the provider', () async { + final onCancel = OnCancelMock(); + final container = ProviderContainer.test(); + final cancelCompleter = Completer.sync(); + final provider = factory.simpleTestProvider((ref) { + final controller = StreamController(); + ref.onDispose(() { + controller.addError(42); + controller.close(); + }); + + return DelegatingStream( + controller.stream, + onSubscriptionCancel: () { + onCancel.call(); + cancelCompleter.complete(); + }, + ); + }); + + container.listen(provider, (previous, next) {}); + final future = container.read(provider.future); + + container.dispose(); + + verifyZeroInteractions(onCancel); + + await expectLater(future, throwsA(42)); + await cancelCompleter.future; + + verifyOnly(onCancel, onCancel()); + }); + + test('Pauses the Stream when the provider is paused', () { + final streamController = StreamController(); + addTearDown(streamController.close); + + final onSubPause = OnPause(); + final onSubResume = OnResume(); + + final container = ProviderContainer.test(); + + final provider = factory.simpleTestProvider( + (ref) { + return DelegatingStream( + streamController.stream, + onSubscriptionPause: onSubPause.call, + onSubscriptionResume: onSubResume.call, + ); + }, + ); + + final sub = container.listen(provider, (previous, next) {}); + + verifyZeroInteractions(onSubPause); + verifyZeroInteractions(onSubResume); + + sub.pause(); + + verifyOnly(onSubPause, onSubPause()); + verifyZeroInteractions(onSubResume); + + sub.resume(); + + verifyOnly(onSubResume, onSubResume()); + verifyNoMoreInteractions(onSubPause); }); test('Cannot share a Notifier instance between providers ', () { @@ -586,29 +650,27 @@ void main() { }, ); - test( - 'if going back to loading after future resolved, throws StateError', - () async { - final container = ProviderContainer.test(); - final completer = Completer.sync(); - final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completer.future), - ); + test('if going back to loading after future resolved, throws StateError', + () async { + final container = ProviderContainer.test(); + final completer = Completer.sync(); + final provider = factory.simpleTestProvider( + (ref) => Stream.fromFuture(completer.future), + ); - container.read(provider); + container.listen(provider, (previous, next) {}); - completer.complete(42); + completer.complete(42); - container.read(provider.notifier).state = const AsyncData(42); - container.read(provider.notifier).state = const AsyncLoading(); + container.read(provider.notifier).state = const AsyncData(42); + container.read(provider.notifier).state = const AsyncLoading(); - final future = container.read(provider.future); + final future = container.read(provider.future); - container.dispose(); + container.dispose(); - await expectLater(future, throwsStateError); - }, - ); + await expectLater(future, throwsStateError); + }); test( 'resolves with the new state if StreamNotifier.state is modified during loading', diff --git a/packages/riverpod/test/src/utils.dart b/packages/riverpod/test/src/utils.dart index d9d254514..0d0292c8a 100644 --- a/packages/riverpod/test/src/utils.dart +++ b/packages/riverpod/test/src/utils.dart @@ -20,6 +20,100 @@ List captureErrors(List cb) { class ProviderObserverMock extends Mock implements ProviderObserver {} +class StreamSubscriptionView implements StreamSubscription { + StreamSubscriptionView(this.inner); + + final StreamSubscription inner; + + @override + Future asFuture([E? futureValue]) => inner.asFuture(futureValue); + + @override + Future cancel() => inner.cancel(); + + @override + bool get isPaused => inner.isPaused; + + @override + void onData(void Function(T data)? handleData) => inner.onData(handleData); + + @override + void onDone(void Function()? handleDone) => inner.onDone(handleDone); + + @override + void onError(Function? handleError) => inner.onError(handleError); + + @override + void pause([Future? resumeSignal]) => inner.pause(resumeSignal); + + @override + void resume() => inner.resume(); +} + +class _DelegatingStreamSubscription extends StreamSubscriptionView { + _DelegatingStreamSubscription( + super.inner, { + this.onSubscriptionPause, + this.onSubscriptionResume, + this.onSubscriptionCancel, + }); + + final void Function()? onSubscriptionPause; + final void Function()? onSubscriptionResume; + final void Function()? onSubscriptionCancel; + + @override + Future cancel() { + onSubscriptionCancel?.call(); + return super.cancel(); + } + + @override + void pause([Future? resumeSignal]) { + onSubscriptionPause?.call(); + super.pause(resumeSignal); + } + + @override + void resume() { + onSubscriptionResume?.call(); + super.resume(); + } +} + +class DelegatingStream extends StreamView { + DelegatingStream( + super.stream, { + this.onSubscriptionPause, + this.onSubscriptionResume, + this.onSubscriptionCancel, + }); + + final void Function()? onSubscriptionPause; + final void Function()? onSubscriptionResume; + final void Function()? onSubscriptionCancel; + + @override + StreamSubscription listen( + void Function(T event)? onData, { + Function? onError, + void Function()? onDone, + bool? cancelOnError, + }) { + return _DelegatingStreamSubscription( + super.listen( + onData, + onError: onError, + onDone: onDone, + cancelOnError: cancelOnError, + ), + onSubscriptionPause: onSubscriptionPause, + onSubscriptionResume: onSubscriptionResume, + onSubscriptionCancel: onSubscriptionCancel, + ); + } +} + class OverrideWithBuildMock extends Mock { OverrideWithBuildMock(this.fallback); @@ -50,6 +144,10 @@ class OnResume extends Mock { void call(); } +class OnPause extends Mock { + void call(); +} + class OnAddListener extends Mock { void call(ProviderSubscription? sub); } From 66e0a897b9ece884e4f60c453938f0d2fd087484 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 15 Sep 2024 01:17:06 +0200 Subject: [PATCH 342/387] Cleanup --- packages/riverpod/lib/src/core/element.dart | 8 +-- .../src/core/proxy_provider_listenable.dart | 1 - packages/riverpod/lib/src/core/ref.dart | 8 +-- .../test/old/framework/modifiers_test.dart | 12 ++-- packages/riverpod/test/old/utils.dart | 4 +- packages/riverpod/test/src/core/ref_test.dart | 60 +++++++++---------- packages/riverpod/test/src/utils.dart | 4 +- 7 files changed, 46 insertions(+), 51 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 82f55d69b..44b7e0c3c 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -606,16 +606,12 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu if (_listenerCount < previousListenerCount) { if (ref?._onRemoveListeners case final listeners?) { - for (final listener in listeners) { - runUnaryGuarded(listener, sub); - } + listeners.forEach(runGuarded); } mayNeedDispose(); } else if (_listenerCount > previousListenerCount) { if (ref?._onAddListeners case final listeners?) { - for (final listener in listeners) { - runUnaryGuarded(listener, sub); - } + listeners.forEach(runGuarded); } } } diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index e50ffbc1b..ba7f741f9 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -85,7 +85,6 @@ class ProviderElementProxy }) { final element = source.readProviderElement(provider); - ; // TODO test weak proxy listener does not break what's said after this. // While we don't care about changes to the element, calling addListener // is necessary to tell the listened element that it is being listened. // We do it at the top of the file to trigger a "flush" before adding diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index f8441570d..afd6015de 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -47,8 +47,8 @@ base class Ref { List? _onDisposeListeners; List? _onResumeListeners; List? _onCancelListeners; - List? _onAddListeners; - List? _onRemoveListeners; + List? _onAddListeners; + List? _onRemoveListeners; List? _onErrorSelfListeners; bool get mounted => _mounted; @@ -280,7 +280,7 @@ final = Provider(dependencies: []); /// /// See also: /// - [onRemoveListener], for when a listener is removed - void onAddListener(void Function(ProviderSubscription sub) cb) { + void onAddListener(void Function() cb) { _throwIfInvalidUsage(); _onAddListeners ??= []; @@ -291,7 +291,7 @@ final = Provider(dependencies: []); /// /// See also: /// - [onAddListener], for when a listener is added - void onRemoveListener(void Function(ProviderSubscription sub) cb) { + void onRemoveListener(void Function() cb) { _throwIfInvalidUsage(); _onRemoveListeners ??= []; diff --git a/packages/riverpod/test/old/framework/modifiers_test.dart b/packages/riverpod/test/old/framework/modifiers_test.dart index da7ce4ae1..ac28709a1 100644 --- a/packages/riverpod/test/old/framework/modifiers_test.dart +++ b/packages/riverpod/test/old/framework/modifiers_test.dart @@ -44,31 +44,31 @@ void main() { final sub = container.listen(provider.future, (prev, value) {}); - verifyOnly(onAddListener, onAddListener(any)); + verifyOnly(onAddListener, onAddListener()); final sub2 = container.listen(provider.future, (prev, value) {}); - verifyOnly(onAddListener, onAddListener(any)); + verifyOnly(onAddListener, onAddListener()); sub.close(); - verifyOnly(onRemoveListener, onRemoveListener(any)); + verifyOnly(onRemoveListener, onRemoveListener()); verifyZeroInteractions(onCancel); sub2.close(); - verifyOnly(onRemoveListener, onRemoveListener(any)); + verifyOnly(onRemoveListener, onRemoveListener()); verifyZeroInteractions(onResume); verifyOnly(onCancel, onCancel()); container.listen(provider.future, (prev, value) {}); - verifyOnly(onAddListener, onAddListener(any)); + verifyOnly(onAddListener, onAddListener()); verifyOnly(onResume, onResume()); container.listen(provider.future, (prev, value) {}); - verifyOnly(onAddListener, onAddListener(any)); + verifyOnly(onAddListener, onAddListener()); verifyNoMoreInteractions(onCancel); verifyNoMoreInteractions(onResume); verifyZeroInteractions(onDispose); diff --git a/packages/riverpod/test/old/utils.dart b/packages/riverpod/test/old/utils.dart index 62db0785c..f7839184e 100644 --- a/packages/riverpod/test/old/utils.dart +++ b/packages/riverpod/test/old/utils.dart @@ -57,11 +57,11 @@ class OnResume extends Mock { } class OnAddListener extends Mock { - void call(ProviderSubscription? sub); + void call(); } class OnRemoveListener extends Mock { - void call(ProviderSubscription? sub); + void call(); } class Listener extends Mock { diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 33341d2f4..e99419db8 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -80,7 +80,7 @@ void main() { throwsA(isA()), ); expect( - () => ref.onAddListener((_) {}), + () => ref.onAddListener(() {}), throwsA(isA()), ); expect( @@ -88,7 +88,7 @@ void main() { throwsA(isA()), ); expect( - () => ref.onRemoveListener((_) {}), + () => ref.onRemoveListener(() {}), throwsA(isA()), ); expect( @@ -163,7 +163,7 @@ void main() { throwsA(isA()), ); expect( - () => container.read(provider.select((_) => ref.onAddListener((_) {}))), + () => container.read(provider.select((_) => ref.onAddListener(() {}))), throwsA(isA()), ); expect( @@ -171,8 +171,8 @@ void main() { throwsA(isA()), ); expect( - () => container - .read(provider.select((_) => ref.onRemoveListener((_) {}))), + () => + container.read(provider.select((_) => ref.onRemoveListener(() {}))), throwsA(isA()), ); expect( @@ -2114,7 +2114,7 @@ void main() { container.read(provider); - verifyOnly(listener, listener(any)); + verifyOnly(listener, listener()); }); test('calls listeners when container.listen subscriptions are closed', @@ -2133,7 +2133,7 @@ void main() { sub.close(); - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); @@ -2144,7 +2144,7 @@ void main() { sub2.close(); - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); }); @@ -2178,7 +2178,7 @@ void main() { sub.close(); - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); @@ -2189,7 +2189,7 @@ void main() { sub2.close(); - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); }); @@ -2221,7 +2221,7 @@ void main() { container.refresh(provider); - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); }); @@ -2240,19 +2240,19 @@ void main() { }); container.read(provider); - verifyOnly(listener, listener(any)); + verifyOnly(listener, listener()); verifyZeroInteractions(listener2); isSecondBuild = true; container.refresh(provider); // Removed sub from refresh - verify(listener2(any)).called(1); + verify(listener2()).called(1); final sub = container.listen(provider, (previous, next) {}); sub.close(); - verify(listener2(any)).called(1); + verify(listener2()).called(1); verifyNoMoreInteractions(listener2); verifyNoMoreInteractions(listener); }); @@ -2262,7 +2262,7 @@ void main() { final container = ProviderContainer.test(); final listener = OnRemoveListener(); final listener2 = OnRemoveListener(); - when(listener(any)).thenThrow(42); + when(listener()).thenThrow(42); final provider = Provider((ref) { ref.onRemoveListener(listener.call); ref.onRemoveListener(listener2.call); @@ -2275,7 +2275,7 @@ void main() { (err, stack) => errors.add(err), ); - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); expect(errors, [42]); @@ -2292,7 +2292,7 @@ void main() { container.read(provider); - verifyOnly(listener, listener(any)); + verifyOnly(listener, listener()); }); test('calls listeners when container.listen is invoked', () { @@ -2306,13 +2306,13 @@ void main() { container.listen(provider, (previous, next) {}); - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); container.listen(provider, (previous, next) {}); - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); }); @@ -2339,13 +2339,13 @@ void main() { ref.listen(dep, (previous, next) {}); - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); ref.listen(dep, (previous, next) {}); - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); }); @@ -2378,20 +2378,20 @@ void main() { ref.watch(dep); - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); ref.watch(dep); // TODO changelog breaking: Calling ref.watch multiple times calls ref.onListen everytime - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); ref2.watch(dep); - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); }); @@ -2410,17 +2410,17 @@ void main() { }); container.read(provider); - verifyOnly(listener, listener(any)); + verifyOnly(listener, listener()); isSecondBuild = true; container.refresh(provider); // Added refresh listener - verifyOnly(listener2, listener2(any)); + verifyOnly(listener2, listener2()); container.listen(provider, (previous, next) {}); - verify(listener2(any)).called(1); + verify(listener2()).called(1); verifyNoMoreInteractions(listener2); verifyNoMoreInteractions(listener); }); @@ -2430,7 +2430,7 @@ void main() { final container = ProviderContainer.test(); final listener = OnAddListener(); final listener2 = OnAddListener(); - when(listener(any)).thenThrow(42); + when(listener()).thenThrow(42); final provider = Provider((ref) { ref.onAddListener(listener.call); ref.onAddListener(listener2.call); @@ -2441,7 +2441,7 @@ void main() { (err, stack) => errors.add(err), ); - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); expect(errors, [42]); @@ -2553,7 +2553,7 @@ void main() { ref.watch(dep); - verifyInOrder([listener(any), listener2(any)]); + verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); }); diff --git a/packages/riverpod/test/src/utils.dart b/packages/riverpod/test/src/utils.dart index 0d0292c8a..fc9554423 100644 --- a/packages/riverpod/test/src/utils.dart +++ b/packages/riverpod/test/src/utils.dart @@ -149,11 +149,11 @@ class OnPause extends Mock { } class OnAddListener extends Mock { - void call(ProviderSubscription? sub); + void call(); } class OnRemoveListener extends Mock { - void call(ProviderSubscription? sub); + void call(); } /// Syntax sugar for: From abb9a6122f89ce68981d4a89ac28ccb9e870c017 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 15 Sep 2024 01:27:50 +0200 Subject: [PATCH 343/387] Changelog --- packages/riverpod/CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 2f40e4c22..c9712f2b7 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -15,6 +15,8 @@ - `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. +- **Breaking**: `StreamProvider` now pauses its `StreamSubscription` when + the provider is not actively listened. - **Breaking**: A provider is now considered "paused" if all of its listeners are also paused. So if a provider `A` is watched _only_ by a provider `B`, and `B` is currently unused, then `A` will be paused. From fcee6f5e322e98a9651773076784606bc4c421c4 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 15 Sep 2024 01:43:12 +0200 Subject: [PATCH 344/387] Update codegen --- .../build_yaml/lib/dependencies.g.dart | 298 +++++++++--------- .../avoid_build_context_in_providers.g.dart | 1 - 2 files changed, 143 insertions(+), 156 deletions(-) diff --git a/packages/riverpod_generator/integration/build_yaml/lib/dependencies.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/dependencies.g.dart index 587d88f1d..5be9cfabb 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/dependencies.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/dependencies.g.dart @@ -6,191 +6,179 @@ part of 'dependencies.dart'; // RiverpodGenerator // ************************************************************************** -String _$calc2Hash() => r'0972ac060d49cb3f08f9192af9cea0611a6b4616'; - -/// Copied from Dart SDK -class _SystemHash { - _SystemHash._(); - - static int combine(int hash, int value) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + value); - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); - return hash ^ (hash >> 6); - } - - static int finish(int hash) { - // ignore: parameter_assignments - hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); - // ignore: parameter_assignments - hash = hash ^ (hash >> 11); - return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); - } -} +typedef Calc2Ref = Ref; -/// See also [calc2]. @ProviderFor(calc2) -const myFamilyCalc2ProviderFamily = Calc2Family(); - -/// See also [calc2]. -class Calc2Family extends Family { - /// See also [calc2]. - const Calc2Family(); +const myFamilyCalc2ProviderFamily = Calc2Family._(); + +final class Calc2Provider extends $FunctionalProvider + with $Provider { + const Calc2Provider._( + {required Calc2Family super.from, + required String super.argument, + int Function( + Calc2Ref ref, + String id, + )? create}) + : _createCb = create, + super( + retry: null, + name: r'myFamilyCalc2ProviderFamily', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); - /// See also [calc2]. - Calc2Provider call( + static const $allTransitiveDependencies0 = myCountPod; + static const $allTransitiveDependencies1 = myCountFuturePod; + static const $allTransitiveDependencies2 = myCountStreamPod; + static const $allTransitiveDependencies3 = myCountNotifierPod; + static const $allTransitiveDependencies4 = myCountAsyncNotifierPod; + static const $allTransitiveDependencies5 = myCountStreamNotifierPod; + static const $allTransitiveDependencies6 = myFamilyCount2ProviderFamily; + static const $allTransitiveDependencies7 = myFamilyCountFuture2ProviderFamily; + static const $allTransitiveDependencies8 = myFamilyCountStream2ProviderFamily; + static const $allTransitiveDependencies9 = + myFamilyCountNotifier2ProviderFamily; + static const $allTransitiveDependencies10 = + myFamilyCountAsyncNotifier2ProviderFamily; + static const $allTransitiveDependencies11 = + myFamilyCountStreamNotifier2ProviderFamily; + + final int Function( + Calc2Ref ref, String id, - ) { - return Calc2Provider( - id, - ); - } + )? _createCb; @override - Calc2Provider getProviderOverride( - covariant Calc2Provider provider, - ) { - return call( - provider.id, - ); - } - - static final Iterable _dependencies = { - myCountPod, - myCountFuturePod, - myCountStreamPod, - myCountNotifierPod, - myCountAsyncNotifierPod, - myCountStreamNotifierPod, - myFamilyCount2ProviderFamily, - myFamilyCountFuture2ProviderFamily, - myFamilyCountStream2ProviderFamily, - myFamilyCountNotifier2ProviderFamily, - myFamilyCountAsyncNotifier2ProviderFamily, - myFamilyCountStreamNotifier2ProviderFamily - }; + String debugGetCreateSourceHash() => _$calc2Hash(); @override - Iterable? get dependencies => _dependencies; - - static final Iterable _allTransitiveDependencies = - { - myCountPod, - ...?myCountPod.allTransitiveDependencies, - myCountFuturePod, - ...?myCountFuturePod.allTransitiveDependencies, - myCountStreamPod, - ...?myCountStreamPod.allTransitiveDependencies, - myCountNotifierPod, - ...?myCountNotifierPod.allTransitiveDependencies, - myCountAsyncNotifierPod, - ...?myCountAsyncNotifierPod.allTransitiveDependencies, - myCountStreamNotifierPod, - ...?myCountStreamNotifierPod.allTransitiveDependencies, - myFamilyCount2ProviderFamily, - ...?myFamilyCount2ProviderFamily.allTransitiveDependencies, - myFamilyCountFuture2ProviderFamily, - ...?myFamilyCountFuture2ProviderFamily.allTransitiveDependencies, - myFamilyCountStream2ProviderFamily, - ...?myFamilyCountStream2ProviderFamily.allTransitiveDependencies, - myFamilyCountNotifier2ProviderFamily, - ...?myFamilyCountNotifier2ProviderFamily.allTransitiveDependencies, - myFamilyCountAsyncNotifier2ProviderFamily, - ...?myFamilyCountAsyncNotifier2ProviderFamily.allTransitiveDependencies, - myFamilyCountStreamNotifier2ProviderFamily, - ...?myFamilyCountStreamNotifier2ProviderFamily.allTransitiveDependencies - }; + String toString() { + return r'myFamilyCalc2ProviderFamily' + '' + '($argument)'; + } - @override - Iterable? get allTransitiveDependencies => - _allTransitiveDependencies; + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + @$internal @override - String? get name => r'myFamilyCalc2ProviderFamily'; -} - -/// See also [calc2]. -class Calc2Provider extends AutoDisposeProvider { - /// See also [calc2]. - Calc2Provider( - String id, - ) : this._internal( - (ref) => calc2( - ref as Calc2Ref, - id, - ), - from: myFamilyCalc2ProviderFamily, - name: r'myFamilyCalc2ProviderFamily', - debugGetCreateSourceHash: - const bool.fromEnvironment('dart.vm.product') - ? null - : _$calc2Hash, - dependencies: Calc2Family._dependencies, - allTransitiveDependencies: Calc2Family._allTransitiveDependencies, - id: id, - ); - - Calc2Provider._internal( - super._createNotifier, { - required super.name, - required super.dependencies, - required super.allTransitiveDependencies, - required super.debugGetCreateSourceHash, - required super.from, - required this.id, - }) : super.internal(); - - final String id; + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); @override - Override overrideWith( - int Function(Calc2Ref provider) create, + Calc2Provider $copyWithCreate( + int Function( + Calc2Ref ref, + ) create, ) { - return ProviderOverride( - origin: this, - override: Calc2Provider._internal( - (ref) => create(ref as Calc2Ref), - from: from, - name: null, - dependencies: null, - allTransitiveDependencies: null, - debugGetCreateSourceHash: null, - id: id, - ), - ); + return Calc2Provider._( + argument: argument as String, + from: from! as Calc2Family, + create: ( + ref, + String id, + ) => + create(ref)); } @override - AutoDisposeProviderElement createElement() { - return _Calc2ProviderElement(this); + int create(Calc2Ref ref) { + final _$cb = _createCb ?? calc2; + final argument = this.argument as String; + return _$cb( + ref, + argument, + ); } @override bool operator ==(Object other) { - return other is Calc2Provider && other.id == id; + return other is Calc2Provider && other.argument == argument; } @override int get hashCode { - var hash = _SystemHash.combine(0, runtimeType.hashCode); - hash = _SystemHash.combine(hash, id.hashCode); - - return _SystemHash.finish(hash); + return argument.hashCode; } } -mixin Calc2Ref on AutoDisposeProviderRef { - /// The parameter `id` of this provider. - String get id; -} +String _$calc2Hash() => r'0972ac060d49cb3f08f9192af9cea0611a6b4616'; -class _Calc2ProviderElement extends AutoDisposeProviderElement - with Calc2Ref { - _Calc2ProviderElement(super.provider); +final class Calc2Family extends Family { + const Calc2Family._() + : super( + retry: null, + name: r'myFamilyCalc2ProviderFamily', + dependencies: const [ + myCountPod, + myCountFuturePod, + myCountStreamPod, + myCountNotifierPod, + myCountAsyncNotifierPod, + myCountStreamNotifierPod, + myFamilyCount2ProviderFamily, + myFamilyCountFuture2ProviderFamily, + myFamilyCountStream2ProviderFamily, + myFamilyCountNotifier2ProviderFamily, + myFamilyCountAsyncNotifier2ProviderFamily, + myFamilyCountStreamNotifier2ProviderFamily + ], + allTransitiveDependencies: const { + Calc2Provider.$allTransitiveDependencies0, + Calc2Provider.$allTransitiveDependencies1, + Calc2Provider.$allTransitiveDependencies2, + Calc2Provider.$allTransitiveDependencies3, + Calc2Provider.$allTransitiveDependencies4, + Calc2Provider.$allTransitiveDependencies5, + Calc2Provider.$allTransitiveDependencies6, + Calc2Provider.$allTransitiveDependencies7, + Calc2Provider.$allTransitiveDependencies8, + Calc2Provider.$allTransitiveDependencies9, + Calc2Provider.$allTransitiveDependencies10, + Calc2Provider.$allTransitiveDependencies11, + }, + isAutoDispose: true, + ); + + Calc2Provider call( + String id, + ) => + Calc2Provider._(argument: id, from: this); @override - String get id => (origin as Calc2Provider).id; + String debugGetCreateSourceHash() => _$calc2Hash(); + + @override + String toString() => r'myFamilyCalc2ProviderFamily'; + + /// {@macro riverpod.override_with} + Override overrideWith( + int Function( + Calc2Ref ref, + String args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (pointer) { + final provider = pointer.origin as Calc2Provider; + + final argument = provider.argument as String; + + return provider + .$copyWithCreate((ref) => create(ref, argument)) + .$createElement(pointer); + }, + ); + } } // ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member +// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 724b19e36..065501b23 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -344,7 +344,6 @@ abstract class _$MyNotifier extends $Notifier { BuildContext, { BuildContext context2, }); - // expect_lint: avoid_build_context_in_providers BuildContext get context1 => _$args.$1; // expect_lint: avoid_build_context_in_providers BuildContext get context2 => _$args.context2; From 8f0917cf6720dc192b7ce9271f911ba4079f1a6f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 15 Sep 2024 01:45:35 +0200 Subject: [PATCH 345/387] Fix lint --- packages/riverpod/test/meta_test.dart | 2 +- .../riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart | 2 +- .../lib/src/nodes/widget_ref_invocation.dart | 2 +- .../lib/src/nodes/widgets/stateful_widget.dart | 2 +- packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index d134387af..ccc67210c 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -184,7 +184,7 @@ class _PublicAPIVisitor extends GeneralizingElementVisitor { } void _verifyInheritsAnnotations(Element element) { - final parent = element.enclosingElement; + final parent = element.enclosingElement3; if (parent is! ClassElement) return; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart index 78275eb56..a18bdbce3 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart @@ -14,7 +14,7 @@ extension RefInvocationX on MethodInvocation { final functionOwner = function.staticElement .cast() ?.declaration - .enclosingElement; + .enclosingElement3; if (functionOwner == null || // Since Ref is sealed, checking that the function is from the package:riverpod diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart index 0968b75c2..827ef0688 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart @@ -19,7 +19,7 @@ extension WidgetRefInvocationX on MethodInvocation { final functionOwner = function.staticElement .cast() ?.declaration - .enclosingElement; + .enclosingElement3; if (functionOwner == null || // Since Ref is sealed, checking that the function is from the package:riverpod diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart index ce7f724d7..6bd15f065 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart @@ -21,7 +21,7 @@ ClassElement? _findStateFromReturnType(ClassElement node) { } ClassElement? _findStateWithMatchingGeneric(ClassElement node) { - for (final clazz in node.enclosingElement.classes) { + for (final clazz in node.enclosingElement3.classes) { final type = clazz.supertype; if (type != null && isState(type) && _findStateWidget(clazz) == node) { return clazz; diff --git a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart index 312af2e74..048eeed3b 100644 --- a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart +++ b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart @@ -55,7 +55,7 @@ class UnknownScopedUsage extends RiverpodLintRule { if (override?.provider == identifier) return; final enclosingConstructorType = identifier - .node.staticParameterElement?.enclosingElement + .node.staticParameterElement?.enclosingElement3 .safeCast() ?.returnType; // Silence the warning if passed to a widget constructor. From 980d0f1e0c21dbad41431a133fe838b1eea2dfa1 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 15 Sep 2024 01:47:16 +0200 Subject: [PATCH 346/387] Format --- .../test/consumer_listen_test.dart | 24 +++++++++++++------ 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/packages/flutter_riverpod/test/consumer_listen_test.dart b/packages/flutter_riverpod/test/consumer_listen_test.dart index 63f6585fe..76bc0ccfd 100644 --- a/packages/flutter_riverpod/test/consumer_listen_test.dart +++ b/packages/flutter_riverpod/test/consumer_listen_test.dart @@ -162,7 +162,9 @@ void main() { await tester.pumpWidget(Container()); expect( - container.readProviderElement(provider).hasNonWeakListeners, false); + container.readProviderElement(provider).hasNonWeakListeners, + false, + ); }); testWidgets('closes the subscription on provider change', (tester) async { @@ -182,9 +184,13 @@ void main() { ); expect( - container.readProviderElement(provider(0)).hasNonWeakListeners, true); - expect(container.readProviderElement(provider(1)).hasNonWeakListeners, - false); + container.readProviderElement(provider(0)).hasNonWeakListeners, + true, + ); + expect( + container.readProviderElement(provider(1)).hasNonWeakListeners, + false, + ); await tester.pumpWidget( UncontrolledProviderScope( @@ -198,10 +204,14 @@ void main() { ), ); - expect(container.readProviderElement(provider(0)).hasNonWeakListeners, - false); expect( - container.readProviderElement(provider(1)).hasNonWeakListeners, true); + container.readProviderElement(provider(0)).hasNonWeakListeners, + false, + ); + expect( + container.readProviderElement(provider(1)).hasNonWeakListeners, + true, + ); }); testWidgets('listen to the new provider on provider change', From 5fa05566ac0130df7da2d006003eaad2d74f460d Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 18 Sep 2024 00:45:55 +0200 Subject: [PATCH 347/387] Listen Visibility to pause subscriptions --- packages/flutter_riverpod/CHANGELOG.md | 1 + .../lib/src/core/consumer.dart | 46 ++++- .../test/src/core/consumer_test.dart | 183 +++++++++++++++++- .../lib/src/core/provider_subscription.dart | 2 +- .../src/core/provider_subscription_test.dart | 18 ++ 5 files changed, 244 insertions(+), 6 deletions(-) diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md index 75dd7aebb..093798bd1 100644 --- a/packages/flutter_riverpod/CHANGELOG.md +++ b/packages/flutter_riverpod/CHANGELOG.md @@ -1,5 +1,6 @@ ## Unreleased build +- **Breaking**: When a ConsumerWidgets stops being visible (based off `Visibility`), it now temporarily stops listening to providers. - **Breaking**: Removed all `Ref` subclasses (such `FutureProviderRef`). Use `Ref` directly instead. For `FutureProviderRef.future`, migrate to using an `AsyncNotifier`. diff --git a/packages/flutter_riverpod/lib/src/core/consumer.dart b/packages/flutter_riverpod/lib/src/core/consumer.dart index 79492aaae..d029ac4f1 100644 --- a/packages/flutter_riverpod/lib/src/core/consumer.dart +++ b/packages/flutter_riverpod/lib/src/core/consumer.dart @@ -69,6 +69,15 @@ typedef ConsumerBuilder = Widget Function( /// } /// ``` /// +/// ## Performance considerations +/// +/// To optimize performance by avoiding unnecessary network requests and +/// pausing unused streams, [Consumer] will temporarily stop listening to +/// providers when the widget stops being visible. +/// +/// This is determined using [Visibility.of], and will invoke +/// [ProviderSubscription.pause] on all currently active subscriptions. +/// /// See also: /// /// * [ConsumerWidget], a base-class for widgets that wants to listen to providers. @@ -349,6 +358,9 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { /// The [Element] for a [ConsumerStatefulWidget] ConsumerStatefulElement(ConsumerStatefulWidget super.widget); + @override + BuildContext get context => this; + late ProviderContainer _container = ProviderScope.containerOf(this); var _dependencies = , ProviderSubscription>{}; @@ -356,6 +368,19 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { _oldDependencies; final _listeners = >[]; List<_ListenManual>? _manualListeners; + bool? _visible; + + Iterable get _allSubscriptions sync* { + yield* _dependencies.values; + yield* _listeners; + if (_manualListeners != null) { + yield* _manualListeners!; + } + } + + void _applyVisibility(ProviderSubscription sub) { + if (_visible == false) sub.pause(); + } @override void didChangeDependencies() { @@ -372,6 +397,18 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { @override Widget build() { + final visible = Visibility.of(context); + if (visible != _visible) { + _visible = visible; + for (final sub in _allSubscriptions) { + if (visible) { + sub.resume(); + } else { + sub.pause(); + } + } + } + try { _oldDependencies = _dependencies; for (var i = 0; i < _listeners.length; i++) { @@ -404,10 +441,12 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { return oldDependency; } - return _container.listen( + final sub = _container.listen( target, (_, __) => markNeedsBuild(), ); + _applyVisibility(sub); + return sub; }).read() as Res; } @@ -448,6 +487,7 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { // which listen call was preserved between widget rebuild, and we wouldn't // want to call the listener on every rebuild. final sub = _container.listen(provider, listener, onError: onError); + _applyVisibility(sub); _listeners.add(sub); } @@ -501,13 +541,11 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { ) as ProviderSubscriptionWithOrigin, this, ); + _applyVisibility(sub); listeners.add(sub); return sub; } - - @override - BuildContext get context => this; } final class _ListenManual diff --git a/packages/flutter_riverpod/test/src/core/consumer_test.dart b/packages/flutter_riverpod/test/src/core/consumer_test.dart index 84b4c97f1..5ffbd24ff 100644 --- a/packages/flutter_riverpod/test/src/core/consumer_test.dart +++ b/packages/flutter_riverpod/test/src/core/consumer_test.dart @@ -1,3 +1,5 @@ +// ignore_for_file: invalid_use_of_internal_member + import 'dart:async'; import 'package:flutter/material.dart'; @@ -5,6 +7,29 @@ import 'package:flutter_riverpod/src/internals.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:riverpod/legacy.dart'; +class SimpleVisibility extends StatelessWidget { + const SimpleVisibility({ + super.key, + required this.visible, + required this.child, + }); + + final bool visible; + final Widget child; + + @override + Widget build(BuildContext context) { + return Visibility( + visible: visible, + maintainState: true, + maintainAnimation: true, + maintainSize: true, + maintainInteractivity: true, + child: child, + ); + } +} + void main() { group('_ListenManual', () { testWidgets('handles pause/resume', (tester) async { @@ -28,7 +53,6 @@ void main() { ); final container = ProviderScope.containerOf(ref.context); - // ignore: invalid_use_of_internal_member final element = container.readProviderElement(provider); expect(element.isActive, true); @@ -43,6 +67,163 @@ void main() { }); }); + group('Handles Visibility', () { + testWidgets( + 'when adding a listener, initializes pause state based on visibility', + (tester) async { + final providerForVisible = Provider((ref) => 0); + + await tester.pumpWidget( + ProviderScope( + child: Column( + children: [ + Consumer( + builder: (c, ref, _) { + ref.listen(providerForVisible, (_, __) {}); + ref.watch(providerForVisible); + ref.listenManual(providerForVisible, (_, __) {}); + + return const SizedBox(); + }, + ), + SimpleVisibility( + visible: false, + child: Consumer( + builder: (c, ref, _) { + ref.listen(_provider, (_, __) {}); + ref.watch(_provider); + ref.listenManual(_provider, (_, __) {}); + + return const SizedBox(); + }, + ), + ), + ], + ), + ), + ); + + final container = ProviderScope.containerOf( + tester.element(find.byType(Column)), + ); + final visibleElement = container.readProviderElement(providerForVisible); + final hiddenElement = container.readProviderElement(_provider); + + expect( + hiddenElement.dependents, + everyElement( + isA() + .having((e) => e.isPaused, 'isPaused', true), + ), + ); + expect( + visibleElement.dependents, + everyElement( + isA() + .having((e) => e.isPaused, 'isPaused', false), + ), + ); + }); + + testWidgets( + 'listenManual inside life-cycles before didChangeDependencies ' + 'on non-visible widgets does not paused twice', (tester) async { + late ProviderSubscription sub; + final widget = CallbackConsumerWidget( + initState: (context, ref) { + sub = ref.listenManual(_provider, (_, __) {}); + }, + ); + + await tester.pumpWidget( + ProviderScope( + child: SimpleVisibility(visible: false, child: widget), + ), + ); + + sub.resume(); + + expect(sub.isPaused, false); + }); + + testWidgets('when visibility changes, pause/resume listeners', + (tester) async { + late WidgetRef ref; + final widget = Consumer( + builder: (c, r, _) { + ref = r; + + return const SizedBox(); + }, + ); + + await tester.pumpWidget( + ProviderScope( + child: SimpleVisibility(visible: true, child: widget), + ), + ); + + final sub = ref.listenManual(_provider, (_, __) {}); + + await tester.pumpWidget( + ProviderScope( + child: SimpleVisibility(visible: false, child: widget), + ), + ); + + expect(sub.isPaused, true); + + await tester.pumpWidget( + ProviderScope( + child: SimpleVisibility(visible: true, child: widget), + ), + ); + + expect(sub.isPaused, false); + }); + + testWidgets( + 'when a dependency changes but visibility does not, do not pause/resume listeners', + (tester) async { + late WidgetRef ref; + final widget = Consumer( + builder: (context, r, _) { + // Subscribe to Theme + Theme.of(context); + ref = r; + + return const SizedBox(); + }, + ); + + await tester.pumpWidget( + ProviderScope( + child: Theme( + data: ThemeData.dark(), + child: SimpleVisibility(visible: false, child: widget), + ), + ), + ); + + final sub = ref.listenManual(_provider, (_, __) {}); + + await tester.pumpWidget( + ProviderScope( + child: Theme( + data: ThemeData.light(), + child: SimpleVisibility(visible: false, child: widget), + ), + ), + ); + + expect(sub.isPaused, true); + + sub.resume(); + + expect(sub.isPaused, false); + }); + }); + testWidgets('Riverpod test', (tester) async { // Regression test for https://github.com/rrousselGit/riverpod/pull/3156 diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index 8ee6ff93f..c1440738c 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -84,7 +84,7 @@ mixin _OnPauseMixin { if (_pauseCount == 1) { onResume(); } - _pauseCount = math.min(_pauseCount - 1, 0); + _pauseCount = math.max(_pauseCount - 1, 0); } void onResume(); diff --git a/packages/riverpod/test/src/core/provider_subscription_test.dart b/packages/riverpod/test/src/core/provider_subscription_test.dart index e3a882b8d..7fc3ad108 100644 --- a/packages/riverpod/test/src/core/provider_subscription_test.dart +++ b/packages/riverpod/test/src/core/provider_subscription_test.dart @@ -130,5 +130,23 @@ void main() { verifyNoMoreInteractions(onError); verifyZeroInteractions(listener); }); + + test('needs to be called as many times as pause() was called', () { + final container = ProviderContainer.test(); + final provider = Provider((ref) => 0); + + final sub = container.listen(provider, (p, b) {}); + + sub.pause(); + sub.pause(); + sub.pause(); + + sub.resume(); + expect(sub.isPaused, true); + sub.resume(); + expect(sub.isPaused, true); + sub.resume(); + expect(sub.isPaused, false); + }); }); } From 027c75693585d457ecb402b61a6255593de9c189 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 18 Sep 2024 01:48:02 +0200 Subject: [PATCH 348/387] Fix AST caching --- .../lib/src/analyzer_utils.dart | 50 +++++++------------ .../lib/src/nodes.g.dart | 7 ++- .../lib/src/nodes/dependencies.dart | 32 +++++++++--- .../lib/src/nodes/provider_listenable.dart | 4 +- .../lib/src/nodes/providers/function.dart | 4 +- .../lib/src/nodes/providers/identifiers.dart | 4 +- .../lib/src/nodes/providers/legacy.dart | 4 +- .../lib/src/nodes/providers/notifier.dart | 4 +- .../lib/src/nodes/ref_invocation.dart | 4 +- .../lib/src/nodes/riverpod.dart | 8 ++- .../lib/src/nodes/scopes/overrides.dart | 8 ++- .../src/nodes/scopes/provider_container.dart | 5 +- .../lib/src/nodes/scopes/provider_scope.dart | 5 +- .../lib/src/nodes/widget_ref_invocation.dart | 4 +- .../lib/src/nodes/widgets/widget.dart | 8 ++- .../lib/src/lints/unknown_scoped_usage.dart | 5 +- 16 files changed, 96 insertions(+), 60 deletions(-) diff --git a/packages/riverpod_analyzer_utils/lib/src/analyzer_utils.dart b/packages/riverpod_analyzer_utils/lib/src/analyzer_utils.dart index d7c59c038..1d9bd8d1f 100644 --- a/packages/riverpod_analyzer_utils/lib/src/analyzer_utils.dart +++ b/packages/riverpod_analyzer_utils/lib/src/analyzer_utils.dart @@ -1,49 +1,35 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:meta/meta.dart'; -@immutable -class _Key { - const _Key(this.value, this.name); - - final Object value; - final String name; - - @override - bool operator ==(Object other) { - return other is _Key && other.value == value && other.name == name; - } - - @override - int get hashCode => Object.hash(value, name); -} - -class _Box { - _Box(this.value); +@internal +class Box { + Box(this.value); final T value; } @internal extension AstUtils on AstNode { - static final _cache = Expando<_Box>(); - R upsert( - String keyPart, + Iterable get ancestors sync* { + var parent = this.parent; + while (parent != null) { + yield parent; + parent = parent.parent; + } + } +} + +@internal +extension ExpandoUtils on Expando> { + R upsert( + AstNode key, R Function() create, ) { - final key = _Key(this, keyPart); // Using a record to differentiate "null value" from "no value". - final existing = _cache[key] as _Box?; + final existing = this[key]; if (existing != null) return existing.value; final created = create(); - _cache[key] = _Box(created); + this[key] = Box(created); return created; } - - Iterable get ancestors sync* { - var parent = this.parent; - while (parent != null) { - yield parent; - parent = parent.parent; - } - } } diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes.g.dart b/packages/riverpod_analyzer_utils/lib/src/nodes.g.dart index 68564be3b..31e7aa8e2 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes.g.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes.g.dart @@ -726,13 +726,12 @@ class RiverpodAnalysisResult extends RecursiveRiverpodAstVisitor { } class RiverpodAstRegistry { + static final cache = Expando>>(); + void run(AstNode node) { final previousErrorReporter = errorReporter; try { - final errors = node.upsert( - 'RiverpodAstRegistry.errors', - () => [], - ); + final errors = cache.upsert(node, () => []); final visitor = _RiverpodAstRegistryVisitor(this); errorReporter = errors.add; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart index 7823c1d3a..73e42b417 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart @@ -1,8 +1,10 @@ part of '../nodes.dart'; extension on CollectionElement { + static final _cache = Expando>(); + ProviderDependency? get providerDependency { - return upsert('ProviderDependency', () { + return _cache.upsert(this, () { final that = this; if (that is! Expression) { errorReporter( @@ -88,8 +90,10 @@ final class ProviderDependency { } extension on Expression { + static final _cache = Expando>(); + ProviderDependencyList? get providerDependencyList { - return upsert('ProviderDependencyList', () { + return _cache.upsert(this, () { final that = this; // explicit null, count as valid value (no dependencies) if (that is NullLiteral) { @@ -296,8 +300,10 @@ extension AccumulatedDependenciesX on AstNode { } extension on InstanceCreationExpression { + static final _cache = Expando>(); + AccumulatedDependencyList? get accumulatedDependencies { - return upsert('InstanceCreationExpression#accumulatedDependencies', () { + return _cache.upsert(this, () { final providerScope = this.providerScope; if (providerScope == null) return null; @@ -313,8 +319,10 @@ extension on InstanceCreationExpression { } extension on AnnotatedNode { + static final _cache = Expando>(); + AccumulatedDependencyList? get accumulatedDependencies { - return upsert('#AnnotatedNodeAccumulatedDependencies', () { + return _cache.upsert(this, () { final provider = cast()?.provider; // Have State inherit dependencies from its widget final state = cast()?.state; @@ -347,8 +355,10 @@ class IdentifierDependencies { @_ast extension IdentifierDependenciesX on Identifier { + static final _cache = Expando>(); + IdentifierDependencies? get identifierDependencies { - return upsert('Identifier#identifierDependencies', () { + return _cache.upsert(this, () { final staticElement = this.staticElement; if (staticElement == null) return null; @@ -372,8 +382,10 @@ class NamedTypeDependencies { @_ast extension NamedTypeDependenciesX on NamedType { + static final _cache = Expando>(); + NamedTypeDependencies? get typeAnnotationDependencies { - return upsert('NamedType#typeAnnotationDependencies', () { + return _cache.upsert(this, () { final staticElement = type?.element; if (staticElement == null) return null; @@ -389,8 +401,10 @@ extension NamedTypeDependenciesX on NamedType { } extension DependenciesAnnotatedAnnotatedNodeOfX on AnnotatedNode { + static final _cache = Expando>(); + DependenciesAnnotation? get dependencies { - return upsert('DependenciesAnnotationAnnotatedNodeX', () { + return _cache.upsert(this, () { return metadata.map((e) => e.dependencies).nonNulls.firstOrNull; }); } @@ -398,8 +412,10 @@ extension DependenciesAnnotatedAnnotatedNodeOfX on AnnotatedNode { @_ast extension DependenciesAnnotatedAnnotatedNodeX on Annotation { + static final _cache = Expando>(); + DependenciesAnnotation? get dependencies { - return upsert('DependenciesAnnotation', () { + return _cache.upsert(this, () { final elementAnnotation = this.elementAnnotation; final element = this.element; if (element == null || elementAnnotation == null) return null; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/provider_listenable.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/provider_listenable.dart index f33d8349b..2c76d990e 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/provider_listenable.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/provider_listenable.dart @@ -2,8 +2,10 @@ part of '../nodes.dart'; @_ast extension ProviderListenableExpressionX on Expression { + static final _cache = Expando>(); + ProviderListenableExpression? get providerListenable { - return upsert('ProviderListenableExpression', () { + return _cache.upsert(this, () { final returnType = staticType; if (returnType == null) return null; if (!providerListenableType.isAssignableFromType(returnType)) return null; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/function.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/function.dart index 6a8ad92f7..0c903c5f5 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/function.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/function.dart @@ -2,8 +2,10 @@ part of '../../nodes.dart'; @_ast extension FunctionalProviderDeclarationX on FunctionDeclaration { + static final _cache = Expando>(); + FunctionalProviderDeclaration? get provider { - return upsert('FunctionalProviderDeclaration', () { + return _cache.upsert(this, () { final element = declaredElement; if (element == null) return null; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/identifiers.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/identifiers.dart index 8e7acd125..c9ce8aa84 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/identifiers.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/identifiers.dart @@ -2,8 +2,10 @@ part of '../../nodes.dart'; @_ast extension ProviderIdentifierX on SimpleIdentifier { + static final _cache = Expando>(); + ProviderIdentifier? get provider { - return upsert('ProviderIdentifier', () { + return _cache.upsert(this, () { final element = staticElement; if (element is! PropertyAccessorElement) return null; final variable = element.variable2; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/legacy.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/legacy.dart index 4e6a76c9e..489e951ca 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/legacy.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/legacy.dart @@ -49,8 +49,10 @@ final class LegacyProviderDependency { @_ast extension LegacyProviderDeclarationX on VariableDeclaration { + static final _cache = Expando>(); + LegacyProviderDeclaration? get provider { - return upsert('LegacyProviderDeclaration', () { + return _cache.upsert(this, () { final element = declaredElement; if (element == null) return null; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/notifier.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/notifier.dart index 6217f2df6..639a4b198 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/notifier.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/notifier.dart @@ -2,8 +2,10 @@ part of '../../nodes.dart'; @_ast extension ClassBasedProviderDeclarationX on ClassDeclaration { + static final _cache = Expando>(); + ClassBasedProviderDeclaration? get provider { - return upsert('ClassBasedProviderDeclaration', () { + return _cache.upsert(this, () { final element = declaredElement; if (element == null) return null; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart index a18bdbce3..e69a3f494 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart @@ -2,8 +2,10 @@ part of '../nodes.dart'; @_ast extension RefInvocationX on MethodInvocation { + static final _cache = Expando>(); + RefInvocation? get refInvocation { - return upsert('RefInvocation', () { + return _cache.upsert(this, () { final targetType = realTarget?.staticType; if (targetType == null) return null; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart index 4f3094f2f..2e71ac507 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart @@ -1,8 +1,10 @@ part of '../nodes.dart'; extension RiverpodAnnotatedAnnotatedNodeOfX on AnnotatedNode { + static final _cache = Expando>(); + RiverpodAnnotation? get riverpod { - return upsert('RiverpodAnnotationAnnotatedNodeX', () { + return _cache.upsert(this, () { return metadata.map((e) => e.riverpod).nonNulls.firstOrNull; }); } @@ -10,8 +12,10 @@ extension RiverpodAnnotatedAnnotatedNodeOfX on AnnotatedNode { @_ast extension RiverpodAnnotatedAnnotatedNodeX on Annotation { + static final _cache = Expando>(); + RiverpodAnnotation? get riverpod { - return upsert('RiverpodAnnotation', () { + return _cache.upsert(this, () { final elementAnnotation = this.elementAnnotation; final element = this.element; if (element == null || elementAnnotation == null) return null; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/overrides.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/overrides.dart index 9c729153f..7caad7890 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/overrides.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/overrides.dart @@ -2,8 +2,10 @@ part of '../../nodes.dart'; @_ast extension ProviderOverrideExpressionX on CollectionElement { + static final _cache = Expando>(); + ProviderOverrideExpression? get providerOverride { - return upsert('ProviderOverrideExpression', () { + return _cache.upsert(this, () { final expression = this; if (expression is! Expression) return null; @@ -41,8 +43,10 @@ final class ProviderOverrideExpression { @_ast extension ProviderOverrideListX on Expression { + static final _cache = Expando>(); + ProviderOverrideList? get overrides { - return upsert('ProviderOverrideList', () { + return _cache.upsert(this, () { final expression = this; final type = staticType; if (type == null || !type.isDartCoreList) return null; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_container.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_container.dart index 5d41dcb39..9549ae326 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_container.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_container.dart @@ -3,8 +3,11 @@ part of '../../nodes.dart'; @_ast extension ProviderContainerInstanceCreationExpressionX on InstanceCreationExpression { + static final _cache = + Expando>(); + ProviderContainerInstanceCreationExpression? get providerContainer { - return upsert('ProviderContainerInstanceCreationExpression', () { + return _cache.upsert(this, () { final createdType = constructorName.type.type; if (createdType == null || !providerContainerType.isExactlyType(createdType)) { diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_scope.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_scope.dart index 69d1c5a74..50c7efb2a 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_scope.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/scopes/provider_scope.dart @@ -3,8 +3,11 @@ part of '../../nodes.dart'; @_ast extension ProviderScopeInstanceCreationExpressionX on InstanceCreationExpression { + static final _cache = + Expando>(); + ProviderScopeInstanceCreationExpression? get providerScope { - return upsert('ProviderScopeInstanceCreationExpression', () { + return _cache.upsert(this, () { final createdType = constructorName.type.type; if (createdType == null || !providerScopeType.isExactlyType(createdType)) { diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart index 827ef0688..5bdf93f49 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart @@ -2,8 +2,10 @@ part of '../nodes.dart'; @_ast extension WidgetRefInvocationX on MethodInvocation { + static final _cache = Expando>(); + WidgetRefInvocation? get widgetRefInvocation { - return upsert('WidgetRefInvocation', () { + return _cache.upsert(this, () { final targetType = realTarget?.staticType; if (targetType == null) return null; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/widget.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/widget.dart index 1c4ba9ced..0e505a0f8 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/widget.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/widget.dart @@ -2,8 +2,10 @@ part of '../../nodes.dart'; @_ast extension WidgetX on ClassDeclaration { + static final _cache1 = Expando>(); + WidgetDeclaration? get widget { - return upsert('Widget', () { + return _cache1.upsert(this, () { final type = extendsClause?.superclass.type; if (type == null) return null; @@ -19,8 +21,10 @@ extension WidgetX on ClassDeclaration { }); } + static final _cache2 = Expando>(); + StateDeclaration? get state { - return upsert('State', () { + return _cache2.upsert(this, () { final type = extendsClause?.superclass.type; if (type == null) return null; diff --git a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart index 048eeed3b..fb312d515 100644 --- a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart +++ b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart @@ -62,7 +62,10 @@ class UnknownScopedUsage extends RiverpodLintRule { if (enclosingConstructorType != null && widgetType.isAssignableFromType(enclosingConstructorType)) return; - reporter.atNode(identifier.node, code); + reporter.atNode( + identifier.node, + code, + ); }); } } From 088cfcc6a6c144b9db21ecc64d3c9d42b7efda7c Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 18 Sep 2024 01:51:57 +0200 Subject: [PATCH 349/387] Remove unused default --- packages/riverpod/lib/src/core/element.dart | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 547506a12..53e0b9b97 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -483,7 +483,6 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu newState.stackTrace, ); } - default: } for (final observer in container.observers) { From f6e5e015facd1ba6e745f0a518dc155f066c0560 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 18 Sep 2024 02:01:01 +0200 Subject: [PATCH 350/387] Fix test --- .../test/nodes/riverpod_test.dart | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/riverpod_analyzer_utils_tests/test/nodes/riverpod_test.dart b/packages/riverpod_analyzer_utils_tests/test/nodes/riverpod_test.dart index c40685067..62c1f2a66 100644 --- a/packages/riverpod_analyzer_utils_tests/test/nodes/riverpod_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/nodes/riverpod_test.dart @@ -73,7 +73,7 @@ int eight(EightRef ref) => 0; ); expect( errors[4].targetElement.toString(), - 'Riverpod Riverpod({bool keepAlive = false, List? dependencies})', + 'Riverpod Riverpod({bool keepAlive = false, List? dependencies, Duration? Function(int, Object)? retry})', ); expect( @@ -88,7 +88,7 @@ int eight(EightRef ref) => 0; ); expect( errors[6].targetElement.toString(), - 'Riverpod Riverpod({bool keepAlive = false, List? dependencies})', + 'Riverpod Riverpod({bool keepAlive = false, List? dependencies, Duration? Function(int, Object)? retry})', ); expect( @@ -103,7 +103,7 @@ int eight(EightRef ref) => 0; ); expect( errors[8].targetElement.toString(), - 'Riverpod Riverpod({bool keepAlive = false, List? dependencies})', + 'Riverpod Riverpod({bool keepAlive = false, List? dependencies, Duration? Function(int, Object)? retry})', ); expect( From 4e4c4ba26ec70bf2a615610d30e606a295550c04 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 18 Sep 2024 02:08:39 +0200 Subject: [PATCH 351/387] Fix codegen --- .../lint_visitor_generator/lib/builder.dart | 22 +++++++++++-------- .../lib/src/nodes.g.dart | 7 ++++-- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/packages/lint_visitor_generator/lib/builder.dart b/packages/lint_visitor_generator/lib/builder.dart index 12a98c422..d72e149bb 100644 --- a/packages/lint_visitor_generator/lib/builder.dart +++ b/packages/lint_visitor_generator/lib/builder.dart @@ -43,13 +43,15 @@ class _LintVisitorGenerator extends Generator { .expand((extension) { final constraint = extension.extendedType; - return extension.accessors.map( - (e) => ( - constraint: constraint.element!.name!, - type: e.returnType.element!.name!, - name: e.name, - ), - ); + return extension.accessors + .map( + (e) => ( + constraint: constraint.element!.name!, + type: e.returnType.element!.name!, + name: e.name, + ), + ) + .where((e) => !e.name.startsWith('_cache')); }).toList(); final byConstraint = <({ @@ -146,11 +148,13 @@ class RiverpodAnalysisResult extends RecursiveRiverpodAstVisitor { } class RiverpodAstRegistry { + static final _cache = Expando>>(); + void run(AstNode node) { final previousErrorReporter = errorReporter; try { - final errors = node.upsert( - 'RiverpodAstRegistry.errors', + final errors = _cache.upsert( + node, () => [], ); diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes.g.dart b/packages/riverpod_analyzer_utils/lib/src/nodes.g.dart index 31e7aa8e2..e0694f4e5 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes.g.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes.g.dart @@ -726,12 +726,15 @@ class RiverpodAnalysisResult extends RecursiveRiverpodAstVisitor { } class RiverpodAstRegistry { - static final cache = Expando>>(); + static final _cache = Expando>>(); void run(AstNode node) { final previousErrorReporter = errorReporter; try { - final errors = cache.upsert(node, () => []); + final errors = _cache.upsert( + node, + () => [], + ); final visitor = _RiverpodAstRegistryVisitor(this); errorReporter = errors.add; From a21ea32f7a5f9e5704ce1a09a547c980a393995a Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Nov 2024 15:11:54 +0100 Subject: [PATCH 352/387] Update Ref --- .gitattributes | 1 + .github/workflows/build.yml | 3 +- .github/workflows/riverpod_lint.yml | 1 + CONTRIBUTING.md | 2 +- README.md | 2 +- examples/counter/lib/main.g.dart | 2 +- examples/counter/pubspec.yaml | 2 +- examples/marvel/pubspec.yaml | 2 +- examples/pub/lib/detail.dart | 6 +- examples/pub/lib/detail.g.dart | 8 +- examples/pub/lib/search.dart | 2 +- examples/pub/lib/search.g.dart | 4 +- examples/pub/pubspec.yaml | 2 +- examples/random_number/lib/main.dart | 15 +- examples/random_number/pubspec.yaml | 2 +- examples/stackoverflow/lib/common.dart | 2 +- examples/stackoverflow/lib/question.dart | 2 +- examples/stackoverflow/lib/tag.dart | 2 +- examples/stackoverflow/pubspec.yaml | 2 +- examples/todos/pubspec.yaml | 4 +- packages/flutter_riverpod/CHANGELOG.md | 17 + ...dispose_change_notifier_provider_test.dart | 2 +- .../change_notifier_provider_test.dart | 2 +- packages/hooks_riverpod/CHANGELOG.md | 17 + .../hooks_riverpod/test/analysis_options.yaml | 5 + packages/riverpod/CHANGELOG.md | 19 +- .../src/core/provider/notifier_provider.dart | 14 + packages/riverpod/lib/src/core/ref.dart | 16 +- packages/riverpod/pubspec.yaml | 3 +- packages/riverpod/pubspec_overrides.yaml | 2 +- packages/riverpod_analyzer_utils/CHANGELOG.md | 11 +- .../lib/src/nodes/dependencies.dart | 4 +- .../lib/src/nodes/provider_or_family.dart | 4 +- packages/riverpod_analyzer_utils/pubspec.yaml | 4 +- .../pubspec.yaml | 2 +- packages/riverpod_annotation/CHANGELOG.md | 12 + .../lib/riverpod_annotation.dart | 2 +- packages/riverpod_generator/CHANGELOG.md | 25 +- packages/riverpod_generator/README.md | 4 +- .../build_yaml/lib/dependencies.dart | 2 +- .../build_yaml/lib/dependencies.g.dart | 4 +- .../integration/build_yaml/lib/main.dart | 12 +- .../integration/build_yaml/lib/main.g.dart | 14 +- .../lib/src/riverpod_generator.dart | 2 +- packages/riverpod_generator/pubspec.yaml | 2 +- .../test/integration/annotated.g.dart | 2 +- .../test/integration/async.dart | 10 +- .../test/integration/async.g.dart | 12 +- .../test/integration/auto_dispose.dart | 12 +- .../test/integration/auto_dispose.g.dart | 14 +- .../test/integration/dependencies.dart | 27 +- .../test/integration/dependencies.g.dart | 28 +- .../test/integration/dependencies2.dart | 8 +- .../test/integration/dependencies2.g.dart | 10 +- .../test/integration/documented.dart | 4 +- .../test/integration/documented.g.dart | 6 +- .../test/integration/generated.dart | 29 +- .../test/integration/generated.g.dart | 140 +++-- .../test/integration/hash/hash1.dart | 4 +- .../test/integration/hash/hash1.g.dart | 6 +- .../test/integration/hash/retry.dart | 4 +- .../test/integration/hash/retry.g.dart | 6 +- .../test/integration/scopes.g.dart | 2 +- .../test/integration/split.dart | 4 +- .../test/integration/split.g.dart | 6 +- .../test/integration/split2.dart | 2 +- .../test/integration/stream.dart | 8 +- .../test/integration/stream.g.dart | 10 +- .../test/integration/sync.dart | 28 +- .../test/integration/sync.g.dart | 24 +- packages/riverpod_graph/lib/src/analyze.dart | 5 +- packages/riverpod_graph/pubspec.yaml | 2 +- .../generated/golden/lib/sync.dart | 8 +- .../generated/golden/lib/sync.g.dart | 10 +- packages/riverpod_lint/CHANGELOG.md | 19 +- packages/riverpod_lint/README.md | 42 +- .../convert_to_stateful_base_widget.dart | 5 +- .../convert_to_stateless_base_widget.dart | 5 +- .../lints/async_value_nullable_pattern.dart | 5 +- .../lib/src/lints/functional_ref.dart | 83 ++- .../lib/src/lints/missing_provider_scope.dart | 5 +- .../lib/src/lints/notifier_build.dart | 9 +- .../lib/src/lints/provider_parameters.dart | 12 +- .../lib/src/lints/unknown_scoped_usage.dart | 8 +- .../lib/src/riverpod_custom_lint.dart | 4 +- packages/riverpod_lint/pubspec.yaml | 8 +- packages/riverpod_lint/pubspec_overrides.yaml | 2 - .../analysis_options.yaml | 8 +- .../riverpod_lint_flutter_test/pubspec.yaml | 5 +- ..._class_based_provider_to_functional.g.dart | 2 +- ...ass_based_provider_to_functional_test.dart | 28 +- ...rt_functional_provider_to_class_based.dart | 4 +- ..._functional_provider_to_class_based.g.dart | 6 +- ...nctional_provider_to_class_based_test.dart | 36 +- .../convert_to_widget_test.dart | 122 ++--- ...rt_class_based_provider_to_functional.diff | 10 +- ...rt_functional_provider_to_class_based.diff | 8 +- .../assists/wrap_widget/wrap_widget_test.dart | 43 +- .../test/encoders.dart | 4 +- .../avoid_build_context_in_providers.dart | 4 +- .../avoid_build_context_in_providers.g.dart | 42 +- .../avoid_public_notifier_properties.g.dart | 2 +- .../failing_functional_ref.dart | 3 + .../lints/functional_ref/fix/auto_import.dart | 17 + .../lints/functional_ref/fix/auto_import.diff | 100 ++++ .../functional_ref/fix/auto_import.g.dart | 190 +++++++ .../fix/failing_functional_ref.diff | 36 ++ .../functional_ref/fix/functional_ref.diff | 20 + .../fix/functional_ref_test.dart | 78 +++ .../lints/functional_ref/fix/use_prefix.dart | 19 + .../lints/functional_ref/fix/use_prefix.diff | 34 ++ .../functional_ref/fix/use_prefix.g.dart | 190 +++++++ .../lints/functional_ref/functional_ref.dart | 13 +- .../functional_ref/functional_ref.g.dart | 349 +----------- .../avoid_build_context_in_providers_lint.md | 14 +- .../failing_functional_ref_fix.diff | 22 +- .../failing_functional_ref_lint.md | 6 +- .../functional_ref/functional_ref_fix.diff | 38 +- .../functional_ref/functional_ref_lint.md | 34 +- ...y_use_keep_alive_inside_keep_alive_lint.md | 4 +- .../missing_dependencies2_fix.diff | 75 ++- .../missing_dependencies2_lint.md | 124 ++++- .../missing_dependencies_fix.diff | 8 +- .../missing_dependencies_lint.md | 22 +- .../unsupported_provider_value_lint.md | 32 +- .../test/lints/notifier_extends.g.dart | 2 +- ...only_use_keep_alive_inside_keep_alive.dart | 6 +- ...ly_use_keep_alive_inside_keep_alive.g.dart | 2 +- .../protected_notifier_properties.g.dart | 2 +- .../lints/provider_dependencies/another.dart | 6 +- .../provider_dependencies/another.g.dart | 8 +- .../missing_dependencies.dart | 20 +- .../missing_dependencies.g.dart | 22 +- .../missing_dependencies2.dart | 99 +++- .../missing_dependencies2.g.dart | 512 +++++++++++++++++- .../unused_dependency.dart | 18 +- .../unused_dependency.g.dart | 2 +- .../test/lints/provider_parameters.dart | 2 +- .../test/lints/provider_parameters.g.dart | 4 +- ...providers_should_specify_dependencies.dart | 4 +- ...oviders_should_specify_dependencies.g.dart | 6 +- .../test/lints/unknown_scoped_usage.dart | 4 +- .../test/lints/unknown_scoped_usage.g.dart | 2 +- .../lints/unsupported_provider_value.dart | 27 +- .../lints/unsupported_provider_value.g.dart | 28 +- .../test/test_lint.dart | 144 ++++- .../docs/advanced/select/select/codegen.dart | 2 +- .../advanced/select/select/codegen.g.dart | 4 +- .../advanced/select/select_async/codegen.dart | 4 +- .../select/select_async/codegen.g.dart | 4 +- .../cancel/detail_screen/codegen.dart | 2 +- .../cancel/detail_screen/codegen.g.dart | 4 +- .../cancel/detail_screen_cancel/codegen.dart | 2 +- .../detail_screen_cancel/codegen.g.dart | 4 +- .../detail_screen_debounce/codegen.dart | 2 +- .../detail_screen_debounce/codegen.g.dart | 4 +- .../provider_with_extension/codegen.dart | 2 +- .../provider_with_extension/codegen.g.dart | 4 +- .../fetch_activity/codegen.dart | 2 +- .../fetch_activity/codegen.g.dart | 4 +- .../pull_to_refresh/full_app/codegen.dart | 2 +- .../pull_to_refresh/full_app/codegen.g.dart | 4 +- website/docs/concepts/about_codegen/main.dart | 2 +- .../docs/concepts/about_codegen/main.g.dart | 4 +- .../provider_type/async_class_future.g.dart | 2 +- .../provider_type/async_class_stream.g.dart | 2 +- .../provider_type/async_fn_future.dart | 2 +- .../provider_type/async_fn_future.g.dart | 4 +- .../provider_type/async_fn_stream.dart | 2 +- .../provider_type/async_fn_stream.g.dart | 4 +- .../provider_type/auto_dispose.dart | 4 +- .../provider_type/auto_dispose.g.dart | 6 +- .../about_codegen/provider_type/family.dart | 2 +- .../about_codegen/provider_type/family.g.dart | 4 +- .../provider_type/family_class.g.dart | 2 +- .../provider_type/family_fn.dart | 2 +- .../provider_type/family_fn.g.dart | 4 +- .../provider_type/sync_class.g.dart | 2 +- .../about_codegen/provider_type/sync_fn.dart | 2 +- .../provider_type/sync_fn.g.dart | 4 +- website/docs/concepts/about_hooks.mdx | 2 +- .../docs/concepts/async_initialization.dart | 28 +- .../characters_provider/codegen.dart | 6 +- .../characters_provider/codegen.g.dart | 6 +- .../city_provider/codegen.dart | 2 +- .../city_provider/codegen.g.dart | 4 +- .../filtered_todo_list_provider/codegen.dart | 4 +- .../codegen.g.dart | 4 +- .../read_in_provider/codegen.dart | 4 +- .../read_in_provider/codegen.g.dart | 6 +- .../select_async_provider/codegen.dart | 8 +- .../select_async_provider/codegen.g.dart | 6 +- .../todo_list_provider/codegen.g.dart | 2 +- .../weather_provider/codegen.dart | 4 +- .../weather_provider/codegen.g.dart | 6 +- .../whole_object_provider/codegen.dart | 4 +- .../whole_object_provider/codegen.g.dart | 6 +- .../lifecycle_on_dispose/codegen.dart | 2 +- .../lifecycle_on_dispose/codegen.g.dart | 4 +- .../creating_a_provider/codegen.dart | 2 +- .../creating_a_provider/codegen.g.dart | 4 +- .../declaring_many_providers/codegen.dart | 4 +- .../declaring_many_providers/codegen.g.dart | 6 +- .../concepts/reading/counter/codegen.dart | 2 +- .../concepts/reading/counter/codegen.g.dart | 2 +- .../docs/concepts/reading/listen/codegen.dart | 2 +- .../concepts/reading/listen/codegen.g.dart | 4 +- .../reading/listen_build/codegen.g.dart | 2 +- .../reading/listen_build/codegen_hooks.g.dart | 2 +- .../concepts/reading/provider/codegen.dart | 4 +- .../concepts/reading/provider/codegen.g.dart | 6 +- .../docs/concepts/reading/read/codegen.g.dart | 2 +- .../reading/read/codegen_hooks.g.dart | 2 +- .../reading/read_build/codegen.g.dart | 2 +- .../read_notifier_build/codegen.g.dart | 2 +- .../docs/concepts/reading/watch/codegen.dart | 4 +- .../concepts/reading/watch/codegen.g.dart | 6 +- .../concepts/reading/watch_build/codegen.dart | 2 +- .../reading/watch_build/codegen.g.dart | 4 +- .../reading/watch_build/codegen_hooks.dart | 2 +- .../reading/watch_build/codegen_hooks.g.dart | 4 +- .../watch_notifier_build/codegen.g.dart | 2 +- website/docs/concepts/scopes.mdx | 2 +- .../concepts/why_immutability/codegen.g.dart | 2 +- .../auto_dispose/cache_for_extension.dart | 2 +- .../auto_dispose/cache_for_usage/codegen.dart | 2 +- .../cache_for_usage/codegen.g.dart | 4 +- .../auto_dispose/codegen_keep_alive.dart | 2 +- .../auto_dispose/codegen_keep_alive.g.dart | 4 +- .../invalidate_family_example/codegen.dart | 2 +- .../invalidate_family_example/codegen.g.dart | 4 +- .../auto_dispose/keep_alive/codegen.dart | 2 +- .../auto_dispose/keep_alive/codegen.g.dart | 4 +- .../on_dispose_example/codegen.dart | 4 +- .../on_dispose_example/codegen.g.dart | 6 +- .../docs/essentials/combining_requests.mdx | 4 +- .../functional_ref/codegen.dart | 4 +- .../functional_ref/codegen.g.dart | 6 +- .../listen_example/codegen.dart | 4 +- .../listen_example/codegen.g.dart | 4 +- .../notifier_ref/codegen.dart | 2 +- .../notifier_ref/codegen.g.dart | 4 +- .../read_example/codegen.dart | 2 +- .../read_example/codegen.g.dart | 2 +- .../watch_example/codegen.dart | 5 +- .../watch_example/codegen.g.dart | 6 +- .../watch_placement/codegen.dart | 4 +- .../watch_placement/codegen.g.dart | 4 +- .../require_value/codegen.dart | 2 +- .../require_value/codegen.g.dart | 4 +- website/docs/essentials/first_request.mdx | 4 +- .../first_request/codegen/provider.dart | 2 +- .../first_request/codegen/provider.g.dart | 4 +- .../passing_args/family/codegen.dart | 2 +- .../passing_args/family/codegen.g.dart | 4 +- .../passing_args/no_arg_provider/codegen.dart | 2 +- .../no_arg_provider/codegen.g.dart | 4 +- .../codegen/todo_list_notifier.g.dart | 2 +- .../todo_list_notifier_add_todo.g.dart | 2 +- .../codegen/todo_list_provider.dart | 2 +- .../codegen/todo_list_provider.g.dart | 4 +- .../testing/notifier_mock/codegen.g.dart | 2 +- .../testing/provider_to_mock/codegen.dart | 2 +- .../testing/provider_to_mock/codegen.g.dart | 4 +- .../websockets_sync/pipe_change_notifier.dart | 2 +- .../pipe_change_notifier.g.dart | 4 +- .../essentials/websockets_sync/raw_usage.dart | 2 +- .../websockets_sync/raw_usage.g.dart | 4 +- .../shared_pipe_change_notifier.dart | 4 +- .../shared_pipe_change_notifier.g.dart | 6 +- .../stream_provider/codegen.dart | 2 +- .../stream_provider/codegen.g.dart | 4 +- .../sync_definition/codegen.dart | 2 +- .../sync_definition/codegen.g.dart | 4 +- website/docs/from_provider/family/family.dart | 2 +- .../docs/from_provider/family/family.g.dart | 4 +- .../motivation/async_values/async_values.dart | 4 +- .../async_values/async_values.g.dart | 6 +- .../motivation/auto_dispose/auto_dispose.dart | 4 +- .../auto_dispose/auto_dispose.g.dart | 6 +- .../motivation/combine/combine.dart | 4 +- .../motivation/combine/combine.g.dart | 6 +- .../motivation/same_type/same_type.dart | 4 +- .../motivation/same_type/same_type.g.dart | 6 +- website/docs/from_provider/quickstart.mdx | 2 +- .../dart_hello_world/main.dart | 2 +- .../dart_hello_world/main.g.dart | 4 +- .../hello_world/hooks_codegen/main.dart | 2 +- .../hello_world/hooks_codegen/main.g.dart | 4 +- .../getting_started/hello_world/main.dart | 2 +- .../getting_started/hello_world/main.g.dart | 4 +- website/docs/introduction/why_riverpod.mdx | 2 +- .../introduction/why_riverpod/codegen.dart | 2 +- .../introduction/why_riverpod/codegen.g.dart | 4 +- .../declaration/declaration.g.dart | 2 +- .../initialization/initialization.g.dart | 2 +- .../migrated/migrated.g.dart | 2 +- .../add_listener/add_listener.dart | 2 +- .../add_listener/add_listener.g.dart | 4 +- .../from_state_notifier/add_listener/raw.dart | 2 +- .../async_notifier/async_notifier.g.dart | 2 +- .../build_init/build_init.g.dart | 2 +- .../family_and_dispose.dart | 2 +- .../family_and_dispose.g.dart | 2 +- .../from_state_provider.g.dart | 2 +- .../old_lifecycles/old_lifecycles.g.dart | 2 +- .../old_lifecycles_final.dart | 4 +- .../old_lifecycles_final.g.dart | 2 +- .../config_provider/codegen.dart | 3 +- .../config_provider/codegen.g.dart | 4 +- .../remote_todos/codegen.g.dart | 2 +- .../notifier_provider/todos/codegen.g.dart | 2 +- .../completed_todos/completed_todos.dart | 2 +- .../completed_todos/completed_todos.g.dart | 4 +- .../optimized_previous_button.dart | 2 +- .../optimized_previous_button.g.dart | 4 +- .../docs/providers/provider/todo/todo.g.dart | 2 +- .../unoptimized_previous_button.g.dart | 2 +- .../live_stream_chat_provider/codegen.dart | 2 +- .../live_stream_chat_provider/codegen.g.dart | 4 +- .../current/about_codegen/main.dart | 2 +- .../current/about_hooks.mdx | 2 +- .../dart_hello_world/main.dart | 2 +- .../getting_started/hello_world/main.dart | 2 +- .../current/introduction.mdx | 6 +- .../current/essentials/first_request.mdx | 4 +- .../first_request/codegen/provider.dart | 2 +- .../passing_args/codegen/family.dart | 2 +- .../passing_args/codegen/provider.dart | 2 +- .../codegen/todo_list_provider.dart | 2 +- .../current/from_provider/quickstart.mdx | 2 +- .../current/about_codegen/main.dart | 2 +- .../current/essentials/first_request.mdx | 4 +- .../current/from_provider/quickstart.mdx | 2 +- .../dart_hello_world/main.dart | 2 +- .../getting_started/hello_world/main.dart | 2 +- .../current/introduction.mdx | 2 +- .../current/concepts/about_hooks.mdx | 2 +- .../current/essentials/first_request.mdx | 6 +- .../current/from_provider/quickstart.mdx | 2 +- .../current/essentials/first_request.mdx | 4 +- .../first_request/codegen/provider.dart | 2 +- .../passing_args/codegen/family.dart | 2 +- .../passing_args/codegen/provider.dart | 2 +- .../codegen/todo_list_provider.dart | 2 +- .../current/from_provider/quickstart.mdx | 2 +- website/pubspec.yaml | 2 +- website/static/snippets/async.dart | 2 +- website/static/snippets/async.g.dart | 4 +- website/static/snippets/combine.dart | 6 +- website/static/snippets/combine.g.dart | 4 +- website/static/snippets/create.dart | 2 +- website/static/snippets/create.g.dart | 4 +- website/static/snippets/declare.g.dart | 2 +- website/yarn.lock | 6 +- 355 files changed, 2798 insertions(+), 1471 deletions(-) create mode 100644 .gitattributes create mode 100644 packages/hooks_riverpod/test/analysis_options.yaml create mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.diff create mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.g.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/failing_functional_ref.diff create mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref.diff create mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref_test.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.dart create mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.diff create mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.g.dart diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..b1f2a0c3c --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +**/*.*.dart linguist-generated=true diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index f1d36fda1..9b190a266 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -21,8 +21,7 @@ jobs: strategy: matrix: channel: - # Waiting for WidgetStateProperty to be stable - # - stable + - stable - master package_path: - examples/counter diff --git a/.github/workflows/riverpod_lint.yml b/.github/workflows/riverpod_lint.yml index eb30d0bca..2bee84581 100644 --- a/.github/workflows/riverpod_lint.yml +++ b/.github/workflows/riverpod_lint.yml @@ -20,6 +20,7 @@ jobs: matrix: channel: - master + - stable package_path: - packages/riverpod_analyzer_utils - packages/riverpod_analyzer_utils_tests diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f4dcd9b4d..bf5b5e2e1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,7 +35,7 @@ You do not need to spend a lot of time making that issue. The important is: Making an issue is important to discuss what needs to be done. You wouldn't want to spend tens of hours working on something, only to have your PR rejected because we disagree on the direction taken. -An discussion may slow down the work initially, but it can save you from a lot +A discussion may slow down the work initially, but it can save you from a lot of frustration. ## Documentation work diff --git a/README.md b/README.md index 45112fb16..4841824a7 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ Long story short: ```dart @riverpod - Future boredSuggestion(BoredSuggestionRef ref) async { + Future boredSuggestion(Ref ref) async { final response = await http.get( Uri.https('boredapi.com', '/api/activity'), ); diff --git a/examples/counter/lib/main.g.dart b/examples/counter/lib/main.g.dart index 2a62bb8a4..e2f13fdc0 100644 --- a/examples/counter/lib/main.g.dart +++ b/examples/counter/lib/main.g.dart @@ -88,4 +88,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/examples/counter/pubspec.yaml b/examples/counter/pubspec.yaml index b2c4b3b6f..71a355882 100644 --- a/examples/counter/pubspec.yaml +++ b/examples/counter/pubspec.yaml @@ -24,7 +24,7 @@ dependencies: dev_dependencies: build_runner: ^2.3.3 - custom_lint: ^0.6.5 + custom_lint: ^0.7.0 flutter_test: sdk: flutter freezed: ^2.3.2 diff --git a/examples/marvel/pubspec.yaml b/examples/marvel/pubspec.yaml index 8b64a8c6a..dab401fe3 100644 --- a/examples/marvel/pubspec.yaml +++ b/examples/marvel/pubspec.yaml @@ -22,7 +22,7 @@ dependencies: dev_dependencies: build_runner: ^2.0.0 - custom_lint: ^0.6.5 + custom_lint: ^0.7.0 flutter_test: sdk: flutter freezed: ^2.1.0 diff --git a/examples/pub/lib/detail.dart b/examples/pub/lib/detail.dart index 707903408..676b8aa14 100644 --- a/examples/pub/lib/detail.dart +++ b/examples/pub/lib/detail.dart @@ -23,7 +23,7 @@ extension CancelTokenX on Ref { @riverpod Future fetchPackageDetails( - FetchPackageDetailsRef ref, { + Ref ref, { required String packageName, }) async { final cancelToken = ref.cancelToken(); @@ -34,7 +34,7 @@ Future fetchPackageDetails( } @riverpod -Future> likedPackages(LikedPackagesRef ref) async { +Future> likedPackages(Ref ref) async { final cancelToken = ref.cancelToken(); return ref @@ -43,7 +43,7 @@ Future> likedPackages(LikedPackagesRef ref) async { } @riverpod -PubRepository pubRepository(PubRepositoryRef ref) => PubRepository(); +PubRepository pubRepository(Ref ref) => PubRepository(); /// A provider that fetches the likes count, popularity score and pub points /// for a given package. diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 40b98a5de..116d43511 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -92,7 +92,7 @@ final class FetchPackageDetailsProvider } String _$fetchPackageDetailsHash() => - r'e65ba332cb8397cc5a1aca6e656233dff698391a'; + r'16ad07d6f69412f6d456c6d482f15dc53421df74'; final class FetchPackageDetailsFamily extends Family { const FetchPackageDetailsFamily._() @@ -191,7 +191,7 @@ final class LikedPackagesProvider extends $FunctionalProvider< } } -String _$likedPackagesHash() => r'304a4def167e245812638cba776e8d5eb66d8844'; +String _$likedPackagesHash() => r'8debee8d8fa48334d1de21fa9bbf03224265d29d'; typedef PubRepositoryRef = Ref; @@ -252,7 +252,7 @@ final class PubRepositoryProvider } } -String _$pubRepositoryHash() => r'1f4dbfa0911f6467067fab244677acbcb8c7ad4e'; +String _$pubRepositoryHash() => r'fd358feb202d2c34ad507ebf0a40bddbebc8ea98'; /// A provider that fetches the likes count, popularity score and pub points /// for a given package. @@ -437,4 +437,4 @@ abstract class _$PackageMetrics extends $AsyncNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/examples/pub/lib/search.dart b/examples/pub/lib/search.dart index eeafba4f1..3a9cdb2eb 100644 --- a/examples/pub/lib/search.dart +++ b/examples/pub/lib/search.dart @@ -17,7 +17,7 @@ const searchPageSize = 10; @riverpod Future> fetchPackages( - FetchPackagesRef ref, { + Ref ref, { required int page, String search = '', }) async { diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 1f5b79dc3..3a0818fbf 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -106,7 +106,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< } } -String _$fetchPackagesHash() => r'46519fce4d1661e1358deac4d806374fa68f12c8'; +String _$fetchPackagesHash() => r'b52d4beb5d9ac53769d76ccd1d81bb005c66edd5'; final class FetchPackagesFamily extends Family { const FetchPackagesFamily._() @@ -161,4 +161,4 @@ final class FetchPackagesFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/examples/pub/pubspec.yaml b/examples/pub/pubspec.yaml index 822f2e513..59d69f5b1 100644 --- a/examples/pub/pubspec.yaml +++ b/examples/pub/pubspec.yaml @@ -23,7 +23,7 @@ dependencies: dev_dependencies: build_runner: ^2.0.0 - custom_lint: ^0.6.5 + custom_lint: ^0.7.0 flutter_test: sdk: flutter freezed: ^2.1.0 diff --git a/examples/random_number/lib/main.dart b/examples/random_number/lib/main.dart index 39dff754d..6b5751916 100644 --- a/examples/random_number/lib/main.dart +++ b/examples/random_number/lib/main.dart @@ -2,26 +2,25 @@ import 'dart:math'; import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:flutter_riverpod/legacy.dart'; void main() { runApp(const ProviderScope(child: RandomNumberApp())); } -// State notifier for generating a random number exposed by a state notifier +// Notifier for generating a random number exposed by a state notifier // provider -class RandomNumberGenerator extends StateNotifier { - RandomNumberGenerator() : super(Random().nextInt(9999)); +class RandomNumberGenerator extends Notifier { + @override + int build() => Random().nextInt(9999); void generate() { state = Random().nextInt(9999); } } -// State notifier provider holding the state -final randomNumberProvider = StateNotifierProvider( - (ref) => RandomNumberGenerator(), -); +// Notifier provider holding the state +final randomNumberProvider = + NotifierProvider(RandomNumberGenerator.new); class RandomNumberApp extends StatelessWidget { const RandomNumberApp({super.key}); diff --git a/examples/random_number/pubspec.yaml b/examples/random_number/pubspec.yaml index f1d1e4c72..770d455bd 100644 --- a/examples/random_number/pubspec.yaml +++ b/examples/random_number/pubspec.yaml @@ -14,7 +14,7 @@ dependencies: mockito: ^5.0.13 dev_dependencies: - custom_lint: ^0.6.5 + custom_lint: ^0.7.0 flutter_lints: ^1.0.0 flutter_test: sdk: flutter diff --git a/examples/stackoverflow/lib/common.dart b/examples/stackoverflow/lib/common.dart index b8625183a..fa9380eb9 100644 --- a/examples/stackoverflow/lib/common.dart +++ b/examples/stackoverflow/lib/common.dart @@ -18,7 +18,7 @@ final client = Provider((ref) => Dio()); // this provider. dependencies: [], ) -ThemeData theme(ThemeRef ref) { +ThemeData theme(Ref ref) { throw UnimplementedError(); } diff --git a/examples/stackoverflow/lib/question.dart b/examples/stackoverflow/lib/question.dart index 14a065d0d..a44bd0fda 100644 --- a/examples/stackoverflow/lib/question.dart +++ b/examples/stackoverflow/lib/question.dart @@ -124,7 +124,7 @@ final questionThemeProvider = Provider((ref) { /// This is an optional step. Since scoping is a fairly advanced mechanism, /// it's entirely fine to simply pass the [Question] to [QuestionItem] directly. @Riverpod(dependencies: []) -AsyncValue currentQuestion(CurrentQuestionRef ref) { +AsyncValue currentQuestion(Ref ref) { throw UnimplementedError(); } diff --git a/examples/stackoverflow/lib/tag.dart b/examples/stackoverflow/lib/tag.dart index ac2f77963..d73659011 100644 --- a/examples/stackoverflow/lib/tag.dart +++ b/examples/stackoverflow/lib/tag.dart @@ -19,7 +19,7 @@ class TagTheme with _$TagTheme { } @Riverpod(dependencies: [theme]) -TagTheme tagTheme(TagThemeRef ref) { +TagTheme tagTheme(Ref ref) { final theme = ref.watch(themeProvider); return TagTheme( diff --git a/examples/stackoverflow/pubspec.yaml b/examples/stackoverflow/pubspec.yaml index ec52db7db..0767c7bdd 100644 --- a/examples/stackoverflow/pubspec.yaml +++ b/examples/stackoverflow/pubspec.yaml @@ -19,7 +19,7 @@ dependencies: dev_dependencies: build_runner: ^2.0.0 - custom_lint: ^0.6.5 + custom_lint: ^0.7.0 flutter_test: sdk: flutter freezed: ^2.1.0 diff --git a/examples/todos/pubspec.yaml b/examples/todos/pubspec.yaml index 3aacdc880..80697d4de 100644 --- a/examples/todos/pubspec.yaml +++ b/examples/todos/pubspec.yaml @@ -14,11 +14,11 @@ dependencies: path: ../../packages/hooks_riverpod riverpod: path: ../../packages/riverpod - uuid: ^3.0.4 + uuid: ^4.0.4 dev_dependencies: build_runner: ^2.0.0 - custom_lint: ^0.6.5 + custom_lint: ^0.7.0 flutter_test: sdk: flutter riverpod_lint: diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md index 093798bd1..b405bc9c9 100644 --- a/packages/flutter_riverpod/CHANGELOG.md +++ b/packages/flutter_riverpod/CHANGELOG.md @@ -42,6 +42,23 @@ Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. - **Breaking**: Removed everything marked as "deprecated" - Bumped minimum Dart SDK to >= 3.0.0-dev +## 2.6.1 - 2024-10-22 + +- Added `AsyncNotifier.listenSelf`. It was mistakenly absent from the 2.6.0 release + +## 2.6.0 - 2024-10-20 + +- Deprecated all `Ref` subclasses. Instead, use `Ref` itself. +- Deprecated `Ref`'s type argument. Use `Ref` without its generic parameter instead. +- Deprecated any `Ref` member that used `Ref`'s generic (such as `Ref.state` or `Ref.listenSelf`). + Instead, use a `Notifier`. +- Added `Notifier.listenSelf`, as a replacement to `Ref.listenSelf`. +- `Ref.watch` and other methods now accept auto-dispose providers too. + +## 2.5.3 - 2024-10-12 + +- Fixed a typo in the documentation (thanks to @ljbkusters) + ## 2.5.2 - 2024-03-18 - Fixed various typos in the documentation (thanks to @kevalvavaliya) diff --git a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart index 03388db56..e4793b463 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart @@ -1,4 +1,4 @@ -// ignore_for_file: invalid_use_of_internal_member +// ignore_for_file: invalid_use_of_internal_member, deprecated_member_use_from_same_package import 'package:flutter/widgets.dart' hide Listener; import 'package:flutter_riverpod/src/internals.dart'; diff --git a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart index da60c932b..09c69c11a 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart @@ -1,4 +1,4 @@ -// ignore_for_file: invalid_use_of_internal_member, avoid_types_on_closure_parameters +// ignore_for_file: invalid_use_of_internal_member, avoid_types_on_closure_parameters, deprecated_member_use_from_same_package, deprecated_member_use import 'dart:async'; diff --git a/packages/hooks_riverpod/CHANGELOG.md b/packages/hooks_riverpod/CHANGELOG.md index 1688eec2d..0cd6a306f 100644 --- a/packages/hooks_riverpod/CHANGELOG.md +++ b/packages/hooks_riverpod/CHANGELOG.md @@ -35,6 +35,23 @@ Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. - **Breaking**: Removed everything marked as "deprecated" - Bumped minimum Dart SDK to >= 3.0.0-dev +## 2.6.1 - 2024-10-22 + +- Added `AsyncNotifier.listenSelf`. It was mistakenly absent from the 2.6.0 release + +## 2.6.0 - 2024-10-20 + +- Deprecated all `Ref` subclasses. Instead, use `Ref` itself. +- Deprecated `Ref`'s type argument. Use `Ref` without its generic parameter instead. +- Deprecated any `Ref` member that used `Ref`'s generic (such as `Ref.state` or `Ref.listenSelf`). + Instead, use a `Notifier`. +- Added `Notifier.listenSelf`, as a replacement to `Ref.listenSelf`. +- `Ref.watch` and other methods now accept auto-dispose providers too. + +## 2.5.3 - 2024-10-12 + +- Fixed a typo in the documentation (thanks to @ljbkusters) + ## 2.5.2 - 2024-08-15 - Added mutation pending state to example (thanks to @luketg8) diff --git a/packages/hooks_riverpod/test/analysis_options.yaml b/packages/hooks_riverpod/test/analysis_options.yaml new file mode 100644 index 000000000..38c1cf1a8 --- /dev/null +++ b/packages/hooks_riverpod/test/analysis_options.yaml @@ -0,0 +1,5 @@ +import: "../../analysis_options.yaml" + +analyzer: + errors: + deprecated_member_use_from_same_package: false diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index c9712f2b7..33f85c447 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -18,7 +18,7 @@ - **Breaking**: `StreamProvider` now pauses its `StreamSubscription` when the provider is not actively listened. - **Breaking**: A provider is now considered "paused" if all - of its listeners are also paused. So if a provider `A` is watched _only_ by a provider `B`, and `B` is currently unused, + of its listeners are also paused. So if a provider `A` is watched _only_ by a provider `B`, and `B` is currently unused, then `A` will be paused. - Added `Ref.listen(..., weak: true)`. When specifying `weak: true`, the listener will not cause the provider to be @@ -75,6 +75,23 @@ Fix exceptions when using multiple root `ProviderContainers`/`ProviderScopes`. - **Breaking**: Removed everything marked as "deprecated" - Bumped minimum Dart SDK to >= 3.0.0-dev +## 2.6.1 - 2024-10-22 + +- Added `AsyncNotifier.listenSelf`. It was mistakenly absent from the 2.6.0 release + +## 2.6.0 - 2024-10-20 + +- Deprecated all `Ref` subclasses. Instead, use `Ref` itself. +- Deprecated `Ref`'s type argument. Use `Ref` without its generic parameter instead. +- Deprecated any `Ref` member that used `Ref`'s generic (such as `Ref.state` or `Ref.listenSelf`). + Instead, use a `Notifier`. +- Added `Notifier.listenSelf`, as a replacement to `Ref.listenSelf`. +- `Ref.watch` and other methods now accept auto-dispose providers too. + +## 2.5.3 - 2024-10-12 + +- Fixed a typo in the documentation (thanks to @ljbkusters) + ## 2.5.1 - 2024-03-10 - Improved `Provider(dependencies: [...])` documentation. diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index dd2496991..9c8edc781 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -65,6 +65,20 @@ abstract class NotifierBase { return ref; } + /// Listens to changes on the value exposed by this provider. + /// + /// The listener will be called immediately after the provider completes building. + /// + /// As opposed to [Ref.listen], the listener will be called even if + /// [updateShouldNotify] returns false, meaning that the previous + /// and new value can potentially be identical. + void listenSelf( + void Function(StateT? previous, StateT next) listener, { + void Function(Object error, StackTrace stackTrace)? onError, + }) { + ref.listenSelf(listener, onError: onError); + } + @visibleForTesting @protected StateT get state => ref.state; diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index afd6015de..d2b484aef 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -37,7 +37,8 @@ Cannot use the Ref of $origin after it has been disposed. This typically happens /// - [read] and [watch], two methods that allow a provider to consume other providers. /// - [onDispose], a method that allows performing a task when the provider is destroyed. /// {@endtemplate} -base class Ref { +@optionalTypeArgs +base class Ref<@Deprecated('Will be removed in 3.0') StateT> { /// {@macro riverpod.provider_ref_base} Ref._(this._element); @@ -63,12 +64,14 @@ base class Ref { /// - on asynchronous providers, this will return an [AsyncLoading]. /// /// Will throw if the provider threw during creation. + @Deprecated('foo') StateT get state { _throwIfInvalidUsage(); return _element.readSelf(); } + @Deprecated('foo') set state(StateT newState) { _throwIfInvalidUsage(); @@ -210,10 +213,14 @@ final = Provider(dependencies: []); } /// {@template riverpod.invalidate} - /// Invalidates the state of the provider, causing it to refresh. + /// Invalidates the state of the provider, destroying the state immediately + /// and causing the provider to rebuild at some point in the future. /// - /// As opposed to [refresh], the refresh is not immediate and is instead - /// delayed to the next read or next frame. + /// As opposed to [refresh], the rebuild is not immediate and is instead + /// delayed by an undefined amount of time. + /// Typically, the rebuild happens at the next tick of the event loop. + /// But if a provider is not listened to, the rebuild may be delayed until + /// the provider is listened to again. /// /// Calling [invalidate] multiple times will refresh the provider only /// once. @@ -600,6 +607,7 @@ final = Provider(dependencies: []); /// As opposed to [listen], the listener will be called even if /// [ProviderElement.updateShouldNotify] returns false, meaning that the previous /// and new value can potentially be identical. + @Deprecated('foo') void listenSelf( void Function(StateT? previous, StateT next) listener, { void Function(Object error, StackTrace stackTrace)? onError, diff --git a/packages/riverpod/pubspec.yaml b/packages/riverpod/pubspec.yaml index 1219bf994..aa0b421ab 100644 --- a/packages/riverpod/pubspec.yaml +++ b/packages/riverpod/pubspec.yaml @@ -20,7 +20,8 @@ dependencies: test: ^1.0.0 dev_dependencies: - analyzer: ^6.3.0 + analyzer: ^6.7.0 + expect_error: ^1.0.0 mockito: ^5.0.0 path: ^1.9.0 trotter: ^2.0.0-dev.1 diff --git a/packages/riverpod/pubspec_overrides.yaml b/packages/riverpod/pubspec_overrides.yaml index 5fe406c11..607c9fadd 100644 --- a/packages/riverpod/pubspec_overrides.yaml +++ b/packages/riverpod/pubspec_overrides.yaml @@ -1,3 +1,3 @@ dependency_overrides: # necessary for mockito - analyzer: ^6.0.0 + analyzer: ^6.7.0 diff --git a/packages/riverpod_analyzer_utils/CHANGELOG.md b/packages/riverpod_analyzer_utils/CHANGELOG.md index 629c4d80c..2836f63f1 100644 --- a/packages/riverpod_analyzer_utils/CHANGELOG.md +++ b/packages/riverpod_analyzer_utils/CHANGELOG.md @@ -13,7 +13,16 @@ - Added `GeneratorProviderDeclarationElement.isFamily` -## Unreleased patch +## 0.5.7 - 2024-10-27 + +- Support latest custom_lint + +## 0.5.6 - 2024-10-22 + +- Support analyzer >=6.7.0 <7.0.0 + This should make it compatible with Flutter's stable channel. + +## 0.5.5 - 2024-10-12 Bumped minimum analyzer to 6.9.0 diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart index 73e42b417..474132174 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/dependencies.dart @@ -333,7 +333,9 @@ extension on AnnotatedNode { // Always initialize root declarations, // to handle cases where a method in a class has @Dependencies // but the class itself does not. - this is! CompilationUnitMember) return null; + this is! CompilationUnitMember) { + return null; + } return AccumulatedDependencyList._( node: this, diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/provider_or_family.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/provider_or_family.dart index fcb0f11b9..84c62ee84 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/provider_or_family.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/provider_or_family.dart @@ -63,7 +63,9 @@ final class ProviderOrFamilyExpression { final returnType = expression.staticType; if (returnType == null) return null; if (!providerBaseType.isAssignableFromType(returnType) && - !familyType.isAssignableFromType(returnType)) return null; + !familyType.isAssignableFromType(returnType)) { + return null; + } final parseResult = _parsesProviderExpression(expression); if (parseResult == null) return null; diff --git a/packages/riverpod_analyzer_utils/pubspec.yaml b/packages/riverpod_analyzer_utils/pubspec.yaml index 6df2391c1..c88856251 100644 --- a/packages/riverpod_analyzer_utils/pubspec.yaml +++ b/packages/riverpod_analyzer_utils/pubspec.yaml @@ -10,10 +10,10 @@ environment: sdk: ">=3.0.0<4.0.0" dependencies: - analyzer: ^6.9.0 + analyzer: ^6.7.0 collection: ^1.16.0 crypto: ^3.0.2 - custom_lint_core: ^0.6.5 + custom_lint_core: ^0.7.0 freezed_annotation: ^2.2.0 meta: ^1.7.0 path: ^1.8.0 diff --git a/packages/riverpod_analyzer_utils_tests/pubspec.yaml b/packages/riverpod_analyzer_utils_tests/pubspec.yaml index 2327173ed..aae67e74c 100644 --- a/packages/riverpod_analyzer_utils_tests/pubspec.yaml +++ b/packages/riverpod_analyzer_utils_tests/pubspec.yaml @@ -6,7 +6,7 @@ environment: sdk: ">=3.0.0<4.0.0" dependencies: - analyzer: ">=5.12.0 <7.0.0" + analyzer: ^6.7.0 collection: ^1.16.0 freezed_annotation: ^2.2.0 meta: ^1.7.0 diff --git a/packages/riverpod_annotation/CHANGELOG.md b/packages/riverpod_annotation/CHANGELOG.md index 739e84940..a677b4bc5 100644 --- a/packages/riverpod_annotation/CHANGELOG.md +++ b/packages/riverpod_annotation/CHANGELOG.md @@ -25,6 +25,18 @@ - `riverpod` upgraded to `3.0.0-dev.0` +## 2.6.1 - 2024-10-22 + +- `riverpod` upgraded to `2.6.1` + +## 2.6.0 - 2024-10-20 + +- `riverpod` upgraded to `2.6.0` + +## 2.5.3 - 2024-10-12 + +- `riverpod` upgraded to `2.5.3` + ## 2.3.5 - 2024-03-10 - `riverpod` upgraded to `2.5.1` diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index fb6b71d14..feb355c4a 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -16,10 +16,10 @@ export 'package:riverpod/src/internals.dart' $FamilyOverride, $FunctionalProvider, $FutureModifier, + Ref, NotifierBase, $AsyncClassModifier, $ClassProvider, - Ref, $ValueProvider, $ProviderOverride, $RefArg, diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 1fb5e7681..442977ab7 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -17,7 +17,30 @@ - Added support for `@Riverpod(retry: ...)` -## Unreleased patch +## 2.6.2 - 2024-10-27 + +- `riverpod_analyzer_utils` upgraded to `0.5.7` + +## 2.6.1 - 2024-10-22 + +- Support analyzer >=6.7.0 <7.0.0 + This should make it compatible with Flutter's stable channel. + +## 2.6.0 - 2024-10-20 + +- Deprecated the generated `Ref` subclasses. + Instead of: + ```dart + @riverpod + Model foo(FooRef ref) => .. + ``` + Do: + ```dart + @riverpod + Model foo(Ref ref) => .. + ``` + +## 2.4.4 - 2024-10-12 - `@Riverpod(dependencies: [...])` now respects `build.yaml` options diff --git a/packages/riverpod_generator/README.md b/packages/riverpod_generator/README.md index d331bec0d..d3566d46d 100644 --- a/packages/riverpod_generator/README.md +++ b/packages/riverpod_generator/README.md @@ -38,7 +38,7 @@ part 'my_file.g.dart'; // In this example, riverpod_generator will use this function and generate a matching "fetchProductProvider". // The following example would be the equivalent of a "FutureProvider.autoDispose.family" @riverpod -Future> fetchProducts(FetchProductRef ref, {required int page, int limit = 50}) async { +Future> fetchProducts(Ref ref, {required int page, int limit = 50}) async { final dio = Dio(); final response = await dio.get('https://my-api/products?page=$page&limit=$limit'); final json = response.data! as List; @@ -138,7 +138,7 @@ part 'main.g.dart'; // Providers are defined by annotating a function with @riverpod @riverpod -String label(LabelRef ref) => 'Hello world'; +String label(Ref ref) => 'Hello world'; void main() { runApp(ProviderScope(child: Home())); diff --git a/packages/riverpod_generator/integration/build_yaml/lib/dependencies.dart b/packages/riverpod_generator/integration/build_yaml/lib/dependencies.dart index 04de89ed6..4b3fc48b4 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/dependencies.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/dependencies.dart @@ -20,7 +20,7 @@ part 'dependencies.g.dart'; CountStreamNotifier2, ], ) -int calc2(Calc2Ref ref, String id) { +int calc2(Ref ref, String id) { ref.watch(myCountPod); ref.watch(myCountFuturePod); ref.watch(myCountStreamPod); diff --git a/packages/riverpod_generator/integration/build_yaml/lib/dependencies.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/dependencies.g.dart index 5be9cfabb..21a7daa43 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/dependencies.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/dependencies.g.dart @@ -110,7 +110,7 @@ final class Calc2Provider extends $FunctionalProvider } } -String _$calc2Hash() => r'0972ac060d49cb3f08f9192af9cea0611a6b4616'; +String _$calc2Hash() => r'ae1d601ff7cdda569255e8014bd5d8d1c178b3eb'; final class Calc2Family extends Family { const Calc2Family._() @@ -181,4 +181,4 @@ final class Calc2Family extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.dart index 1cfb4ea9a..df64e3942 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.dart @@ -3,17 +3,17 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; @riverpod -int count(CountRef ref) { +int count(Ref ref) { return 1; } @riverpod -FutureOr countFuture(CountFutureRef ref) { +FutureOr countFuture(Ref ref) { return 1; } @riverpod -Stream countStream(CountStreamRef ref) { +Stream countStream(Ref ref) { return Stream.value(1); } @@ -42,17 +42,17 @@ class CountStreamNotifier extends _$CountStreamNotifier { } @riverpod -int count2(Count2Ref ref, int a) { +int count2(Ref ref, int a) { return 1; } @riverpod -FutureOr countFuture2(CountFuture2Ref ref, int a) { +FutureOr countFuture2(Ref ref, int a) { return 1; } @riverpod -Stream countStream2(CountStream2Ref ref, int a) { +Stream countStream2(Ref ref, int a) { return Stream.value(1); } diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index fad75ddb1..8e34f6f68 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -64,7 +64,7 @@ final class CountProvider extends $FunctionalProvider } } -String _$countHash() => r'4c7e72b275767a60ece5e8662ab1e28f73cf7e44'; +String _$countHash() => r'a31bb5cbb0ddb2466df2cc62a306709ea24fae12'; typedef CountFutureRef = Ref>; @@ -117,7 +117,7 @@ final class CountFutureProvider } } -String _$countFutureHash() => r'ec7cc31ce1c1a10607f1dcb35dd217acd2877729'; +String _$countFutureHash() => r'c292214b486fdd9ec98a61e277812f29fc4b5802'; typedef CountStreamRef = Ref>; @@ -170,7 +170,7 @@ final class CountStreamProvider } } -String _$countStreamHash() => r'1dbe49244ea19e8dbc3af0534429bb323720c07a'; +String _$countStreamHash() => r'472c06085fb994619f54de368f047b7cc8466872'; @ProviderFor(CountNotifier) const myCountNotifierPod = CountNotifierProvider._(); @@ -456,7 +456,7 @@ final class Count2Provider extends $FunctionalProvider } } -String _$count2Hash() => r'6256825480d83bb13acde282cf3c9d9524cc3a6c'; +String _$count2Hash() => r'4146ae486161f9d444b4d80ec846199b13eeaae2'; final class Count2Family extends Family { const Count2Family._() @@ -582,7 +582,7 @@ final class CountFuture2Provider } } -String _$countFuture2Hash() => r'096675b70a267f5d7c62ac7d3e7dd231ef529034'; +String _$countFuture2Hash() => r'6acaa58de0116853fd831efb4ac1a8047205f12b'; final class CountFuture2Family extends Family { const CountFuture2Family._() @@ -708,7 +708,7 @@ final class CountStream2Provider } } -String _$countStream2Hash() => r'051264dd685ebc0a57e454bb676957c93cb4ae20'; +String _$countStream2Hash() => r'96c9a0935240f1727986800c1fe6dea974b9accc'; final class CountStream2Family extends Family { const CountStream2Family._() @@ -1228,4 +1228,4 @@ abstract class _$CountStreamNotifier2 extends $StreamNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index fda577fb0..ae1a51f77 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -107,7 +107,7 @@ class RiverpodGenerator extends ParserGenerator { if (buffer.isNotEmpty) { buffer.write(''' // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package '''); } } diff --git a/packages/riverpod_generator/pubspec.yaml b/packages/riverpod_generator/pubspec.yaml index 8879f886b..f406faa3d 100644 --- a/packages/riverpod_generator/pubspec.yaml +++ b/packages/riverpod_generator/pubspec.yaml @@ -10,7 +10,7 @@ environment: sdk: ">=3.0.0 <4.0.0" dependencies: - analyzer: ^6.5.0 + analyzer: ^6.7.0 build: ^2.0.0 build_config: ^1.0.0 collection: ^1.15.0 diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index ebfa3f779..95ad17e48 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -708,4 +708,4 @@ final class NotCopiedFamilyFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/async.dart b/packages/riverpod_generator/test/integration/async.dart index 469608b30..e4a16b5cb 100644 --- a/packages/riverpod_generator/test/integration/async.dart +++ b/packages/riverpod_generator/test/integration/async.dart @@ -3,7 +3,7 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'async.g.dart'; @riverpod -Future> generic(GenericRef ref) async { +Future> generic(Ref ref) async { return []; } @@ -16,25 +16,25 @@ class GenericClass extends _$GenericClass { } @riverpod -FutureOr public(PublicRef ref) { +FutureOr public(Ref ref) { return 'Hello world'; } const privateProvider = _privateProvider; @riverpod -Future _private(_PrivateRef ref) async { +Future _private(Ref ref) async { return 'Hello world'; } @riverpod -FutureOr familyOr(FamilyOrRef ref, int first) { +FutureOr familyOr(Ref ref, int first) { return '(first: $first)'; } @riverpod Future family( - FamilyRef ref, + Ref ref, int first, { String? second, required double third, diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 791f59c3c..c470df6e4 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -85,7 +85,7 @@ final class GenericProvider } } -String _$genericHash() => r'6ee5473ece745b00328c1e048f6967c160343620'; +String _$genericHash() => r'5fb4a4ebeb69c6841722c3a021554648db095009'; final class GenericFamily extends Family { const GenericFamily._() @@ -322,7 +322,7 @@ final class PublicProvider } } -String _$publicHash() => r'9d99b79c013da13926d4ad89c72ebca4fc1cc257'; +String _$publicHash() => r'19bceccf795e4c3a26ad1e613fd6f41aad949e2b'; typedef _PrivateRef = Ref>; @@ -375,7 +375,7 @@ final class _PrivateProvider } } -String _$privateHash() => r'bc0469a9315de114a0ccd82c7db4980844d0009f'; +String _$privateHash() => r'7f0d1ff55a21e520b8471bbabc4649b5336221d4'; typedef FamilyOrRef = Ref>; @@ -458,7 +458,7 @@ final class FamilyOrProvider } } -String _$familyOrHash() => r'1c3217e296b0ce52c07c18769d1fffb95850f482'; +String _$familyOrHash() => r'97cce80a626e228202fa30b87c07ae8319b48023'; final class FamilyOrFamily extends Family { const FamilyOrFamily._() @@ -619,7 +619,7 @@ final class FamilyProvider } } -String _$familyHash() => r'eb6fad35a94d4238b621c2100253ee2c700bee77'; +String _$familyHash() => r'1da6c928ee85a03729a1c147f33e018521bb9c89'; final class FamilyFamily extends Family { const FamilyFamily._() @@ -1194,4 +1194,4 @@ abstract class _$FamilyClass extends $AsyncNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/auto_dispose.dart b/packages/riverpod_generator/test/integration/auto_dispose.dart index 9ae30399d..26c824040 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.dart @@ -3,33 +3,33 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'auto_dispose.g.dart'; @Riverpod(keepAlive: true) -int keepAlive(KeepAliveRef ref) { +int keepAlive(Ref ref) { return 0; } @Riverpod(keepAlive: false) -int notKeepAlive(NotKeepAliveRef ref) { +int notKeepAlive(Ref ref) { ref.keepAlive(); return 0; } @riverpod -int defaultKeepAlive(DefaultKeepAliveRef ref) { +int defaultKeepAlive(Ref ref) { return 0; } @Riverpod(keepAlive: true) -int keepAliveFamily(KeepAliveFamilyRef ref, int a) { +int keepAliveFamily(Ref ref, int a) { return 0; } @Riverpod(keepAlive: false) -int notKeepAliveFamily(NotKeepAliveFamilyRef ref, int a) { +int notKeepAliveFamily(Ref ref, int a) { ref.keepAlive(); return 0; } @riverpod -int defaultKeepAliveFamily(DefaultKeepAliveFamilyRef ref, int a) { +int defaultKeepAliveFamily(Ref ref, int a) { return 0; } diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index d4f345241..b4e799256 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -64,7 +64,7 @@ final class KeepAliveProvider extends $FunctionalProvider } } -String _$keepAliveHash() => r'72dd192676126d487c24c7695a91d59410c62696'; +String _$keepAliveHash() => r'44af50bf7e6dcfddc61a1f32855855b534a7fe4f'; typedef NotKeepAliveRef = Ref; @@ -124,7 +124,7 @@ final class NotKeepAliveProvider extends $FunctionalProvider } } -String _$notKeepAliveHash() => r'1ccc497d7c651f8e730ec1bcecf271ffe9615d83'; +String _$notKeepAliveHash() => r'e60c952d04ffd7548294908c2e1ef472614c284b'; typedef DefaultKeepAliveRef = Ref; @@ -184,7 +184,7 @@ final class DefaultKeepAliveProvider extends $FunctionalProvider } } -String _$defaultKeepAliveHash() => r'1c236764d83a62ca442c5d5b4a83bd0d6e4548cf'; +String _$defaultKeepAliveHash() => r'76485c3c7574c38dcba6dda28c94a59c09b339c0'; typedef KeepAliveFamilyRef = Ref; @@ -274,7 +274,7 @@ final class KeepAliveFamilyProvider extends $FunctionalProvider } } -String _$keepAliveFamilyHash() => r'80d684923a104e2488ec281097bf9b5b04b4fa5a'; +String _$keepAliveFamilyHash() => r'd1eb1243ea9463617b08a6e9cc5ae6b2df499ba2'; final class KeepAliveFamilyFamily extends Family { const KeepAliveFamilyFamily._() @@ -408,7 +408,7 @@ final class NotKeepAliveFamilyProvider extends $FunctionalProvider } String _$notKeepAliveFamilyHash() => - r'9f530635a3310431aff36f0f9150f80c56348a51'; + r'a721713b026088b65be6c0f7f9beb1083a377a7c'; final class NotKeepAliveFamilyFamily extends Family { const NotKeepAliveFamilyFamily._() @@ -543,7 +543,7 @@ final class DefaultKeepAliveFamilyProvider extends $FunctionalProvider } String _$defaultKeepAliveFamilyHash() => - r'a1d9a5a40b8d43983428273ebee0660fe39250ed'; + r'e79f3d9ccd6713aade34c1701699c578f9236e9e'; final class DefaultKeepAliveFamilyFamily extends Family { const DefaultKeepAliveFamilyFamily._() @@ -588,4 +588,4 @@ final class DefaultKeepAliveFamilyFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/dependencies.dart b/packages/riverpod_generator/test/integration/dependencies.dart index e87eb23bd..c350b1ee3 100644 --- a/packages/riverpod_generator/test/integration/dependencies.dart +++ b/packages/riverpod_generator/test/integration/dependencies.dart @@ -3,10 +3,10 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'dependencies.g.dart'; @riverpod -int dep(DepRef ref) => 0; +int dep(Ref ref) => 0; @riverpod -int family(DepRef ref, int id) => 0; +int family(Ref ref, int id) => 0; @riverpod class Dep2 extends _$Dep2 { @@ -21,10 +21,10 @@ class Family2 extends _$Family2 { } @Riverpod(dependencies: [dep, family, Dep2, Family2]) -int provider(ProviderRef ref) => 0; +int provider(Ref ref) => 0; @Riverpod(dependencies: [dep, family, Dep2, Family2]) -int provider2(Provider2Ref ref) => 0; +int provider2(Ref ref) => 0; @Riverpod(dependencies: [dep, family, Dep2, Family2]) class Provider3 extends _$Provider3 { @@ -39,13 +39,13 @@ class Provider4 extends _$Provider4 { } @Riverpod(dependencies: [provider]) -int transitiveDependencies(TransitiveDependenciesRef ref) => 0; +int transitiveDependencies(Ref ref) => 0; @Riverpod(dependencies: [dep, family, Dep2]) -int smallTransitiveDependencyCount(SmallTransitiveDependencyCountRef ref) => 0; +int smallTransitiveDependencyCount(Ref ref) => 0; @Riverpod(dependencies: []) -int emptyDependenciesFunctional(EmptyDependenciesFunctionalRef ref) => 0; +int emptyDependenciesFunctional(Ref ref) => 0; @Riverpod(dependencies: []) class EmptyDependenciesClassBased extends _$EmptyDependenciesClassBased { @@ -54,22 +54,21 @@ class EmptyDependenciesClassBased extends _$EmptyDependenciesClassBased { } @Riverpod(dependencies: [_privateDep, publicDep]) -int providerWithDependencies(ProviderWithDependenciesRef ref) { +int providerWithDependencies(Ref ref) { return 0; } @riverpod -int _privateDep(_PrivateDepRef ref) => 0; +int _privateDep(Ref ref) => 0; @riverpod -int publicDep(PublicDepRef ref) => 0; +int publicDep(Ref ref) => 0; @Riverpod(dependencies: [dep, dep, Dep2, Dep2]) -int duplicateDependencies(DuplicateDependenciesRef ref) => 0; +int duplicateDependencies(Ref ref) => 0; @Riverpod(dependencies: [family, family, Family2, Family2]) -int duplicateDependencies2(DuplicateDependencies2Ref ref) => 0; +int duplicateDependencies2(Ref ref) => 0; @Riverpod(dependencies: [duplicateDependencies, duplicateDependencies2]) -int transitiveDuplicateDependencies(TransitiveDuplicateDependenciesRef ref) => - 0; +int transitiveDuplicateDependencies(Ref ref) => 0; diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index c399d0f35..dbbce7e74 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -64,7 +64,7 @@ final class DepProvider extends $FunctionalProvider } } -String _$depHash() => r'2213a401e03a1a914579b4a3a7707b783de9efba'; +String _$depHash() => r'1b3ec5231cd2328602151de9ceacdcd102a1d2e2'; typedef FamilyRef = Ref; @@ -154,7 +154,7 @@ final class FamilyProvider extends $FunctionalProvider } } -String _$familyHash() => r'8c228ff14b8c6cf1f3d4d6266232d64b5057c440'; +String _$familyHash() => r'940eb87eb11206499f73f05791a6266b38cda88a'; final class FamilyFamily extends Family { const FamilyFamily._() @@ -501,7 +501,7 @@ final class ProviderProvider extends $FunctionalProvider } } -String _$providerHash() => r'6c9184ef4c6a410a2132e1ecc13a2e646e936d37'; +String _$providerHash() => r'1be7ae7ac2100d39b949af50ec50fce48b26cdd1'; typedef Provider2Ref = Ref; @@ -576,7 +576,7 @@ final class Provider2Provider extends $FunctionalProvider } } -String _$provider2Hash() => r'70d908579c5e64ce6558b42f433adfb80f4dc79b'; +String _$provider2Hash() => r'30f81430b57f0116f621a4a309c458fce0536378'; @ProviderFor(Provider3) const provider3Provider = Provider3Provider._(); @@ -912,7 +912,7 @@ final class TransitiveDependenciesProvider extends $FunctionalProvider } String _$transitiveDependenciesHash() => - r'9c81823224bb28a5dc482328c04ce76293370877'; + r'909d45403831b521177ec15b1dd78554e261d3be'; typedef SmallTransitiveDependencyCountRef = Ref; @@ -987,7 +987,7 @@ final class SmallTransitiveDependencyCountProvider } String _$smallTransitiveDependencyCountHash() => - r'34689e1ba57e2959975cbf8ebd6c9483f4652a73'; + r'f67b369dd99e35a6e6211004b45c87c5ba4ac1c7'; typedef EmptyDependenciesFunctionalRef = Ref; @@ -1050,7 +1050,7 @@ final class EmptyDependenciesFunctionalProvider } String _$emptyDependenciesFunctionalHash() => - r'592bebd079450e2071fb12d68c3ae333d5c28359'; + r'77289071cab8a10da8f5b7b40932864510a1ee38'; @ProviderFor(EmptyDependenciesClassBased) const emptyDependenciesClassBasedProvider = @@ -1196,7 +1196,7 @@ final class ProviderWithDependenciesProvider } String _$providerWithDependenciesHash() => - r'beecbe7a41b647ab92367dbcc12055bcd6345af7'; + r'7d40c994fc2d4ba9e6a0bb4a3d100f8da874eb5e'; typedef _PrivateDepRef = Ref; @@ -1256,7 +1256,7 @@ final class _PrivateDepProvider extends $FunctionalProvider } } -String _$privateDepHash() => r'f610d91bd39e0dcffe6ff4e74160964a291289d9'; +String _$privateDepHash() => r'92ff5cc515ecf2455cb04773f1b49f23b17ea2e2'; typedef PublicDepRef = Ref; @@ -1316,7 +1316,7 @@ final class PublicDepProvider extends $FunctionalProvider } } -String _$publicDepHash() => r'bcb69aace017c86c3c4b8eccf59fa22d010834bc'; +String _$publicDepHash() => r'a9c461ae174577183ab4c0ff8d8267cc7a64a2c5'; typedef DuplicateDependenciesRef = Ref; @@ -1383,7 +1383,7 @@ final class DuplicateDependenciesProvider extends $FunctionalProvider } String _$duplicateDependenciesHash() => - r'8e4c4b40d7500e97e8490874d48cc960c64af712'; + r'ad48ecca57899ee55c69793c84a01235d6a49834'; typedef DuplicateDependencies2Ref = Ref; @@ -1453,7 +1453,7 @@ final class DuplicateDependencies2Provider extends $FunctionalProvider } String _$duplicateDependencies2Hash() => - r'43a4ff16a760fc697426a5b1ebc1f8882c816cfb'; + r'6e065325922dc36f408f85998cf2d7ba7a80ba56'; typedef TransitiveDuplicateDependenciesRef = Ref; @@ -1537,7 +1537,7 @@ final class TransitiveDuplicateDependenciesProvider } String _$transitiveDuplicateDependenciesHash() => - r'aba44b6c1cf82eea782ad260f2e95d9f771f12ac'; + r'be6a85098fc66be440b6b201f58a6ce1c526caf6'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/dependencies2.dart b/packages/riverpod_generator/test/integration/dependencies2.dart index 59c79f9b4..92697505e 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.dart @@ -6,12 +6,12 @@ part 'dependencies2.g.dart'; // Regression test for https://github.com/rrousselGit/riverpod/issues/2490 @Riverpod(dependencies: [providerWithDependencies, _private2, public2]) -int providerWithDependencies2(ProviderWithDependencies2Ref ref) { +int providerWithDependencies2(Ref ref) { return 0; } @Riverpod(dependencies: [providerWithDependencies, _private2, public2]) -int familyWithDependencies2(ProviderWithDependencies2Ref ref, {int? id}) { +int familyWithDependencies2(Ref ref, {int? id}) { return 0; } @@ -28,7 +28,7 @@ class NotifierFamilyWithDependencies extends _$NotifierFamilyWithDependencies { } @riverpod -int _private2(_Private2Ref ref) => 0; +int _private2(Ref ref) => 0; @riverpod -int public2(Public2Ref ref) => 0; +int public2(Ref ref) => 0; diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index 17bc8b5f6..d66f0a8e5 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -84,7 +84,7 @@ final class ProviderWithDependencies2Provider } String _$providerWithDependencies2Hash() => - r'90e090d5fa759369dceb59b2d2e219f67ed5f9e0'; + r'3a6100929120a9cf1ef7f1e0a5e9b8e4d4030ae2'; typedef FamilyWithDependencies2Ref = Ref; @@ -185,7 +185,7 @@ final class FamilyWithDependencies2Provider } String _$familyWithDependencies2Hash() => - r'209b9e3ed4e5fad89572268d161fbe64a6ef0e87'; + r'd064c06ca5a85a62cbe2b47943e98fc2e858fb03'; final class FamilyWithDependencies2Family extends Family { const FamilyWithDependencies2Family._() @@ -576,7 +576,7 @@ final class _Private2Provider extends $FunctionalProvider } } -String _$private2Hash() => r'5e0fa14ff40fb444c027ed25150a42362db3ef19'; +String _$private2Hash() => r'e420875c8fbd9bf33eff945f2b7276b585032a38'; typedef Public2Ref = Ref; @@ -636,7 +636,7 @@ final class Public2Provider extends $FunctionalProvider } } -String _$public2Hash() => r'9767255f0182589fe48b29d217dd488b0a13b9d5'; +String _$public2Hash() => r'20eb4f82e5f25fafc72775e7b86021d70ebb5579'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/documented.dart b/packages/riverpod_generator/test/integration/documented.dart index ead656b6e..a395963be 100644 --- a/packages/riverpod_generator/test/integration/documented.dart +++ b/packages/riverpod_generator/test/integration/documented.dart @@ -5,7 +5,7 @@ part 'documented.g.dart'; /// Hello world // Foo @riverpod -String functional(FunctionalRef ref) => 'functional'; +String functional(Ref ref) => 'functional'; /// Hello world // Foo @@ -19,7 +19,7 @@ class ClassBased extends _$ClassBased { // Foo @riverpod String family( - FamilyRef ref, + Ref ref, /// Hello Id int id, diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index b8c36c01e..41f1699bb 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -72,7 +72,7 @@ final class FunctionalProvider extends $FunctionalProvider } } -String _$functionalHash() => r'1198a9a7842513019f6a8cd1b32e72217a00ee8f'; +String _$functionalHash() => r'52eddcd28b005800da9cf6c22df77f2f040bfb34'; /// Hello world // Foo @@ -245,7 +245,7 @@ final class FamilyProvider extends $FunctionalProvider } } -String _$familyHash() => r'339f0a8e0733a30bbb2220ce7ff6b9de7abe6022'; +String _$familyHash() => r'5164f4ea1f2d6c741e5c600c48a1b2ac2be7a1eb'; /// Hello world // Foo @@ -470,4 +470,4 @@ abstract class _$ClassFamilyBased extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/generated.dart b/packages/riverpod_generator/test/integration/generated.dart index 0122f491d..2036f8d5c 100644 --- a/packages/riverpod_generator/test/integration/generated.dart +++ b/packages/riverpod_generator/test/integration/generated.dart @@ -1,7 +1,6 @@ // ignore_for_file: library_private_types_in_public_api, inference_failure_on_function_return_type, always_declare_return_types, type_annotate_public_apis import 'package:freezed_annotation/freezed_annotation.dart'; -import 'package:riverpod/riverpod.dart' as r; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'generated.freezed.dart'; @@ -13,10 +12,10 @@ class Test with _$Test { } @riverpod -_Test generated(GeneratedRef ref) => _Test(); +_Test generated(Ref ref) => _Test(); @riverpod -_Test generatedFamily(GeneratedFamilyRef ref, _Test test) => _Test(); +_Test generatedFamily(Ref ref, _Test test) => _Test(); @riverpod class GeneratedClass extends _$GeneratedClass { @@ -31,10 +30,10 @@ class GeneratedClassFamily extends _$GeneratedClassFamily { } @riverpod -$dynamic($DynamicRef ref) => _Test(); +$dynamic(Ref ref) => _Test(); @riverpod -$dynamicFamily($DynamicFamilyRef ref, test) => _Test(); +$dynamicFamily(Ref ref, test) => _Test(); @riverpod class $DynamicClass extends _$$DynamicClass { @@ -54,32 +53,32 @@ const dynamicProvider = _dynamicProvider; _dynamic(_DynamicRef ref, test) => 0; @riverpod -r.AsyncValue alias(AliasRef ref) { - return const r.AsyncData(42); +AsyncValue alias(AliasRef ref) { + return const AsyncData(42); } @riverpod -r.AsyncValue aliasFamily( +AsyncValue aliasFamily( AliasFamilyRef ref, - r.AsyncValue test, + AsyncValue test, ) { - return const r.AsyncData(42); + return const AsyncData(42); } @riverpod class AliasClass extends _$AliasClass { @override - r.AsyncValue build() { - return const r.AsyncData(42); + AsyncValue build() { + return const AsyncData(42); } } @riverpod class AliasClassFamily extends _$AliasClassFamily { @override - r.AsyncValue build( - r.AsyncValue test, + AsyncValue build( + AsyncValue test, ) { - return const r.AsyncData(42); + return const AsyncData(42); } } diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 26cafbcf9..4aef3a2a0 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -64,7 +64,7 @@ final class GeneratedProvider extends $FunctionalProvider<_Test, _Test> } } -String _$generatedHash() => r'e49f3520d06ed50d34a44de613fdcd20b19f48d4'; +String _$generatedHash() => r'0332eb232658688654514ff241ff380edbf4dbf6'; typedef GeneratedFamilyRef = Ref<_Test>; @@ -154,7 +154,7 @@ final class GeneratedFamilyProvider extends $FunctionalProvider<_Test, _Test> } } -String _$generatedFamilyHash() => r'ed284f58926c87acc81dab9168882d5d1c2cddf8'; +String _$generatedFamilyHash() => r'8ac3b633763cb8dbad6e0686a732df3a081a0d64'; final class GeneratedFamilyFamily extends Family { const GeneratedFamilyFamily._() @@ -491,7 +491,7 @@ final class $DynamicProvider extends $FunctionalProvider } } -String _$$dynamicHash() => r'f62d63d9340f30b253e687f76deacd8205fed0e7'; +String _$$dynamicHash() => r'17c8e140446da2e3c026ebb51c4b074d2894b7ff'; typedef $DynamicFamilyRef = Ref; @@ -581,7 +581,7 @@ final class $DynamicFamilyProvider extends $FunctionalProvider } } -String _$$dynamicFamilyHash() => r'b764133af8837b8321b08814892f198d4bc1aa18'; +String _$$dynamicFamilyHash() => r'6897846251c8b4b5b2fa72d8d3e14ae3381c0c0f'; final class $DynamicFamilyFamily extends Family { const $DynamicFamilyFamily._() @@ -993,16 +993,16 @@ final class _DynamicFamily extends Family { } } -typedef AliasRef = Ref>; +typedef AliasRef = Ref>; @ProviderFor(alias) const aliasProvider = AliasProvider._(); final class AliasProvider - extends $FunctionalProvider, r.AsyncValue> - with $Provider, AliasRef> { + extends $FunctionalProvider, AsyncValue> + with $Provider, AliasRef> { const AliasProvider._( - {r.AsyncValue Function( + {AsyncValue Function( AliasRef ref, )? create}) : _createCb = create, @@ -1016,7 +1016,7 @@ final class AliasProvider allTransitiveDependencies: null, ); - final r.AsyncValue Function( + final AsyncValue Function( AliasRef ref, )? _createCb; @@ -1024,22 +1024,21 @@ final class AliasProvider String debugGetCreateSourceHash() => _$aliasHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(r.AsyncValue value) { + Override overrideWithValue(AsyncValue value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>(value), + providerOverride: $ValueProvider>(value), ); } @$internal @override - $ProviderElement> $createElement( - $ProviderPointer pointer) => + $ProviderElement> $createElement($ProviderPointer pointer) => $ProviderElement(this, pointer); @override AliasProvider $copyWithCreate( - r.AsyncValue Function( + AsyncValue Function( AliasRef ref, ) create, ) { @@ -1047,28 +1046,28 @@ final class AliasProvider } @override - r.AsyncValue create(AliasRef ref) { + AsyncValue create(AliasRef ref) { final _$cb = _createCb ?? alias; return _$cb(ref); } } -String _$aliasHash() => r'cc08ec4cc5ec0dc98bdb7f4dcbc035021b09bcf3'; +String _$aliasHash() => r'ed56b34397f397d33434be16d3a6bab96d24c45b'; -typedef AliasFamilyRef = Ref>; +typedef AliasFamilyRef = Ref>; @ProviderFor(aliasFamily) const aliasFamilyProvider = AliasFamilyFamily._(); final class AliasFamilyProvider - extends $FunctionalProvider, r.AsyncValue> - with $Provider, AliasFamilyRef> { + extends $FunctionalProvider, AsyncValue> + with $Provider, AliasFamilyRef> { const AliasFamilyProvider._( {required AliasFamilyFamily super.from, - required r.AsyncValue super.argument, - r.AsyncValue Function( + required AsyncValue super.argument, + AsyncValue Function( AliasFamilyRef ref, - r.AsyncValue test, + AsyncValue test, )? create}) : _createCb = create, super( @@ -1079,9 +1078,9 @@ final class AliasFamilyProvider allTransitiveDependencies: null, ); - final r.AsyncValue Function( + final AsyncValue Function( AliasFamilyRef ref, - r.AsyncValue test, + AsyncValue test, )? _createCb; @override @@ -1095,39 +1094,38 @@ final class AliasFamilyProvider } /// {@macro riverpod.override_with_value} - Override overrideWithValue(r.AsyncValue value) { + Override overrideWithValue(AsyncValue value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>(value), + providerOverride: $ValueProvider>(value), ); } @$internal @override - $ProviderElement> $createElement( - $ProviderPointer pointer) => + $ProviderElement> $createElement($ProviderPointer pointer) => $ProviderElement(this, pointer); @override AliasFamilyProvider $copyWithCreate( - r.AsyncValue Function( + AsyncValue Function( AliasFamilyRef ref, ) create, ) { return AliasFamilyProvider._( - argument: argument as r.AsyncValue, + argument: argument as AsyncValue, from: from! as AliasFamilyFamily, create: ( ref, - r.AsyncValue test, + AsyncValue test, ) => create(ref)); } @override - r.AsyncValue create(AliasFamilyRef ref) { + AsyncValue create(AliasFamilyRef ref) { final _$cb = _createCb ?? aliasFamily; - final argument = this.argument as r.AsyncValue; + final argument = this.argument as AsyncValue; return _$cb( ref, argument, @@ -1145,7 +1143,7 @@ final class AliasFamilyProvider } } -String _$aliasFamilyHash() => r'f345937d5750132f629aef41646b119a301f750b'; +String _$aliasFamilyHash() => r'21f22a6042a649e2de33b829bb85ea54eb6983a2'; final class AliasFamilyFamily extends Family { const AliasFamilyFamily._() @@ -1158,7 +1156,7 @@ final class AliasFamilyFamily extends Family { ); AliasFamilyProvider call( - r.AsyncValue test, + AsyncValue test, ) => AliasFamilyProvider._(argument: test, from: this); @@ -1170,9 +1168,9 @@ final class AliasFamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( - r.AsyncValue Function( + AsyncValue Function( AliasFamilyRef ref, - r.AsyncValue args, + AsyncValue args, ) create, ) { return $FamilyOverride( @@ -1180,7 +1178,7 @@ final class AliasFamilyFamily extends Family { createElement: (pointer) { final provider = pointer.origin as AliasFamilyProvider; - final argument = provider.argument as r.AsyncValue; + final argument = provider.argument as AsyncValue; return provider .$copyWithCreate((ref) => create(ref, argument)) @@ -1194,7 +1192,7 @@ final class AliasFamilyFamily extends Family { const aliasClassProvider = AliasClassProvider._(); final class AliasClassProvider - extends $NotifierProvider> { + extends $NotifierProvider> { const AliasClassProvider._( {super.runNotifierBuildOverride, AliasClass Function()? create}) : _createCb = create, @@ -1214,10 +1212,10 @@ final class AliasClassProvider String debugGetCreateSourceHash() => _$aliasClassHash(); /// {@macro riverpod.override_with_value} - Override overrideWithValue(r.AsyncValue value) { + Override overrideWithValue(AsyncValue value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>(value), + providerOverride: $ValueProvider>(value), ); } @@ -1236,8 +1234,8 @@ final class AliasClassProvider @$internal @override AliasClassProvider $copyWithBuild( - r.AsyncValue Function( - Ref>, + AsyncValue Function( + Ref>, AliasClass, ) build, ) { @@ -1246,28 +1244,28 @@ final class AliasClassProvider @$internal @override - $NotifierProviderElement> $createElement( + $NotifierProviderElement> $createElement( $ProviderPointer pointer) => $NotifierProviderElement(this, pointer); } -String _$aliasClassHash() => r'a6c6d7594ebd09ba728e42d79b12af560d09c379'; +String _$aliasClassHash() => r'aac83936c14520c015f0fe8a0120d353c0baf602'; -abstract class _$AliasClass extends $Notifier> { - r.AsyncValue build(); +abstract class _$AliasClass extends $Notifier> { + AsyncValue build(); @$internal @override - r.AsyncValue runBuild() => build(); + AsyncValue runBuild() => build(); } @ProviderFor(AliasClassFamily) const aliasClassFamilyProvider = AliasClassFamilyFamily._(); final class AliasClassFamilyProvider - extends $NotifierProvider> { + extends $NotifierProvider> { const AliasClassFamilyProvider._( {required AliasClassFamilyFamily super.from, - required r.AsyncValue super.argument, + required AsyncValue super.argument, super.runNotifierBuildOverride, AliasClassFamily Function()? create}) : _createCb = create, @@ -1292,10 +1290,10 @@ final class AliasClassFamilyProvider } /// {@macro riverpod.override_with_value} - Override overrideWithValue(r.AsyncValue value) { + Override overrideWithValue(AsyncValue value) { return $ProviderOverride( origin: this, - providerOverride: $ValueProvider>(value), + providerOverride: $ValueProvider>(value), ); } @@ -1309,7 +1307,7 @@ final class AliasClassFamilyProvider AliasClassFamily Function() create, ) { return AliasClassFamilyProvider._( - argument: argument as r.AsyncValue, + argument: argument as AsyncValue, from: from! as AliasClassFamilyFamily, create: create); } @@ -1317,20 +1315,20 @@ final class AliasClassFamilyProvider @$internal @override AliasClassFamilyProvider $copyWithBuild( - r.AsyncValue Function( - Ref>, + AsyncValue Function( + Ref>, AliasClassFamily, ) build, ) { return AliasClassFamilyProvider._( - argument: argument as r.AsyncValue, + argument: argument as AsyncValue, from: from! as AliasClassFamilyFamily, runNotifierBuildOverride: build); } @$internal @override - $NotifierProviderElement> $createElement( + $NotifierProviderElement> $createElement( $ProviderPointer pointer) => $NotifierProviderElement(this, pointer); @@ -1345,7 +1343,7 @@ final class AliasClassFamilyProvider } } -String _$aliasClassFamilyHash() => r'3f348beb95dae3a9890b4a4d0ce01481316fc66d'; +String _$aliasClassFamilyHash() => r'd4374c0ffbbca9d65fb967255129b3ceddaa764e'; final class AliasClassFamilyFamily extends Family { const AliasClassFamilyFamily._() @@ -1358,7 +1356,7 @@ final class AliasClassFamilyFamily extends Family { ); AliasClassFamilyProvider call( - r.AsyncValue test, + AsyncValue test, ) => AliasClassFamilyProvider._(argument: test, from: this); @@ -1371,7 +1369,7 @@ final class AliasClassFamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( AliasClassFamily Function( - r.AsyncValue args, + AsyncValue args, ) create, ) { return $FamilyOverride( @@ -1379,7 +1377,7 @@ final class AliasClassFamilyFamily extends Family { createElement: (pointer) { final provider = pointer.origin as AliasClassFamilyProvider; - final argument = provider.argument as r.AsyncValue; + final argument = provider.argument as AsyncValue; return provider .$copyWithCreate(() => create(argument)) @@ -1390,8 +1388,8 @@ final class AliasClassFamilyFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - r.AsyncValue Function(Ref> ref, - AliasClassFamily notifier, r.AsyncValue argument) + AsyncValue Function(Ref> ref, + AliasClassFamily notifier, AsyncValue argument) build, ) { return $FamilyOverride( @@ -1399,7 +1397,7 @@ final class AliasClassFamilyFamily extends Family { createElement: (pointer) { final provider = pointer.origin as AliasClassFamilyProvider; - final argument = provider.argument as r.AsyncValue; + final argument = provider.argument as AsyncValue; return provider .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) @@ -1409,19 +1407,19 @@ final class AliasClassFamilyFamily extends Family { } } -abstract class _$AliasClassFamily extends $Notifier> { - late final _$args = ref.$arg as r.AsyncValue; - r.AsyncValue get test => _$args; +abstract class _$AliasClassFamily extends $Notifier> { + late final _$args = ref.$arg as AsyncValue; + AsyncValue get test => _$args; - r.AsyncValue build( - r.AsyncValue test, + AsyncValue build( + AsyncValue test, ); @$internal @override - r.AsyncValue runBuild() => build( + AsyncValue runBuild() => build( _$args, ); } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/hash/hash1.dart b/packages/riverpod_generator/test/integration/hash/hash1.dart index a299a420e..67fb2e74a 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.dart @@ -3,12 +3,12 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'hash1.g.dart'; @riverpod -String simple(SimpleRef ref) { +String simple(Ref ref) { return 'Hello world'; } @riverpod -String simple2(Simple2Ref ref) { +String simple2(Ref ref) { return 'Hello world2'; } diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index 3b01e9aa9..0cc5023c4 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -64,7 +64,7 @@ final class SimpleProvider extends $FunctionalProvider } } -String _$simpleHash() => r'ff9f7451526aef5b3af6646814631a502ad76a5f'; +String _$simpleHash() => r'f916b37e39d654e9acfc9c2bd7a244902197b306'; typedef Simple2Ref = Ref; @@ -124,7 +124,7 @@ final class Simple2Provider extends $FunctionalProvider } } -String _$simple2Hash() => r'06327442776394c5c9cbb33b048d7a42e709e7fd'; +String _$simple2Hash() => r'a60a8496fc391f5adf7ad45a12d0723f14f3127c'; @ProviderFor(SimpleClass) const simpleClassProvider = SimpleClassProvider._(); @@ -196,4 +196,4 @@ abstract class _$SimpleClass extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/hash/retry.dart b/packages/riverpod_generator/test/integration/hash/retry.dart index 6aadf62ba..77b2d08af 100644 --- a/packages/riverpod_generator/test/integration/hash/retry.dart +++ b/packages/riverpod_generator/test/integration/hash/retry.dart @@ -3,10 +3,10 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'retry.g.dart'; @Riverpod(retry: myRetry) -String a(ARef ref) => throw UnimplementedError(); +String a(Ref ref) => throw UnimplementedError(); Duration? myRetry(int retryCount, Object error) => null; Duration? myRetry2(int retryCount, Object error) => null; @Riverpod(retry: myRetry2) -String b(ARef ref, int arg) => throw UnimplementedError(); +String b(Ref ref, int arg) => throw UnimplementedError(); diff --git a/packages/riverpod_generator/test/integration/hash/retry.g.dart b/packages/riverpod_generator/test/integration/hash/retry.g.dart index a49dc5d2d..3341cd835 100644 --- a/packages/riverpod_generator/test/integration/hash/retry.g.dart +++ b/packages/riverpod_generator/test/integration/hash/retry.g.dart @@ -64,7 +64,7 @@ final class AProvider extends $FunctionalProvider } } -String _$aHash() => r'3500a02140f277a66793d8118c15e09150ae67cd'; +String _$aHash() => r'83a9516d10f85dc72ca773837e042bfc6e36c1f1'; typedef BRef = Ref; @@ -154,7 +154,7 @@ final class BProvider extends $FunctionalProvider } } -String _$bHash() => r'0af37d2fa472b9730e1aa01841787d964b9f193b'; +String _$bHash() => r'95798a157250c86a901bca5701b487f508f8a5a4'; final class BFamily extends Family { const BFamily._() @@ -199,4 +199,4 @@ final class BFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index fc6837210..132dea515 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -238,4 +238,4 @@ abstract class _$ScopedClassFamily extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/split.dart b/packages/riverpod_generator/test/integration/split.dart index 543f7e6fc..c5e4755a7 100644 --- a/packages/riverpod_generator/test/integration/split.dart +++ b/packages/riverpod_generator/test/integration/split.dart @@ -1,8 +1,8 @@ -// Regression test for https://github.com/rrousselGit/riverpod/issues/2175 +// Regresion test for https://github.com/rrousselGit/riverpod/issues/2175 import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'split2.dart'; part 'split.g.dart'; @riverpod -int counter2(Counter2Ref ref) => 0; +int counter2(Ref ref) => 0; diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index d9b6e97f3..d28eb5553 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -64,7 +64,7 @@ final class Counter2Provider extends $FunctionalProvider } } -String _$counter2Hash() => r'9328919066a683f85226fc59201bb7c54f107a7d'; +String _$counter2Hash() => r'ab7bef7da79217c780c76761a5ae0c0172ca097e'; typedef CounterRef = Ref; @@ -124,7 +124,7 @@ final class CounterProvider extends $FunctionalProvider } } -String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; +String _$counterHash() => r'784ece48cb20fcfdec1553774ecfbd381d1e081f'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/split2.dart b/packages/riverpod_generator/test/integration/split2.dart index 8dc266ec0..2edb0f174 100644 --- a/packages/riverpod_generator/test/integration/split2.dart +++ b/packages/riverpod_generator/test/integration/split2.dart @@ -1,4 +1,4 @@ part of 'split.dart'; @riverpod -int counter(CounterRef ref) => 0; +int counter(Ref ref) => 0; diff --git a/packages/riverpod_generator/test/integration/stream.dart b/packages/riverpod_generator/test/integration/stream.dart index 00f919624..d6454068a 100644 --- a/packages/riverpod_generator/test/integration/stream.dart +++ b/packages/riverpod_generator/test/integration/stream.dart @@ -3,7 +3,7 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'stream.g.dart'; @riverpod -Stream> generic(GenericRef ref) async* { +Stream> generic(Ref ref) async* { yield []; } @@ -16,20 +16,20 @@ class GenericClass extends _$GenericClass { } @riverpod -Stream public(PublicRef ref) { +Stream public(Ref ref) { return Stream.value('Hello world'); } const privateProvider = _privateProvider; @riverpod -Stream _private(_PrivateRef ref) { +Stream _private(Ref ref) { return Stream.value('Hello world'); } @riverpod Stream family( - FamilyRef ref, + Ref ref, int first, { String? second, required double third, diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 2d3f0c39e..2e4e2000d 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -85,7 +85,7 @@ final class GenericProvider } } -String _$genericHash() => r'c1122edf55163d47de8d871ed5d15e0a7edddc05'; +String _$genericHash() => r'eaaf15c08df1aba30b6d6e70d67622d669df977f'; final class GenericFamily extends Family { const GenericFamily._() @@ -322,7 +322,7 @@ final class PublicProvider } } -String _$publicHash() => r'c5cc0eac434371901cf6ab159a81bba49c58da12'; +String _$publicHash() => r'ed93527425175c4a2475e83a3f44223a2aa604d7'; typedef _PrivateRef = Ref>; @@ -375,7 +375,7 @@ final class _PrivateProvider } } -String _$privateHash() => r'bbee0c7e27bda81346b5f52c96b23b2e48f83077'; +String _$privateHash() => r'7915ccdd16751e7dc6274bb024d1b273d78dc78b'; typedef FamilyRef = Ref>; @@ -493,7 +493,7 @@ final class FamilyProvider } } -String _$familyHash() => r'6896fac2f6e3ccd7c38ecaa0d538cbd3577936b2'; +String _$familyHash() => r'ba1df8eab0af0f3f71ae29d23ccb7a491d8e2825'; final class FamilyFamily extends Family { const FamilyFamily._() @@ -913,4 +913,4 @@ abstract class _$FamilyClass extends $StreamNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/integration/sync.dart b/packages/riverpod_generator/test/integration/sync.dart index 20c87bbea..cd4f5ea85 100644 --- a/packages/riverpod_generator/test/integration/sync.dart +++ b/packages/riverpod_generator/test/integration/sync.dart @@ -1,10 +1,10 @@ -import 'package:riverpod/riverpod.dart' as r; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'sync.g.dart'; @riverpod -List generic(GenericRef ref) { +List generic(Ref ref) { return [ 'Hello world', 42, @@ -14,7 +14,7 @@ List generic(GenericRef ref) { @riverpod List complexGeneric( - ComplexGenericRef ref, { + Ref ref, { required T param, Foo? otherParam, }) { @@ -31,12 +31,12 @@ class GenericClass extends _$GenericClass } @riverpod -Raw> rawFuture(RawFutureRef ref) async { +Raw> rawFuture(Ref ref) async { return 'Hello world'; } @riverpod -Raw> rawStream(RawStreamRef ref) async* { +Raw> rawStream(Ref ref) async* { yield 'Hello world'; } @@ -57,12 +57,12 @@ class RawStreamClass extends _$RawStreamClass { } @riverpod -Raw> rawFamilyFuture(RawFamilyFutureRef ref, int id) async { +Raw> rawFamilyFuture(Ref ref, int id) async { return 'Hello world'; } @riverpod -Raw> rawFamilyStream(RawFamilyStreamRef ref, int id) async* { +Raw> rawFamilyStream(Ref ref, int id) async* { yield 'Hello world'; } @@ -84,19 +84,19 @@ class RawFamilyStreamClass extends _$RawFamilyStreamClass { /// This is some documentation @riverpod -String public(PublicRef ref) { +String public(Ref ref) { return 'Hello world'; } @riverpod -String supports$inNames(Supports$inNamesRef ref) { +String supports$inNames(Ref ref) { return 'Hello world'; } /// This is some documentation @riverpod String family( - FamilyRef ref, + Ref ref, int first, { String? second, required double third, @@ -109,11 +109,11 @@ String family( const privateProvider = _privateProvider; @riverpod -String _private(_PrivateRef ref) { +String _private(Ref ref) { return 'Hello world'; } -mixin MyMixin on r.NotifierBase {} +mixin MyMixin on NotifierBase {} /// This is some documentation @riverpod @@ -197,11 +197,11 @@ class Supports$InClassFamilyName } @riverpod -String generated(GeneratedRef ref) { +String generated(Ref ref) { return 'Just a simple normal generated provider'; } -r.Provider someProvider() => r.Provider((ref) => 'hello'); +Provider someProvider() => Provider((ref) => 'hello'); // Regression test for https://github.com/rrousselGit/riverpod/issues/2299 final _someProvider = someProvider(); diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 00c358cd1..1fb2502d4 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -93,7 +93,7 @@ final class GenericProvider } } -String _$genericHash() => r'0fda19dd377694315cdffd7414d53f98569c655c'; +String _$genericHash() => r'4a2a38e246fc4ef25c46d93477010b66de01ff30'; final class GenericFamily extends Family { const GenericFamily._() @@ -249,7 +249,7 @@ final class ComplexGenericProvider } } -String _$complexGenericHash() => r'a5254e5552cd61bb8d65c018539ff2d8edfd5822'; +String _$complexGenericHash() => r'bc3433c913396a238e833722a2dc3a78bdf844a4'; final class ComplexGenericFamily extends Family { const ComplexGenericFamily._() @@ -524,7 +524,7 @@ final class RawFutureProvider } } -String _$rawFutureHash() => r'5203a56065b768023770326281618e3229ccb530'; +String _$rawFutureHash() => r'9d397f4c0a578a2741610f9ca6f17438ee8e5a34'; typedef RawStreamRef = Ref>>; @@ -586,7 +586,7 @@ final class RawStreamProvider } } -String _$rawStreamHash() => r'2b764189753a8b74f47ba557a79416f00ef5cebd'; +String _$rawStreamHash() => r'c7d6cd22f1f325827c866c3ec757d08315fd9858'; @ProviderFor(RawFutureClass) const rawFutureClassProvider = RawFutureClassProvider._(); @@ -818,7 +818,7 @@ final class RawFamilyFutureProvider } } -String _$rawFamilyFutureHash() => r'485f59512081852e51279658facc015309743864'; +String _$rawFamilyFutureHash() => r'0ac70d7a2133691f1a9a38cedaeeb6b3bc667ade'; final class RawFamilyFutureFamily extends Family { const RawFamilyFutureFamily._() @@ -953,7 +953,7 @@ final class RawFamilyStreamProvider } } -String _$rawFamilyStreamHash() => r'e778e5cfcb8ab381e2412f5c73213aaa03b93012'; +String _$rawFamilyStreamHash() => r'6eacfa3a3576d884099c08c298751a3d395271be'; final class RawFamilyStreamFamily extends Family { const RawFamilyStreamFamily._() @@ -1388,7 +1388,7 @@ final class PublicProvider extends $FunctionalProvider } } -String _$publicHash() => r'138be35943899793ab085e711fe3f3d22696a3ba'; +String _$publicHash() => r'94bee36125844f9fe521363bb228632b9f3bfbc7'; typedef Supports$inNamesRef = Ref; @@ -1448,7 +1448,7 @@ final class Supports$inNamesProvider extends $FunctionalProvider } } -String _$supports$inNamesHash() => r'cbf929802fcbd0aa949ad72743d096fb3ef5f28f'; +String _$supports$inNamesHash() => r'8da1f9329f302ce75e38d03c96595de3260b4d2d'; /// This is some documentation typedef FamilyRef = Ref; @@ -1577,7 +1577,7 @@ final class FamilyProvider extends $FunctionalProvider } } -String _$familyHash() => r'14d1ee238ca608d547630d0e222ef4c5866e9e61'; +String _$familyHash() => r'f58149448f80f10ec054f2f8a6f37bae61e38f49'; /// This is some documentation final class FamilyFamily extends Family { @@ -1704,7 +1704,7 @@ final class _PrivateProvider extends $FunctionalProvider } } -String _$privateHash() => r'519561bc7e88e394d7f75ca2102a5c0acc832c66'; +String _$privateHash() => r'834affaed42662bf46ce7f6203ac2495e1e8974b'; /// This is some documentation @ProviderFor(PublicClass) @@ -2869,7 +2869,7 @@ final class GeneratedProvider extends $FunctionalProvider } } -String _$generatedHash() => r'fecbc1d5d9a05fc996b452a57fd1975ff368af91'; +String _$generatedHash() => r'24bfb5df4dc529258ab568372e90a1cbfc2d8c24'; typedef UnnecessaryCastRef = Ref; @@ -3312,4 +3312,4 @@ final class ManyDataStreamFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_graph/lib/src/analyze.dart b/packages/riverpod_graph/lib/src/analyze.dart index b65d298e7..85ccd68b2 100644 --- a/packages/riverpod_graph/lib/src/analyze.dart +++ b/packages/riverpod_graph/lib/src/analyze.dart @@ -683,7 +683,10 @@ class _ProviderName { /// Returns the name of the provider. _ProviderName _displayNameForProvider(VariableElement provider) { final providerName = provider.name; - final enclosingElementName = provider.enclosingElement3?.displayName; + final enclosingElementName = provider + // ignore: deprecated_member_use, necessary to support older versions of analyzer + .enclosingElement + ?.displayName; return _ProviderName( providerName: providerName, enclosingElementName: enclosingElementName ?? '', diff --git a/packages/riverpod_graph/pubspec.yaml b/packages/riverpod_graph/pubspec.yaml index def4dcf16..609a75006 100644 --- a/packages/riverpod_graph/pubspec.yaml +++ b/packages/riverpod_graph/pubspec.yaml @@ -11,7 +11,7 @@ environment: sdk: ">=3.0.0<4.0.0" dependencies: - analyzer: "6.9.0" + analyzer: ^6.7.0 args: ^2.4.0 collection: ^1.0.0 path: ^1.8.2 diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart index df024ab3f..228a0eff2 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart @@ -4,20 +4,20 @@ part 'sync.g.dart'; /// A public generated provider. @riverpod -String public(PublicRef ref) { +String public(Ref ref) { return 'Hello world'; } /// A generated provider with a '$' in its name. @riverpod -String supports$inNames(Supports$inNamesRef ref) { +String supports$inNames(Ref ref) { return ref.watch(publicProvider); } /// A generated family provider. @riverpod String family( - FamilyRef ref, + Ref ref, int first, { String? second, required double third, @@ -32,7 +32,7 @@ String family( const privateProvider = _privateProvider; @riverpod -String _private(_PrivateRef ref) { +String _private(Ref ref) { return ref.watch(publicProvider); } diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index caa66850a..4dd2653f5 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -68,7 +68,7 @@ final class PublicProvider extends $FunctionalProvider } } -String _$publicHash() => r'138be35943899793ab085e711fe3f3d22696a3ba'; +String _$publicHash() => r'94bee36125844f9fe521363bb228632b9f3bfbc7'; /// A generated provider with a '$' in its name. typedef Supports$inNamesRef = Ref; @@ -132,7 +132,7 @@ final class Supports$inNamesProvider extends $FunctionalProvider } } -String _$supports$inNamesHash() => r'baacdb7b92917860b02aba1fa7010c7056da4a67'; +String _$supports$inNamesHash() => r'a883450ddca90a227631fe54d1d9ae305bc558d9'; /// A generated family provider. typedef FamilyRef = Ref; @@ -261,7 +261,7 @@ final class FamilyProvider extends $FunctionalProvider } } -String _$familyHash() => r'ebf082969854dcc358b9870a2e5e9b922423e59b'; +String _$familyHash() => r'062561e0cad8585939dc9adc23de6452be2c9788'; /// A generated family provider. final class FamilyFamily extends Family { @@ -388,7 +388,7 @@ final class _PrivateProvider extends $FunctionalProvider } } -String _$privateHash() => r'9a87ed0765ad8448525fa1290b34760c79e7402b'; +String _$privateHash() => r'4f7b825ffa8a674f01dc8453cb480060a6a7bf5f'; /// A generated public provider from a class @ProviderFor(PublicClass) @@ -847,4 +847,4 @@ abstract class _$Supports$InClassName extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index c9002713f..9fa55e203 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -42,7 +42,24 @@ Various lints had their severity changed: - `riverpod` upgraded to `3.0.0-dev.0` -## Unreleased patch +## 2.6.2 - 2024-10-27 + +- Support latest custom_lint + +## 2.6.1 - 2024-10-22 + +- Support analyzer >=6.7.0 <7.0.0 + This should make it compatible with Flutter's stable channel. + +## 2.4.0 - 2024-10-20 + +- `functional_ref` and its quick-fix now expect: + ```dart + @riverpod + Model foo(Ref ref) => .. + ``` + +## 2.3.14 - 2024-10-12 Bump analyzer to ^6.9.0 diff --git a/packages/riverpod_lint/README.md b/packages/riverpod_lint/README.md index 8dc42fc2d..74fa1d7f1 100644 --- a/packages/riverpod_lint/README.md +++ b/packages/riverpod_lint/README.md @@ -202,11 +202,11 @@ Consider the following providers: ```dart // A non-scoped provider @riverpod -int root(RootRef ref) => 0; +int root(Ref ref) => 0; // A possibly scoped provider @Riverpod(dependencies: []) -int scoped(ScopedRef ref) => 0; +int scoped(Ref ref) => 0; ``` **Good**: @@ -214,21 +214,21 @@ int scoped(ScopedRef ref) => 0; ```dart // No dependencies used, no need to specify "dependencies" @riverpod -int example(ExampleRef ref) => 0; +int example(Ref ref) => 0; // We can specify an empty "dependencies" list if we wish to. // This marks the provider as "scoped". @Riverpod(dependencies: []) -int example(ExampleRef ref) => 0; +int example(Ref ref) => 0; @riverpod -void example(ExampleRef ref) { +void example(Ref ref) { // rootProvider is not scoped, no need to specify it as "dependencies" ref.watch(rootProvider); } @Riverpod(dependencies: [scoped]) -void example(ExampleRef ref) { +void example(Ref ref) { // scopedProvider is scoped and as such specifying "dependencies" is required. ref.watch(scopedProvider); } @@ -261,16 +261,16 @@ ProviderScope( ```dart // scopedProvider isn't used and should therefore not be listed @Riverpod(dependencies: [scoped]) -int example(ExampleRef ref) => 0; +int example(Ref ref) => 0; @Riverpod(dependencies: []) -void example(ExampleRef ref) { +void example(Ref ref) { // scopedProvider is used but not present in the list of dependencies ref.watch(scopedProvider); } @Riverpod(dependencies: [root]) -void example(ExampleRef ref) { +void example(Ref ref) { // rootProvider is not a scoped provider. As such it shouldn't be listed in "dependencies" ref.watch(rootProvider); } @@ -294,10 +294,10 @@ Consider the following providers: ```dart @Riverpod(dependencies: []) -int scoped(ScopedRef ref) => 0; +int scoped(Ref ref) => 0; @riverpod -int root(RootRef ref) => 0; +int root(Ref ref) => 0; ``` (Providers defined without `riverpod_generator` are not supported) @@ -362,10 +362,10 @@ Failing to do so would break the [provider_dependencies](#provider_dependencies- ```dart @riverpod -int dep(DepRef ref) => 0; +int dep(Ref ref) => 0; @riverpod -void example(ExampleRef ref) { +void example(Ref ref) { /// Generated providers can depend on other generated providers ref.watch(depProvider); } @@ -377,7 +377,7 @@ void example(ExampleRef ref) { final depProvider = Provider((ref) => 0); @riverpod -void example(ExampleRef ref) { +void example(Ref ref) { // Generated providers should not depend on non-generated providers ref.watch(depProvider); } @@ -391,7 +391,7 @@ Providers should not interact with `BuildContext`. ```dart @riverpod -int fn(FnRef ref) => 0; +int fn(Ref ref) => 0; @riverpod class MyNotifier extends _$MyNotifier { @@ -405,7 +405,7 @@ class MyNotifier extends _$MyNotifier { ```dart // Providers should not receive a BuildContext as a parameter. -int fn(FnRef ref, BuildContext context) => 0; +int fn(Ref ref, BuildContext context) => 0; @riverpod class MyNotifier extends _$MyNotifier { @@ -518,7 +518,7 @@ In that scenario, you may explicitly wrap the value in `Raw`: ```dart @riverpod -int integer(IntegerRef ref) => 0; +int integer(Ref ref) => 0; @riverpod class IntegerNotifier extends _$IntegerNotifier { @@ -529,7 +529,7 @@ class IntegerNotifier extends _$IntegerNotifier { // By using "Raw", we can explicitly return a ChangeNotifier in a provider // without triggering `unsupported_provider_value`. @riverpod -Raw myRouter(MyRouterRef ref) { +Raw myRouter(Ref ref) { final router = GoRouter(...); // Riverpod won't dispose the ChangeNotifier for you in this case. Don't forget // to do it on your own! @@ -544,7 +544,7 @@ Raw myRouter(MyRouterRef ref) { // KO: riverpod_generator does not support creating StateNotifier/ChangeNotifiers/... // Instead annotate a class with @riverpod. @riverpod -MyStateNotifier stateNotifier(StateNotifierRef ref) => MyStateNotifier(); +MyStateNotifier stateNotifier(Ref ref) => MyStateNotifier(); class MyStateNotifier extends StateNotifier { MyStateNotifier(): super(0); @@ -559,7 +559,7 @@ Functional providers must receive a ref matching the provider name as their firs ```dart @riverpod -int myProvider(MyProviderRef ref) => 0; +int myProvider(Ref ref) => 0; ``` **Bad**: @@ -569,7 +569,7 @@ int myProvider(MyProviderRef ref) => 0; @riverpod int myProvider() => 0; -// The ref parameter is not correctly typed (int -> MyProviderRef) +// The ref parameter is not correctly typed (int -> Ref) @riverpod int myProvider(int ref) => 0; ``` diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart index 013dfc526..05d2623a5 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart @@ -287,7 +287,10 @@ class _ReplacementEditBuilder extends RecursiveAstVisitor { } final element = node.staticElement; if (element is ExecutableElement && - element.enclosingElement3 == widgetClassElement && + element + // ignore: deprecated_member_use, necessary to support older versions of analyzer + .enclosingElement == + widgetClassElement && !elementsToMove.contains(element)) { final offset = node.offset; final qualifier = diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart index 3e654764a..1d1398c49 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart @@ -329,7 +329,10 @@ class _ReplacementEditBuilder extends RecursiveAstVisitor { } final element = node.staticElement; if (element is ExecutableElement && - element.enclosingElement3 == widgetClassElement && + element + // ignore: deprecated_member_use, necessary to support older versions of analyzer + .enclosingElement == + widgetClassElement && !elementsToMove.contains(element)) { final parent = node.parent; if (parent is PrefixedIdentifier) { diff --git a/packages/riverpod_lint/lib/src/lints/async_value_nullable_pattern.dart b/packages/riverpod_lint/lib/src/lints/async_value_nullable_pattern.dart index b5fd70cea..af3c385da 100644 --- a/packages/riverpod_lint/lib/src/lints/async_value_nullable_pattern.dart +++ b/packages/riverpod_lint/lib/src/lints/async_value_nullable_pattern.dart @@ -1,7 +1,10 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/dart/element/nullability_suffix.dart'; import 'package:analyzer/dart/element/type.dart'; -import 'package:analyzer/error/error.dart' hide LintCode; +import 'package:analyzer/error/error.dart' + hide + // ignore: undefined_hidden_name, necessary to support lower analyzer version + LintCode; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; diff --git a/packages/riverpod_lint/lib/src/lints/functional_ref.dart b/packages/riverpod_lint/lib/src/lints/functional_ref.dart index 4dd11ea1e..9db84a345 100644 --- a/packages/riverpod_lint/lib/src/lints/functional_ref.dart +++ b/packages/riverpod_lint/lib/src/lints/functional_ref.dart @@ -1,8 +1,14 @@ import 'package:analyzer/dart/ast/ast.dart'; -import 'package:analyzer/error/error.dart' hide LintCode; +import 'package:analyzer/dart/element/element.dart'; +import 'package:analyzer/error/error.dart' + hide + // ignore: undefined_hidden_name, necessary to support lower analyzer version + LintCode; import 'package:analyzer/error/listener.dart'; +import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart'; import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; +import 'package:meta/meta.dart'; import '../riverpod_custom_lint.dart'; import 'notifier_extends.dart'; @@ -76,7 +82,7 @@ class FunctionalRef extends RiverpodLintRule { } @override - List getFixes() => [FunctionalRefFix()]; + List getFixes() => [FunctionalRefFix()]; } class FunctionalRefFix extends RiverpodFix { @@ -94,14 +100,9 @@ class FunctionalRefFix extends RiverpodFix { return; } - final expectedGenerics = genericsDisplayStringFor( - declaration.node.functionExpression.typeParameters, - ); - final expectedRefType = '${refNameFor(declaration)}$expectedGenerics'; - final refNode = declaration .node.functionExpression.parameters!.parameters.firstOrNull; - if (refNode == null) { + if (refNode == null || refNode.isNamed) { // No ref parameter, adding one final changeBuilder = reporter.createChangeBuilder( message: 'Add ref parameter', @@ -109,9 +110,14 @@ class FunctionalRefFix extends RiverpodFix { ); changeBuilder.addDartFileEdit((builder) { + var toInsert = 'Ref ref'; + if (refNode != null) { + toInsert = '$toInsert, '; + } + builder.addSimpleInsertion( declaration.node.functionExpression.parameters!.leftParenthesis.end, - '$expectedRefType ref', + toInsert, ); }); return; @@ -121,24 +127,75 @@ class FunctionalRefFix extends RiverpodFix { // No type specified, adding it. final changeBuilder = reporter.createChangeBuilder( - message: 'Type as $expectedRefType', + message: 'Type as Ref', priority: 90, ); changeBuilder.addDartFileEdit((builder) { if (!refNode.isExplicitlyTyped) { - builder.addSimpleInsertion(refNode.name!.offset, '$expectedRefType '); + builder.addSimpleInsertion(refNode.name!.offset, 'Ref '); return; } + final type = typeAnnotationFor(refNode); builder.addSimpleReplacement( sourceRangeFrom( - start: refNode.type!.offset, + start: type.offset, end: refNode.name!.offset, ), - '$expectedRefType ', + 'Ref ', ); }); }); } } + +extension LibraryForNode on AstNode { + LibraryElement get library => (root as CompilationUnit).library; +} + +extension ImportFix on DartFileEditBuilder { + @useResult + String importRef() { + return _importWithPrefix('Ref'); + } + + @useResult + String _importWithPrefix(String name) { + final hooksRiverpodUri = + Uri(scheme: 'package', path: 'hooks_riverpod/hooks_riverpod.dart'); + final flutterRiverpodUri = + Uri(scheme: 'package', path: 'flutter_riverpod/flutter_riverpod.dart'); + final riverpodUri = Uri(scheme: 'package', path: 'riverpod/riverpod.dart'); + + if (importsLibrary(hooksRiverpodUri)) { + return _buildImport(hooksRiverpodUri, name); + } + + if (importsLibrary(flutterRiverpodUri)) { + return _buildImport(flutterRiverpodUri, name); + } + + return _buildImport(riverpodUri, name); + } + + String _buildImport(Uri uri, String name) { + final import = importLibraryElement(uri); + + final prefix = import.prefix; + if (prefix != null) return '$prefix.$name'; + + return name; + } +} + +TypeAnnotation typeAnnotationFor(FormalParameter param) { + if (param is DefaultFormalParameter) { + return typeAnnotationFor(param.parameter); + } + if (param is SimpleFormalParameter) { + return param.type!; + } + + throw UnimplementedError('Unknown parameter type: $param'); +} diff --git a/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart b/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart index d3b40ca55..76270b87b 100644 --- a/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart +++ b/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart @@ -1,6 +1,9 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/dart/element/element.dart'; -import 'package:analyzer/error/error.dart' hide LintCode; +import 'package:analyzer/error/error.dart' + hide + // ignore: undefined_hidden_name, necessary to support lower analyzer version + LintCode; import 'package:analyzer/error/listener.dart'; import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; diff --git a/packages/riverpod_lint/lib/src/lints/notifier_build.dart b/packages/riverpod_lint/lib/src/lints/notifier_build.dart index 702a0ef93..e233f229e 100644 --- a/packages/riverpod_lint/lib/src/lints/notifier_build.dart +++ b/packages/riverpod_lint/lib/src/lints/notifier_build.dart @@ -1,5 +1,8 @@ import 'package:analyzer/dart/element/element.dart'; -import 'package:analyzer/error/error.dart' hide LintCode; +import 'package:analyzer/error/error.dart' + hide + // ignore: undefined_hidden_name, necessary to support lower analyzer version + LintCode; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; @@ -30,7 +33,9 @@ class NotifierBuild extends RiverpodLintRule { final annotationElement = element.element; if (annotationElement == null || - annotationElement is! ExecutableElement) return false; + annotationElement is! ExecutableElement) { + return false; + } return riverpodType.isExactlyType(annotationElement.returnType); }, diff --git a/packages/riverpod_lint/lib/src/lints/provider_parameters.dart b/packages/riverpod_lint/lib/src/lints/provider_parameters.dart index a177c3985..91ca9c00f 100644 --- a/packages/riverpod_lint/lib/src/lints/provider_parameters.dart +++ b/packages/riverpod_lint/lib/src/lints/provider_parameters.dart @@ -42,20 +42,22 @@ class ProviderParameters extends RiverpodLintRule { if (value is TypedLiteral && !value.isConst) { // Non-const literals always return a new instance and don't override == - reporter.atNode(value, code); + reporter.atNode(value, _code); } else if (value is FunctionExpression) { // provider(() => 42) is bad because a new function will always be created - reporter.atNode(value, code); + reporter.atNode(value, _code); } else if (value is InstanceCreationExpression && !value.isConst) { final instantiatedObject = value.constructorName.staticElement ?.applyRedirectedConstructors(); - final operatorEqual = - instantiatedObject?.enclosingElement3.recursiveGetMethod('=='); + final operatorEqual = instantiatedObject + // ignore: deprecated_member_use, necessary to support older versions of analyzer + ?.enclosingElement + .recursiveGetMethod('=='); if (operatorEqual == null) { // Doing `provider(new Class())` is bad if the class does not override == - reporter.atNode(value, code); + reporter.atNode(value, _code); } } } diff --git a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart index fb312d515..15e4370a5 100644 --- a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart +++ b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart @@ -43,7 +43,9 @@ class UnknownScopedUsage extends RiverpodLintRule { // then it's fine. // This is to reject cases like `ref.watch(something(provider))`. if (refInvocation?.listenable.provider == identifier || - widgetRefInvocation?.listenable.provider == identifier) return; + widgetRefInvocation?.listenable.provider == identifier) { + return; + } // .parent is used because providers count as overrides. // We don't want to count "provider" as an override, and want to focus @@ -60,7 +62,9 @@ class UnknownScopedUsage extends RiverpodLintRule { ?.returnType; // Silence the warning if passed to a widget constructor. if (enclosingConstructorType != null && - widgetType.isAssignableFromType(enclosingConstructorType)) return; + widgetType.isAssignableFromType(enclosingConstructorType)) { + return; + } reporter.atNode( identifier.node, diff --git a/packages/riverpod_lint/lib/src/riverpod_custom_lint.dart b/packages/riverpod_lint/lib/src/riverpod_custom_lint.dart index c41924e57..892770e75 100644 --- a/packages/riverpod_lint/lib/src/riverpod_custom_lint.dart +++ b/packages/riverpod_lint/lib/src/riverpod_custom_lint.dart @@ -6,9 +6,7 @@ SourceRange sourceRangeFrom({required int start, required int end}) { return SourceRange(start, end - start); } -String refNameFor(ProviderDeclaration provider) { - return '${provider.name.lexeme.titled}Ref'; -} +String refNameFor(ProviderDeclaration provider) => 'Ref'; String classNameFor(ProviderDeclaration provider) { return provider.name.lexeme.titled; diff --git a/packages/riverpod_lint/pubspec.yaml b/packages/riverpod_lint/pubspec.yaml index 34af0db08..c66c1675d 100644 --- a/packages/riverpod_lint/pubspec.yaml +++ b/packages/riverpod_lint/pubspec.yaml @@ -11,14 +11,14 @@ environment: sdk: ">=3.0.0<4.0.0" dependencies: - analyzer: ^6.9.0 + analyzer: ^6.7.0 analyzer_plugin: ^0.11.2 collection: ^1.16.0 - custom_lint_builder: ^0.6.5 + custom_lint_builder: ^0.7.0 meta: ^1.7.0 path: ^1.8.1 - riverpod: ^3.0.0-dev.3 - riverpod_analyzer_utils: ^1.0.0-dev.1 + riverpod: 3.0.0-dev.3 + riverpod_analyzer_utils: 1.0.0-dev.1 source_span: ^1.8.0 yaml: ^3.1.1 diff --git a/packages/riverpod_lint/pubspec_overrides.yaml b/packages/riverpod_lint/pubspec_overrides.yaml index d711ada23..06c1d5f2b 100644 --- a/packages/riverpod_lint/pubspec_overrides.yaml +++ b/packages/riverpod_lint/pubspec_overrides.yaml @@ -2,7 +2,5 @@ dependency_overrides: riverpod_analyzer_utils: path: ../riverpod_analyzer_utils - # necessary due to outdated mockito dependency - analyzer: ^6.0.0 riverpod: path: ../riverpod diff --git a/packages/riverpod_lint_flutter_test/analysis_options.yaml b/packages/riverpod_lint_flutter_test/analysis_options.yaml index 69961a146..b3d19c02e 100644 --- a/packages/riverpod_lint_flutter_test/analysis_options.yaml +++ b/packages/riverpod_lint_flutter_test/analysis_options.yaml @@ -3,8 +3,10 @@ analyzer: - custom_lint exclude: # Files with errors on purpose - - test/lints/notifier_extends.g.dart - - test/lints/functional_ref.g.dart + - test/lints/notifier_extends/notifier_extends.g.dart + - test/lints/functional_ref/functional_ref.g.dart + - test/lints/functional_ref/fix/auto_import.g.dart + - test/lints/functional_ref/fix/use_prefix.g.dart custom_lint: - debug: true \ No newline at end of file + debug: true diff --git a/packages/riverpod_lint_flutter_test/pubspec.yaml b/packages/riverpod_lint_flutter_test/pubspec.yaml index 7222d92a0..a56d18125 100644 --- a/packages/riverpod_lint_flutter_test/pubspec.yaml +++ b/packages/riverpod_lint_flutter_test/pubspec.yaml @@ -12,11 +12,12 @@ dependencies: sdk: flutter freezed_annotation: ^2.2.0 json_annotation: ^4.8.0 + pubspec_parse: ^1.3.0 dev_dependencies: build_runner: ^2.4.6 - custom_lint: ^0.6.5 - custom_lint_core: ^0.6.5 + custom_lint: ^0.7.0 + custom_lint_core: ^0.7.0 freezed: ^2.3.2 json_serializable: ^6.6.1 riverpod_lint: diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index ef5b84bf4..d2358f5d1 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -437,4 +437,4 @@ abstract class _$Generic extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart index fe2af3181..049d20692 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional_test.dart @@ -1,5 +1,4 @@ import 'package:riverpod_lint/src/assists/class_based_to_functional_provider.dart'; -import 'package:analyzer/source/source_range.dart'; import '../../test_lint.dart'; @@ -9,19 +8,24 @@ void main() { 'test/assists/goldens/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff', sourcePath: 'test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.dart', - (result) async { + (result, helper) async { final assist = ClassBasedToFunctionalProvider(); - return [ - ...await assist.testRun(result, const SourceRange(145, 0)), - ...await assist.testRun(result, const SourceRange(149, 0)), - ...await assist.testRun(result, const SourceRange(156, 0)), - ...await assist.testRun(result, const SourceRange(165, 0)), - ...await assist.testRun(result, const SourceRange(174, 0)), - ...await assist.testRun(result, const SourceRange(190, 0)), - ...await assist.testRun(result, const SourceRange(258, 0)), - ...await assist.testRun(result, const SourceRange(412, 0)), - ]; + final cursors = helper.rangesForString(r''' +@rive<>rpod<> +class <>Example e<>xtends _$<>Example { + @ove<>rride + int build() => 0; +} + +/// Some comment +@riverpod +class Exampl<>eFamily extends _$ExampleFamily { +'''); + + final cursors2 = helper.rangesForString('class Gen<>eric'); + + return helper.runAssist(assist, result, [...cursors, ...cursors2]); }, ); } diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart index a2ad96cb8..f7f660062 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart @@ -4,11 +4,11 @@ part 'convert_functional_provider_to_class_based.g.dart'; /// Some comment @riverpod -int example(ExampleRef ref) => 0; +int example(Ref ref) => 0; /// Some comment @riverpod -int exampleFamily(ExampleFamilyRef ref, {required int a, String b = '42'}) { +int exampleFamily(Ref ref, {required int a, String b = '42'}) { // Hello world return 0; } diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index bc2b97022..af6daf4c5 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -68,7 +68,7 @@ final class ExampleProvider extends $FunctionalProvider } } -String _$exampleHash() => r'638d7db2be22eaad0f51ea0b3ae38e0483d43725'; +String _$exampleHash() => r'67898608b444d39a000852f647ca6d3326740c98'; /// Some comment typedef ExampleFamilyRef = Ref; @@ -176,7 +176,7 @@ final class ExampleFamilyProvider extends $FunctionalProvider } } -String _$exampleFamilyHash() => r'f5547d3d88c42b135db5efea7dfaa542b3db9cc1'; +String _$exampleFamilyHash() => r'70dfc6f4b2d7d251edbc3a66c3ac0f2c56aebf8b'; /// Some comment final class ExampleFamilyFamily extends Family { @@ -233,4 +233,4 @@ final class ExampleFamilyFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart index f0e59e0be..bbc09b52c 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based_test.dart @@ -1,26 +1,24 @@ import 'package:riverpod_lint/src/assists/functional_to_class_based_provider.dart'; -import 'package:analyzer/source/source_range.dart'; import '../../test_lint.dart'; void main() { - testGolden( - 'Convert functional providers to class-based providers', - 'test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff', - sourcePath: - 'test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart', - (result) async { - final assist = FunctionalToClassBasedProvider(); + testGolden('Convert functional providers to class-based providers', + 'test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff', + sourcePath: + 'test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart', + (result, helper) async { + final assist = FunctionalToClassBasedProvider(); - return [ - ...await assist.testRun(result, const SourceRange(145, 0)), - ...await assist.testRun(result, const SourceRange(148, 0)), - ...await assist.testRun(result, const SourceRange(156, 0)), - ...await assist.testRun(result, const SourceRange(167, 0)), - ...await assist.testRun(result, const SourceRange(180, 0)), - ...await assist.testRun(result, const SourceRange(224, 0)), - ...await assist.testRun(result, const SourceRange(342, 0)), - ]; - }, - ); + final cursors = helper.rangesForString(''' +@rive<>rpo<>d +int ex<>ample(R<>ef ref) =><> 0; + +/// Some comment +@riverpod +int exampleF<>amily(Ref ref, {required int a, String b = '42'}) { +'''); + + return helper.runAssist(assist, result, cursors); + }); } diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart index 099e03afa..16a12986a 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_to_widget/convert_to_widget_test.dart @@ -1,4 +1,3 @@ -import 'package:analyzer/source/source_range.dart'; import 'package:pubspec_parse/pubspec_parse.dart'; import 'package:riverpod_lint/src/assists/convert_to_stateful_base_widget.dart'; import 'package:riverpod_lint/src/assists/convert_to_stateless_base_widget.dart'; @@ -176,70 +175,71 @@ void _runGoldenTest( description, goldenFilePath, sourcePath: 'test/assists/convert_to_widget/convert_to_widget.dart', - (result) async { - final changes = [ - // Stateless - ...await assist.testRun(result, const SourceRange(163, 0), - pubspec: pubspec), - ...await assist.testRun(result, const SourceRange(174, 0), - pubspec: pubspec), - ...await assist.testRun(result, const SourceRange(185, 0), - pubspec: pubspec), - - // StatelessWithComma - ...await assist.testRun(result, const SourceRange(350, 0), - pubspec: pubspec), - - // Hook - ...await assist.testRun(result, const SourceRange(524, 0), - pubspec: pubspec), - - // HookConsumer - ...await assist.testRun(result, const SourceRange(690, 0), - pubspec: pubspec), - - // Stateful - ...await assist.testRun(result, const SourceRange(884, 0), - pubspec: pubspec), - - // ExplicitCreateState - ...await assist.testRun(result, const SourceRange(1208, 0), - pubspec: pubspec), - - // HookStateful - ...await assist.testRun(result, const SourceRange(1553, 0), - pubspec: pubspec), - - // ConsumerStateful - ...await assist.testRun(result, const SourceRange(1863, 0), - pubspec: pubspec), - - // HookConsumerStateful - ...await assist.testRun(result, const SourceRange(2214, 0), - pubspec: pubspec), - - // ConsumerWidget - ...await assist.testRun(result, const SourceRange(2582, 0), - pubspec: pubspec), - - // StatelessWithField - ...await assist.testRun(result, const SourceRange(2784, 0), - pubspec: pubspec), - - // HookConsumerWithField - ...await assist.testRun(result, const SourceRange(3139, 0), - pubspec: pubspec), - - // ConsumerStatefulWithField - ...await assist.testRun(result, const SourceRange(3571, 0), - pubspec: pubspec), + (result, helper) async { + final cursors = [ + ...helper.rangesForString(''' +class Stateless ext<>ends Statel<>essWidget {<> + const Stateless({super.key}); +'''), + ...helper.rangesForString(''' +class StatelessWithComma extends Stateles<>sWidget { + const StatelessWithComma({super.key}); +'''), + ...helper.rangesForString(''' +class Hook extends Hook<>Widget { + const Hook({super.key}); +'''), + ...helper.rangesForString(''' +class HookConsumer extends HookConsumer<>Widget { + const HookConsumer({super.key}); +'''), + ...helper.rangesForString(''' +class Stateful extends Stateful<>Widget { + const Stateful({super.key}); +'''), + ...helper.rangesForString(''' +class ExplicitCreateState extends State<>fulWidget { + const ExplicitCreateState({super.key}); +'''), + ...helper.rangesForString(''' +class HookStateful extends StatefulH<>ookWidget { + const HookStateful({super.key}); +'''), + ...helper.rangesForString(''' +class ConsumerStateful extends ConsumerStat<>efulWidget { + const ConsumerStateful({super.key}); +'''), + ...helper.rangesForString(''' +class HookConsumerStateful extends StatefulHo<>okConsumerWidget { + const HookConsumerStateful({super.key}); +'''), + ...helper.rangesForString(''' +class Consumer extends Consume<>rWidget { + const Consumer({super.key}); +'''), + ...helper.rangesForString(''' +class StatelessWithField extends Stateless<>Widget { + const StatelessWithField({ +'''), + ...helper.rangesForString(''' +class HookConsumerWithField extends HookConsumer<>Widget { + const HookConsumerWithField({ +'''), + ...helper.rangesForString(''' +class ConsumerStatefulWithField extends ConsumerStateful<>Widget { + const ConsumerStatefulWithField({ +'''), ]; - expect( - changes, - hasLength(expectedChangeCount), + final changes = await helper.runAssist( + assist, + result, + cursors, + pubspec: pubspec, ); + expect(changes, hasLength(expectedChangeCount)); + return changes; }, ); diff --git a/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff index d32463fb6..4a35375eb 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff +++ b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.diff @@ -8,7 +8,7 @@ Diff for file `test/assists/convert_class_based_provider_to_functional/convert_c - @override - int build() => 0; - } -+ int example(ExampleRef ref) => 0; ++ int example(Ref ref) => 0; /// Some comment ``` @@ -23,7 +23,7 @@ Diff for file `test/assists/convert_class_based_provider_to_functional/convert_c - @override - int build() => 0; - } -+ int example(ExampleRef ref) => 0; ++ int example(Ref ref) => 0; /// Some comment ``` @@ -38,7 +38,7 @@ Diff for file `test/assists/convert_class_based_provider_to_functional/convert_c - @override - int build() => 0; - } -+ int example(ExampleRef ref) => 0; ++ int example(Ref ref) => 0; /// Some comment ``` @@ -55,7 +55,7 @@ Diff for file `test/assists/convert_class_based_provider_to_functional/convert_c - // Hello world - return 0; - } -+ int exampleFamily(ExampleFamilyRef ref, {required int a, String b = '42'}) { ++ int exampleFamily(Ref ref, {required int a, String b = '42'}) { + // Hello world + return 0; + } @@ -73,6 +73,6 @@ Diff for file `test/assists/convert_class_based_provider_to_functional/convert_c - @override - int build() => 0; - } -+ int generic(GenericRef ref) => 0; ++ int generic(Ref ref) => 0; ``` --- diff --git a/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff index 47aeb2dbf..729b5335f 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff +++ b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff @@ -1,10 +1,10 @@ Message: `Convert to class-based provider` Priority: 100 -Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:7`: +Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:8`: ``` /// Some comment @riverpod -- int example(ExampleRef ref) => 0; +- int example(Ref ref) => 0; + class Example extends _$Example { + @override + int build() => 0; @@ -15,11 +15,11 @@ Diff for file `test/assists/convert_functional_provider_to_class_based/convert_f --- Message: `Convert to class-based provider` Priority: 100 -Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:11`: +Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:12`: ``` /// Some comment @riverpod -- int exampleFamily(ExampleFamilyRef ref, {required int a, String b = '42'}) { +- int exampleFamily(Ref ref, {required int a, String b = '42'}) { - // Hello world - return 0; + class ExampleFamily extends _$ExampleFamily { diff --git a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart index fa9d77973..29c2d8212 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/wrap_widget/wrap_widget_test.dart @@ -1,7 +1,6 @@ import 'package:test/test.dart'; import 'package:riverpod_lint/src/assists/wrap_with_consumer.dart'; import 'package:riverpod_lint/src/assists/wrap_with_provider_scope.dart'; -import 'package:analyzer/source/source_range.dart'; import '../../test_lint.dart'; @@ -10,22 +9,19 @@ void main() { 'Wrap with consumer', 'test/assists/goldens/wrap_widget/wrap_with_consumer.diff', sourcePath: 'test/assists/wrap_widget/wrap_widget.dart', - (result) async { + (result, helper) async { final assist = WrapWithConsumer(); - var changes = [ - // Map - ...await assist.testRun(result, const SourceRange(224, 0)), + final cursors = helper.rangesForString(''' + Widget build(BuildContext context) { + Ma<>p(); - // Scaffold - ...await assist.testRun(result, const SourceRange(245, 0)), + return Scaf<>fold( + body: Conta<>iner(<>), + ); +'''); - // Container - ...await assist.testRun(result, const SourceRange(268, 0)), - - // Between () - ...await assist.testRun(result, const SourceRange(273, 0)), - ]; + final changes = await helper.runAssist(assist, result, cursors); expect(changes, hasLength(2)); @@ -37,22 +33,19 @@ void main() { 'Wrap with ProviderScope', 'test/assists/goldens/wrap_widget/wrap_with_provider_scope.diff', sourcePath: 'test/assists/wrap_widget/wrap_widget.dart', - (result) async { + (result, helper) async { final assist = WrapWithProviderScope(); - final changes = [ - // Map - ...await assist.testRun(result, const SourceRange(224, 0)), - - // Scaffold - ...await assist.testRun(result, const SourceRange(245, 0)), + final cursors = helper.rangesForString(''' + Widget build(BuildContext context) { + Ma<>p(); - // Container - ...await assist.testRun(result, const SourceRange(268, 0)), + return Scaf<>fold( + body: Conta<>iner(<>), + ); +'''); - // Between () - ...await assist.testRun(result, const SourceRange(273, 0)), - ]; + final changes = await helper.runAssist(assist, result, cursors); expect(changes, hasLength(2)); diff --git a/packages/riverpod_lint_flutter_test/test/encoders.dart b/packages/riverpod_lint_flutter_test/test/encoders.dart index 46ab91732..1905b2c81 100644 --- a/packages/riverpod_lint_flutter_test/test/encoders.dart +++ b/packages/riverpod_lint_flutter_test/test/encoders.dart @@ -13,12 +13,12 @@ import 'package:test/test.dart'; import 'golden.dart'; Matcher matchesPrioritizedSourceChangesGolden( - String fileName, { + File file, { required String source, required String sourcePath, }) { return matchersGoldenFile>( - File(fileName), + file, isEmpty: (value) => value.isEmpty, encode: (changes) { return encodePrioritizedSourceChanges( diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart index f75dfb0e4..e3ca4231b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart @@ -7,7 +7,7 @@ part 'avoid_build_context_in_providers.g.dart'; @riverpod int fn( - FnRef ref, + Ref ref, // expect_lint: avoid_build_context_in_providers BuildContext context1, { // expect_lint: avoid_build_context_in_providers @@ -34,7 +34,7 @@ class MyNotifier extends _$MyNotifier { } @riverpod -class Regresion2959 extends _$Regresion2959 { +class Regression2959 extends _$Regression2959 { @override void build() {} diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index 065501b23..b83819f2b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -108,7 +108,7 @@ final class FnProvider extends $FunctionalProvider } } -String _$fnHash() => r'7b8d0cf179067c80b8553b3232fd886fac83f387'; +String _$fnHash() => r'8a726da6104b38a55782e44062757e6771b19de3'; final class FnFamily extends Family { const FnFamily._() @@ -360,28 +360,28 @@ abstract class _$MyNotifier extends $Notifier { ); } -@ProviderFor(Regresion2959) -const regresion2959Provider = Regresion2959Provider._(); +@ProviderFor(Regression2959) +const regression2959Provider = Regression2959Provider._(); -final class Regresion2959Provider - extends $NotifierProvider { - const Regresion2959Provider._( - {super.runNotifierBuildOverride, Regresion2959 Function()? create}) +final class Regression2959Provider + extends $NotifierProvider { + const Regression2959Provider._( + {super.runNotifierBuildOverride, Regression2959 Function()? create}) : _createCb = create, super( from: null, argument: null, retry: null, - name: r'regresion2959Provider', + name: r'regression2959Provider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); - final Regresion2959 Function()? _createCb; + final Regression2959 Function()? _createCb; @override - String debugGetCreateSourceHash() => _$regresion2959Hash(); + String debugGetCreateSourceHash() => _$regression2959Hash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(void value) { @@ -393,37 +393,37 @@ final class Regresion2959Provider @$internal @override - Regresion2959 create() => _createCb?.call() ?? Regresion2959(); + Regression2959 create() => _createCb?.call() ?? Regression2959(); @$internal @override - Regresion2959Provider $copyWithCreate( - Regresion2959 Function() create, + Regression2959Provider $copyWithCreate( + Regression2959 Function() create, ) { - return Regresion2959Provider._(create: create); + return Regression2959Provider._(create: create); } @$internal @override - Regresion2959Provider $copyWithBuild( + Regression2959Provider $copyWithBuild( void Function( Ref, - Regresion2959, + Regression2959, ) build, ) { - return Regresion2959Provider._(runNotifierBuildOverride: build); + return Regression2959Provider._(runNotifierBuildOverride: build); } @$internal @override - $NotifierProviderElement $createElement( + $NotifierProviderElement $createElement( $ProviderPointer pointer) => $NotifierProviderElement(this, pointer); } -String _$regresion2959Hash() => r'bcf9a829ce75026a78569de680451d157c7d90a2'; +String _$regression2959Hash() => r'e58855125577a855d642da1ef85f35178ad95afd'; -abstract class _$Regresion2959 extends $Notifier { +abstract class _$Regression2959 extends $Notifier { void build(); @$internal @override @@ -431,4 +431,4 @@ abstract class _$Regresion2959 extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index 8c6ea6c4a..f8498e21c 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -168,4 +168,4 @@ abstract class _$GeneratedNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/failing_functional_ref.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/failing_functional_ref.dart index 984c3acf7..393aba95d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/failing_functional_ref.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/failing_functional_ref.dart @@ -20,3 +20,6 @@ int incorrectlyTyped( int noRefButArgs({int a = 42}) { return 0; } + +@riverpod +int valid(Ref ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.dart new file mode 100644 index 000000000..f9da55bfe --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.dart @@ -0,0 +1,17 @@ +// ignore_for_file: deprecated_member_use_from_same_package +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'auto_import.g.dart'; + +// No riverpod imported. Should add it automatically +@riverpod +// expect_lint: functional_ref +int example(ExampleRef ref) => 0; + +@riverpod +// expect_lint: functional_ref +int empty() => 0; + +@riverpod +// expect_lint: functional_ref +int untyped(ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.diff b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.diff new file mode 100644 index 000000000..8467bc041 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.diff @@ -0,0 +1,100 @@ +Message: `Type as Ref` +Priority: 90 +Diff for file `test/lints/functional_ref/fix/auto_import.dart:2`: +``` +// ignore_for_file: deprecated_member_use_from_same_package +- import 'package:riverpod_annotation/riverpod_annotation.dart'; +- +- part 'auto_import.g.dart'; +- +- // No riverpod imported. Should add it automatically +- @riverpod +- // expect_lint: functional_ref +- int example(ExampleRef ref) => 0; ++ import 'package:riverpod/riverpod.dart'; ++ import 'package:riverpod_annotation/riverpod_annotation.dart'; ++ ++ part 'auto_import.g.dart'; ++ ++ // No riverpod imported. Should add it automatically ++ @riverpod ++ // expect_lint: functional_ref ++ int example(Ref ref) => 0; + +@riverpod +``` +--- +Message: `Add ref parameter` +Priority: 90 +Diff for file `test/lints/functional_ref/fix/auto_import.dart:2`: +``` +// ignore_for_file: deprecated_member_use_from_same_package +- import 'package:riverpod_annotation/riverpod_annotation.dart'; +- +- part 'auto_import.g.dart'; +- +- // No riverpod imported. Should add it automatically +- @riverpod +- // expect_lint: functional_ref +- int example(ExampleRef ref) => 0; +- +- @riverpod +- // expect_lint: functional_ref +- int empty() => 0; ++ import 'package:riverpod/riverpod.dart'; ++ import 'package:riverpod_annotation/riverpod_annotation.dart'; ++ ++ part 'auto_import.g.dart'; ++ ++ // No riverpod imported. Should add it automatically ++ @riverpod ++ // expect_lint: functional_ref ++ int example(ExampleRef ref) => 0; ++ ++ @riverpod ++ // expect_lint: functional_ref ++ int empty(Ref ref) => 0; + +@riverpod +``` +--- +Message: `Type as Ref` +Priority: 90 +Diff for file `test/lints/functional_ref/fix/auto_import.dart:2`: +``` +// ignore_for_file: deprecated_member_use_from_same_package +- import 'package:riverpod_annotation/riverpod_annotation.dart'; +- +- part 'auto_import.g.dart'; +- +- // No riverpod imported. Should add it automatically +- @riverpod +- // expect_lint: functional_ref +- int example(ExampleRef ref) => 0; +- +- @riverpod +- // expect_lint: functional_ref +- int empty() => 0; +- +- @riverpod +- // expect_lint: functional_ref +- int untyped(ref) => 0; ++ import 'package:riverpod/riverpod.dart'; ++ import 'package:riverpod_annotation/riverpod_annotation.dart'; ++ ++ part 'auto_import.g.dart'; ++ ++ // No riverpod imported. Should add it automatically ++ @riverpod ++ // expect_lint: functional_ref ++ int example(ExampleRef ref) => 0; ++ ++ @riverpod ++ // expect_lint: functional_ref ++ int empty() => 0; ++ ++ @riverpod ++ // expect_lint: functional_ref ++ int untyped(Ref ref) => 0; +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.g.dart new file mode 100644 index 000000000..fca00e4f6 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.g.dart @@ -0,0 +1,190 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'auto_import.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + int create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'638d7db2be22eaad0f51ea0b3ae38e0483d43725'; + +typedef EmptyRef = Ref; + +@ProviderFor(empty) +const emptyProvider = EmptyProvider._(); + +final class EmptyProvider extends $FunctionalProvider + with $Provider { + const EmptyProvider._( + {int Function( + EmptyRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'emptyProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + EmptyRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$emptyHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + EmptyProvider $copyWithCreate( + int Function( + EmptyRef ref, + ) create, + ) { + return EmptyProvider._(create: create); + } + + @override + int create(EmptyRef ref) { + final _$cb = _createCb ?? empty; + return _$cb(ref); + } +} + +String _$emptyHash() => r'eaec2981c894019fafd068e09478ffe961a8d188'; + +typedef UntypedRef = Ref; + +@ProviderFor(untyped) +const untypedProvider = UntypedProvider._(); + +final class UntypedProvider extends $FunctionalProvider + with $Provider { + const UntypedProvider._( + {int Function( + UntypedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'untypedProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + UntypedRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$untypedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + UntypedProvider $copyWithCreate( + int Function( + UntypedRef ref, + ) create, + ) { + return UntypedProvider._(create: create); + } + + @override + int create(UntypedRef ref) { + final _$cb = _createCb ?? untyped; + return _$cb(ref); + } +} + +String _$untypedHash() => r'5dd4815f63ed35a15a2e027b4e0cb496693f07f4'; + +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/failing_functional_ref.diff b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/failing_functional_ref.diff new file mode 100644 index 000000000..474f8d630 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/failing_functional_ref.diff @@ -0,0 +1,36 @@ +Message: `Add ref parameter` +Priority: 90 +Diff for file `test/lints/functional_ref/failing_functional_ref.dart:6`: +``` +@riverpod +// expect_lint: functional_ref +- int refless() { ++ int refless(Ref ref) { + return 0; +} +``` +--- +Message: `Type as Ref` +Priority: 90 +Diff for file `test/lints/functional_ref/failing_functional_ref.dart:13`: +``` +int incorrectlyTyped( + // expect_lint: functional_ref +- int ref, ++ Ref ref, +) { + return 0; +``` +--- +Message: `Add ref parameter` +Priority: 90 +Diff for file `test/lints/functional_ref/failing_functional_ref.dart:21`: +``` +@riverpod +// expect_lint: functional_ref +- int noRefButArgs({int a = 42}) { ++ int noRefButArgs(Ref ref, {int a = 42}) { + return 0; +} +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref.diff b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref.diff new file mode 100644 index 000000000..5dcd029ad --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref.diff @@ -0,0 +1,20 @@ +Message: `Type as Ref` +Priority: 90 +Diff for file `test/lints/functional_ref/functional_ref.dart:10`: +``` +int nameless( + // expect_lint: functional_ref +- ref, ++ Ref ref, +) { + return 0; +``` +--- +Message: `Type as Ref` +Priority: 90 +Diff for file `test/lints/functional_ref/functional_ref.dart:20`: +``` +@riverpod +int valid(Ref ref) => 0; +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref_test.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref_test.dart new file mode 100644 index 000000000..fa8f0aa18 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref_test.dart @@ -0,0 +1,78 @@ +import 'package:collection/collection.dart'; +import 'package:riverpod_lint/src/lints/functional_ref.dart'; + +import '../../../test_lint.dart'; + +void main() { + testGolden( + 'Verify that @riverpod functions have a Ref', + 'test/lints/functional_ref/fix/functional_ref.diff', + sourcePath: 'test/lints/functional_ref/functional_ref.dart', + (result, helper) async { + const lint = FunctionalRef(); + final fix = lint.getFixes().single; + + final errors = await lint.testRun(result); + + final changes = await Future.wait([ + for (final error in errors) fix.testRun(result, error, errors), + ]); + + return changes.flattened; + }, + ); + + testGolden( + 'Verify that @riverpod functions have a Ref', + 'test/lints/functional_ref/fix/failing_functional_ref.diff', + sourcePath: 'test/lints/functional_ref/failing_functional_ref.dart', + (result, helper) async { + const lint = FunctionalRef(); + final fix = lint.getFixes().single; + + final errors = await lint.testRun(result); + + final changes = await Future.wait([ + for (final error in errors) fix.testRun(result, error, errors), + ]); + + return changes.flattened; + }, + ); + + testGolden( + 'The Ref fix should add imports', + 'test/lints/functional_ref/fix/auto_import.diff', + sourcePath: 'test/lints/functional_ref/fix/auto_import.dart', + (result, helper) async { + const lint = FunctionalRef(); + final fix = lint.getFixes().single; + + final errors = await lint.testRun(result); + + final changes = await Future.wait([ + for (final error in errors) fix.testRun(result, error, errors), + ]); + + return changes.flattened; + }, + ); + + testGolden( + 'Supports prefixes', + 'test/lints/functional_ref/fix/use_prefix.diff', + sourcePath: 'test/lints/functional_ref/fix/use_prefix.dart', + (result, helper) async { + const lint = FunctionalRef(); + final fix = lint.getFixes().single; + + final errors = await lint.testRun(result); + + final changes = await Future.wait([ + for (final error in errors) fix.testRun(result, error, errors), + ]); + + return changes.flattened; + }, + ); +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.dart new file mode 100644 index 000000000..da23acc3e --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.dart @@ -0,0 +1,19 @@ +// ignore_for_file: deprecated_member_use_from_same_package +// ignore: unused_import, used for the fix +import 'package:riverpod/riverpod.dart' as prefix; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'use_prefix.g.dart'; + +// No riverpod imported. Should add it automatically +@riverpod +// expect_lint: functional_ref +int example(ExampleRef ref) => 0; + +@riverpod +// expect_lint: functional_ref +int empty() => 0; + +@riverpod +// expect_lint: functional_ref +int untyped(ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.diff b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.diff new file mode 100644 index 000000000..c403a677f --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.diff @@ -0,0 +1,34 @@ +Message: `Type as Ref` +Priority: 90 +Diff for file `test/lints/functional_ref/fix/use_prefix.dart:11`: +``` +@riverpod +// expect_lint: functional_ref +- int example(ExampleRef ref) => 0; ++ int example(prefix.Ref ref) => 0; + +@riverpod +``` +--- +Message: `Add ref parameter` +Priority: 90 +Diff for file `test/lints/functional_ref/fix/use_prefix.dart:15`: +``` +@riverpod +// expect_lint: functional_ref +- int empty() => 0; ++ int empty(prefix.Ref ref) => 0; + +@riverpod +``` +--- +Message: `Type as Ref` +Priority: 90 +Diff for file `test/lints/functional_ref/fix/use_prefix.dart:19`: +``` +@riverpod +// expect_lint: functional_ref +- int untyped(ref) => 0; ++ int untyped(prefix.Ref ref) => 0; +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.g.dart new file mode 100644 index 000000000..7d5bbd75c --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.g.dart @@ -0,0 +1,190 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'use_prefix.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +typedef ExampleRef = Ref; + +@ProviderFor(example) +const exampleProvider = ExampleProvider._(); + +final class ExampleProvider extends $FunctionalProvider + with $Provider { + const ExampleProvider._( + {int Function( + ExampleRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'exampleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + ExampleRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$exampleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + ExampleProvider $copyWithCreate( + int Function( + ExampleRef ref, + ) create, + ) { + return ExampleProvider._(create: create); + } + + @override + int create(ExampleRef ref) { + final _$cb = _createCb ?? example; + return _$cb(ref); + } +} + +String _$exampleHash() => r'638d7db2be22eaad0f51ea0b3ae38e0483d43725'; + +typedef EmptyRef = Ref; + +@ProviderFor(empty) +const emptyProvider = EmptyProvider._(); + +final class EmptyProvider extends $FunctionalProvider + with $Provider { + const EmptyProvider._( + {int Function( + EmptyRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'emptyProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + EmptyRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$emptyHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + EmptyProvider $copyWithCreate( + int Function( + EmptyRef ref, + ) create, + ) { + return EmptyProvider._(create: create); + } + + @override + int create(EmptyRef ref) { + final _$cb = _createCb ?? empty; + return _$cb(ref); + } +} + +String _$emptyHash() => r'eaec2981c894019fafd068e09478ffe961a8d188'; + +typedef UntypedRef = Ref; + +@ProviderFor(untyped) +const untypedProvider = UntypedProvider._(); + +final class UntypedProvider extends $FunctionalProvider + with $Provider { + const UntypedProvider._( + {int Function( + UntypedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'untypedProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + UntypedRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$untypedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + UntypedProvider $copyWithCreate( + int Function( + UntypedRef ref, + ) create, + ) { + return UntypedProvider._(create: create); + } + + @override + int create(UntypedRef ref) { + final _$cb = _createCb ?? untyped; + return _$cb(ref); + } +} + +String _$untypedHash() => r'5dd4815f63ed35a15a2e027b4e0cb496693f07f4'; + +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.dart index b2f16d752..351164386 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.dart @@ -11,16 +11,7 @@ int nameless( } @riverpod -int generics(GenericsRef ref) => 0; +int generics(Ref ref) => 0; @riverpod -// expect_lint: functional_ref -int noGenerics(NoGenericsRef ref) => 0; - -@riverpod -// expect_lint: functional_ref -int missingGenerics(MissingGenericsRef ref) => 0; - -@riverpod -// expect_lint: functional_ref -int wrongOrder(WrongOrderRef ref) => 0; +int valid(Ref ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 700e79762..57bc20ffe 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -154,7 +154,7 @@ final class GenericsProvider } } -String _$genericsHash() => r'b5813cf6a00581bafea48d8ab66f7d5468fff0e4'; +String _$genericsHash() => r'dddbd6460e73b1f20343bbadee6666311c5ac0ea'; final class GenericsFamily extends Family { const GenericsFamily._() @@ -190,297 +190,34 @@ final class GenericsFamily extends Family { } } -typedef NoGenericsRef = Ref; +typedef ValidRef = Ref; -@ProviderFor(noGenerics) -const noGenericsProvider = NoGenericsFamily._(); +@ProviderFor(valid) +const validProvider = ValidProvider._(); -final class NoGenericsProvider - extends $FunctionalProvider - with $Provider> { - const NoGenericsProvider._( - {required NoGenericsFamily super.from, - int Function( - NoGenericsRef ref, - )? create}) - : _createCb = create, - super( - argument: null, - retry: null, - name: r'noGenericsProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - NoGenericsRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$noGenericsHash(); - - NoGenericsProvider _copyWithCreate( - int Function( - NoGenericsRef ref, - ) create, - ) { - return NoGenericsProvider._( - from: from! as NoGenericsFamily, create: create); - } - - @override - String toString() { - return r'noGenericsProvider' - '<${A}, ${B}>' - '()'; - } - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - NoGenericsProvider $copyWithCreate( - int Function( - NoGenericsRef ref, - ) create, - ) { - return NoGenericsProvider._( - from: from! as NoGenericsFamily, create: create); - } - - @override - int create(NoGenericsRef ref) { - final _$cb = _createCb ?? noGenerics; - return _$cb(ref); - } - - @override - bool operator ==(Object other) { - return other is NoGenericsProvider && - other.runtimeType == runtimeType && - other.argument == argument; - } - - @override - int get hashCode { - return Object.hash(runtimeType, argument); - } -} - -String _$noGenericsHash() => r'449264e25990bc14ad811c0940117c8cde4d730a'; - -final class NoGenericsFamily extends Family { - const NoGenericsFamily._() - : super( - retry: null, - name: r'noGenericsProvider', - dependencies: null, - allTransitiveDependencies: null, - isAutoDispose: true, - ); - - NoGenericsProvider call() => - NoGenericsProvider._(from: this); - - @override - String debugGetCreateSourceHash() => _$noGenericsHash(); - - @override - String toString() => r'noGenericsProvider'; - - /// {@macro riverpod.override_with} - Override overrideWith( - int Function(NoGenericsRef ref) create, - ) { - return $FamilyOverride( - from: this, - createElement: (pointer) { - final provider = pointer.origin as NoGenericsProvider; - - return provider._copyWithCreate(create).$createElement(pointer); - }, - ); - } -} - -typedef MissingGenericsRef = Ref; - -@ProviderFor(missingGenerics) -const missingGenericsProvider = MissingGenericsFamily._(); - -final class MissingGenericsProvider extends $FunctionalProvider - with $Provider> { - const MissingGenericsProvider._( - {required MissingGenericsFamily super.from, - int Function( - MissingGenericsRef ref, - )? create}) - : _createCb = create, - super( - argument: null, - retry: null, - name: r'missingGenericsProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - MissingGenericsRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$missingGenericsHash(); - - MissingGenericsProvider _copyWithCreate( - int Function( - MissingGenericsRef ref, - ) create, - ) { - return MissingGenericsProvider._( - from: from! as MissingGenericsFamily, create: create); - } - - @override - String toString() { - return r'missingGenericsProvider' - '<${A}, ${B}>' - '()'; - } - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - MissingGenericsProvider $copyWithCreate( - int Function( - MissingGenericsRef ref, - ) create, - ) { - return MissingGenericsProvider._( - from: from! as MissingGenericsFamily, create: create); - } - - @override - int create(MissingGenericsRef ref) { - final _$cb = _createCb ?? missingGenerics; - return _$cb(ref); - } - - @override - bool operator ==(Object other) { - return other is MissingGenericsProvider && - other.runtimeType == runtimeType && - other.argument == argument; - } - - @override - int get hashCode { - return Object.hash(runtimeType, argument); - } -} - -String _$missingGenericsHash() => r'7d8bc49e4f1e466260fbf6a61a3f9e62b4aef28f'; - -final class MissingGenericsFamily extends Family { - const MissingGenericsFamily._() - : super( - retry: null, - name: r'missingGenericsProvider', - dependencies: null, - allTransitiveDependencies: null, - isAutoDispose: true, - ); - - MissingGenericsProvider call() => - MissingGenericsProvider._(from: this); - - @override - String debugGetCreateSourceHash() => _$missingGenericsHash(); - - @override - String toString() => r'missingGenericsProvider'; - - /// {@macro riverpod.override_with} - Override overrideWith( - int Function(MissingGenericsRef ref) create, - ) { - return $FamilyOverride( - from: this, - createElement: (pointer) { - final provider = pointer.origin as MissingGenericsProvider; - - return provider._copyWithCreate(create).$createElement(pointer); - }, - ); - } -} - -typedef WrongOrderRef = Ref; - -@ProviderFor(wrongOrder) -const wrongOrderProvider = WrongOrderFamily._(); - -final class WrongOrderProvider extends $FunctionalProvider - with $Provider> { - const WrongOrderProvider._( - {required WrongOrderFamily super.from, - int Function( - WrongOrderRef ref, +final class ValidProvider extends $FunctionalProvider + with $Provider { + const ValidProvider._( + {int Function( + ValidRef ref, )? create}) : _createCb = create, super( + from: null, argument: null, retry: null, - name: r'wrongOrderProvider', + name: r'validProvider', isAutoDispose: true, dependencies: null, allTransitiveDependencies: null, ); final int Function( - WrongOrderRef ref, + ValidRef ref, )? _createCb; @override - String debugGetCreateSourceHash() => _$wrongOrderHash(); - - WrongOrderProvider _copyWithCreate( - int Function( - WrongOrderRef ref, - ) create, - ) { - return WrongOrderProvider._( - from: from! as WrongOrderFamily, create: create); - } - - @override - String toString() { - return r'wrongOrderProvider' - '<${B}, ${A}>' - '()'; - } + String debugGetCreateSourceHash() => _$validHash(); /// {@macro riverpod.override_with_value} Override overrideWithValue(int value) { @@ -496,68 +233,22 @@ final class WrongOrderProvider extends $FunctionalProvider $ProviderElement(this, pointer); @override - WrongOrderProvider $copyWithCreate( + ValidProvider $copyWithCreate( int Function( - WrongOrderRef ref, + ValidRef ref, ) create, ) { - return WrongOrderProvider._( - from: from! as WrongOrderFamily, create: create); + return ValidProvider._(create: create); } @override - int create(WrongOrderRef ref) { - final _$cb = _createCb ?? wrongOrder; + int create(ValidRef ref) { + final _$cb = _createCb ?? valid; return _$cb(ref); } - - @override - bool operator ==(Object other) { - return other is WrongOrderProvider && - other.runtimeType == runtimeType && - other.argument == argument; - } - - @override - int get hashCode { - return Object.hash(runtimeType, argument); - } } -String _$wrongOrderHash() => r'6732863e85b220c07f82c2d13be15c1e6f08192d'; - -final class WrongOrderFamily extends Family { - const WrongOrderFamily._() - : super( - retry: null, - name: r'wrongOrderProvider', - dependencies: null, - allTransitiveDependencies: null, - isAutoDispose: true, - ); - - WrongOrderProvider call() => - WrongOrderProvider._(from: this); - - @override - String debugGetCreateSourceHash() => _$wrongOrderHash(); - - @override - String toString() => r'wrongOrderProvider'; - - /// {@macro riverpod.override_with} - Override overrideWith( - int Function(WrongOrderRef ref) create, - ) { - return $FamilyOverride( - from: this, - createElement: (pointer) { - final provider = pointer.origin as WrongOrderProvider; +String _$validHash() => r'f33913278e3b1615927fe05b3e6e1f781da7729a'; - return provider._copyWithCreate(create).$createElement(pointer); - }, - ); - } -} // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md index 3a90d2915..36544c25b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md @@ -1,10 +1,10 @@ code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:12:3 +test/lints/avoid_build_context_in_providers.dart:13:3 ```dart - FnRef ref, + Ref ref, // expect_lint: avoid_build_context_in_providers >>>BuildContext context1<<<, { // expect_lint: avoid_build_context_in_providers @@ -16,7 +16,7 @@ test/lints/avoid_build_context_in_providers.dart:12:3 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:14:3 +test/lints/avoid_build_context_in_providers.dart:15:3 ```dart BuildContext context1, { @@ -31,7 +31,7 @@ test/lints/avoid_build_context_in_providers.dart:14:3 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:22:5 +test/lints/avoid_build_context_in_providers.dart:23:5 ```dart int build( @@ -46,7 +46,7 @@ test/lints/avoid_build_context_in_providers.dart:22:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:24:5 +test/lints/avoid_build_context_in_providers.dart:25:5 ```dart BuildContext context1, { @@ -61,7 +61,7 @@ test/lints/avoid_build_context_in_providers.dart:24:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:30:5 +test/lints/avoid_build_context_in_providers.dart:31:5 ```dart void event( @@ -76,7 +76,7 @@ test/lints/avoid_build_context_in_providers.dart:30:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:32:5 +test/lints/avoid_build_context_in_providers.dart:33:5 ```dart BuildContext context3, { diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_fix.diff index 9ddd8c001..474f8d630 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_fix.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_fix.diff @@ -1,24 +1,36 @@ Message: `Add ref parameter` Priority: 90 -Diff for file `test/lints/functional_ref/failing_functional_ref.dart:5`: +Diff for file `test/lints/functional_ref/failing_functional_ref.dart:6`: ``` @riverpod // expect_lint: functional_ref - int refless() { -+ int refless(ReflessRef ref) { ++ int refless(Ref ref) { return 0; } ``` --- -Message: `Type as IncorrectlyTypedRef` +Message: `Type as Ref` Priority: 90 -Diff for file `test/lints/functional_ref/failing_functional_ref.dart:12`: +Diff for file `test/lints/functional_ref/failing_functional_ref.dart:13`: ``` int incorrectlyTyped( // expect_lint: functional_ref - int ref, -+ IncorrectlyTypedRef ref, ++ Ref ref, ) { return 0; ``` --- +Message: `Add ref parameter` +Priority: 90 +Diff for file `test/lints/functional_ref/failing_functional_ref.dart:21`: +``` +@riverpod +// expect_lint: functional_ref +- int noRefButArgs({int a = 42}) { ++ int noRefButArgs(Ref ref, {int a = 42}) { + return 0; +} +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_lint.md index 5cd4da160..2f4399048 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_lint.md @@ -1,7 +1,7 @@ code: functional_ref severity: Severity.warning message: Functional providers must receive a ref matching the provider name as their first positional parameter. -test/lints/functional_ref/failing_functional_ref.dart:5:5 +test/lints/functional_ref/failing_functional_ref.dart:6:5 ```dart @riverpod @@ -16,7 +16,7 @@ int >>>refless<<<() { code: functional_ref severity: Severity.warning message: Functional providers must receive a ref matching the provider name as their first positional parameter. -test/lints/functional_ref/failing_functional_ref.dart:12:3 +test/lints/functional_ref/failing_functional_ref.dart:13:3 ```dart int incorrectlyTyped( @@ -31,7 +31,7 @@ int incorrectlyTyped( code: functional_ref severity: Severity.warning message: Functional providers must receive a ref matching the provider name as their first positional parameter. -test/lints/functional_ref/failing_functional_ref.dart:20:23 +test/lints/functional_ref/failing_functional_ref.dart:21:23 ```dart @riverpod diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff index b3dab2390..5dcd029ad 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff @@ -1,46 +1,20 @@ -Message: `Type as NamelessRef` +Message: `Type as Ref` Priority: 90 -Diff for file `test/lints/functional_ref/functional_ref.dart:8`: +Diff for file `test/lints/functional_ref/functional_ref.dart:10`: ``` int nameless( // expect_lint: functional_ref - ref, -+ NamelessRef ref, ++ Ref ref, ) { return 0; ``` --- -Message: `Type as NoGenericsRef` +Message: `Type as Ref` Priority: 90 -Diff for file `test/lints/functional_ref/functional_ref.dart:18`: +Diff for file `test/lints/functional_ref/functional_ref.dart:20`: ``` @riverpod -// expect_lint: functional_ref -- int noGenerics(NoGenericsRef ref) => 0; -+ int noGenerics(NoGenericsRef ref) => 0; - -@riverpod -``` ---- -Message: `Type as MissingGenericsRef` -Priority: 90 -Diff for file `test/lints/functional_ref/functional_ref.dart:22`: -``` -@riverpod -// expect_lint: functional_ref -- int missingGenerics(MissingGenericsRef ref) => 0; -+ int missingGenerics(MissingGenericsRef ref) => 0; - -@riverpod -``` ---- -Message: `Type as WrongOrderRef` -Priority: 90 -Diff for file `test/lints/functional_ref/functional_ref.dart:26`: -``` -@riverpod -// expect_lint: functional_ref -- int wrongOrder(WrongOrderRef ref) => 0; -+ int wrongOrder(WrongOrderRef ref) => 0; +int valid(Ref ref) => 0; ``` --- diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md index 941197123..e8a8c25c0 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md @@ -1,7 +1,7 @@ code: functional_ref severity: Severity.warning message: Functional providers must receive a ref matching the provider name as their first positional parameter. -test/lints/functional_ref/functional_ref.dart:8:3 +test/lints/functional_ref/functional_ref.dart:10:3 ```dart int nameless( @@ -16,40 +16,12 @@ int nameless( code: functional_ref severity: Severity.warning message: Functional providers must receive a ref matching the provider name as their first positional parameter. -test/lints/functional_ref/functional_ref.dart:18:34 +test/lints/functional_ref/functional_ref.dart:16:32 ```dart -@riverpod -// expect_lint: functional_ref -int noGenerics(>>>NoGenericsRef<<< ref) => 0; - -@riverpod -``` - -======= -code: functional_ref -severity: Severity.warning -message: Functional providers must receive a ref matching the provider name as their first positional parameter. -test/lints/functional_ref/functional_ref.dart:22:27 - -```dart @riverpod -// expect_lint: functional_ref -int missingGenerics(>>>MissingGenericsRef<<< ref) => 0; +int generics(>>>Ref<<< ref) => 0; @riverpod ``` - -======= - -code: functional_ref -severity: Severity.warning -message: Functional providers must receive a ref matching the provider name as their first positional parameter. -test/lints/functional_ref/functional_ref.dart:26:22 - -```dart -@riverpod -// expect_lint: functional_ref -int wrongOrder(>>>WrongOrderRef<<< ref) => 0; -``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/only_use_keep_alive_inside_keep_alive/only_use_keep_alive_inside_keep_alive_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/only_use_keep_alive_inside_keep_alive/only_use_keep_alive_inside_keep_alive_lint.md index 173c5cc9a..b69c47fc2 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/only_use_keep_alive_inside_keep_alive/only_use_keep_alive_inside_keep_alive_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/only_use_keep_alive_inside_keep_alive/only_use_keep_alive_inside_keep_alive_lint.md @@ -2,7 +2,7 @@ code: only_use_keep_alive_inside_keep_alive severity: Severity.warning correctionMessage: Either stop marking this provider as `keepAlive` or remove `keepAlive` from the used provider. message: If a provider is declared as `keepAlive`, it can only use providers that are also declared as `keepAlive. -test/lints/only_use_keep_alive_inside_keep_alive.dart:27:3 +test/lints/only_use_keep_alive_inside_keep_alive.dart:28:3 ```dart @@ -18,7 +18,7 @@ code: only_use_keep_alive_inside_keep_alive severity: Severity.warning correctionMessage: Either stop marking this provider as `keepAlive` or remove `keepAlive` from the used provider. message: If a provider is declared as `keepAlive`, it can only use providers that are also declared as `keepAlive. -test/lints/only_use_keep_alive_inside_keep_alive.dart:29:3 +test/lints/only_use_keep_alive_inside_keep_alive.dart:30:3 ```dart ref.watch(autoDisposeProvider); diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_fix.diff index f235d5684..cb059cc5e 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_fix.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_fix.diff @@ -1,30 +1,73 @@ Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:31`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:32`: ``` // expect_lint: provider_dependencies - @riverpod + @Riverpod(dependencies: [generatedScoped]) int watchGeneratedScopedButNoDependencies( - WatchGeneratedScopedButNoDependenciesRef ref, + Ref ref, ``` --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:57`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:60`: ``` // expect_lint: provider_dependencies - @Riverpod(dependencies: []) + @Riverpod(dependencies: [generatedScoped]) int watchGeneratedScopedButEmptyDependencies( - WatchGeneratedScopedButEmptyDependenciesRef ref, + Ref ref, +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:92`: +``` + +// expect_lint: provider_dependencies +- @Riverpod(dependencies: [dep]) ++ @Riverpod(dependencies: [dep, generatedScoped]) +int watchGeneratedScopedButMissingDependencies( + Ref ref, +``` +--- +Message: `Remove "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:123`: +``` +} + +- @Riverpod(dependencies: [ +- // The dependency is redundant because it is not a scoped provider +- // expect_lint: provider_dependencies +- generatedRoot, +- ]) ++ @riverpod +int watchGeneratedRootAndContainsDependency( + Ref ref, +``` +--- +Message: `Update "dependencies"` +Priority: 100 +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:136`: +``` +// A dependency is specified but never used + +- @Riverpod(dependencies: [ +- dep, +- // expect_lint: provider_dependencies +- generatedRoot, ++ @Riverpod(dependencies: [dep]) +int specifiedDependencyButNeverUsed(Ref ref) { + ref.watch(depProvider); ``` --- Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:155`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:218`: ``` class MemberDependencies { // expect_lint: provider_dependencies @@ -36,7 +79,7 @@ class MemberDependencies { --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:163`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:226`: ``` class CanUpdateMultipleDependenciesAtOnce { // expect_lint: provider_dependencies @@ -48,7 +91,7 @@ class CanUpdateMultipleDependenciesAtOnce { --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:160`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:223`: ``` // expect_lint: provider_dependencies @@ -60,7 +103,7 @@ class CanUpdateMultipleDependenciesAtOnce { --- Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:183`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:246`: ``` // Handle identifiers with dependencies // expect_lint: provider_dependencies @@ -72,7 +115,7 @@ void fn() {} --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:187`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:250`: ``` // expect_lint: provider_dependencies @@ -85,19 +128,19 @@ Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:187`: --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:195`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:258`: ``` // expect_lint: provider_dependencies - @riverpod + @Riverpod(dependencies: [dep]) -int foo(FooRef ref) { +int foo(Ref ref) { fn(); ``` --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:212`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:275`: ``` // expect_lint: provider_dependencies @@ -110,7 +153,7 @@ Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:212`: --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:243`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:306`: ``` // expect_lint: provider_dependencies @@ -122,7 +165,7 @@ class Stateful2 extends StatefulWidget { --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:259`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:322`: ``` // expect_lint: provider_dependencies @@ -135,13 +178,13 @@ Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:259`: --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:272`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:335`: ``` // expect_lint: provider_dependencies - @riverpod + @Riverpod(dependencies: [anotherNonEmptyScoped]) -int crossFileDependency(CrossFileDependencyRef ref) { +int crossFileDependency(Ref ref) { ref.watch(anotherNonEmptyScopedProvider); ``` --- diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_lint.md index 47da384f1..7fde3b149 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_lint.md @@ -2,24 +2,24 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: generatedScoped - test/lints/provider_dependencies/missing_dependencies2.dart:35:20 + test/lints/provider_dependencies/missing_dependencies2.dart:36:20 ```dart - WatchGeneratedScopedButNoDependenciesRef ref, + Ref ref, ) { return ref.watch(>>>generatedScopedProvider<<<); } ``` message: Missing dependencies: generatedScoped -test/lints/provider_dependencies/missing_dependencies2.dart:31:1 +test/lints/provider_dependencies/missing_dependencies2.dart:32:1 ```dart // expect_lint: provider_dependencies >>>@riverpod<<< int watchGeneratedScopedButNoDependencies( - WatchGeneratedScopedButNoDependenciesRef ref, + Ref ref, ``` ======= @@ -28,24 +28,88 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: generatedScoped - test/lints/provider_dependencies/missing_dependencies2.dart:61:20 + test/lints/provider_dependencies/missing_dependencies2.dart:64:20 ```dart - WatchGeneratedScopedButEmptyDependenciesRef ref, + Ref ref, ) { return ref.watch(>>>generatedScopedProvider<<<); } ``` message: Missing dependencies: generatedScoped -test/lints/provider_dependencies/missing_dependencies2.dart:57:25 +test/lints/provider_dependencies/missing_dependencies2.dart:60:25 ```dart // expect_lint: provider_dependencies @Riverpod(dependencies: >>>[]<<<) int watchGeneratedScopedButEmptyDependencies( - WatchGeneratedScopedButEmptyDependenciesRef ref, + Ref ref, +``` + +======= + +code: provider_dependencies +severity: Severity.warning +contextMessages: + message: generatedScoped + test/lints/provider_dependencies/missing_dependencies2.dart:97:20 + + ```dart + ) { + ref.watch(depProvider); + return ref.watch(>>>generatedScopedProvider<<<); + } + + ``` +message: Missing dependencies: generatedScoped +test/lints/provider_dependencies/missing_dependencies2.dart:92:25 + +```dart + +// expect_lint: provider_dependencies +@Riverpod(dependencies: >>>[dep]<<<) +int watchGeneratedScopedButMissingDependencies( + Ref ref, +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: generatedRoot +test/lints/provider_dependencies/missing_dependencies2.dart:123:25 + +```dart +} + +@Riverpod(dependencies: >>>[ + // The dependency is redundant because it is not a scoped provider + // expect_lint: provider_dependencies + generatedRoot, +]<<<) +int watchGeneratedRootAndContainsDependency( + Ref ref, +``` + +======= + +code: provider_dependencies +severity: Severity.warning +message: Unused dependencies: generatedRoot +test/lints/provider_dependencies/missing_dependencies2.dart:136:25 + +```dart +// A dependency is specified but never used + +@Riverpod(dependencies: >>>[ + dep, + // expect_lint: provider_dependencies + generatedRoot, +]<<<) +int specifiedDependencyButNeverUsed(Ref ref) { + ref.watch(depProvider); ``` ======= @@ -53,7 +117,7 @@ int watchGeneratedScopedButEmptyDependencies( code: provider_dependencies severity: Severity.warning message: Unused dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:155:17 +test/lints/provider_dependencies/missing_dependencies2.dart:218:17 ```dart class MemberDependencies { @@ -69,7 +133,7 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: dep - test/lints/provider_dependencies/missing_dependencies2.dart:165:15 + test/lints/provider_dependencies/missing_dependencies2.dart:228:15 ```dart @Dependencies([]) @@ -79,7 +143,7 @@ contextMessages: } ``` message: Missing dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:163:17 +test/lints/provider_dependencies/missing_dependencies2.dart:226:17 ```dart class CanUpdateMultipleDependenciesAtOnce { @@ -95,7 +159,7 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: dep - test/lints/provider_dependencies/missing_dependencies2.dart:165:15 + test/lints/provider_dependencies/missing_dependencies2.dart:228:15 ```dart @Dependencies([]) @@ -105,7 +169,7 @@ contextMessages: } ``` message: Missing dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:160:15 +test/lints/provider_dependencies/missing_dependencies2.dart:223:15 ```dart @@ -120,7 +184,7 @@ class CanUpdateMultipleDependenciesAtOnce { code: provider_dependencies severity: Severity.warning message: Unused dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:183:15 +test/lints/provider_dependencies/missing_dependencies2.dart:246:15 ```dart // Handle identifiers with dependencies @@ -136,7 +200,7 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: dep - test/lints/provider_dependencies/missing_dependencies2.dart:188:3 + test/lints/provider_dependencies/missing_dependencies2.dart:251:3 ```dart // expect_lint: provider_dependencies @@ -146,7 +210,7 @@ contextMessages: ``` message: Missing dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:187:1 +test/lints/provider_dependencies/missing_dependencies2.dart:250:1 ```dart @@ -164,23 +228,23 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: dep - test/lints/provider_dependencies/missing_dependencies2.dart:197:3 + test/lints/provider_dependencies/missing_dependencies2.dart:260:3 ```dart @riverpod - int foo(FooRef ref) { + int foo(Ref ref) { >>>fn<<<(); return 0; } ``` message: Missing dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:195:1 +test/lints/provider_dependencies/missing_dependencies2.dart:258:1 ```dart // expect_lint: provider_dependencies >>>@riverpod<<< -int foo(FooRef ref) { +int foo(Ref ref) { fn(); ``` @@ -190,7 +254,7 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: dep - test/lints/provider_dependencies/missing_dependencies2.dart:215:12 + test/lints/provider_dependencies/missing_dependencies2.dart:278:12 ```dart @override @@ -200,7 +264,7 @@ contextMessages: } ``` message: Missing dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:212:1 +test/lints/provider_dependencies/missing_dependencies2.dart:275:1 ```dart @@ -221,7 +285,7 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: dep - test/lints/provider_dependencies/missing_dependencies2.dart:254:12 + test/lints/provider_dependencies/missing_dependencies2.dart:317:12 ```dart @override @@ -231,7 +295,7 @@ contextMessages: } ``` message: Missing dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:243:15 +test/lints/provider_dependencies/missing_dependencies2.dart:306:15 ```dart @@ -247,7 +311,7 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: dep - test/lints/provider_dependencies/missing_dependencies2.dart:268:41 + test/lints/provider_dependencies/missing_dependencies2.dart:331:41 ```dart class _Stateful3State extends State { @@ -257,7 +321,7 @@ contextMessages: ``` message: Missing dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:259:1 +test/lints/provider_dependencies/missing_dependencies2.dart:322:1 ```dart @@ -278,22 +342,22 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: anotherNonEmptyScoped - test/lints/provider_dependencies/missing_dependencies2.dart:274:13 + test/lints/provider_dependencies/missing_dependencies2.dart:337:13 ```dart @riverpod - int crossFileDependency(CrossFileDependencyRef ref) { + int crossFileDependency(Ref ref) { ref.watch(>>>anotherNonEmptyScopedProvider<<<); return 0; } ``` message: Missing dependencies: anotherNonEmptyScoped -test/lints/provider_dependencies/missing_dependencies2.dart:272:1 +test/lints/provider_dependencies/missing_dependencies2.dart:335:1 ```dart // expect_lint: provider_dependencies >>>@riverpod<<< -int crossFileDependency(CrossFileDependencyRef ref) { +int crossFileDependency(Ref ref) { ref.watch(anotherNonEmptyScopedProvider); ``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_fix.diff index bcee91f6b..78d2d523c 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_fix.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_fix.diff @@ -42,7 +42,7 @@ Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:77`: // expect_lint: provider_dependencies - @riverpod + @Riverpod(dependencies: [dep]) -int plainAnnotation(PlainAnnotationRef ref) { +int plainAnnotation(Ref ref) { ref.watch(depProvider); ``` --- @@ -54,7 +54,7 @@ Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:84`: // expect_lint: provider_dependencies - @Riverpod(keepAlive: false) + @Riverpod(keepAlive: false, dependencies: [dep]) -int customAnnotation(CustomAnnotationRef ref) { +int customAnnotation(Ref ref) { ref.watch(depProvider); ``` --- @@ -79,7 +79,7 @@ Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:104`: - dependencies: [], + dependencies: [dep], ) -int existingDep(ExistingDepRef ref) { +int existingDep(Ref ref) { ``` --- Message: `Update "dependencies"` @@ -91,7 +91,7 @@ Diff for file `test/lints/provider_dependencies/missing_dependencies.dart:114`: - dependencies: [], + dependencies: [dep, dep2], ) -int multipleDeps(MultipleDepsRef ref) { +int multipleDeps(Ref ref) { ``` --- Message: `Specify "dependencies"` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_lint.md index 37698ae8a..2ca7be720 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies_lint.md @@ -51,7 +51,7 @@ contextMessages: ```dart @riverpod - int plainAnnotation(PlainAnnotationRef ref) { + int plainAnnotation(Ref ref) { ref.watch(>>>depProvider<<<); return 0; } @@ -63,7 +63,7 @@ test/lints/provider_dependencies/missing_dependencies.dart:77:1 // expect_lint: provider_dependencies >>>@riverpod<<< -int plainAnnotation(PlainAnnotationRef ref) { +int plainAnnotation(Ref ref) { ref.watch(depProvider); ``` @@ -77,7 +77,7 @@ contextMessages: ```dart @Riverpod(keepAlive: false) - int customAnnotation(CustomAnnotationRef ref) { + int customAnnotation(Ref ref) { ref.watch(>>>depProvider<<<); return 0; } @@ -89,7 +89,7 @@ test/lints/provider_dependencies/missing_dependencies.dart:84:1 // expect_lint: provider_dependencies >>>@Riverpod(keepAlive: false)<<< -int customAnnotation(CustomAnnotationRef ref) { +int customAnnotation(Ref ref) { ref.watch(depProvider); ``` @@ -102,7 +102,7 @@ contextMessages: test/lints/provider_dependencies/missing_dependencies.dart:97:13 ```dart - CustomAnnotationWithTrailingCommaRef ref, + Ref ref, ) { ref.watch(>>>depProvider<<<); return 0; @@ -118,7 +118,7 @@ test/lints/provider_dependencies/missing_dependencies.dart:91:1 keepAlive: false, )<<< int customAnnotationWithTrailingComma( - CustomAnnotationWithTrailingCommaRef ref, + Ref ref, ``` ======= @@ -131,7 +131,7 @@ contextMessages: ```dart ) - int existingDep(ExistingDepRef ref) { + int existingDep(Ref ref) { ref.watch(>>>depProvider<<<); return 0; } @@ -144,7 +144,7 @@ test/lints/provider_dependencies/missing_dependencies.dart:104:17 // expect_lint: provider_dependencies dependencies: >>>[]<<<, ) -int existingDep(ExistingDepRef ref) { +int existingDep(Ref ref) { ``` ======= @@ -157,7 +157,7 @@ contextMessages: ```dart ) - int multipleDeps(MultipleDepsRef ref) { + int multipleDeps(Ref ref) { ref.watch(>>>depProvider<<<); ref.watch(dep2Provider); return 0; @@ -167,7 +167,7 @@ contextMessages: test/lints/provider_dependencies/missing_dependencies.dart:118:13 ```dart - int multipleDeps(MultipleDepsRef ref) { + int multipleDeps(Ref ref) { ref.watch(depProvider); ref.watch(>>>dep2Provider<<<); return 0; @@ -181,7 +181,7 @@ test/lints/provider_dependencies/missing_dependencies.dart:114:17 // expect_lint: provider_dependencies dependencies: >>>[]<<<, ) -int multipleDeps(MultipleDepsRef ref) { +int multipleDeps(Ref ref) { ``` ======= diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/unsupported_provider_value/unsupported_provider_value_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/unsupported_provider_value/unsupported_provider_value_lint.md index 0abe96313..52e37eb86 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/unsupported_provider_value/unsupported_provider_value_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/unsupported_provider_value/unsupported_provider_value_lint.md @@ -7,7 +7,7 @@ test/lints/unsupported_provider_value.dart:13:17 ```dart @riverpod // expect_lint: unsupported_provider_value -MyStateNotifier >>>stateNotifier<<<(StateNotifierRef ref) => MyStateNotifier(); +MyStateNotifier >>>stateNotifier<<<(Ref ref) => MyStateNotifier(); @riverpod ``` @@ -23,7 +23,7 @@ test/lints/unsupported_provider_value.dart:17:25 ```dart @riverpod // expect_lint: unsupported_provider_value -Future >>>asyncStateNotifier<<<(AsyncStateNotifierRef ref) async { +Future >>>asyncStateNotifier<<<(Ref ref) async { return MyStateNotifier(); } ``` @@ -55,9 +55,9 @@ test/lints/unsupported_provider_value.dart:29:25 ```dart @riverpod // expect_lint: unsupported_provider_value -Future >>>stateNotifierAsync<<<(StateNotifierAsyncRef ref) async => - MyStateNotifier(); +Future >>>stateNotifierAsync<<<(Ref ref) async => MyStateNotifier(); +// Regression tests for https://github.com/rrousselGit/riverpod/issues/2302 ``` ======= @@ -66,7 +66,7 @@ code: unsupported_provider_value severity: Severity.info correctionMessage: If using StateNotifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. message: The riverpod_generator package does not support StateNotifier values. -test/lints/unsupported_provider_value.dart:52:7 +test/lints/unsupported_provider_value.dart:51:7 ```dart @riverpod @@ -82,12 +82,12 @@ code: unsupported_provider_value severity: Severity.info correctionMessage: If using ChangeNotifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. message: The riverpod_generator package does not support ChangeNotifier values. -test/lints/unsupported_provider_value.dart:62:18 +test/lints/unsupported_provider_value.dart:61:18 ```dart @riverpod // expect_lint: unsupported_provider_value -MyChangeNotifier >>>changeNotifier<<<(ChangeNotifierRef ref) => MyChangeNotifier(); +MyChangeNotifier >>>changeNotifier<<<(Ref ref) => MyChangeNotifier(); @riverpod ``` @@ -98,7 +98,7 @@ code: unsupported_provider_value severity: Severity.info correctionMessage: If using ChangeNotifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. message: The riverpod_generator package does not support ChangeNotifier values. -test/lints/unsupported_provider_value.dart:66:7 +test/lints/unsupported_provider_value.dart:65:7 ```dart @riverpod @@ -114,12 +114,12 @@ code: unsupported_provider_value severity: Severity.info correctionMessage: If using Notifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. message: The riverpod_generator package does not support Notifier values. -test/lints/unsupported_provider_value.dart:74:12 +test/lints/unsupported_provider_value.dart:73:12 ```dart @riverpod // expect_lint: unsupported_provider_value -MyNotifier >>>notifier<<<(NotifierRef ref) => MyNotifier(); +MyNotifier >>>notifier<<<(Ref ref) => MyNotifier(); @riverpod ``` @@ -130,12 +130,12 @@ code: unsupported_provider_value severity: Severity.info correctionMessage: If using Notifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. message: The riverpod_generator package does not support Notifier values. -test/lints/unsupported_provider_value.dart:78:23 +test/lints/unsupported_provider_value.dart:77:23 ```dart @riverpod // expect_lint: unsupported_provider_value -MyAutoDisposeNotifier >>>autoDisposeNotifier<<<(AutoDisposeNotifierRef ref) { +MyAutoDisposeNotifier >>>autoDisposeNotifier<<<(Ref ref) { return MyAutoDisposeNotifier(); } ``` @@ -146,7 +146,7 @@ code: unsupported_provider_value severity: Severity.info correctionMessage: If using Notifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. message: The riverpod_generator package does not support Notifier values. -test/lints/unsupported_provider_value.dart:84:7 +test/lints/unsupported_provider_value.dart:83:7 ```dart @riverpod @@ -162,12 +162,12 @@ code: unsupported_provider_value severity: Severity.info correctionMessage: If using AsyncNotifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. message: The riverpod_generator package does not support AsyncNotifier values. -test/lints/unsupported_provider_value.dart:100:17 +test/lints/unsupported_provider_value.dart:99:17 ```dart @riverpod // expect_lint: unsupported_provider_value -MyAsyncNotifier >>>asyncNotifier<<<(AsyncNotifierRef ref) => MyAsyncNotifier(); +MyAsyncNotifier >>>asyncNotifier<<<(Ref ref) => MyAsyncNotifier(); @riverpod ``` @@ -178,7 +178,7 @@ code: unsupported_provider_value severity: Severity.info correctionMessage: If using AsyncNotifier even though riverpod_generator does not support it, you can wrap the type in "Raw" to silence the warning. For example by returning Raw. message: The riverpod_generator package does not support AsyncNotifier values. -test/lints/unsupported_provider_value.dart:104:7 +test/lints/unsupported_provider_value.dart:103:7 ```dart @riverpod diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart index a4e054f21..4ab6766d5 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart @@ -915,4 +915,4 @@ abstract class _$WrongOrder extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.dart b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.dart index 8e0fe9892..c01d1bcac 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.dart @@ -3,7 +3,7 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'only_use_keep_alive_inside_keep_alive.g.dart'; @Riverpod(keepAlive: true) -int keepAlive(KeepAliveRef ref) => 42; +int keepAlive(Ref ref) => 42; @Riverpod(keepAlive: true) class KeepAliveClass extends _$KeepAliveClass { @@ -11,7 +11,7 @@ class KeepAliveClass extends _$KeepAliveClass { } @riverpod -int autoDispose(AutoDisposeRef ref) => 42; +int autoDispose(Ref ref) => 42; @riverpod class AutoDisposeClass extends _$AutoDisposeClass { @@ -19,7 +19,7 @@ class AutoDisposeClass extends _$AutoDisposeClass { } @Riverpod(keepAlive: true) -int fn(FnRef ref) { +int fn(Ref ref) { ref.watch(keepAliveProvider); ref.watch(keepAliveClassProvider); diff --git a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart index 195bf9d30..8c94f9cd9 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart @@ -327,4 +327,4 @@ final class FnProvider extends $FunctionalProvider String _$fnHash() => r'9e89e9bead8aa30a86f31bd16f4106c4b38e8f2b'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index b263c9f96..2cfaaee48 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -1193,4 +1193,4 @@ abstract class _$B2 extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.dart index 295747979..0396dce89 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.dart @@ -6,13 +6,13 @@ part 'another.g.dart'; final aProvider = Provider((ref) => 0); @riverpod -int b(BRef ref) => 0; +int b(Ref ref) => 0; @Riverpod(dependencies: []) -int anotherScoped(AnotherScopedRef ref) => 0; +int anotherScoped(Ref ref) => 0; @Riverpod(dependencies: [anotherScoped]) -int anotherNonEmptyScoped(AnotherNonEmptyScopedRef ref) { +int anotherNonEmptyScoped(Ref ref) { ref.watch(anotherScopedProvider); return 0; } diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart index 126b8cede..2471842c1 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart @@ -64,7 +64,7 @@ final class BProvider extends $FunctionalProvider } } -String _$bHash() => r'52593050701642f22b31c590f20c003dc2ee1579'; +String _$bHash() => r'31624e9aa10c9cd7941c9626e841c6df3468723b'; typedef AnotherScopedRef = Ref; @@ -124,7 +124,7 @@ final class AnotherScopedProvider extends $FunctionalProvider } } -String _$anotherScopedHash() => r'409a070806b566d16d98f18c99bf6243d481887f'; +String _$anotherScopedHash() => r'edf3ccffb7c3ce1b1e4ffdd4009aeed4fa38c3f8'; typedef AnotherNonEmptyScopedRef = Ref; @@ -189,7 +189,7 @@ final class AnotherNonEmptyScopedProvider extends $FunctionalProvider } String _$anotherNonEmptyScopedHash() => - r'cc21d248e644c853e4647ad60ca72cb42b82475f'; + r'56da5331e55d74e8e10ff710d20618f217394a69'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.dart index a1ba3a2bb..a10cd4dd1 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.dart @@ -5,16 +5,16 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'missing_dependencies.g.dart'; @Riverpod(dependencies: []) -int dep(DepRef ref) => 0; +int dep(Ref ref) => 0; @Riverpod(dependencies: [dep]) -int transitiveDep(TransitiveDepRef ref) => ref.watch(depProvider); +int transitiveDep(Ref ref) => ref.watch(depProvider); @Riverpod(dependencies: []) -int dep2(Dep2Ref ref) => 0; +int dep2(Ref ref) => 0; @Riverpod(dependencies: []) -int depFamily(DepFamilyRef ref, int id) => 0; +int depFamily(Ref ref, int id) => 0; // expect_lint: provider_dependencies @Dependencies([dep]) @@ -75,14 +75,14 @@ class DepFamily extends StatelessWidget { // expect_lint: provider_dependencies @riverpod -int plainAnnotation(PlainAnnotationRef ref) { +int plainAnnotation(Ref ref) { ref.watch(depProvider); return 0; } // expect_lint: provider_dependencies @Riverpod(keepAlive: false) -int customAnnotation(CustomAnnotationRef ref) { +int customAnnotation(Ref ref) { ref.watch(depProvider); return 0; } @@ -92,7 +92,7 @@ int customAnnotation(CustomAnnotationRef ref) { keepAlive: false, ) int customAnnotationWithTrailingComma( - CustomAnnotationWithTrailingCommaRef ref, + Ref ref, ) { ref.watch(depProvider); return 0; @@ -103,7 +103,7 @@ int customAnnotationWithTrailingComma( // expect_lint: provider_dependencies dependencies: [], ) -int existingDep(ExistingDepRef ref) { +int existingDep(Ref ref) { ref.watch(depProvider); return 0; } @@ -113,7 +113,7 @@ int existingDep(ExistingDepRef ref) { // expect_lint: provider_dependencies dependencies: [], ) -int multipleDeps(MultipleDepsRef ref) { +int multipleDeps(Ref ref) { ref.watch(depProvider); ref.watch(dep2Provider); return 0; @@ -277,4 +277,4 @@ class _NotFoundWidgetState extends ConsumerState { /// Random doc to test that identifiers in docs don't trigger the lint. /// [dep], [DepWidget], [depProvider] @Riverpod(dependencies: []) -int providerWithDartDoc(ProviderWithDartDocRef ref) => 0; +int providerWithDartDoc(Ref ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart index c464a0c2a..55ed1029b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart @@ -64,7 +64,7 @@ final class DepProvider extends $FunctionalProvider } } -String _$depHash() => r'749c4d696d29c72686cabcabd6fa7855f5cbf4db'; +String _$depHash() => r'578a350a40cda46444ecd9fa3ea2fd7bd0994692'; typedef TransitiveDepRef = Ref; @@ -128,7 +128,7 @@ final class TransitiveDepProvider extends $FunctionalProvider } } -String _$transitiveDepHash() => r'3718ab2a36c91fb776740c6aeafc49db08bbffd5'; +String _$transitiveDepHash() => r'cedc000b7d16447684dff970ddea659cca24cdf6'; typedef Dep2Ref = Ref; @@ -188,7 +188,7 @@ final class Dep2Provider extends $FunctionalProvider } } -String _$dep2Hash() => r'13cd909366c79168e3d9cd95f529ddbcee6de7dc'; +String _$dep2Hash() => r'97901e825cdcf5b1ac455b0fe8a2111662ce9f13'; typedef DepFamilyRef = Ref; @@ -278,7 +278,7 @@ final class DepFamilyProvider extends $FunctionalProvider } } -String _$depFamilyHash() => r'c11006a8b9718af9899999b7c49f78cf3423f558'; +String _$depFamilyHash() => r'6cca68b98693e352e9b801b1fc441d438fc72525'; final class DepFamilyFamily extends Family { const DepFamilyFamily._() @@ -389,7 +389,7 @@ final class PlainAnnotationProvider extends $FunctionalProvider } } -String _$plainAnnotationHash() => r'ceeb01dfcbd115f3676c8e38ce35a03cff16246b'; +String _$plainAnnotationHash() => r'6a3d1f1f2e53902af56cd7ce6ceba17358690b70'; typedef CustomAnnotationRef = Ref; @@ -449,7 +449,7 @@ final class CustomAnnotationProvider extends $FunctionalProvider } } -String _$customAnnotationHash() => r'04faed9b424be360e594870f91c4ef4689f05672'; +String _$customAnnotationHash() => r'8081bbad2cfbe5bff1ace9aa3be450dd28112488'; typedef CustomAnnotationWithTrailingCommaRef = Ref; @@ -513,7 +513,7 @@ final class CustomAnnotationWithTrailingCommaProvider } String _$customAnnotationWithTrailingCommaHash() => - r'b5c62d769dfc53d6d77e8fde9e0eb7d8a0ab9d18'; + r'709613050eb1db7b4c43cb87855e2c32988141d8'; typedef ExistingDepRef = Ref; @@ -573,7 +573,7 @@ final class ExistingDepProvider extends $FunctionalProvider } } -String _$existingDepHash() => r'8d7866d1af7e350d7c792e43a542cd47b130b239'; +String _$existingDepHash() => r'73e7e1a0d4c2ae07ed03fb248408c3d82fe85554'; typedef MultipleDepsRef = Ref; @@ -633,7 +633,7 @@ final class MultipleDepsProvider extends $FunctionalProvider } } -String _$multipleDepsHash() => r'9d08791636a0435ba115062a453d0d9e530ecf71'; +String _$multipleDepsHash() => r'66de70567c011a294a2c46703dfab8ba7247fd5e'; /// Random doc to test that identifiers in docs don't trigger the lint. /// [dep], [DepWidget], [depProvider] @@ -702,7 +702,7 @@ final class ProviderWithDartDocProvider extends $FunctionalProvider } String _$providerWithDartDocHash() => - r'6aeff1697c1ec37f475319a4100e01c0e56369ae'; + r'aeb5735ad2dbe1d0b41a529828f9bb2c915071b6'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart index e97f01b02..e27c76210 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart @@ -9,78 +9,140 @@ import 'another.dart'; part 'missing_dependencies2.g.dart'; @Riverpod(dependencies: []) -int dep(DepRef ref) => 0; +int dep(Ref ref) => 0; final scoped = Provider((ref) => 0, dependencies: []); @Riverpod(dependencies: []) -int generatedScoped(GeneratedScopedRef ref) => 0; +int generatedScoped(Ref ref) => 0; final root = Provider((ref) => 0); @riverpod -int generatedRoot(GeneratedRootRef ref) => 0; +int generatedRoot(Ref ref) => 0; // dep no "dependencies" @riverpod -int watchScopedButNoDependencies(WatchScopedButNoDependenciesRef ref) { +int watchScopedButNoDependencies(Ref ref) { + // expect_lint: avoid_manual_providers_as_generated_provider_dependency return ref.watch(scoped); } // expect_lint: provider_dependencies @riverpod int watchGeneratedScopedButNoDependencies( - WatchGeneratedScopedButNoDependenciesRef ref, + Ref ref, ) { return ref.watch(generatedScopedProvider); } @riverpod -int watchRootButNoDependencies(WatchRootButNoDependenciesRef ref) { +int watchRootButNoDependencies(Ref ref) { + // expect_lint: avoid_manual_providers_as_generated_provider_dependency return ref.watch(root); } @riverpod int watchGeneratedRootButNoDependencies( - WatchGeneratedRootButNoDependenciesRef ref, + Ref ref, ) { return ref.watch(generatedRootProvider); } // Check "dependencies" specified but missing dependency @Riverpod(dependencies: []) -int watchScopedButEmptyDependencies(WatchScopedButEmptyDependenciesRef ref) { +int watchScopedButEmptyDependencies(Ref ref) { + // expect_lint: avoid_manual_providers_as_generated_provider_dependency return ref.watch(scoped); } // expect_lint: provider_dependencies @Riverpod(dependencies: []) int watchGeneratedScopedButEmptyDependencies( - WatchGeneratedScopedButEmptyDependenciesRef ref, + Ref ref, ) { return ref.watch(generatedScopedProvider); } @Riverpod(dependencies: []) -int watchRootButEmptyDependencies(WatchRootButEmptyDependenciesRef ref) { +int watchRootButEmptyDependencies(Ref ref) { + // expect_lint: avoid_manual_providers_as_generated_provider_dependency return ref.watch(root); } @Riverpod(dependencies: []) int watchGeneratedRootButEmptyDependencies( - WatchGeneratedRootButEmptyDependenciesRef ref, + Ref ref, ) { return ref.watch(generatedRootProvider); } +// Check "dependencies" specified but missing dependency + +@Riverpod(dependencies: [dep]) +int watchScopedButMissingDependencies( + Ref ref, +) { + ref.watch(depProvider); + // expect_lint: avoid_manual_providers_as_generated_provider_dependency + return ref.watch(scoped); +} + +// expect_lint: provider_dependencies +@Riverpod(dependencies: [dep]) +int watchGeneratedScopedButMissingDependencies( + Ref ref, +) { + ref.watch(depProvider); + return ref.watch(generatedScopedProvider); +} + +@Riverpod(dependencies: [dep]) +int watchRootButMissingDependencies(Ref ref) { + ref.watch(depProvider); + // expect_lint: avoid_manual_providers_as_generated_provider_dependency + return ref.watch(root); +} + +@Riverpod(dependencies: [dep]) +int watchGeneratedRootButMissingDependencies( + Ref ref, +) { + ref.watch(depProvider); + return ref.watch(generatedRootProvider); +} + // Check "dependencies" specified and contains dependency @Riverpod(dependencies: [generatedScoped]) int watchGeneratedScopedAndContainsDependency( - WatchGeneratedScopedAndContainsDependencyRef ref, + Ref ref, ) { return ref.watch(generatedScopedProvider); } +@Riverpod(dependencies: [ + // The dependency is redundant because it is not a scoped provider + // expect_lint: provider_dependencies + generatedRoot, +]) +int watchGeneratedRootAndContainsDependency( + Ref ref, +) { + return ref.watch(generatedRootProvider); +} + +// A dependency is specified but never used + +@Riverpod(dependencies: [ + dep, + // expect_lint: provider_dependencies + generatedRoot, +]) +int specifiedDependencyButNeverUsed(Ref ref) { + ref.watch(depProvider); + return 0; +} + // Works with classes too @Riverpod(dependencies: []) class ClassWatchGeneratedRootButMissingDependencies @@ -92,7 +154,7 @@ class ClassWatchGeneratedRootButMissingDependencies } @Riverpod(dependencies: [generatedScoped]) -int regression2348(Regression2348Ref ref) { +int regression2348(Ref ref) { ref..watch(generatedScopedProvider); return 0; } @@ -109,20 +171,21 @@ class Regression2417 extends _$Regression2417 { // Regression for https://github.com/rrousselGit/riverpod/issues/2909 @Riverpod(dependencies: [dep]) -int familyDep(FamilyDepRef ref, int p) { +int familyDep(Ref ref, int p) { final test = ref.watch(depProvider); return test * p; } @Riverpod(dependencies: [familyDep]) -int familyDep2(FamilyDep2Ref ref, int p) { +int familyDep2(Ref ref, int p) { final test = ref.watch(familyDepProvider(0)); return test * p; } // Regression test for https://github.com/rrousselGit/riverpod/issues/2935 @riverpod -int alias(AliasRef ref) { +int alias(Ref ref) { + // expect_lint: avoid_manual_providers_as_generated_provider_dependency ref.watch(import_alias.aProvider); ref.watch(import_alias.bProvider); return 0; @@ -193,7 +256,7 @@ void fn3() => fn(); // expect_lint: provider_dependencies @riverpod -int foo(FooRef ref) { +int foo(Ref ref) { fn(); return 0; } @@ -270,7 +333,7 @@ class _Stateful3State extends State { // expect_lint: provider_dependencies @riverpod -int crossFileDependency(CrossFileDependencyRef ref) { +int crossFileDependency(Ref ref) { ref.watch(anotherNonEmptyScopedProvider); return 0; } diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart index aebad7d82..5d6c8ecaa 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart @@ -64,7 +64,7 @@ final class DepProvider extends $FunctionalProvider } } -String _$depHash() => r'749c4d696d29c72686cabcabd6fa7855f5cbf4db'; +String _$depHash() => r'578a350a40cda46444ecd9fa3ea2fd7bd0994692'; typedef GeneratedScopedRef = Ref; @@ -124,7 +124,7 @@ final class GeneratedScopedProvider extends $FunctionalProvider } } -String _$generatedScopedHash() => r'2eefb4cc872ddccfeb862142fd5f7e6d8bd82159'; +String _$generatedScopedHash() => r'f8e5b6926ce13765c83dbb7f8c8458c9c5fe7d69'; typedef GeneratedRootRef = Ref; @@ -184,7 +184,7 @@ final class GeneratedRootProvider extends $FunctionalProvider } } -String _$generatedRootHash() => r'080e3393566db0f44add3607e28a5a2980948704'; +String _$generatedRootHash() => r'179253a56503f28bb616c602d8af9ad3b23d438f'; typedef WatchScopedButNoDependenciesRef = Ref; @@ -247,7 +247,70 @@ final class WatchScopedButNoDependenciesProvider } String _$watchScopedButNoDependenciesHash() => - r'3ec52c4ab2ea2b3204b7aa049d1756c01c014ff0'; + r'e326226fdc19ea7a4430900154c071f5a1a98e40'; + +typedef WatchExternalButNoDependenciesRef = Ref; + +@ProviderFor(watchExternalButNoDependencies) +const watchExternalButNoDependenciesProvider = + WatchExternalButNoDependenciesProvider._(); + +final class WatchExternalButNoDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchExternalButNoDependenciesProvider._( + {int Function( + WatchExternalButNoDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'watchExternalButNoDependenciesProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final int Function( + WatchExternalButNoDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$watchExternalButNoDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + WatchExternalButNoDependenciesProvider $copyWithCreate( + int Function( + WatchExternalButNoDependenciesRef ref, + ) create, + ) { + return WatchExternalButNoDependenciesProvider._(create: create); + } + + @override + int create(WatchExternalButNoDependenciesRef ref) { + final _$cb = _createCb ?? watchExternalButNoDependencies; + return _$cb(ref); + } +} + +String _$watchExternalButNoDependenciesHash() => + r'2ed9c528aa61dbb5d1cf274d41b527d761c3d522'; typedef WatchGeneratedScopedButNoDependenciesRef = Ref; @@ -311,7 +374,7 @@ final class WatchGeneratedScopedButNoDependenciesProvider } String _$watchGeneratedScopedButNoDependenciesHash() => - r'2a4aba824078fe2c999260b4138939dee96c4fba'; + r'2109f8ccbc13632e45f18ccb93bc3059c431eba1'; typedef WatchRootButNoDependenciesRef = Ref; @@ -374,7 +437,7 @@ final class WatchRootButNoDependenciesProvider } String _$watchRootButNoDependenciesHash() => - r'037187e333a5bd5d11d00147d179640b8a0f18dd'; + r'cfecc8aeb539e82c46276f9e4dd78c323b4bef12'; typedef WatchGeneratedRootButNoDependenciesRef = Ref; @@ -438,7 +501,7 @@ final class WatchGeneratedRootButNoDependenciesProvider } String _$watchGeneratedRootButNoDependenciesHash() => - r'ecf43cc257376d2828638ce937813d2b72b46967'; + r'c839dab901f606c11c78f9c8761931027d3db1d1'; typedef WatchScopedButEmptyDependenciesRef = Ref; @@ -501,7 +564,7 @@ final class WatchScopedButEmptyDependenciesProvider } String _$watchScopedButEmptyDependenciesHash() => - r'6b7526eb9dfd70c8249c71efffc60d612ca92f16'; + r'a194f52730f635e9c92b3467b33b8c302c93b1ab'; typedef WatchGeneratedScopedButEmptyDependenciesRef = Ref; @@ -565,7 +628,7 @@ final class WatchGeneratedScopedButEmptyDependenciesProvider } String _$watchGeneratedScopedButEmptyDependenciesHash() => - r'5dc6791ab2f661a378de3e8335943a48e8305435'; + r'fa4cb564341e7b3f0dd10f70e17381c67859c643'; typedef WatchRootButEmptyDependenciesRef = Ref; @@ -628,7 +691,7 @@ final class WatchRootButEmptyDependenciesProvider } String _$watchRootButEmptyDependenciesHash() => - r'c95800f6aec446737168ac8dc3e6edcaeeed3bc0'; + r'8669a421efcd8caadc0d070f0c88043668610bbb'; typedef WatchGeneratedRootButEmptyDependenciesRef = Ref; @@ -692,7 +755,281 @@ final class WatchGeneratedRootButEmptyDependenciesProvider } String _$watchGeneratedRootButEmptyDependenciesHash() => - r'9fb97c1fa207a18870cd23c682305dcef413a706'; + r'80581ac491e25ae8c6ee7b7f25dff9939f8de37c'; + +typedef WatchScopedButMissingDependenciesRef = Ref; + +@ProviderFor(watchScopedButMissingDependencies) +const watchScopedButMissingDependenciesProvider = + WatchScopedButMissingDependenciesProvider._(); + +final class WatchScopedButMissingDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchScopedButMissingDependenciesProvider._( + {int Function( + WatchScopedButMissingDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'watchScopedButMissingDependenciesProvider', + isAutoDispose: true, + dependencies: const [depProvider], + allTransitiveDependencies: const [ + WatchScopedButMissingDependenciesProvider + .$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + + final int Function( + WatchScopedButMissingDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$watchScopedButMissingDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + WatchScopedButMissingDependenciesProvider $copyWithCreate( + int Function( + WatchScopedButMissingDependenciesRef ref, + ) create, + ) { + return WatchScopedButMissingDependenciesProvider._(create: create); + } + + @override + int create(WatchScopedButMissingDependenciesRef ref) { + final _$cb = _createCb ?? watchScopedButMissingDependencies; + return _$cb(ref); + } +} + +String _$watchScopedButMissingDependenciesHash() => + r'c890e4845b1fca73ee02442eb7a203734605173c'; + +typedef WatchGeneratedScopedButMissingDependenciesRef = Ref; + +@ProviderFor(watchGeneratedScopedButMissingDependencies) +const watchGeneratedScopedButMissingDependenciesProvider = + WatchGeneratedScopedButMissingDependenciesProvider._(); + +final class WatchGeneratedScopedButMissingDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchGeneratedScopedButMissingDependenciesProvider._( + {int Function( + WatchGeneratedScopedButMissingDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'watchGeneratedScopedButMissingDependenciesProvider', + isAutoDispose: true, + dependencies: const [depProvider], + allTransitiveDependencies: const [ + WatchGeneratedScopedButMissingDependenciesProvider + .$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + + final int Function( + WatchGeneratedScopedButMissingDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$watchGeneratedScopedButMissingDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + WatchGeneratedScopedButMissingDependenciesProvider $copyWithCreate( + int Function( + WatchGeneratedScopedButMissingDependenciesRef ref, + ) create, + ) { + return WatchGeneratedScopedButMissingDependenciesProvider._(create: create); + } + + @override + int create(WatchGeneratedScopedButMissingDependenciesRef ref) { + final _$cb = _createCb ?? watchGeneratedScopedButMissingDependencies; + return _$cb(ref); + } +} + +String _$watchGeneratedScopedButMissingDependenciesHash() => + r'fbbb5f1ea3725a7554dc05073f47a6b9ce5d913d'; + +typedef WatchRootButMissingDependenciesRef = Ref; + +@ProviderFor(watchRootButMissingDependencies) +const watchRootButMissingDependenciesProvider = + WatchRootButMissingDependenciesProvider._(); + +final class WatchRootButMissingDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchRootButMissingDependenciesProvider._( + {int Function( + WatchRootButMissingDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'watchRootButMissingDependenciesProvider', + isAutoDispose: true, + dependencies: const [depProvider], + allTransitiveDependencies: const [ + WatchRootButMissingDependenciesProvider.$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + + final int Function( + WatchRootButMissingDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$watchRootButMissingDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + WatchRootButMissingDependenciesProvider $copyWithCreate( + int Function( + WatchRootButMissingDependenciesRef ref, + ) create, + ) { + return WatchRootButMissingDependenciesProvider._(create: create); + } + + @override + int create(WatchRootButMissingDependenciesRef ref) { + final _$cb = _createCb ?? watchRootButMissingDependencies; + return _$cb(ref); + } +} + +String _$watchRootButMissingDependenciesHash() => + r'cc9c5e6c3a1c34e291a63c429fb031e0cc701499'; + +typedef WatchGeneratedRootButMissingDependenciesRef = Ref; + +@ProviderFor(watchGeneratedRootButMissingDependencies) +const watchGeneratedRootButMissingDependenciesProvider = + WatchGeneratedRootButMissingDependenciesProvider._(); + +final class WatchGeneratedRootButMissingDependenciesProvider + extends $FunctionalProvider + with $Provider { + const WatchGeneratedRootButMissingDependenciesProvider._( + {int Function( + WatchGeneratedRootButMissingDependenciesRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'watchGeneratedRootButMissingDependenciesProvider', + isAutoDispose: true, + dependencies: const [depProvider], + allTransitiveDependencies: const [ + WatchGeneratedRootButMissingDependenciesProvider + .$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + + final int Function( + WatchGeneratedRootButMissingDependenciesRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$watchGeneratedRootButMissingDependenciesHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + WatchGeneratedRootButMissingDependenciesProvider $copyWithCreate( + int Function( + WatchGeneratedRootButMissingDependenciesRef ref, + ) create, + ) { + return WatchGeneratedRootButMissingDependenciesProvider._(create: create); + } + + @override + int create(WatchGeneratedRootButMissingDependenciesRef ref) { + final _$cb = _createCb ?? watchGeneratedRootButMissingDependencies; + return _$cb(ref); + } +} + +String _$watchGeneratedRootButMissingDependenciesHash() => + r'10d01aea2b6b0772e98172f410bdbfce85786243'; typedef WatchGeneratedScopedAndContainsDependencyRef = Ref; @@ -761,7 +1098,148 @@ final class WatchGeneratedScopedAndContainsDependencyProvider } String _$watchGeneratedScopedAndContainsDependencyHash() => - r'320592737e763091c1229a79ae07fe961e7aab72'; + r'948e75e097500b33ee2fdbd3dc9fdecafa5f3d10'; + +typedef WatchGeneratedRootAndContainsDependencyRef = Ref; + +@ProviderFor(watchGeneratedRootAndContainsDependency) +const watchGeneratedRootAndContainsDependencyProvider = + WatchGeneratedRootAndContainsDependencyProvider._(); + +final class WatchGeneratedRootAndContainsDependencyProvider + extends $FunctionalProvider + with $Provider { + const WatchGeneratedRootAndContainsDependencyProvider._( + {int Function( + WatchGeneratedRootAndContainsDependencyRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'watchGeneratedRootAndContainsDependencyProvider', + isAutoDispose: true, + dependencies: const [generatedRootProvider], + allTransitiveDependencies: const [ + WatchGeneratedRootAndContainsDependencyProvider + .$allTransitiveDependencies0, + ], + ); + + static const $allTransitiveDependencies0 = generatedRootProvider; + + final int Function( + WatchGeneratedRootAndContainsDependencyRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => + _$watchGeneratedRootAndContainsDependencyHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + WatchGeneratedRootAndContainsDependencyProvider $copyWithCreate( + int Function( + WatchGeneratedRootAndContainsDependencyRef ref, + ) create, + ) { + return WatchGeneratedRootAndContainsDependencyProvider._(create: create); + } + + @override + int create(WatchGeneratedRootAndContainsDependencyRef ref) { + final _$cb = _createCb ?? watchGeneratedRootAndContainsDependency; + return _$cb(ref); + } +} + +String _$watchGeneratedRootAndContainsDependencyHash() => + r'780392b647f1606186ee0f70c81dd5b03f506284'; + +typedef SpecifiedDependencyButNeverUsedRef = Ref; + +@ProviderFor(specifiedDependencyButNeverUsed) +const specifiedDependencyButNeverUsedProvider = + SpecifiedDependencyButNeverUsedProvider._(); + +final class SpecifiedDependencyButNeverUsedProvider + extends $FunctionalProvider + with $Provider { + const SpecifiedDependencyButNeverUsedProvider._( + {int Function( + SpecifiedDependencyButNeverUsedRef ref, + )? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'specifiedDependencyButNeverUsedProvider', + isAutoDispose: true, + dependencies: const [ + depProvider, + generatedRootProvider + ], + allTransitiveDependencies: const [ + SpecifiedDependencyButNeverUsedProvider.$allTransitiveDependencies0, + SpecifiedDependencyButNeverUsedProvider.$allTransitiveDependencies1, + ], + ); + + static const $allTransitiveDependencies0 = depProvider; + static const $allTransitiveDependencies1 = generatedRootProvider; + + final int Function( + SpecifiedDependencyButNeverUsedRef ref, + )? _createCb; + + @override + String debugGetCreateSourceHash() => _$specifiedDependencyButNeverUsedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + $ProviderElement $createElement($ProviderPointer pointer) => + $ProviderElement(this, pointer); + + @override + SpecifiedDependencyButNeverUsedProvider $copyWithCreate( + int Function( + SpecifiedDependencyButNeverUsedRef ref, + ) create, + ) { + return SpecifiedDependencyButNeverUsedProvider._(create: create); + } + + @override + int create(SpecifiedDependencyButNeverUsedRef ref) { + final _$cb = _createCb ?? specifiedDependencyButNeverUsed; + return _$cb(ref); + } +} + +String _$specifiedDependencyButNeverUsedHash() => + r'cca97d259bcacbff290f0d459e0de3a9b5b6a510'; @ProviderFor(ClassWatchGeneratedRootButMissingDependencies) const classWatchGeneratedRootButMissingDependenciesProvider = @@ -904,7 +1382,7 @@ final class Regression2348Provider extends $FunctionalProvider } } -String _$regression2348Hash() => r'72fbbe420e9835c9843c28b7c9375ca3d99ca4b7'; +String _$regression2348Hash() => r'6ad005595ee202c8b0188562ed8c4a33d01260e2'; @ProviderFor(Regression2417) const regression2417Provider = Regression2417Provider._(); @@ -1070,7 +1548,7 @@ final class FamilyDepProvider extends $FunctionalProvider } } -String _$familyDepHash() => r'1c152873ed2b3e88da09d8e1fc53a33635cbe3b3'; +String _$familyDepHash() => r'ed674a44492b3871b72b4fbc68180ea0839723e5'; final class FamilyDepFamily extends Family { const FamilyDepFamily._() @@ -1209,7 +1687,7 @@ final class FamilyDep2Provider extends $FunctionalProvider } } -String _$familyDep2Hash() => r'd81e2e56d75dd08a695b834853a3a6cea99ea305'; +String _$familyDep2Hash() => r'ee9c96f7a1d65e1b66c29aa8d8c030146995504c'; final class FamilyDep2Family extends Family { const FamilyDep2Family._() @@ -1315,7 +1793,7 @@ final class AliasProvider extends $FunctionalProvider } } -String _$aliasHash() => r'871c6c7ab22e4bbed2dc46917daf42e7fc1b9d88'; +String _$aliasHash() => r'b410585ad56c66160898a05647e09e1a606aa9d2'; @ProviderFor(AliasClass) const aliasClassProvider = AliasClassProvider._(); @@ -1583,4 +2061,4 @@ String _$crossFileDependencyHash() => r'9ca6b69de674377c6906fb835cbe04d01851d088'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.dart index 650984ed0..1ba634f07 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.dart @@ -6,13 +6,13 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'unused_dependency.g.dart'; @riverpod -int root(RootRef ref) => 0; +int root(Ref ref) => 0; @Riverpod(dependencies: []) -int dep(DepRef ref) => 0; +int dep(Ref ref) => 0; @Riverpod(dependencies: []) -int dep2(Dep2Ref ref) => 0; +int dep2(Ref ref) => 0; //////////// @@ -24,7 +24,7 @@ int dep2(Dep2Ref ref) => 0; dep2, ], ) -int extraDep(ExtraDepRef ref) { +int extraDep(Ref ref) { ref.watch(dep2Provider); return 0; } @@ -36,7 +36,7 @@ int extraDep(ExtraDepRef ref) { dep, ], ) -int noDep(NoDepRef ref) { +int noDep(Ref ref) { return 0; } @@ -47,7 +47,7 @@ int noDep(NoDepRef ref) { ], keepAlive: false, ) -int dependenciesFirstThenKeepAlive(DependenciesFirstThenKeepAliveRef ref) { +int dependenciesFirstThenKeepAlive(Ref ref) { return 0; } @@ -57,13 +57,13 @@ int dependenciesFirstThenKeepAlive(DependenciesFirstThenKeepAliveRef ref) { dep, ], ) -int noDepNoParam(NoDepNoParamRef ref) { +int noDepNoParam(Ref ref) { return 0; } // expect_lint: provider_dependencies @Riverpod(keepAlive: false, dependencies: [dep]) -int noDepWithoutComma(NoDepWithoutCommaRef ref) { +int noDepWithoutComma(Ref ref) { return 0; } @@ -74,7 +74,7 @@ int noDepWithoutComma(NoDepWithoutCommaRef ref) { root, ], ) -int rootDep(RootDepRef ref) => 0; +int rootDep(Ref ref) => 0; // expect_lint: provider_dependencies @Dependencies([dep]) diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart index 59f2dc0ad..b9662253f 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart @@ -580,4 +580,4 @@ final class RootDepProvider extends $FunctionalProvider String _$rootDepHash() => r'a57728bf865d5a9a73f40f08b038946418cdcf52'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.dart index a5992bd7d..5ad69f049 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.dart @@ -10,7 +10,7 @@ final legacy = Provider.family((ref, value) => 0); final provider = Provider.family((ref, value) => 0); @Riverpod(keepAlive: true) -int generator(GeneratorRef ref, {Object? value}) => 0; +int generator(Ref ref, {Object? value}) => 0; var list = [42]; final dep = Provider((ref) { diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index cac3f9f6f..bfea5c3ce 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -94,7 +94,7 @@ final class GeneratorProvider extends $FunctionalProvider } } -String _$generatorHash() => r'e76b8050c3a272ecef1985e4dc7dfe5df3270f2f'; +String _$generatorHash() => r'd7d1733f8884b6702f363ddb178ae57797d0034f'; final class GeneratorFamily extends Family { const GeneratorFamily._() @@ -139,4 +139,4 @@ final class GeneratorFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.dart index 5c274efa4..a7a06d4eb 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.dart @@ -15,10 +15,10 @@ class UnimplementedScoped extends _$UnimplementedScoped { } @Riverpod(dependencies: []) -int scoped(ScopedRef ref) => 0; +int scoped(Ref ref) => 0; @riverpod -int root(RootRef ref) => 0; +int root(Ref ref) => 0; // A fake runApp to check that we lint only on the official Flutter's runApp void runApp(Widget widget) {} diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart index 08c0d1d49..be88dd927 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart @@ -135,7 +135,7 @@ final class ScopedProvider extends $FunctionalProvider } } -String _$scopedHash() => r'bbf25968b1186d2dd63d10545364453712d491cf'; +String _$scopedHash() => r'5a271e9b23e18517694454448b922a6c9d03781e'; typedef RootRef = Ref; @@ -195,7 +195,7 @@ final class RootProvider extends $FunctionalProvider } } -String _$rootHash() => r'1cd85d73316aad02169ff0f5e7af5cf1423410ff'; +String _$rootHash() => r'dda8bbb46cb4d7c658597669e3be92e2447dcfb0'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.dart b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.dart index 1d4abfe53..1a44280a3 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.dart @@ -5,10 +5,10 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'unknown_scoped_usage.g.dart'; @Riverpod(dependencies: []) -int scoped(ScopedRef ref) => 0; +int scoped(Ref ref) => 0; @riverpod -int root(RootRef ref) => 0; +int root(Ref ref) => 0; @Dependencies([scoped]) void fn(WidgetRef widgetRef, Ref ref) { diff --git a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart index 4d26711bf..31a8dbb5b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart @@ -127,4 +127,4 @@ final class RootProvider extends $FunctionalProvider String _$rootHash() => r'1cd85d73316aad02169ff0f5e7af5cf1423410ff'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.dart index 2b09ef0ed..4df784c6d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.dart @@ -6,15 +6,15 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'unsupported_provider_value.g.dart'; @riverpod -int integer(IntegerRef ref) => 0; +int integer(Ref ref) => 0; @riverpod // expect_lint: unsupported_provider_value -MyStateNotifier stateNotifier(StateNotifierRef ref) => MyStateNotifier(); +MyStateNotifier stateNotifier(Ref ref) => MyStateNotifier(); @riverpod // expect_lint: unsupported_provider_value -Future asyncStateNotifier(AsyncStateNotifierRef ref) async { +Future asyncStateNotifier(Ref ref) async { return MyStateNotifier(); } @@ -26,8 +26,7 @@ class StateNotifierClass extends _$StateNotifierClass { @riverpod // expect_lint: unsupported_provider_value -Future stateNotifierAsync(StateNotifierAsyncRef ref) async => - MyStateNotifier(); +Future stateNotifierAsync(Ref ref) async => MyStateNotifier(); // Regression tests for https://github.com/rrousselGit/riverpod/issues/2302 @riverpod @@ -59,7 +58,7 @@ class MyStateNotifier extends StateNotifier { @riverpod // expect_lint: unsupported_provider_value -MyChangeNotifier changeNotifier(ChangeNotifierRef ref) => MyChangeNotifier(); +MyChangeNotifier changeNotifier(Ref ref) => MyChangeNotifier(); @riverpod // expect_lint: unsupported_provider_value @@ -71,11 +70,11 @@ class MyChangeNotifier extends ChangeNotifier {} @riverpod // expect_lint: unsupported_provider_value -MyNotifier notifier(NotifierRef ref) => MyNotifier(); +MyNotifier notifier(Ref ref) => MyNotifier(); @riverpod // expect_lint: unsupported_provider_value -MyAutoDisposeNotifier autoDisposeNotifier(AutoDisposeNotifierRef ref) { +MyAutoDisposeNotifier autoDisposeNotifier(Ref ref) { return MyAutoDisposeNotifier(); } @@ -97,7 +96,7 @@ class MyAutoDisposeNotifier extends Notifier { @riverpod // expect_lint: unsupported_provider_value -MyAsyncNotifier asyncNotifier(AsyncNotifierRef ref) => MyAsyncNotifier(); +MyAsyncNotifier asyncNotifier(Ref ref) => MyAsyncNotifier(); @riverpod // expect_lint: unsupported_provider_value @@ -111,32 +110,32 @@ class MyAsyncNotifier extends AsyncNotifier { } @riverpod -Raw rawNotifier(RawNotifierRef ref) => MyChangeNotifier(); +Raw rawNotifier(Ref ref) => MyChangeNotifier(); @riverpod Raw> rawFutureNotifier( - RawFutureNotifierRef ref, + Ref ref, ) async { return MyChangeNotifier(); } @riverpod Raw> rawStreamNotifier( - RawStreamNotifierRef ref, + Ref ref, ) async* { yield MyChangeNotifier(); } @riverpod Future> futureRawNotifier( - FutureRawNotifierRef ref, + Ref ref, ) async { return MyChangeNotifier(); } @riverpod Stream> streamRawNotifier( - StreamRawNotifierRef ref, + Ref ref, ) async* { yield MyChangeNotifier(); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart index 648dc92a9..288de347a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart @@ -64,7 +64,7 @@ final class IntegerProvider extends $FunctionalProvider } } -String _$integerHash() => r'a8ce0296e677f64c8b9d1893eed85598c096765e'; +String _$integerHash() => r'8ad63bb35c89ffcf2ef281d7c39539760afff303'; typedef StateNotifierRef = Ref; @@ -125,7 +125,7 @@ final class StateNotifierProvider } } -String _$stateNotifierHash() => r'5d517187bf927e19246ffbcc279d59e15df8ef30'; +String _$stateNotifierHash() => r'2505b564fd3a623976548c715b1623dea507f6d3'; typedef AsyncStateNotifierRef = Ref>; @@ -182,7 +182,7 @@ final class AsyncStateNotifierProvider extends $FunctionalProvider< } String _$asyncStateNotifierHash() => - r'66442390f13e38cd9594f841a7610ab0f632db81'; + r'5c5954eb030f5688abdf881e047c8893c864b1a2'; @ProviderFor(StateNotifierClass) const stateNotifierClassProvider = StateNotifierClassProvider._(); @@ -310,7 +310,7 @@ final class StateNotifierAsyncProvider extends $FunctionalProvider< } String _$stateNotifierAsyncHash() => - r'9a9b1986076dfdfa4490cc109f1bd0f112a7455c'; + r'ce67cf8c6f4bda46835042c17ea01186b5b399a5'; @ProviderFor(SelfNotifier) const selfNotifierProvider = SelfNotifierProvider._(); @@ -633,7 +633,7 @@ final class ChangeNotifierProvider } } -String _$changeNotifierHash() => r'6325328c129773979364c3cfd628f8f696bbaf66'; +String _$changeNotifierHash() => r'1686043b72e25b3143c5131906924f1393569400'; @ProviderFor(ChangeNotifierClass) const changeNotifierClassProvider = ChangeNotifierClassProvider._(); @@ -764,7 +764,7 @@ final class NotifierProvider extends $FunctionalProvider } } -String _$notifierHash() => r'2f323c78400044790faaf61912fc98c6153942f6'; +String _$notifierHash() => r'5ad63d9ccd05ab78e7a6ba5c763cacf0b1decb7b'; typedef AutoDisposeNotifierRef = Ref; @@ -827,7 +827,7 @@ final class AutoDisposeNotifierProvider } String _$autoDisposeNotifierHash() => - r'620df0fc11c887f01e125454afe8de553cfea6d0'; + r'6aecd9dee1e2734c3acf8eab05145418d10656e1'; @ProviderFor(NotifierClass) const notifierClassProvider = NotifierClassProvider._(); @@ -958,7 +958,7 @@ final class AsyncNotifierProvider } } -String _$asyncNotifierHash() => r'c90348efac71d241468236924f6c6bc80ae0d0e0'; +String _$asyncNotifierHash() => r'8800a97f6bf80a56caf5d968d4b4ab91f7f0a64e'; @ProviderFor(AsyncNotifierClass) const asyncNotifierClassProvider = AsyncNotifierClassProvider._(); @@ -1091,7 +1091,7 @@ final class RawNotifierProvider } } -String _$rawNotifierHash() => r'c01adc70a8e08258bf5d13024aa8e9b86359a2b2'; +String _$rawNotifierHash() => r'c667d10419c9ce1fdd227e2afd1f3aaf63c3380b'; typedef RawFutureNotifierRef = Ref>>; @@ -1153,7 +1153,7 @@ final class RawFutureNotifierProvider extends $FunctionalProvider< } } -String _$rawFutureNotifierHash() => r'883253dbf7ade868c44b288ec3da02be64dcfb20'; +String _$rawFutureNotifierHash() => r'ff2744c369ebd96615f19451eae416d7afeef03f'; typedef RawStreamNotifierRef = Ref>>; @@ -1215,7 +1215,7 @@ final class RawStreamNotifierProvider extends $FunctionalProvider< } } -String _$rawStreamNotifierHash() => r'f22f6a906e275c6245365bf029e2dc217cf3a301'; +String _$rawStreamNotifierHash() => r'9a13efb8fbcef6c4388d5a2535b1b0aec6e46a9a'; typedef FutureRawNotifierRef = Ref>>; @@ -1271,7 +1271,7 @@ final class FutureRawNotifierProvider extends $FunctionalProvider< } } -String _$futureRawNotifierHash() => r'd70ca757ff2539fc698ff924c135ee5e88a98018'; +String _$futureRawNotifierHash() => r'87103845bce1f4cae4ad62ae3b7da6ca3539581f'; typedef StreamRawNotifierRef = Ref>>; @@ -1327,7 +1327,7 @@ final class StreamRawNotifierProvider extends $FunctionalProvider< } } -String _$streamRawNotifierHash() => r'b1075c37ef3e8a83dfb9a3d469b76bd4855c336f'; +String _$streamRawNotifierHash() => r'1d4abe389b7dfe1381879d8ffb174f6d1d9325e0'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/test_lint.dart b/packages/riverpod_lint_flutter_test/test/test_lint.dart index feefe45ab..8f89c0da9 100644 --- a/packages/riverpod_lint_flutter_test/test/test_lint.dart +++ b/packages/riverpod_lint_flutter_test/test/test_lint.dart @@ -1,7 +1,10 @@ +import 'dart:convert'; import 'dart:io'; +import 'package:analyzer/source/source_range.dart'; import 'package:analyzer_plugin/protocol/protocol_generated.dart'; import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:pubspec_parse/pubspec_parse.dart'; import 'package:test/test.dart'; import 'package:path/path.dart'; import 'package:riverpod_lint/src/riverpod_custom_lint.dart'; @@ -48,7 +51,7 @@ void testLint( expect( changes.flattened, matchesPrioritizedSourceChangesGolden( - fixesGoldenPath, + File(fixesGoldenPath), source: result.content, sourcePath: sourcePath.path, ), @@ -59,24 +62,149 @@ void testLint( @isTest void testGolden( String description, - String file, - Future> Function(ResolvedUnitResult) - testRun, { + String goldensFile, + Future> Function( + ResolvedUnitResult, + OffsetHelper helper, + ) body, { required String sourcePath, }) { assert(sourcePath.endsWith('.dart')); test(description, () async { - final absoluteSourcePath = File(normalize(sourcePath)).absolute; - final result = await resolveFile2(path: absoluteSourcePath.path); + final absoluteSource = File(normalize(sourcePath)).absolute; + + final sourceFile = File(sourcePath).absolute; + + final result = await resolveFile2(path: absoluteSource.path); result as ResolvedUnitResult; + final source = sourceFile.readAsStringSync(); + final changes = await body(result, OffsetHelper._(source)).then( + (value) => value.toList(), + ); + expect( - await testRun(result), + await changes, matchesPrioritizedSourceChangesGolden( - file, + File(goldensFile), source: result.content, sourcePath: sourcePath, ), ); }); } + +const _cursor = '<>'; + +class OffsetHelper { + OffsetHelper._(this._content); + + final String _content; + + /// Strings must be code of the format: + /// + /// ``dart + /// Some<>Code + /// ``` + /// + /// where `<>` is the location of the cursor. + /// + /// At least one `<>` must be present, or the function will throw. + Iterable rangesForString(String string) sync* { + final cursors = '<>'.allMatches(string).toList(); + if (cursors.isEmpty) { + throw ArgumentError('String does not contain any cursors: $string'); + } + + final stringWithoutCursors = string.replaceAll(_cursor, ''); + + final start = _content.indexOf(stringWithoutCursors); + if (start == -1) { + throw ArgumentError('String not found in content: $stringWithoutCursors'); + } + + if (_content.indexOf(stringWithoutCursors, start + 1) != -1) { + throw ArgumentError( + 'Found the string twice in the content: $stringWithoutCursors', + ); + } + + for (final (index, cursor) in cursors.indexed) { + // In the case of multiple cursors, we need to adjust the offset + // to account for the previous cursors. + final actualCursorStart = cursor.start - 2 * index; + yield SourceRange(start + actualCursorStart, 0); + } + } + + Future> runAssist( + RiverpodAssist assist, + ResolvedUnitResult result, + Iterable cursorRanges, { + Pubspec? pubspec, + }) async { + return Future.wait( + cursorRanges.map( + (range) => assist.testRun(result, range, pubspec: pubspec), + ), + ).then((value) => value.expand((e) => e)); + } + + void debugOffset(List offsets) { + offsets.sort(); + + var mappedContent = _content; + for (final offset in offsets.reversed) { + mappedContent = mappedContent.substring(0, offset) + + '<>' + + mappedContent.substring(offset); + } + + final lines = LineSplitter.split(mappedContent).toList(); + + final codes = []; + + StringBuffer? buffer; + + void openBuffer() { + buffer ??= StringBuffer("helper.rangesForString('''\n"); + } + + void closeBuffer() { + if (buffer == null) return; + + buffer!.write("''')"); + codes.add(buffer.toString()); + buffer = null; + } + + // Print all lines with <> in them and one line before and after. + for (final (index, line) in lines.indexed) { + if (buffer == null && line.trim().isEmpty) continue; + + final hasCursor = line.contains(_cursor); + late final hadCursor = index >= 1 && lines[index - 1].contains(_cursor); + late final willHaveCursor = + index + 1 < lines.length && lines[index + 1].contains(_cursor); + + if (hasCursor || hadCursor || willHaveCursor) { + openBuffer(); + buffer!.writeln(line); + } else { + closeBuffer(); + } + } + + if (buffer != null) closeBuffer(); + + if (codes.length == 1) { + print(' final cursors = ${codes.single};'); + } else { + print(' final cursors = ['); + for (final code in codes) { + print(' ...$code,'); + } + print(' ];'); + } + } +} diff --git a/website/docs/advanced/select/select/codegen.dart b/website/docs/advanced/select/select/codegen.dart index 67f529215..fce0f19a3 100644 --- a/website/docs/advanced/select/select/codegen.dart +++ b/website/docs/advanced/select/select/codegen.dart @@ -12,7 +12,7 @@ class User { } @riverpod -User example(ExampleRef ref) => User() +User example(Ref ref) => User() ..firstName = 'John' ..lastName = 'Doe'; diff --git a/website/docs/advanced/select/select/codegen.g.dart b/website/docs/advanced/select/select/codegen.g.dart index 2d51a144c..ba7f12252 100644 --- a/website/docs/advanced/select/select/codegen.g.dart +++ b/website/docs/advanced/select/select/codegen.g.dart @@ -66,7 +66,7 @@ final class ExampleProvider extends $FunctionalProvider } } -String _$exampleHash() => r'72881c6147d44adb957180debefe7696d93107f0'; +String _$exampleHash() => r'c9865d4390aad5b8480addcbb73dbd225c8417b8'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/advanced/select/select_async/codegen.dart b/website/docs/advanced/select/select_async/codegen.dart index 60b6285e5..9ddf7256b 100644 --- a/website/docs/advanced/select/select_async/codegen.dart +++ b/website/docs/advanced/select/select_async/codegen.dart @@ -9,7 +9,7 @@ class User { } @riverpod -FutureOr user(UserRef ref) { +FutureOr user(Ref ref) { return User() ..firstName = 'John' ..lastName = 'Doe'; @@ -17,7 +17,7 @@ FutureOr user(UserRef ref) { /* SNIPPET START */ @riverpod -Object? example(ExampleRef ref) async { +Object? example(Ref ref) async { // {@template watch} // Wait for a user to be available, and listen to only the "firstName" property // {@endtemplate} diff --git a/website/docs/advanced/select/select_async/codegen.g.dart b/website/docs/advanced/select/select_async/codegen.g.dart index e1f780f62..a37162d18 100644 --- a/website/docs/advanced/select/select_async/codegen.g.dart +++ b/website/docs/advanced/select/select_async/codegen.g.dart @@ -119,7 +119,7 @@ final class ExampleProvider extends $FunctionalProvider } } -String _$exampleHash() => r'1fccbdbec0e3585bc9d3a5709ac88a8919dd78fa'; +String _$exampleHash() => r'05abb7bf29fe43807cb1a31a17eb23c821529a69'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.dart b/website/docs/case_studies/cancel/detail_screen/codegen.dart index 1941e884c..7a47d834a 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.dart @@ -24,7 +24,7 @@ class Activity with _$Activity { } @riverpod -Future activity(ActivityRef ref) async { +Future activity(Ref ref) async { final response = await http.get( Uri.https('www.boredapi.com', '/api/activity'), ); diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart index 127c57c1a..a08c54d0a 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart @@ -79,7 +79,7 @@ final class ActivityProvider } } -String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; +String _$activityHash() => r'609ac1c1d8008d8109ea5869c7aa88013032917c'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart index d88aa6b16..8094b9996 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart @@ -9,7 +9,7 @@ part 'codegen.g.dart'; /* SNIPPET START */ @riverpod -Future activity(ActivityRef ref) async { +Future activity(Ref ref) async { // {@template client} // We create an HTTP client using package:http // {@endtemplate} diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart index 46529fa89..fe2311549 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -59,7 +59,7 @@ final class ActivityProvider } } -String _$activityHash() => r'304864a6b8051925061a2bba397574ec45b94d08'; +String _$activityHash() => r'ac82ab2c8ff5c059f8f9abebed0a5c1fb6dc66c8'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart index f93cba60c..732f8e134 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart @@ -9,7 +9,7 @@ part 'codegen.g.dart'; /* SNIPPET START */ @riverpod -Future activity(ActivityRef ref) async { +Future activity(Ref ref) async { // {@template didDispose} // We capture whether the provider is currently disposed or not. // {@endtemplate} diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart index 5c8f2d5bf..e85b6c152 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -59,7 +59,7 @@ final class ActivityProvider } } -String _$activityHash() => r'ef908e3b46693862f082769663b14d5369d6e155'; +String _$activityHash() => r'dd7d10807315da17e775b99e8e03f5d9634fc822'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.dart index 5bd3ccfca..e3663c7a0 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.dart @@ -9,7 +9,7 @@ part 'codegen.g.dart'; /* SNIPPET START */ @riverpod -Future activity(ActivityRef ref) async { +Future activity(Ref ref) async { // {@template client} // We obtain an HTTP client using the extension we created earlier. // {@endtemplate} diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart index c3bd25059..dd3818a4c 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -59,7 +59,7 @@ final class ActivityProvider } } -String _$activityHash() => r'f045dd6e89fde6bbe12a89f243290d289a3e692d'; +String _$activityHash() => r'c1d2d6dca725a8b75b31c73630a5641dba0bec2b'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart index 0cec67cba..16ac99207 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart @@ -9,7 +9,7 @@ part 'codegen.g.dart'; /* SNIPPET START */ @riverpod -Future activity(ActivityRef ref) async { +Future activity(Ref ref) async { final response = await http.get( Uri.https('www.boredapi.com', '/api/activity'), ); diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart index df778ce92..a82fb6d2c 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -59,7 +59,7 @@ final class ActivityProvider } } -String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; +String _$activityHash() => r'609ac1c1d8008d8109ea5869c7aa88013032917c'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.dart index 837a4b2d7..865e30cc7 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.dart @@ -45,7 +45,7 @@ class ActivityView extends ConsumerWidget { } @riverpod -Future activity(ActivityRef ref) async { +Future activity(Ref ref) async { final response = await http.get( Uri.https('www.boredapi.com', '/api/activity'), ); diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart index 127c57c1a..a08c54d0a 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -79,7 +79,7 @@ final class ActivityProvider } } -String _$activityHash() => r'c73d0af18bcf7072f6a5a913b0b272649fb99a81'; +String _$activityHash() => r'609ac1c1d8008d8109ea5869c7aa88013032917c'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/main.dart b/website/docs/concepts/about_codegen/main.dart index 1ccb42807..6dbbf14aa 100644 --- a/website/docs/concepts/about_codegen/main.dart +++ b/website/docs/concepts/about_codegen/main.dart @@ -16,7 +16,7 @@ final http = Http(); /* SNIPPET START */ @riverpod -Future fetchUser(FetchUserRef ref, {required int userId}) async { +Future fetchUser(Ref ref, {required int userId}) async { final json = await http.get('api/user/$userId'); return User.fromJson(json); } diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 35ce3eec9..7c9996902 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -89,7 +89,7 @@ final class FetchUserProvider } } -String _$fetchUserHash() => r'ff427bbb4130a8a6994fa623ae70997f7b0f6bdb'; +String _$fetchUserHash() => r'0ea61464a124f8af2cf15b830a1a012d4272eb47'; final class FetchUserFamily extends Family { const FetchUserFamily._() @@ -134,4 +134,4 @@ final class FetchUserFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart index dacbd45bb..885c7b645 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart @@ -70,4 +70,4 @@ abstract class _$Example extends $AsyncNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart index 9e044bab2..c44d2341f 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart @@ -70,4 +70,4 @@ abstract class _$Example extends $StreamNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart index 95fdd909c..7ab60af7c 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart @@ -4,6 +4,6 @@ part 'async_fn_future.g.dart'; /* SNIPPET START */ @riverpod -Future example(ExampleRef ref) async { +Future example(Ref ref) async { return Future.value('foo'); } diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart index 45170ea57..0bc4e6ea9 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -59,7 +59,7 @@ final class ExampleProvider } } -String _$exampleHash() => r'e620af6b870a76eea4228989433de0666957d813'; +String _$exampleHash() => r'24ba6aa120f9e40b3796d5429f7723b82f8f0970'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart index 74da790ad..43b3a877f 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart @@ -4,6 +4,6 @@ part 'async_fn_stream.g.dart'; /* SNIPPET START */ @riverpod -Stream example(ExampleRef ref) async* { +Stream example(Ref ref) async* { yield 'foo'; } diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart index d565bb46f..9209375a3 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -59,7 +59,7 @@ final class ExampleProvider } } -String _$exampleHash() => r'8a2b19776fb9bbb1631f898bd6446b57b102dd9d'; +String _$exampleHash() => r'f7f90ac5fbf939c0259a549b8e01a559b0d95ff1'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart index 0c714c702..3351a2da9 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart @@ -5,8 +5,8 @@ part 'auto_dispose.g.dart'; /* SNIPPET START */ // AutoDispose provider (keepAlive is false by default) @riverpod -String example1(Example1Ref ref) => 'foo'; +String example1(Ref ref) => 'foo'; // Non autoDispose provider @Riverpod(keepAlive: true) -String example2(Example2Ref ref) => 'foo'; +String example2(Ref ref) => 'foo'; diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart index 41638f78b..a69296fe2 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -66,7 +66,7 @@ final class Example1Provider extends $FunctionalProvider } } -String _$example1Hash() => r'8a5f0865f758792cc8e4f2ca67db334196df6e88'; +String _$example1Hash() => r'6a361ee6f9dd1d0cdbb42f967f6356aa058f7041'; typedef Example2Ref = Ref; @@ -126,7 +126,7 @@ final class Example2Provider extends $FunctionalProvider } } -String _$example2Hash() => r'bc25731d759be185125d12d995d0b89b07d1e271'; +String _$example2Hash() => r'181b89435c06a7284a8978c5ab9f13bb4a3693b0'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/family.dart b/website/docs/concepts/about_codegen/provider_type/family.dart index e1ee685fb..d4a88c306 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.dart @@ -4,4 +4,4 @@ part 'family.g.dart'; /* SNIPPET START */ @riverpod -String example(ExampleRef ref, int param) => 'Hello $param'; +String example(Ref ref, int param) => 'Hello $param'; diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index 37d1cc09d..e6167b773 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -96,7 +96,7 @@ final class ExampleProvider extends $FunctionalProvider } } -String _$exampleHash() => r'c4f5a651a55bcf34b0c92d98d77436844cbdc097'; +String _$exampleHash() => r'7cd87bca029ed938b0e314a14fdfaa2875bd3079'; final class ExampleFamily extends Family { const ExampleFamily._() @@ -141,4 +141,4 @@ final class ExampleFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index 7adf9c927..82025a91d 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -205,4 +205,4 @@ abstract class _$Example extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.dart index 9f6ff57cd..6ac513340 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.dart @@ -5,7 +5,7 @@ part 'family_fn.g.dart'; /* SNIPPET START */ @riverpod String example( - ExampleRef ref, + Ref ref, int param1, { String param2 = 'foo', }) { diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index 261ea5829..c68fcb438 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -110,7 +110,7 @@ final class ExampleProvider extends $FunctionalProvider } } -String _$exampleHash() => r'9c32e94eea83a436746088de51e6426f251b2190'; +String _$exampleHash() => r'5795b1f6c6f075de18d0e9789a3a52040c144f0c'; final class ExampleFamily extends Family { const ExampleFamily._() @@ -165,4 +165,4 @@ final class ExampleFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart index 667033101..018497099 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart @@ -78,4 +78,4 @@ abstract class _$Example extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.dart index 0d4922734..73e82b7e2 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.dart @@ -4,6 +4,6 @@ part 'sync_fn.g.dart'; /* SNIPPET START */ @riverpod -String example(ExampleRef ref) { +String example(Ref ref) { return 'foo'; } diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart index 95a8f5e82..bb0ecb8a4 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -66,7 +66,7 @@ final class ExampleProvider extends $FunctionalProvider } } -String _$exampleHash() => r'dd4e9043c704a42a3fc025e7fef9515f659fc78a'; +String _$exampleHash() => r'e75fe2037fef7a3f80e04fa007fe64d719dba2fd'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/about_hooks.mdx b/website/docs/concepts/about_hooks.mdx index ffce70b56..d65fa3c86 100644 --- a/website/docs/concepts/about_hooks.mdx +++ b/website/docs/concepts/about_hooks.mdx @@ -56,7 +56,7 @@ In general, hooks are helpful for: - Forms - Animations - Reacting to user events -- ... +- etc. As an example, we could use hooks to manually implement a fade-in animation, where a widget starts invisible and slowly appears. diff --git a/website/docs/concepts/async_initialization.dart b/website/docs/concepts/async_initialization.dart index a006cf77d..8163a5896 100644 --- a/website/docs/concepts/async_initialization.dart +++ b/website/docs/concepts/async_initialization.dart @@ -1,8 +1,7 @@ -// ignore_for_file: omit_local_variable_types, prefer_final_locals +// ignore_for_file: omit_local_variable_types, prefer_final_locals, unreachable_from_main import 'package:flutter/material.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:flutter_riverpod/legacy.dart'; import 'package:shared_preferences/shared_preferences.dart'; class LoadingScreen extends StatelessWidget { @@ -15,15 +14,22 @@ class LoadingScreen extends StatelessWidget { } /* SNIPPET START */ -// We'd like to obtain an instance of shared preferences synchronously in a provider -final countProvider = StateProvider((ref) { - final preferences = ref.watch(sharedPreferencesProvider); - final currentValue = preferences.getInt('count') ?? 0; - ref.listenSelf((prev, curr) { - preferences.setInt('count', curr); - }); - return currentValue; -}); +final countProvider = NotifierProvider(CountNotifier.new); + +class CountNotifier extends Notifier { + @override + int build() { + // We'd like to obtain an instance of shared preferences synchronously in a provider + final preferences = ref.watch(sharedPreferencesProvider); + final currentValue = preferences.getInt('count') ?? 0; + listenSelf((prev, next) { + preferences.setInt('count', next); + }); + return currentValue; + } + + void increment() => state++; +} // We don't have an actual instance of SharedPreferences, and we can't get one except asynchronously final sharedPreferencesProvider = diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart index 8c5ea014e..dbab1b4e1 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.dart @@ -11,15 +11,15 @@ final dio = Dio(); // The current search filter @riverpod -String search(SearchRef ref) => ''; +String search(Ref ref) => ''; @riverpod -Stream configs(ConfigsRef ref) { +Stream configs(Ref ref) { return Stream.value(Configuration()); } @riverpod -Future> characters(CharactersRef ref) async { +Future> characters(Ref ref) async { final search = ref.watch(searchProvider); final configs = await ref.watch(configsProvider.future); final response = await dio.get>>( diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart index 42f2e78d3..dc6ac0c60 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -122,7 +122,7 @@ final class ConfigsProvider extends $FunctionalProvider< } } -String _$configsHash() => r'166cbe95e6b49ed7bc78c96041fb14abddbf6911'; +String _$configsHash() => r'6416514dacd408abb24de2bd1404860e6518c564'; typedef CharactersRef = Ref>>; @@ -178,7 +178,7 @@ final class CharactersProvider extends $FunctionalProvider< } } -String _$charactersHash() => r'b1e8e15bbeab60d92fe959d9e1dd4ceba6a31446'; +String _$charactersHash() => r'd2bac558571ceae538d012696be58e2a06e8013f'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.dart index 8b8f234b9..092367038 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.dart @@ -4,4 +4,4 @@ part 'codegen.g.dart'; /* SNIPPET START */ @riverpod -String city(CityRef ref) => 'London'; +String city(Ref ref) => 'London'; diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart index 730fd5cb5..b2002c0b7 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -66,7 +66,7 @@ final class CityProvider extends $FunctionalProvider } } -String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; +String _$cityHash() => r'6a5023a3aba119f1ecaee6c7db44b3f519e72759'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart index c224a8c57..4e16203ed 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.dart @@ -11,12 +11,12 @@ enum Filter { } @riverpod -Filter filter(FilterRef ref) => Filter.none; +Filter filter(Ref ref) => Filter.none; /* SNIPPET START */ @riverpod -List filteredTodoList(FilteredTodoListRef ref) { +List filteredTodoList(Ref ref) { final filter = ref.watch(filterProvider); final todos = ref.watch(todoListProvider); diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart index 853d26933..b7639677e 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -127,7 +127,7 @@ final class FilteredTodoListProvider } } -String _$filteredTodoListHash() => r'1c35eb0fce8fc7c7cda86413b02f606f8c8ae2b4'; +String _$filteredTodoListHash() => r'e0faf3934cd30a62b5771f2e4d64eaa727065c2f'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart index b1cb3dbe3..c76e47a97 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart @@ -3,14 +3,14 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; @riverpod -MyValue another(AnotherRef ref) => MyValue(); +MyValue another(Ref ref) => MyValue(); class MyValue {} /* SNIPPET START */ @riverpod -MyValue my(MyRef ref) { +MyValue my(Ref ref) { // Bad practice to call `read` here final value = ref.read(anotherProvider); return value; diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart index 4b37b373a..f7503cf38 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -66,7 +66,7 @@ final class AnotherProvider extends $FunctionalProvider } } -String _$anotherHash() => r'bb412edc55657c14eace37792cd18e5254604a36'; +String _$anotherHash() => r'07629e5ae4a53bcd316b91c07d7558edbdea9317'; typedef MyRef = Ref; @@ -126,7 +126,7 @@ final class MyProvider extends $FunctionalProvider } } -String _$myHash() => r'2712c772be4dbaabd4c99fd803f927a7e9938b21'; +String _$myHash() => r'816efc8816269dabd0944c434946903db197fe0b'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart index e44e202bc..0bdb6db69 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart @@ -1,4 +1,3 @@ - import 'package:dio/dio.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; @@ -11,13 +10,14 @@ final dio = Dio(); /* SNIPPET START */ @riverpod -Stream config(ConfigRef ref) => Stream.value(Configuration()); +Stream config(Ref ref) => Stream.value(Configuration()); @riverpod -Future> products(ProductsRef ref) async { +Future> products(Ref ref) async { // Listens only to the host. If something else in the configurations // changes, this will not pointlessly re-evaluate our provider. - final host = await ref.watch(configProvider.selectAsync((config) => config.host)); + final host = + await ref.watch(configProvider.selectAsync((config) => config.host)); final result = await dio.get>>('$host/products'); diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart index 7fb8dd81b..5175f017a 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -62,7 +62,7 @@ final class ConfigProvider extends $FunctionalProvider< } } -String _$configHash() => r'3021d1a8aac384e99d5d22714ffe6e868954888b'; +String _$configHash() => r'66f48a02bf939463649f0e7ad34137265e5c8b66'; typedef ProductsRef = Ref>>; @@ -118,7 +118,7 @@ final class ProductsProvider extends $FunctionalProvider< } } -String _$productsHash() => r'd1f4523880408cf8ee0e68969c40cf87d5c78557'; +String _$productsHash() => r'1915c65cef29cadc8b0adadd6ecddf753586974b'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart index e348a795b..786c6bb15 100644 --- a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$TodoList extends $Notifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart index 8f7af2644..a66b91521 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart @@ -3,14 +3,14 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; @riverpod -String city(CityRef ref) => 'London'; +String city(Ref ref) => 'London'; class Weather {} Future fetchWeather({required String city}) async => Weather(); /* SNIPPET START */ @riverpod -Future weather(WeatherRef ref) { +Future weather(Ref ref) { // We use `ref.watch` to listen to another provider, and we pass it the provider // that we want to consume. Here: cityProvider final city = ref.watch(cityProvider); diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart index 32ac94816..81459f14c 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -66,7 +66,7 @@ final class CityProvider extends $FunctionalProvider } } -String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; +String _$cityHash() => r'6a5023a3aba119f1ecaee6c7db44b3f519e72759'; typedef WeatherRef = Ref>; @@ -119,7 +119,7 @@ final class WeatherProvider } } -String _$weatherHash() => r'9a79d0269032630918eef9d3f562ff35b5860061'; +String _$weatherHash() => r'277f005f0a4ea0bc28eaa4bc6628ba2a5d1034c8'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart index 1a90008ed..cb3a1ec73 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart @@ -10,10 +10,10 @@ final dio = Dio(); /* SNIPPET START */ @riverpod -Stream config(ConfigRef ref) => Stream.value(Configuration()); +Stream config(Ref ref) => Stream.value(Configuration()); @riverpod -Future> products(ProductsRef ref) async { +Future> products(Ref ref) async { // Will cause productsProvider to re-fetch the products if anything in the // configurations changes final configs = await ref.watch(configProvider.future); diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart index b34376210..bbf51d481 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -62,7 +62,7 @@ final class ConfigProvider extends $FunctionalProvider< } } -String _$configHash() => r'3021d1a8aac384e99d5d22714ffe6e868954888b'; +String _$configHash() => r'66f48a02bf939463649f0e7ad34137265e5c8b66'; typedef ProductsRef = Ref>>; @@ -118,7 +118,7 @@ final class ProductsProvider extends $FunctionalProvider< } } -String _$productsHash() => r'637254615fa398af0d36e212f09e5d3d8ff866aa'; +String _$productsHash() => r'd0ddbfac09629b48b568f0cc07e063bb7d649162'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.dart index b881d7bf9..35f832a69 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.dart @@ -8,7 +8,7 @@ part 'codegen.g.dart'; /* SNIPPET START */ @riverpod -Stream example(ExampleRef ref) { +Stream example(Ref ref) { final streamController = StreamController(); ref.onDispose(() { diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart index 24597d983..52c546ac7 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart @@ -59,7 +59,7 @@ final class ExampleProvider } } -String _$exampleHash() => r'e2c4eb8a7cf06c7a0e5d07ee2bd51db254033fa6'; +String _$exampleHash() => r'ec358d3864f4c5daaab92153afd5cf79e915aebc'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.dart b/website/docs/concepts/providers/creating_a_provider/codegen.dart index 8dc6c5e12..15efd2d7a 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.dart @@ -7,6 +7,6 @@ class MyValue {} /* SNIPPET START */ @riverpod -MyValue my(MyRef ref) { +MyValue my(Ref ref) { return MyValue(); } diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart index 1478a2bd2..5671a1e78 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart @@ -66,7 +66,7 @@ final class MyProvider extends $FunctionalProvider } } -String _$myHash() => r'0810ee24cae78c131d00773ac20d254c83eefab7'; +String _$myHash() => r'abf4b86b981ed95db3f391483b0a1497c33e98b8'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.dart index 474fe004b..276cab4dd 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.dart @@ -5,6 +5,6 @@ part 'codegen.g.dart'; /* SNIPPET START */ @riverpod -String city(CityRef ref) => 'London'; +String city(Ref ref) => 'London'; @riverpod -String country(CountryRef ref) => 'England'; +String country(Ref ref) => 'England'; diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart index b3c4216c7..75fc805a3 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart @@ -66,7 +66,7 @@ final class CityProvider extends $FunctionalProvider } } -String _$cityHash() => r'2ccdee096b5d5c1cafa736b3e52b788431b9af38'; +String _$cityHash() => r'6a5023a3aba119f1ecaee6c7db44b3f519e72759'; typedef CountryRef = Ref; @@ -126,7 +126,7 @@ final class CountryProvider extends $FunctionalProvider } } -String _$countryHash() => r'd1513349c3bc0c99763cb4fb29eb012f2351bc4c'; +String _$countryHash() => r'9fabd1cffe35f15a0a03339193da2d646c260137'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/counter/codegen.dart b/website/docs/concepts/reading/counter/codegen.dart index a23405835..2b464eb1d 100644 --- a/website/docs/concepts/reading/counter/codegen.dart +++ b/website/docs/concepts/reading/counter/codegen.dart @@ -3,7 +3,7 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; @riverpod -Repository repository(RepositoryRef ref) => Repository(); +Repository repository(Ref ref) => Repository(); class Repository { Future post(String url) async {} diff --git a/website/docs/concepts/reading/counter/codegen.g.dart b/website/docs/concepts/reading/counter/codegen.g.dart index 862a2f9e3..22ed0e8c3 100644 --- a/website/docs/concepts/reading/counter/codegen.g.dart +++ b/website/docs/concepts/reading/counter/codegen.g.dart @@ -139,4 +139,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/listen/codegen.dart b/website/docs/concepts/reading/listen/codegen.dart index 0037c4c8d..b4531515a 100644 --- a/website/docs/concepts/reading/listen/codegen.dart +++ b/website/docs/concepts/reading/listen/codegen.dart @@ -8,7 +8,7 @@ part 'codegen.g.dart'; /* SNIPPET START */ @riverpod -void another(AnotherRef ref) { +void another(Ref ref) { ref.listen(counterProvider, (int? previousCount, int newCount) { print('The counter changed $newCount'); }); diff --git a/website/docs/concepts/reading/listen/codegen.g.dart b/website/docs/concepts/reading/listen/codegen.g.dart index 18edca4f4..cc379a6ae 100644 --- a/website/docs/concepts/reading/listen/codegen.g.dart +++ b/website/docs/concepts/reading/listen/codegen.g.dart @@ -66,7 +66,7 @@ final class AnotherProvider extends $FunctionalProvider } } -String _$anotherHash() => r'2208f9221f3d898305609874d4f43c28bdfff2b4'; +String _$anotherHash() => r'1901cd6ee57ea427f82e6d5bbee79e91ddf71065'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/listen_build/codegen.g.dart b/website/docs/concepts/reading/listen_build/codegen.g.dart index cca0f2498..9fd3d5b2f 100644 --- a/website/docs/concepts/reading/listen_build/codegen.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart index 37350b911..c01cf74b5 100644 --- a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/provider/codegen.dart b/website/docs/concepts/reading/provider/codegen.dart index 201c92f91..954941a9b 100644 --- a/website/docs/concepts/reading/provider/codegen.dart +++ b/website/docs/concepts/reading/provider/codegen.dart @@ -8,12 +8,12 @@ class Repository { } @riverpod -Repository repository(RepositoryRef ref) => Repository(); +Repository repository(Ref ref) => Repository(); /* SNIPPET START */ @riverpod -String value(ValueRef ref) { +String value(Ref ref) { // use ref to obtain other providers final repository = ref.watch(repositoryProvider); return repository.get(); diff --git a/website/docs/concepts/reading/provider/codegen.g.dart b/website/docs/concepts/reading/provider/codegen.g.dart index 5a44b7459..b56fef447 100644 --- a/website/docs/concepts/reading/provider/codegen.g.dart +++ b/website/docs/concepts/reading/provider/codegen.g.dart @@ -67,7 +67,7 @@ final class RepositoryProvider } } -String _$repositoryHash() => r'c6dc3b5b727028966b5b850b27ffc7294b485273'; +String _$repositoryHash() => r'6f859a9d70c3112139aaf826ee2bd541a4c001cb'; typedef ValueRef = Ref; @@ -127,7 +127,7 @@ final class ValueProvider extends $FunctionalProvider } } -String _$valueHash() => r'8c26f7aaa911af815cff9e513a18e4d8dcc6d1df'; +String _$valueHash() => r'fcb38a2d2c3755f3691e73cd163e8c895d1af4b5'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/read/codegen.g.dart b/website/docs/concepts/reading/read/codegen.g.dart index afde0445a..bd492c1e5 100644 --- a/website/docs/concepts/reading/read/codegen.g.dart +++ b/website/docs/concepts/reading/read/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/read/codegen_hooks.g.dart b/website/docs/concepts/reading/read/codegen_hooks.g.dart index b47bde380..e8fc5b198 100644 --- a/website/docs/concepts/reading/read/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/read/codegen_hooks.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/read_build/codegen.g.dart b/website/docs/concepts/reading/read_build/codegen.g.dart index afde0445a..bd492c1e5 100644 --- a/website/docs/concepts/reading/read_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_build/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart index afde0445a..bd492c1e5 100644 --- a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/watch/codegen.dart b/website/docs/concepts/reading/watch/codegen.dart index 31de6da74..947af2a51 100644 --- a/website/docs/concepts/reading/watch/codegen.dart +++ b/website/docs/concepts/reading/watch/codegen.dart @@ -16,7 +16,7 @@ abstract class Todo { /* SNIPPET START */ @riverpod -FilterType filterType(FilterTypeRef ref) { +FilterType filterType(Ref ref) { return FilterType.none; } @@ -29,7 +29,7 @@ class Todos extends _$Todos { } @riverpod -List filteredTodoList(FilteredTodoListRef ref) { +List filteredTodoList(Ref ref) { // obtains both the filter and the list of todos final FilterType filter = ref.watch(filterTypeProvider); final List todos = ref.watch(todosProvider); diff --git a/website/docs/concepts/reading/watch/codegen.g.dart b/website/docs/concepts/reading/watch/codegen.g.dart index a24d2c9f7..f99d9cb4b 100644 --- a/website/docs/concepts/reading/watch/codegen.g.dart +++ b/website/docs/concepts/reading/watch/codegen.g.dart @@ -67,7 +67,7 @@ final class FilterTypeProvider } } -String _$filterTypeHash() => r'42b68b163daecff7a0b9b069b16025a89910b4fb'; +String _$filterTypeHash() => r'68d61a593d49306927c26fbcc66ea9fffa7c52f5'; @ProviderFor(Todos) const todosProvider = TodosProvider._(); @@ -197,7 +197,7 @@ final class FilteredTodoListProvider } } -String _$filteredTodoListHash() => r'34f1e929a9e7850946ea8634d9f3e8f38ae5687d'; +String _$filteredTodoListHash() => r'0508935737f2cb9718bd8150111135cb433bfaeb'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/watch_build/codegen.dart b/website/docs/concepts/reading/watch_build/codegen.dart index 80b63d216..7224d1a33 100644 --- a/website/docs/concepts/reading/watch_build/codegen.dart +++ b/website/docs/concepts/reading/watch_build/codegen.dart @@ -24,7 +24,7 @@ class TodoList extends _$TodoList { /* SNIPPET START */ @riverpod -int counter(CounterRef ref) => 0; +int counter(Ref ref) => 0; class HomeView extends ConsumerWidget { const HomeView({super.key}); diff --git a/website/docs/concepts/reading/watch_build/codegen.g.dart b/website/docs/concepts/reading/watch_build/codegen.g.dart index 9c9fc7911..00f69cff1 100644 --- a/website/docs/concepts/reading/watch_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen.g.dart @@ -135,7 +135,7 @@ final class CounterProvider extends $FunctionalProvider } } -String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; +String _$counterHash() => r'784ece48cb20fcfdec1553774ecfbd381d1e081f'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/watch_build/codegen_hooks.dart b/website/docs/concepts/reading/watch_build/codegen_hooks.dart index c82698304..f9d721a17 100644 --- a/website/docs/concepts/reading/watch_build/codegen_hooks.dart +++ b/website/docs/concepts/reading/watch_build/codegen_hooks.dart @@ -25,7 +25,7 @@ class TodoList extends _$TodoList { /* SNIPPET START */ @riverpod -int counter(CounterRef ref) => 0; +int counter(Ref ref) => 0; class HomeView extends HookConsumerWidget { const HomeView({super.key}); diff --git a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart index 3a2f0b18c..59e10aff2 100644 --- a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart @@ -135,7 +135,7 @@ final class CounterProvider extends $FunctionalProvider } } -String _$counterHash() => r'9b0db44ecc47057e79891e5ecd92d34b08637679'; +String _$counterHash() => r'784ece48cb20fcfdec1553774ecfbd381d1e081f'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart index afde0445a..bd492c1e5 100644 --- a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Counter extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/concepts/scopes.mdx b/website/docs/concepts/scopes.mdx index ec97f6ec6..4faf0541b 100644 --- a/website/docs/concepts/scopes.mdx +++ b/website/docs/concepts/scopes.mdx @@ -1,6 +1,6 @@ --- title: Scopes -version: 1 +version: 2 --- import CodeBlock from "@theme/CodeBlock"; diff --git a/website/docs/concepts/why_immutability/codegen.g.dart b/website/docs/concepts/why_immutability/codegen.g.dart index b73742a3e..acb6c8147 100644 --- a/website/docs/concepts/why_immutability/codegen.g.dart +++ b/website/docs/concepts/why_immutability/codegen.g.dart @@ -79,4 +79,4 @@ abstract class _$ThemeNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/cache_for_extension.dart b/website/docs/essentials/auto_dispose/cache_for_extension.dart index 9acb4b558..7e6a4e00d 100644 --- a/website/docs/essentials/auto_dispose/cache_for_extension.dart +++ b/website/docs/essentials/auto_dispose/cache_for_extension.dart @@ -3,7 +3,7 @@ import 'dart:async'; import 'package:hooks_riverpod/hooks_riverpod.dart'; /* SNIPPET START */ -extension CacheForExtension on Ref { +extension CacheForExtension on Ref { // {@template cacheFor} /// Keeps the provider alive for [duration]. // {@endtemplate} diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart index 7775e7930..a19f6a897 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart @@ -9,7 +9,7 @@ part 'codegen.g.dart'; /* SNIPPET START */ @riverpod -Future example(ExampleRef ref) async { +Future example(Ref ref) async { // {@template cacheFor} /// Keeps the state alive for 5 minutes // {@endtemplate} diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart index 00844f23c..9faef92af 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -59,7 +59,7 @@ final class ExampleProvider } } -String _$exampleHash() => r'3ff29b1cd8fa864286a2a04e39adf1c8589b4275'; +String _$exampleHash() => r'7721b15eade2919325624bb7c4fd0bfb0cfc3e68'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.dart index 67b34d0bf..74af13186 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.dart @@ -8,6 +8,6 @@ part 'codegen_keep_alive.g.dart'; // the automatic state destruction // {@endtemplate} @Riverpod(keepAlive: true) -int example(ExampleRef ref) { +int example(Ref ref) { return 0; } diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart index cf88fefa9..9dca89cd2 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -66,7 +66,7 @@ final class ExampleProvider extends $FunctionalProvider } } -String _$exampleHash() => r'78f9426f6cbda80564387a9db8cd02368d890a85'; +String _$exampleHash() => r'd11e74682b7fd8010a0c2815b780a44a15b7a3da'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.dart index 73f432104..fd347f6e4 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.dart @@ -9,7 +9,7 @@ late WidgetRef ref; /* SNIPPET START */ @riverpod -String label(LabelRef ref, String userName) { +String label(Ref ref, String userName) { return 'Hello $userName'; } diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index 875115020..19a06c2cf 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -96,7 +96,7 @@ final class LabelProvider extends $FunctionalProvider } } -String _$labelHash() => r'20aa8ce0231205540f466f91259732bd86953c64'; +String _$labelHash() => r'c53d17dd111313633bd7ca6d6cf6b48dded58ca5'; final class LabelFamily extends Family { const LabelFamily._() @@ -141,4 +141,4 @@ final class LabelFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.dart index 83f4c8a59..a3f17cc7c 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.dart @@ -7,7 +7,7 @@ part 'codegen.g.dart'; /* SNIPPET START */ @riverpod -Future example(ExampleRef ref) async { +Future example(Ref ref) async { final response = await http.get(Uri.parse('https://example.com')); // {@template keepAlive} // We keep the provider alive only after the request has successfully completed. diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart index 4a1969448..4e8ac232f 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -59,7 +59,7 @@ final class ExampleProvider } } -String _$exampleHash() => r'4fa856c55e84da9525dcecfab1c897e61456325b'; +String _$exampleHash() => r'47fbbb04e2e5aef4d37c361939a7df40ef05e851'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart index 3f586a185..a7eafb658 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart @@ -7,11 +7,11 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; @riverpod -int other(OtherRef ref) => 0; +int other(Ref ref) => 0; /* SNIPPET START */ @riverpod -Stream example(ExampleRef ref) { +Stream example(Ref ref) { final controller = StreamController(); // {@template onDispose} diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart index 2b3a36b69..8837784c1 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -66,7 +66,7 @@ final class OtherProvider extends $FunctionalProvider } } -String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; +String _$otherHash() => r'5d27b2b1b1c6bd17ba0844f74ade2088611be371'; typedef ExampleRef = Ref>; @@ -119,7 +119,7 @@ final class ExampleProvider } } -String _$exampleHash() => r'29f92958e0d0e3f13ac033e92cd2e4072339c7db'; +String _$exampleHash() => r'012c40f45aaeb96633a857d1407f04d25255f32f'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests.mdx b/website/docs/essentials/combining_requests.mdx index ccd32c941..c629dfbd7 100644 --- a/website/docs/essentials/combining_requests.mdx +++ b/website/docs/essentials/combining_requests.mdx @@ -1,6 +1,6 @@ --- title: Combining requests -version: 2 +version: 3 --- import { Link } from "/src/components/Link"; @@ -104,7 +104,7 @@ phase of the provider. This includes "listener" callbacks or methods on Notifier ::: -## The `ref.listen`/`listenSelf` methods. +## The `ref.listen` methods. The `ref.listen` method is an alternative to `ref.watch`. It is similar to your traditional "listen"/"addListener" method. It takes a provider diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.dart index f51c3c34b..e776d8c31 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.dart @@ -5,11 +5,11 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; @riverpod -int other(OtherRef ref) => 0; +int other(Ref ref) => 0; /* SNIPPET START */ @riverpod -int example(ExampleRef ref) { +int example(Ref ref) { // {@template provider} // "Ref" can be used here to read other providers // {@endtemplate} diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart index fa3bc6d72..f8b8fccc8 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart @@ -66,7 +66,7 @@ final class OtherProvider extends $FunctionalProvider } } -String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; +String _$otherHash() => r'5d27b2b1b1c6bd17ba0844f74ade2088611be371'; typedef ExampleRef = Ref; @@ -126,7 +126,7 @@ final class ExampleProvider extends $FunctionalProvider } } -String _$exampleHash() => r'4429d7d3bb2b31fea4cc42c2f2af02d3f3d10693'; +String _$exampleHash() => r'6115819b119e2f16f22c69aae827632e3b585775'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.dart b/website/docs/essentials/combining_requests/listen_example/codegen.dart index 7a417d13b..8de5958a6 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.dart @@ -5,11 +5,11 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; @riverpod -int other(OtherRef ref) => 0; +int other(Ref ref) => 0; /* SNIPPET START */ @riverpod -int example(ExampleRef ref) { +int example(Ref ref) { ref.listen(otherProvider, (previous, next) { print('Changed from: $previous, next: $next'); }); diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart index 164310b3c..d5773ce92 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart @@ -126,7 +126,7 @@ final class ExampleProvider extends $FunctionalProvider } } -String _$exampleHash() => r'd614303f372e06e6ab96035affc4c07a53b28741'; +String _$exampleHash() => r'42a795719de4bd2ec79f315aaaf87d1c89ebf063'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.dart index 1f9922ff4..c184574c3 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.dart @@ -5,7 +5,7 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; @riverpod -int other(OtherRef ref) => 0; +int other(Ref ref) => 0; /* SNIPPET START */ @riverpod diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart index 04806fe6d..39ba403d8 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -66,7 +66,7 @@ final class OtherProvider extends $FunctionalProvider } } -String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; +String _$otherHash() => r'5d27b2b1b1c6bd17ba0844f74ade2088611be371'; @ProviderFor(Example) const exampleProvider = ExampleProvider._(); @@ -138,4 +138,4 @@ abstract class _$Example extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/read_example/codegen.dart b/website/docs/essentials/combining_requests/read_example/codegen.dart index 8ae074d63..0e3e09226 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.dart @@ -5,7 +5,7 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; @riverpod -int other(OtherRef ref) => 0; +int other(Ref ref) => 0; /* SNIPPET START */ @riverpod diff --git a/website/docs/essentials/combining_requests/read_example/codegen.g.dart b/website/docs/essentials/combining_requests/read_example/codegen.g.dart index 21ea570da..5bca74f74 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.g.dart @@ -138,4 +138,4 @@ abstract class _$MyNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/watch_example/codegen.dart b/website/docs/essentials/combining_requests/watch_example/codegen.dart index c800279d4..55a72d895 100644 --- a/website/docs/essentials/combining_requests/watch_example/codegen.dart +++ b/website/docs/essentials/combining_requests/watch_example/codegen.dart @@ -2,6 +2,7 @@ import 'dart:convert'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; @@ -14,7 +15,7 @@ const someStream = Stream<({double longitude, double latitude})>.empty(); /* SNIPPET START */ @riverpod -Stream<({double longitude, double latitude})> location(LocationRef ref) { +Stream<({double longitude, double latitude})> location(Ref ref) { // {@template provider} // TO-DO: Return a stream which obtains the current location // {@endtemplate} @@ -22,7 +23,7 @@ Stream<({double longitude, double latitude})> location(LocationRef ref) { } @riverpod -Future> restaurantsNearMe(RestaurantsNearMeRef ref) async { +Future> restaurantsNearMe(Ref ref) async { // {@template watch} // We use "ref.watch" to obtain the latest location. // By specifying that ".future" after the provider, our code will wait diff --git a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart index f2c48aa58..0253aa2e0 100644 --- a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart @@ -63,7 +63,7 @@ final class LocationProvider extends $FunctionalProvider< } } -String _$locationHash() => r'22e666f1e1ce04ce03d8f8d5652e25b54c1d1af3'; +String _$locationHash() => r'39328e5d0ec2b97acec14f1aba6c8db3f24f46a8'; typedef RestaurantsNearMeRef = Ref>>; @@ -119,7 +119,7 @@ final class RestaurantsNearMeProvider extends $FunctionalProvider< } } -String _$restaurantsNearMeHash() => r'dd49cc1e6f16abb34dd15286d171e322c06b93b8'; +String _$restaurantsNearMeHash() => r'f577a4362db45208cd34f499d73f39f284807d13'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.dart index 36f97a531..d5a9cd653 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.dart @@ -6,11 +6,11 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; @riverpod -int other(OtherRef ref) => 0; +int other(Ref ref) => 0; /* SNIPPET START */ @riverpod -int example(ExampleRef ref) { +int example(Ref ref) { ref.watch(otherProvider); // Good! ref.onDispose(() => ref.watch(otherProvider)); // Bad! diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart index 88dd570d3..d73558063 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart @@ -126,7 +126,7 @@ final class ExampleProvider extends $FunctionalProvider } } -String _$exampleHash() => r'd4d63f5cf1aaec5b7c6a19e6fee18ddf070147ec'; +String _$exampleHash() => r'fed2d2be4787bc4a715efa198a89a297967b54a1'; @ProviderFor(MyNotifier) const myNotifierProvider = MyNotifierProvider._(); @@ -198,4 +198,4 @@ abstract class _$MyNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/eager_initialization/require_value/codegen.dart b/website/docs/essentials/eager_initialization/require_value/codegen.dart index 287f18063..314f78b23 100644 --- a/website/docs/essentials/eager_initialization/require_value/codegen.dart +++ b/website/docs/essentials/eager_initialization/require_value/codegen.dart @@ -11,7 +11,7 @@ part 'codegen.g.dart'; // An eagerly initialized provider. // {@endtemplate} @riverpod -Future example(ExampleRef ref) async => 'Hello world'; +Future example(Ref ref) async => 'Hello world'; class MyConsumer extends ConsumerWidget { @override diff --git a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart index 4eaf1bcf3..0753091c3 100644 --- a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart +++ b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart @@ -59,7 +59,7 @@ final class ExampleProvider } } -String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; +String _$exampleHash() => r'8768b72378809f5cb6ae94b65493cbb49bd23b77'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/first_request.mdx b/website/docs/essentials/first_request.mdx index 8d52f4205..9b64ad3d7 100644 --- a/website/docs/essentials/first_request.mdx +++ b/website/docs/essentials/first_request.mdx @@ -179,7 +179,7 @@ Subsequent reads will not call the function again, but instead return the cached } `} @@ -219,7 +219,7 @@ Subsequent reads will not call the function again, but instead return the cached }, { offset: 28, - length: 17, + length: 7, label: "Ref", description: <> diff --git a/website/docs/essentials/first_request/codegen/provider.dart b/website/docs/essentials/first_request/codegen/provider.dart index 0ba64ec53..9a68b34be 100644 --- a/website/docs/essentials/first_request/codegen/provider.dart +++ b/website/docs/essentials/first_request/codegen/provider.dart @@ -15,7 +15,7 @@ part 'provider.g.dart'; /// which will cache the result of this function. // {@endtemplate} @riverpod -Future activity(ActivityRef ref) async { +Future activity(Ref ref) async { // {@template response} // Using package:http, we fetch a random activity from the Bored API. // {@endtemplate} diff --git a/website/docs/essentials/first_request/codegen/provider.g.dart b/website/docs/essentials/first_request/codegen/provider.g.dart index 466fbdd3f..235e2ffda 100644 --- a/website/docs/essentials/first_request/codegen/provider.g.dart +++ b/website/docs/essentials/first_request/codegen/provider.g.dart @@ -71,7 +71,7 @@ final class ActivityProvider } } -String _$activityHash() => r'636cd5510e09cbfc46f31b74a70d9e98c89e95a4'; +String _$activityHash() => r'c90b5d6502e5e4c31a2fa8c974683171cad8f38f'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/passing_args/family/codegen.dart b/website/docs/essentials/passing_args/family/codegen.dart index b5e4cee05..ab4743a20 100644 --- a/website/docs/essentials/passing_args/family/codegen.dart +++ b/website/docs/essentials/passing_args/family/codegen.dart @@ -12,7 +12,7 @@ Future fetchActivity() => throw UnimplementedError(); /* SNIPPET START */ @riverpod Future activity( - ActivityRef ref, + Ref ref, // {@template codegen_activityType} // We can add arguments to the provider. // The type of the parameter can be whatever you wish. diff --git a/website/docs/essentials/passing_args/family/codegen.g.dart b/website/docs/essentials/passing_args/family/codegen.g.dart index 46a54342a..e9b7005ff 100644 --- a/website/docs/essentials/passing_args/family/codegen.g.dart +++ b/website/docs/essentials/passing_args/family/codegen.g.dart @@ -89,7 +89,7 @@ final class ActivityProvider } } -String _$activityHash() => r'cb76e67cd45f1823d3ed497a235be53819ce2eaf'; +String _$activityHash() => r'6c815736c0d2b40a92695adcd78516534d7ac2fc'; final class ActivityFamily extends Family { const ActivityFamily._() @@ -290,4 +290,4 @@ abstract class _$ActivityNotifier2 extends $AsyncNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/passing_args/no_arg_provider/codegen.dart b/website/docs/essentials/passing_args/no_arg_provider/codegen.dart index 7e2f1ded9..da1c34adb 100644 --- a/website/docs/essentials/passing_args/no_arg_provider/codegen.dart +++ b/website/docs/essentials/passing_args/no_arg_provider/codegen.dart @@ -13,7 +13,7 @@ FutureOr fetchActivity() => throw UnimplementedError(); // A "functional" provider // {@endtemplate} @riverpod -Future activity(ActivityRef ref) async { +Future activity(Ref ref) async { // {@template fetchActivity} // TODO: perform a network request to fetch an activity // {@endtemplate} diff --git a/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart b/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart index 56192f6e8..a0f80d2fd 100644 --- a/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart +++ b/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart @@ -59,7 +59,7 @@ final class ActivityProvider } } -String _$activityHash() => r'2f9496c5d70de9314c67e5c48ac44d8b149bc471'; +String _$activityHash() => r'7b532e70a92d6bc198900ca61f0e714c5484c34d'; @ProviderFor(ActivityNotifier2) const activityNotifier2Provider = ActivityNotifier2Provider._(); @@ -124,4 +124,4 @@ abstract class _$ActivityNotifier2 extends $AsyncNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart index 4e3b431dd..57729a100 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -86,4 +86,4 @@ abstract class _$TodoList extends $AsyncNotifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart index e42591301..d72057c23 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -71,4 +71,4 @@ abstract class _$TodoList extends $AsyncNotifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.dart index 8e1b799e1..f0a84c83a 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.dart @@ -14,7 +14,7 @@ class Todo with _$Todo { /* SNIPPET START */ @riverpod -Future> todoList(TodoListRef ref) async { +Future> todoList(Ref ref) async { // {@template note} // Simulate a network request. This would normally come from a real API // {@endtemplate} diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart index 811989448..dbf63d019 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -59,7 +59,7 @@ final class TodoListProvider } } -String _$todoListHash() => r'26b30307668c8feefa7cbe3c400b73e6edccbc39'; +String _$todoListHash() => r'79ea254a2b6239c9fbcc2b5e6f075a3e5b72598e'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/testing/notifier_mock/codegen.g.dart b/website/docs/essentials/testing/notifier_mock/codegen.g.dart index 860998b23..403e0448f 100644 --- a/website/docs/essentials/testing/notifier_mock/codegen.g.dart +++ b/website/docs/essentials/testing/notifier_mock/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$MyNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.dart b/website/docs/essentials/testing/provider_to_mock/codegen.dart index 9811c1ed9..073779b2d 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.dart @@ -7,5 +7,5 @@ part 'codegen.g.dart'; // An eagerly initialized provider. // {@endtemplate} @riverpod -Future example(ExampleRef ref) async => 'Hello world'; +Future example(Ref ref) async => 'Hello world'; /* SNIPPET END */ diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart index 4eaf1bcf3..0753091c3 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart @@ -59,7 +59,7 @@ final class ExampleProvider } } -String _$exampleHash() => r'd421d08db0ee9d10af5521159561135d8c5fa57c'; +String _$exampleHash() => r'8768b72378809f5cb6ae94b65493cbb49bd23b77'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.dart index b9af5a491..0cc75bea6 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.dart @@ -11,7 +11,7 @@ part 'pipe_change_notifier.g.dart'; /// whenever the value changes. // {@endtemplate} @riverpod -Raw> myListenable(MyListenableRef ref) { +Raw> myListenable(Ref ref) { final notifier = ValueNotifier(0); // {@template onDispose} diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart index f54e1dfc4..5d83c1e63 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -80,7 +80,7 @@ final class MyListenableProvider extends $FunctionalProvider< } } -String _$myListenableHash() => r'c80799a0224092668fca44187b98ccfcd2b33ae1'; +String _$myListenableHash() => r'11b973997ad9787b8f775746d7a87211df2cb6bb'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/raw_usage.dart b/website/docs/essentials/websockets_sync/raw_usage.dart index b2fd409a6..a42bf0fc2 100644 --- a/website/docs/essentials/websockets_sync/raw_usage.dart +++ b/website/docs/essentials/websockets_sync/raw_usage.dart @@ -8,7 +8,7 @@ part 'raw_usage.g.dart'; /* SNIPPET START */ @riverpod -Raw> rawStream(RawStreamRef ref) { +Raw> rawStream(Ref ref) { // {@template provider} // "Raw" is a typedef. No need to wrap the return // value in a "Raw" constructor. diff --git a/website/docs/essentials/websockets_sync/raw_usage.g.dart b/website/docs/essentials/websockets_sync/raw_usage.g.dart index b184bb7e5..58feb279f 100644 --- a/website/docs/essentials/websockets_sync/raw_usage.g.dart +++ b/website/docs/essentials/websockets_sync/raw_usage.g.dart @@ -67,7 +67,7 @@ final class RawStreamProvider } } -String _$rawStreamHash() => r'7e7c2e8f4f08d33a4d86d60449e143c419ca4822'; +String _$rawStreamHash() => r'9ce48e3afce64329958af139c77f5e271e0bf04f'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart index f155f3403..e36e7c732 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart @@ -22,11 +22,11 @@ extension on Ref { } @riverpod -Raw> myListenable(MyListenableRef ref) { +Raw> myListenable(Ref ref) { return ref.disposeAndListenChangeNotifier(ValueNotifier(0)); } @riverpod -Raw> anotherListenable(AnotherListenableRef ref) { +Raw> anotherListenable(Ref ref) { return ref.disposeAndListenChangeNotifier(ValueNotifier(42)); } diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart index 55e808c20..3fc9c9629 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -68,7 +68,7 @@ final class MyListenableProvider extends $FunctionalProvider< } } -String _$myListenableHash() => r'90f4227ef5442f978d742115663e5f0869622a27'; +String _$myListenableHash() => r'a28ce39430582e0d7be5f8303a31477569153193'; typedef AnotherListenableRef = Ref>>; @@ -130,7 +130,7 @@ final class AnotherListenableProvider extends $FunctionalProvider< } } -String _$anotherListenableHash() => r'50dd36b21e07c50818944ec49f9e68d21fcae876'; +String _$anotherListenableHash() => r'49aab48c26d8596262c3d89e0190baeaf9d7ac4a'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.dart index 1af14c68e..e80ec7478 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.dart @@ -8,7 +8,7 @@ part 'codegen.g.dart'; /* SNIPPET START */ @riverpod -Stream streamExample(StreamExampleRef ref) async* { +Stream streamExample(Ref ref) async* { // {@template provider} // Every 1 second, yield a number from 0 to 41. // This could be replaced with a Stream from Firestore or GraphQL or anything else. diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart index 6306dcf86..ac7abc116 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -59,7 +59,7 @@ final class StreamExampleProvider } } -String _$streamExampleHash() => r'ca9993b22f6d587b20c041133cacd28d01933074'; +String _$streamExampleHash() => r'5f0e824562e820b85cc0d031a7fcce1d381023a5'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.dart index dbccd14aa..cdddcb32d 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.dart @@ -4,7 +4,7 @@ part 'codegen.g.dart'; /* SNIPPET START */ @riverpod -int synchronousExample(SynchronousExampleRef ref) { +int synchronousExample(Ref ref) { return 0; } /* SNIPPET END */ diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart index a16299830..ad6845854 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -67,7 +67,7 @@ final class SynchronousExampleProvider extends $FunctionalProvider } String _$synchronousExampleHash() => - r'98df96e07d554683041f668c06b36f183ff534c1'; + r'a12577c395d5a639fdad88b28309f378a64bd2a7'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/family/family.dart b/website/docs/from_provider/family/family.dart index 4d49c552a..61cf268fc 100644 --- a/website/docs/from_provider/family/family.dart +++ b/website/docs/from_provider/family/family.dart @@ -6,6 +6,6 @@ part 'family.g.dart'; /* SNIPPET START */ @riverpod -int random(RandomRef ref, {required int seed, required int max}) { +int random(Ref ref, {required int seed, required int max}) { return Random(seed).nextInt(max); } diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index 4e89b9640..2d63f67fd 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -110,7 +110,7 @@ final class RandomProvider extends $FunctionalProvider } } -String _$randomHash() => r'517b12aad4df7b31f8872b89af74e7880377b2ea'; +String _$randomHash() => r'ab69799dce84746b22880feae0f1db6dea906f6a'; final class RandomFamily extends Family { const RandomFamily._() @@ -165,4 +165,4 @@ final class RandomFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/motivation/async_values/async_values.dart b/website/docs/from_provider/motivation/async_values/async_values.dart index 802a23150..0518dc0a7 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.dart @@ -10,7 +10,7 @@ part 'async_values.g.dart'; /* SNIPPET START */ @riverpod -Future> itemsApi(ItemsApiRef ref) async { +Future> itemsApi(Ref ref) async { final client = Dio(); final result = await client.get>('your-favorite-api'); final parsed = [...result.data!.map((e) => Item.fromJson(e as Json))]; @@ -18,7 +18,7 @@ Future> itemsApi(ItemsApiRef ref) async { } @riverpod -List evenItems(EvenItemsRef ref) { +List evenItems(Ref ref) { final asyncValue = ref.watch(itemsApiProvider); if (asyncValue.isReloading) return []; if (asyncValue.hasError) return const [Item(id: -1)]; diff --git a/website/docs/from_provider/motivation/async_values/async_values.g.dart b/website/docs/from_provider/motivation/async_values/async_values.g.dart index bb9202a05..7b61c6df3 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.g.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.g.dart @@ -59,7 +59,7 @@ final class ItemsApiProvider } } -String _$itemsApiHash() => r'b32ccb7b85305e361d8ed752cbe11d9524c96190'; +String _$itemsApiHash() => r'fa5a8f7e93ac048d9bd5dfc1744749995cf154af'; typedef EvenItemsRef = Ref>; @@ -120,7 +120,7 @@ final class EvenItemsProvider } } -String _$evenItemsHash() => r'55ae98f9b6108203dfc4a139f1ade9fbd8ba8ddd'; +String _$evenItemsHash() => r'22297e33c5f55ff99fb49747c203be595a28fabf'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart index 956d888f5..052686f61 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart @@ -10,7 +10,7 @@ part 'auto_dispose.g.dart'; // With code gen, .autoDispose is the default // {@endtemplate} @riverpod -int diceRoll(DiceRollRef ref) { +int diceRoll(Ref ref) { // {@template dice} // Since this provider is .autoDispose, un-listening to it will dispose // its current exposed state. @@ -22,7 +22,7 @@ int diceRoll(DiceRollRef ref) { } @riverpod -int cachedDiceRoll(CachedDiceRollRef ref) { +int cachedDiceRoll(Ref ref) { final coin = Random().nextInt(10); if (coin > 5) throw Exception('Way too large.'); // {@template keepAlive} diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart index 47fdddd7f..289213187 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -66,7 +66,7 @@ final class DiceRollProvider extends $FunctionalProvider } } -String _$diceRollHash() => r'dfd5ac8b74351a0076da9d131c10277f53ff11b9'; +String _$diceRollHash() => r'58d43e5143bb64e855939d55a3be3ee81d66c518'; typedef CachedDiceRollRef = Ref; @@ -126,7 +126,7 @@ final class CachedDiceRollProvider extends $FunctionalProvider } } -String _$cachedDiceRollHash() => r'fc31fcb804f10360d75362e56329976343ee7abb'; +String _$cachedDiceRollHash() => r'eaf5bb809278298f16e2eda8972b1876921f66f5'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/motivation/combine/combine.dart b/website/docs/from_provider/motivation/combine/combine.dart index ecd1915da..521d231b7 100644 --- a/website/docs/from_provider/motivation/combine/combine.dart +++ b/website/docs/from_provider/motivation/combine/combine.dart @@ -7,12 +7,12 @@ part 'combine.g.dart'; /* SNIPPET START */ @riverpod -int number(NumberRef ref) { +int number(Ref ref) { return Random().nextInt(10); } @riverpod -int doubled(DoubledRef ref) { +int doubled(Ref ref) { final number = ref.watch(numberProvider); return number * 2; diff --git a/website/docs/from_provider/motivation/combine/combine.g.dart b/website/docs/from_provider/motivation/combine/combine.g.dart index 1c8a14477..2b4fd8e2f 100644 --- a/website/docs/from_provider/motivation/combine/combine.g.dart +++ b/website/docs/from_provider/motivation/combine/combine.g.dart @@ -66,7 +66,7 @@ final class NumberProvider extends $FunctionalProvider } } -String _$numberHash() => r'725e25be57b9cc2bd914752f156e26a214596b63'; +String _$numberHash() => r'03ac91d5904c18f04321b140fd263ed6bc85d3c1'; typedef DoubledRef = Ref; @@ -126,7 +126,7 @@ final class DoubledProvider extends $FunctionalProvider } } -String _$doubledHash() => r'ddc640c876bdbe49fe72fe1632b5ff48687c9279'; +String _$doubledHash() => r'2a7f7fadb89e55d6adcf11aaa21943c66b10df5e'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/motivation/same_type/same_type.dart b/website/docs/from_provider/motivation/same_type/same_type.dart index 94a4ab086..a46db40cf 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.dart @@ -8,12 +8,12 @@ part 'same_type.g.dart'; /* SNIPPET START */ @riverpod -List items(ItemsRef ref) { +List items(Ref ref) { return []; // ... } @riverpod -List evenItems(EvenItemsRef ref) { +List evenItems(Ref ref) { final items = ref.watch(itemsProvider); return [...items.whereIndexed((index, element) => index.isEven)]; } diff --git a/website/docs/from_provider/motivation/same_type/same_type.g.dart b/website/docs/from_provider/motivation/same_type/same_type.g.dart index 2d52f8876..0f5682add 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.g.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.g.dart @@ -66,7 +66,7 @@ final class ItemsProvider extends $FunctionalProvider, List> } } -String _$itemsHash() => r'f0a8fa6874f4868db9ead31e82c75d976f9d2033'; +String _$itemsHash() => r'8dafed1afc3fc52651c24445640d8b57ff080f66'; typedef EvenItemsRef = Ref>; @@ -127,7 +127,7 @@ final class EvenItemsProvider } } -String _$evenItemsHash() => r'82b4525e91604745f2b4664531b32d4aff5717d4'; +String _$evenItemsHash() => r'83ef608e2e1ec6926495f7a4dd4bac3e6b1f16e1'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/from_provider/quickstart.mdx b/website/docs/from_provider/quickstart.mdx index 820d2e247..d11545fb6 100644 --- a/website/docs/from_provider/quickstart.mdx +++ b/website/docs/from_provider/quickstart.mdx @@ -167,7 +167,7 @@ And then, you can expose your `ChangeNotifier` with the following codegen syntax ```dart // ignore_for_file: unsupported_provider_value @riverpod -MyNotifier example(ExampleRef ref) { +MyNotifier example(Ref ref) { return ref.listenAndDisposeChangeNotifier(MyNotifier()); } ``` diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.dart b/website/docs/introduction/getting_started/dart_hello_world/main.dart index 09380505c..c265b837a 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.dart @@ -11,7 +11,7 @@ part 'main.g.dart'; // By using a provider, this allows us to mock/override the value exposed. // {@endtemplate} @riverpod -String helloWorld(HelloWorldRef ref) { +String helloWorld(Ref ref) { return 'Hello world'; } diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart index 82564d247..cd7ab0585 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart @@ -66,7 +66,7 @@ final class HelloWorldProvider extends $FunctionalProvider } } -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +String _$helloWorldHash() => r'9abaa5ab530c55186861f2debdaa218aceacb7eb'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.dart b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.dart index a3091e132..cb84e0e85 100644 --- a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.dart +++ b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.dart @@ -14,7 +14,7 @@ part 'main.g.dart'; // By using a provider, this allows us to mock/override the value exposed. // {@endtemplate} @riverpod -String helloWorld(HelloWorldRef ref) { +String helloWorld(Ref ref) { return 'Hello world'; } diff --git a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart index 82564d247..cd7ab0585 100644 --- a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -66,7 +66,7 @@ final class HelloWorldProvider extends $FunctionalProvider } } -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +String _$helloWorldHash() => r'9abaa5ab530c55186861f2debdaa218aceacb7eb'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/introduction/getting_started/hello_world/main.dart b/website/docs/introduction/getting_started/hello_world/main.dart index 22b1e3eef..622956be6 100644 --- a/website/docs/introduction/getting_started/hello_world/main.dart +++ b/website/docs/introduction/getting_started/hello_world/main.dart @@ -13,7 +13,7 @@ part 'main.g.dart'; // By using a provider, this allows us to mock/override the value exposed. // {@endtemplate} @riverpod -String helloWorld(HelloWorldRef ref) { +String helloWorld(Ref ref) { return 'Hello world'; } diff --git a/website/docs/introduction/getting_started/hello_world/main.g.dart b/website/docs/introduction/getting_started/hello_world/main.g.dart index 82564d247..cd7ab0585 100644 --- a/website/docs/introduction/getting_started/hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/main.g.dart @@ -66,7 +66,7 @@ final class HelloWorldProvider extends $FunctionalProvider } } -String _$helloWorldHash() => r'8bbe6cff2b7b1f4e1f7be3d1820da793259f7bfc'; +String _$helloWorldHash() => r'9abaa5ab530c55186861f2debdaa218aceacb7eb'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/introduction/why_riverpod.mdx b/website/docs/introduction/why_riverpod.mdx index 51e880c03..8dffc3566 100644 --- a/website/docs/introduction/why_riverpod.mdx +++ b/website/docs/introduction/why_riverpod.mdx @@ -41,7 +41,7 @@ amount of features, such as: - Cancelling asynchronous requests when no-longer used - Optimistic UIs - Offline mode -- ... +- etc. These features can be tricky to implement, but are crucial for a good user experience. Yet few packages try to tackle those problems directly, and a lot of the work diff --git a/website/docs/introduction/why_riverpod/codegen.dart b/website/docs/introduction/why_riverpod/codegen.dart index e1f66c59b..bd784d449 100644 --- a/website/docs/introduction/why_riverpod/codegen.dart +++ b/website/docs/introduction/why_riverpod/codegen.dart @@ -18,7 +18,7 @@ class Package { // {@endtemplate} @riverpod Future> fetchPackages( - FetchPackagesRef ref, { + Ref ref, { required int page, String search = '', }) async { diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index e30a97e36..156d2a12d 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -106,7 +106,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< } } -String _$fetchPackagesHash() => r'eebf7d838a57f493fffebfd2c8d8ab76d3233165'; +String _$fetchPackagesHash() => r'4b2c6ea2cd702ab0f9846ba19c945d2c43161605'; final class FetchPackagesFamily extends Family { const FetchPackagesFamily._() @@ -161,4 +161,4 @@ final class FetchPackagesFamily extends Family { } } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart index e71a9d949..55bfc4490 100644 --- a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart +++ b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart @@ -71,4 +71,4 @@ abstract class _$MyNotifier extends $AsyncNotifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart index 474896c77..e9ea97aa9 100644 --- a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart +++ b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart @@ -71,4 +71,4 @@ abstract class _$MyNotifier extends $AsyncNotifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart index 9fa60b6d3..27e13530d 100644 --- a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart +++ b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart @@ -71,4 +71,4 @@ abstract class _$MyNotifier extends $AsyncNotifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/add_listener/add_listener.dart b/website/docs/migration/from_state_notifier/add_listener/add_listener.dart index ead1c72d8..780be14a9 100644 --- a/website/docs/migration/from_state_notifier/add_listener/add_listener.dart +++ b/website/docs/migration/from_state_notifier/add_listener/add_listener.dart @@ -10,7 +10,7 @@ part 'add_listener.g.dart'; class MyNotifier extends _$MyNotifier { @override int build() { - ref.listenSelf((_, next) => debugPrint('$next')); + listenSelf((_, next) => debugPrint('$next')); return 0; } diff --git a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart index 783472ad4..14da5b2ae 100644 --- a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart +++ b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -68,7 +68,7 @@ final class MyNotifierProvider extends $NotifierProvider { $NotifierProviderElement(this, pointer); } -String _$myNotifierHash() => r'9acd382ed579c545ace755687b155e28eba01d22'; +String _$myNotifierHash() => r'7ff4b7b8f822ca720b55e2d29ed07d7f0b3485e8'; abstract class _$MyNotifier extends $Notifier { int build(); @@ -78,4 +78,4 @@ abstract class _$MyNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/add_listener/raw.dart b/website/docs/migration/from_state_notifier/add_listener/raw.dart index d032a4c2d..c2c30b288 100644 --- a/website/docs/migration/from_state_notifier/add_listener/raw.dart +++ b/website/docs/migration/from_state_notifier/add_listener/raw.dart @@ -7,7 +7,7 @@ import 'package:riverpod/riverpod.dart'; class MyNotifier extends Notifier { @override int build() { - ref.listenSelf((_, next) => debugPrint('$next')); + listenSelf((_, next) => debugPrint('$next')); return 0; } diff --git a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart index 7ae0b4412..4fb0fde7c 100644 --- a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart +++ b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -72,4 +72,4 @@ abstract class _$AsyncTodosNotifier extends $AsyncNotifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart index d2c67e60e..0a0d15377 100644 --- a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart +++ b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart @@ -79,4 +79,4 @@ abstract class _$CounterNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart index 54df8a0ab..0bc88af1f 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.dart @@ -9,7 +9,7 @@ import '../../utils.dart'; part 'family_and_dispose.g.dart'; @riverpod -TaskTrackerRepo taskTracker(TaskTrackerRef ref) => TaskTrackerRepo(); +TaskTrackerRepo taskTracker(Ref ref) => TaskTrackerRepo(); /* SNIPPET START */ @riverpod diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index af2146920..5b0f54f90 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -228,4 +228,4 @@ abstract class _$BugsEncounteredNotifier extends $AsyncNotifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart index fd51f4c27..9c2f7aafc 100644 --- a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart +++ b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -79,4 +79,4 @@ abstract class _$CounterNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart index 77786bd38..56d0d7cb3 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -78,4 +78,4 @@ abstract class _$MyNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart index ec601378e..7c0233912 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.dart @@ -6,11 +6,11 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'old_lifecycles_final.g.dart'; @riverpod -Duration duration(DurationRef ref) => const Duration(seconds: 1); +Duration duration(Ref ref) => const Duration(seconds: 1); @riverpod // ignore: library_private_types_in_public_api -_MyRepo repository(RepositoryRef ref) => _MyRepo(); +_MyRepo repository(Ref ref) => _MyRepo(); class _MyRepo { Future update(int i, {CancelToken? token}) async {} diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart index d1bbb1248..bc223e302 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -198,4 +198,4 @@ abstract class _$MyNotifier extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/providers/future_provider/config_provider/codegen.dart b/website/docs/providers/future_provider/config_provider/codegen.dart index 2aa87a29e..e862b79f8 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.dart @@ -5,6 +5,7 @@ import 'dart:convert'; import 'package:flutter/services.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; + class Configuration { Configuration.fromJson(Map json); final String host = ''; @@ -13,7 +14,7 @@ class Configuration { /* SNIPPET START */ @riverpod -Future fetchConfiguration(FetchConfigurationRef ref) async { +Future fetchConfiguration(Ref ref) async { final content = json.decode( await rootBundle.loadString('assets/configurations.json'), ) as Map; diff --git a/website/docs/providers/future_provider/config_provider/codegen.g.dart b/website/docs/providers/future_provider/config_provider/codegen.g.dart index 552b84192..f1b0f39d0 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.g.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.g.dart @@ -63,7 +63,7 @@ final class FetchConfigurationProvider extends $FunctionalProvider< } String _$fetchConfigurationHash() => - r'6c0f062e6f20baf883c4282856f1197fbe633d89'; + r'f18dd06ced5e58734c6fd925e5614c34e94d1b9e'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart index 89721667f..bccf693f8 100644 --- a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart @@ -88,4 +88,4 @@ abstract class _$AsyncTodos extends $AsyncNotifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/providers/notifier_provider/todos/codegen.g.dart b/website/docs/providers/notifier_provider/todos/codegen.g.dart index 2cd348c1d..89844c69d 100644 --- a/website/docs/providers/notifier_provider/todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/todos/codegen.g.dart @@ -78,4 +78,4 @@ abstract class _$Todos extends $Notifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/providers/provider/completed_todos/completed_todos.dart b/website/docs/providers/provider/completed_todos/completed_todos.dart index 1a29d96f5..720a034ba 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.dart @@ -7,7 +7,7 @@ part 'completed_todos.g.dart'; /* SNIPPET START */ @riverpod -List completedTodos(CompletedTodosRef ref) { +List completedTodos(Ref ref) { final todos = ref.watch(todosProvider); // we return only the completed todos diff --git a/website/docs/providers/provider/completed_todos/completed_todos.g.dart b/website/docs/providers/provider/completed_todos/completed_todos.g.dart index 707b10a68..1c4e638cc 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.g.dart @@ -67,7 +67,7 @@ final class CompletedTodosProvider } } -String _$completedTodosHash() => r'855706c09268f428696b3b382ae1605818361b83'; +String _$completedTodosHash() => r'0a6a67db7f22556b2cd64236815fdd4d2e72a72b'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.dart b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.dart index 7d3b8a332..4c36fafd9 100644 --- a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.dart +++ b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.dart @@ -22,7 +22,7 @@ class PageIndex extends _$PageIndex { // A provider which computes whether the user is allowed to go to the previous page @riverpod /* highlight-start */ -bool canGoToPreviousPage(CanGoToPreviousPageRef ref) { +bool canGoToPreviousPage(Ref ref) { /* highlight-end */ return ref.watch(pageIndexProvider) != 0; } diff --git a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index c64586e3f..03ffbd16f 100644 --- a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -136,7 +136,7 @@ final class CanGoToPreviousPageProvider extends $FunctionalProvider } String _$canGoToPreviousPageHash() => - r'801fe8182a37cd21ae83bdfccbe36c125b4d14fb'; + r'1cb9c497aa7e5e8ee03c5711f079c2b68a4c28c5'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/providers/provider/todo/todo.g.dart b/website/docs/providers/provider/todo/todo.g.dart index fde860cf8..27e1180bf 100644 --- a/website/docs/providers/provider/todo/todo.g.dart +++ b/website/docs/providers/provider/todo/todo.g.dart @@ -78,4 +78,4 @@ abstract class _$Todos extends $Notifier> { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart index ae755d0cd..7e9fc2b3d 100644 --- a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart +++ b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -78,4 +78,4 @@ abstract class _$PageIndex extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart index e2e34878c..6ac7b13c4 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart @@ -9,7 +9,7 @@ part 'codegen.g.dart'; /* SNIPPET START */ @riverpod -Stream> chat(ChatRef ref) async* { +Stream> chat(Ref ref) async* { // Connect to an API using sockets, and decode the output final socket = await Socket.connect('my-api', 4242); ref.onDispose(socket.close); diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart index 4a02bafb4..9566110bc 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -60,7 +60,7 @@ final class ChatProvider } } -String _$chatHash() => r'db1302132f90e854fe2f5da9d97d89c9a3c8b858'; +String _$chatHash() => r'bad093d5344471463a1e71688281924642f3a58c'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.dart index 1ccb42807..6dbbf14aa 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_codegen/main.dart @@ -16,7 +16,7 @@ final http = Http(); /* SNIPPET START */ @riverpod -Future fetchUser(FetchUserRef ref, {required int userId}) async { +Future fetchUser(Ref ref, {required int userId}) async { final json = await http.get('api/user/$userId'); return User.fromJson(json); } diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_hooks.mdx b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_hooks.mdx index 705bbb7ae..04386796e 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/about_hooks.mdx +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/about_hooks.mdx @@ -52,7 +52,7 @@ En général, les hokks sont utiles pour : - les formulaires - les animations - la réaction aux événements de l'utilisateur -- ... +- etc. Par exemple, nous pourrions utiliser les hooks pour implémenter manuellement une animation en fondu, où un widget commence invisible et apparaît lentement. diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart index a7c49d638..4a9361d1d 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart @@ -9,7 +9,7 @@ part 'main.g.dart'; // We create a "provider", which will store a value (here "Hello world"). // By using a provider, this allows us to mock/override the value exposed. @riverpod -String helloWorld(HelloWorldRef ref) { +String helloWorld(Ref ref) { return 'Hello world'; } diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart index f03708b64..11c0f9cb3 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart @@ -11,7 +11,7 @@ part 'main.g.dart'; // We create a "provider", which will store a value (here "Hello world"). // By using a provider, this allows us to mock/override the value exposed. @riverpod -String helloWorld(HelloWorldRef ref) { +String helloWorld(Ref ref) { return 'Hello world'; } diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/introduction.mdx b/website/i18n/fr/docusaurus-plugin-content-docs/current/introduction.mdx index 210549880..9108476fd 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/introduction.mdx +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/introduction.mdx @@ -35,9 +35,9 @@ influencés par un grand nombre de fonctionnalités, telles que : - rechercher en tapant - debouncing des requêtes asynchrones - annulation des requêtes asynchrones lorsqu'elles ne sont plus utilisées -- interfaces utilisateur optimistes +- interfaces utilisateur optimistes - mode hors ligne -- ... +- etc. Ces fonctionnalités peuvent être délicates à mettre en œuvre, mais sont cruciales pour une bonne expérience utilisateur. @@ -59,7 +59,7 @@ implémentée à l'aide de Riverpod. // Récupère la liste des packages depuis pub.dev @riverpod Future> fetchPackages( - FetchPackagesRef ref, { + Ref ref, { required int page, String search = '', }) async { diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request.mdx index e7bec27f3..c71c2745c 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request.mdx @@ -177,7 +177,7 @@ Le letture successive non chiameranno nuovamente la funzione, ma restituiranno i } `} @@ -216,7 +216,7 @@ Le letture successive non chiameranno nuovamente la funzione, ma restituiranno i }, { offset: 28, - length: 17, + length: 7, label: "Ref", description: <> diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart index 24ae03d1a..f975eff35 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart @@ -13,7 +13,7 @@ part 'provider.g.dart'; /// This will create a provider named `activityProvider` /// which will cache the result of this function. @riverpod -Future activity(ActivityRef ref) async { +Future activity(Ref ref) async { // Usando il package http, otteniamo un'attività casuale dalle Bored API final response = await http.get(Uri.https('boredapi.com', '/api/activity')); // Usando dart:convert, decodifichiamo il payload JSON in una Map. diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart index 15b704231..f3d02eb43 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart @@ -10,7 +10,7 @@ part 'family.g.dart'; /* SNIPPET START */ @riverpod Future activity( - ActivityRef ref, + Ref ref, // Possiamo aggiungere argomenti al provider // Il tipo del parametro può essere qualsiasi cosa tu voglia. String activityType, diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart index f91c10052..8a2adf42e 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart @@ -12,7 +12,7 @@ FutureOr fetchActivity() => throw UnimplementedError(); /* SNIPPET START */ // Un provider "funzionale" @riverpod -Future activity(ActivityRef ref) async { +Future activity(Ref ref) async { // TODO: eseguire una richiesta di rete per ottenere un'attività. return fetchActivity(); } diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart index 76ab146fd..5a16c314a 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart @@ -14,7 +14,7 @@ class Todo with _$Todo { /* SNIPPET START */ @riverpod -Future> todoList(TodoListRef ref) async { +Future> todoList(Ref ref) async { // Simula una richiesta di rete. Normalmente il risultato dovrebbe venire da una API reale return [ Todo(description: 'Learn Flutter', completed: true), diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx index d47e57bde..4a66f0ba7 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx @@ -156,7 +156,7 @@ Successivamente, puoi esporre il tuo `ChangeNotifier` con la seguente sintassi c ```dart // ignore_for_file: unsupported_provider_value @riverpod -MyNotifier example(ExampleRef ref) { +MyNotifier example(Ref ref) { return ref.listenAndDisposeChangeNotifier(MyNotifier()); } ``` diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.dart index 1ccb42807..6dbbf14aa 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/about_codegen/main.dart @@ -16,7 +16,7 @@ final http = Http(); /* SNIPPET START */ @riverpod -Future fetchUser(FetchUserRef ref, {required int userId}) async { +Future fetchUser(Ref ref, {required int userId}) async { final json = await http.get('api/user/$userId'); return User.fromJson(json); } diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/essentials/first_request.mdx b/website/i18n/ja/docusaurus-plugin-content-docs/current/essentials/first_request.mdx index b601703f3..875a93235 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/essentials/first_request.mdx +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/essentials/first_request.mdx @@ -184,7 +184,7 @@ provider のロジックを配置する場所です。 } `} @@ -223,7 +223,7 @@ Result myFunction(MyFunctionRef ref) { }, { offset: 28, - length: 17, + length: 7, label: "Ref", description: <> diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx b/website/i18n/ja/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx index b60aaaaed..e3be6ad72 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx @@ -162,7 +162,7 @@ extension ChangeNotifierWithCodeGenExtension on Ref { ```dart // ignore_for_file: unsupported_provider_value @riverpod -MyNotifier example(ExampleRef ref) { +MyNotifier example(Ref ref) { return ref.listenAndDisposeChangeNotifier(MyNotifier()); } ``` diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart index a7c49d638..4a9361d1d 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/dart_hello_world/main.dart @@ -9,7 +9,7 @@ part 'main.g.dart'; // We create a "provider", which will store a value (here "Hello world"). // By using a provider, this allows us to mock/override the value exposed. @riverpod -String helloWorld(HelloWorldRef ref) { +String helloWorld(Ref ref) { return 'Hello world'; } diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart index f03708b64..11c0f9cb3 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/getting_started/hello_world/main.dart @@ -11,7 +11,7 @@ part 'main.g.dart'; // We create a "provider", which will store a value (here "Hello world"). // By using a provider, this allows us to mock/override the value exposed. @riverpod -String helloWorld(HelloWorldRef ref) { +String helloWorld(Ref ref) { return 'Hello world'; } diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/introduction.mdx b/website/i18n/ja/docusaurus-plugin-content-docs/current/introduction.mdx index a5f0d1c2c..513376b7f 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/introduction.mdx +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/introduction.mdx @@ -51,7 +51,7 @@ Riverpod は Flutter の widget にインスパイアされた、 // pub.dev からパッケージ一覧を取得する @riverpod Future> fetchPackages( - FetchPackagesRef ref, { + Ref ref, { required int page, String search = '', }) async { diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx index 7516cbbae..aab39806d 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/about_hooks.mdx @@ -49,7 +49,7 @@ Riverpod의 provider가 "전역(Global)" 애플리케이션 상태(State)를 위 - 폼(forms) - 애니메이션(animations) - 사용자 이벤트에 반응하기(reacting to user events) -- ... +- etc. 예를 들어, 훅(Hooks)를 위젯이 보이지 않다가 서서히 나타나는 페이드인(Fade-in) 애니메이션을 직접 구현하는데 사용할 수 있습니다. diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request.mdx index 2d7957eb8..f9b79eead 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/essentials/first_request.mdx @@ -180,7 +180,7 @@ provider 타입은 자연스럽게 따라올 것입니다. } `} @@ -219,7 +219,7 @@ Result myFunction(MyFunctionRef ref) { }, { offset: 28, - length: 17, + length: 7, label: "Ref", description: <> @@ -274,7 +274,7 @@ provider는 당연히 "ref" 객체에 액세스할 수 있으므로 이전에 pr 하지만 여기서는 provider가 아니라 위젯에 있습니다. 그렇다면 "ref"는 어떻게 얻을 수 있을까요? 해결책은 `Consumer`라는 커스텀 위젯을 사용하는 것입니다. -`Consumer`는 `Builder`와 비슷한 위젲이지만, "ref"를 제공한다는 추가적인 이점이 있습니다. +`Consumer`는 `Builder`와 비슷한 위젯이지만, "ref"를 제공한다는 추가적인 이점이 있습니다. 이를 통해 UI가 provider들을 읽을 수 있습니다. 다음 예제는 `Consumer`를 사용하는 방법을 보여줍니다: diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx index d3a3fa6c0..650ae7b82 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx @@ -158,7 +158,7 @@ extension ChangeNotifierWithCodeGenExtension on Ref { ```dart // ignore_for_file: unsupported_provider_value @riverpod -MyNotifier example(ExampleRef ref) { +MyNotifier example(Ref ref) { return ref.listenAndDisposeChangeNotifier(MyNotifier()); } ``` diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request.mdx index 490a98fbf..b8777fb7b 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request.mdx @@ -293,7 +293,7 @@ Subsequent reads will not call the function again, but instead return the cached } `} @@ -354,7 +354,7 @@ Subsequent reads will not call the function again, but instead return the cached }, { offset: 28, - length: 17, + length: 7, label: "Ref", description: <> diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart index 0f70b54f6..ce35a3d4e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/first_request/codegen/provider.dart @@ -9,7 +9,7 @@ part 'provider.g.dart'; /// 这将创建一个名为 `activityProvider` 的提供者程序 /// 它可以缓存函数执行的结果 @riverpod -Future activity(ActivityRef ref) async { +Future activity(Ref ref) async { // 使用 package:http, 我们可以从 Bored API 获取一个随机的活动。 final response = await http.get(Uri.https('boredapi.com', '/api/activity')); // 使用 dart:convert, 然后我们将 JSON 有效负载解码为 Map 数据结构。 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart index 7d5c4c260..93877649e 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/family.dart @@ -8,7 +8,7 @@ part 'family.g.dart'; /* SNIPPET START */ @riverpod Future activity( - ActivityRef ref, + Ref ref, // 我们可以向提供者程序添加参数。 // 参数的类型可以是您想要的任何类型。 String activityType, diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart index d2cd2b635..3c1a97cc7 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/passing_args/codegen/provider.dart @@ -11,7 +11,7 @@ FutureOr fetchActivity() => throw UnimplementedError(); /* SNIPPET START */ // “函数型”提供者程序 @riverpod -Future activity(ActivityRef ref) async { +Future activity(Ref ref) async { // TODO: 执行网络请求以获取活动 return fetchActivity(); } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart index 88eb06c0e..2a4e5acea 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/essentials/side_effects/codegen/todo_list_provider.dart @@ -14,7 +14,7 @@ class Todo with _$Todo { } @riverpod -Future> todoList(TodoListRef ref) async { +Future> todoList(Ref ref) async { // 模拟一个网络请求。这通常来自真实的 API return [ Todo(description: 'Learn Flutter', completed: true), diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx index d98512916..a95d57fc1 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/from_provider/quickstart.mdx @@ -333,7 +333,7 @@ And then, you can expose your `ChangeNotifier` with the following codegen syntax ```dart // ignore_for_file: unsupported_provider_value @riverpod -MyNotifier example(ExampleRef ref) { +MyNotifier example(Ref ref) { return ref.listenAndDisposeChangeNotifier(MyNotifier()); } ``` diff --git a/website/pubspec.yaml b/website/pubspec.yaml index 0a0847b5d..0684ef534 100644 --- a/website/pubspec.yaml +++ b/website/pubspec.yaml @@ -25,7 +25,7 @@ dependencies: dev_dependencies: build_runner: - custom_lint: ^0.6.4 + custom_lint: ^0.7.0 flutter_test: sdk: flutter freezed: ^2.2.0 diff --git a/website/static/snippets/async.dart b/website/static/snippets/async.dart index e3a5e86db..82b764d78 100644 --- a/website/static/snippets/async.dart +++ b/website/static/snippets/async.dart @@ -19,7 +19,7 @@ class Configuration { /* SNIPPET START */ @riverpod -Future configurations(ConfigurationsRef ref) async { +Future configurations(Ref ref) async { final uri = Uri.parse('configs.json'); final rawJson = await File.fromUri(uri).readAsString(); diff --git a/website/static/snippets/async.g.dart b/website/static/snippets/async.g.dart index b34a4deb5..72b36c3ae 100644 --- a/website/static/snippets/async.g.dart +++ b/website/static/snippets/async.g.dart @@ -62,7 +62,7 @@ final class ConfigurationsProvider extends $FunctionalProvider< } } -String _$configurationsHash() => r'27f534f8b2a22c39b2d28c2414358a228c552155'; +String _$configurationsHash() => r'9ba3dc8a87bfe57002a403f03c8e0db6ba4759fd'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/static/snippets/combine.dart b/website/static/snippets/combine.dart index 96664b177..0ad595310 100644 --- a/website/static/snippets/combine.dart +++ b/website/static/snippets/combine.dart @@ -15,15 +15,15 @@ enum Filter { } @riverpod -List todos(TodosRef ref) => []; +List todos(Ref ref) => []; @riverpod -Filter filter(FilterRef ref) => Filter.all; +Filter filter(Ref ref) => Filter.all; /* SNIPPET START */ @riverpod -List filteredTodos(FilteredTodosRef ref) { +List filteredTodos(Ref ref) { // Providers can consume other providers using the "ref" object. // With ref.watch, providers will automatically update if the watched values changes. final List todos = ref.watch(todosProvider); diff --git a/website/static/snippets/combine.g.dart b/website/static/snippets/combine.g.dart index f63fa7d0e..7a451f3a0 100644 --- a/website/static/snippets/combine.g.dart +++ b/website/static/snippets/combine.g.dart @@ -187,7 +187,7 @@ final class FilteredTodosProvider } } -String _$filteredTodosHash() => r'bcb1e81823aaf9b967948b619c177ebc571d96a7'; +String _$filteredTodosHash() => r'9a243c7679a9c6c6aa4a9bea798cbff31a3038c6'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/static/snippets/create.dart b/website/static/snippets/create.dart index 0690b6e2f..236716169 100644 --- a/website/static/snippets/create.dart +++ b/website/static/snippets/create.dart @@ -10,7 +10,7 @@ part 'create.g.dart'; /* SNIPPET START */ @riverpod -Future boredSuggestion(BoredSuggestionRef ref) async { +Future boredSuggestion(Ref ref) async { final response = await http.get( Uri.https('boredapi.com', '/api/activity'), ); diff --git a/website/static/snippets/create.g.dart b/website/static/snippets/create.g.dart index 6017bf03c..00f4cc70b 100644 --- a/website/static/snippets/create.g.dart +++ b/website/static/snippets/create.g.dart @@ -59,7 +59,7 @@ final class BoredSuggestionProvider } } -String _$boredSuggestionHash() => r'6cceb7a902c8fe2477eae0dff97d10644a848ea0'; +String _$boredSuggestionHash() => r'ea7579b20dd2a5f45fd9d9ea09fcbd3608330d24'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/static/snippets/declare.g.dart b/website/static/snippets/declare.g.dart index f17d4b939..cf1a890e9 100644 --- a/website/static/snippets/declare.g.dart +++ b/website/static/snippets/declare.g.dart @@ -78,4 +78,4 @@ abstract class _$Count extends $Notifier { } // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/yarn.lock b/website/yarn.lock index 343d70c98..583bdd8e7 100644 --- a/website/yarn.lock +++ b/website/yarn.lock @@ -4594,9 +4594,9 @@ http-parser-js@>=0.5.1: integrity sha512-SGeBX54F94Wgu5RH3X5jsDtf4eHyRogWX1XGT3b4HuW3tQPM4AaBzoUji/4AAJNXCEOWZ5O0DgZmJw1947gD5Q== http-proxy-middleware@^2.0.3: - version "2.0.6" - resolved "https://registry.yarnpkg.com/http-proxy-middleware/-/http-proxy-middleware-2.0.6.tgz#e1a4dd6979572c7ab5a4e4b55095d1f32a74963f" - integrity sha512-ya/UeJ6HVBYxrgYotAZo1KvPWlgB48kUJLDePFeneHsVujFaW5WNj2NgWCAE//B1Dl02BIfYlpNgBy8Kf8Rjmw== + version "2.0.7" + resolved "https://registry.yarnpkg.com/http-proxy-middleware/-/http-proxy-middleware-2.0.7.tgz#915f236d92ae98ef48278a95dedf17e991936ec6" + integrity sha512-fgVY8AV7qU7z/MmXJ/rxwbrtQH4jBQ9m7kp3llF0liB7glmFeVZFBepQb32T3y8n8k2+AEYuMPCpinYW+/CuRA== dependencies: "@types/http-proxy" "^1.17.8" http-proxy "^1.18.1" From 262c149ce80c2400d2f5ab6dc5ffb48f3e578f99 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Nov 2024 15:21:25 +0100 Subject: [PATCH 353/387] Update Ref --- .../lib/src/core/consumer.dart | 2 +- .../riverpod/lib/src/core/async_value.dart | 2 +- .../legacy_provider_declaration_test.dart | 4 +-- .../test/nodes/dependencies_test.dart | 4 +-- .../providers/generated_providers_test.dart | 34 +++++++++---------- .../nodes/providers/identifiers_test.dart | 2 +- .../test/nodes/riverpod_test.dart | 26 +++++++------- .../test/ref_invocation_test.dart | 4 +-- .../test/type_utils_test.dart | 4 +-- .../lib/src/riverpod_annotation.dart | 14 ++++---- packages/riverpod_generator/CHANGELOG.md | 2 +- .../test/integration/annotated.dart | 9 +++-- .../test/integration/generated.dart | 6 ++-- .../test/integration/sync.dart | 4 +-- packages/riverpod_lint/README.md | 4 +-- .../unused_dependency_lint.md | 10 +++--- .../current/migration/utils.dart | 8 ++--- .../current/migration/utils.dart | 8 ++--- .../current/migration/utils.dart | 8 ++--- 19 files changed, 77 insertions(+), 78 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/core/consumer.dart b/packages/flutter_riverpod/lib/src/core/consumer.dart index d029ac4f1..853bc2ea7 100644 --- a/packages/flutter_riverpod/lib/src/core/consumer.dart +++ b/packages/flutter_riverpod/lib/src/core/consumer.dart @@ -20,7 +20,7 @@ typedef ConsumerBuilder = Widget Function( /// /// ```dart /// @riverpod -/// Future fetchUser(FetchUserRef ref) async { +/// Future fetchUser(Ref ref) async { /// // ... /// } /// ``` diff --git a/packages/riverpod/lib/src/core/async_value.dart b/packages/riverpod/lib/src/core/async_value.dart index 3ef0156a7..2e24a1ee8 100644 --- a/packages/riverpod/lib/src/core/async_value.dart +++ b/packages/riverpod/lib/src/core/async_value.dart @@ -186,7 +186,7 @@ sealed class AsyncValue { /// /// ```dart /// @riverpod - /// Future example(ExampleRef ref) async { + /// Future example(Ref ref) async { /// ref.state = AsyncLoading(progress: 0); /// /// await something(); diff --git a/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart b/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart index c6e05c054..079668e09 100644 --- a/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/legacy_provider_declaration_test.dart @@ -56,11 +56,11 @@ part 'foo.g.dart'; final legacy = Provider((ref) => 0); @riverpod -int simple(SimpleRef ref) => 0; +int simple(Ref ref) => 0; // Regression test for https://github.com/rrousselGit/riverpod/issues/2194 @riverpod -int complex(ComplexRef ref, {int? id, String? another}) => 0; +int complex(Ref ref, {int? id, String? another}) => 0; ''', (resolver, unit, units) async { final result = await resolver.resolveRiverpodAnalysisResult(); diff --git a/packages/riverpod_analyzer_utils_tests/test/nodes/dependencies_test.dart b/packages/riverpod_analyzer_utils_tests/test/nodes/dependencies_test.dart index d5c526523..5585672bb 100644 --- a/packages/riverpod_analyzer_utils_tests/test/nodes/dependencies_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/nodes/dependencies_test.dart @@ -13,7 +13,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:flutter/material.dart'; @riverpod -int a(ARef ref) => 0; +int a(Ref ref) => 0; @riverpod class B extends _$B { @@ -22,7 +22,7 @@ class B extends _$B { } @riverpod -int c(CRef ref, int arg) => 0; +int c(Ref ref, int arg) => 0; @riverpod class D extends _$D { diff --git a/packages/riverpod_analyzer_utils_tests/test/nodes/providers/generated_providers_test.dart b/packages/riverpod_analyzer_utils_tests/test/nodes/providers/generated_providers_test.dart index e18371f3b..eed80d7fd 100644 --- a/packages/riverpod_analyzer_utils_tests/test/nodes/providers/generated_providers_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/nodes/providers/generated_providers_test.dart @@ -9,7 +9,7 @@ void main() { import 'package:riverpod_annotation/riverpod_annotation.dart'; @riverpod -T generic(GenericRef ref) => throw UnimplementedError(); +T generic(Ref ref) => throw UnimplementedError(); @riverpod class GenericClass extends _$GenericClass { @@ -18,7 +18,7 @@ class GenericClass extends _$GenericClass { } @riverpod -int value(ValueRef ref) => throw UnimplementedError(); +int value(Ref ref) => throw UnimplementedError(); @riverpod class ValueClass extends _$ValueClass { @@ -27,7 +27,7 @@ class ValueClass extends _$ValueClass { } @riverpod -int parametrized(ParametrizedRef ref, int id) => throw UnimplementedError(); +int parametrized(Ref ref, int id) => throw UnimplementedError(); @riverpod class ParametrizedClass extends _$ParametrizedClass { @@ -57,13 +57,13 @@ class ParametrizedClass extends _$ParametrizedClass { import 'package:riverpod_annotation/riverpod_annotation.dart'; @riverpod -Raw> value(ValueRef ref) async => 0; +Raw> value(Ref ref) async => 0; @riverpod -Future value2(Value2Ref ref) async => 0; +Future value2(Ref ref) async => 0; @riverpod -Future> value3(Value3Ref ref) async => 0; +Future> value3(Ref ref) async => 0; ''', (resolver, unit, units) async { final value = unit.declarations.findByName('value').provider!; @@ -110,7 +110,7 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; int scoped() => 0; @riverpod -int plain(PlainRef ref) => 0; +int plain(Ref ref) => 0; ''', (resolver, unit, units) async { final scoped = unit.declarations.findByName('scoped').provider!; @@ -127,10 +127,10 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'foo.g.dart'; @riverpod -int first(FirstRef ref) => 0; +int first(Ref ref) => 0; @Riverpod() -int second(SecondRef ref) => 0; +int second(Ref ref) => 0; @riverpod class Counter extends _$Counter { @@ -159,13 +159,13 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'foo.g.dart'; @riverpod -int autoDispose(AutoDisposeRef ref) => 0; +int autoDispose(Ref ref) => 0; @Riverpod(keepAlive: false) -int autoDispose2(AutoDisposeRef ref) => 0; +int autoDispose2(Ref ref) => 0; @Riverpod(keepAlive: true) -int keepAlive(KeepAliveRef ref) => 0; +int keepAlive(Ref ref) => 0; @riverpod class AutoDisposeNotifierTest extends _$AutoDisposeNotifierTest { @@ -245,7 +245,7 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'foo.g.dart'; @riverpod -int root(RootRef ref) => 0; +int root(Ref ref) => 0; @riverpod class RootNotifier extends _$RootNotifier { @@ -254,7 +254,7 @@ class RootNotifier extends _$RootNotifier { } @Riverpod(dependencies: []) -int empty(EmptyRef ref) => 0; +int empty(Ref ref) => 0; @Riverpod(dependencies: []) class EmptyNotifier extends _$EmptyNotifier { @@ -263,7 +263,7 @@ class EmptyNotifier extends _$EmptyNotifier { } @Riverpod(dependencies: [empty, EmptyNotifier]) -int providerDependency(ProviderDependencyRef ref) => 0; +int providerDependency(Ref ref) => 0; @Riverpod(dependencies: [empty, EmptyNotifier]) class ProviderDependencyNotifier extends _$ProviderDependencyNotifier { @@ -272,7 +272,7 @@ class ProviderDependencyNotifier extends _$ProviderDependencyNotifier { } @Riverpod(dependencies: [providerDependency, ProviderDependencyNotifier]) -int nestedDependency(NestedDependencyRef ref) => 0; +int nestedDependency(Ref ref) => 0; @Riverpod(dependencies: [providerDependency, ProviderDependencyNotifier]) class NestedDependencyNotifier extends _$NestedDependencyNotifier { @@ -281,7 +281,7 @@ class NestedDependencyNotifier extends _$NestedDependencyNotifier { } @Riverpod(dependencies: [empty, EmptyNotifier]) -int family(NestedDependencyRef ref) => 0; +int family(Ref ref) => 0; @Riverpod(dependencies: [empty, EmptyNotifier]) class FamilyClass extends _$FamilyClass { diff --git a/packages/riverpod_analyzer_utils_tests/test/nodes/providers/identifiers_test.dart b/packages/riverpod_analyzer_utils_tests/test/nodes/providers/identifiers_test.dart index 6a55d413a..93c46fb2e 100644 --- a/packages/riverpod_analyzer_utils_tests/test/nodes/providers/identifiers_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/nodes/providers/identifiers_test.dart @@ -16,7 +16,7 @@ part 'foo.g.dart'; // Let's define some providers @riverpod -int a(ARef ref) => 0; +int a(Ref ref) => 0; @riverpod class B extends _$B { diff --git a/packages/riverpod_analyzer_utils_tests/test/nodes/riverpod_test.dart b/packages/riverpod_analyzer_utils_tests/test/nodes/riverpod_test.dart index 62c1f2a66..5335ae89a 100644 --- a/packages/riverpod_analyzer_utils_tests/test/nodes/riverpod_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/nodes/riverpod_test.dart @@ -13,27 +13,27 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; const deps = []; @Riverpod(dependencies: deps) -int first(FirstRef ref) => 0; +int first(Ref ref) => 0; @Riverpod(dependencies: ) -int second(SecondRef ref) => 0; +int second(Ref ref) => 0; @Riverpod(dependencies: [gibberish]) -int forth(ForthRef ref) => 0; +int forth(Ref ref) => 0; @Riverpod(dependencies: [if (true) forth]) -int fifth(FifthRef ref) => 0; +int fifth(Ref ref) => 0; @Riverpod(dependencies: [int]) -int sixth(SixthRef ref) => 0; +int sixth(Ref ref) => 0; void fn() {} @Riverpod(dependencies: [fn]) -int seven(SevenRef ref) => 0; +int seven(Ref ref) => 0; @Riverpod(dependencies: ['foo']) -int eight(EightRef ref) => 0; +int eight(Ref ref) => 0; ''', (resolver, unit, units) async { final errors = collectErrors(() { for (final d in unit.declarations) { @@ -117,13 +117,13 @@ int eight(EightRef ref) => 0; import 'package:riverpod_annotation/riverpod_annotation.dart'; @riverpod -int dependency(DependencyRef ref) => 0; +int dependency(Ref ref) => 0; @Riverpod(dependencies: [dependency]) -int fn(FnRef ref) => 0; +int fn(Ref ref) => 0; @Riverpod(dependencies: [dependency]) -int fn2(FnRef ref) => 0; +int fn2(Ref ref) => 0; ''', (resolver, unit, units) async { final dependency = unit.declarations.findByName('dependency').riverpod; @@ -148,13 +148,13 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; int unrelated() => 0; @riverpod -int variable(VariableRef ref) => 0; +int variable(Ref ref) => 0; @Riverpod() -int constructor(ConstructorRef ref) => 0; +int constructor(Ref ref) => 0; @Riverpod(keepAlive: false, dependencies: null) -int explicit(ExplicitRef ref) => 0; +int explicit(Ref ref) => 0; @Riverpod(keepAlive: true, dependencies: [variable]) int constructor2(Constructor2Ref ref) => 0; diff --git a/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart b/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart index 36cf64bab..3f457e230 100644 --- a/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart @@ -36,7 +36,7 @@ import 'file.dart' as alias; part 'foo.g.dart'; @Riverpod(keepAlive: true) -int aliased(AliasedRef ref) { +int aliased(Ref ref) { ref.watch(alias.aProvider); return 0; } @@ -99,7 +99,7 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'foo.g.dart'; @riverpod -int generated(GeneratedRef ref) => 0; +int generated(Ref ref) => 0; @riverpod class MyNotifier extends _$MyNotifier { diff --git a/packages/riverpod_analyzer_utils_tests/test/type_utils_test.dart b/packages/riverpod_analyzer_utils_tests/test/type_utils_test.dart index 7fd884c13..ddc0205ca 100644 --- a/packages/riverpod_analyzer_utils_tests/test/type_utils_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/type_utils_test.dart @@ -45,7 +45,7 @@ part 'foo.g.dart'; Never throws() => throw UnimplementedError(); @riverpod -int a(ARef ref) => throws(); +int a(Ref ref) => throws(); @riverpod class B extends _$B { @@ -54,7 +54,7 @@ class B extends _$B { } @riverpod -int c(CRef ref, int arg) => throws(); +int c(Ref ref, int arg) => throws(); @riverpod class D extends _$D { diff --git a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart index 4092357a0..610476987 100644 --- a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart @@ -55,12 +55,12 @@ final class Riverpod { /// ```dart /// // By not specifying "dependencies", we are saying that this provider is never scoped /// @riverpod - /// Foo root(RootRef ref) => Foo(); + /// Foo root(Ref ref) => Foo(); /// /// // By specifying "dependencies" (even if the list is empty), /// // we are saying that this provider is potentially scoped /// @Riverpod(dependencies: []) - /// Foo scoped(ScopedRef ref) => Foo(); + /// Foo scoped(Ref ref) => Foo(); /// /// // Alternatively, notifiers with an abstract build method are also considered scoped /// @riverpod @@ -75,14 +75,14 @@ final class Riverpod { /// /// ```dart /// @riverpod - /// Object? dependent(DependentRef ref) { + /// Object? dependent(Ref ref) { /// ref.watch(rootProvider); /// // This provider does not depend on any scoped provider, /// // as such "dependencies" is optional /// } /// /// @Riverpod(dependencies: []) - /// Object? dependent(DependentRef ref) { + /// Object? dependent(Ref ref) { /// ref.watch(rootProvider); /// // This provider decided to specify "dependencies" anyway, marking /// // "dependentProvider" as possibly scoped. @@ -91,7 +91,7 @@ final class Riverpod { /// } /// /// @Riverpod(dependencies: [root]) - /// Object? dependent(DependentRef ref) { + /// Object? dependent(Ref ref) { /// ref.watch(rootProvider); /// // Including "rootProvider" in "dependencies" is fine too, even though /// // it is not required. It is a no-op. @@ -102,7 +102,7 @@ final class Riverpod { /// /// ```dart /// @Riverpod(dependencies: [scoped]) - /// Object? dependent(DependentRef ref) { + /// Object? dependent(Ref ref) { /// ref.watch(scopedProvider); /// // Since "scopedProvider" specifies "dependencies", any provider that /// // depends on it must also specify "dependencies" and include "scopedProvider". @@ -232,7 +232,7 @@ class MissingScopeException implements Exception { /// Consider the following scoped provider: /// ```dart /// @Riverpod(dependencies: []) -/// String selectedBookID(SelectedBookIDRef ref) => throw UnimplementedError(); +/// String selectedBookID(Ref ref) => throw UnimplementedError(); /// ``` /// /// Since this provider is scoped, we should specify `@Dependencies` on any object diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 442977ab7..b209439e1 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -6,7 +6,7 @@ ```dart @riverpod - String example(ExampleRef ref, int arg, {required int anotherArg}) {...} + String example(Ref ref, int arg, {required int anotherArg}) {...} // ... exampleProvider.overrideWith( (ref, ({int arg, int anotherArg}) args) { diff --git a/packages/riverpod_generator/test/integration/annotated.dart b/packages/riverpod_generator/test/integration/annotated.dart index 21bcee88f..76dfa1100 100644 --- a/packages/riverpod_generator/test/integration/annotated.dart +++ b/packages/riverpod_generator/test/integration/annotated.dart @@ -7,8 +7,7 @@ part 'annotated.g.dart'; @Deprecated('Deprecation message') @visibleForTesting @protected -String functional(FunctionalRef ref, @Deprecated('field') int id) => - 'functional'; +String functional(Ref ref, @Deprecated('field') int id) => 'functional'; @riverpod @Deprecated('Deprecation message') @@ -23,11 +22,11 @@ class ClassBased extends _$ClassBased { @Deprecated('Deprecation message') @visibleForTesting @protected -String family(FamilyRef ref, int id) => 'family $id'; +String family(Ref ref, int id) => 'family $id'; @riverpod @doNotStore -String notCopiedFunctional(NotCopiedFunctionalRef ref) => 'notCopiedFunctional'; +String notCopiedFunctional(Ref ref) => 'notCopiedFunctional'; @riverpod @doNotStore @@ -38,4 +37,4 @@ class NotCopiedClassBased extends _$NotCopiedClassBased { @riverpod @doNotStore -String notCopiedFamily(NotCopiedFamilyRef ref, int id) => 'notCopiedFamily $id'; +String notCopiedFamily(Ref ref, int id) => 'notCopiedFamily $id'; diff --git a/packages/riverpod_generator/test/integration/generated.dart b/packages/riverpod_generator/test/integration/generated.dart index 2036f8d5c..a00374139 100644 --- a/packages/riverpod_generator/test/integration/generated.dart +++ b/packages/riverpod_generator/test/integration/generated.dart @@ -50,16 +50,16 @@ class $DynamicClassFamily extends _$$DynamicClassFamily { const dynamicProvider = _dynamicProvider; @riverpod -_dynamic(_DynamicRef ref, test) => 0; +_dynamic(Ref ref, test) => 0; @riverpod -AsyncValue alias(AliasRef ref) { +AsyncValue alias(Ref ref) { return const AsyncData(42); } @riverpod AsyncValue aliasFamily( - AliasFamilyRef ref, + Ref ref, AsyncValue test, ) { return const AsyncData(42); diff --git a/packages/riverpod_generator/test/integration/sync.dart b/packages/riverpod_generator/test/integration/sync.dart index cd4f5ea85..3dac18300 100644 --- a/packages/riverpod_generator/test/integration/sync.dart +++ b/packages/riverpod_generator/test/integration/sync.dart @@ -212,7 +212,7 @@ final _other = _someProvider; // Regression test for now casting `as Object?` when not needed @riverpod -String unnecessaryCast(GeneratedRef ref, Object? arg) { +String unnecessaryCast(Ref ref, Object? arg) { return 'Just a simple normal generated provider'; } @@ -229,6 +229,6 @@ class ManyProviderData {} @riverpod Stream> manyDataStream( - ManyDataStreamRef ref, + Ref ref, ManyProviderData pData, ) async* {} diff --git a/packages/riverpod_lint/README.md b/packages/riverpod_lint/README.md index 74fa1d7f1..3a23b0dbb 100644 --- a/packages/riverpod_lint/README.md +++ b/packages/riverpod_lint/README.md @@ -633,10 +633,10 @@ to behave as a `keepAlive`, even though it isn't marked as such. ```dart @riverpod -int nonKeepAlive(NonKeepAliveRef ref) => 0; +int nonKeepAlive(Ref ref) => 0; @Riverpod(keepAlive: true) -int fn(FnRef ref) { +int fn(Ref ref) { // `keepAlive` providers should only depend on keepAlive providers. ref.watch(nonKeepAliveProvider); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_lint.md index 1715ef512..69ef74d66 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_lint.md @@ -11,7 +11,7 @@ test/lints/provider_dependencies/unused_dependency.dart:22:17 dep2, ]<<<, ) -int extraDep(ExtraDepRef ref) { +int extraDep(Ref ref) { ``` ======= @@ -28,7 +28,7 @@ test/lints/provider_dependencies/unused_dependency.dart:35:17 dep, ]<<<, ) -int noDep(NoDepRef ref) { +int noDep(Ref ref) { ``` ======= @@ -62,7 +62,7 @@ test/lints/provider_dependencies/unused_dependency.dart:56:17 dep, ]<<<, ) -int noDepNoParam(NoDepNoParamRef ref) { +int noDepNoParam(Ref ref) { ``` ======= @@ -76,7 +76,7 @@ test/lints/provider_dependencies/unused_dependency.dart:65:43 // expect_lint: provider_dependencies @Riverpod(keepAlive: false, dependencies: >>>[dep]<<<) -int noDepWithoutComma(NoDepWithoutCommaRef ref) { +int noDepWithoutComma(Ref ref) { return 0; ``` @@ -94,7 +94,7 @@ test/lints/provider_dependencies/unused_dependency.dart:73:17 root, ]<<<, ) -int rootDep(RootDepRef ref) => 0; +int rootDep(Ref ref) => 0; ``` ======= diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.dart index ad922b1e3..37d1d7f83 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/migration/utils.dart @@ -5,19 +5,19 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'utils.g.dart'; @riverpod -int random(RandomRef ref) { +int random(Ref ref) { return math.Random().nextInt(6); } @riverpod -TaskTrackerRepo taskTracker(TaskTrackerRef ref) => TaskTrackerRepo(); +TaskTrackerRepo taskTracker(Ref ref) => TaskTrackerRepo(); class TaskTrackerRepo { Future fix({required String id, required int fixed}) async => 0; } @riverpod -Duration duration(DurationRef ref) => Duration.zero; +Duration duration(Ref ref) => Duration.zero; @riverpod -int availableWater(AvailableWaterRef ref) => 40; +int availableWater(Ref ref) => 40; diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.dart b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.dart index ad922b1e3..37d1d7f83 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.dart +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/migration/utils.dart @@ -5,19 +5,19 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'utils.g.dart'; @riverpod -int random(RandomRef ref) { +int random(Ref ref) { return math.Random().nextInt(6); } @riverpod -TaskTrackerRepo taskTracker(TaskTrackerRef ref) => TaskTrackerRepo(); +TaskTrackerRepo taskTracker(Ref ref) => TaskTrackerRepo(); class TaskTrackerRepo { Future fix({required String id, required int fixed}) async => 0; } @riverpod -Duration duration(DurationRef ref) => Duration.zero; +Duration duration(Ref ref) => Duration.zero; @riverpod -int availableWater(AvailableWaterRef ref) => 40; +int availableWater(Ref ref) => 40; diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.dart index ad922b1e3..37d1d7f83 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/migration/utils.dart @@ -5,19 +5,19 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'utils.g.dart'; @riverpod -int random(RandomRef ref) { +int random(Ref ref) { return math.Random().nextInt(6); } @riverpod -TaskTrackerRepo taskTracker(TaskTrackerRef ref) => TaskTrackerRepo(); +TaskTrackerRepo taskTracker(Ref ref) => TaskTrackerRepo(); class TaskTrackerRepo { Future fix({required String id, required int fixed}) async => 0; } @riverpod -Duration duration(DurationRef ref) => Duration.zero; +Duration duration(Ref ref) => Duration.zero; @riverpod -int availableWater(AvailableWaterRef ref) => 40; +int availableWater(Ref ref) => 40; From 258540978e88bb52d01028e3566bdf971f885db7 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Nov 2024 15:28:04 +0100 Subject: [PATCH 354/387] Fix lint tests --- ...rt_functional_provider_to_class_based.diff | 4 +- .../lints/functional_ref/fix/auto_import.dart | 17 -- .../lints/functional_ref/fix/auto_import.diff | 100 --------- .../functional_ref/fix/auto_import.g.dart | 190 ------------------ .../fix/failing_functional_ref.diff | 6 +- .../functional_ref/fix/functional_ref.diff | 4 +- .../fix/functional_ref_test.dart | 36 ---- .../lints/functional_ref/fix/use_prefix.dart | 19 -- .../lints/functional_ref/fix/use_prefix.diff | 34 ---- .../functional_ref/fix/use_prefix.g.dart | 190 ------------------ .../avoid_build_context_in_providers_lint.md | 12 +- .../failing_functional_ref_fix.diff | 6 +- .../failing_functional_ref_lint.md | 6 +- .../functional_ref/functional_ref_fix.diff | 4 +- .../functional_ref/functional_ref_lint.md | 4 +- ...y_use_keep_alive_inside_keep_alive_lint.md | 4 +- .../unused_dependency_fix.diff | 12 +- 17 files changed, 31 insertions(+), 617 deletions(-) delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.g.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.g.dart diff --git a/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff index 729b5335f..0980c5b6b 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff +++ b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff @@ -1,6 +1,6 @@ Message: `Convert to class-based provider` Priority: 100 -Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:8`: +Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:7`: ``` /// Some comment @riverpod @@ -15,7 +15,7 @@ Diff for file `test/assists/convert_functional_provider_to_class_based/convert_f --- Message: `Convert to class-based provider` Priority: 100 -Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:12`: +Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:11`: ``` /// Some comment @riverpod diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.dart deleted file mode 100644 index f9da55bfe..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.dart +++ /dev/null @@ -1,17 +0,0 @@ -// ignore_for_file: deprecated_member_use_from_same_package -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -part 'auto_import.g.dart'; - -// No riverpod imported. Should add it automatically -@riverpod -// expect_lint: functional_ref -int example(ExampleRef ref) => 0; - -@riverpod -// expect_lint: functional_ref -int empty() => 0; - -@riverpod -// expect_lint: functional_ref -int untyped(ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.diff b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.diff deleted file mode 100644 index 8467bc041..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.diff +++ /dev/null @@ -1,100 +0,0 @@ -Message: `Type as Ref` -Priority: 90 -Diff for file `test/lints/functional_ref/fix/auto_import.dart:2`: -``` -// ignore_for_file: deprecated_member_use_from_same_package -- import 'package:riverpod_annotation/riverpod_annotation.dart'; -- -- part 'auto_import.g.dart'; -- -- // No riverpod imported. Should add it automatically -- @riverpod -- // expect_lint: functional_ref -- int example(ExampleRef ref) => 0; -+ import 'package:riverpod/riverpod.dart'; -+ import 'package:riverpod_annotation/riverpod_annotation.dart'; -+ -+ part 'auto_import.g.dart'; -+ -+ // No riverpod imported. Should add it automatically -+ @riverpod -+ // expect_lint: functional_ref -+ int example(Ref ref) => 0; - -@riverpod -``` ---- -Message: `Add ref parameter` -Priority: 90 -Diff for file `test/lints/functional_ref/fix/auto_import.dart:2`: -``` -// ignore_for_file: deprecated_member_use_from_same_package -- import 'package:riverpod_annotation/riverpod_annotation.dart'; -- -- part 'auto_import.g.dart'; -- -- // No riverpod imported. Should add it automatically -- @riverpod -- // expect_lint: functional_ref -- int example(ExampleRef ref) => 0; -- -- @riverpod -- // expect_lint: functional_ref -- int empty() => 0; -+ import 'package:riverpod/riverpod.dart'; -+ import 'package:riverpod_annotation/riverpod_annotation.dart'; -+ -+ part 'auto_import.g.dart'; -+ -+ // No riverpod imported. Should add it automatically -+ @riverpod -+ // expect_lint: functional_ref -+ int example(ExampleRef ref) => 0; -+ -+ @riverpod -+ // expect_lint: functional_ref -+ int empty(Ref ref) => 0; - -@riverpod -``` ---- -Message: `Type as Ref` -Priority: 90 -Diff for file `test/lints/functional_ref/fix/auto_import.dart:2`: -``` -// ignore_for_file: deprecated_member_use_from_same_package -- import 'package:riverpod_annotation/riverpod_annotation.dart'; -- -- part 'auto_import.g.dart'; -- -- // No riverpod imported. Should add it automatically -- @riverpod -- // expect_lint: functional_ref -- int example(ExampleRef ref) => 0; -- -- @riverpod -- // expect_lint: functional_ref -- int empty() => 0; -- -- @riverpod -- // expect_lint: functional_ref -- int untyped(ref) => 0; -+ import 'package:riverpod/riverpod.dart'; -+ import 'package:riverpod_annotation/riverpod_annotation.dart'; -+ -+ part 'auto_import.g.dart'; -+ -+ // No riverpod imported. Should add it automatically -+ @riverpod -+ // expect_lint: functional_ref -+ int example(ExampleRef ref) => 0; -+ -+ @riverpod -+ // expect_lint: functional_ref -+ int empty() => 0; -+ -+ @riverpod -+ // expect_lint: functional_ref -+ int untyped(Ref ref) => 0; -``` ---- diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.g.dart deleted file mode 100644 index fca00e4f6..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.g.dart +++ /dev/null @@ -1,190 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'auto_import.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -typedef ExampleRef = Ref; - -@ProviderFor(example) -const exampleProvider = ExampleProvider._(); - -final class ExampleProvider extends $FunctionalProvider - with $Provider { - const ExampleProvider._( - {int Function( - ExampleRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'exampleProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - ExampleRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$exampleHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - ExampleProvider $copyWithCreate( - int Function( - ExampleRef ref, - ) create, - ) { - return ExampleProvider._(create: create); - } - - @override - int create(ExampleRef ref) { - final _$cb = _createCb ?? example; - return _$cb(ref); - } -} - -String _$exampleHash() => r'638d7db2be22eaad0f51ea0b3ae38e0483d43725'; - -typedef EmptyRef = Ref; - -@ProviderFor(empty) -const emptyProvider = EmptyProvider._(); - -final class EmptyProvider extends $FunctionalProvider - with $Provider { - const EmptyProvider._( - {int Function( - EmptyRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'emptyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - EmptyRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$emptyHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - EmptyProvider $copyWithCreate( - int Function( - EmptyRef ref, - ) create, - ) { - return EmptyProvider._(create: create); - } - - @override - int create(EmptyRef ref) { - final _$cb = _createCb ?? empty; - return _$cb(ref); - } -} - -String _$emptyHash() => r'eaec2981c894019fafd068e09478ffe961a8d188'; - -typedef UntypedRef = Ref; - -@ProviderFor(untyped) -const untypedProvider = UntypedProvider._(); - -final class UntypedProvider extends $FunctionalProvider - with $Provider { - const UntypedProvider._( - {int Function( - UntypedRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'untypedProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - UntypedRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$untypedHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - UntypedProvider $copyWithCreate( - int Function( - UntypedRef ref, - ) create, - ) { - return UntypedProvider._(create: create); - } - - @override - int create(UntypedRef ref) { - final _$cb = _createCb ?? untyped; - return _$cb(ref); - } -} - -String _$untypedHash() => r'5dd4815f63ed35a15a2e027b4e0cb496693f07f4'; - -// ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/failing_functional_ref.diff b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/failing_functional_ref.diff index 474f8d630..81cb4b72f 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/failing_functional_ref.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/failing_functional_ref.diff @@ -1,6 +1,6 @@ Message: `Add ref parameter` Priority: 90 -Diff for file `test/lints/functional_ref/failing_functional_ref.dart:6`: +Diff for file `test/lints/functional_ref/failing_functional_ref.dart:5`: ``` @riverpod // expect_lint: functional_ref @@ -12,7 +12,7 @@ Diff for file `test/lints/functional_ref/failing_functional_ref.dart:6`: --- Message: `Type as Ref` Priority: 90 -Diff for file `test/lints/functional_ref/failing_functional_ref.dart:13`: +Diff for file `test/lints/functional_ref/failing_functional_ref.dart:12`: ``` int incorrectlyTyped( // expect_lint: functional_ref @@ -24,7 +24,7 @@ int incorrectlyTyped( --- Message: `Add ref parameter` Priority: 90 -Diff for file `test/lints/functional_ref/failing_functional_ref.dart:21`: +Diff for file `test/lints/functional_ref/failing_functional_ref.dart:20`: ``` @riverpod // expect_lint: functional_ref diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref.diff b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref.diff index 5dcd029ad..f2ba52bfd 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref.diff @@ -1,6 +1,6 @@ Message: `Type as Ref` Priority: 90 -Diff for file `test/lints/functional_ref/functional_ref.dart:10`: +Diff for file `test/lints/functional_ref/functional_ref.dart:8`: ``` int nameless( // expect_lint: functional_ref @@ -12,7 +12,7 @@ int nameless( --- Message: `Type as Ref` Priority: 90 -Diff for file `test/lints/functional_ref/functional_ref.dart:20`: +Diff for file `test/lints/functional_ref/functional_ref.dart:18`: ``` @riverpod int valid(Ref ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref_test.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref_test.dart index fa8f0aa18..34a4d87f6 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref_test.dart @@ -39,40 +39,4 @@ void main() { return changes.flattened; }, ); - - testGolden( - 'The Ref fix should add imports', - 'test/lints/functional_ref/fix/auto_import.diff', - sourcePath: 'test/lints/functional_ref/fix/auto_import.dart', - (result, helper) async { - const lint = FunctionalRef(); - final fix = lint.getFixes().single; - - final errors = await lint.testRun(result); - - final changes = await Future.wait([ - for (final error in errors) fix.testRun(result, error, errors), - ]); - - return changes.flattened; - }, - ); - - testGolden( - 'Supports prefixes', - 'test/lints/functional_ref/fix/use_prefix.diff', - sourcePath: 'test/lints/functional_ref/fix/use_prefix.dart', - (result, helper) async { - const lint = FunctionalRef(); - final fix = lint.getFixes().single; - - final errors = await lint.testRun(result); - - final changes = await Future.wait([ - for (final error in errors) fix.testRun(result, error, errors), - ]); - - return changes.flattened; - }, - ); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.dart deleted file mode 100644 index da23acc3e..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.dart +++ /dev/null @@ -1,19 +0,0 @@ -// ignore_for_file: deprecated_member_use_from_same_package -// ignore: unused_import, used for the fix -import 'package:riverpod/riverpod.dart' as prefix; -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -part 'use_prefix.g.dart'; - -// No riverpod imported. Should add it automatically -@riverpod -// expect_lint: functional_ref -int example(ExampleRef ref) => 0; - -@riverpod -// expect_lint: functional_ref -int empty() => 0; - -@riverpod -// expect_lint: functional_ref -int untyped(ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.diff b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.diff deleted file mode 100644 index c403a677f..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.diff +++ /dev/null @@ -1,34 +0,0 @@ -Message: `Type as Ref` -Priority: 90 -Diff for file `test/lints/functional_ref/fix/use_prefix.dart:11`: -``` -@riverpod -// expect_lint: functional_ref -- int example(ExampleRef ref) => 0; -+ int example(prefix.Ref ref) => 0; - -@riverpod -``` ---- -Message: `Add ref parameter` -Priority: 90 -Diff for file `test/lints/functional_ref/fix/use_prefix.dart:15`: -``` -@riverpod -// expect_lint: functional_ref -- int empty() => 0; -+ int empty(prefix.Ref ref) => 0; - -@riverpod -``` ---- -Message: `Type as Ref` -Priority: 90 -Diff for file `test/lints/functional_ref/fix/use_prefix.dart:19`: -``` -@riverpod -// expect_lint: functional_ref -- int untyped(ref) => 0; -+ int untyped(prefix.Ref ref) => 0; -``` ---- diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.g.dart deleted file mode 100644 index 7d5bbd75c..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.g.dart +++ /dev/null @@ -1,190 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'use_prefix.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -typedef ExampleRef = Ref; - -@ProviderFor(example) -const exampleProvider = ExampleProvider._(); - -final class ExampleProvider extends $FunctionalProvider - with $Provider { - const ExampleProvider._( - {int Function( - ExampleRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'exampleProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - ExampleRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$exampleHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - ExampleProvider $copyWithCreate( - int Function( - ExampleRef ref, - ) create, - ) { - return ExampleProvider._(create: create); - } - - @override - int create(ExampleRef ref) { - final _$cb = _createCb ?? example; - return _$cb(ref); - } -} - -String _$exampleHash() => r'638d7db2be22eaad0f51ea0b3ae38e0483d43725'; - -typedef EmptyRef = Ref; - -@ProviderFor(empty) -const emptyProvider = EmptyProvider._(); - -final class EmptyProvider extends $FunctionalProvider - with $Provider { - const EmptyProvider._( - {int Function( - EmptyRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'emptyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - EmptyRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$emptyHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - EmptyProvider $copyWithCreate( - int Function( - EmptyRef ref, - ) create, - ) { - return EmptyProvider._(create: create); - } - - @override - int create(EmptyRef ref) { - final _$cb = _createCb ?? empty; - return _$cb(ref); - } -} - -String _$emptyHash() => r'eaec2981c894019fafd068e09478ffe961a8d188'; - -typedef UntypedRef = Ref; - -@ProviderFor(untyped) -const untypedProvider = UntypedProvider._(); - -final class UntypedProvider extends $FunctionalProvider - with $Provider { - const UntypedProvider._( - {int Function( - UntypedRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'untypedProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - UntypedRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$untypedHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - UntypedProvider $copyWithCreate( - int Function( - UntypedRef ref, - ) create, - ) { - return UntypedProvider._(create: create); - } - - @override - int create(UntypedRef ref) { - final _$cb = _createCb ?? untyped; - return _$cb(ref); - } -} - -String _$untypedHash() => r'5dd4815f63ed35a15a2e027b4e0cb496693f07f4'; - -// ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md index 36544c25b..589c4dde1 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md @@ -1,7 +1,7 @@ code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:13:3 +test/lints/avoid_build_context_in_providers.dart:12:3 ```dart Ref ref, @@ -16,7 +16,7 @@ test/lints/avoid_build_context_in_providers.dart:13:3 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:15:3 +test/lints/avoid_build_context_in_providers.dart:14:3 ```dart BuildContext context1, { @@ -31,7 +31,7 @@ test/lints/avoid_build_context_in_providers.dart:15:3 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:23:5 +test/lints/avoid_build_context_in_providers.dart:22:5 ```dart int build( @@ -46,7 +46,7 @@ test/lints/avoid_build_context_in_providers.dart:23:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:25:5 +test/lints/avoid_build_context_in_providers.dart:24:5 ```dart BuildContext context1, { @@ -61,7 +61,7 @@ test/lints/avoid_build_context_in_providers.dart:25:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:31:5 +test/lints/avoid_build_context_in_providers.dart:30:5 ```dart void event( @@ -76,7 +76,7 @@ test/lints/avoid_build_context_in_providers.dart:31:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:33:5 +test/lints/avoid_build_context_in_providers.dart:32:5 ```dart BuildContext context3, { diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_fix.diff index 474f8d630..81cb4b72f 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_fix.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_fix.diff @@ -1,6 +1,6 @@ Message: `Add ref parameter` Priority: 90 -Diff for file `test/lints/functional_ref/failing_functional_ref.dart:6`: +Diff for file `test/lints/functional_ref/failing_functional_ref.dart:5`: ``` @riverpod // expect_lint: functional_ref @@ -12,7 +12,7 @@ Diff for file `test/lints/functional_ref/failing_functional_ref.dart:6`: --- Message: `Type as Ref` Priority: 90 -Diff for file `test/lints/functional_ref/failing_functional_ref.dart:13`: +Diff for file `test/lints/functional_ref/failing_functional_ref.dart:12`: ``` int incorrectlyTyped( // expect_lint: functional_ref @@ -24,7 +24,7 @@ int incorrectlyTyped( --- Message: `Add ref parameter` Priority: 90 -Diff for file `test/lints/functional_ref/failing_functional_ref.dart:21`: +Diff for file `test/lints/functional_ref/failing_functional_ref.dart:20`: ``` @riverpod // expect_lint: functional_ref diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_lint.md index 2f4399048..5cd4da160 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/failing_functional_ref_lint.md @@ -1,7 +1,7 @@ code: functional_ref severity: Severity.warning message: Functional providers must receive a ref matching the provider name as their first positional parameter. -test/lints/functional_ref/failing_functional_ref.dart:6:5 +test/lints/functional_ref/failing_functional_ref.dart:5:5 ```dart @riverpod @@ -16,7 +16,7 @@ int >>>refless<<<() { code: functional_ref severity: Severity.warning message: Functional providers must receive a ref matching the provider name as their first positional parameter. -test/lints/functional_ref/failing_functional_ref.dart:13:3 +test/lints/functional_ref/failing_functional_ref.dart:12:3 ```dart int incorrectlyTyped( @@ -31,7 +31,7 @@ int incorrectlyTyped( code: functional_ref severity: Severity.warning message: Functional providers must receive a ref matching the provider name as their first positional parameter. -test/lints/functional_ref/failing_functional_ref.dart:21:23 +test/lints/functional_ref/failing_functional_ref.dart:20:23 ```dart @riverpod diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff index 5dcd029ad..f2ba52bfd 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff @@ -1,6 +1,6 @@ Message: `Type as Ref` Priority: 90 -Diff for file `test/lints/functional_ref/functional_ref.dart:10`: +Diff for file `test/lints/functional_ref/functional_ref.dart:8`: ``` int nameless( // expect_lint: functional_ref @@ -12,7 +12,7 @@ int nameless( --- Message: `Type as Ref` Priority: 90 -Diff for file `test/lints/functional_ref/functional_ref.dart:20`: +Diff for file `test/lints/functional_ref/functional_ref.dart:18`: ``` @riverpod int valid(Ref ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md index e8a8c25c0..344b8fdf2 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md @@ -1,7 +1,7 @@ code: functional_ref severity: Severity.warning message: Functional providers must receive a ref matching the provider name as their first positional parameter. -test/lints/functional_ref/functional_ref.dart:10:3 +test/lints/functional_ref/functional_ref.dart:8:3 ```dart int nameless( @@ -16,7 +16,7 @@ int nameless( code: functional_ref severity: Severity.warning message: Functional providers must receive a ref matching the provider name as their first positional parameter. -test/lints/functional_ref/functional_ref.dart:16:32 +test/lints/functional_ref/functional_ref.dart:14:32 ```dart diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/only_use_keep_alive_inside_keep_alive/only_use_keep_alive_inside_keep_alive_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/only_use_keep_alive_inside_keep_alive/only_use_keep_alive_inside_keep_alive_lint.md index b69c47fc2..173c5cc9a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/only_use_keep_alive_inside_keep_alive/only_use_keep_alive_inside_keep_alive_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/only_use_keep_alive_inside_keep_alive/only_use_keep_alive_inside_keep_alive_lint.md @@ -2,7 +2,7 @@ code: only_use_keep_alive_inside_keep_alive severity: Severity.warning correctionMessage: Either stop marking this provider as `keepAlive` or remove `keepAlive` from the used provider. message: If a provider is declared as `keepAlive`, it can only use providers that are also declared as `keepAlive. -test/lints/only_use_keep_alive_inside_keep_alive.dart:28:3 +test/lints/only_use_keep_alive_inside_keep_alive.dart:27:3 ```dart @@ -18,7 +18,7 @@ code: only_use_keep_alive_inside_keep_alive severity: Severity.warning correctionMessage: Either stop marking this provider as `keepAlive` or remove `keepAlive` from the used provider. message: If a provider is declared as `keepAlive`, it can only use providers that are also declared as `keepAlive. -test/lints/only_use_keep_alive_inside_keep_alive.dart:30:3 +test/lints/only_use_keep_alive_inside_keep_alive.dart:29:3 ```dart ref.watch(autoDisposeProvider); diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_fix.diff index 1c4036b23..8537bff58 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_fix.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/unused_dependency_fix.diff @@ -10,7 +10,7 @@ Diff for file `test/lints/provider_dependencies/unused_dependency.dart:22`: - ], + dependencies: [dep2], ) -int extraDep(ExtraDepRef ref) { +int extraDep(Ref ref) { ``` --- Message: `Remove "dependencies"` @@ -25,7 +25,7 @@ Diff for file `test/lints/provider_dependencies/unused_dependency.dart:34`: - ], - ) + ) -int noDep(NoDepRef ref) { +int noDep(Ref ref) { return 0; ``` --- @@ -41,7 +41,7 @@ Diff for file `test/lints/provider_dependencies/unused_dependency.dart:45`: - keepAlive: false, + keepAlive: false, ) -int dependenciesFirstThenKeepAlive(DependenciesFirstThenKeepAliveRef ref) { +int dependenciesFirstThenKeepAlive(Ref ref) { ``` --- Message: `Remove "dependencies"` @@ -57,7 +57,7 @@ Diff for file `test/lints/provider_dependencies/unused_dependency.dart:54`: - ], - ) + @riverpod -int noDepNoParam(NoDepNoParamRef ref) { +int noDepNoParam(Ref ref) { return 0; ``` --- @@ -69,7 +69,7 @@ Diff for file `test/lints/provider_dependencies/unused_dependency.dart:65`: // expect_lint: provider_dependencies - @Riverpod(keepAlive: false, dependencies: [dep]) + @Riverpod(keepAlive: false) -int noDepWithoutComma(NoDepWithoutCommaRef ref) { +int noDepWithoutComma(Ref ref) { return 0; ``` --- @@ -85,7 +85,7 @@ Diff for file `test/lints/provider_dependencies/unused_dependency.dart:72`: - ], - ) + ) -int rootDep(RootDepRef ref) => 0; +int rootDep(Ref ref) => 0; ``` --- From 9c2dbc670c12ea2fd6c8e6e1b4e4cb05cf4da12a Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Nov 2024 15:49:28 +0100 Subject: [PATCH 355/387] Fix more lints --- .../lib/src/lints/functional_ref.dart | 21 --- .../riverpod_lint_flutter_test/build.yaml | 1 + .../failing_notifier_extends.dart | 14 ++ .../notifier_extends.dart | 13 -- .../notifier_extends.g.dart | 138 ------------------ ...ly_use_keep_alive_inside_keep_alive.g.dart | 6 +- .../missing_dependencies2.g.dart | 67 +-------- .../unused_dependency.g.dart | 18 +-- .../test/lints/unknown_scoped_usage.g.dart | 4 +- 9 files changed, 31 insertions(+), 251 deletions(-) create mode 100644 packages/riverpod_lint_flutter_test/test/lints/notifier_extends/failing_notifier_extends.dart rename packages/riverpod_lint_flutter_test/test/lints/{ => notifier_extends}/notifier_extends.dart (77%) rename packages/riverpod_lint_flutter_test/test/lints/{ => notifier_extends}/notifier_extends.g.dart (85%) diff --git a/packages/riverpod_lint/lib/src/lints/functional_ref.dart b/packages/riverpod_lint/lib/src/lints/functional_ref.dart index 9db84a345..a5c804a5e 100644 --- a/packages/riverpod_lint/lib/src/lints/functional_ref.dart +++ b/packages/riverpod_lint/lib/src/lints/functional_ref.dart @@ -11,7 +11,6 @@ import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:meta/meta.dart'; import '../riverpod_custom_lint.dart'; -import 'notifier_extends.dart'; class FunctionalRef extends RiverpodLintRule { const FunctionalRef() : super(code: _code); @@ -58,26 +57,6 @@ class FunctionalRef extends RiverpodLintRule { if (refNodeType.beginToken.lexeme != expectedRefName) { reporter.atNode(refNodeType, _code); } - - final expectedTypeArguments = - declaration.node.functionExpression.typeParameters?.typeParameters ?? - const []; - - final currentRefType = refNode.type; - if (currentRefType is! NamedType) { - reporter.atNode(refNodeType, _code); - return; - } - final actualTypeArguments = - currentRefType.typeArguments?.arguments ?? const []; - - if (!areGenericTypeArgumentsMatching( - expectedTypeArguments, - actualTypeArguments, - )) { - reporter.atNode(refNodeType, _code); - return; - } }); } diff --git a/packages/riverpod_lint_flutter_test/build.yaml b/packages/riverpod_lint_flutter_test/build.yaml index aee239ff4..43ef69596 100644 --- a/packages/riverpod_lint_flutter_test/build.yaml +++ b/packages/riverpod_lint_flutter_test/build.yaml @@ -8,3 +8,4 @@ targets: - test/lints/notifier_build.dart - test/lints/riverpod_syntax_error.dart - test/lints/functional_ref/failing_functional_ref.dart + - test/lints/notifier_extends/failing_notifier_extends.dart \ No newline at end of file diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/failing_notifier_extends.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/failing_notifier_extends.dart new file mode 100644 index 000000000..a07051376 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/failing_notifier_extends.dart @@ -0,0 +1,14 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@riverpod +// expect_lint: notifier_extends +class NoExtends { + int build() => 0; +} + +@riverpod +// expect_lint: notifier_extends +class WrongExtends extends AsyncNotifier { + int build() => 0; +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.dart similarity index 77% rename from packages/riverpod_lint_flutter_test/test/lints/notifier_extends.dart rename to packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.dart index 5a607d83b..0c134f500 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.dart @@ -1,4 +1,3 @@ -import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'notifier_extends.g.dart'; @@ -10,18 +9,6 @@ class MyNotifier extends _$MyNotifier { int build() => 0; } -@riverpod -// expect_lint: notifier_extends -class NoExtends { - int build() => 0; -} - -@riverpod -// expect_lint: notifier_extends -class WrongExtends extends AsyncNotifier { - int build() => 0; -} - // Regression test for https://github.com/rrousselGit/riverpod/issues/2165 @riverpod class _PrivateClass extends _$PrivateClass { diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart similarity index 85% rename from packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart rename to packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart index 4ab6766d5..edb112c21 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart @@ -75,144 +75,6 @@ abstract class _$MyNotifier extends $Notifier { int runBuild() => build(); } -@ProviderFor(NoExtends) -const noExtendsProvider = NoExtendsProvider._(); - -final class NoExtendsProvider extends $NotifierProvider { - const NoExtendsProvider._( - {super.runNotifierBuildOverride, NoExtends Function()? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'noExtendsProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final NoExtends Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$noExtendsHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - NoExtends create() => _createCb?.call() ?? NoExtends(); - - @$internal - @override - NoExtendsProvider $copyWithCreate( - NoExtends Function() create, - ) { - return NoExtendsProvider._(create: create); - } - - @$internal - @override - NoExtendsProvider $copyWithBuild( - int Function( - Ref, - NoExtends, - ) build, - ) { - return NoExtendsProvider._(runNotifierBuildOverride: build); - } - - @$internal - @override - $NotifierProviderElement $createElement( - $ProviderPointer pointer) => - $NotifierProviderElement(this, pointer); -} - -String _$noExtendsHash() => r'3f1276999a9a6d3676c628c25ed853cbefb21ce9'; - -abstract class _$NoExtends extends $Notifier { - int build(); - @$internal - @override - int runBuild() => build(); -} - -@ProviderFor(WrongExtends) -const wrongExtendsProvider = WrongExtendsProvider._(); - -final class WrongExtendsProvider extends $NotifierProvider { - const WrongExtendsProvider._( - {super.runNotifierBuildOverride, WrongExtends Function()? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'wrongExtendsProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final WrongExtends Function()? _createCb; - - @override - String debugGetCreateSourceHash() => _$wrongExtendsHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - WrongExtends create() => _createCb?.call() ?? WrongExtends(); - - @$internal - @override - WrongExtendsProvider $copyWithCreate( - WrongExtends Function() create, - ) { - return WrongExtendsProvider._(create: create); - } - - @$internal - @override - WrongExtendsProvider $copyWithBuild( - int Function( - Ref, - WrongExtends, - ) build, - ) { - return WrongExtendsProvider._(runNotifierBuildOverride: build); - } - - @$internal - @override - $NotifierProviderElement $createElement( - $ProviderPointer pointer) => - $NotifierProviderElement(this, pointer); -} - -String _$wrongExtendsHash() => r'6479055793af10a34e225373a67f7eaac4d7c0de'; - -abstract class _$WrongExtends extends $Notifier { - int build(); - @$internal - @override - int runBuild() => build(); -} - @ProviderFor(_PrivateClass) const _privateClassProvider = _PrivateClassProvider._(); diff --git a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart index 8c94f9cd9..e05d9ef45 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart @@ -64,7 +64,7 @@ final class KeepAliveProvider extends $FunctionalProvider } } -String _$keepAliveHash() => r'756ceaba79af550d4498a93ec30118f989cd5bb4'; +String _$keepAliveHash() => r'095b2cb2261b9d79721aa6552b8aaf0d8a7bb7ee'; @ProviderFor(KeepAliveClass) const keepAliveClassProvider = KeepAliveClassProvider._(); @@ -194,7 +194,7 @@ final class AutoDisposeProvider extends $FunctionalProvider } } -String _$autoDisposeHash() => r'd46d894171aed556a8b4deafeda4de6b9465f632'; +String _$autoDisposeHash() => r'1ace7b4b2957ecf77b683b868e91a2614fc77d03'; @ProviderFor(AutoDisposeClass) const autoDisposeClassProvider = AutoDisposeClassProvider._(); @@ -324,7 +324,7 @@ final class FnProvider extends $FunctionalProvider } } -String _$fnHash() => r'9e89e9bead8aa30a86f31bd16f4106c4b38e8f2b'; +String _$fnHash() => r'e96b0302f7492f5aecedd46f6edeeea456839d01'; // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart index 5d6c8ecaa..ce0674122 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart @@ -249,69 +249,6 @@ final class WatchScopedButNoDependenciesProvider String _$watchScopedButNoDependenciesHash() => r'e326226fdc19ea7a4430900154c071f5a1a98e40'; -typedef WatchExternalButNoDependenciesRef = Ref; - -@ProviderFor(watchExternalButNoDependencies) -const watchExternalButNoDependenciesProvider = - WatchExternalButNoDependenciesProvider._(); - -final class WatchExternalButNoDependenciesProvider - extends $FunctionalProvider - with $Provider { - const WatchExternalButNoDependenciesProvider._( - {int Function( - WatchExternalButNoDependenciesRef ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'watchExternalButNoDependenciesProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - WatchExternalButNoDependenciesRef ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$watchExternalButNoDependenciesHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - WatchExternalButNoDependenciesProvider $copyWithCreate( - int Function( - WatchExternalButNoDependenciesRef ref, - ) create, - ) { - return WatchExternalButNoDependenciesProvider._(create: create); - } - - @override - int create(WatchExternalButNoDependenciesRef ref) { - final _$cb = _createCb ?? watchExternalButNoDependencies; - return _$cb(ref); - } -} - -String _$watchExternalButNoDependenciesHash() => - r'2ed9c528aa61dbb5d1cf274d41b527d761c3d522'; - typedef WatchGeneratedScopedButNoDependenciesRef = Ref; @ProviderFor(watchGeneratedScopedButNoDependencies) @@ -1997,7 +1934,7 @@ final class FooProvider extends $FunctionalProvider } } -String _$fooHash() => r'f9ce60fe868c2c54aa282702554861a13e8871cd'; +String _$fooHash() => r'a390b7b969bb0eec183426bfc85bec32750e9475'; typedef CrossFileDependencyRef = Ref; @@ -2058,7 +1995,7 @@ final class CrossFileDependencyProvider extends $FunctionalProvider } String _$crossFileDependencyHash() => - r'9ca6b69de674377c6906fb835cbe04d01851d088'; + r'3ab740fe1903f2c126412df43ee34eed87a6f4fe'; // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart index b9662253f..decf8ed18 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart @@ -64,7 +64,7 @@ final class RootProvider extends $FunctionalProvider } } -String _$rootHash() => r'1cd85d73316aad02169ff0f5e7af5cf1423410ff'; +String _$rootHash() => r'dda8bbb46cb4d7c658597669e3be92e2447dcfb0'; typedef DepRef = Ref; @@ -124,7 +124,7 @@ final class DepProvider extends $FunctionalProvider } } -String _$depHash() => r'749c4d696d29c72686cabcabd6fa7855f5cbf4db'; +String _$depHash() => r'578a350a40cda46444ecd9fa3ea2fd7bd0994692'; typedef Dep2Ref = Ref; @@ -184,7 +184,7 @@ final class Dep2Provider extends $FunctionalProvider } } -String _$dep2Hash() => r'13cd909366c79168e3d9cd95f529ddbcee6de7dc'; +String _$dep2Hash() => r'97901e825cdcf5b1ac455b0fe8a2111662ce9f13'; //////////// typedef ExtraDepRef = Ref; @@ -254,7 +254,7 @@ final class ExtraDepProvider extends $FunctionalProvider } } -String _$extraDepHash() => r'038d9c819b5d91eb1f7166194d8e646f17ea24d7'; +String _$extraDepHash() => r'586c1a0f0ac120f8608c025a6a47fe5282b80320'; typedef NoDepRef = Ref; @@ -318,7 +318,7 @@ final class NoDepProvider extends $FunctionalProvider } } -String _$noDepHash() => r'38d78ded1eba491968c0200cc0b51969fcf3ec9a'; +String _$noDepHash() => r'99022366e7dd3e19464747d1e2f23184691aa134'; typedef DependenciesFirstThenKeepAliveRef = Ref; @@ -385,7 +385,7 @@ final class DependenciesFirstThenKeepAliveProvider } String _$dependenciesFirstThenKeepAliveHash() => - r'15604dafd167408515dfb4e846fab0af46e7e566'; + r'b9bd9082ce9a72feea33f9327b26e7b428cadfd3'; typedef NoDepNoParamRef = Ref; @@ -449,7 +449,7 @@ final class NoDepNoParamProvider extends $FunctionalProvider } } -String _$noDepNoParamHash() => r'fe52f15a4d98159beafe8b9a177073f6b6cbae6d'; +String _$noDepNoParamHash() => r'ea3e66e28bbfb716adf89cea37a1607c78283e06'; typedef NoDepWithoutCommaRef = Ref; @@ -513,7 +513,7 @@ final class NoDepWithoutCommaProvider extends $FunctionalProvider } } -String _$noDepWithoutCommaHash() => r'59d5a7874da40605b1b187766ebb4927d2eaae81'; +String _$noDepWithoutCommaHash() => r'a3b07e526b4829ee4ed1848de4ff64c3b05c1a30'; typedef RootDepRef = Ref; @@ -577,7 +577,7 @@ final class RootDepProvider extends $FunctionalProvider } } -String _$rootDepHash() => r'a57728bf865d5a9a73f40f08b038946418cdcf52'; +String _$rootDepHash() => r'c406dc7e58c18bc46ed722a81208bc13fe62654a'; // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart index 31a8dbb5b..7da7a768a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart @@ -64,7 +64,7 @@ final class ScopedProvider extends $FunctionalProvider } } -String _$scopedHash() => r'bbf25968b1186d2dd63d10545364453712d491cf'; +String _$scopedHash() => r'5a271e9b23e18517694454448b922a6c9d03781e'; typedef RootRef = Ref; @@ -124,7 +124,7 @@ final class RootProvider extends $FunctionalProvider } } -String _$rootHash() => r'1cd85d73316aad02169ff0f5e7af5cf1423410ff'; +String _$rootHash() => r'dda8bbb46cb4d7c658597669e3be92e2447dcfb0'; // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package From b705da0031015cb6fd20cd10bdf0566e284011ba Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Nov 2024 16:33:22 +0100 Subject: [PATCH 356/387] Updated generated files --- examples/counter/lib/main.g.dart | 2 +- examples/pub/lib/detail.g.dart | 48 +-- examples/pub/lib/search.g.dart | 16 +- examples/stackoverflow/lib/common.g.dart | 20 +- examples/stackoverflow/lib/question.g.dart | 28 +- examples/stackoverflow/lib/tag.g.dart | 16 +- .../build_yaml/lib/dependencies.g.dart | 14 +- .../integration/build_yaml/lib/main.g.dart | 98 +++--- .../test/integration/annotated.g.dart | 69 ++-- .../test/integration/async.g.dart | 90 +++-- .../test/integration/auto_dispose.g.dart | 78 ++--- .../test/integration/dependencies.g.dart | 176 ++++------ .../test/integration/dependencies2.g.dart | 60 ++-- .../test/integration/documented.g.dart | 37 +- .../test/integration/generated.g.dart | 120 +++---- .../test/integration/hash/hash1.g.dart | 26 +- .../test/integration/hash/retry.g.dart | 26 +- .../test/integration/scopes.g.dart | 6 +- .../test/integration/split.g.dart | 24 +- .../test/integration/stream.g.dart | 69 ++-- .../test/integration/sync.g.dart | 274 +++++++-------- .../generated/golden/lib/sync.g.dart | 63 ++-- ..._class_based_provider_to_functional.g.dart | 12 +- ..._functional_provider_to_class_based.g.dart | 28 +- .../avoid_build_context_in_providers.g.dart | 20 +- .../avoid_public_notifier_properties.g.dart | 4 +- .../functional_ref/functional_ref.g.dart | 41 +-- .../notifier_extends/notifier_extends.g.dart | 29 +- ...ly_use_keep_alive_inside_keep_alive.g.dart | 40 +-- .../protected_notifier_properties.g.dart | 36 +- .../provider_dependencies/another.g.dart | 36 +- .../missing_dependencies.g.dart | 127 +++---- .../missing_dependencies2.g.dart | 315 +++++++----------- .../unused_dependency.g.dart | 110 +++--- .../test/lints/provider_parameters.g.dart | 14 +- ...oviders_should_specify_dependencies.g.dart | 26 +- .../test/lints/unknown_scoped_usage.g.dart | 24 +- .../lints/unsupported_provider_value.g.dart | 176 ++++------ .../advanced/select/select/codegen.g.dart | 12 +- .../select/select_async/codegen.g.dart | 26 +- .../cancel/detail_screen/codegen.g.dart | 12 +- .../detail_screen_cancel/codegen.g.dart | 12 +- .../detail_screen_debounce/codegen.g.dart | 12 +- .../provider_with_extension/codegen.g.dart | 12 +- .../fetch_activity/codegen.g.dart | 12 +- .../pull_to_refresh/full_app/codegen.g.dart | 12 +- .../docs/concepts/about_codegen/main.g.dart | 14 +- .../provider_type/async_class_future.g.dart | 2 +- .../provider_type/async_class_stream.g.dart | 2 +- .../provider_type/async_fn_future.g.dart | 12 +- .../provider_type/async_fn_stream.g.dart | 12 +- .../provider_type/auto_dispose.g.dart | 24 +- .../about_codegen/provider_type/family.g.dart | 14 +- .../provider_type/family_class.g.dart | 4 +- .../provider_type/family_fn.g.dart | 14 +- .../provider_type/sync_class.g.dart | 2 +- .../provider_type/sync_fn.g.dart | 12 +- .../characters_provider/codegen.g.dart | 42 +-- .../city_provider/codegen.g.dart | 12 +- .../codegen.g.dart | 26 +- .../read_in_provider/codegen.g.dart | 24 +- .../select_async_provider/codegen.g.dart | 28 +- .../todo_list_provider/codegen.g.dart | 2 +- .../weather_provider/codegen.g.dart | 24 +- .../whole_object_provider/codegen.g.dart | 28 +- .../lifecycle_on_dispose/codegen.g.dart | 12 +- .../creating_a_provider/codegen.g.dart | 12 +- .../declaring_many_providers/codegen.g.dart | 24 +- .../concepts/reading/counter/codegen.g.dart | 16 +- .../concepts/reading/listen/codegen.g.dart | 12 +- .../reading/listen_build/codegen.g.dart | 2 +- .../reading/listen_build/codegen_hooks.g.dart | 2 +- .../concepts/reading/provider/codegen.g.dart | 24 +- .../docs/concepts/reading/read/codegen.g.dart | 2 +- .../reading/read/codegen_hooks.g.dart | 2 +- .../reading/read_build/codegen.g.dart | 2 +- .../read_notifier_build/codegen.g.dart | 2 +- .../concepts/reading/watch/codegen.g.dart | 26 +- .../reading/watch_build/codegen.g.dart | 14 +- .../reading/watch_build/codegen_hooks.g.dart | 14 +- .../watch_notifier_build/codegen.g.dart | 2 +- .../concepts/why_immutability/codegen.g.dart | 2 +- .../cache_for_usage/codegen.g.dart | 12 +- .../auto_dispose/codegen_keep_alive.g.dart | 12 +- .../invalidate_family_example/codegen.g.dart | 14 +- .../auto_dispose/keep_alive/codegen.g.dart | 12 +- .../on_dispose_example/codegen.g.dart | 24 +- .../functional_ref/codegen.g.dart | 24 +- .../listen_example/codegen.g.dart | 26 +- .../notifier_ref/codegen.g.dart | 14 +- .../read_example/codegen.g.dart | 16 +- .../watch_example/codegen.g.dart | 26 +- .../watch_placement/codegen.g.dart | 28 +- .../require_value/codegen.g.dart | 12 +- .../first_request/codegen/provider.g.dart | 15 +- .../passing_args/family/codegen.g.dart | 20 +- .../no_arg_provider/codegen.g.dart | 14 +- .../codegen/todo_list_notifier.g.dart | 2 +- .../todo_list_notifier_add_todo.g.dart | 2 +- .../codegen/todo_list_provider.g.dart | 12 +- .../testing/notifier_mock/codegen.g.dart | 2 +- .../testing/provider_to_mock/codegen.g.dart | 12 +- .../pipe_change_notifier.g.dart | 17 +- .../websockets_sync/raw_usage.g.dart | 12 +- .../shared_pipe_change_notifier.g.dart | 28 +- .../stream_provider/codegen.g.dart | 12 +- .../sync_definition/codegen.g.dart | 12 +- .../docs/from_provider/family/family.g.dart | 14 +- .../async_values/async_values.g.dart | 24 +- .../auto_dispose/auto_dispose.g.dart | 24 +- .../motivation/combine/combine.g.dart | 24 +- .../motivation/same_type/same_type.g.dart | 24 +- .../dart_hello_world/main.g.dart | 12 +- .../hello_world/hooks_codegen/main.g.dart | 12 +- .../getting_started/hello_world/main.g.dart | 12 +- .../introduction/why_riverpod/codegen.g.dart | 16 +- .../declaration/declaration.g.dart | 2 +- .../initialization/initialization.g.dart | 2 +- .../migrated/migrated.g.dart | 2 +- .../add_listener/add_listener.g.dart | 2 +- .../async_notifier/async_notifier.g.dart | 2 +- .../build_init/build_init.g.dart | 2 +- .../family_and_dispose.g.dart | 20 +- .../from_state_provider.g.dart | 2 +- .../old_lifecycles/old_lifecycles.g.dart | 2 +- .../old_lifecycles_final.g.dart | 30 +- .../config_provider/codegen.g.dart | 14 +- .../remote_todos/codegen.g.dart | 2 +- .../notifier_provider/todos/codegen.g.dart | 2 +- .../completed_todos/completed_todos.g.dart | 12 +- .../optimized_previous_button.g.dart | 14 +- .../docs/providers/provider/todo/todo.g.dart | 2 +- .../unoptimized_previous_button.g.dart | 2 +- .../live_stream_chat_provider/codegen.g.dart | 12 +- website/static/snippets/async.g.dart | 14 +- website/static/snippets/combine.g.dart | 40 +-- website/static/snippets/create.g.dart | 12 +- website/static/snippets/declare.g.dart | 2 +- 138 files changed, 1544 insertions(+), 2168 deletions(-) diff --git a/examples/counter/lib/main.g.dart b/examples/counter/lib/main.g.dart index e2f13fdc0..de01a3856 100644 --- a/examples/counter/lib/main.g.dart +++ b/examples/counter/lib/main.g.dart @@ -64,7 +64,7 @@ final class CounterProvider extends $NotifierProvider { @override CounterProvider $copyWithBuild( int Function( - Ref, + Ref, Counter, ) build, ) { diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart index 116d43511..634aec783 100644 --- a/examples/pub/lib/detail.g.dart +++ b/examples/pub/lib/detail.g.dart @@ -8,21 +8,17 @@ part of 'detail.dart'; // RiverpodGenerator // ************************************************************************** -typedef FetchPackageDetailsRef = Ref>; - @ProviderFor(fetchPackageDetails) const fetchPackageDetailsProvider = FetchPackageDetailsFamily._(); final class FetchPackageDetailsProvider extends $FunctionalProvider, FutureOr> - with - $FutureModifier, - $FutureProvider { + with $FutureModifier, $FutureProvider { const FetchPackageDetailsProvider._( {required FetchPackageDetailsFamily super.from, required String super.argument, FutureOr Function( - FetchPackageDetailsRef ref, { + Ref ref, { required String packageName, })? create}) : _createCb = create, @@ -35,7 +31,7 @@ final class FetchPackageDetailsProvider ); final FutureOr Function( - FetchPackageDetailsRef ref, { + Ref ref, { required String packageName, })? _createCb; @@ -57,7 +53,7 @@ final class FetchPackageDetailsProvider @override FetchPackageDetailsProvider $copyWithCreate( FutureOr Function( - FetchPackageDetailsRef ref, + Ref ref, ) create, ) { return FetchPackageDetailsProvider._( @@ -71,7 +67,7 @@ final class FetchPackageDetailsProvider } @override - FutureOr create(FetchPackageDetailsRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? fetchPackageDetails; final argument = this.argument as String; return _$cb( @@ -118,7 +114,7 @@ final class FetchPackageDetailsFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( FutureOr Function( - FetchPackageDetailsRef ref, + Ref ref, String args, ) create, ) { @@ -137,19 +133,15 @@ final class FetchPackageDetailsFamily extends Family { } } -typedef LikedPackagesRef = Ref>>; - @ProviderFor(likedPackages) const likedPackagesProvider = LikedPackagesProvider._(); final class LikedPackagesProvider extends $FunctionalProvider< AsyncValue>, FutureOr>> - with - $FutureModifier>, - $FutureProvider, LikedPackagesRef> { + with $FutureModifier>, $FutureProvider> { const LikedPackagesProvider._( {FutureOr> Function( - LikedPackagesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -163,7 +155,7 @@ final class LikedPackagesProvider extends $FunctionalProvider< ); final FutureOr> Function( - LikedPackagesRef ref, + Ref ref, )? _createCb; @override @@ -178,14 +170,14 @@ final class LikedPackagesProvider extends $FunctionalProvider< @override LikedPackagesProvider $copyWithCreate( FutureOr> Function( - LikedPackagesRef ref, + Ref ref, ) create, ) { return LikedPackagesProvider._(create: create); } @override - FutureOr> create(LikedPackagesRef ref) { + FutureOr> create(Ref ref) { final _$cb = _createCb ?? likedPackages; return _$cb(ref); } @@ -193,17 +185,15 @@ final class LikedPackagesProvider extends $FunctionalProvider< String _$likedPackagesHash() => r'8debee8d8fa48334d1de21fa9bbf03224265d29d'; -typedef PubRepositoryRef = Ref; - @ProviderFor(pubRepository) const pubRepositoryProvider = PubRepositoryProvider._(); final class PubRepositoryProvider extends $FunctionalProvider - with $Provider { + with $Provider { const PubRepositoryProvider._( {PubRepository Function( - PubRepositoryRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -217,7 +207,7 @@ final class PubRepositoryProvider ); final PubRepository Function( - PubRepositoryRef ref, + Ref ref, )? _createCb; @override @@ -239,14 +229,14 @@ final class PubRepositoryProvider @override PubRepositoryProvider $copyWithCreate( PubRepository Function( - PubRepositoryRef ref, + Ref ref, ) create, ) { return PubRepositoryProvider._(create: create); } @override - PubRepository create(PubRepositoryRef ref) { + PubRepository create(Ref ref) { final _$cb = _createCb ?? pubRepository; return _$cb(ref); } @@ -319,7 +309,7 @@ final class PackageMetricsProvider @override PackageMetricsProvider $copyWithBuild( FutureOr Function( - Ref>, + Ref, PackageMetrics, ) build, ) { @@ -402,9 +392,7 @@ final class PackageMetricsFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( FutureOr Function( - Ref> ref, - PackageMetrics notifier, - String argument) + Ref ref, PackageMetrics notifier, String argument) build, ) { return $FamilyOverride( diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart index 3a0818fbf..571727cdf 100644 --- a/examples/pub/lib/search.g.dart +++ b/examples/pub/lib/search.g.dart @@ -8,16 +8,12 @@ part of 'search.dart'; // RiverpodGenerator // ************************************************************************** -typedef FetchPackagesRef = Ref>>; - @ProviderFor(fetchPackages) const fetchPackagesProvider = FetchPackagesFamily._(); final class FetchPackagesProvider extends $FunctionalProvider< AsyncValue>, FutureOr>> - with - $FutureModifier>, - $FutureProvider, FetchPackagesRef> { + with $FutureModifier>, $FutureProvider> { const FetchPackagesProvider._( {required FetchPackagesFamily super.from, required ({ @@ -26,7 +22,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< }) super.argument, FutureOr> Function( - FetchPackagesRef ref, { + Ref ref, { required int page, String search, })? create}) @@ -40,7 +36,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< ); final FutureOr> Function( - FetchPackagesRef ref, { + Ref ref, { required int page, String search, })? _createCb; @@ -64,7 +60,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< @override FetchPackagesProvider $copyWithCreate( FutureOr> Function( - FetchPackagesRef ref, + Ref ref, ) create, ) { return FetchPackagesProvider._( @@ -82,7 +78,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< } @override - FutureOr> create(FetchPackagesRef ref) { + FutureOr> create(Ref ref) { final _$cb = _createCb ?? fetchPackages; final argument = this.argument as ({ int page, @@ -136,7 +132,7 @@ final class FetchPackagesFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( FutureOr> Function( - FetchPackagesRef ref, + Ref ref, ({ int page, String search, diff --git a/examples/stackoverflow/lib/common.g.dart b/examples/stackoverflow/lib/common.g.dart index b982683fa..21effce3f 100644 --- a/examples/stackoverflow/lib/common.g.dart +++ b/examples/stackoverflow/lib/common.g.dart @@ -8,12 +8,6 @@ part of 'common.dart'; // RiverpodGenerator // ************************************************************************** -/// A Provider that exposes the current theme. -/// -/// This is unimplemented by default, and will be overridden inside [MaterialApp] -/// with the current theme obtained using a [BuildContext]. -typedef ThemeRef = Ref; - /// A Provider that exposes the current theme. /// /// This is unimplemented by default, and will be overridden inside [MaterialApp] @@ -26,14 +20,14 @@ const themeProvider = ThemeProvider._(); /// This is unimplemented by default, and will be overridden inside [MaterialApp] /// with the current theme obtained using a [BuildContext]. final class ThemeProvider extends $FunctionalProvider - with $Provider { + with $Provider { /// A Provider that exposes the current theme. /// /// This is unimplemented by default, and will be overridden inside [MaterialApp] /// with the current theme obtained using a [BuildContext]. const ThemeProvider._( {ThemeData Function( - ThemeRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -47,7 +41,7 @@ final class ThemeProvider extends $FunctionalProvider ); final ThemeData Function( - ThemeRef ref, + Ref ref, )? _createCb; @override @@ -69,20 +63,20 @@ final class ThemeProvider extends $FunctionalProvider @override ThemeProvider $copyWithCreate( ThemeData Function( - ThemeRef ref, + Ref ref, ) create, ) { return ThemeProvider._(create: create); } @override - ThemeData create(ThemeRef ref) { + ThemeData create(Ref ref) { final _$cb = _createCb ?? theme; return _$cb(ref); } } -String _$themeHash() => r'ff39eda97684261eefc24ddb24e41172880644cd'; +String _$themeHash() => r'0fea6438c8bee8be98515c10e8e67c2e75c6af46'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/examples/stackoverflow/lib/question.g.dart b/examples/stackoverflow/lib/question.g.dart index 159693d48..11f440f5d 100644 --- a/examples/stackoverflow/lib/question.g.dart +++ b/examples/stackoverflow/lib/question.g.dart @@ -63,20 +63,6 @@ Map _$$QuestionImplToJson(_$QuestionImpl instance) => // RiverpodGenerator // ************************************************************************** -/// A scoped provider, exposing the current question used by [QuestionItem]. -/// -/// This is used as a performance optimization to pass a [Question] to -/// [QuestionItem], while still instantiating [QuestionItem] using the `const` -/// keyword. -/// -/// This allows [QuestionItem] to rebuild less often. -/// By doing so, even when using [QuestionItem] in a [ListView], even if new -/// questions are obtained, previously rendered [QuestionItem]s won't rebuild. -/// -/// This is an optional step. Since scoping is a fairly advanced mechanism, -/// it's entirely fine to simply pass the [Question] to [QuestionItem] directly. -typedef CurrentQuestionRef = Ref>; - /// A scoped provider, exposing the current question used by [QuestionItem]. /// /// This is used as a performance optimization to pass a [Question] to @@ -106,7 +92,7 @@ const currentQuestionProvider = CurrentQuestionProvider._(); /// it's entirely fine to simply pass the [Question] to [QuestionItem] directly. final class CurrentQuestionProvider extends $FunctionalProvider, AsyncValue> - with $Provider, CurrentQuestionRef> { + with $Provider> { /// A scoped provider, exposing the current question used by [QuestionItem]. /// /// This is used as a performance optimization to pass a [Question] to @@ -121,7 +107,7 @@ final class CurrentQuestionProvider /// it's entirely fine to simply pass the [Question] to [QuestionItem] directly. const CurrentQuestionProvider._( {AsyncValue Function( - CurrentQuestionRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -135,7 +121,7 @@ final class CurrentQuestionProvider ); final AsyncValue Function( - CurrentQuestionRef ref, + Ref ref, )? _createCb; @override @@ -158,20 +144,20 @@ final class CurrentQuestionProvider @override CurrentQuestionProvider $copyWithCreate( AsyncValue Function( - CurrentQuestionRef ref, + Ref ref, ) create, ) { return CurrentQuestionProvider._(create: create); } @override - AsyncValue create(CurrentQuestionRef ref) { + AsyncValue create(Ref ref) { final _$cb = _createCb ?? currentQuestion; return _$cb(ref); } } -String _$currentQuestionHash() => r'2179e068c1d64674dc292a1a027e9e338284c57f'; +String _$currentQuestionHash() => r'e9359841a5b980cd7b8c79a0b56cb98878190861'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/examples/stackoverflow/lib/tag.g.dart b/examples/stackoverflow/lib/tag.g.dart index ffb3b78f6..510f04b06 100644 --- a/examples/stackoverflow/lib/tag.g.dart +++ b/examples/stackoverflow/lib/tag.g.dart @@ -8,16 +8,14 @@ part of 'tag.dart'; // RiverpodGenerator // ************************************************************************** -typedef TagThemeRef = Ref; - @ProviderFor(tagTheme) const tagThemeProvider = TagThemeProvider._(); final class TagThemeProvider extends $FunctionalProvider - with $Provider { + with $Provider { const TagThemeProvider._( {TagTheme Function( - TagThemeRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -35,7 +33,7 @@ final class TagThemeProvider extends $FunctionalProvider static const $allTransitiveDependencies0 = themeProvider; final TagTheme Function( - TagThemeRef ref, + Ref ref, )? _createCb; @override @@ -57,20 +55,20 @@ final class TagThemeProvider extends $FunctionalProvider @override TagThemeProvider $copyWithCreate( TagTheme Function( - TagThemeRef ref, + Ref ref, ) create, ) { return TagThemeProvider._(create: create); } @override - TagTheme create(TagThemeRef ref) { + TagTheme create(Ref ref) { final _$cb = _createCb ?? tagTheme; return _$cb(ref); } } -String _$tagThemeHash() => r'bf5d051ea43e2f60d370096bb756aa81f21e9d68'; +String _$tagThemeHash() => r'ccf06d5f6b009c601edd44f88bf4f853708c38df'; // ignore_for_file: type=lint -// ignore_for_file: deprecated_member_use_from_same_package, unreachable_from_main, invalid_use_of_internal_member +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/integration/build_yaml/lib/dependencies.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/dependencies.g.dart index 21a7daa43..dfcc891f4 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/dependencies.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/dependencies.g.dart @@ -6,18 +6,16 @@ part of 'dependencies.dart'; // RiverpodGenerator // ************************************************************************** -typedef Calc2Ref = Ref; - @ProviderFor(calc2) const myFamilyCalc2ProviderFamily = Calc2Family._(); final class Calc2Provider extends $FunctionalProvider - with $Provider { + with $Provider { const Calc2Provider._( {required Calc2Family super.from, required String super.argument, int Function( - Calc2Ref ref, + Ref ref, String id, )? create}) : _createCb = create, @@ -46,7 +44,7 @@ final class Calc2Provider extends $FunctionalProvider myFamilyCountStreamNotifier2ProviderFamily; final int Function( - Calc2Ref ref, + Ref ref, String id, )? _createCb; @@ -76,7 +74,7 @@ final class Calc2Provider extends $FunctionalProvider @override Calc2Provider $copyWithCreate( int Function( - Calc2Ref ref, + Ref ref, ) create, ) { return Calc2Provider._( @@ -90,7 +88,7 @@ final class Calc2Provider extends $FunctionalProvider } @override - int create(Calc2Ref ref) { + int create(Ref ref) { final _$cb = _createCb ?? calc2; final argument = this.argument as String; return _$cb( @@ -162,7 +160,7 @@ final class Calc2Family extends Family { /// {@macro riverpod.override_with} Override overrideWith( int Function( - Calc2Ref ref, + Ref ref, String args, ) create, ) { diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart index 8e34f6f68..2f67f0f14 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.g.dart @@ -6,16 +6,14 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -typedef CountRef = Ref; - @ProviderFor(count) const myCountPod = CountProvider._(); final class CountProvider extends $FunctionalProvider - with $Provider { + with $Provider { const CountProvider._( {int Function( - CountRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class CountProvider extends $FunctionalProvider ); final int Function( - CountRef ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class CountProvider extends $FunctionalProvider @override CountProvider $copyWithCreate( int Function( - CountRef ref, + Ref ref, ) create, ) { return CountProvider._(create: create); } @override - int create(CountRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? count; return _$cb(ref); } @@ -66,17 +64,15 @@ final class CountProvider extends $FunctionalProvider String _$countHash() => r'a31bb5cbb0ddb2466df2cc62a306709ea24fae12'; -typedef CountFutureRef = Ref>; - @ProviderFor(countFuture) const myCountFuturePod = CountFutureProvider._(); final class CountFutureProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const CountFutureProvider._( {FutureOr Function( - CountFutureRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -90,7 +86,7 @@ final class CountFutureProvider ); final FutureOr Function( - CountFutureRef ref, + Ref ref, )? _createCb; @override @@ -104,14 +100,14 @@ final class CountFutureProvider @override CountFutureProvider $copyWithCreate( FutureOr Function( - CountFutureRef ref, + Ref ref, ) create, ) { return CountFutureProvider._(create: create); } @override - FutureOr create(CountFutureRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? countFuture; return _$cb(ref); } @@ -119,17 +115,15 @@ final class CountFutureProvider String _$countFutureHash() => r'c292214b486fdd9ec98a61e277812f29fc4b5802'; -typedef CountStreamRef = Ref>; - @ProviderFor(countStream) const myCountStreamPod = CountStreamProvider._(); final class CountStreamProvider extends $FunctionalProvider, Stream> - with $FutureModifier, $StreamProvider { + with $FutureModifier, $StreamProvider { const CountStreamProvider._( {Stream Function( - CountStreamRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -143,7 +137,7 @@ final class CountStreamProvider ); final Stream Function( - CountStreamRef ref, + Ref ref, )? _createCb; @override @@ -157,14 +151,14 @@ final class CountStreamProvider @override CountStreamProvider $copyWithCreate( Stream Function( - CountStreamRef ref, + Ref ref, ) create, ) { return CountStreamProvider._(create: create); } @override - Stream create(CountStreamRef ref) { + Stream create(Ref ref) { final _$cb = _createCb ?? countStream; return _$cb(ref); } @@ -219,7 +213,7 @@ final class CountNotifierProvider @override CountNotifierProvider $copyWithBuild( int Function( - Ref, + Ref, CountNotifier, ) build, ) { @@ -281,7 +275,7 @@ final class CountAsyncNotifierProvider @override CountAsyncNotifierProvider $copyWithBuild( FutureOr Function( - Ref>, + Ref, CountAsyncNotifier, ) build, ) { @@ -344,7 +338,7 @@ final class CountStreamNotifierProvider @override CountStreamNotifierProvider $copyWithBuild( Stream Function( - Ref>, + Ref, CountStreamNotifier, ) build, ) { @@ -368,18 +362,16 @@ abstract class _$CountStreamNotifier extends $StreamNotifier { Stream runBuild() => build(); } -typedef Count2Ref = Ref; - @ProviderFor(count2) const myFamilyCount2ProviderFamily = Count2Family._(); final class Count2Provider extends $FunctionalProvider - with $Provider { + with $Provider { const Count2Provider._( {required Count2Family super.from, required int super.argument, int Function( - Count2Ref ref, + Ref ref, int a, )? create}) : _createCb = create, @@ -392,7 +384,7 @@ final class Count2Provider extends $FunctionalProvider ); final int Function( - Count2Ref ref, + Ref ref, int a, )? _createCb; @@ -422,7 +414,7 @@ final class Count2Provider extends $FunctionalProvider @override Count2Provider $copyWithCreate( int Function( - Count2Ref ref, + Ref ref, ) create, ) { return Count2Provider._( @@ -436,7 +428,7 @@ final class Count2Provider extends $FunctionalProvider } @override - int create(Count2Ref ref) { + int create(Ref ref) { final _$cb = _createCb ?? count2; final argument = this.argument as int; return _$cb( @@ -482,7 +474,7 @@ final class Count2Family extends Family { /// {@macro riverpod.override_with} Override overrideWith( int Function( - Count2Ref ref, + Ref ref, int args, ) create, ) { @@ -501,19 +493,17 @@ final class Count2Family extends Family { } } -typedef CountFuture2Ref = Ref>; - @ProviderFor(countFuture2) const myFamilyCountFuture2ProviderFamily = CountFuture2Family._(); final class CountFuture2Provider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const CountFuture2Provider._( {required CountFuture2Family super.from, required int super.argument, FutureOr Function( - CountFuture2Ref ref, + Ref ref, int a, )? create}) : _createCb = create, @@ -526,7 +516,7 @@ final class CountFuture2Provider ); final FutureOr Function( - CountFuture2Ref ref, + Ref ref, int a, )? _createCb; @@ -548,7 +538,7 @@ final class CountFuture2Provider @override CountFuture2Provider $copyWithCreate( FutureOr Function( - CountFuture2Ref ref, + Ref ref, ) create, ) { return CountFuture2Provider._( @@ -562,7 +552,7 @@ final class CountFuture2Provider } @override - FutureOr create(CountFuture2Ref ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? countFuture2; final argument = this.argument as int; return _$cb( @@ -608,7 +598,7 @@ final class CountFuture2Family extends Family { /// {@macro riverpod.override_with} Override overrideWith( FutureOr Function( - CountFuture2Ref ref, + Ref ref, int args, ) create, ) { @@ -627,19 +617,17 @@ final class CountFuture2Family extends Family { } } -typedef CountStream2Ref = Ref>; - @ProviderFor(countStream2) const myFamilyCountStream2ProviderFamily = CountStream2Family._(); final class CountStream2Provider extends $FunctionalProvider, Stream> - with $FutureModifier, $StreamProvider { + with $FutureModifier, $StreamProvider { const CountStream2Provider._( {required CountStream2Family super.from, required int super.argument, Stream Function( - CountStream2Ref ref, + Ref ref, int a, )? create}) : _createCb = create, @@ -652,7 +640,7 @@ final class CountStream2Provider ); final Stream Function( - CountStream2Ref ref, + Ref ref, int a, )? _createCb; @@ -674,7 +662,7 @@ final class CountStream2Provider @override CountStream2Provider $copyWithCreate( Stream Function( - CountStream2Ref ref, + Ref ref, ) create, ) { return CountStream2Provider._( @@ -688,7 +676,7 @@ final class CountStream2Provider } @override - Stream create(CountStream2Ref ref) { + Stream create(Ref ref) { final _$cb = _createCb ?? countStream2; final argument = this.argument as int; return _$cb( @@ -734,7 +722,7 @@ final class CountStream2Family extends Family { /// {@macro riverpod.override_with} Override overrideWith( Stream Function( - CountStream2Ref ref, + Ref ref, int args, ) create, ) { @@ -811,7 +799,7 @@ final class CountNotifier2Provider @override CountNotifier2Provider $copyWithBuild( int Function( - Ref, + Ref, CountNotifier2, ) build, ) { @@ -883,7 +871,7 @@ final class CountNotifier2Family extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - int Function(Ref ref, CountNotifier2 notifier, int argument) build, + int Function(Ref ref, CountNotifier2 notifier, int argument) build, ) { return $FamilyOverride( from: this, @@ -964,7 +952,7 @@ final class CountAsyncNotifier2Provider @override CountAsyncNotifier2Provider $copyWithBuild( FutureOr Function( - Ref>, + Ref, CountAsyncNotifier2, ) build, ) { @@ -1037,8 +1025,7 @@ final class CountAsyncNotifier2Family extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - FutureOr Function(Ref> ref, - CountAsyncNotifier2 notifier, int argument) + FutureOr Function(Ref ref, CountAsyncNotifier2 notifier, int argument) build, ) { return $FamilyOverride( @@ -1121,7 +1108,7 @@ final class CountStreamNotifier2Provider @override CountStreamNotifier2Provider $copyWithBuild( Stream Function( - Ref>, + Ref, CountStreamNotifier2, ) build, ) { @@ -1194,8 +1181,7 @@ final class CountStreamNotifier2Family extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - Stream Function(Ref> ref, - CountStreamNotifier2 notifier, int argument) + Stream Function(Ref ref, CountStreamNotifier2 notifier, int argument) build, ) { return $FamilyOverride( diff --git a/packages/riverpod_generator/test/integration/annotated.g.dart b/packages/riverpod_generator/test/integration/annotated.g.dart index 95ad17e48..f8f5a688a 100644 --- a/packages/riverpod_generator/test/integration/annotated.g.dart +++ b/packages/riverpod_generator/test/integration/annotated.g.dart @@ -6,8 +6,6 @@ part of 'annotated.dart'; // RiverpodGenerator // ************************************************************************** -typedef FunctionalRef = Ref; - @ProviderFor(functional) @Deprecated('Deprecation message') @visibleForTesting @@ -15,12 +13,12 @@ typedef FunctionalRef = Ref; const functionalProvider = FunctionalFamily._(); final class FunctionalProvider extends $FunctionalProvider - with $Provider { + with $Provider { const FunctionalProvider._( {required FunctionalFamily super.from, required int super.argument, String Function( - FunctionalRef ref, + Ref ref, @Deprecated('field') int id, )? create}) : _createCb = create, @@ -33,7 +31,7 @@ final class FunctionalProvider extends $FunctionalProvider ); final String Function( - FunctionalRef ref, + Ref ref, @Deprecated('field') int id, )? _createCb; @@ -63,7 +61,7 @@ final class FunctionalProvider extends $FunctionalProvider @override FunctionalProvider $copyWithCreate( String Function( - FunctionalRef ref, + Ref ref, ) create, ) { return FunctionalProvider._( @@ -77,7 +75,7 @@ final class FunctionalProvider extends $FunctionalProvider } @override - String create(FunctionalRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? functional; final argument = this.argument as int; return _$cb( @@ -97,7 +95,7 @@ final class FunctionalProvider extends $FunctionalProvider } } -String _$functionalHash() => r'288107f94c896141a9b3999f606e4ccdf078f15e'; +String _$functionalHash() => r'ba8606cd0526e2dde0f775eb8f4c9d8b5b6fdf2c'; final class FunctionalFamily extends Family { const FunctionalFamily._() @@ -123,7 +121,7 @@ final class FunctionalFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( String Function( - FunctionalRef ref, + Ref ref, int args, ) create, ) { @@ -202,7 +200,7 @@ final class ClassBasedProvider extends $NotifierProvider { @override ClassBasedProvider $copyWithBuild( String Function( - Ref, + Ref, ClassBased, ) build, ) { @@ -274,7 +272,7 @@ final class ClassBasedFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - String Function(Ref ref, ClassBased notifier, int argument) build, + String Function(Ref ref, ClassBased notifier, int argument) build, ) { return $FamilyOverride( from: this, @@ -306,8 +304,6 @@ abstract class _$ClassBased extends $Notifier { ); } -typedef FamilyRef = Ref; - @ProviderFor(family) @Deprecated('Deprecation message') @visibleForTesting @@ -315,12 +311,12 @@ typedef FamilyRef = Ref; const familyProvider = FamilyFamily._(); final class FamilyProvider extends $FunctionalProvider - with $Provider { + with $Provider { const FamilyProvider._( {required FamilyFamily super.from, required int super.argument, String Function( - FamilyRef ref, + Ref ref, int id, )? create}) : _createCb = create, @@ -333,7 +329,7 @@ final class FamilyProvider extends $FunctionalProvider ); final String Function( - FamilyRef ref, + Ref ref, int id, )? _createCb; @@ -363,7 +359,7 @@ final class FamilyProvider extends $FunctionalProvider @override FamilyProvider $copyWithCreate( String Function( - FamilyRef ref, + Ref ref, ) create, ) { return FamilyProvider._( @@ -377,7 +373,7 @@ final class FamilyProvider extends $FunctionalProvider } @override - String create(FamilyRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? family; final argument = this.argument as int; return _$cb( @@ -397,7 +393,7 @@ final class FamilyProvider extends $FunctionalProvider } } -String _$familyHash() => r'd70685b83be840bfd9e79c11fb84c905d19d6e10'; +String _$familyHash() => r'14b97009aec20a0332208f8a60bc177b44c9d1d4'; final class FamilyFamily extends Family { const FamilyFamily._() @@ -423,7 +419,7 @@ final class FamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( String Function( - FamilyRef ref, + Ref ref, int args, ) create, ) { @@ -442,17 +438,14 @@ final class FamilyFamily extends Family { } } -typedef NotCopiedFunctionalRef = Ref; - @ProviderFor(notCopiedFunctional) const notCopiedFunctionalProvider = NotCopiedFunctionalProvider._(); final class NotCopiedFunctionalProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const NotCopiedFunctionalProvider._( {String Function( - NotCopiedFunctionalRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -466,7 +459,7 @@ final class NotCopiedFunctionalProvider ); final String Function( - NotCopiedFunctionalRef ref, + Ref ref, )? _createCb; @override @@ -488,21 +481,21 @@ final class NotCopiedFunctionalProvider @override NotCopiedFunctionalProvider $copyWithCreate( String Function( - NotCopiedFunctionalRef ref, + Ref ref, ) create, ) { return NotCopiedFunctionalProvider._(create: create); } @override - String create(NotCopiedFunctionalRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? notCopiedFunctional; return _$cb(ref); } } String _$notCopiedFunctionalHash() => - r'30587ee9ceb75d5c8562015ad4a67ec0b107c1f6'; + r'7b2cd9abef57493eebc1c05b1d2b4e2743ddbea2'; @ProviderFor(NotCopiedClassBased) const notCopiedClassBasedProvider = NotCopiedClassBasedProvider._(); @@ -551,7 +544,7 @@ final class NotCopiedClassBasedProvider @override NotCopiedClassBasedProvider $copyWithBuild( String Function( - Ref, + Ref, NotCopiedClassBased, ) build, ) { @@ -575,18 +568,16 @@ abstract class _$NotCopiedClassBased extends $Notifier { String runBuild() => build(); } -typedef NotCopiedFamilyRef = Ref; - @ProviderFor(notCopiedFamily) const notCopiedFamilyProvider = NotCopiedFamilyFamily._(); final class NotCopiedFamilyProvider extends $FunctionalProvider - with $Provider { + with $Provider { const NotCopiedFamilyProvider._( {required NotCopiedFamilyFamily super.from, required int super.argument, String Function( - NotCopiedFamilyRef ref, + Ref ref, int id, )? create}) : _createCb = create, @@ -599,7 +590,7 @@ final class NotCopiedFamilyProvider extends $FunctionalProvider ); final String Function( - NotCopiedFamilyRef ref, + Ref ref, int id, )? _createCb; @@ -629,7 +620,7 @@ final class NotCopiedFamilyProvider extends $FunctionalProvider @override NotCopiedFamilyProvider $copyWithCreate( String Function( - NotCopiedFamilyRef ref, + Ref ref, ) create, ) { return NotCopiedFamilyProvider._( @@ -643,7 +634,7 @@ final class NotCopiedFamilyProvider extends $FunctionalProvider } @override - String create(NotCopiedFamilyRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? notCopiedFamily; final argument = this.argument as int; return _$cb( @@ -663,7 +654,7 @@ final class NotCopiedFamilyProvider extends $FunctionalProvider } } -String _$notCopiedFamilyHash() => r'6ef06ce6ebd73b476870bbe1af41c4f3fbe8ddb1'; +String _$notCopiedFamilyHash() => r'ea652776532e2bf993a249b25b5254fc3dfff4b9'; final class NotCopiedFamilyFamily extends Family { const NotCopiedFamilyFamily._() @@ -689,7 +680,7 @@ final class NotCopiedFamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( String Function( - NotCopiedFamilyRef ref, + Ref ref, int args, ) create, ) { diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index c470df6e4..83b37b2b6 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -6,18 +6,16 @@ part of 'async.dart'; // RiverpodGenerator // ************************************************************************** -typedef GenericRef = Ref>>; - @ProviderFor(generic) const genericProvider = GenericFamily._(); final class GenericProvider extends $FunctionalProvider>, FutureOr>> - with $FutureModifier>, $FutureProvider, GenericRef> { + with $FutureModifier>, $FutureProvider> { const GenericProvider._( {required GenericFamily super.from, FutureOr> Function( - GenericRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -30,7 +28,7 @@ final class GenericProvider ); final FutureOr> Function( - GenericRef ref, + Ref ref, )? _createCb; @override @@ -38,7 +36,7 @@ final class GenericProvider GenericProvider _copyWithCreate( FutureOr> Function( - GenericRef ref, + Ref ref, ) create, ) { return GenericProvider._( @@ -60,14 +58,14 @@ final class GenericProvider @override GenericProvider $copyWithCreate( FutureOr> Function( - GenericRef ref, + Ref ref, ) create, ) { return GenericProvider._(from: from! as GenericFamily, create: create); } @override - FutureOr> create(GenericRef ref) { + FutureOr> create(Ref ref) { final _$cb = _createCb ?? generic; return _$cb(ref); } @@ -85,7 +83,7 @@ final class GenericProvider } } -String _$genericHash() => r'5fb4a4ebeb69c6841722c3a021554648db095009'; +String _$genericHash() => r'b7413a59722e9d62ae99c8a7ee0b4a24417fc3b4'; final class GenericFamily extends Family { const GenericFamily._() @@ -107,7 +105,7 @@ final class GenericFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( - FutureOr> Function(GenericRef ref) create, + FutureOr> Function(Ref ref) create, ) { return $FamilyOverride( from: this, @@ -153,7 +151,7 @@ final class GenericClassProvider GenericClassProvider _copyWithBuild( FutureOr> Function( - Ref>>, + Ref, GenericClass, ) build, ) { @@ -185,7 +183,7 @@ final class GenericClassProvider @override GenericClassProvider $copyWithBuild( FutureOr> Function( - Ref>>, + Ref, GenericClass, ) build, ) { @@ -249,8 +247,7 @@ final class GenericClassFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - FutureOr> Function( - Ref>> ref, GenericClass notifier) + FutureOr> Function(Ref ref, GenericClass notifier) build, ) { return $FamilyOverride( @@ -271,17 +268,15 @@ abstract class _$GenericClass extends $AsyncNotifier> { FutureOr> runBuild() => build(); } -typedef PublicRef = Ref>; - @ProviderFor(public) const publicProvider = PublicProvider._(); final class PublicProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const PublicProvider._( {FutureOr Function( - PublicRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -295,7 +290,7 @@ final class PublicProvider ); final FutureOr Function( - PublicRef ref, + Ref ref, )? _createCb; @override @@ -309,14 +304,14 @@ final class PublicProvider @override PublicProvider $copyWithCreate( FutureOr Function( - PublicRef ref, + Ref ref, ) create, ) { return PublicProvider._(create: create); } @override - FutureOr create(PublicRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? public; return _$cb(ref); } @@ -324,17 +319,15 @@ final class PublicProvider String _$publicHash() => r'19bceccf795e4c3a26ad1e613fd6f41aad949e2b'; -typedef _PrivateRef = Ref>; - @ProviderFor(_private) const _privateProvider = _PrivateProvider._(); final class _PrivateProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const _PrivateProvider._( {FutureOr Function( - _PrivateRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -348,7 +341,7 @@ final class _PrivateProvider ); final FutureOr Function( - _PrivateRef ref, + Ref ref, )? _createCb; @override @@ -362,14 +355,14 @@ final class _PrivateProvider @override _PrivateProvider $copyWithCreate( FutureOr Function( - _PrivateRef ref, + Ref ref, ) create, ) { return _PrivateProvider._(create: create); } @override - FutureOr create(_PrivateRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? _private; return _$cb(ref); } @@ -377,19 +370,17 @@ final class _PrivateProvider String _$privateHash() => r'7f0d1ff55a21e520b8471bbabc4649b5336221d4'; -typedef FamilyOrRef = Ref>; - @ProviderFor(familyOr) const familyOrProvider = FamilyOrFamily._(); final class FamilyOrProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const FamilyOrProvider._( {required FamilyOrFamily super.from, required int super.argument, FutureOr Function( - FamilyOrRef ref, + Ref ref, int first, )? create}) : _createCb = create, @@ -402,7 +393,7 @@ final class FamilyOrProvider ); final FutureOr Function( - FamilyOrRef ref, + Ref ref, int first, )? _createCb; @@ -424,7 +415,7 @@ final class FamilyOrProvider @override FamilyOrProvider $copyWithCreate( FutureOr Function( - FamilyOrRef ref, + Ref ref, ) create, ) { return FamilyOrProvider._( @@ -438,7 +429,7 @@ final class FamilyOrProvider } @override - FutureOr create(FamilyOrRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? familyOr; final argument = this.argument as int; return _$cb( @@ -484,7 +475,7 @@ final class FamilyOrFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( FutureOr Function( - FamilyOrRef ref, + Ref ref, int args, ) create, ) { @@ -503,14 +494,12 @@ final class FamilyOrFamily extends Family { } } -typedef FamilyRef = Ref>; - @ProviderFor(family) const familyProvider = FamilyFamily._(); final class FamilyProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const FamilyProvider._( {required FamilyFamily super.from, required ( @@ -522,7 +511,7 @@ final class FamilyProvider }) super.argument, FutureOr Function( - FamilyRef ref, + Ref ref, int first, { String? second, required double third, @@ -539,7 +528,7 @@ final class FamilyProvider ); final FutureOr Function( - FamilyRef ref, + Ref ref, int first, { String? second, required double third, @@ -565,7 +554,7 @@ final class FamilyProvider @override FamilyProvider $copyWithCreate( FutureOr Function( - FamilyRef ref, + Ref ref, ) create, ) { return FamilyProvider._( @@ -589,7 +578,7 @@ final class FamilyProvider } @override - FutureOr create(FamilyRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? family; final argument = this.argument as ( int, { @@ -655,7 +644,7 @@ final class FamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( FutureOr Function( - FamilyRef ref, + Ref ref, ( int, { String? second, @@ -725,7 +714,7 @@ final class PublicClassProvider @override PublicClassProvider $copyWithBuild( FutureOr Function( - Ref>, + Ref, PublicClass, ) build, ) { @@ -787,7 +776,7 @@ final class _PrivateClassProvider @override _PrivateClassProvider $copyWithBuild( FutureOr Function( - Ref>, + Ref, _PrivateClass, ) build, ) { @@ -860,7 +849,7 @@ final class FamilyOrClassProvider @override FamilyOrClassProvider $copyWithBuild( FutureOr Function( - Ref>, + Ref, FamilyOrClass, ) build, ) { @@ -932,8 +921,7 @@ final class FamilyOrClassFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - FutureOr Function( - Ref> ref, FamilyOrClass notifier, int argument) + FutureOr Function(Ref ref, FamilyOrClass notifier, int argument) build, ) { return $FamilyOverride( @@ -1028,7 +1016,7 @@ final class FamilyClassProvider @override FamilyClassProvider $copyWithBuild( FutureOr Function( - Ref>, + Ref, FamilyClass, ) build, ) { @@ -1129,7 +1117,7 @@ final class FamilyClassFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( FutureOr Function( - Ref> ref, + Ref ref, FamilyClass notifier, ( int, { diff --git a/packages/riverpod_generator/test/integration/auto_dispose.g.dart b/packages/riverpod_generator/test/integration/auto_dispose.g.dart index b4e799256..a207548e0 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.g.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.g.dart @@ -6,16 +6,14 @@ part of 'auto_dispose.dart'; // RiverpodGenerator // ************************************************************************** -typedef KeepAliveRef = Ref; - @ProviderFor(keepAlive) const keepAliveProvider = KeepAliveProvider._(); final class KeepAliveProvider extends $FunctionalProvider - with $Provider { + with $Provider { const KeepAliveProvider._( {int Function( - KeepAliveRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class KeepAliveProvider extends $FunctionalProvider ); final int Function( - KeepAliveRef ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class KeepAliveProvider extends $FunctionalProvider @override KeepAliveProvider $copyWithCreate( int Function( - KeepAliveRef ref, + Ref ref, ) create, ) { return KeepAliveProvider._(create: create); } @override - int create(KeepAliveRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? keepAlive; return _$cb(ref); } @@ -66,16 +64,14 @@ final class KeepAliveProvider extends $FunctionalProvider String _$keepAliveHash() => r'44af50bf7e6dcfddc61a1f32855855b534a7fe4f'; -typedef NotKeepAliveRef = Ref; - @ProviderFor(notKeepAlive) const notKeepAliveProvider = NotKeepAliveProvider._(); final class NotKeepAliveProvider extends $FunctionalProvider - with $Provider { + with $Provider { const NotKeepAliveProvider._( {int Function( - NotKeepAliveRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -89,7 +85,7 @@ final class NotKeepAliveProvider extends $FunctionalProvider ); final int Function( - NotKeepAliveRef ref, + Ref ref, )? _createCb; @override @@ -111,14 +107,14 @@ final class NotKeepAliveProvider extends $FunctionalProvider @override NotKeepAliveProvider $copyWithCreate( int Function( - NotKeepAliveRef ref, + Ref ref, ) create, ) { return NotKeepAliveProvider._(create: create); } @override - int create(NotKeepAliveRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? notKeepAlive; return _$cb(ref); } @@ -126,16 +122,14 @@ final class NotKeepAliveProvider extends $FunctionalProvider String _$notKeepAliveHash() => r'e60c952d04ffd7548294908c2e1ef472614c284b'; -typedef DefaultKeepAliveRef = Ref; - @ProviderFor(defaultKeepAlive) const defaultKeepAliveProvider = DefaultKeepAliveProvider._(); final class DefaultKeepAliveProvider extends $FunctionalProvider - with $Provider { + with $Provider { const DefaultKeepAliveProvider._( {int Function( - DefaultKeepAliveRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -149,7 +143,7 @@ final class DefaultKeepAliveProvider extends $FunctionalProvider ); final int Function( - DefaultKeepAliveRef ref, + Ref ref, )? _createCb; @override @@ -171,14 +165,14 @@ final class DefaultKeepAliveProvider extends $FunctionalProvider @override DefaultKeepAliveProvider $copyWithCreate( int Function( - DefaultKeepAliveRef ref, + Ref ref, ) create, ) { return DefaultKeepAliveProvider._(create: create); } @override - int create(DefaultKeepAliveRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? defaultKeepAlive; return _$cb(ref); } @@ -186,18 +180,16 @@ final class DefaultKeepAliveProvider extends $FunctionalProvider String _$defaultKeepAliveHash() => r'76485c3c7574c38dcba6dda28c94a59c09b339c0'; -typedef KeepAliveFamilyRef = Ref; - @ProviderFor(keepAliveFamily) const keepAliveFamilyProvider = KeepAliveFamilyFamily._(); final class KeepAliveFamilyProvider extends $FunctionalProvider - with $Provider { + with $Provider { const KeepAliveFamilyProvider._( {required KeepAliveFamilyFamily super.from, required int super.argument, int Function( - KeepAliveFamilyRef ref, + Ref ref, int a, )? create}) : _createCb = create, @@ -210,7 +202,7 @@ final class KeepAliveFamilyProvider extends $FunctionalProvider ); final int Function( - KeepAliveFamilyRef ref, + Ref ref, int a, )? _createCb; @@ -240,7 +232,7 @@ final class KeepAliveFamilyProvider extends $FunctionalProvider @override KeepAliveFamilyProvider $copyWithCreate( int Function( - KeepAliveFamilyRef ref, + Ref ref, ) create, ) { return KeepAliveFamilyProvider._( @@ -254,7 +246,7 @@ final class KeepAliveFamilyProvider extends $FunctionalProvider } @override - int create(KeepAliveFamilyRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? keepAliveFamily; final argument = this.argument as int; return _$cb( @@ -300,7 +292,7 @@ final class KeepAliveFamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( int Function( - KeepAliveFamilyRef ref, + Ref ref, int args, ) create, ) { @@ -319,18 +311,16 @@ final class KeepAliveFamilyFamily extends Family { } } -typedef NotKeepAliveFamilyRef = Ref; - @ProviderFor(notKeepAliveFamily) const notKeepAliveFamilyProvider = NotKeepAliveFamilyFamily._(); final class NotKeepAliveFamilyProvider extends $FunctionalProvider - with $Provider { + with $Provider { const NotKeepAliveFamilyProvider._( {required NotKeepAliveFamilyFamily super.from, required int super.argument, int Function( - NotKeepAliveFamilyRef ref, + Ref ref, int a, )? create}) : _createCb = create, @@ -343,7 +333,7 @@ final class NotKeepAliveFamilyProvider extends $FunctionalProvider ); final int Function( - NotKeepAliveFamilyRef ref, + Ref ref, int a, )? _createCb; @@ -373,7 +363,7 @@ final class NotKeepAliveFamilyProvider extends $FunctionalProvider @override NotKeepAliveFamilyProvider $copyWithCreate( int Function( - NotKeepAliveFamilyRef ref, + Ref ref, ) create, ) { return NotKeepAliveFamilyProvider._( @@ -387,7 +377,7 @@ final class NotKeepAliveFamilyProvider extends $FunctionalProvider } @override - int create(NotKeepAliveFamilyRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? notKeepAliveFamily; final argument = this.argument as int; return _$cb( @@ -434,7 +424,7 @@ final class NotKeepAliveFamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( int Function( - NotKeepAliveFamilyRef ref, + Ref ref, int args, ) create, ) { @@ -453,18 +443,16 @@ final class NotKeepAliveFamilyFamily extends Family { } } -typedef DefaultKeepAliveFamilyRef = Ref; - @ProviderFor(defaultKeepAliveFamily) const defaultKeepAliveFamilyProvider = DefaultKeepAliveFamilyFamily._(); final class DefaultKeepAliveFamilyProvider extends $FunctionalProvider - with $Provider { + with $Provider { const DefaultKeepAliveFamilyProvider._( {required DefaultKeepAliveFamilyFamily super.from, required int super.argument, int Function( - DefaultKeepAliveFamilyRef ref, + Ref ref, int a, )? create}) : _createCb = create, @@ -477,7 +465,7 @@ final class DefaultKeepAliveFamilyProvider extends $FunctionalProvider ); final int Function( - DefaultKeepAliveFamilyRef ref, + Ref ref, int a, )? _createCb; @@ -507,7 +495,7 @@ final class DefaultKeepAliveFamilyProvider extends $FunctionalProvider @override DefaultKeepAliveFamilyProvider $copyWithCreate( int Function( - DefaultKeepAliveFamilyRef ref, + Ref ref, ) create, ) { return DefaultKeepAliveFamilyProvider._( @@ -521,7 +509,7 @@ final class DefaultKeepAliveFamilyProvider extends $FunctionalProvider } @override - int create(DefaultKeepAliveFamilyRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? defaultKeepAliveFamily; final argument = this.argument as int; return _$cb( @@ -569,7 +557,7 @@ final class DefaultKeepAliveFamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( int Function( - DefaultKeepAliveFamilyRef ref, + Ref ref, int args, ) create, ) { diff --git a/packages/riverpod_generator/test/integration/dependencies.g.dart b/packages/riverpod_generator/test/integration/dependencies.g.dart index dbbce7e74..7e88c4c4c 100644 --- a/packages/riverpod_generator/test/integration/dependencies.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies.g.dart @@ -6,16 +6,14 @@ part of 'dependencies.dart'; // RiverpodGenerator // ************************************************************************** -typedef DepRef = Ref; - @ProviderFor(dep) const depProvider = DepProvider._(); final class DepProvider extends $FunctionalProvider - with $Provider { + with $Provider { const DepProvider._( {int Function( - DepRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class DepProvider extends $FunctionalProvider ); final int Function( - DepRef ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class DepProvider extends $FunctionalProvider @override DepProvider $copyWithCreate( int Function( - DepRef ref, + Ref ref, ) create, ) { return DepProvider._(create: create); } @override - int create(DepRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? dep; return _$cb(ref); } @@ -66,18 +64,16 @@ final class DepProvider extends $FunctionalProvider String _$depHash() => r'1b3ec5231cd2328602151de9ceacdcd102a1d2e2'; -typedef FamilyRef = Ref; - @ProviderFor(family) const familyProvider = FamilyFamily._(); final class FamilyProvider extends $FunctionalProvider - with $Provider { + with $Provider { const FamilyProvider._( {required FamilyFamily super.from, required int super.argument, int Function( - FamilyRef ref, + Ref ref, int id, )? create}) : _createCb = create, @@ -90,7 +86,7 @@ final class FamilyProvider extends $FunctionalProvider ); final int Function( - FamilyRef ref, + Ref ref, int id, )? _createCb; @@ -120,7 +116,7 @@ final class FamilyProvider extends $FunctionalProvider @override FamilyProvider $copyWithCreate( int Function( - FamilyRef ref, + Ref ref, ) create, ) { return FamilyProvider._( @@ -134,7 +130,7 @@ final class FamilyProvider extends $FunctionalProvider } @override - int create(FamilyRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? family; final argument = this.argument as int; return _$cb( @@ -180,7 +176,7 @@ final class FamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( int Function( - FamilyRef ref, + Ref ref, int args, ) create, ) { @@ -245,7 +241,7 @@ final class Dep2Provider extends $NotifierProvider { @override Dep2Provider $copyWithBuild( int Function( - Ref, + Ref, Dep2, ) build, ) { @@ -325,7 +321,7 @@ final class Family2Provider extends $NotifierProvider { @override Family2Provider $copyWithBuild( int Function( - Ref, + Ref, Family2, ) build, ) { @@ -397,7 +393,7 @@ final class Family2Family extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - int Function(Ref ref, Family2 notifier, int argument) build, + int Function(Ref ref, Family2 notifier, int argument) build, ) { return $FamilyOverride( from: this, @@ -428,16 +424,14 @@ abstract class _$Family2 extends $Notifier { ); } -typedef ProviderRef = Ref; - @ProviderFor(provider) const providerProvider = ProviderProvider._(); final class ProviderProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ProviderProvider._( {int Function( - ProviderRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -466,7 +460,7 @@ final class ProviderProvider extends $FunctionalProvider static const $allTransitiveDependencies3 = family2Provider; final int Function( - ProviderRef ref, + Ref ref, )? _createCb; @override @@ -488,14 +482,14 @@ final class ProviderProvider extends $FunctionalProvider @override ProviderProvider $copyWithCreate( int Function( - ProviderRef ref, + Ref ref, ) create, ) { return ProviderProvider._(create: create); } @override - int create(ProviderRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? provider; return _$cb(ref); } @@ -503,16 +497,14 @@ final class ProviderProvider extends $FunctionalProvider String _$providerHash() => r'1be7ae7ac2100d39b949af50ec50fce48b26cdd1'; -typedef Provider2Ref = Ref; - @ProviderFor(provider2) const provider2Provider = Provider2Provider._(); final class Provider2Provider extends $FunctionalProvider - with $Provider { + with $Provider { const Provider2Provider._( {int Function( - Provider2Ref ref, + Ref ref, )? create}) : _createCb = create, super( @@ -541,7 +533,7 @@ final class Provider2Provider extends $FunctionalProvider static const $allTransitiveDependencies3 = family2Provider; final int Function( - Provider2Ref ref, + Ref ref, )? _createCb; @override @@ -563,14 +555,14 @@ final class Provider2Provider extends $FunctionalProvider @override Provider2Provider $copyWithCreate( int Function( - Provider2Ref ref, + Ref ref, ) create, ) { return Provider2Provider._(create: create); } @override - int create(Provider2Ref ref) { + int create(Ref ref) { final _$cb = _createCb ?? provider2; return _$cb(ref); } @@ -639,7 +631,7 @@ final class Provider3Provider extends $NotifierProvider { @override Provider3Provider $copyWithBuild( int Function( - Ref, + Ref, Provider3, ) build, ) { @@ -724,7 +716,7 @@ final class Provider4Provider extends $NotifierProvider { @override Provider4Provider $copyWithBuild( int Function( - Ref, + Ref, Provider4, ) build, ) { @@ -806,7 +798,7 @@ final class Provider4Family extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - int Function(Ref ref, Provider4 notifier, int argument) build, + int Function(Ref ref, Provider4 notifier, int argument) build, ) { return $FamilyOverride( from: this, @@ -837,16 +829,14 @@ abstract class _$Provider4 extends $Notifier { ); } -typedef TransitiveDependenciesRef = Ref; - @ProviderFor(transitiveDependencies) const transitiveDependenciesProvider = TransitiveDependenciesProvider._(); final class TransitiveDependenciesProvider extends $FunctionalProvider - with $Provider { + with $Provider { const TransitiveDependenciesProvider._( {int Function( - TransitiveDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -876,7 +866,7 @@ final class TransitiveDependenciesProvider extends $FunctionalProvider ProviderProvider.$allTransitiveDependencies3; final int Function( - TransitiveDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -898,14 +888,14 @@ final class TransitiveDependenciesProvider extends $FunctionalProvider @override TransitiveDependenciesProvider $copyWithCreate( int Function( - TransitiveDependenciesRef ref, + Ref ref, ) create, ) { return TransitiveDependenciesProvider._(create: create); } @override - int create(TransitiveDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? transitiveDependencies; return _$cb(ref); } @@ -914,18 +904,15 @@ final class TransitiveDependenciesProvider extends $FunctionalProvider String _$transitiveDependenciesHash() => r'909d45403831b521177ec15b1dd78554e261d3be'; -typedef SmallTransitiveDependencyCountRef = Ref; - @ProviderFor(smallTransitiveDependencyCount) const smallTransitiveDependencyCountProvider = SmallTransitiveDependencyCountProvider._(); final class SmallTransitiveDependencyCountProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const SmallTransitiveDependencyCountProvider._( {int Function( - SmallTransitiveDependencyCountRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -951,7 +938,7 @@ final class SmallTransitiveDependencyCountProvider static const $allTransitiveDependencies2 = dep2Provider; final int Function( - SmallTransitiveDependencyCountRef ref, + Ref ref, )? _createCb; @override @@ -973,14 +960,14 @@ final class SmallTransitiveDependencyCountProvider @override SmallTransitiveDependencyCountProvider $copyWithCreate( int Function( - SmallTransitiveDependencyCountRef ref, + Ref ref, ) create, ) { return SmallTransitiveDependencyCountProvider._(create: create); } @override - int create(SmallTransitiveDependencyCountRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? smallTransitiveDependencyCount; return _$cb(ref); } @@ -989,18 +976,15 @@ final class SmallTransitiveDependencyCountProvider String _$smallTransitiveDependencyCountHash() => r'f67b369dd99e35a6e6211004b45c87c5ba4ac1c7'; -typedef EmptyDependenciesFunctionalRef = Ref; - @ProviderFor(emptyDependenciesFunctional) const emptyDependenciesFunctionalProvider = EmptyDependenciesFunctionalProvider._(); final class EmptyDependenciesFunctionalProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const EmptyDependenciesFunctionalProvider._( {int Function( - EmptyDependenciesFunctionalRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1014,7 +998,7 @@ final class EmptyDependenciesFunctionalProvider ); final int Function( - EmptyDependenciesFunctionalRef ref, + Ref ref, )? _createCb; @override @@ -1036,14 +1020,14 @@ final class EmptyDependenciesFunctionalProvider @override EmptyDependenciesFunctionalProvider $copyWithCreate( int Function( - EmptyDependenciesFunctionalRef ref, + Ref ref, ) create, ) { return EmptyDependenciesFunctionalProvider._(create: create); } @override - int create(EmptyDependenciesFunctionalRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? emptyDependenciesFunctional; return _$cb(ref); } @@ -1102,7 +1086,7 @@ final class EmptyDependenciesClassBasedProvider @override EmptyDependenciesClassBasedProvider $copyWithBuild( int Function( - Ref, + Ref, EmptyDependenciesClassBased, ) build, ) { @@ -1127,17 +1111,14 @@ abstract class _$EmptyDependenciesClassBased extends $Notifier { int runBuild() => build(); } -typedef ProviderWithDependenciesRef = Ref; - @ProviderFor(providerWithDependencies) const providerWithDependenciesProvider = ProviderWithDependenciesProvider._(); final class ProviderWithDependenciesProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const ProviderWithDependenciesProvider._( {int Function( - ProviderWithDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1160,7 +1141,7 @@ final class ProviderWithDependenciesProvider static const $allTransitiveDependencies1 = publicDepProvider; final int Function( - ProviderWithDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -1182,14 +1163,14 @@ final class ProviderWithDependenciesProvider @override ProviderWithDependenciesProvider $copyWithCreate( int Function( - ProviderWithDependenciesRef ref, + Ref ref, ) create, ) { return ProviderWithDependenciesProvider._(create: create); } @override - int create(ProviderWithDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? providerWithDependencies; return _$cb(ref); } @@ -1198,16 +1179,14 @@ final class ProviderWithDependenciesProvider String _$providerWithDependenciesHash() => r'7d40c994fc2d4ba9e6a0bb4a3d100f8da874eb5e'; -typedef _PrivateDepRef = Ref; - @ProviderFor(_privateDep) const _privateDepProvider = _PrivateDepProvider._(); final class _PrivateDepProvider extends $FunctionalProvider - with $Provider { + with $Provider { const _PrivateDepProvider._( {int Function( - _PrivateDepRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1221,7 +1200,7 @@ final class _PrivateDepProvider extends $FunctionalProvider ); final int Function( - _PrivateDepRef ref, + Ref ref, )? _createCb; @override @@ -1243,14 +1222,14 @@ final class _PrivateDepProvider extends $FunctionalProvider @override _PrivateDepProvider $copyWithCreate( int Function( - _PrivateDepRef ref, + Ref ref, ) create, ) { return _PrivateDepProvider._(create: create); } @override - int create(_PrivateDepRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? _privateDep; return _$cb(ref); } @@ -1258,16 +1237,14 @@ final class _PrivateDepProvider extends $FunctionalProvider String _$privateDepHash() => r'92ff5cc515ecf2455cb04773f1b49f23b17ea2e2'; -typedef PublicDepRef = Ref; - @ProviderFor(publicDep) const publicDepProvider = PublicDepProvider._(); final class PublicDepProvider extends $FunctionalProvider - with $Provider { + with $Provider { const PublicDepProvider._( {int Function( - PublicDepRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1281,7 +1258,7 @@ final class PublicDepProvider extends $FunctionalProvider ); final int Function( - PublicDepRef ref, + Ref ref, )? _createCb; @override @@ -1303,14 +1280,14 @@ final class PublicDepProvider extends $FunctionalProvider @override PublicDepProvider $copyWithCreate( int Function( - PublicDepRef ref, + Ref ref, ) create, ) { return PublicDepProvider._(create: create); } @override - int create(PublicDepRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? publicDep; return _$cb(ref); } @@ -1318,16 +1295,14 @@ final class PublicDepProvider extends $FunctionalProvider String _$publicDepHash() => r'a9c461ae174577183ab4c0ff8d8267cc7a64a2c5'; -typedef DuplicateDependenciesRef = Ref; - @ProviderFor(duplicateDependencies) const duplicateDependenciesProvider = DuplicateDependenciesProvider._(); final class DuplicateDependenciesProvider extends $FunctionalProvider - with $Provider { + with $Provider { const DuplicateDependenciesProvider._( {int Function( - DuplicateDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1347,7 +1322,7 @@ final class DuplicateDependenciesProvider extends $FunctionalProvider static const $allTransitiveDependencies1 = dep2Provider; final int Function( - DuplicateDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -1369,14 +1344,14 @@ final class DuplicateDependenciesProvider extends $FunctionalProvider @override DuplicateDependenciesProvider $copyWithCreate( int Function( - DuplicateDependenciesRef ref, + Ref ref, ) create, ) { return DuplicateDependenciesProvider._(create: create); } @override - int create(DuplicateDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? duplicateDependencies; return _$cb(ref); } @@ -1385,16 +1360,14 @@ final class DuplicateDependenciesProvider extends $FunctionalProvider String _$duplicateDependenciesHash() => r'ad48ecca57899ee55c69793c84a01235d6a49834'; -typedef DuplicateDependencies2Ref = Ref; - @ProviderFor(duplicateDependencies2) const duplicateDependencies2Provider = DuplicateDependencies2Provider._(); final class DuplicateDependencies2Provider extends $FunctionalProvider - with $Provider { + with $Provider { const DuplicateDependencies2Provider._( {int Function( - DuplicateDependencies2Ref ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1417,7 +1390,7 @@ final class DuplicateDependencies2Provider extends $FunctionalProvider static const $allTransitiveDependencies1 = family2Provider; final int Function( - DuplicateDependencies2Ref ref, + Ref ref, )? _createCb; @override @@ -1439,14 +1412,14 @@ final class DuplicateDependencies2Provider extends $FunctionalProvider @override DuplicateDependencies2Provider $copyWithCreate( int Function( - DuplicateDependencies2Ref ref, + Ref ref, ) create, ) { return DuplicateDependencies2Provider._(create: create); } @override - int create(DuplicateDependencies2Ref ref) { + int create(Ref ref) { final _$cb = _createCb ?? duplicateDependencies2; return _$cb(ref); } @@ -1455,18 +1428,15 @@ final class DuplicateDependencies2Provider extends $FunctionalProvider String _$duplicateDependencies2Hash() => r'6e065325922dc36f408f85998cf2d7ba7a80ba56'; -typedef TransitiveDuplicateDependenciesRef = Ref; - @ProviderFor(transitiveDuplicateDependencies) const transitiveDuplicateDependenciesProvider = TransitiveDuplicateDependenciesProvider._(); final class TransitiveDuplicateDependenciesProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const TransitiveDuplicateDependenciesProvider._( {int Function( - TransitiveDuplicateDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1501,7 +1471,7 @@ final class TransitiveDuplicateDependenciesProvider DuplicateDependencies2Provider.$allTransitiveDependencies1; final int Function( - TransitiveDuplicateDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -1523,14 +1493,14 @@ final class TransitiveDuplicateDependenciesProvider @override TransitiveDuplicateDependenciesProvider $copyWithCreate( int Function( - TransitiveDuplicateDependenciesRef ref, + Ref ref, ) create, ) { return TransitiveDuplicateDependenciesProvider._(create: create); } @override - int create(TransitiveDuplicateDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? transitiveDuplicateDependencies; return _$cb(ref); } diff --git a/packages/riverpod_generator/test/integration/dependencies2.g.dart b/packages/riverpod_generator/test/integration/dependencies2.g.dart index d66f0a8e5..175a263bf 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.g.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.g.dart @@ -6,17 +6,14 @@ part of 'dependencies2.dart'; // RiverpodGenerator // ************************************************************************** -typedef ProviderWithDependencies2Ref = Ref; - @ProviderFor(providerWithDependencies2) const providerWithDependencies2Provider = ProviderWithDependencies2Provider._(); final class ProviderWithDependencies2Provider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const ProviderWithDependencies2Provider._( {int Function( - ProviderWithDependencies2Ref ref, + Ref ref, )? create}) : _createCb = create, super( @@ -48,7 +45,7 @@ final class ProviderWithDependencies2Provider static const $allTransitiveDependencies4 = public2Provider; final int Function( - ProviderWithDependencies2Ref ref, + Ref ref, )? _createCb; @override @@ -70,14 +67,14 @@ final class ProviderWithDependencies2Provider @override ProviderWithDependencies2Provider $copyWithCreate( int Function( - ProviderWithDependencies2Ref ref, + Ref ref, ) create, ) { return ProviderWithDependencies2Provider._(create: create); } @override - int create(ProviderWithDependencies2Ref ref) { + int create(Ref ref) { final _$cb = _createCb ?? providerWithDependencies2; return _$cb(ref); } @@ -86,19 +83,16 @@ final class ProviderWithDependencies2Provider String _$providerWithDependencies2Hash() => r'3a6100929120a9cf1ef7f1e0a5e9b8e4d4030ae2'; -typedef FamilyWithDependencies2Ref = Ref; - @ProviderFor(familyWithDependencies2) const familyWithDependencies2Provider = FamilyWithDependencies2Family._(); final class FamilyWithDependencies2Provider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const FamilyWithDependencies2Provider._( {required FamilyWithDependencies2Family super.from, required int? super.argument, int Function( - FamilyWithDependencies2Ref ref, { + Ref ref, { int? id, })? create}) : _createCb = create, @@ -119,7 +113,7 @@ final class FamilyWithDependencies2Provider static const $allTransitiveDependencies4 = public2Provider; final int Function( - FamilyWithDependencies2Ref ref, { + Ref ref, { int? id, })? _createCb; @@ -149,7 +143,7 @@ final class FamilyWithDependencies2Provider @override FamilyWithDependencies2Provider $copyWithCreate( int Function( - FamilyWithDependencies2Ref ref, + Ref ref, ) create, ) { return FamilyWithDependencies2Provider._( @@ -163,7 +157,7 @@ final class FamilyWithDependencies2Provider } @override - int create(FamilyWithDependencies2Ref ref) { + int create(Ref ref) { final _$cb = _createCb ?? familyWithDependencies2; final argument = this.argument as int?; return _$cb( @@ -221,7 +215,7 @@ final class FamilyWithDependencies2Family extends Family { /// {@macro riverpod.override_with} Override overrideWith( int Function( - FamilyWithDependencies2Ref ref, + Ref ref, int? args, ) create, ) { @@ -307,7 +301,7 @@ final class NotifierWithDependenciesProvider @override NotifierWithDependenciesProvider $copyWithBuild( int Function( - Ref, + Ref, NotifierWithDependencies, ) build, ) { @@ -399,7 +393,7 @@ final class NotifierFamilyWithDependenciesProvider @override NotifierFamilyWithDependenciesProvider $copyWithBuild( int Function( - Ref, + Ref, NotifierFamilyWithDependencies, ) build, ) { @@ -484,8 +478,8 @@ final class NotifierFamilyWithDependenciesFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - int Function(Ref ref, NotifierFamilyWithDependencies notifier, - int? argument) + int Function( + Ref ref, NotifierFamilyWithDependencies notifier, int? argument) build, ) { return $FamilyOverride( @@ -518,16 +512,14 @@ abstract class _$NotifierFamilyWithDependencies extends $Notifier { ); } -typedef _Private2Ref = Ref; - @ProviderFor(_private2) const _private2Provider = _Private2Provider._(); final class _Private2Provider extends $FunctionalProvider - with $Provider { + with $Provider { const _Private2Provider._( {int Function( - _Private2Ref ref, + Ref ref, )? create}) : _createCb = create, super( @@ -541,7 +533,7 @@ final class _Private2Provider extends $FunctionalProvider ); final int Function( - _Private2Ref ref, + Ref ref, )? _createCb; @override @@ -563,14 +555,14 @@ final class _Private2Provider extends $FunctionalProvider @override _Private2Provider $copyWithCreate( int Function( - _Private2Ref ref, + Ref ref, ) create, ) { return _Private2Provider._(create: create); } @override - int create(_Private2Ref ref) { + int create(Ref ref) { final _$cb = _createCb ?? _private2; return _$cb(ref); } @@ -578,16 +570,14 @@ final class _Private2Provider extends $FunctionalProvider String _$private2Hash() => r'e420875c8fbd9bf33eff945f2b7276b585032a38'; -typedef Public2Ref = Ref; - @ProviderFor(public2) const public2Provider = Public2Provider._(); final class Public2Provider extends $FunctionalProvider - with $Provider { + with $Provider { const Public2Provider._( {int Function( - Public2Ref ref, + Ref ref, )? create}) : _createCb = create, super( @@ -601,7 +591,7 @@ final class Public2Provider extends $FunctionalProvider ); final int Function( - Public2Ref ref, + Ref ref, )? _createCb; @override @@ -623,14 +613,14 @@ final class Public2Provider extends $FunctionalProvider @override Public2Provider $copyWithCreate( int Function( - Public2Ref ref, + Ref ref, ) create, ) { return Public2Provider._(create: create); } @override - int create(Public2Ref ref) { + int create(Ref ref) { final _$cb = _createCb ?? public2; return _$cb(ref); } diff --git a/packages/riverpod_generator/test/integration/documented.g.dart b/packages/riverpod_generator/test/integration/documented.g.dart index 41f1699bb..fb33e8058 100644 --- a/packages/riverpod_generator/test/integration/documented.g.dart +++ b/packages/riverpod_generator/test/integration/documented.g.dart @@ -6,10 +6,6 @@ part of 'documented.dart'; // RiverpodGenerator // ************************************************************************** -/// Hello world -// Foo -typedef FunctionalRef = Ref; - /// Hello world // Foo @ProviderFor(functional) @@ -18,12 +14,12 @@ const functionalProvider = FunctionalProvider._(); /// Hello world // Foo final class FunctionalProvider extends $FunctionalProvider - with $Provider { + with $Provider { /// Hello world // Foo const FunctionalProvider._( {String Function( - FunctionalRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -37,7 +33,7 @@ final class FunctionalProvider extends $FunctionalProvider ); final String Function( - FunctionalRef ref, + Ref ref, )? _createCb; @override @@ -59,14 +55,14 @@ final class FunctionalProvider extends $FunctionalProvider @override FunctionalProvider $copyWithCreate( String Function( - FunctionalRef ref, + Ref ref, ) create, ) { return FunctionalProvider._(create: create); } @override - String create(FunctionalRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? functional; return _$cb(ref); } @@ -126,7 +122,7 @@ final class ClassBasedProvider extends $NotifierProvider { @override ClassBasedProvider $copyWithBuild( String Function( - Ref, + Ref, ClassBased, ) build, ) { @@ -149,10 +145,6 @@ abstract class _$ClassBased extends $Notifier { String runBuild() => build(); } -/// Hello world -// Foo -typedef FamilyRef = Ref; - /// Hello world // Foo @ProviderFor(family) @@ -161,14 +153,14 @@ const familyProvider = FamilyFamily._(); /// Hello world // Foo final class FamilyProvider extends $FunctionalProvider - with $Provider { + with $Provider { /// Hello world // Foo const FamilyProvider._( {required FamilyFamily super.from, required int super.argument, String Function( - FamilyRef ref, + Ref ref, int id, )? create}) : _createCb = create, @@ -181,7 +173,7 @@ final class FamilyProvider extends $FunctionalProvider ); final String Function( - FamilyRef ref, + Ref ref, int id, )? _createCb; @@ -211,7 +203,7 @@ final class FamilyProvider extends $FunctionalProvider @override FamilyProvider $copyWithCreate( String Function( - FamilyRef ref, + Ref ref, ) create, ) { return FamilyProvider._( @@ -225,7 +217,7 @@ final class FamilyProvider extends $FunctionalProvider } @override - String create(FamilyRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? family; final argument = this.argument as int; return _$cb( @@ -275,7 +267,7 @@ final class FamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( String Function( - FamilyRef ref, + Ref ref, int args, ) create, ) { @@ -358,7 +350,7 @@ final class ClassFamilyBasedProvider @override ClassFamilyBasedProvider $copyWithBuild( String Function( - Ref, + Ref, ClassFamilyBased, ) build, ) { @@ -434,8 +426,7 @@ final class ClassFamilyBasedFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - String Function(Ref ref, ClassFamilyBased notifier, int argument) - build, + String Function(Ref ref, ClassFamilyBased notifier, int argument) build, ) { return $FamilyOverride( from: this, diff --git a/packages/riverpod_generator/test/integration/generated.g.dart b/packages/riverpod_generator/test/integration/generated.g.dart index 4aef3a2a0..e835715b7 100644 --- a/packages/riverpod_generator/test/integration/generated.g.dart +++ b/packages/riverpod_generator/test/integration/generated.g.dart @@ -6,16 +6,14 @@ part of 'generated.dart'; // RiverpodGenerator // ************************************************************************** -typedef GeneratedRef = Ref<_Test>; - @ProviderFor(generated) const generatedProvider = GeneratedProvider._(); final class GeneratedProvider extends $FunctionalProvider<_Test, _Test> - with $Provider<_Test, GeneratedRef> { + with $Provider<_Test> { const GeneratedProvider._( {_Test Function( - GeneratedRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class GeneratedProvider extends $FunctionalProvider<_Test, _Test> ); final _Test Function( - GeneratedRef ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class GeneratedProvider extends $FunctionalProvider<_Test, _Test> @override GeneratedProvider $copyWithCreate( _Test Function( - GeneratedRef ref, + Ref ref, ) create, ) { return GeneratedProvider._(create: create); } @override - _Test create(GeneratedRef ref) { + _Test create(Ref ref) { final _$cb = _createCb ?? generated; return _$cb(ref); } @@ -66,18 +64,16 @@ final class GeneratedProvider extends $FunctionalProvider<_Test, _Test> String _$generatedHash() => r'0332eb232658688654514ff241ff380edbf4dbf6'; -typedef GeneratedFamilyRef = Ref<_Test>; - @ProviderFor(generatedFamily) const generatedFamilyProvider = GeneratedFamilyFamily._(); final class GeneratedFamilyProvider extends $FunctionalProvider<_Test, _Test> - with $Provider<_Test, GeneratedFamilyRef> { + with $Provider<_Test> { const GeneratedFamilyProvider._( {required GeneratedFamilyFamily super.from, required _Test super.argument, _Test Function( - GeneratedFamilyRef ref, + Ref ref, _Test test, )? create}) : _createCb = create, @@ -90,7 +86,7 @@ final class GeneratedFamilyProvider extends $FunctionalProvider<_Test, _Test> ); final _Test Function( - GeneratedFamilyRef ref, + Ref ref, _Test test, )? _createCb; @@ -120,7 +116,7 @@ final class GeneratedFamilyProvider extends $FunctionalProvider<_Test, _Test> @override GeneratedFamilyProvider $copyWithCreate( _Test Function( - GeneratedFamilyRef ref, + Ref ref, ) create, ) { return GeneratedFamilyProvider._( @@ -134,7 +130,7 @@ final class GeneratedFamilyProvider extends $FunctionalProvider<_Test, _Test> } @override - _Test create(GeneratedFamilyRef ref) { + _Test create(Ref ref) { final _$cb = _createCb ?? generatedFamily; final argument = this.argument as _Test; return _$cb( @@ -180,7 +176,7 @@ final class GeneratedFamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( _Test Function( - GeneratedFamilyRef ref, + Ref ref, _Test args, ) create, ) { @@ -246,7 +242,7 @@ final class GeneratedClassProvider @override GeneratedClassProvider $copyWithBuild( _Test Function( - Ref<_Test>, + Ref, GeneratedClass, ) build, ) { @@ -327,7 +323,7 @@ final class GeneratedClassFamilyProvider @override GeneratedClassFamilyProvider $copyWithBuild( _Test Function( - Ref<_Test>, + Ref, GeneratedClassFamily, ) build, ) { @@ -400,8 +396,7 @@ final class GeneratedClassFamilyFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - _Test Function( - Ref<_Test> ref, GeneratedClassFamily notifier, _Test argument) + _Test Function(Ref ref, GeneratedClassFamily notifier, _Test argument) build, ) { return $FamilyOverride( @@ -433,16 +428,14 @@ abstract class _$GeneratedClassFamily extends $Notifier<_Test> { ); } -typedef $DynamicRef = Ref; - @ProviderFor($dynamic) const $dynamicProvider = $DynamicProvider._(); final class $DynamicProvider extends $FunctionalProvider - with $Provider { + with $Provider { const $DynamicProvider._( {Object? Function( - $DynamicRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -456,7 +449,7 @@ final class $DynamicProvider extends $FunctionalProvider ); final Object? Function( - $DynamicRef ref, + Ref ref, )? _createCb; @override @@ -478,14 +471,14 @@ final class $DynamicProvider extends $FunctionalProvider @override $DynamicProvider $copyWithCreate( Object? Function( - $DynamicRef ref, + Ref ref, ) create, ) { return $DynamicProvider._(create: create); } @override - Object? create($DynamicRef ref) { + Object? create(Ref ref) { final _$cb = _createCb ?? $dynamic; return _$cb(ref); } @@ -493,18 +486,16 @@ final class $DynamicProvider extends $FunctionalProvider String _$$dynamicHash() => r'17c8e140446da2e3c026ebb51c4b074d2894b7ff'; -typedef $DynamicFamilyRef = Ref; - @ProviderFor($dynamicFamily) const $dynamicFamilyProvider = $DynamicFamilyFamily._(); final class $DynamicFamilyProvider extends $FunctionalProvider - with $Provider { + with $Provider { const $DynamicFamilyProvider._( {required $DynamicFamilyFamily super.from, required dynamic super.argument, Object? Function( - $DynamicFamilyRef ref, + Ref ref, dynamic test, )? create}) : _createCb = create, @@ -517,7 +508,7 @@ final class $DynamicFamilyProvider extends $FunctionalProvider ); final Object? Function( - $DynamicFamilyRef ref, + Ref ref, dynamic test, )? _createCb; @@ -547,7 +538,7 @@ final class $DynamicFamilyProvider extends $FunctionalProvider @override $DynamicFamilyProvider $copyWithCreate( Object? Function( - $DynamicFamilyRef ref, + Ref ref, ) create, ) { return $DynamicFamilyProvider._( @@ -561,7 +552,7 @@ final class $DynamicFamilyProvider extends $FunctionalProvider } @override - Object? create($DynamicFamilyRef ref) { + Object? create(Ref ref) { final _$cb = _createCb ?? $dynamicFamily; final argument = this.argument as dynamic; return _$cb( @@ -607,7 +598,7 @@ final class $DynamicFamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( Object? Function( - $DynamicFamilyRef ref, + Ref ref, dynamic args, ) create, ) { @@ -673,7 +664,7 @@ final class $DynamicClassProvider @override $DynamicClassProvider $copyWithBuild( Object? Function( - Ref, + Ref, $DynamicClass, ) build, ) { @@ -754,7 +745,7 @@ final class $DynamicClassFamilyProvider @override $DynamicClassFamilyProvider $copyWithBuild( Object? Function( - Ref, + Ref, $DynamicClassFamily, ) build, ) { @@ -827,8 +818,7 @@ final class $DynamicClassFamilyFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - Object? Function( - Ref ref, $DynamicClassFamily notifier, dynamic argument) + Object? Function(Ref ref, $DynamicClassFamily notifier, dynamic argument) build, ) { return $FamilyOverride( @@ -860,18 +850,16 @@ abstract class _$$DynamicClassFamily extends $Notifier { ); } -typedef _DynamicRef = Ref; - @ProviderFor(_dynamic) const _dynamicProvider = _DynamicFamily._(); final class _DynamicProvider extends $FunctionalProvider - with $Provider { + with $Provider { const _DynamicProvider._( {required _DynamicFamily super.from, required dynamic super.argument, Object? Function( - _DynamicRef ref, + Ref ref, dynamic test, )? create}) : _createCb = create, @@ -884,7 +872,7 @@ final class _DynamicProvider extends $FunctionalProvider ); final Object? Function( - _DynamicRef ref, + Ref ref, dynamic test, )? _createCb; @@ -914,7 +902,7 @@ final class _DynamicProvider extends $FunctionalProvider @override _DynamicProvider $copyWithCreate( Object? Function( - _DynamicRef ref, + Ref ref, ) create, ) { return _DynamicProvider._( @@ -928,7 +916,7 @@ final class _DynamicProvider extends $FunctionalProvider } @override - Object? create(_DynamicRef ref) { + Object? create(Ref ref) { final _$cb = _createCb ?? _dynamic; final argument = this.argument as dynamic; return _$cb( @@ -948,7 +936,7 @@ final class _DynamicProvider extends $FunctionalProvider } } -String _$dynamicHash() => r'da9dc07960139fff2cf5fe584dca5c524e4f2308'; +String _$dynamicHash() => r'e08bd08481e4ea0d3da2ab7c38f940c34e96ba7f'; final class _DynamicFamily extends Family { const _DynamicFamily._() @@ -974,7 +962,7 @@ final class _DynamicFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( Object? Function( - _DynamicRef ref, + Ref ref, dynamic args, ) create, ) { @@ -993,17 +981,15 @@ final class _DynamicFamily extends Family { } } -typedef AliasRef = Ref>; - @ProviderFor(alias) const aliasProvider = AliasProvider._(); final class AliasProvider extends $FunctionalProvider, AsyncValue> - with $Provider, AliasRef> { + with $Provider> { const AliasProvider._( {AsyncValue Function( - AliasRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1017,7 +1003,7 @@ final class AliasProvider ); final AsyncValue Function( - AliasRef ref, + Ref ref, )? _createCb; @override @@ -1039,34 +1025,32 @@ final class AliasProvider @override AliasProvider $copyWithCreate( AsyncValue Function( - AliasRef ref, + Ref ref, ) create, ) { return AliasProvider._(create: create); } @override - AsyncValue create(AliasRef ref) { + AsyncValue create(Ref ref) { final _$cb = _createCb ?? alias; return _$cb(ref); } } -String _$aliasHash() => r'ed56b34397f397d33434be16d3a6bab96d24c45b'; - -typedef AliasFamilyRef = Ref>; +String _$aliasHash() => r'3feb548aa9a314142b5c5e3c9c7664a316a10d11'; @ProviderFor(aliasFamily) const aliasFamilyProvider = AliasFamilyFamily._(); final class AliasFamilyProvider extends $FunctionalProvider, AsyncValue> - with $Provider, AliasFamilyRef> { + with $Provider> { const AliasFamilyProvider._( {required AliasFamilyFamily super.from, required AsyncValue super.argument, AsyncValue Function( - AliasFamilyRef ref, + Ref ref, AsyncValue test, )? create}) : _createCb = create, @@ -1079,7 +1063,7 @@ final class AliasFamilyProvider ); final AsyncValue Function( - AliasFamilyRef ref, + Ref ref, AsyncValue test, )? _createCb; @@ -1109,7 +1093,7 @@ final class AliasFamilyProvider @override AliasFamilyProvider $copyWithCreate( AsyncValue Function( - AliasFamilyRef ref, + Ref ref, ) create, ) { return AliasFamilyProvider._( @@ -1123,7 +1107,7 @@ final class AliasFamilyProvider } @override - AsyncValue create(AliasFamilyRef ref) { + AsyncValue create(Ref ref) { final _$cb = _createCb ?? aliasFamily; final argument = this.argument as AsyncValue; return _$cb( @@ -1143,7 +1127,7 @@ final class AliasFamilyProvider } } -String _$aliasFamilyHash() => r'21f22a6042a649e2de33b829bb85ea54eb6983a2'; +String _$aliasFamilyHash() => r'6afe0afc21cfd2f0f26862e9d8c1095eca5f6e42'; final class AliasFamilyFamily extends Family { const AliasFamilyFamily._() @@ -1169,7 +1153,7 @@ final class AliasFamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( AsyncValue Function( - AliasFamilyRef ref, + Ref ref, AsyncValue args, ) create, ) { @@ -1235,7 +1219,7 @@ final class AliasClassProvider @override AliasClassProvider $copyWithBuild( AsyncValue Function( - Ref>, + Ref, AliasClass, ) build, ) { @@ -1316,7 +1300,7 @@ final class AliasClassFamilyProvider @override AliasClassFamilyProvider $copyWithBuild( AsyncValue Function( - Ref>, + Ref, AliasClassFamily, ) build, ) { @@ -1388,8 +1372,8 @@ final class AliasClassFamilyFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - AsyncValue Function(Ref> ref, - AliasClassFamily notifier, AsyncValue argument) + AsyncValue Function( + Ref ref, AliasClassFamily notifier, AsyncValue argument) build, ) { return $FamilyOverride( diff --git a/packages/riverpod_generator/test/integration/hash/hash1.g.dart b/packages/riverpod_generator/test/integration/hash/hash1.g.dart index 0cc5023c4..9842eb755 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.g.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.g.dart @@ -6,16 +6,14 @@ part of 'hash1.dart'; // RiverpodGenerator // ************************************************************************** -typedef SimpleRef = Ref; - @ProviderFor(simple) const simpleProvider = SimpleProvider._(); final class SimpleProvider extends $FunctionalProvider - with $Provider { + with $Provider { const SimpleProvider._( {String Function( - SimpleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class SimpleProvider extends $FunctionalProvider ); final String Function( - SimpleRef ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class SimpleProvider extends $FunctionalProvider @override SimpleProvider $copyWithCreate( String Function( - SimpleRef ref, + Ref ref, ) create, ) { return SimpleProvider._(create: create); } @override - String create(SimpleRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? simple; return _$cb(ref); } @@ -66,16 +64,14 @@ final class SimpleProvider extends $FunctionalProvider String _$simpleHash() => r'f916b37e39d654e9acfc9c2bd7a244902197b306'; -typedef Simple2Ref = Ref; - @ProviderFor(simple2) const simple2Provider = Simple2Provider._(); final class Simple2Provider extends $FunctionalProvider - with $Provider { + with $Provider { const Simple2Provider._( {String Function( - Simple2Ref ref, + Ref ref, )? create}) : _createCb = create, super( @@ -89,7 +85,7 @@ final class Simple2Provider extends $FunctionalProvider ); final String Function( - Simple2Ref ref, + Ref ref, )? _createCb; @override @@ -111,14 +107,14 @@ final class Simple2Provider extends $FunctionalProvider @override Simple2Provider $copyWithCreate( String Function( - Simple2Ref ref, + Ref ref, ) create, ) { return Simple2Provider._(create: create); } @override - String create(Simple2Ref ref) { + String create(Ref ref) { final _$cb = _createCb ?? simple2; return _$cb(ref); } @@ -172,7 +168,7 @@ final class SimpleClassProvider extends $NotifierProvider { @override SimpleClassProvider $copyWithBuild( String Function( - Ref, + Ref, SimpleClass, ) build, ) { diff --git a/packages/riverpod_generator/test/integration/hash/retry.g.dart b/packages/riverpod_generator/test/integration/hash/retry.g.dart index 3341cd835..97c31e493 100644 --- a/packages/riverpod_generator/test/integration/hash/retry.g.dart +++ b/packages/riverpod_generator/test/integration/hash/retry.g.dart @@ -6,16 +6,14 @@ part of 'retry.dart'; // RiverpodGenerator // ************************************************************************** -typedef ARef = Ref; - @ProviderFor(a) const aProvider = AProvider._(); final class AProvider extends $FunctionalProvider - with $Provider { + with $Provider { const AProvider._( {String Function( - ARef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class AProvider extends $FunctionalProvider ); final String Function( - ARef ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class AProvider extends $FunctionalProvider @override AProvider $copyWithCreate( String Function( - ARef ref, + Ref ref, ) create, ) { return AProvider._(create: create); } @override - String create(ARef ref) { + String create(Ref ref) { final _$cb = _createCb ?? a; return _$cb(ref); } @@ -66,18 +64,16 @@ final class AProvider extends $FunctionalProvider String _$aHash() => r'83a9516d10f85dc72ca773837e042bfc6e36c1f1'; -typedef BRef = Ref; - @ProviderFor(b) const bProvider = BFamily._(); final class BProvider extends $FunctionalProvider - with $Provider { + with $Provider { const BProvider._( {required BFamily super.from, required int super.argument, String Function( - BRef ref, + Ref ref, int arg, )? create}) : _createCb = create, @@ -90,7 +86,7 @@ final class BProvider extends $FunctionalProvider ); final String Function( - BRef ref, + Ref ref, int arg, )? _createCb; @@ -120,7 +116,7 @@ final class BProvider extends $FunctionalProvider @override BProvider $copyWithCreate( String Function( - BRef ref, + Ref ref, ) create, ) { return BProvider._( @@ -134,7 +130,7 @@ final class BProvider extends $FunctionalProvider } @override - String create(BRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? b; final argument = this.argument as int; return _$cb( @@ -180,7 +176,7 @@ final class BFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( String Function( - BRef ref, + Ref ref, int args, ) create, ) { diff --git a/packages/riverpod_generator/test/integration/scopes.g.dart b/packages/riverpod_generator/test/integration/scopes.g.dart index 132dea515..a719f7459 100644 --- a/packages/riverpod_generator/test/integration/scopes.g.dart +++ b/packages/riverpod_generator/test/integration/scopes.g.dart @@ -52,7 +52,7 @@ final class ScopedClassProvider extends $NotifierProvider { @override ScopedClassProvider $copyWithBuild( int Function( - Ref, + Ref, ScopedClass, ) build, ) { @@ -133,7 +133,7 @@ final class ScopedClassFamilyProvider @override ScopedClassFamilyProvider $copyWithBuild( int Function( - Ref, + Ref, ScopedClassFamily, ) build, ) { @@ -205,7 +205,7 @@ final class ScopedClassFamilyFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - int Function(Ref ref, ScopedClassFamily notifier, int argument) build, + int Function(Ref ref, ScopedClassFamily notifier, int argument) build, ) { return $FamilyOverride( from: this, diff --git a/packages/riverpod_generator/test/integration/split.g.dart b/packages/riverpod_generator/test/integration/split.g.dart index d28eb5553..a3eb0f24a 100644 --- a/packages/riverpod_generator/test/integration/split.g.dart +++ b/packages/riverpod_generator/test/integration/split.g.dart @@ -6,16 +6,14 @@ part of 'split.dart'; // RiverpodGenerator // ************************************************************************** -typedef Counter2Ref = Ref; - @ProviderFor(counter2) const counter2Provider = Counter2Provider._(); final class Counter2Provider extends $FunctionalProvider - with $Provider { + with $Provider { const Counter2Provider._( {int Function( - Counter2Ref ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class Counter2Provider extends $FunctionalProvider ); final int Function( - Counter2Ref ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class Counter2Provider extends $FunctionalProvider @override Counter2Provider $copyWithCreate( int Function( - Counter2Ref ref, + Ref ref, ) create, ) { return Counter2Provider._(create: create); } @override - int create(Counter2Ref ref) { + int create(Ref ref) { final _$cb = _createCb ?? counter2; return _$cb(ref); } @@ -66,16 +64,14 @@ final class Counter2Provider extends $FunctionalProvider String _$counter2Hash() => r'ab7bef7da79217c780c76761a5ae0c0172ca097e'; -typedef CounterRef = Ref; - @ProviderFor(counter) const counterProvider = CounterProvider._(); final class CounterProvider extends $FunctionalProvider - with $Provider { + with $Provider { const CounterProvider._( {int Function( - CounterRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -89,7 +85,7 @@ final class CounterProvider extends $FunctionalProvider ); final int Function( - CounterRef ref, + Ref ref, )? _createCb; @override @@ -111,14 +107,14 @@ final class CounterProvider extends $FunctionalProvider @override CounterProvider $copyWithCreate( int Function( - CounterRef ref, + Ref ref, ) create, ) { return CounterProvider._(create: create); } @override - int create(CounterRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? counter; return _$cb(ref); } diff --git a/packages/riverpod_generator/test/integration/stream.g.dart b/packages/riverpod_generator/test/integration/stream.g.dart index 2e4e2000d..77864bf8f 100644 --- a/packages/riverpod_generator/test/integration/stream.g.dart +++ b/packages/riverpod_generator/test/integration/stream.g.dart @@ -6,18 +6,16 @@ part of 'stream.dart'; // RiverpodGenerator // ************************************************************************** -typedef GenericRef = Ref>>; - @ProviderFor(generic) const genericProvider = GenericFamily._(); final class GenericProvider extends $FunctionalProvider>, Stream>> - with $FutureModifier>, $StreamProvider, GenericRef> { + with $FutureModifier>, $StreamProvider> { const GenericProvider._( {required GenericFamily super.from, Stream> Function( - GenericRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -30,7 +28,7 @@ final class GenericProvider ); final Stream> Function( - GenericRef ref, + Ref ref, )? _createCb; @override @@ -38,7 +36,7 @@ final class GenericProvider GenericProvider _copyWithCreate( Stream> Function( - GenericRef ref, + Ref ref, ) create, ) { return GenericProvider._( @@ -60,14 +58,14 @@ final class GenericProvider @override GenericProvider $copyWithCreate( Stream> Function( - GenericRef ref, + Ref ref, ) create, ) { return GenericProvider._(from: from! as GenericFamily, create: create); } @override - Stream> create(GenericRef ref) { + Stream> create(Ref ref) { final _$cb = _createCb ?? generic; return _$cb(ref); } @@ -107,7 +105,7 @@ final class GenericFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( - Stream> Function(GenericRef ref) create, + Stream> Function(Ref ref) create, ) { return $FamilyOverride( from: this, @@ -153,7 +151,7 @@ final class GenericClassProvider GenericClassProvider _copyWithBuild( Stream> Function( - Ref>>, + Ref, GenericClass, ) build, ) { @@ -185,7 +183,7 @@ final class GenericClassProvider @override GenericClassProvider $copyWithBuild( Stream> Function( - Ref>>, + Ref, GenericClass, ) build, ) { @@ -249,8 +247,7 @@ final class GenericClassFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - Stream> Function( - Ref>> ref, GenericClass notifier) + Stream> Function(Ref ref, GenericClass notifier) build, ) { return $FamilyOverride( @@ -271,17 +268,15 @@ abstract class _$GenericClass extends $StreamNotifier> { Stream> runBuild() => build(); } -typedef PublicRef = Ref>; - @ProviderFor(public) const publicProvider = PublicProvider._(); final class PublicProvider extends $FunctionalProvider, Stream> - with $FutureModifier, $StreamProvider { + with $FutureModifier, $StreamProvider { const PublicProvider._( {Stream Function( - PublicRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -295,7 +290,7 @@ final class PublicProvider ); final Stream Function( - PublicRef ref, + Ref ref, )? _createCb; @override @@ -309,14 +304,14 @@ final class PublicProvider @override PublicProvider $copyWithCreate( Stream Function( - PublicRef ref, + Ref ref, ) create, ) { return PublicProvider._(create: create); } @override - Stream create(PublicRef ref) { + Stream create(Ref ref) { final _$cb = _createCb ?? public; return _$cb(ref); } @@ -324,17 +319,15 @@ final class PublicProvider String _$publicHash() => r'ed93527425175c4a2475e83a3f44223a2aa604d7'; -typedef _PrivateRef = Ref>; - @ProviderFor(_private) const _privateProvider = _PrivateProvider._(); final class _PrivateProvider extends $FunctionalProvider, Stream> - with $FutureModifier, $StreamProvider { + with $FutureModifier, $StreamProvider { const _PrivateProvider._( {Stream Function( - _PrivateRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -348,7 +341,7 @@ final class _PrivateProvider ); final Stream Function( - _PrivateRef ref, + Ref ref, )? _createCb; @override @@ -362,14 +355,14 @@ final class _PrivateProvider @override _PrivateProvider $copyWithCreate( Stream Function( - _PrivateRef ref, + Ref ref, ) create, ) { return _PrivateProvider._(create: create); } @override - Stream create(_PrivateRef ref) { + Stream create(Ref ref) { final _$cb = _createCb ?? _private; return _$cb(ref); } @@ -377,14 +370,12 @@ final class _PrivateProvider String _$privateHash() => r'7915ccdd16751e7dc6274bb024d1b273d78dc78b'; -typedef FamilyRef = Ref>; - @ProviderFor(family) const familyProvider = FamilyFamily._(); final class FamilyProvider extends $FunctionalProvider, Stream> - with $FutureModifier, $StreamProvider { + with $FutureModifier, $StreamProvider { const FamilyProvider._( {required FamilyFamily super.from, required ( @@ -396,7 +387,7 @@ final class FamilyProvider }) super.argument, Stream Function( - FamilyRef ref, + Ref ref, int first, { String? second, required double third, @@ -413,7 +404,7 @@ final class FamilyProvider ); final Stream Function( - FamilyRef ref, + Ref ref, int first, { String? second, required double third, @@ -439,7 +430,7 @@ final class FamilyProvider @override FamilyProvider $copyWithCreate( Stream Function( - FamilyRef ref, + Ref ref, ) create, ) { return FamilyProvider._( @@ -463,7 +454,7 @@ final class FamilyProvider } @override - Stream create(FamilyRef ref) { + Stream create(Ref ref) { final _$cb = _createCb ?? family; final argument = this.argument as ( int, { @@ -529,7 +520,7 @@ final class FamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( Stream Function( - FamilyRef ref, + Ref ref, ( int, { String? second, @@ -599,7 +590,7 @@ final class PublicClassProvider @override PublicClassProvider $copyWithBuild( Stream Function( - Ref>, + Ref, PublicClass, ) build, ) { @@ -661,7 +652,7 @@ final class _PrivateClassProvider @override _PrivateClassProvider $copyWithBuild( Stream Function( - Ref>, + Ref, _PrivateClass, ) build, ) { @@ -747,7 +738,7 @@ final class FamilyClassProvider @override FamilyClassProvider $copyWithBuild( Stream Function( - Ref>, + Ref, FamilyClass, ) build, ) { @@ -848,7 +839,7 @@ final class FamilyClassFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( Stream Function( - Ref> ref, + Ref ref, FamilyClass notifier, ( int, { diff --git a/packages/riverpod_generator/test/integration/sync.g.dart b/packages/riverpod_generator/test/integration/sync.g.dart index 1fb2502d4..fa219a7a7 100644 --- a/packages/riverpod_generator/test/integration/sync.g.dart +++ b/packages/riverpod_generator/test/integration/sync.g.dart @@ -6,18 +6,15 @@ part of 'sync.dart'; // RiverpodGenerator // ************************************************************************** -typedef GenericRef = Ref>; - @ProviderFor(generic) const genericProvider = GenericFamily._(); final class GenericProvider - extends $FunctionalProvider, List> - with $Provider, GenericRef> { + extends $FunctionalProvider, List> with $Provider> { const GenericProvider._( {required GenericFamily super.from, List Function( - GenericRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -30,7 +27,7 @@ final class GenericProvider ); final List Function( - GenericRef ref, + Ref ref, )? _createCb; @override @@ -38,7 +35,7 @@ final class GenericProvider GenericProvider _copyWithCreate( List Function( - GenericRef ref, + Ref ref, ) create, ) { return GenericProvider._( @@ -68,14 +65,14 @@ final class GenericProvider @override GenericProvider $copyWithCreate( List Function( - GenericRef ref, + Ref ref, ) create, ) { return GenericProvider._(from: from! as GenericFamily, create: create); } @override - List create(GenericRef ref) { + List create(Ref ref) { final _$cb = _createCb ?? generic; return _$cb(ref); } @@ -115,7 +112,7 @@ final class GenericFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( - List Function(GenericRef ref) create, + List Function(Ref ref) create, ) { return $FamilyOverride( from: this, @@ -128,14 +125,11 @@ final class GenericFamily extends Family { } } -typedef ComplexGenericRef = Ref>; - @ProviderFor(complexGeneric) const complexGenericProvider = ComplexGenericFamily._(); final class ComplexGenericProvider - extends $FunctionalProvider, List> - with $Provider, ComplexGenericRef> { + extends $FunctionalProvider, List> with $Provider> { const ComplexGenericProvider._( {required ComplexGenericFamily super.from, required ({ @@ -144,7 +138,7 @@ final class ComplexGenericProvider }) super.argument, List Function( - ComplexGenericRef ref, { + Ref ref, { required T param, Foo? otherParam, })? create}) @@ -158,7 +152,7 @@ final class ComplexGenericProvider ); final List Function( - ComplexGenericRef ref, { + Ref ref, { required T param, Foo? otherParam, })? _createCb; @@ -168,7 +162,7 @@ final class ComplexGenericProvider ComplexGenericProvider _copyWithCreate( List Function( - ComplexGenericRef ref, { + Ref ref, { required T param, Foo? otherParam, }) create, @@ -205,7 +199,7 @@ final class ComplexGenericProvider @override ComplexGenericProvider $copyWithCreate( List Function( - ComplexGenericRef ref, + Ref ref, ) create, ) { return ComplexGenericProvider._( @@ -223,7 +217,7 @@ final class ComplexGenericProvider } @override - List create(ComplexGenericRef ref) { + List create(Ref ref) { final _$cb = _createCb ?? complexGeneric; final argument = this.argument as ({ T param, @@ -279,7 +273,7 @@ final class ComplexGenericFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( List Function( - ComplexGenericRef ref, + Ref ref, ({ T param, Foo? otherParam, @@ -339,7 +333,7 @@ final class GenericClassProvider GenericClassProvider _copyWithBuild( List Function( - Ref>, + Ref, GenericClass, ) build, ) { @@ -379,7 +373,7 @@ final class GenericClassProvider @override GenericClassProvider $copyWithBuild( List Function( - Ref>, + Ref, GenericClass, ) build, ) { @@ -443,8 +437,7 @@ final class GenericClassFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - List Function(Ref> ref, GenericClass notifier) - build, + List Function(Ref ref, GenericClass notifier) build, ) { return $FamilyOverride( from: this, @@ -464,17 +457,15 @@ abstract class _$GenericClass extends $Notifier> { List runBuild() => build(); } -typedef RawFutureRef = Ref>>; - @ProviderFor(rawFuture) const rawFutureProvider = RawFutureProvider._(); final class RawFutureProvider extends $FunctionalProvider>, Raw>> - with $Provider>, RawFutureRef> { + with $Provider>> { const RawFutureProvider._( {Raw> Function( - RawFutureRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -488,7 +479,7 @@ final class RawFutureProvider ); final Raw> Function( - RawFutureRef ref, + Ref ref, )? _createCb; @override @@ -511,14 +502,14 @@ final class RawFutureProvider @override RawFutureProvider $copyWithCreate( Raw> Function( - RawFutureRef ref, + Ref ref, ) create, ) { return RawFutureProvider._(create: create); } @override - Raw> create(RawFutureRef ref) { + Raw> create(Ref ref) { final _$cb = _createCb ?? rawFuture; return _$cb(ref); } @@ -526,17 +517,15 @@ final class RawFutureProvider String _$rawFutureHash() => r'9d397f4c0a578a2741610f9ca6f17438ee8e5a34'; -typedef RawStreamRef = Ref>>; - @ProviderFor(rawStream) const rawStreamProvider = RawStreamProvider._(); final class RawStreamProvider extends $FunctionalProvider>, Raw>> - with $Provider>, RawStreamRef> { + with $Provider>> { const RawStreamProvider._( {Raw> Function( - RawStreamRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -550,7 +539,7 @@ final class RawStreamProvider ); final Raw> Function( - RawStreamRef ref, + Ref ref, )? _createCb; @override @@ -573,14 +562,14 @@ final class RawStreamProvider @override RawStreamProvider $copyWithCreate( Raw> Function( - RawStreamRef ref, + Ref ref, ) create, ) { return RawStreamProvider._(create: create); } @override - Raw> create(RawStreamRef ref) { + Raw> create(Ref ref) { final _$cb = _createCb ?? rawStream; return _$cb(ref); } @@ -635,7 +624,7 @@ final class RawFutureClassProvider @override RawFutureClassProvider $copyWithBuild( Raw> Function( - Ref>>, + Ref, RawFutureClass, ) build, ) { @@ -705,7 +694,7 @@ final class RawStreamClassProvider @override RawStreamClassProvider $copyWithBuild( Raw> Function( - Ref>>, + Ref, RawStreamClass, ) build, ) { @@ -728,19 +717,17 @@ abstract class _$RawStreamClass extends $Notifier>> { Raw> runBuild() => build(); } -typedef RawFamilyFutureRef = Ref>>; - @ProviderFor(rawFamilyFuture) const rawFamilyFutureProvider = RawFamilyFutureFamily._(); final class RawFamilyFutureProvider extends $FunctionalProvider>, Raw>> - with $Provider>, RawFamilyFutureRef> { + with $Provider>> { const RawFamilyFutureProvider._( {required RawFamilyFutureFamily super.from, required int super.argument, Raw> Function( - RawFamilyFutureRef ref, + Ref ref, int id, )? create}) : _createCb = create, @@ -753,7 +740,7 @@ final class RawFamilyFutureProvider ); final Raw> Function( - RawFamilyFutureRef ref, + Ref ref, int id, )? _createCb; @@ -784,7 +771,7 @@ final class RawFamilyFutureProvider @override RawFamilyFutureProvider $copyWithCreate( Raw> Function( - RawFamilyFutureRef ref, + Ref ref, ) create, ) { return RawFamilyFutureProvider._( @@ -798,7 +785,7 @@ final class RawFamilyFutureProvider } @override - Raw> create(RawFamilyFutureRef ref) { + Raw> create(Ref ref) { final _$cb = _createCb ?? rawFamilyFuture; final argument = this.argument as int; return _$cb( @@ -844,7 +831,7 @@ final class RawFamilyFutureFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( Raw> Function( - RawFamilyFutureRef ref, + Ref ref, int args, ) create, ) { @@ -863,19 +850,17 @@ final class RawFamilyFutureFamily extends Family { } } -typedef RawFamilyStreamRef = Ref>>; - @ProviderFor(rawFamilyStream) const rawFamilyStreamProvider = RawFamilyStreamFamily._(); final class RawFamilyStreamProvider extends $FunctionalProvider>, Raw>> - with $Provider>, RawFamilyStreamRef> { + with $Provider>> { const RawFamilyStreamProvider._( {required RawFamilyStreamFamily super.from, required int super.argument, Raw> Function( - RawFamilyStreamRef ref, + Ref ref, int id, )? create}) : _createCb = create, @@ -888,7 +873,7 @@ final class RawFamilyStreamProvider ); final Raw> Function( - RawFamilyStreamRef ref, + Ref ref, int id, )? _createCb; @@ -919,7 +904,7 @@ final class RawFamilyStreamProvider @override RawFamilyStreamProvider $copyWithCreate( Raw> Function( - RawFamilyStreamRef ref, + Ref ref, ) create, ) { return RawFamilyStreamProvider._( @@ -933,7 +918,7 @@ final class RawFamilyStreamProvider } @override - Raw> create(RawFamilyStreamRef ref) { + Raw> create(Ref ref) { final _$cb = _createCb ?? rawFamilyStream; final argument = this.argument as int; return _$cb( @@ -979,7 +964,7 @@ final class RawFamilyStreamFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( Raw> Function( - RawFamilyStreamRef ref, + Ref ref, int args, ) create, ) { @@ -1056,7 +1041,7 @@ final class RawFamilyFutureClassProvider @override RawFamilyFutureClassProvider $copyWithBuild( Raw> Function( - Ref>>, + Ref, RawFamilyFutureClass, ) build, ) { @@ -1129,8 +1114,8 @@ final class RawFamilyFutureClassFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - Raw> Function(Ref>> ref, - RawFamilyFutureClass notifier, int argument) + Raw> Function( + Ref ref, RawFamilyFutureClass notifier, int argument) build, ) { return $FamilyOverride( @@ -1220,7 +1205,7 @@ final class RawFamilyStreamClassProvider @override RawFamilyStreamClassProvider $copyWithBuild( Raw> Function( - Ref>>, + Ref, RawFamilyStreamClass, ) build, ) { @@ -1293,8 +1278,8 @@ final class RawFamilyStreamClassFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - Raw> Function(Ref>> ref, - RawFamilyStreamClass notifier, int argument) + Raw> Function( + Ref ref, RawFamilyStreamClass notifier, int argument) build, ) { return $FamilyOverride( @@ -1326,20 +1311,17 @@ abstract class _$RawFamilyStreamClass extends $Notifier>> { ); } -/// This is some documentation -typedef PublicRef = Ref; - /// This is some documentation @ProviderFor(public) const publicProvider = PublicProvider._(); /// This is some documentation final class PublicProvider extends $FunctionalProvider - with $Provider { + with $Provider { /// This is some documentation const PublicProvider._( {String Function( - PublicRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1353,7 +1335,7 @@ final class PublicProvider extends $FunctionalProvider ); final String Function( - PublicRef ref, + Ref ref, )? _createCb; @override @@ -1375,14 +1357,14 @@ final class PublicProvider extends $FunctionalProvider @override PublicProvider $copyWithCreate( String Function( - PublicRef ref, + Ref ref, ) create, ) { return PublicProvider._(create: create); } @override - String create(PublicRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? public; return _$cb(ref); } @@ -1390,16 +1372,14 @@ final class PublicProvider extends $FunctionalProvider String _$publicHash() => r'94bee36125844f9fe521363bb228632b9f3bfbc7'; -typedef Supports$inNamesRef = Ref; - @ProviderFor(supports$inNames) const supports$inNamesProvider = Supports$inNamesProvider._(); final class Supports$inNamesProvider extends $FunctionalProvider - with $Provider { + with $Provider { const Supports$inNamesProvider._( {String Function( - Supports$inNamesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1413,7 +1393,7 @@ final class Supports$inNamesProvider extends $FunctionalProvider ); final String Function( - Supports$inNamesRef ref, + Ref ref, )? _createCb; @override @@ -1435,14 +1415,14 @@ final class Supports$inNamesProvider extends $FunctionalProvider @override Supports$inNamesProvider $copyWithCreate( String Function( - Supports$inNamesRef ref, + Ref ref, ) create, ) { return Supports$inNamesProvider._(create: create); } @override - String create(Supports$inNamesRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? supports$inNames; return _$cb(ref); } @@ -1450,16 +1430,13 @@ final class Supports$inNamesProvider extends $FunctionalProvider String _$supports$inNamesHash() => r'8da1f9329f302ce75e38d03c96595de3260b4d2d'; -/// This is some documentation -typedef FamilyRef = Ref; - /// This is some documentation @ProviderFor(family) const familyProvider = FamilyFamily._(); /// This is some documentation final class FamilyProvider extends $FunctionalProvider - with $Provider { + with $Provider { /// This is some documentation const FamilyProvider._( {required FamilyFamily super.from, @@ -1472,7 +1449,7 @@ final class FamilyProvider extends $FunctionalProvider }) super.argument, String Function( - FamilyRef ref, + Ref ref, int first, { String? second, required double third, @@ -1489,7 +1466,7 @@ final class FamilyProvider extends $FunctionalProvider ); final String Function( - FamilyRef ref, + Ref ref, int first, { String? second, required double third, @@ -1523,7 +1500,7 @@ final class FamilyProvider extends $FunctionalProvider @override FamilyProvider $copyWithCreate( String Function( - FamilyRef ref, + Ref ref, ) create, ) { return FamilyProvider._( @@ -1547,7 +1524,7 @@ final class FamilyProvider extends $FunctionalProvider } @override - String create(FamilyRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? family; final argument = this.argument as ( int, { @@ -1615,7 +1592,7 @@ final class FamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( String Function( - FamilyRef ref, + Ref ref, ( int, { String? second, @@ -1646,16 +1623,14 @@ final class FamilyFamily extends Family { } } -typedef _PrivateRef = Ref; - @ProviderFor(_private) const _privateProvider = _PrivateProvider._(); final class _PrivateProvider extends $FunctionalProvider - with $Provider { + with $Provider { const _PrivateProvider._( {String Function( - _PrivateRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1669,7 +1644,7 @@ final class _PrivateProvider extends $FunctionalProvider ); final String Function( - _PrivateRef ref, + Ref ref, )? _createCb; @override @@ -1691,14 +1666,14 @@ final class _PrivateProvider extends $FunctionalProvider @override _PrivateProvider $copyWithCreate( String Function( - _PrivateRef ref, + Ref ref, ) create, ) { return _PrivateProvider._(create: create); } @override - String create(_PrivateRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? _private; return _$cb(ref); } @@ -1755,7 +1730,7 @@ final class PublicClassProvider extends $NotifierProvider { @override PublicClassProvider $copyWithBuild( String Function( - Ref, + Ref, PublicClass, ) build, ) { @@ -1825,7 +1800,7 @@ final class _PrivateClassProvider @override _PrivateClassProvider $copyWithBuild( String Function( - Ref, + Ref, _PrivateClass, ) build, ) { @@ -1921,7 +1896,7 @@ final class FamilyClassProvider extends $NotifierProvider { @override FamilyClassProvider $copyWithBuild( String Function( - Ref, + Ref, FamilyClass, ) build, ) { @@ -2024,7 +1999,7 @@ final class FamilyClassFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( String Function( - Ref ref, + Ref ref, FamilyClass notifier, ( int, { @@ -2088,18 +2063,15 @@ abstract class _$FamilyClass extends $Notifier { ); } -typedef Supports$InFnNameRef = Ref; - @ProviderFor(supports$InFnName) const supports$InFnNameProvider = Supports$InFnNameFamily._(); final class Supports$InFnNameProvider - extends $FunctionalProvider - with $Provider> { + extends $FunctionalProvider with $Provider { const Supports$InFnNameProvider._( {required Supports$InFnNameFamily super.from, String Function( - Supports$InFnNameRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -2112,7 +2084,7 @@ final class Supports$InFnNameProvider ); final String Function( - Supports$InFnNameRef ref, + Ref ref, )? _createCb; @override @@ -2120,7 +2092,7 @@ final class Supports$InFnNameProvider Supports$InFnNameProvider _copyWithCreate( String Function( - Supports$InFnNameRef ref, + Ref ref, ) create, ) { return Supports$InFnNameProvider._( @@ -2150,7 +2122,7 @@ final class Supports$InFnNameProvider @override Supports$InFnNameProvider $copyWithCreate( String Function( - Supports$InFnNameRef ref, + Ref ref, ) create, ) { return Supports$InFnNameProvider._( @@ -2158,7 +2130,7 @@ final class Supports$InFnNameProvider } @override - String create(Supports$InFnNameRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? supports$InFnName; return _$cb(ref); } @@ -2176,7 +2148,7 @@ final class Supports$InFnNameProvider } } -String _$supports$InFnNameHash() => r'fec3daca655669a46760cc54921f098b9cbaac3d'; +String _$supports$InFnNameHash() => r'09636911da6a98293c260aad55b89bea5296136b'; final class Supports$InFnNameFamily extends Family { const Supports$InFnNameFamily._() @@ -2199,7 +2171,7 @@ final class Supports$InFnNameFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( - String Function(Supports$InFnNameRef ref) create, + String Function(Ref ref) create, ) { return $FamilyOverride( from: this, @@ -2212,14 +2184,11 @@ final class Supports$InFnNameFamily extends Family { } } -typedef Supports$InFnNameFamilyRef = Ref; - @ProviderFor(supports$InFnNameFamily) const supports$InFnNameFamilyProvider = Supports$InFnNameFamilyFamily._(); final class Supports$InFnNameFamilyProvider - extends $FunctionalProvider - with $Provider> { + extends $FunctionalProvider with $Provider { const Supports$InFnNameFamilyProvider._( {required Supports$InFnNameFamilyFamily super.from, required ( @@ -2229,7 +2198,7 @@ final class Supports$InFnNameFamilyProvider }) super.argument, String Function( - Supports$InFnNameFamilyRef ref, + Ref ref, And$InT positional$arg, { required And$InT named$arg, String defaultArg, @@ -2244,7 +2213,7 @@ final class Supports$InFnNameFamilyProvider ); final String Function( - Supports$InFnNameFamilyRef ref, + Ref ref, And$InT positional$arg, { required And$InT named$arg, String defaultArg, @@ -2255,7 +2224,7 @@ final class Supports$InFnNameFamilyProvider Supports$InFnNameFamilyProvider _copyWithCreate( String Function( - Supports$InFnNameFamilyRef ref, + Ref ref, And$InT positional$arg, { required And$InT named$arg, String defaultArg, @@ -2294,7 +2263,7 @@ final class Supports$InFnNameFamilyProvider @override Supports$InFnNameFamilyProvider $copyWithCreate( String Function( - Supports$InFnNameFamilyRef ref, + Ref ref, ) create, ) { return Supports$InFnNameFamilyProvider._( @@ -2314,7 +2283,7 @@ final class Supports$InFnNameFamilyProvider } @override - String create(Supports$InFnNameFamilyRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? supports$InFnNameFamily; final argument = this.argument as ( And$InT, { @@ -2343,7 +2312,7 @@ final class Supports$InFnNameFamilyProvider } String _$supports$InFnNameFamilyHash() => - r'1daa434fa2ad9ff37deade29ba3ca8155833df1b'; + r'3124634e8535d4db655d6384b0827f0f195a75ef'; final class Supports$InFnNameFamilyFamily extends Family { const Supports$InFnNameFamilyFamily._() @@ -2375,7 +2344,7 @@ final class Supports$InFnNameFamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( String Function( - Supports$InFnNameFamilyRef ref, + Ref ref, ( And$InT, { And$InT named$arg, @@ -2438,7 +2407,7 @@ final class Supports$InClassNameProvider Supports$InClassNameProvider _copyWithBuild( String Function( - Ref, + Ref, Supports$InClassName, ) build, ) { @@ -2480,7 +2449,7 @@ final class Supports$InClassNameProvider @override Supports$InClassNameProvider $copyWithBuild( String Function( - Ref, + Ref, Supports$InClassName, ) build, ) { @@ -2546,8 +2515,7 @@ final class Supports$InClassNameFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - String Function( - Ref ref, Supports$InClassName notifier) + String Function(Ref ref, Supports$InClassName notifier) build, ) { return $FamilyOverride( @@ -2612,7 +2580,7 @@ final class Supports$InClassFamilyNameProvider Supports$InClassFamilyNameProvider _copyWithBuild( String Function( - Ref, + Ref, Supports$InClassFamilyName, ) build, ) { @@ -2665,7 +2633,7 @@ final class Supports$InClassFamilyNameProvider @override Supports$InClassFamilyNameProvider $copyWithBuild( String Function( - Ref, + Ref, Supports$InClassFamilyName, ) build, ) { @@ -2759,7 +2727,7 @@ final class Supports$InClassFamilyNameFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( String Function( - Ref ref, + Ref ref, Supports$InClassFamilyName notifier, ( And$InT, { @@ -2811,16 +2779,14 @@ abstract class _$Supports$InClassFamilyName extends $Notifier { ); } -typedef GeneratedRef = Ref; - @ProviderFor(generated) const generatedProvider = GeneratedProvider._(); final class GeneratedProvider extends $FunctionalProvider - with $Provider { + with $Provider { const GeneratedProvider._( {String Function( - GeneratedRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -2834,7 +2800,7 @@ final class GeneratedProvider extends $FunctionalProvider ); final String Function( - GeneratedRef ref, + Ref ref, )? _createCb; @override @@ -2856,14 +2822,14 @@ final class GeneratedProvider extends $FunctionalProvider @override GeneratedProvider $copyWithCreate( String Function( - GeneratedRef ref, + Ref ref, ) create, ) { return GeneratedProvider._(create: create); } @override - String create(GeneratedRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? generated; return _$cb(ref); } @@ -2871,18 +2837,16 @@ final class GeneratedProvider extends $FunctionalProvider String _$generatedHash() => r'24bfb5df4dc529258ab568372e90a1cbfc2d8c24'; -typedef UnnecessaryCastRef = Ref; - @ProviderFor(unnecessaryCast) const unnecessaryCastProvider = UnnecessaryCastFamily._(); final class UnnecessaryCastProvider extends $FunctionalProvider - with $Provider { + with $Provider { const UnnecessaryCastProvider._( {required UnnecessaryCastFamily super.from, required Object? super.argument, String Function( - UnnecessaryCastRef ref, + Ref ref, Object? arg, )? create}) : _createCb = create, @@ -2895,7 +2859,7 @@ final class UnnecessaryCastProvider extends $FunctionalProvider ); final String Function( - UnnecessaryCastRef ref, + Ref ref, Object? arg, )? _createCb; @@ -2925,7 +2889,7 @@ final class UnnecessaryCastProvider extends $FunctionalProvider @override UnnecessaryCastProvider $copyWithCreate( String Function( - UnnecessaryCastRef ref, + Ref ref, ) create, ) { return UnnecessaryCastProvider._( @@ -2939,7 +2903,7 @@ final class UnnecessaryCastProvider extends $FunctionalProvider } @override - String create(UnnecessaryCastRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? unnecessaryCast; final argument = this.argument; return _$cb( @@ -2959,7 +2923,7 @@ final class UnnecessaryCastProvider extends $FunctionalProvider } } -String _$unnecessaryCastHash() => r'282c11ef4f55267c3e6ed70af1a260cd1c2163e6'; +String _$unnecessaryCastHash() => r'c64330124f4b03a3e6757e787f62966a32bf83ad'; final class UnnecessaryCastFamily extends Family { const UnnecessaryCastFamily._() @@ -2985,7 +2949,7 @@ final class UnnecessaryCastFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( String Function( - UnnecessaryCastRef ref, + Ref ref, Object? args, ) create, ) { @@ -3062,7 +3026,7 @@ final class UnnecessaryCastClassProvider @override UnnecessaryCastClassProvider $copyWithBuild( String Function( - Ref, + Ref, UnnecessaryCastClass, ) build, ) { @@ -3135,8 +3099,7 @@ final class UnnecessaryCastClassFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - String Function( - Ref ref, UnnecessaryCastClass notifier, Object? argument) + String Function(Ref ref, UnnecessaryCastClass notifier, Object? argument) build, ) { return $FamilyOverride( @@ -3168,22 +3131,17 @@ abstract class _$UnnecessaryCastClass extends $Notifier { ); } -typedef ManyDataStreamRef - = Ref>>; - @ProviderFor(manyDataStream) const manyDataStreamProvider = ManyDataStreamFamily._(); final class ManyDataStreamProvider extends $FunctionalProvider>, Stream>> - with - $FutureModifier>, - $StreamProvider, ManyDataStreamRef> { + with $FutureModifier>, $StreamProvider> { const ManyDataStreamProvider._( {required ManyDataStreamFamily super.from, required ManyProviderData super.argument, Stream> Function( - ManyDataStreamRef ref, + Ref ref, ManyProviderData pData, )? create}) : _createCb = create, @@ -3196,7 +3154,7 @@ final class ManyDataStreamProvider ); final Stream> Function( - ManyDataStreamRef ref, + Ref ref, ManyProviderData pData, )? _createCb; @@ -3205,7 +3163,7 @@ final class ManyDataStreamProvider ManyDataStreamProvider _copyWithCreate( Stream> Function( - ManyDataStreamRef ref, + Ref ref, ManyProviderData pData, ) create, ) { @@ -3230,7 +3188,7 @@ final class ManyDataStreamProvider @override ManyDataStreamProvider $copyWithCreate( Stream> Function( - ManyDataStreamRef ref, + Ref ref, ) create, ) { return ManyDataStreamProvider._( @@ -3244,7 +3202,7 @@ final class ManyDataStreamProvider } @override - Stream> create(ManyDataStreamRef ref) { + Stream> create(Ref ref) { final _$cb = _createCb ?? manyDataStream; final argument = this.argument as ManyProviderData; return _$cb( @@ -3266,7 +3224,7 @@ final class ManyDataStreamProvider } } -String _$manyDataStreamHash() => r'965270e9e187c17b8c78c03ded79136a4073ff04'; +String _$manyDataStreamHash() => r'5f389757cba176868a47b89b14b1f96afe20d728'; final class ManyDataStreamFamily extends Family { const ManyDataStreamFamily._() @@ -3292,7 +3250,7 @@ final class ManyDataStreamFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( Stream> Function( - ManyDataStreamRef ref, + Ref ref, ManyProviderData args, ) create, ) { diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart index 4dd2653f5..5eff2951a 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.g.dart @@ -6,20 +6,17 @@ part of 'sync.dart'; // RiverpodGenerator // ************************************************************************** -/// A public generated provider. -typedef PublicRef = Ref; - /// A public generated provider. @ProviderFor(public) const publicProvider = PublicProvider._(); /// A public generated provider. final class PublicProvider extends $FunctionalProvider - with $Provider { + with $Provider { /// A public generated provider. const PublicProvider._( {String Function( - PublicRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -33,7 +30,7 @@ final class PublicProvider extends $FunctionalProvider ); final String Function( - PublicRef ref, + Ref ref, )? _createCb; @override @@ -55,14 +52,14 @@ final class PublicProvider extends $FunctionalProvider @override PublicProvider $copyWithCreate( String Function( - PublicRef ref, + Ref ref, ) create, ) { return PublicProvider._(create: create); } @override - String create(PublicRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? public; return _$cb(ref); } @@ -70,20 +67,17 @@ final class PublicProvider extends $FunctionalProvider String _$publicHash() => r'94bee36125844f9fe521363bb228632b9f3bfbc7'; -/// A generated provider with a '$' in its name. -typedef Supports$inNamesRef = Ref; - /// A generated provider with a '$' in its name. @ProviderFor(supports$inNames) const supports$inNamesProvider = Supports$inNamesProvider._(); /// A generated provider with a '$' in its name. final class Supports$inNamesProvider extends $FunctionalProvider - with $Provider { + with $Provider { /// A generated provider with a '$' in its name. const Supports$inNamesProvider._( {String Function( - Supports$inNamesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -97,7 +91,7 @@ final class Supports$inNamesProvider extends $FunctionalProvider ); final String Function( - Supports$inNamesRef ref, + Ref ref, )? _createCb; @override @@ -119,14 +113,14 @@ final class Supports$inNamesProvider extends $FunctionalProvider @override Supports$inNamesProvider $copyWithCreate( String Function( - Supports$inNamesRef ref, + Ref ref, ) create, ) { return Supports$inNamesProvider._(create: create); } @override - String create(Supports$inNamesRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? supports$inNames; return _$cb(ref); } @@ -134,16 +128,13 @@ final class Supports$inNamesProvider extends $FunctionalProvider String _$supports$inNamesHash() => r'a883450ddca90a227631fe54d1d9ae305bc558d9'; -/// A generated family provider. -typedef FamilyRef = Ref; - /// A generated family provider. @ProviderFor(family) const familyProvider = FamilyFamily._(); /// A generated family provider. final class FamilyProvider extends $FunctionalProvider - with $Provider { + with $Provider { /// A generated family provider. const FamilyProvider._( {required FamilyFamily super.from, @@ -156,7 +147,7 @@ final class FamilyProvider extends $FunctionalProvider }) super.argument, String Function( - FamilyRef ref, + Ref ref, int first, { String? second, required double third, @@ -173,7 +164,7 @@ final class FamilyProvider extends $FunctionalProvider ); final String Function( - FamilyRef ref, + Ref ref, int first, { String? second, required double third, @@ -207,7 +198,7 @@ final class FamilyProvider extends $FunctionalProvider @override FamilyProvider $copyWithCreate( String Function( - FamilyRef ref, + Ref ref, ) create, ) { return FamilyProvider._( @@ -231,7 +222,7 @@ final class FamilyProvider extends $FunctionalProvider } @override - String create(FamilyRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? family; final argument = this.argument as ( int, { @@ -299,7 +290,7 @@ final class FamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( String Function( - FamilyRef ref, + Ref ref, ( int, { String? second, @@ -330,16 +321,14 @@ final class FamilyFamily extends Family { } } -typedef _PrivateRef = Ref; - @ProviderFor(_private) const _privateProvider = _PrivateProvider._(); final class _PrivateProvider extends $FunctionalProvider - with $Provider { + with $Provider { const _PrivateProvider._( {String Function( - _PrivateRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -353,7 +342,7 @@ final class _PrivateProvider extends $FunctionalProvider ); final String Function( - _PrivateRef ref, + Ref ref, )? _createCb; @override @@ -375,14 +364,14 @@ final class _PrivateProvider extends $FunctionalProvider @override _PrivateProvider $copyWithCreate( String Function( - _PrivateRef ref, + Ref ref, ) create, ) { return _PrivateProvider._(create: create); } @override - String create(_PrivateRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? _private; return _$cb(ref); } @@ -439,7 +428,7 @@ final class PublicClassProvider extends $NotifierProvider { @override PublicClassProvider $copyWithBuild( String Function( - Ref, + Ref, PublicClass, ) build, ) { @@ -509,7 +498,7 @@ final class _PrivateClassProvider @override _PrivateClassProvider $copyWithBuild( String Function( - Ref, + Ref, _PrivateClass, ) build, ) { @@ -605,7 +594,7 @@ final class FamilyClassProvider extends $NotifierProvider { @override FamilyClassProvider $copyWithBuild( String Function( - Ref, + Ref, FamilyClass, ) build, ) { @@ -708,7 +697,7 @@ final class FamilyClassFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( String Function( - Ref ref, + Ref ref, FamilyClass notifier, ( int, { @@ -822,7 +811,7 @@ final class Supports$InClassNameProvider @override Supports$InClassNameProvider $copyWithBuild( String Function( - Ref, + Ref, Supports$InClassName, ) build, ) { diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart index d2358f5d1..5c978d16b 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_class_based_provider_to_functional/convert_class_based_provider_to_functional.g.dart @@ -55,7 +55,7 @@ final class ExampleProvider extends $NotifierProvider { @override ExampleProvider $copyWithBuild( int Function( - Ref, + Ref, Example, ) build, ) { @@ -146,7 +146,7 @@ final class ExampleFamilyProvider @override ExampleFamilyProvider $copyWithBuild( int Function( - Ref, + Ref, ExampleFamily, ) build, ) { @@ -234,7 +234,7 @@ final class ExampleFamilyFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( int Function( - Ref ref, + Ref ref, ExampleFamily notifier, ({ int a, @@ -313,7 +313,7 @@ final class GenericProvider GenericProvider _copyWithBuild( int Function( - Ref, + Ref, Generic, ) build, ) { @@ -353,7 +353,7 @@ final class GenericProvider @override GenericProvider $copyWithBuild( int Function( - Ref, + Ref, Generic, ) build, ) { @@ -416,7 +416,7 @@ final class GenericFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - int Function(Ref ref, Generic notifier) build, + int Function(Ref ref, Generic notifier) build, ) { return $FamilyOverride( from: this, diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart index af6daf4c5..0190818a7 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.g.dart @@ -6,20 +6,17 @@ part of 'convert_functional_provider_to_class_based.dart'; // RiverpodGenerator // ************************************************************************** -/// Some comment -typedef ExampleRef = Ref; - /// Some comment @ProviderFor(example) const exampleProvider = ExampleProvider._(); /// Some comment final class ExampleProvider extends $FunctionalProvider - with $Provider { + with $Provider { /// Some comment const ExampleProvider._( {int Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -33,7 +30,7 @@ final class ExampleProvider extends $FunctionalProvider ); final int Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -55,14 +52,14 @@ final class ExampleProvider extends $FunctionalProvider @override ExampleProvider $copyWithCreate( int Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - int create(ExampleRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } @@ -70,16 +67,13 @@ final class ExampleProvider extends $FunctionalProvider String _$exampleHash() => r'67898608b444d39a000852f647ca6d3326740c98'; -/// Some comment -typedef ExampleFamilyRef = Ref; - /// Some comment @ProviderFor(exampleFamily) const exampleFamilyProvider = ExampleFamilyFamily._(); /// Some comment final class ExampleFamilyProvider extends $FunctionalProvider - with $Provider { + with $Provider { /// Some comment const ExampleFamilyProvider._( {required ExampleFamilyFamily super.from, @@ -89,7 +83,7 @@ final class ExampleFamilyProvider extends $FunctionalProvider }) super.argument, int Function( - ExampleFamilyRef ref, { + Ref ref, { required int a, String b, })? create}) @@ -103,7 +97,7 @@ final class ExampleFamilyProvider extends $FunctionalProvider ); final int Function( - ExampleFamilyRef ref, { + Ref ref, { required int a, String b, })? _createCb; @@ -134,7 +128,7 @@ final class ExampleFamilyProvider extends $FunctionalProvider @override ExampleFamilyProvider $copyWithCreate( int Function( - ExampleFamilyRef ref, + Ref ref, ) create, ) { return ExampleFamilyProvider._( @@ -152,7 +146,7 @@ final class ExampleFamilyProvider extends $FunctionalProvider } @override - int create(ExampleFamilyRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? exampleFamily; final argument = this.argument as ({ int a, @@ -208,7 +202,7 @@ final class ExampleFamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( int Function( - ExampleFamilyRef ref, + Ref ref, ({ int a, String b, diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart index b83819f2b..1254e1c65 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.g.dart @@ -6,13 +6,11 @@ part of 'avoid_build_context_in_providers.dart'; // RiverpodGenerator // ************************************************************************** -typedef FnRef = Ref; - @ProviderFor(fn) const fnProvider = FnFamily._(); final class FnProvider extends $FunctionalProvider - with $Provider { + with $Provider { const FnProvider._( {required FnFamily super.from, required ( @@ -21,7 +19,7 @@ final class FnProvider extends $FunctionalProvider }) super.argument, int Function( - FnRef ref, + Ref ref, BuildContext context1, { required BuildContext context2, })? create}) @@ -35,7 +33,7 @@ final class FnProvider extends $FunctionalProvider ); final int Function( - FnRef ref, + Ref ref, BuildContext context1, { required BuildContext context2, })? _createCb; @@ -66,7 +64,7 @@ final class FnProvider extends $FunctionalProvider @override FnProvider $copyWithCreate( int Function( - FnRef ref, + Ref ref, ) create, ) { return FnProvider._( @@ -84,7 +82,7 @@ final class FnProvider extends $FunctionalProvider } @override - int create(FnRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? fn; final argument = this.argument as ( BuildContext, { @@ -138,7 +136,7 @@ final class FnFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( int Function( - FnRef ref, + Ref ref, ( BuildContext, { BuildContext context2, @@ -227,7 +225,7 @@ final class MyNotifierProvider extends $NotifierProvider { @override MyNotifierProvider $copyWithBuild( int Function( - Ref, + Ref, MyNotifier, ) build, ) { @@ -313,7 +311,7 @@ final class MyNotifierFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( int Function( - Ref ref, + Ref ref, MyNotifier notifier, ( BuildContext, { @@ -407,7 +405,7 @@ final class Regression2959Provider @override Regression2959Provider $copyWithBuild( void Function( - Ref, + Ref, Regression2959, ) build, ) { diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart index f8498e21c..6de5b8755 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_public_notifier_properties.g.dart @@ -64,7 +64,7 @@ final class GeneratedNotifierProvider @override GeneratedNotifierProvider $copyWithBuild( int Function( - Ref, + Ref, GeneratedNotifier, ) build, ) { @@ -136,7 +136,7 @@ final class GeneratedNotifierFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - int Function(Ref ref, GeneratedNotifier notifier, int argument) build, + int Function(Ref ref, GeneratedNotifier notifier, int argument) build, ) { return $FamilyOverride( from: this, diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart index 57bc20ffe..16f8991e7 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/functional_ref.g.dart @@ -6,16 +6,14 @@ part of 'functional_ref.dart'; // RiverpodGenerator // ************************************************************************** -typedef NamelessRef = Ref; - @ProviderFor(nameless) const namelessProvider = NamelessProvider._(); final class NamelessProvider extends $FunctionalProvider - with $Provider { + with $Provider { const NamelessProvider._( {int Function( - NamelessRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class NamelessProvider extends $FunctionalProvider ); final int Function( - NamelessRef ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class NamelessProvider extends $FunctionalProvider @override NamelessProvider $copyWithCreate( int Function( - NamelessRef ref, + Ref ref, ) create, ) { return NamelessProvider._(create: create); } @override - int create(NamelessRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? nameless; return _$cb(ref); } @@ -66,18 +64,15 @@ final class NamelessProvider extends $FunctionalProvider String _$namelessHash() => r'1a2aa61445a64c65301051820b159c5998195606'; -typedef GenericsRef = Ref; - @ProviderFor(generics) const genericsProvider = GenericsFamily._(); final class GenericsProvider - extends $FunctionalProvider - with $Provider> { + extends $FunctionalProvider with $Provider { const GenericsProvider._( {required GenericsFamily super.from, int Function( - GenericsRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -90,7 +85,7 @@ final class GenericsProvider ); final int Function( - GenericsRef ref, + Ref ref, )? _createCb; @override @@ -98,7 +93,7 @@ final class GenericsProvider GenericsProvider _copyWithCreate( int Function( - GenericsRef ref, + Ref ref, ) create, ) { return GenericsProvider._( @@ -128,7 +123,7 @@ final class GenericsProvider @override GenericsProvider $copyWithCreate( int Function( - GenericsRef ref, + Ref ref, ) create, ) { return GenericsProvider._( @@ -136,7 +131,7 @@ final class GenericsProvider } @override - int create(GenericsRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? generics; return _$cb(ref); } @@ -177,7 +172,7 @@ final class GenericsFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( - int Function(GenericsRef ref) create, + int Function(Ref ref) create, ) { return $FamilyOverride( from: this, @@ -190,16 +185,14 @@ final class GenericsFamily extends Family { } } -typedef ValidRef = Ref; - @ProviderFor(valid) const validProvider = ValidProvider._(); final class ValidProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ValidProvider._( {int Function( - ValidRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -213,7 +206,7 @@ final class ValidProvider extends $FunctionalProvider ); final int Function( - ValidRef ref, + Ref ref, )? _createCb; @override @@ -235,14 +228,14 @@ final class ValidProvider extends $FunctionalProvider @override ValidProvider $copyWithCreate( int Function( - ValidRef ref, + Ref ref, ) create, ) { return ValidProvider._(create: create); } @override - int create(ValidRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? valid; return _$cb(ref); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart index edb112c21..cdc6ae99a 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/notifier_extends/notifier_extends.g.dart @@ -52,7 +52,7 @@ final class MyNotifierProvider extends $NotifierProvider { @override MyNotifierProvider $copyWithBuild( int Function( - Ref, + Ref, MyNotifier, ) build, ) { @@ -122,7 +122,7 @@ final class _PrivateClassProvider @override _PrivateClassProvider $copyWithBuild( String Function( - Ref, + Ref, _PrivateClass, ) build, ) { @@ -178,7 +178,7 @@ final class GenericsProvider GenericsProvider _copyWithBuild( int Function( - Ref, + Ref, Generics, ) build, ) { @@ -218,7 +218,7 @@ final class GenericsProvider @override GenericsProvider $copyWithBuild( int Function( - Ref, + Ref, Generics, ) build, ) { @@ -282,7 +282,7 @@ final class GenericsFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - int Function(Ref ref, Generics notifier) build, + int Function(Ref ref, Generics notifier) build, ) { return $FamilyOverride( from: this, @@ -335,7 +335,7 @@ final class NoGenericsProvider NoGenericsProvider _copyWithBuild( int Function( - Ref, + Ref, NoGenerics, ) build, ) { @@ -375,7 +375,7 @@ final class NoGenericsProvider @override NoGenericsProvider $copyWithBuild( int Function( - Ref, + Ref, NoGenerics, ) build, ) { @@ -439,8 +439,7 @@ final class NoGenericsFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - int Function(Ref ref, NoGenerics notifier) - build, + int Function(Ref ref, NoGenerics notifier) build, ) { return $FamilyOverride( from: this, @@ -493,7 +492,7 @@ final class MissingGenericsProvider MissingGenericsProvider _copyWithBuild( int Function( - Ref, + Ref, MissingGenerics, ) build, ) { @@ -535,7 +534,7 @@ final class MissingGenericsProvider @override MissingGenericsProvider $copyWithBuild( int Function( - Ref, + Ref, MissingGenerics, ) build, ) { @@ -599,7 +598,7 @@ final class MissingGenericsFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - int Function(Ref ref, MissingGenerics notifier) build, + int Function(Ref ref, MissingGenerics notifier) build, ) { return $FamilyOverride( from: this, @@ -652,7 +651,7 @@ final class WrongOrderProvider WrongOrderProvider _copyWithBuild( int Function( - Ref, + Ref, WrongOrder, ) build, ) { @@ -692,7 +691,7 @@ final class WrongOrderProvider @override WrongOrderProvider $copyWithBuild( int Function( - Ref, + Ref, WrongOrder, ) build, ) { @@ -756,7 +755,7 @@ final class WrongOrderFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - int Function(Ref ref, WrongOrder notifier) build, + int Function(Ref ref, WrongOrder notifier) build, ) { return $FamilyOverride( from: this, diff --git a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart index e05d9ef45..dea54858d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/only_use_keep_alive_inside_keep_alive.g.dart @@ -6,16 +6,14 @@ part of 'only_use_keep_alive_inside_keep_alive.dart'; // RiverpodGenerator // ************************************************************************** -typedef KeepAliveRef = Ref; - @ProviderFor(keepAlive) const keepAliveProvider = KeepAliveProvider._(); final class KeepAliveProvider extends $FunctionalProvider - with $Provider { + with $Provider { const KeepAliveProvider._( {int Function( - KeepAliveRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class KeepAliveProvider extends $FunctionalProvider ); final int Function( - KeepAliveRef ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class KeepAliveProvider extends $FunctionalProvider @override KeepAliveProvider $copyWithCreate( int Function( - KeepAliveRef ref, + Ref ref, ) create, ) { return KeepAliveProvider._(create: create); } @override - int create(KeepAliveRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? keepAlive; return _$cb(ref); } @@ -113,7 +111,7 @@ final class KeepAliveClassProvider @override KeepAliveClassProvider $copyWithBuild( int Function( - Ref, + Ref, KeepAliveClass, ) build, ) { @@ -136,16 +134,14 @@ abstract class _$KeepAliveClass extends $Notifier { int runBuild() => build(); } -typedef AutoDisposeRef = Ref; - @ProviderFor(autoDispose) const autoDisposeProvider = AutoDisposeProvider._(); final class AutoDisposeProvider extends $FunctionalProvider - with $Provider { + with $Provider { const AutoDisposeProvider._( {int Function( - AutoDisposeRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -159,7 +155,7 @@ final class AutoDisposeProvider extends $FunctionalProvider ); final int Function( - AutoDisposeRef ref, + Ref ref, )? _createCb; @override @@ -181,14 +177,14 @@ final class AutoDisposeProvider extends $FunctionalProvider @override AutoDisposeProvider $copyWithCreate( int Function( - AutoDisposeRef ref, + Ref ref, ) create, ) { return AutoDisposeProvider._(create: create); } @override - int create(AutoDisposeRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? autoDispose; return _$cb(ref); } @@ -243,7 +239,7 @@ final class AutoDisposeClassProvider @override AutoDisposeClassProvider $copyWithBuild( int Function( - Ref, + Ref, AutoDisposeClass, ) build, ) { @@ -266,16 +262,14 @@ abstract class _$AutoDisposeClass extends $Notifier { int runBuild() => build(); } -typedef FnRef = Ref; - @ProviderFor(fn) const fnProvider = FnProvider._(); final class FnProvider extends $FunctionalProvider - with $Provider { + with $Provider { const FnProvider._( {int Function( - FnRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -289,7 +283,7 @@ final class FnProvider extends $FunctionalProvider ); final int Function( - FnRef ref, + Ref ref, )? _createCb; @override @@ -311,14 +305,14 @@ final class FnProvider extends $FunctionalProvider @override FnProvider $copyWithCreate( int Function( - FnRef ref, + Ref ref, ) create, ) { return FnProvider._(create: create); } @override - int create(FnRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? fn; return _$cb(ref); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart index 2cfaaee48..ca5340382 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/protected_notifier_properties.g.dart @@ -51,7 +51,7 @@ final class AProvider extends $NotifierProvider { @override AProvider $copyWithBuild( int Function( - Ref, + Ref, A, ) build, ) { @@ -118,7 +118,7 @@ final class A2Provider extends $NotifierProvider { @override A2Provider $copyWithBuild( int Function( - Ref, + Ref, A2, ) build, ) { @@ -195,7 +195,7 @@ final class A3Provider extends $NotifierProvider { @override A3Provider $copyWithBuild( int Function( - Ref, + Ref, A3, ) build, ) { @@ -266,7 +266,7 @@ final class A3Family extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - int Function(Ref ref, A3 notifier, int argument) build, + int Function(Ref ref, A3 notifier, int argument) build, ) { return $FamilyOverride( from: this, @@ -352,7 +352,7 @@ final class A4Provider extends $NotifierProvider { @override A4Provider $copyWithBuild( int Function( - Ref, + Ref, A4, ) build, ) { @@ -423,7 +423,7 @@ final class A4Family extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - int Function(Ref ref, A4 notifier, int argument) build, + int Function(Ref ref, A4 notifier, int argument) build, ) { return $FamilyOverride( from: this, @@ -501,7 +501,7 @@ final class A5Provider extends $AsyncNotifierProvider { @override A5Provider $copyWithBuild( FutureOr Function( - Ref>, + Ref, A5, ) build, ) { @@ -573,8 +573,7 @@ final class A5Family extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - FutureOr Function(Ref> ref, A5 notifier, int argument) - build, + FutureOr Function(Ref ref, A5 notifier, int argument) build, ) { return $FamilyOverride( from: this, @@ -652,7 +651,7 @@ final class A6Provider extends $AsyncNotifierProvider { @override A6Provider $copyWithBuild( FutureOr Function( - Ref>, + Ref, A6, ) build, ) { @@ -724,8 +723,7 @@ final class A6Family extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - FutureOr Function(Ref> ref, A6 notifier, int argument) - build, + FutureOr Function(Ref ref, A6 notifier, int argument) build, ) { return $FamilyOverride( from: this, @@ -803,7 +801,7 @@ final class A7Provider extends $StreamNotifierProvider { @override A7Provider $copyWithBuild( Stream Function( - Ref>, + Ref, A7, ) build, ) { @@ -875,8 +873,7 @@ final class A7Family extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - Stream Function(Ref> ref, A7 notifier, int argument) - build, + Stream Function(Ref ref, A7 notifier, int argument) build, ) { return $FamilyOverride( from: this, @@ -954,7 +951,7 @@ final class A8Provider extends $StreamNotifierProvider { @override A8Provider $copyWithBuild( Stream Function( - Ref>, + Ref, A8, ) build, ) { @@ -1026,8 +1023,7 @@ final class A8Family extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - Stream Function(Ref> ref, A8 notifier, int argument) - build, + Stream Function(Ref ref, A8 notifier, int argument) build, ) { return $FamilyOverride( from: this, @@ -1103,7 +1099,7 @@ final class BProvider extends $NotifierProvider { @override BProvider $copyWithBuild( int Function( - Ref, + Ref, B, ) build, ) { @@ -1170,7 +1166,7 @@ final class B2Provider extends $NotifierProvider { @override B2Provider $copyWithBuild( int Function( - Ref, + Ref, B2, ) build, ) { diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart index 2471842c1..acb68d2ab 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/another.g.dart @@ -6,16 +6,14 @@ part of 'another.dart'; // RiverpodGenerator // ************************************************************************** -typedef BRef = Ref; - @ProviderFor(b) const bProvider = BProvider._(); final class BProvider extends $FunctionalProvider - with $Provider { + with $Provider { const BProvider._( {int Function( - BRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class BProvider extends $FunctionalProvider ); final int Function( - BRef ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class BProvider extends $FunctionalProvider @override BProvider $copyWithCreate( int Function( - BRef ref, + Ref ref, ) create, ) { return BProvider._(create: create); } @override - int create(BRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? b; return _$cb(ref); } @@ -66,16 +64,14 @@ final class BProvider extends $FunctionalProvider String _$bHash() => r'31624e9aa10c9cd7941c9626e841c6df3468723b'; -typedef AnotherScopedRef = Ref; - @ProviderFor(anotherScoped) const anotherScopedProvider = AnotherScopedProvider._(); final class AnotherScopedProvider extends $FunctionalProvider - with $Provider { + with $Provider { const AnotherScopedProvider._( {int Function( - AnotherScopedRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -89,7 +85,7 @@ final class AnotherScopedProvider extends $FunctionalProvider ); final int Function( - AnotherScopedRef ref, + Ref ref, )? _createCb; @override @@ -111,14 +107,14 @@ final class AnotherScopedProvider extends $FunctionalProvider @override AnotherScopedProvider $copyWithCreate( int Function( - AnotherScopedRef ref, + Ref ref, ) create, ) { return AnotherScopedProvider._(create: create); } @override - int create(AnotherScopedRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? anotherScoped; return _$cb(ref); } @@ -126,16 +122,14 @@ final class AnotherScopedProvider extends $FunctionalProvider String _$anotherScopedHash() => r'edf3ccffb7c3ce1b1e4ffdd4009aeed4fa38c3f8'; -typedef AnotherNonEmptyScopedRef = Ref; - @ProviderFor(anotherNonEmptyScoped) const anotherNonEmptyScopedProvider = AnotherNonEmptyScopedProvider._(); final class AnotherNonEmptyScopedProvider extends $FunctionalProvider - with $Provider { + with $Provider { const AnotherNonEmptyScopedProvider._( {int Function( - AnotherNonEmptyScopedRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -153,7 +147,7 @@ final class AnotherNonEmptyScopedProvider extends $FunctionalProvider static const $allTransitiveDependencies0 = anotherScopedProvider; final int Function( - AnotherNonEmptyScopedRef ref, + Ref ref, )? _createCb; @override @@ -175,14 +169,14 @@ final class AnotherNonEmptyScopedProvider extends $FunctionalProvider @override AnotherNonEmptyScopedProvider $copyWithCreate( int Function( - AnotherNonEmptyScopedRef ref, + Ref ref, ) create, ) { return AnotherNonEmptyScopedProvider._(create: create); } @override - int create(AnotherNonEmptyScopedRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? anotherNonEmptyScoped; return _$cb(ref); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart index 55ed1029b..06a7b3727 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies.g.dart @@ -6,16 +6,14 @@ part of 'missing_dependencies.dart'; // RiverpodGenerator // ************************************************************************** -typedef DepRef = Ref; - @ProviderFor(dep) const depProvider = DepProvider._(); final class DepProvider extends $FunctionalProvider - with $Provider { + with $Provider { const DepProvider._( {int Function( - DepRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class DepProvider extends $FunctionalProvider ); final int Function( - DepRef ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class DepProvider extends $FunctionalProvider @override DepProvider $copyWithCreate( int Function( - DepRef ref, + Ref ref, ) create, ) { return DepProvider._(create: create); } @override - int create(DepRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? dep; return _$cb(ref); } @@ -66,16 +64,14 @@ final class DepProvider extends $FunctionalProvider String _$depHash() => r'578a350a40cda46444ecd9fa3ea2fd7bd0994692'; -typedef TransitiveDepRef = Ref; - @ProviderFor(transitiveDep) const transitiveDepProvider = TransitiveDepProvider._(); final class TransitiveDepProvider extends $FunctionalProvider - with $Provider { + with $Provider { const TransitiveDepProvider._( {int Function( - TransitiveDepRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -93,7 +89,7 @@ final class TransitiveDepProvider extends $FunctionalProvider static const $allTransitiveDependencies0 = depProvider; final int Function( - TransitiveDepRef ref, + Ref ref, )? _createCb; @override @@ -115,14 +111,14 @@ final class TransitiveDepProvider extends $FunctionalProvider @override TransitiveDepProvider $copyWithCreate( int Function( - TransitiveDepRef ref, + Ref ref, ) create, ) { return TransitiveDepProvider._(create: create); } @override - int create(TransitiveDepRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? transitiveDep; return _$cb(ref); } @@ -130,16 +126,14 @@ final class TransitiveDepProvider extends $FunctionalProvider String _$transitiveDepHash() => r'cedc000b7d16447684dff970ddea659cca24cdf6'; -typedef Dep2Ref = Ref; - @ProviderFor(dep2) const dep2Provider = Dep2Provider._(); final class Dep2Provider extends $FunctionalProvider - with $Provider { + with $Provider { const Dep2Provider._( {int Function( - Dep2Ref ref, + Ref ref, )? create}) : _createCb = create, super( @@ -153,7 +147,7 @@ final class Dep2Provider extends $FunctionalProvider ); final int Function( - Dep2Ref ref, + Ref ref, )? _createCb; @override @@ -175,14 +169,14 @@ final class Dep2Provider extends $FunctionalProvider @override Dep2Provider $copyWithCreate( int Function( - Dep2Ref ref, + Ref ref, ) create, ) { return Dep2Provider._(create: create); } @override - int create(Dep2Ref ref) { + int create(Ref ref) { final _$cb = _createCb ?? dep2; return _$cb(ref); } @@ -190,18 +184,16 @@ final class Dep2Provider extends $FunctionalProvider String _$dep2Hash() => r'97901e825cdcf5b1ac455b0fe8a2111662ce9f13'; -typedef DepFamilyRef = Ref; - @ProviderFor(depFamily) const depFamilyProvider = DepFamilyFamily._(); final class DepFamilyProvider extends $FunctionalProvider - with $Provider { + with $Provider { const DepFamilyProvider._( {required DepFamilyFamily super.from, required int super.argument, int Function( - DepFamilyRef ref, + Ref ref, int id, )? create}) : _createCb = create, @@ -214,7 +206,7 @@ final class DepFamilyProvider extends $FunctionalProvider ); final int Function( - DepFamilyRef ref, + Ref ref, int id, )? _createCb; @@ -244,7 +236,7 @@ final class DepFamilyProvider extends $FunctionalProvider @override DepFamilyProvider $copyWithCreate( int Function( - DepFamilyRef ref, + Ref ref, ) create, ) { return DepFamilyProvider._( @@ -258,7 +250,7 @@ final class DepFamilyProvider extends $FunctionalProvider } @override - int create(DepFamilyRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? depFamily; final argument = this.argument as int; return _$cb( @@ -304,7 +296,7 @@ final class DepFamilyFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( int Function( - DepFamilyRef ref, + Ref ref, int args, ) create, ) { @@ -323,10 +315,6 @@ final class DepFamilyFamily extends Family { } } -//////////// -// expect_lint: provider_dependencies -typedef PlainAnnotationRef = Ref; - //////////// // expect_lint: provider_dependencies @ProviderFor(plainAnnotation) @@ -335,12 +323,12 @@ const plainAnnotationProvider = PlainAnnotationProvider._(); //////////// // expect_lint: provider_dependencies final class PlainAnnotationProvider extends $FunctionalProvider - with $Provider { + with $Provider { //////////// // expect_lint: provider_dependencies const PlainAnnotationProvider._( {int Function( - PlainAnnotationRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -354,7 +342,7 @@ final class PlainAnnotationProvider extends $FunctionalProvider ); final int Function( - PlainAnnotationRef ref, + Ref ref, )? _createCb; @override @@ -376,14 +364,14 @@ final class PlainAnnotationProvider extends $FunctionalProvider @override PlainAnnotationProvider $copyWithCreate( int Function( - PlainAnnotationRef ref, + Ref ref, ) create, ) { return PlainAnnotationProvider._(create: create); } @override - int create(PlainAnnotationRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? plainAnnotation; return _$cb(ref); } @@ -391,16 +379,14 @@ final class PlainAnnotationProvider extends $FunctionalProvider String _$plainAnnotationHash() => r'6a3d1f1f2e53902af56cd7ce6ceba17358690b70'; -typedef CustomAnnotationRef = Ref; - @ProviderFor(customAnnotation) const customAnnotationProvider = CustomAnnotationProvider._(); final class CustomAnnotationProvider extends $FunctionalProvider - with $Provider { + with $Provider { const CustomAnnotationProvider._( {int Function( - CustomAnnotationRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -414,7 +400,7 @@ final class CustomAnnotationProvider extends $FunctionalProvider ); final int Function( - CustomAnnotationRef ref, + Ref ref, )? _createCb; @override @@ -436,14 +422,14 @@ final class CustomAnnotationProvider extends $FunctionalProvider @override CustomAnnotationProvider $copyWithCreate( int Function( - CustomAnnotationRef ref, + Ref ref, ) create, ) { return CustomAnnotationProvider._(create: create); } @override - int create(CustomAnnotationRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? customAnnotation; return _$cb(ref); } @@ -451,18 +437,15 @@ final class CustomAnnotationProvider extends $FunctionalProvider String _$customAnnotationHash() => r'8081bbad2cfbe5bff1ace9aa3be450dd28112488'; -typedef CustomAnnotationWithTrailingCommaRef = Ref; - @ProviderFor(customAnnotationWithTrailingComma) const customAnnotationWithTrailingCommaProvider = CustomAnnotationWithTrailingCommaProvider._(); final class CustomAnnotationWithTrailingCommaProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const CustomAnnotationWithTrailingCommaProvider._( {int Function( - CustomAnnotationWithTrailingCommaRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -476,7 +459,7 @@ final class CustomAnnotationWithTrailingCommaProvider ); final int Function( - CustomAnnotationWithTrailingCommaRef ref, + Ref ref, )? _createCb; @override @@ -499,14 +482,14 @@ final class CustomAnnotationWithTrailingCommaProvider @override CustomAnnotationWithTrailingCommaProvider $copyWithCreate( int Function( - CustomAnnotationWithTrailingCommaRef ref, + Ref ref, ) create, ) { return CustomAnnotationWithTrailingCommaProvider._(create: create); } @override - int create(CustomAnnotationWithTrailingCommaRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? customAnnotationWithTrailingComma; return _$cb(ref); } @@ -515,16 +498,14 @@ final class CustomAnnotationWithTrailingCommaProvider String _$customAnnotationWithTrailingCommaHash() => r'709613050eb1db7b4c43cb87855e2c32988141d8'; -typedef ExistingDepRef = Ref; - @ProviderFor(existingDep) const existingDepProvider = ExistingDepProvider._(); final class ExistingDepProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ExistingDepProvider._( {int Function( - ExistingDepRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -538,7 +519,7 @@ final class ExistingDepProvider extends $FunctionalProvider ); final int Function( - ExistingDepRef ref, + Ref ref, )? _createCb; @override @@ -560,14 +541,14 @@ final class ExistingDepProvider extends $FunctionalProvider @override ExistingDepProvider $copyWithCreate( int Function( - ExistingDepRef ref, + Ref ref, ) create, ) { return ExistingDepProvider._(create: create); } @override - int create(ExistingDepRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? existingDep; return _$cb(ref); } @@ -575,16 +556,14 @@ final class ExistingDepProvider extends $FunctionalProvider String _$existingDepHash() => r'73e7e1a0d4c2ae07ed03fb248408c3d82fe85554'; -typedef MultipleDepsRef = Ref; - @ProviderFor(multipleDeps) const multipleDepsProvider = MultipleDepsProvider._(); final class MultipleDepsProvider extends $FunctionalProvider - with $Provider { + with $Provider { const MultipleDepsProvider._( {int Function( - MultipleDepsRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -598,7 +577,7 @@ final class MultipleDepsProvider extends $FunctionalProvider ); final int Function( - MultipleDepsRef ref, + Ref ref, )? _createCb; @override @@ -620,14 +599,14 @@ final class MultipleDepsProvider extends $FunctionalProvider @override MultipleDepsProvider $copyWithCreate( int Function( - MultipleDepsRef ref, + Ref ref, ) create, ) { return MultipleDepsProvider._(create: create); } @override - int create(MultipleDepsRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? multipleDeps; return _$cb(ref); } @@ -635,10 +614,6 @@ final class MultipleDepsProvider extends $FunctionalProvider String _$multipleDepsHash() => r'66de70567c011a294a2c46703dfab8ba7247fd5e'; -/// Random doc to test that identifiers in docs don't trigger the lint. -/// [dep], [DepWidget], [depProvider] -typedef ProviderWithDartDocRef = Ref; - /// Random doc to test that identifiers in docs don't trigger the lint. /// [dep], [DepWidget], [depProvider] @ProviderFor(providerWithDartDoc) @@ -647,12 +622,12 @@ const providerWithDartDocProvider = ProviderWithDartDocProvider._(); /// Random doc to test that identifiers in docs don't trigger the lint. /// [dep], [DepWidget], [depProvider] final class ProviderWithDartDocProvider extends $FunctionalProvider - with $Provider { + with $Provider { /// Random doc to test that identifiers in docs don't trigger the lint. /// [dep], [DepWidget], [depProvider] const ProviderWithDartDocProvider._( {int Function( - ProviderWithDartDocRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -666,7 +641,7 @@ final class ProviderWithDartDocProvider extends $FunctionalProvider ); final int Function( - ProviderWithDartDocRef ref, + Ref ref, )? _createCb; @override @@ -688,14 +663,14 @@ final class ProviderWithDartDocProvider extends $FunctionalProvider @override ProviderWithDartDocProvider $copyWithCreate( int Function( - ProviderWithDartDocRef ref, + Ref ref, ) create, ) { return ProviderWithDartDocProvider._(create: create); } @override - int create(ProviderWithDartDocRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? providerWithDartDoc; return _$cb(ref); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart index ce0674122..9f0fb55b1 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.g.dart @@ -6,16 +6,14 @@ part of 'missing_dependencies2.dart'; // RiverpodGenerator // ************************************************************************** -typedef DepRef = Ref; - @ProviderFor(dep) const depProvider = DepProvider._(); final class DepProvider extends $FunctionalProvider - with $Provider { + with $Provider { const DepProvider._( {int Function( - DepRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class DepProvider extends $FunctionalProvider ); final int Function( - DepRef ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class DepProvider extends $FunctionalProvider @override DepProvider $copyWithCreate( int Function( - DepRef ref, + Ref ref, ) create, ) { return DepProvider._(create: create); } @override - int create(DepRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? dep; return _$cb(ref); } @@ -66,16 +64,14 @@ final class DepProvider extends $FunctionalProvider String _$depHash() => r'578a350a40cda46444ecd9fa3ea2fd7bd0994692'; -typedef GeneratedScopedRef = Ref; - @ProviderFor(generatedScoped) const generatedScopedProvider = GeneratedScopedProvider._(); final class GeneratedScopedProvider extends $FunctionalProvider - with $Provider { + with $Provider { const GeneratedScopedProvider._( {int Function( - GeneratedScopedRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -89,7 +85,7 @@ final class GeneratedScopedProvider extends $FunctionalProvider ); final int Function( - GeneratedScopedRef ref, + Ref ref, )? _createCb; @override @@ -111,14 +107,14 @@ final class GeneratedScopedProvider extends $FunctionalProvider @override GeneratedScopedProvider $copyWithCreate( int Function( - GeneratedScopedRef ref, + Ref ref, ) create, ) { return GeneratedScopedProvider._(create: create); } @override - int create(GeneratedScopedRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? generatedScoped; return _$cb(ref); } @@ -126,16 +122,14 @@ final class GeneratedScopedProvider extends $FunctionalProvider String _$generatedScopedHash() => r'f8e5b6926ce13765c83dbb7f8c8458c9c5fe7d69'; -typedef GeneratedRootRef = Ref; - @ProviderFor(generatedRoot) const generatedRootProvider = GeneratedRootProvider._(); final class GeneratedRootProvider extends $FunctionalProvider - with $Provider { + with $Provider { const GeneratedRootProvider._( {int Function( - GeneratedRootRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -149,7 +143,7 @@ final class GeneratedRootProvider extends $FunctionalProvider ); final int Function( - GeneratedRootRef ref, + Ref ref, )? _createCb; @override @@ -171,14 +165,14 @@ final class GeneratedRootProvider extends $FunctionalProvider @override GeneratedRootProvider $copyWithCreate( int Function( - GeneratedRootRef ref, + Ref ref, ) create, ) { return GeneratedRootProvider._(create: create); } @override - int create(GeneratedRootRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? generatedRoot; return _$cb(ref); } @@ -186,18 +180,15 @@ final class GeneratedRootProvider extends $FunctionalProvider String _$generatedRootHash() => r'179253a56503f28bb616c602d8af9ad3b23d438f'; -typedef WatchScopedButNoDependenciesRef = Ref; - @ProviderFor(watchScopedButNoDependencies) const watchScopedButNoDependenciesProvider = WatchScopedButNoDependenciesProvider._(); final class WatchScopedButNoDependenciesProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const WatchScopedButNoDependenciesProvider._( {int Function( - WatchScopedButNoDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -211,7 +202,7 @@ final class WatchScopedButNoDependenciesProvider ); final int Function( - WatchScopedButNoDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -233,14 +224,14 @@ final class WatchScopedButNoDependenciesProvider @override WatchScopedButNoDependenciesProvider $copyWithCreate( int Function( - WatchScopedButNoDependenciesRef ref, + Ref ref, ) create, ) { return WatchScopedButNoDependenciesProvider._(create: create); } @override - int create(WatchScopedButNoDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? watchScopedButNoDependencies; return _$cb(ref); } @@ -249,18 +240,15 @@ final class WatchScopedButNoDependenciesProvider String _$watchScopedButNoDependenciesHash() => r'e326226fdc19ea7a4430900154c071f5a1a98e40'; -typedef WatchGeneratedScopedButNoDependenciesRef = Ref; - @ProviderFor(watchGeneratedScopedButNoDependencies) const watchGeneratedScopedButNoDependenciesProvider = WatchGeneratedScopedButNoDependenciesProvider._(); final class WatchGeneratedScopedButNoDependenciesProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const WatchGeneratedScopedButNoDependenciesProvider._( {int Function( - WatchGeneratedScopedButNoDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -274,7 +262,7 @@ final class WatchGeneratedScopedButNoDependenciesProvider ); final int Function( - WatchGeneratedScopedButNoDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -297,14 +285,14 @@ final class WatchGeneratedScopedButNoDependenciesProvider @override WatchGeneratedScopedButNoDependenciesProvider $copyWithCreate( int Function( - WatchGeneratedScopedButNoDependenciesRef ref, + Ref ref, ) create, ) { return WatchGeneratedScopedButNoDependenciesProvider._(create: create); } @override - int create(WatchGeneratedScopedButNoDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? watchGeneratedScopedButNoDependencies; return _$cb(ref); } @@ -313,18 +301,15 @@ final class WatchGeneratedScopedButNoDependenciesProvider String _$watchGeneratedScopedButNoDependenciesHash() => r'2109f8ccbc13632e45f18ccb93bc3059c431eba1'; -typedef WatchRootButNoDependenciesRef = Ref; - @ProviderFor(watchRootButNoDependencies) const watchRootButNoDependenciesProvider = WatchRootButNoDependenciesProvider._(); final class WatchRootButNoDependenciesProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const WatchRootButNoDependenciesProvider._( {int Function( - WatchRootButNoDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -338,7 +323,7 @@ final class WatchRootButNoDependenciesProvider ); final int Function( - WatchRootButNoDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -360,14 +345,14 @@ final class WatchRootButNoDependenciesProvider @override WatchRootButNoDependenciesProvider $copyWithCreate( int Function( - WatchRootButNoDependenciesRef ref, + Ref ref, ) create, ) { return WatchRootButNoDependenciesProvider._(create: create); } @override - int create(WatchRootButNoDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? watchRootButNoDependencies; return _$cb(ref); } @@ -376,18 +361,15 @@ final class WatchRootButNoDependenciesProvider String _$watchRootButNoDependenciesHash() => r'cfecc8aeb539e82c46276f9e4dd78c323b4bef12'; -typedef WatchGeneratedRootButNoDependenciesRef = Ref; - @ProviderFor(watchGeneratedRootButNoDependencies) const watchGeneratedRootButNoDependenciesProvider = WatchGeneratedRootButNoDependenciesProvider._(); final class WatchGeneratedRootButNoDependenciesProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const WatchGeneratedRootButNoDependenciesProvider._( {int Function( - WatchGeneratedRootButNoDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -401,7 +383,7 @@ final class WatchGeneratedRootButNoDependenciesProvider ); final int Function( - WatchGeneratedRootButNoDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -424,14 +406,14 @@ final class WatchGeneratedRootButNoDependenciesProvider @override WatchGeneratedRootButNoDependenciesProvider $copyWithCreate( int Function( - WatchGeneratedRootButNoDependenciesRef ref, + Ref ref, ) create, ) { return WatchGeneratedRootButNoDependenciesProvider._(create: create); } @override - int create(WatchGeneratedRootButNoDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? watchGeneratedRootButNoDependencies; return _$cb(ref); } @@ -440,18 +422,15 @@ final class WatchGeneratedRootButNoDependenciesProvider String _$watchGeneratedRootButNoDependenciesHash() => r'c839dab901f606c11c78f9c8761931027d3db1d1'; -typedef WatchScopedButEmptyDependenciesRef = Ref; - @ProviderFor(watchScopedButEmptyDependencies) const watchScopedButEmptyDependenciesProvider = WatchScopedButEmptyDependenciesProvider._(); final class WatchScopedButEmptyDependenciesProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const WatchScopedButEmptyDependenciesProvider._( {int Function( - WatchScopedButEmptyDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -465,7 +444,7 @@ final class WatchScopedButEmptyDependenciesProvider ); final int Function( - WatchScopedButEmptyDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -487,14 +466,14 @@ final class WatchScopedButEmptyDependenciesProvider @override WatchScopedButEmptyDependenciesProvider $copyWithCreate( int Function( - WatchScopedButEmptyDependenciesRef ref, + Ref ref, ) create, ) { return WatchScopedButEmptyDependenciesProvider._(create: create); } @override - int create(WatchScopedButEmptyDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? watchScopedButEmptyDependencies; return _$cb(ref); } @@ -503,18 +482,15 @@ final class WatchScopedButEmptyDependenciesProvider String _$watchScopedButEmptyDependenciesHash() => r'a194f52730f635e9c92b3467b33b8c302c93b1ab'; -typedef WatchGeneratedScopedButEmptyDependenciesRef = Ref; - @ProviderFor(watchGeneratedScopedButEmptyDependencies) const watchGeneratedScopedButEmptyDependenciesProvider = WatchGeneratedScopedButEmptyDependenciesProvider._(); final class WatchGeneratedScopedButEmptyDependenciesProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const WatchGeneratedScopedButEmptyDependenciesProvider._( {int Function( - WatchGeneratedScopedButEmptyDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -528,7 +504,7 @@ final class WatchGeneratedScopedButEmptyDependenciesProvider ); final int Function( - WatchGeneratedScopedButEmptyDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -551,14 +527,14 @@ final class WatchGeneratedScopedButEmptyDependenciesProvider @override WatchGeneratedScopedButEmptyDependenciesProvider $copyWithCreate( int Function( - WatchGeneratedScopedButEmptyDependenciesRef ref, + Ref ref, ) create, ) { return WatchGeneratedScopedButEmptyDependenciesProvider._(create: create); } @override - int create(WatchGeneratedScopedButEmptyDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? watchGeneratedScopedButEmptyDependencies; return _$cb(ref); } @@ -567,18 +543,15 @@ final class WatchGeneratedScopedButEmptyDependenciesProvider String _$watchGeneratedScopedButEmptyDependenciesHash() => r'fa4cb564341e7b3f0dd10f70e17381c67859c643'; -typedef WatchRootButEmptyDependenciesRef = Ref; - @ProviderFor(watchRootButEmptyDependencies) const watchRootButEmptyDependenciesProvider = WatchRootButEmptyDependenciesProvider._(); final class WatchRootButEmptyDependenciesProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const WatchRootButEmptyDependenciesProvider._( {int Function( - WatchRootButEmptyDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -592,7 +565,7 @@ final class WatchRootButEmptyDependenciesProvider ); final int Function( - WatchRootButEmptyDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -614,14 +587,14 @@ final class WatchRootButEmptyDependenciesProvider @override WatchRootButEmptyDependenciesProvider $copyWithCreate( int Function( - WatchRootButEmptyDependenciesRef ref, + Ref ref, ) create, ) { return WatchRootButEmptyDependenciesProvider._(create: create); } @override - int create(WatchRootButEmptyDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? watchRootButEmptyDependencies; return _$cb(ref); } @@ -630,18 +603,15 @@ final class WatchRootButEmptyDependenciesProvider String _$watchRootButEmptyDependenciesHash() => r'8669a421efcd8caadc0d070f0c88043668610bbb'; -typedef WatchGeneratedRootButEmptyDependenciesRef = Ref; - @ProviderFor(watchGeneratedRootButEmptyDependencies) const watchGeneratedRootButEmptyDependenciesProvider = WatchGeneratedRootButEmptyDependenciesProvider._(); final class WatchGeneratedRootButEmptyDependenciesProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const WatchGeneratedRootButEmptyDependenciesProvider._( {int Function( - WatchGeneratedRootButEmptyDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -655,7 +625,7 @@ final class WatchGeneratedRootButEmptyDependenciesProvider ); final int Function( - WatchGeneratedRootButEmptyDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -678,14 +648,14 @@ final class WatchGeneratedRootButEmptyDependenciesProvider @override WatchGeneratedRootButEmptyDependenciesProvider $copyWithCreate( int Function( - WatchGeneratedRootButEmptyDependenciesRef ref, + Ref ref, ) create, ) { return WatchGeneratedRootButEmptyDependenciesProvider._(create: create); } @override - int create(WatchGeneratedRootButEmptyDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? watchGeneratedRootButEmptyDependencies; return _$cb(ref); } @@ -694,18 +664,15 @@ final class WatchGeneratedRootButEmptyDependenciesProvider String _$watchGeneratedRootButEmptyDependenciesHash() => r'80581ac491e25ae8c6ee7b7f25dff9939f8de37c'; -typedef WatchScopedButMissingDependenciesRef = Ref; - @ProviderFor(watchScopedButMissingDependencies) const watchScopedButMissingDependenciesProvider = WatchScopedButMissingDependenciesProvider._(); final class WatchScopedButMissingDependenciesProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const WatchScopedButMissingDependenciesProvider._( {int Function( - WatchScopedButMissingDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -724,7 +691,7 @@ final class WatchScopedButMissingDependenciesProvider static const $allTransitiveDependencies0 = depProvider; final int Function( - WatchScopedButMissingDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -747,14 +714,14 @@ final class WatchScopedButMissingDependenciesProvider @override WatchScopedButMissingDependenciesProvider $copyWithCreate( int Function( - WatchScopedButMissingDependenciesRef ref, + Ref ref, ) create, ) { return WatchScopedButMissingDependenciesProvider._(create: create); } @override - int create(WatchScopedButMissingDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? watchScopedButMissingDependencies; return _$cb(ref); } @@ -763,18 +730,15 @@ final class WatchScopedButMissingDependenciesProvider String _$watchScopedButMissingDependenciesHash() => r'c890e4845b1fca73ee02442eb7a203734605173c'; -typedef WatchGeneratedScopedButMissingDependenciesRef = Ref; - @ProviderFor(watchGeneratedScopedButMissingDependencies) const watchGeneratedScopedButMissingDependenciesProvider = WatchGeneratedScopedButMissingDependenciesProvider._(); final class WatchGeneratedScopedButMissingDependenciesProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const WatchGeneratedScopedButMissingDependenciesProvider._( {int Function( - WatchGeneratedScopedButMissingDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -793,7 +757,7 @@ final class WatchGeneratedScopedButMissingDependenciesProvider static const $allTransitiveDependencies0 = depProvider; final int Function( - WatchGeneratedScopedButMissingDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -816,14 +780,14 @@ final class WatchGeneratedScopedButMissingDependenciesProvider @override WatchGeneratedScopedButMissingDependenciesProvider $copyWithCreate( int Function( - WatchGeneratedScopedButMissingDependenciesRef ref, + Ref ref, ) create, ) { return WatchGeneratedScopedButMissingDependenciesProvider._(create: create); } @override - int create(WatchGeneratedScopedButMissingDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? watchGeneratedScopedButMissingDependencies; return _$cb(ref); } @@ -832,18 +796,15 @@ final class WatchGeneratedScopedButMissingDependenciesProvider String _$watchGeneratedScopedButMissingDependenciesHash() => r'fbbb5f1ea3725a7554dc05073f47a6b9ce5d913d'; -typedef WatchRootButMissingDependenciesRef = Ref; - @ProviderFor(watchRootButMissingDependencies) const watchRootButMissingDependenciesProvider = WatchRootButMissingDependenciesProvider._(); final class WatchRootButMissingDependenciesProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const WatchRootButMissingDependenciesProvider._( {int Function( - WatchRootButMissingDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -861,7 +822,7 @@ final class WatchRootButMissingDependenciesProvider static const $allTransitiveDependencies0 = depProvider; final int Function( - WatchRootButMissingDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -883,14 +844,14 @@ final class WatchRootButMissingDependenciesProvider @override WatchRootButMissingDependenciesProvider $copyWithCreate( int Function( - WatchRootButMissingDependenciesRef ref, + Ref ref, ) create, ) { return WatchRootButMissingDependenciesProvider._(create: create); } @override - int create(WatchRootButMissingDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? watchRootButMissingDependencies; return _$cb(ref); } @@ -899,18 +860,15 @@ final class WatchRootButMissingDependenciesProvider String _$watchRootButMissingDependenciesHash() => r'cc9c5e6c3a1c34e291a63c429fb031e0cc701499'; -typedef WatchGeneratedRootButMissingDependenciesRef = Ref; - @ProviderFor(watchGeneratedRootButMissingDependencies) const watchGeneratedRootButMissingDependenciesProvider = WatchGeneratedRootButMissingDependenciesProvider._(); final class WatchGeneratedRootButMissingDependenciesProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const WatchGeneratedRootButMissingDependenciesProvider._( {int Function( - WatchGeneratedRootButMissingDependenciesRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -929,7 +887,7 @@ final class WatchGeneratedRootButMissingDependenciesProvider static const $allTransitiveDependencies0 = depProvider; final int Function( - WatchGeneratedRootButMissingDependenciesRef ref, + Ref ref, )? _createCb; @override @@ -952,14 +910,14 @@ final class WatchGeneratedRootButMissingDependenciesProvider @override WatchGeneratedRootButMissingDependenciesProvider $copyWithCreate( int Function( - WatchGeneratedRootButMissingDependenciesRef ref, + Ref ref, ) create, ) { return WatchGeneratedRootButMissingDependenciesProvider._(create: create); } @override - int create(WatchGeneratedRootButMissingDependenciesRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? watchGeneratedRootButMissingDependencies; return _$cb(ref); } @@ -968,18 +926,15 @@ final class WatchGeneratedRootButMissingDependenciesProvider String _$watchGeneratedRootButMissingDependenciesHash() => r'10d01aea2b6b0772e98172f410bdbfce85786243'; -typedef WatchGeneratedScopedAndContainsDependencyRef = Ref; - @ProviderFor(watchGeneratedScopedAndContainsDependency) const watchGeneratedScopedAndContainsDependencyProvider = WatchGeneratedScopedAndContainsDependencyProvider._(); final class WatchGeneratedScopedAndContainsDependencyProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const WatchGeneratedScopedAndContainsDependencyProvider._( {int Function( - WatchGeneratedScopedAndContainsDependencyRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -998,7 +953,7 @@ final class WatchGeneratedScopedAndContainsDependencyProvider static const $allTransitiveDependencies0 = generatedScopedProvider; final int Function( - WatchGeneratedScopedAndContainsDependencyRef ref, + Ref ref, )? _createCb; @override @@ -1021,14 +976,14 @@ final class WatchGeneratedScopedAndContainsDependencyProvider @override WatchGeneratedScopedAndContainsDependencyProvider $copyWithCreate( int Function( - WatchGeneratedScopedAndContainsDependencyRef ref, + Ref ref, ) create, ) { return WatchGeneratedScopedAndContainsDependencyProvider._(create: create); } @override - int create(WatchGeneratedScopedAndContainsDependencyRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? watchGeneratedScopedAndContainsDependency; return _$cb(ref); } @@ -1037,18 +992,15 @@ final class WatchGeneratedScopedAndContainsDependencyProvider String _$watchGeneratedScopedAndContainsDependencyHash() => r'948e75e097500b33ee2fdbd3dc9fdecafa5f3d10'; -typedef WatchGeneratedRootAndContainsDependencyRef = Ref; - @ProviderFor(watchGeneratedRootAndContainsDependency) const watchGeneratedRootAndContainsDependencyProvider = WatchGeneratedRootAndContainsDependencyProvider._(); final class WatchGeneratedRootAndContainsDependencyProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const WatchGeneratedRootAndContainsDependencyProvider._( {int Function( - WatchGeneratedRootAndContainsDependencyRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1067,7 +1019,7 @@ final class WatchGeneratedRootAndContainsDependencyProvider static const $allTransitiveDependencies0 = generatedRootProvider; final int Function( - WatchGeneratedRootAndContainsDependencyRef ref, + Ref ref, )? _createCb; @override @@ -1090,14 +1042,14 @@ final class WatchGeneratedRootAndContainsDependencyProvider @override WatchGeneratedRootAndContainsDependencyProvider $copyWithCreate( int Function( - WatchGeneratedRootAndContainsDependencyRef ref, + Ref ref, ) create, ) { return WatchGeneratedRootAndContainsDependencyProvider._(create: create); } @override - int create(WatchGeneratedRootAndContainsDependencyRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? watchGeneratedRootAndContainsDependency; return _$cb(ref); } @@ -1106,18 +1058,15 @@ final class WatchGeneratedRootAndContainsDependencyProvider String _$watchGeneratedRootAndContainsDependencyHash() => r'780392b647f1606186ee0f70c81dd5b03f506284'; -typedef SpecifiedDependencyButNeverUsedRef = Ref; - @ProviderFor(specifiedDependencyButNeverUsed) const specifiedDependencyButNeverUsedProvider = SpecifiedDependencyButNeverUsedProvider._(); final class SpecifiedDependencyButNeverUsedProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const SpecifiedDependencyButNeverUsedProvider._( {int Function( - SpecifiedDependencyButNeverUsedRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1140,7 +1089,7 @@ final class SpecifiedDependencyButNeverUsedProvider static const $allTransitiveDependencies1 = generatedRootProvider; final int Function( - SpecifiedDependencyButNeverUsedRef ref, + Ref ref, )? _createCb; @override @@ -1162,14 +1111,14 @@ final class SpecifiedDependencyButNeverUsedProvider @override SpecifiedDependencyButNeverUsedProvider $copyWithCreate( int Function( - SpecifiedDependencyButNeverUsedRef ref, + Ref ref, ) create, ) { return SpecifiedDependencyButNeverUsedProvider._(create: create); } @override - int create(SpecifiedDependencyButNeverUsedRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? specifiedDependencyButNeverUsed; return _$cb(ref); } @@ -1231,7 +1180,7 @@ final class ClassWatchGeneratedRootButMissingDependenciesProvider @override ClassWatchGeneratedRootButMissingDependenciesProvider $copyWithBuild( int Function( - Ref, + Ref, ClassWatchGeneratedRootButMissingDependencies, ) build, ) { @@ -1257,16 +1206,14 @@ abstract class _$ClassWatchGeneratedRootButMissingDependencies int runBuild() => build(); } -typedef Regression2348Ref = Ref; - @ProviderFor(regression2348) const regression2348Provider = Regression2348Provider._(); final class Regression2348Provider extends $FunctionalProvider - with $Provider { + with $Provider { const Regression2348Provider._( {int Function( - Regression2348Ref ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1284,7 +1231,7 @@ final class Regression2348Provider extends $FunctionalProvider static const $allTransitiveDependencies0 = generatedScopedProvider; final int Function( - Regression2348Ref ref, + Ref ref, )? _createCb; @override @@ -1306,14 +1253,14 @@ final class Regression2348Provider extends $FunctionalProvider @override Regression2348Provider $copyWithCreate( int Function( - Regression2348Ref ref, + Ref ref, ) create, ) { return Regression2348Provider._(create: create); } @override - int create(Regression2348Ref ref) { + int create(Ref ref) { final _$cb = _createCb ?? regression2348; return _$cb(ref); } @@ -1372,7 +1319,7 @@ final class Regression2417Provider @override Regression2417Provider $copyWithBuild( int Function( - Ref, + Ref, Regression2417, ) build, ) { @@ -1395,18 +1342,16 @@ abstract class _$Regression2417 extends $Notifier { int runBuild() => build(); } -typedef FamilyDepRef = Ref; - @ProviderFor(familyDep) const familyDepProvider = FamilyDepFamily._(); final class FamilyDepProvider extends $FunctionalProvider - with $Provider { + with $Provider { const FamilyDepProvider._( {required FamilyDepFamily super.from, required int super.argument, int Function( - FamilyDepRef ref, + Ref ref, int p, )? create}) : _createCb = create, @@ -1421,7 +1366,7 @@ final class FamilyDepProvider extends $FunctionalProvider static const $allTransitiveDependencies0 = depProvider; final int Function( - FamilyDepRef ref, + Ref ref, int p, )? _createCb; @@ -1451,7 +1396,7 @@ final class FamilyDepProvider extends $FunctionalProvider @override FamilyDepProvider $copyWithCreate( int Function( - FamilyDepRef ref, + Ref ref, ) create, ) { return FamilyDepProvider._( @@ -1465,7 +1410,7 @@ final class FamilyDepProvider extends $FunctionalProvider } @override - int create(FamilyDepRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? familyDep; final argument = this.argument as int; return _$cb( @@ -1513,7 +1458,7 @@ final class FamilyDepFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( int Function( - FamilyDepRef ref, + Ref ref, int args, ) create, ) { @@ -1532,18 +1477,16 @@ final class FamilyDepFamily extends Family { } } -typedef FamilyDep2Ref = Ref; - @ProviderFor(familyDep2) const familyDep2Provider = FamilyDep2Family._(); final class FamilyDep2Provider extends $FunctionalProvider - with $Provider { + with $Provider { const FamilyDep2Provider._( {required FamilyDep2Family super.from, required int super.argument, int Function( - FamilyDep2Ref ref, + Ref ref, int p, )? create}) : _createCb = create, @@ -1560,7 +1503,7 @@ final class FamilyDep2Provider extends $FunctionalProvider FamilyDepProvider.$allTransitiveDependencies0; final int Function( - FamilyDep2Ref ref, + Ref ref, int p, )? _createCb; @@ -1590,7 +1533,7 @@ final class FamilyDep2Provider extends $FunctionalProvider @override FamilyDep2Provider $copyWithCreate( int Function( - FamilyDep2Ref ref, + Ref ref, ) create, ) { return FamilyDep2Provider._( @@ -1604,7 +1547,7 @@ final class FamilyDep2Provider extends $FunctionalProvider } @override - int create(FamilyDep2Ref ref) { + int create(Ref ref) { final _$cb = _createCb ?? familyDep2; final argument = this.argument as int; return _$cb( @@ -1653,7 +1596,7 @@ final class FamilyDep2Family extends Family { /// {@macro riverpod.override_with} Override overrideWith( int Function( - FamilyDep2Ref ref, + Ref ref, int args, ) create, ) { @@ -1672,16 +1615,14 @@ final class FamilyDep2Family extends Family { } } -typedef AliasRef = Ref; - @ProviderFor(alias) const aliasProvider = AliasProvider._(); final class AliasProvider extends $FunctionalProvider - with $Provider { + with $Provider { const AliasProvider._( {int Function( - AliasRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1695,7 +1636,7 @@ final class AliasProvider extends $FunctionalProvider ); final int Function( - AliasRef ref, + Ref ref, )? _createCb; @override @@ -1717,14 +1658,14 @@ final class AliasProvider extends $FunctionalProvider @override AliasProvider $copyWithCreate( int Function( - AliasRef ref, + Ref ref, ) create, ) { return AliasProvider._(create: create); } @override - int create(AliasRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? alias; return _$cb(ref); } @@ -1778,7 +1719,7 @@ final class AliasClassProvider extends $NotifierProvider { @override AliasClassProvider $copyWithBuild( int Function( - Ref, + Ref, AliasClass, ) build, ) { @@ -1852,7 +1793,7 @@ final class RiverpodDependenciesProvider @override RiverpodDependenciesProvider $copyWithBuild( int Function( - Ref, + Ref, RiverpodDependencies, ) build, ) { @@ -1876,16 +1817,14 @@ abstract class _$RiverpodDependencies extends $Notifier { int runBuild() => build(); } -typedef FooRef = Ref; - @ProviderFor(foo) const fooProvider = FooProvider._(); final class FooProvider extends $FunctionalProvider - with $Provider { + with $Provider { const FooProvider._( {int Function( - FooRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1899,7 +1838,7 @@ final class FooProvider extends $FunctionalProvider ); final int Function( - FooRef ref, + Ref ref, )? _createCb; @override @@ -1921,14 +1860,14 @@ final class FooProvider extends $FunctionalProvider @override FooProvider $copyWithCreate( int Function( - FooRef ref, + Ref ref, ) create, ) { return FooProvider._(create: create); } @override - int create(FooRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? foo; return _$cb(ref); } @@ -1936,16 +1875,14 @@ final class FooProvider extends $FunctionalProvider String _$fooHash() => r'a390b7b969bb0eec183426bfc85bec32750e9475'; -typedef CrossFileDependencyRef = Ref; - @ProviderFor(crossFileDependency) const crossFileDependencyProvider = CrossFileDependencyProvider._(); final class CrossFileDependencyProvider extends $FunctionalProvider - with $Provider { + with $Provider { const CrossFileDependencyProvider._( {int Function( - CrossFileDependencyRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1959,7 +1896,7 @@ final class CrossFileDependencyProvider extends $FunctionalProvider ); final int Function( - CrossFileDependencyRef ref, + Ref ref, )? _createCb; @override @@ -1981,14 +1918,14 @@ final class CrossFileDependencyProvider extends $FunctionalProvider @override CrossFileDependencyProvider $copyWithCreate( int Function( - CrossFileDependencyRef ref, + Ref ref, ) create, ) { return CrossFileDependencyProvider._(create: create); } @override - int create(CrossFileDependencyRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? crossFileDependency; return _$cb(ref); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart index decf8ed18..381eebcf0 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/unused_dependency.g.dart @@ -6,16 +6,14 @@ part of 'unused_dependency.dart'; // RiverpodGenerator // ************************************************************************** -typedef RootRef = Ref; - @ProviderFor(root) const rootProvider = RootProvider._(); final class RootProvider extends $FunctionalProvider - with $Provider { + with $Provider { const RootProvider._( {int Function( - RootRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class RootProvider extends $FunctionalProvider ); final int Function( - RootRef ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class RootProvider extends $FunctionalProvider @override RootProvider $copyWithCreate( int Function( - RootRef ref, + Ref ref, ) create, ) { return RootProvider._(create: create); } @override - int create(RootRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? root; return _$cb(ref); } @@ -66,16 +64,14 @@ final class RootProvider extends $FunctionalProvider String _$rootHash() => r'dda8bbb46cb4d7c658597669e3be92e2447dcfb0'; -typedef DepRef = Ref; - @ProviderFor(dep) const depProvider = DepProvider._(); final class DepProvider extends $FunctionalProvider - with $Provider { + with $Provider { const DepProvider._( {int Function( - DepRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -89,7 +85,7 @@ final class DepProvider extends $FunctionalProvider ); final int Function( - DepRef ref, + Ref ref, )? _createCb; @override @@ -111,14 +107,14 @@ final class DepProvider extends $FunctionalProvider @override DepProvider $copyWithCreate( int Function( - DepRef ref, + Ref ref, ) create, ) { return DepProvider._(create: create); } @override - int create(DepRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? dep; return _$cb(ref); } @@ -126,16 +122,14 @@ final class DepProvider extends $FunctionalProvider String _$depHash() => r'578a350a40cda46444ecd9fa3ea2fd7bd0994692'; -typedef Dep2Ref = Ref; - @ProviderFor(dep2) const dep2Provider = Dep2Provider._(); final class Dep2Provider extends $FunctionalProvider - with $Provider { + with $Provider { const Dep2Provider._( {int Function( - Dep2Ref ref, + Ref ref, )? create}) : _createCb = create, super( @@ -149,7 +143,7 @@ final class Dep2Provider extends $FunctionalProvider ); final int Function( - Dep2Ref ref, + Ref ref, )? _createCb; @override @@ -171,14 +165,14 @@ final class Dep2Provider extends $FunctionalProvider @override Dep2Provider $copyWithCreate( int Function( - Dep2Ref ref, + Ref ref, ) create, ) { return Dep2Provider._(create: create); } @override - int create(Dep2Ref ref) { + int create(Ref ref) { final _$cb = _createCb ?? dep2; return _$cb(ref); } @@ -186,20 +180,17 @@ final class Dep2Provider extends $FunctionalProvider String _$dep2Hash() => r'97901e825cdcf5b1ac455b0fe8a2111662ce9f13'; -//////////// -typedef ExtraDepRef = Ref; - //////////// @ProviderFor(extraDep) const extraDepProvider = ExtraDepProvider._(); //////////// final class ExtraDepProvider extends $FunctionalProvider - with $Provider { + with $Provider { //////////// const ExtraDepProvider._( {int Function( - ExtraDepRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -219,7 +210,7 @@ final class ExtraDepProvider extends $FunctionalProvider static const $allTransitiveDependencies1 = dep2Provider; final int Function( - ExtraDepRef ref, + Ref ref, )? _createCb; @override @@ -241,14 +232,14 @@ final class ExtraDepProvider extends $FunctionalProvider @override ExtraDepProvider $copyWithCreate( int Function( - ExtraDepRef ref, + Ref ref, ) create, ) { return ExtraDepProvider._(create: create); } @override - int create(ExtraDepRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? extraDep; return _$cb(ref); } @@ -256,16 +247,14 @@ final class ExtraDepProvider extends $FunctionalProvider String _$extraDepHash() => r'586c1a0f0ac120f8608c025a6a47fe5282b80320'; -typedef NoDepRef = Ref; - @ProviderFor(noDep) const noDepProvider = NoDepProvider._(); final class NoDepProvider extends $FunctionalProvider - with $Provider { + with $Provider { const NoDepProvider._( {int Function( - NoDepRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -283,7 +272,7 @@ final class NoDepProvider extends $FunctionalProvider static const $allTransitiveDependencies0 = depProvider; final int Function( - NoDepRef ref, + Ref ref, )? _createCb; @override @@ -305,14 +294,14 @@ final class NoDepProvider extends $FunctionalProvider @override NoDepProvider $copyWithCreate( int Function( - NoDepRef ref, + Ref ref, ) create, ) { return NoDepProvider._(create: create); } @override - int create(NoDepRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? noDep; return _$cb(ref); } @@ -320,18 +309,15 @@ final class NoDepProvider extends $FunctionalProvider String _$noDepHash() => r'99022366e7dd3e19464747d1e2f23184691aa134'; -typedef DependenciesFirstThenKeepAliveRef = Ref; - @ProviderFor(dependenciesFirstThenKeepAlive) const dependenciesFirstThenKeepAliveProvider = DependenciesFirstThenKeepAliveProvider._(); final class DependenciesFirstThenKeepAliveProvider - extends $FunctionalProvider - with $Provider { + extends $FunctionalProvider with $Provider { const DependenciesFirstThenKeepAliveProvider._( {int Function( - DependenciesFirstThenKeepAliveRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -349,7 +335,7 @@ final class DependenciesFirstThenKeepAliveProvider static const $allTransitiveDependencies0 = depProvider; final int Function( - DependenciesFirstThenKeepAliveRef ref, + Ref ref, )? _createCb; @override @@ -371,14 +357,14 @@ final class DependenciesFirstThenKeepAliveProvider @override DependenciesFirstThenKeepAliveProvider $copyWithCreate( int Function( - DependenciesFirstThenKeepAliveRef ref, + Ref ref, ) create, ) { return DependenciesFirstThenKeepAliveProvider._(create: create); } @override - int create(DependenciesFirstThenKeepAliveRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? dependenciesFirstThenKeepAlive; return _$cb(ref); } @@ -387,16 +373,14 @@ final class DependenciesFirstThenKeepAliveProvider String _$dependenciesFirstThenKeepAliveHash() => r'b9bd9082ce9a72feea33f9327b26e7b428cadfd3'; -typedef NoDepNoParamRef = Ref; - @ProviderFor(noDepNoParam) const noDepNoParamProvider = NoDepNoParamProvider._(); final class NoDepNoParamProvider extends $FunctionalProvider - with $Provider { + with $Provider { const NoDepNoParamProvider._( {int Function( - NoDepNoParamRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -414,7 +398,7 @@ final class NoDepNoParamProvider extends $FunctionalProvider static const $allTransitiveDependencies0 = depProvider; final int Function( - NoDepNoParamRef ref, + Ref ref, )? _createCb; @override @@ -436,14 +420,14 @@ final class NoDepNoParamProvider extends $FunctionalProvider @override NoDepNoParamProvider $copyWithCreate( int Function( - NoDepNoParamRef ref, + Ref ref, ) create, ) { return NoDepNoParamProvider._(create: create); } @override - int create(NoDepNoParamRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? noDepNoParam; return _$cb(ref); } @@ -451,16 +435,14 @@ final class NoDepNoParamProvider extends $FunctionalProvider String _$noDepNoParamHash() => r'ea3e66e28bbfb716adf89cea37a1607c78283e06'; -typedef NoDepWithoutCommaRef = Ref; - @ProviderFor(noDepWithoutComma) const noDepWithoutCommaProvider = NoDepWithoutCommaProvider._(); final class NoDepWithoutCommaProvider extends $FunctionalProvider - with $Provider { + with $Provider { const NoDepWithoutCommaProvider._( {int Function( - NoDepWithoutCommaRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -478,7 +460,7 @@ final class NoDepWithoutCommaProvider extends $FunctionalProvider static const $allTransitiveDependencies0 = depProvider; final int Function( - NoDepWithoutCommaRef ref, + Ref ref, )? _createCb; @override @@ -500,14 +482,14 @@ final class NoDepWithoutCommaProvider extends $FunctionalProvider @override NoDepWithoutCommaProvider $copyWithCreate( int Function( - NoDepWithoutCommaRef ref, + Ref ref, ) create, ) { return NoDepWithoutCommaProvider._(create: create); } @override - int create(NoDepWithoutCommaRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? noDepWithoutComma; return _$cb(ref); } @@ -515,16 +497,14 @@ final class NoDepWithoutCommaProvider extends $FunctionalProvider String _$noDepWithoutCommaHash() => r'a3b07e526b4829ee4ed1848de4ff64c3b05c1a30'; -typedef RootDepRef = Ref; - @ProviderFor(rootDep) const rootDepProvider = RootDepProvider._(); final class RootDepProvider extends $FunctionalProvider - with $Provider { + with $Provider { const RootDepProvider._( {int Function( - RootDepRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -542,7 +522,7 @@ final class RootDepProvider extends $FunctionalProvider static const $allTransitiveDependencies0 = rootProvider; final int Function( - RootDepRef ref, + Ref ref, )? _createCb; @override @@ -564,14 +544,14 @@ final class RootDepProvider extends $FunctionalProvider @override RootDepProvider $copyWithCreate( int Function( - RootDepRef ref, + Ref ref, ) create, ) { return RootDepProvider._(create: create); } @override - int create(RootDepRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? rootDep; return _$cb(ref); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart index bfea5c3ce..96dacfe00 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_parameters.g.dart @@ -6,18 +6,16 @@ part of 'provider_parameters.dart'; // RiverpodGenerator // ************************************************************************** -typedef GeneratorRef = Ref; - @ProviderFor(generator) const generatorProvider = GeneratorFamily._(); final class GeneratorProvider extends $FunctionalProvider - with $Provider { + with $Provider { const GeneratorProvider._( {required GeneratorFamily super.from, required Object? super.argument, int Function( - GeneratorRef ref, { + Ref ref, { Object? value, })? create}) : _createCb = create, @@ -30,7 +28,7 @@ final class GeneratorProvider extends $FunctionalProvider ); final int Function( - GeneratorRef ref, { + Ref ref, { Object? value, })? _createCb; @@ -60,7 +58,7 @@ final class GeneratorProvider extends $FunctionalProvider @override GeneratorProvider $copyWithCreate( int Function( - GeneratorRef ref, + Ref ref, ) create, ) { return GeneratorProvider._( @@ -74,7 +72,7 @@ final class GeneratorProvider extends $FunctionalProvider } @override - int create(GeneratorRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? generator; final argument = this.argument; return _$cb( @@ -120,7 +118,7 @@ final class GeneratorFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( int Function( - GeneratorRef ref, + Ref ref, Object? args, ) create, ) { diff --git a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart index be88dd927..1051c1d99 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/scoped_providers_should_specify_dependencies.g.dart @@ -53,7 +53,7 @@ final class UnimplementedScopedProvider @override UnimplementedScopedProvider $copyWithBuild( int Function( - Ref, + Ref, UnimplementedScoped, ) build, ) { @@ -77,16 +77,14 @@ abstract class _$UnimplementedScoped extends $Notifier { int runBuild() => build(); } -typedef ScopedRef = Ref; - @ProviderFor(scoped) const scopedProvider = ScopedProvider._(); final class ScopedProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ScopedProvider._( {int Function( - ScopedRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -100,7 +98,7 @@ final class ScopedProvider extends $FunctionalProvider ); final int Function( - ScopedRef ref, + Ref ref, )? _createCb; @override @@ -122,14 +120,14 @@ final class ScopedProvider extends $FunctionalProvider @override ScopedProvider $copyWithCreate( int Function( - ScopedRef ref, + Ref ref, ) create, ) { return ScopedProvider._(create: create); } @override - int create(ScopedRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? scoped; return _$cb(ref); } @@ -137,16 +135,14 @@ final class ScopedProvider extends $FunctionalProvider String _$scopedHash() => r'5a271e9b23e18517694454448b922a6c9d03781e'; -typedef RootRef = Ref; - @ProviderFor(root) const rootProvider = RootProvider._(); final class RootProvider extends $FunctionalProvider - with $Provider { + with $Provider { const RootProvider._( {int Function( - RootRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -160,7 +156,7 @@ final class RootProvider extends $FunctionalProvider ); final int Function( - RootRef ref, + Ref ref, )? _createCb; @override @@ -182,14 +178,14 @@ final class RootProvider extends $FunctionalProvider @override RootProvider $copyWithCreate( int Function( - RootRef ref, + Ref ref, ) create, ) { return RootProvider._(create: create); } @override - int create(RootRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? root; return _$cb(ref); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart index 7da7a768a..b9df28400 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.g.dart @@ -6,16 +6,14 @@ part of 'unknown_scoped_usage.dart'; // RiverpodGenerator // ************************************************************************** -typedef ScopedRef = Ref; - @ProviderFor(scoped) const scopedProvider = ScopedProvider._(); final class ScopedProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ScopedProvider._( {int Function( - ScopedRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class ScopedProvider extends $FunctionalProvider ); final int Function( - ScopedRef ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class ScopedProvider extends $FunctionalProvider @override ScopedProvider $copyWithCreate( int Function( - ScopedRef ref, + Ref ref, ) create, ) { return ScopedProvider._(create: create); } @override - int create(ScopedRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? scoped; return _$cb(ref); } @@ -66,16 +64,14 @@ final class ScopedProvider extends $FunctionalProvider String _$scopedHash() => r'5a271e9b23e18517694454448b922a6c9d03781e'; -typedef RootRef = Ref; - @ProviderFor(root) const rootProvider = RootProvider._(); final class RootProvider extends $FunctionalProvider - with $Provider { + with $Provider { const RootProvider._( {int Function( - RootRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -89,7 +85,7 @@ final class RootProvider extends $FunctionalProvider ); final int Function( - RootRef ref, + Ref ref, )? _createCb; @override @@ -111,14 +107,14 @@ final class RootProvider extends $FunctionalProvider @override RootProvider $copyWithCreate( int Function( - RootRef ref, + Ref ref, ) create, ) { return RootProvider._(create: create); } @override - int create(RootRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? root; return _$cb(ref); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart index 288de347a..dd62d2b38 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unsupported_provider_value.g.dart @@ -6,16 +6,14 @@ part of 'unsupported_provider_value.dart'; // RiverpodGenerator // ************************************************************************** -typedef IntegerRef = Ref; - @ProviderFor(integer) const integerProvider = IntegerProvider._(); final class IntegerProvider extends $FunctionalProvider - with $Provider { + with $Provider { const IntegerProvider._( {int Function( - IntegerRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -29,7 +27,7 @@ final class IntegerProvider extends $FunctionalProvider ); final int Function( - IntegerRef ref, + Ref ref, )? _createCb; @override @@ -51,14 +49,14 @@ final class IntegerProvider extends $FunctionalProvider @override IntegerProvider $copyWithCreate( int Function( - IntegerRef ref, + Ref ref, ) create, ) { return IntegerProvider._(create: create); } @override - int create(IntegerRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? integer; return _$cb(ref); } @@ -66,17 +64,15 @@ final class IntegerProvider extends $FunctionalProvider String _$integerHash() => r'8ad63bb35c89ffcf2ef281d7c39539760afff303'; -typedef StateNotifierRef = Ref; - @ProviderFor(stateNotifier) const stateNotifierProvider = StateNotifierProvider._(); final class StateNotifierProvider extends $FunctionalProvider - with $Provider { + with $Provider { const StateNotifierProvider._( {MyStateNotifier Function( - StateNotifierRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -90,7 +86,7 @@ final class StateNotifierProvider ); final MyStateNotifier Function( - StateNotifierRef ref, + Ref ref, )? _createCb; @override @@ -112,14 +108,14 @@ final class StateNotifierProvider @override StateNotifierProvider $copyWithCreate( MyStateNotifier Function( - StateNotifierRef ref, + Ref ref, ) create, ) { return StateNotifierProvider._(create: create); } @override - MyStateNotifier create(StateNotifierRef ref) { + MyStateNotifier create(Ref ref) { final _$cb = _createCb ?? stateNotifier; return _$cb(ref); } @@ -127,19 +123,15 @@ final class StateNotifierProvider String _$stateNotifierHash() => r'2505b564fd3a623976548c715b1623dea507f6d3'; -typedef AsyncStateNotifierRef = Ref>; - @ProviderFor(asyncStateNotifier) const asyncStateNotifierProvider = AsyncStateNotifierProvider._(); final class AsyncStateNotifierProvider extends $FunctionalProvider< AsyncValue, FutureOr> - with - $FutureModifier, - $FutureProvider { + with $FutureModifier, $FutureProvider { const AsyncStateNotifierProvider._( {FutureOr Function( - AsyncStateNotifierRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -153,7 +145,7 @@ final class AsyncStateNotifierProvider extends $FunctionalProvider< ); final FutureOr Function( - AsyncStateNotifierRef ref, + Ref ref, )? _createCb; @override @@ -168,14 +160,14 @@ final class AsyncStateNotifierProvider extends $FunctionalProvider< @override AsyncStateNotifierProvider $copyWithCreate( FutureOr Function( - AsyncStateNotifierRef ref, + Ref ref, ) create, ) { return AsyncStateNotifierProvider._(create: create); } @override - FutureOr create(AsyncStateNotifierRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? asyncStateNotifier; return _$cb(ref); } @@ -231,7 +223,7 @@ final class StateNotifierClassProvider @override StateNotifierClassProvider $copyWithBuild( MyStateNotifier Function( - Ref, + Ref, StateNotifierClass, ) build, ) { @@ -255,19 +247,15 @@ abstract class _$StateNotifierClass extends $Notifier { MyStateNotifier runBuild() => build(); } -typedef StateNotifierAsyncRef = Ref>; - @ProviderFor(stateNotifierAsync) const stateNotifierAsyncProvider = StateNotifierAsyncProvider._(); final class StateNotifierAsyncProvider extends $FunctionalProvider< AsyncValue, FutureOr> - with - $FutureModifier, - $FutureProvider { + with $FutureModifier, $FutureProvider { const StateNotifierAsyncProvider._( {FutureOr Function( - StateNotifierAsyncRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -281,7 +269,7 @@ final class StateNotifierAsyncProvider extends $FunctionalProvider< ); final FutureOr Function( - StateNotifierAsyncRef ref, + Ref ref, )? _createCb; @override @@ -296,14 +284,14 @@ final class StateNotifierAsyncProvider extends $FunctionalProvider< @override StateNotifierAsyncProvider $copyWithCreate( FutureOr Function( - StateNotifierAsyncRef ref, + Ref ref, ) create, ) { return StateNotifierAsyncProvider._(create: create); } @override - FutureOr create(StateNotifierAsyncRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? stateNotifierAsync; return _$cb(ref); } @@ -351,7 +339,7 @@ final class SelfNotifierProvider @override SelfNotifierProvider $copyWithBuild( FutureOr Function( - Ref>, + Ref, SelfNotifier, ) build, ) { @@ -421,7 +409,7 @@ final class SyncSelfNotifierProvider @override SyncSelfNotifierProvider $copyWithBuild( SyncSelfNotifier Function( - Ref, + Ref, SyncSelfNotifier, ) build, ) { @@ -483,7 +471,7 @@ final class StreamSelfNotifierProvider @override StreamSelfNotifierProvider $copyWithBuild( Stream Function( - Ref>, + Ref, StreamSelfNotifier, ) build, ) { @@ -549,7 +537,7 @@ final class StateNotifierClassAsyncProvider @override StateNotifierClassAsyncProvider $copyWithBuild( FutureOr Function( - Ref>, + Ref, StateNotifierClassAsync, ) build, ) { @@ -574,17 +562,15 @@ abstract class _$StateNotifierClassAsync FutureOr runBuild() => build(); } -typedef ChangeNotifierRef = Ref; - @ProviderFor(changeNotifier) const changeNotifierProvider = ChangeNotifierProvider._(); final class ChangeNotifierProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ChangeNotifierProvider._( {MyChangeNotifier Function( - ChangeNotifierRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -598,7 +584,7 @@ final class ChangeNotifierProvider ); final MyChangeNotifier Function( - ChangeNotifierRef ref, + Ref ref, )? _createCb; @override @@ -620,14 +606,14 @@ final class ChangeNotifierProvider @override ChangeNotifierProvider $copyWithCreate( MyChangeNotifier Function( - ChangeNotifierRef ref, + Ref ref, ) create, ) { return ChangeNotifierProvider._(create: create); } @override - MyChangeNotifier create(ChangeNotifierRef ref) { + MyChangeNotifier create(Ref ref) { final _$cb = _createCb ?? changeNotifier; return _$cb(ref); } @@ -682,7 +668,7 @@ final class ChangeNotifierClassProvider @override ChangeNotifierClassProvider $copyWithBuild( MyChangeNotifier Function( - Ref, + Ref, ChangeNotifierClass, ) build, ) { @@ -706,16 +692,14 @@ abstract class _$ChangeNotifierClass extends $Notifier { MyChangeNotifier runBuild() => build(); } -typedef NotifierRef = Ref; - @ProviderFor(notifier) const notifierProvider = NotifierProvider._(); final class NotifierProvider extends $FunctionalProvider - with $Provider { + with $Provider { const NotifierProvider._( {MyNotifier Function( - NotifierRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -729,7 +713,7 @@ final class NotifierProvider extends $FunctionalProvider ); final MyNotifier Function( - NotifierRef ref, + Ref ref, )? _createCb; @override @@ -751,14 +735,14 @@ final class NotifierProvider extends $FunctionalProvider @override NotifierProvider $copyWithCreate( MyNotifier Function( - NotifierRef ref, + Ref ref, ) create, ) { return NotifierProvider._(create: create); } @override - MyNotifier create(NotifierRef ref) { + MyNotifier create(Ref ref) { final _$cb = _createCb ?? notifier; return _$cb(ref); } @@ -766,17 +750,15 @@ final class NotifierProvider extends $FunctionalProvider String _$notifierHash() => r'5ad63d9ccd05ab78e7a6ba5c763cacf0b1decb7b'; -typedef AutoDisposeNotifierRef = Ref; - @ProviderFor(autoDisposeNotifier) const autoDisposeNotifierProvider = AutoDisposeNotifierProvider._(); final class AutoDisposeNotifierProvider extends $FunctionalProvider - with $Provider { + with $Provider { const AutoDisposeNotifierProvider._( {MyAutoDisposeNotifier Function( - AutoDisposeNotifierRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -790,7 +772,7 @@ final class AutoDisposeNotifierProvider ); final MyAutoDisposeNotifier Function( - AutoDisposeNotifierRef ref, + Ref ref, )? _createCb; @override @@ -813,14 +795,14 @@ final class AutoDisposeNotifierProvider @override AutoDisposeNotifierProvider $copyWithCreate( MyAutoDisposeNotifier Function( - AutoDisposeNotifierRef ref, + Ref ref, ) create, ) { return AutoDisposeNotifierProvider._(create: create); } @override - MyAutoDisposeNotifier create(AutoDisposeNotifierRef ref) { + MyAutoDisposeNotifier create(Ref ref) { final _$cb = _createCb ?? autoDisposeNotifier; return _$cb(ref); } @@ -876,7 +858,7 @@ final class NotifierClassProvider @override NotifierClassProvider $copyWithBuild( MyNotifier Function( - Ref, + Ref, NotifierClass, ) build, ) { @@ -899,17 +881,15 @@ abstract class _$NotifierClass extends $Notifier { MyNotifier runBuild() => build(); } -typedef AsyncNotifierRef = Ref; - @ProviderFor(asyncNotifier) const asyncNotifierProvider = AsyncNotifierProvider._(); final class AsyncNotifierProvider extends $FunctionalProvider - with $Provider { + with $Provider { const AsyncNotifierProvider._( {MyAsyncNotifier Function( - AsyncNotifierRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -923,7 +903,7 @@ final class AsyncNotifierProvider ); final MyAsyncNotifier Function( - AsyncNotifierRef ref, + Ref ref, )? _createCb; @override @@ -945,14 +925,14 @@ final class AsyncNotifierProvider @override AsyncNotifierProvider $copyWithCreate( MyAsyncNotifier Function( - AsyncNotifierRef ref, + Ref ref, ) create, ) { return AsyncNotifierProvider._(create: create); } @override - MyAsyncNotifier create(AsyncNotifierRef ref) { + MyAsyncNotifier create(Ref ref) { final _$cb = _createCb ?? asyncNotifier; return _$cb(ref); } @@ -1007,7 +987,7 @@ final class AsyncNotifierClassProvider @override AsyncNotifierClassProvider $copyWithBuild( MyAsyncNotifier Function( - Ref, + Ref, AsyncNotifierClass, ) build, ) { @@ -1031,17 +1011,15 @@ abstract class _$AsyncNotifierClass extends $Notifier { MyAsyncNotifier runBuild() => build(); } -typedef RawNotifierRef = Ref>; - @ProviderFor(rawNotifier) const rawNotifierProvider = RawNotifierProvider._(); final class RawNotifierProvider extends $FunctionalProvider, Raw> - with $Provider, RawNotifierRef> { + with $Provider> { const RawNotifierProvider._( {Raw Function( - RawNotifierRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1055,7 +1033,7 @@ final class RawNotifierProvider ); final Raw Function( - RawNotifierRef ref, + Ref ref, )? _createCb; @override @@ -1078,14 +1056,14 @@ final class RawNotifierProvider @override RawNotifierProvider $copyWithCreate( Raw Function( - RawNotifierRef ref, + Ref ref, ) create, ) { return RawNotifierProvider._(create: create); } @override - Raw create(RawNotifierRef ref) { + Raw create(Ref ref) { final _$cb = _createCb ?? rawNotifier; return _$cb(ref); } @@ -1093,17 +1071,15 @@ final class RawNotifierProvider String _$rawNotifierHash() => r'c667d10419c9ce1fdd227e2afd1f3aaf63c3380b'; -typedef RawFutureNotifierRef = Ref>>; - @ProviderFor(rawFutureNotifier) const rawFutureNotifierProvider = RawFutureNotifierProvider._(); final class RawFutureNotifierProvider extends $FunctionalProvider< Raw>, Raw>> - with $Provider>, RawFutureNotifierRef> { + with $Provider>> { const RawFutureNotifierProvider._( {Raw> Function( - RawFutureNotifierRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1117,7 +1093,7 @@ final class RawFutureNotifierProvider extends $FunctionalProvider< ); final Raw> Function( - RawFutureNotifierRef ref, + Ref ref, )? _createCb; @override @@ -1140,14 +1116,14 @@ final class RawFutureNotifierProvider extends $FunctionalProvider< @override RawFutureNotifierProvider $copyWithCreate( Raw> Function( - RawFutureNotifierRef ref, + Ref ref, ) create, ) { return RawFutureNotifierProvider._(create: create); } @override - Raw> create(RawFutureNotifierRef ref) { + Raw> create(Ref ref) { final _$cb = _createCb ?? rawFutureNotifier; return _$cb(ref); } @@ -1155,17 +1131,15 @@ final class RawFutureNotifierProvider extends $FunctionalProvider< String _$rawFutureNotifierHash() => r'ff2744c369ebd96615f19451eae416d7afeef03f'; -typedef RawStreamNotifierRef = Ref>>; - @ProviderFor(rawStreamNotifier) const rawStreamNotifierProvider = RawStreamNotifierProvider._(); final class RawStreamNotifierProvider extends $FunctionalProvider< Raw>, Raw>> - with $Provider>, RawStreamNotifierRef> { + with $Provider>> { const RawStreamNotifierProvider._( {Raw> Function( - RawStreamNotifierRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1179,7 +1153,7 @@ final class RawStreamNotifierProvider extends $FunctionalProvider< ); final Raw> Function( - RawStreamNotifierRef ref, + Ref ref, )? _createCb; @override @@ -1202,14 +1176,14 @@ final class RawStreamNotifierProvider extends $FunctionalProvider< @override RawStreamNotifierProvider $copyWithCreate( Raw> Function( - RawStreamNotifierRef ref, + Ref ref, ) create, ) { return RawStreamNotifierProvider._(create: create); } @override - Raw> create(RawStreamNotifierRef ref) { + Raw> create(Ref ref) { final _$cb = _createCb ?? rawStreamNotifier; return _$cb(ref); } @@ -1217,8 +1191,6 @@ final class RawStreamNotifierProvider extends $FunctionalProvider< String _$rawStreamNotifierHash() => r'9a13efb8fbcef6c4388d5a2535b1b0aec6e46a9a'; -typedef FutureRawNotifierRef = Ref>>; - @ProviderFor(futureRawNotifier) const futureRawNotifierProvider = FutureRawNotifierProvider._(); @@ -1226,10 +1198,10 @@ final class FutureRawNotifierProvider extends $FunctionalProvider< AsyncValue>, FutureOr>> with $FutureModifier>, - $FutureProvider, FutureRawNotifierRef> { + $FutureProvider> { const FutureRawNotifierProvider._( {FutureOr> Function( - FutureRawNotifierRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1243,7 +1215,7 @@ final class FutureRawNotifierProvider extends $FunctionalProvider< ); final FutureOr> Function( - FutureRawNotifierRef ref, + Ref ref, )? _createCb; @override @@ -1258,14 +1230,14 @@ final class FutureRawNotifierProvider extends $FunctionalProvider< @override FutureRawNotifierProvider $copyWithCreate( FutureOr> Function( - FutureRawNotifierRef ref, + Ref ref, ) create, ) { return FutureRawNotifierProvider._(create: create); } @override - FutureOr> create(FutureRawNotifierRef ref) { + FutureOr> create(Ref ref) { final _$cb = _createCb ?? futureRawNotifier; return _$cb(ref); } @@ -1273,8 +1245,6 @@ final class FutureRawNotifierProvider extends $FunctionalProvider< String _$futureRawNotifierHash() => r'87103845bce1f4cae4ad62ae3b7da6ca3539581f'; -typedef StreamRawNotifierRef = Ref>>; - @ProviderFor(streamRawNotifier) const streamRawNotifierProvider = StreamRawNotifierProvider._(); @@ -1282,10 +1252,10 @@ final class StreamRawNotifierProvider extends $FunctionalProvider< AsyncValue>, Stream>> with $FutureModifier>, - $StreamProvider, StreamRawNotifierRef> { + $StreamProvider> { const StreamRawNotifierProvider._( {Stream> Function( - StreamRawNotifierRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -1299,7 +1269,7 @@ final class StreamRawNotifierProvider extends $FunctionalProvider< ); final Stream> Function( - StreamRawNotifierRef ref, + Ref ref, )? _createCb; @override @@ -1314,14 +1284,14 @@ final class StreamRawNotifierProvider extends $FunctionalProvider< @override StreamRawNotifierProvider $copyWithCreate( Stream> Function( - StreamRawNotifierRef ref, + Ref ref, ) create, ) { return StreamRawNotifierProvider._(create: create); } @override - Stream> create(StreamRawNotifierRef ref) { + Stream> create(Ref ref) { final _$cb = _createCb ?? streamRawNotifier; return _$cb(ref); } diff --git a/website/docs/advanced/select/select/codegen.g.dart b/website/docs/advanced/select/select/codegen.g.dart index ba7f12252..0aaaa5a94 100644 --- a/website/docs/advanced/select/select/codegen.g.dart +++ b/website/docs/advanced/select/select/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ExampleRef = Ref; - @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ExampleProvider._( {User Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class ExampleProvider extends $FunctionalProvider ); final User Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class ExampleProvider extends $FunctionalProvider @override ExampleProvider $copyWithCreate( User Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - User create(ExampleRef ref) { + User create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } diff --git a/website/docs/advanced/select/select_async/codegen.g.dart b/website/docs/advanced/select/select_async/codegen.g.dart index a37162d18..c53201dae 100644 --- a/website/docs/advanced/select/select_async/codegen.g.dart +++ b/website/docs/advanced/select/select_async/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef UserRef = Ref>; - @ProviderFor(user) const userProvider = UserProvider._(); final class UserProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const UserProvider._( {FutureOr Function( - UserRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class UserProvider ); final FutureOr Function( - UserRef ref, + Ref ref, )? _createCb; @override @@ -46,31 +44,29 @@ final class UserProvider @override UserProvider $copyWithCreate( FutureOr Function( - UserRef ref, + Ref ref, ) create, ) { return UserProvider._(create: create); } @override - FutureOr create(UserRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? user; return _$cb(ref); } } -String _$userHash() => r'19a4464690c31301e47fd7bd5bf6ea475c1a73eb'; - -typedef ExampleRef = Ref; +String _$userHash() => r'b83ca110a6fae2341d1bfca73fb3d89c4d12723d'; @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ExampleProvider._( {Object? Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -84,7 +80,7 @@ final class ExampleProvider extends $FunctionalProvider ); final Object? Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -106,14 +102,14 @@ final class ExampleProvider extends $FunctionalProvider @override ExampleProvider $copyWithCreate( Object? Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - Object? create(ExampleRef ref) { + Object? create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } diff --git a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart index a08c54d0a..30cf3b400 100644 --- a/website/docs/case_studies/cancel/detail_screen/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen/codegen.g.dart @@ -28,17 +28,15 @@ Map _$$ActivityImplToJson(_$ActivityImpl instance) => // RiverpodGenerator // ************************************************************************** -typedef ActivityRef = Ref>; - @ProviderFor(activity) const activityProvider = ActivityProvider._(); final class ActivityProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const ActivityProvider._( {FutureOr Function( - ActivityRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -52,7 +50,7 @@ final class ActivityProvider ); final FutureOr Function( - ActivityRef ref, + Ref ref, )? _createCb; @override @@ -66,14 +64,14 @@ final class ActivityProvider @override ActivityProvider $copyWithCreate( FutureOr Function( - ActivityRef ref, + Ref ref, ) create, ) { return ActivityProvider._(create: create); } @override - FutureOr create(ActivityRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? activity; return _$cb(ref); } diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart index fe2311549..d5d5e9bdc 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ActivityRef = Ref>; - @ProviderFor(activity) const activityProvider = ActivityProvider._(); final class ActivityProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const ActivityProvider._( {FutureOr Function( - ActivityRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class ActivityProvider ); final FutureOr Function( - ActivityRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class ActivityProvider @override ActivityProvider $copyWithCreate( FutureOr Function( - ActivityRef ref, + Ref ref, ) create, ) { return ActivityProvider._(create: create); } @override - FutureOr create(ActivityRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? activity; return _$cb(ref); } diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart index e85b6c152..5599a976f 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ActivityRef = Ref>; - @ProviderFor(activity) const activityProvider = ActivityProvider._(); final class ActivityProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const ActivityProvider._( {FutureOr Function( - ActivityRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class ActivityProvider ); final FutureOr Function( - ActivityRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class ActivityProvider @override ActivityProvider $copyWithCreate( FutureOr Function( - ActivityRef ref, + Ref ref, ) create, ) { return ActivityProvider._(create: create); } @override - FutureOr create(ActivityRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? activity; return _$cb(ref); } diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart index dd3818a4c..bfc06dfd6 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ActivityRef = Ref>; - @ProviderFor(activity) const activityProvider = ActivityProvider._(); final class ActivityProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const ActivityProvider._( {FutureOr Function( - ActivityRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class ActivityProvider ); final FutureOr Function( - ActivityRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class ActivityProvider @override ActivityProvider $copyWithCreate( FutureOr Function( - ActivityRef ref, + Ref ref, ) create, ) { return ActivityProvider._(create: create); } @override - FutureOr create(ActivityRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? activity; return _$cb(ref); } diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart index a82fb6d2c..ce5bea251 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ActivityRef = Ref>; - @ProviderFor(activity) const activityProvider = ActivityProvider._(); final class ActivityProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const ActivityProvider._( {FutureOr Function( - ActivityRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class ActivityProvider ); final FutureOr Function( - ActivityRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class ActivityProvider @override ActivityProvider $copyWithCreate( FutureOr Function( - ActivityRef ref, + Ref ref, ) create, ) { return ActivityProvider._(create: create); } @override - FutureOr create(ActivityRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? activity; return _$cb(ref); } diff --git a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart index a08c54d0a..30cf3b400 100644 --- a/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart +++ b/website/docs/case_studies/pull_to_refresh/full_app/codegen.g.dart @@ -28,17 +28,15 @@ Map _$$ActivityImplToJson(_$ActivityImpl instance) => // RiverpodGenerator // ************************************************************************** -typedef ActivityRef = Ref>; - @ProviderFor(activity) const activityProvider = ActivityProvider._(); final class ActivityProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const ActivityProvider._( {FutureOr Function( - ActivityRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -52,7 +50,7 @@ final class ActivityProvider ); final FutureOr Function( - ActivityRef ref, + Ref ref, )? _createCb; @override @@ -66,14 +64,14 @@ final class ActivityProvider @override ActivityProvider $copyWithCreate( FutureOr Function( - ActivityRef ref, + Ref ref, ) create, ) { return ActivityProvider._(create: create); } @override - FutureOr create(ActivityRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? activity; return _$cb(ref); } diff --git a/website/docs/concepts/about_codegen/main.g.dart b/website/docs/concepts/about_codegen/main.g.dart index 7c9996902..889d75b37 100644 --- a/website/docs/concepts/about_codegen/main.g.dart +++ b/website/docs/concepts/about_codegen/main.g.dart @@ -8,19 +8,17 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -typedef FetchUserRef = Ref>; - @ProviderFor(fetchUser) const fetchUserProvider = FetchUserFamily._(); final class FetchUserProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const FetchUserProvider._( {required FetchUserFamily super.from, required int super.argument, FutureOr Function( - FetchUserRef ref, { + Ref ref, { required int userId, })? create}) : _createCb = create, @@ -33,7 +31,7 @@ final class FetchUserProvider ); final FutureOr Function( - FetchUserRef ref, { + Ref ref, { required int userId, })? _createCb; @@ -55,7 +53,7 @@ final class FetchUserProvider @override FetchUserProvider $copyWithCreate( FutureOr Function( - FetchUserRef ref, + Ref ref, ) create, ) { return FetchUserProvider._( @@ -69,7 +67,7 @@ final class FetchUserProvider } @override - FutureOr create(FetchUserRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? fetchUser; final argument = this.argument as int; return _$cb( @@ -115,7 +113,7 @@ final class FetchUserFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( FutureOr Function( - FetchUserRef ref, + Ref ref, int args, ) create, ) { diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart index 885c7b645..52014d865 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_future.g.dart @@ -46,7 +46,7 @@ final class ExampleProvider extends $AsyncNotifierProvider { @override ExampleProvider $copyWithBuild( FutureOr Function( - Ref>, + Ref, Example, ) build, ) { diff --git a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart index c44d2341f..382965278 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_class_stream.g.dart @@ -46,7 +46,7 @@ final class ExampleProvider extends $StreamNotifierProvider { @override ExampleProvider $copyWithBuild( Stream Function( - Ref>, + Ref, Example, ) build, ) { diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart index 0bc4e6ea9..779c98093 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.g.dart @@ -8,17 +8,15 @@ part of 'async_fn_future.dart'; // RiverpodGenerator // ************************************************************************** -typedef ExampleRef = Ref>; - @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const ExampleProvider._( {FutureOr Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class ExampleProvider ); final FutureOr Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class ExampleProvider @override ExampleProvider $copyWithCreate( FutureOr Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - FutureOr create(ExampleRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart index 9209375a3..f743c75ef 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.g.dart @@ -8,17 +8,15 @@ part of 'async_fn_stream.dart'; // RiverpodGenerator // ************************************************************************** -typedef ExampleRef = Ref>; - @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider, Stream> - with $FutureModifier, $StreamProvider { + with $FutureModifier, $StreamProvider { const ExampleProvider._( {Stream Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class ExampleProvider ); final Stream Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class ExampleProvider @override ExampleProvider $copyWithCreate( Stream Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - Stream create(ExampleRef ref) { + Stream create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart index a69296fe2..9abfc469c 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.g.dart @@ -8,16 +8,14 @@ part of 'auto_dispose.dart'; // RiverpodGenerator // ************************************************************************** -typedef Example1Ref = Ref; - @ProviderFor(example1) const example1Provider = Example1Provider._(); final class Example1Provider extends $FunctionalProvider - with $Provider { + with $Provider { const Example1Provider._( {String Function( - Example1Ref ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class Example1Provider extends $FunctionalProvider ); final String Function( - Example1Ref ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class Example1Provider extends $FunctionalProvider @override Example1Provider $copyWithCreate( String Function( - Example1Ref ref, + Ref ref, ) create, ) { return Example1Provider._(create: create); } @override - String create(Example1Ref ref) { + String create(Ref ref) { final _$cb = _createCb ?? example1; return _$cb(ref); } @@ -68,16 +66,14 @@ final class Example1Provider extends $FunctionalProvider String _$example1Hash() => r'6a361ee6f9dd1d0cdbb42f967f6356aa058f7041'; -typedef Example2Ref = Ref; - @ProviderFor(example2) const example2Provider = Example2Provider._(); final class Example2Provider extends $FunctionalProvider - with $Provider { + with $Provider { const Example2Provider._( {String Function( - Example2Ref ref, + Ref ref, )? create}) : _createCb = create, super( @@ -91,7 +87,7 @@ final class Example2Provider extends $FunctionalProvider ); final String Function( - Example2Ref ref, + Ref ref, )? _createCb; @override @@ -113,14 +109,14 @@ final class Example2Provider extends $FunctionalProvider @override Example2Provider $copyWithCreate( String Function( - Example2Ref ref, + Ref ref, ) create, ) { return Example2Provider._(create: create); } @override - String create(Example2Ref ref) { + String create(Ref ref) { final _$cb = _createCb ?? example2; return _$cb(ref); } diff --git a/website/docs/concepts/about_codegen/provider_type/family.g.dart b/website/docs/concepts/about_codegen/provider_type/family.g.dart index e6167b773..703faf3b7 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.g.dart @@ -8,18 +8,16 @@ part of 'family.dart'; // RiverpodGenerator // ************************************************************************** -typedef ExampleRef = Ref; - @ProviderFor(example) const exampleProvider = ExampleFamily._(); final class ExampleProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ExampleProvider._( {required ExampleFamily super.from, required int super.argument, String Function( - ExampleRef ref, + Ref ref, int param, )? create}) : _createCb = create, @@ -32,7 +30,7 @@ final class ExampleProvider extends $FunctionalProvider ); final String Function( - ExampleRef ref, + Ref ref, int param, )? _createCb; @@ -62,7 +60,7 @@ final class ExampleProvider extends $FunctionalProvider @override ExampleProvider $copyWithCreate( String Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._( @@ -76,7 +74,7 @@ final class ExampleProvider extends $FunctionalProvider } @override - String create(ExampleRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? example; final argument = this.argument as int; return _$cb( @@ -122,7 +120,7 @@ final class ExampleFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( String Function( - ExampleRef ref, + Ref ref, int args, ) create, ) { diff --git a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart index 82025a91d..c26d84a59 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_class.g.dart @@ -72,7 +72,7 @@ final class ExampleProvider extends $NotifierProvider { @override ExampleProvider $copyWithBuild( String Function( - Ref, + Ref, Example, ) build, ) { @@ -158,7 +158,7 @@ final class ExampleFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( String Function( - Ref ref, + Ref ref, Example notifier, ( int, { diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart index c68fcb438..d918bce6f 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.g.dart @@ -8,13 +8,11 @@ part of 'family_fn.dart'; // RiverpodGenerator // ************************************************************************** -typedef ExampleRef = Ref; - @ProviderFor(example) const exampleProvider = ExampleFamily._(); final class ExampleProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ExampleProvider._( {required ExampleFamily super.from, required ( @@ -23,7 +21,7 @@ final class ExampleProvider extends $FunctionalProvider }) super.argument, String Function( - ExampleRef ref, + Ref ref, int param1, { String param2, })? create}) @@ -37,7 +35,7 @@ final class ExampleProvider extends $FunctionalProvider ); final String Function( - ExampleRef ref, + Ref ref, int param1, { String param2, })? _createCb; @@ -68,7 +66,7 @@ final class ExampleProvider extends $FunctionalProvider @override ExampleProvider $copyWithCreate( String Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._( @@ -86,7 +84,7 @@ final class ExampleProvider extends $FunctionalProvider } @override - String create(ExampleRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? example; final argument = this.argument as ( int, { @@ -140,7 +138,7 @@ final class ExampleFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( String Function( - ExampleRef ref, + Ref ref, ( int, { String param2, diff --git a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart index 018497099..3984ef54d 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_class.g.dart @@ -54,7 +54,7 @@ final class ExampleProvider extends $NotifierProvider { @override ExampleProvider $copyWithBuild( String Function( - Ref, + Ref, Example, ) build, ) { diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart index bb0ecb8a4..0da673a93 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.g.dart @@ -8,16 +8,14 @@ part of 'sync_fn.dart'; // RiverpodGenerator // ************************************************************************** -typedef ExampleRef = Ref; - @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ExampleProvider._( {String Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class ExampleProvider extends $FunctionalProvider ); final String Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class ExampleProvider extends $FunctionalProvider @override ExampleProvider $copyWithCreate( String Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - String create(ExampleRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } diff --git a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart index dc6ac0c60..94def9aad 100644 --- a/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/characters_provider/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef SearchRef = Ref; - @ProviderFor(search) const searchProvider = SearchProvider._(); final class SearchProvider extends $FunctionalProvider - with $Provider { + with $Provider { const SearchProvider._( {String Function( - SearchRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class SearchProvider extends $FunctionalProvider ); final String Function( - SearchRef ref, + Ref ref, )? _createCb; @override @@ -53,34 +51,30 @@ final class SearchProvider extends $FunctionalProvider @override SearchProvider $copyWithCreate( String Function( - SearchRef ref, + Ref ref, ) create, ) { return SearchProvider._(create: create); } @override - String create(SearchRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? search; return _$cb(ref); } } -String _$searchHash() => r'a093687a671a5d5481789cf3e401a09f96f8896d'; - -typedef ConfigsRef = Ref>; +String _$searchHash() => r'bc08d7ad4026615f3c0e4824c6b943f315cf18be'; @ProviderFor(configs) const configsProvider = ConfigsProvider._(); final class ConfigsProvider extends $FunctionalProvider< AsyncValue, Stream> - with - $FutureModifier, - $StreamProvider { + with $FutureModifier, $StreamProvider { const ConfigsProvider._( {Stream Function( - ConfigsRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -94,7 +88,7 @@ final class ConfigsProvider extends $FunctionalProvider< ); final Stream Function( - ConfigsRef ref, + Ref ref, )? _createCb; @override @@ -109,14 +103,14 @@ final class ConfigsProvider extends $FunctionalProvider< @override ConfigsProvider $copyWithCreate( Stream Function( - ConfigsRef ref, + Ref ref, ) create, ) { return ConfigsProvider._(create: create); } @override - Stream create(ConfigsRef ref) { + Stream create(Ref ref) { final _$cb = _createCb ?? configs; return _$cb(ref); } @@ -124,19 +118,15 @@ final class ConfigsProvider extends $FunctionalProvider< String _$configsHash() => r'6416514dacd408abb24de2bd1404860e6518c564'; -typedef CharactersRef = Ref>>; - @ProviderFor(characters) const charactersProvider = CharactersProvider._(); final class CharactersProvider extends $FunctionalProvider< AsyncValue>, FutureOr>> - with - $FutureModifier>, - $FutureProvider, CharactersRef> { + with $FutureModifier>, $FutureProvider> { const CharactersProvider._( {FutureOr> Function( - CharactersRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -150,7 +140,7 @@ final class CharactersProvider extends $FunctionalProvider< ); final FutureOr> Function( - CharactersRef ref, + Ref ref, )? _createCb; @override @@ -165,14 +155,14 @@ final class CharactersProvider extends $FunctionalProvider< @override CharactersProvider $copyWithCreate( FutureOr> Function( - CharactersRef ref, + Ref ref, ) create, ) { return CharactersProvider._(create: create); } @override - FutureOr> create(CharactersRef ref) { + FutureOr> create(Ref ref) { final _$cb = _createCb ?? characters; return _$cb(ref); } diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart index b2002c0b7..b60e09654 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef CityRef = Ref; - @ProviderFor(city) const cityProvider = CityProvider._(); final class CityProvider extends $FunctionalProvider - with $Provider { + with $Provider { const CityProvider._( {String Function( - CityRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class CityProvider extends $FunctionalProvider ); final String Function( - CityRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class CityProvider extends $FunctionalProvider @override CityProvider $copyWithCreate( String Function( - CityRef ref, + Ref ref, ) create, ) { return CityProvider._(create: create); } @override - String create(CityRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? city; return _$cb(ref); } diff --git a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart index b7639677e..8d5daac4e 100644 --- a/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/filtered_todo_list_provider/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef FilterRef = Ref; - @ProviderFor(filter) const filterProvider = FilterProvider._(); final class FilterProvider extends $FunctionalProvider - with $Provider { + with $Provider { const FilterProvider._( {Filter Function( - FilterRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class FilterProvider extends $FunctionalProvider ); final Filter Function( - FilterRef ref, + Ref ref, )? _createCb; @override @@ -53,32 +51,30 @@ final class FilterProvider extends $FunctionalProvider @override FilterProvider $copyWithCreate( Filter Function( - FilterRef ref, + Ref ref, ) create, ) { return FilterProvider._(create: create); } @override - Filter create(FilterRef ref) { + Filter create(Ref ref) { final _$cb = _createCb ?? filter; return _$cb(ref); } } -String _$filterHash() => r'53b85f9e189dabb39aa269e62536a3f1a3559ef7'; - -typedef FilteredTodoListRef = Ref>; +String _$filterHash() => r'6583f8bace972f4385964cd26f217751164b537b'; @ProviderFor(filteredTodoList) const filteredTodoListProvider = FilteredTodoListProvider._(); final class FilteredTodoListProvider extends $FunctionalProvider, List> - with $Provider, FilteredTodoListRef> { + with $Provider> { const FilteredTodoListProvider._( {List Function( - FilteredTodoListRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -92,7 +88,7 @@ final class FilteredTodoListProvider ); final List Function( - FilteredTodoListRef ref, + Ref ref, )? _createCb; @override @@ -114,14 +110,14 @@ final class FilteredTodoListProvider @override FilteredTodoListProvider $copyWithCreate( List Function( - FilteredTodoListRef ref, + Ref ref, ) create, ) { return FilteredTodoListProvider._(create: create); } @override - List create(FilteredTodoListRef ref) { + List create(Ref ref) { final _$cb = _createCb ?? filteredTodoList; return _$cb(ref); } diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart index f7503cf38..309085274 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef AnotherRef = Ref; - @ProviderFor(another) const anotherProvider = AnotherProvider._(); final class AnotherProvider extends $FunctionalProvider - with $Provider { + with $Provider { const AnotherProvider._( {MyValue Function( - AnotherRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class AnotherProvider extends $FunctionalProvider ); final MyValue Function( - AnotherRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class AnotherProvider extends $FunctionalProvider @override AnotherProvider $copyWithCreate( MyValue Function( - AnotherRef ref, + Ref ref, ) create, ) { return AnotherProvider._(create: create); } @override - MyValue create(AnotherRef ref) { + MyValue create(Ref ref) { final _$cb = _createCb ?? another; return _$cb(ref); } @@ -68,16 +66,14 @@ final class AnotherProvider extends $FunctionalProvider String _$anotherHash() => r'07629e5ae4a53bcd316b91c07d7558edbdea9317'; -typedef MyRef = Ref; - @ProviderFor(my) const myProvider = MyProvider._(); final class MyProvider extends $FunctionalProvider - with $Provider { + with $Provider { const MyProvider._( {MyValue Function( - MyRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -91,7 +87,7 @@ final class MyProvider extends $FunctionalProvider ); final MyValue Function( - MyRef ref, + Ref ref, )? _createCb; @override @@ -113,14 +109,14 @@ final class MyProvider extends $FunctionalProvider @override MyProvider $copyWithCreate( MyValue Function( - MyRef ref, + Ref ref, ) create, ) { return MyProvider._(create: create); } @override - MyValue create(MyRef ref) { + MyValue create(Ref ref) { final _$cb = _createCb ?? my; return _$cb(ref); } diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart index 5175f017a..428bc97f0 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.g.dart @@ -8,19 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ConfigRef = Ref>; - @ProviderFor(config) const configProvider = ConfigProvider._(); final class ConfigProvider extends $FunctionalProvider< AsyncValue, Stream> - with - $FutureModifier, - $StreamProvider { + with $FutureModifier, $StreamProvider { const ConfigProvider._( {Stream Function( - ConfigRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -34,7 +30,7 @@ final class ConfigProvider extends $FunctionalProvider< ); final Stream Function( - ConfigRef ref, + Ref ref, )? _createCb; @override @@ -49,14 +45,14 @@ final class ConfigProvider extends $FunctionalProvider< @override ConfigProvider $copyWithCreate( Stream Function( - ConfigRef ref, + Ref ref, ) create, ) { return ConfigProvider._(create: create); } @override - Stream create(ConfigRef ref) { + Stream create(Ref ref) { final _$cb = _createCb ?? config; return _$cb(ref); } @@ -64,19 +60,15 @@ final class ConfigProvider extends $FunctionalProvider< String _$configHash() => r'66f48a02bf939463649f0e7ad34137265e5c8b66'; -typedef ProductsRef = Ref>>; - @ProviderFor(products) const productsProvider = ProductsProvider._(); final class ProductsProvider extends $FunctionalProvider< AsyncValue>, FutureOr>> - with - $FutureModifier>, - $FutureProvider, ProductsRef> { + with $FutureModifier>, $FutureProvider> { const ProductsProvider._( {FutureOr> Function( - ProductsRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -90,7 +82,7 @@ final class ProductsProvider extends $FunctionalProvider< ); final FutureOr> Function( - ProductsRef ref, + Ref ref, )? _createCb; @override @@ -105,14 +97,14 @@ final class ProductsProvider extends $FunctionalProvider< @override ProductsProvider $copyWithCreate( FutureOr> Function( - ProductsRef ref, + Ref ref, ) create, ) { return ProductsProvider._(create: create); } @override - FutureOr> create(ProductsRef ref) { + FutureOr> create(Ref ref) { final _$cb = _createCb ?? products; return _$cb(ref); } diff --git a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart index 786c6bb15..fd5cc7759 100644 --- a/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/todo_list_provider/codegen.g.dart @@ -54,7 +54,7 @@ final class TodoListProvider extends $NotifierProvider> { @override TodoListProvider $copyWithBuild( List Function( - Ref>, + Ref, TodoList, ) build, ) { diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart index 81459f14c..ac5fc993c 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef CityRef = Ref; - @ProviderFor(city) const cityProvider = CityProvider._(); final class CityProvider extends $FunctionalProvider - with $Provider { + with $Provider { const CityProvider._( {String Function( - CityRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class CityProvider extends $FunctionalProvider ); final String Function( - CityRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class CityProvider extends $FunctionalProvider @override CityProvider $copyWithCreate( String Function( - CityRef ref, + Ref ref, ) create, ) { return CityProvider._(create: create); } @override - String create(CityRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? city; return _$cb(ref); } @@ -68,17 +66,15 @@ final class CityProvider extends $FunctionalProvider String _$cityHash() => r'6a5023a3aba119f1ecaee6c7db44b3f519e72759'; -typedef WeatherRef = Ref>; - @ProviderFor(weather) const weatherProvider = WeatherProvider._(); final class WeatherProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const WeatherProvider._( {FutureOr Function( - WeatherRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -92,7 +88,7 @@ final class WeatherProvider ); final FutureOr Function( - WeatherRef ref, + Ref ref, )? _createCb; @override @@ -106,14 +102,14 @@ final class WeatherProvider @override WeatherProvider $copyWithCreate( FutureOr Function( - WeatherRef ref, + Ref ref, ) create, ) { return WeatherProvider._(create: create); } @override - FutureOr create(WeatherRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? weather; return _$cb(ref); } diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart index bbf51d481..310381d65 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.g.dart @@ -8,19 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ConfigRef = Ref>; - @ProviderFor(config) const configProvider = ConfigProvider._(); final class ConfigProvider extends $FunctionalProvider< AsyncValue, Stream> - with - $FutureModifier, - $StreamProvider { + with $FutureModifier, $StreamProvider { const ConfigProvider._( {Stream Function( - ConfigRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -34,7 +30,7 @@ final class ConfigProvider extends $FunctionalProvider< ); final Stream Function( - ConfigRef ref, + Ref ref, )? _createCb; @override @@ -49,14 +45,14 @@ final class ConfigProvider extends $FunctionalProvider< @override ConfigProvider $copyWithCreate( Stream Function( - ConfigRef ref, + Ref ref, ) create, ) { return ConfigProvider._(create: create); } @override - Stream create(ConfigRef ref) { + Stream create(Ref ref) { final _$cb = _createCb ?? config; return _$cb(ref); } @@ -64,19 +60,15 @@ final class ConfigProvider extends $FunctionalProvider< String _$configHash() => r'66f48a02bf939463649f0e7ad34137265e5c8b66'; -typedef ProductsRef = Ref>>; - @ProviderFor(products) const productsProvider = ProductsProvider._(); final class ProductsProvider extends $FunctionalProvider< AsyncValue>, FutureOr>> - with - $FutureModifier>, - $FutureProvider, ProductsRef> { + with $FutureModifier>, $FutureProvider> { const ProductsProvider._( {FutureOr> Function( - ProductsRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -90,7 +82,7 @@ final class ProductsProvider extends $FunctionalProvider< ); final FutureOr> Function( - ProductsRef ref, + Ref ref, )? _createCb; @override @@ -105,14 +97,14 @@ final class ProductsProvider extends $FunctionalProvider< @override ProductsProvider $copyWithCreate( FutureOr> Function( - ProductsRef ref, + Ref ref, ) create, ) { return ProductsProvider._(create: create); } @override - FutureOr> create(ProductsRef ref) { + FutureOr> create(Ref ref) { final _$cb = _createCb ?? products; return _$cb(ref); } diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart index 52c546ac7..a54e676cf 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ExampleRef = Ref>; - @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider, Stream> - with $FutureModifier, $StreamProvider { + with $FutureModifier, $StreamProvider { const ExampleProvider._( {Stream Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class ExampleProvider ); final Stream Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class ExampleProvider @override ExampleProvider $copyWithCreate( Stream Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - Stream create(ExampleRef ref) { + Stream create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart index 5671a1e78..5e7e8aafb 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.g.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef MyRef = Ref; - @ProviderFor(my) const myProvider = MyProvider._(); final class MyProvider extends $FunctionalProvider - with $Provider { + with $Provider { const MyProvider._( {MyValue Function( - MyRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class MyProvider extends $FunctionalProvider ); final MyValue Function( - MyRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class MyProvider extends $FunctionalProvider @override MyProvider $copyWithCreate( MyValue Function( - MyRef ref, + Ref ref, ) create, ) { return MyProvider._(create: create); } @override - MyValue create(MyRef ref) { + MyValue create(Ref ref) { final _$cb = _createCb ?? my; return _$cb(ref); } diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart index 75fc805a3..be7fa50dc 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef CityRef = Ref; - @ProviderFor(city) const cityProvider = CityProvider._(); final class CityProvider extends $FunctionalProvider - with $Provider { + with $Provider { const CityProvider._( {String Function( - CityRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class CityProvider extends $FunctionalProvider ); final String Function( - CityRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class CityProvider extends $FunctionalProvider @override CityProvider $copyWithCreate( String Function( - CityRef ref, + Ref ref, ) create, ) { return CityProvider._(create: create); } @override - String create(CityRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? city; return _$cb(ref); } @@ -68,16 +66,14 @@ final class CityProvider extends $FunctionalProvider String _$cityHash() => r'6a5023a3aba119f1ecaee6c7db44b3f519e72759'; -typedef CountryRef = Ref; - @ProviderFor(country) const countryProvider = CountryProvider._(); final class CountryProvider extends $FunctionalProvider - with $Provider { + with $Provider { const CountryProvider._( {String Function( - CountryRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -91,7 +87,7 @@ final class CountryProvider extends $FunctionalProvider ); final String Function( - CountryRef ref, + Ref ref, )? _createCb; @override @@ -113,14 +109,14 @@ final class CountryProvider extends $FunctionalProvider @override CountryProvider $copyWithCreate( String Function( - CountryRef ref, + Ref ref, ) create, ) { return CountryProvider._(create: create); } @override - String create(CountryRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? country; return _$cb(ref); } diff --git a/website/docs/concepts/reading/counter/codegen.g.dart b/website/docs/concepts/reading/counter/codegen.g.dart index 22ed0e8c3..49c218644 100644 --- a/website/docs/concepts/reading/counter/codegen.g.dart +++ b/website/docs/concepts/reading/counter/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef RepositoryRef = Ref; - @ProviderFor(repository) const repositoryProvider = RepositoryProvider._(); final class RepositoryProvider extends $FunctionalProvider - with $Provider { + with $Provider { const RepositoryProvider._( {Repository Function( - RepositoryRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class RepositoryProvider ); final Repository Function( - RepositoryRef ref, + Ref ref, )? _createCb; @override @@ -54,20 +52,20 @@ final class RepositoryProvider @override RepositoryProvider $copyWithCreate( Repository Function( - RepositoryRef ref, + Ref ref, ) create, ) { return RepositoryProvider._(create: create); } @override - Repository create(RepositoryRef ref) { + Repository create(Ref ref) { final _$cb = _createCb ?? repository; return _$cb(ref); } } -String _$repositoryHash() => r'c6dc3b5b727028966b5b850b27ffc7294b485273'; +String _$repositoryHash() => r'6f859a9d70c3112139aaf826ee2bd541a4c001cb'; @ProviderFor(Counter) const counterProvider = CounterProvider._(); @@ -115,7 +113,7 @@ final class CounterProvider extends $NotifierProvider { @override CounterProvider $copyWithBuild( int Function( - Ref, + Ref, Counter, ) build, ) { diff --git a/website/docs/concepts/reading/listen/codegen.g.dart b/website/docs/concepts/reading/listen/codegen.g.dart index cc379a6ae..b3034258c 100644 --- a/website/docs/concepts/reading/listen/codegen.g.dart +++ b/website/docs/concepts/reading/listen/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef AnotherRef = Ref; - @ProviderFor(another) const anotherProvider = AnotherProvider._(); final class AnotherProvider extends $FunctionalProvider - with $Provider { + with $Provider { const AnotherProvider._( {void Function( - AnotherRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class AnotherProvider extends $FunctionalProvider ); final void Function( - AnotherRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class AnotherProvider extends $FunctionalProvider @override AnotherProvider $copyWithCreate( void Function( - AnotherRef ref, + Ref ref, ) create, ) { return AnotherProvider._(create: create); } @override - void create(AnotherRef ref) { + void create(Ref ref) { final _$cb = _createCb ?? another; return _$cb(ref); } diff --git a/website/docs/concepts/reading/listen_build/codegen.g.dart b/website/docs/concepts/reading/listen_build/codegen.g.dart index 9fd3d5b2f..a8fbbd8c7 100644 --- a/website/docs/concepts/reading/listen_build/codegen.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen.g.dart @@ -54,7 +54,7 @@ final class CounterProvider extends $NotifierProvider { @override CounterProvider $copyWithBuild( int Function( - Ref, + Ref, Counter, ) build, ) { diff --git a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart index c01cf74b5..ae33ca0fd 100644 --- a/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/listen_build/codegen_hooks.g.dart @@ -54,7 +54,7 @@ final class CounterProvider extends $NotifierProvider { @override CounterProvider $copyWithBuild( int Function( - Ref, + Ref, Counter, ) build, ) { diff --git a/website/docs/concepts/reading/provider/codegen.g.dart b/website/docs/concepts/reading/provider/codegen.g.dart index b56fef447..061312636 100644 --- a/website/docs/concepts/reading/provider/codegen.g.dart +++ b/website/docs/concepts/reading/provider/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef RepositoryRef = Ref; - @ProviderFor(repository) const repositoryProvider = RepositoryProvider._(); final class RepositoryProvider extends $FunctionalProvider - with $Provider { + with $Provider { const RepositoryProvider._( {Repository Function( - RepositoryRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class RepositoryProvider ); final Repository Function( - RepositoryRef ref, + Ref ref, )? _createCb; @override @@ -54,14 +52,14 @@ final class RepositoryProvider @override RepositoryProvider $copyWithCreate( Repository Function( - RepositoryRef ref, + Ref ref, ) create, ) { return RepositoryProvider._(create: create); } @override - Repository create(RepositoryRef ref) { + Repository create(Ref ref) { final _$cb = _createCb ?? repository; return _$cb(ref); } @@ -69,16 +67,14 @@ final class RepositoryProvider String _$repositoryHash() => r'6f859a9d70c3112139aaf826ee2bd541a4c001cb'; -typedef ValueRef = Ref; - @ProviderFor(value) const valueProvider = ValueProvider._(); final class ValueProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ValueProvider._( {String Function( - ValueRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -92,7 +88,7 @@ final class ValueProvider extends $FunctionalProvider ); final String Function( - ValueRef ref, + Ref ref, )? _createCb; @override @@ -114,14 +110,14 @@ final class ValueProvider extends $FunctionalProvider @override ValueProvider $copyWithCreate( String Function( - ValueRef ref, + Ref ref, ) create, ) { return ValueProvider._(create: create); } @override - String create(ValueRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? value; return _$cb(ref); } diff --git a/website/docs/concepts/reading/read/codegen.g.dart b/website/docs/concepts/reading/read/codegen.g.dart index bd492c1e5..43d8edd39 100644 --- a/website/docs/concepts/reading/read/codegen.g.dart +++ b/website/docs/concepts/reading/read/codegen.g.dart @@ -54,7 +54,7 @@ final class CounterProvider extends $NotifierProvider { @override CounterProvider $copyWithBuild( int Function( - Ref, + Ref, Counter, ) build, ) { diff --git a/website/docs/concepts/reading/read/codegen_hooks.g.dart b/website/docs/concepts/reading/read/codegen_hooks.g.dart index e8fc5b198..ba15f2c85 100644 --- a/website/docs/concepts/reading/read/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/read/codegen_hooks.g.dart @@ -54,7 +54,7 @@ final class CounterProvider extends $NotifierProvider { @override CounterProvider $copyWithBuild( int Function( - Ref, + Ref, Counter, ) build, ) { diff --git a/website/docs/concepts/reading/read_build/codegen.g.dart b/website/docs/concepts/reading/read_build/codegen.g.dart index bd492c1e5..43d8edd39 100644 --- a/website/docs/concepts/reading/read_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_build/codegen.g.dart @@ -54,7 +54,7 @@ final class CounterProvider extends $NotifierProvider { @override CounterProvider $copyWithBuild( int Function( - Ref, + Ref, Counter, ) build, ) { diff --git a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart index bd492c1e5..43d8edd39 100644 --- a/website/docs/concepts/reading/read_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/read_notifier_build/codegen.g.dart @@ -54,7 +54,7 @@ final class CounterProvider extends $NotifierProvider { @override CounterProvider $copyWithBuild( int Function( - Ref, + Ref, Counter, ) build, ) { diff --git a/website/docs/concepts/reading/watch/codegen.g.dart b/website/docs/concepts/reading/watch/codegen.g.dart index f99d9cb4b..185d3178b 100644 --- a/website/docs/concepts/reading/watch/codegen.g.dart +++ b/website/docs/concepts/reading/watch/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef FilterTypeRef = Ref; - @ProviderFor(filterType) const filterTypeProvider = FilterTypeProvider._(); final class FilterTypeProvider extends $FunctionalProvider - with $Provider { + with $Provider { const FilterTypeProvider._( {FilterType Function( - FilterTypeRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class FilterTypeProvider ); final FilterType Function( - FilterTypeRef ref, + Ref ref, )? _createCb; @override @@ -54,14 +52,14 @@ final class FilterTypeProvider @override FilterTypeProvider $copyWithCreate( FilterType Function( - FilterTypeRef ref, + Ref ref, ) create, ) { return FilterTypeProvider._(create: create); } @override - FilterType create(FilterTypeRef ref) { + FilterType create(Ref ref) { final _$cb = _createCb ?? filterType; return _$cb(ref); } @@ -115,7 +113,7 @@ final class TodosProvider extends $NotifierProvider> { @override TodosProvider $copyWithBuild( List Function( - Ref>, + Ref, Todos, ) build, ) { @@ -138,17 +136,15 @@ abstract class _$Todos extends $Notifier> { List runBuild() => build(); } -typedef FilteredTodoListRef = Ref>; - @ProviderFor(filteredTodoList) const filteredTodoListProvider = FilteredTodoListProvider._(); final class FilteredTodoListProvider extends $FunctionalProvider, List> - with $Provider, FilteredTodoListRef> { + with $Provider> { const FilteredTodoListProvider._( {List Function( - FilteredTodoListRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -162,7 +158,7 @@ final class FilteredTodoListProvider ); final List Function( - FilteredTodoListRef ref, + Ref ref, )? _createCb; @override @@ -184,14 +180,14 @@ final class FilteredTodoListProvider @override FilteredTodoListProvider $copyWithCreate( List Function( - FilteredTodoListRef ref, + Ref ref, ) create, ) { return FilteredTodoListProvider._(create: create); } @override - List create(FilteredTodoListRef ref) { + List create(Ref ref) { final _$cb = _createCb ?? filteredTodoList; return _$cb(ref); } diff --git a/website/docs/concepts/reading/watch_build/codegen.g.dart b/website/docs/concepts/reading/watch_build/codegen.g.dart index 00f69cff1..03595dcf0 100644 --- a/website/docs/concepts/reading/watch_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen.g.dart @@ -54,7 +54,7 @@ final class TodoListProvider extends $NotifierProvider> { @override TodoListProvider $copyWithBuild( List Function( - Ref>, + Ref, TodoList, ) build, ) { @@ -77,16 +77,14 @@ abstract class _$TodoList extends $Notifier> { List runBuild() => build(); } -typedef CounterRef = Ref; - @ProviderFor(counter) const counterProvider = CounterProvider._(); final class CounterProvider extends $FunctionalProvider - with $Provider { + with $Provider { const CounterProvider._( {int Function( - CounterRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -100,7 +98,7 @@ final class CounterProvider extends $FunctionalProvider ); final int Function( - CounterRef ref, + Ref ref, )? _createCb; @override @@ -122,14 +120,14 @@ final class CounterProvider extends $FunctionalProvider @override CounterProvider $copyWithCreate( int Function( - CounterRef ref, + Ref ref, ) create, ) { return CounterProvider._(create: create); } @override - int create(CounterRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? counter; return _$cb(ref); } diff --git a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart index 59e10aff2..7ba745f62 100644 --- a/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart +++ b/website/docs/concepts/reading/watch_build/codegen_hooks.g.dart @@ -54,7 +54,7 @@ final class TodoListProvider extends $NotifierProvider> { @override TodoListProvider $copyWithBuild( List Function( - Ref>, + Ref, TodoList, ) build, ) { @@ -77,16 +77,14 @@ abstract class _$TodoList extends $Notifier> { List runBuild() => build(); } -typedef CounterRef = Ref; - @ProviderFor(counter) const counterProvider = CounterProvider._(); final class CounterProvider extends $FunctionalProvider - with $Provider { + with $Provider { const CounterProvider._( {int Function( - CounterRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -100,7 +98,7 @@ final class CounterProvider extends $FunctionalProvider ); final int Function( - CounterRef ref, + Ref ref, )? _createCb; @override @@ -122,14 +120,14 @@ final class CounterProvider extends $FunctionalProvider @override CounterProvider $copyWithCreate( int Function( - CounterRef ref, + Ref ref, ) create, ) { return CounterProvider._(create: create); } @override - int create(CounterRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? counter; return _$cb(ref); } diff --git a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart index bd492c1e5..43d8edd39 100644 --- a/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart +++ b/website/docs/concepts/reading/watch_notifier_build/codegen.g.dart @@ -54,7 +54,7 @@ final class CounterProvider extends $NotifierProvider { @override CounterProvider $copyWithBuild( int Function( - Ref, + Ref, Counter, ) build, ) { diff --git a/website/docs/concepts/why_immutability/codegen.g.dart b/website/docs/concepts/why_immutability/codegen.g.dart index acb6c8147..f088cdf2c 100644 --- a/website/docs/concepts/why_immutability/codegen.g.dart +++ b/website/docs/concepts/why_immutability/codegen.g.dart @@ -55,7 +55,7 @@ final class ThemeNotifierProvider @override ThemeNotifierProvider $copyWithBuild( ThemeSettings Function( - Ref, + Ref, ThemeNotifier, ) build, ) { diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart index 9faef92af..4544d0d25 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ExampleRef = Ref>; - @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const ExampleProvider._( {FutureOr Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class ExampleProvider ); final FutureOr Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class ExampleProvider @override ExampleProvider $copyWithCreate( FutureOr Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - FutureOr create(ExampleRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart index 9dca89cd2..575faac55 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.g.dart @@ -8,16 +8,14 @@ part of 'codegen_keep_alive.dart'; // RiverpodGenerator // ************************************************************************** -typedef ExampleRef = Ref; - @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ExampleProvider._( {int Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class ExampleProvider extends $FunctionalProvider ); final int Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class ExampleProvider extends $FunctionalProvider @override ExampleProvider $copyWithCreate( int Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - int create(ExampleRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } diff --git a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart index 19a06c2cf..f63db73da 100644 --- a/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/invalidate_family_example/codegen.g.dart @@ -8,18 +8,16 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef LabelRef = Ref; - @ProviderFor(label) const labelProvider = LabelFamily._(); final class LabelProvider extends $FunctionalProvider - with $Provider { + with $Provider { const LabelProvider._( {required LabelFamily super.from, required String super.argument, String Function( - LabelRef ref, + Ref ref, String userName, )? create}) : _createCb = create, @@ -32,7 +30,7 @@ final class LabelProvider extends $FunctionalProvider ); final String Function( - LabelRef ref, + Ref ref, String userName, )? _createCb; @@ -62,7 +60,7 @@ final class LabelProvider extends $FunctionalProvider @override LabelProvider $copyWithCreate( String Function( - LabelRef ref, + Ref ref, ) create, ) { return LabelProvider._( @@ -76,7 +74,7 @@ final class LabelProvider extends $FunctionalProvider } @override - String create(LabelRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? label; final argument = this.argument as String; return _$cb( @@ -122,7 +120,7 @@ final class LabelFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( String Function( - LabelRef ref, + Ref ref, String args, ) create, ) { diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart index 4e8ac232f..79e5e3df4 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ExampleRef = Ref>; - @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const ExampleProvider._( {FutureOr Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class ExampleProvider ); final FutureOr Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class ExampleProvider @override ExampleProvider $copyWithCreate( FutureOr Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - FutureOr create(ExampleRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart index 8837784c1..9e4f5ef90 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef OtherRef = Ref; - @ProviderFor(other) const otherProvider = OtherProvider._(); final class OtherProvider extends $FunctionalProvider - with $Provider { + with $Provider { const OtherProvider._( {int Function( - OtherRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class OtherProvider extends $FunctionalProvider ); final int Function( - OtherRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class OtherProvider extends $FunctionalProvider @override OtherProvider $copyWithCreate( int Function( - OtherRef ref, + Ref ref, ) create, ) { return OtherProvider._(create: create); } @override - int create(OtherRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? other; return _$cb(ref); } @@ -68,17 +66,15 @@ final class OtherProvider extends $FunctionalProvider String _$otherHash() => r'5d27b2b1b1c6bd17ba0844f74ade2088611be371'; -typedef ExampleRef = Ref>; - @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider, Stream> - with $FutureModifier, $StreamProvider { + with $FutureModifier, $StreamProvider { const ExampleProvider._( {Stream Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -92,7 +88,7 @@ final class ExampleProvider ); final Stream Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -106,14 +102,14 @@ final class ExampleProvider @override ExampleProvider $copyWithCreate( Stream Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - Stream create(ExampleRef ref) { + Stream create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart index f8b8fccc8..c4f8ef7f1 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef OtherRef = Ref; - @ProviderFor(other) const otherProvider = OtherProvider._(); final class OtherProvider extends $FunctionalProvider - with $Provider { + with $Provider { const OtherProvider._( {int Function( - OtherRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class OtherProvider extends $FunctionalProvider ); final int Function( - OtherRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class OtherProvider extends $FunctionalProvider @override OtherProvider $copyWithCreate( int Function( - OtherRef ref, + Ref ref, ) create, ) { return OtherProvider._(create: create); } @override - int create(OtherRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? other; return _$cb(ref); } @@ -68,16 +66,14 @@ final class OtherProvider extends $FunctionalProvider String _$otherHash() => r'5d27b2b1b1c6bd17ba0844f74ade2088611be371'; -typedef ExampleRef = Ref; - @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ExampleProvider._( {int Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -91,7 +87,7 @@ final class ExampleProvider extends $FunctionalProvider ); final int Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -113,14 +109,14 @@ final class ExampleProvider extends $FunctionalProvider @override ExampleProvider $copyWithCreate( int Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - int create(ExampleRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart index d5773ce92..1e04eee5a 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef OtherRef = Ref; - @ProviderFor(other) const otherProvider = OtherProvider._(); final class OtherProvider extends $FunctionalProvider - with $Provider { + with $Provider { const OtherProvider._( {int Function( - OtherRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class OtherProvider extends $FunctionalProvider ); final int Function( - OtherRef ref, + Ref ref, )? _createCb; @override @@ -53,31 +51,29 @@ final class OtherProvider extends $FunctionalProvider @override OtherProvider $copyWithCreate( int Function( - OtherRef ref, + Ref ref, ) create, ) { return OtherProvider._(create: create); } @override - int create(OtherRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? other; return _$cb(ref); } } -String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; - -typedef ExampleRef = Ref; +String _$otherHash() => r'5d27b2b1b1c6bd17ba0844f74ade2088611be371'; @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ExampleProvider._( {int Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -91,7 +87,7 @@ final class ExampleProvider extends $FunctionalProvider ); final int Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -113,14 +109,14 @@ final class ExampleProvider extends $FunctionalProvider @override ExampleProvider $copyWithCreate( int Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - int create(ExampleRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart index 39ba403d8..6ac7315d9 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef OtherRef = Ref; - @ProviderFor(other) const otherProvider = OtherProvider._(); final class OtherProvider extends $FunctionalProvider - with $Provider { + with $Provider { const OtherProvider._( {int Function( - OtherRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class OtherProvider extends $FunctionalProvider ); final int Function( - OtherRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class OtherProvider extends $FunctionalProvider @override OtherProvider $copyWithCreate( int Function( - OtherRef ref, + Ref ref, ) create, ) { return OtherProvider._(create: create); } @override - int create(OtherRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? other; return _$cb(ref); } @@ -114,7 +112,7 @@ final class ExampleProvider extends $NotifierProvider { @override ExampleProvider $copyWithBuild( int Function( - Ref, + Ref, Example, ) build, ) { diff --git a/website/docs/essentials/combining_requests/read_example/codegen.g.dart b/website/docs/essentials/combining_requests/read_example/codegen.g.dart index 5bca74f74..e34ca3d31 100644 --- a/website/docs/essentials/combining_requests/read_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/read_example/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef OtherRef = Ref; - @ProviderFor(other) const otherProvider = OtherProvider._(); final class OtherProvider extends $FunctionalProvider - with $Provider { + with $Provider { const OtherProvider._( {int Function( - OtherRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class OtherProvider extends $FunctionalProvider ); final int Function( - OtherRef ref, + Ref ref, )? _createCb; @override @@ -53,20 +51,20 @@ final class OtherProvider extends $FunctionalProvider @override OtherProvider $copyWithCreate( int Function( - OtherRef ref, + Ref ref, ) create, ) { return OtherProvider._(create: create); } @override - int create(OtherRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? other; return _$cb(ref); } } -String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; +String _$otherHash() => r'5d27b2b1b1c6bd17ba0844f74ade2088611be371'; @ProviderFor(MyNotifier) const myNotifierProvider = MyNotifierProvider._(); @@ -114,7 +112,7 @@ final class MyNotifierProvider extends $NotifierProvider { @override MyNotifierProvider $copyWithBuild( int Function( - Ref, + Ref, MyNotifier, ) build, ) { diff --git a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart index 0253aa2e0..9fb17601e 100644 --- a/website/docs/essentials/combining_requests/watch_example/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_example/codegen.g.dart @@ -8,8 +8,6 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef LocationRef = Ref>; - @ProviderFor(location) const locationProvider = LocationProvider._(); @@ -18,10 +16,10 @@ final class LocationProvider extends $FunctionalProvider< Stream<({double longitude, double latitude})>> with $FutureModifier<({double longitude, double latitude})>, - $StreamProvider<({double longitude, double latitude}), LocationRef> { + $StreamProvider<({double longitude, double latitude})> { const LocationProvider._( {Stream<({double longitude, double latitude})> Function( - LocationRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -35,7 +33,7 @@ final class LocationProvider extends $FunctionalProvider< ); final Stream<({double longitude, double latitude})> Function( - LocationRef ref, + Ref ref, )? _createCb; @override @@ -50,14 +48,14 @@ final class LocationProvider extends $FunctionalProvider< @override LocationProvider $copyWithCreate( Stream<({double longitude, double latitude})> Function( - LocationRef ref, + Ref ref, ) create, ) { return LocationProvider._(create: create); } @override - Stream<({double longitude, double latitude})> create(LocationRef ref) { + Stream<({double longitude, double latitude})> create(Ref ref) { final _$cb = _createCb ?? location; return _$cb(ref); } @@ -65,19 +63,15 @@ final class LocationProvider extends $FunctionalProvider< String _$locationHash() => r'39328e5d0ec2b97acec14f1aba6c8db3f24f46a8'; -typedef RestaurantsNearMeRef = Ref>>; - @ProviderFor(restaurantsNearMe) const restaurantsNearMeProvider = RestaurantsNearMeProvider._(); final class RestaurantsNearMeProvider extends $FunctionalProvider< AsyncValue>, FutureOr>> - with - $FutureModifier>, - $FutureProvider, RestaurantsNearMeRef> { + with $FutureModifier>, $FutureProvider> { const RestaurantsNearMeProvider._( {FutureOr> Function( - RestaurantsNearMeRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -91,7 +85,7 @@ final class RestaurantsNearMeProvider extends $FunctionalProvider< ); final FutureOr> Function( - RestaurantsNearMeRef ref, + Ref ref, )? _createCb; @override @@ -106,14 +100,14 @@ final class RestaurantsNearMeProvider extends $FunctionalProvider< @override RestaurantsNearMeProvider $copyWithCreate( FutureOr> Function( - RestaurantsNearMeRef ref, + Ref ref, ) create, ) { return RestaurantsNearMeProvider._(create: create); } @override - FutureOr> create(RestaurantsNearMeRef ref) { + FutureOr> create(Ref ref) { final _$cb = _createCb ?? restaurantsNearMe; return _$cb(ref); } diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart index d73558063..2647a21b1 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef OtherRef = Ref; - @ProviderFor(other) const otherProvider = OtherProvider._(); final class OtherProvider extends $FunctionalProvider - with $Provider { + with $Provider { const OtherProvider._( {int Function( - OtherRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class OtherProvider extends $FunctionalProvider ); final int Function( - OtherRef ref, + Ref ref, )? _createCb; @override @@ -53,31 +51,29 @@ final class OtherProvider extends $FunctionalProvider @override OtherProvider $copyWithCreate( int Function( - OtherRef ref, + Ref ref, ) create, ) { return OtherProvider._(create: create); } @override - int create(OtherRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? other; return _$cb(ref); } } -String _$otherHash() => r'b23696171643dfbab23d167ed9b5ab0639e6a86c'; - -typedef ExampleRef = Ref; +String _$otherHash() => r'5d27b2b1b1c6bd17ba0844f74ade2088611be371'; @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider - with $Provider { + with $Provider { const ExampleProvider._( {int Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -91,7 +87,7 @@ final class ExampleProvider extends $FunctionalProvider ); final int Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -113,14 +109,14 @@ final class ExampleProvider extends $FunctionalProvider @override ExampleProvider $copyWithCreate( int Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - int create(ExampleRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } @@ -174,7 +170,7 @@ final class MyNotifierProvider extends $NotifierProvider { @override MyNotifierProvider $copyWithBuild( int Function( - Ref, + Ref, MyNotifier, ) build, ) { diff --git a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart index 0753091c3..d317584cf 100644 --- a/website/docs/essentials/eager_initialization/require_value/codegen.g.dart +++ b/website/docs/essentials/eager_initialization/require_value/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ExampleRef = Ref>; - @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const ExampleProvider._( {FutureOr Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class ExampleProvider ); final FutureOr Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class ExampleProvider @override ExampleProvider $copyWithCreate( FutureOr Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - FutureOr create(ExampleRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } diff --git a/website/docs/essentials/first_request/codegen/provider.g.dart b/website/docs/essentials/first_request/codegen/provider.g.dart index 235e2ffda..f507b27f8 100644 --- a/website/docs/essentials/first_request/codegen/provider.g.dart +++ b/website/docs/essentials/first_request/codegen/provider.g.dart @@ -8,11 +8,6 @@ part of 'provider.dart'; // RiverpodGenerator // ************************************************************************** -/// This will create a provider named `activityProvider` -/// which will cache the result of this function. -// {@endtemplate} -typedef ActivityRef = Ref>; - /// This will create a provider named `activityProvider` /// which will cache the result of this function. // {@endtemplate} @@ -24,13 +19,13 @@ const activityProvider = ActivityProvider._(); // {@endtemplate} final class ActivityProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { /// This will create a provider named `activityProvider` /// which will cache the result of this function. // {@endtemplate} const ActivityProvider._( {FutureOr Function( - ActivityRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -44,7 +39,7 @@ final class ActivityProvider ); final FutureOr Function( - ActivityRef ref, + Ref ref, )? _createCb; @override @@ -58,14 +53,14 @@ final class ActivityProvider @override ActivityProvider $copyWithCreate( FutureOr Function( - ActivityRef ref, + Ref ref, ) create, ) { return ActivityProvider._(create: create); } @override - FutureOr create(ActivityRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? activity; return _$cb(ref); } diff --git a/website/docs/essentials/passing_args/family/codegen.g.dart b/website/docs/essentials/passing_args/family/codegen.g.dart index e9b7005ff..51bf760fb 100644 --- a/website/docs/essentials/passing_args/family/codegen.g.dart +++ b/website/docs/essentials/passing_args/family/codegen.g.dart @@ -8,19 +8,17 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ActivityRef = Ref>; - @ProviderFor(activity) const activityProvider = ActivityFamily._(); final class ActivityProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const ActivityProvider._( {required ActivityFamily super.from, required String super.argument, FutureOr Function( - ActivityRef ref, + Ref ref, String activityType, )? create}) : _createCb = create, @@ -33,7 +31,7 @@ final class ActivityProvider ); final FutureOr Function( - ActivityRef ref, + Ref ref, String activityType, )? _createCb; @@ -55,7 +53,7 @@ final class ActivityProvider @override ActivityProvider $copyWithCreate( FutureOr Function( - ActivityRef ref, + Ref ref, ) create, ) { return ActivityProvider._( @@ -69,7 +67,7 @@ final class ActivityProvider } @override - FutureOr create(ActivityRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? activity; final argument = this.argument as String; return _$cb( @@ -115,7 +113,7 @@ final class ActivityFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( FutureOr Function( - ActivityRef ref, + Ref ref, String args, ) create, ) { @@ -184,7 +182,7 @@ final class ActivityNotifier2Provider @override ActivityNotifier2Provider $copyWithBuild( FutureOr Function( - Ref>, + Ref, ActivityNotifier2, ) build, ) { @@ -256,8 +254,8 @@ final class ActivityNotifier2Family extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - FutureOr Function(Ref> ref, - ActivityNotifier2 notifier, String argument) + FutureOr Function( + Ref ref, ActivityNotifier2 notifier, String argument) build, ) { return $FamilyOverride( diff --git a/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart b/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart index a0f80d2fd..3dae20276 100644 --- a/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart +++ b/website/docs/essentials/passing_args/no_arg_provider/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ActivityRef = Ref>; - @ProviderFor(activity) const activityProvider = ActivityProvider._(); final class ActivityProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const ActivityProvider._( {FutureOr Function( - ActivityRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class ActivityProvider ); final FutureOr Function( - ActivityRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class ActivityProvider @override ActivityProvider $copyWithCreate( FutureOr Function( - ActivityRef ref, + Ref ref, ) create, ) { return ActivityProvider._(create: create); } @override - FutureOr create(ActivityRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? activity; return _$cb(ref); } @@ -100,7 +98,7 @@ final class ActivityNotifier2Provider @override ActivityNotifier2Provider $copyWithBuild( FutureOr Function( - Ref>, + Ref, ActivityNotifier2, ) build, ) { diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart index 57729a100..c2f3d90b1 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier.g.dart @@ -62,7 +62,7 @@ final class TodoListProvider @override TodoListProvider $copyWithBuild( FutureOr> Function( - Ref>>, + Ref, TodoList, ) build, ) { diff --git a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart index d72057c23..6d57aa996 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_notifier_add_todo.g.dart @@ -47,7 +47,7 @@ final class TodoListProvider @override TodoListProvider $copyWithBuild( FutureOr> Function( - Ref>>, + Ref, TodoList, ) build, ) { diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart index dbf63d019..2ac49cc27 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.g.dart @@ -8,17 +8,15 @@ part of 'todo_list_provider.dart'; // RiverpodGenerator // ************************************************************************** -typedef TodoListRef = Ref>>; - @ProviderFor(todoList) const todoListProvider = TodoListProvider._(); final class TodoListProvider extends $FunctionalProvider>, FutureOr>> - with $FutureModifier>, $FutureProvider, TodoListRef> { + with $FutureModifier>, $FutureProvider> { const TodoListProvider._( {FutureOr> Function( - TodoListRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class TodoListProvider ); final FutureOr> Function( - TodoListRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class TodoListProvider @override TodoListProvider $copyWithCreate( FutureOr> Function( - TodoListRef ref, + Ref ref, ) create, ) { return TodoListProvider._(create: create); } @override - FutureOr> create(TodoListRef ref) { + FutureOr> create(Ref ref) { final _$cb = _createCb ?? todoList; return _$cb(ref); } diff --git a/website/docs/essentials/testing/notifier_mock/codegen.g.dart b/website/docs/essentials/testing/notifier_mock/codegen.g.dart index 403e0448f..cdf362639 100644 --- a/website/docs/essentials/testing/notifier_mock/codegen.g.dart +++ b/website/docs/essentials/testing/notifier_mock/codegen.g.dart @@ -54,7 +54,7 @@ final class MyNotifierProvider extends $NotifierProvider { @override MyNotifierProvider $copyWithBuild( int Function( - Ref, + Ref, MyNotifier, ) build, ) { diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart index 0753091c3..d317584cf 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.g.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ExampleRef = Ref>; - @ProviderFor(example) const exampleProvider = ExampleProvider._(); final class ExampleProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const ExampleProvider._( {FutureOr Function( - ExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class ExampleProvider ); final FutureOr Function( - ExampleRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class ExampleProvider @override ExampleProvider $copyWithCreate( FutureOr Function( - ExampleRef ref, + Ref ref, ) create, ) { return ExampleProvider._(create: create); } @override - FutureOr create(ExampleRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? example; return _$cb(ref); } diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart index 5d83c1e63..f4b759774 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.g.dart @@ -8,11 +8,6 @@ part of 'pipe_change_notifier.dart'; // RiverpodGenerator // ************************************************************************** -/// A provider which creates a ValueNotifier and update its listeners -/// whenever the value changes. -// {@endtemplate} -typedef MyListenableRef = Ref>>; - /// A provider which creates a ValueNotifier and update its listeners /// whenever the value changes. // {@endtemplate} @@ -23,14 +18,14 @@ const myListenableProvider = MyListenableProvider._(); /// whenever the value changes. // {@endtemplate} final class MyListenableProvider extends $FunctionalProvider< - Raw>, Raw>> - with $Provider>, MyListenableRef> { + Raw>, + Raw>> with $Provider>> { /// A provider which creates a ValueNotifier and update its listeners /// whenever the value changes. // {@endtemplate} const MyListenableProvider._( {Raw> Function( - MyListenableRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -44,7 +39,7 @@ final class MyListenableProvider extends $FunctionalProvider< ); final Raw> Function( - MyListenableRef ref, + Ref ref, )? _createCb; @override @@ -67,14 +62,14 @@ final class MyListenableProvider extends $FunctionalProvider< @override MyListenableProvider $copyWithCreate( Raw> Function( - MyListenableRef ref, + Ref ref, ) create, ) { return MyListenableProvider._(create: create); } @override - Raw> create(MyListenableRef ref) { + Raw> create(Ref ref) { final _$cb = _createCb ?? myListenable; return _$cb(ref); } diff --git a/website/docs/essentials/websockets_sync/raw_usage.g.dart b/website/docs/essentials/websockets_sync/raw_usage.g.dart index 58feb279f..c971179f0 100644 --- a/website/docs/essentials/websockets_sync/raw_usage.g.dart +++ b/website/docs/essentials/websockets_sync/raw_usage.g.dart @@ -8,17 +8,15 @@ part of 'raw_usage.dart'; // RiverpodGenerator // ************************************************************************** -typedef RawStreamRef = Ref>>; - @ProviderFor(rawStream) const rawStreamProvider = RawStreamProvider._(); final class RawStreamProvider extends $FunctionalProvider>, Raw>> - with $Provider>, RawStreamRef> { + with $Provider>> { const RawStreamProvider._( {Raw> Function( - RawStreamRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class RawStreamProvider ); final Raw> Function( - RawStreamRef ref, + Ref ref, )? _createCb; @override @@ -54,14 +52,14 @@ final class RawStreamProvider @override RawStreamProvider $copyWithCreate( Raw> Function( - RawStreamRef ref, + Ref ref, ) create, ) { return RawStreamProvider._(create: create); } @override - Raw> create(RawStreamRef ref) { + Raw> create(Ref ref) { final _$cb = _createCb ?? rawStream; return _$cb(ref); } diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart index 3fc9c9629..59ea67a73 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.g.dart @@ -8,17 +8,15 @@ part of 'shared_pipe_change_notifier.dart'; // RiverpodGenerator // ************************************************************************** -typedef MyListenableRef = Ref>>; - @ProviderFor(myListenable) const myListenableProvider = MyListenableProvider._(); final class MyListenableProvider extends $FunctionalProvider< - Raw>, Raw>> - with $Provider>, MyListenableRef> { + Raw>, + Raw>> with $Provider>> { const MyListenableProvider._( {Raw> Function( - MyListenableRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class MyListenableProvider extends $FunctionalProvider< ); final Raw> Function( - MyListenableRef ref, + Ref ref, )? _createCb; @override @@ -55,14 +53,14 @@ final class MyListenableProvider extends $FunctionalProvider< @override MyListenableProvider $copyWithCreate( Raw> Function( - MyListenableRef ref, + Ref ref, ) create, ) { return MyListenableProvider._(create: create); } @override - Raw> create(MyListenableRef ref) { + Raw> create(Ref ref) { final _$cb = _createCb ?? myListenable; return _$cb(ref); } @@ -70,17 +68,15 @@ final class MyListenableProvider extends $FunctionalProvider< String _$myListenableHash() => r'a28ce39430582e0d7be5f8303a31477569153193'; -typedef AnotherListenableRef = Ref>>; - @ProviderFor(anotherListenable) const anotherListenableProvider = AnotherListenableProvider._(); final class AnotherListenableProvider extends $FunctionalProvider< - Raw>, Raw>> - with $Provider>, AnotherListenableRef> { + Raw>, + Raw>> with $Provider>> { const AnotherListenableProvider._( {Raw> Function( - AnotherListenableRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -94,7 +90,7 @@ final class AnotherListenableProvider extends $FunctionalProvider< ); final Raw> Function( - AnotherListenableRef ref, + Ref ref, )? _createCb; @override @@ -117,14 +113,14 @@ final class AnotherListenableProvider extends $FunctionalProvider< @override AnotherListenableProvider $copyWithCreate( Raw> Function( - AnotherListenableRef ref, + Ref ref, ) create, ) { return AnotherListenableProvider._(create: create); } @override - Raw> create(AnotherListenableRef ref) { + Raw> create(Ref ref) { final _$cb = _createCb ?? anotherListenable; return _$cb(ref); } diff --git a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart index ac7abc116..0e31026e8 100644 --- a/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/stream_provider/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef StreamExampleRef = Ref>; - @ProviderFor(streamExample) const streamExampleProvider = StreamExampleProvider._(); final class StreamExampleProvider extends $FunctionalProvider, Stream> - with $FutureModifier, $StreamProvider { + with $FutureModifier, $StreamProvider { const StreamExampleProvider._( {Stream Function( - StreamExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class StreamExampleProvider ); final Stream Function( - StreamExampleRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class StreamExampleProvider @override StreamExampleProvider $copyWithCreate( Stream Function( - StreamExampleRef ref, + Ref ref, ) create, ) { return StreamExampleProvider._(create: create); } @override - Stream create(StreamExampleRef ref) { + Stream create(Ref ref) { final _$cb = _createCb ?? streamExample; return _$cb(ref); } diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart index ad6845854..287ae347d 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.g.dart @@ -8,16 +8,14 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef SynchronousExampleRef = Ref; - @ProviderFor(synchronousExample) const synchronousExampleProvider = SynchronousExampleProvider._(); final class SynchronousExampleProvider extends $FunctionalProvider - with $Provider { + with $Provider { const SynchronousExampleProvider._( {int Function( - SynchronousExampleRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class SynchronousExampleProvider extends $FunctionalProvider ); final int Function( - SynchronousExampleRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class SynchronousExampleProvider extends $FunctionalProvider @override SynchronousExampleProvider $copyWithCreate( int Function( - SynchronousExampleRef ref, + Ref ref, ) create, ) { return SynchronousExampleProvider._(create: create); } @override - int create(SynchronousExampleRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? synchronousExample; return _$cb(ref); } diff --git a/website/docs/from_provider/family/family.g.dart b/website/docs/from_provider/family/family.g.dart index 2d63f67fd..8c2fc95a0 100644 --- a/website/docs/from_provider/family/family.g.dart +++ b/website/docs/from_provider/family/family.g.dart @@ -8,13 +8,11 @@ part of 'family.dart'; // RiverpodGenerator // ************************************************************************** -typedef RandomRef = Ref; - @ProviderFor(random) const randomProvider = RandomFamily._(); final class RandomProvider extends $FunctionalProvider - with $Provider { + with $Provider { const RandomProvider._( {required RandomFamily super.from, required ({ @@ -23,7 +21,7 @@ final class RandomProvider extends $FunctionalProvider }) super.argument, int Function( - RandomRef ref, { + Ref ref, { required int seed, required int max, })? create}) @@ -37,7 +35,7 @@ final class RandomProvider extends $FunctionalProvider ); final int Function( - RandomRef ref, { + Ref ref, { required int seed, required int max, })? _createCb; @@ -68,7 +66,7 @@ final class RandomProvider extends $FunctionalProvider @override RandomProvider $copyWithCreate( int Function( - RandomRef ref, + Ref ref, ) create, ) { return RandomProvider._( @@ -86,7 +84,7 @@ final class RandomProvider extends $FunctionalProvider } @override - int create(RandomRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? random; final argument = this.argument as ({ int seed, @@ -140,7 +138,7 @@ final class RandomFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( int Function( - RandomRef ref, + Ref ref, ({ int seed, int max, diff --git a/website/docs/from_provider/motivation/async_values/async_values.g.dart b/website/docs/from_provider/motivation/async_values/async_values.g.dart index 7b61c6df3..1b78c2ed0 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.g.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.g.dart @@ -8,17 +8,15 @@ part of 'async_values.dart'; // RiverpodGenerator // ************************************************************************** -typedef ItemsApiRef = Ref>>; - @ProviderFor(itemsApi) const itemsApiProvider = ItemsApiProvider._(); final class ItemsApiProvider extends $FunctionalProvider>, FutureOr>> - with $FutureModifier>, $FutureProvider, ItemsApiRef> { + with $FutureModifier>, $FutureProvider> { const ItemsApiProvider._( {FutureOr> Function( - ItemsApiRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class ItemsApiProvider ); final FutureOr> Function( - ItemsApiRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class ItemsApiProvider @override ItemsApiProvider $copyWithCreate( FutureOr> Function( - ItemsApiRef ref, + Ref ref, ) create, ) { return ItemsApiProvider._(create: create); } @override - FutureOr> create(ItemsApiRef ref) { + FutureOr> create(Ref ref) { final _$cb = _createCb ?? itemsApi; return _$cb(ref); } @@ -61,17 +59,15 @@ final class ItemsApiProvider String _$itemsApiHash() => r'fa5a8f7e93ac048d9bd5dfc1744749995cf154af'; -typedef EvenItemsRef = Ref>; - @ProviderFor(evenItems) const evenItemsProvider = EvenItemsProvider._(); final class EvenItemsProvider extends $FunctionalProvider, List> - with $Provider, EvenItemsRef> { + with $Provider> { const EvenItemsProvider._( {List Function( - EvenItemsRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -85,7 +81,7 @@ final class EvenItemsProvider ); final List Function( - EvenItemsRef ref, + Ref ref, )? _createCb; @override @@ -107,14 +103,14 @@ final class EvenItemsProvider @override EvenItemsProvider $copyWithCreate( List Function( - EvenItemsRef ref, + Ref ref, ) create, ) { return EvenItemsProvider._(create: create); } @override - List create(EvenItemsRef ref) { + List create(Ref ref) { final _$cb = _createCb ?? evenItems; return _$cb(ref); } diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart index 289213187..2c1ffb3ea 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.g.dart @@ -8,16 +8,14 @@ part of 'auto_dispose.dart'; // RiverpodGenerator // ************************************************************************** -typedef DiceRollRef = Ref; - @ProviderFor(diceRoll) const diceRollProvider = DiceRollProvider._(); final class DiceRollProvider extends $FunctionalProvider - with $Provider { + with $Provider { const DiceRollProvider._( {int Function( - DiceRollRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class DiceRollProvider extends $FunctionalProvider ); final int Function( - DiceRollRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class DiceRollProvider extends $FunctionalProvider @override DiceRollProvider $copyWithCreate( int Function( - DiceRollRef ref, + Ref ref, ) create, ) { return DiceRollProvider._(create: create); } @override - int create(DiceRollRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? diceRoll; return _$cb(ref); } @@ -68,16 +66,14 @@ final class DiceRollProvider extends $FunctionalProvider String _$diceRollHash() => r'58d43e5143bb64e855939d55a3be3ee81d66c518'; -typedef CachedDiceRollRef = Ref; - @ProviderFor(cachedDiceRoll) const cachedDiceRollProvider = CachedDiceRollProvider._(); final class CachedDiceRollProvider extends $FunctionalProvider - with $Provider { + with $Provider { const CachedDiceRollProvider._( {int Function( - CachedDiceRollRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -91,7 +87,7 @@ final class CachedDiceRollProvider extends $FunctionalProvider ); final int Function( - CachedDiceRollRef ref, + Ref ref, )? _createCb; @override @@ -113,14 +109,14 @@ final class CachedDiceRollProvider extends $FunctionalProvider @override CachedDiceRollProvider $copyWithCreate( int Function( - CachedDiceRollRef ref, + Ref ref, ) create, ) { return CachedDiceRollProvider._(create: create); } @override - int create(CachedDiceRollRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? cachedDiceRoll; return _$cb(ref); } diff --git a/website/docs/from_provider/motivation/combine/combine.g.dart b/website/docs/from_provider/motivation/combine/combine.g.dart index 2b4fd8e2f..d8ed187a2 100644 --- a/website/docs/from_provider/motivation/combine/combine.g.dart +++ b/website/docs/from_provider/motivation/combine/combine.g.dart @@ -8,16 +8,14 @@ part of 'combine.dart'; // RiverpodGenerator // ************************************************************************** -typedef NumberRef = Ref; - @ProviderFor(number) const numberProvider = NumberProvider._(); final class NumberProvider extends $FunctionalProvider - with $Provider { + with $Provider { const NumberProvider._( {int Function( - NumberRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class NumberProvider extends $FunctionalProvider ); final int Function( - NumberRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class NumberProvider extends $FunctionalProvider @override NumberProvider $copyWithCreate( int Function( - NumberRef ref, + Ref ref, ) create, ) { return NumberProvider._(create: create); } @override - int create(NumberRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? number; return _$cb(ref); } @@ -68,16 +66,14 @@ final class NumberProvider extends $FunctionalProvider String _$numberHash() => r'03ac91d5904c18f04321b140fd263ed6bc85d3c1'; -typedef DoubledRef = Ref; - @ProviderFor(doubled) const doubledProvider = DoubledProvider._(); final class DoubledProvider extends $FunctionalProvider - with $Provider { + with $Provider { const DoubledProvider._( {int Function( - DoubledRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -91,7 +87,7 @@ final class DoubledProvider extends $FunctionalProvider ); final int Function( - DoubledRef ref, + Ref ref, )? _createCb; @override @@ -113,14 +109,14 @@ final class DoubledProvider extends $FunctionalProvider @override DoubledProvider $copyWithCreate( int Function( - DoubledRef ref, + Ref ref, ) create, ) { return DoubledProvider._(create: create); } @override - int create(DoubledRef ref) { + int create(Ref ref) { final _$cb = _createCb ?? doubled; return _$cb(ref); } diff --git a/website/docs/from_provider/motivation/same_type/same_type.g.dart b/website/docs/from_provider/motivation/same_type/same_type.g.dart index 0f5682add..30bc5f7ec 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.g.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.g.dart @@ -8,16 +8,14 @@ part of 'same_type.dart'; // RiverpodGenerator // ************************************************************************** -typedef ItemsRef = Ref>; - @ProviderFor(items) const itemsProvider = ItemsProvider._(); final class ItemsProvider extends $FunctionalProvider, List> - with $Provider, ItemsRef> { + with $Provider> { const ItemsProvider._( {List Function( - ItemsRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class ItemsProvider extends $FunctionalProvider, List> ); final List Function( - ItemsRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class ItemsProvider extends $FunctionalProvider, List> @override ItemsProvider $copyWithCreate( List Function( - ItemsRef ref, + Ref ref, ) create, ) { return ItemsProvider._(create: create); } @override - List create(ItemsRef ref) { + List create(Ref ref) { final _$cb = _createCb ?? items; return _$cb(ref); } @@ -68,17 +66,15 @@ final class ItemsProvider extends $FunctionalProvider, List> String _$itemsHash() => r'8dafed1afc3fc52651c24445640d8b57ff080f66'; -typedef EvenItemsRef = Ref>; - @ProviderFor(evenItems) const evenItemsProvider = EvenItemsProvider._(); final class EvenItemsProvider extends $FunctionalProvider, List> - with $Provider, EvenItemsRef> { + with $Provider> { const EvenItemsProvider._( {List Function( - EvenItemsRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -92,7 +88,7 @@ final class EvenItemsProvider ); final List Function( - EvenItemsRef ref, + Ref ref, )? _createCb; @override @@ -114,14 +110,14 @@ final class EvenItemsProvider @override EvenItemsProvider $copyWithCreate( List Function( - EvenItemsRef ref, + Ref ref, ) create, ) { return EvenItemsProvider._(create: create); } @override - List create(EvenItemsRef ref) { + List create(Ref ref) { final _$cb = _createCb ?? evenItems; return _$cb(ref); } diff --git a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart index cd7ab0585..c197b77fe 100644 --- a/website/docs/introduction/getting_started/dart_hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/dart_hello_world/main.g.dart @@ -8,16 +8,14 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -typedef HelloWorldRef = Ref; - @ProviderFor(helloWorld) const helloWorldProvider = HelloWorldProvider._(); final class HelloWorldProvider extends $FunctionalProvider - with $Provider { + with $Provider { const HelloWorldProvider._( {String Function( - HelloWorldRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class HelloWorldProvider extends $FunctionalProvider ); final String Function( - HelloWorldRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class HelloWorldProvider extends $FunctionalProvider @override HelloWorldProvider $copyWithCreate( String Function( - HelloWorldRef ref, + Ref ref, ) create, ) { return HelloWorldProvider._(create: create); } @override - String create(HelloWorldRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? helloWorld; return _$cb(ref); } diff --git a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart index cd7ab0585..c197b77fe 100644 --- a/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/hooks_codegen/main.g.dart @@ -8,16 +8,14 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -typedef HelloWorldRef = Ref; - @ProviderFor(helloWorld) const helloWorldProvider = HelloWorldProvider._(); final class HelloWorldProvider extends $FunctionalProvider - with $Provider { + with $Provider { const HelloWorldProvider._( {String Function( - HelloWorldRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class HelloWorldProvider extends $FunctionalProvider ); final String Function( - HelloWorldRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class HelloWorldProvider extends $FunctionalProvider @override HelloWorldProvider $copyWithCreate( String Function( - HelloWorldRef ref, + Ref ref, ) create, ) { return HelloWorldProvider._(create: create); } @override - String create(HelloWorldRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? helloWorld; return _$cb(ref); } diff --git a/website/docs/introduction/getting_started/hello_world/main.g.dart b/website/docs/introduction/getting_started/hello_world/main.g.dart index cd7ab0585..c197b77fe 100644 --- a/website/docs/introduction/getting_started/hello_world/main.g.dart +++ b/website/docs/introduction/getting_started/hello_world/main.g.dart @@ -8,16 +8,14 @@ part of 'main.dart'; // RiverpodGenerator // ************************************************************************** -typedef HelloWorldRef = Ref; - @ProviderFor(helloWorld) const helloWorldProvider = HelloWorldProvider._(); final class HelloWorldProvider extends $FunctionalProvider - with $Provider { + with $Provider { const HelloWorldProvider._( {String Function( - HelloWorldRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class HelloWorldProvider extends $FunctionalProvider ); final String Function( - HelloWorldRef ref, + Ref ref, )? _createCb; @override @@ -53,14 +51,14 @@ final class HelloWorldProvider extends $FunctionalProvider @override HelloWorldProvider $copyWithCreate( String Function( - HelloWorldRef ref, + Ref ref, ) create, ) { return HelloWorldProvider._(create: create); } @override - String create(HelloWorldRef ref) { + String create(Ref ref) { final _$cb = _createCb ?? helloWorld; return _$cb(ref); } diff --git a/website/docs/introduction/why_riverpod/codegen.g.dart b/website/docs/introduction/why_riverpod/codegen.g.dart index 156d2a12d..c95e4a048 100644 --- a/website/docs/introduction/why_riverpod/codegen.g.dart +++ b/website/docs/introduction/why_riverpod/codegen.g.dart @@ -8,16 +8,12 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef FetchPackagesRef = Ref>>; - @ProviderFor(fetchPackages) const fetchPackagesProvider = FetchPackagesFamily._(); final class FetchPackagesProvider extends $FunctionalProvider< AsyncValue>, FutureOr>> - with - $FutureModifier>, - $FutureProvider, FetchPackagesRef> { + with $FutureModifier>, $FutureProvider> { const FetchPackagesProvider._( {required FetchPackagesFamily super.from, required ({ @@ -26,7 +22,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< }) super.argument, FutureOr> Function( - FetchPackagesRef ref, { + Ref ref, { required int page, String search, })? create}) @@ -40,7 +36,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< ); final FutureOr> Function( - FetchPackagesRef ref, { + Ref ref, { required int page, String search, })? _createCb; @@ -64,7 +60,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< @override FetchPackagesProvider $copyWithCreate( FutureOr> Function( - FetchPackagesRef ref, + Ref ref, ) create, ) { return FetchPackagesProvider._( @@ -82,7 +78,7 @@ final class FetchPackagesProvider extends $FunctionalProvider< } @override - FutureOr> create(FetchPackagesRef ref) { + FutureOr> create(Ref ref) { final _$cb = _createCb ?? fetchPackages; final argument = this.argument as ({ int page, @@ -136,7 +132,7 @@ final class FetchPackagesFamily extends Family { /// {@macro riverpod.override_with} Override overrideWith( FutureOr> Function( - FetchPackagesRef ref, + Ref ref, ({ int page, String search, diff --git a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart index 55bfc4490..1632a0375 100644 --- a/website/docs/migration/from_change_notifier/declaration/declaration.g.dart +++ b/website/docs/migration/from_change_notifier/declaration/declaration.g.dart @@ -47,7 +47,7 @@ final class MyNotifierProvider @override MyNotifierProvider $copyWithBuild( FutureOr> Function( - Ref>>, + Ref, MyNotifier, ) build, ) { diff --git a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart index e9ea97aa9..52f915fbb 100644 --- a/website/docs/migration/from_change_notifier/initialization/initialization.g.dart +++ b/website/docs/migration/from_change_notifier/initialization/initialization.g.dart @@ -47,7 +47,7 @@ final class MyNotifierProvider @override MyNotifierProvider $copyWithBuild( FutureOr> Function( - Ref>>, + Ref, MyNotifier, ) build, ) { diff --git a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart index 27e13530d..49889dd55 100644 --- a/website/docs/migration/from_change_notifier/migrated/migrated.g.dart +++ b/website/docs/migration/from_change_notifier/migrated/migrated.g.dart @@ -47,7 +47,7 @@ final class MyNotifierProvider @override MyNotifierProvider $copyWithBuild( FutureOr> Function( - Ref>>, + Ref, MyNotifier, ) build, ) { diff --git a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart index 14da5b2ae..dff85bbe7 100644 --- a/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart +++ b/website/docs/migration/from_state_notifier/add_listener/add_listener.g.dart @@ -54,7 +54,7 @@ final class MyNotifierProvider extends $NotifierProvider { @override MyNotifierProvider $copyWithBuild( int Function( - Ref, + Ref, MyNotifier, ) build, ) { diff --git a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart index 4fb0fde7c..7c9f86c59 100644 --- a/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart +++ b/website/docs/migration/from_state_notifier/async_notifier/async_notifier.g.dart @@ -47,7 +47,7 @@ final class AsyncTodosNotifierProvider @override AsyncTodosNotifierProvider $copyWithBuild( FutureOr> Function( - Ref>>, + Ref, AsyncTodosNotifier, ) build, ) { diff --git a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart index 0a0d15377..d91084e2d 100644 --- a/website/docs/migration/from_state_notifier/build_init/build_init.g.dart +++ b/website/docs/migration/from_state_notifier/build_init/build_init.g.dart @@ -55,7 +55,7 @@ final class CounterNotifierProvider @override CounterNotifierProvider $copyWithBuild( int Function( - Ref, + Ref, CounterNotifier, ) build, ) { diff --git a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart index 5b0f54f90..e6db0d173 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose/family_and_dispose.g.dart @@ -8,17 +8,15 @@ part of 'family_and_dispose.dart'; // RiverpodGenerator // ************************************************************************** -typedef TaskTrackerRef = Ref; - @ProviderFor(taskTracker) const taskTrackerProvider = TaskTrackerProvider._(); final class TaskTrackerProvider extends $FunctionalProvider - with $Provider { + with $Provider { const TaskTrackerProvider._( {TaskTrackerRepo Function( - TaskTrackerRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class TaskTrackerProvider ); final TaskTrackerRepo Function( - TaskTrackerRef ref, + Ref ref, )? _createCb; @override @@ -54,20 +52,20 @@ final class TaskTrackerProvider @override TaskTrackerProvider $copyWithCreate( TaskTrackerRepo Function( - TaskTrackerRef ref, + Ref ref, ) create, ) { return TaskTrackerProvider._(create: create); } @override - TaskTrackerRepo create(TaskTrackerRef ref) { + TaskTrackerRepo create(Ref ref) { final _$cb = _createCb ?? taskTracker; return _$cb(ref); } } -String _$taskTrackerHash() => r'd78149146c3a07b78e7dc1d03fa60ed1941c3702'; +String _$taskTrackerHash() => r'004d4554b37d841c6f668e298067dd39611a453a'; @ProviderFor(BugsEncounteredNotifier) const bugsEncounteredNotifierProvider = BugsEncounteredNotifierFamily._(); @@ -120,7 +118,7 @@ final class BugsEncounteredNotifierProvider @override BugsEncounteredNotifierProvider $copyWithBuild( FutureOr Function( - Ref>, + Ref, BugsEncounteredNotifier, ) build, ) { @@ -194,8 +192,8 @@ final class BugsEncounteredNotifierFamily extends Family { /// {@macro riverpod.override_with_build} Override overrideWithBuild( - FutureOr Function(Ref> ref, - BugsEncounteredNotifier notifier, String argument) + FutureOr Function( + Ref ref, BugsEncounteredNotifier notifier, String argument) build, ) { return $FamilyOverride( diff --git a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart index 9c2f7aafc..0f1fdaa0f 100644 --- a/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart +++ b/website/docs/migration/from_state_notifier/from_state_provider/from_state_provider.g.dart @@ -55,7 +55,7 @@ final class CounterNotifierProvider @override CounterNotifierProvider $copyWithBuild( int Function( - Ref, + Ref, CounterNotifier, ) build, ) { diff --git a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart index 56d0d7cb3..3ca538354 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles/old_lifecycles.g.dart @@ -54,7 +54,7 @@ final class MyNotifierProvider extends $NotifierProvider { @override MyNotifierProvider $copyWithBuild( int Function( - Ref, + Ref, MyNotifier, ) build, ) { diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart index bc223e302..02f0ae7a2 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_final/old_lifecycles_final.g.dart @@ -8,16 +8,14 @@ part of 'old_lifecycles_final.dart'; // RiverpodGenerator // ************************************************************************** -typedef DurationRef = Ref; - @ProviderFor(duration) const durationProvider = DurationProvider._(); final class DurationProvider extends $FunctionalProvider - with $Provider { + with $Provider { const DurationProvider._( {Duration Function( - DurationRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class DurationProvider extends $FunctionalProvider ); final Duration Function( - DurationRef ref, + Ref ref, )? _createCb; @override @@ -53,31 +51,29 @@ final class DurationProvider extends $FunctionalProvider @override DurationProvider $copyWithCreate( Duration Function( - DurationRef ref, + Ref ref, ) create, ) { return DurationProvider._(create: create); } @override - Duration create(DurationRef ref) { + Duration create(Ref ref) { final _$cb = _createCb ?? duration; return _$cb(ref); } } -String _$durationHash() => r'be282a34a01007c6f3e04447579609199306aecc'; - -typedef RepositoryRef = Ref<_MyRepo>; +String _$durationHash() => r'997cacfb78da8107053428dfc5515497354b50c6'; @ProviderFor(repository) const repositoryProvider = RepositoryProvider._(); final class RepositoryProvider extends $FunctionalProvider<_MyRepo, _MyRepo> - with $Provider<_MyRepo, RepositoryRef> { + with $Provider<_MyRepo> { const RepositoryProvider._( {_MyRepo Function( - RepositoryRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -91,7 +87,7 @@ final class RepositoryProvider extends $FunctionalProvider<_MyRepo, _MyRepo> ); final _MyRepo Function( - RepositoryRef ref, + Ref ref, )? _createCb; @override @@ -113,20 +109,20 @@ final class RepositoryProvider extends $FunctionalProvider<_MyRepo, _MyRepo> @override RepositoryProvider $copyWithCreate( _MyRepo Function( - RepositoryRef ref, + Ref ref, ) create, ) { return RepositoryProvider._(create: create); } @override - _MyRepo create(RepositoryRef ref) { + _MyRepo create(Ref ref) { final _$cb = _createCb ?? repository; return _$cb(ref); } } -String _$repositoryHash() => r'80732dff4b7c3731f85f4c5ae72c820ae349c7fe'; +String _$repositoryHash() => r'8c1b035ba722660550674e92444db7b6f25ac2a3'; @ProviderFor(MyNotifier) const myNotifierProvider = MyNotifierProvider._(); @@ -174,7 +170,7 @@ final class MyNotifierProvider extends $NotifierProvider { @override MyNotifierProvider $copyWithBuild( int Function( - Ref, + Ref, MyNotifier, ) build, ) { diff --git a/website/docs/providers/future_provider/config_provider/codegen.g.dart b/website/docs/providers/future_provider/config_provider/codegen.g.dart index f1b0f39d0..4464c19c8 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.g.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.g.dart @@ -8,19 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef FetchConfigurationRef = Ref>; - @ProviderFor(fetchConfiguration) const fetchConfigurationProvider = FetchConfigurationProvider._(); final class FetchConfigurationProvider extends $FunctionalProvider< AsyncValue, FutureOr> - with - $FutureModifier, - $FutureProvider { + with $FutureModifier, $FutureProvider { const FetchConfigurationProvider._( {FutureOr Function( - FetchConfigurationRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -34,7 +30,7 @@ final class FetchConfigurationProvider extends $FunctionalProvider< ); final FutureOr Function( - FetchConfigurationRef ref, + Ref ref, )? _createCb; @override @@ -49,14 +45,14 @@ final class FetchConfigurationProvider extends $FunctionalProvider< @override FetchConfigurationProvider $copyWithCreate( FutureOr Function( - FetchConfigurationRef ref, + Ref ref, ) create, ) { return FetchConfigurationProvider._(create: create); } @override - FutureOr create(FetchConfigurationRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? fetchConfiguration; return _$cb(ref); } diff --git a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart index bccf693f8..3f847060c 100644 --- a/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/remote_todos/codegen.g.dart @@ -64,7 +64,7 @@ final class AsyncTodosProvider @override AsyncTodosProvider $copyWithBuild( FutureOr> Function( - Ref>>, + Ref, AsyncTodos, ) build, ) { diff --git a/website/docs/providers/notifier_provider/todos/codegen.g.dart b/website/docs/providers/notifier_provider/todos/codegen.g.dart index 89844c69d..efd558a2c 100644 --- a/website/docs/providers/notifier_provider/todos/codegen.g.dart +++ b/website/docs/providers/notifier_provider/todos/codegen.g.dart @@ -54,7 +54,7 @@ final class TodosProvider extends $NotifierProvider> { @override TodosProvider $copyWithBuild( List Function( - Ref>, + Ref, Todos, ) build, ) { diff --git a/website/docs/providers/provider/completed_todos/completed_todos.g.dart b/website/docs/providers/provider/completed_todos/completed_todos.g.dart index 1c4e638cc..41474e4a3 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.g.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.g.dart @@ -8,17 +8,15 @@ part of 'completed_todos.dart'; // RiverpodGenerator // ************************************************************************** -typedef CompletedTodosRef = Ref>; - @ProviderFor(completedTodos) const completedTodosProvider = CompletedTodosProvider._(); final class CompletedTodosProvider extends $FunctionalProvider, List> - with $Provider, CompletedTodosRef> { + with $Provider> { const CompletedTodosProvider._( {List Function( - CompletedTodosRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class CompletedTodosProvider ); final List Function( - CompletedTodosRef ref, + Ref ref, )? _createCb; @override @@ -54,14 +52,14 @@ final class CompletedTodosProvider @override CompletedTodosProvider $copyWithCreate( List Function( - CompletedTodosRef ref, + Ref ref, ) create, ) { return CompletedTodosProvider._(create: create); } @override - List create(CompletedTodosRef ref) { + List create(Ref ref) { final _$cb = _createCb ?? completedTodos; return _$cb(ref); } diff --git a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart index 03ffbd16f..8d7ca5e1f 100644 --- a/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart +++ b/website/docs/providers/provider/optimized_previous_button/optimized_previous_button.g.dart @@ -54,7 +54,7 @@ final class PageIndexProvider extends $NotifierProvider { @override PageIndexProvider $copyWithBuild( int Function( - Ref, + Ref, PageIndex, ) build, ) { @@ -77,16 +77,14 @@ abstract class _$PageIndex extends $Notifier { int runBuild() => build(); } -typedef CanGoToPreviousPageRef = Ref; - @ProviderFor(canGoToPreviousPage) const canGoToPreviousPageProvider = CanGoToPreviousPageProvider._(); final class CanGoToPreviousPageProvider extends $FunctionalProvider - with $Provider { + with $Provider { const CanGoToPreviousPageProvider._( {bool Function( - CanGoToPreviousPageRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -100,7 +98,7 @@ final class CanGoToPreviousPageProvider extends $FunctionalProvider ); final bool Function( - CanGoToPreviousPageRef ref, + Ref ref, )? _createCb; @override @@ -122,14 +120,14 @@ final class CanGoToPreviousPageProvider extends $FunctionalProvider @override CanGoToPreviousPageProvider $copyWithCreate( bool Function( - CanGoToPreviousPageRef ref, + Ref ref, ) create, ) { return CanGoToPreviousPageProvider._(create: create); } @override - bool create(CanGoToPreviousPageRef ref) { + bool create(Ref ref) { final _$cb = _createCb ?? canGoToPreviousPage; return _$cb(ref); } diff --git a/website/docs/providers/provider/todo/todo.g.dart b/website/docs/providers/provider/todo/todo.g.dart index 27e1180bf..cb2d43165 100644 --- a/website/docs/providers/provider/todo/todo.g.dart +++ b/website/docs/providers/provider/todo/todo.g.dart @@ -54,7 +54,7 @@ final class TodosProvider extends $NotifierProvider> { @override TodosProvider $copyWithBuild( List Function( - Ref>, + Ref, Todos, ) build, ) { diff --git a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart index 7e9fc2b3d..f56618fca 100644 --- a/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart +++ b/website/docs/providers/provider/unoptimized_previous_button/unoptimized_previous_button.g.dart @@ -54,7 +54,7 @@ final class PageIndexProvider extends $NotifierProvider { @override PageIndexProvider $copyWithBuild( int Function( - Ref, + Ref, PageIndex, ) build, ) { diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart index 9566110bc..4c5c4e59b 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.g.dart @@ -8,17 +8,15 @@ part of 'codegen.dart'; // RiverpodGenerator // ************************************************************************** -typedef ChatRef = Ref>>; - @ProviderFor(chat) const chatProvider = ChatProvider._(); final class ChatProvider extends $FunctionalProvider>, Stream>> - with $FutureModifier>, $StreamProvider, ChatRef> { + with $FutureModifier>, $StreamProvider> { const ChatProvider._( {Stream> Function( - ChatRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class ChatProvider ); final Stream> Function( - ChatRef ref, + Ref ref, )? _createCb; @override @@ -47,14 +45,14 @@ final class ChatProvider @override ChatProvider $copyWithCreate( Stream> Function( - ChatRef ref, + Ref ref, ) create, ) { return ChatProvider._(create: create); } @override - Stream> create(ChatRef ref) { + Stream> create(Ref ref) { final _$cb = _createCb ?? chat; return _$cb(ref); } diff --git a/website/static/snippets/async.g.dart b/website/static/snippets/async.g.dart index 72b36c3ae..974da642c 100644 --- a/website/static/snippets/async.g.dart +++ b/website/static/snippets/async.g.dart @@ -8,19 +8,15 @@ part of 'async.dart'; // RiverpodGenerator // ************************************************************************** -typedef ConfigurationsRef = Ref>; - @ProviderFor(configurations) const configurationsProvider = ConfigurationsProvider._(); final class ConfigurationsProvider extends $FunctionalProvider< AsyncValue, FutureOr> - with - $FutureModifier, - $FutureProvider { + with $FutureModifier, $FutureProvider { const ConfigurationsProvider._( {FutureOr Function( - ConfigurationsRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -34,7 +30,7 @@ final class ConfigurationsProvider extends $FunctionalProvider< ); final FutureOr Function( - ConfigurationsRef ref, + Ref ref, )? _createCb; @override @@ -49,14 +45,14 @@ final class ConfigurationsProvider extends $FunctionalProvider< @override ConfigurationsProvider $copyWithCreate( FutureOr Function( - ConfigurationsRef ref, + Ref ref, ) create, ) { return ConfigurationsProvider._(create: create); } @override - FutureOr create(ConfigurationsRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? configurations; return _$cb(ref); } diff --git a/website/static/snippets/combine.g.dart b/website/static/snippets/combine.g.dart index 7a451f3a0..f11a03ee8 100644 --- a/website/static/snippets/combine.g.dart +++ b/website/static/snippets/combine.g.dart @@ -8,16 +8,14 @@ part of 'combine.dart'; // RiverpodGenerator // ************************************************************************** -typedef TodosRef = Ref>; - @ProviderFor(todos) const todosProvider = TodosProvider._(); final class TodosProvider extends $FunctionalProvider, List> - with $Provider, TodosRef> { + with $Provider> { const TodosProvider._( {List Function( - TodosRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -31,7 +29,7 @@ final class TodosProvider extends $FunctionalProvider, List> ); final List Function( - TodosRef ref, + Ref ref, )? _createCb; @override @@ -53,31 +51,29 @@ final class TodosProvider extends $FunctionalProvider, List> @override TodosProvider $copyWithCreate( List Function( - TodosRef ref, + Ref ref, ) create, ) { return TodosProvider._(create: create); } @override - List create(TodosRef ref) { + List create(Ref ref) { final _$cb = _createCb ?? todos; return _$cb(ref); } } -String _$todosHash() => r'146df519c4c2f843a867e4c6f5983259194f34fc'; - -typedef FilterRef = Ref; +String _$todosHash() => r'ed255140669430745a7779b542a1209dc182ce0c'; @ProviderFor(filter) const filterProvider = FilterProvider._(); final class FilterProvider extends $FunctionalProvider - with $Provider { + with $Provider { const FilterProvider._( {Filter Function( - FilterRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -91,7 +87,7 @@ final class FilterProvider extends $FunctionalProvider ); final Filter Function( - FilterRef ref, + Ref ref, )? _createCb; @override @@ -113,32 +109,30 @@ final class FilterProvider extends $FunctionalProvider @override FilterProvider $copyWithCreate( Filter Function( - FilterRef ref, + Ref ref, ) create, ) { return FilterProvider._(create: create); } @override - Filter create(FilterRef ref) { + Filter create(Ref ref) { final _$cb = _createCb ?? filter; return _$cb(ref); } } -String _$filterHash() => r'db6b594dad9378c59a08eaee9a1208065cb916eb'; - -typedef FilteredTodosRef = Ref>; +String _$filterHash() => r'38c5f61dc2d4b44e9be37bb724487d265cc0a645'; @ProviderFor(filteredTodos) const filteredTodosProvider = FilteredTodosProvider._(); final class FilteredTodosProvider extends $FunctionalProvider, List> - with $Provider, FilteredTodosRef> { + with $Provider> { const FilteredTodosProvider._( {List Function( - FilteredTodosRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -152,7 +146,7 @@ final class FilteredTodosProvider ); final List Function( - FilteredTodosRef ref, + Ref ref, )? _createCb; @override @@ -174,14 +168,14 @@ final class FilteredTodosProvider @override FilteredTodosProvider $copyWithCreate( List Function( - FilteredTodosRef ref, + Ref ref, ) create, ) { return FilteredTodosProvider._(create: create); } @override - List create(FilteredTodosRef ref) { + List create(Ref ref) { final _$cb = _createCb ?? filteredTodos; return _$cb(ref); } diff --git a/website/static/snippets/create.g.dart b/website/static/snippets/create.g.dart index 00f4cc70b..e9368f969 100644 --- a/website/static/snippets/create.g.dart +++ b/website/static/snippets/create.g.dart @@ -8,17 +8,15 @@ part of 'create.dart'; // RiverpodGenerator // ************************************************************************** -typedef BoredSuggestionRef = Ref>; - @ProviderFor(boredSuggestion) const boredSuggestionProvider = BoredSuggestionProvider._(); final class BoredSuggestionProvider extends $FunctionalProvider, FutureOr> - with $FutureModifier, $FutureProvider { + with $FutureModifier, $FutureProvider { const BoredSuggestionProvider._( {FutureOr Function( - BoredSuggestionRef ref, + Ref ref, )? create}) : _createCb = create, super( @@ -32,7 +30,7 @@ final class BoredSuggestionProvider ); final FutureOr Function( - BoredSuggestionRef ref, + Ref ref, )? _createCb; @override @@ -46,14 +44,14 @@ final class BoredSuggestionProvider @override BoredSuggestionProvider $copyWithCreate( FutureOr Function( - BoredSuggestionRef ref, + Ref ref, ) create, ) { return BoredSuggestionProvider._(create: create); } @override - FutureOr create(BoredSuggestionRef ref) { + FutureOr create(Ref ref) { final _$cb = _createCb ?? boredSuggestion; return _$cb(ref); } diff --git a/website/static/snippets/declare.g.dart b/website/static/snippets/declare.g.dart index cf1a890e9..8c3f82b4f 100644 --- a/website/static/snippets/declare.g.dart +++ b/website/static/snippets/declare.g.dart @@ -54,7 +54,7 @@ final class CountProvider extends $NotifierProvider { @override CountProvider $copyWithBuild( int Function( - Ref, + Ref, Count, ) build, ) { From 3f7bc940026123d2378b7dec5c8abda3a62f2a0a Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Nov 2024 16:34:22 +0100 Subject: [PATCH 357/387] Remove Ref type-arg --- examples/marvel/lib/src/marvel.dart | 2 +- .../flutter_riverpod/lib/src/builders.dart | 6 +-- .../legacy/change_notifier_provider.dart | 2 +- ...dispose_change_notifier_provider_test.dart | 19 ---------- .../change_notifier_provider_test.dart | 8 +--- packages/riverpod/lib/src/builder.dart | 30 +++++++-------- packages/riverpod/lib/src/core/family.dart | 37 ++++++++----------- .../core/provider/functional_provider.dart | 4 +- .../src/core/provider/notifier_provider.dart | 24 ++++++------ .../lib/src/core/provider/provider.dart | 4 +- packages/riverpod/lib/src/core/ref.dart | 3 -- .../lib/src/providers/async_notifier.dart | 3 +- .../src/providers/async_notifier/family.dart | 6 +-- .../src/providers/async_notifier/orphan.dart | 6 +-- .../lib/src/providers/future_provider.dart | 14 +++---- .../legacy/state_notifier_provider.dart | 2 +- .../src/providers/legacy/state_provider.dart | 4 +- .../riverpod/lib/src/providers/notifier.dart | 2 +- .../lib/src/providers/notifier/family.dart | 4 +- .../lib/src/providers/notifier/orphan.dart | 4 +- .../riverpod/lib/src/providers/provider.dart | 16 ++++---- .../lib/src/providers/stream_notifier.dart | 3 +- .../src/providers/stream_notifier/family.dart | 5 +-- .../src/providers/stream_notifier/orphan.dart | 4 +- .../lib/src/providers/stream_provider.dart | 14 +++---- .../state_notifier_provider_test.dart | 18 ++------- .../state_provider/state_provider_test.dart | 12 ++---- .../auto_dispose_future_provider_test.dart | 2 +- .../future_provider/future_provider_test.dart | 16 +++----- .../provider/auto_dispose_provider_test.dart | 4 +- .../provider/provider_test.dart | 16 +++----- .../auto_dispose_stream_provider_test.dart | 2 +- .../stream_provider/stream_provider_test.dart | 10 ++--- .../src/core/modifiers/select_async_test.dart | 2 +- packages/riverpod/test/src/core/ref_test.dart | 12 +++--- packages/riverpod/test/src/matrix.dart | 15 ++++---- .../src/matrix/async_notifier_provider.dart | 2 +- .../test/src/matrix/notifier_provider.dart | 2 +- .../src/matrix/stream_notifier_provider.dart | 2 +- .../src/providers/future_provider_test.dart | 4 +- .../src/providers/stream_notifier_test.dart | 2 +- packages/riverpod/test/src/utils.dart | 2 +- .../lib/src/riverpod_generator.dart | 19 +--------- .../lib/src/templates/family.dart | 6 +-- .../lib/src/templates/provider.dart | 10 ++--- .../lib/src/templates/ref.dart | 19 ---------- .../test/integration/async.dart | 2 +- .../test/integration/sync.dart | 4 +- .../golden/lib/constructor_providers.dart | 2 +- .../missing_dependencies2.dart | 19 ++++++---- .../bin/generate_providers.dart | 12 +----- .../family_and_dispose_old.dart | 2 +- 52 files changed, 167 insertions(+), 277 deletions(-) delete mode 100644 packages/riverpod_generator/lib/src/templates/ref.dart diff --git a/examples/marvel/lib/src/marvel.dart b/examples/marvel/lib/src/marvel.dart index 36f6aed18..594e04380 100644 --- a/examples/marvel/lib/src/marvel.dart +++ b/examples/marvel/lib/src/marvel.dart @@ -29,7 +29,7 @@ class MarvelRepository { }) : _getCurrentTimestamp = getCurrentTimestamp ?? (() => DateTime.now().millisecondsSinceEpoch); - final Ref ref; + final Ref ref; final int Function() _getCurrentTimestamp; final _characterCache = {}; diff --git a/packages/flutter_riverpod/lib/src/builders.dart b/packages/flutter_riverpod/lib/src/builders.dart index ba87dc02b..42e60ae7c 100644 --- a/packages/flutter_riverpod/lib/src/builders.dart +++ b/packages/flutter_riverpod/lib/src/builders.dart @@ -230,7 +230,7 @@ class ChangeNotifierProviderFamilyBuilder { /// {@endtemplate} ChangeNotifierProviderFamily call( - NotifierT Function(Ref ref, ArgT param) create, { + NotifierT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, Retry? retry, @@ -302,7 +302,7 @@ class AutoDisposeChangeNotifierProviderBuilder { /// {@macro riverpod.family} ChangeNotifierProvider call( - NotifierT Function(Ref ref) create, { + NotifierT Function(Ref ref) create, { String? name, Iterable? dependencies, Retry? retry, @@ -328,7 +328,7 @@ class AutoDisposeChangeNotifierProviderFamilyBuilder { /// {@macro riverpod.family} ChangeNotifierProviderFamily call( - NotifierT Function(Ref ref, ArgT param) create, { + NotifierT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, Retry? retry, 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 index 7baea1590..0c4816adb 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -145,7 +145,7 @@ final class ChangeNotifierProvider @visibleForOverriding @override ChangeNotifierProvider $copyWithCreate( - Create> create, + Create create, ) { return ChangeNotifierProvider.internal( create, diff --git a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart index e4793b463..9c15be3cf 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/auto_dispose_change_notifier_provider_test.dart @@ -3,9 +3,6 @@ import 'package:flutter/widgets.dart' hide Listener; import 'package:flutter_riverpod/src/internals.dart'; import 'package:flutter_test/flutter_test.dart'; -import 'package:mockito/mockito.dart'; - -import '../../utils.dart'; void main() { group('ChangeNotifierProvider.autoDispose', () { @@ -21,22 +18,6 @@ void main() { container.dispose(); }); - test('can read and set current ChangeNotifier', () async { - final container = ProviderContainer.test(); - final listener = Listener>(); - late Ref> ref; - final provider = - ChangeNotifierProvider.autoDispose>((r) { - ref = r; - return ValueNotifier(0); - }); - - container.listen(provider, listener.call); - - verifyZeroInteractions(listener); - expect(ref.state.value, 0); - }); - test('can refresh .notifier', () async { var initialValue = 1; final provider = ChangeNotifierProvider.autoDispose>( diff --git a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart index 09c69c11a..660c4b18b 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart @@ -38,12 +38,8 @@ void main() { final container = ProviderContainer.test( overrides: [ - provider.overrideWith( - (Ref> ref) => ValueNotifier(42), - ), - autoDispose.overrideWith( - (Ref> ref) => ValueNotifier(84), - ), + provider.overrideWith((ref) => ValueNotifier(42)), + autoDispose.overrideWith((ref) => ValueNotifier(84)), ], ); diff --git a/packages/riverpod/lib/src/builder.dart b/packages/riverpod/lib/src/builder.dart index eb530a5e6..219444bc6 100644 --- a/packages/riverpod/lib/src/builder.dart +++ b/packages/riverpod/lib/src/builder.dart @@ -229,7 +229,7 @@ class StateProviderFamilyBuilder { /// ``` /// {@endtemplate} StateProviderFamily call( - StateT Function(Ref ref, ArgT param) create, { + StateT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, Retry? retry, @@ -301,7 +301,7 @@ class AutoDisposeStateProviderBuilder { /// {@macro riverpod.family} StateProvider call( - StateT Function(Ref ref) create, { + StateT Function(Ref ref) create, { String? name, Iterable? dependencies, Retry? retry, @@ -326,7 +326,7 @@ class AutoDisposeStateProviderFamilyBuilder { /// {@macro riverpod.family} StateProviderFamily call( - StateT Function(Ref ref, ArgT param) create, { + StateT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, Retry? retry, @@ -348,7 +348,7 @@ class StateNotifierProviderFamilyBuilder { /// {@macro riverpod.family} StateNotifierProviderFamily call, StateT, ArgT>( - NotifierT Function(Ref ref, ArgT param) create, { + NotifierT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, Retry? retry, @@ -373,7 +373,7 @@ class AutoDisposeStateNotifierProviderBuilder { /// {@macro riverpod.family} StateNotifierProvider call, StateT>( - NotifierT Function(Ref ref) create, { + NotifierT Function(Ref ref) create, { String? name, Iterable? dependencies, Retry? retry, @@ -399,7 +399,7 @@ class AutoDisposeStateNotifierProviderFamilyBuilder { /// {@macro riverpod.family} StateNotifierProviderFamily call, StateT, ArgT>( - NotifierT Function(Ref ref, ArgT param) create, { + NotifierT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, Retry? retry, @@ -420,7 +420,7 @@ class ProviderFamilyBuilder { /// {@macro riverpod.family} ProviderFamily call( - StateT Function(Ref ref, ArgT param) create, { + StateT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, Retry? retry, @@ -444,7 +444,7 @@ class AutoDisposeProviderBuilder { /// {@macro riverpod.family} Provider call( - StateT Function(Ref ref) create, { + StateT Function(Ref ref) create, { String? name, Iterable? dependencies, Retry? retry, @@ -469,7 +469,7 @@ class AutoDisposeProviderFamilyBuilder { /// {@macro riverpod.family} ProviderFamily call( - StateT Function(Ref ref, ArgT param) create, { + StateT Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, Retry? retry, @@ -490,7 +490,7 @@ class FutureProviderFamilyBuilder { /// {@macro riverpod.family} FutureProviderFamily call( - FutureOr Function(Ref> ref, ArgT param) create, { + FutureOr Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, Retry? retry, @@ -514,7 +514,7 @@ class AutoDisposeFutureProviderBuilder { /// {@macro riverpod.family} FutureProvider call( - FutureOr Function(Ref> ref) create, { + FutureOr Function(Ref ref) create, { String? name, Iterable? dependencies, Retry? retry, @@ -539,7 +539,7 @@ class AutoDisposeFutureProviderFamilyBuilder { /// {@macro riverpod.family} FutureProviderFamily call( - FutureOr Function(Ref> ref, ArgT param) create, { + FutureOr Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, Retry? retry, @@ -560,7 +560,7 @@ class StreamProviderFamilyBuilder { /// {@macro riverpod.family} StreamProviderFamily call( - Stream Function(Ref> ref, ArgT param) create, { + Stream Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, Retry? retry, @@ -584,7 +584,7 @@ class AutoDisposeStreamProviderBuilder { /// {@macro riverpod.family} StreamProvider call( - Stream Function(Ref> ref) create, { + Stream Function(Ref ref) create, { String? name, Iterable? dependencies, Retry? retry, @@ -609,7 +609,7 @@ class AutoDisposeStreamProviderFamilyBuilder { /// {@macro riverpod.family} StreamProviderFamily call( - Stream Function(Ref> ref, ArgT param) create, { + Stream Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, Retry? retry, diff --git a/packages/riverpod/lib/src/core/family.dart b/packages/riverpod/lib/src/core/family.dart index 10dedc617..63e48623a 100644 --- a/packages/riverpod/lib/src/core/family.dart +++ b/packages/riverpod/lib/src/core/family.dart @@ -5,10 +5,9 @@ part of '../framework.dart'; typedef FunctionalProviderFactory< // ProviderT, CreatedT, - RefT extends Ref, ArgT> = ProviderT Function( - Create create, { + Create create, { required String? name, required List? dependencies, required List? allTransitiveDependencies, @@ -24,15 +23,13 @@ typedef ClassProviderFactory< // NotifierT, ProviderT, CreatedT, - RefT extends Ref, ArgT> = ProviderT Function( NotifierT Function() create, { required String? name, required Iterable? dependencies, required Iterable? allTransitiveDependencies, - required RunNotifierBuild? - runNotifierBuildOverride, + required RunNotifierBuild? runNotifierBuildOverride, required bool isAutoDispose, required Family from, required ArgT argument, @@ -41,8 +38,7 @@ typedef ClassProviderFactory< // /// A [Create] equivalent used by [Family]. @internal -typedef FamilyCreate, ArgT> = CreatedT - Function(RefT ref, ArgT arg); +typedef FamilyCreate = CreatedT Function(Ref ref, ArgT arg); /// A base class for all families abstract class Family extends ProviderOrFamily implements _FamilyOverride { @@ -85,7 +81,7 @@ class FunctionalFamily< // /// This API is not meant for public consumption. const FunctionalFamily( this._createFn, { - required FunctionalProviderFactory, ArgT> + required FunctionalProviderFactory providerFactory, required super.name, required super.dependencies, @@ -94,10 +90,9 @@ class FunctionalFamily< // required super.retry, }) : _providerFactory = providerFactory; - final FunctionalProviderFactory, ArgT> - _providerFactory; + final FunctionalProviderFactory _providerFactory; - final CreatedT Function(Ref ref, ArgT arg) _createFn; + final CreatedT Function(Ref ref, ArgT arg) _createFn; /// {@template family.call} /// Create a provider from an external value. @@ -123,7 +118,7 @@ class FunctionalFamily< // /// {@macro riverpod.override_with} Override overrideWith( - CreatedT Function(Ref ref, ArgT arg) create, + CreatedT Function(Ref ref, ArgT arg) create, ) { return $FamilyOverride( from: this, @@ -148,14 +143,14 @@ class FunctionalFamily< // /// This API is not meant for public consumption. @internal class ClassFamily< // - NotifierT extends NotifierBase< // + NotifierT extends NotifierBase< // + StateT, + CreatedT>, StateT, - CreatedT>, - StateT, - ArgT, - CreatedT, - ProviderT extends $ClassProvider>> extends Family { + ArgT, + CreatedT, + ProviderT extends $ClassProvider> + extends Family { /// A base implementation for [Family], used by the various providers to /// help them define a [Family]. /// @@ -171,7 +166,7 @@ class ClassFamily< // }); @internal - final ClassProviderFactory, ArgT> + final ClassProviderFactory providerFactory; final NotifierT Function() _createFn; @@ -208,7 +203,7 @@ class ClassFamily< // /// {@macro riverpod.override_with} Override overrideWithBuild( - RunNotifierBuild> build, + RunNotifierBuild build, ) { return $FamilyOverride( from: this, diff --git a/packages/riverpod/lib/src/core/provider/functional_provider.dart b/packages/riverpod/lib/src/core/provider/functional_provider.dart index c73ffce86..e34891e96 100644 --- a/packages/riverpod/lib/src/core/provider/functional_provider.dart +++ b/packages/riverpod/lib/src/core/provider/functional_provider.dart @@ -23,7 +23,7 @@ abstract base class $FunctionalProvider< // /// This is an implementation detail of Riverpod and should not be used. @visibleForOverriding $FunctionalProvider $copyWithCreate( - Create> create, + Create create, ); /// {@template riverpod.override_with} @@ -60,7 +60,7 @@ abstract base class $FunctionalProvider< // /// ); /// ``` /// {@endtemplate} - Override overrideWith(Create> create) { + Override overrideWith(Create create) { return $ProviderOverride( origin: this, providerOverride: $copyWithCreate(create), diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index 9c8edc781..a921c8585 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -24,11 +24,10 @@ This means that you tried to either: /// The prototype of `Notifier.build` overrides. @internal -typedef RunNotifierBuild< // - NotifierT, - CreatedT, - RefT extends Ref> - = CreatedT Function(RefT ref, NotifierT notifier); +typedef RunNotifierBuild = CreatedT Function( + Ref ref, + NotifierT notifier, +); /// A base class for all "notifiers". /// @@ -105,8 +104,7 @@ abstract base class $ClassProvider< // StateT, CreatedT>, StateT, - CreatedT, - RefT extends Ref> extends ProviderBase { + CreatedT> extends ProviderBase { const $ClassProvider({ required super.name, required super.from, @@ -128,19 +126,19 @@ abstract base class $ClassProvider< // } @internal - final RunNotifierBuild? runNotifierBuildOverride; + final RunNotifierBuild? runNotifierBuildOverride; @internal NotifierT create(); @visibleForOverriding - $ClassProvider $copyWithCreate( + $ClassProvider $copyWithCreate( NotifierT Function() create, ); @visibleForOverriding - $ClassProvider $copyWithBuild( - RunNotifierBuild build, + $ClassProvider $copyWithBuild( + RunNotifierBuild build, ); /// {@macro riverpod.override_with} @@ -155,7 +153,7 @@ abstract base class $ClassProvider< // /// Hello world /// {@endtemplate} Override overrideWithBuild( - RunNotifierBuild build, + RunNotifierBuild build, ) { return $ProviderOverride( origin: this, @@ -181,7 +179,7 @@ abstract class ClassProviderElement< // ClassProviderElement(super.pointer); @override - $ClassProvider> get provider; + $ClassProvider get provider; final classListenable = ProxyElementValueListenable(); diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index a9dd865eb..866e5bb19 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -13,9 +13,7 @@ part of '../../framework.dart'; /// - [Ref], which exposes the methods to read other providers. /// - [Provider], a provider that uses [Create] to expose an immutable value. @internal -typedef Create> = CreatedT Function( - RefT ref, -); +typedef Create = CreatedT Function(Ref ref); /// A callback used to catches errors @internal diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index d2b484aef..43d91fae5 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -64,14 +64,12 @@ base class Ref<@Deprecated('Will be removed in 3.0') StateT> { /// - on asynchronous providers, this will return an [AsyncLoading]. /// /// Will throw if the provider threw during creation. - @Deprecated('foo') StateT get state { _throwIfInvalidUsage(); return _element.readSelf(); } - @Deprecated('foo') set state(StateT newState) { _throwIfInvalidUsage(); @@ -607,7 +605,6 @@ final = Provider(dependencies: []); /// As opposed to [listen], the listener will be called even if /// [ProviderElement.updateShouldNotify] returns false, meaning that the previous /// and new value can potentially be identical. - @Deprecated('foo') void listenSelf( void Function(StateT? previous, StateT next) listener, { void Function(Object error, StackTrace stackTrace)? onError, diff --git a/packages/riverpod/lib/src/providers/async_notifier.dart b/packages/riverpod/lib/src/providers/async_notifier.dart index 380c73319..a0ec15738 100644 --- a/packages/riverpod/lib/src/providers/async_notifier.dart +++ b/packages/riverpod/lib/src/providers/async_notifier.dart @@ -27,8 +27,7 @@ abstract base class $AsyncNotifierProvider< // extends $ClassProvider< // NotifierT, AsyncValue, - FutureOr, - Ref>> // + FutureOr> // with $FutureModifier { /// Implementation detail of `riverpod_generator`. diff --git a/packages/riverpod/lib/src/providers/async_notifier/family.dart b/packages/riverpod/lib/src/providers/async_notifier/family.dart index 21142ea3c..18cc23b73 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/family.dart @@ -75,8 +75,7 @@ final class FamilyAsyncNotifierProvider< // FamilyAsyncNotifierProvider _copyWith({ NotifierT Function()? create, - RunNotifierBuild, Ref>>? - build, + RunNotifierBuild>? build, }) { return FamilyAsyncNotifierProvider._( create ?? _createNotifier, @@ -109,8 +108,7 @@ final class FamilyAsyncNotifierProvider< // @visibleForOverriding @override FamilyAsyncNotifierProvider $copyWithBuild( - RunNotifierBuild, Ref>>? - build, + RunNotifierBuild>? build, ) { return _copyWith(build: build); } diff --git a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart index a8d91f19f..d76222ee1 100644 --- a/packages/riverpod/lib/src/providers/async_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/async_notifier/orphan.dart @@ -104,8 +104,7 @@ final class AsyncNotifierProvider< // AsyncNotifierProvider _copyWith({ NotifierT Function()? create, - RunNotifierBuild, Ref>>? - build, + RunNotifierBuild>? build, }) { return AsyncNotifierProvider.internal( create ?? _createNotifier, @@ -132,8 +131,7 @@ final class AsyncNotifierProvider< // @visibleForOverriding @override AsyncNotifierProvider $copyWithBuild( - RunNotifierBuild, Ref>>? - build, + RunNotifierBuild>? build, ) { return _copyWith(build: build); } diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index a9ed4e201..c787add2a 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -12,8 +12,8 @@ import 'stream_provider.dart' show StreamProvider; /// Implementation detail of `riverpod_generator`. /// Do not use, as this may be removed at any time. @internal -base mixin $FutureProvider on ProviderBase> { - FutureOr create(RefT ref); +base mixin $FutureProvider on ProviderBase> { + FutureOr create(Ref ref); /// {@macro riverpod.override_with_value} Override overrideWithValue(AsyncValue value) { @@ -96,7 +96,7 @@ final class FutureProvider extends $FunctionalProvider, FutureOr> with $FutureModifier, - $FutureProvider>>, + $FutureProvider, LegacyProviderMixin> { /// {@macro riverpod.future_provider} FutureProvider( @@ -131,10 +131,10 @@ final class FutureProvider /// {@macro riverpod.family} static const family = FutureProviderFamilyBuilder(); - final Create, Ref>> _create; + final Create> _create; @override - FutureOr create(Ref> ref) => this._create(ref); + FutureOr create(Ref ref) => this._create(ref); @internal @override @@ -146,7 +146,7 @@ final class FutureProvider @visibleForOverriding @override FutureProvider $copyWithCreate( - Create, Ref>> create, + Create> create, ) { return FutureProvider.internal( create, @@ -171,7 +171,7 @@ class $FutureProviderElement extends ProviderElement> $FutureProviderElement(this.provider, super.pointer); @override - final $FutureProvider>> provider; + final $FutureProvider provider; @override void create( diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index de3fe65fb..93ec9bbe9 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -149,7 +149,7 @@ final class StateNotifierProvider< // @visibleForOverriding @override StateNotifierProvider $copyWithCreate( - Create> create, + Create create, ) { return StateNotifierProvider.internal( create, diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 4d1b3cdaa..dbdf23bc8 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -98,9 +98,7 @@ final class StateProvider extends $FunctionalProvider @mustBeOverridden @visibleForOverriding @override - StateProvider $copyWithCreate( - Create> create, - ) { + StateProvider $copyWithCreate(Create create) { return StateProvider.internal( create, name: name, diff --git a/packages/riverpod/lib/src/providers/notifier.dart b/packages/riverpod/lib/src/providers/notifier.dart index fbc720dfb..d2ced3d23 100644 --- a/packages/riverpod/lib/src/providers/notifier.dart +++ b/packages/riverpod/lib/src/providers/notifier.dart @@ -84,7 +84,7 @@ abstract class $Notifier extends NotifierBase { /// Do not use. abstract base class $NotifierProvider // , StateT> - extends $ClassProvider> { + extends $ClassProvider { /// An internal base class for [Notifier]. /// /// Not meant for public consumption. diff --git a/packages/riverpod/lib/src/providers/notifier/family.dart b/packages/riverpod/lib/src/providers/notifier/family.dart index 104328155..a1a51732d 100644 --- a/packages/riverpod/lib/src/providers/notifier/family.dart +++ b/packages/riverpod/lib/src/providers/notifier/family.dart @@ -49,7 +49,7 @@ final class FamilyNotifierProvider // FamilyNotifierProvider _copyWith({ NotifierT Function()? create, - RunNotifierBuild>? build, + RunNotifierBuild? build, }) { return FamilyNotifierProvider._( create ?? _createNotifier, @@ -68,7 +68,7 @@ final class FamilyNotifierProvider // @mustBeOverridden @visibleForOverriding FamilyNotifierProvider $copyWithBuild( - RunNotifierBuild> build, + RunNotifierBuild build, ) { return _copyWith(build: build); } diff --git a/packages/riverpod/lib/src/providers/notifier/orphan.dart b/packages/riverpod/lib/src/providers/notifier/orphan.dart index 86d4f6abe..b63a988f3 100644 --- a/packages/riverpod/lib/src/providers/notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/notifier/orphan.dart @@ -129,7 +129,7 @@ final class NotifierProvider, StateT> NotifierProvider _copyWith({ NotifierT Function()? create, - RunNotifierBuild>? build, + RunNotifierBuild? build, }) { return NotifierProvider.internal( create ?? _createNotifier, @@ -148,7 +148,7 @@ final class NotifierProvider, StateT> @visibleForOverriding @override NotifierProvider $copyWithBuild( - RunNotifierBuild>? build, + RunNotifierBuild? build, ) { return _copyWith(build: build); } diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 54d6355cb..a9536ed45 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -9,13 +9,13 @@ import 'stream_provider.dart' show StreamProvider; /// Implementation detail of `riverpod_generator`. /// Do not use, as this may be removed at any time. @internal -base mixin $Provider on ProviderBase { - StateT create(RefT ref); +base mixin $Provider on ProviderBase { + StateT create(Ref ref); } /// {@macro riverpod.provider} base class Provider extends $FunctionalProvider - with $Provider>, LegacyProviderMixin { + with $Provider, LegacyProviderMixin { /// {@macro riverpod.provider} Provider( this._create, { @@ -49,10 +49,10 @@ base class Provider extends $FunctionalProvider /// {@macro riverpod.family} static const family = ProviderFamilyBuilder(); - final Create> _create; + final Create _create; @override - StateT create(Ref ref) => _create(ref); + StateT create(Ref ref) => _create(ref); @internal @override @@ -63,9 +63,7 @@ base class Provider extends $FunctionalProvider @mustBeOverridden @visibleForOverriding @override - Provider $copyWithCreate( - Create> create, - ) { + Provider $copyWithCreate(Create create) { return Provider.internal( create, from: from, @@ -348,7 +346,7 @@ class $ProviderElement extends ProviderElement { $ProviderElement(this.provider, super.pointer); @override - final $Provider> provider; + final $Provider provider; @override void create(Ref ref, {required bool didChangeDependency}) { diff --git a/packages/riverpod/lib/src/providers/stream_notifier.dart b/packages/riverpod/lib/src/providers/stream_notifier.dart index e7ed41a05..c84e097e5 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier.dart @@ -28,8 +28,7 @@ abstract base class $StreamNotifierProvider< extends $ClassProvider< // NotifierT, AsyncValue, - Stream, - Ref>> // + Stream> // with $FutureModifier { /// Implementation detail of `riverpod_generator`. diff --git a/packages/riverpod/lib/src/providers/stream_notifier/family.dart b/packages/riverpod/lib/src/providers/stream_notifier/family.dart index d1a574297..7196ca061 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/family.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/family.dart @@ -64,8 +64,7 @@ final class FamilyStreamNotifierProvider< // NotifierT Function()? create, RunNotifierBuild< // NotifierT, - Stream, - Ref>>? + Stream>? build, }) { return FamilyStreamNotifierProvider._( @@ -85,7 +84,7 @@ final class FamilyStreamNotifierProvider< // @mustBeOverridden @visibleForOverriding FamilyStreamNotifierProvider $copyWithBuild( - RunNotifierBuild, Ref>> build, + RunNotifierBuild> build, ) { return _copyWith(build: build); } diff --git a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart index 153c6b6eb..d2ce95a05 100644 --- a/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart +++ b/packages/riverpod/lib/src/providers/stream_notifier/orphan.dart @@ -91,7 +91,7 @@ final class StreamNotifierProvider< // StreamNotifierProvider _copyWith({ NotifierT Function()? create, - RunNotifierBuild, Ref>>? build, + RunNotifierBuild>? build, }) { return StreamNotifierProvider.internal( create ?? _createNotifier, @@ -118,7 +118,7 @@ final class StreamNotifierProvider< // @visibleForOverriding @override StreamNotifierProvider $copyWithBuild( - RunNotifierBuild, Ref>>? build, + RunNotifierBuild>? build, ) { return _copyWith(build: build); } diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index 27befb850..eb4b995ea 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -13,8 +13,8 @@ import 'provider.dart' show Provider; /// Implementation detail of `riverpod_generator`. /// Do not use, as this may be removed at any time. @internal -base mixin $StreamProvider on ProviderBase> { - Stream create(RefT ref); +base mixin $StreamProvider on ProviderBase> { + Stream create(Ref ref); /// {@macro riverpod.override_with_value} Override overrideWithValue(AsyncValue value) { @@ -85,7 +85,7 @@ base class StreamProvider extends $FunctionalProvider, Stream> with $FutureModifier, - $StreamProvider>>, + $StreamProvider, LegacyProviderMixin> { /// {@macro riverpod.stream_provider} StreamProvider( @@ -120,10 +120,10 @@ base class StreamProvider /// {@macro riverpod.family} static const family = StreamProviderFamilyBuilder(); - final Create, Ref>> _create; + final Create> _create; @override - Stream create(Ref> ref) => _create(ref); + Stream create(Ref ref) => _create(ref); @internal @override @@ -135,7 +135,7 @@ base class StreamProvider @visibleForOverriding @override $FunctionalProvider, Stream> $copyWithCreate( - Create, Ref>> create, + Create> create, ) { return StreamProvider.internal( create, @@ -158,7 +158,7 @@ class $StreamProviderElement extends ProviderElement> $StreamProviderElement(this.provider, super.pointer); @override - final $StreamProvider>> provider; + final $StreamProvider provider; final _streamNotifier = ProxyElementValueListenable>(); final StreamController _streamController = diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart index 85c075959..5a6eacd19 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart @@ -39,12 +39,8 @@ void main() { ); final container = ProviderContainer.test( overrides: [ - provider.overrideWith( - (Ref ref) => TestNotifier(42), - ), - autoDispose.overrideWith( - (Ref ref) => TestNotifier(84), - ), + provider.overrideWith((ref) => TestNotifier(42)), + autoDispose.overrideWith((ref) => TestNotifier(84)), ], ); @@ -62,15 +58,9 @@ void main() { ); final container = ProviderContainer.test( overrides: [ - family.overrideWith( - (Ref ref, int arg) => TestNotifier(42 + arg), - ), + family.overrideWith((ref, int arg) => TestNotifier(42 + arg)), autoDisposeFamily.overrideWith( - ( - Ref ref, - int arg, - ) => - TestNotifier(84 + arg), + (ref, int arg) => TestNotifier(84 + arg), ), ], ); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart index 18063f6a3..93a282280 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart @@ -18,8 +18,8 @@ void main() { ); final container = ProviderContainer.test( overrides: [ - provider.overrideWith((Ref ref) => 42), - autoDispose.overrideWith((Ref ref) => 84), + provider.overrideWith((ref) => 42), + autoDispose.overrideWith((ref) => 84), ], ); @@ -34,12 +34,8 @@ void main() { ); final container = ProviderContainer.test( overrides: [ - family.overrideWith( - (Ref ref, int arg) => '42 $arg', - ), - autoDisposeFamily.overrideWith( - (Ref ref, int arg) => '84 $arg', - ), + family.overrideWith((ref, int arg) => '42 $arg'), + autoDisposeFamily.overrideWith((ref, int arg) => '84 $arg'), ], ); diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart index 66d559fee..6b76ae4d1 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart @@ -12,7 +12,7 @@ void main() { test('can read and set current AsyncValue', () { final container = ProviderContainer.test(); final listener = Listener>(); - late Ref> ref; + late Ref ref; final provider = FutureProvider.autoDispose((r) { ref = r; return 0; diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart index 700d50173..43382ef65 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart @@ -30,10 +30,8 @@ void main() { final autoDispose = FutureProvider.autoDispose((ref) => 0); final container = ProviderContainer.test( overrides: [ - provider.overrideWith((Ref> ref) => 42), - autoDispose.overrideWith( - (Ref> ref) => 84, - ), + provider.overrideWith((ref) => 42), + autoDispose.overrideWith((ref) => 84), ], ); @@ -86,12 +84,8 @@ void main() { ); final container = ProviderContainer.test( overrides: [ - family.overrideWith( - (Ref> ref, int arg) => '42 $arg', - ), - autoDisposeFamily.overrideWith( - (Ref> ref, int arg) => '84 $arg', - ), + family.overrideWith((ref, int arg) => '42 $arg'), + autoDisposeFamily.overrideWith((ref, int arg) => '84 $arg'), ], ); @@ -241,7 +235,7 @@ void main() { test('can read and set current AsyncValue', () { final container = ProviderContainer.test(); final listener = Listener>(); - late Ref> ref; + late Ref ref; final provider = FutureProvider((r) { ref = r; return 0; diff --git a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart index c8d937ef9..d59a7661b 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart @@ -12,7 +12,7 @@ void main() { test('can read and change current value', () { final container = ProviderContainer.test(); final listener = Listener(); - late Ref ref; + late Ref ref; final provider = Provider.autoDispose((r) { ref = r; return 0; @@ -98,7 +98,7 @@ void main() { () async { final container = ProviderContainer.test(); final listener = Listener(); - late Ref ref; + late Ref ref; final provider = Provider.autoDispose((r) { ref = r; return 0; diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart index 4dd928067..ea6cf7040 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart @@ -15,10 +15,8 @@ void main() { final autoDispose = Provider.autoDispose((ref) => 0); final container = ProviderContainer.test( overrides: [ - provider.overrideWith((Ref ref) => 42), - autoDispose.overrideWith( - (Ref ref) => 84, - ), + provider.overrideWith((ref) => 42), + autoDispose.overrideWith((ref) => 84), ], ); @@ -33,10 +31,8 @@ void main() { ); final container = ProviderContainer.test( overrides: [ - family.overrideWith((Ref ref, int arg) => '42 $arg'), - autoDisposeFamily.overrideWith( - (Ref ref, int arg) => '84 $arg', - ), + family.overrideWith((ref, int arg) => '42 $arg'), + autoDisposeFamily.overrideWith((ref, int arg) => '84 $arg'), ], ); @@ -78,7 +74,7 @@ void main() { test('can read and change current value', () { final container = ProviderContainer.test(); final listener = Listener(); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; return 0; @@ -151,7 +147,7 @@ void main() { () async { final container = ProviderContainer.test(); final listener = Listener(); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; return 0; diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart index 6bba9449c..907718f26 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart @@ -15,7 +15,7 @@ void main() { test('can read and set current AsyncValue', () async { final container = ProviderContainer.test(); final listener = Listener>(); - late Ref> ref; + late Ref ref; final provider = StreamProvider.autoDispose((r) { ref = r; return Stream.value(0); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart index 13d3e45b6..5b1b6a9af 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart @@ -26,11 +26,11 @@ void main() { ); final container = ProviderContainer.test( overrides: [ - provider.overrideWith((Ref> ref) { + provider.overrideWith((ref) { ref.state = const AsyncData(42); return Stream.value(43); }), - autoDispose.overrideWith((Ref> ref) { + autoDispose.overrideWith((ref) { ref.state = const AsyncData(84); return Stream.value(85); }), @@ -55,13 +55,13 @@ void main() { final container = ProviderContainer.test( overrides: [ family.overrideWith( - (Ref> ref, int arg) { + (ref, int arg) { ref.state = AsyncData('42 $arg'); return Stream.value('43 $arg'); }, ), autoDisposeFamily.overrideWith( - (Ref> ref, int arg) { + (ref, int arg) { ref.state = AsyncData('84 $arg'); return Stream.value('85 $arg'); }, @@ -174,7 +174,7 @@ void main() { test('can read and set current AsyncValue', () async { final container = ProviderContainer.test(); final listener = Listener>(); - late Ref> ref; + late Ref ref; final provider = StreamProvider((r) { ref = r; return Stream.value(0); diff --git a/packages/riverpod/test/src/core/modifiers/select_async_test.dart b/packages/riverpod/test/src/core/modifiers/select_async_test.dart index 9cc5fa94d..7f4d99390 100644 --- a/packages/riverpod/test/src/core/modifiers/select_async_test.dart +++ b/packages/riverpod/test/src/core/modifiers/select_async_test.dart @@ -198,7 +198,7 @@ void main() { test('handles multiple AsyncLoading at once then data', () async { final container = ProviderContainer.test(); - late Ref> ref; + late Ref ref; final provider = FutureProvider((r) { ref = r; final completer = Completer(); diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index e99419db8..0d0fe6692 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -349,7 +349,7 @@ void main() { test('supports asReload', () async { final container = ProviderContainer.test(); - late Ref> ref; + late Ref ref; final provider = FutureProvider((r) async { ref = r; return 0; @@ -601,7 +601,7 @@ void main() { final listener = Listener(); final listener2 = Listener(); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; ref.listenSelf(listener.call); @@ -826,7 +826,7 @@ void main() { test('does not invoke value listeners if paused', () { final container = ProviderContainer.test(); final listener = Listener(); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; return 0; @@ -1156,7 +1156,7 @@ void main() { test('cannot listen itself', () { final container = ProviderContainer.test(); final listener = Listener(); - late Ref ref; + late Ref ref; late Provider provider; provider = Provider((r) { ref = r; @@ -1856,7 +1856,7 @@ void main() { final listener = Listener(); final selfListener = Listener(); final container = ProviderContainer.test(observers: [observer]); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; ref.listenSelf(selfListener.call); @@ -2957,7 +2957,7 @@ void main() { group('mounted', () { test('stays false on older refs while new refs are building', () { final container = ProviderContainer.test(); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; return 0; diff --git a/packages/riverpod/test/src/matrix.dart b/packages/riverpod/test/src/matrix.dart index 09cd1bd27..eb0c0fa7a 100644 --- a/packages/riverpod/test/src/matrix.dart +++ b/packages/riverpod/test/src/matrix.dart @@ -31,9 +31,9 @@ class TestFactory { final bool isFamily; } -typedef ProviderFactory - = ProviderT Function([Object? arg]) Function( - BaseT Function(RefT ref, Object? arg) create, { +typedef ProviderFactory = ProviderT Function([Object? arg]) + Function( + BaseT Function(Ref ref, Object? arg) create, { String? name, Iterable? dependencies, Retry? retry, @@ -57,8 +57,7 @@ extension $Modifiers on ProviderBase { } } -final providerFactory = - , Ref>>[ +final providerFactory = >>[ (create, {name, dependencies, retry}) => ([arg]) { return Provider( (ref) => create(ref, arg), @@ -94,7 +93,7 @@ final providerFactory = ]; final futureProviderFactories = - , FutureProvider, Ref>>[ + , FutureProvider>>[ (create, {name, dependencies, retry}) => ([arg]) { return FutureProvider( (ref) => create(ref, arg), @@ -130,7 +129,7 @@ final futureProviderFactories = ]; final streamProviderFactories = - , StreamProvider, Ref>>[ + , StreamProvider>>[ (create, {name, dependencies, retry}) => ([arg]) { return StreamProvider( (ref) => create(ref, arg), @@ -166,7 +165,7 @@ final streamProviderFactories = ]; final asyncProviderFactory = - >, Ref>>[ + >>>[ for (final factory in futureProviderFactories) (create, {name, dependencies, retry}) => factory( (ref, arg) async => create(ref, arg), diff --git a/packages/riverpod/test/src/matrix/async_notifier_provider.dart b/packages/riverpod/test/src/matrix/async_notifier_provider.dart index 714660222..ad7e08124 100644 --- a/packages/riverpod/test/src/matrix/async_notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/async_notifier_provider.dart @@ -180,7 +180,7 @@ class DeferredFamilyAsyncNotifier } class AsyncNotifierTestFactory extends TestFactory< - ProviderFactory<$AsyncNotifier, ProviderBase, void>> { + ProviderFactory<$AsyncNotifier, ProviderBase>> { AsyncNotifierTestFactory({ required super.isAutoDispose, required super.isFamily, diff --git a/packages/riverpod/test/src/matrix/notifier_provider.dart b/packages/riverpod/test/src/matrix/notifier_provider.dart index 58971acd5..c72767ad0 100644 --- a/packages/riverpod/test/src/matrix/notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/notifier_provider.dart @@ -173,7 +173,7 @@ class DeferredFamilyNotifier extends FamilyNotifier } class NotifierTestFactory extends TestFactory< - ProviderFactory<$Notifier, ProviderBase, void>> { + ProviderFactory<$Notifier, ProviderBase>> { NotifierTestFactory({ required super.isAutoDispose, required super.isFamily, diff --git a/packages/riverpod/test/src/matrix/stream_notifier_provider.dart b/packages/riverpod/test/src/matrix/stream_notifier_provider.dart index c141cd236..456c0c349 100644 --- a/packages/riverpod/test/src/matrix/stream_notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/stream_notifier_provider.dart @@ -185,7 +185,7 @@ class DeferredFamilyStreamNotifier } class StreamNotifierTestFactory extends TestFactory< - ProviderFactory<$StreamNotifier, ProviderBase, void>> { + ProviderFactory<$StreamNotifier, ProviderBase>> { StreamNotifierTestFactory({ required super.isAutoDispose, required super.isFamily, diff --git a/packages/riverpod/test/src/providers/future_provider_test.dart b/packages/riverpod/test/src/providers/future_provider_test.dart index c202622be..5d42a98b1 100644 --- a/packages/riverpod/test/src/providers/future_provider_test.dart +++ b/packages/riverpod/test/src/providers/future_provider_test.dart @@ -11,7 +11,7 @@ void main() { group('FutureProvider', () { test('resets progress to 0 if restarting while the future is pending', () { final container = ProviderContainer.test(); - late Ref> ref; + late Ref ref; final completer = Completer(); addTearDown(() => completer.complete(42)); @@ -69,7 +69,7 @@ void main() { () => fakeAsync((fake) async { final container = ProviderContainer.test(); var retryCount = 0; - late Ref> r; + late Ref r; final provider = FutureProvider( (ref) { r = ref; diff --git a/packages/riverpod/test/src/providers/stream_notifier_test.dart b/packages/riverpod/test/src/providers/stream_notifier_test.dart index 1482d64bf..910cadc2d 100644 --- a/packages/riverpod/test/src/providers/stream_notifier_test.dart +++ b/packages/riverpod/test/src/providers/stream_notifier_test.dart @@ -137,7 +137,7 @@ void main() { () => fakeAsync((fake) async { final container = ProviderContainer.test(); var retryCount = 0; - late Ref> r; + late Ref r; final provider = FutureProvider( (ref) { r = ref; diff --git a/packages/riverpod/test/src/utils.dart b/packages/riverpod/test/src/utils.dart index 6705992f7..d2344bcf3 100644 --- a/packages/riverpod/test/src/utils.dart +++ b/packages/riverpod/test/src/utils.dart @@ -119,7 +119,7 @@ class OverrideWithBuildMock extends Mock { final CreatedT fallback; - CreatedT call(Ref? ref, NotifierT? value) { + CreatedT call(Ref? ref, NotifierT? value) { return super.noSuchMethod( Invocation.method(#call, [ref, value]), returnValue: fallback, diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index ae1a51f77..a7f434293 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -16,7 +16,6 @@ import 'templates/notifier.dart'; import 'templates/parameters.dart'; import 'templates/provider.dart'; import 'templates/provider_variable.dart'; -import 'templates/ref.dart'; import 'type.dart'; String providerDocFor(Element element) { @@ -209,7 +208,6 @@ class _RiverpodGeneratorVisitor { void visitFunctionalProviderDeclaration( FunctionalProviderDeclaration provider, ) { - RefTemplate(provider).run(buffer); visitGeneratorProviderDeclaration(provider); } } @@ -229,10 +227,6 @@ extension ProviderElementNames on GeneratorProviderDeclarationElement { } String get providerTypeName => '${name.titled}Provider'; - String get refImplName => switch (this) { - ClassBasedProviderDeclarationElement() => 'Ref', - FunctionalProviderDeclarationElement() => '${name.titled}Ref' - }; String get familyTypeName => '${name.titled}Family'; @@ -285,7 +279,6 @@ extension ProviderNames on GeneratorProviderDeclaration { } String get providerTypeName => providerElement.providerTypeName; - String get refImplName => providerElement.refImplName; String get familyTypeName => providerElement.familyTypeName; @@ -355,13 +348,6 @@ extension ProviderNames on GeneratorProviderDeclaration { String genericsDefinition() => _genericDefinitionDisplayString(typeParameters); - String get refWithGenerics { - return switch (this) { - FunctionalProviderDeclaration() => '$refImplName${generics()}', - ClassBasedProviderDeclaration() => 'Ref<$exposedTypeDisplayString>', - }; - } - String notifierBuildType({ bool withGenericDefinition = false, bool withArguments = false, @@ -377,7 +363,7 @@ extension ProviderNames on GeneratorProviderDeclaration { ) : ''; - return '$createdTypeDisplayString Function$genericsDefinition($refWithGenerics, $notifierType, $parameters)'; + return '$createdTypeDisplayString Function$genericsDefinition(Ref, $notifierType, $parameters)'; } String createType({ @@ -398,8 +384,7 @@ extension ProviderNames on GeneratorProviderDeclaration { ) : ''; - final refType = '${provider.refImplName}$generics'; - return '${provider.createdTypeDisplayString} Function$genericsDefinition($refType ref, $params)'; + return '${provider.createdTypeDisplayString} Function$genericsDefinition(Ref ref, $params)'; case ClassBasedProviderDeclaration(): return '${provider.name}$generics Function$genericsDefinition()'; } diff --git a/packages/riverpod_generator/lib/src/templates/family.dart b/packages/riverpod_generator/lib/src/templates/family.dart index bab9edc40..14145855d 100644 --- a/packages/riverpod_generator/lib/src/templates/family.dart +++ b/packages/riverpod_generator/lib/src/templates/family.dart @@ -93,9 +93,9 @@ ${provider.doc} final class ${provider.familyTypeName} extends Family { }) { final createType = switch (provider) { FunctionalProviderDeclaration(parameters: [_, ...]) => - '${provider.createdTypeDisplayString} Function$_genericsDefinition(${provider.refWithGenerics} ref, $_argumentRecordType args,)', + '${provider.createdTypeDisplayString} Function$_genericsDefinition(Ref ref, $_argumentRecordType args,)', FunctionalProviderDeclaration(parameters: []) => - '${provider.createdTypeDisplayString} Function$_genericsDefinition(${provider.refWithGenerics} ref)', + '${provider.createdTypeDisplayString} Function$_genericsDefinition(Ref ref)', ClassBasedProviderDeclaration(parameters: [_, ...]) => '$_notifierType Function$_genericsDefinition($_argumentRecordType args,)', ClassBasedProviderDeclaration() => @@ -172,7 +172,7 @@ Override overrideWith($createType create,) { }) { final runNotifierBuildType = ''' ${provider.createdTypeDisplayString} Function$_genericsDefinition( - ${provider.refWithGenerics} ref, + Ref ref, $_notifierType notifier ${switch (provider.parameters) { [] => '', diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 150f772ce..3c0b49614 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -22,8 +22,6 @@ class ProviderTemplate extends Template { late final _generics = provider.generics(); late final _genericsDefinition = provider.genericsDefinition(); - late final _refType = provider.refWithGenerics; - @override void run(StringBuffer buffer) { final provider = this.provider; @@ -41,15 +39,15 @@ class ProviderTemplate extends Template { case SupportedCreatedType.future: modifiers = [ '\$FutureModifier<$valueType>', - '\$FutureProvider<$valueType, $_refType>', + '\$FutureProvider<$valueType>', ]; case SupportedCreatedType.stream: modifiers = [ '\$FutureModifier<$valueType>', - '\$StreamProvider<$valueType, $_refType>', + '\$StreamProvider<$valueType>', ]; case SupportedCreatedType.value: - modifiers = ['\$Provider<$valueType, $_refType>']; + modifiers = ['\$Provider<$valueType>']; } final mixins = modifiers.isEmpty ? '' : ' with ${modifiers.join(', ')}'; @@ -270,7 +268,7 @@ ${provider.doc} final class $name$_genericsDefinition void _writeFunctionalCreate(StringBuffer buffer) { buffer.write(''' @override - ${provider.createdTypeDisplayString} create(${provider.refImplName}$_generics ref) { + ${provider.createdTypeDisplayString} create(Ref ref) { final _\$cb = _createCb ?? ${provider.name}$_generics; '''); diff --git a/packages/riverpod_generator/lib/src/templates/ref.dart b/packages/riverpod_generator/lib/src/templates/ref.dart deleted file mode 100644 index 88aaa9ae0..000000000 --- a/packages/riverpod_generator/lib/src/templates/ref.dart +++ /dev/null @@ -1,19 +0,0 @@ -import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; - -import '../riverpod_generator.dart'; -import 'template.dart'; - -class RefTemplate extends Template { - RefTemplate(this.provider); - - final FunctionalProviderDeclaration provider; - - @override - void run(StringBuffer buffer) { - final typeParametersDefinition = provider.genericsDefinition(); - - buffer.writeln(''' -${provider.doc} typedef ${provider.refImplName}$typeParametersDefinition = Ref<${provider.exposedTypeDisplayString}>; -'''); - } -} diff --git a/packages/riverpod_generator/test/integration/async.dart b/packages/riverpod_generator/test/integration/async.dart index e4a16b5cb..0672af81a 100644 --- a/packages/riverpod_generator/test/integration/async.dart +++ b/packages/riverpod_generator/test/integration/async.dart @@ -3,7 +3,7 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'async.g.dart'; @riverpod -Future> generic(Ref ref) async { +Future> generic(Ref ref) async { return []; } diff --git a/packages/riverpod_generator/test/integration/sync.dart b/packages/riverpod_generator/test/integration/sync.dart index 3dac18300..1f0460bfe 100644 --- a/packages/riverpod_generator/test/integration/sync.dart +++ b/packages/riverpod_generator/test/integration/sync.dart @@ -158,7 +158,7 @@ class FamilyClass extends _$FamilyClass with MyMixin { } @riverpod -String supports$InFnName(Supports$InFnNameRef ref) { +String supports$InFnName(Ref ref) { return 'Hello world'; } @@ -166,7 +166,7 @@ const default$value = ''; @riverpod String supports$InFnNameFamily( - Supports$InFnNameFamilyRef ref, + Ref ref, And$InT positional$arg, { required And$InT named$arg, String defaultArg = default$value, diff --git a/packages/riverpod_graph/test/integration/addition/golden/lib/constructor_providers.dart b/packages/riverpod_graph/test/integration/addition/golden/lib/constructor_providers.dart index e77743866..c6988e5f2 100644 --- a/packages/riverpod_graph/test/integration/addition/golden/lib/constructor_providers.dart +++ b/packages/riverpod_graph/test/integration/addition/golden/lib/constructor_providers.dart @@ -17,7 +17,7 @@ class MarvelRepository { }) : _getCurrentTimestamp = getCurrentTimestamp ?? (() => DateTime.now().millisecondsSinceEpoch); - final Ref ref; + final Ref ref; final int Function() _getCurrentTimestamp; } diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart index e27c76210..bfd48ef09 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart @@ -120,11 +120,14 @@ int watchGeneratedScopedAndContainsDependency( return ref.watch(generatedScopedProvider); } -@Riverpod(dependencies: [ - // The dependency is redundant because it is not a scoped provider - // expect_lint: provider_dependencies - generatedRoot, -]) +@Riverpod( + dependencies: + // The dependency is redundant because it is not a scoped provider + // expect_lint: provider_dependencies + [ + generatedRoot, + ], +) int watchGeneratedRootAndContainsDependency( Ref ref, ) { @@ -133,9 +136,11 @@ int watchGeneratedRootAndContainsDependency( // A dependency is specified but never used -@Riverpod(dependencies: [ +@Riverpod(dependencies: + // generatedRoot is extra + // expect_lint: provider_dependencies + [ dep, - // expect_lint: provider_dependencies generatedRoot, ]) int specifiedDependencyButNeverUsed(Ref ref) { diff --git a/tools/generate_providers/bin/generate_providers.dart b/tools/generate_providers/bin/generate_providers.dart index d4b524d06..e374260d0 100644 --- a/tools/generate_providers/bin/generate_providers.dart +++ b/tools/generate_providers/bin/generate_providers.dart @@ -39,11 +39,9 @@ class _FunctionalBuilder extends _Builder { required super.genericsDefinition, required super.genericsUsage, required this.createdT, - required this.refT, }); final String createdT; - final String refT; } class _NotifierBuilder extends _Builder { @@ -95,7 +93,6 @@ Future main(List args) async { genericsUsage: 'StateT', genericsDefinition: 'StateT', createdT: 'StateT', - refT: 'Ref', ), _FunctionalBuilder( 'StateNotifierProvider', @@ -103,28 +100,24 @@ Future main(List args) async { genericsDefinition: 'NotifierT extends StateNotifier, StateT', createdT: 'NotifierT', - refT: 'Ref', ), _FunctionalBuilder( 'Provider', genericsUsage: 'StateT', genericsDefinition: 'StateT', createdT: 'StateT', - refT: 'Ref', ), _FunctionalBuilder( 'FutureProvider', genericsUsage: 'StateT', genericsDefinition: 'StateT', createdT: 'FutureOr', - refT: 'Ref>', ), _FunctionalBuilder( 'StreamProvider', genericsUsage: 'StateT', genericsDefinition: 'StateT', createdT: 'Stream', - refT: 'Ref>', ), _NotifierBuilder( 'NotifierProvider', @@ -190,7 +183,6 @@ import 'internals.dart'; genericsUsage: 'NotifierT', genericsDefinition: 'NotifierT extends ChangeNotifier?', createdT: 'NotifierT', - refT: 'Ref', ), ], kinds: _ProviderKind.values, @@ -260,7 +252,7 @@ class $builderName { $familyDoc ${provider.providerName}Family<${provider.genericsUsage}, ArgT> call<${provider.genericsDefinition}, ArgT>( - ${provider.createdT} Function(${provider.refT} ref, ArgT param) create, { + ${provider.createdT} Function(Ref ref, ArgT param) create, { String? name, Iterable? dependencies, Retry? retry, @@ -296,7 +288,7 @@ class $builderName { $familyDoc ${provider.providerName}<${provider.genericsUsage}> call<${provider.genericsDefinition}>( - ${provider.createdT} Function(${provider.refT} ref) create, { + ${provider.createdT} Function(Ref ref) create, { String? name, Iterable? dependencies, Retry? retry, diff --git a/website/docs/migration/from_state_notifier/family_and_dispose_old.dart b/website/docs/migration/from_state_notifier/family_and_dispose_old.dart index f01455cf7..113594ef1 100644 --- a/website/docs/migration/from_state_notifier/family_and_dispose_old.dart +++ b/website/docs/migration/from_state_notifier/family_and_dispose_old.dart @@ -14,7 +14,7 @@ class BugsEncounteredNotifier extends StateNotifier> { required this.featureId, }) : super(const AsyncData(99)); final String featureId; - final Ref> ref; + final Ref ref; Future fix(int amount) async { state = await AsyncValue.guard(() async { From 6082367c26bb61975ead7729e723175fd6e33b65 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Fri, 1 Nov 2024 17:08:14 +0100 Subject: [PATCH 358/387] Ref => Ref --- examples/pub/lib/detail.dart | 2 +- .../legacy/change_notifier_provider.dart | 6 +- .../flutter_riverpod/test/provider_test.dart | 2 +- .../change_notifier_provider_test.dart | 11 ++-- packages/riverpod/lib/src/core/element.dart | 10 +-- .../lib/src/core/override_with_value.dart | 2 +- .../src/core/provider/notifier_provider.dart | 16 +++-- packages/riverpod/lib/src/core/ref.dart | 4 +- .../lib/src/providers/future_provider.dart | 2 +- .../legacy/state_notifier_provider.dart | 4 +- .../src/providers/legacy/state_provider.dart | 4 +- .../riverpod/lib/src/providers/provider.dart | 2 +- .../lib/src/providers/stream_provider.dart | 2 +- .../old/legacy/framework2/framework_test.dart | 2 +- .../test/old/legacy/framework_test.dart | 2 +- ..._dispose_state_notifier_provider_test.dart | 2 +- .../state_notifier_provider_test.dart | 2 +- .../riverpod/test/src/core/family_test.dart | 4 +- packages/riverpod/test/src/core/ref_test.dart | 64 +++++++++---------- packages/riverpod/test/src/matrix.dart | 2 +- .../src/matrix/async_notifier_provider.dart | 10 +-- .../test/src/matrix/notifier_provider.dart | 10 +-- .../src/matrix/stream_notifier_provider.dart | 10 +-- .../test/ref_invocation_test.dart | 2 +- .../lib/src/riverpod_annotation.dart | 2 +- .../functional_ref/functional_ref_lint.md | 2 +- .../unknown_scoped_usage_lint.md | 2 +- .../test/lints/unknown_scoped_usage.dart | 2 +- .../docs/case_studies/cancel/extension.dart | 2 +- website/docs/concepts/combining_providers.mdx | 2 +- .../docs/concepts/reading/counter/raw.dart | 2 +- .../shared_pipe_change_notifier.dart | 2 +- .../old_lifecycles_old.dart | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading_counter.dart | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading_counter.dart | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading.mdx | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading_counter.dart | 2 +- .../case_studies/cancel/extension.dart | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading_counter.dart | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/combining_providers.mdx | 2 +- .../current/concepts/reading_counter.dart | 2 +- .../case_studies/cancel/extension.dart | 2 +- .../current/concepts/combining_providers.mdx | 2 +- 50 files changed, 115 insertions(+), 114 deletions(-) diff --git a/examples/pub/lib/detail.dart b/examples/pub/lib/detail.dart index 676b8aa14..c1b15ff97 100644 --- a/examples/pub/lib/detail.dart +++ b/examples/pub/lib/detail.dart @@ -13,7 +13,7 @@ import 'search.dart'; part 'detail.g.dart'; -extension CancelTokenX on Ref { +extension CancelTokenX on Ref { CancelToken cancelToken() { final cancelToken = CancelToken(); onDispose(cancelToken.cancel); 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 index 0c4816adb..9d3d814b9 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -131,7 +131,7 @@ final class ChangeNotifierProvider /// has changes. Refreshable get notifier => _notifier(this); - final NotifierT Function(Ref ref) _createFn; + final NotifierT Function(Ref ref) _createFn; @internal @override @@ -172,7 +172,7 @@ class ChangeNotifierProviderElement void Function()? _removeListener; @override - void create(Ref ref, {required bool didChangeDependency}) { + void create(Ref ref, {required bool didChangeDependency}) { final notifierResult = _notifierNotifier.result = Result.guard( () => provider._createFn(ref), ); @@ -238,7 +238,7 @@ class ChangeNotifierProviderFamily @override Override overrideWith( - NotifierT Function(Ref ref, Arg arg) create, + NotifierT Function(Ref ref, Arg arg) create, ) { return $FamilyOverride( from: this, diff --git a/packages/flutter_riverpod/test/provider_test.dart b/packages/flutter_riverpod/test/provider_test.dart index 5c6b9d8f8..202eadeaf 100644 --- a/packages/flutter_riverpod/test/provider_test.dart +++ b/packages/flutter_riverpod/test/provider_test.dart @@ -290,7 +290,7 @@ void main() { final provider = Provider((_) => 42); // These check the type safety - Ref? ref; + Ref? ref; final Provider provider1 = Provider((r) { final first = r.watch(provider); diff --git a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart index 660c4b18b..ee2b44b28 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart @@ -57,12 +57,9 @@ void main() { ); final container = ProviderContainer.test( overrides: [ - family.overrideWith( - (Ref> ref, int arg) => ValueNotifier('42 $arg'), - ), - autoDisposeFamily.overrideWith( - (Ref> ref, int arg) => ValueNotifier('84 $arg'), - ), + family.overrideWith((ref, int arg) => ValueNotifier('42 $arg')), + autoDisposeFamily + .overrideWith((ref, int arg) => ValueNotifier('84 $arg')), ], ); @@ -100,7 +97,7 @@ void main() { test('can read and set current ChangeNotifier', () async { final container = ProviderContainer.test(); final listener = Listener>(); - late Ref> ref; + late Ref ref; final provider = ChangeNotifierProvider>((r) { ref = r; return ValueNotifier(0); diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 53e0b9b97..3e409da77 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -72,7 +72,7 @@ abstract class ProviderElement implements Node { /// The [ProviderContainer] that owns this [ProviderElement]. ProviderContainer get container => pointer.targetContainer; - Ref? ref; + Ref? ref; /// Whether this [ProviderElement] is actively in use. /// @@ -229,7 +229,7 @@ This could mean a few things: _debugCurrentCreateHash = provider.debugGetCreateSourceHash(); } - final ref = this.ref = Ref._(this); + final ref = this.ref = Ref._(this); buildState(ref); _notifyListeners( @@ -254,7 +254,7 @@ This could mean a few things: /// to dependencies that are no-longer used. void _performBuild() { runOnDispose(); - final ref = this.ref = Ref._(this); + final ref = this.ref = Ref._(this); final previousStateResult = _stateResult; if (kDebugMode) _debugDidSetState = false; @@ -282,7 +282,7 @@ This could mean a few things: /// - [didChangeDependency] can be used to differentiate a rebuild caused /// by [Ref.watch] from one caused by [Ref.refresh]/[Ref.invalidate]. @visibleForOverriding - void create(Ref ref, {required bool didChangeDependency}); + void create(Ref ref, {required bool didChangeDependency}); /// A utility for re-initializing a provider when needed. /// @@ -323,7 +323,7 @@ This could mean a few things: /// Invokes [create] and handles errors. @internal - void buildState(Ref ref) { + void buildState(Ref ref) { if (_didChangeDependency) _retryCount = 0; ProviderElement? debugPreviouslyBuildingElement; diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index b7b16fc13..670b85968 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -72,7 +72,7 @@ class _ValueProviderElement extends ProviderElement { void _setValue(StateT value) => setStateResult(ResultData(value)); @override - void create(Ref ref, {required bool didChangeDependency}) { + void create(Ref ref, {required bool didChangeDependency}) { _setValue(provider._value); } diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index a921c8585..7af0e7fff 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -54,10 +54,10 @@ typedef RunNotifierBuild = CreatedT Function( /// } /// ``` abstract class NotifierBase { - Ref? _ref; + Ref? _ref; @protected - Ref get ref { + Ref get ref { final ref = _ref; if (ref == null) throw StateError(uninitializedElementError); @@ -75,12 +75,15 @@ abstract class NotifierBase { void Function(StateT? previous, StateT next) listener, { void Function(Object error, StackTrace stackTrace)? onError, }) { - ref.listenSelf(listener, onError: onError); + ref.listenSelf( + (prev, next) => listener(prev as StateT?, next as StateT), + onError: onError, + ); } @visibleForTesting @protected - StateT get state => ref.state; + StateT get state => ref.state as StateT; @visibleForTesting @protected @@ -94,7 +97,8 @@ abstract class NotifierBase { @internal extension ClassBaseX on NotifierBase { - ProviderElement? get element => _ref?._element; + ProviderElement? get element => + _ref?._element as ProviderElement?; } /// Implementation detail of `riverpod_generator`. @@ -186,7 +190,7 @@ abstract class ClassProviderElement< // @mustCallSuper @override void create( - Ref ref, { + Ref ref, { required bool didChangeDependency, }) { final seamless = !didChangeDependency; diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 43d91fae5..746a8a978 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -1,7 +1,7 @@ part of '../framework.dart'; @internal -extension $RefArg on Ref { +extension $RefArg on Ref { // Implementation detail, do not use Object? get $arg => _element.origin.argument; @@ -412,7 +412,7 @@ final = Provider(dependencies: []); /// class MyService { /// MyService(this.ref); /// - /// final Ref ref; + /// final Ref ref; /// /// Future fetchUser() { /// // We read the current configurations, but do not care about diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index c787add2a..6c5bea9c2 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -175,7 +175,7 @@ class $FutureProviderElement extends ProviderElement> @override void create( - Ref> ref, { + Ref ref, { required bool didChangeDependency, }) { handleFuture( diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index 93ec9bbe9..60f8bd8ae 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -118,7 +118,7 @@ final class StateNotifierProvider< // /// {@macro riverpod.family} static const family = StateNotifierProviderFamilyBuilder(); - final NotifierT Function(Ref ref) _create; + final NotifierT Function(Ref ref) _create; /// Obtains the [StateNotifier] associated with this provider, without listening /// to state changes. @@ -177,7 +177,7 @@ class StateNotifierProviderElement, void Function()? _removeListener; @override - void create(Ref ref, {required bool didChangeDependency}) { + void create(Ref ref, {required bool didChangeDependency}) { final notifier = _notifierNotifier.result = Result.guard( () => provider._create(ref), ); diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index dbdf23bc8..ed2ca1c31 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -83,7 +83,7 @@ final class StateProvider extends $FunctionalProvider /// {@macro riverpod.family} static const family = StateProviderFamilyBuilder(); - final StateT Function(Ref ref) _createFn; + final StateT Function(Ref ref) _createFn; Refreshable> get notifier => _notifier(this); @@ -127,7 +127,7 @@ class StateProviderElement extends ProviderElement { @override void create( - Ref ref, { + Ref ref, { required bool didChangeDependency, }) { final initialState = provider._createFn(ref); diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index a9536ed45..26cab11fa 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -349,7 +349,7 @@ class $ProviderElement extends ProviderElement { final $Provider provider; @override - void create(Ref ref, {required bool didChangeDependency}) { + void create(Ref ref, {required bool didChangeDependency}) { setStateResult(ResultData(provider.create(ref))); } diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index eb4b995ea..a87e0bc6e 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -166,7 +166,7 @@ class $StreamProviderElement extends ProviderElement> @override void create( - Ref> ref, { + Ref ref, { required bool didChangeDependency, }) { asyncTransition(AsyncLoading(), seamless: !didChangeDependency); diff --git a/packages/riverpod/test/old/legacy/framework2/framework_test.dart b/packages/riverpod/test/old/legacy/framework2/framework_test.dart index 6f6cd38c5..c4ff841eb 100644 --- a/packages/riverpod/test/old/legacy/framework2/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework2/framework_test.dart @@ -504,7 +504,7 @@ void main() { final root = ProviderContainer.test(); final container = ProviderContainer.test(parent: root); var callCount = 0; - late Ref providerReference; + late Ref providerReference; var result = 0; final provider = Provider((ref) { callCount++; diff --git a/packages/riverpod/test/old/legacy/framework_test.dart b/packages/riverpod/test/old/legacy/framework_test.dart index 3108ddd89..7b3c81081 100644 --- a/packages/riverpod/test/old/legacy/framework_test.dart +++ b/packages/riverpod/test/old/legacy/framework_test.dart @@ -186,7 +186,7 @@ void main() { var callCount = 0; final onDispose = OnDisposeMock(); final error = Error(); - late Ref reference; + late Ref reference; final provider = Provider((ref) { reference = ref; callCount++; diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart index 4433e2ea0..cd2be06e0 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart @@ -10,7 +10,7 @@ void main() { test('can read and set current StateNotifier', () async { final container = ProviderContainer.test(); final listener = Listener(); - late Ref ref; + late Ref ref; final provider = StateNotifierProvider.autoDispose((r) { ref = r; return Counter(); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart index 5a6eacd19..324e3a55b 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart @@ -108,7 +108,7 @@ void main() { test('can read and set current StateNotifier', () async { final container = ProviderContainer.test(); final listener = Listener(); - late Ref ref; + late Ref ref; final provider = StateNotifierProvider((r) { ref = r; return Counter(); diff --git a/packages/riverpod/test/src/core/family_test.dart b/packages/riverpod/test/src/core/family_test.dart index 800e0e75e..2542e9575 100644 --- a/packages/riverpod/test/src/core/family_test.dart +++ b/packages/riverpod/test/src/core/family_test.dart @@ -25,7 +25,7 @@ void main() { container.read(provider); - final [ref as Ref, notifier as TestNotifier] = verify( + final [ref as Ref, notifier as TestNotifier] = verify( overrideWithBuild.call(captureAny, captureAny), ).captured; @@ -61,7 +61,7 @@ void main() { container.read(provider(0)); - final [ref as Ref, notifier as TestNotifier] = verify( + final [ref as Ref, notifier as TestNotifier] = verify( overrideWithBuild.call(captureAny, captureAny), ).captured; diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 0d0fe6692..97f4091e2 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -9,7 +9,7 @@ import 'package:test/test.dart'; import '../utils.dart'; final refMethodsThatDependOnProviders = - ref, ProviderBase)>{ + )>{ 'watch': (ref, p) => ref.watch(p), 'read': (ref, p) => ref.read(p), 'listen': (ref, p) => ref.listen(p, (prev, next) {}), @@ -18,13 +18,13 @@ final refMethodsThatDependOnProviders = 'exists': (ref, p) => ref.exists(p), }; final refMethodsThatDependOnListenables = - ref, ProviderListenable)>{ + )>{ 'watch': (ref, p) => ref.watch(p), 'read': (ref, p) => ref.read(p), 'listen': (ref, p) => ref.listen(p, (prev, next) {}), }; final refMethodsThatDependOnProviderOrFamilies = - ref, ProviderOrFamily)>{ + { 'invalidate': (ref, p) => ref.invalidate(p), }; @@ -32,7 +32,7 @@ void main() { group('Ref', () { test('asserts that a lifecycle cannot be used after a ref is unmounted', () { - late Ref ref; + late Ref ref; final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = Provider((r) { @@ -115,7 +115,7 @@ void main() { }); test('asserts that a lifecycle cannot be used inside selectors', () { - late Ref ref; + late Ref ref; final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = Provider((r) { @@ -201,7 +201,7 @@ void main() { group('invalidate', () { test('can disposes of the element if not used anymore', () async { - late Ref ref; + late Ref ref; final dep = Provider((r) { ref = r; return 0; @@ -228,7 +228,7 @@ void main() { () async { final container = ProviderContainer.test(); final provider = FutureProvider((r) async => 0); - late Ref ref; + late Ref ref; final dep = Provider((r) { ref = r; return 0; @@ -247,7 +247,7 @@ void main() { test('supports asReload', () async { final container = ProviderContainer.test(); final provider = FutureProvider((r) async => 0); - late Ref ref; + late Ref ref; final dep = Provider((r) { ref = r; return 0; @@ -270,7 +270,7 @@ void main() { test('calls dispose immediately', () { final container = ProviderContainer.test(); final listener = OnDisposeMock(); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; ref.onDispose(listener.call); @@ -288,7 +288,7 @@ void main() { final container = ProviderContainer.test(); final listener = Listener(); var result = 0; - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; return result; @@ -311,7 +311,7 @@ void main() { final container = ProviderContainer.test(); final listener = Listener(); final dep = StateProvider((ref) => 0); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; return ref.watch(dep); @@ -331,7 +331,7 @@ void main() { }); test('can disposes of the element if not used anymore', () async { - late Ref ref; + late Ref ref; final provider = Provider.autoDispose((r) { ref = r; r.keepAlive(); @@ -845,7 +845,7 @@ void main() { test('does not invoke error listeners if paused', () { final container = ProviderContainer.test(); final listener = ErrorListener(); - late Ref ref; + late Ref ref; var throws = false; final provider = Provider((r) { ref = r; @@ -1802,7 +1802,7 @@ void main() { 'the provider will not be disposed.', () async { final container = ProviderContainer.test(); late KeepAliveLink a; - late Ref ref; + late Ref ref; final provider = Provider.autoDispose((r) { ref = r; @@ -1834,7 +1834,7 @@ void main() { test('refreshes a provider and return the new state', () { var value = 0; final state = Provider((ref) => value); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; }); @@ -1949,7 +1949,7 @@ void main() { group('.refresh', () { test('Throws if a circular dependency is detected', () { // Regression test for https://github.com/rrousselGit/riverpod/issues/2336 - late Ref ref; + late Ref ref; final a = Provider((r) { ref = r; return 0; @@ -1969,7 +1969,7 @@ void main() { group('.invalidate', () { test('Throws if a circular dependency is detected', () { // Regression test for https://github.com/rrousselGit/riverpod/issues/2336 - late Ref ref; + late Ref ref; final a = Provider((r) { ref = r; return 0; @@ -1986,7 +1986,7 @@ void main() { }); test('Circular dependency ignores families', () { - late Ref ref; + late Ref ref; final a = Provider((r) { ref = r; return 0; @@ -2007,7 +2007,7 @@ void main() { final listener = Listener(); var result = 0; final provider = Provider((r) => result); - late Ref ref; + late Ref ref; final another = Provider((r) { ref = r; }); @@ -2036,7 +2036,7 @@ void main() { var result = 0; final unrelated = Provider((ref) => result); final provider = Provider.family((r, i) => '$result-$i'); - late Ref ref; + late Ref ref; final another = Provider((r) { ref = r; }); @@ -2072,7 +2072,7 @@ void main() { (r, i) => result, dependencies: const [], ); - late Ref ref; + late Ref ref; final another = Provider((r) => ref = r, dependencies: [provider]); final listener = Listener(); @@ -2160,7 +2160,7 @@ void main() { ref.onRemoveListener(listener2.call); }, ); - late Ref ref; + late Ref ref; final provider = Provider( name: 'provider', (r) { @@ -2205,7 +2205,7 @@ void main() { ref.onRemoveListener(listener2.call); }, ); - late Ref ref; + late Ref ref; final provider = Provider( name: 'provider', (r) => ref = r, @@ -2328,7 +2328,7 @@ void main() { ref.onAddListener(listener2.call); }, ); - late Ref ref; + late Ref ref; final provider = Provider( name: 'provider', (r) => ref = r, @@ -2361,12 +2361,12 @@ void main() { ref.onAddListener(listener2.call); }, ); - late Ref ref; + late Ref ref; final provider = Provider( name: 'provider', (r) => ref = r, ); - late Ref ref2; + late Ref ref2; final provider2 = Provider( name: 'provider', (r) => ref2 = r, @@ -2500,7 +2500,7 @@ void main() { ref.onResume(listener2.call); }, ); - late Ref ref; + late Ref ref; final provider = Provider( name: 'provider', (r) => ref = r, @@ -2537,7 +2537,7 @@ void main() { ref.onAddListener(listener2.call); }, ); - late Ref ref; + late Ref ref; final provider = Provider( name: 'provider', (r) => ref = r, @@ -2702,7 +2702,7 @@ void main() { ref.onCancel(listener.call); ref.onCancel(listener2.call); }); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; }); @@ -2975,7 +2975,7 @@ void main() { test('is false during onDispose caused by ref.watch', () { final container = ProviderContainer.test(); bool? mounted; - late Ref ref; + late Ref ref; final dep = StateProvider((ref) => 0); final provider = Provider((r) { ref = r; @@ -2994,7 +2994,7 @@ void main() { test('is false during onDispose caused by container dispose', () { final container = ProviderContainer.test(); bool? mounted; - late Ref ref; + late Ref ref; final dep = StateProvider((ref) => 0); final provider = Provider((r) { ref = r; @@ -3013,7 +3013,7 @@ void main() { test('is false in between rebuilds', () { final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); - late Ref ref; + late Ref ref; final provider = Provider((r) { ref = r; ref.watch(dep); diff --git a/packages/riverpod/test/src/matrix.dart b/packages/riverpod/test/src/matrix.dart index eb0c0fa7a..8643c0a61 100644 --- a/packages/riverpod/test/src/matrix.dart +++ b/packages/riverpod/test/src/matrix.dart @@ -33,7 +33,7 @@ class TestFactory { typedef ProviderFactory = ProviderT Function([Object? arg]) Function( - BaseT Function(Ref ref, Object? arg) create, { + BaseT Function(Ref? ref, Object? arg) create, { String? name, Iterable? dependencies, Retry? retry, diff --git a/packages/riverpod/test/src/matrix/async_notifier_provider.dart b/packages/riverpod/test/src/matrix/async_notifier_provider.dart index ad7e08124..6baeffbb9 100644 --- a/packages/riverpod/test/src/matrix/async_notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/async_notifier_provider.dart @@ -134,7 +134,7 @@ class DeferredAsyncNotifier extends AsyncNotifier bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) : _updateShouldNotify = updateShouldNotify; - final FutureOr Function(Ref> ref) _create; + final FutureOr Function(Ref ref) _create; final bool Function( AsyncValue previousState, AsyncValue newState, @@ -160,7 +160,7 @@ class DeferredFamilyAsyncNotifier bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) : _updateShouldNotify = updateShouldNotify; - final FutureOr Function(Ref> ref) _create; + final FutureOr Function(Ref ref) _create; final bool Function( AsyncValue previousState, @@ -191,12 +191,12 @@ class AsyncNotifierTestFactory extends TestFactory< }); final TestAsyncNotifier Function( - FutureOr Function(Ref> ref) create, + FutureOr Function(Ref ref) create, ) deferredNotifier; final $AsyncNotifierProvider, StateT> Function( - FutureOr Function(Ref> ref) create, { + FutureOr Function(Ref ref) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) deferredProvider; @@ -206,7 +206,7 @@ class AsyncNotifierTestFactory extends TestFactory< $AsyncNotifierProvider, StateT> simpleTestProvider( - FutureOr Function(Ref> ref) create, { + FutureOr Function(Ref ref) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) { return deferredProvider( diff --git a/packages/riverpod/test/src/matrix/notifier_provider.dart b/packages/riverpod/test/src/matrix/notifier_provider.dart index c72767ad0..87c52450a 100644 --- a/packages/riverpod/test/src/matrix/notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/notifier_provider.dart @@ -131,7 +131,7 @@ class DeferredNotifier extends Notifier bool Function(StateT, StateT)? updateShouldNotify, }) : _updateShouldNotify = updateShouldNotify; - final StateT Function(Ref ref) _create; + final StateT Function(Ref ref) _create; final bool Function( StateT previousState, StateT newState, @@ -153,7 +153,7 @@ class DeferredFamilyNotifier extends FamilyNotifier bool Function(StateT, StateT)? updateShouldNotify, }) : _updateShouldNotify = updateShouldNotify; - final StateT Function(Ref ref) _create; + final StateT Function(Ref ref) _create; final bool Function( StateT previousState, @@ -184,11 +184,11 @@ class NotifierTestFactory extends TestFactory< }); final TestNotifier Function( - StateT Function(Ref ref) create, + StateT Function(Ref ref) create, ) deferredNotifier; final $NotifierProvider, StateT> Function( - StateT Function(Ref ref) create, { + StateT Function(Ref ref) create, { bool Function(StateT, StateT)? updateShouldNotify, }) deferredProvider; @@ -197,7 +197,7 @@ class NotifierTestFactory extends TestFactory< ) provider; $NotifierProvider, StateT> simpleTestProvider( - StateT Function(Ref ref) create, { + StateT Function(Ref ref) create, { bool Function(StateT, StateT)? updateShouldNotify, }) { return deferredProvider( diff --git a/packages/riverpod/test/src/matrix/stream_notifier_provider.dart b/packages/riverpod/test/src/matrix/stream_notifier_provider.dart index 456c0c349..03599453f 100644 --- a/packages/riverpod/test/src/matrix/stream_notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/stream_notifier_provider.dart @@ -139,7 +139,7 @@ class DeferredStreamNotifier extends StreamNotifier bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) : _updateShouldNotify = updateShouldNotify; - final Stream Function(Ref> ref) _create; + final Stream Function(Ref ref) _create; final bool Function( AsyncValue previousState, AsyncValue newState, @@ -165,7 +165,7 @@ class DeferredFamilyStreamNotifier bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) : _updateShouldNotify = updateShouldNotify; - final Stream Function(Ref> ref) _create; + final Stream Function(Ref ref) _create; final bool Function( AsyncValue previousState, @@ -196,12 +196,12 @@ class StreamNotifierTestFactory extends TestFactory< }); final TestStreamNotifier Function( - Stream Function(Ref> ref) create, + Stream Function(Ref ref) create, ) deferredNotifier; final $StreamNotifierProvider, StateT> Function( - Stream Function(Ref> ref) create, { + Stream Function(Ref ref) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, Retry? retry, }) deferredProvider; @@ -213,7 +213,7 @@ class StreamNotifierTestFactory extends TestFactory< $StreamNotifierProvider, StateT> simpleTestProvider( - Stream Function(Ref> ref) create, { + Stream Function(Ref ref) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) { return deferredProvider( diff --git a/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart b/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart index 3f457e230..b56d2c3c7 100644 --- a/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart @@ -444,7 +444,7 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; final dep = FutureProvider((ref) => 0); final dep2 = FutureProvider((ref) => 0); -void fn(Ref ref) { +void fn(Ref ref) { ref.read(dep); ref.read(dep2); } diff --git a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart index 610476987..b2a7f0886 100644 --- a/packages/riverpod_annotation/lib/src/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/src/riverpod_annotation.dart @@ -203,7 +203,7 @@ class MissingScopeException implements Exception { MissingScopeException(this.ref); /// The [Ref] that threw the exception - final Ref ref; + final Ref ref; @override String toString() { diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md index 344b8fdf2..4b0a90073 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md @@ -21,7 +21,7 @@ test/lints/functional_ref/functional_ref.dart:14:32 ```dart @riverpod -int generics(>>>Ref<<< ref) => 0; +int generics(>>>Ref ref) => 0; @riverpod ``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/unknown_scoped_usage/unknown_scoped_usage_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/unknown_scoped_usage/unknown_scoped_usage_lint.md index 291f9421c..16b6c5a5d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/unknown_scoped_usage/unknown_scoped_usage_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/unknown_scoped_usage/unknown_scoped_usage_lint.md @@ -4,7 +4,7 @@ message: A provider was used, but could not find the associated `ref`. test/lints/unknown_scoped_usage.dart:16:3 ```dart -void fn(WidgetRef widgetRef, Ref ref) { +void fn(WidgetRef widgetRef, Ref ref) { // expect_lint: unknown_scoped_usage >>>scopedProvider<<<; rootProvider; diff --git a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.dart b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.dart index 1a44280a3..ac0546121 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/unknown_scoped_usage.dart @@ -11,7 +11,7 @@ int scoped(Ref ref) => 0; int root(Ref ref) => 0; @Dependencies([scoped]) -void fn(WidgetRef widgetRef, Ref ref) { +void fn(WidgetRef widgetRef, Ref ref) { // expect_lint: unknown_scoped_usage scopedProvider; rootProvider; diff --git a/website/docs/case_studies/cancel/extension.dart b/website/docs/case_studies/cancel/extension.dart index d6e34982d..162f777fa 100644 --- a/website/docs/case_studies/cancel/extension.dart +++ b/website/docs/case_studies/cancel/extension.dart @@ -2,7 +2,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; /* SNIPPET START */ -extension DebounceAndCancelExtension on Ref { +extension DebounceAndCancelExtension on Ref { // {@template note} /// Wait for [duration] (defaults to 500ms), and then return a [http.Client] /// which can be used to make a request. diff --git a/website/docs/concepts/combining_providers.mdx b/website/docs/concepts/combining_providers.mdx index 541647f57..42a483b9b 100644 --- a/website/docs/concepts/combining_providers.mdx +++ b/website/docs/concepts/combining_providers.mdx @@ -128,7 +128,7 @@ final repositoryProvider = Provider(Repository.new); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; Future fetchCatalog() async { String token = ref.read(userTokenProvider); diff --git a/website/docs/concepts/reading/counter/raw.dart b/website/docs/concepts/reading/counter/raw.dart index 5d248ab57..579d682a9 100644 --- a/website/docs/concepts/reading/counter/raw.dart +++ b/website/docs/concepts/reading/counter/raw.dart @@ -16,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter can use the "ref" to read other providers diff --git a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart index e36e7c732..8b94a0d55 100644 --- a/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart +++ b/website/docs/essentials/websockets_sync/shared_pipe_change_notifier.dart @@ -6,7 +6,7 @@ import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'shared_pipe_change_notifier.g.dart'; /* SNIPPET START */ -extension on Ref { +extension on Ref { // {@template extension} // We can move the previous logic to a Ref extension. // This enables reusing the logic between providers diff --git a/website/docs/migration/from_state_notifier/old_lifecycles_old.dart b/website/docs/migration/from_state_notifier/old_lifecycles_old.dart index 880fcee10..2b6e8b335 100644 --- a/website/docs/migration/from_state_notifier/old_lifecycles_old.dart +++ b/website/docs/migration/from_state_notifier/old_lifecycles_old.dart @@ -21,7 +21,7 @@ class MyNotifier extends StateNotifier { _timer = Timer.periodic(period, (t) => update()); // 2 side effect on init } final Duration period; - final Ref ref; + final Ref ref; late final Timer _timer; Future update() async { diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index 970aea954..1ca5b48cc 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -166,7 +166,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` diff --git a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index d4cacfdd8..c8abd8706 100644 --- a/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/bn/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -16,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter এই "ref" অবজেক্ট ব্যবহার করে অন্য প্রভাইডার পড়তে পারবে diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index c2902ddac..91c4c2a46 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -174,7 +174,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index feee2608b..103dd40d4 100644 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/de/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -16,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter kann "ref" dazu benutzen um andere Provider auszulesen diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index 4c30a0c51..395bd4730 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -166,7 +166,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` Sin embargo, pasar `ref.read` da como resultado un código un poco menos verboso diff --git a/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/reading.mdx b/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/reading.mdx index f49ebaf7c..81b1e7b2e 100644 --- a/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/reading.mdx +++ b/website/i18n/es/docusaurus-plugin-content-docs/current/concepts/reading.mdx @@ -39,7 +39,7 @@ final counter = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref): super(0); - final Ref ref; + final Ref ref; void increment() { // `Counter` puede usar la "ref" para leer otros providers diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index 82260ba01..cfa1da36c 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -174,7 +174,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` diff --git a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index 9c7c301a1..87f981849 100644 --- a/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/fr/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -16,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter peut utiliser le "ref" pour lire d'autres providers diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart b/website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart index cdebd482e..2db7bba89 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart @@ -2,7 +2,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; /* SNIPPET START */ -extension DebounceAndCancelExtension on Ref { +extension DebounceAndCancelExtension on Ref { /// Aspetta per la [duration] (di default a 500ms) e poi ritorna un [http.Client] /// con il quale possiamo effettuare una richiesta. /// diff --git a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index 4466dcec9..e3aacdf73 100644 --- a/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/it/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -161,7 +161,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` L'unica differenza che comporta passare `ref.read` è la scrittura di meno codice, inoltre, diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index ce41b30d1..7caaeb576 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -161,7 +161,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index 3c02b890e..3640d66a6 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -16,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter は `ref` を使って他のプロバイダーを利用することができる diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index 6d01aa2e0..1714af6af 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -163,7 +163,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index 578714d56..75d691be3 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -179,7 +179,7 @@ final repositoryProvider = Provider((ref) => Repository(ref)); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; } ``` diff --git a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart index a92076a79..815cafe73 100644 --- a/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart +++ b/website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/reading_counter.dart @@ -16,7 +16,7 @@ final counterProvider = StateNotifierProvider((ref) { class Counter extends StateNotifier { Counter(this.ref) : super(0); - final Ref ref; + final Ref ref; void increment() { // Counter может использовать "ref" для чтения других провайдеров diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart index 2f2becfc5..8a06acb22 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/case_studies/cancel/extension.dart @@ -2,7 +2,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; /* SNIPPET START */ -extension DebounceAndCancelExtension on Ref { +extension DebounceAndCancelExtension on Ref { /// 等待 [duration]（默认为 500ms）， /// 然后返回一个 [http.Client]，用于发出请求。 /// diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx index 9b0ebf319..07a82f984 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/combining_providers.mdx @@ -131,7 +131,7 @@ final repositoryProvider = Provider(Repository.new); class Repository { Repository(this.ref); - final Ref ref; + final Ref ref; Future fetchCatalog() async { String token = ref.read(userTokenProvider); From f95b3feb3fafcde378e52466aa8164184b4359f2 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 2 Nov 2024 22:18:04 +0100 Subject: [PATCH 359/387] Fix riverpod tests --- .../change_notifier_provider_test.dart | 17 -- packages/riverpod/lib/src/core/element.dart | 6 +- .../src/core/provider/notifier_provider.dart | 14 +- .../state_notifier_provider_test.dart | 21 +-- .../state_provider/state_provider_test.dart | 17 -- .../future_provider/future_provider_test.dart | 21 --- .../stream_provider/stream_provider_test.dart | 21 --- .../riverpod/test/src/core/family_test.dart | 4 +- .../src/core/provider_subscription_test.dart | 2 +- packages/riverpod/test/src/core/ref_test.dart | 155 +++++++++++------- .../src/matrix/async_notifier_provider.dart | 16 +- .../test/src/matrix/notifier_provider.dart | 44 +++-- .../src/matrix/stream_notifier_provider.dart | 22 ++- .../src/providers/async_notifier_test.dart | 112 ++++++------- .../src/providers/future_provider_test.dart | 2 +- .../test/src/providers/notifier_test.dart | 70 ++++---- .../src/providers/stream_notifier_test.dart | 136 +++++++-------- 17 files changed, 325 insertions(+), 355 deletions(-) diff --git a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart index ee2b44b28..b6501249e 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart @@ -67,23 +67,6 @@ void main() { expect(container.read(autoDisposeFamily(10)).value, '84 10'); }); - test('ref.listenSelf listens to state changes', () { - final listener = Listener>(); - final container = ProviderContainer.test(); - final provider = ChangeNotifierProvider>((ref) { - ref.listenSelf(listener.call); - return ValueNotifier(0); - }); - - final notifier = container.read(provider); - - verifyOnly(listener, listener(null, notifier)); - - container.read(provider.notifier).value++; - - verifyOnly(listener, listener(notifier, notifier)); - }); - test('support null ChangeNotifier', () { final container = ProviderContainer.test(); final provider = ChangeNotifierProvider?>((ref) => null); diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 3e409da77..c5e61439d 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -72,7 +72,7 @@ abstract class ProviderElement implements Node { /// The [ProviderContainer] that owns this [ProviderElement]. ProviderContainer get container => pointer.targetContainer; - Ref? ref; + Ref? ref; /// Whether this [ProviderElement] is actively in use. /// @@ -282,7 +282,7 @@ This could mean a few things: /// - [didChangeDependency] can be used to differentiate a rebuild caused /// by [Ref.watch] from one caused by [Ref.refresh]/[Ref.invalidate]. @visibleForOverriding - void create(Ref ref, {required bool didChangeDependency}); + void create(Ref ref, {required bool didChangeDependency}); /// A utility for re-initializing a provider when needed. /// @@ -323,7 +323,7 @@ This could mean a few things: /// Invokes [create] and handles errors. @internal - void buildState(Ref ref) { + void buildState(Ref ref) { if (_didChangeDependency) _retryCount = 0; ProviderElement? debugPreviouslyBuildingElement; diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index 7af0e7fff..a8de29417 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -54,10 +54,10 @@ typedef RunNotifierBuild = CreatedT Function( /// } /// ``` abstract class NotifierBase { - Ref? _ref; + Ref? _ref; @protected - Ref get ref { + Ref get ref { final ref = _ref; if (ref == null) throw StateError(uninitializedElementError); @@ -71,19 +71,20 @@ abstract class NotifierBase { /// As opposed to [Ref.listen], the listener will be called even if /// [updateShouldNotify] returns false, meaning that the previous /// and new value can potentially be identical. + @protected void listenSelf( void Function(StateT? previous, StateT next) listener, { void Function(Object error, StackTrace stackTrace)? onError, }) { ref.listenSelf( - (prev, next) => listener(prev as StateT?, next as StateT), + (prev, next) => listener(prev, next), onError: onError, ); } @visibleForTesting @protected - StateT get state => ref.state as StateT; + StateT get state => ref.state; @visibleForTesting @protected @@ -97,8 +98,7 @@ abstract class NotifierBase { @internal extension ClassBaseX on NotifierBase { - ProviderElement? get element => - _ref?._element as ProviderElement?; + ProviderElement? get element => _ref?._element; } /// Implementation detail of `riverpod_generator`. @@ -190,7 +190,7 @@ abstract class ClassProviderElement< // @mustCallSuper @override void create( - Ref ref, { + Ref ref, { required bool didChangeDependency, }) { final seamless = !didChangeDependency; diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart index 324e3a55b..0514da27e 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart @@ -16,7 +16,9 @@ void main() { onDispose: () => throw StateError('called'), ); final container = ProviderContainer.test(); - final provider = StateNotifierProvider((_) => notifier); + final provider = StateNotifierProvider( + (_) => notifier, + ); container.read(provider); @@ -88,23 +90,6 @@ void main() { verifyNoMoreInteractions(listener); }); - test('ref.listenSelf listens to state changes', () { - final listener = Listener(); - final container = ProviderContainer.test(); - final provider = StateNotifierProvider, int>((ref) { - ref.listenSelf(listener.call); - return StateController(0); - }); - - final notifier = container.read(provider.notifier); - - verifyOnly(listener, listener(null, 0)); - - notifier.state++; - - verifyOnly(listener, listener(0, 1)); - }); - test('can read and set current StateNotifier', () async { final container = ProviderContainer.test(); final listener = Listener(); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart index 93a282280..37f5092d6 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_provider/state_provider_test.dart @@ -60,23 +60,6 @@ void main() { verifyNoMoreInteractions(listener); }); - test('ref.listenSelf listens to state changes', () { - final listener = Listener(); - final container = ProviderContainer.test(); - final provider = StateProvider((ref) { - ref.listenSelf(listener.call); - return 0; - }); - - final notifier = container.read(provider.notifier); - - verifyOnly(listener, listener(null, 0)); - - notifier.state++; - - verifyOnly(listener, listener(0, 1)); - }); - test('supports .name', () { expect( StateProvider((ref) => 0).name, diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart index 43382ef65..fb3154d11 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart @@ -93,27 +93,6 @@ void main() { expect(container.read(autoDisposeFamily(10)).value, '84 10'); }); - test('Emits AsyncLoading before the create function is executed', () async { - final container = ProviderContainer.test(); - late AsyncValue state; - final provider = FutureProvider((ref) { - state = ref.state; - return 0; - }); - - container.read(provider); - - expect(state, const AsyncLoading()); - - await container.read(provider.future); - container.refresh(provider); - - expect( - state, - const AsyncLoading().copyWithPrevious(const AsyncData(0)), - ); - }); - test('On dispose, .future resolves with the future returned itself', () async { final container = ProviderContainer.test(); diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart index 5b1b6a9af..51d164f3a 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart @@ -73,27 +73,6 @@ void main() { expect(container.read(autoDisposeFamily(10)).value, '84 10'); }); - test('Emits AsyncLoading before the create function is executed', () async { - final container = ProviderContainer.test(); - late AsyncValue state; - final provider = StreamProvider((ref) { - state = ref.state; - return Stream.value(0); - }); - - container.listen(provider, (p, n) {}); - - expect(state, const AsyncLoading()); - - await container.read(provider.future); - container.refresh(provider); - - expect( - state, - const AsyncLoading().copyWithPrevious(const AsyncData(0)), - ); - }); - group('When going back to AsyncLoading', () { test( 'sets isRefreshing to true if triggered by a ref.invalidate/ref.refresh', diff --git a/packages/riverpod/test/src/core/family_test.dart b/packages/riverpod/test/src/core/family_test.dart index 2542e9575..278f67e00 100644 --- a/packages/riverpod/test/src/core/family_test.dart +++ b/packages/riverpod/test/src/core/family_test.dart @@ -9,7 +9,7 @@ void main() { group('ClassProvider', () { notifierProviderFactory.createGroup((factory) { test('overrideWithBuild', () { - final provider = factory.simpleTestProvider((ref) => 0); + final provider = factory.simpleTestProvider((ref, _) => 0); final overrideWithBuild = OverrideWithBuildMock, int, int>(-1); @@ -42,7 +42,7 @@ void main() { if (!factory.isFamily) return; test('overrideWithBuild', () { - final provider = factory.simpleTestProvider((ref) => 0).from!; + final provider = factory.simpleTestProvider((ref, _) => 0).from!; provider as NotifierProviderFamily, int, Object?>; diff --git a/packages/riverpod/test/src/core/provider_subscription_test.dart b/packages/riverpod/test/src/core/provider_subscription_test.dart index 7fc3ad108..571ca481e 100644 --- a/packages/riverpod/test/src/core/provider_subscription_test.dart +++ b/packages/riverpod/test/src/core/provider_subscription_test.dart @@ -68,7 +68,7 @@ void main() { () async { final container = ProviderContainer.test(); final provider = NotifierProvider, int>( - () => DeferredNotifier((ref) => 0), + () => DeferredNotifier((ref, _) => 0), ); final listener = Listener(); diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 97f4091e2..019fc5471 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -6,6 +6,7 @@ import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/framework.dart'; import 'package:test/test.dart'; +import '../matrix.dart'; import '../utils.dart'; final refMethodsThatDependOnProviders = @@ -584,9 +585,13 @@ void main() { group('listenSelf', () { test('does not break autoDispose', () async { final container = ProviderContainer.test(); - final provider = Provider.autoDispose((ref) { - ref.listenSelf((previous, next) {}); - }); + + final provider = + NotifierProvider.autoDispose, void>( + () => DeferredNotifier((ref, self) { + ref.listenSelf((previous, next) {}); + }), + ); container.read(provider); expect(container.getAllProviderElements(), [anything]); @@ -601,14 +606,14 @@ void main() { final listener = Listener(); final listener2 = Listener(); - late Ref ref; - final provider = Provider((r) { - ref = r; - ref.listenSelf(listener.call); - ref.listenSelf(listener2.call); + final provider = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + self.listenSelf(listener.call); + self.listenSelf(listener2.call); - return 0; - }); + return 0; + }), + ); container.read(provider); @@ -619,7 +624,7 @@ void main() { verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); - ref.state = 42; + container.read(provider.notifier).state = 42; verifyInOrder([ listener(0, 42), @@ -634,12 +639,15 @@ void main() { final listener = Listener(); final listener2 = Listener(); var result = 0; - final provider = Provider((ref) { - ref.listenSelf(listener.call); - ref.listenSelf(listener2.call); - return result; - }); + final provider = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + self.listenSelf(listener.call); + self.listenSelf(listener2.call); + + return result; + }), + ); container.read(provider); @@ -665,12 +673,15 @@ void main() { final container = ProviderContainer.test(); final listener = Listener(); final listener2 = Listener(); - final provider = Provider((ref) { - ref.listenSelf(listener.call); - ref.listenSelf(listener2.call); - return 0; - }); + final provider = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + self.listenSelf(listener.call); + self.listenSelf(listener2.call); + + return 0; + }), + ); container.read(provider); @@ -696,15 +707,18 @@ void main() { final listener = Listener(); final listener2 = Listener(); var result = 0; - final provider = Provider((ref) { - if (result == 0) { - ref.listenSelf(listener.call); - } else { - ref.listenSelf(listener2.call); - } - return result; - }); + final provider = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + if (result == 0) { + self.listenSelf(listener.call); + } else { + self.listenSelf(listener2.call); + } + + return result; + }), + ); container.read(provider); @@ -726,12 +740,15 @@ void main() { final errorListener = ErrorListener(); final errorListener2 = ErrorListener(); var error = 42; - final provider = Provider((ref) { - ref.listenSelf(listener.call, onError: errorListener.call); - ref.listenSelf((prev, next) {}, onError: errorListener2.call); - Error.throwWithStackTrace(error, StackTrace.empty); - }); + final provider = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + self.listenSelf(listener.call, onError: errorListener.call); + self.listenSelf((prev, next) {}, onError: errorListener2.call); + + Error.throwWithStackTrace(error, StackTrace.empty); + }), + ); expect(() => container.read(provider), throwsA(42)); @@ -761,13 +778,18 @@ void main() { final errorListener = ErrorListener(); final errorListener2 = ErrorListener(); Exception? error; - final provider = Provider((ref) { - ref.listenSelf((prev, next) {}, onError: errorListener.call); - if (error != null) Error.throwWithStackTrace(error, StackTrace.empty); + final provider = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + self.listenSelf((prev, next) {}, onError: errorListener.call); - return 0; - }); + if (error != null) { + Error.throwWithStackTrace(error, StackTrace.empty); + } + + return 0; + }), + ); container.listen( provider, @@ -794,10 +816,13 @@ void main() { final listener = Listener(); final listener2 = Listener(); var result = 0; - final provider = Provider((ref) { - ref.listenSelf(listener.call); - return result; - }); + + final provider = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + self.listenSelf(listener.call); + return result; + }), + ); container.listen(provider, listener2.call, fireImmediately: true); @@ -1856,12 +1881,12 @@ void main() { final listener = Listener(); final selfListener = Listener(); final container = ProviderContainer.test(observers: [observer]); - late Ref ref; - final provider = Provider((r) { - ref = r; - ref.listenSelf(selfListener.call); - return 0; - }); + final provider = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + self.listenSelf(selfListener.call); + return 0; + }), + ); container.listen(provider, listener.call, fireImmediately: true); @@ -1869,7 +1894,7 @@ void main() { verifyOnly(listener, listener(null, 0)); verifyOnly(selfListener, selfListener(null, 0)); - ref.notifyListeners(); + container.read(provider.notifier).ref.notifyListeners(); verifyOnly(listener, listener(0, 0)); verifyOnly(selfListener, selfListener(0, 0)); @@ -1886,11 +1911,14 @@ void main() { final selfListener = Listener(); final listener = Listener(); final container = ProviderContainer.test(observers: [observer]); - final provider = Provider((ref) { - ref.listenSelf(selfListener.call); - ref.notifyListeners(); - return 0; - }); + + final provider = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + self.listenSelf(selfListener.call); + ref.notifyListeners(); + return 0; + }), + ); container.listen(provider, listener.call, fireImmediately: true); @@ -1910,13 +1938,16 @@ void main() { const firstValue = 'first'; const secondValue = 'second'; var result = firstValue; - final provider = Provider((ref) { - ref.listenSelf(selfListener.call); - if (callNotifyListeners) { - ref.notifyListeners(); - } - return result; - }); + + final provider = NotifierProvider, Object>( + () => DeferredNotifier((ref, self) { + self.listenSelf(selfListener.call); + if (callNotifyListeners) { + ref.notifyListeners(); + } + return result; + }), + ); container.listen(provider, listener.call, fireImmediately: true); diff --git a/packages/riverpod/test/src/matrix/async_notifier_provider.dart b/packages/riverpod/test/src/matrix/async_notifier_provider.dart index 6baeffbb9..9dd098134 100644 --- a/packages/riverpod/test/src/matrix/async_notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/async_notifier_provider.dart @@ -134,14 +134,14 @@ class DeferredAsyncNotifier extends AsyncNotifier bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) : _updateShouldNotify = updateShouldNotify; - final FutureOr Function(Ref ref) _create; + final FutureOr Function(Ref ref, $AsyncNotifier self) _create; final bool Function( AsyncValue previousState, AsyncValue newState, )? _updateShouldNotify; @override - FutureOr build() => _create(ref); + FutureOr build() => _create(ref, this); @override bool updateShouldNotify( @@ -160,7 +160,7 @@ class DeferredFamilyAsyncNotifier bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) : _updateShouldNotify = updateShouldNotify; - final FutureOr Function(Ref ref) _create; + final FutureOr Function(Ref ref, $AsyncNotifier self) _create; final bool Function( AsyncValue previousState, @@ -168,7 +168,7 @@ class DeferredFamilyAsyncNotifier )? _updateShouldNotify; @override - FutureOr build(int arg) => _create(ref); + FutureOr build(int arg) => _create(ref, this); @override bool updateShouldNotify( @@ -191,12 +191,12 @@ class AsyncNotifierTestFactory extends TestFactory< }); final TestAsyncNotifier Function( - FutureOr Function(Ref ref) create, + FutureOr Function(Ref ref, $AsyncNotifier self) create, ) deferredNotifier; final $AsyncNotifierProvider, StateT> Function( - FutureOr Function(Ref ref) create, { + FutureOr Function(Ref ref, $AsyncNotifier self) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) deferredProvider; @@ -206,11 +206,11 @@ class AsyncNotifierTestFactory extends TestFactory< $AsyncNotifierProvider, StateT> simpleTestProvider( - FutureOr Function(Ref ref) create, { + FutureOr Function(Ref ref, $AsyncNotifier self) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) { return deferredProvider( - (ref) => create(ref), + (ref, self) => create(ref, self), updateShouldNotify: updateShouldNotify, ); } diff --git a/packages/riverpod/test/src/matrix/notifier_provider.dart b/packages/riverpod/test/src/matrix/notifier_provider.dart index 87c52450a..282e5ae2a 100644 --- a/packages/riverpod/test/src/matrix/notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/notifier_provider.dart @@ -5,11 +5,12 @@ final notifierProviderFactory = TestMatrix( 'NotifierProvider': NotifierTestFactory( isAutoDispose: false, isFamily: false, - deferredNotifier: DeferredNotifier.new, + deferredNotifier: (create) => + DeferredNotifier((ref, self) => create(ref, self)), deferredProvider: (create, {updateShouldNotify}) { return NotifierProvider, StateT>( () => DeferredNotifier( - create, + (ref, self) => create(ref, self), updateShouldNotify: updateShouldNotify, ), ); @@ -29,11 +30,12 @@ final notifierProviderFactory = TestMatrix( 'NotifierProvider.autoDispose': NotifierTestFactory( isAutoDispose: true, isFamily: false, - deferredNotifier: DeferredNotifier.new, + deferredNotifier: (create) => + DeferredNotifier((ref, self) => create(ref, self)), deferredProvider: (create, {updateShouldNotify}) { return NotifierProvider.autoDispose, StateT>( () => DeferredNotifier( - create, + (ref, self) => create(ref, self), updateShouldNotify: updateShouldNotify, ), ); @@ -122,6 +124,15 @@ abstract class TestNotifier implements $Notifier { @override set state(StateT value); + + @override + Ref get ref; + + @override + void listenSelf( + void Function(StateT? previous, StateT next) listener, { + void Function(Object error, StackTrace stackTrace)? onError, + }); } class DeferredNotifier extends Notifier @@ -131,14 +142,23 @@ class DeferredNotifier extends Notifier bool Function(StateT, StateT)? updateShouldNotify, }) : _updateShouldNotify = updateShouldNotify; - final StateT Function(Ref ref) _create; + final StateT Function(Ref ref, DeferredNotifier self) _create; final bool Function( StateT previousState, StateT newState, )? _updateShouldNotify; @override - StateT build() => _create(ref); + Ref get ref; + + @override + void listenSelf( + void Function(StateT? previous, StateT next) listener, { + void Function(Object error, StackTrace stackTrace)? onError, + }); + + @override + StateT build() => _create(ref, this); @override bool updateShouldNotify(StateT previousState, StateT newState) => @@ -153,7 +173,7 @@ class DeferredFamilyNotifier extends FamilyNotifier bool Function(StateT, StateT)? updateShouldNotify, }) : _updateShouldNotify = updateShouldNotify; - final StateT Function(Ref ref) _create; + final StateT Function(Ref ref, DeferredFamilyNotifier self) _create; final bool Function( StateT previousState, @@ -161,7 +181,7 @@ class DeferredFamilyNotifier extends FamilyNotifier )? _updateShouldNotify; @override - StateT build(int arg) => _create(ref); + StateT build(int arg) => _create(ref, this); @override bool updateShouldNotify( @@ -184,11 +204,11 @@ class NotifierTestFactory extends TestFactory< }); final TestNotifier Function( - StateT Function(Ref ref) create, + StateT Function(Ref ref, $Notifier self) create, ) deferredNotifier; final $NotifierProvider, StateT> Function( - StateT Function(Ref ref) create, { + StateT Function(Ref ref, $Notifier self) create, { bool Function(StateT, StateT)? updateShouldNotify, }) deferredProvider; @@ -197,11 +217,11 @@ class NotifierTestFactory extends TestFactory< ) provider; $NotifierProvider, StateT> simpleTestProvider( - StateT Function(Ref ref) create, { + StateT Function(Ref ref, $Notifier self) create, { bool Function(StateT, StateT)? updateShouldNotify, }) { return deferredProvider( - (ref) => create(ref), + (ref, self) => create(ref, self), updateShouldNotify: updateShouldNotify, ); } diff --git a/packages/riverpod/test/src/matrix/stream_notifier_provider.dart b/packages/riverpod/test/src/matrix/stream_notifier_provider.dart index 03599453f..f00b4211d 100644 --- a/packages/riverpod/test/src/matrix/stream_notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/stream_notifier_provider.dart @@ -139,14 +139,17 @@ class DeferredStreamNotifier extends StreamNotifier bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) : _updateShouldNotify = updateShouldNotify; - final Stream Function(Ref ref) _create; + final Stream Function( + Ref ref, + DeferredStreamNotifier self, + ) _create; final bool Function( AsyncValue previousState, AsyncValue newState, )? _updateShouldNotify; @override - Stream build() => _create(ref); + Stream build() => _create(ref, this); @override bool updateShouldNotify( @@ -165,7 +168,10 @@ class DeferredFamilyStreamNotifier bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) : _updateShouldNotify = updateShouldNotify; - final Stream Function(Ref ref) _create; + final Stream Function( + Ref ref, + DeferredFamilyStreamNotifier self, + ) _create; final bool Function( AsyncValue previousState, @@ -173,7 +179,7 @@ class DeferredFamilyStreamNotifier )? _updateShouldNotify; @override - Stream build(int arg) => _create(ref); + Stream build(int arg) => _create(ref, this); @override bool updateShouldNotify( @@ -196,12 +202,12 @@ class StreamNotifierTestFactory extends TestFactory< }); final TestStreamNotifier Function( - Stream Function(Ref ref) create, + Stream Function(Ref ref, $StreamNotifier self) create, ) deferredNotifier; final $StreamNotifierProvider, StateT> Function( - Stream Function(Ref ref) create, { + Stream Function(Ref ref, $StreamNotifier self) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, Retry? retry, }) deferredProvider; @@ -213,11 +219,11 @@ class StreamNotifierTestFactory extends TestFactory< $StreamNotifierProvider, StateT> simpleTestProvider( - Stream Function(Ref ref) create, { + Stream Function(Ref ref, $StreamNotifier self) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, }) { return deferredProvider( - (ref) => create(ref), + (ref, self) => create(ref, self), updateShouldNotify: updateShouldNotify, ); } diff --git a/packages/riverpod/test/src/providers/async_notifier_test.dart b/packages/riverpod/test/src/providers/async_notifier_test.dart index 81eabed32..670459dd1 100644 --- a/packages/riverpod/test/src/providers/async_notifier_test.dart +++ b/packages/riverpod/test/src/providers/async_notifier_test.dart @@ -32,7 +32,7 @@ void main() { test('sets provider(arg) dependencies/allTransitiveDependencies to null', () { final provider = factory.value( - (_, arg) => factory.deferredNotifier((ref) => 0), + (_, arg) => factory.deferredNotifier((ref, _) => 0), dependencies: [], ); @@ -43,7 +43,7 @@ void main() { test('Cannot share a Notifier instance between providers ', () { final container = ProviderContainer.test(); - final notifier = factory.deferredNotifier((ref) => 0); + final notifier = factory.deferredNotifier((ref, _) => 0); final provider = factory.provider(() => notifier); final provider2 = factory.provider(() => notifier); @@ -60,7 +60,7 @@ void main() { final container = ProviderContainer.test(); late TestAsyncNotifier notifier; late List errors; - final provider = factory.simpleTestProvider((ref) { + final provider = factory.simpleTestProvider((ref, _) { ref.onDispose(() { errors = captureErrors([ () => notifier.state, @@ -84,7 +84,7 @@ void main() { test('Using the notifier after dispose throws', () { final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider((ref) => 0); + final provider = factory.simpleTestProvider((ref, _) => 0); container.listen(provider.notifier, (prev, next) {}); final notifier = container.read(provider.notifier); @@ -112,7 +112,7 @@ void main() { test('Can assign `AsyncLoading` to `AsyncValue`', () { // Regression test for https://github.com/rrousselGit/riverpod/issues/2120 - final provider = factory.simpleTestProvider((ref) => 42); + final provider = factory.simpleTestProvider((ref, _) => 42); final container = ProviderContainer.test(); final sub = container.listen(provider.notifier, (prev, next) {}); @@ -131,7 +131,7 @@ void main() { test('Can assign `AsyncData` to `AsyncValue`', () { // Regression test for https://github.com/rrousselGit/riverpod/issues/2120 - final provider = factory.simpleTestProvider((ref) => 42); + final provider = factory.simpleTestProvider((ref, _) => 42); final container = ProviderContainer.test(); final sub = container.listen(provider.notifier, (prev, next) {}); @@ -150,7 +150,7 @@ void main() { test('Can assign `AsyncError` to `AsyncValue`', () { // Regression test for https://github.com/rrousselGit/riverpod/issues/2120 - final provider = factory.simpleTestProvider((ref) => 42); + final provider = factory.simpleTestProvider((ref, _) => 42); final container = ProviderContainer.test(); final sub = container.listen(provider.notifier, (prev, next) {}); @@ -176,7 +176,7 @@ void main() { final container = ProviderContainer.test(); var count = 0; final provider = factory.simpleTestProvider( - (ref) => Future.value(count++), + (ref, _) => Future.value(count++), ); container.listen(provider, (previous, next) {}); @@ -206,7 +206,9 @@ void main() { 'performs seamless:false copyWithPrevious on `state = AsyncLoading()`', () async { final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider((ref) => Future.value(0)); + final provider = factory.simpleTestProvider( + (ref, _) => Future.value(0), + ); final sub = container.listen(provider.notifier, (previous, next) {}); @@ -228,7 +230,7 @@ void main() { final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = factory.simpleTestProvider( - (ref) => Future.value(ref.watch(dep)), + (ref, _) => Future.value(ref.watch(dep)), ); container.listen(provider, (previous, next) {}); @@ -279,7 +281,7 @@ void main() { final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = factory.simpleTestProvider( - (ref) => Future.value(ref.watch(dep)), + (ref, _) => Future.value(ref.watch(dep)), ); container.listen(provider, (previous, next) {}); @@ -300,7 +302,7 @@ void main() { }); test('does not notify listeners when refreshed during loading', () async { - final provider = factory.simpleTestProvider((ref) => Future.value(0)); + final provider = factory.simpleTestProvider((ref, _) => Future.value(0)); final container = ProviderContainer.test(); final listener = Listener>(); @@ -321,8 +323,8 @@ void main() { test('supports listenSelf', () { final listener = Listener>(); final onError = ErrorListener(); - final provider = factory.simpleTestProvider((ref) { - ref.listenSelf(listener.call, onError: onError.call); + final provider = factory.simpleTestProvider((ref, self) { + self.listenSelf(listener.call, onError: onError.call); Error.throwWithStackTrace(42, StackTrace.empty); }); final container = ProviderContainer.test(); @@ -350,7 +352,7 @@ void main() { test( 'converts AsyncNotifier.build into an AsyncData if the future completes', () async { - final provider = factory.simpleTestProvider((ref) => Future.value(0)); + final provider = factory.simpleTestProvider((ref, _) => Future.value(0)); final container = ProviderContainer.test(); final listener = Listener>(); @@ -377,7 +379,7 @@ void main() { test('converts AsyncNotifier.build into an AsyncError if the future fails', () async { final provider = factory.simpleTestProvider( - (ref) => Future.error(0, StackTrace.empty), + (ref, _) => Future.error(0, StackTrace.empty), ); final container = ProviderContainer.test(); final listener = Listener>(); @@ -426,7 +428,7 @@ void main() { test( 'synchronously emits AsyncData if AsyncNotifier.build emits synchronously', () async { - final provider = factory.simpleTestProvider((ref) => 0); + final provider = factory.simpleTestProvider((ref, _) => 0); final container = ProviderContainer.test(); final listener = Listener>(); @@ -441,7 +443,7 @@ void main() { 'synchronously emits AsyncError if AsyncNotifier.build throws synchronously', () async { final provider = factory.simpleTestProvider( - (ref) => Error.throwWithStackTrace(42, StackTrace.empty), + (ref, _) => Error.throwWithStackTrace(42, StackTrace.empty), ); final container = ProviderContainer.test(); final listener = Listener>(); @@ -469,7 +471,7 @@ void main() { 1: Completer.sync(), }; final provider = factory.simpleTestProvider( - (ref) => completers[ref.watch(dep)]!.future, + (ref, _) => completers[ref.watch(dep)]!.future, ); final listener = Listener>(); @@ -508,7 +510,7 @@ void main() { 1: Completer.sync(), }; final provider = factory.simpleTestProvider( - (ref) => completers[ref.watch(dep)]!.future, + (ref, _) => completers[ref.watch(dep)]!.future, ); final listener = Listener>(); @@ -544,7 +546,7 @@ void main() { test( 'when manually modifying the state, the new exposed value contains the previous state when possible', () async { - final provider = factory.simpleTestProvider((ref) => 0); + final provider = factory.simpleTestProvider((ref, _) => 0); final container = ProviderContainer.test(); final sub = container.listen(provider.notifier, (previous, next) {}); @@ -582,12 +584,10 @@ void main() { final provider = factory.provider( () { late TestAsyncNotifier notifier; - return notifier = factory.deferredNotifier( - (ref) { - state = notifier.state; - return Future.value(ref.watch(dep)); - }, - ); + return notifier = factory.deferredNotifier((ref, _) { + state = notifier.state; + return Future.value(ref.watch(dep)); + }); }, ); final container = ProviderContainer.test(); @@ -606,7 +606,7 @@ void main() { }); test('notifies listeners when the setter is called', () { - final provider = factory.simpleTestProvider((ref) => 0); + final provider = factory.simpleTestProvider((ref, _) => 0); final container = ProviderContainer.test(); final listener = Listener>(); @@ -628,7 +628,7 @@ void main() { () async { final container = ProviderContainer.test(); final listener = Listener>(); - var body = () => factory.deferredNotifier((ref) => 0); + var body = () => factory.deferredNotifier((ref, _) => 0); final provider = factory.provider(() => body()); container.listen(provider.future, listener.call); @@ -655,7 +655,7 @@ void main() { final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( - (ref) => completer.future, + (ref, _) => completer.future, ); final future = container.read(provider.future); @@ -672,7 +672,7 @@ void main() { final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( - (ref) => completer.future, + (ref, _) => completer.future, ); final future = container.read(provider.future); @@ -691,7 +691,7 @@ void main() { final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( - (ref) => completer.future, + (ref, _) => completer.future, ); container.read(provider); @@ -714,7 +714,7 @@ void main() { final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( - (ref) => completer.future, + (ref, _) => completer.future, ); container.read(provider); @@ -738,7 +738,7 @@ void main() { final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( - (ref) => completer.future, + (ref, _) => completer.future, ); final listener = Listener>(); @@ -763,7 +763,7 @@ void main() { test('resolves with the new state when notifier.state is changed', () async { final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider((ref) => 0); + final provider = factory.simpleTestProvider((ref, _) => 0); final listener = Listener>(); final sub = container.listen(provider.notifier, (previous, next) {}); @@ -788,7 +788,7 @@ void main() { final listener = OnBuildMock(); final dep = StateProvider((ref) => 0); final provider = factory.simpleTestProvider( - (ref) { + (ref, _) { listener(); return Future.value(ref.watch(dep)); }, @@ -808,7 +808,7 @@ void main() { final container = ProviderContainer.test(); final listener = Listener<$AsyncNotifier>(); final onError = ErrorListener(); - var body = () => factory.deferredNotifier((ref) => 0); + var body = () => factory.deferredNotifier((ref, _) => 0); final provider = factory.provider(() => body()); container.listen( @@ -839,7 +839,7 @@ void main() { final dep = StateProvider((ref) => 0); final provider = factory.provider(() { return factory.deferredNotifier( - (ref) => Future.value(ref.watch(dep)), + (ref, _) => Future.value(ref.watch(dep)), ); }); final container = ProviderContainer.test(); @@ -870,7 +870,7 @@ void main() { 'Can override AsyncNotifier.updateShouldNotify to change the default filter logic', () { final provider = factory.simpleTestProvider>( - (ref) => Equal(42), + (ref, _) => Equal(42), updateShouldNotify: (a, b) => a != b, ); final container = ProviderContainer.test(); @@ -901,7 +901,7 @@ void main() { test('passes in the latest state', () async { final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( - (ref) => 0, + (ref, _) => 0, ); final sub = container.listen(provider.notifier, (prev, next) {}); @@ -928,7 +928,7 @@ void main() { test('can specify onError to handle error scenario', () async { final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( - (ref) => Error.throwWithStackTrace(42, StackTrace.empty), + (ref, _) => Error.throwWithStackTrace(42, StackTrace.empty), ); var callCount = 0; Object? actualErr; @@ -964,7 +964,7 @@ void main() { test('executes immediately with current state if a state is available', () async { final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider((ref) => 1); + final provider = factory.simpleTestProvider((ref, _) => 1); final sub = container.listen(provider.notifier, (prev, next) {}); @@ -981,7 +981,7 @@ void main() { () async { final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( - (ref) => Error.throwWithStackTrace(42, StackTrace.empty), + (ref, _) => Error.throwWithStackTrace(42, StackTrace.empty), ); var callCount = 0; @@ -1010,7 +1010,7 @@ void main() { test('awaits the future resolution if in loading state', () async { final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( - (ref) => Future.value(42), + (ref, _) => Future.value(42), ); final sub = container.listen(provider.notifier, (prev, next) {}); @@ -1028,17 +1028,17 @@ void main() { test('supports overrideWith', () { final provider = AsyncNotifierProvider, int>( - () => DeferredAsyncNotifier((ref) => 0), + () => DeferredAsyncNotifier((ref, _) => 0), ); final autoDispose = AsyncNotifierProvider.autoDispose, int>( - () => DeferredAsyncNotifier((ref) => 0), + () => DeferredAsyncNotifier((ref, _) => 0), ); final container = ProviderContainer.test( overrides: [ - provider.overrideWith(() => DeferredAsyncNotifier((ref) => 42)), + provider.overrideWith(() => DeferredAsyncNotifier((ref, _) => 42)), autoDispose.overrideWith( - () => DeferredAsyncNotifier((ref) => 84), + () => DeferredAsyncNotifier((ref, _) => 84), ), ], ); @@ -1050,19 +1050,19 @@ void main() { test('supports family overrideWith', () { final family = AsyncNotifierProvider.family< DeferredFamilyAsyncNotifier, int, int>( - () => DeferredFamilyAsyncNotifier((ref) => 0), + () => DeferredFamilyAsyncNotifier((ref, _) => 0), ); final autoDisposeFamily = AsyncNotifierProvider.autoDispose .family, int, int>( - () => DeferredFamilyAsyncNotifier((ref) => 0), + () => DeferredFamilyAsyncNotifier((ref, _) => 0), ); final container = ProviderContainer.test( overrides: [ family.overrideWith( - () => DeferredFamilyAsyncNotifier((ref) => 42), + () => DeferredFamilyAsyncNotifier((ref, _) => 42), ), autoDisposeFamily.overrideWith( - () => DeferredFamilyAsyncNotifier((ref) => 84), + () => DeferredFamilyAsyncNotifier((ref, _) => 84), ), ], ); @@ -1082,7 +1082,7 @@ void main() { test('provider', () { final provider = AsyncNotifierProvider, int>( - () => DeferredAsyncNotifier((ref) => 0), + () => DeferredAsyncNotifier((ref, _) => 0), ); provider.select((AsyncValue value) => 0); @@ -1101,7 +1101,7 @@ void main() { test('autoDispose', () { final autoDispose = AsyncNotifierProvider.autoDispose, int>( - () => DeferredAsyncNotifier((ref) => 0), + () => DeferredAsyncNotifier((ref, _) => 0), ); autoDispose.select((AsyncValue value) => 0); @@ -1124,7 +1124,7 @@ void main() { test('family', () { final family = AsyncNotifierProvider.family< DeferredFamilyAsyncNotifier, String, int>( - () => DeferredFamilyAsyncNotifier((ref) => '0'), + () => DeferredFamilyAsyncNotifier((ref, _) => '0'), ); family(0).select((AsyncValue value) => 0); @@ -1152,7 +1152,7 @@ void main() { final autoDisposeFamily = AsyncNotifierProvider.autoDispose .family, String, int>( - () => DeferredFamilyAsyncNotifier((ref) => '0'), + () => DeferredFamilyAsyncNotifier((ref, _) => '0'), ); autoDisposeFamily(0).select((AsyncValue value) => 0); diff --git a/packages/riverpod/test/src/providers/future_provider_test.dart b/packages/riverpod/test/src/providers/future_provider_test.dart index 5d42a98b1..a113c11f6 100644 --- a/packages/riverpod/test/src/providers/future_provider_test.dart +++ b/packages/riverpod/test/src/providers/future_provider_test.dart @@ -22,7 +22,7 @@ void main() { expect(container.read(provider), const AsyncValue.loading()); - ref.state = const AsyncValue.loading(progress: .2); + ref.state = const AsyncValue.loading(progress: .2); container.refresh(provider); diff --git a/packages/riverpod/test/src/providers/notifier_test.dart b/packages/riverpod/test/src/providers/notifier_test.dart index 35ae2a421..bbd164b7d 100644 --- a/packages/riverpod/test/src/providers/notifier_test.dart +++ b/packages/riverpod/test/src/providers/notifier_test.dart @@ -26,7 +26,7 @@ void main() { notifierProviderFactory.createGroup((factory) { test('Cannot share a Notifier instance between providers ', () { final container = ProviderContainer.test(); - final notifier = factory.deferredNotifier((ref) => 0); + final notifier = factory.deferredNotifier((ref, _) => 0); final provider = factory.provider(() => notifier); final provider2 = factory.provider(() => notifier); @@ -43,7 +43,7 @@ void main() { final container = ProviderContainer.test(); late TestNotifier notifier; late List errors; - final provider = factory.simpleTestProvider((ref) { + final provider = factory.simpleTestProvider((ref, _) { ref.onDispose(() { errors = captureErrors([ () => notifier.state, @@ -66,7 +66,7 @@ void main() { test('Using the notifier after dispose throws', () { final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider((ref) => 0); + final provider = factory.simpleTestProvider((ref, _) => 0); container.listen(provider.notifier, (prev, next) {}); final notifier = container.read(provider.notifier); @@ -90,7 +90,7 @@ void main() { // Regression test for https://github.com/rrousselGit/riverpod/issues/2617 final container = ProviderContainer.test(); - final notifier = factory.deferredNotifier((ref) => 0); + final notifier = factory.deferredNotifier((ref, _) => 0); final provider = factory.provider(() => notifier); final provider2 = factory.provider(() => notifier); @@ -109,7 +109,7 @@ void main() { final provider = factory.provider(() { late TestNotifier notifier; - return notifier = factory.deferredNotifier((ref) { + return notifier = factory.deferredNotifier((ref, _) { stateInBuild.add(notifier.stateOrNull); return 0; }); @@ -128,7 +128,7 @@ void main() { test('returns null if Notifier.build threw', () { final provider = factory.simpleTestProvider( - (ref) => throw Exception('42'), + (ref, _) => throw Exception('42'), ); final container = ProviderContainer.test(); @@ -147,7 +147,7 @@ void main() { final provider = factory.provider(() { late TestNotifier notifier; - return notifier = factory.deferredNotifier((ref) { + return notifier = factory.deferredNotifier((ref, _) { stateInBuild.add(notifier.stateOrNull); return 0; }); @@ -167,7 +167,7 @@ void main() { test('Post build, returns the current state', () { final provider = factory.simpleTestProvider( - (ref) => 0, + (ref, _) => 0, ); final container = ProviderContainer.test(); @@ -187,7 +187,7 @@ void main() { 'On invalidated providers, rebuilds the notifier and return the new state', () { final provider = factory.simpleTestProvider( - (ref) => 0, + (ref, _) => 0, ); final container = ProviderContainer.test(); @@ -209,7 +209,7 @@ void main() { test( 'uses notifier.build as initial state and update listeners when state changes', () { - final provider = factory.simpleTestProvider((ref) => 0); + final provider = factory.simpleTestProvider((ref, _) => 0); final container = ProviderContainer.test(); final listener = Listener(); @@ -229,7 +229,7 @@ void main() { final notifierListener = Listener<$Notifier>(); final dep = StateProvider((ref) => 0); final provider = factory.provider(() { - return factory.deferredNotifier((ref) => ref.watch(dep)); + return factory.deferredNotifier((ref, _) => ref.watch(dep)); }); final container = ProviderContainer.test(); @@ -253,7 +253,7 @@ void main() { test('calls notifier.build on every watch update', () async { final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider((ref) { + final provider = factory.simpleTestProvider((ref, _) { return ref.watch(dep); }); final container = ProviderContainer.test(); @@ -274,7 +274,7 @@ void main() { test('After a state initialization error, the notifier is still available', () { - final provider = factory.simpleTestProvider((ref) { + final provider = factory.simpleTestProvider((ref, _) { throw StateError('Hey'); }); final container = ProviderContainer.test(); @@ -344,7 +344,7 @@ void main() { }); test('can read/set the current state within the notifier', () { - final provider = factory.simpleTestProvider((ref) => 0); + final provider = factory.simpleTestProvider((ref, _) => 0); final container = ProviderContainer.test(); final listener = Listener(); @@ -368,8 +368,8 @@ void main() { test( 'Reading the state inside the notifier rethrows initialization error, if any', () { - final provider = - factory.simpleTestProvider((ref) => throw UnimplementedError()); + final provider = factory + .simpleTestProvider((ref, _) => throw UnimplementedError()); final container = ProviderContainer.test(); final notifier = container.read(provider.notifier); @@ -383,7 +383,7 @@ void main() { final err = UnimplementedError(); final stack = StackTrace.current; final provider = factory.simpleTestProvider( - (ref) => Error.throwWithStackTrace(err, stack), + (ref, _) => Error.throwWithStackTrace(err, stack), ); final container = ProviderContainer.test(); final listener = Listener(); @@ -421,7 +421,7 @@ void main() { }); test('supports ref.refresh(provider)', () { - final provider = factory.simpleTestProvider((ref) => 0); + final provider = factory.simpleTestProvider((ref, _) => 0); final container = ProviderContainer.test(); expect(container.read(provider), 0); @@ -438,8 +438,8 @@ void main() { test('supports listenSelf((State? prev, State next) {})', () { final listener = Listener(); final onError = ErrorListener(); - final provider = factory.simpleTestProvider((ref) { - ref.listenSelf(listener.call, onError: onError.call); + final provider = factory.simpleTestProvider((ref, self) { + self.listenSelf(listener.call, onError: onError.call); Error.throwWithStackTrace(42, StackTrace.empty); }); final container = ProviderContainer.test(); @@ -451,7 +451,7 @@ void main() { test('filters state update by identical by default', () { final provider = - factory.simpleTestProvider>((ref) => Equal(42)); + factory.simpleTestProvider>((ref, _) => Equal(42)); final container = ProviderContainer.test(); final listener = Listener>(); @@ -474,7 +474,7 @@ void main() { 'Can override Notifier.updateShouldNotify to change the default filter logic', () { final provider = factory.simpleTestProvider>( - (ref) => Equal(42), + (ref, _) => Equal(42), updateShouldNotify: (a, b) => a != b, ); final container = ProviderContainer.test(); @@ -505,7 +505,7 @@ void main() { test('keeps state alive if notifier is listened', () async { final container = ProviderContainer.test(); final onDispose = OnDisposeMock(); - final provider = factory.simpleTestProvider((ref) { + final provider = factory.simpleTestProvider((ref, _) { ref.onDispose(onDispose.call); return 0; }); @@ -531,17 +531,17 @@ void main() { test('supports overrideWith', () { final provider = NotifierProvider, int>( - () => DeferredNotifier((ref) => 0), + () => DeferredNotifier((ref, _) => 0), ); final autoDispose = NotifierProvider.autoDispose, int>( - () => DeferredNotifier((ref) => 0), + () => DeferredNotifier((ref, _) => 0), ); final container = ProviderContainer.test( overrides: [ - provider.overrideWith(() => DeferredNotifier((ref) => 42)), + provider.overrideWith(() => DeferredNotifier((ref, _) => 42)), autoDispose.overrideWith( - () => DeferredNotifier((ref) => 84), + () => DeferredNotifier((ref, _) => 84), ), ], ); @@ -553,19 +553,19 @@ void main() { test('supports family overrideWith', () { final family = NotifierProvider.family, int, int>( - () => DeferredFamilyNotifier((ref) => 0), + () => DeferredFamilyNotifier((ref, _) => 0), ); final autoDisposeFamily = NotifierProvider.autoDispose .family, int, int>( - () => DeferredFamilyNotifier((ref) => 0), + () => DeferredFamilyNotifier((ref, _) => 0), ); final container = ProviderContainer.test( overrides: [ family.overrideWith( - () => DeferredFamilyNotifier((ref) => 42), + () => DeferredFamilyNotifier((ref, _) => 42), ), autoDisposeFamily.overrideWith( - () => DeferredFamilyNotifier((ref) => 84), + () => DeferredFamilyNotifier((ref, _) => 84), ), ], ); @@ -585,7 +585,7 @@ void main() { test('provider', () { final provider = NotifierProvider, int>( - () => DeferredNotifier((ref) => 0), + () => DeferredNotifier((ref, _) => 0), ); provider.select((int value) => 0); @@ -600,7 +600,7 @@ void main() { test('autoDispose', () { final autoDispose = NotifierProvider.autoDispose, int>( - () => DeferredNotifier((ref) => 0), + () => DeferredNotifier((ref, _) => 0), ); autoDispose.select((int value) => 0); @@ -619,7 +619,7 @@ void main() { test('family', () { final family = NotifierProvider.family, String, int>( - () => DeferredFamilyNotifier((ref) => '0'), + () => DeferredFamilyNotifier((ref, _) => '0'), ); family(0).select((String value) => 0); @@ -643,7 +643,7 @@ void main() { final autoDisposeFamily = NotifierProvider.autoDispose .family, String, int>( - () => DeferredFamilyNotifier((ref) => '0'), + () => DeferredFamilyNotifier((ref, _) => '0'), ); autoDisposeFamily(0).select((String value) => 0); diff --git a/packages/riverpod/test/src/providers/stream_notifier_test.dart b/packages/riverpod/test/src/providers/stream_notifier_test.dart index 910cadc2d..eb9bf68d5 100644 --- a/packages/riverpod/test/src/providers/stream_notifier_test.dart +++ b/packages/riverpod/test/src/providers/stream_notifier_test.dart @@ -34,7 +34,7 @@ void main() { final onCancel = OnCancelMock(); final container = ProviderContainer.test(); final cancelCompleter = Completer.sync(); - final provider = factory.simpleTestProvider((ref) { + final provider = factory.simpleTestProvider((ref, _) { final controller = StreamController(); ref.onDispose(() { controller.addError(42); @@ -72,15 +72,13 @@ void main() { final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider( - (ref) { - return DelegatingStream( - streamController.stream, - onSubscriptionPause: onSubPause.call, - onSubscriptionResume: onSubResume.call, - ); - }, - ); + final provider = factory.simpleTestProvider((ref, _) { + return DelegatingStream( + streamController.stream, + onSubscriptionPause: onSubPause.call, + onSubscriptionResume: onSubResume.call, + ); + }); final sub = container.listen(provider, (previous, next) {}); @@ -105,7 +103,7 @@ void main() { var err = Exception('foo'); final stack = StackTrace.current; final provider = factory.deferredProvider( - (ref) => Error.throwWithStackTrace(err, stack), + (ref, _) => Error.throwWithStackTrace(err, stack), retry: (_, __) => const Duration(seconds: 1), ); final listener = Listener>(); @@ -163,7 +161,7 @@ void main() { test('Cannot share a Notifier instance between providers ', () { final container = ProviderContainer.test(); - final notifier = factory.deferredNotifier((ref) => Stream.value(0)); + final notifier = factory.deferredNotifier((ref, _) => Stream.value(0)); final provider = factory.provider(() => notifier); final provider2 = factory.provider(() => notifier); @@ -180,7 +178,7 @@ void main() { final container = ProviderContainer.test(); late TestStreamNotifier notifier; late List errors; - final provider = factory.simpleTestProvider((ref) { + final provider = factory.simpleTestProvider((ref, self) { ref.onDispose(() { errors = captureErrors([ () => notifier.state, @@ -204,7 +202,9 @@ void main() { test('Using the notifier after dispose throws', () { final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider((ref) => Stream.value(0)); + final provider = factory.simpleTestProvider( + (ref, self) => Stream.value(0), + ); container.listen(provider.notifier, (prev, next) {}); final notifier = container.read(provider.notifier); @@ -237,7 +237,7 @@ void main() { final container = ProviderContainer.test(); var count = 0; final provider = factory.simpleTestProvider( - (ref) => Stream.value(count++), + (ref, self) => Stream.value(count++), ); container.listen(provider, (previous, next) {}); @@ -267,7 +267,9 @@ void main() { 'performs seamless:false copyWithPrevious on `state = AsyncLoading()`', () async { final container = ProviderContainer.test(); - final provider = factory.simpleTestProvider((ref) => Stream.value(0)); + final provider = factory.simpleTestProvider( + (ref, self) => Stream.value(0), + ); final sub = container.listen(provider.notifier, (previous, next) {}); @@ -289,7 +291,7 @@ void main() { final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = factory.simpleTestProvider( - (ref) => Stream.value(ref.watch(dep)), + (ref, self) => Stream.value(ref.watch(dep)), ); container.listen(provider, (previous, next) {}); @@ -314,7 +316,7 @@ void main() { final container = ProviderContainer.test(); final dep = StateProvider((ref) => 0); final provider = factory.simpleTestProvider( - (ref) => Stream.value(ref.watch(dep)), + (ref, self) => Stream.value(ref.watch(dep)), ); container.listen(provider, (previous, next) {}); @@ -335,7 +337,9 @@ void main() { }); test('does not notify listeners when refreshed during loading', () async { - final provider = factory.simpleTestProvider((ref) => Stream.value(0)); + final provider = factory.simpleTestProvider( + (ref, self) => Stream.value(0), + ); final container = ProviderContainer.test(); final listener = Listener>(); @@ -356,8 +360,8 @@ void main() { test('supports listenSelf', () { final listener = Listener>(); final onError = ErrorListener(); - final provider = factory.simpleTestProvider((ref) { - ref.listenSelf(listener.call, onError: onError.call); + final provider = factory.simpleTestProvider((ref, self) { + self.listenSelf(listener.call, onError: onError.call); Error.throwWithStackTrace(42, StackTrace.empty); }); final container = ProviderContainer.test(); @@ -385,7 +389,9 @@ void main() { test( 'converts StreamNotifier.build into an AsyncData if the future completes', () async { - final provider = factory.simpleTestProvider((ref) => Stream.value(0)); + final provider = factory.simpleTestProvider((ref, self) => Stream.value( + 0, + )); final container = ProviderContainer.test(); final listener = Listener>(); @@ -412,7 +418,7 @@ void main() { test('converts StreamNotifier.build into an AsyncError if the future fails', () async { final provider = factory.simpleTestProvider( - (ref) => Stream.error(0, StackTrace.empty), + (ref, _) => Stream.error(0, StackTrace.empty), ); final container = ProviderContainer.test(); final listener = Listener>(); @@ -463,7 +469,7 @@ void main() { 'synchronously emits AsyncError if StreamNotifier.build throws synchronously', () async { final provider = factory.simpleTestProvider( - (ref) => Error.throwWithStackTrace(42, StackTrace.empty), + (ref, _) => Error.throwWithStackTrace(42, StackTrace.empty), ); final container = ProviderContainer.test(); final listener = Listener>(); @@ -491,7 +497,7 @@ void main() { 1: Completer.sync(), }; final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completers[ref.watch(dep)]!.future), + (ref, _) => Stream.fromFuture(completers[ref.watch(dep)]!.future), ); final listener = Listener>(); @@ -530,7 +536,7 @@ void main() { 1: Completer.sync(), }; final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completers[ref.watch(dep)]!.future), + (ref, _) => Stream.fromFuture(completers[ref.watch(dep)]!.future), ); final listener = Listener>(); @@ -567,7 +573,7 @@ void main() { 'when manually modifying the state, the new exposed value contains the previous state when possible', () async { final provider = factory.simpleTestProvider( - (ref) => Stream.value(0), + (ref, _) => Stream.value(0), ); final container = ProviderContainer.test(); @@ -610,12 +616,10 @@ void main() { final provider = factory.provider( () { late TestStreamNotifier notifier; - return notifier = factory.deferredNotifier( - (ref) { - state = notifier.state; - return Stream.value(ref.watch(dep)); - }, - ); + return notifier = factory.deferredNotifier((ref, _) { + state = notifier.state; + return Stream.value(ref.watch(dep)); + }); }, ); final container = ProviderContainer.test(); @@ -634,7 +638,9 @@ void main() { }); test('notifies listeners when the setter is called', () async { - final provider = factory.simpleTestProvider((ref) => Stream.value(0)); + final provider = factory.simpleTestProvider( + (ref, self) => Stream.value(0), + ); final container = ProviderContainer.test(); final listener = Listener>(); @@ -661,7 +667,7 @@ void main() { final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completer.future), + (ref, _) => Stream.fromFuture(completer.future), ); final future = container.read(provider.future); @@ -678,7 +684,7 @@ void main() { final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completer.future), + (ref, _) => Stream.fromFuture(completer.future), ); final future = container.read(provider.future); @@ -697,7 +703,7 @@ void main() { final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completer.future), + (ref, _) => Stream.fromFuture(completer.future), ); container.read(provider); @@ -719,7 +725,7 @@ void main() { final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completer.future), + (ref, _) => Stream.fromFuture(completer.future), ); container.listen(provider, (previous, next) {}); @@ -742,7 +748,7 @@ void main() { final container = ProviderContainer.test(); final completer = Completer.sync(); final provider = factory.simpleTestProvider( - (ref) => Stream.fromFuture(completer.future), + (ref, _) => Stream.fromFuture(completer.future), ); final listener = Listener>(); @@ -768,7 +774,7 @@ void main() { () async { final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( - (ref) => Stream.value(0), + (ref, _) => Stream.value(0), ); final listener = Listener>(); @@ -793,12 +799,10 @@ void main() { test('returns a Future identical to that of .future', () { final listener = OnBuildMock(); final dep = StateProvider((ref) => 0); - final provider = factory.simpleTestProvider( - (ref) { - listener(); - return Stream.value(ref.watch(dep)); - }, - ); + final provider = factory.simpleTestProvider((ref, _) { + listener(); + return Stream.value(ref.watch(dep)); + }); final container = ProviderContainer.test(); container.listen(provider.notifier, (previous, next) {}); @@ -816,7 +820,7 @@ void main() { final dep = StateProvider((ref) => 0); final provider = factory.provider(() { return factory.deferredNotifier( - (ref) => Stream.value(ref.watch(dep)), + (ref, _) => Stream.value(ref.watch(dep)), ); }); final container = ProviderContainer.test(); @@ -847,7 +851,7 @@ void main() { 'Can override StreamNotifier.updateShouldNotify to change the default filter logic', () async { final provider = factory.simpleTestProvider>( - (ref) => Stream.value(Equal(42)), + (ref, _) => Stream.value(Equal(42)), updateShouldNotify: (a, b) => a != b, ); final container = ProviderContainer.test(); @@ -881,7 +885,7 @@ void main() { test('passes in the latest state', () async { final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( - (ref) => Stream.value(0), + (ref, _) => Stream.value(0), ); // Skip the loading @@ -911,7 +915,7 @@ void main() { test('can specify onError to handle error scenario', () async { final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( - (ref) => Error.throwWithStackTrace(42, StackTrace.empty), + (ref, _) => Error.throwWithStackTrace(42, StackTrace.empty), ); var callCount = 0; Object? actualErr; @@ -948,7 +952,7 @@ void main() { () async { final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( - (ref) => Stream.value(1), + (ref, _) => Stream.value(1), ); // Skip the loading @@ -969,7 +973,7 @@ void main() { () async { final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( - (ref) => Error.throwWithStackTrace(42, StackTrace.empty), + (ref, _) => Error.throwWithStackTrace(42, StackTrace.empty), ); var callCount = 0; @@ -998,7 +1002,7 @@ void main() { test('awaits the future resolution if in loading state', () async { final container = ProviderContainer.test(); final provider = factory.simpleTestProvider( - (ref) => Stream.value(42), + (ref, _) => Stream.value(42), ); final sub = container.listen(provider.notifier, (prev, next) {}); @@ -1016,19 +1020,19 @@ void main() { test('supports overrideWith', () async { final provider = StreamNotifierProvider, int>( - () => DeferredStreamNotifier((ref) => Stream.value(0)), + () => DeferredStreamNotifier((ref, _) => Stream.value(0)), ); final autoDispose = StreamNotifierProvider.autoDispose, int>( - () => DeferredStreamNotifier((ref) => Stream.value(0)), + () => DeferredStreamNotifier((ref, _) => Stream.value(0)), ); final container = ProviderContainer.test( overrides: [ provider.overrideWith( - () => DeferredStreamNotifier((ref) => Stream.value(42)), + () => DeferredStreamNotifier((ref, _) => Stream.value(42)), ), autoDispose.overrideWith( - () => DeferredStreamNotifier((ref) => Stream.value(84)), + () => DeferredStreamNotifier((ref, _) => Stream.value(84)), ), ], ); @@ -1044,20 +1048,20 @@ void main() { test('supports family overrideWith', () async { final family = StreamNotifierProvider.family< DeferredFamilyStreamNotifier, int, int>( - () => DeferredFamilyStreamNotifier((ref) => Stream.value(0)), + () => DeferredFamilyStreamNotifier((ref, _) => Stream.value(0)), ); final autoDisposeFamily = StreamNotifierProvider.autoDispose .family, int, int>( - () => DeferredFamilyStreamNotifier((ref) => Stream.value(0)), + () => DeferredFamilyStreamNotifier((ref, _) => Stream.value(0)), ); final container = ProviderContainer.test( overrides: [ family.overrideWith( - () => DeferredFamilyStreamNotifier((ref) => Stream.value(42)), + () => DeferredFamilyStreamNotifier((ref, _) => Stream.value(42)), ), autoDisposeFamily.overrideWith( () => DeferredFamilyStreamNotifier( - (ref) => Stream.value(84), + (ref, _) => Stream.value(84), ), ), ], @@ -1078,7 +1082,7 @@ void main() { final dep = Provider.autoDispose((ref) => 0); final provider = StreamNotifierProvider.autoDispose, int>( - () => DeferredStreamNotifier((ref) { + () => DeferredStreamNotifier((ref, _) { return Stream.value(ref.watch(dep)); }), ); @@ -1102,7 +1106,7 @@ void main() { test('provider', () { final provider = StreamNotifierProvider, int>( - () => DeferredStreamNotifier((ref) => Stream.value(0)), + () => DeferredStreamNotifier((ref, _) => Stream.value(0)), ); provider.select((AsyncValue value) => 0); @@ -1121,7 +1125,7 @@ void main() { test('autoDispose', () { final autoDispose = StreamNotifierProvider.autoDispose, int>( - () => DeferredStreamNotifier((ref) => Stream.value(0)), + () => DeferredStreamNotifier((ref, _) => Stream.value(0)), ); autoDispose.select((AsyncValue value) => 0); @@ -1144,7 +1148,7 @@ void main() { test('family', () { final family = StreamNotifierProvider.family< DeferredFamilyStreamNotifier, String, int>( - () => DeferredFamilyStreamNotifier((ref) => Stream.value('0')), + () => DeferredFamilyStreamNotifier((ref, _) => Stream.value('0')), ); family(0).select((AsyncValue value) => 0); @@ -1172,7 +1176,7 @@ void main() { final autoDisposeFamily = StreamNotifierProvider.autoDispose .family, String, int>( - () => DeferredFamilyStreamNotifier((ref) => Stream.value('0')), + () => DeferredFamilyStreamNotifier((ref, _) => Stream.value('0')), ); autoDisposeFamily(0).select((AsyncValue value) => 0); From 3f5fd410810470d7bfec3ff458ee210b28fe9588 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sat, 2 Nov 2024 22:25:39 +0100 Subject: [PATCH 360/387] Fix some depreciation --- .../framework/provider_container_test.dart | 21 ++++++++++++------- ..._dispose_state_notifier_provider_test.dart | 6 ++++-- .../test/src/core/uni_directional_test.dart | 11 ++++++---- .../src/providers/stream_notifier_test.dart | 6 +++--- 4 files changed, 27 insertions(+), 17 deletions(-) diff --git a/packages/riverpod/test/old/framework/provider_container_test.dart b/packages/riverpod/test/old/framework/provider_container_test.dart index 6f167cfd4..36c54c899 100644 --- a/packages/riverpod/test/old/framework/provider_container_test.dart +++ b/packages/riverpod/test/old/framework/provider_container_test.dart @@ -2,6 +2,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/src/internals.dart'; import 'package:test/test.dart'; +import '../../src/matrix.dart'; import '../utils.dart'; void main() { @@ -144,10 +145,12 @@ void main() { () async { final dep = StateProvider((ref) => 0); final provider = Provider((ref) => ref.watch(dep)); - final another = StateProvider((ref) { - ref.listen(provider, (prev, value) => ref.state++); - return 0; - }); + final another = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + ref.listen(provider, (prev, value) => self.state++); + return 0; + }), + ); final container = ProviderContainer.test(); expect(container.read(another), 0); @@ -162,10 +165,12 @@ void main() { () async { final dep = StateProvider((ref) => 0); final provider = Provider((ref) => ref.watch(dep)); - final another = StateProvider((ref) { - ref.listen(provider, (prev, value) => ref.state++); - return 0; - }); + final another = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + ref.listen(provider, (prev, value) => self.state++); + return 0; + }), + ); final container = ProviderContainer.test(); expect(container.read(another), 0); diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart index cd2be06e0..c4348c0bf 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart @@ -107,11 +107,13 @@ void main() { }); test('can specify name', () { - final provider = StateNotifierProvider.autoDispose( + final provider = StateNotifierProvider.autoDispose( (_) => TestNotifier(), name: 'example', ); - final provider2 = StateNotifierProvider.autoDispose((_) => TestNotifier()); + final provider2 = StateNotifierProvider.autoDispose( + (_) => TestNotifier(), + ); expect(provider.name, 'example'); expect(provider2.name, isNull); diff --git a/packages/riverpod/test/src/core/uni_directional_test.dart b/packages/riverpod/test/src/core/uni_directional_test.dart index ae63b2072..2bf07a19f 100644 --- a/packages/riverpod/test/src/core/uni_directional_test.dart +++ b/packages/riverpod/test/src/core/uni_directional_test.dart @@ -2,6 +2,7 @@ import 'package:mockito/mockito.dart'; import 'package:riverpod/src/internals.dart'; import 'package:test/test.dart'; +import '../matrix.dart'; import '../utils.dart'; void main() { @@ -34,10 +35,12 @@ void main() { test('rebuilding a provider can modify other providers', () async { final dep = StateProvider((ref) => 0); final provider = Provider((ref) => ref.watch(dep)); - final another = StateProvider((ref) { - ref.listen(provider, (prev, value) => ref.state++); - return 0; - }); + final another = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + ref.listen(provider, (prev, value) => self.state++); + return 0; + }), + ); final container = ProviderContainer.test(); expect(container.read(another), 0); diff --git a/packages/riverpod/test/src/providers/stream_notifier_test.dart b/packages/riverpod/test/src/providers/stream_notifier_test.dart index eb9bf68d5..468cb7741 100644 --- a/packages/riverpod/test/src/providers/stream_notifier_test.dart +++ b/packages/riverpod/test/src/providers/stream_notifier_test.dart @@ -389,9 +389,9 @@ void main() { test( 'converts StreamNotifier.build into an AsyncData if the future completes', () async { - final provider = factory.simpleTestProvider((ref, self) => Stream.value( - 0, - )); + final provider = factory.simpleTestProvider( + (ref, self) => Stream.value(0), + ); final container = ProviderContainer.test(); final listener = Listener>(); From 81f41e776f4e3d3663f04b47b3f9fbe78dafc65c Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 3 Nov 2024 00:24:12 +0100 Subject: [PATCH 361/387] Fix lints --- .../change_notifier_provider_test.dart | 16 -- packages/riverpod/CHANGELOG.md | 1 + packages/riverpod/lib/src/core/element.dart | 18 +- .../src/core/provider/notifier_provider.dart | 31 +-- .../lib/src/core/provider_container.dart | 2 - packages/riverpod/lib/src/core/ref.dart | 62 +++--- ..._dispose_state_notifier_provider_test.dart | 15 -- .../state_notifier_provider_test.dart | 15 -- .../auto_dispose_future_provider_test.dart | 31 --- .../future_provider/future_provider_test.dart | 70 ------- .../provider/auto_dispose_provider_test.dart | 97 --------- .../provider/provider_test.dart | 184 ++++-------------- .../auto_dispose_stream_provider_test.dart | 39 ---- .../stream_provider/stream_provider_test.dart | 101 +++------- .../test/src/core/auto_dispose_test.dart | 2 - .../src/core/modifiers/select_async_test.dart | 25 +-- .../test/src/core/provider_element_test.dart | 21 +- packages/riverpod/test/src/core/ref_test.dart | 36 +--- .../src/matrix/async_notifier_provider.dart | 15 +- .../test/src/matrix/notifier_provider.dart | 5 +- .../src/matrix/stream_notifier_provider.dart | 2 + .../src/providers/async_notifier_test.dart | 119 +++++++++++ .../src/providers/future_provider_test.dart | 50 ----- .../src/providers/stream_notifier_test.dart | 15 +- .../lib/src/riverpod_generator.dart | 1 - .../riverpod_generator/test/doc_test.dart | 6 - .../riverpod_generator/test/stream_test.dart | 22 ++- 27 files changed, 316 insertions(+), 685 deletions(-) diff --git a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart index b6501249e..0585c526a 100644 --- a/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart +++ b/packages/flutter_riverpod/test/providers/change_notifier/change_notifier_provider_test.dart @@ -5,7 +5,6 @@ import 'dart:async'; import 'package:flutter/widgets.dart' hide Listener; import 'package:flutter_riverpod/src/internals.dart'; import 'package:flutter_test/flutter_test.dart'; -import 'package:mockito/mockito.dart'; import '../../utils.dart'; @@ -77,21 +76,6 @@ void main() { container.dispose(); }); - test('can read and set current ChangeNotifier', () async { - final container = ProviderContainer.test(); - final listener = Listener>(); - late Ref ref; - final provider = ChangeNotifierProvider>((r) { - ref = r; - return ValueNotifier(0); - }); - - container.listen(provider, listener.call); - - verifyZeroInteractions(listener); - expect(ref.state.value, 0); - }); - test('can refresh .notifier', () async { var initialValue = 1; final provider = ChangeNotifierProvider>( diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 33f85c447..7c42ef9e4 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -17,6 +17,7 @@ rebuilds. This enables using `Ref.mounted` to check dispose. - **Breaking**: `StreamProvider` now pauses its `StreamSubscription` when the provider is not actively listened. +- **Breaking**: Calling ref.watch multiple times calls ref.onListen every-times. - **Breaking**: A provider is now considered "paused" if all of its listeners are also paused. So if a provider `A` is watched _only_ by a provider `B`, and `B` is currently unused, then `A` will be paused. diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index c5e61439d..e8b408d91 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -72,7 +72,8 @@ abstract class ProviderElement implements Node { /// The [ProviderContainer] that owns this [ProviderElement]. ProviderContainer get container => pointer.targetContainer; - Ref? ref; + // ignore: library_private_types_in_public_api, not public + _Ref? ref; /// Whether this [ProviderElement] is actively in use. /// @@ -229,7 +230,7 @@ This could mean a few things: _debugCurrentCreateHash = provider.debugGetCreateSourceHash(); } - final ref = this.ref = Ref._(this); + final ref = this.ref = _Ref(this); buildState(ref); _notifyListeners( @@ -254,7 +255,7 @@ This could mean a few things: /// to dependencies that are no-longer used. void _performBuild() { runOnDispose(); - final ref = this.ref = Ref._(this); + final ref = this.ref = _Ref(this); final previousStateResult = _stateResult; if (kDebugMode) _debugDidSetState = false; @@ -282,7 +283,11 @@ This could mean a few things: /// - [didChangeDependency] can be used to differentiate a rebuild caused /// by [Ref.watch] from one caused by [Ref.refresh]/[Ref.invalidate]. @visibleForOverriding - void create(Ref ref, {required bool didChangeDependency}); + void create( + // ignore: library_private_types_in_public_api, not public + _Ref ref, { + required bool didChangeDependency, + }); /// A utility for re-initializing a provider when needed. /// @@ -323,7 +328,10 @@ This could mean a few things: /// Invokes [create] and handles errors. @internal - void buildState(Ref ref) { + void buildState( + // ignore: library_private_types_in_public_api, not public + _Ref ref, + ) { if (_didChangeDependency) _retryCount = 0; ProviderElement? debugPreviouslyBuildingElement; diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index a8de29417..db3ef4566 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -54,15 +54,9 @@ typedef RunNotifierBuild = CreatedT Function( /// } /// ``` abstract class NotifierBase { - Ref? _ref; - + _Ref? _ref; @protected - Ref get ref { - final ref = _ref; - if (ref == null) throw StateError(uninitializedElementError); - - return ref; - } + Ref get ref => $ref; /// Listens to changes on the value exposed by this provider. /// @@ -76,19 +70,16 @@ abstract class NotifierBase { void Function(StateT? previous, StateT next) listener, { void Function(Object error, StackTrace stackTrace)? onError, }) { - ref.listenSelf( - (prev, next) => listener(prev, next), - onError: onError, - ); + $ref.listenSelf(listener, onError: onError); } @visibleForTesting @protected - StateT get state => ref.state; + StateT get state => $ref.state; @visibleForTesting @protected - set state(StateT newState) => ref.state = newState; + set state(StateT newState) => $ref.state = newState; CreatedT runBuild(); @@ -99,6 +90,15 @@ abstract class NotifierBase { @internal extension ClassBaseX on NotifierBase { ProviderElement? get element => _ref?._element; + + @internal + // ignore: library_private_types_in_public_api, not public + _Ref get $ref { + final ref = _ref; + if (ref == null) throw StateError(uninitializedElementError); + + return ref; + } } /// Implementation detail of `riverpod_generator`. @@ -190,7 +190,8 @@ abstract class ClassProviderElement< // @mustCallSuper @override void create( - Ref ref, { + // ignore: library_private_types_in_public_api, not public + _Ref ref, { required bool didChangeDependency, }) { final seamless = !didChangeDependency; diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 3ac08842c..05be79843 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -289,8 +289,6 @@ class ProviderPointerManager { (e) { if (e.key.allTransitiveDependencies == null) return e; - // TODO don't fork a family if no family(42) is overridden - return MapEntry(e.key, ProviderDirectory.from(e.value)); }, ), diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index 746a8a978..b401bee2d 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -38,44 +38,18 @@ Cannot use the Ref of $origin after it has been disposed. This typically happens /// - [onDispose], a method that allows performing a task when the provider is destroyed. /// {@endtemplate} @optionalTypeArgs -base class Ref<@Deprecated('Will be removed in 3.0') StateT> { - /// {@macro riverpod.provider_ref_base} - Ref._(this._element); - - final ProviderElement _element; +sealed class Ref { + ProviderElement get _element; List? _keepAliveLinks; - List? _onChangeSelfListeners; List? _onDisposeListeners; List? _onResumeListeners; List? _onCancelListeners; List? _onAddListeners; List? _onRemoveListeners; - List? _onErrorSelfListeners; bool get mounted => _mounted; var _mounted = true; - /// Obtains the state currently exposed by this provider. - /// - /// Mutating this property will notify the provider listeners. - /// - /// If called before a value was set, there are two possible scenarios: - /// - on synchronous providers, this will throw a [StateError]. - /// - on asynchronous providers, this will return an [AsyncLoading]. - /// - /// Will throw if the provider threw during creation. - StateT get state { - _throwIfInvalidUsage(); - - return _element.readSelf(); - } - - set state(StateT newState) { - _throwIfInvalidUsage(); - - _element.setStateResult(ResultData(newState)); - } - /// The [ProviderContainer] that this provider is associated with. ProviderContainer get container => _element.container; @@ -597,6 +571,38 @@ final = Provider(dependencies: []); fireImmediately: fireImmediately, ); } +} + +class _Ref extends Ref { + /// {@macro riverpod.provider_ref_base} + _Ref(this._element); + + @override + final ProviderElement _element; + + List? _onChangeSelfListeners; + List? _onErrorSelfListeners; + + /// Obtains the state currently exposed by this provider. + /// + /// Mutating this property will notify the provider listeners. + /// + /// If called before a value was set, there are two possible scenarios: + /// - on synchronous providers, this will throw a [StateError]. + /// - on asynchronous providers, this will return an [AsyncLoading]. + /// + /// Will throw if the provider threw during creation. + StateT get state { + _throwIfInvalidUsage(); + + return _element.readSelf(); + } + + set state(StateT newState) { + _throwIfInvalidUsage(); + + _element.setStateResult(ResultData(newState)); + } /// Listens to changes on the value exposed by this provider. /// diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart index c4348c0bf..2915e4c91 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/auto_dispose_state_notifier_provider_test.dart @@ -7,21 +7,6 @@ import 'package:test/test.dart'; import '../../../utils.dart'; void main() { - test('can read and set current StateNotifier', () async { - final container = ProviderContainer.test(); - final listener = Listener(); - late Ref ref; - final provider = StateNotifierProvider.autoDispose((r) { - ref = r; - return Counter(); - }); - - container.listen(provider, listener.call); - - verifyZeroInteractions(listener); - expect(ref.state, 0); - }); - test('can be auto-scoped', () async { final dep = Provider( (ref) => 0, diff --git a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart index 0514da27e..d2fa7f120 100644 --- a/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/deprecated/state_notifier_provider/state_notifier_provider_test.dart @@ -90,21 +90,6 @@ void main() { verifyNoMoreInteractions(listener); }); - test('can read and set current StateNotifier', () async { - final container = ProviderContainer.test(); - final listener = Listener(); - late Ref ref; - final provider = StateNotifierProvider((r) { - ref = r; - return Counter(); - }); - - container.listen(provider, listener.call); - - verifyZeroInteractions(listener); - expect(ref.state, 0); - }); - test('can be auto-scoped', () async { final dep = Provider( (ref) => 0, diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart index 6b76ae4d1..13b38f231 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/auto_dispose_future_provider_test.dart @@ -9,37 +9,6 @@ import 'package:test/test.dart'; import '../../utils.dart'; void main() { - test('can read and set current AsyncValue', () { - final container = ProviderContainer.test(); - final listener = Listener>(); - late Ref ref; - final provider = FutureProvider.autoDispose((r) { - ref = r; - return 0; - }); - - container.listen(provider, listener.call); - - expect(ref.state, const AsyncData(0)); - verifyZeroInteractions(listener); - - ref.state = const AsyncLoading(); - - expect( - ref.state, - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ); - verifyOnly( - listener, - listener( - const AsyncData(0), - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ), - ); - }); - test('can be auto-scoped', () async { final dep = Provider( (ref) => 0, diff --git a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart index fb3154d11..d4b1d9279 100644 --- a/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/future_provider/future_provider_test.dart @@ -39,44 +39,6 @@ void main() { expect(container.read(autoDispose).value, 84); }); - test('Does not skip return value if ref.state was set', () async { - final provider = FutureProvider((ref) async { - await Future.value(); - ref.state = const AsyncData(1); - await Future.value(); - ref.state = const AsyncData(2); - await Future.value(); - return 3; - }); - final container = ProviderContainer.test(); - final listener = Listener>(); - // Completer used for the sole purpose of being able to await `provider.future` - // Since `provider` emits `AsyncData` before the future completes, then - // `provider.future` completes early. - // As such, awaiting `provider.future` isn't enough to fully await the FutureProvider - final completer = Completer(); - - container.listen>( - provider, - (prev, next) { - if (next.value == 3) { - completer.complete(); - } - listener(prev, next); - }, - fireImmediately: true, - ); - - await completer.future; - - verifyInOrder([ - listener(null, const AsyncLoading()), - listener(const AsyncLoading(), const AsyncData(1)), - listener(const AsyncData(1), const AsyncData(2)), - listener(const AsyncData(2), const AsyncData(3)), - ]); - }); - test('supports family overrideWith', () { final family = FutureProvider.family((ref, arg) => '0 $arg'); final autoDisposeFamily = FutureProvider.autoDispose.family( @@ -211,38 +173,6 @@ void main() { }); }); - test('can read and set current AsyncValue', () { - final container = ProviderContainer.test(); - final listener = Listener>(); - late Ref ref; - final provider = FutureProvider((r) { - ref = r; - return 0; - }); - - container.listen(provider, listener.call); - - expect(ref.state, const AsyncData(0)); - verifyZeroInteractions(listener); - - ref.state = const AsyncLoading(); - - expect( - ref.state, - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ); - - verifyOnly( - listener, - listener( - const AsyncData(0), - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ), - ); - }); - test('can be auto-scoped', () async { final dep = Provider( (ref) => 0, diff --git a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart index d59a7661b..643c0b4a1 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/auto_dispose_provider_test.dart @@ -1,86 +1,9 @@ -import 'package:mockito/mockito.dart'; -import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:riverpod/src/internals.dart' show ProviderElement; import 'package:test/test.dart'; -import '../../utils.dart'; - void main() { group('Provider.autoDispose', () { - group('ref.state', () { - test('can read and change current value', () { - final container = ProviderContainer.test(); - final listener = Listener(); - late Ref ref; - final provider = Provider.autoDispose((r) { - ref = r; - return 0; - }); - - container.listen(provider, listener.call); - verifyZeroInteractions(listener); - - expect(ref.state, 0); - - ref.state = 42; - - verifyOnly(listener, listener(0, 42)); - expect(ref.state, 42); - }); - - test('fails if trying to read the state before it was set', () { - final container = ProviderContainer.test(); - Object? err; - final provider = Provider.autoDispose((ref) { - try { - ref.state; - } catch (e) { - err = e; - } - return 0; - }); - - container.read(provider); - expect(err, isStateError); - }); - - test( - 'on rebuild, still fails if trying to read the state before was built', - () { - final dep = StateProvider((ref) => false); - final container = ProviderContainer.test(); - Object? err; - final provider = Provider.autoDispose((ref) { - if (ref.watch(dep)) { - try { - ref.state; - } catch (e) { - err = e; - } - } - return 0; - }); - - container.read(provider); - expect(err, isNull); - - container.read(dep.notifier).state = true; - container.read(provider); - - expect(err, isStateError); - }); - - test('can read the state if the setter was called before', () { - final container = ProviderContainer.test(); - final provider = Provider.autoDispose((ref) { - return ref.state = 42; - }); - - expect(container.read(provider), 42); - }); - }); - test('can be refreshed', () async { var result = 0; final container = ProviderContainer.test(); @@ -94,26 +17,6 @@ void main() { expect(container.read(provider), 1); }); - test('does not notify listeners when called ref.state= with == new value', - () async { - final container = ProviderContainer.test(); - final listener = Listener(); - late Ref ref; - final provider = Provider.autoDispose((r) { - ref = r; - return 0; - }); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(listener, listener(null, 0)); - - ref.state = 0; - await container.pump(); - - verifyNoMoreInteractions(listener); - }); - group('scoping an override overrides all the associated subproviders', () { test('when passing the provider itself', () { final provider = Provider.autoDispose( diff --git a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart index ea6cf7040..917d9c82b 100644 --- a/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/provider/provider_test.dart @@ -53,116 +53,6 @@ void main() { expect(container.read(provider), 1); }); - group('ref.state', () { - test('throws on providers that threw', () { - final container = ProviderContainer.test(); - final provider = Provider((ref) => throw UnimplementedError()); - - expect( - () => container.read(provider), - throwsUnimplementedError, - ); - - final element = container.readProviderElement(provider); - - expect( - () => element.ref!.state, - throwsUnimplementedError, - ); - }); - - test('can read and change current value', () { - final container = ProviderContainer.test(); - final listener = Listener(); - late Ref ref; - final provider = Provider((r) { - ref = r; - return 0; - }); - - container.listen(provider, listener.call); - verifyZeroInteractions(listener); - - expect(ref.state, 0); - - ref.state = 42; - - verifyOnly(listener, listener(0, 42)); - expect(ref.state, 42); - }); - - test('fails if trying to read the state before it was set', () { - final container = ProviderContainer.test(); - Object? err; - final provider = Provider((ref) { - try { - ref.state; - } catch (e) { - err = e; - } - return 0; - }); - - container.read(provider); - expect(err, isStateError); - }); - - test( - 'on rebuild, still fails if trying to read the state before was built', - () { - final dep = StateProvider((ref) => false); - final container = ProviderContainer.test(); - Object? err; - final provider = Provider((ref) { - if (ref.watch(dep)) { - try { - ref.state; - } catch (e) { - err = e; - } - } - return 0; - }); - - container.read(provider); - expect(err, isNull); - - container.read(dep.notifier).state = true; - container.read(provider); - - expect(err, isStateError); - }); - - test('can read the state if the setter was called before', () { - final container = ProviderContainer.test(); - final provider = Provider((ref) { - return ref.state = 42; - }); - - expect(container.read(provider), 42); - }); - }); - - test('does not notify listeners when called ref.state= with == new value', - () async { - final container = ProviderContainer.test(); - final listener = Listener(); - late Ref ref; - final provider = Provider((r) { - ref = r; - return 0; - }); - - container.listen(provider, listener.call, fireImmediately: true); - - verifyOnly(listener, listener(null, 0)); - - ref.state = 0; - await container.pump(); - - verifyNoMoreInteractions(listener); - }); - group('scoping an override overrides all the associated sub-providers', () { test('when passing the provider itself', () { final provider = Provider( @@ -268,51 +158,53 @@ void main() { expect(callCount, 1); }); - test("rebuild don't notify clients if == doesn't change", () { - final container = ProviderContainer.test(); - final counter = Counter(); - final other = StateNotifierProvider((ref) => counter); - var buildCount = 0; - final provider = Provider((ref) { - buildCount++; - return ref.watch(other).isEven; - }); - final listener = Listener(); - - final sub = - container.listen(provider, listener.call, fireImmediately: true); + group('updateShouldNotify', () { + test("rebuild don't notify clients if == doesn't change", () { + final container = ProviderContainer.test(); + final counter = Counter(); + final other = StateNotifierProvider((ref) => counter); + var buildCount = 0; + final provider = Provider((ref) { + buildCount++; + return ref.watch(other).isEven; + }); + final listener = Listener(); - verifyOnly(listener, listener(null, true)); - expect(sub.read(), true); - expect(buildCount, 1); + final sub = + container.listen(provider, listener.call, fireImmediately: true); - counter.increment(); - counter.increment(); + verifyOnly(listener, listener(null, true)); + expect(sub.read(), true); + expect(buildCount, 1); - expect(sub.read(), true); - expect(buildCount, 2); - verifyNoMoreInteractions(listener); - }); + counter.increment(); + counter.increment(); - test('rebuild notify clients if == did change', () { - final container = ProviderContainer.test(); - final counter = Counter(); - final other = StateNotifierProvider((ref) => counter); - final provider = Provider((ref) { - return ref.watch(other).isEven; + expect(sub.read(), true); + expect(buildCount, 2); + verifyNoMoreInteractions(listener); }); - final listener = Listener(); - final sub = - container.listen(provider, listener.call, fireImmediately: true); + test('rebuild notify clients if == did change', () { + final container = ProviderContainer.test(); + final counter = Counter(); + final other = StateNotifierProvider((ref) => counter); + final provider = Provider((ref) { + return ref.watch(other).isEven; + }); + final listener = Listener(); - verifyOnly(listener, listener(null, true)); - expect(sub.read(), true); + final sub = + container.listen(provider, listener.call, fireImmediately: true); - counter.increment(); + verifyOnly(listener, listener(null, true)); + expect(sub.read(), true); - expect(sub.read(), false); - verifyOnly(listener, listener(true, false)); + counter.increment(); + + expect(sub.read(), false); + verifyOnly(listener, listener(true, false)); + }); }); test('can be auto-scoped', () async { diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart index 907718f26..8bf9a8af6 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/auto_dispose_stream_provider_test.dart @@ -12,45 +12,6 @@ import '../../utils.dart'; void main() { group('StreamProvider.autoDispose', () { - test('can read and set current AsyncValue', () async { - final container = ProviderContainer.test(); - final listener = Listener>(); - late Ref ref; - final provider = StreamProvider.autoDispose((r) { - ref = r; - return Stream.value(0); - }); - - container.listen(provider, listener.call); - - await container.read(provider.future); - expect(ref.state, const AsyncData(0)); - verifyOnly( - listener, - listener( - const AsyncLoading(), - const AsyncData(0), - ), - ); - - ref.state = const AsyncLoading(); - - expect( - ref.state, - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ); - - verifyOnly( - listener, - listener( - const AsyncData(0), - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ), - ); - }); - test('can be auto-scoped', () async { final dep = Provider( (ref) => 0, diff --git a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart index 51d164f3a..6ea01c5ae 100644 --- a/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart +++ b/packages/riverpod/test/old/legacy_providers/stream_provider/stream_provider_test.dart @@ -12,65 +12,51 @@ import '../../utils.dart'; void main() { test('supports overrideWith', () { - final provider = StreamProvider( - (ref) { - ref.state = const AsyncData(0); - return Stream.value(1); - }, - ); + final provider = StreamProvider((ref) => Stream.value(1)); final autoDispose = StreamProvider.autoDispose( - (ref) { - ref.state = const AsyncData(0); - return Stream.value(1); - }, + (ref) => Stream.value(1), ); final container = ProviderContainer.test( overrides: [ - provider.overrideWith((ref) { - ref.state = const AsyncData(42); - return Stream.value(43); - }), - autoDispose.overrideWith((ref) { - ref.state = const AsyncData(84); - return Stream.value(85); - }), + provider.overrideWith((ref) => Stream.value(42)), + autoDispose.overrideWith((ref) => Stream.value(84)), ], ); - expect(container.read(provider).value, 42); - expect(container.read(autoDispose).value, 84); + expect( + container.listen(provider.future, (a, b) {}).read(), + completion(42), + ); + expect( + container.listen(autoDispose.future, (a, b) {}).read(), + completion(84), + ); }); test('supports family overrideWith', () { final family = StreamProvider.family((ref, arg) { - ref.state = AsyncData('0 $arg'); - return Stream.value('1 $arg'); + return Stream.value('0 $arg'); }); final autoDisposeFamily = StreamProvider.autoDispose.family( - (ref, arg) { - ref.state = AsyncData('0 $arg'); - return Stream.value('1 $arg'); - }, + (ref, arg) => Stream.value('0 $arg'), ); final container = ProviderContainer.test( overrides: [ - family.overrideWith( - (ref, int arg) { - ref.state = AsyncData('42 $arg'); - return Stream.value('43 $arg'); - }, - ), + family.overrideWith((ref, int arg) => Stream.value('42 $arg')), autoDisposeFamily.overrideWith( - (ref, int arg) { - ref.state = AsyncData('84 $arg'); - return Stream.value('85 $arg'); - }, + (ref, int arg) => Stream.value('84 $arg'), ), ], ); - expect(container.read(family(10)).value, '42 10'); - expect(container.read(autoDisposeFamily(10)).value, '84 10'); + expect( + container.listen(family(10).future, (a, b) {}).read(), + completion('42 10'), + ); + expect( + container.listen(autoDisposeFamily(10).future, (a, b) {}).read(), + completion('84 10'), + ); }); group('When going back to AsyncLoading', () { @@ -150,45 +136,6 @@ void main() { }); }); - test('can read and set current AsyncValue', () async { - final container = ProviderContainer.test(); - final listener = Listener>(); - late Ref ref; - final provider = StreamProvider((r) { - ref = r; - return Stream.value(0); - }); - - container.listen(provider, listener.call); - await container.read(provider.future); - - expect(ref.state, const AsyncData(0)); - verifyOnly( - listener, - listener( - const AsyncLoading(), - const AsyncData(0), - ), - ); - - ref.state = const AsyncLoading(); - - expect( - ref.state, - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ); - - verifyOnly( - listener, - listener( - const AsyncData(0), - const AsyncLoading() - .copyWithPrevious(const AsyncData(0), isRefresh: false), - ), - ); - }); - test('can be auto-scoped', () async { final dep = Provider( (ref) => 0, diff --git a/packages/riverpod/test/src/core/auto_dispose_test.dart b/packages/riverpod/test/src/core/auto_dispose_test.dart index 9bb044106..76f1df389 100644 --- a/packages/riverpod/test/src/core/auto_dispose_test.dart +++ b/packages/riverpod/test/src/core/auto_dispose_test.dart @@ -95,8 +95,6 @@ void main() { expect(container.pointerManager.readPointer(provider(0)), isNull); }); - // TODO test recursive dispose does not remove pointers in unrelated containers - test( 'When a non-overridden autoDispose provider is disposed ' 'and the associated ProviderContainer has a child ProviderContainer which overrides said provider, ' diff --git a/packages/riverpod/test/src/core/modifiers/select_async_test.dart b/packages/riverpod/test/src/core/modifiers/select_async_test.dart index 7f4d99390..e43f6b85f 100644 --- a/packages/riverpod/test/src/core/modifiers/select_async_test.dart +++ b/packages/riverpod/test/src/core/modifiers/select_async_test.dart @@ -5,6 +5,7 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; +import '../../matrix.dart'; import '../../utils.dart'; void main() { @@ -198,14 +199,14 @@ void main() { test('handles multiple AsyncLoading at once then data', () async { final container = ProviderContainer.test(); - late Ref ref; - final provider = FutureProvider((r) { - ref = r; - final completer = Completer(); - ref.onDispose(() => completer.complete(84)); + final provider = AsyncNotifierProvider, int>( + () => DeferredAsyncNotifier((ref, self) { + final completer = Completer(); + ref.onDispose(() => completer.complete(84)); - return completer.future; - }); + return completer.future; + }), + ); final sub = container.listen( provider.selectAsync((data) => data + 40), @@ -214,13 +215,13 @@ void main() { expect(sub.read(), completion(42)); - ref.state = const AsyncLoading() + final notifier = container.read(provider.notifier); + notifier.state = const AsyncLoading() .copyWithPrevious(const AsyncValue.data(0)); - ref.state = const AsyncLoading() + notifier.state = const AsyncLoading() .copyWithPrevious(const AsyncError('err', StackTrace.empty)); - ref.state = const AsyncLoading(); - - ref.state = const AsyncData(2); + notifier.state = const AsyncLoading(); + notifier.state = const AsyncData(2); // the previous unawaited `completion` should resolve with 2+40 }); diff --git a/packages/riverpod/test/src/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart index adcd86b5d..070019fde 100644 --- a/packages/riverpod/test/src/core/provider_element_test.dart +++ b/packages/riverpod/test/src/core/provider_element_test.dart @@ -5,6 +5,7 @@ import 'package:riverpod/src/internals.dart'; import 'package:test/test.dart'; import '../../third_party/fake_async.dart'; +import '../matrix.dart'; import '../utils.dart'; void main() { @@ -527,10 +528,12 @@ void main() { final listener = Listener(); final dep = StateProvider((ref) => 0); - final provider = Provider((ref) { - ref.watch(dep); - return ref.state = 0; - }); + final provider = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + ref.watch(dep); + return self.state = 0; + }), + ); container.listen(provider, listener.call, fireImmediately: true); @@ -542,10 +545,12 @@ void main() { final listener = Listener(); final dep = StateProvider((ref) => 0); - final provider = Provider((ref) { - ref.watch(dep); - return ref.state = 0; - }); + final provider = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + ref.watch(dep); + return self.state = 0; + }), + ); container.listen(provider, listener.call, fireImmediately: true); diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 019fc5471..d110b3e0d 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -43,19 +43,10 @@ void main() { }); container.read(provider); - container.read(dep.notifier).state++; final another = Provider((ref) => 0); - expect( - () => ref.state, - throwsA(isA()), - ); - expect( - () => ref.state = 42, - throwsA(isA()), - ); expect( () => ref.watch(another), throwsA(isA()), @@ -131,14 +122,6 @@ void main() { final another = Provider((ref) => 0); - expect( - () => container.read(provider.select((_) => ref.state)), - throwsA(isA()), - ); - expect( - () => container.read(provider.select((_) => ref.state = 42)), - throwsA(isA()), - ); expect( () => container.read(provider.select((_) => ref.watch(another))), throwsA(isA()), @@ -589,7 +572,7 @@ void main() { final provider = NotifierProvider.autoDispose, void>( () => DeferredNotifier((ref, self) { - ref.listenSelf((previous, next) {}); + self.listenSelf((previous, next) {}); }), ); @@ -1181,17 +1164,17 @@ void main() { test('cannot listen itself', () { final container = ProviderContainer.test(); final listener = Listener(); - late Ref ref; - late Provider provider; - provider = Provider((r) { - ref = r; - ref.listen(provider, (previous, next) {}); - return 0; - }); + late NotifierProvider, int> provider; + provider = NotifierProvider, int>( + () => DeferredNotifier((ref, self) { + ref.listen(provider, (previous, next) {}); + return 0; + }), + ); expect(() => container.read(provider), throwsA(isAssertionError)); - ref.state = 42; + container.read(provider.notifier).state = 42; verifyZeroInteractions(listener); }); @@ -2415,7 +2398,6 @@ void main() { ref.watch(dep); - // TODO changelog breaking: Calling ref.watch multiple times calls ref.onListen everytime verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); diff --git a/packages/riverpod/test/src/matrix/async_notifier_provider.dart b/packages/riverpod/test/src/matrix/async_notifier_provider.dart index 9dd098134..193dfdee7 100644 --- a/packages/riverpod/test/src/matrix/async_notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/async_notifier_provider.dart @@ -6,8 +6,9 @@ final asyncNotifierProviderFactory = TestMatrix( isAutoDispose: false, isFamily: false, deferredNotifier: DeferredAsyncNotifier.new, - deferredProvider: (create, {updateShouldNotify}) { + deferredProvider: (create, {updateShouldNotify, retry}) { return AsyncNotifierProvider, StateT>( + retry: retry, () => DeferredAsyncNotifier( create, updateShouldNotify: updateShouldNotify, @@ -31,9 +32,10 @@ final asyncNotifierProviderFactory = TestMatrix( isAutoDispose: true, isFamily: false, deferredNotifier: DeferredAsyncNotifier.new, - deferredProvider: (create, {updateShouldNotify}) { + deferredProvider: (create, {updateShouldNotify, retry}) { return AsyncNotifierProvider.autoDispose, StateT>( + retry: retry, () => DeferredAsyncNotifier( create, updateShouldNotify: updateShouldNotify, @@ -59,9 +61,10 @@ final asyncNotifierProviderFactory = TestMatrix( isAutoDispose: false, isFamily: true, deferredNotifier: DeferredFamilyAsyncNotifier.new, - deferredProvider: (create, {updateShouldNotify}) { + deferredProvider: (create, {updateShouldNotify, retry}) { return AsyncNotifierProvider.family, StateT, Object?>( + retry: retry, () => DeferredFamilyAsyncNotifier( create, updateShouldNotify: updateShouldNotify, @@ -88,9 +91,10 @@ final asyncNotifierProviderFactory = TestMatrix( isAutoDispose: true, isFamily: true, deferredNotifier: DeferredFamilyAsyncNotifier.new, - deferredProvider: (create, {updateShouldNotify}) { + deferredProvider: (create, {updateShouldNotify, retry}) { return AsyncNotifierProvider.family .autoDispose, StateT, Object?>( + retry: retry, () => DeferredFamilyAsyncNotifier( create, updateShouldNotify: updateShouldNotify, @@ -198,6 +202,7 @@ class AsyncNotifierTestFactory extends TestFactory< Function( FutureOr Function(Ref ref, $AsyncNotifier self) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + Retry? retry, }) deferredProvider; final $AsyncNotifierProvider<$AsyncNotifier, StateT> Function( @@ -208,10 +213,12 @@ class AsyncNotifierTestFactory extends TestFactory< simpleTestProvider( FutureOr Function(Ref ref, $AsyncNotifier self) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + Retry? retry, }) { return deferredProvider( (ref, self) => create(ref, self), updateShouldNotify: updateShouldNotify, + retry: retry, ); } } diff --git a/packages/riverpod/test/src/matrix/notifier_provider.dart b/packages/riverpod/test/src/matrix/notifier_provider.dart index 282e5ae2a..dd4299b51 100644 --- a/packages/riverpod/test/src/matrix/notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/notifier_provider.dart @@ -125,9 +125,6 @@ abstract class TestNotifier implements $Notifier { @override set state(StateT value); - @override - Ref get ref; - @override void listenSelf( void Function(StateT? previous, StateT next) listener, { @@ -149,7 +146,7 @@ class DeferredNotifier extends Notifier )? _updateShouldNotify; @override - Ref get ref; + Ref get ref; @override void listenSelf( diff --git a/packages/riverpod/test/src/matrix/stream_notifier_provider.dart b/packages/riverpod/test/src/matrix/stream_notifier_provider.dart index f00b4211d..0bdf165fd 100644 --- a/packages/riverpod/test/src/matrix/stream_notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/stream_notifier_provider.dart @@ -221,10 +221,12 @@ class StreamNotifierTestFactory extends TestFactory< simpleTestProvider( Stream Function(Ref ref, $StreamNotifier self) create, { bool Function(AsyncValue, AsyncValue)? updateShouldNotify, + Retry? retry, }) { return deferredProvider( (ref, self) => create(ref, self), updateShouldNotify: updateShouldNotify, + retry: retry, ); } } diff --git a/packages/riverpod/test/src/providers/async_notifier_test.dart b/packages/riverpod/test/src/providers/async_notifier_test.dart index 670459dd1..497fc2609 100644 --- a/packages/riverpod/test/src/providers/async_notifier_test.dart +++ b/packages/riverpod/test/src/providers/async_notifier_test.dart @@ -10,6 +10,7 @@ import 'package:riverpod/src/framework.dart' show UnmountedRefException; import 'package:riverpod/src/providers/async_notifier.dart' show $AsyncNotifier; import 'package:test/test.dart'; +import '../../third_party/fake_async.dart'; import '../matrix.dart'; import '../utils.dart'; @@ -41,6 +42,124 @@ void main() { }); } + group('retry', () { + test( + 'handles retry', + () => fakeAsync((fake) async { + final container = ProviderContainer.test(); + var err = Exception('foo'); + final stack = StackTrace.current; + final provider = factory.simpleTestProvider( + (ref, self) => Error.throwWithStackTrace(err, stack), + retry: (_, __) => const Duration(seconds: 1), + ); + final listener = Listener>(); + + container.listen(provider, fireImmediately: true, listener.call); + await container.read(provider.future).catchError((e) => 0); + + verifyOnly( + listener, + listener(any, AsyncValue.error(err, stack)), + ); + + err = Exception('bar'); + + fake.elapse(const Duration(seconds: 1)); + fake.flushMicrotasks(); + + await container.read(provider.future).catchError((e) => 0); + + verifyOnly( + listener, + listener(any, AsyncValue.error(err, stack)), + ); + }), + ); + + test( + 'manually setting the state to an error does not cause a retry', + () => fakeAsync((fake) async { + final container = ProviderContainer.test(); + var retryCount = 0; + final provider = factory.simpleTestProvider( + (ref, self) => 0, + retry: (_, __) { + retryCount++; + return const Duration(seconds: 1); + }, + ); + final listener = Listener>(); + + container.listen(provider, fireImmediately: true, listener.call); + + expect(retryCount, 0); + + container.read(provider.notifier).state = AsyncValue.error( + Error(), + StackTrace.current, + ); + + expect(retryCount, 0); + }), + ); + }); + + test('resets progress to 0 if restarting while the future is pending', () { + final container = ProviderContainer.test(); + final completer = Completer(); + addTearDown(() => completer.complete(42)); + + final provider = factory.simpleTestProvider((ref, self) { + return completer.future; + }); + + expect(container.read(provider), const AsyncValue.loading()); + + container.read(provider.notifier).state = + const AsyncValue.loading(progress: .2); + + container.refresh(provider); + + expect(container.read(provider), const AsyncValue.loading()); + }); + + test('Does not skip return value if ref.state was set', () async { + final provider = factory.simpleTestProvider((ref, self) async { + await Future.value(); + self.state = const AsyncData(1); + await Future.value(); + self.state = const AsyncData(2); + await Future.value(); + return 3; + }); + final container = ProviderContainer.test(); + final listener = Listener>(); + // Completer used for the sole purpose of being able to await `provider.future` + // Since `provider` emits `AsyncData` before the future completes, then + // `provider.future` completes early. + // As such, awaiting `provider.future` isn't enough to fully await the FutureProvider + final completer = Completer(); + + container.listen>( + provider, + (prev, next) { + if (next.value == 3) completer.complete(); + listener(prev, next); + }, + fireImmediately: true, + ); + + await completer.future; + + verifyInOrder([ + listener(null, const AsyncLoading()), + listener(const AsyncLoading(), const AsyncData(1)), + listener(const AsyncData(1), const AsyncData(2)), + listener(const AsyncData(2), const AsyncData(3)), + ]); + }); + test('Cannot share a Notifier instance between providers ', () { final container = ProviderContainer.test(); final notifier = factory.deferredNotifier((ref, _) => 0); diff --git a/packages/riverpod/test/src/providers/future_provider_test.dart b/packages/riverpod/test/src/providers/future_provider_test.dart index a113c11f6..2a8f2722e 100644 --- a/packages/riverpod/test/src/providers/future_provider_test.dart +++ b/packages/riverpod/test/src/providers/future_provider_test.dart @@ -1,5 +1,3 @@ -import 'dart:async'; - import 'package:mockito/mockito.dart'; import 'package:riverpod/riverpod.dart'; import 'package:test/test.dart'; @@ -9,26 +7,6 @@ import '../utils.dart'; void main() { group('FutureProvider', () { - test('resets progress to 0 if restarting while the future is pending', () { - final container = ProviderContainer.test(); - late Ref ref; - final completer = Completer(); - addTearDown(() => completer.complete(42)); - - final provider = FutureProvider((r) { - ref = r; - return completer.future; - }); - - expect(container.read(provider), const AsyncValue.loading()); - - ref.state = const AsyncValue.loading(progress: .2); - - container.refresh(provider); - - expect(container.read(provider), const AsyncValue.loading()); - }); - group('retry', () { test( 'handles retry', @@ -63,34 +41,6 @@ void main() { ); }), ); - - test( - 'manually setting the state to an error does not cause a retry', - () => fakeAsync((fake) async { - final container = ProviderContainer.test(); - var retryCount = 0; - late Ref r; - final provider = FutureProvider( - (ref) { - r = ref; - return 0; - }, - retry: (_, __) { - retryCount++; - return const Duration(seconds: 1); - }, - ); - final listener = Listener>(); - - container.listen(provider, fireImmediately: true, listener.call); - - expect(retryCount, 0); - - r.state = AsyncValue.error(Error(), StackTrace.current); - - expect(retryCount, 0); - }), - ); }); }); } diff --git a/packages/riverpod/test/src/providers/stream_notifier_test.dart b/packages/riverpod/test/src/providers/stream_notifier_test.dart index 468cb7741..6a6f93bc0 100644 --- a/packages/riverpod/test/src/providers/stream_notifier_test.dart +++ b/packages/riverpod/test/src/providers/stream_notifier_test.dart @@ -136,15 +136,15 @@ void main() { final container = ProviderContainer.test(); var retryCount = 0; late Ref r; - final provider = FutureProvider( - (ref) { - r = ref; - return 0; - }, + final provider = factory.simpleTestProvider( retry: (_, __) { retryCount++; return const Duration(seconds: 1); }, + (ref, self) { + self.state = const AsyncValue.data(0); + return const Stream.empty(); + }, ); final listener = Listener>(); @@ -152,7 +152,10 @@ void main() { expect(retryCount, 0); - r.state = AsyncValue.error(Error(), StackTrace.current); + container.read(provider.notifier).state = AsyncValue.error( + Error(), + StackTrace.current, + ); expect(retryCount, 0); }), diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index a7f434293..d3e1e6108 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -149,7 +149,6 @@ class _RiverpodGeneratorVisitor { List? _computeAllTransitiveDependencies( GeneratorProviderDeclaration provider, ) { - // TODO throw if a dependency is not accessible in the current library. final dependencies = provider.annotation.dependencyList?.values; if (dependencies == null) return null; diff --git a/packages/riverpod_generator/test/doc_test.dart b/packages/riverpod_generator/test/doc_test.dart index 0930cf9e4..e1b357b03 100644 --- a/packages/riverpod_generator/test/doc_test.dart +++ b/packages/riverpod_generator/test/doc_test.dart @@ -25,12 +25,6 @@ void main() async { expect(doc, '/// Hello world\n// Foo\n'); }); - test('Doc on generated ref', () async { - final doc = topLevelDeclarations.findNamed('FamilyRef').doc; - - expect(doc, '/// Hello world\n// Foo\n'); - }); - test('Doc on generated family', () async { final family = topLevelDeclarations.findNamed('FamilyFamily') as ClassDeclaration; diff --git a/packages/riverpod_generator/test/stream_test.dart b/packages/riverpod_generator/test/stream_test.dart index c6d1f1e20..729ccc569 100644 --- a/packages/riverpod_generator/test/stream_test.dart +++ b/packages/riverpod_generator/test/stream_test.dart @@ -127,30 +127,34 @@ void main() { ); }); - test('can overrideWith', () { + test('can overrideWith', () async { final container = ProviderContainer.test( overrides: [ - publicProvider.overrideWith((ref) { - ref.state = const AsyncData('test'); - return const Stream.empty(); - }), + publicProvider.overrideWith((ref) => Stream.value('test')), publicClassProvider.overrideWith(() => PublicClass(42)), familyProvider.overrideWith( (ref, args) { - ref.state = AsyncData( + return Stream.value( 'test (first: ${args.$1}, second: ${args.second}, third: ${args.third}, fourth: ${args.fourth}, fifth: ${args.fifth})', ); - return const Stream.empty(); }, ), familyClassProvider.overrideWith(FamilyClass.new), ], ); - expect(container.read(publicProvider).requireValue, 'test'); + expect( + await container.listen(publicProvider.future, (a, b) {}).read(), + 'test', + ); expect(container.read(publicClassProvider.notifier).param, 42); expect( - container.read(familyProvider(42, second: '42', third: .42)).requireValue, + await container + .listen( + familyProvider(42, second: '42', third: .42).future, + (a, b) {}, + ) + .read(), 'test (first: 42, second: 42, third: 0.42, fourth: true, fifth: null)', ); expect( From 3188d25fc45e4286102f865de832f8d56d1f9440 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 3 Nov 2024 00:50:45 +0100 Subject: [PATCH 362/387] Fix lints --- .../lints/provider_dependencies/missing_dependencies2.dart | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart index bfd48ef09..88e0d24e1 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/missing_dependencies2.dart @@ -1,4 +1,4 @@ -// ignore_for_file: unused_field, avoid_manual_providers_as_generated_provider_dependency +// ignore_for_file: unused_field import 'package:flutter/material.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; @@ -199,6 +199,7 @@ int alias(Ref ref) { // Regression test for https://github.com/rrousselGit/riverpod/issues/2935 @riverpod class AliasClass extends _$AliasClass { + // expect_lint: avoid_manual_providers_as_generated_provider_dependency late final int _a = ref.read(import_alias.aProvider); late final int _b = ref.read(import_alias.bProvider); From 00f89624837273305143e84d44e3068aeb8d7eba Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 3 Nov 2024 00:55:52 +0100 Subject: [PATCH 363/387] Lint --- .../lib/src/lints/avoid_ref_inside_state_dispose.dart | 5 ++++- packages/riverpod_lint/lib/src/lints/notifier_extends.dart | 5 ++++- .../lib/src/lints/only_use_keep_alive_inside_keep_alive.dart | 5 ++++- .../riverpod_lint/lib/src/lints/provider_dependencies.dart | 5 ++++- .../riverpod_lint/lib/src/lints/provider_parameters.dart | 5 ++++- .../riverpod_lint/lib/src/lints/riverpod_syntax_error.dart | 5 ++++- .../lints/scoped_providers_should_specify_dependencies.dart | 5 ++++- .../riverpod_lint/lib/src/lints/unknown_scoped_usage.dart | 5 ++++- .../lib/src/migration/missing_legacy_import.dart | 5 ++++- 9 files changed, 36 insertions(+), 9 deletions(-) diff --git a/packages/riverpod_lint/lib/src/lints/avoid_ref_inside_state_dispose.dart b/packages/riverpod_lint/lib/src/lints/avoid_ref_inside_state_dispose.dart index 0515ae04d..c85f2a5dc 100644 --- a/packages/riverpod_lint/lib/src/lints/avoid_ref_inside_state_dispose.dart +++ b/packages/riverpod_lint/lib/src/lints/avoid_ref_inside_state_dispose.dart @@ -1,5 +1,8 @@ import 'package:analyzer/dart/ast/ast.dart'; -import 'package:analyzer/error/error.dart' hide LintCode; +import 'package:analyzer/error/error.dart' + hide + // ignore: undefined_hidden_name, necessary to support broad analyzer versions + LintCode; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; diff --git a/packages/riverpod_lint/lib/src/lints/notifier_extends.dart b/packages/riverpod_lint/lib/src/lints/notifier_extends.dart index 7da27e271..0a8bcf156 100644 --- a/packages/riverpod_lint/lib/src/lints/notifier_extends.dart +++ b/packages/riverpod_lint/lib/src/lints/notifier_extends.dart @@ -1,5 +1,8 @@ import 'package:analyzer/dart/ast/ast.dart'; -import 'package:analyzer/error/error.dart' hide LintCode; +import 'package:analyzer/error/error.dart' + hide + // ignore: undefined_hidden_name, necessary to support broad analyzer versions + LintCode; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; diff --git a/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart b/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart index 5285dcaf6..eb60dc017 100644 --- a/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart +++ b/packages/riverpod_lint/lib/src/lints/only_use_keep_alive_inside_keep_alive.dart @@ -1,5 +1,8 @@ import 'package:analyzer/dart/ast/ast.dart'; -import 'package:analyzer/error/error.dart' hide LintCode; +import 'package:analyzer/error/error.dart' + hide + // ignore: undefined_hidden_name, necessary to support broad analyzer versions + LintCode; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; diff --git a/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart b/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart index 9672380db..a7054907e 100644 --- a/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart +++ b/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart @@ -1,6 +1,9 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/diagnostic/diagnostic.dart'; -import 'package:analyzer/error/error.dart' hide LintCode; +import 'package:analyzer/error/error.dart' + hide + // ignore: undefined_hidden_name, necessary to support broad analyzer versions + LintCode; import 'package:analyzer/error/listener.dart'; import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart'; import 'package:analyzer_plugin/utilities/range_factory.dart'; diff --git a/packages/riverpod_lint/lib/src/lints/provider_parameters.dart b/packages/riverpod_lint/lib/src/lints/provider_parameters.dart index 91ca9c00f..bd40e6d43 100644 --- a/packages/riverpod_lint/lib/src/lints/provider_parameters.dart +++ b/packages/riverpod_lint/lib/src/lints/provider_parameters.dart @@ -1,6 +1,9 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/dart/element/element.dart'; -import 'package:analyzer/error/error.dart' hide LintCode; +import 'package:analyzer/error/error.dart' + hide + // ignore: undefined_hidden_name, necessary to support broad analyzer versions + LintCode; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; diff --git a/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart b/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart index 922ab1325..ca5f279cf 100644 --- a/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart +++ b/packages/riverpod_lint/lib/src/lints/riverpod_syntax_error.dart @@ -1,4 +1,7 @@ -import 'package:analyzer/error/error.dart' hide LintCode; +import 'package:analyzer/error/error.dart' + hide + // ignore: undefined_hidden_name, necessary to support broad analyzer versions + LintCode; import 'package:analyzer/error/listener.dart'; import 'package:analyzer/source/source_range.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; diff --git a/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart b/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart index b6f688a3c..4eb8868bf 100644 --- a/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart +++ b/packages/riverpod_lint/lib/src/lints/scoped_providers_should_specify_dependencies.dart @@ -1,5 +1,8 @@ import 'package:analyzer/dart/ast/ast.dart'; -import 'package:analyzer/error/error.dart' hide LintCode; +import 'package:analyzer/error/error.dart' + hide + // ignore: undefined_hidden_name, necessary to support broad analyzer versions + LintCode; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; diff --git a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart index 15e4370a5..b3541907a 100644 --- a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart +++ b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart @@ -1,6 +1,9 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/dart/element/element.dart'; -import 'package:analyzer/error/error.dart' hide LintCode; +import 'package:analyzer/error/error.dart' + hide + // ignore: undefined_hidden_name, necessary to support broad analyzer versions + LintCode; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; diff --git a/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart b/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart index cdcad2161..e0be586d6 100644 --- a/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart +++ b/packages/riverpod_lint/lib/src/migration/missing_legacy_import.dart @@ -1,6 +1,9 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/dart/element/type.dart'; -import 'package:analyzer/error/error.dart' hide LintCode; +import 'package:analyzer/error/error.dart' + hide + // ignore: undefined_hidden_name, necessary to support broad analyzer versions + LintCode; import 'package:analyzer/error/listener.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; From 0c775d3e126d1ffd536d97bcd1fde1e20e34ec70 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 3 Nov 2024 00:59:08 +0100 Subject: [PATCH 364/387] Use enclosingElement --- .../lib/src/nodes/ref_invocation.dart | 3 ++- .../lib/src/nodes/widget_ref_invocation.dart | 3 ++- .../lib/src/nodes/widgets/stateful_widget.dart | 5 ++++- .../riverpod_lint/lib/src/lints/unknown_scoped_usage.dart | 5 ++++- 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart index e69a3f494..5a0515010 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart @@ -16,7 +16,8 @@ extension RefInvocationX on MethodInvocation { final functionOwner = function.staticElement .cast() ?.declaration - .enclosingElement3; + // ignore: deprecated_member_use, required to support lower versions of analyzer + .enclosingElement; if (functionOwner == null || // Since Ref is sealed, checking that the function is from the package:riverpod diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart index 5bdf93f49..aa052d0dc 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart @@ -21,7 +21,8 @@ extension WidgetRefInvocationX on MethodInvocation { final functionOwner = function.staticElement .cast() ?.declaration - .enclosingElement3; + // ignore: deprecated_member_use, required to support lower versions of analyzer + .enclosingElement; if (functionOwner == null || // Since Ref is sealed, checking that the function is from the package:riverpod diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart index 6bd15f065..cb6dd5ff7 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart @@ -21,7 +21,10 @@ ClassElement? _findStateFromReturnType(ClassElement node) { } ClassElement? _findStateWithMatchingGeneric(ClassElement node) { - for (final clazz in node.enclosingElement3.classes) { + for (final clazz in node + // ignore: deprecated_member_use, required to support lower versions of analyzer + .enclosingElement + .classes) { final type = clazz.supertype; if (type != null && isState(type) && _findStateWidget(clazz) == node) { return clazz; diff --git a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart index b3541907a..5ec9fa083 100644 --- a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart +++ b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart @@ -60,7 +60,10 @@ class UnknownScopedUsage extends RiverpodLintRule { if (override?.provider == identifier) return; final enclosingConstructorType = identifier - .node.staticParameterElement?.enclosingElement3 + .node + .staticParameterElement + // ignore: deprecated_member_use, required to support lower versions of analyzer + ?.enclosingElement .safeCast() ?.returnType; // Silence the warning if passed to a widget constructor. From fa387c2847a3b96e622f1cea2e64b179981f8ee4 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 3 Nov 2024 01:38:11 +0100 Subject: [PATCH 365/387] Fix goldens --- .../functional_ref/fix/functional_ref.diff | 8 --- .../functional_ref/functional_ref_fix.diff | 8 --- .../functional_ref/functional_ref_lint.md | 15 ----- .../failing_notifier_extends_fix.diff | 24 ++++++++ .../failing_notifier_extends_lint.md | 27 ++++++++ .../notifier_extends_fix.diff | 30 +-------- .../notifier_extends/notifier_extends_lint.md | 36 +---------- .../missing_dependencies2_fix.diff | 44 ++++++------- .../missing_dependencies2_lint.md | 61 +++++++++---------- 9 files changed, 109 insertions(+), 144 deletions(-) create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/failing_notifier_extends_fix.diff create mode 100644 packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/failing_notifier_extends_lint.md diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref.diff b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref.diff index f2ba52bfd..69204fe4d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref.diff @@ -10,11 +10,3 @@ int nameless( return 0; ``` --- -Message: `Type as Ref` -Priority: 90 -Diff for file `test/lints/functional_ref/functional_ref.dart:18`: -``` -@riverpod -int valid(Ref ref) => 0; -``` ---- diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff index f2ba52bfd..69204fe4d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_fix.diff @@ -10,11 +10,3 @@ int nameless( return 0; ``` --- -Message: `Type as Ref` -Priority: 90 -Diff for file `test/lints/functional_ref/functional_ref.dart:18`: -``` -@riverpod -int valid(Ref ref) => 0; -``` ---- diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md index 4b0a90073..9e76f32a7 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/functional_ref/functional_ref_lint.md @@ -10,18 +10,3 @@ int nameless( ) { return 0; ``` - -======= - -code: functional_ref -severity: Severity.warning -message: Functional providers must receive a ref matching the provider name as their first positional parameter. -test/lints/functional_ref/functional_ref.dart:14:32 - -```dart - -@riverpod -int generics(>>>Ref ref) => 0; - -@riverpod -``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/failing_notifier_extends_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/failing_notifier_extends_fix.diff new file mode 100644 index 000000000..5edb63ff6 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/failing_notifier_extends_fix.diff @@ -0,0 +1,24 @@ +Message: `Extend _$NoExtends` +Priority: 90 +Diff for file `test/lints/notifier_extends/failing_notifier_extends.dart:6`: +``` +@riverpod +// expect_lint: notifier_extends +- class NoExtends { ++ class NoExtends extends _$NoExtends { + int build() => 0; +} +``` +--- +Message: `Extend _$WrongExtends` +Priority: 90 +Diff for file `test/lints/notifier_extends/failing_notifier_extends.dart:12`: +``` +@riverpod +// expect_lint: notifier_extends +- class WrongExtends extends AsyncNotifier { ++ class WrongExtends extends _$WrongExtends { + int build() => 0; +} +``` +--- diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/failing_notifier_extends_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/failing_notifier_extends_lint.md new file mode 100644 index 000000000..4c0aeb796 --- /dev/null +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/failing_notifier_extends_lint.md @@ -0,0 +1,27 @@ +code: notifier_extends +severity: Severity.warning +message: Classes annotated by @riverpod must extend _$ClassName +test/lints/notifier_extends/failing_notifier_extends.dart:6:7 + +```dart +@riverpod +// expect_lint: notifier_extends +class >>>NoExtends<<< { + int build() => 0; +} +``` + +======= + +code: notifier_extends +severity: Severity.warning +message: Classes annotated by @riverpod must extend _$ClassName +test/lints/notifier_extends/failing_notifier_extends.dart:12:28 + +```dart +@riverpod +// expect_lint: notifier_extends +class WrongExtends extends >>>AsyncNotifier<<< { + int build() => 0; +} +``` diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_fix.diff index 49a064dd5..ba14cfc6d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_fix.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_fix.diff @@ -1,30 +1,6 @@ -Message: `Extend _$NoExtends` -Priority: 90 -Diff for file `test/lints/notifier_extends.dart:15`: -``` -@riverpod -// expect_lint: notifier_extends -- class NoExtends { -+ class NoExtends extends _$NoExtends { - int build() => 0; -} -``` ---- -Message: `Extend _$WrongExtends` -Priority: 90 -Diff for file `test/lints/notifier_extends.dart:21`: -``` -@riverpod -// expect_lint: notifier_extends -- class WrongExtends extends AsyncNotifier { -+ class WrongExtends extends _$WrongExtends { - int build() => 0; -} -``` ---- Message: `Extend _$NoGenerics` Priority: 90 -Diff for file `test/lints/notifier_extends.dart:39`: +Diff for file `test/lints/notifier_extends/notifier_extends.dart:26`: ``` @riverpod // expect_lint: notifier_extends @@ -36,7 +12,7 @@ Diff for file `test/lints/notifier_extends.dart:39`: --- Message: `Extend _$MissingGenerics` Priority: 90 -Diff for file `test/lints/notifier_extends.dart:45`: +Diff for file `test/lints/notifier_extends/notifier_extends.dart:32`: ``` @riverpod // expect_lint: notifier_extends @@ -48,7 +24,7 @@ Diff for file `test/lints/notifier_extends.dart:45`: --- Message: `Extend _$WrongOrder` Priority: 90 -Diff for file `test/lints/notifier_extends.dart:51`: +Diff for file `test/lints/notifier_extends/notifier_extends.dart:38`: ``` @riverpod // expect_lint: notifier_extends diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_lint.md index 03dd8b072..d573cb8c3 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/notifier_extends/notifier_extends_lint.md @@ -1,37 +1,7 @@ code: notifier_extends severity: Severity.warning message: Classes annotated by @riverpod must extend _$ClassName -test/lints/notifier_extends.dart:15:7 - -```dart -@riverpod -// expect_lint: notifier_extends -class >>>NoExtends<<< { - int build() => 0; -} -``` - -======= - -code: notifier_extends -severity: Severity.warning -message: Classes annotated by @riverpod must extend _$ClassName -test/lints/notifier_extends.dart:21:28 - -```dart -@riverpod -// expect_lint: notifier_extends -class WrongExtends extends >>>AsyncNotifier<<< { - int build() => 0; -} -``` - -======= - -code: notifier_extends -severity: Severity.warning -message: Classes annotated by @riverpod must extend _$ClassName -test/lints/notifier_extends.dart:39:44 +test/lints/notifier_extends/notifier_extends.dart:26:44 ```dart @riverpod @@ -46,7 +16,7 @@ class NoGenerics extends >>>_$NoGenerics<<< { code: notifier_extends severity: Severity.warning message: Classes annotated by @riverpod must extend _$ClassName -test/lints/notifier_extends.dart:45:37 +test/lints/notifier_extends/notifier_extends.dart:32:37 ```dart @riverpod @@ -61,7 +31,7 @@ class MissingGenerics extends >>>_$MissingGenerics<<< { code: notifier_extends severity: Severity.warning message: Classes annotated by @riverpod must extend _$ClassName -test/lints/notifier_extends.dart:51:32 +test/lints/notifier_extends/notifier_extends.dart:38:32 ```dart @riverpod diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_fix.diff b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_fix.diff index cb059cc5e..6ca7213de 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_fix.diff +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_fix.diff @@ -40,11 +40,14 @@ Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:123`: ``` } -- @Riverpod(dependencies: [ -- // The dependency is redundant because it is not a scoped provider -- // expect_lint: provider_dependencies -- generatedRoot, -- ]) +- @Riverpod( +- dependencies: +- // The dependency is redundant because it is not a scoped provider +- // expect_lint: provider_dependencies +- [ +- generatedRoot, +- ], +- ) + @riverpod int watchGeneratedRootAndContainsDependency( Ref ref, @@ -52,22 +55,21 @@ int watchGeneratedRootAndContainsDependency( --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:136`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:142`: ``` -// A dependency is specified but never used - -- @Riverpod(dependencies: [ + // generatedRoot is extra + // expect_lint: provider_dependencies +- [ - dep, -- // expect_lint: provider_dependencies - generatedRoot, -+ @Riverpod(dependencies: [dep]) ++ [dep]) int specifiedDependencyButNeverUsed(Ref ref) { ref.watch(depProvider); ``` --- Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:218`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:224`: ``` class MemberDependencies { // expect_lint: provider_dependencies @@ -79,7 +81,7 @@ class MemberDependencies { --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:226`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:232`: ``` class CanUpdateMultipleDependenciesAtOnce { // expect_lint: provider_dependencies @@ -91,7 +93,7 @@ class CanUpdateMultipleDependenciesAtOnce { --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:223`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:229`: ``` // expect_lint: provider_dependencies @@ -103,7 +105,7 @@ class CanUpdateMultipleDependenciesAtOnce { --- Message: `Remove "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:246`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:252`: ``` // Handle identifiers with dependencies // expect_lint: provider_dependencies @@ -115,7 +117,7 @@ void fn() {} --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:250`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:256`: ``` // expect_lint: provider_dependencies @@ -128,7 +130,7 @@ Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:250`: --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:258`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:264`: ``` // expect_lint: provider_dependencies @@ -140,7 +142,7 @@ int foo(Ref ref) { --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:275`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:281`: ``` // expect_lint: provider_dependencies @@ -153,7 +155,7 @@ Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:275`: --- Message: `Update "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:306`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:312`: ``` // expect_lint: provider_dependencies @@ -165,7 +167,7 @@ class Stateful2 extends StatefulWidget { --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:322`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:328`: ``` // expect_lint: provider_dependencies @@ -178,7 +180,7 @@ Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:322`: --- Message: `Specify "dependencies"` Priority: 100 -Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:335`: +Diff for file `test/lints/provider_dependencies/missing_dependencies2.dart:341`: ``` // expect_lint: provider_dependencies diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_lint.md index 7fde3b149..8b9fb8e7d 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/provider_dependencies/missing_dependencies2_lint.md @@ -79,18 +79,16 @@ int watchGeneratedScopedButMissingDependencies( code: provider_dependencies severity: Severity.warning message: Unused dependencies: generatedRoot -test/lints/provider_dependencies/missing_dependencies2.dart:123:25 +test/lints/provider_dependencies/missing_dependencies2.dart:127:7 ```dart -} - -@Riverpod(dependencies: >>>[ - // The dependency is redundant because it is not a scoped provider - // expect_lint: provider_dependencies - generatedRoot, -]<<<) + // The dependency is redundant because it is not a scoped provider + // expect_lint: provider_dependencies + >>>[ + generatedRoot, + ]<<<, +) int watchGeneratedRootAndContainsDependency( - Ref ref, ``` ======= @@ -98,14 +96,13 @@ int watchGeneratedRootAndContainsDependency( code: provider_dependencies severity: Severity.warning message: Unused dependencies: generatedRoot -test/lints/provider_dependencies/missing_dependencies2.dart:136:25 +test/lints/provider_dependencies/missing_dependencies2.dart:142:5 ```dart -// A dependency is specified but never used - -@Riverpod(dependencies: >>>[ + // generatedRoot is extra + // expect_lint: provider_dependencies + >>>[ dep, - // expect_lint: provider_dependencies generatedRoot, ]<<<) int specifiedDependencyButNeverUsed(Ref ref) { @@ -117,7 +114,7 @@ int specifiedDependencyButNeverUsed(Ref ref) { code: provider_dependencies severity: Severity.warning message: Unused dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:218:17 +test/lints/provider_dependencies/missing_dependencies2.dart:224:17 ```dart class MemberDependencies { @@ -133,7 +130,7 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: dep - test/lints/provider_dependencies/missing_dependencies2.dart:228:15 + test/lints/provider_dependencies/missing_dependencies2.dart:234:15 ```dart @Dependencies([]) @@ -143,7 +140,7 @@ contextMessages: } ``` message: Missing dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:226:17 +test/lints/provider_dependencies/missing_dependencies2.dart:232:17 ```dart class CanUpdateMultipleDependenciesAtOnce { @@ -159,7 +156,7 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: dep - test/lints/provider_dependencies/missing_dependencies2.dart:228:15 + test/lints/provider_dependencies/missing_dependencies2.dart:234:15 ```dart @Dependencies([]) @@ -169,7 +166,7 @@ contextMessages: } ``` message: Missing dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:223:15 +test/lints/provider_dependencies/missing_dependencies2.dart:229:15 ```dart @@ -184,7 +181,7 @@ class CanUpdateMultipleDependenciesAtOnce { code: provider_dependencies severity: Severity.warning message: Unused dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:246:15 +test/lints/provider_dependencies/missing_dependencies2.dart:252:15 ```dart // Handle identifiers with dependencies @@ -200,7 +197,7 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: dep - test/lints/provider_dependencies/missing_dependencies2.dart:251:3 + test/lints/provider_dependencies/missing_dependencies2.dart:257:3 ```dart // expect_lint: provider_dependencies @@ -210,7 +207,7 @@ contextMessages: ``` message: Missing dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:250:1 +test/lints/provider_dependencies/missing_dependencies2.dart:256:1 ```dart @@ -228,7 +225,7 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: dep - test/lints/provider_dependencies/missing_dependencies2.dart:260:3 + test/lints/provider_dependencies/missing_dependencies2.dart:266:3 ```dart @riverpod @@ -238,7 +235,7 @@ contextMessages: } ``` message: Missing dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:258:1 +test/lints/provider_dependencies/missing_dependencies2.dart:264:1 ```dart @@ -254,7 +251,7 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: dep - test/lints/provider_dependencies/missing_dependencies2.dart:278:12 + test/lints/provider_dependencies/missing_dependencies2.dart:284:12 ```dart @override @@ -264,7 +261,7 @@ contextMessages: } ``` message: Missing dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:275:1 +test/lints/provider_dependencies/missing_dependencies2.dart:281:1 ```dart @@ -285,7 +282,7 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: dep - test/lints/provider_dependencies/missing_dependencies2.dart:317:12 + test/lints/provider_dependencies/missing_dependencies2.dart:323:12 ```dart @override @@ -295,7 +292,7 @@ contextMessages: } ``` message: Missing dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:306:15 +test/lints/provider_dependencies/missing_dependencies2.dart:312:15 ```dart @@ -311,7 +308,7 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: dep - test/lints/provider_dependencies/missing_dependencies2.dart:331:41 + test/lints/provider_dependencies/missing_dependencies2.dart:337:41 ```dart class _Stateful3State extends State { @@ -321,7 +318,7 @@ contextMessages: ``` message: Missing dependencies: dep -test/lints/provider_dependencies/missing_dependencies2.dart:322:1 +test/lints/provider_dependencies/missing_dependencies2.dart:328:1 ```dart @@ -342,7 +339,7 @@ code: provider_dependencies severity: Severity.warning contextMessages: message: anotherNonEmptyScoped - test/lints/provider_dependencies/missing_dependencies2.dart:337:13 + test/lints/provider_dependencies/missing_dependencies2.dart:343:13 ```dart @riverpod @@ -352,7 +349,7 @@ contextMessages: } ``` message: Missing dependencies: anotherNonEmptyScoped -test/lints/provider_dependencies/missing_dependencies2.dart:335:1 +test/lints/provider_dependencies/missing_dependencies2.dart:341:1 ```dart From 3ceda7c878ad32162218c3ea230c7cdded048466 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 3 Nov 2024 02:00:06 +0100 Subject: [PATCH 366/387] Fix lint --- examples/marvel/lib/src/widgets/search_bar.dart | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/examples/marvel/lib/src/widgets/search_bar.dart b/examples/marvel/lib/src/widgets/search_bar.dart index 5a1be1940..a78989098 100644 --- a/examples/marvel/lib/src/widgets/search_bar.dart +++ b/examples/marvel/lib/src/widgets/search_bar.dart @@ -6,18 +6,17 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import '../screens/home.dart'; +const _height = 300.0; + class _SearchTheme { const _SearchTheme({ required this.width, - // ignore: unused_element, blocked by https://github.com/dart-lang/linter/issues/3232 - this.height = 300, required this.searchDecoration, required this.iconPadding, required this.searchMargin, }); final double width; - final double height; final BoxDecoration searchDecoration; final EdgeInsets iconPadding; final EdgeInsets searchMargin; @@ -187,7 +186,7 @@ class _SearchHintContainer extends StatelessWidget { Widget build(BuildContext context) { return Container( constraints: BoxConstraints( - maxHeight: theme.height, + maxHeight: _height, ), margin: theme.searchMargin, child: Material( @@ -196,7 +195,7 @@ class _SearchHintContainer extends StatelessWidget { clipBehavior: Clip.hardEdge, child: OverflowBox( alignment: Alignment.topLeft, - maxHeight: theme.height, + maxHeight: _height, maxWidth: 300, child: child, ), From b2432b03ecc7500552fe43d33044177026b9b213 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 3 Nov 2024 02:05:21 +0100 Subject: [PATCH 367/387] enclosingElement3 --- packages/riverpod/test/meta_test.dart | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index ccc67210c..50e894b8c 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -184,7 +184,8 @@ class _PublicAPIVisitor extends GeneralizingElementVisitor { } void _verifyInheritsAnnotations(Element element) { - final parent = element.enclosingElement3; + // ignore: deprecated_member_use, needed to support older SDK + final parent = element.enclosingElement; if (parent is! ClassElement) return; From 003f2f744fdab385341a99ed2cf5c5a06037c723 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Tue, 19 Nov 2024 00:26:00 +0100 Subject: [PATCH 368/387] Sync dev with master --- analysis_options.yaml | 3 + examples/marvel/analysis_options.yaml | 3 + .../flutter_riverpod/lib/src/builders.dart | 2 - packages/hooks_riverpod/pubspec.yaml | 2 +- packages/riverpod/lib/src/core/ref.dart | 2 +- .../test/ref_invocation_test.dart | 142 +++++++++++++- .../test/widget_ref_invocation_test.dart | 83 ++++++++ packages/riverpod_generator/CHANGELOG.md | 4 + .../generated/golden/lib/sync.dart | 1 + packages/riverpod_lint/CHANGELOG.md | 4 + .../lib/src/lints/functional_ref.dart | 37 ---- .../lib/src/lints/provider_dependencies.dart | 2 +- ...rt_functional_provider_to_class_based.dart | 1 + ...rt_functional_provider_to_class_based.diff | 4 +- .../test/golden.dart | 182 ++++++++++++++++++ .../avoid_build_context_in_providers.dart | 1 + .../fix/functional_ref_test.dart | 18 -- .../avoid_build_context_in_providers_lint.md | 12 +- .../advanced/select/select_async/codegen.dart | 1 + .../cancel/detail_screen_cancel/codegen.dart | 1 + .../detail_screen_debounce/codegen.dart | 1 + .../provider_with_extension/codegen.dart | 1 + .../fetch_activity/codegen.dart | 1 + website/docs/concepts/about_codegen/main.dart | 1 + .../provider_type/async_fn_future.dart | 1 + .../provider_type/async_fn_stream.dart | 1 + .../provider_type/auto_dispose.dart | 1 + .../about_codegen/provider_type/family.dart | 1 + .../provider_type/family_fn.dart | 1 + .../about_codegen/provider_type/sync_fn.dart | 1 + .../city_provider/codegen.dart | 1 + .../read_in_provider/codegen.dart | 1 + .../select_async_provider/codegen.dart | 1 + .../weather_provider/codegen.dart | 1 + .../whole_object_provider/codegen.dart | 1 + .../lifecycle_on_dispose/codegen.dart | 1 + .../creating_a_provider/codegen.dart | 1 + .../declaring_many_providers/codegen.dart | 1 + .../docs/concepts/reading/listen/codegen.dart | 1 + .../concepts/reading/provider/codegen.dart | 1 + .../docs/concepts/reading/watch/codegen.dart | 1 + .../auto_dispose/cache_for_usage/codegen.dart | 1 + .../auto_dispose/codegen_keep_alive.dart | 1 + .../auto_dispose/keep_alive/codegen.dart | 1 + .../on_dispose_example/codegen.dart | 1 + .../functional_ref/codegen.dart | 1 + .../listen_example/codegen.dart | 1 + .../notifier_ref/codegen.dart | 1 + .../watch_placement/codegen.dart | 1 + .../first_request/codegen/provider.dart | 1 + .../passing_args/family/codegen.dart | 1 + .../passing_args/no_arg_provider/codegen.dart | 1 + .../codegen/todo_list_provider.dart | 1 + .../testing/provider_to_mock/codegen.dart | 1 + .../websockets_sync/pipe_change_notifier.dart | 1 + .../sync_definition/codegen.dart | 1 + website/docs/from_provider/family/family.dart | 1 + .../motivation/async_values/async_values.dart | 1 + .../motivation/auto_dispose/auto_dispose.dart | 1 + .../motivation/combine/combine.dart | 1 + .../motivation/same_type/same_type.dart | 1 + .../introduction/why_riverpod/codegen.dart | 1 + .../config_provider/codegen.dart | 1 + .../completed_todos/completed_todos.dart | 1 + .../live_stream_chat_provider/codegen.dart | 1 + website/static/snippets/create.dart | 1 + 66 files changed, 478 insertions(+), 73 deletions(-) diff --git a/analysis_options.yaml b/analysis_options.yaml index 7ee5dfa6d..f7880c29b 100644 --- a/analysis_options.yaml +++ b/analysis_options.yaml @@ -11,6 +11,9 @@ analyzer: included_file_warning: ignore # false positive when using Freezed invalid_annotation_target: ignore + # I prefer specifying a parameter on a widget even if they are unused (such as Key) + # for the sake of consistency. + unused_element_parameter: false linter: rules: diff --git a/examples/marvel/analysis_options.yaml b/examples/marvel/analysis_options.yaml index fd37ac1ff..611834f1a 100644 --- a/examples/marvel/analysis_options.yaml +++ b/examples/marvel/analysis_options.yaml @@ -6,3 +6,6 @@ analyzer: errors: # Some assets are voluntarily gitignored asset_does_not_exist: ignore + # I prefer specifying a parameter on a widget even if they are unused (such as Key) + # for the sake of consistency. + unused_element_parameter: false \ No newline at end of file diff --git a/packages/flutter_riverpod/lib/src/builders.dart b/packages/flutter_riverpod/lib/src/builders.dart index 42e60ae7c..09567226e 100644 --- a/packages/flutter_riverpod/lib/src/builders.dart +++ b/packages/flutter_riverpod/lib/src/builders.dart @@ -8,8 +8,6 @@ // You can then use it in your terminal by executing: // generate_providers -// ignore_for_file: invalid_use_of_internal_member - import 'package:flutter/foundation.dart'; import 'package:meta/meta.dart'; diff --git a/packages/hooks_riverpod/pubspec.yaml b/packages/hooks_riverpod/pubspec.yaml index eb4d45f5b..4f7ea2acb 100644 --- a/packages/hooks_riverpod/pubspec.yaml +++ b/packages/hooks_riverpod/pubspec.yaml @@ -17,7 +17,7 @@ dependencies: collection: ^1.15.0 flutter: sdk: flutter - flutter_hooks: '>=0.18.0 <0.21.0' + flutter_hooks: '>=0.18.0 <0.22.0' flutter_riverpod: 3.0.0-dev.3 riverpod: 3.0.0-dev.3 state_notifier: ">=0.7.2 <2.0.0" diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index b401bee2d..d48e4a879 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -205,7 +205,7 @@ final = Provider(dependencies: []); /// Using [asReload] will disable this behavior and count as a /// "hard refresh". /// - /// If used on a provider which is not initialized, this method will have no effect. + /// If used on a provider which is not initialized or disposed, this method will have no effect. /// {@endtemplate} void invalidate(ProviderOrFamily providerOrFamily, {bool asReload = false}) { _throwIfInvalidUsage(); diff --git a/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart b/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart index b56d2c3c7..17c6f930e 100644 --- a/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart @@ -6,15 +6,15 @@ import 'analyzer_test_utils.dart'; // ignore: invalid_use_of_internal_member extension on RiverpodAnalysisResult { List get refWatchInvocations { - return refInvocations.cast(); + return refInvocations.whereType().toList(); } List get refListenInvocations { - return refInvocations.cast(); + return refInvocations.whereType().toList(); } List get refReadInvocations { - return refInvocations.cast(); + return refInvocations.whereType().toList(); } } @@ -436,8 +436,93 @@ final provider = Provider((ref) { ); }); - testSource('Decodes unknown ref usages', - timeout: const Timeout.factor(4), source: ''' + testSource('Decodes nested ref.read invocations with family providers', + runGenerator: true, source: ''' +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'foo.g.dart'; + +final dep = FutureProvider((ref) => 0); +final dep2 = FutureProvider.family((ref, int arg) => 0); +final dep3 = FutureProvider.family((ref, int arg) => 0); + +final provider = Provider((ref) { + ref.read(dep2(ref.read(dep))); + + return 0; +}); + +final provider2 = Provider((ref) { + ref.read(dep3(ref.read(dep2(ref.read(dep))))); + + return 0; +}); + +int transformArg(int arg) { + return arg; +} + +final provider3 = Provider((ref) { + ref.read(dep3(transformArg(ref.read(dep)))); + + return 0; +}); +''', (resolver, unit, units) async { + final result = await resolver.resolveRiverpodAnalysisResult(); + + expect(result.refReadInvocations, hasLength(7)); + expect(result.refInvocations, result.refReadInvocations); + + // provider + expect(result.refReadInvocations[0].node.toSource(), 'ref.read(dep)'); + expect(result.refReadInvocations[0].function.toSource(), 'read'); + expect( + result.refReadInvocations[0].listenable.provider?.providerElement, + same( + result.legacyProviderDeclarations.findByName('dep').providerElement, + ), + ); + + expect( + result.refReadInvocations[1].node.toSource(), + 'ref.read(dep2(ref.read(dep)))', + ); + expect(result.refReadInvocations[1].function.toSource(), 'read'); + expect( + result.refReadInvocations[1].listenable.provider?.providerElement, + same( + result.legacyProviderDeclarations.findByName('dep2').providerElement, + ), + ); + + // provider2 + expect(result.refReadInvocations[2].node.toSource(), 'ref.read(dep)'); + expect( + result.refReadInvocations[3].node.toSource(), + 'ref.read(dep2(ref.read(dep)))', + ); + expect( + result.refReadInvocations[4].node.toSource(), + 'ref.read(dep3(ref.read(dep2(ref.read(dep)))))', + ); + expect(result.refReadInvocations[4].function.toSource(), 'read'); + expect( + result.refReadInvocations[4].listenable.provider?.providerElement, + same( + result.legacyProviderDeclarations.findByName('dep3').providerElement, + ), + ); + + // provider3 + expect(result.refReadInvocations[5].node.toSource(), 'ref.read(dep)'); + expect( + result.refReadInvocations[6].node.toSource(), + 'ref.read(dep3(transformArg(ref.read(dep))))', + ); + }); + + testSource('Decodes unknown ref usages', source: ''' import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; @@ -592,6 +677,53 @@ void fn(_Ref ref) { ); }); + testSource('Decodes mix of nested ref.watch and ref.read invocations', + runGenerator: true, source: ''' +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'foo.g.dart'; + +final dep = FutureProvider((ref) => 0); +final dep2 = FutureProvider.family((ref, int arg) => 0); + +final provider = Provider((ref) { + ref.watch(dep2(ref.read(dep))); + + return 0; +}); +''', (resolver, unit, units) async { + final result = await resolver.resolveRiverpodAnalysisResult(); + + expect(result.refWatchInvocations, hasLength(1)); + expect(result.refReadInvocations, hasLength(1)); + expect( + result.refInvocations, + [...result.refReadInvocations, ...result.refWatchInvocations], + ); + + expect( + result.refWatchInvocations[0].node.toSource(), + 'ref.watch(dep2(ref.read(dep)))', + ); + expect(result.refWatchInvocations[0].function.toSource(), 'watch'); + expect( + result.refWatchInvocations[0].listenable.provider?.providerElement, + same( + result.legacyProviderDeclarations.findByName('dep2').providerElement, + ), + ); + + expect(result.refReadInvocations[0].node.toSource(), 'ref.read(dep)'); + expect(result.refReadInvocations[0].function.toSource(), 'read'); + expect( + result.refReadInvocations[0].listenable.provider?.providerElement, + same( + result.legacyProviderDeclarations.findByName('dep').providerElement, + ), + ); + }); + testSource('Decodes provider.query ref.watch usages', timeout: const Timeout.factor(4), runGenerator: true, source: r''' import 'package:riverpod/riverpod.dart'; diff --git a/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart b/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart index 041a421b6..795d24e3c 100644 --- a/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart @@ -652,6 +652,89 @@ void fn(_Ref ref) { ); }); + testSource('Decodes nested ref.watch invocations with family providers', + runGenerator: true, source: ''' +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter/material.dart'; + +part 'foo.g.dart'; + +final family = FutureProvider.family((ref, id) => 0); + +@Riverpod(keepAlive: true) +Future family2(Family2Ref ref, {required int id}) async => 0; + +class MyWidget extends ConsumerWidget { + const MyWidget({super.key}); + + @override + Widget build(BuildContext context, WidgetRef ref) { + ref.watch(family(ref.read(family2Provider(id: 0)))); + ref.watch(family2Provider(ref.watch(family(id: 0)))); + return Container(); + } +} +''', (resolver, unit, units) async { + final result = await resolver.resolveRiverpodAnalysisResult(); + + expect(result.widgetRefWatchInvocations, hasLength(3)); + + expect( + result.widgetRefWatchInvocations[0].node.toSource(), + 'ref.watch(family(ref.read(family2Provider(id: 0))))', + ); + expect(result.widgetRefWatchInvocations[0].function.toSource(), 'watch'); + expect( + result.widgetRefWatchInvocations[0].listenable.provider?.node.toSource(), + 'family(ref.read(family2Provider(id: 0)))', + ); + expect( + result.widgetRefWatchInvocations[0].listenable.provider?.node.toSource(), + 'family', + ); + expect( + result.widgetRefWatchInvocations[0].listenable.provider?.providerElement, + same( + result.legacyProviderDeclarations.findByName('family').providerElement, + ), + ); + expect( + result.widgetRefWatchInvocations[0].listenable.familyArguments + ?.toSource(), + '(ref.read(family2Provider(id: 0)))', + ); + + // ref.watch(family2Provider(ref.watch(family(id: 0))); + expect( + result.widgetRefWatchInvocations[1].node.toSource(), + 'ref.watch(family2Provider(ref.watch(family(id: 0))))', + ); + expect(result.widgetRefWatchInvocations[1].function.toSource(), 'watch'); + expect( + result.widgetRefWatchInvocations[1].listenable.provider?.node.toSource(), + 'family2Provider(ref.watch(family(id: 0)))', + ); + expect( + result.widgetRefWatchInvocations[1].listenable.provider?.node.toSource(), + 'family2Provider', + ); + expect( + result.widgetRefWatchInvocations[1].listenable.provider?.providerElement, + same( + result.functionalProviderDeclarations + .findByName('family2') + .providerElement, + ), + ); + expect( + result.widgetRefWatchInvocations[1].listenable.familyArguments + ?.toSource(), + '(ref.watch(family(id: 0)))', + ); + }); + testSource('Decodes provider.query ref.watch usages', timeout: const Timeout.factor(4), runGenerator: true, source: r''' import 'package:riverpod/riverpod.dart'; diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index b209439e1..348a2e2a1 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -17,6 +17,10 @@ - Added support for `@Riverpod(retry: ...)` +## 2.6.3 - 2024-11-18 + +- `riverpod_analyzer_utils` upgraded to `0.5.8` + ## 2.6.2 - 2024-10-27 - `riverpod_analyzer_utils` upgraded to `0.5.7` diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart index 228a0eff2..66f008712 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart @@ -1,3 +1,4 @@ +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'sync.g.dart'; diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index 9fa55e203..de0da62e5 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -42,6 +42,10 @@ Various lints had their severity changed: - `riverpod` upgraded to `3.0.0-dev.0` +## 2.6.3 - 2024-11-18 + +- provider_dependencies now correctly detects nested ref invocations where a dependency is used as a parameter of another dependency (thanks to @josh-burton) + ## 2.6.2 - 2024-10-27 - Support latest custom_lint diff --git a/packages/riverpod_lint/lib/src/lints/functional_ref.dart b/packages/riverpod_lint/lib/src/lints/functional_ref.dart index a5c804a5e..ad8278f8d 100644 --- a/packages/riverpod_lint/lib/src/lints/functional_ref.dart +++ b/packages/riverpod_lint/lib/src/lints/functional_ref.dart @@ -5,10 +5,8 @@ import 'package:analyzer/error/error.dart' // ignore: undefined_hidden_name, necessary to support lower analyzer version LintCode; import 'package:analyzer/error/listener.dart'; -import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart'; import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; -import 'package:meta/meta.dart'; import '../riverpod_custom_lint.dart'; @@ -133,41 +131,6 @@ extension LibraryForNode on AstNode { LibraryElement get library => (root as CompilationUnit).library; } -extension ImportFix on DartFileEditBuilder { - @useResult - String importRef() { - return _importWithPrefix('Ref'); - } - - @useResult - String _importWithPrefix(String name) { - final hooksRiverpodUri = - Uri(scheme: 'package', path: 'hooks_riverpod/hooks_riverpod.dart'); - final flutterRiverpodUri = - Uri(scheme: 'package', path: 'flutter_riverpod/flutter_riverpod.dart'); - final riverpodUri = Uri(scheme: 'package', path: 'riverpod/riverpod.dart'); - - if (importsLibrary(hooksRiverpodUri)) { - return _buildImport(hooksRiverpodUri, name); - } - - if (importsLibrary(flutterRiverpodUri)) { - return _buildImport(flutterRiverpodUri, name); - } - - return _buildImport(riverpodUri, name); - } - - String _buildImport(Uri uri, String name) { - final import = importLibraryElement(uri); - - final prefix = import.prefix; - if (prefix != null) return '$prefix.$name'; - - return name; - } -} - TypeAnnotation typeAnnotationFor(FormalParameter param) { if (param is DefaultFormalParameter) { return typeAnnotationFor(param.parameter); diff --git a/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart b/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart index a7054907e..af555ef47 100644 --- a/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart +++ b/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart @@ -2,7 +2,7 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/diagnostic/diagnostic.dart'; import 'package:analyzer/error/error.dart' hide - // ignore: undefined_hidden_name, necessary to support broad analyzer versions + // ignore: undefined_hidden_name, necessary to support lower analyzer version LintCode; import 'package:analyzer/error/listener.dart'; import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart'; diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart index f7f660062..894b5db24 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart @@ -1,3 +1,4 @@ +import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'convert_functional_provider_to_class_based.g.dart'; diff --git a/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff index 0980c5b6b..729b5335f 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff +++ b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff @@ -1,6 +1,6 @@ Message: `Convert to class-based provider` Priority: 100 -Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:7`: +Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:8`: ``` /// Some comment @riverpod @@ -15,7 +15,7 @@ Diff for file `test/assists/convert_functional_provider_to_class_based/convert_f --- Message: `Convert to class-based provider` Priority: 100 -Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:11`: +Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:12`: ``` /// Some comment @riverpod diff --git a/packages/riverpod_lint_flutter_test/test/golden.dart b/packages/riverpod_lint_flutter_test/test/golden.dart index 7d362c40b..a368db2d1 100644 --- a/packages/riverpod_lint_flutter_test/test/golden.dart +++ b/packages/riverpod_lint_flutter_test/test/golden.dart @@ -1,7 +1,16 @@ +import 'dart:convert'; import 'dart:io'; +import 'package:analyzer/dart/analysis/results.dart'; +import 'package:analyzer/dart/analysis/utilities.dart'; +import 'package:analyzer/source/source_range.dart'; +import 'package:analyzer_plugin/protocol/protocol_generated.dart'; +import 'package:custom_lint_core/custom_lint_core.dart'; import 'package:freezed_annotation/freezed_annotation.dart'; +import 'package:path/path.dart'; +import 'package:pubspec_parse/pubspec_parse.dart'; import 'package:test/test.dart'; +import 'package:riverpod_lint/src/riverpod_custom_lint.dart'; final _goldenWrite = bool.parse(Platform.environment[r'goldens'] ?? 'false'); @@ -109,3 +118,176 @@ class _MatchesGoldenFile extends Matcher { return mismatchDescription.add('Unknown mismatch'); } } + +File writeToTemporaryFile(String content) { + final tempDir = Directory.systemTemp.createTempSync(); + addTearDown(() => tempDir.deleteSync(recursive: true)); + + final file = File(join(tempDir.path, 'file.dart')) + ..createSync(recursive: true) + ..writeAsStringSync(content); + + return file; +} + +const _cursor = '<>'; + +class OffsetHelper { + OffsetHelper._(this._content); + + final String _content; + + /// Strings must be code of the format: + /// + /// ``dart + /// Some<>Code + /// ``` + /// + /// where `<>` is the location of the cursor. + /// + /// At least one `<>` must be present, or the function will throw. + Iterable rangesForString(String string) sync* { + final cursors = '<>'.allMatches(string).toList(); + if (cursors.isEmpty) { + throw ArgumentError('String does not contain any cursors: $string'); + } + + final stringWithoutCursors = string.replaceAll(_cursor, ''); + + final start = _content.indexOf(stringWithoutCursors); + if (start == -1) { + throw ArgumentError('String not found in content: $stringWithoutCursors'); + } + + if (_content.indexOf(stringWithoutCursors, start + 1) != -1) { + throw ArgumentError( + 'Found the string twice in the content: $stringWithoutCursors', + ); + } + + for (final (index, cursor) in cursors.indexed) { + // In the case of multiple cursors, we need to adjust the offset + // to account for the previous cursors. + final actualCursorStart = cursor.start - 2 * index; + yield SourceRange(start + actualCursorStart, 0); + } + } + + Future> runAssist( + RiverpodAssist assist, + ResolvedUnitResult result, + Iterable cursorRanges, { + Pubspec? pubspec, + }) async { + return Future.wait( + cursorRanges.map( + (range) => assist.testRun(result, range, pubspec: pubspec), + ), + ).then((value) => value.expand((e) => e)); + } + + void debugOffset(List offsets) { + offsets.sort(); + + var mappedContent = _content; + for (final offset in offsets.reversed) { + mappedContent = mappedContent.substring(0, offset) + + '<>' + + mappedContent.substring(offset); + } + + final lines = LineSplitter.split(mappedContent).toList(); + + final codes = []; + + StringBuffer? buffer; + + void openBuffer() { + buffer ??= StringBuffer("helper.rangesForString('''\n"); + } + + void closeBuffer() { + if (buffer == null) return; + + buffer!.write("''')"); + codes.add(buffer.toString()); + buffer = null; + } + + // Print all lines with <> in them and one line before and after. + for (final (index, line) in lines.indexed) { + if (buffer == null && line.trim().isEmpty) continue; + + final hasCursor = line.contains(_cursor); + late final hadCursor = index >= 1 && lines[index - 1].contains(_cursor); + late final willHaveCursor = + index + 1 < lines.length && lines[index + 1].contains(_cursor); + + if (hasCursor || hadCursor || willHaveCursor) { + openBuffer(); + buffer!.writeln(line); + } else { + closeBuffer(); + } + } + + if (buffer != null) closeBuffer(); + + if (codes.length == 1) { + print(' final cursors = ${codes.single};'); + } else { + print(' final cursors = ['); + for (final code in codes) { + print(' ...$code,'); + } + print(' ];'); + } + } +} + +void testGolden( + String description, + String fileName, + Future> Function( + ResolvedUnitResult unit, + OffsetHelper offsetHelper, + ) body, { + required String sourcePath, +}) { + test(description, () async { + final file = File(sourcePath).absolute; + + final result = await resolveFile2(path: file.path); + result as ResolvedUnitResult; + + final source = file.readAsStringSync(); + final changes = await body(result, OffsetHelper._(source)) + .then((value) => value.toList()); + + try { + expect( + changes, + matcherNormalizedPrioritizedSourceChangeSnapshot( + fileName, + sources: {'**': source}, + relativePath: Directory.current.path, + ), + ); + } on TestFailure { + if (!_goldenWrite) rethrow; + + final source = File(sourcePath).readAsStringSync(); + final result = encodePrioritizedSourceChanges( + changes, + sources: {'**': source}, + relativePath: Directory.current.path, + ); + + final golden = File('test/$fileName'); + golden + ..createSync(recursive: true) + ..writeAsStringSync(result); + return; + } + }); +} diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart index e3ca4231b..faa14343c 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart @@ -1,6 +1,7 @@ // ignore_for_file: unused_element import 'package:flutter/widgets.dart'; +import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'avoid_build_context_in_providers.g.dart'; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref_test.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref_test.dart index 34a4d87f6..a28b4cdd1 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref_test.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/functional_ref_test.dart @@ -21,22 +21,4 @@ void main() { return changes.flattened; }, ); - - testGolden( - 'Verify that @riverpod functions have a Ref', - 'test/lints/functional_ref/fix/failing_functional_ref.diff', - sourcePath: 'test/lints/functional_ref/failing_functional_ref.dart', - (result, helper) async { - const lint = FunctionalRef(); - final fix = lint.getFixes().single; - - final errors = await lint.testRun(result); - - final changes = await Future.wait([ - for (final error in errors) fix.testRun(result, error, errors), - ]); - - return changes.flattened; - }, - ); } diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md index 589c4dde1..36544c25b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md @@ -1,7 +1,7 @@ code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:12:3 +test/lints/avoid_build_context_in_providers.dart:13:3 ```dart Ref ref, @@ -16,7 +16,7 @@ test/lints/avoid_build_context_in_providers.dart:12:3 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:14:3 +test/lints/avoid_build_context_in_providers.dart:15:3 ```dart BuildContext context1, { @@ -31,7 +31,7 @@ test/lints/avoid_build_context_in_providers.dart:14:3 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:22:5 +test/lints/avoid_build_context_in_providers.dart:23:5 ```dart int build( @@ -46,7 +46,7 @@ test/lints/avoid_build_context_in_providers.dart:22:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:24:5 +test/lints/avoid_build_context_in_providers.dart:25:5 ```dart BuildContext context1, { @@ -61,7 +61,7 @@ test/lints/avoid_build_context_in_providers.dart:24:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:30:5 +test/lints/avoid_build_context_in_providers.dart:31:5 ```dart void event( @@ -76,7 +76,7 @@ test/lints/avoid_build_context_in_providers.dart:30:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:32:5 +test/lints/avoid_build_context_in_providers.dart:33:5 ```dart BuildContext context3, { diff --git a/website/docs/advanced/select/select_async/codegen.dart b/website/docs/advanced/select/select_async/codegen.dart index 9ddf7256b..94b911bca 100644 --- a/website/docs/advanced/select/select_async/codegen.dart +++ b/website/docs/advanced/select/select_async/codegen.dart @@ -1,5 +1,6 @@ // ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors, body_might_complete_normally_nullable +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart index 8094b9996..0fe63d984 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart @@ -1,6 +1,7 @@ import 'dart:convert'; import 'package:http/http.dart' as http; +import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../detail_screen/codegen.dart'; diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart index 732f8e134..54ec304da 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart @@ -1,5 +1,6 @@ import 'dart:convert'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.dart index e3663c7a0..85db5313b 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.dart @@ -1,5 +1,6 @@ import 'dart:convert'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../detail_screen/codegen.dart'; diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart index 16ac99207..54cbd50da 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart @@ -1,5 +1,6 @@ import 'dart:convert'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/concepts/about_codegen/main.dart b/website/docs/concepts/about_codegen/main.dart index 6dbbf14aa..b0a1a4347 100644 --- a/website/docs/concepts/about_codegen/main.dart +++ b/website/docs/concepts/about_codegen/main.dart @@ -1,5 +1,6 @@ // ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, avoid_unused_constructor_parameters +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart index 7ab60af7c..27f448f98 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'async_fn_future.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart index 43b3a877f..a7080cdc9 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'async_fn_stream.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart index 3351a2da9..ecc7afa9e 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'auto_dispose.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/family.dart b/website/docs/concepts/about_codegen/provider_type/family.dart index d4a88c306..22db5c5f8 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'family.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.dart index 6ac513340..e7e941e5f 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'family_fn.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.dart index 73e82b7e2..0099d43b4 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'sync_fn.g.dart'; diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.dart index 092367038..39edaa161 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart index c76e47a97..556d228c0 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart index 0bdb6db69..1d76926cc 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart @@ -1,4 +1,5 @@ import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'models.dart'; diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart index a66b91521..0d04d544e 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart index cb3a1ec73..e52b9f54b 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart @@ -1,4 +1,5 @@ import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'models.dart'; diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.dart index 35f832a69..ab64f257e 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.dart @@ -2,6 +2,7 @@ import 'dart:async'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.dart b/website/docs/concepts/providers/creating_a_provider/codegen.dart index 15efd2d7a..163f5b4b5 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.dart index 276cab4dd..17b1ccab8 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/reading/listen/codegen.dart b/website/docs/concepts/reading/listen/codegen.dart index b4531515a..ac2cd9cae 100644 --- a/website/docs/concepts/reading/listen/codegen.dart +++ b/website/docs/concepts/reading/listen/codegen.dart @@ -1,5 +1,6 @@ // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../counter/codegen.dart'; diff --git a/website/docs/concepts/reading/provider/codegen.dart b/website/docs/concepts/reading/provider/codegen.dart index 954941a9b..46e832fe8 100644 --- a/website/docs/concepts/reading/provider/codegen.dart +++ b/website/docs/concepts/reading/provider/codegen.dart @@ -1,4 +1,5 @@ // ignore_for_file: avoid_positional_boolean_parameters +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/reading/watch/codegen.dart b/website/docs/concepts/reading/watch/codegen.dart index 947af2a51..ebbaa8d7c 100644 --- a/website/docs/concepts/reading/watch/codegen.dart +++ b/website/docs/concepts/reading/watch/codegen.dart @@ -1,5 +1,6 @@ // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart index a19f6a897..69dad3871 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart @@ -1,5 +1,6 @@ // ignore_for_file: unused_local_variable +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.dart index 74af13186..48eba50c6 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen_keep_alive.g.dart'; diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.dart index a3f17cc7c..8d2afa235 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.dart @@ -1,5 +1,6 @@ // ignore_for_file: unused_local_variable +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart index a7eafb658..d783c47fd 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart @@ -2,6 +2,7 @@ import 'dart:async'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.dart index e776d8c31..8f0ea7b7c 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.dart @@ -1,5 +1,6 @@ // ignore_for_file: unused_local_variable +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.dart b/website/docs/essentials/combining_requests/listen_example/codegen.dart index 8de5958a6..dc8a14a77 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.dart @@ -1,5 +1,6 @@ // ignore_for_file: unused_local_variable, avoid_print +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.dart index c184574c3..35609efa1 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.dart @@ -1,5 +1,6 @@ // ignore_for_file: unused_local_variable +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.dart index d5a9cd653..e2ae6e347 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.dart @@ -1,6 +1,7 @@ // ignore_for_file: unused_local_variable import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/first_request/codegen/provider.dart b/website/docs/essentials/first_request/codegen/provider.dart index 9a68b34be..afaff3513 100644 --- a/website/docs/essentials/first_request/codegen/provider.dart +++ b/website/docs/essentials/first_request/codegen/provider.dart @@ -1,6 +1,7 @@ /* SNIPPET START */ import 'dart:convert'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'activity.dart'; diff --git a/website/docs/essentials/passing_args/family/codegen.dart b/website/docs/essentials/passing_args/family/codegen.dart index ab4743a20..5c8a0117e 100644 --- a/website/docs/essentials/passing_args/family/codegen.dart +++ b/website/docs/essentials/passing_args/family/codegen.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_print import 'dart:convert'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../first_request/codegen/activity.dart'; diff --git a/website/docs/essentials/passing_args/no_arg_provider/codegen.dart b/website/docs/essentials/passing_args/no_arg_provider/codegen.dart index da1c34adb..eee4a724c 100644 --- a/website/docs/essentials/passing_args/no_arg_provider/codegen.dart +++ b/website/docs/essentials/passing_args/no_arg_provider/codegen.dart @@ -1,5 +1,6 @@ // ignore_for_file: avoid_print +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../first_request/codegen/activity.dart'; diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.dart index f0a84c83a..e80b9d4a0 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:freezed_annotation/freezed_annotation.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.dart b/website/docs/essentials/testing/provider_to_mock/codegen.dart index 073779b2d..078148729 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.dart index 0cc75bea6..03d665216 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.dart @@ -1,6 +1,7 @@ // ignore_for_file: omit_local_variable_types import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'pipe_change_notifier.g.dart'; diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.dart index cdddcb32d..eeaba83b6 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/from_provider/family/family.dart b/website/docs/from_provider/family/family.dart index 61cf268fc..88012fd24 100644 --- a/website/docs/from_provider/family/family.dart +++ b/website/docs/from_provider/family/family.dart @@ -1,5 +1,6 @@ import 'dart:math'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'family.g.dart'; diff --git a/website/docs/from_provider/motivation/async_values/async_values.dart b/website/docs/from_provider/motivation/async_values/async_values.dart index 0518dc0a7..96f694e2a 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.dart @@ -1,5 +1,6 @@ import 'package:collection/collection.dart'; import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../helpers/item.dart'; diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart index 052686f61..fcb26dd6c 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart @@ -1,5 +1,6 @@ import 'dart:math'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'auto_dispose.g.dart'; diff --git a/website/docs/from_provider/motivation/combine/combine.dart b/website/docs/from_provider/motivation/combine/combine.dart index 521d231b7..f26e5d285 100644 --- a/website/docs/from_provider/motivation/combine/combine.dart +++ b/website/docs/from_provider/motivation/combine/combine.dart @@ -1,5 +1,6 @@ import 'dart:math'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'combine.g.dart'; diff --git a/website/docs/from_provider/motivation/same_type/same_type.dart b/website/docs/from_provider/motivation/same_type/same_type.dart index a46db40cf..1094a6950 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.dart @@ -1,4 +1,5 @@ import 'package:collection/collection.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../helpers/item.dart'; diff --git a/website/docs/introduction/why_riverpod/codegen.dart b/website/docs/introduction/why_riverpod/codegen.dart index bd784d449..5205e623c 100644 --- a/website/docs/introduction/why_riverpod/codegen.dart +++ b/website/docs/introduction/why_riverpod/codegen.dart @@ -1,6 +1,7 @@ // ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types import 'package:dio/dio.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/providers/future_provider/config_provider/codegen.dart b/website/docs/providers/future_provider/config_provider/codegen.dart index e862b79f8..f8520a4ec 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.dart @@ -3,6 +3,7 @@ import 'dart:convert'; import 'package:flutter/services.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/providers/provider/completed_todos/completed_todos.dart b/website/docs/providers/provider/completed_todos/completed_todos.dart index 720a034ba..bc04a41b9 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.dart @@ -1,3 +1,4 @@ +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../todo/todo.dart'; diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart index 6ac7b13c4..d5247516f 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart @@ -2,6 +2,7 @@ import 'dart:convert'; import 'dart:io'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/static/snippets/create.dart b/website/static/snippets/create.dart index 236716169..418e7430e 100644 --- a/website/static/snippets/create.dart +++ b/website/static/snippets/create.dart @@ -2,6 +2,7 @@ import 'dart:convert'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; From ec753f99d5025dbaa9c622c4402fc12d10675829 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Tue, 19 Nov 2024 00:32:09 +0100 Subject: [PATCH 369/387] Lints --- packages/flutter_riverpod/lib/src/builders.dart | 2 ++ .../test/integration/generated/golden/lib/sync.dart | 1 - .../convert_functional_provider_to_class_based.dart | 1 - .../test/lints/avoid_build_context_in_providers.dart | 1 - website/docs/advanced/select/select_async/codegen.dart | 1 - .../docs/case_studies/cancel/detail_screen_cancel/codegen.dart | 1 - .../case_studies/cancel/detail_screen_debounce/codegen.dart | 1 - .../case_studies/cancel/provider_with_extension/codegen.dart | 1 - .../case_studies/pull_to_refresh/fetch_activity/codegen.dart | 1 - website/docs/concepts/about_codegen/main.dart | 1 - .../concepts/about_codegen/provider_type/async_fn_future.dart | 1 - .../concepts/about_codegen/provider_type/async_fn_stream.dart | 1 - .../docs/concepts/about_codegen/provider_type/auto_dispose.dart | 1 - website/docs/concepts/about_codegen/provider_type/family.dart | 1 - .../docs/concepts/about_codegen/provider_type/family_fn.dart | 1 - website/docs/concepts/about_codegen/provider_type/sync_fn.dart | 1 - .../combining_provider_states/city_provider/codegen.dart | 1 - .../combining_provider_states/read_in_provider/codegen.dart | 1 - .../select_async_provider/codegen.dart | 1 - .../combining_provider_states/weather_provider/codegen.dart | 1 - .../whole_object_provider/codegen.dart | 1 - website/docs/concepts/lifecycle_on_dispose/codegen.dart | 1 - .../docs/concepts/providers/creating_a_provider/codegen.dart | 1 - .../concepts/providers/declaring_many_providers/codegen.dart | 1 - website/docs/concepts/reading/listen/codegen.dart | 1 - website/docs/concepts/reading/provider/codegen.dart | 1 - website/docs/concepts/reading/watch/codegen.dart | 1 - .../docs/essentials/auto_dispose/cache_for_usage/codegen.dart | 1 - website/docs/essentials/auto_dispose/codegen_keep_alive.dart | 1 - website/docs/essentials/auto_dispose/keep_alive/codegen.dart | 1 - .../essentials/auto_dispose/on_dispose_example/codegen.dart | 1 - .../essentials/combining_requests/functional_ref/codegen.dart | 1 - .../essentials/combining_requests/listen_example/codegen.dart | 1 - .../essentials/combining_requests/notifier_ref/codegen.dart | 1 - .../essentials/combining_requests/watch_placement/codegen.dart | 1 - website/docs/essentials/first_request/codegen/provider.dart | 1 - website/docs/essentials/passing_args/family/codegen.dart | 1 - .../docs/essentials/passing_args/no_arg_provider/codegen.dart | 1 - .../essentials/side_effects/codegen/todo_list_provider.dart | 1 - website/docs/essentials/testing/provider_to_mock/codegen.dart | 1 - .../docs/essentials/websockets_sync/pipe_change_notifier.dart | 1 - .../essentials/websockets_sync/sync_definition/codegen.dart | 1 - website/docs/from_provider/family/family.dart | 1 - .../from_provider/motivation/async_values/async_values.dart | 1 - .../from_provider/motivation/auto_dispose/auto_dispose.dart | 1 - website/docs/from_provider/motivation/combine/combine.dart | 1 - website/docs/from_provider/motivation/same_type/same_type.dart | 1 - website/docs/introduction/why_riverpod/codegen.dart | 1 - .../docs/providers/future_provider/config_provider/codegen.dart | 1 - .../providers/provider/completed_todos/completed_todos.dart | 1 - .../stream_provider/live_stream_chat_provider/codegen.dart | 1 - website/static/snippets/create.dart | 1 - 52 files changed, 2 insertions(+), 51 deletions(-) diff --git a/packages/flutter_riverpod/lib/src/builders.dart b/packages/flutter_riverpod/lib/src/builders.dart index 09567226e..42e60ae7c 100644 --- a/packages/flutter_riverpod/lib/src/builders.dart +++ b/packages/flutter_riverpod/lib/src/builders.dart @@ -8,6 +8,8 @@ // You can then use it in your terminal by executing: // generate_providers +// ignore_for_file: invalid_use_of_internal_member + import 'package:flutter/foundation.dart'; import 'package:meta/meta.dart'; diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart index 66f008712..228a0eff2 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart @@ -1,4 +1,3 @@ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'sync.g.dart'; diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart index 894b5db24..f7f660062 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart @@ -1,4 +1,3 @@ -import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'convert_functional_provider_to_class_based.g.dart'; diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart index faa14343c..e3ca4231b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart @@ -1,7 +1,6 @@ // ignore_for_file: unused_element import 'package:flutter/widgets.dart'; -import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'avoid_build_context_in_providers.g.dart'; diff --git a/website/docs/advanced/select/select_async/codegen.dart b/website/docs/advanced/select/select_async/codegen.dart index 94b911bca..9ddf7256b 100644 --- a/website/docs/advanced/select/select_async/codegen.dart +++ b/website/docs/advanced/select/select_async/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors, body_might_complete_normally_nullable -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart index 0fe63d984..8094b9996 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart @@ -1,7 +1,6 @@ import 'dart:convert'; import 'package:http/http.dart' as http; -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../detail_screen/codegen.dart'; diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart index 54ec304da..732f8e134 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart @@ -1,6 +1,5 @@ import 'dart:convert'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.dart index 85db5313b..e3663c7a0 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.dart @@ -1,6 +1,5 @@ import 'dart:convert'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../detail_screen/codegen.dart'; diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart index 54cbd50da..16ac99207 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart @@ -1,6 +1,5 @@ import 'dart:convert'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/concepts/about_codegen/main.dart b/website/docs/concepts/about_codegen/main.dart index b0a1a4347..6dbbf14aa 100644 --- a/website/docs/concepts/about_codegen/main.dart +++ b/website/docs/concepts/about_codegen/main.dart @@ -1,6 +1,5 @@ // ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, avoid_unused_constructor_parameters -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart index 27f448f98..7ab60af7c 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'async_fn_future.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart index a7080cdc9..43b3a877f 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'async_fn_stream.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart index ecc7afa9e..3351a2da9 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'auto_dispose.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/family.dart b/website/docs/concepts/about_codegen/provider_type/family.dart index 22db5c5f8..d4a88c306 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'family.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.dart index e7e941e5f..6ac513340 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'family_fn.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.dart index 0099d43b4..73e82b7e2 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'sync_fn.g.dart'; diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.dart index 39edaa161..092367038 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart index 556d228c0..c76e47a97 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart index 1d76926cc..0bdb6db69 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart @@ -1,5 +1,4 @@ import 'package:dio/dio.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'models.dart'; diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart index 0d04d544e..a66b91521 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart index e52b9f54b..cb3a1ec73 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart @@ -1,5 +1,4 @@ import 'package:dio/dio.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'models.dart'; diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.dart index ab64f257e..35f832a69 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.dart @@ -2,7 +2,6 @@ import 'dart:async'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.dart b/website/docs/concepts/providers/creating_a_provider/codegen.dart index 163f5b4b5..15efd2d7a 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.dart index 17b1ccab8..276cab4dd 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/reading/listen/codegen.dart b/website/docs/concepts/reading/listen/codegen.dart index ac2cd9cae..b4531515a 100644 --- a/website/docs/concepts/reading/listen/codegen.dart +++ b/website/docs/concepts/reading/listen/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../counter/codegen.dart'; diff --git a/website/docs/concepts/reading/provider/codegen.dart b/website/docs/concepts/reading/provider/codegen.dart index 46e832fe8..954941a9b 100644 --- a/website/docs/concepts/reading/provider/codegen.dart +++ b/website/docs/concepts/reading/provider/codegen.dart @@ -1,5 +1,4 @@ // ignore_for_file: avoid_positional_boolean_parameters -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/reading/watch/codegen.dart b/website/docs/concepts/reading/watch/codegen.dart index ebbaa8d7c..947af2a51 100644 --- a/website/docs/concepts/reading/watch/codegen.dart +++ b/website/docs/concepts/reading/watch/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart index 69dad3871..a19f6a897 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: unused_local_variable -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.dart index 48eba50c6..74af13186 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen_keep_alive.g.dart'; diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.dart index 8d2afa235..a3f17cc7c 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: unused_local_variable -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart index d783c47fd..a7eafb658 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart @@ -2,7 +2,6 @@ import 'dart:async'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.dart index 8f0ea7b7c..e776d8c31 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: unused_local_variable -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.dart b/website/docs/essentials/combining_requests/listen_example/codegen.dart index dc8a14a77..8de5958a6 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: unused_local_variable, avoid_print -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.dart index 35609efa1..c184574c3 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: unused_local_variable -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.dart index e2ae6e347..d5a9cd653 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.dart @@ -1,7 +1,6 @@ // ignore_for_file: unused_local_variable import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/first_request/codegen/provider.dart b/website/docs/essentials/first_request/codegen/provider.dart index afaff3513..9a68b34be 100644 --- a/website/docs/essentials/first_request/codegen/provider.dart +++ b/website/docs/essentials/first_request/codegen/provider.dart @@ -1,7 +1,6 @@ /* SNIPPET START */ import 'dart:convert'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'activity.dart'; diff --git a/website/docs/essentials/passing_args/family/codegen.dart b/website/docs/essentials/passing_args/family/codegen.dart index 5c8a0117e..ab4743a20 100644 --- a/website/docs/essentials/passing_args/family/codegen.dart +++ b/website/docs/essentials/passing_args/family/codegen.dart @@ -1,7 +1,6 @@ // ignore_for_file: avoid_print import 'dart:convert'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../first_request/codegen/activity.dart'; diff --git a/website/docs/essentials/passing_args/no_arg_provider/codegen.dart b/website/docs/essentials/passing_args/no_arg_provider/codegen.dart index eee4a724c..da1c34adb 100644 --- a/website/docs/essentials/passing_args/no_arg_provider/codegen.dart +++ b/website/docs/essentials/passing_args/no_arg_provider/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: avoid_print -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../first_request/codegen/activity.dart'; diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.dart index e80b9d4a0..f0a84c83a 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:freezed_annotation/freezed_annotation.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.dart b/website/docs/essentials/testing/provider_to_mock/codegen.dart index 078148729..073779b2d 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.dart index 03d665216..0cc75bea6 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.dart @@ -1,7 +1,6 @@ // ignore_for_file: omit_local_variable_types import 'package:flutter/widgets.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'pipe_change_notifier.g.dart'; diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.dart index eeaba83b6..cdddcb32d 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/from_provider/family/family.dart b/website/docs/from_provider/family/family.dart index 88012fd24..61cf268fc 100644 --- a/website/docs/from_provider/family/family.dart +++ b/website/docs/from_provider/family/family.dart @@ -1,6 +1,5 @@ import 'dart:math'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'family.g.dart'; diff --git a/website/docs/from_provider/motivation/async_values/async_values.dart b/website/docs/from_provider/motivation/async_values/async_values.dart index 96f694e2a..0518dc0a7 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.dart @@ -1,6 +1,5 @@ import 'package:collection/collection.dart'; import 'package:dio/dio.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../helpers/item.dart'; diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart index fcb26dd6c..052686f61 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart @@ -1,6 +1,5 @@ import 'dart:math'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'auto_dispose.g.dart'; diff --git a/website/docs/from_provider/motivation/combine/combine.dart b/website/docs/from_provider/motivation/combine/combine.dart index f26e5d285..521d231b7 100644 --- a/website/docs/from_provider/motivation/combine/combine.dart +++ b/website/docs/from_provider/motivation/combine/combine.dart @@ -1,6 +1,5 @@ import 'dart:math'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'combine.g.dart'; diff --git a/website/docs/from_provider/motivation/same_type/same_type.dart b/website/docs/from_provider/motivation/same_type/same_type.dart index 1094a6950..a46db40cf 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.dart @@ -1,5 +1,4 @@ import 'package:collection/collection.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../helpers/item.dart'; diff --git a/website/docs/introduction/why_riverpod/codegen.dart b/website/docs/introduction/why_riverpod/codegen.dart index 5205e623c..bd784d449 100644 --- a/website/docs/introduction/why_riverpod/codegen.dart +++ b/website/docs/introduction/why_riverpod/codegen.dart @@ -1,7 +1,6 @@ // ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types import 'package:dio/dio.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/providers/future_provider/config_provider/codegen.dart b/website/docs/providers/future_provider/config_provider/codegen.dart index f8520a4ec..e862b79f8 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.dart @@ -3,7 +3,6 @@ import 'dart:convert'; import 'package:flutter/services.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/providers/provider/completed_todos/completed_todos.dart b/website/docs/providers/provider/completed_todos/completed_todos.dart index bc04a41b9..720a034ba 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../todo/todo.dart'; diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart index d5247516f..6ac7b13c4 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart @@ -2,7 +2,6 @@ import 'dart:convert'; import 'dart:io'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/static/snippets/create.dart b/website/static/snippets/create.dart index 418e7430e..236716169 100644 --- a/website/static/snippets/create.dart +++ b/website/static/snippets/create.dart @@ -2,7 +2,6 @@ import 'dart:convert'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; From 965ef1376e4c12dc965dd69076df0097528810f7 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Tue, 19 Nov 2024 00:57:57 +0100 Subject: [PATCH 370/387] fix test --- .../test/widget_ref_invocation_test.dart | 24 ++++++++++--------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart b/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart index 795d24e3c..1aab5b165 100644 --- a/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart +++ b/packages/riverpod_analyzer_utils_tests/test/widget_ref_invocation_test.dart @@ -6,19 +6,21 @@ import 'analyzer_test_utils.dart'; // ignore: invalid_use_of_internal_member extension on RiverpodAnalysisResult { List get widgetRefWatchInvocations { - return widgetRefInvocations.cast(); + return widgetRefInvocations.whereType().toList(); } List get widgetRefReadInvocations { - return widgetRefInvocations.cast(); + return widgetRefInvocations.whereType().toList(); } List get widgetRefListenInvocations { - return widgetRefInvocations.cast(); + return widgetRefInvocations.whereType().toList(); } List get widgetRefListenManualInvocations { - return widgetRefInvocations.cast(); + return widgetRefInvocations + .whereType() + .toList(); } } @@ -687,7 +689,7 @@ class MyWidget extends ConsumerWidget { ); expect(result.widgetRefWatchInvocations[0].function.toSource(), 'watch'); expect( - result.widgetRefWatchInvocations[0].listenable.provider?.node.toSource(), + result.widgetRefWatchInvocations[0].listenable.node.toSource(), 'family(ref.read(family2Provider(id: 0)))', ); expect( @@ -708,20 +710,20 @@ class MyWidget extends ConsumerWidget { // ref.watch(family2Provider(ref.watch(family(id: 0))); expect( - result.widgetRefWatchInvocations[1].node.toSource(), + result.widgetRefWatchInvocations[2].node.toSource(), 'ref.watch(family2Provider(ref.watch(family(id: 0))))', ); - expect(result.widgetRefWatchInvocations[1].function.toSource(), 'watch'); + expect(result.widgetRefWatchInvocations[2].function.toSource(), 'watch'); expect( - result.widgetRefWatchInvocations[1].listenable.provider?.node.toSource(), + result.widgetRefWatchInvocations[2].listenable.node.toSource(), 'family2Provider(ref.watch(family(id: 0)))', ); expect( - result.widgetRefWatchInvocations[1].listenable.provider?.node.toSource(), + result.widgetRefWatchInvocations[2].listenable.provider?.node.toSource(), 'family2Provider', ); expect( - result.widgetRefWatchInvocations[1].listenable.provider?.providerElement, + result.widgetRefWatchInvocations[2].listenable.provider?.providerElement, same( result.functionalProviderDeclarations .findByName('family2') @@ -729,7 +731,7 @@ class MyWidget extends ConsumerWidget { ), ); expect( - result.widgetRefWatchInvocations[1].listenable.familyArguments + result.widgetRefWatchInvocations[2].listenable.familyArguments ?.toSource(), '(ref.watch(family(id: 0)))', ); From ecb52b32be9c7295c97d96bf899e8ec390d2d04b Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Tue, 19 Nov 2024 01:13:38 +0100 Subject: [PATCH 371/387] goldens --- .../convert_functional_provider_to_class_based.diff | 4 ++-- .../avoid_build_context_in_providers_lint.md | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff index 729b5335f..0980c5b6b 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff +++ b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff @@ -1,6 +1,6 @@ Message: `Convert to class-based provider` Priority: 100 -Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:8`: +Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:7`: ``` /// Some comment @riverpod @@ -15,7 +15,7 @@ Diff for file `test/assists/convert_functional_provider_to_class_based/convert_f --- Message: `Convert to class-based provider` Priority: 100 -Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:12`: +Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:11`: ``` /// Some comment @riverpod diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md index 36544c25b..589c4dde1 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md @@ -1,7 +1,7 @@ code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:13:3 +test/lints/avoid_build_context_in_providers.dart:12:3 ```dart Ref ref, @@ -16,7 +16,7 @@ test/lints/avoid_build_context_in_providers.dart:13:3 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:15:3 +test/lints/avoid_build_context_in_providers.dart:14:3 ```dart BuildContext context1, { @@ -31,7 +31,7 @@ test/lints/avoid_build_context_in_providers.dart:15:3 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:23:5 +test/lints/avoid_build_context_in_providers.dart:22:5 ```dart int build( @@ -46,7 +46,7 @@ test/lints/avoid_build_context_in_providers.dart:23:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:25:5 +test/lints/avoid_build_context_in_providers.dart:24:5 ```dart BuildContext context1, { @@ -61,7 +61,7 @@ test/lints/avoid_build_context_in_providers.dart:25:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:31:5 +test/lints/avoid_build_context_in_providers.dart:30:5 ```dart void event( @@ -76,7 +76,7 @@ test/lints/avoid_build_context_in_providers.dart:31:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:33:5 +test/lints/avoid_build_context_in_providers.dart:32:5 ```dart BuildContext context3, { From 5ba44abe07a6fa32e83da927f5094ee85cf3ead0 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 8 Dec 2024 18:21:48 +0100 Subject: [PATCH 372/387] Add mutations (#3860) fixes #1660 --- .../lib/src/core/consumer.dart | 45 +- packages/riverpod/CHANGELOG.md | 6 + packages/riverpod/lib/riverpod.dart | 4 +- .../riverpod/lib/src/common/listenable.dart | 6 +- packages/riverpod/lib/src/core/element.dart | 48 +- .../riverpod/lib/src/core/foundation.dart | 32 +- .../lib/src/core/modifiers/future.dart | 15 +- .../lib/src/core/modifiers/select.dart | 53 +- .../lib/src/core/modifiers/select_async.dart | 19 +- .../src/core/provider/notifier_provider.dart | 2 +- .../lib/src/core/provider/provider.dart | 8 +- .../lib/src/core/provider_container.dart | 131 +- .../lib/src/core/provider_subscription.dart | 290 ++- .../src/core/proxy_provider_listenable.dart | 115 +- packages/riverpod/lib/src/framework.dart | 1 + packages/riverpod/lib/src/mutation.dart | 513 ++++++ .../legacy/state_notifier_provider.dart | 4 +- .../src/providers/legacy/state_provider.dart | 4 +- packages/riverpod/test/old/utils.dart | 106 +- .../test/src/core/provider_element_test.dart | 4 +- .../test/src/core/provider_observer_test.dart | 329 ++-- packages/riverpod/test/src/core/ref_test.dart | 42 +- packages/riverpod/test/src/utils.dart | 67 +- packages/riverpod_analyzer_utils/CHANGELOG.md | 1 + .../lib/src/errors.dart | 3 + .../lib/src/nodes.dart | 3 +- .../nodes/{riverpod.dart => annotation.dart} | 69 + .../lib/src/nodes/providers/notifier.dart | 125 +- .../lib/src/riverpod_types/generator.dart | 6 + .../test/mutation_test.dart | 98 + packages/riverpod_annotation/CHANGELOG.md | 3 + .../riverpod_annotation/analysis_options.yaml | 6 + .../lib/riverpod_annotation.dart | 7 + packages/riverpod_generator/CHANGELOG.md | 2 +- .../lib/src/riverpod_generator.dart | 32 +- .../lib/src/templates/element.dart | 95 + .../lib/src/templates/mutation.dart | 100 ++ .../lib/src/templates/provider.dart | 49 +- packages/riverpod_generator/pubspec.yaml | 1 + .../test/analysis_options.yaml | 5 + .../test/integration/mutation.dart | 149 ++ .../test/integration/mutation.g.dart | 1593 +++++++++++++++++ packages/riverpod_generator/test/mock.dart | 201 +++ .../test/mutation_test.dart | 513 ++++++ .../concepts/provider_observer_logger.dart | 5 +- .../provider_observer/provider_observer.dart | 24 +- 46 files changed, 4405 insertions(+), 529 deletions(-) create mode 100644 packages/riverpod/lib/src/mutation.dart rename packages/riverpod_analyzer_utils/lib/src/nodes/{riverpod.dart => annotation.dart} (68%) create mode 100644 packages/riverpod_analyzer_utils_tests/test/mutation_test.dart create mode 100644 packages/riverpod_annotation/analysis_options.yaml create mode 100644 packages/riverpod_generator/lib/src/templates/element.dart create mode 100644 packages/riverpod_generator/lib/src/templates/mutation.dart create mode 100644 packages/riverpod_generator/test/analysis_options.yaml create mode 100644 packages/riverpod_generator/test/integration/mutation.dart create mode 100644 packages/riverpod_generator/test/integration/mutation.g.dart create mode 100644 packages/riverpod_generator/test/mock.dart create mode 100644 packages/riverpod_generator/test/mutation_test.dart diff --git a/packages/flutter_riverpod/lib/src/core/consumer.dart b/packages/flutter_riverpod/lib/src/core/consumer.dart index 853bc2ea7..e8edf5f5d 100644 --- a/packages/flutter_riverpod/lib/src/core/consumer.dart +++ b/packages/flutter_riverpod/lib/src/core/consumer.dart @@ -367,7 +367,7 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { Map, ProviderSubscription>? _oldDependencies; final _listeners = >[]; - List<_ListenManual>? _manualListeners; + List>? _manualListeners; bool? _visible; Iterable get _allSubscriptions sync* { @@ -532,14 +532,20 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { // be used inside initState. final container = ProviderScope.containerOf(this, listen: false); - final sub = _ListenManual( - container.listen( - provider, - listener, - onError: onError, - fireImmediately: fireImmediately, - ) as ProviderSubscriptionWithOrigin, - this, + final innerSubscription = container.listen( + provider, + listener, + onError: onError, + fireImmediately: fireImmediately, + // ignore: invalid_use_of_internal_member, from riverpod + ) as ProviderSubscriptionWithOrigin; + + // ignore: invalid_use_of_internal_member, from riverpod + late final ProviderSubscriptionView sub; + sub = ProviderSubscriptionView( + innerSubscription: innerSubscription, + onClose: () => _manualListeners?.remove(sub), + read: innerSubscription.read, ); _applyVisibility(sub); listeners.add(sub); @@ -547,24 +553,3 @@ class ConsumerStatefulElement extends StatefulElement implements WidgetRef { return sub; } } - -final class _ListenManual - // ignore: invalid_use_of_internal_member - extends DelegatingProviderSubscription { - _ListenManual(this.innerSubscription, this._element); - - @override - final ProviderSubscriptionWithOrigin innerSubscription; - final ConsumerStatefulElement _element; - - @override - void close() { - if (!closed) { - _element._manualListeners?.remove(this); - } - super.close(); - } - - @override - T read() => innerSubscription.read(); -} diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 7c42ef9e4..d5fe7418c 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -1,5 +1,8 @@ ## Unreleased build +- **Breaking**: ProviderObserver methods have been updated to take a `ProviderObserverContext` parameter. + This replaces the old `provider`+`container` parameters, and contains extra + information. - **Breaking**: It is now a runtime exception to "scope" a provider that is not specifying `dependencies`. - **Breaking**: Removed all `Ref` subclasses (such `FutureProviderRef`). @@ -21,6 +24,9 @@ - **Breaking**: A provider is now considered "paused" if all of its listeners are also paused. So if a provider `A` is watched _only_ by a provider `B`, and `B` is currently unused, then `A` will be paused. +- Added methods to `ProviderObserver` for listening to "mutations". + Mutations are a new code-generation-only feature. See riverpod_generator's changelog + for more information. - 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, diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index f32aac134..439a701d0 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -36,12 +36,12 @@ export 'src/framework.dart' AsyncSubscription, FutureModifierElement, RunNotifierBuild, + ProviderListenableWithOrigin, $FunctionalProvider, ProviderStateSubscription, ProviderSubscriptionImpl, ProviderSubscriptionWithOrigin, - SelectorSubscription, - DelegatingProviderSubscription, + ProviderSubscriptionView, $ClassProvider, LegacyProviderMixin, ClassProviderElement, diff --git a/packages/riverpod/lib/src/common/listenable.dart b/packages/riverpod/lib/src/common/listenable.dart index 7284f7c37..7a615a3ba 100644 --- a/packages/riverpod/lib/src/common/listenable.dart +++ b/packages/riverpod/lib/src/common/listenable.dart @@ -51,6 +51,8 @@ class ProxyElementValueListenable extends _ValueListenable { } class _ValueListenable { + void Function()? onCancel; + int _count = 0; // The _listeners is intentionally set to a fixed-length _GrowableList instead // of const []. @@ -93,7 +95,6 @@ class _ValueListenable { /// [_notifyListeners]; and similarly, by overriding [_removeListener], checking /// if [hasListeners] is false after calling `super.removeListener()`, and if /// so, stopping that same work. - @protected bool get hasListeners { return _count > 0; } @@ -218,6 +219,9 @@ class _ValueListenable { break; } } + + final onCancel = this.onCancel; + if (!hasListeners && onCancel != null) onCancel(); } /// Discards any resources used by the object. After this is called, the diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index e8b408d91..58dd8045d 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -18,8 +18,9 @@ part of '../framework.dart'; /// {@endtemplate} sealed class Refreshable implements ProviderListenable {} -mixin _ProviderRefreshable implements Refreshable { - ProviderBase get provider; +mixin _ProviderRefreshable + implements Refreshable, ProviderListenableWithOrigin { + ProviderBase get provider; } /// A debug utility used by `flutter_riverpod`/`hooks_riverpod` to check @@ -137,7 +138,6 @@ abstract class ProviderElement implements Node { /// /// This is not meant for public consumption. Instead, public API should use /// [readSelf]. - @internal Result? get stateResult => _stateResult; /// Returns the currently exposed by a provider @@ -156,7 +156,6 @@ abstract class ProviderElement implements Node { /// /// This API is not meant for public consumption. Instead if a [Ref] needs /// to expose a way to update the state, the practice is to expose a getter/setter. - @internal void setStateResult(Result newState) { if (kDebugMode) _debugDidSetState = true; @@ -175,7 +174,6 @@ abstract class ProviderElement implements Node { /// /// This is not meant for public consumption. Instead, public API should use /// [readSelf]. - @internal StateT get requireState { const uninitializedError = ''' Tried to read the state of an uninitialized provider. @@ -204,7 +202,6 @@ This could mean a few things: /// Called when a provider is rebuilt. Used for providers to not notify their /// listeners if the exposed value did not change. - @internal bool updateShouldNotify(StateT previous, StateT next); /* /STATE */ @@ -225,7 +222,7 @@ This could mean a few things: } /// Called the first time a provider is obtained. - void _mount() { + void mount() { if (kDebugMode) { _debugCurrentCreateHash = provider.debugGetCreateSourceHash(); } @@ -298,11 +295,10 @@ This could mean a few things: /// /// This is not meant for public consumption. Public API should hide /// [flush] from users, such that they don't need to care about invoking this function. - @internal void flush() { if (!_didMount) { _didMount = true; - _mount(); + mount(); } _maybeRebuildDependencies(); @@ -420,6 +416,17 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ); } + MutationContext? _currentMutationContext() => + Zone.current[mutationZoneKey] as MutationContext?; + + ProviderObserverContext _currentObserverContext() { + return ProviderObserverContext( + origin, + container, + mutation: _currentMutationContext(), + ); + } + void _notifyListeners( Result newState, Result? previousStateResult, { @@ -475,7 +482,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu if (listener.closed) continue; Zone.current.runBinaryGuarded( - listener._notify, + listener._onOriginData, previousState, newState.state, ); @@ -486,7 +493,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu if (listener.closed) continue; Zone.current.runBinaryGuarded( - listener._notifyError, + listener._onOriginError, newState.error, newState.stackTrace, ); @@ -495,31 +502,28 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu for (final observer in container.observers) { if (isMount) { - runTernaryGuarded( + runBinaryGuarded( observer.didAddProvider, - origin, + _currentObserverContext(), newState.stateOrNull, - container, ); } else { - runQuaternaryGuarded( + runTernaryGuarded( observer.didUpdateProvider, - origin, + _currentObserverContext(), previousState, newState.stateOrNull, - container, ); } } for (final observer in container.observers) { if (newState is ResultError) { - runQuaternaryGuarded( + runTernaryGuarded( observer.providerDidFail, - origin, + _currentObserverContext(), newState.error, newState.stackTrace, - container, ); } } @@ -564,7 +568,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ); switch (sub) { - case ProviderSubscriptionImpl(): + case final ProviderSubscriptionImpl sub: sub._listenedElement.addDependentSubscription(sub); } @@ -715,7 +719,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu ref._onDisposeListeners?.forEach(runGuarded); for (final observer in container.observers) { - runBinaryGuarded(observer.didDisposeProvider, origin, container); + runUnaryGuarded(observer.didDisposeProvider, _currentObserverContext()); } ref._keepAliveLinks = null; diff --git a/packages/riverpod/lib/src/core/foundation.dart b/packages/riverpod/lib/src/core/foundation.dart index fde25aab8..89c7abd9c 100644 --- a/packages/riverpod/lib/src/core/foundation.dart +++ b/packages/riverpod/lib/src/core/foundation.dart @@ -176,6 +176,29 @@ String shortHash(Object? object) { return object.hashCode.toUnsigned(20).toRadixString(16).padLeft(5, '0'); } +@internal +mixin ProviderListenableWithOrigin on ProviderListenable { + @override + ProviderSubscriptionWithOrigin addListener( + Node source, + void Function(OutT? previous, OutT next) listener, { + required void Function(Object error, StackTrace stackTrace)? onError, + required void Function()? onDependencyMayHaveChanged, + required bool fireImmediately, + required bool weak, + }); + + @override + ProviderListenable select( + Selected Function(OutT value) selector, + ) { + return _ProviderSelector( + provider: this, + selector: selector, + ); + } +} + /// A base class for all providers, used to consume a provider. /// /// It is used by [ProviderContainer.listen] and `ref.watch` to listen to @@ -185,7 +208,7 @@ String shortHash(Object? object) { @immutable mixin ProviderListenable implements ProviderListenableOrFamily { /// Starts listening to this transformer - ProviderSubscriptionWithOrigin addListener( + ProviderSubscription addListener( Node source, void Function(StateT? previous, StateT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, @@ -261,10 +284,5 @@ mixin ProviderListenable implements ProviderListenableOrFamily { /// changed instead of whenever the age changes. ProviderListenable select( Selected Function(StateT value) selector, - ) { - return _ProviderSelector( - provider: this, - selector: selector, - ); - } + ); } diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 5a0d4bbb8..757518867 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -138,8 +138,10 @@ base mixin $FutureModifier on ProviderBase> { /// return await http.get('${configs.host}/products'); /// }); /// ``` - Refreshable> get future { - return ProviderElementProxy, Future>( + Refreshable> get future => _future; + + _ProviderRefreshable, AsyncValue> get _future { + return ProviderElementProxy, AsyncValue>( this, (element) { element as FutureModifierElement; @@ -181,10 +183,10 @@ base mixin $FutureModifier on ProviderBase> { ProviderListenable> selectAsync( Output Function(StateT data) selector, ) { - return _AsyncSelector( + return _AsyncSelector>( selector: selector, provider: this, - future: future, + future: _future, ); } } @@ -290,12 +292,11 @@ mixin FutureModifierElement on ProviderElement> { asyncTransition(value, seamless: seamless); for (final observer in container.observers) { - runQuaternaryGuarded( + runTernaryGuarded( observer.providerDidFail, - provider, + _currentObserverContext(), value.error, value.stackTrace, - container, ); } diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index 474eb13a8..b9bf77388 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -23,7 +23,10 @@ var _debugIsRunningSelector = false; /// An internal class for `ProviderBase.select`. @sealed -class _ProviderSelector with ProviderListenable { +class _ProviderSelector + with + ProviderListenable, + ProviderListenableWithOrigin { /// An internal class for `ProviderBase.select`. _ProviderSelector({ required this.provider, @@ -31,7 +34,7 @@ class _ProviderSelector with ProviderListenable { }); /// The provider that was selected - final ProviderListenable provider; + final ProviderListenableWithOrigin provider; /// The selector applied final OutputT Function(InputT) selector; @@ -78,7 +81,7 @@ class _ProviderSelector with ProviderListenable { } @override - SelectorSubscription addListener( + ProviderSubscriptionWithOrigin addListener( Node node, void Function(OutputT? previous, OutputT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, @@ -116,9 +119,12 @@ class _ProviderSelector with ProviderListenable { ); } - return SelectorSubscription( + return ProviderSubscriptionView( innerSubscription: sub, - () { + read: () { + // flushes the provider + sub.read(); + // Using ! because since `sub.read` flushes the inner subscription, // it is guaranteed that `lastSelectedValue` is not null. return switch (lastSelectedValue!) { @@ -133,40 +139,3 @@ class _ProviderSelector with ProviderListenable { ); } } - -@internal -final class SelectorSubscription - extends DelegatingProviderSubscription { - SelectorSubscription( - this._read, { - this.onClose, - required this.innerSubscription, - }); - - @override - final ProviderSubscriptionWithOrigin innerSubscription; - - final void Function()? onClose; - final OutT Function() _read; - - @override - void close() { - if (closed) return; - - onClose?.call(); - super.close(); - } - - @override - OutT read() { - if (closed) { - throw StateError( - 'called ProviderSubscription.read on a subscription that was closed', - ); - } - // flushes the provider - innerSubscription.read(); - - return _read(); - } -} diff --git a/packages/riverpod/lib/src/core/modifiers/select_async.dart b/packages/riverpod/lib/src/core/modifiers/select_async.dart index 30cff870e..ffb3bd42c 100644 --- a/packages/riverpod/lib/src/core/modifiers/select_async.dart +++ b/packages/riverpod/lib/src/core/modifiers/select_async.dart @@ -2,7 +2,10 @@ part of '../../framework.dart'; /// An internal class for `ProviderBase.selectAsync`. @sealed -class _AsyncSelector with ProviderListenable> { +class _AsyncSelector + with + ProviderListenable>, + ProviderListenableWithOrigin, OriginT> { /// An internal class for `ProviderBase.select`. _AsyncSelector({ required this.provider, @@ -11,10 +14,10 @@ class _AsyncSelector with ProviderListenable> { }); /// The provider that was selected - final ProviderListenable> provider; + final ProviderListenableWithOrigin, OriginT> provider; /// The future associated to the listened provider - final ProviderListenable> future; + final ProviderListenableWithOrigin, OriginT> future; /// The selector applied final OutputT Function(InputT) selector; @@ -32,7 +35,7 @@ class _AsyncSelector with ProviderListenable> { } @override - SelectorSubscription, Future> addListener( + ProviderSubscriptionWithOrigin, OriginT> addListener( Node node, void Function(Future? previous, Future next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, @@ -147,9 +150,13 @@ class _AsyncSelector with ProviderListenable> { listener(null, selectedFuture!); } - return SelectorSubscription( + return ProviderSubscriptionView, OriginT>( innerSubscription: sub, - () => selectedFuture!, + read: () { + // Flush + sub.read(); + return selectedFuture!; + }, onClose: () { final completer = selectedCompleter; if (completer != null && !completer.isCompleted) { diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index db3ef4566..c671fcdea 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -121,7 +121,7 @@ abstract base class $ClassProvider< // }); Refreshable get notifier { - return ProviderElementProxy( + return ProviderElementProxy( this, (element) => (element as ClassProviderElement) diff --git a/packages/riverpod/lib/src/core/provider/provider.dart b/packages/riverpod/lib/src/core/provider/provider.dart index 866e5bb19..2540fd376 100644 --- a/packages/riverpod/lib/src/core/provider/provider.dart +++ b/packages/riverpod/lib/src/core/provider/provider.dart @@ -17,13 +17,15 @@ typedef Create = CreatedT Function(Ref ref); /// A callback used to catches errors @internal -typedef OnError = void Function(Object, StackTrace); +typedef OnError = void Function(Object error, StackTrace stackTrace); /// A base class for _all_ providers. @immutable // Marked as "base" because linters/generators rely on fields on const provider instances. abstract base class ProviderBase extends ProviderOrFamily - with ProviderListenable + with + ProviderListenable, + ProviderListenableWithOrigin implements Refreshable, _ProviderOverride { /// A base class for _all_ providers. const ProviderBase({ @@ -81,7 +83,7 @@ abstract base class ProviderBase extends ProviderOrFamily source: source, listenedElement: element, weak: weak, - listener: (prev, next) => listener(prev as StateT?, next as StateT), + listener: listener, onError: onError, ); } diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 05be79843..4954a782e 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -778,7 +778,7 @@ class ProviderContainer implements Node { ); switch (sub) { - case ProviderSubscriptionImpl(): + case final ProviderSubscriptionImpl sub: sub._listenedElement.addDependentSubscription(sub); } @@ -804,16 +804,12 @@ class ProviderContainer implements Node { /// {@macro riverpod.refresh} StateT refresh(Refreshable refreshable) { - ProviderBase providerToRefresh; - - switch (refreshable) { - case ProviderBase(): - providerToRefresh = refreshable; - case _ProviderRefreshable(:final provider): - providerToRefresh = provider; - } - + final providerToRefresh = switch (refreshable) { + ProviderBase() => refreshable, + _ProviderRefreshable(:final provider) => provider + }; invalidate(providerToRefresh); + return read(refreshable); } @@ -977,6 +973,7 @@ class ProviderContainer implements Node { void dispose() => _dispose(updateChildren: true); /// Traverse the [ProviderElement]s associated with this [ProviderContainer]. + @internal Iterable getAllProviderElements() { return _pointerManager .listProviderPointers() @@ -990,6 +987,7 @@ class ProviderContainer implements Node { /// This is fairly expensive and should be avoided as much as possible. /// If you do not need for providers to be sorted, consider using [getAllProviderElements] /// instead, which returns an unsorted list and is significantly faster. + @internal Iterable getAllProviderElementsInOrder() sync* { final visitedNodes = HashSet(); final queue = DoubleLinkedQueue(); @@ -1064,6 +1062,44 @@ extension ProviderContainerTest on ProviderContainer { ProviderPointerManager get pointerManager => _pointerManager; } +/// Information about the pending mutation, when [ProviderObserver] emits +/// an event while a mutation is in progress. +class MutationContext { + @internal + MutationContext(this.invocation, this.notifier); + + /// Information about the method invoked by the mutation, and its arguments. + final Invocation invocation; + + /// The notifier that triggered the mutation. + final NotifierBase notifier; +} + +/// Information about the [ProviderObserver] event. +class ProviderObserverContext { + @internal + ProviderObserverContext( + this.provider, + this.container, { + this.mutation, + }); + + /// The provider that triggered the event. + final ProviderBase provider; + + /// The container that owns [provider]'s state. + final ProviderContainer container; + + /// The pending mutation while the observer was called. + /// + /// Pretty much all observer events may be triggered by a mutation under some + /// conditions. + /// For example, if a mutation refreshes another provider, then + /// [ProviderObserver.didDisposeProvider] will contain the mutation that + /// disposed the provider. + final MutationContext? mutation; +} + /// An object that listens to the changes of a [ProviderContainer]. /// /// This can be used for logging or making devtools. @@ -1077,35 +1113,92 @@ abstract class ProviderObserver { /// /// [value] will be `null` if the provider threw during initialization. void didAddProvider( - ProviderBase provider, + ProviderObserverContext context, Object? value, - ProviderContainer container, ) {} /// A provider emitted an error, be it by throwing during initialization /// or by having a [Future]/[Stream] emit an error void providerDidFail( - ProviderBase provider, + ProviderObserverContext context, Object error, StackTrace stackTrace, - ProviderContainer container, ) {} /// Called by providers when they emit a notification. /// /// - [newValue] will be `null` if the provider threw during initialization. /// - [previousValue] will be `null` if the previous build threw during initialization. + /// + /// If the change is caused by a "mutation", [mutation] will be the invocation + /// that caused the state change. + /// This includes when a mutation manually calls `state=`: + /// + /// ```dart + /// @riverpod + /// class Example extends _$Example { + /// @override + /// int count() => 0; + /// + /// @mutation + /// int increment() { + /// state++; // This will trigger `didUpdateProvider` and "mutation" will be `#increment` + /// + /// // ... + /// } + /// } + /// ``` void didUpdateProvider( - ProviderBase provider, + ProviderObserverContext context, Object? previousValue, Object? newValue, - ProviderContainer container, ) {} /// A provider was disposed - void didDisposeProvider( - ProviderBase provider, - ProviderContainer container, + void didDisposeProvider(ProviderObserverContext context) {} + + /// A mutation was reset. + /// + /// This includes both manual calls to [MutationBase.reset] and automatic + /// resets. + /// + /// {@macro auto_reset} + void mutationReset(ProviderObserverContext context) {} + + /// A mutation was started. + /// + /// {@template obs_mutation_arg} + /// [mutation] is strictly the same as [ProviderObserverContext.mutation]. + /// It is provided as a convenience, as this life-cycle is guaranteed + /// to have a non-null [ProviderObserverContext.mutation]. + /// {@endtemplate} + void mutationStart( + ProviderObserverContext context, + MutationContext mutation, + ) {} + + /// A mutation failed. + /// + /// [error] is the error thrown by the mutation. + /// [stackTrace] is the stack trace of the error. + /// + /// {@macro obs_mutation_arg} + void mutationError( + ProviderObserverContext context, + MutationContext mutation, + Object error, + StackTrace stackTrace, + ) {} + + /// A mutation succeeded. + /// + /// [result] is the value returned by the mutation. + /// + /// {@macro obs_mutation_arg} + void mutationSuccess( + ProviderObserverContext context, + MutationContext mutation, + Object? result, ) {} } diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index c1440738c..421a72790 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -31,21 +31,36 @@ sealed class ProviderSubscription { void close(); } +@internal @optionalTypeArgs sealed class ProviderSubscriptionWithOrigin - extends ProviderSubscription { + extends ProviderSubscription implements Pausable { ProviderBase get origin; ProviderElement get _listenedElement; - void _notify(StateT? prev, StateT next); + void _onOriginData(StateT? prev, StateT next); + void _onOriginError(Object error, StackTrace stackTrace); + + OutT _callRead(); + + @override + OutT read() { + if (closed) { + throw StateError( + 'called ProviderSubscription.read on a subscription that was closed', + ); + } + _listenedElement.mayNeedDispose(); + _listenedElement.flush(); - void _notifyError(Object error, StackTrace stackTrace); + return _callRead(); + } } @internal @optionalTypeArgs -abstract base class ProviderSubscriptionImpl - extends ProviderSubscriptionWithOrigin with _OnPauseMixin { +abstract base class ProviderSubscriptionImpl + extends ProviderSubscriptionWithOrigin with _OnPauseMixin { @override bool get isPaused => _isPaused; @@ -54,6 +69,59 @@ abstract base class ProviderSubscriptionImpl bool get closed => _closed; var _closed = false; + /// Whether an event was sent while this subscription was paused. + /// + /// This enables re-rending the last missing event when the subscription is resumed. + ({ + (OutT?, OutT)? data, + (Object, StackTrace)? error, + })? _missedCalled; + void Function(OutT? prev, OutT next) get _listener; + OnError get _errorListener; + + @mustCallSuper + @override + void onCancel() { + _listenedElement.onSubscriptionPause(this); + } + + @mustCallSuper + @override + void onResume() { + _listenedElement.onSubscriptionResume(this); + if (_missedCalled?.data case final event?) { + final prev = event.$1; + final next = event.$2; + + _missedCalled = null; + _notifyData(prev, next); + } else if (_missedCalled?.error case final event?) { + final error = event.$1; + final stackTrace = event.$2; + + _missedCalled = null; + _notifyError(error, stackTrace); + } + } + + void _notifyData(OutT? prev, OutT next) { + if (isPaused) { + _missedCalled = (data: (prev, next), error: null); + return; + } + + _listener(prev, next); + } + + void _notifyError(Object error, StackTrace stackTrace) { + if (isPaused) { + _missedCalled = (data: null, error: (error, stackTrace)); + return; + } + + _errorListener(error, stackTrace); + } + /// Stops listening to the provider. /// /// It is safe to call this method multiple times. @@ -67,42 +135,80 @@ abstract base class ProviderSubscriptionImpl } } -mixin _OnPauseMixin { +abstract class Pausable { + bool get isPaused; + + void pause(); + void resume(); + + void onCancel(); + void onResume(); +} + +mixin _OnPauseMixin on Pausable { bool get _isPaused => _pauseCount > 0; var _pauseCount = 0; + @override @mustCallSuper void pause() { - if (_pauseCount == 0) { - onCancel(); - } + final shouldCallCancel = _pauseCount == 0; _pauseCount++; + + if (shouldCallCancel) onCancel(); } + @override @mustCallSuper void resume() { - if (_pauseCount == 1) { - onResume(); - } + final shouldCallResume = _pauseCount == 1; _pauseCount = math.max(_pauseCount - 1, 0); + + if (shouldCallResume) onResume(); } + @override void onResume(); + @override void onCancel(); } @internal -abstract base class DelegatingProviderSubscription - extends ProviderSubscriptionImpl { +base class ProviderSubscriptionView + extends ProviderSubscriptionImpl { + ProviderSubscriptionView({ + required this.innerSubscription, + required OutT Function() read, + void Function()? onClose, + }) : _read = read, + _onClose = onClose; + + final ProviderSubscriptionWithOrigin innerSubscription; + final OutT Function() _read; + final void Function()? _onClose; + @override - ProviderBase get origin => innerSubscription.origin; + OnError get _errorListener { + return switch (innerSubscription) { + final ProviderSubscriptionImpl sub => + sub._errorListener, + }; + } @override - ProviderElement get _listenedElement => - innerSubscription._listenedElement; + void Function(OutT? prev, OutT next) get _listener { + return switch (innerSubscription) { + final ProviderSubscriptionImpl sub => sub._listener, + }; + } + + @override + ProviderBase get origin => innerSubscription.origin; - ProviderSubscriptionWithOrigin get innerSubscription; + @override + ProviderElement get _listenedElement => + innerSubscription._listenedElement; @override bool get weak => innerSubscription.weak; @@ -111,27 +217,29 @@ abstract base class DelegatingProviderSubscription Node get source => innerSubscription.source; @override - void _notify(StateT? prev, StateT next) { - innerSubscription._notify(prev, next); + void _onOriginData(OriginT? prev, OriginT next) { + innerSubscription._onOriginData(prev, next); } @override - void _notifyError(Object error, StackTrace stackTrace) { - innerSubscription._notifyError(error, stackTrace); + void _onOriginError(Object error, StackTrace stackTrace) { + innerSubscription._onOriginError(error, stackTrace); } @override void onCancel() { + super.onCancel(); switch (innerSubscription) { - case final ProviderSubscriptionImpl sub: + case final ProviderSubscriptionImpl sub: sub.onCancel(); } } @override void onResume() { + super.onResume(); switch (innerSubscription) { - case final ProviderSubscriptionImpl sub: + case final ProviderSubscriptionImpl sub: sub.onResume(); } } @@ -152,22 +260,86 @@ abstract base class DelegatingProviderSubscription void close() { if (_closed) return; + _onClose?.call(); innerSubscription.close(); super.close(); } + + @override + OutT _callRead() => _read(); +} + +final class DelegatingProviderSubscription + extends ProviderSubscriptionImpl { + DelegatingProviderSubscription({ + required this.origin, + required this.source, + required this.weak, + required OnError? errorListener, + required ProviderElement listenedElement, + required void Function(OutT? prev, OutT next) listener, + void Function(OriginT? prev, OriginT next)? onOriginData, + void Function(Object error, StackTrace stackTrace)? onOriginError, + required OutT Function() read, + required void Function()? onClose, + }) : _errorListener = errorListener ?? Zone.current.handleUncaughtError, + _listenedElement = listenedElement, + _listener = listener, + _onOriginDataCb = onOriginData, + _onOriginErrorCb = onOriginError, + _readCb = read, + _onCloseCb = onClose; + + @override + final ProviderBase origin; + @override + final Node source; + @override + final bool weak; + @override + final OnError _errorListener; + @override + final ProviderElement _listenedElement; + @override + final void Function(OutT? prev, OutT next) _listener; + final void Function(OriginT? prev, OriginT next)? _onOriginDataCb; + final void Function(Object error, StackTrace stackTrace)? _onOriginErrorCb; + final OutT Function() _readCb; + final void Function()? _onCloseCb; + + @override + void _onOriginData(OriginT? prev, OriginT next) => + _onOriginDataCb?.call(prev, next); + + @override + void _onOriginError(Object error, StackTrace stackTrace) => + _onOriginErrorCb?.call(error, stackTrace); + + @override + OutT _callRead() => _readCb(); + + @override + void close() { + if (_closed) return; + + _onCloseCb?.call(); + super.close(); + } } /// When a provider listens to another provider using `listen` @internal final class ProviderStateSubscription - extends ProviderSubscriptionImpl with _OnPauseMixin { + extends ProviderSubscriptionImpl { ProviderStateSubscription({ required this.source, required this.weak, required ProviderElement listenedElement, - required this.listener, - required this.onError, - }) : _listenedElement = listenedElement; + required void Function(StateT? prev, StateT next) listener, + required OnError onError, + }) : _listenedElement = listenedElement, + _listener = listener, + _errorListener = onError; @override ProviderBase get origin => _listenedElement.origin; @@ -180,68 +352,18 @@ final class ProviderStateSubscription final bool weak; // Why can't this be typed correctly? - final void Function(Object? prev, Object? state) listener; - final OnError onError; - - /// Whether an event was sent while this subscription was paused. - /// - /// This enables re-rending the last missing event when the subscription is resumed. - ({ - (StateT?, StateT)? data, - (Object, StackTrace)? error, - })? _missedCalled; + final void Function(StateT? prev, StateT next) _listener; + final OnError _errorListener; @override - StateT read() { - if (_closed) { - throw StateError( - 'called ProviderSubscription.read on a subscription that was closed', - ); - } - _listenedElement.mayNeedDispose(); - return _listenedElement.readSelf(); - } + StateT _callRead() => _listenedElement.readSelf(); @override - void onCancel() => _listenedElement.onSubscriptionPause(this); + void _onOriginData(StateT? prev, StateT next) => _notifyData(prev, next); @override - void onResume() { - _listenedElement.onSubscriptionResume(this); - if (_missedCalled?.data case final event?) { - final prev = event.$1; - final next = event.$2; - - _missedCalled = null; - listener(prev, next); - } else if (_missedCalled?.error case final event?) { - final error = event.$1; - final stackTrace = event.$2; - - _missedCalled = null; - onError(error, stackTrace); - } - } - - @override - void _notify(StateT? prev, StateT next) { - if (_isPaused) { - _missedCalled = (data: (prev, next), error: null); - return; - } - - listener(prev, next); - } - - @override - void _notifyError(Object error, StackTrace stackTrace) { - if (_isPaused) { - _missedCalled = (data: null, error: (error, stackTrace)); - return; - } - - onError(error, stackTrace); - } + void _onOriginError(Object error, StackTrace stackTrace) => + _notifyError(error, stackTrace); } /// Deals with the internals of synchronously calling the listeners diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index ba7f741f9..94e9651b8 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -1,35 +1,56 @@ part of '../framework.dart'; -final class _ProxySubscription - extends DelegatingProviderSubscription { - _ProxySubscription( - this.innerSubscription, - this._removeListeners, - this._read, - ); +class LazyProxyListenable + with ProviderListenable, ProviderListenableWithOrigin { + LazyProxyListenable(this.provider, this._lense); - @override - final ProviderSubscriptionWithOrigin innerSubscription; - - final void Function() _removeListeners; - final OutT Function() _read; + final ProviderBase provider; + final ProxyElementValueListenable Function( + ProviderElement element, + ) _lense; @override - OutT read() { - if (closed) { - throw StateError( - 'called ProviderSubscription.read on a subscription that was closed', - ); + ProviderSubscriptionWithOrigin addListener( + Node source, + void Function(OutT? previous, OutT next) listener, { + required void Function(Object error, StackTrace stackTrace)? onError, + required void Function()? onDependencyMayHaveChanged, + required bool fireImmediately, + required bool weak, + }) { + final element = source.readProviderElement(provider); + + final listenable = _lense(element); + if (fireImmediately) { + switch (listenable.result) { + case null: + break; + case final ResultData data: + runBinaryGuarded(listener, null, data.state); + case final ResultError error: + if (onError != null) { + runBinaryGuarded(onError, error.error, error.stackTrace); + } + } } - return _read(); - } - @override - void close() { - if (closed) return; + late final ProviderSubscriptionImpl sub; + final removeListener = listenable.addListener( + (a, b) => sub._notifyData(a, b), + onError: onError, + onDependencyMayHaveChanged: onDependencyMayHaveChanged, + ); - _removeListeners(); - super.close(); + return sub = DelegatingProviderSubscription( + listenedElement: element, + source: source, + weak: weak, + origin: provider, + onClose: removeListener, + errorListener: onError, + listener: listener, + read: () => listenable.value, + ); } } @@ -49,8 +70,11 @@ final class _ProxySubscription /// /// This API is not meant for public consumption. @internal -class ProviderElementProxy - with ProviderListenable, _ProviderRefreshable { +class ProviderElementProxy + with + ProviderListenable, + ProviderListenableWithOrigin, + _ProviderRefreshable { /// An internal utility for reading alternate values of a provider. /// /// For example, this is used by [FutureProvider] to differentiate: @@ -66,16 +90,22 @@ class ProviderElementProxy /// ``` /// /// This API is not meant for public consumption. - const ProviderElementProxy(this.provider, this._lense); + const ProviderElementProxy( + this.provider, + this._lense, { + this.flushElement = false, + }); + + final bool flushElement; @override - final ProviderBase provider; + final ProviderBase provider; final ProxyElementValueListenable Function( - ProviderElement element, + ProviderElement element, ) _lense; @override - ProviderSubscriptionWithOrigin addListener( + ProviderSubscriptionWithOrigin addListener( Node source, void Function(OutT? previous, OutT next) listener, { required void Function(Object error, StackTrace stackTrace)? onError, @@ -120,24 +150,23 @@ class ProviderElementProxy onDependencyMayHaveChanged: onDependencyMayHaveChanged, ); - return _ProxySubscription( - innerSub, - removeListener, - () => _read(source), - ); - } + return ProviderSubscriptionView( + innerSubscription: innerSub, + onClose: removeListener, + read: () { + final element = source.readProviderElement(provider); + element.flush(); + element.mayNeedDispose(); - OutT _read(Node node) { - final element = node.readProviderElement(provider); - element.flush(); - element.mayNeedDispose(); - - return _lense(element).value; + return _lense(element).value; + }, + ); } @override bool operator ==(Object other) => - other is ProviderElementProxy && other.provider == provider; + other is ProviderElementProxy && + other.provider == provider; @override int get hashCode => provider.hashCode; diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index 1e1f7d950..7a935e78b 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -10,6 +10,7 @@ import 'package:test/test.dart' as test; import 'common/env.dart'; import 'common/pragma.dart'; import 'internals.dart'; +import 'mutation.dart'; part 'core/modifiers/select_async.dart'; part 'core/provider/provider.dart'; diff --git a/packages/riverpod/lib/src/mutation.dart b/packages/riverpod/lib/src/mutation.dart new file mode 100644 index 000000000..2e922953c --- /dev/null +++ b/packages/riverpod/lib/src/mutation.dart @@ -0,0 +1,513 @@ +import 'dart:async'; + +import 'package:meta/meta.dart'; +import 'package:meta/meta_meta.dart'; + +import 'internals.dart'; + +// Mutation code. This should be in riverpod_annotation, but has to be here +// for the sake of ProviderObserver. + +@internal +const mutationZoneKey = #_mutation; + +/// {@template mutation} +/// Declares a method of a notifier as a "mutation". +/// +/// ## What is a mutation? +/// +/// A mutation is a method that modifies the state of a [Notifier]. +/// For example, an `addTodo` mutation would add a new todo to a todo-list. +/// +/// The primary purpose of mutations is to enable Flutter's Widgets to listen +/// to the progress of an operation. +/// Specifically, by using mutations, a widget may: +/// - Disabling a button while the operation is in progress +/// - Show a button to start an operation +/// - Show a loading indicator when the mutation is in progress. +/// - Show a snackbar when the operation completes/fails +/// +/// Mutations also make it easier to separate the logic for "starting an operation" +/// from the logic for "handling the result of an operation". +/// Two widgets can rely on the same mutation, and the progress of the operation +/// will be shared between them. +/// This way, one widget can be responsible for showing a button, while another +/// widget can be responsible for showing a loading indicator. +/// +/// Although there are ways to handle such cases without mutations, using +/// mutations makes it simpler to deal with. +/// For example, there is no need to catch possible exceptions to allow the UI +/// to show an error message. By using mutations, Riverpod will automatically +/// take care of that. +/// +/// ## How to define a mutation +/// +/// To define a mutation, we must first define a [Notifier]. +/// For that, we need to define a class annotation by `@riverpod`, and that defines +/// a `build` method: +/// +/// ```dart +/// @riverpod +/// class TodoListNotifier extends $ExampleNotifier { +/// @override +/// Future> build() { +/// /* fetch the list of todos from your server here */ +/// } +/// } +/// ``` +/// +/// Once we have defined a notifier, we can add a mutation to it. +/// To do so, we define a method in the notifier class and annotate it with [Mutation]: +/// +/// **Note**: +/// That method **must** return a [Future] that resolves with a value of the same +/// type as the notifier's state. +/// In our above example, the state of our notifier is `List`, so the mutation +/// must return a `Future>`. +/// +/// ```dart +/// @riverpod +/// class TodoListNotifier extends $ExampleNotifier { +/// /* ... */ +/// +/// @mutation +/// Future> addTodo(Todo todo) async { +/// /* to-do: Make an HTTP post request to notify the server about the added todo */ +/// +/// // Mutations are expected to return the new state for our notifier. +/// // Riverpod will then assign this value to `this.state` +/// return [...await future, todo]; +/// } +/// } +/// ``` +/// +/// ## How to use mutations +/// +/// Now that we've defined a mutation, we need a way to invoke it from our UI. +/// +/// The way this is typically done is by using `ref.watch`/`ref.listen` to obtain +/// an object that enables us to interact with the mutation: +/// +/// ```dart +/// class AddTodoButton extends ConsumerWidget { +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// // We use `ref.watch` to obtain the mutation object. +/// // For every `@mutation` defined in our notifier, a corresponding +/// // `myProvider.myMutation` will be available ; which can be as followed: +/// final addTodo = ref.watch(todoListProvider.addTodo); +/// } +/// } +/// ``` +/// +/// Once we have obtained the mutation object, we have two main ways to use it: +/// +/// ### 1. Start the operation inside a button press +/// +/// Mutation objects are "callable". This means that we can call them like a function. +/// When we call a mutation, it will start the operation. +/// Of course, we will have to pass the required arguments that are expected by our mutation. +/// +/// The following code shows a button that, when pressed, will start the `addTodo` mutation: +/// +/// ```dart +/// final addTodo = ref.watch(todoListProvider.addTodo); +/// +/// return ElevatedButton( +/// // Pressing the button will call `TodoListNotifier.addTodo` +/// onPressed: () => addTodo(Todo('Buy milk')), +/// ); +/// ``` +/// +/// ### 2. Listen to the progress of the operation +/// +/// Alternatively, we can use the mutation object to track the progress of the operation. +/// This is useful for many reasons, including: +/// - Disabling a button while the operation is in progress +/// - Showing a loading indicator while the operation is pending +/// - Showing a snackbar or the button in red/green when the operation fails/completes +/// +/// {@macro mutation_states} +/// +/// You can switch over the different types using pattern matching: +/// +/// ```dart +/// final addTodo = ref.watch(todoListProvider.addTodo); +/// +/// switch (addTodo.state) { +/// case IdleMutationState(): +/// print('The mutation is idle'); +/// case PendingMutationState(): +/// print('The mutation is in progress'); +/// case ErrorMutationState(:final error): +/// print('The mutation has failed with $error'); +/// case SuccessMutationState(:final value): +/// print('The mutation has succeeded, and the new state is $value'); +/// } +/// ``` +/// +/// ### Example: Showing a loading indicator while the mutation is in progress +/// +/// You can check for the [PendingMutationState] to show a loading indicator. +/// The following code shows a loading indicator while the mutation is in progress. +/// The indicator will disappear when the mutation completes or fails. +/// +/// ```dart +/// class TodoListView extends ConsumerWidget { +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// final addTodo = ref.watch(todoListProvider.addTodo); +/// +/// return Scaffold( +/// body: Column( +/// children: [ +/// // If the mutation is in progress, show a loading indicator +/// if (addTodo.state is PendingMutationState) +/// const LinearProgressIndicator(), +/// // See above for how AddTodoButton is defined +/// AddTodoButton(), +/// ], +/// ), +/// ); +/// } +/// } +/// ``` +/// +/// Notice how the code that handles the loading state of our mutation +/// is separated from the code that starts the mutation. +/// In this example, even though `AddTodoButton` and `TodoListView` are separate, +/// both share the progress of the operation. This allows to easily separate +/// split the responsibilities of our widgets. +/// +/// ### Example: Showing a snackbar when the mutation completes/fails +/// +/// You can check for the [ErrorMutationState] and [SuccessMutationState] to show a snackbar. +/// +/// Since showing snackbars is done using `showSnackBar`, which is not a widget, +/// we cannot rely on `ref.watch` here. +/// Instead, we should use `ref.listen` to listen to the mutation state. +/// This will give us a callback where we can safely show a snackbar. +/// +/// ```dart +/// class TodoListView extends ConsumerWidget { +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// ref.listen(todoListProvider.addTodo, (_, addTodo) { +/// // We determine if the mutation succeeded or failed, and change +/// // the message accordingly. +/// String message; +/// if (addTodo.state is ErrorMutationState) { +/// message = 'Failed to add todo'; +/// } +/// else if (addTodo.state is SuccessMutationState) { +/// message = 'Todo added successfully'; +/// } +/// // We are neither in a success nor in an error state, so we do not show a snackbar. +/// else return; +/// +/// // We show a snackbar with the message. +/// ScaffoldMessenger.of(context).showSnackBar( +/// SnackBar(content: Text(message)), +/// ); +/// }); +/// } +/// } +/// ``` +/// +/// ## Example: Disabling a button while the operation is pending +/// +/// You can check for the [PendingMutationState] to know if an operation is +/// in progress. We can use this information to disable a button, by setting its +/// `onPressed` to `null`: +/// +/// ```dart +/// class AddTodoButton extends ConsumerWidget { +/// @override +/// Widget build(BuildContext context, WidgetRef ref) { +/// final addTodo = ref.watch(todoListProvider.addTodo); +/// +/// return ElevatedButton( +/// onPressed: addTodo.state is PendingMutationState +/// ? null // If the mutation is in progress, disable the button +/// : () => addTodo(Todo('Buy milk')), // Otherwise enable the button +/// ); +/// } +/// } +/// ``` +/// +/// A similar logic can be used for showing the button in red/green when the +/// operation fails/completes, by instead checking for [ErrorMutationState] and +/// [SuccessMutationState]. +/// +/// {@macro auto_reset} +/// {@endtemplate} +@Target({TargetKind.method}) +final class Mutation { + /// {@macro mutation} + const Mutation(); +} + +/// {@macro mutation} +const mutation = Mutation(); + +/// The current state of a mutation. +/// +/// {@template mutation_states} +/// A mutation can be in any of the following states: +/// - [IdleMutationState]: The mutation is not running. This is the default state. +/// - [PendingMutationState]: The mutation has been called and is in progress. +/// - [ErrorMutationState]: The mutation has failed with an error. +/// - [SuccessMutationState]: The mutation has completed successfully. +/// {@endtemplate} +sealed class MutationState { + const MutationState._(); +} + +/// The mutation is not running. +/// +/// This is the default state of a mutation. +/// A mutation can be reset to this state by calling [MutationBase.reset]. +/// +/// {@macro auto_reset} +/// +/// {@macro mutation_states} +final class IdleMutationState extends MutationState { + const IdleMutationState._() : super._(); + + @override + String toString() => 'IdleMutationState<$ResultT>()'; +} + +/// The mutation has been called and is in progress. +/// +/// {@macro mutation_states} +final class PendingMutationState extends MutationState { + const PendingMutationState._() : super._(); + + @override + String toString() => 'PendingMutationState<$ResultT>()'; +} + +/// The mutation has failed with an error. +/// +/// {@macro mutation_states} +final class ErrorMutationState extends MutationState { + ErrorMutationState._(this.error, this.stackTrace) : super._(); + + /// The error thrown by the mutation. + final Object error; + + /// The stack trace of the [error]. + final StackTrace stackTrace; + + @override + String toString() => 'ErrorMutationState<$ResultT>($error, $stackTrace)'; +} + +/// The mutation has completed successfully. +/// +/// {@macro mutation_states} +final class SuccessMutationState extends MutationState { + SuccessMutationState._(this.value) : super._(); + + /// The new state of the notifier after the mutation has completed. + final ResultT value; + + @override + String toString() => 'SuccessMutationState<$ResultT>($value)'; +} + +/// A base class that all mutations extends. +/// +/// See also [Mutation] for information on how to define a mutation. +@immutable +abstract class MutationBase { + /// The current state of the mutation. + /// + /// This defaults to [IdleMutationState]. + /// When the mutation starts, it will change to [PendingMutationState] and + /// then to either [ErrorMutationState] or [SuccessMutationState]. + /// + /// **Note**: + /// This property is immutable. The state will not change unless you + /// call `ref.watch(provider.myMutation)` again. + MutationState get state; + + /// Sets [state] back to [IdleMutationState]. + /// + /// Calling [reset] is useful when the mutation is actively listened to, + /// and you want to forcibly go back to the [IdleMutationState]. + /// + /// {@template auto_reset} + /// ## Automatic resets + /// + /// By default, mutations are automatically reset when they are no longer + /// being listened to. + /// This is similar to Riverpod's "auto-dispose" feature, for mutations. + /// If you remove all `watch`/`listen` calls to a mutation, the mutation + /// will automatically go-back to its [IdleMutationState]. + /// + /// If your mutation is always listened, you may want to call [reset] manually + /// to restore the mutation to its [IdleMutationState]. + /// {@endtemplate} + void reset(); +} + +@internal +abstract class $SyncMutationBase< + StateT, + MutationT extends $SyncMutationBase, + ClassT extends NotifierBase> + extends _MutationBase { + $SyncMutationBase({super.state, super.key}); + + @override + void setData(StateT value) { + element.setStateResult(Result.data(value)); + } +} + +@internal +abstract class $AsyncMutationBase< + StateT, + MutationT extends $AsyncMutationBase, + ClassT extends NotifierBase, Object?>> + extends _MutationBase, MutationT, ClassT> { + $AsyncMutationBase({super.state, super.key}); + + @override + void setData(StateT value) { + element.setStateResult(Result.data(AsyncData(value))); + } +} + +abstract class _MutationBase< + ValueT, + StateT, + MutationT extends _MutationBase, + ClassT extends NotifierBase> + implements MutationBase { + _MutationBase({MutationState? state, this.key}) + : state = state ?? IdleMutationState._() { + listenable.onCancel = _scheduleAutoReset; + } + + @override + final MutationState state; + final Object? key; + + ClassProviderElement get element; + ProxyElementValueListenable get listenable; + + Object? get _currentKey => listenable.result?.stateOrNull?.key; + + MutationT copyWith(MutationState state, {Object? key}); + + void setData(ValueT value); + + void _scheduleAutoReset() { + Future.microtask(() { + if (listenable.hasListeners) return; + + reset(); + }); + } + + @override + void reset() { + if (state is IdleMutationState) return; + + listenable.result = ResultData(copyWith(IdleMutationState._())); + + final context = ProviderObserverContext(element.origin, element.container); + + _notifyObserver((obs) => obs.mutationReset(context)); + } + + void _notifyObserver(void Function(ProviderObserver obs) cb) { + for (final observer in element.container.observers) { + runUnaryGuarded(cb, observer); + } + } + + void _setState(MutationContext? mutationContext, MutationT mutation) { + listenable.result = Result.data(mutation); + + final obsContext = ProviderObserverContext( + element.origin, + element.container, + mutation: mutationContext, + ); + + switch (mutation.state) { + case ErrorMutationState(:final error, :final stackTrace): + _notifyObserver( + (obs) => obs.mutationError( + obsContext, + mutationContext!, + error, + stackTrace, + ), + ); + + case SuccessMutationState(:final value): + _notifyObserver( + (obs) => obs.mutationSuccess(obsContext, mutationContext!, value), + ); + + case PendingMutationState(): + _notifyObserver( + (obs) => obs.mutationStart(obsContext, mutationContext!), + ); + + default: + } + } + + @protected + Future mutateAsync( + Invocation invocation, + FutureOr Function(ClassT clazz) cb, + ) { + element.flush(); + final notifier = element.classListenable.value; + final mutationContext = MutationContext(invocation, notifier); + + return runZoned( + zoneValues: {mutationZoneKey: mutationContext}, + () async { + // ! is safe because of the flush() above + final key = Object(); + try { + _setState( + mutationContext, + copyWith(PendingMutationState._(), key: key), + ); + + final result = await cb(notifier); + if (key == _currentKey) { + _setState( + mutationContext, + copyWith(SuccessMutationState._(result)), + ); + } + setData(result); + + return result; + } catch (err, stack) { + if (key == _currentKey) { + _setState( + mutationContext, + copyWith(ErrorMutationState._(err, stack)), + ); + } + + rethrow; + } + }, + ); + } + + @override + String toString() => '$runtimeType#${shortHash(this)}($state)'; +} diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index 60f8bd8ae..a46f22601 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -4,11 +4,11 @@ import 'package:state_notifier/state_notifier.dart'; import '../../builder.dart'; import '../../internals.dart'; -ProviderElementProxy +ProviderElementProxy _notifier, StateT>( StateNotifierProvider that, ) { - return ProviderElementProxy( + return ProviderElementProxy( that, (element) { return (element as StateNotifierProviderElement) diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index ed2ca1c31..1d2006d7f 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -4,10 +4,10 @@ import '../../builder.dart'; import '../../internals.dart'; import 'state_controller.dart'; -ProviderElementProxy> _notifier( +ProviderElementProxy, StateT> _notifier( StateProvider that, ) { - return ProviderElementProxy>( + return ProviderElementProxy, StateT>( that, (element) { return (element as StateProviderElement)._controllerNotifier; diff --git a/packages/riverpod/test/old/utils.dart b/packages/riverpod/test/old/utils.dart index f7839184e..6f8965cf0 100644 --- a/packages/riverpod/test/old/utils.dart +++ b/packages/riverpod/test/old/utils.dart @@ -182,56 +182,82 @@ class ObserverMock extends Mock implements ProviderObserver { } @override - void didDisposeProvider( - ProviderBase? provider, - ProviderContainer? container, - ) { - super.noSuchMethod( - Invocation.method(#didDisposeProvider, [provider, container]), - ); - } + void didAddProvider( + ProviderObserverContext? context, + Object? value, + ); @override void providerDidFail( - ProviderBase? provider, + ProviderObserverContext? context, Object? error, - Object? stackTrace, - Object? container, - ) { - super.noSuchMethod( - Invocation.method( - #providerDidFail, - [provider, error, stackTrace, container], - ), - ); - } - - @override - void didAddProvider( - ProviderBase? provider, - Object? value, - ProviderContainer? container, - ) { - super.noSuchMethod( - Invocation.method(#didAddProvider, [provider, value, container]), - ); - } + StackTrace? stackTrace, + ); @override void didUpdateProvider( - ProviderBase? provider, + ProviderObserverContext? context, Object? previousValue, Object? newValue, - ProviderContainer? container, - ) { - super.noSuchMethod( - Invocation.method( - #didUpdateProvider, - [provider, previousValue, newValue, container], - ), - ); - } + ); + + @override + void didDisposeProvider(ProviderObserverContext? context); + + @override + void mutationReset(ProviderObserverContext? context); + + @override + void mutationStart( + ProviderObserverContext? context, + MutationContext? mutation, + ); + + @override + void mutationError( + ProviderObserverContext? context, + MutationContext? mutation, + Object? error, + StackTrace? stackTrace, + ); + + @override + void mutationSuccess( + ProviderObserverContext? context, + MutationContext? mutation, + Object? result, + ); } // can subclass ProviderObserver without implementing all life-cycles class CustomObserver extends ProviderObserver {} + +TypeMatcher isProviderObserverContext( + Object? provider, + Object? container, { + Object? mutation, +}) { + var matcher = isA(); + + matcher = matcher.having((e) => e.provider, 'provider', provider); + matcher = matcher.having((e) => e.container, 'container', container); + if (mutation != null) { + matcher = matcher.having((e) => e.mutation, 'mutation', mutation); + } + + return matcher; +} + +TypeMatcher isMutationContext( + Object? invocation, { + Object? notifier, +}) { + var matcher = isA(); + + matcher = matcher.having((e) => e.invocation, 'invocation', invocation); + if (notifier != null) { + matcher = matcher.having((e) => e.notifier, 'notifier', notifier); + } + + return matcher; +} diff --git a/packages/riverpod/test/src/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart index 070019fde..c72be45fd 100644 --- a/packages/riverpod/test/src/core/provider_element_test.dart +++ b/packages/riverpod/test/src/core/provider_element_test.dart @@ -25,12 +25,12 @@ void main() { expect(providerElement.subscriptions, null); expect( providerElement.dependents, - [isA, int>>()], + [isA>()], ); expect(providerElement.weakDependents, isEmpty); expect(depElement.subscriptions, [ - isA, int>>(), + isA>(), ]); expect(depElement.dependents, isEmpty); expect(depElement.weakDependents, isEmpty); diff --git a/packages/riverpod/test/src/core/provider_observer_test.dart b/packages/riverpod/test/src/core/provider_observer_test.dart index 609ed9a4b..ce00b940e 100644 --- a/packages/riverpod/test/src/core/provider_observer_test.dart +++ b/packages/riverpod/test/src/core/provider_observer_test.dart @@ -9,18 +9,6 @@ import '../utils.dart'; void main() { group('ProviderObserver', () { - test('life-cycles do nothing by default', () { - const observer = ConstObserver(); - - final provider = Provider((ref) => 0); - final container = ProviderContainer.test(); - - observer.didAddProvider(provider, 0, container); - observer.didDisposeProvider(provider, container); - observer.didUpdateProvider(provider, 0, 0, container); - observer.providerDidFail(provider, 0, StackTrace.empty, container); - }); - test('can have const constructors', () { final root = ProviderContainer.test( observers: [ @@ -36,8 +24,9 @@ void main() { () async { final observer = ObserverMock(); final observer2 = ObserverMock(); - final container = - ProviderContainer.test(observers: [observer, observer2]); + final container = ProviderContainer.test( + observers: [observer, observer2], + ); final dep = StateProvider((ref) => 0); final provider = Provider((ref) { if (ref.watch(dep) == 0) { @@ -56,19 +45,17 @@ void main() { verifyInOrder([ observer.didUpdateProvider( - provider, + argThat(isProviderObserverContext(provider, container)), null, 0, - container, ), observer2.didUpdateProvider( - provider, + argThat(isProviderObserverContext(provider, container)), null, 0, - container, ), ]); - verifyNever(observer.providerDidFail(any, any, any, any)); + verifyNever(observer.providerDidFail(any, any, any)); }); test( @@ -102,13 +89,37 @@ void main() { expect(child.read(provider.notifier).state++, 42); - verify(observer.didUpdateProvider(provider, 42, 43, child)).called(1); - verify(observer2.didUpdateProvider(provider, 42, 43, child)).called(1); - verify(observer3.didUpdateProvider(provider, 42, 43, child)).called(1); + verify( + observer.didUpdateProvider( + argThat(isProviderObserverContext(provider, child)), + 42, + 43, + ), + ).called(1); + verify( + observer2.didUpdateProvider( + argThat(isProviderObserverContext(provider, child)), + 42, + 43, + ), + ).called(1); + verify( + observer3.didUpdateProvider( + argThat(isProviderObserverContext(provider, child)), + 42, + 43, + ), + ).called(1); mid.read(provider.notifier).state++; - verify(observer.didUpdateProvider(provider, 0, 1, root)).called(1); + verify( + observer.didUpdateProvider( + argThat(isProviderObserverContext(provider, root)), + 0, + 1, + ), + ).called(1); verifyNoMoreInteractions(observer3); verifyNoMoreInteractions(observer2); @@ -131,7 +142,11 @@ void main() { verifyOnly( observer, - observer.didUpdateProvider(computed, 0, 1, container), + observer.didUpdateProvider( + argThat(isProviderObserverContext(computed, container)), + 0, + 1, + ), ).called(1); }); @@ -148,7 +163,11 @@ void main() { verifyOnly( observer, - observer.didUpdateProvider(provider, 0, 1, container), + observer.didUpdateProvider( + argThat(isProviderObserverContext(provider, container)), + 0, + 1, + ), ).called(1); }); @@ -170,8 +189,14 @@ void main() { verify(listener(null, 0)).called(1); verifyNoMoreInteractions(listener); verifyInOrder([ - observer.didAddProvider(provider, 0, container), - observer2.didAddProvider(provider, 0, container), + observer.didAddProvider( + argThat(isProviderObserverContext(provider, container)), + 0, + ), + observer2.didAddProvider( + argThat(isProviderObserverContext(provider, container)), + 0, + ), ]); verifyNoMoreInteractions(observer); verifyNoMoreInteractions(observer2); @@ -180,8 +205,16 @@ void main() { verifyInOrder([ listener(0, 1), - observer.didUpdateProvider(provider, 0, 1, container), - observer2.didUpdateProvider(provider, 0, 1, container), + observer.didUpdateProvider( + argThat(isProviderObserverContext(provider, container)), + 0, + 1, + ), + observer2.didUpdateProvider( + argThat(isProviderObserverContext(provider, container)), + 0, + 1, + ), ]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(observer); @@ -190,11 +223,9 @@ void main() { test('guards didUpdateProviders', () { final observer = ObserverMock(); - when(observer.didUpdateProvider(any, any, any, any)) - .thenThrow('error1'); + when(observer.didUpdateProvider(any, any, any)).thenThrow('error1'); final observer2 = ObserverMock(); - when(observer2.didUpdateProvider(any, any, any, any)) - .thenThrow('error2'); + when(observer2.didUpdateProvider(any, any, any)).thenThrow('error2'); final observer3 = ObserverMock(); final provider = StateNotifierProvider((_) => Counter()); final counter = Counter(); @@ -214,9 +245,21 @@ void main() { expect(errors, ['error1', 'error2']); verifyInOrder([ - observer.didUpdateProvider(provider, 0, 1, container), - observer2.didUpdateProvider(provider, 0, 1, container), - observer3.didUpdateProvider(provider, 0, 1, container), + observer.didUpdateProvider( + argThat(isProviderObserverContext(provider, container)), + 0, + 1, + ), + observer2.didUpdateProvider( + argThat(isProviderObserverContext(provider, container)), + 0, + 1, + ), + observer3.didUpdateProvider( + argThat(isProviderObserverContext(provider, container)), + 0, + 1, + ), ]); verifyNoMoreInteractions(observer); verifyNoMoreInteractions(observer2); @@ -247,12 +290,13 @@ void main() { await container.pump(); verifyInOrder([ - observer.didDisposeProvider(isNegative, container), + observer.didDisposeProvider( + argThat(isProviderObserverContext(isNegative, container)), + ), observer.didUpdateProvider( - provider, + argThat(isProviderObserverContext(provider, container)), 0, 1, - container, ), ]); verifyNoMoreInteractions(observer); @@ -261,19 +305,19 @@ void main() { await container.pump(); verifyInOrder([ - observer.didDisposeProvider(isNegative, container), + observer.didDisposeProvider( + argThat(isProviderObserverContext(isNegative, container)), + ), observer.didUpdateProvider( - provider, + argThat(isProviderObserverContext(provider, container)), 1, -10, - container, ), isNegativeListener(false, true), observer.didUpdateProvider( - isNegative, + argThat(isProviderObserverContext(isNegative, container)), false, true, - container, ), ]); verifyNoMoreInteractions(isNegativeListener); @@ -325,20 +369,54 @@ void main() { await child.pump(); verifyInOrder([ - observer.didDisposeProvider(provider, child), - observer.didUpdateProvider(dep, 0, 1, root), - observer.didUpdateProvider(provider, 42, null, child), - observer.providerDidFail(provider, 'error', StackTrace.empty, child), + observer.didDisposeProvider( + argThat(isProviderObserverContext(provider, child)), + ), + observer.didUpdateProvider( + argThat(isProviderObserverContext(dep, root)), + 0, + 1, + ), + observer.didUpdateProvider( + argThat(isProviderObserverContext(provider, child)), + 42, + null, + ), + observer.providerDidFail( + argThat(isProviderObserverContext(provider, child)), + 'error', + StackTrace.empty, + ), ]); verifyInOrder([ - observer2.didDisposeProvider(provider, child), - observer2.didUpdateProvider(provider, 42, null, child), - observer2.providerDidFail(provider, 'error', StackTrace.empty, child), + observer2.didDisposeProvider( + argThat(isProviderObserverContext(provider, child)), + ), + observer2.didUpdateProvider( + argThat(isProviderObserverContext(provider, child)), + 42, + null, + ), + observer2.providerDidFail( + argThat(isProviderObserverContext(provider, child)), + 'error', + StackTrace.empty, + ), ]); verifyInOrder([ - observer3.didDisposeProvider(provider, child), - observer3.didUpdateProvider(provider, 42, null, child), - observer3.providerDidFail(provider, 'error', StackTrace.empty, child), + observer3.didDisposeProvider( + argThat(isProviderObserverContext(provider, child)), + ), + observer3.didUpdateProvider( + argThat(isProviderObserverContext(provider, child)), + 42, + null, + ), + observer3.providerDidFail( + argThat(isProviderObserverContext(provider, child)), + 'error', + StackTrace.empty, + ), ]); verifyNoMoreInteractions(observer3); @@ -358,21 +436,18 @@ void main() { verifyInOrder([ observer.didAddProvider( - provider, + argThat(isProviderObserverContext(provider, container)), const AsyncLoading(), - container, ), observer.didUpdateProvider( - provider, + argThat(isProviderObserverContext(provider, container)), const AsyncLoading(), const AsyncError('error', StackTrace.empty), - container, ), observer.providerDidFail( - provider, + argThat(isProviderObserverContext(provider, container)), 'error', StackTrace.empty, - container, ), ]); }); @@ -389,21 +464,18 @@ void main() { verifyInOrder([ observer.didAddProvider( - provider, + argThat(isProviderObserverContext(provider, container)), const AsyncLoading(), - container, ), observer.didUpdateProvider( - provider, + argThat(isProviderObserverContext(provider, container)), const AsyncLoading(), const AsyncError('error', StackTrace.empty), - container, ), observer.providerDidFail( - provider, + argThat(isProviderObserverContext(provider, container)), 'error', StackTrace.empty, - container, ), ]); }); @@ -421,19 +493,23 @@ void main() { ); verifyInOrder([ - observer.didAddProvider(provider, null, container), - observer2.didAddProvider(provider, null, container), + observer.didAddProvider( + argThat(isProviderObserverContext(provider, container)), + null, + ), + observer2.didAddProvider( + argThat(isProviderObserverContext(provider, container)), + null, + ), observer.providerDidFail( - provider, + argThat(isProviderObserverContext(provider, container)), argThat(isUnimplementedError), argThat(isNotNull), - container, ), observer2.providerDidFail( - provider, + argThat(isProviderObserverContext(provider, container)), argThat(isUnimplementedError), argThat(isNotNull), - container, ), ]); verifyNoMoreInteractions(observer); @@ -462,28 +538,24 @@ void main() { verifyInOrder([ observer.didUpdateProvider( - provider, + argThat(isProviderObserverContext(provider, container)), 0, null, - container, ), observer2.didUpdateProvider( - provider, + argThat(isProviderObserverContext(provider, container)), 0, null, - container, ), observer.providerDidFail( - provider, + argThat(isProviderObserverContext(provider, container)), argThat(isUnimplementedError), argThat(isNotNull), - container, ), observer2.providerDidFail( - provider, + argThat(isProviderObserverContext(provider, container)), argThat(isUnimplementedError), argThat(isNotNull), - container, ), ]); }); @@ -500,7 +572,12 @@ void main() { throwsUnimplementedError, ); - verify(observer.didAddProvider(provider, null, container)); + verify( + observer.didAddProvider( + argThat(isProviderObserverContext(provider, container)), + null, + ), + ); }); test( @@ -527,14 +604,28 @@ void main() { expect(child.read(provider), 42); verifyInOrder([ - observer3.didAddProvider(provider, 42, child), - observer2.didAddProvider(provider, 42, child), - observer.didAddProvider(provider, 42, child), + observer3.didAddProvider( + argThat(isProviderObserverContext(provider, child)), + 42, + ), + observer2.didAddProvider( + argThat(isProviderObserverContext(provider, child)), + 42, + ), + observer.didAddProvider( + argThat(isProviderObserverContext(provider, child)), + 42, + ), ]); expect(mid.read(provider), 0); - verify(observer.didAddProvider(provider, 0, root)).called(1); + verify( + observer.didAddProvider( + argThat(isProviderObserverContext(provider, root)), + 0, + ), + ).called(1); verifyNoMoreInteractions(observer3); verifyNoMoreInteractions(observer2); @@ -551,14 +642,12 @@ void main() { expect(container.read(provider), 42); verifyInOrder([ observer.didAddProvider( - provider, + argThat(isProviderObserverContext(provider, container)), 42, - container, ), observer2.didAddProvider( - provider, + argThat(isProviderObserverContext(provider, container)), 42, - container, ), ]); verifyNoMoreInteractions(observer); @@ -567,9 +656,9 @@ void main() { test('guards against exceptions', () { final observer = ObserverMock(); - when(observer.didAddProvider(any, any, any)).thenThrow('error1'); + when(observer.didAddProvider(any, any)).thenThrow('error1'); final observer2 = ObserverMock(); - when(observer2.didAddProvider(any, any, any)).thenThrow('error2'); + when(observer2.didAddProvider(any, any)).thenThrow('error2'); final observer3 = ObserverMock(); final provider = Provider((_) => 42); final container = ProviderContainer.test( @@ -587,9 +676,18 @@ void main() { expect(result, 42); expect(errors, ['error1', 'error2']); verifyInOrder([ - observer.didAddProvider(provider, 42, container), - observer2.didAddProvider(provider, 42, container), - observer3.didAddProvider(provider, 42, container), + observer.didAddProvider( + argThat(isProviderObserverContext(provider, container)), + 42, + ), + observer2.didAddProvider( + argThat(isProviderObserverContext(provider, container)), + 42, + ), + observer3.didAddProvider( + argThat(isProviderObserverContext(provider, container)), + 42, + ), ]); verifyNoMoreInteractions(observer); }); @@ -606,7 +704,12 @@ void main() { clearInteractions(observer); container.invalidate(provider); - verifyOnly(observer, observer.didDisposeProvider(provider, container)); + verifyOnly( + observer, + observer.didDisposeProvider( + argThat(isProviderObserverContext(provider, container)), + ), + ); container.invalidate(provider); verifyNoMoreInteractions(observer); @@ -624,7 +727,9 @@ void main() { container.dispose(); verifyInOrder([ - observer.didDisposeProvider(provider, container), + observer.didDisposeProvider( + argThat(isProviderObserverContext(provider, container)), + ), ]); verifyNoMoreInteractions(observer); }); @@ -644,16 +749,18 @@ void main() { await container.pump(); verifyInOrder([ - observer.didDisposeProvider(provider, container), + observer.didDisposeProvider( + argThat(isProviderObserverContext(provider, container)), + ), ]); verifyNoMoreInteractions(observer); }); test('is guarded', () { final observer = ObserverMock(); - when(observer.didDisposeProvider(any, any)).thenThrow('error1'); + when(observer.didDisposeProvider(any)).thenThrow('error1'); final observer2 = ObserverMock(); - when(observer2.didDisposeProvider(any, any)).thenThrow('error2'); + when(observer2.didDisposeProvider(any)).thenThrow('error2'); final observer3 = ObserverMock(); final onDispose = OnDisposeMock(); final provider = Provider((ref) { @@ -677,13 +784,25 @@ void main() { expect(errors, ['error1', 'error2', 'error1', 'error2']); verifyInOrder([ - observer.didDisposeProvider(provider2, container), - observer2.didDisposeProvider(provider2, container), - observer3.didDisposeProvider(provider2, container), + observer.didDisposeProvider( + argThat(isProviderObserverContext(provider2, container)), + ), + observer2.didDisposeProvider( + argThat(isProviderObserverContext(provider2, container)), + ), + observer3.didDisposeProvider( + argThat(isProviderObserverContext(provider2, container)), + ), onDispose(), - observer.didDisposeProvider(provider, container), - observer2.didDisposeProvider(provider, container), - observer3.didDisposeProvider(provider, container), + observer.didDisposeProvider( + argThat(isProviderObserverContext(provider, container)), + ), + observer2.didDisposeProvider( + argThat(isProviderObserverContext(provider, container)), + ), + observer3.didDisposeProvider( + argThat(isProviderObserverContext(provider, container)), + ), ]); verifyNoMoreInteractions(onDispose); verifyNoMoreInteractions(observer); diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index d110b3e0d..f3610bfae 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -1860,7 +1860,7 @@ void main() { group('.notifyListeners', () { test('If called after initialization, notify listeners', () { - final observer = ProviderObserverMock(); + final observer = ObserverMock(); final listener = Listener(); final selfListener = Listener(); final container = ProviderContainer.test(observers: [observer]); @@ -1873,7 +1873,13 @@ void main() { container.listen(provider, listener.call, fireImmediately: true); - verifyOnly(observer, observer.didAddProvider(provider, 0, container)); + verifyOnly( + observer, + observer.didAddProvider( + argThat(isProviderObserverContext(provider, container)), + 0, + ), + ); verifyOnly(listener, listener(null, 0)); verifyOnly(selfListener, selfListener(null, 0)); @@ -1883,14 +1889,18 @@ void main() { verifyOnly(selfListener, selfListener(0, 0)); verifyOnly( observer, - observer.didUpdateProvider(provider, 0, 0, container), + observer.didUpdateProvider( + argThat(isProviderObserverContext(provider, container)), + 0, + 0, + ), ); }); test( 'can be invoked during first initialization, and does not notify listeners', () { - final observer = ProviderObserverMock(); + final observer = ObserverMock(); final selfListener = Listener(); final listener = Listener(); final container = ProviderContainer.test(observers: [observer]); @@ -1905,7 +1915,13 @@ void main() { container.listen(provider, listener.call, fireImmediately: true); - verifyOnly(observer, observer.didAddProvider(provider, 0, container)); + verifyOnly( + observer, + observer.didAddProvider( + argThat(isProviderObserverContext(provider, container)), + 0, + ), + ); verifyOnly(listener, listener(null, 0)); verifyOnly(selfListener, selfListener(null, 0)); }); @@ -1913,7 +1929,7 @@ void main() { test( 'can be invoked during a re-initialization, and does not notify listeners', () { - final observer = ProviderObserverMock(); + final observer = ObserverMock(); final listener = Listener(); final selfListener = Listener(); final container = ProviderContainer.test(observers: [observer]); @@ -1936,7 +1952,10 @@ void main() { verifyOnly( observer, - observer.didAddProvider(provider, firstValue, container), + observer.didAddProvider( + argThat(isProviderObserverContext(provider, container)), + firstValue, + ), ); verifyOnly(selfListener, selfListener(null, firstValue)); verifyOnly(listener, listener(null, firstValue)); @@ -1947,13 +1966,16 @@ void main() { verifyOnly(selfListener, selfListener(firstValue, secondValue)); verifyOnly(listener, listener(firstValue, secondValue)); - verify(observer.didDisposeProvider(provider, container)); + verify( + observer.didDisposeProvider( + argThat(isProviderObserverContext(provider, container)), + ), + ); verify( observer.didUpdateProvider( - provider, + argThat(isProviderObserverContext(provider, container)), firstValue, secondValue, - container, ), ).called(1); verifyNoMoreInteractions(observer); diff --git a/packages/riverpod/test/src/utils.dart b/packages/riverpod/test/src/utils.dart index d2344bcf3..5321322b3 100644 --- a/packages/riverpod/test/src/utils.dart +++ b/packages/riverpod/test/src/utils.dart @@ -5,6 +5,9 @@ import 'package:riverpod/legacy.dart'; import 'package:riverpod/src/internals.dart'; import 'package:test/test.dart' hide Retry; +export '../old/utils.dart' + show ObserverMock, isProviderObserverContext, isMutationContext; + List captureErrors(List cb) { final errors = []; for (final fn in cb) { @@ -18,8 +21,6 @@ List captureErrors(List cb) { return errors; } -class ProviderObserverMock extends Mock implements ProviderObserver {} - class StreamSubscriptionView implements StreamSubscription { StreamSubscriptionView(this.inner); @@ -249,65 +250,3 @@ List errorsOf(void Function() cb) { runZonedGuarded(cb, (err, _) => errors.add(err)); return [...errors]; } - -class ObserverMock extends Mock implements ProviderObserver { - ObserverMock([this.label]); - - final String? label; - - @override - String toString() { - return label ?? super.toString(); - } - - @override - void didDisposeProvider( - ProviderBase? provider, - ProviderContainer? container, - ) { - super.noSuchMethod( - Invocation.method(#didDisposeProvider, [provider, container]), - ); - } - - @override - void providerDidFail( - ProviderBase? provider, - Object? error, - Object? stackTrace, - Object? container, - ) { - super.noSuchMethod( - Invocation.method( - #providerDidFail, - [provider, error, stackTrace, container], - ), - ); - } - - @override - void didAddProvider( - ProviderBase? provider, - Object? value, - ProviderContainer? container, - ) { - super.noSuchMethod( - Invocation.method(#didAddProvider, [provider, value, container]), - ); - } - - @override - void didUpdateProvider( - ProviderBase? provider, - Object? previousValue, - Object? newValue, - ProviderContainer? container, - ) { - super.noSuchMethod( - Invocation.method( - #didUpdateProvider, - [provider, previousValue, newValue, container], - ), - ); - } -} diff --git a/packages/riverpod_analyzer_utils/CHANGELOG.md b/packages/riverpod_analyzer_utils/CHANGELOG.md index 2836f63f1..129fe7e40 100644 --- a/packages/riverpod_analyzer_utils/CHANGELOG.md +++ b/packages/riverpod_analyzer_utils/CHANGELOG.md @@ -3,6 +3,7 @@ - **Breaking**: Rewrote all RiverpodAst nodes to instead be extensions on `AstNodes`. Too many changes to detail everything. I'm the only one who uses this package anyway. If you're reading this, have a nice day! +- Added support for parsing `@mutation` ## 1.0.0-dev.1 - 2023-11-20 diff --git a/packages/riverpod_analyzer_utils/lib/src/errors.dart b/packages/riverpod_analyzer_utils/lib/src/errors.dart index a8a0d99da..eed83d768 100644 --- a/packages/riverpod_analyzer_utils/lib/src/errors.dart +++ b/packages/riverpod_analyzer_utils/lib/src/errors.dart @@ -19,6 +19,9 @@ enum RiverpodAnalysisErrorCode { providerDependencyListParseError, providerOrFamilyExpressionParseError, invalidRetryArgument, + mutationReturnTypeMismatch, + mutationIsStatic, + mutationIsAbstract, } class RiverpodAnalysisError { diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes.dart b/packages/riverpod_analyzer_utils/lib/src/nodes.dart index fe288f180..753e7d115 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes.dart @@ -9,6 +9,7 @@ import 'package:analyzer/dart/ast/token.dart'; import 'package:analyzer/dart/ast/visitor.dart'; import 'package:analyzer/dart/constant/value.dart'; import 'package:analyzer/dart/element/element.dart'; +import 'package:analyzer/dart/element/nullability_suffix.dart'; import 'package:analyzer/dart/element/type.dart'; import 'package:collection/collection.dart'; import 'package:crypto/crypto.dart'; @@ -34,7 +35,7 @@ part 'nodes/providers/identifiers.dart'; part 'nodes/provider_for.dart'; part 'nodes/provider_or_family.dart'; -part 'nodes/riverpod.dart'; +part 'nodes/annotation.dart'; part 'nodes/provider_listenable.dart'; part 'nodes/ref_invocation.dart'; part 'nodes/widget_ref_invocation.dart'; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/annotation.dart similarity index 68% rename from packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart rename to packages/riverpod_analyzer_utils/lib/src/nodes/annotation.dart index 2e71ac507..3420d9360 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/riverpod.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/annotation.dart @@ -131,3 +131,72 @@ final class RiverpodAnnotationElement { final List? dependencies; final Set? allTransitiveDependencies; } + +extension MutationAnnotatedNodeOfX on AnnotatedNode { + static final _cache = Expando>(); + + MutationAnnotation? get mutation { + return _cache.upsert(this, () { + return metadata.map((e) => e.mutation).nonNulls.firstOrNull; + }); + } +} + +extension MutationAnnotationX on Annotation { + static final _cache = Expando>(); + + MutationAnnotation? get mutation { + return _cache.upsert(this, () { + final elementAnnotation = this.elementAnnotation; + final element = this.element; + if (element == null || elementAnnotation == null) return null; + if (element is! ExecutableElement || + !mutationType.isExactlyType(element.returnType)) { + // The annotation is not an @Mutation + return null; + } + + final mutationAnnotationElement = MutationAnnotationElement._parse( + elementAnnotation, + ); + if (mutationAnnotationElement == null) return null; + + return MutationAnnotation._( + node: this, + element: mutationAnnotationElement, + ); + }); + } +} + +final class MutationAnnotation { + MutationAnnotation._({required this.node, required this.element}); + + final Annotation node; + final MutationAnnotationElement element; +} + +final class MutationAnnotationElement { + MutationAnnotationElement._({ + required this.element, + }); + + static final _cache = _Cache(); + + static MutationAnnotationElement? _parse(ElementAnnotation element) { + return _cache(element, () { + final type = element.element.cast()?.returnType; + if (type == null || !mutationType.isExactlyType(type)) return null; + + return MutationAnnotationElement._( + element: element, + ); + }); + } + + static MutationAnnotationElement? _of(Element element) { + return element.metadata.map(_parse).nonNulls.firstOrNull; + } + + final ElementAnnotation element; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/notifier.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/notifier.dart index 639a4b198..dfe10e6aa 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/providers/notifier.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/providers/notifier.dart @@ -108,7 +108,11 @@ final class ClassBasedProviderDeclaration extends GeneratorProviderDeclaration { required this.createdTypeNode, required this.exposedTypeNode, required this.valueTypeNode, - }); + }) : mutations = node.members + .whereType() + .map((e) => e.mutation) + .nonNulls + .toList(); @override final Token name; @@ -125,6 +129,101 @@ final class ClassBasedProviderDeclaration extends GeneratorProviderDeclaration { final TypeAnnotation? valueTypeNode; @override final SourcedType exposedTypeNode; + + final List mutations; +} + +extension MutationMethodDeclarationX on MethodDeclaration { + static final _cache = _Cache(); + + Mutation? get mutation { + return _cache(this, () { + final element = declaredElement; + if (element == null) return null; + + final mutationElement = MutationElement._parse(element); + if (mutationElement == null) return null; + + if (isStatic) { + errorReporter( + RiverpodAnalysisError( + 'Mutations cannot be static.', + targetNode: this, + targetElement: element, + code: RiverpodAnalysisErrorCode.mutationIsStatic, + ), + ); + return null; + } + if (isAbstract) { + errorReporter( + RiverpodAnalysisError( + 'Mutations cannot be abstract.', + targetNode: this, + targetElement: element, + code: RiverpodAnalysisErrorCode.mutationIsAbstract, + ), + ); + return null; + } + + final expectedReturnType = thisOrAncestorOfType()! + .members + .whereType() + .firstWhereOrNull((e) => e.name.lexeme == 'build') + ?.returnType; + if (expectedReturnType == null) return null; + + final expectedValueType = _getValueType( + expectedReturnType, + element.library, + ); + if (expectedValueType == null) return null; + + final expectedType = + element.library.typeProvider.futureOrElement.instantiate( + typeArguments: [expectedValueType.type!], + nullabilitySuffix: NullabilitySuffix.none, + ); + + final actualType = element.returnType; + + final isAssignable = element.library.typeSystem.isAssignableTo( + actualType, + expectedType, + strictCasts: true, + ); + if (!isAssignable) { + errorReporter( + RiverpodAnalysisError( + 'The return type of mutations must match the type returned by the "build" method.', + targetNode: this, + targetElement: element, + code: RiverpodAnalysisErrorCode.mutationReturnTypeMismatch, + ), + ); + return null; + } + + final mutation = Mutation._( + node: this, + element: mutationElement, + ); + + return mutation; + }); + } +} + +final class Mutation { + Mutation._({ + required this.node, + required this.element, + }); + + String get name => node.name.lexeme; + final MethodDeclaration node; + final MutationElement element; } class ClassBasedProviderDeclarationElement @@ -185,3 +284,27 @@ class ClassBasedProviderDeclarationElement final ExecutableElement buildMethod; } + +class MutationElement { + MutationElement._({ + required this.name, + required this.method, + }); + + static final _cache = _Cache(); + + static MutationElement? _parse(ExecutableElement element) { + return _cache(element, () { + final annotation = MutationAnnotationElement._of(element); + if (annotation == null) return null; + + return MutationElement._( + name: element.name, + method: element, + ); + }); + } + + final String name; + final ExecutableElement method; +} diff --git a/packages/riverpod_analyzer_utils/lib/src/riverpod_types/generator.dart b/packages/riverpod_analyzer_utils/lib/src/riverpod_types/generator.dart index cdb126a55..eeefbba62 100644 --- a/packages/riverpod_analyzer_utils/lib/src/riverpod_types/generator.dart +++ b/packages/riverpod_analyzer_utils/lib/src/riverpod_types/generator.dart @@ -17,3 +17,9 @@ const riverpodType = TypeChecker.fromName( 'Riverpod', packageName: 'riverpod_annotation', ); + +/// Matches with the `Mutation` annotation from riverpod_annotation. +const mutationType = TypeChecker.fromName( + 'Mutation', + packageName: 'riverpod', +); diff --git a/packages/riverpod_analyzer_utils_tests/test/mutation_test.dart b/packages/riverpod_analyzer_utils_tests/test/mutation_test.dart new file mode 100644 index 000000000..d9dccd451 --- /dev/null +++ b/packages/riverpod_analyzer_utils_tests/test/mutation_test.dart @@ -0,0 +1,98 @@ +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import 'package:test/test.dart'; + +import 'analyzer_test_utils.dart'; + +void main() { + testSource( + 'Rejects mutations with a return value non-matching the build value', + source: r''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@riverpod +class SyncNotifier extends _$SyncNotifier { + @override + T build() => throw 42; + + @mutation + Stream a() => throw 42; + + @mutation + T b() => throw 42; + + @mutation + FutureOr c() => throw 42; + + @mutation + Future d() => throw 42; + + @mutation + Future e() => throw 42; + + @mutation + int e() => throw 42; +} +''', (resolver, unit, units) async { + final result = + await resolver.resolveRiverpodAnalysisResult(ignoreErrors: true); + + expect(result.errors, hasLength(3)); + + expect( + result.errors, + everyElement( + isA() + .having((e) => e.targetNode, 'node', isNotNull) + .having((e) => e.targetElement, 'element', isNotNull) + .having( + (e) => e.code, + 'code', + RiverpodAnalysisErrorCode.mutationReturnTypeMismatch, + ) + .having( + (e) => e.message, + 'message', + 'The return type of mutations must match the type returned by the "build" method.', + ), + ), + ); + }); + + testSource('rejects abstract/static mutations', source: r''' +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +@riverpod +class Abstract extends _$Abstract { + @override + int build() => 0; + + @mutation + Future a(); + + @mutation + static Future b() async => 42; +} +''', (resolver, unit, units) async { + final result = + await resolver.resolveRiverpodAnalysisResult(ignoreErrors: true); + + expect(result.errors, hasLength(2)); + + expect( + result.errors, + everyElement( + isA() + .having((e) => e.targetNode, 'node', isNotNull) + .having((e) => e.targetElement, 'element', isNotNull) + .having( + (e) => e.code, + 'code', + anyOf( + RiverpodAnalysisErrorCode.mutationIsAbstract, + RiverpodAnalysisErrorCode.mutationIsStatic, + ), + ), + ), + ); + }); +} diff --git a/packages/riverpod_annotation/CHANGELOG.md b/packages/riverpod_annotation/CHANGELOG.md index a677b4bc5..d8f6544fc 100644 --- a/packages/riverpod_annotation/CHANGELOG.md +++ b/packages/riverpod_annotation/CHANGELOG.md @@ -3,6 +3,9 @@ - **Breaking** various `package:riverpod` objects are no-longer exported. If you wish to use providers by hand, you will have to separately import `package:riverpod/riverpod.dart`. +- Added `@mutation` support. + Mutations are a way to enable your UI to easily listen to the status of side-effects. + See the documentation of `@mutation` for further information. - Made `@Riverpod` final - Added `@Dependencies([...])`, for lint purposes. This is similar to `@Riverpod(dependencies: [...])`, but is applied on diff --git a/packages/riverpod_annotation/analysis_options.yaml b/packages/riverpod_annotation/analysis_options.yaml new file mode 100644 index 000000000..a9a268589 --- /dev/null +++ b/packages/riverpod_annotation/analysis_options.yaml @@ -0,0 +1,6 @@ +include: ../../analysis_options.yaml +analyzer: + errors: + # We have a tight constraint on Riverpod to use its internal APIs + invalid_use_of_internal_member: ignore + implementation_imports: ignore diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index feb355c4a..d8ddb66ab 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -58,6 +58,13 @@ export 'package:riverpod/src/internals.dart' $NotifierProviderElement, $Notifier; +// ignore: invalid_export_of_internal_element, used by the generator. +export 'package:riverpod/src/mutation.dart' + show $SyncMutationBase, $AsyncMutationBase; +// Separate export to avoid silencing valid @internal issues +export 'package:riverpod/src/mutation.dart' + hide $SyncMutationBase, $AsyncMutationBase; + export 'src/riverpod_annotation.dart'; /// An implementation detail of `riverpod_generator`. diff --git a/packages/riverpod_generator/CHANGELOG.md b/packages/riverpod_generator/CHANGELOG.md index 348a2e2a1..3045f40b8 100644 --- a/packages/riverpod_generator/CHANGELOG.md +++ b/packages/riverpod_generator/CHANGELOG.md @@ -14,7 +14,7 @@ } ) ``` - +- Added support for mutations. See also `@mutation` for further information. - Added support for `@Riverpod(retry: ...)` ## 2.6.3 - 2024-11-18 diff --git a/packages/riverpod_generator/lib/src/riverpod_generator.dart b/packages/riverpod_generator/lib/src/riverpod_generator.dart index d3e1e6108..abbae9ba9 100644 --- a/packages/riverpod_generator/lib/src/riverpod_generator.dart +++ b/packages/riverpod_generator/lib/src/riverpod_generator.dart @@ -10,8 +10,10 @@ import 'package:source_gen/source_gen.dart'; import 'models.dart'; import 'parse_generator.dart'; +import 'templates/element.dart'; import 'templates/family.dart'; import 'templates/hash.dart'; +import 'templates/mutation.dart'; import 'templates/notifier.dart'; import 'templates/parameters.dart'; import 'templates/provider.dart'; @@ -202,6 +204,10 @@ class _RiverpodGeneratorVisitor { ) { visitGeneratorProviderDeclaration(provider); NotifierTemplate(provider).run(buffer); + ElementTemplate(provider).run(buffer); + for (final mutation in provider.mutations) { + MutationTemplate(mutation, provider).run(buffer); + } } void visitFunctionalProviderDeclaration( @@ -343,9 +349,9 @@ extension ProviderNames on GeneratorProviderDeclaration { final ClassBasedProviderDeclaration p => p.node.typeParameters }; - String generics() => _genericUsageDisplayString(typeParameters); + String generics() => typeParameters.genericUsageDisplayString(); String genericsDefinition() => - _genericDefinitionDisplayString(typeParameters); + typeParameters.genericDefinitionDisplayString(); String notifierBuildType({ bool withGenericDefinition = false, @@ -389,7 +395,9 @@ extension ProviderNames on GeneratorProviderDeclaration { } } - String get elementName => switch (this) { + String get generatedElementName => '_\$${providerElement.name.public}Element'; + + String get internalElementName => switch (this) { ClassBasedProviderDeclaration() => switch (createdType) { SupportedCreatedType.future => r'$AsyncNotifierProviderElement', SupportedCreatedType.stream => r'$StreamNotifierProviderElement', @@ -417,16 +425,18 @@ extension ProviderNames on GeneratorProviderDeclaration { } } -String _genericDefinitionDisplayString(TypeParameterList? typeParameters) { - return typeParameters?.toSource() ?? ''; -} - -String _genericUsageDisplayString(TypeParameterList? typeParameterList) { - if (typeParameterList == null) { - return ''; +extension TypeX on TypeParameterList? { + String genericDefinitionDisplayString() { + return this?.toSource() ?? ''; } - return '<${typeParameterList.typeParameters.map((e) => e.name.lexeme).join(', ')}>'; + String genericUsageDisplayString() { + if (this == null) { + return ''; + } + + return '<${this!.typeParameters.map((e) => e.name.lexeme).join(', ')}>'; + } } extension ParameterDoc on AstNode { diff --git a/packages/riverpod_generator/lib/src/templates/element.dart b/packages/riverpod_generator/lib/src/templates/element.dart new file mode 100644 index 000000000..165f24602 --- /dev/null +++ b/packages/riverpod_generator/lib/src/templates/element.dart @@ -0,0 +1,95 @@ +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; + +import '../models.dart'; +import '../riverpod_generator.dart'; +import 'template.dart'; + +extension MutationX on Mutation { + String get elementFieldName => '_\$${name.lowerFirst}'; + String get generatedMutationInterfaceName => + '${(node.parent! as ClassDeclaration).name}\$${name.titled}'; + String get generatedMutationImplName => + '_\$${(node.parent! as ClassDeclaration).name}\$${name.titled}'; +} + +class ElementTemplate extends Template { + ElementTemplate(this.provider); + + final ClassBasedProviderDeclaration provider; + late final _generics = provider.generics(); + late final _genericsDefinition = provider.genericsDefinition(); + + @override + void run(StringBuffer buffer) { + if (provider.mutations.isEmpty) return; + + buffer.write(''' +class ${provider.generatedElementName}$_genericsDefinition extends ${provider.internalElementName}<${provider.name}$_generics, ${provider.valueTypeDisplayString}> { + ${provider.generatedElementName}(super.provider, super.pointer) { +'''); + + _constructorBody(buffer); + buffer.writeln('}'); + + _fields(buffer); + _overrideMount(buffer); + _overrideVisitChildren(buffer); + + buffer.writeln('}'); + } + + void _constructorBody(StringBuffer buffer) { + for (final mutation in provider.mutations) { + buffer.writeln( + ' ${mutation.elementFieldName}.result = Result.data(${mutation.generatedMutationImplName}(this));', + ); + } + } + + void _overrideVisitChildren(StringBuffer buffer) { + buffer.writeln(''' + @override + void visitChildren({ + required void Function(ProviderElement element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); +'''); + + for (final mutation in provider.mutations) { + buffer.writeln(' listenableVisitor(${mutation.elementFieldName});'); + } + + buffer.write(''' + } + '''); + } + + void _fields(StringBuffer buffer) { + for (final mutation in provider.mutations) { + buffer.writeln( + ' final ${mutation.elementFieldName} = ProxyElementValueListenable<${mutation.generatedMutationImplName}>();', + ); + } + } + + void _overrideMount(StringBuffer buffer) { + buffer.write(''' + @override + void mount() { + super.mount(); +'''); + for (final mutation in provider.mutations) { + buffer.writeln( + ' ${mutation.elementFieldName}.result!.stateOrNull!.reset();', + ); + } + buffer.writeln(''' + }'''); + } +} diff --git a/packages/riverpod_generator/lib/src/templates/mutation.dart b/packages/riverpod_generator/lib/src/templates/mutation.dart new file mode 100644 index 000000000..044ec019f --- /dev/null +++ b/packages/riverpod_generator/lib/src/templates/mutation.dart @@ -0,0 +1,100 @@ +import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; + +import '../riverpod_generator.dart'; +import '../type.dart'; +import 'element.dart'; +import 'parameters.dart'; +import 'template.dart'; + +class MutationTemplate extends Template { + MutationTemplate(this.mutation, this.provider); + + final Mutation mutation; + final ClassBasedProviderDeclaration provider; + + @override + void run(StringBuffer buffer) { + final parametersPassThrough = buildParamInvocationQuery({ + for (final parameter in mutation.node.parameters!.parameters) + parameter: parameter.name.toString(), + }); + + final mutationBase = switch (provider.createdType) { + SupportedCreatedType.future => r'$AsyncMutationBase', + SupportedCreatedType.stream => r'$AsyncMutationBase', + SupportedCreatedType.value => r'$SyncMutationBase', + }; + + buffer.writeln(''' +sealed class ${mutation.generatedMutationInterfaceName} extends MutationBase<${provider.valueTypeDisplayString}> { + /// Starts the mutation. + /// + /// This will first set the state to [PendingMutationState], then + /// will call [${provider.name}.${mutation.name}] with the provided parameters. + /// + /// After the method completes, the mutation state will be updated to either + /// [SuccessMutationState] or [ErrorMutationState] based on if the method + /// threw or not. + /// + /// Lastly, if the method completes without throwing, the Notifier's state + /// will be updated with the new value. + /// + /// **Note**: + /// If the notifier threw in its constructor, the mutation won't start + /// and [call] will throw. + /// This should generally never happen though, as Notifiers are not supposed + /// to have logic in their constructors. + Future<${provider.valueTypeDisplayString}> call${mutation.node.typeParameters.genericDefinitionDisplayString()}${mutation.node.parameters}; +} + +final class ${mutation.generatedMutationImplName} + extends $mutationBase<${provider.valueTypeDisplayString}, ${mutation.generatedMutationImplName}, ${provider.name}> + implements ${mutation.generatedMutationInterfaceName} { + ${mutation.generatedMutationImplName}(this.element, {super.state, super.key}); + + @override + final ${provider.generatedElementName} element; + + @override + ProxyElementValueListenable<${mutation.generatedMutationImplName}> get listenable => element.${mutation.elementFieldName}; + + @override + Future<${provider.valueTypeDisplayString}> call${mutation.node.typeParameters.genericDefinitionDisplayString()}${mutation.node.parameters} { + return mutateAsync( + ${_mutationInvocation()}, + (\$notifier) => \$notifier.${mutation.name}${mutation.node.typeParameters.genericUsageDisplayString()}($parametersPassThrough), + ); + } + + @override + ${mutation.generatedMutationImplName} copyWith(MutationState state, {Object? key}) => ${mutation.generatedMutationImplName}(element, state: state, key: key); +} +'''); + } + + String _mutationInvocation() { + final positional = mutation.node.parameters?.parameters + .where((e) => e.isPositional) + .map((e) => e.name!.lexeme) + .toList() ?? + const []; + Map? named = Map.fromEntries( + mutation.node.parameters?.parameters + .where((e) => e.isNamed) + .map((e) => MapEntry(e.name!.lexeme, e.name!.lexeme)) ?? + const [], + ); + + if (named.isEmpty) named = null; + + final typeParams = mutation.node.typeParameters?.typeParameters + .map((e) => e.name.lexeme) + .toList() ?? + const []; + if (typeParams.isEmpty) { + return 'Invocation.method(#${mutation.name}, $positional, ${named ?? ''})'; + } + + return 'Invocation.genericMethod(#${mutation.name}, $typeParams, $positional, ${named ?? ''})'; + } +} diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 3c0b49614..967f0303f 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -3,6 +3,7 @@ import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; import '../models.dart'; import '../riverpod_generator.dart'; import '../type.dart'; +import 'element.dart'; import 'parameters.dart'; import 'template.dart'; @@ -162,9 +163,9 @@ ${provider.doc} final class $name$_genericsDefinition buffer.writeln(''' @\$internal @override - ${provider.elementName}<${provider.valueTypeDisplayString}> \$createElement( + ${provider.internalElementName}<${provider.valueTypeDisplayString}> \$createElement( \$ProviderPointer pointer - ) => ${provider.elementName}(this, pointer); + ) => ${provider.internalElementName}(this, pointer); @override ${provider.providerTypeName}$_generics \$copyWithCreate( @@ -179,7 +180,7 @@ ${provider.doc} final class $name$_genericsDefinition _writeFunctionalCreate(buffer); - case ClassBasedProviderDeclaration(): + case ClassBasedProviderDeclaration(:final mutations): final notifierType = '${provider.name}$_generics'; buffer.writeln(''' @@ -208,16 +209,52 @@ ${provider.doc} final class $name$_genericsDefinition runNotifierBuildOverride: build ); } +'''); + + _classCreateElement(mutations, buffer, notifierType); + + for (final mutation in mutations) { + buffer.writeln(''' + ProviderListenable<${mutation.generatedMutationInterfaceName}> get ${mutation.name} + => LazyProxyListenable<${mutation.generatedMutationInterfaceName}, ${provider.exposedTypeDisplayString}>( + this, + (element) { + element as ${provider.generatedElementName}$_generics; + + return element.${mutation.elementFieldName}; + }, + ); + '''); + } + } + + _writeEqual(buffer); + } + void _classCreateElement( + List mutations, + StringBuffer buffer, + String notifierType, + ) { + if (mutations.isEmpty) { + buffer.writeln(''' @\$internal @override - ${provider.elementName}<$notifierType, ${provider.valueTypeDisplayString}> \$createElement( + ${provider.internalElementName}<$notifierType, ${provider.valueTypeDisplayString}> \$createElement( \$ProviderPointer pointer - ) => ${provider.elementName}(this, pointer); + ) => ${provider.internalElementName}(this, pointer); '''); + + return; } - _writeEqual(buffer); + buffer.writeln(''' + @\$internal + @override + ${provider.generatedElementName}$_generics \$createElement( + \$ProviderPointer pointer + ) => ${provider.generatedElementName}(this, pointer); +'''); } void _writeOverrideWithValue(StringBuffer buffer) { diff --git a/packages/riverpod_generator/pubspec.yaml b/packages/riverpod_generator/pubspec.yaml index f406faa3d..b1298ea90 100644 --- a/packages/riverpod_generator/pubspec.yaml +++ b/packages/riverpod_generator/pubspec.yaml @@ -16,6 +16,7 @@ dependencies: collection: ^1.15.0 crypto: ^3.0.2 meta: ^1.7.0 + mockito: ^5.4.4 path: ^1.8.0 riverpod_analyzer_utils: 1.0.0-dev.1 riverpod_annotation: 3.0.0-dev.3 diff --git a/packages/riverpod_generator/test/analysis_options.yaml b/packages/riverpod_generator/test/analysis_options.yaml new file mode 100644 index 000000000..ca4fba333 --- /dev/null +++ b/packages/riverpod_generator/test/analysis_options.yaml @@ -0,0 +1,5 @@ +include: ../analysis_options.yaml +analyzer: + errors: + # We have a tight constraint on Riverpod to use its internal APIs + invalid_use_of_internal_member: ignore diff --git a/packages/riverpod_generator/test/integration/mutation.dart b/packages/riverpod_generator/test/integration/mutation.dart new file mode 100644 index 000000000..08ccca44e --- /dev/null +++ b/packages/riverpod_generator/test/integration/mutation.dart @@ -0,0 +1,149 @@ +import 'package:riverpod/src/internals.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'mutation.g.dart'; + +@riverpod +class Simple extends _$Simple { + @override + int build() => 0; + + @mutation + Future increment([int inc = 1]) async => state + inc; + + @mutation + FutureOr incrementOr() => state + 1; + + @mutation + Future delegated(Future Function() fn) => fn(); +} + +@riverpod +class SimpleFamily extends _$SimpleFamily { + @override + int build(String arg) => 0; + + @mutation + Future increment([int inc = 1]) async => state + inc; + + @mutation + FutureOr incrementOr() => state + 1; +} + +@riverpod +class SimpleAsync extends _$SimpleAsync { + @override + Future build() async => 0; + + @mutation + Future increment([int inc = 1]) async => (await future) + inc; + + @mutation + Future delegated(Future Function() fn) async { + await future; + return fn(); + } +} + +@riverpod +class SimpleAsync2 extends _$SimpleAsync2 { + @override + Stream build(String arg) => Stream.value(0); + + @mutation + Future increment() async => (await future) + 1; +} + +@riverpod +class Generic extends _$Generic { + @override + Future build() async => 0; + + @mutation + Future increment() async => (await future) + 1; +} + +@riverpod +class GenericMut extends _$GenericMut { + @override + Future build() async => 0; + + @mutation + Future increment(T value) async => + (await future) + value.ceil(); +} + +@riverpod +class FailingCtor extends _$FailingCtor { + FailingCtor() { + throw StateError('err'); + } + + @override + int build() => 0; + + @mutation + Future increment([int inc = 1]) async => state + inc; +} + +// final mut = ref.watch(aProvider(arg).increment); +// mut(2); + +// class User { +// final String id; +// } + +// class UserSub extends User {} + +// class IList extends List {} + +// @Repository(retry: retry) +// class Users extends _$Users { +// @riverpod +// FutureOr byId(String id) => User(); + +// @riverpod +// Future> home() async => []; + +// @riverpod +// Future> search(String search) async => []; + +// @riverpod +// Future> search(String search) async => []; + +// @riverpod +// Future> search(String search) async => []; + +// @riverpod +// Stream> socketSearch(String search) async => []; + +// @mutation +// Future addUser(User user) async { +// return user; +// } +// } + +// abstract class Repository { +// Map> _all; + +// KeyT key(StateT state); + +// void build(Ref ref); +// } + +// abstract class _$Users extends Repository { +// // User has a .id, so we automatically pick it up as the key +// @override +// String key(User user) => user.id; + +// @override +// void build(ref) { +// observe(providerOrFamily, onAdd: (provider, key, value) { +// ref.mutate((state) => state.add(value)); +// }, onUpdate); +// } +// } + +// // ref.watch(usersProvider.byId('123')); +// // ref.watch(usersProvider.home); +// // ref.watch(usersProvider.search('john')); diff --git a/packages/riverpod_generator/test/integration/mutation.g.dart b/packages/riverpod_generator/test/integration/mutation.g.dart new file mode 100644 index 000000000..e229d3876 --- /dev/null +++ b/packages/riverpod_generator/test/integration/mutation.g.dart @@ -0,0 +1,1593 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'mutation.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +@ProviderFor(Simple) +const simpleProvider = SimpleProvider._(); + +final class SimpleProvider extends $NotifierProvider { + const SimpleProvider._( + {super.runNotifierBuildOverride, Simple Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'simpleProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Simple Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$simpleHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Simple create() => _createCb?.call() ?? Simple(); + + @$internal + @override + SimpleProvider $copyWithCreate( + Simple Function() create, + ) { + return SimpleProvider._(create: create); + } + + @$internal + @override + SimpleProvider $copyWithBuild( + int Function( + Ref, + Simple, + ) build, + ) { + return SimpleProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + _$SimpleElement $createElement($ProviderPointer pointer) => + _$SimpleElement(this, pointer); + + ProviderListenable get increment => + LazyProxyListenable( + this, + (element) { + element as _$SimpleElement; + + return element._$increment; + }, + ); + + ProviderListenable get incrementOr => + LazyProxyListenable( + this, + (element) { + element as _$SimpleElement; + + return element._$incrementOr; + }, + ); + + ProviderListenable get delegated => + LazyProxyListenable( + this, + (element) { + element as _$SimpleElement; + + return element._$delegated; + }, + ); +} + +String _$simpleHash() => r'c84cd9b6e3b09516b19316b0b21ea5ba5bc08a07'; + +abstract class _$Simple extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +class _$SimpleElement extends $NotifierProviderElement { + _$SimpleElement(super.provider, super.pointer) { + _$increment.result = Result.data(_$Simple$Increment(this)); + _$incrementOr.result = Result.data(_$Simple$IncrementOr(this)); + _$delegated.result = Result.data(_$Simple$Delegated(this)); + } + final _$increment = ProxyElementValueListenable<_$Simple$Increment>(); + final _$incrementOr = ProxyElementValueListenable<_$Simple$IncrementOr>(); + final _$delegated = ProxyElementValueListenable<_$Simple$Delegated>(); + @override + void mount() { + super.mount(); + _$increment.result!.stateOrNull!.reset(); + _$incrementOr.result!.stateOrNull!.reset(); + _$delegated.result!.stateOrNull!.reset(); + } + + @override + void visitChildren({ + required void Function(ProviderElement element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); + + listenableVisitor(_$increment); + listenableVisitor(_$incrementOr); + listenableVisitor(_$delegated); + } +} + +sealed class Simple$Increment extends MutationBase { + /// Starts the mutation. + /// + /// This will first set the state to [PendingMutationState], then + /// will call [Simple.increment] with the provided parameters. + /// + /// After the method completes, the mutation state will be updated to either + /// [SuccessMutationState] or [ErrorMutationState] based on if the method + /// threw or not. + /// + /// Lastly, if the method completes without throwing, the Notifier's state + /// will be updated with the new value. + /// + /// **Note**: + /// If the notifier threw in its constructor, the mutation won't start + /// and [call] will throw. + /// This should generally never happen though, as Notifiers are not supposed + /// to have logic in their constructors. + Future call([int inc = 1]); +} + +final class _$Simple$Increment + extends $SyncMutationBase + implements Simple$Increment { + _$Simple$Increment(this.element, {super.state, super.key}); + + @override + final _$SimpleElement element; + + @override + ProxyElementValueListenable<_$Simple$Increment> get listenable => + element._$increment; + + @override + Future call([int inc = 1]) { + return mutateAsync( + Invocation.method( + #increment, + [inc], + ), + ($notifier) => $notifier.increment( + inc, + ), + ); + } + + @override + _$Simple$Increment copyWith(MutationState state, {Object? key}) => + _$Simple$Increment(element, state: state, key: key); +} + +sealed class Simple$IncrementOr extends MutationBase { + /// Starts the mutation. + /// + /// This will first set the state to [PendingMutationState], then + /// will call [Simple.incrementOr] with the provided parameters. + /// + /// After the method completes, the mutation state will be updated to either + /// [SuccessMutationState] or [ErrorMutationState] based on if the method + /// threw or not. + /// + /// Lastly, if the method completes without throwing, the Notifier's state + /// will be updated with the new value. + /// + /// **Note**: + /// If the notifier threw in its constructor, the mutation won't start + /// and [call] will throw. + /// This should generally never happen though, as Notifiers are not supposed + /// to have logic in their constructors. + Future call(); +} + +final class _$Simple$IncrementOr + extends $SyncMutationBase + implements Simple$IncrementOr { + _$Simple$IncrementOr(this.element, {super.state, super.key}); + + @override + final _$SimpleElement element; + + @override + ProxyElementValueListenable<_$Simple$IncrementOr> get listenable => + element._$incrementOr; + + @override + Future call() { + return mutateAsync( + Invocation.method( + #incrementOr, + [], + ), + ($notifier) => $notifier.incrementOr(), + ); + } + + @override + _$Simple$IncrementOr copyWith(MutationState state, {Object? key}) => + _$Simple$IncrementOr(element, state: state, key: key); +} + +sealed class Simple$Delegated extends MutationBase { + /// Starts the mutation. + /// + /// This will first set the state to [PendingMutationState], then + /// will call [Simple.delegated] with the provided parameters. + /// + /// After the method completes, the mutation state will be updated to either + /// [SuccessMutationState] or [ErrorMutationState] based on if the method + /// threw or not. + /// + /// Lastly, if the method completes without throwing, the Notifier's state + /// will be updated with the new value. + /// + /// **Note**: + /// If the notifier threw in its constructor, the mutation won't start + /// and [call] will throw. + /// This should generally never happen though, as Notifiers are not supposed + /// to have logic in their constructors. + Future call(Future Function() fn); +} + +final class _$Simple$Delegated + extends $SyncMutationBase + implements Simple$Delegated { + _$Simple$Delegated(this.element, {super.state, super.key}); + + @override + final _$SimpleElement element; + + @override + ProxyElementValueListenable<_$Simple$Delegated> get listenable => + element._$delegated; + + @override + Future call(Future Function() fn) { + return mutateAsync( + Invocation.method( + #delegated, + [fn], + ), + ($notifier) => $notifier.delegated( + fn, + ), + ); + } + + @override + _$Simple$Delegated copyWith(MutationState state, {Object? key}) => + _$Simple$Delegated(element, state: state, key: key); +} + +@ProviderFor(SimpleFamily) +const simpleFamilyProvider = SimpleFamilyFamily._(); + +final class SimpleFamilyProvider extends $NotifierProvider { + const SimpleFamilyProvider._( + {required SimpleFamilyFamily super.from, + required String super.argument, + super.runNotifierBuildOverride, + SimpleFamily Function()? create}) + : _createCb = create, + super( + retry: null, + name: r'simpleFamilyProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final SimpleFamily Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$simpleFamilyHash(); + + @override + String toString() { + return r'simpleFamilyProvider' + '' + '($argument)'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + SimpleFamily create() => _createCb?.call() ?? SimpleFamily(); + + @$internal + @override + SimpleFamilyProvider $copyWithCreate( + SimpleFamily Function() create, + ) { + return SimpleFamilyProvider._( + argument: argument as String, + from: from! as SimpleFamilyFamily, + create: create); + } + + @$internal + @override + SimpleFamilyProvider $copyWithBuild( + int Function( + Ref, + SimpleFamily, + ) build, + ) { + return SimpleFamilyProvider._( + argument: argument as String, + from: from! as SimpleFamilyFamily, + runNotifierBuildOverride: build); + } + + @$internal + @override + _$SimpleFamilyElement $createElement($ProviderPointer pointer) => + _$SimpleFamilyElement(this, pointer); + + ProviderListenable get increment => + LazyProxyListenable( + this, + (element) { + element as _$SimpleFamilyElement; + + return element._$increment; + }, + ); + + ProviderListenable get incrementOr => + LazyProxyListenable( + this, + (element) { + element as _$SimpleFamilyElement; + + return element._$incrementOr; + }, + ); + + @override + bool operator ==(Object other) { + return other is SimpleFamilyProvider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$simpleFamilyHash() => r'7f7a9985568e147b78fbcd6ed7691a6677f75aeb'; + +final class SimpleFamilyFamily extends Family { + const SimpleFamilyFamily._() + : super( + retry: null, + name: r'simpleFamilyProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + SimpleFamilyProvider call( + String arg, + ) => + SimpleFamilyProvider._(argument: arg, from: this); + + @override + String debugGetCreateSourceHash() => _$simpleFamilyHash(); + + @override + String toString() => r'simpleFamilyProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + SimpleFamily Function( + String args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (pointer) { + final provider = pointer.origin as SimpleFamilyProvider; + + final argument = provider.argument as String; + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(pointer); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + int Function(Ref ref, SimpleFamily notifier, String argument) build, + ) { + return $FamilyOverride( + from: this, + createElement: (pointer) { + final provider = pointer.origin as SimpleFamilyProvider; + + final argument = provider.argument as String; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(pointer); + }, + ); + } +} + +abstract class _$SimpleFamily extends $Notifier { + late final _$args = ref.$arg as String; + String get arg => _$args; + + int build( + String arg, + ); + @$internal + @override + int runBuild() => build( + _$args, + ); +} + +class _$SimpleFamilyElement + extends $NotifierProviderElement { + _$SimpleFamilyElement(super.provider, super.pointer) { + _$increment.result = Result.data(_$SimpleFamily$Increment(this)); + _$incrementOr.result = Result.data(_$SimpleFamily$IncrementOr(this)); + } + final _$increment = ProxyElementValueListenable<_$SimpleFamily$Increment>(); + final _$incrementOr = + ProxyElementValueListenable<_$SimpleFamily$IncrementOr>(); + @override + void mount() { + super.mount(); + _$increment.result!.stateOrNull!.reset(); + _$incrementOr.result!.stateOrNull!.reset(); + } + + @override + void visitChildren({ + required void Function(ProviderElement element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); + + listenableVisitor(_$increment); + listenableVisitor(_$incrementOr); + } +} + +sealed class SimpleFamily$Increment extends MutationBase { + /// Starts the mutation. + /// + /// This will first set the state to [PendingMutationState], then + /// will call [SimpleFamily.increment] with the provided parameters. + /// + /// After the method completes, the mutation state will be updated to either + /// [SuccessMutationState] or [ErrorMutationState] based on if the method + /// threw or not. + /// + /// Lastly, if the method completes without throwing, the Notifier's state + /// will be updated with the new value. + /// + /// **Note**: + /// If the notifier threw in its constructor, the mutation won't start + /// and [call] will throw. + /// This should generally never happen though, as Notifiers are not supposed + /// to have logic in their constructors. + Future call([int inc = 1]); +} + +final class _$SimpleFamily$Increment + extends $SyncMutationBase + implements SimpleFamily$Increment { + _$SimpleFamily$Increment(this.element, {super.state, super.key}); + + @override + final _$SimpleFamilyElement element; + + @override + ProxyElementValueListenable<_$SimpleFamily$Increment> get listenable => + element._$increment; + + @override + Future call([int inc = 1]) { + return mutateAsync( + Invocation.method( + #increment, + [inc], + ), + ($notifier) => $notifier.increment( + inc, + ), + ); + } + + @override + _$SimpleFamily$Increment copyWith(MutationState state, {Object? key}) => + _$SimpleFamily$Increment(element, state: state, key: key); +} + +sealed class SimpleFamily$IncrementOr extends MutationBase { + /// Starts the mutation. + /// + /// This will first set the state to [PendingMutationState], then + /// will call [SimpleFamily.incrementOr] with the provided parameters. + /// + /// After the method completes, the mutation state will be updated to either + /// [SuccessMutationState] or [ErrorMutationState] based on if the method + /// threw or not. + /// + /// Lastly, if the method completes without throwing, the Notifier's state + /// will be updated with the new value. + /// + /// **Note**: + /// If the notifier threw in its constructor, the mutation won't start + /// and [call] will throw. + /// This should generally never happen though, as Notifiers are not supposed + /// to have logic in their constructors. + Future call(); +} + +final class _$SimpleFamily$IncrementOr + extends $SyncMutationBase + implements SimpleFamily$IncrementOr { + _$SimpleFamily$IncrementOr(this.element, {super.state, super.key}); + + @override + final _$SimpleFamilyElement element; + + @override + ProxyElementValueListenable<_$SimpleFamily$IncrementOr> get listenable => + element._$incrementOr; + + @override + Future call() { + return mutateAsync( + Invocation.method( + #incrementOr, + [], + ), + ($notifier) => $notifier.incrementOr(), + ); + } + + @override + _$SimpleFamily$IncrementOr copyWith(MutationState state, + {Object? key}) => + _$SimpleFamily$IncrementOr(element, state: state, key: key); +} + +@ProviderFor(SimpleAsync) +const simpleAsyncProvider = SimpleAsyncProvider._(); + +final class SimpleAsyncProvider + extends $AsyncNotifierProvider { + const SimpleAsyncProvider._( + {super.runNotifierBuildOverride, SimpleAsync Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'simpleAsyncProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final SimpleAsync Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$simpleAsyncHash(); + + @$internal + @override + SimpleAsync create() => _createCb?.call() ?? SimpleAsync(); + + @$internal + @override + SimpleAsyncProvider $copyWithCreate( + SimpleAsync Function() create, + ) { + return SimpleAsyncProvider._(create: create); + } + + @$internal + @override + SimpleAsyncProvider $copyWithBuild( + FutureOr Function( + Ref, + SimpleAsync, + ) build, + ) { + return SimpleAsyncProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + _$SimpleAsyncElement $createElement($ProviderPointer pointer) => + _$SimpleAsyncElement(this, pointer); + + ProviderListenable get increment => + LazyProxyListenable>( + this, + (element) { + element as _$SimpleAsyncElement; + + return element._$increment; + }, + ); + + ProviderListenable get delegated => + LazyProxyListenable>( + this, + (element) { + element as _$SimpleAsyncElement; + + return element._$delegated; + }, + ); +} + +String _$simpleAsyncHash() => r'ed00b8e5170e48855d0b3cddddabd316fef466cf'; + +abstract class _$SimpleAsync extends $AsyncNotifier { + FutureOr build(); + @$internal + @override + FutureOr runBuild() => build(); +} + +class _$SimpleAsyncElement + extends $AsyncNotifierProviderElement { + _$SimpleAsyncElement(super.provider, super.pointer) { + _$increment.result = Result.data(_$SimpleAsync$Increment(this)); + _$delegated.result = Result.data(_$SimpleAsync$Delegated(this)); + } + final _$increment = ProxyElementValueListenable<_$SimpleAsync$Increment>(); + final _$delegated = ProxyElementValueListenable<_$SimpleAsync$Delegated>(); + @override + void mount() { + super.mount(); + _$increment.result!.stateOrNull!.reset(); + _$delegated.result!.stateOrNull!.reset(); + } + + @override + void visitChildren({ + required void Function(ProviderElement element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); + + listenableVisitor(_$increment); + listenableVisitor(_$delegated); + } +} + +sealed class SimpleAsync$Increment extends MutationBase { + /// Starts the mutation. + /// + /// This will first set the state to [PendingMutationState], then + /// will call [SimpleAsync.increment] with the provided parameters. + /// + /// After the method completes, the mutation state will be updated to either + /// [SuccessMutationState] or [ErrorMutationState] based on if the method + /// threw or not. + /// + /// Lastly, if the method completes without throwing, the Notifier's state + /// will be updated with the new value. + /// + /// **Note**: + /// If the notifier threw in its constructor, the mutation won't start + /// and [call] will throw. + /// This should generally never happen though, as Notifiers are not supposed + /// to have logic in their constructors. + Future call([int inc = 1]); +} + +final class _$SimpleAsync$Increment + extends $AsyncMutationBase + implements SimpleAsync$Increment { + _$SimpleAsync$Increment(this.element, {super.state, super.key}); + + @override + final _$SimpleAsyncElement element; + + @override + ProxyElementValueListenable<_$SimpleAsync$Increment> get listenable => + element._$increment; + + @override + Future call([int inc = 1]) { + return mutateAsync( + Invocation.method( + #increment, + [inc], + ), + ($notifier) => $notifier.increment( + inc, + ), + ); + } + + @override + _$SimpleAsync$Increment copyWith(MutationState state, {Object? key}) => + _$SimpleAsync$Increment(element, state: state, key: key); +} + +sealed class SimpleAsync$Delegated extends MutationBase { + /// Starts the mutation. + /// + /// This will first set the state to [PendingMutationState], then + /// will call [SimpleAsync.delegated] with the provided parameters. + /// + /// After the method completes, the mutation state will be updated to either + /// [SuccessMutationState] or [ErrorMutationState] based on if the method + /// threw or not. + /// + /// Lastly, if the method completes without throwing, the Notifier's state + /// will be updated with the new value. + /// + /// **Note**: + /// If the notifier threw in its constructor, the mutation won't start + /// and [call] will throw. + /// This should generally never happen though, as Notifiers are not supposed + /// to have logic in their constructors. + Future call(Future Function() fn); +} + +final class _$SimpleAsync$Delegated + extends $AsyncMutationBase + implements SimpleAsync$Delegated { + _$SimpleAsync$Delegated(this.element, {super.state, super.key}); + + @override + final _$SimpleAsyncElement element; + + @override + ProxyElementValueListenable<_$SimpleAsync$Delegated> get listenable => + element._$delegated; + + @override + Future call(Future Function() fn) { + return mutateAsync( + Invocation.method( + #delegated, + [fn], + ), + ($notifier) => $notifier.delegated( + fn, + ), + ); + } + + @override + _$SimpleAsync$Delegated copyWith(MutationState state, {Object? key}) => + _$SimpleAsync$Delegated(element, state: state, key: key); +} + +@ProviderFor(SimpleAsync2) +const simpleAsync2Provider = SimpleAsync2Family._(); + +final class SimpleAsync2Provider + extends $StreamNotifierProvider { + const SimpleAsync2Provider._( + {required SimpleAsync2Family super.from, + required String super.argument, + super.runNotifierBuildOverride, + SimpleAsync2 Function()? create}) + : _createCb = create, + super( + retry: null, + name: r'simpleAsync2Provider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final SimpleAsync2 Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$simpleAsync2Hash(); + + @override + String toString() { + return r'simpleAsync2Provider' + '' + '($argument)'; + } + + @$internal + @override + SimpleAsync2 create() => _createCb?.call() ?? SimpleAsync2(); + + @$internal + @override + SimpleAsync2Provider $copyWithCreate( + SimpleAsync2 Function() create, + ) { + return SimpleAsync2Provider._( + argument: argument as String, + from: from! as SimpleAsync2Family, + create: create); + } + + @$internal + @override + SimpleAsync2Provider $copyWithBuild( + Stream Function( + Ref, + SimpleAsync2, + ) build, + ) { + return SimpleAsync2Provider._( + argument: argument as String, + from: from! as SimpleAsync2Family, + runNotifierBuildOverride: build); + } + + @$internal + @override + _$SimpleAsync2Element $createElement($ProviderPointer pointer) => + _$SimpleAsync2Element(this, pointer); + + ProviderListenable get increment => + LazyProxyListenable>( + this, + (element) { + element as _$SimpleAsync2Element; + + return element._$increment; + }, + ); + + @override + bool operator ==(Object other) { + return other is SimpleAsync2Provider && other.argument == argument; + } + + @override + int get hashCode { + return argument.hashCode; + } +} + +String _$simpleAsync2Hash() => r'7b372f85f3e4f1c2a954402b82a9a7b68bbc1407'; + +final class SimpleAsync2Family extends Family { + const SimpleAsync2Family._() + : super( + retry: null, + name: r'simpleAsync2Provider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + SimpleAsync2Provider call( + String arg, + ) => + SimpleAsync2Provider._(argument: arg, from: this); + + @override + String debugGetCreateSourceHash() => _$simpleAsync2Hash(); + + @override + String toString() => r'simpleAsync2Provider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + SimpleAsync2 Function( + String args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (pointer) { + final provider = pointer.origin as SimpleAsync2Provider; + + final argument = provider.argument as String; + + return provider + .$copyWithCreate(() => create(argument)) + .$createElement(pointer); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + Stream Function(Ref ref, SimpleAsync2 notifier, String argument) build, + ) { + return $FamilyOverride( + from: this, + createElement: (pointer) { + final provider = pointer.origin as SimpleAsync2Provider; + + final argument = provider.argument as String; + + return provider + .$copyWithBuild((ref, notifier) => build(ref, notifier, argument)) + .$createElement(pointer); + }, + ); + } +} + +abstract class _$SimpleAsync2 extends $StreamNotifier { + late final _$args = ref.$arg as String; + String get arg => _$args; + + Stream build( + String arg, + ); + @$internal + @override + Stream runBuild() => build( + _$args, + ); +} + +class _$SimpleAsync2Element + extends $StreamNotifierProviderElement { + _$SimpleAsync2Element(super.provider, super.pointer) { + _$increment.result = Result.data(_$SimpleAsync2$Increment(this)); + } + final _$increment = ProxyElementValueListenable<_$SimpleAsync2$Increment>(); + @override + void mount() { + super.mount(); + _$increment.result!.stateOrNull!.reset(); + } + + @override + void visitChildren({ + required void Function(ProviderElement element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); + + listenableVisitor(_$increment); + } +} + +sealed class SimpleAsync2$Increment extends MutationBase { + /// Starts the mutation. + /// + /// This will first set the state to [PendingMutationState], then + /// will call [SimpleAsync2.increment] with the provided parameters. + /// + /// After the method completes, the mutation state will be updated to either + /// [SuccessMutationState] or [ErrorMutationState] based on if the method + /// threw or not. + /// + /// Lastly, if the method completes without throwing, the Notifier's state + /// will be updated with the new value. + /// + /// **Note**: + /// If the notifier threw in its constructor, the mutation won't start + /// and [call] will throw. + /// This should generally never happen though, as Notifiers are not supposed + /// to have logic in their constructors. + Future call(); +} + +final class _$SimpleAsync2$Increment + extends $AsyncMutationBase + implements SimpleAsync2$Increment { + _$SimpleAsync2$Increment(this.element, {super.state, super.key}); + + @override + final _$SimpleAsync2Element element; + + @override + ProxyElementValueListenable<_$SimpleAsync2$Increment> get listenable => + element._$increment; + + @override + Future call() { + return mutateAsync( + Invocation.method( + #increment, + [], + ), + ($notifier) => $notifier.increment(), + ); + } + + @override + _$SimpleAsync2$Increment copyWith(MutationState state, {Object? key}) => + _$SimpleAsync2$Increment(element, state: state, key: key); +} + +@ProviderFor(Generic) +const genericProvider = GenericFamily._(); + +final class GenericProvider + extends $AsyncNotifierProvider, int> { + const GenericProvider._( + {required GenericFamily super.from, + super.runNotifierBuildOverride, + Generic Function()? create}) + : _createCb = create, + super( + argument: null, + retry: null, + name: r'genericProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Generic Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$genericHash(); + + GenericProvider _copyWithCreate( + Generic Function() create, + ) { + return GenericProvider._( + from: from! as GenericFamily, create: create); + } + + GenericProvider _copyWithBuild( + FutureOr Function( + Ref, + Generic, + ) build, + ) { + return GenericProvider._( + from: from! as GenericFamily, runNotifierBuildOverride: build); + } + + @override + String toString() { + return r'genericProvider' + '<${T}>' + '()'; + } + + @$internal + @override + Generic create() => _createCb?.call() ?? Generic(); + + @$internal + @override + GenericProvider $copyWithCreate( + Generic Function() create, + ) { + return GenericProvider._(from: from! as GenericFamily, create: create); + } + + @$internal + @override + GenericProvider $copyWithBuild( + FutureOr Function( + Ref, + Generic, + ) build, + ) { + return GenericProvider._( + from: from! as GenericFamily, runNotifierBuildOverride: build); + } + + @$internal + @override + _$GenericElement $createElement($ProviderPointer pointer) => + _$GenericElement(this, pointer); + + ProviderListenable get increment => + LazyProxyListenable>( + this, + (element) { + element as _$GenericElement; + + return element._$increment; + }, + ); + + @override + bool operator ==(Object other) { + return other is GenericProvider && + other.runtimeType == runtimeType && + other.argument == argument; + } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } +} + +String _$genericHash() => r'4089b4d9b08bfff0256ad67cf35780a6409f7a87'; + +final class GenericFamily extends Family { + const GenericFamily._() + : super( + retry: null, + name: r'genericProvider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + GenericProvider call() => GenericProvider._(from: this); + + @override + String debugGetCreateSourceHash() => _$genericHash(); + + @override + String toString() => r'genericProvider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + Generic Function() create, + ) { + return $FamilyOverride( + from: this, + createElement: (pointer) { + final provider = pointer.origin as GenericProvider; + + return provider._copyWithCreate(create).$createElement(pointer); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + FutureOr Function(Ref ref, Generic notifier) build, + ) { + return $FamilyOverride( + from: this, + createElement: (pointer) { + final provider = pointer.origin as GenericProvider; + + return provider._copyWithBuild(build).$createElement(pointer); + }, + ); + } +} + +abstract class _$Generic extends $AsyncNotifier { + FutureOr build(); + @$internal + @override + FutureOr runBuild() => build(); +} + +class _$GenericElement + extends $AsyncNotifierProviderElement, int> { + _$GenericElement(super.provider, super.pointer) { + _$increment.result = Result.data(_$Generic$Increment(this)); + } + final _$increment = ProxyElementValueListenable<_$Generic$Increment>(); + @override + void mount() { + super.mount(); + _$increment.result!.stateOrNull!.reset(); + } + + @override + void visitChildren({ + required void Function(ProviderElement element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); + + listenableVisitor(_$increment); + } +} + +sealed class Generic$Increment extends MutationBase { + /// Starts the mutation. + /// + /// This will first set the state to [PendingMutationState], then + /// will call [Generic.increment] with the provided parameters. + /// + /// After the method completes, the mutation state will be updated to either + /// [SuccessMutationState] or [ErrorMutationState] based on if the method + /// threw or not. + /// + /// Lastly, if the method completes without throwing, the Notifier's state + /// will be updated with the new value. + /// + /// **Note**: + /// If the notifier threw in its constructor, the mutation won't start + /// and [call] will throw. + /// This should generally never happen though, as Notifiers are not supposed + /// to have logic in their constructors. + Future call(); +} + +final class _$Generic$Increment + extends $AsyncMutationBase + implements Generic$Increment { + _$Generic$Increment(this.element, {super.state, super.key}); + + @override + final _$GenericElement element; + + @override + ProxyElementValueListenable<_$Generic$Increment> get listenable => + element._$increment; + + @override + Future call() { + return mutateAsync( + Invocation.method( + #increment, + [], + ), + ($notifier) => $notifier.increment(), + ); + } + + @override + _$Generic$Increment copyWith(MutationState state, {Object? key}) => + _$Generic$Increment(element, state: state, key: key); +} + +@ProviderFor(GenericMut) +const genericMutProvider = GenericMutProvider._(); + +final class GenericMutProvider extends $AsyncNotifierProvider { + const GenericMutProvider._( + {super.runNotifierBuildOverride, GenericMut Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'genericMutProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final GenericMut Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$genericMutHash(); + + @$internal + @override + GenericMut create() => _createCb?.call() ?? GenericMut(); + + @$internal + @override + GenericMutProvider $copyWithCreate( + GenericMut Function() create, + ) { + return GenericMutProvider._(create: create); + } + + @$internal + @override + GenericMutProvider $copyWithBuild( + FutureOr Function( + Ref, + GenericMut, + ) build, + ) { + return GenericMutProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + _$GenericMutElement $createElement($ProviderPointer pointer) => + _$GenericMutElement(this, pointer); + + ProviderListenable get increment => + LazyProxyListenable>( + this, + (element) { + element as _$GenericMutElement; + + return element._$increment; + }, + ); +} + +String _$genericMutHash() => r'43acfc1b7cf59fb05f31ed4c2d5470422198feb0'; + +abstract class _$GenericMut extends $AsyncNotifier { + FutureOr build(); + @$internal + @override + FutureOr runBuild() => build(); +} + +class _$GenericMutElement + extends $AsyncNotifierProviderElement { + _$GenericMutElement(super.provider, super.pointer) { + _$increment.result = Result.data(_$GenericMut$Increment(this)); + } + final _$increment = ProxyElementValueListenable<_$GenericMut$Increment>(); + @override + void mount() { + super.mount(); + _$increment.result!.stateOrNull!.reset(); + } + + @override + void visitChildren({ + required void Function(ProviderElement element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); + + listenableVisitor(_$increment); + } +} + +sealed class GenericMut$Increment extends MutationBase { + /// Starts the mutation. + /// + /// This will first set the state to [PendingMutationState], then + /// will call [GenericMut.increment] with the provided parameters. + /// + /// After the method completes, the mutation state will be updated to either + /// [SuccessMutationState] or [ErrorMutationState] based on if the method + /// threw or not. + /// + /// Lastly, if the method completes without throwing, the Notifier's state + /// will be updated with the new value. + /// + /// **Note**: + /// If the notifier threw in its constructor, the mutation won't start + /// and [call] will throw. + /// This should generally never happen though, as Notifiers are not supposed + /// to have logic in their constructors. + Future call(T value); +} + +final class _$GenericMut$Increment + extends $AsyncMutationBase + implements GenericMut$Increment { + _$GenericMut$Increment(this.element, {super.state, super.key}); + + @override + final _$GenericMutElement element; + + @override + ProxyElementValueListenable<_$GenericMut$Increment> get listenable => + element._$increment; + + @override + Future call(T value) { + return mutateAsync( + Invocation.genericMethod( + #increment, + [T], + [value], + ), + ($notifier) => $notifier.increment( + value, + ), + ); + } + + @override + _$GenericMut$Increment copyWith(MutationState state, {Object? key}) => + _$GenericMut$Increment(element, state: state, key: key); +} + +@ProviderFor(FailingCtor) +const failingCtorProvider = FailingCtorProvider._(); + +final class FailingCtorProvider extends $NotifierProvider { + const FailingCtorProvider._( + {super.runNotifierBuildOverride, FailingCtor Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'failingCtorProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final FailingCtor Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$failingCtorHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(int value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + FailingCtor create() => _createCb?.call() ?? FailingCtor(); + + @$internal + @override + FailingCtorProvider $copyWithCreate( + FailingCtor Function() create, + ) { + return FailingCtorProvider._(create: create); + } + + @$internal + @override + FailingCtorProvider $copyWithBuild( + int Function( + Ref, + FailingCtor, + ) build, + ) { + return FailingCtorProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + _$FailingCtorElement $createElement($ProviderPointer pointer) => + _$FailingCtorElement(this, pointer); + + ProviderListenable get increment => + LazyProxyListenable( + this, + (element) { + element as _$FailingCtorElement; + + return element._$increment; + }, + ); +} + +String _$failingCtorHash() => r'6cdef257a2d783fa5a606b411be0d23744766cdc'; + +abstract class _$FailingCtor extends $Notifier { + int build(); + @$internal + @override + int runBuild() => build(); +} + +class _$FailingCtorElement extends $NotifierProviderElement { + _$FailingCtorElement(super.provider, super.pointer) { + _$increment.result = Result.data(_$FailingCtor$Increment(this)); + } + final _$increment = ProxyElementValueListenable<_$FailingCtor$Increment>(); + @override + void mount() { + super.mount(); + _$increment.result!.stateOrNull!.reset(); + } + + @override + void visitChildren({ + required void Function(ProviderElement element) elementVisitor, + required void Function(ProxyElementValueListenable element) + listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); + + listenableVisitor(_$increment); + } +} + +sealed class FailingCtor$Increment extends MutationBase { + /// Starts the mutation. + /// + /// This will first set the state to [PendingMutationState], then + /// will call [FailingCtor.increment] with the provided parameters. + /// + /// After the method completes, the mutation state will be updated to either + /// [SuccessMutationState] or [ErrorMutationState] based on if the method + /// threw or not. + /// + /// Lastly, if the method completes without throwing, the Notifier's state + /// will be updated with the new value. + /// + /// **Note**: + /// If the notifier threw in its constructor, the mutation won't start + /// and [call] will throw. + /// This should generally never happen though, as Notifiers are not supposed + /// to have logic in their constructors. + Future call([int inc = 1]); +} + +final class _$FailingCtor$Increment + extends $SyncMutationBase + implements FailingCtor$Increment { + _$FailingCtor$Increment(this.element, {super.state, super.key}); + + @override + final _$FailingCtorElement element; + + @override + ProxyElementValueListenable<_$FailingCtor$Increment> get listenable => + element._$increment; + + @override + Future call([int inc = 1]) { + return mutateAsync( + Invocation.method( + #increment, + [inc], + ), + ($notifier) => $notifier.increment( + inc, + ), + ); + } + + @override + _$FailingCtor$Increment copyWith(MutationState state, {Object? key}) => + _$FailingCtor$Increment(element, state: state, key: key); +} + +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/mock.dart b/packages/riverpod_generator/test/mock.dart new file mode 100644 index 000000000..04efbf137 --- /dev/null +++ b/packages/riverpod_generator/test/mock.dart @@ -0,0 +1,201 @@ +import 'package:mockito/mockito.dart'; +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:test/test.dart'; + +class ListenerMock with Mock { + void call(Object? a, Object? b); +} + +typedef VerifyOnly = VerificationResult Function( + Mock mock, + T matchingInvocations, +); + +/// Syntax sugar for: +/// +/// ```dart +/// verify(mock()).called(1); +/// verifyNoMoreInteractions(mock); +/// ``` +VerifyOnly get verifyOnly { + final verification = verify; + + return (mock, invocation) { + final result = verification(invocation); + result.called(1); + verifyNoMoreInteractions(mock); + return result; + }; +} + +TypeMatcher> isMutationBase({ + TypeMatcher>? state, +}) { + var matcher = isA>(); + + if (state != null) { + matcher = matcher.having((e) => e.state, 'state', state); + } + + return matcher; +} + +TypeMatcher> isIdleMutationState() { + return isA>(); +} + +TypeMatcher> isPendingMutationState() { + return isA>(); +} + +TypeMatcher> isSuccessMutationState(T value) { + return isA>().having((e) => e.value, 'value', value); +} + +TypeMatcher> isErrorMutationState(Object error) { + return isA>().having((e) => e.error, 'error', error); +} + +enum InvocationKind { + method, + getter, + setter, +} + +TypeMatcher isInvocation({ + Object? memberName, + List? positionalArguments, + Map? namedArguments, + Object? typeArguments, + InvocationKind? kind, +}) { + var matcher = isA(); + + if (kind != null) { + switch (kind) { + case InvocationKind.method: + matcher = matcher.having((e) => e.isMethod, 'isMethod', true); + case InvocationKind.getter: + matcher = matcher.having((e) => e.isGetter, 'isGetter', true); + case InvocationKind.setter: + matcher = matcher.having((e) => e.isSetter, 'isSetter', true); + } + } + + if (typeArguments != null) { + matcher = matcher.having( + (e) => e.typeArguments, + 'typeArguments', + typeArguments, + ); + } + + if (memberName != null) { + matcher = matcher.having((e) => e.memberName, 'memberName', memberName); + } + + if (positionalArguments != null) { + matcher = matcher.having( + (e) => e.positionalArguments, + 'positionalArguments', + positionalArguments, + ); + } + + if (namedArguments != null) { + matcher = matcher.having( + (e) => e.namedArguments, + 'namedArguments', + namedArguments, + ); + } + + return matcher; +} + +class ObserverMock extends Mock implements ProviderObserver { + ObserverMock([this.label]); + + final String? label; + + @override + String toString() { + return label ?? super.toString(); + } + + @override + void didAddProvider( + ProviderObserverContext? context, + Object? value, + ); + + @override + void providerDidFail( + ProviderObserverContext? context, + Object? error, + StackTrace? stackTrace, + ); + + @override + void didUpdateProvider( + ProviderObserverContext? context, + Object? previousValue, + Object? newValue, + ); + + @override + void didDisposeProvider(ProviderObserverContext? context); + + @override + void mutationReset(ProviderObserverContext? context); + + @override + void mutationStart( + ProviderObserverContext? context, + MutationContext? mutation, + ); + + @override + void mutationError( + ProviderObserverContext? context, + MutationContext? mutation, + Object? error, + StackTrace? stackTrace, + ); + + @override + void mutationSuccess( + ProviderObserverContext? context, + MutationContext? mutation, + Object? result, + ); +} + +TypeMatcher isProviderObserverContext( + Object? provider, + Object? container, { + required Object? mutation, +}) { + var matcher = isA(); + + matcher = matcher.having((e) => e.provider, 'provider', provider); + matcher = matcher.having((e) => e.container, 'container', container); + matcher = matcher.having((e) => e.mutation, 'mutation', mutation); + + return matcher; +} + +TypeMatcher isMutationContext( + Object? invocation, { + Object? notifier, +}) { + var matcher = isA(); + + matcher = matcher.having((e) => e.invocation, 'invocation', invocation); + if (notifier != null) { + matcher = matcher.having((e) => e.notifier, 'notifier', notifier); + } + + return matcher; +} diff --git a/packages/riverpod_generator/test/mutation_test.dart b/packages/riverpod_generator/test/mutation_test.dart new file mode 100644 index 000000000..27c19696f --- /dev/null +++ b/packages/riverpod_generator/test/mutation_test.dart @@ -0,0 +1,513 @@ +import 'dart:async'; + +import 'package:mockito/mockito.dart'; +import 'package:riverpod/riverpod.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; +import 'package:test/test.dart'; + +import 'integration/mutation.dart'; +import 'mock.dart'; + +void main() { + test('Can listen a mutation', () async { + final container = ProviderContainer.test(); + final listener = ListenerMock(); + + final sub = container.listen( + simpleProvider.delegated, + listener.call, + fireImmediately: true, + ); + + verifyOnly( + listener, + listener(any, isMutationBase(state: isIdleMutationState())), + ); + + final future = sub.read().call(() async => 1); + + verifyOnly( + listener, + listener(any, isMutationBase(state: isPendingMutationState())), + ); + + expect(await future, 1); + + verifyOnly( + listener, + listener(any, isMutationBase(state: isSuccessMutationState(1))), + ); + + final future2 = sub.read().call(() => throw StateError('42')); + + await expectLater(future2, throwsA(isStateError)); + verifyInOrder([ + listener(any, isMutationBase(state: isPendingMutationState())), + listener( + any, + isMutationBase(state: isErrorMutationState(isStateError)), + ), + ]); + verifyNoMoreInteractions(listener); + }); + + test('Can listen a mutation with family', () async { + final container = ProviderContainer.test(); + final listener = ListenerMock(); + + final sub = + container.listen(simpleFamilyProvider('key').increment, listener.call); + + expect( + sub.read(), + isMutationBase(state: isIdleMutationState()), + ); + + final future = sub.read().call(2); + + expect( + sub.read(), + isMutationBase(state: isPendingMutationState()), + ); + + expect(await future, 2); + + expect( + sub.read(), + isMutationBase(state: isSuccessMutationState(2)), + ); + }); + + test('Supports generic mutations', () async { + final container = ProviderContainer.test(); + final listener = ListenerMock(); + + final sub = container.listen(genericMutProvider.increment, listener.call); + + expect( + sub.read(), + isMutationBase(state: isIdleMutationState()), + ); + + final future = sub.read().call(2.5); + + expect(await future, 3); + + expect( + sub.read(), + isMutationBase(state: isSuccessMutationState(3)), + ); + }); + + group('auto reset', () { + test('Automatically resets the state when all listeners are removed', + () async { + final container = ProviderContainer.test(); + + // The mutation should reset even if the provider is kept alive + container.listen(simpleProvider, (a, b) {}); + + final sub = container.listen(simpleProvider.increment, (a, b) {}); + final sub2 = container.listen(simpleProvider.increment, (a, b) {}); + + await sub.read().call(2); + + sub.close(); + await null; + + expect( + container.read(simpleProvider.increment), + isMutationBase(state: isSuccessMutationState(2)), + ); + + sub2.close(); + await null; + + expect( + container.read(simpleProvider.increment), + isMutationBase(state: isIdleMutationState()), + ); + }); + + test('is cancelled if a listener is added during the delay', () async { + final container = ProviderContainer.test(); + + final sub = container.listen(simpleProvider.increment, (a, b) {}); + + await sub.read().call(2); + sub.close(); + + container.listen(simpleProvider.increment, (a, b) {}); + await null; + + expect( + container.read(simpleProvider.increment), + isMutationBase(state: isSuccessMutationState(2)), + ); + }); + }); + + test('Maintains progress even if a provider is when the provider is reset', + () async { + final container = ProviderContainer.test(); + + final sub = container.listen(simpleProvider.increment, (a, b) {}); + + await sub.read().call(2); + container.invalidate(simpleProvider); + + expect( + sub.read(), + isMutationBase(state: isSuccessMutationState(2)), + ); + }); + + test('Supports getting called again while pending', () async { + final container = ProviderContainer.test(); + final sub = container.listen(simpleAsyncProvider.delegated, (a, b) {}); + + final completer = Completer(); + final completer2 = Completer(); + final completer3 = Completer(); + + final future = sub.read().call(() => completer.future); + final future2 = sub.read().call(() => completer2.future); + final future3 = sub.read().call(() => completer3.future); + + completer.complete(42); + + expect(await future, 42); + expect( + sub.read(), + isMutationBase(state: isPendingMutationState()), + ); + expect(container.read(simpleAsyncProvider), const AsyncData(42)); + + completer2.completeError(21); + await expectLater(future2, throwsA(21)); + expect( + sub.read(), + isMutationBase(state: isPendingMutationState()), + ); + expect(container.read(simpleAsyncProvider), const AsyncData(42)); + + completer3.complete(21); + expect(await future3, 21); + expect( + sub.read(), + isMutationBase(state: isSuccessMutationState(21)), + ); + expect(container.read(simpleAsyncProvider), const AsyncData(21)); + }); + + test('Listening to a mutation keeps the provider alive', () async { + final container = ProviderContainer.test(); + + final sub = container.listen(simpleProvider.increment, (a, b) {}); + + expect(container.read(simpleProvider), 0); + + await container.pump(); + expect(container.exists(simpleProvider), true); + + sub.close(); + + await container.pump(); + expect(container.exists(simpleProvider), false); + }); + + test('Listening a mutation lazily initializes the provider', () async { + final container = ProviderContainer.test(); + + final sub = container.listen(simpleProvider.increment, (a, b) {}); + + final element = container.readProviderElement(simpleProvider); + + expect(element.stateResult, null); + + await sub.read().call(2); + + expect(container.read(simpleProvider), 2); + }); + + test('If notifier constructor throws, the mutation immediately throws', + () async { + final observer = ObserverMock(); + final container = ProviderContainer.test(observers: [observer]); + + final sub = container.listen(failingCtorProvider.increment, (a, b) {}); + + expect(sub.read(), isMutationBase(state: isIdleMutationState())); + + expect(() => sub.read().call(2), throwsStateError); + + expect( + sub.read(), + isMutationBase(state: isIdleMutationState()), + ); + verifyNever(observer.mutationError(any, any, any, any)); + }); + + group('reset', () { + test('Supports calling reset while pending', () async { + final container = ProviderContainer.test(); + final sub = container.listen(simpleProvider.delegated, (a, b) {}); + + final completer = Completer(); + final future = sub.read().call(() => completer.future); + + sub.read().reset(); + + completer.complete(42); + + expect(await future, 42); + expect( + sub.read(), + isMutationBase(state: isIdleMutationState()), + ); + }); + + test('sets the state back to idle', () async { + final container = ProviderContainer.test(); + final listener = ListenerMock(); + + final sub = container.listen(simpleProvider.increment, listener.call); + + await sub.read().call(2); + + sub.read().reset(); + + expect( + sub.read(), + isMutationBase(state: isIdleMutationState()), + ); + }); + }); + + group('Integration with ProviderObserver', () { + test('handles generic methods', () async { + final observer = ObserverMock(); + final container = ProviderContainer.test( + observers: [observer], + ); + + container.listen(genericMutProvider, (a, b) {}); + container.listen(genericMutProvider.increment, (a, b) {}); + await container.read(genericMutProvider.future); + + clearInteractions(observer); + + await container.read(genericMutProvider.increment).call(42); + + verify( + observer.didUpdateProvider( + argThat( + isProviderObserverContext( + genericMutProvider, + container, + mutation: isMutationContext( + isInvocation( + memberName: #increment, + positionalArguments: [42.0], + kind: InvocationKind.method, + typeArguments: [double], + ), + ), + ), + ), + const AsyncData(0), + const AsyncData(42), + ), + ); + }); + + test('sends current mutation to didUpdateProvider', () async { + final observer = ObserverMock(); + final container = ProviderContainer.test( + observers: [observer], + ); + + final sub = container.listen(simpleProvider.notifier, (a, b) {}); + container.listen(simpleProvider.delegated, (a, b) {}); + + clearInteractions(observer); + + Future fn() async { + sub.read().state = 1; + return 42; + } + + await container.read(simpleProvider.delegated).call(fn); + + verifyInOrder([ + observer.didUpdateProvider( + argThat( + isProviderObserverContext( + simpleProvider, + container, + mutation: isMutationContext( + isInvocation( + memberName: #delegated, + positionalArguments: [fn], + kind: InvocationKind.method, + typeArguments: isEmpty, + ), + ), + ), + ), + 0, + 1, + ), + observer.didUpdateProvider( + argThat( + isProviderObserverContext( + simpleProvider, + container, + mutation: isMutationContext( + isInvocation( + memberName: #delegated, + positionalArguments: [fn], + kind: InvocationKind.method, + typeArguments: isEmpty, + ), + ), + ), + ), + 1, + 42, + ), + ]); + }); + + test('handles mutationStart/Pending/Success/Error/Reset', () async { + final observer = ObserverMock(); + final container = ProviderContainer.test( + observers: [observer], + ); + + container.listen(simpleProvider, (a, b) {}); + clearInteractions(observer); + + final sub = container.listen(simpleProvider.delegated, (a, b) {}); + verifyNoMoreInteractions(observer); + + Future fn() async => 42; + final stack = StackTrace.current; + final err = StateError('foo'); + Future fn2() async => Error.throwWithStackTrace(err, stack); + + final future = sub.read().call(fn); + verifyOnly( + observer, + observer.mutationStart( + argThat( + isProviderObserverContext( + simpleProvider, + container, + mutation: isNotNull, + ), + ), + argThat( + isMutationContext( + isInvocation( + memberName: #delegated, + positionalArguments: [fn], + kind: InvocationKind.method, + typeArguments: isEmpty, + ), + ), + ), + ), + ); + + await future; + + verify( + observer.mutationSuccess( + argThat( + isProviderObserverContext( + simpleProvider, + container, + mutation: isNotNull, + ), + ), + argThat( + isMutationContext( + isInvocation( + memberName: #delegated, + positionalArguments: [fn], + kind: InvocationKind.method, + typeArguments: isEmpty, + ), + ), + ), + 42, + ), + ); + + final future2 = sub.read().call(fn2); + + verify( + observer.mutationStart( + argThat( + isProviderObserverContext( + simpleProvider, + container, + mutation: isNotNull, + ), + ), + argThat( + isMutationContext( + isInvocation( + memberName: #delegated, + positionalArguments: [fn2], + kind: InvocationKind.method, + typeArguments: isEmpty, + ), + ), + ), + ), + ); + + await expectLater(future2, throwsA(isStateError)); + + verify( + observer.mutationError( + argThat( + isProviderObserverContext( + simpleProvider, + container, + mutation: isNotNull, + ), + ), + argThat( + isMutationContext( + isInvocation( + memberName: #delegated, + positionalArguments: [fn2], + kind: InvocationKind.method, + typeArguments: isEmpty, + ), + ), + ), + err, + stack, + ), + ); + + sub.read().reset(); + + verify( + observer.mutationReset( + argThat( + isProviderObserverContext( + simpleProvider, + container, + mutation: isNull, + ), + ), + ), + ); + }); + }); +} diff --git a/website/docs/concepts/provider_observer_logger.dart b/website/docs/concepts/provider_observer_logger.dart index 8ab5ecbae..8aa41b77c 100644 --- a/website/docs/concepts/provider_observer_logger.dart +++ b/website/docs/concepts/provider_observer_logger.dart @@ -11,14 +11,13 @@ import 'package:flutter_riverpod/legacy.dart'; class Logger extends ProviderObserver { @override void didUpdateProvider( - ProviderBase provider, + ProviderObserverContext context, Object? previousValue, Object? newValue, - ProviderContainer container, ) { print(''' { - "provider": "${provider.name ?? provider.runtimeType}", + "provider": "${context.provider.name ?? context.provider.runtimeType}", "newValue": "$newValue" }'''); } diff --git a/website/docs/essentials/provider_observer/provider_observer.dart b/website/docs/essentials/provider_observer/provider_observer.dart index dd75afb01..27c668b2c 100644 --- a/website/docs/essentials/provider_observer/provider_observer.dart +++ b/website/docs/essentials/provider_observer/provider_observer.dart @@ -6,38 +6,34 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; class MyObserver extends ProviderObserver { @override void didAddProvider( - ProviderBase provider, + ProviderObserverContext context, Object? value, - ProviderContainer container, ) { - print('Provider $provider was initialized with $value'); + print('Provider ${context.provider} was initialized with $value'); } @override - void didDisposeProvider( - ProviderBase provider, - ProviderContainer container, - ) { - print('Provider $provider was disposed'); + void didDisposeProvider(ProviderObserverContext context) { + print('Provider ${context.provider} was disposed'); } @override void didUpdateProvider( - ProviderBase provider, + ProviderObserverContext context, Object? previousValue, Object? newValue, - ProviderContainer container, ) { - print('Provider $provider updated from $previousValue to $newValue'); + print( + 'Provider ${context.provider} updated from $previousValue to $newValue', + ); } @override void providerDidFail( - ProviderBase provider, + ProviderObserverContext context, Object error, StackTrace stackTrace, - ProviderContainer container, ) { - print('Provider $provider threw $error at $stackTrace'); + print('Provider ${context.provider} threw $error at $stackTrace'); } } From c21fee7b1575784774872453617c60da112a465d Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 9 Dec 2024 19:09:50 +0100 Subject: [PATCH 373/387] Add a way to unregister life-cycle listeners (#3862) --- packages/riverpod/CHANGELOG.md | 2 + packages/riverpod/lib/riverpod.dart | 1 - packages/riverpod/lib/src/core/devtool.dart | 17 --- .../src/core/provider/notifier_provider.dart | 6 +- .../lib/src/core/provider_container.dart | 5 - packages/riverpod/lib/src/core/ref.dart | 57 +++++--- packages/riverpod/lib/src/framework.dart | 2 +- .../src/core/provider_container_test.dart | 28 ---- packages/riverpod/test/src/core/ref_test.dart | 124 +++++++++++++++--- packages/riverpod/test/src/matrix.dart | 1 + .../test/src/matrix/notifier_provider.dart | 4 +- .../src/providers/async_notifier_test.dart | 65 +++++---- .../test/src/providers/notifier_test.dart | 54 ++++++-- .../src/providers/stream_notifier_test.dart | 65 +++++---- packages/riverpod/test/src/utils.dart | 2 + 15 files changed, 290 insertions(+), 143 deletions(-) delete mode 100644 packages/riverpod/lib/src/core/devtool.dart diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index d5fe7418c..5ded22860 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -24,6 +24,8 @@ - **Breaking**: A provider is now considered "paused" if all of its listeners are also paused. So if a provider `A` is watched _only_ by a provider `B`, and `B` is currently unused, then `A` will be paused. +- All `Ref` life-cycles (such as `Ref.onDispose`) and `Notifier.listenSelf` + now return a function to remove the listener. - Added methods to `ProviderObserver` for listening to "mutations". Mutations are a new code-generation-only feature. See riverpod_generator's changelog for more information. diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 439a701d0..531661a21 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -22,7 +22,6 @@ export 'src/framework.dart' ProviderElementProxy, OnError, ProviderContainerTest, - DebugRiverpodDevtoolBiding, TransitiveFamilyOverride, TransitiveProviderOverride, $ProviderPointer, diff --git a/packages/riverpod/lib/src/core/devtool.dart b/packages/riverpod/lib/src/core/devtool.dart deleted file mode 100644 index 6e483608d..000000000 --- a/packages/riverpod/lib/src/core/devtool.dart +++ /dev/null @@ -1,17 +0,0 @@ -part of '../framework.dart'; - -@internal -abstract class DebugRiverpodDevtoolBiding { - static final _containers = []; - - static List get containers => - UnmodifiableListView(_containers); - - static void addContainer(ProviderContainer container) { - _containers.add(container); - } - - static void removeContainer(ProviderContainer container) { - _containers.remove(container); - } -} diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index c671fcdea..b387f128d 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -65,12 +65,14 @@ abstract class NotifierBase { /// As opposed to [Ref.listen], the listener will be called even if /// [updateShouldNotify] returns false, meaning that the previous /// and new value can potentially be identical. + /// + /// Returns a function which can be called to remove the listener. @protected - void listenSelf( + RemoveListener listenSelf( void Function(StateT? previous, StateT next) listener, { void Function(Object error, StackTrace stackTrace)? onError, }) { - $ref.listenSelf(listener, onError: onError); + return $ref.listenSelf(listener, onError: onError); } @visibleForTesting diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 4954a782e..9900be895 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -636,7 +636,6 @@ class ProviderContainer implements Node { // This ensures that if an error is thrown, the parent & global state // are not affected. parent?._children.add(this); - if (kDebugMode) DebugRiverpodDevtoolBiding.addContainer(this); } /// An automatically disposed [ProviderContainer]. @@ -954,10 +953,6 @@ class ProviderContainer implements Node { for (final element in getAllProviderElementsInOrder().toList().reversed) { element.dispose(); } - - if (kDebugMode) { - DebugRiverpodDevtoolBiding.removeContainer(this); - } } /// Release all the resources associated with this [ProviderContainer]. diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index d48e4a879..b36fcf019 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -257,24 +257,32 @@ final = Provider(dependencies: []); /// A life-cycle for whenever a new listener is added to the provider. /// + /// Returns a function which can be called to remove the listener. + /// /// See also: /// - [onRemoveListener], for when a listener is removed - void onAddListener(void Function() cb) { + RemoveListener onAddListener(void Function() cb) { _throwIfInvalidUsage(); - _onAddListeners ??= []; - _onAddListeners!.add(cb); + final list = _onAddListeners ??= []; + list.add(cb); + + return () => list.remove(cb); } /// A life-cycle for whenever a listener is removed from the provider. /// + /// Returns a function which can be called to remove the listener. + /// /// See also: /// - [onAddListener], for when a listener is added - void onRemoveListener(void Function() cb) { + RemoveListener onRemoveListener(void Function() cb) { _throwIfInvalidUsage(); - _onRemoveListeners ??= []; - _onRemoveListeners!.add(cb); + final list = _onRemoveListeners ??= []; + list.add(cb); + + return () => list.remove(cb); } /// Add a listener to perform an operation when the last listener of the provider @@ -287,6 +295,8 @@ final = Provider(dependencies: []); /// _will_ get paused/dispose. It is possible that after the last listener /// is removed, a new listener is immediately added. /// + /// Returns a function which can be called to remove the listener. + /// /// See also: /// - [keepAlive], which can be combined with [onCancel] for /// advanced manipulation on when the provider should get disposed. @@ -294,16 +304,20 @@ final = Provider(dependencies: []); /// destroy its state when no longer listened to. /// - [onDispose], a life-cycle for when a provider is disposed. /// - [onResume], a life-cycle for when the provider is listened to again. - void onCancel(void Function() cb) { + RemoveListener onCancel(void Function() cb) { _throwIfInvalidUsage(); - _onCancelListeners ??= []; - _onCancelListeners!.add(cb); + final list = _onCancelListeners ??= []; + list.add(cb); + + return () => list.remove(cb); } /// A life-cycle for when a provider is listened again after it was paused /// (and [onCancel] was triggered). /// + /// Returns a function which can be called to remove the listener. + /// /// See also: /// - [keepAlive], which can be combined with [onCancel] for /// advanced manipulation on when the provider should get disposed. @@ -311,11 +325,13 @@ final = Provider(dependencies: []); /// destroy its state when no longer listened to. /// - [onDispose], a life-cycle for when a provider is disposed. /// - [onCancel], a life-cycle for when all listeners of a provider are removed. - void onResume(void Function() cb) { + RemoveListener onResume(void Function() cb) { _throwIfInvalidUsage(); - _onResumeListeners ??= []; - _onResumeListeners!.add(cb); + final list = _onResumeListeners ??= []; + list.add(cb); + + return () => list.remove(cb); } /// Adds a listener to perform an operation right before the provider is destroyed. @@ -357,6 +373,8 @@ final = Provider(dependencies: []); /// if an exception happens before [onDispose] is called, then /// some of your objects may not be disposed. /// + /// Returns a function which can be called to remove the listener. + /// /// See also: /// /// - [Provider.autoDispose], a modifier which tell a provider that it should @@ -364,11 +382,13 @@ final = Provider(dependencies: []); /// - [ProviderContainer.dispose], to destroy all providers associated with /// a [ProviderContainer] at once. /// - [onCancel], a life-cycle for when all listeners of a provider are removed. - void onDispose(void Function() listener) { + RemoveListener onDispose(void Function() listener) { _throwIfInvalidUsage(); - _onDisposeListeners ??= []; - _onDisposeListeners!.add(listener); + final list = _onDisposeListeners ??= []; + list.add(listener); + + return () => list.remove(listener); } /// Read the state associated with a provider, without listening to that provider. @@ -611,7 +631,7 @@ class _Ref extends Ref { /// As opposed to [listen], the listener will be called even if /// [ProviderElement.updateShouldNotify] returns false, meaning that the previous /// and new value can potentially be identical. - void listenSelf( + RemoveListener listenSelf( void Function(StateT? previous, StateT next) listener, { void Function(Object error, StackTrace stackTrace)? onError, }) { @@ -622,6 +642,11 @@ class _Ref extends Ref { _onErrorSelfListeners ??= []; _onErrorSelfListeners!.add(onError); } + + return () { + _onChangeSelfListeners?.remove(listener); + _onErrorSelfListeners?.remove(onError); + }; } } diff --git a/packages/riverpod/lib/src/framework.dart b/packages/riverpod/lib/src/framework.dart index 7a935e78b..c722c8cd9 100644 --- a/packages/riverpod/lib/src/framework.dart +++ b/packages/riverpod/lib/src/framework.dart @@ -6,6 +6,7 @@ import 'dart:math' as math; import 'package:collection/collection.dart'; import 'package:meta/meta.dart'; +import 'package:state_notifier/state_notifier.dart'; import 'package:test/test.dart' as test; import 'common/env.dart'; import 'common/pragma.dart'; @@ -27,5 +28,4 @@ part 'core/modifiers/select.dart'; part 'core/scheduler.dart'; part 'core/override_with_value.dart'; part 'core/override.dart'; -part 'core/devtool.dart'; part 'core/modifiers/future.dart'; diff --git a/packages/riverpod/test/src/core/provider_container_test.dart b/packages/riverpod/test/src/core/provider_container_test.dart index f73e1c619..ea4c0c8dd 100644 --- a/packages/riverpod/test/src/core/provider_container_test.dart +++ b/packages/riverpod/test/src/core/provider_container_test.dart @@ -81,11 +81,6 @@ TypeMatcher isProviderDirectory({ } void main() { - tearDown(() { - // Verifies that there is no container leak. - expect(DebugRiverpodDevtoolBiding.containers, isEmpty); - }); - group('ProviderPointerManager', () { group('findDeepestTransitiveDependencyProviderContainer', () { final transitiveDependency = Provider( @@ -1025,13 +1020,6 @@ void main() { ); }); - test('registers itself in the container list', () { - final container = ProviderContainer(); - addTearDown(container.dispose); - - expect(DebugRiverpodDevtoolBiding.containers, [container]); - }); - test('throws if "parent" is disposed', () { final root = ProviderContainer(); root.dispose(); @@ -1046,11 +1034,6 @@ void main() { isEmpty, reason: 'Invalid containers should not be added as children', ); - expect( - DebugRiverpodDevtoolBiding.containers, - isEmpty, - reason: 'Invalid containers should not be added to the global list', - ); }); test('if parent is null, assign "root" to "null"', () { @@ -1812,17 +1795,6 @@ void main() { expect(callCount, 0); }); - test('unregister itself from the container list', () { - final container = ProviderContainer(); - addTearDown(container.dispose); - - expect(DebugRiverpodDevtoolBiding.containers, [container]); - - container.dispose(); - - expect(DebugRiverpodDevtoolBiding.containers, isEmpty); - }); - test('Disposes its children first', () { final rootOnDispose = OnDisposeMock(); final childOnDispose = OnDisposeMock(); diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index f3610bfae..1377a78cb 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -351,24 +351,6 @@ void main() { }); }); - test("can't use ref inside onDispose", () { - final provider2 = Provider((ref) => 0); - final provider = Provider((ref) { - ref.onDispose(() { - ref.watch(provider2); - }); - return ref; - }); - final container = ProviderContainer.test(); - - container.read(provider); - - final errors = []; - runZonedGuarded(container.dispose, (err, _) => errors.add(err)); - - expect(errors, [isA()]); - }); - group( 'asserts that a provider cannot depend on a provider that is not in its dependencies:', () { @@ -2141,6 +2123,23 @@ void main() { }); group('.onRemoveListener', () { + test('returns a way to unregister the listener', () { + final container = ProviderContainer.test(); + final listener = OnRemoveListener(); + late RemoveListener remove; + final provider = Provider((ref) { + remove = ref.onRemoveListener(listener.call); + }); + + final sub = container.listen(provider, (previous, next) {}); + + remove(); + + sub.close(); + + verifyZeroInteractions(listener); + }); + test('is called on read', () { final container = ProviderContainer.test(); final listener = OnRemoveListener(); @@ -2319,6 +2318,24 @@ void main() { }); group('.onAddListener', () { + test('returns a way to unregister the listener', () { + final container = ProviderContainer.test(); + final listener = OnAddListener(); + late RemoveListener remove; + final provider = Provider((ref) { + remove = ref.onAddListener(listener.call); + }); + + container.listen(provider, (previous, next) {}); + clearInteractions(listener); + + remove(); + + container.listen(provider, (previous, next) {}); + + verifyZeroInteractions(listener); + }); + test('is called on read', () { final container = ProviderContainer.test(); final listener = OnAddListener(); @@ -2484,6 +2501,24 @@ void main() { }); group('.onResume', () { + test('returns a way to unregister the listener', () { + final container = ProviderContainer.test(); + final listener = OnResume(); + late RemoveListener remove; + final provider = Provider((ref) { + remove = ref.onResume(listener.call); + }); + + final sub = container.listen(provider, (previous, next) {}); + + remove(); + + sub.pause(); + sub.resume(); + + verifyZeroInteractions(listener); + }); + test('is not called on initial subscription', () { final container = ProviderContainer.test(); final listener = OnResume(); @@ -2675,6 +2710,23 @@ void main() { }); group('.onCancel', () { + test('returns a way to unregister the listener', () { + final container = ProviderContainer.test(); + final listener = OnCancelMock(); + late RemoveListener remove; + final provider = Provider((ref) { + remove = ref.onCancel(listener.call); + }); + + final sub = container.listen(provider, (previous, next) {}); + + remove(); + + sub.close(); + + verifyZeroInteractions(listener); + }); + test( 'is called when dependent is invalidated and was the only listener', // TODO deal with now that we have onPause @@ -2871,6 +2923,42 @@ void main() { }); group('.onDispose', () { + test('returns a way to unregister the listener', () async { + final container = ProviderContainer.test(); + final listener = OnDisposeMock(); + late RemoveListener remove; + final provider = Provider.autoDispose((ref) { + remove = ref.onDispose(listener.call); + }); + + final sub = container.listen(provider, (previous, next) {}); + + remove(); + + sub.close(); + await container.pump(); + + verifyZeroInteractions(listener); + }); + + test("can't use ref inside onDispose", () { + final provider2 = Provider((ref) => 0); + final provider = Provider((ref) { + ref.onDispose(() { + ref.watch(provider2); + }); + return ref; + }); + final container = ProviderContainer.test(); + + container.read(provider); + + final errors = []; + runZonedGuarded(container.dispose, (err, _) => errors.add(err)); + + expect(errors, [isA()]); + }); + test( 'calls all the listeners in order when the ProviderContainer is disposed', () { diff --git a/packages/riverpod/test/src/matrix.dart b/packages/riverpod/test/src/matrix.dart index 8643c0a61..202f2a010 100644 --- a/packages/riverpod/test/src/matrix.dart +++ b/packages/riverpod/test/src/matrix.dart @@ -1,6 +1,7 @@ import 'dart:async'; import 'package:riverpod/src/internals.dart'; +import 'package:state_notifier/state_notifier.dart'; import 'package:test/test.dart' hide Retry; part 'matrix/async_notifier_provider.dart'; diff --git a/packages/riverpod/test/src/matrix/notifier_provider.dart b/packages/riverpod/test/src/matrix/notifier_provider.dart index dd4299b51..bdc31dc61 100644 --- a/packages/riverpod/test/src/matrix/notifier_provider.dart +++ b/packages/riverpod/test/src/matrix/notifier_provider.dart @@ -126,7 +126,7 @@ abstract class TestNotifier implements $Notifier { set state(StateT value); @override - void listenSelf( + RemoveListener listenSelf( void Function(StateT? previous, StateT next) listener, { void Function(Object error, StackTrace stackTrace)? onError, }); @@ -149,7 +149,7 @@ class DeferredNotifier extends Notifier Ref get ref; @override - void listenSelf( + RemoveListener listenSelf( void Function(StateT? previous, StateT next) listener, { void Function(Object error, StackTrace stackTrace)? onError, }); diff --git a/packages/riverpod/test/src/providers/async_notifier_test.dart b/packages/riverpod/test/src/providers/async_notifier_test.dart index 497fc2609..cd66d250d 100644 --- a/packages/riverpod/test/src/providers/async_notifier_test.dart +++ b/packages/riverpod/test/src/providers/async_notifier_test.dart @@ -439,33 +439,54 @@ void main() { ); }); - test('supports listenSelf', () { - final listener = Listener>(); - final onError = ErrorListener(); - final provider = factory.simpleTestProvider((ref, self) { - self.listenSelf(listener.call, onError: onError.call); - Error.throwWithStackTrace(42, StackTrace.empty); + group('listenSelf', () { + test('can remove the listener', () async { + final container = ProviderContainer.test(); + final listener = Listener>(); + late final RemoveListener remove; + final provider = factory.simpleTestProvider((ref, self) { + remove = self.listenSelf(listener.call); + return 0; + }); + + container.listen(provider.notifier, (previous, next) {}); + clearInteractions(listener); + + remove(); + + container.read(provider.notifier).state = const AsyncData(42); + + verifyZeroInteractions(listener); }); - final container = ProviderContainer.test(); - container.listen(provider, (previous, next) {}); + test('supports listenSelf', () { + final listener = Listener>(); + final onError = ErrorListener(); + final provider = factory.simpleTestProvider((ref, self) { + self.listenSelf(listener.call, onError: onError.call); + Error.throwWithStackTrace(42, StackTrace.empty); + }); + final container = ProviderContainer.test(); - verifyOnly( - listener, - listener(null, const AsyncError(42, StackTrace.empty)), - ); - verifyZeroInteractions(onError); + container.listen(provider, (previous, next) {}); - container.read(provider.notifier).state = const AsyncData(42); + verifyOnly( + listener, + listener(null, const AsyncError(42, StackTrace.empty)), + ); + verifyZeroInteractions(onError); - verifyNoMoreInteractions(onError); - verifyOnly( - listener, - listener( - const AsyncError(42, StackTrace.empty), - const AsyncData(42), - ), - ); + container.read(provider.notifier).state = const AsyncData(42); + + verifyNoMoreInteractions(onError); + verifyOnly( + listener, + listener( + const AsyncError(42, StackTrace.empty), + const AsyncData(42), + ), + ); + }); }); test( diff --git a/packages/riverpod/test/src/providers/notifier_test.dart b/packages/riverpod/test/src/providers/notifier_test.dart index bbd164b7d..0d5dca1b8 100644 --- a/packages/riverpod/test/src/providers/notifier_test.dart +++ b/packages/riverpod/test/src/providers/notifier_test.dart @@ -435,18 +435,54 @@ void main() { expect(container.read(provider.notifier).state, 0); }); - test('supports listenSelf((State? prev, State next) {})', () { - final listener = Listener(); - final onError = ErrorListener(); - final provider = factory.simpleTestProvider((ref, self) { - self.listenSelf(listener.call, onError: onError.call); - Error.throwWithStackTrace(42, StackTrace.empty); + group('listenSelf', () { + test('can remove the data listener', () async { + final container = ProviderContainer.test(); + final listener = Listener(); + late final RemoveListener remove; + final provider = factory.simpleTestProvider((ref, self) { + remove = self.listenSelf(listener.call); + return 0; + }); + + container.listen(provider.notifier, (previous, next) {}); + clearInteractions(listener); + + remove(); + + container.read(provider.notifier).state = 42; + + verifyZeroInteractions(listener); + }); + + test('can remove the error listener', () async { + final container = ProviderContainer.test(); + final listener = ErrorListener(); + final provider = factory.simpleTestProvider((ref, self) { + final remove = self.listenSelf((a, b) {}, onError: listener.call); + remove(); + + throw StateError(''); + }); + + container.listen(provider.notifier, (previous, next) {}); + + verifyZeroInteractions(listener); }); - final container = ProviderContainer.test(); - expect(() => container.read(provider), throwsA(42)); + test('supports listenSelf((State? prev, State next) {})', () { + final listener = Listener(); + final onError = ErrorListener(); + final provider = factory.simpleTestProvider((ref, self) { + self.listenSelf(listener.call, onError: onError.call); + Error.throwWithStackTrace(42, StackTrace.empty); + }); + final container = ProviderContainer.test(); - verifyOnly(onError, onError(42, StackTrace.empty)); + expect(() => container.read(provider), throwsA(42)); + + verifyOnly(onError, onError(42, StackTrace.empty)); + }); }); test('filters state update by identical by default', () { diff --git a/packages/riverpod/test/src/providers/stream_notifier_test.dart b/packages/riverpod/test/src/providers/stream_notifier_test.dart index 6a6f93bc0..d73d4524b 100644 --- a/packages/riverpod/test/src/providers/stream_notifier_test.dart +++ b/packages/riverpod/test/src/providers/stream_notifier_test.dart @@ -360,33 +360,54 @@ void main() { ); }); - test('supports listenSelf', () { - final listener = Listener>(); - final onError = ErrorListener(); - final provider = factory.simpleTestProvider((ref, self) { - self.listenSelf(listener.call, onError: onError.call); - Error.throwWithStackTrace(42, StackTrace.empty); + group('listenSelf', () { + test('can remove the listener', () async { + final container = ProviderContainer.test(); + final listener = Listener>(); + late final RemoveListener remove; + final provider = factory.simpleTestProvider((ref, self) { + remove = self.listenSelf(listener.call); + return Stream.value(42); + }); + + container.listen(provider.notifier, (previous, next) {}); + clearInteractions(listener); + + remove(); + + container.read(provider.notifier).state = const AsyncData(42); + + verifyZeroInteractions(listener); }); - final container = ProviderContainer.test(); - container.listen(provider, (previous, next) {}); + test('supports listenSelf', () { + final listener = Listener>(); + final onError = ErrorListener(); + final provider = factory.simpleTestProvider((ref, self) { + self.listenSelf(listener.call, onError: onError.call); + Error.throwWithStackTrace(42, StackTrace.empty); + }); + final container = ProviderContainer.test(); - verifyOnly( - listener, - listener(null, const AsyncError(42, StackTrace.empty)), - ); - verifyZeroInteractions(onError); + container.listen(provider, (previous, next) {}); - container.read(provider.notifier).state = const AsyncData(42); + verifyOnly( + listener, + listener(null, const AsyncError(42, StackTrace.empty)), + ); + verifyZeroInteractions(onError); - verifyNoMoreInteractions(onError); - verifyOnly( - listener, - listener( - const AsyncError(42, StackTrace.empty), - const AsyncData(42), - ), - ); + container.read(provider.notifier).state = const AsyncData(42); + + verifyNoMoreInteractions(onError); + verifyOnly( + listener, + listener( + const AsyncError(42, StackTrace.empty), + const AsyncData(42), + ), + ); + }); }); test( diff --git a/packages/riverpod/test/src/utils.dart b/packages/riverpod/test/src/utils.dart index 5321322b3..bdabd4732 100644 --- a/packages/riverpod/test/src/utils.dart +++ b/packages/riverpod/test/src/utils.dart @@ -8,6 +8,8 @@ import 'package:test/test.dart' hide Retry; export '../old/utils.dart' show ObserverMock, isProviderObserverContext, isMutationContext; +typedef RemoveListener = void Function(); + List captureErrors(List cb) { final errors = []; for (final fn in cb) { From 459aec79afb19c46b991863219debccde016191f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 9 Dec 2024 19:19:43 +0100 Subject: [PATCH 374/387] Fix-3490 (#3863) fixes #3490 --- .../test/integration/async.dart | 18 ++ .../test/integration/async.g.dart | 242 ++++++++++++++++++ 2 files changed, 260 insertions(+) diff --git a/packages/riverpod_generator/test/integration/async.dart b/packages/riverpod_generator/test/integration/async.dart index 0672af81a..b9550f58f 100644 --- a/packages/riverpod_generator/test/integration/async.dart +++ b/packages/riverpod_generator/test/integration/async.dart @@ -92,3 +92,21 @@ class FamilyClass extends _$FamilyClass { return '(first: $first, second: $second, third: $third, fourth: $fourth, fifth: $fifth)'; } } + +// Regression test for https://github.com/rrousselGit/riverpod/issues/3490 +typedef Regression3490Cb = Future<(int, Cursor)> Function({ + Map filters, + Sort? sort, + Cursor? cursor, +}); + +@riverpod +class Regression3490 + extends _$Regression3490 { + @override + void build({ + required String type, + required Regression3490Cb getData, + String? parentId, + }) {} +} diff --git a/packages/riverpod_generator/test/integration/async.g.dart b/packages/riverpod_generator/test/integration/async.g.dart index 83b37b2b6..f98630ea7 100644 --- a/packages/riverpod_generator/test/integration/async.g.dart +++ b/packages/riverpod_generator/test/integration/async.g.dart @@ -1181,5 +1181,247 @@ abstract class _$FamilyClass extends $AsyncNotifier { ); } +@ProviderFor(Regression3490) +const regression3490Provider = Regression3490Family._(); + +final class Regression3490Provider + extends $NotifierProvider, void> { + const Regression3490Provider._( + {required Regression3490Family super.from, + required ({ + String type, + Regression3490Cb getData, + String? parentId, + }) + super.argument, + super.runNotifierBuildOverride, + Regression3490 Function()? create}) + : _createCb = create, + super( + retry: null, + name: r'regression3490Provider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Regression3490 Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$regression3490Hash(); + + Regression3490Provider _copyWithCreate( + Regression3490 Function() create, + ) { + return Regression3490Provider._( + argument: argument as ({ + String type, + Regression3490Cb getData, + String? parentId, + }), + from: from! as Regression3490Family, + create: create); + } + + Regression3490Provider _copyWithBuild( + void Function( + Ref, + Regression3490, + ) build, + ) { + return Regression3490Provider._( + argument: argument as ({ + String type, + Regression3490Cb getData, + String? parentId, + }), + from: from! as Regression3490Family, + runNotifierBuildOverride: build); + } + + @override + String toString() { + return r'regression3490Provider' + '<${Model}, ${Sort}, ${Cursor}>' + '$argument'; + } + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(void value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Regression3490 create() => + _createCb?.call() ?? Regression3490(); + + @$internal + @override + Regression3490Provider $copyWithCreate( + Regression3490 Function() create, + ) { + return Regression3490Provider._( + argument: argument as ({ + String type, + Regression3490Cb getData, + String? parentId, + }), + from: from! as Regression3490Family, + create: create); + } + + @$internal + @override + Regression3490Provider $copyWithBuild( + void Function( + Ref, + Regression3490, + ) build, + ) { + return Regression3490Provider._( + argument: argument as ({ + String type, + Regression3490Cb getData, + String? parentId, + }), + from: from! as Regression3490Family, + runNotifierBuildOverride: build); + } + + @$internal + @override + $NotifierProviderElement, void> + $createElement($ProviderPointer pointer) => + $NotifierProviderElement(this, pointer); + + @override + bool operator ==(Object other) { + return other is Regression3490Provider && + other.runtimeType == runtimeType && + other.argument == argument; + } + + @override + int get hashCode { + return Object.hash(runtimeType, argument); + } +} + +String _$regression3490Hash() => r'9d5d48cbde589961d0cdac395f68111ec17b194a'; + +final class Regression3490Family extends Family { + const Regression3490Family._() + : super( + retry: null, + name: r'regression3490Provider', + dependencies: null, + allTransitiveDependencies: null, + isAutoDispose: true, + ); + + Regression3490Provider call({ + required String type, + required Regression3490Cb getData, + String? parentId, + }) => + Regression3490Provider._(argument: ( + type: type, + getData: getData, + parentId: parentId, + ), from: this); + + @override + String debugGetCreateSourceHash() => _$regression3490Hash(); + + @override + String toString() => r'regression3490Provider'; + + /// {@macro riverpod.override_with} + Override overrideWith( + Regression3490 Function( + ({ + String type, + Regression3490Cb getData, + String? parentId, + }) args, + ) create, + ) { + return $FamilyOverride( + from: this, + createElement: (pointer) { + final provider = pointer.origin as Regression3490Provider; + + return provider._copyWithCreate(() { + final argument = provider.argument as ({ + String type, + Regression3490Cb getData, + String? parentId, + }); + + return create(argument); + }).$createElement(pointer); + }, + ); + } + + /// {@macro riverpod.override_with_build} + Override overrideWithBuild( + void Function( + Ref ref, + Regression3490 notifier, + ({ + String type, + Regression3490Cb getData, + String? parentId, + }) argument) + build, + ) { + return $FamilyOverride( + from: this, + createElement: (pointer) { + final provider = pointer.origin as Regression3490Provider; + + return provider._copyWithBuild((ref, notifier) { + final argument = provider.argument as ({ + String type, + Regression3490Cb getData, + String? parentId, + }); + + return build(ref, notifier, argument); + }).$createElement(pointer); + }, + ); + } +} + +abstract class _$Regression3490 extends $Notifier { + late final _$args = ref.$arg as ({ + String type, + Regression3490Cb getData, + String? parentId, + }); + String get type => _$args.type; + Regression3490Cb get getData => _$args.getData; + String? get parentId => _$args.parentId; + + void build({ + required String type, + required Regression3490Cb getData, + String? parentId, + }); + @$internal + @override + void runBuild() => build( + type: _$args.type, + getData: _$args.getData, + parentId: _$args.parentId, + ); +} + // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package From f2b304c4ef53a82b72503c5e9dc014bf2d3c35b8 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 9 Dec 2024 20:32:18 +0100 Subject: [PATCH 375/387] Auto add imports (#3864) fixes #3777 --- packages/riverpod_lint/CHANGELOG.md | 2 + .../convert_to_stateful_base_widget.dart | 17 +-- .../convert_to_stateless_base_widget.dart | 18 ++- .../src/assists/convert_to_widget_utils.dart | 54 ++++++-- .../lib/src/assists/wrap_with_consumer.dart | 5 +- .../src/assists/wrap_with_provider_scope.dart | 7 +- packages/riverpod_lint/lib/src/imports.dart | 128 ++++++++++++++++++ .../lib/src/lints/functional_ref.dart | 9 +- .../lib/src/lints/missing_provider_scope.dart | 6 +- .../lib/src/lints/provider_dependencies.dart | 13 +- 10 files changed, 218 insertions(+), 41 deletions(-) create mode 100644 packages/riverpod_lint/lib/src/imports.dart diff --git a/packages/riverpod_lint/CHANGELOG.md b/packages/riverpod_lint/CHANGELOG.md index de0da62e5..362ef3cd8 100644 --- a/packages/riverpod_lint/CHANGELOG.md +++ b/packages/riverpod_lint/CHANGELOG.md @@ -1,5 +1,7 @@ ## Unreleased build +- All lints/assists now automatically add the relevant imports when + updating code. - Updated `provider_dependencies` to support `@Dependencies` - added `riverpod_syntax_error`, for reporting errors when the generator would throw. - added `avoid_keep_alive_dependency_inside_auto_dispose` diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart index 05d2623a5..54ae9b287 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateful_base_widget.dart @@ -8,6 +8,7 @@ import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dar import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; +import '../imports.dart'; import '../riverpod_custom_lint.dart'; import 'convert_to_widget_utils.dart'; @@ -72,7 +73,7 @@ class ConvertToStatefulBaseWidget extends RiverpodAssist { ExtendsClause node, ) { final changeBuilder = reporter.createChangeBuilder( - message: 'Convert to ${targetWidget.widgetName}', + message: 'Convert to ${targetWidget.widgetAssistName}', priority: targetWidget.priority, ); @@ -80,7 +81,7 @@ class ConvertToStatefulBaseWidget extends RiverpodAssist { // Change the extended base class builder.addSimpleReplacement( node.superclass.sourceRange, - targetWidget.widgetName, + targetWidget.widgetName(builder), ); final widgetClass = node.thisOrAncestorOfType(); @@ -143,10 +144,10 @@ class ConvertToStatefulBaseWidget extends RiverpodAssist { switch (targetWidget) { case StatefulBaseWidgetType.consumerStatefulWidget: case StatefulBaseWidgetType.statefulHookConsumerWidget: - baseStateName = 'ConsumerState'; + baseStateName = builder.importConsumerState(); case StatefulBaseWidgetType.statefulHookWidget: case StatefulBaseWidgetType.statefulWidget: - baseStateName = 'State'; + baseStateName = builder.importState(); } // Split the class into two classes right before the build method @@ -178,7 +179,7 @@ class $createdStateClassName extends $baseStateName<${widgetClass.name}> { required int priorityAdjustment, }) { final changeBuilder = reporter.createChangeBuilder( - message: 'Convert to ${targetWidget.widgetName}', + message: 'Convert to ${targetWidget.widgetAssistName}', priority: targetWidget.priority + priorityAdjustment, ); @@ -186,7 +187,7 @@ class $createdStateClassName extends $baseStateName<${widgetClass.name}> { // Change the extended base class builder.addSimpleReplacement( node.superclass.sourceRange, - targetWidget.widgetName, + targetWidget.widgetName(builder), ); final widgetClass = node.thisOrAncestorOfType(); @@ -199,10 +200,10 @@ class $createdStateClassName extends $baseStateName<${widgetClass.name}> { switch (targetWidget) { case StatefulBaseWidgetType.consumerStatefulWidget: case StatefulBaseWidgetType.statefulHookConsumerWidget: - baseStateName = 'ConsumerState'; + baseStateName = builder.importConsumerState(); case StatefulBaseWidgetType.statefulHookWidget: case StatefulBaseWidgetType.statefulWidget: - baseStateName = 'State'; + baseStateName = builder.importState(); } final createStateMethod = widgetClass.members diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart index 1d1398c49..fbe82f958 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_stateless_base_widget.dart @@ -7,6 +7,7 @@ import 'package:analyzer/source/source_range.dart'; import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; +import '../imports.dart'; import '../riverpod_custom_lint.dart'; import 'convert_to_widget_utils.dart'; @@ -74,7 +75,7 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist { ExtendsClause node, ) { final changeBuilder = reporter.createChangeBuilder( - message: 'Convert to ${targetWidget.widgetName}', + message: 'Convert to ${targetWidget.assistName}', priority: targetWidget.priority, ); @@ -82,7 +83,7 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist { // Change the extended base class builder.addSimpleReplacement( node.superclass.sourceRange, - targetWidget.widgetName, + targetWidget.widgetName(builder), ); final buildMethod = node @@ -99,11 +100,13 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist { switch (targetWidget) { case StatelessBaseWidgetType.consumerWidget: case StatelessBaseWidgetType.hookConsumerWidget: + final widgetRef = builder.importWidgetRef(); + // If the build method has not a ref, add it if (buildParams.parameters.length == 1) { builder.addSimpleInsertion( buildParams.parameters.last.end, - ', WidgetRef ref', + ', $widgetRef ref', ); } case StatelessBaseWidgetType.hookWidget: @@ -128,7 +131,7 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist { required int priorityAdjustment, }) { final changeBuilder = reporter.createChangeBuilder( - message: 'Convert to ${targetWidget.widgetName}', + message: 'Convert to ${targetWidget.assistName}', priority: targetWidget.priority + priorityAdjustment, ); @@ -136,7 +139,7 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist { // Change the extended base class builder.addSimpleReplacement( node.superclass.sourceRange, - targetWidget.widgetName, + targetWidget.widgetName(builder), ); final widgetClass = node.thisOrAncestorOfType(); @@ -252,9 +255,10 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist { switch (targetWidget) { case StatelessBaseWidgetType.consumerWidget: case StatelessBaseWidgetType.hookConsumerWidget: + final widgetRef = builder.importWidgetRef(); builder.addSimpleReplacement( parameterRange, - 'BuildContext context, WidgetRef ref', + 'BuildContext context, $widgetRef ref', ); case StatelessBaseWidgetType.hookWidget: case StatelessBaseWidgetType.statelessWidget: @@ -275,7 +279,7 @@ class ConvertToStatelessBaseWidget extends RiverpodAssist { } } -// Original implemenation in +// Original implementation in // package:analysis_server/lib/src/services/correction/dart/flutter_convert_to_stateless_widget.dart class _FieldFinder extends RecursiveAstVisitor { final fieldsAssignedInConstructors = {}; diff --git a/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart b/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart index 11026c5fc..a75c299c9 100644 --- a/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart +++ b/packages/riverpod_lint/lib/src/assists/convert_to_widget_utils.dart @@ -1,13 +1,14 @@ import 'package:analyzer/dart/ast/ast.dart'; import 'package:analyzer/dart/element/element.dart'; +import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart'; import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; +import '../imports.dart'; import '../object_utils.dart'; enum StatelessBaseWidgetType { hookConsumerWidget( - widgetName: 'HookConsumerWidget', priority: 37, typeChecker: TypeChecker.fromName( 'HookConsumerWidget', @@ -16,7 +17,6 @@ enum StatelessBaseWidgetType { requiredPackage: 'hooks_riverpod', ), hookWidget( - widgetName: 'HookWidget', priority: 36, typeChecker: TypeChecker.fromName( 'HookWidget', @@ -25,7 +25,6 @@ enum StatelessBaseWidgetType { requiredPackage: 'flutter_hooks', ), consumerWidget( - widgetName: 'ConsumerWidget', priority: 35, typeChecker: TypeChecker.fromName( 'ConsumerWidget', @@ -33,7 +32,6 @@ enum StatelessBaseWidgetType { ), ), statelessWidget( - widgetName: 'StatelessWidget', priority: 34, typeChecker: TypeChecker.fromName( 'StatelessWidget', @@ -43,20 +41,39 @@ enum StatelessBaseWidgetType { ; const StatelessBaseWidgetType({ - required this.widgetName, required this.priority, required this.typeChecker, this.requiredPackage, }); - final String widgetName; + final int priority; final TypeChecker typeChecker; final String? requiredPackage; + + String widgetName(DartFileEditBuilder builder) { + return switch (this) { + StatelessBaseWidgetType.hookConsumerWidget => + builder.importHookConsumerWidget(), + StatelessBaseWidgetType.hookWidget => builder.importHookWidget(), + StatelessBaseWidgetType.consumerWidget => builder.importConsumerWidget(), + StatelessBaseWidgetType.statelessWidget => + builder.importStatelessWidget(), + }; + } + + String get assistName { + return switch (this) { + StatelessBaseWidgetType.hookConsumerWidget => 'HookConsumerWidget', + StatelessBaseWidgetType.hookWidget => 'HookWidget', + StatelessBaseWidgetType.consumerWidget => 'ConsumerWidget', + StatelessBaseWidgetType.statelessWidget => 'StatelessWidget', + }; + } } enum StatefulBaseWidgetType { statefulHookConsumerWidget( - widgetName: 'StatefulHookConsumerWidget', + widgetAssistName: 'StatefulHookConsumerWidget', priority: 33, typeChecker: TypeChecker.fromName( 'StatefulHookConsumerWidget', @@ -65,7 +82,7 @@ enum StatefulBaseWidgetType { requiredPackage: 'hooks_riverpod', ), statefulHookWidget( - widgetName: 'StatefulHookWidget', + widgetAssistName: 'StatefulHookWidget', priority: 32, typeChecker: TypeChecker.fromName( 'StatefulHookWidget', @@ -74,7 +91,7 @@ enum StatefulBaseWidgetType { requiredPackage: 'flutter_hooks', ), consumerStatefulWidget( - widgetName: 'ConsumerStatefulWidget', + widgetAssistName: 'ConsumerStatefulWidget', priority: 31, typeChecker: TypeChecker.fromName( 'ConsumerStatefulWidget', @@ -82,7 +99,7 @@ enum StatefulBaseWidgetType { ), ), statefulWidget( - widgetName: 'StatefulWidget', + widgetAssistName: 'StatefulWidget', priority: 30, typeChecker: TypeChecker.fromName( 'StatefulWidget', @@ -92,15 +109,28 @@ enum StatefulBaseWidgetType { ; const StatefulBaseWidgetType({ - required this.widgetName, + required this.widgetAssistName, required this.priority, required this.typeChecker, this.requiredPackage, }); - final String widgetName; + + final String widgetAssistName; final int priority; final TypeChecker typeChecker; final String? requiredPackage; + + String widgetName(DartFileEditBuilder builder) { + return switch (this) { + StatefulBaseWidgetType.statefulHookConsumerWidget => + builder.importStatefulHookConsumerWidget(), + StatefulBaseWidgetType.statefulHookWidget => + builder.importStatefulHookWidget(), + StatefulBaseWidgetType.consumerStatefulWidget => + builder.importConsumerStatefulWidget(), + StatefulBaseWidgetType.statefulWidget => builder.importStatefulWidget(), + }; + } } TypeChecker getStatelessBaseType({ diff --git a/packages/riverpod_lint/lib/src/assists/wrap_with_consumer.dart b/packages/riverpod_lint/lib/src/assists/wrap_with_consumer.dart index 6ac8fb383..823bea5d5 100644 --- a/packages/riverpod_lint/lib/src/assists/wrap_with_consumer.dart +++ b/packages/riverpod_lint/lib/src/assists/wrap_with_consumer.dart @@ -2,6 +2,7 @@ import 'package:analyzer/source/source_range.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import '../imports.dart'; import '../riverpod_custom_lint.dart'; /// Right above "wrap in builder" @@ -33,9 +34,11 @@ class WrapWithConsumer extends RiverpodAssist { ); changeBuilder.addDartFileEdit((builder) { + final consumer = builder.importConsumer(); + builder.addSimpleInsertion( node.offset, - 'Consumer(builder: (context, ref, child) { return ', + '$consumer(builder: (context, ref, child) { return ', ); builder.addSimpleInsertion(node.end, '; },)'); }); diff --git a/packages/riverpod_lint/lib/src/assists/wrap_with_provider_scope.dart b/packages/riverpod_lint/lib/src/assists/wrap_with_provider_scope.dart index 2c44bb97b..a95fd4bde 100644 --- a/packages/riverpod_lint/lib/src/assists/wrap_with_provider_scope.dart +++ b/packages/riverpod_lint/lib/src/assists/wrap_with_provider_scope.dart @@ -2,6 +2,7 @@ import 'package:analyzer/source/source_range.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import '../imports.dart'; import '../riverpod_custom_lint.dart'; import 'wrap_with_consumer.dart'; @@ -31,10 +32,8 @@ class WrapWithProviderScope extends RiverpodAssist { ); changeBuilder.addDartFileEdit((builder) { - builder.addSimpleInsertion( - node.offset, - 'ProviderScope(child: ', - ); + final providerScope = builder.importProviderScope(); + builder.addSimpleInsertion(node.offset, '$providerScope(child: '); builder.addSimpleInsertion(node.end, ',)'); }); }); diff --git a/packages/riverpod_lint/lib/src/imports.dart b/packages/riverpod_lint/lib/src/imports.dart new file mode 100644 index 000000000..6a5eff658 --- /dev/null +++ b/packages/riverpod_lint/lib/src/imports.dart @@ -0,0 +1,128 @@ +import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart'; +import 'package:meta/meta.dart'; + +extension ImportFix on DartFileEditBuilder { + // hybrid + @useResult + String importRef() => _importHybridRiverpod('Ref'); + + // flutter_riverpod + @useResult + String importWidgetRef() => _importFlutterRiverpod('WidgetRef'); + @useResult + String importConsumerStatefulWidget() => + _importFlutterRiverpod('ConsumerStatefulWidget'); + @useResult + String importConsumerWidget() => _importFlutterRiverpod('ConsumerWidget'); + @useResult + String importConsumerState() => _importFlutterRiverpod('ConsumerState'); + @useResult + String importConsumer() => _importFlutterRiverpod('Consumer'); + @useResult + String importProviderScope() => _importFlutterRiverpod('ProviderScope'); + + // flutter_hooks + @useResult + String importHookWidget() => _importFlutterHooks('HookWidget'); + +// hooks_riverpod + @useResult + String importHookConsumerWidget() => + _importHooksRiverpod('HookConsumerWidget'); + @useResult + String importStatefulHookConsumerWidget() => + _importHooksRiverpod('StatefulHookConsumerWidget'); + + // riverpod_annotation + @useResult + String importDependenciesClass() => _importRiverpodAnnotation('Dependencies'); + @useResult + String importRiverpod() => _importRiverpodAnnotation('riverpod'); + @useResult + String importRiverpodClass() => _importRiverpodAnnotation('Riverpod'); + + // Flutter widgets: + @useResult + String importState() => _importFlutterWidgets('State'); + @useResult + String importStatelessWidget() => _importFlutterWidgets('StatelessWidget'); + @useResult + String importStatefulHookWidget() => + _importFlutterWidgets('StatefulHookWidget'); + @useResult + String importStatefulWidget() => _importFlutterWidgets('StatefulWidget'); + + @useResult + String _importWithPrefix(String name, List uris) { + for (var i = 0; i < uris.length - 1; i++) { + final uri = uris[i]; + if (importsLibrary(uri)) return _buildImport(uri, name); + } + + final lastUri = uris.last; + return _buildImport(lastUri, name); + } + + @useResult + String _importHybridRiverpod(String name) { + return _importWithPrefix(name, [ + Uri(scheme: 'package', path: 'hooks_riverpod/hooks_riverpod.dart'), + Uri(scheme: 'package', path: 'flutter_riverpod/flutter_riverpod.dart'), + Uri( + scheme: 'package', + path: 'riverpod_annotation/riverpod_annotation.dart', + ), + Uri(scheme: 'package', path: 'riverpod/riverpod.dart'), + ]); + } + + @useResult + String _importHooksRiverpod(String name) { + return _importWithPrefix(name, [ + Uri(scheme: 'package', path: 'hooks_riverpod/hooks_riverpod.dart'), + ]); + } + + @useResult + String _importFlutterRiverpod(String name) { + return _importWithPrefix(name, [ + Uri(scheme: 'package', path: 'hooks_riverpod/hooks_riverpod.dart'), + Uri(scheme: 'package', path: 'flutter_riverpod/flutter_riverpod.dart'), + ]); + } + + @useResult + String _importRiverpodAnnotation(String name) { + return _importWithPrefix(name, [ + Uri( + scheme: 'package', + path: 'riverpod_annotation/riverpod_annotation.dart', + ), + ]); + } + + @useResult + String _importFlutterHooks(String name) { + return _importWithPrefix(name, [ + Uri(scheme: 'package', path: 'flutter_hooks/flutter_hooks.dart'), + ]); + } + + @useResult + String _importFlutterWidgets(String name) { + return _importWithPrefix(name, [ + Uri(scheme: 'package', path: 'flutter/cupertino.dart'), + Uri(scheme: 'package', path: 'flutter/material.dart'), + Uri(scheme: 'package', path: 'flutter/widgets.dart'), + ]); + } + + String _buildImport(Uri uri, String name) { + final import = importLibraryElement(uri); + + final prefix = import.prefix; + if (prefix != null) return '$prefix.$name'; + + return name; + } +} diff --git a/packages/riverpod_lint/lib/src/lints/functional_ref.dart b/packages/riverpod_lint/lib/src/lints/functional_ref.dart index ad8278f8d..35c46f1e5 100644 --- a/packages/riverpod_lint/lib/src/lints/functional_ref.dart +++ b/packages/riverpod_lint/lib/src/lints/functional_ref.dart @@ -8,6 +8,7 @@ import 'package:analyzer/error/listener.dart'; import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; +import '../imports.dart'; import '../riverpod_custom_lint.dart'; class FunctionalRef extends RiverpodLintRule { @@ -87,7 +88,8 @@ class FunctionalRefFix extends RiverpodFix { ); changeBuilder.addDartFileEdit((builder) { - var toInsert = 'Ref ref'; + final ref = builder.importRef(); + var toInsert = '$ref ref'; if (refNode != null) { toInsert = '$toInsert, '; } @@ -109,8 +111,9 @@ class FunctionalRefFix extends RiverpodFix { ); changeBuilder.addDartFileEdit((builder) { + final ref = builder.importRef(); if (!refNode.isExplicitlyTyped) { - builder.addSimpleInsertion(refNode.name!.offset, 'Ref '); + builder.addSimpleInsertion(refNode.name!.offset, '$ref '); return; } @@ -120,7 +123,7 @@ class FunctionalRefFix extends RiverpodFix { start: type.offset, end: refNode.name!.offset, ), - 'Ref ', + '$ref ', ); }); }); diff --git a/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart b/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart index 76270b87b..31ece5de2 100644 --- a/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart +++ b/packages/riverpod_lint/lib/src/lints/missing_provider_scope.dart @@ -9,6 +9,7 @@ import 'package:collection/collection.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import '../imports.dart'; import '../riverpod_custom_lint.dart'; import 'scoped_providers_should_specify_dependencies.dart'; @@ -63,7 +64,7 @@ class AddProviderScope extends DartFix { List others, ) { context.registry.addMethodInvocation((node) { - // The method is not impacte by this analysis error + // The method is not impact by this analysis error if (!node.sourceRange.intersects(analysisError.sourceRange)) return; final changeBuilder = reporter.createChangeBuilder( @@ -72,12 +73,13 @@ class AddProviderScope extends DartFix { ); changeBuilder.addDartFileEdit((builder) { + final providerScope = builder.importProviderScope(); final firstArgument = node.argumentList.arguments.firstOrNull; if (firstArgument == null) return; builder.addSimpleInsertion( firstArgument.offset, - 'ProviderScope(child: ', + '$providerScope(child: ', ); builder.addSimpleInsertion(firstArgument.end, ')'); }); diff --git a/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart b/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart index af555ef47..defd93d77 100644 --- a/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart +++ b/packages/riverpod_lint/lib/src/lints/provider_dependencies.dart @@ -10,6 +10,7 @@ import 'package:analyzer_plugin/utilities/range_factory.dart'; import 'package:custom_lint_builder/custom_lint_builder.dart'; import 'package:riverpod_analyzer_utils/riverpod_analyzer_utils.dart'; +import '../imports.dart'; import '../object_utils.dart'; import '../riverpod_custom_lint.dart'; @@ -356,9 +357,10 @@ class _ProviderDependenciesFix extends RiverpodFix { if (riverpodAnnotation case final riverpod?) { _riverpodSpecifyDependencies(builder, riverpod, newDependencies); } else { + final dep = builder.importDependenciesClass(); builder.addSimpleInsertion( data.list.node.offset, - '@Dependencies($newDependencies)\n', + '@$dep($newDependencies)\n', ); } }); @@ -383,9 +385,10 @@ class _ProviderDependenciesFix extends RiverpodFix { '[$dependencies]', ); } else { + final dep = builder.importDependenciesClass(); builder.addSimpleReplacement( data.list.dependencies!.node.sourceRange, - '@Dependencies($newDependencies)', + '@$dep($newDependencies)', ); } }); @@ -396,12 +399,13 @@ class _ProviderDependenciesFix extends RiverpodFix { RiverpodAnnotation riverpod, ) { if (riverpod.keepAliveNode == null) { + final _riverpod = builder.importRiverpod(); // Only "dependencies" is specified in the annotation. // So instead of @Riverpod(dependencies: []) -> @Riverpod(), // we can do @Riverpod(dependencies: []) -> @riverpod builder.addSimpleReplacement( riverpod.node.sourceRange, - '@riverpod', + '@$_riverpod', ); return; } @@ -423,10 +427,11 @@ class _ProviderDependenciesFix extends RiverpodFix { ) { final annotationArguments = riverpod.node.arguments; if (annotationArguments == null) { + final _riverpod = builder.importRiverpodClass(); // No argument list found. We are using the @riverpod annotation. builder.addSimpleReplacement( riverpod.node.sourceRange, - '@Riverpod(dependencies: $newDependencies)', + '@$_riverpod(dependencies: $newDependencies)', ); } else { // Argument list found, we are using the @Riverpod() annotation From 24894de321b85352bbde91140ca37ec3dcf5bbf2 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 9 Dec 2024 21:21:43 +0100 Subject: [PATCH 376/387] Imports --- .../flutter_riverpod/lib/src/builders.dart | 2 + .../build_yaml/lib/dependencies.dart | 1 - .../integration/build_yaml/lib/main.dart | 1 - .../test/integration/async.dart | 1 - .../test/integration/auto_dispose.dart | 1 - .../test/integration/dependencies.dart | 1 - .../test/integration/dependencies2.dart | 1 - .../test/integration/hash/hash1.dart | 1 - .../test/integration/split.dart | 3 +- .../test/integration/stream.dart | 1 - .../generated/golden/lib/sync.dart | 1 - ...rt_functional_provider_to_class_based.dart | 1 - .../avoid_build_context_in_providers.dart | 1 - .../lints/functional_ref/fix/auto_import.dart | 17 -- .../lints/functional_ref/fix/auto_import.diff | 100 ---------- .../functional_ref/fix/auto_import.g.dart | 184 ------------------ .../lints/functional_ref/fix/use_prefix.dart | 19 -- .../lints/functional_ref/fix/use_prefix.diff | 34 ---- .../functional_ref/fix/use_prefix.g.dart | 184 ------------------ .../advanced/select/select_async/codegen.dart | 1 - .../cancel/detail_screen_cancel/codegen.dart | 1 - .../detail_screen_debounce/codegen.dart | 1 - .../provider_with_extension/codegen.dart | 1 - .../fetch_activity/codegen.dart | 1 - website/docs/concepts/about_codegen/main.dart | 1 - .../provider_type/async_fn_future.dart | 1 - .../provider_type/async_fn_stream.dart | 1 - .../provider_type/auto_dispose.dart | 1 - .../about_codegen/provider_type/family.dart | 1 - .../provider_type/family_fn.dart | 1 - .../about_codegen/provider_type/sync_fn.dart | 1 - .../city_provider/codegen.dart | 1 - .../read_in_provider/codegen.dart | 1 - .../select_async_provider/codegen.dart | 1 - .../weather_provider/codegen.dart | 1 - .../whole_object_provider/codegen.dart | 1 - .../lifecycle_on_dispose/codegen.dart | 1 - .../creating_a_provider/codegen.dart | 1 - .../declaring_many_providers/codegen.dart | 1 - .../docs/concepts/reading/listen/codegen.dart | 1 - .../concepts/reading/provider/codegen.dart | 1 - .../docs/concepts/reading/watch/codegen.dart | 1 - .../auto_dispose/cache_for_usage/codegen.dart | 1 - .../auto_dispose/codegen_keep_alive.dart | 1 - .../auto_dispose/keep_alive/codegen.dart | 1 - .../on_dispose_example/codegen.dart | 1 - .../functional_ref/codegen.dart | 1 - .../listen_example/codegen.dart | 1 - .../notifier_ref/codegen.dart | 1 - .../watch_placement/codegen.dart | 1 - .../first_request/codegen/provider.dart | 1 - .../passing_args/family/codegen.dart | 1 - .../passing_args/no_arg_provider/codegen.dart | 1 - .../codegen/todo_list_provider.dart | 1 - .../testing/provider_to_mock/codegen.dart | 1 - .../websockets_sync/pipe_change_notifier.dart | 1 - .../sync_definition/codegen.dart | 1 - website/docs/from_provider/family/family.dart | 1 - .../motivation/async_values/async_values.dart | 1 - .../motivation/auto_dispose/auto_dispose.dart | 1 - .../motivation/combine/combine.dart | 1 - .../motivation/same_type/same_type.dart | 1 - .../introduction/why_riverpod/codegen.dart | 1 - .../config_provider/codegen.dart | 1 - .../completed_todos/completed_todos.dart | 1 - .../live_stream_chat_provider/codegen.dart | 1 - website/static/snippets/create.dart | 1 - 67 files changed, 3 insertions(+), 599 deletions(-) delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.g.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.dart delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.diff delete mode 100644 packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.g.dart diff --git a/packages/flutter_riverpod/lib/src/builders.dart b/packages/flutter_riverpod/lib/src/builders.dart index 09567226e..42e60ae7c 100644 --- a/packages/flutter_riverpod/lib/src/builders.dart +++ b/packages/flutter_riverpod/lib/src/builders.dart @@ -8,6 +8,8 @@ // You can then use it in your terminal by executing: // generate_providers +// ignore_for_file: invalid_use_of_internal_member + import 'package:flutter/foundation.dart'; import 'package:meta/meta.dart'; diff --git a/packages/riverpod_generator/integration/build_yaml/lib/dependencies.dart b/packages/riverpod_generator/integration/build_yaml/lib/dependencies.dart index 1f59cd52f..4b3fc48b4 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/dependencies.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/dependencies.dart @@ -1,4 +1,3 @@ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'main.dart'; diff --git a/packages/riverpod_generator/integration/build_yaml/lib/main.dart b/packages/riverpod_generator/integration/build_yaml/lib/main.dart index bb6a2201f..df64e3942 100644 --- a/packages/riverpod_generator/integration/build_yaml/lib/main.dart +++ b/packages/riverpod_generator/integration/build_yaml/lib/main.dart @@ -1,4 +1,3 @@ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; diff --git a/packages/riverpod_generator/test/integration/async.dart b/packages/riverpod_generator/test/integration/async.dart index e5ed13bdd..b9550f58f 100644 --- a/packages/riverpod_generator/test/integration/async.dart +++ b/packages/riverpod_generator/test/integration/async.dart @@ -1,4 +1,3 @@ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'async.g.dart'; diff --git a/packages/riverpod_generator/test/integration/auto_dispose.dart b/packages/riverpod_generator/test/integration/auto_dispose.dart index d5cdde00a..26c824040 100644 --- a/packages/riverpod_generator/test/integration/auto_dispose.dart +++ b/packages/riverpod_generator/test/integration/auto_dispose.dart @@ -1,4 +1,3 @@ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'auto_dispose.g.dart'; diff --git a/packages/riverpod_generator/test/integration/dependencies.dart b/packages/riverpod_generator/test/integration/dependencies.dart index 18b7ad251..c350b1ee3 100644 --- a/packages/riverpod_generator/test/integration/dependencies.dart +++ b/packages/riverpod_generator/test/integration/dependencies.dart @@ -1,4 +1,3 @@ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'dependencies.g.dart'; diff --git a/packages/riverpod_generator/test/integration/dependencies2.dart b/packages/riverpod_generator/test/integration/dependencies2.dart index 89d04b4b2..92697505e 100644 --- a/packages/riverpod_generator/test/integration/dependencies2.dart +++ b/packages/riverpod_generator/test/integration/dependencies2.dart @@ -1,4 +1,3 @@ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'dependencies.dart'; diff --git a/packages/riverpod_generator/test/integration/hash/hash1.dart b/packages/riverpod_generator/test/integration/hash/hash1.dart index 32b6febae..67fb2e74a 100644 --- a/packages/riverpod_generator/test/integration/hash/hash1.dart +++ b/packages/riverpod_generator/test/integration/hash/hash1.dart @@ -1,4 +1,3 @@ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'hash1.g.dart'; diff --git a/packages/riverpod_generator/test/integration/split.dart b/packages/riverpod_generator/test/integration/split.dart index ab3c4fcc3..47a61d7b3 100644 --- a/packages/riverpod_generator/test/integration/split.dart +++ b/packages/riverpod_generator/test/integration/split.dart @@ -1,5 +1,4 @@ -// Regresion test for https://github.com/rrousselGit/riverpod/issues/2175 -import 'package:riverpod/riverpod.dart'; +// Regression test for https://github.com/rrousselGit/riverpod/issues/2175 import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'split2.dart'; diff --git a/packages/riverpod_generator/test/integration/stream.dart b/packages/riverpod_generator/test/integration/stream.dart index 7c751b9a2..d6454068a 100644 --- a/packages/riverpod_generator/test/integration/stream.dart +++ b/packages/riverpod_generator/test/integration/stream.dart @@ -1,4 +1,3 @@ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'stream.g.dart'; diff --git a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart index 66f008712..228a0eff2 100644 --- a/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart +++ b/packages/riverpod_graph/test/integration/generated/golden/lib/sync.dart @@ -1,4 +1,3 @@ -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'sync.g.dart'; diff --git a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart index 894b5db24..f7f660062 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart +++ b/packages/riverpod_lint_flutter_test/test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart @@ -1,4 +1,3 @@ -import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'convert_functional_provider_to_class_based.g.dart'; diff --git a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart index faa14343c..e3ca4231b 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart +++ b/packages/riverpod_lint_flutter_test/test/lints/avoid_build_context_in_providers.dart @@ -1,7 +1,6 @@ // ignore_for_file: unused_element import 'package:flutter/widgets.dart'; -import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'avoid_build_context_in_providers.g.dart'; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.dart deleted file mode 100644 index f9da55bfe..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.dart +++ /dev/null @@ -1,17 +0,0 @@ -// ignore_for_file: deprecated_member_use_from_same_package -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -part 'auto_import.g.dart'; - -// No riverpod imported. Should add it automatically -@riverpod -// expect_lint: functional_ref -int example(ExampleRef ref) => 0; - -@riverpod -// expect_lint: functional_ref -int empty() => 0; - -@riverpod -// expect_lint: functional_ref -int untyped(ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.diff b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.diff deleted file mode 100644 index 8467bc041..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.diff +++ /dev/null @@ -1,100 +0,0 @@ -Message: `Type as Ref` -Priority: 90 -Diff for file `test/lints/functional_ref/fix/auto_import.dart:2`: -``` -// ignore_for_file: deprecated_member_use_from_same_package -- import 'package:riverpod_annotation/riverpod_annotation.dart'; -- -- part 'auto_import.g.dart'; -- -- // No riverpod imported. Should add it automatically -- @riverpod -- // expect_lint: functional_ref -- int example(ExampleRef ref) => 0; -+ import 'package:riverpod/riverpod.dart'; -+ import 'package:riverpod_annotation/riverpod_annotation.dart'; -+ -+ part 'auto_import.g.dart'; -+ -+ // No riverpod imported. Should add it automatically -+ @riverpod -+ // expect_lint: functional_ref -+ int example(Ref ref) => 0; - -@riverpod -``` ---- -Message: `Add ref parameter` -Priority: 90 -Diff for file `test/lints/functional_ref/fix/auto_import.dart:2`: -``` -// ignore_for_file: deprecated_member_use_from_same_package -- import 'package:riverpod_annotation/riverpod_annotation.dart'; -- -- part 'auto_import.g.dart'; -- -- // No riverpod imported. Should add it automatically -- @riverpod -- // expect_lint: functional_ref -- int example(ExampleRef ref) => 0; -- -- @riverpod -- // expect_lint: functional_ref -- int empty() => 0; -+ import 'package:riverpod/riverpod.dart'; -+ import 'package:riverpod_annotation/riverpod_annotation.dart'; -+ -+ part 'auto_import.g.dart'; -+ -+ // No riverpod imported. Should add it automatically -+ @riverpod -+ // expect_lint: functional_ref -+ int example(ExampleRef ref) => 0; -+ -+ @riverpod -+ // expect_lint: functional_ref -+ int empty(Ref ref) => 0; - -@riverpod -``` ---- -Message: `Type as Ref` -Priority: 90 -Diff for file `test/lints/functional_ref/fix/auto_import.dart:2`: -``` -// ignore_for_file: deprecated_member_use_from_same_package -- import 'package:riverpod_annotation/riverpod_annotation.dart'; -- -- part 'auto_import.g.dart'; -- -- // No riverpod imported. Should add it automatically -- @riverpod -- // expect_lint: functional_ref -- int example(ExampleRef ref) => 0; -- -- @riverpod -- // expect_lint: functional_ref -- int empty() => 0; -- -- @riverpod -- // expect_lint: functional_ref -- int untyped(ref) => 0; -+ import 'package:riverpod/riverpod.dart'; -+ import 'package:riverpod_annotation/riverpod_annotation.dart'; -+ -+ part 'auto_import.g.dart'; -+ -+ // No riverpod imported. Should add it automatically -+ @riverpod -+ // expect_lint: functional_ref -+ int example(ExampleRef ref) => 0; -+ -+ @riverpod -+ // expect_lint: functional_ref -+ int empty() => 0; -+ -+ @riverpod -+ // expect_lint: functional_ref -+ int untyped(Ref ref) => 0; -``` ---- diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.g.dart deleted file mode 100644 index 5cd459a66..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/auto_import.g.dart +++ /dev/null @@ -1,184 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'auto_import.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -@ProviderFor(example) -const exampleProvider = ExampleProvider._(); - -final class ExampleProvider extends $FunctionalProvider - with $Provider { - const ExampleProvider._( - {int Function( - Ref ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'exampleProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - Ref ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$exampleHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - ExampleProvider $copyWithCreate( - int Function( - Ref ref, - ) create, - ) { - return ExampleProvider._(create: create); - } - - @override - int create(Ref ref) { - final _$cb = _createCb ?? example; - return _$cb(ref); - } -} - -String _$exampleHash() => r'638d7db2be22eaad0f51ea0b3ae38e0483d43725'; - -@ProviderFor(empty) -const emptyProvider = EmptyProvider._(); - -final class EmptyProvider extends $FunctionalProvider - with $Provider { - const EmptyProvider._( - {int Function( - Ref ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'emptyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - Ref ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$emptyHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - EmptyProvider $copyWithCreate( - int Function( - Ref ref, - ) create, - ) { - return EmptyProvider._(create: create); - } - - @override - int create(Ref ref) { - final _$cb = _createCb ?? empty; - return _$cb(ref); - } -} - -String _$emptyHash() => r'eaec2981c894019fafd068e09478ffe961a8d188'; - -@ProviderFor(untyped) -const untypedProvider = UntypedProvider._(); - -final class UntypedProvider extends $FunctionalProvider - with $Provider { - const UntypedProvider._( - {int Function( - Ref ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'untypedProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - Ref ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$untypedHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - UntypedProvider $copyWithCreate( - int Function( - Ref ref, - ) create, - ) { - return UntypedProvider._(create: create); - } - - @override - int create(Ref ref) { - final _$cb = _createCb ?? untyped; - return _$cb(ref); - } -} - -String _$untypedHash() => r'5dd4815f63ed35a15a2e027b4e0cb496693f07f4'; - -// ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.dart deleted file mode 100644 index da23acc3e..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.dart +++ /dev/null @@ -1,19 +0,0 @@ -// ignore_for_file: deprecated_member_use_from_same_package -// ignore: unused_import, used for the fix -import 'package:riverpod/riverpod.dart' as prefix; -import 'package:riverpod_annotation/riverpod_annotation.dart'; - -part 'use_prefix.g.dart'; - -// No riverpod imported. Should add it automatically -@riverpod -// expect_lint: functional_ref -int example(ExampleRef ref) => 0; - -@riverpod -// expect_lint: functional_ref -int empty() => 0; - -@riverpod -// expect_lint: functional_ref -int untyped(ref) => 0; diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.diff b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.diff deleted file mode 100644 index c403a677f..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.diff +++ /dev/null @@ -1,34 +0,0 @@ -Message: `Type as Ref` -Priority: 90 -Diff for file `test/lints/functional_ref/fix/use_prefix.dart:11`: -``` -@riverpod -// expect_lint: functional_ref -- int example(ExampleRef ref) => 0; -+ int example(prefix.Ref ref) => 0; - -@riverpod -``` ---- -Message: `Add ref parameter` -Priority: 90 -Diff for file `test/lints/functional_ref/fix/use_prefix.dart:15`: -``` -@riverpod -// expect_lint: functional_ref -- int empty() => 0; -+ int empty(prefix.Ref ref) => 0; - -@riverpod -``` ---- -Message: `Type as Ref` -Priority: 90 -Diff for file `test/lints/functional_ref/fix/use_prefix.dart:19`: -``` -@riverpod -// expect_lint: functional_ref -- int untyped(ref) => 0; -+ int untyped(prefix.Ref ref) => 0; -``` ---- diff --git a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.g.dart b/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.g.dart deleted file mode 100644 index b98098717..000000000 --- a/packages/riverpod_lint_flutter_test/test/lints/functional_ref/fix/use_prefix.g.dart +++ /dev/null @@ -1,184 +0,0 @@ -// GENERATED CODE - DO NOT MODIFY BY HAND - -part of 'use_prefix.dart'; - -// ************************************************************************** -// RiverpodGenerator -// ************************************************************************** - -@ProviderFor(example) -const exampleProvider = ExampleProvider._(); - -final class ExampleProvider extends $FunctionalProvider - with $Provider { - const ExampleProvider._( - {int Function( - Ref ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'exampleProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - Ref ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$exampleHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - ExampleProvider $copyWithCreate( - int Function( - Ref ref, - ) create, - ) { - return ExampleProvider._(create: create); - } - - @override - int create(Ref ref) { - final _$cb = _createCb ?? example; - return _$cb(ref); - } -} - -String _$exampleHash() => r'638d7db2be22eaad0f51ea0b3ae38e0483d43725'; - -@ProviderFor(empty) -const emptyProvider = EmptyProvider._(); - -final class EmptyProvider extends $FunctionalProvider - with $Provider { - const EmptyProvider._( - {int Function( - Ref ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'emptyProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - Ref ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$emptyHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - EmptyProvider $copyWithCreate( - int Function( - Ref ref, - ) create, - ) { - return EmptyProvider._(create: create); - } - - @override - int create(Ref ref) { - final _$cb = _createCb ?? empty; - return _$cb(ref); - } -} - -String _$emptyHash() => r'eaec2981c894019fafd068e09478ffe961a8d188'; - -@ProviderFor(untyped) -const untypedProvider = UntypedProvider._(); - -final class UntypedProvider extends $FunctionalProvider - with $Provider { - const UntypedProvider._( - {int Function( - Ref ref, - )? create}) - : _createCb = create, - super( - from: null, - argument: null, - retry: null, - name: r'untypedProvider', - isAutoDispose: true, - dependencies: null, - allTransitiveDependencies: null, - ); - - final int Function( - Ref ref, - )? _createCb; - - @override - String debugGetCreateSourceHash() => _$untypedHash(); - - /// {@macro riverpod.override_with_value} - Override overrideWithValue(int value) { - return $ProviderOverride( - origin: this, - providerOverride: $ValueProvider(value), - ); - } - - @$internal - @override - $ProviderElement $createElement($ProviderPointer pointer) => - $ProviderElement(this, pointer); - - @override - UntypedProvider $copyWithCreate( - int Function( - Ref ref, - ) create, - ) { - return UntypedProvider._(create: create); - } - - @override - int create(Ref ref) { - final _$cb = _createCb ?? untyped; - return _$cb(ref); - } -} - -String _$untypedHash() => r'5dd4815f63ed35a15a2e027b4e0cb496693f07f4'; - -// ignore_for_file: type=lint -// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/website/docs/advanced/select/select_async/codegen.dart b/website/docs/advanced/select/select_async/codegen.dart index 94b911bca..9ddf7256b 100644 --- a/website/docs/advanced/select/select_async/codegen.dart +++ b/website/docs/advanced/select/select_async/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: unused_local_variable, avoid_multiple_declarations_per_line, omit_local_variable_types, prefer_final_locals, use_key_in_widget_constructors, body_might_complete_normally_nullable -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart index 0fe63d984..8094b9996 100644 --- a/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart +++ b/website/docs/case_studies/cancel/detail_screen_cancel/codegen.dart @@ -1,7 +1,6 @@ import 'dart:convert'; import 'package:http/http.dart' as http; -import 'package:riverpod/riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../detail_screen/codegen.dart'; diff --git a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart index 54ec304da..732f8e134 100644 --- a/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart +++ b/website/docs/case_studies/cancel/detail_screen_debounce/codegen.dart @@ -1,6 +1,5 @@ import 'dart:convert'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/case_studies/cancel/provider_with_extension/codegen.dart b/website/docs/case_studies/cancel/provider_with_extension/codegen.dart index 85db5313b..e3663c7a0 100644 --- a/website/docs/case_studies/cancel/provider_with_extension/codegen.dart +++ b/website/docs/case_studies/cancel/provider_with_extension/codegen.dart @@ -1,6 +1,5 @@ import 'dart:convert'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../detail_screen/codegen.dart'; diff --git a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart index 54cbd50da..16ac99207 100644 --- a/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart +++ b/website/docs/case_studies/pull_to_refresh/fetch_activity/codegen.dart @@ -1,6 +1,5 @@ import 'dart:convert'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/concepts/about_codegen/main.dart b/website/docs/concepts/about_codegen/main.dart index b0a1a4347..6dbbf14aa 100644 --- a/website/docs/concepts/about_codegen/main.dart +++ b/website/docs/concepts/about_codegen/main.dart @@ -1,6 +1,5 @@ // ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types, avoid_unused_constructor_parameters -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'main.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart index 27f448f98..7ab60af7c 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_future.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'async_fn_future.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart index a7080cdc9..43b3a877f 100644 --- a/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart +++ b/website/docs/concepts/about_codegen/provider_type/async_fn_stream.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'async_fn_stream.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart b/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart index ecc7afa9e..3351a2da9 100644 --- a/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart +++ b/website/docs/concepts/about_codegen/provider_type/auto_dispose.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'auto_dispose.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/family.dart b/website/docs/concepts/about_codegen/provider_type/family.dart index 22db5c5f8..d4a88c306 100644 --- a/website/docs/concepts/about_codegen/provider_type/family.dart +++ b/website/docs/concepts/about_codegen/provider_type/family.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'family.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/family_fn.dart b/website/docs/concepts/about_codegen/provider_type/family_fn.dart index e7e941e5f..6ac513340 100644 --- a/website/docs/concepts/about_codegen/provider_type/family_fn.dart +++ b/website/docs/concepts/about_codegen/provider_type/family_fn.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'family_fn.g.dart'; diff --git a/website/docs/concepts/about_codegen/provider_type/sync_fn.dart b/website/docs/concepts/about_codegen/provider_type/sync_fn.dart index 0099d43b4..73e82b7e2 100644 --- a/website/docs/concepts/about_codegen/provider_type/sync_fn.dart +++ b/website/docs/concepts/about_codegen/provider_type/sync_fn.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'sync_fn.g.dart'; diff --git a/website/docs/concepts/combining_provider_states/city_provider/codegen.dart b/website/docs/concepts/combining_provider_states/city_provider/codegen.dart index 39edaa161..092367038 100644 --- a/website/docs/concepts/combining_provider_states/city_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/city_provider/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart index 556d228c0..c76e47a97 100644 --- a/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/read_in_provider/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart index 1d76926cc..0bdb6db69 100644 --- a/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/select_async_provider/codegen.dart @@ -1,5 +1,4 @@ import 'package:dio/dio.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'models.dart'; diff --git a/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart b/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart index 0d04d544e..a66b91521 100644 --- a/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/weather_provider/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart index e52b9f54b..cb3a1ec73 100644 --- a/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart +++ b/website/docs/concepts/combining_provider_states/whole_object_provider/codegen.dart @@ -1,5 +1,4 @@ import 'package:dio/dio.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'models.dart'; diff --git a/website/docs/concepts/lifecycle_on_dispose/codegen.dart b/website/docs/concepts/lifecycle_on_dispose/codegen.dart index ab64f257e..35f832a69 100644 --- a/website/docs/concepts/lifecycle_on_dispose/codegen.dart +++ b/website/docs/concepts/lifecycle_on_dispose/codegen.dart @@ -2,7 +2,6 @@ import 'dart:async'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/providers/creating_a_provider/codegen.dart b/website/docs/concepts/providers/creating_a_provider/codegen.dart index 163f5b4b5..15efd2d7a 100644 --- a/website/docs/concepts/providers/creating_a_provider/codegen.dart +++ b/website/docs/concepts/providers/creating_a_provider/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/providers/declaring_many_providers/codegen.dart b/website/docs/concepts/providers/declaring_many_providers/codegen.dart index 17b1ccab8..276cab4dd 100644 --- a/website/docs/concepts/providers/declaring_many_providers/codegen.dart +++ b/website/docs/concepts/providers/declaring_many_providers/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/reading/listen/codegen.dart b/website/docs/concepts/reading/listen/codegen.dart index ac2cd9cae..b4531515a 100644 --- a/website/docs/concepts/reading/listen/codegen.dart +++ b/website/docs/concepts/reading/listen/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../counter/codegen.dart'; diff --git a/website/docs/concepts/reading/provider/codegen.dart b/website/docs/concepts/reading/provider/codegen.dart index 46e832fe8..954941a9b 100644 --- a/website/docs/concepts/reading/provider/codegen.dart +++ b/website/docs/concepts/reading/provider/codegen.dart @@ -1,5 +1,4 @@ // ignore_for_file: avoid_positional_boolean_parameters -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/concepts/reading/watch/codegen.dart b/website/docs/concepts/reading/watch/codegen.dart index ebbaa8d7c..947af2a51 100644 --- a/website/docs/concepts/reading/watch/codegen.dart +++ b/website/docs/concepts/reading/watch/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: omit_local_variable_types, avoid_types_on_closure_parameters, avoid_print -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart index 69dad3871..a19f6a897 100644 --- a/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart +++ b/website/docs/essentials/auto_dispose/cache_for_usage/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: unused_local_variable -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/essentials/auto_dispose/codegen_keep_alive.dart b/website/docs/essentials/auto_dispose/codegen_keep_alive.dart index 48eba50c6..74af13186 100644 --- a/website/docs/essentials/auto_dispose/codegen_keep_alive.dart +++ b/website/docs/essentials/auto_dispose/codegen_keep_alive.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen_keep_alive.g.dart'; diff --git a/website/docs/essentials/auto_dispose/keep_alive/codegen.dart b/website/docs/essentials/auto_dispose/keep_alive/codegen.dart index 8d2afa235..a3f17cc7c 100644 --- a/website/docs/essentials/auto_dispose/keep_alive/codegen.dart +++ b/website/docs/essentials/auto_dispose/keep_alive/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: unused_local_variable -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart index d783c47fd..a7eafb658 100644 --- a/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart +++ b/website/docs/essentials/auto_dispose/on_dispose_example/codegen.dart @@ -2,7 +2,6 @@ import 'dart:async'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/functional_ref/codegen.dart b/website/docs/essentials/combining_requests/functional_ref/codegen.dart index 8f0ea7b7c..e776d8c31 100644 --- a/website/docs/essentials/combining_requests/functional_ref/codegen.dart +++ b/website/docs/essentials/combining_requests/functional_ref/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: unused_local_variable -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/listen_example/codegen.dart b/website/docs/essentials/combining_requests/listen_example/codegen.dart index dc8a14a77..8de5958a6 100644 --- a/website/docs/essentials/combining_requests/listen_example/codegen.dart +++ b/website/docs/essentials/combining_requests/listen_example/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: unused_local_variable, avoid_print -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/notifier_ref/codegen.dart b/website/docs/essentials/combining_requests/notifier_ref/codegen.dart index 35609efa1..c184574c3 100644 --- a/website/docs/essentials/combining_requests/notifier_ref/codegen.dart +++ b/website/docs/essentials/combining_requests/notifier_ref/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: unused_local_variable -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/combining_requests/watch_placement/codegen.dart b/website/docs/essentials/combining_requests/watch_placement/codegen.dart index e2ae6e347..d5a9cd653 100644 --- a/website/docs/essentials/combining_requests/watch_placement/codegen.dart +++ b/website/docs/essentials/combining_requests/watch_placement/codegen.dart @@ -1,7 +1,6 @@ // ignore_for_file: unused_local_variable import 'package:flutter/foundation.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/first_request/codegen/provider.dart b/website/docs/essentials/first_request/codegen/provider.dart index afaff3513..9a68b34be 100644 --- a/website/docs/essentials/first_request/codegen/provider.dart +++ b/website/docs/essentials/first_request/codegen/provider.dart @@ -1,7 +1,6 @@ /* SNIPPET START */ import 'dart:convert'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; import 'activity.dart'; diff --git a/website/docs/essentials/passing_args/family/codegen.dart b/website/docs/essentials/passing_args/family/codegen.dart index 5c8a0117e..ab4743a20 100644 --- a/website/docs/essentials/passing_args/family/codegen.dart +++ b/website/docs/essentials/passing_args/family/codegen.dart @@ -1,7 +1,6 @@ // ignore_for_file: avoid_print import 'dart:convert'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../first_request/codegen/activity.dart'; diff --git a/website/docs/essentials/passing_args/no_arg_provider/codegen.dart b/website/docs/essentials/passing_args/no_arg_provider/codegen.dart index eee4a724c..da1c34adb 100644 --- a/website/docs/essentials/passing_args/no_arg_provider/codegen.dart +++ b/website/docs/essentials/passing_args/no_arg_provider/codegen.dart @@ -1,6 +1,5 @@ // ignore_for_file: avoid_print -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../first_request/codegen/activity.dart'; diff --git a/website/docs/essentials/side_effects/codegen/todo_list_provider.dart b/website/docs/essentials/side_effects/codegen/todo_list_provider.dart index e80b9d4a0..f0a84c83a 100644 --- a/website/docs/essentials/side_effects/codegen/todo_list_provider.dart +++ b/website/docs/essentials/side_effects/codegen/todo_list_provider.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:freezed_annotation/freezed_annotation.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; diff --git a/website/docs/essentials/testing/provider_to_mock/codegen.dart b/website/docs/essentials/testing/provider_to_mock/codegen.dart index 078148729..073779b2d 100644 --- a/website/docs/essentials/testing/provider_to_mock/codegen.dart +++ b/website/docs/essentials/testing/provider_to_mock/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/essentials/websockets_sync/pipe_change_notifier.dart b/website/docs/essentials/websockets_sync/pipe_change_notifier.dart index 03d665216..0cc75bea6 100644 --- a/website/docs/essentials/websockets_sync/pipe_change_notifier.dart +++ b/website/docs/essentials/websockets_sync/pipe_change_notifier.dart @@ -1,7 +1,6 @@ // ignore_for_file: omit_local_variable_types import 'package:flutter/widgets.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'pipe_change_notifier.g.dart'; diff --git a/website/docs/essentials/websockets_sync/sync_definition/codegen.dart b/website/docs/essentials/websockets_sync/sync_definition/codegen.dart index eeaba83b6..cdddcb32d 100644 --- a/website/docs/essentials/websockets_sync/sync_definition/codegen.dart +++ b/website/docs/essentials/websockets_sync/sync_definition/codegen.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/from_provider/family/family.dart b/website/docs/from_provider/family/family.dart index 88012fd24..61cf268fc 100644 --- a/website/docs/from_provider/family/family.dart +++ b/website/docs/from_provider/family/family.dart @@ -1,6 +1,5 @@ import 'dart:math'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'family.g.dart'; diff --git a/website/docs/from_provider/motivation/async_values/async_values.dart b/website/docs/from_provider/motivation/async_values/async_values.dart index 96f694e2a..0518dc0a7 100644 --- a/website/docs/from_provider/motivation/async_values/async_values.dart +++ b/website/docs/from_provider/motivation/async_values/async_values.dart @@ -1,6 +1,5 @@ import 'package:collection/collection.dart'; import 'package:dio/dio.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../helpers/item.dart'; diff --git a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart index fcb26dd6c..052686f61 100644 --- a/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart +++ b/website/docs/from_provider/motivation/auto_dispose/auto_dispose.dart @@ -1,6 +1,5 @@ import 'dart:math'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'auto_dispose.g.dart'; diff --git a/website/docs/from_provider/motivation/combine/combine.dart b/website/docs/from_provider/motivation/combine/combine.dart index f26e5d285..521d231b7 100644 --- a/website/docs/from_provider/motivation/combine/combine.dart +++ b/website/docs/from_provider/motivation/combine/combine.dart @@ -1,6 +1,5 @@ import 'dart:math'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'combine.g.dart'; diff --git a/website/docs/from_provider/motivation/same_type/same_type.dart b/website/docs/from_provider/motivation/same_type/same_type.dart index 1094a6950..a46db40cf 100644 --- a/website/docs/from_provider/motivation/same_type/same_type.dart +++ b/website/docs/from_provider/motivation/same_type/same_type.dart @@ -1,5 +1,4 @@ import 'package:collection/collection.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../../helpers/item.dart'; diff --git a/website/docs/introduction/why_riverpod/codegen.dart b/website/docs/introduction/why_riverpod/codegen.dart index 5205e623c..bd784d449 100644 --- a/website/docs/introduction/why_riverpod/codegen.dart +++ b/website/docs/introduction/why_riverpod/codegen.dart @@ -1,7 +1,6 @@ // ignore_for_file: use_key_in_widget_constructors, omit_local_variable_types import 'package:dio/dio.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/providers/future_provider/config_provider/codegen.dart b/website/docs/providers/future_provider/config_provider/codegen.dart index f8520a4ec..e862b79f8 100644 --- a/website/docs/providers/future_provider/config_provider/codegen.dart +++ b/website/docs/providers/future_provider/config_provider/codegen.dart @@ -3,7 +3,6 @@ import 'dart:convert'; import 'package:flutter/services.dart'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/docs/providers/provider/completed_todos/completed_todos.dart b/website/docs/providers/provider/completed_todos/completed_todos.dart index bc04a41b9..720a034ba 100644 --- a/website/docs/providers/provider/completed_todos/completed_todos.dart +++ b/website/docs/providers/provider/completed_todos/completed_todos.dart @@ -1,4 +1,3 @@ -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; import '../todo/todo.dart'; diff --git a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart index d5247516f..6ac7b13c4 100644 --- a/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart +++ b/website/docs/providers/stream_provider/live_stream_chat_provider/codegen.dart @@ -2,7 +2,6 @@ import 'dart:convert'; import 'dart:io'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'codegen.g.dart'; diff --git a/website/static/snippets/create.dart b/website/static/snippets/create.dart index 418e7430e..236716169 100644 --- a/website/static/snippets/create.dart +++ b/website/static/snippets/create.dart @@ -2,7 +2,6 @@ import 'dart:convert'; -import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:http/http.dart' as http; import 'package:riverpod_annotation/riverpod_annotation.dart'; From d7b791c00f62b98954a46004f144469ea60c03c9 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 9 Dec 2024 21:37:21 +0100 Subject: [PATCH 377/387] Fix goldens --- .../convert_functional_provider_to_class_based.diff | 4 ++-- .../avoid_build_context_in_providers_lint.md | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff index 729b5335f..0980c5b6b 100644 --- a/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff +++ b/packages/riverpod_lint_flutter_test/test/assists/goldens/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.diff @@ -1,6 +1,6 @@ Message: `Convert to class-based provider` Priority: 100 -Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:8`: +Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:7`: ``` /// Some comment @riverpod @@ -15,7 +15,7 @@ Diff for file `test/assists/convert_functional_provider_to_class_based/convert_f --- Message: `Convert to class-based provider` Priority: 100 -Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:12`: +Diff for file `test/assists/convert_functional_provider_to_class_based/convert_functional_provider_to_class_based.dart:11`: ``` /// Some comment @riverpod diff --git a/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md index 36544c25b..589c4dde1 100644 --- a/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md +++ b/packages/riverpod_lint_flutter_test/test/lints/goldens/avoid_build_context_in_providers/avoid_build_context_in_providers_lint.md @@ -1,7 +1,7 @@ code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:13:3 +test/lints/avoid_build_context_in_providers.dart:12:3 ```dart Ref ref, @@ -16,7 +16,7 @@ test/lints/avoid_build_context_in_providers.dart:13:3 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:15:3 +test/lints/avoid_build_context_in_providers.dart:14:3 ```dart BuildContext context1, { @@ -31,7 +31,7 @@ test/lints/avoid_build_context_in_providers.dart:15:3 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:23:5 +test/lints/avoid_build_context_in_providers.dart:22:5 ```dart int build( @@ -46,7 +46,7 @@ test/lints/avoid_build_context_in_providers.dart:23:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:25:5 +test/lints/avoid_build_context_in_providers.dart:24:5 ```dart BuildContext context1, { @@ -61,7 +61,7 @@ test/lints/avoid_build_context_in_providers.dart:25:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:31:5 +test/lints/avoid_build_context_in_providers.dart:30:5 ```dart void event( @@ -76,7 +76,7 @@ test/lints/avoid_build_context_in_providers.dart:31:5 code: avoid_build_context_in_providers severity: Severity.info message: Passing BuildContext to providers indicates mixing UI with the business logic. -test/lints/avoid_build_context_in_providers.dart:33:5 +test/lints/avoid_build_context_in_providers.dart:32:5 ```dart BuildContext context3, { From cc8088385ae8e244f63621a5a0424b601fd8e4b7 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Mon, 9 Dec 2024 22:36:16 +0100 Subject: [PATCH 378/387] Fix-stream-cancel (#3865) ## Related Issues fixes #3853 ## Checklist Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (`[x]`). - [x] I have updated the `CHANGELOG.md` of the relevant packages. Changelog files must be edited under the form: ```md ## Unreleased fix/major/minor - Description of your change. (thanks to @yourGithubId) ``` - [x] If this contains new features or behavior changes, I have updated the documentation to match those changes. --- packages/riverpod/CHANGELOG.md | 1 + .../lib/src/core/modifiers/future.dart | 77 ++++--------------- .../src/providers/stream_notifier_test.dart | 58 ++++---------- .../riverpod_generator/test/stream_test.dart | 10 ++- 4 files changed, 38 insertions(+), 108 deletions(-) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 5ded22860..1452ccaab 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -24,6 +24,7 @@ - **Breaking**: A provider is now considered "paused" if all of its listeners are also paused. So if a provider `A` is watched _only_ by a provider `B`, and `B` is currently unused, then `A` will be paused. +- Fix `StreamProvider` not cancelling the `StreamSubscription` if the stream is never emitted any value. - All `Ref` life-cycles (such as `Ref.onDispose`) and `Notifier.listenSelf` now return a function to remove the listener. - Added methods to `ProviderObserver` for listening to "mutations". diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 757518867..1391ce31f 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -3,9 +3,13 @@ part of '../../framework.dart'; /// Internal typedef for cancelling the subscription to an async operation @internal typedef AsyncSubscription = ({ + /// The provider was disposed, but may rebuild later void Function() cancel, void Function()? pause, void Function()? resume, + + /// The provider was disposed + void Function()? abort, }); /// Implementation detail of `riverpod_generator`. @@ -422,10 +426,13 @@ mixin FutureModifierElement on ProviderElement> { }, ); - last(futureOr, cancel); + last(futureOr); return ( cancel: cancel, + // We don't call `cancel` here to let `provider.future` resolve with + // the last value emitted by the future. + abort: null, pause: null, resume: null, ); @@ -438,7 +445,7 @@ mixin FutureModifierElement on ProviderElement> { required void Function(StateT) data, required void Function(Object, StackTrace) error, required void Function() done, - required void Function(Future, void Function()) last, + required void Function(Future) last, }) listen, { required bool seamless, }) { @@ -450,12 +457,12 @@ mixin FutureModifierElement on ProviderElement> { } try { - final sub = _cancelSubscription = listen( + _cancelSubscription = listen( data: (value) { onData(AsyncData(value), seamless: seamless); }, error: callOnError, - last: (last, sub) { + last: (last) { assert(_lastFuture == null, 'bad state'); _lastFuture = last; }, @@ -463,10 +470,6 @@ mixin FutureModifierElement on ProviderElement> { _lastFuture = null; }, ); - assert( - sub == null || _lastFuture != null, - 'An async operation is pending but the state for provider.future was not initialized.', - ); } catch (error, stackTrace) { callOnError(error, stackTrace); } @@ -492,17 +495,7 @@ mixin FutureModifierElement on ProviderElement> { final lastFuture = _lastFuture; if (lastFuture != null) { - final cancelSubscription = _cancelSubscription; - if (cancelSubscription != null) { - cancelSubscription.resume?.call(); - lastFuture - .then( - (_) {}, - // ignore: avoid_types_on_closure_parameters - onError: (Object _) {}, - ) - .whenComplete(cancelSubscription.cancel); - } + _cancelSubscription?.abort?.call(); // Prevent super.dispose from cancelling the subscription on the "last" // stream value, so that it can be sent to `provider.future`. @@ -535,60 +528,22 @@ mixin FutureModifierElement on ProviderElement> { extension on Stream { AsyncSubscription listenAndTrackLast( - void Function(Future, void Function()) last, { + void Function(Future) last, { required Object Function() lastOrElseError, required void Function(T event) onData, required void Function(Object error, StackTrace stackTrace) onError, required void Function() onDone, }) { - final completer = Completer(); - - Result? result; late StreamSubscription subscription; - subscription = listen( - (event) { - result = Result.data(event); - onData(event); - }, - // ignore: avoid_types_on_closure_parameters - onError: (Object error, StackTrace stackTrace) { - result = Result.error(error, stackTrace); - onError(error, stackTrace); - }, - onDone: () { - if (result != null) { - switch (result!) { - case ResultData(:final state): - completer.complete(state); - case ResultError(:final error, :final stackTrace): - completer.future.ignore(); - completer.completeError(error, stackTrace); - } - } else { - // The error happens after the associated provider is disposed. - // As such, it's normally never read. Reporting this error as uncaught - // would cause too many false-positives. And the edge-cases that - // do reach this error will throw anyway - completer.future.ignore(); - - completer.completeError( - lastOrElseError(), - StackTrace.current, - ); - } - - onDone(); - }, - ); + subscription = listen(onData, onError: onError, onDone: onDone); final asyncSub = ( cancel: subscription.cancel, pause: subscription.pause, - resume: subscription.resume + resume: subscription.resume, + abort: subscription.cancel, ); - last(completer.future, asyncSub.cancel); - return asyncSub; } } diff --git a/packages/riverpod/test/src/providers/stream_notifier_test.dart b/packages/riverpod/test/src/providers/stream_notifier_test.dart index d73d4524b..7ee32bebe 100644 --- a/packages/riverpod/test/src/providers/stream_notifier_test.dart +++ b/packages/riverpod/test/src/providers/stream_notifier_test.dart @@ -33,7 +33,6 @@ void main() { test('closes the StreamSubscription upon disposing the provider', () async { final onCancel = OnCancelMock(); final container = ProviderContainer.test(); - final cancelCompleter = Completer.sync(); final provider = factory.simpleTestProvider((ref, _) { final controller = StreamController(); ref.onDispose(() { @@ -43,10 +42,7 @@ void main() { return DelegatingStream( controller.stream, - onSubscriptionCancel: () { - onCancel.call(); - cancelCompleter.complete(); - }, + onSubscriptionCancel: onCancel.call, ); }); @@ -55,12 +51,9 @@ void main() { container.dispose(); - verifyZeroInteractions(onCancel); - - await expectLater(future, throwsA(42)); - await cancelCompleter.future; - verifyOnly(onCancel, onCancel()); + + await expectLater(future, throwsStateError); }); test('Pauses the Stream when the provider is paused', () { @@ -690,60 +683,37 @@ void main() { () async { final container = ProviderContainer.test(); final completer = Completer.sync(); + addTearDown(() => completer.complete(42)); final provider = factory.simpleTestProvider( (ref, _) => Stream.fromFuture(completer.future), ); final future = container.read(provider.future); - container.dispose(); - - completer.complete(42); + expect(future, throwsA(isStateError)); - await expectLater(future, completion(42)); + container.dispose(); }); test( - 'when disposed during loading, resolves with the error of StreamNotifier.build', - () async { + 'going data > loading while the future is still pending. ' + 'Resolves with error', () async { final container = ProviderContainer.test(); final completer = Completer.sync(); + addTearDown(() => completer.complete(42)); final provider = factory.simpleTestProvider( (ref, _) => Stream.fromFuture(completer.future), ); + container.read(provider); + container.read(provider.notifier).state = const AsyncData(42); + container.read(provider.notifier).state = const AsyncLoading(); + final future = container.read(provider.future); + expect(future, throwsA(isStateError)); container.dispose(); - - completer.completeError(42); - - await expectLater(future, throwsA(42)); }); - test( - 'going data > loading while the future is still pending. ' - 'Resolves with last future result', - () async { - final container = ProviderContainer.test(); - final completer = Completer.sync(); - final provider = factory.simpleTestProvider( - (ref, _) => Stream.fromFuture(completer.future), - ); - - container.read(provider); - container.read(provider.notifier).state = const AsyncData(42); - container.read(provider.notifier).state = const AsyncLoading(); - - final future = container.read(provider.future); - - container.dispose(); - - completer.complete(42); - - await expectLater(future, completion(42)); - }, - ); - test('if going back to loading after future resolved, throws StateError', () async { final container = ProviderContainer.test(); diff --git a/packages/riverpod_generator/test/stream_test.dart b/packages/riverpod_generator/test/stream_test.dart index 729ccc569..7a39f0eb9 100644 --- a/packages/riverpod_generator/test/stream_test.dart +++ b/packages/riverpod_generator/test/stream_test.dart @@ -34,7 +34,7 @@ void main() { ], ); - final result = container.read(publicProvider.future); + final result = container.listen(publicProvider.future, (a, b) {}).read(); expect(await result, 'Hello world'); }); @@ -54,11 +54,15 @@ void main() { ); expect( - await container.read(familyProvider(42, third: .42).future), + await container + .listen(familyProvider(42, third: .42).future, (a, b) {}) + .read(), 'Hello world 42 null 0.42 true null', ); expect( - await container.read(familyProvider(21, third: .21).future), + await container + .listen(familyProvider(21, third: .21).future, (a, b) {}) + .read(), 'Override', ); }); From d90f2d337ab5245f57abbade8b594c1484999e04 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 11 Dec 2024 12:35:21 +0100 Subject: [PATCH 379/387] Skip unimplemented test --- packages/riverpod/test/src/core/provider_element_test.dart | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/riverpod/test/src/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart index c72be45fd..10e939e7f 100644 --- a/packages/riverpod/test/src/core/provider_element_test.dart +++ b/packages/riverpod/test/src/core/provider_element_test.dart @@ -37,7 +37,11 @@ void main() { }); group('retry', () { - test('default retry delays from 200ms to 6.4 seconds', () {}); + test( + skip: 'unimplemented', + 'default retry delays from 200ms to 6.4 seconds', + () {}, + ); group('custom retry', () { test( From aaa38bfeb63a3124e3e1d265d6891fa3d8db0901 Mon Sep 17 00:00:00 2001 From: Simon Date: Tue, 24 Dec 2024 02:33:35 -0800 Subject: [PATCH 380/387] Fix mutation codegen (#3876) --- .../legacy/change_notifier_provider.dart | 7 +- .../riverpod/lib/src/common/listenable.dart | 8 +- packages/riverpod/lib/src/common/result.dart | 16 +- packages/riverpod/lib/src/core/element.dart | 15 +- .../lib/src/core/modifiers/future.dart | 11 +- .../lib/src/core/modifiers/select.dart | 18 +- .../lib/src/core/modifiers/select_async.dart | 8 +- .../src/core/provider/notifier_provider.dart | 7 +- .../lib/src/core/provider_subscription.dart | 2 +- .../src/core/proxy_provider_listenable.dart | 8 +- packages/riverpod/lib/src/mutation.dart | 8 +- .../legacy/state_notifier_provider.dart | 7 +- .../src/providers/legacy/state_provider.dart | 9 +- .../lib/src/providers/stream_provider.dart | 7 +- .../riverpod/test/src/common/result_test.dart | 24 +- .../lib/riverpod_annotation.dart | 7 + .../lib/src/templates/element.dart | 8 +- .../lib/src/templates/mutation.dart | 6 +- .../lib/src/templates/provider.dart | 2 +- .../test/integration/mutation.dart | 73 +---- .../test/integration/mutation.g.dart | 273 +++++++++++++----- .../test/mutation_test.dart | 15 + 22 files changed, 320 insertions(+), 219 deletions(-) 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 index 9d3d814b9..5031ad323 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -167,13 +167,13 @@ class ChangeNotifierProviderElement @override final ChangeNotifierProvider provider; - final _notifierNotifier = ProxyElementValueListenable(); + final _notifierNotifier = $ElementLense(); void Function()? _removeListener; @override void create(Ref ref, {required bool didChangeDependency}) { - final notifierResult = _notifierNotifier.result = Result.guard( + final notifierResult = _notifierNotifier.result = $Result.guard( () => provider._createFn(ref), ); @@ -208,8 +208,7 @@ class ChangeNotifierProviderElement @override void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, + required void Function($ElementLense element) listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, diff --git a/packages/riverpod/lib/src/common/listenable.dart b/packages/riverpod/lib/src/common/listenable.dart index 7a615a3ba..9689865cc 100644 --- a/packages/riverpod/lib/src/common/listenable.dart +++ b/packages/riverpod/lib/src/common/listenable.dart @@ -19,7 +19,7 @@ class _Listener { /// to subsets of the state exposed by a provider. @internal @optionalTypeArgs -class ProxyElementValueListenable extends _ValueListenable { +class $ElementLense extends _ValueListenable { /// Directly obtain the value exposed, gratefully handling cases where /// [result] is null or in error state. T get value { @@ -33,9 +33,9 @@ class ProxyElementValueListenable extends _ValueListenable { /// The state associated with this notifier. /// /// Modifying this property will notify listeners. - Result? get result => _result; - Result? _result; - set result(Result? value) { + $Result? get result => _result; + $Result? _result; + set result($Result? value) { final previous = _result; _result = value; diff --git a/packages/riverpod/lib/src/common/result.dart b/packages/riverpod/lib/src/common/result.dart index bb9d9a938..535be3d77 100644 --- a/packages/riverpod/lib/src/common/result.dart +++ b/packages/riverpod/lib/src/common/result.dart @@ -3,24 +3,24 @@ import 'package:meta/meta.dart'; /// A T|Error union type. @immutable @internal -sealed class Result { +sealed class $Result { /// The data case // coverage:ignore-start - factory Result.data(State state) = ResultData; + factory $Result.data(State state) = ResultData; // coverage:ignore-end /// The error case // coverage:ignore-start - factory Result.error(Object error, StackTrace stackTrace) = ResultError; + factory $Result.error(Object error, StackTrace stackTrace) = ResultError; // coverage:ignore-end /// Automatically catches errors into a [ResultError] and convert successful /// values into a [ResultData]. - static Result guard(State Function() cb) { + static $Result guard(State Function() cb) { try { - return Result.data(cb()); + return $Result.data(cb()); } catch (err, stack) { - return Result.error(err, stack); + return $Result.error(err, stack); } } @@ -36,7 +36,7 @@ sealed class Result { /// The data case @internal -class ResultData implements Result { +class ResultData implements $Result { /// The data case ResultData(this.state); @@ -64,7 +64,7 @@ class ResultData implements Result { /// The error case @internal -class ResultError implements Result { +class ResultError implements $Result { /// The error case ResultError(this.error, this.stackTrace); diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 58dd8045d..b0902b27e 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -126,7 +126,7 @@ abstract class ProviderElement implements Node { var _didMount = false; /* STATE */ - Result? _stateResult; + $Result? _stateResult; /// The current state of the provider. /// @@ -138,7 +138,7 @@ abstract class ProviderElement implements Node { /// /// This is not meant for public consumption. Instead, public API should use /// [readSelf]. - Result? get stateResult => _stateResult; + $Result? get stateResult => _stateResult; /// Returns the currently exposed by a provider /// @@ -156,7 +156,7 @@ abstract class ProviderElement implements Node { /// /// This API is not meant for public consumption. Instead if a [Ref] needs /// to expose a way to update the state, the practice is to expose a getter/setter. - void setStateResult(Result newState) { + void setStateResult($Result newState) { if (kDebugMode) _debugDidSetState = true; final previousResult = stateResult; @@ -344,7 +344,7 @@ This could mean a few things: } catch (err, stack) { if (kDebugMode) _debugDidSetState = true; - _stateResult = Result.error(err, stack); + _stateResult = $Result.error(err, stack); triggerRetry(err); } finally { _didBuild = true; @@ -428,8 +428,8 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } void _notifyListeners( - Result newState, - Result? previousStateResult, { + $Result newState, + $Result? previousStateResult, { bool checkUpdateShouldNotify = true, bool isMount = false, }) { @@ -805,8 +805,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu /// [Ref.listen] multiple times to an element, it may be visited multiple times. void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, + required void Function($ElementLense element) listenableVisitor, }) { void lookup(Iterable children) { for (final child in children) { diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 1391ce31f..0184c6e67 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -239,7 +239,7 @@ mixin FutureModifierElement on ProviderElement> { /// An observable for [FutureProvider.future]. @internal - final futureNotifier = ProxyElementValueListenable>(); + final futureNotifier = $ElementLense>(); Completer? _futureCompleter; Future? _lastFuture; AsyncSubscription? _cancelSubscription; @@ -270,7 +270,7 @@ mixin FutureModifierElement on ProviderElement> { @override @protected - void setStateResult(Result> newState) { + void setStateResult($Result> newState) { newState.requireState.map( loading: onLoading, error: onError, @@ -314,7 +314,7 @@ mixin FutureModifierElement on ProviderElement> { ); _futureCompleter = null; } else { - futureNotifier.result = Result.data( + futureNotifier.result = $Result.data( Future.error( value.error, value.stackTrace, @@ -336,7 +336,7 @@ mixin FutureModifierElement on ProviderElement> { completer.complete(value.value); _futureCompleter = null; } else { - futureNotifier.result = Result.data(Future.value(value.value)); + futureNotifier.result = $Result.data(Future.value(value.value)); } } @@ -515,8 +515,7 @@ mixin FutureModifierElement on ProviderElement> { @override void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, + required void Function($ElementLense element) listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, diff --git a/packages/riverpod/lib/src/core/modifiers/select.dart b/packages/riverpod/lib/src/core/modifiers/select.dart index b9bf77388..69494b858 100644 --- a/packages/riverpod/lib/src/core/modifiers/select.dart +++ b/packages/riverpod/lib/src/core/modifiers/select.dart @@ -39,17 +39,17 @@ class _ProviderSelector /// The selector applied final OutputT Function(InputT) selector; - Result _select(Result value) { + $Result _select($Result value) { if (kDebugMode) _debugIsRunningSelector = true; try { return switch (value) { - ResultData(:final state) => Result.data(selector(state)), + ResultData(:final state) => $Result.data(selector(state)), ResultError(:final error, :final stackTrace) => - Result.error(error, stackTrace), + $Result.error(error, stackTrace), }; } catch (err, stack) { - return Result.error(err, stack); + return $Result.error(err, stack); } finally { if (kDebugMode) _debugIsRunningSelector = false; } @@ -57,12 +57,12 @@ class _ProviderSelector void _selectOnChange({ required InputT newState, - required Result? lastSelectedValue, + required $Result? lastSelectedValue, required void Function(Object error, StackTrace stackTrace) onError, required void Function(OutputT? prev, OutputT next) listener, - required void Function(Result newState) onChange, + required void Function($Result newState) onChange, }) { - final newSelectedValue = _select(Result.data(newState)); + final newSelectedValue = _select($Result.data(newState)); if (lastSelectedValue == null || !lastSelectedValue.hasState || !newSelectedValue.hasState || @@ -91,7 +91,7 @@ class _ProviderSelector }) { onError ??= Zone.current.handleUncaughtError; - Result? lastSelectedValue; + $Result? lastSelectedValue; final sub = provider.addListener( node, (prev, input) { @@ -109,7 +109,7 @@ class _ProviderSelector onError: onError, ); - if (!weak) lastSelectedValue = _select(Result.guard(sub.read)); + if (!weak) lastSelectedValue = _select($Result.guard(sub.read)); if (fireImmediately) { _handleFireImmediately( diff --git a/packages/riverpod/lib/src/core/modifiers/select_async.dart b/packages/riverpod/lib/src/core/modifiers/select_async.dart index ffb3bd42c..9fa483503 100644 --- a/packages/riverpod/lib/src/core/modifiers/select_async.dart +++ b/packages/riverpod/lib/src/core/modifiers/select_async.dart @@ -22,13 +22,13 @@ class _AsyncSelector /// The selector applied final OutputT Function(InputT) selector; - Result _select(InputT value) { + $Result _select(InputT value) { if (kDebugMode) _debugIsRunningSelector = true; try { - return Result.data(selector(value)); + return $Result.data(selector(value)); } catch (err, stack) { - return Result.error(err, stack); + return $Result.error(err, stack); } finally { if (kDebugMode) _debugIsRunningSelector = false; } @@ -43,7 +43,7 @@ class _AsyncSelector required bool fireImmediately, required bool weak, }) { - Result? lastSelectedValue; + $Result? lastSelectedValue; Completer? selectedCompleter; Future? selectedFuture; diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index b387f128d..19b92b99a 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -187,7 +187,7 @@ abstract class ClassProviderElement< // @override $ClassProvider get provider; - final classListenable = ProxyElementValueListenable(); + final classListenable = $ElementLense(); @mustCallSuper @override @@ -198,7 +198,7 @@ abstract class ClassProviderElement< // }) { final seamless = !didChangeDependency; - final result = classListenable.result = Result.guard(() { + final result = classListenable.result = $Result.guard(() { final notifier = provider.create(); if (notifier._ref != null) { throw StateError(alreadyInitializedError); @@ -250,8 +250,7 @@ abstract class ClassProviderElement< // @override void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, + required void Function($ElementLense element) listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index 421a72790..a3e5238ef 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -369,7 +369,7 @@ final class ProviderStateSubscription /// Deals with the internals of synchronously calling the listeners /// when using `fireImmediately: true` void _handleFireImmediately( - Result currentState, { + $Result currentState, { required void Function(StateT? previous, StateT current) listener, required void Function(Object error, StackTrace stackTrace) onError, }) { diff --git a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart index 94e9651b8..0fde2bb5b 100644 --- a/packages/riverpod/lib/src/core/proxy_provider_listenable.dart +++ b/packages/riverpod/lib/src/core/proxy_provider_listenable.dart @@ -1,11 +1,11 @@ part of '../framework.dart'; -class LazyProxyListenable +class $LazyProxyListenable with ProviderListenable, ProviderListenableWithOrigin { - LazyProxyListenable(this.provider, this._lense); + $LazyProxyListenable(this.provider, this._lense); final ProviderBase provider; - final ProxyElementValueListenable Function( + final $ElementLense Function( ProviderElement element, ) _lense; @@ -100,7 +100,7 @@ class ProviderElementProxy @override final ProviderBase provider; - final ProxyElementValueListenable Function( + final $ElementLense Function( ProviderElement element, ) _lense; diff --git a/packages/riverpod/lib/src/mutation.dart b/packages/riverpod/lib/src/mutation.dart index 2e922953c..1ac949fe1 100644 --- a/packages/riverpod/lib/src/mutation.dart +++ b/packages/riverpod/lib/src/mutation.dart @@ -363,7 +363,7 @@ abstract class $SyncMutationBase< @override void setData(StateT value) { - element.setStateResult(Result.data(value)); + element.setStateResult($Result.data(value)); } } @@ -377,7 +377,7 @@ abstract class $AsyncMutationBase< @override void setData(StateT value) { - element.setStateResult(Result.data(AsyncData(value))); + element.setStateResult($Result.data(AsyncData(value))); } } @@ -397,7 +397,7 @@ abstract class _MutationBase< final Object? key; ClassProviderElement get element; - ProxyElementValueListenable get listenable; + $ElementLense get listenable; Object? get _currentKey => listenable.result?.stateOrNull?.key; @@ -431,7 +431,7 @@ abstract class _MutationBase< } void _setState(MutationContext? mutationContext, MutationT mutation) { - listenable.result = Result.data(mutation); + listenable.result = $Result.data(mutation); final obsContext = ProviderObserverContext( element.origin, diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index a46f22601..d1040f08a 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -172,13 +172,13 @@ class StateNotifierProviderElement, @override final StateNotifierProvider provider; - final _notifierNotifier = ProxyElementValueListenable(); + final _notifierNotifier = $ElementLense(); void Function()? _removeListener; @override void create(Ref ref, {required bool didChangeDependency}) { - final notifier = _notifierNotifier.result = Result.guard( + final notifier = _notifierNotifier.result = $Result.guard( () => provider._create(ref), ); @@ -212,8 +212,7 @@ class StateNotifierProviderElement, @override void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, + required void Function($ElementLense element) listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 1d2006d7f..7a454aa8e 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -119,9 +119,9 @@ class StateProviderElement extends ProviderElement { @override final StateProvider provider; - final _controllerNotifier = ProxyElementValueListenable>(); + final _controllerNotifier = $ElementLense>(); - final _stateNotifier = ProxyElementValueListenable>(); + final _stateNotifier = $ElementLense>(); void Function()? _removeListener; @@ -133,7 +133,7 @@ class StateProviderElement extends ProviderElement { final initialState = provider._createFn(ref); final controller = StateController(initialState); - _controllerNotifier.result = Result.data(controller); + _controllerNotifier.result = $Result.data(controller); _removeListener = controller.addListener( fireImmediately: true, @@ -163,8 +163,7 @@ class StateProviderElement extends ProviderElement { @override void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, + required void Function($ElementLense element) listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index a87e0bc6e..140d07698 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -160,7 +160,7 @@ class $StreamProviderElement extends ProviderElement> @override final $StreamProvider provider; - final _streamNotifier = ProxyElementValueListenable>(); + final _streamNotifier = $ElementLense>(); final StreamController _streamController = StreamController.broadcast(); @@ -170,7 +170,7 @@ class $StreamProviderElement extends ProviderElement> required bool didChangeDependency, }) { asyncTransition(AsyncLoading(), seamless: !didChangeDependency); - _streamNotifier.result ??= Result.data(_streamController.stream); + _streamNotifier.result ??= $Result.data(_streamController.stream); handleStream( () => provider.create(ref), @@ -190,8 +190,7 @@ class $StreamProviderElement extends ProviderElement> @override void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, + required void Function($ElementLense element) listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, diff --git a/packages/riverpod/test/src/common/result_test.dart b/packages/riverpod/test/src/common/result_test.dart index 902634c8c..e7e1fec01 100644 --- a/packages/riverpod/test/src/common/result_test.dart +++ b/packages/riverpod/test/src/common/result_test.dart @@ -4,32 +4,32 @@ import 'package:test/test.dart'; void main() { group('Result.data', () { test('implements hashCode/==', () { - expect(Result.data(42), Result.data(42)); - expect(Result.data(42), isNot(Result.data(21))); + expect($Result.data(42), $Result.data(42)); + expect($Result.data(42), isNot($Result.data(21))); - expect(Result.data(42).hashCode, Result.data(42).hashCode); - expect(Result.data(42).hashCode, isNot(Result.data(21).hashCode)); + expect($Result.data(42).hashCode, $Result.data(42).hashCode); + expect($Result.data(42).hashCode, isNot($Result.data(21).hashCode)); }); }); group('Result.error', () { test('implements hashCode/==', () { expect( - Result.error(42, StackTrace.empty), - Result.error(42, StackTrace.empty), + $Result.error(42, StackTrace.empty), + $Result.error(42, StackTrace.empty), ); expect( - Result.error(42, StackTrace.empty), - isNot(Result.error(21, StackTrace.empty)), + $Result.error(42, StackTrace.empty), + isNot($Result.error(21, StackTrace.empty)), ); expect( - Result.error(42, StackTrace.empty).hashCode, - Result.error(42, StackTrace.empty).hashCode, + $Result.error(42, StackTrace.empty).hashCode, + $Result.error(42, StackTrace.empty).hashCode, ); expect( - Result.error(42, StackTrace.empty).hashCode, - isNot(Result.error(21, StackTrace.empty).hashCode), + $Result.error(42, StackTrace.empty).hashCode, + isNot($Result.error(21, StackTrace.empty).hashCode), ); }); }); diff --git a/packages/riverpod_annotation/lib/riverpod_annotation.dart b/packages/riverpod_annotation/lib/riverpod_annotation.dart index d8ddb66ab..e449dd69d 100644 --- a/packages/riverpod_annotation/lib/riverpod_annotation.dart +++ b/packages/riverpod_annotation/lib/riverpod_annotation.dart @@ -25,6 +25,13 @@ export 'package:riverpod/src/internals.dart' $RefArg, $ProviderPointer, + // Mutation/Listenables + ProviderListenable, + $LazyProxyListenable, + ProviderElement, + $ElementLense, + $Result, + // Provider $Provider, $ProviderElement, diff --git a/packages/riverpod_generator/lib/src/templates/element.dart b/packages/riverpod_generator/lib/src/templates/element.dart index 165f24602..8951911a3 100644 --- a/packages/riverpod_generator/lib/src/templates/element.dart +++ b/packages/riverpod_generator/lib/src/templates/element.dart @@ -42,17 +42,17 @@ class ${provider.generatedElementName}$_genericsDefinition extends ${provider.in void _constructorBody(StringBuffer buffer) { for (final mutation in provider.mutations) { buffer.writeln( - ' ${mutation.elementFieldName}.result = Result.data(${mutation.generatedMutationImplName}(this));', + ' ${mutation.elementFieldName}.result = \$Result.data(${mutation.generatedMutationImplName}(this));', ); } } void _overrideVisitChildren(StringBuffer buffer) { - buffer.writeln(''' + buffer.writeln(r''' @override void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) + required void Function($ElementLense element) listenableVisitor, }) { super.visitChildren( @@ -73,7 +73,7 @@ class ${provider.generatedElementName}$_genericsDefinition extends ${provider.in void _fields(StringBuffer buffer) { for (final mutation in provider.mutations) { buffer.writeln( - ' final ${mutation.elementFieldName} = ProxyElementValueListenable<${mutation.generatedMutationImplName}>();', + ' final ${mutation.elementFieldName} = \$ElementLense<${mutation.generatedMutationImplName}>();', ); } } diff --git a/packages/riverpod_generator/lib/src/templates/mutation.dart b/packages/riverpod_generator/lib/src/templates/mutation.dart index 044ec019f..902569b52 100644 --- a/packages/riverpod_generator/lib/src/templates/mutation.dart +++ b/packages/riverpod_generator/lib/src/templates/mutation.dart @@ -56,7 +56,7 @@ final class ${mutation.generatedMutationImplName} final ${provider.generatedElementName} element; @override - ProxyElementValueListenable<${mutation.generatedMutationImplName}> get listenable => element.${mutation.elementFieldName}; + \$ElementLense<${mutation.generatedMutationImplName}> get listenable => element.${mutation.elementFieldName}; @override Future<${provider.valueTypeDisplayString}> call${mutation.node.typeParameters.genericDefinitionDisplayString()}${mutation.node.parameters} { @@ -67,7 +67,7 @@ final class ${mutation.generatedMutationImplName} } @override - ${mutation.generatedMutationImplName} copyWith(MutationState state, {Object? key}) => ${mutation.generatedMutationImplName}(element, state: state, key: key); + ${mutation.generatedMutationImplName} copyWith(MutationState<${provider.valueTypeDisplayString}> state, {Object? key}) => ${mutation.generatedMutationImplName}(element, state: state, key: key); } '''); } @@ -81,7 +81,7 @@ final class ${mutation.generatedMutationImplName} Map? named = Map.fromEntries( mutation.node.parameters?.parameters .where((e) => e.isNamed) - .map((e) => MapEntry(e.name!.lexeme, e.name!.lexeme)) ?? + .map((e) => MapEntry('#${e.name!.lexeme}', e.name!.lexeme)) ?? const [], ); diff --git a/packages/riverpod_generator/lib/src/templates/provider.dart b/packages/riverpod_generator/lib/src/templates/provider.dart index 967f0303f..46729b2fb 100644 --- a/packages/riverpod_generator/lib/src/templates/provider.dart +++ b/packages/riverpod_generator/lib/src/templates/provider.dart @@ -216,7 +216,7 @@ ${provider.doc} final class $name$_genericsDefinition for (final mutation in mutations) { buffer.writeln(''' ProviderListenable<${mutation.generatedMutationInterfaceName}> get ${mutation.name} - => LazyProxyListenable<${mutation.generatedMutationInterfaceName}, ${provider.exposedTypeDisplayString}>( + => \$LazyProxyListenable<${mutation.generatedMutationInterfaceName}, ${provider.exposedTypeDisplayString}>( this, (element) { element as ${provider.generatedElementName}$_generics; diff --git a/packages/riverpod_generator/test/integration/mutation.dart b/packages/riverpod_generator/test/integration/mutation.dart index 08ccca44e..ab8071f79 100644 --- a/packages/riverpod_generator/test/integration/mutation.dart +++ b/packages/riverpod_generator/test/integration/mutation.dart @@ -1,4 +1,3 @@ -import 'package:riverpod/src/internals.dart'; import 'package:riverpod_annotation/riverpod_annotation.dart'; part 'mutation.g.dart'; @@ -86,64 +85,16 @@ class FailingCtor extends _$FailingCtor { Future increment([int inc = 1]) async => state + inc; } -// final mut = ref.watch(aProvider(arg).increment); -// mut(2); - -// class User { -// final String id; -// } - -// class UserSub extends User {} - -// class IList extends List {} - -// @Repository(retry: retry) -// class Users extends _$Users { -// @riverpod -// FutureOr byId(String id) => User(); - -// @riverpod -// Future> home() async => []; - -// @riverpod -// Future> search(String search) async => []; - -// @riverpod -// Future> search(String search) async => []; - -// @riverpod -// Future> search(String search) async => []; - -// @riverpod -// Stream> socketSearch(String search) async => []; - -// @mutation -// Future addUser(User user) async { -// return user; -// } -// } - -// abstract class Repository { -// Map> _all; - -// KeyT key(StateT state); - -// void build(Ref ref); -// } - -// abstract class _$Users extends Repository { -// // User has a .id, so we automatically pick it up as the key -// @override -// String key(User user) => user.id; - -// @override -// void build(ref) { -// observe(providerOrFamily, onAdd: (provider, key, value) { -// ref.mutate((state) => state.add(value)); -// }, onUpdate); -// } -// } +@riverpod +class Typed extends _$Typed { + @override + String build() => 'typed'; -// // ref.watch(usersProvider.byId('123')); -// // ref.watch(usersProvider.home); -// // ref.watch(usersProvider.search('john')); + @mutation + Future mutate( + String one, { + required String two, + required String three, + }) async => + '$one $two $three'; +} diff --git a/packages/riverpod_generator/test/integration/mutation.g.dart b/packages/riverpod_generator/test/integration/mutation.g.dart index e229d3876..7d2f70556 100644 --- a/packages/riverpod_generator/test/integration/mutation.g.dart +++ b/packages/riverpod_generator/test/integration/mutation.g.dart @@ -65,7 +65,7 @@ final class SimpleProvider extends $NotifierProvider { _$SimpleElement(this, pointer); ProviderListenable get increment => - LazyProxyListenable( + $LazyProxyListenable( this, (element) { element as _$SimpleElement; @@ -75,7 +75,7 @@ final class SimpleProvider extends $NotifierProvider { ); ProviderListenable get incrementOr => - LazyProxyListenable( + $LazyProxyListenable( this, (element) { element as _$SimpleElement; @@ -85,7 +85,7 @@ final class SimpleProvider extends $NotifierProvider { ); ProviderListenable get delegated => - LazyProxyListenable( + $LazyProxyListenable( this, (element) { element as _$SimpleElement; @@ -106,13 +106,13 @@ abstract class _$Simple extends $Notifier { class _$SimpleElement extends $NotifierProviderElement { _$SimpleElement(super.provider, super.pointer) { - _$increment.result = Result.data(_$Simple$Increment(this)); - _$incrementOr.result = Result.data(_$Simple$IncrementOr(this)); - _$delegated.result = Result.data(_$Simple$Delegated(this)); + _$increment.result = $Result.data(_$Simple$Increment(this)); + _$incrementOr.result = $Result.data(_$Simple$IncrementOr(this)); + _$delegated.result = $Result.data(_$Simple$Delegated(this)); } - final _$increment = ProxyElementValueListenable<_$Simple$Increment>(); - final _$incrementOr = ProxyElementValueListenable<_$Simple$IncrementOr>(); - final _$delegated = ProxyElementValueListenable<_$Simple$Delegated>(); + final _$increment = $ElementLense<_$Simple$Increment>(); + final _$incrementOr = $ElementLense<_$Simple$IncrementOr>(); + final _$delegated = $ElementLense<_$Simple$Delegated>(); @override void mount() { super.mount(); @@ -124,8 +124,7 @@ class _$SimpleElement extends $NotifierProviderElement { @override void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, + required void Function($ElementLense element) listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, @@ -168,8 +167,7 @@ final class _$Simple$Increment final _$SimpleElement element; @override - ProxyElementValueListenable<_$Simple$Increment> get listenable => - element._$increment; + $ElementLense<_$Simple$Increment> get listenable => element._$increment; @override Future call([int inc = 1]) { @@ -219,8 +217,7 @@ final class _$Simple$IncrementOr final _$SimpleElement element; @override - ProxyElementValueListenable<_$Simple$IncrementOr> get listenable => - element._$incrementOr; + $ElementLense<_$Simple$IncrementOr> get listenable => element._$incrementOr; @override Future call() { @@ -268,8 +265,7 @@ final class _$Simple$Delegated final _$SimpleElement element; @override - ProxyElementValueListenable<_$Simple$Delegated> get listenable => - element._$delegated; + $ElementLense<_$Simple$Delegated> get listenable => element._$delegated; @override Future call(Future Function() fn) { @@ -362,7 +358,7 @@ final class SimpleFamilyProvider extends $NotifierProvider { _$SimpleFamilyElement(this, pointer); ProviderListenable get increment => - LazyProxyListenable( + $LazyProxyListenable( this, (element) { element as _$SimpleFamilyElement; @@ -372,7 +368,7 @@ final class SimpleFamilyProvider extends $NotifierProvider { ); ProviderListenable get incrementOr => - LazyProxyListenable( + $LazyProxyListenable( this, (element) { element as _$SimpleFamilyElement; @@ -471,12 +467,11 @@ abstract class _$SimpleFamily extends $Notifier { class _$SimpleFamilyElement extends $NotifierProviderElement { _$SimpleFamilyElement(super.provider, super.pointer) { - _$increment.result = Result.data(_$SimpleFamily$Increment(this)); - _$incrementOr.result = Result.data(_$SimpleFamily$IncrementOr(this)); + _$increment.result = $Result.data(_$SimpleFamily$Increment(this)); + _$incrementOr.result = $Result.data(_$SimpleFamily$IncrementOr(this)); } - final _$increment = ProxyElementValueListenable<_$SimpleFamily$Increment>(); - final _$incrementOr = - ProxyElementValueListenable<_$SimpleFamily$IncrementOr>(); + final _$increment = $ElementLense<_$SimpleFamily$Increment>(); + final _$incrementOr = $ElementLense<_$SimpleFamily$IncrementOr>(); @override void mount() { super.mount(); @@ -487,8 +482,7 @@ class _$SimpleFamilyElement @override void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, + required void Function($ElementLense element) listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, @@ -530,8 +524,7 @@ final class _$SimpleFamily$Increment final _$SimpleFamilyElement element; @override - ProxyElementValueListenable<_$SimpleFamily$Increment> get listenable => - element._$increment; + $ElementLense<_$SimpleFamily$Increment> get listenable => element._$increment; @override Future call([int inc = 1]) { @@ -581,7 +574,7 @@ final class _$SimpleFamily$IncrementOr final _$SimpleFamilyElement element; @override - ProxyElementValueListenable<_$SimpleFamily$IncrementOr> get listenable => + $ElementLense<_$SimpleFamily$IncrementOr> get listenable => element._$incrementOr; @override @@ -653,7 +646,7 @@ final class SimpleAsyncProvider _$SimpleAsyncElement(this, pointer); ProviderListenable get increment => - LazyProxyListenable>( + $LazyProxyListenable>( this, (element) { element as _$SimpleAsyncElement; @@ -663,7 +656,7 @@ final class SimpleAsyncProvider ); ProviderListenable get delegated => - LazyProxyListenable>( + $LazyProxyListenable>( this, (element) { element as _$SimpleAsyncElement; @@ -685,11 +678,11 @@ abstract class _$SimpleAsync extends $AsyncNotifier { class _$SimpleAsyncElement extends $AsyncNotifierProviderElement { _$SimpleAsyncElement(super.provider, super.pointer) { - _$increment.result = Result.data(_$SimpleAsync$Increment(this)); - _$delegated.result = Result.data(_$SimpleAsync$Delegated(this)); + _$increment.result = $Result.data(_$SimpleAsync$Increment(this)); + _$delegated.result = $Result.data(_$SimpleAsync$Delegated(this)); } - final _$increment = ProxyElementValueListenable<_$SimpleAsync$Increment>(); - final _$delegated = ProxyElementValueListenable<_$SimpleAsync$Delegated>(); + final _$increment = $ElementLense<_$SimpleAsync$Increment>(); + final _$delegated = $ElementLense<_$SimpleAsync$Delegated>(); @override void mount() { super.mount(); @@ -700,8 +693,7 @@ class _$SimpleAsyncElement @override void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, + required void Function($ElementLense element) listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, @@ -743,8 +735,7 @@ final class _$SimpleAsync$Increment final _$SimpleAsyncElement element; @override - ProxyElementValueListenable<_$SimpleAsync$Increment> get listenable => - element._$increment; + $ElementLense<_$SimpleAsync$Increment> get listenable => element._$increment; @override Future call([int inc = 1]) { @@ -794,8 +785,7 @@ final class _$SimpleAsync$Delegated final _$SimpleAsyncElement element; @override - ProxyElementValueListenable<_$SimpleAsync$Delegated> get listenable => - element._$delegated; + $ElementLense<_$SimpleAsync$Delegated> get listenable => element._$delegated; @override Future call(Future Function() fn) { @@ -881,7 +871,7 @@ final class SimpleAsync2Provider _$SimpleAsync2Element(this, pointer); ProviderListenable get increment => - LazyProxyListenable>( + $LazyProxyListenable>( this, (element) { element as _$SimpleAsync2Element; @@ -980,9 +970,9 @@ abstract class _$SimpleAsync2 extends $StreamNotifier { class _$SimpleAsync2Element extends $StreamNotifierProviderElement { _$SimpleAsync2Element(super.provider, super.pointer) { - _$increment.result = Result.data(_$SimpleAsync2$Increment(this)); + _$increment.result = $Result.data(_$SimpleAsync2$Increment(this)); } - final _$increment = ProxyElementValueListenable<_$SimpleAsync2$Increment>(); + final _$increment = $ElementLense<_$SimpleAsync2$Increment>(); @override void mount() { super.mount(); @@ -992,8 +982,7 @@ class _$SimpleAsync2Element @override void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, + required void Function($ElementLense element) listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, @@ -1034,8 +1023,7 @@ final class _$SimpleAsync2$Increment final _$SimpleAsync2Element element; @override - ProxyElementValueListenable<_$SimpleAsync2$Increment> get listenable => - element._$increment; + $ElementLense<_$SimpleAsync2$Increment> get listenable => element._$increment; @override Future call() { @@ -1131,7 +1119,7 @@ final class GenericProvider _$GenericElement(this, pointer); ProviderListenable get increment => - LazyProxyListenable>( + $LazyProxyListenable>( this, (element) { element as _$GenericElement; @@ -1212,9 +1200,9 @@ abstract class _$Generic extends $AsyncNotifier { class _$GenericElement extends $AsyncNotifierProviderElement, int> { _$GenericElement(super.provider, super.pointer) { - _$increment.result = Result.data(_$Generic$Increment(this)); + _$increment.result = $Result.data(_$Generic$Increment(this)); } - final _$increment = ProxyElementValueListenable<_$Generic$Increment>(); + final _$increment = $ElementLense<_$Generic$Increment>(); @override void mount() { super.mount(); @@ -1224,8 +1212,7 @@ class _$GenericElement @override void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, + required void Function($ElementLense element) listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, @@ -1266,8 +1253,7 @@ final class _$Generic$Increment final _$GenericElement element; @override - ProxyElementValueListenable<_$Generic$Increment> get listenable => - element._$increment; + $ElementLense<_$Generic$Increment> get listenable => element._$increment; @override Future call() { @@ -1336,7 +1322,7 @@ final class GenericMutProvider extends $AsyncNotifierProvider { _$GenericMutElement(this, pointer); ProviderListenable get increment => - LazyProxyListenable>( + $LazyProxyListenable>( this, (element) { element as _$GenericMutElement; @@ -1358,9 +1344,9 @@ abstract class _$GenericMut extends $AsyncNotifier { class _$GenericMutElement extends $AsyncNotifierProviderElement { _$GenericMutElement(super.provider, super.pointer) { - _$increment.result = Result.data(_$GenericMut$Increment(this)); + _$increment.result = $Result.data(_$GenericMut$Increment(this)); } - final _$increment = ProxyElementValueListenable<_$GenericMut$Increment>(); + final _$increment = $ElementLense<_$GenericMut$Increment>(); @override void mount() { super.mount(); @@ -1370,8 +1356,7 @@ class _$GenericMutElement @override void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, + required void Function($ElementLense element) listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, @@ -1412,8 +1397,7 @@ final class _$GenericMut$Increment final _$GenericMutElement element; @override - ProxyElementValueListenable<_$GenericMut$Increment> get listenable => - element._$increment; + $ElementLense<_$GenericMut$Increment> get listenable => element._$increment; @override Future call(T value) { @@ -1493,7 +1477,7 @@ final class FailingCtorProvider extends $NotifierProvider { _$FailingCtorElement(this, pointer); ProviderListenable get increment => - LazyProxyListenable( + $LazyProxyListenable( this, (element) { element as _$FailingCtorElement; @@ -1514,9 +1498,9 @@ abstract class _$FailingCtor extends $Notifier { class _$FailingCtorElement extends $NotifierProviderElement { _$FailingCtorElement(super.provider, super.pointer) { - _$increment.result = Result.data(_$FailingCtor$Increment(this)); + _$increment.result = $Result.data(_$FailingCtor$Increment(this)); } - final _$increment = ProxyElementValueListenable<_$FailingCtor$Increment>(); + final _$increment = $ElementLense<_$FailingCtor$Increment>(); @override void mount() { super.mount(); @@ -1526,8 +1510,7 @@ class _$FailingCtorElement extends $NotifierProviderElement { @override void visitChildren({ required void Function(ProviderElement element) elementVisitor, - required void Function(ProxyElementValueListenable element) - listenableVisitor, + required void Function($ElementLense element) listenableVisitor, }) { super.visitChildren( elementVisitor: elementVisitor, @@ -1568,8 +1551,7 @@ final class _$FailingCtor$Increment final _$FailingCtorElement element; @override - ProxyElementValueListenable<_$FailingCtor$Increment> get listenable => - element._$increment; + $ElementLense<_$FailingCtor$Increment> get listenable => element._$increment; @override Future call([int inc = 1]) { @@ -1589,5 +1571,158 @@ final class _$FailingCtor$Increment _$FailingCtor$Increment(element, state: state, key: key); } +@ProviderFor(Typed) +const typedProvider = TypedProvider._(); + +final class TypedProvider extends $NotifierProvider { + const TypedProvider._( + {super.runNotifierBuildOverride, Typed Function()? create}) + : _createCb = create, + super( + from: null, + argument: null, + retry: null, + name: r'typedProvider', + isAutoDispose: true, + dependencies: null, + allTransitiveDependencies: null, + ); + + final Typed Function()? _createCb; + + @override + String debugGetCreateSourceHash() => _$typedHash(); + + /// {@macro riverpod.override_with_value} + Override overrideWithValue(String value) { + return $ProviderOverride( + origin: this, + providerOverride: $ValueProvider(value), + ); + } + + @$internal + @override + Typed create() => _createCb?.call() ?? Typed(); + + @$internal + @override + TypedProvider $copyWithCreate( + Typed Function() create, + ) { + return TypedProvider._(create: create); + } + + @$internal + @override + TypedProvider $copyWithBuild( + String Function( + Ref, + Typed, + ) build, + ) { + return TypedProvider._(runNotifierBuildOverride: build); + } + + @$internal + @override + _$TypedElement $createElement($ProviderPointer pointer) => + _$TypedElement(this, pointer); + + ProviderListenable get mutate => + $LazyProxyListenable( + this, + (element) { + element as _$TypedElement; + + return element._$mutate; + }, + ); +} + +String _$typedHash() => r'1f53e16796771d14fcdfec41d2b9f5eb70d875a7'; + +abstract class _$Typed extends $Notifier { + String build(); + @$internal + @override + String runBuild() => build(); +} + +class _$TypedElement extends $NotifierProviderElement { + _$TypedElement(super.provider, super.pointer) { + _$mutate.result = $Result.data(_$Typed$Mutate(this)); + } + final _$mutate = $ElementLense<_$Typed$Mutate>(); + @override + void mount() { + super.mount(); + _$mutate.result!.stateOrNull!.reset(); + } + + @override + void visitChildren({ + required void Function(ProviderElement element) elementVisitor, + required void Function($ElementLense element) listenableVisitor, + }) { + super.visitChildren( + elementVisitor: elementVisitor, + listenableVisitor: listenableVisitor, + ); + + listenableVisitor(_$mutate); + } +} + +sealed class Typed$Mutate extends MutationBase { + /// Starts the mutation. + /// + /// This will first set the state to [PendingMutationState], then + /// will call [Typed.mutate] with the provided parameters. + /// + /// After the method completes, the mutation state will be updated to either + /// [SuccessMutationState] or [ErrorMutationState] based on if the method + /// threw or not. + /// + /// Lastly, if the method completes without throwing, the Notifier's state + /// will be updated with the new value. + /// + /// **Note**: + /// If the notifier threw in its constructor, the mutation won't start + /// and [call] will throw. + /// This should generally never happen though, as Notifiers are not supposed + /// to have logic in their constructors. + Future call(String one, {required String two, required String three}); +} + +final class _$Typed$Mutate + extends $SyncMutationBase + implements Typed$Mutate { + _$Typed$Mutate(this.element, {super.state, super.key}); + + @override + final _$TypedElement element; + + @override + $ElementLense<_$Typed$Mutate> get listenable => element._$mutate; + + @override + Future call(String one, + {required String two, required String three}) { + return mutateAsync( + Invocation.method(#mutate, [one], {#two: two, #three: three}), + ($notifier) => $notifier.mutate( + one, + two: two, + three: three, + ), + ); + } + + @override + _$Typed$Mutate copyWith(MutationState state, {Object? key}) => + _$Typed$Mutate(element, state: state, key: key); +} + // ignore_for_file: type=lint // ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member, deprecated_member_use_from_same_package diff --git a/packages/riverpod_generator/test/mutation_test.dart b/packages/riverpod_generator/test/mutation_test.dart index 27c19696f..65d317563 100644 --- a/packages/riverpod_generator/test/mutation_test.dart +++ b/packages/riverpod_generator/test/mutation_test.dart @@ -248,6 +248,21 @@ void main() { verifyNever(observer.mutationError(any, any, any, any)); }); + test('Typed providers and named parameters', () async { + final container = ProviderContainer.test(); + + final sub = container.listen(typedProvider.mutate, (a, b) {}); + + expect(container.read(typedProvider), 'typed'); + + await sub.read().call('five', two: 'six', three: 'seven'); + + expect( + sub.read(), + isMutationBase(state: isSuccessMutationState('five six seven')), + ); + }); + group('reset', () { test('Supports calling reset while pending', () async { final container = ProviderContainer.test(); From e06630c898883fb54486965a6e7ba9cfca60549f Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Sun, 29 Dec 2024 21:04:00 +0100 Subject: [PATCH 381/387] Add test --- packages/riverpod/lib/src/core/element.dart | 2 +- .../test/src/core/provider_element_test.dart | 34 +++++++++++++++++-- 2 files changed, 33 insertions(+), 3 deletions(-) diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index b0902b27e..31044754e 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -49,7 +49,7 @@ abstract class ProviderElement implements Node { static Duration? _defaultRetry(int retryCount, Object error) { return Duration( - milliseconds: math.min(200 * (retryCount + 1), 6400), + milliseconds: math.min(200 * math.pow(2, retryCount).toInt(), 6400), ); } diff --git a/packages/riverpod/test/src/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart index 10e939e7f..4114cf560 100644 --- a/packages/riverpod/test/src/core/provider_element_test.dart +++ b/packages/riverpod/test/src/core/provider_element_test.dart @@ -38,9 +38,39 @@ void main() { group('retry', () { test( - skip: 'unimplemented', 'default retry delays from 200ms to 6.4 seconds', - () {}, + () => fakeAsync((fake) async { + final container = ProviderContainer.test(); + var buildCount = 0; + final provider = Provider((ref) { + buildCount++; + throw StateError(''); + }); + + container.listen( + provider, + (prev, next) {}, + fireImmediately: true, + onError: (e, s) {}, + ); + + const times = [ + 200, + 400, + 800, + 1600, + 3200, + 6400, + ]; + + for (final (index, time) in times.indexed) { + fake.elapse(Duration(milliseconds: time - 10)); + expect(buildCount, index + 1, reason: 'expect retry time of $time'); + + fake.elapse(const Duration(milliseconds: 10)); + expect(buildCount, index + 2); + } + }), ); group('custom retry', () { From deca6d3ccebf3b16f686bf67d06b1bc836002f67 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 8 Jan 2025 15:32:31 +0100 Subject: [PATCH 382/387] Pause subscriptions while a provider rebuilds (#3911) ## Related Issues fixes #1253 ## Checklist Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (`[x]`). - [x] I have updated the `CHANGELOG.md` of the relevant packages. Changelog files must be edited under the form: ```md ## Unreleased fix/major/minor - Description of your change. (thanks to @yourGithubId) ``` - [x] If this contains new features or behavior changes, I have updated the documentation to match those changes. --- analysis_options.yaml | 1 + examples/marvel/analysis_options.yaml | 3 - .../legacy/change_notifier_provider.dart | 4 +- packages/riverpod/CHANGELOG.md | 3 + packages/riverpod/lib/riverpod.dart | 1 + packages/riverpod/lib/src/core/element.dart | 64 ++++++++++++++++--- .../lib/src/core/modifiers/future.dart | 21 ++++-- .../lib/src/core/override_with_value.dart | 4 +- .../src/core/provider/notifier_provider.dart | 4 +- .../lib/src/core/provider_container.dart | 2 +- .../lib/src/core/provider_subscription.dart | 5 ++ .../lib/src/providers/future_provider.dart | 4 +- .../legacy/state_notifier_provider.dart | 4 +- .../src/providers/legacy/state_provider.dart | 4 +- .../riverpod/lib/src/providers/provider.dart | 4 +- .../lib/src/providers/stream_provider.dart | 4 +- .../src/core/modifiers/select_async_test.dart | 8 +-- .../test/src/core/provider_element_test.dart | 50 +++++++++++++++ packages/riverpod/test/src/core/ref_test.dart | 15 +++-- 19 files changed, 167 insertions(+), 38 deletions(-) diff --git a/analysis_options.yaml b/analysis_options.yaml index f7880c29b..53072d418 100644 --- a/analysis_options.yaml +++ b/analysis_options.yaml @@ -14,6 +14,7 @@ analyzer: # I prefer specifying a parameter on a widget even if they are unused (such as Key) # for the sake of consistency. unused_element_parameter: false + unrecognized_error_code: ignore linter: rules: diff --git a/examples/marvel/analysis_options.yaml b/examples/marvel/analysis_options.yaml index 611834f1a..fd37ac1ff 100644 --- a/examples/marvel/analysis_options.yaml +++ b/examples/marvel/analysis_options.yaml @@ -6,6 +6,3 @@ analyzer: errors: # Some assets are voluntarily gitignored asset_does_not_exist: ignore - # I prefer specifying a parameter on a widget even if they are unused (such as Key) - # for the sake of consistency. - unused_element_parameter: false \ No newline at end of file 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 index 5031ad323..d65558502 100644 --- a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart +++ b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart @@ -172,7 +172,7 @@ class ChangeNotifierProviderElement void Function()? _removeListener; @override - void create(Ref ref, {required bool didChangeDependency}) { + WhenComplete create(Ref ref, {required bool didChangeDependency}) { final notifierResult = _notifierNotifier.result = $Result.guard( () => provider._createFn(ref), ); @@ -186,6 +186,8 @@ class ChangeNotifierProviderElement notifier.addListener(listener); _removeListener = () => notifier.removeListener(listener); } + + return null; } @override diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 1452ccaab..88975009c 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -24,6 +24,9 @@ - **Breaking**: A provider is now considered "paused" if all of its listeners are also paused. So if a provider `A` is watched _only_ by a provider `B`, and `B` is currently unused, then `A` will be paused. +- **Breaking**: When an asynchronous provider rebuilds, it doesn't immediately stops + listening to its previous providers. Instead, those subscriptions are removed when the rebuild completes. + This impacts how "auto-dispose" behaves. - Fix `StreamProvider` not cancelling the `StreamSubscription` if the stream is never emitted any value. - All `Ref` life-cycles (such as `Ref.onDispose`) and `Notifier.listenSelf` now return a function to remove the listener. diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart index 531661a21..8c6f97aa6 100644 --- a/packages/riverpod/lib/riverpod.dart +++ b/packages/riverpod/lib/riverpod.dart @@ -8,6 +8,7 @@ export 'src/framework.dart' $ValueProvider, FamilyCreate, FunctionalFamily, + WhenComplete, $FamilyOverride, ClassFamily, SetupFamilyOverride, diff --git a/packages/riverpod/lib/src/core/element.dart b/packages/riverpod/lib/src/core/element.dart index 31044754e..013609370 100644 --- a/packages/riverpod/lib/src/core/element.dart +++ b/packages/riverpod/lib/src/core/element.dart @@ -30,6 +30,9 @@ mixin _ProviderRefreshable @internal void Function()? debugCanModifyProviders; +@internal +typedef WhenComplete = void Function(void Function() cb)?; + /// {@template riverpod.provider_element_base} /// An internal class that handles the state of a provider. /// @@ -96,6 +99,7 @@ abstract class ProviderElement implements Node { /// excluding `listen(weak: true)`. bool get hasNonWeakListeners => _listenerCount > 0; + List? _inactiveSubscriptions; @visibleForTesting List? subscriptions; @visibleForTesting @@ -280,7 +284,7 @@ This could mean a few things: /// - [didChangeDependency] can be used to differentiate a rebuild caused /// by [Ref.watch] from one caused by [Ref.refresh]/[Ref.invalidate]. @visibleForOverriding - void create( + WhenComplete create( // ignore: library_private_types_in_public_api, not public _Ref ref, { required bool didChangeDependency, @@ -340,7 +344,13 @@ This could mean a few things: _didBuild = false; try { - create(ref, didChangeDependency: previousDidChangeDependency); + final whenComplete = create( + ref, + didChangeDependency: previousDidChangeDependency, + ) ?? + (cb) => cb(); + + whenComplete(_didCompleteInitialization); } catch (err, stack) { if (kDebugMode) _debugDidSetState = true; @@ -612,11 +622,16 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } void removeDependentSubscription(ProviderSubscription sub) { - while (sub.isPaused) { - sub.resume(); - } - _onChangeSubscription(sub, () { + // If the subscription is paused, internally resume it to decrement any + // associated state. + // We don't want to call onResume though. + _notifyResumeListeners = false; + while (sub.isPaused) { + sub.resume(); + } + _notifyResumeListeners = true; + if (sub.weak) { weakDependents.remove(sub); } else { @@ -629,6 +644,7 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu }); } + var _notifyResumeListeners = true; void _onChangeSubscription(ProviderSubscription sub, void Function() apply) { final wasActive = isActive; final previousListenerCount = _listenerCount; @@ -636,7 +652,9 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu switch ((wasActive: wasActive, isActive: isActive)) { case (wasActive: false, isActive: true) when _didCancelOnce: - ref?._onResumeListeners?.forEach(runGuarded); + if (_notifyResumeListeners) { + ref?._onResumeListeners?.forEach(runGuarded); + } onResume(); case (wasActive: true, isActive: false): @@ -681,6 +699,16 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu }); } + /// A life-cycle called by subclasses of [ProviderElement] when + /// their provider's `build` method completes. + void _didCompleteInitialization() { + // Close inactive subscriptions + if (_inactiveSubscriptions case final subs?) { + _closeSubscriptions(subs); + _inactiveSubscriptions = null; + } + } + /// Life-cycle for when a listener is removed. void mayNeedDispose() { if (provider.isAutoDispose) { @@ -699,6 +727,12 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu } } + void _pauseSubscriptions(List subscriptions) { + for (var i = 0; i < subscriptions.length; i++) { + subscriptions[i].pause(); + } + } + /// Executes the [Ref.onDispose] listeners previously registered, then clear /// the list of listeners. @protected @@ -713,7 +747,12 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu _pendingRetryTimer?.cancel(); _pendingRetryTimer = null; - if (subscriptions case final subs?) _closeSubscriptions(subs); + // Pause current subscriptions and queue them to be deleted upon the completion + // of the next rebuild. + if (subscriptions case final subs?) { + (_inactiveSubscriptions ??= []).addAll(subs); + _pauseSubscriptions(subs); + } subscriptions = null; ref._onDisposeListeners?.forEach(runGuarded); @@ -750,7 +789,14 @@ The provider ${_debugCurrentlyBuildingElement!.origin} modified $origin while bu _stateResult = null; ref = null; - if (dependents case final subs?) _closeSubscriptions(subs); + if (dependents case final subs?) { + _closeSubscriptions(subs); + dependents = null; + } + if (_inactiveSubscriptions case final subs?) { + _closeSubscriptions(subs); + _inactiveSubscriptions = null; + } } /// Release the resources associated to this [ProviderElement]. diff --git a/packages/riverpod/lib/src/core/modifiers/future.dart b/packages/riverpod/lib/src/core/modifiers/future.dart index 0184c6e67..6dd2ac98d 100644 --- a/packages/riverpod/lib/src/core/modifiers/future.dart +++ b/packages/riverpod/lib/src/core/modifiers/future.dart @@ -343,11 +343,11 @@ mixin FutureModifierElement on ProviderElement> { /// Listens to a [Stream] and convert it into an [AsyncValue]. @preferInline @internal - void handleStream( + WhenComplete handleStream( Stream Function() create, { required bool seamless, }) { - _handleAsync(seamless: seamless, ({ + return _handleAsync(seamless: seamless, ({ required data, required done, required error, @@ -389,11 +389,11 @@ mixin FutureModifierElement on ProviderElement> { /// Listens to a [Future] and convert it into an [AsyncValue]. @preferInline @internal - void handleFuture( + WhenComplete handleFuture( FutureOr Function() create, { required bool seamless, }) { - _handleAsync(seamless: seamless, ({ + return _handleAsync(seamless: seamless, ({ required data, required done, required error, @@ -440,7 +440,7 @@ mixin FutureModifierElement on ProviderElement> { } /// Listens to a [Future] and transforms it into an [AsyncValue]. - void _handleAsync( + WhenComplete _handleAsync( AsyncSubscription? Function({ required void Function(StateT) data, required void Function(Object, StackTrace) error, @@ -456,6 +456,9 @@ mixin FutureModifierElement on ProviderElement> { onError(AsyncError(error, stackTrace), seamless: seamless); } + void Function()? onDone; + var isDone = false; + try { _cancelSubscription = listen( data: (value) { @@ -468,11 +471,19 @@ mixin FutureModifierElement on ProviderElement> { }, done: () { _lastFuture = null; + isDone = true; + onDone?.call(); }, ); } catch (error, stackTrace) { callOnError(error, stackTrace); } + + return (onDoneCb) { + onDone = onDoneCb; + // Handle synchronous completion + if (isDone) onDoneCb(); + }; } @override diff --git a/packages/riverpod/lib/src/core/override_with_value.dart b/packages/riverpod/lib/src/core/override_with_value.dart index 670b85968..b3c97272d 100644 --- a/packages/riverpod/lib/src/core/override_with_value.dart +++ b/packages/riverpod/lib/src/core/override_with_value.dart @@ -72,8 +72,10 @@ class _ValueProviderElement extends ProviderElement { void _setValue(StateT value) => setStateResult(ResultData(value)); @override - void create(Ref ref, {required bool didChangeDependency}) { + WhenComplete create(Ref ref, {required bool didChangeDependency}) { _setValue(provider._value); + + return null; } @override diff --git a/packages/riverpod/lib/src/core/provider/notifier_provider.dart b/packages/riverpod/lib/src/core/provider/notifier_provider.dart index 19b92b99a..b745eb23e 100644 --- a/packages/riverpod/lib/src/core/provider/notifier_provider.dart +++ b/packages/riverpod/lib/src/core/provider/notifier_provider.dart @@ -191,7 +191,7 @@ abstract class ClassProviderElement< // @mustCallSuper @override - void create( + WhenComplete create( // ignore: library_private_types_in_public_api, not public _Ref ref, { required bool didChangeDependency, @@ -227,6 +227,8 @@ abstract class ClassProviderElement< // seamless: seamless, ); } + + return null; } void handleNotifier(NotifierT notifier, {required bool seamless}) { diff --git a/packages/riverpod/lib/src/core/provider_container.dart b/packages/riverpod/lib/src/core/provider_container.dart index 9900be895..772c12220 100644 --- a/packages/riverpod/lib/src/core/provider_container.dart +++ b/packages/riverpod/lib/src/core/provider_container.dart @@ -936,6 +936,7 @@ class ProviderContainer implements Node { required bool updateChildren, }) { if (_disposed) return; + _disposed = true; // We dispose children before disposing "this" // This is important to dispose providers from leaves to roots. @@ -945,7 +946,6 @@ class ProviderContainer implements Node { child._dispose(updateChildren: false); } - _disposed = true; if (updateChildren) _parent?._children.remove(this); if (_root == null) scheduler.dispose(); diff --git a/packages/riverpod/lib/src/core/provider_subscription.dart b/packages/riverpod/lib/src/core/provider_subscription.dart index a3e5238ef..5f52c2a03 100644 --- a/packages/riverpod/lib/src/core/provider_subscription.dart +++ b/packages/riverpod/lib/src/core/provider_subscription.dart @@ -89,6 +89,7 @@ abstract base class ProviderSubscriptionImpl @override void onResume() { _listenedElement.onSubscriptionResume(this); + if (closed) return; if (_missedCalled?.data case final event?) { final prev = event.$1; final next = event.$2; @@ -105,6 +106,7 @@ abstract base class ProviderSubscriptionImpl } void _notifyData(OutT? prev, OutT next) { + assert(!closed, 'cannot notify after close'); if (isPaused) { _missedCalled = (data: (prev, next), error: null); return; @@ -114,6 +116,7 @@ abstract base class ProviderSubscriptionImpl } void _notifyError(Object error, StackTrace stackTrace) { + assert(!closed, 'cannot notify after close'); if (isPaused) { _missedCalled = (data: null, error: (error, stackTrace)); return; @@ -352,7 +355,9 @@ final class ProviderStateSubscription final bool weak; // Why can't this be typed correctly? + @override final void Function(StateT? prev, StateT next) _listener; + @override final OnError _errorListener; @override diff --git a/packages/riverpod/lib/src/providers/future_provider.dart b/packages/riverpod/lib/src/providers/future_provider.dart index 6c5bea9c2..bb2aba736 100644 --- a/packages/riverpod/lib/src/providers/future_provider.dart +++ b/packages/riverpod/lib/src/providers/future_provider.dart @@ -174,11 +174,11 @@ class $FutureProviderElement extends ProviderElement> final $FutureProvider provider; @override - void create( + WhenComplete create( Ref ref, { required bool didChangeDependency, }) { - handleFuture( + return handleFuture( () => provider.create(ref), seamless: !didChangeDependency, ); diff --git a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart index d1040f08a..a13cf0b63 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_notifier_provider.dart @@ -177,7 +177,7 @@ class StateNotifierProviderElement, void Function()? _removeListener; @override - void create(Ref ref, {required bool didChangeDependency}) { + WhenComplete create(Ref ref, {required bool didChangeDependency}) { final notifier = _notifierNotifier.result = $Result.guard( () => provider._create(ref), ); @@ -186,6 +186,8 @@ class StateNotifierProviderElement, (newState) => setStateResult(ResultData(newState)), fireImmediately: true, ); + + return null; } @override diff --git a/packages/riverpod/lib/src/providers/legacy/state_provider.dart b/packages/riverpod/lib/src/providers/legacy/state_provider.dart index 7a454aa8e..23572a171 100644 --- a/packages/riverpod/lib/src/providers/legacy/state_provider.dart +++ b/packages/riverpod/lib/src/providers/legacy/state_provider.dart @@ -126,7 +126,7 @@ class StateProviderElement extends ProviderElement { void Function()? _removeListener; @override - void create( + WhenComplete create( Ref ref, { required bool didChangeDependency, }) { @@ -142,6 +142,8 @@ class StateProviderElement extends ProviderElement { setStateResult(ResultData(state)); }, ); + + return null; } @override diff --git a/packages/riverpod/lib/src/providers/provider.dart b/packages/riverpod/lib/src/providers/provider.dart index 26cab11fa..d61d409ca 100644 --- a/packages/riverpod/lib/src/providers/provider.dart +++ b/packages/riverpod/lib/src/providers/provider.dart @@ -349,8 +349,10 @@ class $ProviderElement extends ProviderElement { final $Provider provider; @override - void create(Ref ref, {required bool didChangeDependency}) { + WhenComplete create(Ref ref, {required bool didChangeDependency}) { setStateResult(ResultData(provider.create(ref))); + + return null; } @override diff --git a/packages/riverpod/lib/src/providers/stream_provider.dart b/packages/riverpod/lib/src/providers/stream_provider.dart index 140d07698..03226c509 100644 --- a/packages/riverpod/lib/src/providers/stream_provider.dart +++ b/packages/riverpod/lib/src/providers/stream_provider.dart @@ -165,14 +165,14 @@ class $StreamProviderElement extends ProviderElement> StreamController.broadcast(); @override - void create( + WhenComplete create( Ref ref, { required bool didChangeDependency, }) { asyncTransition(AsyncLoading(), seamless: !didChangeDependency); _streamNotifier.result ??= $Result.data(_streamController.stream); - handleStream( + return handleStream( () => provider.create(ref), seamless: !didChangeDependency, ); diff --git a/packages/riverpod/test/src/core/modifiers/select_async_test.dart b/packages/riverpod/test/src/core/modifiers/select_async_test.dart index e43f6b85f..9336d869b 100644 --- a/packages/riverpod/test/src/core/modifiers/select_async_test.dart +++ b/packages/riverpod/test/src/core/modifiers/select_async_test.dart @@ -18,8 +18,8 @@ void main() { final dep = StreamProvider((ref) => controller.stream); container.listen(dep, (p, n) {}); - final ref = container.read(provider); - final future = ref.watch(dep.selectAsync((data) => data * 2)); + final ref = container.listen(provider, (a, b) {}); + final future = ref.read().watch(dep.selectAsync((data) => data * 2)); container.invalidate(provider); controller.add(21); @@ -35,8 +35,8 @@ void main() { final dep = StreamProvider((ref) => controller.stream); container.listen(dep, (p, n) {}); - final ref = container.read(provider); - final future = ref.watch(dep.selectAsync((data) => data * 2)); + final ref = container.listen(provider, (a, b) {}); + final future = ref.read().watch(dep.selectAsync((data) => data * 2)); container.invalidate(provider); controller.addError('err'); diff --git a/packages/riverpod/test/src/core/provider_element_test.dart b/packages/riverpod/test/src/core/provider_element_test.dart index 4114cf560..b3a2c4dbc 100644 --- a/packages/riverpod/test/src/core/provider_element_test.dart +++ b/packages/riverpod/test/src/core/provider_element_test.dart @@ -10,6 +10,56 @@ import '../utils.dart'; void main() { group('ProviderElement', () { + test( + 'pauses old subscriptions upon invalidation until the completion of the new computation', + () async { + final container = ProviderContainer.test(); + final depProvider = Provider.family((ref, _) => 0); + final futureP = FutureProvider(Future.value); + final streamP = StreamProvider(Stream.value); + final p = Provider((ref) => ref); + + final depP = container.readProviderElement(depProvider('p')); + final depF = container.readProviderElement(depProvider('f')); + final depS = container.readProviderElement(depProvider('s')); + + container.listen(p, (a, b) {}).read().watch(depProvider('p')); + (await container.listen(futureP.future, (a, b) {}).read()) + .watch(depProvider('f')); + (await container.listen(streamP.future, (a, b) {}).read()) + .watch(depProvider('s')); + + container.invalidate(p); + container.invalidate(futureP); + container.invalidate(streamP); + + expect(depP.hasNonWeakListeners, true); + expect(depF.hasNonWeakListeners, true); + expect(depS.hasNonWeakListeners, true); + expect(depP.isActive, false); + expect(depF.isActive, false); + expect(depS.isActive, false); + + await container.pump(); + + expect(depP.hasNonWeakListeners, false); + expect(depF.hasNonWeakListeners, true); + expect(depS.hasNonWeakListeners, true); + expect(depP.isActive, false); + expect(depF.isActive, false); + expect(depS.isActive, false); + + await container.read(streamP.future); + await container.read(futureP.future); + + expect(depP.hasNonWeakListeners, false); + expect(depF.hasNonWeakListeners, false); + expect(depS.hasNonWeakListeners, false); + expect(depP.isActive, false); + expect(depF.isActive, false); + expect(depS.isActive, false); + }); + test('Only includes direct subscriptions in subscription lists', () { final container = ProviderContainer.test(); final provider = FutureProvider((ref) => 0); diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index 1377a78cb..a5712c885 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -2812,13 +2812,15 @@ void main() { verifyNoMoreInteractions(listener2); }); - test('is called when all provider dependencies are removed', () { + test('is called when all provider dependencies are removed', () async { final container = ProviderContainer.test(); final listener = OnCancelMock(); final listener2 = OnCancelMock(); + final resume = OnResume(); final dep = Provider(name: 'dep', (ref) { ref.onCancel(listener.call); ref.onCancel(listener2.call); + ref.onResume(resume.call); }); var watching = true; final provider = Provider(name: 'provider', (ref) { @@ -2831,21 +2833,22 @@ void main() { container.listen(provider, (p, n) {}); container.listen(provider2, (p, n) {}); - verifyZeroInteractions(listener); - verifyZeroInteractions(listener2); - watching = false; // remove the dependency provider<>dep - container.refresh(provider); + container.invalidate(provider); + await container.pump(); + verifyZeroInteractions(listener); verifyZeroInteractions(listener2); // remove the dependency provider2<>dep - container.refresh(provider2); + container.invalidate(provider2); + await container.pump(); verifyInOrder([listener(), listener2()]); verifyNoMoreInteractions(listener); verifyNoMoreInteractions(listener2); + verifyZeroInteractions(resume); }); test('is called when using container.read', () async { From 952f9743051f2182f39bd972cc2d801622275f23 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 8 Jan 2025 15:33:16 +0100 Subject: [PATCH 383/387] changelog --- packages/riverpod/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md index 88975009c..1a2f3acb5 100644 --- a/packages/riverpod/CHANGELOG.md +++ b/packages/riverpod/CHANGELOG.md @@ -26,7 +26,7 @@ then `A` will be paused. - **Breaking**: When an asynchronous provider rebuilds, it doesn't immediately stops listening to its previous providers. Instead, those subscriptions are removed when the rebuild completes. - This impacts how "auto-dispose" behaves. + This impacts how "auto-dispose" behaves. See https://github.com/rrousselGit/riverpod/issues/1253 - Fix `StreamProvider` not cancelling the `StreamSubscription` if the stream is never emitted any value. - All `Ref` life-cycles (such as `Ref.onDispose`) and `Notifier.listenSelf` now return a function to remove the listener. From 30b9eb8ccfc9670cc73a1792916ad9763ef4b8ce Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 8 Jan 2025 16:41:23 +0100 Subject: [PATCH 384/387] Fix message --- packages/riverpod/lib/src/core/ref.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/riverpod/lib/src/core/ref.dart b/packages/riverpod/lib/src/core/ref.dart index b36fcf019..22ef8711a 100644 --- a/packages/riverpod/lib/src/core/ref.dart +++ b/packages/riverpod/lib/src/core/ref.dart @@ -120,7 +120,7 @@ final = Provider(dependencies: []); void _throwIfInvalidUsage() { assert( !_debugIsRunningSelector, - 'Cannot call ref.listen inside a selector', + 'Cannot call ref. inside a selector', ); if (!mounted) throw UnmountedRefException(_element.origin); } From f88ba03f0cb3322c8e67fc888b180a4161056f93 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 8 Jan 2025 19:34:13 +0100 Subject: [PATCH 385/387] Fix pub get --- packages/lint_visitor_generator/pubspec.yaml | 4 ++-- packages/riverpod/test/meta_test.dart | 3 +-- .../lib/src/nodes/ref_invocation.dart | 3 +-- .../lib/src/nodes/widget_ref_invocation.dart | 3 +-- .../lib/src/nodes/widgets/stateful_widget.dart | 5 +---- packages/riverpod_analyzer_utils/pubspec.yaml | 2 +- .../riverpod_lint/lib/src/lints/unknown_scoped_usage.dart | 5 +---- packages/riverpod_lint_flutter_test/pubspec.yaml | 4 ++-- website/pubspec.yaml | 2 +- website/pubspec_overrides.yaml | 7 +++---- 10 files changed, 14 insertions(+), 24 deletions(-) diff --git a/packages/lint_visitor_generator/pubspec.yaml b/packages/lint_visitor_generator/pubspec.yaml index b4e34cd52..c8995dee6 100644 --- a/packages/lint_visitor_generator/pubspec.yaml +++ b/packages/lint_visitor_generator/pubspec.yaml @@ -5,13 +5,13 @@ environment: sdk: ">=3.0.0 <4.0.0" dependencies: - analyzer: ">=5.12.0 <7.0.0" + analyzer: ^7.0.0 build: ^2.3.1 build_config: ^1.1.0 collection: ^1.17.1 meta: ^1.7.0 path: ^1.9.0 - source_gen: ^1.2.3 + source_gen: ^2.0.0 source_span: ^1.10.0 dev_dependencies: diff --git a/packages/riverpod/test/meta_test.dart b/packages/riverpod/test/meta_test.dart index 50e894b8c..ccc67210c 100644 --- a/packages/riverpod/test/meta_test.dart +++ b/packages/riverpod/test/meta_test.dart @@ -184,8 +184,7 @@ class _PublicAPIVisitor extends GeneralizingElementVisitor { } void _verifyInheritsAnnotations(Element element) { - // ignore: deprecated_member_use, needed to support older SDK - final parent = element.enclosingElement; + final parent = element.enclosingElement3; if (parent is! ClassElement) return; diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart index 5a0515010..e69a3f494 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/ref_invocation.dart @@ -16,8 +16,7 @@ extension RefInvocationX on MethodInvocation { final functionOwner = function.staticElement .cast() ?.declaration - // ignore: deprecated_member_use, required to support lower versions of analyzer - .enclosingElement; + .enclosingElement3; if (functionOwner == null || // Since Ref is sealed, checking that the function is from the package:riverpod diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart index aa052d0dc..5bdf93f49 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/widget_ref_invocation.dart @@ -21,8 +21,7 @@ extension WidgetRefInvocationX on MethodInvocation { final functionOwner = function.staticElement .cast() ?.declaration - // ignore: deprecated_member_use, required to support lower versions of analyzer - .enclosingElement; + .enclosingElement3; if (functionOwner == null || // Since Ref is sealed, checking that the function is from the package:riverpod diff --git a/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart index cb6dd5ff7..6bd15f065 100644 --- a/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart +++ b/packages/riverpod_analyzer_utils/lib/src/nodes/widgets/stateful_widget.dart @@ -21,10 +21,7 @@ ClassElement? _findStateFromReturnType(ClassElement node) { } ClassElement? _findStateWithMatchingGeneric(ClassElement node) { - for (final clazz in node - // ignore: deprecated_member_use, required to support lower versions of analyzer - .enclosingElement - .classes) { + for (final clazz in node.enclosingElement3.classes) { final type = clazz.supertype; if (type != null && isState(type) && _findStateWidget(clazz) == node) { return clazz; diff --git a/packages/riverpod_analyzer_utils/pubspec.yaml b/packages/riverpod_analyzer_utils/pubspec.yaml index f7c80d8d1..c102d1eb8 100644 --- a/packages/riverpod_analyzer_utils/pubspec.yaml +++ b/packages/riverpod_analyzer_utils/pubspec.yaml @@ -13,7 +13,7 @@ dependencies: analyzer: ^7.0.0 collection: ^1.16.0 crypto: ^3.0.2 - custom_lint_core: ^0.7.0 + custom_lint_core: ^0.7.1 freezed_annotation: ^2.2.0 meta: ^1.7.0 path: ^1.8.0 diff --git a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart index 5ec9fa083..b3541907a 100644 --- a/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart +++ b/packages/riverpod_lint/lib/src/lints/unknown_scoped_usage.dart @@ -60,10 +60,7 @@ class UnknownScopedUsage extends RiverpodLintRule { if (override?.provider == identifier) return; final enclosingConstructorType = identifier - .node - .staticParameterElement - // ignore: deprecated_member_use, required to support lower versions of analyzer - ?.enclosingElement + .node.staticParameterElement?.enclosingElement3 .safeCast() ?.returnType; // Silence the warning if passed to a widget constructor. diff --git a/packages/riverpod_lint_flutter_test/pubspec.yaml b/packages/riverpod_lint_flutter_test/pubspec.yaml index a56d18125..a21d60005 100644 --- a/packages/riverpod_lint_flutter_test/pubspec.yaml +++ b/packages/riverpod_lint_flutter_test/pubspec.yaml @@ -27,10 +27,10 @@ dev_dependencies: flutter_test: sdk: flutter glob: ^2.1.2 - analyzer: ^6.0.0 + analyzer: ^7.0.0 path: ^1.9.0 source_span: ^1.10.0 - analyzer_plugin: ^0.11.3 + analyzer_plugin: ^0.12.0 dependency_overrides: riverpod_generator: diff --git a/website/pubspec.yaml b/website/pubspec.yaml index 0684ef534..2ea88408d 100644 --- a/website/pubspec.yaml +++ b/website/pubspec.yaml @@ -25,7 +25,7 @@ dependencies: dev_dependencies: build_runner: - custom_lint: ^0.7.0 + custom_lint: ^0.7.1 flutter_test: sdk: flutter freezed: ^2.2.0 diff --git a/website/pubspec_overrides.yaml b/website/pubspec_overrides.yaml index 7488c6af5..60a4f269e 100644 --- a/website/pubspec_overrides.yaml +++ b/website/pubspec_overrides.yaml @@ -5,10 +5,6 @@ dependency_overrides: riverpod_lint: path: ../packages/riverpod_lint - ## Needed due to Flutter not supporting 6.0.0 yet - analyzer: ^6.0.0 - analyzer_plugin: ^0.11.3 - # Hotreloader issue vm_service: ^14.0.0 flutter_riverpod: @@ -21,3 +17,6 @@ dependency_overrides: path: ../packages/riverpod_annotation riverpod_generator: path: ../packages/riverpod_generator + + # For flutter_test + test_api: ^0.7.4 \ No newline at end of file From 4b72dd8caf38e90205ca54a3a2238d56e6023d4e Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 8 Jan 2025 19:39:19 +0100 Subject: [PATCH 386/387] Remove skipped test --- packages/riverpod/test/src/core/ref_test.dart | 28 ------------------- 1 file changed, 28 deletions(-) diff --git a/packages/riverpod/test/src/core/ref_test.dart b/packages/riverpod/test/src/core/ref_test.dart index a5712c885..54f543f60 100644 --- a/packages/riverpod/test/src/core/ref_test.dart +++ b/packages/riverpod/test/src/core/ref_test.dart @@ -2727,34 +2727,6 @@ void main() { verifyZeroInteractions(listener); }); - test( - 'is called when dependent is invalidated and was the only listener', - // TODO deal with now that we have onPause - skip: 'Waiting for "clear dependencies after FutureProvider rebuilds"', - () async { - // - final container = ProviderContainer.test(); - final onCancel = OnCancelMock(); - final dep = StateProvider((ref) { - ref.onCancel(onCancel.call); - return 0; - }); - final provider = Provider.autoDispose((ref) => ref.watch(dep)); - - container.read(provider); - - verifyZeroInteractions(onCancel); - - container.read(dep.notifier).state++; - - verify(onCancel()).called(1); - - await container.pump(); - - verifyNoMoreInteractions(onCancel); - }, - ); - test('is called when all container listeners are removed', () { final container = ProviderContainer.test(); final listener = OnCancelMock(); From 4d40e980d945c2fe0b43883e9217e1bee3de6672 Mon Sep 17 00:00:00 2001 From: Remi Rousselet Date: Wed, 8 Jan 2025 19:42:51 +0100 Subject: [PATCH 387/387] Fix pub get --- examples/counter/pubspec_overrides.yaml | 3 +++ examples/marvel/pubspec_overrides.yaml | 3 +++ examples/pub/pubspec_overrides.yaml | 3 +++ examples/random_number/pubspec_overrides.yaml | 3 +++ examples/stackoverflow/pubspec_overrides.yaml | 3 +++ examples/todos/pubspec_overrides.yaml | 3 +++ 6 files changed, 18 insertions(+) diff --git a/examples/counter/pubspec_overrides.yaml b/examples/counter/pubspec_overrides.yaml index a7b425eea..b03880da2 100644 --- a/examples/counter/pubspec_overrides.yaml +++ b/examples/counter/pubspec_overrides.yaml @@ -14,3 +14,6 @@ dependency_overrides: path: ../../packages/riverpod_generator riverpod_lint: path: ../../packages/riverpod_lint + + # For flutter_test + test_api: ^0.7.4 diff --git a/examples/marvel/pubspec_overrides.yaml b/examples/marvel/pubspec_overrides.yaml index a7b425eea..b03880da2 100644 --- a/examples/marvel/pubspec_overrides.yaml +++ b/examples/marvel/pubspec_overrides.yaml @@ -14,3 +14,6 @@ dependency_overrides: path: ../../packages/riverpod_generator riverpod_lint: path: ../../packages/riverpod_lint + + # For flutter_test + test_api: ^0.7.4 diff --git a/examples/pub/pubspec_overrides.yaml b/examples/pub/pubspec_overrides.yaml index a7b425eea..b03880da2 100644 --- a/examples/pub/pubspec_overrides.yaml +++ b/examples/pub/pubspec_overrides.yaml @@ -14,3 +14,6 @@ dependency_overrides: path: ../../packages/riverpod_generator riverpod_lint: path: ../../packages/riverpod_lint + + # For flutter_test + test_api: ^0.7.4 diff --git a/examples/random_number/pubspec_overrides.yaml b/examples/random_number/pubspec_overrides.yaml index 6ce4319bc..020e1f784 100644 --- a/examples/random_number/pubspec_overrides.yaml +++ b/examples/random_number/pubspec_overrides.yaml @@ -12,3 +12,6 @@ dependency_overrides: path: ../../packages/riverpod_generator riverpod_lint: path: ../../packages/riverpod_lint + + # For flutter_test + test_api: ^0.7.4 diff --git a/examples/stackoverflow/pubspec_overrides.yaml b/examples/stackoverflow/pubspec_overrides.yaml index a7b425eea..b03880da2 100644 --- a/examples/stackoverflow/pubspec_overrides.yaml +++ b/examples/stackoverflow/pubspec_overrides.yaml @@ -14,3 +14,6 @@ dependency_overrides: path: ../../packages/riverpod_generator riverpod_lint: path: ../../packages/riverpod_lint + + # For flutter_test + test_api: ^0.7.4 diff --git a/examples/todos/pubspec_overrides.yaml b/examples/todos/pubspec_overrides.yaml index a7b425eea..b03880da2 100644 --- a/examples/todos/pubspec_overrides.yaml +++ b/examples/todos/pubspec_overrides.yaml @@ -14,3 +14,6 @@ dependency_overrides: path: ../../packages/riverpod_generator riverpod_lint: path: ../../packages/riverpod_lint + + # For flutter_test + test_api: ^0.7.4